nfe-lib-node 1.6.0 → 1.8.0

package/README.md

@@ -1,168 +1,70 @@
 # nfe-lib-node 🚀
 
-Uma biblioteca Node.js em TypeScript para emissão de Nota Fiscal Eletrônica (NF-e) focada em simplicidade, segurança e sem dependência de serviços terceiros (SaaS). 
+Biblioteca Node.js em TypeScript para emissão e gestão de **Nota Fiscal Eletrônica (NF-e Modelo 55 — Layout 4.00)** com comunicação direta com a SEFAZ (mTLS/SOAP 1.2), assinatura XMLDSig e geração nativa de DANFE em PDF.
 
 Pague apenas os seus impostos, não pela emissão! 😉
 
 ## 📦 Instalação
 
-Instale diretamente via NPM:
-
 ```bash
 npm install nfe-lib-node
 ```
 
-Ou, para clonar e rodar localmente:
-
-```bash
-git clone https://github.com/rafconrado/nfe-lib-node.git
-cd nfe-lib-node
-npm install
-```
-
-## 🚀 Como usar
-
-A arquitetura foi pensada para ser o mais simples possível. Você só precisa do seu Certificado Digital A1 (`.pfx`).
-
-### 1. Validar Certificado e Consultar Status do Serviço (SEFAZ)
-
-```typescript
-import { NFe, Certificado } from 'nfe-lib-node';
-import fs from 'fs';
-
-async function testarSefaz() {
-  const certificado = new Certificado(fs.readFileSync('./certificado.pfx'), 'SENHA_DO_CERTIFICADO');
-
-  // Opcional: Inspecionar dados e validade do Certificado A1 (ICP-Brasil)
-  const dadosCert = certificado.getDados();
-  console.log(`Titular: ${dadosCert.nomeComum} (${dadosCert.cnpjOuCpf})`);
-  console.log(`Válido: ${dadosCert.estaValido} (${dadosCert.diasParaVencer} dias restantes)`);
-
-  const nfe = new NFe({ uf: 'DF', ambiente: 'homologacao', certificado });
-
-  const status = await nfe.consultarStatus();
-  console.log(status.xml);
-}
-```
-
-### 2. Emitir uma NF-e (Autorização) e Gerar DANFE em PDF
-
-A biblioteca cuida da infraestrutura completa (Tipagem do Layout 4.00, Assinatura XMLDSig, comunicação SOAP e geração de DANFE em PDF sem dependências pesadas):
+## ⚡ Uso Rápido
 
 ```typescript
+import fs from 'node:fs';
 import { NFe, Certificado, Danfe, type DadosNFe } from 'nfe-lib-node';
-import fs from 'fs';
-
-async function emitirNota() {
-  const certificado = new Certificado(fs.readFileSync('./certificado.pfx'), 'SENHA_DO_CERTIFICADO');
-  const nfe = new NFe({ uf: 'DF', ambiente: 'homologacao', certificado });
-
-  const nota: DadosNFe = {
-    infNFe: {
-      '@Id': 'NFe5326...',
-      '@versao': '4.00',
-      ide: { /* ... */ },
-      emit: { /* ... */ },
-      dest: { /* ... */ },
-      det: [ /* ... */ ],
-      total: { /* ... */ },
-      transp: { /* ... */ },
-      pag: { /* ... */ }
-    }
-  };
-
-  const resposta = await nfe.emitir(nota);
-  console.log(`Status: ${resposta.status} - ${resposta.motivo}`);
-
-  // Gera o PDF do DANFE diretamente a partir do XML assinado + retorno da SEFAZ
-  if (resposta.xmlAssinado) {
-    const pdfBuffer = Danfe.fromXml(resposta.xmlAssinado, resposta.xml);
-    fs.writeFileSync('./danfe.pdf', pdfBuffer);
-  }
-}
-```
-
-### 3. Consultar Protocolo, Recibo, Cancelar, Carta de Correção, Inutilizar e Manifestar
-
-```typescript
-import { NFe, Certificado } from 'nfe-lib-node';
-import fs from 'fs';
-
-async function gerenciarNotas() {
-  const certificado = new Certificado(fs.readFileSync('./certificado.pfx'), 'SENHA_DO_CERTIFICADO');
-  const nfe = new NFe({ uf: 'DF', ambiente: 'homologacao', certificado });
-
-  const chave = '53260999999999999999550010000000011847291634';
-
-  // 1. Consulta de Protocolo por Chave de Acesso (NFeConsultaProtocolo4)
-  const consulta = await nfe.consultarProtocolo(chave);
-  console.log(`Situação: ${consulta.status} - ${consulta.motivo}`);
-
-  // 2. Consulta de Recibo de Lote de 15 dígitos (NFeRetAutorizacao4)
-  const recibo = await nfe.consultarRecibo('531000000000001');
-  console.log(`Recibo: ${recibo.status} - ${recibo.motivo}`);
-
-  // 3. Carta de Correção Eletrônica - CC-e (tpEvento 110110)
-  const cce = await nfe.cartaCorrecao({
-    chave,
-    correcao: 'Correcao na descricao complementar da mercadoria transportada.',
-    nSeqEvento: 1,
-  });
-  console.log(`CC-e: ${cce.status} - ${cce.motivo}`);
 
-  // 4. Cancelamento de NF-e (tpEvento 110111)
-  const cancelamento = await nfe.cancelar({
-    chave,
-    protocolo: '153260000000001',
-    justificativa: 'Erro no preenchimento dos dados comerciais da nota fiscal.',
-  });
-  console.log(`Cancelamento: ${cancelamento.status} - ${cancelamento.motivo}`);
-
-  // 5. Inutilização de Faixa de Numeração (NFeInutilizacao4)
-  const inutilizacao = await nfe.inutilizar({
-    cnpj: '00000000000000',
-    serie: 1,
-    numeroInicial: 10,
-    numeroFinal: 12,
-    justificativa: 'Quebra de sequencia na numeracao do sistema emissor.',
+const certificado = new Certificado(fs.readFileSync('./certificado.pfx'), 'SENHA_DO_PFX');
+const nfe = new NFe({ uf: 'DF', ambiente: 'homologacao', certificado });
+
+// 1. Emitir NF-e (@Id, cUF, cNF, cDV, dhEmi e tpAmb são calculados automaticamente se omitidos)
+const nota: DadosNFe = {
+  infNFe: {
+    ide: { natOp: 'VENDA', serie: '1', nNF: '100', tpNF: '1', idDest: '1', cMunFG: '5300108', tpImp: '1', tpEmis: '1', finNFe: '1', indFinal: '1', indPres: '1', procEmi: '0', verProc: '1.0.0' },
+    emit: { /* dados do emitente */ } as any,
+    dest: { /* dados do destinatário */ } as any,
+    det: [ /* itens da nota */ ],
+    total: { /* totais ICMSTot */ } as any,
+    transp: { modFrete: '9' },
+    pag: { detPag: [{ tPag: '01', vPag: '100.00' }] },
+  },
+};
+
+const emissao = await nfe.emitir(nota);
+console.log(emissao.chave, emissao.status, emissao.motivo);
+
+// 2. Gerar DANFE A4 em PDF (com suporte opcional a logo PNG/JPEG)
+if (emissao.xmlAssinado) {
+  const pdf = Danfe.fromXml(emissao.xmlAssinado, emissao.xml, {
+    logo: fs.readFileSync('./logo.png'), // opcional
   });
-  console.log(`Inutilização: ${inutilizacao.status} - ${inutilizacao.motivo}`);
-
-  // 6. Manifestação do Destinatário no Ambiente Nacional (210210, 210200, 210220, 210240)
-  const ciencia = await nfe.manifestar({
-    chave,
-    tipo: 'ciencia', // 'ciencia' | 'confirmacao' | 'desconhecimento' | 'nao_realizada'
-  });
-  console.log(`Manifestação: ${ciencia.status} - ${ciencia.motivo}`);
+  fs.writeFileSync('./danfe.pdf', pdf);
 }
 ```
 
