@wildo-ai/framework-knowledge 1.1.8 → 1.1.10
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/claude-marketplace/.claude-plugin/marketplace.json +1 -1
- package/dist/claude-marketplace/plugins/wildo/.claude-plugin/plugin.json +1 -1
- package/dist/claude-marketplace/plugins/wildo/references/acceptance.md +11 -0
- package/dist/claude-marketplace/plugins/wildo/references/composites-and-the-loop.md +9 -2
- package/dist/claude-marketplace/plugins/wildo/references/creation-state.md +21 -0
- package/dist/claude-marketplace/plugins/wildo/references/derived-artifacts.md +121 -0
- package/dist/claude-marketplace/plugins/wildo/references/expert-personas-and-deliberations.md +26 -7
- package/dist/claude-marketplace/plugins/wildo/references/runs-judges-and-questions.md +31 -5
- package/dist/claude-marketplace/plugins/wildo/skills/accept/SKILL.md +4 -2
- package/dist/claude-marketplace/plugins/wildo/skills/answer/SKILL.md +29 -2
- package/dist/claude-marketplace/plugins/wildo/skills/build/SKILL.md +69 -24
- package/dist/claude-marketplace/plugins/wildo/skills/doctor/SKILL.md +10 -0
- package/dist/claude-marketplace/plugins/wildo/skills/run/SKILL.md +21 -5
- package/dist/claude-marketplace/plugins/wildo/skills/start/SKILL.md +31 -5
- package/dist/claude-marketplace/plugins/wildo/skills/status/SKILL.md +2 -0
- package/dist/claude-marketplace/plugins/wildo/skills/why/SKILL.md +20 -4
- 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 +95 -5
- package/dist/esm/framework-knowledge.definitions.js.map +1 -1
- package/dist/esm/framework-knowledge.loader.d.ts.map +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts +2 -2
- 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 +2 -2
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.d.ts +11 -11
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.js +29 -22
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +41 -3
- 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 +175 -14
- 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 +1 -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 +3 -3
- 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 +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.d.ts +8 -4
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.js +13 -6
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts +4 -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 +90 -13
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.experience-plan/playbook.definition.d.ts +4 -3
- package/dist/esm/playbooks/bottom_up.experience-plan/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.experience-plan/playbook.definition.js +4 -3
- package/dist/esm/playbooks/bottom_up.experience-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts +8 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +12 -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 +12 -3
- 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 +8 -4
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.website-plan/playbook.definition.d.ts +4 -1
- package/dist/esm/playbooks/bottom_up.website-plan/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.website-plan/playbook.definition.js +2 -1
- package/dist/esm/playbooks/bottom_up.website-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/cross_cutting.application-creation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/cross_cutting.compliance/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/cross_cutting.feature-development/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/cross_cutting.refinement/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts +1 -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 +13 -1
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/refinement.feature-contribution/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/refinement.governance-document-candidate/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts +25 -27
- 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 +91 -43
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.d.ts +41 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.js +43 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.d.ts +200 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.js +203 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.d.ts +81 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.js +93 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts +3 -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 +27 -18
- 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.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts +11 -1
- 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 +11 -11
- 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 +2 -0
- 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 +3 -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.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +2 -0
- 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 +3 -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.map +1 -1
- package/dist/esm/playbooks/top_down.definition/playbook.definition.d.ts +5 -2
- package/dist/esm/playbooks/top_down.definition/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.definition/playbook.definition.js +16 -4
- package/dist/esm/playbooks/top_down.definition/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.expert-personas/playbook.definition.d.ts +27 -6
- package/dist/esm/playbooks/top_down.expert-personas/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.expert-personas/playbook.definition.js +32 -12
- package/dist/esm/playbooks/top_down.expert-personas/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.feature-drafts/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts +2 -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 +13 -5
- 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 +7 -3
- 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 +71 -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 -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 +23 -8
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.d.ts +7 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.js +4 -2
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts +9 -3
- 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 +3 -3
- 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.map +1 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts +35 -2
- 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 +41 -17
- 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/assurance-authority-bases/wildo-safe-baseline-v1/external-framework-mapping.json +1 -1
- package/dist/knowledge/manifest.json +8 -8
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/method.md +22 -7
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/playbook.json +3 -3
- package/dist/knowledge/playbooks/bottom_up.build/method.md +17 -15
- package/dist/knowledge/playbooks/bottom_up.build/playbook.json +4 -3
- package/dist/knowledge/playbooks/bottom_up.build-decompose/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.build-decompose/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +261 -34
- package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +42 -4
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +188 -59
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +2 -2
- package/dist/knowledge/playbooks/bottom_up.build-scale/method.md +169 -276
- package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +2 -2
- package/dist/knowledge/playbooks/bottom_up.capability-composition/method.md +8 -1
- package/dist/knowledge/playbooks/bottom_up.capability-composition/playbook.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.conception/method.md +3 -2
- package/dist/knowledge/playbooks/bottom_up.conception/playbook.json +11 -3
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.domain-plan/method.md +129 -17
- package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +7 -4
- package/dist/knowledge/playbooks/bottom_up.experience-plan/method.md +28 -6
- package/dist/knowledge/playbooks/bottom_up.experience-plan/playbook.json +5 -4
- package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +13 -5
- package/dist/knowledge/playbooks/bottom_up.placement-plan/method.md +50 -0
- package/dist/knowledge/playbooks/bottom_up.placement-plan/playbook.json +16 -4
- package/dist/knowledge/playbooks/bottom_up.website-plan/method.md +19 -0
- package/dist/knowledge/playbooks/bottom_up.website-plan/playbook.json +5 -2
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +7 -3
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +1 -1
- package/dist/knowledge/playbooks/refinement.document-facts/method.md +8 -0
- package/dist/knowledge/playbooks/refinement.document-facts/playbook.json +3 -2
- package/dist/knowledge/playbooks/refinement.feature-contribution/method.md +5 -2
- package/dist/knowledge/playbooks/refinement.feature-contribution/playbook.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/method.md +75 -37
- package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +35 -38
- package/dist/knowledge/playbooks/top_down.brand-name-research/method.md +145 -0
- package/dist/knowledge/playbooks/top_down.brand-name-research/playbook.json +57 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/method.md +99 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/playbook.json +65 -0
- package/dist/knowledge/playbooks/top_down.brand-naming/method.md +56 -0
- package/dist/knowledge/playbooks/top_down.brand-naming/playbook.json +76 -0
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.business-model/method.md +60 -6
- package/dist/knowledge/playbooks/top_down.business-model/playbook.json +15 -10
- package/dist/knowledge/playbooks/top_down.capability-map/method.md +10 -9
- package/dist/knowledge/playbooks/top_down.capability-map/playbook.json +1 -1
- package/dist/knowledge/playbooks/top_down.compliance-analysis/playbook.json +30 -10
- package/dist/knowledge/playbooks/top_down.compliance-conception/playbook.json +3 -1
- package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +4 -1
- package/dist/knowledge/playbooks/top_down.definition/method.md +8 -3
- package/dist/knowledge/playbooks/top_down.definition/playbook.json +6 -4
- package/dist/knowledge/playbooks/top_down.expert-personas/playbook.json +16 -2
- package/dist/knowledge/playbooks/top_down.feature-drafts/method.md +5 -2
- package/dist/knowledge/playbooks/top_down.feature-drafts/playbook.json +1 -1
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/method.md +26 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/playbook.json +4 -2
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +11 -1
- package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.requirements-definition/method.md +84 -9
- package/dist/knowledge/playbooks/top_down.requirements-definition/playbook.json +6 -3
- package/dist/knowledge/playbooks/top_down.risk-register/method.md +21 -0
- package/dist/knowledge/playbooks/top_down.risk-register/playbook.json +8 -2
- package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +4 -2
- package/dist/knowledge/playbooks/top_down.vision-elicitation/method.md +29 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +58 -17
- package/dist/knowledge/references/brand.name-choice.config.md +144 -0
- package/dist/knowledge/references/brand.name-screening.config.md +308 -0
- package/dist/knowledge/references/build-plan.task-graph.config.md +119 -11
- package/dist/knowledge/references/business-model.pricing-plan.config.md +16 -0
- package/dist/knowledge/references/business-model.snapshot.config.md +64 -0
- package/dist/knowledge/references/business-model.snapshot.validation.md +68 -4
- package/dist/knowledge/references/capability-composition.config.md +67 -4
- package/dist/knowledge/references/companion.market.prompt-renderer.md +11 -6
- package/dist/knowledge/references/example.authorization.application-roles.office-and-field.md +44 -0
- package/dist/knowledge/references/example.backend.custom-operation.audit-event.md +81 -0
- package/dist/knowledge/references/example.backend.custom-operation.child-line-total.md +258 -0
- package/dist/knowledge/references/example.backend.custom-operation.computed-total.md +153 -0
- package/dist/knowledge/references/example.backend.custom-operation.create-related-resource.md +107 -0
- package/dist/knowledge/references/example.data-seeding.minimal.md +39 -10
- package/dist/knowledge/references/example.data-seeding.row-reference.md +80 -0
- package/dist/knowledge/references/example.email.template.minimal.md +1 -1
- package/dist/knowledge/references/example.resource.config-wiring.retention-policy-operations.md +74 -0
- package/dist/knowledge/references/example.resource.personal-data.free-text-field.md +19 -0
- package/dist/knowledge/references/example.resource.personal-data.person-without-account.md +27 -0
- package/dist/knowledge/references/example.resource.status-lifecycle.quote.md +152 -0
- package/dist/knowledge/references/example.resource.ui-behavior.filter-presets.md +15 -0
- package/dist/knowledge/references/example.resource.ui-behavior.operation-icon.md +8 -0
- package/dist/knowledge/references/example.views.app-level.home-definition.md +13 -0
- package/dist/knowledge/references/example.views.chart-definition.shared.md +83 -0
- package/dist/knowledge/references/experience-plan.config.md +60 -7
- package/dist/knowledge/references/market.context-block.builder.md +1 -1
- package/dist/knowledge/references/market.snapshot.validation.md +1 -1
- package/dist/knowledge/references/placement-plan.config.md +43 -0
- package/dist/knowledge/references/requirements.functional-requirement.config.md +8 -2
- package/dist/knowledge/references/requirements.non-functional-requirement.config.md +2 -0
- package/dist/knowledge/references/requirements.references.conventions.md +1 -1
- package/dist/knowledge/references/requirements.snapshot.config.md +57 -1
- package/dist/knowledge/references/requirements.snapshot.validation.md +35 -1
- package/dist/knowledge/references/saas.backend.audit-logs.log-event.md +63 -0
- package/dist/knowledge/references/saas.backend.document-sequence.issue-in-operation.md +60 -0
- package/dist/knowledge/references/saas.backend.document-sequence.raise-floor.md +156 -0
- package/dist/knowledge/references/saas.backend.email.send.md +77 -0
- package/dist/knowledge/references/saas.backend.notifications.operation-email-template-ref.md +60 -0
- package/dist/knowledge/references/saas.data-seeding.bootstrap-wiring.md +7 -1
- package/dist/knowledge/references/saas.data-seeding.computed-entry.md +43 -0
- package/dist/knowledge/references/saas.data-seeding.definition-input.md +14 -2
- package/dist/knowledge/references/saas.data-seeding.row-reference.md +93 -0
- package/dist/knowledge/references/saas.frontend.collection-filter-presets.md +124 -0
- package/dist/knowledge/references/saas.frontend.launcher.item-refs.md +316 -0
- package/dist/knowledge/references/saas.frontend.launcher.merge-rules.md +106 -0
- package/dist/knowledge/references/saas.frontend.launcher.runtime-availability.md +60 -0
- package/dist/knowledge/references/saas.frontend.resource-label-params.md +52 -0
- package/dist/knowledge/references/saas.frontend.resource-operation-frontend-config.md +47 -18
- package/dist/knowledge/references/saas.frontend.resource-ui-behavior-config.md +4 -1
- package/dist/knowledge/references/saas.frontend.settings-hub.engine-destination-roles.md +25 -0
- package/dist/knowledge/references/saas.frontend.settings-hub.placement.md +2 -2
- package/dist/knowledge/references/saas.models.audit.trail-config.md +45 -0
- package/dist/knowledge/references/saas.models.notifications.user-notification-definition.md +5 -3
- package/dist/knowledge/references/saas.models.queue.scheduled-recovery.md +81 -2
- package/dist/knowledge/references/saas.models.resource-config.builder-parameters.md +26 -0
- package/dist/knowledge/references/saas.models.roles.definition.md +61 -0
- package/dist/knowledge/references/saas.models.roles.organization-defaults.md +97 -0
- package/dist/knowledge/references/saas.public-runtime.contract.md +26 -0
- package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +10 -0
- package/dist/knowledge/references/saas.website.astro.bridge.md +10 -0
- package/dist/knowledge/references/saas.website.astro.label-loader.md +12 -0
- package/dist/knowledge/references/saas.website.astro.llms-txt-server.md +14 -1
- package/dist/knowledge/references/saas.website.astro.site-context.md +13 -0
- package/dist/knowledge/references/saas.website.blog.bridge.md +4 -0
- package/dist/knowledge/references/saas.website.config.site-context-loader.md +3 -0
- package/dist/knowledge/references/saas.website.factories.define-section.md +4 -0
- package/dist/knowledge/references/saas.website.legal.public-document-links.md +76 -0
- package/dist/knowledge/references/saas.website.page-manifest.schema.md +12 -3
- package/dist/knowledge/references/saas.website.page-sections.component.md +72 -0
- package/dist/knowledge/references/saas.website.root-config.seo.md +2 -1
- package/dist/knowledge/references/saas.website.runtime.context.md +7 -0
- package/dist/knowledge/references/saas.website.sections.definition-schema.md +11 -0
- package/dist/knowledge/references/saas.website.seo.llms-txt-config.md +2 -0
- package/dist/knowledge/references/website-plan.config.md +26 -0
- package/dist/knowledge/references/zod.decorators.chainable-runtime.md +13 -0
- package/dist/knowledge/references/zod.decorators.decorator-vocabulary.md +7 -0
- package/dist/knowledge/references/zod.decorators.document-sequence.md +65 -0
- package/dist/knowledge/references/zod.decorators.schema-metadata.md +1 -0
- package/dist/knowledge/references/zod.decorators.shared-structural-methods.md +21 -0
- package/dist/knowledge/references/zod.factories.bigdecimal.md +1 -0
- package/dist/knowledge/references/zod.factories.code.md +1 -0
- package/dist/knowledge/references/zod.factories.duration.md +1 -0
- package/dist/knowledge/references/zod.factories.money.md +1 -0
- package/dist/knowledge/registries/assurance-authority-bases.json +1 -1
- package/dist/knowledge/registries/framework-topics.json +374 -1
- package/dist/knowledge/registries/playbooks.json +76 -28
- package/dist/knowledge/registries/source-tags.json +1513 -898
- package/dist/knowledge/rules/live-context-door.md +5 -2
- package/dist/knowledge/skills/INDEX.md +5 -2
- package/dist/knowledge/skills/application-consumer-documentation-authoring/SKILL.md +16 -3
- package/dist/knowledge/skills/application-database-migrations/SKILL.md +14 -3
- package/dist/knowledge/skills/application-roles-authoring/SKILL.md +158 -0
- package/dist/knowledge/skills/application-roles-authoring/references/framework-application-roles-api.md +169 -0
- package/dist/knowledge/skills/application-roles-authoring/references/office-and-field-worked-example.md +63 -0
- package/dist/knowledge/skills/authorization-unit-narrowing/SKILL.md +6 -1
- package/dist/knowledge/skills/backend-custom-operation/SKILL.md +256 -9
- package/dist/knowledge/skills/backend-custom-operation/references/after-the-operation.md +42 -0
- package/dist/knowledge/skills/backend-custom-operation/references/framework-audit-log-event-api.md +220 -0
- package/dist/knowledge/skills/brand-logo-authoring/SKILL.md +5 -0
- package/dist/knowledge/skills/brand-name-screening/SKILL.md +178 -0
- package/dist/knowledge/skills/brand-name-screening/references/framework-brand-name-screening-api.md +466 -0
- package/dist/knowledge/skills/brand-name-screening/references/screening-procedure.md +87 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-privacy-notice.md +7 -3
- package/dist/knowledge/skills/config-app-shell/SKILL.md +58 -5
- package/dist/knowledge/skills/config-app-shell/references/framework-launcher-items-api.md +461 -0
- package/dist/knowledge/skills/config-app-shell/references/framework-launcher-visibility-api.md +80 -0
- package/dist/knowledge/skills/config-design-system/SKILL.md +28 -6
- package/dist/knowledge/skills/config-navigation/SKILL.md +14 -3
- package/dist/knowledge/skills/config-saas/SKILL.md +56 -15
- package/dist/knowledge/skills/config-saas/references/compliance-declarations.md +65 -2
- package/dist/knowledge/skills/config-saas/references/framework-audit-trail-config-api.md +62 -2
- package/dist/knowledge/skills/config-saas/references/framework-background-work-api.md +81 -2
- package/dist/knowledge/skills/config-saas-backend/SKILL.md +6 -1
- package/dist/knowledge/skills/configure-billing/SKILL.md +18 -4
- package/dist/knowledge/skills/email-add-template/SKILL.md +28 -6
- package/dist/knowledge/skills/email-add-template/references/email-artifact-paths.md +1 -1
- package/dist/knowledge/skills/email-add-template/references/framework-email-send-api.md +128 -0
- package/dist/knowledge/skills/email-add-template/references/framework-operation-email-template-ref-api.md +99 -0
- package/dist/knowledge/skills/engine-component-registration/SKILL.md +6 -1
- package/dist/knowledge/skills/engine-product-definitions/SKILL.md +21 -8
- package/dist/knowledge/skills/flows-actors-chat-assistant/SKILL.md +10 -2
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/SKILL.md +18 -4
- package/dist/knowledge/skills/frontend-component-catalog/SKILL.md +11 -3
- package/dist/knowledge/skills/frontend-component-catalog/references/framework-component-catalog.md +2 -1
- package/dist/knowledge/skills/frontend-component-catalog/references/framework-component-usage.md +8 -0
- package/dist/knowledge/skills/i18n-rerun-pipeline/SKILL.md +19 -5
- package/dist/knowledge/skills/i18n-translation-rerun/SKILL.md +10 -2
- package/dist/knowledge/skills/inbound-channels/SKILL.md +2 -2
- package/dist/knowledge/skills/infra-environment-config/SKILL.md +6 -1
- package/dist/knowledge/skills/local-environment-bootstrap/SKILL.md +17 -2
- package/dist/knowledge/skills/local-environment-bootstrap/references/derived-artifact-currency.md +122 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/framework-upgrade-and-dependency-alignment.md +11 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/wildo-cli-bootstrap-commands.md +9 -2
- package/dist/knowledge/skills/market-add-feature-benefit/SKILL.md +10 -2
- package/dist/knowledge/skills/market-alternatives/SKILL.md +10 -2
- package/dist/knowledge/skills/market-authoring-overview/SKILL.md +10 -2
- package/dist/knowledge/skills/market-category/SKILL.md +21 -7
- package/dist/knowledge/skills/market-channels/SKILL.md +6 -1
- package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +22 -4
- package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +12 -2
- package/dist/knowledge/skills/market-generation-cli/SKILL.md +21 -11
- package/dist/knowledge/skills/market-generation-cli/references/framework-market-generation-cli.md +11 -6
- package/dist/knowledge/skills/market-icp/SKILL.md +10 -2
- package/dist/knowledge/skills/market-jobs-pains-gains/SKILL.md +6 -1
- package/dist/knowledge/skills/market-message-templates-authoring/SKILL.md +6 -1
- package/dist/knowledge/skills/market-message-templates-authoring/references/framework-message-template-api.md +1 -1
- package/dist/knowledge/skills/market-persona/SKILL.md +14 -3
- package/dist/knowledge/skills/market-positioning-authoring/SKILL.md +6 -1
- package/dist/knowledge/skills/market-proof-and-objection/SKILL.md +10 -2
- package/dist/knowledge/skills/market-scoring-interpretation/SKILL.md +6 -1
- package/dist/knowledge/skills/market-snapshot-validation/SKILL.md +15 -4
- package/dist/knowledge/skills/market-snapshot-validation/references/framework-snapshot-validation-api.md +1 -1
- package/dist/knowledge/skills/market-tone-of-voice/SKILL.md +6 -1
- package/dist/knowledge/skills/model-cost-attribution/references/framework-work-unit-api.md +26 -0
- package/dist/knowledge/skills/module-companion-exports/SKILL.md +7 -1
- package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +10 -0
- package/dist/knowledge/skills/module-relationships/SKILL.md +37 -8
- package/dist/knowledge/skills/pdf-template-authoring/SKILL.md +4 -2
- package/dist/knowledge/skills/provider-address-lookup/SKILL.md +14 -3
- package/dist/knowledge/skills/provider-frontend-file-picker/SKILL.md +6 -1
- package/dist/knowledge/skills/provider-operation-calls/SKILL.md +14 -3
- package/dist/knowledge/skills/rate-limit-authoring/SKILL.md +10 -2
- package/dist/knowledge/skills/resource-add-field/SKILL.md +10 -2
- package/dist/knowledge/skills/resource-add-field/references/framework-field-cross-layer-api.md +46 -17
- package/dist/knowledge/skills/resource-add-resource/SKILL.md +14 -2
- package/dist/knowledge/skills/resource-add-resource/references/framework-new-resource-core-config-api.md +26 -0
- package/dist/knowledge/skills/resource-config-wiring/SKILL.md +29 -3
- package/dist/knowledge/skills/resource-config-wiring/references/framework-collection-operation-declarations.md +19 -4
- package/dist/knowledge/skills/resource-config-wiring/references/framework-operation-audit-api.md +5 -2
- package/dist/knowledge/skills/resource-config-wiring/references/framework-personal-data-declaration-api.md +103 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-retention-policy-operations.md +135 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-resource-config-api.md +26 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-user-notifications-api.md +26 -7
- package/dist/knowledge/skills/resource-custom-view/SKILL.md +10 -2
- package/dist/knowledge/skills/resource-custom-view/references/custom-view-contracts.md +46 -17
- package/dist/knowledge/skills/resource-external-data/references/erasure-suppression.md +2 -2
- package/dist/knowledge/skills/resource-retention-binding/SKILL.md +5 -1
- package/dist/knowledge/skills/resource-schema-authoring/SKILL.md +15 -1
- package/dist/knowledge/skills/resource-schema-authoring/references/computed-totals.md +569 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/document-numbers.md +358 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-decorator-vocabulary-api.md +8 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-shared-decorator-methods-api.md +21 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-special-factories-api.md +7 -2
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-zod-lifecycle-and-chainable-api.md +13 -0
- package/dist/knowledge/skills/resource-status-lifecycle/SKILL.md +153 -0
- package/dist/knowledge/skills/resource-status-lifecycle/references/commercial-documents.md +46 -0
- package/dist/knowledge/skills/resource-status-lifecycle/references/quote-lifecycle-worked-example.md +198 -0
- package/dist/knowledge/skills/resource-ui-behavior/SKILL.md +30 -4
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-collection-filter-presets-api.md +157 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-frontend-resource-ui-contracts-api.md +101 -19
- package/dist/knowledge/skills/seeding-authoring/SKILL.md +202 -39
- package/dist/knowledge/skills/seeding-authoring/references/cross-seed-row-references.md +67 -0
- package/dist/knowledge/skills/seeding-authoring/references/framework-data-seeding-api.md +154 -4
- package/dist/knowledge/skills/seeding-authoring/references/seed-row-overlay.md +22 -0
- package/dist/knowledge/skills/seeding-operations/references/framework-data-seeding-operations-api.md +7 -1
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-destinations-catalog.md +43 -0
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-placement-api.md +2 -2
- package/dist/knowledge/skills/spec-companion-exports/SKILL.md +6 -1
- package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +10 -0
- package/dist/knowledge/skills/spec-component-update/SKILL.md +10 -2
- package/dist/knowledge/skills/spec-composite-view-update/SKILL.md +2 -2
- package/dist/knowledge/skills/spec-family-update/SKILL.md +71 -66
- package/dist/knowledge/skills/spec-family-update/references/family-spec-routing.md +1 -1
- package/dist/knowledge/skills/spec-resource-update/SKILL.md +30 -10
- package/dist/knowledge/skills/spec-resource-update/references/resource-spec-field-routing.md +28 -0
- package/dist/knowledge/skills/spec-update-after-change/SKILL.md +22 -5
- package/dist/knowledge/skills/views-add-composite-view/SKILL.md +6 -1
- package/dist/knowledge/skills/views-add-custom-view/SKILL.md +10 -2
- package/dist/knowledge/skills/views-app-level/SKILL.md +13 -3
- package/dist/knowledge/skills/views-app-level/references/application-home.md +56 -0
- package/dist/knowledge/skills/views-chart-authoring/SKILL.md +221 -37
- package/dist/knowledge/skills/views-composite-authoring/SKILL.md +22 -5
- package/dist/knowledge/skills/views-execution-authoring/SKILL.md +1 -1
- package/dist/knowledge/skills/website-anonymous-session/SKILL.md +32 -2
- package/dist/knowledge/skills/website-blog-authoring/SKILL.md +16 -3
- package/dist/knowledge/skills/website-blog-authoring/references/blog-adapter-api.md +4 -0
- package/dist/knowledge/skills/website-bundle-discipline/SKILL.md +7 -1
- package/dist/knowledge/skills/website-consent-gate-overrides/SKILL.md +13 -1
- package/dist/knowledge/skills/website-factory-advanced/SKILL.md +14 -2
- package/dist/knowledge/skills/website-inbound-contact-forms/SKILL.md +13 -1
- package/dist/knowledge/skills/website-layout-overrides/SKILL.md +6 -1
- package/dist/knowledge/skills/website-marketing-metadata-extension/SKILL.md +19 -1
- package/dist/knowledge/skills/website-navigation-authoring/SKILL.md +55 -18
- package/dist/knowledge/skills/website-navigation-authoring/references/framework-public-document-links-api.md +98 -0
- package/dist/knowledge/skills/website-navigation-authoring/references/worked-examples-header-footer.md +8 -11
- package/dist/knowledge/skills/website-page-authoring/SKILL.md +100 -8
- package/dist/knowledge/skills/website-page-authoring/references/framework-site-context-loader-api.md +3 -0
- package/dist/knowledge/skills/website-primitive-overrides/SKILL.md +6 -1
- package/dist/knowledge/skills/website-section-contact/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-contact/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-cta/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-cta/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-faq/SKILL.md +21 -1
- package/dist/knowledge/skills/website-section-faq/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-feature-benefit-summary/SKILL.md +21 -1
- package/dist/knowledge/skills/website-section-feature-benefit-summary/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-feature-detail/SKILL.md +25 -2
- package/dist/knowledge/skills/website-section-feature-detail/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-footer-cta/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-footer-cta/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-hero/SKILL.md +33 -10
- package/dist/knowledge/skills/website-section-hero/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-pricing/SKILL.md +21 -1
- package/dist/knowledge/skills/website-section-pricing/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-social-proof/SKILL.md +27 -2
- package/dist/knowledge/skills/website-section-social-proof/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/SKILL.md +16 -4
- package/dist/knowledge/skills/website-seo-aeo-geo/references/aeo-api.md +11 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/references/geo-api.md +16 -1
- package/dist/knowledge/skills/website-seo-aeo-geo/references/seo-api.md +2 -1
- package/dist/knowledge/topic-index.json +1590 -292
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +4 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: spec-family-update
|
|
3
|
-
description: Author or update product, role, and milestone family specifications with stable ids, cross-links, and `codeHandling` wiring. Use when the user says "spec out a new product tier", "rename a role spec", "update the milestone narrative", "add a new product/role/milestone spec", "the family spec ids drifted from the runtime
|
|
3
|
+
description: Author or update product, role, and milestone family specifications with stable ids, cross-links, and `codeHandling` wiring. Use when the user says "spec out a new product tier", "rename a role spec", "update the milestone narrative", "add a new product/role/milestone spec", "the family spec ids drifted from the runtime record", or any change to product / role / milestone definition family records.
|
|
4
4
|
user-invocable: false
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -31,24 +31,27 @@ serve three consumers:
|
|
|
31
31
|
2. The **definition lookup** — `codeHandling.definitionOwner`,
|
|
32
32
|
`definitionSymbol`, `definitionCollectionEntry`, and
|
|
33
33
|
`identifierDeclaration` let companion follow the spec back to the
|
|
34
|
-
runtime
|
|
34
|
+
runtime record it describes.
|
|
35
35
|
3. The **packaging / commerce / org structure layers** — product
|
|
36
36
|
specs feed pricing tables; role specs feed permission narratives;
|
|
37
37
|
milestone specs feed onboarding and progression UIs.
|
|
38
38
|
|
|
39
39
|
These three families are spec'd through the **same shape** as feature
|
|
40
|
-
specs
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
follows
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
>
|
|
40
|
+
specs — each built with its `appLevel<Family>SpecificationFromDefinition(...)`
|
|
41
|
+
helper and aggregated with `build<Family>SpecificationMap(...)`, both from
|
|
42
|
+
`@wildo-ai/saas-specifications`. What differs is the runtime record each
|
|
43
|
+
spec follows:
|
|
44
|
+
|
|
45
|
+
| Family | Runtime record (shared-lib) | Shape |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| Role | `CUSTOM_ROLES_CONFIGURATION` in `shared-lib/src/engine/roles.ts` | a record keyed by the role name — no enum; declare the role itself with `application-roles-authoring` |
|
|
48
|
+
| Product | `CUSTOM_PRODUCT_CATALOG` in `shared-lib/src/engine/product.ts` | an array of product definitions |
|
|
49
|
+
| Milestone | `CUSTOM_MILESTONE_DEFINITIONS` in `shared-lib/src/engine/milestones.ts`, or a module's `moduleMilestonesDefinitions` in `shared-lib/src/modules/<module>/milestones.ts` | an array of milestone definitions |
|
|
50
|
+
|
|
51
|
+
> **Where they live**: role specifications under `specifications/src/engine/roles/`,
|
|
52
|
+
> product specifications under `specifications/src/engine/products/`, milestone
|
|
53
|
+
> specifications under `specifications/src/modules/<module>/milestones/`. Mirror a
|
|
54
|
+
> sibling in the same folder; with none yet, mirror `spec-feature-update`.
|
|
52
55
|
|
|
53
56
|
### A fourth definition family: error-message specs
|
|
54
57
|
|
|
@@ -72,18 +75,16 @@ two ways that change how you treat it:
|
|
|
72
75
|
|
|
73
76
|
| Surface | Glob (relative to repo root) |
|
|
74
77
|
|--------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
77
|
-
| Milestone spec | `specifications/src/milestones/<
|
|
78
|
-
|
|
|
79
|
-
|
|
|
80
|
-
| Family enums (parity) | `shared-lib/src/products/custom-products.ts`, `shared-lib/src/roles/custom-roles.ts`, `shared-lib/src/milestones/custom-milestones.ts` |
|
|
81
|
-
| Family definition collections | `shared-lib/src/products/custom-product-definitions.ts`, `shared-lib/src/roles/custom-role-definitions.ts`, `shared-lib/src/milestones/custom-milestone-definitions.ts` |
|
|
78
|
+
| Role spec | `specifications/src/engine/roles/<role>.role.specification.ts` (aggregated in `specifications/src/engine/roles/index.ts`) |
|
|
79
|
+
| Product spec | `specifications/src/engine/products/<product>.product.specification.ts` |
|
|
80
|
+
| Milestone spec | `specifications/src/modules/<slug>/milestones/<group>.milestone.specifications.ts` (aggregated in that folder's `index.ts`) |
|
|
81
|
+
| Companion exports | `specifications/src/companion-exports.ts` (`productSpecifications`, `roleSpecifications`, `milestoneSpecifications` slots) — spread the application's map beside the engine's, or the companion reads only the engine's |
|
|
82
|
+
| Runtime records | `shared-lib/src/engine/roles.ts` (`CUSTOM_ROLES_CONFIGURATION`), `shared-lib/src/engine/product.ts` (`CUSTOM_PRODUCT_CATALOG`), `shared-lib/src/engine/milestones.ts` / `shared-lib/src/modules/<slug>/milestones.ts` |
|
|
82
83
|
|
|
83
84
|
## When to Use
|
|
84
85
|
|
|
85
86
|
- Adding a new product tier, role, or milestone — author the spec
|
|
86
|
-
alongside the
|
|
87
|
+
alongside the runtime record
|
|
87
88
|
- Renaming a family record — update the spec's
|
|
88
89
|
`identifierDeclaration` + collection entry + cross-references
|
|
89
90
|
- Updating tier pricing narrative, role permissions narrative, or
|
|
@@ -103,15 +104,17 @@ two ways that change how you treat it:
|
|
|
103
104
|
|
|
104
105
|
## Workflow
|
|
105
106
|
|
|
106
|
-
### Step 1: Pick the family + locate the
|
|
107
|
+
### Step 1: Pick the family + locate the runtime record
|
|
107
108
|
|
|
108
109
|
Use `references/family-spec-routing.md` to pick the file pattern.
|
|
109
110
|
Whichever family (product / role / milestone), the spec must follow
|
|
110
111
|
its runtime backbone:
|
|
111
112
|
|
|
112
|
-
1.
|
|
113
|
-
|
|
114
|
-
|
|
113
|
+
1. Find (or add) the runtime record the spec describes: the role's entry
|
|
114
|
+
in `CUSTOM_ROLES_CONFIGURATION` (declared with `application-roles-authoring`),
|
|
115
|
+
the product in `CUSTOM_PRODUCT_CATALOG`, the milestone in its definitions array
|
|
116
|
+
2. Author the spec with the family's `appLevel<Family>SpecificationFromDefinition(...)`,
|
|
117
|
+
naming the record (`{ role: 'FIELD_TECHNICIAN' }` for a role)
|
|
115
118
|
3. Add cross-links if the family interacts with another (e.g. a
|
|
116
119
|
role spec that requires a product tier)
|
|
117
120
|
|
|
@@ -134,13 +137,15 @@ signal.
|
|
|
134
137
|
Same shape as the feature spec:
|
|
135
138
|
|
|
136
139
|
- `definitionOwner: { ownerId, ownerKind: SpecificationOwnerKind.* }`
|
|
137
|
-
- `definitionSymbol` — the
|
|
138
|
-
(`
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
140
|
+
- `definitionSymbol` — the runtime record's symbol
|
|
141
|
+
(`CUSTOM_ROLES_CONFIGURATION`, `CUSTOM_PRODUCT_CATALOG`,
|
|
142
|
+
`CUSTOM_MILESTONE_DEFINITIONS` or the module's `moduleMilestonesDefinitions`)
|
|
143
|
+
- `definitionCollectionEntry` — the field that identifies the entry and its
|
|
144
|
+
value; for a role, `identifierField: 'role'` and the role name (a small
|
|
145
|
+
helper beside the role specs, taking the role name, keeps the symbol in one
|
|
146
|
+
place)
|
|
147
|
+
- `identifierDeclaration` — a typed enum reference when the family's
|
|
148
|
+
identifiers ARE an enum; roles are plain strings, so a role spec has none
|
|
144
149
|
- `supportingSymbols: [...]` — related runtime symbols (e.g. for a
|
|
145
150
|
product spec, the pricing-table symbol; for a role spec, the
|
|
146
151
|
permission-set symbol)
|
|
@@ -149,16 +154,16 @@ Same shape as the feature spec:
|
|
|
149
154
|
|
|
150
155
|
### Step 5: Register
|
|
151
156
|
|
|
152
|
-
1. Add the spec to the family map
|
|
157
|
+
1. Add the spec to the family map (`build<Family>SpecificationMap`)
|
|
153
158
|
2. Re-export from the family spec barrel
|
|
154
159
|
3. Verify it lands in `specificationsCompanionExports.<family>Specifications`
|
|
155
160
|
|
|
156
161
|
## Worked Example
|
|
157
162
|
|
|
158
|
-
|
|
159
|
-
`spec-feature-update` worked example for the spec shape — the
|
|
160
|
-
`codeHandling` wiring pattern is identical, only the
|
|
161
|
-
|
|
163
|
+
Mirror a sibling family spec in the same folder when one exists; otherwise
|
|
164
|
+
mirror the `spec-feature-update` worked example for the spec shape — the
|
|
165
|
+
`codeHandling` wiring pattern is identical, only the runtime record
|
|
166
|
+
changes. The framework feature anchor
|
|
162
167
|
demonstrates the canonical typed `codeHandling` wiring you should
|
|
163
168
|
copy:
|
|
164
169
|
|
|
@@ -227,10 +232,10 @@ export const aiAssistantFeatureSpecification: FeatureSpecificationConfig = {
|
|
|
227
232
|
|
|
228
233
|
When porting to a family spec, swap:
|
|
229
234
|
|
|
230
|
-
- `CUSTOM_FEATURE_DEFINITIONS` → `
|
|
231
|
-
`
|
|
232
|
-
- `ApplicationFeature` →
|
|
233
|
-
|
|
235
|
+
- `CUSTOM_FEATURE_DEFINITIONS` → `CUSTOM_PRODUCT_CATALOG` /
|
|
236
|
+
`CUSTOM_ROLES_CONFIGURATION` / `CUSTOM_MILESTONE_DEFINITIONS`
|
|
237
|
+
- `ApplicationFeature` (an enum) → the product's or milestone's identifier,
|
|
238
|
+
or the role's plain name
|
|
234
239
|
- `featureSpecifications` map → `productSpecifications` /
|
|
235
240
|
`roleSpecifications` / `milestoneSpecifications`
|
|
236
241
|
- `availabilityRole` (feature-only) → drop in family specs (use
|
|
@@ -246,33 +251,34 @@ When porting to a family spec, swap:
|
|
|
246
251
|
|
|
247
252
|
## Verification
|
|
248
253
|
|
|
249
|
-
- [ ]
|
|
250
|
-
- [ ]
|
|
251
|
-
- [ ] Spec uses the family-specific typed contract (`ProductSpecificationConfig` / `RoleSpecificationConfig` / `MilestoneSpecificationConfig`)
|
|
254
|
+
- [ ] The runtime record the spec describes exists (the role in `CUSTOM_ROLES_CONFIGURATION`, the product in `CUSTOM_PRODUCT_CATALOG`, the milestone in its definitions array)
|
|
255
|
+
- [ ] Spec uses the family-specific typed contract (`ProductSpecificationConfig` / `RoleSpecificationConfig` / `MilestoneSpecificationConfig`) through its `appLevel<Family>SpecificationFromDefinition` helper
|
|
252
256
|
- [ ] `codeHandling.definitionOwner.ownerKind` uses `SpecificationOwnerKind.*`
|
|
253
|
-
- [ ] `codeHandling.definitionCollectionEntry
|
|
254
|
-
- [ ]
|
|
255
|
-
- [ ] Spec
|
|
256
|
-
- [ ] Spec lands in `specificationsCompanionExports.<family>Specifications`
|
|
257
|
+
- [ ] `codeHandling.definitionSymbol` names the runtime record, and `definitionCollectionEntry` names the entry (`identifierField: 'role'` + the role name, for a role)
|
|
258
|
+
- [ ] Spec registered in the family map through `build<Family>SpecificationMap`
|
|
259
|
+
- [ ] Spec lands in `specificationsCompanionExports.<family>Specifications`, spread beside the engine's map
|
|
257
260
|
|
|
258
261
|
### Grep invariants
|
|
259
262
|
|
|
260
|
-
Run from the
|
|
261
|
-
/ `milestone`), `<FamilyEnum>` (`CustomProduct` / `CustomRole` /
|
|
262
|
-
`CustomMilestone`), and `<MEMBER>`:
|
|
263
|
+
Run from the app root, substituting `<NAME>` (the role name, product or milestone identifier):
|
|
263
264
|
|
|
264
265
|
| Invariant | Command |
|
|
265
266
|
|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
266
|
-
|
|
|
267
|
-
|
|
|
268
|
-
|
|
|
269
|
-
|
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
267
|
+
| The runtime record exists | `rg -n "<NAME>" shared-lib/src/engine/roles.ts shared-lib/src/engine/product.ts shared-lib/src/engine/milestones.ts shared-lib/src/modules/*/milestones.ts` |
|
|
268
|
+
| A spec names it | `rg -ln "<NAME>" specifications/src/engine specifications/src/modules` |
|
|
269
|
+
| The companion reads the application's family map, not only the engine's | see the commands below the table |
|
|
270
|
+
| **Unique ids across a family** (must return no duplicates) | see the commands below the table |
|
|
271
|
+
|
|
272
|
+
```bash
|
|
273
|
+
# The companion reads the application's family map, not only the engine's
|
|
274
|
+
rg -n "roleSpecifications|productSpecifications|milestoneSpecifications" specifications/src/companion-exports.ts
|
|
275
|
+
|
|
276
|
+
# Unique ids across a family (must return no duplicates)
|
|
277
|
+
rg -P -oN "FromDefinition\(\s*\{\s*\w+:\s*'\K[^']+" specifications/src | sort | uniq -d
|
|
278
|
+
```
|
|
273
279
|
|
|
274
280
|
The high-signal invariant is **"unique ids across the family"** —
|
|
275
|
-
two specs that
|
|
281
|
+
two specs that name the same record mean one silently
|
|
276
282
|
shadows the other in the family map; companion will lose half the
|
|
277
283
|
narrative.
|
|
278
284
|
|
|
@@ -281,17 +287,16 @@ narrative.
|
|
|
281
287
|
| Rationalization | Reality |
|
|
282
288
|
|-----------------|---------|
|
|
283
289
|
| "Rename id casually" | Analytics, billing, permission systems, and companion all cache by id; renaming without a migration record breaks all four. |
|
|
284
|
-
| "Two families can share the same id namespace" | Each family has its own
|
|
290
|
+
| "Two families can share the same id namespace" | Each family has its own runtime record and map; cross-family id sharing breaks runtime resolution. |
|
|
285
291
|
| "I'll skip cross-family `supportingSymbols`" | When a role spec depends on a product tier, omitting the supporting symbol drops the cross-family link from companion / AI authoring. |
|
|
286
292
|
| "Schema families and definition families are the same thing" | They are not. Schema families (money, range, duration) are Zod factories under `resource-schema-authoring`; definition families (product, role, milestone) are this skill. |
|
|
287
293
|
|
|
288
294
|
## Red Flags
|
|
289
295
|
|
|
290
|
-
-
|
|
291
|
-
- Spec exists but
|
|
292
|
-
-
|
|
293
|
-
-
|
|
294
|
-
- Family record renamed in the enum but the spec's `memberName` still references the old name
|
|
296
|
+
- Two specs naming the same record in one family (catch with the **Unique ids across a family** grep — must return no lines)
|
|
297
|
+
- Spec exists but its runtime record does not (catch with the **runtime record exists** grep)
|
|
298
|
+
- `roleSpecifications` / `productSpecifications` / `milestoneSpecifications` in companion exports holding only the engine's map, so the application's specs are read by nothing (catch with the **companion reads the application's family map** grep)
|
|
299
|
+
- Record renamed in shared-lib but the spec still names the old one (catch with the **runtime record exists** grep on the spec's name)
|
|
295
300
|
|
|
296
301
|
## Related Skills
|
|
297
302
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|--------|-------------------|
|
|
5
5
|
| Product | `*.product.specification.ts` |
|
|
6
6
|
| Role | `*.role.specification.ts` |
|
|
7
|
-
| Milestone | `*.milestone.
|
|
7
|
+
| Milestone | `*.milestone.specifications.ts` (one file per group of milestones) |
|
|
8
8
|
|
|
9
9
|
Shared rules:
|
|
10
10
|
|
|
@@ -65,7 +65,7 @@ must trace back to a real schema field or a real config operation.
|
|
|
65
65
|
### Step 2: Route field work
|
|
66
66
|
|
|
67
67
|
Use `references/resource-spec-field-routing.md` to pick the right
|
|
68
|
-
`*Spec` shape (`enumSpec`, `
|
|
68
|
+
`*Spec()` method for the field's shape (`stringSpec`, `enumSpec`, `foreignKeySpec`, `moneySpec`, …) and its params type.
|
|
69
69
|
|
|
70
70
|
### Step 3: Specification decorators in code
|
|
71
71
|
|
|
@@ -198,19 +198,39 @@ Run from the app root, substituting `<resource>` (e.g. `todos`) and
|
|
|
198
198
|
|
|
199
199
|
| Invariant | Command |
|
|
200
200
|
|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
201
|
-
| Schema fields exist |
|
|
202
|
-
| Spec field map entries |
|
|
203
|
-
| **
|
|
201
|
+
| Schema fields exist | see the commands below the table |
|
|
202
|
+
| Spec field map entries | see the commands below the table |
|
|
203
|
+
| **Every field the spec documents exists in the schema** (must return empty) | see the commands below the table |
|
|
204
204
|
| Enum specs name `enumDeclaration` | `rg -n "enumDeclaration:" specifications/src/modules/<module>/resources/<resource>.resource.specification.ts` |
|
|
205
205
|
| Every spec field has `meaning` | `rg -c "meaning:" specifications/src/modules/<module>/resources/<resource>.resource.specification.ts` |
|
|
206
|
-
| Operations declared in config |
|
|
207
|
-
| Operations described in spec |
|
|
206
|
+
| Operations declared in config | see the commands below the table |
|
|
207
|
+
| Operations described in spec | see the commands below the table |
|
|
208
208
|
| Conditional operations (compare with the next row) | `rg -c "enabledCondition" shared-lib/src/modules/<module>/resources/<resource>/<resource>.resources-config.ts` |
|
|
209
209
|
| Operations stating why they can be unavailable | `rg -c "unavailableWhen" specifications/src/modules/<module>/resources/<resource>.resource.specification.ts` |
|
|
210
210
|
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
211
|
+
```bash
|
|
212
|
+
# Schema fields exist
|
|
213
|
+
rg -oN '^\s+([a-zA-Z]+):\s*z\.' shared-lib/src/modules/<module>/resources/<resource>/<resource>.schemas.ts | sort -u
|
|
214
|
+
|
|
215
|
+
# Spec field map entries
|
|
216
|
+
rg -oN '^\s+([a-zA-Z]+):\s*schemaShape\.' specifications/src/modules/<module>/resources/<resource>.resource.specification.ts | sort -u
|
|
217
|
+
|
|
218
|
+
# Every field the spec documents exists in the schema (must return empty)
|
|
219
|
+
for f in $(rg -oNP 'schemaShape\.\K\w+' specifications/src/modules/<module>/resources/<resource>.resource.specification.ts | sort -u); do
|
|
220
|
+
rg -q "^\s+$f\s*:" shared-lib/src/modules/<module>/resources/<resource>/<resource>.schemas.ts || echo "stale spec entry: $f"
|
|
221
|
+
done
|
|
222
|
+
|
|
223
|
+
# Operations declared in config
|
|
224
|
+
rg -oN "CoreResourceOperation\.[A-Z_]+" shared-lib/src/modules/<module>/resources/<resource>/<resource>.resources-config.ts | sort -u
|
|
225
|
+
|
|
226
|
+
# Operations described in spec
|
|
227
|
+
rg -oN "CoreResourceOperation\.[A-Z_]+" specifications/src/modules/<module>/resources/<resource>.resource.specification.ts | sort -u
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
The stale-entry invariant is the high-signal one: it catches "renamed or
|
|
231
|
+
removed a field, the spec still names the old one". Whether a NEW field
|
|
232
|
+
deserves an entry is a judgement no grep makes: document the fields that
|
|
233
|
+
carry meaning.
|
|
214
234
|
|
|
215
235
|
## Common Rationalizations
|
|
216
236
|
|
|
@@ -223,7 +243,7 @@ high-signal one — it catches "added a field, forgot to document it" and
|
|
|
223
243
|
|
|
224
244
|
## Red Flags
|
|
225
245
|
|
|
226
|
-
-
|
|
246
|
+
- The spec documents a field the schema no longer has, after a rename or a removal (catch with **Every field the spec documents exists in the schema** — must return empty). The other direction is a judgement, not a grep: the spec documents the fields that carry meaning (an enum, a foreign key, an array of objects), and may leave a plain field undocumented on purpose.
|
|
227
247
|
- Operation appears in spec but not in `*.resources-config.ts`, or vice versa (catch with the two **CoreResourceOperation** greps and diff them).
|
|
228
248
|
- Enum field documented without `enumDeclaration` (catch with **Enum specs name `enumDeclaration`** — must return at least 1 line per enum).
|
|
229
249
|
- Spec `fields` entry without a `meaning` value (catch with **Every spec field has `meaning`** — count must equal field-map size).
|
package/dist/knowledge/skills/spec-resource-update/references/resource-spec-field-routing.md
CHANGED
|
@@ -10,3 +10,31 @@ When editing `*.resource.specification.ts`:
|
|
|
10
10
|
| Variant-only | Place under correct variant path; update `additionalFieldSpecs` if used |
|
|
11
11
|
|
|
12
12
|
Keep `codeHandling` import paths aligned with `shared-lib` exports.
|
|
13
|
+
|
|
14
|
+
## Which `*Spec()` method a field takes
|
|
15
|
+
|
|
16
|
+
The method follows the field's SHAPE, the same way its `*UI()` method does. Its params object is optional; when you pass
|
|
17
|
+
one, `meaning` (what the field represents in the domain) is required. The types are in
|
|
18
|
+
`framework-field-spec-params-api.md`. There is no `relationSpec` or `semanticSpec`: a foreign key takes `foreignKeySpec`,
|
|
19
|
+
and the field's meaning goes in the shared params every method accepts (`FieldSpecBaseParams`).
|
|
20
|
+
|
|
21
|
+
| the field is | method | params type (beyond `FieldSpecBaseParams`) |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `z.string()` (or a string format) | `stringSpec` | `StringSpecParams` |
|
|
24
|
+
| a foreign key (`z.string().isForeignKey()`) | `foreignKeySpec` | `ForeignKeySpecParams` |
|
|
25
|
+
| a time of day (a string) | `timeSpec` | none |
|
|
26
|
+
| `z.number()` | `numberSpec` | `NumberSpecParams` |
|
|
27
|
+
| `z.boolean()` | `booleanSpec` | none |
|
|
28
|
+
| `z.date()` holding a date / a date and time | `dateSpec` / `dateTimeSpec` | `DateSpecParams` |
|
|
29
|
+
| `z.enum(...)` | `enumSpec` | `EnumSpecParams` (per-value `EnumValueSpecConfig`) |
|
|
30
|
+
| `z_money()` | `moneySpec` | none |
|
|
31
|
+
| `z_code()` | `codeSpec` | none |
|
|
32
|
+
| `z_file()` | `fileSpec` | none |
|
|
33
|
+
| `z_duration()` | `durationSpec` | none |
|
|
34
|
+
| `z_phone()` | `phoneSpec` | none |
|
|
35
|
+
| `z_bigdecimal()` | `bigDecimalSpec` | `BigDecimalSpecParams` |
|
|
36
|
+
| `z.array(...)` | `arraySpec` | `ArraySpecParams` |
|
|
37
|
+
| `z.object(...)`, `z.record(...)`, `z.map(...)` | `objectSpec` | none |
|
|
38
|
+
|
|
39
|
+
Call it on the field the way it is written: after `.optional()` or `.default(...)` works too, since the wrappers carry the
|
|
40
|
+
same methods.
|
|
@@ -127,7 +127,7 @@ documented `meaning`:
|
|
|
127
127
|
|
|
128
128
|
Apply the same shape to your edits:
|
|
129
129
|
|
|
130
|
-
- **Schema added a field?**
|
|
130
|
+
- **Schema added a field?** If it carries meaning (an enum, a foreign key, an array of objects, a value a reader must understand), add a `<fieldName>: schemaShape.<fieldName>.<...>Spec({...})` entry to the resource spec's `fields` map; a plain field may stay undocumented on purpose. **Schema removed or renamed a field?** Its spec entry must go or follow, since the spec may never name a field the schema lacks.
|
|
131
131
|
- **Schema added an enum value?** Add a `[MyEnum.NEW_VALUE]: { meaning: '...' }` entry to the spec's `values` map. TypeScript will catch this if the spec is typed against the enum — verify the `enumDeclaration` is in place.
|
|
132
132
|
- **Resources-config added an operation?** Reference it in the spec's operations section. The two `CoreResourceOperation.*` grep sets in `spec-resource-update` must match.
|
|
133
133
|
- **Relationships file added an FK?** The corresponding relationship spec entry must follow.
|
|
@@ -157,10 +157,27 @@ Run from the app root, substituting `<resource>` and `<module>`:
|
|
|
157
157
|
|
|
158
158
|
| Invariant | Command |
|
|
159
159
|
|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
160
|
-
| **
|
|
161
|
-
| **Operations in config ↔ operations in spec agree** (must return empty) |
|
|
162
|
-
| **Composite view section refs ↔ spec section refs agree** (must return empty) |
|
|
163
|
-
| Resource schema commit without matching spec touch (sanity check) |
|
|
160
|
+
| **Every field the spec documents exists in the schema** (must return empty) | see the commands below the table |
|
|
161
|
+
| **Operations in config ↔ operations in spec agree** (must return empty) | see the commands below the table |
|
|
162
|
+
| **Composite view section refs ↔ spec section refs agree** (must return empty) | see the commands below the table |
|
|
163
|
+
| Resource schema commit without matching spec touch (sanity check) | run the two commands below the table — both should be non-empty for the same resource |
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
# Every field the spec documents exists in the schema (must return empty)
|
|
167
|
+
rg -oNP 'schemaShape\.\K\w+' specifications/src/modules/<module>/resources/<resource>.resource.specification.ts | sort -u | while read -r f; do
|
|
168
|
+
rg -q "^\s+$f\s*:" shared-lib/src/modules/<module>/resources/<resource>/<resource>.schemas.ts || echo "stale spec entry: $f"
|
|
169
|
+
done
|
|
170
|
+
|
|
171
|
+
# Operations in config ↔ operations in spec agree (must return empty)
|
|
172
|
+
comm -3 <(rg -oN "CoreResourceOperation\.[A-Z_]+" shared-lib/src/modules/<module>/resources/<resource>/<resource>.resources-config.ts | sort -u) <(rg -oN "CoreResourceOperation\.[A-Z_]+" specifications/src/modules/<module>/resources/<resource>.resource.specification.ts | sort -u)
|
|
173
|
+
|
|
174
|
+
# Composite view section refs ↔ spec section refs agree (must return empty)
|
|
175
|
+
comm -3 <(rg -P -oN '<Section name="\K[a-z0-9-]+' frontend/src/modules/<module>/resources/**/<Component>.tsx | sort -u) <(rg -P -oN "sectionRef:\s*'\K[a-z0-9-]+" specifications/src/modules/<module>/composite-views/<view>.composite-view.specification.ts | sort -u)
|
|
176
|
+
|
|
177
|
+
# Resource schema commit without matching spec touch (sanity check)
|
|
178
|
+
git diff --name-only HEAD~1 | rg "(\\.schemas\\.ts|\\.resources-config\\.ts)"
|
|
179
|
+
git diff --name-only HEAD~1 | rg "\\.resource\\.specification\\.ts"
|
|
180
|
+
```
|
|
164
181
|
|
|
165
182
|
The first three invariants are the high-signal ones — each catches a
|
|
166
183
|
specific drift class (field, operation, section) at the surface where it
|
|
@@ -231,9 +231,14 @@ Run from the app root and substitute `<viewRef>` (the registry key, e.g.
|
|
|
231
231
|
| The registry entry uses `satisfies ResourceCompositeViewsConfig` (typed) | `rg -n "satisfies ResourceCompositeViewsConfig" frontend/src/modules/*/resources/**/<Component>.tsx` |
|
|
232
232
|
| Section names from the JSX | `rg -oN '<Section name="[a-z0-9-]+"' frontend/src/modules/*/resources/**/<Component>.tsx` |
|
|
233
233
|
| Section refs from the registry | `rg -oN "sectionRefs:\\s*\\[[^\\]]+\\]" frontend/src/modules/*/resources/**/<Component>.tsx` |
|
|
234
|
-
| **JSX section names ↔ registry sectionRefs agree** (must return empty) |
|
|
234
|
+
| **JSX section names ↔ registry sectionRefs agree** (must return empty) | see the commands below the table (both sides derived from the same component file — no hardcoded list) |
|
|
235
235
|
| The specification names the same composite ref | `rg -n "<viewRef>" specifications/src/modules/*/composite-views/*.composite-view.specification.ts` |
|
|
236
236
|
|
|
237
|
+
```bash
|
|
238
|
+
# JSX section names ↔ registry sectionRefs agree (must return empty)
|
|
239
|
+
comm -3 <(rg -oNP '<Section name="\K[a-z0-9-]+' frontend/src/modules/*/resources/**/<Component>.tsx | sort -u) <(rg -oNP "(?<=sectionRefs:\\s*\\[)[^\\]]+" frontend/src/modules/*/resources/**/<Component>.tsx | rg -oNP "'[a-z0-9-]+'" | tr -d "'" | sort -u)
|
|
240
|
+
```
|
|
241
|
+
|
|
237
242
|
The fifth invariant is the high-signal one: if the JSX section names
|
|
238
243
|
and the registry's `sectionRefs` diverge, the composite renders sections
|
|
239
244
|
the spec doesn't describe (or describes sections that never render).
|
|
@@ -201,13 +201,21 @@ the operation key:
|
|
|
201
201
|
|
|
202
202
|
| Invariant | Command |
|
|
203
203
|
|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
|
|
204
|
-
| The component file exists and exports the component |
|
|
205
|
-
| The component uses `useExecution()` (execution view) or `useResource()` (read/update host) |
|
|
204
|
+
| The component file exists and exports the component | see the commands below the table |
|
|
205
|
+
| The component uses `useExecution()` (execution view) or `useResource()` (read/update host) | see the commands below the table |
|
|
206
206
|
| The `ui-behavior` references the component | `rg -n "<Component>" frontend/src/modules/*/resources/*/*.ui-behavior.tsx` |
|
|
207
207
|
| The specification documents the view | `rg -n "exportName:\\s*'<Component>'" specifications/src/modules/*/resources/*.resource.specification.ts` |
|
|
208
208
|
| **No anchor props** are passed at the call site (must return zero matches in `ui-behavior`) | `rg -n "<Component>\\s+resourceId=" frontend/src/modules/*/resources/*/*.ui-behavior.tsx` |
|
|
209
209
|
| Component is not registered against more than one operation | `rg -c "<Component>" frontend/src/modules/*/resources/*/*.ui-behavior.tsx` |
|
|
210
210
|
|
|
211
|
+
```bash
|
|
212
|
+
# The component file exists and exports the component
|
|
213
|
+
rg -n "export (function|default|const) <Component>" frontend/src/modules/*/resources/**/*.tsx
|
|
214
|
+
|
|
215
|
+
# The component uses `useExecution()` (execution view) or `useResource()` (read/update host)
|
|
216
|
+
rg -n "useExecution\\(\\)|useResource\\(" frontend/src/modules/*/resources/**/<Component>.tsx
|
|
217
|
+
```
|
|
218
|
+
|
|
211
219
|
The fifth grep MUST return zero matches: anchor extraction is the
|
|
212
220
|
framework's job. The sixth grep should return at most `1` per file.
|
|
213
221
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: views-app-level
|
|
3
|
-
description: Register module-level or app-level view definitions, view refs, and full custom views outside a single resource folder — exposed via the `AppCompositeViewsConfig` map and reachable from navigation, sidebar, command menu, or launcher. Use when the user says "add a hub screen for the module", "register an overview / dashboard view", "expose a cross-resource view from the launcher", "add a view ref the sidebar can target", or any module-level / app-level view registration.
|
|
3
|
+
description: Register module-level or app-level view definitions, view refs, and full custom views outside a single resource folder — exposed via the `AppCompositeViewsConfig` map and reachable from navigation, sidebar, command menu, or launcher. Use when the user says "add a hub screen for the module", "register an overview / dashboard view", "expose a cross-resource view from the launcher", "add a view ref the sidebar can target", "make this dashboard the home page", or any module-level / app-level view registration, including the application's home (`homeDefinitionFactory`).
|
|
4
4
|
user-invocable: false
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -52,6 +52,7 @@ App-level views are routed differently than resource-owned views:
|
|
|
52
52
|
- Registering a full custom view reachable from the app shell
|
|
53
53
|
- Wiring cross-module view refs
|
|
54
54
|
- Creating a module overview dashboard
|
|
55
|
+
- Setting the application's home (`homeDefinitionFactory`) — see `references/application-home.md`
|
|
55
56
|
|
|
56
57
|
## When NOT to Use
|
|
57
58
|
|
|
@@ -149,6 +150,7 @@ What is **not** in this block (and shouldn't be):
|
|
|
149
150
|
## References
|
|
150
151
|
|
|
151
152
|
- `references/app-level-views-routing.md`
|
|
153
|
+
- `references/application-home.md` — make a view or a resource operation what a person sees at `/` (`homeDefinitionFactory`)
|
|
152
154
|
- `references/framework-view-scope-and-full-custom-api.md` — source-backed `FrontendView_Definition` + `FullCustomViewDefinition`
|
|
153
155
|
|
|
154
156
|
## Verification
|
|
@@ -169,10 +171,18 @@ Run from the app root, substituting `<slug>`:
|
|
|
169
171
|
|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
|
|
170
172
|
| Registration map is typed | `rg -n "satisfies AppCompositeViewsConfig" frontend/src/modules/<slug>/app-level-views/index.ts` |
|
|
171
173
|
| View refs are constants, not literals | `rg -n "viewRef=\"[a-z-]+\"" frontend/src/modules/<slug>/app-level-views` (must return empty — consumers should use the constant) |
|
|
172
|
-
| Each registered view ref has a constant in `view-refs.frontend.ts` |
|
|
173
|
-
| **Section names in JSX match `sectionRefs`** (must return empty per file) |
|
|
174
|
+
| Each registered view ref has a constant in `view-refs.frontend.ts` | run the commands below the table, cross-checked with `view-refs.frontend.ts` |
|
|
175
|
+
| **Section names in JSX match `sectionRefs`** (must return empty per file) | see the commands below the table |
|
|
174
176
|
| App-level views re-exported from the module index | `rg -n "from\s+'./app-level-views'" frontend/src/modules/<slug>/index.ts` |
|
|
175
177
|
|
|
178
|
+
```bash
|
|
179
|
+
# Each registered view ref has a constant in `view-refs.frontend.ts`
|
|
180
|
+
rg -P -oN "\[\K[A-Z_]+(?=\]:)" frontend/src/modules/<slug>/app-level-views/index.ts | sort -u
|
|
181
|
+
|
|
182
|
+
# Section names in JSX match `sectionRefs` (must return empty per file)
|
|
183
|
+
comm -3 <(rg -P -oN "<Section name=\"\K[a-z]+" <ViewFile>.tsx | sort -u) <(rg -P -oN "sectionRefs:\s*\[\K[^\]]+" <registry>.ts | tr ',' '\n' | rg -oN "[a-z]+" | sort -u)
|
|
184
|
+
```
|
|
185
|
+
|
|
176
186
|
The first invariant (typed registration) is the high-signal one —
|
|
177
187
|
without `satisfies AppCompositeViewsConfig`, the map silently
|
|
178
188
|
accepts unknown keys and consumers cannot typecheck `viewRef`
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# The application's home
|
|
2
|
+
|
|
3
|
+
What a person sees when they open the application root (`/`). It is set in one place:
|
|
4
|
+
`homeDefinitionFactory` in `frontend/src/config/global-views.config.ts`. When it returns nothing, the
|
|
5
|
+
application opens on the framework's default welcome page.
|
|
6
|
+
|
|
7
|
+
Read this when:
|
|
8
|
+
|
|
9
|
+
- the experience plan decides a `home` and your task's objective asks you to set it;
|
|
10
|
+
- the root shows the welcome page although a home was configured;
|
|
11
|
+
- you are choosing between showing a dashboard at the root and opening a resource's list.
|
|
12
|
+
|
|
13
|
+
## Two forms, mutually exclusive
|
|
14
|
+
|
|
15
|
+
| Plan says | Return | Notes |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
| a `VIEW` home | `{ compositeViewReference: <view ref constant> }` | Only an **application-level** composite view, a key of an `AppCompositeViewsConfig`. It renders in place, and the URL stays `/`. A composite view one resource owns (declared in its `ui-behavior`) is not registered there, so the root shows "view not found". |
|
|
18
|
+
| a `RESOURCE_OPERATION` home | `{ resourceOperationPath: { … } }` | The root redirects to that operation. |
|
|
19
|
+
|
|
20
|
+
## A view home
|
|
21
|
+
|
|
22
|
+
Use the view's ref constant from `view-refs.frontend.ts`, never a string literal. A renamed view then
|
|
23
|
+
fails to compile instead of opening on "view not found":
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Usage Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
export const homeDefinitionFactory: FrontendConfigFactory_HomeDefinition = () => ({
|
|
30
|
+
// Application root ("/") renders the home dashboard, an application-level composite view, IN PLACE: the URL stays
|
|
31
|
+
// "/", and the composite remains addressable at its own `/composite/<ref>` route. Named by its ref constant, never
|
|
32
|
+
// a string literal, so a renamed view fails to compile here instead of opening on "view not found".
|
|
33
|
+
compositeViewReference: HOME_DASHBOARD_VIEW_REF,
|
|
34
|
+
});
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## A resource-operation home
|
|
38
|
+
|
|
39
|
+
`resourceOperationPath` is matched EXACTLY against the resource's operations, and a mismatch is
|
|
40
|
+
silent: the root shows the welcome page and nothing reports it. Fill every field:
|
|
41
|
+
|
|
42
|
+
| Field | Value |
|
|
43
|
+
|---|---|
|
|
44
|
+
| `resourceType` | the resource's registered type, camelCase (`workOrder`), not its kebab-case slug |
|
|
45
|
+
| `operationIdentifier` | the operation: `list`, `read`, or the custom verb's identifier |
|
|
46
|
+
| `isOperationDefault` | `true`: the operation's default variant |
|
|
47
|
+
| `isBulkOperation` | `false` |
|
|
48
|
+
| `variantKey` | that default variant's key, when it declares one; omit it otherwise |
|
|
49
|
+
| `parentResourcesRequirements` | `[]` for a top-level resource; the parent chain for a nested one |
|
|
50
|
+
|
|
51
|
+
## Verify
|
|
52
|
+
|
|
53
|
+
- `rg -n "homeDefinitionFactory" -A6 frontend/src/config/global-views.config.ts`: it returns exactly one of
|
|
54
|
+
the two forms.
|
|
55
|
+
- For a view home, the ref constant is a key of an `AppCompositeViewsConfig` (`rg -n "<REF_CONSTANT>" frontend/src/modules/*/app-level-views/`).
|
|
56
|
+
- Open `/` in the running application: it shows the home, not the welcome title.
|