@treeunfe/types 1.0.4 → 1.0.5

package/.turbo/turbo-build.log

@@ -1,71 +1,71 @@
 
-> @treeunfe/types@1.0.3 build /home/runner/work/treeunfe-dfe/treeunfe-dfe/packages/types
+> @treeunfe/types@1.0.4 build /home/runner/work/treeunfe-dfe/treeunfe-dfe/packages/types
 > rollup -c
 
-(node:3507) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/treeunfe-dfe/treeunfe-dfe/packages/types/rollup.config.js is not specified and it doesn't parse as CommonJS.
+(node:3512) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/treeunfe-dfe/treeunfe-dfe/packages/types/rollup.config.js is not specified and it doesn't parse as CommonJS.
 Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
 To eliminate this warning, add "type": "module" to /home/runner/work/treeunfe-dfe/treeunfe-dfe/packages/types/package.json.
 (Use `node --trace-warnings ...` to show where the warning was created)
 
 src/index.ts → dist/index.cjs...
 (!) [plugin typescript] @rollup/plugin-typescript: outputToFilesystem option is defaulting to true.
-created dist/index.cjs in 1.9s
+created dist/index.cjs in 1.8s
 
 src/index.ts → dist/index.mjs...
-created dist/index.mjs in 936ms
+created dist/index.mjs in 900ms
 
 src/common/index.ts → dist/common/index.cjs...
 (!) Generated an empty chunk
 "index"
-created dist/common/index.cjs in 654ms
+created dist/common/index.cjs in 594ms
 
 src/common/index.ts → dist/common/index.mjs...
 (!) Generated an empty chunk
 "index"
-created dist/common/index.mjs in 605ms
+created dist/common/index.mjs in 564ms
 
 src/cte/index.ts → dist/cte/index.cjs...
 (!) Generated an empty chunk
 "index"
-created dist/cte/index.cjs in 699ms
+created dist/cte/index.cjs in 649ms
 
 src/cte/index.ts → dist/cte/index.mjs...
 (!) Generated an empty chunk
 "index"
-created dist/cte/index.mjs in 585ms
+created dist/cte/index.mjs in 577ms
 
 src/nfce/index.ts → dist/nfce/index.cjs...
 (!) Generated an empty chunk
 "index"
-created dist/nfce/index.cjs in 534ms
+created dist/nfce/index.cjs in 502ms
 
 src/nfce/index.ts → dist/nfce/index.mjs...
 (!) Generated an empty chunk
 "index"
-created dist/nfce/index.mjs in 590ms
+created dist/nfce/index.mjs in 551ms
 
 src/nfe/index.ts → dist/nfe/index.cjs...
 (!) Generated an empty chunk
 "index"
-created dist/nfe/index.cjs in 556ms
+created dist/nfe/index.cjs in 521ms
 
 src/nfe/index.ts → dist/nfe/index.mjs...
 (!) Generated an empty chunk
 "index"
-created dist/nfe/index.mjs in 555ms
+created dist/nfe/index.mjs in 506ms
 
 src/nfse/index.ts → dist/nfse/index.cjs...
-created dist/nfse/index.cjs in 642ms
+created dist/nfse/index.cjs in 606ms
 
 src/nfse/index.ts → dist/nfse/index.mjs...
-created dist/nfse/index.mjs in 534ms
+created dist/nfse/index.mjs in 495ms
 
 src/interfaces/index.ts → dist/interfaces/index.cjs...
 (!) Generated an empty chunk
 "index"
-created dist/interfaces/index.cjs in 504ms
+created dist/interfaces/index.cjs in 477ms
 
 src/interfaces/index.ts → dist/interfaces/index.mjs...
 (!) Generated an empty chunk
 "index"
-created dist/interfaces/index.mjs in 489ms
+created dist/interfaces/index.mjs in 448ms

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @treeunfe/types
 
