@nfewizard-io/nfce

v1.0.2

Published

7 months ago

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 (NFC-e).

Downloads

0High
0Medium
0Low

maurelima

nfe nfce nota fiscal eletrônica dfe sefaz danfe recepção de eventos fiscal eventos nfe epec

NFeWizard-io - Módulo NFCe

🚧 Emissão NFe 🚧

Para emissão e demais eventos de NFe utilize a lib nfewizard-io

npm i nfewizard-io

Sobre

Autorização (Emissão de NFCe): Submissão de Notas Fiscais de Consumidor Eletrônica para autorização.
Consulta de Protocolo: Verificação da situação atual da NFC-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.
Inutilização de NFCe: Processo de inutilização de números de NFC-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 Estadual, garantindo a disponibilidade dos webservices.
Recepção de Eventos: Tratamento de diversos eventos relacionados à NFCe, incluindo:
- Cancelamento de NFCe
- EPEC (Evento Prévio de Emissão em Contingência)
Geração de DANFE: Criação do Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica (DANFE), um resumo impresso da NFCe.

🚧 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:

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:

build:
  esbuild:
    bundle: true
    minify: true
    sourcemap: true
    target: 'node20'
    format: 'cjs'
    external:
      - 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:

const NFeWizard = require('nfewizard-io').default;

Exemplo de Utilização

import NFeWizard from 'nfewizard-io';
// Instanciar
const nfeWizard = new NFeWizard();

// Inicializar
await nfeWizard.NFCE_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",
            idCSC: 1,
            tokenCSC: '99999999-9999-9999-9999-999999999999'
        },
        email: {
            host: 'smtp.example.com',
            port: 587,
            secure: false,
            auth: {
                user: '[email protected]',
                pass: 'sua-senha'
            },
            emailParams: {
                from: '"Seu Nome" <[email protected]>',
                to: '[email protected]',
            }
        },
        lib: {
            connection: {
                timeout: 30000,
            },
            useOpenSSL: false,
            useForSchemaValidation: 'validateSchemaJsBased',
        }
    }
});

// Exemplo de Utilização
await nfeWizard.NFCE_ConsultaStatusServico();

Documentação

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

Última Release (0.3.16)

Observações

Certificado: Implementado apenas em certificados A1.
NodeJs: Testado com versões 16 ou superiores.
UF: Testado apenas para São Paulo. Status das homologações pode ser consultado no arquivo STATUS_HOMOLOGAÇÃO.

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::

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "program": "${workspaceFolder}/src/index.ts",
            "outFiles": [
                "${workspaceFolder}/**/*.js"
            ],
            "sourceMaps": true
        }
    ]
}

Exemplo do tsconfig.json do projeto que importa o NFEWizard.IO::

{
  "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

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:

Patrocínios

Agradecemos imensamente aos nossos patrocinadores pela sua generosidade.

Contribuições

Contribuições Mensais

Criadores

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

Licença

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