@redocly/framework 1.0.0-next.5 → 1.0.0-next.7
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/routes/source-sync-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-chunk-url.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/commands/build.js +1 -1
- package/dist/cli/commands/dev.js +1 -1
- package/dist/cli/commands/ingest.js +1 -1
- package/dist/cli/commands/translate.js +2 -2
- 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/log-output/index.js +1 -1
- 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/ThemeGlobalStyle.js +1 -0
- package/dist/client/UnversionedVersionButton.js +1 -1
- package/dist/client/ai-search/use-ai-search.js +1 -1
- package/dist/client/analytics-page-view.js +1 -1
- package/dist/client/app.js +3 -3
- package/dist/client/client-entry.js +1 -1
- package/dist/client/contexts.js +1 -1
- package/dist/client/dev-problems/ProblemsBar.js +61 -11
- 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/feedback.js +1 -1
- package/dist/client/l10n/ssr-l10n.js +1 -1
- 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 +61 -61
- package/dist/client/review/use-review.js +1 -1
- package/dist/client/sidebar/PoweredByRedocly.js +2 -2
- package/dist/client/sidebar/SidebarDataProvider.js +1 -1
- package/dist/client/sidebar/drilldown.js +1 -1
- package/dist/client/ssr.js +1 -1
- package/dist/client/telemetry/config.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/theme-logo.js +1 -1
- package/dist/client/use-banner.js +1 -1
- package/dist/client/use-entity-revisions.js +1 -1
- package/dist/client/use-page-versions.js +1 -1
- package/dist/client/use-search.js +1 -1
- package/dist/client/webmcp/tools/shared.js +1 -1
- package/dist/client/webmcp/tools/site-tools.js +1 -1
- package/dist/client/webmcp/use-webmcp-tools.js +1 -1
- package/dist/content-layer/allowed-packages.js +1 -1
- package/dist/content-layer/config-schema.d.ts +5 -1
- package/dist/content-layer/config-schema.js +1 -1
- package/dist/content-layer/config.d.ts +8 -3
- package/dist/content-layer/config.js +1 -1
- package/dist/content-layer/database/adapters/node-sqlite-client.js +1 -1
- package/dist/content-layer/database/connection.js +1 -1
- package/dist/content-layer/database/entity-store.d.ts +9 -1
- package/dist/content-layer/database/entity-store.js +1 -1
- package/dist/content-layer/database/invalidation.js +26 -26
- package/dist/content-layer/database/origins.d.ts +2 -4
- package/dist/content-layer/database/origins.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/hook-inputs.js +1 -1
- package/dist/content-layer/ingest/normalize-artifacts.js +1 -1
- 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/load-view.js +1 -1
- package/dist/content-layer/link-checker/validate.js +1 -1
- package/dist/content-layer/loaders/context.js +1 -1
- package/dist/content-layer/markdown/client/OpenapiTagComponents.js +2 -2
- 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/client/markdown-text.js +1 -1
- 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.js +1 -1
- package/dist/content-layer/markdown/nodes/heading.js +1 -1
- package/dist/content-layer/markdown/resolve/audience-tag.d.ts +1 -1
- package/dist/content-layer/markdown/resolve/audience-tag.js +1 -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.js +1 -1
- package/dist/content-layer/markdown/resolve/references.js +1 -1
- package/dist/content-layer/markdown/search/to-markdown.js +1 -1
- package/dist/content-layer/markdown/search/to-sections.js +1 -1
- 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 +4 -1
- package/dist/content-layer/markdown/tags/html.js +1 -1
- package/dist/content-layer/markdown/tags/variant.js +1 -1
- package/dist/content-layer/markdown/types/service.d.ts +2 -0
- package/dist/content-layer/markdown/utils/parse-cache.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/plan-gates.d.ts +3 -2
- package/dist/content-layer/plan-gates.js +1 -1
- package/dist/content-layer/plugins/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/client/template.js +4 -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 +2 -2
- 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/markdown-docs.js +13 -13
- 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.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/app-data/banner.js +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/use-catalog-classic.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/index.js +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/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/content-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/ignored-routes.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/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/credentials-page/site-branding.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 +6 -6
- package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/fetch-bridge.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/index.js +2 -2
- package/dist/content-layer/plugins/internal/mcp/server/gateway/secret-store.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tools.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/handler.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/authorize.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/server-info.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/search.js +2 -2
- package/dist/content-layer/plugins/internal/mock/server/handler.js +1 -1
- 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/scorecard-classic/index.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/bundle.d.ts +1 -1
- package/dist/content-layer/plugins/internal/sidebar/bundle.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.d.ts +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.js +2 -2
- 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/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/plugin.d.ts +8 -0
- package/dist/content-layer/plugins/types/search.d.ts +1 -1
- 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/version-path.js +1 -1
- package/dist/content-layer/revisions/config.js +1 -1
- package/dist/content-layer/server/context.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/versions/redirect.d.ts +11 -6
- package/dist/content-layer/versions/redirect.js +1 -1
- package/dist/content-layer/versions/resolve.js +1 -1
- package/dist/plugin-api.d.ts +3 -0
- package/dist/plugin-api.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/gate.js +1 -1
- package/dist/server/auth/middleware.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 +13 -13
- package/dist/server/cors-proxy/handler.js +1 -1
- package/dist/server/feedback/route.js +1 -1
- package/dist/server/lambda-entry.js +1 -1
- package/dist/server/manifest-assets.js +4 -4
- 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/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/route.js +1 -1
- package/dist/server/seo-tags.js +2 -2
- package/dist/server/sitemap.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/template-ids.js +1 -1
- package/dist/shared/constants/api-spec-kinds.d.ts +6 -0
- package/dist/shared/constants/api-spec-kinds.js +1 -0
- package/dist/shared/constants/content-update.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/{server → shared}/constants/system-routes.d.ts +1 -1
- package/dist/shared/constants/system-routes.js +1 -0
- package/dist/shared/plan-gates.d.ts +6 -1
- package/dist/shared/plan-gates.js +1 -1
- package/dist/shared/products.js +1 -1
- package/dist/{server → shared}/project-env.d.ts +1 -1
- package/dist/{server → shared}/rbac/api-docs.d.ts +1 -1
- package/dist/{server → shared}/rbac/engine.d.ts +1 -1
- package/dist/shared/rbac/engine.js +0 -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/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/types/config.d.ts +2 -0
- package/dist/shared/types/search.d.ts +7 -2
- package/dist/shared/utils/routes/file-path-to-route-slug.js +1 -1
- package/package.json +28 -8
- 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/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/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/{server → shared}/project-env.js +0 -0
- /package/dist/{server → shared}/rbac/api-docs.js +0 -0
- /package/dist/{server → shared}/rbac/entity-scope.js +0 -0
- /package/dist/{server → shared}/rbac/filter.d.ts +0 -0
- /package/dist/{server → shared}/rbac/route-scope.d.ts +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
|
@@ -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 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{toJsonValue as t}from"../../../database/utils/json.js";import{createEntityLoader as n}from"../../../loaders/define.js";import{runtimeFile as r}from"../../utils/runtime-file.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{toJsonValue as t}from"../../../database/utils/json.js";import{createEntityLoader as n}from"../../../loaders/define.js";import{runtimeFile as r}from"../../utils/runtime-file.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{isObject as o}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as s}from"../../../../shared/utils/routes/normalize-route-slug.js";import{API_DOCS_INFO_BLOCK_DEP_KEY as c}from"../api-docs/server/shared.js";import{CATALOG_CLASSIC_DEP_KEY as l}from"../catalog-classic/client/contract.js";import{toPosixPath as u}from"../../../../shared/utils/to-posix-path.js";import{publicLink as d}from"../../../versions/public-link.js";import{createApiEntityKey as f}from"../../utils/api-entity-key.js";import{getLoadedProjectPlugins as p}from"../../project/loaded-set.js";import{API_OUTPUT_MANIFEST_KEY as m}from"../../../api-outputs.js";import{catalogEntityKey as h}from"../catalog-classic/entity-key.js";import{CATALOG_CARD_METADATA_ENTITY_TYPE as g}from"../catalog-classic/card-metadata.js";import{loadVersionGroups as _}from"../catalog-classic/resolve-items.js";import{NON_CONFORMANT as ee,apiPagePath as v,scorecardDetailsFile as y}from"./client/contract.js";import{findTarget as b,readScorecardSettings as x}from"./config.js";import{API_SCORECARD_ENTITY_TYPE as S,RULES_ENTITY_KEY as C,apiScorecardEntityKey as w,isScoredApi as T,scorecardPageEntityKey as E}from"./entities.js";import{collectRuleNames as te,lintApi as ne,resolveLevelConfigs as D,summarizeRules as O}from"./lint.js";import{gzip as k}from"../../../../shared/utils/gzip.js";import{join as A,posix as j,relative as M}from"node:path";import re from"picomatch";const N=`internal.scorecard-classic`,P=`scorecard-classic`,ie=i(N,`api`),ae=i(N,`rules`),oe=i(N,`page`),se=i(N,`card-metadata`),ce=i(N,`badge`),F=n(ie,async e=>{let t=e.file.path,n=e.args.source??t,r=e.routes.byFilePath(t),i=r&&e.routes.get(r.slug);if(!i)return{value:null,metadata:{sourcePath:t}};let a=async t=>({body:await e.createBlobRef(await k(new TextEncoder().encode(JSON.stringify(t))),{format:`binary`}),contentType:`application/gzip`}),o=x(e.config),s=J(e.contentDir),c=b(o.targets,i.metadata),l=b(o.targets.filter(e=>e.rules!==void 0),i.metadata),u=s.paths,d;try{let t=await D({contentDir:e.contentDir,settings:o,plugins:s.plugins,readFile:e.io.readFile});u=[...t.files,...s.paths];let r=l===void 0?void 0:t.targets[o.targets.indexOf(l)];d=await ne({contentDir:e.contentDir,filePath:n,source:await e.io.readFile(A(e.contentDir,n)),configs:Object.fromEntries(o.levels.map(e=>[e.name,r?.[e.name]??t.levels[e.name]]))})}catch(e){return{value:await a(null),metadata:{sourcePath:t},problems:[{code:`scorecard/lint-failed`,message:`The scorecard could not lint this API: ${e instanceof Error?e.message:String(e)}`,location:{filePath:t}}],entityDeps:Y([n,...u])}}let f={...L(o,d.levels,c?.minimumLevel),title:await I(e.entities,t)??j.basename(n),relativePath:t,levels:d.levels};i.version!==null&&(f.version=i.version);let{levels:p,...m}=f,h={...m,levels:Object.fromEntries(Object.entries(p).map(([e,{problems:t,...n}])=>[e,n])),rules:O(p),sourcePath:t,route:i.slug};return{value:await a(f),metadata:h,entityDeps:Y([n,...d.files,...u])}});async function I(e,t){let n=await e.load(f(t)).catch(()=>void 0),r=o(n)&&o(n.info)?n.info:{};return typeof r.title==`string`?r.title:void 0}function L(e,t,n){let r=e.levels.map(e=>e.name),i=r.findIndex(e=>t[e].errors>0),a=i===-1?r.length:i,o=n??r[0],s=r.indexOf(o),c=`HIGHEST`;return a-1<s?c=`BELOW_MINIMUM`:s<r.length-1&&(c=`MINIMUM`),{scorecardLevel:a===0?ee:r[a-1],scorecardLevelIdx:a,targetLevel:o,status:c}}async function R(e,t){let n=await e.get(t);return n!==null&&(n.status!==`ready`||!T(n.metadata))&&(await e.load(t).catch(()=>void 0),n=await e.get(t)),n!==null&&T(n.metadata)?n.metadata:null}async function z(e){let t=[];for(let n of await e.list({type:S})){let r=await R(e,n.key);r!==null&&t.push(r)}return t}function B({sourcePath:e,route:t,...n}){return n}const V=n(ae,async e=>{let t=x(e.config),{perLevel:n,all:r}=await D({contentDir:e.contentDir,settings:t,plugins:J(e.contentDir).plugins,readFile:e.io.readFile}).then(e=>te(e.levels),()=>({perLevel:{},all:[]}));return{value:{levelNames:t.levels.map(e=>e.name),rules:r,rulesPerLevel:n}}}),H=n(oe,async e=>{let t=await e.entities.load(h(e.args.catalogId)),n=await e.entities.load(C),r=(await z(e.entities)).flatMap(t=>{let n=e.routes.get(t.route);return n?[{route:n,api:t}]:[]}),{versionGroups:i,entityDeps:a}=await _(r,e),o=new Map(r.map(({route:e,api:t})=>[d(e,i),B(t)])),s=[];for(let e of t.items){let t=o.get(e.link);t!==void 0&&s.push({...e,metadata:{...e.metadata,scorecard:t,scorecardLevel:t.scorecardLevel}})}let c={...t,items:s,scorecard:{...n,teamMetadataProperty:x(e.config).teamMetadataProperty}},l=JSON.stringify(c);return{value:l.length>65536?await e.createBlobRef(l,{format:`json`}):c,entityDeps:a}}),U=n(se,async e=>({value:(await z(e.entities)).map(e=>({route:e.route,metadata:{scorecardStatus:e.status,scorecardLevel:e.scorecardLevel,scorecardLevelIdx:e.scorecardLevelIdx,scorecardLevels:G(e)}}))})),W=n(ce,async e=>{let t=await R(e.entities,w(e.args.file)),n=t&&e.routes.get(t.route);if(!t||!n)return{value:null};let{versionGroups:r,entityDeps:i}=await _([{route:n}],e),a=d(n,r),o=q(e.config);if(o.length===0)return{value:null};let s=o[0].slug;if(o.length>1){for(let{catalogId:t,slug:n}of o)if((await e.entities.load(h(t))).items.some(e=>e.link===a)){s=n;break}}return{value:{scorecardLevel:t.scorecardLevel,scorecardLevelIdx:t.scorecardLevelIdx,scorecardLevels:G(t),scoreCardSlug:v(K(s),a)},entityDeps:i}});function G(e){return Object.fromEntries(Object.entries(e.levels).map(([e,t])=>[e,{uniqueErrors:t.uniqueErrors,uniqueWarnings:t.uniqueWarnings}]))}function K(e){return j.join(s(e),`scorecard`)}function q(e){return Object.entries(e.catalogClassic??e.catalog??{}).map(([e,t])=>({catalogId:e,slug:String(t.slug)}))}function J(e){let t=p(e)?.lintPlugins??[];return{plugins:t,paths:t.map(t=>u(M(e,t.path))).filter(e=>e!==``&&!e.startsWith(`../`))}}function Y(e){return[...new Set(e)].map(e=>({kind:`file`,path:e}))}function X(e){let t=e=>typeof e==`string`||typeof e==`number`;return t(e.manifest.openapi)||t(e.manifest.swagger)}function Z(e){let t=e.manifest[m];return o(t)&&typeof t.root==`string`?t.root:e.path}function Q(e){let t=Z(e);return F.withArgs(t===e.path?{}:{source:t},{stableKey:w(e.path),type:S,metadata:{sourcePath:e.path}})}function $(e,t){if(!X(e))return!1;let n=(t.scorecardClassic??t.scorecard)?.ignore??[];return n.length===0||!re([...n])(Z(e))}function le(e,t){let n=e.filter(e=>e.status===`BELOW_MINIMUM`).map(e=>e.relativePath);if(n.length===0)return;let r=n.slice(0,15).map(e=>`\n - ${e}`),i=n.length-r.length,a=`Detected OpenAPI definitions with score below minimum level:${r.join(``)}${i>0?`\n ... and ${i} more`:``}`;t.config.platform?.ignoreLint??(t.config.scorecardClassic??t.config.scorecard)?.ignoreNonCompliant?t.logger.warn(a):t.logger.error(a)}const ue=e({id:N,version:`2.3.0`,content:{filter:{extensions:[`.yaml`,`.yml`,`.json`]},extractFile(e,t){return $(e,t.config)?{routes:[],entities:[Q(e)]}:null},extractAll(e){let t=e.config.catalogClassic??e.config.catalog??{};if(!e.files.some(X)&&Object.keys(t).length===0)return{routes:[]};let n=x(e.config),r=[V.withArgs({},{stableKey:C})];n.isDefault||r.push(U.withArgs({},{stableKey:`scorecard-classic:card-metadata`,type:g}));let i=[];for(let[e,n]of Object.entries(t)){let t=K(String(n.slug)),a=H.withArgs({catalogId:e},{stableKey:E(e),metadata:{sourcePath:t}});r.push(a),i.push({deps:{[l]:a},metadata:{title:typeof n.title==`string`?n.title:`API design scorecard`},routeId:e,slug:t,template:P,wildcardPrefix:!0})}return{entities:r,routes:i}}},finalize(e){let t=q(e.config).length>0&&!x(e.config).isDefault,n=[],r=[],i=[];for(let a of e.files){let o=$(a,e.config)?e.routes.byFilePath(a.path):void 0;if(o===void 0||(n.push({path:y(a.path),producer:Q(a),audience:{routeSlug:o.slug}}),!t))continue;let s=W.withArgs({file:a.path},{stableKey:`scorecard-classic:badge:${o.slug}`});r.push(s),i.push({slug:o.slug,deps:{[c]:s}})}return{entities:r,attach:i,staticFiles:n}},async buildMetadata(e){if(await e.entities.get(`scorecard-classic:rules`)===null)return;let n=await e.entities.load(C),r=await z(e.entities),i={};for(let e of r){let{rules:t,...n}=B(e);i[e.relativePath]=n}return le(r,e),{scorecardData:i,...n,reuniteIgnoreLint:t(e.config.platform?.ignoreLint)}},loaders:[F,V,H,U,W],templates:{[P]:a(r(`./client/template.tsx`,import.meta.url))}});export{N as SCORECARD_CLASSIC_PLUGIN_ID,P as SCORECARD_CLASSIC_TEMPLATE_ID,ue as scorecardClassicContentPlugin};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
|
|
2
|
-
import type { NAV_ITEM_RBAC, RbacScope } from '../../../../
|
|
2
|
+
import type { NAV_ITEM_RBAC, RbacScope } from '../../../../shared/rbac/types.js';
|
|
3
3
|
import type { Logger } from '../../../../shared/logger.js';
|
|
4
4
|
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
5
5
|
import type { ProblemDraft } from '../../../problems/types.js';
|
|
@@ -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=K(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 P({...i,entry:t,tabIndex:e}));L({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=I({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=K(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${G(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 D({...e,ref:t.$ref});if(typeof t.directory==`string`&&E(t)&&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 z({...e,directoryPath:r,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:T(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...X(t,e),label:t.separator,labelTranslationKey:J(t.separatorTranslationKey)}];let r=await V(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=J(t.group)??J(t.label)??(i===void 0?J(t.href):void 0)??r.anchor,s=E(t);return[{type:w(t,i,r.linksConnectedHeading===!0),...X(t,e),menuStyle:s?Z(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:T(t),link:r.link,isGroup:s?!0:void 0,version:J(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e,t,n){if(E(e)&&!n)return`group`;if(t!==void 0||e.href||e.label)return`link`}function T(e){return J(E(e)?e.groupTranslationKey:e.labelTranslationKey)}function E(e){return J(e.group)!==void 0}async function D(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)?O(e,r,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" must be a YAML sequence.`),[])}async function O(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 k(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?O({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(A)):[]}function A(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function j(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function M(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function N(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw M({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw M({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw M({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw M({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw M({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw M({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 M({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function P(e){let{entry:t}=e,n=t.tab;N({file:e.file,entry:t});let r=j(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 F({...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),...I({...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,...Q(t.icon,e),items:a}}async function F(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 S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function I(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function L(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}`},R({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},R({routes:e.routes,link:t.link,items:t.items}))}}function R(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 z(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)=>B(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 k(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}U(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({type:`link`,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({type:`group`,items:a,label:r}),i.set(n,a),t=a}return t}}function B(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function V(e,t){if(typeof e.page==`string`){let{path:n,suffix:r,anchor:a}=i(e.page.trim()),o=await H(n,t);if(!o)return{};let s=e.disconnect!==!0;return s&&U(o,t),{link:`${o.slug}${r}`,anchor:a,linksConnectedHeading:s&&a!==void 0,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 H(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 U(e,t){t.assignedRouteSlugs.add(e.slug)}async function W(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 G(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function K(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function q(e){if(!Array.isArray(e))return;let n=[];for(let r of e){if(!t(r))continue;let e=J(r.name),i=J(r.icon);(e!==void 0||i!==void 0)&&n.push({name:e??``,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(e,n){let r=t(e)?J(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=$(t.src,n);return{srcSet:l(e)}}let i=J(e);return i===void 0?{}:{icon:$(i,n)}}function $(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,W as stampDefaultVersions};
|
|
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{splitUrlSuffix as n}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolveContentPath as r}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as i}from"../assets/extensions.js";import{toNavItemRbacAnnotation as a}from"../../../../shared/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,n){let i=p.load(e);if(!Array.isArray(i))return[];let a=[],o=e=>{if(t(e)){if(typeof e.$ref==`string`){let t=r(e.$ref,n);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: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=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,n,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 P({...i,entry:t,tabIndex:e}));L({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=I({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=K(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${G(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 D({...e,ref:t.$ref});if(typeof t.directory==`string`&&E(t)&&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 n=r(t.directory,e.file.path);if(n===null)return h(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(n);i.length===0&&h(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await z({...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:T(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...X(t,e),label:t.separator,labelTranslationKey:J(t.separatorTranslationKey)}];let n=await V(t,e),i=n.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=J(t.group)??J(t.label)??(i===void 0?J(t.href):void 0)??n.anchor,s=E(t);return[{type:w(t,i,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:T(t),link:n.link,isGroup:s?!0:void 0,version:J(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e,t,n){if(E(e)&&!n)return`group`;if(t!==void 0||e.href||e.label)return`link`}function T(e){return J(E(e)?e.groupTranslationKey:e.labelTranslationKey)}function E(e){return J(e.group)!==void 0}async function D(e){let{ref:t}=e,n=r(t,e.file.path);if(n===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(n))return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" includes itself.`),[];let i;try{i=await e.readFile(n)}catch{return h(e,`sidebar/missing-target`,`Sidebar $ref "${n}" could not be read.`),[]}let a=p.load(i);return Array.isArray(a)?O(e,n,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" must be a YAML sequence.`),[])}async function O(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 k(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?O({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(A)):[]}function A(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function j(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function M(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function N(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw M({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw M({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw M({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw M({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw M({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw M({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 M({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function P(e){let{entry:t}=e,n=t.tab;N({file:e.file,entry:t});let r=j(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 F({...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),...I({...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,...Q(t.icon,e),items:a}}async function F(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 S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function I(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function L(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}`},R({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},R({routes:e.routes,link:t.link,items:t.items}))}}function R(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 z(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)=>B(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 k(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}U(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({type:`link`,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({type:`group`,items:a,label:r}),i.set(n,a),t=a}return t}}function B(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function V(e,t){if(typeof e.page==`string`){let{path:r,suffix:i,anchor:a}=n(e.page.trim()),o=await H(r,t);if(!o)return{};let s=e.disconnect!==!0;return s&&U(o,t),{link:`${o.slug}${i}`,anchor:a,linksConnectedHeading:s&&a!==void 0,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 H(e,t){let n=o(e,t.file.path,t.routes);if(n.kind===`escaped`){h(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)&&h(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return n.value}function U(e,t){t.assignedRouteSlugs.add(e.slug)}async function W(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 G(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function K(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function q(e){if(!Array.isArray(e))return;let n=[];for(let r of e){if(!t(r))continue;let e=J(r.name),i=J(r.icon);(e!==void 0||i!==void 0)&&n.push({name:e??``,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(e,n){let r=t(e)?J(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=$(t.src,n);return{srcSet:l(e)}}let i=J(e);return i===void 0?{}:{icon:$(i,n)}}function $(e,t){if(!i(e))return e;let n=r(e,t.file.path);return n===null?(h(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${n}`}export{b as bundleSidebar,x as bundleSidebarEntries,_ as collectSidebarLinkRefs,g as collectSidebarRefTargets,W as stampDefaultVersions};
|
|
@@ -1,7 +1,7 @@
|
|
|
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
5
|
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
6
6
|
import { SIDEBAR_ROUTE_DEP_KEY } from '../../../../shared/constants/route-deps.js';
|
|
7
7
|
export declare const SIDEBAR_PLUGIN_ID = "internal.sidebar";
|
|
@@ -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.24.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"../../../../shared/constants/l10n/defaults.js";import{compareStrings as i}from"../../../../shared/utils/compare-strings.js";import{isObject as a}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as o}from"../../../../shared/utils/l10n.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as s,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as c,SIDEBAR_ROUTE_DEP_KEY as l,localizedSidebarDepKey as ee}from"../../../../shared/constants/route-deps.js";import{toPublicVersionedSlug as u}from"../../../../shared/constants/versions.js";import{splitUrlSuffix as d}from"../../../../shared/utils/routes/split-url-suffix.js";import{NAV_ITEM_RBAC as f}from"../../../../shared/rbac/types.js";import{resolveContentPath as p}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as m}from"../assets/extensions.js";import{resolvePageTarget as h}from"../../../../shared/utils/routes/resolve-page-target.js";import{collectVersionGroups as g,findVersionedDirectories as _}from"../../../versions/version-groups.js";import{publicLink as v}from"../../../versions/public-link.js";import{linkedPageAccess as y}from"../../utils/link-access.js";import{safeDecodeURI as b}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as x,parseSrcSet as S}from"../assets/srcset.js";import{bundleSidebar as C,bundleSidebarEntries as te,collectSidebarLinkRefs as w,collectSidebarRefTargets as ne,stampDefaultVersions as re}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as T,sidebarStartEntityKey as E}from"./contributions.js";import{applySubtree as D}from"./subtree.js";import{collectSlugOverrides as O}from"../../utils/slug-overrides.js";import{SITE_START_ENTITY_KEY as ie}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$/i,P=/(^|\/)sidebars\.ya?ml$/i,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,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,i=e?await t.loadEntity(e):void 0,a=r.tabId!==void 0,o=a?{...r,isGroup:!0,label:r.label??R(i)}:r,s=i===void 0?[o]:D(o,i);for(let e of s){let i=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],o=e[A]??(i===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 H(e.srcSet,t),items:e.items?await V(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await V(e.menu,t):void 0,label:a?e.label??B(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?u(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,[A]:o,[f]:i})}}return n}async function H(e,t){let n=S(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 x(r)}function U(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!m(r))return r;let i=await e.resolveImageReference(r,``),a=p(b(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 W(e){return e.tabId!==void 0}function G(e){return W(e)&&e.link!==void 0}function K(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[A]:e[A],[f]:e[f]}}function q(e){return{...K(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function J(e){return{...K(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(G).map(q)}}const Y=t(M,async e=>{let t=U(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,s=i.length===0?/* @__PURE__ */ new Map:await g({io:e.io,routes:e.routes,versionedDirectories:i}),c=await V(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??o(e,n)))??a(e),accessOf:t=>y(t,e.routes,s),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(W).map(J)}:c,...t.collected()}});async function ae(e){let t=await e.loadEntity(e.subtreeKey);return V(D({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function oe(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(D({link:r},await t.entities.load(i)))}return n}function se(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 ce(e){let t=[];for(let n of await e.list({type:T}))t.push(...await e.load(n.key));return t}function le(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 ue(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=de(e,t,n);return r===null?null:{item:e,link:r.link,label:await fe(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=p(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 de(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}=d(e.page.trim()),o=h(r,I,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${v(s,n)}${i}`,anchor:a,route:s}}async function fe(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 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?u(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&&P.test(e))??t).link}function he(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 ge=e({id:j,version:`1.24.0`,content:{filter:{match:e=>N.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await w({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,u=[],f=/* @__PURE__ */ new Map,p=/* @__PURE__ */ new Map,m=[],h=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),v=e.routes.all(),b=O(v,e.localeContext),x=_(v),S=x.length>0?x:void 0;h.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let w=new Map(h.map(({path:e,source:t})=>[e,t])),T=/* @__PURE__ */ new Map;for(let{path:e}of h)P.test(e)&&T.set(k.dirname(e),e);let D=/* @__PURE__ */ new Set;for(let{path:e,source:t}of h)for(let n of ne(t,e))D.add(n);let j={routes:e.routes,report:e=>r.push(e),readFile:async t=>w.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:T},M=async(n,r)=>{if(n.nodes.length===0)return;await re({io:e.io,routes:e.routes,logger:e.logger,nodes:n.nodes,versionedDirectories:x});let i=Y.withArgs({nodes:n.nodes,versionedDirectories:S},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),p.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:b[r]??{},versionedDirectories:S});t.push(e),a.set(r,e)}return f.set(i,a),i};for(let{path:t,source:n}of h){if(D.has(t))continue;let s=await C({...j,file:{path:t},source:n}),c=await M(s,t);if(c===void 0)continue;a.set(t,c);let l=t.startsWith(`@l10n/`)?null:$(s.nodes);l!==null&&m.push({path:t,link:l}),u.push(await Z(s,e));for(let e of s.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,c),o.set(e,t)}}se(i,u);let N=new Map(v.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=N.get(t);if(e===void 0||e.originFilePath===null)continue;let o=oe(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 I=await ce(e.entities),L=/* @__PURE__ */ new Set,R=/* @__PURE__ */ new Map,z=/* @__PURE__ */ new Map;for(let t of I){let n=i.get(t.route);if(n===void 0){let r=await te({...j,file:{path:F},entries:t.entries});if(n=await M(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),L.add(e))}let r=R.get(n);R.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=z.get(n);z.set(n,a===void 0?t.breadcrumbs??[]:le(a,t.breadcrumbs))}if(h.length===0&&v.length>0){let e=await C({...j,file:{path:F},source:`- directory: .
|
|
2
|
+
`,skipRoutes:L}),t=await M(e);if(t!==void 0){for(let n of e.assignedRouteSlugs)i.has(n)||i.set(n,t);let n=$(e.nodes);n!==null&&m.push({path:F,link:n})}}let B=me(m)??he(v);if(B!==null){let{path:e}=d(B);t.push(n(e,{stableKey:ie}))}let V=/* @__PURE__ */ new Map;for(let e of v){if(e.originFilePath===null)continue;let t=X(e);V.set(t,[...V.get(t)??[],e.slug])}for(let[e,t]of[...i]){let n=N.get(e);for(let e of(n&&V.get(X(n)))??[])i.has(e)||i.set(e,t)}let H=/* @__PURE__ */ new Map,U=(e.config.navbar?.items??[]).filter(e=>e.linkedSidebars?.length),W=/* @__PURE__ */ new Map,G=z.size===0&&U.length===0||S===void 0?/* @__PURE__ */ new Map:await g({io:e.io,routes:e.routes,versionedDirectories:S});for(let[t,n]of await ue(U,e.routes,G,a,t=>e.entities.load(t)))z.set(t,[n,...z.get(t)??[]]);let K=({label:t,link:n,icon:r})=>({label:t,link:n,icon:r,[A]:y(n,e.routes,G)??void 0});for(let[e,r]of R){if(r===null)continue;let i=n(K(r));t.push(i),H.set(e,i)}for(let[e,r]of z){if(r.length===0)continue;let i=n(r.map(K));t.push(i),W.set(e,i)}for(let r of new Set(I.map(e=>e.route))){let a=i.get(r),o=a===void 0?void 0:p.get(a),s=o===void 0?null:pe(o,e.routes.bySlug(r)?.version??null);s!==null&&t.push(n(s,{stableKey:E(r)}))}return{entities:t,attach:[...i.entries()].map(([e,t])=>{let n={[l]:t},r=H.get(t);r!==void 0&&(n[s]=r);let i=W.get(t);if(i!==void 0&&(n[c]=i),N.get(e)?.locale===``)for(let[e,r]of f.get(t)??[])n[ee(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,l as SIDEBAR_ROUTE_DEP_KEY,L as isTabbedSidebar,ae as resolveAutoSidebar,ge as sidebarContentPlugin};
|
|
@@ -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{AGENT_SKILLS_BASE as i,SKILLS_FOLDER as a,SKILLS_INDEX_SLUG as o,SKILL_FILENAME as s}from"../../utils/skill-paths.js";import{compileContentGlob as c}from"../../utils/glob.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=`${i}/:slug/${s}`,m=s.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=[],o=/* @__PURE__ */ new Map;for(let[e,c]of n){let n=c.includes(`SKILL.md`)?s:c[0];c.length>1&&t.warn(`Multiple skill files in "${a}/${e}" differ only by case; using "${n}".`);let l=r(e),u=o.get(l);if(u!==void 0){t.warn(`Skipping skill folder "${a}/${e}": its slug "${l}" collides with the folder "${u}" after slugification.`);continue}o.set(l,e),i.push({slug:l,sourcePath:`${a}/${e}/${n}`})}return i}const _=e({id:f,version:`1.3.0`,server:{routes:[{method:`GET`,path:o,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??[]],i=r.length>0?c(r):()=>!1,a=process.env.PROJECT_SLUG||`project-docs`,o=g(e.files,e.logger);e.files.some(e=>e.path===`SKILL.md`)&&o.push({slug:a,sourcePath:s});let f=/* @__PURE__ */ new Map,p=/* @__PURE__ */ new Map,m=n(e.config,`rbac`);for(let n of o){if(i(n.sourcePath))continue;let r=await e.io.readFile(n.sourcePath),a=d(n.sourcePath,r);if(`error`in a){e.logger.warn(a.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:a.title,description:a.description,sourcePath:n.sourcePath};`rbac`in a&&m&&(s.rbac=a.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};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{hashString as e}from"../../../../database/utils/json.js";import{withPathPrefix as t}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SCHEMA_URL as n,skillMarkdownPath as r}from"../../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as i,skillEntityKey as a}from"../../../types/skill-entity.js";import{isEntityScopeVisible as o}from"../../../../../
|
|
1
|
+
import{hashString as e}from"../../../../database/utils/json.js";import{withPathPrefix as t}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SCHEMA_URL as n,skillMarkdownPath as r}from"../../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as i,skillEntityKey as a}from"../../../types/skill-entity.js";import{isEntityScopeVisible as o}from"../../../../../shared/rbac/entity-scope.js";import{notFoundResponse as s}from"../../../../../server/plugin-context.js";import{publicOrigin as c}from"../../../utils/request-origin.js";const l={"Cache-Control":`no-store`,"Access-Control-Allow-Origin":`*`};function u(e){return e.config.skills?.hide===!0}async function d(a,d){if(u(d))return s();let f=c(d.request),p=await d.entities.list({type:i}),m=await Promise.all(p.map(async n=>{let{slug:i,title:a,description:s}=n.metadata??{};if(typeof i!=`string`||!o(n,d.request.teams,e=>d.logger?.warn(e)))return[];let{content:c}=await d.entities.load(n.key);return[{name:a??i,type:`skill-md`,description:s??``,url:`${f}${t(r(i))}`,digest:`sha256:${e(c)}`}]}));return a.json({$schema:n,skills:m.flat()},200,l)}async function f(e,t){if(u(t))return s();let n=e.req.param(`slug`)??``,r=a(n),i=await t.entities.get(r);if(!i||!o(i,t.request.teams,e=>t.logger?.warn(e)))return s();let{content:c}=await t.entities.load(r);return e.body(c,200,{"Content-Type":`text/markdown; charset=utf-8`,...l})}export{f as skillMarkdown,d as skillsIndex};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{
|
|
2
|
-
`)}function x(e){return/* @__PURE__ */ Error(`Failed to load project plugins:\n${b(e)}`)}function S(e){return(e.plugins??[]).map(e=>e.trim()).filter(e=>e!==``)}function C(e,t){let n=Object.keys(t).find(t=>e===t||e.startsWith(`${t}/`));return n===void 0?void 0:t[n]}function w(e){let t=Object.keys(c).find(t=>e===t||e===`${t}/plugin.js`);return t===void 0?void 0:c[t]}async function T(e,t,n){if(h(e)){if(await n.exists(e))return e;let r=_(t,e.replace(/^[/\\]+/,``));return await n.exists(r)?r:null}if(e.startsWith(`./`)||e.startsWith(`../`)){let r=_(t,e);return await n.exists(r)?r:null}if(e.includes(`/`)){let r=_(t,e);if(await n.exists(r))return r}return E(e,t)}function E(e,t){try{return d(import.meta.url).resolve(e,{paths:[t,m(f(import.meta.url))]})}catch{return null}}async function D(
|
|
1
|
+
import{isPlanFeatureGranted as e}from"../../../shared/plan-gates.js";import{isObject as t}from"../../../shared/utils/is-object.js";import{hashContentBytes as n}from"../../../shared/utils/content-hash.js";import{createNodePlatformFs as r}from"../../../platform/node/fs.js";import{loadRedoclyConfig as i}from"../../config.js";import{BUILT_IN_CLASSIC_PLUGINS as a,DEFAULT_PROJECT_PLUGIN_FILES as o,INTERNAL_PLUGIN_ID_PREFIX as s,PLAN_GATED_PLUGINS as c}from"./constants.js";import{setLoadedProjectPlugins as l}from"./loaded-set.js";import{createInternalContentPlugins as u}from"../internal/index.js";import{createRequire as d}from"node:module";import{fileURLToPath as f,pathToFileURL as p}from"node:url";import{dirname as m,isAbsolute as h,join as g,resolve as _}from"node:path";async function v(t,n={}){let s=_(t),c=n.fs??r(),{config:l}=await i(s,c),d=[],f=S(l),p=[];for(let e of f){let t=C(e,a);if(t!==void 0){n.logger?.warn(`Project plugin "${e}" is skipped: ${t} are built in. Remove it from \`plugins\` in redocly.yaml.`);continue}let r=w(e),i=r===void 0?await T(e,s,c):E(e,s);if(i===null){d.push({entry:e,message:`Cannot resolve the plugin module from the project root, its node_modules or the Realm Plus installation.`});continue}p.some(e=>e.path===i)||p.push({entry:e,path:i,feature:r??`customPlugins`})}for(let e of o){let t=g(s,e);if(await c.exists(t)){p.some(e=>e.path===t)||p.push({entry:e,path:t,feature:`customPlugins`});break}}let m=[],h=[],v=new Set(u().map(e=>e.id));for(let{entry:t,path:r,feature:i}of p){let a=await D({entry:t,path:r,contentDir:s,config:l,fs:c});if(`lintPlugin`in a){h.push({entry:t,path:r,plugin:a.lintPlugin});continue}if(`message`in a){d.push(a);continue}if(!e(l,i)){n.logger?.warn(`Project plugin "${t}" is skipped: \`${i}\` is not in this project's plan.`);continue}if(v.has(a.plugin.id)){d.push({entry:t,path:r,message:`Plugin id "${a.plugin.id}" is already registered by another plugin.`});continue}v.add(a.plugin.id),m.push(a)}for(let e of d)n.logger?.error(`Project plugin "${e.entry}": ${e.message}`);return{plugins:m,lintPlugins:h,paths:p.map(e=>e.path),entries:f,diagnostics:d}}async function y(e,t={}){let n=await v(e,t);return l(e,n),n}function b(e){return e.map(e=>`- ${e.entry}${e.path?` (${e.path})`:``}: ${e.message}`).join(`
|
|
2
|
+
`)}function x(e){return/* @__PURE__ */ Error(`Failed to load project plugins:\n${b(e)}`)}function S(e){return(e.plugins??[]).map(e=>e.trim()).filter(e=>e!==``)}function C(e,t){let n=Object.keys(t).find(t=>e===t||e.startsWith(`${t}/`));return n===void 0?void 0:t[n]}function w(e){let t=Object.keys(c).find(t=>e===t||e===`${t}/plugin.js`);return t===void 0?void 0:c[t]}async function T(e,t,n){if(h(e)){if(await n.exists(e))return e;let r=_(t,e.replace(/^[/\\]+/,``));return await n.exists(r)?r:null}if(e.startsWith(`./`)||e.startsWith(`../`)){let r=_(t,e);return await n.exists(r)?r:null}if(e.includes(`/`)){let r=_(t,e);if(await n.exists(r))return r}return E(e,t)}function E(e,t){try{return d(import.meta.url).resolve(e,{paths:[t,m(f(import.meta.url))]})}catch{return null}}async function D(e){let{entry:t,path:r}=e,i=await n(await e.fs.readBinaryFile(r)),a=p(r);a.searchParams.set(`v`,i),delete d(r).cache[r];let o;try{o=await import(a.href)}catch(e){return{entry:t,path:r,message:`Cannot import the plugin module: ${M(e)}`}}let s=O(o);if(s===void 0)return{entry:t,path:r,message:`The module has no default export.`};let c=s,l=i;if(typeof s==`function`){l+=`+${await n(new TextEncoder().encode(JSON.stringify(e.config)))}`;try{c=await s({engine:`realm-plus`,contentDir:e.contentDir,config:e.config})}catch(e){return{entry:t,path:r,message:`The plugin factory threw: ${M(e)}`}}}if(A(c))return{lintPlugin:c};let u=j(c);if(u!==null)return{entry:t,path:r,message:u};let f=c;return{entry:t,path:r,plugin:{...f,version:`${f.version}+${l}`}}}function O(e){if(!t(e))return;let n=e.default;return t(n)&&!(`id`in n)&&`default`in n?n.default:n}const k=[`rules`,`preprocessors`,`decorators`,`configs`,`assertions`];function A(e){return t(e)&&typeof e.processContent!=`function`&&typeof e.afterRoutesCreated!=`function`&&e.version===void 0&&k.some(t=>t in e)}function j(e){return t(e)?typeof e.processContent==`function`||typeof e.afterRoutesCreated==`function`?`This is a legacy Realm lifecycle plugin (processContent/afterRoutesCreated). Realm Plus loads content plugins; see docs/guides/authoring-plugins.md.`:typeof e.id!=`string`||e.id.trim()===``?"The plugin needs a non-empty string `id`.":e.id.startsWith(`internal.`)?`The plugin id prefix "${s}" is reserved for built-in plugins.`:typeof e.version!=`string`||e.version.trim()===``?"The plugin needs a non-empty string `version`.":null:`The default export must be a plugin object or a factory that returns one.`}function M(e){return e instanceof Error?e.message:String(e)}export{x as createProjectPluginLoadError,b as formatProjectPluginDiagnostics,y as loadAndRegisterProjectPlugins,v as loadProjectPlugins,S as readPluginEntries,T as resolveProjectPluginPath};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{resolveRuntimeFilePath as e}from"./utils/runtime-file.js";import{resolveServerModuleReference as t}from"./server-fn.js";import{normalizeRouteSlug as n}from"../../shared/utils/routes/normalize-route-slug.js";import{ENGINE_ROUTE_PREFIXES as r,SYSTEM_ROUTES as i}from"../../
|
|
1
|
+
import{resolveRuntimeFilePath as e}from"./utils/runtime-file.js";import{resolveServerModuleReference as t}from"./server-fn.js";import{normalizeRouteSlug as n}from"../../shared/utils/routes/normalize-route-slug.js";import{ENGINE_ROUTE_PREFIXES as r,SYSTEM_ROUTES as i}from"../../shared/constants/system-routes.js";import{contentIgnoreMatcherOf as a}from"../ingest/scan.js";import{isStaticFolderPath as o}from"./internal/static-folder/index.js";import{collectEntityLoaders as s}from"../loaders/registry.js";import{resolve as c}from"node:path";const l=/^[a-zA-Z0-9_-]{1,64}$/;function u(e,t){let r=/* @__PURE__ */ new Map;for(let t of e){if(r.has(t.id))throw Error(`Duplicate content plugin id: ${t.id}`);r.set(t.id,t)}let i=f(r.values()),a=p(r.values()),o=m(r.values(),t),c=s(r.values()),l=_(r.values()),u=new Map(i.map(e=>[e.definition.id,e])),h=new Map(c.map(e=>[e.definition.id,e]));return{getById(e){return r.get(e)},getServerFnById(e){return u.get(e)},getEntityLoaderById(e){return h.get(e)},getEntityLoadersForPlugin(e){return c.filter(t=>t.pluginId===e)},list(){return[...r.values()]},listServerFns(){return[...i]},listServerRoutes(){return[...a]},listMcpTools(){return[...o.values()]},listReservedSlugs(){let e=/* @__PURE__ */ new Map;for(let t of a){if(/[:*]/.test(t.path))continue;let r=n(t.path);e.has(r)||e.set(r,t.plugin.id)}return e},listEntityLoaders(){return[...c]},listTemplates(){return[...l]},listFinalizePlugins(){return[...r.values()].filter(e=>e.finalize!==void 0)},listExtractAllPlugins(){return[...r.values()].filter(e=>e.content?.extractAll!==void 0)},listBuildMetadataPlugins(){return[...r.values()].filter(e=>e.buildMetadata!==void 0)},resolveAllForFile(e){return[...r.values()].filter(t=>d(t.content?.filter,e))}}}function d(e,t){return!e?.isStaticFolder&&o(t)?!1:e?.extensions?.some(e=>t.toLowerCase().endsWith(e.toLowerCase()))?!0:e?.match?.(t)??!1}function f(e){let t=[],n=/* @__PURE__ */ new Map;for(let r of e)for(let e of r.server?.functions??[]){let i=n.get(e.id);if(i!==void 0)throw Error(`Duplicate server function id "${e.id}" (plugins: ${i}, ${r.id})`);n.set(e.id,r.id),t.push({definition:e,pluginId:r.id})}return t}function p(e){let n=[],r=/* @__PURE__ */ new Map;for(let i of e)for(let e of i.server?.routes??[]){g(e,i.id);let a=r.get(e.path)??/* @__PURE__ */ new Set;for(let t of h(e.method)){if(a.has(t)||a.has(`ALL`)||t===`ALL`&&a.size>0)throw Error(`Plugin "${i.id}" server route ${t} ${e.path} is already declared by another plugin.`);a.add(t)}r.set(e.path,a),n.push({...e,handler:t(e.handler),plugin:{id:i.id,version:i.version}})}return n}function m(e,n){let r=/* @__PURE__ */ new Map;for(let i of e)for(let e of i.mcp?.tools??[]){if(!l.test(e.name))throw Error(`Plugin "${i.id}" declares an MCP tool with an invalid name "${e.name}". A name must match ${l.source}.`);let a=r.get(e.name);a&&n?.warn(`Plugin "${i.id}" MCP tool "${e.name}" overrides the one from "${a.plugin.id}".`),r.set(e.name,{declaration:e,handler:t(e.handler),plugin:{id:i.id,version:i.version}})}return r}function h(e){return e===void 0?[]:(typeof e==`string`?[e]:[...e]).map(e=>e.toUpperCase())}function g(e,t){let{path:a}=e,o=n(a);if(i.includes(o)||e.method!==void 0&&/^\/[:*]/.test(o)||r.some(e=>o===e||o.startsWith(`${e}/`)))throw Error(`Plugin "${t}" server route "${a}" collides with an engine-served path.`)}function _(e){let t=[],n=/* @__PURE__ */ new Set;for(let r of e){let e=r.templates??{};for(let[i,a]of Object.entries(e)){if(n.has(i))throw Error(`Duplicate template id "${i}" (plugin: ${r.id})`);n.add(i),t.push({filePath:v(a),pluginId:r.id,templateId:i})}}return t}function v(t){return y(t)?t.kind===`runtime`?e(t.filePath):c(t.filePath):e(t)}function y(e){return typeof e==`object`&&!(e instanceof URL)&&`kind`in e}function b(e,t){return a(e.config)(t)?[]:e.pluginRegistry.resolveAllForFile(t)}export{l as MCP_TOOL_NAME_PATTERN,u as createContentPluginRegistry,d as matchesContentPluginFilter,b as resolveContentPluginsForFile};
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Context, Next } from 'hono';
|
|
2
|
+
import type { RbacRole } from '../../shared/rbac/types.js';
|
|
2
3
|
import type { RealmConfig } from '../../shared/types/config.js';
|
|
3
4
|
import type { Logger } from '../../shared/logger.js';
|
|
4
5
|
import type { Viewer } from '../../shared/types/auth.js';
|
|
@@ -69,6 +70,8 @@ export type ServerRouteContext = {
|
|
|
69
70
|
/** Whether a page is served at `slug`, including the versionless URL of a default version in any locale. */
|
|
70
71
|
hasRoute(slug: string): Promise<boolean>;
|
|
71
72
|
isSlugVisible(slug: string, options?: SlugVisibilityOptions): boolean;
|
|
73
|
+
/** The viewer's role on the page at `slug`: `none` for a hidden or missing page, `read` everywhere without `access.rbac`. */
|
|
74
|
+
roleForSlug(slug: string): RbacRole;
|
|
72
75
|
/** Runtime key-value store, namespaced to this plugin; shared by every request and process. */
|
|
73
76
|
kv: KvService;
|
|
74
77
|
logger?: Logger;
|
|
@@ -92,6 +95,8 @@ export type ServerRouteHandler = (c: Context, ctx: ServerRouteContext) => Respon
|
|
|
92
95
|
export type ServerMiddlewareHandler = (c: Context, next: Next, ctx: ServerRouteContext) => Promise<Response | void> | Response | void;
|
|
93
96
|
/** The plugin request context plus the host seams only built-in plugins read; not part of `framework/plugin`. */
|
|
94
97
|
export type BuiltinRouteContext = Omit<ServerRouteContext, 'withViewer'> & {
|
|
98
|
+
/** The host's auth key seed for the MCP gateway secret store; absent when the host has none. */
|
|
99
|
+
gatewaySecretSeed?: string;
|
|
95
100
|
loadContentModule?: (sourcePath: string) => Promise<Record<string, unknown>>;
|
|
96
101
|
mcpToolEntries?: readonly ContentPluginMcpToolEntry[];
|
|
97
102
|
withViewer(viewer: Viewer): Promise<BuiltinRouteContext>;
|
|
@@ -1,15 +1,11 @@
|
|
|
1
|
+
import type { ApiSpecType } from '../../../shared/constants/api-spec-kinds.js';
|
|
1
2
|
import type { JsonObject, JsonValue } from '../../database/schema.js';
|
|
3
|
+
export { SPEC_KIND_ARAZZO, SPEC_KIND_ASYNCAPI, SPEC_KIND_GRAPHQL, SPEC_KIND_OPENAPI, type ApiSpecType, } from '../../../shared/constants/api-spec-kinds.js';
|
|
2
4
|
/**
|
|
3
5
|
* The well-known `api` entity: one per spec, value = the canonical bundled spec (blob when
|
|
4
6
|
* large; SDL for graphql). Every non-render consumer reads it, never the source filesystem.
|
|
5
7
|
*/
|
|
6
8
|
export declare const API_ENTITY_TYPE = "api";
|
|
7
|
-
export declare const SPEC_KIND_OPENAPI = "openapi";
|
|
8
|
-
export declare const SPEC_KIND_ASYNCAPI = "asyncapi";
|
|
9
|
-
export declare const SPEC_KIND_GRAPHQL = "graphql";
|
|
10
|
-
export declare const SPEC_KIND_ARAZZO = "arazzo";
|
|
11
|
-
/** An Arazzo description has no page: only `/_bundle` serves it. */
|
|
12
|
-
export type ApiSpecType = typeof SPEC_KIND_OPENAPI | typeof SPEC_KIND_ASYNCAPI | typeof SPEC_KIND_GRAPHQL | typeof SPEC_KIND_ARAZZO;
|
|
13
9
|
/** `/_mock<routeSlug>/*` serves an openapi api's stateless mock (`plugins/internal/mock`). */
|
|
14
10
|
export declare const MOCK_SERVER_ROUTE_PREFIX = "/_mock";
|
|
15
11
|
/** The `/_mock` path under which an api at `routeSlug` is mocked (`''` for a root-mounted spec). */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
import{SPEC_KIND_ARAZZO as e,SPEC_KIND_ASYNCAPI as t,SPEC_KIND_GRAPHQL as n,SPEC_KIND_OPENAPI as r}from"../../../shared/constants/api-spec-kinds.js";const i=`/_mock`;function a(e){return e===`/`?``:e}export{i as MOCK_SERVER_ROUTE_PREFIX,e as SPEC_KIND_ARAZZO,t as SPEC_KIND_ASYNCAPI,n as SPEC_KIND_GRAPHQL,r as SPEC_KIND_OPENAPI,a as mockPathPrefix};
|
|
@@ -13,6 +13,7 @@ import type { EntityStore } from '../../database/entity-store.js';
|
|
|
13
13
|
import type { SearchHandle } from '../../search/store.js';
|
|
14
14
|
import type { DataRefMarker } from '../../materialization/data-ref.js';
|
|
15
15
|
import type { ProblemDraft } from '../../problems/types.js';
|
|
16
|
+
import type { ConfigSchema } from '../../config-schema.js';
|
|
16
17
|
export type ContentPluginMetadata = {
|
|
17
18
|
id: string;
|
|
18
19
|
version: string;
|
|
@@ -160,6 +161,13 @@ export type ContentPluginMcp = {
|
|
|
160
161
|
export type ContentPlugin = {
|
|
161
162
|
id: string;
|
|
162
163
|
version: string;
|
|
164
|
+
/**
|
|
165
|
+
* The schema of the plugin's options, the `redocly.yaml` root key named by its `id`, checked
|
|
166
|
+
* with the rest of the config: a setting it rejects is removed and is a `configuration/invalid`
|
|
167
|
+
* error, and an unknown key stays and is a `configuration/ignored` warning. A built-in root
|
|
168
|
+
* key with the same name wins.
|
|
169
|
+
*/
|
|
170
|
+
configSchema?: ConfigSchema;
|
|
163
171
|
content?: ContentPluginContent;
|
|
164
172
|
/** Run after route slugs are final. */
|
|
165
173
|
finalize?(ctx: FinalizeContext): Promise<FinalizeResult> | FinalizeResult;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { RbacScope } from '../../../
|
|
1
|
+
import type { RbacScope } from '../../../shared/rbac/types.js';
|
|
2
2
|
import type { ProblemDraft } from '../../problems/types.js';
|
|
3
3
|
/** A label rendered next to a hit (mirrors the theme's `ItemBadge`). */
|
|
4
4
|
export type SearchDocumentBadge = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{toPhysicalVersionedSlug as e}from"../../../shared/constants/versions.js";import{splitUrlSuffix as t}from"../../../shared/utils/routes/split-url-suffix.js";function n(e,n,i){if(!e.startsWith(`/`))return;let{path:a}=t(e),o=n.getAccess(a);if(o!==void 0)return o;let s=r(a,i);return s===null?void 0:n.getAccess(s)}function r(t,n){let r=[...n].sort(([e],[t])=>t.length-e.length);for(let[n,i]of r){if(!i.defaultVersion)continue;let r=e(t,n,i.defaultVersion);if(r!==null&&r!==t)return r}return null}export{n as linkedPageAccess};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { RealmConfig } from '../../../shared/types/config.js';
|
|
2
|
-
import type { RbacScope } from '../../../
|
|
2
|
+
import type { RbacScope } from '../../../shared/rbac/types.js';
|
|
3
3
|
import type { JsonObject, JsonValue } from '../../database/schema.js';
|
|
4
4
|
import type { ContentStateView } from '../../database/types/content-state.js';
|
|
5
5
|
/** The identity facts of one route, as every route query returns them. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{hashJsonValue as e,toStableJsonString as t}from"../../database/utils/json.js";import{
|
|
1
|
+
import{hashJsonValue as e,toStableJsonString as t}from"../../database/utils/json.js";import{compareStrings as n}from"../../../shared/utils/compare-strings.js";import{compileRouteAccessMatcher as r}from"../../../shared/rbac/engine.js";import{computePathPrefixes as i}from"../../../shared/utils/routes/compute-path-prefixes.js";import{normalizeRoutePath as a}from"../../../shared/utils/routes/normalize-route-path.js";import{resolveRouteScope as o}from"../../../shared/rbac/route-scope.js";import{hashEntityListMembership as s,hashEntityRead as c}from"../../database/entity-store.js";import{getRouteByFilePath as l,getRouteBySlug as u,getRoutesInDirectory as d}from"./state-lookup.js";function f(e,t){let f=r(t),m=e=>f===null?null:o(f,{hasRbacKey:`rbac`in e.metadata,rbacValue:e.metadata.rbac,slug:e.slug,sourcePath:e.originFilePath},()=>{})??{},h=e=>{let t=[];for(let n of e)t.push(v(n));return t.sort((e,t)=>n(e.slug,t.slug))};function*g(t){for(let n of e.routeBySlug.values())!n.isFallback&&(t===void 0||t(n))&&(yield n)}let y=e=>e!==void 0&&!e.isFallback?e:void 0,b=t=>{let n=a(t),r=y(u(e,n));if(r)return r;let o=i(n),s;for(let e of g(e=>e.wildcardPrefix&&o.includes(e.slug)))(s===void 0||e.slug.length>s.slug.length)&&(s=e);return s};function x(t,r){switch(t){case`byFilePath`:{let t=l(e,r);return _(t?v(t):void 0)}case`bySlug`:{let t=y(u(e,r));return _(t?v(t):void 0)}case`inDirectory`:return _(h(d(e,r)));case`all`:return _(h(g()));case`get`:{let t=y(u(e,r));return _(t?{...v(t),metadata:t.metadata,access:m(t)}:void 0)}case`getAccess`:{let e=b(r);return _(e?m(e):void 0)}case`list`:{let{sidebarKey:e}=JSON.parse(r);return _(h(g(t=>t.sidebarSubtreeEntityKey===e)))}case`metadata`:{let e={};for(let t of[...g()].sort((e,t)=>n(e.slug,t.slug)))Object.hasOwn(t.metadata,r)&&(e[t.slug]=t.metadata[r]);return _(e)}case`entity`:return{value:void 0,hash:c(e,r)};case`entity-type`:return{value:void 0,hash:s(e,r)};default:return{value:void 0,hash:``}}}return p(x)}function p(e){return{hash:(t,n)=>e(t,n).hash,index(n){let r=(t,r)=>{let i=e(t,r);return n?.({kind:t,argument:r,resultHash:i.hash}),i.value};return{byFilePath:e=>r(`byFilePath`,e),bySlug:e=>r(`bySlug`,e),inDirectory:e=>r(`inDirectory`,e),all:()=>r(`all`,``),get:e=>r(`get`,e),getAccess:e=>r(`getAccess`,e),list:e=>r(`list`,t({sidebarKey:e.sidebarKey})),metadata:e=>r(`metadata`,e)}},memoized(){let t=/* @__PURE__ */ new Map;return p((n,r)=>{if(n===`entity`||n===`entity-type`)return e(n,r);let i=`${n}\u0000${r}`,a=t.get(i);return a===void 0&&(a=e(n,r),t.set(i,a)),a})}}}function m(e,t,n){return f(e,t).index(n)}function h(e){let t=/* @__PURE__ */ new Map;for(let n of e)t.set(`${n.kind}\u0000${n.argument}`,n);return[...t.values()].sort((e,t)=>n(e.kind,t.kind)||n(e.argument,t.argument))}function g(e,t){return e.hash(t.kind,t.argument)!==t.resultHash}function _(t){return{value:t,hash:e(t===void 0?`absent`:t)}}function v(e){return{slug:e.slug,routeId:e.routeId,originPluginId:e.originPluginId,originFilePath:e.originFilePath,versionGroup:e.versionGroup,version:e.version,sidebarSubtreeEntityKey:e.sidebarSubtreeEntityKey,template:e.template,locale:e.locale,canonicalSlug:e.canonicalSlug}}export{m as createRouteIndex,f as createRouteQueryEvaluator,h as dedupeRouteQueryDependencies,g as isRouteQueryStale};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{normalizeRouteSlug as e}from"../../../shared/utils/routes/normalize-route-slug.js";import{slugifySegment as t}from"../../../shared/utils/routes/slugify-segment.js";import{delocalizeL10nPath as n}from"../../../shared/utils/l10n.js";import{posix as r}from"node:path";const i=/* @__PURE__ */ new Set([`@api`,`@theme`,`@l10n`,`@mcp`,`@skills`]);function a(e){let t=r.normalize(e.replaceAll(`\\`,`/`)),a=(n(t)??t).split(`/`).filter(Boolean).slice(0,-1),o=a.findIndex(e=>e.startsWith(`@`)&&e.length>1&&!i.has(e));return o===-1?null:{parent:a.slice(0,o).join(`/`),name:a[o].slice(1)}}function o(n){let r=a(n);if(!r)return null;let i=r.parent.split(`/`).filter(Boolean).map(t);return{versionGroup:e(i.join(`/`)),version:t(r.name)}}export{a as findVersionFolder,o as parseContentVersion};
|
|
1
|
+
import{normalizeRouteSlug as e}from"../../../shared/utils/routes/normalize-route-slug.js";import{slugifySegment as t}from"../../../shared/utils/routes/slugify-segment.js";import{delocalizeL10nPath as n}from"../../../shared/utils/l10n.js";import{posix as r}from"node:path";const i=/* @__PURE__ */ new Set([`@api`,`@theme`,`@l10n`,`@mcp`,`@skills`,`@sdk`]);function a(e){let t=r.normalize(e.replaceAll(`\\`,`/`)),a=(n(t)??t).split(`/`).filter(Boolean).slice(0,-1),o=a.findIndex(e=>e.startsWith(`@`)&&e.length>1&&!i.has(e));return o===-1?null:{parent:a.slice(0,o).join(`/`),name:a[o].slice(1)}}function o(n){let r=a(n);if(!r)return null;let i=r.parent.split(`/`).filter(Boolean).map(t);return{versionGroup:e(i.join(`/`)),version:t(r.name)}}export{a as findVersionFolder,o as parseContentVersion};
|