-## ✨ Funcionalidades Atuais
-
-* 🔐 **Certificado Digital A1 (`.pfx`)**: Extração com cache em memória, inspeção de validade/titular (`getDados()`, `estaValido()`) e configuração de mTLS.
-* 🔑 **Chave de Acesso (Módulo 11)**: Geração, validação, extração de dados da chave de 44 dígitos e cálculo automático do `cDV` (`gerarChaveAcesso`, `validarChaveAcesso`, `getDadosChaveAcesso`, `getDigitoVerificador`).
-* ✍️ **Assinatura Digital XMLDSig**: Assinatura no padrão exigido pela SEFAZ (`rsa-sha1` / `enveloped-signature` / `c14n`) para NF-e, Eventos e Inutilização (`assinarXmlNFe`, `assinarXmlEvento`, `assinarXmlInutilizacao`).
-* 🗺️ **Mapeamento Completo de WebServices por UF e Ambiente Nacional**: Resolução automática das URLs oficiais da NF-e 4.00 para todas as 27 UFs e Ambiente Nacional (`getUrlSefaz`, `getUrlAmbienteNacional`, `getAutorizadorPorUF`, `getCodigoUF` — Autorizadores próprios: AM, BA, GO, MG, MS, MT, PE, PR, RS, SP + SVAN, SVRS, AN e contingência SVC-AN / SVC-RS).
-* 📡 **Comunicação SEFAZ Completa (SOAP 1.2)**: Consulta de status (`consultarStatus`), autorização síncrona (`emitir`), consulta de protocolo por chave (`consultarProtocolo`), consulta de recibo (`consultarRecibo`), cancelamento (`cancelar`), carta de correção (`cartaCorrecao`), inutilização de numeração (`inutilizar`) e manifestação do destinatário (`manifestar`), com montagem automática de `<nfeProc>`, `<procEventoNFe>` e `<ProcInutNFe>`.
-* 📄 **Gerador de DANFE em PDF**: Geração nativa de PDF com código de barras `Code128C` via `Danfe.fromXml()`.
-* 📘 **Tipagem TypeScript Completa**: Interfaces completas da NF-e / NFC-e 4.00 (incluindo os novos grupos de IBS/CBS da Reforma Tributária).
+## 🛠️ Operações Disponíveis
+
+| Método / Utilitário | Descrição |
+| :--- | :--- |
+| `nfe.consultarStatus()` | Consulta disponibilidade do webservice da UF (`NFeStatusServico4`) |
+| `nfe.emitir(dados)` | Assina, calcula chave/`cDV` automaticamente, envia lote síncrono e monta `<nfeProc>` |
+| `nfe.consultarProtocolo(chave)` | Consulta situação atual e protocolo da NF-e (`NFeConsultaProtocolo4`) |
+| `nfe.consultarRecibo(recibo)` | Consulta resultado de processamento de lote (`NFeRetAutorizacao4`) |
+| `nfe.cancelar({ chave, protocolo, justificativa })` | Envia evento de Cancelamento (`110111`) e retorna `<procEventoNFe>` |
+| `nfe.cartaCorrecao({ chave, correcao, nSeqEvento })` | Envia Carta de Correção Eletrônica — CC-e (`110110`) |
+| `nfe.inutilizar({ cnpj, serie, numeroInicial, numeroFinal, justificativa })` | Inutiliza faixa de numeração (`NFeInutilizacao4`) e retorna `<ProcInutNFe>` |
+| `nfe.manifestar({ chave, tipo, justificativa? })` | Manifestação do Destinatário no Ambiente Nacional (`ciencia`, `confirmacao`, `desconhecimento`, `nao_realizada`) |
+| `nfe.distribuicaoDFe({ ultimoNSU \| nsu \| chave })` | Consulta `NFeDistribuicaoDFe` e descompacta `<docZip>` automaticamente |
+| `Danfe.fromXml(xml, xmlRetorno?, { logo? })` | Gera PDF A4 do DANFE (monocromático padrão NFePHP, paginação automática e logo opcional) |
+| `certificado.getDados()` | Extrai titular, CNPJ/CPF, validade e dias restantes do Certificado A1 (`.pfx`) |
+| `gerarChaveAcesso` / `validarChaveAcesso` | Gera, valida e extrai campos da chave de 44 dígitos (Módulo 11) |
 
 ## 🛡️ Segurança
 
