https://github.com/bryancalisto/ec-sri-invoice-signer
🇪🇨 Ecuador's SRI documents signer written in pure TypeScript
https://github.com/bryancalisto/ec-sri-invoice-signer
comprobante-de-retencion digital-signature ecuador factura firma-digital guia-de-remision invoice nota-de-credito nota-de-debito sri
Last synced: 3 months ago
JSON representation
🇪🇨 Ecuador's SRI documents signer written in pure TypeScript
- Host: GitHub
- URL: https://github.com/bryancalisto/ec-sri-invoice-signer
- Owner: bryancalisto
- License: mit
- Created: 2023-02-18T03:38:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-23T18:03:34.000Z (4 months ago)
- Last Synced: 2026-02-24T00:28:01.062Z (4 months ago)
- Topics: comprobante-de-retencion, digital-signature, ecuador, factura, firma-digital, guia-de-remision, invoice, nota-de-credito, nota-de-debito, sri
- Language: TypeScript
- Homepage:
- Size: 686 KB
- Stars: 34
- Watchers: 1
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🇪🇨 ec-sri-invoice-signer 🇪🇨
Firmador de comprobantes electrónicos del Servicio de Rentas Internas (SRI) ecuatoriano. Soporta facturas, notas de crédito, notas de débito, comprobantes de retención y guías de remisión. Está escrito en puro TypeScript, sin dependencias de binarios criptográficos como OpenSSL, DLLs con el código de firmado, JARs o similares.
Funciona en Windows, Unix / Linux, o cualquier plataforma que soporte Node.js, sin configuraciones adicionales.
## Guía de uso
1. Instala el paquete.
```bash
npm i ec-sri-invoice-signer
```
2. Usa la función correspondiente en tu código para firmar el documento respectivo. En este ejemplo se firmará una factura:
```js
import fs from 'fs';
import {
signInvoiceXml,
// Otras funciones disponibles:
// signPurchaseLiquidationXml,
// signDebitNoteXml,
// signCreditNoteXml,
// signDeliveryGuideXml,
// signWithholdingCertificateXml,
} from 'ec-sri-invoice-signer';
/* Puedes user require() si usas módulos commonJS. */
/* El XML del documento a firmarse. */
const invoiceXml = '
...
...
...
```
- La declaración del documento XML es opcional.
```xml
...
```
o
```xml
...
```
son igual de válidos.
- La factura debe estar en formato UTF-8.
- No namespaces (xmlns).
```xml
...
```
```xml
...
```
- No etiquetas de Document Type Definition (DOCTYPE).
```xml
]>
...
```
- No atributos con prefijo xml (xml:).
```xml
...
```
## Manejo de errores
Este paquete exporta clases de error específicas para facilitar el manejo de excepciones:
- `XmlFormatError`: Lanzado cuando el XML proporcionado no tiene un formato válido.
- `UnsuportedPkcs12Error`: Lanzado cuando el archivo .p12 no es soportado o la contraseña es incorrecta.
- `UnsupportedXmlFeatureError`: Lanzado cuando el XML contiene características no soportadas (como `DOCTYPE` o `xmlns`).
- `UnsupportedDocumentTypeError`: Lanzado cuando el tipo de documento (nodo raíz) no es soportado.
Ejemplo de manejo:
```js
import { signInvoiceXml, XmlFormatError, UnsupportedXmlFeatureError } from 'ec-sri-invoice-signer';
try {
const signedInvoice = signInvoiceXml(invoiceXml, p12FileData, { pkcs12Password });
} catch (error) {
if (error instanceof XmlFormatError) {
console.error('El XML tiene errores de formato');
} else if (error instanceof UnsupportedXmlFeatureError) {
console.error('El XML contiene características no soportadas:', error.message);
} else {
console.error('Error inesperado:', error.message);
}
}
```
## Nota importante sobre los archivos .p12
El paquete se ha probado satisfactoriamente usando .p12 de estos proveedores (no tengo .p12 de otros proveedores y tampoco he podido recibir el feedback de usuarios del paquete usando otras firmas):
- Uanataca.
- Security Data.
- Lazzate.
Si pruebas el paquete con .p12 de otros proveedores y encuentras problemas, por favor crea un [issue](https://github.com/bryancalisto/ec-sri-invoice-signer/issues)
## Herramientas para prueba directa con servicios del SRI
El repositorio incluye herramientas para probar el firmado de facturas y notas de débito contra los servidores del SRI en modo 'prueba'.
Para usarlas, primero configura los parámetros correspondientes al tipo de documento que quieres probar. Los scripts tomarán los parámetros configurados, firmarán el documento y lo enviarán al SRI para su validación y consultarán el servicio del SRI para verificar el estado del documento, reportando el resultado.
**Nota:** No olvides primero ubicarte en la raíz del proyecto de node (directorio `ec-sri-invoice-signer/` donde está el package.json) antes de correr los comandos siguientes.
### Facturas
Crea el archivo `test/sri-live-test/invoice/invoice-params.json` (usa `test/sri-live-test/invoice/invoice-params-template.json` como plantilla).
Corre la prueba:
```bash
npm run test:sri:invoice
```
### Notas de Débito
Crea el archivo `test/sri-live-test/debit-note/debit-note-params.json` (usa `test/sri-live-test/debit-note/debit-note-params-template.json` como plantilla).
Corre la prueba:
```bash
npm run test:sri:debit-note
```
### Notas de Crédito
Crea el archivo `test/sri-live-test/credit-note/credit-note-params.json` (usa `test/sri-live-test/credit-note/credit-note-params-template.json` como plantilla).
Corre la prueba:
```bash
npm run test:sri:credit-note
```
### Guías de Remisión
Crea el archivo `test/sri-live-test/delivery-guide/delivery-guide-params.json` (usa `test/sri-live-test/delivery-guide/delivery-guide-params-template.json` como plantilla).
Corre la prueba:
```bash
npm run test:sri:delivery-guide
```
### Comprobantes de Retención
Crea el archivo `test/sri-live-test/withholding-certificate/withholding-certificate-params.json` (usa `test/sri-live-test/withholding-certificate/withholding-certificate-params-template.json` como plantilla).
Corre la prueba:
```bash
npm run test:sri:withholding-certificate
```