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

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.
Files changed (97) hide show
  1. package/README.md +19 -0
  2. package/docs/dynamic-fields-field-catalog.md +217 -0
  3. package/docs/dynamic-fields-field-selection-guide.md +204 -0
  4. package/docs/dynamic-fields-host-custom-field-guide.md +252 -0
  5. package/docs/dynamic-fields-host-custom-field-troubleshooting.md +160 -0
  6. package/docs/dynamic-fields-inline-components-guide.md +582 -0
  7. package/docs/dynamic-fields-inline-filter-catalog.md +502 -0
  8. package/docs/dynamic-fields-inline-filter-custom-component-guide.md +241 -0
  9. package/docs/dynamic-fields-inline-filter-inventory.md +247 -0
  10. package/docs/dynamic-fields-inline-filter-runtime-contract.md +391 -0
  11. package/docs/dynamic-fields-inline-filter-selection-guide.md +419 -0
  12. package/docs/dynamic-fields-inline-filter-troubleshooting.md +201 -0
  13. package/docs/dynamic-fields-inventory.md +206 -0
  14. package/docs/dynamic-fields-playground-catalog-plan.md +243 -0
  15. package/docs/generic-crud-service.md +152 -0
  16. package/fesm2022/praxisui-dynamic-fields-index-CBogy3si.mjs +1 -0
  17. package/fesm2022/praxisui-dynamic-fields-index-CWPZdn1Y.mjs +6 -0
  18. package/fesm2022/praxisui-dynamic-fields-index-CrHhyUMO.mjs +1 -0
  19. package/fesm2022/praxisui-dynamic-fields-index-DhGo5In4.mjs +6 -0
  20. package/fesm2022/praxisui-dynamic-fields.mjs +19551 -10669
  21. package/package.json +14 -13
  22. package/src/lib/base/pdx-base-input-runtime-contract.json-api.md +526 -0
  23. package/src/lib/base/pdx-base-select-runtime-contract.json-api.md +474 -0
  24. package/src/lib/components/color-input/pdx-color-input.json-api.md +573 -0
  25. package/src/lib/components/color-picker/pdx-color-picker.json-api.md +686 -0
  26. package/src/lib/components/date-input/pdx-date-input.json-api.md +581 -0
  27. package/src/lib/components/datetime-local-input/pdx-datetime-local-input.json-api.md +560 -0
  28. package/src/lib/components/email-input/pdx-email-input.json-api.md +546 -0
  29. package/src/lib/components/field-shell/praxis-field-shell.json-api.md +523 -0
  30. package/src/lib/components/inline-async-select/pdx-inline-async-select.json-api.md +566 -0
  31. package/src/lib/components/inline-autocomplete/pdx-inline-autocomplete.json-api.md +554 -0
  32. package/src/lib/components/inline-color-label/pdx-inline-color-label.json-api.md +615 -0
  33. package/src/lib/components/inline-currency/pdx-inline-currency.json-api.md +542 -0
  34. package/src/lib/components/inline-currency-range/pdx-inline-currency-range.json-api.md +630 -0
  35. package/src/lib/components/inline-date/pdx-inline-date.json-api.md +529 -0
  36. package/src/lib/components/inline-date-range/pdx-inline-date-range.json-api.md +592 -0
  37. package/src/lib/components/inline-distance-radius/pdx-inline-distance-radius.json-api.md +649 -0
  38. package/src/lib/components/inline-entity-lookup/pdx-inline-entity-lookup.json-api.md +656 -0
  39. package/src/lib/components/inline-input/pdx-inline-input.json-api.md +538 -0
  40. package/src/lib/components/inline-multi-select/pdx-inline-multi-select.json-api.md +566 -0
  41. package/src/lib/components/inline-number/pdx-inline-number.json-api.md +533 -0
  42. package/src/lib/components/inline-pipeline-status/pdx-inline-pipeline-status.json-api.md +619 -0
  43. package/src/lib/components/inline-range-slider/pdx-inline-range-slider.json-api.md +605 -0
  44. package/src/lib/components/inline-rating/pdx-inline-rating.json-api.md +594 -0
  45. package/src/lib/components/inline-relative-period/pdx-inline-relative-period.json-api.md +623 -0
  46. package/src/lib/components/inline-score-priority/pdx-inline-score-priority.json-api.md +632 -0
  47. package/src/lib/components/inline-searchable-select/pdx-inline-searchable-select.json-api.md +564 -0
  48. package/src/lib/components/inline-select/pdx-inline-select.json-api.md +571 -0
  49. package/src/lib/components/inline-sentiment/pdx-inline-sentiment.json-api.md +661 -0
  50. package/src/lib/components/inline-time/pdx-inline-time.json-api.md +573 -0
  51. package/src/lib/components/inline-time-range/pdx-inline-time-range.json-api.md +635 -0
  52. package/src/lib/components/inline-toggle/pdx-inline-toggle.json-api.md +516 -0
  53. package/src/lib/components/inline-tree-select/pdx-inline-tree-select.json-api.md +637 -0
  54. package/src/lib/components/material-async-select/pdx-material-async-select.json-api.md +566 -0
  55. package/src/lib/components/material-autocomplete/pdx-material-autocomplete.json-api.md +561 -0
  56. package/src/lib/components/material-avatar/pdx-material-avatar.json-api.md +670 -0
  57. package/src/lib/components/material-button/pdx-material-button.json-api.md +572 -0
  58. package/src/lib/components/material-button-toggle/pdx-material-button-toggle.json-api.md +577 -0
  59. package/src/lib/components/material-checkbox-group/pdx-material-checkbox-group.json-api.md +611 -0
  60. package/src/lib/components/material-chips/pdx-material-chips.json-api.md +601 -0
  61. package/src/lib/components/material-colorpicker/pdx-material-colorpicker.json-api.md +545 -0
  62. package/src/lib/components/material-cpf-cnpj-input/pdx-material-cpf-cnpj-input.json-api.md +531 -0
  63. package/src/lib/components/material-currency/pdx-material-currency.json-api.md +569 -0
  64. package/src/lib/components/material-date-range/pdx-material-date-range.json-api.md +636 -0
  65. package/src/lib/components/material-datepicker/pdx-material-datepicker.json-api.md +551 -0
  66. package/src/lib/components/material-file-upload/pdx-material-file-upload.json-api.md +511 -0
  67. package/src/lib/components/material-multi-select/pdx-material-multi-select.json-api.md +596 -0
  68. package/src/lib/components/material-multi-select-tree/pdx-material-multi-select-tree.json-api.md +623 -0
  69. package/src/lib/components/material-price-range/pdx-material-price-range.json-api.md +619 -0
  70. package/src/lib/components/material-radio-group/pdx-material-radio-group.json-api.md +585 -0
  71. package/src/lib/components/material-range-slider/pdx-material-range-slider.json-api.md +664 -0
  72. package/src/lib/components/material-rating/pdx-material-rating.json-api.md +551 -0
  73. package/src/lib/components/material-searchable-select/pdx-material-searchable-select.json-api.md +602 -0
  74. package/src/lib/components/material-select/pdx-material-select.json-api.md +601 -0
  75. package/src/lib/components/material-selection-list/pdx-material-selection-list.json-api.md +607 -0
  76. package/src/lib/components/material-slide-toggle/pdx-material-slide-toggle.json-api.md +522 -0
  77. package/src/lib/components/material-slider/pdx-material-slider.json-api.md +602 -0
  78. package/src/lib/components/material-textarea/pdx-material-textarea.json-api.md +598 -0
  79. package/src/lib/components/material-timepicker/pdx-material-timepicker.json-api.md +554 -0
  80. package/src/lib/components/material-transfer-list/pdx-material-transfer-list.json-api.md +614 -0
  81. package/src/lib/components/material-tree-select/pdx-material-tree-select.json-api.md +649 -0
  82. package/src/lib/components/month-input/pdx-month-input.json-api.md +527 -0
  83. package/src/lib/components/number-input/pdx-number-input.json-api.md +594 -0
  84. package/src/lib/components/password-input/pdx-password-input.json-api.md +574 -0
  85. package/src/lib/components/pdx-material-time-range/pdx-material-time-range.json-api.md +592 -0
  86. package/src/lib/components/pdx-year-input/pdx-year-input.json-api.md +543 -0
  87. package/src/lib/components/phone-input/pdx-phone-input.json-api.md +583 -0
  88. package/src/lib/components/preload-status/pdx-preload-status.json-api.md +455 -0
  89. package/src/lib/components/search-input/pdx-search-input.json-api.md +536 -0
  90. package/src/lib/components/text-input/pdx-text-input.json-api.md +600 -0
  91. package/src/lib/components/time-input/pdx-time-input.json-api.md +546 -0
  92. package/src/lib/components/url-input/pdx-url-input.json-api.md +542 -0
  93. package/src/lib/components/week-input/pdx-week-input.json-api.md +533 -0
  94. package/{index.d.ts → types/praxisui-dynamic-fields.d.ts} +874 -440
  95. package/fesm2022/praxisui-dynamic-fields-index-C9IUU4lo.mjs +0 -1
  96. package/fesm2022/praxisui-dynamic-fields-index-GJtthzkD.mjs +0 -1
  97. package/fesm2022/praxisui-dynamic-fields-index-XvVS6lAQ.mjs +0 -1
