Skip to content

Commit

Permalink
Merge pull request #29 from bryancalisto/fix/npm-publish-repo-url
Browse files Browse the repository at this point in the history
Updated documentation
  • Loading branch information
bryancalisto committed May 8, 2024
2 parents b49c8bc + 2ad17c6 commit d177cdb
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 12 deletions.
42 changes: 33 additions & 9 deletions ec-sri-invoice-signer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ec-sri-invoice-signer
Firmador de facturas basado en las especificaciones del Servicio de Rentas Internas (SRI) ecuatoriano. Está escrito en puro TypeScript/JavaScript, sin dependencias de binarios criptográficos como OpenSSL, DLLs con la lógica de firmado o similares.
Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que soporte Node.js .
Firmador de facturas basado en las especificaciones del Servicio de Rentas Internas (SRI) ecuatoriano. Está escrito en puro TypeScript/JavaScript, sin dependencias de binarios criptográficos como OpenSSL, DLLs con el código de firmado o similares.
Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que soporte Node.js sin configuraciones adicionales.

## Guía de uso

Expand All @@ -26,6 +26,15 @@ Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que sopor
doSomethingWithTheSignedInvoice(signedInvoice);
```
3. Si este paquete te ha ayudado, considera dejar tu estrella en<a style="
display: inline-block;
color: #d9deda;
width: fit-content;
padding: 1px 9px;
text-align: center;
border-radius: 6px;
font-weight: bold;"
href="https://github.com/bryancalisto/ec-sri-invoice-signer">GitHub ⭐</a>.
## Notas importantes sobre la estructura del XML
Este paquete no implementa la especificación de [canonicalización](https://en.wikipedia.org/wiki/Canonicalization) http://www.w3.org/TR/2001/REC-xml-c14n-20010315 por completo.
Expand All @@ -44,11 +53,18 @@ Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que sopor
```
- La declaración del documento XML es opcional.
```xml
<?xml version="1.0" encoding="UTF-8"?><factura Id="comprobante" version="1.1.0">...</factura>
<!-- Con declaración -->
<?xml version="1.0" encoding="UTF-8"?>
<factura Id="comprobante" version="1.1.0">
...
</factura>
```
o
```xml
<factura Id="comprobante" version="1.1.0">...</factura>
<!-- Sin declaración -->
<factura Id="comprobante" version="1.1.0">
...
</factura>
```
son igual de válidos.
- La factura debe estar en formato UTF-8.
Expand All @@ -57,12 +73,16 @@ Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que sopor
<!-- En este ejemplo, el xmlns:ds="..." debe ser eliminado. Como contexto, ningún namespace es necesario
para la factura en sí. Este paquete se encarga de colocar los namespaces necesarios en la firma digital
generada -->
<factura Id="comprobante" version="1.1.0" xmlns:ds="...">...</factura>
<factura Id="comprobante" version="1.1.0" xmlns:ds="...">
...
</factura>
```
```xml
<!-- Esto es soportado -->
<factura Id="comprobante" version="1.1.0">...</factura>
<factura Id="comprobante" version="1.1.0">
...
</factura>
```
- No etiquetas de Document Type Definition (DOCTYPE).
```xml
Expand All @@ -75,10 +95,14 @@ Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que sopor
<!ELEMENT heading (#PCDATA)>
<!ELEMENT body (#PCDATA)>
]>
<factura Id="comprobante" version="1.1.0">...<factura>
<factura Id="comprobante" version="1.1.0">
...
<factura>
```
- No atributos con prefijo xml (xml:<attr_name>).
```xml
<!-- Esto no es soportado -->
<factura Id="comprobante" version="1.1.0" xml:foo="123">...</factura>
<!-- Esto no es soportado debido a xml:foo="123"-->
<factura Id="comprobante" version="1.1.0" xml:foo="123">
...
</factura>
```
4 changes: 2 additions & 2 deletions ec-sri-invoice-signer/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ec-sri-invoice-signer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ec-sri-invoice-signer",
"version": "1.1.0",
"version": "1.1.1",
"description": "Ecuador SRI invoice signer.",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand Down

0 comments on commit d177cdb

Please sign in to comment.