@pereirajair/nfse-gov-br-node 0.0.3

package/dist/config/environments.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines the available environments for the NFSe API.
+ */
+export type NfseEnvironment = 'producao' | 'homologacao';
+/**
+ * A mapping of environments to their respective API base URLs.
+ */
+export declare const environmentUrls: Record<NfseEnvironment, string>;

package/dist/config/environments.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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',
+};

package/dist/core/certificate.d.ts

@@ -0,0 +1,18 @@
+import * as forge from 'node-forge';
+/**
+ * Interface for the extracted certificate data.
+ */
+export interface CertificateData {
+    privateKey: forge.pki.PrivateKey;
+    certificate: forge.pki.Certificate;
+    caCertificates: forge.pki.Certificate[];
+}
+/**
+ * Loads an A1 certificate from a PFX/P12 file.
+ *
+ * @param pfxBuffer The buffer containing the PFX/P12 file content.
+ * @param password The password for the certificate.
+ * @returns An object containing the private key, certificate, and CA certificates.
+ * @throws Will throw an error if the certificate cannot be loaded or parsed.
+ */
+export declare function loadA1Certificate(pfxBuffer: Buffer, password: string): CertificateData;

package/dist/core/certificate.js

@@ -0,0 +1,90 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadA1Certificate = loadA1Certificate;
+const forge = __importStar(require("node-forge"));
+/**
+ * Loads an A1 certificate from a PFX/P12 file.
+ *
+ * @param pfxBuffer The buffer containing the PFX/P12 file content.
+ * @param password The password for the certificate.
+ * @returns An object containing the private key, certificate, and CA certificates.
+ * @throws Will throw an error if the certificate cannot be loaded or parsed.
+ */
+function loadA1Certificate(pfxBuffer, password) {
+    try {
+        const p12Asn1 = forge.asn1.fromDer(pfxBuffer.toString('binary'));
+        const p12 = forge.pkcs12.pkcs12FromAsn1(p12Asn1, false, 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);
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        if (!privateKey || !certificate) {
+            throw new Error('Could not find private key or certificate in PFX/P12 file.');
+        }
+        return { privateKey, certificate, caCertificates };
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            if (error.message.includes('Invalid password')) {
+                throw new Error('The provided password for the certificate is incorrect.');
+            }
+            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.');
+            }
+        }
+        throw new Error(`Failed to load A1 certificate: ${error}`);
+    }
+}

package/dist/core/client.d.ts

@@ -0,0 +1,27 @@
+import { CertificateData } from './certificate';
+import { NfseEnvironment } from '../config/environments';
+/**
+ * Configuration for the NfseClient.
+ */
+export interface NfseClientConfig {
+    environment: NfseEnvironment;
+    certificate: CertificateData;
+    timeout?: number;
+}
+/**
+ * A secure HTTP client for communicating with the NFSe Nacional API.
+ * It handles mTLS authentication using a provided A1 certificate.
+ */
+export declare class NfseClient {
+    private readonly client;
+    private readonly config;
+    constructor(config: NfseClientConfig);
+    /**
+     * Sends a POST request to the specified path with the given XML payload.
+     *
+     * @param path The API endpoint path.
+     * @param xmlPayload The XML string to send.
+     * @returns A promise that resolves with the response data.
+     */
+    post(path: string, xmlPayload: string): Promise<any>;
+}

package/dist/core/client.js

@@ -0,0 +1,96 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NfseClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const https = __importStar(require("https"));
+const forge = __importStar(require("node-forge"));
+const environments_1 = require("../config/environments");
+/**
+ * A secure HTTP client for communicating with the NFSe Nacional API.
+ * It handles mTLS authentication using a provided A1 certificate.
+ */
+class NfseClient {
+    constructor(config) {
+        this.config = config;
+        const { privateKey, certificate, caCertificates } = this.config.certificate;
+        const { environment, timeout = 30000 } = this.config;
+        // node-forge requires a password to create a PFX. Since this is for an in-memory
+        // representation passed directly to the https.Agent, we can use a temporary, random one.
+        const tempPassword = Math.random().toString(36).substring(2);
+        const p12Asn1 = forge.pkcs12.toPkcs12Asn1(privateKey, [certificate, ...caCertificates], tempPassword, { algorithm: '3des' });
+        const p12Der = forge.asn1.toDer(p12Asn1).getBytes();
+        const p12Buffer = Buffer.from(p12Der, 'binary');
+        const httpsAgent = new https.Agent({
+            pfx: p12Buffer,
+            passphrase: tempPassword,
+            rejectUnauthorized: true, // Ensure the server certificate is validated
+        });
+        this.client = axios_1.default.create({
+            baseURL: environments_1.environmentUrls[environment],
+            httpsAgent,
+            timeout,
+            headers: {
+                'Content-Type': 'application/xml;charset=utf-8',
+            },
+        });
+    }
+    /**
+     * Sends a POST request to the specified path with the given XML payload.
+     *
+     * @param path The API endpoint path.
+     * @param xmlPayload The XML string to send.
+     * @returns A promise that resolves with the response data.
+     */
+    async post(path, xmlPayload) {
+        try {
+            const response = await this.client.post(path, xmlPayload);
+            return response.data;
+        }
+        catch (error) {
+            // Enhance error handling to provide more context
+            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(`An unexpected error occurred: ${error}`);
+        }
+    }
+}
+exports.NfseClient = NfseClient;

