@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
@@ -0,0 +1,292 @@
1
+ import { createHash } from 'node:crypto';
2
+ import { lookup } from 'node:dns/promises';
3
+ import { lstat, mkdir, mkdtemp, readFile, rename, rm, writeFile } from 'node:fs/promises';
4
+ import { request } from 'node:https';
5
+ import { BlockList, isIP } from 'node:net';
6
+ import path from 'node:path';
7
+ import YAML from 'yaml';
8
+ import { ApiReader } from './api.js';
9
+ const maxFileBytes = 4 * 1024 * 1024;
10
+ const maxTotalBytes = 16 * 1024 * 1024;
11
+ const maxFiles = 128;
12
+ const hash = (value) => createHash('sha256').update(value).digest('hex');
13
+ const blocked = new BlockList();
14
+ for (const [address, prefix] of [
15
+ ['0.0.0.0', 8], ['10.0.0.0', 8], ['100.64.0.0', 10], ['127.0.0.0', 8],
16
+ ['169.254.0.0', 16], ['172.16.0.0', 12], ['192.0.0.0', 24], ['192.0.2.0', 24],
17
+ ['192.168.0.0', 16], ['198.18.0.0', 15], ['198.51.100.0', 24],
18
+ ['203.0.113.0', 24], ['192.88.99.0', 24], ['224.0.0.0', 4], ['240.0.0.0', 4]
19
+ ])
20
+ blocked.addSubnet(address, prefix, 'ipv4');
21
+ for (const [address, prefix] of [
22
+ ['::', 128], ['::1', 128], ['64:ff9b::', 96],
23
+ ['2001::', 32], ['2001:db8::', 32], ['2002::', 16], ['fc00::', 7], ['fe80::', 10], ['ff00::', 8]
24
+ ])
25
+ blocked.addSubnet(address, prefix, 'ipv6');
26
+ function checkedUrl(value, origin) {
27
+ let url;
28
+ try {
29
+ url = new URL(value);
30
+ }
31
+ catch {
32
+ throw new Error(`OpenAPI source needs an absolute HTTPS URL: ${value}`);
33
+ }
34
+ if (url.protocol !== 'https:' || url.username || url.password || url.port || url.search || url.hash || isIP(url.hostname.replace(/^\[|\]$/g, ''))) {
35
+ throw new Error(`OpenAPI source needs a public HTTPS URL without credentials, port, query, or fragment: ${value}`);
36
+ }
37
+ if (origin && url.origin !== origin)
38
+ throw new Error(`Remote $ref leaves the OpenAPI source origin: ${value}`);
39
+ return url;
40
+ }
41
+ async function publicAddress(hostname) {
42
+ const addresses = await lookup(hostname, { all: true, verbatim: true });
43
+ if (!addresses.length || addresses.some(({ address, family }) => !isPublicImportAddress(address, family))) {
44
+ throw new Error(`OpenAPI source host does not resolve only to public addresses: ${hostname}`);
45
+ }
46
+ return addresses[0];
47
+ }
48
+ export function isPublicImportAddress(address, family) {
49
+ return !blocked.check(address, family === 4 ? 'ipv4' : 'ipv6');
50
+ }
51
+ async function downloadPublic(url) {
52
+ const address = await publicAddress(url.hostname);
53
+ return new Promise((resolve, reject) => {
54
+ const req = request(url, {
55
+ method: 'GET', timeout: 10_000, headers: { accept: 'application/yaml, application/json, text/yaml, text/plain', 'accept-encoding': 'identity' },
56
+ lookup: ((_host, options, callback) => {
57
+ if (options.all)
58
+ callback(null, [address]);
59
+ else
60
+ callback(null, address.address, address.family);
61
+ })
62
+ }, response => {
63
+ if (response.statusCode !== 200) {
64
+ response.resume();
65
+ reject(new Error(`OpenAPI download returned HTTP ${response.statusCode} for ${url}`));
66
+ return;
67
+ }
68
+ const chunks = [];
69
+ let size = 0;
70
+ response.on('data', (chunk) => {
71
+ size += chunk.length;
72
+ if (size > maxFileBytes) {
73
+ req.destroy(new Error(`OpenAPI source exceeds ${maxFileBytes} bytes: ${url}`));
74
+ return;
75
+ }
76
+ chunks.push(chunk);
77
+ });
78
+ response.on('end', () => resolve(Buffer.concat(chunks)));
79
+ response.on('error', reject);
80
+ });
81
+ const deadline = setTimeout(() => req.destroy(new Error(`OpenAPI download exceeded 30 seconds: ${url}`)), 30_000);
82
+ req.once('close', () => clearTimeout(deadline));
83
+ req.on('timeout', () => req.destroy(new Error(`OpenAPI download timed out: ${url}`)));
84
+ req.on('error', reject);
85
+ req.end();
86
+ });
87
+ }
88
+ function parse(source, url) {
89
+ const document = YAML.parseDocument(source.toString('utf8'), { uniqueKeys: true });
90
+ if (document.errors.length)
91
+ throw new Error(`${url}: ${document.errors.map(error => error.message).join('; ')}`);
92
+ return document.toJS();
93
+ }
94
+ function localPath(url, entry) {
95
+ return url === entry ? 'openapi.yaml' : `refs/${hash(url)}.yaml`;
96
+ }
97
+ async function snapshot(entry, directory, download) {
98
+ const entryUrl = checkedUrl(entry);
99
+ const queue = [entryUrl.href];
100
+ const queued = new Set(queue);
101
+ const files = [];
102
+ let totalBytes = 0;
103
+ for (let index = 0; index < queue.length; index++) {
104
+ const currentUrl = queue[index];
105
+ const bytes = await download(new URL(currentUrl));
106
+ totalBytes += bytes.length;
107
+ if (bytes.length > maxFileBytes || totalBytes > maxTotalBytes)
108
+ throw new Error('Remote OpenAPI source exceeds the import size limit');
109
+ const value = parse(bytes, currentUrl);
110
+ if (index === 0 && (!value || typeof value !== 'object' || Array.isArray(value) || !/^3\.(0|1)\./.test(String(value.openapi)))) {
111
+ throw new Error(`${currentUrl}: OpenAPI 3.0.x or 3.1.x document required`);
112
+ }
113
+ const currentPath = localPath(currentUrl, entry);
114
+ function rewriteReference(reference) {
115
+ if (reference.startsWith('#'))
116
+ return reference;
117
+ let target;
118
+ try {
119
+ target = new URL(reference, currentUrl);
120
+ }
121
+ catch {
122
+ throw new Error(`Invalid remote reference ${reference} in ${currentUrl}`);
123
+ }
124
+ let fragment;
125
+ try {
126
+ fragment = decodeURIComponent(target.hash);
127
+ }
128
+ catch {
129
+ throw new Error(`Invalid remote reference fragment ${reference}`);
130
+ }
131
+ target.hash = '';
132
+ checkedUrl(target.href, entryUrl.origin);
133
+ if (fragment && !fragment.startsWith('#/'))
134
+ throw new Error(`Unsupported remote reference fragment ${reference}`);
135
+ if (!queued.has(target.href)) {
136
+ if (queue.length >= maxFiles)
137
+ throw new Error(`Remote OpenAPI source exceeds ${maxFiles} files`);
138
+ queue.push(target.href);
139
+ queued.add(target.href);
140
+ }
141
+ if (target.href === currentUrl)
142
+ return fragment || '#';
143
+ const relative = path.posix.relative(path.posix.dirname(currentPath), localPath(target.href, entry));
144
+ return `${relative.startsWith('.') ? relative : `./${relative}`}${fragment}`;
145
+ }
146
+ async function rewrite(node, kind = 'object', map = false) {
147
+ if (!node || typeof node !== 'object')
148
+ return;
149
+ if (Array.isArray(node)) {
150
+ for (const child of node)
151
+ await rewrite(child, kind);
152
+ return;
153
+ }
154
+ if (map) {
155
+ for (const child of Object.values(node))
156
+ await rewrite(child, kind);
157
+ return;
158
+ }
159
+ if (typeof node.$ref === 'string')
160
+ node.$ref = rewriteReference(node.$ref);
161
+ if (node.discriminator?.mapping && typeof node.discriminator.mapping === 'object') {
162
+ for (const [name, target] of Object.entries(node.discriminator.mapping)) {
163
+ if (typeof target !== 'string')
164
+ throw new Error(`Invalid discriminator mapping ${name} in ${currentUrl}`);
165
+ if (target.startsWith('.') || target.startsWith('/') || target.includes('/') || /\.(?:ya?ml|json)(?:#|$)/i.test(target))
166
+ node.discriminator.mapping[name] = rewriteReference(target);
167
+ }
168
+ }
169
+ for (const [key, child] of Object.entries(node)) {
170
+ if (key === '$ref' || key.startsWith('x-') || ['example', 'default', 'enum', 'const', 'security'].includes(key) ||
171
+ (kind === 'example' && key === 'value') || (kind === 'schema' && key === 'examples'))
172
+ continue;
173
+ const childKind = kind === 'schema' || key === 'schema' || key === 'schemas' ? 'schema' : key === 'examples' ? 'example' : kind;
174
+ const isMap = kind === 'schema'
175
+ ? ['properties', 'patternProperties', '$defs', 'definitions', 'dependentSchemas'].includes(key)
176
+ : ['paths', 'webhooks', 'schemas', 'responses', 'parameters', 'requestBodies', 'headers', 'links', 'callbacks', 'pathItems', 'securitySchemes', 'examples', 'content', 'encoding', 'variables', 'flows', 'scopes'].includes(key);
177
+ await rewrite(child, childKind, isMap);
178
+ }
179
+ }
180
+ await rewrite(value);
181
+ const output = path.join(directory, currentPath);
182
+ const digest = hash(bytes);
183
+ const snapshotText = `# Imported from ${currentUrl}\n# Source SHA-256: ${digest}\n${YAML.stringify(value)}`;
184
+ await mkdir(path.dirname(output), { recursive: true });
185
+ await writeFile(output, snapshotText);
186
+ files.push({ url: currentUrl, path: currentPath, digest, snapshotDigest: hash(snapshotText) });
187
+ }
188
+ const lock = { version: 1, entry, files: files.sort((a, b) => a.url.localeCompare(b.url)) };
189
+ await writeFile(path.join(directory, 'source-lock.json'), JSON.stringify(lock, null, 2) + '\n');
190
+ await new ApiReader().collectReferences(path.join(directory, 'openapi.yaml'));
191
+ return lock;
192
+ }
193
+ function changes(previous, next) {
194
+ const oldFiles = new Map(previous?.files.map(file => [file.url, file]) ?? []);
195
+ const newFiles = new Map(next.files.map(file => [file.url, file]));
196
+ return [...new Set([...oldFiles.keys(), ...newFiles.keys()])].sort().flatMap(url => {
197
+ const before = oldFiles.get(url);
198
+ const after = newFiles.get(url);
199
+ return before?.digest === after?.digest && before?.snapshotDigest === after?.snapshotDigest ? [] : [{
200
+ url, before: before?.digest ?? null, after: after?.digest ?? null,
201
+ snapshotBefore: before?.snapshotDigest ?? null, snapshotAfter: after?.snapshotDigest ?? null
202
+ }];
203
+ });
204
+ }
205
+ export async function importRemoteOpenApi(url, directory, options = {}) {
206
+ const entry = checkedUrl(url).href;
207
+ const output = path.resolve(directory);
208
+ try {
209
+ await lstat(output);
210
+ throw new Error(`Import output already exists: ${output}`);
211
+ }
212
+ catch (error) {
213
+ if (error.code !== 'ENOENT')
214
+ throw error;
215
+ }
216
+ await mkdir(path.dirname(output), { recursive: true });
217
+ const candidate = await mkdtemp(path.join(path.dirname(output), '.shoalrun-import-'));
218
+ try {
219
+ const lock = await snapshot(entry, candidate, options.download ?? downloadPublic);
220
+ await rename(candidate, output);
221
+ return { status: 'imported', directory: output, entry: lock.entry, files: lock.files, changes: changes(undefined, lock) };
222
+ }
223
+ catch (error) {
224
+ await rm(candidate, { recursive: true, force: true });
225
+ throw error;
226
+ }
227
+ }
228
+ export async function refreshRemoteOpenApi(directory, options = {}) {
229
+ const output = path.resolve(directory);
230
+ if (!(await lstat(output)).isDirectory())
231
+ throw new Error(`Snapshot must be a directory: ${output}`);
232
+ const previous = JSON.parse(await readFile(path.join(output, 'source-lock.json'), 'utf8'));
233
+ if (previous.version !== 1 || !Array.isArray(previous.files) || previous.files.some(file => typeof file.path !== 'string' || typeof file.snapshotDigest !== 'string' ||
234
+ (file.path !== 'openapi.yaml' && !/^refs\/[0-9a-f]{64}\.yaml$/.test(file.path))))
235
+ throw new Error(`Invalid source-lock.json in ${output}`);
236
+ for (const file of previous.files) {
237
+ if (!(await lstat(path.join(output, file.path))).isFile())
238
+ throw new Error(`Snapshot file is not a regular file: ${file.path}`);
239
+ const actual = hash(await readFile(path.join(output, file.path)));
240
+ if (actual !== file.snapshotDigest)
241
+ throw new Error(`Local OpenAPI snapshot changed since import: ${file.path}`);
242
+ }
243
+ const entry = checkedUrl(previous.entry).href;
244
+ const candidate = await mkdtemp(path.join(path.dirname(output), '.shoalrun-import-'));
245
+ try {
246
+ const lock = await snapshot(entry, candidate, options.download ?? downloadPublic);
247
+ const changed = changes(previous, lock);
248
+ if (!changed.length) {
249
+ await rm(candidate, { recursive: true, force: true });
250
+ return { status: 'unchanged', directory: output, entry, files: lock.files, changes: changed };
251
+ }
252
+ const nextOutput = path.resolve(options.output ?? `${output}-refresh-${hash(JSON.stringify(lock)).slice(0, 12)}`);
253
+ const relative = path.relative(output, nextOutput);
254
+ if (nextOutput === output || (relative !== '..' && !relative.startsWith(`..${path.sep}`) && !path.isAbsolute(relative))) {
255
+ throw new Error(`Refresh output must be outside the current snapshot: ${nextOutput}`);
256
+ }
257
+ let existingOutput = false;
258
+ try {
259
+ existingOutput = (await lstat(nextOutput)).isDirectory();
260
+ }
261
+ catch (error) {
262
+ if (error.code !== 'ENOENT')
263
+ throw error;
264
+ }
265
+ if (existingOutput) {
266
+ const existing = JSON.parse(await readFile(path.join(nextOutput, 'source-lock.json'), 'utf8'));
267
+ if (JSON.stringify(existing) !== JSON.stringify(lock))
268
+ throw new Error(`Refresh output already exists with different content: ${nextOutput}`);
269
+ for (const file of existing.files)
270
+ if (!(await lstat(path.join(nextOutput, file.path))).isFile() || hash(await readFile(path.join(nextOutput, file.path))) !== file.snapshotDigest) {
271
+ throw new Error(`Refresh output already exists with changed content: ${nextOutput}`);
272
+ }
273
+ await rm(candidate, { recursive: true, force: true });
274
+ return { status: 'updated', directory: nextOutput, previousDirectory: output, entry, files: lock.files, changes: changed };
275
+ }
276
+ try {
277
+ await lstat(nextOutput);
278
+ throw new Error(`Refresh output already exists: ${nextOutput}`);
279
+ }
280
+ catch (error) {
281
+ if (error.code !== 'ENOENT')
282
+ throw error;
283
+ }
284
+ await mkdir(path.dirname(nextOutput), { recursive: true });
285
+ await rename(candidate, nextOutput);
286
+ return { status: 'updated', directory: nextOutput, previousDirectory: output, entry, files: lock.files, changes: changed };
287
+ }
288
+ catch (error) {
289
+ await rm(candidate, { recursive: true, force: true });
290
+ throw error;
291
+ }
292
+ }
@@ -0,0 +1,3 @@
1
+ export declare function publicTree(tree: any, representation: 'html' | 'markdown', documentRoutes: Set<string>, mode?: 'light' | 'dark' | 'system', basePath?: string): any;
2
+ export declare function outputUrl(value: string, pageRoute: string, origin: string | undefined, representation: 'html' | 'markdown', documentRoutes: Set<string>, basePath?: string): string;
3
+ export declare function resolveOutputLinks(tree: any, pageRoute: string, origin: string | undefined, representation: 'html' | 'markdown', documentRoutes: Set<string>, basePath?: string): any;
@@ -0,0 +1,320 @@
1
+ import { createHash } from 'node:crypto';
2
+ import katex from 'katex';
3
+ import { badgeIcon, treeIcon } from './icons.js';
4
+ import { heading, link, list, markdownRoute, paragraph, text } from './content.js';
5
+ import { walkthroughHtml, walkthroughMarkdown } from './walkthrough.js';
6
+ import { procedureTree } from './procedure-components.js';
7
+ import { readerViewParam } from './reader-filters.js';
8
+ import { paletteCatalog, presetCatalog } from './palettes.js';
9
+ import { diagramSvg } from './diagram-svg.js';
10
+ export function publicTree(tree, representation, documentRoutes, mode = 'light', basePath = '') {
11
+ let diagramIndex = 0;
12
+ const element = (name, properties, children) => ({ type: 'paragraph', data: { hName: name, hProperties: properties }, children });
13
+ const walk = (node) => {
14
+ if (node.type === 'docComponent') {
15
+ const children = node.children.flatMap(walk);
16
+ if (representation === 'markdown')
17
+ return children;
18
+ return [element('section', { 'data-shoalrun-component': node.name, 'data-component-data': JSON.stringify(node.componentData), 'data-component-module': `${basePath}${node.browser.moduleUrl}`, 'data-component-styles': JSON.stringify(node.browser.styleUrls.map((url) => `${basePath}${url}`)) }, [
19
+ element('div', { 'data-component-controls': '', hidden: true }, []),
20
+ element('div', { 'data-component-content': '' }, children)
21
+ ])];
22
+ }
23
+ if (node.type === 'docRepresentation')
24
+ return node.representation === representation ? node.children.flatMap(walk) : [];
25
+ if (node.type === 'docCookbookChooser') {
26
+ const prompt = node.mode === 'single' ? 'Choose one recipe.' : 'Choose one or more recipes.';
27
+ const details = (option) => [option.when ? `Use when: ${option.when}` : option.summary, option.needs ? `You need: ${option.needs}` : '', option.outcome ? `You will have: ${option.outcome}` : ''].filter(Boolean);
28
+ if (representation === 'markdown')
29
+ return [
30
+ paragraph(text(`${node.title}. ${prompt}`)),
31
+ list(node.options.map((option) => [paragraph(link(option.markdownRoute, `${option.label} — ${option.title}`)), ...details(option).map((value) => paragraph(text(value)))]))
32
+ ];
33
+ return [element('section', { className: ['cookbook-chooser'], 'data-cookbook-chooser': JSON.stringify({ options: node.options, id: node.id, mode: node.mode, title: node.title }) }, [
34
+ element('div', { className: ['cookbook-chooser-controls'], hidden: true }, [
35
+ element('fieldset', {}, [element('legend', {}, [text(node.title)]), ...node.options.map((option) => element('label', { className: ['cookbook-option'] }, [
36
+ element('input', { type: node.mode === 'single' ? 'radio' : 'checkbox', value: option.id }, []),
37
+ element('span', {}, [element('strong', {}, [text(option.label)]), ...details(option).map((value) => element('span', { className: ['cookbook-option-detail'] }, [text(value)]))])
38
+ ]))]),
39
+ element('p', { className: ['cookbook-chooser-status'], role: 'status', 'aria-live': 'polite' }, [text(prompt)]),
40
+ element('div', { className: ['cookbook-path-actions'], hidden: true }, [
41
+ element('a', { className: ['cookbook-share'], href: '#' }, [text('Link to this path')]),
42
+ element('button', { type: 'button', className: ['cookbook-download'] }, [text('Download Markdown')]),
43
+ element('button', { type: 'button', className: ['cookbook-print'] }, [text('Print this path')])
44
+ ]),
45
+ element('div', { className: ['cookbook-chooser-result'] }, [])
46
+ ]),
47
+ element('div', { className: ['cookbook-chooser-approved'] }, [
48
+ element('p', {}, [text('Recipes in this cookbook:')]),
49
+ element('ul', {}, node.options.map((option) => element('li', {}, [element('a', { href: option.route }, [text(`${option.label} — ${option.title}`)])])))
50
+ ])
51
+ ])];
52
+ }
53
+ if (node.type === 'docReaderSection') {
54
+ const children = node.children.flatMap(walk);
55
+ return representation === 'markdown' ? [paragraph({ type: 'strong', children: [text(`For ${node.description}.`)] }), ...children]
56
+ : [element('section', { className: ['reader-section'], 'data-reader-filters': JSON.stringify(node.selection) }, children)];
57
+ }
58
+ if (node.type === 'docReaderChoice') {
59
+ if (representation === 'markdown') {
60
+ const choice = link(`${node.route}?${node.scope === 'page' ? 'pageView' : 'view'}=${encodeURIComponent(readerViewParam(node.selection))}`, node.label);
61
+ choice.data = { htmlDestination: true };
62
+ return [paragraph(choice)];
63
+ }
64
+ return [element('button', { type: 'button', className: ['reader-choice'], 'data-reader-choice': JSON.stringify(node.selection), 'data-reader-scope': node.scope }, [text(node.label)])];
65
+ }
66
+ if (node.type === 'docReaderFilter') {
67
+ return representation === 'markdown' ? [] : [element('div', { className: ['reader-filter-slot'], 'data-reader-filter': JSON.stringify(node.control) }, [])];
68
+ }
69
+ if (node.type === 'docTable') {
70
+ const table = node.children.flatMap(walk);
71
+ if (representation === 'markdown')
72
+ return table;
73
+ const filter = node.filter ? element('div', { className: ['doc-table-filter'], hidden: true }, [
74
+ element('label', {}, [text('Filter rows'), element('input', { type: 'search', placeholder: 'Search table rows' }, [])]),
75
+ element('span', { className: ['doc-table-count'], role: 'status', 'aria-live': 'polite' }, [])
76
+ ]) : null;
77
+ return [element('div', { className: ['doc-table'], ...(node.filter ? { 'data-table-filter': '' } : {}) }, [
78
+ ...(filter ? [filter] : []),
79
+ element('div', { className: ['doc-table-scroll', ...(node.sticky ? ['doc-table-sticky'] : [])], ...(node.sticky ? { tabIndex: 0 } : {}) }, table)
80
+ ])];
81
+ }
82
+ if (node.type === 'docBadge') {
83
+ if (representation === 'markdown')
84
+ return [text(node.label)];
85
+ return [element('span', { className: ['doc-badge', `doc-badge-${node.variant}`] }, [...(node.icon ? [badgeIcon(node.icon)] : []), text(node.label)])];
86
+ }
87
+ if (node.type === 'docKbd')
88
+ return representation === 'markdown' ? [text(node.label)] : [element('kbd', { className: ['doc-kbd'] }, [text(node.label)])];
89
+ if (node.type === 'docInfoHint') {
90
+ if (representation === 'markdown')
91
+ return [paragraph(text(`${node.label}: ${node.definition}`))];
92
+ return [element('details', { className: ['doc-info-hint'] }, [element('summary', {}, [text(node.label)]), element('p', {}, [text(node.definition)])])];
93
+ }
94
+ if (node.type === 'docTooltip') {
95
+ if (representation === 'markdown')
96
+ return [node.inline ? text(`${node.label} (${node.definition})`) : paragraph(text(`${node.label}: ${node.definition}`))];
97
+ const tooltip = element('span', { className: ['doc-tooltip'], 'data-tooltip': '' }, [
98
+ element('span', { className: ['doc-tooltip-trigger'] }, [text(node.label)]),
99
+ element('span', { className: ['doc-tooltip-separator'] }, [text(': ')]),
100
+ element('span', { className: ['doc-tooltip-popup'] }, [text(node.definition)])
101
+ ]);
102
+ return [node.inline ? tooltip : paragraph(tooltip)];
103
+ }
104
+ if (node.type === 'docProgress') {
105
+ const summary = `${node.label}: ${node.value} of ${node.max} complete`;
106
+ if (representation === 'markdown')
107
+ return [paragraph(text(`${summary}.`))];
108
+ return [element('div', { className: ['doc-progress'] }, [element('p', { className: ['doc-progress-label'] }, [text(summary)]), element('progress', { value: node.value, max: node.max, 'aria-label': node.label }, [text(`${node.value} of ${node.max}`)])])];
109
+ }
110
+ if (node.type === 'docMath') {
111
+ if (representation === 'markdown') {
112
+ const math = node.display ? { type: 'code', lang: 'latex', value: node.expression } : { type: 'inlineCode', value: node.expression };
113
+ return [node.block && !node.display ? paragraph(math) : math];
114
+ }
115
+ const marker = `SHOALRUNMATH${createHash('sha256').update(`${node.display}|${node.expression}`).digest('hex').slice(0, 24)}`;
116
+ const markup = katex.renderToString(node.expression, { output: 'mathml', displayMode: node.display, throwOnError: true, strict: 'error', trust: false, maxExpand: 1000 });
117
+ const math = element(node.display ? 'div' : 'span', { className: [node.display ? 'doc-math-display' : 'doc-math-inline'] }, [{ type: 'text', value: marker, data: { mathMarkup: markup } }]);
118
+ return [node.block && !node.display ? paragraph(math) : math];
119
+ }
120
+ if (node.type === 'docActionLink') {
121
+ const children = node.children.flatMap(walk);
122
+ const url = representation === 'markdown' && documentRoutes.has(node.url) ? markdownRoute(node.url, basePath) : node.url;
123
+ return [{ type: 'link', url, children, ...(representation === 'html' ? { data: { hProperties: { className: ['doc-action-link', `doc-action-${node.variant}`] } } } : {}) }];
124
+ }
125
+ if (node.type === 'docDefinitionList') {
126
+ if (representation === 'markdown') {
127
+ const inline = new Set(['text', 'strong', 'emphasis', 'inlineCode', 'link', 'delete', 'image', 'break']);
128
+ const blocks = (children) => {
129
+ const result = [];
130
+ let pending = [];
131
+ const flush = () => { if (pending.length)
132
+ result.push(paragraph(...pending)); pending = []; };
133
+ for (const child of children) {
134
+ if (inline.has(child.type))
135
+ pending.push(child);
136
+ else {
137
+ flush();
138
+ result.push(child);
139
+ }
140
+ }
141
+ flush();
142
+ return result;
143
+ };
144
+ return [{ type: 'list', ordered: false, spread: true, children: node.items.map((item) => ({ type: 'listItem', spread: true, children: [
145
+ paragraph({ type: 'strong', children: item.term.flatMap(walk).flatMap((term) => term.type === 'paragraph' ? term.children : [term]) }),
146
+ ...blocks(item.definition.flatMap(walk))
147
+ ] })) }];
148
+ }
149
+ const list = element('dl', { className: ['doc-definition-list'] }, node.items.flatMap((item) => [
150
+ element('dt', {}, item.term.flatMap(walk).flatMap((term) => term.type === 'paragraph' ? term.children : [term])),
151
+ element('dd', {}, item.definition.flatMap(walk))
152
+ ]));
153
+ if (!node.filter)
154
+ return [list];
155
+ const controls = element('div', { className: ['doc-definition-filter'], hidden: true }, [
156
+ element('label', {}, [text('Filter terms and definitions'), element('input', { type: 'search', placeholder: 'Search glossary' }, [])]),
157
+ element('span', { className: ['doc-definition-count'], role: 'status', 'aria-live': 'polite' }, [])
158
+ ]);
159
+ return [element('div', { className: ['doc-definition-list-wrap'], 'data-definition-filter': '' }, [controls, list])];
160
+ }
161
+ if (node.type === 'docFileTree') {
162
+ const item = (entry) => {
163
+ const url = entry.url && representation === 'markdown' && documentRoutes.has(entry.url) ? markdownRoute(entry.url, basePath) : entry.url;
164
+ const label = url ? link(url, entry.name) : text(entry.name);
165
+ const children = entry.children.map(item);
166
+ if (representation === 'markdown')
167
+ return { type: 'listItem', spread: !!children.length, children: [paragraph(label), ...(children.length ? [{ type: 'list', ordered: false, children }] : [])] };
168
+ const icons = entry.kind === 'folder' && (!entry.icon || entry.icon === 'folder')
169
+ ? [element('span', { className: ['tree-folder-closed'] }, [treeIcon('folder')]), element('span', { className: ['tree-folder-open'] }, [treeIcon('folder-open')])]
170
+ : [treeIcon(entry.icon || 'file')];
171
+ const caption = element('span', { className: ['file-tree-label'] }, [
172
+ ...icons,
173
+ ...(url ? [{ type: 'link', url, children: [text(entry.name)] }] : [text(entry.name)])
174
+ ]);
175
+ return element('li', { className: [entry.kind === 'folder' ? 'file-tree-folder' : 'file-tree-file'] }, entry.kind === 'folder' ? [element('details', { className: ['file-tree-branch'], ...(!entry.collapsed ? { open: true } : {}) }, [element('summary', {}, [caption]), ...(children.length ? [element('ul', {}, children)] : [])])] : [caption]);
176
+ };
177
+ const items = node.items.map(item);
178
+ return representation === 'markdown' ? [{ type: 'list', ordered: false, children: items }] : [element('div', { className: ['doc-file-tree'], 'data-file-tree': '' }, [...(node.controls ? [element('div', { className: ['file-tree-controls'], hidden: true }, [element('button', { type: 'button', 'data-tree-expand': '' }, [text('Expand all')]), element('button', { type: 'button', 'data-tree-collapse': '' }, [text('Collapse all')])])] : []), element('ul', {}, items)])];
179
+ }
180
+ if (node.type === 'docSteps' || node.type === 'docTimeline')
181
+ return procedureTree(node, representation, walk, element, text, paragraph);
182
+ if (representation === 'markdown' && node.data?.htmlOnly)
183
+ return [];
184
+ if (representation === 'html' && (node.data?.exampleOnly || node.data?.markdownOnly))
185
+ return [];
186
+ if (node.type === 'docDiagram') {
187
+ if (representation === 'markdown')
188
+ return [
189
+ paragraph({ type: 'strong', children: [text(node.title)] }),
190
+ paragraph(text(node.summary)),
191
+ paragraph(link(node.url, `View ${node.title} diagram`)),
192
+ { type: 'code', lang: node.engine, value: node.source }
193
+ ];
194
+ if (node.diagramSvg) {
195
+ const visual = element('div', { className: ['doc-diagram-visual'] }, []);
196
+ Object.assign(visual.data, { hChildren: [diagramSvg(node.diagramSvg, node.title, `diagram-instance-${++diagramIndex}`)] });
197
+ return [element('figure', { className: ['doc-diagram'], 'data-renderer': 'pele', ...(node.width ? { style: `max-width:${node.width}px` } : {}) }, [
198
+ visual,
199
+ element('figcaption', {}, [{ type: 'strong', children: [text(node.title)] }, text(` — ${node.summary}`)])
200
+ ])];
201
+ }
202
+ return [element('figure', { className: ['doc-diagram'], 'data-color-mode': mode, ...(node.width ? { style: `max-width:${node.width}px` } : {}) }, [
203
+ { type: 'image', url: node.url, alt: node.title, data: { hProperties: { className: ['diagram-light'] } } },
204
+ { type: 'image', url: node.darkUrl, alt: node.title, data: { hProperties: { className: ['diagram-dark'] } } },
205
+ element('figcaption', {}, [{ type: 'strong', children: [text(node.title)] }, text(` — ${node.summary}`)])
206
+ ])];
207
+ }
208
+ // Images are phrasing nodes; keep standalone images inside a block so
209
+ // Markdown serialization retains the separators between surrounding blocks.
210
+ if (node.type === 'docImage') {
211
+ const image = { type: 'image', url: node.url, alt: node.alt, ...(representation === 'html' ? { data: { hProperties: { className: ['doc-image', ...(node.align ? [`doc-image-align-${node.align}`] : [])], ...(node.width ? { style: `width:100%;max-width:${node.width}px` } : {}) } } } : {}) };
212
+ if (representation === 'markdown')
213
+ return [paragraph(image), ...(node.caption ? [paragraph(text(node.caption))] : []), ...(node.expand ? [paragraph(link(node.url, 'View original image'))] : [])];
214
+ if (!node.expand && !node.caption)
215
+ return [paragraph(image)];
216
+ const visual = node.expand ? { type: 'link', url: node.url, data: { hProperties: { 'data-image-expand': '', 'aria-label': `Enlarge image: ${node.alt || 'Image'}` } }, children: [image] } : image;
217
+ return [element('figure', { className: ['doc-image-figure', ...(node.align ? [`doc-image-align-${node.align}`] : [])], ...(node.width ? { style: `max-width:${node.width}px` } : {}) }, [paragraph(visual), ...(node.caption ? [element('figcaption', {}, [text(node.caption)])] : [])])];
218
+ }
219
+ if (node.type === 'themePreview') {
220
+ const cell = (value, asCode) => ({ type: 'tableCell', children: [asCode ? { type: 'inlineCode', value } : text(value)] });
221
+ const row = (values, codeColumns) => ({ type: 'tableRow', children: values.map((value, column) => cell(value, codeColumns.includes(column))) });
222
+ const table = (head, rows, codeColumns) => ({ type: 'table', align: head.map(() => null), children: [row(head, []), ...rows.map(values => row(values, codeColumns))] });
223
+ const fallback = [
224
+ paragraph(text('Every preset works with every palette, in light or dark mode.')),
225
+ table(['Preset', 'Shape', 'Default palette'], presetCatalog.map(preset => [preset.name, preset.shape, preset.palette]), [0, 2]),
226
+ table(['Palette', 'Colors'], paletteCatalog.map(palette => [palette.name, palette.colors]), [0]),
227
+ { type: 'code', lang: 'yaml', meta: 'title="docs.config.yaml"', value: 'theme:\n preset: vice\n palette: harbor\n mode: system' }
228
+ ];
229
+ if (representation === 'markdown')
230
+ return fallback;
231
+ return [element('div', { className: ['theme-preview'], 'data-theme-preview': JSON.stringify({ presets: presetCatalog.map(({ name, palette, masthead }) => ({ name, palette, masthead })), palettes: paletteCatalog.map(palette => palette.name) }) }, [fallback[0], element('details', { className: ['theme-preview-catalog'] }, [element('summary', {}, [text('Browse themes and palettes')]), ...fallback.slice(1)])])];
232
+ }
233
+ if (node.type === 'docHero') {
234
+ const links = node.links.map((item) => item.children ? { ...item, children: item.children.flatMap(walk) } : item);
235
+ if (representation === 'markdown')
236
+ return [
237
+ ...(node.customTitle ? [paragraph({ type: 'strong', children: [text(node.title)] })] : []),
238
+ paragraph(text(node.tagline)),
239
+ ...(links.length ? [{ type: 'list', ordered: false, spread: false, children: links.map((item) => ({ type: 'listItem', spread: false, children: [paragraph(...walk(item))] })) }] : []),
240
+ ...(node.image && node.image.alt ? [paragraph({ type: 'image', url: node.image.url, alt: node.image.alt })] : []),
241
+ ...(node.code ? [node.code] : [])
242
+ ];
243
+ // With an image or code block the hero becomes two columns: text, then the visual.
244
+ const visual = node.image
245
+ ? [element('div', { className: ['hero-visual'] }, [{ type: 'image', url: node.image.url, alt: node.image.alt, data: { hProperties: { loading: 'eager', decoding: 'async' } } }])]
246
+ : node.code ? [element('div', { className: ['hero-visual', 'hero-visual-code'] }, [node.code])] : [];
247
+ const copy = [
248
+ element('h1', { className: ['hero-title'] }, [text(node.title)]),
249
+ element('p', { className: ['hero-tagline'] }, [text(node.tagline)]),
250
+ ...(links.length ? [element('div', { className: ['hero-actions'] }, links.map((item, index) => ({ ...item, data: { hProperties: { className: ['hero-action', index ? 'hero-secondary' : 'hero-primary'] } } })))] : [])
251
+ ];
252
+ return [element('section', { className: ['hero', ...(visual.length ? ['has-visual'] : [])], 'data-hero': '', ...(node.align === 'start' || visual.length ? { 'data-align': 'start' } : {}) }, visual.length ? [element('div', { className: ['hero-copy'] }, copy), ...visual] : copy)];
253
+ }
254
+ if (node.type === 'docSection') {
255
+ const children = node.children.flatMap(walk);
256
+ if (representation === 'markdown')
257
+ return children;
258
+ return [element('section', { className: ['splash-section'], ...(node.variant ? { 'data-variant': node.variant } : {}), ...(node.sectionId ? { id: node.sectionId } : {}) }, [element('div', { className: ['splash-inner'] }, children)])];
259
+ }
260
+ if (node.type === 'docCollapsibleGroup') {
261
+ const children = node.children.flatMap(walk);
262
+ return representation === 'markdown' ? children : [element('div', { className: ['doc-collapsible-group'] }, children)];
263
+ }
264
+ if (node.type === 'docCollapsible') {
265
+ const children = node.children.flatMap(walk);
266
+ if (representation === 'markdown')
267
+ return [heading(3, node.title), ...children];
268
+ return [element('details', { className: ['doc-collapsible'], ...(node.open ? { open: true } : {}) }, [element('summary', {}, [text(node.title)]), element('div', { className: ['collapsible-body'] }, children)])];
269
+ }
270
+ if (node.type === 'docWalkthrough')
271
+ return representation === 'markdown' ? walkthroughMarkdown(node, walk, { heading, paragraph, text }) : walkthroughHtml(node, walk, element, text);
272
+ if (node.type === 'docTabs') {
273
+ if (representation === 'markdown')
274
+ return node.children.flatMap((tab) => [heading(3, tab.label), ...tab.children.flatMap(walk)]);
275
+ const links = node.children.map((tab, index) => ({ ...link(`#${node.id}-panel-${index + 1}`, tab.label), data: { hProperties: { 'data-tab-value': tab.value } } }));
276
+ const panels = node.children.map((tab, index) => element('section', { id: `${node.id}-panel-${index + 1}`, className: ['doc-tabpanel'] }, [
277
+ { ...heading(3, tab.label), data: { hProperties: { className: ['tab-fallback-heading'] } } },
278
+ ...tab.children.flatMap(walk)
279
+ ]));
280
+ return [element('div', { className: ['doc-tabs'], 'data-tabs': '', ...(node.sync ? { 'data-tab-sync': node.sync } : {}), ...(node.equalHeight ? { 'data-equal-height': '' } : {}) }, [element('div', { className: ['doc-tablist'], 'aria-label': node.label }, links), ...panels])];
281
+ }
282
+ if (node.type === 'link' && documentRoutes.has(node.url) && representation === 'markdown')
283
+ return [{ ...node, url: markdownRoute(node.url, basePath), children: node.children.flatMap(walk) }];
284
+ if (node.children)
285
+ return [{ ...node, children: node.children.flatMap(walk) }];
286
+ return [node];
287
+ };
288
+ return walk(tree)[0];
289
+ }
290
+ // Resolve authored links against the published page route, then use the public
291
+ // origin when one is configured. Keep fragment-only links local to the page.
292
+ export function outputUrl(value, pageRoute, origin, representation, documentRoutes, basePath = '') {
293
+ if (!value || value.startsWith('#') || /^(?:[a-z][a-z\d+.-]*:|\/\/)/i.test(value))
294
+ return value;
295
+ const target = new URL(value, `https://shoalrun.invalid${basePath && pageRoute === basePath ? `${pageRoute}/` : pageRoute}`);
296
+ if (basePath && value.startsWith('/') && target.pathname !== basePath && !target.pathname.startsWith(`${basePath}/`))
297
+ target.pathname = `${basePath}${target.pathname}`;
298
+ if (representation === 'markdown' && documentRoutes.has(target.pathname))
299
+ target.pathname = markdownRoute(target.pathname, basePath);
300
+ return `${origin ?? ''}${target.pathname}${target.search}${target.hash}`;
301
+ }
302
+ export function resolveOutputLinks(tree, pageRoute, origin, representation, documentRoutes, basePath = '') {
303
+ const walk = (node) => {
304
+ const resolved = { ...node };
305
+ if (['link', 'image', 'definition'].includes(node.type) && typeof node.url === 'string')
306
+ resolved.url = outputUrl(node.url, pageRoute, node.type === 'image' && representation === 'html' ? undefined : origin, node.data?.htmlDestination ? 'html' : representation, documentRoutes, basePath);
307
+ if (node.data?.hProperties) {
308
+ const properties = { ...node.data.hProperties };
309
+ for (const key of ['href', 'src'])
310
+ if (typeof properties[key] === 'string')
311
+ properties[key] = outputUrl(properties[key], pageRoute, key === 'src' && representation === 'html' ? undefined : origin, node.data?.htmlDestination ? 'html' : representation, documentRoutes, basePath);
312
+ resolved.data = { ...node.data, hProperties: properties };
313
+ }
314
+ if (node.children)
315
+ resolved.children = node.children.map(walk);
316
+ return resolved;
317
+ };
318
+ return walk(tree);
319
+ }
320
+ // Search runs in the reader's browser. The framework owns the header box; a provider module owns retrieval.