nfewizard-io 0.3.0 → 0.3.2

package/dist/esm/core/types/NFeWizard.d.ts

@@ -0,0 +1,172 @@
+export type NFeWizardProps = {
+    /**
+    * @param {obj} dfe - Configurações relacionadas aos processos de DFe
+    */
+    dfe: {
+        /**
+         * @param {boolean} baixarXMLDistribuicao - Define se os XMLs retornados pelo método NFeDistribuicaoDFe serão salvos
+         */
+        baixarXMLDistribuicao?: boolean;
+        /**
+         * @param {string} pathXMLDistribuicao - Define onde os XMLs retornados pelo método NFeDistribuicaoDFe serão salvos
+         */
+        pathXMLDistribuicao?: string;
+        /**
+         * @param {boolean} armazenarXMLAutorizacao - Define se o XML gerado na emissão de NFe deve ser salvo
+         */
+        armazenarXMLAutorizacao?: boolean;
+        /**
+         * @param {string} pathXMLAutorizacao - Define onde o XML gerado na emissão de NFe sera salvo
+         */
+        pathXMLAutorizacao?: string;
+        /**
+         * @param {boolean} armazenarXMLConsulta - Define se os XMLs de consulta (gerados pela lib) e Retorno (retornados pela SEFAZ) serão salvos
+         */
+        armazenarXMLConsulta?: boolean;
+        /**
+         * @param {string} pathXMLConsulta - Define onde os XMLs de consulta (gerados pela lib) e os XML de retorno (retornados pela SEFAZ) serão salvos
+         */
+        pathXMLConsulta?: string;
+        /**
+         * @param {boolean} armazenarXMLConsultaComTagSoap - Define se os XMLs de consulta (gerados pela lib) devem ser armazenados com a tag soap
+         */
+        armazenarXMLConsultaComTagSoap?: boolean;
+        /**
+         * @param {boolean} armazenarXMLRetorno - Define se os XMLs de consulta (gerados pela lib) e Retorno (retornados pela SEFAZ) serão salvos
+         */
+        armazenarXMLRetorno?: boolean;
+        /**
+         * @param {string} pathXMLRetorno - Define onde os XMLs de consulta (gerados pela lib) e os XML de retorno (retornados pela SEFAZ) serão salvos
+         */
+        pathXMLRetorno?: string;
+        /**
+         * @param {boolean} armazenarRetornoEmJSON - Define se o retorno da SEFAZ deverá ser salvo em json
+         */
+        armazenarRetornoEmJSON?: boolean;
+        /**
+         * @param {string} pathRetornoEmJSON - Define onde o arquivo JSON gerado a partir do retorno da SEFAZ será salvo
+         */
+        pathRetornoEmJSON?: string;
+        /**
+         * @param {boolean} incluirTimestampNoNomeDosArquivos - Define se deverão ser incluidos data e hora no fim do nome dos arquivos
+         * (Aplicados apenas nos arquivos do XMLRetorno e XMLConsulta)
+         */
+        incluirTimestampNoNomeDosArquivos?: boolean;
+        /**
+         * @param {boolean} exibirMarcaDaguaDanfe - Define se a marca d'água de ver ser exibida ou não na DANFE
+         */
+        exibirMarcaDaguaDanfe?: boolean;
+        /**
+         * @param {string} pathCertificado - Define de onde o certificado digital será importado
+         */
+        pathCertificado: string;
+        /**
+         * @param {string} senhaCertificado - Senha do certificado digital
+         */
+        senhaCertificado: string;
+        /**
+         * @param {string} UF - UF da pessoa vinculada ao certificado digital
+         */
+        UF: string;
+        /**
+         * @param {string} CPFCNPJ - CPF/CNPJ da pessoa vinculada ao certificado digital
+         */
+        CPFCNPJ: string;
+    };
+    /**
+    * @param {obj} nfe - Configurações relacionadas aos processos de NFe e NFCe
+    */
+    nfe: {
+        /**
+         * @param {number} ambiente - Define o ambiente que receberá os XML da NF-e:
+         * 1 = Produção
+         * 2 = Homologação
+         */
+        ambiente: number;
+        /**
+         * @param {string} versaoDF - Versão (testado apenas com 4.00)
+         */
+        versaoDF: string;
+        /**
+         * @param {string} tokenCSC - Código de Segurança do Contribuinte (Utilizado para NFCe)
+         */
+        tokenCSC?: string;
+        /**
+         * @param {number} idCSC - Identificador do Código de Segurança do Contribuinte (Utilizado para NFCe)
+         */
+        idCSC?: number;
+    };
+    /**
+    * @param email -Preencher para casos onde for necessário utilizar envio de e-mail;
+    */
+    email?: {
+        /**
+         * @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;
+        };
+    };
+    /**
+    * @param {obj} lib - Permite customização de alguns parametros de execução da lib
+    */
+    lib?: {
+        /**
+        * @param {obj} connection -  Define opções de conexão aos webservices da SEFAZ
+        */
+        connection?: {
+            /**
+            * @param {obj} timeout -  Define o tempo de espera por um retorno da SEFAZ
+            */
+            timeout?: number;
+        };
+        /**
+        * @param {obj} log -  Define opções de log
+        */
+        log?: {
+            exibirLogNoConsole?: boolean;
+        };
+        /**
+        * @param {boolean} useOpenSSL -  Define se a lib deve utilizar métodos que fazem uso do OpenSSL ou não
+        */
+        useOpenSSL?: boolean;
+        /**
+        * @param {validateSchemaJavaBased | validateSchemaJsBased} useForSchemaValidation - Define se a lib deve utilizar um método de validação de schema
+        * baseado em JAVA ou em JS puro.
+        * Útil para utilização em ambientes sem JAVA (Ex: Lambda)
+        */
+        useForSchemaValidation?: 'validateSchemaJavaBased' | 'validateSchemaJsBased';
+    };
+};

package/dist/esm/core/types/Utils.d.ts

@@ -0,0 +1,29 @@
+export type GenericObject = Record<string, any>;
+export interface SoapMethod {
+    [key: string]: {
+        method: string;
+        action: string;
+    };
+}
+export interface ServicesUrl {
+    [key: string]: {
+        [key: string]: string;
+    };
+}
+export interface NFeServicosUrlType {
+    [estado: string]: {
+        [servico: string]: string;
+    };
+}
+export interface SaveXMLProps {
+    data: any;
+    fileName: string;
+    metodo: string;
+    path: string | undefined;
+}
+export interface SaveJSONProps {
+    data: any;
+    fileName: string;
+    metodo: string;
+    path: string | undefined;
+}

package/dist/esm/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/esm/core/utils/NFEImposto.d.ts

@@ -0,0 +1,4 @@
+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/esm/core/utils/Utility.d.ts

@@ -0,0 +1,68 @@
+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;
+    xmlParser: XmlParser;
+    constructor(environment: Environment);
+    /**
+     * Método utilitário para criar diretórios
+     */
+    createDir(path: string): void;
+    /**
+     * Método utilitário para escrever arquivo
+     */
+    createFile(path: string, fileName: string, file: any, extension: string): void;
+    /**
+     * Função recursiva para encontrar a chave em qualquer nivel do objeto
+     */
+    findInObj: (obj: GenericObject, chave: string) => any;
+    /**
+     * Método responsável por gravar o XML como json
+     */
+    salvaJSON(props: SaveJSONProps): void;
+    /**
+     * Método responsável por gravar os XML recebidos em disco
+     */
+    salvaXMLFromJson(config: NFeWizardProps, xmlInJson: any, fileName?: string, metodo?: string): void;
+    salvaXML(props: SaveXMLProps): void;
+    /**
+     * Recupera url para action e metoodo do SOAP
+     */
+    getSoapInfo1(uf: string, metodo: string): {
+        method: string;
+        action: string;
+    };
+    getSoapInfo(uf: string, method: string): {
+        method: string;
+        action: string;
+    };
+    getLatestURLConsulta(data: Record<string, string>, metodo: string): string | null;
+    /**
+     * Define o ambiente (UF e Produção ou Homologação) para geração das chaves de recuperação da URL do webservice
+     */
+    setAmbiente(metodo: string, ambienteNacional: boolean | undefined, versao: string, mod: string): {
+        chaveMae: string;
+        chaveFilha: string;
+    };
+    /**
+     * Retorna a url correta do webservice
+     */
+    getWebServiceUrl(metodo: string, ambienteNacional?: boolean, versao?: string, mod?: string): string;
+    getUrlNFCe(metodo: string, ambienteNacional?: boolean, versao?: string): string;
+    /**
+     * Função para validar XML com Schema
+     */
+    formatErrorMessage(message: string): string;
+    validateSchemaJsBased(xml: any, metodo: string): Promise<unknown>;
+    validateSchemaJavaBased(xml: any, metodo: string): Promise<unknown>;
+    verificaRejeicao(data: string, metodo: string, name?: string): GenericObject;
+    getProtNFe(xmlRetorno: string): {
+        protNFe: ProtNFe[] | undefined;
+        nRec: string;
+    };
+    private getRequestLogFileName;
+    salvaConsulta(xmlConsulta: string, xmlFormated: string, metodo: string, name?: string): void;
+    salvaRetorno(xmlRetorno: string, responseInJson: GenericObject, metodo: string, name?: string): void;
+}
+export default Utility;

