# NFeWizard-io ## 🚨 ATENÇÃO: Esta biblioteca foi modularizada! 🚨 A biblioteca nfewizard-io agora está dividida em módulos menores para facilitar a manutenção e otimizar o tamanho do pacote. ⚠️ A partir da versão 1.0.0 este repositório será responsável apenas pelos serviços de NF-e. Para os serviços de NFC-e utilize o `@nfewizard-io/nfce`. ## 📦 Como instalar os novos pacotes? ### Para utilizar serviços relacionados à NFCe instale o modulo: ```typescript npm i @nfewizard-io/nfce ``` 🚀 Pronto, agora você pode decidir utilizar apenas os serviços que precisa! ## Sobre NFeWizard-io é uma biblioteca Node.js projetada para simplificar a interação com os webservices da SEFAZ, proporcionando uma solução robusta para automação de processos relacionados à Nota Fiscal Eletrônica (NF-e). A biblioteca oferece métodos abrangentes para diversas operações fiscais, incluindo: - **Autorização (Emissão de NFe e NFCe)**: Submissão de Notas Fiscais Eletrônicas e Notas Fiscais de Consumidor Eletrônica para autorização. - **Distribuição DFe**: Consulta e Download de DF-e (Documentos fiscais eletrônicos), facilitando o acesso a documentos fiscais eletrônicos. - **Consulta de Protocolo**: Verificação da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. - **Inutilização de NFe**: Processo de inutilização de números de NF-e que não serão utilizados, assegurando a conformidade fiscal. - **Consulta de Status do Serviço**: Monitoramento do status dos serviços da SEFAZ, garantindo a disponibilidade dos webservices. - **Recepção de Eventos**: Tratamento de diversos eventos relacionados à NFe e NFCe, incluindo: - Cancelamento de NFe e NFCe - Carta de Correção - Ciência da Operação - Confirmação da Operação - Desconhecimento da Operação - EPEC (Evento Prévio de Emissão em Contingência) - Operação Não Realizada - **Geração de DANFE**: Criação do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE), um resumo impresso da NFe. ## 🚧 ATENÇÃO 🚧 ### Requisitos para instalação Para utilizar esta biblioteca, é necessário ter o JDK instalado no ambiente. Caso esteja rodando em um ambiente sem suporte ao JDK (como a Vercel) ou que não permita a adição de layers (diferente do AWS Lambda), é possível configurar a biblioteca como uma external lib e utilizar a seguinte opção ao inicializá-la: ```typescript useForSchemaValidation: 'validateSchemaJsBased' ``` ### Exemplo de configuração no Serverless Framework Se estiver usando o Serverless Framework, você pode marcar a biblioteca como external no arquivo de configuração (.yml), garantindo que ela não seja empacotada junto ao código da aplicação: ```yml build: esbuild: bundle: true minify: true sourcemap: true target: 'node20' format: 'cjs' external: - better-sqlite3 - mysql - mysql2 - oracledb - tedious - sqlite3 - pg-query-stream - nfewizard-io ``` Dessa forma, a nfewizard-io será tratada como uma dependência externa, permitindo sua execução sem a necessidade do JDK no ambiente. ### Exemplo de importação CJS Para ambientes CJS (CommonJS) a importação utilizada deverá ser feita da seguinte maneira: ```typescript const NFeWizard = require('nfewizard-io').default; ``` ## Exemplo de Utilização ```typescript import NFeWizard from 'nfewizard-io'; // Instanciar const nfeWizard = new NFeWizard(); // Inicializar await nfeWizard.NFE_LoadEnvironment({ config: { dfe: { baixarXMLDistribuicao: true, pathXMLDistribuicao: "tmp/DistribuicaoDFe", armazenarXMLAutorizacao: true, pathXMLAutorizacao: "tmp/Autorizacao", armazenarXMLRetorno: true, pathXMLRetorno: "tmp/RequestLogs", armazenarXMLConsulta: true, pathXMLConsulta: "tmp/RequestLogs", armazenarXMLConsultaComTagSoap: false, armazenarRetornoEmJSON: true, pathRetornoEmJSON: "tmp/DistribuicaoDFe", pathCertificado: "certificado.pfx", senhaCertificado: "123456", UF: "SP", CPFCNPJ: "99999999999999", }, nfe: { ambiente: 2, versaoDF: "4.00", }, email: { host: 'smtp.example.com', port: 587, secure: false, auth: { user: 'seu-email@example.com', pass: 'sua-senha' }, emailParams: { from: '"Seu Nome" ', to: 'destinatario@example.com', } }, lib: { connection: { timeout: 30000, }, useOpenSSL: false, useForSchemaValidation: 'validateSchemaJsBased', } } }); // Exemplo de Utilização const chaveNFe: DFePorChaveNFe = { cUFAutor: 35, CNPJ: '99999999999999', consChNFe: { chNFe: '00000000000000000000000000000000000000000000' }, } await nfeWizard.NFE_DistribuicaoDFePorChave(chaveNFe); ``` ## Documentação - Para a documentação completa acesse [NFeWizard-io - Docs](https://nfewizard-org.github.io/) ## Última Release (0.3.1) - Efetuados diversos ajustes na emissão de NFC-e. - Alterada estrutura de pastas da lib (com mais alterações estruturais por vir) ## Observações - `Certificado`: Implementado apenas em certificados A1. - `NodeJs`: Testado com versões 16 ou superiores. - `UF`: Testado apenas para São Paulo. Por favor, abra uma issue caso encontre problemas com outros estados. **Para uma boa experiência de Debug no VS Code permitindo fazer o "step into" nos métodos do NfeWizzard, usar o launch.json com sourceMpas true e outFiles conforme segue:**: ```json { "version": "0.2.0", "configurations": [ { "type": "node", "request": "launch", "name": "Launch Program", "skipFiles": [ "/**" ], "program": "${workspaceFolder}/src/index.ts", "outFiles": [ "${workspaceFolder}/**/*.js" ], "sourceMaps": true } ] } ``` **Exemplo do tsconfig.json do projeto que importa o NFEWizard.IO:**: ```json { "compilerOptions": { "target": "es2020", "module": "nodenext", "outDir": "dist", "esModuleInterop": true, "forceConsistentCasingInFileNames": true, "strict": true, "skipLibCheck": true, "sourceMap": true, "inlineSources": true, "inlineSourceMap": false, "declaration": true, "declarationMap": true, "moduleResolution": "nodenext" } } ``` ## Em Desenvolvimento ### Próximos passos - Adicionar tratamento de LOGs - Estudo para implementação de NFSe ## 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](https://github.com/sponsors/Maurelima?frequency=recurring&sponsor=Maurelima) - **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!** # Contribuidores ## Contribuidores de Código Agradecemos aos seguintes desenvolvedores por suas contribuições ao projeto:

dliocode
ThalesAugusto0
cassioseffrin
## Patrocínios Agradecemos imensamente aos nossos patrocinadores pela sua generosidade. ### Contribuições

italosll
### Contribuições Mensais
## Criadores | [](https://github.com/Maurelima) | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | | [Marco Lima](https://github.com/Maurelima) | ## Licença Projetado com ♥ por [Marco Lima](https://github.com/Maurelima). Licenciado sob a [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.pt-br.html).