@@ -0,0 +1,527 @@
1
+ ---
2
+ title: "pdx-month-input JSON API (Canonical)"
3
+ slug: "pdx-month-input-json-api"
4
+ doc_type: "api-reference"
5
+ component: "pdx-month-input"
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-month-input."
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/month-input/month-input.metadata.ts"
22
+ - "projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts"
23
+ - "projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts"
24
+ - "projects/praxis-core/src/lib/models/material-field-metadata.interface.ts"
25
+ source_of_truth_last_verified: "2026-03-06"
26
+ last_updated: "2026-03-06"
27
+ toc: true
28
+ sidebar: true
29
+ tags:
30
+ - "json-api"
31
+ - "canonical-contract"
32
+ - "pdx-month-input"
33
+ api_stability: "canonical"
34
+ schema_verified: true
35
+ runtime_verified: true
36
+ editor_coverage_verified: false
37
+ runtime_scope: "public"
38
+ legacy_paths_present: false
39
+ has_known_mismatches: false
40
+ related_components:
41
+ - "praxis-table"
42
+ - "pdx-base-input-runtime-contract"
43
+ - "pdx-date-input"
44
+ - "pdx-week-input"
45
+ ---
46
+
47
+ # pdx-month-input
48
+
49
+ Este documento e a referencia canonica da API JSON de pdx-month-input.
50
+
51
+ ## Summary
52
+
53
+ - Tipo documental: API reference canonica de contrato JSON.
54
+ - Source of truth: runtime e codigo declarados no frontmatter.
55
+ - Objetivo operacional: consulta rapida, auditavel e deterministica sob pressao.
56
+ - Resumo funcional: Contrato JSON metadata-driven com comportamento definido por runtime e schema associado.
57
+
58
+ ## Purpose and scope
59
+
60
+ - O componente consome payload JSON metadata-driven e expoe comportamento runtime configuravel por contrato.
61
+ - Esta referencia cobre contrato publico, classificacao de paths e semantica de cobertura (runtime/schema/editor).
62
+ - Fora de escopo: quickstart, tutorial narrativo e notas arquiteturais que nao alteram contrato publico.
63
+
64
+ ## Consulta rapida (obrigatorio)
65
+
66
+ | Regra/tema | Observado | Canonico desejado | Status | Evidencia |
67
+ | --- | --- | --- | --- | --- |
68
+ | Component id | `pdx-month-input` | Manter ID canonico estavel e versionado por contrato | Active | frontmatter.component |
69
+ | Primary contract source | `runtime-and-code` | Runtime, schema e docs devem permanecer rastreaveis | Partial | frontmatter.contract_source + source_of_truth |
70
+ | Runtime coverage | `true` | Comportamentos runtime criticos devem ficar explicitamente verificados | Active | `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.metadata.ts`, `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts` |
71
+ | Schema/type coverage | `true` | Tipos e schema devem refletir paths publicos do contrato | Active | source_of_truth + Detailed API reference |
72
+ | 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` |
73
+ | Legacy paths | `false` | Segregar legado de caminhos canonicos com janela de migracao | Active | frontmatter.legacy_paths_present |
74
+ | Known mismatches | `false` | Registrar observed vs desired de forma auditavel | Active | frontmatter.has_known_mismatches |
75
+
76
+ ## Source of truth
77
+
78
+ | Source | Kind | Notes |
79
+ | --- | --- | --- |
80
+ | projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.metadata.ts | schema-metadata | Arquivo presente no repositorio e usado como evidencia de contrato. |
81
+ | projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
82
+ | projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts | runtime-code | Arquivo presente no repositorio e usado como evidencia de contrato. |
83
+ | projects/praxis-core/src/lib/models/material-field-metadata.interface.ts | schema-types | Arquivo presente no repositorio e usado como evidencia de contrato. |
84
+
85
+ ## Support legend
86
+
87
+ - **Active**: suportado em runtime e liberado para uso externo.
88
+ - **Partial**: suporte parcial, com restricoes, lacunas ou validacao incompleta.
89
+ - **Declared-only**: declarado em tipos/schema sem evidencia operacional completa.
90
+ - **Schema-only**: presente em schema/tipos sem cobertura runtime confirmada.
91
+ - **Deprecated**: legado suportado por janela de migracao definida.
92
+
93
+ ## Contract status snapshot
94
+
95
+ | Item | Value | Notes |
96
+ | --- | --- | --- |
97
+ | Reference mode | `canonical` | Deve permanecer canonico |
98
+ | Contract format | `json` | Contrato metadata-driven |
99
+ | Contract source | `runtime-and-code` | Alinhar com source_of_truth |
100
+ | Runtime scope | `public` | Escopo publicado para consumidores |
101
+ | Runtime verified | `true` | Revisar sempre com evidencia de runtime |
102
+ | Schema verified | `true` | Revisar sempre com evidencia de tipos/schema |
103
+ | Editor coverage verified | `false` | Revisar sempre com evidencia de editor/tooling |
104
+ | Legacy paths present | `false` | Segregar legado de contrato canonico |
105
+ | Has known mismatches | `false` | Divergencias devem aparecer em secao dedicada |
106
+
107
+ ## Contract classification (obrigatorio)
108
+
109
+ ### Canonical paths (public contract)
110
+
111
+ | Path | Type | Required | Default | Status | Notes |
112
+ | --- | --- | --- | --- | --- | --- |
113
+ | `metadata` | object | true | n/a | Partial | See Detailed API reference for runtime semantics. |
114
+ | `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
115
+ | `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
116
+ | `visible` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
117
+ | `presentationMode` | boolean | false | n/a | Partial | See Detailed API reference for runtime semantics. |
118
+ | `metadata.controlType` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
119
+ | `metadata.inputType` | string | false | n/a | Partial | See Detailed API reference for runtime semantics. |
120
+ | `metadata.min` | number | false | n/a | Partial | See Detailed API reference for runtime semantics. |
121
+
122
+ ### Supported legacy paths
123
+
124
+ Nenhum path legado suportado foi identificado nesta revisao.
125
+
126
+ ### Internal-only paths
127
+
128
+ Nao ha paths internal-only confirmados no contrato publico desta revisao.
129
+
130
+ ### Experimental paths
131
+
132
+ Nao ha paths experimentais confirmados no contrato publico desta revisao.
133
+
134
+ ## Public contract surface (obrigatorio)
135
+
136
+ ### Top-level configuration blocks
137
+
138
+ | Block | Purpose | Required | Merge strategy | Notes |
139
+ | --- | --- | --- | --- | --- |
140
+ | `metadata` | Payload declarativo principal do componente | true | deep-merge | runtime linkage verified for core flows (component specs, 2026-03-06). |
141
+ | `readonlyMode` | Override de readonly no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
142
+ | `disabledMode` | Override de disabled no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
143
+ | `visible` | Override de visibilidade no host/runtime | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
144
+ | `presentationMode` | Renderizacao de apresentacao sem interacao | false | override | runtime linkage verified for core flows (component specs, 2026-03-06). |
145
+
146
+ ### Nested configuration blocks
147
+
148
+ | Path | Type | Required | Default | Constraints | Notes |
149
+ | --- | --- | --- | --- | --- | --- |
150
+ | `metadata.controlType` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
151
+ | `metadata.inputType` | string | false | n/a | component-defined | Partial; verify per source_of_truth. |
152
+ | `metadata.min` | number | false | n/a | component-defined | Partial; verify per source_of_truth. |
153
+ | `metadata.max` | number | false | n/a | component-defined | Partial; verify per source_of_truth. |
154
+ | `metadata.clearButton.*` | object | false | n/a | component-defined | Partial; verify per source_of_truth. |
155
+
156
+ ### Input bindings (inbound data)
157
+
158
+ | Binding/Path | Type | Required | Source | Runtime normalization | Notes |
159
+ | --- | --- | --- | --- | --- | --- |
160
+ | `metadata` | object | true | host-json | component-defined | Primary inbound contract payload. |
161
+ | `readonlyMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
162
+ | `disabledMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
163
+ | `visible` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
164
+ | `presentationMode` | boolean | false | host-runtime | not-yet-verified | Host-level behavioral override. |
165
+
166
+ ### Output events
167
+
168
+ | Event | Payload | Trigger | Stability | Notes |
169
+ | --- | --- | --- | --- | --- |
170
+ | `validationChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
171
+ | `valueChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
172
+ | `focusChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
173
+ | `nativeBlur` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
174
+ | `nativeChange` | unknown | runtime-event | Experimental | Validate payload shape against source_of_truth. |
175
+
176
+ ### External side channels
177
+
178
+ | Channel | Direction | Contract | Failure mode | Notes |
179
+ | --- | --- | --- | --- | --- |
180
+ | `host/services/storage` | bidirectional | component-defined | component-defined | Side channels variam por componente e host; verificar em source_of_truth. |
181
+
182
+ ### Host/runtime dependencies
183
+
184
+ | Dependency | Required | Environment | Purpose | Notes |
185
+ | --- | --- | --- | --- | --- |
186
+ | `month-input.metadata.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.metadata.ts`. |
187
+ | `month-input.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts`. |
188
+ | `simple-base-input.component.ts` | true | browser/dev/prod/ssr | contract resolution | Refer to `projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts`. |
189
+ | `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`. |
190
+
191
+ ## Coverage by surface (obrigatorio)
192
+
193
+ ### Coverage matrix (runtime, schema/type, editor/tooling)
194
+
195
+ | Surface | Verified | Coverage status | Evidence | Notes |
196
+ | --- | --- | --- | --- | --- |
197
+ | Runtime | `true` | Active | `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.metadata.ts`, `projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts` | Core runtime flows verified via focused component specs on 2026-03-06; editor/tooling coverage remains independent. |
198
+ | Schema/Types | `true` | Active | source_of_truth + Detailed API reference | Reconcile schema/types with canonical paths during follow-up when needed. |
199
+ | 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. |
200
+
201
+ ### Runtime coverage boundaries
202
+
203
+ - Ambientes suportados: browser/dev/prod; SSR/hydration appears to be component-dependent unless explicitly verified.
204
+ - Pre-condicoes: payload JSON valido, bindings de host consistentes e dependencias descritas no source_of_truth.
205
+ - Fora de cobertura confirmada: caminhos internos, experimentais ou aliases nao enumerados formalmente.
206
+
207
+ ### Editor and tooling notes
208
+
209
+ - Evidencia de tooling: selector `pdx-*` mapeado em `DEFAULT_FIELD_SELECTOR_CONTROL_TYPE_MAP` e semeado no `ComponentRegistryService`; editor visual E2E permanece not-yet-verified.
210
+ - O que esta exposto no editor visual depende da cobertura real do workspace e nao deve ser inferido como suporte runtime total.
211
+ - Campos disponiveis apenas via JSON/manual devem continuar no contrato, com rotulo explicito de cobertura parcial.
212
+ - Quando houver divergencia entre editor e runtime, manter mismatch rastreavel em secao dedicada.
213
+
214
+ ## Resolution and precedence model (obrigatorio)
215
+
216
+ ### Merge order
217
+
218
+ 1. defaults do componente
219
+ 2. contrato JSON recebido
220
+ 3. overrides de host/runtime
221
+ 4. normalizacoes internas
222
+
223
+ ### Fallback order
224
+
225
+ contrato explicito -> aliases legados (quando suportados) -> defaults internos -> comportamento seguro
226
+
227
+ ### Override points
228
+
229
+ - inputs publicos do componente
230
+ - configuracao JSON de runtime
231
+ - integracoes de host (servicos/tokens/adapters)
232
+
233
+ ### Runtime normalization
234
+
235
+ Alias e defaults devem convergir para paths canonicos; onde nao houver evidencia, manter not-yet-verified de forma explicita.
236
+
237
+ ### Precedence rules
238
+
239
+ Em conflito entre alias legado e path canonico, priorizar path canonico e registrar janela de migracao do legado.
240
+
241
+ ## Validation and error semantics (obrigatorio)
242
+
243
+ ### Validation model
244
+
245
+ | Path/Rule | Validation phase | Behavior on fail | Error code / warning | Notes |
246
+ | --- | --- | --- | --- | --- |
247
+ | canonical-paths | parse/runtime | component-defined (warn/reject/default) | not-yet-standardized | Semantica detalhada preservada na referencia tecnica por componente. |
248
+
249
+ ### Invalid and unknown field handling
250
+
251
+ - Campos desconhecidos: comportamento component-defined (ignore, warn ou reject).
252
+ - Tipos invalidos: pode haver fallback, warning ou falha, conforme runtime especifico.
253
+ - Valores fora de dominio: registrar observed vs desired em Known limitations and mismatches.
254
+
255
+ ### Fail-open / fail-closed behavior
256
+
257
+ | Condition | Mode | Runtime behavior | Consumer impact |
258
+ | --- | --- | --- | --- |
259
+ | invalid-or-unknown-field | component-defined | not-yet-verified | Pode gerar warning, fallback silencioso ou rejeicao; validar por componente. |
260
+
261
+ ### Runtime warnings vs hard failures
262
+
263
+ | Condition | Severity | Observability | Consumer action |
264
+ | --- | --- | --- | --- |
265
+ | partial-or-declared-only-coverage | warning | logs/eventos do componente | Confirmar ligacao runtime antes de uso critico. |
266
+ | mismatch-confirmed | error-or-warning | componente/host observability | Planejar migracao e corrigir contrato/runtime. |
267
+
268
+ ## Detailed API reference
269
+ ### Preserved technical reference (normalized from previous revision)
270
+
271
+ ### 1. Visao Geral e Quando Usar
272
+ `pdx-month-input` e o campo de mes orientado por JSON em `@praxisui/dynamic-fields`.
273
+
274
+ Use quando precisar:
275
+ - captura de competencia mensal (`YYYY-MM`);
276
+ - limites `min/max` por mes;
277
+ - integracao com formulario reativo;
278
+ - estado controlado pelo host.
279
+
280
+ ### 2. API do Componente (Inputs/Outputs)
281
+ | Propriedade | Tipo | Padrao | Obrigatorio | Comportamento |
282
+ | --- | --- | --- | --- | --- |
283
+ | `metadata` | `MaterialMonthInputMetadata` | - | Sim | Contrato principal do componente. |
284
+ | `readonlyMode` | `boolean` | `false` | Nao | Sobrescreve leitura no host. |
285
+ | `disabledMode` | `boolean` | `false` | Nao | Sobrescreve disabled no host. |
286
+ | `visible` | `boolean` | `true` | Nao | Controla exibicao no host. |
287
+ | `presentationMode` | `boolean` | `false` | Nao | Modo de apresentacao (sem edicao). |
288
+ | `validationChange` | `ValidationErrors \| null` | - | Output | Emite resultado da validacao. |
289
+
290
+ ### 3. Matriz de Cobertura JSON (Completa)
291
+ #### 3.1 Campos especificos do componente
292
+ | Caminho JSON | Tipo | Status | Comportamento em runtime |
293
+ | --- | --- | --- | --- |
294
+ | `metadata.controlType` | `'month'` | Ativo | Identifica contrato do componente. |
295
+ | `metadata.inputType` | `'month'` | Ativo | Renderiza `<input type="month">`. |
296
+ | `metadata.min` | `string (YYYY-MM)` | Ativo | Limite inferior de mes no input nativo. |
297
+ | `metadata.max` | `string (YYYY-MM)` | Ativo | Limite superior de mes no input nativo. |
298
+
299
+ #### 3.2 Campos herdados compartilhados (exaustivo)
300
+ Contrato completo dos campos herdados consumidos por `SimpleBaseInput`:
301
+ - [pdx-base-input-runtime-contract.json-api.md](projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.json-api.md)
302
+
303
+ Resumo de composicao deste componente:
304
+ - `Ativo`: contrato herdado + `min/max` de mes + validacao regex estrita (`YYYY-(01..12)`) + `validationChange`.
305
+ - `Extensao de runtime`: `metadata.clearButton.*`.
306
+
307
+ ### 4. Mapeamento de Comportamento
308
+ - Paginacao: nao se aplica.
309
+ - Ordenacao: nao se aplica.
310
+ - Selecao: valor string unico.
311
+ - Eventos: `validationChange` + fluxo padrao do formulario.
312
+ - Renderizacao: campo de mes com hint/erro/icones e clear opcional.
313
+
314
+ ### 5. Exemplo Minimo (JSON + Uso)
315
+ ```json
316
+ {
317
+ "componentId": "pdx-month-input",
318
+ "metadata": {
319
+ "name": "referenceMonth",
320
+ "label": "Mes de referencia",
321
+ "controlType": "month",
322
+ "inputType": "month"
323
+ }
324
+ }
325
+ ```
326
+ Uso: campo de mes basico para competencia.
327
+
328
+ ### 6. Exemplo Corporativo (JSON + Uso)
329
+ ```json
330
+ {
331
+ "componentId": "pdx-month-input",
332
+ "metadata": {
333
+ "name": "billingMonth",
334
+ "label": "Competencia",
335
+ "controlType": "month",
336
+ "inputType": "month",
337
+ "required": true,
338
+ "min": "2024-01",
339
+ "max": "2026-12",
340
+ "hint": "Selecione a competencia de faturamento",
341
+ "clearButton": {
342
+ "enabled": true,
343
+ "showOnlyWhenFilled": true
344
+ }
345
+ },
346
+ "visible": true
347
+ }
348
+ ```
349
+ Uso: competencia mensal com limites de negocio e feedback de validacao.
350
+
351
+ ### 7. Troubleshooting e Armadilhas Comuns
352
+ 1. Valor fora do formato esperado.
353
+ Correcao: usar `YYYY-MM`.
354
+
355
+ 2. `min/max` nao aplicando.
356
+ Correcao: validar que ambos os limites usam `YYYY-MM`.
357
+
358
+ 3. Campo esperado com precisao de dia.
359
+ Correcao: usar `pdx-date-input` quando for necessario dia.
360
+
361
+ 4. Clear nao aparece.
362
+ Correcao: habilitar `metadata.clearButton.enabled`.
363
+
364
+ 5. Campo oculto bloqueando submit.
365
+ Correcao: alinhar `visible` com obrigatoriedade e regra de negocio.
366
+
367
+ ### 8. Cross-links
368
+ - `projects/praxis-dynamic-fields/src/lib/base/pdx-base-input-runtime-contract.json-api.md`
369
+ - `projects/praxis-dynamic-fields/src/lib/components/date-input/pdx-date-input.json-api.md`
370
+ - `projects/praxis-dynamic-fields/src/lib/components/week-input/pdx-week-input.json-api.md`
371
+
372
+ ### 9. Relatorio de Validacao Estrutural
373
+ - Visao geral: PASS
374
+ - API (inputs/outputs): PASS
375
+ - Cobertura JSON completa (especifico + herdado): PASS
376
+ - Mapeamento de comportamento: PASS
377
+ - Exemplo minimo: PASS
378
+ - Exemplo corporativo: PASS
379
+ - Troubleshooting: PASS
380
+
381
+ ## JSON path index (obrigatorio)
382
+
383
+ | Path | Type | Required | Default | Status | Notes |
384
+ | --- | --- | --- | --- | --- | --- |
385
+ | `metadata` | object | true | n/a | Partial | See Detailed API reference. |
386
+ | `readonlyMode` | boolean | false | n/a | Partial | See Detailed API reference. |
387
+ | `disabledMode` | boolean | false | n/a | Partial | See Detailed API reference. |
388
+ | `visible` | boolean | false | n/a | Partial | See Detailed API reference. |
389
+ | `presentationMode` | boolean | false | n/a | Partial | See Detailed API reference. |
390
+ | `metadata.controlType` | string | false | n/a | Partial | See Detailed API reference. |
391
+ | `metadata.inputType` | string | false | n/a | Partial | See Detailed API reference. |
392
+ | `metadata.min` | number | false | n/a | Partial | See Detailed API reference. |
393
+ | `metadata.max` | number | false | n/a | Partial | See Detailed API reference. |
394
+ | `metadata.clearButton.*` | object | false | n/a | Partial | See Detailed API reference. |
395
+
396
+ ## Events reference (obrigatorio)
397
+
398
+ | Event | Payload | Trigger | Stability | Notes |
399
+ | --- | --- | --- | --- | --- |
400
+ | `validationChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
401
+ | `valueChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
402
+ | `focusChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
403
+ | `nativeBlur` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
404
+ | `nativeChange` | unknown | runtime-event | Experimental | Check component/runtime implementation. |
405
+
406
+ ## Styling API (obrigatorio quando aplicavel)
407
+
408
+ | Token/Class | Scope | Purpose | Notes |
409
+ | --- | --- | --- | --- |
410
+ | `not-yet-verified` | component | Styling contract not yet verified | Use Detailed API reference for component-specific styling notes. |
411
+
412
+ ## Examples (obrigatorio)
413
+
414
+ | Example | Scenario | Validates | Notes |
415
+ | --- | --- | --- | --- |
416
+ | `Minimal valid` | baseline payload | required contract blocks | Extracted from preserved technical reference when available. |
417
+ | `Common setup` | common component usage | standard runtime behavior | Validate against host integration path. |
418
+ | `Advanced setup` | richer config with overrides | precedence and normalization | Requires runtime confirmation for edge cases. |
419
+ | `Enterprise scenario` | governance/legacy/migration context | auditability and compatibility boundaries | Include tenant-specific constraints when applicable. |
420
+
421
+ ### Minimal valid
422
+
423
+ ```json
424
+ {
425
+ "componentId": "pdx-month-input",
426
+ "metadata": {
427
+ "name": "referenceMonth",
428
+ "label": "Mes de referencia",
429
+ "controlType": "month",
430
+ "inputType": "month"
431
+ },
432
+ "readonlyMode": false
433
+ }
434
+ ```
435
+
436
+ ### Common setup
437
+
438
+ ```json
439
+ {
440
+ "componentId": "pdx-month-input",
441
+ "metadata": {
442
+ "name": "billingMonth",
443
+ "label": "Competencia",
444
+ "controlType": "pdx-month-input-common",
445
+ "inputType": "month",
446
+ "required": true,
447
+ "min": "2024-01",
448
+ "max": "2026-12",
449
+ "hint": "Selecione a competencia de faturamento",
450
+ "clearButton": {
451
+ "enabled": true,
452
+ "showOnlyWhenFilled": true
453
+ }
454
+ },
455
+ "visible": true
456
+ }
457
+ ```
458
+
459
+ ### Advanced setup
460
+
461
+ ```json
462
+ {
463
+ "componentId": "pdx-month-input",
464
+ "metadata": {
465
+ "name": "billingMonth",
466
+ "label": "Competencia",
467
+ "controlType": "month",
468
+ "inputType": "month",
469
+ "required": true,
470
+ "min": 5,
471
+ "max": "2026-12",
472
+ "hint": "Selecione a competencia de faturamento",
473
+ "clearButton": {
474
+ "enabled": true,
475
+ "showOnlyWhenFilled": true
476
+ }
477
+ },
478
+ "visible": true,
479
+ "readonlyMode": false,
480
+ "disabledMode": false
481
+ }
482
+ ```
483
+
484
+ ### Enterprise scenario
485
+
486
+ ```json
487
+ {
488
+ "componentId": "pdx-month-input",
489
+ "metadata": {
490
+ "name": "billingMonth",
491
+ "label": "Competencia",
492
+ "controlType": "month",
493
+ "inputType": "month",
494
+ "required": true,
495
+ "min": "2024-01",
496
+ "max": "2026-12",
497
+ "hint": "Selecione a competencia de faturamento",
498
+ "clearButton": {
499
+ "enabled": true,
500
+ "showOnlyWhenFilled": true
501
+ }
502
+ },
503
+ "visible": true,
504
+ "presentationMode": true
505
+ }
506
+ ```
507
+
508
+ ## Compatibility and migration notes (recomendado)
509
+
510
+ | Concern | Affected versions | Migration action | Deadline | Notes |
511
+ | --- | --- | --- | --- | --- |
512
+ | 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 |
513
+
514
+ ## Known limitations and mismatches (recomendado)
515
+
516
+ | Path/Behavior | Observed behavior (runtime) | Desired behavior | Impact | Tracking issue | Target fix |
517
+ | --- | --- | --- | --- | --- | --- |
518
+ | 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 |
519
+
520
+ ## Source references (obrigatorio)
521
+
522
+ | Source type | Path/URL | Why it is source of truth | Last verified (YYYY-MM-DD) | Notes |
523
+ | --- | --- | --- | --- | --- |
524
+ | schema-metadata | projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.metadata.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
525
+ | runtime-code | projects/praxis-dynamic-fields/src/lib/components/month-input/month-input.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
526
+ | runtime-code | projects/praxis-dynamic-fields/src/lib/base/simple-base-input.component.ts | Primary source of truth for contract and behavior. | 2026-03-06 | verified-path |
527
+ | 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 |