@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
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# saas.frontend.settings-hub.engine-destinations
|
|
2
|
-
|
|
3
|
-
## Import Origins
|
|
4
|
-
|
|
5
|
-
- `@wildo-ai/saas-frontend-lib`
|
|
6
|
-
|
|
7
|
-
## Source Excerpts
|
|
8
|
-
|
|
9
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
/**
|
|
13
|
-
* Every settings destination the engine ships, as a named vocabulary.
|
|
14
|
-
*
|
|
15
|
-
* Exists because these refs are a CLOSED vocabulary that engine code addresses
|
|
16
|
-
* by name — the billing command-menu entry opens `/settings/billing`, and any
|
|
17
|
-
* future engine launcher will do the same. Before this enum, `'billing'` was a
|
|
18
|
-
* bare literal in `billing-launcher.ts` with nothing tying it to the catalog
|
|
19
|
-
* entry it names: rename the destination and the command silently resolves to
|
|
20
|
-
* the hub's DEFAULT section instead of failing, so a menu item labelled
|
|
21
|
-
* "Billing" would open Profile.
|
|
22
|
-
*
|
|
23
|
-
* **Engine code must address a destination through this enum. Application
|
|
24
|
-
* config addresses one by string**, deliberately: a placement is authored data,
|
|
25
|
-
* an application should not import an engine enum to write its own rail, and a
|
|
26
|
-
* typo there is caught at DEV startup by `verifySettingsHubContent`.
|
|
27
|
-
*/
|
|
28
|
-
export enum EngineSettingsDestinationRef {
|
|
29
|
-
/** The signed-in user's own profile record. */
|
|
30
|
-
PROFILE = 'profile',
|
|
31
|
-
/** Password, MFA, sessions — a bespoke engine panel. */
|
|
32
|
-
SECURITY = 'security',
|
|
33
|
-
/** Theme and appearance preferences — a bespoke engine panel. */
|
|
34
|
-
APPEARANCE = 'appearance',
|
|
35
|
-
/** The signed-in user's own preference record. */
|
|
36
|
-
PREFERENCES = 'preferences',
|
|
37
|
-
/** Invitations addressed TO the signed-in user, across organizations they have not joined. */
|
|
38
|
-
MY_INVITATIONS = 'my-invitations',
|
|
39
|
-
/** The current organization's own record. Org owner/admin only. */
|
|
40
|
-
ORGANIZATION_GENERAL = 'organization-general',
|
|
41
|
-
/** Organization membership list, including INVITED rows. Org owner/admin only. */
|
|
42
|
-
MEMBERS = 'members',
|
|
43
|
-
/** Billing home — subscription, plans, usage, invoices. Gated on the `billingEnabled` capability. */
|
|
44
|
-
BILLING = 'billing',
|
|
45
|
-
/** Organization API keys. Org owner/admin only. */
|
|
46
|
-
API_KEYS = 'api-keys',
|
|
47
|
-
/** Single sign-on configuration and connections. */
|
|
48
|
-
SSO = 'sso',
|
|
49
|
-
/** SCIM directory provisioning configuration and tokens. */
|
|
50
|
-
SCIM = 'scim',
|
|
51
|
-
/** Audit-event streaming configuration and failed-delivery queue. */
|
|
52
|
-
SIEM = 'siem',
|
|
53
|
-
/** Outbound webhook endpoints and delivery log. */
|
|
54
|
-
WEBHOOKS = 'webhooks',
|
|
55
|
-
/** The organization's audit log. Org owner/admin only. */
|
|
56
|
-
AUDIT_LOGS = 'audit-logs',
|
|
57
|
-
}
|
|
58
|
-
```
|
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# saas.frontend.settings-hub.placement
|
|
2
|
-
|
|
3
|
-
## Import Origins
|
|
4
|
-
|
|
5
|
-
- `@wildo-ai/saas-frontend-lib`
|
|
6
|
-
|
|
7
|
-
## Source Excerpts
|
|
8
|
-
|
|
9
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
/**
|
|
13
|
-
* An addressable settings DESTINATION — what a settings surface *is*, with no
|
|
14
|
-
* opinion on where it appears.
|
|
15
|
-
*
|
|
16
|
-
* This is the half the engine ships (`ENGINE_SETTINGS_DESTINATIONS`). It carries
|
|
17
|
-
* the target and the gating stack, and deliberately carries **no `categoryRef`,
|
|
18
|
-
* no `order` and no `label`**: those are placement, and placement is the
|
|
19
|
-
* application's decision (`SettingsPlacement`).
|
|
20
|
-
*
|
|
21
|
-
* The split exists because the engine shipping a PLACED hub is what made the
|
|
22
|
-
* settings rail unauthorable — an application could not add, remove, reorder or
|
|
23
|
-
* rename a section without the framework agreeing. Splitting destination from
|
|
24
|
-
* placement lets the engine keep owning what a destination MEANS (its target,
|
|
25
|
-
* its roles, its entitlement) while the application owns where it sits.
|
|
26
|
-
*/
|
|
27
|
-
export interface SettingsDestination {
|
|
28
|
-
/** Destination reference — the `/settings/:sectionRef` URL segment and the id a placement names. */
|
|
29
|
-
ref: string;
|
|
30
|
-
/** What the destination renders in its content panel. */
|
|
31
|
-
target: SettingsSectionTarget;
|
|
32
|
-
/** Declarative runtime capability gating (same contract as launcher items). */
|
|
33
|
-
runtimeAvailability?: LauncherRuntimeAvailabilityConfig;
|
|
34
|
-
/** Feature flags required to surface this destination (plan/subscription gating). */
|
|
35
|
-
requiredFeatures?: RequiredFeaturesConfig;
|
|
36
|
-
/** RBAC roles required to surface this destination (OR semantics). */
|
|
37
|
-
requiredRoles?: string[];
|
|
38
|
-
/** Optional CoreFeature id this destination's content is ENTITLED by (soft gate — renders an upgrade prompt). */
|
|
39
|
-
entitlementFeatureId?: string;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* An application's explicit PLACEMENT of one destination in its settings rail.
|
|
44
|
-
*
|
|
45
|
-
* Authored in the application's own config. Nothing is placed implicitly: a
|
|
46
|
-
* destination the application does not place does not render, which is the whole
|
|
47
|
-
* point — "we should just place things", with no automatic inference.
|
|
48
|
-
*
|
|
49
|
-
* `label` is optional and is an OVERRIDE. The resolved label otherwise comes from
|
|
50
|
-
* the `settings_hub.sections.<ref>.label` key, so a placed section is localizable
|
|
51
|
-
* without the application authoring an English string.
|
|
52
|
-
*
|
|
53
|
-
* That namespace and its resolver (`tSettingsHubSection`) EXIST and already fall
|
|
54
|
-
* back to the authored label. What does not exist is anything that generates the
|
|
55
|
-
* units: `LabellingTypes.SETTINGS_HUB` is declared with an empty pattern and the
|
|
56
|
-
* companion plans nothing for it, so today every rail label is the authored
|
|
57
|
-
* English string. R9 is a wiring job, not a new mechanism.
|
|
58
|
-
*/
|
|
59
|
-
export interface SettingsPlacement {
|
|
60
|
-
/** The {@link SettingsDestination.ref} being placed. Refused at DEV startup when unknown. */
|
|
61
|
-
destinationRef: string;
|
|
62
|
-
/** Which category (rail group) this destination sits under. */
|
|
63
|
-
categoryRef: string;
|
|
64
|
-
/** Sort order within the category (lower = higher). */
|
|
65
|
-
order?: number;
|
|
66
|
-
/** Optional icon ref for the rail entry. */
|
|
67
|
-
icon?: string;
|
|
68
|
-
/** Rail label override. Omit to take `settings_hub.sections.<ref>.label`. */
|
|
69
|
-
label?: string;
|
|
70
|
-
}
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
74
|
-
|
|
75
|
-
```typescript
|
|
76
|
-
/**
|
|
77
|
-
* The AUTHORED Settings Hub registry — an application's own settings rail.
|
|
78
|
-
*
|
|
79
|
-
* The framework ships destinations (`ENGINE_SETTINGS_DESTINATIONS`), never a
|
|
80
|
-
* placed hub. This is the application's half: which categories exist, and which
|
|
81
|
-
* destinations are placed where. `wildo init` scaffolds the full destination list
|
|
82
|
-
* as placements so a new application starts complete and edits down.
|
|
83
|
-
*
|
|
84
|
-
* Resolve it with `resolveSettingsHubConfig()` to get the rendered
|
|
85
|
-
* {@link SettingsSection} list; the render path never reads this shape directly.
|
|
86
|
-
*/
|
|
87
|
-
export interface SettingsHubConfig {
|
|
88
|
-
/** Rail groups, in render order (also orderable via `SettingsCategory.order`). */
|
|
89
|
-
categories: SettingsCategory[];
|
|
90
|
-
/**
|
|
91
|
-
* Every destination this application places, and where.
|
|
92
|
-
*
|
|
93
|
-
* A destination that appears in no placement does not render. That is
|
|
94
|
-
* deliberate: absence is how an application removes a settings section, and it
|
|
95
|
-
* must not be second-guessed by a merge against a framework default.
|
|
96
|
-
*/
|
|
97
|
-
placements: SettingsPlacement[];
|
|
98
|
-
/**
|
|
99
|
-
* Section opened when the hub is launched without an explicit section
|
|
100
|
-
* (`/settings` with no `:sectionRef`). Falls back to the first section of the
|
|
101
|
-
* first category when omitted.
|
|
102
|
-
*/
|
|
103
|
-
defaultSectionRef?: string;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
/**
|
|
107
|
-
* The RESOLVED hub — categories plus fully-resolved sections, ready to render.
|
|
108
|
-
*
|
|
109
|
-
* Distinct from {@link SettingsHubConfig} (what an application AUTHORS) because
|
|
110
|
-
* conflating the two is what let a placed default ship from the engine. A
|
|
111
|
-
* consumer that renders takes this; a consumer that configures takes the other.
|
|
112
|
-
*/
|
|
113
|
-
export interface ResolvedSettingsHubConfig {
|
|
114
|
-
categories: SettingsCategory[];
|
|
115
|
-
sections: SettingsSection[];
|
|
116
|
-
defaultSectionRef?: string;
|
|
117
|
-
}
|
|
118
|
-
```
|
|
@@ -1,197 +0,0 @@
|
|
|
1
|
-
# zod.decorators.data-categories
|
|
2
|
-
|
|
3
|
-
## Import Origins
|
|
4
|
-
|
|
5
|
-
- `@wildo-ai/saas-models`
|
|
6
|
-
- `@wildo-ai/zod-decorators`
|
|
7
|
-
|
|
8
|
-
## Source Excerpts
|
|
9
|
-
|
|
10
|
-
### Origin Package: `@wildo-ai/saas-models`
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
*/
|
|
14
|
-
export enum PersonalDataCategory {
|
|
15
|
-
/** Who the person is: name, username, display name, account identifier, avatar. */
|
|
16
|
-
IDENTITY = 'identity',
|
|
17
|
-
/** How the person is reached: email address, telephone number, postal address. */
|
|
18
|
-
CONTACT_DETAILS = 'contact-details',
|
|
19
|
-
/**
|
|
20
|
-
* What proves the person is who they claim: passwords, MFA secrets, API keys, session tokens.
|
|
21
|
-
*
|
|
22
|
-
* Rarely authored by hand — the fact producer DERIVES this category from `.isPassword()`,
|
|
23
|
-
* `.isOtp()` and `.isWriteOnlySecret()`, which are declarations the application already makes.
|
|
24
|
-
* Declare it explicitly only for a credential those markers do not cover.
|
|
25
|
-
*/
|
|
26
|
-
CREDENTIALS = 'credentials',
|
|
27
|
-
/** Money: payment-method references, invoices, billing details, transaction history. */
|
|
28
|
-
FINANCIAL = 'financial',
|
|
29
|
-
/** What the person did in the product: activity records, timestamps, device and telemetry data. */
|
|
30
|
-
USAGE = 'usage',
|
|
31
|
-
/** Where the person is or was: coordinates, derived region, IP-inferred location. */
|
|
32
|
-
LOCATION = 'location',
|
|
33
|
-
/**
|
|
34
|
-
* What the person wrote or uploaded: free text, notes, attachments.
|
|
35
|
-
*
|
|
36
|
-
* ⚠️ Free text is the category that can silently contain any other one — a "notes" field may hold
|
|
37
|
-
* health information nobody declared. Declaring `USER_CONTENT` states what the field is FOR; it
|
|
38
|
-
* does not certify what it will contain, and no schema can. Where a free-text field is
|
|
39
|
-
* FORESEEABLY used for a special category, declare that member alongside.
|
|
40
|
-
*/
|
|
41
|
-
USER_CONTENT = 'user-content',
|
|
42
|
-
/** The person's working life: employer, job title, professional relationship to the operator. */
|
|
43
|
-
PROFESSIONAL = 'professional',
|
|
44
|
-
|
|
45
|
-
// ── GDPR Art. 9(1), verbatim and closed. Processing needs an Art. 9(2) condition of its own,
|
|
46
|
-
// over and above the Art. 6 lawful basis every other member already needs.
|
|
47
|
-
/** Art. 9(1): racial or ethnic origin. */
|
|
48
|
-
SPECIAL_CATEGORY_RACIAL_OR_ETHNIC_ORIGIN = 'special-category:racial-or-ethnic-origin',
|
|
49
|
-
/** Art. 9(1): political opinions. */
|
|
50
|
-
SPECIAL_CATEGORY_POLITICAL_OPINIONS = 'special-category:political-opinions',
|
|
51
|
-
/** Art. 9(1): religious or philosophical beliefs. */
|
|
52
|
-
SPECIAL_CATEGORY_RELIGIOUS_OR_PHILOSOPHICAL_BELIEFS = 'special-category:religious-or-philosophical-beliefs',
|
|
53
|
-
/** Art. 9(1): trade union membership. */
|
|
54
|
-
SPECIAL_CATEGORY_TRADE_UNION_MEMBERSHIP = 'special-category:trade-union-membership',
|
|
55
|
-
/** Art. 9(1): genetic data. */
|
|
56
|
-
SPECIAL_CATEGORY_GENETIC = 'special-category:genetic',
|
|
57
|
-
/**
|
|
58
|
-
* Art. 9(1): biometric data processed FOR THE PURPOSE OF uniquely identifying a natural person.
|
|
59
|
-
*
|
|
60
|
-
* The purpose qualifier is part of the law's definition, not a footnote: a photograph is ordinary
|
|
61
|
-
* `IDENTITY` data until it is put through facial recognition, at which point it becomes this.
|
|
62
|
-
*/
|
|
63
|
-
SPECIAL_CATEGORY_BIOMETRIC = 'special-category:biometric',
|
|
64
|
-
/** Art. 9(1): data concerning health. */
|
|
65
|
-
SPECIAL_CATEGORY_HEALTH = 'special-category:health',
|
|
66
|
-
/** Art. 9(1): data concerning a natural person's sex life or sexual orientation. */
|
|
67
|
-
SPECIAL_CATEGORY_SEX_LIFE_OR_SEXUAL_ORIENTATION = 'special-category:sex-life-or-sexual-orientation',
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* GDPR Art. 10: criminal convictions and offences.
|
|
71
|
-
*
|
|
72
|
-
* Deliberately NOT a member of {@link SPECIAL_CATEGORY_PERSONAL_DATA_CATEGORIES}. Art. 10 is a
|
|
73
|
-
* separate article with a different condition — processing requires official authority or a
|
|
74
|
-
* Member State law — so folding it into the Art. 9 set would attach the wrong legal test to it.
|
|
75
|
-
*/
|
|
76
|
-
CRIMINAL_OFFENCE = 'criminal-offence',
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* What the ENGINE deliberately does NOT declare, so its silence reads as a decision.
|
|
81
|
-
*
|
|
82
|
-
* Measured 2026-08-30: 48 of the 85 engine resource configurations declare at least one category. The rest are silent on
|
|
83
|
-
* purpose, in four groups:
|
|
84
|
-
*
|
|
85
|
-
* - **System machinery is not personal data, even when the row carries a `userId`.** A queue
|
|
86
|
-
* execution, an entitlement limit, an unread counter, a token-budget counter — each exists so the
|
|
87
|
-
* platform can do its work, and the person's identifier on it is the LINK, not the datum. This
|
|
88
|
-
* group is the one that is easiest to get wrong, because such rows legitimately appear in a
|
|
89
|
-
* subject export: `systemAccessPolicy.exportSubject` means *rows here relate to a subject and
|
|
90
|
-
* belong in their bundle*, which is true by linkage alone. It does not mean the row holds a datum
|
|
91
|
-
* about them, and reading it that way once put `jobExecutions` in this inventory.
|
|
92
|
-
*
|
|
93
|
-
* - **A legal person is not a data subject.** `organizations`, `organizationUnits`,
|
|
94
|
-
* `organizationProfiles`, `organizationPreferences` and their siblings describe a COMPANY. GDPR
|
|
95
|
-
* Recital 14 excludes the processing of data concerning legal persons, so declaring
|
|
96
|
-
* `CONTACT_DETAILS` on an organization's switchboard number would make every notice claim the
|
|
97
|
-
* operator holds an individual's contact details that it does not. A small company's number is
|
|
98
|
-
* often a person's — that is a fact about the customer's data, not about this field's meaning.
|
|
99
|
-
* - **Configuration is not data about anyone.** SSO/SCIM/webhook configuration, API keys and OAuth
|
|
100
|
-
* clients owned by an organization, products, prices, promotions, ETL cursors. An organization's
|
|
101
|
-
* API key is a bearer secret whose subject is the organization; the person who minted it is not
|
|
102
|
-
* recorded on the row.
|
|
103
|
-
* - **A foreign key is LINKAGE, not a category.** `userId` on a usage row is what makes that usage
|
|
104
|
-
* personal; the category of the row's CONTENT is what a notice enumerates. Declaring `IDENTITY`
|
|
105
|
-
* on every owner FK would put "identity data" against resources holding no name, and tell a
|
|
106
|
-
* reader nothing the linkage does not already imply. The machinery group above is this same rule
|
|
107
|
-
* applied one level up, at the row rather than the field.
|
|
108
|
-
*
|
|
109
|
-
* The line between the first group and a real answer is not always obvious, and one pair is worth
|
|
110
|
-
* keeping side by side: a metered USAGE RECORD is declared while a TOKEN-BUDGET counter is not.
|
|
111
|
-
* Both count something a person consumed. The usage record is a per-event history with a timestamp —
|
|
112
|
-
* a record of what they did, which an Art. 15 copy must contain. The budget counter is a single
|
|
113
|
-
* mutable number that exists so a limiter can refuse the next call; nothing about the person
|
|
114
|
-
* survives in it. Ask what the row is FOR, not what it counts.
|
|
115
|
-
*
|
|
116
|
-
* Recorded here because absence is invisible. A future reader finding `organizationProfiles`
|
|
117
|
-
* undeclared should be able to see that it was considered, not assume it was missed — the same
|
|
118
|
-
* discipline a justified `N/A` serves in a verification matrix.
|
|
119
|
-
*/
|
|
120
|
-
|
|
121
|
-
/** Zod form of {@link PersonalDataCategory}. */
|
|
122
|
-
export const PersonalDataCategorySchema: z.ZodEnum<typeof PersonalDataCategory> = z.enum(PersonalDataCategory);
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* The GDPR Art. 9(1) members, as a set — the one place the Art. 9 line is drawn.
|
|
126
|
-
*
|
|
127
|
-
* Derived by PREFIX rather than hand-listed: every Art. 9 member's wire value begins
|
|
128
|
-
* `special-category:`, so a member added to the enum joins this set automatically. A hand-written
|
|
129
|
-
* list would be a second enumeration of a closed vocabulary, and the failure mode is silent — a new
|
|
130
|
-
* Art. 9 member omitted from it reads as ordinary personal data.
|
|
131
|
-
*/
|
|
132
|
-
export const SPECIAL_CATEGORY_PERSONAL_DATA_CATEGORIES: ReadonlySet<PersonalDataCategory> = new Set(
|
|
133
|
-
Object.values(PersonalDataCategory).filter((category) => category.startsWith('special-category:')),
|
|
134
|
-
);
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* Does this category carry the GDPR Art. 9 condition?
|
|
138
|
-
*
|
|
139
|
-
* `false` for {@link PersonalDataCategory.CRIMINAL_OFFENCE} — see that member's note. Callers that
|
|
140
|
-
* need "needs a condition beyond Art. 6" must test both.
|
|
141
|
-
*/
|
|
142
|
-
export function isSpecialCategoryPersonalData(category: PersonalDataCategory): boolean {
|
|
143
|
-
return SPECIAL_CATEGORY_PERSONAL_DATA_CATEGORIES.has(category);
|
|
144
|
-
}
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
### Origin Package: `@wildo-ai/zod-decorators`
|
|
148
|
-
|
|
149
|
-
```typescript
|
|
150
|
-
*/
|
|
151
|
-
export function getDataCategories(schema: z.ZodTypeAny): readonly string[] | undefined {
|
|
152
|
-
const metadata = getMetadataRecursive(schema);
|
|
153
|
-
const value = metadata?.[ZodDecorator.DATA_CATEGORIES];
|
|
154
|
-
return Array.isArray(value) && value.length > 0 ? (value as readonly string[]) : undefined;
|
|
155
|
-
}
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Origin Package: `@wildo-ai/zod-decorators`
|
|
159
|
-
|
|
160
|
-
```typescript
|
|
161
|
-
*
|
|
162
|
-
* Declare WHICH KINDS of personal data this field holds — the vocabulary a privacy notice
|
|
163
|
-
* enumerates. Import `PersonalDataCategory` from `@wildo-ai/saas-models`.
|
|
164
|
-
*
|
|
165
|
-
* Accepts a single category (the common case) or an array when a field genuinely spans two. At
|
|
166
|
-
* least one is required: a field that holds NO personal data carries no declaration at all, and
|
|
167
|
-
* that absence is exactly what the compliance gap report reads.
|
|
168
|
-
*
|
|
169
|
-
* Declare it on the field that holds the value. Never on a field merely because its NAME suggests
|
|
170
|
-
* a category — `credentials` is the one category the framework derives for you, and it derives it
|
|
171
|
-
* from `.isPassword()` / `.isOtp()` / `.isWriteOnlySecret()`, never from an identifier.
|
|
172
|
-
*
|
|
173
|
-
* @example
|
|
174
|
-
* fullName: z.string().dataCategories(PersonalDataCategory.IDENTITY)
|
|
175
|
-
* @example
|
|
176
|
-
* email: z.email().nullish().dataCategories(PersonalDataCategory.CONTACT_DETAILS)
|
|
177
|
-
* @example
|
|
178
|
-
* // A field that genuinely spans two — an array never forces you to pick a lie.
|
|
179
|
-
* dietaryNotes: z.string().dataCategories([PersonalDataCategory.USER_CONTENT, PersonalDataCategory.SPECIAL_CATEGORY_HEALTH])
|
|
180
|
-
*/
|
|
181
|
-
[ZodDecorator.DATA_CATEGORIES](categories: string | readonly string[]): DecoratedPrimitiveZodType<T>;
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Origin Package: `@wildo-ai/zod-decorators`
|
|
185
|
-
|
|
186
|
-
```typescript
|
|
187
|
-
*/
|
|
188
|
-
export function addDataCategories<T extends z.ZodTypeAny>(
|
|
189
|
-
schema: T,
|
|
190
|
-
categories: string | readonly string[],
|
|
191
|
-
): T {
|
|
192
|
-
ensureZodDecoratorsLoaded(z);
|
|
193
|
-
return addDecorators(schema, [
|
|
194
|
-
{ ref: ZodDecorator.DATA_CATEGORIES, params: categories },
|
|
195
|
-
]);
|
|
196
|
-
}
|
|
197
|
-
```
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: "Always-on guidance when editing resource schema files (*.schemas.ts). Provides structural policy, decorator awareness, and downstream impact awareness for schema changes."
|
|
3
|
-
globs: "shared-lib/src/modules/**/resources/**/*.schemas.ts"
|
|
4
|
-
alwaysApply: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Resource Schema — Structural Policy
|
|
8
|
-
|
|
9
|
-
This file is a **resource schema** defining the persisted shape of a resource
|
|
10
|
-
using Zod with decorator methods from `@wildo-ai/zod-decorators`.
|
|
11
|
-
|
|
12
|
-
## Required Structure
|
|
13
|
-
|
|
14
|
-
Every resource schema file MUST:
|
|
15
|
-
|
|
16
|
-
1. **Initialize decorators** before schema definitions:
|
|
17
|
-
```typescript
|
|
18
|
-
import { z } from 'zod';
|
|
19
|
-
import { initZodDecorators } from '@wildo-ai/zod-decorators';
|
|
20
|
-
initZodDecorators(z);
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
2. **Define enums as TypeScript enums** (not string arrays):
|
|
24
|
-
```typescript
|
|
25
|
-
// CORRECT
|
|
26
|
-
export enum MyStatus { ACTIVE = 'active', ARCHIVED = 'archived' }
|
|
27
|
-
status: z.enum(MyStatus)
|
|
28
|
-
|
|
29
|
-
// WRONG — loses type safety and autocomplete
|
|
30
|
-
status: z.enum(['active', 'archived'])
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
3. **Export the main schema** and inferred TypeScript type:
|
|
34
|
-
```typescript
|
|
35
|
-
export const MyResource_Schema = z.object({ ... });
|
|
36
|
-
export type MyResource = z.infer<typeof MyResource_Schema>;
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Mandatory Decorators
|
|
40
|
-
|
|
41
|
-
These decorators are NOT optional — missing them causes silent runtime issues:
|
|
42
|
-
|
|
43
|
-
| Field | Required Decorator | Consequence if Missing |
|
|
44
|
-
|-------|-------------------|----------------------|
|
|
45
|
-
| `_id` | `.isPrimaryKey().isSummaryField()` | Resource won't be identifiable in the system |
|
|
46
|
-
| `organizationId` | `.isDBIndexed().isForeignKey().excludeFromUpdate()` | Missing index + mutable org ownership |
|
|
47
|
-
| `createdByUserId` | `.isDBIndexed().isForeignKey().excludeFromUpdate()` | Missing audit trail |
|
|
48
|
-
| `createdAt` | `.excludeFromCreate().excludeFromUpdate()` | Clients can forge timestamps |
|
|
49
|
-
| `updatedAt` | `.excludeFromCreate().excludeFromUpdate()` | Clients can forge timestamps |
|
|
50
|
-
|
|
51
|
-
## Security-Critical Rules
|
|
52
|
-
|
|
53
|
-
- **Sensitive data** → use `.isBackendOnly()`, NEVER `.isHidden()`. `isHidden` still sends data to the frontend.
|
|
54
|
-
- **Server-set fields** → use `.excludeFromCreate()` and/or `.excludeFromUpdate()`. Without these, clients can set arbitrary values.
|
|
55
|
-
- **Foreign keys** → always add `.isForeignKey()`. Without it, the framework cannot generate relationship-aware queries.
|
|
56
|
-
|
|
57
|
-
## Downstream Impact
|
|
58
|
-
|
|
59
|
-
After modifying a `*.schemas.ts` file, these things MUST be verified or updated:
|
|
60
|
-
|
|
61
|
-
1. **Specifications** — Schema changes require spec regeneration. The companion
|
|
62
|
-
reads schema decorators to generate field specs. Run spec update.
|
|
63
|
-
2. **i18n labels** — New fields or enum values need translated labels.
|
|
64
|
-
Missing labels render as raw keys in the UI.
|
|
65
|
-
3. **Resource config** — Adding a discriminator field or changing FK structure
|
|
66
|
-
may require config changes.
|
|
67
|
-
4. **Frontend layout** — New `isSummaryField` fields appear automatically in
|
|
68
|
-
list views, but detail view sections may need layout adjustment.
|
|
69
|
-
|
|
70
|
-
## Anti-Patterns to Flag
|
|
71
|
-
|
|
72
|
-
- `z.nativeEnum()` — the framework uses `z.enum()` with const enum values
|
|
73
|
-
- `z.enum([...])` with inline string array — always define a named enum
|
|
74
|
-
- Missing `.default()` on enum fields — forces users to pick on every create
|
|
75
|
-
- `.optional()` on `_id` or `organizationId` — these are always required
|
|
76
|
-
- Separate create/update/read schema files — use decorators on the single schema
|
|
77
|
-
- Inline `import('...')` types — use top-level `import type`
|