@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
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
16
16
 
17
17
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
18
18
 
19
- **Updated: 2026-11-05.**
19
+ **Updated: 2026-11-07.**
20
20
 
21
21
  Configure the site identity, header, footer, agent guidance, colors, and fonts. These keys belong in `docs.config.yaml` or an included configuration file. For file composition and validation commands, see [Configure your project](https://www.shoalrun.com/configuration.md). Use the [configuration index](https://www.shoalrun.com/config.md) to find another setting.
22
22
 
@@ -24,22 +24,22 @@ Configure the site identity, header, footer, agent guidance, colors, and fonts.
24
24
 
25
25
  Required.
26
26
 
27
- | Key | Default | Meaning |
28
- | ---------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
29
- | `title` | None | Site name in the masthead and the heading of `/llms.txt`. |
30
- | `contentDir` | `content` | Page directory, relative to the root config file. Every `.md` and `.mdx` file in it's read. |
31
- | `contentFilter` | None | Build-time whole-page selection by configured reader facets. All selected facets must match; any listed choice within a facet matches. Unmarked pages are excluded. Unknown or empty selectors and selections with no pages fail. See [separate sites from shared content](https://www.shoalrun.com/publish/single-source-sites.md). |
32
- | `basePath` | `""` | Mount point for public pages and resources, such as `/docs`. Use URL path segments without escapes or dot segments. Build tools keep internal manifests at the output root; the public site is also complete inside the `docs/` output subtree. |
33
- | `origin` | None | The site's HTTPS origin, such as `https://docs.example.com`, with no path or trailing slash. Required to publish the API catalog, and makes link-preview URLs absolute. |
34
- | `indexing` | `true` | Set `false` on previews to add noindex to pages, disallow crawling in `robots.txt`, and omit the XML sitemap. |
35
- | `updated` | None | Optional YYYY-MM-DD fallback for sitemap `lastmod`, especially on generated API pages. Page `updated` overrides it. |
36
- | `favicon` | A mark drawn from the preset and palette | A local `.svg` or `.png` file. See [share images and favicon](https://www.shoalrun.com/styling/share-images.md). |
37
- | `customCss` | None | A local `.css` file linked after the framework styles. See [CSS](https://www.shoalrun.com/author/css.md). |
38
- | `editionBadge` | `auto` | Legacy productless masthead label: `auto` shows only differing publication values; `always` or `never`. Product catalogs use the publication dropdown described below. |
39
- | `publicationSelector.showLanguage` | Automatic | Since 0.1.0-alpha.18 Show language labels in the product publication dropdown only when the rendered edition has multiple languages. A boolean forces display on or off. |
40
- | `header.links` | None | Masthead links. See [header](https://www.shoalrun.com/styling/header.md). |
41
- | `agentDiscovery` | Visually hidden until focused | HTML agent guidance, visual presentation, and link labels. See `site.agentDiscovery` below. |
42
- | `footer` | None | Footer `columns`, bottom-row `links`, and a `text` line. See [site footer](https://www.shoalrun.com/styling/footer.md). |
27
+ | Key | Default | Meaning |
28
+ | ---------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
29
+ | `title` | None | Site name in the masthead and the heading of `/llms.txt`. |
30
+ | `contentDir` | `content` | Page directory, relative to the root config file. Every `.md` and `.mdx` file in it's read. |
31
+ | `contentFilter` | None | Build-time page selection by configured reader facets, also evaluated by [ForFacet](https://www.shoalrun.com/author/components/for-facet.md) sections. All selected facets must match; any listed choice within a facet matches. Unmarked pages are excluded. Unknown or empty selectors and selections with no pages fail. See [separate sites from shared content](https://www.shoalrun.com/publish/single-source-sites.md). |
32
+ | `basePath` | `""` | Mount point for public pages and resources, such as `/docs`. Use URL path segments without escapes or dot segments. Build tools keep internal manifests at the output root; the public site is also complete inside the `docs/` output subtree. |
33
+ | `origin` | None | The site's HTTPS origin, such as `https://docs.example.com`, with no path or trailing slash. Required to publish the API catalog, and makes link-preview URLs absolute. |
34
+ | `indexing` | `true` | Set `false` on previews to add noindex to pages, disallow crawling in `robots.txt`, and omit the XML sitemap. |
35
+ | `updated` | None | Optional YYYY-MM-DD fallback for sitemap `lastmod`, especially on generated API pages. Page `updated` overrides it. |
36
+ | `favicon` | A mark drawn from the preset and palette | A local `.svg` or `.png` file. See [share images and favicon](https://www.shoalrun.com/styling/share-images.md). |
37
+ | `customCss` | None | A local `.css` file linked after the framework styles. See [CSS](https://www.shoalrun.com/author/css.md). |
38
+ | `editionBadge` | `auto` | Legacy productless masthead label: `auto` shows only differing publication values; `always` or `never`. Product catalogs use the publication dropdown described below. |
39
+ | `publicationSelector.showLanguage` | Automatic | Since 0.1.0-alpha.18 Show language labels in the product publication dropdown only when the rendered edition has multiple languages. A boolean forces display on or off. |
40
+ | `header.links` | None | Masthead links. See [header](https://www.shoalrun.com/styling/header.md). |
41
+ | `agentDiscovery` | Visually hidden until focused | HTML agent guidance, visual presentation, and link labels. See `site.agentDiscovery` below. |
42
+ | `footer` | None | Footer `columns`, bottom-row `links`, and a `text` line. See [site footer](https://www.shoalrun.com/styling/footer.md). |
43
43
 
44
44
  A minimal site needs only a title:
45
45
 
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
16
16
 
17
17
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
18
18
 
19
- **Updated: 2026-11-05.**
19
+ **Updated: 2026-11-07.**
20
20
 
21
21
  Parent page: [Full Markdown page](/config/site.md)
22
22
 
@@ -16,7 +16,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
16
16
 
17
17
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
18
18
 
19
- **Updated: 2026-11-05.**
19
+ **Updated: 2026-11-07.**
20
20
 
21
21
  Parent page: [Full Markdown page](/config/site.md)
22
22
 
@@ -59,7 +59,7 @@ CONFIG_DEMO="$(mktemp -d)"
59
59
  mkdir "$CONFIG_DEMO/site"
60
60
  cd "$CONFIG_DEMO/site"
61
61
  npm init -y
62
- npm install --save-exact @shoalrun/cli@1.0.0
62
+ npm install --save-exact @shoalrun/cli@1.1.0
63
63
  npx --no-install shoalrun init . --starter minimal
64
64
  ```
65
65
 
@@ -40,7 +40,7 @@ CONFIG_DEMO="$(mktemp -d)"
40
40
  mkdir "$CONFIG_DEMO/site"
41
41
  cd "$CONFIG_DEMO/site"
42
42
  npm init -y
43
- npm install --save-exact @shoalrun/cli@1.0.0
43
+ npm install --save-exact @shoalrun/cli@1.1.0
44
44
  npx --no-install shoalrun init . --starter minimal
45
45
  ```
46
46
 
@@ -15,14 +15,18 @@ canonical: /content-delivery/api
15
15
 
16
16
  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)
17
17
 
18
- Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Content client API
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  **Available since: 0.1.0-alpha.13.**
23
23
 
24
24
  Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
25
25
 
26
+ ## Generated TypeScript reference
27
+
28
+ Use the [generated content client reference](https://www.shoalrun.com/content-delivery/sdk/all.md) to browse public exports from `@shoalrun/cli/content`. It follows the source declarations and JSDoc, including [snapshot methods](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md), [source options](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md), [results](https://www.shoalrun.com/content-delivery/sdk/content-result.md), and [delivery errors](https://www.shoalrun.com/content-delivery/sdk/content-delivery-error.md). The guide and behavior reference explain how to use those interfaces and where their trust boundaries apply.
29
+
26
30
  ## Open a source
27
31
 
28
32
  ```ts
@@ -136,6 +140,10 @@ The same typed reference selects either available representation. HTML mounting
136
140
 
137
141
  - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
138
142
 
143
+ ### Reference while working
144
+
145
+ - [ContentSnapshot](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md) — Inspect the source-derived snapshot methods and their typed parameters.
146
+
139
147
  ### Related topics
140
148
 
141
149
  - [Read content with a client](https://www.shoalrun.com/content-delivery/client.md) — Look up client methods, limits, and errors.
@@ -0,0 +1,52 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Errors
35
+
36
+ Use `ContentDeliveryError.code` to distinguish these failures.
37
+
38
+ | Code | Meaning |
39
+ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
40
+ | `invalid_manifest` | Invalid source URL, options, inventory, manifest shape, digest, or review metadata |
41
+ | `not_found` | Missing manifest, unknown resource reference, or REST `404` |
42
+ | `unsupported_format` | Unavailable representation, REST `406`, or non-HTML input passed to `mountContent` |
43
+ | `stale_revision` | Content bytes differ from the opened revision, a static representation file is missing, or REST returns `409` |
44
+ | `network_error` | Failed or interrupted request; REST `400`, `405`, or `500`; or HTTP failures outside the REST contract, such as `401`, `429`, or `503` |
45
+ | `invalid_content` | Wrong response media type, invalid UTF-8, exceeded response limit, malformed REST error, or invalid mount content |
46
+ | `disposed` | Reading a disposed snapshot or a read aborted by disposal |
47
+
48
+ The static client maps a missing representation file to `stale_revision`; the REST client preserves `404` as `not_found`. Opening a REST inventory with a different requested revision also produces `stale_revision`.
49
+
50
+ Defined REST error statuses must carry the documented JSON envelope. A malformed envelope produces `invalid_content`; other HTTP failure statuses produce `network_error` regardless of response body format.
51
+
52
+ Cancellation can propagate the signal's abort reason instead of a `ContentDeliveryError`. Treat messages as diagnostics rather than parsing them for program logic.
@@ -0,0 +1,36 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Generated TypeScript reference
35
+
36
+ Use the [generated content client reference](https://www.shoalrun.com/content-delivery/sdk/all.md) to browse public exports from `@shoalrun/cli/content`. It follows the source declarations and JSDoc, including [snapshot methods](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md), [source options](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md), [results](https://www.shoalrun.com/content-delivery/sdk/content-result.md), and [delivery errors](https://www.shoalrun.com/content-delivery/sdk/content-delivery-error.md). The guide and behavior reference explain how to use those interfaces and where their trust boundaries apply.
@@ -0,0 +1,36 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## HTML, Markdown, and agents
35
+
36
+ The same typed reference selects either available representation. HTML mounting is optional and separate from retrieval. Agents can read Markdown and metadata through the client without a DOM. Digests detect mismatched bytes; they don't establish that an unknown publisher's content is trustworthy.
@@ -0,0 +1,42 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Mount HTML
35
+
36
+ ```ts
37
+ mountContent(container, result, { instanceId?, signal? })
38
+ ```
39
+
40
+ The result must be HTML from a trusted export. Mounting replaces the container's children, assigns instance-specific DOM IDs, and rewrites local ID references. The returned `ContentMount` contains `anchors`, `links`, and `unmount()`. See [render content](https://www.shoalrun.com/content-delivery/render.md) for ownership and routing.
41
+
42
+ `instanceId` is optional; the default uses a random UUID. A supplied ID must start with an ASCII letter and contain at most 128 letters, numbers, underscores, or hyphens. Use a different ID for each simultaneous mount. `anchors` maps original anchor IDs to mounted DOM IDs, while `links` carries routing metadata. `signal` cancels before insertion; aborting it after mounting doesn't remove content. Call `unmount()` to remove only nodes still owned by that mount.
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Open a REST source
35
+
36
+ ```ts
37
+ openRestContentSource(options): Promise<ContentSnapshot>
38
+ ```
39
+
40
+ `RestContentSourceOptions` accepts `baseUrl`, a required `{ channel, version, language }` publication, and an optional `revision`. It also accepts the same `fetch`, `signal`, and `limits` options as the manifest source. `limits.manifestBytes` bounds the JSON inventory response. Opening fetches that inventory and pins subsequent reads to its revision.
41
+
42
+ Since 0.1.0-alpha.18
43
+
44
+ Upgrade the exporter and content client together to use product-scoped bundles.
45
+
46
+ For a product-scoped source, pass `{ product, channel, version, language }` as `publication`. The client sends `product` on inventory and resource requests and rejects responses for a different product. Productless responses use envelope `schemaVersion: 1`; product responses use `schemaVersion: 2`. Both use the `/content/v1` protocol path.
47
+
48
+ ```ts
49
+ const snapshot = await openRestContentSource({
50
+ baseUrl: '/content/v1',
51
+ publication: { product: 'payments', channel: 'production', version: 'v3', language: 'en' },
52
+ });
53
+ ```
54
+
55
+ Browser URLs must share the application's origin. Outside a browser, provide an absolute HTTP(S) URL. The base URL must omit credentials, query strings, and fragments. `contentResourceKey(ref)` returns a REST resource key; it's distinct from the local comparison key returned by `contentRefKey(ref)`. See the [HTTP reference](https://www.shoalrun.com/content-delivery/http-api.md) for routes and response types.
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Open a source
35
+
36
+ ```ts
37
+ openManifestContentSource(options): Promise<ContentSnapshot>
38
+ ```
39
+
40
+ | Option | Meaning | Default |
41
+ | ---------------------- | ------------------------------------------------------------ | -------------- |
42
+ | `manifestUrl` | HTTP(S) manifest URL; relative URLs use the browser location | Required |
43
+ | `fetch` | Application-provided fetch implementation | Global `fetch` |
44
+ | `signal` | Cancellation signal for opening the manifest | None |
45
+ | `limits.manifestBytes` | Maximum manifest response bytes | 5,000,000 |
46
+ | `limits.resourceBytes` | Maximum representation response bytes | 8,000,000 |
47
+ | `limits.resources` | Maximum resources in a manifest | 10,000 |
48
+
49
+ `manifestUrl` accepts a string or `URL`. Outside a browser, supply an absolute URL. URLs must omit credentials, query strings, and fragments; the manifest must sit within its declared `publicBase`.
50
+
51
+ Limits must be positive safe integers. The browser client requires the application origin and refuses redirects. The server must send `application/json` for the manifest and the declared content type for representations.
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Read a snapshot
35
+
36
+ A snapshot exposes the following members for one opened revision.
37
+
38
+ | Member | Contract |
39
+ | ------------------------------- | ------------------------------------------------------------------------------- |
40
+ | `revision` | Opened manifest digest |
41
+ | `publication` | Channel, version, and language; product-scoped snapshots also include `product` |
42
+ | `list()` | Read-only resource metadata for this revision |
43
+ | `get(ref, { format, signal? })` | Promise for a checked HTML or Markdown result |
44
+ | `dispose()` | Cancel the snapshot lifetime and refuse later reads |
45
+
46
+ ```ts
47
+ type ContentRef =
48
+ | { kind: 'page'; documentId: string }
49
+ | { kind: 'section'; documentId: string; sectionId: string }
50
+ | { kind: 'snippet'; id: string };
51
+ ```
52
+
53
+ `list()` is synchronous because opening a source loads and freezes its metadata. Each `get()` fetches and checks UTF-8, media type, byte count, and SHA-256 against that revision; the client doesn't cache response bodies. `dispose()` is idempotent, aborts active reads, and makes later `list()` and `get()` calls fail. The opening signal affects only opening; use the per-read signal or `dispose()` for subsequent reads.
54
+
55
+ A `ContentResult` contains `resource`, `representation`, `format`, `content`, and `revision`. `contentRefKey(ref)` returns a key for comparing typed references. It isn't a URL or authorization decision.
@@ -0,0 +1,42 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
27
+
28
+ ## Related reading
29
+
30
+ ### Read first
31
+
32
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
33
+
34
+ ### Reference while working
35
+
36
+ - [ContentSnapshot](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md) — Inspect the source-derived snapshot methods and their typed parameters.
37
+
38
+ ### Related topics
39
+
40
+ - [Read content with a client](https://www.shoalrun.com/content-delivery/client.md) — Look up client methods, limits, and errors.
41
+
42
+ - [Serve content through REST](https://www.shoalrun.com/content-delivery/rest.md) — Use the shared snapshot methods and client limits.
@@ -0,0 +1,40 @@
1
+ ---
2
+ id: reference.content-client
3
+ title: Content client API
4
+ summary: Look up the content client entry point, snapshot methods, limits,
5
+ results, and errors.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-content-delivery
9
+ canonical: /content-delivery/api
10
+ ---
11
+
12
+ # Content client API
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
+ 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)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Client behavior
19
+
20
+ **Updated: 2026-11-07.**
21
+
22
+ **Available since: 0.1.0-alpha.13.**
23
+
24
+ Parent page: [Full Markdown page](/content-delivery/api.md)
25
+
26
+ **Page reading path** — these links apply to the full page.
27
+
28
+ **Read first**
29
+
30
+ - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
31
+
32
+ Import the browser-safe delivery API from `@shoalrun/cli/content`. It reads exports and mounts trusted HTML without loading the compiler. Browser use requires HTTPS or localhost for Web Crypto.
33
+
34
+ ## Validate a manifest
35
+
36
+ ```ts
37
+ validateContentManifest(value, maxResources = 10_000, maxResourceBytes = 8_000_000): asserts value is ContentManifest
38
+ ```
39
+
40
+ This exported helper checks structure, inventory limits, and approved review metadata. It doesn't fetch files or verify the manifest digest. Use `openManifestContentSource` for the complete loading and integrity checks. See the [manifest reference](https://www.shoalrun.com/content-delivery/manifest.md) for `ContentResource`, `ContentRepresentation`, `ContentAnchor`, and `ContentLink` fields.
@@ -17,12 +17,16 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Content delivery > Read content with a client
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-07.**
21
21
 
22
22
  **Available since: 0.1.0-alpha.13.**
23
23
 
24
24
  Use the content client in an application to read a static export. Serve the bundle from the application's origin and use your normal JavaScript build tooling to import `@shoalrun/cli/content`.
25
25
 
26
+ ## Generated TypeScript reference
27
+
28
+ Use the [generated content client reference](https://www.shoalrun.com/content-delivery/sdk/all.md) to browse public exports from `@shoalrun/cli/content`. It follows the source declarations and JSDoc, including [snapshot methods](https://www.shoalrun.com/content-delivery/sdk/content-snapshot.md), [source options](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options.md), [results](https://www.shoalrun.com/content-delivery/sdk/content-result.md), and [delivery errors](https://www.shoalrun.com/content-delivery/sdk/content-delivery-error.md). The guide and behavior reference explain how to use those interfaces and where their trust boundaries apply.
29
+
26
30
  ## Open a revision
27
31
 
28
32
  ```ts
@@ -76,6 +80,10 @@ Request HTML for [application rendering](https://www.shoalrun.com/content-delive
76
80
 
77
81
  - [Content delivery](https://www.shoalrun.com/content-delivery.md) — Understand resource delivery and its application boundary.
78
82
 
83
+ ### Reference while working
84
+
85
+ - [Complete content client reference](https://www.shoalrun.com/content-delivery/sdk/all.md) — Look up the public functions and types while integrating a content source.
86
+
79
87
  ### Related topics
80
88
 
81
89
  - [Select content resources](https://www.shoalrun.com/content-delivery/select.md) — Read a reviewed export from an application.