@shoalrun/cli 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (406) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/CODE-REFERENCES.md +19 -0
  3. package/README.md +13 -4
  4. package/adapters/typescript/README.md +27 -0
  5. package/adapters/typescript/shoalrun-reference.mjs +260 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +3 -1
  7. package/agent-docs/SNAPSHOT.json +5 -5
  8. package/agent-docs/api-docs/code-reference-settings.md +2 -2
  9. package/agent-docs/api-docs/code-reference-settings.sections/catalog-settings.md +2 -2
  10. package/agent-docs/api-docs/code-reference-settings.sections/complete-reference-page.md +2 -2
  11. package/agent-docs/api-docs/code-reference-settings.sections/converter-snapshot.md +2 -2
  12. package/agent-docs/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md +2 -2
  13. package/agent-docs/api-docs/code-reference-settings.sections/html-markdown-and-agents.md +2 -2
  14. package/agent-docs/api-docs/code-reference-settings.sections/metadata-and-selection.md +2 -2
  15. package/agent-docs/api-docs/code-reference-settings.sections/publication-sources.md +2 -2
  16. package/agent-docs/api-docs/code-reference-settings.sections/python-adapter-limits.md +2 -2
  17. package/agent-docs/api-docs/code-reference-settings.sections/related-reading.md +2 -2
  18. package/agent-docs/api-docs/code-reference-settings.sections/symbol-fields.md +2 -2
  19. package/agent-docs/api-docs/code-references.md +9 -1
  20. package/agent-docs/api-docs/code-references.sections/a-real-typescript-example.md +38 -0
  21. package/agent-docs/api-docs/code-references.sections/add-python-source.md +56 -0
  22. package/agent-docs/api-docs/code-references.sections/before-you-start.md +40 -0
  23. package/agent-docs/api-docs/code-references.sections/build-and-verify.md +47 -0
  24. package/agent-docs/api-docs/code-references.sections/choose-the-reading-layout.md +46 -0
  25. package/agent-docs/api-docs/code-references.sections/extract-and-validate-a-snapshot.md +52 -0
  26. package/agent-docs/api-docs/code-references.sections/html-markdown-and-agents.md +42 -0
  27. package/agent-docs/api-docs/code-references.sections/register-the-catalog-and-navigation.md +58 -0
  28. package/agent-docs/api-docs/code-references.sections/related-reading.md +40 -0
  29. package/agent-docs/api-docs/code-references.sections/versions-profiles-and-delivery.md +40 -0
  30. package/agent-docs/api-docs/typescript-references.md +93 -0
  31. package/agent-docs/author/components/for-facet.md +127 -0
  32. package/agent-docs/author/components/only.md +3 -1
  33. package/agent-docs/author/components.md +2 -1
  34. package/agent-docs/author/reader-views.md +2 -2
  35. package/agent-docs/author/reader-views.sections/configure-the-choices.md +2 -2
  36. package/agent-docs/author/reader-views.sections/connect-your-own-control.md +2 -2
  37. package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +2 -2
  38. package/agent-docs/author/reader-views.sections/mark-pages.md +2 -2
  39. package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +2 -2
  40. package/agent-docs/author/reader-views.sections/place-filter-controls.md +2 -2
  41. package/agent-docs/author/reader-views.sections/try-the-controls-here.md +2 -2
  42. package/agent-docs/changelog/facet-typescript.md +54 -0
  43. package/agent-docs/changelog.md +8 -0
  44. package/agent-docs/config/examples.md +2 -2
  45. package/agent-docs/config/examples.sections/feature-showcase.md +2 -2
  46. package/agent-docs/config/examples.sections/minimal-site.md +1 -1
  47. package/agent-docs/config/examples.sections/multilingual-help-center.md +1 -1
  48. package/agent-docs/config/examples.sections/parcel-api-documentation.md +1 -1
  49. package/agent-docs/config/examples.sections/related-reading.md +1 -1
  50. package/agent-docs/config/examples.sections/shared-company-preset.md +1 -1
  51. package/agent-docs/config/outputs.md +12 -12
  52. package/agent-docs/config/outputs.sections/exports.md +12 -12
  53. package/agent-docs/config/outputs.sections/metadata.md +1 -1
  54. package/agent-docs/config/outputs.sections/pdf-output.md +1 -1
  55. package/agent-docs/config/outputs.sections/related-reading.md +1 -1
  56. package/agent-docs/config/site.md +17 -17
  57. package/agent-docs/config/site.sections/related-reading.md +1 -1
  58. package/agent-docs/config/site.sections/theme.md +1 -1
  59. package/agent-docs/configuration.md +1 -1
  60. package/agent-docs/configuration.sections/start-with-one-working-file.md +1 -1
  61. package/agent-docs/content-delivery/api.md +10 -2
  62. package/agent-docs/content-delivery/api.sections/errors.md +52 -0
  63. package/agent-docs/content-delivery/api.sections/generated-typescript-reference.md +36 -0
  64. package/agent-docs/content-delivery/api.sections/html-markdown-and-agents.md +36 -0
  65. package/agent-docs/content-delivery/api.sections/mount-html.md +42 -0
  66. package/agent-docs/content-delivery/api.sections/open-a-rest-source.md +55 -0
  67. package/agent-docs/content-delivery/api.sections/open-a-source.md +51 -0
  68. package/agent-docs/content-delivery/api.sections/read-a-snapshot.md +55 -0
  69. package/agent-docs/content-delivery/api.sections/related-reading.md +42 -0
  70. package/agent-docs/content-delivery/api.sections/validate-a-manifest.md +40 -0
  71. package/agent-docs/content-delivery/client.md +9 -1
  72. package/agent-docs/content-delivery/sdk/all.md +1772 -0
  73. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-exportedid.md +34 -0
  74. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-id.md +34 -0
  75. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-title.md +34 -0
  76. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor.md +44 -0
  77. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset-mediatype.md +34 -0
  78. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset.md +40 -0
  79. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror-code.md +34 -0
  80. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror.md +46 -0
  81. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-manifestbytes.md +36 -0
  82. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resourcebytes.md +36 -0
  83. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resources.md +36 -0
  84. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits.md +44 -0
  85. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contenterrorcode.md +32 -0
  86. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-bytes.md +34 -0
  87. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-digest.md +34 -0
  88. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-path.md +34 -0
  89. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile.md +44 -0
  90. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentformat.md +32 -0
  91. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-asset.md +34 -0
  92. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-fragment.md +34 -0
  93. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-href.md +34 -0
  94. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-key.md +34 -0
  95. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-kind.md +34 -0
  96. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-query.md +34 -0
  97. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-ref.md +34 -0
  98. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink.md +52 -0
  99. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-assets.md +34 -0
  100. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-diagnostics.md +34 -0
  101. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-digest.md +34 -0
  102. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-files.md +34 -0
  103. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-kind.md +34 -0
  104. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publication.md +34 -0
  105. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publicbase.md +34 -0
  106. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-resources.md +34 -0
  107. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-review.md +34 -0
  108. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-schemaversion.md +34 -0
  109. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest.md +68 -0
  110. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-anchors.md +36 -0
  111. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-links.md +36 -0
  112. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-unmount.md +36 -0
  113. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount.md +49 -0
  114. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-channel.md +34 -0
  115. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-language.md +34 -0
  116. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-product.md +34 -0
  117. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-version.md +34 -0
  118. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication.md +46 -0
  119. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentref.md +43 -0
  120. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrefkey.md +42 -0
  121. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-anchors.md +34 -0
  122. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-links.md +34 -0
  123. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation.md +42 -0
  124. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-assets.md +34 -0
  125. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-canonicalurl.md +34 -0
  126. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-externaldependencies.md +34 -0
  127. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-publication.md +36 -0
  128. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-ref.md +36 -0
  129. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-representations.md +36 -0
  130. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-source.md +34 -0
  131. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-summary.md +36 -0
  132. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-title.md +36 -0
  133. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-type.md +36 -0
  134. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource.md +65 -0
  135. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresourcekey.md +42 -0
  136. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-key.md +34 -0
  137. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-resource.md +34 -0
  138. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry.md +42 -0
  139. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror-error.md +34 -0
  140. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror.md +43 -0
  141. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterrorcode.md +32 -0
  142. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-publication.md +34 -0
  143. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-resources.md +34 -0
  144. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-revision.md +34 -0
  145. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-schemaversion.md +34 -0
  146. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist.md +46 -0
  147. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-key.md +34 -0
  148. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-publication.md +34 -0
  149. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-resource.md +34 -0
  150. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-revision.md +34 -0
  151. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-schemaversion.md +34 -0
  152. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource.md +48 -0
  153. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-content.md +36 -0
  154. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-format.md +36 -0
  155. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-representation.md +36 -0
  156. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-resource.md +36 -0
  157. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-revision.md +36 -0
  158. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult.md +48 -0
  159. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-dispose.md +36 -0
  160. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-get.md +45 -0
  161. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-list.md +38 -0
  162. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-publication.md +36 -0
  163. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-revision.md +36 -0
  164. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot.md +47 -0
  165. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-fetch.md +36 -0
  166. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-limits.md +36 -0
  167. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-manifesturl.md +36 -0
  168. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-signal.md +36 -0
  169. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions.md +46 -0
  170. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-mountcontent.md +48 -0
  171. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openmanifestcontentsource.md +54 -0
  172. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openrestcontentsource.md +44 -0
  173. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-baseurl.md +36 -0
  174. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-fetch.md +36 -0
  175. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-limits.md +36 -0
  176. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-publication.md +36 -0
  177. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-revision.md +36 -0
  178. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-signal.md +36 -0
  179. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions.md +50 -0
  180. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-validatecontentmanifest.md +45 -0
  181. package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content.md +65 -0
  182. package/agent-docs/content-delivery/sdk/content-anchor/exported-id.md +25 -0
  183. package/agent-docs/content-delivery/sdk/content-anchor/id.md +25 -0
  184. package/agent-docs/content-delivery/sdk/content-anchor/title.md +25 -0
  185. package/agent-docs/content-delivery/sdk/content-anchor.md +71 -0
  186. package/agent-docs/content-delivery/sdk/content-asset/media-type.md +25 -0
  187. package/agent-docs/content-delivery/sdk/content-asset.md +43 -0
  188. package/agent-docs/content-delivery/sdk/content-delivery-error/code.md +25 -0
  189. package/agent-docs/content-delivery/sdk/content-delivery-error.md +53 -0
  190. package/agent-docs/content-delivery/sdk/content-delivery-limits/manifest-bytes.md +27 -0
  191. package/agent-docs/content-delivery/sdk/content-delivery-limits/resource-bytes.md +27 -0
  192. package/agent-docs/content-delivery/sdk/content-delivery-limits/resources.md +27 -0
  193. package/agent-docs/content-delivery/sdk/content-delivery-limits.md +77 -0
  194. package/agent-docs/content-delivery/sdk/content-error-code.md +23 -0
  195. package/agent-docs/content-delivery/sdk/content-file/bytes.md +25 -0
  196. package/agent-docs/content-delivery/sdk/content-file/digest.md +25 -0
  197. package/agent-docs/content-delivery/sdk/content-file/path.md +25 -0
  198. package/agent-docs/content-delivery/sdk/content-file.md +71 -0
  199. package/agent-docs/content-delivery/sdk/content-format.md +23 -0
  200. package/agent-docs/content-delivery/sdk/content-link/asset.md +25 -0
  201. package/agent-docs/content-delivery/sdk/content-link/fragment.md +25 -0
  202. package/agent-docs/content-delivery/sdk/content-link/href.md +25 -0
  203. package/agent-docs/content-delivery/sdk/content-link/key.md +25 -0
  204. package/agent-docs/content-delivery/sdk/content-link/kind.md +25 -0
  205. package/agent-docs/content-delivery/sdk/content-link/query.md +25 -0
  206. package/agent-docs/content-delivery/sdk/content-link/ref.md +25 -0
  207. package/agent-docs/content-delivery/sdk/content-link.md +127 -0
  208. package/agent-docs/content-delivery/sdk/content-manifest/assets.md +25 -0
  209. package/agent-docs/content-delivery/sdk/content-manifest/diagnostics.md +25 -0
  210. package/agent-docs/content-delivery/sdk/content-manifest/digest.md +25 -0
  211. package/agent-docs/content-delivery/sdk/content-manifest/files.md +25 -0
  212. package/agent-docs/content-delivery/sdk/content-manifest/kind.md +25 -0
  213. package/agent-docs/content-delivery/sdk/content-manifest/public-base.md +25 -0
  214. package/agent-docs/content-delivery/sdk/content-manifest/publication.md +25 -0
  215. package/agent-docs/content-delivery/sdk/content-manifest/resources.md +25 -0
  216. package/agent-docs/content-delivery/sdk/content-manifest/review.md +25 -0
  217. package/agent-docs/content-delivery/sdk/content-manifest/schema-version.md +25 -0
  218. package/agent-docs/content-delivery/sdk/content-manifest.md +179 -0
  219. package/agent-docs/content-delivery/sdk/content-mount/anchors.md +27 -0
  220. package/agent-docs/content-delivery/sdk/content-mount/links.md +27 -0
  221. package/agent-docs/content-delivery/sdk/content-mount/unmount.md +27 -0
  222. package/agent-docs/content-delivery/sdk/content-mount.md +82 -0
  223. package/agent-docs/content-delivery/sdk/content-publication/channel.md +25 -0
  224. package/agent-docs/content-delivery/sdk/content-publication/language.md +25 -0
  225. package/agent-docs/content-delivery/sdk/content-publication/product.md +25 -0
  226. package/agent-docs/content-delivery/sdk/content-publication/version.md +25 -0
  227. package/agent-docs/content-delivery/sdk/content-publication.md +85 -0
  228. package/agent-docs/content-delivery/sdk/content-ref-key.md +34 -0
  229. package/agent-docs/content-delivery/sdk/content-ref.md +40 -0
  230. package/agent-docs/content-delivery/sdk/content-representation/anchors.md +25 -0
  231. package/agent-docs/content-delivery/sdk/content-representation/links.md +25 -0
  232. package/agent-docs/content-delivery/sdk/content-representation.md +57 -0
  233. package/agent-docs/content-delivery/sdk/content-resource/assets.md +25 -0
  234. package/agent-docs/content-delivery/sdk/content-resource/canonical-url.md +25 -0
  235. package/agent-docs/content-delivery/sdk/content-resource/external-dependencies.md +25 -0
  236. package/agent-docs/content-delivery/sdk/content-resource/publication.md +27 -0
  237. package/agent-docs/content-delivery/sdk/content-resource/ref.md +27 -0
  238. package/agent-docs/content-delivery/sdk/content-resource/representations.md +27 -0
  239. package/agent-docs/content-delivery/sdk/content-resource/source.md +25 -0
  240. package/agent-docs/content-delivery/sdk/content-resource/summary.md +27 -0
  241. package/agent-docs/content-delivery/sdk/content-resource/title.md +27 -0
  242. package/agent-docs/content-delivery/sdk/content-resource/type.md +27 -0
  243. package/agent-docs/content-delivery/sdk/content-resource-key.md +34 -0
  244. package/agent-docs/content-delivery/sdk/content-resource.md +192 -0
  245. package/agent-docs/content-delivery/sdk/content-rest-entry/key.md +25 -0
  246. package/agent-docs/content-delivery/sdk/content-rest-entry/resource.md +25 -0
  247. package/agent-docs/content-delivery/sdk/content-rest-entry.md +57 -0
  248. package/agent-docs/content-delivery/sdk/content-rest-error/error.md +25 -0
  249. package/agent-docs/content-delivery/sdk/content-rest-error-code.md +23 -0
  250. package/agent-docs/content-delivery/sdk/content-rest-error.md +46 -0
  251. package/agent-docs/content-delivery/sdk/content-rest-list/publication.md +25 -0
  252. package/agent-docs/content-delivery/sdk/content-rest-list/resources.md +25 -0
  253. package/agent-docs/content-delivery/sdk/content-rest-list/revision.md +25 -0
  254. package/agent-docs/content-delivery/sdk/content-rest-list/schema-version.md +25 -0
  255. package/agent-docs/content-delivery/sdk/content-rest-list.md +85 -0
  256. package/agent-docs/content-delivery/sdk/content-rest-resource/key.md +25 -0
  257. package/agent-docs/content-delivery/sdk/content-rest-resource/publication.md +25 -0
  258. package/agent-docs/content-delivery/sdk/content-rest-resource/resource.md +25 -0
  259. package/agent-docs/content-delivery/sdk/content-rest-resource/revision.md +25 -0
  260. package/agent-docs/content-delivery/sdk/content-rest-resource/schema-version.md +25 -0
  261. package/agent-docs/content-delivery/sdk/content-rest-resource.md +99 -0
  262. package/agent-docs/content-delivery/sdk/content-result/content.md +27 -0
  263. package/agent-docs/content-delivery/sdk/content-result/format.md +27 -0
  264. package/agent-docs/content-delivery/sdk/content-result/representation.md +27 -0
  265. package/agent-docs/content-delivery/sdk/content-result/resource.md +27 -0
  266. package/agent-docs/content-delivery/sdk/content-result/revision.md +27 -0
  267. package/agent-docs/content-delivery/sdk/content-result.md +114 -0
  268. package/agent-docs/content-delivery/sdk/content-snapshot/dispose.md +27 -0
  269. package/agent-docs/content-delivery/sdk/content-snapshot/get.md +36 -0
  270. package/agent-docs/content-delivery/sdk/content-snapshot/list.md +29 -0
  271. package/agent-docs/content-delivery/sdk/content-snapshot/publication.md +27 -0
  272. package/agent-docs/content-delivery/sdk/content-snapshot/revision.md +27 -0
  273. package/agent-docs/content-delivery/sdk/content-snapshot.md +123 -0
  274. package/agent-docs/content-delivery/sdk/exports.md +742 -0
  275. package/agent-docs/content-delivery/sdk/exports.sections/functions.md +30 -0
  276. package/agent-docs/content-delivery/sdk/exports.sections/members.md +47 -0
  277. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentanchor.md +41 -0
  278. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentasset.md +37 -0
  279. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliveryerror.md +43 -0
  280. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliverylimits.md +41 -0
  281. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contenterrorcode.md +29 -0
  282. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentfile.md +41 -0
  283. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentformat.md +29 -0
  284. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentlink.md +49 -0
  285. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmanifest.md +65 -0
  286. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmount.md +46 -0
  287. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentpublication.md +43 -0
  288. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentref.md +40 -0
  289. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrefkey.md +39 -0
  290. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrepresentation.md +39 -0
  291. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresource.md +62 -0
  292. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresourcekey.md +39 -0
  293. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestentry.md +39 -0
  294. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterror.md +40 -0
  295. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterrorcode.md +29 -0
  296. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestlist.md +43 -0
  297. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestresource.md +45 -0
  298. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresult.md +45 -0
  299. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentsnapshot.md +44 -0
  300. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-manifestcontentsourceoptions.md +43 -0
  301. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-mountcontent.md +45 -0
  302. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openmanifestcontentsource.md +51 -0
  303. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openrestcontentsource.md +41 -0
  304. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-restcontentsourceoptions.md +47 -0
  305. package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-validatecontentmanifest.md +42 -0
  306. package/agent-docs/content-delivery/sdk/manifest-content-source-options/fetch.md +27 -0
  307. package/agent-docs/content-delivery/sdk/manifest-content-source-options/limits.md +27 -0
  308. package/agent-docs/content-delivery/sdk/manifest-content-source-options/manifest-url.md +27 -0
  309. package/agent-docs/content-delivery/sdk/manifest-content-source-options/signal.md +27 -0
  310. package/agent-docs/content-delivery/sdk/manifest-content-source-options.md +93 -0
  311. package/agent-docs/content-delivery/sdk/mount-content.md +46 -0
  312. package/agent-docs/content-delivery/sdk/open-manifest-content-source.md +51 -0
  313. package/agent-docs/content-delivery/sdk/open-rest-content-source.md +39 -0
  314. package/agent-docs/content-delivery/sdk/rest-content-source-options/base-url.md +28 -0
  315. package/agent-docs/content-delivery/sdk/rest-content-source-options/fetch.md +27 -0
  316. package/agent-docs/content-delivery/sdk/rest-content-source-options/limits.md +27 -0
  317. package/agent-docs/content-delivery/sdk/rest-content-source-options/publication.md +27 -0
  318. package/agent-docs/content-delivery/sdk/rest-content-source-options/revision.md +27 -0
  319. package/agent-docs/content-delivery/sdk/rest-content-source-options/signal.md +27 -0
  320. package/agent-docs/content-delivery/sdk/rest-content-source-options.md +125 -0
  321. package/agent-docs/content-delivery/sdk/validate-content-manifest.md +38 -0
  322. package/agent-docs/contribute/agent-skills.md +33 -6
  323. package/agent-docs/documents.json +7094 -308
  324. package/agent-docs/features.md +18 -17
  325. package/agent-docs/provenance.json +6 -6
  326. package/agent-docs/publish/content-export.md +3 -1
  327. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +1 -1
  328. package/agent-docs/publish/content-export.sections/check-the-result.md +1 -1
  329. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +1 -1
  330. package/agent-docs/publish/content-export.sections/prerequisites.md +1 -1
  331. package/agent-docs/publish/content-export.sections/related-reading.md +1 -1
  332. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +1 -1
  333. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +1 -1
  334. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +1 -1
  335. package/agent-docs/publish/pdf.md +2 -2
  336. package/agent-docs/publish/pdf.sections/apply-print-styling.md +1 -1
  337. package/agent-docs/publish/pdf.sections/check-the-result.md +1 -1
  338. package/agent-docs/publish/pdf.sections/export-a-page-or-publication.md +2 -2
  339. package/agent-docs/publish/pdf.sections/html-markdown-and-agents.md +1 -1
  340. package/agent-docs/publish/pdf.sections/offer-browser-page-printing.md +1 -1
  341. package/agent-docs/publish/pdf.sections/offer-direct-downloads-through-a-node-server.md +1 -1
  342. package/agent-docs/publish/pdf.sections/prerequisites.md +1 -1
  343. package/agent-docs/publish/pdf.sections/publish-an-optional-manual-download.md +1 -1
  344. package/agent-docs/publish/single-source-sites.md +26 -2
  345. package/agent-docs/publish/single-source-sites.sections/build-and-check-each-output.md +49 -0
  346. package/agent-docs/publish/single-source-sites.sections/html-markdown-and-agents.md +33 -0
  347. package/agent-docs/publish/single-source-sites.sections/include-additional-sections-in-a-build.md +47 -0
  348. package/agent-docs/publish/single-source-sites.sections/related-reading.md +43 -0
  349. package/agent-docs/publish/single-source-sites.sections/select-the-pages-for-each-site.md +74 -0
  350. package/agent-docs/publish/single-source-sites.sections/share-the-base-configuration.md +93 -0
  351. package/agent-docs/reference/agent-skills.md +2 -2
  352. package/agent-docs/search-index.json +1 -1
  353. package/agent-docs/start.md +1 -1
  354. package/agent-docs/start.sections/start-your-own-project.md +1 -1
  355. package/assets/search-lexical.js +15 -4
  356. package/dist/code-reference-model.d.ts +4 -4
  357. package/dist/compiler.d.ts +8 -0
  358. package/dist/compiler.js +10 -4
  359. package/dist/component-names.js +1 -1
  360. package/dist/component-transform.js +14 -22
  361. package/dist/conditional-tree.d.ts +2 -0
  362. package/dist/conditional-tree.js +14 -0
  363. package/dist/content-delivery-contract.d.ts +39 -0
  364. package/dist/content-delivery-contract.js +2 -0
  365. package/dist/content-delivery-validation.d.ts +6 -0
  366. package/dist/content-delivery-validation.js +6 -0
  367. package/dist/content-delivery.d.ts +19 -1
  368. package/dist/content-delivery.js +10 -1
  369. package/dist/content-export-command.d.ts +42 -3
  370. package/dist/content-export.d.ts +42 -3
  371. package/dist/content-export.js +15 -6
  372. package/dist/content-filter.d.ts +2 -0
  373. package/dist/content-filter.js +4 -0
  374. package/dist/content-mount.d.ts +12 -1
  375. package/dist/content-mount.js +8 -1
  376. package/dist/content-rest-client.d.ts +11 -1
  377. package/dist/content-rest-client.js +4 -1
  378. package/dist/content-rest-contract.d.ts +5 -0
  379. package/dist/content-source.d.ts +1 -0
  380. package/dist/content-workspace.d.ts +4 -1
  381. package/dist/content-workspace.js +5 -2
  382. package/dist/deployment-profile.d.ts +3 -1
  383. package/dist/deployment-profile.js +18 -19
  384. package/dist/palettes.d.ts +1 -1
  385. package/dist/publication-manifest.js +1 -1
  386. package/dist/representation-tree.js +8 -2
  387. package/dist/search-query.js +13 -6
  388. package/dist/section-selection.d.ts +29 -0
  389. package/dist/section-selection.js +92 -0
  390. package/dist/snippets.d.ts +1 -0
  391. package/example-configs/facet-sections/README.md +37 -0
  392. package/example-configs/facet-sections/base.yaml +29 -0
  393. package/example-configs/facet-sections/content/billing.mdx +25 -0
  394. package/example-configs/facet-sections/customer.config.yaml +4 -0
  395. package/example-configs/facet-sections/docs.config.yaml +3 -0
  396. package/example-configs/faceted-sites/README.md +4 -2
  397. package/package.json +2 -1
  398. package/skills/shoalrun-author/SKILL.md +13 -0
  399. package/skills/shoalrun-author/references/code-api-references.md +5 -1
  400. package/skills/shoalrun-author/references/facet-selection.md +48 -0
  401. package/skills/shoalrun-brand/SKILL.md +9 -0
  402. package/skills/shoalrun-component-author/SKILL.md +9 -0
  403. package/skills/shoalrun-pdf/SKILL.md +9 -0
  404. package/skills/shoalrun-recipes/SKILL.md +9 -0
  405. package/skills/shoalrun-setup/SKILL.md +9 -0
  406. package/skills/shoalrun-walkthrough/SKILL.md +9 -0
