nfewizard-io 0.3.0 → 0.3.2

package/README.md

@@ -22,6 +22,14 @@ para autorização.
     - Operação Não Realizada
 - **Geração de DANFE**: Criação do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE), um resumo impresso da NFe.
 
+## 🚧 ATENÇÃO 🚧
+
+Para ambientes CJS (CommonJS) a importação utilizada deverá ser feita da seguinte maneira:
+```typescript
+const NFeWizard = require('nfewizard-io').default;
+```
+
+
 ## Exemplo de Utilização
 
 ```typescript
@@ -94,12 +102,10 @@ await nfeWizard.NFE_DistribuicaoDFePorChave(chaveNFe);
 - Para a documentação completa acesse [NFeWizard-io - Docs](https://nfewizard-org.github.io/)
   
 
-## Última Release (0.1.9)
+## Última Release (0.3.1)
 
-- Adicionada propriedade useForSchemaValidation (config - lib - useForSchemaValidation). Caso 'validateSchemaJsBased' chama um método que não utiliza JAVA para validar o xml. Caso 'validateSchemaJavaBased' chama um método baseado em JAAVA para validar o xml.
-- Adicionado método de *validateSchemaJsBased* e *validateSchemaJavaBased* para validação do XML condicionado à propriedade *useForSchemaValidation* na configuração do ambiente.
-- Externaliza libxmljs
-- Finaliza ajustes para funcionamento em ambiente lambda
+- Efetuados diversos ajustes na emissão de NFC-e.
+- Alterada estrutura de pastas da lib (com mais alterações estruturais por vir)
 
 ## Observações
 
@@ -154,9 +160,8 @@ await nfeWizard.NFE_DistribuicaoDFePorChave(chaveNFe);
 
 ### Próximos passos
 
-- Adicionar Testes
-- Aplicar SOLID
 - Adicionar tratamento de LOGs
+- Estudo para implementação de NFSe
 
 ## Contribua para Nossa Biblioteca Open Source
 

package/dist/cjs/{controllers/Email/MailController.d.ts → adapters/MailAdapter.d.ts}

@@ -1,5 +1,5 @@
-import Environment from '@Classes/Environment';
-import { EmailParams } from '@Protocols';
+import Environment from '@Modules/environment/Environment.js';
+import { EmailParams } from 'src/core/types';
 declare class MailController {
     private environment;
     constructor(environment: Environment);

package/dist/cjs/{classes → adapters}/NFeWizard.d.ts

@@ -1,12 +1,7 @@
-import { NFeWizardProps, EventoNFe, ConsultaNFe, NFe, InutilizacaoData, NFEGerarDanfeProps, DFePorChaveNFe, DFePorUltimoNSU, DFePorNSU, Cancelamento, CienciaDaOperacao, ConfirmacaoDaOperacao, OperacaoNaoRealizada, CartaDeCorrecao, DesconhecimentoDaOperacao, EPEC, EmailParams } from '@Protocols';
-declare class NFeWizard {
-    private config;
-    private certificate;
-    private cert_key;
-    private environment;
-    private utility;
-    private xmlBuilder;
-    private axios;
+import { NFeWizardProps, EventoNFe, ConsultaNFe, NFe, InutilizacaoData, NFEGerarDanfeProps, DFePorChaveNFe, DFePorUltimoNSU, DFePorNSU, Cancelamento, CienciaDaOperacao, ConfirmacaoDaOperacao, OperacaoNaoRealizada, CartaDeCorrecao, DesconhecimentoDaOperacao, EPEC, EmailParams } from 'src/core/types';
+import { NFeWizardImpl } from '@Interfaces';
+export default class NFeWizard implements NFeWizardImpl {
+    private nfeWizardService;
     constructor();
     NFE_LoadEnvironment({ config }: {
         config: NFeWizardProps;
@@ -22,31 +17,31 @@ declare class NFeWizard {
     /**
      * Recepção de Eventos
      */
-    NFE_RecepcaoEvento(evento: EventoNFe): Promise<import("@Protocols").GenericObject[]>;
-    NFE_EventoPrevioDeEmissaoEmContingencia(evento: EPEC): Promise<import("@Protocols").GenericObject[]>;
-    NFE_Cancelamento(evento: Cancelamento): Promise<import("@Protocols").GenericObject[]>;
-    NFE_CienciaDaOperacao(evento: CienciaDaOperacao): Promise<import("@Protocols").GenericObject[]>;
-    NFE_ConfirmacaoDaOperacao(evento: ConfirmacaoDaOperacao): Promise<import("@Protocols").GenericObject[]>;
-    NFE_OperacaoNaoRealizada(evento: OperacaoNaoRealizada): Promise<import("@Protocols").GenericObject[]>;
-    NFE_CartaDeCorrecao(evento: CartaDeCorrecao): Promise<import("@Protocols").GenericObject[]>;
-    NFE_DesconhecimentoDaOperacao(evento: DesconhecimentoDaOperacao): Promise<import("@Protocols").GenericObject[]>;
+    NFE_RecepcaoEvento(evento: EventoNFe): Promise<import("src/core/types").GenericObject[]>;
+    NFE_EventoPrevioDeEmissaoEmContingencia(evento: EPEC): Promise<import("src/core/types").GenericObject[]>;
+    NFE_Cancelamento(evento: Cancelamento): Promise<import("src/core/types").GenericObject[]>;
+    NFE_CienciaDaOperacao(evento: CienciaDaOperacao): Promise<import("src/core/types").GenericObject[]>;
+    NFE_ConfirmacaoDaOperacao(evento: ConfirmacaoDaOperacao): Promise<import("src/core/types").GenericObject[]>;
+    NFE_OperacaoNaoRealizada(evento: OperacaoNaoRealizada): Promise<import("src/core/types").GenericObject[]>;
+    NFE_CartaDeCorrecao(evento: CartaDeCorrecao): Promise<import("src/core/types").GenericObject[]>;
+    NFE_DesconhecimentoDaOperacao(evento: DesconhecimentoDaOperacao): Promise<import("src/core/types").GenericObject[]>;
     /**
      * Distribuição DFe
      */
-    NFE_DistribuicaoDFe(data: ConsultaNFe): Promise<import("@Protocols").GenericObject>;
-    NFE_DistribuicaoDFePorUltNSU(data: DFePorUltimoNSU): Promise<import("@Protocols").GenericObject>;
-    NFE_DistribuicaoDFePorNSU(data: DFePorNSU): Promise<import("@Protocols").GenericObject>;
-    NFE_DistribuicaoDFePorChave(data: DFePorChaveNFe): Promise<import("@Protocols").GenericObject>;
+    NFE_DistribuicaoDFe(data: ConsultaNFe): Promise<import("src/core/types").GenericObject>;
+    NFE_DistribuicaoDFePorUltNSU(data: DFePorUltimoNSU): Promise<import("src/core/types").GenericObject>;
+    NFE_DistribuicaoDFePorNSU(data: DFePorNSU): Promise<import("src/core/types").GenericObject>;
+    NFE_DistribuicaoDFePorChave(data: DFePorChaveNFe): Promise<import("src/core/types").GenericObject>;
     /**
      * Autorização
      */
     NFE_Autorizacao(data: NFe): Promise<{
-        NFe: import("@Protocols").LayoutNFe;
-        protNFe: import("@Protocols").ProtNFe;
+        NFe: import("src/core/types").LayoutNFe;
+        protNFe: import("src/core/types").ProtNFe;
     }[]>;
     NFCE_Autorizacao(data: NFe): Promise<{
-        NFe: import("@Protocols").LayoutNFe;
-        protNFe: import("@Protocols").ProtNFe;
+        NFe: import("src/core/types").LayoutNFe;
+        protNFe: import("src/core/types").ProtNFe;
     }[]>;
     /**
      * Inutilização
@@ -68,9 +63,4 @@ declare class NFeWizard {
      * @param {EmailParams} mailParams - Mensagem de texto (aceita html)
      */
     NFE_EnviaEmail(mailParams: EmailParams): void;
-    /**
-     * Validação de ambiente
-     */
-    private validateEnvironment;
 }
-export default NFeWizard;

package/dist/cjs/{classes → adapters}/XmlBuilder.d.ts

@@ -1,4 +1,4 @@
-import Environment from '@Classes/Environment';
+import Environment from '@Modules/environment/Environment.js';
 export interface NamespacesProps {
     [key: string]: string;
 }

package/dist/cjs/core/interfaces/GerarConsultaImpl.d.ts

@@ -0,0 +1,9 @@
+import { Agent } from 'http';
+export interface GerarConsultaImpl {
+    gerarConsulta(xmlConsulta: string, metodo: string, ambienteNacional?: boolean, versao?: string, mod?: string, rootTag?: boolean, tag?: string): Promise<{
+        xmlFormated: string;
+        agent: Agent;
+        webServiceUrl: string;
+        action: string;
+    }>;
+}

package/dist/cjs/core/interfaces/HttpClient.d.ts

@@ -0,0 +1,9 @@
+import https from 'https';
+export interface HttpClient<T = any> {
+    create(config: HttpClientConfig): T;
+}
+export interface HttpClientConfig {
+    headers: Record<string, string>;
+    timeout: number;
+    agent?: https.Agent;
+}

package/dist/cjs/core/interfaces/NFCEAutorizacaoServiceImpl.d.ts

@@ -0,0 +1,11 @@
+import { LayoutNFe, NFe, ProtNFe, GenericObject } from '@Types';
+export interface NFCEAutorizacaoServiceImpl {
+    Exec(data: NFe): Promise<{
+        success: boolean;
+        xMotivo: GenericObject;
+        xmls: {
+            NFe: LayoutNFe;
+            protNFe: ProtNFe;
+        }[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFCERetornoAutorizacaoServiceImpl.d.ts

@@ -0,0 +1,13 @@
+import { ProtNFe } from '@Types';
+export interface NFCERetornoAutorizacaoServiceImpl {
+    getXmlRetorno({ tipoEmissao, nRec, protNFe, xmlNFe }: {
+        tipoEmissao: number;
+        nRec?: string;
+        protNFe?: ProtNFe[];
+        xmlNFe: string[];
+    }): Promise<{
+        success: boolean;
+        message: any;
+        data: string[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFEAutorizacaoServiceImpl.d.ts

@@ -0,0 +1,11 @@
+import { LayoutNFe, NFe, ProtNFe, GenericObject } from '@Types';
+export interface NFEAutorizacaoServiceImpl {
+    Exec(data: NFe): Promise<{
+        success: boolean;
+        xMotivo: GenericObject;
+        xmls: {
+            NFe: LayoutNFe;
+            protNFe: ProtNFe;
+        }[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFEDistribuicaoDFeServiceImpl.d.ts

@@ -0,0 +1,9 @@
+import { ConsultaNFe } from '@Types/NFEDistribuicaoDFe';
+import { GenericObject } from '@Types/Utils';
+export interface NFEDistribuicaoDFeServiceImpl {
+    Exec(data: ConsultaNFe): Promise<{
+        data: GenericObject;
+        xMotivo: any;
+        filesList: string[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFEInutilizacaoServiceImpl.d.ts

@@ -0,0 +1,3 @@
+export interface NFEInutilizacaoServiceImpl {
+    Exec(data?: any): Promise<any>;
+}

package/dist/cjs/core/interfaces/NFERecepcaoEventoServiceImpl.d.ts

@@ -0,0 +1,9 @@
+import { EventoNFe } from '@Types/NFERecepcaoEvento';
+import { GenericObject } from '@Types/Utils';
+export interface NFERecepcaoEventoServiceImpl {
+    Exec(data: EventoNFe): Promise<{
+        success: boolean;
+        xMotivos: any[];
+        response: GenericObject[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFERetornoAutorizacaoServiceImpl.d.ts

@@ -0,0 +1,13 @@
+import { ProtNFe } from '@Types';
+export interface NFERetornoAutorizacaoServiceImpl {
+    getXmlRetorno({ tipoEmissao, nRec, protNFe, xmlNFe }: {
+        tipoEmissao: number;
+        nRec?: string;
+        protNFe?: ProtNFe[];
+        xmlNFe: string[];
+    }): Promise<{
+        success: boolean;
+        message: any;
+        data: string[];
+    }>;
+}

package/dist/cjs/core/interfaces/NFEStatusServicoServiceImpl.d.ts

@@ -0,0 +1,3 @@
+export interface NFEStatusServicoServiceImpl {
+    Exec(data?: any): Promise<any>;
+}

package/dist/cjs/core/interfaces/NFEconsultaProtocoloServiceImpl.d.ts

@@ -0,0 +1,3 @@
+export interface NFEconsultaProtocoloServiceImpl {
+    Exec(data?: any): Promise<any>;
+}

package/dist/cjs/core/interfaces/NFeWizardImpl.d.ts

@@ -0,0 +1,38 @@
+import { Cancelamento, CartaDeCorrecao, CienciaDaOperacao, ConfirmacaoDaOperacao, ConsultaNFe, DesconhecimentoDaOperacao, DFePorChaveNFe, DFePorNSU, DFePorUltimoNSU, EmailParams, EPEC, EventoNFe, GenericObject, InutilizacaoData, LayoutNFe, NFe, NFEGerarDanfeProps, NFeWizardProps, OperacaoNaoRealizada, ProtNFe } from '@Types';
+export interface NFeWizardImpl {
+    NFE_LoadEnvironment({ config }: {
+        config: NFeWizardProps;
+    }): Promise<void>;
+    NFE_ConsultaStatusServico(): Promise<any>;
+    NFE_ConsultaProtocolo(chave: string): Promise<any>;
+    NFE_RecepcaoEvento(evento: EventoNFe): Promise<GenericObject[]>;
+    NFE_EventoPrevioDeEmissaoEmContingencia(evento: EPEC): Promise<GenericObject[]>;
+    NFE_Cancelamento(evento: Cancelamento): Promise<GenericObject[]>;
+    NFE_CienciaDaOperacao(evento: CienciaDaOperacao): Promise<GenericObject[]>;
+    NFE_ConfirmacaoDaOperacao(evento: ConfirmacaoDaOperacao): Promise<GenericObject[]>;
+    NFE_OperacaoNaoRealizada(evento: OperacaoNaoRealizada): Promise<GenericObject[]>;
+    NFE_CartaDeCorrecao(evento: CartaDeCorrecao): Promise<GenericObject[]>;
+    NFE_DesconhecimentoDaOperacao(evento: DesconhecimentoDaOperacao): Promise<GenericObject[]>;
+    NFE_DistribuicaoDFe(data: ConsultaNFe): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorUltNSU(data: DFePorUltimoNSU): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorNSU(data: DFePorNSU): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorChave(data: DFePorChaveNFe): Promise<GenericObject>;
+    NFE_Autorizacao(data: NFe): Promise<{
+        NFe: LayoutNFe;
+        protNFe: ProtNFe;
+    }[]>;
+    NFCE_Autorizacao(data: NFe): Promise<{
+        NFe: LayoutNFe;
+        protNFe: ProtNFe;
+    }[]>;
+    NFE_Inutilizacao(data: InutilizacaoData): Promise<any>;
+    NFE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    NFCE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    NFE_EnviaEmail(mailParams: EmailParams): void;
+}

package/dist/cjs/core/interfaces/NFeWizardServiceImpl.d.ts

@@ -0,0 +1,38 @@
+import { Cancelamento, CartaDeCorrecao, CienciaDaOperacao, ConfirmacaoDaOperacao, ConsultaNFe, DesconhecimentoDaOperacao, DFePorChaveNFe, DFePorNSU, DFePorUltimoNSU, EmailParams, EPEC, EventoNFe, GenericObject, InutilizacaoData, LayoutNFe, NFe, NFEGerarDanfeProps, NFeWizardProps, OperacaoNaoRealizada, ProtNFe } from '@Types';
+export interface NFeWizardServiceImpl {
+    NFE_LoadEnvironment({ config }: {
+        config: NFeWizardProps;
+    }): Promise<void>;
+    NFE_ConsultaStatusServico(): Promise<any>;
+    NFE_ConsultaProtocolo(chave: string): Promise<any>;
+    NFE_RecepcaoEvento(evento: EventoNFe): Promise<GenericObject[]>;
+    NFE_EventoPrevioDeEmissaoEmContingencia(evento: EPEC): Promise<GenericObject[]>;
+    NFE_Cancelamento(evento: Cancelamento): Promise<GenericObject[]>;
+    NFE_CienciaDaOperacao(evento: CienciaDaOperacao): Promise<GenericObject[]>;
+    NFE_ConfirmacaoDaOperacao(evento: ConfirmacaoDaOperacao): Promise<GenericObject[]>;
+    NFE_OperacaoNaoRealizada(evento: OperacaoNaoRealizada): Promise<GenericObject[]>;
+    NFE_CartaDeCorrecao(evento: CartaDeCorrecao): Promise<GenericObject[]>;
+    NFE_DesconhecimentoDaOperacao(evento: DesconhecimentoDaOperacao): Promise<GenericObject[]>;
+    NFE_DistribuicaoDFe(data: ConsultaNFe): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorUltNSU(data: DFePorUltimoNSU): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorNSU(data: DFePorNSU): Promise<GenericObject>;
+    NFE_DistribuicaoDFePorChave(data: DFePorChaveNFe): Promise<GenericObject>;
+    NFE_Autorizacao(data: NFe): Promise<{
+        NFe: LayoutNFe;
+        protNFe: ProtNFe;
+    }[]>;
+    NFCE_Autorizacao(data: NFe): Promise<{
+        NFe: LayoutNFe;
+        protNFe: ProtNFe;
+    }[]>;
+    NFE_Inutilizacao(data: InutilizacaoData): Promise<any>;
+    NFE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    NFCE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    NFE_EnviaEmail(mailParams: EmailParams): void;
+}

package/dist/cjs/core/interfaces/SaveFilesImpl.d.ts

@@ -0,0 +1,5 @@
+import { GenericObject } from '@Types/Utils';
+import { AxiosResponse } from 'axios';
+export interface SaveFilesImpl {
+    salvaArquivos(xmlConsulta: string, responseInJson: GenericObject, xmlRetorno: AxiosResponse<any, any>, metodo: string, options?: Record<string, any>): void;
+}

package/dist/cjs/core/interfaces/index.d.ts

@@ -0,0 +1,14 @@
+export * from './NFeWizardImpl';
+export * from './NFEAutorizacaoServiceImpl';
+export * from './SaveFilesImpl';
+export * from './GerarConsultaImpl';
+export * from './NFEStatusServicoServiceImpl';
+export * from './NFeWizardServiceImpl';
+export * from './NFEconsultaProtocoloServiceImpl';
+export * from './NFERecepcaoEventoServiceImpl';
+export * from './HttpClient';
+export * from './NFEDistribuicaoDFeServiceImpl';
+export * from './NFEInutilizacaoServiceImpl';
+export * from './NFERetornoAutorizacaoServiceImpl';
+export * from './NFCEAutorizacaoServiceImpl';
+export * from './NFCERetornoAutorizacaoServiceImpl';

package/dist/cjs/core/types/LoadCertificate.d.ts

@@ -0,0 +1,11 @@
+import https from 'https';
+export type CertificateLoadResult = {
+    success: boolean;
+    agent: https.Agent;
+    message: string;
+};
+export type CertificateLoadReturn = {
+    certificate: string;
+    cert_key: string;
+    agent: https.Agent;
+};

package/dist/cjs/{protocols/Classes/NFEDanfeGenerator/index.d.ts → core/types/NFEDanfeGenerator.d.ts}

@@ -1,4 +1,4 @@
-import { LayoutNFe, ProtNFe } from '../../';
+import { LayoutNFe, ProtNFe } from './NFEAutorizacao';
 export type NFEGerarDanfeProps = {
     /**
      * @param {NFe} data - Dados da NFe

package/dist/cjs/core/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './EmailConfig';
+export * from './NFEAutorizacao';
+export * from './NFEDanfeGenerator';
+export * from './NFEDistribuicaoDFe';
+export * from './NFEInutilizacao';
+export * from './NFERecepcaoEvento';
+export * from './NFeWizard';
+export * from './Utils';
+export * from './LoadCertificate';

package/dist/cjs/{utils → core/utils}/NFEImposto.d.ts

@@ -1,4 +1,4 @@
-import { COFINS, ICMS, PIS, dadosCOFINS, dadosICMS, dadosPIS } from '@Protocols';
+import { COFINS, ICMS, PIS, dadosCOFINS, dadosICMS, dadosPIS } from 'src/core/types';
 export declare const mountCOFINS: (cofins: dadosCOFINS) => COFINS;
 export declare const mountPIS: (pis: dadosPIS) => PIS;
 export declare const mountICMS: (icms: dadosICMS) => ICMS;

package/dist/cjs/{utils → core/utils}/Utility.d.ts

@@ -1,9 +1,9 @@
-import Environment from '@Classes/Environment';
-import { NFeWizardProps, GenericObject, SaveXMLProps, SaveJSONProps, ProtNFe } from '@Protocols';
-import { Json } from './xml2json';
+import Environment from '@Modules/environment/Environment.js';
+import { NFeWizardProps, GenericObject, SaveXMLProps, SaveJSONProps, ProtNFe } from 'src/core/types';
+import XmlParser from './XmlParser';
 declare class Utility {
     environment: Environment;
-    json: Json;
+    xmlParser: XmlParser;
     constructor(environment: Environment);
     /**
      * Método utilitário para criar diretórios

package/dist/cjs/{utils/xml2json.d.ts → core/utils/XmlParser.d.ts}

@@ -1,5 +1,5 @@
-import { GenericObject } from '@Protocols';
-export declare class Json {
+import { GenericObject } from 'src/core/types';
+export default class XmlParser {
     constructor();
     findInObj: (obj: GenericObject, chave: string) => any;
     removeJsonTextAttribute(value: string, parentElement: any): void;

package/dist/cjs/core/utils/getDesTipoPag.d.ts

@@ -0,0 +1 @@
+export declare const getDesTipoPag: (tPag: string) => string;