nfewizard-io 0.2.9 → 0.3.1

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/adapters/MailAdapter.d.ts

@@ -0,0 +1,10 @@
+import Environment from '@Modules/environment/Environment.js';
+import { EmailParams } from 'src/core/types';
+declare class MailController {
+    private environment;
+    constructor(environment: Environment);
+    private createTransporter;
+    private mountMail;
+    sendEmail(mailParams: EmailParams): void;
+}
+export default MailController;

package/dist/cjs/adapters/NFeWizard.d.ts

@@ -0,0 +1,66 @@
+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;
+    }): Promise<void>;
+    /**
+     * Status Serviço
+     */
+    NFE_ConsultaStatusServico(): Promise<any>;
+    /**
+     * Consulta Protocolo
+     */
+    NFE_ConsultaProtocolo(chave: string): Promise<any>;
+    /**
+     * Recepção de Eventos
+     */
+    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("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("src/core/types").LayoutNFe;
+        protNFe: import("src/core/types").ProtNFe;
+    }[]>;
+    NFCE_Autorizacao(data: NFe): Promise<{
+        NFe: import("src/core/types").LayoutNFe;
+        protNFe: import("src/core/types").ProtNFe;
+    }[]>;
+    /**
+     * Inutilização
+     */
+    NFE_Inutilizacao(data: InutilizacaoData): Promise<any>;
+    /**
+     * DANFE
+     */
+    NFE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    NFCE_GerarDanfe(data: NFEGerarDanfeProps): Promise<{
+        message: string;
+        success: boolean;
+    }>;
+    /**
+     * Método para envio de e-mail
+     * @param {EmailParams} mailParams - Mensagem de texto (aceita html)
+     */
+    NFE_EnviaEmail(mailParams: EmailParams): void;
+}

package/dist/cjs/adapters/SchemaLoader.d.ts

@@ -0,0 +1,4 @@
+export declare const getSchema: (metodo: string) => {
+    basePath: string;
+    schemaPath: string;
+};

package/dist/cjs/adapters/XmlBuilder.d.ts

@@ -0,0 +1,31 @@
+import Environment from '@Modules/environment/Environment.js';
+export interface NamespacesProps {
+    [key: string]: string;
+}
+export interface BodyContentProps {
+    [key: string]: any;
+}
+export interface SoapEnvelopeObjProps {
+    [key: string]: any;
+}
+declare class XmlBuilder {
+    environment: Environment;
+    constructor(environment: Environment);
+    /**
+     * Método para assinar o XML
+     */
+    assinarXML(xml: string, tagAssinar: string): string;
+    /**
+     * Método que converte Objeto em XML
+     */
+    serializeXml<T>(obj: T, rootTag: string): string;
+    /**
+     * Método genérico para geração do XML
+     */
+    gerarXml<T>(xmlObject: T, rootTag: string): string;
+    /**
+     *  Método utilizado para cirar um envelop SOAP - Formato de mensagem para serviço SOAP (como o da SEFAZ)
+     */
+    buildSoapEnvelope(xml: string, soapMethod: string, soapVersion?: string, rootTagObj?: any): string;
+}
+export default XmlBuilder;

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/EmailConfig.d.ts

@@ -0,0 +1,65 @@
+export type EmailConfig = {
+    /**
+     * @param {string} host - Host SMTP do seu provedor de e-mail
+     */
+    host: string;
+    /**
+     * @param {number} port - Porta do servidor SMTP
+     */
+    port: number;
+    /**
+     * @param {boolean} secure - true para SSL, false para outros
+     */
+    secure: boolean;
+    /**
+     * @param auth - Dados para autenticação no servidor SMTP
+     */
+    auth: {
+        /**
+         * @param {string} user - Seu e-mail para autenticação no servidor SMTP
+         */
+        user: string;
+        /**
+         * @param {string} pass -  Sua senha para autenticação no servidor SMTP
+         */
+        pass: string;
+    };
+    /**
+     * @param emailParams -  Dados para enviao do e-mail
+     */
+    emailParams: {
+        /**
+         * @param {string} from -  Remetente padrão
+         */
+        from: string;
+        /**
+         * @param {string} to -  Destinatário padrão
+         */
+        to: string;
+    };
+};
+interface Attachment {
+    /**
+     * @param {string | false} filename -  Nome do arquivo à anexar (Ex: danfe.pdf)
+     */
+    filename?: string | false;
+    /**
+     * @param {string} path -  Caminho completo para o arquivo (Ex: ./src/assets/danfe.pdf)
+     */
+    path: string;
+}
+export type EmailParams = {
+    /**
+     * @param message -  Mensagem de texto (aceita html)
+     */
+    message: string;
+    /**
+     * @param {string} subject -  Assunto do email
+     */
+    subject: string;
+    /**
+     * @param {Attachment[] | undefined} attachments -  Anexos do email
+     */
+    attachments?: Attachment[];
+};
+export {};

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;
+};