---
title: "praxis-field-shell JSON API (Canonical)"
slug: "praxis-field-shell-json-api"
doc_type: "api-reference"
component: "praxis-field-shell"
document_kind: "json-api-canonical"
reference_mode: "canonical"
contract_format: "json"
contract_source: "runtime-and-code"
description: "Referencia canonica do contrato JSON do componente praxis-field-shell."
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/field-shell/field-shell.component.ts"
  - "projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts"
  - "projects/praxis-dynamic-fields/src/lib/utils/format-display.util.ts"
  - "projects/praxis-core/src/lib/models/component-metadata.interface.ts"
  - "projects/praxis-core/src/lib/models/field-presentation.model.ts"
source_of_truth_last_verified: "2026-06-25"
last_updated: "2026-06-25"
toc: true
sidebar: true
tags:
  - "json-api"
  - "canonical-contract"
  - "praxis-field-shell"
api_stability: "canonical"
schema_verified: true
runtime_verified: true
editor_coverage_verified: false
runtime_scope: "public"
legacy_paths_present: true
has_known_mismatches: false
related_components:
  - "praxis-table"
---

# praxis-field-shell

Este documento e a referencia canonica da API JSON de praxis-field-shell.

## 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 | `praxis-field-shell` | 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/field-shell/field-shell.component.ts`, `projects/praxis-dynamic-fields/src/lib/utils/field-state.util.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 | `true` | Segregar legado de caminhos canonicos com janela de migracao | Partial | 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/field-shell/field-shell.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
| projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
| projects/praxis-dynamic-fields/src/lib/utils/format-display.util.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
| projects/praxis-core/src/lib/models/component-metadata.interface.ts | schema-types | Arquivo presente no repositorio e usado como evidencia de contrato. |
| projects/praxis-core/src/lib/models/field-presentation.model.ts | schema-types/runtime-helper | Resolve `presentation` e `presentationRules` para presentationMode sem mutar valores. |

## 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 | `true` | 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. |
| `visible` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `canvasMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `field` | object | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `field.hidden` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `field.formHidden` | unknown | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `field.readonly` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
| `field.readOnly` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |

### Supported legacy paths

| Legacy path | Canonical replacement | Support window | Runtime behavior | Notes |
| --- | --- | --- | --- | --- |
| `metadata.readOnly` | `metadata.readonly` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |
| `metadata.formHidden` | `metadata.boolean` | not-yet-defined | accepted for backward compatibility | Alias inferido da evidencia preservada; validar em runtime. |

### 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). |
| `visible` | Override de visibilidade no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
| `canvasMode` | Configuracao especifica de runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
| `field` | Configuracao especifica de runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
| `presentationMode` | Renderizacao de apresentacao sem interacao | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
| `readonlyMode` | Override de readonly no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
| `disabledMode` | Override de disabled 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 |
| --- | --- | --- | --- | --- | --- |
| `field.hidden` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.formHidden` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.readonly` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.readOnly` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.disabled` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.controlType` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.controlType='avatar'` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.transformDisplayValue` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
| `field.valuePresentation` | object | false | n/a | component-defined | Canonical value formatter for readonly/display surfaces. |
| `field.presentation` | object | false | n/a | component-defined | Semantic readonly/display presentation state. |
| `field.presentationRules` | array | false | n/a | component-defined | Ordered Json Logic rules that override semantic presentation state. |

### Input bindings (inbound data)

| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
| --- | --- | --- | --- | --- | --- |
| `metadata` | object | true | host-json | component-defined | Primary inbound contract payload. |
| `visible` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
| `presentationMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
| `readonlyMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
| `disabledMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |

### Output events

| Event | Payload | Trigger | Stability | Notes |
| --- | --- | --- | --- | --- |
| `canvasMouseEnter` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
| `canvasMouseLeave` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
| `canvasClick` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
| `canvasFocus` | unknown | focusin runtime-event | Experimental | Emitted when a projected field receives focus in canvas mode so `praxis-dynamic-form` can select the field and show the canonical canvas toolbar. |

### 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 |
| --- | --- | --- | --- | --- |
| `field-shell.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/field-shell/field-shell.component.ts`. |
| `field-state.util.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts`. |
| `format-display.util.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/utils/format-display.util.ts`. |
| `component-metadata.interface.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-core/src/lib/models/component-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/field-shell/field-shell.component.ts`, `projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts` | Core runtime flows verified via focused component specs on 2026-05-18, including canvas focus selection; 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` | 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` | `praxis-field-shell` 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: `praxis-field-shell` 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
`praxis-field-shell` e o invólucro interno usado pelo loader dinamico para montar cada campo em runtime.

Use quando precisar:
- entender como estados (`visible`, `readonly`, `disabled`, `presentation`) sao resolvidos no host;
- customizar o container por `itemTemplate` sem reimplementar o campo;
- integrar eventos de canvas (`canvasMode`) no page builder.

### 2. API do Componente (Inputs/Outputs)
| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
| --- | --- | --- | --- | --- |
| `field` | `FieldMetadata` | - | Sim | Metadados do campo renderizado dentro do shell. |
| `index` | `number` | - | Sim | Indice do campo na lista da diretiva. |
| `control` | `AbstractControl \| null` | `null` | Nao | Controle reativo associado ao campo. |
| `readonlyMode/disabledMode/visible/presentationMode` | `boolean` | `false/false/true/false` | Nao | Overrides de estado vindos do host/container. |
| `canvasMode` | `boolean` | `false` | Nao | Ativa eventos de interacao para canvas/editor visual. |
| `itemTemplate` | `TemplateRef` | - | Nao | Template opcional para envelopar o conteudo do campo. |
| `canvasMouseEnter` | `FieldMetadata` | - | Output | Emitido no hover quando `canvasMode=true`. |
| `canvasMouseLeave` | `void` | - | Output | Emitido no mouseleave quando `canvasMode=true`. |
| `canvasClick` | `FieldMetadata` | - | Output | Emitido no click quando `canvasMode=true`. |

### 3. Matriz de Cobertura JSON (Completa)
#### 3.1 Campos especificos do componente
| Caminho JSON | Tipo | Status | Comportamento em runtime |
| --- | --- | --- | --- |
| `field.hidden` | `boolean` | Ativo | Quando `true`, `effectiveVisible=false` no host. |
| `field.formHidden` | `boolean` | Ativo | Alias para ocultar campo no shell. |
| `field.readonly` / `field.readOnly` | `boolean` | Ativo | Entra no calculo de `effectiveReadonlyMode`. |
| `field.disabled` | `boolean` | Ativo | Entra no calculo de `effectiveDisabledMode`. |
| `field.controlType` | `string` | Ativo | Define atributos de host e regra especial de apresentacao. |
| `field.controlType='avatar'` | `string` | Ativo | Mantem conteudo do campo visivel mesmo em presentation mode. |
| `field.transformDisplayValue` | `(value)=>any` | Parcial | Hook valido apenas quando injetado como funcao em runtime (nao serializavel em JSON puro). |
| `field.label/name` | `string` | Ativo | Base do rotulo exibido no bloco de apresentacao. |

Notas de runtime:
- `computeEffectiveState` combina metadado + overrides de input.
- Em `presentationMode`, o shell renderiza HTML formatado por `formatDisplayHtml`.

#### 3.2 Campos herdados compartilhados (exaustivo)
Contrato amplo de campos dinamicos:
- `projects/praxis-core/src/lib/models/component-metadata.interface.ts`

Resumo de composicao deste componente:
- `Ativo`: envelope visual/comportamental, calculo de estado e apresentacao.
- `Parcial`: `transformDisplayValue` exige metadado enriquecido em codigo (funcao real).

### 4. Mapeamento de Comportamento
- Sempre cria o `insertionPoint` (`vc`) para o componente real do campo.
- Em modo apresentacao sem excecao de tipo, esconde conteudo editavel e mostra bloco textual.
- Em modo apresentacao, `field.valuePresentation` formata o valor e `field.presentation`/`field.presentationRules` ajustam presenter, tone, icon, label, badge, tooltip e appearance por semantica declarativa.
- `presentationRules` sao avaliadas com Json Logic contra o contexto do campo. Regras invalidas falham fechadas e nao alteram o `FormControl`.
- `readonlyMode` aplica overlay bloqueando interacao, mantendo controle habilitado.
- `canvasMode` injeta semantica de evento para editores visuais.

### 5. Exemplo Minimo (JSON + Uso)
```json
{
  "field": {
    "name": "status",
    "label": "Status",
    "controlType": "select"
  },
  "visible": true,
  "presentationMode": false
}
```
Uso: shell padrao para um campo dinamico simples.

### 6. Exemplo Corporativo (JSON + Uso)
```json
{
  "field": {
    "id": "f-approval-status",
    "name": "approvalStatus",
    "label": "Aprovacao",
    "controlType": "select",
    "readOnly": true,
    "presentation": {
      "presenter": "status",
      "tone": "neutral",
      "icon": "schedule",
      "label": "Em analise"
    },
    "presentationRules": [
      {
        "when": { "===": [{ "var": "value" }, "BLOQUEADO"] },
        "set": {
          "tone": "danger",
          "icon": "lock",
          "label": "Bloqueado",
          "appearance": "filled"
        }
      }
    ]
  },
  "readonlyMode": false,
  "presentationMode": true,
  "canvasMode": true
}
```
Uso: tela corporativa em modo leitura com integracao de canvas.

Observacao:
- em pipelines 100% JSON, `transformDisplayValue` nao deve ser enviado como string de funcao; esse hook so funciona quando o host injeta funcao em runtime.

### 7. Troubleshooting e Armadilhas Comuns
1. Campo nao aparece.
Correcao: verificar `field.hidden/formHidden` e `visible` no host.

2. Campo fica somente leitura sem override explicito.
Correcao: `field.readonly/readOnly` tambem ativa readonly efetivo.

3. Em apresentacao, componente desaparece.
Correcao: comportamento esperado; excecao atual e `controlType='avatar'`.

4. Evento de canvas nao dispara.
Correcao: garantir `canvasMode=true`.

5. Valor mostrado em apresentacao esta incorreto.
Correcao: revisar `transformDisplayValue` e formato do valor no `control`.

6. Regra de apresentacao nao muda o visual.
Correcao: validar o Json Logic em `field.presentationRules[].when`; o contexto minimo expoe `value`, `rawValue`, `fieldName` e o nome do campo.

### 8. Cross-links
- `projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts`
- `projects/praxis-dynamic-fields/src/lib/utils/format-display.util.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 | true | n/a | Partial | See Detailed API reference. |
| `visible` | boolean | false | n/a | Partial | See Detailed API reference. |
| `canvasMode` | boolean | false | n/a | Partial | See Detailed API reference. |
| `field` | object | false | n/a | Partial | See Detailed API reference. |
| `field.hidden` | boolean | false | n/a | Partial | See Detailed API reference. |
| `field.formHidden` | unknown | false | n/a | Partial | See Detailed API reference. |
| `field.readonly` | boolean | false | n/a | Partial | See Detailed API reference. |
| `field.readOnly` | boolean | false | n/a | Partial | See Detailed API reference. |
| `field.disabled` | boolean | false | n/a | Partial | See Detailed API reference. |
| `field.controlType` | string | false | n/a | Partial | See Detailed API reference. |
| `field.controlType='avatar'` | unknown | false | n/a | Partial | See Detailed API reference. |
| `field.transformDisplayValue` | unknown | false | n/a | Partial | See Detailed API reference. |
| `field.valuePresentation` | object | false | n/a | Active | Formats values in presentation mode. |
| `field.presentation` | object | false | n/a | Active | Semantic state for presentation mode. |
| `field.presentationRules` | array | false | n/a | Active | Json Logic conditional presentation state. |
| `presentationMode` | boolean | false | n/a | Partial | See Detailed API reference. |
| `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference. |
| `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference. |

