@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/all.sections/shoalrun-content-openrestcontentsource.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
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.openRestContentSource
|
|
25
|
+
|
|
26
|
+
**Function** `shoalrun.content.openRestContentSource`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
openRestContentSource(options: RestContentSourceOptions): Promise<ContentSnapshot>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Open a REST inventory and pin subsequent resource reads to its revision.
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
| Parameter | Type / default | Description |
|
|
37
|
+
| --------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
38
|
+
| `options` | [`RestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions) | REST mount, exact publication, optional revision, and request settings. |
|
|
39
|
+
|
|
40
|
+
### Returns
|
|
41
|
+
|
|
42
|
+
`Promise<`[`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot)`>`
|
|
43
|
+
|
|
44
|
+
A snapshot with the same list/get/dispose interface as the manifest source.
|
|
@@ -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.RestContentSourceOptions.baseUrl
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.baseUrl`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
baseUrl: string | URL
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
REST mount URL, such as /content/v1. Browser requests must use the application's origin.
|
|
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.RestContentSourceOptions.fetch
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.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.RestContentSourceOptions.limits
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.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.RestContentSourceOptions.publication
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.publication`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
publication: ContentPublication
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Exact publication to request; include product for a product-scoped source.
|
|
33
|
+
|
|
34
|
+
**Type: **[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentpublication)
|
|
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.RestContentSourceOptions.revision
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.revision`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
revision?: string | undefined
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Expected inventory revision. Omit it to open the current revision.
|
|
33
|
+
|
|
34
|
+
**Type: **`string | 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.RestContentSourceOptions.signal
|
|
25
|
+
|
|
26
|
+
**Property** `shoalrun.content.RestContentSourceOptions.signal`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
signal?: AbortSignal | undefined
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Cancel the inventory-opening request.
|
|
33
|
+
|
|
34
|
+
**Type: **`AbortSignal | undefined`
|
|
35
|
+
|
|
36
|
+
Optional
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-restcontentsourceoptions.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
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.RestContentSourceOptions
|
|
25
|
+
|
|
26
|
+
**Type** `shoalrun.content.RestContentSourceOptions`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
type RestContentSourceOptions = {
|
|
30
|
+
baseUrl: string | URL;
|
|
31
|
+
publication: ContentPublication;
|
|
32
|
+
revision?: string;
|
|
33
|
+
fetch?: typeof globalThis.fetch;
|
|
34
|
+
signal?: AbortSignal;
|
|
35
|
+
limits?: ContentDeliveryLimits;
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Options for a REST inventory and its revision-pinned resource reads.
|
|
40
|
+
|
|
41
|
+
### Fields
|
|
42
|
+
|
|
43
|
+
| Name | Type | Required / default | Description |
|
|
44
|
+
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------- |
|
|
45
|
+
| [`baseUrl`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-baseurl) | `string \| URL` | Required | REST mount URL, such as /content/v1. Browser requests must use the application's origin. |
|
|
46
|
+
| [`fetch`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-fetch) | `((input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>) \| undefined` | Optional | Fetch implementation. Defaults to globalThis.fetch. |
|
|
47
|
+
| [`limits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-limits) | [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentdeliverylimits)` \| undefined` | Optional | Inventory and representation bounds. |
|
|
48
|
+
| [`publication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-publication) | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentpublication) | Required | Exact publication to request; include product for a product-scoped source. |
|
|
49
|
+
| [`revision`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-revision) | `string \| undefined` | Optional | Expected inventory revision. Omit it to open the current revision. |
|
|
50
|
+
| [`signal`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions-signal) | `AbortSignal \| undefined` | Optional | Cancel the inventory-opening request. |
|
package/agent-docs/content-delivery/sdk/all.sections/shoalrun-content-validatecontentmanifest.md
ADDED
|
@@ -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.validateContentManifest
|
|
25
|
+
|
|
26
|
+
**Function** `shoalrun.content.validateContentManifest`
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
validateContentManifest(value: any, maxResources?: number, maxResourceBytes?: number): asserts value is ContentManifest
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Validate a parsed manifest's shape, identities, paths, and resource bounds.
|
|
33
|
+
This assertion narrows the value but doesn't verify fetched file bytes or trust in a host.
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
| Parameter | Type / default | Description |
|
|
38
|
+
| ------------------ | --------------------- | ------------------------------------------------------------- |
|
|
39
|
+
| `value` | `any` | Parsed JSON manifest to validate. |
|
|
40
|
+
| `maxResources` | `number \| undefined` | Maximum allowed resource count; defaults to 10,000. |
|
|
41
|
+
| `maxResourceBytes` | `number \| undefined` | Maximum declared representation bytes; defaults to 8,000,000. |
|
|
42
|
+
|
|
43
|
+
### Returns
|
|
44
|
+
|
|
45
|
+
`void`
|
|
@@ -0,0 +1,65 @@
|
|
|
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
|
|
25
|
+
|
|
26
|
+
**Module** `shoalrun.content`
|
|
27
|
+
|
|
28
|
+
### Functions
|
|
29
|
+
|
|
30
|
+
| Name | Kind | Description |
|
|
31
|
+
| ------------------------------------------------------------------------------------------------------------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| [`contentRefKey`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrefkey) | `function` | Serialize a reference to a deterministic key without including publication scope. |
|
|
33
|
+
| [`contentResourceKey`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresourcekey) | `function` | Public identity only: independent of publication, revision, and export filenames. |
|
|
34
|
+
| [`mountContent`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-mountcontent) | `function` | Mount trusted compiler HTML with instance-specific anchor and accessibility IDs. This is not a sanitizer. The result must come from trusted compiler output. The mount replaces the container's children and rewrites local routing metadata. |
|
|
35
|
+
| [`openManifestContentSource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-openmanifestcontentsource) | `function` | Open and validate one immutable static manifest revision. The caller owns trust in the compiler output and host. Browser URLs must use the application's origin. Requests reject redirects and unexpected content types. |
|
|
36
|
+
| [`openRestContentSource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-openrestcontentsource) | `function` | Open a REST inventory and pin subsequent resource reads to its revision. |
|
|
37
|
+
| [`validateContentManifest`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-validatecontentmanifest) | `function` | Validate a parsed manifest's shape, identities, paths, and resource bounds. This assertion narrows the value but doesn't verify fetched file bytes or trust in a host. |
|
|
38
|
+
|
|
39
|
+
### Members
|
|
40
|
+
|
|
41
|
+
| Name | Kind | Description |
|
|
42
|
+
| ------------------------------------------------------------------------------------------------------------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
+
| [`ContentAnchor`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentanchor) | `type` | Mapping from a canonical document fragment to its exported HTML ID. |
|
|
44
|
+
| [`ContentAsset`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentasset) | `type` | A content-addressed file with its declared media type. |
|
|
45
|
+
| [`ContentDeliveryError`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentdeliveryerror) | `class` | Delivery failure with a machine-readable code and a human-readable message. |
|
|
46
|
+
| [`ContentDeliveryLimits`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentdeliverylimits) | `type` | Positive safe-integer bounds applied when opening and reading content. |
|
|
47
|
+
| [`ContentErrorCode`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contenterrorcode) | `type` | Stable error categories raised by content-source validation and reads. |
|
|
48
|
+
| [`ContentFile`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentfile) | `type` | Export-relative file path, byte length, and SHA-256 digest. |
|
|
49
|
+
| [`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentformat) | `type` | Portable representations a content client can request. |
|
|
50
|
+
| [`ContentLink`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentlink) | `type` | Classified link and optional resource identity for application routing. |
|
|
51
|
+
| [`ContentManifest`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentmanifest) | `type` | One validated, content-addressed export inventory. |
|
|
52
|
+
| [`ContentMount`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentmount) | `type` | Handles and rewritten routing metadata for one mounted HTML instance. |
|
|
53
|
+
| [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentpublication) | `type` | Exact documentation publication selected by a content source. |
|
|
54
|
+
| [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentref) | `type` | Stable identity of a page, a section within a page, or a named snippet instance. A reference is scoped to the publication and revision of the opened snapshot. |
|
|
55
|
+
| [`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrepresentation) | `type` | One portable format, including its file metadata, anchors, and typed links. |
|
|
56
|
+
| [`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresource) | `type` | Inventory entry describing one exported document, section, or snippet instance. |
|
|
57
|
+
| [`ContentRestEntry`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrestentry) | `type` | One resource inventory entry with its REST lookup key. |
|
|
58
|
+
| [`ContentRestError`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresterror) | `type` | JSON error envelope returned by the content REST service. |
|
|
59
|
+
| [`ContentRestErrorCode`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresterrorcode) | `type` | Error categories used by the content REST protocol. |
|
|
60
|
+
| [`ContentRestList`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrestlist) | `type` | Revision-scoped inventory envelope returned by the content REST service. |
|
|
61
|
+
| [`ContentRestResource`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentrestresource) | `type` | Revision-scoped metadata envelope for a single content resource. |
|
|
62
|
+
| [`ContentResult`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentresult) | `type` | A fetched representation together with the metadata needed to render or route it. |
|
|
63
|
+
| [`ContentSnapshot`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-contentsnapshot) | `interface` | A client pinned to one immutable inventory revision and publication. |
|
|
64
|
+
| [`ManifestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-manifestcontentsourceoptions) | `type` | Configuration for opening a static content-export manifest. |
|
|
65
|
+
| [`RestContentSourceOptions`](https://www.shoalrun.com/content-delivery/sdk/all.md#shoalrun-content-restcontentsourceoptions) | `type` | Options for a REST inventory and its revision-pinned resource reads. |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.ContentAnchor.exportedId
|
|
3
|
+
title: exportedId
|
|
4
|
+
summary: "property: shoalrun.content.ContentAnchor.exportedId"
|
|
5
|
+
type: code-reference
|
|
6
|
+
area: publishing
|
|
7
|
+
subarea: publishing-content-delivery
|
|
8
|
+
canonical: /content-delivery/sdk/content-anchor/exported-id
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# exportedId
|
|
12
|
+
|
|
13
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
|
+
|
|
15
|
+
**Updated: 2026-09-27.**
|
|
16
|
+
|
|
17
|
+
**Property** `shoalrun.content.ContentAnchor.exportedId`
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
exportedId: string
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Type: **`string`
|
|
24
|
+
|
|
25
|
+
Required
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.ContentAnchor.id
|
|
3
|
+
title: id
|
|
4
|
+
summary: "property: shoalrun.content.ContentAnchor.id"
|
|
5
|
+
type: code-reference
|
|
6
|
+
area: publishing
|
|
7
|
+
subarea: publishing-content-delivery
|
|
8
|
+
canonical: /content-delivery/sdk/content-anchor/id
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# id
|
|
12
|
+
|
|
13
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
|
+
|
|
15
|
+
**Updated: 2026-09-27.**
|
|
16
|
+
|
|
17
|
+
**Property** `shoalrun.content.ContentAnchor.id`
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
id: string
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Type: **`string`
|
|
24
|
+
|
|
25
|
+
Required
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.ContentAnchor.title
|
|
3
|
+
title: title
|
|
4
|
+
summary: "property: shoalrun.content.ContentAnchor.title"
|
|
5
|
+
type: code-reference
|
|
6
|
+
area: publishing
|
|
7
|
+
subarea: publishing-content-delivery
|
|
8
|
+
canonical: /content-delivery/sdk/content-anchor/title
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# title
|
|
12
|
+
|
|
13
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
|
+
|
|
15
|
+
**Updated: 2026-09-27.**
|
|
16
|
+
|
|
17
|
+
**Property** `shoalrun.content.ContentAnchor.title`
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
title?: string | undefined
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Type: **`string | undefined`
|
|
24
|
+
|
|
25
|
+
Optional
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.ContentAnchor
|
|
3
|
+
title: ContentAnchor
|
|
4
|
+
summary: Mapping from a canonical document fragment to its exported HTML ID.
|
|
5
|
+
type: code-reference
|
|
6
|
+
area: publishing
|
|
7
|
+
subarea: publishing-content-delivery
|
|
8
|
+
canonical: /content-delivery/sdk/content-anchor
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# ContentAnchor
|
|
12
|
+
|
|
13
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
|
+
|
|
15
|
+
**Updated: 2026-09-27.**
|
|
16
|
+
|
|
17
|
+
**Type** `shoalrun.content.ContentAnchor`
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
type ContentAnchor = {
|
|
21
|
+
id: string;
|
|
22
|
+
exportedId: string;
|
|
23
|
+
title?: string;
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Mapping from a canonical document fragment to its exported HTML ID.
|
|
28
|
+
|
|
29
|
+
## Fields
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required / default | Description |
|
|
32
|
+
| ------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------------ | ----------- |
|
|
33
|
+
| [`exportedId`](https://www.shoalrun.com/content-delivery/sdk/content-anchor.md#shoalrun-content-contentanchor-exportedid) | `string` | Required | — |
|
|
34
|
+
| [`id`](https://www.shoalrun.com/content-delivery/sdk/content-anchor.md#shoalrun-content-contentanchor-id) | `string` | Required | — |
|
|
35
|
+
| [`title`](https://www.shoalrun.com/content-delivery/sdk/content-anchor.md#shoalrun-content-contentanchor-title) | `string \| undefined` | Optional | — |
|
|
36
|
+
|
|
37
|
+
## shoalrun.content.ContentAnchor.exportedId
|
|
38
|
+
|
|
39
|
+
**Property** `shoalrun.content.ContentAnchor.exportedId`
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
exportedId: string
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Type: **`string`
|
|
46
|
+
|
|
47
|
+
Required
|
|
48
|
+
|
|
49
|
+
## shoalrun.content.ContentAnchor.id
|
|
50
|
+
|
|
51
|
+
**Property** `shoalrun.content.ContentAnchor.id`
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
id: string
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**Type: **`string`
|
|
58
|
+
|
|
59
|
+
Required
|
|
60
|
+
|
|
61
|
+
## shoalrun.content.ContentAnchor.title
|
|
62
|
+
|
|
63
|
+
**Property** `shoalrun.content.ContentAnchor.title`
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
title?: string | undefined
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**Type: **`string | undefined`
|
|
70
|
+
|
|
71
|
+
Optional
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: reference.content-sdk.ContentAsset.mediaType
|
|
3
|
+
title: mediaType
|
|
4
|
+
summary: "property: shoalrun.content.ContentAsset.mediaType"
|
|
5
|
+
type: code-reference
|
|
6
|
+
area: publishing
|
|
7
|
+
subarea: publishing-content-delivery
|
|
8
|
+
canonical: /content-delivery/sdk/content-asset/media-type
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# mediaType
|
|
12
|
+
|
|
13
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
14
|
+
|
|
15
|
+
**Updated: 2026-09-27.**
|
|
16
|
+
|
|
17
|
+
**Property** `shoalrun.content.ContentAsset.mediaType`
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
mediaType: string
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Type: **`string`
|
|
24
|
+
|
|
25
|
+
Required
|