package/dist/core/signer.d.ts

@@ -0,0 +1,10 @@
+import { CertificateData } from './certificate';
+/**
+ * Signs an XML string with the provided certificate data.
+ *
+ * @param xml The XML string to sign.
+ * @param certificateData The certificate data to use for signing.
+ * @param tagToSign The name of the tag within the XML to which the signature will be appended.
+ * @returns The signed XML string.
+ */
+export declare function signXml(xml: string, certificateData: CertificateData, tagToSign: string): string;

package/dist/core/signer.js

@@ -0,0 +1,86 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signXml = signXml;
+const forge = __importStar(require("node-forge"));
+/**
+ * Signs an XML string with the provided certificate data.
+ *
+ * @param xml The XML string to sign.
+ * @param certificateData The certificate data to use for signing.
+ * @param tagToSign The name of the tag within the XML to which the signature will be appended.
+ * @returns The signed XML string.
+ */
+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
+    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}>`);
+    return signedXml;
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { NfseClient } from './core/client';
+export type { NfseClientConfig } from './core/client';
+export { loadA1Certificate } from './core/certificate';
+export type { CertificateData } from './core/certificate';
+export { enviaDps } from './services/dps';
+export { consultarNfseChave, consultarDpsChave } 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 { NFSe, DPSConsultaResponse } from './models/responses';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.environmentUrls = exports.consultarDpsChave = exports.consultarNfseChave = exports.enviaDps = 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 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; } });
+var environments_1 = require("./config/environments");
+Object.defineProperty(exports, "environmentUrls", { enumerable: true, get: function () { return environments_1.environmentUrls; } });

package/dist/models/dps.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Based on ANEXO_I-SEFIN_ADN-DPS_NFSe-SNNFSe
+ */
+export interface Endereco {
+    logradouro: string;
+    numero: string;
+    complemento?: string;
+    bairro: string;
+    codigoMunicipio: string;
+    uf: string;
+    cep: string;
+}
+export interface Contato {
+    telefone?: string;
+    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';
+    };
+    prestador: {
+        cnpj: string;
+        inscricaoMunicipal?: string;
+        regimeEspecialTributacao?: string;
+    };
+    tomador: {
+        identificacao: {
+            cnpjCpf: string;
+            inscricaoMunicipal?: string;
+        };
+        razaoSocial: string;
+        endereco: Endereco;
+        contato?: Contato;
+    };
+    servico: {
+        codigoNbs: string;
+        discriminacao: string;
+        valorServicos: 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;
+    };
+    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 NFSeResponse {
+    chaveAcesso: string;
+}

package/dist/models/dps.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Based on ANEXO_I-SEFIN_ADN-DPS_NFSe-SNNFSe
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/responses.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Represents the structure of a successfully queried NFSe.
+ * The fields here are based on common NFSe layouts and should be
+ * adjusted according to the actual API response.
+ */
+export interface NFSe {
+    chaveAcesso: string;
+    numero: string;
+    dataEmissao: Date;
+    status: string;
+    valorTotal: number;
+    prestador: {
+        cnpj: string;
+        razaoSocial: string;
+    };
+    tomador: {
+        cnpjCpf: string;
+        razaoSocial: string;
+    };
+}
+/**
+ * Represents the structure of a successfully queried DPS.
+ */
+export interface DPSConsultaResponse {
+    chaveAcesso: string;
+    status: 'enviada' | 'processada' | 'erro';
+    numeroNfse?: string;
+}

package/dist/models/responses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/consultas.d.ts

@@ -0,0 +1,18 @@
+import { NfseClient } from '../core/client';
+import { NFSe, DPSConsultaResponse } from '../models/responses';
+/**
+ * Consults an NFSe by its access key.
+ *
+ * @param chaveAcesso The 50-character access key of the NFSe.
+ * @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>;
+/**
+ * Consults a DPS by its access key.
+ *
+ * @param chaveAcesso The access key of the DPS.
+ * @param client An instance of the configured NfseClient.
+ * @returns A promise that resolves with the DPS consultation data.
+ */
+export declare function consultarDpsChave(chaveAcesso: string, client: NfseClient): Promise<DPSConsultaResponse>;

package/dist/services/consultas.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.consultarNfseChave = consultarNfseChave;
+exports.consultarDpsChave = consultarDpsChave;
+const fast_xml_parser_1 = require("fast-xml-parser");
+/**
+ * Consults an NFSe by its access key.
+ *
+ * @param chaveAcesso The 50-character access key of the NFSe.
+ * @param client An instance of the configured NfseClient.
+ * @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;
+}
+/**
+ * Consults a DPS by its access key.
+ *
+ * @param chaveAcesso The access key of the DPS.
+ * @param client An instance of the configured NfseClient.
+ * @returns A promise that resolves with the DPS consultation 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.');
+    }
+    return dpsData;
+}

package/dist/services/dps.d.ts

@@ -0,0 +1,13 @@
+import { DPS, NFSeResponse } from '../models/dps';
+import { NfseClient } from '../core/client';
+import { CertificateData } from '../core/certificate';
+/**
+ * Orchestrates the process of sending a DPS to the NFSe Nacional API.
+ *
+ * @param dps The DPS object to be sent.
+ * @param client An instance of the configured NfseClient.
+ * @param certificate The certificate data for signing.
+ * @returns A promise that resolves with the response from the API.
+ * @throws Will throw an error if any step of the process fails.
+ */
+export declare function enviaDps(dps: DPS, client: NfseClient, certificate: CertificateData): Promise<NFSeResponse>;

package/dist/services/dps.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ *
+ * @param dps The DPS object to be sent.
+ * @param client An instance of the configured NfseClient.
+ * @param certificate The certificate data for signing.
+ * @returns A promise that resolves with the response from the API.
+ * @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');
+        // 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,
+        };
+    }
+    catch (error) {
+        console.error('Failed to send DPS:', error);
+        // Re-throw the error to be handled by the caller
+        throw error;
+    }
+}

package/dist/utils/compression.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Compresses an XML string using GZip and then encodes it in Base64.
+ *
+ * @param xml The input XML string.
+ * @returns A promise that resolves with the Base64 encoded GZipped string.
+ */
+export declare function compressAndEncodeXml(xml: string): Promise<string>;

package/dist/utils/compression.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compressAndEncodeXml = compressAndEncodeXml;
+const zlib = __importStar(require("zlib"));
+const util_1 = require("util");
+const gzip = (0, util_1.promisify)(zlib.gzip);
+/**
+ * Compresses an XML string using GZip and then encodes it in Base64.
+ *
+ * @param xml The input XML string.
+ * @returns A promise that resolves with the Base64 encoded GZipped string.
+ */
+async function compressAndEncodeXml(xml) {
+    const buffer = Buffer.from(xml, 'utf-8');
+    const compressedBuffer = await gzip(buffer);
+    return compressedBuffer.toString('base64');
+}

package/dist/utils/xml.d.ts

@@ -0,0 +1,10 @@
+import { DPS } from '../models/dps';
+/**
+ * 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.
+ */
+export declare function buildDpsXml(dps: DPS): string;

package/dist/utils/xml.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDpsXml = buildDpsXml;
+const date_fns_1 = require("date-fns");
+/**
+ * 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.
+ */
+function buildDpsXml(dps) {
+    // Helper to format dates to 'yyyy-MM-dd'
+    const formatDate = (date) => (0, date_fns_1.format)(date, 'yyyy-MM-dd');
+    // 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>
+</DPS>`;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@pereirajair/nfse-gov-br-node",
+  "version": "0.0.3",
+  "description": "Library for interacting with the Brazilian NFSe Nacional API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.10",
+    "@types/node-forge": "^1.3.14",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "axios": "^1.13.4",
+    "date-fns": "^2.30.0",
+    "fast-xml-parser": "^4.5.3",
+    "node-forge": "^1.3.3",
+    "zod": "^3.25.76"
+  }
+}