@wildo-ai/framework-knowledge 1.1.0
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/LICENSE +34 -0
- package/dist/esm/.builder.pid +9 -0
- package/dist/esm/framework-knowledge.definitions.d.ts +51 -0
- package/dist/esm/framework-knowledge.definitions.d.ts.map +1 -0
- package/dist/esm/framework-knowledge.definitions.js +1571 -0
- package/dist/esm/framework-knowledge.definitions.js.map +1 -0
- package/dist/esm/framework-knowledge.loader.d.ts +72 -0
- package/dist/esm/framework-knowledge.loader.d.ts.map +1 -0
- package/dist/esm/framework-knowledge.loader.js +258 -0
- package/dist/esm/framework-knowledge.loader.js.map +1 -0
- package/dist/esm/framework-knowledge.schemas.d.ts +236 -0
- package/dist/esm/framework-knowledge.schemas.d.ts.map +1 -0
- package/dist/esm/framework-knowledge.schemas.js +23 -0
- package/dist/esm/framework-knowledge.schemas.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +4 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +53 -0
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js +56 -0
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts +200 -0
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js +228 -0
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts +39 -0
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js +39 -0
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts +261 -0
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js +412 -0
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts +61 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +65 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts +53 -0
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js +54 -0
- package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts +43 -0
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js +73 -0
- package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts +53 -0
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js +114 -0
- package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts +95 -0
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js +102 -0
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts +258 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js +241 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts +241 -0
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js +202 -0
- package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +82 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js +89 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts +56 -0
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js +76 -0
- package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts +30 -0
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js +27 -0
- package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts +31 -0
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.js +26 -0
- package/dist/esm/playbooks/top_down.market-research/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts +254 -0
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js +219 -0
- package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts +180 -0
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js +302 -0
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts +249 -0
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js +286 -0
- package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts +248 -0
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js +227 -0
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts +45 -0
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js +48 -0
- package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts +250 -0
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js +218 -0
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js.map +1 -0
- package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/authority-basis.json +1 -0
- package/dist/knowledge/manifest.json +45 -0
- package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +407 -0
- package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +69 -0
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +556 -0
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +47 -0
- package/dist/knowledge/playbooks/bottom_up.build-scale/method.md +344 -0
- package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +43 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/method.md +259 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +83 -0
- package/dist/knowledge/playbooks/bottom_up.domain-plan/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/bottom_up.foundation/method.md +321 -0
- package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +79 -0
- package/dist/knowledge/playbooks/bottom_up.placement-plan/method.md +185 -0
- package/dist/knowledge/playbooks/bottom_up.placement-plan/playbook.json +66 -0
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +737 -0
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +44 -0
- package/dist/knowledge/playbooks/refinement.document-facts/method.md +261 -0
- package/dist/knowledge/playbooks/refinement.document-facts/playbook.json +57 -0
- package/dist/knowledge/playbooks/top_down.brand-identity/method.md +151 -0
- package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +124 -0
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.business-model/method.md +128 -0
- package/dist/knowledge/playbooks/top_down.business-model/playbook.json +102 -0
- package/dist/knowledge/playbooks/top_down.business-model/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/top_down.capability-map/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.capability-map/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.capability-map/method.md +239 -0
- package/dist/knowledge/playbooks/top_down.capability-map/playbook.json +73 -0
- package/dist/knowledge/playbooks/top_down.capability-map/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/top_down.compliance-posture/method.md +177 -0
- package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +95 -0
- package/dist/knowledge/playbooks/top_down.market-analysis/method.md +64 -0
- package/dist/knowledge/playbooks/top_down.market-analysis/playbook.json +49 -0
- package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/method.md +56 -0
- package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/playbook.json +40 -0
- package/dist/knowledge/playbooks/top_down.market-research/method.md +68 -0
- package/dist/knowledge/playbooks/top_down.market-research/playbook.json +42 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/method.md +239 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/playbook.json +69 -0
- package/dist/knowledge/playbooks/top_down.market-snapshot-produce/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.phase-gate/method.md +96 -0
- package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +77 -0
- package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.requirements-definition/method.md +53 -0
- package/dist/knowledge/playbooks/top_down.requirements-definition/playbook.json +61 -0
- package/dist/knowledge/playbooks/top_down.requirements-definition/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/top_down.scope-roadmap/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.scope-roadmap/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.scope-roadmap/method.md +280 -0
- package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +87 -0
- package/dist/knowledge/playbooks/top_down.scope-roadmap/structured-artifact-action.json +1 -0
- package/dist/knowledge/playbooks/top_down.value-proposition/method.md +204 -0
- package/dist/knowledge/playbooks/top_down.value-proposition/playbook.json +54 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/method.md +146 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +120 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/structured-artifact-action.json +1 -0
- package/dist/knowledge/references/application.database.migration-change-risk.md +28 -0
- package/dist/knowledge/references/assertions.authored-metadata.config.md +90 -0
- package/dist/knowledge/references/assertions.behaviors.wire-contracts.md +223 -0
- package/dist/knowledge/references/assertions.references.conventions.md +92 -0
- package/dist/knowledge/references/assertions.snapshot.validation.md +317 -0
- package/dist/knowledge/references/assertions.specification.config.md +287 -0
- package/dist/knowledge/references/brand.asset.config.md +167 -0
- package/dist/knowledge/references/brand.authored-metadata.config.md +51 -0
- package/dist/knowledge/references/brand.logo-direction.config.md +88 -0
- package/dist/knowledge/references/brand.name.config.md +46 -0
- package/dist/knowledge/references/brand.snapshot.config.md +76 -0
- package/dist/knowledge/references/brand.snapshot.validation.md +446 -0
- package/dist/knowledge/references/brand.visual-tone.config.md +56 -0
- package/dist/knowledge/references/build-plan.task-graph.config.md +198 -0
- package/dist/knowledge/references/business-model.authored-metadata.config.md +65 -0
- package/dist/knowledge/references/business-model.pricing-plan.config.md +122 -0
- package/dist/knowledge/references/business-model.references.conventions.md +99 -0
- package/dist/knowledge/references/business-model.snapshot.config.md +121 -0
- package/dist/knowledge/references/business-model.snapshot.validation.md +325 -0
- package/dist/knowledge/references/cli.market.generate-command.md +230 -0
- package/dist/knowledge/references/cli.market.utils.md +147 -0
- package/dist/knowledge/references/companion.introspection.behaviors.market.md +90 -0
- package/dist/knowledge/references/companion.introspection.handlers.market.md +42 -0
- package/dist/knowledge/references/companion.market.generation-service.md +270 -0
- package/dist/knowledge/references/companion.market.prompt-renderer.md +244 -0
- package/dist/knowledge/references/companion.technical-doc.service.md +809 -0
- package/dist/knowledge/references/engine.client-bundle.allow-list.md +125 -0
- package/dist/knowledge/references/engine.client-bundle.discipline.md +130 -0
- package/dist/knowledge/references/engine.client-bundle.external-connectors-public.discipline.md +55 -0
- package/dist/knowledge/references/engine.saas-technical-doc.config.md +215 -0
- package/dist/knowledge/references/engine.saas-website.config.md +331 -0
- package/dist/knowledge/references/example.authorization.unit-narrowing.declaration.md +24 -0
- package/dist/knowledge/references/example.backend.addon-wiring.module.md +55 -0
- package/dist/knowledge/references/example.backend.custom-operation.create-postfix.md +35 -0
- package/dist/knowledge/references/example.backend.operation.error-throw.md +17 -0
- package/dist/knowledge/references/example.config.app-shell.command-menu-items.md +63 -0
- package/dist/knowledge/references/example.config.app-shell.full.md +147 -0
- package/dist/knowledge/references/example.config.app-shell.hosted-components.md +45 -0
- package/dist/knowledge/references/example.config.app-shell.quick-switcher-fields.md +37 -0
- package/dist/knowledge/references/example.config.backend.billing-enable.md +20 -0
- package/dist/knowledge/references/example.config.backend.required-floors.md +46 -0
- package/dist/knowledge/references/example.config.design-system.full.md +162 -0
- package/dist/knowledge/references/example.config.navigation.full.md +71 -0
- package/dist/knowledge/references/example.config.provider.backend-scope-billing.md +27 -0
- package/dist/knowledge/references/example.data-seeding.minimal.md +114 -0
- package/dist/knowledge/references/example.email.template.minimal.md +54 -0
- package/dist/knowledge/references/example.engine.component-registration.lazy-load.md +16 -0
- package/dist/knowledge/references/example.engine.product-definitions.feature-and-profiles.md +146 -0
- package/dist/knowledge/references/example.flows-actors.chat-assistant.md +196 -0
- package/dist/knowledge/references/example.flows-actors.llm-agent-one-shot.md +174 -0
- package/dist/knowledge/references/example.i18n.label-generation.engine-barrel.md +15 -0
- package/dist/knowledge/references/example.infra.cdn.cloudflare.md +23 -0
- package/dist/knowledge/references/example.infra.cdn.generic.md +17 -0
- package/dist/knowledge/references/example.infra.environment-config.local.md +250 -0
- package/dist/knowledge/references/example.market.alternative.in-house-build.md +49 -0
- package/dist/knowledge/references/example.market.authored-metadata.md +32 -0
- package/dist/knowledge/references/example.market.buying-journey.core-icp.md +140 -0
- package/dist/knowledge/references/example.market.category.config.md +71 -0
- package/dist/knowledge/references/example.market.channel.community.md +39 -0
- package/dist/knowledge/references/example.market.feature-benefit.kano-threshold.md +67 -0
- package/dist/knowledge/references/example.market.feature-benefit.pain-reliever.md +65 -0
- package/dist/knowledge/references/example.market.icp.anti-target.md +47 -0
- package/dist/knowledge/references/example.market.icp.individual.md +82 -0
- package/dist/knowledge/references/example.market.icp.legal-entity-with-geographies.md +95 -0
- package/dist/knowledge/references/example.market.is-benefit-available.composition.md +40 -0
- package/dist/knowledge/references/example.market.job.emotional.md +27 -0
- package/dist/knowledge/references/example.market.job.functional.md +28 -0
- package/dist/knowledge/references/example.market.message-template.seeds.md +106 -0
- package/dist/knowledge/references/example.market.objection.pricing.md +39 -0
- package/dist/knowledge/references/example.market.persona.dmu-with-inheritance.md +62 -0
- package/dist/knowledge/references/example.market.persona.individual-self.md +51 -0
- package/dist/knowledge/references/example.market.positioning.per-icp.md +103 -0
- package/dist/knowledge/references/example.market.proof.metric.md +39 -0
- package/dist/knowledge/references/example.market.scoring.golden-case.md +46 -0
- package/dist/knowledge/references/example.market.scoring.no-coverage-zero.md +40 -0
- package/dist/knowledge/references/example.market.snapshot-validation.duplicate-journey-stage.md +36 -0
- package/dist/knowledge/references/example.market.snapshot-validation.errors-by-kind.md +55 -0
- package/dist/knowledge/references/example.market.snapshot-validation.objection-proof-benefit-mismatch.md +74 -0
- package/dist/knowledge/references/example.market.snapshot-validation.proof-without-support.md +32 -0
- package/dist/knowledge/references/example.market.snapshot-validation.threshold-without-job.md +44 -0
- package/dist/knowledge/references/example.market.snapshot.assembled.md +49 -0
- package/dist/knowledge/references/example.market.tone-of-voice.config.md +41 -0
- package/dist/knowledge/references/example.market.trigger.growth-milestone.md +43 -0
- package/dist/knowledge/references/example.module.companion-exports.full.md +142 -0
- package/dist/knowledge/references/example.module.registration.shared.md +16 -0
- package/dist/knowledge/references/example.module.relationships.actor-edge-back-to-scope-owner.md +47 -0
- package/dist/knowledge/references/example.module.relationships.discriminator.md +25 -0
- package/dist/knowledge/references/example.module.relationships.scope-membership-junction.md +25 -0
- package/dist/knowledge/references/example.provider.backend-module-shape.md +110 -0
- package/dist/knowledge/references/example.provider.contribution.backend-billing.md +12 -0
- package/dist/knowledge/references/example.provider.frontend-file-picker.contribution.md +30 -0
- package/dist/knowledge/references/example.provider.frontend-file-picker.module.md +21 -0
- package/dist/knowledge/references/example.rag.source-fields.declaration.md +83 -0
- package/dist/knowledge/references/example.rate-limit.custom-controller-surface.md +25 -0
- package/dist/knowledge/references/example.rate-limit.resource-operation-surface.md +24 -0
- package/dist/knowledge/references/example.resource.add-field.priority-enum.md +19 -0
- package/dist/knowledge/references/example.resource.add-resource.module-factory-map.md +21 -0
- package/dist/knowledge/references/example.resource.config-wiring.fk-relationship.md +33 -0
- package/dist/knowledge/references/example.resource.custom-view.read-host.md +28 -0
- package/dist/knowledge/references/example.resource.mcp-exposure.md +65 -0
- package/dist/knowledge/references/example.resource.reference-constraints.role-constrained.md +27 -0
- package/dist/knowledge/references/example.resource.ui-behavior.enum-badge.md +22 -0
- package/dist/knowledge/references/example.resource.ui-behavior.operation-icon.md +43 -0
- package/dist/knowledge/references/example.spec.composite-view.workspace.md +72 -0
- package/dist/knowledge/references/example.spec.feature.flag-with-codehandling.md +64 -0
- package/dist/knowledge/references/example.spec.frontend-component.prop-vocabulary.md +88 -0
- package/dist/knowledge/references/example.spec.resource.semantic-field.md +23 -0
- package/dist/knowledge/references/example.views.app-level.composite-views-config.md +19 -0
- package/dist/knowledge/references/example.views.chart-view.resource-owned.md +69 -0
- package/dist/knowledge/references/example.views.composite-view.host-embeds.md +31 -0
- package/dist/knowledge/references/example.views.composite-view.workspace.md +65 -0
- package/dist/knowledge/references/example.views.custom-view.execution-host.md +41 -0
- package/dist/knowledge/references/example.views.execution-view.resource-owned.md +25 -0
- package/dist/knowledge/references/external-connectors.app.frontend-provider-module.md +42 -0
- package/dist/knowledge/references/market.alternative.config.md +68 -0
- package/dist/knowledge/references/market.alternative.kind.md +32 -0
- package/dist/knowledge/references/market.authored-metadata.config.md +64 -0
- package/dist/knowledge/references/market.buying-journey.config.md +43 -0
- package/dist/knowledge/references/market.buying-journey.stage.md +33 -0
- package/dist/knowledge/references/market.category.config.md +63 -0
- package/dist/knowledge/references/market.channel.config.md +59 -0
- package/dist/knowledge/references/market.channel.kind.md +49 -0
- package/dist/knowledge/references/market.context-block.builder.md +544 -0
- package/dist/knowledge/references/market.context-block.response.md +57 -0
- package/dist/knowledge/references/market.feature-benefit.config.md +84 -0
- package/dist/knowledge/references/market.feature-benefit.kano.md +41 -0
- package/dist/knowledge/references/market.gain.config.md +50 -0
- package/dist/knowledge/references/market.generation.response.md +108 -0
- package/dist/knowledge/references/market.icp.config.md +162 -0
- package/dist/knowledge/references/market.icp.geographic-targeting.md +57 -0
- package/dist/knowledge/references/market.inherit-from.md +74 -0
- package/dist/knowledge/references/market.is-benefit-available.md +58 -0
- package/dist/knowledge/references/market.job.config.md +48 -0
- package/dist/knowledge/references/market.message-template.config.md +86 -0
- package/dist/knowledge/references/market.objection.config.md +56 -0
- package/dist/knowledge/references/market.objection.kind.md +34 -0
- package/dist/knowledge/references/market.pain.config.md +50 -0
- package/dist/knowledge/references/market.persona.config.md +64 -0
- package/dist/knowledge/references/market.positioning.config.md +84 -0
- package/dist/knowledge/references/market.proof.config.md +48 -0
- package/dist/knowledge/references/market.proof.kind.md +34 -0
- package/dist/knowledge/references/market.references.weighted-edges.md +105 -0
- package/dist/knowledge/references/market.scoring.fit.md +215 -0
- package/dist/knowledge/references/market.snapshot.config.md +34 -0
- package/dist/knowledge/references/market.snapshot.validation.md +1171 -0
- package/dist/knowledge/references/market.tone-of-voice.config.md +80 -0
- package/dist/knowledge/references/market.trigger.config.md +45 -0
- package/dist/knowledge/references/market.trigger.kind.md +35 -0
- package/dist/knowledge/references/placement-plan.config.md +330 -0
- package/dist/knowledge/references/platform.config.application-database.md +74 -0
- package/dist/knowledge/references/platform.config.application-modules.md +30 -0
- package/dist/knowledge/references/platform.config.backing-services.md +266 -0
- package/dist/knowledge/references/platform.config.cdn.md +167 -0
- package/dist/knowledge/references/platform.config.environment.deployment.md +263 -0
- package/dist/knowledge/references/platform.config.saas.md +405 -0
- package/dist/knowledge/references/presets.models.design-system.configuration.md +59 -0
- package/dist/knowledge/references/presets.models.design-system.source-config.md +72 -0
- package/dist/knowledge/references/presets.models.labelling.sections.md +64 -0
- package/dist/knowledge/references/presets.models.material.profile-contract.md +192 -0
- package/dist/knowledge/references/presets.models.material.runtime-policy.md +60 -0
- package/dist/knowledge/references/presets.models.surface-policy.defaults.md +613 -0
- package/dist/knowledge/references/presets.models.surface-policy.md +534 -0
- package/dist/knowledge/references/presets.models.surface-variant.md +56 -0
- package/dist/knowledge/references/requirements.authored-metadata.config.md +64 -0
- package/dist/knowledge/references/requirements.functional-requirement.config.md +68 -0
- package/dist/knowledge/references/requirements.non-functional-requirement.config.md +100 -0
- package/dist/knowledge/references/requirements.references.conventions.md +125 -0
- package/dist/knowledge/references/requirements.snapshot.config.md +73 -0
- package/dist/knowledge/references/requirements.snapshot.validation.md +333 -0
- package/dist/knowledge/references/roadmap.authored-metadata.config.md +64 -0
- package/dist/knowledge/references/roadmap.phase.config.md +149 -0
- package/dist/knowledge/references/roadmap.references.conventions.md +89 -0
- package/dist/knowledge/references/roadmap.snapshot.config.md +65 -0
- package/dist/knowledge/references/roadmap.snapshot.validation.md +325 -0
- package/dist/knowledge/references/saas.backend.app-config.backend-authored.md +32 -0
- package/dist/knowledge/references/saas.backend.application-initialization.assembly.md +38 -0
- package/dist/knowledge/references/saas.backend.billing.resolution-failure-reasons.md +45 -0
- package/dist/knowledge/references/saas.backend.custom-operation.authoritative-fields.md +53 -0
- package/dist/knowledge/references/saas.backend.custom-operation.transactional-core.md +120 -0
- package/dist/knowledge/references/saas.backend.domain-module.md +237 -0
- package/dist/knowledge/references/saas.backend.email-template.definition.md +69 -0
- package/dist/knowledge/references/saas.backend.flows-actors.a2a-agent-card.md +89 -0
- package/dist/knowledge/references/saas.backend.flows-actors.a2a-task-surface.md +118 -0
- package/dist/knowledge/references/saas.backend.flows-actors.function-tool.md +82 -0
- package/dist/knowledge/references/saas.backend.flows-actors.invoke-agent.md +48 -0
- package/dist/knowledge/references/saas.backend.flows-actors.resource-read-tool.md +39 -0
- package/dist/knowledge/references/saas.backend.flows-actors.resource-write-tool.md +67 -0
- package/dist/knowledge/references/saas.backend.pdf-template.bindings.md +52 -0
- package/dist/knowledge/references/saas.backend.pdf-template.definition.md +113 -0
- package/dist/knowledge/references/saas.backend.rate-limit-service.check-policy.md +75 -0
- package/dist/knowledge/references/saas.backend.system-access-service.md +994 -0
- package/dist/knowledge/references/saas.data-seeding.admin-endpoints.md +59 -0
- package/dist/knowledge/references/saas.data-seeding.bootstrap-wiring.md +184 -0
- package/dist/knowledge/references/saas.data-seeding.definition-input.md +95 -0
- package/dist/knowledge/references/saas.data-seeding.modes.md +72 -0
- package/dist/knowledge/references/saas.data-seeding.run-ledger.md +198 -0
- package/dist/knowledge/references/saas.data-seeding.run-status.md +35 -0
- package/dist/knowledge/references/saas.data-seeding.schedule.md +91 -0
- package/dist/knowledge/references/saas.data-seeding.scope-iteration-strategy.md +46 -0
- package/dist/knowledge/references/saas.external-providers.backend-provider-registry.runtime-filter.md +55 -0
- package/dist/knowledge/references/saas.external-providers.document-extraction.applicability.md +26 -0
- package/dist/knowledge/references/saas.external-providers.embeddings.applicability.md +30 -0
- package/dist/knowledge/references/saas.external-providers.llm.model-configuration.md +124 -0
- package/dist/knowledge/references/saas.external-providers.llm.operation-key.md +49 -0
- package/dist/knowledge/references/saas.frontend.app-level-component.configuration.md +265 -0
- package/dist/knowledge/references/saas.frontend.app-level-component.vocabulary.md +148 -0
- package/dist/knowledge/references/saas.frontend.app-shell.hosted-components.md +145 -0
- package/dist/knowledge/references/saas.frontend.chart-view.inserted-declaration.md +80 -0
- package/dist/knowledge/references/saas.frontend.command-menu.omnibox.md +88 -0
- package/dist/knowledge/references/saas.frontend.command-menu.search-resource.md +109 -0
- package/dist/knowledge/references/saas.frontend.component-registration.entry.md +21 -0
- package/dist/knowledge/references/saas.frontend.composite-view.authoring.md +102 -0
- package/dist/knowledge/references/saas.frontend.composite-view.define-helper.md +31 -0
- package/dist/knowledge/references/saas.frontend.domain-module.md +31 -0
- package/dist/knowledge/references/saas.frontend.embedded-resource-descent.md +37 -0
- package/dist/knowledge/references/saas.frontend.execution-view.action-status-contract.md +172 -0
- package/dist/knowledge/references/saas.frontend.execution-view.action-status-contract.per-action-retry-loop.md +115 -0
- package/dist/knowledge/references/saas.frontend.execution-view.definition.md +172 -0
- package/dist/knowledge/references/saas.frontend.execution-view.dirty-bridge-contract.local-pane.md +109 -0
- package/dist/knowledge/references/saas.frontend.execution-view.dirty-bridge-contract.md +55 -0
- package/dist/knowledge/references/saas.frontend.execution-view.dirty-state-contract.md +151 -0
- package/dist/knowledge/references/saas.frontend.execution-view.failure-handling-contract.md +302 -0
- package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.md +89 -0
- package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.participation-prefetch.md +231 -0
- package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.participation-prefetch.shell-data-hydrator.md +174 -0
- package/dist/knowledge/references/saas.frontend.execution-view.navigation-handling-and-embedding.md +96 -0
- package/dist/knowledge/references/saas.frontend.execution-view.navigation-handling-and-embedding.resolution.md +45 -0
- package/dist/knowledge/references/saas.frontend.execution-view.outcome-emission-contract.md +71 -0
- package/dist/knowledge/references/saas.frontend.execution-view.participation-and-anchor.md +80 -0
- package/dist/knowledge/references/saas.frontend.execution-view.three-zone-contract.md +147 -0
- package/dist/knowledge/references/saas.frontend.flows-actors-view.md +40 -0
- package/dist/knowledge/references/saas.frontend.form-fields.file-provider-constraints.md +80 -0
- package/dist/knowledge/references/saas.frontend.full-custom-view.definition.md +64 -0
- package/dist/knowledge/references/saas.frontend.inserted-view.identity-bindings-descriptor.md +149 -0
- package/dist/knowledge/references/saas.frontend.operation-key-and-resource-config-like.md +63 -0
- package/dist/knowledge/references/saas.frontend.quick-switcher.scope-field.md +102 -0
- package/dist/knowledge/references/saas.frontend.related-resource-embeds.md +86 -0
- package/dist/knowledge/references/saas.frontend.related-resource-preview.md +23 -0
- package/dist/knowledge/references/saas.frontend.related-resource-sections.md +28 -0
- package/dist/knowledge/references/saas.frontend.resource-header-title.md +43 -0
- package/dist/knowledge/references/saas.frontend.resource-layout-templates.md +215 -0
- package/dist/knowledge/references/saas.frontend.resource-operation-frontend-config.md +531 -0
- package/dist/knowledge/references/saas.frontend.resource-ui-behavior-config.md +210 -0
- package/dist/knowledge/references/saas.frontend.resource-ui-behavior-preset-map.md +39 -0
- package/dist/knowledge/references/saas.frontend.settings-hub.engine-destinations.md +58 -0
- package/dist/knowledge/references/saas.frontend.settings-hub.placement.md +118 -0
- package/dist/knowledge/references/saas.frontend.view-definition-scope.md +42 -0
- package/dist/knowledge/references/saas.market.generation-agent.md +104 -0
- package/dist/knowledge/references/saas.models.core-resource-operation.md +86 -0
- package/dist/knowledge/references/saas.models.data-mode-read-list.md +395 -0
- package/dist/knowledge/references/saas.models.engine-capabilities.md +114 -0
- package/dist/knowledge/references/saas.models.error-type.md +45 -0
- package/dist/knowledge/references/saas.models.external-data-pipeline.md +162 -0
- package/dist/knowledge/references/saas.models.feature-limit-semantic.md +51 -0
- package/dist/knowledge/references/saas.models.flows-actors.agent-configuration.md +127 -0
- package/dist/knowledge/references/saas.models.flows-actors.agent-definition.md +115 -0
- package/dist/knowledge/references/saas.models.flows-actors.agent-invocation.md +52 -0
- package/dist/knowledge/references/saas.models.flows-actors.agent-prompt-spec.md +188 -0
- package/dist/knowledge/references/saas.models.http-api-binding.md +237 -0
- package/dist/knowledge/references/saas.models.navigation.layout.md +149 -0
- package/dist/knowledge/references/saas.models.organization-unit-narrowing-containment.md +22 -0
- package/dist/knowledge/references/saas.models.organization-unit-narrowing-declaration.md +42 -0
- package/dist/knowledge/references/saas.models.polymorphism.optout-business-key.md +62 -0
- package/dist/knowledge/references/saas.models.polymorphism.variant-definition.md +74 -0
- package/dist/knowledge/references/saas.models.provider-capabilities.md +97 -0
- package/dist/knowledge/references/saas.models.rate-limit-configuration.md +67 -0
- package/dist/knowledge/references/saas.models.relationship-handling-contract.md +30 -0
- package/dist/knowledge/references/saas.models.relationship-handling-settings.md +62 -0
- package/dist/knowledge/references/saas.models.relationship-nature-and-models.md +112 -0
- package/dist/knowledge/references/saas.models.resource-config.builder-parameters.md +431 -0
- package/dist/knowledge/references/saas.models.resource-config.forwarded-label.md +88 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-api-call.md +89 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-base.md +79 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-mcp-exposure.md +49 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-path.md +27 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-union.md +26 -0
- package/dist/knowledge/references/saas.models.resource-config.operation-variant-for-key.md +62 -0
- package/dist/knowledge/references/saas.models.resource-config.resource-configuration.md +124 -0
- package/dist/knowledge/references/saas.models.resource-config.resource-relationships-buckets.md +38 -0
- package/dist/knowledge/references/saas.models.resource-config.resources-registry.md +69 -0
- package/dist/knowledge/references/saas.models.resource-config.searchable-relation.md +89 -0
- package/dist/knowledge/references/saas.models.resource-config.system-access-policy.md +121 -0
- package/dist/knowledge/references/saas.models.resource-config.token-generation.md +145 -0
- package/dist/knowledge/references/saas.models.resource-field-identifier.md +25 -0
- package/dist/knowledge/references/saas.models.resource-operation-display-risk.md +77 -0
- package/dist/knowledge/references/saas.models.resource-operation-variant-runtime.md +58 -0
- package/dist/knowledge/references/saas.models.resource-primary-scope.md +36 -0
- package/dist/knowledge/references/saas.models.resource-relationship-access-scope.md +26 -0
- package/dist/knowledge/references/saas.models.resource-relationship-builder-parameters.md +100 -0
- package/dist/knowledge/references/saas.models.resource-relationship-cardinality.md +57 -0
- package/dist/knowledge/references/saas.models.resource-relationship-declaration.md +69 -0
- package/dist/knowledge/references/saas.models.resource-relationship-resolved-semantics.md +60 -0
- package/dist/knowledge/references/saas.models.resource-relationship-schema.md +172 -0
- package/dist/knowledge/references/saas.models.resource-server-instance.md +109 -0
- package/dist/knowledge/references/saas.models.resource-type.md +24 -0
- package/dist/knowledge/references/saas.models.schema-family-builder.md +242 -0
- package/dist/knowledge/references/saas.models.scope-membership.md +143 -0
- package/dist/knowledge/references/saas.models.shared-domain-module.md +36 -0
- package/dist/knowledge/references/saas.models.shared-saas-module.md +36 -0
- package/dist/knowledge/references/saas.public-runtime.contract.md +229 -0
- package/dist/knowledge/references/saas.rag.retrieval-bounds.md +106 -0
- package/dist/knowledge/references/saas.rag.retrieval-refusals.md +89 -0
- package/dist/knowledge/references/saas.rag.retrieval-request.md +130 -0
- package/dist/knowledge/references/saas.rag.retrieval-result.md +147 -0
- package/dist/knowledge/references/saas.rag.retrieval-scores.md +54 -0
- package/dist/knowledge/references/saas.specifications.application-document-fact-specification.contract.md +59 -0
- package/dist/knowledge/references/saas.specifications.application-document-publication.contract.md +74 -0
- package/dist/knowledge/references/saas.specifications.assurance-document-blueprint.contract.md +1158 -0
- package/dist/knowledge/references/saas.specifications.assurance-program.contract.md +2602 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.catalog-spec-shared.md +180 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.discriminated-union.md +138 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-aggregate-offer.md +46 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-aggregate-rating.md +47 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-article.md +49 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-blog-posting.md +62 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-breadcrumb-list.md +46 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-faq-page.md +51 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-offer.md +46 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-organization.md +48 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-product.md +59 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-review.md +46 -0
- package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-website.md +46 -0
- package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +530 -0
- package/dist/knowledge/references/saas.specifications.composite-view-specification.md +49 -0
- package/dist/knowledge/references/saas.specifications.error-message-specification.md +92 -0
- package/dist/knowledge/references/saas.specifications.family-specifications.md +109 -0
- package/dist/knowledge/references/saas.specifications.feature-specification.md +93 -0
- package/dist/knowledge/references/saas.specifications.frontend-component-spec-factory.md +113 -0
- package/dist/knowledge/references/saas.specifications.frontend-component-spec-model.md +366 -0
- package/dist/knowledge/references/saas.specifications.resource-frontend-configuration-aspect.md +41 -0
- package/dist/knowledge/references/saas.specifications.resource-operation-spec.md +1978 -0
- package/dist/knowledge/references/saas.specifications.resource-pdf-template-spec.md +58 -0
- package/dist/knowledge/references/saas.specifications.resource-spec-code-handling.md +49 -0
- package/dist/knowledge/references/saas.specifications.resource-spec-config.md +156 -0
- package/dist/knowledge/references/saas.specifications.resource-spec-factory.md +171 -0
- package/dist/knowledge/references/saas.specifications.resource-spec-frontend-config-type.md +54 -0
- package/dist/knowledge/references/saas.specifications.resource-spec-frontend-prose.md +171 -0
- package/dist/knowledge/references/saas.website.astro.bridge.md +262 -0
- package/dist/knowledge/references/saas.website.astro.head-renderer.md +271 -0
- package/dist/knowledge/references/saas.website.astro.headers-renderer.md +41 -0
- package/dist/knowledge/references/saas.website.astro.i18n-helper.md +121 -0
- package/dist/knowledge/references/saas.website.astro.label-key-collector.md +117 -0
- package/dist/knowledge/references/saas.website.astro.label-loader.md +377 -0
- package/dist/knowledge/references/saas.website.astro.llms-txt-server.md +46 -0
- package/dist/knowledge/references/saas.website.astro.pick-labels-for-page.md +90 -0
- package/dist/knowledge/references/saas.website.astro.robots-renderer.md +174 -0
- package/dist/knowledge/references/saas.website.astro.runtime-helper.md +187 -0
- package/dist/knowledge/references/saas.website.astro.site-context.md +141 -0
- package/dist/knowledge/references/saas.website.astro.sitemap-coverage.md +188 -0
- package/dist/knowledge/references/saas.website.astro.structured-data-renderer.md +174 -0
- package/dist/knowledge/references/saas.website.blog.bridge.md +396 -0
- package/dist/knowledge/references/saas.website.blog.collection-config.md +180 -0
- package/dist/knowledge/references/saas.website.blog.frontmatter.md +116 -0
- package/dist/knowledge/references/saas.website.blog.head-renderer.md +292 -0
- package/dist/knowledge/references/saas.website.blog.mdx-provider.md +100 -0
- package/dist/knowledge/references/saas.website.blog.post-renderer.md +291 -0
- package/dist/knowledge/references/saas.website.design-tokens.bundle.md +29 -0
- package/dist/knowledge/references/saas.website.design-tokens.colors.md +64 -0
- package/dist/knowledge/references/saas.website.design-tokens.radius.md +38 -0
- package/dist/knowledge/references/saas.website.factories.define-page-manifest.md +98 -0
- package/dist/knowledge/references/saas.website.factories.define-section.md +128 -0
- package/dist/knowledge/references/saas.website.label-keys.compose-helper.md +36 -0
- package/dist/knowledge/references/saas.website.label-keys.format.md +67 -0
- package/dist/knowledge/references/saas.website.label-pack.validator.md +206 -0
- package/dist/knowledge/references/saas.website.page-layout.component.md +217 -0
- package/dist/knowledge/references/saas.website.page-manifest.meta-label-keys.md +47 -0
- package/dist/knowledge/references/saas.website.page-manifest.route-path.md +49 -0
- package/dist/knowledge/references/saas.website.page-manifest.schema.md +186 -0
- package/dist/knowledge/references/saas.website.page-manifest.seo.md +46 -0
- package/dist/knowledge/references/saas.website.page.context.md +57 -0
- package/dist/knowledge/references/saas.website.primitives.button.md +123 -0
- package/dist/knowledge/references/saas.website.primitives.heading.md +103 -0
- package/dist/knowledge/references/saas.website.primitives.image.md +103 -0
- package/dist/knowledge/references/saas.website.primitives.internal-button.md +151 -0
- package/dist/knowledge/references/saas.website.primitives.internal-link.md +193 -0
- package/dist/knowledge/references/saas.website.primitives.link.md +78 -0
- package/dist/knowledge/references/saas.website.primitives.text.md +82 -0
- package/dist/knowledge/references/saas.website.refs.page.md +56 -0
- package/dist/knowledge/references/saas.website.refs.section.md +57 -0
- package/dist/knowledge/references/saas.website.root-config.navigation.md +37 -0
- package/dist/knowledge/references/saas.website.root-config.schema.md +192 -0
- package/dist/knowledge/references/saas.website.root-config.seo.md +98 -0
- package/dist/knowledge/references/saas.website.routing.localized-path.md +84 -0
- package/dist/knowledge/references/saas.website.runtime.context.md +174 -0
- package/dist/knowledge/references/saas.website.section.component.md +138 -0
- package/dist/knowledge/references/saas.website.section.context.md +63 -0
- package/dist/knowledge/references/saas.website.sections.category-enum.md +72 -0
- package/dist/knowledge/references/saas.website.sections.definition-schema.md +121 -0
- package/dist/knowledge/references/saas.website.seo.llms-txt-config.md +37 -0
- package/dist/knowledge/references/saas.website.seo.robots-config.md +106 -0
- package/dist/knowledge/references/saas.website.seo.sitemap-config.md +73 -0
- package/dist/knowledge/references/saas.website.structured-data.payload-shape.md +71 -0
- package/dist/knowledge/references/saas.website.use-label-by-key.hook.md +45 -0
- package/dist/knowledge/references/saas.website.use-label.hook.md +82 -0
- package/dist/knowledge/references/saas.website.use-page.hook.md +30 -0
- package/dist/knowledge/references/saas.website.use-runtime.hook.md +36 -0
- package/dist/knowledge/references/saas.website.use-section.hook.md +30 -0
- package/dist/knowledge/references/saas.website.use-tokens.hook.md +32 -0
- package/dist/knowledge/references/vision.authored-metadata.config.md +64 -0
- package/dist/knowledge/references/vision.constraint.config.md +66 -0
- package/dist/knowledge/references/vision.idea.config.md +45 -0
- package/dist/knowledge/references/vision.mission.config.md +46 -0
- package/dist/knowledge/references/vision.problem.config.md +51 -0
- package/dist/knowledge/references/vision.references.conventions.md +115 -0
- package/dist/knowledge/references/vision.snapshot.config.md +85 -0
- package/dist/knowledge/references/vision.snapshot.validation.md +226 -0
- package/dist/knowledge/references/vision.success-criterion.config.md +60 -0
- package/dist/knowledge/references/zod.decorators.chainable-runtime.md +550 -0
- package/dist/knowledge/references/zod.decorators.conditional-visibility.md +104 -0
- package/dist/knowledge/references/zod.decorators.data-categories.md +197 -0
- package/dist/knowledge/references/zod.decorators.decorator-vocabulary.md +436 -0
- package/dist/knowledge/references/zod.decorators.display-edit-modes.md +174 -0
- package/dist/knowledge/references/zod.decorators.enums.frontend-handling.md +101 -0
- package/dist/knowledge/references/zod.decorators.field-spec-params.md +317 -0
- package/dist/knowledge/references/zod.decorators.file-generation.md +36 -0
- package/dist/knowledge/references/zod.decorators.file-rag-source.md +56 -0
- package/dist/knowledge/references/zod.decorators.file-schema.md +319 -0
- package/dist/knowledge/references/zod.decorators.foreign-key-display-mode.md +83 -0
- package/dist/knowledge/references/zod.decorators.per-primitive-ui.md +459 -0
- package/dist/knowledge/references/zod.decorators.primitive-ui.md +123 -0
- package/dist/knowledge/references/zod.decorators.rag-source.md +164 -0
- package/dist/knowledge/references/zod.decorators.schema-metadata.md +122 -0
- package/dist/knowledge/references/zod.decorators.shared-structural-methods.md +152 -0
- package/dist/knowledge/references/zod.decorators.shared-structural-params.md +314 -0
- package/dist/knowledge/references/zod.decorators.structural-lifecycle-params.md +529 -0
- package/dist/knowledge/references/zod.factories.bigdecimal.md +155 -0
- package/dist/knowledge/references/zod.factories.code.md +127 -0
- package/dist/knowledge/references/zod.factories.duration.md +246 -0
- package/dist/knowledge/references/zod.factories.money.md +166 -0
- package/dist/knowledge/references/zod.factories.phone.md +88 -0
- package/dist/knowledge/references/zod.factories.range.md +174 -0
- package/dist/knowledge/registries/assurance-authority-bases.json +15 -0
- package/dist/knowledge/registries/framework-topics.json +5212 -0
- package/dist/knowledge/registries/playbooks.json +488 -0
- package/dist/knowledge/registries/source-tags.json +7664 -0
- package/dist/knowledge/rules/resource-schema-awareness.md +77 -0
- package/dist/knowledge/skills/INDEX.md +349 -0
- package/dist/knowledge/skills/application-consumer-documentation-authoring/SKILL.md +415 -0
- package/dist/knowledge/skills/application-consumer-documentation-authoring/examples/domain-use-case-and-admin-task.example.md +49 -0
- package/dist/knowledge/skills/application-consumer-documentation-authoring/references/source-and-ownership-routing.md +52 -0
- package/dist/knowledge/skills/application-database-migrations/SKILL.md +218 -0
- package/dist/knowledge/skills/application-database-migrations/references/framework-application-database-api.md +84 -0
- package/dist/knowledge/skills/application-database-migrations/references/framework-migration-change-risk-api.md +37 -0
- package/dist/knowledge/skills/application-database-migrations/references/migration-refusals.md +64 -0
- package/dist/knowledge/skills/application-database-migrations/references/postgresql-vs-mongodb-obligations.md +34 -0
- package/dist/knowledge/skills/authorization-unit-narrowing/SKILL.md +323 -0
- package/dist/knowledge/skills/authorization-unit-narrowing/references/framework-unit-narrowing-declaration-api.md +84 -0
- package/dist/knowledge/skills/backend-addon-wiring/SKILL.md +324 -0
- package/dist/knowledge/skills/backend-addon-wiring/references/backend-di-routing.md +7 -0
- package/dist/knowledge/skills/backend-addon-wiring/references/framework-backend-bootstrap-api.md +276 -0
- package/dist/knowledge/skills/backend-custom-operation/SKILL.md +374 -0
- package/dist/knowledge/skills/backend-custom-operation/references/framework-error-handling-api.md +118 -0
- package/dist/knowledge/skills/backend-custom-operation/references/framework-operation-base-and-path-api.md +107 -0
- package/dist/knowledge/skills/backend-custom-operation/references/framework-transactional-core-api.md +134 -0
- package/dist/knowledge/skills/backend-custom-operation/references/operation-file-conventions.md +10 -0
- package/dist/knowledge/skills/brand-logo-authoring/SKILL.md +192 -0
- package/dist/knowledge/skills/brand-logo-authoring/references/brand-authoring-decisions.md +55 -0
- package/dist/knowledge/skills/brand-logo-authoring/references/framework-brand-asset-api.md +184 -0
- package/dist/knowledge/skills/brand-logo-authoring/references/framework-brand-snapshot-api.md +279 -0
- package/dist/knowledge/skills/compliance-document-authoring/SKILL.md +346 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-governance.md +160 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-privacy-notice.md +518 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-service-terms.md +158 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-application-document-fact-specification-contract.md +95 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-application-document-publication-contract.md +100 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-assurance-document-blueprint-contract.md +1210 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/framework-governed-document-after-drafting.md +40 -0
- package/dist/knowledge/skills/config-app-shell/SKILL.md +698 -0
- package/dist/knowledge/skills/config-app-shell/references/app-shell-surfaces.md +5 -0
- package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-api.md +415 -0
- package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-hosted-components-api.md +170 -0
- package/dist/knowledge/skills/config-app-shell/references/framework-command-menu-omnibox-api.md +212 -0
- package/dist/knowledge/skills/config-app-shell/references/framework-quick-switcher-scope-field-api.md +178 -0
- package/dist/knowledge/skills/config-design-system/SKILL.md +424 -0
- package/dist/knowledge/skills/config-design-system/references/design-system-file.md +10 -0
- package/dist/knowledge/skills/config-design-system/references/framework-design-system-configuration-api.md +77 -0
- package/dist/knowledge/skills/config-design-system/references/framework-material-profile-api.md +200 -0
- package/dist/knowledge/skills/config-design-system/references/framework-material-runtime-policy-api.md +68 -0
- package/dist/knowledge/skills/config-design-system/references/framework-surface-policy-api.md +1212 -0
- package/dist/knowledge/skills/config-design-system/references/surface-policy-authoring.md +92 -0
- package/dist/knowledge/skills/config-navigation/SKILL.md +249 -0
- package/dist/knowledge/skills/config-navigation/references/framework-navigation-layout-api.md +152 -0
- package/dist/knowledge/skills/config-navigation/references/navigation-zones.md +5 -0
- package/dist/knowledge/skills/config-saas/SKILL.md +209 -0
- package/dist/knowledge/skills/config-saas/references/framework-provider-capabilities-api.md +221 -0
- package/dist/knowledge/skills/config-saas/references/framework-wildo-saas-config-api.md +408 -0
- package/dist/knowledge/skills/config-saas/references/saas-config-scope.md +9 -0
- package/dist/knowledge/skills/config-saas-backend/SKILL.md +183 -0
- package/dist/knowledge/skills/config-saas-backend/references/framework-backend-authored-config-api.md +40 -0
- package/dist/knowledge/skills/configure-billing/SKILL.md +261 -0
- package/dist/knowledge/skills/configure-billing/references/config-chain-and-failure-map.md +90 -0
- package/dist/knowledge/skills/configure-billing/references/example-backend-provider-module-shape.md +122 -0
- package/dist/knowledge/skills/configure-billing/references/example-provider-contribution-and-backend-config.md +48 -0
- package/dist/knowledge/skills/configure-billing/references/framework-backend-provider-reachability-api.md +69 -0
- package/dist/knowledge/skills/configure-billing/references/framework-billing-resolution-failure-api.md +57 -0
- package/dist/knowledge/skills/email-add-template/SKILL.md +439 -0
- package/dist/knowledge/skills/email-add-template/references/email-artifact-paths.md +9 -0
- package/dist/knowledge/skills/email-add-template/references/framework-email-template-api.md +72 -0
- package/dist/knowledge/skills/email-definition-wiring/SKILL.md +62 -0
- package/dist/knowledge/skills/email-labels-authoring/SKILL.md +64 -0
- package/dist/knowledge/skills/email-template-authoring/SKILL.md +62 -0
- package/dist/knowledge/skills/engine-component-registration/SKILL.md +257 -0
- package/dist/knowledge/skills/engine-component-registration/references/component-registration-file.md +7 -0
- package/dist/knowledge/skills/engine-component-registration/references/framework-component-registration-api.md +24 -0
- package/dist/knowledge/skills/engine-product-definitions/SKILL.md +429 -0
- package/dist/knowledge/skills/engine-product-definitions/references/framework-engine-product-definitions-api.md +287 -0
- package/dist/knowledge/skills/engine-product-definitions/references/product-registry-scope.md +5 -0
- package/dist/knowledge/skills/flows-actors-a2a-exposure/SKILL.md +491 -0
- package/dist/knowledge/skills/flows-actors-a2a-exposure/references/framework-flows-actors-a2a-contract.md +227 -0
- package/dist/knowledge/skills/flows-actors-a2a-exposure/references/framework-named-a2a-agents-contract.md +143 -0
- package/dist/knowledge/skills/flows-actors-chat-assistant/SKILL.md +368 -0
- package/dist/knowledge/skills/flows-actors-chat-assistant/examples/todo-assistant.example.md +226 -0
- package/dist/knowledge/skills/flows-actors-chat-assistant/references/framework-flows-actors-tool-api.md +208 -0
- package/dist/knowledge/skills/flows-actors-chat-assistant/references/framework-flows-actors-view-api.md +286 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/SKILL.md +376 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-definition-api.md +262 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-invocation-api.md +130 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-prompt-spec-api.md +214 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-operation-and-model-api.md +195 -0
- package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/operation-key-selection.md +60 -0
- package/dist/knowledge/skills/frontend-cdn-publish/SKILL.md +237 -0
- package/dist/knowledge/skills/frontend-cdn-publish/references/cloudflare-and-operator-setup.md +56 -0
- package/dist/knowledge/skills/frontend-cdn-publish/references/framework-cdn-config-api.md +176 -0
- package/dist/knowledge/skills/i18n-label-generation/SKILL.md +261 -0
- package/dist/knowledge/skills/i18n-label-generation/references/framework-labelling-sections-api.md +67 -0
- package/dist/knowledge/skills/i18n-label-generation/references/label-placement.md +7 -0
- package/dist/knowledge/skills/i18n-rerun-pipeline/SKILL.md +269 -0
- package/dist/knowledge/skills/i18n-rerun-pipeline/references/framework-labelling-sections-api.md +67 -0
- package/dist/knowledge/skills/i18n-rerun-pipeline/references/i18n-routing.md +9 -0
- package/dist/knowledge/skills/i18n-translation-rerun/SKILL.md +245 -0
- package/dist/knowledge/skills/i18n-translation-rerun/references/framework-labelling-sections-api.md +67 -0
- package/dist/knowledge/skills/i18n-translation-rerun/references/translation-workflow.md +17 -0
- package/dist/knowledge/skills/infra-environment-config/SKILL.md +646 -0
- package/dist/knowledge/skills/infra-environment-config/references/framework-application-database-api.md +77 -0
- package/dist/knowledge/skills/infra-environment-config/references/framework-backing-services-api.md +282 -0
- package/dist/knowledge/skills/infra-environment-config/references/framework-environment-deployment-api.md +265 -0
- package/dist/knowledge/skills/infra-environment-config/references/infra-config-files.md +7 -0
- package/dist/knowledge/skills/journey-approve/SKILL.md +43 -0
- package/dist/knowledge/skills/journey-bootstrap-scope/SKILL.md +42 -0
- package/dist/knowledge/skills/journey-next/SKILL.md +42 -0
- package/dist/knowledge/skills/journey-report/SKILL.md +43 -0
- package/dist/knowledge/skills/journey-run/SKILL.md +55 -0
- package/dist/knowledge/skills/journey-status/SKILL.md +50 -0
- package/dist/knowledge/skills/local-environment-bootstrap/SKILL.md +370 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/initialization-recovery-recipe.md +50 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/local-environment-troubleshooting.md +409 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/wildo-cli-bootstrap-commands.md +247 -0
- package/dist/knowledge/skills/market-add-feature-benefit/SKILL.md +474 -0
- package/dist/knowledge/skills/market-add-feature-benefit/references/framework-feature-benefit-api.md +139 -0
- package/dist/knowledge/skills/market-alternatives/SKILL.md +543 -0
- package/dist/knowledge/skills/market-authoring-overview/SKILL.md +354 -0
- package/dist/knowledge/skills/market-authoring-overview/references/framework-market-references-api.md +138 -0
- package/dist/knowledge/skills/market-authoring-overview/references/framework-market-snapshot-api.md +129 -0
- package/dist/knowledge/skills/market-category/SKILL.md +290 -0
- package/dist/knowledge/skills/market-channels/SKILL.md +361 -0
- package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +2752 -0
- package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +2443 -0
- package/dist/knowledge/skills/market-generation-cli/SKILL.md +1484 -0
- package/dist/knowledge/skills/market-generation-cli/references/framework-market-generation-cli.md +1230 -0
- package/dist/knowledge/skills/market-icp/SKILL.md +625 -0
- package/dist/knowledge/skills/market-jobs-pains-gains/SKILL.md +352 -0
- package/dist/knowledge/skills/market-message-templates-authoring/SKILL.md +415 -0
- package/dist/knowledge/skills/market-message-templates-authoring/references/framework-message-template-api.md +1439 -0
- package/dist/knowledge/skills/market-persona/SKILL.md +407 -0
- package/dist/knowledge/skills/market-positioning-authoring/SKILL.md +392 -0
- package/dist/knowledge/skills/market-positioning-authoring/references/framework-positioning-api.md +97 -0
- package/dist/knowledge/skills/market-proof-and-objection/SKILL.md +665 -0
- package/dist/knowledge/skills/market-scoring-interpretation/SKILL.md +620 -0
- package/dist/knowledge/skills/market-scoring-interpretation/references/framework-scoring-api.md +291 -0
- package/dist/knowledge/skills/market-snapshot-validation/SKILL.md +1706 -0
- package/dist/knowledge/skills/market-snapshot-validation/references/framework-snapshot-validation-api.md +1228 -0
- package/dist/knowledge/skills/market-tone-of-voice/SKILL.md +260 -0
- package/dist/knowledge/skills/market-triggers-and-journey/SKILL.md +579 -0
- package/dist/knowledge/skills/module-companion-exports/SKILL.md +318 -0
- package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +544 -0
- package/dist/knowledge/skills/module-registration/SKILL.md +212 -0
- package/dist/knowledge/skills/module-registration/references/framework-domain-modules-api.md +366 -0
- package/dist/knowledge/skills/module-registration/references/registry-files.md +9 -0
- package/dist/knowledge/skills/module-relationships/SKILL.md +523 -0
- package/dist/knowledge/skills/module-relationships/references/cross-resource-fk-checklist.md +7 -0
- package/dist/knowledge/skills/module-relationships/references/framework-resource-relationship-authoring-api.md +738 -0
- package/dist/knowledge/skills/pdf-template-authoring/SKILL.md +174 -0
- package/dist/knowledge/skills/pdf-template-authoring/references/framework-pdf-template-api.md +203 -0
- package/dist/knowledge/skills/pdf-template-authoring/references/framework-pdf-template-spec-api.md +62 -0
- package/dist/knowledge/skills/provider-frontend-file-picker/SKILL.md +239 -0
- package/dist/knowledge/skills/provider-frontend-file-picker/references/framework-file-provider-constraints-api.md +90 -0
- package/dist/knowledge/skills/provider-frontend-file-picker/references/framework-frontend-provider-module-api.md +50 -0
- package/dist/knowledge/skills/rate-limit-authoring/SKILL.md +652 -0
- package/dist/knowledge/skills/rate-limit-authoring/references/framework-rate-limit-policy-api.md +182 -0
- package/dist/knowledge/skills/rate-limit-authoring/references/scope-key-and-bucket-conventions.md +137 -0
- package/dist/knowledge/skills/resource-add-field/SKILL.md +272 -0
- package/dist/knowledge/skills/resource-add-field/examples/add-priority-field-to-todos.example.md +153 -0
- package/dist/knowledge/skills/resource-add-field/references/framework-field-cross-layer-api.md +845 -0
- package/dist/knowledge/skills/resource-add-module/SKILL.md +322 -0
- package/dist/knowledge/skills/resource-add-module/references/framework-new-module-wiring-api.md +67 -0
- package/dist/knowledge/skills/resource-add-module/references/module-scaffold-layout.md +15 -0
- package/dist/knowledge/skills/resource-add-resource/SKILL.md +222 -0
- package/dist/knowledge/skills/resource-add-resource/references/framework-new-resource-core-config-api.md +540 -0
- package/dist/knowledge/skills/resource-add-resource/references/scaffold-surfaces-checklist.md +25 -0
- package/dist/knowledge/skills/resource-config-wiring/SKILL.md +370 -0
- package/dist/knowledge/skills/resource-config-wiring/references/config-change-routing.md +11 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-personal-data-declaration-api.md +622 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-operation-scope-enums-api.md +248 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-resource-config-api.md +1769 -0
- package/dist/knowledge/skills/resource-config-wiring/references/framework-system-access-reads-api.md +1209 -0
- package/dist/knowledge/skills/resource-custom-view/SKILL.md +228 -0
- package/dist/knowledge/skills/resource-custom-view/references/custom-view-contracts.md +693 -0
- package/dist/knowledge/skills/resource-external-data/SKILL.md +349 -0
- package/dist/knowledge/skills/resource-external-data/references/framework-external-data-pipeline-api.md +187 -0
- package/dist/knowledge/skills/resource-external-data/references/framework-http-api-binding-api.md +261 -0
- package/dist/knowledge/skills/resource-external-data/references/lane-selection.md +49 -0
- package/dist/knowledge/skills/resource-external-data/references/pipeline-destination-schema.md +43 -0
- package/dist/knowledge/skills/resource-mcp-tool-exposure/SKILL.md +308 -0
- package/dist/knowledge/skills/resource-mcp-tool-exposure/references/framework-named-mcp-servers-contract.md +166 -0
- package/dist/knowledge/skills/resource-mcp-tool-exposure/references/framework-resource-mcp-exposure-contract.md +63 -0
- package/dist/knowledge/skills/resource-mcp-tool-exposure/references/mcp-catalogue-withdrawal-and-verification.md +77 -0
- package/dist/knowledge/skills/resource-mcp-tool-exposure/references/mcp-client-registration-postures.md +90 -0
- package/dist/knowledge/skills/resource-rag-source-fields/SKILL.md +424 -0
- package/dist/knowledge/skills/resource-rag-source-fields/references/corpus-field-selection.md +90 -0
- package/dist/knowledge/skills/resource-rag-source-fields/references/framework-embeddings-capability-api.md +261 -0
- package/dist/knowledge/skills/resource-rag-source-fields/references/framework-file-rag-source-api.md +117 -0
- package/dist/knowledge/skills/resource-rag-source-fields/references/framework-rag-retrieval-api.md +597 -0
- package/dist/knowledge/skills/resource-rag-source-fields/references/framework-rag-source-decorator-api.md +181 -0
- package/dist/knowledge/skills/resource-schema-authoring/SKILL.md +318 -0
- package/dist/knowledge/skills/resource-schema-authoring/examples/add-enum-field-with-ui.example.md +132 -0
- package/dist/knowledge/skills/resource-schema-authoring/examples/basic-resource-schema.example.md +62 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/decorator-layer-map.md +63 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/field-type-selection.md +70 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-decorator-vocabulary-api.md +559 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-personal-data-category-api.md +245 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-polymorphic-resources-api.md +147 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-schema-family-api.md +247 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-shared-decorator-methods-api.md +164 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-shared-structural-params-api.md +327 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-special-factories-api.md +1286 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/framework-zod-lifecycle-and-chainable-api.md +1080 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/polymorphic-per-scope-resources.md +75 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/schema-variants-and-discriminators.md +62 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/shared-layer-decorator-checklist.md +69 -0
- package/dist/knowledge/skills/resource-schema-authoring/references/special-factories.md +45 -0
- package/dist/knowledge/skills/resource-ui-behavior/SKILL.md +389 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-conditional-visibility-api.md +106 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-display-edit-modes-api.md +176 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-enum-frontend-handling-api.md +103 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-foreign-key-ui-api.md +97 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-frontend-resource-ui-contracts-api.md +839 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-per-primitive-ui-api.md +461 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-primitive-ui-api.md +125 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-related-resource-embeds-api.md +245 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/framework-resource-layout-templates-api.md +302 -0
- package/dist/knowledge/skills/resource-ui-behavior/references/ui-layer-boundaries.md +13 -0
- package/dist/knowledge/skills/seeding-authoring/SKILL.md +569 -0
- package/dist/knowledge/skills/seeding-authoring/references/data-seeding-mode-picker.md +154 -0
- package/dist/knowledge/skills/seeding-authoring/references/framework-data-seeding-api.md +176 -0
- package/dist/knowledge/skills/seeding-operations/SKILL.md +505 -0
- package/dist/knowledge/skills/seeding-operations/references/data-seeding-admin-runbook.md +337 -0
- package/dist/knowledge/skills/seeding-operations/references/data-seeding-cron-scheduler.md +171 -0
- package/dist/knowledge/skills/seeding-operations/references/framework-data-seeding-operations-api.md +662 -0
- package/dist/knowledge/skills/settings-placement-authoring/SKILL.md +134 -0
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-destinations-catalog.md +65 -0
- package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-placement-api.md +127 -0
- package/dist/knowledge/skills/spec-catalog-authoring/SKILL.md +726 -0
- package/dist/knowledge/skills/spec-catalog-authoring/references/catalog-spec-pattern-overview.md +242 -0
- package/dist/knowledge/skills/spec-companion-exports/SKILL.md +362 -0
- package/dist/knowledge/skills/spec-companion-exports/references/companion-export-checklist.md +8 -0
- package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +533 -0
- package/dist/knowledge/skills/spec-component-update/SKILL.md +315 -0
- package/dist/knowledge/skills/spec-component-update/references/component-spec-props.md +8 -0
- package/dist/knowledge/skills/spec-component-update/references/framework-frontend-component-spec-api.md +481 -0
- package/dist/knowledge/skills/spec-composite-view-update/SKILL.md +283 -0
- package/dist/knowledge/skills/spec-composite-view-update/references/composite-spec-sections.md +5 -0
- package/dist/knowledge/skills/spec-composite-view-update/references/framework-composite-view-specification-api.md +51 -0
- package/dist/knowledge/skills/spec-family-update/SKILL.md +300 -0
- package/dist/knowledge/skills/spec-family-update/references/family-spec-routing.md +13 -0
- package/dist/knowledge/skills/spec-family-update/references/framework-error-message-specifications-api.md +108 -0
- package/dist/knowledge/skills/spec-family-update/references/framework-family-specifications-api.md +111 -0
- package/dist/knowledge/skills/spec-feature-update/SKILL.md +306 -0
- package/dist/knowledge/skills/spec-feature-update/references/feature-spec-scope.md +5 -0
- package/dist/knowledge/skills/spec-feature-update/references/framework-feature-specification-api.md +95 -0
- package/dist/knowledge/skills/spec-resource-update/SKILL.md +220 -0
- package/dist/knowledge/skills/spec-resource-update/references/framework-field-spec-params-api.md +319 -0
- package/dist/knowledge/skills/spec-resource-update/references/framework-spec-resource-contracts-api.md +2610 -0
- package/dist/knowledge/skills/spec-resource-update/references/resource-spec-field-routing.md +12 -0
- package/dist/knowledge/skills/spec-update-after-change/SKILL.md +195 -0
- package/dist/knowledge/skills/spec-update-after-change/references/framework-spec-factory-api.md +173 -0
- package/dist/knowledge/skills/spec-update-after-change/references/spec-maintenance-by-surface.md +33 -0
- package/dist/knowledge/skills/spec-update-after-change/references/surface-to-spec-routing.md +14 -0
- package/dist/knowledge/skills/views-add-composite-view/SKILL.md +259 -0
- package/dist/knowledge/skills/views-add-composite-view/references/composite-view-routing.md +10 -0
- package/dist/knowledge/skills/views-add-composite-view/references/framework-inserted-view-identity-api.md +151 -0
- package/dist/knowledge/skills/views-add-custom-view/SKILL.md +225 -0
- package/dist/knowledge/skills/views-add-custom-view/references/custom-view-routing.md +10 -0
- package/dist/knowledge/skills/views-add-custom-view/references/framework-view-scope-and-full-custom-api.md +107 -0
- package/dist/knowledge/skills/views-app-level/SKILL.md +201 -0
- package/dist/knowledge/skills/views-app-level/references/app-level-views-routing.md +9 -0
- package/dist/knowledge/skills/views-app-level/references/framework-view-scope-and-full-custom-api.md +107 -0
- package/dist/knowledge/skills/views-chart-authoring/SKILL.md +264 -0
- package/dist/knowledge/skills/views-chart-authoring/references/chart-view-checklist.md +7 -0
- package/dist/knowledge/skills/views-chart-authoring/references/framework-chart-view-contracts-api.md +82 -0
- package/dist/knowledge/skills/views-chart-authoring/references/framework-inserted-view-identity-api.md +152 -0
- package/dist/knowledge/skills/views-composite-authoring/SKILL.md +302 -0
- package/dist/knowledge/skills/views-composite-authoring/references/composite-embedding-checklist.md +23 -0
- package/dist/knowledge/skills/views-composite-authoring/references/framework-composite-view-contracts-api.md +133 -0
- package/dist/knowledge/skills/views-composite-authoring/references/framework-inserted-view-identity-api.md +152 -0
- package/dist/knowledge/skills/views-execution-authoring/SKILL.md +209 -0
- package/dist/knowledge/skills/views-execution-authoring/references/execution-view-checklist.md +7 -0
- package/dist/knowledge/skills/views-execution-authoring/references/framework-execution-view-contracts-api.md +389 -0
- package/dist/knowledge/skills/views-execution-authoring/references/framework-inserted-view-identity-api.md +152 -0
- package/dist/knowledge/skills/website-anonymous-session/SKILL.md +444 -0
- package/dist/knowledge/skills/website-blog-authoring/SKILL.md +587 -0
- package/dist/knowledge/skills/website-blog-authoring/references/blog-adapter-api.md +1426 -0
- package/dist/knowledge/skills/website-bundle-discipline/SKILL.md +553 -0
- package/dist/knowledge/skills/website-bundle-discipline/references/example-website-button-override.md +52 -0
- package/dist/knowledge/skills/website-bundle-discipline/references/website-bundle-rules.md +357 -0
- package/dist/knowledge/skills/website-consent-gate-overrides/SKILL.md +511 -0
- package/dist/knowledge/skills/website-factory-advanced/SKILL.md +376 -0
- package/dist/knowledge/skills/website-inbound-contact-forms/SKILL.md +304 -0
- package/dist/knowledge/skills/website-label-pack/SKILL.md +390 -0
- package/dist/knowledge/skills/website-layout-overrides/SKILL.md +461 -0
- package/dist/knowledge/skills/website-marketing-metadata-extension/SKILL.md +264 -0
- package/dist/knowledge/skills/website-navigation-authoring/SKILL.md +414 -0
- package/dist/knowledge/skills/website-navigation-authoring/references/worked-examples-header-footer.md +366 -0
- package/dist/knowledge/skills/website-page-authoring/SKILL.md +420 -0
- package/dist/knowledge/skills/website-page-variants/SKILL.md +256 -0
- package/dist/knowledge/skills/website-primitive-overrides/SKILL.md +302 -0
- package/dist/knowledge/skills/website-section-contact/SKILL.md +950 -0
- package/dist/knowledge/skills/website-section-contact/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-cta/SKILL.md +822 -0
- package/dist/knowledge/skills/website-section-cta/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-faq/SKILL.md +917 -0
- package/dist/knowledge/skills/website-section-faq/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-feature-benefit-summary/SKILL.md +878 -0
- package/dist/knowledge/skills/website-section-feature-benefit-summary/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-feature-detail/SKILL.md +895 -0
- package/dist/knowledge/skills/website-section-feature-detail/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-footer-cta/SKILL.md +814 -0
- package/dist/knowledge/skills/website-section-footer-cta/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-hero/SKILL.md +944 -0
- package/dist/knowledge/skills/website-section-hero/references/define-website-section-api.md +583 -0
- package/dist/knowledge/skills/website-section-pricing/SKILL.md +934 -0
- package/dist/knowledge/skills/website-section-pricing/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-section-social-proof/SKILL.md +912 -0
- package/dist/knowledge/skills/website-section-social-proof/references/define-website-section-api.md +579 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/SKILL.md +624 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/references/aeo-api.md +633 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/references/geo-api.md +193 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/references/seo-api.md +790 -0
- package/dist/knowledge/topic-index.json +17510 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +49 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# How an agent client gets a `client_id` for your MCP server
|
|
2
|
+
|
|
3
|
+
Read this when an agent cannot connect at all, when you are asked to support a third-party MCP
|
|
4
|
+
client you have no prior relationship with, or when you are deciding what to turn on in
|
|
5
|
+
`backend-api/src/saas-config.backend.ts` under `auth`.
|
|
6
|
+
|
|
7
|
+
Exposing a tool is not enough for a stranger's agent to call it. The agent needs an OAuth client
|
|
8
|
+
identity first, and your application decides which ways of getting one it accepts. **Both mechanisms
|
|
9
|
+
below are OFF by default**, so a brand-new application accepts only clients you registered yourself.
|
|
10
|
+
|
|
11
|
+
## The three ways, in the order a conformant client tries them
|
|
12
|
+
|
|
13
|
+
1. **Pre-registered** — you created the OAuth client and handed over its id. Always available, no
|
|
14
|
+
configuration. Correct when you know the integrator.
|
|
15
|
+
2. **Client ID Metadata Document (CIMD)** — the agent's `client_id` IS an `https://` URL it controls,
|
|
16
|
+
serving a JSON document that describes it. Your server fetches that URL. Nothing is registered
|
|
17
|
+
ahead of time, which is why it suits an agent that has never met your server.
|
|
18
|
+
3. **Dynamic Client Registration (DCR)** — the agent POSTs its own metadata to `/oauth/register` and
|
|
19
|
+
receives a `client_id` back.
|
|
20
|
+
|
|
21
|
+
A client picks the first one it can use, and it learns what you support from your discovery
|
|
22
|
+
document. **That is why enabling has to be deliberate:** if your server advertised a mechanism it
|
|
23
|
+
then refused, a conformant client would spend that rung of its fallback order and could end up
|
|
24
|
+
prompting a human for credentials instead of trying the next option. Your application advertises
|
|
25
|
+
each one only when it is actually enabled.
|
|
26
|
+
|
|
27
|
+
## Choosing a posture
|
|
28
|
+
|
|
29
|
+
| You want | Set |
|
|
30
|
+
|---|---|
|
|
31
|
+
| Only integrators you personally onboarded | nothing — the default |
|
|
32
|
+
| A known set of agent vendors, no strangers | `auth.cimd.policy: ALLOWLIST` + `allowedClients` |
|
|
33
|
+
| Any agent on the public internet | `auth.cimd.policy: OPEN` |
|
|
34
|
+
| Interoperability with clients that only speak DCR | `auth.dynamicClientRegistration.enabled: true` |
|
|
35
|
+
|
|
36
|
+
An allow-list entry may be a **full `client_id` URL** (exact — the stricter and usually correct
|
|
37
|
+
grain) or a **bare host** (every client on that domain). Prefer the URL form when the domain might
|
|
38
|
+
host more than one vendor's metadata: a host entry admits all of them.
|
|
39
|
+
|
|
40
|
+
## What a self-registered client can and cannot do
|
|
41
|
+
|
|
42
|
+
This matters most, because it is the part people assume wrongly. A client that arrived through CIMD
|
|
43
|
+
or DCR proved that it controls a domain, or that it can send an HTTP request. Nobody vouched for it.
|
|
44
|
+
Your application therefore confines it, and **you cannot widen this from configuration**:
|
|
45
|
+
|
|
46
|
+
- **No roles, ever.** Roles are the single authorization axis. A registration request that asks for
|
|
47
|
+
roles is REFUSED, not quietly downgraded — a client that believed it held authority it does not
|
|
48
|
+
have would fail later in a way neither side could diagnose.
|
|
49
|
+
- **Identity scopes only** (`openid` / `profile` / `email`). These authorize nothing; they describe
|
|
50
|
+
the user. The client cannot ask for more, because the ceiling would otherwise be written by the
|
|
51
|
+
party it constrains.
|
|
52
|
+
- **The user ALWAYS sees the consent screen.** A registered first-party client can be marked
|
|
53
|
+
consent-free; an unaffiliated one cannot, whatever its own metadata says. Letting it opt out would
|
|
54
|
+
be self-certification by exactly the party being trusted.
|
|
55
|
+
- **It acts only FOR a consenting user**, never as itself — the `client_credentials` machine grant
|
|
56
|
+
is refused.
|
|
57
|
+
|
|
58
|
+
So the honest summary for an app builder: turning these on lets strangers *ask your users* for
|
|
59
|
+
delegated access. It does not give them any standing of their own.
|
|
60
|
+
|
|
61
|
+
## What your consent screen must show for one of these clients
|
|
62
|
+
|
|
63
|
+
The authorize response carries three fields for this, and they exist because display IS the
|
|
64
|
+
mitigation for an attack the mechanism cannot prevent on its own — an attacker can present a
|
|
65
|
+
legitimate client's metadata URL and bind a `localhost` port, so the user sees a name they trust:
|
|
66
|
+
|
|
67
|
+
- `client.origin` — how the identity was established.
|
|
68
|
+
- `client.redirect_uri_hostname` — **must be displayed**; it is where the user is actually being sent.
|
|
69
|
+
- `client.loopback_only_redirects` — show an additional warning when true.
|
|
70
|
+
|
|
71
|
+
A consent screen that shows only the client NAME is exactly the screen this attack defeats.
|
|
72
|
+
|
|
73
|
+
## If an agent cannot connect
|
|
74
|
+
|
|
75
|
+
Work down this list; the first two are almost always the answer.
|
|
76
|
+
|
|
77
|
+
1. **Read your own discovery document** —
|
|
78
|
+
`GET /.well-known/oauth-authorization-server`. If `client_id_metadata_document_supported` and
|
|
79
|
+
`registration_endpoint` are both absent, your application has not opted in and the agent has no
|
|
80
|
+
way to register. That is the expected default, not a bug.
|
|
81
|
+
2. **Check the posture you authored** matches what you expect (`ALLOWLIST` admits only what it names).
|
|
82
|
+
3. **A CIMD `client_id` must be an `https://` URL WITH A PATH** and no fragment, and the document it
|
|
83
|
+
serves must name that exact URL as its own `client_id`. A bare origin is refused deliberately, so
|
|
84
|
+
one compromised host cannot claim to be every client on it.
|
|
85
|
+
4. **A URL that resolves to a private, loopback or link-local address is refused**, whatever your
|
|
86
|
+
allow-list says. This is an SSRF control and it is not configurable — an unauthenticated stranger
|
|
87
|
+
must not be able to make your server fetch an address only your server can reach.
|
|
88
|
+
5. **A document declaring a shared-secret `token_endpoint_auth_method` is refused.** These clients
|
|
89
|
+
are public and authenticate with PKCE; a secret would have to be arranged out of band, which
|
|
90
|
+
defeats the point of the mechanism.
|
|
@@ -0,0 +1,424 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: resource-rag-source-fields
|
|
3
|
+
description: Declare which resource fields feed the application's retrieval corpus with the `.ragSource()` decorator, choose their chunking, wire the embeddings capability, and query that corpus from a flow, actor or agent tool. Use when the user says "make this searchable by AI", "add RAG over our documents", "let the assistant answer from the knowledge base", "index the article body for retrieval", "make uploaded PDFs searchable", "make scanned documents searchable", "add OCR", "read text out of scans", "set up embeddings", "retrieve context for the prompt", "query the knowledge base from my agent", or asks which fields an assistant should be able to quote.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# RAG Source Fields — Workflow
|
|
7
|
+
|
|
8
|
+
### Target Application Framing
|
|
9
|
+
|
|
10
|
+
This knowledge is for configuring behavior in the target application.
|
|
11
|
+
Wildo is the framework surface being used, not the product being built.
|
|
12
|
+
|
|
13
|
+
Read and apply these patterns from the application-developer point of view:
|
|
14
|
+
|
|
15
|
+
- how the application should configure the relevant app-level file
|
|
16
|
+
- how the application should use framework-provided factories, enums, and helpers
|
|
17
|
+
- how the application should avoid mixing frontend, backend, and infrastructure concerns
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Overview
|
|
21
|
+
|
|
22
|
+
Retrieval in Wildo is a **property of resource fields**, not a pipeline beside them. You declare
|
|
23
|
+
`.ragSource()` on the fields whose text should be answerable, and the framework derives, maintains,
|
|
24
|
+
erases and re-indexes the chunk corpus from the live rows.
|
|
25
|
+
|
|
26
|
+
That framing is the whole skill. The corpus is a **derived tier** — it has no resource of its own,
|
|
27
|
+
no table you author, and no lifecycle you wire. Your job is the decision the framework cannot make:
|
|
28
|
+
which fields a generated answer should be allowed to quote, and how their text should be split.
|
|
29
|
+
|
|
30
|
+
The skill covers both halves of that one decision — **declaring** the corpus (steps 1–6) and
|
|
31
|
+
**consuming** it (step 7) — because they share a single framing: the framework owns the corpus's
|
|
32
|
+
lifecycle *and* its access boundary. You write no maintenance code when you declare, and no access
|
|
33
|
+
check when you query. Read the half you need; they are sequential, not simultaneous.
|
|
34
|
+
|
|
35
|
+
## App Paths
|
|
36
|
+
|
|
37
|
+
| Surface | Glob (relative to app root) |
|
|
38
|
+
|---|---|
|
|
39
|
+
| Resource schemas — where `.ragSource()` is declared | `shared-lib/src/modules/*/resources/*/*.schemas.ts` |
|
|
40
|
+
| Resources config — where a resource's persistence adapter is declared | `shared-lib/src/modules/*/resources/*/*.resources-config.ts` |
|
|
41
|
+
| Capability + provider selection | `wildo.saas.config.ts` |
|
|
42
|
+
| Application database engine, per environment | `infrastructure/*/wildo.infra.*.config.ts` |
|
|
43
|
+
| Specification — the business meaning of a corpus field | `specifications/src/modules/*/resources/*.resource.specification.ts` |
|
|
44
|
+
| Where retrieval is CONSUMED — flows, actors, agent tools | `backend-api/src/modules/*/index.ts` (the module's `flowsActors`) |
|
|
45
|
+
| Where retrieval is CONSUMED — custom operations | `backend-api/src/modules/*/resources/*/*.operation.ts` |
|
|
46
|
+
|
|
47
|
+
## When to Use
|
|
48
|
+
|
|
49
|
+
- A user asks for search, an assistant, or Q&A over content the application already stores
|
|
50
|
+
- Deciding whether a specific field belongs in the retrieval corpus
|
|
51
|
+
- Choosing or changing a field's chunking strategy or size
|
|
52
|
+
- Making uploaded documents answerable
|
|
53
|
+
- Wiring (or deliberately not wiring) the embeddings provider
|
|
54
|
+
- Writing the code that **queries** the corpus for grounding context — step 7
|
|
55
|
+
- Reading a retrieval result: its relevance scores, its refusals, or its truncation report
|
|
56
|
+
|
|
57
|
+
## When NOT to Use
|
|
58
|
+
|
|
59
|
+
- Ordinary field addition with no retrieval intent → use `resource-add-field`
|
|
60
|
+
- Editing a schema's shape, decorators or variants generally → use `resource-schema-authoring`
|
|
61
|
+
- Selecting providers or capabilities across the whole application → use `config-saas`
|
|
62
|
+
- Building an assistant that consumes retrieved context → use `flows-actors-chat-assistant`
|
|
63
|
+
|
|
64
|
+
## Workflow
|
|
65
|
+
|
|
66
|
+
### Step 1: Confirm the resource can hold a corpus — before authoring anything
|
|
67
|
+
|
|
68
|
+
Chunk storage follows the resource's **own persistence adapter**. Today that must resolve to
|
|
69
|
+
**PostgreSQL**, with the vector extension available on the application's database.
|
|
70
|
+
|
|
71
|
+
- A resource that resolves to PostgreSQL is fine. Nothing to configure — the framework provisions
|
|
72
|
+
the chunk storage and its indexes.
|
|
73
|
+
- A resource that resolves to **MongoDB refuses to boot the application**, by name, pointing at the
|
|
74
|
+
tracking issue for the MongoDB chunk store. This is fail-closed on purpose: an application that
|
|
75
|
+
writes chunks it cannot later reach could not honour a subject erasure, and refusing to start is
|
|
76
|
+
the only posture under which that dead end cannot accumulate silently.
|
|
77
|
+
|
|
78
|
+
The adapter comes from the resource's own `persistenceAdapter` declaration if it has one, otherwise
|
|
79
|
+
from the application database engine in the environment config. Check it now — discovering it after
|
|
80
|
+
authoring means a startup failure instead of a decision.
|
|
81
|
+
|
|
82
|
+
**On a MongoDB application, the corpus resource declares BOTH — one without the other does not
|
|
83
|
+
boot.** An application is wholly one adapter by default, because two adapters cannot share a native
|
|
84
|
+
transaction. So `persistenceAdapter` alone is refused at registration; it is admitted only when the
|
|
85
|
+
resource also declares `persistenceAdapterIsolation`, a named claim that this resource takes part in
|
|
86
|
+
no cross-resource atomic write:
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
persistenceAdapter: PersistenceAdapter.POSTGRESQL,
|
|
90
|
+
persistenceAdapterIsolation: ResourcePersistenceAdapterIsolation.NO_CROSS_ADAPTER_TRANSACTION,
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
A retrieval corpus normally qualifies — it is created, published and read on its own, and its chunk
|
|
94
|
+
tier lives in the same adapter it does. Make the claim only if it is TRUE of the resource's design,
|
|
95
|
+
not merely of today's call sites: it is not a flag that silences the error. If an operation later
|
|
96
|
+
commits this resource beside one on the other adapter, the persistence unit of work still refuses
|
|
97
|
+
that boundary at runtime, so a false claim fails loudly rather than degrading silently.
|
|
98
|
+
|
|
99
|
+
### Step 2: Decide which fields belong in the corpus
|
|
100
|
+
|
|
101
|
+
Ask of each candidate field: *if the system answered a question by quoting this field verbatim,
|
|
102
|
+
would that be correct, useful, and safe?*
|
|
103
|
+
|
|
104
|
+
Load `references/corpus-field-selection.md` for the decision table, the five combinations the
|
|
105
|
+
framework refuses outright (and the one-sentence reason for each), and the strategy-choice guide.
|
|
106
|
+
|
|
107
|
+
Two rules that catch most mistakes:
|
|
108
|
+
|
|
109
|
+
- **A corpus source is text a human wrote for another human to read.** Identifiers, statuses,
|
|
110
|
+
timestamps and numeric measures are not corpus material even though they are strings.
|
|
111
|
+
- **Presence is enablement.** There is no `enabled` flag. Declaring the decorator makes the field a
|
|
112
|
+
source; omitting it is the complete declaration for every field that is not one.
|
|
113
|
+
|
|
114
|
+
### Step 3: Declare the sources in the shared schema
|
|
115
|
+
|
|
116
|
+
**File:** `./shared-lib/src/modules/<module>/resources/<resource>/<resource>.schemas.ts`
|
|
117
|
+
|
|
118
|
+
- A short field: bare `.ragSource()`. Authoring a chunk size for a value that fits in one chunk is
|
|
119
|
+
configuration with no effect.
|
|
120
|
+
- A long field: name the strategy that matches the content's real shape, and size the chunks near
|
|
121
|
+
the content's natural unit.
|
|
122
|
+
- An optional field: the decorator composes with `.optional()` in either order.
|
|
123
|
+
- A file field: `z_file({ ragSource, textExtraction })` — see `references/framework-file-rag-source-api.md`
|
|
124
|
+
for the chunking-versus-extraction split, which is the thing most often confused.
|
|
125
|
+
|
|
126
|
+
The config is validated when the schema module loads, so a pathological pair (an overlap that is
|
|
127
|
+
not smaller than the size) fails the application's own startup with a named message rather than
|
|
128
|
+
degrading quietly in a background job.
|
|
129
|
+
|
|
130
|
+
For the exact contracts, load `references/framework-rag-source-decorator-api.md`.
|
|
131
|
+
|
|
132
|
+
### Step 4: Wire the corpus capabilities — or knowingly skip them
|
|
133
|
+
|
|
134
|
+
**File:** `./wildo.saas.config.ts`
|
|
135
|
+
|
|
136
|
+
Declare `EngineCapability.AI_EMBEDDINGS`, add a provider entry for it, and select a primary. See
|
|
137
|
+
`references/framework-embeddings-capability-api.md` for the three places this touches.
|
|
138
|
+
|
|
139
|
+
**Skipping it is a supported state, not a broken one.** With no provider, the corpus is still built
|
|
140
|
+
and text is searchable **lexically the moment it is committed** — only the semantic half of
|
|
141
|
+
retrieval is missing, and a background worker records one warning per run naming the backlog. Wire
|
|
142
|
+
a provider later and that backlog drains on its own.
|
|
143
|
+
|
|
144
|
+
The same is true of freshly written text while a provider IS configured: it is lexically searchable
|
|
145
|
+
immediately and semantically searchable once the background worker embeds it, minutes later. Say
|
|
146
|
+
this out loud to whoever asked, because "I saved it and the assistant does not know it yet" is the
|
|
147
|
+
first question a corpus produces.
|
|
148
|
+
|
|
149
|
+
**If — and only if — the corpus holds SCANNED documents**, wire `EngineCapability.AI_DOCUMENT_EXTRACTION`
|
|
150
|
+
as well, the same three ways, and set `textExtraction: { ocr: true }` on the file field in step 3.
|
|
151
|
+
Both halves are required: the capability says an OCR service exists, the field says these documents
|
|
152
|
+
are worth a per-page cost. Same reference file covers it.
|
|
153
|
+
|
|
154
|
+
**Ask before assuming you need it.** A born-digital PDF — anything produced by a word processor,
|
|
155
|
+
an invoicing system or a report generator — already carries its text and gains NOTHING from OCR,
|
|
156
|
+
at a real per-page cost. The capability earns its place only when the corpus genuinely holds scans
|
|
157
|
+
or photographs of pages. Where the answer is no, write `ocr: false` explicitly with a one-line
|
|
158
|
+
reason beside it rather than leaving the default implicit — the next reader should find a decision,
|
|
159
|
+
not an omission.
|
|
160
|
+
|
|
161
|
+
### Step 5: Update the specification for every corpus field
|
|
162
|
+
|
|
163
|
+
**File:** `./specifications/src/modules/<module>/resources/<resource>.resource.specification.ts`
|
|
164
|
+
|
|
165
|
+
A field that answers user questions is part of the resource's business contract. Say what the field
|
|
166
|
+
means and why it is answerable — a corpus source with no documented meaning is the field a later
|
|
167
|
+
reader removes from the corpus by accident, or adds a secret beside.
|
|
168
|
+
|
|
169
|
+
### Keep Resource Specifications In Sync With Schemas
|
|
170
|
+
|
|
171
|
+
Resource schemas live in `shared-lib/` (typically `*.schemas.ts`). The semantic
|
|
172
|
+
explanation of those schemas lives in the paired resource specification under
|
|
173
|
+
`specifications/src/modules/<module>/resources/`.
|
|
174
|
+
|
|
175
|
+
When you add, remove, rename, or retype a field in a resource schema, update the
|
|
176
|
+
paired resource specification in the same session.
|
|
177
|
+
|
|
178
|
+
- Sync the authored `fields` map so every field present in the runtime schema
|
|
179
|
+
has a truthful semantic entry in the spec.
|
|
180
|
+
- Refresh `additionalFieldSpecs` when inherited or variant-only fields change
|
|
181
|
+
discriminator provenance, move between variants, appear, or disappear.
|
|
182
|
+
- Update enum declarations, enum values, array `elementType`, foreign-key
|
|
183
|
+
targets, temporal roles, and other code-handling metadata when the schema
|
|
184
|
+
source changes the import surface.
|
|
185
|
+
- If the main schema export is moved or renamed in `shared-lib/`, update
|
|
186
|
+
`codeHandling.mainSchema` so an AI generating code from the spec still
|
|
187
|
+
imports the right symbol from the right package.
|
|
188
|
+
- Remove stale field names, variant paths, and prose immediately; never leave
|
|
189
|
+
the specification describing a schema shape that no longer exists.
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
### Step 6: Verify — and write no maintenance code
|
|
193
|
+
|
|
194
|
+
Run the invariants below. Then confirm you wrote **no** erasure, cleanup, re-index, backfill or
|
|
195
|
+
storage code: every one of those is framework-owned, and writing one means either duplicating the
|
|
196
|
+
framework or patching around a defect that should be reported instead.
|
|
197
|
+
|
|
198
|
+
### Step 7: Query the corpus — only if you are writing the consuming code
|
|
199
|
+
|
|
200
|
+
Steps 1–6 declare the corpus. This step is for the other job: a flow, actor, agent tool or custom
|
|
201
|
+
operation that needs grounded context. Skip it when you are only authoring declarations.
|
|
202
|
+
|
|
203
|
+
**File:** the flow/actor on `./backend-api/src/modules/<module>/index.ts`, or a
|
|
204
|
+
`./backend-api/src/modules/<module>/resources/<resource>/<resource>.<operation>.<variant>.operation.ts`
|
|
205
|
+
|
|
206
|
+
Resolve `RagRetrievalBackendService` from the container and call `retrieve({ query, executionContext })`.
|
|
207
|
+
Load `references/framework-rag-retrieval-api.md` for the contract. Four decisions live here:
|
|
208
|
+
|
|
209
|
+
- **Pass the CALLER's execution context, unchanged.** It is the access boundary — the framework
|
|
210
|
+
filters by tenancy inside the query and re-reads every matched row on the caller's authority.
|
|
211
|
+
You write no access check, and substituting a broader context is a privilege escalation rather
|
|
212
|
+
than a way to get more results.
|
|
213
|
+
- **Do not gate on an absolute relevance score.** The fused score orders results within one query
|
|
214
|
+
and means nothing across queries. Take the top N.
|
|
215
|
+
- **Decide `expandRelationships` deliberately.** It defaults to false; turning it on buys one hop of
|
|
216
|
+
related context and costs one authorized read per related row.
|
|
217
|
+
- **Read the refusals and the truncation report.** Both are returned on every call. A refusal is
|
|
218
|
+
data, not an error, and a truncated result is a different answer from an empty corpus.
|
|
219
|
+
|
|
220
|
+
There is no HTTP route for retrieval, deliberately — expose the *feature* that uses it and let that
|
|
221
|
+
feature's own operation carry the authorization.
|
|
222
|
+
|
|
223
|
+
## Worked Example
|
|
224
|
+
|
|
225
|
+
A knowledge-article resource showing five distinct corpus decisions in one schema — a bare source,
|
|
226
|
+
an authored markdown split, a source through `.optional()`, a file source with extraction, and a
|
|
227
|
+
secret deliberately left out. Read it as five decisions, not one block of decorators: the fourth
|
|
228
|
+
and fifth are the ones that carry the lessons.
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
## Usage Example
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import { z } from 'zod';
|
|
235
|
+
import { RAGChunkingStrategy, z_file } from '@wildo-ai/zod-decorators';
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* A knowledge-article resource whose text feeds the application's retrieval corpus.
|
|
239
|
+
*
|
|
240
|
+
* Read this as five separate DECISIONS, not one block of decorators. Every field on a resource
|
|
241
|
+
* gets asked the same question — "should an answer be allowed to quote this?" — and four of the
|
|
242
|
+
* five answers below are "no" or "yes, but chunked differently".
|
|
243
|
+
*
|
|
244
|
+
* There is no `enabled` flag anywhere: a field either carries `.ragSource()` (it IS a corpus
|
|
245
|
+
* source) or it does not. Presence is enablement, which is why a bare `.ragSource()` with no
|
|
246
|
+
* argument is a complete, idiomatic declaration.
|
|
247
|
+
*/
|
|
248
|
+
export const knowledgeArticleSchema = z.object({
|
|
249
|
+
/**
|
|
250
|
+
* 1. A SHORT source field. Bare `.ragSource()` — the framework's default chunking is correct for
|
|
251
|
+
* a value that will not exceed one chunk anyway, and authoring a `chunkSize` here would be
|
|
252
|
+
* configuration with no observable effect.
|
|
253
|
+
*/
|
|
254
|
+
title: z.string().ragSource(),
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* 2. A LONG structured source field, where the strategy choice earns its keep. Chunk boundaries
|
|
258
|
+
* decide what a retrieval hit is able to quote: `MARKDOWN` splits on headings, lists and code
|
|
259
|
+
* fences, so a hit returns a coherent section. `FIXED_SIZE` over the same text returns
|
|
260
|
+
* whatever happened to fall inside the window, mid-sentence.
|
|
261
|
+
*
|
|
262
|
+
* `chunkOverlap` carries a tail of each chunk into the next so a fact that straddles a
|
|
263
|
+
* boundary is still retrievable from one side. It must be strictly smaller than `chunkSize`;
|
|
264
|
+
* the decorator refuses the inverted pair at authoring time rather than at ingestion time.
|
|
265
|
+
*/
|
|
266
|
+
bodyMarkdown: z.string().ragSource({
|
|
267
|
+
chunkingStrategy: RAGChunkingStrategy.MARKDOWN,
|
|
268
|
+
chunkSize: 1200,
|
|
269
|
+
chunkOverlap: 150,
|
|
270
|
+
}),
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* 3. A source field that is OPTIONAL. The decorator composes with `.optional()` in either order
|
|
274
|
+
* — declare it before or after the wrapper and the framework reads the same declaration —
|
|
275
|
+
* which matters because corpus fields (summaries, descriptions, notes) are routinely optional.
|
|
276
|
+
* A field whose value is currently absent simply contributes no chunks.
|
|
277
|
+
*/
|
|
278
|
+
summary: z.string().ragSource().optional(),
|
|
279
|
+
|
|
280
|
+
/**
|
|
281
|
+
* 4. A FILE field as a corpus source. A file is one TEXT PROVIDER, not a separate mechanism:
|
|
282
|
+
* `ragSource` registers the same declaration a string field carries, so the chunk store,
|
|
283
|
+
* the erasure seams and the re-index path see one uniform kind of source.
|
|
284
|
+
*
|
|
285
|
+
* The split of concerns is the thing to remember. `ragSource` configures CHUNKING (identical
|
|
286
|
+
* to a string field). `textExtraction` configures how the file's BYTES become text at all,
|
|
287
|
+
* and is file-only. `ocr` stays off by default because it is an external per-page cost most
|
|
288
|
+
* corpora never need — turn it on when the corpus genuinely holds scans or photographs of
|
|
289
|
+
* text rather than documents with a text layer.
|
|
290
|
+
*/
|
|
291
|
+
attachment: z_file({
|
|
292
|
+
allowedMimeTypes: 'Documents',
|
|
293
|
+
ragSource: {},
|
|
294
|
+
textExtraction: { ocr: true },
|
|
295
|
+
}),
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* 5. A field that must NEVER enter the corpus. Nothing to do — omitting `.ragSource()` is the
|
|
299
|
+
* whole declaration, and it is the default for every field.
|
|
300
|
+
*
|
|
301
|
+
* For the small set of fields whose content is categorically disqualifying — secrets,
|
|
302
|
+
* one-time codes, ephemeral shown-once values, and rows on a native database TTL — the
|
|
303
|
+
* framework does not rely on the author remembering. Combining any of them with
|
|
304
|
+
* `.ragSource()` throws AT DECORATION TIME, in both orders, naming the reason. So the mistake
|
|
305
|
+
* surfaces the first time the schema module is loaded, not the first time an answer quotes a
|
|
306
|
+
* credential.
|
|
307
|
+
*/
|
|
308
|
+
providerApiKey: z.string().isWriteOnlySecret(),
|
|
309
|
+
});
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
## References
|
|
313
|
+
|
|
314
|
+
- `references/corpus-field-selection.md` — which fields belong in a corpus, the refused
|
|
315
|
+
combinations and their reasons, strategy and size choice, and what the framework maintains for you
|
|
316
|
+
- `references/framework-rag-source-decorator-api.md` — source-backed `.ragSource()` contract:
|
|
317
|
+
chunking vocabulary, config params, method signature, escape hatch and reader
|
|
318
|
+
- `references/framework-file-rag-source-api.md` — source-backed file-side options and the
|
|
319
|
+
chunking-versus-extraction split
|
|
320
|
+
- `references/framework-embeddings-capability-api.md` — source-backed capability slot, applicability
|
|
321
|
+
classes, and the "no provider configured" degradation
|
|
322
|
+
- `references/framework-rag-retrieval-api.md` — source-backed consumer contract for step 7: the
|
|
323
|
+
request shape and the one public verb (the execution-context access boundary), the assembled
|
|
324
|
+
result/row/passage shapes, the relevance scores, the truncation report with the frozen caps it
|
|
325
|
+
refers to, and the refusal vocabulary
|
|
326
|
+
|
|
327
|
+
## Verification
|
|
328
|
+
|
|
329
|
+
Declaration (steps 1–6):
|
|
330
|
+
|
|
331
|
+
- [ ] The resource's persistence adapter resolves to PostgreSQL before any declaration was authored
|
|
332
|
+
- [ ] Every declared field is prose a human wrote for another human to read
|
|
333
|
+
- [ ] No corpus source shares a field with a secret, one-time-code, ephemeral or TTL declaration
|
|
334
|
+
- [ ] Every authored `chunkOverlap` is strictly smaller than its `chunkSize`
|
|
335
|
+
- [ ] `AI_EMBEDDINGS` is either wired end to end, or its absence was stated as a deliberate choice
|
|
336
|
+
- [ ] `AI_DOCUMENT_EXTRACTION` is wired ONLY if the corpus holds scans — and if a field sets
|
|
337
|
+
`ocr: true`, the capability is wired too (either half alone silently does nothing)
|
|
338
|
+
- [ ] Every corpus field has specification prose describing its meaning
|
|
339
|
+
- [ ] No erasure, cleanup, re-index, backfill or chunk-storage code was written
|
|
340
|
+
|
|
341
|
+
Consumption (step 7, only if you wrote querying code):
|
|
342
|
+
|
|
343
|
+
- [ ] Every `retrieve(...)` call passes the caller's own execution context, unattenuated and unwidened
|
|
344
|
+
- [ ] No hand-written permission filter, tenancy predicate or visibility guard surrounds a result
|
|
345
|
+
- [ ] No absolute threshold is applied to a fusion score
|
|
346
|
+
- [ ] `refusedResourceTypes` and `truncation` are read, not discarded
|
|
347
|
+
- [ ] No HTTP route was added that exposes retrieval directly
|
|
348
|
+
|
|
349
|
+
### Grep invariants
|
|
350
|
+
|
|
351
|
+
Run from the app root.
|
|
352
|
+
|
|
353
|
+
| Invariant | Command |
|
|
354
|
+
|---|---|
|
|
355
|
+
| Enumerate every corpus declaration in the application | `rg -n "\.ragSource\(\|ragSource:" shared-lib/src` |
|
|
356
|
+
| No corpus source shares a field with a refused companion | `rg -n "ragSource\(.*\.(isPassword\|isOtp\|isWriteOnlySecret\|isEphemeral\|ttl)\(\|\.(isPassword\|isOtp\|isWriteOnlySecret\|isEphemeral\|ttl)\(.*ragSource\(" shared-lib/src` — must return nothing |
|
|
357
|
+
| No resource carrying a declaration is pinned to MongoDB | `rg -ln "\.ragSource\(\|ragSource:" shared-lib/src` then `rg -n "persistenceAdapter" shared-lib/src/modules/*/resources/*/*.resources-config.ts` — cross-check the named resources |
|
|
358
|
+
| Every declared adapter override is PAIRED with its isolation claim | `rg -n "persistenceAdapter:\|persistenceAdapterIsolation:" shared-lib/src` — the two must appear together on the same resource; an adapter alone is refused at registration |
|
|
359
|
+
| Every authored overlap is smaller than its size | `rg -n -A1 "chunkSize:" shared-lib/src` — read each pair |
|
|
360
|
+
| The embeddings capability is declared when any source exists | `rg -n "AI_EMBEDDINGS" wildo.saas.config.ts` — expect the capability block, a provider entry and a `selection` entry |
|
|
361
|
+
| No field opts into OCR without the capability behind it | `rg -n "ocr:\s*true" shared-lib/src` then `rg -n "AI_DOCUMENT_EXTRACTION" wildo.saas.config.ts` — a hit in the first with none in the second is a field paying nothing and getting nothing |
|
|
362
|
+
| No capability is wired with no field asking for it | `rg -n "AI_DOCUMENT_EXTRACTION" wildo.saas.config.ts` then `rg -n "ocr:\s*true" shared-lib/src` — the reverse gap: a configured provider no field can reach |
|
|
363
|
+
| Every corpus field appears in its specification | `rg -n "<field>" specifications/src/modules/*/resources/<resource>.resource.specification.ts` |
|
|
364
|
+
| No hand-written chunk maintenance exists | `rg -n "chunk\|embedding" backend-api/src shared-lib/src` — any hit that manipulates corpus rows is framework work being duplicated |
|
|
365
|
+
| Enumerate every retrieval call site | `rg -n "\.retrieve\(" backend-api/src` — read each one against the four rows below |
|
|
366
|
+
| Every call passes the caller's own context | `rg -n -A6 "\.retrieve\(" backend-api/src \| rg "executionContext"` — every call must name the context it was handed, never one it built or elevated |
|
|
367
|
+
| No absolute threshold on a fusion score | `rg -n "fusion\s*[<>]" backend-api/src` — must return nothing; ordering is the only valid use |
|
|
368
|
+
| Refusals and truncation are read | `rg -n "refusedResourceTypes\|truncation" backend-api/src` — expect at least one hit per retrieval call site |
|
|
369
|
+
| No permission filtering around results | `rg -n -B3 -A8 "\.retrieve\(" backend-api/src \| rg "filter\(\|organizationId\|userId\|canRead\|isVisible"` — must return nothing; access is already decided |
|
|
370
|
+
| No HTTP route exposes retrieval | `rg -n "retrieve\(" -g "*.controller.ts" backend-api/src` — must return nothing |
|
|
371
|
+
|
|
372
|
+
## Common Rationalizations
|
|
373
|
+
|
|
374
|
+
| Rationalization | Reality |
|
|
375
|
+
|---|---|
|
|
376
|
+
| "I will add `enabled: false` and turn it on later" | There is no such flag, deliberately. A field either is a corpus source or is not, and a boolean saying "declared but disabled" would force every downstream reader — detection, storage, erasure — to re-ask a question the declaration already answers. Omit the decorator until you want the field answerable. |
|
|
377
|
+
| "OCR is on, so scanned PDFs will just work" | Two conditions, not one. `ocr: true` on the field AND `AI_DOCUMENT_EXTRACTION` wired in the application. Either alone falls back to the local text-layer read, which returns nothing for a scan — so the document is ingested, contributes no chunks, and is silently unanswerable. Check both. |
|
|
378
|
+
| "I will turn `ocr: true` on everywhere so nothing is missed" | OCR is billed per PAGE by an external service, and a born-digital PDF gains nothing from it — its text is already there. Turning it on across a corpus of ordinary documents buys identical text at a recurring cost, and re-costs every document on every re-ingestion. Turn it on for the fields that hold scans. |
|
|
379
|
+
| "The whole resource should be searchable, so I will declare every string field" | Ids, statuses and timestamps are strings that no sentence can quote. They cost storage, dilute every match, and crowd out the chunk that would have answered. Declare the fields a person wrote to be read. |
|
|
380
|
+
| "I need to delete the chunks when the row is deleted" | You do not, and writing that code is how the two paths drift apart. Row deletion, field scrubbing on a subject erasure, and file unbinding all remove the affected chunks already. If you believe a path is uncovered, report it rather than patching it locally. |
|
|
381
|
+
| "Nothing is retrievable until I configure an embeddings provider" | Text is searchable lexically the moment it is committed. A missing provider defers the semantic half of retrieval and nothing else — the corpus is still built, still erased with its rows, and still drains into vectors the moment a provider appears. |
|
|
382
|
+
| "I edited the field, so I should trigger a re-index" | The write already did. Old chunks are removed immediately — edited-away text must not keep answering questions — and the new text is re-derived after the write commits. |
|
|
383
|
+
| "The framework refuses secrets, so it will catch whatever I miss" | The five refusals are a floor, not a review. The framework cannot know that a free-text field happens to collect card numbers. The field-by-field question is still yours to ask. |
|
|
384
|
+
| "I will declare it now and move the resource to PostgreSQL later" | The application will not start. The refusal is fail-closed because chunks written with no reachable store cannot be erased with their parent — that is a compliance dead end, not a missing feature. |
|
|
385
|
+
| "I should filter the results so users only see their own rows" | Already done, three times over — before the search (the caller's roles), inside the query (the caller's tenancy, as a pre-filter), and after matching (each row re-read on the caller's authority). A filter you add on top can only remove rows the framework already admitted, which hides a defect instead of reporting one. |
|
|
386
|
+
| "Retrieval returned too little, so I will pass a system or elevated context" | That is a privilege escalation wearing a workaround's clothes: it makes one caller's query read another tenant's corpus. A short result is either the caller's roles, the resource's scope declaration, or a reported drop count — all three are visible, and all three are the thing to fix. |
|
|
387
|
+
| "I will only use results scoring above 0.5" | The fused score orders passages *within one query*. It is not a probability and not comparable across queries, so a fixed cutoff keeps everything on one query and nothing on the next. Rank and take the top N. |
|
|
388
|
+
| "The vector arm returned nothing, so retrieval is broken" | That is `lexical-only` mode, and it is a supported state: no embeddings provider configured, or text committed more recently than the background worker has embedded it. Text is answerable by wording immediately and by meaning shortly after. |
|
|
389
|
+
| "A refused resource type means the call failed" | Refusals are data. The call searched everything else and named what it skipped. One member of that vocabulary is a working permission boundary that differs per caller; the rest name a configuration an operator can repair. Discarding the list is how a silently half-searched corpus goes unnoticed. |
|
|
390
|
+
| "I will expose retrieval on an endpoint so the frontend can query it" | An endpoint is its own authorization surface — its own role gate, rate limit, audit posture and tenancy story, all duplicating decisions the calling feature already makes. Expose the assistant or the search operation, and let that operation carry the authorization. |
|
|
391
|
+
|
|
392
|
+
## Red Flags
|
|
393
|
+
|
|
394
|
+
- A declaration was authored before the resource's persistence adapter was checked — catch with the
|
|
395
|
+
**No resource carrying a declaration is pinned to MongoDB** grep
|
|
396
|
+
- A field holding ids, enum values, statuses or timestamps carries a declaration — catch with the
|
|
397
|
+
**Enumerate every corpus declaration** grep and read each hit
|
|
398
|
+
- A declaration sits on a field that also declares a secret, one-time code, ephemeral value or TTL
|
|
399
|
+
— catch with the **No corpus source shares a field with a refused companion** grep
|
|
400
|
+
- An authored `chunkOverlap` is greater than or equal to its `chunkSize` — catch with the
|
|
401
|
+
**Every authored overlap is smaller than its size** grep
|
|
402
|
+
- Corpus sources exist but `wildo.saas.config.ts` never mentions the capability, and nobody decided
|
|
403
|
+
that — catch with the **The embeddings capability is declared** grep
|
|
404
|
+
- A corpus field is absent from the resource specification — catch with the **Every corpus field
|
|
405
|
+
appears in its specification** grep
|
|
406
|
+
- The change includes code that deletes, rebuilds or backfills chunks — catch with the **No
|
|
407
|
+
hand-written chunk maintenance exists** grep
|
|
408
|
+
- A `retrieve(...)` call receives a context the caller did not supply — a system, admin or
|
|
409
|
+
freshly-built context — catch with the **Every call passes the caller's own context** grep
|
|
410
|
+
- Results are filtered, narrowed or re-checked for permissions after the call returns — catch with
|
|
411
|
+
the **No permission filtering around results** grep
|
|
412
|
+
- A numeric threshold is compared against a fusion score — catch with the **No absolute threshold on
|
|
413
|
+
a fusion score** grep
|
|
414
|
+
- A retrieval call site ignores `refusedResourceTypes` or `truncation` — catch with the **Refusals
|
|
415
|
+
and truncation are read** grep
|
|
416
|
+
- A controller calls retrieval directly — catch with the **No HTTP route exposes retrieval** grep
|
|
417
|
+
|
|
418
|
+
## Related Skills
|
|
419
|
+
|
|
420
|
+
- `resource-add-field` — adding the field itself, across every surface
|
|
421
|
+
- `resource-schema-authoring` — the shared-layer schema and its decorators generally
|
|
422
|
+
- `config-saas` — capability, provider and selection authoring across the application
|
|
423
|
+
- `flows-actors-chat-assistant` — building the assistant that consumes retrieved context
|
|
424
|
+
- `spec-update-after-change` — the specification follow-up when the resource's contract moves
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Deciding which fields belong in the retrieval corpus
|
|
2
|
+
|
|
3
|
+
An authored decision aid. No framework API here — for the contracts, read
|
|
4
|
+
`framework-rag-source-decorator-api.md`.
|
|
5
|
+
|
|
6
|
+
## The question to ask, field by field
|
|
7
|
+
|
|
8
|
+
> If a user asked a question and the system answered by quoting this field verbatim, would that be
|
|
9
|
+
> correct, useful, and safe?
|
|
10
|
+
|
|
11
|
+
Three failure shapes come out of that question, and each has a different answer:
|
|
12
|
+
|
|
13
|
+
| The answer is… | Because | What to do |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| Not safe | The value is a credential, a token, a code, or otherwise never meant to be read back | Do not declare it. For the categorically disqualifying kinds the framework also refuses (below). |
|
|
16
|
+
| Not useful | The value is an id, a status, a timestamp, a numeric measure — nothing a sentence can quote | Do not declare it. A corpus of enum values costs storage and returns noise. |
|
|
17
|
+
| Not correct | The value is a rendered or duplicated view of facts already in the corpus | Do not declare it. Indexing the same facts twice makes one hit look like two sources of agreement. |
|
|
18
|
+
| Yes | Prose a person wrote or uploaded, meant to be read | Declare it. |
|
|
19
|
+
|
|
20
|
+
The strongest single signal: **a corpus source is text a human wrote for another human to read.**
|
|
21
|
+
Descriptions, article bodies, notes, summaries, policies, uploaded documents. Not identifiers,
|
|
22
|
+
not machine state, not configuration.
|
|
23
|
+
|
|
24
|
+
## The refusals the framework enforces for you
|
|
25
|
+
|
|
26
|
+
Five companions can never share a field with a corpus declaration. Combining them throws when the
|
|
27
|
+
schema module loads, in either authoring order, naming the reason — so the mistake surfaces at
|
|
28
|
+
application startup, not the first time an answer quotes a credential.
|
|
29
|
+
|
|
30
|
+
| Refused companion | The one-sentence reason |
|
|
31
|
+
|---|---|
|
|
32
|
+
| a password field | A password must never enter a retrieval corpus. |
|
|
33
|
+
| a one-time-code field | A one-time code must never enter a retrieval corpus. |
|
|
34
|
+
| a write-only secret field | A write-only secret must never enter a retrieval corpus. |
|
|
35
|
+
| an ephemeral shown-once field | An ephemeral value must never enter a retrieval corpus. |
|
|
36
|
+
| a native time-to-live field | **This is the non-obvious one.** A TTL is honoured by the database itself: rows vanish with no application code running, so no hook, cascade or post-commit effect can observe the deletion. Derived chunks could therefore never be erased with their parent, and would hold copies of the text forever. |
|
|
37
|
+
|
|
38
|
+
Read the TTL row as the pattern rather than a special case: the framework refuses a corpus source
|
|
39
|
+
wherever the *erasure* of that source could not follow it.
|
|
40
|
+
|
|
41
|
+
Note also what these refusals are NOT: they are a floor, not a review. The framework cannot know
|
|
42
|
+
that a free-text field happens to collect payment details. The question at the top of this page is
|
|
43
|
+
still yours to ask.
|
|
44
|
+
|
|
45
|
+
## Choosing a chunking strategy
|
|
46
|
+
|
|
47
|
+
Chunk boundaries decide what a retrieval hit is able to quote, which is the whole reason this is an
|
|
48
|
+
authored decision rather than a default.
|
|
49
|
+
|
|
50
|
+
| Content shape | Strategy | Why |
|
|
51
|
+
|---|---|---|
|
|
52
|
+
| Structured documents with headings, lists, code fences | markdown | A hit returns a coherent section instead of a fragment that starts mid-sentence. |
|
|
53
|
+
| Continuous prose with no reliable structure | recursive | Splits on a paragraph → sentence → word hierarchy, so boundaries land where a reader would put them. |
|
|
54
|
+
| Source code or configuration | code | Splits on functions, classes and blocks, so a hit is a runnable unit. |
|
|
55
|
+
| Text whose topics shift without any markup to signal it | semantic | Boundaries are detected from meaning; costlier, and worth it only when structure genuinely is absent. |
|
|
56
|
+
| Short values that will never exceed one chunk | omit the config entirely | Authoring a size here is configuration with no observable effect. |
|
|
57
|
+
|
|
58
|
+
`chunkSize` is a target, and `chunkOverlap` carries a tail of each chunk into the next so a fact
|
|
59
|
+
that straddles a boundary stays retrievable from one side. The overlap must be strictly smaller
|
|
60
|
+
than the size; the inverted pair is refused at authoring time.
|
|
61
|
+
|
|
62
|
+
Two size heuristics that survive contact with real corpora:
|
|
63
|
+
|
|
64
|
+
- **Too small fragments the answer.** A chunk that holds half a definition retrieves well and
|
|
65
|
+
quotes badly.
|
|
66
|
+
- **Too large dilutes the match.** A chunk holding six unrelated topics matches every one of them
|
|
67
|
+
weakly, and crowds out the chunk that actually answered the question.
|
|
68
|
+
|
|
69
|
+
Start near the natural unit of the content — a section, a few paragraphs — and change it only in
|
|
70
|
+
response to an observed retrieval failure.
|
|
71
|
+
|
|
72
|
+
## What you never have to write
|
|
73
|
+
|
|
74
|
+
The corpus is a **derived tier**, maintained by the framework. Specifically, do not author:
|
|
75
|
+
|
|
76
|
+
- **Erasure or cleanup.** Deleting a row deletes its chunks. Scrubbing a field on a subject erasure
|
|
77
|
+
deletes that field's chunks in the same decision. Unbinding a file from a field invalidates that
|
|
78
|
+
field's chunks. Every path a subject's data can leave by already reaches the corpus.
|
|
79
|
+
- **Re-indexing on edit.** Writing a corpus field re-derives its chunks after the write commits.
|
|
80
|
+
The old chunks are removed immediately — edited-away text must not keep answering questions —
|
|
81
|
+
and the new text is searchable as soon as it is committed.
|
|
82
|
+
- **A backfill or repair job.** A background pass reconciles the corpus hourly: content that
|
|
83
|
+
drifted is re-derived, chunks whose parent is gone are removed, and unembedded text is counted.
|
|
84
|
+
Adding a declaration to an existing resource needs no migration; the reconciliation finds it.
|
|
85
|
+
- **Any storage schema.** Chunk storage is provisioned by the framework from the resource's own
|
|
86
|
+
persistence adapter.
|
|
87
|
+
|
|
88
|
+
If you find yourself writing any of the above, stop: either the framework already does it, or the
|
|
89
|
+
declaration is on a field the framework cannot reach — which is a defect to report, not to patch
|
|
90
|
+
around.
|