@praxisui/dynamic-fields 8.0.0-beta.6 → 8.0.0-beta.61

package/src/lib/components/preload-status/pdx-preload-status.json-api.md

@@ -0,0 +1,455 @@
+---
+title: "pdx-preload-status JSON API (Canonical)"
+slug: "pdx-preload-status-json-api"
+doc_type: "api-reference"
+component: "pdx-preload-status"
+document_kind: "json-api-canonical"
+reference_mode: "canonical"
+contract_format: "json"
+contract_source: "runtime-and-code"
+description: "Referencia canonica do contrato JSON do componente pdx-preload-status."
+category: "components"
+sub_category: "dynamic-fields"
+audience:
+  - "frontend"
+  - "architect"
+  - "platform-team"
+level: "advanced"
+status: "active"
+owner: "praxis-ui"
+source_of_truth:
+  - "projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts"
+  - "projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts"
+  - "projects/praxis-dynamic-fields/src/lib/services/component-preloader.service.ts"
+source_of_truth_last_verified: "2026-03-06"
+last_updated: "2026-03-06"
+toc: true
+sidebar: true
+tags:
+  - "json-api"
+  - "canonical-contract"
+  - "pdx-preload-status"
+api_stability: "canonical"
+schema_verified: true
+runtime_verified: true
+editor_coverage_verified: false
+runtime_scope: "public"
+legacy_paths_present: false
+has_known_mismatches: false
+related_components:
+  - "praxis-table"
+---
+
+# pdx-preload-status
+
+Este documento e a referencia canonica da API JSON de pdx-preload-status.
+
+## Summary
+
+- Tipo documental: API reference canonica de contrato JSON.
+- Source of truth: runtime e codigo declarados no frontmatter.
+- Objetivo operacional: consulta rapida, auditavel e deterministica sob pressao.
+- Resumo funcional: Contrato JSON metadata-driven com comportamento definido por runtime e schema associado.
+
+## Purpose and scope
+
+- O componente consome payload JSON metadata-driven e expoe comportamento runtime configuravel por contrato.
+- Esta referencia cobre contrato publico, classificacao de paths e semantica de cobertura (runtime/schema/editor).
+- Fora de escopo: quickstart, tutorial narrativo e notas arquiteturais que nao alteram contrato publico.
+
+## Consulta rapida (obrigatorio)
+
+| Regra/tema | Observado | Canonico desejado | Status | Evidencia |
+| --- | --- | --- | --- | --- |
+| Component id | `pdx-preload-status` | Manter ID canonico estavel e versionado por contrato | Active | frontmatter.component |
+| Primary contract source | `runtime-and-code` | Runtime, schema e docs devem permanecer rastreaveis | Partial | frontmatter.contract_source + source_of_truth |
+| Runtime coverage | `true` | Comportamentos runtime criticos devem ficar explicitamente verificados | Active | `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts` |
+| Schema/type coverage | `true` | Tipos e schema devem refletir paths publicos do contrato | Active | source_of_truth + Detailed API reference |
+| Editor/tooling coverage | `false` | Editor/tooling deve espelhar somente contrato publico suportado | Not-covered | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-core/src/lib/utils/inline-filter-controls.util.ts` |
+| Legacy paths | `false` | Segregar legado de caminhos canonicos com janela de migracao | Active | frontmatter.legacy_paths_present |
+| Known mismatches | `false` | Registrar observed vs desired de forma auditavel | Active | frontmatter.has_known_mismatches |
+
+## Source of truth
+
+| Source | Kind | Notes |
+| --- | --- | --- |
+| projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts | schema-metadata | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/services/component-preloader.service.ts | runtime-service | Arquivo presente no repositorio e usado como evidencia de contrato. |
+
+## Support legend
+
+- **Active**: suportado em runtime e liberado para uso externo.
+- **Partial**: suporte parcial, com restricoes, lacunas ou validacao incompleta.
+- **Declared-only**: declarado em tipos/schema sem evidencia operacional completa.
+- **Schema-only**: presente em schema/tipos sem cobertura runtime confirmada.
+- **Deprecated**: legado suportado por janela de migracao definida.
+
+## Contract status snapshot
+
+| Item | Value | Notes |
+| --- | --- | --- |
+| Reference mode | `canonical` | Deve permanecer canonico |
+| Contract format | `json` | Contrato metadata-driven |
+| Contract source | `runtime-and-code` | Alinhar com source_of_truth |
+| Runtime scope | `public` | Escopo publicado para consumidores |
+| Runtime verified | `true` | Revisar sempre com evidencia de runtime |
+| Schema verified | `true` | Revisar sempre com evidencia de tipos/schema |
+| Editor coverage verified | `false` | Revisar sempre com evidencia de editor/tooling |
+| Legacy paths present | `false` | Segregar legado de contrato canonico |
+| Has known mismatches | `false` | Divergencias devem aparecer em secao dedicada |
+
+## Contract classification (obrigatorio)
+
+### Canonical paths (public contract)
+
+| Path | Type | Required | Default | Status | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `visible` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.*` | object | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+
+### Supported legacy paths
+
+Nenhum path legado suportado foi identificado nesta revisao.
+
+### Internal-only paths
+
+Nao ha paths internal-only confirmados no contrato publico desta revisao.
+
+### Experimental paths
+
+Nao ha paths experimentais confirmados no contrato publico desta revisao.
+
+## Public contract surface (obrigatorio)
+
+### Top-level configuration blocks
+
+| Block | Purpose | Required | Merge strategy | Notes |
+| --- | --- | --- | --- | --- |
+| `metadata` | Payload declarativo opcional para contexto do widget | false | deep-merge | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `visible` | Override de visibilidade no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+
+### Nested configuration blocks
+
+| Path | Type | Required | Default | Constraints | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata.*` | object | false | n/a | component-defined | Partial; verify per source_of_truth. |
+
+### Input bindings (inbound data)
+
+| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | false | host-json | component-defined | Optional inbound context payload. |
+| `visible` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
+
+### Output events
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `none-explicitly-documented` | n/a | n/a | Declared-only | Nenhum output publico foi explicitamente documentado na evidencia preservada. |
+
+### External side channels
+
+| Channel | Direction | Contract | Failure mode | Notes |
+| --- | --- | --- | --- | --- |
+| `setExternalControl(AbstractControl)` | inbound | boolean bridge via `control.valueChanges` | No external binding when control is absent | Integration hook; not a canonical JSON path. |
+
+### Host/runtime dependencies
+
+| Dependency | Required | Environment | Purpose | Notes |
+| --- | --- | --- | --- | --- |
+| `preload-status.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts`. |
+| `preload-status.metadata.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts`. |
+| `component-preloader.service.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/services/component-preloader.service.ts`. |
+
+## Coverage by surface (obrigatorio)
+
+### Coverage matrix (runtime, schema/type, editor/tooling)
+
+| Surface | Verified | Coverage status | Evidence | Notes |
+| --- | --- | --- | --- | --- |
+| Runtime | `true` | Active | `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts` | Core runtime flows verified via focused component specs on 2026-03-06; editor/tooling coverage remains independent. |
+| Schema/Types | `true` | Active | source_of_truth + Detailed API reference | Inputs in metadata source align with canonical public JSON paths (`metadata`, `visible`). |
+| Editor/Tooling | `false` | Not-covered | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-core/src/lib/utils/inline-filter-controls.util.ts` | `pdx-preload-status` nao aparece no selector map default nem no alias map inline; cobertura de editor/tooling permanece nao confirmada. |
+
+### Runtime coverage boundaries
+
+- Ambientes suportados: browser/dev/prod; SSR/hydration appears to be component-dependent unless explicitly verified.
+- Pre-condicoes: payload JSON valido, bindings de host consistentes e dependencias descritas no source_of_truth.
+- Fora de cobertura confirmada: caminhos internos, experimentais ou aliases nao enumerados formalmente.
+
+### Editor and tooling notes
+
+- Estado atual: `pdx-preload-status` nao esta mapeado no selector tooling padrao (`DEFAULT_FIELD_SELECTOR_CONTROL_TYPE_MAP`) nem no alias tooling inline; manter `Not-covered` ate existir integracao verificavel.
+- O que esta exposto no editor visual depende da cobertura real do workspace e nao deve ser inferido como suporte runtime total.
+- Campos disponiveis apenas via JSON/manual devem continuar no contrato, com rotulo explicito de cobertura parcial.
+- Quando houver divergencia entre editor e runtime, manter mismatch rastreavel em secao dedicada.
+
+## Resolution and precedence model (obrigatorio)
+
+### Merge order
+
+1. defaults do componente
+2. contrato JSON recebido
+3. overrides de host/runtime
+4. normalizacoes internas
+
+### Fallback order
+
+contrato explicito -> aliases legados (quando suportados) -> defaults internos -> comportamento seguro
+
+### Override points
+
+- inputs publicos do componente
+- configuracao JSON de runtime
+- integracoes de host (servicos/tokens/adapters)
+
+### Runtime normalization
+
+Alias e defaults devem convergir para paths canonicos; onde nao houver evidencia, manter not-yet-verified de forma explicita.
+
+### Precedence rules
+
+Em conflito entre alias legado e path canonico, priorizar path canonico e registrar janela de migracao do legado.
+
+## Validation and error semantics (obrigatorio)
+
+### Validation model
+
+| Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
+| --- | --- | --- | --- | --- |
+| canonical-paths | parse/runtime | component-defined (warn/reject/default) | not-yet-standardized | Semantica detalhada preservada na referencia tecnica por componente. |
+
+### Invalid and unknown field handling
+
+- Campos desconhecidos: comportamento component-defined (ignore, warn ou reject).
+- Tipos invalidos: pode haver fallback, warning ou falha, conforme runtime especifico.
+- Valores fora de dominio: registrar observed vs desired em Known limitations and mismatches.
+
+### Fail-open / fail-closed behavior
+
+| Condition | Mode | Runtime behavior | Consumer impact |
+| --- | --- | --- | --- |
+| invalid-or-unknown-field | component-defined | not-yet-verified | Pode gerar warning, fallback silencioso ou rejeicao; validar por componente. |
+
+### Runtime warnings vs hard failures
+
+| Condition | Severity | Observability | Consumer action |
+| --- | --- | --- | --- |
+| partial-or-declared-only-coverage | warning | logs/eventos do componente | Confirmar ligacao runtime antes de uso critico. |
+| mismatch-confirmed | error-or-warning | componente/host observability | Planejar migracao e corrigir contrato/runtime. |
+
+## Detailed API reference
+### Preserved technical reference (normalized from previous revision)
+
+### 1. Visao Geral e Quando Usar
+`pdx-preload-status` e um widget de observabilidade do preload de componentes de `dynamic-fields`.
+
+Use quando precisar:
+- monitorar progresso de preload em ambiente de desenvolvimento/homologacao;
+- diagnosticar falhas de componentes no carregamento antecipado;
+- oferecer controle manual de recarga (`forceReload`).
+- expor monitoramento tecnico em dashboards operacionais.
+
+### 2. API do Componente (Inputs/Outputs)
+| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
+| --- | --- | --- | --- | --- |
+| `metadata` | `any` | `null` | Nao | Entrada opcional para metadados auxiliares do host. |
+| `visible` | `boolean` | `true` | Nao | Controla exibicao do widget (`display:none` quando `false`). |
+| `setExternalControl(control)` | `AbstractControl` | - | Metodo | Vincula controle externo para ligar/desligar auto-update. |
+
+Observacao:
+- este widget e standalone/observabilidade; nao e resolvido pelo `FieldControlType` do `ComponentRegistryService`.
+
+### 3. Matriz de Cobertura JSON (Completa)
+#### 3.1 Campos especificos do componente
+| Caminho JSON | Tipo | Status | Comportamento em runtime |
+| --- | --- | --- | --- |
+| `metadata.*` | `object` | Ativo | Campo de transporte para contexto de dashboard/host. |
+| `visible` | `boolean` | Ativo | Oculta/mostra o widget no host. |
+
+Nota:
+- `setExternalControl(control)` e hook de integracao runtime (nao JSON path canonico). O valor do `AbstractControl` externo sincroniza `autoUpdate`.
+
+#### 3.2 Campos herdados compartilhados (exaustivo)
+Nao se aplica como campo de formulario padrao.
+
+Resumo de composicao deste componente:
+- `Ativo`: leitura de `status$`, reload manual, toggle de auto-update.
+- `Ativo`: entrada de visibilidade e integracao com controle externo.
+
+### 4. Mapeamento de Comportamento
+- `ngOnInit` assina `status$` do `ComponentPreloaderService`.
+- `autoUpdate=true`: assinatura continua em tempo real.
+- `autoUpdate=false`: carrega snapshot atual do status.
+- `forceReload()` dispara novo preload pelo service.
+- `setExternalControl(control)` pode ser chamado antes ou depois do init; o binding externo e refeito sem acumular listeners.
+- alternar `autoUpdate` nao acumula subscriptions; o modo anterior e encerrado antes de aplicar o novo.
+
+### 5. Exemplo Minimo (JSON + Uso)
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true
+}
+```
+Uso: painel tecnico standalone em ambiente de debug.
+
+### 6. Exemplo Corporativo (JSON + Uso)
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true,
+  "metadata": {
+    "dashboard": "platform-observability",
+    "tenant": "corp"
+  },
+  "autoUpdateBinding": {
+    "type": "FormControl<boolean>",
+    "initialValue": true
+  }
+}
+```
+Uso: dashboard tecnico com toggle centralizado de auto-update.
+
+### 7. Troubleshooting e Armadilhas Comuns
+1. Nao aparece progresso.
+Correcao: verificar se `ComponentPreloaderService` esta registrado e emitindo `status$`.
+
+2. Auto-update nao segue controle externo.
+Correcao: confirmar chamada de `setExternalControl()` e que o `FormControl` externo esta emitindo `valueChanges`.
+
+3. Reload manual sem efeito.
+Correcao: checar implementacao de `forceReload()` no service.
+
+4. Esperar comportamento de campo de formulario.
+Correcao: este componente e widget de monitoramento standalone, nao input de negocio carregado por `controlType`.
+
+5. Falhas repetidas de preload.
+Correcao: revisar `status.errors[]` e componentes listados no service.
+
+### 8. Cross-links
+- `projects/praxis-dynamic-fields/src/lib/services/component-preloader.service.ts`
+
+### 9. Relatorio de Validacao Estrutural
+- Visao geral: PASS
+- API (inputs/outputs): PASS
+- Cobertura JSON completa (especifico + herdado): PASS
+- Mapeamento de comportamento: PASS
+- Exemplo minimo: PASS
+- Exemplo corporativo: PASS
+- Troubleshooting: PASS
+
+## JSON path index (obrigatorio)
+
+| Path | Type | Required | Default | Status | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata` | object | false | n/a | Partial | See Detailed API reference. |
+| `visible` | boolean | false | n/a | Partial | See Detailed API reference. |
+| `metadata.*` | object | false | n/a | Partial | See Detailed API reference. |
+
+## Events reference (obrigatorio)
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `none-explicitly-documented` | n/a | n/a | Declared-only | Nenhum output publico explicitamente documentado. |
+
+## Styling API (obrigatorio quando aplicavel)
+
+| Token/Class | Scope | Purpose | Notes |
+| --- | --- | --- | --- |
+| `not-yet-verified` | component | Styling contract not yet verified | Use Detailed API reference for component-specific styling notes. |
+
+## Examples (obrigatorio)
+
+| Example | Scenario | Validates | Notes |
+| --- | --- | --- | --- |
+| `Minimal valid` | baseline payload | required contract blocks | Extracted from preserved technical reference when available. |
+| `Common setup` | common component usage | standard runtime behavior | Validate against host integration path. |
+| `Advanced setup` | richer config with overrides | precedence and normalization | Requires runtime confirmation for edge cases. |
+| `Enterprise scenario` | governance/legacy/migration context | auditability and compatibility boundaries | Include tenant-specific constraints when applicable. |
+
+### Minimal valid
+
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true,
+  "metadata": {}
+}
+```
+
+### Common setup
+
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true,
+  "metadata": {
+    "dashboard": "platform-observability",
+    "tenant": "corp",
+    "label": "pdx-preload-status-common-1"
+  },
+  "autoUpdateBinding": {
+    "type": "FormControl<boolean>",
+    "initialValue": true
+  }
+}
+```
+
+### Advanced setup
+
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true,
+  "metadata": {
+    "dashboard": "platform-observability",
+    "tenant": "corp",
+    "label": "pdx-preload-status-advanced-2"
+  },
+  "autoUpdateBinding": {
+    "type": "FormControl<boolean>",
+    "initialValue": true
+  }
+}
+```
+
+### Enterprise scenario
+
+```json
+{
+  "widgetId": "pdx-preload-status",
+  "visible": true,
+  "metadata": {
+    "dashboard": "platform-observability",
+    "tenant": "corp",
+    "label": "pdx-preload-status-enterprise-3"
+  },
+  "autoUpdateBinding": {
+    "type": "FormControl<boolean>",
+    "initialValue": true
+  }
+}
+```
+
+## Compatibility and migration notes (recomendado)
+
+| Concern | Affected versions | Migration action | Deadline | Notes |
+| --- | --- | --- | --- | --- |
+| No legacy path detected in current revision | n/a | No migration action required for canonical paths | n/a | Re-evaluate if backward-compat aliases are introduced |
+
+## Known limitations and mismatches (recomendado)
+
+| Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
+| --- | --- | --- | --- | --- | --- |
+| Canonical contract parity | No confirmed mismatch in this revision; runtime linkage verified for core flows (2026-03-06), with editor/tooling coverage pending | Keep runtime/schema/editor alignment evidence updated | Low | n/a | Monitor in periodic audit |
+
+## Source references (obrigatorio)
+
+| Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
+| --- | --- | --- | --- | --- |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| schema-metadata | projects/praxis-dynamic-fields/src/lib/components/preload-status/preload-status.metadata.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| runtime-service | projects/praxis-dynamic-fields/src/lib/services/component-preloader.service.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |