node-sped-nfe 1.0.8 → 1.0.9

package/README.md

@@ -34,57 +34,5 @@ Seja bem-vindo(a) à **Biblioteca de Emissão de NF-e** — sua parceira definit
 
 ---
 
-## 📌 Requisitos
-
-Para garantir o funcionamento correto da biblioteca, certifique-se de que os seguintes requisitos estejam atendidos:
-
-### 🔧 Ambiente
-
-- **Windows**/**Linux**
-- **Node.js** `v22.14.0` (versão testada e recomendada)
-- **xmllint** `2.9.3` (utilizado para validação dos XMLs gerados)
-
----
-
-## 🧪 Estados Testados
-
-A biblioteca já foi testada com sucesso nos seguintes estados brasileiros:
-
-- ✅ MT — Mato Grosso
-- ⬜ AC — Acre
-- ⬜ AL — Alagoas
-- ⬜ AM — Amazonas
-- ⬜ AP — Amapá
-- ⬜ BA — Bahia
-- ⬜ CE — Ceará
-- ⬜ DF — Distrito Federal
-- ⬜ ES — Espírito Santo
-- ⬜ GO — Goiás
-- ⬜ MA — Maranhão
-- ⬜ MG — Minas Gerais
-- ⬜ MS — Mato Grosso do Sul
-- ⬜ PA — Pará
-- ⬜ PB — Paraíba
-- ⬜ PE — Pernambuco
-- ⬜ PI — Piauí
-- ⬜ PR — Paraná
-- ⬜ RJ — Rio de Janeiro
-- ⬜ RN — Rio Grande do Norte
-- ⬜ RO — Rondônia
-- ⬜ RR — Roraima
-- ⬜ RS — Rio Grande do Sul
-- ⬜ SC — Santa Catarina
-- ⬜ SE — Sergipe
-- ⬜ SP — São Paulo
-- ⬜ TO — Tocantins
-
-Contribua com a comunidade! Testou com sucesso em algum estado? Envie um PR ou abra uma issue!
-
-## 🚀 Começando
-
-### 1. Instalação
-
-```bash
-npm install node-sped-nfe
-# ou
-yarn add node-sped-nfe
+## 📌 Informações
+[Documentação](https://github.com/kalmonv/node-sped-nfe/tree/main/docs)

package/docs/README.md

@@ -13,25 +13,36 @@ Antes de começar, verifique se seu ambiente está preparado:
 - ✅ **xmllint / libxml**  
   Utilizado para validação e assinatura de XML.  
   📚 Guia de instalação e uso:  
-  👉 [Assinar XML com xmllint](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/xmllint.md)
+  👉 [Validar XML com xmllint](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/requisitos.md)
 
 ---
+## 📌 Considerações
 
-## 🧭 Passo a passo
+O sistema atualmente segue o layout da **NF-e versão 4.00**, conforme os padrões da SEFAZ.
 
-Siga os passos abaixo na ordem para garantir uma emissão completa e válida:
+Está sendo desenvolvido com estrutura flexível para facilitar futuras adaptações a novas versões da NF-e.
 
-1. 🧾 **Criação do XML da NF-e**  
-   Gere corretamente seu XML com base nas regras da SEFAZ.  
-   👉 [Documentação](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/xml.md)
+🔗 **Leitura obrigatória**:  
+Para uma integração correta, consulte sempre o **Manual de Integração do Contribuinte**, disponível em:  
+[https://www.nfe.fazenda.gov.br/portal/listaConteudo.aspx?tipoConteudo=ndIjl+iEFdE=](https://www.nfe.fazenda.gov.br/portal/listaConteudo.aspx?tipoConteudo=ndIjl+iEFdE=)
 
-2. ✍️ **Assinar o XML**  
-   Assine digitalmente o XML com seu certificado A1.  
-   👉 [Como assinar](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/assinar_xml.md)
+> ⚠️ Manter-se atualizado com esse manual é essencial para garantir conformidade fiscal.
 
-3. 📡 **Enviar para a SEFAZ**  
-   Transmita o XML assinado para a SEFAZ e obtenha o protocolo.  
-   👉 [Envio e retorno](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/sefaz.md)
+---
+
+### 1. 🧾 Criar o XML da NF-e ou NFC-e 
+   📚 Guia de instalação e uso:  
+   [Documentação](https://github.com/kalmonv/node-sped-nfe/blob/main/docs/xml.md)
+- 📂 **NF-e**: [Ver exemplo completo](https://github.com/kalmonv/node-sped-nfe/blob/main/exemplos/nfe.js)  
+- 📂 **NFC-e**: [Ver exemplo completo](https://github.com/kalmonv/node-sped-nfe/blob/main/exemplos/nfce.js)
+
+---
+
+### 2. 🧾 Consulta status da sefaz
+
+- 📂 **NF-e/NFC-e**: [Ver exemplo completo](https://github.com/kalmonv/node-sped-nfe/blob/main/exemplos/status.js)  
+
+---
 
 4. 📬 **Entendendo as respostas da SEFAZ**  
    Interprete corretamente os códigos e status da resposta da SEFAZ.  

package/docs/Tools.md

@@ -0,0 +1,105 @@
+# 🧰 Instanciando a classe `Tools`
+
+A classe `Tools` é responsável por operações centrais da NF-e/NFC-e: geração, assinatura, envio e validação de XMLs.
+
+---
+
+## ✨ Sintaxe
+
+```ts
+const config = {
+  UF: 'SP', // Obrigatorio
+  tpAmb: 2, //1-Produçao, 2-Homologação
+  versao: '4.00', //Obrigatorio
+  xmllint: '/usr/bin/xmllint.exe', //Optativo, caso sistema não tenha declarado nas variaveis.
+  mod: '55', //Obrigatorio, 65 ou 55
+  timeout: 60  //Optativo - Tempo limite de requisição
+};
+const certificado = {
+  pfx: fs.readFileSync('./certs/empresa.pfx'),  //Obrigatorio, caminho para o arquivo .pfx
+  senha: 'minhasenha123'                        //Obrigatorio, senha do certificado digital
+};
+const tools = new Tools(config, certificado);
+```
+
+## 📥 Método `xml2json(xml: string): Promise<object>`
+## 📥 Método `json2xml(obj: object): Promise<string>`
+Converte uma string XML em um objeto JavaScript.
+Converte uma string XML em um objeto JavaScript.
+
+### Exemplo entrada ou saida:
+```xml
+<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
+  <soapenv:Body>
+    <nfeResultMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NFeStatusServico4">
+      <retConsStatServ xmlns="http://www.portalfiscal.inf.br/nfe" versao="4.00">
+        <tpAmb>0</tpAmb>
+        <verAplic>1.00</verAplic>
+        <cStat>999</cStat>
+        <xMotivo>Rejeicao: Erro nao catalogado</xMotivo>
+        <cUF>51</cUF>
+      </retConsStatServ>
+    </nfeResultMsg>
+  </soapenv:Body>
+</soapenv:Envelope>
+```
+```json
+{
+  "soapenv:Envelope": {
+    "@xmlns:soapenv": "http://www.w3.org/2003/05/soap-envelope",
+    "soapenv:Body": {
+      "nfeResultMsg": {
+        "@xmlns": "http://www.portalfiscal.inf.br/nfe/wsdl/NFeStatusServico4",
+        "retConsStatServ": {
+          "@xmlns": "http://www.portalfiscal.inf.br/nfe",
+          "@versao": "4.00",
+          "tpAmb": 0,
+          "verAplic": "1.00",
+          "cStat": 999,
+          "xMotivo": "Rejeicao: Erro nao catalogado",
+          "cUF": 51
+        }
+      }
+    }
+  }
+}
+```
+## 📥 Método `sefazEnviaLote(xml: string, data: any = { idLote: 1, indSinc: 0, compactar: false }): Promise<string>`
+Este método é responsável por enviar um lote de NF-e ou NFC-e para a SEFAZ. Ele recebe um XML contendo a NF-e/NFC-e a ser transmitida, além de um objeto de configuração que define parâmetros adicionais para o envio.
+```ts
+let xml = "Conteudo da NFCe/NFe".
+let data = {
+    idLote: 1, //Identificador de controle do envio do lote. 
+    indSinc: 0, // 0 - Não, 1 = Sim || síncrono
+    compactar: false
+}
+tools.sefazEnviaLote(xml, data);
+```
+
+## 📥 Método `async xmlSign(xmlJSON: string, data: any = { tag: "infNFe" }): Promise<string>`
+Este método é responsável por **assinar digitalmente** o XML da NF-e ou NFC-e utilizando o certificado digital A1 (formato `.pfx`). A assinatura segue o padrão exigido pela SEFAZ e é essencial para a validação do documento fiscal.
+```ts
+let xml = "Conteudo da NFCe/NFe".
+const xmlAssinado = await tools.xmlSign(xml, {
+    tag: "infNFe" //Tag que vai ser usada para gerar assinatura.
+});
+```
+
+## 📥 Método `getCertificado: Promise<object>`
+Este método retorna, de forma assíncrona, o conteúdo do certificado digital **A1 (.pfx)** carregado na instância da classe `Tools`.
+```ts
+const certificado = await tools.getCertificado();
+console.log(certificado) //{ca,key,cert}
+```
+
+## 📥 Método `async consultarNFe(chNFe: string): Promise<string>`
+O método `consultarNFe` realiza a **consulta de uma NF-e ou NFC-e na SEFAZ** utilizando a chave de acesso completa da nota e retorna o status dela em xml.
+```ts
+const xmlStatus = await tools.consultarNFe("CHAVE DA NFE");
+```
+
+## 📥 Método `async sefazStatus(): Promise<string>`
+O método `sefazStatus` realiza a **consulta ao servidor da SEFAZ** utilizando a UF de inicializaçao.
+```ts
+const xmlStatus = await tools.sefazStatus();
+```

package/docs/requisitos.md

@@ -0,0 +1,26 @@
+# Requisitos do Projeto
+
+Este projeto foi desenvolvido e testado com os seguintes requisitos. Certifique-se de instalá-los corretamente para garantir o funcionamento adequado.
+
+## 1. Node.js
+
+- **Versão testada**: `v22.1.4`  
+- É altamente recomendável utilizar a mesma versão para evitar incompatibilidades.
+
+### 1.1 Links para Download
+
+- [Node.js para Windows](https://nodejs.org/dist/v22.1.4/node-v22.1.4-x64.msi)
+- [Node.js para Linux](https://nodejs.org/dist/v22.1.4/node-v22.1.4-linux-x64.tar.xz)
+
+---
+
+## 2. xmllint (libxml) 2.9.3
+
+- Utilizado para validação de arquivos XML, essencial no processo de manipulação de NF-e/NFC-e.
+
+### 2.1 Links para Download
+
+- [libxml2 for Windows (includes xmllint)](http://xmlsoft.org/sources/win32/)
+- Para Linux, você pode instalar via terminal:
+  ```bash
+  sudo apt install libxml2-utils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sped-nfe",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "author": "Kalmon V. Tavares",
   "type": "module",
   "main": "dist/index.js",