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

package/src/lib/components/material-button/pdx-material-button.json-api.md

@@ -0,0 +1,572 @@
+---
+title: "pdx-material-button JSON API (Canonical)"
+slug: "pdx-material-button-json-api"
+doc_type: "api-reference"
+component: "pdx-material-button"
+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-material-button."
+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/material-button/material-button.metadata.ts"
+  - "projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.ts"
+  - "projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.html"
+  - "projects/praxis-dynamic-fields/src/lib/base/simple-base-button.component.ts"
+  - "projects/praxis-core/src/lib/models/material-field-metadata.interface.ts"
+source_of_truth_last_verified: "2026-03-06"
+last_updated: "2026-03-06"
+toc: true
+sidebar: true
+tags:
+  - "json-api"
+  - "canonical-contract"
+  - "pdx-material-button"
+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-material-file-upload"
+---
+
+# pdx-material-button
+
+Este documento e a referencia canonica da API JSON de pdx-material-button.
+
+## 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-material-button` | 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/material-button/material-button.metadata.ts`, `projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.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 | Partial | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.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/material-button/material-button.metadata.ts | schema-metadata | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.html | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-dynamic-fields/src/lib/base/simple-base-button.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
+| projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | schema-types | 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 | true | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.controlType` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.label` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.variant` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.icon` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.disableRipple` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.action` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
+| `metadata.routerLink` | string | 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 principal do componente | true | deep-merge | runtime linkage verified for core flows (component specs, 2026-03-06). |
+| `materialDesign` | Configuracao especifica de runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
+
+### Nested configuration blocks
+
+| Path | Type | Required | Default | Constraints | Notes |
+| --- | --- | --- | --- | --- | --- |
+| `metadata.controlType` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.label` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.variant` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.icon` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.disableRipple` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.action` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.routerLink` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.link` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.href` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
+| `metadata.confirmDialog` | unknown | 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 | true | host-json | component-defined | Primary inbound contract payload. |
+
+### Output events
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `actionExecuted` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+| `click` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+| `focusChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
+
+### External side channels
+
+| Channel | Direction | Contract | Failure mode | Notes |
+| --- | --- | --- | --- | --- |
+| `host/services/storage` | bidirectional | component-defined | component-defined | Side channels variam por componente e host; verificar em source_of_truth. |
+
+### Host/runtime dependencies
+
+| Dependency | Required | Environment | Purpose | Notes |
+| --- | --- | --- | --- | --- |
+| `material-button.metadata.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.metadata.ts`. |
+| `material-button.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.ts`. |
+| `material-button.component.html` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.html`. |
+| `simple-base-button.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/base/simple-base-button.component.ts`. |
+| `material-field-metadata.interface.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-core/src/lib/models/material-field-metadata.interface.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/material-button/material-button.metadata.ts`, `projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.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 | Reconcile schema/types with canonical paths during follow-up when needed. |
+| Editor/Tooling | `false` | Partial | `projects/praxis-core/src/lib/metadata/field-selector-control-type.constants.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.ts` | Selector/control-type tooling linkage verified via default selector map and registry seeding; visual editor end-to-end coverage remains not-yet-verified. |
+
+### 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
+
+- Evidencia de tooling: selector `pdx-*` mapeado em `DEFAULT_FIELD_SELECTOR_CONTROL_TYPE_MAP` e semeado no `ComponentRegistryService`; editor visual E2E permanece not-yet-verified.
+- 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-material-button` e um botao orientado por JSON com variantes Material, execucao de acao e suporte a loading/atalho.
+
+Use quando precisar:
+- CTA configuravel por contrato (navegacao, link, acao custom);
+- variantes visuais (`basic`, `raised`, `stroked`, `flat`, `icon`, `fab`, `mini-fab`);
+- padrao corporativo de acao com telemetria/atalhos.
+
+### 2. API do Componente (Inputs/Outputs)
+| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
+| --- | --- | --- | --- | --- |
+| `metadata` | `MaterialButtonMetadata` | - | Sim | Contrato principal do botao. |
+| `actionExecuted` | `any` | - | Output base button | Resultado da acao executada. |
+| `click` | `MouseEvent` | - | Output base button | Clique do botao antes/apos pipeline de acao. |
+| `focusChange` | `boolean` | - | Output base button | Mudanca de foco. |
+
+### 3. Matriz de Cobertura JSON (Completa)
+#### 3.1 Campos especificos do componente
+| Caminho JSON | Tipo | Status | Comportamento em runtime |
+| --- | --- | --- | --- |
+| `metadata.controlType` | `'button'` | Ativo | Define renderer de botao Material. |
+| `metadata.label` | `string` | Ativo | Texto principal do botao. |
+| `metadata.variant` | `'raised' \| 'stroked' \| 'flat' \| 'icon' \| 'fab' \| 'mini-fab'` | Ativo | Determina tipo de botao Material renderizado. |
+| `metadata.icon` | `string` | Ativo | Icone principal do botao. |
+| `metadata.disableRipple` | `boolean` | Ativo | Desativa ripple visual do botao. |
+| `metadata.action` | `string \| any` | Ativo | Acao custom no pipeline de execucao do base button. |
+| `metadata.routerLink` | `string` | Ativo | Navegacao interna via `router.navigateByUrl`. |
+| `metadata.link` / `metadata.href` | `string` | Ativo | Abre link externo em nova aba. |
+| `metadata.confirmDialog` | `{ title; message; ... }` | Ativo | Exige confirmacao antes de executar acao. |
+| `metadata.shortcut` | `string` | Extensao de runtime | Registra atalho de teclado quando `KeyboardShortcutService` existe. |
+| `metadata.loading` | `boolean` | Ativo | Exibe estado de loading herdado do base button. |
+| `metadata.loadingText` | `string` | Ativo | Texto alternativo durante loading. |
+| `metadata.description` | `string` | Ativo | Tooltip e descricao auxiliar do botao. |
+| `metadata.buttonIconPosition` | `'before' \| 'after'` | Declared-only | Declarado na interface, sem branch visual dedicada no template atual. |
+| `metadata.color` | `ThemePalette` | Parcial | Cor principal vem de `materialDesign.color`; `color` tipado pode nao dominar sozinho. |
+| `metadata.confirmationMessage` | `string` | Declared-only | Interface tipada nao e convertida automaticamente para `confirmDialog`. |
+| `metadata.confirmationTitle` | `string` | Declared-only | Interface tipada nao e convertida automaticamente para `confirmDialog`. |
+| `metadata.confirmationButtons` | `object` | Declared-only | Interface tipada nao e convertida automaticamente para `confirmDialog`. |
+
+#### 3.2 Campos herdados compartilhados (exaustivo)
+Contrato compartilhado de botao base:
+- pipeline de acao (`navigation`, `external-link`, `custom`), loading e debounce de clique em `SimpleBaseButtonComponent`.
+
+Resumo de composicao deste componente:
+- `Ativo`: variantes visuais, acoes, loading, tooltip, atalho.
+- `Parcial`: resolucao de cor entre `color` e `materialDesign.color`.
+- `Declared-only`: bloco `confirmation*` da interface tipada sem mapper dedicado.
+
+### 4. Mapeamento de Comportamento
+- `handleClick`:
+  1. valida debounce/disabled/loading,
+  2. emite `click`,
+  3. resolve tipo de acao,
+  4. executa pipeline (com confirmacao opcional),
+  5. emite `actionExecuted`.
+- Variantes: template possui branch dedicada para cada `variant`.
+- Icon-only: `icon/fab/mini-fab` ajustam aria-label e exibicao de texto.
+
+### 5. Exemplo Minimo (JSON + Uso)
+```json
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "saveBtn",
+    "label": "Salvar",
+    "controlType": "button",
+    "variant": "raised",
+    "icon": "mi:save",
+    "action": "save"
+  }
+}
+```
+Uso: botao de acao simples com variante raised.
+
+### 6. Exemplo Corporativo (JSON + Uso)
+```json
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "approveBtn",
+    "label": "Aprovar Contrato",
+    "controlType": "button",
+    "variant": "stroked",
+    "icon": "mi:check_circle",
+    "disableRipple": false,
+    "routerLink": "/contracts/approval",
+    "shortcut": "Ctrl+Shift+A",
+    "description": "Executa fluxo de aprovacao corporativa",
+    "confirmDialog": {
+      "title": "Confirmar aprovacao",
+      "message": "Deseja aprovar este contrato agora?",
+      "confirmLabel": "Aprovar",
+      "cancelLabel": "Cancelar"
+    },
+    "materialDesign": {
+      "color": "primary"
+    }
+  }
+}
+```
+Uso: CTA corporativo com confirmacao e atalho de teclado.
+
+### 7. Troubleshooting e Armadilhas Comuns
+1. Esperar confirmacao por `confirmationMessage`/`confirmationTitle`.
+Correcao: runtime base usa `confirmDialog`; mapear explicitamente esse bloco.
+
+2. Cor nao aplica conforme esperado.
+Correcao: priorizar `materialDesign.color` no payload final.
+
+3. Atalho nao dispara.
+Correcao: verificar disponibilidade de `KeyboardShortcutService` no host.
+
+4. Acao nao executa por duplo clique rapido.
+Correcao: comportamento esperado por debounce interno do base button.
+
+5. Icone nao muda de posicao por `buttonIconPosition`.
+Correcao: campo tipado sem branch visual dedicada no template atual.
+
+### 8. Cross-links
+- `projects/praxis-dynamic-fields/src/lib/components/material-file-upload/pdx-material-file-upload.json-api.md`
+- `projects/praxis-table/src/lib/praxis-table.json-api.md`
+
+### 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 | true | n/a | Partial | See Detailed API reference. |
+| `metadata.controlType` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.label` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.variant` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.icon` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.disableRipple` | boolean | false | n/a | Partial | See Detailed API reference. |
+| `metadata.action` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.routerLink` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.link` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.href` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.confirmDialog` | unknown | false | n/a | Partial | See Detailed API reference. |
+| `metadata.shortcut` | unknown | false | n/a | Partial | See Detailed API reference. |
+| `metadata.loading` | unknown | false | n/a | Partial | See Detailed API reference. |
+| `metadata.loadingText` | unknown | false | n/a | Partial | See Detailed API reference. |
+| `metadata.description` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.buttonIconPosition` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.color` | string | false | n/a | Partial | See Detailed API reference. |
+| `materialDesign.color` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.confirmationMessage` | string | false | n/a | Partial | See Detailed API reference. |
+| `metadata.confirmationTitle` | string | false | n/a | Partial | See Detailed API reference. |
+
+## Events reference (obrigatorio)
+
+| Event | Payload | Trigger | Stability | Notes |
+| --- | --- | --- | --- | --- |
+| `actionExecuted` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+| `click` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+| `focusChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
+
+## Styling API (obrigatorio quando aplicavel)
+
+| Token/Class | Scope | Purpose | Notes |
+| --- | --- | --- | --- |
+| `metadata.variant` | component | Styling-related JSON path | Validate against runtime implementation. |
+| `metadata.icon` | component | Styling-related JSON path | Validate against runtime implementation. |
+| `metadata.buttonIconPosition` | component | Styling-related JSON path | Validate against runtime implementation. |
+| `metadata.color` | component | Styling-related JSON path | Validate against runtime implementation. |
+| `materialDesign.color` | component | Styling-related JSON path | Validate against runtime implementation. |
+
+## 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
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "saveBtn",
+    "label": "Salvar",
+    "controlType": "button",
+    "variant": "raised",
+    "icon": "mi:save",
+    "action": "save",
+    "disableRipple": false
+  }
+}
+```
+
+### Common setup
+
+```json
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "approveBtn",
+    "label": "pdx-material-button-common",
+    "controlType": "button",
+    "variant": "stroked",
+    "icon": "mi:check_circle",
+    "disableRipple": false,
+    "routerLink": "/contracts/approval",
+    "shortcut": "Ctrl+Shift+A",
+    "description": "Executa fluxo de aprovacao corporativa",
+    "confirmDialog": {
+      "title": "Confirmar aprovacao",
+      "message": "Deseja aprovar este contrato agora?",
+      "confirmLabel": "Aprovar",
+      "cancelLabel": "Cancelar"
+    },
+    "materialDesign": {
+      "color": "primary"
+    }
+  }
+}
+```
+
+### Advanced setup
+
+```json
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "approveBtn",
+    "label": "pdx-material-button-advanced",
+    "controlType": "button",
+    "variant": "stroked",
+    "icon": "mi:check_circle",
+    "disableRipple": false,
+    "routerLink": "/contracts/approval",
+    "shortcut": "Ctrl+Shift+A",
+    "description": "Executa fluxo de aprovacao corporativa",
+    "confirmDialog": {
+      "title": "Confirmar aprovacao",
+      "message": "Deseja aprovar este contrato agora?",
+      "confirmLabel": "Aprovar",
+      "cancelLabel": "Cancelar"
+    },
+    "materialDesign": {
+      "color": "primary"
+    }
+  }
+}
+```
+
+### Enterprise scenario
+
+```json
+{
+  "componentId": "pdx-material-button",
+  "metadata": {
+    "name": "approveBtn",
+    "label": "pdx-material-button-enterprise",
+    "controlType": "button",
+    "variant": "stroked",
+    "icon": "mi:check_circle",
+    "disableRipple": false,
+    "routerLink": "/contracts/approval",
+    "shortcut": "Ctrl+Shift+A",
+    "description": "Executa fluxo de aprovacao corporativa",
+    "confirmDialog": {
+      "title": "Confirmar aprovacao",
+      "message": "Deseja aprovar este contrato agora?",
+      "confirmLabel": "Aprovar",
+      "cancelLabel": "Cancelar"
+    },
+    "materialDesign": {
+      "color": "primary"
+    }
+  }
+}
+```
+
+## 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 |
+| --- | --- | --- | --- | --- |
+| schema-metadata | projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.metadata.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/components/material-button/material-button.component.html | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| runtime-code | projects/praxis-dynamic-fields/src/lib/base/simple-base-button.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
+| schema-types | projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |