@redocly/framework 1.0.0-next.1 → 1.0.0-next.11
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/dist/bundler/build/output-metadata.js +1 -1
- package/dist/bundler/build/run.js +1 -1
- package/dist/bundler/build/theme-global-style-compiler.js +1 -0
- package/dist/bundler/build/theme-global-stylesheets.js +1 -0
- package/dist/bundler/build/vite-config.js +2 -2
- package/dist/bundler/dev/dev-content-build.js +1 -0
- package/dist/bundler/dev/dev-problems.js +1 -1
- package/dist/bundler/dev/dev-reporter.js +1 -1
- package/dist/bundler/dev/routes/dev-content-build-route.js +1 -0
- package/dist/bundler/dev/routes/dev-problems-route.js +1 -1
- package/dist/bundler/dev/run.js +1 -1
- package/dist/bundler/dev/runtime-app.js +1 -1
- package/dist/bundler/dev/vite-config.js +1 -1
- package/dist/bundler/node-bundle.js +1 -0
- package/dist/bundler/runtime-files.js +1 -1
- package/dist/bundler/user-markdoc-schema.js +1 -1
- package/dist/bundler/vite-config.base.js +12 -12
- package/dist/cli/api-docs-build-event.js +1 -0
- package/dist/cli/commands/build.js +1 -1
- package/dist/cli/commands/ingest.js +1 -1
- package/dist/cli/commands/translate.js +1 -1
- package/dist/cli/dev-console/{sweep.js → content-build.js} +1 -1
- package/dist/cli/dev-console/index.js +1 -1
- package/dist/cli/dev-console/lines.js +2 -2
- package/dist/cli/dev-console/plain.js +1 -1
- package/dist/cli/dev-console/tui.js +2 -2
- package/dist/cli/output.js +12 -12
- package/dist/cli/validate-react-pages.js +1 -1
- package/dist/client/ApiAccess.js +3 -0
- package/dist/client/NavigationProgress.js +1 -1
- package/dist/client/ProductsProvider.js +1 -1
- package/dist/client/RouteErrorBoundary.js +1 -1
- package/dist/client/RuntimeLink.js +1 -0
- package/dist/client/ThemeGlobalStyle.js +1 -0
- package/dist/client/UnversionedVersionButton.js +1 -1
- package/dist/client/app.js +2 -7
- package/dist/client/client-entry.js +1 -1
- package/dist/client/dev-problems/ProblemsBar.js +75 -15
- package/dist/client/dev-problems/ProblemsModal.js +15 -15
- package/dist/client/dev-problems/build-segment.js +1 -0
- package/dist/client/dev-problems/index.js +1 -1
- package/dist/client/dev-problems/use-dev-problems.js +1 -1
- package/dist/client/experiments/runtime.js +1 -1
- package/dist/client/history-mount.js +1 -0
- package/dist/client/l10n/use-l10n-config.js +1 -1
- package/dist/client/l10n/use-l10n-href.js +1 -1
- package/dist/client/l10n/use-translate.js +1 -1
- package/dist/client/products.js +1 -1
- package/dist/client/review/ReviewBar.js +163 -69
- package/dist/client/review/login-url.js +1 -0
- package/dist/client/revisions-history.js +1 -1
- package/dist/client/sidebar/PoweredByRedocly.js +2 -2
- package/dist/client/ssr.js +1 -1
- package/dist/client/telemetry/report-preload-failure.js +1 -0
- package/dist/client/templates/dev-login.js +4 -4
- package/dist/client/templates/unauthorized.js +5 -5
- package/dist/client/theme-global-css.js +1 -0
- package/dist/client/use-banner.js +1 -1
- package/dist/client/use-bar-position.js +1 -0
- package/dist/client/use-page-versions.js +1 -1
- package/dist/client/use-router-for-local-links.js +1 -1
- package/dist/client/use-search.js +1 -1
- package/dist/client/utils/routes/is-router-path.js +1 -0
- package/dist/client/webmcp/tools/shared.js +1 -1
- package/dist/content-layer/allowed-packages.js +1 -1
- package/dist/content-layer/api-outputs.js +1 -1
- package/dist/content-layer/config-schema.d.ts +12 -3
- package/dist/content-layer/config-schema.js +1 -1
- package/dist/content-layer/config.d.ts +30 -12
- package/dist/content-layer/config.js +1 -1
- package/dist/content-layer/context.d.ts +2 -0
- package/dist/content-layer/context.js +1 -1
- package/dist/content-layer/database/adapters/node-sqlite-client.js +1 -1
- package/dist/content-layer/database/assets.js +1 -1
- package/dist/content-layer/database/blobs.js +1 -1
- package/dist/content-layer/database/connection.js +1 -1
- package/dist/content-layer/database/entity-store.d.ts +24 -3
- package/dist/content-layer/database/entity-store.js +1 -1
- package/dist/content-layer/database/files.js +1 -1
- package/dist/content-layer/database/finalize.js +1 -1
- package/dist/content-layer/database/invalidation.d.ts +6 -0
- package/dist/content-layer/database/invalidation.js +26 -26
- package/dist/content-layer/database/link-refs.js +1 -1
- package/dist/content-layer/database/origins.d.ts +2 -4
- package/dist/content-layer/database/origins.js +1 -1
- package/dist/content-layer/database/problems.d.ts +2 -0
- package/dist/content-layer/database/problems.js +1 -1
- package/dist/content-layer/database/reset.js +1 -1
- package/dist/content-layer/database/route-query-deps.js +1 -1
- package/dist/content-layer/database/schema.d.ts +50 -0
- package/dist/content-layer/database/schema.js +1 -1
- package/dist/content-layer/database/search-vocab.js +2 -2
- package/dist/content-layer/database/site-config.d.ts +23 -0
- package/dist/content-layer/database/site-config.js +1 -1
- package/dist/content-layer/database/static-files.js +1 -1
- package/dist/content-layer/ingest/extract-all-phase.js +1 -1
- package/dist/content-layer/ingest/finalize-phase.js +1 -1
- package/dist/content-layer/ingest/git-last-modified.js +3 -3
- package/dist/content-layer/ingest/hash.js +1 -1
- package/dist/content-layer/ingest/hook-inputs.js +1 -1
- package/dist/content-layer/ingest/l10n-warnings.js +1 -1
- package/dist/content-layer/ingest/markdoc-schema-problem.js +1 -0
- package/dist/content-layer/ingest/rbac-teams.js +1 -1
- package/dist/content-layer/ingest/run.js +1 -1
- package/dist/content-layer/ingest/scan.d.ts +1 -1
- package/dist/content-layer/ingest/scan.js +1 -1
- package/dist/content-layer/ingest/search-sync.js +1 -1
- package/dist/content-layer/ingest/slugger/resolve-final-slugs.js +1 -1
- package/dist/content-layer/ingest/sync.js +1 -1
- package/dist/content-layer/link-checker/delta.js +1 -1
- package/dist/content-layer/link-checker/fingerprint.js +1 -1
- package/dist/content-layer/link-checker/load-view.js +1 -1
- package/dist/content-layer/link-checker/run-build.js +1 -1
- package/dist/content-layer/link-checker/validate.js +1 -1
- package/dist/content-layer/link-checker/view.js +1 -1
- package/dist/content-layer/loaders/context.js +1 -1
- package/dist/content-layer/loaders/define.d.ts +3 -0
- package/dist/content-layer/markdown/client/JsonSchemaTag.js +1 -1
- package/dist/content-layer/markdown/client/OpenapiTagComponents.js +2 -2
- package/dist/content-layer/markdown/client/code-highlight-notation.js +3 -3
- package/dist/content-layer/markdown/client/dynamic-components.js +1 -1
- package/dist/content-layer/markdown/client/markdoc-components.js +2 -2
- package/dist/content-layer/markdown/constants/builtin-tags.js +1 -1
- package/dist/content-layer/markdown/constants/markdown-text-tag-set.js +1 -1
- package/dist/content-layer/markdown/constants/tag-sets.d.ts +20 -5
- package/dist/content-layer/markdown/constants/tag-sets.js +1 -1
- package/dist/content-layer/markdown/nodes/fence.js +1 -1
- package/dist/content-layer/markdown/nodes/heading.js +1 -1
- package/dist/content-layer/markdown/nodes/table.js +1 -1
- package/dist/content-layer/markdown/resolve/ast.js +1 -1
- package/dist/content-layer/markdown/resolve/attribute-resolver-key.d.ts +8 -1
- package/dist/content-layer/markdown/resolve/attribute-resolver-key.js +1 -1
- package/dist/content-layer/markdown/resolve/audience-tag.d.ts +2 -6
- package/dist/content-layer/markdown/resolve/audience-tag.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/code-snippet.js +5 -4
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/code-walkthrough/filesets.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/diagram-file.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/file-reference.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.d.ts +2 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/operation-samples.d.ts +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/operation-samples.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/partial.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/svg-content.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc.d.ts +2 -1
- package/dist/content-layer/markdown/resolve/markdoc.js +1 -1
- package/dist/content-layer/markdown/resolve/raw-partials.d.ts +2 -1
- package/dist/content-layer/markdown/resolve/raw-partials.js +1 -1
- package/dist/content-layer/markdown/resolve/references.d.ts +3 -1
- package/dist/content-layer/markdown/resolve/references.js +1 -1
- package/dist/content-layer/markdown/resolve/render-diagrams.d.ts +8 -1
- package/dist/content-layer/markdown/resolve/render-diagrams.js +1 -1
- package/dist/content-layer/markdown/search/to-markdown.js +2 -2
- package/dist/content-layer/markdown/search/to-sections.d.ts +8 -3
- package/dist/content-layer/markdown/search/to-sections.js +1 -1
- package/dist/content-layer/markdown/search/to-text.d.ts +4 -1
- package/dist/content-layer/markdown/search/to-text.js +5 -5
- package/dist/content-layer/markdown/server/render.d.ts +4 -2
- package/dist/content-layer/markdown/server/render.js +1 -1
- package/dist/content-layer/markdown/service.js +1 -1
- package/dist/content-layer/markdown/tags/html.d.ts +5 -2
- package/dist/content-layer/markdown/tags/html.js +1 -1
- package/dist/content-layer/markdown/tags/markdoc-error.d.ts +8 -0
- package/dist/content-layer/markdown/tags/markdoc-error.js +1 -1
- package/dist/content-layer/markdown/tags/openapi.d.ts +1 -1
- package/dist/content-layer/markdown/tags/openapi.js +1 -1
- package/dist/content-layer/markdown/tags/partial.d.ts +9 -3
- package/dist/content-layer/markdown/tags/partial.js +1 -1
- package/dist/content-layer/markdown/tags/variant.d.ts +6 -0
- package/dist/content-layer/markdown/tags/variant.js +1 -0
- package/dist/content-layer/markdown/types/service.d.ts +6 -0
- package/dist/content-layer/markdown/utils/collect-anchors.js +1 -1
- package/dist/content-layer/markdown/utils/collect-headings.d.ts +3 -1
- package/dist/content-layer/markdown/utils/collect-headings.js +1 -1
- package/dist/content-layer/markdown/utils/first-heading.js +1 -1
- package/dist/content-layer/markdown/utils/heading-slugger.d.ts +8 -0
- package/dist/content-layer/markdown/utils/heading-slugger.js +1 -1
- package/dist/content-layer/markdown/utils/node-source-range.d.ts +3 -3
- package/dist/content-layer/markdown/utils/node-source-range.js +1 -1
- package/dist/content-layer/markdown/utils/parse-cache.js +1 -1
- package/dist/content-layer/markdown/utils/reparse-example-fences.d.ts +4 -1
- package/dist/content-layer/markdown/utils/reparse-example-fences.js +1 -1
- package/dist/content-layer/markdown/utils/substitute-variables.js +1 -1
- package/dist/content-layer/markdown/utils/walk-markdoc-ast.d.ts +2 -2
- package/dist/content-layer/markdown/utils/walk-markdoc-ast.js +1 -1
- package/dist/content-layer/materialization/asset-reconcile.js +1 -1
- package/dist/content-layer/materialization/entity.js +1 -1
- package/dist/content-layer/materialization/materializer.js +1 -0
- package/dist/content-layer/materialization/static-files.js +1 -1
- package/dist/content-layer/plan-gates.d.ts +3 -2
- package/dist/content-layer/plan-gates.js +1 -1
- package/dist/content-layer/plugins/execute.js +1 -1
- package/dist/content-layer/plugins/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/client/event-handlers.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/client/rebase-item-links.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/client/template.js +12 -4
- package/dist/content-layer/plugins/internal/api-docs/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/build-definition.d.ts +28 -13
- package/dist/content-layer/plugins/internal/api-docs/server/build-definition.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/build-sidebar.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/declares-proto-service.d.ts +2 -0
- package/dist/content-layer/plugins/internal/api-docs/server/declares-proto-service.js +3 -0
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-copy.d.ts +14 -0
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-copy.js +23 -0
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-decorator.d.ts +1 -4
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-decorator.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/options.d.ts +4 -2
- package/dist/content-layer/plugins/internal/api-docs/server/options.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/search-documents.d.ts +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/search-documents.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/spec-download.js +1 -1
- package/dist/content-layer/plugins/internal/api-functions/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-functions/server/access.js +1 -1
- package/dist/content-layer/plugins/internal/api-functions/server/api-function-telemetry.js +1 -0
- package/dist/content-layer/plugins/internal/api-functions/server/dispatch.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/banner.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/index.d.ts +1 -1
- package/dist/content-layer/plugins/internal/app-data/index.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/products.d.ts +2 -0
- package/dist/content-layer/plugins/internal/app-data/products.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/client/catalog-filtering.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/index.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/resolve-items.d.ts +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/resolve-items.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/sidebars.d.ts +1 -1
- package/dist/content-layer/plugins/internal/index.js +1 -1
- package/dist/content-layer/plugins/internal/l10n/index.js +1 -1
- package/dist/content-layer/plugins/internal/l10n/translations-loader.js +1 -1
- package/dist/content-layer/plugins/internal/markdoc/client/template.js +1 -1
- package/dist/content-layer/plugins/internal/markdoc/index.js +1 -1
- package/dist/content-layer/plugins/internal/markdoc/server/shared.d.ts +1 -1
- package/dist/content-layer/plugins/internal/mcp/constants.d.ts +20 -0
- package/dist/content-layer/plugins/internal/mcp/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.d.ts +4 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/agent-card.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/audit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/auth.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/code-credentials.js +2 -2
- package/dist/content-layer/plugins/internal/mcp/server/codemode/capabilities.js +6 -6
- package/dist/content-layer/plugins/internal/mcp/server/codemode/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/discover.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/execute-schema.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/prompts.js +8 -8
- package/dist/content-layer/plugins/internal/mcp/server/config-gate.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/custom-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/allowed-http-methods.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/api-call-operations.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/call-api.js +2 -0
- package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials-page/form-page.js +10 -10
- package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials-page/outcome-pages.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/elicitation.js +7 -6
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/allowed-hosts.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/fetch-bridge.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/fetch-errors.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/ssrf-guard.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/upstream-detail.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/index.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/gateway/secret-store.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tool-list.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tools.js +4 -4
- package/dist/content-layer/plugins/internal/mcp/server/gateway/upstream-auth-scheme.js +2 -2
- package/dist/content-layer/plugins/internal/mcp/server/handler.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/mcp-server.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/mcp-telemetry.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/authorize.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/discovery.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/rate-limit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/server-card.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/skills-resources.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/graphql-catalog.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-catalog.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-document.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-refs.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/pages-navigation.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/pages.js +2 -2
- package/dist/content-layer/plugins/internal/mcp/server/tools/schemas.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/workflows/catalog.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/document-resolver.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/operations-subset.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/resolve-workflows.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/run-workflow.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/schemas.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/tools.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/types.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/workflows/workflow-references.js +1 -0
- package/dist/content-layer/plugins/internal/mock/server/handler.js +1 -1
- package/dist/content-layer/plugins/internal/react-page/index.d.ts +3 -2
- package/dist/content-layer/plugins/internal/react-page/index.js +1 -1
- package/dist/content-layer/plugins/internal/scorecard-classic/client/Grid.js +11 -11
- package/dist/content-layer/plugins/internal/scorecard-classic/client/ScorecardViews.js +1 -1
- package/dist/content-layer/plugins/internal/scorecard-classic/client/ScorecardWidgets.js +7 -7
- package/dist/content-layer/plugins/internal/scorecard-classic/client/template.js +2 -2
- package/dist/content-layer/plugins/internal/sidebar/bundle.d.ts +18 -17
- package/dist/content-layer/plugins/internal/sidebar/bundle.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.d.ts +5 -3
- package/dist/content-layer/plugins/internal/sidebar/index.js +2 -2
- package/dist/content-layer/plugins/internal/sidebar/subtree.js +1 -1
- package/dist/content-layer/plugins/internal/skills/index.js +1 -1
- package/dist/content-layer/plugins/internal/skills/server/routes.js +1 -1
- package/dist/content-layer/plugins/internal/versions/index.js +1 -1
- package/dist/content-layer/plugins/project/load.js +2 -2
- package/dist/content-layer/plugins/registry.js +1 -1
- package/dist/content-layer/plugins/request-context.d.ts +5 -0
- package/dist/content-layer/plugins/types/api-entity.d.ts +2 -6
- package/dist/content-layer/plugins/types/api-entity.js +1 -1
- package/dist/content-layer/plugins/types/markdoc.d.ts +2 -0
- package/dist/content-layer/plugins/types/plugin.d.ts +13 -0
- package/dist/content-layer/plugins/types/search.d.ts +14 -3
- package/dist/content-layer/plugins/utils/link-access.d.ts +2 -0
- package/dist/content-layer/plugins/utils/link-access.js +1 -1
- package/dist/content-layer/plugins/utils/route-index.d.ts +1 -1
- package/dist/content-layer/plugins/utils/route-index.js +1 -1
- package/dist/content-layer/plugins/utils/sidebar-label.d.ts +4 -1
- package/dist/content-layer/plugins/utils/sidebar-label.js +1 -1
- package/dist/content-layer/plugins/utils/version-path.js +1 -1
- package/dist/content-layer/plugins/work-time.js +1 -0
- package/dist/content-layer/problems/codes.d.ts +10 -0
- package/dist/content-layer/problems/codes.js +1 -1
- package/dist/content-layer/revisions/config.js +1 -1
- package/dist/content-layer/revisions/delete.js +1 -1
- package/dist/content-layer/search/engine/core/content-parser.js +1 -1
- package/dist/content-layer/search/engine/core/search-engine.js +1 -1
- package/dist/content-layer/search/facet-rows.js +1 -1
- package/dist/content-layer/search/keywords.d.ts +18 -0
- package/dist/content-layer/search/keywords.js +1 -0
- package/dist/content-layer/search/postings/fragment-field.d.ts +2 -0
- package/dist/content-layer/search/postings/fragment-field.js +1 -1
- package/dist/content-layer/search/postings/postings-store.d.ts +14 -0
- package/dist/content-layer/search/postings/postings-store.js +1 -1
- package/dist/content-layer/search/store.d.ts +14 -1
- package/dist/content-layer/server/context.js +1 -1
- package/dist/content-layer/server/database.js +1 -1
- package/dist/content-layer/server/materialize.js +1 -1
- package/dist/content-layer/static/audience.js +1 -1
- package/dist/content-layer/static/registry.js +1 -1
- package/dist/content-layer/templates/template-set.js +1 -1
- package/dist/content-layer/versions/group-info.d.ts +21 -0
- package/dist/content-layer/versions/group-info.js +1 -0
- package/dist/content-layer/versions/redirect.d.ts +24 -17
- package/dist/content-layer/versions/redirect.js +1 -1
- package/dist/content-layer/versions/resolve.d.ts +1 -21
- package/dist/content-layer/versions/resolve.js +1 -1
- package/dist/content-layer/versions/version-groups.d.ts +5 -1
- package/dist/content-layer/versions/version-groups.js +1 -1
- package/dist/plugin-api.d.ts +3 -0
- package/dist/plugin-api.js +1 -1
- package/dist/server/analytics-tags.js +1 -1
- package/dist/server/app.js +3 -3
- package/dist/server/ask-ai/feature-gate.js +1 -1
- package/dist/server/ask-ai/route.js +1 -1
- package/dist/server/auth/access-config.js +1 -1
- package/dist/server/auth/gate.js +1 -1
- package/dist/server/auth/middleware.js +1 -1
- package/dist/server/auth/oidc.js +1 -1
- package/dist/server/auth/request.js +1 -1
- package/dist/server/auth/routes.js +1 -1
- package/dist/server/auth/runtime.js +1 -1
- package/dist/server/content-assets/access.js +1 -1
- package/dist/server/content.js +14 -13
- package/dist/server/feedback/route.js +1 -1
- package/dist/server/html-tags.js +2 -1
- package/dist/server/lambda-entry.js +1 -1
- package/dist/server/llms-txt.js +1 -1
- package/dist/server/manifest-assets.js +2 -2
- package/dist/server/metrics/request-metrics.js +1 -1
- package/dist/server/node-entry.js +1 -1
- package/dist/server/page-handlers.js +1 -1
- package/dist/server/plugin-context.js +1 -1
- package/dist/server/plugin-routes.js +1 -1
- package/dist/server/public-url.js +1 -0
- package/dist/server/rbac/content-asset-access.js +1 -1
- package/dist/server/redirects.js +1 -1
- package/dist/server/replay-oauth2/route.js +1 -1
- package/dist/server/review/route.js +1 -1
- package/dist/server/runtime-config.js +1 -1
- package/dist/server/search/cache.js +1 -0
- package/dist/server/search/route.js +1 -1
- package/dist/server/search/search-telemetry.js +1 -0
- package/dist/server/seo-tags.js +2 -2
- package/dist/server/ssrf/ssrf-blocklist.js +1 -1
- package/dist/server/static-files/serve.js +1 -1
- package/dist/server/subprocess/runner.js +1 -1
- package/dist/server/telemetry/mock-server-events.js +1 -0
- package/dist/server/telemetry/redirect-event.js +1 -0
- package/dist/server/telemetry/route.js +1 -1
- package/dist/server/telemetry/sender.js +1 -1
- package/dist/server/telemetry/server-events.js +1 -1
- package/dist/server/template-ids.js +1 -1
- package/dist/shared/constants/api-spec-kinds.d.ts +7 -0
- package/dist/shared/constants/api-spec-kinds.js +1 -0
- package/dist/shared/constants/content-update.js +1 -1
- package/dist/shared/constants/dependency-pack.js +1 -1
- package/dist/shared/constants/dev-content-build.js +1 -0
- package/dist/shared/constants/dev-problems.js +1 -1
- package/dist/shared/constants/dev-source-sync.js +1 -1
- package/dist/shared/constants/l10n/langs/ar.js +1 -1
- package/dist/shared/constants/l10n/langs/de.js +1 -1
- package/dist/shared/constants/l10n/langs/en.js +1 -1
- package/dist/shared/constants/l10n/langs/es.js +1 -1
- package/dist/shared/constants/l10n/langs/fr.js +1 -1
- package/dist/shared/constants/l10n/langs/hi.js +1 -1
- package/dist/shared/constants/l10n/langs/it.js +1 -1
- package/dist/shared/constants/l10n/langs/ja.js +1 -1
- package/dist/shared/constants/l10n/langs/ko.js +1 -1
- package/dist/shared/constants/l10n/langs/pl.js +1 -1
- package/dist/shared/constants/l10n/langs/pt-br.js +1 -1
- package/dist/shared/constants/l10n/langs/pt.js +1 -1
- package/dist/shared/constants/l10n/langs/ru.js +1 -1
- package/dist/shared/constants/l10n/langs/uk.js +1 -1
- package/dist/shared/constants/l10n/langs/zh.js +1 -1
- package/dist/shared/constants/manifest-version.d.ts +3 -1
- package/dist/shared/constants/openapi-operation-methods.d.ts +2 -0
- package/dist/shared/constants/openapi-operation-methods.js +1 -0
- package/dist/shared/constants/review.d.ts +5 -0
- package/dist/shared/constants/review.js +1 -1
- package/dist/{server → shared}/constants/system-routes.d.ts +1 -1
- package/dist/shared/constants/system-routes.js +1 -0
- package/dist/shared/constants/versions.d.ts +2 -0
- package/dist/shared/constants/versions.js +1 -1
- package/dist/shared/experiments.js +1 -1
- package/dist/shared/load-dot-env.js +1 -1
- package/dist/shared/plan-gates.d.ts +9 -3
- package/dist/shared/plan-gates.js +1 -1
- package/dist/shared/products.js +1 -1
- package/dist/shared/project-env.d.ts +12 -0
- package/dist/shared/project-env.js +1 -0
- package/dist/shared/public-env.d.ts +9 -0
- package/dist/shared/public-env.js +1 -1
- package/dist/{server → shared}/rbac/api-docs.d.ts +3 -2
- package/dist/shared/rbac/api-docs.js +1 -0
- package/dist/{server → shared}/rbac/engine.d.ts +13 -10
- package/dist/shared/rbac/engine.js +0 -0
- package/dist/{server → shared}/rbac/filter.d.ts +2 -0
- package/dist/shared/rbac/filter.js +1 -0
- package/dist/{server → shared}/rbac/l10n-rules.d.ts +1 -1
- package/dist/shared/rbac/l10n-rules.js +1 -0
- package/dist/{server → shared}/rbac/route-scope.d.ts +1 -1
- package/dist/shared/rbac/route-scope.js +1 -0
- package/dist/{server → shared}/rbac/team-templates.d.ts +6 -2
- package/dist/shared/rbac/team-templates.js +1 -0
- package/dist/{server → shared}/rbac/teams.d.ts +1 -1
- package/dist/shared/rbac/types.js +1 -0
- package/dist/shared/search/facets.d.ts +5 -0
- package/dist/shared/search/facets.js +1 -1
- package/dist/shared/types/auth.d.ts +1 -0
- package/dist/shared/types/config.d.ts +5 -0
- package/dist/shared/types/search.d.ts +8 -2
- package/dist/shared/types/sidebar.d.ts +1 -0
- package/dist/shared/utils/l10n.js +1 -1
- package/dist/shared/utils/redirect-match.js +1 -0
- package/dist/shared/utils/routes/markdown-copy-url.js +1 -0
- package/drizzle/20261103061150_site_config_effective_hash/migration.sql +1 -0
- package/drizzle/20261105151816_search_http_path_tokens/migration.sql +1 -0
- package/drizzle/20261111152552_page_markdown_rbac_scope/migration.sql +1 -0
- package/package.json +37 -13
- package/dist/bundler/dev/__tests__/reset-content-update-state.js +0 -1
- package/dist/bundler/dev/materialization-sweeper.js +0 -1
- package/dist/client/dev-problems/sweep-segment.js +0 -1
- package/dist/client/review/use-bar-position.js +0 -1
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-docs.d.ts +0 -5
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-docs.js +0 -26
- package/dist/content-layer/plugins/internal/mcp/server/gateway/__tests__/fake-kv.js +0 -1
- package/dist/content-layer/server/config.js +0 -1
- package/dist/server/__tests__/rbac-fixture.js +0 -1
- package/dist/server/__tests__/test-session.js +0 -1
- package/dist/server/constants/system-routes.js +0 -1
- package/dist/server/rbac/api-docs.js +0 -1
- package/dist/server/rbac/engine.js +0 -0
- package/dist/server/rbac/filter.js +0 -1
- package/dist/server/rbac/l10n-rules.js +0 -1
- package/dist/server/rbac/route-scope.js +0 -1
- package/dist/server/rbac/team-templates.js +0 -1
- package/dist/server/rbac/types.js +0 -1
- package/dist/shared/utils/routes/markdown-path.js +0 -1
- /package/dist/{server → shared}/rbac/entity-scope.js +0 -0
- /package/dist/{server → shared}/rbac/teams.js +0 -0
- /package/dist/{server → shared}/rbac/types.d.ts +0 -0
- /package/dist/{content-layer/markdown → shared}/utils/packed-ast.d.ts +0 -0
- /package/dist/{content-layer/markdown → shared}/utils/packed-ast.js +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{GET_WORKFLOW_TOOL_NAME as e,LIST_WORKFLOWS_TOOL_NAME as t,READ_ONLY_ANNOTATIONS as n,RUN_WORKFLOW_TOOL_NAME as r}from"../../constants.js";const i={type:`string`,nullable:!0},a={workflowId:{type:`string`,description:"The `workflowId` from `listWorkflows`."},filePath:{...i,description:"The `filePath` from `listWorkflows`. Needed only when several files declare the workflow ID."}},o={workflowId:{type:`string`},filePath:{type:`string`,description:`The Arazzo description that declares the workflow.`},summary:i,description:i,writes:{type:`boolean`,description:`True when a step can change data. Confirm with the user before such a run.`},inputs:{type:`object`,description:"The JSON Schema of the `inputs` that `runWorkflow` takes."}},s={name:t,title:`List API workflows`,description:'Lists the workflows that `runWorkflow` can run. Each workflow is a ready-made multi-step API action that the docs authors wrote, such as "log in, then place an order". When a workflow matches the task, run it instead of chaining `fetch` calls: it already knows the order of the calls and how data passes between them.',summary:`List the multi-step API workflows you can run.`,annotations:n,schema:{type:`object`,required:[],additionalProperties:!1,properties:{filter:{...i,description:`Case-insensitive text to find in the workflow ID, summary, or description.`}}},outputSchema:{type:`object`,required:[`items`],properties:{items:{type:`array`,items:{type:`object`,required:[`workflowId`,`filePath`,`writes`,`inputs`],properties:o}}}}},c={name:e,title:`Get an API workflow`,description:"Gets one workflow from `listWorkflows`: its inputs, outputs, and the request or sub-workflow of each step. Use it to explain a workflow to the user before you run it. For a workflow that cannot run, the error says why.",summary:`Get the inputs, steps, and outputs of one workflow.`,annotations:n,schema:{type:`object`,required:[`workflowId`],additionalProperties:!1,properties:a},outputSchema:{type:`object`,required:[`workflowId`,`filePath`,`writes`,`inputs`,`outputs`,`steps`],properties:{...o,outputs:{type:`array`,items:{type:`string`},description:"The names of the `outputs` a successful run returns."},steps:{type:`array`,items:{type:`object`,required:[`stepId`],properties:{stepId:{type:`string`},description:i,request:{...i,description:"The method and the path, such as `POST /orders`."},workflowId:{...i,description:`The sub-workflow the step runs.`}}}}}}},l={name:r,title:`Run an API workflow`,description:'Runs one workflow from `listWorkflows` with its `inputs`, and returns its `outputs` and one `steps` entry per request. Each request goes through `fetch`: the same documented operations, hosts, stored credentials, and limits. A run that fails returns `status: "failed"` with the failed step and its response. The requests in `steps` already reached the API, so do not run a workflow that writes again without asking the user.',summary:`Run a multi-step API workflow with its inputs.`,annotations:{...n,openWorldHint:!0},schema:{type:`object`,required:[`workflowId`],additionalProperties:!1,properties:{...a,inputs:{type:`object`,nullable:!0,description:"The workflow inputs; their JSON Schema is `inputs` in `listWorkflows`."}}},outputSchema:{type:`object`,required:[`workflowId`,`status`,`steps`],properties:{workflowId:{type:`string`},status:{type:`string`,enum:[`succeeded`,`failed`]},outputs:{type:`object`,nullable:!0},steps:{type:`array`,items:{type:`object`,required:[`stepId`,`ms`],properties:{stepId:{type:`string`},workflowId:{...i,description:`Set for a step of a sub-workflow or a dependency.`},request:i,status:{type:`number`,nullable:!0},ms:{type:`number`},error:{...i,description:`Why the request did not reach the API.`}}}},failure:{type:`object`,nullable:!0,required:[`workflowId`,`reason`],properties:{workflowId:{type:`string`},stepId:i,reason:{type:`string`},response:{type:`object`,nullable:!0,required:[`status`,`body`],properties:{status:{type:`number`},body:{type:`string`}}}}}}}};export{c as GET_WORKFLOW_SCHEMA,s as LIST_WORKFLOWS_SCHEMA,l as RUN_WORKFLOW_SCHEMA};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{formatCandidates as e}from"../tools/openapi-document.js";import{isSafeHttpMethod as t}from"../gateway/allowed-http-methods.js";import{stepKey as n}from"./types.js";import{hasRunnableWorkflows as r,loadWorkflowCatalog as i}from"./catalog.js";import{runWorkflow as a}from"./run-workflow.js";import{GET_WORKFLOW_SCHEMA as o,LIST_WORKFLOWS_SCHEMA as s,RUN_WORKFLOW_SCHEMA as c}from"./schemas.js";import{Ajv as l,AjvJsonSchemaValidator as u}from"@modelcontextprotocol/server/validators/ajv";const d=new u(new l({allErrors:!0,strict:!1,validateFormats:!1}));function f({methods:e}){return e.some(e=>!t(e))}function p({file:e,runnable:t}){let{workflowId:n,summary:r,description:i}=t.workflow;return{workflowId:n,filePath:e.filePath,summary:r,description:i,writes:f(t),inputs:t.inputs}}function m(e){return e.flatMap(e=>Array.from(e.runnable.values(),t=>({file:e,runnable:t})))}function h({workflowId:t,filePath:n},r){let i=n?r.filter(e=>e.filePath===n):r,a=i.flatMap(e=>{let n=e.runnable.get(t);return n?[{file:e,runnable:n}]:[]});if(a.length===1)return a[0];if(a.length>1)throw Error(`Workflow "${t}" is in several files: ${e(a.map(({file:e})=>`"${e.filePath}"`))}. Pass \`filePath\`.`);let o=i.find(e=>e.unsupported.has(t));if(o)throw Error(`Workflow "${t}" in ${o.filePath} cannot run: ${o.unsupported.get(t)}.`);let s=m(r).map(({runnable:e})=>`"${e.workflow.workflowId}"`);throw Error(`No workflow "${t}"`+(n?` in ${n}`:``)+(s.length>0?`. Available workflows: ${e(s)}.`:`.`))}const g={schema:s,isAvailable:r,async execute(e,t){let n=(e??{}).filter?.trim().toLowerCase(),r=m(await i(t)).map(p);return{items:n?r.filter(e=>[e.workflowId,e.summary,e.description].some(e=>e?.toLowerCase().includes(n))):r}}},_={schema:o,isAvailable:r,async execute(e,t){let r=h(e,await i(t)),{workflow:a}=r.runnable;return{...p(r),outputs:Object.keys(a.outputs??{}),steps:(a.steps??[]).map(e=>{let t=r.file.operations.get(n(a.workflowId,e.stepId));return{stepId:e.stepId,description:e.description,request:t&&`${t.method} ${t.path}`,workflowId:e.workflowId}})}}},v={schema:c,isAvailable:r,async execute(e,t,n){let r=e,{file:o,runnable:s}=h(r,await i(t)),c=r.inputs??{},l=d.getValidator(s.inputs)(c);if(!l.valid)throw Error(`The inputs of workflow "${r.workflowId}" are not valid: ${l.errorMessage}`);let u=n?.gatewayFetch;if(!u)throw Error("`runWorkflow` runs only inside an `execute` script.");return a({file:o,workflowId:r.workflowId,inputs:c,fetch:u,deadline:t.executeDeadline})}};function y(){return[g,_,v]}export{y as workflowTools};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
function e(e,t){return`${e}/${t}`}export{e as stepKey};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{isObject as e}from"../../../../../../shared/utils/is-object.js";var t=class extends Error{};const n=/^\$components\.(successActions|failureActions)\.([\w.-]+)$/,r=/^\$sourceDescriptions\.([\w-]+)\.(.+)$/;function i(e,t,n){return c(e.onSuccess??t.successActions??[],n,l)}function a(e,t,n){return c(e.onFailure??t.failureActions??[],n,u)}function o(e){return r.exec(e)?.[2]??e}function s(e,t){let n=[...e.dependsOn??[]];for(let r of e.steps??[]){r.workflowId&&n.push(r.workflowId);let o=[...i(r,e,t),...a(r,e,t)];for(let e of o)(e.type===`goto`||e.type===`retry`)&&e.workflowId&&n.push(e.workflowId)}return n}function c(e,n,r){return e.map(e=>{let i=e.reference;if(typeof i!=`string`)return e;let a=d(i,n);if(!r(a))throw new t(`action reference "${i}" names no component`);return a})}function l(t){return e(t)&&(t.type===`goto`||t.type===`end`)}function u(t){return e(t)&&(t.type===`goto`||t.type===`retry`||t.type===`end`)}function d(t,r){let i=n.exec(t);if(!i||!r)return;let[,a,o]=i,s=r[a];return e(s)?s[o]:void 0}export{r as SOURCE_REFERENCE,t as UnsupportedWorkflowError,a as failureActionsOf,o as localWorkflowId,s as referencedWorkflowIds,i as successActionsOf};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{isPlanFeatureGranted as e}from"../../../../../shared/plan-gates.js";import{isObject as t}from"../../../../../shared/utils/is-object.js";import{filePathToRouteSlug as n}from"../../../../../shared/utils/routes/file-path-to-route-slug.js";import"../../../../../shared/constants/api-spec-kinds.js";import{mockPathPrefix as r}from"../../../types/api-entity.js";import{parseContentVersion as i}from"../../../utils/version-path.js";import{toPublicVersionedSlug as a}from"../../../../../shared/constants/versions.js";import{stripPathPrefix as o}from"../../../../../shared/path-prefix.js";import{notFoundResponse as s}from"../../../../../server/plugin-context.js";import{MOCK_SERVER_HANDLER_ID as c,withMockServerEvent as l}from"../../../../../server/telemetry/mock-server-events.js";const u={"Cache-Control":`no-store`},d=/* @__PURE__ */ new Map;function f(e,n){let r=n.metadata?.mockServer;return{...e,...t(r)?r:{}}}function p(e,t){let{specType:n,routeSlug:i}=e.metadata??{};return n!==`openapi`||typeof i!=`string`||f(t,e).off===!0?null:r(i)}function m(e,t,n=void 0){let r=null,i=-1;for(let a of e){let e=p(a,n);e===null||e.length<=i||h(e,t)&&(r={api:a,path:t.slice(e.length)||`/`},i=e.length)}return r}function h(e,t){return t===e||t.startsWith(`${e}/`)}async function g(e,t,n){let o=null,s=-1;for(let c of t){let t=p(c,e.config.mockServer),l=i(String(c.metadata?.sourcePath));if(t===null||l===null)continue;let u=String(c.metadata?.routeSlug),d=r(a(u,l.versionGroup,l.version,!0));d===t||d.length<=s||!h(d,n)||(await e.versions.counterparts(u))?.group.defaultVersion===l.version&&(o={api:c,path:n.slice(d.length)||`/`},s=d.length)}return o}function _(e,t,{createMockServer:n}){let r=d.get(t.key);if(r&&r.dataHash===t.dataHash)return r.handler;let{strictExamples:i,errorIfForcedExampleNotFound:a}=f(e.config.mockServer,t),o=e.entities.load(t.key).then(e=>n(structuredClone(e),{strictExamples:i,errorIfForcedExampleNotFound:a}));return d.set(t.key,{dataHash:t.dataHash,handler:o}),o.catch(()=>d.delete(t.key)),o}async function v(e,t){let o=await e.entities.list({type:`api`}),s=o.filter(({metadata:e})=>{if(e?.specType!==`openapi`||e.routeSlug!==void 0)return!1;let o=String(e.sourcePath),s=n(o),c=i(o);return(c?[s,a(s,c.versionGroup,c.version,!0)]:[s]).some(e=>h(r(e),t))});return s.length===0?o:(await Promise.all(s.map(t=>e.entities.load(t.key))),e.entities.list({type:`api`}))}function y(e,t){let n=(e.req.header(`x-http-method-override`)??e.req.method).toUpperCase(),{search:r}=new URL(e.req.url),i;return{path:t,method:n,query:r===``?void 0:r,headers:Object.fromEntries(e.req.raw.headers),getBody:()=>i??=e.req.arrayBuffer().then(e=>e.byteLength>0?Buffer.from(e):void 0)}}function b(e){return(o(new URL(e.req.url).pathname)??``).slice(6)||`/`}async function x(t,n){if(!e(n.config,`mockServer`))return s();let r=b(t),i=await v(n,r),a=m(i,r,n.config.mockServer)??await g(n,i,r);if(!a||!n.isSlugVisible(String(a.api.metadata?.routeSlug)))return s();let o;try{o=await import(`@redocly/mock-server`)}catch{return new Response(`Mock server is not available on this host`,{status:501})}return l({handler:c,request:t.req.raw,logger:n.logger},async()=>{let e=await(await _(n,a.api,o))(y(t,a.path));return new Response(e.body?new Uint8Array(e.body):null,{status:e.statusCode,headers:{...e.headers,...u}})})}export{m as matchMockApi,x as mock,y as toMockRequest};
|
|
@@ -5,7 +5,8 @@ export declare const REACT_PAGE_SEARCH_LOADER_KEY = "search";
|
|
|
5
5
|
/**
|
|
6
6
|
* Gives each `.page.tsx` or `.page.ts` file a route whose `template` is a `source:` reference
|
|
7
7
|
* to the file itself. Such a file is its own template, so it needs no template registration.
|
|
8
|
-
* An `export const frontmatter = { ... }` literal becomes the route metadata,
|
|
9
|
-
* (a string or a list) the explicit route slugs: one route for each.
|
|
8
|
+
* An `export const frontmatter = { ... }` literal becomes the route metadata, its `slug`
|
|
9
|
+
* (a string or a list) the explicit route slugs: one route for each, and its `seo.title` the
|
|
10
|
+
* label of a sidebar entry that names none.
|
|
10
11
|
*/
|
|
11
12
|
export declare const reactPageContentPlugin: import("../../types/plugin.js").ContentPlugin;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{createPluginScopedId as
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{SEARCH_GROUP_FACET_FIELD as i}from"../../../../shared/search/facets.js";import{configuredFacetFields as a,extractFacetsFromFrontmatter as o,invalidFacetValueProblems as s,searchCategoryOf as c}from"../../../search/facet-values.js";import{isPlanFeatureGranted as l}from"../../../../shared/plan-gates.js";import{SOURCE_TEMPLATE_PREFIX as u}from"../../../../shared/constants/template-ids.js";import{isObject as d}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as f}from"../../../../shared/utils/routes/normalize-route-slug.js";import{notInPlanProblem as p}from"../../../plan-gates.js";import{filePathToRouteSlug as m}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{isInternalPagePath as h}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as g}from"../../utils/explicit-slugs.js";import{curationKeywordsOf as _}from"../../../search/keywords.js";import{readPageFrontmatter as v}from"./frontmatter.js";const y=[`.page.tsx`,`.page.ts`],b=`internal.react-page`,x=`search`,S=t(r(b,`search`),async e=>({value:e.args}),{searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let{category:n,isInvalid:r}=c(t.route.metadata),{facets:l,invalidFields:u}=o(t.route.metadata,a(t.config)),d={docKey:`page`,routeSlug:t.route.slug,title:e.title,text:e.text,groupKey:n??`Documentation`,facets:l};return e.keywords!==void 0&&(d.keywords=e.keywords),{docs:[d],problems:s([...u,...r?[i]:[]],t.route.originFilePath)}}});function C(e){if(e.excludeFromSearch===!0)return;let t=d(e.search)?e.search:{},n=d(e.seo)?e.seo:{},r=e=>typeof e==`string`?e.trim():``,i=r(t.title)||r(n.title)||r(e.title),a=r(t.description)||r(n.description)||r(e.description);if(i===``&&a===``)return;let o={title:i,text:[a,...Array.isArray(t.keywords)?t.keywords.filter(e=>typeof e==`string`):[]].filter(e=>e!==``).join(` `)},s=_(t.keywords);return s!==void 0&&(o.keywords=s),o}const w=t(r(b,`seo`),async e=>{let{result:t,entityDeps:n,assetUsages:r}=await e.markdown.resolveImageReference(e.args.image,e.file.path);return t.kind===`assetRef`?{value:{image:t.url},entityDeps:n,assetUsages:r}:{value:{image:e.args.image},entityDeps:n}}),T=e({id:b,version:`1.13.0`,loaders:[w,S],content:{filter:{extensions:y},async extractFile(e,t){if(h(e.path))return{routes:[]};if(!l(t.config,`reactPages`))return{routes:[],problems:[p(`React pages`)]};let{frontmatter:r,error:i}=v(await t.io.readFile(e.path));i!==void 0&&t.logger.warn(`Ignoring the frontmatter export of a page component`,{path:e.path,error:i});let a=g(r?.slug),o=d(r?.seo)&&typeof r.seo.image==`string`?r.seo.image:void 0,s=r===null?void 0:C(r),c={};o!==void 0&&(c.seo=w.withArgs({filePath:e.path,image:o})),s!==void 0&&(c[x]=S.withArgs(s,{stableKey:`react-page:search:${e.path}`}));let _=Object.keys(c).length===0?void 0:c,y=`${u}${e.path}`,b=d(r?.seo)?r.seo.title:void 0,T=typeof b==`string`&&b.trim()!==``?n({label:b}):void 0;return{routes:a.length>0?a.map(e=>({routeId:`page`,slug:f(e),template:y,metadata:r??void 0,deps:_,sidebarSubtree:T})):[{routeId:`page`,slugHint:m(e.path,E(e.path)),template:y,metadata:r??void 0,deps:_,sidebarSubtree:T}]}}}});function E(e){return e.toLowerCase().endsWith(`.page.ts`)?`.page.ts`:`.page.tsx`}export{x as REACT_PAGE_SEARCH_LOADER_KEY,T as reactPageContentPlugin};
|
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
import*as e from"react";import
|
|
1
|
+
import*as e from"react";import t from"styled-components";import{Button as n}from"@redocly/theme/components/Button/Button";import{jsx as r,jsxs as i}from"react/jsx-runtime";import{AddIcon as a}from"@redocly/theme/icons/AddIcon/AddIcon";import{SubtractIcon as o}from"@redocly/theme/icons/SubtractIcon/SubtractIcon";function s(t){let{columns:s,rows:y,rowKey:b,expanded:x}=t,[S,C]=e.useState(t.initialSort),[w,T]=e.useState(/* @__PURE__ */ new Set),E=e.useMemo(()=>{let e=s.find(e=>e.id===S?.id)?.sortValue;return!S||!e?y:[...y].sort((t,n)=>{let r=e(t),i=e(n),a=r<i?-1:+(r>i);return S.desc?-a:a})},[s,y,S]),D=e=>C(t=>t?.id===e.id?{id:e.id,desc:!t.desc}:{id:e.id,desc:e.sortDescFirst===!0}),O=e=>T(t=>{let n=new Set(t);return n.delete(e)||n.add(e),n}),k=x?s.length+1:s.length,A=x?`50px repeat(${s.length}, 1fr)`:`25% repeat(${s.length-1}, 1fr)`;return/* @__PURE__ */ i(`div`,{role:`table`,children:[/* @__PURE__ */ i(c,{children:[t.groupHeaderTitle&&/* @__PURE__ */ i(l,{$columns:A,role:`row`,children:[/* @__PURE__ */ r(f,{$column:`1`,role:`columnheader`}),/* @__PURE__ */ r(f,{$column:`2 / ${k+1}`,role:`columnheader`,children:t.groupHeaderTitle})]}),/* @__PURE__ */ i(l,{$columns:A,role:`row`,children:[x&&/* @__PURE__ */ r(d,{role:`columnheader`}),s.map(e=>{let t=S?.id===e.id?S.desc?`desc`:`asc`:void 0;return/* @__PURE__ */ r(d,{role:`columnheader`,$sortable:e.sortValue!==void 0,"aria-sort":t===`asc`?`ascending`:t===`desc`?`descending`:void 0,children:e.sortValue?/* @__PURE__ */ i(p,{type:`button`,onClick:()=>D(e),children:[e.header,/* @__PURE__ */ r(m,{"aria-hidden":`true`,children:t===`desc`?`▾`:t===`asc`?`▴`:`⇕`})]}):e.header},e.id)})]})]}),/* @__PURE__ */ r(`div`,{role:`rowgroup`,children:E.length===0?/* @__PURE__ */ r(u,{$columns:A,role:`row`,children:/* @__PURE__ */ r(g,{role:`cell`,children:t.empty??`No results to show`})}):E.map(e=>{let t=b(e),c=w.has(t);return/* @__PURE__ */ i(u,{$columns:A,role:`row`,children:[x&&/* @__PURE__ */ r(h,{role:`cell`,children:/* @__PURE__ */ r(n,{variant:`text`,size:`medium`,"aria-expanded":c,"aria-label":c?`Collapse`:`Expand`,icon:r(c?o:a,{}),onClick:()=>O(t)})}),s.map(t=>/* @__PURE__ */ r(h,{role:`cell`,children:t.cell(e)},t.id)),c&&x&&/* @__PURE__ */ r(_,{children:/* @__PURE__ */ r(v,{children:x(e)})})]},t)})})]})}const c=t.div`
|
|
2
2
|
border: 1px solid var(--border-color-primary);
|
|
3
3
|
min-width: 775px;
|
|
4
|
-
`,l=
|
|
4
|
+
`,l=t.div`
|
|
5
5
|
display: grid;
|
|
6
6
|
grid-template-columns: ${e=>e.$columns};
|
|
7
7
|
width: 100%;
|
|
8
|
-
`,u=
|
|
8
|
+
`,u=t(l)`
|
|
9
9
|
min-width: 775px;
|
|
10
10
|
border-bottom: 1px solid var(--border-color-primary);
|
|
11
11
|
border-left: 1px solid var(--border-color-primary);
|
|
12
12
|
border-right: 1px solid var(--border-color-primary);
|
|
13
13
|
align-items: center;
|
|
14
|
-
`,d=
|
|
14
|
+
`,d=t.div`
|
|
15
15
|
padding: ${({$sortable:e})=>e?`0`:`5px 15px`};
|
|
16
16
|
background-color: var(--bg-color-raised);
|
|
17
17
|
font-weight: bold;
|
|
18
18
|
color: var(--text-color-secondary);
|
|
19
19
|
box-sizing: border-box;
|
|
20
|
-
`,f=
|
|
20
|
+
`,f=t(d)`
|
|
21
21
|
grid-column: ${e=>e.$column};
|
|
22
22
|
display: flex;
|
|
23
23
|
justify-content: center;
|
|
@@ -27,7 +27,7 @@ import*as e from"react";import{jsx as t,jsxs as n}from"react/jsx-runtime";import
|
|
|
27
27
|
&:nth-child(2) {
|
|
28
28
|
border-bottom: 1px solid var(--border-color-primary);
|
|
29
29
|
}
|
|
30
|
-
`,p=
|
|
30
|
+
`,p=t.button`
|
|
31
31
|
display: block;
|
|
32
32
|
width: 100%;
|
|
33
33
|
height: 100%;
|
|
@@ -40,20 +40,20 @@ import*as e from"react";import{jsx as t,jsxs as n}from"react/jsx-runtime";import
|
|
|
40
40
|
color: inherit;
|
|
41
41
|
text-align: inherit;
|
|
42
42
|
cursor: pointer;
|
|
43
|
-
`,m=
|
|
43
|
+
`,m=t.span`
|
|
44
44
|
font-family: monospace;
|
|
45
|
-
`,h=
|
|
45
|
+
`,h=t.div`
|
|
46
46
|
padding: 5px 15px;
|
|
47
47
|
text-align: left;
|
|
48
|
-
`,g=
|
|
48
|
+
`,g=t.div`
|
|
49
49
|
text-align: center;
|
|
50
50
|
padding: 32px;
|
|
51
51
|
grid-column: 1 / -1;
|
|
52
|
-
`,_=
|
|
52
|
+
`,_=t.div`
|
|
53
53
|
grid-column: 1 / -1;
|
|
54
54
|
margin-bottom: 8px;
|
|
55
55
|
padding: 0 15px;
|
|
56
|
-
`,v=
|
|
56
|
+
`,v=t.div`
|
|
57
57
|
background-color: var(--bg-color-secondary);
|
|
58
58
|
border-radius: 4px;
|
|
59
59
|
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{NON_CONFORMANT as e,apiPagePath as t}from"./contract.js";import{Grid as n}from"./Grid.js";import{LinkButton as r}from"./styles.js";import{ApiLevel as i,Instance as a,LevelIndicator as o,RuleStatus as s}from"./ScorecardWidgets.js";import{useApiScorecard as c}from"./use-scorecard.js";import*as l from"react";import{Fragment as
|
|
1
|
+
import{NON_CONFORMANT as e,apiPagePath as t}from"./contract.js";import{Grid as n}from"./Grid.js";import{LinkButton as r}from"./styles.js";import{ApiLevel as i,Instance as a,LevelIndicator as o,RuleStatus as s}from"./ScorecardWidgets.js";import{useApiScorecard as c}from"./use-scorecard.js";import*as l from"react";import{getScorecardColorVariable as u}from"@redocly/theme/core/utils";import{Fragment as d,jsx as f,jsxs as p}from"react/jsx-runtime";import{Link as m}from"@redocly/theme/components/Link/Link";function h(e,t){return`${e}/rules/${encodeURIComponent(t)}`}function g(e){return e?new Date(e).toLocaleDateString():`-`}function _(e){return e&&new Date(e).getTime()||0}function v(e){let{base:r,levelNames:a,hasPublishedAt:s,hasTeam:c,teamLabel:d}=e,p=l.useMemo(()=>{let e=[{id:`title`,header:`API`,sortValue:e=>e.title,cell:e=>/* @__PURE__ */ f(m,{to:t(r,e.link),children:e.title})}];return s&&e.push({id:`publishedAt`,header:`Published at`,sortValue:e=>_(e.publishedAt),cell:e=>g(e.publishedAt)}),c&&e.push({id:`team`,header:d,sortValue:e=>e.team??``,cell:e=>e.team}),e.push({id:`level`,header:`Level`,sortValue:e=>e.scorecard.scorecardLevelIdx,cell:e=>/* @__PURE__ */ f(i,{level:e.scorecard.scorecardLevel,colorVariable:u(e.scorecard.scorecardLevelIdx,a.length+1)})},...a.map(e=>({id:`level-${e}`,header:e,cell:t=>{let n=t.scorecard.levels[e];return n?/* @__PURE__ */ f(o,{uniqueErrors:n.uniqueErrors,uniqueWarnings:n.uniqueWarnings}):null}}))),e},[r,s,c,a,d]);return/* @__PURE__ */ f(n,{columns:p,rows:e.apis,rowKey:e=>e.link,initialSort:{id:`title`,desc:!1}})}function y(e){let{base:t}=e,r=l.useMemo(()=>[{id:`ruleId`,header:`Rules`,sortValue:e=>e.ruleId,cell:e=>/* @__PURE__ */ f(m,{to:h(t,e.ruleId),children:e.ruleId})},{id:`status`,header:`Status`,sortValue:e=>e.status,cell:e=>/* @__PURE__ */ f(s,{errors:e.errorApisCount,warnings:e.warningApisCount})},{id:`apis`,header:`Problem APIs`,sortValue:e=>e.apis.length,sortDescFirst:!0,cell:e=>e.apis.length},{id:`count`,header:`Problem count`,sortValue:e=>e.count,sortDescFirst:!0,cell:e=>e.count}],[t]);return/* @__PURE__ */ f(n,{columns:r,rows:e.rules,rowKey:e=>e.ruleId,initialSort:{id:`status`,desc:!0}})}function b(t){let{filters:i,levelNames:a,onSelectTeam:o,teamLabel:s,teamProperty:c}=t,u=l.useMemo(()=>[{id:`team`,header:`API ${s}`,sortValue:e=>e.team,cell:e=>/* @__PURE__ */ f(r,{onClick:()=>{o(),i.find(e=>e.property===c)?.selectOption(e.team)},children:e.team})},...[e,...a].map(e=>({id:`level-${e}`,header:e,sortValue:t=>t.apis[e]??0,cell:t=>t.apis[e]??0}))],[i,a,o,s,c]);return/* @__PURE__ */ f(n,{columns:u,rows:t.teams,rowKey:e=>e.team,initialSort:{id:`team`,desc:!1},groupHeaderTitle:`APIs by level`})}function x({level:e,problems:t}){let r=l.useMemo(()=>{let e=/* @__PURE__ */ new Map;for(let n of t){let t=e.get(n.ruleId);t?t.push(n):e.set(n.ruleId,[n])}return[...e].map(([e,t])=>({ruleId:e,problems:[...t.filter(e=>e.severity===`error`),...t.filter(e=>e.severity===`warn`)],errorsCount:t.filter(e=>e.severity===`error`).length,warningsCount:t.filter(e=>e.severity===`warn`).length}))},[t]),i=l.useMemo(()=>[{id:`ruleId`,header:`Rules`,sortValue:e=>e.ruleId,cell:e=>e.ruleId},{id:`status`,header:`Status`,cell:e=>/* @__PURE__ */ f(s,{errors:e.errorsCount,warnings:e.warningsCount})},{id:`count`,header:`Problem count`,sortValue:e=>e.problems.length,sortDescFirst:!0,cell:e=>e.problems.length}],[]);return/* @__PURE__ */ f(n,{columns:i,rows:r,rowKey:e=>e.ruleId,initialSort:{id:`ruleId`,desc:!1},expanded:e=>e.problems.map((e,t)=>/* @__PURE__ */ f(a,{problem:e},t)),empty:/* @__PURE__ */ p(d,{children:[`✅ This API is compliant with `,/* @__PURE__ */ f(`strong`,{children:e}),` level rules`]})})}function S(e){let{hasPublishedAt:t,hasTeam:r,teamLabel:i}=e,a=l.useMemo(()=>{let e=[{id:`title`,header:`API`,sortValue:e=>e.title,cell:e=>e.title}];return t&&e.push({id:`publishedAt`,header:`Published at`,sortValue:e=>_(e.publishedAt),cell:e=>g(e.publishedAt)}),r&&e.push({id:`team`,header:i,sortValue:e=>e.team??``,cell:e=>e.team||`Other`}),e.push({id:`count`,header:`Problem count`,sortValue:e=>e.count,sortDescFirst:!0,cell:e=>e.count}),e},[t,r,i]);return/* @__PURE__ */ f(n,{columns:a,rows:e.apis,rowKey:e=>e.link,initialSort:{id:`title`,desc:!1},expanded:t=>/* @__PURE__ */ f(C,{api:t,ruleId:e.ruleId})})}function C({api:e,ruleId:t}){let n=c(e.scorecard.relativePath);return n===void 0?/* @__PURE__ */ f(`div`,{children:`Loading…`}):(Object.values(n?.levels??{}).map(e=>e.problems.filter(e=>e.ruleId===t)).find(e=>e.length>0)??[]).map((e,t)=>/* @__PURE__ */ f(a,{problem:e},t))}export{v as ApiListView,x as ApiProblemsView,S as RuleApisView,y as RulesView,b as TeamsView,h as rulePagePath};
|
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
import{CardRow as e,Code as t,ContentWithDotWrap as n,Dot as r,EmojiWrap as i,FilePreview as a,InstanceControlsWrap as o,InstanceReference as s,InstanceWrap as c,ScorecardCard as l,ScorecardCardTitle as u}from"./styles.js";import*as d from"react";import
|
|
1
|
+
import{CardRow as e,Code as t,ContentWithDotWrap as n,Dot as r,EmojiWrap as i,FilePreview as a,InstanceControlsWrap as o,InstanceReference as s,InstanceWrap as c,ScorecardCard as l,ScorecardCardTitle as u}from"./styles.js";import*as d from"react";import f from"styled-components";import{Button as p}from"@redocly/theme/components/Button/Button";import{getScorecardColorVariable as m}from"@redocly/theme/core/utils";import{jsx as h,jsxs as g}from"react/jsx-runtime";import{AddIcon as _}from"@redocly/theme/icons/AddIcon/AddIcon";import{SubtractIcon as v}from"@redocly/theme/icons/SubtractIcon/SubtractIcon";import{CloseFilledIcon as y}from"@redocly/theme/icons/CloseFilledIcon/CloseFilledIcon";import{WarningAltFilled as b}from"@redocly/theme/icons/WarningAltFilled/WarningAltFilled";import{CheckboxFilledIcon as x}from"@redocly/theme/icons/CheckboxFilledIcon/CheckboxFilledIcon";const S={Error:`--scorecard-color-error`,Warn:`--scorecard-color-warning`,Pass:`--scorecard-color-success`};function C({level:e,colorVariable:t}){return/* @__PURE__ */ g(n,{children:[/* @__PURE__ */ h(r,{$colorVariable:t}),/* @__PURE__ */ h(`span`,{children:e})]})}function w({summary:e}){let t=Object.keys(e.levels).length;return/* @__PURE__ */ h(M,{chunks:Object.entries(e.levels).map(([n,r],i)=>({share:r/e.total*100,colorVariable:m(i,t),title:`${r} ${n}`}))})}function T({severity:e}){return/* @__PURE__ */ h(r,{$colorVariable:S[e]})}function E(e,t){return`--scorecard-color-${e>0?`error`:t>0?`warning`:`success`}`}function D({errors:e,warnings:t}){return/* @__PURE__ */ g(n,{children:[/* @__PURE__ */ h(r,{$colorVariable:E(e,t)}),/* @__PURE__ */ h(`span`,{children:e>0?`Problem`:t>0?`Warning`:`Normal`})]})}function O({errors:e,warnings:t}){return/* @__PURE__ */ h(r,{$colorVariable:E(e,t)})}function k(e){return e===`error`?`❌`:e===`warn`?`⚠️`:`ℹ️`}function A(e){return e===`error`?`red`:e===`warn`?`orange`:`blue`}function j({problem:e}){let[n,r]=d.useState(!1);return/* @__PURE__ */ g(o,{className:n?`expanded`:``,children:[/* @__PURE__ */ h(p,{variant:`text`,size:`medium`,"aria-label":n?`Hide the code`:`Show the code`,icon:h(n?v:_,{}),onClick:()=>r(e=>!e)}),/* @__PURE__ */ g(c,{$borderColor:A(e.severity),children:[/* @__PURE__ */ g(`div`,{children:[/* @__PURE__ */ h(i,{children:k(e.severity)}),` `,e.message]}),n?/* @__PURE__ */ g(a,{children:[/* @__PURE__ */ g(s,{children:[/* @__PURE__ */ h(`strong`,{children:e.location.source.absoluteRef}),e.location.pointer]}),/* @__PURE__ */ h(t,{children:e.codeframe})]}):null]})]})}function M({chunks:e}){let t=e.map(e=>e.title).filter(Boolean).join(`, `);return/* @__PURE__ */ h(P,{"data-component-name":`Scorecard/Gauge`,title:t,children:e.map((e,t)=>/* @__PURE__ */ h(F,{$share:e.share,$colorVariable:e.colorVariable},t))})}const N=f.span`
|
|
2
2
|
vertical-align: middle;
|
|
3
3
|
display: inline-block;
|
|
4
4
|
margin-right: 0;
|
|
5
5
|
text-align: right;
|
|
6
6
|
width: 70px;
|
|
7
|
-
`,P=
|
|
7
|
+
`,P=f.div`
|
|
8
8
|
display: flex;
|
|
9
9
|
flex-direction: row;
|
|
10
10
|
height: 10px;
|
|
11
11
|
width: 100%;
|
|
12
|
-
`,F=
|
|
12
|
+
`,F=f.div`
|
|
13
13
|
width: ${e=>e.$share}%;
|
|
14
14
|
background-color: var(${e=>e.$colorVariable});
|
|
15
15
|
height: 10px;
|
|
16
|
-
`,I={Pass:{background:`--color-green-1`,icon:`--color-green-6`},Warn:{background:`--color-carrot-1`,icon:`--color-carrot-6`},Error:{background:`--color-raspberry-1`,icon:`--color-raspberry-6`}};function L({uniqueErrors:e,uniqueWarnings:t}){return/* @__PURE__ */
|
|
16
|
+
`,I={Pass:{background:`--color-green-1`,icon:`--color-green-6`},Warn:{background:`--color-carrot-1`,icon:`--color-carrot-6`},Error:{background:`--color-raspberry-1`,icon:`--color-raspberry-6`}};function L({uniqueErrors:e,uniqueWarnings:t}){return/* @__PURE__ */ g(R,{children:[e===0&&/* @__PURE__ */ h(z,{$color:`var(${I.Pass.background})`,children:/* @__PURE__ */ h(x,{size:`13px`,color:`var(${I.Pass.icon})`})}),e>0&&/* @__PURE__ */ g(z,{$color:`var(${I.Error.background})`,children:[/* @__PURE__ */ h(y,{size:`12px`,color:`var(${I.Error.icon})`}),/* @__PURE__ */ h(B,{$color:`var(${I.Error.icon})`,children:e})]}),t>0&&/* @__PURE__ */ g(z,{$color:`var(${I.Warn.background})`,children:[/* @__PURE__ */ h(b,{size:`12px`,color:`var(${I.Warn.icon})`}),/* @__PURE__ */ h(B,{$color:`var(${I.Warn.icon})`,children:t})]})]})}const R=f.div`
|
|
17
17
|
display: flex;
|
|
18
18
|
align-items: center;
|
|
19
19
|
gap: 4px;
|
|
20
|
-
`,z=
|
|
20
|
+
`,z=f.div`
|
|
21
21
|
background-color: ${({$color:e})=>e};
|
|
22
22
|
display: flex;
|
|
23
23
|
align-items: center;
|
|
@@ -25,11 +25,11 @@ import{CardRow as e,Code as t,ContentWithDotWrap as n,Dot as r,EmojiWrap as i,Fi
|
|
|
25
25
|
padding: 4px;
|
|
26
26
|
border-radius: 4px;
|
|
27
27
|
height: 20px;
|
|
28
|
-
`,B=
|
|
28
|
+
`,B=f.span`
|
|
29
29
|
color: ${({$color:e})=>e};
|
|
30
30
|
font-size: 12px;
|
|
31
31
|
margin-left: 4px;
|
|
32
|
-
`;function V({levels:t,title:n}){return/* @__PURE__ */
|
|
32
|
+
`;function V({levels:t,title:n}){return/* @__PURE__ */ g(l,{"data-component-name":`Scorecard/StatusByLevelWidget`,children:[/* @__PURE__ */ h(u,{children:n}),/* @__PURE__ */ h(H,{children:t.map(t=>{let n=t.total-t.errors-t.warnings;return/* @__PURE__ */ g(e,{children:[/* @__PURE__ */ h(`span`,{children:t.name}),/* @__PURE__ */ h(M,{chunks:[{share:n/t.total*100,colorVariable:`--scorecard-color-success`,title:`${n} passed`},{share:t.warnings/t.total*100,colorVariable:`--scorecard-color-warning`,title:`${t.warnings} ${t.warnings===1?`warning`:`warnings`}`},{share:t.errors/t.total*100,colorVariable:`--scorecard-color-error`,title:`${t.errors} ${t.errors===1?`error`:`errors`}`}]}),/* @__PURE__ */ g(N,{children:[n,`/`,t.total]})]},t.name)})})]})}const H=f.div`
|
|
33
33
|
display: flex;
|
|
34
34
|
flex-direction: column;
|
|
35
35
|
gap: 5px;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import{CATALOG_CLASSIC_DEP_KEY as e}from"../../catalog-classic/client/contract.js";import"./contract.js";import{AppPageWrapper as t,CardRow as n,CardValue as r,CardsWrapper as i,ContentWithDotWrap as a,LevelComplianceCardTitle as o,LinkButton as s,ModeSwitcherTab as c,ModeSwitcherTabs as l,PageDescription as u,ProblemsByStatusCardBody as d,ScoreCardStatusCardBody as f,ScorecardCard as p,ScorecardCardTitle as m,TableWrap as h}from"./styles.js";import{ApiLevel as g,Gauge as _,GaugeValue as v,InstanceStatus as y,LevelStatus as b,StatusByLevelWidget as x,StatusDistribution as S}from"./ScorecardWidgets.js";import{useApiScorecard as C,useScorecard as w}from"./use-scorecard.js";import{ApiListView as T,ApiProblemsView as E,RuleApisView as D,RulesView as
|
|
1
|
+
import{CATALOG_CLASSIC_DEP_KEY as e}from"../../catalog-classic/client/contract.js";import"./contract.js";import{AppPageWrapper as t,CardRow as n,CardValue as r,CardsWrapper as i,ContentWithDotWrap as a,LevelComplianceCardTitle as o,LinkButton as s,ModeSwitcherTab as c,ModeSwitcherTabs as l,PageDescription as u,ProblemsByStatusCardBody as d,ScoreCardStatusCardBody as f,ScorecardCard as p,ScorecardCardTitle as m,TableWrap as h}from"./styles.js";import{ApiLevel as g,Gauge as _,GaugeValue as v,InstanceStatus as y,LevelStatus as b,StatusByLevelWidget as x,StatusDistribution as S}from"./ScorecardWidgets.js";import{useApiScorecard as C,useScorecard as w}from"./use-scorecard.js";import{ApiListView as T,ApiProblemsView as E,RuleApisView as D,RulesView as ee,TeamsView as O}from"./ScorecardViews.js";import*as k from"react";import A from"styled-components";import{Button as j}from"@redocly/theme/components/Button/Button";import{useLocation as M}from"react-router";import{breakpoints as N,getScorecardColorVariable as P}from"@redocly/theme/core/utils";import{Fragment as F,jsx as I,jsxs as L}from"react/jsx-runtime";import{useModalScrollLock as R}from"@redocly/theme/core/hooks";import{ArrowLeftIcon as z}from"@redocly/theme/icons/ArrowLeftIcon/ArrowLeftIcon";import{Sidebar as B}from"@redocly/theme/components/Sidebar/Sidebar";import{useLoaderData as V}from"virtual:realm-runtime";import{Link as H}from"@redocly/theme/components/Link/Link";import{CatalogDescription as U,CatalogPageContent as W,CatalogPageDescriptionWrapper as G,CatalogPageWrapper as K,CatalogTitle as q}from"@redocly/theme/components/CatalogClassic/CatalogClassic";import{FilterContent as J}from"@redocly/theme/components/Filter/FilterContent";import{FilterPopover as Y}from"@redocly/theme/components/Filter/FilterPopover";import{HighlightContext as X}from"@redocly/theme/components/CatalogClassic/CatalogClassicHighlight";import{CatalogClassicActions as Z}from"@redocly/theme/components/CatalogClassic/CatalogClassicActions";function Q({page:t}){let n=V(e),{pathname:r}=M();if(!n)return null;let i=t.slug.replace(/\/$/,``),[a,o]=r.slice(i.length).split(`/`).filter(Boolean),s=o===void 0?void 0:decodeURIComponent(o);return/* @__PURE__ */ I(te,{base:i,data:n,view:a===`apis`&&s!==void 0?{kind:`api`,link:`/${s}`}:a===`rules`&&s!==void 0?{kind:`rule`,ruleId:s}:{kind:`dashboard`}})}function te({base:e,data:n,view:r}){let i=w(n);if(r.kind===`api`){let a=i.apis.find(e=>e.link===r.link);return a?/* @__PURE__ */ I(re,{base:e,api:a,scorecard:i,rulesPerLevel:n.scorecard.rulesPerLevel}):/* @__PURE__ */ I(t,{children:`API not found`})}if(r.kind===`rule`){let n=i.problemsByRule.find(e=>e.ruleId===r.ruleId);return n?/* @__PURE__ */ I(ie,{base:e,rule:n,scorecard:i}):/* @__PURE__ */ I(t,{children:`Rule not found`})}return/* @__PURE__ */ I(ne,{base:e,levelNames:n.scorecard.levelNames,scorecard:i})}function ne({base:e,levelNames:t,scorecard:o}){let{summary:u,filters:_,filterTerm:v,setFilterTerm:y,hasTeam:b,teamLabel:x,catalogConfig:C}=o,w={apis:`APIs`,rules:`Rules`};b&&(w.teams=x);let[E,D]=k.useState(!1),[A,j]=k.useState(`apis`),M=k.useCallback(()=>j(`apis`),[]);R(E);let N=o.teams.filter(e=>(e.apis[`Non-conformant`]??0)>0).sort((e,t)=>(t.apis[`Non-conformant`]??0)-(e.apis[`Non-conformant`]??0));return/* @__PURE__ */ I(X.Provider,{value:[v],children:/* @__PURE__ */ L(K,{"data-component-name":`Scorecard/Dashboard`,children:[/* @__PURE__ */ I(ae,{menu:/* @__PURE__ */ I(J,{setFilterTerm:y,filters:_,filterTerm:v,filterValuesCasing:C.filterValuesCasing})}),E&&/* @__PURE__ */ I(Y,{onClose:()=>D(!1),setFilterTerm:y,filterTerm:v,filters:_,filterValuesCasing:C.filterValuesCasing}),/* @__PURE__ */ I(Z,{onOpenFilter:()=>D(!0),filters:_,filterTerm:v}),/* @__PURE__ */ L(W,{children:[/* @__PURE__ */ L(G,{children:[/* @__PURE__ */ I(q,{children:`API design scorecard`}),/* @__PURE__ */ I(U,{children:`See the health of your API designs.`})]}),/* @__PURE__ */ L(i,{children:[/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:`Scorecard status`}),/* @__PURE__ */ L(f,{children:[/* @__PURE__ */ L(`div`,{children:[/* @__PURE__ */ I(r,{children:u.total}),/* @__PURE__ */ I(`br`,{}),`APIs`]}),/* @__PURE__ */ I(`div`,{children:Object.entries(u.levels).map(([e,t],n)=>/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(r,{style:{width:`40px`,textAlign:`right`},children:t}),/* @__PURE__ */ I(g,{level:e,colorVariable:P(n,Object.values(u.levels).length)})]},e))})]}),/* @__PURE__ */ I(S,{summary:u})]}),b&&/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:`Non-conformant APIs by ${x}`}),/* @__PURE__ */ L(d,{children:[N.slice(0,4).map(e=>/* @__PURE__ */ L(n,{children:[/* @__PURE__ */ I(`span`,{style:{flex:1,textAlign:`left`},children:e.team}),/* @__PURE__ */ I(r,{children:e.apis[`Non-conformant`]})]},e.team)),o.teams.length>4&&/* @__PURE__ */ L(s,{onClick:()=>j(`teams`),children:[`See all (`,o.teams.length,`)`]})]})]})]}),/* @__PURE__ */ I(l,{"data-component-name":`Scorecard/ModeSwitcherTabs`,children:Object.entries(w).map(([e,t])=>/* @__PURE__ */ I(c,{"data-component-name":`Scorecard/ModeSwitcherTab`,$isActive:A===e,onClick:()=>j(e),children:t},e))}),/* @__PURE__ */ I(h,{$isActive:A===`apis`,children:/* @__PURE__ */ I(T,{base:e,apis:o.apis,levelNames:t,hasTeam:b,hasPublishedAt:o.hasPublishedAt,teamLabel:x})}),/* @__PURE__ */ I(h,{$isActive:A===`rules`,children:/* @__PURE__ */ I(ee,{base:e,rules:o.problemsByRule})}),b&&/* @__PURE__ */ I(h,{$isActive:A===`teams`,children:/* @__PURE__ */ I(O,{teams:o.teams,levelNames:t,filters:_,teamLabel:x,teamProperty:o.teamProperty,onSelectTeam:M})})]})]})})}function $({base:e}){return/* @__PURE__ */ I(j,{icon:/* @__PURE__ */ I(z,{}),iconPosition:`left`,variant:`ghost`,size:`large`,to:e,children:`Back to dashboard`})}function re({base:e,api:n,scorecard:s,rulesPerLevel:d}){let _=C(n.scorecard.relativePath),v=_?.levels??{},y=Object.keys(v),[S,w]=k.useState(),T=S??y[0];return _===void 0?/* @__PURE__ */ I(t,{children:`Loading…`}):_===null?/* @__PURE__ */ I(t,{children:`Scorecard not found`}):/* @__PURE__ */ L(t,{"data-component-name":`Scorecard/ApiPage`,children:[/* @__PURE__ */ I($,{base:e}),/* @__PURE__ */ I(`h1`,{children:n.title}),/* @__PURE__ */ L(u,{children:[n.publishedAt&&/* @__PURE__ */ L(F,{children:[`Published at: `,new Date(n.publishedAt).toLocaleDateString(),/* @__PURE__ */ I(`br`,{})]}),/* @__PURE__ */ I(H,{to:n.link,external:!0,children:`Documentation`})]}),/* @__PURE__ */ L(i,{children:[/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ L(o,{children:[/* @__PURE__ */ I(`span`,{children:`Scorecard level`}),/* @__PURE__ */ I(g,{level:_.scorecardLevel,colorVariable:P(_.scorecardLevelIdx,y.length+1)})]}),/* @__PURE__ */ L(f,{children:[/* @__PURE__ */ I(`div`,{children:`Compliance by level`}),/* @__PURE__ */ I(`div`,{children:Object.entries(v).map(([e,t])=>/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(r,{style:{width:`100px`,textAlign:`right`},children:e}),/* @__PURE__ */ I(b,{errors:t.errors,warnings:t.warnings})]},e))})]})]}),/* @__PURE__ */ I(x,{title:`Rules compliance`,levels:Object.entries(v).map(([e,t])=>({name:e,errors:t.uniqueErrors,warnings:t.uniqueWarnings,total:d[e]?.length??0}))}),/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:s.teamLabel}),/* @__PURE__ */ I(r,{style:{fontWeight:`normal`},children:n.team})]})]}),/* @__PURE__ */ I(l,{"data-component-name":`Scorecard/ModeSwitcherTabs`,children:y.map(e=>/* @__PURE__ */ I(c,{"data-component-name":`Scorecard/ModeSwitcherTab`,$isActive:T===e,onClick:()=>w(e),children:/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(`span`,{children:e}),/* @__PURE__ */ I(b,{errors:v[e].errors,warnings:v[e].warnings})]})},e))}),y.map(e=>/* @__PURE__ */ I(h,{$isActive:T===e,children:/* @__PURE__ */ I(E,{level:e,problems:v[e].problems})},e))]})}function ie({base:e,rule:o,scorecard:s}){let c=Object.entries(o.teams).sort((e,t)=>t[1]-e[1]),l=o.apis.length;return/* @__PURE__ */ L(t,{"data-component-name":`Scorecard/RulePage`,children:[/* @__PURE__ */ I($,{base:e}),/* @__PURE__ */ L(`h1`,{children:[`Rule `,o.ruleId]}),/* @__PURE__ */ L(i,{children:[/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:`Rule status`}),/* @__PURE__ */ L(f,{children:[/* @__PURE__ */ L(`div`,{children:[/* @__PURE__ */ I(r,{children:l}),/* @__PURE__ */ I(`br`,{}),`APIs`]}),/* @__PURE__ */ L(`div`,{children:[/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(r,{children:l-o.warningApisCount-o.errorApisCount}),/* @__PURE__ */ I(y,{severity:`Pass`})]}),/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(r,{children:o.warningApisCount}),/* @__PURE__ */ I(y,{severity:`Warn`})]}),/* @__PURE__ */ L(a,{children:[/* @__PURE__ */ I(r,{children:o.errorApisCount}),/* @__PURE__ */ I(y,{severity:`Error`})]})]})]})]}),/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:`Problems by level`}),/* @__PURE__ */ I(d,{children:Object.entries(o.levels).map(([e,t])=>/* @__PURE__ */ L(n,{children:[/* @__PURE__ */ I(`span`,{children:e}),/* @__PURE__ */ I(_,{chunks:[{share:t.errors/o.count*100,colorVariable:`--scorecard-color-error`},{share:t.warnings/o.count*100,colorVariable:`--scorecard-color-warning`}]}),/* @__PURE__ */ I(v,{children:t.errors+t.warnings})]},e))})]}),/* @__PURE__ */ L(p,{children:[/* @__PURE__ */ I(m,{children:`Problems by ${s.teamLabel}`}),/* @__PURE__ */ I(d,{children:c.slice(0,4).map(([e,t])=>/* @__PURE__ */ L(n,{children:[/* @__PURE__ */ I(`span`,{style:{flex:1,textAlign:`left`},children:e}),/* @__PURE__ */ I(r,{children:t})]},e))})]})]}),/* @__PURE__ */ I(D,{ruleId:o.ruleId,apis:o.apis,hasPublishedAt:s.hasPublishedAt,hasTeam:s.hasTeam,teamLabel:s.teamLabel})]})}const ae=A(B)`
|
|
2
2
|
display: none;
|
|
3
3
|
|
|
4
|
-
@media screen and (min-width: ${
|
|
4
|
+
@media screen and (min-width: ${N.medium}) {
|
|
5
5
|
display: flex;
|
|
6
6
|
}
|
|
7
7
|
--menu-container-padding-top: 0;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
|
|
2
|
-
import type { NAV_ITEM_RBAC, RbacScope } from '../../../../
|
|
3
|
-
import type {
|
|
2
|
+
import type { NAV_ITEM_RBAC, RbacScope } from '../../../../shared/rbac/types.js';
|
|
3
|
+
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
4
4
|
import type { ProblemDraft } from '../../../problems/types.js';
|
|
5
5
|
import { type LinkRefDraft } from '../../../link-checker/classify.js';
|
|
6
6
|
import type { RouteIndex } from '../../utils/route-index.js';
|
|
7
|
+
import { type VersionGroups } from '../../../versions/version-groups.js';
|
|
7
8
|
export type SidebarBadge = {
|
|
8
9
|
name: string;
|
|
9
10
|
color?: string;
|
|
@@ -11,7 +12,7 @@ export type SidebarBadge = {
|
|
|
11
12
|
position?: 'before' | 'after';
|
|
12
13
|
};
|
|
13
14
|
export type BundledSidebarNode = {
|
|
14
|
-
type?:
|
|
15
|
+
type?: SidebarItemType;
|
|
15
16
|
label?: string;
|
|
16
17
|
/** The theme shows this key's translation, `label` when it has none. */
|
|
17
18
|
labelTranslationKey?: string;
|
|
@@ -51,6 +52,15 @@ export type BundledSidebarNode = {
|
|
|
51
52
|
httpVerb?: string;
|
|
52
53
|
deprecated?: boolean;
|
|
53
54
|
badges?: SidebarBadge[];
|
|
55
|
+
/**
|
|
56
|
+
* A page that is an item of another route's sidebar, such as an API operation under its API
|
|
57
|
+
* route: that route's slug and the page's stored slug. The item gives the label and access, and
|
|
58
|
+
* a page the route does not list loses the link.
|
|
59
|
+
*/
|
|
60
|
+
subtreeItem?: {
|
|
61
|
+
route: string;
|
|
62
|
+
link: string;
|
|
63
|
+
};
|
|
54
64
|
/** Server-only RBAC scope. */
|
|
55
65
|
[REDOCLY_TEAMS_RBAC]?: Record<string, string>;
|
|
56
66
|
/** Server-only scope from the entry's `rbac`. */
|
|
@@ -88,6 +98,8 @@ type BundleSidebarOptions = {
|
|
|
88
98
|
sidebarByDirectory?: ReadonlyMap<string, string>;
|
|
89
99
|
/** Route slugs a `directory` entry leaves out. */
|
|
90
100
|
skipRoutes?: ReadonlySet<string>;
|
|
101
|
+
/** The site's version groups; a `page:` path under a default version's route links through them. */
|
|
102
|
+
versionGroups?: VersionGroups;
|
|
91
103
|
};
|
|
92
104
|
export declare function bundleSidebar(options: BundleSidebarOptions & {
|
|
93
105
|
source: string;
|
|
@@ -98,19 +110,8 @@ export declare function bundleSidebarEntries(options: BundleSidebarOptions & {
|
|
|
98
110
|
}): Promise<BundleSidebarResult>;
|
|
99
111
|
/**
|
|
100
112
|
* Stamp `isDefaultVersion` and `versionLabel` on versioned leaves, from
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* later. Reads go through tracked io, so a change re-runs this finalize.
|
|
104
|
-
* Mutates `nodes`.
|
|
113
|
+
* `versionGroups`. Links keep their stored form here; `resolveSidebarNodes`
|
|
114
|
+
* rewrites default-version links later. Mutates `nodes`.
|
|
105
115
|
*/
|
|
106
|
-
export declare function stampDefaultVersions(
|
|
107
|
-
io: {
|
|
108
|
-
exists: (path: string) => Promise<boolean>;
|
|
109
|
-
readFile: (path: string) => Promise<string>;
|
|
110
|
-
};
|
|
111
|
-
routes: RouteIndex;
|
|
112
|
-
nodes: BundledSidebarNode[];
|
|
113
|
-
versionedDirectories: readonly string[];
|
|
114
|
-
logger?: Logger;
|
|
115
|
-
}): Promise<void>;
|
|
116
|
+
export declare function stampDefaultVersions(nodes: BundledSidebarNode[], versionGroups: VersionGroups): void;
|
|
116
117
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{L10N_DIR as e}from"../../../../shared/constants/l10n/defaults.js";import{isObject as t}from"../../../../shared/utils/is-object.js";import"../../../../shared/utils/l10n.js";import{resolveContentPath as n}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as r}from"../assets/extensions.js";import{splitUrlSuffix as i}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as a}from"../../../../server/rbac/filter.js";import{resolvePageTarget as o}from"../../../../shared/utils/routes/resolve-page-target.js";import{collectVersionGroups as s,findVersionedDirectories as c}from"../../../versions/version-groups.js";import{joinSrcSet as l,parseSrcSet as u}from"../assets/srcset.js";import{classifyLinkTarget as d}from"../../../link-checker/classify.js";import{posix as f}from"node:path";import p from"js-yaml";function m(e){return typeof e.tab==`string`}function h(e,t,n){e.report?.({code:t,message:n,location:{filePath:e.file.path}})}function g(e,r){let i=p.load(e);if(!Array.isArray(i))return[];let a=[],o=e=>{if(t(e)){if(typeof e.$ref==`string`){let t=n(e.$ref,r);t!==null&&a.push(t)}if(Array.isArray(e.items))for(let t of e.items)o(t);if(m(e)&&Array.isArray(e.menu))for(let t of e.menu)o(t)}};for(let e of i)o(e);return a}async function _(e){let t=p.load(e.source);if(!Array.isArray(t))return[];let n=[];return await v({entries:t,ownerFilePath:e.filePath,currentFilePath:e.filePath,readFile:e.readFile,visitedRefs:/* @__PURE__ */ new Set([e.filePath]),refs:n}),n}async function v(e){let{ownerFilePath:t,currentFilePath:r,readFile:i,refs:a}=e;for(let o of e.entries){let s=W(o);if(s===void 0)continue;if(typeof s.$ref==`string`){let o=n(s.$ref,r);if(o===null||i===void 0||e.visitedRefs.has(o))continue;let c;try{c=await i(o)}catch{continue}let l=p.load(c);if(!Array.isArray(l))continue;let u=new Set(e.visitedRefs);u.add(o),await v({entries:l,ownerFilePath:t,currentFilePath:o,readFile:i,visitedRefs:u,refs:a});continue}let c=typeof s.page==`string`?s.page:s.href;typeof c==`string`&&y(a,c,r,t),Array.isArray(s.items)&&await v({...e,entries:s.items}),m(s)&&Array.isArray(s.menu)&&await v({...e,entries:s.menu})}}function y(e,t,n,r){let i=d(t,n);i!==null&&e.push({kind:`link`,raw:t,...i,...n===r?{}:{filePath:n}})}async function b(e){let t=p.load(e.source);if(!Array.isArray(t))throw Error(`Sidebar "${e.file.path}" must be a YAML sequence at the top level.`);return x({...e,entries:t})}async function x(e){let n=e.entries,r=n.filter(e=>t(e)&&m(e));if(r.length>0&&r.length!==n.length)throw Error(`Sidebar "${e.file.path}": when a sidebar uses navigation tabs, every top-level entry must be a tab (found ${n.length-r.length} other entries).`);let i={file:e.file,routes:e.routes,assignedRouteSlugs:/* @__PURE__ */ new Set,versionedDirectories:/* @__PURE__ */ new Set,report:e.report,readFile:e.readFile,skipRoutes:e.skipRoutes,exists:e.exists,sidebarByDirectory:e.sidebarByDirectory??/* @__PURE__ */ new Map,visitedRefs:/* @__PURE__ */ new Set([e.file.path])},a=[];if(r.length>0){for(let[e,t]of r.entries())a.push(await M({...i,entry:t,tabIndex:e}));F({file:e.file,tabs:a,routes:e.routes})}else for(let e of n)a.push(...await S({...i,entry:e}));return{assignedRouteSlugs:[...i.assignedRouteSlugs].sort(),versionedDirectories:[...i.versionedDirectories].sort(),nodes:a}}async function S(e){let n=await C(e),r=t(e.entry)?e.entry.rbac:void 0;if(r===void 0)return n;let i=P({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=W(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${U(e.entry)} is not a page reference or a group.`),[];if(m(t))throw Error(`Sidebar "${e.file.path}": "tab" is only allowed at the top level (found nested tab "${t.tab}").`);if(t.menu!==void 0)throw Error(`Sidebar "${e.file.path}": "menu" is only allowed directly on a tab.`);if(typeof t.$ref==`string`)return T({...e,ref:t.$ref});if(typeof t.directory==`string`&&K(t.group)!==void 0&&t.items===void 0)return C({...e,entry:{...t,directory:void 0,items:[{directory:t.directory,flatten:t.flatten}]}});if(typeof t.directory==`string`){let r=n(t.directory,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(r);i.length===0&&h(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await L({...e,directoryPath:r,flatten:t.flatten===!0,pages:i.filter(t=>!e.skipRoutes?.has(t.slug))}),o=K(t.group)??K(t.label);return o===void 0?a:[{...J(t,e),menuStyle:Y(t),items:a.length>0?a:void 0,label:o,labelTranslationKey:w(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...J(t,e),label:t.separator,labelTranslationKey:K(t.separatorTranslationKey)}];let r=await z(t,e),i=r.route;if(i)for(let t of c([i]))e.versionedDirectories.add(t);let a;if(Array.isArray(t.items)){a=[];for(let n of t.items)a.push(...await S({...e,entry:n}))}let o=K(t.group)??K(t.label)??(i===void 0?K(t.href):void 0)??r.anchor,s=K(t.group)!==void 0;return[{...J(t,e),menuStyle:s?Y(t):void 0,external:t.external===!0||void 0,languageInsensitive:r.languageInsensitive?!0:void 0,items:a&&a.length>0?a:void 0,label:o,labelTranslationKey:w(t),link:r.link,isGroup:s?!0:void 0,version:K(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e){return K(K(e.group)===void 0?e.labelTranslationKey:e.groupTranslationKey)}async function T(e){let{ref:t}=e,r=n(t,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is outside the content root.`),[];if(e.readFile===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is not supported here.`),[];if(e.visitedRefs.has(r))return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" includes itself.`),[];let i;try{i=await e.readFile(r)}catch{return h(e,`sidebar/missing-target`,`Sidebar $ref "${r}" could not be read.`),[]}let a=p.load(i);return Array.isArray(a)?E(e,r,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" must be a YAML sequence.`),[])}async function E(e,t,n){let r=/* @__PURE__ */ new Set([...e.visitedRefs,t]),i=[];for(let a of n)i.push(...await S({...e,entry:a,file:{path:t},visitedRefs:r}));return i}async function D(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?E({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(O)):[]}function O(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function k(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function A(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function j(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw A({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw A({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw A({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw A({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw A({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw A({file:t,label:r,message:`has an empty "menu"`});if(n.$ref!==void 0||n.directory!==void 0||n.group!==void 0||n.href!==void 0)throw A({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function M(e){let{entry:t}=e,n=t.tab;j({file:e.file,entry:t});let r=k(e.tabIndex,n);if(t.menu!==void 0){let i=Array.isArray(t.menu)?t.menu:[],a=[];for(let[t,n]of i.entries()){let i=await N({...e,tabId:r,index:t,raw:n});i!==void 0&&a.push(i)}return{tab:!0,tabId:r,label:n,menu:a,...X(t.icon,e),...P({...e,rbac:t.rbac})}}let[i]=await S({...e,entry:{page:t.page,label:n,items:t.items,rbac:t.rbac}}),a=i?.items??[];return{...i,tab:!0,tabId:r,...X(t.icon,e),items:a}}async function N(e){let{file:t,entry:n,tabId:r,index:i,raw:a}=e,o=n.tab,s=W(a);if(s===void 0||typeof s.page!=`string`)throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" needs "page".`);if(s.page.includes(`#`))throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" page must not contain a heading anchor.`);let c=`${r}/${i}`,[l]=await S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function P(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function F(e){let t=/* @__PURE__ */ new Map,n=(n,r)=>{for(let i of r){let r=t.get(i);if(r!==void 0&&r.tabId!==n.tabId)throw Error(`Sidebar "${e.file.path}": route "${i}" is claimed by two navigation tabs, "${r.label}" and "${n.label}". A route can belong to one tab only.`);t.set(i,n)}};for(let t of e.tabs){if(t.menu!==void 0){for(let r of t.menu)r.tabId!==void 0&&n({tabId:r.tabId,label:`${t.label} > ${r.label??r.link}`},I({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},I({routes:e.routes,link:t.link,items:t.items}))}}function I(e){let t=[],n=n=>{if(n.link===void 0||n.languageInsensitive===!0)return;let r=e.routes.bySlug(n.link);r!==void 0&&r.originFilePath!==null&&t.push(r.slug)};n({link:e.link});let r=e=>{if(e!==void 0)for(let t of e)n(t),r(t.items)};return r(e.items),t}async function L(t){let n=t.directoryPath===``?``:`${t.directoryPath}/`,r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Set,o=t.directoryPath.startsWith(`${e}/`),s=t.pages.filter(e=>o||e.locale===``).map(e=>({route:e,relativePath:e.originFilePath?.startsWith(n)?e.originFilePath.slice(n.length):null})).sort((e,t)=>R(e.relativePath??e.route.slug,t.relativePath??t.route.slug));for(let e of s){let n=e.relativePath?.split(`/`).slice(0,-1)??[],r=c(n);if(r!==void 0){if(!a.has(r.path)){a.add(r.path);let e=await D(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}V(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({link:e.route.slug,version:e.route.version??void 0,versionGroup:e.route.versionGroup??void 0})}return r;function c(e){for(let n=0;n<=e.length;n++){let r=f.join(t.directoryPath,...e.slice(0,n)),i=t.sidebarByDirectory.get(r);if(i!==void 0&&!t.visitedRefs.has(i))return{depth:n,path:i}}}function l(e,n){return t.flatten?[]:e.slice(0,n).filter(e=>!e.startsWith(`@`))}function u(e){let t=r,n=``;for(let r of e){n=n===``?r:`${n}/${r}`;let e=i.get(n);if(e){t=e;continue}let a=[];t.push({items:a,label:r}),i.set(n,a),t=a}return t}}function R(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function z(e,t){if(typeof e.page==`string`){let{path:n,suffix:r,anchor:a}=i(e.page.trim()),o=await B(n,t);return o?(e.disconnect!==!0&&V(o,t),{link:`${o.slug}${r}`,anchor:a,route:o}):{}}if(typeof e.href==`string`){let n=e.href;if(n.startsWith(`/`)){let e=t.routes.bySlug(n);return e?{link:e.slug,route:e}:{link:n,languageInsensitive:!0}}return{link:n,languageInsensitive:!0}}return{}}async function B(e,t){let r=o(e,t.file.path,t.routes);if(r.kind===`escaped`){h(t,`sidebar/invalid-entry`,`Sidebar page "${e}" is outside the content root.`);return}if(r.kind===`missing`){let r=n(e,t.file.path);r!==null&&await t.exists?.(r)&&h(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return r.value}function V(e,t){t.assignedRouteSlugs.add(e.slug)}async function H(e){if(e.versionedDirectories.length===0)return;let t=await s({io:e.io,routes:e.routes,versionedDirectories:e.versionedDirectories}),n=e=>{for(let r of e){if(r.version!==void 0&&r.versionGroup!==void 0){let e=t.get(r.versionGroup),n=e?.labels.get(r.version);n&&(r.versionLabel=n),e?.defaultVersion===r.version&&(r.isDefaultVersion=!0)}r.items&&n(r.items),r.menu&&n(r.menu)}};n(e.nodes)}function U(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function W(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function G(e){if(!Array.isArray(e))return;let n=[];for(let r of e){let e=t(r)?K(r.name):void 0;t(r)&&e!==void 0&&n.push({name:e,color:K(r.color),icon:K(r.icon),position:r.position===`before`||r.position===`after`?r.position:void 0})}return n.length>0?n:void 0}function K(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function q(e,t){return t.find(t=>t===e)}function J(e,t){return{badges:G(e.badges),...X(e.icon,t),expanded:e.expanded===!0?`true`:q(e.expanded,[`always`]),selectFirstItemOnExpand:e.selectFirstItemOnExpand===!0||void 0,separatorLine:e.separatorLine===!0||void 0,linePosition:q(e.linePosition,[`top`,`bottom`]),target:K(e.target),sublabel:K(e.sublabel)}}function Y(e){return q(e.menuStyle,[`drilldown`,`drilldown-header`])}function X(e,n){let r=t(e)?K(e.srcSet):void 0;if(r!==void 0){let e=u(r);if(e===null)return{srcSet:r};for(let t of e)t.src=Z(t.src,n);return{srcSet:l(e)}}let i=K(e);return i===void 0?{}:{icon:Z(i,n)}}function Z(e,t){if(!r(e))return e;let i=n(e,t.file.path);return i===null?(h(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${i}`}export{b as bundleSidebar,x as bundleSidebarEntries,_ as collectSidebarLinkRefs,g as collectSidebarRefTargets,H as stampDefaultVersions};
|
|
1
|
+
import{isObject as e}from"../../../../shared/utils/is-object.js";import{L10N_DIR as t}from"../../../../shared/constants/l10n/defaults.js";import{normalizeRouteSlug as n}from"../../../../shared/utils/routes/normalize-route-slug.js";import"../../../../shared/utils/l10n.js";import{resolveContentPath as r}from"../../../../shared/utils/resolve-content-path.js";import{computePathPrefixes as i}from"../../../../shared/utils/routes/compute-path-prefixes.js";import{isLocalImagePath as a}from"../assets/extensions.js";import{splitUrlSuffix as o}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as s}from"../../../../shared/rbac/filter.js";import{resolvePageTarget as c}from"../../../../shared/utils/routes/resolve-page-target.js";import{findVersionedDirectories as l}from"../../../versions/version-groups.js";import{physicalVersionedSlug as u}from"../../utils/link-access.js";import{joinSrcSet as d,parseSrcSet as f}from"../assets/srcset.js";import{classifyLinkTarget as p}from"../../../link-checker/classify.js";import{posix as m}from"node:path";import h from"js-yaml";function g(e){return typeof e.tab==`string`}function _(e,t,n){e.report?.({code:t,message:n,location:{filePath:e.file.path}})}function v(t,n){let i=h.load(t);if(!Array.isArray(i))return[];let a=[],o=t=>{if(e(t)){if(typeof t.$ref==`string`){let e=r(t.$ref,n);e!==null&&a.push(e)}if(Array.isArray(t.items))for(let e of t.items)o(e);if(g(t)&&Array.isArray(t.menu))for(let e of t.menu)o(e)}};for(let e of i)o(e);return a}async function y(e){let t=h.load(e.source);if(!Array.isArray(t))return[];let n=[];return await b({entries:t,ownerFilePath:e.filePath,currentFilePath:e.filePath,readFile:e.readFile,visitedRefs:/* @__PURE__ */ new Set([e.filePath]),refs:n}),n}async function b(e){let{ownerFilePath:t,currentFilePath:n,readFile:i,refs:a}=e;for(let o of e.entries){let s=K(o);if(s===void 0)continue;if(typeof s.$ref==`string`){let o=r(s.$ref,n);if(o===null||i===void 0||e.visitedRefs.has(o))continue;let c;try{c=await i(o)}catch{continue}let l=h.load(c);if(!Array.isArray(l))continue;let u=new Set(e.visitedRefs);u.add(o),await b({entries:l,ownerFilePath:t,currentFilePath:o,readFile:i,visitedRefs:u,refs:a});continue}let c=typeof s.page==`string`?s.page:s.href;typeof c==`string`&&x(a,c,n,t),Array.isArray(s.items)&&await b({...e,entries:s.items}),g(s)&&Array.isArray(s.menu)&&await b({...e,entries:s.menu})}}function x(e,t,n,r){let i=p(t,n);i!==null&&e.push({kind:`link`,raw:t,...i,...n===r?{}:{filePath:n}})}async function S(e){let t=h.load(e.source);if(!Array.isArray(t))throw Error(`Sidebar "${e.file.path}" must be a YAML sequence at the top level.`);return C({...e,entries:t})}async function C(t){let n=t.entries,r=n.filter(t=>e(t)&&g(t));if(r.length>0&&r.length!==n.length)throw Error(`Sidebar "${t.file.path}": when a sidebar uses navigation tabs, every top-level entry must be a tab (found ${n.length-r.length} other entries).`);let i={file:t.file,routes:t.routes,versionGroups:t.versionGroups??/* @__PURE__ */ new Map,assignedRouteSlugs:/* @__PURE__ */ new Set,versionedDirectories:/* @__PURE__ */ new Set,report:t.report,readFile:t.readFile,skipRoutes:t.skipRoutes,exists:t.exists,sidebarByDirectory:t.sidebarByDirectory??/* @__PURE__ */ new Map,visitedRefs:/* @__PURE__ */ new Set([t.file.path])},a=[];if(r.length>0){for(let[e,t]of r.entries())a.push(await N({...i,entry:t,tabIndex:e}));I({file:t.file,tabs:a,routes:t.routes})}else for(let e of n)a.push(...await w({...i,entry:e}));return{assignedRouteSlugs:[...i.assignedRouteSlugs].sort(),versionedDirectories:[...i.versionedDirectories].sort(),nodes:a}}async function w(t){let n=await T(t),r=e(t.entry)?t.entry.rbac:void 0;if(r===void 0)return n;let i=F({...t,rbac:r});for(let e of n)Object.assign(e,i);return n}async function T(e){let t=K(e.entry);if(t===void 0)return _(e,`sidebar/invalid-entry`,`Sidebar entry ${G(e.entry)} is not a page reference or a group.`),[];if(g(t))throw Error(`Sidebar "${e.file.path}": "tab" is only allowed at the top level (found nested tab "${t.tab}").`);if(t.menu!==void 0)throw Error(`Sidebar "${e.file.path}": "menu" is only allowed directly on a tab.`);if(typeof t.$ref==`string`)return k({...e,ref:t.$ref});if(typeof t.directory==`string`&&O(t)&&t.items===void 0)return T({...e,entry:{...t,directory:void 0,items:[{directory:t.directory,flatten:t.flatten}]}});if(typeof t.directory==`string`){let n=r(t.directory,e.file.path);if(n===null)return _(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(n);i.length===0&&_(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await R({...e,directoryPath:n,flatten:t.flatten===!0,pages:i.filter(t=>!e.skipRoutes?.has(t.slug))}),o=J(t.group)??J(t.label);return o===void 0?a:[{type:`group`,...X(t,e),menuStyle:Z(t),items:a.length>0?a:void 0,label:o,labelTranslationKey:D(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...X(t,e),label:t.separator,labelTranslationKey:J(t.separatorTranslationKey)}];let n=await B(t,e),i=n.route;if(i)for(let t of l([i]))e.versionedDirectories.add(t);let a;if(Array.isArray(t.items)){a=[];for(let n of t.items)a.push(...await w({...e,entry:n}))}let o=J(t.group)??J(t.label)??(i===void 0?J(t.href):void 0)??n.anchor,s=O(t);return[{type:E(t,!!n.link,n.linksConnectedHeading===!0),...X(t,e),menuStyle:s?Z(t):void 0,external:t.external===!0||void 0,languageInsensitive:n.languageInsensitive?!0:void 0,items:a&&a.length>0?a:void 0,label:o,labelTranslationKey:D(t),link:n.link,isGroup:s?!0:void 0,version:J(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0,subtreeItem:n.subtreeItem}]}function E(e,t,n){if(O(e)&&!n)return`group`;if(t||e.label)return`link`}function D(e){return J(O(e)?e.groupTranslationKey:e.labelTranslationKey)}function O(e){return J(e.group)!==void 0}async function k(e){let{ref:t}=e,n=r(t,e.file.path);if(n===null)return _(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is outside the content root.`),[];if(e.readFile===void 0)return _(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is not supported here.`),[];if(e.visitedRefs.has(n))return _(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" includes itself.`),[];let i;try{i=await e.readFile(n)}catch{return _(e,`sidebar/missing-target`,`Sidebar $ref "${n}" could not be read.`),[]}let a=h.load(i);return Array.isArray(a)?A(e,n,a):(_(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" must be a YAML sequence.`),[])}async function A(e,t,n){let r=/* @__PURE__ */ new Set([...e.visitedRefs,t]),i=[];for(let a of n)i.push(...await w({...e,entry:a,file:{path:t},visitedRefs:r}));return i}async function ee(e,t){if(e.readFile===void 0)return[];let n=h.load(await e.readFile(t));return Array.isArray(n)?A({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(te)):[]}function te(t){if(!e(t)||!g(t))return t;let{tab:n,menu:r,...i}=t;return{...i,group:n,items:i.items??r}}function ne(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function j(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function M(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw j({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw j({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw j({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw j({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw j({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw j({file:t,label:r,message:`has an empty "menu"`});if(n.$ref!==void 0||n.directory!==void 0||n.group!==void 0||n.href!==void 0)throw j({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function N(e){let{entry:t}=e,n=t.tab;M({file:e.file,entry:t});let r=ne(e.tabIndex,n);if(t.menu!==void 0){let i=Array.isArray(t.menu)?t.menu:[],a=[];for(let[t,n]of i.entries()){let i=await P({...e,tabId:r,index:t,raw:n});i!==void 0&&a.push(i)}return{tab:!0,tabId:r,label:n,menu:a,...Q(t.icon,e),...F({...e,rbac:t.rbac})}}let[i]=await w({...e,entry:{page:t.page,label:n,items:t.items,rbac:t.rbac}}),a=i?.items??[];return{...i,tab:!0,tabId:r,...Q(t.icon,e),items:a}}async function P(e){let{file:t,entry:n,tabId:r,index:i,raw:a}=e,o=n.tab,s=K(a);if(s===void 0||typeof s.page!=`string`)throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" needs "page".`);if(s.page.includes(`#`))throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" page must not contain a heading anchor.`);let c=`${r}/${i}`,[l]=await w({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function F(e){return s(e.rbac,()=>_(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function I(e){let t=/* @__PURE__ */ new Map,n=(n,r)=>{for(let i of r){let r=t.get(i);if(r!==void 0&&r.tabId!==n.tabId)throw Error(`Sidebar "${e.file.path}": route "${i}" is claimed by two navigation tabs, "${r.label}" and "${n.label}". A route can belong to one tab only.`);t.set(i,n)}};for(let t of e.tabs){if(t.menu!==void 0){for(let r of t.menu)r.tabId!==void 0&&n({tabId:r.tabId,label:`${t.label} > ${r.label??r.link}`},L({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},L({routes:e.routes,link:t.link,items:t.items}))}}function L(e){let t=[],n=n=>{if(n.link===void 0||n.languageInsensitive===!0)return;let r=e.routes.bySlug(n.link);r!==void 0&&r.originFilePath!==null&&t.push(r.slug)};n({link:e.link});let r=e=>{if(e!==void 0)for(let t of e)n(t),r(t.items)};return r(e.items),t}async function R(e){let n=e.directoryPath===``?``:`${e.directoryPath}/`,r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Set,o=e.directoryPath.startsWith(`${t}/`),s=e.pages.filter(e=>o||e.locale===``).map(e=>({route:e,relativePath:e.originFilePath?.startsWith(n)?e.originFilePath.slice(n.length):null})).sort((e,t)=>z(e.relativePath??e.route.slug,t.relativePath??t.route.slug));for(let t of s){let n=t.relativePath?.split(`/`).slice(0,-1)??[],r=c(n);if(r!==void 0){if(!a.has(r.path)){a.add(r.path);let t=await ee(e,r.path);t.length>0&&u(l(n,r.depth)).push(...t)}continue}U(t.route,e),t.route.version&&e.versionedDirectories.add(e.directoryPath),u(l(n,n.length)).push({type:`link`,link:t.route.slug,version:t.route.version??void 0,versionGroup:t.route.versionGroup??void 0})}return r;function c(t){for(let n=0;n<=t.length;n++){let r=m.join(e.directoryPath,...t.slice(0,n)),i=e.sidebarByDirectory.get(r);if(i!==void 0&&!e.visitedRefs.has(i))return{depth:n,path:i}}}function l(t,n){return e.flatten?[]:t.slice(0,n).filter(e=>!e.startsWith(`@`))}function u(e){let t=r,n=``;for(let r of e){n=n===``?r:`${n}/${r}`;let e=i.get(n);if(e){t=e;continue}let a=[];t.push({type:`group`,items:a,label:r}),i.set(n,a),t=a}return t}}function z(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function B(e,t){if(typeof e.page==`string`){let{path:r,suffix:i,anchor:a}=o(e.page.trim()),s=await V(r,t);if(!s){let e=H(r,t);return e===void 0?{}:{link:`${n(r)}${i}`,anchor:a,subtreeItem:e}}let c=e.disconnect!==!0;return c&&U(s,t),{link:`${s.slug}${i}`,anchor:a,linksConnectedHeading:c&&a!==void 0,route:s}}if(typeof e.href==`string`){let n=e.href;if(n.startsWith(`/`)){let e=t.routes.bySlug(n);return e?{link:e.slug,route:e}:{link:n,languageInsensitive:!0}}return{link:n,languageInsensitive:!0}}return{}}async function V(e,t){let n=c(e,t.file.path,t.routes);if(n.kind===`escaped`){_(t,`sidebar/invalid-entry`,`Sidebar page "${e}" is outside the content root.`);return}if(n.kind===`missing`){let n=r(e,t.file.path);n!==null&&await t.exists?.(n)&&_(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return n.value}function H(e,t){if(!e.startsWith(`/`))return;let r=n(e),a=[r,u(r,t.versionGroups)].find(e=>e!==null&&t.routes.getAccess(e)!==void 0);if(a!=null)for(let e of i(a).slice(0,-1).reverse()){let n=t.routes.bySlug(e);if(n?.sidebarSubtreeEntityKey)return{route:n.slug,link:a}}}function U(e,t){t.assignedRouteSlugs.add(e.slug)}function W(e,t){let n=e=>{for(let r of e){if(r.version!==void 0&&r.versionGroup!==void 0){let e=t.get(r.versionGroup),n=e?.labels.get(r.version);n&&(r.versionLabel=n),e?.defaultVersion===r.version&&(r.isDefaultVersion=!0)}r.items&&n(r.items),r.menu&&n(r.menu)}};n(e)}function G(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function K(t){return typeof t==`string`?t.trim()===``?void 0:{page:t}:e(t)?t:void 0}function q(t){if(!Array.isArray(t))return;let n=[];for(let r of t){if(!e(r))continue;let t=J(r.name),i=J(r.icon);(t!==void 0||i!==void 0)&&n.push({name:t??``,color:J(r.color),icon:i,position:r.position===`before`||r.position===`after`?r.position:void 0})}return n.length>0?n:void 0}function J(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function Y(e,t){return t.find(t=>t===e)}function X(e,t){return{badges:q(e.badges),...Q(e.icon,t),expanded:e.expanded===!0?`true`:Y(e.expanded,[`always`]),selectFirstItemOnExpand:e.selectFirstItemOnExpand===!0||void 0,separatorLine:e.separatorLine===!0||void 0,linePosition:Y(e.linePosition,[`top`,`bottom`]),target:J(e.target),sublabel:J(e.sublabel)}}function Z(e){return Y(e.menuStyle,[`drilldown`,`drilldown-header`])}function Q(t,n){let r=e(t)?J(t.srcSet):void 0;if(r!==void 0){let e=f(r);if(e===null)return{srcSet:r};for(let t of e)t.src=$(t.src,n);return{srcSet:d(e)}}let i=J(t);return i===void 0?{}:{icon:$(i,n)}}function $(e,t){if(!a(e))return e;let n=r(e,t.file.path);return n===null?(_(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${n}`}export{S as bundleSidebar,C as bundleSidebarEntries,y as collectSidebarLinkRefs,v as collectSidebarRefTargets,W as stampDefaultVersions};
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
import { REDOCLY_TEAMS_RBAC } from '@redocly/config';
|
|
2
2
|
import { type BundledSidebarNode, type SidebarBadge } from './bundle.js';
|
|
3
3
|
import { type VersionStamp } from './subtree.js';
|
|
4
|
-
import { NAV_ITEM_RBAC, type RbacScope } from '../../../../
|
|
4
|
+
import { NAV_ITEM_RBAC, type RbacScope } from '../../../../shared/rbac/types.js';
|
|
5
|
+
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
5
6
|
import { SIDEBAR_ROUTE_DEP_KEY } from '../../../../shared/constants/route-deps.js';
|
|
6
7
|
export declare const SIDEBAR_PLUGIN_ID = "internal.sidebar";
|
|
7
8
|
export declare const SIDEBAR_AGGREGATOR_LOADER_ID: "internal.sidebar:aggregate";
|
|
8
9
|
export { SIDEBAR_ROUTE_DEP_KEY };
|
|
10
|
+
/** `sidebars.yaml`, or a file name that ends in `.sidebars.yaml`, `_sidebars.yaml` or `-sidebars.yaml`. */
|
|
9
11
|
export declare const SIDEBAR_FILENAME_REGEX: RegExp;
|
|
10
|
-
/** A folder's own sidebar; a named
|
|
12
|
+
/** A folder's own sidebar; a named `*sidebars.yaml` is not one. */
|
|
11
13
|
export declare const FOLDER_SIDEBAR_FILENAME_REGEX: RegExp;
|
|
12
14
|
export type ResolvedSidebarItem = {
|
|
13
|
-
type?:
|
|
15
|
+
type?: SidebarItemType;
|
|
14
16
|
label?: string;
|
|
15
17
|
labelTranslationKey?: string;
|
|
16
18
|
link?: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import"../../../../shared/constants/l10n/defaults.js";import{NAV_ITEM_RBAC as i}from"../../../../server/rbac/types.js";import{compareStrings as a}from"../../../../shared/utils/compare-strings.js";import{isObject as o}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as s}from"../../../../shared/utils/l10n.js";import{resolveContentPath as c}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as l}from"../assets/extensions.js";import{splitUrlSuffix as u}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolvePageTarget as d}from"../../../../shared/utils/routes/resolve-page-target.js";import{toPublicVersionedSlug as f}from"../../../../shared/constants/versions.js";import{collectVersionGroups as p,findVersionedDirectories as ee}from"../../../versions/version-groups.js";import{publicLink as m}from"../../../versions/public-link.js";import{linkedPageAccess as h}from"../../utils/link-access.js";import{safeDecodeURI as g}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as _,parseSrcSet as v}from"../assets/srcset.js";import{bundleSidebar as y,bundleSidebarEntries as te,collectSidebarLinkRefs as b,collectSidebarRefTargets as ne,stampDefaultVersions as x}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as S,sidebarStartEntityKey as re}from"./contributions.js";import{applySubtree as C}from"./subtree.js";import{collectSlugOverrides as w}from"../../utils/slug-overrides.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as ie,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as T,SIDEBAR_ROUTE_DEP_KEY as E,localizedSidebarDepKey as D}from"../../../../shared/constants/route-deps.js";import{SITE_START_ENTITY_KEY as ae}from"../../../../shared/constants/site-start.js";import{posix as O}from"node:path";import{REDOCLY_TEAMS_RBAC as k}from"@redocly/config";const A=`internal.sidebar`,j=r(A,`aggregate`),M=/(^|\/)(?:[^/]*\.)?sidebars\.ya?ml$/i,N=/(^|\/)sidebars\.ya?ml$/i,P=`sidebars.yaml`,F=`redocly.yaml`;function I(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function L(e){if(Array.isArray(e))return e.find(e=>R(e.label)!==void 0)?.label}function R(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function z(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function B(e,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,a=e?await t.loadEntity(e):void 0,o=r.tabId!==void 0,s=o?{...r,isGroup:!0,label:r.label??L(a)}:r,c=a===void 0?[s]:C(s,a);for(let e of c){let a=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],s=e[k]??(a===void 0&&e.link!==void 0?t.accessOf(e.link)??void 0:void 0);n.push({type:e.type,expanded:e.expanded,selectFirstItemOnExpand:e.selectFirstItemOnExpand,external:e.external,target:e.target,languageInsensitive:e.languageInsensitive,icon:e.icon===void 0?void 0:await t.resolveAsset(e.icon),srcSet:e.srcSet===void 0?void 0:await V(e.srcSet,t),items:e.items?await B(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await B(e.menu,t):void 0,label:o?e.label??z(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?f(e.link,e.versionGroup,e.version,e.isDefaultVersion===!0):e.link,separatorLine:e.separatorLine,linePosition:e.linePosition,variant:e.variant,menuStyle:e.menuStyle,sublabel:e.sublabel,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,httpVerb:e.httpVerb,deprecated:e.deprecated,badges:e.badges,[k]:s,[i]:a})}}return n}async function V(e,t){let n=v(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return _(r)}function H(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!l(r))return r;let i=await e.resolveImageReference(r,``),a=c(g(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function U(e){return e.tabId!==void 0}function W(e){return U(e)&&e.link!==void 0}function G(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[k]:e[k],[i]:e[i]}}function K(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function q(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(W).map(K)}}const J=t(j,async e=>{let t=H(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,o=i.length===0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:i}),c=await B(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??s(e,n)))??a(e),accessOf:t=>h(t,e.routes,o),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(U).map(q)}:c,...t.collected()}});async function oe(e){let t=await e.loadEntity(e.subtreeKey);return B(C({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function se(e){let t=typeof e==`string`?e:o(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function Y(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function X(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(C({link:r},await t.entities.load(i)))}return n}function ce(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function le(e){let t=[];for(let n of await e.list({type:S}))t.push(...await e.load(n.key));return t}function ue(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function de(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=fe(e,t,n);return r===null?null:{item:e,link:r.link,label:await Z(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=c(i,F),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function fe(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=u(e.page.trim()),o=d(r,F,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${m(s,n)}${i}`,anchor:a,route:s}}async function Z(e,t,n){let r=R(e.label)??R(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,a=i?await n(i):void 0;return(o(a)?R(a.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function pe(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?f(t.link,t.versionGroup,t.version,!0):t.link}function me(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&N.test(e))??t).link}function he(e){let t=null;for(let{slug:n,originFilePath:r,locale:i,versionGroup:o}of e)r!==null&&i===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&a(n,t)<0)&&(t=n);return t}const ge=e({id:A,version:`1.23.0`,content:{filter:{match:e=>M.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await b({source:n,filePath:e.path,readFile:t.io.readFile})}}},async finalize(e){let t=[],r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Map,o=/* @__PURE__ */ new Map,s=[],c=/* @__PURE__ */ new Map,l=/* @__PURE__ */ new Map,d=[],f=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),m=e.routes.all(),g=w(m,e.localeContext),_=ee(m),v=_.length>0?_:void 0;f.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let b=new Map(f.map(({path:e,source:t})=>[e,t])),S=/* @__PURE__ */ new Map;for(let{path:e}of f)N.test(e)&&S.set(O.dirname(e),e);let C=/* @__PURE__ */ new Set;for(let{path:e,source:t}of f)for(let n of ne(t,e))C.add(n);let A={routes:e.routes,report:e=>r.push(e),readFile:async t=>b.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:S},j=async(n,r)=>{if(n.nodes.length===0)return;await x({io:e.io,routes:e.routes,logger:e.logger,nodes:n.nodes,versionedDirectories:_});let i=J.withArgs({nodes:n.nodes,versionedDirectories:v},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),l.set(i,n.nodes);let a=/* @__PURE__ */ new Map;for(let r of e.localeContext.locales){let e=J.withArgs({nodes:n.nodes,locale:r,slugOverrides:g[r]??{},versionedDirectories:v});t.push(e),a.set(r,e)}return c.set(i,a),i};for(let{path:t,source:n}of f){if(C.has(t))continue;let c=await y({...A,file:{path:t},source:n}),l=await j(c,t);if(l===void 0)continue;a.set(t,l);let u=t.startsWith(`@l10n/`)?null:$(c.nodes);u!==null&&d.push({path:t,link:u}),s.push(await X(c,e));for(let e of c.assignedRouteSlugs){let n=o.get(e);n!==void 0&&r.push({code:`sidebar/route-conflict`,message:`Page "${e}" is in sidebars ${n} and ${t}; it shows ${t}.`,location:{filePath:t}}),i.set(e,l),o.set(e,t)}}ce(i,s);let M=new Map(m.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=M.get(t);if(e===void 0||e.originFilePath===null)continue;let o=se(n);if(o===null)continue;let s=O.normalize(o.startsWith(`/`)?o.slice(1):O.join(O.dirname(e.originFilePath),o)),c=a.get(s);if(c===void 0){r.push({code:`sidebar/missing-target`,message:`Front matter sidebar "${o}" is not a sidebar file of this project.`,location:{filePath:e.originFilePath}});continue}i.set(e.slug,c)}let F=await le(e.entities),I=/* @__PURE__ */ new Set,L=/* @__PURE__ */ new Map,R=/* @__PURE__ */ new Map;for(let t of F){let n=i.get(t.route);if(n===void 0){let r=await te({...A,file:{path:P},entries:t.entries});if(n=await j(r),n===void 0)continue;let a=(await X(r,e)).keys();for(let e of[...r.assignedRouteSlugs,...a])i.has(e)||(i.set(e,n),I.add(e))}let r=L.get(n);L.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=R.get(n);R.set(n,a===void 0?t.breadcrumbs??[]:ue(a,t.breadcrumbs))}if(f.length===0&&m.length>0){let e=await y({...A,file:{path:P},source:`- directory: .
|
|
2
|
-
`,skipRoutes:
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{compareStrings as i}from"../../../../shared/utils/compare-strings.js";import{isObject as a}from"../../../../shared/utils/is-object.js";import"../../../../shared/constants/l10n/defaults.js";import{NAV_ITEM_RBAC as o}from"../../../../shared/rbac/types.js";import{toLocaleSlug as s}from"../../../../shared/utils/l10n.js";import{resolveContentPath as c}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as l}from"../assets/extensions.js";import{splitUrlSuffix as u}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolvePageTarget as d}from"../../../../shared/utils/routes/resolve-page-target.js";import{toPublicVersionedSlug as f}from"../../../../shared/constants/versions.js";import{collectVersionGroups as p,findVersionedDirectories as ee}from"../../../versions/version-groups.js";import{publicLink as m}from"../../../versions/public-link.js";import{linkedPageAccess as h}from"../../utils/link-access.js";import{safeDecodeURI as g}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as _,parseSrcSet as v}from"../assets/srcset.js";import{bundleSidebar as y,bundleSidebarEntries as te,collectSidebarLinkRefs as b,collectSidebarRefTargets as x,stampDefaultVersions as ne}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as S,sidebarStartEntityKey as C}from"./contributions.js";import{applySubtree as w}from"./subtree.js";import{collectSlugOverrides as re}from"../../utils/slug-overrides.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as T,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as E,SIDEBAR_ROUTE_DEP_KEY as D,localizedSidebarDepKey as ie}from"../../../../shared/constants/route-deps.js";import{SITE_START_ENTITY_KEY as O}from"../../../../shared/constants/site-start.js";import{posix as k}from"node:path";import{REDOCLY_TEAMS_RBAC as A}from"@redocly/config";const j=`internal.sidebar`,M=r(j,`aggregate`),N=/(^|[/._-])sidebars\.ya?ml$/,P=/(^|\/)sidebars\.ya?ml$/,F=`sidebars.yaml`,I=`redocly.yaml`;function L(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function R(e){if(Array.isArray(e))return e.find(e=>z(e.label)!==void 0)?.label}function z(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function B(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function V(e,{route:t,link:n},r){let i=r.subtreeKeyOf(t);if(!i)return{...e,link:void 0};let a=await r.loadEntity(i);if(a===void 0)return{...e,label:e.label??B(e.link)};let o=H(w({link:t},a),n.toLowerCase());return o===void 0?{...e,link:void 0}:{...e,label:e.label??o.label,[A]:o[A]}}function H(e,t){for(let n of e){if(n.link?.toLowerCase()===t)return n;let e=n.items===void 0?void 0:H(n.items,t);if(e!==void 0)return e}}async function U(e,t){let n=[];for(let r of e){let e=r.subtreeItem===void 0?r:await V(r,r.subtreeItem,t),i=e.link?t.subtreeKeyOf(e.link):void 0,a=i?await t.loadEntity(i):void 0,s=e.tabId!==void 0,c=s||!!i&&a===void 0,l=s?{...e,isGroup:!0,label:e.label??R(a)}:e,u=a===void 0?[l]:w(l,a);for(let r of u){let i=r[`redocly::nav-item-rbac`]??e[`redocly::nav-item-rbac`],a=r[A]??(i===void 0&&r.link!==void 0?t.accessOf(r.link)??void 0:void 0);n.push({type:r.type,expanded:r.expanded,selectFirstItemOnExpand:r.selectFirstItemOnExpand,external:r.external,target:r.target,languageInsensitive:r.languageInsensitive,icon:r.icon===void 0?void 0:await t.resolveAsset(r.icon),srcSet:r.srcSet===void 0?void 0:await W(r.srcSet,t),items:r.items?await U(r.items,t):void 0,tab:r.tab,tabId:r.tabId,menu:r.menu?await U(r.menu,t):void 0,label:c?r.label??B(r.link):r.label,labelTranslationKey:r.labelTranslationKey,link:r.link!==void 0&&r.versionGroup!==void 0&&r.version!==void 0?f(r.link,r.versionGroup,r.version,r.isDefaultVersion===!0):r.link,separatorLine:r.separatorLine,linePosition:r.linePosition,variant:r.variant,menuStyle:r.menuStyle,sublabel:r.sublabel,version:r.version,versionGroup:r.versionGroup,isDefaultVersion:r.isDefaultVersion,versionLabel:r.versionLabel,httpVerb:r.httpVerb,deprecated:r.deprecated,badges:r.badges,[A]:a,[o]:i})}}return n}async function W(e,t){let n=v(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return _(r)}function G(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!l(r))return r;let i=await e.resolveImageReference(r,``),a=c(g(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function K(e){return e.tabId!==void 0}function q(e){return K(e)&&e.link!==void 0}function J(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[A]:e[A],[o]:e[o]}}function ae(e){return{...J(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function oe(e){return{...J(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(q).map(ae)}}const Y=t(M,async e=>{let t=G(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,o=i.length===0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:i}),c=await U(e.args.nodes,{loadEntity:t=>e.entities.tryLoad(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??s(e,n)))??a(e),accessOf:t=>h(t,e.routes,o),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(K).map(oe)}:c,...t.collected()}});async function se(e){let t=await e.loadEntity(e.subtreeKey);return U(w({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function ce(e){let t=typeof e==`string`?e:a(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function X(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function Z(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(w({link:r},await t.entities.load(i)))}return n}function le(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function ue(e){let t=[];for(let n of await e.list({type:S}))t.push(...await e.load(n.key));return t}function de(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function fe(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=pe(e,t,n);return r===null?null:{item:e,link:r.link,label:await me(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=c(i,I),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function pe(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=u(e.page.trim()),o=d(r,I,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${m(s,n)}${i}`,anchor:a,route:s}}async function me(e,t,n){let r=z(e.label)??z(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,o=i?await n(i):void 0;return(a(o)?z(o.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function he(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?f(t.link,t.versionGroup,t.version,!0):t.link}function ge(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&P.test(e))??t).link}function _e(e){let t=null;for(let{slug:n,originFilePath:r,locale:a,versionGroup:o}of e)r!==null&&a===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&i(n,t)<0)&&(t=n);return t}const ve=e({id:j,version:`1.27.0`,content:{filter:{match:e=>N.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await b({source:n,filePath:e.path,readFile:t.io.readFile})}}},async finalize(e){let t=[],r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Map,o=/* @__PURE__ */ new Map,s=[],c=/* @__PURE__ */ new Map,l=/* @__PURE__ */ new Map,d=[],f=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),m=e.routes.all(),g=re(m,e.localeContext),_=ee(m),v=_.length>0?_:void 0;f.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let b=new Map(f.map(({path:e,source:t})=>[e,t])),S=/* @__PURE__ */ new Map;for(let{path:e}of f)P.test(e)&&S.set(k.dirname(e),e);let w=/* @__PURE__ */ new Set;for(let{path:e,source:t}of f)for(let n of x(t,e))w.add(n);let j=await p({io:e.io,routes:e.routes,versionedDirectories:_}),M={routes:e.routes,versionGroups:j,report:e=>r.push(e),readFile:async t=>b.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:S},N=async(n,r)=>{if(n.nodes.length===0)return;ne(n.nodes,j);let i=Y.withArgs({nodes:n.nodes,versionedDirectories:v},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),l.set(i,n.nodes);let a=/* @__PURE__ */ new Map;for(let r of e.localeContext.locales){let e=Y.withArgs({nodes:n.nodes,locale:r,slugOverrides:g[r]??{},versionedDirectories:v});t.push(e),a.set(r,e)}return c.set(i,a),i};for(let{path:t,source:n}of f){if(w.has(t))continue;let c=await y({...M,file:{path:t},source:n}),l=await N(c,t);if(l===void 0)continue;a.set(t,l);let u=t.startsWith(`@l10n/`)?null:$(c.nodes);u!==null&&d.push({path:t,link:u}),s.push(await Z(c,e));for(let e of c.assignedRouteSlugs){let n=o.get(e);n!==void 0&&r.push({code:`sidebar/route-conflict`,message:`Page "${e}" is in sidebars ${n} and ${t}; it shows ${t}.`,location:{filePath:t}}),i.set(e,l),o.set(e,t)}}le(i,s);let I=new Map(m.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=I.get(t);if(e===void 0||e.originFilePath===null)continue;let o=ce(n);if(o===null)continue;let s=k.normalize(o.startsWith(`/`)?o.slice(1):k.join(k.dirname(e.originFilePath),o)),c=a.get(s);if(c===void 0){r.push({code:`sidebar/missing-target`,message:`Front matter sidebar "${o}" is not a sidebar file of this project.`,location:{filePath:e.originFilePath}});continue}i.set(e.slug,c)}let L=await ue(e.entities),R=/* @__PURE__ */ new Set,z=/* @__PURE__ */ new Map,B=/* @__PURE__ */ new Map;for(let t of L){let n=i.get(t.route);if(n===void 0){let r=await te({...M,file:{path:F},entries:t.entries});if(n=await N(r),n===void 0)continue;let a=(await Z(r,e)).keys();for(let e of[...r.assignedRouteSlugs,...a])i.has(e)||(i.set(e,n),R.add(e))}let r=z.get(n);z.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=B.get(n);B.set(n,a===void 0?t.breadcrumbs??[]:de(a,t.breadcrumbs))}if(f.length===0&&m.length>0){let e=await y({...M,file:{path:F},source:`- directory: .
|
|
2
|
+
`,skipRoutes:R}),t=await N(e);if(t!==void 0){for(let n of e.assignedRouteSlugs)i.has(n)||i.set(n,t);let n=$(e.nodes);n!==null&&d.push({path:F,link:n})}}let V=ge(d)??_e(m);if(V!==null){let{path:e}=u(V);t.push(n(e,{stableKey:O}))}let H=/* @__PURE__ */ new Map;for(let e of m){if(e.originFilePath===null)continue;let t=X(e);H.set(t,[...H.get(t)??[],e.slug])}for(let[e,t]of[...i]){let n=I.get(e);for(let e of(n&&H.get(X(n)))??[])i.has(e)||i.set(e,t)}let U=/* @__PURE__ */ new Map,W=(e.config.navbar?.items??[]).filter(e=>e.linkedSidebars?.length),G=/* @__PURE__ */ new Map;for(let[t,n]of await fe(W,e.routes,j,a,t=>e.entities.tryLoad(t)))B.set(t,[n,...B.get(t)??[]]);let K=({label:t,link:n,icon:r})=>({label:t,link:n,icon:r,[A]:h(n,e.routes,j)??void 0});for(let[e,r]of z){if(r===null)continue;let i=n(K(r));t.push(i),U.set(e,i)}for(let[e,r]of B){if(r.length===0)continue;let i=n(r.map(K));t.push(i),G.set(e,i)}for(let r of new Set(L.map(e=>e.route))){let a=i.get(r),o=a===void 0?void 0:l.get(a),s=o===void 0?null:he(o,e.routes.bySlug(r)?.version??null);s!==null&&t.push(n(s,{stableKey:C(r)}))}return{entities:t,attach:[...i.entries()].map(([e,t])=>{let n={[D]:t},r=U.get(t);r!==void 0&&(n[T]=r);let i=G.get(t);if(i!==void 0&&(n[E]=i),I.get(e)?.locale===``)for(let[e,r]of c.get(t)??[])n[ie(e)]=r;return{slug:e,deps:n}}),problems:r}},loaders:[Y]});export{P as FOLDER_SIDEBAR_FILENAME_REGEX,M as SIDEBAR_AGGREGATOR_LOADER_ID,N as SIDEBAR_FILENAME_REGEX,j as SIDEBAR_PLUGIN_ID,D as SIDEBAR_ROUTE_DEP_KEY,L as isTabbedSidebar,se as resolveAutoSidebar,ve as sidebarContentPlugin};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
function e(e,n){let r=e.version===void 0?void 0:{version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel};if(Array.isArray(n)){let i=e.isGroup===!0||Array.isArray(e.items)&&e.items.length>0,a=n.map(n=>t(n,e.link??``,r));if(i){let[t,...n]=a,r=t&&(t.link===void 0||t.link===e.link)?n:a;return[{...e,items:[...r,...e.items??[]]}]}return a}if(!n||typeof n!=`object`)return[e];let i={...e};for(let[t,r]of Object.entries(n)){if(t===`slugSuffix`&&typeof r==`string`){i.link=(e.link??``)+r;continue}i[t]===void 0&&r!==void 0&&(i[t]=r)}return e.slugSuffix&&!i.link&&(i.link=e.slugSuffix),[i]}function t(e,n,r){let i=r?{...e,...r}:{...e};return e.slugSuffix!==void 0&&(i.link=e.slugSuffix===``||e.slugSuffix===`/`?n:n+e.slugSuffix,delete i.slugSuffix),e.items&&(i.items=e.items.map(e=>t(e,n,r))),i}export{e as applySubtree};
|
|
1
|
+
function e(e,n){let r=e.version===void 0?void 0:{version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel};if(Array.isArray(n)){let i=e.isGroup===!0||Array.isArray(e.items)&&e.items.length>0,a=n.map(n=>t(n,e.link??``,r));if(i){let[t,...n]=a,r=t&&(t.link===void 0||t.link===e.link)?n:a;return[{...e,items:[...r,...e.items??[]]}]}for(let t of a)t.link===e.link&&(e.label!==void 0&&(t.label=e.label,t.labelTranslationKey=e.labelTranslationKey),(e.icon!==void 0||e.srcSet!==void 0)&&(t.icon=e.icon,t.srcSet=e.srcSet),e.badges!==void 0&&(t.badges=e.badges));return a}if(!n||typeof n!=`object`)return[e];let i={...e};for(let[t,r]of Object.entries(n)){if(t===`slugSuffix`&&typeof r==`string`){i.link=(e.link??``)+r;continue}i[t]===void 0&&r!==void 0&&(i[t]=r)}return e.slugSuffix&&!i.link&&(i.link=e.slugSuffix),[i]}function t(e,n,r){let i=r?{...e,...r}:{...e};return e.slugSuffix!==void 0&&(i.link=e.slugSuffix===``||e.slugSuffix===`/`?n:n+e.slugSuffix,delete i.slugSuffix),e.items&&(i.items=e.items.map(e=>t(e,n,r))),i}export{e as applySubtree};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{isPlanFeatureGranted as n}from"../../../../shared/plan-gates.js";import{slugifySegment as r}from"../../../../shared/utils/routes/slugify-segment.js";import{compileContentGlob as i}from"../../utils/glob.js";import{AGENT_SKILLS_BASE as a,SKILLS_FOLDER as o,SKILLS_INDEX_SLUG as s,SKILL_FILENAME as c}from"../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as l,skillEntityKey as u}from"../../types/skill-entity.js";import{parseSkill as d}from"./parse-skill.js";const f=`internal.skills`,p=`${a}/:slug/${c}`,m=c.toLowerCase();function h(e){let t=e.split(`/`);return t.length===3&&t[0]===`@skills`&&t[2].toLowerCase()===m}function g(e,t){let n=/* @__PURE__ */ new Map;for(let t of e){if(!h(t.path))continue;let[,e,r]=t.path.split(`/`),i=n.get(e);i?i.push(r):n.set(e,[r])}let i=[],a=/* @__PURE__ */ new Map;for(let[e,s]of n){let n=s.includes(`SKILL.md`)?c:s[0];s.length>1&&t.warn(`Multiple skill files in "${o}/${e}" differ only by case; using "${n}".`);let l=r(e),u=a.get(l);if(u!==void 0){t.warn(`Skipping skill folder "${o}/${e}": its slug "${l}" collides with the folder "${u}" after slugification.`);continue}a.set(l,e),i.push({slug:l,sourcePath:`${o}/${e}/${n}`})}return i}const _=e({id:f,version:`1.3.0`,server:{routes:[{method:`GET`,path:s,handler:{filePath:`./server/routes.ts`,importer:import.meta.url,exportName:`skillsIndex`}},{method:`GET`,path:p,handler:{filePath:`./server/routes.ts`,importer:import.meta.url,exportName:`skillMarkdown`}}]},content:{filter:{match:e=>e===`SKILL.md`||h(e)},async extractAll(e){let r=[...e.config.mcp?.ignore??[],...e.config.skills?.excludeFiles??[]],a=r.length>0?i(r):()=>!1,o=process.env.PROJECT_SLUG||`project-docs`,s=g(e.files,e.logger);e.files.some(e=>e.path===`SKILL.md`)&&s.push({slug:o,sourcePath:c});let f=/* @__PURE__ */ new Map,p=/* @__PURE__ */ new Map,m=n(e.config,`rbac`);for(let n of s){if(a(n.sourcePath))continue;let r=await e.io.readFile(n.sourcePath),i=d(n.sourcePath,r);if(`error`in i){e.logger.warn(i.error);continue}let o=p.get(n.slug);o!==void 0&&e.logger.warn(`Skill "${n.slug}" from "${o}" is replaced by "${n.sourcePath}".`);let s={slug:n.slug,title:i.title,description:i.description,sourcePath:n.sourcePath};`rbac`in i&&m&&(s.rbac=i.rbac);let c={content:r};p.set(n.slug,n.sourcePath),f.set(n.slug,t(c,{stableKey:u(n.slug),type:l,metadata:s}))}return{routes:[],entities:[...f.values()]}}}});export{f as SKILLS_PLUGIN_ID,p as SKILL_MARKDOWN_ROUTE_PATH,_ as skillsContentPlugin};
|