@nfewizard/danfe 🪄

Atenção: Ao abrir uma issue certifique-se de adicionar as informações abaixo:

Ao abrir issue ou PR, inclua:

## Parametrização
- Tipo de DANFE: NFe / NFCe / NFSe / CTe

Logs Relevantes

Inclua também informações detalhadas sobre o erro:

{"context":"DANFE_NFe","error":{"message":"Erro ao gerar PDF",...}

Sobre a Biblioteca

@nfewizard/danfe é uma biblioteca Node.js especializada na geração de DANFEs (Documento Auxiliar da Nota Fiscal Eletrônica) em formato PDF. A biblioteca oferece uma solução completa e profissional para criar documentos auxiliares de alta qualidade, incluindo:

• DANFE para NFe: Geração do Documento Auxiliar da Nota Fiscal Eletrônica com layout padrão, incluindo:

  • Código de barras
  • Dados do emitente e destinatário
  • Produtos e serviços
  • Totalizadores e impostos
  • Informações adicionais
  • Suporte para múltiplas páginas

• DANFE para NFCe: Geração do Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica com:

  • QR Code para consulta
  • Layout simplificado para cupom fiscal
  • Dados do consumidor
  • Produtos e totalizadores
  • Informações de pagamento

• DANFSe para NFSe: Geração do Documento Auxiliar da Nota Fiscal de Serviços Eletrônica via webservice:

  • Download direto do PDF do servidor municipal
  • Autenticação mútua TLS com certificado digital
  • Suporte para diferentes municípios

• DACTE para CTe: Geração do Documento Auxiliar do Conhecimento de Transporte Eletrônico com:

  • Código de barras e QR Code (infCTeSupl)
  • Remetente, destinatário, expedidor, recebedor e tomador do serviço
  • Dados da carga e componentes do valor da prestação
  • Informações relativas ao imposto (ICMS)
  • Documentos originários (NF-e, NF em papel e outros) com múltiplas páginas
  • Quadro específico por modal (rodoviário, aéreo, aquaviário, ferroviário, dutoviário e multimodal)

Características

• ✅ Suporta NFe, NFCe, NFSe e CTe
• ✅ QR Code para NFCe e CTe
• ✅ Código de barras para NFe e CTe
• ✅ Download via webservice para NFSe
• ✅ TypeScript - Tipos completos incluídos
• ✅ Alta qualidade - PDFs profissionais e bem formatados

Instalação

npm install @nfewizard/danfe
# ou
pnpm add @nfewizard/danfe

Exemplo de Utilização

DANFE para NFe

import { NFE_GerarDanfe } from '@nfewizard/danfe';

// Json de retorno da lib nfewizard-io
const data = {} as any;
const chave = '99999999999999999999999999999999999999999999';

// Gerar DANFE
await NFE_GerarDanfe({
    data, // Objeto completo com NFe, protNFe e xml
    chave,
    outputPath: './danfe.pdf' // Caminho onde o PDF será salvo
});

DANFE para NFCe

import { NFCE_GerarDanfe } from '@nfewizard/danfe';

// Json de retorno da lib @nfewizard/nfce
const data = {} as any;
const chave = '99999999999999999999999999999999999999999999';

// Gerar DANFE
await NFCE_GerarDanfe({
    data, // Objeto completo com NFe, protNFe e xml
    chave,
    outputPath: './nfce-danfe.pdf', // Caminho onde o PDF será salvo
    pageWidth: 226.772 // Largura para NFCe (80mm)
});

DACTE para CTe

import { CTE_GerarDacte } from '@nfewizard/danfe';

// Json de retorno da lib @nfewizard/cte
const data = {} as any;
const chave = '99999999999999999999999999999999999999999999';

// Gerar DACTE
await CTE_GerarDacte({
    data, // Objeto completo com CTe e protCTe
    chave,
    outputPath: './dacte.pdf' // Caminho onde o PDF será salvo
});

Também é possível informar diretamente o XML autorizado (cteProc) ou o CTe solo. Neste caso a chave é opcional, pois é lida de protCTe.infProt.chCTe ou de infCte.Id:

import fs from 'fs';
import { CTE_GerarDacte } from '@nfewizard/danfe';

await CTE_GerarDacte({
    data: fs.readFileSync('./cte.xml', 'utf8'),
    outputPath: './dacte.pdf'
});

DANFSe para NFSe

import { NFSE_GerarDanfe } from '@nfewizard/danfe';

// Gerar DANFSe localmente a partir do XML autorizado
const resultado = await NFSE_GerarDanfe({
    data: xmlDaNFSe,
    outputPath: './danfse.pdf'
});

console.log(resultado.message); // DANFSe gerada em './danfse.pdf'

Documentação

Para a documentação completa acesse NFeWizard-io - Docs

Observações

• NodeJs: Testado com versões 16 ou superiores.
• Fontes: A biblioteca inclui fontes Arial para garantir consistência visual.
• PDF: Os PDFs gerados seguem o layout padrão definido pela SEFAZ.

Contribua para Nossa Biblioteca Open Source

Primeiramente, obrigado por considerar contribuir para nossa biblioteca! Nosso projeto é de código aberto e gratuito para uso, mas manter e desenvolver novas funcionalidades requer tempo e esforço. Se você achar nosso trabalho útil e quiser apoiar nosso desenvolvimento, considere fazer uma doação.

Por que doar?

• Suporte Contínuo: Sua doação ajuda a manter o projeto ativo e em constante evolução.
• Novos Recursos: Com seu apoio, podemos adicionar novos recursos e melhorias.
• Manutenção e Correções: Garantimos que bugs sejam corrigidos rapidamente e que o código esteja sempre atualizado.
• Reconhecimento: Apoiadores são reconhecidos em nossa documentação e página do projeto.
• Fraldas: Meu primeiro filho nasceu no inicio desse ano, fraldas são caras! 🍼🚼

Como doar?

Você pode contribuir através das seguintes plataformas:

• GitHub Sponsors

• Pix: Se preferir doar via Pix, utilize a seguinte chave:

  Chave Pix: 944ce2f2-e90f-400a-a388-bb1fe6719e02
  Nome: Marco Lima

Agradecemos imensamente seu apoio!

Outras formas de contribuir

Se você não puder doar financeiramente, existem outras maneiras valiosas de contribuir:

• Reportar Bugs: Envie relatórios de bugs e problemas que encontrar.
• Submeter PRs: Contribua com código, documentação ou testes.
• Espalhe a Palavra: Compartilhe nosso projeto com amigos e colegas.

Agradecimentos

Agradecemos imensamente seu apoio e contribuição. Juntos, podemos construir e manter uma ferramenta incrível para todos!

Muito obrigado!

Criadores

| | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | | Marco Lima |

Licença

Projetado com ♥ por Marco Lima. Licenciado sob a GPL-3.0.