@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.
Files changed (922) hide show
  1. package/LICENSE +34 -0
  2. package/dist/esm/.builder.pid +9 -0
  3. package/dist/esm/framework-knowledge.definitions.d.ts +51 -0
  4. package/dist/esm/framework-knowledge.definitions.d.ts.map +1 -0
  5. package/dist/esm/framework-knowledge.definitions.js +1571 -0
  6. package/dist/esm/framework-knowledge.definitions.js.map +1 -0
  7. package/dist/esm/framework-knowledge.loader.d.ts +72 -0
  8. package/dist/esm/framework-knowledge.loader.d.ts.map +1 -0
  9. package/dist/esm/framework-knowledge.loader.js +258 -0
  10. package/dist/esm/framework-knowledge.loader.js.map +1 -0
  11. package/dist/esm/framework-knowledge.schemas.d.ts +236 -0
  12. package/dist/esm/framework-knowledge.schemas.d.ts.map +1 -0
  13. package/dist/esm/framework-knowledge.schemas.js +23 -0
  14. package/dist/esm/framework-knowledge.schemas.js.map +1 -0
  15. package/dist/esm/index.d.ts +4 -0
  16. package/dist/esm/index.d.ts.map +1 -0
  17. package/dist/esm/index.js +4 -0
  18. package/dist/esm/index.js.map +1 -0
  19. package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +53 -0
  20. package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts.map +1 -0
  21. package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js +56 -0
  22. package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js.map +1 -0
  23. package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts +200 -0
  24. package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts.map +1 -0
  25. package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js +228 -0
  26. package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js.map +1 -0
  27. package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts +39 -0
  28. package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts.map +1 -0
  29. package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js +39 -0
  30. package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js.map +1 -0
  31. package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts +261 -0
  32. package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts.map +1 -0
  33. package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js +412 -0
  34. package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js.map +1 -0
  35. package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts +61 -0
  36. package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -0
  37. package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +65 -0
  38. package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js.map +1 -0
  39. package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts +53 -0
  40. package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.d.ts.map +1 -0
  41. package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js +54 -0
  42. package/dist/esm/playbooks/bottom_up.placement-plan/playbook.definition.js.map +1 -0
  43. package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts +43 -0
  44. package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.d.ts.map +1 -0
  45. package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js +73 -0
  46. package/dist/esm/playbooks/refinement.compliance-document-candidate/playbook.definition.js.map +1 -0
  47. package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts +53 -0
  48. package/dist/esm/playbooks/refinement.document-facts/playbook.definition.d.ts.map +1 -0
  49. package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js +114 -0
  50. package/dist/esm/playbooks/refinement.document-facts/playbook.definition.js.map +1 -0
  51. package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts +95 -0
  52. package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts.map +1 -0
  53. package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js +102 -0
  54. package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js.map +1 -0
  55. package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts +258 -0
  56. package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts.map +1 -0
  57. package/dist/esm/playbooks/top_down.business-model/playbook.definition.js +241 -0
  58. package/dist/esm/playbooks/top_down.business-model/playbook.definition.js.map +1 -0
  59. package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts +241 -0
  60. package/dist/esm/playbooks/top_down.capability-map/playbook.definition.d.ts.map +1 -0
  61. package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js +202 -0
  62. package/dist/esm/playbooks/top_down.capability-map/playbook.definition.js.map +1 -0
  63. package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +82 -0
  64. package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts.map +1 -0
  65. package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js +89 -0
  66. package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js.map +1 -0
  67. package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts +56 -0
  68. package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.d.ts.map +1 -0
  69. package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js +76 -0
  70. package/dist/esm/playbooks/top_down.market-analysis/playbook.definition.js.map +1 -0
  71. package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts +30 -0
  72. package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.d.ts.map +1 -0
  73. package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js +27 -0
  74. package/dist/esm/playbooks/top_down.market-evidence-adequacy/playbook.definition.js.map +1 -0
  75. package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts +31 -0
  76. package/dist/esm/playbooks/top_down.market-research/playbook.definition.d.ts.map +1 -0
  77. package/dist/esm/playbooks/top_down.market-research/playbook.definition.js +26 -0
  78. package/dist/esm/playbooks/top_down.market-research/playbook.definition.js.map +1 -0
  79. package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts +254 -0
  80. package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.d.ts.map +1 -0
  81. package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js +219 -0
  82. package/dist/esm/playbooks/top_down.market-snapshot-produce/playbook.definition.js.map +1 -0
  83. package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts +180 -0
  84. package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts.map +1 -0
  85. package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js +302 -0
  86. package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js.map +1 -0
  87. package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts +249 -0
  88. package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.d.ts.map +1 -0
  89. package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js +286 -0
  90. package/dist/esm/playbooks/top_down.requirements-definition/playbook.definition.js.map +1 -0
  91. package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts +248 -0
  92. package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts.map +1 -0
  93. package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js +227 -0
  94. package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js.map +1 -0
  95. package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts +45 -0
  96. package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.d.ts.map +1 -0
  97. package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js +48 -0
  98. package/dist/esm/playbooks/top_down.value-proposition/playbook.definition.js.map +1 -0
  99. package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts +250 -0
  100. package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts.map +1 -0
  101. package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js +218 -0
  102. package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js.map +1 -0
  103. package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/authority-basis.json +1 -0
  104. package/dist/knowledge/manifest.json +45 -0
  105. package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +407 -0
  106. package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +69 -0
  107. package/dist/knowledge/playbooks/bottom_up.build-dispatch/evaluation-protocol.json +1 -0
  108. package/dist/knowledge/playbooks/bottom_up.build-dispatch/evaluation-treatment.json +1 -0
  109. package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +556 -0
  110. package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +47 -0
  111. package/dist/knowledge/playbooks/bottom_up.build-scale/method.md +344 -0
  112. package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +43 -0
  113. package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-protocol.json +1 -0
  114. package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-treatment.json +1 -0
  115. package/dist/knowledge/playbooks/bottom_up.domain-plan/method.md +259 -0
  116. package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +83 -0
  117. package/dist/knowledge/playbooks/bottom_up.domain-plan/structured-artifact-action.json +1 -0
  118. package/dist/knowledge/playbooks/bottom_up.foundation/method.md +321 -0
  119. package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +79 -0
  120. package/dist/knowledge/playbooks/bottom_up.placement-plan/method.md +185 -0
  121. package/dist/knowledge/playbooks/bottom_up.placement-plan/playbook.json +66 -0
  122. package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +737 -0
  123. package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +44 -0
  124. package/dist/knowledge/playbooks/refinement.document-facts/method.md +261 -0
  125. package/dist/knowledge/playbooks/refinement.document-facts/playbook.json +57 -0
  126. package/dist/knowledge/playbooks/top_down.brand-identity/method.md +151 -0
  127. package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +124 -0
  128. package/dist/knowledge/playbooks/top_down.business-model/evaluation-protocol.json +1 -0
  129. package/dist/knowledge/playbooks/top_down.business-model/evaluation-treatment.json +1 -0
  130. package/dist/knowledge/playbooks/top_down.business-model/method.md +128 -0
  131. package/dist/knowledge/playbooks/top_down.business-model/playbook.json +102 -0
  132. package/dist/knowledge/playbooks/top_down.business-model/structured-artifact-action.json +1 -0
  133. package/dist/knowledge/playbooks/top_down.capability-map/evaluation-protocol.json +1 -0
  134. package/dist/knowledge/playbooks/top_down.capability-map/evaluation-treatment.json +1 -0
  135. package/dist/knowledge/playbooks/top_down.capability-map/method.md +239 -0
  136. package/dist/knowledge/playbooks/top_down.capability-map/playbook.json +73 -0
  137. package/dist/knowledge/playbooks/top_down.capability-map/structured-artifact-action.json +1 -0
  138. package/dist/knowledge/playbooks/top_down.compliance-posture/method.md +177 -0
  139. package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +95 -0
  140. package/dist/knowledge/playbooks/top_down.market-analysis/method.md +64 -0
  141. package/dist/knowledge/playbooks/top_down.market-analysis/playbook.json +49 -0
  142. package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/method.md +56 -0
  143. package/dist/knowledge/playbooks/top_down.market-evidence-adequacy/playbook.json +40 -0
  144. package/dist/knowledge/playbooks/top_down.market-research/method.md +68 -0
  145. package/dist/knowledge/playbooks/top_down.market-research/playbook.json +42 -0
  146. package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-protocol.json +1 -0
  147. package/dist/knowledge/playbooks/top_down.market-snapshot-produce/evaluation-treatment.json +1 -0
  148. package/dist/knowledge/playbooks/top_down.market-snapshot-produce/method.md +239 -0
  149. package/dist/knowledge/playbooks/top_down.market-snapshot-produce/playbook.json +69 -0
  150. package/dist/knowledge/playbooks/top_down.market-snapshot-produce/structured-artifact-action.json +1 -0
  151. package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-protocol.json +1 -0
  152. package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-treatment.json +1 -0
  153. package/dist/knowledge/playbooks/top_down.phase-gate/method.md +96 -0
  154. package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +77 -0
  155. package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-protocol.json +1 -0
  156. package/dist/knowledge/playbooks/top_down.requirements-definition/evaluation-treatment.json +1 -0
  157. package/dist/knowledge/playbooks/top_down.requirements-definition/method.md +53 -0
  158. package/dist/knowledge/playbooks/top_down.requirements-definition/playbook.json +61 -0
  159. package/dist/knowledge/playbooks/top_down.requirements-definition/structured-artifact-action.json +1 -0
  160. package/dist/knowledge/playbooks/top_down.scope-roadmap/evaluation-protocol.json +1 -0
  161. package/dist/knowledge/playbooks/top_down.scope-roadmap/evaluation-treatment.json +1 -0
  162. package/dist/knowledge/playbooks/top_down.scope-roadmap/method.md +280 -0
  163. package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +87 -0
  164. package/dist/knowledge/playbooks/top_down.scope-roadmap/structured-artifact-action.json +1 -0
  165. package/dist/knowledge/playbooks/top_down.value-proposition/method.md +204 -0
  166. package/dist/knowledge/playbooks/top_down.value-proposition/playbook.json +54 -0
  167. package/dist/knowledge/playbooks/top_down.vision-elicitation/evaluation-protocol.json +1 -0
  168. package/dist/knowledge/playbooks/top_down.vision-elicitation/evaluation-treatment.json +1 -0
  169. package/dist/knowledge/playbooks/top_down.vision-elicitation/method.md +146 -0
  170. package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +120 -0
  171. package/dist/knowledge/playbooks/top_down.vision-elicitation/structured-artifact-action.json +1 -0
  172. package/dist/knowledge/references/application.database.migration-change-risk.md +28 -0
  173. package/dist/knowledge/references/assertions.authored-metadata.config.md +90 -0
  174. package/dist/knowledge/references/assertions.behaviors.wire-contracts.md +223 -0
  175. package/dist/knowledge/references/assertions.references.conventions.md +92 -0
  176. package/dist/knowledge/references/assertions.snapshot.validation.md +317 -0
  177. package/dist/knowledge/references/assertions.specification.config.md +287 -0
  178. package/dist/knowledge/references/brand.asset.config.md +167 -0
  179. package/dist/knowledge/references/brand.authored-metadata.config.md +51 -0
  180. package/dist/knowledge/references/brand.logo-direction.config.md +88 -0
  181. package/dist/knowledge/references/brand.name.config.md +46 -0
  182. package/dist/knowledge/references/brand.snapshot.config.md +76 -0
  183. package/dist/knowledge/references/brand.snapshot.validation.md +446 -0
  184. package/dist/knowledge/references/brand.visual-tone.config.md +56 -0
  185. package/dist/knowledge/references/build-plan.task-graph.config.md +198 -0
  186. package/dist/knowledge/references/business-model.authored-metadata.config.md +65 -0
  187. package/dist/knowledge/references/business-model.pricing-plan.config.md +122 -0
  188. package/dist/knowledge/references/business-model.references.conventions.md +99 -0
  189. package/dist/knowledge/references/business-model.snapshot.config.md +121 -0
  190. package/dist/knowledge/references/business-model.snapshot.validation.md +325 -0
  191. package/dist/knowledge/references/cli.market.generate-command.md +230 -0
  192. package/dist/knowledge/references/cli.market.utils.md +147 -0
  193. package/dist/knowledge/references/companion.introspection.behaviors.market.md +90 -0
  194. package/dist/knowledge/references/companion.introspection.handlers.market.md +42 -0
  195. package/dist/knowledge/references/companion.market.generation-service.md +270 -0
  196. package/dist/knowledge/references/companion.market.prompt-renderer.md +244 -0
  197. package/dist/knowledge/references/companion.technical-doc.service.md +809 -0
  198. package/dist/knowledge/references/engine.client-bundle.allow-list.md +125 -0
  199. package/dist/knowledge/references/engine.client-bundle.discipline.md +130 -0
  200. package/dist/knowledge/references/engine.client-bundle.external-connectors-public.discipline.md +55 -0
  201. package/dist/knowledge/references/engine.saas-technical-doc.config.md +215 -0
  202. package/dist/knowledge/references/engine.saas-website.config.md +331 -0
  203. package/dist/knowledge/references/example.authorization.unit-narrowing.declaration.md +24 -0
  204. package/dist/knowledge/references/example.backend.addon-wiring.module.md +55 -0
  205. package/dist/knowledge/references/example.backend.custom-operation.create-postfix.md +35 -0
  206. package/dist/knowledge/references/example.backend.operation.error-throw.md +17 -0
  207. package/dist/knowledge/references/example.config.app-shell.command-menu-items.md +63 -0
  208. package/dist/knowledge/references/example.config.app-shell.full.md +147 -0
  209. package/dist/knowledge/references/example.config.app-shell.hosted-components.md +45 -0
  210. package/dist/knowledge/references/example.config.app-shell.quick-switcher-fields.md +37 -0
  211. package/dist/knowledge/references/example.config.backend.billing-enable.md +20 -0
  212. package/dist/knowledge/references/example.config.backend.required-floors.md +46 -0
  213. package/dist/knowledge/references/example.config.design-system.full.md +162 -0
  214. package/dist/knowledge/references/example.config.navigation.full.md +71 -0
  215. package/dist/knowledge/references/example.config.provider.backend-scope-billing.md +27 -0
  216. package/dist/knowledge/references/example.data-seeding.minimal.md +114 -0
  217. package/dist/knowledge/references/example.email.template.minimal.md +54 -0
  218. package/dist/knowledge/references/example.engine.component-registration.lazy-load.md +16 -0
  219. package/dist/knowledge/references/example.engine.product-definitions.feature-and-profiles.md +146 -0
  220. package/dist/knowledge/references/example.flows-actors.chat-assistant.md +196 -0
  221. package/dist/knowledge/references/example.flows-actors.llm-agent-one-shot.md +174 -0
  222. package/dist/knowledge/references/example.i18n.label-generation.engine-barrel.md +15 -0
  223. package/dist/knowledge/references/example.infra.cdn.cloudflare.md +23 -0
  224. package/dist/knowledge/references/example.infra.cdn.generic.md +17 -0
  225. package/dist/knowledge/references/example.infra.environment-config.local.md +250 -0
  226. package/dist/knowledge/references/example.market.alternative.in-house-build.md +49 -0
  227. package/dist/knowledge/references/example.market.authored-metadata.md +32 -0
  228. package/dist/knowledge/references/example.market.buying-journey.core-icp.md +140 -0
  229. package/dist/knowledge/references/example.market.category.config.md +71 -0
  230. package/dist/knowledge/references/example.market.channel.community.md +39 -0
  231. package/dist/knowledge/references/example.market.feature-benefit.kano-threshold.md +67 -0
  232. package/dist/knowledge/references/example.market.feature-benefit.pain-reliever.md +65 -0
  233. package/dist/knowledge/references/example.market.icp.anti-target.md +47 -0
  234. package/dist/knowledge/references/example.market.icp.individual.md +82 -0
  235. package/dist/knowledge/references/example.market.icp.legal-entity-with-geographies.md +95 -0
  236. package/dist/knowledge/references/example.market.is-benefit-available.composition.md +40 -0
  237. package/dist/knowledge/references/example.market.job.emotional.md +27 -0
  238. package/dist/knowledge/references/example.market.job.functional.md +28 -0
  239. package/dist/knowledge/references/example.market.message-template.seeds.md +106 -0
  240. package/dist/knowledge/references/example.market.objection.pricing.md +39 -0
  241. package/dist/knowledge/references/example.market.persona.dmu-with-inheritance.md +62 -0
  242. package/dist/knowledge/references/example.market.persona.individual-self.md +51 -0
  243. package/dist/knowledge/references/example.market.positioning.per-icp.md +103 -0
  244. package/dist/knowledge/references/example.market.proof.metric.md +39 -0
  245. package/dist/knowledge/references/example.market.scoring.golden-case.md +46 -0
  246. package/dist/knowledge/references/example.market.scoring.no-coverage-zero.md +40 -0
  247. package/dist/knowledge/references/example.market.snapshot-validation.duplicate-journey-stage.md +36 -0
  248. package/dist/knowledge/references/example.market.snapshot-validation.errors-by-kind.md +55 -0
  249. package/dist/knowledge/references/example.market.snapshot-validation.objection-proof-benefit-mismatch.md +74 -0
  250. package/dist/knowledge/references/example.market.snapshot-validation.proof-without-support.md +32 -0
  251. package/dist/knowledge/references/example.market.snapshot-validation.threshold-without-job.md +44 -0
  252. package/dist/knowledge/references/example.market.snapshot.assembled.md +49 -0
  253. package/dist/knowledge/references/example.market.tone-of-voice.config.md +41 -0
  254. package/dist/knowledge/references/example.market.trigger.growth-milestone.md +43 -0
  255. package/dist/knowledge/references/example.module.companion-exports.full.md +142 -0
  256. package/dist/knowledge/references/example.module.registration.shared.md +16 -0
  257. package/dist/knowledge/references/example.module.relationships.actor-edge-back-to-scope-owner.md +47 -0
  258. package/dist/knowledge/references/example.module.relationships.discriminator.md +25 -0
  259. package/dist/knowledge/references/example.module.relationships.scope-membership-junction.md +25 -0
  260. package/dist/knowledge/references/example.provider.backend-module-shape.md +110 -0
  261. package/dist/knowledge/references/example.provider.contribution.backend-billing.md +12 -0
  262. package/dist/knowledge/references/example.provider.frontend-file-picker.contribution.md +30 -0
  263. package/dist/knowledge/references/example.provider.frontend-file-picker.module.md +21 -0
  264. package/dist/knowledge/references/example.rag.source-fields.declaration.md +83 -0
  265. package/dist/knowledge/references/example.rate-limit.custom-controller-surface.md +25 -0
  266. package/dist/knowledge/references/example.rate-limit.resource-operation-surface.md +24 -0
  267. package/dist/knowledge/references/example.resource.add-field.priority-enum.md +19 -0
  268. package/dist/knowledge/references/example.resource.add-resource.module-factory-map.md +21 -0
  269. package/dist/knowledge/references/example.resource.config-wiring.fk-relationship.md +33 -0
  270. package/dist/knowledge/references/example.resource.custom-view.read-host.md +28 -0
  271. package/dist/knowledge/references/example.resource.mcp-exposure.md +65 -0
  272. package/dist/knowledge/references/example.resource.reference-constraints.role-constrained.md +27 -0
  273. package/dist/knowledge/references/example.resource.ui-behavior.enum-badge.md +22 -0
  274. package/dist/knowledge/references/example.resource.ui-behavior.operation-icon.md +43 -0
  275. package/dist/knowledge/references/example.spec.composite-view.workspace.md +72 -0
  276. package/dist/knowledge/references/example.spec.feature.flag-with-codehandling.md +64 -0
  277. package/dist/knowledge/references/example.spec.frontend-component.prop-vocabulary.md +88 -0
  278. package/dist/knowledge/references/example.spec.resource.semantic-field.md +23 -0
  279. package/dist/knowledge/references/example.views.app-level.composite-views-config.md +19 -0
  280. package/dist/knowledge/references/example.views.chart-view.resource-owned.md +69 -0
  281. package/dist/knowledge/references/example.views.composite-view.host-embeds.md +31 -0
  282. package/dist/knowledge/references/example.views.composite-view.workspace.md +65 -0
  283. package/dist/knowledge/references/example.views.custom-view.execution-host.md +41 -0
  284. package/dist/knowledge/references/example.views.execution-view.resource-owned.md +25 -0
  285. package/dist/knowledge/references/external-connectors.app.frontend-provider-module.md +42 -0
  286. package/dist/knowledge/references/market.alternative.config.md +68 -0
  287. package/dist/knowledge/references/market.alternative.kind.md +32 -0
  288. package/dist/knowledge/references/market.authored-metadata.config.md +64 -0
  289. package/dist/knowledge/references/market.buying-journey.config.md +43 -0
  290. package/dist/knowledge/references/market.buying-journey.stage.md +33 -0
  291. package/dist/knowledge/references/market.category.config.md +63 -0
  292. package/dist/knowledge/references/market.channel.config.md +59 -0
  293. package/dist/knowledge/references/market.channel.kind.md +49 -0
  294. package/dist/knowledge/references/market.context-block.builder.md +544 -0
  295. package/dist/knowledge/references/market.context-block.response.md +57 -0
  296. package/dist/knowledge/references/market.feature-benefit.config.md +84 -0
  297. package/dist/knowledge/references/market.feature-benefit.kano.md +41 -0
  298. package/dist/knowledge/references/market.gain.config.md +50 -0
  299. package/dist/knowledge/references/market.generation.response.md +108 -0
  300. package/dist/knowledge/references/market.icp.config.md +162 -0
  301. package/dist/knowledge/references/market.icp.geographic-targeting.md +57 -0
  302. package/dist/knowledge/references/market.inherit-from.md +74 -0
  303. package/dist/knowledge/references/market.is-benefit-available.md +58 -0
  304. package/dist/knowledge/references/market.job.config.md +48 -0
  305. package/dist/knowledge/references/market.message-template.config.md +86 -0
  306. package/dist/knowledge/references/market.objection.config.md +56 -0
  307. package/dist/knowledge/references/market.objection.kind.md +34 -0
  308. package/dist/knowledge/references/market.pain.config.md +50 -0
  309. package/dist/knowledge/references/market.persona.config.md +64 -0
  310. package/dist/knowledge/references/market.positioning.config.md +84 -0
  311. package/dist/knowledge/references/market.proof.config.md +48 -0
  312. package/dist/knowledge/references/market.proof.kind.md +34 -0
  313. package/dist/knowledge/references/market.references.weighted-edges.md +105 -0
  314. package/dist/knowledge/references/market.scoring.fit.md +215 -0
  315. package/dist/knowledge/references/market.snapshot.config.md +34 -0
  316. package/dist/knowledge/references/market.snapshot.validation.md +1171 -0
  317. package/dist/knowledge/references/market.tone-of-voice.config.md +80 -0
  318. package/dist/knowledge/references/market.trigger.config.md +45 -0
  319. package/dist/knowledge/references/market.trigger.kind.md +35 -0
  320. package/dist/knowledge/references/placement-plan.config.md +330 -0
  321. package/dist/knowledge/references/platform.config.application-database.md +74 -0
  322. package/dist/knowledge/references/platform.config.application-modules.md +30 -0
  323. package/dist/knowledge/references/platform.config.backing-services.md +266 -0
  324. package/dist/knowledge/references/platform.config.cdn.md +167 -0
  325. package/dist/knowledge/references/platform.config.environment.deployment.md +263 -0
  326. package/dist/knowledge/references/platform.config.saas.md +405 -0
  327. package/dist/knowledge/references/presets.models.design-system.configuration.md +59 -0
  328. package/dist/knowledge/references/presets.models.design-system.source-config.md +72 -0
  329. package/dist/knowledge/references/presets.models.labelling.sections.md +64 -0
  330. package/dist/knowledge/references/presets.models.material.profile-contract.md +192 -0
  331. package/dist/knowledge/references/presets.models.material.runtime-policy.md +60 -0
  332. package/dist/knowledge/references/presets.models.surface-policy.defaults.md +613 -0
  333. package/dist/knowledge/references/presets.models.surface-policy.md +534 -0
  334. package/dist/knowledge/references/presets.models.surface-variant.md +56 -0
  335. package/dist/knowledge/references/requirements.authored-metadata.config.md +64 -0
  336. package/dist/knowledge/references/requirements.functional-requirement.config.md +68 -0
  337. package/dist/knowledge/references/requirements.non-functional-requirement.config.md +100 -0
  338. package/dist/knowledge/references/requirements.references.conventions.md +125 -0
  339. package/dist/knowledge/references/requirements.snapshot.config.md +73 -0
  340. package/dist/knowledge/references/requirements.snapshot.validation.md +333 -0
  341. package/dist/knowledge/references/roadmap.authored-metadata.config.md +64 -0
  342. package/dist/knowledge/references/roadmap.phase.config.md +149 -0
  343. package/dist/knowledge/references/roadmap.references.conventions.md +89 -0
  344. package/dist/knowledge/references/roadmap.snapshot.config.md +65 -0
  345. package/dist/knowledge/references/roadmap.snapshot.validation.md +325 -0
  346. package/dist/knowledge/references/saas.backend.app-config.backend-authored.md +32 -0
  347. package/dist/knowledge/references/saas.backend.application-initialization.assembly.md +38 -0
  348. package/dist/knowledge/references/saas.backend.billing.resolution-failure-reasons.md +45 -0
  349. package/dist/knowledge/references/saas.backend.custom-operation.authoritative-fields.md +53 -0
  350. package/dist/knowledge/references/saas.backend.custom-operation.transactional-core.md +120 -0
  351. package/dist/knowledge/references/saas.backend.domain-module.md +237 -0
  352. package/dist/knowledge/references/saas.backend.email-template.definition.md +69 -0
  353. package/dist/knowledge/references/saas.backend.flows-actors.a2a-agent-card.md +89 -0
  354. package/dist/knowledge/references/saas.backend.flows-actors.a2a-task-surface.md +118 -0
  355. package/dist/knowledge/references/saas.backend.flows-actors.function-tool.md +82 -0
  356. package/dist/knowledge/references/saas.backend.flows-actors.invoke-agent.md +48 -0
  357. package/dist/knowledge/references/saas.backend.flows-actors.resource-read-tool.md +39 -0
  358. package/dist/knowledge/references/saas.backend.flows-actors.resource-write-tool.md +67 -0
  359. package/dist/knowledge/references/saas.backend.pdf-template.bindings.md +52 -0
  360. package/dist/knowledge/references/saas.backend.pdf-template.definition.md +113 -0
  361. package/dist/knowledge/references/saas.backend.rate-limit-service.check-policy.md +75 -0
  362. package/dist/knowledge/references/saas.backend.system-access-service.md +994 -0
  363. package/dist/knowledge/references/saas.data-seeding.admin-endpoints.md +59 -0
  364. package/dist/knowledge/references/saas.data-seeding.bootstrap-wiring.md +184 -0
  365. package/dist/knowledge/references/saas.data-seeding.definition-input.md +95 -0
  366. package/dist/knowledge/references/saas.data-seeding.modes.md +72 -0
  367. package/dist/knowledge/references/saas.data-seeding.run-ledger.md +198 -0
  368. package/dist/knowledge/references/saas.data-seeding.run-status.md +35 -0
  369. package/dist/knowledge/references/saas.data-seeding.schedule.md +91 -0
  370. package/dist/knowledge/references/saas.data-seeding.scope-iteration-strategy.md +46 -0
  371. package/dist/knowledge/references/saas.external-providers.backend-provider-registry.runtime-filter.md +55 -0
  372. package/dist/knowledge/references/saas.external-providers.document-extraction.applicability.md +26 -0
  373. package/dist/knowledge/references/saas.external-providers.embeddings.applicability.md +30 -0
  374. package/dist/knowledge/references/saas.external-providers.llm.model-configuration.md +124 -0
  375. package/dist/knowledge/references/saas.external-providers.llm.operation-key.md +49 -0
  376. package/dist/knowledge/references/saas.frontend.app-level-component.configuration.md +265 -0
  377. package/dist/knowledge/references/saas.frontend.app-level-component.vocabulary.md +148 -0
  378. package/dist/knowledge/references/saas.frontend.app-shell.hosted-components.md +145 -0
  379. package/dist/knowledge/references/saas.frontend.chart-view.inserted-declaration.md +80 -0
  380. package/dist/knowledge/references/saas.frontend.command-menu.omnibox.md +88 -0
  381. package/dist/knowledge/references/saas.frontend.command-menu.search-resource.md +109 -0
  382. package/dist/knowledge/references/saas.frontend.component-registration.entry.md +21 -0
  383. package/dist/knowledge/references/saas.frontend.composite-view.authoring.md +102 -0
  384. package/dist/knowledge/references/saas.frontend.composite-view.define-helper.md +31 -0
  385. package/dist/knowledge/references/saas.frontend.domain-module.md +31 -0
  386. package/dist/knowledge/references/saas.frontend.embedded-resource-descent.md +37 -0
  387. package/dist/knowledge/references/saas.frontend.execution-view.action-status-contract.md +172 -0
  388. package/dist/knowledge/references/saas.frontend.execution-view.action-status-contract.per-action-retry-loop.md +115 -0
  389. package/dist/knowledge/references/saas.frontend.execution-view.definition.md +172 -0
  390. package/dist/knowledge/references/saas.frontend.execution-view.dirty-bridge-contract.local-pane.md +109 -0
  391. package/dist/knowledge/references/saas.frontend.execution-view.dirty-bridge-contract.md +55 -0
  392. package/dist/knowledge/references/saas.frontend.execution-view.dirty-state-contract.md +151 -0
  393. package/dist/knowledge/references/saas.frontend.execution-view.failure-handling-contract.md +302 -0
  394. package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.md +89 -0
  395. package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.participation-prefetch.md +231 -0
  396. package/dist/knowledge/references/saas.frontend.execution-view.loading-aggregation.participation-prefetch.shell-data-hydrator.md +174 -0
  397. package/dist/knowledge/references/saas.frontend.execution-view.navigation-handling-and-embedding.md +96 -0
  398. package/dist/knowledge/references/saas.frontend.execution-view.navigation-handling-and-embedding.resolution.md +45 -0
  399. package/dist/knowledge/references/saas.frontend.execution-view.outcome-emission-contract.md +71 -0
  400. package/dist/knowledge/references/saas.frontend.execution-view.participation-and-anchor.md +80 -0
  401. package/dist/knowledge/references/saas.frontend.execution-view.three-zone-contract.md +147 -0
  402. package/dist/knowledge/references/saas.frontend.flows-actors-view.md +40 -0
  403. package/dist/knowledge/references/saas.frontend.form-fields.file-provider-constraints.md +80 -0
  404. package/dist/knowledge/references/saas.frontend.full-custom-view.definition.md +64 -0
  405. package/dist/knowledge/references/saas.frontend.inserted-view.identity-bindings-descriptor.md +149 -0
  406. package/dist/knowledge/references/saas.frontend.operation-key-and-resource-config-like.md +63 -0
  407. package/dist/knowledge/references/saas.frontend.quick-switcher.scope-field.md +102 -0
  408. package/dist/knowledge/references/saas.frontend.related-resource-embeds.md +86 -0
  409. package/dist/knowledge/references/saas.frontend.related-resource-preview.md +23 -0
  410. package/dist/knowledge/references/saas.frontend.related-resource-sections.md +28 -0
  411. package/dist/knowledge/references/saas.frontend.resource-header-title.md +43 -0
  412. package/dist/knowledge/references/saas.frontend.resource-layout-templates.md +215 -0
  413. package/dist/knowledge/references/saas.frontend.resource-operation-frontend-config.md +531 -0
  414. package/dist/knowledge/references/saas.frontend.resource-ui-behavior-config.md +210 -0
  415. package/dist/knowledge/references/saas.frontend.resource-ui-behavior-preset-map.md +39 -0
  416. package/dist/knowledge/references/saas.frontend.settings-hub.engine-destinations.md +58 -0
  417. package/dist/knowledge/references/saas.frontend.settings-hub.placement.md +118 -0
  418. package/dist/knowledge/references/saas.frontend.view-definition-scope.md +42 -0
  419. package/dist/knowledge/references/saas.market.generation-agent.md +104 -0
  420. package/dist/knowledge/references/saas.models.core-resource-operation.md +86 -0
  421. package/dist/knowledge/references/saas.models.data-mode-read-list.md +395 -0
  422. package/dist/knowledge/references/saas.models.engine-capabilities.md +114 -0
  423. package/dist/knowledge/references/saas.models.error-type.md +45 -0
  424. package/dist/knowledge/references/saas.models.external-data-pipeline.md +162 -0
  425. package/dist/knowledge/references/saas.models.feature-limit-semantic.md +51 -0
  426. package/dist/knowledge/references/saas.models.flows-actors.agent-configuration.md +127 -0
  427. package/dist/knowledge/references/saas.models.flows-actors.agent-definition.md +115 -0
  428. package/dist/knowledge/references/saas.models.flows-actors.agent-invocation.md +52 -0
  429. package/dist/knowledge/references/saas.models.flows-actors.agent-prompt-spec.md +188 -0
  430. package/dist/knowledge/references/saas.models.http-api-binding.md +237 -0
  431. package/dist/knowledge/references/saas.models.navigation.layout.md +149 -0
  432. package/dist/knowledge/references/saas.models.organization-unit-narrowing-containment.md +22 -0
  433. package/dist/knowledge/references/saas.models.organization-unit-narrowing-declaration.md +42 -0
  434. package/dist/knowledge/references/saas.models.polymorphism.optout-business-key.md +62 -0
  435. package/dist/knowledge/references/saas.models.polymorphism.variant-definition.md +74 -0
  436. package/dist/knowledge/references/saas.models.provider-capabilities.md +97 -0
  437. package/dist/knowledge/references/saas.models.rate-limit-configuration.md +67 -0
  438. package/dist/knowledge/references/saas.models.relationship-handling-contract.md +30 -0
  439. package/dist/knowledge/references/saas.models.relationship-handling-settings.md +62 -0
  440. package/dist/knowledge/references/saas.models.relationship-nature-and-models.md +112 -0
  441. package/dist/knowledge/references/saas.models.resource-config.builder-parameters.md +431 -0
  442. package/dist/knowledge/references/saas.models.resource-config.forwarded-label.md +88 -0
  443. package/dist/knowledge/references/saas.models.resource-config.operation-api-call.md +89 -0
  444. package/dist/knowledge/references/saas.models.resource-config.operation-base.md +79 -0
  445. package/dist/knowledge/references/saas.models.resource-config.operation-mcp-exposure.md +49 -0
  446. package/dist/knowledge/references/saas.models.resource-config.operation-path.md +27 -0
  447. package/dist/knowledge/references/saas.models.resource-config.operation-union.md +26 -0
  448. package/dist/knowledge/references/saas.models.resource-config.operation-variant-for-key.md +62 -0
  449. package/dist/knowledge/references/saas.models.resource-config.resource-configuration.md +124 -0
  450. package/dist/knowledge/references/saas.models.resource-config.resource-relationships-buckets.md +38 -0
  451. package/dist/knowledge/references/saas.models.resource-config.resources-registry.md +69 -0
  452. package/dist/knowledge/references/saas.models.resource-config.searchable-relation.md +89 -0
  453. package/dist/knowledge/references/saas.models.resource-config.system-access-policy.md +121 -0
  454. package/dist/knowledge/references/saas.models.resource-config.token-generation.md +145 -0
  455. package/dist/knowledge/references/saas.models.resource-field-identifier.md +25 -0
  456. package/dist/knowledge/references/saas.models.resource-operation-display-risk.md +77 -0
  457. package/dist/knowledge/references/saas.models.resource-operation-variant-runtime.md +58 -0
  458. package/dist/knowledge/references/saas.models.resource-primary-scope.md +36 -0
  459. package/dist/knowledge/references/saas.models.resource-relationship-access-scope.md +26 -0
  460. package/dist/knowledge/references/saas.models.resource-relationship-builder-parameters.md +100 -0
  461. package/dist/knowledge/references/saas.models.resource-relationship-cardinality.md +57 -0
  462. package/dist/knowledge/references/saas.models.resource-relationship-declaration.md +69 -0
  463. package/dist/knowledge/references/saas.models.resource-relationship-resolved-semantics.md +60 -0
  464. package/dist/knowledge/references/saas.models.resource-relationship-schema.md +172 -0
  465. package/dist/knowledge/references/saas.models.resource-server-instance.md +109 -0
  466. package/dist/knowledge/references/saas.models.resource-type.md +24 -0
  467. package/dist/knowledge/references/saas.models.schema-family-builder.md +242 -0
  468. package/dist/knowledge/references/saas.models.scope-membership.md +143 -0
  469. package/dist/knowledge/references/saas.models.shared-domain-module.md +36 -0
  470. package/dist/knowledge/references/saas.models.shared-saas-module.md +36 -0
  471. package/dist/knowledge/references/saas.public-runtime.contract.md +229 -0
  472. package/dist/knowledge/references/saas.rag.retrieval-bounds.md +106 -0
  473. package/dist/knowledge/references/saas.rag.retrieval-refusals.md +89 -0
  474. package/dist/knowledge/references/saas.rag.retrieval-request.md +130 -0
  475. package/dist/knowledge/references/saas.rag.retrieval-result.md +147 -0
  476. package/dist/knowledge/references/saas.rag.retrieval-scores.md +54 -0
  477. package/dist/knowledge/references/saas.specifications.application-document-fact-specification.contract.md +59 -0
  478. package/dist/knowledge/references/saas.specifications.application-document-publication.contract.md +74 -0
  479. package/dist/knowledge/references/saas.specifications.assurance-document-blueprint.contract.md +1158 -0
  480. package/dist/knowledge/references/saas.specifications.assurance-program.contract.md +2602 -0
  481. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.catalog-spec-shared.md +180 -0
  482. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.discriminated-union.md +138 -0
  483. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-aggregate-offer.md +46 -0
  484. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-aggregate-rating.md +47 -0
  485. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-article.md +49 -0
  486. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-blog-posting.md +62 -0
  487. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-breadcrumb-list.md +46 -0
  488. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-faq-page.md +51 -0
  489. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-offer.md +46 -0
  490. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-organization.md +48 -0
  491. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-product.md +59 -0
  492. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-review.md +46 -0
  493. package/dist/knowledge/references/saas.specifications.catalogs.schema-org.entity-website.md +46 -0
  494. package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +530 -0
  495. package/dist/knowledge/references/saas.specifications.composite-view-specification.md +49 -0
  496. package/dist/knowledge/references/saas.specifications.error-message-specification.md +92 -0
  497. package/dist/knowledge/references/saas.specifications.family-specifications.md +109 -0
  498. package/dist/knowledge/references/saas.specifications.feature-specification.md +93 -0
  499. package/dist/knowledge/references/saas.specifications.frontend-component-spec-factory.md +113 -0
  500. package/dist/knowledge/references/saas.specifications.frontend-component-spec-model.md +366 -0
  501. package/dist/knowledge/references/saas.specifications.resource-frontend-configuration-aspect.md +41 -0
  502. package/dist/knowledge/references/saas.specifications.resource-operation-spec.md +1978 -0
  503. package/dist/knowledge/references/saas.specifications.resource-pdf-template-spec.md +58 -0
  504. package/dist/knowledge/references/saas.specifications.resource-spec-code-handling.md +49 -0
  505. package/dist/knowledge/references/saas.specifications.resource-spec-config.md +156 -0
  506. package/dist/knowledge/references/saas.specifications.resource-spec-factory.md +171 -0
  507. package/dist/knowledge/references/saas.specifications.resource-spec-frontend-config-type.md +54 -0
  508. package/dist/knowledge/references/saas.specifications.resource-spec-frontend-prose.md +171 -0
  509. package/dist/knowledge/references/saas.website.astro.bridge.md +262 -0
  510. package/dist/knowledge/references/saas.website.astro.head-renderer.md +271 -0
  511. package/dist/knowledge/references/saas.website.astro.headers-renderer.md +41 -0
  512. package/dist/knowledge/references/saas.website.astro.i18n-helper.md +121 -0
  513. package/dist/knowledge/references/saas.website.astro.label-key-collector.md +117 -0
  514. package/dist/knowledge/references/saas.website.astro.label-loader.md +377 -0
  515. package/dist/knowledge/references/saas.website.astro.llms-txt-server.md +46 -0
  516. package/dist/knowledge/references/saas.website.astro.pick-labels-for-page.md +90 -0
  517. package/dist/knowledge/references/saas.website.astro.robots-renderer.md +174 -0
  518. package/dist/knowledge/references/saas.website.astro.runtime-helper.md +187 -0
  519. package/dist/knowledge/references/saas.website.astro.site-context.md +141 -0
  520. package/dist/knowledge/references/saas.website.astro.sitemap-coverage.md +188 -0
  521. package/dist/knowledge/references/saas.website.astro.structured-data-renderer.md +174 -0
  522. package/dist/knowledge/references/saas.website.blog.bridge.md +396 -0
  523. package/dist/knowledge/references/saas.website.blog.collection-config.md +180 -0
  524. package/dist/knowledge/references/saas.website.blog.frontmatter.md +116 -0
  525. package/dist/knowledge/references/saas.website.blog.head-renderer.md +292 -0
  526. package/dist/knowledge/references/saas.website.blog.mdx-provider.md +100 -0
  527. package/dist/knowledge/references/saas.website.blog.post-renderer.md +291 -0
  528. package/dist/knowledge/references/saas.website.design-tokens.bundle.md +29 -0
  529. package/dist/knowledge/references/saas.website.design-tokens.colors.md +64 -0
  530. package/dist/knowledge/references/saas.website.design-tokens.radius.md +38 -0
  531. package/dist/knowledge/references/saas.website.factories.define-page-manifest.md +98 -0
  532. package/dist/knowledge/references/saas.website.factories.define-section.md +128 -0
  533. package/dist/knowledge/references/saas.website.label-keys.compose-helper.md +36 -0
  534. package/dist/knowledge/references/saas.website.label-keys.format.md +67 -0
  535. package/dist/knowledge/references/saas.website.label-pack.validator.md +206 -0
  536. package/dist/knowledge/references/saas.website.page-layout.component.md +217 -0
  537. package/dist/knowledge/references/saas.website.page-manifest.meta-label-keys.md +47 -0
  538. package/dist/knowledge/references/saas.website.page-manifest.route-path.md +49 -0
  539. package/dist/knowledge/references/saas.website.page-manifest.schema.md +186 -0
  540. package/dist/knowledge/references/saas.website.page-manifest.seo.md +46 -0
  541. package/dist/knowledge/references/saas.website.page.context.md +57 -0
  542. package/dist/knowledge/references/saas.website.primitives.button.md +123 -0
  543. package/dist/knowledge/references/saas.website.primitives.heading.md +103 -0
  544. package/dist/knowledge/references/saas.website.primitives.image.md +103 -0
  545. package/dist/knowledge/references/saas.website.primitives.internal-button.md +151 -0
  546. package/dist/knowledge/references/saas.website.primitives.internal-link.md +193 -0
  547. package/dist/knowledge/references/saas.website.primitives.link.md +78 -0
  548. package/dist/knowledge/references/saas.website.primitives.text.md +82 -0
  549. package/dist/knowledge/references/saas.website.refs.page.md +56 -0
  550. package/dist/knowledge/references/saas.website.refs.section.md +57 -0
  551. package/dist/knowledge/references/saas.website.root-config.navigation.md +37 -0
  552. package/dist/knowledge/references/saas.website.root-config.schema.md +192 -0
  553. package/dist/knowledge/references/saas.website.root-config.seo.md +98 -0
  554. package/dist/knowledge/references/saas.website.routing.localized-path.md +84 -0
  555. package/dist/knowledge/references/saas.website.runtime.context.md +174 -0
  556. package/dist/knowledge/references/saas.website.section.component.md +138 -0
  557. package/dist/knowledge/references/saas.website.section.context.md +63 -0
  558. package/dist/knowledge/references/saas.website.sections.category-enum.md +72 -0
  559. package/dist/knowledge/references/saas.website.sections.definition-schema.md +121 -0
  560. package/dist/knowledge/references/saas.website.seo.llms-txt-config.md +37 -0
  561. package/dist/knowledge/references/saas.website.seo.robots-config.md +106 -0
  562. package/dist/knowledge/references/saas.website.seo.sitemap-config.md +73 -0
  563. package/dist/knowledge/references/saas.website.structured-data.payload-shape.md +71 -0
  564. package/dist/knowledge/references/saas.website.use-label-by-key.hook.md +45 -0
  565. package/dist/knowledge/references/saas.website.use-label.hook.md +82 -0
  566. package/dist/knowledge/references/saas.website.use-page.hook.md +30 -0
  567. package/dist/knowledge/references/saas.website.use-runtime.hook.md +36 -0
  568. package/dist/knowledge/references/saas.website.use-section.hook.md +30 -0
  569. package/dist/knowledge/references/saas.website.use-tokens.hook.md +32 -0
  570. package/dist/knowledge/references/vision.authored-metadata.config.md +64 -0
  571. package/dist/knowledge/references/vision.constraint.config.md +66 -0
  572. package/dist/knowledge/references/vision.idea.config.md +45 -0
  573. package/dist/knowledge/references/vision.mission.config.md +46 -0
  574. package/dist/knowledge/references/vision.problem.config.md +51 -0
  575. package/dist/knowledge/references/vision.references.conventions.md +115 -0
  576. package/dist/knowledge/references/vision.snapshot.config.md +85 -0
  577. package/dist/knowledge/references/vision.snapshot.validation.md +226 -0
  578. package/dist/knowledge/references/vision.success-criterion.config.md +60 -0
  579. package/dist/knowledge/references/zod.decorators.chainable-runtime.md +550 -0
  580. package/dist/knowledge/references/zod.decorators.conditional-visibility.md +104 -0
  581. package/dist/knowledge/references/zod.decorators.data-categories.md +197 -0
  582. package/dist/knowledge/references/zod.decorators.decorator-vocabulary.md +436 -0
  583. package/dist/knowledge/references/zod.decorators.display-edit-modes.md +174 -0
  584. package/dist/knowledge/references/zod.decorators.enums.frontend-handling.md +101 -0
  585. package/dist/knowledge/references/zod.decorators.field-spec-params.md +317 -0
  586. package/dist/knowledge/references/zod.decorators.file-generation.md +36 -0
  587. package/dist/knowledge/references/zod.decorators.file-rag-source.md +56 -0
  588. package/dist/knowledge/references/zod.decorators.file-schema.md +319 -0
  589. package/dist/knowledge/references/zod.decorators.foreign-key-display-mode.md +83 -0
  590. package/dist/knowledge/references/zod.decorators.per-primitive-ui.md +459 -0
  591. package/dist/knowledge/references/zod.decorators.primitive-ui.md +123 -0
  592. package/dist/knowledge/references/zod.decorators.rag-source.md +164 -0
  593. package/dist/knowledge/references/zod.decorators.schema-metadata.md +122 -0
  594. package/dist/knowledge/references/zod.decorators.shared-structural-methods.md +152 -0
  595. package/dist/knowledge/references/zod.decorators.shared-structural-params.md +314 -0
  596. package/dist/knowledge/references/zod.decorators.structural-lifecycle-params.md +529 -0
  597. package/dist/knowledge/references/zod.factories.bigdecimal.md +155 -0
  598. package/dist/knowledge/references/zod.factories.code.md +127 -0
  599. package/dist/knowledge/references/zod.factories.duration.md +246 -0
  600. package/dist/knowledge/references/zod.factories.money.md +166 -0
  601. package/dist/knowledge/references/zod.factories.phone.md +88 -0
  602. package/dist/knowledge/references/zod.factories.range.md +174 -0
  603. package/dist/knowledge/registries/assurance-authority-bases.json +15 -0
  604. package/dist/knowledge/registries/framework-topics.json +5212 -0
  605. package/dist/knowledge/registries/playbooks.json +488 -0
  606. package/dist/knowledge/registries/source-tags.json +7664 -0
  607. package/dist/knowledge/rules/resource-schema-awareness.md +77 -0
  608. package/dist/knowledge/skills/INDEX.md +349 -0
  609. package/dist/knowledge/skills/application-consumer-documentation-authoring/SKILL.md +415 -0
  610. package/dist/knowledge/skills/application-consumer-documentation-authoring/examples/domain-use-case-and-admin-task.example.md +49 -0
  611. package/dist/knowledge/skills/application-consumer-documentation-authoring/references/source-and-ownership-routing.md +52 -0
  612. package/dist/knowledge/skills/application-database-migrations/SKILL.md +218 -0
  613. package/dist/knowledge/skills/application-database-migrations/references/framework-application-database-api.md +84 -0
  614. package/dist/knowledge/skills/application-database-migrations/references/framework-migration-change-risk-api.md +37 -0
  615. package/dist/knowledge/skills/application-database-migrations/references/migration-refusals.md +64 -0
  616. package/dist/knowledge/skills/application-database-migrations/references/postgresql-vs-mongodb-obligations.md +34 -0
  617. package/dist/knowledge/skills/authorization-unit-narrowing/SKILL.md +323 -0
  618. package/dist/knowledge/skills/authorization-unit-narrowing/references/framework-unit-narrowing-declaration-api.md +84 -0
  619. package/dist/knowledge/skills/backend-addon-wiring/SKILL.md +324 -0
  620. package/dist/knowledge/skills/backend-addon-wiring/references/backend-di-routing.md +7 -0
  621. package/dist/knowledge/skills/backend-addon-wiring/references/framework-backend-bootstrap-api.md +276 -0
  622. package/dist/knowledge/skills/backend-custom-operation/SKILL.md +374 -0
  623. package/dist/knowledge/skills/backend-custom-operation/references/framework-error-handling-api.md +118 -0
  624. package/dist/knowledge/skills/backend-custom-operation/references/framework-operation-base-and-path-api.md +107 -0
  625. package/dist/knowledge/skills/backend-custom-operation/references/framework-transactional-core-api.md +134 -0
  626. package/dist/knowledge/skills/backend-custom-operation/references/operation-file-conventions.md +10 -0
  627. package/dist/knowledge/skills/brand-logo-authoring/SKILL.md +192 -0
  628. package/dist/knowledge/skills/brand-logo-authoring/references/brand-authoring-decisions.md +55 -0
  629. package/dist/knowledge/skills/brand-logo-authoring/references/framework-brand-asset-api.md +184 -0
  630. package/dist/knowledge/skills/brand-logo-authoring/references/framework-brand-snapshot-api.md +279 -0
  631. package/dist/knowledge/skills/compliance-document-authoring/SKILL.md +346 -0
  632. package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-governance.md +160 -0
  633. package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-privacy-notice.md +518 -0
  634. package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-service-terms.md +158 -0
  635. package/dist/knowledge/skills/compliance-document-authoring/references/framework-application-document-fact-specification-contract.md +95 -0
  636. package/dist/knowledge/skills/compliance-document-authoring/references/framework-application-document-publication-contract.md +100 -0
  637. package/dist/knowledge/skills/compliance-document-authoring/references/framework-assurance-document-blueprint-contract.md +1210 -0
  638. package/dist/knowledge/skills/compliance-document-authoring/references/framework-governed-document-after-drafting.md +40 -0
  639. package/dist/knowledge/skills/config-app-shell/SKILL.md +698 -0
  640. package/dist/knowledge/skills/config-app-shell/references/app-shell-surfaces.md +5 -0
  641. package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-api.md +415 -0
  642. package/dist/knowledge/skills/config-app-shell/references/framework-app-shell-hosted-components-api.md +170 -0
  643. package/dist/knowledge/skills/config-app-shell/references/framework-command-menu-omnibox-api.md +212 -0
  644. package/dist/knowledge/skills/config-app-shell/references/framework-quick-switcher-scope-field-api.md +178 -0
  645. package/dist/knowledge/skills/config-design-system/SKILL.md +424 -0
  646. package/dist/knowledge/skills/config-design-system/references/design-system-file.md +10 -0
  647. package/dist/knowledge/skills/config-design-system/references/framework-design-system-configuration-api.md +77 -0
  648. package/dist/knowledge/skills/config-design-system/references/framework-material-profile-api.md +200 -0
  649. package/dist/knowledge/skills/config-design-system/references/framework-material-runtime-policy-api.md +68 -0
  650. package/dist/knowledge/skills/config-design-system/references/framework-surface-policy-api.md +1212 -0
  651. package/dist/knowledge/skills/config-design-system/references/surface-policy-authoring.md +92 -0
  652. package/dist/knowledge/skills/config-navigation/SKILL.md +249 -0
  653. package/dist/knowledge/skills/config-navigation/references/framework-navigation-layout-api.md +152 -0
  654. package/dist/knowledge/skills/config-navigation/references/navigation-zones.md +5 -0
  655. package/dist/knowledge/skills/config-saas/SKILL.md +209 -0
  656. package/dist/knowledge/skills/config-saas/references/framework-provider-capabilities-api.md +221 -0
  657. package/dist/knowledge/skills/config-saas/references/framework-wildo-saas-config-api.md +408 -0
  658. package/dist/knowledge/skills/config-saas/references/saas-config-scope.md +9 -0
  659. package/dist/knowledge/skills/config-saas-backend/SKILL.md +183 -0
  660. package/dist/knowledge/skills/config-saas-backend/references/framework-backend-authored-config-api.md +40 -0
  661. package/dist/knowledge/skills/configure-billing/SKILL.md +261 -0
  662. package/dist/knowledge/skills/configure-billing/references/config-chain-and-failure-map.md +90 -0
  663. package/dist/knowledge/skills/configure-billing/references/example-backend-provider-module-shape.md +122 -0
  664. package/dist/knowledge/skills/configure-billing/references/example-provider-contribution-and-backend-config.md +48 -0
  665. package/dist/knowledge/skills/configure-billing/references/framework-backend-provider-reachability-api.md +69 -0
  666. package/dist/knowledge/skills/configure-billing/references/framework-billing-resolution-failure-api.md +57 -0
  667. package/dist/knowledge/skills/email-add-template/SKILL.md +439 -0
  668. package/dist/knowledge/skills/email-add-template/references/email-artifact-paths.md +9 -0
  669. package/dist/knowledge/skills/email-add-template/references/framework-email-template-api.md +72 -0
  670. package/dist/knowledge/skills/email-definition-wiring/SKILL.md +62 -0
  671. package/dist/knowledge/skills/email-labels-authoring/SKILL.md +64 -0
  672. package/dist/knowledge/skills/email-template-authoring/SKILL.md +62 -0
  673. package/dist/knowledge/skills/engine-component-registration/SKILL.md +257 -0
  674. package/dist/knowledge/skills/engine-component-registration/references/component-registration-file.md +7 -0
  675. package/dist/knowledge/skills/engine-component-registration/references/framework-component-registration-api.md +24 -0
  676. package/dist/knowledge/skills/engine-product-definitions/SKILL.md +429 -0
  677. package/dist/knowledge/skills/engine-product-definitions/references/framework-engine-product-definitions-api.md +287 -0
  678. package/dist/knowledge/skills/engine-product-definitions/references/product-registry-scope.md +5 -0
  679. package/dist/knowledge/skills/flows-actors-a2a-exposure/SKILL.md +491 -0
  680. package/dist/knowledge/skills/flows-actors-a2a-exposure/references/framework-flows-actors-a2a-contract.md +227 -0
  681. package/dist/knowledge/skills/flows-actors-a2a-exposure/references/framework-named-a2a-agents-contract.md +143 -0
  682. package/dist/knowledge/skills/flows-actors-chat-assistant/SKILL.md +368 -0
  683. package/dist/knowledge/skills/flows-actors-chat-assistant/examples/todo-assistant.example.md +226 -0
  684. package/dist/knowledge/skills/flows-actors-chat-assistant/references/framework-flows-actors-tool-api.md +208 -0
  685. package/dist/knowledge/skills/flows-actors-chat-assistant/references/framework-flows-actors-view-api.md +286 -0
  686. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/SKILL.md +376 -0
  687. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-definition-api.md +262 -0
  688. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-invocation-api.md +130 -0
  689. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-agent-prompt-spec-api.md +214 -0
  690. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/framework-llm-operation-and-model-api.md +195 -0
  691. package/dist/knowledge/skills/flows-actors-llm-agent-invocation/references/operation-key-selection.md +60 -0
  692. package/dist/knowledge/skills/frontend-cdn-publish/SKILL.md +237 -0
  693. package/dist/knowledge/skills/frontend-cdn-publish/references/cloudflare-and-operator-setup.md +56 -0
  694. package/dist/knowledge/skills/frontend-cdn-publish/references/framework-cdn-config-api.md +176 -0
  695. package/dist/knowledge/skills/i18n-label-generation/SKILL.md +261 -0
  696. package/dist/knowledge/skills/i18n-label-generation/references/framework-labelling-sections-api.md +67 -0
  697. package/dist/knowledge/skills/i18n-label-generation/references/label-placement.md +7 -0
  698. package/dist/knowledge/skills/i18n-rerun-pipeline/SKILL.md +269 -0
  699. package/dist/knowledge/skills/i18n-rerun-pipeline/references/framework-labelling-sections-api.md +67 -0
  700. package/dist/knowledge/skills/i18n-rerun-pipeline/references/i18n-routing.md +9 -0
  701. package/dist/knowledge/skills/i18n-translation-rerun/SKILL.md +245 -0
  702. package/dist/knowledge/skills/i18n-translation-rerun/references/framework-labelling-sections-api.md +67 -0
  703. package/dist/knowledge/skills/i18n-translation-rerun/references/translation-workflow.md +17 -0
  704. package/dist/knowledge/skills/infra-environment-config/SKILL.md +646 -0
  705. package/dist/knowledge/skills/infra-environment-config/references/framework-application-database-api.md +77 -0
  706. package/dist/knowledge/skills/infra-environment-config/references/framework-backing-services-api.md +282 -0
  707. package/dist/knowledge/skills/infra-environment-config/references/framework-environment-deployment-api.md +265 -0
  708. package/dist/knowledge/skills/infra-environment-config/references/infra-config-files.md +7 -0
  709. package/dist/knowledge/skills/journey-approve/SKILL.md +43 -0
  710. package/dist/knowledge/skills/journey-bootstrap-scope/SKILL.md +42 -0
  711. package/dist/knowledge/skills/journey-next/SKILL.md +42 -0
  712. package/dist/knowledge/skills/journey-report/SKILL.md +43 -0
  713. package/dist/knowledge/skills/journey-run/SKILL.md +55 -0
  714. package/dist/knowledge/skills/journey-status/SKILL.md +50 -0
  715. package/dist/knowledge/skills/local-environment-bootstrap/SKILL.md +370 -0
  716. package/dist/knowledge/skills/local-environment-bootstrap/references/initialization-recovery-recipe.md +50 -0
  717. package/dist/knowledge/skills/local-environment-bootstrap/references/local-environment-troubleshooting.md +409 -0
  718. package/dist/knowledge/skills/local-environment-bootstrap/references/wildo-cli-bootstrap-commands.md +247 -0
  719. package/dist/knowledge/skills/market-add-feature-benefit/SKILL.md +474 -0
  720. package/dist/knowledge/skills/market-add-feature-benefit/references/framework-feature-benefit-api.md +139 -0
  721. package/dist/knowledge/skills/market-alternatives/SKILL.md +543 -0
  722. package/dist/knowledge/skills/market-authoring-overview/SKILL.md +354 -0
  723. package/dist/knowledge/skills/market-authoring-overview/references/framework-market-references-api.md +138 -0
  724. package/dist/knowledge/skills/market-authoring-overview/references/framework-market-snapshot-api.md +129 -0
  725. package/dist/knowledge/skills/market-category/SKILL.md +290 -0
  726. package/dist/knowledge/skills/market-channels/SKILL.md +361 -0
  727. package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +2752 -0
  728. package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +2443 -0
  729. package/dist/knowledge/skills/market-generation-cli/SKILL.md +1484 -0
  730. package/dist/knowledge/skills/market-generation-cli/references/framework-market-generation-cli.md +1230 -0
  731. package/dist/knowledge/skills/market-icp/SKILL.md +625 -0
  732. package/dist/knowledge/skills/market-jobs-pains-gains/SKILL.md +352 -0
  733. package/dist/knowledge/skills/market-message-templates-authoring/SKILL.md +415 -0
  734. package/dist/knowledge/skills/market-message-templates-authoring/references/framework-message-template-api.md +1439 -0
  735. package/dist/knowledge/skills/market-persona/SKILL.md +407 -0
  736. package/dist/knowledge/skills/market-positioning-authoring/SKILL.md +392 -0
  737. package/dist/knowledge/skills/market-positioning-authoring/references/framework-positioning-api.md +97 -0
  738. package/dist/knowledge/skills/market-proof-and-objection/SKILL.md +665 -0
  739. package/dist/knowledge/skills/market-scoring-interpretation/SKILL.md +620 -0
  740. package/dist/knowledge/skills/market-scoring-interpretation/references/framework-scoring-api.md +291 -0
  741. package/dist/knowledge/skills/market-snapshot-validation/SKILL.md +1706 -0
  742. package/dist/knowledge/skills/market-snapshot-validation/references/framework-snapshot-validation-api.md +1228 -0
  743. package/dist/knowledge/skills/market-tone-of-voice/SKILL.md +260 -0
  744. package/dist/knowledge/skills/market-triggers-and-journey/SKILL.md +579 -0
  745. package/dist/knowledge/skills/module-companion-exports/SKILL.md +318 -0
  746. package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +544 -0
  747. package/dist/knowledge/skills/module-registration/SKILL.md +212 -0
  748. package/dist/knowledge/skills/module-registration/references/framework-domain-modules-api.md +366 -0
  749. package/dist/knowledge/skills/module-registration/references/registry-files.md +9 -0
  750. package/dist/knowledge/skills/module-relationships/SKILL.md +523 -0
  751. package/dist/knowledge/skills/module-relationships/references/cross-resource-fk-checklist.md +7 -0
  752. package/dist/knowledge/skills/module-relationships/references/framework-resource-relationship-authoring-api.md +738 -0
  753. package/dist/knowledge/skills/pdf-template-authoring/SKILL.md +174 -0
  754. package/dist/knowledge/skills/pdf-template-authoring/references/framework-pdf-template-api.md +203 -0
  755. package/dist/knowledge/skills/pdf-template-authoring/references/framework-pdf-template-spec-api.md +62 -0
  756. package/dist/knowledge/skills/provider-frontend-file-picker/SKILL.md +239 -0
  757. package/dist/knowledge/skills/provider-frontend-file-picker/references/framework-file-provider-constraints-api.md +90 -0
  758. package/dist/knowledge/skills/provider-frontend-file-picker/references/framework-frontend-provider-module-api.md +50 -0
  759. package/dist/knowledge/skills/rate-limit-authoring/SKILL.md +652 -0
  760. package/dist/knowledge/skills/rate-limit-authoring/references/framework-rate-limit-policy-api.md +182 -0
  761. package/dist/knowledge/skills/rate-limit-authoring/references/scope-key-and-bucket-conventions.md +137 -0
  762. package/dist/knowledge/skills/resource-add-field/SKILL.md +272 -0
  763. package/dist/knowledge/skills/resource-add-field/examples/add-priority-field-to-todos.example.md +153 -0
  764. package/dist/knowledge/skills/resource-add-field/references/framework-field-cross-layer-api.md +845 -0
  765. package/dist/knowledge/skills/resource-add-module/SKILL.md +322 -0
  766. package/dist/knowledge/skills/resource-add-module/references/framework-new-module-wiring-api.md +67 -0
  767. package/dist/knowledge/skills/resource-add-module/references/module-scaffold-layout.md +15 -0
  768. package/dist/knowledge/skills/resource-add-resource/SKILL.md +222 -0
  769. package/dist/knowledge/skills/resource-add-resource/references/framework-new-resource-core-config-api.md +540 -0
  770. package/dist/knowledge/skills/resource-add-resource/references/scaffold-surfaces-checklist.md +25 -0
  771. package/dist/knowledge/skills/resource-config-wiring/SKILL.md +370 -0
  772. package/dist/knowledge/skills/resource-config-wiring/references/config-change-routing.md +11 -0
  773. package/dist/knowledge/skills/resource-config-wiring/references/framework-personal-data-declaration-api.md +622 -0
  774. package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-operation-scope-enums-api.md +248 -0
  775. package/dist/knowledge/skills/resource-config-wiring/references/framework-saas-models-resource-config-api.md +1769 -0
  776. package/dist/knowledge/skills/resource-config-wiring/references/framework-system-access-reads-api.md +1209 -0
  777. package/dist/knowledge/skills/resource-custom-view/SKILL.md +228 -0
  778. package/dist/knowledge/skills/resource-custom-view/references/custom-view-contracts.md +693 -0
  779. package/dist/knowledge/skills/resource-external-data/SKILL.md +349 -0
  780. package/dist/knowledge/skills/resource-external-data/references/framework-external-data-pipeline-api.md +187 -0
  781. package/dist/knowledge/skills/resource-external-data/references/framework-http-api-binding-api.md +261 -0
  782. package/dist/knowledge/skills/resource-external-data/references/lane-selection.md +49 -0
  783. package/dist/knowledge/skills/resource-external-data/references/pipeline-destination-schema.md +43 -0
  784. package/dist/knowledge/skills/resource-mcp-tool-exposure/SKILL.md +308 -0
  785. package/dist/knowledge/skills/resource-mcp-tool-exposure/references/framework-named-mcp-servers-contract.md +166 -0
  786. package/dist/knowledge/skills/resource-mcp-tool-exposure/references/framework-resource-mcp-exposure-contract.md +63 -0
  787. package/dist/knowledge/skills/resource-mcp-tool-exposure/references/mcp-catalogue-withdrawal-and-verification.md +77 -0
  788. package/dist/knowledge/skills/resource-mcp-tool-exposure/references/mcp-client-registration-postures.md +90 -0
  789. package/dist/knowledge/skills/resource-rag-source-fields/SKILL.md +424 -0
  790. package/dist/knowledge/skills/resource-rag-source-fields/references/corpus-field-selection.md +90 -0
  791. package/dist/knowledge/skills/resource-rag-source-fields/references/framework-embeddings-capability-api.md +261 -0
  792. package/dist/knowledge/skills/resource-rag-source-fields/references/framework-file-rag-source-api.md +117 -0
  793. package/dist/knowledge/skills/resource-rag-source-fields/references/framework-rag-retrieval-api.md +597 -0
  794. package/dist/knowledge/skills/resource-rag-source-fields/references/framework-rag-source-decorator-api.md +181 -0
  795. package/dist/knowledge/skills/resource-schema-authoring/SKILL.md +318 -0
  796. package/dist/knowledge/skills/resource-schema-authoring/examples/add-enum-field-with-ui.example.md +132 -0
  797. package/dist/knowledge/skills/resource-schema-authoring/examples/basic-resource-schema.example.md +62 -0
  798. package/dist/knowledge/skills/resource-schema-authoring/references/decorator-layer-map.md +63 -0
  799. package/dist/knowledge/skills/resource-schema-authoring/references/field-type-selection.md +70 -0
  800. package/dist/knowledge/skills/resource-schema-authoring/references/framework-decorator-vocabulary-api.md +559 -0
  801. package/dist/knowledge/skills/resource-schema-authoring/references/framework-personal-data-category-api.md +245 -0
  802. package/dist/knowledge/skills/resource-schema-authoring/references/framework-polymorphic-resources-api.md +147 -0
  803. package/dist/knowledge/skills/resource-schema-authoring/references/framework-schema-family-api.md +247 -0
  804. package/dist/knowledge/skills/resource-schema-authoring/references/framework-shared-decorator-methods-api.md +164 -0
  805. package/dist/knowledge/skills/resource-schema-authoring/references/framework-shared-structural-params-api.md +327 -0
  806. package/dist/knowledge/skills/resource-schema-authoring/references/framework-special-factories-api.md +1286 -0
  807. package/dist/knowledge/skills/resource-schema-authoring/references/framework-zod-lifecycle-and-chainable-api.md +1080 -0
  808. package/dist/knowledge/skills/resource-schema-authoring/references/polymorphic-per-scope-resources.md +75 -0
  809. package/dist/knowledge/skills/resource-schema-authoring/references/schema-variants-and-discriminators.md +62 -0
  810. package/dist/knowledge/skills/resource-schema-authoring/references/shared-layer-decorator-checklist.md +69 -0
  811. package/dist/knowledge/skills/resource-schema-authoring/references/special-factories.md +45 -0
  812. package/dist/knowledge/skills/resource-ui-behavior/SKILL.md +389 -0
  813. package/dist/knowledge/skills/resource-ui-behavior/references/framework-conditional-visibility-api.md +106 -0
  814. package/dist/knowledge/skills/resource-ui-behavior/references/framework-display-edit-modes-api.md +176 -0
  815. package/dist/knowledge/skills/resource-ui-behavior/references/framework-enum-frontend-handling-api.md +103 -0
  816. package/dist/knowledge/skills/resource-ui-behavior/references/framework-foreign-key-ui-api.md +97 -0
  817. package/dist/knowledge/skills/resource-ui-behavior/references/framework-frontend-resource-ui-contracts-api.md +839 -0
  818. package/dist/knowledge/skills/resource-ui-behavior/references/framework-per-primitive-ui-api.md +461 -0
  819. package/dist/knowledge/skills/resource-ui-behavior/references/framework-primitive-ui-api.md +125 -0
  820. package/dist/knowledge/skills/resource-ui-behavior/references/framework-related-resource-embeds-api.md +245 -0
  821. package/dist/knowledge/skills/resource-ui-behavior/references/framework-resource-layout-templates-api.md +302 -0
  822. package/dist/knowledge/skills/resource-ui-behavior/references/ui-layer-boundaries.md +13 -0
  823. package/dist/knowledge/skills/seeding-authoring/SKILL.md +569 -0
  824. package/dist/knowledge/skills/seeding-authoring/references/data-seeding-mode-picker.md +154 -0
  825. package/dist/knowledge/skills/seeding-authoring/references/framework-data-seeding-api.md +176 -0
  826. package/dist/knowledge/skills/seeding-operations/SKILL.md +505 -0
  827. package/dist/knowledge/skills/seeding-operations/references/data-seeding-admin-runbook.md +337 -0
  828. package/dist/knowledge/skills/seeding-operations/references/data-seeding-cron-scheduler.md +171 -0
  829. package/dist/knowledge/skills/seeding-operations/references/framework-data-seeding-operations-api.md +662 -0
  830. package/dist/knowledge/skills/settings-placement-authoring/SKILL.md +134 -0
  831. package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-destinations-catalog.md +65 -0
  832. package/dist/knowledge/skills/settings-placement-authoring/references/framework-settings-placement-api.md +127 -0
  833. package/dist/knowledge/skills/spec-catalog-authoring/SKILL.md +726 -0
  834. package/dist/knowledge/skills/spec-catalog-authoring/references/catalog-spec-pattern-overview.md +242 -0
  835. package/dist/knowledge/skills/spec-companion-exports/SKILL.md +362 -0
  836. package/dist/knowledge/skills/spec-companion-exports/references/companion-export-checklist.md +8 -0
  837. package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +533 -0
  838. package/dist/knowledge/skills/spec-component-update/SKILL.md +315 -0
  839. package/dist/knowledge/skills/spec-component-update/references/component-spec-props.md +8 -0
  840. package/dist/knowledge/skills/spec-component-update/references/framework-frontend-component-spec-api.md +481 -0
  841. package/dist/knowledge/skills/spec-composite-view-update/SKILL.md +283 -0
  842. package/dist/knowledge/skills/spec-composite-view-update/references/composite-spec-sections.md +5 -0
  843. package/dist/knowledge/skills/spec-composite-view-update/references/framework-composite-view-specification-api.md +51 -0
  844. package/dist/knowledge/skills/spec-family-update/SKILL.md +300 -0
  845. package/dist/knowledge/skills/spec-family-update/references/family-spec-routing.md +13 -0
  846. package/dist/knowledge/skills/spec-family-update/references/framework-error-message-specifications-api.md +108 -0
  847. package/dist/knowledge/skills/spec-family-update/references/framework-family-specifications-api.md +111 -0
  848. package/dist/knowledge/skills/spec-feature-update/SKILL.md +306 -0
  849. package/dist/knowledge/skills/spec-feature-update/references/feature-spec-scope.md +5 -0
  850. package/dist/knowledge/skills/spec-feature-update/references/framework-feature-specification-api.md +95 -0
  851. package/dist/knowledge/skills/spec-resource-update/SKILL.md +220 -0
  852. package/dist/knowledge/skills/spec-resource-update/references/framework-field-spec-params-api.md +319 -0
  853. package/dist/knowledge/skills/spec-resource-update/references/framework-spec-resource-contracts-api.md +2610 -0
  854. package/dist/knowledge/skills/spec-resource-update/references/resource-spec-field-routing.md +12 -0
  855. package/dist/knowledge/skills/spec-update-after-change/SKILL.md +195 -0
  856. package/dist/knowledge/skills/spec-update-after-change/references/framework-spec-factory-api.md +173 -0
  857. package/dist/knowledge/skills/spec-update-after-change/references/spec-maintenance-by-surface.md +33 -0
  858. package/dist/knowledge/skills/spec-update-after-change/references/surface-to-spec-routing.md +14 -0
  859. package/dist/knowledge/skills/views-add-composite-view/SKILL.md +259 -0
  860. package/dist/knowledge/skills/views-add-composite-view/references/composite-view-routing.md +10 -0
  861. package/dist/knowledge/skills/views-add-composite-view/references/framework-inserted-view-identity-api.md +151 -0
  862. package/dist/knowledge/skills/views-add-custom-view/SKILL.md +225 -0
  863. package/dist/knowledge/skills/views-add-custom-view/references/custom-view-routing.md +10 -0
  864. package/dist/knowledge/skills/views-add-custom-view/references/framework-view-scope-and-full-custom-api.md +107 -0
  865. package/dist/knowledge/skills/views-app-level/SKILL.md +201 -0
  866. package/dist/knowledge/skills/views-app-level/references/app-level-views-routing.md +9 -0
  867. package/dist/knowledge/skills/views-app-level/references/framework-view-scope-and-full-custom-api.md +107 -0
  868. package/dist/knowledge/skills/views-chart-authoring/SKILL.md +264 -0
  869. package/dist/knowledge/skills/views-chart-authoring/references/chart-view-checklist.md +7 -0
  870. package/dist/knowledge/skills/views-chart-authoring/references/framework-chart-view-contracts-api.md +82 -0
  871. package/dist/knowledge/skills/views-chart-authoring/references/framework-inserted-view-identity-api.md +152 -0
  872. package/dist/knowledge/skills/views-composite-authoring/SKILL.md +302 -0
  873. package/dist/knowledge/skills/views-composite-authoring/references/composite-embedding-checklist.md +23 -0
  874. package/dist/knowledge/skills/views-composite-authoring/references/framework-composite-view-contracts-api.md +133 -0
  875. package/dist/knowledge/skills/views-composite-authoring/references/framework-inserted-view-identity-api.md +152 -0
  876. package/dist/knowledge/skills/views-execution-authoring/SKILL.md +209 -0
  877. package/dist/knowledge/skills/views-execution-authoring/references/execution-view-checklist.md +7 -0
  878. package/dist/knowledge/skills/views-execution-authoring/references/framework-execution-view-contracts-api.md +389 -0
  879. package/dist/knowledge/skills/views-execution-authoring/references/framework-inserted-view-identity-api.md +152 -0
  880. package/dist/knowledge/skills/website-anonymous-session/SKILL.md +444 -0
  881. package/dist/knowledge/skills/website-blog-authoring/SKILL.md +587 -0
  882. package/dist/knowledge/skills/website-blog-authoring/references/blog-adapter-api.md +1426 -0
  883. package/dist/knowledge/skills/website-bundle-discipline/SKILL.md +553 -0
  884. package/dist/knowledge/skills/website-bundle-discipline/references/example-website-button-override.md +52 -0
  885. package/dist/knowledge/skills/website-bundle-discipline/references/website-bundle-rules.md +357 -0
  886. package/dist/knowledge/skills/website-consent-gate-overrides/SKILL.md +511 -0
  887. package/dist/knowledge/skills/website-factory-advanced/SKILL.md +376 -0
  888. package/dist/knowledge/skills/website-inbound-contact-forms/SKILL.md +304 -0
  889. package/dist/knowledge/skills/website-label-pack/SKILL.md +390 -0
  890. package/dist/knowledge/skills/website-layout-overrides/SKILL.md +461 -0
  891. package/dist/knowledge/skills/website-marketing-metadata-extension/SKILL.md +264 -0
  892. package/dist/knowledge/skills/website-navigation-authoring/SKILL.md +414 -0
  893. package/dist/knowledge/skills/website-navigation-authoring/references/worked-examples-header-footer.md +366 -0
  894. package/dist/knowledge/skills/website-page-authoring/SKILL.md +420 -0
  895. package/dist/knowledge/skills/website-page-variants/SKILL.md +256 -0
  896. package/dist/knowledge/skills/website-primitive-overrides/SKILL.md +302 -0
  897. package/dist/knowledge/skills/website-section-contact/SKILL.md +950 -0
  898. package/dist/knowledge/skills/website-section-contact/references/define-website-section-api.md +579 -0
  899. package/dist/knowledge/skills/website-section-cta/SKILL.md +822 -0
  900. package/dist/knowledge/skills/website-section-cta/references/define-website-section-api.md +579 -0
  901. package/dist/knowledge/skills/website-section-faq/SKILL.md +917 -0
  902. package/dist/knowledge/skills/website-section-faq/references/define-website-section-api.md +579 -0
  903. package/dist/knowledge/skills/website-section-feature-benefit-summary/SKILL.md +878 -0
  904. package/dist/knowledge/skills/website-section-feature-benefit-summary/references/define-website-section-api.md +579 -0
  905. package/dist/knowledge/skills/website-section-feature-detail/SKILL.md +895 -0
  906. package/dist/knowledge/skills/website-section-feature-detail/references/define-website-section-api.md +579 -0
  907. package/dist/knowledge/skills/website-section-footer-cta/SKILL.md +814 -0
  908. package/dist/knowledge/skills/website-section-footer-cta/references/define-website-section-api.md +579 -0
  909. package/dist/knowledge/skills/website-section-hero/SKILL.md +944 -0
  910. package/dist/knowledge/skills/website-section-hero/references/define-website-section-api.md +583 -0
  911. package/dist/knowledge/skills/website-section-pricing/SKILL.md +934 -0
  912. package/dist/knowledge/skills/website-section-pricing/references/define-website-section-api.md +579 -0
  913. package/dist/knowledge/skills/website-section-social-proof/SKILL.md +912 -0
  914. package/dist/knowledge/skills/website-section-social-proof/references/define-website-section-api.md +579 -0
  915. package/dist/knowledge/skills/website-seo-aeo-geo/SKILL.md +624 -0
  916. package/dist/knowledge/skills/website-seo-aeo-geo/references/aeo-api.md +633 -0
  917. package/dist/knowledge/skills/website-seo-aeo-geo/references/geo-api.md +193 -0
  918. package/dist/knowledge/skills/website-seo-aeo-geo/references/seo-api.md +790 -0
  919. package/dist/knowledge/topic-index.json +17510 -0
  920. package/dist/tsconfig.build.tsbuildinfo +1 -0
  921. package/dist/tsconfig.tsbuildinfo +1 -0
  922. package/package.json +49 -0
