@praxisui/table 1.0.0-beta.1 → 1.0.0-beta.10

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/README.md CHANGED
@@ -1,10 +1,10 @@
1
- # @praxis/table
1
+ # @praxisui/table
2
2
 
3
3
  > Componente de tabela empresarial avançado com arquitetura unificada
4
4
 
5
5
  ## 🌟 Visão Geral
6
6
 
7
- A biblioteca `@praxis/table` fornece um componente de tabela robusto e altamente configurável para aplicações Angular empresariais. Com a nova arquitetura unificada, oferece uma experiência de desenvolvimento simplificada mantendo todos os recursos avançados.
7
+ A biblioteca `@praxisui/table` fornece um componente de tabela robusto e altamente configurável para aplicações Angular empresariais. Com a nova arquitetura unificada, oferece uma experiência de desenvolvimento simplificada mantendo todos os recursos avançados.
8
8
 
9
9
  ## ✨ Características Principais
10
10
 
@@ -34,6 +34,188 @@ A biblioteca `@praxis/table` fornece um componente de tabela robusto e altamente
34
34
  - **Toolbar Editor**: Personalização de ações
35
35
  - **Messages Editor**: Textos e localização
36
36
 
37
+ Nota (Regras)
38
+ - A antiga aba visual genérica foi removida deste pacote. Um editor especializado para regras da Tabela está em desenvolvimento e já pode ser usado no painel de configuração.
39
+
40
+ ### 🧩 Editor de Regras (column-first)
41
+
42
+ O novo editor é "column-first" e usa uma tipagem compartilhada com o Editor de Colunas. Principais pontos:
43
+
44
+ - Escopo: aplique regras na linha inteira (rowConditionalStyles) ou em uma coluna específica (columns[].conditionalStyles).
45
+ - Operadores por tipo: o conjunto de operadores é filtrado por tipo (string/number/date/boolean/enum).
46
+ - Editores de valor dinâmicos: inputs numéricos, listas (CSV/múltipla seleção), datepickers.
47
+ - Grupos lógicos: construa condições com AND/OR/NOT e reordene via arrastar-e-soltar (CDK DragDrop).
48
+ - Preview: execute “Testar” para ver quantas linhas seriam afetadas pelas regras ativas.
49
+ - Import/Export: exporta JSON sem o campo `enabled`; importa com validação de DSL e sanitização de estilos (allowlist).
50
+
51
+ Exemplos de DSL:
52
+
53
+ ```text
54
+ contains(status, 'Ativo')
55
+ not (status in ['A', 'I'])
56
+ (price >= 10 and price <= 20)
57
+ (createdAt >= '2024-10-01' and createdAt <= '2024-10-31')
58
+ (name == null or name == '')
59
+ active == true
60
+ ```
61
+
62
+ Notas sobre enum/CSV:
63
+ - Para campos enumerados, as opções são inferidas de `valueMapping` da coluna ou de `fields?.options`.
64
+ - Para `in/not in` em números/strings, use CSV (ex.: `10, 20, 30` ou `Alice, Bob`).
65
+
66
+ #### Extensões de DSL (JSON/Tempo)
67
+
68
+ Você pode registrar funções adicionais no `DslParser` do app host para expressões com JSON e data/tempo.
69
+
70
+ Exemplo rápido (registro direto):
71
+ ```ts
72
+ import { DslParser } from '@praxisui/specification';
73
+ import { registerJsonDslFunctions, registerDateDslFunctions } from '@praxisui/table';
74
+
75
+ const parser = new DslParser<any>();
76
+ registerJsonDslFunctions(parser);
77
+ registerDateDslFunctions(parser);
78
+ ```
79
+
80
+ Exemplos de DSL:
81
+ - `jsonGet(payload, '$.user.name') == 'Alice'`
82
+ - `hasJsonKey(payload, '$.meta.etag')`
83
+ - `jsonPathMatches(payload, '$.roles[0]', '^admin$')`
84
+
85
+ Guia completo: `projects/praxis-table/docs/DSL-Extensions-Guide.md`
86
+
87
+ #### 🎨 Efeitos (Conteúdo C)
88
+
89
+ O bloco de Efeitos permite aplicar estilo e visuais quando a condição é verdadeira:
90
+
91
+ - Toolbar de texto com ícones (negrito, itálico, sublinhado) e presets rápidos (tachado, maiúsculas/minúsculas/capitalizar, tamanho +/- e reset).
92
+ - Presets de feedback com ícones (sucesso, aviso, erro, info) — mantêm o rótulo via tooltip e `aria-label`.
93
+ - “Posição do valor” como grupo de alternância (antes / entre-1 / entre-2 / depois / oculto).
94
+ - “Ordem dos visuais” com seletor compacto (3 mais comuns) e menu para opções extras.
95
+ - Layout do compose: espaçamento, alinhamento, quebra de linha e reticências.
96
+
97
+ Dicas
98
+ - Use “Resetar texto” para reverter efeitos de texto sem perder cor de fundo/borda.
99
+ - Para acessibilidade, os grupos possuem `role="toolbar"`, tooltips e navegação por teclado consistente.
100
+
101
+ Como reverter efeitos
102
+ - “Reset Text” remove apenas propriedades de tipografia e transformação de texto.
103
+ - “Limpar efeitos” apaga classe e estilo livres do bloco rápido.
104
+
105
+ Observação: capturas de tela “antes/depois” podem ser adicionadas no PR conforme necessário.
106
+
107
+ #### Relacionais (lookup)
108
+
109
+ Campos relacionais (FK/objetos) podem ser editados no Rules Editor com busca assíncrona (typeahead) e seleção single/multiple.
110
+
111
+ Boas práticas
112
+ - Informe `resourcePath` (ou `endpoint`) no `FieldDefinition` para habilitar o lookup via `GenericCrudService` do host.
113
+ - Defina `valueField` (chave estável, tipicamente `id`) e `displayField` (label amigável, como `name`).
114
+ - Para múltipla seleção, use `multiple: true` no `FieldDefinition` quando aplicável.
115
+ - No runtime, registre as funções JSON no parser (ver guia) para que as expressões de ID/JSON funcionem: `jsonGet/hasJsonKey/jsonPathMatches`.
116
+ - APIs com busca: suporte a um parâmetro livre de texto (por ex. `search`) facilita a experiência do autocomplete.
117
+
118
+ Exemplo de FieldDefinition (lookup)
119
+ ```ts
120
+ import type { FieldDefinition } from '@praxisui/core';
121
+
122
+ const fields: FieldDefinition[] = [
123
+ {
124
+ name: 'customer',
125
+ type: 'object',
126
+ // Habilita o lookup via GenericCrudService
127
+ resourcePath: 'customers',
128
+ // Mapeia o id/label que virão do backend
129
+ valueField: 'id',
130
+ displayField: 'name',
131
+ // Se quiser multiseleção em todo o app
132
+ // multiple: true,
133
+ },
134
+ ];
135
+ ```
136
+
137
+ Operadores e DSL gerada (relacional)
138
+ - `id ==` → `jsonGet(customer, '$.id') == 10`
139
+ - `id in` → `jsonGet(customer, '$.id') in [10, 20]`
140
+ - `has property` → `hasJsonKey(customer, '$.meta.etag')`
141
+ - Condições por caminho (join simples): use `key ==` (JSON Path + valor)
142
+
143
+ UI (no editor)
144
+ - `id ==` (single): autocomplete + chip “label [id]” com ação “Limpar”.
145
+ - `id in` (multi): autocomplete + chips removíveis por item.
146
+ - `has property`: input do caminho (ex.: `$.meta.etag`).
147
+
148
+ Formato esperado do payload (relacional)
149
+
150
+ Para que o editor/preview e o runtime avaliem corretamente as regras relacionais, o valor do campo deve ser um objeto (ou compatível com JSON) contendo ao menos o identificador e, opcionalmente, propriedades exibidas:
151
+
152
+ ```ts
153
+ // Exemplo de linha (row) com campo relacional "customer"
154
+ const row = {
155
+ id: 123,
156
+ customer: {
157
+ id: 10, // ← usado em id == / id in via jsonGet(customer, '$.id')
158
+ name: 'ACME', // ← usado para exibir label no autocomplete/chip
159
+ meta: { etag: 'v1' },
160
+ },
161
+ };
162
+
163
+ // Regras DSL comuns
164
+ // id ==
165
+ // jsonGet(customer, '$.id') == 10
166
+ // id in
167
+ // jsonGet(customer, '$.id') in [10, 20]
168
+ // has property
169
+ // hasJsonKey(customer, '$.meta.etag')
170
+ // caminho/valor (join simples)
171
+ // jsonGet(customer, '$.name') == 'ACME'
172
+ ```
173
+
174
+ Notas
175
+ - O editor usa `displayField` (ex.: `name`) para compor o rótulo, e `valueField` (ex.: `id`) para gerar a DSL.
176
+ - Se o backend devolver o relacionamento já "normalizado" (ex.: `customerId` e `customerName` na mesma linha), você ainda pode expressar condições com operadores padrão (`==`, `in`) no campo numérico/literal — a abordagem relacional é útil quando o payload contém o objeto.
177
+
178
+ Onde é consumido (preview e runtime)
179
+
180
+ - Preview/validação no Editor de Regras (usa `DslParser` interno):
181
+ - Validação da expressão (parse): projects/praxis-table/src/lib/rules-editor/table-rules-editor.component.ts:536
182
+ - Preview “Testar” (parse + evaluate): projects/praxis-table/src/lib/rules-editor/table-rules-editor.component.ts:909
183
+ - Runtime na Tabela (aplica `rowConditionalStyles`/`conditionalStyles`):
184
+ - Parser interno do componente: projects/praxis-table/src/lib/praxis-table.ts:282
185
+
186
+ Observação
187
+ - Ao registrar funções via `DslParserFactory` (ex.: `registerJsonDslFunctions`/`registerDateDslFunctions`), use a mesma estratégia para o parser que avalia regras no runtime (Tabela) e para qualquer serviço que precise avaliar DSL. O Editor usa um parser interno para validação/preview; as funções de data já são suportadas por padrão, e as de JSON podem exigir extensão no runtime (ver guia).
188
+
189
+ Exemplo de Provider (recomendado)
190
+
191
+ ```ts
192
+ import { Injectable } from '@angular/core';
193
+ import { DslParser } from '@praxisui/specification';
194
+ import { registerJsonDslFunctions, registerDateDslFunctions } from '@praxisui/table';
195
+
196
+ @Injectable({ providedIn: 'root' })
197
+ export class DslParserFactory {
198
+ private parser: DslParser<any>;
199
+
200
+ constructor() {
201
+ this.parser = new DslParser<any>();
202
+ registerJsonDslFunctions(this.parser);
203
+ registerDateDslFunctions(this.parser);
204
+ }
205
+
206
+ get(): DslParser<any> {
207
+ return this.parser;
208
+ }
209
+ }
210
+
211
+ // Em um componente/serviço que avalia regras:
212
+ // constructor(factory: DslParserFactory) {
213
+ // const parser = factory.get();
214
+ // const spec = parser.parse("jsonGet(payload, '$.user.name') == 'Alice'");
215
+ // const ok = spec.isSatisfiedBy({ payload: { user: { name: 'Alice' } } });
216
+ // }
217
+ ```
218
+
37
219
  ### ⚙️ Painel de Configurações
38
220
 
39
221
  Para abrir o painel de configurações, habilite o modo de edição na tabela:
@@ -178,6 +360,46 @@ sequenceDiagram
178
360
  - Virtualização: habilite em Comportamento → Virtualização para listas grandes (requer altura de linha previsível).
179
361
  - Densidade e linhas de grade: ajuste em Comportamento → Aparência rápida (compacta/confortável/espaçosa; bordas horizontais/verticais).
180
362
 
363
+ ## Rolagem Horizontal (owner do scroll)
364
+
365
+ Por padrão, a `<praxis-table>` agora assume a responsabilidade pela rolagem horizontal quando o conteúdo excede a largura do container. Isso evita cortes de conteúdo e comportamentos inconsistentes entre projetos.
366
+
367
+ ### Input: `horizontalScroll`
368
+
369
+ ```
370
+ @Input() horizontalScroll: 'auto' | 'wrap' | 'none' = 'auto';
371
+ ```
372
+
373
+ - `auto` (padrão): a tabela cria um viewport com `overflow-x: auto` e permite que a tabela interna cresça com `width: max-content`. Quando a soma das colunas > container, aparece a barra de rolagem horizontal neste viewport.
374
+ - `wrap`: permite quebra de linha nas células (libera `white-space: normal`), reduzindo a largura necessária; ideal quando você prefere minimizar a rolagem horizontal.
375
+ - `none`: desabilita o comportamento interno; o host (página) deve fornecer o container com `overflow-x: auto` e as regras de largura necessárias.
376
+
377
+ Exemplo:
378
+
379
+ ```html
380
+ <!-- Comportamento padrão (auto) -->
381
+ <praxis-table resourcePath="employees"></praxis-table>
382
+
383
+ <!-- Reduz rolagem: permite quebra de linha nas células -->
384
+ <praxis-table resourcePath="employees" horizontalScroll="wrap"></praxis-table>
385
+
386
+ <!-- Host controla o scroll horizontal -->
387
+ <div class="table-shell" style="overflow-x:auto">
388
+ <praxis-table resourcePath="employees" horizontalScroll="none"></praxis-table>
389
+ <!-- host pode usar width: max-content na tabela interna conforme seu design system -->
390
+ </div>
391
+ ```
392
+
393
+ ### Editor de Configuração (Settings Panel)
394
+
395
+ Na aba “Visão Geral & Comportamento”, há um seletor “Scroll Horizontal” com as opções `Auto`, `Wrap` e `Host` (none). As alterações podem ser aplicadas (Aplicar) ou salvas (Salvar & Fechar). O valor é persistido junto com outras preferências da tabela.
396
+
397
+ ### Notas
398
+
399
+ - O caminho virtual (CDK Virtual Scroll) permanece sendo o owner da rolagem vertical; o viewport horizontal é um contêiner externo que não interfere no scroll vertical.
400
+ - Cabeçalho sticky continua funcional. Teste combinações com colunas sticky/virt para seu caso.
401
+ - Para grids alternativos (ex.: Kendo), as mesmas regras de `max-content`/`min-width: 100%` se aplicam ao elemento de tabela interno.
402
+
181
403
  ## Virtualização (CDK)
182
404
 
183
405
  Quando `behavior.virtualization.enabled` estiver ativo, as linhas da tabela são renderizadas com `cdk-virtual-scroll-viewport` (cabeçalho permanece igual).
@@ -1064,6 +1286,51 @@ Notas rápidas (Flow ETag no Filter):
1064
1286
  - 200: atualiza `serverHash/lastVerifiedAt`; marca `outdated=true` apenas quando em customização; não aplica o schema automaticamente.
1065
1287
  - O corpo do schema é baixado apenas quando necessário para renderização (ex.: `alwaysVisibleFields` ou ao abrir o painel Avançado).
1066
1288
 
1289
+ ## Formatação de Colunas (format)
1290
+
1291
+ Cada coluna pode declarar `type` e uma string de formatação `format` consumida pelo `DataFormattingService`. Os tipos suportados são: `string`, `number`, `currency`, `percentage`, `date`, `boolean`, `custom`.
1292
+
1293
+ Regra geral: a formatação só é aplicada quando há `format` não vazio e `type !== 'custom'`.
1294
+
1295
+ Tipos e padrões de `format`:
1296
+ - number (DecimalPipe)
1297
+ - Padrões: `minInt.minFrac-maxFrac`
1298
+ - Exemplos: `1.0-0`, `1.2-2`, `1.0-3|nosep` (remove separador de milhar)
1299
+ - currency (CurrencyPipe)
1300
+ - Sintaxe: `CURRENCY|DISPLAY|DECIMALS[|nosep]`
1301
+ - Exemplos: `BRL|symbol|2`, `USD|code|0`, `EUR|symbol|2|nosep`
1302
+ - percentage (PercentPipe/DecimalPipe)
1303
+ - Sem multiplicador: `1.0-0` (PercentPipe)
1304
+ - Multiplicar por 100: `1.1-1|x100` (DecimalPipe×100 + `%`)
1305
+ - date (DatePipe)
1306
+ - Tokens Angular: `shortDate`, `mediumDate`, `longDate`, `fullDate`, `short`, `shortTime`
1307
+ - Padrões customizados: `dd/MM/yyyy`, `yyyy-MM-dd`, `dd/MM/yyyy HH:mm`
1308
+ - string (transformações + truncamento)
1309
+ - Transform: `uppercase` | `lowercase` | `titlecase` | `capitalize` | `none`
1310
+ - Transform + truncar: `<transform>|truncate|<max>|<suffix>`
1311
+ - Exemplos: `uppercase|truncate|50|...`, `titlecase`
1312
+ - boolean (pré-definidos ou custom)
1313
+ - Presets: `true-false` | `yes-no` | `active-inactive` | `on-off` | `enabled-disabled`
1314
+ - Custom: `custom|Verdadeiro|Falso`
1315
+
1316
+ Exemplos de ColumnDefinition:
1317
+ ```ts
1318
+ { field: 'salario', type: 'currency', format: 'BRL|symbol|2', header: 'Salário' }
1319
+ { field: 'desconto', type: 'percentage', format: '1.1-1|x100', header: 'Desconto' }
1320
+ { field: 'criadoEm', type: 'date', format: 'dd/MM/yyyy', header: 'Criado em' }
1321
+ { field: 'nome', type: 'string', format: 'titlecase|truncate|32|…', header: 'Nome' }
1322
+ { field: 'ativo', type: 'boolean', format: 'yes-no', header: 'Ativo' }
1323
+ ```
1324
+
1325
+ Observações:
1326
+ - `|nosep` remove separadores de milhar da saída formatada.
1327
+ - Para datas inválidas ou valores não numéricos, o serviço retorna o valor original (com aviso no console).
1328
+ - Colunas com renderizador `custom` não passam por formatação automática.
1329
+
1330
+ Exemplos práticos no workspace (rotas):
1331
+ - Regras Visuais (Simples): `/table-rules-simple`
1332
+ - Regras Visuais (Complexas): `/table-rules-complex`
1333
+
1067
1334
  ## 📊 Roadmap
1068
1335
 
1069
1336
  ### Próximas Versões