@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.11

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 (1011) hide show
  1. package/AUTHORING.md +269 -0
  2. package/CHANGELOG.md +82 -0
  3. package/LICENSE +202 -0
  4. package/README.md +189 -2
  5. package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +33 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
  7. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +9 -0
  8. package/agent-docs/SNAPSHOT.json +9 -0
  9. package/agent-docs/about.md +49 -0
  10. package/agent-docs/api-docs/focused-contracts.md +68 -0
  11. package/agent-docs/api-docs/generate.md +189 -0
  12. package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
  13. package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
  14. package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
  15. package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
  16. package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
  17. package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
  18. package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
  19. package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
  20. package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
  21. package/agent-docs/api-docs/support.md +97 -0
  22. package/agent-docs/author/add-page.md +124 -0
  23. package/agent-docs/author/agent-overview.md +59 -0
  24. package/agent-docs/author/agent-workflow.md +65 -0
  25. package/agent-docs/author/agents.md +53 -0
  26. package/agent-docs/author/analytics.md +286 -0
  27. package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
  28. package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
  29. package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
  30. package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
  31. package/agent-docs/author/analytics.sections/event-format.md +59 -0
  32. package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
  33. package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
  34. package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
  35. package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
  36. package/agent-docs/author/analytics.sections/related-reading.md +42 -0
  37. package/agent-docs/author/authoring-agent.md +102 -0
  38. package/agent-docs/author/coding-agent.md +90 -0
  39. package/agent-docs/author/components/action-link.md +41 -0
  40. package/agent-docs/author/components/api-embeds.md +263 -0
  41. package/agent-docs/author/components/api-embeds.sections/apiexample.md +117 -0
  42. package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
  43. package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
  44. package/agent-docs/author/components/badge.md +76 -0
  45. package/agent-docs/author/components/breadcrumbs.md +57 -0
  46. package/agent-docs/author/components/callout.md +131 -0
  47. package/agent-docs/author/components/cards.md +168 -0
  48. package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
  49. package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
  50. package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
  51. package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
  52. package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
  53. package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
  54. package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
  55. package/agent-docs/author/components/code-blocks.md +117 -0
  56. package/agent-docs/author/components/collapsible.md +99 -0
  57. package/agent-docs/author/components/cookbook-chooser.md +86 -0
  58. package/agent-docs/author/components/custom/react.md +190 -0
  59. package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
  60. package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
  61. package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
  62. package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
  63. package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
  64. package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
  65. package/agent-docs/author/components/custom.md +183 -0
  66. package/agent-docs/author/components/definition-list.md +54 -0
  67. package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
  68. package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
  69. package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
  70. package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
  71. package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
  72. package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
  73. package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
  74. package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
  75. package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
  76. package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
  77. package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
  78. package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
  79. package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
  80. package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
  81. package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
  82. package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
  83. package/agent-docs/author/components/diagrams.md +155 -0
  84. package/agent-docs/author/components/doc-link.md +58 -0
  85. package/agent-docs/author/components/fields.md +121 -0
  86. package/agent-docs/author/components/file-tree.md +84 -0
  87. package/agent-docs/author/components/images.md +103 -0
  88. package/agent-docs/author/components/info-hint.md +61 -0
  89. package/agent-docs/author/components/kbd.md +45 -0
  90. package/agent-docs/author/components/math.md +39 -0
  91. package/agent-docs/author/components/only.md +65 -0
  92. package/agent-docs/author/components/progress.md +53 -0
  93. package/agent-docs/author/components/related-reading.md +48 -0
  94. package/agent-docs/author/components/steps.md +121 -0
  95. package/agent-docs/author/components/tables.md +64 -0
  96. package/agent-docs/author/components/tabs.md +129 -0
  97. package/agent-docs/author/components/timeline.md +74 -0
  98. package/agent-docs/author/components/tooltips.md +58 -0
  99. package/agent-docs/author/components/walkthroughs.md +390 -0
  100. package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
  101. package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
  102. package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
  103. package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
  104. package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
  105. package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
  106. package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +53 -0
  107. package/agent-docs/author/components.md +78 -0
  108. package/agent-docs/author/content.md +74 -0
  109. package/agent-docs/author/cookbooks.md +119 -0
  110. package/agent-docs/author/css.md +238 -0
  111. package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
  112. package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
  113. package/agent-docs/author/css.sections/page-attributes.md +69 -0
  114. package/agent-docs/author/css.sections/page-transitions.md +60 -0
  115. package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
  116. package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
  117. package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
  118. package/agent-docs/author/custom-metadata.md +177 -0
  119. package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
  120. package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
  121. package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
  122. package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
  123. package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
  124. package/agent-docs/author/design-templates.md +49 -0
  125. package/agent-docs/author/design-writing-guides.md +73 -0
  126. package/agent-docs/author/frontmatter-reference.md +146 -0
  127. package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
  128. package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
  129. package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
  130. package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
  131. package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
  132. package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
  133. package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
  134. package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
  135. package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
  136. package/agent-docs/author/frontmatter.md +255 -0
  137. package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
  138. package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
  139. package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
  140. package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
  141. package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
  142. package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
  143. package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
  144. package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
  145. package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
  146. package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
  147. package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
  148. package/agent-docs/author/markdown-metadata.md +207 -0
  149. package/agent-docs/author/navigation.md +269 -0
  150. package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
  151. package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
  152. package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
  153. package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
  154. package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
  155. package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
  156. package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
  157. package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
  158. package/agent-docs/author/navigation.sections/related-reading.md +44 -0
  159. package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
  160. package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
  161. package/agent-docs/author/reader-views.md +200 -0
  162. package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
  163. package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
  164. package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
  165. package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
  166. package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
  167. package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
  168. package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
  169. package/agent-docs/author/recipe-drafts.md +181 -0
  170. package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
  171. package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
  172. package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
  173. package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
  174. package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
  175. package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
  176. package/agent-docs/author/recipes.md +127 -0
  177. package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
  178. package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
  179. package/agent-docs/author/recipes.sections/related-reading.md +36 -0
  180. package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
  181. package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
  182. package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
  183. package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
  184. package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
  185. package/agent-docs/author/related-reading.md +143 -0
  186. package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
  187. package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
  188. package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
  189. package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
  190. package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
  191. package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
  192. package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
  193. package/agent-docs/author/release-notes.md +153 -0
  194. package/agent-docs/author/search.md +299 -0
  195. package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
  196. package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
  197. package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
  198. package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
  199. package/agent-docs/author/search.sections/lexical-search.md +78 -0
  200. package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
  201. package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
  202. package/agent-docs/author/search.sections/related-reading.md +45 -0
  203. package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
  204. package/agent-docs/author/search.sections/turn-search-off.md +46 -0
  205. package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
  206. package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
  207. package/agent-docs/author/snippets.md +118 -0
  208. package/agent-docs/author/taxonomy.md +121 -0
  209. package/agent-docs/author/templates.md +231 -0
  210. package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
  211. package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
  212. package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
  213. package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
  214. package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
  215. package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
  216. package/agent-docs/author/templates.sections/related-reading.md +47 -0
  217. package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
  218. package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
  219. package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
  220. package/agent-docs/author/workspace/commands.md +92 -0
  221. package/agent-docs/author/workspace.md +104 -0
  222. package/agent-docs/author/writing-style.md +137 -0
  223. package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
  224. package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +42 -0
  225. package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
  226. package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
  227. package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
  228. package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +41 -0
  229. package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
  230. package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
  231. package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
  232. package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
  233. package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
  234. package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
  235. package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
  236. package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
  237. package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
  238. package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
  239. package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
  240. package/agent-docs/changelog/2026-10-25.md +45 -0
  241. package/agent-docs/changelog/2026-10-26.md +66 -0
  242. package/agent-docs/changelog/2026-10-27.md +85 -0
  243. package/agent-docs/changelog/authoring-preview.md +40 -0
  244. package/agent-docs/changelog/authoring-search.md +39 -0
  245. package/agent-docs/changelog/authoring-tools.md +34 -0
  246. package/agent-docs/changelog/working-tree-skill.md +38 -0
  247. package/agent-docs/changelog.md +115 -0
  248. package/agent-docs/chat/checks.md +175 -0
  249. package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
  250. package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
  251. package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
  252. package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
  253. package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
  254. package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
  255. package/agent-docs/chat/checks.sections/related-reading.md +42 -0
  256. package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
  257. package/agent-docs/chat/host.md +222 -0
  258. package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
  259. package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
  260. package/agent-docs/chat/host.sections/related-reading.md +43 -0
  261. package/agent-docs/chat/passage-index.md +228 -0
  262. package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
  263. package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
  264. package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
  265. package/agent-docs/chat/passage-index.sections/limits.md +45 -0
  266. package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
  267. package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
  268. package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
  269. package/agent-docs/chat/prepared-answers.md +116 -0
  270. package/agent-docs/chat/settings.md +213 -0
  271. package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
  272. package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
  273. package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
  274. package/agent-docs/chat/settings.sections/related-reading.md +32 -0
  275. package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
  276. package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
  277. package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
  278. package/agent-docs/chat/setup.md +97 -0
  279. package/agent-docs/chat.md +102 -0
  280. package/agent-docs/cli.md +445 -0
  281. package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
  282. package/agent-docs/cli.sections/author-pages.md +94 -0
  283. package/agent-docs/cli.sections/build-and-serve.md +144 -0
  284. package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
  285. package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
  286. package/agent-docs/cli.sections/related-reading.md +33 -0
  287. package/agent-docs/cli.sections/search-and-chat.md +132 -0
  288. package/agent-docs/cli.sections/start-a-project.md +37 -0
  289. package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
  290. package/agent-docs/concepts.md +133 -0
  291. package/agent-docs/config/apis.md +136 -0
  292. package/agent-docs/config/content.md +264 -0
  293. package/agent-docs/config/content.sections/authoring.md +58 -0
  294. package/agent-docs/config/content.sections/badges.md +34 -0
  295. package/agent-docs/config/content.sections/callouts.md +34 -0
  296. package/agent-docs/config/content.sections/cookbooks.md +38 -0
  297. package/agent-docs/config/content.sections/frontmatter.md +75 -0
  298. package/agent-docs/config/content.sections/readerfilters.md +44 -0
  299. package/agent-docs/config/content.sections/related-reading.md +34 -0
  300. package/agent-docs/config/content.sections/relationships.md +76 -0
  301. package/agent-docs/config/content.sections/snippets.md +61 -0
  302. package/agent-docs/config/content.sections/templates.md +57 -0
  303. package/agent-docs/config/content.sections/variables.md +55 -0
  304. package/agent-docs/config/examples.md +354 -0
  305. package/agent-docs/config/examples.sections/feature-showcase.md +55 -0
  306. package/agent-docs/config/examples.sections/minimal-site.md +80 -0
  307. package/agent-docs/config/examples.sections/multilingual-help-center.md +110 -0
  308. package/agent-docs/config/examples.sections/parcel-api-documentation.md +153 -0
  309. package/agent-docs/config/examples.sections/related-reading.md +50 -0
  310. package/agent-docs/config/examples.sections/shared-company-preset.md +118 -0
  311. package/agent-docs/config/integrations.md +76 -0
  312. package/agent-docs/config/outputs.md +160 -0
  313. package/agent-docs/config/outputs.sections/exports.md +57 -0
  314. package/agent-docs/config/outputs.sections/metadata.md +42 -0
  315. package/agent-docs/config/outputs.sections/related-reading.md +34 -0
  316. package/agent-docs/config/publishing.md +219 -0
  317. package/agent-docs/config/publishing.sections/navigation.md +92 -0
  318. package/agent-docs/config/publishing.sections/redirects.md +79 -0
  319. package/agent-docs/config/publishing.sections/related-reading.md +33 -0
  320. package/agent-docs/config/site.md +193 -0
  321. package/agent-docs/config/site.sections/related-reading.md +33 -0
  322. package/agent-docs/config/site.sections/theme.md +74 -0
  323. package/agent-docs/config.md +195 -0
  324. package/agent-docs/configuration.md +384 -0
  325. package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
  326. package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
  327. package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
  328. package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
  329. package/agent-docs/configuration.sections/related-reading.md +42 -0
  330. package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
  331. package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
  332. package/agent-docs/configuration.sections/start-with-one-working-file.md +81 -0
  333. package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
  334. package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
  335. package/agent-docs/connect/mcp.md +85 -0
  336. package/agent-docs/contribute/agent-skills.md +72 -0
  337. package/agent-docs/cookbooks/authoring.md +68 -0
  338. package/agent-docs/cookbooks/site-workflows.md +59 -0
  339. package/agent-docs/cookbooks/welcome-email.md +55 -0
  340. package/agent-docs/documents.json +20058 -0
  341. package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
  342. package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
  343. package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
  344. package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
  345. package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
  346. package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
  347. package/agent-docs/example-api/cedar.md +39 -0
  348. package/agent-docs/example-api/create-note.md +344 -0
  349. package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
  350. package/agent-docs/example-api/write-note.md +55 -0
  351. package/agent-docs/explore.md +54 -0
  352. package/agent-docs/glossary.md +827 -0
  353. package/agent-docs/index.md +249 -0
  354. package/agent-docs/ingredients/audit-site.md +27 -0
  355. package/agent-docs/ingredients/build-site.md +29 -0
  356. package/agent-docs/ingredients/compile-framework.md +28 -0
  357. package/agent-docs/ingredients/complete-page.md +30 -0
  358. package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
  359. package/agent-docs/ingredients/inspect-build.md +41 -0
  360. package/agent-docs/ingredients/preview-site.md +31 -0
  361. package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
  362. package/agent-docs/ingredients/scaffold-page.md +28 -0
  363. package/agent-docs/non-goals.md +58 -0
  364. package/agent-docs/provenance.json +10 -0
  365. package/agent-docs/publish/agent-discovery.md +79 -0
  366. package/agent-docs/publish/agent-friendliness.md +201 -0
  367. package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
  368. package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
  369. package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
  370. package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
  371. package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
  372. package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
  373. package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
  374. package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
  375. package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
  376. package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
  377. package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
  378. package/agent-docs/publish/api-references.md +217 -0
  379. package/agent-docs/publish/api-references.sections/add-useful-examples.md +36 -0
  380. package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
  381. package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
  382. package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +36 -0
  383. package/agent-docs/publish/api-references.sections/generate-many-pages-selectively.md +36 -0
  384. package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
  385. package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +36 -0
  386. package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +36 -0
  387. package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
  388. package/agent-docs/publish/api-references.sections/publish-several-versions.md +36 -0
  389. package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
  390. package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
  391. package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
  392. package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
  393. package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +36 -0
  394. package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
  395. package/agent-docs/publish/audit.md +160 -0
  396. package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
  397. package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
  398. package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
  399. package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
  400. package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
  401. package/agent-docs/publish/audit.sections/related-reading.md +47 -0
  402. package/agent-docs/publish/content-export.md +208 -0
  403. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
  404. package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
  405. package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
  406. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
  407. package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
  408. package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
  409. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
  410. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
  411. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
  412. package/agent-docs/publish/content-negotiation.md +121 -0
  413. package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
  414. package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
  415. package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
  416. package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
  417. package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
  418. package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
  419. package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
  420. package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
  421. package/agent-docs/publish/deployment-check.md +72 -0
  422. package/agent-docs/publish/evals.md +175 -0
  423. package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
  424. package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
  425. package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
  426. package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
  427. package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
  428. package/agent-docs/publish/evals.sections/related-reading.md +36 -0
  429. package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
  430. package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
  431. package/agent-docs/publish/host-adapters.md +60 -0
  432. package/agent-docs/publish/manni.md +227 -0
  433. package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
  434. package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
  435. package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
  436. package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
  437. package/agent-docs/publish/mcp-analytics.md +356 -0
  438. package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
  439. package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
  440. package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
  441. package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
  442. package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
  443. package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
  444. package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
  445. package/agent-docs/publish/mcp.md +190 -0
  446. package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
  447. package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
  448. package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
  449. package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
  450. package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
  451. package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
  452. package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
  453. package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
  454. package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
  455. package/agent-docs/publish/openapi-extension-mappings.md +84 -0
  456. package/agent-docs/publish/output.md +220 -0
  457. package/agent-docs/publish/output.sections/api-contracts.md +48 -0
  458. package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
  459. package/agent-docs/publish/output.sections/current-limits.md +40 -0
  460. package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
  461. package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
  462. package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
  463. package/agent-docs/publish/output.sections/page-formats.md +46 -0
  464. package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
  465. package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
  466. package/agent-docs/publish/output.sections/related-reading.md +34 -0
  467. package/agent-docs/publish/output.sections/response-identity.md +38 -0
  468. package/agent-docs/publish/output.sections/site-files.md +64 -0
  469. package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
  470. package/agent-docs/publish/output.sections/where-files-go.md +49 -0
  471. package/agent-docs/publish/publications.md +153 -0
  472. package/agent-docs/publish/revisions.md +104 -0
  473. package/agent-docs/publish/seo.md +119 -0
  474. package/agent-docs/publish/single-source-sites.md +168 -0
  475. package/agent-docs/publish/troubleshooting.md +112 -0
  476. package/agent-docs/publish/vercel.md +130 -0
  477. package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
  478. package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
  479. package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
  480. package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
  481. package/agent-docs/publish.md +95 -0
  482. package/agent-docs/recipes/add-page.md +194 -0
  483. package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
  484. package/agent-docs/recipes/add-page.sections/before-you-start.md +33 -0
  485. package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
  486. package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
  487. package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
  488. package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
  489. package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
  490. package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
  491. package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +42 -0
  492. package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
  493. package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
  494. package/agent-docs/recipes/audit-docs.md +122 -0
  495. package/agent-docs/recipes/build-docs.md +105 -0
  496. package/agent-docs/recipes/preview-hybrid-search.md +84 -0
  497. package/agent-docs/recipes/preview-page.md +124 -0
  498. package/agent-docs/recipes/queue-email.md +49 -0
  499. package/agent-docs/recipes/refresh-agent-docs.md +109 -0
  500. package/agent-docs/recipes/send-welcome-email.md +92 -0
  501. package/agent-docs/reference/agent-skills.md +73 -0
  502. package/agent-docs/search-and-chat.md +87 -0
  503. package/agent-docs/search-index.json +1 -0
  504. package/agent-docs/start.md +197 -0
  505. package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
  506. package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
  507. package/agent-docs/start.sections/build-this-site.md +35 -0
  508. package/agent-docs/start.sections/check-writing-style.md +35 -0
  509. package/agent-docs/start.sections/create-a-page.md +105 -0
  510. package/agent-docs/start.sections/make-it-yours.md +37 -0
  511. package/agent-docs/start.sections/prerequisites.md +37 -0
  512. package/agent-docs/start.sections/related-reading.md +45 -0
  513. package/agent-docs/start.sections/start-your-own-project.md +53 -0
  514. package/agent-docs/status.md +75 -0
  515. package/agent-docs/styling/color-modes.md +85 -0
  516. package/agent-docs/styling/footer.md +67 -0
  517. package/agent-docs/styling/header.md +65 -0
  518. package/agent-docs/styling/layouts.md +193 -0
  519. package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
  520. package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
  521. package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
  522. package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
  523. package/agent-docs/styling/layouts.sections/hero.md +83 -0
  524. package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
  525. package/agent-docs/styling/palettes.md +140 -0
  526. package/agent-docs/styling/share-images.md +105 -0
  527. package/agent-docs/styling/themes.md +125 -0
  528. package/agent-docs/styling/try.md +106 -0
  529. package/agent-docs/what-is-shoalrun.md +56 -0
  530. package/assets/analytics.js +72 -0
  531. package/assets/ask-widget.js +320 -0
  532. package/assets/code-samples.js +28 -0
  533. package/assets/components.js +32 -0
  534. package/assets/cookbook-chooser.js +170 -0
  535. package/assets/copy-markdown.js +24 -0
  536. package/assets/example-panel.js +77 -0
  537. package/assets/file-tree.js +49 -0
  538. package/assets/image-viewer.js +41 -0
  539. package/assets/mode.js +26 -0
  540. package/assets/navigation.js +233 -0
  541. package/assets/reader-filters.js +305 -0
  542. package/assets/reader.js +111 -0
  543. package/assets/search-highlight.js +32 -0
  544. package/assets/search-lexical.js +66 -0
  545. package/assets/search.js +150 -0
  546. package/assets/table-filter.js +63 -0
  547. package/assets/tabs.js +80 -0
  548. package/assets/theme-preview.css +17 -0
  549. package/assets/theme-preview.js +135 -0
  550. package/assets/theme-switcher.js +113 -0
  551. package/assets/tooltips.js +81 -0
  552. package/assets/walkthrough.js +233 -0
  553. package/dist/agent-discovery.d.ts +11 -0
  554. package/dist/agent-discovery.js +37 -0
  555. package/dist/analytics.d.ts +2 -0
  556. package/dist/analytics.js +13 -0
  557. package/dist/answer-cache.d.ts +24 -0
  558. package/dist/answer-cache.js +55 -0
  559. package/dist/answer-cards.d.ts +71 -0
  560. package/dist/answer-cards.js +148 -0
  561. package/dist/api-embeds.d.ts +22 -0
  562. package/dist/api-embeds.js +84 -0
  563. package/dist/api-identity.d.ts +6 -0
  564. package/dist/api-identity.js +7 -0
  565. package/dist/api-materialize.d.ts +12 -0
  566. package/dist/api-materialize.js +120 -0
  567. package/dist/api-publication-plan.d.ts +86 -0
  568. package/dist/api-publication-plan.js +187 -0
  569. package/dist/api-publication-review.d.ts +23 -0
  570. package/dist/api-publication-review.js +58 -0
  571. package/dist/api-selection.d.ts +21 -0
  572. package/dist/api-selection.js +84 -0
  573. package/dist/api.d.ts +74 -0
  574. package/dist/api.js +782 -0
  575. package/dist/artifact-bundle.d.ts +96 -0
  576. package/dist/artifact-bundle.js +306 -0
  577. package/dist/ask-function.d.ts +19 -0
  578. package/dist/ask-function.js +139 -0
  579. package/dist/ask-handler.d.ts +38 -0
  580. package/dist/ask-handler.js +157 -0
  581. package/dist/ask-log-kv.d.ts +14 -0
  582. package/dist/ask-log-kv.js +69 -0
  583. package/dist/ask-log.d.ts +106 -0
  584. package/dist/ask-log.js +159 -0
  585. package/dist/ask-setup.d.ts +43 -0
  586. package/dist/ask-setup.js +99 -0
  587. package/dist/ask.d.ts +152 -0
  588. package/dist/ask.js +532 -0
  589. package/dist/audit.d.ts +29 -0
  590. package/dist/audit.js +171 -0
  591. package/dist/authored-change.d.ts +22 -0
  592. package/dist/authored-change.js +47 -0
  593. package/dist/authoring-api.d.ts +18 -0
  594. package/dist/authoring-api.js +15 -0
  595. package/dist/authoring-findings.d.ts +31 -0
  596. package/dist/authoring-findings.js +104 -0
  597. package/dist/authoring-guidance.d.ts +15 -0
  598. package/dist/authoring-guidance.js +57 -0
  599. package/dist/authoring-preview.d.ts +24 -0
  600. package/dist/authoring-preview.js +160 -0
  601. package/dist/authoring-project-command.d.ts +7 -0
  602. package/dist/authoring-project-command.js +52 -0
  603. package/dist/authoring-project.d.ts +104 -0
  604. package/dist/authoring-project.js +287 -0
  605. package/dist/authoring-review-command.d.ts +1 -0
  606. package/dist/authoring-review-command.js +68 -0
  607. package/dist/authoring-review.d.ts +72 -0
  608. package/dist/authoring-review.js +71 -0
  609. package/dist/authoring-snapshot.d.ts +66 -0
  610. package/dist/authoring-snapshot.js +293 -0
  611. package/dist/authoring-validation-command.d.ts +1 -0
  612. package/dist/authoring-validation-command.js +54 -0
  613. package/dist/authoring-validation.d.ts +101 -0
  614. package/dist/authoring-validation.js +348 -0
  615. package/dist/badges.d.ts +16 -0
  616. package/dist/badges.js +57 -0
  617. package/dist/budget-store.d.ts +21 -0
  618. package/dist/budget-store.js +90 -0
  619. package/dist/budget.d.ts +45 -0
  620. package/dist/budget.js +128 -0
  621. package/dist/build-info.d.ts +10 -0
  622. package/dist/build-info.js +15 -0
  623. package/dist/callouts.d.ts +18 -0
  624. package/dist/callouts.js +63 -0
  625. package/dist/cards.d.ts +35 -0
  626. package/dist/cards.js +237 -0
  627. package/dist/chat-config.d.ts +117 -0
  628. package/dist/chat-config.js +400 -0
  629. package/dist/chat-pause.d.ts +1 -0
  630. package/dist/chat-pause.js +3 -0
  631. package/dist/chat.d.ts +46 -0
  632. package/dist/chat.js +78 -0
  633. package/dist/cli-discovery.d.ts +4 -0
  634. package/dist/cli-discovery.js +86 -0
  635. package/dist/cli.d.ts +2 -0
  636. package/dist/cli.js +750 -0
  637. package/dist/code-samples.d.ts +50 -0
  638. package/dist/code-samples.js +181 -0
  639. package/dist/compact-discovery.d.ts +15 -0
  640. package/dist/compact-discovery.js +78 -0
  641. package/dist/compiler-config.d.ts +67 -0
  642. package/dist/compiler-config.js +66 -0
  643. package/dist/compiler.d.ts +208 -0
  644. package/dist/compiler.js +524 -0
  645. package/dist/component-bundle.d.ts +4 -0
  646. package/dist/component-bundle.js +32 -0
  647. package/dist/component-content.d.ts +78 -0
  648. package/dist/component-content.js +47 -0
  649. package/dist/component-manifest.d.ts +15 -0
  650. package/dist/component-manifest.js +84 -0
  651. package/dist/component-names.d.ts +1 -0
  652. package/dist/component-names.js +1 -0
  653. package/dist/component-plugins.d.ts +28 -0
  654. package/dist/component-plugins.js +141 -0
  655. package/dist/component-transform.d.ts +10 -0
  656. package/dist/component-transform.js +697 -0
  657. package/dist/components.d.ts +2 -0
  658. package/dist/components.js +1 -0
  659. package/dist/config.d.ts +29 -0
  660. package/dist/config.js +149 -0
  661. package/dist/content-export-assets.d.ts +23 -0
  662. package/dist/content-export-assets.js +103 -0
  663. package/dist/content-export-command.d.ts +20 -0
  664. package/dist/content-export-command.js +57 -0
  665. package/dist/content-export-config.d.ts +16 -0
  666. package/dist/content-export-config.js +50 -0
  667. package/dist/content-export-render.d.ts +12 -0
  668. package/dist/content-export-render.js +132 -0
  669. package/dist/content-export.d.ts +30 -0
  670. package/dist/content-export.js +307 -0
  671. package/dist/content-filter.d.ts +4 -0
  672. package/dist/content-filter.js +16 -0
  673. package/dist/content-source.d.ts +100 -0
  674. package/dist/content-source.js +42 -0
  675. package/dist/content-workspace.d.ts +293 -0
  676. package/dist/content-workspace.js +69 -0
  677. package/dist/content.d.ts +41 -0
  678. package/dist/content.js +176 -0
  679. package/dist/cookbook-chooser.d.ts +19 -0
  680. package/dist/cookbook-chooser.js +56 -0
  681. package/dist/dev.d.ts +2 -0
  682. package/dist/dev.js +113 -0
  683. package/dist/diagram-svg.d.ts +1 -0
  684. package/dist/diagram-svg.js +44 -0
  685. package/dist/diagrams.d.ts +7 -0
  686. package/dist/diagrams.js +102 -0
  687. package/dist/docs-author.d.ts +86 -0
  688. package/dist/docs-author.js +380 -0
  689. package/dist/docs-command.d.ts +8 -0
  690. package/dist/docs-command.js +62 -0
  691. package/dist/docs-eval.d.ts +146 -0
  692. package/dist/docs-eval.js +231 -0
  693. package/dist/docs-mcp.d.ts +12 -0
  694. package/dist/docs-mcp.js +82 -0
  695. package/dist/docs-tool.d.ts +81 -0
  696. package/dist/docs-tool.js +7 -0
  697. package/dist/document-sync.d.ts +36 -0
  698. package/dist/document-sync.js +58 -0
  699. package/dist/documentation-core.d.ts +148 -0
  700. package/dist/documentation-core.js +160 -0
  701. package/dist/embeddings.d.ts +68 -0
  702. package/dist/embeddings.js +198 -0
  703. package/dist/focused-audit.d.ts +10 -0
  704. package/dist/focused-audit.js +69 -0
  705. package/dist/focused-openapi.d.ts +2 -0
  706. package/dist/focused-openapi.js +140 -0
  707. package/dist/fonts.d.ts +54 -0
  708. package/dist/fonts.js +92 -0
  709. package/dist/freshness.d.ts +7 -0
  710. package/dist/freshness.js +58 -0
  711. package/dist/frontmatter.d.ts +24 -0
  712. package/dist/frontmatter.js +342 -0
  713. package/dist/function-package.d.ts +1 -0
  714. package/dist/function-package.js +58 -0
  715. package/dist/highlight.d.ts +14 -0
  716. package/dist/highlight.js +114 -0
  717. package/dist/html-renderer.d.ts +10 -0
  718. package/dist/html-renderer.js +63 -0
  719. package/dist/icons.d.ts +8 -0
  720. package/dist/icons.js +40 -0
  721. package/dist/index-build.d.ts +55 -0
  722. package/dist/index-build.js +227 -0
  723. package/dist/ingredient-draft.d.ts +17 -0
  724. package/dist/ingredient-draft.js +94 -0
  725. package/dist/ingredient-workflow.d.ts +8 -0
  726. package/dist/ingredient-workflow.js +25 -0
  727. package/dist/init.d.ts +8 -0
  728. package/dist/init.js +66 -0
  729. package/dist/jev.d.ts +62 -0
  730. package/dist/jev.js +190 -0
  731. package/dist/link-audit.d.ts +12 -0
  732. package/dist/link-audit.js +146 -0
  733. package/dist/llms-discovery.d.ts +11 -0
  734. package/dist/llms-discovery.js +23 -0
  735. package/dist/markdown-sections.d.ts +15 -0
  736. package/dist/markdown-sections.js +60 -0
  737. package/dist/markdown-size.d.ts +7 -0
  738. package/dist/markdown-size.js +6 -0
  739. package/dist/mcp-analytics.d.ts +38 -0
  740. package/dist/mcp-analytics.js +35 -0
  741. package/dist/mcp-artifacts.d.ts +2 -0
  742. package/dist/mcp-artifacts.js +78 -0
  743. package/dist/mcp-client-metadata.d.ts +18 -0
  744. package/dist/mcp-client-metadata.js +69 -0
  745. package/dist/mcp-config.d.ts +23 -0
  746. package/dist/mcp-config.js +56 -0
  747. package/dist/mcp-http.d.ts +19 -0
  748. package/dist/mcp-http.js +157 -0
  749. package/dist/mcp-integrity.d.ts +3 -0
  750. package/dist/mcp-integrity.js +4 -0
  751. package/dist/mcp-node.d.ts +4 -0
  752. package/dist/mcp-node.js +68 -0
  753. package/dist/mcp-vercel-runtime.d.ts +3 -0
  754. package/dist/mcp-vercel-runtime.js +36 -0
  755. package/dist/mcp-vercel.d.ts +15 -0
  756. package/dist/mcp-vercel.js +65 -0
  757. package/dist/metadata-provider.d.ts +19 -0
  758. package/dist/metadata-provider.js +38 -0
  759. package/dist/negotiation.d.ts +10 -0
  760. package/dist/negotiation.js +35 -0
  761. package/dist/not-found.d.ts +16 -0
  762. package/dist/not-found.js +25 -0
  763. package/dist/output-commit.d.ts +1 -0
  764. package/dist/output-commit.js +133 -0
  765. package/dist/output-location.d.ts +3 -0
  766. package/dist/output-location.js +30 -0
  767. package/dist/page-materialization.d.ts +78 -0
  768. package/dist/page-materialization.js +132 -0
  769. package/dist/page-renderer.d.ts +71 -0
  770. package/dist/page-renderer.js +177 -0
  771. package/dist/palettes.d.ts +41 -0
  772. package/dist/palettes.js +160 -0
  773. package/dist/procedure-components.d.ts +2 -0
  774. package/dist/procedure-components.js +94 -0
  775. package/dist/project-navigation.d.ts +41 -0
  776. package/dist/project-navigation.js +190 -0
  777. package/dist/provider-http.d.ts +10 -0
  778. package/dist/provider-http.js +60 -0
  779. package/dist/publication-manifest.d.ts +229 -0
  780. package/dist/publication-manifest.js +53 -0
  781. package/dist/publication-plan.d.ts +34 -0
  782. package/dist/publication-plan.js +85 -0
  783. package/dist/publication-render.d.ts +71 -0
  784. package/dist/publication-render.js +92 -0
  785. package/dist/reader-filters.d.ts +30 -0
  786. package/dist/reader-filters.js +105 -0
  787. package/dist/recipe-draft.d.ts +17 -0
  788. package/dist/recipe-draft.js +147 -0
  789. package/dist/reference-audit.d.ts +18 -0
  790. package/dist/reference-audit.js +169 -0
  791. package/dist/remote-import.d.ts +62 -0
  792. package/dist/remote-import.js +292 -0
  793. package/dist/representation-tree.d.ts +3 -0
  794. package/dist/representation-tree.js +320 -0
  795. package/dist/retrieval-config.d.ts +30 -0
  796. package/dist/retrieval-config.js +83 -0
  797. package/dist/retrieval.d.ts +60 -0
  798. package/dist/retrieval.js +228 -0
  799. package/dist/scaffold.d.ts +39 -0
  800. package/dist/scaffold.js +167 -0
  801. package/dist/search-config.d.ts +8 -0
  802. package/dist/search-config.js +26 -0
  803. package/dist/search-handler.d.ts +16 -0
  804. package/dist/search-handler.js +111 -0
  805. package/dist/search-identifier.d.ts +3 -0
  806. package/dist/search-identifier.js +25 -0
  807. package/dist/search-literal.d.ts +1 -0
  808. package/dist/search-literal.js +28 -0
  809. package/dist/search-query.d.ts +54 -0
  810. package/dist/search-query.js +120 -0
  811. package/dist/search-results.d.ts +6 -0
  812. package/dist/search-results.js +45 -0
  813. package/dist/search-snippet.d.ts +11 -0
  814. package/dist/search-snippet.js +93 -0
  815. package/dist/search-synonyms.d.ts +8 -0
  816. package/dist/search-synonyms.js +46 -0
  817. package/dist/semantic-markdown.d.ts +10 -0
  818. package/dist/semantic-markdown.js +39 -0
  819. package/dist/server.d.ts +10 -0
  820. package/dist/server.js +223 -0
  821. package/dist/share-images.d.ts +24 -0
  822. package/dist/share-images.js +187 -0
  823. package/dist/site-path.d.ts +2 -0
  824. package/dist/site-path.js +15 -0
  825. package/dist/sitemap.d.ts +8 -0
  826. package/dist/sitemap.js +58 -0
  827. package/dist/snippets.d.ts +19 -0
  828. package/dist/snippets.js +84 -0
  829. package/dist/structured-model-output.d.ts +6 -0
  830. package/dist/structured-model-output.js +21 -0
  831. package/dist/subject-deprecation.d.ts +21 -0
  832. package/dist/subject-deprecation.js +57 -0
  833. package/dist/surface-text.d.ts +4 -0
  834. package/dist/surface-text.js +42 -0
  835. package/dist/taxonomy.d.ts +14 -0
  836. package/dist/taxonomy.js +88 -0
  837. package/dist/turnstile.d.ts +21 -0
  838. package/dist/turnstile.js +52 -0
  839. package/dist/vale.d.ts +28 -0
  840. package/dist/vale.js +103 -0
  841. package/dist/vercel-function.d.ts +21 -0
  842. package/dist/vercel-function.js +108 -0
  843. package/dist/vercel.d.ts +11 -0
  844. package/dist/vercel.js +103 -0
  845. package/dist/walkthrough.d.ts +25 -0
  846. package/dist/walkthrough.js +336 -0
  847. package/dist/yaml-value.d.ts +2 -0
  848. package/dist/yaml-value.js +36 -0
  849. package/example-configs/api-docs/README.md +59 -0
  850. package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
  851. package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
  852. package/example-configs/api-docs/content/overview.mdx +36 -0
  853. package/example-configs/api-docs/content/quickstart.mdx +52 -0
  854. package/example-configs/api-docs/docs.config.yaml +104 -0
  855. package/example-configs/faceted-sites/README.md +31 -0
  856. package/example-configs/faceted-sites/base.yaml +30 -0
  857. package/example-configs/faceted-sites/content/api.md +12 -0
  858. package/example-configs/faceted-sites/content/home.md +10 -0
  859. package/example-configs/faceted-sites/content/operations.md +12 -0
  860. package/example-configs/faceted-sites/developers.config.yaml +8 -0
  861. package/example-configs/faceted-sites/docs.config.yaml +7 -0
  862. package/example-configs/faceted-sites/europe.config.yaml +9 -0
  863. package/example-configs/minimal/content/install.mdx +12 -0
  864. package/example-configs/minimal/content/welcome.mdx +8 -0
  865. package/example-configs/minimal/docs.config.yaml +31 -0
  866. package/example-configs/multilingual/content/de/home.mdx +9 -0
  867. package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
  868. package/example-configs/multilingual/content/home.mdx +10 -0
  869. package/example-configs/multilingual/content/reset-password.mdx +12 -0
  870. package/example-configs/multilingual/docs.config.yaml +61 -0
  871. package/example-configs/multilingual/snippets/contact.mdx +1 -0
  872. package/example-configs/notifications/apis/notifications.yaml +132 -0
  873. package/example-configs/notifications/content/cookbook.mdx +17 -0
  874. package/example-configs/notifications/content/get-message.mdx +14 -0
  875. package/example-configs/notifications/content/queue-email.mdx +42 -0
  876. package/example-configs/notifications/content/queue-push.mdx +33 -0
  877. package/example-configs/notifications/content/queue-sms.mdx +33 -0
  878. package/example-configs/notifications/content/send-email.mdx +14 -0
  879. package/example-configs/notifications/content/send-push.mdx +14 -0
  880. package/example-configs/notifications/content/send-sms.mdx +14 -0
  881. package/example-configs/notifications/content/start.mdx +13 -0
  882. package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
  883. package/example-configs/notifications/content/welcome-email.mdx +82 -0
  884. package/example-configs/notifications/demo.mjs +43 -0
  885. package/example-configs/notifications/docs.config.yaml +88 -0
  886. package/example-configs/notifications/ingredient-drafts/README.md +41 -0
  887. package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
  888. package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
  889. package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
  890. package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
  891. package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
  892. package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
  893. package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
  894. package/example-configs/reference-stress/README.md +32 -0
  895. package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
  896. package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
  897. package/example-configs/reference-stress/content/overview.mdx +14 -0
  898. package/example-configs/reference-stress/docs.config.yaml +55 -0
  899. package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
  900. package/example-configs/shared-preset/shared/runbook.mdx +7 -0
  901. package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
  902. package/example-configs/shared-preset/site/content/start.mdx +9 -0
  903. package/example-configs/shared-preset/site/docs.config.yaml +18 -0
  904. package/example-configs/showcase/README.md +20 -0
  905. package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
  906. package/example-configs/showcase/content/assets/collection.svg +1 -0
  907. package/example-configs/showcase/content/code.mdx +100 -0
  908. package/example-configs/showcase/content/create-enrollment.mdx +11 -0
  909. package/example-configs/showcase/content/features.mdx +39 -0
  910. package/example-configs/showcase/content/landing.mdx +36 -0
  911. package/example-configs/showcase/content/overview.mdx +42 -0
  912. package/example-configs/showcase/content/personalization.mdx +38 -0
  913. package/example-configs/showcase/content/preview.mdx +35 -0
  914. package/example-configs/showcase/content/procedures.mdx +88 -0
  915. package/example-configs/showcase/content/quickstart.mdx +64 -0
  916. package/example-configs/showcase/content/reading.mdx +99 -0
  917. package/example-configs/showcase/content/verify.mdx +27 -0
  918. package/example-configs/showcase/content/visuals.mdx +47 -0
  919. package/example-configs/showcase/content/workflows.mdx +12 -0
  920. package/example-configs/showcase/docs.config.yaml +149 -0
  921. package/example-configs/showcase/snippets/sandbox.mdx +1 -0
  922. package/examples/analytics/README.md +56 -0
  923. package/examples/analytics/inspector.js +25 -0
  924. package/examples/analytics/posthog.js +36 -0
  925. package/examples/components/comparison.mjs +8 -0
  926. package/examples/components/components.json +6 -0
  927. package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
  928. package/examples/components/copy-text/LICENSE.react.txt +21 -0
  929. package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
  930. package/examples/components/copy-text/browser.jsx +21 -0
  931. package/examples/components/copy-text/components.json +6 -0
  932. package/examples/components/copy-text/package-lock.json +41 -0
  933. package/examples/components/copy-text/package.json +9 -0
  934. package/examples/components/copy-text/plugin.mjs +5 -0
  935. package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
  936. package/examples/components/retry-budget/LICENSE.react.txt +21 -0
  937. package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
  938. package/examples/components/retry-budget/browser.jsx +50 -0
  939. package/examples/components/retry-budget/components.json +6 -0
  940. package/examples/components/retry-budget/model.js +22 -0
  941. package/examples/components/retry-budget/package-lock.json +41 -0
  942. package/examples/components/retry-budget/package.json +9 -0
  943. package/examples/components/retry-budget/plugin.mjs +31 -0
  944. package/examples/components/retry-budget/policy.json +9 -0
  945. package/examples/components/retry-budget/style.css +25 -0
  946. package/examples/diagrams/d2-gallery.json +138 -0
  947. package/examples/diagrams/gallery.json +236 -0
  948. package/examples/help-drawer/README.md +44 -0
  949. package/examples/help-drawer/app.js +53 -0
  950. package/examples/help-drawer/components/components.json +1 -0
  951. package/examples/help-drawer/components/support.mjs +10 -0
  952. package/examples/help-drawer/content/account.md +8 -0
  953. package/examples/help-drawer/content/billing.mdx +29 -0
  954. package/examples/help-drawer/content/keys.mdx +46 -0
  955. package/examples/help-drawer/content/settings.svg +1 -0
  956. package/examples/help-drawer/docs.config.yaml +30 -0
  957. package/examples/help-drawer/index.html +26 -0
  958. package/examples/help-drawer/preview.mjs +33 -0
  959. package/examples/mcp-analytics/README.md +59 -0
  960. package/examples/mcp-analytics/posthog.mjs +159 -0
  961. package/package.json +100 -4
  962. package/schemas/content-export.schema.json +55 -0
  963. package/skills/shoalrun-author/SKILL.md +52 -0
  964. package/skills/shoalrun-component-author/SKILL.md +24 -0
  965. package/skills/shoalrun-recipes/SKILL.md +25 -0
  966. package/skills/shoalrun-setup/SKILL.md +34 -0
  967. package/skills/shoalrun-walkthrough/SKILL.md +18 -0
  968. package/styles/fonts/figtree-LICENSE.txt +93 -0
  969. package/styles/fonts/figtree-italic.woff2 +0 -0
  970. package/styles/fonts/figtree.woff2 +0 -0
  971. package/styles/fonts/inter-LICENSE.txt +93 -0
  972. package/styles/fonts/inter-italic.woff2 +0 -0
  973. package/styles/fonts/inter.woff2 +0 -0
  974. package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
  975. package/styles/fonts/jetbrains-mono.woff2 +0 -0
  976. package/styles/fonts/jost-LICENSE.txt +93 -0
  977. package/styles/fonts/jost-italic.woff2 +0 -0
  978. package/styles/fonts/jost.woff2 +0 -0
  979. package/styles/fonts/share/figtree-400.ttf +0 -0
  980. package/styles/fonts/share/figtree-700.ttf +0 -0
  981. package/styles/fonts/share/inter-400.ttf +0 -0
  982. package/styles/fonts/share/inter-700.ttf +0 -0
  983. package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
  984. package/styles/fonts/share/jost-italic-800.ttf +0 -0
  985. package/styles/fonts/share/metrics.json +1 -0
  986. package/styles/fonts/share/source-serif-4-400.ttf +0 -0
  987. package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
  988. package/styles/fonts/source-serif-4-italic.woff2 +0 -0
  989. package/styles/fonts/source-serif-4.woff2 +0 -0
  990. package/styles/header.css +56 -0
  991. package/styles/site.css +825 -0
  992. package/styles/themes/ledger.css +93 -0
  993. package/styles/themes/palettes/amethyst.yaml +127 -0
  994. package/styles/themes/palettes/coral.yaml +127 -0
  995. package/styles/themes/palettes/harbor.yaml +127 -0
  996. package/styles/themes/palettes/ink.yaml +127 -0
  997. package/styles/themes/palettes/kelp.yaml +127 -0
  998. package/styles/themes/palettes/vice.yaml +127 -0
  999. package/styles/themes/reef.css +68 -0
  1000. package/styles/themes/vice.css +56 -0
  1001. package/styles/tokens.css +91 -0
  1002. package/templates/api-reference.mdx +133 -0
  1003. package/templates/cookbook.mdx +38 -0
  1004. package/templates/explanation.mdx +76 -0
  1005. package/templates/guide.mdx +175 -0
  1006. package/templates/how-to.mdx +171 -0
  1007. package/templates/ingredient.mdx +53 -0
  1008. package/templates/recipe.mdx +76 -0
  1009. package/templates/reference.mdx +171 -0
  1010. package/templates/troubleshooting.mdx +159 -0
  1011. package/templates/tutorial.mdx +165 -0
