@pereirajair/nfse-gov-br-node 0.0.3 → 0.3.0

package/README.md

@@ -0,0 +1,90 @@
+# @pereirajair/nfse-gov-br-node
+
+Unofficial Node.js library for interacting with the Brazilian **NFS-e Nacional** (Nota Fiscal de Serviço Eletrônica) API.
+
+This library simplifies the process of generating, signing, and transmitting the DPS (Declaração Prévia de Serviço) using an A1 digital certificate.
+
+## Features
+
+- **Full XML Generation**: Automatically builds the compliant XML structure for DPS.
+- **XML Signing**: Handles XML Digital Signature (X509) using `xml-crypto` (RSA-SHA1 + Enveloped Signature), fully compatible with the national standard.
+- **mTLS Authentication**: Easy configuration for A1 (PFX) certificates for mutual TLS authentication.
+- **Homologation & Production**: toggle between environments easily.
+- **Typed Interfaces**: TypeScript definitions for all major data structures (DPS, Prestador, Tomador, etc.).
+
+## Installation
+
+```bash
+npm install @pereirajair/nfse-gov-br-node
+```
+
+## Prerequisites
+
+- **Node.js** >= 18
+- **A1 Digital Certificate** (.pfx or .p12)
+- **OpenSSL** (usually required by `node-forge` or `xml-crypto` under the hood for some operations, though mostly pure JS).
+
+## Usage
+
+### 1. Basic Setup
+
+First, load your certificate and initialize the client:
+
+```javascript
+const fs = require('fs');
+const { loadA1Certificate, NfseClient } = require('@pereirajair/nfse-gov-br-node');
+
+// Load Certificate
+const pfxBuffer = fs.readFileSync('path/to/certificate.pfx');
+const certificateData = loadA1Certificate(pfxBuffer, 'YOUR_PASSWORD');
+
+// Initialize Client (homologacao or producao)
+const client = new NfseClient({
+  environment: 'homologacao', // or 'producao'
+  certificate: certificateData,
+});
+```
+
+### 2. Sending a DPS (Issue NFS-e)
+
+```javascript
+const { enviaDps, generateDpsId } = require('@pereirajair/nfse-gov-br-node');
+
+const dpsDataForId = {
+  municipioEmissao: '4125506',
+  prestador: { cnpj: '00000000000000' },
+  serie: '1',
+  numero: '10'
+};
+const idDps = generateDpsId(dpsDataForId);
+
+const dps = {
+  id: idDps,
+  ambiente: 2, // 2-Homologação
+  dataEmissao: new Date(),
+  serie: '1',
+  numero: '10',
+  prestador: { ... },
+  tomador: { ... },
+  servico: { ... },
+  valores: { ... }
+  // See examples/enviar-dps.js for full object structure
+};
+
+enviaDps(dps, client, certificateData)
+  .then(response => {
+     console.log('NFS-e Issued!', response.chaveAcesso);
+  })
+  .catch(err => console.error(err));
+```
+
+## Examples
+
+Check the `examples/` directory for complete working scripts:
+- `enviar-dps.js`: Full example of issuing an NFS-e.
+- `consultar-nfse.js`: Query an NFS-e by Access Key.
+- `consultar-dps.js`: Query a DPS by ID.
+
+## License
+
+MIT

package/dist/config/environments.js

@@ -5,6 +5,6 @@ exports.environmentUrls = void 0;
  * A mapping of environments to their respective API base URLs.
  */
 exports.environmentUrls = {
-    producao: 'https://www.nfse.gov.br',
-    homologacao: 'https://www.producaorestrita.nfse.gov.br',
+    producao: 'https://sefin.nfse.gov.br/SefinNacional',
+    homologacao: 'https://sefin.producaorestrita.nfse.gov.br/SefinNacional',
 };

package/dist/core/certificate.js

