nfse-brazil-national 1.0.0

package/.github/workflows/npm-publish-github-packages.yml

@@ -0,0 +1,55 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages and npm Registry when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://npm.pkg.github.com/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: production
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org/
+
+      - name: Publish to npm
+        run: NODE_AUTH_TOKEN="" npm publish --provenance --access public
+        continue-on-error: true

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/misc.xml

@@ -0,0 +1,5 @@
+<project version="4">
+  <component name="ProjectRootManager" version="2">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/nfse-brazil-national.iml" filepath="$PROJECT_DIR$/nfse-brazil-national.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,105 @@
+# nfse-brazil-national
+
+[![NPM version](https://img.shields.io/npm/v/nfse-brazil-national)](https://www.npmjs.com/package/nfse-brazil-national)
+
+Biblioteca cliente para integração com a API Nacional da NFS-e (Nota Fiscal de Serviço Eletrônica) do Brasil.
+
+Esta biblioteca facilita a geração, assinatura, validação e transmissão de documentos XML (DPS e Eventos) para o ambiente nacional da NFS-e.
+
+## Funcionalidades
+
+*   **Geração de XML**: Criação de XMLs de DPS e Cancelamento baseados em templates.
+*   **Assinatura Digital**: Assinatura XMLDSIG (padrão ICP-Brasil) utilizando certificados A1 (PFX/PKCS#12 ou PEM).
+*   **Validação XSD**: Validação local dos XMLs gerados contra os schemas oficiais antes do envio.
+*   **Comunicação API**: Métodos para emissão síncrona, consulta e cancelamento.
+*   **Helpers**: Utilitários para geração de IDs (DPS/Eventos) e formatação de datas no padrão exigido.
+
+## Instalação
+
+```bash
+npm install nfse-brazil-national
+```
+
+## Uso
+
+### Configuração
+
+Importe a classe e instancie o cliente com as credenciais e o certificado digital.
+
+```javascript
+import { NfseNationalClient } from "nfse-brazil-national";
+
+const client = new NfseNationalClient({
+    // URL do ambiente (Homologação ou Produção)
+    baseURL: "https://sefin.producaorestrita.nfse.gov.br/SefinNacional", 
+    // Caminho para o certificado PFX ou Buffer
+    certificate: "./certificado.pfx",
+    // Senha do certificado
+    password: "sua-senha-aqui"
+});
+```
+
+### Emissão de NFS-e (Envio de DPS)
+
+Para emitir uma nota, utilize os métodos estáticos para gerar IDs e datas no formato correto.
+
+```javascript
+// 1. Gerar ID e Data formatada
+const idDps = NfseNationalClient.generateDpsId(
+    "3304557",        // Código Município Emitente (ex: Rio de Janeiro)
+    "2",              // Tipo Inscrição Federal (2=CNPJ)
+    "00000000000191", // CNPJ Emitente
+    "900",            // Série
+    "1"               // Número DPS
+);
+
+const dataEmissao = NfseNationalClient.generateDateTime(); // Data atual formatada
+
+// 2. Montar dados (exemplo simplificado)
+const dadosDps = {
+    id: idDps,
+    ambiente: "2", // 2-Homologação
+    dataEmissao: dataEmissao,
+    // ... demais campos (prestador, tomador, servico, valores)
+};
+
+// 3. Emitir (Gera XML, Assina, Valida XSD e Envia)
+try {
+    const resultado = await client.issueNfse(dadosDps);
+    console.log("NFS-e emitida com sucesso!");
+    console.log("Chave de Acesso:", resultado.chaveAcesso);
+} catch (error) {
+    console.error("Erro na emissão:", error.message);
+}
+```
+
+### Cancelamento de NFS-e
+
+```javascript
+const chaveAcesso = "332601..."; // Chave da nota a cancelar
+
+// 1. Gerar ID do Evento (101101 = Cancelamento)
+const idEvento = NfseNationalClient.generateEventId(chaveAcesso, "101101");
+
+const dadosCancelamento = {
+    id: idEvento,
+    ambiente: "2",
+    versaoAplicacao: "1.0.0",
+    dataHoraEvento: NfseNationalClient.generateDateTime(),
+    chaveAcesso: chaveAcesso,
+    codigoMotivo: "1", // 1-Erro na Emissão
+    descricaoMotivo: "Cancelamento solicitado via API"
+};
+
+// 2. Enviar Cancelamento
+const resultado = await client.cancelNfse(dadosCancelamento, chaveAcesso);
+```
+
+## API Reference
+
+*   `issueNfse(dpsData)`: Gera o XML do DPS, assina e envia para a API.
+*   `cancelNfse(cancelamentoData, chaveAcesso)`: Gera o XML do evento, assina e envia.
+*   `getNfse(chaveAcesso)`: Retorna os dados de uma NFS-e específica.
+*   `getDps(idDps)`: Consulta status de um DPS.
+*   `generateDpsXml(dpsData)`: Apenas gera o XML assinado (sem enviar).
+*   `validateDpsXml(xmlString)`: Valida XML contra o XSD.

package/examples/sequence.json

@@ -0,0 +1,3 @@
+{
+  "lastSequence": 1
+}

package/examples/simple-usage.js

@@ -0,0 +1,184 @@
+import { NfseNationalClient } from "../src/index.js";
+import fs from "fs/promises";
+import path from "path";
+import { fileURLToPath } from "url";
+
+// --- CONFIGURAÇÃO ---
+const CERTIFICATE_PATH = "...";
+const CERTIFICATE_PASSWORD = "---";
+const SEQUENCE_FILE = path.join(path.dirname(fileURLToPath(import.meta.url)), "sequence.json");
+// --------------------
+
+async function getNextSequence() {
+    try {
+        const data = await fs.readFile(SEQUENCE_FILE, 'utf8');
+        const json = JSON.parse(data);
+        const next = json.lastSequence + 1;
+        await fs.writeFile(SEQUENCE_FILE, JSON.stringify({ lastSequence: next }, null, 2));
+        return next;
+    } catch (error) {
+        // Se o arquivo não existir, começa do 1
+        const initial = 1;
+        await fs.writeFile(SEQUENCE_FILE, JSON.stringify({ lastSequence: initial }, null, 2));
+        return initial;
+    }
+}
+
+async function main() {
+    const baseURL = "https://sefin.producaorestrita.nfse.gov.br/SefinNacional";
+    //const baseURL = "https://sefin.nfse.gov.br/SefinNacional";
+
+    try {
+        console.log(`Using certificate: ${CERTIFICATE_PATH}`);
+
+        const client = new NfseNationalClient({
+            baseURL: baseURL,
+            certificate: CERTIFICATE_PATH,
+            password: CERTIFICATE_PASSWORD
+        });
+
+        // Dados para geração do ID da DPS
+        const municipioEmitente = "3304557"; // Rio de Janeiro
+        const tipoInscricaoFederal = "2"; // 2-CNPJ
+        const inscricaoFederal = "38027543000175"; // CNPJ
+        const serieDps = "900"; // Série do XML exemplo
+        
+        // Obtém o próximo número sequencial
+        const seq = await getNextSequence();
+        const numeroDps = seq.toString();
+        
+        // Gera o ID utilizando o helper da biblioteca
+        const idDps = NfseNationalClient.generateDpsId(
+            municipioEmitente, 
+            tipoInscricaoFederal, 
+            inscricaoFederal, 
+            serieDps, 
+            numeroDps
+        );
+
+        const dadosDps = {
+            // --- Informações do DPS ---
+            id: idDps,
+            versaoAplicacao: "1.0.0",
+            ambiente: "2", // 1-Produção, 2-Homologação
+            dataEmissao: NfseNationalClient.generateDateTime(),
+            serie: serieDps,
+            numero: numeroDps,
+            competencia: "2026-01-01", // Competência do XML exemplo
+            tipoEmitente: "1", // 1-Prestador
+            municipioEmissao: municipioEmitente,
+
+            // --- Prestador ---
+            prestador: {
+                cnpj: inscricaoFederal,
+                telefone: "5121026080",
+                optanteSimplesNacional: "3", // 1-Não Optante, 2-MEI, 3-ME/EPP
+                regimeApuracaoTributacaoSN: "1", // 1-Recolhimento pelo SN
+                regimeEspecialTributacao: "0" // 0-Nenhum
+            },
+
+            // --- Tomador ---
+            tomador: {
+                cpf: "...",
+                nome: "...",
+
+                /*endereco: {
+                    codigoMunicipio: "...",
+                    cep: "...",
+                    logradouro: "...",
+                    numero: "...",
+                    bairro: "...",
+                    complemento: "...",
+                },
+                telefone: "...",
+                email: "..."*/
+            },
+
+            // --- Serviço ---
+            servico: {
+                municipioPrestacao: municipioEmitente,
+                codigoTributacaoNacional: "080201",
+                codigoTributacaoMunicipal: "015",
+                descricao: "...",
+                codigoNbs: "122051900",
+                codigoInterno: "0"
+            },
+
+            valores: {
+                valorServicos: "10.00",
+                tributacaoIssqn: "1",
+                tipoRetencaoIssqn: "1", 
+                //aliquotaIssqn: "0.00",
+                tributosDetalhado: {
+                    federal: "0.00",
+                    estadual: "0.00",
+                    municipal: "0.00"
+                }
+            }
+        };
+        
+        console.log("Generating XML...");
+        const xmlAssinado = await client.generateDpsXml(dadosDps);
+
+        console.log("Validating XML against XSD...");
+        await client.validateDpsXml(xmlAssinado);
+        console.log("XML Valid!");
+
+        console.log(`Sending DPS (ID: ${dadosDps.id})...`);
+        
+        let resultado;
+        resultado = await client.issueNfse(xmlAssinado);
+        
+        if (resultado) {
+            console.log("Success! API Response:");
+            console.log(JSON.stringify(resultado, null, 2));
+        }
+
+        if (resultado && resultado.chaveAcesso) {
+            console.log(`\nAttempting to cancel NFS-e: ${resultado.chaveAcesso}`);
+            
+            const cancelamentoData = {
+                id: NfseNationalClient.generateEventId(resultado.chaveAcesso, "101101"),
+                ambiente: "2", // 1-Produção, 2-Homologação
+                versaoAplicacao: "1.0.0",
+                dataHoraEvento: NfseNationalClient.generateDateTime(),
+                cnpjAutor: inscricaoFederal, 
+                chaveAcesso: resultado.chaveAcesso,
+                numeroPedido: "001",
+                codigoMotivo: "1", // 1-Erro na Emissão
+                descricaoMotivo: "Cancellation test via API"
+            };
+
+            console.log("Generating Cancellation XML...");
+            const xmlCancelamento = await client.generateCancellationXml(cancelamentoData);
+
+            console.log("Validating Cancellation XML...");
+            await client.validateEventXml(xmlCancelamento);
+            console.log("Cancellation XML Valid!");
+
+            const resultadoCancelamento = await client.cancelNfse(xmlCancelamento, resultado.chaveAcesso);
+            console.log("Cancellation successful!");
+            console.log(JSON.stringify(resultadoCancelamento, null, 2));
+        }
+
+    } catch (error) {
+        console.error("Execution error:");
+        if (error.status) {
+            console.error(`HTTP Status: ${error.status}`);
+            console.error("Details:", JSON.stringify(error.data, null, 2));
+        } else {
+            console.error("Message:", error.message);
+            if (error.cause) {
+                console.error("Cause:", error.cause);
+            }
+            if (error.code) {
+                console.error("Error Code:", error.code);
+            }
+            if (error.originalError && error.originalError.response) {
+                 console.error("Response Data:", error.originalError.response.data);
+            }
+        }
+    }
+}
+
+main();

package/fix-xsd.js

@@ -0,0 +1,59 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const targetFile = path.join(__dirname, 'src', 'templates', 'xsd', 'tiposSimples_v1.00.xsd');
+
+async function main() {
+    try {
+        console.log(`Lendo arquivo: ${targetFile}`);
+        let data = await fs.readFile(targetFile, 'utf8');
+        let modified = false;
+
+        // 1. Substituir \d por [0-9] para compatibilidade com libxml2/xmllint
+        // O xmllint (usado no macOS/Linux) não suporta o atalho \d em XSD regex, exigindo [0-9]
+        if (data.includes('\\d')) {
+            // Substitui todas as ocorrências globais de \d por [0-9]
+            data = data.replace(/\\d/g, '[0-9]');
+            console.log('✅ Todas as ocorrências de \\d substituídas por [0-9].');
+            modified = true;
+        }
+
+        // 2. Remover âncoras ^ e $ (XSD 1.0 trata como literais, não como início/fim de string)
+        if (data.includes('^') || data.includes('$')) {
+             // Remove ^ logo após as aspas de abertura
+             data = data.replace(/value="\^/g, 'value="');
+             
+             // Remove $ logo antes das aspas de fechamento
+             data = data.replace(/\$"/g, '"');
+             
+             console.log('✅ Âncoras ^ e $ removidas (incompatíveis com XSD 1.0/libxml2).');
+             modified = true;
+        }
+
+        // 2. Atualizar versão do Schema para 1.01
+        /*const oldVersionStr = 'value="1\\.00"';
+        const newVersionStr = 'value="1\\.01"';
+
+        if (data.includes(oldVersionStr)) {
+            data = data.replaceAll(oldVersionStr, newVersionStr);
+            console.log('✅ Versão do Schema atualizada para 1.01.');
+            modified = true;
+        }*/
+
+
+        if (modified) {
+            await fs.writeFile(targetFile, data, 'utf8');
+            console.log('💾 Arquivo XSD salvo com sucesso.');
+        } else {
+            console.log('⚠️ Nenhuma alteração necessária (o arquivo já pode estar atualizado).');
+        }
+    } catch (err) {
+        console.error('❌ Erro:', err.message);
+    }
+}
+
+main();

package/nfse-brazil-national.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "nfse-brazil-national",
+  "version": "1.0.0",
+  "description": "Biblioteca cliente para integração com a API Nacional da NFS-e (Nota Fiscal de Serviço Eletrônica) do Brasil.",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": "./src/index.js",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flaviolacer/nfse-brazil-national.git"
+  },
+  "author": "Flavio Lacerda",
+  "homepage": "https://github.com/flaviolacer/nfse-brazil-national",
+  "scripts": {
+    "test": "node --test"
+  },
+  "public": true,
+  "dependencies": {
+    "axios": "^1.13.2",
+    "handlebars": "^4.7.8",
+    "xml-crypto": "^6.0.0",
+    "@xmldom/xmldom": "^0.8.10",
+    "node-forge": "^1.3.1"
+  }
+}