package/dist/esm/core/utils/ValidaCPFCNPJ.d.ts

@@ -0,0 +1,31 @@
+declare class ValidaCPFCNPJ {
+    constructor();
+    /**
+     * Valida o CPF ou CNPJ.
+     * @param cpfCnpj CPF ou CNPJ à validar.
+     * @returns Retorna um objeto com o tipo do documento e um boolean se é um documento válido ou não
+     */
+    validarCpfCnpj(cpfCnpj: string): {
+        documentoValido: boolean;
+        tipoDoDocumento: 'CPF' | 'CNPJ' | 'Desconhecido';
+    };
+    /**
+     * Validoa o CPF
+     * @param cpf
+     * @returns Retorna se o CPF é valido ou não
+     */
+    private documentoValidoateCpf;
+    /**
+     * Validoa o CNPJ
+     * @param CNPJ
+     * @returns Retorna se o CNPJ é valido ou não
+     */
+    private documentoValidoateCnpj;
+    /**
+     * Adiciona máscara ao CPF/CNPJ.
+     * @param cpfCnpj CPF ou CNPJ à adicionar máscara.
+     * @returns Retorna o documento com máscara.
+     */
+    mascaraCnpjCpf(cpfcnpj: string): string;
+}
+export default ValidaCPFCNPJ;

