etiquetas.js 1.0.0-alpha.7 → 1.0.0-alpha.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "etiquetas.js",
3
- "version": "1.0.0-alpha.7",
3
+ "version": "1.0.0-alpha.9",
4
4
  "type": "module",
5
5
  "main": "dist/etiquetas.umd.js",
6
6
  "module": "dist/etiquetas.es.js",
package/README.git.md DELETED
@@ -1,121 +0,0 @@
1
- # 🏷️ Sistema de Etiquetas - Etiquetas.js
2
-
3
- Sistema completo para geração de etiquetas de peças, tamponamentos, insumos, retalhos e volumes com suporte a impressão e download de PDFs.
4
-
5
-
6
-
7
- ## 🚀 Instalação
8
-
9
- ```bash
10
- npm install etiquetas-js
11
- ```
12
-
13
- ## ⚙️ Configuração Inicial
14
-
15
- ```javascript
16
- import etiquetas from 'etiquetas-js';
17
-
18
- // Inicializar o sistema
19
- etiquetas.init({
20
- token: '<jwt-token>'
21
- });
22
- ```
23
-
24
- ## 📚 API Principal
25
- <jwt-token> é utilizado como authorization na api dinabox para obter os templates de etiqueta
26
- ### Inicialização e Configuração
27
-
28
- ```javascript
29
- // Inicializar sistema
30
- etiquetas.init(config);
31
-
32
-
33
- // Verificar status da impressora
34
- const status = await etiquetas.getPrinterStatus();
35
- ```
36
-
37
- ### Geração de Etiquetas
38
-
39
- const labelData = [{variableProps: {
40
-
41
-
42
- ```javascript
43
- // Gerar etiqueta de peça
44
- <all-variables>
45
- }, specialProps: {
46
- <all-specialprops>
47
- }}]
48
- O tamanho do array de labelData é a quantidade de etiquetas que serão geradas. Os dados <all-variables> e <all-specialprops>
49
-
50
- const pdfPeca = await etiquetas.makeLabel({variableProps: {
51
- PROJETO_ID:123
52
-
53
- },specialProps: {
54
- lamination: {
55
-
56
- material_id:"123",
57
- edges: {
58
- left_id:"123",
59
- right_id:null,
60
- bottom_id:"123",
61
- top_id:"245"
62
- }
63
-
64
- },
65
-
66
- }
67
- }}, <label-id>);
68
- ```
69
-
70
- ### Saída e Impressão
71
-
72
-
73
-
74
- ```javascript
75
- // Download de PDF
76
- await etiquetas.downloadPDF(pdfBuffer, 'etiqueta.pdf');
77
-
78
- // Enviar para impressora
79
- await etiquetas.sendToPrinter(pdfBuffer);
80
-
81
- // Envio inteligente (imprime se conectado, senão faz download)
82
- await etiquetas.sendLabel(labelData, <label-id>);
83
-
84
- ```
85
-
86
- ## 🎨 Templates
87
-
88
- ### Templates Disponíveis
89
- Utilizando a API das labels busque o ID do template
90
-
91
- Cada arquivo contém a definição de variáveis e propriedades especiais que podem ser usadas na geração das etiquetas correspondentes.
92
-
93
- ## 📑 Variáveis e SpecialProps dos Templates
94
-
95
- 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.
96
-
97
- ### Lista universal de variableProps
98
-
99
- - {{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}}
100
-
101
- > **Observação:** Você pode usar qualquer combinação dessas variáveis em qualquer template, desde que o template utilize o campo correspondente.
102
-
103
- ---
104
-
105
- ### Lista universal de specialProps
106
-
107
- - **rect**: Retângulo. Dados necessários: já vem no template.
108
- - **lamination**: Desenha bordas de laminação conforme materiais. Dados necessários: informações de borda e material (edge_left_id, material_id, etc).
109
- - **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).
110
- - **identifierByProject**: Gera um identificador visual (preto e branco) para o projeto. Dados necessários: project_id, numberByProject.
111
- - **colorfulIdentifierByProject**: Igual ao anterior, mas colorido. Dados necessários: project_id, numberByProject, color.
112
- - **barCode**: Gera um código de barras. Dados necessários: código a ser convertido (originBarcode, customBarcode, code_a, code_b, etc).
113
- - **miniSheet**: Miniatura da chapa. Dados necessários: lista de partes (parts), dimensões da chapa (height, width).
114
- - **miniPartA**: Miniatura da peça (lado A). Dados necessários: dados da peça (width, height, index).
115
- - **miniPartB**: Miniatura da peça (lado B). Dados necessários: dados da peça (width, height, index).
116
- - **Image**: Imagem. Dados necessários: já vem no template.
117
- - **text**: Texto estático. Dados necessários: já vem no template.
118
- - **volumeContent**: Gera uma tabela de itens do volume. Dados necessários: itemList (array de itens do volume).
119
-
120
- > **Observação:** Você pode usar qualquer combinação dessas specialProps em qualquer template, desde que o template utilize o campo correspondente.
121
-