@praxisui/dynamic-fields 8.0.0-beta.6 → 8.0.0-beta.60
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 +19 -0
- package/docs/dynamic-fields-field-catalog.md +217 -0
- package/docs/dynamic-fields-field-selection-guide.md +204 -0
- package/docs/dynamic-fields-host-custom-field-guide.md +252 -0
- package/docs/dynamic-fields-host-custom-field-troubleshooting.md +160 -0
- package/docs/dynamic-fields-inline-components-guide.md +582 -0
- package/docs/dynamic-fields-inline-filter-catalog.md +502 -0
- package/docs/dynamic-fields-inline-filter-custom-component-guide.md +241 -0
- package/docs/dynamic-fields-inline-filter-inventory.md +247 -0
- package/docs/dynamic-fields-inline-filter-runtime-contract.md +391 -0
- package/docs/dynamic-fields-inline-filter-selection-guide.md +419 -0
- package/docs/dynamic-fields-inline-filter-troubleshooting.md +201 -0
- package/docs/dynamic-fields-inventory.md +206 -0
- package/docs/dynamic-fields-playground-catalog-plan.md +243 -0
- package/docs/generic-crud-service.md +152 -0
- package/fesm2022/praxisui-dynamic-fields-index-CBogy3si.mjs +1 -0
- package/fesm2022/praxisui-dynamic-fields-index-CWPZdn1Y.mjs +6 -0
- package/fesm2022/praxisui-dynamic-fields-index-CrHhyUMO.mjs +1 -0
- package/fesm2022/praxisui-dynamic-fields-index-DhGo5In4.mjs +6 -0
- package/fesm2022/praxisui-dynamic-fields.mjs +19551 -10669
- package/package.json +14 -13
- package/src/lib/base/pdx-base-input-runtime-contract.json-api.md +526 -0
- package/src/lib/base/pdx-base-select-runtime-contract.json-api.md +474 -0
- package/src/lib/components/color-input/pdx-color-input.json-api.md +573 -0
- package/src/lib/components/color-picker/pdx-color-picker.json-api.md +686 -0
- package/src/lib/components/date-input/pdx-date-input.json-api.md +581 -0
- package/src/lib/components/datetime-local-input/pdx-datetime-local-input.json-api.md +560 -0
- package/src/lib/components/email-input/pdx-email-input.json-api.md +546 -0
- package/src/lib/components/field-shell/praxis-field-shell.json-api.md +523 -0
- package/src/lib/components/inline-async-select/pdx-inline-async-select.json-api.md +566 -0
- package/src/lib/components/inline-autocomplete/pdx-inline-autocomplete.json-api.md +554 -0
- package/src/lib/components/inline-color-label/pdx-inline-color-label.json-api.md +615 -0
- package/src/lib/components/inline-currency/pdx-inline-currency.json-api.md +542 -0
- package/src/lib/components/inline-currency-range/pdx-inline-currency-range.json-api.md +630 -0
- package/src/lib/components/inline-date/pdx-inline-date.json-api.md +529 -0
- package/src/lib/components/inline-date-range/pdx-inline-date-range.json-api.md +592 -0
- package/src/lib/components/inline-distance-radius/pdx-inline-distance-radius.json-api.md +649 -0
- package/src/lib/components/inline-entity-lookup/pdx-inline-entity-lookup.json-api.md +656 -0
- package/src/lib/components/inline-input/pdx-inline-input.json-api.md +538 -0
- package/src/lib/components/inline-multi-select/pdx-inline-multi-select.json-api.md +566 -0
- package/src/lib/components/inline-number/pdx-inline-number.json-api.md +533 -0
- package/src/lib/components/inline-pipeline-status/pdx-inline-pipeline-status.json-api.md +619 -0
- package/src/lib/components/inline-range-slider/pdx-inline-range-slider.json-api.md +605 -0
- package/src/lib/components/inline-rating/pdx-inline-rating.json-api.md +594 -0
- package/src/lib/components/inline-relative-period/pdx-inline-relative-period.json-api.md +623 -0
- package/src/lib/components/inline-score-priority/pdx-inline-score-priority.json-api.md +632 -0
- package/src/lib/components/inline-searchable-select/pdx-inline-searchable-select.json-api.md +564 -0
- package/src/lib/components/inline-select/pdx-inline-select.json-api.md +571 -0
- package/src/lib/components/inline-sentiment/pdx-inline-sentiment.json-api.md +661 -0
- package/src/lib/components/inline-time/pdx-inline-time.json-api.md +573 -0
- package/src/lib/components/inline-time-range/pdx-inline-time-range.json-api.md +635 -0
- package/src/lib/components/inline-toggle/pdx-inline-toggle.json-api.md +516 -0
- package/src/lib/components/inline-tree-select/pdx-inline-tree-select.json-api.md +637 -0
- package/src/lib/components/material-async-select/pdx-material-async-select.json-api.md +566 -0
- package/src/lib/components/material-autocomplete/pdx-material-autocomplete.json-api.md +561 -0
- package/src/lib/components/material-avatar/pdx-material-avatar.json-api.md +670 -0
- package/src/lib/components/material-button/pdx-material-button.json-api.md +572 -0
- package/src/lib/components/material-button-toggle/pdx-material-button-toggle.json-api.md +577 -0
- package/src/lib/components/material-checkbox-group/pdx-material-checkbox-group.json-api.md +611 -0
- package/src/lib/components/material-chips/pdx-material-chips.json-api.md +601 -0
- package/src/lib/components/material-colorpicker/pdx-material-colorpicker.json-api.md +545 -0
- package/src/lib/components/material-cpf-cnpj-input/pdx-material-cpf-cnpj-input.json-api.md +531 -0
- package/src/lib/components/material-currency/pdx-material-currency.json-api.md +569 -0
- package/src/lib/components/material-date-range/pdx-material-date-range.json-api.md +636 -0
- package/src/lib/components/material-datepicker/pdx-material-datepicker.json-api.md +551 -0
- package/src/lib/components/material-file-upload/pdx-material-file-upload.json-api.md +511 -0
- package/src/lib/components/material-multi-select/pdx-material-multi-select.json-api.md +596 -0
- package/src/lib/components/material-multi-select-tree/pdx-material-multi-select-tree.json-api.md +623 -0
- package/src/lib/components/material-price-range/pdx-material-price-range.json-api.md +619 -0
- package/src/lib/components/material-radio-group/pdx-material-radio-group.json-api.md +585 -0
- package/src/lib/components/material-range-slider/pdx-material-range-slider.json-api.md +664 -0
- package/src/lib/components/material-rating/pdx-material-rating.json-api.md +551 -0
- package/src/lib/components/material-searchable-select/pdx-material-searchable-select.json-api.md +602 -0
- package/src/lib/components/material-select/pdx-material-select.json-api.md +601 -0
- package/src/lib/components/material-selection-list/pdx-material-selection-list.json-api.md +607 -0
- package/src/lib/components/material-slide-toggle/pdx-material-slide-toggle.json-api.md +522 -0
- package/src/lib/components/material-slider/pdx-material-slider.json-api.md +602 -0
- package/src/lib/components/material-textarea/pdx-material-textarea.json-api.md +598 -0
- package/src/lib/components/material-timepicker/pdx-material-timepicker.json-api.md +554 -0
- package/src/lib/components/material-transfer-list/pdx-material-transfer-list.json-api.md +614 -0
- package/src/lib/components/material-tree-select/pdx-material-tree-select.json-api.md +649 -0
- package/src/lib/components/month-input/pdx-month-input.json-api.md +527 -0
- package/src/lib/components/number-input/pdx-number-input.json-api.md +594 -0
- package/src/lib/components/password-input/pdx-password-input.json-api.md +574 -0
- package/src/lib/components/pdx-material-time-range/pdx-material-time-range.json-api.md +592 -0
- package/src/lib/components/pdx-year-input/pdx-year-input.json-api.md +543 -0
- package/src/lib/components/phone-input/pdx-phone-input.json-api.md +583 -0
- package/src/lib/components/preload-status/pdx-preload-status.json-api.md +455 -0
- package/src/lib/components/search-input/pdx-search-input.json-api.md +536 -0
- package/src/lib/components/text-input/pdx-text-input.json-api.md +600 -0
- package/src/lib/components/time-input/pdx-time-input.json-api.md +546 -0
- package/src/lib/components/url-input/pdx-url-input.json-api.md +542 -0
- package/src/lib/components/week-input/pdx-week-input.json-api.md +533 -0
- package/{index.d.ts → types/praxisui-dynamic-fields.d.ts} +874 -440
- package/fesm2022/praxisui-dynamic-fields-index-C9IUU4lo.mjs +0 -1
- package/fesm2022/praxisui-dynamic-fields-index-GJtthzkD.mjs +0 -1
- package/fesm2022/praxisui-dynamic-fields-index-XvVS6lAQ.mjs +0 -1
|
@@ -0,0 +1,656 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "pdx-inline-entity-lookup JSON API (Canonical)"
|
|
3
|
+
slug: "pdx-inline-entity-lookup-json-api"
|
|
4
|
+
doc_type: "api-reference"
|
|
5
|
+
component: "pdx-inline-entity-lookup"
|
|
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 pdx-inline-entity-lookup."
|
|
11
|
+
category: "components"
|
|
12
|
+
sub_category: "dynamic-fields"
|
|
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-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts"
|
|
22
|
+
- "projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts"
|
|
23
|
+
- "projects/praxis-core/src/lib/models/material-field-metadata.interface.ts"
|
|
24
|
+
source_of_truth_last_verified: "2026-04-16"
|
|
25
|
+
last_updated: "2026-04-16"
|
|
26
|
+
toc: true
|
|
27
|
+
sidebar: true
|
|
28
|
+
tags:
|
|
29
|
+
- "json-api"
|
|
30
|
+
- "canonical-contract"
|
|
31
|
+
- "pdx-inline-entity-lookup"
|
|
32
|
+
api_stability: "canonical"
|
|
33
|
+
schema_verified: true
|
|
34
|
+
runtime_verified: true
|
|
35
|
+
editor_coverage_verified: false
|
|
36
|
+
runtime_scope: "public"
|
|
37
|
+
legacy_paths_present: false
|
|
38
|
+
has_known_mismatches: false
|
|
39
|
+
related_components:
|
|
40
|
+
- "praxis-table"
|
|
41
|
+
- "pdx-material-async-select"
|
|
42
|
+
- "pdx-base-select-runtime-contract"
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
# pdx-inline-entity-lookup
|
|
46
|
+
|
|
47
|
+
Este documento e a referencia canonica da API JSON de pdx-inline-entity-lookup.
|
|
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: Contrato JSON metadata-driven com comportamento definido por runtime e schema associado.
|
|
55
|
+
|
|
56
|
+
## Purpose and scope
|
|
57
|
+
|
|
58
|
+
- O componente consome payload JSON metadata-driven e expoe comportamento runtime configuravel por contrato.
|
|
59
|
+
- Esta referencia cobre contrato publico, classificacao de paths e semantica de cobertura (runtime/schema/editor).
|
|
60
|
+
- Fora de escopo: quickstart, tutorial narrativo e notas arquiteturais que nao alteram contrato publico.
|
|
61
|
+
|
|
62
|
+
## Consulta rapida (obrigatorio)
|
|
63
|
+
|
|
64
|
+
| Regra/tema | Observado | Canonico desejado | Status | Evidencia |
|
|
65
|
+
| --- | --- | --- | --- | --- |
|
|
66
|
+
| Component id | `pdx-inline-entity-lookup` | Manter ID canonico estavel e versionado por contrato | Active | frontmatter.component |
|
|
67
|
+
| Primary contract source | `runtime-and-code` | Runtime, schema e docs devem permanecer rastreaveis | Partial | frontmatter.contract_source + source_of_truth |
|
|
68
|
+
| Runtime coverage | `true` | Comportamentos runtime criticos devem ficar explicitamente verificados | Active | `projects/praxis-dynamic-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts` |
|
|
69
|
+
| Schema/type coverage | `true` | Tipos e schema devem refletir paths publicos do contrato | Active | source_of_truth + Detailed API reference |
|
|
70
|
+
| Editor/tooling coverage | `false` | Editor/tooling deve espelhar somente contrato publico suportado | Partial | `projects/praxis-core/src/lib/utils/inline-filter-controls.util.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.ts` |
|
|
71
|
+
| Path hygiene | `false` | Manter consistencia entre contrato canonico e caminhos documentados | Active | frontmatter.legacy_paths_present |
|
|
72
|
+
| Known mismatches | `false` | Registrar observed vs desired de forma auditavel | Active | frontmatter.has_known_mismatches |
|
|
73
|
+
|
|
74
|
+
## Source of truth
|
|
75
|
+
|
|
76
|
+
| Source | Kind | Notes |
|
|
77
|
+
| --- | --- | --- |
|
|
78
|
+
| projects/praxis-dynamic-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
79
|
+
| projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
80
|
+
| projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | schema-types | Arquivo presente no repositorio e usado como evidencia de contrato. |
|
|
81
|
+
|
|
82
|
+
## Support legend
|
|
83
|
+
|
|
84
|
+
- **Active**: suportado em runtime e liberado para uso externo.
|
|
85
|
+
- **Partial**: suporte parcial, com restricoes, lacunas ou validacao incompleta.
|
|
86
|
+
- **Declared-only**: declarado em tipos/schema sem evidencia operacional completa.
|
|
87
|
+
- **Schema-only**: presente em schema/tipos sem cobertura runtime confirmada.
|
|
88
|
+
|
|
89
|
+
## Contract status snapshot
|
|
90
|
+
|
|
91
|
+
| Item | Value | Notes |
|
|
92
|
+
| --- | --- | --- |
|
|
93
|
+
| Reference mode | `canonical` | Deve permanecer canonico |
|
|
94
|
+
| Contract format | `json` | Contrato metadata-driven |
|
|
95
|
+
| Contract source | `runtime-and-code` | Alinhar com source_of_truth |
|
|
96
|
+
| Runtime scope | `public` | Escopo publicado para consumidores |
|
|
97
|
+
| Runtime verified | `true` | Revisar sempre com evidencia de runtime |
|
|
98
|
+
| Schema verified | `true` | Revisar sempre com evidencia de tipos/schema |
|
|
99
|
+
| Editor coverage verified | `false` | Revisar sempre com evidencia de editor/tooling |
|
|
100
|
+
| Current path hygiene | `false` | Segregar consistencia do contrato canonico |
|
|
101
|
+
| Has known mismatches | `false` | Divergencias devem aparecer em secao dedicada |
|
|
102
|
+
|
|
103
|
+
## Contract classification (obrigatorio)
|
|
104
|
+
|
|
105
|
+
### Canonical paths (public contract)
|
|
106
|
+
|
|
107
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
108
|
+
| --- | --- | --- | --- | --- | --- |
|
|
109
|
+
| `metadata` | object | true | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
110
|
+
| `metadata.lookupIdKey` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
111
|
+
| `metadata.lookupLabelKey` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
112
|
+
| `metadata.lookupSubtitleKey` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
113
|
+
| `metadata.lookupSeparator` | unknown | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
114
|
+
| `metadata.searchPlaceholder` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
115
|
+
| `metadata.optionValueKey` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
116
|
+
| `metadata.optionLabelKey` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
|
|
117
|
+
| `metadata.optionSource` | object | false | n/a | Active | Fonte canonica de lookup remoto e semantica RESOURCE_ENTITY. |
|
|
118
|
+
| `metadata.optionSource.resourcePath` | string | false | n/a | Active | Habilita carga remota, busca, paginacao e reidratacao por IDs. |
|
|
119
|
+
| `metadata.optionSource.valuePropertyPath` | string | false | n/a | Active | Campo canonico de identidade da entidade no payload de lookup. |
|
|
120
|
+
| `metadata.optionSource.labelPropertyPath` | string | false | n/a | Active | Campo canonico de label humano da entidade. |
|
|
121
|
+
| `metadata.optionSource.codePropertyPath` | string | false | n/a | Active | Campo canonico de codigo curto exibido antes do label. |
|
|
122
|
+
| `metadata.optionSource.descriptionPropertyPaths` | string[] | false | n/a | Active | Campos concatenados na linha secundaria do lookup. |
|
|
123
|
+
| `metadata.optionSource.statusPropertyPath` | string | false | n/a | Active | Campo canonico de status exibido na linha secundaria. |
|
|
124
|
+
| `metadata.optionSource.display` | object | false | n/a | Active | Intencao canonica de UX para a entidade referenciada. |
|
|
125
|
+
| `metadata.optionSource.display.preset` | string | false | `rich` para formulario, `compact` para inline | Active | Preset semantico: `compact`, `rich`, `directory`, `status`, `reference` ou `hierarchical`. |
|
|
126
|
+
| `metadata.optionSource.display.usage` | string | false | n/a | Active | Contexto preferencial de uso: `form`, `filter`, `table-cell`, `dashboard`, `wizard` ou `review`. |
|
|
127
|
+
| `metadata.optionSource.display.density` | string | false | n/a | Active | Densidade preferencial: `compact`, `comfortable` ou `rich`. |
|
|
128
|
+
| `metadata.optionSource.display.secondaryPropertyPaths` | string[] | false | n/a | Active | Campos de subtitulo usados para diferenciar entidades parecidas. |
|
|
129
|
+
| `metadata.optionSource.display.fields` | object[] | false | n/a | Active | Campos ricos semanticos exibidos na lista e no valor selecionado. Cada item aceita `key`, `propertyPath`, `label`, `icon`, `presentation`, `tone` e `format`. |
|
|
130
|
+
| `metadata.optionSource.display.badgePropertyPaths` | string[] | false | n/a | Active | Campos publicados como badges/chips quando o backend tambem os materializa no payload de option. |
|
|
131
|
+
|
|
132
|
+
### Path audit
|
|
133
|
+
|
|
134
|
+
Nenhum desvio de caminho foi identificado nesta revisao.
|
|
135
|
+
|
|
136
|
+
### Internal-only paths
|
|
137
|
+
|
|
138
|
+
Nao ha paths internal-only confirmados no contrato publico desta revisao.
|
|
139
|
+
|
|
140
|
+
### Experimental paths
|
|
141
|
+
|
|
142
|
+
Nao ha paths experimentais confirmados no contrato publico desta revisao.
|
|
143
|
+
|
|
144
|
+
## Public contract surface (obrigatorio)
|
|
145
|
+
|
|
146
|
+
### Top-level configuration blocks
|
|
147
|
+
|
|
148
|
+
| Block | Purpose | Required | Merge strategy | Notes |
|
|
149
|
+
| --- | --- | --- | --- | --- |
|
|
150
|
+
| `metadata` | Payload declarativo principal do componente | true | deep-merge | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
151
|
+
| `resourcePath` | Configuracao especifica de runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
152
|
+
| `readonlyMode` | Override de readonly no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
153
|
+
| `disabledMode` | Override de disabled no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
154
|
+
| `visible` | Override de visibilidade no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
155
|
+
| `presentationMode` | Renderizacao de apresentacao sem interacao | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
|
|
156
|
+
|
|
157
|
+
### Nested configuration blocks
|
|
158
|
+
|
|
159
|
+
| Path | Type | Required | Default | Constraints | Notes |
|
|
160
|
+
| --- | --- | --- | --- | --- | --- |
|
|
161
|
+
| `metadata.lookupIdKey` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
162
|
+
| `metadata.lookupLabelKey` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
163
|
+
| `metadata.lookupSubtitleKey` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
164
|
+
| `metadata.lookupSeparator` | unknown | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
165
|
+
| `metadata.searchPlaceholder` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
166
|
+
| `metadata.optionValueKey` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
167
|
+
| `metadata.optionLabelKey` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
168
|
+
| `metadata.optionSource` | object | false | n/a | `RESOURCE_ENTITY` recomendado para entidades de negocio | Fonte canonica para resourcePath, identidade, label, codigo, descricao, status e detalhe. |
|
|
169
|
+
| `metadata.optionSource.display` | object | false | n/a | contrato semantico de UX, nao CSS | Governanca de preset, uso, densidade, campos ricos, secundarios e badges do resultado. |
|
|
170
|
+
| `metadata.resourcePath` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
171
|
+
| `metadata.inlineAutoSize.*` | object | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
172
|
+
| `metadata.searchable` | boolean | false | n/a | component-defined | Partial; verify per source_of_truth. |
|
|
173
|
+
|
|
174
|
+
### Input bindings (inbound data)
|
|
175
|
+
|
|
176
|
+
| Binding/Path | Type | Required | Source | Runtime normalization | Notes |
|
|
177
|
+
| --- | --- | --- | --- | --- | --- |
|
|
178
|
+
| `metadata` | object | true | host-json | component-defined | Primary inbound contract payload. |
|
|
179
|
+
| `readonlyMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
|
|
180
|
+
| `disabledMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
|
|
181
|
+
| `visible` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
|
|
182
|
+
| `presentationMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
|
|
183
|
+
|
|
184
|
+
### Output events
|
|
185
|
+
|
|
186
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
187
|
+
| --- | --- | --- | --- | --- |
|
|
188
|
+
| `searchTermChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
189
|
+
| `selectionChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
190
|
+
| `openedChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
191
|
+
| `valueChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
192
|
+
| `focusChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
193
|
+
| `nativeBlur` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
194
|
+
| `nativeChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
|
|
195
|
+
|
|
196
|
+
### External side channels
|
|
197
|
+
|
|
198
|
+
| Channel | Direction | Contract | Failure mode | Notes |
|
|
199
|
+
| --- | --- | --- | --- | --- |
|
|
200
|
+
| `host/services/storage` | bidirectional | component-defined | component-defined | Side channels variam por componente e host; verificar em source_of_truth. |
|
|
201
|
+
|
|
202
|
+
### Host/runtime dependencies
|
|
203
|
+
|
|
204
|
+
| Dependency | Required | Environment | Purpose | Notes |
|
|
205
|
+
| --- | --- | --- | --- | --- |
|
|
206
|
+
| `inline-entity-lookup.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts`. |
|
|
207
|
+
| `material-async-select.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts`. |
|
|
208
|
+
| `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`. |
|
|
209
|
+
|
|
210
|
+
## Coverage by surface (obrigatorio)
|
|
211
|
+
|
|
212
|
+
### Coverage matrix (runtime, schema/type, editor/tooling)
|
|
213
|
+
|
|
214
|
+
| Surface | Verified | Coverage status | Evidence | Notes |
|
|
215
|
+
| --- | --- | --- | --- | --- |
|
|
216
|
+
| Runtime | `true` | Active | `projects/praxis-dynamic-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts`, `projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts` | Core runtime flows verified via focused component specs on 2026-03-06; editor/tooling coverage remains independent. |
|
|
217
|
+
| Schema/Types | `true` | Active | source_of_truth + Detailed API reference | Reconcile schema/types with canonical paths during follow-up when needed. |
|
|
218
|
+
| Editor/Tooling | `false` | Partial | `projects/praxis-core/src/lib/utils/inline-filter-controls.util.ts`, `projects/praxis-dynamic-fields/src/lib/services/component-registry/component-registry.service.ts` | Alias/selector tooling linkage verified for inline filters; visual editor end-to-end coverage remains not-yet-verified. |
|
|
219
|
+
|
|
220
|
+
### Runtime coverage boundaries
|
|
221
|
+
|
|
222
|
+
- Ambientes suportados: browser/dev/prod; SSR/hydration appears to be component-dependent unless explicitly verified.
|
|
223
|
+
- Pre-condicoes: payload JSON valido, bindings de host consistentes e dependencias descritas no source_of_truth.
|
|
224
|
+
- Fora de cobertura confirmada: caminhos internos, experimentais ou aliases nao enumerados formalmente.
|
|
225
|
+
|
|
226
|
+
### Editor and tooling notes
|
|
227
|
+
|
|
228
|
+
- Evidencia de tooling: aliases `pdx-inline-*` resolvidos por `inline-filter-controls.util.ts` e consumidos no `ComponentRegistryService`; editor visual E2E permanece not-yet-verified.
|
|
229
|
+
- O que esta exposto no editor visual depende da cobertura real do workspace e nao deve ser inferido como suporte runtime total.
|
|
230
|
+
- Campos disponiveis apenas via JSON/manual devem continuar no contrato, com rotulo explicito de cobertura parcial.
|
|
231
|
+
- Quando houver divergencia entre editor e runtime, manter mismatch rastreavel em secao dedicada.
|
|
232
|
+
|
|
233
|
+
## Resolution and precedence model (obrigatorio)
|
|
234
|
+
|
|
235
|
+
### Merge order
|
|
236
|
+
|
|
237
|
+
1. defaults do componente
|
|
238
|
+
2. contrato JSON recebido
|
|
239
|
+
3. overrides de host/runtime
|
|
240
|
+
4. normalizacoes internas
|
|
241
|
+
|
|
242
|
+
### Fallback order
|
|
243
|
+
|
|
244
|
+
contrato explicito -> aliases historicos (quando suportados) -> defaults internos -> comportamento seguro
|
|
245
|
+
|
|
246
|
+
### Override points
|
|
247
|
+
|
|
248
|
+
- inputs publicos do componente
|
|
249
|
+
- configuracao JSON de runtime
|
|
250
|
+
- integracoes de host (servicos/tokens/adapters)
|
|
251
|
+
|
|
252
|
+
### Runtime normalization
|
|
253
|
+
|
|
254
|
+
Alias e defaults devem convergir para paths canonicos; onde nao houver evidencia, manter not-yet-verified de forma explicita.
|
|
255
|
+
|
|
256
|
+
### Precedence rules
|
|
257
|
+
|
|
258
|
+
Em conflito entre caminho historico e path canonico, priorizar path canonico e registrar janela de migracao do historico.
|
|
259
|
+
|
|
260
|
+
## Validation and error semantics (obrigatorio)
|
|
261
|
+
|
|
262
|
+
### Validation model
|
|
263
|
+
|
|
264
|
+
| Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
|
|
265
|
+
| --- | --- | --- | --- | --- |
|
|
266
|
+
| canonical-paths | parse/runtime | component-defined (warn/reject/default) | not-yet-standardized | Semantica detalhada preservada na referencia tecnica por componente. |
|
|
267
|
+
|
|
268
|
+
### Invalid and unknown field handling
|
|
269
|
+
|
|
270
|
+
- Campos desconhecidos: comportamento component-defined (ignore, warn ou reject).
|
|
271
|
+
- Tipos invalidos: pode haver fallback, warning ou falha, conforme runtime especifico.
|
|
272
|
+
- Valores fora de dominio: registrar observed vs desired em Known limitations and mismatches.
|
|
273
|
+
|
|
274
|
+
### Fail-open / fail-closed behavior
|
|
275
|
+
|
|
276
|
+
| Condition | Mode | Runtime behavior | Consumer impact |
|
|
277
|
+
| --- | --- | --- | --- |
|
|
278
|
+
| invalid-or-unknown-field | component-defined | not-yet-verified | Pode gerar warning, fallback silencioso ou rejeicao; validar por componente. |
|
|
279
|
+
|
|
280
|
+
### Runtime warnings vs hard failures
|
|
281
|
+
|
|
282
|
+
| Condition | Severity | Observability | Consumer action |
|
|
283
|
+
| --- | --- | --- | --- |
|
|
284
|
+
| partial-or-declared-only-coverage | warning | logs/eventos do componente | Confirmar ligacao runtime antes de uso critico. |
|
|
285
|
+
| mismatch-confirmed | error-or-warning | componente/host observability | Planejar migracao e corrigir contrato/runtime. |
|
|
286
|
+
|
|
287
|
+
## Detailed API reference
|
|
288
|
+
### Preserved technical reference (normalized from previous revision)
|
|
289
|
+
|
|
290
|
+
### 1. Visao Geral e Quando Usar
|
|
291
|
+
`pdx-inline-entity-lookup` e um lookup corporativo inline para selecionar entidades por identificador + descricao.
|
|
292
|
+
|
|
293
|
+
Use quando precisar:
|
|
294
|
+
- localizar registros por codigo e descricao na mesma opcao;
|
|
295
|
+
- combinar busca local/remota em painel compacto;
|
|
296
|
+
- padronizar exibicao do trigger como `ID - Label`.
|
|
297
|
+
|
|
298
|
+
### 2. API do Componente (Inputs/Outputs)
|
|
299
|
+
| Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
|
|
300
|
+
| --- | --- | --- | --- | --- |
|
|
301
|
+
| `metadata` | `MaterialSelectMetadata` | - | Sim | Contrato principal do lookup inline. |
|
|
302
|
+
| `readonlyMode/disabledMode/visible/presentationMode` | `boolean` | `false/false/true/false` | Nao | Estados de host do campo inline. |
|
|
303
|
+
| `selectionChange` | `T` | - | Output herdado | Valor selecionado da entidade. |
|
|
304
|
+
| `optionSelected` | `SelectOption` | - | Output herdado | Opcao selecionada no painel. |
|
|
305
|
+
| `optionsLoaded` | `SelectOption[]` | - | Output herdado | Lote carregado (local/remoto). |
|
|
306
|
+
|
|
307
|
+
### 3. Matriz de Cobertura JSON (Completa)
|
|
308
|
+
#### 3.1 Campos especificos do componente
|
|
309
|
+
| Caminho JSON | Tipo | Status | Comportamento em runtime |
|
|
310
|
+
| --- | --- | --- | --- |
|
|
311
|
+
| `metadata.lookupIdKey` | `string` | Ativo | Chave primaria usada na parte "ID" do texto. |
|
|
312
|
+
| `metadata.lookupLabelKey` | `string` | Ativo | Chave do label principal da entidade. |
|
|
313
|
+
| `metadata.lookupSubtitleKey` | `string` | Ativo | Chave de subtitulo opcional da entidade. |
|
|
314
|
+
| `metadata.lookupSeparator` | `string` | Ativo | Separador entre ID e label no trigger/opcao. |
|
|
315
|
+
| `metadata.searchPlaceholder` | `string` | Ativo | Placeholder do campo de busca do painel; na ausencia de override, o runtime cai para o catalogo shared `inlineSelect.searchPlaceholder`. |
|
|
316
|
+
| `metadata.optionValueKey` / `metadata.optionLabelKey` | `string` | Ativo | Fallback para mapping de id/label. |
|
|
317
|
+
| `metadata.optionSource` | `object` | Ativo | Fonte canonica de plataforma para Entity Lookup remoto. Quando `resourcePath` existe dentro de `optionSource`, o runtime usa endpoints de option-source para busca/paginacao e reidratacao por IDs. |
|
|
318
|
+
| `metadata.optionSource.valuePropertyPath` | `string` | Ativo | Resolve identidade da entidade para comparacao/reidratacao quando o valor salvo e primitivo ou objeto. |
|
|
319
|
+
| `metadata.optionSource.labelPropertyPath` | `string` | Ativo | Resolve label principal quando o objeto local/remoto carrega o campo de dominio em vez de `label`. |
|
|
320
|
+
| `metadata.optionSource.codePropertyPath` | `string` | Ativo | Resolve codigo curto exibido como parte primaria do lookup. |
|
|
321
|
+
| `metadata.optionSource.descriptionPropertyPaths` | `string[]` | Ativo | Resolve descricao rica concatenando campos de dominio na linha secundaria. |
|
|
322
|
+
| `metadata.optionSource.statusPropertyPath` | `string` | Ativo | Resolve status exibido depois da descricao. |
|
|
323
|
+
| `metadata.optionSource.detail.kind` | `"surface" | "route" | "href"` | Ativo | `surface` e o contrato canonico para detalhe de entidade: o runtime descobre `/{resource}/{id}/surfaces` e abre a surface por `GlobalActionService`/`surface.open`. `route`/`href` ficam como fallback legado. |
|
|
324
|
+
| `metadata.optionSource.detail.surfaceId` | `string` | Ativo | Id da surface item-level preferida para o detalhe. Quando ausente, o runtime escolhe `detail`, `view` ou a primeira surface item-level de leitura disponivel. |
|
|
325
|
+
| `metadata.optionSource.detail.presentation` | `"drawer" | "modal"` | Ativo | Apresentacao desejada para `surface.open`. Default vem do preset/host de surface. |
|
|
326
|
+
| `metadata.optionSource.detail.preferredWidget` / `metadata.optionSource.detail.mode` | `string` | Documental | Hints semanticos para autoria/discovery. A materializacao final vem da surface descoberta e do `ResourceSurfaceOpenAdapterService`. |
|
|
327
|
+
| `metadata.optionSource.detail.hrefTemplate` / `metadata.optionSource.detail.routeTemplate` | `string` | Legado | Fallback para abrir detalhe por link quando nao houver contrato de surface ou servico global disponivel. Nao deve ser a fonte primaria em novos lookups de plataforma. |
|
|
328
|
+
| `metadata.optionSource.display.preset` | `"compact" | "rich" | "directory" | "status" | "reference" | "hierarchical"` | Ativo | Define a intencao visual canonica. `directory` e recomendado para pessoas/equipes; `reference` para codigo + descricao; `status` para entidades com estado operacional forte. |
|
|
329
|
+
| `metadata.optionSource.display.usage` | `"form" | "filter" | "table-cell" | "dashboard" | "wizard" | "review"` | Ativo | Indica onde a option-source costuma aparecer. O runtime pode ajustar densidade e acoes sem duplicar regra por host. |
|
|
330
|
+
| `metadata.optionSource.display.density` | `"compact" | "comfortable" | "rich"` | Ativo | Densidade preferencial. Campos de formulario usam `comfortable`; filtros inline e celulas de tabela tendem a `compact`; revisoes podem usar `rich`. |
|
|
331
|
+
| `metadata.optionSource.display.secondaryPropertyPaths` | `string[]` | Ativo | Campos usados como subtitulo quando o payload local ou remoto preserva essas propriedades. O runtime tambem aceita `descriptionPropertyPaths` como fallback. |
|
|
332
|
+
| `metadata.optionSource.display.fields` | `object[]` | Ativo | Subinformacoes ricas com `propertyPath`, `label`, `icon`, `presentation` (`text`, `chip`, `badge`, `date`, `currency`, `metric`), `tone` e `format`. Quando o endpoint materializa `OptionDTO.extra.richFields[]`, esses valores sao usados diretamente. |
|
|
333
|
+
| `metadata.optionSource.display.badgePropertyPaths` | `string[]` | Ativo | Campos usados para badges/chips quando materializados no payload da option-source. |
|
|
334
|
+
| `metadata.resourcePath` | `string` | Ativo | Caminho operacional herdado. Para Entity Lookup de plataforma, preferir `metadata.optionSource.resourcePath`. |
|
|
335
|
+
| `metadata.inlineAutoSize.*` | `object` | Ativo | Largura responsiva da pill lookup. |
|
|
336
|
+
| `metadata.selectedLayout` | `"compact" | "inline" | "card" | "token"` | Ativo | Para `controlType: "entityLookup"`, `compact` e o default preservam altura de campo de formulario. `card` renderiza valor selecionado como cartao rico quando a superficie pedir revisao/detalhe. `token` preserva leitura compacta herdada. |
|
|
337
|
+
| `metadata.resultLayout` | `"list" | "denseList" | "table" | "card"` | Ativo | Para `controlType: "entityLookup"`, `list` e o default renderizam linhas ricas; `denseList` preserva leitura compacta. |
|
|
338
|
+
| `metadata.showCode` | `boolean` | Ativo | Controla exibicao do codigo curto na linha e no cartao. Default: `true`. |
|
|
339
|
+
| `metadata.showDescription` | `boolean` | Ativo | Controla exibicao da descricao composta. Default: `true`. |
|
|
340
|
+
| `metadata.showStatus` | `boolean` | Ativo | Controla exibicao do badge de status. Default: `true`. |
|
|
341
|
+
| `metadata.showAvatar` | `boolean` | Ativo | Controla exibicao de avatar por iniciais. Default: `true`. |
|
|
342
|
+
| `metadata.showBadges` | `boolean` | Ativo | Controla exibicao de badges auxiliares vindos de `badges`, `tags`, `riskLevel`, `homologationStatus` ou `badgeKeys`. Default: `true`. |
|
|
343
|
+
| `metadata.showDisabledReason` | `boolean` | Ativo | Controla exibicao do motivo de bloqueio quando `selectable=false`. Default: `true`. |
|
|
344
|
+
| `metadata.showResultCount` | `boolean` | Ativo | Controla contador de resultados no painel de busca. Quando o backend pagina com `totalElements`, mostra o total remoto; em fontes locais/cursor, mostra o total carregado. Default: `true`. |
|
|
345
|
+
| `metadata.statusToneMap` | `Record<string, "success" | "warning" | "danger" | "neutral">` | Ativo | Permite mapear status de dominio para tom visual governado. |
|
|
346
|
+
| `metadata.badgeKeys` | `string[]` | Ativo | Chaves adicionais lidas do valor de entidade para compor badges auxiliares. |
|
|
347
|
+
| `metadata.maxVisibleBadges` | `number` | Ativo | Limita quantidade de badges auxiliares exibidos. Default: `3`. |
|
|
348
|
+
| `metadata.actions.showDetail` | `boolean` | Ativo | Controla acao de detalhe quando houver surface canonica ou fallback `detailHref`/`detailRoute`. Default: `true`. |
|
|
349
|
+
| `metadata.actions.showChange` | `boolean` | Ativo | Controla acao de troca no cartao selecionado. Default: `true`. |
|
|
350
|
+
| `metadata.actions.showCopyCode` | `boolean` | Ativo | Controla acao de copiar codigo/id. Default: `true`. |
|
|
351
|
+
| `metadata.actions.showClear` | `boolean` | Ativo | Controla acao de limpar em conjunto com `clearButton`/clearable herdado. |
|
|
352
|
+
| `metadata.detailActionLabel` / `metadata.changeActionLabel` / `metadata.copyCodeActionLabel` / `metadata.clearActionLabel` | `string` | Ativo | Overrides textuais das acoes do cartao selecionado. |
|
|
353
|
+
| `metadata.searchable` | `boolean` | Ativo | Exibe/oculta barra de busca interna. |
|
|
354
|
+
|
|
355
|
+
#### 3.2 Campos herdados compartilhados (exaustivo)
|
|
356
|
+
- `projects/praxis-dynamic-fields/src/lib/components/material-async-select/pdx-material-async-select.json-api.md`
|
|
357
|
+
- `projects/praxis-dynamic-fields/src/lib/base/pdx-base-select-runtime-contract.json-api.md`
|
|
358
|
+
|
|
359
|
+
Resumo de composicao deste componente:
|
|
360
|
+
- `Ativo`: composicao lookup (id/label/subtitle), busca e reset rapido.
|
|
361
|
+
- `Extensao de runtime`: chaves `lookup*` para semantica corporativa.
|
|
362
|
+
|
|
363
|
+
### 4. Mapeamento de Comportamento
|
|
364
|
+
- Para `controlType: "inlineEntityLookup"`, o trigger preserva valor compacto composto por `buildLookupPrimaryText(id,label)`.
|
|
365
|
+
- Para `controlType: "entityLookup"`, o host publica `data-field-type="entityLookup"`, ocupa `width: 100%` e deve respeitar a coluna do `praxis-dynamic-form`; o trigger pode renderizar campo compacto ou cartao de revisao com avatar, codigo, label, descricao, status, badges e acoes.
|
|
366
|
+
- `metadata.optionSource.display` e a fonte preferencial de UX para a entidade; campos top-level como `selectedLayout`, `density`, `showAvatar` e `showStatus` funcionam como override local de host.
|
|
367
|
+
- Opcoes podem mostrar linha secundaria (`subtitle`) para desambiguacao; em `entityLookup`, a linha rica tambem mostra avatar, campos ricos com icones/chips/datas, status visual, badges e motivo de bloqueio.
|
|
368
|
+
- Com `metadata.optionSource.resourcePath`, busca emite termo no pipeline remoto de option-source; sem endpoint, filtra local.
|
|
369
|
+
- `metadata.resourcePath` continua aceito como configuracao operacional herdada, mas nao substitui a semantica canonica de entidade publicada em `metadata.optionSource`.
|
|
370
|
+
- Opcao de reset limpa filtro sem fechar contexto de trabalho.
|
|
371
|
+
- `OptionDTO.extra.selectable === false` desabilita a opcao e permite exibir `disabledReason` sem remover a entidade da lista ou da reidratacao.
|
|
372
|
+
|
|
373
|
+
### 5. Exemplo Minimo (JSON + Uso)
|
|
374
|
+
```json
|
|
375
|
+
{
|
|
376
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
377
|
+
"metadata": {
|
|
378
|
+
"name": "employee",
|
|
379
|
+
"label": "Funcionario",
|
|
380
|
+
"controlType": "select",
|
|
381
|
+
"lookupIdKey": "employeeId",
|
|
382
|
+
"lookupLabelKey": "fullName",
|
|
383
|
+
"selectOptions": [
|
|
384
|
+
{ "employeeId": "E-100", "fullName": "Ana Lima", "value": "E-100" }
|
|
385
|
+
]
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
```
|
|
389
|
+
Uso: lookup simples em lista local.
|
|
390
|
+
|
|
391
|
+
### 6. Exemplo Corporativo (JSON + Uso)
|
|
392
|
+
```json
|
|
393
|
+
{
|
|
394
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
395
|
+
"metadata": {
|
|
396
|
+
"name": "costCenterOwner",
|
|
397
|
+
"label": "Responsavel",
|
|
398
|
+
"controlType": "inlineEntityLookup",
|
|
399
|
+
"optionSource": {
|
|
400
|
+
"key": "employees",
|
|
401
|
+
"type": "RESOURCE_ENTITY",
|
|
402
|
+
"resourcePath": "people/employees",
|
|
403
|
+
"entityKey": "employee",
|
|
404
|
+
"valuePropertyPath": "id",
|
|
405
|
+
"labelPropertyPath": "nome",
|
|
406
|
+
"codePropertyPath": "matricula",
|
|
407
|
+
"descriptionPropertyPaths": ["departamento"],
|
|
408
|
+
"statusPropertyPath": "status",
|
|
409
|
+
"detail": {
|
|
410
|
+
"kind": "surface",
|
|
411
|
+
"surfaceId": "view",
|
|
412
|
+
"presentation": "drawer",
|
|
413
|
+
"preferredWidget": "praxis-dynamic-form",
|
|
414
|
+
"mode": "view"
|
|
415
|
+
},
|
|
416
|
+
"display": {
|
|
417
|
+
"preset": "directory",
|
|
418
|
+
"usage": "form",
|
|
419
|
+
"density": "comfortable",
|
|
420
|
+
"selectedLayout": "compact",
|
|
421
|
+
"resultLayout": "list",
|
|
422
|
+
"primaryPropertyPath": "nome",
|
|
423
|
+
"secondaryPropertyPaths": ["cargo", "departamento"],
|
|
424
|
+
"badgePropertyPaths": ["departamento"],
|
|
425
|
+
"showAvatar": true,
|
|
426
|
+
"showCode": false,
|
|
427
|
+
"showDescription": true,
|
|
428
|
+
"showStatus": true,
|
|
429
|
+
"showBadges": true,
|
|
430
|
+
"showResultCount": true
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
"lookupSeparator": " | ",
|
|
434
|
+
"searchable": true,
|
|
435
|
+
"searchPlaceholder": "Buscar por matricula ou nome",
|
|
436
|
+
"inlineAutoSize": { "minWidth": 156, "maxWidth": 420 },
|
|
437
|
+
"clearButton": { "enabled": true, "showOnlyWhenFilled": true }
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
```
|
|
441
|
+
Uso: lookup de colaborador em filtro corporativo com alto volume.
|
|
442
|
+
|
|
443
|
+
### 7. Troubleshooting e Armadilhas Comuns
|
|
444
|
+
1. Trigger mostra texto incompleto.
|
|
445
|
+
Correcao: validar `lookupIdKey` e `lookupLabelKey` no payload.
|
|
446
|
+
|
|
447
|
+
2. Subtitulo nao aparece nas opcoes.
|
|
448
|
+
Correcao: preencher `lookupSubtitleKey` e garantir dado no backend.
|
|
449
|
+
|
|
450
|
+
3. Busca nao retorna remoto.
|
|
451
|
+
Correcao: conferir `resourcePath` e contrato de endpoint.
|
|
452
|
+
|
|
453
|
+
4. Separador indesejado no texto.
|
|
454
|
+
Correcao: configurar `lookupSeparator`.
|
|
455
|
+
|
|
456
|
+
5. Campo estoura largura da toolbar.
|
|
457
|
+
Correcao: ajustar `inlineAutoSize.minWidth/maxWidth`.
|
|
458
|
+
|
|
459
|
+
### 8. Cross-links
|
|
460
|
+
- `projects/praxis-dynamic-fields/src/lib/components/material-async-select/pdx-material-async-select.json-api.md`
|
|
461
|
+
- `projects/praxis-dynamic-fields/src/lib/base/pdx-base-select-runtime-contract.json-api.md`
|
|
462
|
+
|
|
463
|
+
### 9. Relatorio de Validacao Estrutural
|
|
464
|
+
- Visao geral: PASS
|
|
465
|
+
- API (inputs/outputs): PASS
|
|
466
|
+
- Cobertura JSON completa (especifico + herdado): PASS
|
|
467
|
+
- Mapeamento de comportamento: PASS
|
|
468
|
+
- Exemplo minimo: PASS
|
|
469
|
+
- Exemplo corporativo: PASS
|
|
470
|
+
- Troubleshooting: PASS
|
|
471
|
+
|
|
472
|
+
## JSON path index (obrigatorio)
|
|
473
|
+
|
|
474
|
+
| Path | Type | Required | Default | Status | Notes |
|
|
475
|
+
| --- | --- | --- | --- | --- | --- |
|
|
476
|
+
| `metadata` | object | true | n/a | Partial | See Detailed API reference. |
|
|
477
|
+
| `metadata.lookupIdKey` | string | false | n/a | Partial | See Detailed API reference. |
|
|
478
|
+
| `metadata.lookupLabelKey` | string | false | n/a | Partial | See Detailed API reference. |
|
|
479
|
+
| `metadata.lookupSubtitleKey` | string | false | n/a | Partial | See Detailed API reference. |
|
|
480
|
+
| `metadata.lookupSeparator` | unknown | false | n/a | Partial | See Detailed API reference. |
|
|
481
|
+
| `metadata.searchPlaceholder` | string | false | n/a | Partial | See Detailed API reference. |
|
|
482
|
+
| `metadata.optionValueKey` | string | false | n/a | Partial | See Detailed API reference. |
|
|
483
|
+
| `metadata.optionLabelKey` | string | false | n/a | Partial | See Detailed API reference. |
|
|
484
|
+
| `metadata.resourcePath` | string | false | n/a | Partial | See Detailed API reference. |
|
|
485
|
+
| `metadata.inlineAutoSize.*` | object | false | n/a | Partial | See Detailed API reference. |
|
|
486
|
+
| `metadata.searchable` | boolean | false | n/a | Partial | See Detailed API reference. |
|
|
487
|
+
| `resourcePath` | string | false | n/a | Partial | See Detailed API reference. |
|
|
488
|
+
| `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference. |
|
|
489
|
+
| `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference. |
|
|
490
|
+
| `visible` | boolean | false | n/a | Partial | See Detailed API reference. |
|
|
491
|
+
| `presentationMode` | boolean | false | n/a | Partial | See Detailed API reference. |
|
|
492
|
+
|
|
493
|
+
## Events reference (obrigatorio)
|
|
494
|
+
|
|
495
|
+
| Event | Payload | Trigger | Stability | Notes |
|
|
496
|
+
| --- | --- | --- | --- | --- |
|
|
497
|
+
| `searchTermChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
498
|
+
| `selectionChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
499
|
+
| `openedChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
500
|
+
| `valueChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
501
|
+
| `focusChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
502
|
+
| `nativeBlur` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
503
|
+
| `nativeChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
|
|
504
|
+
|
|
505
|
+
## Styling API (obrigatorio quando aplicavel)
|
|
506
|
+
|
|
507
|
+
| Token/Class | Scope | Purpose | Notes |
|
|
508
|
+
| --- | --- | --- | --- |
|
|
509
|
+
| `not-yet-verified` | component | Styling contract not yet verified | Use Detailed API reference for component-specific styling notes. |
|
|
510
|
+
|
|
511
|
+
## Examples (obrigatorio)
|
|
512
|
+
|
|
513
|
+
| Example | Scenario | Validates | Notes |
|
|
514
|
+
| --- | --- | --- | --- |
|
|
515
|
+
| `Minimal valid` | baseline payload | required contract blocks | Extracted from preserved technical reference when available. |
|
|
516
|
+
| `Common setup` | common component usage | standard runtime behavior | Validate against host integration path. |
|
|
517
|
+
| `Advanced setup` | richer config with overrides | precedence and normalization | Requires runtime confirmation for edge cases. |
|
|
518
|
+
| `Enterprise scenario` | governance/legacy/migration context | auditability and compatibility boundaries | Include tenant-specific constraints when applicable. |
|
|
519
|
+
|
|
520
|
+
### Minimal valid
|
|
521
|
+
|
|
522
|
+
```json
|
|
523
|
+
{
|
|
524
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
525
|
+
"metadata": {
|
|
526
|
+
"name": "employee",
|
|
527
|
+
"label": "Funcionario",
|
|
528
|
+
"controlType": "select",
|
|
529
|
+
"lookupIdKey": "employeeId",
|
|
530
|
+
"lookupLabelKey": "fullName",
|
|
531
|
+
"selectOptions": [
|
|
532
|
+
{
|
|
533
|
+
"employeeId": "E-100",
|
|
534
|
+
"fullName": "Ana Lima",
|
|
535
|
+
"value": "E-100"
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"searchable": false
|
|
539
|
+
}
|
|
540
|
+
}
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
### Common setup
|
|
544
|
+
|
|
545
|
+
```json
|
|
546
|
+
{
|
|
547
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
548
|
+
"metadata": {
|
|
549
|
+
"name": "costCenterOwner",
|
|
550
|
+
"label": "Responsavel",
|
|
551
|
+
"controlType": "select",
|
|
552
|
+
"resourcePath": "employees/options",
|
|
553
|
+
"lookupIdKey": "matricula",
|
|
554
|
+
"lookupLabelKey": "nome",
|
|
555
|
+
"lookupSubtitleKey": "departamento",
|
|
556
|
+
"lookupSeparator": " | ",
|
|
557
|
+
"optionValueKey": "id",
|
|
558
|
+
"optionLabelKey": "nome",
|
|
559
|
+
"searchable": true,
|
|
560
|
+
"searchPlaceholder": "pdx-inline-entity-lookup-common",
|
|
561
|
+
"inlineAutoSize": {
|
|
562
|
+
"minWidth": 156,
|
|
563
|
+
"maxWidth": 420
|
|
564
|
+
},
|
|
565
|
+
"clearButton": {
|
|
566
|
+
"enabled": true,
|
|
567
|
+
"showOnlyWhenFilled": true
|
|
568
|
+
}
|
|
569
|
+
}
|
|
570
|
+
}
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
### Advanced setup
|
|
574
|
+
|
|
575
|
+
```json
|
|
576
|
+
{
|
|
577
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
578
|
+
"metadata": {
|
|
579
|
+
"name": "costCenterOwner",
|
|
580
|
+
"label": "Responsavel",
|
|
581
|
+
"controlType": "select",
|
|
582
|
+
"resourcePath": "employees/options",
|
|
583
|
+
"lookupIdKey": "matricula",
|
|
584
|
+
"lookupLabelKey": "nome",
|
|
585
|
+
"lookupSubtitleKey": "departamento",
|
|
586
|
+
"lookupSeparator": " | ",
|
|
587
|
+
"optionValueKey": "id",
|
|
588
|
+
"optionLabelKey": "nome",
|
|
589
|
+
"searchable": true,
|
|
590
|
+
"searchPlaceholder": "Buscar por matricula ou nome",
|
|
591
|
+
"inlineAutoSize": {
|
|
592
|
+
"minWidth": 156,
|
|
593
|
+
"maxWidth": 420
|
|
594
|
+
},
|
|
595
|
+
"clearButton": {
|
|
596
|
+
"enabled": true,
|
|
597
|
+
"showOnlyWhenFilled": true
|
|
598
|
+
}
|
|
599
|
+
},
|
|
600
|
+
"readonlyMode": false,
|
|
601
|
+
"disabledMode": false
|
|
602
|
+
}
|
|
603
|
+
```
|
|
604
|
+
|
|
605
|
+
### Enterprise scenario
|
|
606
|
+
|
|
607
|
+
```json
|
|
608
|
+
{
|
|
609
|
+
"componentId": "pdx-inline-entity-lookup",
|
|
610
|
+
"metadata": {
|
|
611
|
+
"name": "costCenterOwner",
|
|
612
|
+
"label": "Responsavel",
|
|
613
|
+
"controlType": "select",
|
|
614
|
+
"resourcePath": "employees/options",
|
|
615
|
+
"lookupIdKey": "matricula",
|
|
616
|
+
"lookupLabelKey": "nome",
|
|
617
|
+
"lookupSubtitleKey": "departamento",
|
|
618
|
+
"lookupSeparator": " | ",
|
|
619
|
+
"optionValueKey": "id",
|
|
620
|
+
"optionLabelKey": "nome",
|
|
621
|
+
"searchable": true,
|
|
622
|
+
"searchPlaceholder": "Buscar por matricula ou nome",
|
|
623
|
+
"inlineAutoSize": {
|
|
624
|
+
"minWidth": 156,
|
|
625
|
+
"maxWidth": 420
|
|
626
|
+
},
|
|
627
|
+
"clearButton": {
|
|
628
|
+
"enabled": true,
|
|
629
|
+
"showOnlyWhenFilled": true
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"presentationMode": true,
|
|
633
|
+
"visible": true,
|
|
634
|
+
"resourcePath": "/api/pdx-inline-entity-lookup"
|
|
635
|
+
}
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
## Compatibility and migration notes (recomendado)
|
|
639
|
+
|
|
640
|
+
| Concern | Affected versions | Migration action | Deadline | Notes |
|
|
641
|
+
| --- | --- | --- | --- | --- |
|
|
642
|
+
| 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 |
|
|
643
|
+
|
|
644
|
+
## Known limitations and mismatches (recomendado)
|
|
645
|
+
|
|
646
|
+
| Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
|
|
647
|
+
| --- | --- | --- | --- | --- | --- |
|
|
648
|
+
| Canonical contract parity | Runtime e exemplos desta referencia foram realinhados em 2026-03-16 para refletir fallbacks shared de placeholder e busca via `inlineSelect.*` | Manter exemplos e host overrides coerentes com o catalogo shared e evitar reintroduzir copy local | Low | n/a | Monitor in periodic audit |
|
|
649
|
+
|
|
650
|
+
## Source references (obrigatorio)
|
|
651
|
+
|
|
652
|
+
| Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
|
|
653
|
+
| --- | --- | --- | --- | --- |
|
|
654
|
+
| runtime-code | projects/praxis-dynamic-fields/src/lib/components/inline-entity-lookup/inline-entity-lookup.component.ts | Primary source of truth for contract and behavior. | 2026-03-16 | verified-path |
|
|
655
|
+
| runtime-code | projects/praxis-dynamic-fields/src/lib/components/material-async-select/material-async-select.component.ts | Primary source of truth for contract and behavior. | 2026-03-16 | verified-path |
|
|
656
|
+
| schema-types | projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | Primary source of truth for contract and behavior. | 2026-03-16 | verified-path |
|