Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@nodecfdi/credentials

nodecfdi974MIT3.2.0TypeScript support: included

Librería para usar eFirma (fiel) y CSD (sellos) para el SAT

certificate, sat, csd, fiel, signing, firmar, factura, rfc, efirma, sellos, pfx

readme

@nodecfdi/credentials

Source Code Npm Node Version Support Discord Latest Version Software License Build Status Reliability Maintainability Code Coverage Violations Total Downloads

Library to use eFirma (fiel) and CSD (sellos) from SAT

:us: The documentation of this project is in spanish as this is the natural language for intended audience.

:mexico: La documentación del proyecto está en español porque ese es el lenguaje principal de los usuarios.

Acerca de @nodecfdi/credentials

Esta librería ha sido creada para poder trabajar con los archivos CSD y FIEL del SAT. De esta forma, se simplifica el proceso de firmar, verificar firma y obtener datos particulares del archivo de certificado así como de la llave pública.

  • El CSD (Certificado de Sello Digital) es utilizado para firmar Comprobantes Fiscales Digitales.

  • La FIEL (o eFirma) es utilizada para firmar electrónicamente documentos (generalmente usando XML-SEC) y está reconocida por el gobierno mexicano como una manera de firma legal de una persona física o moral.

Con esta librería no es necesario convertir los archivos generados por el SAT a otro formato, se pueden utilizar tal y como el SAT los entrega.

Esta librería ha sido inspirada por la versión para php https://github.com/phpcfdi/credentials

Documentación

La documentación está disponible en el sitio web NodeCfdi

Soporte

Puedes obtener soporte abriendo un ticket en Github.

Adicionalmente, esta librería pertenece a la comunidad OcelotlStudio, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.

Compatibilidad

Esta librería se mantendrá compatible con al menos la versión con soporte activo de Node más reciente.

También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.

Contribuciones

Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para más detalles y recuerda revisar el archivo CHANGELOG.

The @nodecfdi/credentials library is copyright © NodeCfdi - OcelotlStudio and licensed for use under the MIT License (MIT). Please see LICENSE for more information.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v3.2.0

Commits

  • feat: :sparkles: add missing types exported form node-forge for algorithms usage in sign 64faf4f
  • chore: :arrow_up: update dependencies 7551e0b
  • build: :construction: remove export of package.json file not necessary export a4bb015

v3.1.1 - 2024-09-11

Commits

  • chore(release): :tada: 3.1.1 6b45e95
  • chore: :arrow_up: update dependencies, eslint config update to latest and usage of auto-changelog 6ab7f27
  • docs: :memo: small change to show badge icon on build b2fc2a0

v3.1.0 - 2024-08-14

Fixed

  • feat: :sparkles: add support to change private key password #20

Commits

  • chore(release): :tada: 3.1.0 3fc0dab
  • docs: :memo: update readme to remove old documentation of library and add new link for doc be72dee
  • style: :rotating_light: resolve issues reported by sonarcloud a86fc87

v3.0.0 - 2024-08-13

Commits

  • chore: :recycle: remove old config files and configs 6b00538
  • docs: :memo: update docs target with latest updates in library 8685dbf
  • style: :rotating_light: resolve format using prettier ac01b4a

v2.0.3 - 2023-07-13

Merged

  • chore: version bump 2.0.3 #19

Commits

  • docs: generate docs 287e21d
  • fix: exports for node-forge and esm imports 5b97c82

v2.0.2 - 2023-07-13

Merged

  • chore: version bump 2.0.2 #18

Commits

v2.0.1 - 2023-07-11

Merged

  • chore: version 2.0.1 #17

Commits

v2.0.0 - 2023-06-30

Merged

  • version bump 2.0.0 #14
  • chore(deps): update dependency typedoc-theme-hierarchy to v3 #5
  • chore(deps): update dependency jest-watch-typeahead to v2 #4

Commits

  • refactor: move from jsrsasign to node-forge for handle certs and pems 274e6f8
  • refactor: move again to ts-mixer for handler best protected access 2f1f08c
  • chore: increment test coverage and added missing tests b79c7a3

v1.3.0 - 2022-07-08

Merged

  • Version 1.3.0 #2

Commits

  • chore: update new configs dbcc9a4
  • docs: added docs for next release v1.3.0 8596346
  • refactor: remove old docs and old configs 5301307

v1.2.2 - 2022-03-14

Commits

  • docs: update docs for release version 1.2.2, revert changes for support teletex strings 2a9cd45
  • refactor: revert change of certificate for support teletex string, jsrsasign support native 31070c8

v1.2.1 - 2022-03-10

Commits

  • docs: prepare docs for release version 1.1.0 7808409
  • chore: initial commit de94ded
  • docs: prepare docs for release version 1.2.1 3d839bd