@@ -0,0 +1,47 @@
1
+ ---
2
+ id: reference.content-sdk.exports
3
+ title: shoalrun.content
4
+ summary: "module: shoalrun.content"
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/exports
9
+ ---
10
+
11
+ # shoalrun.content
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ Parent page: [Full Markdown page](/content-delivery/sdk/exports.md)
18
+
19
+ **Module** `shoalrun.content`
20
+
21
+ ## shoalrun.content.RestContentSourceOptions
22
+
23
+ **Type** `shoalrun.content.RestContentSourceOptions`
24
+
25
+ ```typescript
26
+ type RestContentSourceOptions = {
27
+ baseUrl: string | URL;
28
+ publication: ContentPublication;
29
+ revision?: string;
30
+ fetch?: typeof globalThis.fetch;
31
+ signal?: AbortSignal;
32
+ limits?: ContentDeliveryLimits;
33
+ };
34
+ ```
35
+
36
+ Options for a REST inventory and its revision-pinned resource reads.
37
+
38
+ ### Fields
39
+
40
+ | Name | Type | Required / default | Description |
41
+ | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------- |
42
+ | [`baseUrl`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/base-url.md) | `string \| URL` | Required | REST mount URL, such as /content/v1. Browser requests must use the application's origin. |
43
+ | [`fetch`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/fetch.md) | `((input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>) \| undefined` | Optional | Fetch implementation. Defaults to globalThis.fetch. |
44
+ | [`limits`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/limits.md) | [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentdeliverylimits)` \| undefined` | Optional | Inventory and representation bounds. |
45
+ | [`publication`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/publication.md) | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentpublication) | Required | Exact publication to request; include product for a product-scoped source. |
46
+ | [`revision`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/revision.md) | `string \| undefined` | Optional | Expected inventory revision. Omit it to open the current revision. |
47
+ | [`signal`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options/signal.md) | `AbortSignal \| undefined` | Optional | Cancel the inventory-opening request. |
@@ -0,0 +1,42 @@
1
+ ---
2
+ id: reference.content-sdk.exports
3
+ title: shoalrun.content
4
+ summary: "module: shoalrun.content"
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/exports
9
+ ---
10
+
11
+ # shoalrun.content
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ Parent page: [Full Markdown page](/content-delivery/sdk/exports.md)
18
+
19
+ **Module** `shoalrun.content`
20
+
21
+ ## shoalrun.content.validateContentManifest
22
+
23
+ **Function** `shoalrun.content.validateContentManifest`
24
+
25
+ ```typescript
26
+ validateContentManifest(value: any, maxResources?: number, maxResourceBytes?: number): asserts value is ContentManifest
27
+ ```
28
+
29
+ Validate a parsed manifest's shape, identities, paths, and resource bounds.
30
+ This assertion narrows the value but doesn't verify fetched file bytes or trust in a host.
31
+
32
+ ### Parameters
33
+
34
+ | Parameter | Type / default | Description |
35
+ | ------------------ | --------------------- | ------------------------------------------------------------- |
36
+ | `value` | `any` | Parsed JSON manifest to validate. |
37
+ | `maxResources` | `number \| undefined` | Maximum allowed resource count; defaults to 10,000. |
38
+ | `maxResourceBytes` | `number \| undefined` | Maximum declared representation bytes; defaults to 8,000,000. |
39
+
40
+ ### Returns
41
+
42
+ `void`
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.ManifestContentSourceOptions.fetch
3
+ title: fetch
4
+ summary: Fetch implementation. Defaults to globalThis.fetch.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/manifest-content-source-options/fetch
9
+ ---
10
+
11
+ # fetch
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.ManifestContentSourceOptions.fetch`
18
+
19
+ ```typescript
20
+ fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined
21
+ ```
22
+
23
+ Fetch implementation. Defaults to globalThis.fetch.
24
+
25
+ **Type:&#x20;**`((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined`
26
+
27
+ Optional
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.ManifestContentSourceOptions.limits
3
+ title: limits
4
+ summary: Inventory and representation bounds.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/manifest-content-source-options/limits
9
+ ---
10
+
11
+ # limits
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.ManifestContentSourceOptions.limits`
18
+
19
+ ```typescript
20
+ limits?: ContentDeliveryLimits | undefined
21
+ ```
22
+
23
+ Inventory and representation bounds.
24
+
25
+ **Type:&#x20;**[`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md)` | undefined`
26
+
27
+ Optional
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.ManifestContentSourceOptions.manifestUrl
3
+ title: manifestUrl
4
+ summary: Manifest URL; a browser resolves relative URLs against its current location.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/manifest-content-source-options/manifest-url
9
+ ---
10
+
11
+ # manifestUrl
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.ManifestContentSourceOptions.manifestUrl`
18
+
19
+ ```typescript
20
+ manifestUrl: string | URL
21
+ ```
22
+
23
+ Manifest URL; a browser resolves relative URLs against its current location.
24
+
25
+ **Type:&#x20;**`string | URL`
26
+
27
+ Required
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.ManifestContentSourceOptions.signal
3
+ title: signal
4
+ summary: Cancel the opening request. Use get's signal to cancel an individual read.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/manifest-content-source-options/signal
9
+ ---
10
+
11
+ # signal
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.ManifestContentSourceOptions.signal`
18
+
19
+ ```typescript
20
+ signal?: AbortSignal | undefined
21
+ ```
22
+
23
+ Cancel the opening request. Use get's signal to cancel an individual read.
24
+
25
+ **Type:&#x20;**`AbortSignal | undefined`
26
+
27
+ Optional
@@ -0,0 +1,93 @@
1
+ ---
2
+ id: reference.content-sdk.ManifestContentSourceOptions
3
+ title: ManifestContentSourceOptions
4
+ summary: Configuration for opening a static content-export manifest.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/manifest-content-source-options
9
+ ---
10
+
11
+ # ManifestContentSourceOptions
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Type** `shoalrun.content.ManifestContentSourceOptions`
18
+
19
+ ```typescript
20
+ type ManifestContentSourceOptions = {
21
+ manifestUrl: string | URL;
22
+ fetch?: typeof globalThis.fetch;
23
+ signal?: AbortSignal;
24
+ limits?: ContentDeliveryLimits;
25
+ };
26
+ ```
27
+
28
+ Configuration for opening a static content-export manifest.
29
+
30
+ ## Fields
31
+
32
+ | Name | Type | Required / default | Description |
33
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------ | ---------------------------------------------------------------------------- |
34
+ | [`fetch`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md#shoalrun-content-manifestcontentsourceoptions-fetch) | `((input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>) \| undefined` | Optional | Fetch implementation. Defaults to globalThis.fetch. |
35
+ | [`limits`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md#shoalrun-content-manifestcontentsourceoptions-limits) | [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md)` \| undefined` | Optional | Inventory and representation bounds. |
36
+ | [`manifestUrl`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md#shoalrun-content-manifestcontentsourceoptions-manifesturl) | `string \| URL` | Required | Manifest URL; a browser resolves relative URLs against its current location. |
37
+ | [`signal`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md#shoalrun-content-manifestcontentsourceoptions-signal) | `AbortSignal \| undefined` | Optional | Cancel the opening request. Use get's signal to cancel an individual read. |
38
+
39
+ ## shoalrun.content.ManifestContentSourceOptions.fetch
40
+
41
+ **Property** `shoalrun.content.ManifestContentSourceOptions.fetch`
42
+
43
+ ```typescript
44
+ fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined
45
+ ```
46
+
47
+ Fetch implementation. Defaults to globalThis.fetch.
48
+
49
+ **Type:&#x20;**`((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined`
50
+
51
+ Optional
52
+
53
+ ## shoalrun.content.ManifestContentSourceOptions.limits
54
+
55
+ **Property** `shoalrun.content.ManifestContentSourceOptions.limits`
56
+
57
+ ```typescript
58
+ limits?: ContentDeliveryLimits | undefined
59
+ ```
60
+
61
+ Inventory and representation bounds.
62
+
63
+ **Type:&#x20;**[`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md)` | undefined`
64
+
65
+ Optional
66
+
67
+ ## shoalrun.content.ManifestContentSourceOptions.manifestUrl
68
+
69
+ **Property** `shoalrun.content.ManifestContentSourceOptions.manifestUrl`
70
+
71
+ ```typescript
72
+ manifestUrl: string | URL
73
+ ```
74
+
75
+ Manifest URL; a browser resolves relative URLs against its current location.
76
+
77
+ **Type:&#x20;**`string | URL`
78
+
79
+ Required
80
+
81
+ ## shoalrun.content.ManifestContentSourceOptions.signal
82
+
83
+ **Property** `shoalrun.content.ManifestContentSourceOptions.signal`
84
+
85
+ ```typescript
86
+ signal?: AbortSignal | undefined
87
+ ```
88
+
89
+ Cancel the opening request. Use get's signal to cancel an individual read.
90
+
91
+ **Type:&#x20;**`AbortSignal | undefined`
92
+
93
+ Optional
@@ -0,0 +1,46 @@
1
+ ---
2
+ id: reference.content-sdk.mountContent
3
+ title: mountContent
4
+ summary: Mount trusted compiler HTML with instance-specific anchor and
5
+ accessibility IDs. This is not a sanitizer. The result must come from trusted
6
+ compiler output. The mount replaces the container's children and rewrites
7
+ local routing metadata.
8
+ type: code-reference
9
+ area: publishing
10
+ subarea: publishing-content-delivery
11
+ canonical: /content-delivery/sdk/mount-content
12
+ ---
13
+
14
+ # mountContent
15
+
16
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
17
+
18
+ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
19
+
20
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > TypeScript symbols > mountContent
21
+
22
+ **Updated: 2026-09-27.**
23
+
24
+ **Function** `shoalrun.content.mountContent`
25
+
26
+ ```typescript
27
+ mountContent(container: Element, result: ContentResult, options?: { instanceId?: string; signal?: AbortSignal; }): ContentMount
28
+ ```
29
+
30
+ Mount trusted compiler HTML with instance-specific anchor and accessibility IDs.
31
+ This is not a sanitizer. The result must come from trusted compiler output.
32
+ The mount replaces the container's children and rewrites local routing metadata.
33
+
34
+ ## Parameters
35
+
36
+ | Parameter | Type / default | Description |
37
+ | ----------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
38
+ | `container` | `Element` | DOM element receiving the content. |
39
+ | `result` | [`ContentResult`](https://www.shoalrun.com/content-delivery/sdk/content-result.md) | A validated HTML representation; Markdown results aren't accepted. |
40
+ | `options` | `{ instanceId?: string; signal?: AbortSignal; } \| undefined` | Optional unique instance ID and cancellation signal. |
41
+
42
+ ## Returns
43
+
44
+ [`ContentMount`](https://www.shoalrun.com/content-delivery/sdk/content-mount.md)
45
+
46
+ Rewritten anchors, typed links, and an unmount handle.
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: reference.content-sdk.openManifestContentSource
3
+ title: openManifestContentSource
4
+ summary: Open and validate one immutable static manifest revision. The caller
5
+ owns trust in the compiler output and host. Browser URLs must use the
6
+ application's origin. Requests reject redirects and unexpected content types.
7
+ type: code-reference
8
+ area: publishing
9
+ subarea: publishing-content-delivery
10
+ canonical: /content-delivery/sdk/open-manifest-content-source
11
+ ---
12
+
13
+ # openManifestContentSource
14
+
15
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
16
+
17
+ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
18
+
19
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > TypeScript symbols > openManifestContentSource
20
+
21
+ **Updated: 2026-09-27.**
22
+
23
+ **Function** `shoalrun.content.openManifestContentSource`
24
+
25
+ ```typescript
26
+ openManifestContentSource(options: ManifestContentSourceOptions): Promise<ContentSnapshot>
27
+ ```
28
+
29
+ Open and validate one immutable static manifest revision.
30
+ The caller owns trust in the compiler output and host. Browser URLs must use
31
+ the application's origin. Requests reject redirects and unexpected content types.
32
+
33
+ ## Parameters
34
+
35
+ | Parameter | Type / default | Description |
36
+ | --------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
37
+ | `options` | [`ManifestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md) | Manifest URL, request implementation, cancellation, and limits. |
38
+
39
+ ## Returns
40
+
41
+ `Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md)`>`
42
+
43
+ A revision-pinned snapshot for listing and reading exported resources.
44
+
45
+ ## Examples
46
+
47
+ ```typescript
48
+ const snapshot = await openManifestContentSource({ manifestUrl: '/help/manifest.json' });
49
+ const page = await snapshot.get({ kind: 'page', documentId: 'guide.start' }, { format: 'markdown' });
50
+ snapshot.dispose();
51
+ ```
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: reference.content-sdk.openRestContentSource
3
+ title: openRestContentSource
4
+ summary: Open a REST inventory and pin subsequent resource reads to its revision.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/open-rest-content-source
9
+ ---
10
+
11
+ # openRestContentSource
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
16
+
17
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > TypeScript symbols > openRestContentSource
18
+
19
+ **Updated: 2026-09-27.**
20
+
21
+ **Function** `shoalrun.content.openRestContentSource`
22
+
23
+ ```typescript
24
+ openRestContentSource(options: RestContentSourceOptions): Promise<ContentSnapshot>
25
+ ```
26
+
27
+ Open a REST inventory and pin subsequent resource reads to its revision.
28
+
29
+ ## Parameters
30
+
31
+ | Parameter | Type / default | Description |
32
+ | --------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
33
+ | `options` | [`RestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/rest-content-source-options.md) | REST mount, exact publication, optional revision, and request settings. |
34
+
35
+ ## Returns
36
+
37
+ `Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md)`>`
38
+
39
+ A snapshot with the same list/get/dispose interface as the manifest source.
@@ -0,0 +1,28 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.baseUrl
3
+ title: baseUrl
4
+ summary: REST mount URL, such as /content/v1. Browser requests must use the
5
+ application's origin.
6
+ type: code-reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/sdk/rest-content-source-options/base-url
10
+ ---
11
+
12
+ # baseUrl
13
+
14
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
15
+
16
+ **Updated: 2026-09-27.**
17
+
18
+ **Property** `shoalrun.content.RestContentSourceOptions.baseUrl`
19
+
20
+ ```typescript
21
+ baseUrl: string | URL
22
+ ```
23
+
24
+ REST mount URL, such as /content/v1. Browser requests must use the application's origin.
25
+
26
+ **Type:&#x20;**`string | URL`
27
+
28
+ Required
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.fetch
3
+ title: fetch
4
+ summary: Fetch implementation. Defaults to globalThis.fetch.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/rest-content-source-options/fetch
9
+ ---
10
+
11
+ # fetch
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.RestContentSourceOptions.fetch`
18
+
19
+ ```typescript
20
+ fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined
21
+ ```
22
+
23
+ Fetch implementation. Defaults to globalThis.fetch.
24
+
25
+ **Type:&#x20;**`((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined`
26
+
27
+ Optional
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.limits
3
+ title: limits
4
+ summary: Inventory and representation bounds.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/rest-content-source-options/limits
9
+ ---
10
+
11
+ # limits
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.RestContentSourceOptions.limits`
18
+
19
+ ```typescript
20
+ limits?: ContentDeliveryLimits | undefined
21
+ ```
22
+
23
+ Inventory and representation bounds.
24
+
25
+ **Type:&#x20;**[`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md)` | undefined`
26
+
27
+ Optional
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.publication
3
+ title: publication
4
+ summary: Exact publication to request; include product for a product-scoped source.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/rest-content-source-options/publication
9
+ ---
10
+
11
+ # publication
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.RestContentSourceOptions.publication`
18
+
19
+ ```typescript
20
+ publication: ContentPublication
21
+ ```
22
+
23
+ Exact publication to request; include product for a product-scoped source.
24
+
25
+ **Type:&#x20;**[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)
26
+
27
+ Required
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.revision
3
+ title: revision
4
+ summary: Expected inventory revision. Omit it to open the current revision.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/rest-content-source-options/revision
9
+ ---
10
+
11
+ # revision
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.RestContentSourceOptions.revision`
18
+
19
+ ```typescript
20
+ revision?: string | undefined
21
+ ```
22
+
23
+ Expected inventory revision. Omit it to open the current revision.
24
+
25
+ **Type:&#x20;**`string | undefined`
26
+
27
+ Optional
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: reference.content-sdk.RestContentSourceOptions.signal
3
+ title: signal
4
+ summary: Cancel the inventory-opening request.
5
+ type: code-reference
6
+ area: publishing
7
+ subarea: publishing-content-delivery
8
+ canonical: /content-delivery/sdk/rest-content-source-options/signal
9
+ ---
10
+
11
+ # signal
12
+
13
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
+
15
+ **Updated: 2026-09-27.**
16
+
17
+ **Property** `shoalrun.content.RestContentSourceOptions.signal`
18
+
19
+ ```typescript
20
+ signal?: AbortSignal | undefined
21
+ ```
22
+
23
+ Cancel the inventory-opening request.
24
+
25
+ **Type:&#x20;**`AbortSignal | undefined`
26
+
27
+ Optional