package/dist/esm/core/utils/XmlParser.d.ts

@@ -0,0 +1,18 @@
+import { GenericObject } from 'src/core/types';
+export default class XmlParser {
+    constructor();
+    findInObj: (obj: GenericObject, chave: string) => any;
+    removeJsonTextAttribute(value: string, parentElement: any): void;
+    getStatusServicoBody(jsonData: any): any;
+    getConsultaProtocoloBody(jsonData: any): any;
+    getRecepcaoEventoBody(jsonData: any): any;
+    getDistribuicaoDFe(jsonData: any): any;
+    getDistribuicaoDFeProcBody(jsonData: any): any;
+    getDistribuicaoDFeResBody(jsonData: any): any;
+    getDistribuicaoDFeEventBody(jsonData: any): any;
+    getAutorizacaoEventBody(jsonData: any): any;
+    getAutorizacaoFinalEventBody(jsonData: any): any;
+    getAutorizacaoRetornoEventBody(jsonData: any): any;
+    getInutilizacaoRetornoEventBody(jsonData: any): any;
+    convertXmlToJson(xml: string, metodo: string, nsu?: string): GenericObject;
+}

package/dist/esm/core/utils/getCodIBGE.d.ts

@@ -0,0 +1 @@
+export declare const getCodIBGE: (UF: string) => number;

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

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

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import NFeWizard from './adapters/NFeWizard';
+export { NFeWizard as default };
+export * from './core/types';
+export * from './core/utils/NFEImposto';