@treeunfe/cte 1.0.5

package/src/exemplo-uso.ts

@@ -0,0 +1,216 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Exemplo de uso do serviço CTEDistribuicaoDFe
+ * 
+ * Este arquivo demonstra como utilizar o serviço de distribuição de CTe
+ * nas diferentes modalidades disponíveis.
+ * 
+ * NOTA: Este é um arquivo de exemplo. Ajuste as configurações conforme sua implementação.
+ */
+
+// @ts-nocheck - Arquivo de exemplo, não incluído no build
+
+import { XmlBuilder, BaseNFe, Environment, Utility, logger, GerarConsulta, SaveFiles, XmlParser, ValidaCPFCNPJ, mountCOFINS, mountICMS, mountPIS } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import axios from 'axios';
+import CTEDistribuicaoDFe from './operations/CTEDistribuicaoDFe/CTEDistribuicaoDFe.js';
+import CTEDistribuicaoDFePorNSU from './operations/CTEDistribuicaoDFe/CTEDistribuicaoDFePorNSU.js';
+import CTEDistribuicaoDFePorUltNSU from './operations/CTEDistribuicaoDFe/CTEDistribuicaoDFePorUltNSU.js';
+
+// Exemplo de configuração (ajustar conforme necessário)
+const config = {
+    dfe: {
+        UF: 'SP',
+        ambiente: 2, // 1=Produção, 2=Homologação
+        pathXMLDistribuicao: './tmp/DistribuicaoDFe',
+        baixarXMLDistribuicao: true,
+        armazenarRetornoEmJSON: true,
+    },
+    nfe: {
+        ambiente: 2,
+    }
+};
+
+/**
+ * Exemplo 1: Consulta por último NSU
+ * 
+ * Este método consulta todos os documentos disponíveis a partir do último NSU conhecido.
+ * É útil para sincronização incremental de documentos.
+ */
+async function exemploPorUltNSU() {
+    const environment = new Environment(config);
+    const utility = new Utility(environment);
+    const xmlBuilder = new XmlBuilder();
+
+    // Instancias dos serviços necessários (ajustar conforme implementação)
+    const saveFiles: SaveFilesImpl = {} as SaveFilesImpl;
+    const gerarConsulta: GerarConsultaImpl = {} as GerarConsultaImpl;
+
+    const service = new CTEDistribuicaoDFePorUltNSU(
+        environment,
+        utility,
+        xmlBuilder,
+        axios,
+        saveFiles,
+        gerarConsulta
+    );
+
+    const cteDistribuicao = new CTEDistribuicaoDFe(service);
+
+    try {
+        const resultado = await cteDistribuicao.Exec({
+            cUFAutor: '35', // UF do autor (35 = São Paulo)
+            CNPJ: '12345678901234', // CNPJ do interessado
+            distNSU: {
+                ultNSU: '000000000000000' // Último NSU conhecido (zeros para primeiro acesso)
+            }
+        });
+
+        console.log('Resultado da consulta por último NSU:');
+        console.log('Mensagem:', resultado.xMotivo);
+        console.log('Arquivos processados:', resultado.filesList);
+        console.log('Dados:', resultado.data);
+    } catch (error) {
+        console.error('Erro ao consultar por último NSU:', error);
+    }
+}
+
+/**
+ * Exemplo 2: Consulta por NSU específico
+ * 
+ * Este método consulta um documento através de seu NSU específico.
+ * Útil para recuperar documentos individuais quando você tem o NSU.
+ * 
+ * NOTA: O CTe NÃO possui consulta por chave de acesso na distribuição DFe,
+ * apenas por NSU, conforme norma técnica.
+ */
+async function exemploPorNSU() {
+    const environment = new Environment(config);
+    const utility = new Utility(environment);
+    const xmlBuilder = new XmlBuilder();
+
+    const saveFiles: SaveFilesImpl = {} as SaveFilesImpl;
+    const gerarConsulta: GerarConsultaImpl = {} as GerarConsultaImpl;
+
+    const service = new CTEDistribuicaoDFePorNSU(
+        environment,
+        utility,
+        xmlBuilder,
+        axios,
+        saveFiles,
+        gerarConsulta
+    );
+
+    const cteDistribuicao = new CTEDistribuicaoDFe(service);
+
+    try {
+        const resultado = await cteDistribuicaoDFe.Exec({
+            cUFAutor: '35',
+            CNPJ: '12345678901234',
+            consNSU: {
+                NSU: '000000000000123' // NSU específico
+            }
+        });
+
+        console.log('Resultado da consulta por NSU:');
+        console.log('Mensagem:', resultado.xMotivo);
+        console.log('Arquivos processados:', resultado.filesList);
+        console.log('Dados:', resultado.data);
+    } catch (error) {
+        console.error('Erro ao consultar por NSU:', error);
+    }
+}
+
+/**
+ * Códigos de retorno comuns
+ * 
+ * 137 - Nenhum documento localizado
+ * 138 - Documento localizado
+ * 656 - Consulta a ser processada
+ */
+
+// Descomentar para testar
+// exemploPorUltNSU();
+// exemploPorNSU();
+
+export {
+    exemploPorNSU, exemploPorUltNSU
+};
+
+/**
+ * Exemplo 3: Consulta por NSU específico
+ * 
+ * Este método consulta um documento através de seu NSU específico.
+ * Útil para recuperar documentos individuais quando você tem o NSU.
+ */
+async function exemploPorNSU() {
+    const environment = new Environment(config);
+    const utility = new Utility(environment);
+    const xmlBuilder = new XmlBuilder();
+
+    const saveFiles: SaveFilesImpl = {} as SaveFilesImpl;
+    const gerarConsulta: GerarConsultaImpl = {} as GerarConsultaImpl;
+
+    const service = new CTEDistribuicaoDFePorNSU(
+        environment,
+        utility,
+        xmlBuilder,
+        axios,
+        saveFiles,
+        gerarConsulta
+    );
+
+    const cteDistribuicao = new CTEDistribuicaoDFe(service);
+
+    try {
+        const resultado = await cteDistribuicao.Exec({
+            cUFAutor: '35',
+            CNPJ: '12345678901234',
+            consNSU: {
+                NSU: '000000000000123' // NSU específico
+            }
+        });
+
+        console.log('Resultado da consulta por NSU:');
+        console.log('Mensagem:', resultado.xMotivo);
+        console.log('Arquivos processados:', resultado.filesList);
+        console.log('Dados:', resultado.data);
+    } catch (error) {
+        console.error('Erro ao consultar por NSU:', error);
+    }
+}
+
+/**
+ * Códigos de retorno comuns
+ * 
+ * 137 - Nenhum documento localizado
+ * 138 - Documento localizado
+ * 656 - Consulta a ser processada
+ */
+
+// Descomentar para testar
+// exemploPorUltNSU();
+// exemploPorChave();
+// exemploPorNSU();
+
+export {
+    exemploPorChave,
+    exemploPorNSU, exemploPorUltNSU
+};
+