-* **Nunca** faça commit do seu arquivo `.pfx` ou da sua senha para o GitHub.
-* O arquivo `.gitignore` já vem configurado para ignorar extensões de certificados por padrão.
-
-## 🤝 Contribuições
-
-As próximas etapas envolvem suporte a Distribuição de DF-e (`NFeDistribuicaoDFe`) e geração de QR-Code para NFC-e (Modelo 65). Toda contribuição da comunidade Node.js brasileira é bem-vinda!
-
-## 👨‍💻 Autor
-
-Criado e idealizado por **Rafael Conrado**.
-Se você curtiu o projeto, me dê um "Alô" nas redes:
-* [GitHub - @rafconrado](https://github.com/rafconrado)
-* [LinkedIn](https://www.linkedin.com/in/rafconradoo/)
+Nunca faça commit do seu arquivo `.pfx` ou da sua senha. O `.gitignore` do projeto já bloqueia extensões de certificados (`.pfx`, `.p12`, `.cer`, `.key`, `.pem`) e variáveis `.env`.
 
-## 📝 Licença
+## 👨‍💻 Autor & Licença
 
-MIT License
+Criado por **Rafael Conrado** ([GitHub](https://github.com/rafconrado) • [LinkedIn](https://www.linkedin.com/in/rafconradoo/)). Distribuído sob a licença **MIT**.

package/dist/Danfe.d.ts

@@ -1,16 +1,35 @@
+export interface OpcoesDanfe {
+    /**
+     * Logomarca da empresa emitente em formato PNG ou JPEG (`Buffer`, base64 ou Data URI `data:image/...;base64,...`).
+     * Quando informada, é renderizada no quadro "IDENTIFICAÇÃO DO EMITENTE" seguindo o padrão NFePHP (`sped-da`).
+     */
+    logo?: Buffer | string | undefined;
+}
 export declare class Danfe {
-    static fromXml(xmlNFe: string, xmlRetornoSefaz?: string): Buffer;
+    static fromXml(xmlNFe: string, xmlRetornoSefazOuOpcoes?: string | OpcoesDanfe, opcoes?: OpcoesDanfe): Buffer;
+    private static drawSectionTitle;
+    private static drawFieldBox;
+    private static drawRoundedRect;
+    private static drawHLine;
+    private static drawVLine;
+    private static drawLabel;
+    private static drawAlignedItemCell;
+    private static estimateTextWidth;
+    private static drawText;
+    private static drawTextRight;
+    private static drawTextCentered;
+    private static wrapText;
+    private static escapePdfText;
     private static getDescricaoFrete;
     private static getDescricaoPagamento;
     private static formatDecimal;
+    private static formatNumeroNF;
+    private static formatCep;
     private static getTag;
     private static formatDoc;
     private static formatDateTime;
-    private static drawSectionHeader;
-    private static drawBox;
-    private static drawText;
-    private static escapePdfText;
     private static drawCode128C;
+    private static parseLogoImage;
     private static buildPdfBuffer;
 }
 //# sourceMappingURL=Danfe.d.ts.map

package/dist/Danfe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Danfe.d.ts","sourceRoot":"","sources":["../src/Danfe.ts"],"names":[],"mappings":"AAwDA,qBAAa,KAAK;IAChB,OAAc,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CA4OtE;IAED,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAYhC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAcpC,OAAO,CAAC,MAAM,CAAC,aAAa;IAM5B,OAAO,CAAC,MAAM,CAAC,MAAM;IAYrB,OAAO,CAAC,MAAM,CAAC,SAAS;IAWxB,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAIhC,OAAO,CAAC,MAAM,CAAC,OAAO;IAoBtB,OAAO,CAAC,MAAM,CAAC,QAAQ;IAMvB,OAAO,CAAC,MAAM,CAAC,aAAa;IAS5B,OAAO,CAAC,MAAM,CAAC,YAAY;IAgC3B,OAAO,CAAC,MAAM,CAAC,cAAc;CA6B9B"}
+{"version":3,"file":"Danfe.d.ts","sourceRoot":"","sources":["../src/Danfe.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACpC;AAkED,qBAAa,KAAK;IAChB,OAAc,OAAO,CACnB,MAAM,EAAE,MAAM,EACd,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,EAC9C,MAAM,CAAC,EAAE,WAAW,GACnB,MAAM,CAgbR;IAED,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAI/B,OAAO,CAAC,MAAM,CAAC,YAAY;IA2B3B,OAAO,CAAC,MAAM,CAAC,eAAe;IAyB9B,OAAO,CAAC,MAAM,CAAC,SAAS;IAIxB,OAAO,CAAC,MAAM,CAAC,SAAS;IAIxB,OAAO,CAAC,MAAM,CAAC,SAAS;IAIxB,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAKhC,OAAO,CAAC,MAAM,CAAC,QAAQ;IAMvB,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAM/B,OAAO,CAAC,MAAM,CAAC,QAAQ;IAkBvB,OAAO,CAAC,MAAM,CAAC,aAAa;IAU5B,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAYhC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAcpC,OAAO,CAAC,MAAM,CAAC,aAAa;IAM5B,OAAO,CAAC,MAAM,CAAC,cAAc;IAK7B,OAAO,CAAC,MAAM,CAAC,SAAS;IAQxB,OAAO,CAAC,MAAM,CAAC,MAAM;IAYrB,OAAO,CAAC,MAAM,CAAC,SAAS;IAWxB,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B,OAAO,CAAC,MAAM,CAAC,YAAY;IAgC3B,OAAO,CAAC,MAAM,CAAC,cAAc;IAqM7B,OAAO,CAAC,MAAM,CAAC,cAAc;CA2D9B"}