package/dist/api.js ADDED
@@ -0,0 +1,782 @@
1
+ import { readFile, realpath } from 'node:fs/promises';
2
+ import { realpathSync } from 'node:fs';
3
+ import { STATUS_CODES } from 'node:http';
4
+ import path from 'node:path';
5
+ import { createHash } from 'node:crypto';
6
+ import { parseYaml } from './yaml-value.js';
7
+ import { code, heading, link, list, paragraph, parsePlainMarkdown, text } from './content.js';
8
+ import { requestSamples } from './code-samples.js';
9
+ const methods = new Set(['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']);
10
+ export const supportedSchemaKeywords = new Set(['$ref', 'type', 'format', 'nullable', 'enum', 'const', 'default', 'minLength', 'maxLength', 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum', 'multipleOf', 'minItems', 'maxItems', 'uniqueItems', 'minProperties', 'maxProperties', 'pattern', 'readOnly', 'writeOnly', 'deprecated', 'description', 'example', 'examples', 'allOf', 'oneOf', 'anyOf', 'items', 'properties', 'required', 'additionalProperties', 'title', 'discriminator']);
11
+ const inline = (s) => ({ type: 'inlineCode', value: s });
12
+ export function querySyntaxRules(value) {
13
+ if (value === undefined)
14
+ return [];
15
+ if (!Array.isArray(value))
16
+ throw new Error('api.querySyntax must be a list');
17
+ return value.map((item, index) => {
18
+ const where = `api.querySyntax[${index}]`;
19
+ if (!item || typeof item !== 'object' || Array.isArray(item))
20
+ throw new Error(`${where} must be a mapping`);
21
+ const rule = item;
22
+ if (Object.keys(rule).some(key => !['parameter', 'pathPrefixes', 'style', 'example'].includes(key)))
23
+ throw new Error(`${where} accepts parameter, pathPrefixes, style, and example`);
24
+ if (typeof rule.parameter !== 'string' || !rule.parameter.trim())
25
+ throw new Error(`${where}.parameter must be a name`);
26
+ if (!Array.isArray(rule.pathPrefixes) || !rule.pathPrefixes.length || rule.pathPrefixes.some(prefix => typeof prefix !== 'string' || !prefix.startsWith('/') || /[?#]/.test(prefix)))
27
+ throw new Error(`${where}.pathPrefixes must be absolute path prefixes`);
28
+ if (rule.style !== 'unwrapped')
29
+ throw new Error(`${where}.style must be unwrapped`);
30
+ if (typeof rule.example !== 'string' || !/^[^?&#\s]+=[^?&#\s]+$/.test(rule.example))
31
+ throw new Error(`${where}.example must be one query expression such as FIELD(eq)=VALUE`);
32
+ return rule;
33
+ });
34
+ }
35
+ const slug = (value) => value.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '') || 'value';
36
+ export function exampleTitle(key, summary) {
37
+ if (typeof summary === 'string' && summary.trim())
38
+ return summary.trim();
39
+ const words = key.replace(/([a-z0-9])([A-Z])/g, '$1 $2').replace(/([A-Z])([A-Z][a-z])/g, '$1 $2').replace(/[_-]+/g, ' ').trim();
40
+ return words ? words[0].toUpperCase() + words.slice(1) : 'Example';
41
+ }
42
+ const schemaName = (reference) => reference.split('/').at(-1)?.replaceAll('~1', '/').replaceAll('~0', '~') || reference;
43
+ const sameProse = (a, b) => a.trim().replace(/\s+/g, ' ').replace(/[.!?]+$/, '') === (b ?? '').trim().replace(/\s+/g, ' ').replace(/[.!?]+$/, '');
44
+ const anchorFor = (parts) => `field-${parts.map(slug).join('-')}-${createHash('sha256').update(parts.join('\0')).digest('hex').slice(0, 7)}`;
45
+ const marked = (node) => ({ ...node, data: { ...node.data, exampleOnly: true } });
46
+ const disclosure = (label, children, open = false, properties = false) => ({
47
+ type: 'docApiDisclosure', data: { hName: 'details', hProperties: { className: ['api-schema-disclosure', ...(properties ? ['api-properties-disclosure'] : [])], ...(open ? { open: true } : {}) } },
48
+ children: [{ ...paragraph(text(label)), data: { hName: 'summary' } }, ...children]
49
+ });
50
+ // HTML-only hooks: remark-rehype turns hName/hProperties into elements, while the Markdown twin keeps the plain text.
51
+ const tagged = (node, className, properties = {}) => ({ ...node, data: { ...node.data, hProperties: { ...node.data?.hProperties, className: [className], ...properties } } });
52
+ const span = (value, className) => ({ type: 'text', value, data: { hName: 'span', hProperties: { className: [className] } } });
53
+ const infoCard = (children) => ({ type: 'docApiInfoCard', data: { hName: 'div', hProperties: { className: ['api-info-card'] } }, children });
54
+ const infoCards = (kind, cards) => ({ type: 'docApiInfoCards', data: { hName: 'div', hProperties: { className: [`api-${kind}-list`] } }, children: cards });
55
+ export class ApiReader {
56
+ files = new Map();
57
+ allowedRoots = new Set();
58
+ dependencies = new Set();
59
+ constructor(projectRoot) {
60
+ if (projectRoot)
61
+ this.allowedRoots.add(realpathSync(path.resolve(projectRoot)));
62
+ }
63
+ async load(file) {
64
+ file = path.resolve(file);
65
+ // A source explicitly selected by the caller may resolve sibling files. References
66
+ // cannot grant themselves access to another directory on the build machine.
67
+ this.allowedRoots.add(path.dirname(await realpath(file)));
68
+ return this.loadFile(file);
69
+ }
70
+ async loadReference(file) {
71
+ const resolved = await realpath(file);
72
+ const allowed = [...this.allowedRoots].some(root => {
73
+ const relative = path.relative(root, resolved);
74
+ return relative !== '..' && !relative.startsWith(`..${path.sep}`) && !path.isAbsolute(relative);
75
+ });
76
+ if (!allowed)
77
+ throw new Error(`Local $ref escapes the configured project or OpenAPI source directory: ${file}`);
78
+ return this.loadFile(path.resolve(file));
79
+ }
80
+ async loadFile(file) {
81
+ const cached = this.files.get(file);
82
+ if (cached)
83
+ return cached;
84
+ const source = await readFile(file, 'utf8');
85
+ const value = parseYaml(source, file);
86
+ const item = { file, value };
87
+ this.files.set(file, item);
88
+ this.dependencies.add(file);
89
+ return item;
90
+ }
91
+ async ref(source, reference) {
92
+ const separator = reference.indexOf('#');
93
+ const name = separator < 0 ? reference : reference.slice(0, separator);
94
+ const pointer = separator < 0 ? '' : reference.slice(separator + 1);
95
+ if (name.includes('://'))
96
+ throw new Error(`Remote $ref requires a pinned snapshot: ${reference}`);
97
+ if (name && (path.isAbsolute(name) || path.win32.isAbsolute(name)))
98
+ throw new Error(`Absolute local $ref is not allowed: ${reference}`);
99
+ const target = name ? await this.loadReference(path.resolve(path.dirname(source.file), name)) : source;
100
+ if (pointer && !pointer.startsWith('/'))
101
+ throw new Error(`Unsupported $ref pointer: ${reference}`);
102
+ const value = pointer ? pointer.slice(1).split('/').reduce((at, key) => at?.[key.replaceAll('~1', '/').replaceAll('~0', '~')], target.value) : target.value;
103
+ if (value === undefined)
104
+ throw new Error(`Broken $ref ${reference} in ${source.file}`);
105
+ return { value, source: target, label: `${path.basename(target.file)}#${pointer}`, identity: `${target.file}#${pointer}` };
106
+ }
107
+ async collectReferences(file) {
108
+ const visited = new Set();
109
+ const files = new Set();
110
+ const source = await this.load(file);
111
+ async function walk(reader, current, value, kind = 'object') {
112
+ files.add(current.file);
113
+ if (!value || typeof value !== 'object')
114
+ return;
115
+ if (Array.isArray(value)) {
116
+ for (const item of value)
117
+ await walk(reader, current, item, kind);
118
+ return;
119
+ }
120
+ if (typeof value.$ref === 'string') {
121
+ const resolved = await reader.ref(current, value.$ref);
122
+ const key = `${resolved.identity}|${kind}`;
123
+ if (!visited.has(key)) {
124
+ visited.add(key);
125
+ await walk(reader, resolved.source, resolved.value, kind);
126
+ }
127
+ }
128
+ if (kind === 'schema' && value.discriminator?.mapping)
129
+ for (const target of Object.values(value.discriminator.mapping)) {
130
+ if (typeof target !== 'string' || !(target.startsWith('.') || target.startsWith('/') || target.startsWith('#') || target.includes('/') || /\.(?:ya?ml|json)(?:#|$)/i.test(target)))
131
+ continue;
132
+ const resolved = await reader.ref(current, target);
133
+ const key = `${resolved.identity}|schema`;
134
+ if (!visited.has(key)) {
135
+ visited.add(key);
136
+ await walk(reader, resolved.source, resolved.value, 'schema');
137
+ }
138
+ }
139
+ for (const [key, child] of Object.entries(value)) {
140
+ // Examples and schema literals are payload data, including any $ref keys.
141
+ if (key === '$ref' || key.startsWith('x-') || ['example', 'default', 'enum', 'const', 'security'].includes(key) ||
142
+ (kind === 'example' && key === 'value') || (kind === 'schema' && key === 'examples'))
143
+ continue;
144
+ const childKind = kind === 'schema' || key === 'schema' || key === 'schemas' ? 'schema' : key === 'examples' ? 'example' : kind;
145
+ const isMap = kind === 'schema'
146
+ ? ['properties', 'patternProperties', '$defs', 'definitions', 'dependentSchemas'].includes(key)
147
+ : ['paths', 'webhooks', 'schemas', 'responses', 'parameters', 'requestBodies', 'headers', 'links', 'callbacks', 'pathItems', 'securitySchemes', 'examples', 'content', 'encoding', 'variables', 'flows', 'scopes'].includes(key);
148
+ if (isMap && child && typeof child === 'object' && !Array.isArray(child)) {
149
+ for (const entry of Object.values(child))
150
+ await walk(reader, current, entry, childKind);
151
+ }
152
+ else
153
+ await walk(reader, current, child, childKind);
154
+ }
155
+ }
156
+ await walk(this, source, source.value);
157
+ return [...files].sort();
158
+ }
159
+ async operation(file, sourceOperationId, stableOperationId = sourceOperationId, querySyntax = [], pageTitle) {
160
+ const source = await this.load(file);
161
+ const api = source.value;
162
+ if (!/^3\.(0|1)\./.test(String(api.openapi)))
163
+ throw new Error(`${file}: OpenAPI 3.0.x or 3.1.x required`);
164
+ const schemaVersion = String(api.openapi).startsWith('3.0.') ? '3.0' : '3.1';
165
+ let found;
166
+ for (const [collection, webhook] of [[api.paths ?? {}, false], [api.webhooks ?? {}, true]])
167
+ for (const [route, initial] of Object.entries(collection)) {
168
+ const { value: pathItem, source: pathSource } = await this.deref(source, initial);
169
+ for (const [method, op] of Object.entries(pathItem)) {
170
+ if (!methods.has(method))
171
+ continue;
172
+ if (op.operationId === sourceOperationId) {
173
+ if (found)
174
+ throw new Error(`Duplicate OpenAPI operationId ${sourceOperationId}`);
175
+ found = { method, route, op, pathItem, pathSource, webhook };
176
+ }
177
+ }
178
+ }
179
+ if (!found)
180
+ throw new Error(`Missing OpenAPI operationId ${sourceOperationId}`);
181
+ const { method, route, op, pathItem, pathSource, webhook } = found;
182
+ for (const unsupported of ['callbacks', 'webhooks'])
183
+ if (op[unsupported])
184
+ throw new Error(`Unsupported operation feature ${unsupported} on ${sourceOperationId}`);
185
+ const blocks = [tagged(heading(2, webhook ? `Webhook: ${route}` : `${method.toUpperCase()} ${route}`), 'api-operation-heading')];
186
+ if (webhook)
187
+ blocks.push(paragraph(text(`The provider sends a ${method.toUpperCase()} request for this event to the receiver's webhook URL.`)));
188
+ const examples = [];
189
+ const shapes = [];
190
+ let buildRequest;
191
+ let queryRule;
192
+ let queryExpression;
193
+ const exampleIds = new Set();
194
+ const addExamples = async (source, holder, location, mediaType, status, targetBlocks = blocks) => {
195
+ if (holder.example !== undefined && holder.examples !== undefined)
196
+ throw new Error(`${source.file}: ${location} cannot define both example and examples`);
197
+ const entries = holder.examples ? Object.entries(holder.examples) : holder.example !== undefined ? [['default', { value: holder.example, summary: 'Default example' }]] : [];
198
+ for (const [key, initial] of entries) {
199
+ if (initial?.$ref && Object.keys(initial).length !== 1)
200
+ throw new Error(`${source.file}: example reference ${key} has unsupported siblings`);
201
+ const { value: resolved } = await this.deref(source, initial);
202
+ if (!resolved || typeof resolved !== 'object')
203
+ throw new Error(`${source.file}: invalid Example Object ${key}`);
204
+ if ('value' in resolved && 'externalValue' in resolved)
205
+ throw new Error(`${source.file}: example ${key} cannot define both value and externalValue`);
206
+ if (!('value' in resolved) && !('externalValue' in resolved))
207
+ throw new Error(`${source.file}: example ${key} needs value or externalValue`);
208
+ const identity = `${stableOperationId}|${location}|${status ?? ''}|${mediaType ?? ''}|${key}`;
209
+ const id = `example-${slug(stableOperationId)}-${slug(location)}-${slug(status ?? '')}-${slug(mediaType ?? '')}-${slug(key)}-${createHash('sha256').update(identity).digest('hex').slice(0, 7)}`;
210
+ if (exampleIds.has(id))
211
+ throw new Error(`Duplicate named example ${identity}`);
212
+ exampleIds.add(id);
213
+ const example = { id, key, title: exampleTitle(key, resolved.summary), description: String(resolved.description ?? '').trim(), location, mediaType, status, provenance: initial?.$ref ? `OpenAPI component ${initial.$ref}` : 'Authored in OpenAPI' };
214
+ if ('value' in resolved)
215
+ example.value = resolved.value;
216
+ else {
217
+ if (typeof resolved.externalValue !== 'string' || !/^https:\/\//.test(resolved.externalValue))
218
+ throw new Error(`${source.file}: local externalValue needs a pinned adapter for ${key}`);
219
+ example.externalValue = resolved.externalValue;
220
+ }
221
+ examples.push(example);
222
+ if (queryRule && queryExpression === queryRule.example && location === `parameter:query:${queryRule.parameter}` && example.value && typeof example.value === 'object' && !Array.isArray(example.value)) {
223
+ const entries = Object.entries(example.value);
224
+ if (entries.length === 1 && /^[^?&#\s=]+$/.test(entries[0][0]) && ['string', 'number', 'boolean'].includes(typeof entries[0][1]))
225
+ queryExpression = `${entries[0][0]}=${encodeURIComponent(String(entries[0][1]))}`;
226
+ }
227
+ if (location.startsWith('parameter:')) {
228
+ const value = example.externalValue ? link(example.externalValue, 'Open external example') : inline(queryRule && location === `parameter:query:${queryRule.parameter}` ? queryExpression ?? JSON.stringify(example.value) : JSON.stringify(example.value));
229
+ const sample = paragraph({ type: 'strong', children: [text(example.title)] }, text(': '), value, ...(example.description ? [text(` — ${example.description}`)] : []));
230
+ sample.data = { hProperties: { className: ['api-parameter-example'] } };
231
+ targetBlocks.push(sample);
232
+ continue;
233
+ }
234
+ targetBlocks.push(marked(heading(5, `Example: ${example.title}`)));
235
+ targetBlocks.push(marked(paragraph(text(`Key: ${key}. Location: ${location}${status ? ` ${status}` : ''}${mediaType ? `; ${mediaType}` : ''}. ${example.provenance}.`))));
236
+ if (example.description)
237
+ targetBlocks.push(marked(paragraph(text(example.description))));
238
+ if (example.externalValue)
239
+ targetBlocks.push(marked(paragraph(text('External example: '), link(example.externalValue, example.externalValue))));
240
+ else
241
+ targetBlocks.push(marked(code(typeof example.value === 'string' && mediaType?.startsWith('text/') ? example.value : JSON.stringify(example.value, null, 2), mediaType?.includes('json') || typeof example.value !== 'string' ? 'json' : 'text')));
242
+ if (location === 'request' && !webhook && !example.externalValue && buildRequest && mediaType?.toLowerCase() !== 'multipart/form-data') {
243
+ example.samples = requestSamples(buildRequest(mediaType ?? undefined, example.value));
244
+ example.curl = example.samples[0].code;
245
+ targetBlocks.push(marked(paragraph(text('Example request (cURL):'))));
246
+ targetBlocks.push(marked(code(example.curl, 'bash')));
247
+ }
248
+ }
249
+ };
250
+ if (op.summary)
251
+ blocks.push(...parsePlainMarkdown(op.summary).map(node => sameProse(String(op.summary), pageTitle) && node.type === 'paragraph' ? tagged(node, 'api-operation-summary') : node));
252
+ if (op.description)
253
+ blocks.push(...parsePlainMarkdown(op.description));
254
+ if (op.deprecated)
255
+ blocks.push(tagged(paragraph(text('Deprecated operation.')), 'api-deprecated-note'));
256
+ if (op.externalDocs) {
257
+ if (typeof op.externalDocs.url !== 'string')
258
+ throw new Error(`Invalid externalDocs on ${sourceOperationId}`);
259
+ blocks.push(paragraph(text('Additional documentation: '), link(op.externalDocs.url, op.externalDocs.description ?? op.externalDocs.url)));
260
+ }
261
+ const servers = op.servers ?? pathItem.servers ?? api.servers;
262
+ if (!webhook && servers?.length) {
263
+ blocks.push(heading(3, 'Servers'));
264
+ const serverItems = [];
265
+ for (const server of servers) {
266
+ if (typeof server.url !== 'string')
267
+ throw new Error(`Invalid server on ${sourceOperationId}`);
268
+ const item = [paragraph(inline(server.url), ...(server.description ? [text(` — ${server.description}`)] : []))];
269
+ for (const [name, variable] of Object.entries(server.variables ?? {})) {
270
+ if (variable.default === undefined)
271
+ throw new Error(`Server variable ${name} needs a default`);
272
+ item.push(paragraph(inline(name), text(` defaults to ${variable.default}${variable.enum ? `; allowed: ${variable.enum.join(', ')}` : ''}.`)));
273
+ }
274
+ serverItems.push(infoCard(item));
275
+ }
276
+ blocks.push(infoCards('server', serverItems));
277
+ }
278
+ const security = op.security ?? api.security;
279
+ if (security) {
280
+ blocks.push(heading(3, 'Authentication'));
281
+ if (!security.length)
282
+ blocks.push(paragraph(text('No authentication required.')));
283
+ else {
284
+ if (security.length > 1)
285
+ blocks.push(paragraph(text('Use one of these authentication options:')));
286
+ const authItems = [];
287
+ for (const [index, alternative] of security.entries()) {
288
+ const names = Object.keys(alternative);
289
+ const onlyScheme = names.length === 1 ? api.components?.securitySchemes?.[names[0]] : undefined;
290
+ const label = !names.length ? 'No authentication' : names.length > 1 ? `Option ${index + 1} · all required` : onlyScheme?.type === 'apiKey' ? 'API key' : onlyScheme?.type === 'http' && onlyScheme.scheme?.toLowerCase() === 'bearer' ? 'Bearer token' : onlyScheme?.type === 'http' ? `HTTP ${onlyScheme.scheme} authentication` : onlyScheme?.type === 'oauth2' ? 'OAuth2' : onlyScheme?.type === 'openIdConnect' ? 'OpenID Connect' : onlyScheme?.type === 'mutualTLS' ? 'Client certificate' : `Option ${index + 1}`;
291
+ const item = [paragraph({ type: 'strong', children: [text(label)] })];
292
+ if (!names.length) {
293
+ authItems.push(infoCard(item));
294
+ continue;
295
+ }
296
+ for (const name of names) {
297
+ const scheme = api.components?.securitySchemes?.[name];
298
+ if (!scheme)
299
+ throw new Error(`Unknown security scheme ${name}`);
300
+ let detail;
301
+ if (scheme.type === 'apiKey') {
302
+ if (!['header', 'query', 'cookie'].includes(scheme.in) || typeof scheme.name !== 'string')
303
+ throw new Error(`Invalid API key security scheme ${name}`);
304
+ detail = `API key in ${scheme.in} ${scheme.name}`;
305
+ }
306
+ else if (scheme.type === 'http') {
307
+ if (typeof scheme.scheme !== 'string')
308
+ throw new Error(`Invalid HTTP security scheme ${name}`);
309
+ detail = `HTTP ${scheme.scheme}${scheme.bearerFormat ? ` (${scheme.bearerFormat})` : ''}`;
310
+ }
311
+ else if (scheme.type === 'oauth2') {
312
+ const flows = Object.keys(scheme.flows ?? {});
313
+ if (!flows.length)
314
+ throw new Error(`OAuth2 security scheme ${name} has no flows`);
315
+ detail = `OAuth2 flows: ${flows.join(', ')}`;
316
+ }
317
+ else if (scheme.type === 'openIdConnect') {
318
+ if (typeof scheme.openIdConnectUrl !== 'string')
319
+ throw new Error(`OpenID Connect security scheme ${name} has no discovery URL`);
320
+ detail = `OpenID Connect discovery: ${scheme.openIdConnectUrl}`;
321
+ }
322
+ else if (scheme.type === 'mutualTLS')
323
+ detail = 'Mutual TLS client certificate';
324
+ else
325
+ throw new Error(`Unsupported security scheme type ${scheme.type} on ${name}`);
326
+ const scopes = alternative[name];
327
+ if (!Array.isArray(scopes))
328
+ throw new Error(`Security requirement ${name} needs a scopes array`);
329
+ item.push(paragraph(text(`${detail}${scopes.length ? `; scopes: ${scopes.join(', ')}` : ''}.`)));
330
+ if (scheme.description)
331
+ item.push(...parsePlainMarkdown(scheme.description));
332
+ }
333
+ authItems.push(infoCard(item));
334
+ }
335
+ blocks.push(infoCards('auth', authItems));
336
+ }
337
+ }
338
+ const parameters = [];
339
+ const parameterPositions = new Map();
340
+ for (const initial of [...(pathItem.parameters ?? []), ...(op.parameters ?? [])]) {
341
+ const resolved = await this.deref(pathSource, initial);
342
+ const parameter = resolved.value;
343
+ const key = `${parameter.in}|${parameter.name}`;
344
+ if (!parameter.in || !parameter.name)
345
+ throw new Error(`Invalid parameter on ${sourceOperationId}`);
346
+ const position = parameterPositions.get(key);
347
+ if (position === undefined) {
348
+ parameterPositions.set(key, parameters.length);
349
+ parameters.push(resolved);
350
+ }
351
+ else
352
+ parameters[position] = resolved;
353
+ }
354
+ const applicableQueryRules = webhook ? [] : querySyntax.filter(rule => rule.pathPrefixes.some(prefix => route.startsWith(prefix)) && parameters.some(({ value: parameter }) => parameter.in === 'query' && parameter.name === rule.parameter));
355
+ if (applicableQueryRules.length > 1)
356
+ throw new Error(`Multiple query syntax rules apply to ${sourceOperationId}`);
357
+ queryRule = applicableQueryRules[0];
358
+ queryExpression = queryRule?.example;
359
+ buildRequest = (mediaType, body, formFields = []) => {
360
+ const server = servers?.[0];
361
+ const serverUrl = typeof server?.url === 'string' ? server.url.replace(/\{([^}]+)\}/g, (_, name) => String(server.variables?.[name]?.default ?? `YOUR_${name.toUpperCase()}`)) : 'https://YOUR_API_HOST';
362
+ const base = serverUrl.startsWith('/') ? `https://YOUR_API_HOST${serverUrl}` : serverUrl;
363
+ let url = `${base.replace(/\/$/, '')}${route}`;
364
+ for (const { value: parameter } of parameters)
365
+ if (parameter.in === 'path')
366
+ url = url.replaceAll(`{${parameter.name}}`, `YOUR_${String(parameter.name).replace(/[^a-z0-9]/gi, '_').toUpperCase()}`);
367
+ const requiredQuery = parameters.filter(({ value: parameter }) => parameter.in === 'query' && parameter.required && parameter.name !== queryRule?.parameter);
368
+ const query = requiredQuery.map(({ value: parameter }) => `${encodeURIComponent(parameter.name)}=YOUR_${String(parameter.name).replace(/[^a-z0-9]/gi, '_').toUpperCase()}`);
369
+ if (queryExpression)
370
+ query.unshift(queryExpression);
371
+ const auth = [];
372
+ const alternative = security?.[0] ?? {};
373
+ for (const name of Object.keys(alternative)) {
374
+ const scheme = api.components?.securitySchemes?.[name];
375
+ if (scheme?.type === 'apiKey') {
376
+ if (scheme.in === 'header')
377
+ auth.push({ kind: 'header', name: scheme.name, value: 'YOUR_API_KEY' });
378
+ if (scheme.in === 'cookie')
379
+ auth.push({ kind: 'cookie', name: scheme.name, value: 'YOUR_API_KEY' });
380
+ if (scheme.in === 'query')
381
+ query.push(`${encodeURIComponent(scheme.name)}=YOUR_API_KEY`);
382
+ }
383
+ else if (scheme?.type === 'http' && scheme.scheme?.toLowerCase() === 'basic')
384
+ auth.push({ kind: 'basic', user: 'YOUR_USERNAME', pass: 'YOUR_PASSWORD' });
385
+ else if (scheme?.type === 'http' && scheme.scheme?.toLowerCase() === 'digest')
386
+ auth.push({ kind: 'digest', user: 'YOUR_USERNAME', pass: 'YOUR_PASSWORD' });
387
+ else if (scheme?.type === 'http' && scheme.scheme?.toLowerCase() !== 'bearer')
388
+ auth.push({ kind: 'authorization', value: 'YOUR_AUTHORIZATION_VALUE' });
389
+ else if (scheme?.type === 'http' || scheme?.type === 'oauth2' || scheme?.type === 'openIdConnect')
390
+ auth.push({ kind: 'bearer', token: 'YOUR_TOKEN' });
391
+ else if (scheme?.type === 'mutualTLS')
392
+ auth.push({ kind: 'mtls', cert: 'CLIENT_CERT.pem', key: 'CLIENT_KEY.pem' });
393
+ }
394
+ const headers = parameters.filter(({ value: parameter }) => parameter.in === 'header' && parameter.required)
395
+ .map(({ value: parameter }) => ({ name: parameter.name, value: `YOUR_${String(parameter.name).replace(/[^a-z0-9]/gi, '_').toUpperCase()}` }));
396
+ const fullUrl = url + (query.length ? `${url.includes('?') ? '&' : '?'}${query.join('&')}` : '');
397
+ const request = { method, url: fullUrl, headers, auth };
398
+ if (mediaType && !formFields.length)
399
+ request.contentType = mediaType;
400
+ if (formFields.length)
401
+ request.body = { mediaType: mediaType ?? '', text: '', formFields };
402
+ else if (body !== undefined)
403
+ request.body = { mediaType: mediaType ?? '', text: typeof body === 'string' && mediaType?.startsWith('text/') ? body : JSON.stringify(body), formFields: [] };
404
+ return request;
405
+ };
406
+ if (parameters.length) {
407
+ blocks.push(heading(3, 'Parameters'));
408
+ for (const { value: parameter, source } of parameters) {
409
+ if (parameter.content)
410
+ throw new Error(`Parameter content needs an adapter: ${parameter.name}`);
411
+ const unwrapped = queryRule?.parameter === parameter.name && parameter.in === 'query';
412
+ const detail = [{ ...heading(4, unwrapped ? 'Filters' : parameter.name), children: [unwrapped ? text('Filters') : { ...text(parameter.name), data: { hName: 'code' } }, span(` (${parameter.in})`, 'api-parameter-in')] }];
413
+ const presence = paragraph(text(parameter.required ? 'Required' : 'Optional'));
414
+ presence.data = { hProperties: { className: ['api-parameter-presence'], 'data-required': parameter.required ? 'true' : 'false' } };
415
+ detail.push(presence);
416
+ if (unwrapped) {
417
+ detail.push(paragraph(text('OpenAPI calls this placeholder '), inline(parameter.name), text('. Send a filter expression directly in the query string, without '), inline(`${parameter.name}=`), text('.')));
418
+ detail.push(paragraph(text('Query form: '), inline(`?${queryRule.example}`), text('. Replace the field, operator, and value for your filter.')));
419
+ if (parameter.description)
420
+ detail.push(disclosure('Source notes, accepted fields, and operators', parsePlainMarkdown(parameter.description)));
421
+ }
422
+ else if (parameter.description)
423
+ detail.push(...parsePlainMarkdown(parameter.description));
424
+ if (parameter.style || parameter.explode !== undefined)
425
+ detail.push(paragraph(text(`Serialization: ${parameter.style ?? 'default'}; explode: ${parameter.explode ?? 'default'}.`)));
426
+ if (parameter.schema !== undefined)
427
+ detail.push(...await this.schemaBlocks(source, parameter.schema, schemaVersion, 5, new Set(), ['parameter', parameter.in, parameter.name], [], parameter.description));
428
+ await addExamples(source, parameter, `parameter:${parameter.in}:${parameter.name}`, null, null, detail);
429
+ blocks.push({ type: 'docApiParameter', data: { hName: 'section', hProperties: { className: ['api-parameter'] } }, children: detail });
430
+ }
431
+ }
432
+ let multipartRequest;
433
+ if (op.requestBody) {
434
+ const { value: requestBody, source: requestSource } = await this.deref(pathSource, op.requestBody);
435
+ blocks.push(heading(3, 'Request body'));
436
+ blocks.push(tagged(paragraph(text(requestBody.required ? 'Required' : 'Optional'), span('.', 'api-separator')), 'api-body-presence', { 'data-required': requestBody.required ? 'true' : 'false' }));
437
+ if (requestBody.description)
438
+ blocks.push(...parsePlainMarkdown(requestBody.description));
439
+ for (const [mediaType, media] of Object.entries(requestBody.content ?? {})) {
440
+ if (media.encoding)
441
+ throw new Error(`Request encoding needs an adapter: ${mediaType}`);
442
+ blocks.push(tagged(heading(4, mediaType), 'api-media-heading'));
443
+ if (media.schema !== undefined) {
444
+ blocks.push(...await this.schemaBlocks(requestSource, media.schema, schemaVersion, 5, new Set(), ['request', mediaType]));
445
+ if (mediaType.toLowerCase().includes('json'))
446
+ shapes.push({ location: 'request', status: null, mediaType, value: await this.schemaShape(requestSource, media.schema, new Set()) });
447
+ if (mediaType.toLowerCase() === 'multipart/form-data') {
448
+ const { value: schema } = await this.deref(requestSource, media.schema);
449
+ const required = schema?.required;
450
+ if (Array.isArray(required) && required.length && required.every((name) => typeof name === 'string' && schema.properties?.[name]?.type === 'string' && schema.properties[name].format === 'binary')) {
451
+ if (!webhook)
452
+ multipartRequest = buildRequest(mediaType, undefined, required);
453
+ }
454
+ }
455
+ }
456
+ await addExamples(requestSource, media, 'request', mediaType, null);
457
+ }
458
+ }
459
+ const samples = webhook || (op.requestBody && !multipartRequest) ? undefined : requestSamples(!op.requestBody ? buildRequest() : multipartRequest);
460
+ const curl = samples?.[0]?.code;
461
+ if (curl) {
462
+ blocks.push(marked(heading(3, 'Example request')));
463
+ blocks.push(marked(code(curl, 'bash')));
464
+ }
465
+ blocks.push(heading(3, 'Responses'));
466
+ for (const [status, initial] of Object.entries(op.responses ?? {})) {
467
+ const { value: response, source: responseSource } = await this.deref(pathSource, initial);
468
+ if (response.headers || response.links)
469
+ throw new Error(`Response headers or links need an adapter: ${status}`);
470
+ const description = String(response.description ?? '').trim();
471
+ const mediaEntries = Object.entries(response.content ?? {});
472
+ const responseBlocks = [];
473
+ const responseHeading = { ...heading(4, ''), children: [span(status, 'api-status-code'), span(': ', 'api-separator'), text(status === 'default' ? 'Default response' : STATUS_CODES[Number(status)] ?? 'Response')] };
474
+ responseBlocks.push({ type: 'docApiResponseHeader', data: { hName: 'div', hProperties: { className: ['api-response-header'] } }, children: [responseHeading, ...mediaEntries.map(([mediaType]) => ({ ...paragraph(inline(mediaType)), data: { hProperties: { className: ['api-response-media'] } } }))] });
475
+ if (description)
476
+ responseBlocks.push(...parsePlainMarkdown(description));
477
+ for (const [mediaType, media] of mediaEntries) {
478
+ if (mediaEntries.length > 1)
479
+ responseBlocks.push(tagged(heading(5, mediaType), 'api-media-heading'));
480
+ if (media.schema !== undefined) {
481
+ responseBlocks.push(...await this.schemaBlocks(responseSource, media.schema, schemaVersion, 5, new Set(), ['response', status, mediaType]));
482
+ if (mediaType.toLowerCase().includes('json'))
483
+ shapes.push({ location: 'response', status, mediaType, value: await this.schemaShape(responseSource, media.schema, new Set()) });
484
+ }
485
+ await addExamples(responseSource, media, 'response', mediaType, status, responseBlocks);
486
+ }
487
+ blocks.push({ type: 'docApiResponse', data: { hName: 'section', hProperties: { className: ['api-response'], 'data-status': /^[1-5]\d\d$/.test(status) ? `${status[0]}xx` : status.toLowerCase() } }, children: responseBlocks });
488
+ }
489
+ if (op.tags !== undefined && (!Array.isArray(op.tags) || op.tags.some((tag) => typeof tag !== 'string')))
490
+ throw new Error(`Invalid OpenAPI tags on ${sourceOperationId}`);
491
+ return { blocks, examples, shapes, curl, samples, method, route, webhook, deprecated: op.deprecated === true, tags: op.tags ?? [] };
492
+ }
493
+ async schemaShape(source, schema, seen, depth = 0) {
494
+ if (schema === true)
495
+ return '<any value>';
496
+ if (schema === false)
497
+ return '<no valid value>';
498
+ if (!schema || typeof schema !== 'object')
499
+ return 'unknown';
500
+ if (depth > 12)
501
+ return '<nested schema>';
502
+ if (schema.$ref) {
503
+ const resolved = await this.ref(source, schema.$ref);
504
+ if (seen.has(resolved.identity))
505
+ return `<recursive ${schemaName(resolved.label)}>`;
506
+ const next = new Set(seen);
507
+ next.add(resolved.identity);
508
+ return this.schemaShape(resolved.source, resolved.value, next, depth + 1);
509
+ }
510
+ if (schema.allOf?.length) {
511
+ const parts = await Promise.all(schema.allOf.map((part) => this.schemaShape(source, part, seen, depth + 1)));
512
+ if (parts.every(part => part && typeof part === 'object' && !Array.isArray(part))) {
513
+ const own = await this.schemaShape(source, { ...schema, allOf: undefined }, seen, depth + 1);
514
+ return Object.assign({}, ...parts, own && typeof own === 'object' && !Array.isArray(own) ? own : {});
515
+ }
516
+ return { allOf: parts };
517
+ }
518
+ for (const kind of ['oneOf', 'anyOf'])
519
+ if (schema[kind]?.length)
520
+ return { [kind]: await Promise.all(schema[kind].map((part) => this.schemaShape(source, part, seen, depth + 1))) };
521
+ if (schema.const !== undefined)
522
+ return schema.const;
523
+ const types = Array.isArray(schema.type) ? schema.type : schema.type ? [schema.type] : [];
524
+ if (schema.properties || types.includes('object') || schema.additionalProperties) {
525
+ const value = {};
526
+ for (const [name, child] of Object.entries(schema.properties ?? {}))
527
+ value[name] = await this.schemaShape(source, child, seen, depth + 1);
528
+ if (schema.additionalProperties && typeof schema.additionalProperties === 'object')
529
+ value['<key>'] = await this.schemaShape(source, schema.additionalProperties, seen, depth + 1);
530
+ return value;
531
+ }
532
+ if (schema.items !== undefined || types.includes('array'))
533
+ return [schema.items !== undefined ? await this.schemaShape(source, schema.items, seen, depth + 1) : 'unknown'];
534
+ const label = types.length ? types.join(' | ') : schema.enum?.length ? typeof schema.enum[0] : 'unknown';
535
+ return `${label}${schema.format ? ` (${schema.format})` : ''}${schema.nullable && !types.includes('null') ? ' | null' : ''}`;
536
+ }
537
+ async schemaAllowsNull(source, schema, seen = new Set()) {
538
+ if (typeof schema === 'boolean')
539
+ return schema;
540
+ if (!schema || typeof schema !== 'object')
541
+ return false;
542
+ if (schema.nullable === true || schema.type === 'null' || (Array.isArray(schema.type) && schema.type.includes('null')) || schema.const === null || schema.enum?.includes(null))
543
+ return true;
544
+ if (schema.type !== undefined || schema.const !== undefined || schema.enum !== undefined)
545
+ return false;
546
+ if (schema.$ref) {
547
+ const resolved = await this.ref(source, schema.$ref);
548
+ if (seen.has(resolved.identity))
549
+ return false;
550
+ return this.schemaAllowsNull(resolved.source, resolved.value, new Set([...seen, resolved.identity]));
551
+ }
552
+ if (schema.oneOf?.length || schema.anyOf?.length) {
553
+ for (const child of [...(schema.oneOf ?? []), ...(schema.anyOf ?? [])])
554
+ if (await this.schemaAllowsNull(source, child, seen))
555
+ return true;
556
+ }
557
+ if (schema.allOf?.length) {
558
+ for (const child of schema.allOf)
559
+ if (!await this.schemaAllowsNull(source, child, seen))
560
+ return false;
561
+ return true;
562
+ }
563
+ return false;
564
+ }
565
+ async schemaTypeLabel(source, schema, seen = new Set()) {
566
+ if (schema === true)
567
+ return 'any value';
568
+ if (schema === false)
569
+ return 'no valid value';
570
+ if (!schema || typeof schema !== 'object')
571
+ return 'unknown';
572
+ if (schema.$ref) {
573
+ const resolved = await this.ref(source, schema.$ref);
574
+ if (seen.has(resolved.identity))
575
+ return 'object';
576
+ return this.schemaTypeLabel(resolved.source, resolved.value, new Set([...seen, resolved.identity]));
577
+ }
578
+ const types = Array.isArray(schema.type) ? schema.type : schema.type ? [schema.type] : [];
579
+ if (schema.items !== undefined || types.includes('array'))
580
+ return `list of ${schema.items !== undefined ? await this.schemaTypeLabel(source, schema.items, seen) : 'unknown'}`;
581
+ if (schema.properties || types.includes('object') || schema.additionalProperties)
582
+ return 'object';
583
+ if (schema.enum?.length)
584
+ return `enum<${types.find((type) => type !== 'null') ?? typeof schema.enum.find((value) => value !== null)}>`;
585
+ if (types.length)
586
+ return types.filter((type) => type !== 'null').join(' | ') || 'null';
587
+ if (schema.oneOf?.length || schema.anyOf?.length)
588
+ return 'one of several types';
589
+ if (schema.allOf?.length)
590
+ return this.schemaTypeLabel(source, schema.allOf[0], seen);
591
+ return schema.const !== undefined ? typeof schema.const : 'unknown';
592
+ }
593
+ async operationSchema(file, sourceOperationId, selection, anchorScope = '') {
594
+ const source = await this.load(file);
595
+ if (!/^3\.(0|1)\./.test(String(source.value.openapi)))
596
+ throw new Error(`${file}: OpenAPI 3.0.x or 3.1.x required`);
597
+ const schemaVersion = String(source.value.openapi).startsWith('3.0.') ? '3.0' : '3.1';
598
+ let operation;
599
+ for (const collection of [source.value.paths ?? {}, source.value.webhooks ?? {}])
600
+ for (const initial of Object.values(collection)) {
601
+ const pathItem = await this.deref(source, initial);
602
+ for (const [method, candidate] of Object.entries(pathItem.value))
603
+ if (methods.has(method) && candidate.operationId === sourceOperationId) {
604
+ if (operation)
605
+ throw new Error(`duplicate OpenAPI operationId ${sourceOperationId}`);
606
+ operation = { value: candidate, source: pathItem.source };
607
+ }
608
+ }
609
+ if (!operation)
610
+ throw new Error(`unknown OpenAPI operationId ${sourceOperationId}`);
611
+ const holder = selection.kind === 'request' ? operation.value.requestBody : operation.value.responses?.[selection.status];
612
+ if (!holder)
613
+ throw new Error(`missing ${selection.kind}${selection.status ? ` ${selection.status}` : ''} on ${sourceOperationId}`);
614
+ const resolved = await this.deref(operation.source, holder);
615
+ const media = resolved.value.content?.[selection.mediaType];
616
+ if (!media)
617
+ throw new Error(`missing ${selection.mediaType} in ${selection.kind}${selection.status ? ` ${selection.status}` : ''} on ${sourceOperationId}`);
618
+ if (media.schema === undefined)
619
+ throw new Error(`missing schema for ${selection.mediaType} on ${sourceOperationId}`);
620
+ const schema = selection.schema ? { $ref: selection.schema } : media.schema;
621
+ const schemaSource = selection.schema ? source : resolved.source;
622
+ const label = `${selection.kind === 'request' ? 'Request' : `Response ${selection.status}`} schema · ${selection.mediaType}`;
623
+ return [heading(3, label), ...await this.schemaBlocks(schemaSource, schema, schemaVersion, 4, new Set(), [selection.kind, 'embedded', anchorScope, sourceOperationId, selection.status ?? '', selection.mediaType])];
624
+ }
625
+ async schemaReference(file, reference, anchorScope = '') {
626
+ const source = await this.load(file);
627
+ if (!/^3\.(0|1)\./.test(String(source.value.openapi)))
628
+ throw new Error(`${file}: OpenAPI 3.0.x or 3.1.x required`);
629
+ const schemaVersion = String(source.value.openapi).startsWith('3.0.') ? '3.0' : '3.1';
630
+ const selected = await this.ref(source, reference);
631
+ if (selected.value === null || !['object', 'boolean'].includes(typeof selected.value) || Array.isArray(selected.value))
632
+ throw new Error(`${file}: ${reference} must select a schema`);
633
+ const field = /\/properties\/[^/]+$/.test(reference);
634
+ const label = `${field ? 'Field' : 'Schema'} · ${schemaName(reference)}`;
635
+ return [heading(3, label), ...await this.schemaBlocks(selected.source, selected.value, schemaVersion, 4, new Set(), ['standalone', 'embedded', anchorScope, reference])];
636
+ }
637
+ async deref(source, value) {
638
+ const seen = new Set();
639
+ while (value?.$ref) {
640
+ const identity = `${source.file}#${value.$ref}`;
641
+ if (seen.has(identity))
642
+ throw new Error(`Recursive reference object ${value.$ref} in ${source.file}`);
643
+ seen.add(identity);
644
+ ({ value, source } = await this.ref(source, value.$ref));
645
+ }
646
+ return { value, source };
647
+ }
648
+ async schemaBlocks(source, schema, schemaVersion, depth, seen, scope, trail = [], omitRootDescription, omitRootType = false) {
649
+ const location = `${[...scope, ...trail].join('/')} in ${source.file}`;
650
+ if (typeof schema === 'boolean') {
651
+ if (schemaVersion === '3.0')
652
+ throw new Error(`Boolean schemas require OpenAPI 3.1 at ${location}`);
653
+ return [paragraph(text(schema ? 'Any value is allowed.' : 'No value is allowed.'))];
654
+ }
655
+ if (!schema || typeof schema !== 'object' || Array.isArray(schema))
656
+ throw new Error(`Invalid schema at ${location}`);
657
+ for (const key of Object.keys(schema))
658
+ if (!supportedSchemaKeywords.has(key) && !key.startsWith('x-'))
659
+ throw new Error(`Unsupported schema keyword ${key} at ${location}`);
660
+ if (schema.examples !== undefined && (schemaVersion === '3.0' || !Array.isArray(schema.examples)))
661
+ throw new Error(`Schema examples need an array in OpenAPI 3.1 at ${location}`);
662
+ for (const key of ['exclusiveMinimum', 'exclusiveMaximum'])
663
+ if (schema[key] !== undefined) {
664
+ if (schemaVersion === '3.0' && (typeof schema[key] !== 'boolean' || typeof schema[key === 'exclusiveMinimum' ? 'minimum' : 'maximum'] !== 'number'))
665
+ throw new Error(`${key} in OpenAPI 3.0 needs a boolean and its numeric ${key === 'exclusiveMinimum' ? 'minimum' : 'maximum'} at ${location}`);
666
+ if (schemaVersion === '3.1' && (typeof schema[key] !== 'number' || !Number.isFinite(schema[key])))
667
+ throw new Error(`${key} in OpenAPI 3.1 needs a number at ${location}`);
668
+ }
669
+ if (schema.$ref) {
670
+ const resolved = await this.ref(source, schema.$ref);
671
+ const { $ref, description: localDescription, ...adjacent } = schema;
672
+ const annotations = Object.keys(adjacent).length ? [tagged(paragraph(text('Additional schema keywords at this use:')), 'api-schema-label'), ...await this.schemaBlocks(source, adjacent, schemaVersion, depth, seen, scope, [...trail, 'adjacent'])] : [];
673
+ const description = typeof localDescription === 'string' ? localDescription : resolved.value?.description;
674
+ const visibleDescription = typeof description === 'string' && !sameProse(description, omitRootDescription) ? parsePlainMarkdown(description) : [];
675
+ if (seen.has(resolved.identity))
676
+ return [...visibleDescription, paragraph(text('Recursive reference: '), inline(schemaName(resolved.label)), text('.')), ...annotations];
677
+ const next = new Set(seen);
678
+ next.add(resolved.identity);
679
+ const array = resolved.value?.items || resolved.value?.type === 'array';
680
+ const object = resolved.value?.properties || resolved.value?.additionalProperties || resolved.value?.allOf || resolved.value?.oneOf || resolved.value?.anyOf || resolved.value?.type === 'object';
681
+ const detail = [...await this.schemaBlocks(resolved.source, resolved.value, schemaVersion, depth, next, scope, trail, resolved.value?.description, omitRootType || Boolean(object)), ...annotations];
682
+ return array ? [...visibleDescription, disclosure('Items', detail, depth <= 5)] : [...visibleDescription, ...detail];
683
+ }
684
+ const parts = [];
685
+ if (schema.type && !omitRootType)
686
+ parts.push(Array.isArray(schema.type) ? schema.type.join(' | ') : schema.type);
687
+ if (schema.format)
688
+ parts.push(`format: ${schema.format}`);
689
+ if (schema.nullable)
690
+ parts.push('nullable');
691
+ if (schema.const !== undefined)
692
+ parts.push(`const: ${JSON.stringify(schema.const)}`);
693
+ if (schema.default !== undefined)
694
+ parts.push(`default: ${JSON.stringify(schema.default)}`);
695
+ for (const key of ['minLength', 'maxLength', 'minimum', 'maximum', 'multipleOf', 'minItems', 'maxItems', 'minProperties', 'maxProperties', 'pattern'])
696
+ if (schema[key] !== undefined)
697
+ parts.push(`${key}: ${schema[key]}`);
698
+ for (const key of ['exclusiveMinimum', 'exclusiveMaximum'])
699
+ if (schema[key] !== undefined)
700
+ parts.push(`${key}: ${schema[key]}`);
701
+ if (schema.uniqueItems !== undefined)
702
+ parts.push(`uniqueItems: ${schema.uniqueItems}`);
703
+ if (schema.readOnly)
704
+ parts.push('read only');
705
+ if (schema.writeOnly)
706
+ parts.push('write only');
707
+ if (schema.deprecated)
708
+ parts.push('deprecated');
709
+ if (schema.title)
710
+ parts.push(`title: ${schema.title}`);
711
+ const blocks = [];
712
+ if (parts.length)
713
+ blocks.push(tagged(paragraph(...parts.flatMap((part, index) => index ? [span('; ', 'api-separator'), span(part, 'api-constraint')] : [span(part, 'api-constraint')])), 'api-schema-constraints'));
714
+ if (schema.description && !sameProse(schema.description, omitRootDescription))
715
+ blocks.push(...parsePlainMarkdown(schema.description));
716
+ if (schema.enum) {
717
+ const options = paragraph(span('Available options: ', 'api-enum-label'), ...schema.enum.flatMap((value, index) => index ? [span(', ', 'api-separator'), inline(JSON.stringify(value))] : [inline(JSON.stringify(value))]));
718
+ options.data = { hProperties: { className: ['api-enum-options'] } };
719
+ blocks.push(options);
720
+ }
721
+ if (schema.example !== undefined)
722
+ blocks.push(tagged(paragraph(text('Example (authored in OpenAPI):')), 'api-schema-label'), code(JSON.stringify(schema.example, null, 2), 'json'));
723
+ for (const [index, example] of (schema.examples ?? []).entries())
724
+ blocks.push(tagged(paragraph(text(`Example ${index + 1} (authored in OpenAPI):`)), 'api-schema-label'), code(JSON.stringify(example, null, 2), 'json'));
725
+ if (schema.discriminator) {
726
+ const discriminator = schema.discriminator;
727
+ if (typeof discriminator.propertyName !== 'string' || (discriminator.mapping && (typeof discriminator.mapping !== 'object' || Object.values(discriminator.mapping).some(value => typeof value !== 'string'))))
728
+ throw new Error(`Invalid discriminator in ${source.file}`);
729
+ blocks.push(paragraph(text('Discriminator property: '), inline(discriminator.propertyName)));
730
+ if (discriminator.mapping)
731
+ blocks.push(list(Object.entries(discriminator.mapping).map(([name, reference]) => [paragraph(inline(name), text(' selects '), inline(reference))])));
732
+ }
733
+ for (const composition of ['allOf', 'oneOf', 'anyOf'])
734
+ if (schema[composition]) {
735
+ blocks.push(tagged(paragraph(text(composition === 'allOf' ? 'All of these parts apply:' : composition === 'oneOf' ? scope[0] === 'response' ? 'The response has exactly one of these shapes:' : 'Use exactly one of these shapes:' : 'Use one or more of these shapes:')), 'api-schema-label'));
736
+ for (const [index, child] of schema[composition].entries()) {
737
+ const label = typeof child.title === 'string' && child.title.trim() ? child.title.trim() : `${composition === 'allOf' ? 'Part' : 'Shape'} ${index + 1}`;
738
+ let shape = child;
739
+ if (child && typeof child === 'object') {
740
+ const { title: _title, ...withoutTitle } = child;
741
+ shape = withoutTitle;
742
+ }
743
+ const detail = await this.schemaBlocks(source, shape, schemaVersion, depth + 1, seen, scope, [...trail, composition, String(index + 1)]);
744
+ const resolved = await this.deref(source, child);
745
+ const count = Object.keys(resolved.value?.properties ?? {}).length;
746
+ const metadata = count ? ` · ${count} ${count === 1 ? 'property' : 'properties'}` : '';
747
+ blocks.push({ type: 'docApiVariant', data: { hName: 'div', hProperties: { className: ['api-schema-variant'] } }, children: [tagged(paragraph({ type: 'strong', children: [text(label)] }, ...(metadata ? [span(metadata, 'api-variant-count')] : [])), 'api-schema-variant-title'), ...detail] });
748
+ }
749
+ }
750
+ if (schema.items !== undefined) {
751
+ blocks.push(tagged(paragraph(text('Array items:')), 'api-schema-label'));
752
+ blocks.push(...await this.schemaBlocks(source, schema.items, schemaVersion, depth + 1, seen, scope, [...trail, 'items']));
753
+ }
754
+ const entries = Object.entries(schema.properties ?? {});
755
+ if (entries.length) {
756
+ const items = [];
757
+ for (const [name, child] of entries) {
758
+ const required = schema.required?.includes(name) ?? false;
759
+ const nullable = await this.schemaAllowsNull(source, child);
760
+ const requirement = scope[0] === 'response' ? (required ? 'always present' : 'may be absent') : (required ? 'required' : 'optional');
761
+ const anchor = anchorFor([...scope, ...trail, name]);
762
+ const typeLabel = await this.schemaTypeLabel(source, child);
763
+ const fieldPath = [...trail, name].join('.');
764
+ const pathHint = { type: 'docApiPathHint', data: { hName: 'span', hProperties: { className: ['api-field-path'], 'data-path': fieldPath, 'aria-label': `Field path: ${fieldPath}`, tabIndex: 0 } }, children: [text('ⓘ')] };
765
+ const field = paragraph(inline(name), text(' '), { ...inline(typeLabel), data: { hProperties: { className: ['api-field-type'] } } }, text(' '), { type: 'strong', children: [text(requirement)] }, ...(nullable ? [text(' '), { type: 'strong', data: { hProperties: { className: ['nullability-badge'] } }, children: [text('nullable')] }] : []), text(' '), pathHint);
766
+ field.data = { hProperties: { id: anchor, 'data-field': '', 'data-presence': required ? 'present' : 'optional' } };
767
+ const nested = await this.schemaBlocks(source, child, schemaVersion, depth + 1, seen, scope, [...trail, name], undefined, true);
768
+ items.push([field, ...nested]);
769
+ }
770
+ blocks.push(disclosure(`${entries.length} ${entries.length === 1 ? 'property' : 'properties'}`, [list(items)], depth <= 5, true));
771
+ }
772
+ if (schema.additionalProperties !== undefined) {
773
+ if (typeof schema.additionalProperties === 'boolean')
774
+ blocks.push(paragraph(text(`Additional properties: ${schema.additionalProperties ? 'allowed' : 'not allowed'}.`)));
775
+ else {
776
+ blocks.push(tagged(paragraph(text('Additional-key schema:')), 'api-schema-label'));
777
+ blocks.push(...await this.schemaBlocks(source, schema.additionalProperties, schemaVersion, depth + 1, seen, scope, [...trail, 'additionalProperties']));
778
+ }
779
+ }
780
+ return blocks;
781
+ }
782
+ }