package/src/index.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+// Re-export all types from @treeunfe/types
+export * from '@treeunfe/types';
+
+// Export handlers
+export { default as CTe } from './adapters/CTe';
+
+// Export operations
+export * from './operations/index';
+
+// Export services
+export * from './services/index';

package/src/operations/CTEDistribuicaoDFe/CTEDistribuicaoDFe.ts

@@ -0,0 +1,30 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { CTEDistribuicaoDFeServiceImpl } from '@treeunfe/types/interfaces';
+
+class CTEDistribuicaoDFe implements CTEDistribuicaoDFeServiceImpl {
+    cteDistribuicaoDFeService: CTEDistribuicaoDFeServiceImpl;
+    constructor(cteDistribuicaoDFeService: CTEDistribuicaoDFeServiceImpl) {
+        this.cteDistribuicaoDFeService = cteDistribuicaoDFeService;
+    }
+
+    async Exec(data?: any): Promise<any> {
+        return await this.cteDistribuicaoDFeService.Exec(data);
+    }
+}
+
+export default CTEDistribuicaoDFe;

package/src/operations/CTEDistribuicaoDFe/CTEDistribuicaoDFePorNSU.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { XmlBuilder, Environment, Utility } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import { AxiosInstance } from 'axios';
+import CTEDistribuicaoDFeService from '../../services/CTEDistribuicaoDFe/CTEDistribuicaoDFeService.js';
+
+class CTEDistribuicaoDFePorNSU extends CTEDistribuicaoDFeService {
+    constructor(environment: Environment, utility: Utility, xmlBuilder: XmlBuilder, axios: AxiosInstance, saveFiles: SaveFilesImpl, gerarConsulta: GerarConsultaImpl) {
+        super(environment, utility, xmlBuilder, axios, saveFiles, gerarConsulta);
+    }
+}
+
+export default CTEDistribuicaoDFePorNSU;

