etiquetas.js 1.0.0-alpha.1 → 1.0.0-alpha.3

package/README.git.md

@@ -1,486 +1,121 @@
-# 🏷️ Sistema de Etiquetas - Etiquetas.js
-
-Sistema completo para geração de etiquetas de peças, tamponamentos, insumos, retalhos e volumes com suporte a impressão e download de PDFs.
-
-## 📋 Índice
-
-- [Instalação](#instalação)
-- [Configuração Inicial](#configuração-inicial)
-- [API Principal](#api-principal)
-- [Tipos de Etiquetas](#tipos-de-etiquetas)
-- [Exemplos de Uso](#exemplos-de-uso)
-- [Templates](#templates)
-- [Testes](#testes)
-- [Estrutura do Projeto](#estrutura-do-projeto)
-- [Sistema Legacy](#sistema-legacy)
-
-## 🚀 Instalação
-
-```bash
-npm install etiquetas-js
-```
-
-## ⚙️ Configuração Inicial
-
-```javascript
-import etiquetas from 'etiquetas-js';
-
-// Inicializar o sistema
-etiquetas.init({
-  printerName: 'Zebra ZT230',
-  paperSize: 'A4',
-  orientation: 'portrait',
-  defaultTemplate: 'template-padrao'
-});
-```
-
-## 📚 API Principal
-
-### Inicialização e Configuração
-
-```javascript
-// Inicializar sistema
-etiquetas.init(config);
-
-// Configurar impressora
-etiquetas.configurePrinter({
-  printerName: 'HP LaserJet Pro',
-  paperSize: 'A4',
-  orientation: 'landscape'
-});
-
-// Verificar status da impressora
-const status = await etiquetas.getPrinterStatus();
-```
-
-### Geração de Etiquetas
-
-```javascript
-// Gerar etiqueta de peça
-const pdfPeca = await etiquetas.makePartLabel(dadosPeca, 'template-peca-padrao');
-
-// Gerar etiqueta de tamponamento
-const pdfTamp = await etiquetas.makeTamponamentoLabel(dadosTamp, 'template-tamponamento-padrao');
-
-// Gerar etiqueta de insumo
-const pdfInsumo = await etiquetas.makeInsumoLabel(dadosInsumo, 'template-insumo-padrao');
-
-// Gerar etiqueta de retalho
-const pdfRetalho = await etiquetas.makeRetalhoLabel(dadosRetalho, 'template-retalho-padrao');
-
-// Gerar etiqueta de volume
-const pdfVolume = await etiquetas.makeVolumeLabel(dadosVolume, 'template-volume-padrao');
-```
-
-### Saída e Impressão
-
-```javascript
-// Download de PDF
-await etiquetas.downloadPDF(pdfBuffer, 'etiqueta.pdf');
-
-// Enviar para impressora
-await etiquetas.sendToPrinter(pdfBuffer);
-
-// Envio inteligente (imprime se conectado, senão faz download)
-await etiquetas.sendPartLabel(dadosPeca, 'template-peca-padrao');
-await etiquetas.sendTamponamentoLabel(dadosTamp, 'template-tamponamento-padrao');
-await etiquetas.sendInsumoLabel(dadosInsumo, 'template-insumo-padrao');
-await etiquetas.sendRetalhoLabel(dadosRetalho, 'template-retalho-padrao');
-await etiquetas.sendVolumeLabel(dadosVolume, 'template-volume-padrao');
-```
-
-### Geração em Lote
-
-```javascript
-// Gerar múltiplas etiquetas
-const pdfs = await etiquetas.makeBatchLabels(
-  [peca1, peca2, peca3], 
-  'template-peca-padrao', 
-  'parts'
-);
-```
-
-## 🏷️ Tipos de Etiquetas
-
-### 1. Etiquetas de Peças (`parts`)
-
-```javascript
-const dadosPeca = {
-  id: "P001",
-  codigo: "PID123",
-  nome: "Lateral Esquerda",
-  tipo: "cabinet",
-  largura: 600,
-  altura: 800,
-  espessura: 15,
-  material: {
-    nome: "MDF Branco",
-    altura: 2750,
-    largura: 1830
-  },
-  bordas: {
-    esquerda: "Branco 0.4",
-    direita: "Branco 0.4",
-    superior: "Branco 0.4",
-    inferior: "Sem borda"
-  },
-  furacao: {
-    codigoA: "A001",
-    codigoB: "B002",
-    ladoUsinagem: "face"
-  },
-  projeto: {
-    id: "PROJ001",
-    nome: "Cozinha Moderna",
-    cliente: "João Silva"
-  }
-};
-```
-
-### 2. Etiquetas de Tamponamentos (`woodwork`)
-
-```javascript
-const dadosTamponamento = {
-  id: "TAMP-001",
-  name: "Tamponamento Lateral",
-  ref: "T001",
-  qt: 2,
-  weight: 1.5,
-  material: "MDF 15mm",
-  project_id: "PROJ001",
-  project_description: "Cozinha Moderna",
-  project_customer_name: "João Silva"
-};
-```
-
-### 3. Etiquetas de Insumos (`inputs`)
-
-```javascript
-const dadosInsumo = {
-  id: "INS-001",
-  name: "Parafuso Phillips 4x30",
-  dimensions: "4x30mm",
-  qt: 50,
-  weight: 0.1,
-  ref: "PAR-001",
-  manufacturer: "Fixadores SA",
-  project_id: "PROJ001",
-  project_description: "Cozinha Moderna",
-  project_customer_name: "João Silva"
-};
-```
-
-### 4. Etiquetas de Retalhos (`scraps`)
-
-```javascript
-const dadosRetalho = {
-  scrapId: "RET-001",
-  id: "RET-001",
-  name: "Retalho MDF Branco",
-  ref: "R001",
-  qt: 1,
-  weight: 2.3,
-  date: "2024-01-15T10:30:00Z",
-  material: "MDF Branco 15mm",
-  project_id: "PROJ001",
-  project_description: "Cozinha Moderna",
-  project_customer_name: "João Silva"
-};
-```
-
-### 5. Etiquetas de Volumes (`volumes`)
-
-```javascript
-const dadosVolume = {
-  volume_id: "VOL-001",
-  volume_name: "Volume Cozinha - Módulo 1",
-  volume_weight: 45.8,
-  volume_date: "2024-01-15T10:30:00Z",
-  project_id: "PROJ001",
-  project_description: "Cozinha Moderna",
-  project_customer_name: "João Silva"
-};
-```
-
-## 🎨 Templates
-
-### Templates Disponíveis
-
-- **Peças**: `template-peca-padrao`, `template-peca-compacto`
-- **Tamponamentos**: `template-tamponamento-padrao`
-- **Insumos**: `template-insumo-padrao`
-- **Retalhos**: `template-retalho-padrao`
-- **Volumes**: `template-volume-padrao`
-
-### Variáveis de Template
-
-O sistema suporta 44+ variáveis organizadas por categoria:
-
-#### Projeto (5 variáveis)
-- `{{PROJETO_ID}}`, `{{PROJETO_NOME}}`, `{{PROJETO_OBS}}`
-- `{{CLIENTE_ID}}`, `{{CLIENTE_NOME}}`
-
-#### Peça (7 variáveis)
-- `{{PECA_ID}}`, `{{PECA_CODIGO}}`, `{{PECA_NOME}}`, `{{PECA_TIPO}}`
-- `{{LARGURA}}`, `{{ALTURA}}`, `{{ESPESSURA}}`
-
-#### Material (3 variáveis)
-- `{{MN}}` (Nome), `{{MA}}` (Altura), `{{ML}}` (Largura)
-
-#### Bordas (4 variáveis)
-- `{{FE}}` (Esquerda), `{{FD}}` (Direita), `{{FS}}` (Superior), `{{FI}}` (Inferior)
-
-#### Furação (3 variáveis)
-- `{{FURO_A}}`, `{{FURO_B}}`, `{{LADO_USINAGEM}}`
-
-#### Volume (4 variáveis)
-- `{{VOLUME_ID}}`, `{{VOLUME_NOME}}`, `{{VOLUME_PESO}}`, `{{VOLUME_DATA}}`
-
-#### Insumo (7 variáveis)
-- `{{INSUMO_NOME}}`, `{{INSUMO_ID}}`, `{{INSUMO_DIMENSOES}}`
-- `{{INSUMO_QTD}}`, `{{INSUMO_PESO}}`, `{{INSUMO_REF}}`, `{{INSUMO_MARCA}}`
-
-#### Tamponamento (5 variáveis)
-- `{{TAMPONAMENTO_ID}}`, `{{TAMPONAMENTO_REF}}`, `{{TAMPONAMENTO_QT}}`
-- `{{TAMPONAMENTO_PESO}}`, `{{TAMPONAMENTO_NOME}}`
-
-#### Retalho (3 variáveis)
-- `{{RETALHO_ID}}`, `{{DATA_CRIACAO}}`, `{{RETALHO_INDICE}}`
-
-## 🧪 Testes
-
-Execute os testes do sistema:
-
-```bash
-# Executar testes completos
-node mock/testes.js
-
-# Teste rápido - apenas geração de todos os tipos
-node mock/executar-teste-completo.js
-
-# Teste específico de todos os tipos
-node mock/teste-todos-tipos.js
-
-# Teste otimizado (recomendado para evitar problemas de memória)
-node mock/executar-teste-otimizado.js
-
-# Ou importar funções específicas
-import { executarTodosTestes, gerarEtiquetasDeTodosOsTipos } from './mock/testes.js';
-import { gerarEtiquetasOtimizado } from './mock/teste-todos-tipos-otimizado.js';
-
-await executarTodosTestes();
-await gerarEtiquetasDeTodosOsTipos();
-await gerarEtiquetasOtimizado(); // Versão otimizada
-```
-
-### Testes Incluídos
-
-- ✅ Status da Impressora
-- ✅ Configuração de Impressora  
-- ✅ Geração de Etiquetas (todos os 5 tipos)
-- ✅ Download de PDF
-- ✅ Envio Inteligente
-- ✅ Geração em Lote
-- 🆕 **Teste Completo - Todos os Tipos** (novo!)
-
-### Novo Teste: Todos os Tipos de Etiquetas
-
-O novo teste `gerarEtiquetasDeTodosOsTipos()` gera uma etiqueta de cada tipo disponível:
-
-```javascript
-import { gerarEtiquetasDeTodosOsTipos } from './mock/teste-todos-tipos.js';
-
-const resultados = await gerarEtiquetasDeTodosOsTipos();
-console.log(`Sucessos: ${resultados.sucessos}/5`);
-```
-
-### 🚀 Teste Otimizado (Recomendado)
-
-Para evitar problemas de memória e heap overflow, use a versão otimizada:
-
-```bash
-# Execução rápida
-node mock/executar-teste-otimizado.js
-
-# Com mais memória (se necessário)
-node --max-old-space-size=4096 mock/executar-teste-otimizado.js
-
-# Com garbage collection
-node --expose-gc mock/executar-teste-otimizado.js
-```
-
-**Melhorias da versão otimizada:**
-- ⚡ Timeouts para evitar travamentos
-- 🧹 Limpeza automática de memória
-- 🔄 Processamento sequencial com pausas
-- 📊 Dados simplificados para melhor performance
-- ❌ Tratamento robusto de erros
-
-**Tipos testados:**
-- 📋 Etiqueta de Peça
-- 🔧 Etiqueta de Tamponamento  
-- 🔩 Etiqueta de Insumo
-- ♻️ Etiqueta de Retalho
-- 📦 Etiqueta de Volume
-
-**Recursos do teste:**
-- ⏱️ Medição de tempo de geração
-- 📊 Relatório detalhado de resultados
-- 💾 Salvamento automático dos PDFs em `mock/output/`
-- 📈 Estatísticas de performance
-
-## 📁 Estrutura do Projeto
-
-```
-etiquetas.js/
-├── src/
-│   ├── etiquetas.js          # API principal reorganizada
-│   ├── index.js              # Exportações principais
-│   ├── constants.js          # Constantes e configurações
-│   ├── templates.js          # Templates de etiquetas
-│   ├── types.ts              # Definições TypeScript
-│   ├── formatData.js         # Formatação de dados
-│   ├── labelWorker.js        # Worker para geração
-│   └── createLabel.jsx       # Geração de PDFs
-├── mock/
-│   ├── testes.js             # Testes completos
-│   └── exemplo de dados...   # Dados de exemplo
-└── GITHUB_ISSUE.md           # Documentação técnica
-```
-
-## 🔧 Configurações Avançadas
-
-### Configuração Personalizada
-
-```javascript
-etiquetas.init({
-  printerName: 'Zebra ZT230',
-  paperSize: 'A4',
-  orientation: 'portrait',
-  defaultTemplate: 'template-personalizado',
-  autoDownloadOnPrinterError: true,
-  maxBatchSize: 100,
-  cacheEnabled: true,
-  debugMode: false
-});
-```
-
-### Tratamento de Erros
-
-```javascript
-try {
-  const pdf = await etiquetas.makePartLabel(dados, template);
-  await etiquetas.sendToPrinter(pdf);
-} catch (error) {
-  console.error('Erro:', error.message);
-  // Fallback para download
-  await etiquetas.downloadPDF(pdf, 'etiqueta-backup.pdf');
-}
-```
-
-## 📊 Status e Monitoramento
-
-```javascript
-// Verificar status completo
-const status = await etiquetas.getPrinterStatus();
-console.log('Impressora:', status.connected ? 'Conectada' : 'Desconectada');
-console.log('Nome:', status.printerName);
-console.log('Papel:', status.paperSize);
-```
-
----
-
-## 🔄 Sistema Legacy
-
-### Label Viewer Without UI (Sistema Anterior)
-
-Este projeto evoluiu de um fork do `labelViewer` que removia componentes de UI. O sistema legacy ainda está disponível para compatibilidade:
-
-#### Exemplo básico com hook e worker (Legacy)
-
-```javascript
-import { useLabelData, createLabelWorker } from './src';
-
-function MyComponent() {
-  const { getLabelData, config, userPrefs } = useLabelData();
-  
-  const generateLabels = async () => {
-    const labelData = getLabelData('parts');
-    const worker = createLabelWorker();
-    
-    const params = {
-      dataSource: labelData.data,
-      labels: labelData.label,
-      userPrefs: labelData.userPrefs,
-      cacheKey: labelData.cacheKey,
-    };
-    
-    try {
-      const result = await worker.generateLabels(params, (progress) => {
-        console.log(`Progresso: ${progress.percentage}%`);
-      });
-      
-      console.log('Labels gerados:', result);
-    } catch (error) {
-      console.error('Erro ao gerar labels:', error);
-    }
-  };
-  
-  return (
-    <button onClick={generateLabels}>
-      Gerar Labels
-    </button>
-  );
-}
-```
-
-#### Usando o store (Legacy)
-
-```javascript
-import { useLabelStore } from './src';
-
-function MyComponent() {
-  const { 
-    pdfInstance, 
-    isGenerating, 
-    progress, 
-    setPDFInstance, 
-    setGenerating 
-  } = useLabelStore();
-  
-  // Use o store para gerenciar estado...
-}
-```
-
-### Migração do Sistema Legacy
-
-Para migrar do sistema legacy para a nova API:
-
-```javascript
-// Antes (Legacy)
-import { useLabelData, createLabelWorker } from './src';
-const labelData = getLabelData('parts');
-const worker = createLabelWorker();
-const result = await worker.generateLabels(params);
-
-// Depois (Nova API)
-import etiquetas from './src/etiquetas.js';
-etiquetas.init(config);
-const pdf = await etiquetas.makePartLabel(dadosPeca, template);
-```
-
-## 🤝 Contribuição
-
-1. Fork o projeto
-2. Crie uma branch para sua feature (`git checkout -b feature/nova-feature`)
-3. Commit suas mudanças (`git commit -am 'Adiciona nova feature'`)
-4. Push para a branch (`git push origin feature/nova-feature`)
-5. Abra um Pull Request
-
-## 📄 Licença
-
-Este projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
-
----
-
-**Desenvolvido com ❤️ para facilitar a geração de etiquetas industriais**
+# 🏷️ Sistema de Etiquetas - Etiquetas.js
+
+Sistema completo para geração de etiquetas de peças, tamponamentos, insumos, retalhos e volumes com suporte a impressão e download de PDFs.
+
+
+
+## 🚀 Instalação
+
+```bash
+npm install etiquetas-js
+```
+
+## ⚙️ Configuração Inicial
+
+```javascript
+import etiquetas from 'etiquetas-js';
+
+// Inicializar o sistema
+etiquetas.init({
+  token: '<jwt-token>'
+});
+```
+
+## 📚 API Principal
+    <jwt-token> é utilizado como authorization na api dinabox para obter os templates de etiqueta
+### Inicialização e Configuração
+
+```javascript
+// Inicializar sistema
+etiquetas.init(config);
+
+
+// Verificar status da impressora
+const status = await etiquetas.getPrinterStatus();
+```
+
+### Geração de Etiquetas
+
+const labelData = [{variableProps: {
+
+
+```javascript
+// Gerar etiqueta de peça
+  <all-variables>
+}, specialProps: {
+  <all-specialprops>
+}}] 
+O tamanho do array de labelData é a quantidade de etiquetas que serão geradas. Os dados   <all-variables> e <all-specialprops>
+
+const pdfPeca = await etiquetas.makeLabel({variableProps: {
+  PROJETO_ID:123
+
+},specialProps: {
+  lamination: {
+    
+    material_id:"123",
+    edges: {
+      left_id:"123",
+      right_id:null,
+      bottom_id:"123",
+      top_id:"245"
+    }
+    
+  },
+  
+  }
+}}, <label-id>);
+```
+
+### Saída e Impressão
+
+
+
+```javascript
+// Download de PDF
+await etiquetas.downloadPDF(pdfBuffer, 'etiqueta.pdf');
+
+// Enviar para impressora
+await etiquetas.sendToPrinter(pdfBuffer);
+
+// Envio inteligente (imprime se conectado, senão faz download)
+await etiquetas.sendLabel(labelData, <label-id>);
+
+```
+
+## 🎨 Templates
+
+### Templates Disponíveis
+Utilizando a API das labels busque o ID do template
+
+Cada arquivo contém a definição de variáveis e propriedades especiais que podem ser usadas na geração das etiquetas correspondentes.
+
+## 📑 Variáveis e SpecialProps dos Templates
+
+Abaixo estão listadas todas as variáveis (`variableProps`) e propriedades especiais (`specialProps`) disponíveis para uso em qualquer template de etiqueta. Use-as conforme o tipo de etiqueta desejado.
+
+### Lista universal de variableProps
+
+- {{PROJETO_NOME}}, {{PROJETO_ID}}, {{LOTE_ID}}, {{CLIENTE_NOME}}, {{MODULO_NOME}}, {{MODULO_QTD}}, {{MODULO_REF}}, {{MODULO_OBS}}, {{PECA_ID}}, {{PECA_CODIGO}}, {{PECA_REF}}, {{PECA_INDICE}}, {{PECA_INDICE2}}, {{PECA_NOME}}, {{PECA_OBS}}, {{LARGURA}}, {{ALTURA}}, {{ESPESSURA}}, {{MN}}, {{MA}}, {{ML}}, {{FURO_A}}, {{FURO_A2}}, {{FURO_B}}, {{FURO_B2}}, {{FE}}, {{FD}}, {{FS}}, {{FI}}, {{PECA_TIPO}}, {{MATERIAL_NOME}}, {{TAMPONAMENTO_ID}}, {{TAMPONAMENTO_REF}}, {{TAMPONAMENTO_QT}}, {{TAMPONAMENTO_PESO}}, {{TAMPONAMENTO_NOME}}, {{INSUMO_NOME}}, {{INSUMO_ID}}, {{INSUMO_DIMENSOES}}, {{INSUMO_QTD}}, {{INSUMO_PESO}}, {{INSUMO_REF}}, {{INSUMO_MARCA}}, {{INSUMO_CATEGORIA}}, {{INSUMO_FABRICANTE}}, {{RETALHO_ID}}, {{DATA_CRIACAO}}, {{RETALHO_INDICE}}, {{LADO_USINAGEM}}, {{RETALHO_NOME}}, {{RETALHO_QT}}, {{RETALHO_PESO}}, {{RETALHO_DIMENSOES}}, {{RETALHO_MATERIAL}}, {{RETALHO_ORIGEM}}, {{CODIGO_A}}, {{CODIGO_B}}, {{FURO_A_SD}}, {{FURO_B_SD}}, {{FURO_TOPO}}, {{VOLUME_ID}}, {{VOLUME_NOME}}, {{VOLUME_PESO}}, {{VOLUME_DATA}}, {{VOLUME_DESCRICAO}}, {{VOLUME_PECAS}}, {{VOLUME_DIMENSOES}}
+
+> **Observação:** Você pode usar qualquer combinação dessas variáveis em qualquer template, desde que o template utilize o campo correspondente.
+
+---
+
+### Lista universal de specialProps
+
+- **rect**: Retângulo. Dados necessários: já vem no template.
+- **lamination**: Desenha bordas de laminação conforme materiais. Dados necessários: informações de borda e material (edge_left_id, material_id, etc).
+- **enhancedLamination**: Laminação detalhada, com indicação visual de materiais e furos. Dados necessários: dados de peça, bordas e furos (holes_diagram, width, height, etc).
+- **identifierByProject**: Gera um identificador visual (preto e branco) para o projeto. Dados necessários: project_id, numberByProject.
+- **colorfulIdentifierByProject**: Igual ao anterior, mas colorido. Dados necessários: project_id, numberByProject, color.
+- **barCode**: Gera um código de barras. Dados necessários: código a ser convertido (originBarcode, customBarcode, code_a, code_b, etc).
+- **miniSheet**: Miniatura da chapa. Dados necessários: lista de partes (parts), dimensões da chapa (height, width).
+- **miniPartA**: Miniatura da peça (lado A). Dados necessários: dados da peça (width, height, index).
+- **miniPartB**: Miniatura da peça (lado B). Dados necessários: dados da peça (width, height, index).
+- **Image**: Imagem. Dados necessários: já vem no template.
+- **text**: Texto estático. Dados necessários: já vem no template.
+- **volumeContent**: Gera uma tabela de itens do volume. Dados necessários: itemList (array de itens do volume).
+
+> **Observação:** Você pode usar qualquer combinação dessas specialProps em qualquer template, desde que o template utilize o campo correspondente.
+