@wildo-ai/framework-knowledge 1.1.2 → 1.1.4
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 +351 -18
- package/dist/esm/framework-knowledge.definitions.js.map +1 -1
- package/dist/esm/framework-knowledge.loader.d.ts.map +1 -1
- package/dist/esm/framework-knowledge.schemas.d.ts +1 -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/index.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts +3 -4
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js +4 -4
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +3 -4
- 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 +4 -4
- 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 -1
- 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 -1
- 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 -1
- 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 -1
- 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 +1 -2
- 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 -2
- 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 +2 -3
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +3 -3
- 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 -2
- 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 -2
- 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 +0 -1
- 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 +0 -1
- 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 +0 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js +0 -1
- 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 +0 -1
- 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 +0 -1
- 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 +0 -1
- 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 -1
- 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 +0 -1
- 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 -1
- 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 +0 -2
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js +2 -2
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts +0 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js +0 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.d.ts +0 -1
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.js +0 -1
- package/dist/esm/playbooks/top_down.compliance-evidence-adequacy/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +0 -1
- 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 +0 -1
- 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 +0 -1
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.js +0 -1
- package/dist/esm/playbooks/top_down.compliance-research/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts +0 -2
- 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 -4
- 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 -1
- 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 -1
- 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 +0 -1
- 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 -1
- 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 +0 -1
- 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 -1
- 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 +0 -1
- 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 +0 -1
- 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 -1
- 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 -1
- 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 +0 -1
- 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 +0 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js.map +1 -1
- package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/authority-basis.json +1 -1
- package/dist/knowledge/manifest.json +8 -9
- package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +13 -70
- package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +11 -19
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +5 -88
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +15 -8
- package/dist/knowledge/playbooks/bottom_up.build-scale/method.md +4 -5
- package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +15 -8
- package/dist/knowledge/playbooks/bottom_up.domain-plan/method.md +4 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +8 -7
- package/dist/knowledge/playbooks/bottom_up.foundation/method.md +22 -49
- package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +8 -17
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +15 -780
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +11 -11
- package/dist/knowledge/playbooks/refinement.document-facts/method.md +20 -141
- package/dist/knowledge/playbooks/refinement.document-facts/playbook.json +15 -10
- package/dist/knowledge/playbooks/top_down.brand-identity/method.md +3 -2
- package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +16 -11
- package/dist/knowledge/playbooks/top_down.business-model/playbook.json +14 -6
- package/dist/knowledge/playbooks/top_down.capability-map/method.md +4 -2
- package/dist/knowledge/playbooks/top_down.capability-map/playbook.json +16 -7
- package/dist/knowledge/playbooks/top_down.compliance-posture/method.md +4 -21
- package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +65 -16
- 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 +43 -23
- package/dist/knowledge/playbooks/top_down.phase-gate/method.md +4 -8
- package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +7 -9
- package/dist/knowledge/playbooks/top_down.requirements-definition/method.md +7 -9
- package/dist/knowledge/playbooks/top_down.requirements-definition/playbook.json +15 -7
- package/dist/knowledge/playbooks/top_down.scope-roadmap/method.md +3 -3
- package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +16 -11
- package/dist/knowledge/playbooks/top_down.value-proposition/method.md +4 -2
- package/dist/knowledge/playbooks/top_down.value-proposition/playbook.json +15 -7
- package/dist/knowledge/playbooks/top_down.vision-elicitation/method.md +2 -2
- package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +16 -11
- package/dist/knowledge/references/build-plan.task-graph.config.md +1 -45
- package/dist/knowledge/references/companion.technical-doc.service.md +2 -102
- package/dist/knowledge/references/example.config.app-shell.full.md +5 -0
- package/dist/knowledge/references/example.module.companion-exports.full.md +0 -1
- 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 -51
- package/dist/knowledge/references/presets.models.surface-policy.md +10 -19
- package/dist/knowledge/references/saas.external-data.admin-endpoints.md +48 -0
- package/dist/knowledge/references/saas.frontend.app-level-component.configuration.md +11 -31
- package/dist/knowledge/references/saas.frontend.app-level-component.vocabulary.md +1 -0
- package/dist/knowledge/references/saas.frontend.composite-view.authoring.md +0 -45
- package/dist/knowledge/references/saas.frontend.resource-operation-frontend-config.md +0 -198
- package/dist/knowledge/references/saas.models.data-mode-read-list.md +0 -164
- package/dist/knowledge/references/saas.models.engine-capabilities.md +6 -26
- package/dist/knowledge/references/saas.models.http-api-binding.md +29 -3
- package/dist/knowledge/references/saas.models.provider-capabilities.md +3 -4
- 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 +31 -11
- package/dist/knowledge/references/saas.specifications.assurance-document-blueprint.contract.md +2 -32
- package/dist/knowledge/references/saas.specifications.assurance-program.contract.md +6 -29
- package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +0 -56
- package/dist/knowledge/references/saas.specifications.resource-spec-config.md +0 -22
- 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 -7
- package/dist/knowledge/references/zod.decorators.field-spec-params.md +5 -31
- package/dist/knowledge/references/zod.decorators.per-primitive-ui.md +1 -44
- package/dist/knowledge/references/zod.decorators.primitive-ui.md +0 -3
- package/dist/knowledge/references/zod.decorators.schema-metadata.md +0 -1
- package/dist/knowledge/references/zod.decorators.shared-structural-params.md +0 -15
- package/dist/knowledge/registries/assurance-authority-bases.json +2 -3
- package/dist/knowledge/registries/framework-topics.json +11 -146
- package/dist/knowledge/registries/playbooks.json +18 -154
- package/dist/knowledge/registries/source-tags.json +630 -883
- package/dist/knowledge/skills/INDEX.md +3 -4
- package/dist/knowledge/skills/brand-logo-authoring/SKILL.md +1 -2
- package/dist/knowledge/skills/compliance-document-authoring/SKILL.md +2 -16
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-governance.md +9 -31
- 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 +53 -97
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-assurance-document-blueprint-contract.md +21 -84
- package/dist/knowledge/skills/config-app-shell/SKILL.md +9 -31
- package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-api.md +12 -31
- package/dist/knowledge/skills/config-design-system/SKILL.md +1 -23
- package/dist/knowledge/skills/config-design-system/references/framework-surface-policy-api.md +10 -19
- package/dist/knowledge/skills/config-navigation/SKILL.md +2 -75
- package/dist/knowledge/skills/config-saas/SKILL.md +2 -19
- package/dist/knowledge/skills/config-saas/references/framework-provider-capabilities-api.md +9 -30
- package/dist/knowledge/skills/config-saas/references/framework-wildo-saas-config-api.md +0 -51
- package/dist/knowledge/skills/configure-billing/references/example-backend-provider-module-shape.md +0 -7
- package/dist/knowledge/skills/flows-actors-a2a-exposure/SKILL.md +1 -2
- package/dist/knowledge/skills/flows-actors-a2a-exposure/references/framework-flows-actors-a2a-contract.md +3 -4
- package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +0 -56
- package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +0 -56
- package/dist/knowledge/skills/module-companion-exports/SKILL.md +0 -1
- package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +0 -56
- package/dist/knowledge/skills/resource-add-field/SKILL.md +3 -3
- package/dist/knowledge/skills/resource-add-field/references/framework-field-cross-layer-api.md +0 -213
- 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 -15
- package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-resource-config-api.md +2 -224
- package/dist/knowledge/skills/resource-custom-view/references/custom-view-contracts.md +0 -198
- 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-mcp-tool-exposure/SKILL.md +1 -22
- package/dist/knowledge/skills/resource-rag-source-fields/references/framework-embeddings-capability-api.md +8 -28
- 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-shared-structural-params-api.md +0 -15
- 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 -7
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-frontend-resource-ui-contracts-api.md +0 -198
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-per-primitive-ui-api.md +1 -44
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-primitive-ui-api.md +0 -3
- package/dist/knowledge/skills/spec-companion-exports/SKILL.md +0 -1
- package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +0 -56
- package/dist/knowledge/skills/spec-resource-update/references/framework-field-spec-params-api.md +5 -31
- package/dist/knowledge/skills/spec-resource-update/references/framework-spec-resource-contracts-api.md +0 -22
- package/dist/knowledge/skills/views-composite-authoring/references/framework-composite-view-contracts-api.md +0 -45
- package/dist/knowledge/topic-index.json +220 -725
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +4 -4
- package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/external-framework-mapping.json +0 -1
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/method.md +0 -51
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/playbook.json +0 -43
- package/dist/knowledge/playbooks/bottom_up.placement-plan/method.md +0 -185
- package/dist/knowledge/playbooks/bottom_up.placement-plan/playbook.json +0 -64
- package/dist/knowledge/playbooks/top_down.compliance-analysis/method.md +0 -41
- package/dist/knowledge/playbooks/top_down.compliance-analysis/playbook.json +0 -100
- package/dist/knowledge/playbooks/top_down.compliance-conception/method.md +0 -117
- package/dist/knowledge/playbooks/top_down.compliance-conception/playbook.json +0 -86
- package/dist/knowledge/playbooks/top_down.compliance-evidence-adequacy/method.md +0 -61
- package/dist/knowledge/playbooks/top_down.compliance-evidence-adequacy/playbook.json +0 -41
- package/dist/knowledge/playbooks/top_down.compliance-research/method.md +0 -76
- package/dist/knowledge/playbooks/top_down.compliance-research/playbook.json +0 -42
- 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 -42
- package/dist/knowledge/playbooks/top_down.market-research/method.md +0 -68
- package/dist/knowledge/playbooks/top_down.market-research/playbook.json +0 -44
- 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 -67
- package/dist/knowledge/references/placement-plan.config.md +0 -330
- package/dist/knowledge/references/saas.frontend.display-layout.reading-measure.md +0 -34
- package/dist/knowledge/references/saas.frontend.navigation.operation-override.md +0 -45
- package/dist/knowledge/references/saas.frontend.public-shell.identity-mode.md +0 -65
- 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/saas.models.file-upload-grant.md +0 -179
- package/dist/knowledge/references/saas.models.navigation.surface-vocabulary.md +0 -124
- package/dist/knowledge/references/saas.models.navigation.transition-vocabulary.md +0 -99
- package/dist/knowledge/references/saas.models.navigation.zone-declaration.md +0 -127
- package/dist/knowledge/references/saas.models.resource-config.operation-variant-client-timeout.md +0 -42
- package/dist/knowledge/references/saas.specifications.application-authored-document-fact-specification.contract.md +0 -29
- 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/config-app-shell/references/framework-public-shell-identity-api.md +0 -124
- package/dist/knowledge/skills/config-design-system/references/loading-placeholder-authoring.md +0 -47
- package/dist/knowledge/skills/config-navigation/references/framework-content-width-api.md +0 -98
- package/dist/knowledge/skills/config-navigation/references/framework-navigation-operation-override-api.md +0 -54
- package/dist/knowledge/skills/config-navigation/references/framework-navigation-vocabulary-api.md +0 -232
- package/dist/knowledge/skills/config-navigation/references/framework-navigation-zone-declaration-api.md +0 -149
- package/dist/knowledge/skills/config-navigation/references/how-navigation-resolves.md +0 -114
- package/dist/knowledge/skills/config-navigation/references/navigation-configuration-map.md +0 -133
- package/dist/knowledge/skills/config-saas/references/compliance-declarations.md +0 -111
- package/dist/knowledge/skills/resource-config-wiring/references/framework-personal-data-declaration-api.md +0 -622
- package/dist/knowledge/skills/resource-mcp-tool-exposure/references/framework-file-upload-grant-contract.md +0 -192
- 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,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`
|
package/dist/knowledge/skills/config-app-shell/references/framework-public-shell-identity-api.md
DELETED
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
# Public-page identity — naming the application on sign-in (source)
|
|
2
|
-
|
|
3
|
-
Read this when the application should say **whose** login screen it is: a mark
|
|
4
|
-
and/or the application name on the sign-in card. You are setting one field,
|
|
5
|
-
`publicShellIdentityMode`, and passing it to `buildFrontendModuleConfigOverrides`
|
|
6
|
-
in `frontend/src/modules-registry.frontend.ts`.
|
|
7
|
-
|
|
8
|
-
## It is not an app-shell component key
|
|
9
|
-
|
|
10
|
-
Every other surface in this skill is keyed by `ApplicationLevelComponentType`
|
|
11
|
-
in `frontend/src/config/app-shell.config.ts`. This one is not, and reasoning by
|
|
12
|
-
analogy costs you a silent no-op: adding `publicShellIdentityMode` to
|
|
13
|
-
`appShellConfig` configures **nothing**, with no error.
|
|
14
|
-
|
|
15
|
-
The reason is that the two describe different runtimes. Those keys govern the
|
|
16
|
-
AUTHENTICATED shell — menubar, sidebar, status bar — and none of it exists yet
|
|
17
|
-
on a public page. So the field sits beside `navigationLayout`, `homeDefinition`
|
|
18
|
-
and `errorPageConfig`, which are the other whole-frontend decisions.
|
|
19
|
-
|
|
20
|
-
## It covers every public card, not only login
|
|
21
|
-
|
|
22
|
-
One container renders them all, so the choice is made once and applies to
|
|
23
|
-
sign-in, registration, invitation acceptance, e-mail confirmation, password
|
|
24
|
-
reset, the MFA challenge, magic-link verification, enrollment, and the OAuth
|
|
25
|
-
consent / logged-out / logout-confirm screens.
|
|
26
|
-
|
|
27
|
-
That is deliberate rather than convenient: a brand on the login page and none
|
|
28
|
-
on the MFA challenge reads as two different products mid-authentication, which
|
|
29
|
-
is exactly when a person is deciding whether to trust the page.
|
|
30
|
-
|
|
31
|
-
## The mode is a PERMISSION, never a promise that a logo exists
|
|
32
|
-
|
|
33
|
-
This is the part authors get wrong, because the field name sounds like it
|
|
34
|
-
renders something. What renders is decided from the brand DATA:
|
|
35
|
-
|
|
36
|
-
| What the application has | What the card shows |
|
|
37
|
-
|---|---|
|
|
38
|
-
| A `SYMBOL` mark and a name | the mark, with the name beneath it |
|
|
39
|
-
| A `WORDMARK` or `LOCKUP` mark | the **mark alone** — such a mark already contains the name, and printing the name beneath would show it twice |
|
|
40
|
-
| No generated brand yet | the **name alone** |
|
|
41
|
-
| A mark whose file cannot be loaded | the **name alone** — never a broken image |
|
|
42
|
-
| Neither a mark nor a name | nothing at all |
|
|
43
|
-
|
|
44
|
-
So turning this on is safe before a brand exists, and it does not need to be
|
|
45
|
-
revisited after one is generated — the same setting starts showing the mark on
|
|
46
|
-
its own.
|
|
47
|
-
|
|
48
|
-
## Which identity it shows
|
|
49
|
-
|
|
50
|
-
The application's own: `appIdentity.displayName`, falling back to the technical
|
|
51
|
-
`appName`, plus the `brandAssets` the brand generation produced. Author the mark
|
|
52
|
-
through the brand brief (`brand-logo-authoring`) — there is nothing to configure
|
|
53
|
-
here to point at an asset, and no URL to paste.
|
|
54
|
-
|
|
55
|
-
## Default, and when to turn it on
|
|
56
|
-
|
|
57
|
-
`HIDDEN` is the framework default, and an application that never mentions the
|
|
58
|
-
field behaves exactly as before. Prefer leaving it off until the application has
|
|
59
|
-
a name it is willing to show a stranger: with no brand and no `displayName`, the
|
|
60
|
-
card would print the technical `appName` over the sign-in form.
|
|
61
|
-
|
|
62
|
-
## Import Origins
|
|
63
|
-
|
|
64
|
-
- `@wildo-ai/saas-frontend-lib`
|
|
65
|
-
|
|
66
|
-
## Source Excerpts
|
|
67
|
-
|
|
68
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
69
|
-
|
|
70
|
-
```typescript
|
|
71
|
-
*
|
|
72
|
-
* Whether the PUBLIC (unauthenticated) pages present the application's identity.
|
|
73
|
-
*
|
|
74
|
-
* Declare it beside your other frontend configuration and pass it to
|
|
75
|
-
* `buildFrontendModuleConfigOverrides` in `frontend/src/modules-registry.frontend.ts`, alongside
|
|
76
|
-
* `navigationLayout`, `homeDefinition` and `errorPageConfig`:
|
|
77
|
-
*
|
|
78
|
-
* ```ts
|
|
79
|
-
* import { PublicShellIdentityMode } from '@wildo-ai/saas-frontend-lib';
|
|
80
|
-
*
|
|
81
|
-
* frontendConfigOverrides: buildFrontendModuleConfigOverrides({
|
|
82
|
-
* // …navigationLayout, designSystemConfiguration, homeDefinition, errorPageConfig
|
|
83
|
-
* publicShellIdentityMode: PublicShellIdentityMode.BRAND_HEADER,
|
|
84
|
-
* }),
|
|
85
|
-
* ```
|
|
86
|
-
*
|
|
87
|
-
* It is NOT an `ApplicationLevelComponentType` key: it does not belong in
|
|
88
|
-
* `frontend/src/config/app-shell.config.ts`, and putting it there configures nothing at all. Those
|
|
89
|
-
* keys describe the AUTHENTICATED shell (menubar, sidebar, status bar); the pages this governs
|
|
90
|
-
* render before any of that exists.
|
|
91
|
-
*
|
|
92
|
-
* Login, registration, invitation acceptance, e-mail confirmation, password reset, the MFA
|
|
93
|
-
* challenge and the OAuth consent screens are the first thing a person ever sees of an application,
|
|
94
|
-
* and they are also the pages most likely to be reached from a link — an e-mail, a chat message, a
|
|
95
|
-
* bookmark — with no surrounding context saying what they belong to. Naming the surface there is
|
|
96
|
-
* conventional (Stripe, Linear, GitHub, Slack all do it) and it is the difference between "sign in"
|
|
97
|
-
* and "sign in to WHAT".
|
|
98
|
-
*
|
|
99
|
-
* OPT-IN, and {@link HIDDEN} is the framework default, for the same reason the sidebar's home mode
|
|
100
|
-
* defaults to a navigation row rather than a brand header: showing an identity assumes the surface
|
|
101
|
-
* HAS one worth showing, and an application that has generated no brand yet would get its technical
|
|
102
|
-
* `appName` printed over its login form. An application says when it is ready.
|
|
103
|
-
*
|
|
104
|
-
* Mirrors {@link SidebarHomeDisplayMode} deliberately — same question ("how is this product's
|
|
105
|
-
* identity surfaced here"), same answer shape, so an author who has met one already knows this one.
|
|
106
|
-
*/
|
|
107
|
-
export enum PublicShellIdentityMode {
|
|
108
|
-
/**
|
|
109
|
-
* Public pages carry no identity. The framework default, and the behavior of every application
|
|
110
|
-
* that does not mention this field.
|
|
111
|
-
*/
|
|
112
|
-
HIDDEN = 'hidden',
|
|
113
|
-
/**
|
|
114
|
-
* The identity at the top of the public card, above the form's own heading: the mark when one
|
|
115
|
-
* resolves, and the name.
|
|
116
|
-
*
|
|
117
|
-
* What actually renders is decided from the DATA, not from this mode — an application with no
|
|
118
|
-
* generated brand shows its name alone, and a brand whose mark is a wordmark or lockup shows the
|
|
119
|
-
* mark alone, because such a mark already contains the name. So this mode is a permission, never
|
|
120
|
-
* a promise that a logo exists.
|
|
121
|
-
*/
|
|
122
|
-
BRAND_HEADER = 'brand_header',
|
|
123
|
-
}
|
|
124
|
-
```
|
package/dist/knowledge/skills/config-design-system/references/loading-placeholder-authoring.md
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# Loading placeholders — the two things a theme must not decide freely
|
|
2
|
-
|
|
3
|
-
A skeleton is a GHOST OF CONTENT, not a surface of its own. Two consequences a theme gets wrong by
|
|
4
|
-
reaching for a palette entry, both measured on a live application rather than supposed.
|
|
5
|
-
|
|
6
|
-
## 1. The fill is a neutral TINT, never a semantic colour
|
|
7
|
-
|
|
8
|
-
`bg-accent`, `bg-secondary`, `bg-muted` and their siblings carry meaning — and, more importantly, carry
|
|
9
|
-
the APPLICATION's brand. A workbench whose accent resolves to `oklch(0.606 0.25 292)` flashed saturated
|
|
10
|
-
violet slabs on every list, card and detail page while it loaded.
|
|
11
|
-
|
|
12
|
-
They are also OPAQUE, which makes them correct on exactly the one surface they were picked against. The
|
|
13
|
-
same skeleton renders on the page, inside a raised card, inside a muted panel and inside an overlay.
|
|
14
|
-
|
|
15
|
-
Use `SKELETON_NEUTRAL_TINT` from `@wildo-ai/presets-components-models` — a low-alpha tint of the
|
|
16
|
-
foreground. It composites correctly on every surface and inverts for free in dark mode, because
|
|
17
|
-
`--foreground` already does.
|
|
18
|
-
|
|
19
|
-
```ts
|
|
20
|
-
const skeleton: UIBehaviorRecipe = recipe({
|
|
21
|
-
base: `${SKELETON_NEUTRAL_TINT} animate-pulse ${MY.radius} motion-reduce:animate-none`,
|
|
22
|
-
});
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
A theme still owns radius, border and animation — its idiom. A theme that needs a different strength
|
|
26
|
-
changes the ALPHA (`bg-foreground/5`) rather than reaching for a palette token.
|
|
27
|
-
|
|
28
|
-
## 2. A COLLECTION repeats its silhouette
|
|
29
|
-
|
|
30
|
-
A template describes ONE thing. Drawing one of them on a list tells the reader "one item is coming"
|
|
31
|
-
while twenty are, and it is the most common complaint about skeletons: *I cannot tell what these are.*
|
|
32
|
-
|
|
33
|
-
`Skeleton` takes a `count`. A collection knows its page size, so it says so — and the framework's own
|
|
34
|
-
list layout already does this for every resource. The count is clamped, so a page size of 100 does not
|
|
35
|
-
paint a wall of grey.
|
|
36
|
-
|
|
37
|
-
**Match the silhouette to what the collection actually draws, which is two questions rather than one.**
|
|
38
|
-
A table draws rows; so does a CARDS collection whose `cardLayout.style` is `LIST` — the classic stacked
|
|
39
|
-
list of one-line entries. Only a card GRID draws the tall card shape. Keying on the display mode alone
|
|
40
|
-
gives a page of 128px blocks above a list of one-line rows.
|
|
41
|
-
|
|
42
|
-
## What you do not have to do
|
|
43
|
-
|
|
44
|
-
Nothing, for an ordinary application. Both behaviours are the framework default: the shipped themes
|
|
45
|
-
carry the neutral tint, and `ResourceLayout_List` passes the template and count for every resource
|
|
46
|
-
list. This page matters when you AUTHOR a theme, or when a custom collection surface draws its own
|
|
47
|
-
loading state.
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
# Content width — who decides how wide a surface may be
|
|
2
|
-
|
|
3
|
-
Read this when a surface looks narrower than the space it was given: a detail pane with a column of
|
|
4
|
-
content and dead space beside it, a board or a table that will not use a wide monitor, a document
|
|
5
|
-
squeezed while its container is not.
|
|
6
|
-
|
|
7
|
-
There are **three** caps between a zone and a line of text, they apply in sequence, and each is owned
|
|
8
|
-
by a different party. Almost every "it will not fill the pane" report is one of the three, and fixing
|
|
9
|
-
the wrong one changes nothing visible because a tighter one is still underneath.
|
|
10
|
-
|
|
11
|
-
| # | Cap | Owned by | How to change it |
|
|
12
|
-
|---|---|---|---|
|
|
13
|
-
| 1 | The zone's content boundary — the page-content width (`content`, ~80rem) | the destination in the zone | `zoneContentMaxWidth` on the view or operation |
|
|
14
|
-
| 2 | The pane itself, in an adjacent zone | the navigation layout | `ratio`, `minWidth`, `maxWidth` on the zone, plus the reader's drag |
|
|
15
|
-
| 3 | The reading measure inside a layout root (~42rem) | the display or form TEMPLATE | `responsiveMaxWidth` below |
|
|
16
|
-
|
|
17
|
-
Cap 3 is the one that surprises people, because it is the tightest and the least visible: it sits
|
|
18
|
-
inside the template, so widening the pane does not move it.
|
|
19
|
-
|
|
20
|
-
## Finding which cap is binding — do this FIRST
|
|
21
|
-
|
|
22
|
-
Every element that decides a width announces its tier, so the whole chain is one call in the console:
|
|
23
|
-
|
|
24
|
-
Select the element that looks too narrow in the inspector (so it is `$0`), then:
|
|
25
|
-
|
|
26
|
-
```js
|
|
27
|
-
// every cap ABOVE the selected element, outermost first — the binding one is the narrowest row
|
|
28
|
-
[...document.querySelectorAll('[data-inline-size-tier]')]
|
|
29
|
-
.filter((el) => el.contains($0))
|
|
30
|
-
.map((el) => [el.dataset.inlineSizeTier, Math.round(el.getBoundingClientRect().width), el.dataset.slot ?? el.tagName]);
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Filter by ancestry rather than listing the whole page: a card, a node and a dialog each declare a tier
|
|
34
|
-
too, so a page-wide listing is dominated by leaves that cap nothing above your content.
|
|
35
|
-
|
|
36
|
-
Read it before changing anything. **Fixing a cap that is not the binding one changes nothing visible**,
|
|
37
|
-
because a tighter cap is still underneath — which is how the wrong level got fixed twice in a row on
|
|
38
|
-
the workbench artifact before anyone measured. The binding cap is the narrowest row, not the outermost.
|
|
39
|
-
|
|
40
|
-
## Declaring the reading measure
|
|
41
|
-
|
|
42
|
-
## Import Origins
|
|
43
|
-
|
|
44
|
-
- `@wildo-ai/saas-frontend-lib`
|
|
45
|
-
|
|
46
|
-
## Source Excerpts
|
|
47
|
-
|
|
48
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
49
|
-
|
|
50
|
-
```tsx
|
|
51
|
-
export interface DisplayLayoutProps {
|
|
52
|
-
/** Additional CSS classes for the root container. */
|
|
53
|
-
className?: string;
|
|
54
|
-
/**
|
|
55
|
-
* How wide the layout root lets its content grow, named in the framework's own vocabulary.
|
|
56
|
-
*
|
|
57
|
-
* Defaults to `'measure'` — the reading-measure cap (~42rem, themeable via `--measure-max-width`)
|
|
58
|
-
* that keeps a single-column stack of label/value pairs readable instead of stretched edge to edge.
|
|
59
|
-
* That default is right for what this layout was built for and is unchanged.
|
|
60
|
-
*
|
|
61
|
-
* It is WRONG for a composed document. A template that renders tabs, quote blocks, tables or regions
|
|
62
|
-
* is not a field stack: those set their own measure internally, and a 42rem cap around them squeezes
|
|
63
|
-
* the whole composition into a column with dead space beside it. Such a template declares `'none'`.
|
|
64
|
-
*
|
|
65
|
-
* `'none'` is not "uncapped" in practice — the zone content boundary above has already capped the
|
|
66
|
-
* area at the page-content width (`'content'`, ~80rem) and an adjacent pane is narrower still. This
|
|
67
|
-
* prop decides only whether a SECOND, tighter cap applies inside that, and the answer depends on what
|
|
68
|
-
* the template renders, which is why the template is the one asked.
|
|
69
|
-
*/
|
|
70
|
-
responsiveMaxWidth?: ResponsiveMaxWidth;
|
|
71
|
-
children?: ReactNode;
|
|
72
|
-
}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
`FormLayout` carries the identical prop, with the same default.
|
|
76
|
-
|
|
77
|
-
## Choosing a tier
|
|
78
|
-
|
|
79
|
-
- **Leave the default** for a single column of label/value pairs, settings rows or form inputs. That
|
|
80
|
-
is what the measure exists for: such a stack really is unreadable stretched across a wide zone, and
|
|
81
|
-
the cap is not a bug to route around.
|
|
82
|
-
- **Declare `'none'`** for a composed DOCUMENT — tabs, regions, tables, quote blocks, prose sections.
|
|
83
|
-
Those set their own measure internally, so an outer 42rem cap improves no line of text and only
|
|
84
|
-
leaves a strip the reader cannot reclaim by dragging.
|
|
85
|
-
- `'none'` is never actually uncapped: caps 1 and 2 are still above it. It removes a second, tighter
|
|
86
|
-
cap inside a boundary the framework has already applied.
|
|
87
|
-
|
|
88
|
-
## If the decision is the same for a family of templates
|
|
89
|
-
|
|
90
|
-
Wrap it once. Sixteen templates each spelling `responsiveMaxWidth="none"` is one decision recorded
|
|
91
|
-
sixteen times, and the seventeenth template will be written without it. A small local layout component
|
|
92
|
-
that the family's templates import instead means a new member gets the right measure by construction.
|
|
93
|
-
|
|
94
|
-
## What NOT to do
|
|
95
|
-
|
|
96
|
-
Do not set your own `max-w-*` on a template root. It is a fourth cap, invisible to everything above,
|
|
97
|
-
and it disagrees with the zone the moment a pane is resized. Every width in the chain above has a
|
|
98
|
-
declaration; use the one at the level that owns the question.
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
# Per-operation navigation override — the exception to the layout
|
|
2
|
-
|
|
3
|
-
Read this when ONE operation must not follow the layout's global behaviour: a detail that belongs in a
|
|
4
|
-
sheet while every other detail splits, an overlay that must not block the surface behind it, an
|
|
5
|
-
appearance that differs at one breakpoint.
|
|
6
|
-
|
|
7
|
-
This is the supported way to express an exception. The alternative an author reaches for — holding the
|
|
8
|
-
selection in component state and rendering a panel locally — produces something that looks the same and
|
|
9
|
-
has none of the framework's behaviour: no URL, no back navigation, no zone semantics, no responsive
|
|
10
|
-
collapse.
|
|
11
|
-
|
|
12
|
-
## Import Origins
|
|
13
|
-
|
|
14
|
-
- `@wildo-ai/saas-frontend-lib`
|
|
15
|
-
|
|
16
|
-
## Source Excerpts
|
|
17
|
-
|
|
18
|
-
### Origin Package: `@wildo-ai/saas-frontend-lib`
|
|
19
|
-
|
|
20
|
-
```typescript
|
|
21
|
-
*
|
|
22
|
-
* Per-operation navigation chrome: transition, overlay/split appearance, source zone.
|
|
23
|
-
*
|
|
24
|
-
* **How to use:** attach fragments of this shape under
|
|
25
|
-
* `ResourceOperationFrontendConfig.navigationOverrides` in `resourceUIBehavior()`.
|
|
26
|
-
* Each override applies when navigating **from** the configured zone/viewport into
|
|
27
|
-
* this operation. Prefer mirroring a sibling resource that already matches the
|
|
28
|
-
* product’s overlay vs split behavior.
|
|
29
|
-
*/
|
|
30
|
-
export const NavigationOperationOverrideSchema = z.object({
|
|
31
|
-
transition: TransitionConfigSchema,
|
|
32
|
-
appearance: viewportDiscriminatedSchema(z.union([
|
|
33
|
-
z.enum(OverlayAppearance),
|
|
34
|
-
z.enum(SplitAppearance),
|
|
35
|
-
])).optional(),
|
|
36
|
-
fromZone: z.union([z.enum(NavigationZoneName), z.literal('appLevel')]).optional(),
|
|
37
|
-
viewport: z.enum(ViewportBreakpoint).optional(),
|
|
38
|
-
/**
|
|
39
|
-
* Behaviour of the OVERLAY this override resolves to — whether the page behind stays interactive,
|
|
40
|
-
* whether touching it dismisses, whether it is dimmed. Ignored for non-overlay transitions.
|
|
41
|
-
*
|
|
42
|
-
* These three were already declared on `OverlayContainerConfig` with documented defaults and read by
|
|
43
|
-
* nothing; they are honoured now, and this is the channel that lets a NAVIGATION-driven overlay set
|
|
44
|
-
* them. Declared per operation because it describes the CONTENT: an application legitimately has a
|
|
45
|
-
* create dialog that blocks everything and a detail sheet beside a live canvas that blocks nothing.
|
|
46
|
-
*/
|
|
47
|
-
overlayBehavior: z.object({
|
|
48
|
-
modal: z.boolean().optional(),
|
|
49
|
-
closeOnOutsideClick: z.boolean().optional(),
|
|
50
|
-
showBackdrop: z.boolean().optional(),
|
|
51
|
-
}).optional(),
|
|
52
|
-
});
|
|
53
|
-
export type NavigationOperationOverride = z.infer<typeof NavigationOperationOverrideSchema>;
|
|
54
|
-
```
|