@@ -50,29 +50,32 @@ function loadA1Certificate(pfxBuffer, password) {
         let privateKey = null;
         let certificate = null;
         const caCertificates = [];
-        // Find the private key and certificate
-        for (const safeContent of p12.safeContents) {
-            for (const key in safeContent.safeBags) {
-                const bags = safeContent.safeBags[key];
-                if (Array.isArray(bags)) {
-                    for (const bag of bags) {
-                        if (bag.type === forge.pki.oids.pkcs8ShroudedKeyBag) {
-                            privateKey = bag.key;
-                        }
-                        else if (bag.type === forge.pki.oids.certBag) {
-                            if (certificate === null) {
-                                certificate = bag.cert;
-                            }
-                            else {
-                                caCertificates.push(bag.cert);
-                            }
-                        }
-                    }
-                }
+        // 1. Get Private Keys (check both encrypted and unencrypted bags)
+        const keyBags = p12.getBags({ bagType: forge.pki.oids.pkcs8ShroudedKeyBag });
+        const unshroudedKeyBags = p12.getBags({ bagType: forge.pki.oids.keyBag });
+        const combinedKeyBags = [
+            ...(keyBags[forge.pki.oids.pkcs8ShroudedKeyBag] || []),
+            ...(unshroudedKeyBags[forge.pki.oids.keyBag] || [])
+        ];
+        if (combinedKeyBags.length > 0) {
+            privateKey = combinedKeyBags[0].key;
+        }
+        // 2. Get Certificates
+        const certBags = p12.getBags({ bagType: forge.pki.oids.certBag });
+        const certs = certBags[forge.pki.oids.certBag] || [];
+        for (const bag of certs) {
+            if (certificate === null) {
+                certificate = bag.cert;
+            }
+            else {
+                caCertificates.push(bag.cert);
             }
         }
-        if (!privateKey || !certificate) {
-            throw new Error('Could not find private key or certificate in PFX/P12 file.');
+        if (!privateKey) {
+            throw new Error('Could not find private key in PFX/P12 file.');
+        }
+        if (!certificate) {
+            throw new Error('Could not find certificate in PFX/P12 file.');
         }
         return { privateKey, certificate, caCertificates };
     }
@@ -84,6 +87,10 @@ function loadA1Certificate(pfxBuffer, password) {
             if (error.message.includes('Unable to parse PKCS#12')) {
                 throw new Error('Unable to parse the certificate. The file may be corrupt or in an unsupported format.');
             }
+            // Re-throw our specific errors
+            if (error.message.includes('Could not find')) {
+                throw error;
+            }
         }
         throw new Error(`Failed to load A1 certificate: ${error}`);
     }

package/dist/core/client.d.ts

@@ -17,11 +17,26 @@ export declare class NfseClient {
     private readonly config;
     constructor(config: NfseClientConfig);
     /**
-     * Sends a POST request to the specified path with the given XML payload.
+     * Sends a POST request to the specified path with the given payload.
      *
      * @param path The API endpoint path.
-     * @param xmlPayload The XML string to send.
+     * @param data The data to send (object or string).
      * @returns A promise that resolves with the response data.
      */
-    post(path: string, xmlPayload: string): Promise<any>;
+    post(path: string, data: any): Promise<any>;
+    /**
+     * Sends a GET request to the specified path.
+     *
+     * @param path The API endpoint path.
+     * @returns A promise that resolves with the response data.
+     */
+    get(path: string): Promise<any>;
+    /**
+     * Sends a HEAD request to the specified path.
+     *
+     * @param path The API endpoint path.
+     * @param params Optional query parameters.
+     * @returns A promise that resolves with the response headers.
+     */
+    head(path: string, params?: any): Promise<any>;
 }

package/dist/core/client.js

@@ -66,20 +66,21 @@ class NfseClient {
             httpsAgent,
             timeout,
             headers: {
-                'Content-Type': 'application/xml;charset=utf-8',
+                'Content-Type': 'application/json;charset=utf-8',
+                'Accept': 'application/json',
             },
         });
     }
     /**
-     * Sends a POST request to the specified path with the given XML payload.
+     * Sends a POST request to the specified path with the given payload.
      *
      * @param path The API endpoint path.
-     * @param xmlPayload The XML string to send.
+     * @param data The data to send (object or string).
      * @returns A promise that resolves with the response data.
      */
-    async post(path, xmlPayload) {
+    async post(path, data) {
         try {
-            const response = await this.client.post(path, xmlPayload);
+            const response = await this.client.post(path, data);
             return response.data;
         }
         catch (error) {
@@ -87,7 +88,48 @@ class NfseClient {
             if (axios_1.default.isAxiosError(error)) {
                 const { response } = error;
                 const errorMessage = (response === null || response === void 0 ? void 0 : response.data) || error.message;
-                throw new Error(`API request failed with status ${response === null || response === void 0 ? void 0 : response.status}: ${errorMessage}`);
+                throw new Error(`API request failed with status ${response === null || response === void 0 ? void 0 : response.status}: ${JSON.stringify(errorMessage)}`);
+            }
+            throw new Error(`An unexpected error occurred: ${error}`);
+        }
+    }
+    /**
+     * Sends a GET request to the specified path.
+     *
+     * @param path The API endpoint path.
+     * @returns A promise that resolves with the response data.
+     */
+    async get(path) {
+        try {
+            const response = await this.client.get(path);
+            return response.data;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error)) {
+                const { response } = error;
+                const errorMessage = (response === null || response === void 0 ? void 0 : response.data) || error.message;
+                throw new Error(`API request failed with status ${response === null || response === void 0 ? void 0 : response.status}: ${JSON.stringify(errorMessage)}`);
+            }
+            throw new Error(`An unexpected error occurred: ${error}`);
+        }
+    }
+    /**
+     * Sends a HEAD request to the specified path.
+     *
+     * @param path The API endpoint path.
+     * @param params Optional query parameters.
+     * @returns A promise that resolves with the response headers.
+     */
+    async head(path, params) {
+        try {
+            const response = await this.client.head(path, { params });
+            return response.headers;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error)) {
+                const { response } = error;
+                // For HEAD requests, we mostly care about the status code
+                throw new Error(`API request failed with status ${response === null || response === void 0 ? void 0 : response.status}`);
             }
             throw new Error(`An unexpected error occurred: ${error}`);
         }

package/dist/core/signer.d.ts

