@wildo-ai/framework-knowledge 1.1.1 → 1.1.3
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/dist/esm/framework-knowledge.definitions.d.ts +1 -1
- package/dist/esm/framework-knowledge.definitions.d.ts.map +1 -1
- package/dist/esm/framework-knowledge.definitions.js +271 -8
- package/dist/esm/framework-knowledge.definitions.js.map +1 -1
- package/dist/esm/framework-knowledge.loader.d.ts +19 -0
- package/dist/esm/framework-knowledge.loader.d.ts.map +1 -1
- package/dist/esm/framework-knowledge.loader.js +32 -0
- package/dist/esm/framework-knowledge.loader.js.map +1 -1
- package/dist/esm/framework-knowledge.schemas.d.ts +13 -2
- package/dist/esm/framework-knowledge.schemas.d.ts.map +1 -1
- package/dist/esm/framework-knowledge.schemas.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts +45 -0
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js +55 -0
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +6 -7
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js +6 -6
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts +0 -4
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js +0 -2
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts +0 -4
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js +0 -2
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts +3 -9
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js +1 -3
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts +10 -6
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +25 -4
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts +1 -5
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js +1 -3
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts +4 -2
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js +4 -2
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts +1 -2
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js +13 -14
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts +3 -5
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js +3 -4
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts +2 -8
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts +2 -8
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts +52 -0
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js +127 -0
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts +75 -0
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js +91 -0
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.d.ts +29 -0
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.js +28 -0
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +9 -45
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js +4 -54
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.d.ts +30 -0
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.js +25 -0
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts +2 -9
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js +9 -5
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts +0 -1
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js +0 -1
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts +0 -1
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.js +0 -1
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts +0 -9
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts +2 -8
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts +2 -8
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts +2 -8
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js +5 -4
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts +0 -4
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js +0 -2
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts +4 -6
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js +25 -5
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js.map +1 -1
- package/dist/knowledge/manifest.json +6 -7
- package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +7 -47
- package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +6 -13
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +1 -82
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +11 -6
- package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +10 -5
- package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +3 -4
- package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +3 -4
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +15 -735
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +11 -7
- package/dist/knowledge/playbooks/refinement.document-facts/method.md +16 -123
- package/dist/knowledge/playbooks/refinement.document-facts/playbook.json +15 -8
- package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +10 -4
- package/dist/knowledge/playbooks/top_down.business-model/playbook.json +10 -4
- package/dist/knowledge/playbooks/top_down.capability-map/method.md +2 -2
- package/dist/knowledge/playbooks/top_down.capability-map/playbook.json +12 -5
- package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +10 -4
- package/dist/knowledge/playbooks/{top_down.market-snapshot-produce → top_down.market-analysis}/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/{top_down.market-snapshot-produce → top_down.market-analysis}/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.market-analysis/method.md +165 -51
- package/dist/knowledge/playbooks/top_down.market-analysis/playbook.json +39 -21
- package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +2 -6
- package/dist/knowledge/playbooks/top_down.requirements-definition/playbook.json +10 -4
- package/dist/knowledge/playbooks/top_down.scope-roadmap/method.md +1 -1
- package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +11 -5
- package/dist/knowledge/playbooks/top_down.value-proposition/method.md +2 -2
- package/dist/knowledge/playbooks/top_down.value-proposition/playbook.json +11 -5
- package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +10 -4
- package/dist/knowledge/references/build-plan.task-graph.config.md +1 -45
- package/dist/knowledge/references/example.config.app-shell.full.md +4 -0
- package/dist/knowledge/references/example.provider.backend-module-shape.md +0 -7
- package/dist/knowledge/references/example.resource.add-resource.module-factory-map.md +1 -0
- package/dist/knowledge/references/platform.config.saas.md +0 -50
- package/dist/knowledge/references/saas.external-data.admin-endpoints.md +48 -0
- package/dist/knowledge/references/saas.frontend.app-level-component.configuration.md +10 -6
- package/dist/knowledge/references/saas.frontend.app-level-component.vocabulary.md +1 -0
- package/dist/knowledge/references/saas.frontend.resource-operation-frontend-config.md +0 -109
- package/dist/knowledge/references/saas.models.data-mode-read-list.md +0 -137
- package/dist/knowledge/references/saas.models.http-api-binding.md +29 -3
- package/dist/knowledge/references/saas.models.resource-config.builder-parameters.md +2 -4
- package/dist/knowledge/references/saas.models.resource-config.resource-configuration.md +0 -2
- package/dist/knowledge/references/saas.models.resource-config.resources-registry.md +0 -14
- package/dist/knowledge/references/saas.specifications.application-document-fact-specification.contract.md +1 -1
- package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +0 -36
- package/dist/knowledge/references/zod.decorators.chainable-runtime.md +0 -26
- package/dist/knowledge/references/zod.decorators.decorator-vocabulary.md +0 -45
- package/dist/knowledge/references/zod.decorators.display-edit-modes.md +1 -1
- package/dist/knowledge/references/zod.decorators.per-primitive-ui.md +1 -1
- package/dist/knowledge/references/zod.decorators.schema-metadata.md +0 -1
- package/dist/knowledge/registries/assurance-authority-bases.json +1 -1
- package/dist/knowledge/registries/framework-topics.json +11 -48
- package/dist/knowledge/registries/playbooks.json +11 -74
- package/dist/knowledge/registries/source-tags.json +538 -622
- package/dist/knowledge/skills/INDEX.md +0 -1
- package/dist/knowledge/skills/compliance-document-authoring/SKILL.md +2 -16
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-governance.md +8 -26
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-privacy-notice.md +74 -252
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-service-terms.md +8 -26
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-application-document-fact-specification-contract.md +21 -36
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-assurance-document-blueprint-contract.md +19 -49
- package/dist/knowledge/skills/config-app-shell/SKILL.md +8 -6
- package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-api.md +11 -6
- package/dist/knowledge/skills/config-saas/references/framework-wildo-saas-config-api.md +0 -50
- package/dist/knowledge/skills/configure-billing/references/example-backend-provider-module-shape.md +0 -7
- package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +0 -36
- package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +0 -36
- package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +0 -36
- package/dist/knowledge/skills/resource-add-field/references/framework-field-cross-layer-api.md +0 -109
- package/dist/knowledge/skills/resource-add-resource/SKILL.md +1 -2
- package/dist/knowledge/skills/resource-add-resource/references/framework-new-resource-core-config-api.md +2 -4
- package/dist/knowledge/skills/resource-config-wiring/SKILL.md +0 -2
- package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-resource-config-api.md +2 -157
- package/dist/knowledge/skills/resource-custom-view/references/custom-view-contracts.md +0 -109
- package/dist/knowledge/skills/resource-external-data/SKILL.md +2 -0
- package/dist/knowledge/skills/resource-external-data/references/framework-http-api-binding-api.md +29 -3
- package/dist/knowledge/skills/resource-external-data/references/framework-pipeline-admin-endpoints-api.md +70 -0
- package/dist/knowledge/skills/resource-schema-authoring/SKILL.md +0 -1
- package/dist/knowledge/skills/resource-schema-authoring/references/decorator-layer-map.md +0 -17
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-decorator-vocabulary-api.md +0 -46
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-zod-lifecycle-and-chainable-api.md +0 -26
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-display-edit-modes-api.md +1 -1
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-frontend-resource-ui-contracts-api.md +0 -109
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-per-primitive-ui-api.md +1 -1
- package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +0 -36
- package/dist/knowledge/topic-index.json +128 -285
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +4 -4
- package/dist/esm/.builder.pid +0 -9
- package/dist/knowledge/playbooks/bottom_up.placement-plan/method.md +0 -185
- package/dist/knowledge/playbooks/bottom_up.placement-plan/playbook.json +0 -66
- package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/method.md +0 -56
- package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/playbook.json +0 -40
- package/dist/knowledge/playbooks/top_down.market-research/method.md +0 -68
- package/dist/knowledge/playbooks/top_down.market-research/playbook.json +0 -42
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/method.md +0 -239
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/playbook.json +0 -69
- package/dist/knowledge/references/placement-plan.config.md +0 -330
- package/dist/knowledge/references/saas.frontend.settings-hub.engine-destinations.md +0 -58
- package/dist/knowledge/references/saas.frontend.settings-hub.placement.md +0 -118
- package/dist/knowledge/references/zod.decorators.data-categories.md +0 -197
- package/dist/knowledge/rules/resource-schema-awareness.md +0 -77
- package/dist/knowledge/skills/resource-config-wiring/references/framework-personal-data-declaration-api.md +0 -622
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-personal-data-category-api.md +0 -245
- package/dist/knowledge/skills/settings-placement-authoring/SKILL.md +0 -134
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-destinations-catalog.md +0 -65
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-placement-api.md +0 -127
- /package/dist/knowledge/playbooks/{top_down.market-snapshot-produce → top_down.market-analysis}/structured-artifact-action.json +0 -0
|
@@ -143,106 +143,6 @@ export enum ActionPlacement {
|
|
|
143
143
|
DANGER_ZONE = 'danger_zone',
|
|
144
144
|
}
|
|
145
145
|
|
|
146
|
-
/**
|
|
147
|
-
* HOW an operation's action collects its input and shows its result — the chrome the user meets
|
|
148
|
-
* when they click the button.
|
|
149
|
-
*
|
|
150
|
-
* ## Why this axis exists
|
|
151
|
-
*
|
|
152
|
-
* Until this axis, one rule decided the answer for every custom operation:
|
|
153
|
-
* *has a `requestDto` ⇒ navigate*. So an action asking for a single reason string got the same
|
|
154
|
-
* full-page treatment as a multi-step wizard, and the only way out was to author
|
|
155
|
-
* `navigationOverrides` — per operation, in terms of a zone, a transition verb and an appearance.
|
|
156
|
-
* Three concepts to answer one question.
|
|
157
|
-
*
|
|
158
|
-
* This is that one question. It is a **display-only** axis: backend authorization is untouched and
|
|
159
|
-
* `roles` remain the only security authority, exactly like its siblings {@link ActionVisibility},
|
|
160
|
-
* {@link ActionPlacement} and {@link ResourceOperationActionScope}.
|
|
161
|
-
*
|
|
162
|
-
* ## It is an ALIAS, not a parallel mechanism
|
|
163
|
-
*
|
|
164
|
-
* `MODAL` and `PAGE` do not render anything themselves — they resolve to the navigation transitions
|
|
165
|
-
* that already exist (`OVERLAY`, and the ordinary chain), so there is one runtime mechanism and one
|
|
166
|
-
* set of zone/appearance/URL semantics. `DIRECT`, `POPOVER` and `INLINE` never enter navigation at
|
|
167
|
-
* all, because none of them is a destination: nothing is pushed, no zone changes, and there is
|
|
168
|
-
* nothing for a back button to pop. `INLINE` is hosted by the collection the element belongs to —
|
|
169
|
-
* see `InPlaceOperationContext` for why that is not the navigation layer's job.
|
|
170
|
-
*
|
|
171
|
-
* Consequently an explicit `navigationOverrides` entry still WINS over a presentation authored here
|
|
172
|
-
* (it is the more specific instrument, and it is checked first in the resolution chain). Author this
|
|
173
|
-
* axis to say what KIND of chrome the action wants; author `navigationOverrides` when you need to
|
|
174
|
-
* name the zone, the appearance or the viewport yourself.
|
|
175
|
-
*
|
|
176
|
-
* ## When omitted
|
|
177
|
-
*
|
|
178
|
-
* It is DERIVED from the operation — see `resolveResourceOperationActionPresentation()`. An
|
|
179
|
-
* operation that asks for nothing executes directly; a small field set opens a modal; input the
|
|
180
|
-
* framework cannot fit in an overlay (files, nested writes, a large field set) keeps the page it
|
|
181
|
-
* has always had. An operation whose `surface` is `ADDRESSABLE` always keeps its page: the author
|
|
182
|
-
* has already said it is a deep-linkable destination.
|
|
183
|
-
*/
|
|
184
|
-
export enum ResourceOperationActionPresentation {
|
|
185
|
-
/**
|
|
186
|
-
* Execute on click, with no form at all — the confirmation dialog for a risky operation is the
|
|
187
|
-
* only thing between the click and the request.
|
|
188
|
-
*
|
|
189
|
-
* Only meaningful for an operation that needs no caller input. Declaring it on an operation that
|
|
190
|
-
* DOES have required request fields would send an empty body, so the resolver refuses to derive it
|
|
191
|
-
* there and an author who declares it anyway gets the operation's fields dropped — check
|
|
192
|
-
* `requestDto` before reaching for this.
|
|
193
|
-
*/
|
|
194
|
-
DIRECT = 'direct',
|
|
195
|
-
/**
|
|
196
|
-
* A small form anchored to the button that opened it, dismissed by clicking away.
|
|
197
|
-
*
|
|
198
|
-
* The single-input idiom ("assign to…", "snooze until…"). Transient by construction: no URL, no
|
|
199
|
-
* history entry, nothing to deep-link. Use it when the surrounding context is the point — the user
|
|
200
|
-
* is reading the row they are acting on and must not lose sight of it.
|
|
201
|
-
*/
|
|
202
|
-
POPOVER = 'popover',
|
|
203
|
-
/**
|
|
204
|
-
* The element being acted on transforms in place to collect the input, leaving its neighbours
|
|
205
|
-
* visible — the row becomes the form rather than being covered by one.
|
|
206
|
-
*
|
|
207
|
-
* Use it when the surrounding rows are the point: the user is comparing, and an overlay would hide
|
|
208
|
-
* the very thing that made them act on this row.
|
|
209
|
-
*
|
|
210
|
-
* **Transient, like {@link POPOVER}, and for the same reason.** Nothing is pushed, no URL changes,
|
|
211
|
-
* and a reload returns the list to rest. An inline row-edit is a momentary state of a listing, not
|
|
212
|
-
* a place — which is also why no admin framework deep-links one, and why anything that SHOULD be
|
|
213
|
-
* linkable, reloadable or reachable by a back button wants {@link PAGE}.
|
|
214
|
-
*
|
|
215
|
-
* **It requires a collection.** The host is provided by the list the element belongs to
|
|
216
|
-
* (`InPlaceOperationProvider`); the same action rendered on a detail page, in a danger zone or in a
|
|
217
|
-
* picker has no row to transform and degrades to an overlay rather than becoming a dead button.
|
|
218
|
-
*
|
|
219
|
-
* Note it does NOT resolve to `NavigationTransition.INPLACE`. Element-level hosting uses none of
|
|
220
|
-
* what the navigation layer offers — no zone, no stack entry, no appearance — and routing it there
|
|
221
|
-
* is exactly why that transition has never done what its own docstring promises. See
|
|
222
|
-
* `InPlaceOperationContext`.
|
|
223
|
-
*/
|
|
224
|
-
INLINE = 'inline',
|
|
225
|
-
/**
|
|
226
|
-
* An overlay above the layout — the workhorse for "a handful of fields", and the default the
|
|
227
|
-
* derivation reaches for.
|
|
228
|
-
*
|
|
229
|
-
* Resolves to {@link NavigationTransition.OVERLAY}. The concrete appearance (dialog / sheet /
|
|
230
|
-
* drawer / panel) stays the app's decision, resolved from its navigation layout exactly as any
|
|
231
|
-
* other overlay: this axis says "an overlay", not "a dialog specifically". Author
|
|
232
|
-
* `navigationOverrides` when you need to name one.
|
|
233
|
-
*/
|
|
234
|
-
MODAL = 'modal',
|
|
235
|
-
/**
|
|
236
|
-
* A routable page, resolved through the ordinary navigation chain (zone transitions, viewport
|
|
237
|
-
* overrides, the framework `PUSH` fallback) — i.e. exactly the behaviour every parameterised
|
|
238
|
-
* action had before this axis existed.
|
|
239
|
-
*
|
|
240
|
-
* The right answer for complex or multi-step input, and for anything a user should be able to
|
|
241
|
-
* link to, reload, or reach with a back button.
|
|
242
|
-
*/
|
|
243
|
-
PAGE = 'page',
|
|
244
|
-
}
|
|
245
|
-
|
|
246
146
|
/**
|
|
247
147
|
* Does an operation's action target a SINGLE resource instance, or the WHOLE
|
|
248
148
|
* collection in the current scope?
|
|
@@ -417,15 +317,6 @@ export const ResourceOperationFrontendConfigSchema = z.object({
|
|
|
417
317
|
* row id still rides the URL path too, which the handler may ignore.)
|
|
418
318
|
*/
|
|
419
319
|
rowTargetRequestField: z.string().optional(),
|
|
420
|
-
/**
|
|
421
|
-
* HOW this action collects its input — see {@link ResourceOperationActionPresentation}.
|
|
422
|
-
* Omitted derives from the operation (`resolveResourceOperationActionPresentation`): no input
|
|
423
|
-
* executes directly, a small field set opens a modal, complex input keeps its page.
|
|
424
|
-
*
|
|
425
|
-
* Display-only. An explicit `navigationOverrides` entry is the more specific instrument and wins
|
|
426
|
-
* over whatever this resolves to.
|
|
427
|
-
*/
|
|
428
|
-
actionPresentation: z.enum(ResourceOperationActionPresentation).optional(),
|
|
429
320
|
customView: z.any().optional(),
|
|
430
321
|
displayPresetOverride: z.object({
|
|
431
322
|
resourceLayoutPresetKey: z.string().optional(),
|
|
@@ -45,147 +45,10 @@ export enum DataMode {
|
|
|
45
45
|
*
|
|
46
46
|
* If not specified at resource level, uses `appConfig.database.defaultAdapter`.
|
|
47
47
|
*/
|
|
48
|
-
/**
|
|
49
|
-
* What an INTROSPECTION-backed resource projects.
|
|
50
|
-
*
|
|
51
|
-
* Declared BY THE AUTHOR beside the resource, exactly as `httpApiBinding` is, and for the same
|
|
52
|
-
* reason: the adapter answers "how rows are reached", and everything specific to THIS resource's
|
|
53
|
-
* reach is a typed declaration rather than runtime inference.
|
|
54
|
-
*
|
|
55
|
-
* Keeping it here rather than in a companion-side lookup table matters. A table keyed by resource
|
|
56
|
-
* type would be a second enumeration of a population the resource configs already define — the
|
|
57
|
-
* shape that silently drifts when one side gains an entry.
|
|
58
|
-
*/
|
|
59
|
-
export enum IntrospectionTenancyStance {
|
|
60
|
-
/**
|
|
61
|
-
* The rows describe the APPLICATION'S OWN STRUCTURE — its modules, resource specifications,
|
|
62
|
-
* design system, compliance declarations — and carry no tenant dimension, so there is nothing for
|
|
63
|
-
* a contextual scope predicate to filter on.
|
|
64
|
-
*
|
|
65
|
-
* This is the only stance implemented, and it is declared rather than inferred for the reason
|
|
66
|
-
* `HttpApiTenancyStance` gives for its own: an unstated stance is indistinguishable from an
|
|
67
|
-
* overlooked one. Every other repository enforces scoping ITSELF — Mongo and PostgreSQL through
|
|
68
|
-
* `buildContextualFilter`, HTTP_API through its tenancy stance — so a read-through adapter that
|
|
69
|
-
* simply returned whatever its source produced would be the one backing kind with no scoping
|
|
70
|
-
* story, and nobody would be asked to notice.
|
|
71
|
-
*/
|
|
72
|
-
APPLICATION_STRUCTURE = 'application-structure',
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* The rows carry a tenant dimension and a scope predicate must be pushed into the source.
|
|
76
|
-
*
|
|
77
|
-
* REFUSED AT REGISTRATION today: no introspection behavior takes a scope argument, so the engine
|
|
78
|
-
* has nothing to push down. Declared as a member rather than omitted so the refusal is explicit
|
|
79
|
-
* and a future scoped behavior is a deliberate design step — the alternative is that the first
|
|
80
|
-
* author needing it discovers the gap by shipping unscoped rows.
|
|
81
|
-
*/
|
|
82
|
-
SCOPE_FILTER_PUSHDOWN = 'scope-filter-pushdown',
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
export interface IntrospectionResourceBinding {
|
|
86
|
-
/**
|
|
87
|
-
* The companion introspection behavior whose output becomes this resource's rows.
|
|
88
|
-
*
|
|
89
|
-
* A plain string on purpose: the behavior catalog lives in the companion (23 behaviors as of
|
|
90
|
-
* 2026-08-29) and the engine must not depend on it. An unknown id is refused by the companion at
|
|
91
|
-
* read time, naming the id and the supported set.
|
|
92
|
-
*/
|
|
93
|
-
readonly behavior: string;
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
* Path into the behavior's result that holds the rows, dot-separated. Omitted means the result
|
|
97
|
-
* itself is the row collection.
|
|
98
|
-
*
|
|
99
|
-
* Behaviors answer their own natural shape — `{ frontendChartRegistrationRefs: [...] }` — and
|
|
100
|
-
* teaching each one to answer a uniform envelope would change 23 working behaviors to suit a
|
|
101
|
-
* consumer that arrived later.
|
|
102
|
-
*/
|
|
103
|
-
readonly rowsPath?: string;
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* REQUIRED. Why these rows need no contextual scope predicate, or that they do.
|
|
107
|
-
*
|
|
108
|
-
* Not optional and not defaulted: a default would make "nobody thought about tenancy" and
|
|
109
|
-
* "tenancy does not apply here" the same declaration.
|
|
110
|
-
*/
|
|
111
|
-
readonly tenancy: IntrospectionTenancyStance;
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* Fields whose values COMPOSE each row's primary key, in order, when the behavior's rows carry no
|
|
115
|
-
* identifier of their own.
|
|
116
|
-
*
|
|
117
|
-
* Most introspection behaviors answer structural projections rather than records: a module row
|
|
118
|
-
* carries `moduleId` and needs nothing here, while a relationship row carries only the two
|
|
119
|
-
* resource types it joins. Without a key such a resource can be LISTed and never READ, because
|
|
120
|
-
* there is no value to address a row by.
|
|
121
|
-
*
|
|
122
|
-
* Composition is DECLARED rather than derived because only the author knows which fields are
|
|
123
|
-
* jointly unique for a given behavior — and being wrong is not hypothetical. `resourceType1` +
|
|
124
|
-
* `resourceType2` is unique across all 16 relationships in the dogfood application and is still
|
|
125
|
-
* unsafe in general, since the framework permits several edges between the same pair (a junction
|
|
126
|
-
* with two roles, a self-relationship). So the source FAILS LOUDLY when two rows compose the same
|
|
127
|
-
* key rather than serving both under one id, which would make READ return an arbitrary one of
|
|
128
|
-
* them and give no sign anything was wrong.
|
|
129
|
-
*
|
|
130
|
-
* The composed value is written to the resource's own `resourceFieldIdentifier`, which is the one
|
|
131
|
-
* key name resolvable from the registry without introspecting the schema's decorators. A resource
|
|
132
|
-
* declaring `identityFields` must therefore name that field as its primary key.
|
|
133
|
-
*
|
|
134
|
-
* The values are joined verbatim, so the key stays READABLE — `workspace__users__createdByUserId`
|
|
135
|
-
* rather than an opaque hash. That is possible because an INTROSPECTION-backed resource resolves
|
|
136
|
-
* to `ResourceIdFormat.INTROSPECTION_SYNTHESIZED`, which admits a URL-safe charset instead of the
|
|
137
|
-
* ObjectId-or-UUID rule platform rows follow.
|
|
138
|
-
*
|
|
139
|
-
* It was briefly a deterministic UUIDv5, before that format existed. Hashing worked and was the
|
|
140
|
-
* wrong trade: it made every id opaque, and it disguised the real property — a DERIVED id is only
|
|
141
|
-
* as stable as the fields it is derived from, and hiding that behind a hash removes the reader's
|
|
142
|
-
* ability to notice when a row's identity moves.
|
|
143
|
-
*
|
|
144
|
-
* Each value must be URL-safe (`[a-zA-Z0-9_-]`) and the whole key at most 255 characters; the
|
|
145
|
-
* source refuses per row rather than emitting a key that lists and cannot be read.
|
|
146
|
-
*
|
|
147
|
-
* Omit when the behavior's rows already carry an identifier of their own.
|
|
148
|
-
*/
|
|
149
|
-
readonly identityFields?: readonly string[];
|
|
150
|
-
}
|
|
151
|
-
|
|
152
48
|
export enum PersistenceAdapter {
|
|
153
49
|
MONGODB = 'mongodb',
|
|
154
50
|
POSTGRESQL = 'postgresql',
|
|
155
51
|
|
|
156
|
-
/**
|
|
157
|
-
* Rows are DERIVED on demand by asking the running dev companion to introspect the application —
|
|
158
|
-
* its resource registry, specifications, design system, compliance facts, assertions, market and
|
|
159
|
-
* persona context. Nothing is stored: every read recomputes.
|
|
160
|
-
*
|
|
161
|
-
* ## Why this is an adapter and not a service call
|
|
162
|
-
*
|
|
163
|
-
* The companion already computes all of it — 23 named introspection behaviors — and today each is
|
|
164
|
-
* reachable only through a bespoke route. Making it an adapter is what turns those behaviors into
|
|
165
|
-
* ordinary RESOURCES: list, read, filter, search, labels, navigation, all generated, with no
|
|
166
|
-
* per-behavior UI. That is the same argument `HTTP_API` settled on 2026-08-26 — the adapter answers
|
|
167
|
-
* "how rows are reached", and the mechanism behind it is a binding an author declares.
|
|
168
|
-
*
|
|
169
|
-
* Distinct from `HTTP_API`, deliberately, and not merely because the transport differs. Retrieval
|
|
170
|
-
* is a SUBPROCESS that imports the target application's built modules; it costs seconds rather than
|
|
171
|
-
* milliseconds, it requires that application's `dist` to exist, and its failure mode is a behavior
|
|
172
|
-
* throwing rather than a row being absent. Collapsing the two would give one declaration whose
|
|
173
|
-
* discriminator chooses between an HTTP call and a subprocess — two adapters wearing one name.
|
|
174
|
-
*
|
|
175
|
-
* ## What every adapter decision site must honor
|
|
176
|
-
*
|
|
177
|
-
* - **READ-ONLY, absolutely.** There is no writable target: a row is a projection of the
|
|
178
|
-
* application's own source. Every write method refuses, as `HTTP_API`'s twelve do.
|
|
179
|
-
* - **No provisioning, migration or schema surface.** Nothing is stored, so there is nothing to
|
|
180
|
-
* create, migrate or verify — the platform must never believe it owns a store here.
|
|
181
|
-
* - **Never a legal application-wide DEFAULT adapter.** It is a per-resource declaration only;
|
|
182
|
-
* an application whose default was introspection could persist nothing at all.
|
|
183
|
-
* - **It must DEGRADE, never fail closed at boot.** The companion is the only thing that can run
|
|
184
|
-
* an introspection behavior, so a boot path that refuses on an introspection failure would need
|
|
185
|
-
* the companion to fix the companion — see `continuity-drift-and-cas-basis.md` Rule 3.
|
|
186
|
-
*/
|
|
187
|
-
INTROSPECTION = 'introspection',
|
|
188
|
-
|
|
189
52
|
/**
|
|
190
53
|
* Rows live in a system reached over an authenticated HTTP API and are queried on demand
|
|
191
54
|
* (read-through). Decided 2026-08-26 (ETL workstream, D1): this IS a persistence-adapter answer
|
|
@@ -11,9 +11,35 @@
|
|
|
11
11
|
```typescript
|
|
12
12
|
export enum HttpApiTransportDialect {
|
|
13
13
|
/**
|
|
14
|
-
* OData v4
|
|
15
|
-
*
|
|
16
|
-
*
|
|
14
|
+
* OData **v4** — one generic client: mechanical pushdown of
|
|
15
|
+
* `$filter`/`$select`/`$top`/`$skip`/`$orderby`/`$count`, with a `$metadata` boot-time
|
|
16
|
+
* verification probe of the committed declaration.
|
|
17
|
+
*
|
|
18
|
+
* ⚠ **This member is v4 ONLY, and that excludes SAP's most-used API.** An earlier revision of
|
|
19
|
+
* this comment named "SAP S/4HANA, Microsoft Dataverse/Dynamics 365" here, which is half right
|
|
20
|
+
* and was load-bearing — it is why nobody looked:
|
|
21
|
+
*
|
|
22
|
+
* | Target | Version | Consumable today |
|
|
23
|
+
* |---|---|---|
|
|
24
|
+
* | Microsoft Dataverse / Dynamics 365 Web API (`/api/data/v9.2/`) | v4 | ✅ |
|
|
25
|
+
* | SAP S/4HANA OData **v4** services (`/sap/opu/odata4/…`) | v4 | ✅ |
|
|
26
|
+
* | SAP `API_BUSINESS_PARTNER` (`/sap/opu/odata/sap/API_BUSINESS_PARTNER`) | **v2** | ❌ |
|
|
27
|
+
*
|
|
28
|
+
* v2 is not a v4 variant with a different header. Its collection envelope is
|
|
29
|
+
* `{ "d": { "results": [...], "__next": …, "__count": … } }` rather than
|
|
30
|
+
* `{ "value": [...], "@odata.nextLink": … }`; `Edm.DateTime` serializes as `"/Date(<ticks>)/"`
|
|
31
|
+
* rather than ISO 8601; `Edm.Decimal` and `Edm.Int64` serialize as JSON STRINGS rather than
|
|
32
|
+
* numbers; and JSON must be requested (`$format=json`) because v2 defaults to Atom/XML. So it
|
|
33
|
+
* changes the envelope, the paging property, the count property AND the value encoding — a
|
|
34
|
+
* reader written for one cannot read the other, and the mapping layer needs coercions the way
|
|
35
|
+
* Odoo needs `ODOO_FALSE_AS_NULL`.
|
|
36
|
+
* spec-cite: OData Version 2.0 JSON Format
|
|
37
|
+
* (https://www.odata.org/documentation/odata-version-2-0/json-format/) — the `d`/`results`/
|
|
38
|
+
* `__next`/`__count` envelope, the `/Date(<ticks>)/` DateTime literal, and Edm.Decimal /
|
|
39
|
+
* Edm.Int64 "formatted as a JSON string".
|
|
40
|
+
*
|
|
41
|
+
* Supporting v2 is an OPEN decision, not an oversight. Until it lands, point an ODATA binding at
|
|
42
|
+
* a v4 service: for SAP that means the OData v4 edition of the API where one is published.
|
|
17
43
|
*/
|
|
18
44
|
ODATA = 'odata',
|
|
19
45
|
|
|
@@ -306,9 +306,7 @@ export type ResourceConfiguration_BuilderParameters<
|
|
|
306
306
|
* stance, erasure stance, and remote-call semantics. The factory enforces presence/absence
|
|
307
307
|
* coherence and content-validates the declaration.
|
|
308
308
|
*/
|
|
309
|
-
httpApiBinding?:
|
|
310
|
-
/** REQUIRED when `persistenceAdapter` is INTROSPECTION; meaningless otherwise. */
|
|
311
|
-
introspectionBinding?: IntrospectionResourceBinding,
|
|
309
|
+
httpApiBinding?: HttpApiResourceBindingAuthored,
|
|
312
310
|
|
|
313
311
|
/**
|
|
314
312
|
* OPTIONAL inbound ETL pipeline on an ordinary LOCAL resource — "some resources local, some
|
|
@@ -319,7 +317,7 @@ export type ResourceConfiguration_BuilderParameters<
|
|
|
319
317
|
* targets exist, accept null unless `required`, and are excludeFromCreate/Update; CLOSED
|
|
320
318
|
* population refuses caller CREATE operations).
|
|
321
319
|
*/
|
|
322
|
-
externalDataPipeline?:
|
|
320
|
+
externalDataPipeline?: ExternalDataPipelineDeclarationAuthored,
|
|
323
321
|
|
|
324
322
|
isSystemResource?: boolean, // default false - true for core system resources (organizations, users, etc.), false for tenant-specific resources
|
|
325
323
|
|
|
@@ -60,8 +60,6 @@ export type ResourceConfiguration<
|
|
|
60
60
|
* (factory-enforced both ways). See the authoring-side declaration for the full contract.
|
|
61
61
|
*/
|
|
62
62
|
httpApiBinding?: HttpApiResourceBinding,
|
|
63
|
-
/** REQUIRED when `persistenceAdapter` is INTROSPECTION; meaningless otherwise. */
|
|
64
|
-
introspectionBinding?: IntrospectionResourceBinding,
|
|
65
63
|
|
|
66
64
|
/**
|
|
67
65
|
* The inbound ETL pipeline, when this LOCAL resource declared one — parsed + coherence-checked
|
|
@@ -19,20 +19,6 @@ export type ResourcesRegistry = {
|
|
|
19
19
|
resourceConfigurations: {
|
|
20
20
|
[key: ResourceType]: AnyResourceConfiguration ;
|
|
21
21
|
};
|
|
22
|
-
/**
|
|
23
|
-
* The resource types the APPLICATION registered — its own, never the engine's.
|
|
24
|
-
*
|
|
25
|
-
* The registry composes app and core factory maps into one `resourceConfigurations`, which is what
|
|
26
|
-
* every runtime consumer wants. This is the one place the two are still distinguishable, so the
|
|
27
|
-
* split is recorded HERE rather than re-derived by each consumer from a core key set — which would
|
|
28
|
-
* be a second enumeration of a population this file already knows.
|
|
29
|
-
*
|
|
30
|
-
* Its consumer today is the personal-data declaration report, which asks a question only an
|
|
31
|
-
* application author can act on: the engine declares its own posture on ~85 resources, and putting
|
|
32
|
-
* those in front of a reader of a report about THEIR application is how a diagnostic channel stops
|
|
33
|
-
* being read.
|
|
34
|
-
*/
|
|
35
|
-
applicationResourceTypes: ResourceType[];
|
|
36
22
|
/**
|
|
37
23
|
* Map of ResourceType to its standard field identifier (e.g., USERS -> userId).
|
|
38
24
|
* Used for FK field resolution without string manipulation.
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
export const ApplicationDocumentFactSpecificationSchema = z
|
|
31
31
|
.strictObject({
|
|
32
32
|
schemaVersion: z.literal(1),
|
|
33
|
-
specificationRef:
|
|
33
|
+
specificationRef: AssuranceNamespacedRefSchema,
|
|
34
34
|
specificationVersion: GovernedDocumentPositiveSafeIntegerSchema,
|
|
35
35
|
declarations: z.array(ApplicationDocumentFactDeclarationSchema).min(1),
|
|
36
36
|
})
|
|
@@ -54,7 +54,6 @@ export interface SpecificationsCompanionExports<
|
|
|
54
54
|
TRequirementsSnapshot = RequirementsSnapshot,
|
|
55
55
|
TRoadmapSnapshot = RoadmapSnapshot,
|
|
56
56
|
TBuildPlanTaskGraph = BuildPlanTaskGraph,
|
|
57
|
-
TPlacementPlan = PlacementPlan,
|
|
58
57
|
TDomainPlanOutputSet = DomainPlanOutputSet,
|
|
59
58
|
TBusinessModelLiteSnapshot = BusinessModelLiteSnapshot,
|
|
60
59
|
// Appended STRICTLY LAST (positional generics — never insert mid-list):
|
|
@@ -82,11 +81,6 @@ export interface SpecificationsCompanionExports<
|
|
|
82
81
|
// Appended STRICTLY LAST: release-process selection is a separate accepted
|
|
83
82
|
// decision, never an implicit default of routing or document necessity.
|
|
84
83
|
TDocumentReleasePolicySpecification = ApplicationDocumentReleasePolicySpecification,
|
|
85
|
-
// Appended STRICTLY LAST: WHO else processes personal data, under what legal
|
|
86
|
-
// identity and where (issue #88). Optional, and the optionality is the design:
|
|
87
|
-
// a partial register is useful and its holes are REPORTED per provider against
|
|
88
|
-
// the application's configured set, rather than blocking anything.
|
|
89
|
-
TProcessorRegister = ApplicationProcessorRegister,
|
|
90
84
|
> {
|
|
91
85
|
resourceSpecifications: TResourceSpecifications;
|
|
92
86
|
applicationBusinessSemanticsSnapshot?: TBusinessSemanticsSnapshot;
|
|
@@ -317,22 +311,6 @@ export interface SpecificationsCompanionExports<
|
|
|
317
311
|
* `validateBuildPlanTaskGraph` on the value before wiring it here.
|
|
318
312
|
*/
|
|
319
313
|
buildPlanSpecification?: TBuildPlanTaskGraph;
|
|
320
|
-
/**
|
|
321
|
-
* Application **placement** specification — WHERE every settings destination,
|
|
322
|
-
* resource operation and app view sits in the shell, and WHY (`PlacementPlan`,
|
|
323
|
-
* `_core/placement-plan/`).
|
|
324
|
-
*
|
|
325
|
-
* Produced by the `bottom_up.placement-plan` playbook as an expert-panel
|
|
326
|
-
* DELIBERATION rather than a creator elicitation: the creator does not choose
|
|
327
|
-
* placement, so each decision carries a `rationale` that answers "why is this
|
|
328
|
-
* here?" without re-running the panel. Consumed by build-decompose, which
|
|
329
|
-
* turns it into the coding tasks that author `settings-hub.config.ts` and
|
|
330
|
-
* `app-shell.config.ts`.
|
|
331
|
-
*
|
|
332
|
-
* Optional until an application reaches the bottom-up phase; app bootstraps
|
|
333
|
-
* should run `validatePlacementPlan` on the value before wiring it here.
|
|
334
|
-
*/
|
|
335
|
-
placementPlanSpecification?: TPlacementPlan;
|
|
336
314
|
/**
|
|
337
315
|
* Application **domain-plan** specification — the atomic module decomposition
|
|
338
316
|
* PLUS relationship drafts (`DomainPlanOutputSet`, `_core/domain-plan/`);
|
|
@@ -471,20 +449,6 @@ export interface SpecificationsCompanionExports<
|
|
|
471
449
|
* Omitting it is honest: unresolved document facts remain visible gaps.
|
|
472
450
|
*/
|
|
473
451
|
documentFactSpecification?: TDocumentFactSpecification;
|
|
474
|
-
/**
|
|
475
|
-
* WHO else processes this application's personal data — legal identity, processing region and the
|
|
476
|
-
* processor's own subprocessors (issue #88).
|
|
477
|
-
*
|
|
478
|
-
* A configured provider already establishes THAT a third party is involved and what function it
|
|
479
|
-
* performs. None of that is what a privacy notice's recipient statement needs, and an
|
|
480
|
-
* international-transfer statement cannot be made at all without a region.
|
|
481
|
-
*
|
|
482
|
-
* Optional, and its holes are reported rather than blocking: the companion compares this register
|
|
483
|
-
* against the application's CONFIGURED providers and names each one that is undeclared, so a partial
|
|
484
|
-
* register is useful and an empty one still produces an actionable document. An absent entry means
|
|
485
|
-
* nobody has established that processor's identity — never that the provider is unused.
|
|
486
|
-
*/
|
|
487
|
-
processorRegister?: TProcessorRegister;
|
|
488
452
|
/**
|
|
489
453
|
* Accepted application-declared semantic causality between whole
|
|
490
454
|
* specification-family states. This is not the registry's physical
|
|
@@ -231,32 +231,6 @@ function applySingleDecorator<T extends z.ZodTypeAny>(
|
|
|
231
231
|
currentMetadata[ZodDecorator.PORTABILITY_PROVENANCE] = raw;
|
|
232
232
|
break;
|
|
233
233
|
}
|
|
234
|
-
case ZodDecorator.DATA_CATEGORIES: {
|
|
235
|
-
// NORMALIZE HERE, not in the doors — the impersonalizeWith discipline. A single value (the
|
|
236
|
-
// common case) and an array both store a deduped ARRAY, so every reader sees one shape and
|
|
237
|
-
// `getDataCategories` answers "is this field categorized?" by presence alone.
|
|
238
|
-
//
|
|
239
|
-
// Fail LOUD on an empty declaration. An UNCATEGORIZED field is a legitimate, common state —
|
|
240
|
-
// most fields are not personal data — and the gap report is built on ABSENCE. A stored empty
|
|
241
|
-
// array would read back as declared-with-no-categories, which is invisible to a report
|
|
242
|
-
// looking for absence: the field would be silently excluded from the notice while looking
|
|
243
|
-
// annotated to anyone reading the schema.
|
|
244
|
-
//
|
|
245
|
-
// WHETHER each value is a real `PersonalDataCategory` member is checked by the resource
|
|
246
|
-
// factory's boot guard, which owns the enum — this layer knows only that non-empty strings
|
|
247
|
-
// were declared.
|
|
248
|
-
const raw = p as unknown;
|
|
249
|
-
const authored: readonly unknown[] = Array.isArray(raw) ? raw : [raw];
|
|
250
|
-
if (authored.length === 0 || authored.some((value) => typeof value !== 'string' || value.trim().length === 0)) {
|
|
251
|
-
throw new Error(
|
|
252
|
-
`dataCategories(categories) requires at least one non-empty PersonalDataCategory value (received ${JSON.stringify(raw)}). ` +
|
|
253
|
-
`A field that holds no personal data carries NO declaration — absence is what a category gap report reads. ` +
|
|
254
|
-
`An empty declaration looks annotated and discloses nothing.`,
|
|
255
|
-
);
|
|
256
|
-
}
|
|
257
|
-
currentMetadata[ZodDecorator.DATA_CATEGORIES] = [...new Set(authored as readonly string[])];
|
|
258
|
-
break;
|
|
259
|
-
}
|
|
260
234
|
case ZodDecorator.IS_AUDIT_EVIDENCE:
|
|
261
235
|
currentMetadata[ZodDecorator.IS_AUDIT_EVIDENCE] = true;
|
|
262
236
|
break;
|
|
@@ -57,40 +57,6 @@ export enum ZodDecorator {
|
|
|
57
57
|
* `SUBJECT_PROVIDED` and masked on erasure.
|
|
58
58
|
*/
|
|
59
59
|
PORTABILITY_PROVENANCE = "portabilityProvenance",
|
|
60
|
-
/**
|
|
61
|
-
* Data categories: WHICH KINDS of personal data this field holds — one or more
|
|
62
|
-
* `PersonalDataCategory` values (strings), read by the compliance fact producer to answer the
|
|
63
|
-
* privacy-notice question "which categories of personal data do you process".
|
|
64
|
-
*
|
|
65
|
-
* Authored fluently: `email: z.email().dataCategories(PersonalDataCategory.CONTACT_DETAILS)`, or
|
|
66
|
-
* with an array when a field genuinely spans two —
|
|
67
|
-
* `.dataCategories([PersonalDataCategory.USER_CONTENT, PersonalDataCategory.SPECIAL_CATEGORY_HEALTH])`.
|
|
68
|
-
* The chokepoint normalizes either form to a deduped array, so every reader sees one shape.
|
|
69
|
-
* At least one category is REQUIRED and each must be a non-empty string: a blank declaration
|
|
70
|
-
* would read back as declared-but-meaningless, which is worse than absent, because absence is
|
|
71
|
-
* what the gap report is looking for. `addDataCategories(schema, categories)` is the equivalent
|
|
72
|
-
* programmatic escape hatch; read them back with `getDataCategories(schema)`.
|
|
73
|
-
*
|
|
74
|
-
* WHETHER each value is a real `PersonalDataCategory` member is checked by the resource factory's
|
|
75
|
-
* boot guard, which owns the enum — this layer knows only that non-empty strings were declared.
|
|
76
|
-
*
|
|
77
|
-
* ⚠️ Four adjacent axes, none of them this one. {@link ZodDecorator.IMPERSONALIZE_WITH} says what
|
|
78
|
-
* happens to the value on ERASURE; {@link ZodDecorator.PORTABILITY_PROVENANCE} says where it CAME
|
|
79
|
-
* FROM; `Compliance_DataClassification` is a SENSITIVITY ladder for flows-actors config; a
|
|
80
|
-
* retention class says HOW LONG it is kept. A single field is routinely all five at once, and
|
|
81
|
-
* none of the other four can answer "what kind of personal data is this".
|
|
82
|
-
*
|
|
83
|
-
* ⚠️ Do NOT declare a category on a field merely because its NAME suggests one. The decorator
|
|
84
|
-
* exists precisely so categories are never derived from identifiers: `email`, `phone` and
|
|
85
|
-
* `dateOfBirth` are suggestive while `notes` is not, and an inventory assembled by
|
|
86
|
-
* pattern-matching names is a guess whose misses are silently undisclosed. `CREDENTIALS` is the
|
|
87
|
-
* one category the producer derives, and it derives it from `.isPassword()` / `.isOtp()` /
|
|
88
|
-
* `.isWriteOnlySecret()` — markers the author wrote, not names it read.
|
|
89
|
-
*
|
|
90
|
-
* assurance-control: WILDO.PRIVACY.PERSONAL_DATA_INVENTORY — the application declares which
|
|
91
|
-
* categories of personal data each field holds
|
|
92
|
-
*/
|
|
93
|
-
DATA_CATEGORIES = "dataCategories",
|
|
94
60
|
/**
|
|
95
61
|
* Audit evidence: this field's BEFORE/AFTER VALUES are recorded when a resource operation
|
|
96
62
|
* mutates it, on the `resource_operation_performed` audit event.
|
|
@@ -263,12 +229,6 @@ export type ZodDecorator_ParamsType = {
|
|
|
263
229
|
* normalize; if a second axis is ever needed the chokepoint widens exactly as that one did.
|
|
264
230
|
*/
|
|
265
231
|
[ZodDecorator.PORTABILITY_PROVENANCE]: string;
|
|
266
|
-
/**
|
|
267
|
-
* The field's personal-data categories — `PersonalDataCategory` values, typed as plain strings at
|
|
268
|
-
* this layer (zod-decorators sits below saas-models and cannot import the enum). Accepts a single
|
|
269
|
-
* value (the common case) or an array; the chokepoint normalizes either to a deduped array.
|
|
270
|
-
*/
|
|
271
|
-
[ZodDecorator.DATA_CATEGORIES]: string | readonly string[];
|
|
272
232
|
// Audit-evidence marker — parameterless, like IS_BUSINESS_KEY. A field either is evidence or is
|
|
273
233
|
// not; there is no axis to parameterize, and adding one would invite per-field redaction policy
|
|
274
234
|
// to grow here instead of on the impersonalization decorator that owns it.
|
|
@@ -361,11 +321,6 @@ export type ZodDecorator_Types = {
|
|
|
361
321
|
* (zod-decorators sits below saas-models). Stored exactly as authored; the chokepoint only
|
|
362
322
|
* rejects blanks. */
|
|
363
323
|
[ZodDecorator.PORTABILITY_PROVENANCE]: string;
|
|
364
|
-
/** Personal-data categories — `PersonalDataCategory` values carried as opaque `string`s
|
|
365
|
-
* (zod-decorators sits below saas-models). ALWAYS the normalized array, deduped and non-empty:
|
|
366
|
-
* the chokepoint widens a bare single-value authoring form on the way in, so every reader sees
|
|
367
|
-
* one shape and `getDataCategories` can answer "is this field categorized?" by presence alone. */
|
|
368
|
-
[ZodDecorator.DATA_CATEGORIES]: readonly string[];
|
|
369
324
|
/** Audit-evidence marker — stored as the bare `true` sentinel (parameterless, like IS_BUSINESS_KEY). */
|
|
370
325
|
[ZodDecorator.IS_AUDIT_EVIDENCE]: true;
|
|
371
326
|
/** RAG-source config — ALWAYS the normalized object ( `{}` when authored with no argument): the
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
*
|
|
15
15
|
* These values are not the persisted resource semantics themselves. They are
|
|
16
16
|
* consumed by the frontend resource UI behavior layer, typically in
|
|
17
|
-
* files like `
|
|
17
|
+
* files like `app/src/modules/<module>/resources/<resource>/<resource>.ui-behavior.tsx`, where the AI
|
|
18
18
|
* calls decorators like `.stringUI()`, `.enumUI()`, `.booleanUI()`, etc. on the
|
|
19
19
|
* schema shape exposed to `resourceUIBehavior(...)`.
|
|
20
20
|
*
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
*
|
|
19
19
|
* They belong to the frontend resource behavior layer, not to shared resource
|
|
20
20
|
* schemas. In application code, they are typically authored in files like:
|
|
21
|
-
* `
|
|
21
|
+
* `app/src/modules/<module>/resources/<resource>/<resource>.ui-behavior.tsx`
|
|
22
22
|
*
|
|
23
23
|
* The shared schema establishes structural meaning (`isSummaryField`,
|
|
24
24
|
* `isForeignKey`, `excludeFromUpdate`, ...). These UI parameter types control
|
|
@@ -37,7 +37,6 @@ export interface CustomFieldMetadata {
|
|
|
37
37
|
[ZodDecorator.IS_WRITE_ONLY_SECRET]?: ZodDecorator_Types[ZodDecorator.IS_WRITE_ONLY_SECRET];
|
|
38
38
|
[ZodDecorator.IMPERSONALIZE_WITH]?: ZodDecorator_Types[ZodDecorator.IMPERSONALIZE_WITH];
|
|
39
39
|
[ZodDecorator.PORTABILITY_PROVENANCE]?: ZodDecorator_Types[ZodDecorator.PORTABILITY_PROVENANCE];
|
|
40
|
-
[ZodDecorator.DATA_CATEGORIES]?: ZodDecorator_Types[ZodDecorator.DATA_CATEGORIES];
|
|
41
40
|
[ZodDecorator.IS_AUDIT_EVIDENCE]?: ZodDecorator_Types[ZodDecorator.IS_AUDIT_EVIDENCE];
|
|
42
41
|
[ZodDecorator.RAG_SOURCE]?: ZodDecorator_Types[ZodDecorator.RAG_SOURCE];
|
|
43
42
|
[ZodDecorator.IS_VIRTUAL]?: ZodDecorator_Types[ZodDecorator.IS_VIRTUAL];
|