package/src/operations/CTEDistribuicaoDFe/CTEDistribuicaoDFePorUltNSU.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { XmlBuilder, Environment, Utility } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import { AxiosInstance } from 'axios';
+import CTEDistribuicaoDFeService from '../../services/CTEDistribuicaoDFe/CTEDistribuicaoDFeService.js';
+
+class CTEDistribuicaoDFePorUltNSU extends CTEDistribuicaoDFeService {
+    constructor(environment: Environment, utility: Utility, xmlBuilder: XmlBuilder, axios: AxiosInstance, saveFiles: SaveFilesImpl, gerarConsulta: GerarConsultaImpl) {
+        super(environment, utility, xmlBuilder, axios, saveFiles, gerarConsulta);
+    }
+}
+
+export default CTEDistribuicaoDFePorUltNSU;

package/src/operations/index.ts

@@ -0,0 +1,20 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+export { default as CTEDistribuicaoDFe } from './CTEDistribuicaoDFe/CTEDistribuicaoDFe';
+export { default as CTEDistribuicaoDFePorNSU } from './CTEDistribuicaoDFe/CTEDistribuicaoDFePorNSU';
+export { default as CTEDistribuicaoDFePorUltNSU } from './CTEDistribuicaoDFe/CTEDistribuicaoDFePorUltNSU';

package/src/services/CTEDistribuicaoDFe/CTEDistribuicaoDFePorNSU.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { XmlBuilder, Environment, Utility } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import { AxiosInstance } from 'axios';
+import CTEDistribuicaoDFeService from './CTEDistribuicaoDFeService.js';
+
+class CTEDistribuicaoDFePorNSUService extends CTEDistribuicaoDFeService {
+    constructor(environment: Environment, utility: Utility, xmlBuilder: XmlBuilder, axios: AxiosInstance, saveFiles: SaveFilesImpl, gerarConsulta: GerarConsultaImpl) {
+        super(environment, utility, xmlBuilder, axios, saveFiles, gerarConsulta);
+    }
+}
+
+export default CTEDistribuicaoDFePorNSUService;

package/src/services/CTEDistribuicaoDFe/CTEDistribuicaoDFePorUltNSU.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { XmlBuilder, Environment, Utility } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import { AxiosInstance } from 'axios';
+import CTEDistribuicaoDFeService from './CTEDistribuicaoDFeService.js';
+
+class CTEDistribuicaoDFePorUltNSUService extends CTEDistribuicaoDFeService {
+    constructor(environment: Environment, utility: Utility, xmlBuilder: XmlBuilder, axios: AxiosInstance, saveFiles: SaveFilesImpl, gerarConsulta: GerarConsultaImpl) {
+        super(environment, utility, xmlBuilder, axios, saveFiles, gerarConsulta);
+    }
+}
+
+export default CTEDistribuicaoDFePorUltNSUService;

package/src/services/CTEDistribuicaoDFe/CTEDistribuicaoDFeService.ts

@@ -0,0 +1,141 @@
+/*
+ * This file is part of Treeunfe DFe.
+ * 
+ * Treeunfe DFe is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Treeunfe DFe is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Treeunfe DFe. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { XmlBuilder, BaseNFe, Environment, Utility, logger } from '@treeunfe/shared';
+import { GerarConsultaImpl, SaveFilesImpl } from '@treeunfe/types/interfaces';
+import { GenericObject } from '@treeunfe/types/common';
+import { ConsultaCTe } from '@treeunfe/types/cte';
+import { AxiosInstance, AxiosResponse } from 'axios';
+import { Agent } from 'http';
+import DistribuicaoHandler from './util/DistribuicaoHandler.js';
+
+class CTEDistribuicaoDFeService extends BaseNFe {
+    constructor(environment: Environment, utility: Utility, xmlBuilder: XmlBuilder, axios: AxiosInstance, saveFiles: SaveFilesImpl, gerarConsulta: GerarConsultaImpl) {
+        super(environment, utility, xmlBuilder, 'CTeDistribuicaoDFe', axios, saveFiles, gerarConsulta);
+    }
+
+    protected gerarXml(data: ConsultaCTe): string {
+        return this.gerarXmlCTeDistribuicaoDFe(data);
+    }
+
+    gerarXmlCTeDistribuicaoDFe(data: ConsultaCTe) {
+        logger.info('Montando estrutura do XML em JSON', {
+            context: 'CTEDistribuicaoDFeService',
+        });
+        const { ambiente } = this.environment.getConfig();
+
+        // XML para CTe - versão 1.00
+        const xmlObject = {
+            $: {
+                versao: "1.00",
+                xmlns: 'http://www.portalfiscal.inf.br/cte'
+            },
+            tpAmb: ambiente,
+            ...data,
+        }
+
+        return this.xmlBuilder.gerarXml(xmlObject, 'distDFeInt', this.metodo)
+    }
+
+    protected async callWebService(xmlConsulta: string, webServiceUrl: string, ContentType: string, action: string, agent: Agent): Promise<AxiosResponse<any, any>> {
+        const startTime = Date.now();
+
+        const headers = {
+            'Content-Type': ContentType,
+        };
+
+        logger.http('Iniciando comunicação com o webservice', {
+            context: `CTEDistribuicaoDFeService`,
+            method: this.metodo,
+            url: webServiceUrl,
+            action,
+            headers,
+        });
+
+        const response = await this.axios.post(webServiceUrl, xmlConsulta, {
+            headers,
+            httpsAgent: agent
+        });
+
+        const duration = Date.now() - startTime;
+
+        logger.http('Comunicação concluída com sucesso', {
+            context: `CTEDistribuicaoDFeService`,
+            method: this.metodo,
+            duration: `${duration}ms`,
+            responseSize: response.data ? JSON.stringify(response.data).length : 0
+        });
+
+        return response;
+    }
+
+    async Exec(data: ConsultaCTe) {
+        let xmlConsulta: string = '';
+        let xmlConsultaSoap: string = '';
+        // webServiceUrlTmp não é usado, mas mantido para compatibilidade
+        // let webServiceUrlTmp: string = '';
+        let responseInJson: GenericObject | undefined = undefined;
+        let xmlRetorno: AxiosResponse<any, any> = {} as AxiosResponse<any, any>;
+        const ContentType = this.setContentType();
+        try {
+            // Gerando XML para consulta de Distribuição DFe do CTe
+            xmlConsulta = this.gerarXmlCTeDistribuicaoDFe(data);
+            console.log({ xmlConsulta })
+            const { xmlFormated, agent, webServiceUrl, action } = await this.gerarConsulta.gerarConsulta(xmlConsulta, this.metodo, true, '1.00', 'CTe', true, 'cteDistDFeInteresse', 'cteDadosMsg');
+
+            xmlConsultaSoap = xmlFormated;
+            // webServiceUrlTmp não é usado, mas mantido para compatibilidade
+            // webServiceUrlTmp = webServiceUrl;
+
+            const xmlRetorno = await this.callWebService(xmlFormated, webServiceUrl, ContentType, action, agent);
+
+            // Verifica se houve rejeição
+            responseInJson = this.utility.verificaRejeicao(xmlRetorno.data, this.metodo);
+
+            if (responseInJson.retDistDFeInt.cStat === '137') {
+                return {
+                    data: {} as GenericObject,
+                    xMotivo: responseInJson.retDistDFeInt.xMotivo,
+                    filesList: [],
+                }
+            }
+            /**
+             * Descompacta XML
+             * Converte XML para Json
+             * Salva XML
+             * Gera erro em caso de rejeição
+             */
+            const handlerDistribuicao = new DistribuicaoHandler(this.environment, this.utility, this.metodo);
+            const filesList = handlerDistribuicao.deCompressDFeXML(xmlRetorno.data, this.metodo, xmlConsulta);
+            const xMotivo = this.utility.findInObj(responseInJson, 'xMotivo');
+
+            return {
+                data: responseInJson,
+                xMotivo,
+                filesList,
+            }
+        } finally {
+            // Salva XML de Consulta
+            this.utility.salvaConsulta(xmlConsulta, xmlConsultaSoap, this.metodo);
+
+            // Salva XML de Retorno
+            this.utility.salvaRetorno(xmlRetorno.data, responseInJson, this.metodo);
+        }
+    }
+
+}
+
+export default CTEDistribuicaoDFeService;