@@ -1,6 +1,6 @@
 import { CertificateData } from './certificate';
 /**
- * Signs an XML string with the provided certificate data.
+ * Signs an XML string with the provided certificate data using xml-crypto.
  *
  * @param xml The XML string to sign.
  * @param certificateData The certificate data to use for signing.

package/dist/core/signer.js

@@ -35,8 +35,9 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.signXml = signXml;
 const forge = __importStar(require("node-forge"));
+const xml_crypto_1 = require("xml-crypto");
 /**
- * Signs an XML string with the provided certificate data.
+ * Signs an XML string with the provided certificate data using xml-crypto.
  *
  * @param xml The XML string to sign.
  * @param certificateData The certificate data to use for signing.
@@ -45,42 +46,55 @@ const forge = __importStar(require("node-forge"));
  */
 function signXml(xml, certificateData, tagToSign) {
     const { privateKey, certificate } = certificateData;
-    // 1. Create the digest of the XML
-    const md = forge.md.sha256.create();
-    md.update(xml, 'utf8');
-    const digest = md.digest().bytes();
-    const digestB64 = forge.util.encode64(digest);
-    // 2. Define the <SignedInfo> block. This is what actually gets signed.
-    const signedInfo = `<SignedInfo>
-                <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
-                <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" />
-                <Reference URI="">
-                    <Transforms>
-                        <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
-                    </Transforms>
-                    <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" />
-                    <DigestValue>${digestB64}</DigestValue>
-                </Reference>
-            </SignedInfo>`;
-    // 3. Create the signature of the <SignedInfo> block
-    const signatureMd = forge.md.sha256.create();
-    signatureMd.update(signedInfo, 'utf8');
-    const signature = privateKey.sign(signatureMd);
-    const signatureB64 = forge.util.encode64(signature);
-    // 4. Extract the certificate in Base64 format
+    // Convert keys to PEM format expected by xml-crypto
+    const privateKeyPem = forge.pki.privateKeyToPem(privateKey);
     const certPem = forge.pki.certificateToPem(certificate);
-    const certB64 = forge.util.encode64(certPem.replace(/-----BEGIN CERTIFICATE-----|-----END CERTIFICATE-----|\r|\n/g, ''));
-    // 5. Assemble the final <Signature> block
-    const signatureBlock = `<Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
-            ${signedInfo}
-            <SignatureValue>${signatureB64}</SignatureValue>
-            <KeyInfo>
-                <X509Data>
-                    <X509Certificate>${certB64}</X509Certificate>
-                </X509Data>
-            </KeyInfo>
-        </Signature>`;
-    // 6. Inject the signature block into the original XML
-    const signedXml = xml.replace(`</${tagToSign}>`, `${signatureBlock}</${tagToSign}>`);
+    // Helper to get pure base64 certificate (no headers)
+    const getCertB64 = (pem) => {
+        return pem.replace(/-----BEGIN CERTIFICATE-----|-----END CERTIFICATE-----|\r|\n/g, '');
+    };
+    const sig = new xml_crypto_1.SignedXml({
+        privateKey: privateKeyPem,
+        signatureAlgorithm: "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
+        canonicalizationAlgorithm: "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
+    });
+    // Extract ID reference
+    // We assume the tagToSign matches the pattern <tagToSign ... Id="XYZ" ...>
+    const tagMatch = xml.match(new RegExp(`<${tagToSign}[^>]*Id="([^"]+)"[^>]*>`, 'i'));
+    const tagId = tagMatch ? tagMatch[1] : '';
+    const referenceUri = tagId ? `#${tagId}` : '';
+    if (!tagId) {
+        throw new Error(`Could not find Id attribute in tag '${tagToSign}' to sign.`);
+    }
+    // Add Reference
+    sig.addReference({
+        xpath: `//*[local-name(.)='${tagToSign}']`,
+        transforms: [
+            "http://www.w3.org/2000/09/xmldsig#enveloped-signature",
+            "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
+        ],
+        digestAlgorithm: "http://www.w3.org/2000/09/xmldsig#sha1",
+        uri: referenceUri
+    });
+    // Custom KeyInfo provider
+    // Implementing exactly as nfse-brazil-national does to ensure compatibility
+    // They overwrite the getKeyInfoContent method on the instance.
+    sig.getKeyInfoContent = function ({ prefix }) {
+        const certB64 = getCertB64(certPem);
+        const p = prefix ? `${prefix}:` : "";
+        return `<${p}X509Data><${p}X509Certificate>${certB64}</${p}X509Certificate></${p}X509Data>`;
+    };
+    // Compute Signature
+    // xml-crypto expects the whole XML. By default it appends Signature to root.
+    // For DPS, root is <DPS>. <infDPS> is child.
+    // So Signature will become a sibling of <infDPS> (child of <DPS>).
+    // This matches the requirement "Signature invalid child of infDPS" -> means it must NOT be inside infDPS.
+    sig.computeSignature(xml, {
+        prefix: "", // No prefix for Signature namespace by default
+        attrs: {
+            xmlns: "http://www.w3.org/2000/09/xmldsig#"
+        }
+    });
+    let signedXml = sig.getSignedXml();
     return signedXml;
 }

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 export { NfseClient } from './core/client';
 export type { NfseClientConfig } from './core/client';
 export { loadA1Certificate } from './core/certificate';
+export { buildDpsXml, generateDpsId } from './utils/xml';
+export { signXml } from './core/signer';
 export type { CertificateData } from './core/certificate';
 export { enviaDps } from './services/dps';
-export { consultarNfseChave, consultarDpsChave } from './services/consultas';
+export { consultarNfseChave, consultarDpsId, verificarNfsePorDpsId } from './services/consultas';
 export { environmentUrls } from './config/environments';
 export type { NfseEnvironment } from './config/environments';
-export type { DPS, Endereco, Contato, NFSeResponse } from './models/dps';
+export type { DPS, Endereco, Contato, NFSeResponse, DPSResponse } from './models/dps';
 export type { NFSe, DPSConsultaResponse } from './models/responses';

package/dist/index.js

@@ -1,14 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.environmentUrls = exports.consultarDpsChave = exports.consultarNfseChave = exports.enviaDps = exports.loadA1Certificate = exports.NfseClient = void 0;
+exports.environmentUrls = exports.verificarNfsePorDpsId = exports.consultarDpsId = exports.consultarNfseChave = exports.enviaDps = exports.signXml = exports.generateDpsId = exports.buildDpsXml = exports.loadA1Certificate = exports.NfseClient = void 0;
 var client_1 = require("./core/client");
 Object.defineProperty(exports, "NfseClient", { enumerable: true, get: function () { return client_1.NfseClient; } });
 var certificate_1 = require("./core/certificate");
 Object.defineProperty(exports, "loadA1Certificate", { enumerable: true, get: function () { return certificate_1.loadA1Certificate; } });