## Events reference (obrigatorio)

| Event | Payload | Trigger | Stability | Notes |
| --- | --- | --- | --- | --- |
| `canvasMouseEnter` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
| `canvasMouseLeave` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
| `canvasClick` | unknown | runtime-event | Experimental | Check component/runtime implementation. |

## 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
{
  "field": {
    "name": "status",
    "label": "Status",
    "controlType": "select"
  },
  "visible": true,
  "presentationMode": false,
  "metadata": {}
}
```

### Common setup

```json
{
  "field": {
    "id": "f-approval-status",
    "name": "approvalStatus",
    "label": "Aprovacao",
    "controlType": "praxis-field-shell-common",
    "readOnly": true
  },
  "readonlyMode": false,
  "presentationMode": true,
  "canvasMode": true,
  "metadata": {}
}
```

### Advanced setup

```json
{
  "field": {
    "id": "f-approval-status",
    "name": "approvalStatus",
    "label": "Aprovacao",
    "controlType": "select",
    "readOnly": true
  },
  "readonlyMode": false,
  "presentationMode": true,
  "canvasMode": true,
  "metadata": {},
  "disabledMode": false
}
```

### Enterprise scenario

```json
{
  "field": {
    "id": "f-approval-status",
    "name": "approvalStatus",
    "label": "Aprovacao",
    "controlType": "select",
    "readOnly": true
  },
  "readonlyMode": false,
  "presentationMode": true,
  "canvasMode": true,
  "metadata": {},
  "visible": true
}
```

## Compatibility and migration notes (recomendado)

| Concern | Affected versions | Migration action | Deadline | Notes |
| --- | --- | --- | --- | --- |
| Legacy aliases coexist with canonical paths | Active consumers using legacy JSON keys | Keep canonical paths for new usage and map aliases in migration backlog | not-yet-defined | Track via component-level migration issue |

## 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/field-shell/field-shell.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
| runtime-code | projects/praxis-dynamic-fields/src/lib/utils/field-state.util.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
| runtime-code | projects/praxis-dynamic-fields/src/lib/utils/format-display.util.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
| schema-types | projects/praxis-core/src/lib/models/component-metadata.interface.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |