@praxisui/dynamic-form 8.0.0-beta.19 → 8.0.0-beta.20
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 +15 -4
- package/docs/dynamic-form-authoring-document-semantics.md +80 -0
- package/docs/dynamic-form-llm-rule-authoring-guide.md +313 -0
- package/docs/dynamic-form-rules-authoring-plan.md +369 -0
- package/docs/hot-metadata-updates.md +141 -0
- package/docs/layout-items-visual-blocks.md +406 -0
- package/fesm2022/praxisui-dynamic-form.mjs +482 -15
- package/index.d.ts +25 -2
- package/package.json +12 -6
- package/src/lib/components/praxis-form-actions/praxis-form-actions.json-api.md +441 -0
- package/src/lib/config-editor/praxis-dynamic-form-config-editor.json-api.md +480 -0
- package/src/lib/filter-form/praxis-filter-form.json-api.md +507 -0
- package/src/lib/json-config-editor/form-json-config-editor.json-api.md +491 -0
- package/src/lib/layout-editor/praxis-layout-editor.json-api.md +432 -0
- package/src/lib/praxis-dynamic-form.json-api.md +955 -0
|
@@ -0,0 +1,480 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "praxis-dynamic-form-config-editor JSON API (Canonical)"
|
|
3
|
+
slug: "praxis-dynamic-form-config-editor-json-api"
|
|
4
|
+
doc_type: "api-reference"
|
|
5
|
+
component: "praxis-dynamic-form-config-editor"
|
|
6
|
+
document_kind: "json-api-canonical"
|
|
7
|
+
reference_mode: "canonical"
|
|
8
|
+
contract_format: "json"
|
|
9
|
+
contract_source: "runtime-and-code"
|
|
10
|
+
description: "Referencia canonica do contrato JSON do componente praxis-dynamic-form-config-editor."
|
|
11
|
+
category: "components"
|
|
12
|
+
sub_category: "config-editor"
|
|
13
|
+
audience:
|
|
14
|
+
- "frontend"
|
|
15
|
+
- "architect"
|
|
16
|
+
- "platform-team"
|
|
17
|
+
level: "advanced"
|
|
18
|
+
status: "active"
|
|
19
|
+
owner: "praxis-ui"
|
|
20
|
+
source_of_truth:
|
|
21
|
+
- "projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.ts"
|
|
22
|
+
- "projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.html"
|
|
23
|
+
- "projects/praxis-dynamic-form/src/lib/praxis-dynamic-form.ts"
|
|
24
|
+
- "projects/praxis-settings-panel/src/lib/settings-panel.types.ts"
|
|
25
|
+
- "projects/praxis-core/src/lib/models/form/form-config.model.ts"
|
|
26
|
+
source_of_truth_last_verified: "2026-03-15"
|
|
27
|
+
last_updated: "2026-03-15"
|
|
28
|
+
toc: true
|
|
29
|
+
sidebar: true
|
|
30
|
+
tags:
|
|
31
|
+
- "json-api"
|
|
32
|
+
- "canonical-contract"
|
|
33
|
+
- "praxis-dynamic-form-config-editor"
|
|
34
|
+
api_stability: "canonical"
|
|
35
|
+
schema_verified: true
|
|
36
|
+
runtime_verified: false
|
|
37
|
+
editor_coverage_verified: false
|
|
38
|
+
runtime_scope: "public"
|
|
39
|
+
legacy_paths_present: false
|
|
40
|
+
has_known_mismatches: true
|
|
41
|
+
related_components:
|
|
42
|
+
- "praxis-table"
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
# praxis-dynamic-form-config-editor
|
|
46
|
+
|
|
47
|
+
Este documento e a referencia canonica da API JSON de praxis-dynamic-form-config-editor.
|
|
48
|
+
|
|
49
|
+
## Summary
|
|
50
|
+
|
|
51
|
+
- Tipo documental: API reference canonica de contrato JSON.
|
|
52
|
+
- Source of truth: runtime e codigo declarados no frontmatter.
|
|
53
|
+
- Objetivo operacional: consulta rapida, auditavel e deterministica sob pressao.
|
|
54
|
+
- Resumo funcional herdado: `praxis-dynamic-form-config-editor` e o editor avancado de configuracao do `praxis-dynamic-form`. Ele nao e um form de dados final; e um componente de autoria/revisao de JSON para layout, regras, hooks, mensagens e preferencias auxiliares.
|
|
55
|
+
|
|
56
|
+
## Canonical authoring semantics
|
|
57
|
+
|
|
58
|
+
- O editor visual e o editor JSON operam sobre `DynamicFormAuthoringDocument`.
|
|
59
|
+
- O editor JSON aceita apenas o envelope canônico; payloads legados pertencem aos caminhos de compatibilidade do runtime.
|
|
60
|
+
- `Apply` e `Save` emitem um snapshot canonico completo com semantica `replace-all`.
|
|
61
|
+
- `config`, `bindings` e `contextSnapshot` substituem integralmente o estado autoral anterior.
|
|
62
|
+
- Ausencia de `bindings.mode` limpa o binding persistido e restaura o modo default efetivo do host.
|
|
63
|
+
- Ausencia de `contextSnapshot.backConfig`, `contextSnapshot.presentation` ou `contextSnapshot.schemaPrefs` significa remocao explicita do bloco ausente.
|
|
64
|
+
- Payloads legados aceitos por caminhos de compatibilidade continuam fora deste contrato e permanecem em semantica `merge-compat`.
|
|
65
|
+
|
|
66
|
+
## Scope and positioning
|
|
67
|
+
|
|
68
|
+
- Escopo: contrato JSON publico e limites de comportamento observavel.
|
|
69
|
+
- Fora de escopo: tutorial de adocao e walkthrough operacional detalhado.
|
|
70
|
+
- Posicionamento: referencia canonicamente governada para consumidores, arquitetos e mantenedores.
|
|
71
|
+
|
|
72
|
+
## Source of truth
|
|
73
|
+
|
|
74
|
+
| Source | Kind | Notes |
|
|
75
|
+
| --- | --- | --- |
|
|
76
|
+
| projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.ts | runtime-code | Source de implementacao declarado no repositorio. |
|
|
77
|
+
| projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.html | template-style | Source de implementacao declarado no repositorio. |
|
|
78
|
+
| projects/praxis-dynamic-form/src/lib/praxis-dynamic-form.ts | runtime-code | Source de implementacao declarado no repositorio. |
|
|
79
|
+
| projects/praxis-settings-panel/src/lib/settings-panel.types.ts | runtime-code | Source de implementacao declarado no repositorio. |
|
|
80
|
+
| projects/praxis-core/src/lib/models/form/form-config.model.ts | runtime-code | Source de implementacao declarado no repositorio. |
|
|
81
|
+
|
|
82
|
+
## Support legend
|
|
83
|
+
|
|
84
|
+
- Active: suportado e observado no runtime atual.
|
|
85
|
+
- Partial: suporte parcial, com restricoes conhecidas.
|
|
86
|
+
- Declared-only: declarado em tipos/schema sem ligacao runtime confirmada.
|
|
87
|
+
- Schema-only: presente em schema/modelo sem confirmacao de execucao.
|
|
88
|
+
- Deprecated: mantido por compatibilidade legada com migracao prevista.
|
|
89
|
+
|
|
90
|
+
## Contract classification
|
|
91
|
+
|
|
92
|
+
### Canonical paths (public contract)
|
|
93
|
+
|
|
94
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
95
|
+
| --- | --- | --- | --- | --- | --- |
|
|
96
|
+
| `sections` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
97
|
+
| `fieldMetadata` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
98
|
+
| `actions` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
99
|
+
| `behavior` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
100
|
+
| `messages` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
101
|
+
| `hooks` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
102
|
+
| `formRules` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
103
|
+
| `formRulesState` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
104
|
+
| `hints` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
105
|
+
| `api` | not-specified | not-specified | n/a | Partial | Preservado da documentação anterior. |
|
|
106
|
+
| `metadata` | not-specified | not-specified | n/a | Partial | Preservado da documentação anterior. |
|
|
107
|
+
|
|
108
|
+
### Supported legacy paths
|
|
109
|
+
|
|
110
|
+
Nenhum path legado suportado foi identificado nesta revisão baseada em evidência textual preservada.
|
|
111
|
+
|
|
112
|
+
### Internal-only paths
|
|
113
|
+
|
|
114
|
+
| Path | Internal consumer | Runtime presence | Public support | Notes |
|
|
115
|
+
| --- | --- | --- | --- | --- |
|
|
116
|
+
| not-yet-mapped | not-yet-verified | not-yet-verified | No | Caminhos internos nao mapeados explicitamente nesta revisao automatizada. |
|
|
117
|
+
|
|
118
|
+
### Experimental paths
|
|
119
|
+
|
|
120
|
+
| Path | Enablement (flag/guard) | Stability | Rollout notes | Notes |
|
|
121
|
+
| --- | --- | --- | --- | --- |
|
|
122
|
+
| not-yet-mapped | not-yet-verified | Experimental | not-yet-verified | Registrar somente quando houver evidencia em runtime/codigo. |
|
|
123
|
+
|
|
124
|
+
## Overview
|
|
125
|
+
|
|
126
|
+
Este arquivo foi adaptado para o padrao canonico atual sem remover conteudo tecnico existente. O conteudo detalhado anterior foi preservado para manter rastreabilidade historica e reduzir perda de contexto.
|
|
127
|
+
|
|
128
|
+
## Public contract surface
|
|
129
|
+
|
|
130
|
+
### Top-level configuration blocks
|
|
131
|
+
|
|
132
|
+
| Block | Purpose | Required | Merge strategy | Notes |
|
|
133
|
+
| --- | --- | --- | --- | --- |
|
|
134
|
+
| sections | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
135
|
+
| fieldMetadata | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
136
|
+
| actions | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
137
|
+
| behavior | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
138
|
+
| messages | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
139
|
+
| hooks | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
140
|
+
| formRules | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
141
|
+
| formRulesState | Configuração top-level identificada na referência preservada. | not-yet-verified | component-defined | 1 path(s) mapeado(s), status predominante Active. |
|
|
142
|
+
|
|
143
|
+
### Nested configuration blocks
|
|
144
|
+
|
|
145
|
+
| Path | Type | Required | Default | Constraints | Notes |
|
|
146
|
+
| --- | --- | --- | --- | --- | --- |
|
|
147
|
+
| `sections` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
148
|
+
| `fieldMetadata` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
149
|
+
| `actions` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
150
|
+
| `behavior` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
151
|
+
| `messages` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
152
|
+
| `hooks` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
153
|
+
| `formRules` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
154
|
+
| `formRulesState` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
155
|
+
| `hints` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
156
|
+
| `api` | not-specified | not-specified | n/a | component-defined | Preservado da documentação anterior. |
|
|
157
|
+
|
|
158
|
+
### Input bindings
|
|
159
|
+
|
|
160
|
+
| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
|
|
161
|
+
| --- | --- | --- | --- | --- | --- |
|
|
162
|
+
| component-inputs | see-detailed-api | not-yet-verified | runtime-and-code | not-yet-verified | Inputs preservados na referência detalhada. |
|
|
163
|
+
|
|
164
|
+
### Output events
|
|
165
|
+
|
|
166
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
167
|
+
| --- | --- | --- | --- | --- |
|
|
168
|
+
| component-outputs | see-detailed-api | runtime-event | Partial | Eventos preservados na referência detalhada. |
|
|
169
|
+
|
|
170
|
+
### External side channels
|
|
171
|
+
|
|
172
|
+
| Channel | Direction | Contract | Failure mode | Notes |
|
|
173
|
+
| --- | --- | --- | --- | --- |
|
|
174
|
+
| host/services/storage | bidirectional | see-detailed-api | not-yet-verified | Side channels dependem do componente e do host consumidor. |
|
|
175
|
+
|
|
176
|
+
### Host/runtime dependencies
|
|
177
|
+
|
|
178
|
+
| Dependency | Required | Environment | Purpose | Notes |
|
|
179
|
+
| --- | --- | --- | --- | --- |
|
|
180
|
+
| see-source-of-truth | true | browser/dev/prod/ssr | runtime linkage | Confirmar por componente quando necessario. |
|
|
181
|
+
|
|
182
|
+
## Coverage matrix
|
|
183
|
+
|
|
184
|
+
| Surface | Verified | Coverage status | Evidence | Notes |
|
|
185
|
+
| --- | --- | --- | --- | --- |
|
|
186
|
+
| Runtime | false | Partial | source_of_truth + conteudo preservado | Revisao estrutural concluida; validacao comportamental fina pode exigir follow-up. |
|
|
187
|
+
| Schema/Types | true | Partial | interfaces/modelos citados | Mapeamento formal de todos os campos ainda pode requerer refinamento. |
|
|
188
|
+
| Editor/Tooling | false | Partial | secoes de editor quando presentes | Cobertura de editor/tooling nem sempre confirmada por evidencia direta. |
|
|
189
|
+
|
|
190
|
+
## Runtime coverage boundaries
|
|
191
|
+
|
|
192
|
+
- Cobertura consolidada com base em documentacao existente e source of truth declarado.
|
|
193
|
+
- Comportamentos fora de evidencia direta foram marcados como not-yet-verified ou Partial.
|
|
194
|
+
- Compatibilidade legada, quando detectada, foi separada em classificacao explicita.
|
|
195
|
+
|
|
196
|
+
## Resolution model
|
|
197
|
+
|
|
198
|
+
### Merge order
|
|
199
|
+
|
|
200
|
+
1. defaults do componente
|
|
201
|
+
2. contrato JSON recebido
|
|
202
|
+
3. overrides de host/runtime
|
|
203
|
+
4. normalizacoes internas
|
|
204
|
+
|
|
205
|
+
### Fallback order
|
|
206
|
+
|
|
207
|
+
contrato explicito -> aliases legados (quando suportados) -> defaults internos -> comportamento seguro
|
|
208
|
+
|
|
209
|
+
### Override points
|
|
210
|
+
|
|
211
|
+
- inputs publicos do componente
|
|
212
|
+
- configuracao JSON de runtime
|
|
213
|
+
- integracoes de host (servicos/tokens/adapters)
|
|
214
|
+
|
|
215
|
+
### Runtime normalization
|
|
216
|
+
|
|
217
|
+
Campos e aliases preservados do documento anterior devem convergir progressivamente para paths canonicos declarados.
|
|
218
|
+
|
|
219
|
+
### Precedence rules
|
|
220
|
+
|
|
221
|
+
Quando houver conflito entre alias e path canonico, priorizar path canonico e manter alias apenas para backward compatibility.
|
|
222
|
+
|
|
223
|
+
## Validation and error semantics
|
|
224
|
+
|
|
225
|
+
### Validation model
|
|
226
|
+
|
|
227
|
+
| Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
|
|
228
|
+
| --- | --- | --- | --- | --- |
|
|
229
|
+
| see-detailed-api | runtime | warn-or-reject | not-yet-standardized | Semantica de validacao preservada do documento anterior. |
|
|
230
|
+
|
|
231
|
+
### Error semantics
|
|
232
|
+
|
|
233
|
+
Erros devem ser classificados em warnings recuperaveis versus falhas bloqueantes. Quando a evidencia nao estiver explicita, tratar como not yet verified.
|
|
234
|
+
|
|
235
|
+
### Fail-open / fail-closed behavior
|
|
236
|
+
|
|
237
|
+
| Condition | Mode | Runtime behavior | Consumer impact |
|
|
238
|
+
| --- | --- | --- | --- |
|
|
239
|
+
| invalid-or-unknown-field | component-defined | not-yet-verified | Variavel por componente; requer verificacao em runtime. |
|
|
240
|
+
|
|
241
|
+
### Invalid or unknown field handling
|
|
242
|
+
|
|
243
|
+
- Campos desconhecidos: comportamento depende da estrategia do componente (ignore, warn ou reject).
|
|
244
|
+
- Campos invalidos: podem gerar fallback, warning ou falha conforme implementacao.
|
|
245
|
+
- Registrar divergencias observadas em Known limitations and mismatches.
|
|
246
|
+
|
|
247
|
+
### Runtime warnings vs hard failures
|
|
248
|
+
|
|
249
|
+
| Condition | Severity | Observability | Consumer action |
|
|
250
|
+
| --- | --- | --- | --- |
|
|
251
|
+
| partial-or-declared-only-coverage | warning | logs/eventos do componente | confirmar ligacao runtime antes de uso critico |
|
|
252
|
+
|
|
253
|
+
## Detailed API
|
|
254
|
+
|
|
255
|
+
### Preserved technical reference (normalized from previous revision)
|
|
256
|
+
|
|
257
|
+
### 1. Visao Geral e Quando Usar
|
|
258
|
+
`praxis-dynamic-form-config-editor` e o editor avancado de configuracao do `praxis-dynamic-form`.
|
|
259
|
+
Ele nao e um form de dados final; e um componente de autoria/revisao de JSON para layout, regras, hooks, mensagens e preferencias auxiliares.
|
|
260
|
+
|
|
261
|
+
No runtime atual, ele opera como `SettingsValueProvider` dentro do `SettingsPanelService`.
|
|
262
|
+
|
|
263
|
+
Use quando precisar de:
|
|
264
|
+
- editar `FormConfig` de forma visual + JSON;
|
|
265
|
+
- gerar bundle de configuracao para `applied/saved` no settings panel;
|
|
266
|
+
- manter round-trip de regras (`formRules` + `formRulesState`);
|
|
267
|
+
- ajustar preferencias de apresentacao e de verificacao de schema fora do `FormConfig` principal.
|
|
268
|
+
|
|
269
|
+
### 2. Contrato de Entrada (Settings Panel Data)
|
|
270
|
+
|
|
271
|
+
Este componente nao expoe `@Input` publico direto no codigo.
|
|
272
|
+
A entrada operacional vem via `SETTINGS_PANEL_DATA` (injetado pelo settings panel).
|
|
273
|
+
|
|
274
|
+
| Chave em `SETTINGS_PANEL_DATA` | Tipo | Obrigatorio | Status | Comportamento |
|
|
275
|
+
| --- | --- | --- | --- | --- |
|
|
276
|
+
| `formConfig` | `FormConfig` | Sim (na pratica) | Active | Base de edicao; e normalizado e clonado no construtor. |
|
|
277
|
+
| `backConfig` | `BackConfig` | Nao | Active | Configuracao de retorno do CRUD; fallback local quando ausente. |
|
|
278
|
+
| `formId` | `string` | Nao | Active | Identidade para persistencia auxiliar e chave de painel. |
|
|
279
|
+
| `componentKeyId` | `string` | Nao | Active | Prioridade para chave de persistencia quando informado. |
|
|
280
|
+
| `mode` | `'create' \| 'edit' \| 'view'` | Nao | Active | Inicializa `inputMode`; invalido cai para `create`. |
|
|
281
|
+
| `presentationMode` | `boolean` | Nao | Active | Controla exibicao da aba "Modo Apresentacao". |
|
|
282
|
+
| `runtimeContext` | `DynamicFormRuntimeContext` | Nao | Active | Contexto operacional somente leitura; pode expor `resolvedContract.schemaUrl/submitUrl/submitMethod` para diagnosticos visuais, sem persistencia no documento autoral. |
|
|
283
|
+
|
|
284
|
+
### 3. Contrato de Saida (SettingsValueProvider)
|
|
285
|
+
|
|
286
|
+
| Superficie | Tipo | Status | Notas |
|
|
287
|
+
| --- | --- | --- | --- |
|
|
288
|
+
| `isDirty$` | `Observable<boolean>` | Active | Dirty check por `stableStringify` entre `initialConfig` e `editedConfig`. |
|
|
289
|
+
| `isValid$` | `Observable<boolean>` | Active | Reflete validacao do editor JSON e estado interno. |
|
|
290
|
+
| `isBusy$` | `Observable<boolean>` | Active | Estado de processamento em `reset/onSave`. |
|
|
291
|
+
| `reset()` | `() => void` | Active | Restaura snapshot inicial e sincroniza aba JSON. |
|
|
292
|
+
| `getSettingsValue()` | `() => EditorBundle` | Active | Retorna bundle consumido pelo host no `applied/saved`. |
|
|
293
|
+
| `onSave()` | `() => EditorBundle` | Active | Mesmo contrato de `getSettingsValue`, com controle de busy. |
|
|
294
|
+
|
|
295
|
+
`EditorBundle` retornado:
|
|
296
|
+
|
|
297
|
+
```ts
|
|
298
|
+
{
|
|
299
|
+
formConfig: FormConfig;
|
|
300
|
+
backConfig?: BackConfig;
|
|
301
|
+
presentation: {
|
|
302
|
+
labelPosition: 'above' | 'left';
|
|
303
|
+
labelFontSize?: number | null;
|
|
304
|
+
valueFontSize?: number | null;
|
|
305
|
+
compact?: boolean;
|
|
306
|
+
density?: 'comfortable' | 'cozy' | 'compact';
|
|
307
|
+
labelWidth?: number | null;
|
|
308
|
+
labelAlign?: 'start' | 'center' | 'end';
|
|
309
|
+
valueAlign?: 'start' | 'center' | 'end';
|
|
310
|
+
};
|
|
311
|
+
inputsPatch: { mode: 'create' | 'edit' | 'view' };
|
|
312
|
+
schemaPrefs: {
|
|
313
|
+
notifyIfOutdated: 'inline' | 'snackbar' | 'both' | 'none';
|
|
314
|
+
snoozeMs: number;
|
|
315
|
+
autoOpenSettingsOnOutdated: boolean;
|
|
316
|
+
};
|
|
317
|
+
}
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### 4. Cobertura de `formConfig` no Editor
|
|
321
|
+
|
|
322
|
+
| Caminho | Status | Como e tratado |
|
|
323
|
+
| --- | --- | --- |
|
|
324
|
+
| `sections` | Active | Editado na aba Layout (`praxis-layout-editor`). |
|
|
325
|
+
| `fieldMetadata` | Active | Usado em layout, cascatas e rule builder. |
|
|
326
|
+
| `actions` | Active | Editado na aba Acoes. |
|
|
327
|
+
| `behavior` | Active | Editado na aba Comportamento. |
|
|
328
|
+
| `messages` | Active | Editado na aba Mensagens. |
|
|
329
|
+
| `hooks` | Active | Editado na aba Hooks e JSON. |
|
|
330
|
+
| `formRules` | Active | Gerado pela aba Regras (visual builder). |
|
|
331
|
+
| `formRulesState` | Active | Persistido para round-trip sem perda. |
|
|
332
|
+
| `hints` | Active | Editado na aba Dicas e Tooltips. |
|
|
333
|
+
| `api` | Partial | Sem aba dedicada; passa por JSON editor quando presente. |
|
|
334
|
+
| `metadata` | Partial | Mantido em round-trip; sem painel dedicado. |
|
|
335
|
+
|
|
336
|
+
Politicas de integridade:
|
|
337
|
+
- `endpoint` legado e removido de `fieldMetadata` antes de salvar (`stripLegacyFieldMetadata`).
|
|
338
|
+
- `formRules` vazio e `formRulesState` vazio podem ser removidos para evitar dirty falso.
|
|
339
|
+
|
|
340
|
+
### 5. Exemplo de Integracao no Host
|
|
341
|
+
```ts
|
|
342
|
+
const ref = settingsPanel.open({
|
|
343
|
+
id: `form.${formId}`,
|
|
344
|
+
title: 'Configuracao do Formulario',
|
|
345
|
+
content: {
|
|
346
|
+
component: PraxisDynamicFormConfigEditor,
|
|
347
|
+
inputs: {
|
|
348
|
+
formConfig,
|
|
349
|
+
backConfig,
|
|
350
|
+
formId,
|
|
351
|
+
componentKeyId,
|
|
352
|
+
mode,
|
|
353
|
+
presentationMode
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
});
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
No `saved/applied`, o host consome o bundle e decide persistencia por chave/canal.
|
|
360
|
+
|
|
361
|
+
### 6. Problemas Comuns e Armadilhas
|
|
362
|
+
1. Tratar `praxis-dynamic-form-config-editor` como componente final de dados.
|
|
363
|
+
Correcao: ele e editor de configuracao, nao runtime de submissao de entidade.
|
|
364
|
+
|
|
365
|
+
2. Assumir `SETTINGS_PANEL_DATA` sem `formConfig`.
|
|
366
|
+
Correcao: passe sempre `formConfig`; sem base valida o valor salvo perde previsibilidade.
|
|
367
|
+
|
|
368
|
+
3. Ignorar `inputsPatch.mode` retornado no save.
|
|
369
|
+
Correcao: aplique patch de modo no host quando necessario para consistencia de UX.
|
|
370
|
+
|
|
371
|
+
4. Persistir bundle inteiro como se fosse `FormConfig` puro.
|
|
372
|
+
Correcao: separe `formConfig` de `presentation/schemaPrefs/backConfig/inputsPatch`.
|
|
373
|
+
|
|
374
|
+
5. Esperar aba de `api` dedicada.
|
|
375
|
+
Correcao: hoje ajustes de `api` sao via JSON editor (pass-through).
|
|
376
|
+
|
|
377
|
+
6. Considerar `isDirty$` como diff de negocio definitivo.
|
|
378
|
+
Correcao: e diff estrutural para UX do painel, nao auditoria de negocio.
|
|
379
|
+
|
|
380
|
+
### 7. Referencias Cruzadas
|
|
381
|
+
- Runtime consumidor: `projects/praxis-dynamic-form/src/lib/praxis-dynamic-form.ts`
|
|
382
|
+
- Editor JSON interno: `projects/praxis-dynamic-form/src/lib/json-config-editor/json-config-editor.component.ts`
|
|
383
|
+
- Contrato do painel: `projects/praxis-settings-panel/src/lib/settings-panel.types.ts`
|
|
384
|
+
- Modelo base: `projects/praxis-core/src/lib/models/form/form-config.model.ts`
|
|
385
|
+
|
|
386
|
+
### 8. Premissas
|
|
387
|
+
- O host e responsavel pela persistencia definitiva e por aplicar patches retornados.
|
|
388
|
+
- O bundle retornado pode conter dados fora de `FormConfig` por design (preferencias e contexto).
|
|
389
|
+
- Validacoes de autorizacao e politica de alteracao devem ser tratadas no host/backend.
|
|
390
|
+
|
|
391
|
+
### 9. Relatorio de Validacao Estrutural
|
|
392
|
+
- Visao geral: PASS
|
|
393
|
+
- Contrato de entrada por `SETTINGS_PANEL_DATA`: PASS
|
|
394
|
+
- Contrato de saida (`SettingsValueProvider`): PASS
|
|
395
|
+
- Cobertura de `FormConfig` com status: PASS
|
|
396
|
+
- Exemplo de integracao: PASS
|
|
397
|
+
- Problemas comuns (>=5): PASS
|
|
398
|
+
- Referencias cruzadas: PASS
|
|
399
|
+
- Premissas explicitas: PASS
|
|
400
|
+
|
|
401
|
+
## JSON path index
|
|
402
|
+
|
|
403
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
404
|
+
| --- | --- | --- | --- | --- | --- |
|
|
405
|
+
| `sections` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
406
|
+
| `fieldMetadata` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
407
|
+
| `actions` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
408
|
+
| `behavior` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
409
|
+
| `messages` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
410
|
+
| `hooks` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
411
|
+
| `formRules` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
412
|
+
| `formRulesState` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
413
|
+
| `hints` | not-specified | not-specified | n/a | Active | Preservado da documentação anterior. |
|
|
414
|
+
| `api` | not-specified | not-specified | n/a | Partial | Preservado da documentação anterior. |
|
|
415
|
+
| `metadata` | not-specified | not-specified | n/a | Partial | Preservado da documentação anterior. |
|
|
416
|
+
|
|
417
|
+
## Events
|
|
418
|
+
|
|
419
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
420
|
+
| --- | --- | --- | --- | --- |
|
|
421
|
+
| component-outputs | see-detailed-api | runtime-event | Partial | Eventos preservados na referência detalhada. |
|
|
422
|
+
|
|
423
|
+
## Styling API
|
|
424
|
+
|
|
425
|
+
| Token/Class | Scope | Purpose | Notes |
|
|
426
|
+
| --- | --- | --- | --- |
|
|
427
|
+
| see-detailed-api | component | styling/runtime | Consolidar naming canonico quando aplicavel. |
|
|
428
|
+
|
|
429
|
+
## Editor and tooling notes
|
|
430
|
+
|
|
431
|
+
- Cobertura de editor/tooling foi separada da cobertura de runtime para evitar confusao de suporte.
|
|
432
|
+
- Quando nao houver evidencia direta no codigo, o status deve permanecer not yet verified.
|
|
433
|
+
|
|
434
|
+
## Examples
|
|
435
|
+
|
|
436
|
+
### Minimal valid
|
|
437
|
+
|
|
438
|
+
```json
|
|
439
|
+
{}
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Typical/common
|
|
443
|
+
|
|
444
|
+
```json
|
|
445
|
+
{}
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### Advanced
|
|
449
|
+
|
|
450
|
+
```json
|
|
451
|
+
{}
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
### Enterprise scenario
|
|
455
|
+
|
|
456
|
+
```json
|
|
457
|
+
{}
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
## Known limitations and mismatches
|
|
461
|
+
|
|
462
|
+
| Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
|
|
463
|
+
| --- | --- | --- | --- | --- | --- |
|
|
464
|
+
| coverage/mapping | Evidência textual preservada indica itens Partial/Declared-only. | Cobertura confirmada por evidência runtime + schema + editor. | Pode gerar uso de paths não totalmente ligados. | to-be-linked | next-doc-cycle |
|
|
465
|
+
|
|
466
|
+
## Compatibility and migration notes
|
|
467
|
+
|
|
468
|
+
| Concern | Affected versions | Migration action | Deadline | Notes |
|
|
469
|
+
| --- | --- | --- | --- | --- |
|
|
470
|
+
| legacy aliases and mixed status vocabulary | pre-canonical docs | unificar para taxonomia canonica (Active/Partial/Declared-only/...) | next-doc-cycle | manter backward compatibility documentada |
|
|
471
|
+
|
|
472
|
+
## Source references
|
|
473
|
+
|
|
474
|
+
| Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
|
|
475
|
+
| --- | --- | --- | --- | --- |
|
|
476
|
+
| local-file | projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.ts | Evidencia de implementacao e contrato. | 2026-03-05 | referencia preservada da versao anterior |
|
|
477
|
+
| local-file | projects/praxis-dynamic-form/src/lib/config-editor/praxis-dynamic-form-config-editor.html | Evidencia de implementacao e contrato. | 2026-03-05 | referencia preservada da versao anterior |
|
|
478
|
+
| local-file | projects/praxis-dynamic-form/src/lib/praxis-dynamic-form.ts | Evidencia de implementacao e contrato. | 2026-03-05 | referencia preservada da versao anterior |
|
|
479
|
+
| local-file | projects/praxis-settings-panel/src/lib/settings-panel.types.ts | Evidencia de implementacao e contrato. | 2026-03-05 | referencia preservada da versao anterior |
|
|
480
|
+
| local-file | projects/praxis-core/src/lib/models/form/form-config.model.ts | Evidencia de implementacao e contrato. | 2026-03-05 | referencia preservada da versao anterior |
|