+var xml_1 = require("./utils/xml");
+Object.defineProperty(exports, "buildDpsXml", { enumerable: true, get: function () { return xml_1.buildDpsXml; } });
+Object.defineProperty(exports, "generateDpsId", { enumerable: true, get: function () { return xml_1.generateDpsId; } });
+var signer_1 = require("./core/signer");
+Object.defineProperty(exports, "signXml", { enumerable: true, get: function () { return signer_1.signXml; } });
 var dps_1 = require("./services/dps");
 Object.defineProperty(exports, "enviaDps", { enumerable: true, get: function () { return dps_1.enviaDps; } });
 var consultas_1 = require("./services/consultas");
 Object.defineProperty(exports, "consultarNfseChave", { enumerable: true, get: function () { return consultas_1.consultarNfseChave; } });
-Object.defineProperty(exports, "consultarDpsChave", { enumerable: true, get: function () { return consultas_1.consultarDpsChave; } });
+Object.defineProperty(exports, "consultarDpsId", { enumerable: true, get: function () { return consultas_1.consultarDpsId; } });
+Object.defineProperty(exports, "verificarNfsePorDpsId", { enumerable: true, get: function () { return consultas_1.verificarNfsePorDpsId; } });
 var environments_1 = require("./config/environments");
 Object.defineProperty(exports, "environmentUrls", { enumerable: true, get: function () { return environments_1.environmentUrls; } });

package/dist/models/dps.d.ts