@@ -0,0 +1,652 @@
1
+ ---
2
+ name: rate-limit-authoring
3
+ description: Author per-endpoint rate limits — declare a `rateLimit?` policy on a resource operation variant (declarative path) or call `RateLimitBackendService.checkPolicy(req, res, policy, scopeKey, organizationId?, clientIdOverride?)` from a custom controller (hand-wired path). Use when the user says "rate-limit this endpoint", "add a per-IP cap", "throttle the magic-link / OTP / password-reset / register flow", "the endpoint is being abused", "tune the OAuth / SCIM token quota", or "the headers don't show the right `X-RateLimit-Reset`".
4
+ ---
5
+
6
+ # Rate-Limit Authoring
7
+
8
+ ### Target Application Framing
9
+
10
+ This knowledge is for configuring behavior in the target application.
11
+ Wildo is the framework surface being used, not the product being built.
12
+
13
+ Read and apply these patterns from the application-developer point of view:
14
+
15
+ - how the application should configure the relevant app-level file
16
+ - how the application should use framework-provided factories, enums, and helpers
17
+ - how the application should avoid mixing frontend, backend, and infrastructure concerns
18
+
19
+
20
+ ## Overview
21
+
22
+ Per-endpoint rate limits in Wildo are **declarative**: a single
23
+ `RateLimitConfiguration` shape — optional `requestsPerMinute` /
24
+ `requestsPerHour` / `requestsPerDay` / `customWindows` — feeds two
25
+ consumption surfaces, layered behind the global HTTP per-IP safety net
26
+ (`RuntimeConfig.httpServerConfiguration.rateLimiting`).
27
+
28
+ | Surface | Where authors declare it | When the framework enforces it |
29
+ |---|---|---|
30
+ | **Resource operation variant** (preferred) | `rateLimit?: RateLimitConfiguration` field on `API_CALL` / `API_CALL_WITH_CALLBACK` variants in `<resource>.resources-config.ts` | `ControllerResourceBackendService.doOperation` runs `RateLimitBackendService.checkPolicyForVariant(req, res, variant)` BEFORE execution-context creation, request-data validation, and authorization. Bucket is IP-keyed by construction (no authenticated identity exists yet at this seam). |
31
+ | **Custom controller** (hand-wired routes: auth, SCIM, marketing public endpoints) | `RateLimitBackendService.checkPolicy(req, res, policy, scopeKey, organizationId?, clientIdOverride?)` inline at the controller method | When the controller method is invoked; the author chooses the bucket key (IP by default, or any resolved subject identifier via `clientIdOverride`). |
32
+
33
+ A request is allowed only when it passes **every declared window**
34
+ (`AND` semantics). On 429:
35
+
36
+ - `X-RateLimit-Limit / -Remaining / -Reset` reports the **tightest
37
+ active window** (fewest remaining slots) — the binding quota the
38
+ client should respect.
39
+ - `Retry-After` (RFC 6585) and the error body's `retryAfterSeconds`
40
+ report the **latest tripped window**. Declared windows are AND-ed, so
41
+ a retry cannot succeed until every exceeded window has reset.
42
+
43
+ Both surfaces fail-closed when Redis is unavailable (the underlying
44
+ `RedisService.incrementRateLimit` throws `ErrorType.DATABASE` rather
45
+ than silently passing traffic). The global HTTP
46
+ limiter keeps its in-memory fail-open `Map` as the noisy-neighbor
47
+ preventer at the perimeter; the per-endpoint surface is the security
48
+ boundary.
49
+
50
+ ## Paths
51
+
52
+ Application projects use the app-root paths below. Read the installed package
53
+ declarations or this skill's source-backed references for exact public shapes.
54
+
55
+ | Surface | Typical application path / public contract |
56
+ |---|---|
57
+ | Resource configuration with `rateLimit?` | `shared-lib/src/modules/<slug>/resources/<resource>/<resource>.resources-config.ts` |
58
+ | Custom controller calling `checkPolicy` | `backend-api/src/modules/<slug>/controllers/*.controller.ts` |
59
+ | Schema (`RateLimitConfiguration`) | declared `@wildo-ai/saas-models` contract |
60
+ | Service (`RateLimitBackendService`) | declared `@wildo-ai/saas-backend-lib` contract |
61
+ | Phone-bucket helper | **Blocked public surface:** the installed package does not currently expose a public phone-normalization helper. Keep the per-phone normalization requirement, but ask the application/framework owner for a declared contract rather than importing `AuthControllerUtils` or a private path. |
62
+ | IP extraction helper | declared `@wildo-ai/saas-backend-lib` `getClientIpFromRequest` contract |
63
+
64
+ ## When to Use
65
+
66
+ - A public anonymous endpoint that needs abuse protection beyond the
67
+ global per-IP safety net (e.g. `INBOUND_CONTACTS.CREATE`,
68
+ `auth/identify`, `auth/magic-link/send`).
69
+ - An authenticated endpoint that needs a per-user cap (e.g. SCIM
70
+ per-token quota, password-change throttle).
71
+ - A sensitive flow where the bucket key is the resolved subject
72
+ identifier rather than the IP (so credential-stuffing-style IP
73
+ rotation cannot bypass the cap — see "Bucket-Key Strategy" below).
74
+
75
+ ## When NOT to Use
76
+
77
+ - The global HTTP per-IP limiter
78
+ (`RuntimeConfig.httpServerConfiguration.rateLimiting`) is sufficient
79
+ → no per-endpoint policy needed; the safety net catches it.
80
+ - WebSocket per-event throttling → out of scope; it is a distinct installed
81
+ runtime concern with different enforcement semantics.
82
+ - Outbound throttling against an external API → that's a CLIENT-SIDE
83
+ concern (uses `ExternalProvider_RateLimitConfigurationSchema` from
84
+ `@wildo-ai/external-connectors-models` — `maxConcurrent` / `minTime`
85
+ / `reservoir`-style token-bucket fields, NOT the inbound
86
+ `RateLimitConfiguration` shape this SKILL covers).
87
+ - A counter that doesn't actually reject traffic on overflow (e.g.
88
+ observability-only `redisService.incrementRateLimit` calls used as a
89
+ generic `INCR + TTL` primitive) → don't go through this surface;
90
+ that's an INC-counter pattern, not a rate limit.
91
+ - Quota/cooldown counters with non-rate-limit semantics:
92
+ - SSO grace login counters are read-before-check and incremented only
93
+ after successful password auth. They model a finite fallback quota,
94
+ not "N requests per window".
95
+ - SAML certificate-expiry audit warnings use an hourly Redis cooldown
96
+ to avoid duplicate audit events. They do not reject user traffic.
97
+ If more of these appear, extract a quota/cooldown helper rather than
98
+ forcing them through `checkPolicy` or K-3 `checkRateLimit`.
99
+
100
+ ## Workflow
101
+
102
+ ### Step 1: Pick the surface
103
+
104
+ | Situation | Surface |
105
+ |---|---|
106
+ | The endpoint is a `CoreResourceOperation` (`CREATE` / `READ` / `UPDATE` / `LIST` / `DELETE`) or a typed custom operation on a registered `ResourceConfiguration` | **Resource operation variant** — declare `rateLimit?` on the variant. The pre-flight seam runs before EC creation; F-22 fail-fast is automatic. |
107
+ | The route is hand-wired in a controller class (`@httpPost(...)`-style or framework-internal auth/SCIM controllers) | **Custom controller** — call `checkPolicy(...)` inline. You own the call site, so you also own the F-22 ordering (call BEFORE the expensive operation). |
108
+
109
+ If you are unsure: **prefer the resource-operation variant**. The
110
+ declarative path centralizes the policy in the resource configuration
111
+ (visible in the spec docs, replayable across consumers), and the
112
+ pre-flight seam guarantees the F-22 fail-fast ordering.
113
+
114
+ ### Step 2: Author the policy
115
+
116
+ Declare ONE `RateLimitConfiguration` with the windows you actually
117
+ need. Multiple windows on the same bucket COMPOSE in a single call
118
+ (do NOT split into two `checkPolicy` invocations — see "Multi-Window
119
+ Collapse" below).
120
+
121
+ <!-- TIER C WAIVER: composite juxtaposing the resource-operation rateLimit? surface and the custom-controller checkPolicy surface with illustrative scope keys; no single real call site shows both, so anchoring would fragment the side-by-side contrast. -->
122
+ ```ts
123
+ // Resource-operation surface — `rateLimit?` on the variant builder
124
+ {
125
+ variantType: ResourceOperationVariantType.API_CALL,
126
+ httpVerb: HttpMethod.POST,
127
+ rateLimit: {
128
+ requestsPerMinute: 5,
129
+ requestsPerHour: 30,
130
+ },
131
+ // ... other variant fields
132
+ }
133
+
134
+ // Custom-controller surface — `checkPolicy` at the call site
135
+ await this.rateLimitService.checkPolicy(
136
+ req,
137
+ res,
138
+ { requestsPerMinute: 10, requestsPerHour: 100 },
139
+ 'auth:magic-link:send:by-ip', // F-15 scope-key naming
140
+ );
141
+ ```
142
+
143
+ ### Step 3: Pick the bucket key (custom-controller surface only)
144
+
145
+ The resource-operation surface always buckets by IP — the
146
+ authenticated identity is unknown at the pre-flight seam by
147
+ construction. Custom controllers can supply a `clientIdOverride` when
148
+ they have a stronger identity than IP. The choice has **direct
149
+ security consequences**: a bucket key derived from a value the
150
+ attacker controls is bypassable by varying that value.
151
+
152
+ | Resolved subject identifier | `clientIdOverride` value | Why |
153
+ |---|---|---|
154
+ | SCIM token id | `token._id` | One token, one bucket — independent of which IP the IdP calls from. |
155
+ | Authenticated user | `userId` | One user, one bucket across all their devices/IPs — credential-stuffing-style IP rotation cannot bypass. |
156
+ | Email-keyed flow (password reset, magic link, register) | `email.toLowerCase()` (D-4) | One email, one bucket across all originating IPs. |
157
+ | Phone-keyed flow (SMS OTP send) | `phoneRateLimitBucketKey(phone)` (F-14) | One phone number, one bucket across IP and across `+ / 00` international-prefix variants. |
158
+ | Composite (e.g. per-user per-source) | `${userId}:${source}` (D-5: `:`-separated) | When two dimensions matter equally, join with `:`. Document the composition order at the call site. |
159
+
160
+ Omit `clientIdOverride` for pre-auth flows where no better identity
161
+ exists yet (e.g. `auth/identify`, anonymous-session init) — the
162
+ default `getClientIpFromRequest(req)` is correct. NEVER pass `req.ip`
163
+ directly: it disagrees with the framework's IP extraction behind
164
+ proxies (C-1 / F-7).
165
+
166
+ ### Step 4: Order multiple checks victim-protectively (F-20)
167
+
168
+ When a single endpoint has both an identity-keyed cap (per-email,
169
+ per-user) AND an IP-keyed cap, the identity check must fire FIRST so
170
+ the email/user counter is decremented BEFORE the IP counter. Order:
171
+
172
+ <!-- TIER C WAIVER: distilled two-call ordering illustration (per-email FIRST, per-IP SECOND) for the F-20 victim-protective principle; the lesson is call ordering, not a verbatim engine call site. -->
173
+ ```ts
174
+ // F-20: per-email FIRST (protects the victim's account)
175
+ await this.rateLimitService.checkPolicy(
176
+ req, res,
177
+ { requestsPerMinute: 5, requestsPerHour: 30 },
178
+ 'auth:register:by-email',
179
+ undefined,
180
+ email.toLowerCase(), // D-4 baseline
181
+ );
182
+ // Per-IP SECOND (catches IP-rotation flooding)
183
+ await this.rateLimitService.checkPolicy(
184
+ req, res,
185
+ { requestsPerMinute: 10, requestsPerHour: 100 },
186
+ 'auth:register:by-ip',
187
+ );
188
+ ```
189
+
190
+ Reverse ordering would let an attacker exhaust the per-email window
191
+ without their IP being throttled — the victim sees rate-limit errors
192
+ on their own account while the attacker continues from a fresh IP.
193
+
194
+ ### Step 5: Verify the headers and 429 behavior
195
+
196
+ After the call lands, hit the endpoint enough times to trip the
197
+ binding window and verify:
198
+
199
+ - `X-RateLimit-Limit` / `-Remaining` / `-Reset` are emitted on EVERY
200
+ response (not only 429s) and report the tightest ACTIVE window
201
+ (the one with the fewest remaining slots after this request).
202
+ - `Retry-After` is emitted on the 429 (RFC 6585 spelling) and matches
203
+ the latest tripped window — clients/proxies that don't parse the JSON
204
+ body still get the right hint.
205
+ - The error body carries `error.type: 'RATE_LIMIT'` with
206
+ `retryAfterSeconds` matching `Retry-After`.
207
+ - A second `checkPolicy` invocation on the same response (e.g. a
208
+ resource operation that ALSO triggers a service-level
209
+ `checkPolicy`) does NOT overwrite the first call's headers with
210
+ looser values (F-9 compare-and-set guard preserves the tighter
211
+ window).
212
+
213
+ ## Authoring Conventions
214
+
215
+ ### Bucket-Key Strategy (the F-conventions)
216
+
217
+ The conventions below encode durable security properties. The labels (F-7,
218
+ F-14, and so on) are mnemonic names used by this skill; their meaning is fully
219
+ defined here, not in a private migration plan.
220
+
221
+ - **F-7 — Unknown IP closure (HTTP-derived buckets):** When the
222
+ bucket key derives from the current request's IP, use
223
+ `getClientIpFromRequest(req)` directly (no `if (ipAddress)` guard).
224
+ The helper returns the literal string `'unknown'` when no IP can
225
+ be extracted — co-bucket those requests rather than letting them
226
+ bypass the limit. The exception (rare): when the bucket key derives
227
+ from session-stored IP captured at a DIFFERENT request seam
228
+ (e.g. `session.deviceInfo?.ipAddress` set at identify time), a
229
+ missing value means "the session was created without an IP" — a
230
+ different population from "this request lacks an IP" — and the
231
+ K-3 escape-hatch sites with `if (ipAddress)` guards (see
232
+ `PASSWORD_IP` block in `auth-constants.backend.ts`) are
233
+ deliberate exceptions, not unfinished work.
234
+
235
+ - **F-14 — Phone normalization:** ALWAYS bucket phone numbers via
236
+ `phoneRateLimitBucketKey(phone)` (strips `+` and `00`
237
+ international prefixes). Without normalization, an attacker who
238
+ varies between `+33612345678` / `0033612345678` /
239
+ `33612345678` gets three distinct buckets for the same phone
240
+ number — the per-phone cap is then trivially bypassable.
241
+
242
+ - **F-15 — Scope-key naming with `:by-<dimension>` suffix:** When a
243
+ single endpoint declares multiple buckets (per-email AND per-IP,
244
+ per-user AND per-source), suffix the scope key with the bucket
245
+ dimension: `auth:register:by-email`, `auth:register:by-ip`,
246
+ `auth:magic-link:send:by-ip`, `scim:tokens:by-token`. Without the
247
+ suffix, two `checkPolicy` calls on the same scope key with
248
+ different `clientIdOverride` values would COLLIDE on the same
249
+ Redis namespace (the scope is the same, but the meaning differs)
250
+ and one cap would silently consume the other's quota.
251
+
252
+ - **F-20 — Victim-protective ordering:** When an endpoint declares
253
+ BOTH an identity-keyed cap AND an IP-keyed cap, ALWAYS call the
254
+ identity-keyed check FIRST. See Step 4 above for the rationale.
255
+
256
+ - **F-22 — Fail-fast ordering at the call site:** Call `checkPolicy`
257
+ BEFORE execution-context creation, JWT extraction, DB lookups,
258
+ external API calls, or any other expensive operation. The
259
+ resource-operation surface gets this for free (the pre-flight
260
+ seam runs before EC creation). For custom controllers, the call
261
+ must precede the expensive work — otherwise rate-limited requests
262
+ still pay the cost they were meant to deflect. Documented
263
+ exceptions exist where the bucket key REQUIRES authenticated
264
+ session state to compute (`crossFrontendHandoff`, MFA enrollment,
265
+ the K-3 escape-hatch sites); document the exception inline at the
266
+ call site.
267
+
268
+ - **D-3 — `customWindows` is the escape hatch:** Reach for
269
+ `requestsPerMinute / Hour / Day` first. `customWindows` exists
270
+ for the rare endpoint whose business semantics genuinely don't
271
+ fit a 60s / 3600s / 86400s grid — the canonical example is the
272
+ SMS phone-verify family with a 5-minute (300s) window tied to
273
+ the OTP TTL (rounding to minute would let attackers through;
274
+ rounding to hour would DoS legitimate users). It is NOT a
275
+ convenience knob for arbitrary tuning.
276
+
277
+ - **D-4 — Email normalization baseline:** Apply `.toLowerCase()` at
278
+ every email-keyed bucket key seam. Plus-addressing
279
+ (`alice+tag@example.com`) and Gmail-dot tricks
280
+ (`a.l.i.c.e@gmail.com`) are NOT normalized at this layer — those
281
+ are tracked as a separate deferred normalization pass. The
282
+ `.toLowerCase()` call is preserved at every call site even when
283
+ the upstream schema already lowercases (e.g.
284
+ `AuthIdentificationRequestSchema` lowercases via
285
+ `.email().toLowerCase()`) — keeping the call site
286
+ intent-revealing prevents future schema changes from silently
287
+ breaking the bucket.
288
+
289
+ - **D-5 — Composite `clientIdOverride` separator:** When two
290
+ dimensions matter equally (e.g. per-user per-source), join with
291
+ `:`. Document the composition order at the call site so a future
292
+ reader knows which dimension is the prefix.
293
+
294
+ ### Multi-Window Collapse
295
+
296
+ When the SAME bucket needs MULTIPLE windows (e.g. per-email 5/min
297
+ AND 30/hour), declare BOTH windows on a SINGLE `checkPolicy` call:
298
+
299
+ <!-- TIER C WAIVER: distilled single-call multi-window illustration (minute AND hour on one checkPolicy); the real magic-link call site is named in the lead comment for cross-check. -->
300
+ ```ts
301
+ // CORRECT (PR 8b magic-link convention) — one call, AND-ed windows
302
+ await this.rateLimitService.checkPolicy(
303
+ req, res,
304
+ {
305
+ requestsPerMinute: appConfigService.config.auth.magicLinkOperational.perEmailPerMinute,
306
+ requestsPerHour: appConfigService.config.auth.magicLinkOperational.perEmailPerHour,
307
+ },
308
+ 'auth:magic-link:send:by-email',
309
+ undefined,
310
+ email.toLowerCase(), // D-4
311
+ );
312
+ ```
313
+
314
+ ```ts
315
+ // WRONG — two calls force header logic to compose across calls
316
+ await this.rateLimitService.checkPolicy(req, res, { requestsPerMinute: 5 }, 'auth:magic-link:send:by-email', undefined, email.toLowerCase());
317
+ await this.rateLimitService.checkPolicy(req, res, { requestsPerHour: 30 }, 'auth:magic-link:send:by-email', undefined, email.toLowerCase());
318
+ ```
319
+
320
+ The single-call form lets `checkPolicy` pick the tightest active
321
+ window AND the latest tripped window in ONE pass; the
322
+ double-call form forces the second call to compete against the
323
+ first call's already-set headers via the F-9 compare-and-set guard
324
+ — it works, but the intent is muddied and the second call's
325
+ window-name (`'minute'` vs `'hour'`) collides with the first call's
326
+ key on the same Redis bucket.
327
+
328
+ ## When `checkPolicy` is NOT the right answer (K-3 escape hatch)
329
+
330
+ For the rare case where the bucket key is **not cheaply derivable
331
+ from HTTP-layer inputs** (`req.ip`, `req.body.email`, `req.body.phone`,
332
+ authenticated `userId` from JWT), the framework retains the lower-
333
+ level `checkRateLimit(key, max, windowSeconds, organizationId?, messageOverride?, options?)`
334
+ imperative API as the **escape hatch**. Four canonical sites in the
335
+ engine use it today:
336
+
337
+ - **`AuthenticationOrchestrator.sendSMSOTP`** — bucket key is the
338
+ phone number resolved from the session via DB lookup (the
339
+ `session.userId` first resolves to a user, then to the user's
340
+ verified phone). Computing this at the controller layer would
341
+ duplicate the lookup and leak orchestration into the controller.
342
+ - **`AuthenticationOrchestrator.authenticatePassword`** — dual
343
+ buckets per-email + per-IP, both keyed off `session.email` /
344
+ `session.deviceInfo?.ipAddress` captured at `identify` time. The
345
+ per-IP bucket carries the F-7 EXCEPTION documented above (a
346
+ session created without an IP is a different population from a
347
+ request without an IP — different threat surfaces, different
348
+ buckets).
349
+ - **`AuthenticationOrchestrator.sendEmailOTP`** — bucket key
350
+ is `session.userId` (per-user 5/min OTP-send cap). Migrated from
351
+ `redisService.incrementRateLimit` to `checkRateLimit` in Step 7
352
+ F-23 sub-PR a. The OTP-specific user-facing message is preserved
353
+ via the `messageOverride` parameter (existing OTP UX depended on
354
+ the OTP-specific phrasing — `'Too many OTP requests. Please
355
+ wait before requesting another code.'` — not the generic
356
+ rate-limit message). This is the canonical use of `messageOverride`:
357
+ preserve domain-specific UX context the generic rate-limit
358
+ message would lose.
359
+ - **`AuthenticationOrchestrator.authenticatePassword` global lockout**
360
+ — bucket key is `session.email` (captured at identify time, not
361
+ HTTP-derived) and the user-facing envelope is NOT a 429. This is
362
+ the canonical use of the Step 3.1 bridge `options` parameter:
363
+ preserve the existing
364
+ `ErrorType.AUTHENTICATION` +
365
+ `AUTHENTICATION_ACCOUNT_LOCKED` +
366
+ `{ lockoutDurationMinutes }`
367
+ contract while still routing the counter mechanics through the
368
+ framework primitive.
369
+
370
+ Reach for `checkRateLimit` ONLY when both:
371
+
372
+ 1. The bucket key requires session-resolved or DB-resolved state
373
+ the controller layer doesn't have, AND
374
+ 2. Lifting the check to the controller layer would force the
375
+ controller to duplicate orchestrator logic (email-resolution,
376
+ phone-resolution).
377
+
378
+ For everything else: `checkPolicy` is the right surface. If you
379
+ find yourself reaching for `checkRateLimit`, write a one-paragraph
380
+ K-3 ESCAPE-HATCH justification at the call site explaining (a) why
381
+ the bucket key isn't HTTP-derivable, and (b) why moving the check
382
+ to the controller would duplicate logic. Cross-reference the K-3
383
+ constant in the relevant `*-constants.backend.ts` so a future
384
+ auditor can verify the call site against the constants block.
385
+
386
+ A third surface — `redisService.incrementRateLimit` called directly
387
+ without going through `RateLimitBackendService` — is now CLOSED for
388
+ inbound rate-limit enforcement use. The only remaining direct
389
+ engine uses are distinct subsystems/counters: the global HTTP limiter
390
+ system 1, SSO grace quota bookkeeping, and SAML audit cooldown
391
+ de-duplication. Do NOT add new direct call sites that throw or gate
392
+ inbound traffic based on the count.
393
+
394
+ ### Bridge `options` on `checkRateLimit` (the escape-hatch's escape-hatch)
395
+
396
+ Most K-3 callers want a 429 `RATE_LIMIT` envelope — the generic
397
+ "too many requests, retry in N seconds" UX. A small minority want
398
+ the same per-key cap-and-throw mechanic but a DIFFERENT error
399
+ envelope. The canonical case is the `authenticatePassword` global
400
+ lockout counter: semantically a per-email cap, but UX-wise an
401
+ "account temporarily locked" 401 (so it routes through the same
402
+ frontend handler as the existing status-derived
403
+ `AUTHENTICATION_ACCOUNT_LOCKED` throws and shares the
404
+ `lockoutDurationMinutes` context payload).
405
+
406
+ `checkRateLimit`'s `options?` parameter is the bridge:
407
+
408
+ - `options.errorType` overrides the default `ErrorType.RATE_LIMIT`
409
+ (the lockout site uses `ErrorType.AUTHENTICATION` to share the
410
+ 401 handler chain).
411
+ - `options.customMessageReference` adds the
412
+ `customMessageReference` field to the built error (the lockout
413
+ site uses `AUTHENTICATION_ACCOUNT_LOCKED`). When omitted, the
414
+ field is not present on `buildError`'s opts at all — the default
415
+ K-3 `RATE_LIMIT` callers stay on the plain pre-bridge form.
416
+ - `options.contextExtra` adds extra fields to the error `context`
417
+ (e.g. `{ lockoutDurationMinutes: 30 }`). The canonical
418
+ `message` and `retryAfterSeconds` always win on collision; use
419
+ `messageOverride` to swap the message, never
420
+ `contextExtra.message`.
421
+
422
+ Reach for `options` ONLY when the call site needs a non-RATE_LIMIT
423
+ envelope. If you find yourself adding `errorType: ErrorType.RATE_LIMIT`
424
+ explicitly — drop the `options` argument entirely and let the
425
+ default kick in. The bridge is a forking point, not a configuration
426
+ surface.
427
+
428
+ ## Worked Example — Resource Operation Surface
429
+
430
+ The framework's public `inbound-contacts` lead-capture resource declares the
431
+ canonical multi-window per-IP policy on its anonymous `CREATE` — the same
432
+ `rateLimit?` field is available on any resource operation you author:
433
+
434
+
435
+ ## Usage Example
436
+
437
+ ```typescript
438
+ {
439
+ variantType: ResourceOperationVariantType.API_CALL,
440
+ isDefault: true,
441
+ roles: [CORE_APP_ROLES.APP_ANONYMOUS],
442
+ riskLevel: ResourceOperationRiskLevel.LOW,
443
+ // Public anonymous CREATE — declares the per-IP rate-limit on the
444
+ // default API_CALL variant. Two windows (a short burst limit + an
445
+ // hourly cap) are AND-ed and enforced at the controller pre-flight
446
+ // seam; no bucket-key choice is needed here because IP is the only
447
+ // identity available before execution-context creation. The global
448
+ // HTTP limiter remains the safety net for any path that bypasses
449
+ // this surface.
450
+ rateLimit: {
451
+ requestsPerMinute: 5,
452
+ requestsPerHour: 30,
453
+ },
454
+ },
455
+ ```
456
+
457
+ What earns its place:
458
+
459
+ - `rateLimit?` declared on the **default `API_CALL` variant** —
460
+ auto-variants (`SUMMARY` / `CONTEXT` for READ/LIST) inherit the
461
+ field by design (one declaration covers all derived variants).
462
+ - **Two windows in ONE declaration** — minute + hour AND-ed; the
463
+ pre-flight seam picks the tightest active for headers and the
464
+ latest tripped for `Retry-After` automatically.
465
+ - **No bucket-key choice at this layer** — the pre-flight seam
466
+ buckets by IP (the only identity available before EC creation);
467
+ this is correct for a public anonymous endpoint where IP is the
468
+ best-available identity.
469
+ - **No `console.log`, no `if (ipAddress)` guard, no scope-key
470
+ naming concern** — the resource-controller seam owns the F-7
471
+ closure, the F-22 fail-fast ordering, and the
472
+ `resource:<RESOURCE>:<OPERATION>` scope-key shape.
473
+
474
+ What is **not** in this block (and shouldn't be):
475
+
476
+ - No `clientIdOverride` (no authenticated identity at this seam).
477
+ - No service-layer `checkRateLimit` duplicate (the pre-flight seam
478
+ is the SINGLE enforcement point for resource-operation policies).
479
+
480
+ ## Worked Example — Custom Controller Surface
481
+
482
+ The framework-internal `AuthenticationController.identify` declares the
483
+ canonical dual-bucket per-email + per-IP policy at the controller seam:
484
+
485
+
486
+ ## Usage Example
487
+
488
+ ```typescript
489
+ // Dual-bucket at the controller seam: per-email FIRST (victim-protective
490
+ // ordering — the named account is decremented before the loud source),
491
+ // then per-IP. Distinct scope keys prevent collision; both run before
492
+ // execution-context creation so the limit fails fast.
493
+ await this.rateLimitService.checkPolicy(
494
+ req,
495
+ res,
496
+ { requestsPerMinute: 10 },
497
+ 'auth:identify:by-email',
498
+ undefined,
499
+ body.email.toLowerCase(),
500
+ );
501
+ await this.rateLimitService.checkPolicy(
502
+ req,
503
+ res,
504
+ { requestsPerMinute: 10 },
505
+ 'auth:identify:by-ip',
506
+ );
507
+ ```
508
+
509
+ What earns its place:
510
+
511
+ - **Two `checkPolicy` calls** — one per dimension, F-15 distinct
512
+ scope keys (`:by-email` / `:by-ip`) prevent Redis collision.
513
+ - **F-20 ordering** — per-email FIRST so the victim's email
514
+ counter is decremented before the attacker's IP counter; reverse
515
+ order would let IP-rotation drain the per-email cap silently.
516
+ - **F-22 ordering** — both calls precede EC creation, JWT
517
+ extraction, and the orchestrator dispatch.
518
+ - **D-4 baseline** — `email.toLowerCase()` at the bucket-key seam,
519
+ even though the schema already lowercases (the call site stays
520
+ intent-revealing).
521
+ - **F-7 closure** — no `if (ipAddress)` guard on the per-IP call;
522
+ the default `getClientIpFromRequest(req)` co-buckets unknown
523
+ IPs via the `'unknown'` sentinel.
524
+ - **`checkPolicy` not `checkRateLimit`** — bucket keys are
525
+ HTTP-derivable (request body `email` + request `ip`), so the
526
+ declarative path is the right surface (NOT a K-3 escape-hatch
527
+ case).
528
+
529
+ What is **not** in this block (and shouldn't be):
530
+
531
+ - No `console.log` of the rate-limit decision (the headers + 429
532
+ are the contract).
533
+ - No `req.ip` reference (use `getClientIpFromRequest(req)` via the
534
+ default — `req.ip` disagrees behind proxies).
535
+ - No `organizationId` (pre-auth seam; tenant unknown by
536
+ construction).
537
+
538
+ ## References
539
+
540
+ - `references/framework-rate-limit-policy-api.md` — source-backed
541
+ excerpts of `RateLimitConfiguration` (the policy shape) and
542
+ `RateLimitBackendService.checkPolicy` (the custom-controller
543
+ surface API).
544
+ - `references/scope-key-and-bucket-conventions.md` — the
545
+ F-7 / F-14 / F-15 / F-20 / F-22 / D-3 / D-4 / D-5 conventions
546
+ reformatted as a dense reference cheat sheet for code review.
547
+ - `backend-custom-operation/SKILL.md` — sibling skill for authoring
548
+ the operation pipeline an `API_CALL` variant invokes; the
549
+ `rateLimit?` field on that variant is enforced BEFORE the
550
+ operation handler runs.
551
+ - `resource-config-wiring/SKILL.md` (when present) — declaring
552
+ `ResourceConfiguration` entries that carry `rateLimit?` on
553
+ variants.
554
+ - The convention labels above are self-contained. Apply their described
555
+ security properties; do not depend on private migration history.
556
+
557
+ ## Verification
558
+
559
+ - [ ] If on the resource-operation surface: `rateLimit?` declared
560
+ on the variant builder parameters (NOT on the operation; per
561
+ K-5 the field lives on variants so different variants of the
562
+ same operation can declare different policies).
563
+ - [ ] If on the custom-controller surface: `checkPolicy` invoked
564
+ BEFORE EC creation, JWT extraction, DB lookups (F-22).
565
+ - [ ] Multi-window collapsed into ONE `checkPolicy` call when both
566
+ windows share the SAME bucket (PR 8b convention).
567
+ - [ ] Multiple buckets on one endpoint use F-15 `:by-<dim>` suffix.
568
+ - [ ] Identity-keyed checks (per-email, per-user, per-phone) fire
569
+ BEFORE per-IP checks (F-20).
570
+ - [ ] Email-keyed bucket keys apply `.toLowerCase()` at the call
571
+ site (D-4), even when the schema already lowercases.
572
+ - [ ] Phone-keyed bucket keys go through `phoneRateLimitBucketKey`
573
+ (F-14).
574
+ - [ ] No `if (ipAddress)` guard around HTTP-derived per-IP checks
575
+ (F-7 closure via the `'unknown'` sentinel) — guards only at
576
+ K-3 escape-hatch sites with a documented exception block.
577
+ - [ ] No `req.ip` direct reference (use `getClientIpFromRequest`
578
+ via the default).
579
+ - [ ] No new `RateLimitBackendService.checkRateLimit` call site
580
+ unless the K-3 escape-hatch criteria are documented at the
581
+ call site with a one-paragraph justification.
582
+ - [ ] No new `redisService.incrementRateLimit` direct call site
583
+ for rate-limit enforcement (F-23 surface is fully closed
584
+ outside system 1 + `RateLimitBackendService`).
585
+
586
+ ### Grep invariants
587
+
588
+ Run from the app root, substituting `<slug>` and `<resource>`:
589
+
590
+ | Invariant | Command |
591
+ |---|---|
592
+ | `rateLimit?` declared on variant builder | `rg -n "rateLimit:\s*\{" shared-lib/src/modules/<slug>/resources/<resource>/` |
593
+ | `checkPolicy` invoked from controller | `rg -n "rateLimitService\.checkPolicy\(" backend-api/src/modules/<slug>/controllers/` |
594
+ | **No `req.ip` direct reference** (must be empty in custom controllers; use `getClientIpFromRequest`) | `rg -n "\\breq\\.ip\\b" backend-api/src/modules/<slug>/controllers/` |
595
+ | **No `if (ipAddress)` guard** around per-IP `checkPolicy` (must be empty outside K-3 sites) | `rg -nB1 "checkPolicy\\([^)]*\\.by-ip" backend-api/src/modules/<slug>/controllers/ \| rg "if \\(ipAddress\\)"` |
596
+ | F-15 `:by-<dim>` suffix when an endpoint declares multiple buckets | `rg -n "checkPolicy\\(" backend-api/src/modules/<slug>/controllers/<file>.controller.ts \| rg ":by-"` |
597
+
598
+ The high-signal invariant is **"no `req.ip` direct reference"**
599
+ combined with **"no `if (ipAddress)` guard around per-IP
600
+ `checkPolicy`"** — those are the two traps PR 7-D-3 / PR 7b /
601
+ PR 8c kept catching during the migration audit.
602
+
603
+ ## Common Rationalizations
604
+
605
+ | Rationalization | Reality |
606
+ |---|---|
607
+ | "I'll just call `checkRateLimit` directly — it's simpler." | `checkRateLimit` is the K-3 escape hatch, not the default surface. It does NOT emit `X-RateLimit-*` headers, does NOT support multi-window AND-ing, does NOT provide the F-9 compare-and-set guard against header overwrites. Use `checkPolicy` unless the bucket key is genuinely not HTTP-derivable. |
608
+ | "Two windows = two `checkPolicy` calls." | Wrong. ONE call with both windows declared (PR 8b convention). Two calls force the F-9 compare-and-set guard to mediate the headers — works, but the intent is muddied and the Redis key suffixes (`:minute` / `:hour`) collide on the same bucket. |
609
+ | "I'll skip `.toLowerCase()` since the schema already lowercases the email." | The call-site invariant is intent-revealing (D-4). Skipping it makes a future schema change a silent bucket-key migration — every previously-bucketed user gets a fresh bucket because the casing changed. Always `.toLowerCase()` at the bucket-key seam. |
610
+ | "I'll bucket the phone number raw — `+33...` and `0033...` are different international formats." | They're the same phone number with different prefixes. `phoneRateLimitBucketKey` (F-14) strips both so the per-phone cap holds across format variants. Bucketing raw makes the cap trivially bypassable. |
611
+ | "I'll wrap the per-IP `checkPolicy` in `if (ipAddress)` so unknown IPs aren't penalized." | Wrong direction. Unknown IPs should be CO-BUCKETED via the `'unknown'` sentinel from `getClientIpFromRequest` (F-7) — otherwise an attacker behind a proxy that strips IP headers gets unlimited free traffic. The `'unknown'` bucket is shared across all such requests, which is the desired safety. K-3 sites are documented exceptions only. |
612
+ | "I'll call `checkPolicy` AFTER the JWT extraction so I have the user id." | F-22 violation. The point of rate-limiting is to deflect the cost of expensive operations — calling JWT extraction first means rate-limited requests still pay the parse + verify cost. If you need the user id, the bucket key isn't HTTP-derivable; consider whether this is actually a K-3 escape-hatch case. |
613
+ | "I'll add a per-second peak limit." | Use `customWindows: [{ requestsPerWindow: 100, windowSeconds: 1 }]` (D-3 escape hatch). The canonical windows are minute / hour / day; per-second policies aren't a first-class window because they're rare in practice (most endpoints want minute-grained rate limits, not peak-rate token-bucket semantics). |
614
+ | "Per-email AND per-IP — order doesn't matter, both fire." | F-20 violation. Per-email FIRST so the victim's email counter is decremented before the attacker's IP counter — reverse order lets IP rotation drain the per-email cap silently. |
615
+
616
+ ## Red Flags
617
+
618
+ - A `checkPolicy` call without `:by-<dim>` suffix on the scope key
619
+ AND another `checkPolicy` call on the same scope key with a
620
+ different `clientIdOverride` (F-15 collision — both end up in
621
+ the same Redis namespace).
622
+ - A `checkPolicy` call placed AFTER the orchestrator dispatch / EC
623
+ creation / JWT extraction without a documented F-22 exception.
624
+ - Per-IP `checkPolicy` wrapped in `if (ipAddress)` guard outside
625
+ the K-3 escape-hatch sites (F-7 violation — unknown IPs get
626
+ unlimited traffic).
627
+ - New call site to `RateLimitBackendService.checkRateLimit` without
628
+ a one-paragraph K-3 justification at the call site explaining
629
+ why the bucket key isn't HTTP-derivable.
630
+ - New direct call to `redisService.incrementRateLimit` (F-23
631
+ surface is closed for new use).
632
+ - `customWindows` declared with a duration that maps cleanly to
633
+ one of `60s` / `3600s` / `86400s` (D-3 misuse — use the canonical
634
+ field instead).
635
+ - Email-keyed bucket key without `.toLowerCase()` at the call site
636
+ (D-4 violation).
637
+ - Phone-keyed bucket key without `phoneRateLimitBucketKey`
638
+ normalization (F-14 violation).
639
+ - Two `checkPolicy` calls on the SAME bucket with windows that
640
+ could collapse into ONE call (PR 8b convention violation).
641
+ - `req.ip` referenced directly anywhere (must use
642
+ `getClientIpFromRequest(req)` — C-1 / F-7).
643
+
644
+ ## Related Skills
645
+
646
+ - `backend-custom-operation` — the operation handler pipeline an
647
+ `API_CALL` variant invokes. The `rateLimit?` field on that
648
+ variant runs BEFORE the operation handler.
649
+ - `resource-config-wiring` (when present) — declaring resource
650
+ configurations that carry `rateLimit?` on variants.
651
+ - `backend-addon-wiring` — module wiring for the controller class
652
+ that hosts hand-wired routes calling `checkPolicy`.