+## 1.0.5
+
+### Patch Changes
+
+- Release patch version
+
 ## 1.0.4
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,255 @@
+# Treeunfe DFe 🪄
+
+> Biblioteca Node.js open source para integração com webservices da SEFAZ, desenvolvida e mantida pela **Treeunfe**.
+
+[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.pt-br.html)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-16%2B-green.svg)](https://nodejs.org/)
+
+## 📖 Sobre
+
+**Treeunfe DFe** é uma biblioteca open source desenvolvida e mantida pela empresa **Treeunfe**, projetada para simplificar a integração com os webservices da SEFAZ. A biblioteca oferece uma solução robusta e modular para automação de processos relacionados a documentos fiscais eletrônicos.
+
+### ✨ Características
+
+- 🚀 **Open Source**: Código aberto e gratuito para uso
+- 🔄 **Atualizações Frequentes**: Mantida ativamente pela Treeunfe com atualizações regulares
+- 📦 **Modular**: Instale apenas os módulos que você precisa
+- 🛠️ **TypeScript**: Totalmente tipado para melhor experiência de desenvolvimento
+- 📚 **Documentação Completa**: Documentação detalhada e exemplos práticos
+
+## 🏢 Sobre a Treeunfe
+
+A **Treeunfe** é uma empresa especializada em soluções fiscais e tributárias. Esta biblioteca é mantida ativamente pela equipe Treeunfe, garantindo atualizações frequentes, correções de bugs e suporte às últimas normas técnicas da SEFAZ.
+
+## 📦 Instalação
+
+A biblioteca é modular, permitindo instalar apenas os módulos necessários:
+
+```bash
+# Instalar módulo NFe
+npm install @treeunfe/nfe @treeunfe/types @treeunfe/shared
+
+# Instalar módulo NFCe
+npm install @treeunfe/nfce @treeunfe/types @treeunfe/shared
+
+# Instalar módulo CTe
+npm install @treeunfe/cte @treeunfe/types @treeunfe/shared
+
+# Instalar módulo NFSe
+npm install @treeunfe/nfse @treeunfe/types @treeunfe/shared
+
+# Instalar módulo DANFE (geração de PDF)
+npm install @treeunfe/danfe
+```
+
+## 🚀 Início Rápido
+
+### Exemplo: NFe
+
+```typescript
+import { NFe, TreeunfeDFeService } from '@treeunfe/nfe';
+import { TreeunfeDFeProps } from '@treeunfe/types';
+import path from 'path';
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+
+// Inicializar serviço
+const treeunfeDFeService = new TreeunfeDFeService();
+const nfeHandler = new NFe(treeunfeDFeService);
+
+// Configurar ambiente
+await nfeHandler.LoadEnvironment({
+  config: {
+    dfe: {
+      baixarXMLDistribuicao: true,
+      pathXMLDistribuicao: "tmp/DistribuicaoDFe/NFe",
+      armazenarXMLAutorizacao: true,
+      pathXMLAutorizacao: "tmp/Autorizacao/NFe",
+      armazenarXMLRetorno: true,
+      pathXMLRetorno: "tmp/RequestLogs/NFe",
+      armazenarXMLConsulta: true,
+      pathXMLConsulta: "tmp/RequestLogs/NFe",
+      
+      pathCertificado: path.resolve(__dirname, "certificado.pfx"),
+      senhaCertificado: "sua_senha_aqui",
+      UF: "SP",
+      CPFCNPJ: "00000000000000",
+    },
+    nfe: {
+      ambiente: 2, // 1 = Produção, 2 = Homologação
+      versaoDF: "4.00",
+      tokenCSC: 'seu_token_csc',
+      idCSRT: '01'
+    },
+    lib: {
+      connection: {
+        timeout: 30000,
+      },
+      log: {
+        exibirLogNoConsole: true,
+        armazenarLogs: true,
+        pathLogs: 'tmp/Logs/NFe'
+      },
+      useOpenSSL: false,
+      useForSchemaValidation: 'validateSchemaJsBased',
+    }
+  } as TreeunfeDFeProps
+});
+
+// Consultar status do serviço
+await nfeHandler.ConsultaStatusServico();
+
+// Consultar protocolo
+await nfeHandler.ConsultaProtocolo('00000000000000000000000000000000000000000000');
+```
+
+### Exemplo: NFSe
+
+```typescript
+import { NFSe } from '@treeunfe/nfse';
+import { TreeunfeDFeService } from '@treeunfe/nfe';
+import { TreeunfeDFeProps } from '@treeunfe/types';
+import path from 'path';
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+
+// Inicializar serviço
+const treeunfeDFeService = new TreeunfeDFeService();
+const nfseHandler = new NFSe(treeunfeDFeService);
+
+// Configurar ambiente
+await nfseHandler.LoadEnvironment({
+  config: {
+    dfe: {
+      baixarXMLDistribuicao: true,
+      pathXMLDistribuicao: "tmp/DistribuicaoDFe/NFSe",
+      armazenarXMLAutorizacao: true,
+      pathXMLAutorizacao: "tmp/Autorizacao/NFSe",
+      armazenarXMLRetorno: true,
+      pathXMLRetorno: "tmp/RequestLogs/NFSe",
+      
+      pathCertificado: path.resolve(__dirname, "certificado.pfx"),
+      senhaCertificado: "sua_senha_aqui",
+      UF: "SP",
+      CPFCNPJ: "00000000000000",
+    },
+    nfse: {
+      ambiente: 2, // 1 = Produção, 2 = Homologação
+      versao: "1.00"
+    },
+    lib: {
+      connection: {
+        timeout: 30000,
+      },
+      log: {
+        exibirLogNoConsole: true,
+        armazenarLogs: true,
+        pathLogs: 'tmp/Logs/NFSe'
+      },
+      useOpenSSL: false,
+      useForSchemaValidation: 'validateSchemaJsBased',
+    }
+  } as TreeunfeDFeProps
+});
+
+// Consultar NFSe por chave
+await nfseHandler.Consulta({
+  chaveAcesso: '00000000000000000000000000000000000000000000'
+});
+```
+
+## 📚 Funcionalidades
+
+### NFe (Nota Fiscal Eletrônica)
+- ✅ Autorização de NFe
+- ✅ Consulta de Protocolo
+- ✅ Consulta de Status do Serviço
+- ✅ Distribuição DFe (por NSU, Último NSU ou Chave)
+- ✅ Inutilização de NFe
+- ✅ Recepção de Eventos (Cancelamento, Carta de Correção, EPEC, etc.)
+- ✅ Geração de DANFE
+
+### NFCe (Nota Fiscal de Consumidor Eletrônica)
+- ✅ Autorização de NFCe
+- ✅ Consulta de Protocolo
+- ✅ Geração de QR Code
+- ✅ Geração de DANFE
+
+### CTe (Conhecimento de Transporte Eletrônico)
+- ✅ Distribuição DFe (por NSU, Último NSU ou Chave)
+- ✅ Download automático de documentos CT-e
+
+### NFSe (Nota Fiscal de Serviços Eletrônica)
+- ✅ Autorização de NFSe
+- ✅ Consulta de NFSe
+- ✅ Consulta de Parâmetros Municipais
+- ✅ Registro de Eventos (Cancelamento, etc.)
+- ✅ Distribuição por NSU
+
+## 📖 Documentação
+
+Para documentação completa, exemplos detalhados e referência da API, acesse:
+
+**🔗 [Documentação Completa](https://nfewizard-org.github.io/)**
+
+## ⚙️ Requisitos
+
+- **Node.js**: Versão 16 ou superior
+- **Certificado**: Certificado A1 (arquivo .pfx)
+- **TypeScript**: Recomendado (mas não obrigatório)
+
+### Validação de Schema
+
+Por padrão, a biblioteca utiliza validação baseada em Java. Para ambientes sem suporte ao JDK (como Vercel, AWS Lambda sem layers), configure:
+
+```typescript
+lib: {
+  useForSchemaValidation: 'validateSchemaJsBased'
+}
+```
+
+## 🤝 Contribuindo
+
+Contribuições são bem-vindas! Este é um projeto open source mantido pela Treeunfe, e sua colaboração é muito apreciada.
+
+### Como Contribuir
+
+1. **Reportar Bugs**: Abra uma issue descrevendo o problema
+2. **Sugerir Funcionalidades**: Compartilhe suas ideias
+3. **Enviar Pull Requests**: Contribua com código, documentação ou melhorias
+4. **Espalhar a Palavra**: Compartilhe o projeto com outros desenvolvedores
+
+### Ao Abrir uma Issue
+
+Por favor, inclua as seguintes informações:
+
+```markdown
+## Parametrização
+- UF: SP
+- Certificado: A1
+- Método: NFE_ConsultaStatusServico
+- Status: ✅ Funcionando / ❌ Com erro
+```
+
+Inclua também os logs gerados no diretório configurado em `pathLogs` (arquivos `app.jsonl`, `error.jsonl` e `http.jsonl`).
+
+## 📝 Licença
+
+Este projeto é licenciado sob a [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.pt-br.html).
+
+## 🏢 Mantido por Treeunfe
+
+Desenvolvido e mantido com ❤️ pela equipe **Treeunfe**.
+
+- 🌐 Website: [Treeunfe](https://treeunfe.com.br)
+- 📧 Suporte: suporte@treeunfe.com.br
+- 💬 Issues: [GitHub Issues](https://github.com/treeunfe/treeunfe-dfe/issues)
+
+## ⭐ Agradecimentos
+
+Agradecemos a todos os contribuidores e usuários que tornam este projeto possível!
+
+---
+
+**Treeunfe DFe** - Simplificando a integração com a SEFAZ 🚀

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@treeunfe/types",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Tipos TypeScript para Treeunfe DFe ecosystem (NFe, NFCe, CTe, NFSe)",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -63,7 +63,6 @@
     "url": "https://github.com/treeunfe/treeunfe-dfe",
     "directory": "packages/types"
   },
-  "readme": "../../README.md",
   "dependencies": {},
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.7",