@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.
- package/CHANGELOG.md +19 -0
- package/CODE-REFERENCES.md +19 -0
- package/README.md +13 -4
- package/adapters/typescript/README.md +27 -0
- package/adapters/typescript/shoalrun-reference.mjs +260 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +3 -1
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/api-docs/code-reference-settings.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/catalog-settings.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/complete-reference-page.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/converter-snapshot.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/metadata-and-selection.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/publication-sources.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/python-adapter-limits.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/related-reading.md +2 -2
- package/agent-docs/api-docs/code-reference-settings.sections/symbol-fields.md +2 -2
- package/agent-docs/api-docs/code-references.md +9 -1
- package/agent-docs/api-docs/code-references.sections/a-real-typescript-example.md +38 -0
- package/agent-docs/api-docs/code-references.sections/add-python-source.md +56 -0
- package/agent-docs/api-docs/code-references.sections/before-you-start.md +40 -0
- package/agent-docs/api-docs/code-references.sections/build-and-verify.md +47 -0
- package/agent-docs/api-docs/code-references.sections/choose-the-reading-layout.md +46 -0
- package/agent-docs/api-docs/code-references.sections/extract-and-validate-a-snapshot.md +52 -0
- package/agent-docs/api-docs/code-references.sections/html-markdown-and-agents.md +42 -0
- package/agent-docs/api-docs/code-references.sections/register-the-catalog-and-navigation.md +58 -0
- package/agent-docs/api-docs/code-references.sections/related-reading.md +40 -0
- package/agent-docs/api-docs/code-references.sections/versions-profiles-and-delivery.md +40 -0
- package/agent-docs/api-docs/typescript-references.md +93 -0
- package/agent-docs/author/components/for-facet.md +127 -0
- package/agent-docs/author/components/only.md +3 -1
- package/agent-docs/author/components.md +2 -1
- package/agent-docs/author/reader-views.md +2 -2
- package/agent-docs/author/reader-views.sections/configure-the-choices.md +2 -2
- package/agent-docs/author/reader-views.sections/connect-your-own-control.md +2 -2
- package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +2 -2
- package/agent-docs/author/reader-views.sections/mark-pages.md +2 -2
- package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +2 -2
- package/agent-docs/author/reader-views.sections/place-filter-controls.md +2 -2
- package/agent-docs/author/reader-views.sections/try-the-controls-here.md +2 -2
- package/agent-docs/changelog/facet-typescript.md +54 -0
- package/agent-docs/changelog.md +8 -0
- package/agent-docs/config/examples.md +2 -2
- package/agent-docs/config/examples.sections/feature-showcase.md +2 -2
- package/agent-docs/config/examples.sections/minimal-site.md +1 -1
- package/agent-docs/config/examples.sections/multilingual-help-center.md +1 -1
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +1 -1
- package/agent-docs/config/examples.sections/related-reading.md +1 -1
- package/agent-docs/config/examples.sections/shared-company-preset.md +1 -1
- package/agent-docs/config/outputs.md +12 -12
- package/agent-docs/config/outputs.sections/exports.md +12 -12
- package/agent-docs/config/outputs.sections/metadata.md +1 -1
- package/agent-docs/config/outputs.sections/pdf-output.md +1 -1
- package/agent-docs/config/outputs.sections/related-reading.md +1 -1
- package/agent-docs/config/site.md +17 -17
- package/agent-docs/config/site.sections/related-reading.md +1 -1
- package/agent-docs/config/site.sections/theme.md +1 -1
- package/agent-docs/configuration.md +1 -1
- package/agent-docs/configuration.sections/start-with-one-working-file.md +1 -1
- package/agent-docs/content-delivery/api.md +10 -2
- package/agent-docs/content-delivery/api.sections/errors.md +52 -0
- package/agent-docs/content-delivery/api.sections/generated-typescript-reference.md +36 -0
- package/agent-docs/content-delivery/api.sections/html-markdown-and-agents.md +36 -0
- package/agent-docs/content-delivery/api.sections/mount-html.md +42 -0
- package/agent-docs/content-delivery/api.sections/open-a-rest-source.md +55 -0
- package/agent-docs/content-delivery/api.sections/open-a-source.md +51 -0
- package/agent-docs/content-delivery/api.sections/read-a-snapshot.md +55 -0
- package/agent-docs/content-delivery/api.sections/related-reading.md +42 -0
- package/agent-docs/content-delivery/api.sections/validate-a-manifest.md +40 -0
- package/agent-docs/content-delivery/client.md +9 -1
- package/agent-docs/content-delivery/sdk/all.md +1772 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-exportedid.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-id.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor-title.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentanchor.md +44 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset-mediatype.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentasset.md +40 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror-code.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliveryerror.md +46 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-manifestbytes.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resourcebytes.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits-resources.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentdeliverylimits.md +44 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contenterrorcode.md +32 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-bytes.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-digest.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile-path.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentfile.md +44 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentformat.md +32 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-asset.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-fragment.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-href.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-key.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-kind.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-query.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink-ref.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentlink.md +52 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-assets.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-diagnostics.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-digest.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-files.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-kind.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publication.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-publicbase.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-resources.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-review.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest-schemaversion.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmanifest.md +68 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-anchors.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-links.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount-unmount.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentmount.md +49 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-channel.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-language.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-product.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication-version.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentpublication.md +46 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentref.md +43 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrefkey.md +42 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-anchors.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation-links.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrepresentation.md +42 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-assets.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-canonicalurl.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-externaldependencies.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-publication.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-ref.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-representations.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-source.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-summary.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-title.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource-type.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresource.md +65 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresourcekey.md +42 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-key.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry-resource.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestentry.md +42 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror-error.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterror.md +43 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresterrorcode.md +32 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-publication.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-resources.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-revision.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist-schemaversion.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestlist.md +46 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-key.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-publication.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-resource.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-revision.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource-schemaversion.md +34 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentrestresource.md +48 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-content.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-format.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-representation.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-resource.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-revision.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult.md +48 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-dispose.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-get.md +45 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-list.md +38 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-publication.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-revision.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot.md +47 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-fetch.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-limits.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-manifesturl.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions-signal.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-manifestcontentsourceoptions.md +46 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-mountcontent.md +48 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openmanifestcontentsource.md +54 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openrestcontentsource.md +44 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-baseurl.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-fetch.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-limits.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-publication.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-revision.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions-signal.md +36 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions.md +50 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-validatecontentmanifest.md +45 -0
- package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content.md +65 -0
- package/agent-docs/content-delivery/sdk/content-anchor/exported-id.md +25 -0
- package/agent-docs/content-delivery/sdk/content-anchor/id.md +25 -0
- package/agent-docs/content-delivery/sdk/content-anchor/title.md +25 -0
- package/agent-docs/content-delivery/sdk/content-anchor.md +71 -0
- package/agent-docs/content-delivery/sdk/content-asset/media-type.md +25 -0
- package/agent-docs/content-delivery/sdk/content-asset.md +43 -0
- package/agent-docs/content-delivery/sdk/content-delivery-error/code.md +25 -0
- package/agent-docs/content-delivery/sdk/content-delivery-error.md +53 -0
- package/agent-docs/content-delivery/sdk/content-delivery-limits/manifest-bytes.md +27 -0
- package/agent-docs/content-delivery/sdk/content-delivery-limits/resource-bytes.md +27 -0
- package/agent-docs/content-delivery/sdk/content-delivery-limits/resources.md +27 -0
- package/agent-docs/content-delivery/sdk/content-delivery-limits.md +77 -0
- package/agent-docs/content-delivery/sdk/content-error-code.md +23 -0
- package/agent-docs/content-delivery/sdk/content-file/bytes.md +25 -0
- package/agent-docs/content-delivery/sdk/content-file/digest.md +25 -0
- package/agent-docs/content-delivery/sdk/content-file/path.md +25 -0
- package/agent-docs/content-delivery/sdk/content-file.md +71 -0
- package/agent-docs/content-delivery/sdk/content-format.md +23 -0
- package/agent-docs/content-delivery/sdk/content-link/asset.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/fragment.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/href.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/key.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/kind.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/query.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link/ref.md +25 -0
- package/agent-docs/content-delivery/sdk/content-link.md +127 -0
- package/agent-docs/content-delivery/sdk/content-manifest/assets.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/diagnostics.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/digest.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/files.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/kind.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/public-base.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/publication.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/resources.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/review.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest/schema-version.md +25 -0
- package/agent-docs/content-delivery/sdk/content-manifest.md +179 -0
- package/agent-docs/content-delivery/sdk/content-mount/anchors.md +27 -0
- package/agent-docs/content-delivery/sdk/content-mount/links.md +27 -0
- package/agent-docs/content-delivery/sdk/content-mount/unmount.md +27 -0
- package/agent-docs/content-delivery/sdk/content-mount.md +82 -0
- package/agent-docs/content-delivery/sdk/content-publication/channel.md +25 -0
- package/agent-docs/content-delivery/sdk/content-publication/language.md +25 -0
- package/agent-docs/content-delivery/sdk/content-publication/product.md +25 -0
- package/agent-docs/content-delivery/sdk/content-publication/version.md +25 -0
- package/agent-docs/content-delivery/sdk/content-publication.md +85 -0
- package/agent-docs/content-delivery/sdk/content-ref-key.md +34 -0
- package/agent-docs/content-delivery/sdk/content-ref.md +40 -0
- package/agent-docs/content-delivery/sdk/content-representation/anchors.md +25 -0
- package/agent-docs/content-delivery/sdk/content-representation/links.md +25 -0
- package/agent-docs/content-delivery/sdk/content-representation.md +57 -0
- package/agent-docs/content-delivery/sdk/content-resource/assets.md +25 -0
- package/agent-docs/content-delivery/sdk/content-resource/canonical-url.md +25 -0
- package/agent-docs/content-delivery/sdk/content-resource/external-dependencies.md +25 -0
- package/agent-docs/content-delivery/sdk/content-resource/publication.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource/ref.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource/representations.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource/source.md +25 -0
- package/agent-docs/content-delivery/sdk/content-resource/summary.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource/title.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource/type.md +27 -0
- package/agent-docs/content-delivery/sdk/content-resource-key.md +34 -0
- package/agent-docs/content-delivery/sdk/content-resource.md +192 -0
- package/agent-docs/content-delivery/sdk/content-rest-entry/key.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-entry/resource.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-entry.md +57 -0
- package/agent-docs/content-delivery/sdk/content-rest-error/error.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-error-code.md +23 -0
- package/agent-docs/content-delivery/sdk/content-rest-error.md +46 -0
- package/agent-docs/content-delivery/sdk/content-rest-list/publication.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-list/resources.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-list/revision.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-list/schema-version.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-list.md +85 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource/key.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource/publication.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource/resource.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource/revision.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource/schema-version.md +25 -0
- package/agent-docs/content-delivery/sdk/content-rest-resource.md +99 -0
- package/agent-docs/content-delivery/sdk/content-result/content.md +27 -0
- package/agent-docs/content-delivery/sdk/content-result/format.md +27 -0
- package/agent-docs/content-delivery/sdk/content-result/representation.md +27 -0
- package/agent-docs/content-delivery/sdk/content-result/resource.md +27 -0
- package/agent-docs/content-delivery/sdk/content-result/revision.md +27 -0
- package/agent-docs/content-delivery/sdk/content-result.md +114 -0
- package/agent-docs/content-delivery/sdk/content-snapshot/dispose.md +27 -0
- package/agent-docs/content-delivery/sdk/content-snapshot/get.md +36 -0
- package/agent-docs/content-delivery/sdk/content-snapshot/list.md +29 -0
- package/agent-docs/content-delivery/sdk/content-snapshot/publication.md +27 -0
- package/agent-docs/content-delivery/sdk/content-snapshot/revision.md +27 -0
- package/agent-docs/content-delivery/sdk/content-snapshot.md +123 -0
- package/agent-docs/content-delivery/sdk/exports.md +742 -0
- package/agent-docs/content-delivery/sdk/exports.sections/functions.md +30 -0
- package/agent-docs/content-delivery/sdk/exports.sections/members.md +47 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentanchor.md +41 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentasset.md +37 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliveryerror.md +43 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentdeliverylimits.md +41 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contenterrorcode.md +29 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentfile.md +41 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentformat.md +29 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentlink.md +49 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmanifest.md +65 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentmount.md +46 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentpublication.md +43 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentref.md +40 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrefkey.md +39 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrepresentation.md +39 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresource.md +62 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresourcekey.md +39 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestentry.md +39 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterror.md +40 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterrorcode.md +29 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestlist.md +43 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestresource.md +45 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresult.md +45 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentsnapshot.md +44 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-manifestcontentsourceoptions.md +43 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-mountcontent.md +45 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openmanifestcontentsource.md +51 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openrestcontentsource.md +41 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-restcontentsourceoptions.md +47 -0
- package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-validatecontentmanifest.md +42 -0
- package/agent-docs/content-delivery/sdk/manifest-content-source-options/fetch.md +27 -0
- package/agent-docs/content-delivery/sdk/manifest-content-source-options/limits.md +27 -0
- package/agent-docs/content-delivery/sdk/manifest-content-source-options/manifest-url.md +27 -0
- package/agent-docs/content-delivery/sdk/manifest-content-source-options/signal.md +27 -0
- package/agent-docs/content-delivery/sdk/manifest-content-source-options.md +93 -0
- package/agent-docs/content-delivery/sdk/mount-content.md +46 -0
- package/agent-docs/content-delivery/sdk/open-manifest-content-source.md +51 -0
- package/agent-docs/content-delivery/sdk/open-rest-content-source.md +39 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/base-url.md +28 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/fetch.md +27 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/limits.md +27 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/publication.md +27 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/revision.md +27 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options/signal.md +27 -0
- package/agent-docs/content-delivery/sdk/rest-content-source-options.md +125 -0
- package/agent-docs/content-delivery/sdk/validate-content-manifest.md +38 -0
- package/agent-docs/contribute/agent-skills.md +33 -6
- package/agent-docs/documents.json +7094 -308
- package/agent-docs/features.md +18 -17
- package/agent-docs/provenance.json +6 -6
- package/agent-docs/publish/content-export.md +3 -1
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +1 -1
- package/agent-docs/publish/content-export.sections/check-the-result.md +1 -1
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +1 -1
- package/agent-docs/publish/content-export.sections/prerequisites.md +1 -1
- package/agent-docs/publish/content-export.sections/related-reading.md +1 -1
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +1 -1
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +1 -1
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +1 -1
- package/agent-docs/publish/pdf.md +2 -2
- package/agent-docs/publish/pdf.sections/apply-print-styling.md +1 -1
- package/agent-docs/publish/pdf.sections/check-the-result.md +1 -1
- package/agent-docs/publish/pdf.sections/export-a-page-or-publication.md +2 -2
- package/agent-docs/publish/pdf.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/publish/pdf.sections/offer-browser-page-printing.md +1 -1
- package/agent-docs/publish/pdf.sections/offer-direct-downloads-through-a-node-server.md +1 -1
- package/agent-docs/publish/pdf.sections/prerequisites.md +1 -1
- package/agent-docs/publish/pdf.sections/publish-an-optional-manual-download.md +1 -1
- package/agent-docs/publish/single-source-sites.md +26 -2
- package/agent-docs/publish/single-source-sites.sections/build-and-check-each-output.md +49 -0
- package/agent-docs/publish/single-source-sites.sections/html-markdown-and-agents.md +33 -0
- package/agent-docs/publish/single-source-sites.sections/include-additional-sections-in-a-build.md +47 -0
- package/agent-docs/publish/single-source-sites.sections/related-reading.md +43 -0
- package/agent-docs/publish/single-source-sites.sections/select-the-pages-for-each-site.md +74 -0
- package/agent-docs/publish/single-source-sites.sections/share-the-base-configuration.md +93 -0
- package/agent-docs/reference/agent-skills.md +2 -2
- package/agent-docs/search-index.json +1 -1
- package/agent-docs/start.md +1 -1
- package/agent-docs/start.sections/start-your-own-project.md +1 -1
- package/assets/search-lexical.js +15 -4
- package/dist/code-reference-model.d.ts +4 -4
- package/dist/compiler.d.ts +8 -0
- package/dist/compiler.js +10 -4
- package/dist/component-names.js +1 -1
- package/dist/component-transform.js +14 -22
- package/dist/conditional-tree.d.ts +2 -0
- package/dist/conditional-tree.js +14 -0
- package/dist/content-delivery-contract.d.ts +39 -0
- package/dist/content-delivery-contract.js +2 -0
- package/dist/content-delivery-validation.d.ts +6 -0
- package/dist/content-delivery-validation.js +6 -0
- package/dist/content-delivery.d.ts +19 -1
- package/dist/content-delivery.js +10 -1
- package/dist/content-export-command.d.ts +42 -3
- package/dist/content-export.d.ts +42 -3
- package/dist/content-export.js +15 -6
- package/dist/content-filter.d.ts +2 -0
- package/dist/content-filter.js +4 -0
- package/dist/content-mount.d.ts +12 -1
- package/dist/content-mount.js +8 -1
- package/dist/content-rest-client.d.ts +11 -1
- package/dist/content-rest-client.js +4 -1
- package/dist/content-rest-contract.d.ts +5 -0
- package/dist/content-source.d.ts +1 -0
- package/dist/content-workspace.d.ts +4 -1
- package/dist/content-workspace.js +5 -2
- package/dist/deployment-profile.d.ts +3 -1
- package/dist/deployment-profile.js +18 -19
- package/dist/palettes.d.ts +1 -1
- package/dist/publication-manifest.js +1 -1
- package/dist/representation-tree.js +8 -2
- package/dist/search-query.js +13 -6
- package/dist/section-selection.d.ts +29 -0
- package/dist/section-selection.js +92 -0
- package/dist/snippets.d.ts +1 -0
- package/example-configs/facet-sections/README.md +37 -0
- package/example-configs/facet-sections/base.yaml +29 -0
- package/example-configs/facet-sections/content/billing.mdx +25 -0
- package/example-configs/facet-sections/customer.config.yaml +4 -0
- package/example-configs/facet-sections/docs.config.yaml +3 -0
- package/example-configs/faceted-sites/README.md +4 -2
- package/package.json +2 -1
- package/skills/shoalrun-author/SKILL.md +13 -0
- package/skills/shoalrun-author/references/code-api-references.md +5 -1
- package/skills/shoalrun-author/references/facet-selection.md +48 -0
- package/skills/shoalrun-brand/SKILL.md +9 -0
- package/skills/shoalrun-component-author/SKILL.md +9 -0
- package/skills/shoalrun-pdf/SKILL.md +9 -0
- package/skills/shoalrun-recipes/SKILL.md +9 -0
- package/skills/shoalrun-setup/SKILL.md +9 -0
- package/skills/shoalrun-walkthrough/SKILL.md +9 -0
package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrepresentation.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
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.ContentRepresentation
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRepresentation`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRepresentation = ContentAsset & {
|
|
27
|
+
anchors: ContentAnchor[];
|
|
28
|
+
links: ContentLink[];
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
One portable format, including its file metadata, anchors, and typed links.
|
|
33
|
+
|
|
34
|
+
### Fields
|
|
35
|
+
|
|
36
|
+
| Name | Type | Required / default | Description |
|
|
37
|
+
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
38
|
+
| [`anchors`](https://www.shoalrun.com/content-delivery/sdk/content-representation/anchors.md) | [`ContentAnchor`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentanchor)`[]` | Required | — |
|
|
39
|
+
| [`links`](https://www.shoalrun.com/content-delivery/sdk/content-representation/links.md) | [`ContentLink`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentlink)`[]` | Required | — |
|
|
@@ -0,0 +1,62 @@
|
|
|
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.ContentResource
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentResource`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentResource = {
|
|
27
|
+
ref: ContentRef;
|
|
28
|
+
publication: ContentPublication;
|
|
29
|
+
title: string;
|
|
30
|
+
summary: string;
|
|
31
|
+
type: string;
|
|
32
|
+
canonicalUrl?: string;
|
|
33
|
+
source?: {
|
|
34
|
+
documentId?: string;
|
|
35
|
+
snippetId?: string;
|
|
36
|
+
valuesDigest?: string;
|
|
37
|
+
};
|
|
38
|
+
representations: Partial<Record<ContentFormat, ContentRepresentation>>;
|
|
39
|
+
assets: string[];
|
|
40
|
+
externalDependencies: Array<{
|
|
41
|
+
url: string;
|
|
42
|
+
kind: 'image';
|
|
43
|
+
}>;
|
|
44
|
+
};
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Inventory entry describing one exported document, section, or snippet instance.
|
|
48
|
+
|
|
49
|
+
### Fields
|
|
50
|
+
|
|
51
|
+
| Name | Type | Required / default | Description |
|
|
52
|
+
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------- |
|
|
53
|
+
| [`assets`](https://www.shoalrun.com/content-delivery/sdk/content-resource/assets.md) | `string[]` | Required | — |
|
|
54
|
+
| [`canonicalUrl`](https://www.shoalrun.com/content-delivery/sdk/content-resource/canonical-url.md) | `string \| undefined` | Optional | — |
|
|
55
|
+
| [`externalDependencies`](https://www.shoalrun.com/content-delivery/sdk/content-resource/external-dependencies.md) | `{ url: string; kind: "image"; }[]` | Required | — |
|
|
56
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-resource/publication.md) | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentpublication) | Required | Exact product, channel, version, and documentation language. |
|
|
57
|
+
| [`ref`](https://www.shoalrun.com/content-delivery/sdk/content-resource/ref.md) | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentref) | Required | Stable identity used by ContentSnapshot.get. |
|
|
58
|
+
| [`representations`](https://www.shoalrun.com/content-delivery/sdk/content-resource/representations.md) | `Partial<Record<`[`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentformat)`, `[`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentrepresentation)`>>` | Required | Available portable formats and their files, anchors, and typed links. |
|
|
59
|
+
| [`source`](https://www.shoalrun.com/content-delivery/sdk/content-resource/source.md) | `{ documentId?: string; snippetId?: string; valuesDigest?: string; } \| undefined` | Optional | — |
|
|
60
|
+
| [`summary`](https://www.shoalrun.com/content-delivery/sdk/content-resource/summary.md) | `string` | Required | Short explanation of the resource's purpose. |
|
|
61
|
+
| [`title`](https://www.shoalrun.com/content-delivery/sdk/content-resource/title.md) | `string` | Required | Human-readable resource title. |
|
|
62
|
+
| [`type`](https://www.shoalrun.com/content-delivery/sdk/content-resource/type.md) | `string` | Required | Authored document type, or section/snippet for a selected resource. |
|
package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresourcekey.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
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.contentResourceKey
|
|
22
|
+
|
|
23
|
+
**Function** `shoalrun.content.contentResourceKey`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
contentResourceKey(ref: ContentRef): string
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Public identity only: independent of publication, revision, and export filenames.
|
|
30
|
+
|
|
31
|
+
### Parameters
|
|
32
|
+
|
|
33
|
+
| Parameter | Type / default | Description |
|
|
34
|
+
| --------- | ---------------------------------------------------------------------------------------------------- | ----------- |
|
|
35
|
+
| `ref` | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentref) | — |
|
|
36
|
+
|
|
37
|
+
### Returns
|
|
38
|
+
|
|
39
|
+
`string`
|
|
@@ -0,0 +1,39 @@
|
|
|
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.ContentRestEntry
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRestEntry`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRestEntry = {
|
|
27
|
+
key: string;
|
|
28
|
+
resource: ContentResource;
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
One resource inventory entry with its REST lookup key.
|
|
33
|
+
|
|
34
|
+
### Fields
|
|
35
|
+
|
|
36
|
+
| Name | Type | Required / default | Description |
|
|
37
|
+
| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
38
|
+
| [`key`](https://www.shoalrun.com/content-delivery/sdk/content-rest-entry/key.md) | `string` | Required | — |
|
|
39
|
+
| [`resource`](https://www.shoalrun.com/content-delivery/sdk/content-rest-entry/resource.md) | [`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentresource) | Required | — |
|
|
@@ -0,0 +1,40 @@
|
|
|
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.ContentRestError
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRestError`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRestError = {
|
|
27
|
+
error: {
|
|
28
|
+
code: ContentRestErrorCode;
|
|
29
|
+
message: string;
|
|
30
|
+
};
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
JSON error envelope returned by the content REST service.
|
|
35
|
+
|
|
36
|
+
### Fields
|
|
37
|
+
|
|
38
|
+
| Name | Type | Required / default | Description |
|
|
39
|
+
| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
40
|
+
| [`error`](https://www.shoalrun.com/content-delivery/sdk/content-rest-error/error.md) | `{ code: `[`ContentRestErrorCode`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentresterrorcode)`; message: string; }` | Required | — |
|
package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentresterrorcode.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
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.ContentRestErrorCode
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRestErrorCode`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRestErrorCode = 'invalid_request' | 'not_found' | 'unsupported_format' | 'stale_revision' | 'method_not_allowed' | 'internal_error';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Error categories used by the content REST protocol.
|
|
@@ -0,0 +1,43 @@
|
|
|
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.ContentRestList
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRestList`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRestList = {
|
|
27
|
+
schemaVersion: 1 | 2;
|
|
28
|
+
revision: string;
|
|
29
|
+
publication: ContentPublication;
|
|
30
|
+
resources: ContentRestEntry[];
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Revision-scoped inventory envelope returned by the content REST service.
|
|
35
|
+
|
|
36
|
+
### Fields
|
|
37
|
+
|
|
38
|
+
| Name | Type | Required / default | Description |
|
|
39
|
+
| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
40
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-rest-list/publication.md) | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentpublication) | Required | — |
|
|
41
|
+
| [`resources`](https://www.shoalrun.com/content-delivery/sdk/content-rest-list/resources.md) | [`ContentRestEntry`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentrestentry)`[]` | Required | — |
|
|
42
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/content-rest-list/revision.md) | `string` | Required | — |
|
|
43
|
+
| [`schemaVersion`](https://www.shoalrun.com/content-delivery/sdk/content-rest-list/schema-version.md) | `1 \| 2` | Required | — |
|
package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-contentrestresource.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
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.ContentRestResource
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentRestResource`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentRestResource = {
|
|
27
|
+
schemaVersion: 1 | 2;
|
|
28
|
+
revision: string;
|
|
29
|
+
publication: ContentPublication;
|
|
30
|
+
key: string;
|
|
31
|
+
resource: ContentResource;
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Revision-scoped metadata envelope for a single content resource.
|
|
36
|
+
|
|
37
|
+
### Fields
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required / default | Description |
|
|
40
|
+
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
41
|
+
| [`key`](https://www.shoalrun.com/content-delivery/sdk/content-rest-resource/key.md) | `string` | Required | — |
|
|
42
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-rest-resource/publication.md) | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentpublication) | Required | — |
|
|
43
|
+
| [`resource`](https://www.shoalrun.com/content-delivery/sdk/content-rest-resource/resource.md) | [`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentresource) | Required | — |
|
|
44
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/content-rest-resource/revision.md) | `string` | Required | — |
|
|
45
|
+
| [`schemaVersion`](https://www.shoalrun.com/content-delivery/sdk/content-rest-resource/schema-version.md) | `1 \| 2` | Required | — |
|
|
@@ -0,0 +1,45 @@
|
|
|
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.ContentResult
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ContentResult`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ContentResult = {
|
|
27
|
+
resource: Readonly<ContentResource>;
|
|
28
|
+
representation: Readonly<ContentRepresentation>;
|
|
29
|
+
format: ContentFormat;
|
|
30
|
+
content: string;
|
|
31
|
+
revision: string;
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
A fetched representation together with the metadata needed to render or route it.
|
|
36
|
+
|
|
37
|
+
### Fields
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required / default | Description |
|
|
40
|
+
| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------- |
|
|
41
|
+
| [`content`](https://www.shoalrun.com/content-delivery/sdk/content-result/content.md) | `string` | Required | Validated UTF-8 HTML or Markdown text. |
|
|
42
|
+
| [`format`](https://www.shoalrun.com/content-delivery/sdk/content-result/format.md) | [`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentformat) | Required | Representation actually returned by the source. |
|
|
43
|
+
| [`representation`](https://www.shoalrun.com/content-delivery/sdk/content-result/representation.md) | `Readonly<`[`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentrepresentation)`>` | Required | File, media type, anchors, and typed links for the selected format. |
|
|
44
|
+
| [`resource`](https://www.shoalrun.com/content-delivery/sdk/content-result/resource.md) | `Readonly<`[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentresource)`>` | Required | Inventory entry that was selected by the requested reference. |
|
|
45
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/content-result/revision.md) | `string` | Required | Revision shared by this response and its opened content snapshot. |
|
|
@@ -0,0 +1,44 @@
|
|
|
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.ContentSnapshot
|
|
22
|
+
|
|
23
|
+
**Interface** `shoalrun.content.ContentSnapshot`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
interface ContentSnapshot
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
A client pinned to one immutable inventory revision and publication.
|
|
30
|
+
|
|
31
|
+
### Fields
|
|
32
|
+
|
|
33
|
+
| Name | Type | Required / default | Description |
|
|
34
|
+
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------ |
|
|
35
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot/publication.md) | `Readonly<`[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentpublication)`>` | Required | Publication shared by every resource available from this snapshot. |
|
|
36
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot/revision.md) | `string` | Required | Content digest identifying this inventory revision. |
|
|
37
|
+
|
|
38
|
+
### Methods
|
|
39
|
+
|
|
40
|
+
| Name | Kind | Description |
|
|
41
|
+
| -------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------- |
|
|
42
|
+
| [`dispose`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot/dispose.md) | `method` | Cancel pending requests and prevent subsequent reads or inventory access. |
|
|
43
|
+
| [`get`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot/get.md) | `method` | Fetch one available representation of a stable content reference. |
|
|
44
|
+
| [`list`](https://www.shoalrun.com/content-delivery/sdk/content-snapshot/list.md) | `method` | List the resources in the opened inventory without fetching their bodies. |
|
|
@@ -0,0 +1,43 @@
|
|
|
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.ManifestContentSourceOptions
|
|
22
|
+
|
|
23
|
+
**Type** `shoalrun.content.ManifestContentSourceOptions`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
type ManifestContentSourceOptions = {
|
|
27
|
+
manifestUrl: string | URL;
|
|
28
|
+
fetch?: typeof globalThis.fetch;
|
|
29
|
+
signal?: AbortSignal;
|
|
30
|
+
limits?: ContentDeliveryLimits;
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Configuration for opening a static content-export manifest.
|
|
35
|
+
|
|
36
|
+
### Fields
|
|
37
|
+
|
|
38
|
+
| Name | Type | Required / default | Description |
|
|
39
|
+
| -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------- |
|
|
40
|
+
| [`fetch`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options/fetch.md) | `((input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>) \| undefined` | Optional | Fetch implementation. Defaults to globalThis.fetch. |
|
|
41
|
+
| [`limits`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options/limits.md) | [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentdeliverylimits)` \| undefined` | Optional | Inventory and representation bounds. |
|
|
42
|
+
| [`manifestUrl`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options/manifest-url.md) | `string \| URL` | Required | Manifest URL; a browser resolves relative URLs against its current location. |
|
|
43
|
+
| [`signal`](https://www.shoalrun.com/content-delivery/sdk/manifest-content-source-options/signal.md) | `AbortSignal \| undefined` | Optional | Cancel the opening request. Use get's signal to cancel an individual read. |
|
|
@@ -0,0 +1,45 @@
|
|
|
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.mountContent
|
|
22
|
+
|
|
23
|
+
**Function** `shoalrun.content.mountContent`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
mountContent(container: Element, result: ContentResult, options?: { instanceId?: string; signal?: AbortSignal; }): ContentMount
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Mount trusted compiler HTML with instance-specific anchor and accessibility IDs.
|
|
30
|
+
This is not a sanitizer. The result must come from trusted compiler output.
|
|
31
|
+
The mount replaces the container's children and rewrites local routing metadata.
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
| Parameter | Type / default | Description |
|
|
36
|
+
| ----------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
37
|
+
| `container` | `Element` | DOM element receiving the content. |
|
|
38
|
+
| `result` | [`ContentResult`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentresult) | A validated HTML representation; Markdown results aren't accepted. |
|
|
39
|
+
| `options` | `{ instanceId?: string; signal?: AbortSignal; } \| undefined` | Optional unique instance ID and cancellation signal. |
|
|
40
|
+
|
|
41
|
+
### Returns
|
|
42
|
+
|
|
43
|
+
[`ContentMount`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentmount)
|
|
44
|
+
|
|
45
|
+
Rewritten anchors, typed links, and an unmount handle.
|
|
@@ -0,0 +1,51 @@
|
|
|
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.openManifestContentSource
|
|
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/exports.md#shoalrun-content-manifestcontentsourceoptions) | Manifest URL, request implementation, cancellation, and limits. |
|
|
38
|
+
|
|
39
|
+
### Returns
|
|
40
|
+
|
|
41
|
+
`Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentsnapshot)`>`
|
|
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
|
+
```
|
package/agent-docs/content-delivery/sdk/exports.sections/shoalrun-content-openrestcontentsource.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
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.openRestContentSource
|
|
22
|
+
|
|
23
|
+
**Function** `shoalrun.content.openRestContentSource`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
openRestContentSource(options: RestContentSourceOptions): Promise<ContentSnapshot>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Open a REST inventory and pin subsequent resource reads to its revision.
|
|
30
|
+
|
|
31
|
+
### Parameters
|
|
32
|
+
|
|
33
|
+
| Parameter | Type / default | Description |
|
|
34
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
35
|
+
| `options` | [`RestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-restcontentsourceoptions) | REST mount, exact publication, optional revision, and request settings. |
|
|
36
|
+
|
|
37
|
+
### Returns
|
|
38
|
+
|
|
39
|
+
`Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/exports.md#shoalrun-content-contentsnapshot)`>`
|
|
40
|
+
|
|
41
|
+
A snapshot with the same list/get/dispose interface as the manifest source.
|