@shoalrun/cli 0.1.0-alpha.17 → 0.1.0-alpha.19
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/AUTHORING.md +29 -0
- package/CHANGELOG.md +54 -0
- package/DEPLOYMENT-PROFILES.md +96 -5
- package/README.md +106 -25
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +23 -17
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/api-docs/focused-contracts.md +4 -4
- package/agent-docs/api-docs/generate.md +11 -11
- package/agent-docs/api-docs/generate.sections/add-useful-examples.md +3 -3
- package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +4 -4
- package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +1 -1
- package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +2 -2
- package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +1 -1
- package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +1 -1
- package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +4 -4
- package/agent-docs/api-docs/generate.sections/related-reading.md +1 -1
- package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +2 -2
- package/agent-docs/api-docs/support.md +7 -7
- package/agent-docs/author/add-page.md +3 -3
- package/agent-docs/author/agent-overview.md +3 -3
- package/agent-docs/author/agent-workflow.md +7 -7
- package/agent-docs/author/analytics.md +27 -27
- package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +3 -3
- package/agent-docs/author/analytics.sections/built-in-events.md +15 -15
- package/agent-docs/author/analytics.sections/configure-an-adapter.md +1 -1
- package/agent-docs/author/analytics.sections/custom-interactions.md +2 -2
- package/agent-docs/author/analytics.sections/event-format.md +2 -2
- package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +4 -4
- package/agent-docs/author/analytics.sections/inspect-events-locally.md +2 -2
- package/agent-docs/author/analytics.sections/map-events-to-your-service.md +3 -3
- package/agent-docs/author/analytics.sections/posthog-example.md +3 -3
- package/agent-docs/author/analytics.sections/related-reading.md +1 -1
- package/agent-docs/author/authoring-agent.md +3 -3
- package/agent-docs/author/coding-agent.md +4 -4
- package/agent-docs/author/components/api-embeds.md +6 -6
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +3 -3
- package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/components/api-embeds.sections/related-reading.md +1 -1
- package/agent-docs/author/components/badge.md +2 -2
- package/agent-docs/author/components/callout.md +2 -2
- package/agent-docs/author/components/cards.md +16 -16
- package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +4 -4
- package/agent-docs/author/components/cards.sections/build-a-collection.md +7 -7
- package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +9 -9
- package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/components/cards.sections/link-to-one-document.md +3 -3
- package/agent-docs/author/components/cards.sections/override-card-text.md +5 -5
- package/agent-docs/author/components/cards.sections/related-reading.md +3 -3
- package/agent-docs/author/components/code-blocks.md +2 -2
- package/agent-docs/author/components/collapsible.md +3 -3
- package/agent-docs/author/components/cookbook-chooser.md +5 -5
- package/agent-docs/author/components/custom/react.md +8 -8
- package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +2 -2
- package/agent-docs/author/components/custom/react.sections/registration.md +1 -1
- package/agent-docs/author/components/custom/react.sections/related-reading.md +1 -1
- package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +3 -3
- package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +3 -3
- package/agent-docs/author/components/custom.md +7 -7
- package/agent-docs/author/components/definition-list.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +2 -2
- package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.md +3 -3
- package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +2 -2
- package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +2 -2
- package/agent-docs/author/components/diagrams.md +8 -8
- package/agent-docs/author/components/doc-link.md +3 -3
- package/agent-docs/author/components/fields.md +18 -18
- package/agent-docs/author/components/file-tree.md +2 -2
- package/agent-docs/author/components/images.md +5 -5
- package/agent-docs/author/components/info-hint.md +3 -3
- package/agent-docs/author/components/kbd.md +2 -2
- package/agent-docs/author/components/math.md +2 -2
- package/agent-docs/author/components/only.md +3 -3
- package/agent-docs/author/components/progress.md +3 -3
- package/agent-docs/author/components/steps.md +2 -2
- package/agent-docs/author/components/tables.md +2 -2
- package/agent-docs/author/components/tabs.md +5 -5
- package/agent-docs/author/components/timeline.md +2 -2
- package/agent-docs/author/components/tooltips.md +2 -2
- package/agent-docs/author/components/walkthroughs.md +2 -2
- package/agent-docs/author/components/walkthroughs.sections/attributes.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +2 -2
- package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/related-reading.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/syntax.md +1 -1
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +1 -1
- package/agent-docs/author/components.md +2 -2
- package/agent-docs/author/content.md +3 -3
- package/agent-docs/author/cookbooks.md +9 -9
- package/agent-docs/author/css.md +4 -4
- package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +3 -3
- package/agent-docs/author/css.sections/core-color-tokens.md +3 -3
- package/agent-docs/author/css.sections/html-markdown-and-agents.md +4 -4
- package/agent-docs/author/css.sections/page-attributes.md +3 -3
- package/agent-docs/author/css.sections/page-transitions.md +3 -3
- package/agent-docs/author/css.sections/responsive-behavior.md +3 -3
- package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +3 -3
- package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +3 -3
- package/agent-docs/author/custom-metadata.md +13 -13
- package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +4 -4
- package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +3 -3
- package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +2 -2
- package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +3 -3
- package/agent-docs/author/custom-metadata.sections/related-reading.md +1 -1
- package/agent-docs/author/design-templates.md +3 -3
- package/agent-docs/author/design-writing-guides.md +3 -3
- package/agent-docs/author/frontmatter-reference.md +45 -6
- package/agent-docs/author/frontmatter-reference.sections/categorize-connect-and-present-the-page.md +64 -0
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/feature-availability.md +59 -0
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/product-publication-fields.md +37 -0
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +2 -2
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +4 -4
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +2 -2
- package/agent-docs/author/frontmatter.md +13 -13
- package/agent-docs/author/frontmatter.sections/audience-badges.md +3 -3
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +4 -4
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +1 -1
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +4 -4
- package/agent-docs/author/frontmatter.sections/publication-fields.md +2 -2
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +1 -1
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +1 -1
- package/agent-docs/author/frontmatter.sections/related-reading.md +1 -1
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +1 -1
- package/agent-docs/author/frontmatter.sections/seo-fields.md +2 -2
- package/agent-docs/author/frontmatter.sections/validation-rules.md +3 -3
- package/agent-docs/author/markdown-metadata.md +20 -20
- package/agent-docs/author/navigation.md +12 -12
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +4 -4
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +2 -2
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +4 -4
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +4 -4
- package/agent-docs/author/navigation.sections/local-api-preview.md +2 -2
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +3 -3
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +2 -2
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +2 -2
- package/agent-docs/author/navigation.sections/related-reading.md +2 -2
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +4 -4
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +3 -3
- package/agent-docs/author/reader-views.md +9 -9
- 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 +1 -1
- package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +3 -3
- package/agent-docs/author/reader-views.sections/mark-pages.md +3 -3
- 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/author/recipe-drafts.md +5 -5
- package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +2 -2
- package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +2 -2
- package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +1 -1
- package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +2 -2
- package/agent-docs/author/recipe-drafts.sections/related-reading.md +1 -1
- package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +2 -2
- package/agent-docs/author/recipes.md +7 -7
- package/agent-docs/author/recipes.sections/how-agents-use-this.md +2 -2
- package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +2 -2
- package/agent-docs/author/recipes.sections/related-reading.md +1 -1
- package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +1 -1
- package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +3 -3
- package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +2 -2
- package/agent-docs/author/recipes.sections/what-each-file-does.md +1 -1
- package/agent-docs/author/recipes.sections/what-happens-and-when.md +2 -2
- package/agent-docs/author/related-reading.md +11 -11
- package/agent-docs/author/related-reading.sections/automatic-footers.md +3 -3
- package/agent-docs/author/related-reading.sections/declare-relationships.md +3 -3
- package/agent-docs/author/related-reading.sections/display-related-documents.md +3 -3
- package/agent-docs/author/related-reading.sections/html-markdown-and-agents.md +1 -1
- package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +2 -2
- package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +3 -3
- package/agent-docs/author/related-reading.sections/related-reading.md +1 -1
- package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +2 -2
- package/agent-docs/author/release-notes.md +8 -8
- package/agent-docs/author/search.md +43 -39
- package/agent-docs/author/search.sections/agent-and-mcp-search-scope.md +12 -8
- package/agent-docs/author/search.sections/choose-a-provider.md +8 -8
- package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +4 -4
- package/agent-docs/author/search.sections/enable-included-semantic-search.md +5 -5
- package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +3 -3
- package/agent-docs/author/search.sections/html-markdown-and-agents.md +3 -3
- package/agent-docs/author/search.sections/lexical-search.md +6 -6
- package/agent-docs/author/search.sections/local-semantic-preview.md +3 -3
- package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +2 -2
- package/agent-docs/author/search.sections/related-reading.md +2 -2
- package/agent-docs/author/search.sections/reuse-the-lexical-index.md +5 -5
- package/agent-docs/author/search.sections/turn-search-off.md +3 -3
- package/agent-docs/author/search.sections/use-the-search-box.md +2 -2
- package/agent-docs/author/search.sections/write-a-custom-provider.md +11 -11
- package/agent-docs/author/snippets.md +3 -3
- package/agent-docs/author/taxonomy.md +3 -3
- package/agent-docs/author/templates.md +16 -14
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +2 -2
- package/agent-docs/author/templates.sections/built-in-templates.md +2 -2
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +7 -7
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +8 -6
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +2 -2
- package/agent-docs/author/templates.sections/project-added-templates.md +3 -3
- package/agent-docs/author/templates.sections/related-reading.md +2 -2
- package/agent-docs/author/templates.sections/scaffold-a-page.md +2 -2
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +3 -3
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +3 -3
- package/agent-docs/author/workspace/commands.md +4 -4
- package/agent-docs/author/workspace.md +7 -7
- package/agent-docs/author/writing-style.md +33 -18
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +2 -2
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +3 -3
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +4 -4
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +2 -2
- package/agent-docs/author/writing-style.sections/feature-availability.md +20 -7
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +5 -5
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +4 -4
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +4 -4
- package/agent-docs/author/writing-style.sections/related-reading.md +2 -2
- package/agent-docs/author/writing-style.sections/review-a-draft.md +3 -3
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +2 -2
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +4 -2
- package/agent-docs/changelog/2026-10-14-agent-readiness.md +2 -2
- package/agent-docs/changelog/2026-10-15-evaluation-builds.md +9 -9
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +4 -4
- package/agent-docs/changelog/2026-10-17-mcp-hosting.md +2 -2
- package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +3 -3
- package/agent-docs/changelog/2026-10-19-visual-navigation.md +3 -3
- package/agent-docs/changelog/2026-10-25.md +2 -2
- package/agent-docs/changelog/2026-10-26.md +4 -4
- package/agent-docs/changelog/2026-10-27.md +1 -1
- package/agent-docs/changelog/2026-10-28.md +3 -3
- package/agent-docs/changelog/2026-10-30.md +1 -1
- package/agent-docs/changelog/2026-11-03.md +5 -5
- package/agent-docs/changelog/2026-11-04-runtime-packaging.md +46 -0
- package/agent-docs/changelog/authoring-preview.md +3 -3
- package/agent-docs/changelog/authoring-search.md +1 -1
- package/agent-docs/changelog/authoring-tools.md +2 -2
- package/agent-docs/changelog/branding-security.md +66 -0
- package/agent-docs/changelog/product-publications.md +60 -0
- package/agent-docs/changelog/working-tree-skill.md +1 -1
- package/agent-docs/changelog.md +25 -1
- package/agent-docs/chat/checks.md +11 -11
- package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +1 -1
- package/agent-docs/chat/checks.sections/answer-for-one-audience.md +2 -2
- package/agent-docs/chat/checks.sections/answer-without-a-model.md +2 -2
- package/agent-docs/chat/checks.sections/follow-up-questions.md +2 -2
- package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +3 -3
- package/agent-docs/chat/checks.sections/questions-with-several-parts.md +3 -3
- package/agent-docs/chat/checks.sections/related-reading.md +1 -1
- package/agent-docs/chat/checks.sections/reuse-answers.md +4 -4
- package/agent-docs/chat/host.md +28 -10
- package/agent-docs/chat/host.sections/cap-the-daily-spend.md +2 -2
- package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +3 -3
- package/agent-docs/chat/host.sections/related-reading.md +2 -2
- package/agent-docs/chat/passage-index.md +17 -17
- package/agent-docs/chat/passage-index.sections/build-the-index.md +2 -2
- package/agent-docs/chat/passage-index.sections/embed-passages.md +3 -3
- package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +2 -2
- package/agent-docs/chat/passage-index.sections/limits.md +2 -2
- package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +3 -3
- package/agent-docs/chat/passage-index.sections/related-reading.md +2 -2
- package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +15 -15
- package/agent-docs/chat/prepared-answers.md +4 -4
- package/agent-docs/chat/settings.md +4 -4
- package/agent-docs/chat/settings.sections/choose-the-scorer.md +1 -1
- package/agent-docs/chat/settings.sections/configure-chat.md +2 -2
- package/agent-docs/chat/settings.sections/configure-retrieval.md +1 -1
- package/agent-docs/chat/settings.sections/related-reading.md +1 -1
- package/agent-docs/chat/settings.sections/send-extra-request-fields.md +2 -2
- package/agent-docs/chat/settings.sections/use-more-than-one-model.md +2 -2
- package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +1 -1
- package/agent-docs/chat/setup.md +2 -2
- package/agent-docs/chat.md +3 -3
- package/agent-docs/cli.md +73 -59
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +11 -7
- package/agent-docs/cli.sections/author-pages.md +16 -12
- package/agent-docs/cli.sections/build-and-serve.md +30 -18
- package/agent-docs/cli.sections/inspect-config-and-operations.md +13 -9
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +7 -3
- package/agent-docs/cli.sections/related-reading.md +6 -2
- package/agent-docs/cli.sections/search-and-chat.md +24 -18
- package/agent-docs/cli.sections/start-a-project.md +7 -3
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +7 -3
- package/agent-docs/concepts.md +2 -2
- package/agent-docs/config/apis.md +2 -2
- package/agent-docs/config/content.md +3 -3
- package/agent-docs/config/content.sections/authoring.md +3 -3
- package/agent-docs/config/content.sections/badges.md +1 -1
- package/agent-docs/config/content.sections/callouts.md +1 -1
- package/agent-docs/config/content.sections/cookbooks.md +1 -1
- package/agent-docs/config/content.sections/frontmatter.md +1 -1
- package/agent-docs/config/content.sections/readerfilters.md +1 -1
- package/agent-docs/config/content.sections/related-reading.md +1 -1
- package/agent-docs/config/content.sections/relationships.md +1 -1
- package/agent-docs/config/content.sections/snippets.md +1 -1
- package/agent-docs/config/content.sections/templates.md +1 -1
- package/agent-docs/config/content.sections/variables.md +1 -1
- package/agent-docs/config/examples.md +4 -4
- package/agent-docs/config/examples.sections/feature-showcase.md +4 -4
- 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/integrations.md +4 -4
- package/agent-docs/config/outputs.md +22 -16
- package/agent-docs/config/outputs.sections/exports.md +19 -13
- package/agent-docs/config/outputs.sections/metadata.md +2 -2
- package/agent-docs/config/outputs.sections/related-reading.md +1 -1
- package/agent-docs/config/publishing.md +29 -19
- package/agent-docs/config/publishing.sections/navigation.md +2 -2
- package/agent-docs/config/publishing.sections/redirects.md +8 -8
- package/agent-docs/config/publishing.sections/related-reading.md +2 -2
- package/agent-docs/config/site.md +42 -18
- 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 +19 -19
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +1 -1
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +5 -5
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +1 -1
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +5 -5
- package/agent-docs/configuration.sections/related-reading.md +1 -1
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +5 -5
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +3 -3
- package/agent-docs/configuration.sections/start-with-one-working-file.md +2 -2
- package/agent-docs/configuration.sections/understand-the-three-stages.md +3 -3
- package/agent-docs/configuration.sections/understand-where-paths-point.md +2 -2
- package/agent-docs/connect/mcp.md +24 -15
- package/agent-docs/content-delivery/agents.md +6 -6
- package/agent-docs/content-delivery/api.md +29 -16
- package/agent-docs/content-delivery/client.md +14 -8
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-fa1d2e3f.md +10 -2
- package/agent-docs/content-delivery/http-api/operations/get-content-representation-head-4052375c.md +10 -2
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-849f1c49.md +537 -3
- package/agent-docs/content-delivery/http-api/operations/get-content-resource-head-0a352acd.md +10 -2
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-8e977ec7.md +545 -3
- package/agent-docs/content-delivery/http-api/operations/list-content-resources-head-b67cbad9.md +10 -2
- package/agent-docs/content-delivery/http-api.md +21 -7
- package/agent-docs/content-delivery/manifest.md +30 -8
- package/agent-docs/content-delivery/publish.md +5 -5
- package/agent-docs/content-delivery/render.md +6 -6
- package/agent-docs/content-delivery/rest.md +16 -8
- package/agent-docs/content-delivery/sections.md +11 -11
- package/agent-docs/content-delivery/select.md +6 -6
- package/agent-docs/content-delivery.md +4 -4
- package/agent-docs/contribute/agent-skills.md +3 -3
- package/agent-docs/cookbooks/authoring.md +3 -3
- package/agent-docs/cookbooks/site-workflows.md +2 -2
- package/agent-docs/cookbooks/welcome-email.md +3 -3
- package/agent-docs/documents.json +2500 -1927
- package/agent-docs/example-api/cedar.md +4 -4
- package/agent-docs/features.md +49 -0
- package/agent-docs/glossary.md +22 -22
- package/agent-docs/index.md +5 -5
- package/agent-docs/ingredients/audit-site.md +2 -2
- package/agent-docs/ingredients/build-site.md +2 -2
- package/agent-docs/ingredients/complete-page.md +2 -2
- package/agent-docs/ingredients/refresh-agent-bundle.md +2 -2
- package/agent-docs/non-goals.md +4 -4
- package/agent-docs/provenance.json +10 -4
- package/agent-docs/publish/agent-discovery.md +8 -2
- package/agent-docs/publish/agent-friendliness.md +21 -21
- package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +5 -5
- package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +5 -5
- package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +5 -5
- package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +5 -5
- package/agent-docs/publish/agent-friendliness.sections/related-reading.md +3 -3
- package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +3 -3
- package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +3 -3
- package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +4 -4
- package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +9 -9
- package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +5 -5
- package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +4 -4
- package/agent-docs/publish/api-references.md +5 -5
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +2 -2
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +3 -3
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +2 -2
- package/agent-docs/publish/api-references.sections/next-steps.md +2 -2
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +2 -2
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +2 -2
- package/agent-docs/publish/api-references.sections/register-the-operation.md +2 -2
- package/agent-docs/publish/api-references.sections/related-reading.md +2 -2
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +3 -3
- package/agent-docs/publish/api-references.sections/what-readers-get.md +3 -3
- package/agent-docs/publish/audit.md +8 -8
- package/agent-docs/publish/audit.sections/add-project-tests.md +2 -2
- package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +2 -2
- package/agent-docs/publish/audit.sections/check-before-pushing.md +3 -3
- package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +2 -2
- package/agent-docs/publish/audit.sections/read-the-report.md +3 -3
- package/agent-docs/publish/audit.sections/related-reading.md +1 -1
- package/agent-docs/publish/content-export.md +37 -15
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +4 -4
- package/agent-docs/publish/content-export.sections/check-the-result.md +2 -2
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +3 -3
- package/agent-docs/publish/content-export.sections/prerequisites.md +4 -4
- package/agent-docs/publish/content-export.sections/related-reading.md +2 -2
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +3 -3
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +2 -2
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +4 -4
- package/agent-docs/publish/content-negotiation.md +10 -10
- package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/missing-pages.md +3 -3
- package/agent-docs/publish/content-negotiation.sections/related-reading.md +1 -1
- package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +3 -3
- package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +2 -2
- package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +2 -2
- package/agent-docs/publish/deployment-check.md +6 -6
- package/agent-docs/publish/deployment-profiles.md +60 -26
- package/agent-docs/publish/deployment-profiles.sections/before-you-begin.md +5 -5
- package/agent-docs/publish/deployment-profiles.sections/build-and-inspect-the-edition.md +9 -9
- package/agent-docs/publish/deployment-profiles.sections/check-the-result.md +7 -7
- package/agent-docs/publish/deployment-profiles.sections/choose-navigation-labels.md +6 -6
- package/agent-docs/publish/deployment-profiles.sections/current-limits.md +7 -7
- package/agent-docs/publish/deployment-profiles.sections/define-the-shared-sku-manifest.md +6 -6
- package/agent-docs/publish/deployment-profiles.sections/html-markdown-and-agents.md +7 -7
- package/agent-docs/publish/deployment-profiles.sections/mark-pages-and-shared-sections.md +13 -13
- package/agent-docs/publish/deployment-profiles.sections/preview-and-edit-a-customer-edition.md +55 -0
- package/agent-docs/publish/deployment-profiles.sections/related-reading.md +6 -6
- package/agent-docs/publish/deployment-profiles.sections/select-each-product-release.md +55 -0
- package/agent-docs/publish/deployment-profiles.sections/supply-the-profile-from-the-deployment.md +6 -6
- package/agent-docs/publish/evals.md +16 -16
- package/agent-docs/publish/evals.sections/add-the-audit-hook.md +5 -5
- package/agent-docs/publish/evals.sections/check-the-report.md +4 -4
- package/agent-docs/publish/evals.sections/define-a-task-file.md +5 -5
- package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +5 -5
- package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +5 -5
- package/agent-docs/publish/evals.sections/related-reading.md +3 -3
- package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +4 -4
- package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +6 -6
- package/agent-docs/publish/host-adapters.md +6 -6
- package/agent-docs/publish/manni.md +16 -16
- package/agent-docs/publish/manni.sections/check-the-result.md +3 -3
- package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +6 -6
- package/agent-docs/publish/manni.sections/optional-custom-policies.md +4 -4
- package/agent-docs/publish/manni.sections/prerequisites.md +2 -2
- package/agent-docs/publish/mcp-analytics.md +12 -12
- package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +4 -4
- package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +4 -4
- package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +4 -4
- package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +4 -4
- package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +5 -5
- package/agent-docs/publish/mcp-analytics.sections/related-reading.md +3 -3
- package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +5 -5
- package/agent-docs/publish/mcp.md +56 -29
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +8 -8
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +4 -4
- package/agent-docs/publish/mcp.sections/configure-the-client.md +4 -4
- package/agent-docs/publish/mcp.sections/discover-product-releases-before-searching.md +52 -0
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +6 -6
- package/agent-docs/publish/mcp.sections/html-markdown-and-agents.md +38 -0
- package/agent-docs/publish/mcp.sections/related-reading.md +3 -3
- package/agent-docs/publish/mcp.sections/search-then-read.md +13 -12
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +12 -8
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +4 -4
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +4 -4
- package/agent-docs/publish/openapi-extension-mappings.md +12 -12
- package/agent-docs/publish/output.md +20 -20
- package/agent-docs/publish/output.sections/api-contracts.md +1 -1
- package/agent-docs/publish/output.sections/code-highlighting.md +1 -1
- package/agent-docs/publish/output.sections/current-limits.md +1 -1
- package/agent-docs/publish/output.sections/incremental-sync.md +4 -4
- package/agent-docs/publish/output.sections/manifest-records-and-sections.md +3 -3
- package/agent-docs/publish/output.sections/navigation-section-indexes.md +1 -1
- package/agent-docs/publish/output.sections/page-formats.md +2 -2
- package/agent-docs/publish/output.sections/published-output-contract.md +5 -5
- package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +1 -1
- package/agent-docs/publish/output.sections/related-reading.md +1 -1
- package/agent-docs/publish/output.sections/response-identity.md +1 -1
- package/agent-docs/publish/output.sections/site-files.md +6 -6
- package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +3 -3
- package/agent-docs/publish/output.sections/where-files-go.md +3 -3
- package/agent-docs/publish/publications.md +108 -19
- package/agent-docs/publish/publications.sections/add-a-language.md +60 -0
- package/agent-docs/publish/publications.sections/change-just-one-part-of-a-shared-page.md +63 -0
- package/agent-docs/publish/publications.sections/give-each-api-version-its-own-contract.md +34 -0
- package/agent-docs/publish/publications.sections/keep-an-unchanged-page-in-one-file.md +53 -0
- package/agent-docs/publish/publications.sections/publish-versions-without-a-product-catalog.md +49 -0
- package/agent-docs/publish/publications.sections/related-reading.md +42 -0
- package/agent-docs/publish/publications.sections/version-products-independently.md +115 -0
- package/agent-docs/publish/publications.sections/what-agents-receive.md +38 -0
- package/agent-docs/publish/revisions.md +4 -4
- package/agent-docs/publish/seo.md +10 -10
- package/agent-docs/publish/seo.sections/related-reading.md +2 -2
- package/agent-docs/publish/seo.sections/set-the-public-address.md +3 -3
- package/agent-docs/publish/seo.sections/what-agents-receive.md +3 -3
- package/agent-docs/publish/seo.sections/what-the-build-adds.md +2 -2
- package/agent-docs/publish/seo.sections/write-the-page-title-and-summary.md +2 -2
- package/agent-docs/publish/single-source-sites.md +5 -5
- package/agent-docs/publish/troubleshooting.md +10 -10
- package/agent-docs/publish/vercel.md +5 -5
- package/agent-docs/publish/vercel.sections/check-the-deployment.md +1 -1
- package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +2 -2
- package/agent-docs/publish/vercel.sections/prepare-your-project.md +2 -2
- package/agent-docs/publish/vercel.sections/related-reading.md +1 -1
- package/agent-docs/publish.md +2 -2
- package/agent-docs/recipes/add-page.md +5 -5
- package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +2 -2
- package/agent-docs/recipes/add-page.sections/before-you-start.md +1 -1
- package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +2 -2
- package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +1 -1
- package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +1 -1
- package/agent-docs/recipes/add-page.sections/check-the-outcome.md +1 -1
- package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +2 -2
- package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +1 -1
- package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +2 -2
- package/agent-docs/recipes/add-page.sections/related-reading.md +1 -1
- package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +1 -1
- package/agent-docs/recipes/audit-docs.md +4 -4
- package/agent-docs/recipes/build-docs.md +2 -2
- package/agent-docs/recipes/preview-hybrid-search.md +5 -5
- package/agent-docs/recipes/preview-page.md +2 -2
- package/agent-docs/recipes/queue-email.md +2 -2
- package/agent-docs/recipes/refresh-agent-docs.md +4 -4
- package/agent-docs/recipes/send-welcome-email.md +13 -13
- package/agent-docs/reference/agent-skills.md +7 -7
- package/agent-docs/search-and-chat.md +4 -4
- package/agent-docs/search-index.json +1 -1
- package/agent-docs/start.md +5 -5
- package/agent-docs/start.sections/add-the-page-to-navigation.md +3 -3
- package/agent-docs/start.sections/build-and-check-both-outputs.md +3 -3
- 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 +14 -4
- package/agent-docs/styling/color-modes.md +2 -2
- package/agent-docs/styling/footer.md +2 -2
- package/agent-docs/styling/header.md +2 -2
- package/agent-docs/styling/layouts.md +3 -3
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +1 -1
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +1 -1
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +2 -2
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +1 -1
- package/agent-docs/styling/layouts.sections/hero.md +1 -1
- package/agent-docs/styling/layouts.sections/hide-the-table-of-contents-or-give-content-more-room.md +1 -1
- package/agent-docs/styling/layouts.sections/html-markdown-and-agents.md +2 -2
- package/agent-docs/styling/layouts.sections/related-reading.md +1 -1
- package/agent-docs/styling/palettes.md +3 -3
- package/agent-docs/styling/share-images.md +3 -3
- package/agent-docs/styling/themes.md +2 -2
- package/agent-docs/styling/try.md +2 -2
- package/agent-docs/what-is-shoalrun.md +7 -3
- package/assets/ask-widget.js +21 -7
- package/assets/navigation.js +5 -0
- package/dist/api-materialize.d.ts +2 -1
- package/dist/api-materialize.js +21 -9
- package/dist/api-publication-plan.d.ts +2 -0
- package/dist/api-publication-plan.js +23 -7
- package/dist/api-publication-review.js +4 -3
- package/dist/api-selection.d.ts +5 -2
- package/dist/api-selection.js +18 -11
- package/dist/artifact-bundle.js +9 -6
- package/dist/ask-function.js +5 -2
- package/dist/ask-runtime.d.ts +1 -0
- package/dist/ask-runtime.js +7 -2
- package/dist/authored-change.js +2 -1
- package/dist/authoring-project.js +1 -1
- package/dist/cards.js +2 -1
- package/dist/chat-config.d.ts +2 -0
- package/dist/chat-config.js +10 -2
- package/dist/cli-discovery.d.ts +2 -2
- package/dist/cli-discovery.js +9 -4
- package/dist/cli.js +50 -25
- package/dist/compiler-config.d.ts +17 -0
- package/dist/compiler-config.js +43 -2
- package/dist/compiler.d.ts +21 -0
- package/dist/compiler.js +16 -12
- package/dist/component-transform.d.ts +2 -4
- package/dist/component-transform.js +20 -7
- package/dist/config.d.ts +1 -0
- package/dist/config.js +2 -1
- package/dist/content-delivery-contract.d.ts +2 -1
- package/dist/content-delivery-validation.d.ts +2 -2
- package/dist/content-delivery-validation.js +6 -4
- package/dist/content-export-command.d.ts +1 -1
- package/dist/content-export-command.js +4 -4
- package/dist/content-export-comparison.js +6 -5
- package/dist/content-export-config.js +3 -1
- package/dist/content-export.js +9 -8
- package/dist/content-rest-client.js +4 -2
- package/dist/content-rest-contract.d.ts +2 -2
- package/dist/content-rest-server.js +11 -6
- package/dist/content-source.d.ts +13 -0
- package/dist/content-source.js +5 -2
- package/dist/content-workspace.d.ts +12 -0
- package/dist/content-workspace.js +2 -1
- package/dist/content.js +3 -2
- package/dist/cookbook-chooser.js +2 -1
- package/dist/deployment-profile.d.ts +2 -1
- package/dist/deployment-profile.js +38 -8
- package/dist/dev.d.ts +3 -1
- package/dist/dev.js +99 -12
- package/dist/docs-author.js +2 -1
- package/dist/docs-command.js +2 -2
- package/dist/docs-eval.d.ts +1 -0
- package/dist/docs-eval.js +2 -2
- package/dist/docs-mcp.d.ts +1 -0
- package/dist/docs-mcp.js +10 -5
- package/dist/docs-tool.d.ts +4 -10
- package/dist/document-sync.d.ts +1 -0
- package/dist/document-sync.js +2 -2
- package/dist/documentation-core.d.ts +29 -10
- package/dist/documentation-core.js +38 -4
- package/dist/freshness.js +2 -2
- package/dist/frontmatter.js +13 -7
- package/dist/function-runtime.d.ts +1 -0
- package/dist/index-build.d.ts +1 -0
- package/dist/index-build.js +2 -2
- package/dist/ingredient-draft.js +20 -10
- package/dist/mcp-analytics.d.ts +1 -0
- package/dist/mcp-artifacts.js +13 -4
- package/dist/mcp-config.d.ts +1 -0
- package/dist/mcp-config.js +3 -1
- package/dist/mcp-http.js +1 -1
- package/dist/page-materialization.d.ts +3 -4
- package/dist/page-materialization.js +15 -8
- package/dist/page-renderer.d.ts +6 -0
- package/dist/page-renderer.js +16 -5
- package/dist/project-navigation.js +2 -1
- package/dist/publication-identity.d.ts +12 -0
- package/dist/publication-identity.js +17 -0
- package/dist/publication-manifest.d.ts +24 -1
- package/dist/publication-manifest.js +14 -6
- package/dist/publication-plan.js +21 -9
- package/dist/publication-render.js +24 -8
- package/dist/recipe-draft.js +9 -6
- package/dist/scaffold.d.ts +7 -4
- package/dist/scaffold.js +16 -16
- package/dist/search-query.d.ts +4 -10
- package/dist/search-query.js +10 -9
- package/dist/server.d.ts +8 -0
- package/dist/server.js +14 -3
- package/dist/subject-deprecation.js +2 -1
- package/dist/turnstile-policy.d.ts +2 -0
- package/dist/turnstile-policy.js +23 -0
- package/dist/turnstile.d.ts +7 -0
- package/dist/turnstile.js +29 -2
- package/dist/vercel-function.js +2 -2
- package/example-configs/products/README.md +37 -0
- package/example-configs/products/content/operations.mdx +50 -0
- package/example-configs/products/content/payments-v2.mdx +30 -0
- package/example-configs/products/content/payments-v3.mdx +38 -0
- package/example-configs/products/content/priority-settlement.mdx +23 -0
- package/example-configs/products/content/reporting-v1.mdx +36 -0
- package/example-configs/products/content/scheduled-exports.mdx +23 -0
- package/example-configs/products/docs.config.yaml +56 -0
- package/example-configs/products/profiles/all-releases.yaml +9 -0
- package/example-configs/products/profiles/customer-a.yaml +13 -0
- package/example-configs/products/profiles/customer-b.yaml +13 -0
- package/example-configs/products/skus.yaml +11 -0
- package/examples/content-delivery/preview.mjs +1 -1
- package/package.json +1 -1
- package/schemas/content-export.schema.json +41 -3
- package/schemas/content-rest.openapi.json +184 -37
- package/skills/shoalrun-author/SKILL.md +6 -2
- package/skills/shoalrun-author/references/customer-editions.md +34 -4
- package/skills/shoalrun-author/references/publications.md +60 -0
- package/skills/shoalrun-brand/SKILL.md +52 -0
- package/skills/shoalrun-recipes/SKILL.md +2 -0
- package/skills/shoalrun-setup/SKILL.md +3 -1
- package/styles/header.css +3 -0
- package/styles/site.css +3 -0
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +0 -116
|
@@ -1,24 +1,32 @@
|
|
|
1
|
+
import { documentKey, publicationKey, parsePublicationKey } from './publication-identity.js';
|
|
1
2
|
import { markdownSize } from './markdown-size.js';
|
|
2
3
|
import { createHash } from 'node:crypto';
|
|
3
4
|
import { navigationPath, navigationTab, navigationTabRecord } from './project-navigation.js';
|
|
4
5
|
import { sitemapFiles } from './sitemap.js';
|
|
5
6
|
const digest = (value) => createHash('sha256').update(value).digest('hex');
|
|
6
|
-
const keyFor =
|
|
7
|
-
export function buildPublicationManifest({ fictionalDocuments, configDigest, synonyms, basePath, publicPath, readerFilters, taxonomy, dependencies, rendered, resolvedNavigation, cardUses, snippetUses, apiEmbedUses, focusedContracts, operations, publishedRelationships, redirects, apiSources, siteOrigin, siteIndexing, siteUpdated, diagramAssets, heroImages, faviconRoute, catalog }) {
|
|
7
|
+
const keyFor = documentKey;
|
|
8
|
+
export function buildPublicationManifest({ configPublications, fictionalDocuments, configDigest, synonyms, basePath, publicPath, readerFilters, taxonomy, dependencies, rendered, resolvedNavigation, cardUses, snippetUses, apiEmbedUses, focusedContracts, operations, publishedRelationships, redirects, apiSources, siteOrigin, siteIndexing, siteUpdated, diagramAssets, heroImages, faviconRoute, catalog }) {
|
|
8
9
|
const indexable = (doc) => siteIndexing && doc.frontmatter.seo?.noindex !== true;
|
|
9
10
|
const updatedFor = (doc) => doc.frontmatter.updated ?? siteUpdated;
|
|
10
11
|
const tabs = [...resolvedNavigation].flatMap(([key, nodes]) => {
|
|
11
|
-
const
|
|
12
|
-
return nodes.filter(node => node.tab).map(node => navigationTabRecord(node,
|
|
12
|
+
const variant = parsePublicationKey(key);
|
|
13
|
+
return nodes.filter(node => node.tab).map(node => navigationTabRecord(node, variant, basePath));
|
|
13
14
|
});
|
|
14
15
|
const tabFor = (doc) => {
|
|
15
|
-
const node = navigationTab(resolvedNavigation.get(
|
|
16
|
+
const node = navigationTab(resolvedNavigation.get(publicationKey(doc.variant)) ?? [], doc.route);
|
|
16
17
|
return node ? { navigationTab: navigationTabRecord(node, doc.variant, basePath) } : {};
|
|
17
18
|
};
|
|
18
19
|
const sitemaps = siteOrigin && siteIndexing ? sitemapFiles(siteOrigin, rendered.filter(page => indexable(page.doc)).map(page => ({ route: page.doc.route, updated: updatedFor(page.doc) })).concat([{ route: publicPath('/llms.txt'), updated: undefined }]), {}, basePath) : new Map();
|
|
20
|
+
// Publish one compact catalog, limited to releases present in this edition.
|
|
21
|
+
const enabled = [...new Map(rendered.map(({ doc }) => [publicationKey(doc.variant), doc.variant])).values()];
|
|
22
|
+
const products = configPublications.products ? Object.fromEntries(Object.entries(configPublications.products).flatMap(([id, definition]) => {
|
|
23
|
+
const versions = [...new Set(enabled.filter(variant => variant.product === id).map(variant => variant.version))];
|
|
24
|
+
return versions.length ? [[id, { ...(definition.label ? { label: definition.label } : {}), ...(versions.includes(definition.defaultVersion) ? { defaultVersion: definition.defaultVersion } : {}), versions }]] : [];
|
|
25
|
+
})) : undefined;
|
|
19
26
|
const manifest = {
|
|
20
27
|
schemaVersion: 1,
|
|
21
28
|
configDigest: configDigest,
|
|
29
|
+
...(products ? { publications: { enabled, products } } : {}),
|
|
22
30
|
...(synonyms.length ? { searchSynonyms: synonyms } : {}),
|
|
23
31
|
basePath,
|
|
24
32
|
...(sitemaps.size ? { sitemap: publicPath('/sitemap.xml') } : {}),
|
|
@@ -26,7 +34,7 @@ export function buildPublicationManifest({ fictionalDocuments, configDigest, syn
|
|
|
26
34
|
...(taxonomy ? { taxonomy } : {}),
|
|
27
35
|
dependencies,
|
|
28
36
|
...(tabs.length ? { navigationTabs: tabs } : {}),
|
|
29
|
-
documents: rendered.map(({ doc, markdown, sections }) => ({ id: doc.frontmatter.id, demo: fictionalDocuments.has(doc), type: doc.frontmatter.type, title: doc.frontmatter.title, summary: doc.frontmatter.summary, subjectLifecycle: doc.frontmatter.subjectLifecycle ?? null, ...(doc.change ? { change: doc.change } : {}), ...(doc.subjectDeprecation ? { subjectDeprecation: doc.subjectDeprecation } : {}), variant: doc.variant, url: doc.route, markdownUrl: doc.markdownRoute, ...tabFor(doc), indexable: indexable(doc), ...(updatedFor(doc) ? { updated: updatedFor(doc) } : {}), ...(doc.frontmatter.verified ? { verified: doc.frontmatter.verified } : {}), contentDigest: doc.contentDigest, breadcrumbs: navigationPath(resolvedNavigation.get(
|
|
37
|
+
documents: rendered.map(({ doc, markdown, sections }) => ({ id: doc.frontmatter.id, demo: fictionalDocuments.has(doc), type: doc.frontmatter.type, title: doc.frontmatter.title, summary: doc.frontmatter.summary, subjectLifecycle: doc.frontmatter.subjectLifecycle ?? null, ...(doc.change ? { change: doc.change } : {}), ...(doc.subjectDeprecation ? { subjectDeprecation: doc.subjectDeprecation } : {}), variant: doc.variant, url: doc.route, markdownUrl: doc.markdownRoute, ...tabFor(doc), indexable: indexable(doc), ...(updatedFor(doc) ? { updated: updatedFor(doc) } : {}), ...(doc.frontmatter.availability ? { availability: doc.frontmatter.availability } : {}), ...(doc.frontmatter.verified ? { verified: doc.frontmatter.verified } : {}), contentDigest: doc.contentDigest, breadcrumbs: navigationPath(resolvedNavigation.get(publicationKey(doc.variant)) ?? [], doc.route), ...(doc.frontmatter.product !== undefined ? { product: doc.frontmatter.product } : {}), ...(doc.frontmatter.area !== undefined ? { area: doc.frontmatter.area } : {}), ...(doc.frontmatter.subarea !== undefined ? { subarea: doc.frontmatter.subarea } : {}), ...(readerFilters ? { readerFilters: doc.readerFilters ?? {} } : {}), cardTargets: cardUses.get(doc)?.targets ?? [], cardQueries: cardUses.get(doc)?.queries ?? [], snippets: [...new Set(snippetUses.filter(use => use.documentId === doc.frontmatter.id).map(use => use.id))], apiEmbeds: apiEmbedUses.filter(use => use.documentKey === keyFor(doc.frontmatter.id, doc.variant)).map(({ sourceFile, documentKey, ...request }) => request), focusedContractUrl: doc.focusedContractUrl ?? null, focusedContractBytes: doc.focusedContractUrl ? focusedContracts.get(doc.focusedContractUrl)?.bytes : null, focusedContractDigest: doc.focusedContractUrl ? focusedContracts.get(doc.focusedContractUrl)?.digest : null, sections: (sections ?? []).map(({ content, ...record }) => record), ...markdownSize(markdown), digest: digest(markdown) })),
|
|
30
38
|
operations,
|
|
31
39
|
relationships: publishedRelationships,
|
|
32
40
|
redirects,
|
package/dist/publication-plan.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { documentKey, samePublication } from './publication-identity.js';
|
|
1
2
|
import { hasScaffoldPlaceholders } from './scaffold-placeholders.js';
|
|
2
3
|
import { validateFeatureClassification, matchesFeatures } from './deployment-profile.js';
|
|
3
4
|
import { matchesContentFilter } from './content-filter.js';
|
|
@@ -7,8 +8,8 @@ import { markdownRoute, readDocument, routeFor } from './content.js';
|
|
|
7
8
|
import { applyFormattingLocale, validateFrontmatter } from './frontmatter.js';
|
|
8
9
|
import { mergeProvidedMetadata } from './metadata-provider.js';
|
|
9
10
|
import { pageReaderFilters } from './reader-filters.js';
|
|
10
|
-
import { configField } from './compiler-config.js';
|
|
11
|
-
const keyFor =
|
|
11
|
+
import { resolvePublication, configField } from './compiler-config.js';
|
|
12
|
+
const keyFor = documentKey;
|
|
12
13
|
async function files(dir) {
|
|
13
14
|
const entries = await readdir(dir, { withFileTypes: true });
|
|
14
15
|
const nested = await Promise.all(entries.map(async (entry) => entry.isDirectory() ? files(path.join(dir, entry.name)) : /\.mdx?$/.test(entry.name) ? [path.join(dir, entry.name)] : []));
|
|
@@ -38,27 +39,38 @@ export async function planAuthoredDocuments({ base, basePath, config, variants,
|
|
|
38
39
|
return merged.page;
|
|
39
40
|
} : undefined, sourceOverrides?.get(file));
|
|
40
41
|
frontmatter.language ??= language;
|
|
42
|
+
// A product's release default never comes from the legacy global version.
|
|
43
|
+
if (config.publications.products && frontmatter.product && !frontmatter.publications) {
|
|
44
|
+
if (!Object.hasOwn(config.publications.products, frontmatter.product))
|
|
45
|
+
throw new Error(`${file}: unknown publication product ${frontmatter.product}`);
|
|
46
|
+
const enforcedVersion = configField(configField(config.frontmatter, 'enforced'), 'version');
|
|
47
|
+
if (sourceFrontmatter.version === undefined && enforcedVersion === undefined)
|
|
48
|
+
frontmatter.version = resolvePublication(config.publications, { ...frontmatter, version: undefined }, language).version;
|
|
49
|
+
resolvePublication(config.publications, frontmatter, language);
|
|
50
|
+
}
|
|
41
51
|
applyFormattingLocale(frontmatter, config.frontmatter, sourceFrontmatter);
|
|
42
52
|
validateFrontmatter(frontmatter, config.frontmatter, file, sourceFrontmatter);
|
|
43
53
|
const pagePublications = frontmatter.publications;
|
|
44
54
|
if (pagePublications) {
|
|
45
|
-
if (sourceFrontmatter.channel !== undefined || sourceFrontmatter.version !== undefined)
|
|
55
|
+
if (sourceFrontmatter.channel !== undefined || sourceFrontmatter.version !== undefined || (config.publications.products && sourceFrontmatter.product !== undefined))
|
|
46
56
|
throw new Error(`${file}: use publications instead of page-level channel or version`);
|
|
47
57
|
for (const publication of pagePublications) {
|
|
48
|
-
|
|
49
|
-
throw new Error(`${file}: unknown publication ${publication.channel}/${publication.version}`);
|
|
58
|
+
resolvePublication(config.publications, publication, language);
|
|
50
59
|
const enforced = configField(config.frontmatter, 'enforced');
|
|
51
|
-
if (configField(enforced, 'channel') && configField(enforced, 'channel') !== publication.channel || configField(enforced, 'version') && configField(enforced, 'version') !== publication.version)
|
|
60
|
+
if (configField(enforced, 'channel') && configField(enforced, 'channel') !== publication.channel || configField(enforced, 'version') && configField(enforced, 'version') !== publication.version || config.publications.products && configField(enforced, 'product') && configField(enforced, 'product') !== publication.product)
|
|
52
61
|
throw new Error(`${file}: publications conflicts with enforced channel or version`);
|
|
53
62
|
}
|
|
54
63
|
}
|
|
55
64
|
knownDocumentIds.add(frontmatter.id);
|
|
65
|
+
const previousType = knownDocumentTypes.get(frontmatter.id);
|
|
66
|
+
if (previousType !== undefined && previousType !== frontmatter.type)
|
|
67
|
+
throw new Error(`${file}: stable document ID ${frontmatter.id} has inconsistent types across publications (${previousType} and ${frontmatter.type})`);
|
|
56
68
|
knownDocumentTypes.set(frontmatter.id, frontmatter.type);
|
|
57
69
|
if (frontmatter.type === 'api-reference')
|
|
58
70
|
for (const operation of frontmatter.operations ?? [])
|
|
59
71
|
authoredOperationIds.add(operation);
|
|
60
72
|
const classificationVariants = featureContext?.classificationPublications ?? variants;
|
|
61
|
-
const classificationEligible = frontmatter.access?.policy === 'public' && classificationVariants.some(variant => (pagePublications ? pagePublications.some(item => item.
|
|
73
|
+
const classificationEligible = frontmatter.access?.policy === 'public' && classificationVariants.some(variant => (pagePublications ? pagePublications.some(item => samePublication({ ...item, language: frontmatter.language }, variant)) : samePublication({ channel: frontmatter.channel, version: frontmatter.version, language: frontmatter.language, ...(config.publications.products && frontmatter.product ? { product: frontmatter.product } : {}) }, variant)) && frontmatter.language === variant.language);
|
|
62
74
|
if (classificationEligible)
|
|
63
75
|
validateFeatureClassification(sourceFrontmatter, featureContext, `${file}: ${frontmatter.id}`);
|
|
64
76
|
const included = matchesFeatures(frontmatter.requires, featureContext, `${file}: ${frontmatter.id}`);
|
|
@@ -80,13 +92,13 @@ export async function planAuthoredDocuments({ base, basePath, config, variants,
|
|
|
80
92
|
throw new Error(`${file}: unresolved scaffold placeholders cannot be published`);
|
|
81
93
|
let selectedPublication = false;
|
|
82
94
|
for (const variant of variants) {
|
|
83
|
-
if (pagePublications ? !pagePublications.some(item => item
|
|
95
|
+
if (pagePublications ? !pagePublications.some(item => samePublication({ ...item, language: frontmatter.language }, variant)) : (frontmatter.channel && frontmatter.channel !== variant.channel || frontmatter.version && frontmatter.version !== variant.version || (config.publications.products && frontmatter.product !== variant.product)))
|
|
84
96
|
continue;
|
|
85
97
|
if (frontmatter.language && frontmatter.language !== variant.language)
|
|
86
98
|
continue;
|
|
87
99
|
if (!pagePublications && (!frontmatter.channel || !frontmatter.version || !frontmatter.language))
|
|
88
100
|
throw new Error(`${file}: resolved frontmatter needs publication channel and version`);
|
|
89
|
-
const publishedFrontmatter = pagePublications ? { ...frontmatter, channel: variant.channel, version: variant.version } : frontmatter;
|
|
101
|
+
const publishedFrontmatter = pagePublications ? { ...frontmatter, channel: variant.channel, version: variant.version, ...(variant.product ? { product: variant.product } : {}) } : frontmatter;
|
|
90
102
|
const key = keyFor(frontmatter.id, variant);
|
|
91
103
|
if (docs.has(key))
|
|
92
104
|
throw new Error(`Duplicate document identity ${key}`);
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import { documentKey, publicationKey, samePublication } from './publication-identity.js';
|
|
1
2
|
import { resolveAuthoredChange, authoredChangeNotice } from './authored-change.js';
|
|
2
3
|
import { resolveSubjectDeprecation, subjectDeprecationNotice } from './subject-deprecation.js';
|
|
3
4
|
import { markdownSections } from './markdown-sections.js';
|
|
4
5
|
import { contentDigest } from './freshness.js';
|
|
5
|
-
import { configField } from './compiler-config.js';
|
|
6
|
+
import { configField, isConfigMapping } from './compiler-config.js';
|
|
6
7
|
import { fictionalDocument, resolveLlmsDiscovery } from './llms-discovery.js';
|
|
7
8
|
import { publicationRelationships, resolveCardTree } from './cards.js';
|
|
8
9
|
import { resolveCookbookTree } from './cookbook-chooser.js';
|
|
@@ -10,13 +11,17 @@ import { buildHtmlPage, heading, link, markdownRoute, paragraph, projectMetadata
|
|
|
10
11
|
import { navigationPath, navigationTab, navigationTabRecord, resolveProjectNavigation } from './project-navigation.js';
|
|
11
12
|
import { outputUrl, publicTree, resolveOutputLinks } from './representation-tree.js';
|
|
12
13
|
import { presetCatalog } from './palettes.js';
|
|
13
|
-
const keyFor =
|
|
14
|
+
const keyFor = documentKey;
|
|
14
15
|
export function renderPublicationPages({ rendered, docs, relationships, knownOperations, cardUses, publishedRelationships, cookbooks, documentRoutes, basePath, siteOrigin, colorMode, config, highlighter, editionLabel, customStyleFile, themePreset, palette, themeStyleFile, generatedPaletteCss, generatedBadgeCss, themeSwitcherData, generatedFontsCss, fontsPreload, shareFor, faviconRoute, logoRoute, modeToggle, header, footer, search, readerFilters, variants, externalDocuments, externalSiteLinks, navigationSpec, navigationEntries, navigationTagOrder, freshness }) {
|
|
15
16
|
const resolvedNavigation = new Map();
|
|
17
|
+
const selector = config.site.publicationSelector;
|
|
18
|
+
if (selector !== undefined && (!isConfigMapping(selector) || Object.keys(selector).some(key => key !== 'showLanguage') || (selector.showLanguage !== undefined && typeof selector.showLanguage !== 'boolean')))
|
|
19
|
+
throw new Error('site.publicationSelector must be a mapping with an optional boolean showLanguage');
|
|
20
|
+
const showLanguage = isConfigMapping(selector) && typeof selector.showLanguage === 'boolean' ? selector.showLanguage : new Set(rendered.map(item => item.doc.variant.language)).size > 1;
|
|
16
21
|
const scopedRelationships = new Map();
|
|
17
22
|
const hasHome = rendered.some(page => page.doc.route === basePath || page.doc.route === '/');
|
|
18
23
|
for (const page of rendered) {
|
|
19
|
-
const navVariant =
|
|
24
|
+
const navVariant = publicationKey(page.doc.variant);
|
|
20
25
|
let edges = scopedRelationships.get(navVariant);
|
|
21
26
|
if (!edges) {
|
|
22
27
|
const local = new Map([...docs.values()].filter(doc => keyFor(doc.frontmatter.id, doc.variant) === keyFor(doc.frontmatter.id, page.doc.variant)).map(doc => [doc.frontmatter.id, doc]));
|
|
@@ -60,7 +65,7 @@ export function renderPublicationPages({ rendered, docs, relationships, knownOpe
|
|
|
60
65
|
...(index ? [text(' > ')] : []),
|
|
61
66
|
crumb.url && index < breadcrumbs.length - 1 ? link(outputUrl(markdownRoute(crumb.url, basePath), page.doc.route, siteOrigin, 'markdown', documentRoutes, basePath), crumb.label) : text(crumb.label)
|
|
62
67
|
]))])) + '\n' : '');
|
|
63
|
-
page.markdown = projectMetadata(page.doc, config) + renderMarkdown(root([heading(1, page.doc.frontmatter.title)])) + '\n' + renderMarkdown(root([{ type: 'blockquote', children: [paragraph(text('Documentation index: '), link(outputUrl(`${basePath}/llms.min.txt`, page.doc.route, siteOrigin, 'markdown', documentRoutes, basePath), 'llms.min.txt'), text(' · Document manifest: '), link(outputUrl(`${basePath}/documents.json`, page.doc.route, siteOrigin, 'markdown', documentRoutes, basePath), 'documents.json'))] }])) + '\n' + breadcrumbMarkdown + (page.doc.frontmatter.date ? markdownLabel('Published', page.doc.frontmatter.date) : '') + (page.doc.frontmatter.updated && !(page.doc.frontmatter.type === 'changelog-entry' && page.doc.frontmatter.date) ? markdownLabel('Updated', page.doc.frontmatter.updated) : '') + (page.doc.frontmatter.verified ? markdownLabel('Verified', page.doc.frontmatter.verified) : '') + (page.doc.frontmatter.releaseVersion ? markdownLabel('Version', page.doc.frontmatter.releaseVersion) : '') + (subjectLifecycleLabel ? markdownLabel('Status', subjectLifecycleLabel) : '') + noticeMarkdown + renderMarkdown(mdTree);
|
|
68
|
+
page.markdown = projectMetadata(page.doc, config) + renderMarkdown(root([heading(1, page.doc.frontmatter.title)])) + '\n' + renderMarkdown(root([{ type: 'blockquote', children: [paragraph(text('Documentation index: '), link(outputUrl(`${basePath}/llms.min.txt`, page.doc.route, siteOrigin, 'markdown', documentRoutes, basePath), 'llms.min.txt'), text(' · Document manifest: '), link(outputUrl(`${basePath}/documents.json`, page.doc.route, siteOrigin, 'markdown', documentRoutes, basePath), 'documents.json'))] }])) + '\n' + breadcrumbMarkdown + (page.doc.frontmatter.date ? markdownLabel('Published', page.doc.frontmatter.date) : '') + (page.doc.frontmatter.updated && !(page.doc.frontmatter.type === 'changelog-entry' && page.doc.frontmatter.date) ? markdownLabel('Updated', page.doc.frontmatter.updated) : '') + (page.doc.frontmatter.availability?.since ? markdownLabel('Available since', page.doc.frontmatter.availability.since) : '') + (page.doc.frontmatter.availability?.through ? markdownLabel('Available through', page.doc.frontmatter.availability.through) : '') + (page.doc.frontmatter.verified ? markdownLabel('Verified', page.doc.frontmatter.verified) : '') + (page.doc.frontmatter.releaseVersion ? markdownLabel('Version', page.doc.frontmatter.releaseVersion) : '') + (subjectLifecycleLabel ? markdownLabel('Status', subjectLifecycleLabel) : '') + noticeMarkdown + renderMarkdown(mdTree);
|
|
64
69
|
const body = renderMarkdown(mdTree);
|
|
65
70
|
const sectionPrefix = page.markdown.slice(0, -body.length) + (fictional ? renderMarkdown(root([mdTree.children[0]])) + '\n' : '');
|
|
66
71
|
page.sections = markdownSections(page.doc.tree, page.doc.markdownRoute, page.markdown, sectionPrefix, tree => {
|
|
@@ -71,22 +76,33 @@ export function renderPublicationPages({ rendered, docs, relationships, knownOpe
|
|
|
71
76
|
...(node.children ? { children: node.children.map(parentLinks) } : {}) });
|
|
72
77
|
return renderMarkdown(parentLinks(resolved));
|
|
73
78
|
}, page.doc.frontmatter.standaloneSections);
|
|
74
|
-
const externalForPage = externalDocuments.get(page.doc.frontmatter.id) ?? [];
|
|
79
|
+
const externalForPage = (externalDocuments.get(page.doc.frontmatter.id) ?? []).filter(item => item.variant.product === page.doc.variant.product);
|
|
75
80
|
const shownLanguages = new Set([...variants.map(variant => variant.language), ...externalForPage.map(item => item.variant.language)]).size > 1;
|
|
76
81
|
const languageSuffix = (variant) => shownLanguages ? ` · ${variant.language}` : '';
|
|
77
|
-
const localAlternates = variants.flatMap(variant => {
|
|
82
|
+
const localAlternates = variants.filter(variant => variant.product === page.doc.variant.product).flatMap(variant => {
|
|
78
83
|
const alternate = docs.get(keyFor(page.doc.frontmatter.id, variant));
|
|
79
84
|
const label = `${variant.channel} · ${variant.version}${languageSuffix(variant)}`;
|
|
80
85
|
if (alternate)
|
|
81
86
|
return [{ label, url: alternate.route, current: alternate === page.doc }];
|
|
82
|
-
const overview = [...docs.values()].filter(doc => doc.variant
|
|
87
|
+
const overview = [...docs.values()].filter(doc => samePublication(doc.variant, variant) && doc.frontmatter.access?.policy === 'public').sort((a, b) => a.route.length - b.route.length || a.route.localeCompare(b.route))[0];
|
|
83
88
|
return overview ? [{ label: `${label} · page unavailable; open overview`, url: overview.route, current: false }] : [];
|
|
84
89
|
});
|
|
85
90
|
const publicationAlternates = [...localAlternates, ...externalSiteLinks, ...externalForPage.map(item => ({
|
|
86
91
|
label: `${item.label}${item.label.toLowerCase() === item.variant.channel.toLowerCase() ? '' : ` · ${item.variant.channel}`} · ${item.variant.version}${languageSuffix(item.variant)}`,
|
|
87
92
|
url: item.url, current: false
|
|
88
93
|
}))];
|
|
89
|
-
|
|
94
|
+
// Derive choices from the selected output, not the catalog: a customer
|
|
95
|
+
// edition must not advertise products or releases it did not publish.
|
|
96
|
+
const publicationChoices = config.publications.products ? [...new Map(rendered.map(item => [publicationKey(item.doc.variant), item.doc.variant])).values()]
|
|
97
|
+
.sort((left, right) => (left.product ?? '').localeCompare(right.product ?? '') || publicationKey(left).localeCompare(publicationKey(right)))
|
|
98
|
+
.flatMap(variant => {
|
|
99
|
+
const target = docs.get(keyFor(page.doc.frontmatter.id, variant)) ?? rendered.filter(item => samePublication(item.doc.variant, variant)).map(item => item.doc).sort((left, right) => left.route.length - right.route.length || left.route.localeCompare(right.route))[0];
|
|
100
|
+
if (!target)
|
|
101
|
+
return [];
|
|
102
|
+
const group = variant.product === undefined ? config.site.title : config.publications.products?.[variant.product]?.label ?? variant.product;
|
|
103
|
+
return [{ group, label: `${group} · ${variant.channel} · ${variant.version}${showLanguage ? ` · ${variant.language}` : ''}`, url: target.route, current: samePublication(page.doc.variant, variant) }];
|
|
104
|
+
}) : [];
|
|
105
|
+
page.html = buildHtmlPage(page.doc, page.htmlTree, page.doc.markdownRoute, config.site.title, navigation, page.pageExamples, page.pageShapes, highlighter, editionLabel(page.doc.variant), !!customStyleFile, { preset: themePreset, palette: palette.name, themeCss: !!themeStyleFile, paletteCss: !!generatedPaletteCss, badgesCss: !!generatedBadgeCss, themeSwitcher: themeSwitcherData, fontsCss: !!generatedFontsCss, preloadFont: fontsPreload, masthead: presetCatalog.find(preset => preset.name === themePreset)?.masthead, share: shareFor(page.doc), favicon: faviconRoute, logo: logoRoute, touchIcon: !faviconRoute.endsWith('.png'), origin: siteOrigin, indexing: config.site.indexing !== false, home: hasHome, mode: colorMode, toggle: modeToggle, header, footer, search: search.provider !== 'none', publicationChoices, publicationAlternates, breadcrumbs }, page.pageCurl, page.pageSamples, { ...config, readerFilters });
|
|
90
106
|
}
|
|
91
107
|
return resolvedNavigation;
|
|
92
108
|
}
|
package/dist/recipe-draft.js
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { resolvePublication } from './compiler-config.js';
|
|
2
|
+
import { samePublication } from './publication-identity.js';
|
|
1
3
|
import { createHash } from 'node:crypto';
|
|
2
4
|
import { mkdir, readFile, realpath, writeFile } from 'node:fs/promises';
|
|
3
5
|
import path from 'node:path';
|
|
@@ -17,8 +19,10 @@ function parseYaml(source, file) {
|
|
|
17
19
|
return document.toJS();
|
|
18
20
|
}
|
|
19
21
|
function parseSpec(value) {
|
|
20
|
-
if (!object(value) || value.schemaVersion !== 1 || Object.keys(value).some(key => !['schemaVersion', 'id', 'title', 'summary', 'slug', 'ingredients', 'inputs', 'outcome'].includes(key)))
|
|
22
|
+
if (!object(value) || value.schemaVersion !== 1 || Object.keys(value).some(key => !['schemaVersion', 'id', 'title', 'summary', 'slug', 'ingredients', 'inputs', 'outcome', 'publication'].includes(key)))
|
|
21
23
|
throw new Error('Recipe spec needs schemaVersion: 1 and only supported fields');
|
|
24
|
+
if (value.publication !== undefined && (!object(value.publication) || Object.keys(value.publication).some(key => !['product', 'channel', 'version', 'language'].includes(key)) || Object.values(value.publication).some(item => typeof item !== 'string' || !item)))
|
|
25
|
+
throw new Error('Recipe publication must declare product/channel/version/language strings');
|
|
22
26
|
workflowValues(value.inputs, 'Recipe inputs');
|
|
23
27
|
if (value.outcome !== undefined && (typeof value.outcome !== 'string' || !value.outcome.trim()))
|
|
24
28
|
throw new Error('Recipe outcome must be nonempty text');
|
|
@@ -59,9 +63,8 @@ export async function renderRecipeDraft(configFile, specFile) {
|
|
|
59
63
|
const config = (await loadConfig(configPath)).value;
|
|
60
64
|
const spec = parseSpec(parseYaml(await readFile(specFile, 'utf8'), specFile));
|
|
61
65
|
const defaults = config.publications?.defaults ?? {};
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
const language = defaults.language ?? defaultLanguage(config);
|
|
66
|
+
const product = spec.publication?.product ?? defaults.product;
|
|
67
|
+
const publication = resolvePublication(config.publications, { ...defaults, ...spec.publication, ...(product ? { product, version: spec.publication?.version } : {}) }, defaultLanguage(config));
|
|
65
68
|
const seen = new Set();
|
|
66
69
|
const operations = new Set();
|
|
67
70
|
const sources = [];
|
|
@@ -95,7 +98,7 @@ export async function renderRecipeDraft(configFile, specFile) {
|
|
|
95
98
|
for (const prerequisite of workflow.prerequisites)
|
|
96
99
|
prerequisites.add(prerequisite);
|
|
97
100
|
}
|
|
98
|
-
if (header.channel
|
|
101
|
+
if (!samePublication({ channel: String(header.channel), version: String(header.version), language: String(header.language), ...(config.publications.products && header.product ? { product: String(header.product) } : {}) }, publication))
|
|
99
102
|
throw new Error(`Ingredient ${header.id} must match the recipe's default publication`);
|
|
100
103
|
if (header.operations !== undefined) {
|
|
101
104
|
if (!Array.isArray(header.operations) || header.operations.some(value => typeof value !== 'string'))
|
|
@@ -111,7 +114,7 @@ export async function renderRecipeDraft(configFile, specFile) {
|
|
|
111
114
|
}
|
|
112
115
|
const header = {
|
|
113
116
|
id: spec.id, title: spec.title, summary: spec.summary, type: 'recipe', slug: spec.slug,
|
|
114
|
-
|
|
117
|
+
...publication,
|
|
115
118
|
...(operations.size ? { operations: [...operations] } : {}), access: { policy: 'draft' }
|
|
116
119
|
};
|
|
117
120
|
const sourceDigest = digest([JSON.stringify(spec), ...sources].join('\n'));
|
package/dist/scaffold.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export type ScaffoldInput = {
|
|
|
4
4
|
summary: string;
|
|
5
5
|
slug: string;
|
|
6
6
|
operations?: string[];
|
|
7
|
+
product?: string;
|
|
7
8
|
channel?: string;
|
|
8
9
|
version?: string;
|
|
9
10
|
language?: string;
|
|
@@ -19,8 +20,9 @@ export declare function scaffold(configFile: string, templateId: string, targetF
|
|
|
19
20
|
id: string;
|
|
20
21
|
file: string;
|
|
21
22
|
publication: {
|
|
22
|
-
|
|
23
|
-
|
|
23
|
+
product?: string;
|
|
24
|
+
channel: string;
|
|
25
|
+
version: string;
|
|
24
26
|
language: string;
|
|
25
27
|
};
|
|
26
28
|
access: string;
|
|
@@ -31,8 +33,9 @@ export declare function scaffoldFromPath(configFile: string, templateId: string,
|
|
|
31
33
|
id: string;
|
|
32
34
|
file: string;
|
|
33
35
|
publication: {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
+
product?: string;
|
|
37
|
+
channel: string;
|
|
38
|
+
version: string;
|
|
36
39
|
language: string;
|
|
37
40
|
};
|
|
38
41
|
access: string;
|
package/dist/scaffold.js
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { resolvePublication } from './compiler-config.js';
|
|
2
|
+
import { samePublication } from './publication-identity.js';
|
|
1
3
|
import { mkdir, readFile, realpath, writeFile } from 'node:fs/promises';
|
|
2
4
|
import path from 'node:path';
|
|
3
5
|
import { fileURLToPath } from 'node:url';
|
|
@@ -100,14 +102,12 @@ export async function scaffold(configFile, templateId, targetFile, input) {
|
|
|
100
102
|
if (!knownOperations.has(operation))
|
|
101
103
|
throw new Error(`Unknown scaffold operation ${operation}`);
|
|
102
104
|
const defaults = config.publications?.defaults;
|
|
103
|
-
const applicability = resolveFrontmatter(Object.fromEntries(Object.entries({ channel: input.channel, version: input.version, language: input.language }).filter(([, value]) => value !== undefined)), config.frontmatter);
|
|
104
|
-
const
|
|
105
|
-
const
|
|
106
|
-
const
|
|
107
|
-
if (!
|
|
108
|
-
throw new Error(
|
|
109
|
-
if (!config.publications?.enabled?.some((item) => item.channel === channel && item.version === version && (item.language ?? defaultLanguage(config)) === language))
|
|
110
|
-
throw new Error(`Scaffold publication ${channel}/${version}/${language} is not enabled`);
|
|
105
|
+
const applicability = resolveFrontmatter(Object.fromEntries(Object.entries({ product: input.product, channel: input.channel, version: input.version, language: input.language }).filter(([, value]) => value !== undefined)), config.frontmatter);
|
|
106
|
+
const product = config.publications?.products ? applicability.product ?? defaults?.product : undefined;
|
|
107
|
+
const publication = resolvePublication(config.publications, { ...applicability, product, ...(product ? { product, version: config.frontmatter?.enforced?.version ?? input.version } : {}), channel: applicability.channel ?? defaults?.channel }, defaultLanguage(config));
|
|
108
|
+
const { channel, version, language } = publication;
|
|
109
|
+
if (!config.publications?.enabled?.some((item) => samePublication(resolvePublication(config.publications, item, defaultLanguage(config)), publication)))
|
|
110
|
+
throw new Error(`Scaffold publication ${product ? product + '/' : ''}${channel}/${version}/${language} is not enabled`);
|
|
111
111
|
const root = path.dirname(path.resolve(configFile));
|
|
112
112
|
const contentDir = await canonicalPath(path.resolve(root, config.site?.contentDir ?? 'content'));
|
|
113
113
|
const target = await canonicalPath(targetFile);
|
|
@@ -118,13 +118,13 @@ export async function scaffold(configFile, templateId, targetFile, input) {
|
|
|
118
118
|
? path.resolve(path.dirname(explainSegments(loaded, ['templates', templateId, 'body']).source.file), template.body)
|
|
119
119
|
: path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../templates', template.body);
|
|
120
120
|
const { header, body } = splitTemplate(await readFile(bodyFile, 'utf8'), bodyFile);
|
|
121
|
-
const frontmatter = { id: input.id, title: input.title, summary: input.summary, type: template.type, slug: input.slug,
|
|
122
|
-
routeFor(frontmatter,
|
|
121
|
+
const frontmatter = { id: input.id, title: input.title, summary: input.summary, type: template.type, slug: input.slug, ...publication, ...(!config.publications?.products && applicability.product ? { product: applicability.product } : {}), ...(input.operations?.length ? { operations: input.operations } : {}), access: { policy: 'draft' } };
|
|
122
|
+
routeFor(frontmatter, publication, config);
|
|
123
123
|
const written = header ? fillTemplateHeader(header, frontmatter) : YAML.stringify(frontmatter);
|
|
124
124
|
const content = `---\n${written.replace(/\s*$/, '\n')}---\n\n${body.trimStart().replace(/\s*$/, '\n')}`;
|
|
125
125
|
await mkdir(path.dirname(target), { recursive: true });
|
|
126
126
|
await writeFile(target, content, { flag: 'wx' });
|
|
127
|
-
return { status: 'ok', template: templateId, id: input.id, file: target, publication
|
|
127
|
+
return { status: 'ok', template: templateId, id: input.id, file: target, publication, access: 'draft' };
|
|
128
128
|
}
|
|
129
129
|
export async function scaffoldFromPath(configFile, templateId, targetFile, overrides = {}) {
|
|
130
130
|
const loaded = await loadConfig(configFile);
|
|
@@ -137,14 +137,14 @@ export async function scaffoldFromPath(configFile, templateId, targetFile, overr
|
|
|
137
137
|
if (parts.some(part => !part))
|
|
138
138
|
throw new Error('Scaffold target needs a usable filename');
|
|
139
139
|
const title = parts.at(-1).split('-').map(word => word[0].toUpperCase() + word.slice(1)).join(' ');
|
|
140
|
-
const selected = resolveFrontmatter(Object.fromEntries(Object.entries({ channel: overrides.channel, version: overrides.version, language: overrides.language }).filter(([, value]) => value !== undefined)), config.frontmatter);
|
|
141
|
-
const
|
|
142
|
-
const version = selected.version ?? config.publications?.defaults?.
|
|
143
|
-
const language = selected.language ?? defaultLanguage(config);
|
|
140
|
+
const selected = resolveFrontmatter(Object.fromEntries(Object.entries({ product: overrides.product, channel: overrides.channel, version: overrides.version, language: overrides.language }).filter(([, value]) => value !== undefined)), config.frontmatter);
|
|
141
|
+
const product = config.publications?.products ? selected.product ?? config.publications?.defaults?.product : undefined;
|
|
142
|
+
const { channel, version, language } = resolvePublication(config.publications, { ...selected, product, ...(product ? { product, version: config.frontmatter?.enforced?.version ?? overrides.version } : {}), channel: selected.channel ?? config.publications?.defaults?.channel }, defaultLanguage(config));
|
|
144
143
|
const prefixGroups = [
|
|
145
144
|
language === defaultLanguage(config) ? '' : language,
|
|
145
|
+
product ? config.publications.products[product].pathPrefix : '',
|
|
146
146
|
config.publications?.channels?.[channel]?.pathPrefix ?? '',
|
|
147
|
-
config.publications?.versions?.[version]?.pathPrefix ?? ''
|
|
147
|
+
(product ? config.publications.products[product].versions : config.publications?.versions)?.[version]?.pathPrefix ?? ''
|
|
148
148
|
].map(value => value.split('/').filter(Boolean));
|
|
149
149
|
const prefixCandidates = [];
|
|
150
150
|
for (let start = 0; start < prefixGroups.length; start++) {
|
package/dist/search-query.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type SearchOptions = {
|
|
2
|
+
product?: string;
|
|
2
3
|
channel?: string;
|
|
3
4
|
version?: string;
|
|
4
5
|
language?: string;
|
|
@@ -7,22 +8,14 @@ export type SearchOptions = {
|
|
|
7
8
|
export declare function queryBuiltSite(directory: string, query: string, options?: SearchOptions): Promise<{
|
|
8
9
|
status: string;
|
|
9
10
|
query: string;
|
|
10
|
-
publication:
|
|
11
|
-
channel: string;
|
|
12
|
-
version: string;
|
|
13
|
-
language: string;
|
|
14
|
-
};
|
|
11
|
+
publication: import("./publication-identity.js").PublicationCoordinate;
|
|
15
12
|
total: number;
|
|
16
13
|
results: never[];
|
|
17
14
|
matchMode?: undefined;
|
|
18
15
|
} | {
|
|
19
16
|
status: string;
|
|
20
17
|
query: string;
|
|
21
|
-
publication:
|
|
22
|
-
channel: string;
|
|
23
|
-
version: string;
|
|
24
|
-
language: string;
|
|
25
|
-
};
|
|
18
|
+
publication: import("./publication-identity.js").PublicationCoordinate;
|
|
26
19
|
total: number;
|
|
27
20
|
matchMode: string;
|
|
28
21
|
results: {
|
|
@@ -46,6 +39,7 @@ export declare function queryBuiltSite(directory: string, query: string, options
|
|
|
46
39
|
channel: string;
|
|
47
40
|
version: string;
|
|
48
41
|
language: string;
|
|
42
|
+
product?: string | undefined;
|
|
49
43
|
section?: string | undefined;
|
|
50
44
|
id: string;
|
|
51
45
|
};
|
package/dist/search-query.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { parsePublicationKey } from './publication-identity.js';
|
|
1
2
|
import { readFile } from 'node:fs/promises';
|
|
2
3
|
import path from 'node:path';
|
|
3
4
|
import { phraseMatches, queryUnits, validateSearchSynonyms } from './search-synonyms.js';
|
|
@@ -30,18 +31,18 @@ export async function queryBuiltSite(directory, query, options = {}) {
|
|
|
30
31
|
throw new Error('Unsupported or invalid search-index.json');
|
|
31
32
|
const synonyms = validateSearchSynonyms(index.synonyms);
|
|
32
33
|
const matching = index.documents.filter(doc => {
|
|
33
|
-
const
|
|
34
|
-
return (!options.channel || channel === options.channel) && (!options.version || version === options.version) && (!options.language || language === options.language);
|
|
34
|
+
const { product, channel, version, language } = parsePublicationKey(doc.variant);
|
|
35
|
+
return (!options.product || product === options.product) && (!options.channel || channel === options.channel) && (!options.version || version === options.version) && (!options.language || language === options.language);
|
|
35
36
|
});
|
|
36
37
|
const variants = [...new Set(matching.map(doc => doc.variant))].sort();
|
|
37
38
|
if (!variants.length)
|
|
38
39
|
throw new Error('No search documents match the selected publication');
|
|
39
40
|
if (variants.length > 1)
|
|
40
|
-
throw new Error(`Search matches multiple publications (${variants.join(', ')}); pass --channel, --version, and --language`);
|
|
41
|
+
throw new Error(`Search matches multiple publications (${variants.join(', ')}); pass --product where applicable, --channel, --version, and --language`);
|
|
41
42
|
const terms = queryUnits(query, synonyms);
|
|
42
43
|
if (!terms.length) {
|
|
43
|
-
const
|
|
44
|
-
return { status: 'ok', query: query.trim(), publication
|
|
44
|
+
const publication = parsePublicationKey(variants[0]);
|
|
45
|
+
return { status: 'ok', query: query.trim(), publication, total: 0, results: [] };
|
|
45
46
|
}
|
|
46
47
|
const match = (value, unit) => phraseMatches(value, unit.term) || unit.alternatives.some(term => phraseMatches(value, term));
|
|
47
48
|
// Page titles are short subject labels, often singular. Accept a plain final
|
|
@@ -78,10 +79,10 @@ export async function queryBuiltSite(directory, query, options = {}) {
|
|
|
78
79
|
// A complete multiword section-title match outranks incidental page-title words.
|
|
79
80
|
if (meaningful.length >= 2 && candidates.some(candidate => meaningful.every(term => match(candidate.title.toLocaleLowerCase(), term))))
|
|
80
81
|
score += 20;
|
|
81
|
-
const
|
|
82
|
+
const { product, channel, version, language } = parsePublicationKey(doc.variant);
|
|
82
83
|
const tokens = selected?.markdownTokens ?? doc.markdownTokens;
|
|
83
84
|
const read = { tool: selected ? 'get_section' : 'get_page', arguments: {
|
|
84
|
-
id: doc.id, ...(selected ? { section: selected.id } : {}), channel, version, language,
|
|
85
|
+
id: doc.id, ...(selected ? { section: selected.id } : {}), ...(product === undefined ? {} : { product }), channel, version, language,
|
|
85
86
|
...(tokens !== undefined ? { maxTokens: Math.min(100_000, Math.max(4096, tokens * 2 + 1024)) } : {}),
|
|
86
87
|
} };
|
|
87
88
|
return [{ score, contentScore, prominentMatches, matched: matched.length, partialMatched: matched.filter(term => !fallbackStopWords.has(term.term)).length, id: doc.id, type: doc.type, title: doc.title, summary: doc.summary, url: section ? `${doc.url}#${section.id}` : doc.url, markdownUrl: selected?.markdownUrl ?? doc.markdownUrl, pageMarkdownUrl: doc.markdownUrl, read, ...(tokens !== undefined ? { markdownTokens: tokens, markdownBytes: selected?.markdownBytes ?? doc.markdownBytes, markdownTokenEncoding: doc.markdownTokenEncoding } : {}), ...(selected || section ? { section: selected?.title ?? section?.title } : {}), snippet: excerpt(doc.text, terms.flatMap(unit => [unit.term, ...unit.alternatives])) }];
|
|
@@ -115,6 +116,6 @@ export async function queryBuiltSite(directory, query, options = {}) {
|
|
|
115
116
|
}
|
|
116
117
|
return (complete.length ? b.matched - a.matched : b.partialMatched - a.partialMatched) || b.score - a.score || a.title.localeCompare(b.title) || a.id.localeCompare(b.id);
|
|
117
118
|
});
|
|
118
|
-
const
|
|
119
|
-
return { status: 'ok', query: query.trim(), publication
|
|
119
|
+
const publication = parsePublicationKey(variants[0]);
|
|
120
|
+
return { status: 'ok', query: query.trim(), publication, total: ranked.length, matchMode: stronger.length ? 'mixed' : complete.length ? 'all' : 'partial', results: ranked.slice(0, limit).map(({ matched, partialMatched, contentScore, prominentMatches, ...result }) => result) };
|
|
120
121
|
}
|
package/dist/server.d.ts
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
1
|
import { type Server, type ServerResponse } from 'node:http';
|
|
2
|
+
export type PreviewStatus = {
|
|
3
|
+
profile?: string;
|
|
4
|
+
profileDigest?: string;
|
|
5
|
+
buildId?: string;
|
|
6
|
+
error?: string;
|
|
7
|
+
};
|
|
2
8
|
export type SiteExtras = {
|
|
3
9
|
ask?: (request: Request) => Promise<Response>;
|
|
4
10
|
search?: (request: Request) => Promise<Response>;
|
|
5
11
|
widget?: string;
|
|
6
12
|
publicSettings?: Record<string, unknown>;
|
|
7
13
|
panel?: Record<string, string>;
|
|
14
|
+
preview?: PreviewStatus;
|
|
8
15
|
};
|
|
16
|
+
export declare function previewMarkup(basePath: string, preview?: PreviewStatus): string;
|
|
9
17
|
export declare function createSiteServer(directory: string, liveClients?: Set<ServerResponse>, extras?: SiteExtras): Promise<Server>;
|
|
10
18
|
export declare function serveSite(directory: string, host: string, port: number, liveClients?: Set<ServerResponse>, extras?: SiteExtras): Promise<Server>;
|
package/dist/server.js
CHANGED
|
@@ -6,6 +6,13 @@ import { readFile, realpath, stat } from 'node:fs/promises';
|
|
|
6
6
|
import path from 'node:path';
|
|
7
7
|
import { homeUrl, negotiatedDocument } from './negotiation.js';
|
|
8
8
|
const types = { '.html': 'text/html; charset=utf-8', '.md': 'text/markdown; charset=utf-8', '.xml': 'application/xml; charset=utf-8', '.json': 'application/json', '.yaml': 'application/yaml', '.yml': 'application/yaml', '.css': 'text/css; charset=utf-8', '.js': 'text/javascript; charset=utf-8', '.txt': 'text/plain; charset=utf-8', '.png': 'image/png', '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg', '.svg': 'image/svg+xml', '.woff2': 'font/woff2', '.woff': 'font/woff', '.ttf': 'font/ttf', '.otf': 'font/otf' };
|
|
9
|
+
const escapeHtml = (value) => value.replace(/[&<>"']/g, character => ({ '&': '&', '<': '<', '>': '>', '"': '"', "'": ''' }[character]));
|
|
10
|
+
const scriptJson = (value) => JSON.stringify(value).replace(/</g, '\\u003c');
|
|
11
|
+
export function previewMarkup(basePath, preview) {
|
|
12
|
+
const identity = preview?.profile ? `Customer preview: ${preview.profile} (edition ${preview.profileDigest?.slice(0, 12) ?? 'unknown'}, build ${preview.buildId?.slice(0, 12) ?? 'unknown'}).` : '';
|
|
13
|
+
const failure = preview?.error ? `Build failed: ${preview.error}. Showing the last successful build.` : '';
|
|
14
|
+
return `${identity ? `<aside id="shoalrun-preview-edition" role="status">${escapeHtml(identity)}</aside>` : ''}${failure ? `<aside id="shoalrun-build-status" role="alert">${escapeHtml(failure)}</aside>` : ''}<script>const updates=new EventSource(${scriptJson(`${basePath}/__shoalrun/reload`)});updates.addEventListener("built",event=>{const update=JSON.parse(event.data);let pathname=location.pathname;try{pathname=decodeURIComponent(pathname)}catch{}const route=pathname.replace(/\\/+$/,"")||"/";if(update.routes&&!update.routes.includes(route)&&update.home){location.assign(update.home)}else{location.reload()}});updates.addEventListener("failed",event=>{let status=document.getElementById("shoalrun-build-status");if(!status){status=document.createElement("aside");status.id="shoalrun-build-status";status.setAttribute("role","alert");document.body.append(status)}status.textContent="Build failed: "+JSON.parse(event.data).message+". Showing the last successful build."})</script>`;
|
|
15
|
+
}
|
|
9
16
|
const bridgeLimit = 20_000;
|
|
10
17
|
// Read a Node request into a Web `Request`, refusing bodies over the limit before a handler sees them.
|
|
11
18
|
async function bridge(request, response, handler) {
|
|
@@ -91,6 +98,8 @@ export async function createSiteServer(directory, liveClients, extras = {}) {
|
|
|
91
98
|
if (liveClients && pathname === `${basePath}/__shoalrun/reload`) {
|
|
92
99
|
response.writeHead(200, { 'Content-Type': 'text/event-stream', 'Cache-Control': 'no-cache', Connection: 'keep-alive' });
|
|
93
100
|
response.write(': connected\n\n');
|
|
101
|
+
if (extras.preview?.error)
|
|
102
|
+
response.write(`event: failed\ndata: ${JSON.stringify({ message: extras.preview.error })}\n\n`);
|
|
94
103
|
liveClients.add(response);
|
|
95
104
|
response.on('close', () => liveClients.delete(response));
|
|
96
105
|
return;
|
|
@@ -149,7 +158,7 @@ export async function createSiteServer(directory, liveClients, extras = {}) {
|
|
|
149
158
|
const sendRepresentation = (body, resourceHeaders) => {
|
|
150
159
|
const match = request.headers['if-none-match'];
|
|
151
160
|
const etag = resourceHeaders.ETag;
|
|
152
|
-
const notModified = (request.method === 'GET' || request.method === 'HEAD') && etag && match?.split(',').some(value => value.trim() === '*' || value.trim().replace(/^W\//, '') === etag);
|
|
161
|
+
const notModified = !liveClients && (request.method === 'GET' || request.method === 'HEAD') && etag && match?.split(',').some(value => value.trim() === '*' || value.trim().replace(/^W\//, '') === etag);
|
|
153
162
|
response.writeHead(notModified ? 304 : 200, resourceHeaders);
|
|
154
163
|
response.end(notModified || request.method === 'HEAD' ? undefined : body);
|
|
155
164
|
};
|
|
@@ -172,7 +181,7 @@ export async function createSiteServer(directory, liveClients, extras = {}) {
|
|
|
172
181
|
let body = await readFile(file);
|
|
173
182
|
const documentRoute = pathname === '/' ? '/' : pathname.replace(/\/+$/, '');
|
|
174
183
|
const document = manifest.documents.find(item => item.url === documentRoute);
|
|
175
|
-
const injected = `${liveClients ?
|
|
184
|
+
const injected = `${liveClients ? previewMarkup(basePath, extras.preview) : ''}${extras.ask && extras.widget ? `<script src="${basePath}/__shoalrun/ask.js" defer></script>` : ''}`;
|
|
176
185
|
if (injected && file.endsWith('.html') && request.method !== 'HEAD')
|
|
177
186
|
body = Buffer.from(body.toString('utf8').replace('</body>', `${injected}</body>`));
|
|
178
187
|
sendRepresentation(body, { ...(headers[pathname] ?? { 'Content-Type': types[path.extname(file)] ?? 'application/octet-stream' }), ...(file.toLowerCase().endsWith('.svg') ? { 'Content-Security-Policy': 'sandbox' } : {}), ...(document ? { Vary: 'Accept', Link: `<${document.markdownUrl}>; rel="alternate"; type="text/markdown"` } : {}) });
|
|
@@ -206,7 +215,9 @@ export async function createSiteServer(directory, liveClients, extras = {}) {
|
|
|
206
215
|
const document = manifest.documents.find(item => item.markdownUrl === pathname || (markdown && item.url === (pathname.replace(/\/+$/, '') || '/')));
|
|
207
216
|
const twin = document && await siteFile(document.url === '/' ? '/index.html' : `${document.url}/index.html`).then(file => stat(file)).then(info => info.isFile()).catch(() => false) ? document.url : undefined;
|
|
208
217
|
response.writeHead(404, { 'Content-Type': markdown ? 'text/markdown; charset=utf-8' : 'text/html; charset=utf-8', Vary: 'Accept', 'X-Robots-Tag': 'noindex', ...(twin ? { Link: `<${twin}>; rel="alternate"; type="text/html"` } : {}) });
|
|
209
|
-
|
|
218
|
+
let body = !markdown && errorHtml ? (twin ? addNotFoundTwin(errorHtml, twin) : errorHtml) : notFoundPage(basePath, home ?? `${basePath}/`, markdown, twin, search);
|
|
219
|
+
if (!markdown && liveClients)
|
|
220
|
+
body = body.replace('</body>', `${previewMarkup(basePath, extras.preview)}</body>`);
|
|
210
221
|
response.end(request.method === 'HEAD' ? undefined : body);
|
|
211
222
|
}
|
|
212
223
|
});
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { documentKey } from './publication-identity.js';
|
|
1
2
|
import { link, paragraph, root, text } from './semantic-markdown.js';
|
|
2
3
|
export function validateSubjectDeprecation(value, file) {
|
|
3
4
|
if (value === undefined)
|
|
@@ -34,7 +35,7 @@ export function resolveSubjectDeprecation(doc, docs) {
|
|
|
34
35
|
const id = value[key];
|
|
35
36
|
if (!id)
|
|
36
37
|
continue;
|
|
37
|
-
const target = docs.get(
|
|
38
|
+
const target = docs.get(documentKey(id, doc.variant));
|
|
38
39
|
if (id === doc.frontmatter.id || !target || target.frontmatter.access?.policy !== 'public')
|
|
39
40
|
throw new Error(`${doc.file}: subjectDeprecation.${key} must name another public document in the same publication: ${id}`);
|
|
40
41
|
result[key] = { id, title: target.frontmatter.title, url: target.route, markdownUrl: target.markdownRoute };
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
// Canonical, exact hostnames only: no wildcard, URL, credentials, or port.
|
|
2
|
+
export function turnstileHostname(value) {
|
|
3
|
+
if (typeof value !== 'string' || !value || value.length > 253 || /[\s*]/.test(value))
|
|
4
|
+
return;
|
|
5
|
+
const hostname = value.toLowerCase().replace(/\.$/, '');
|
|
6
|
+
try {
|
|
7
|
+
const url = new URL(`https://${hostname}`);
|
|
8
|
+
if (url.host !== hostname || url.pathname !== '/' || url.search || url.hash || url.username || url.password)
|
|
9
|
+
return;
|
|
10
|
+
return hostname;
|
|
11
|
+
}
|
|
12
|
+
catch {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
export function turnstileHostnames(value, setting) {
|
|
17
|
+
if (!Array.isArray(value) || value.length === 0 || value.length > 100)
|
|
18
|
+
throw new Error(`${setting} must be a nonempty list of at most 100 exact hostnames`);
|
|
19
|
+
const names = value.map(turnstileHostname);
|
|
20
|
+
if (names.some(name => name === undefined))
|
|
21
|
+
throw new Error(`${setting} must contain exact hostnames without wildcards, URLs, or ports`);
|
|
22
|
+
return [...new Set(names)];
|
|
23
|
+
}
|
package/dist/turnstile.d.ts
CHANGED
|
@@ -1,15 +1,22 @@
|
|
|
1
1
|
export type TurnstileOptions = {
|
|
2
2
|
secret: string;
|
|
3
|
+
allowedHostnames: readonly string[];
|
|
4
|
+
action?: string;
|
|
3
5
|
timeoutMs?: number;
|
|
4
6
|
fetch?: typeof fetch;
|
|
5
7
|
};
|
|
6
8
|
export declare const turnstileVerifyUrl = "https://challenges.cloudflare.com/turnstile/v0/siteverify";
|
|
9
|
+
export declare function turnstilePreviewVerifier(options?: Pick<TurnstileOptions, 'fetch' | 'timeoutMs'>): (input: {
|
|
10
|
+
token?: string;
|
|
11
|
+
ip?: string;
|
|
12
|
+
}) => Promise<boolean>;
|
|
7
13
|
export declare function turnstileVerifier(options: TurnstileOptions): (input: {
|
|
8
14
|
token?: string;
|
|
9
15
|
ip?: string;
|
|
10
16
|
}) => Promise<boolean>;
|
|
11
17
|
export type SessionOptions = {
|
|
12
18
|
secret: string;
|
|
19
|
+
context?: string;
|
|
13
20
|
maxAgeSeconds?: number;
|
|
14
21
|
now?: () => number;
|
|
15
22
|
};
|