@@ -15,69 +15,102 @@ export interface Contato {
     email?: string;
 }
 export interface DPS {
-    identificacao: {
-        numero: string;
-        serie: string;
-        dataEmissao: Date;
-        competencia: Date;
-        tipoTributacao: 'T' | 'F' | 'A' | 'B' | 'M' | 'N' | 'X' | 'V' | 'P' | 'S';
-    };
+    id?: string;
+    ambiente: 1 | 2;
+    versaoAplicacao: string;
+    dataEmissao: string | Date;
+    competencia: string | Date;
+    serie: string;
+    numero: string;
+    tipoEmitente: number;
+    municipioEmissao: string;
     prestador: {
         cnpj: string;
+        optanteSimplesNacional: 1 | 2 | 3;
+        regimeEspecialTributacao?: number;
+        regimeApuracaoTributacaoSN?: number;
         inscricaoMunicipal?: string;
-        regimeEspecialTributacao?: string;
+        telefone?: string;
+        email?: string;
     };
     tomador: {
-        identificacao: {
-            cnpjCpf: string;
-            inscricaoMunicipal?: string;
+        cpf?: string;
+        cnpj?: string;
+        inscricaoMunicipal?: string;
+        nome: string;
+        endereco?: {
+            logradouro: string;
+            numero: string;
+            complemento?: string;
+            bairro: string;
+            codigoMunicipio: string;
+            uf: string;
+            cep: string;
         };
-        razaoSocial: string;
-        endereco: Endereco;
-        contato?: Contato;
+        telefone?: string;
+        email?: string;
     };
     servico: {
-        codigoNbs: string;
-        discriminacao: string;
-        valorServicos: number;
+        municipioPrestacao: string;
+        codigoTributacaoNacional: string;
+        codigoTributacaoMunicipal?: string;
+        descricao: string;
+        codigoNbs?: string;
+        codigoInterno?: string;
+        paisPrestacao?: string;
+    };
+    valores: {
+        valorServicos: number | string;
+        tributacaoIssqn: 1 | 2 | 3;
+        tipoRetencaoIssqn: 1 | 2 | 3;
+        percentualTotalTributosSN?: number;
+        valorIss?: number;
+        aliquotaIssqn?: number;
         valorDeducoes?: number;
         valorPis?: number;
         valorCofins?: number;
         valorInss?: number;
         valorIr?: number;
         valorCsll?: number;
-        issRetido: boolean;
-        valorIss?: number;
-        aliquota?: number;
-        descontoIncondicionado?: number;
-        descontoCondicionado?: number;
-        itemListaServico: string;
-        codigoCnae?: string;
-        codigoTributacaoMunicipio?: string;
-        municipioPrestacao: string;
-        paisPrestacao?: string;
+        issRetido?: boolean;
+        descontos?: {
+            incondicionado?: number;
+            condicionado?: number;
+        };
+        deducaoReducao?: {
+            percentual?: number;
+            valor?: number;
+        };
+        tributosDetalhado?: {
+            federal: number;
+            estadual: number;
+            municipal: number;
+        };
     };
+    infosComp?: string;
     construcaoCivil?: {
         codigoObra?: string;
         art?: string;
-        inscricaoImobiliaria?: string;
-        endereco?: Endereco;
-    };
-    atividadesEvento?: {
-        codigoEvento: string;
-        nomeEvento: string;
-        dataInicio: Date;
-        dataFim: Date;
-        endereco: Endereco;
-    };
-    ibsCbs?: {
-        situacaoTributaria: string;
-        classificacaoTributaria: string;
-        valorAliquota?: number;
-        valorIBS?: number;
-        valorCBS?: number;
     };
 }
+export interface MensagemProcessamento {
+    codigo?: string;
+    descricao?: string;
+    correcao?: string;
+}
 export interface NFSeResponse {
+    tipoAmbiente: number;
+    versaoAplicativo: string;
+    dataHoraProcessamento: string;
+    idDps: string;
+    chaveAcesso: string;
+    nfseXmlGZipB64: string;
+    alertas?: MensagemProcessamento[];
+}
+export interface DPSResponse {
+    tipoAmbiente: number;
+    versaoAplicativo: string;
+    dataHoraProcessamento: string;
+    idDps: string;
     chaveAcesso: string;
 }

package/dist/services/consultas.d.ts

@@ -1,5 +1,5 @@
 import { NfseClient } from '../core/client';
-import { NFSe, DPSConsultaResponse } from '../models/responses';
+import { NFSeResponse, DPSResponse } from '../models/dps';
 /**
  * Consults an NFSe by its access key.
  *
@@ -7,12 +7,20 @@ import { NFSe, DPSConsultaResponse } from '../models/responses';
  * @param client An instance of the configured NfseClient.
  * @returns A promise that resolves with the NFSe data.
  */
-export declare function consultarNfseChave(chaveAcesso: string, client: NfseClient): Promise<NFSe>;
+export declare function consultarNfseChave(chaveAcesso: string, client: NfseClient): Promise<NFSeResponse>;
 /**
- * Consults a DPS by its access key.
+ * Consults a DPS by its Id.
  *
- * @param chaveAcesso The access key of the DPS.
+ * @param id The identifier of the DPS.
  * @param client An instance of the configured NfseClient.
- * @returns A promise that resolves with the DPS consultation data.
+ * @returns A promise that resolves with the DPS response data.
  */
-export declare function consultarDpsChave(chaveAcesso: string, client: NfseClient): Promise<DPSConsultaResponse>;
+export declare function consultarDpsId(id: string, client: NfseClient): Promise<DPSResponse>;
+/**
+ * Verifies if an NFSe was emitted from a DPS Id.
+ *
+ * @param id The identifier of the DPS.
+ * @param client An instance of the configured NfseClient.
+ * @returns A promise that resolves to true if the NFSe exists, false otherwise.
+ */
+export declare function verificarNfsePorDpsId(id: string, client: NfseClient): Promise<boolean>;

package/dist/services/consultas.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.consultarNfseChave = consultarNfseChave;
-exports.consultarDpsChave = consultarDpsChave;
-const fast_xml_parser_1 = require("fast-xml-parser");
+exports.consultarDpsId = consultarDpsId;
+exports.verificarNfsePorDpsId = verificarNfsePorDpsId;
 /**
  * Consults an NFSe by its access key.
  *
@@ -11,40 +11,40 @@ const fast_xml_parser_1 = require("fast-xml-parser");
  * @returns A promise that resolves with the NFSe data.
  */
 async function consultarNfseChave(chaveAcesso, client) {
-    var _a;
-    const xmlPayload = `<ConsultarNfse>
-                        <chaveAcesso>${chaveAcesso}</chaveAcesso>
-                      </ConsultarNfse>`;
-    // Placeholder for the actual API endpoint
-    const responseXml = await client.post('/ws/consultarNfse', xmlPayload);
-    const parser = new fast_xml_parser_1.XMLParser();
-    const parsedResponse = parser.parse(responseXml);
-    // The exact path to the data needs to be verified against the API's response
-    const nfseData = (_a = parsedResponse === null || parsedResponse === void 0 ? void 0 : parsedResponse.retornoConsultaNfse) === null || _a === void 0 ? void 0 : _a.nfse;
-    if (!nfseData) {
-        throw new Error('Could not find NFSe data in the API response.');
-    }
-    return nfseData;
+    // Use GET /nfse/{chaveAcesso} as per the documentation
+    const response = await client.get(`/nfse/${chaveAcesso}`);
+    return response;
 }
 /**
- * Consults a DPS by its access key.
+ * Consults a DPS by its Id.
  *
- * @param chaveAcesso The access key of the DPS.
+ * @param id The identifier of the DPS.
  * @param client An instance of the configured NfseClient.
- * @returns A promise that resolves with the DPS consultation data.
+ * @returns A promise that resolves with the DPS response data.
  */
-async function consultarDpsChave(chaveAcesso, client) {
-    const xmlPayload = `<ConsultarDps>
-                        <chaveAcesso>${chaveAcesso}</chaveAcesso>
-                      </ConsultarDps>`;
-    // Placeholder for the actual API endpoint
-    const responseXml = await client.post('/ws/consultarDps', xmlPayload);
-    const parser = new fast_xml_parser_1.XMLParser();
-    const parsedResponse = parser.parse(responseXml);
-    // The exact path to the data needs to be verified against the API's response
-    const dpsData = parsedResponse === null || parsedResponse === void 0 ? void 0 : parsedResponse.retornoConsultaDps;
-    if (!dpsData) {
-        throw new Error('Could not find DPS data in the API response.');
+async function consultarDpsId(id, client) {
+    const response = await client.get(`/dps/${id}`);
+    return response;
+}
+/**
+ * Verifies if an NFSe was emitted from a DPS Id.
+ *
+ * @param id The identifier of the DPS.
+ * @param client An instance of the configured NfseClient.
+ * @returns A promise that resolves to true if the NFSe exists, false otherwise.
+ */
+async function verificarNfsePorDpsId(id, client) {
+    try {
+        // Verified by HEAD /nfse?id={id} according to some interpretations, 
+        // but the doc says "HEAD /nfse" path parameters or query? 
+        // doc: head /nfse, path parameters id required string
+        await client.head(`/nfse/${id}`);
+        return true;
+    }
+    catch (error) {
+        if (error.message.includes('status 404')) {
+            return false;
+        }
+        throw error;
     }
-    return dpsData;
 }

package/dist/services/dps.js

@@ -4,7 +4,6 @@ exports.enviaDps = enviaDps;
 const xml_1 = require("../utils/xml");
 const signer_1 = require("../core/signer");
 const compression_1 = require("../utils/compression");
-const fast_xml_parser_1 = require("fast-xml-parser");
 /**
  * Orchestrates the process of sending a DPS to the NFSe Nacional API.
  *
@@ -15,33 +14,18 @@ const fast_xml_parser_1 = require("fast-xml-parser");
  * @throws Will throw an error if any step of the process fails.
  */
 async function enviaDps(dps, client, certificate) {
-    var _a;
     try {
         // 1. Build the DPS XML from the object
         const dpsXml = (0, xml_1.buildDpsXml)(dps);
         // 2. Sign the DPS XML document
-        // The signature must be applied to the <DPS> tag
-        const signedDpsXml = (0, signer_1.signXml)(dpsXml, certificate, 'DPS');
+        // The signature must be applied to the <infDPS> tag
+        const signedDpsXml = (0, signer_1.signXml)(dpsXml, certificate, 'infDPS');
         // 3. Compress and Base64 encode the signed XML
-        const compressedPayload = await (0, compression_1.compressAndEncodeXml)(signedDpsXml);
-        // 4. Wrap the payload in the required structure for the API
-        const finalXml = `<EnviarDeclaracaoServico><dps_compactado>${compressedPayload}</dps_compactado></EnviarDeclaracaoServico>`;
-        // 5. Send the request using the mTLS client
-        // The specific endpoint path needs to be confirmed from the official documentation,
-        // '/ws/enviarDps' is a placeholder based on common patterns.
-        const responseXml = await client.post('/ws/enviarDps', finalXml);
-        // 6. Parse the XML response
-        const parser = new fast_xml_parser_1.XMLParser();
-        const parsedResponse = parser.parse(responseXml);
-        // The exact path to the response data needs to be verified against the API's actual response structure.
-        const chaveAcesso = (_a = parsedResponse === null || parsedResponse === void 0 ? void 0 : parsedResponse.retornoEnvioDps) === null || _a === void 0 ? void 0 : _a.chaveAcesso;
-        if (!chaveAcesso) {
-            throw new Error('Could not find chaveAcesso in the API response.');
-        }
-        return {
-            chaveAcesso,
-            ...parsedResponse.retornoEnvioDps,
-        };
+        const dpsXmlGZipB64 = await (0, compression_1.compressAndEncodeXml)(signedDpsXml);
+        // 4. Send the request using the mTLS client
+        // Updated to use the synchronous JSON API endpoint
+        const response = await client.post('/nfse', { dpsXmlGZipB64 });
+        return response;
     }
     catch (error) {
         console.error('Failed to send DPS:', error);

package/dist/utils/xml.d.ts

@@ -1,10 +1,11 @@
 import { DPS } from '../models/dps';
+/**
+ * Generates the DPS ID according to the pattern:
+ * "DPS" + Cód.Mun (7) + Tipo de Inscrição Federal (1) + Inscrição Federal (14) + Série DPS (5) + Núm. DPS (15)
+ */
+export declare function generateDpsId(dps: DPS): string;
 /**
  * Converts a DPS object to its XML string representation.
- * Note: This is a simplified builder for the MVP. A more robust XML library
- * might be used in the future for better maintainability.
- *
- * @param dps The DPS object.
- * @returns The XML string representation of the DPS.
+ * Matches the structure of the nfse-brazil-national template.
  */
 export declare function buildDpsXml(dps: DPS): string;

package/dist/utils/xml.js

@@ -1,66 +1,156 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDpsId = generateDpsId;
 exports.buildDpsXml = buildDpsXml;
 const date_fns_1 = require("date-fns");
+/**
+ * Generates the DPS ID according to the pattern:
+ * "DPS" + Cód.Mun (7) + Tipo de Inscrição Federal (1) + Inscrição Federal (14) + Série DPS (5) + Núm. DPS (15)
+ */
+function generateDpsId(dps) {
+    const codMun = dps.municipioEmissao.padStart(7, '0');
+    const tpInsc = '2'; // 2=CNPJ (Fixed for now as we only support CNPJ prestador)
+    const cnpj = dps.prestador.cnpj.replace(/\D/g, '').padStart(14, '0');
+    const serie = dps.serie.padStart(5, '0');
+    const numero = dps.numero.padStart(15, '0');
+    return `DPS${codMun}${tpInsc}${cnpj}${serie}${numero}`;
+}
 /**
  * Converts a DPS object to its XML string representation.
- * Note: This is a simplified builder for the MVP. A more robust XML library
- * might be used in the future for better maintainability.
- *
- * @param dps The DPS object.
- * @returns The XML string representation of the DPS.
+ * Matches the structure of the nfse-brazil-national template.
  */
 function buildDpsXml(dps) {
-    // Helper to format dates to 'yyyy-MM-dd'
-    const formatDate = (date) => (0, date_fns_1.format)(date, 'yyyy-MM-dd');
+    var _a;
+    // Helper to format dates to 'yyyy-MM-dd' or ISO date-time
+    const formatDate = (date) => {
+        if (date instanceof Date)
+            return (0, date_fns_1.format)(date, 'yyyy-MM-dd');
+        return date.split('T')[0]; // simple handling for ISO string
+    };
+    const formatDateTime = (date) => {
+        if (typeof date === 'string')
+            return date;
+        // Format: YYYY-MM-DDThh:mm:ss-03:00
+        const pad = (n) => n.toString().padStart(2, '0');
+        const yyyy = date.getFullYear();
+        const mm = pad(date.getMonth() + 1);
+        const dd = pad(date.getDate());
+        const hh = pad(date.getHours());
+        const min = pad(date.getMinutes());
+        const ss = pad(date.getSeconds());
+        // Offset handling could be improved, but for "homologacao" usually -03:00 is expected/safe
+        return `${yyyy}-${mm}-${dd}T${hh}:${min}:${ss}-03:00`;
+    };
     // Helper to safely add optional elements
     const addOptional = (tag, value) => (value ? `<${tag}>${value}</${tag}>` : '');
-    const addOptionalFloat = (tag, value) => (value ? `<${tag}>${value.toFixed(2)}</${tag}>` : '');
-    return `<?xml version="1.0" encoding="UTF-8"?>
-<DPS xmlns="http://www.nfse.gov.br/nfse">
-  <identificacao>
-    <numero>${dps.identificacao.numero}</numero>
-    <serie>${dps.identificacao.serie}</serie>
-    <dataEmissao>${formatDate(dps.identificacao.dataEmissao)}</dataEmissao>
-    <competencia>${formatDate(dps.identificacao.competencia)}</competencia>
-    <tipoTributacao>${dps.identificacao.tipoTributacao}</tipoTributacao>
-  </identificacao>
-  <prestador>
-    <cnpj>${dps.prestador.cnpj}</cnpj>
-    ${addOptional('inscricaoMunicipal', dps.prestador.inscricaoMunicipal)}
-    ${addOptional('regimeEspecialTributacao', dps.prestador.regimeEspecialTributacao)}
-  </prestador>
-  <tomador>
-    <identificacao>
-      <cnpjCpf>${dps.tomador.identificacao.cnpjCpf}</cnpjCpf>
-      ${addOptional('inscricaoMunicipal', dps.tomador.identificacao.inscricaoMunicipal)}
-    </identificacao>
-    <razaoSocial>${dps.tomador.razaoSocial}</razaoSocial>
-    <endereco>
-        <logradouro>${dps.tomador.endereco.logradouro}</logradouro>
-        <numero>${dps.tomador.endereco.numero}</numero>
-        ${addOptional('complemento', dps.tomador.endereco.complemento)}
-        <bairro>${dps.tomador.endereco.bairro}</bairro>
-        <codigoMunicipio>${dps.tomador.endereco.codigoMunicipio}</codigoMunicipio>
-        <uf>${dps.tomador.endereco.uf}</uf>
-        <cep>${dps.tomador.endereco.cep}</cep>
-    </endereco>
-  </tomador>
-  <servico>
-    <codigoNbs>${dps.servico.codigoNbs}</codigoNbs>
-    <discriminacao>${dps.servico.discriminacao}</discriminacao>
-    <valorServicos>${dps.servico.valorServicos.toFixed(2)}</valorServicos>
-    ${addOptionalFloat('valorDeducoes', dps.servico.valorDeducoes)}
-    ${addOptionalFloat('valorPis', dps.servico.valorPis)}
-    ${addOptionalFloat('valorCofins', dps.servico.valorCofins)}
-    ${addOptionalFloat('valorInss', dps.servico.valorInss)}
-    ${addOptionalFloat('valorIr', dps.servico.valorIr)}
-    ${addOptionalFloat('valorCsll', dps.servico.valorCsll)}
-    <issRetido>${dps.servico.issRetido}</issRetido>
-    ${addOptionalFloat('valorIss', dps.servico.valorIss)}
-    ${addOptionalFloat('aliquota', dps.servico.aliquota)}
-    <itemListaServico>${dps.servico.itemListaServico}</itemListaServico>
-    <municipioPrestacao>${dps.servico.municipioPrestacao}</municipioPrestacao>
-  </servico>
+    const addOptionalFloat = (tag, value) => (value !== undefined && value !== null ? `<${tag}>${value}</${tag}>` : '');
+    const dpsId = dps.id || generateDpsId(dps);
+    // Determine tomador identification tag (CNPJ or CPF)
+    const tomadorIdTag = dps.tomador.cnpj ?
+        `<CNPJ>${dps.tomador.cnpj.replace(/\D/g, '')}</CNPJ>` :
+        (dps.tomador.cpf ? `<CPF>${dps.tomador.cpf.replace(/\D/g, '')}</CPF>` : '');
+    // Determine discounts/deductions blocks
+    let valoresHtml = `<vServPrest><vServ>${dps.valores.valorServicos}</vServ></vServPrest>`;
+    if (dps.valores.descontos) {
+        valoresHtml += `<vDescCondIncond>`;
+        if (dps.valores.descontos.incondicionado)
+            valoresHtml += `<vDescIncond>${dps.valores.descontos.incondicionado}</vDescIncond>`;
+        if (dps.valores.descontos.condicionado)
+            valoresHtml += `<vDescCond>${dps.valores.descontos.condicionado}</vDescCond>`;
+        valoresHtml += `</vDescCondIncond>`;
+    }
+    if (dps.valores.deducaoReducao) {
+        valoresHtml += `<vDedRed>`;
+        if (dps.valores.deducaoReducao.percentual)
+            valoresHtml += `<pDR>${dps.valores.deducaoReducao.percentual}</pDR>`;
+        if (dps.valores.deducaoReducao.valor)
+            valoresHtml += `<vDR>${dps.valores.deducaoReducao.valor}</vDR>`;
+        valoresHtml += `</vDedRed>`;
+    }
+    let tribMunHtml = `
+          <tribISSQN>${dps.valores.tributacaoIssqn}</tribISSQN>
+          <tpRetISSQN>${dps.valores.tipoRetencaoIssqn}</tpRetISSQN>`;
+    if (dps.valores.aliquotaIssqn)
+        tribMunHtml += `<pAliq>${dps.valores.aliquotaIssqn}</pAliq>`;
+    if (dps.valores.valorIss)
+        tribMunHtml += `<vISSQN>${dps.valores.valorIss}</vISSQN>`;
+    let totTribHtml = '';
+    if (dps.valores.tributosDetalhado) {
+        totTribHtml = `<pTotTrib>
+            <pTotTribFed>${dps.valores.tributosDetalhado.federal}</pTotTribFed>
+            <pTotTribEst>${dps.valores.tributosDetalhado.estadual}</pTotTribEst>
+            <pTotTribMun>${dps.valores.tributosDetalhado.municipal}</pTotTribMun>
+          </pTotTrib>`;
+    }
+    else if (dps.valores.percentualTotalTributosSN !== undefined) {
+        totTribHtml = `<pTotTribSN>${dps.valores.percentualTotalTributosSN}</pTotTribSN>`;
+    }
+    else {
+        totTribHtml = `<indTotTrib>0</indTotTrib>`;
+    }
+    const xml = `<?xml version="1.0" encoding="UTF-8"?>
+<DPS xmlns="http://www.sped.fazenda.gov.br/nfse" versao="1.00">
+  <infDPS Id="${dpsId}">
+    <tpAmb>${dps.ambiente}</tpAmb>
+    <dhEmi>${formatDateTime(dps.dataEmissao)}</dhEmi>
+    <verAplic>${dps.versaoAplicacao}</verAplic>
+    <serie>${dps.serie}</serie>
+    <nDPS>${dps.numero}</nDPS>
+    <dCompet>${formatDate(dps.competencia)}</dCompet>
+    <tpEmit>${dps.tipoEmitente}</tpEmit>
+    <cLocEmi>${dps.municipioEmissao}</cLocEmi>
+    <prest>
+      <CNPJ>${dps.prestador.cnpj.replace(/\D/g, '')}</CNPJ>
+      ${addOptional('fone', dps.prestador.telefone)}
+      <regTrib>
+        <opSimpNac>${dps.prestador.optanteSimplesNacional}</opSimpNac>
+        ${addOptional('regApTribSN', dps.prestador.regimeApuracaoTributacaoSN)}
+        <regEspTrib>${(_a = dps.prestador.regimeEspecialTributacao) !== null && _a !== void 0 ? _a : 0}</regEspTrib>
+      </regTrib>
+    </prest>
+    <toma>
+      ${tomadorIdTag}
+      ${addOptional('IM', dps.tomador.inscricaoMunicipal)}
+      <xNome>${dps.tomador.nome}</xNome>
+      ${dps.tomador.endereco ? `<end>
+        ${dps.tomador.endereco.cep ? `<endNac>
+          <cMun>${dps.tomador.endereco.codigoMunicipio}</cMun>
+          <CEP>${dps.tomador.endereco.cep.replace(/\D/g, '')}</CEP>
+        </endNac>` : ''}
+        <xLgr>${dps.tomador.endereco.logradouro}</xLgr>
+        <nro>${dps.tomador.endereco.numero}</nro>
+        ${addOptional('xCpl', dps.tomador.endereco.complemento)}
+        <xBairro>${dps.tomador.endereco.bairro}</xBairro>
+      </end>` : ''}
+      ${addOptional('fone', dps.tomador.telefone)}
+      ${addOptional('email', dps.tomador.email)}
+    </toma>
+    <serv>
+      <locPrest>
+        <cLocPrestacao>${dps.servico.municipioPrestacao}</cLocPrestacao>
+        ${addOptional('cPaisPrestacao', dps.servico.paisPrestacao)}
+      </locPrest>
+      <cServ>
+        <cTribNac>${dps.servico.codigoTributacaoNacional}</cTribNac>
+        ${addOptional('cTribMun', dps.servico.codigoTributacaoMunicipal)}
+        <xDescServ>${dps.servico.descricao}</xDescServ>
+        ${addOptional('cNBS', dps.servico.codigoNbs ? dps.servico.codigoNbs.replace(/\D/g, '') : undefined)}
+        ${addOptional('cIntContrib', dps.servico.codigoInterno)}
+      </cServ>
+    </serv>
+    <valores>
+      ${valoresHtml}
+      <trib>
+        <tribMun>
+          ${tribMunHtml}
+        </tribMun>
+        <totTrib>
+          ${totTribHtml}
+        </totTrib>
+      </trib>
+    </valores>
+  </infDPS>
 </DPS>`;
+    // Minify XML to remove spaces between tags
+    return xml.replace(/>\s+</g, '><').trim();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pereirajair/nfse-gov-br-node",
-  "version": "0.0.3",
+  "version": "0.3.0",
   "description": "Library for interacting with the Brazilian NFSe Nacional API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,20 +9,25 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "test": "jest"
+    "test": "jest",
+    "ship:minor": "git add . && git commit -m \"feat: atualização de rotina\" && npm version minor && git push --follow-tags"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.10",
     "@types/node-forge": "^1.3.14",
+    "@types/xml-crypto": "^1.4.6",
+    "@types/xmldom": "^0.1.34",
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   },
   "dependencies": {
+    "@xmldom/xmldom": "^0.8.11",
     "axios": "^1.13.4",
     "date-fns": "^2.30.0",
     "fast-xml-parser": "^4.5.3",
     "node-forge": "^1.3.3",
+    "xml-crypto": "^6.1.2",
     "zod": "^3.25.76"
   }
 }