@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,809 @@
|
|
|
1
|
+
# companion.technical-doc.service
|
|
2
|
+
|
|
3
|
+
## Import Origins
|
|
4
|
+
|
|
5
|
+
- `@wildo-ai/dev-companion`
|
|
6
|
+
|
|
7
|
+
## Source Excerpts
|
|
8
|
+
|
|
9
|
+
### Origin Package: `@wildo-ai/dev-companion`
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { existsSync } from 'node:fs';
|
|
15
|
+
import * as path from 'node:path';
|
|
16
|
+
import { inject, injectable } from 'inversify';
|
|
17
|
+
import {
|
|
18
|
+
AppConfigurationService,
|
|
19
|
+
ErrorBuilderBackendService,
|
|
20
|
+
LoggerService,
|
|
21
|
+
SAAS_SERVICE_TYPES,
|
|
22
|
+
resolveFeatureGatedCoreResourceExclusions,
|
|
23
|
+
describeCaughtError,
|
|
24
|
+
} from '@wildo-ai/saas-backend-lib';
|
|
25
|
+
import { CoreResourceType, ErrorCustomMessageReference, ErrorType } from '@wildo-ai/saas-models';
|
|
26
|
+
import { AppFrontendType, loadConfig } from '@wildo-ai/platform-config-lib';
|
|
27
|
+
import {
|
|
28
|
+
generateOpenApiDocuments,
|
|
29
|
+
resolveTechnicalDocumentationForbiddenPublicSentinels,
|
|
30
|
+
resolveTechnicalDocumentationOutputBudgets,
|
|
31
|
+
OpenApiGenerationInputSchema,
|
|
32
|
+
resolveApplicationOrganizationRoleDocumentation,
|
|
33
|
+
type ApplicationOrganizationRoleDocumentationSource,
|
|
34
|
+
type ApplicationOrganizationUnitResourceDocumentation,
|
|
35
|
+
type OpenApiGenerationInput,
|
|
36
|
+
type OpenApiGenerationProjectorStats,
|
|
37
|
+
type OperationProjection,
|
|
38
|
+
type ResourceTag,
|
|
39
|
+
type TechnicalDocGenerateOpenApiResult,
|
|
40
|
+
} from '@wildo-ai/saas-technical-doc/companion';
|
|
41
|
+
import {
|
|
42
|
+
createApiReferenceLinkIndex,
|
|
43
|
+
resolveTechnicalDocumentationApiReferenceLink,
|
|
44
|
+
type WildoTechnicalDocConfig,
|
|
45
|
+
} from '@wildo-ai/saas-technical-doc';
|
|
46
|
+
import { createConservedApiReferenceModel } from '@wildo-ai/saas-technical-doc/openapi-reference-model';
|
|
47
|
+
|
|
48
|
+
import { TechnicalDocumentationPilotCompanionService } from './technical-documentation-pilot.companion.service';
|
|
49
|
+
import { COMPANION_SERVICE_TYPES } from '../../core/inject/models/service-types';
|
|
50
|
+
import type { CompanionContext } from '../../core/context/companion-context';
|
|
51
|
+
import { CompanionIntrospectionService } from '../../core/introspection/services/companion-introspection.companion.service';
|
|
52
|
+
import {
|
|
53
|
+
type TechnicalDocumentationApplicationDerivationCompanionService,
|
|
54
|
+
type TechnicalDocumentationApplicationDerivationResult,
|
|
55
|
+
} from './technical-documentation-application-derivation.companion.service';
|
|
56
|
+
import type {
|
|
57
|
+
TechnicalDocumentationEnvironmentIdentityInput,
|
|
58
|
+
} from './technical-documentation-environment-identity.companion.service';
|
|
59
|
+
import { getCompanionConfiguredPrimaryLanguage } from '../../core/config/primary-language.companion.utils';
|
|
60
|
+
import { readPerUnitLabels, resolvePerUnitFilePath } from '../../i18n-labelling/utils/per-unit-file.utils';
|
|
61
|
+
import { ROLE_LABELLING_UNIT_FILE_PATH_HINT } from '../../i18n-labelling/utils/role-lifecycle-keys.utils';
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* The diagnostics result is owned by the engine contract. The local companion
|
|
65
|
+
* re-exports it only for its in-memory inspection route; managed publication
|
|
66
|
+
* has its own pointer/fact result and never writes this diagnostic shape.
|
|
67
|
+
*/
|
|
68
|
+
export type {
|
|
69
|
+
TechnicalDocGenerateOpenApiResult,
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Conventional file name for the per-service technical-documentation
|
|
74
|
+
* configuration (Step 7.5 refactor — `saas-technical-doc.md`). Authored
|
|
75
|
+
* at the docs service root next to `package.json` / `docusaurus.config.ts`.
|
|
76
|
+
*
|
|
77
|
+
* Discovery is "by convention, not by configuration":
|
|
78
|
+
*
|
|
79
|
+
* - The companion locates this file by walking the `services` entry
|
|
80
|
+
* whose `frontendType === TECH_DOC` and joining `<saasRoot>/<service.path>/`.
|
|
81
|
+
* The saas-config schema's `superRefine` already enforces "at most
|
|
82
|
+
* one TECH_DOC service per app", so the lookup is deterministic.
|
|
83
|
+
*
|
|
84
|
+
* - File presence is the enable signal — there is NO `enabled` field
|
|
85
|
+
* on `WildoTechnicalDocConfigSchema`. A TECH_DOC service without
|
|
86
|
+
* this file is treated as a misconfiguration and the loader fails
|
|
87
|
+
* closed (rather than silently shipping a docs site with no
|
|
88
|
+
* OpenAPI metadata).
|
|
89
|
+
*/
|
|
90
|
+
const PER_SERVICE_TECH_DOC_CONFIG_FILE_NAME = 'wildo.tech-doc.config.ts';
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Subprocess wire shape — kept as a structural type rather than an imported
|
|
94
|
+
* symbol because the source declaration lives inside the introspection-
|
|
95
|
+
* subprocess module which intentionally is NOT exported from `src/index.ts`
|
|
96
|
+
* (subprocess code must not load in the parent process).
|
|
97
|
+
*
|
|
98
|
+
* The `stats` field reuses {@link OpenApiGenerationProjectorStats} from the
|
|
99
|
+
* engine package so the projector subprocess and the companion-side result
|
|
100
|
+
* cannot drift on the diagnostic counts they exchange (H-C fix-up).
|
|
101
|
+
*/
|
|
102
|
+
interface OpenApiGenerationInputSubprocessOutput {
|
|
103
|
+
operations: OperationProjection[];
|
|
104
|
+
/** Source-derived application activation facts; independent from the API-reference selection. */
|
|
105
|
+
readonly hasConfiguredMcpToolOperations: boolean;
|
|
106
|
+
readonly hasConfiguredA2aSkills: boolean;
|
|
107
|
+
/**
|
|
108
|
+
* Source-derived role semantics cross the subprocess boundary unchanged.
|
|
109
|
+
* The parent then joins the application's primary-locale labels before a
|
|
110
|
+
* consumer-documentation fact is derived; labels are intentionally not
|
|
111
|
+
* fabricated by the registry projector.
|
|
112
|
+
*/
|
|
113
|
+
readonly organizationRoles: readonly ApplicationOrganizationRoleDocumentationSource[];
|
|
114
|
+
/** Exact resources selected by the application's unit-narrowing startup declaration. */
|
|
115
|
+
readonly organizationUnitAwareResources: readonly ApplicationOrganizationUnitResourceDocumentation[];
|
|
116
|
+
/** Canonical framework HTTP error envelope, JSON-safe across the subprocess boundary. */
|
|
117
|
+
errorResponseSchema: unknown;
|
|
118
|
+
/**
|
|
119
|
+
* Per-resource OpenAPI tag descriptors (the resource's business purpose),
|
|
120
|
+
* merged into {@link OpenApiGenerationInput.resourceTags}. Mirrors the
|
|
121
|
+
* projector's wire shape; see `openapi-generation-input.behavior.ts`.
|
|
122
|
+
*/
|
|
123
|
+
resourceTags: ResourceTag[];
|
|
124
|
+
stats: OpenApiGenerationProjectorStats;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
@injectable()
|
|
128
|
+
export class TechnicalDocCompanionService {
|
|
129
|
+
private readonly logDebug: (message: string, context?: Record<string, unknown>) => void;
|
|
130
|
+
|
|
131
|
+
constructor(
|
|
132
|
+
@inject(SAAS_SERVICE_TYPES.Logger) private readonly logger: LoggerService,
|
|
133
|
+
@inject(SAAS_SERVICE_TYPES.ErrorBuilderService)
|
|
134
|
+
private readonly errorBuilder: ErrorBuilderBackendService,
|
|
135
|
+
@inject(SAAS_SERVICE_TYPES.AppConfigService)
|
|
136
|
+
private readonly appConfigService: AppConfigurationService,
|
|
137
|
+
@inject(COMPANION_SERVICE_TYPES.CompanionContext)
|
|
138
|
+
private readonly companionContext: CompanionContext,
|
|
139
|
+
@inject(COMPANION_SERVICE_TYPES.IntrospectionService)
|
|
140
|
+
private readonly companionIntrospectionService: CompanionIntrospectionService,
|
|
141
|
+
@inject(COMPANION_SERVICE_TYPES.TechnicalDocumentationApplicationDerivationService)
|
|
142
|
+
private readonly applicationDerivationService: TechnicalDocumentationApplicationDerivationCompanionService,
|
|
143
|
+
) {
|
|
144
|
+
this.logDebug = this.logger.debugByType('TechnicalDocCompanionService');
|
|
145
|
+
this.logger.setDebugTypeLogging('TechnicalDocCompanionService', true);
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* Produces one framework private derivation, including the resolved
|
|
151
|
+
* organization-role inventory, and its public pre-render bundle.
|
|
152
|
+
* The caller selects the environment backend service; the companion resolves
|
|
153
|
+
* the environment identity and source-derived operation-exposure evidence.
|
|
154
|
+
* It does not read accepted application-family state or select application
|
|
155
|
+
* documentation. The role inventory is a narrow configuration projection,
|
|
156
|
+
* not an application-authored use-case selection.
|
|
157
|
+
*/
|
|
158
|
+
public async deriveApplicationDocumentationBundles(
|
|
159
|
+
input: TechnicalDocumentationEnvironmentIdentityInput,
|
|
160
|
+
): Promise<TechnicalDocumentationApplicationDerivationResult> {
|
|
161
|
+
const technicalDocConfig = await this.loadTechnicalDocConfig();
|
|
162
|
+
const excludedCoreResourceTypes = resolveFeatureGatedCoreResourceExclusions(this.appConfigService.config);
|
|
163
|
+
const subprocessOutput = await this.callSubprocessProjector(
|
|
164
|
+
technicalDocConfig.apiDocResources,
|
|
165
|
+
excludedCoreResourceTypes ? [...excludedCoreResourceTypes].sort() : undefined,
|
|
166
|
+
);
|
|
167
|
+
const organizationRoles = await this.resolveApplicationOrganizationRoles(input.backendServiceKey, subprocessOutput.organizationRoles);
|
|
168
|
+
return this.applicationDerivationService.deriveAuthorizedBundles({
|
|
169
|
+
...input,
|
|
170
|
+
operations: subprocessOutput.operations,
|
|
171
|
+
hasConfiguredMcpToolOperations: subprocessOutput.hasConfiguredMcpToolOperations,
|
|
172
|
+
hasConfiguredA2aSkills: subprocessOutput.hasConfiguredA2aSkills,
|
|
173
|
+
organizationRoles,
|
|
174
|
+
organizationUnitAwareResources: subprocessOutput.organizationUnitAwareResources,
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Publishes the complete managed documentation tree at stable generated paths.
|
|
180
|
+
* This operation synchronizes the framework-owned consumer documentation into
|
|
181
|
+
* `src/generated/consumer-documentation/**`. The directory is generator-owned;
|
|
182
|
+
* Git provides history and rollback.
|
|
183
|
+
*
|
|
184
|
+
* **No capture.** Screenshots resolve to `PLACEHOLDER` (framework-materialized bytes), so
|
|
185
|
+
* publication needs no browser, no provisioned tenant and no live stack. That was the
|
|
186
|
+
* decision that collapsed this from a multi-precondition chain to one call: pictures are
|
|
187
|
+
* a pre-production refinement, and `refuseProvisionalAssets` is how a production
|
|
188
|
+
* environment declares it will not ship without them.
|
|
189
|
+
*
|
|
190
|
+
* Docusaurus runtime/build measurement happens against the generated publication after it
|
|
191
|
+
* exists. Measuring the previous site before publication and applying that observation to
|
|
192
|
+
* a different candidate made first cutover circular and, in practice, let the retired
|
|
193
|
+
* 981-page OpenAPI site block publication of the much smaller generated tree.
|
|
194
|
+
*/
|
|
195
|
+
public async publishManagedDocumentation(
|
|
196
|
+
input: TechnicalDocumentationEnvironmentIdentityInput & { readonly refuseProvisionalAssets?: boolean },
|
|
197
|
+
) {
|
|
198
|
+
const technicalDocConfig = await this.loadTechnicalDocConfig();
|
|
199
|
+
const generated = await this.generateVerifiedApplicationOpenApiDocuments(input);
|
|
200
|
+
for (const section of generated.documents.sections) {
|
|
201
|
+
createConservedApiReferenceModel(section);
|
|
202
|
+
}
|
|
203
|
+
const apiReferenceLinkIndex = createApiReferenceLinkIndex(generated.documents.sections);
|
|
204
|
+
const publisher = new TechnicalDocumentationPilotCompanionService(this.companionContext.saasRoot);
|
|
205
|
+
await publisher.publishOpenApiDocuments({
|
|
206
|
+
documents: generated.documents,
|
|
207
|
+
sourceUnitRefs: [`technical-documentation:source/openapi/${this.companionContext.saasConfig.slug}`],
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
return publisher.generateValidateAndPublish({
|
|
211
|
+
derivation: generated.derivation,
|
|
212
|
+
supportedApiVersion: technicalDocConfig.supportedApiVersion,
|
|
213
|
+
forbiddenPublicSentinels: resolveTechnicalDocumentationForbiddenPublicSentinels(
|
|
214
|
+
technicalDocConfig.forbiddenPublicSentinels,
|
|
215
|
+
),
|
|
216
|
+
budgets: resolveTechnicalDocumentationOutputBudgets(technicalDocConfig.outputBudgets),
|
|
217
|
+
resolveApiReferenceTarget: (target) => resolveTechnicalDocumentationApiReferenceLink(apiReferenceLinkIndex, target),
|
|
218
|
+
...(input.refuseProvisionalAssets === undefined
|
|
219
|
+
? {}
|
|
220
|
+
: { refuseProvisionalAssets: input.refuseProvisionalAssets }),
|
|
221
|
+
});
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Generates the complete API reference from the resolved application and
|
|
226
|
+
* enabled framework resource catalog.
|
|
227
|
+
*
|
|
228
|
+
* Narrative documentation intentionally selects a small set of source-backed
|
|
229
|
+
* customer journeys. It must not become an allow-list for API operations:
|
|
230
|
+
* doing so hid every framework resource and every application resource other
|
|
231
|
+
* than the one chosen for the current use-case page. The OpenAPI generator
|
|
232
|
+
* already applies the API-call and API-key exposure filters to this complete
|
|
233
|
+
* resolved catalog; the derivation remains part of publication for consumer
|
|
234
|
+
* content and evidence, but does not truncate the API contract.
|
|
235
|
+
*/
|
|
236
|
+
public async generateVerifiedApplicationOpenApiDocuments(
|
|
237
|
+
input: TechnicalDocumentationEnvironmentIdentityInput,
|
|
238
|
+
): Promise<{
|
|
239
|
+
readonly derivation: TechnicalDocumentationApplicationDerivationResult;
|
|
240
|
+
readonly documents: ReturnType<typeof generateOpenApiDocuments>;
|
|
241
|
+
readonly sourceStats: OpenApiGenerationProjectorStats;
|
|
242
|
+
readonly authorizedOperationCount: number;
|
|
243
|
+
}> {
|
|
244
|
+
const technicalDocConfig = await this.loadTechnicalDocConfig();
|
|
245
|
+
const excludedCoreResourceTypes = resolveFeatureGatedCoreResourceExclusions(this.appConfigService.config);
|
|
246
|
+
const subprocessOutput = await this.callSubprocessProjector(
|
|
247
|
+
technicalDocConfig.apiDocResources,
|
|
248
|
+
excludedCoreResourceTypes ? [...excludedCoreResourceTypes].sort() : undefined,
|
|
249
|
+
);
|
|
250
|
+
const organizationRoles = await this.resolveApplicationOrganizationRoles(input.backendServiceKey, subprocessOutput.organizationRoles);
|
|
251
|
+
const derivation = await this.applicationDerivationService.deriveAuthorizedBundles({
|
|
252
|
+
...input,
|
|
253
|
+
operations: subprocessOutput.operations,
|
|
254
|
+
hasConfiguredMcpToolOperations: subprocessOutput.hasConfiguredMcpToolOperations,
|
|
255
|
+
hasConfiguredA2aSkills: subprocessOutput.hasConfiguredA2aSkills,
|
|
256
|
+
organizationRoles,
|
|
257
|
+
organizationUnitAwareResources: subprocessOutput.organizationUnitAwareResources,
|
|
258
|
+
});
|
|
259
|
+
const generationInput = this.assembleGenerationInput(subprocessOutput, technicalDocConfig);
|
|
260
|
+
|
|
261
|
+
return Object.freeze({
|
|
262
|
+
derivation,
|
|
263
|
+
documents: generateOpenApiDocuments(generationInput),
|
|
264
|
+
sourceStats: subprocessOutput.stats,
|
|
265
|
+
authorizedOperationCount: subprocessOutput.operations.length,
|
|
266
|
+
});
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Generate the Application + Organization OpenAPI YAML
|
|
271
|
+
* documents for the currently-loaded SaaS app. Returns the
|
|
272
|
+
* pure-function generator output unchanged so the controller
|
|
273
|
+
* can pass it straight through as JSON.
|
|
274
|
+
*
|
|
275
|
+
* The method does NOT short-circuit on a "disabled docs site" —
|
|
276
|
+
* after the Step 7.5 refactor there is no `enabled` flag anywhere
|
|
277
|
+
* (file presence under a TECH_DOC service IS the enable signal).
|
|
278
|
+
* If the docs service or its `wildo.tech-doc.config.ts` is missing,
|
|
279
|
+
* {@link loadTechnicalDocConfig} fails closed with a CONFIGURATION
|
|
280
|
+
* error before generation runs.
|
|
281
|
+
*/
|
|
282
|
+
public async generateOpenApiDocuments(): Promise<TechnicalDocGenerateOpenApiResult> {
|
|
283
|
+
this.logDebug('technical-doc generate-openapi — start', {
|
|
284
|
+
appSlug: this.companionContext.saasConfig.slug,
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
// Load the per-service config BEFORE the subprocess call: its
|
|
288
|
+
// `apiDocResources` opt-in is threaded into the projector so the subprocess
|
|
289
|
+
// also documents the named core (engine) resources.
|
|
290
|
+
const technicalDocConfig = await this.loadTechnicalDocConfig();
|
|
291
|
+
const excludedCoreResourceTypes = resolveFeatureGatedCoreResourceExclusions(this.appConfigService.config);
|
|
292
|
+
const subprocessOutput = await this.callSubprocessProjector(
|
|
293
|
+
technicalDocConfig.apiDocResources,
|
|
294
|
+
excludedCoreResourceTypes ? [...excludedCoreResourceTypes].sort() : undefined,
|
|
295
|
+
);
|
|
296
|
+
const generationInput = this.assembleGenerationInput(subprocessOutput, technicalDocConfig);
|
|
297
|
+
const documents = generateOpenApiDocuments(generationInput);
|
|
298
|
+
|
|
299
|
+
this.logDebug('technical-doc generate-openapi — success', {
|
|
300
|
+
appSlug: generationInput.appSlug,
|
|
301
|
+
sectionCount: documents.sections.length,
|
|
302
|
+
resourceCount: subprocessOutput.stats.resourceCount,
|
|
303
|
+
consideredOperationCount: subprocessOutput.stats.consideredOperationCount,
|
|
304
|
+
projectedRowCount: subprocessOutput.stats.projectedRowCount,
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
return {
|
|
308
|
+
documents,
|
|
309
|
+
stats: subprocessOutput.stats,
|
|
310
|
+
metadata: {
|
|
311
|
+
appSlug: generationInput.appSlug,
|
|
312
|
+
appDisplayName: generationInput.appDisplayName,
|
|
313
|
+
...(generationInput.publicMarketingTitle !== undefined
|
|
314
|
+
? { publicMarketingTitle: generationInput.publicMarketingTitle }
|
|
315
|
+
: {}),
|
|
316
|
+
supportedApiVersion: generationInput.supportedApiVersion,
|
|
317
|
+
},
|
|
318
|
+
};
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* Materializes the two generated OpenAPI serializations at stable paths for
|
|
323
|
+
* the docs application. This is companion-owned generation; Docusaurus reads
|
|
324
|
+
* the resulting files and never regenerates or edits them.
|
|
325
|
+
*/
|
|
326
|
+
public async publishOpenApiReference(): Promise<{ readonly rootPath: string; readonly outputPaths: readonly string[] }> {
|
|
327
|
+
const generated = await this.generateOpenApiDocuments();
|
|
328
|
+
return new TechnicalDocumentationPilotCompanionService(this.companionContext.saasRoot).publishOpenApiDocuments({
|
|
329
|
+
documents: generated.documents,
|
|
330
|
+
sourceUnitRefs: [`technical-documentation:source/openapi/${generated.metadata.appSlug}`],
|
|
331
|
+
});
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Call the `'openapi-generation-input'` introspection behavior
|
|
336
|
+
* on any backend service (the projector behavior routes to
|
|
337
|
+
* `library` which every backend service declares — same picker
|
|
338
|
+
* pattern as `MarketGenerationCompanionService.pickMarketCarrierServiceKey`
|
|
339
|
+
* and `getResourcesRegistry`'s carrier picker).
|
|
340
|
+
*
|
|
341
|
+
* Validates the subprocess wire format defensively: a structural
|
|
342
|
+
* mismatch here would otherwise surface as a confusing Zod parse
|
|
343
|
+
* failure deeper in the generator.
|
|
344
|
+
*/
|
|
345
|
+
private async callSubprocessProjector(
|
|
346
|
+
apiDocResources?: WildoTechnicalDocConfig['apiDocResources'],
|
|
347
|
+
excludedCoreResourceTypes?: readonly string[],
|
|
348
|
+
): Promise<OpenApiGenerationInputSubprocessOutput> {
|
|
349
|
+
const input = {
|
|
350
|
+
...(apiDocResources !== undefined ? { apiDocResources } : {}),
|
|
351
|
+
...(excludedCoreResourceTypes !== undefined ? { excludedCoreResourceTypes } : {}),
|
|
352
|
+
};
|
|
353
|
+
const introspection = await this.companionIntrospectionService.requestInfo({
|
|
354
|
+
serviceKey: this.pickProjectorCarrierServiceKey(),
|
|
355
|
+
behavior: 'openapi-generation-input',
|
|
356
|
+
// Thread both the authored core-resource selection and the canonical
|
|
357
|
+
// runtime feature exclusions across the JSON-safe subprocess boundary.
|
|
358
|
+
...(Object.keys(input).length > 0 ? { input } : {}),
|
|
359
|
+
});
|
|
360
|
+
|
|
361
|
+
if (introspection.success === false) {
|
|
362
|
+
const failure = introspection;
|
|
363
|
+
throw this.errorBuilder.buildError(ErrorType.INTERNAL, undefined, {
|
|
364
|
+
customMessageReference: ErrorCustomMessageReference.INTERNAL,
|
|
365
|
+
context: {
|
|
366
|
+
message: failure.error.message,
|
|
367
|
+
serviceKey: failure.serviceKey,
|
|
368
|
+
behavior: failure.behavior,
|
|
369
|
+
targetId: failure.targetId,
|
|
370
|
+
},
|
|
371
|
+
});
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
const data: unknown = introspection.data;
|
|
375
|
+
if (
|
|
376
|
+
!isPlainObject(data)
|
|
377
|
+
|| !Array.isArray(data.operations)
|
|
378
|
+
|| typeof data.hasConfiguredMcpToolOperations !== 'boolean'
|
|
379
|
+
|| typeof data.hasConfiguredA2aSkills !== 'boolean'
|
|
380
|
+
|| !isPlainObject(data.errorResponseSchema)
|
|
381
|
+
|| !Array.isArray(data.resourceTags)
|
|
382
|
+
|| !Array.isArray(data.organizationRoles)
|
|
383
|
+
|| !Array.isArray(data.organizationUnitAwareResources)
|
|
384
|
+
|| !isOpenApiGenerationProjectorStats(data.stats)
|
|
385
|
+
) {
|
|
386
|
+
throw this.errorBuilder.buildError(ErrorType.INTERNAL, undefined, {
|
|
387
|
+
customMessageReference: ErrorCustomMessageReference.INTERNAL,
|
|
388
|
+
context: {
|
|
389
|
+
message: 'openapi-generation-input subprocess returned a malformed payload — expected '
|
|
390
|
+
+ '`{ operations: OperationProjection[], hasConfiguredMcpToolOperations: boolean, hasConfiguredA2aSkills: boolean, organizationRoles: OrganizationRole[], organizationUnitAwareResources: OrganizationUnitAwareResource[], errorResponseSchema: object, resourceTags: ResourceTag[], stats: { ... } }`.',
|
|
391
|
+
},
|
|
392
|
+
});
|
|
393
|
+
}
|
|
394
|
+
const output = data as unknown as OpenApiGenerationInputSubprocessOutput;
|
|
395
|
+
assertResolvedHttpOperationProjectionConservation(output);
|
|
396
|
+
return output;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* Compose the subprocess projection with the
|
|
401
|
+
* `WildoSaasConfig`-derived metadata the parent process owns +
|
|
402
|
+
* the per-service `wildo.tech-doc.config.ts` block (Step 7.5
|
|
403
|
+
* refactor — `saas-technical-doc.md`).
|
|
404
|
+
*
|
|
405
|
+
* The `publicMarketingTitle` projected into `openapi.info.title`
|
|
406
|
+
* comes from the per-service config (NOT from
|
|
407
|
+
* `WildoSaasConfig.technicalDoc?.publicMarketingTitle` — that root-
|
|
408
|
+
* level field was removed in Step 7.5 in favor of co-locating the
|
|
409
|
+
* tech-doc-specific config with the engine package that owns it).
|
|
410
|
+
*
|
|
411
|
+
* Re-parses the result through `OpenApiGenerationInputSchema`
|
|
412
|
+
* so the generator only ever sees a fully-validated payload —
|
|
413
|
+
* if a future field is added to the schema, this assembly step
|
|
414
|
+
* must be updated in the same commit and the Zod parse will
|
|
415
|
+
* fail fast otherwise.
|
|
416
|
+
*/
|
|
417
|
+
private assembleGenerationInput(
|
|
418
|
+
subprocessOutput: OpenApiGenerationInputSubprocessOutput,
|
|
419
|
+
technicalDocConfig: WildoTechnicalDocConfig,
|
|
420
|
+
): OpenApiGenerationInput {
|
|
421
|
+
const saasConfig = this.companionContext.saasConfig;
|
|
422
|
+
const candidateInput: OpenApiGenerationInput = {
|
|
423
|
+
appSlug: saasConfig.slug,
|
|
424
|
+
appDisplayName: saasConfig.displayName,
|
|
425
|
+
supportedApiVersion: technicalDocConfig.supportedApiVersion,
|
|
426
|
+
...(technicalDocConfig.publicMarketingTitle
|
|
427
|
+
? { publicMarketingTitle: technicalDocConfig.publicMarketingTitle }
|
|
428
|
+
: {}),
|
|
429
|
+
operations: subprocessOutput.operations,
|
|
430
|
+
errorResponseSchema: subprocessOutput.errorResponseSchema,
|
|
431
|
+
...(subprocessOutput.resourceTags && subprocessOutput.resourceTags.length > 0
|
|
432
|
+
? { resourceTags: applyApiReferenceResourceCategories(subprocessOutput.resourceTags, technicalDocConfig.apiReferenceResourceCategories) }
|
|
433
|
+
: {}),
|
|
434
|
+
// App-enriched OpenAPI `servers` (deployment base URLs). The framework
|
|
435
|
+
// emits the security SCHEMES automatically (they are universal), but the
|
|
436
|
+
// server URLs are app/environment knowledge → authored on the tech-doc
|
|
437
|
+
// config and threaded straight through.
|
|
438
|
+
...(technicalDocConfig.apiServers && technicalDocConfig.apiServers.length > 0
|
|
439
|
+
? { servers: technicalDocConfig.apiServers }
|
|
440
|
+
: {}),
|
|
441
|
+
// App-authored landing-page intro; the generator prepends it to the
|
|
442
|
+
// framework-universal API-conventions block to form `info.description`.
|
|
443
|
+
...(technicalDocConfig.apiOverview
|
|
444
|
+
? { apiOverview: technicalDocConfig.apiOverview }
|
|
445
|
+
: {}),
|
|
446
|
+
};
|
|
447
|
+
|
|
448
|
+
const parsed = OpenApiGenerationInputSchema.safeParse(candidateInput);
|
|
449
|
+
if (!parsed.success) {
|
|
450
|
+
throw this.errorBuilder.buildError(ErrorType.INTERNAL, undefined, {
|
|
451
|
+
customMessageReference: ErrorCustomMessageReference.INTERNAL,
|
|
452
|
+
context: {
|
|
453
|
+
message: 'Failed to assemble OpenApiGenerationInput — schema validation rejected the '
|
|
454
|
+
+ 'merged subprocess + saas-config payload. This usually means the subprocess produced '
|
|
455
|
+
+ 'an OperationProjection that fails the strict OperationProjectionSchema (e.g. an '
|
|
456
|
+
+ 'API_CALL_WITH_CALLBACK row missing `callbackPath`).',
|
|
457
|
+
issues: parsed.error.issues,
|
|
458
|
+
},
|
|
459
|
+
});
|
|
460
|
+
}
|
|
461
|
+
return parsed.data;
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* Load the per-service `wildo.tech-doc.config.ts` for the
|
|
466
|
+
* (unique) `frontendType: TECH_DOC` service declared in
|
|
467
|
+
* `wildo.saas.config.ts`.
|
|
468
|
+
*
|
|
469
|
+
* Discovery contract (Step 7.5 refactor — `saas-technical-doc.md`):
|
|
470
|
+
*
|
|
471
|
+
* - The TECH_DOC service is identified by `frontendType === TECH_DOC`,
|
|
472
|
+
* NOT by service key. This decouples the companion from any
|
|
473
|
+
* convention like `services.docs` — apps may name the service
|
|
474
|
+
* anything (e.g. `'apiDocs'`, `'developerPortal'`).
|
|
475
|
+
*
|
|
476
|
+
* - The saas-config schema's `superRefine` enforces "at most one
|
|
477
|
+
* TECH_DOC service per app", so the lookup either finds exactly
|
|
478
|
+
* one match or zero. Two matches cannot reach this code.
|
|
479
|
+
*
|
|
480
|
+
* - File presence IS the enable signal. A TECH_DOC service without
|
|
481
|
+
* `wildo.tech-doc.config.ts` is a misconfiguration we surface
|
|
482
|
+
* immediately (CONFIGURATION error) rather than letting the OpenAPI
|
|
483
|
+
* generator silently emit a docs-site-incompatible payload.
|
|
484
|
+
*
|
|
485
|
+
* - The Zod validation that rejects unknown keys / malformed values
|
|
486
|
+
* runs inside `defineTechnicalDocConfig` (which the per-service
|
|
487
|
+
* config file invokes via `export default defineTechnicalDocConfig({...})`).
|
|
488
|
+
* `loadConfig` evaluates the file via jiti, so by the time it
|
|
489
|
+
* returns we have an already-parsed `WildoTechnicalDocConfig`.
|
|
490
|
+
*
|
|
491
|
+
* - The config is evaluated for every derivation or publication request.
|
|
492
|
+
* It is an application-owned input outside the companion package's
|
|
493
|
+
* TypeScript watch graph, so a process-lifetime cache would make a valid
|
|
494
|
+
* taxonomy, server or overview edit invisible until an unrelated restart.
|
|
495
|
+
* Publication is infrequent and config loading is tiny beside the source
|
|
496
|
+
* projection, making freshness the correct trade-off.
|
|
497
|
+
*
|
|
498
|
+
* - The `csp?` `@unimplemented` warning fires in the same evaluation
|
|
499
|
+
* pass (also inside `defineTechnicalDocConfig`) — this loader does
|
|
500
|
+
* not need to re-check authored fields.
|
|
501
|
+
*
|
|
502
|
+
* @throws CONFIGURATION error if no TECH_DOC service is declared OR if
|
|
503
|
+
* the per-service config file is missing.
|
|
504
|
+
*/
|
|
505
|
+
private async loadTechnicalDocConfig(): Promise<WildoTechnicalDocConfig> {
|
|
506
|
+
const techDocServiceEntry = Object.entries(this.companionContext.saasConfig.services)
|
|
507
|
+
.find(([, service]) => service.frontendType === AppFrontendType.TECH_DOC);
|
|
508
|
+
|
|
509
|
+
if (!techDocServiceEntry) {
|
|
510
|
+
throw this.errorBuilder.buildError(ErrorType.CONFIGURATION, undefined, {
|
|
511
|
+
customMessageReference: ErrorCustomMessageReference.CONFIGURATION,
|
|
512
|
+
context: {
|
|
513
|
+
message:
|
|
514
|
+
'No frontend service with `frontendType: TECH_DOC` is declared in '
|
|
515
|
+
+ 'wildo.saas.config.ts. The technical-documentation companion routes '
|
|
516
|
+
+ '(diagnostic OpenAPI generation / managed publication) require an authored TECH_DOC service '
|
|
517
|
+
+ 'because that service folder owns the per-service '
|
|
518
|
+
+ '`wildo.tech-doc.config.ts` (publicMarketingTitle, API projection metadata, csp). '
|
|
519
|
+
+ 'Add a TECH_DOC service in wildo.saas.config.ts and ship the per-service '
|
|
520
|
+
+ 'config file under it.',
|
|
521
|
+
},
|
|
522
|
+
});
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
const [techDocServiceKey, techDocService] = techDocServiceEntry;
|
|
526
|
+
const techDocConfigPath = path.resolve(
|
|
527
|
+
this.companionContext.saasRoot,
|
|
528
|
+
techDocService.path,
|
|
529
|
+
PER_SERVICE_TECH_DOC_CONFIG_FILE_NAME,
|
|
530
|
+
);
|
|
531
|
+
|
|
532
|
+
if (!existsSync(techDocConfigPath)) {
|
|
533
|
+
throw this.errorBuilder.buildError(ErrorType.CONFIGURATION, undefined, {
|
|
534
|
+
customMessageReference: ErrorCustomMessageReference.CONFIGURATION,
|
|
535
|
+
context: {
|
|
536
|
+
message:
|
|
537
|
+
`TECH_DOC service '${techDocServiceKey}' is declared in wildo.saas.config.ts `
|
|
538
|
+
+ `but the required per-service config file '${PER_SERVICE_TECH_DOC_CONFIG_FILE_NAME}' `
|
|
539
|
+
+ `is missing under '${techDocService.path}/'. File presence IS the enable signal `
|
|
540
|
+
+ '(the retired `technicalDoc.enabled` setting was replaced by file '
|
|
541
|
+
+ 'presence). Create the file with '
|
|
542
|
+
+ '`export default defineTechnicalDocConfig({ ... })` from '
|
|
543
|
+
+ '`@wildo-ai/saas-technical-doc`.',
|
|
544
|
+
expectedPath: techDocConfigPath,
|
|
545
|
+
},
|
|
546
|
+
});
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
let loaded: WildoTechnicalDocConfig;
|
|
550
|
+
try {
|
|
551
|
+
loaded = await loadConfig<WildoTechnicalDocConfig>(techDocConfigPath);
|
|
552
|
+
} catch (e) {
|
|
553
|
+
throw this.errorBuilder.buildError(ErrorType.CONFIGURATION, undefined, {
|
|
554
|
+
customMessageReference: ErrorCustomMessageReference.CONFIGURATION,
|
|
555
|
+
context: {
|
|
556
|
+
message:
|
|
557
|
+
`Failed to load per-service technical-documentation config at ${techDocConfigPath}. `
|
|
558
|
+
+ 'The file MUST do `export default defineTechnicalDocConfig({...})` and pass '
|
|
559
|
+
+ 'WildoTechnicalDocConfigSchema (`z.strictObject` — unknown keys reject).',
|
|
560
|
+
cause: describeCaughtError(e),
|
|
561
|
+
},
|
|
562
|
+
});
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
return loaded;
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Join source-derived role semantics to the exact primary-language labels
|
|
570
|
+
* used by this application. The labels are not decoration: administrators
|
|
571
|
+
* must see the same role names and descriptions in documentation and in the
|
|
572
|
+
* member-management interface, so an incomplete label unit blocks
|
|
573
|
+
* publication instead of falling back to a prettified role token.
|
|
574
|
+
*/
|
|
575
|
+
private async resolveApplicationOrganizationRoles(
|
|
576
|
+
backendServiceKey: string,
|
|
577
|
+
roles: readonly ApplicationOrganizationRoleDocumentationSource[],
|
|
578
|
+
) {
|
|
579
|
+
const backendService = this.companionContext.servicesByKey[backendServiceKey];
|
|
580
|
+
if (backendService === undefined || backendService.frontendType !== undefined) {
|
|
581
|
+
throw new Error(`technical-documentation role labels require a declared backend service key: ${backendServiceKey}`);
|
|
582
|
+
}
|
|
583
|
+
const primaryLocale = getCompanionConfiguredPrimaryLanguage(this.appConfigService.config);
|
|
584
|
+
const i18nRoot = path.resolve(this.companionContext.saasRoot, backendService.path, 'src/engine/i18n');
|
|
585
|
+
const roleLabelsPath = resolvePerUnitFilePath({
|
|
586
|
+
i18nRoot,
|
|
587
|
+
unit: { filePathHint: ROLE_LABELLING_UNIT_FILE_PATH_HINT },
|
|
588
|
+
localeCode: primaryLocale,
|
|
589
|
+
});
|
|
590
|
+
const primaryLocaleLabels = await readPerUnitLabels(roleLabelsPath);
|
|
591
|
+
return resolveApplicationOrganizationRoleDocumentation(roles, primaryLocaleLabels);
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Pick the first declared backend service key. Same picker
|
|
596
|
+
* pattern as the existing companion services that route to
|
|
597
|
+
* subprocess behaviors on the `library` target — every backend
|
|
598
|
+
* declares the shared library, so any backend service is a
|
|
599
|
+
* valid carrier.
|
|
600
|
+
*/
|
|
601
|
+
private pickProjectorCarrierServiceKey(): string {
|
|
602
|
+
const backendServiceKey = Object.entries(this.companionContext.servicesByKey)
|
|
603
|
+
.find(([, service]) => !service.frontendType)?.[0];
|
|
604
|
+
|
|
605
|
+
if (!backendServiceKey) {
|
|
606
|
+
throw this.errorBuilder.buildError(ErrorType.CONFIGURATION, undefined, {
|
|
607
|
+
customMessageReference: ErrorCustomMessageReference.CONFIGURATION,
|
|
608
|
+
context: {
|
|
609
|
+
message: 'No backend service is available to resolve the openapi-generation-input '
|
|
610
|
+
+ 'introspection behavior. The behavior routes to the `library` target which every '
|
|
611
|
+
+ 'backend service declares — but the companion context has none.',
|
|
612
|
+
},
|
|
613
|
+
});
|
|
614
|
+
}
|
|
615
|
+
return backendServiceKey;
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
private pickFrontendApplicationServiceKey(): string {
|
|
619
|
+
const frontendServiceKey = Object.entries(this.companionContext.servicesByKey)
|
|
620
|
+
.find(([, service]) => service.frontendType === AppFrontendType.SAAS_APP)?.[0];
|
|
621
|
+
if (!frontendServiceKey) throw new Error('technical-documentation frontend runtime evidence requires one SAAS_APP service');
|
|
622
|
+
return frontendServiceKey;
|
|
623
|
+
}
|
|
624
|
+
}
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* Attaches the documentation config's explicit API taxonomy to the resolved
|
|
628
|
+
* resource tags before OpenAPI generation.
|
|
629
|
+
*
|
|
630
|
+
* The operation subprocess owns the resolved resource inventory and
|
|
631
|
+
* specification facts; the TECH_DOC config owns an application's editorial
|
|
632
|
+
* navigation taxonomy. Joining them here keeps both truths in their proper
|
|
633
|
+
* owners, then makes the OpenAPI document the sole transport to the browser.
|
|
634
|
+
* Once an application elects to declare categories, an exact inventory join is
|
|
635
|
+
* required: an uncategorised new resource or a stale config name must stop
|
|
636
|
+
* publication instead of quietly producing a misleading partial navigation.
|
|
637
|
+
*/
|
|
638
|
+
export function applyApiReferenceResourceCategories(
|
|
639
|
+
resourceTags: readonly ResourceTag[],
|
|
640
|
+
categories: WildoTechnicalDocConfig['apiReferenceResourceCategories'],
|
|
641
|
+
): ResourceTag[] {
|
|
642
|
+
if (categories === undefined) return [...resourceTags];
|
|
643
|
+
const tagsByName = new Map(resourceTags.map((tag) => [tag.name, tag]));
|
|
644
|
+
if (tagsByName.size !== resourceTags.length) throw new Error('OpenAPI resource tags must be unique before category assignment');
|
|
645
|
+
|
|
646
|
+
const categoryByResourceName = new Map<string, WildoTechnicalDocConfig['apiReferenceResourceCategories'][number]>();
|
|
647
|
+
const categoryIds = new Set<string>();
|
|
648
|
+
const unavailableResourceNames: string[] = [];
|
|
649
|
+
for (const category of categories) {
|
|
650
|
+
if (categoryIds.has(category.id)) throw new Error(`API-reference category '${category.id}' is declared more than once`);
|
|
651
|
+
categoryIds.add(category.id);
|
|
652
|
+
for (const resourceName of category.resourceNames) {
|
|
653
|
+
if (!tagsByName.has(resourceName)) {
|
|
654
|
+
unavailableResourceNames.push(`${category.id}:${resourceName}`);
|
|
655
|
+
continue;
|
|
656
|
+
}
|
|
657
|
+
const prior = categoryByResourceName.get(resourceName);
|
|
658
|
+
if (prior !== undefined) throw new Error(`API-reference resource '${resourceName}' is assigned to both '${prior.id}' and '${category.id}'`);
|
|
659
|
+
categoryByResourceName.set(resourceName, category);
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
if (unavailableResourceNames.length > 0) {
|
|
663
|
+
throw new Error(`API-reference categories name unavailable resources: ${unavailableResourceNames.sort().join(', ')}`);
|
|
664
|
+
}
|
|
665
|
+
const unassignedResourceNames = [...tagsByName.keys()].filter((resourceName) => !categoryByResourceName.has(resourceName)).sort();
|
|
666
|
+
if (unassignedResourceNames.length > 0) {
|
|
667
|
+
throw new Error(`API-reference resources have no configured category: ${unassignedResourceNames.join(', ')}`);
|
|
668
|
+
}
|
|
669
|
+
return resourceTags.map((tag) => {
|
|
670
|
+
const category = categoryByResourceName.get(tag.name)!;
|
|
671
|
+
return {
|
|
672
|
+
...tag,
|
|
673
|
+
category: {
|
|
674
|
+
id: category.id,
|
|
675
|
+
label: category.label,
|
|
676
|
+
...(category.description === undefined ? {} : { description: category.description }),
|
|
677
|
+
},
|
|
678
|
+
};
|
|
679
|
+
});
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
function isPlainObject(value: unknown): value is Record<string, unknown> {
|
|
683
|
+
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
function isNonNegativeInteger(value: unknown): value is number {
|
|
687
|
+
return typeof value === 'number' && Number.isInteger(value) && value >= 0;
|
|
688
|
+
}
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* Verifies the cross-process conservation boundary before the generator sees
|
|
692
|
+
* the payload. The subprocess records the resolved HTTP inventory before
|
|
693
|
+
* flattening it; this parent-side join prevents a future projector filter,
|
|
694
|
+
* collapse or mapper change from merely adjusting a count while dropping the
|
|
695
|
+
* operation that the count represented.
|
|
696
|
+
*/
|
|
697
|
+
function assertResolvedHttpOperationProjectionConservation(output: OpenApiGenerationInputSubprocessOutput): void {
|
|
698
|
+
const key = (entry: {
|
|
699
|
+
readonly identity: {
|
|
700
|
+
readonly contractVersion: number;
|
|
701
|
+
readonly resourceRef: string;
|
|
702
|
+
readonly operationFamilyRef: string;
|
|
703
|
+
readonly operationVariantRef: string;
|
|
704
|
+
readonly variantType: string;
|
|
705
|
+
readonly httpVerb: string;
|
|
706
|
+
readonly path: string;
|
|
707
|
+
};
|
|
708
|
+
readonly section: string;
|
|
709
|
+
readonly roles: readonly string[];
|
|
710
|
+
}): string => JSON.stringify([
|
|
711
|
+
entry.identity.contractVersion,
|
|
712
|
+
entry.identity.resourceRef,
|
|
713
|
+
entry.identity.operationFamilyRef,
|
|
714
|
+
entry.identity.operationVariantRef,
|
|
715
|
+
entry.identity.variantType,
|
|
716
|
+
entry.identity.httpVerb,
|
|
717
|
+
entry.identity.path,
|
|
718
|
+
entry.section,
|
|
719
|
+
entry.roles,
|
|
720
|
+
]);
|
|
721
|
+
const source = new Set(output.stats.resolvedExternalHttpOperations.map(key));
|
|
722
|
+
const projections = new Set(output.operations.map((operation) => key({
|
|
723
|
+
identity: operation.identity,
|
|
724
|
+
section: operation.consumerApiSection,
|
|
725
|
+
roles: operation.roles,
|
|
726
|
+
})));
|
|
727
|
+
if (
|
|
728
|
+
source.size !== output.stats.resolvedExternalHttpOperations.length
|
|
729
|
+
|| projections.size !== output.operations.length
|
|
730
|
+
|| source.size !== projections.size
|
|
731
|
+
|| [...source].some((entry) => !projections.has(entry))
|
|
732
|
+
) {
|
|
733
|
+
throw new Error('openapi-generation-input subprocess violated resolved HTTP operation → projection conservation');
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
/** Validate the complete diagnostics object received from the subprocess. */
|
|
738
|
+
function isOpenApiGenerationProjectorStats(value: unknown): value is OpenApiGenerationProjectorStats {
|
|
739
|
+
if (!isPlainObject(value)) return false;
|
|
740
|
+
if (
|
|
741
|
+
!isNonNegativeInteger(value.resourceCount)
|
|
742
|
+
|| !isNonNegativeInteger(value.consideredOperationCount)
|
|
743
|
+
|| !isNonNegativeInteger(value.projectedRowCount)
|
|
744
|
+
|| !Array.isArray(value.resolvedExternalHttpOperations)
|
|
745
|
+
|| !isNonNegativeInteger(value.skippedOperationWithoutInitiatorInfosCount)
|
|
746
|
+
|| !Array.isArray(value.skippedOperationsWithoutInitiatorInfos)
|
|
747
|
+
) {
|
|
748
|
+
return false;
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
if (
|
|
752
|
+
value.resolvedExternalHttpOperations.length !== value.projectedRowCount
|
|
753
|
+
|| !value.resolvedExternalHttpOperations.every((entry) =>
|
|
754
|
+
isPlainObject(entry)
|
|
755
|
+
&& isPlainObject(entry.identity)
|
|
756
|
+
&& typeof entry.section === 'string'
|
|
757
|
+
&& Array.isArray(entry.roles)
|
|
758
|
+
&& entry.roles.every((role) => typeof role === 'string'))
|
|
759
|
+
) {
|
|
760
|
+
return false;
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
if (
|
|
764
|
+
value.excludedCoreResources !== undefined
|
|
765
|
+
&& (
|
|
766
|
+
!Array.isArray(value.excludedCoreResources)
|
|
767
|
+
|| !value.excludedCoreResources.every((entry) =>
|
|
768
|
+
typeof entry === 'string' && Object.values(CoreResourceType).includes(entry as CoreResourceType))
|
|
769
|
+
)
|
|
770
|
+
) {
|
|
771
|
+
return false;
|
|
772
|
+
}
|
|
773
|
+
if (!value.skippedOperationsWithoutInitiatorInfos.every((entry) =>
|
|
774
|
+
isPlainObject(entry)
|
|
775
|
+
&& typeof entry.resourceIdentifier === 'string'
|
|
776
|
+
&& typeof entry.operationIdentifier === 'string'
|
|
777
|
+
&& typeof entry.variantType === 'string'
|
|
778
|
+
&& (entry.variantKey === undefined || typeof entry.variantKey === 'string')
|
|
779
|
+
&& (entry.isOperationDefault === undefined || typeof entry.isOperationDefault === 'boolean')
|
|
780
|
+
&& (entry.isBulkOperation === undefined || typeof entry.isBulkOperation === 'boolean'))) {
|
|
781
|
+
return false;
|
|
782
|
+
}
|
|
783
|
+
if (
|
|
784
|
+
value.skippedCoreResources !== undefined
|
|
785
|
+
&& (
|
|
786
|
+
!Array.isArray(value.skippedCoreResources)
|
|
787
|
+
|| !value.skippedCoreResources.every((entry) => isPlainObject(entry) && typeof entry.resourceType === 'string' && typeof entry.reason === 'string')
|
|
788
|
+
)
|
|
789
|
+
) {
|
|
790
|
+
return false;
|
|
791
|
+
}
|
|
792
|
+
if (
|
|
793
|
+
value.collapsedCoreOperations !== undefined
|
|
794
|
+
&& (
|
|
795
|
+
!Array.isArray(value.collapsedCoreOperations)
|
|
796
|
+
|| !value.collapsedCoreOperations.every((entry) =>
|
|
797
|
+
isPlainObject(entry)
|
|
798
|
+
&& typeof entry.resourceType === 'string'
|
|
799
|
+
&& typeof entry.operationKey === 'string'
|
|
800
|
+
&& typeof entry.httpVerb === 'string'
|
|
801
|
+
&& typeof entry.path === 'string')
|
|
802
|
+
)
|
|
803
|
+
) {
|
|
804
|
+
return false;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
return true;
|
|
808
|
+
}
|
|
809
|
+
```
|