@shoalrun/cli 0.1.0-beta.1 → 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 +36 -0
- package/CODE-REFERENCES.md +156 -0
- package/README.md +18 -6
- package/adapters/python/requirements.txt +1 -0
- package/adapters/python/shoalrun_reference.py +234 -0
- 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 +6 -2
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/about.md +3 -3
- package/agent-docs/api-docs/code-reference-settings.md +160 -0
- package/agent-docs/api-docs/code-reference-settings.sections/catalog-settings.md +50 -0
- package/agent-docs/api-docs/code-reference-settings.sections/complete-reference-page.md +46 -0
- package/agent-docs/api-docs/code-reference-settings.sections/converter-snapshot.md +58 -0
- package/agent-docs/api-docs/code-reference-settings.sections/descriptions-type-links-and-source-links.md +40 -0
- package/agent-docs/api-docs/code-reference-settings.sections/html-markdown-and-agents.md +38 -0
- package/agent-docs/api-docs/code-reference-settings.sections/metadata-and-selection.md +38 -0
- package/agent-docs/api-docs/code-reference-settings.sections/publication-sources.md +54 -0
- package/agent-docs/api-docs/code-reference-settings.sections/python-adapter-limits.md +38 -0
- package/agent-docs/api-docs/code-reference-settings.sections/related-reading.md +32 -0
- package/agent-docs/api-docs/code-reference-settings.sections/symbol-fields.md +56 -0
- package/agent-docs/api-docs/code-references.md +151 -0
- 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/agent-overview.md +2 -2
- 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/code-api-references.md +44 -0
- package/agent-docs/changelog/facet-typescript.md +54 -0
- package/agent-docs/changelog.md +17 -1
- package/agent-docs/cli.md +11 -1
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +1 -1
- package/agent-docs/cli.sections/author-pages.md +1 -1
- package/agent-docs/cli.sections/build-and-serve.md +1 -1
- package/agent-docs/cli.sections/inspect-config-and-operations.md +1 -1
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +1 -1
- package/agent-docs/cli.sections/related-reading.md +1 -1
- package/agent-docs/cli.sections/search-and-chat.md +1 -1
- package/agent-docs/cli.sections/start-a-project.md +1 -1
- package/agent-docs/cli.sections/validate-code-reference-snapshots.md +41 -0
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +1 -1
- package/agent-docs/config/apis.md +5 -1
- package/agent-docs/config/examples.md +3 -3
- package/agent-docs/config/examples.sections/feature-showcase.md +3 -3
- package/agent-docs/config/examples.sections/minimal-site.md +2 -2
- package/agent-docs/config/examples.sections/multilingual-help-center.md +2 -2
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +2 -2
- package/agent-docs/config/examples.sections/related-reading.md +2 -2
- package/agent-docs/config/examples.sections/shared-company-preset.md +2 -2
- 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/config.md +2 -2
- package/agent-docs/configuration.md +2 -2
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +1 -1
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +1 -1
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +1 -1
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +1 -1
- package/agent-docs/configuration.sections/related-reading.md +1 -1
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +1 -1
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +1 -1
- package/agent-docs/configuration.sections/start-with-one-working-file.md +2 -2
- package/agent-docs/configuration.sections/understand-the-three-stages.md +1 -1
- package/agent-docs/configuration.sections/understand-where-paths-point.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 +7710 -530
- package/agent-docs/features.md +20 -18
- package/agent-docs/provenance.json +6 -6
- package/agent-docs/publish/api-references.md +3 -1
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +3 -1
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +3 -1
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +3 -1
- package/agent-docs/publish/api-references.sections/next-steps.md +3 -1
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +3 -1
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +3 -1
- package/agent-docs/publish/api-references.sections/register-the-operation.md +3 -1
- package/agent-docs/publish/api-references.sections/related-reading.md +3 -1
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +3 -1
- package/agent-docs/publish/api-references.sections/what-readers-get.md +3 -1
- 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 +3 -3
- package/agent-docs/start.sections/add-the-page-to-navigation.md +2 -2
- package/agent-docs/start.sections/build-and-check-both-outputs.md +2 -2
- package/agent-docs/start.sections/build-this-site.md +2 -2
- package/agent-docs/start.sections/check-writing-style.md +2 -2
- package/agent-docs/start.sections/create-a-page.md +2 -2
- package/agent-docs/start.sections/make-it-yours.md +2 -2
- package/agent-docs/start.sections/migrating-from-github-packages.md +2 -2
- package/agent-docs/start.sections/prerequisites.md +2 -2
- package/agent-docs/start.sections/related-reading.md +2 -2
- package/agent-docs/start.sections/start-your-own-project.md +3 -3
- package/agent-docs/status.md +6 -4
- package/agent-docs/styling/themes.md +7 -3
- package/agent-docs/what-is-shoalrun.md +2 -2
- package/assets/search-lexical.js +15 -4
- package/dist/artifact-bundle.d.ts +1 -0
- package/dist/artifact-bundle.js +11 -3
- package/dist/cli-discovery.d.ts +1 -1
- package/dist/cli-discovery.js +1 -0
- package/dist/cli.js +7 -0
- package/dist/code-reference-model.d.ts +85 -0
- package/dist/code-reference-model.js +73 -0
- package/dist/code-references.d.ts +23 -0
- package/dist/code-references.js +371 -0
- package/dist/compiler-config.d.ts +1 -0
- package/dist/compiler.d.ts +8 -0
- package/dist/compiler.js +14 -7
- 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/config.js +1 -1
- 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 +2 -0
- package/dist/content-workspace.d.ts +5 -1
- package/dist/content-workspace.js +7 -2
- package/dist/deployment-profile.d.ts +3 -1
- package/dist/deployment-profile.js +18 -19
- package/dist/fonts.d.ts +9 -0
- package/dist/fonts.js +58 -3
- package/dist/page-materialization.js +3 -2
- package/dist/page-renderer.d.ts +1 -0
- package/dist/page-renderer.js +3 -1
- package/dist/palettes.d.ts +1 -1
- package/dist/publication-manifest.js +1 -1
- package/dist/publication-render.d.ts +2 -1
- package/dist/publication-render.js +2 -2
- package/dist/representation-tree.js +12 -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/examples/code-references/content/start.md +53 -0
- package/examples/code-references/docs.config.yaml +262 -0
- package/examples/code-references/python/orchard/__init__.py +11 -0
- package/examples/code-references/python/orchard/client.py +212 -0
- package/examples/code-references/python/orchard/errors.py +31 -0
- package/examples/code-references/python/orchard/models.py +69 -0
- package/examples/code-references/python/orchard/pagination.py +39 -0
- package/examples/code-references/reference.json +1244 -0
- package/package.json +9 -1
- package/schemas/code-reference.schema.json +306 -0
- package/skills/shoalrun-author/SKILL.md +17 -0
- package/skills/shoalrun-author/references/code-api-references.md +19 -0
- 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/styles/site.css +61 -2
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentresult-revision.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentResult.revision
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ContentResult.revision`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
revision: string
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Revision shared by this response and its opened content snapshot.
|
|
33
|
+
|
|
34
|
+
**Type: **`string`
|
|
35
|
+
|
|
36
|
+
Required
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentResult
|
|
25
|
+
|
|
26
|
+
**Type** `shoalrun.content.ContentResult`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
type ContentResult = {
|
|
30
|
+
resource: Readonly<ContentResource>;
|
|
31
|
+
representation: Readonly<ContentRepresentation>;
|
|
32
|
+
format: ContentFormat;
|
|
33
|
+
content: string;
|
|
34
|
+
revision: string;
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
A fetched representation together with the metadata needed to render or route it.
|
|
39
|
+
|
|
40
|
+
### Fields
|
|
41
|
+
|
|
42
|
+
| Name | Type | Required / default | Description |
|
|
43
|
+
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------- |
|
|
44
|
+
| [`content`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult-content) | `string` | Required | Validated UTF-8 HTML or Markdown text. |
|
|
45
|
+
| [`format`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult-format) | [`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentformat) | Required | Representation actually returned by the source. |
|
|
46
|
+
| [`representation`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult-representation) | `Readonly<`[`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrepresentation)`>` | Required | File, media type, anchors, and typed links for the selected format. |
|
|
47
|
+
| [`resource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult-resource) | `Readonly<`[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresource)`>` | Required | Inventory entry that was selected by the requested reference. |
|
|
48
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult-revision) | `string` | Required | Revision shared by this response and its opened content snapshot. |
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-dispose.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot.dispose
|
|
25
|
+
|
|
26
|
+
**Method** `shoalrun.content.ContentSnapshot.dispose`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
dispose(): void
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Cancel pending requests and prevent subsequent reads or inventory access.
|
|
33
|
+
|
|
34
|
+
### Returns
|
|
35
|
+
|
|
36
|
+
`void`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot.get
|
|
25
|
+
|
|
26
|
+
**Method** `shoalrun.content.ContentSnapshot.get`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
get(ref: ContentRef, options: { format: ContentFormat; signal?: AbortSignal; }): Promise<ContentResult>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Fetch one available representation of a stable content reference.
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
| Parameter | Type / default | Description |
|
|
37
|
+
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
38
|
+
| `ref` | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentref) | Page, section, or named snippet instance in this snapshot. |
|
|
39
|
+
| `options` | `{ format: `[`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentformat)`; signal?: AbortSignal; }` | Required format and an optional signal for this read. |
|
|
40
|
+
|
|
41
|
+
### Returns
|
|
42
|
+
|
|
43
|
+
`Promise<`[`ContentResult`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult)`>`
|
|
44
|
+
|
|
45
|
+
Validated representation text with its routing and revision metadata.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot.list
|
|
25
|
+
|
|
26
|
+
**Method** `shoalrun.content.ContentSnapshot.list`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
list(): readonly Readonly<ContentResource>[]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
List the resources in the opened inventory without fetching their bodies.
|
|
33
|
+
|
|
34
|
+
### Returns
|
|
35
|
+
|
|
36
|
+
`readonly Readonly<`[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresource)`>[]`
|
|
37
|
+
|
|
38
|
+
Read-only resource entries for this publication and revision.
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-publication.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot.publication
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ContentSnapshot.publication`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
readonly publication: Readonly<ContentPublication>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Publication shared by every resource available from this snapshot.
|
|
33
|
+
|
|
34
|
+
**Type: **`Readonly<`[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentpublication)`>`
|
|
35
|
+
|
|
36
|
+
Required
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-contentsnapshot-revision.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot.revision
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ContentSnapshot.revision`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
readonly revision: string
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Content digest identifying this inventory revision.
|
|
33
|
+
|
|
34
|
+
**Type: **`string`
|
|
35
|
+
|
|
36
|
+
Required
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ContentSnapshot
|
|
25
|
+
|
|
26
|
+
**Interface** `shoalrun.content.ContentSnapshot`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
interface ContentSnapshot
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
A client pinned to one immutable inventory revision and publication.
|
|
33
|
+
|
|
34
|
+
### Fields
|
|
35
|
+
|
|
36
|
+
| Name | Type | Required / default | Description |
|
|
37
|
+
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------ |
|
|
38
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot-publication) | `Readonly<`[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentpublication)`>` | Required | Publication shared by every resource available from this snapshot. |
|
|
39
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot-revision) | `string` | Required | Content digest identifying this inventory revision. |
|
|
40
|
+
|
|
41
|
+
### Methods
|
|
42
|
+
|
|
43
|
+
| Name | Kind | Description |
|
|
44
|
+
| ---------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------- |
|
|
45
|
+
| [`dispose`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot-dispose) | `method` | Cancel pending requests and prevent subsequent reads or inventory access. |
|
|
46
|
+
| [`get`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot-get) | `method` | Fetch one available representation of a stable content reference. |
|
|
47
|
+
| [`list`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot-list) | `method` | List the resources in the opened inventory without fetching their bodies. |
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ManifestContentSourceOptions.fetch
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ManifestContentSourceOptions.fetch`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Fetch implementation. Defaults to globalThis.fetch.
|
|
33
|
+
|
|
34
|
+
**Type: **`((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined`
|
|
35
|
+
|
|
36
|
+
Optional
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ManifestContentSourceOptions.limits
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ManifestContentSourceOptions.limits`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
limits?: ContentDeliveryLimits | undefined
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Inventory and representation bounds.
|
|
33
|
+
|
|
34
|
+
**Type: **[`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentdeliverylimits)` | undefined`
|
|
35
|
+
|
|
36
|
+
Optional
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ManifestContentSourceOptions.manifestUrl
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ManifestContentSourceOptions.manifestUrl`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
manifestUrl: string | URL
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Manifest URL; a browser resolves relative URLs against its current location.
|
|
33
|
+
|
|
34
|
+
**Type: **`string | URL`
|
|
35
|
+
|
|
36
|
+
Required
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ManifestContentSourceOptions.signal
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.ManifestContentSourceOptions.signal`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
signal?: AbortSignal | undefined
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Cancel the opening request. Use get's signal to cancel an individual read.
|
|
33
|
+
|
|
34
|
+
**Type: **`AbortSignal | undefined`
|
|
35
|
+
|
|
36
|
+
Optional
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.ManifestContentSourceOptions
|
|
25
|
+
|
|
26
|
+
**Type** `shoalrun.content.ManifestContentSourceOptions`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
type ManifestContentSourceOptions = {
|
|
30
|
+
manifestUrl: string | URL;
|
|
31
|
+
fetch?: typeof globalThis.fetch;
|
|
32
|
+
signal?: AbortSignal;
|
|
33
|
+
limits?: ContentDeliveryLimits;
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Configuration for opening a static content-export manifest.
|
|
38
|
+
|
|
39
|
+
### Fields
|
|
40
|
+
|
|
41
|
+
| Name | Type | Required / default | Description |
|
|
42
|
+
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------- |
|
|
43
|
+
| [`fetch`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions-fetch) | `((input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>) \| undefined` | Optional | Fetch implementation. Defaults to globalThis.fetch. |
|
|
44
|
+
| [`limits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions-limits) | [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentdeliverylimits)` \| undefined` | Optional | Inventory and representation bounds. |
|
|
45
|
+
| [`manifestUrl`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions-manifesturl) | `string \| URL` | Required | Manifest URL; a browser resolves relative URLs against its current location. |
|
|
46
|
+
| [`signal`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions-signal) | `AbortSignal \| undefined` | Optional | Cancel the opening request. Use get's signal to cancel an individual read. |
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.mountContent
|
|
25
|
+
|
|
26
|
+
**Function** `shoalrun.content.mountContent`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
mountContent(container: Element, result: ContentResult, options?: { instanceId?: string; signal?: AbortSignal; }): ContentMount
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Mount trusted compiler HTML with instance-specific anchor and accessibility IDs.
|
|
33
|
+
This is not a sanitizer. The result must come from trusted compiler output.
|
|
34
|
+
The mount replaces the container's children and rewrites local routing metadata.
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type / default | Description |
|
|
39
|
+
| ----------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
|
40
|
+
| `container` | `Element` | DOM element receiving the content. |
|
|
41
|
+
| `result` | [`ContentResult`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult) | A validated HTML representation; Markdown results aren't accepted. |
|
|
42
|
+
| `options` | `{ instanceId?: string; signal?: AbortSignal; } \| undefined` | Optional unique instance ID and cancellation signal. |
|
|
43
|
+
|
|
44
|
+
### Returns
|
|
45
|
+
|
|
46
|
+
[`ContentMount`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentmount)
|
|
47
|
+
|
|
48
|
+
Rewritten anchors, typed links, and an unmount handle.
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-openmanifestcontentsource.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.complete
|
|
3
|
+
title: Complete content client reference
|
|
4
|
+
summary: Public exports from @shoalrun/cli/content, with signatures and JSDoc
|
|
5
|
+
from TypeScript declarations.
|
|
6
|
+
type: code-reference
|
|
7
|
+
area: publishing
|
|
8
|
+
subarea: publishing-content-delivery
|
|
9
|
+
canonical: /content-delivery/sdk/all
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Complete content client reference
|
|
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 > TypeScript symbols > Complete reference
|
|
19
|
+
|
|
20
|
+
**Updated: 2026-11-07.**
|
|
21
|
+
|
|
22
|
+
Parent page: [Full Markdown page](/content-delivery/sdk/all.md)
|
|
23
|
+
|
|
24
|
+
## shoalrun.content.openManifestContentSource
|
|
25
|
+
|
|
26
|
+
**Function** `shoalrun.content.openManifestContentSource`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
openManifestContentSource(options: ManifestContentSourceOptions): Promise<ContentSnapshot>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Open and validate one immutable static manifest revision.
|
|
33
|
+
The caller owns trust in the compiler output and host. Browser URLs must use
|
|
34
|
+
the application's origin. Requests reject redirects and unexpected content types.
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type / default | Description |
|
|
39
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
|
|
40
|
+
| `options` | [`ManifestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions) | Manifest URL, request implementation, cancellation, and limits. |
|
|
41
|
+
|
|
42
|
+
### Returns
|
|
43
|
+
|
|
44
|
+
`Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot)`>`
|
|
45
|
+
|
|
46
|
+
A revision-pinned snapshot for listing and reading exported resources.
|
|
47
|
+
|
|
48
|
+
### Examples
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
const snapshot = await openManifestContentSource({ manifestUrl: '/help/manifest.json' });
|
|
52
|
+
const page = await snapshot.get({ kind: 'page', documentId: 'guide.start' }, { format: 'markdown' });
|
|
53
|
+
snapshot.dispose();
|
|
54
|
+
```
|