@redocly/framework 1.0.0-next.1 → 1.0.0-next.2
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/cli/args.js +1 -1
- package/dist/cli/commands/translate.js +1 -1
- package/dist/cli/validate-react-pages.js +1 -1
- package/dist/content-layer/config-schema.d.ts +7 -2
- package/dist/content-layer/config-schema.js +1 -1
- package/dist/content-layer/config.d.ts +22 -9
- package/dist/content-layer/config.js +1 -1
- package/dist/content-layer/context.d.ts +2 -0
- package/dist/content-layer/context.js +1 -1
- package/dist/content-layer/database/assets.js +1 -1
- package/dist/content-layer/database/blobs.js +1 -1
- package/dist/content-layer/database/entity-store.d.ts +5 -0
- package/dist/content-layer/database/entity-store.js +1 -1
- package/dist/content-layer/database/files.js +1 -1
- package/dist/content-layer/database/finalize.js +1 -1
- package/dist/content-layer/database/invalidation.d.ts +6 -0
- package/dist/content-layer/database/invalidation.js +26 -26
- package/dist/content-layer/database/link-refs.js +1 -1
- package/dist/content-layer/database/origins.js +1 -1
- package/dist/content-layer/database/problems.js +1 -1
- package/dist/content-layer/database/reset.js +1 -1
- package/dist/content-layer/database/route-query-deps.js +1 -1
- package/dist/content-layer/database/schema.d.ts +33 -0
- package/dist/content-layer/database/schema.js +1 -1
- package/dist/content-layer/database/search-vocab.js +2 -2
- package/dist/content-layer/database/site-config.d.ts +23 -0
- package/dist/content-layer/database/site-config.js +1 -1
- package/dist/content-layer/database/static-files.js +1 -1
- package/dist/content-layer/ingest/finalize-phase.js +1 -1
- package/dist/content-layer/ingest/hook-inputs.js +1 -1
- package/dist/content-layer/ingest/run.js +1 -1
- package/dist/content-layer/ingest/search-sync.js +1 -1
- package/dist/content-layer/ingest/sync.js +1 -1
- package/dist/content-layer/link-checker/delta.js +1 -1
- package/dist/content-layer/loaders/context.js +1 -1
- package/dist/content-layer/markdown/constants/tag-sets.d.ts +2 -0
- package/dist/content-layer/markdown/constants/tag-sets.js +1 -1
- package/dist/content-layer/markdown/nodes/table.js +1 -1
- package/dist/content-layer/markdown/resolve/ast.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/code-snippet.js +5 -4
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/code-walkthrough/filesets.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/diagram-file.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/file-reference.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.d.ts +2 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/operation-samples.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/partial.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/svg-content.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc.js +1 -1
- package/dist/content-layer/markdown/resolve/render-diagrams.d.ts +8 -1
- package/dist/content-layer/markdown/resolve/render-diagrams.js +1 -1
- package/dist/content-layer/markdown/tags/markdoc-error.d.ts +8 -0
- package/dist/content-layer/markdown/tags/markdoc-error.js +1 -1
- package/dist/content-layer/markdown/utils/node-source-range.d.ts +3 -3
- package/dist/content-layer/markdown/utils/node-source-range.js +1 -1
- package/dist/content-layer/materialization/asset-reconcile.js +1 -1
- package/dist/content-layer/materialization/entity.js +1 -1
- package/dist/content-layer/materialization/static-files.js +1 -1
- package/dist/content-layer/plan-gates.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-sidebar.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/search-documents.d.ts +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/search-documents.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/resolve-items.d.ts +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/sidebars.d.ts +1 -1
- package/dist/content-layer/plugins/internal/markdoc/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.d.ts +4 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/agent-card.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/auth.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/handler.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/discovery.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/server-card.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/skills-resources.js +1 -1
- package/dist/content-layer/plugins/internal/react-page/index.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/bundle.d.ts +2 -1
- package/dist/content-layer/plugins/internal/sidebar/bundle.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.d.ts +2 -1
- package/dist/content-layer/plugins/internal/sidebar/index.js +1 -1
- package/dist/content-layer/plugins/internal/skills/server/routes.js +1 -1
- package/dist/content-layer/plugins/types/search.d.ts +13 -2
- package/dist/content-layer/plugins/utils/link-access.js +1 -1
- package/dist/content-layer/problems/codes.d.ts +10 -0
- package/dist/content-layer/problems/codes.js +1 -1
- package/dist/content-layer/revisions/delete.js +1 -1
- package/dist/content-layer/search/engine/core/search-engine.js +1 -1
- package/dist/content-layer/search/facet-rows.js +1 -1
- package/dist/content-layer/search/keywords.d.ts +18 -0
- package/dist/content-layer/search/keywords.js +1 -0
- package/dist/content-layer/search/postings/postings-store.d.ts +14 -0
- package/dist/content-layer/search/postings/postings-store.js +1 -1
- package/dist/content-layer/search/store.d.ts +3 -1
- package/dist/content-layer/server/database.js +1 -1
- package/dist/content-layer/static/registry.js +1 -1
- package/dist/content-layer/versions/group-info.d.ts +21 -0
- package/dist/content-layer/versions/group-info.js +1 -0
- package/dist/content-layer/versions/redirect.d.ts +13 -11
- package/dist/content-layer/versions/redirect.js +1 -1
- package/dist/content-layer/versions/resolve.d.ts +1 -21
- package/dist/content-layer/versions/resolve.js +1 -1
- package/dist/content-layer/versions/version-groups.d.ts +1 -1
- package/dist/content-layer/versions/version-groups.js +1 -1
- package/dist/server/__tests__/rbac-fixture.js +1 -1
- package/dist/server/app.js +3 -3
- package/dist/server/content.js +9 -9
- package/dist/server/lambda-entry.js +1 -1
- package/dist/server/node-entry.js +1 -1
- package/dist/server/page-handlers.js +2 -2
- package/dist/server/plugin-context.js +1 -1
- package/dist/server/project-env.d.ts +12 -0
- package/dist/server/project-env.js +1 -0
- package/dist/server/redirects.js +1 -1
- package/dist/server/runtime-config.js +1 -1
- package/dist/server/search/route.js +1 -1
- package/dist/server/static-files/serve.js +1 -1
- package/dist/server/subprocess/child-entry.js +1 -1
- package/dist/server/subprocess/host.js +1 -1
- package/dist/server/subprocess/runner.js +1 -1
- package/dist/shared/constants/dependency-pack.js +1 -1
- package/dist/shared/constants/l10n/langs/ar.js +1 -1
- package/dist/shared/constants/l10n/langs/de.js +1 -1
- package/dist/shared/constants/l10n/langs/en.js +1 -1
- package/dist/shared/constants/l10n/langs/es.js +1 -1
- package/dist/shared/constants/l10n/langs/fr.js +1 -1
- package/dist/shared/constants/l10n/langs/hi.js +1 -1
- package/dist/shared/constants/l10n/langs/it.js +1 -1
- package/dist/shared/constants/l10n/langs/ja.js +1 -1
- package/dist/shared/constants/l10n/langs/ko.js +1 -1
- package/dist/shared/constants/l10n/langs/pl.js +1 -1
- package/dist/shared/constants/l10n/langs/pt-br.js +1 -1
- package/dist/shared/constants/l10n/langs/pt.js +1 -1
- package/dist/shared/constants/l10n/langs/ru.js +1 -1
- package/dist/shared/constants/l10n/langs/uk.js +1 -1
- package/dist/shared/constants/l10n/langs/zh.js +1 -1
- package/dist/shared/plan-gates.d.ts +3 -2
- package/dist/shared/search/facets.d.ts +5 -0
- package/dist/shared/search/facets.js +1 -1
- package/dist/shared/types/search.d.ts +1 -0
- package/dist/shared/types/sidebar.d.ts +1 -0
- package/drizzle/20261103061150_site_config_effective_hash/migration.sql +1 -0
- package/drizzle/20261105151816_search_http_path_tokens/migration.sql +1 -0
- package/package.json +7 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{SEARCH_HTTP_METHOD_FACET_FIELD as e,SEARCH_HTTP_PATH_FACET_FIELD as t}from"../../../../../shared/search/facets.js";import{isRbacScope as n}from"../../../../../server/rbac/engine.js";import{annotateApiDocsRbac as r}from"../../../../../server/rbac/api-docs.js";import{withImpliedDiscriminatorMappings as i}from"./implied-discriminators.js";import{createHash as a}from"node:crypto";import{REDOCLY_TEAMS_RBAC as o}from"@redocly/config";import{ApiDocsSearchIndexer as s}from"@redocly/api-docs/lib/services/search/indexer/index.js";import{isOperationName as c}from"@redocly/api-docs/lib/utils/http-methods.js";const l=`API Reference`;function u(e,t,n={}){let a=h(e.store)?e.store:{},o=r(t,e.specType,{warn:n.warn??(()=>{})}),c=i(o),l=new s(e.basePath,a.schemaStore,h(c)?c:void 0,{exampleStore:a.exampleStore}),u=e=>{for(let t of e)l.addItem(t),h(t)&&Array.isArray(t.items)&&u(t.items)};u(e.items);let m=[],g=/* @__PURE__ */ new Set,_=[];return{docs:l.getResult().map(e=>{for(let t of e.parameters??[]){let n=f(t),r=n.fragmentKey;g.has(r)||(g.add(r),m.push(n));let i={docKey:e.id,fragmentKey:r,place:t.place,anchor:p(t.deepLink)};t.path&&t.path.length>0&&(i.path=t.path),_.push(i)}return d(e,n)}),fragments:m,uses:_}}function d(r,i){let a=r.httpPath?m(r.httpPath):void 0,s={...i.facets},l=r.isAdditionalOperation?r.httpMethod:r.httpMethod&&c(r.httpMethod)?r.httpMethod.toLowerCase():void 0;l&&(s[e]=l,a&&(s[t]=a));let u={docKey:r.id,routeSlug:r.url,title:m(r.title),text:m(r.text),groupKey:i.groupKey??`API Reference`,facets:s},d=r[o];return n(d)&&(u.rbacScope=d),r.httpMethod&&(u.httpMethod=r.httpMethod),a&&(u.httpPath=a),r.deprecated&&(u.deprecated=!0),r.isAdditionalOperation&&(u.isAdditionalOperation=!0),r.badges&&r.badges.length>0&&(u.badges=r.badges),u}function f(e){let t={name:m(e.name),description:m(e.description)};return e.example&&(t.example=e.example),e.enum&&e.enum.length>0&&(t.enum=e.enum),{fragmentKey:a(`sha1`).update(JSON.stringify([t.name,t.description,t.example??null,t.enum??null])).digest(`hex`),...t}}function p(e){if(!e)return``;let t=e.indexOf(`#`);return t>=0?e.slice(t+1):e}function m(e){return Array.isArray(e)?e.join(` `):e}function h(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}export{l as API_DOCS_SEARCH_GROUP,u as buildApiDocsSearchDocuments};
|
|
@@ -5,7 +5,7 @@ import type { Logger } from '../../../../shared/logger.js';
|
|
|
5
5
|
import type { RouteDetail, RouteIndex } from '../../utils/route-index.js';
|
|
6
6
|
import type { PluginIO } from '../../types/io.js';
|
|
7
7
|
import type { EntityInvalidationDep } from '../../types/plugin.js';
|
|
8
|
-
import type { VersionGroupInfo } from '../../../versions/
|
|
8
|
+
import type { VersionGroupInfo } from '../../../versions/group-info.js';
|
|
9
9
|
export type CatalogNavItem = CatalogConfig['items'][number];
|
|
10
10
|
/** A catalog item with its server-only RBAC scope. */
|
|
11
11
|
export type CatalogItemPayload = CatalogItemValue & {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { SidebarContribution, SidebarBreadcrumb } from '../sidebar/contributions.js';
|
|
2
|
-
import type { VersionGroupInfo } from '../../../versions/
|
|
2
|
+
import type { VersionGroupInfo } from '../../../versions/group-info.js';
|
|
3
3
|
import type { EntityStore } from '../../../database/entity-store.js';
|
|
4
4
|
import { type CatalogMember } from './resolve-items.js';
|
|
5
5
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{runtimeTemplate as i}from"../../templates.js";import{SEARCH_GROUP_FACET_FIELD as a}from"../../../../shared/search/facets.js";import{configuredFacetFields as o,extractFacetsFromFrontmatter as s,invalidFacetValueProblems as c,searchCategoryOf as l}from"../../../search/facet-values.js";import{isObject as u}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as d}from"../../../../shared/utils/routes/normalize-route-slug.js";import{resolveContentPath as f}from"../../../../shared/utils/resolve-content-path.js";import{PAGE_BANNER_SCHEMA as p,sanitizeConfig as m}from"../../../config-schema.js";import{notInPlanProblem as h}from"../../../plan-gates.js";import{matchPathMap as g}from"../../utils/glob.js";import{filePathToRouteSlug as _}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{isPlanFeatureGranted as v}from"../../../../shared/plan-gates.js";import{splitUrlSuffix as y}from"../../../../shared/utils/routes/split-url-suffix.js";import{packMarkdocAst as ee,unpackMarkdocAst as b}from"../../../markdown/utils/packed-ast.js";import{isRouteSlugTarget as x}from"../../../../shared/utils/routes/is-route-slug-target.js";import{loadSidebarSubtreeLabel as S}from"../../utils/sidebar-label.js";import{replaceWithMarkdocError as C}from"../../../markdown/tags/markdoc-error.js";import{CODE_WALKTHROUGH_TAG_NAMES as te,builtInMarkdocTags as ne}from"../../../markdown/constants/builtin-tags.js";import{walkMarkdocAst as w}from"../../../markdown/utils/walk-markdoc-ast.js";import{markdocNodeRange as re}from"../../../markdown/utils/node-source-range.js";import{markdocFirstHeading as ie}from"../../../markdown/search/to-text.js";import{safeDecodeURI as ae}from"../../../../shared/utils/safe-decode-uri.js";import{shiftRange as oe}from"../../../../shared/utils/shift-range.js";import{classifyLinkTarget as se}from"../../../link-checker/classify.js";import{onDiskLinkRefs as ce}from"../../../link-checker/node-ref.js";import{isPartialPath as le}from"../../../markdown/utils/partials.js";import{FRONTMATTER_BLOCK_RE as ue,computeFrontmatterLineOffset as de}from"../../../markdown/utils/frontmatter-offset.js";import{inlineRawPartials as fe}from"../../../markdown/resolve/raw-partials.js";import{resolveMarkdownAst as T}from"../../../markdown/resolve/ast.js";import{resolveBannerForAppData as E}from"../app-data/banner.js";import{MARKDOC_DOCUMENT_LOADER_KEY as D}from"../../../../shared/constants/route-deps.js";import{isMarkdocValidationEnabled as O,resolveMarkdocTagSet as k,resolveMarkdownPageValidationSet as A,userMarkdocSchemaFiles as j}from"../../../markdown/constants/tag-sets.js";import{pageLocale as M}from"../../utils/page-locale.js";import{markdocAstToMarkdownDoc as N}from"../../../markdown/search/to-markdown.js";import{collectAnchors as P}from"../../../markdown/utils/collect-anchors.js";import{frontmatterVariable as F}from"../../../markdown/utils/frontmatter-variable.js";import{markdownFirstHeading as I}from"../../../markdown/utils/first-heading.js";import{markdocAstToSearchSections as L}from"../../../markdown/search/to-sections.js";import{isInternalPagePath as R}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as z}from"../../utils/explicit-slugs.js";import{isSkillContentPath as B}from"../../utils/skill-paths.js";import{SOURCE_TEMPLATE_PREFIX as V}from"../../../../shared/constants/template-ids.js";import{captureSnippet as H,splitSourceLines as pe}from"../../../../shared/utils/capture-snippet.js";import me from"js-yaml";const U=`markdoc-page`,W=r(`internal.markdoc`,`document`),G=r(`internal.markdoc`,`sidebar-item`),he=`Documentation`,K=t(W,async e=>{let t=await e.io.readFile(e.file.absolutePath),{content:n,frontmatter:r,frontmatterError:i}=Y(t),a=J(e),{ast:o,entityDeps:s,assetUsages:c,tagList:l,problems:u,linkRefs:d}=await T(n,e.file.path,{resolverContext:a,tags:(await k()).tags,variables:{get env(){return e.config.publicEnv??{}}},transform:v(e.config,`codeWalkthrough`)?void 0:t=>Ce(t,e.file.path),validation:O()?await A():void 0}),f=de(t);Oe(o);let p=await Se(r.seo,e),m=v(e.config,`banner`)?await E(ke(r,e.file.path,e.logger),a):void 0,h=await we(r,e),g=await Te(r.navigation,e),_={...h.frontmatter,navigation:g.value,seo:p.seo,banner:m?.banner},y=Ae(r,o);return{value:{ast:ee(o),frontmatter:_,tagList:l,title:y,editPage:xe(e.config,r,e.file.path),lastModified:e.file.lastModifiedAt},entityDeps:[...s,..._e(),...p.entityDeps,...m?.deps??[],...h.entityDeps,...g.entityDeps],assetUsages:[...c,...p.assetUsages,...m?.assetUsages??[],...h.assetUsages],problems:ve(t,e.file.path,f,u,i),linkRefs:[...ce(d,f),...g.linkRefs],targetInventories:[ye(o,{frontmatter:F(_,y)})]}},{usesProjectMarkdocSchema:!0,async markdown(e,t){let{tags:n}=await k(),{chunks:r,headings:i}=N(b(e.ast),{tags:n,locale:M(t),variables:{frontmatter:F(e.frontmatter,e.title),env:t.config.publicEnv??{}}});return[{chunks:r,headings:i,...e.title?{title:e.title}:{}}]},searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=t.route.slug,r=e.title??Q(t.route.originFilePath??n),{category:i,isInvalid:u}=l(t.route.metadata),{facets:d,invalidFields:f}=s(t.route.metadata,o(t.config));return{docs:L(b(e.ast),r,{frontmatter:F(e.frontmatter,e.title)}).map(e=>{let t={docKey:e.docKey,routeSlug:n,title:e.title,text:e.text,groupKey:i??`Documentation`,facets:d};return e.anchor!==void 0&&(t.anchor=e.anchor),e.path!==void 0&&(t.path=e.path),e.rbacTeams!==void 0&&(t.rbacScope=Object.fromEntries(e.rbacTeams.map(e=>[e,`read`]))),t}),problems:c([...f,...u?[a]:[]],t.route.originFilePath)}}}),q=t(G,async e=>{let{content:t,frontmatter:n}=Y(await e.io.readFile(e.file.absolutePath)),r=await fe(t,e.file.path,J(e));return{value:{label:Z(n)??I(r.source)??Q(e.args.filePath)},entityDeps:r.entityDeps}});function J(e){return{config:e.config,contentDir:e.contentDir,entities:e.entities,file:e.file,io:e.io,logger:e.logger,markdown:e.markdown,plugin:e.plugin}}const ge=e({id:`internal.markdoc`,version:`3.42.0`,content:{filter:{match:e=>e.toLowerCase().endsWith(`.md`)&&!B(e)},extractFile(e,t){if(R(e.path)||le(e.path,t.config))return{routes:[]};if(!v(t.config,`markdown`))return{routes:[],problems:[h(`Markdown pages`)]};let{banner:n,...r}=e.manifest,i=je(e,t),a=z(r.slug),o=K.withArgs({filePath:e.path}),s=q.withArgs({filePath:e.path});return{routes:a.length>0?a.map(e=>({deps:{[D]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:e,slugHint:null,template:i})):[{deps:{[D]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:null,slugHint:_(e.path),template:i}],entities:[o]}}},loaders:[K,q],templates:{[U]:i(n(`./client/template.tsx`,import.meta.url))}});function Y(e){let t=e.match(ue);if(!t)return{content:e,frontmatter:{}};let n=t[1]??``;try{let r=me.load(n);return{content:e.slice(t[0].length),frontmatter:u(r)?r:{}}}catch(n){let r=n instanceof Error?n.message:String(n);return{content:e.slice(t[0].length),frontmatter:{},frontmatterError:r}}}function _e(){return(j()??[]).map(e=>({kind:`file`,path:e}))}function ve(e,t,n,r,i){if(r.length===0&&i===void 0)return[];let a=pe(e),o=r.map(e=>be(e,a,n,t));if(i!==void 0){let e={start:{line:1},end:{line:n}};o.push({code:`markdown/frontmatter-parse`,message:i,location:{filePath:t,range:e,snippet:H(a,e)}})}return o}function ye(e,t){let{ids:n,exhaustive:r}=P(e,t);return{kind:`anchor`,exhaustive:r,targets:n}}function be(e,t,n,r){let i=e.location?.range;if(!i)return e;let a=oe(i,n);return{...e,location:{filePath:r,range:a,snippet:H(t,a)}}}function xe(e,t,n){let r=u(t.markdown)?t.markdown:{},i={...e.markdown?.editPage,...u(r.editPage)?r.editPage:{}};if(i.hide!==!0&&typeof i.baseUrl==`string`&&i.baseUrl!==``)return{to:`${i.baseUrl.replace(/(?<!\/)\/+$/,``)}/${n}`}}async function Se(e,t){if(!u(e)||typeof e.image!=`string`)return{seo:e,entityDeps:[],assetUsages:[]};let n=await t.markdown.resolveImageReference(e.image,t.file.path);return n.result.kind===`assetRef`?{seo:{...e,image:n.result.url},entityDeps:n.entityDeps,assetUsages:n.assetUsages}:{seo:e,entityDeps:n.entityDeps,assetUsages:[]}}function Ce(e,t){let n=[];for(let r of w(e)){if(r.type!==`tag`||r.tag===void 0||!te.includes(r.tag))continue;let e=`\`${r.tag}\` is not in this project's plan and is ignored.`;n.push({code:`configuration/ignored`,message:e,location:{filePath:t,range:re(r)??{start:{line:1},end:{line:1}}}}),C(r,e)}return n}const X=[`image`,`links`];async function we(e,t){let n=t.config.markdown?.frontMatterKeysToResolve??X,r={...e},i=[],a=[];for(let o of n){let n=e[o];if(typeof n!=`string`)continue;let s=await t.markdown.resolveLocalReference(n,t.file.path);i.push(...s.entityDeps),a.push(...s.assetUsages),s.result.kind!==`passthrough`&&(r[o]=s.result.url)}return{frontmatter:r,entityDeps:i,assetUsages:a}}async function Te(e,t){let n=[],r=[];if(!u(e))return{value:e,entityDeps:n,linkRefs:r};let i={...e};for(let a of[`nextButton`,`previousButton`]){let o=e[a];if(!u(o)||typeof o.page!=`string`)continue;let{page:s,...c}=o,l=se(ae(s),t.file.path);l!==null&&r.push({kind:`link`,raw:s,...l});let d=await De(s,t);n.push(...d.entityDeps),i[a]={...c,label:typeof c.label==`string`?c.label:d.route&&await Ee(d.route,t),link:d.link}}return{value:i,entityDeps:n,linkRefs:r}}async function Ee(e,t){let n=await S(t.entities,e);if(n!==void 0)return n;let r=t.routes.get(e.slug)?.metadata.seo;return u(r)&&typeof r.title==`string`&&r.title.trim()!==``?r.title:e.slug}async function De(e,t){let n=e.trim(),{path:r,suffix:i}=y(n);if(x(r)){let e=t.routes.bySlug(d(r));return{link:e&&`${e.slug}${i}`,route:e,entityDeps:[]}}let a=await t.markdown.resolveLocalReference(n,t.file.path);if(a.result.kind!==`pageUrl`)return{entityDeps:a.entityDeps};let o=a.result.url;return{link:o,route:t.routes.bySlug(y(o).path)??a.entityDeps.map(e=>e.kind===`file`?t.routes.byFilePath(e.path):void 0).reverse().find(e=>e!==void 0),entityDeps:a.entityDeps}}function Oe(e){let t=/* @__PURE__ */ new Map;for(let n of w(e)){if(n.type!==`tag`||n.tag===void 0||ne[n.tag]?.attributes?.__idx===void 0)continue;let e=(t.get(n.tag)??0)+1;t.set(n.tag,e),n.attributes.__idx=e}}function ke(e,t,n){if(e.banner===void 0)return;let{value:r,problems:i}=m(p,{banner:e.banner});for(let e of i)n?.warn(`${t}: ${e.message}`);return r.banner}function Ae(e,t){return Z(e)??ie(t)??void 0}function Z(e){let t=u(e.seo)?e.seo.title:void 0;return typeof t==`string`&&t.trim()!==``?t:void 0}function Q(e){let t=(e.split(`/`).pop()??e).replace(/\.[^.]+$/,``);return t===``?e:t}function je(e,t){let n=e.manifest.template;if(typeof n==`string`&&n.trim()!==``)return $(n,e.path,t.logger);let r=g(e.path,t.config.markdown?.template);return typeof r==`string`&&r.trim()!==``?$(r,`redocly.yaml`,t.logger):U}function $(e,t,n){if(!e.startsWith(`./`)&&!e.startsWith(`../`)&&!e.startsWith(`/`))return e;let r=f(e,t);return r===null?(n.warn(`Template reference "${e}" in ${t} escapes the content root; falling back to ${U}.`),U):`${V}${r}`}export{W as MARKDOC_DOCUMENT_LOADER_ID,he as MARKDOC_SEARCH_GROUP,G as MARKDOC_SIDEBAR_ITEM_LOADER_ID,U as MARKDOC_TEMPLATE_ID,ge as markdocContentPlugin};
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{runtimeTemplate as i}from"../../templates.js";import{SEARCH_GROUP_FACET_FIELD as a}from"../../../../shared/search/facets.js";import{configuredFacetFields as o,extractFacetsFromFrontmatter as s,invalidFacetValueProblems as c,searchCategoryOf as l}from"../../../search/facet-values.js";import{isObject as u}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as d}from"../../../../shared/utils/routes/normalize-route-slug.js";import{resolveContentPath as f}from"../../../../shared/utils/resolve-content-path.js";import{PAGE_BANNER_SCHEMA as p,sanitizeConfig as m}from"../../../config-schema.js";import{notInPlanProblem as h}from"../../../plan-gates.js";import{matchPathMap as g}from"../../utils/glob.js";import{filePathToRouteSlug as _}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{isPlanFeatureGranted as v}from"../../../../shared/plan-gates.js";import{splitUrlSuffix as y}from"../../../../shared/utils/routes/split-url-suffix.js";import{packMarkdocAst as ee,unpackMarkdocAst as b}from"../../../markdown/utils/packed-ast.js";import{isRouteSlugTarget as x}from"../../../../shared/utils/routes/is-route-slug-target.js";import{loadSidebarSubtreeLabel as S}from"../../utils/sidebar-label.js";import{markdocNodeRange as C}from"../../../markdown/utils/node-source-range.js";import{replaceWithMarkdocError as te}from"../../../markdown/tags/markdoc-error.js";import{CODE_WALKTHROUGH_TAG_NAMES as ne,builtInMarkdocTags as re}from"../../../markdown/constants/builtin-tags.js";import{walkMarkdocAst as w}from"../../../markdown/utils/walk-markdoc-ast.js";import{markdocFirstHeading as ie}from"../../../markdown/search/to-text.js";import{safeDecodeURI as ae}from"../../../../shared/utils/safe-decode-uri.js";import{shiftRange as oe}from"../../../../shared/utils/shift-range.js";import{classifyLinkTarget as se}from"../../../link-checker/classify.js";import{onDiskLinkRefs as ce}from"../../../link-checker/node-ref.js";import{isPartialPath as le}from"../../../markdown/utils/partials.js";import{FRONTMATTER_BLOCK_RE as ue,computeFrontmatterLineOffset as de}from"../../../markdown/utils/frontmatter-offset.js";import{inlineRawPartials as fe}from"../../../markdown/resolve/raw-partials.js";import{resolveMarkdownAst as T}from"../../../markdown/resolve/ast.js";import{resolveBannerForAppData as E}from"../app-data/banner.js";import{MARKDOC_DOCUMENT_LOADER_KEY as D}from"../../../../shared/constants/route-deps.js";import{isMarkdocValidationEnabled as O,resolveMarkdocTagSet as k,resolveMarkdownPageValidationSet as A,userMarkdocSchemaFiles as j,userMarkdocTagNames as M}from"../../../markdown/constants/tag-sets.js";import{pageLocale as N}from"../../utils/page-locale.js";import{markdocAstToMarkdownDoc as P}from"../../../markdown/search/to-markdown.js";import{collectAnchors as F}from"../../../markdown/utils/collect-anchors.js";import{frontmatterVariable as I}from"../../../markdown/utils/frontmatter-variable.js";import{markdownFirstHeading as L}from"../../../markdown/utils/first-heading.js";import{markdocAstToSearchSections as R}from"../../../markdown/search/to-sections.js";import{isInternalPagePath as z}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as B}from"../../utils/explicit-slugs.js";import{isSkillContentPath as V}from"../../utils/skill-paths.js";import{SOURCE_TEMPLATE_PREFIX as pe}from"../../../../shared/constants/template-ids.js";import{captureSnippet as H,splitSourceLines as me}from"../../../../shared/utils/capture-snippet.js";import{curationKeywordsOf as he}from"../../../search/keywords.js";import ge from"js-yaml";const U=`markdoc-page`,W=r(`internal.markdoc`,`document`),G=r(`internal.markdoc`,`sidebar-item`),_e=`Documentation`,K=t(W,async e=>{let t=await e.io.readFile(e.file.absolutePath),{content:n,frontmatter:r,frontmatterError:i}=Y(t),a=J(e),{ast:o,entityDeps:s,assetUsages:c,tagList:l,problems:u,linkRefs:d}=await T(n,e.file.path,{resolverContext:a,tags:(await k()).tags,variables:{get env(){return e.config.publicEnv??{}}},transform:t=>Ee(t,e.file.path,Te(e.config)),validation:O()?await A():void 0}),f=de(t);je(o);let p=await we(r.seo,e),m=v(e.config,`banner`)?await E(Me(r,e.file.path,e.logger),a):void 0,h=await Oe(r,e),g=await ke(r.navigation,e),_={...h.frontmatter,navigation:g.value,seo:p.seo,banner:m?.banner},y=Ne(r,o);return{value:{ast:ee(o),frontmatter:_,tagList:l,title:y,editPage:Ce(e.config,r,e.file.path),lastModified:e.file.lastModifiedAt},entityDeps:[...s,...ye(),...p.entityDeps,...m?.deps??[],...h.entityDeps,...g.entityDeps],assetUsages:[...c,...p.assetUsages,...m?.assetUsages??[],...h.assetUsages],problems:be(t,e.file.path,f,u,i),linkRefs:[...ce(d,f),...g.linkRefs],targetInventories:[xe(o,{frontmatter:I(_,y)})]}},{usesProjectMarkdocSchema:!0,async markdown(e,t){let{tags:n}=await k(),{chunks:r,headings:i}=P(b(e.ast),{tags:n,locale:N(t),variables:{frontmatter:I(e.frontmatter,e.title),env:t.config.publicEnv??{}}});return[{chunks:r,headings:i,...e.title?{title:e.title}:{}}]},searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=t.route.slug,r=e.title??Q(t.route.originFilePath??n),{category:i,isInvalid:u}=l(t.route.metadata),{facets:d,invalidFields:f}=s(t.route.metadata,o(t.config)),p=he(e.frontmatter.keywords);return{docs:R(b(e.ast),r,{frontmatter:I(e.frontmatter,e.title)}).map((e,t)=>{let r={docKey:e.docKey,routeSlug:n,title:e.title,text:e.text,groupKey:i??`Documentation`,facets:d};e.anchor!==void 0&&(r.anchor=e.anchor),e.path!==void 0&&(r.path=e.path);let a=t===0?p:{excludes:p?.excludes};return(a?.includes||a?.excludes)&&(r.keywords=a),e.rbacTeams!==void 0&&(r.rbacScope=Object.fromEntries(e.rbacTeams.map(e=>[e,`read`]))),r}),problems:c([...f,...u?[a]:[]],t.route.originFilePath)}}}),q=t(G,async e=>{let{content:t,frontmatter:n}=Y(await e.io.readFile(e.file.absolutePath)),r=await fe(t,e.file.path,J(e));return{value:{label:Z(n)??L(r.source)??Q(e.args.filePath)},entityDeps:r.entityDeps}});function J(e){return{config:e.config,contentDir:e.contentDir,entities:e.entities,file:e.file,io:e.io,logger:e.logger,markdown:e.markdown,plugin:e.plugin}}const ve=e({id:`internal.markdoc`,version:`3.43.1`,content:{filter:{match:e=>e.toLowerCase().endsWith(`.md`)&&!V(e)},extractFile(e,t){if(z(e.path)||le(e.path,t.config))return{routes:[]};if(!v(t.config,`markdown`))return{routes:[],problems:[h(`Markdown pages`)]};let{banner:n,...r}=e.manifest,i=Pe(e,t),a=B(r.slug),o=K.withArgs({filePath:e.path}),s=q.withArgs({filePath:e.path});return{routes:a.length>0?a.map(e=>({deps:{[D]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:e,slugHint:null,template:i})):[{deps:{[D]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:null,slugHint:_(e.path),template:i}],entities:[o]}}},loaders:[K,q],templates:{[U]:i(n(`./client/template.tsx`,import.meta.url))}});function Y(e){let t=e.match(ue);if(!t)return{content:e,frontmatter:{}};let n=t[1]??``;try{let r=ge.load(n);return{content:e.slice(t[0].length),frontmatter:u(r)?r:{}}}catch(n){let r=n instanceof Error?n.message:String(n);return{content:e.slice(t[0].length),frontmatter:{},frontmatterError:r}}}function ye(){return(j()??[]).map(e=>({kind:`file`,path:e}))}function be(e,t,n,r,i){if(r.length===0&&i===void 0)return[];let a=me(e),o=r.map(e=>Se(e,a,n,t));if(i!==void 0){let e={start:{line:1},end:{line:n}};o.push({code:`markdown/frontmatter-parse`,message:i,location:{filePath:t,range:e,snippet:H(a,e)}})}return o}function xe(e,t){let{ids:n,exhaustive:r}=F(e,t);return{kind:`anchor`,exhaustive:r,targets:n}}function Se(e,t,n,r){let i=e.location?.range;if(!i)return e;let a=oe(i,n);return{...e,location:{filePath:r,range:a,snippet:H(t,a)}}}function Ce(e,t,n){let r=u(t.markdown)?t.markdown:{},i={...e.markdown?.editPage,...u(r.editPage)?r.editPage:{}};if(i.hide!==!0&&typeof i.baseUrl==`string`&&i.baseUrl!==``)return{to:`${i.baseUrl.replace(/(?<!\/)\/+$/,``)}/${n}`}}async function we(e,t){if(!u(e)||typeof e.image!=`string`)return{seo:e,entityDeps:[],assetUsages:[]};let n=await t.markdown.resolveImageReference(e.image,t.file.path);return n.result.kind===`assetRef`?{seo:{...e,image:n.result.url},entityDeps:n.entityDeps,assetUsages:n.assetUsages}:{seo:e,entityDeps:n.entityDeps,assetUsages:[]}}function Te(e){let t=/* @__PURE__ */ new Map;if(!v(e,`customMarkdocTags`))for(let e of M())t.set(e,`Custom Markdoc tags are not in this project's plan, so \`${e}\` is ignored.`);if(!v(e,`codeWalkthrough`))for(let e of ne)t.set(e,`\`${e}\` is not in this project's plan and is ignored.`);return t}function Ee(e,t,n){let r=[];if(n.size===0)return r;for(let i of w(e)){let e=i.type===`tag`&&i.tag!==void 0?n.get(i.tag):void 0;e!==void 0&&(r.push({code:`configuration/ignored`,message:e,location:{filePath:t,range:C(i)??{start:{line:1},end:{line:1}}}}),te(i,e))}return r}const De=[`image`,`links`];async function Oe(e,t){let n=t.config.markdown?.frontMatterKeysToResolve??De,r={...e},i=[],a=[];for(let o of n){let n=e[o];if(typeof n!=`string`)continue;let s=await t.markdown.resolveLocalReference(n,t.file.path);i.push(...s.entityDeps),a.push(...s.assetUsages),s.result.kind!==`passthrough`&&(r[o]=s.result.url)}return{frontmatter:r,entityDeps:i,assetUsages:a}}async function ke(e,t){let n=[],r=[];if(!u(e))return{value:e,entityDeps:n,linkRefs:r};let i={...e};for(let a of[`nextButton`,`previousButton`]){let o=e[a];if(!u(o)||typeof o.page!=`string`)continue;let{page:s,...c}=o,l=se(ae(s),t.file.path);l!==null&&r.push({kind:`link`,raw:s,...l});let d=await X(s,t);n.push(...d.entityDeps),i[a]={...c,label:typeof c.label==`string`?c.label:d.route&&await Ae(d.route,t),link:d.link}}return{value:i,entityDeps:n,linkRefs:r}}async function Ae(e,t){let n=await S(t.entities,e);if(n!==void 0)return n;let r=t.routes.get(e.slug)?.metadata.seo;return u(r)&&typeof r.title==`string`&&r.title.trim()!==``?r.title:e.slug}async function X(e,t){let n=e.trim(),{path:r,suffix:i}=y(n);if(x(r)){let e=t.routes.bySlug(d(r));return{link:e&&`${e.slug}${i}`,route:e,entityDeps:[]}}let a=await t.markdown.resolveLocalReference(n,t.file.path);if(a.result.kind!==`pageUrl`)return{entityDeps:a.entityDeps};let o=a.result.url;return{link:o,route:t.routes.bySlug(y(o).path)??a.entityDeps.map(e=>e.kind===`file`?t.routes.byFilePath(e.path):void 0).reverse().find(e=>e!==void 0),entityDeps:a.entityDeps}}function je(e){let t=/* @__PURE__ */ new Map;for(let n of w(e)){if(n.type!==`tag`||n.tag===void 0||re[n.tag]?.attributes?.__idx===void 0)continue;let e=(t.get(n.tag)??0)+1;t.set(n.tag,e),n.attributes.__idx=e}}function Me(e,t,n){if(e.banner===void 0)return;let{value:r,problems:i}=m(p,{banner:e.banner});for(let e of i)n?.warn(`${t}: ${e.message}`);return r.banner}function Ne(e,t){return Z(e)??ie(t)??void 0}function Z(e){let t=u(e.seo)?e.seo.title:void 0;return typeof t==`string`&&t.trim()!==``?t:void 0}function Q(e){let t=(e.split(`/`).pop()??e).replace(/\.[^.]+$/,``);return t===``?e:t}function Pe(e,t){let n=e.manifest.template;if(typeof n==`string`&&n.trim()!==``)return $(n,e.path,t.logger);let r=g(e.path,t.config.markdown?.template);return typeof r==`string`&&r.trim()!==``?$(r,`redocly.yaml`,t.logger):U}function $(e,t,n){if(!e.startsWith(`./`)&&!e.startsWith(`../`)&&!e.startsWith(`/`))return e;let r=f(e,t);return r===null?(n.warn(`Template reference "${e}" in ${t} escapes the content root; falling back to ${U}.`),U):`${pe}${r}`}export{W as MARKDOC_DOCUMENT_LOADER_ID,_e as MARKDOC_SEARCH_GROUP,G as MARKDOC_SIDEBAR_ITEM_LOADER_ID,U as MARKDOC_TEMPLATE_ID,ve as markdocContentPlugin};
|
|
@@ -12,7 +12,10 @@ export type McpToolFileFacts = {
|
|
|
12
12
|
};
|
|
13
13
|
export declare function mcpToolFileEntityKey(sourcePath: string): string;
|
|
14
14
|
export declare function isMcpToolFile(path: string): boolean;
|
|
15
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* One `mcp-tools` entity per valid `@mcp` file; an invalid, duplicate or reserved name is an error
|
|
17
|
+
* problem instead. Without custom MCP tools in the plan, each file is a warning and no entity.
|
|
18
|
+
*/
|
|
16
19
|
export declare function scanMcpToolFiles(ctx: Pick<FinalizeContext, 'config' | 'files'>): {
|
|
17
20
|
entities: AnyRawEntityReference[];
|
|
18
21
|
problems: ProblemDraft[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{createInlineEntity as e}from"../../../loaders/define.js";import{
|
|
1
|
+
import{createInlineEntity as e}from"../../../loaders/define.js";import{notInPlanProblem as t}from"../../../plan-gates.js";import{MCP_TOOL_NAME_PATTERN as n}from"../../registry.js";import{isPlanFeatureGranted as r}from"../../../../shared/plan-gates.js";import{CREATE_ANONYMOUS_SESSION_TOOL_NAME as i,DISCOVER_TOOL_NAME as a,EXECUTE_TOOL_NAME as o,MANAGE_API_CREDENTIALS_TOOL_NAME as s,MCP_TOOLS_ENTITY_TYPE as c,REMOVE_API_CREDENTIALS_TOOL_NAME as l,SUBMIT_FEEDBACK_TOOL_NAME as u}from"./constants.js";import{isMcpHidden as d}from"./server/config-gate.js";import{buildMcpSetupPageRoutes as f}from"./setup-page.js";const p=`@mcp`,m=`mcp/invalid-tool`,h=/\.(ts|js)$/u,g=/\.d\.ts$/u,_=/* @__PURE__ */ new Set([`search`,`list-apis`,`get-endpoints`,`get-endpoint-info`,`get-security-schemes`,`get-full-api-description`,`list-graphql-apis`,`get-graphql-type-list`,`get-graphql-type`,`get-graphql-schema`,`list-pages`,`get-page`,`grep-pages`,`whoami`,u,o,a,`describe-tools`,i,s,l]);function v(e){return`mcp-tool-file:${e}`}function y(e){if(g.test(e)||!h.test(e))return!1;let t=e.split(`/`),n=t.indexOf(p);return n!==-1&&n<t.length-1}function b(e,t,r){if(!n.test(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is derived from the file name and may only contain letters, numbers, hyphens, and underscores (max 64 characters). Rename the file.`;if(r!==void 0)return`Duplicate MCP tool name "${e}": defined by both "${r}" and "${t}". Tool names are file names, so each file name must be unique across @mcp folders.`;if(_.has(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is already used by a built-in MCP tool. Rename the file.`}function x(n){let i=[],a=[];if(d(n.config))return{entities:i,problems:a};if(!r(n.config,`customMcpTools`)){for(let{path:e}of n.files)a.push({...t(`Custom MCP tools`),location:{filePath:e}});return{entities:i,problems:a}}let o=/* @__PURE__ */ new Map;for(let{path:t}of n.files){let n=t.slice(t.lastIndexOf(`/`)+1).replace(h,``),r=b(n,t,o.get(n));if(r!==void 0){a.push({code:m,message:r,location:{filePath:t}});continue}o.set(n,t);let s={name:n,sourcePath:t};i.push(e(s,{stableKey:v(t),type:c,metadata:s}))}return{entities:i,problems:a}}const S={filter:{match:y},extractAll(e){return{routes:f(e.config),entities:[]}}};export{p as MCP_DIR_SEGMENT,m as MCP_TOOL_PROBLEM_CODE,_ as RESERVED_MCP_TOOL_NAMES,y as isMcpToolFile,S as mcpContent,v as mcpToolFileEntityKey,x as scanMcpToolFiles};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{runtimeTemplate as r}from"../../templates.js";import{collectVersionGroups as i,findVersionedDirectories as a}from"../../../versions/version-groups.js";import{MCP_CREDENTIALS_THEME_ENTITY_KEY as o,MCP_IGNORED_ROUTES_ENTITY_KEY as s}from"../../../../shared/constants/mcp.js";import{A2A_ROUTE as c,AGENT_CARD_ROUTE as l,MCP_AUTHORIZATION_SERVER_ROUTE as u,MCP_AUTHORIZE_ROUTE as d,MCP_CALLBACK_ROUTE as f,MCP_CREDENTIALS_ROUTE as p,MCP_PROTECTED_RESOURCE_ROUTE as m,MCP_REGISTER_ROUTE as h,MCP_ROUTE as g,MCP_SERVER_CARD_ROUTE as _,MCP_SETUP_TEMPLATE_ID as v,MCP_TOKEN_ROUTE as y,PUBLIC_MCP_ROUTE as b}from"./constants.js";import{buildMcpAppData as x}from"./app-data.js";import{readCredentialsTheme as S}from"./credentials-theme.js";import{mcpContent as C,scanMcpToolFiles as w}from"./content-tools.js";import{collectIgnoredRouteSlugs as T}from"./ignored-routes.js";import{findMcpRedirectConflict as E}from"./redirects.js";function D(e,t,n,r){return{path:e,auth:`manual`,...r?{method:r}:{},handler:{filePath:t,importer:import.meta.url,exportName:n}}}const O=[D(g,`./server/handler.ts`,`mcp`),D(b,`./server/handler.ts`,`mcpPublic`),D(_,`./server/server-card.ts`,`mcpServerCard`,`GET`),D(m,`./server/oauth/discovery.ts`,`oauthProtectedResource`,`GET`),D(u,`./server/oauth/discovery.ts`,`oauthAuthorizationServer`,`GET`),D(h,`./server/oauth/register.ts`,`mcpRegister`,`POST`),D(d,`./server/oauth/authorize.ts`,`mcpAuthorize`,`GET`),D(y,`./server/oauth/token.ts`,`mcpToken`,`POST`),D(f,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(`${f}/*`,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(f,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(`${f}/*`,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(p,`./server/gateway/credentials-handler.ts`,`mcpCredentials`,`ALL`),D(l,`./server/agent-card.ts`,`agentCard`,`GET`),D(c,`./server/agent-card.ts`,`a2a`,`POST`)],k=e({id:`internal.mcp`,version:`1.
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{runtimeTemplate as r}from"../../templates.js";import{collectVersionGroups as i,findVersionedDirectories as a}from"../../../versions/version-groups.js";import{MCP_CREDENTIALS_THEME_ENTITY_KEY as o,MCP_IGNORED_ROUTES_ENTITY_KEY as s}from"../../../../shared/constants/mcp.js";import{A2A_ROUTE as c,AGENT_CARD_ROUTE as l,MCP_AUTHORIZATION_SERVER_ROUTE as u,MCP_AUTHORIZE_ROUTE as d,MCP_CALLBACK_ROUTE as f,MCP_CREDENTIALS_ROUTE as p,MCP_PROTECTED_RESOURCE_ROUTE as m,MCP_REGISTER_ROUTE as h,MCP_ROUTE as g,MCP_SERVER_CARD_ROUTE as _,MCP_SETUP_TEMPLATE_ID as v,MCP_TOKEN_ROUTE as y,PUBLIC_MCP_ROUTE as b}from"./constants.js";import{buildMcpAppData as x}from"./app-data.js";import{readCredentialsTheme as S}from"./credentials-theme.js";import{mcpContent as C,scanMcpToolFiles as w}from"./content-tools.js";import{collectIgnoredRouteSlugs as T}from"./ignored-routes.js";import{findMcpRedirectConflict as E}from"./redirects.js";function D(e,t,n,r){return{path:e,auth:`manual`,...r?{method:r}:{},handler:{filePath:t,importer:import.meta.url,exportName:n}}}const O=[D(g,`./server/handler.ts`,`mcp`),D(b,`./server/handler.ts`,`mcpPublic`),D(_,`./server/server-card.ts`,`mcpServerCard`,`GET`),D(m,`./server/oauth/discovery.ts`,`oauthProtectedResource`,`GET`),D(u,`./server/oauth/discovery.ts`,`oauthAuthorizationServer`,`GET`),D(h,`./server/oauth/register.ts`,`mcpRegister`,`POST`),D(d,`./server/oauth/authorize.ts`,`mcpAuthorize`,`GET`),D(y,`./server/oauth/token.ts`,`mcpToken`,`POST`),D(f,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(`${f}/*`,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(f,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(`${f}/*`,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(p,`./server/gateway/credentials-handler.ts`,`mcpCredentials`,`ALL`),D(l,`./server/agent-card.ts`,`agentCard`,`GET`),D(c,`./server/agent-card.ts`,`a2a`,`POST`)],k=e({id:`internal.mcp`,version:`1.10.0`,content:C,server:{routes:O},templates:{[v]:r(n(`./client/template.tsx`,import.meta.url))},async finalize(e){let n=E(e.config.redirects);if(n)throw Error(`Redirect "${n.from}" references the reserved MCP route "${n.route}". Remove it: the MCP endpoints are served by the internal.mcp plugin and a redirect would shadow them.`);let r={mcp:x(e.config)},{entities:c,problems:l}=w(e),u=await S(e.io,e.config.palette,t=>e.logger.debug(t));c.push(t(u,{stableKey:o}));let d=e.config.mcp?.ignore??[];if(d.length===0)return{appData:r,problems:l,entities:c};let f=await i({io:e.io,routes:e.routes,versionedDirectories:a(e.routes.all())}),p=T(e.routes.all(),d,f,e.localeContext);return p.length===0?{appData:r,problems:l,entities:c}:(e.logger.debug(`mcp.ignore: hiding ${p.length} routes from the MCP tools`),c.push(t(p,{stableKey:s})),{appData:r,problems:l,entities:c})}});export{k as mcpContentPlugin};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SLUG as t,skillMarkdownPath as n}from"../../../utils/skill-paths.js";import{A2A_ROUTE as r,MCP_ROUTE as i,MCP_SERVER_CARD_ROUTE as a}from"../constants.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"./config-gate.js";import{SKILL_ENTITY_TYPE as l}from"../../../types/skill-entity.js";import{
|
|
1
|
+
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SLUG as t,skillMarkdownPath as n}from"../../../utils/skill-paths.js";import{A2A_ROUTE as r,MCP_ROUTE as i,MCP_SERVER_CARD_ROUTE as a}from"../constants.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"./config-gate.js";import{SKILL_ENTITY_TYPE as l}from"../../../types/skill-entity.js";import{publicBaseUrl as u}from"../../../utils/request-origin.js";import{isEntityScopeVisible as d}from"../../../../../server/rbac/entity-scope.js";import{notFoundResponse as f}from"../../../../../server/plugin-context.js";import{CORS_ANY_ORIGIN as p,MCP_AUTH_SCHEMES as m}from"./oauth/constants.js";import"./auth.js";const h=[`text/plain`],g=[`text/plain`],_={streaming:!1,pushNotifications:!1},v={"Cache-Control":`no-store`};async function y(t,r){let i=!!t.request.viewer?.isAuthenticated;return o(c(t.config))&&!i?[]:(await t.entities.list({type:l})).flatMap(i=>{let{slug:a,title:o,description:s}=i.metadata??{};return typeof a!=`string`||!d(i,t.request.teams,e=>t.logger?.warn(e))?[]:[{id:a,name:o??a,description:s??``,tags:[],url:`${r}${e(n(a))}`}]})}async function b(t,n){if(s(n.config)||n.config.skills?.hide===!0)return f();t.set(`realmCacheControlOwned`,!0);let a=u(n.config,n.request),l=o(c(n.config)),d=n.config.seo;return t.json({name:d?.title||d?.projectTitle||`Developer Documentation`,description:d?.description||`Documentation agent card announcing this site's agent skills and MCP server.`,url:`${a}${e(r)}`,documentationUrl:`${a}${e(`/`)}`,version:`0.0.1`,protocolVersion:`0.3.0`,preferredTransport:`HTTP+JSON`,capabilities:{..._,extensions:[{uri:`https://modelcontextprotocol.io`,description:`Model Context Protocol server exposing the documentation tools and skills.`,params:{url:`${a}${e(i)}`,...l?{authentication:{required:!0,schemes:[...m]}}:{}}}]},defaultInputModes:h,defaultOutputModes:g,skills:await y(n,a)},200,{...v,...p})}function x(n,r){if(s(r.config))return f();let i=[`<${e(a)}>; rel="mcp-server-card"`];return r.config.skills?.hide!==!0&&i.push(`<${e(t)}>; rel="agent-skills"`),n.json({error:{code:`405`,message:`Method not allowed`}},405,{Link:i.join(`, `),...p,"Access-Control-Expose-Headers":`Link`})}export{x as a2a,b as agentCard};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{MCP_AUTHORIZATION_SERVER_ROUTE as t,MCP_PROTECTED_RESOURCE_ROUTE as n,PUBLIC_MCP_ROUTE as r}from"../constants.js";import{ANONYMOUS_VIEWER as i}from"../../../../../shared/types/auth.js";import{canAccessMcpFeature as a,isMcpContentProtected as o,isPublicEndpointServed as s,resolveMcpAccess as c}from"./config-gate.js";import{
|
|
1
|
+
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{MCP_AUTHORIZATION_SERVER_ROUTE as t,MCP_PROTECTED_RESOURCE_ROUTE as n,PUBLIC_MCP_ROUTE as r}from"../constants.js";import{ANONYMOUS_VIEWER as i}from"../../../../../shared/types/auth.js";import{canAccessMcpFeature as a,isMcpContentProtected as o,isPublicEndpointServed as s,resolveMcpAccess as c}from"./config-gate.js";import{publicOrigin as l}from"../../../utils/request-origin.js";import{getBearerVerifier as u,getSessionIssuer as d}from"../../../../../server/auth/middleware.js";import{isAssistantAnonymousToken as f}from"../../../../../server/ask-ai/assistant-anonymous-token.js";import{CORS_ANY_ORIGIN as p,CORS_EXPOSE_CHALLENGE as m,SUPPORTED_MCP_SCOPES as h}from"./oauth/constants.js";function g(e){let t=/^Bearer\s+(\S+)$/i.exec((e??``).trim());return t?t[1]:null}function _(r,i){let a=i?[`error="${i.code}"`,`error_description="${i.description}"`]:[];return a.push(`resource_metadata="${r}${e(n)}"`,`scope="${h.join(` `)}"`,`authorization_uri="${r}${e(t)}"`),`Bearer ${a.join(`, `)}`}function v(e,t){return t?`${e}. A public endpoint that serves anonymous-accessible content is available at ${t}.`:e}function y(e,t,n){return new Response(JSON.stringify(t),{status:e,headers:{"Content-Type":`application/json`,"Cache-Control":`no-store`,...n}})}function b(e,t){return y(401,{error:`unauthorized`,message:v(`Authentication required`,t)},{"WWW-Authenticate":_(e),...m})}function x(e,t){return y(401,{error:`invalid_token`,message:v(`Invalid or expired token`,t)},{"WWW-Authenticate":_(e,{code:`invalid_token`,description:`Invalid or expired token`}),...m})}function S(){return y(403,{error:`forbidden`,message:`You do not have access to this MCP server`},{...p})}async function C(t){let{c:n,ctx:p}=t,m=e=>p.logger?.warn(e),h=c(p.config),_=o(h);if(t.forceAnonymous){let e=await p.withViewer(i);return a(h,e.request.teams,!1,m)?{kind:`allow`,ctx:e,isProtected:_}:{kind:`deny`,response:S()}}let v=t=>{let n=l(p.request);return{kind:`deny`,response:t(n,s(p.config,h)?`${n}${e(r)}`:void 0)}},y=p.request.viewer??i,C,w,T=p,E=g(n.req.header(`authorization`)),D=d(n)?.artifactSecret,O=E!==null&&D!==void 0&&await f(E,D);if(!_)w=O||E===null?void 0:E;else if(O)y=i,T=await p.withViewer(i);else if(E!==null){let e=await u(n)?.(E);if(!e)return v(x);y=e.viewer,C=e.claims,w=E,T=await p.withViewer(y)}else if(!y.isAuthenticated)return v(b);return a(h,T.request.teams,y.isAuthenticated,m)?{kind:`allow`,ctx:T,isProtected:_,accessToken:w,claims:C}:{kind:`deny`,response:S()}}export{C as authorizeMcpRequest,o as isMcpContentProtected,s as isPublicEndpointServed,g as readBearerToken,c as resolveMcpAccess};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{AI_METADATA_HEADER as e}from"../constants.js";import{isMcpHidden as t,isPublicEndpointServed as n,resolveMcpAccess as r}from"./config-gate.js";import{
|
|
1
|
+
import{AI_METADATA_HEADER as e}from"../constants.js";import{isMcpHidden as t,isPublicEndpointServed as n,resolveMcpAccess as r}from"./config-gate.js";import{publicOrigin as i}from"../../../utils/request-origin.js";import{formatError as a,jsonRpcErrorResponse as o}from"./tool-errors.js";import{buildMcpFileTools as s,createCustomTool as c,invokeCustomTool as l}from"./custom-tools.js";import{notFoundResponse as u}from"../../../../../server/plugin-context.js";import{authorizeMcpRequest as d}from"./auth.js";import{EXECUTE_DEADLINE_MS as f}from"./codemode/constants.js";import{resolveMcpMode as p,resolveRequestInstructionsStyle as m,resolveRequestMcpMode as h}from"./mode.js";import{narrowMcpConfigForCaller as g}from"./gateway/caller-api-calls.js";import{isGatewayEnabled as _}from"./gateway/env.js";import{userSubject as v}from"./gateway/subject.js";import{parseUserAgent as y}from"./mcp-client.js";import{createMcpTelemetry as b}from"./mcp-telemetry.js";import{applyMcpRateLimit as x}from"./rate-limit.js";import{createToolRegistry as S}from"./tool-registry.js";import{mcpToolRegistry as C}from"./registry-instance.js";const w=`POST`;function T(e){return(e??``).split(`,`).some(e=>{let[t,...n]=e.split(`;`).map(e=>e.trim().toLowerCase());if(t!==`text/html`)return!1;let r=n.find(e=>e.startsWith(`q=`));return r===void 0||Number(r.slice(2))>0})}function E(){return o(405,`Method not allowed`,{Allow:w})}function D(e){let t={error:`Method Not Allowed`,message:`In order to use this MCP server, you need to register it in your MCP client (VS Code, Cursor, Claude Code, etc.) using this URL: ${e}`};return new Response(JSON.stringify(t),{status:405,headers:{"Content-Type":`application/json`,"Cache-Control":`no-store`,Allow:w}})}function O(){return o(501,`MCP transport is not available in this environment`)}function k(e){if(!e)return{};try{let t=JSON.parse(e);return typeof t==`object`&&t&&!Array.isArray(t)?t:{}}catch{return{}}}function A(t,n,r,i){let a=k(t.headers.get(e)),{userAgent:o}=n.request,{client:s,clientVersion:c}=y(o),l=h(t.url,p()),u=crypto.randomUUID(),d=v(n.request.viewer),f=n.request.ip??void 0;return{config:{...n.config,mcp:g(n.config.mcp,a)},entities:n.entities,hasRoute:e=>n.hasRoute(e),isSlugVisible:(e,t)=>n.isSlugVisible(e,t),kv:n.kv,logger:n.logger,pageMarkdown:n.pageMarkdown,search:n.search,request:n.request,metadata:a,mcpMode:l,instructionsStyle:m(t.url),requestId:u,executeDeadline:i,messageId:typeof a.messageId==`string`?a.messageId:void 0,callerSubject:d,client:s,clientVersion:c,accessToken:r.accessToken,isProtected:r.isProtected??!1,isAvailableMemo:/* @__PURE__ */ new Map,subprocess:n.subprocess,claims:r.claims,telemetry:b({userAgent:o,request:t,metadata:a,mode:l,requestId:u,callerSubject:d,clientIp:f,logger:n.logger})}}async function j(e){let t=_(e.config)?(await import(`./gateway/index.js`)).gatewayTools():[],n=e.subprocess?e.mcpToolEntries??[]:[],r=C.list(),i=/* @__PURE__ */ new Set([...r.map(e=>e.schema.name),...t.map(e=>e.schema.name),...n.map(e=>e.declaration.name)]),a=e.subprocess?await s({entities:e.entities,loadContentModule:e.loadContentModule,reservedNames:i,logger:e.logger}):[];if(t.length===0&&n.length===0&&a.length===0)return C;let o=S();for(let e of r)o.register(e);for(let e of t)o.register(e);for(let e of n)o.register(c(e));for(let e of a)o.register(e);return o}async function M(e,t,n,r={}){let i=await j(e),o;try{o=await import(`./mcp-server.js`)}catch(t){return e.logger?.error(`MCP transport failed to load: ${a(t)}`),async()=>O()}let s;return o.createMcpRequestHandler({registry:i,logger:e.logger,buildToolContext:r=>s??=A(r,e,t,n),onError:r.onError})}function N(e={}){return async(a,o,s)=>{let c=Date.now()+f;if(t(s.config)||e.publicEndpoint&&!n(s.config,r(s.config)))return u();if(a.req.method===`GET`&&T(a.req.header(`accept`)))return o();let l=await x({kv:s.kv,ip:s.request.ip,bucket:`mcp`,logger:s.logger});if(l)return l;let p=await d({c:a,ctx:s,forceAnonymous:e.forceAnonymous});return p.kind===`deny`?p.response:a.req.method===`GET`?D(`${i(s.request)}${new URL(s.request.url).pathname}`):a.req.method===`POST`?(await M(p.ctx,{isProtected:p.isProtected,accessToken:p.accessToken,claims:p.claims},c))(a.req.raw):E()}}const P=N(),F=N({forceAnonymous:!0,publicEndpoint:!0});export{A as buildToolContext,N as createMcpHandler,M as createServedMcpRequestHandler,l as invokeCustomTool,P as mcp,F as mcpPublic};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{withPathPrefix as e}from"../../../../../../shared/path-prefix.js";import{MCP_AUTHORIZATION_SERVER_ROUTE as t,MCP_AUTHORIZE_ROUTE as n,MCP_REGISTER_ROUTE as r,MCP_ROUTE as i,MCP_TOKEN_ROUTE as a}from"../../constants.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"../config-gate.js";import{
|
|
1
|
+
import{withPathPrefix as e}from"../../../../../../shared/path-prefix.js";import{MCP_AUTHORIZATION_SERVER_ROUTE as t,MCP_AUTHORIZE_ROUTE as n,MCP_REGISTER_ROUTE as r,MCP_ROUTE as i,MCP_TOKEN_ROUTE as a}from"../../constants.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"../config-gate.js";import{publicOrigin as l}from"../../../../utils/request-origin.js";import{notFoundResponse as u}from"../../../../../../server/plugin-context.js";import{CORS_ANY_ORIGIN as d,SUPPORTED_MCP_GRANT_TYPES as f,SUPPORTED_MCP_SCOPES as p}from"./constants.js";import"../auth.js";function m(e){return!s(e.config)&&o(c(e.config))}function h(n,r){if(!m(r))return u();let a=l(r.request);return n.json({resource:`${a}${e(i)}`,authorization_servers:[a],bearer_methods_supported:[`header`],resource_documentation:`${a}${e(t)}`,scopes_supported:[...p],bearer_token_types_supported:[`Bearer`]},200,{...d})}function g(t,i){if(!m(i))return u();let o=l(i.request);return t.json({issuer:o,authorization_endpoint:`${o}${e(n)}`,token_endpoint:`${o}${e(a)}`,scopes_supported:[...p],registration_endpoint:`${o}${e(r)}`,response_types_supported:[`code`],grant_types_supported:[...f],subject_types_supported:[`public`],id_token_signing_alg_values_supported:[`RS256`],code_challenge_methods_supported:[`S256`],token_endpoint_auth_methods_supported:[`none`],client_id_metadata_document_supported:!0},200,{...d})}export{g as oauthAuthorizationServer,h as oauthProtectedResource};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{MCP_ROUTE as t}from"../constants.js";import{ANONYMOUS_VIEWER as n}from"../../../../../shared/types/auth.js";import{isMcpContentProtected as r,isMcpHidden as i,resolveMcpAccess as a}from"./config-gate.js";import{
|
|
1
|
+
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{MCP_ROUTE as t}from"../constants.js";import{ANONYMOUS_VIEWER as n}from"../../../../../shared/types/auth.js";import{isMcpContentProtected as r,isMcpHidden as i,resolveMcpAccess as a}from"./config-gate.js";import{publicBaseUrl as o,publicOrigin as s}from"../../../utils/request-origin.js";import{formatError as c}from"./tool-errors.js";import{notFoundResponse as l}from"../../../../../server/plugin-context.js";import{CORS_ANY_ORIGIN as u,MCP_AUTH_SCHEMES as d}from"./oauth/constants.js";import"./auth.js";import{EXECUTE_DEADLINE_MS as f}from"./codemode/constants.js";import{sendMcpServerCardServed as p}from"./mcp-telemetry.js";import{applyMcpRateLimit as m}from"./rate-limit.js";import{createServedMcpRequestHandler as h}from"./handler.js";import{docsServerInfo as g}from"./server-info.js";import{CLIENT_CAPABILITIES_META_KEY as _,CLIENT_INFO_META_KEY as v,LATEST_PROTOCOL_VERSION as y,PROTOCOL_VERSION_META_KEY as b}from"@modelcontextprotocol/server";const x=`2026-07-28`,S=[`dynamic`],C={capabilities:{},tools:S};async function w(e,t,n){let r=await e(new Request(t,{method:`POST`,headers:{"content-type":`application/json`,accept:`application/json, text/event-stream`,"mcp-protocol-version":x,"mcp-method":n},body:JSON.stringify({jsonrpc:`2.0`,id:1,method:n,params:{_meta:{[b]:x,[v]:{name:`server-card`,version:`1.0`},[_]:{}}}})}));if(r.ok)return(await r.json()).result}function T(e,t){e.logger?.warn(`MCP server card lists dynamic tools: ${c(t)}`)}async function E(r,i){let a=await r.withViewer(n),o=await h(a,{isProtected:i},Date.now()+f,{onError:e=>T(r,e)}),c=new URL(e(t),s(r.request)).href,[l,u]=await Promise.all([w(o,c,`server/discover`),i?void 0:w(o,c,`tools/list`)]);if(!l)return;if(i)return{capabilities:l.capabilities,tools:S};if(!u)return;let d=u.tools.map(({name:e,title:t,description:n,inputSchema:r,annotations:i})=>({name:e,title:t,description:n,inputSchema:r,annotations:i}));return{capabilities:l.capabilities,instructions:l.instructions,tools:d.length>0?d:S}}async function D(n,s){if(i(s.config))return l();n.set(`realmCacheControlOwned`,!0);let c=await m({kv:s.kv,ip:s.request.ip,bucket:`card`,headers:u,logger:s.logger});if(c)return c;let f=g(s.config,s.request),h=r(a(s.config)),_=await E(s,h).catch(e=>{T(s,e)}),{capabilities:v,instructions:b,tools:x}=_??C;return await p({logger:s.logger}),n.json({$schema:`https://static.modelcontextprotocol.io/schemas/mcp-server-card/v1.json`,version:`1.0`,protocolVersion:y,serverInfo:{...f,title:f.name},description:f.description,documentationUrl:o(s.config,s.request),transport:{type:`streamable-http`,endpoint:e(t)},capabilities:v,authentication:h?{required:!0,schemes:[...d]}:void 0,instructions:b,tools:x},200,{...u,"Cache-Control":_?`public, max-age=3600`:`no-store`})}export{D as mcpServerCard};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{skillMarkdownPath as t}from"../../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as n}from"../../../types/skill-entity.js";import{
|
|
1
|
+
import{withPathPrefix as e}from"../../../../../shared/path-prefix.js";import{skillMarkdownPath as t}from"../../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as n}from"../../../types/skill-entity.js";import{publicOrigin as r}from"../../../utils/request-origin.js";import{isEntityScopeVisible as i}from"../../../../../server/rbac/entity-scope.js";async function a(a){if(a.config.skills?.hide===!0)return[];let o=await a.entities.list({type:n}),s=r(a.request),c=e=>i(e,a.request.teams,e=>a.logger?.warn(e));return o.flatMap(n=>{let{slug:r,title:i,description:o}=n.metadata??{};return typeof r!=`string`||!c(n)?[]:[{slug:r,title:i??r,description:o??``,uri:`${s}${e(t(r))}`,read:async()=>(await a.entities.load(n.key)).content}]})}export{a as loadSkillResources};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{createPluginScopedId as n}from"../../utils/scoped-id.js";import{SEARCH_GROUP_FACET_FIELD as r}from"../../../../shared/search/facets.js";import{configuredFacetFields as i,extractFacetsFromFrontmatter as a,invalidFacetValueProblems as o,searchCategoryOf as s}from"../../../search/facet-values.js";import{isObject as c}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as l}from"../../../../shared/utils/routes/normalize-route-slug.js";import{notInPlanProblem as u}from"../../../plan-gates.js";import{filePathToRouteSlug as d}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{isPlanFeatureGranted as f}from"../../../../shared/plan-gates.js";import{isInternalPagePath as p}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as m}from"../../utils/explicit-slugs.js";import{SOURCE_TEMPLATE_PREFIX as h}from"../../../../shared/constants/template-ids.js";import{
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{createPluginScopedId as n}from"../../utils/scoped-id.js";import{SEARCH_GROUP_FACET_FIELD as r}from"../../../../shared/search/facets.js";import{configuredFacetFields as i,extractFacetsFromFrontmatter as a,invalidFacetValueProblems as o,searchCategoryOf as s}from"../../../search/facet-values.js";import{isObject as c}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as l}from"../../../../shared/utils/routes/normalize-route-slug.js";import{notInPlanProblem as u}from"../../../plan-gates.js";import{filePathToRouteSlug as d}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{isPlanFeatureGranted as f}from"../../../../shared/plan-gates.js";import{isInternalPagePath as p}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as m}from"../../utils/explicit-slugs.js";import{SOURCE_TEMPLATE_PREFIX as h}from"../../../../shared/constants/template-ids.js";import{curationKeywordsOf as g}from"../../../search/keywords.js";import{readPageFrontmatter as _}from"./frontmatter.js";const v=[`.page.tsx`,`.page.ts`],y=`internal.react-page`,b=`search`,x=t(n(y,`search`),async e=>({value:e.args}),{searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let{category:n,isInvalid:c}=s(t.route.metadata),{facets:l,invalidFields:u}=a(t.route.metadata,i(t.config)),d={docKey:`page`,routeSlug:t.route.slug,title:e.title,text:e.text,groupKey:n??`Documentation`,facets:l};return e.keywords!==void 0&&(d.keywords=e.keywords),{docs:[d],problems:o([...u,...c?[r]:[]],t.route.originFilePath)}}});function S(e){if(e.excludeFromSearch===!0)return;let t=c(e.search)?e.search:{},n=c(e.seo)?e.seo:{},r=e=>typeof e==`string`?e.trim():``,i=r(t.title)||r(n.title)||r(e.title),a=r(t.description)||r(n.description)||r(e.description);if(i===``&&a===``)return;let o={title:i,text:[a,...Array.isArray(t.keywords)?t.keywords.filter(e=>typeof e==`string`):[]].filter(e=>e!==``).join(` `)},s=g(t.keywords);return s!==void 0&&(o.keywords=s),o}const C=t(n(y,`seo`),async e=>{let{result:t,entityDeps:n,assetUsages:r}=await e.markdown.resolveImageReference(e.args.image,e.file.path);return t.kind===`assetRef`?{value:{image:t.url},entityDeps:n,assetUsages:r}:{value:{image:e.args.image},entityDeps:n}}),w=e({id:y,version:`1.12.0`,loaders:[C,x],content:{filter:{extensions:v},async extractFile(e,t){if(p(e.path))return{routes:[]};if(!f(t.config,`reactPages`))return{routes:[],problems:[u(`React pages`)]};let{frontmatter:n,error:r}=_(await t.io.readFile(e.path));r!==void 0&&t.logger.warn(`Ignoring the frontmatter export of a page component`,{path:e.path,error:r});let i=m(n?.slug),a=c(n?.seo)&&typeof n.seo.image==`string`?n.seo.image:void 0,o=n===null?void 0:S(n),s={};a!==void 0&&(s.seo=C.withArgs({filePath:e.path,image:a})),o!==void 0&&(s[b]=x.withArgs(o,{stableKey:`react-page:search:${e.path}`}));let g=Object.keys(s).length===0?void 0:s,v=`${h}${e.path}`;return{routes:i.length>0?i.map(e=>({routeId:`page`,slug:l(e),template:v,metadata:n??void 0,deps:g})):[{routeId:`page`,slugHint:d(e.path,T(e.path)),template:v,metadata:n??void 0,deps:g}]}}}});function T(e){return e.toLowerCase().endsWith(`.page.ts`)?`.page.ts`:`.page.tsx`}export{b as REACT_PAGE_SEARCH_LOADER_KEY,w as reactPageContentPlugin};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
|
|
2
2
|
import type { NAV_ITEM_RBAC, RbacScope } from '../../../../server/rbac/types.js';
|
|
3
3
|
import type { Logger } from '../../../../shared/logger.js';
|
|
4
|
+
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
4
5
|
import type { ProblemDraft } from '../../../problems/types.js';
|
|
5
6
|
import { type LinkRefDraft } from '../../../link-checker/classify.js';
|
|
6
7
|
import type { RouteIndex } from '../../utils/route-index.js';
|
|
@@ -11,7 +12,7 @@ export type SidebarBadge = {
|
|
|
11
12
|
position?: 'before' | 'after';
|
|
12
13
|
};
|
|
13
14
|
export type BundledSidebarNode = {
|
|
14
|
-
type?:
|
|
15
|
+
type?: SidebarItemType;
|
|
15
16
|
label?: string;
|
|
16
17
|
/** The theme shows this key's translation, `label` when it has none. */
|
|
17
18
|
labelTranslationKey?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{L10N_DIR as e}from"../../../../shared/constants/l10n/defaults.js";import{isObject as t}from"../../../../shared/utils/is-object.js";import"../../../../shared/utils/l10n.js";import{resolveContentPath as n}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as r}from"../assets/extensions.js";import{splitUrlSuffix as i}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as a}from"../../../../server/rbac/filter.js";import{resolvePageTarget as o}from"../../../../shared/utils/routes/resolve-page-target.js";import{collectVersionGroups as s,findVersionedDirectories as c}from"../../../versions/version-groups.js";import{joinSrcSet as l,parseSrcSet as u}from"../assets/srcset.js";import{classifyLinkTarget as d}from"../../../link-checker/classify.js";import{posix as f}from"node:path";import p from"js-yaml";function m(e){return typeof e.tab==`string`}function h(e,t,n){e.report?.({code:t,message:n,location:{filePath:e.file.path}})}function g(e,r){let i=p.load(e);if(!Array.isArray(i))return[];let a=[],o=e=>{if(t(e)){if(typeof e.$ref==`string`){let t=n(e.$ref,r);t!==null&&a.push(t)}if(Array.isArray(e.items))for(let t of e.items)o(t);if(m(e)&&Array.isArray(e.menu))for(let t of e.menu)o(t)}};for(let e of i)o(e);return a}async function _(e){let t=p.load(e.source);if(!Array.isArray(t))return[];let n=[];return await v({entries:t,ownerFilePath:e.filePath,currentFilePath:e.filePath,readFile:e.readFile,visitedRefs:/* @__PURE__ */ new Set([e.filePath]),refs:n}),n}async function v(e){let{ownerFilePath:t,currentFilePath:r,readFile:i,refs:a}=e;for(let o of e.entries){let s=W(o);if(s===void 0)continue;if(typeof s.$ref==`string`){let o=n(s.$ref,r);if(o===null||i===void 0||e.visitedRefs.has(o))continue;let c;try{c=await i(o)}catch{continue}let l=p.load(c);if(!Array.isArray(l))continue;let u=new Set(e.visitedRefs);u.add(o),await v({entries:l,ownerFilePath:t,currentFilePath:o,readFile:i,visitedRefs:u,refs:a});continue}let c=typeof s.page==`string`?s.page:s.href;typeof c==`string`&&y(a,c,r,t),Array.isArray(s.items)&&await v({...e,entries:s.items}),m(s)&&Array.isArray(s.menu)&&await v({...e,entries:s.menu})}}function y(e,t,n,r){let i=d(t,n);i!==null&&e.push({kind:`link`,raw:t,...i,...n===r?{}:{filePath:n}})}async function b(e){let t=p.load(e.source);if(!Array.isArray(t))throw Error(`Sidebar "${e.file.path}" must be a YAML sequence at the top level.`);return x({...e,entries:t})}async function x(e){let n=e.entries,r=n.filter(e=>t(e)&&m(e));if(r.length>0&&r.length!==n.length)throw Error(`Sidebar "${e.file.path}": when a sidebar uses navigation tabs, every top-level entry must be a tab (found ${n.length-r.length} other entries).`);let i={file:e.file,routes:e.routes,assignedRouteSlugs:/* @__PURE__ */ new Set,versionedDirectories:/* @__PURE__ */ new Set,report:e.report,readFile:e.readFile,skipRoutes:e.skipRoutes,exists:e.exists,sidebarByDirectory:e.sidebarByDirectory??/* @__PURE__ */ new Map,visitedRefs:/* @__PURE__ */ new Set([e.file.path])},a=[];if(r.length>0){for(let[e,t]of r.entries())a.push(await M({...i,entry:t,tabIndex:e}));F({file:e.file,tabs:a,routes:e.routes})}else for(let e of n)a.push(...await S({...i,entry:e}));return{assignedRouteSlugs:[...i.assignedRouteSlugs].sort(),versionedDirectories:[...i.versionedDirectories].sort(),nodes:a}}async function S(e){let n=await C(e),r=t(e.entry)?e.entry.rbac:void 0;if(r===void 0)return n;let i=P({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=W(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${U(e.entry)} is not a page reference or a group.`),[];if(m(t))throw Error(`Sidebar "${e.file.path}": "tab" is only allowed at the top level (found nested tab "${t.tab}").`);if(t.menu!==void 0)throw Error(`Sidebar "${e.file.path}": "menu" is only allowed directly on a tab.`);if(typeof t.$ref==`string`)return T({...e,ref:t.$ref});if(typeof t.directory==`string`&&K(t.group)!==void 0&&t.items===void 0)return C({...e,entry:{...t,directory:void 0,items:[{directory:t.directory,flatten:t.flatten}]}});if(typeof t.directory==`string`){let r=n(t.directory,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(r);i.length===0&&h(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await L({...e,directoryPath:r,flatten:t.flatten===!0,pages:i.filter(t=>!e.skipRoutes?.has(t.slug))}),o=K(t.group)??K(t.label);return o===void 0?a:[{...J(t,e),menuStyle:Y(t),items:a.length>0?a:void 0,label:o,labelTranslationKey:w(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...J(t,e),label:t.separator,labelTranslationKey:K(t.separatorTranslationKey)}];let r=await z(t,e),i=r.route;if(i)for(let t of c([i]))e.versionedDirectories.add(t);let a;if(Array.isArray(t.items)){a=[];for(let n of t.items)a.push(...await S({...e,entry:n}))}let o=K(t.group)??K(t.label)??(i===void 0?K(t.href):void 0)??r.anchor,s=K(t.group)!==void 0;return[{...J(t,e),menuStyle:s?Y(t):void 0,external:t.external===!0||void 0,languageInsensitive:r.languageInsensitive?!0:void 0,items:a&&a.length>0?a:void 0,label:o,labelTranslationKey:w(t),link:r.link,isGroup:s?!0:void 0,version:K(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e){return K(K(e.group)===void 0?e.labelTranslationKey:e.groupTranslationKey)}async function T(e){let{ref:t}=e,r=n(t,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is outside the content root.`),[];if(e.readFile===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is not supported here.`),[];if(e.visitedRefs.has(r))return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" includes itself.`),[];let i;try{i=await e.readFile(r)}catch{return h(e,`sidebar/missing-target`,`Sidebar $ref "${r}" could not be read.`),[]}let a=p.load(i);return Array.isArray(a)?E(e,r,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" must be a YAML sequence.`),[])}async function E(e,t,n){let r=/* @__PURE__ */ new Set([...e.visitedRefs,t]),i=[];for(let a of n)i.push(...await S({...e,entry:a,file:{path:t},visitedRefs:r}));return i}async function D(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?E({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(O)):[]}function O(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function k(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function A(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function j(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw A({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw A({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw A({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw A({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw A({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw A({file:t,label:r,message:`has an empty "menu"`});if(n.$ref!==void 0||n.directory!==void 0||n.group!==void 0||n.href!==void 0)throw A({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function M(e){let{entry:t}=e,n=t.tab;j({file:e.file,entry:t});let r=k(e.tabIndex,n);if(t.menu!==void 0){let i=Array.isArray(t.menu)?t.menu:[],a=[];for(let[t,n]of i.entries()){let i=await N({...e,tabId:r,index:t,raw:n});i!==void 0&&a.push(i)}return{tab:!0,tabId:r,label:n,menu:a,...X(t.icon,e),...P({...e,rbac:t.rbac})}}let[i]=await S({...e,entry:{page:t.page,label:n,items:t.items,rbac:t.rbac}}),a=i?.items??[];return{...i,tab:!0,tabId:r,...X(t.icon,e),items:a}}async function N(e){let{file:t,entry:n,tabId:r,index:i,raw:a}=e,o=n.tab,s=W(a);if(s===void 0||typeof s.page!=`string`)throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" needs "page".`);if(s.page.includes(`#`))throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" page must not contain a heading anchor.`);let c=`${r}/${i}`,[l]=await S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function P(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function F(e){let t=/* @__PURE__ */ new Map,n=(n,r)=>{for(let i of r){let r=t.get(i);if(r!==void 0&&r.tabId!==n.tabId)throw Error(`Sidebar "${e.file.path}": route "${i}" is claimed by two navigation tabs, "${r.label}" and "${n.label}". A route can belong to one tab only.`);t.set(i,n)}};for(let t of e.tabs){if(t.menu!==void 0){for(let r of t.menu)r.tabId!==void 0&&n({tabId:r.tabId,label:`${t.label} > ${r.label??r.link}`},I({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},I({routes:e.routes,link:t.link,items:t.items}))}}function I(e){let t=[],n=n=>{if(n.link===void 0||n.languageInsensitive===!0)return;let r=e.routes.bySlug(n.link);r!==void 0&&r.originFilePath!==null&&t.push(r.slug)};n({link:e.link});let r=e=>{if(e!==void 0)for(let t of e)n(t),r(t.items)};return r(e.items),t}async function L(t){let n=t.directoryPath===``?``:`${t.directoryPath}/`,r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Set,o=t.directoryPath.startsWith(`${e}/`),s=t.pages.filter(e=>o||e.locale===``).map(e=>({route:e,relativePath:e.originFilePath?.startsWith(n)?e.originFilePath.slice(n.length):null})).sort((e,t)=>R(e.relativePath??e.route.slug,t.relativePath??t.route.slug));for(let e of s){let n=e.relativePath?.split(`/`).slice(0,-1)??[],r=c(n);if(r!==void 0){if(!a.has(r.path)){a.add(r.path);let e=await D(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}V(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({link:e.route.slug,version:e.route.version??void 0,versionGroup:e.route.versionGroup??void 0})}return r;function c(e){for(let n=0;n<=e.length;n++){let r=f.join(t.directoryPath,...e.slice(0,n)),i=t.sidebarByDirectory.get(r);if(i!==void 0&&!t.visitedRefs.has(i))return{depth:n,path:i}}}function l(e,n){return t.flatten?[]:e.slice(0,n).filter(e=>!e.startsWith(`@`))}function u(e){let t=r,n=``;for(let r of e){n=n===``?r:`${n}/${r}`;let e=i.get(n);if(e){t=e;continue}let a=[];t.push({items:a,label:r}),i.set(n,a),t=a}return t}}function R(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function z(e,t){if(typeof e.page==`string`){let{path:n,suffix:r,anchor:a}=i(e.page.trim()),o=await B(n,t);return o?(e.disconnect!==!0&&V(o,t),{link:`${o.slug}${r}`,anchor:a,route:o}):{}}if(typeof e.href==`string`){let n=e.href;if(n.startsWith(`/`)){let e=t.routes.bySlug(n);return e?{link:e.slug,route:e}:{link:n,languageInsensitive:!0}}return{link:n,languageInsensitive:!0}}return{}}async function B(e,t){let r=o(e,t.file.path,t.routes);if(r.kind===`escaped`){h(t,`sidebar/invalid-entry`,`Sidebar page "${e}" is outside the content root.`);return}if(r.kind===`missing`){let r=n(e,t.file.path);r!==null&&await t.exists?.(r)&&h(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return r.value}function V(e,t){t.assignedRouteSlugs.add(e.slug)}async function H(e){if(e.versionedDirectories.length===0)return;let t=await s({io:e.io,routes:e.routes,versionedDirectories:e.versionedDirectories}),n=e=>{for(let r of e){if(r.version!==void 0&&r.versionGroup!==void 0){let e=t.get(r.versionGroup),n=e?.labels.get(r.version);n&&(r.versionLabel=n),e?.defaultVersion===r.version&&(r.isDefaultVersion=!0)}r.items&&n(r.items),r.menu&&n(r.menu)}};n(e.nodes)}function U(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function W(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function G(e){if(!Array.isArray(e))return;let n=[];for(let r of e){let e=t(r)?K(r.name):void 0;t(r)&&e!==void 0&&n.push({name:e,color:K(r.color),icon:K(r.icon),position:r.position===`before`||r.position===`after`?r.position:void 0})}return n.length>0?n:void 0}function K(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function q(e,t){return t.find(t=>t===e)}function J(e,t){return{badges:G(e.badges),...X(e.icon,t),expanded:e.expanded===!0?`true`:q(e.expanded,[`always`]),selectFirstItemOnExpand:e.selectFirstItemOnExpand===!0||void 0,separatorLine:e.separatorLine===!0||void 0,linePosition:q(e.linePosition,[`top`,`bottom`]),target:K(e.target),sublabel:K(e.sublabel)}}function Y(e){return q(e.menuStyle,[`drilldown`,`drilldown-header`])}function X(e,n){let r=t(e)?K(e.srcSet):void 0;if(r!==void 0){let e=u(r);if(e===null)return{srcSet:r};for(let t of e)t.src=Z(t.src,n);return{srcSet:l(e)}}let i=K(e);return i===void 0?{}:{icon:Z(i,n)}}function Z(e,t){if(!r(e))return e;let i=n(e,t.file.path);return i===null?(h(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${i}`}export{b as bundleSidebar,x as bundleSidebarEntries,_ as collectSidebarLinkRefs,g as collectSidebarRefTargets,H as stampDefaultVersions};
|
|
1
|
+
import{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){let e=t(r)?J(r.name):void 0;t(r)&&e!==void 0&&n.push({name:e,color:J(r.color),icon:J(r.icon),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};
|
|
@@ -2,6 +2,7 @@ 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
4
|
import { NAV_ITEM_RBAC, type RbacScope } from '../../../../server/rbac/types.js';
|
|
5
|
+
import type { SidebarItemType } from '../../../../shared/types/sidebar.js';
|
|
5
6
|
import { SIDEBAR_ROUTE_DEP_KEY } from '../../../../shared/constants/route-deps.js';
|
|
6
7
|
export declare const SIDEBAR_PLUGIN_ID = "internal.sidebar";
|
|
7
8
|
export declare const SIDEBAR_AGGREGATOR_LOADER_ID: "internal.sidebar:aggregate";
|
|
@@ -10,7 +11,7 @@ export declare const SIDEBAR_FILENAME_REGEX: RegExp;
|
|
|
10
11
|
/** A folder's own sidebar; a named `*.sidebars.yaml` is not one. */
|
|
11
12
|
export declare const FOLDER_SIDEBAR_FILENAME_REGEX: RegExp;
|
|
12
13
|
export type ResolvedSidebarItem = {
|
|
13
|
-
type?:
|
|
14
|
+
type?: SidebarItemType;
|
|
14
15
|
label?: string;
|
|
15
16
|
labelTranslationKey?: string;
|
|
16
17
|
link?: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import"../../../../shared/constants/l10n/defaults.js";import{NAV_ITEM_RBAC as i}from"../../../../server/rbac/types.js";import{compareStrings as a}from"../../../../shared/utils/compare-strings.js";import{isObject as o}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as s}from"../../../../shared/utils/l10n.js";import{resolveContentPath as c}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as l}from"../assets/extensions.js";import{splitUrlSuffix as u}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolvePageTarget as d}from"../../../../shared/utils/routes/resolve-page-target.js";import{toPublicVersionedSlug as f}from"../../../../shared/constants/versions.js";import{collectVersionGroups as p,findVersionedDirectories as ee}from"../../../versions/version-groups.js";import{publicLink as m}from"../../../versions/public-link.js";import{linkedPageAccess as h}from"../../utils/link-access.js";import{safeDecodeURI as g}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as _,parseSrcSet as v}from"../assets/srcset.js";import{bundleSidebar as y,bundleSidebarEntries as te,collectSidebarLinkRefs as b,collectSidebarRefTargets as ne,stampDefaultVersions as x}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as S,sidebarStartEntityKey as re}from"./contributions.js";import{applySubtree as C}from"./subtree.js";import{collectSlugOverrides as w}from"../../utils/slug-overrides.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as ie,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as T,SIDEBAR_ROUTE_DEP_KEY as E,localizedSidebarDepKey as D}from"../../../../shared/constants/route-deps.js";import{SITE_START_ENTITY_KEY as ae}from"../../../../shared/constants/site-start.js";import{posix as O}from"node:path";import{REDOCLY_TEAMS_RBAC as k}from"@redocly/config";const A=`internal.sidebar`,j=r(A,`aggregate`),M=/(^|\/)(?:[^/]*\.)?sidebars\.ya?ml$/i,N=/(^|\/)sidebars\.ya?ml$/i,P=`sidebars.yaml`,F=`redocly.yaml`;function I(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function L(e){if(Array.isArray(e))return e.find(e=>R(e.label)!==void 0)?.label}function R(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function z(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function B(e,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,a=e?await t.loadEntity(e):void 0,o=r.tabId!==void 0,s=o?{...r,isGroup:!0,label:r.label??L(a)}:r,c=a===void 0?[s]:C(s,a);for(let e of c){let a=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],s=e[k]??(a===void 0&&e.link!==void 0?t.accessOf(e.link)??void 0:void 0);n.push({type:e.type,expanded:e.expanded,selectFirstItemOnExpand:e.selectFirstItemOnExpand,external:e.external,target:e.target,languageInsensitive:e.languageInsensitive,icon:e.icon===void 0?void 0:await t.resolveAsset(e.icon),srcSet:e.srcSet===void 0?void 0:await V(e.srcSet,t),items:e.items?await B(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await B(e.menu,t):void 0,label:o?e.label??z(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?f(e.link,e.versionGroup,e.version,e.isDefaultVersion===!0):e.link,separatorLine:e.separatorLine,linePosition:e.linePosition,variant:e.variant,menuStyle:e.menuStyle,sublabel:e.sublabel,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,httpVerb:e.httpVerb,deprecated:e.deprecated,badges:e.badges,[k]:s,[i]:a})}}return n}async function V(e,t){let n=v(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return _(r)}function H(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!l(r))return r;let i=await e.resolveImageReference(r,``),a=c(g(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function U(e){return e.tabId!==void 0}function W(e){return U(e)&&e.link!==void 0}function G(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[k]:e[k],[i]:e[i]}}function K(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function q(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(W).map(K)}}const J=t(j,async e=>{let t=H(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,o=i.length===0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:i}),c=await B(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??s(e,n)))??a(e),accessOf:t=>h(t,e.routes,o),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(U).map(q)}:c,...t.collected()}});async function oe(e){let t=await e.loadEntity(e.subtreeKey);return B(C({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function se(e){let t=typeof e==`string`?e:o(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function Y(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function X(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(C({link:r},await t.entities.load(i)))}return n}function ce(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function le(e){let t=[];for(let n of await e.list({type:S}))t.push(...await e.load(n.key));return t}function ue(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function de(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=fe(e,t,n);return r===null?null:{item:e,link:r.link,label:await Z(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=c(i,F),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function fe(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=u(e.page.trim()),o=d(r,F,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${m(s,n)}${i}`,anchor:a,route:s}}async function Z(e,t,n){let r=R(e.label)??R(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,a=i?await n(i):void 0;return(o(a)?R(a.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function pe(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?f(t.link,t.versionGroup,t.version,!0):t.link}function me(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&N.test(e))??t).link}function he(e){let t=null;for(let{slug:n,originFilePath:r,locale:i,versionGroup:o}of e)r!==null&&i===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&a(n,t)<0)&&(t=n);return t}const ge=e({id:A,version:`1.23.0`,content:{filter:{match:e=>M.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await b({source:n,filePath:e.path,readFile:t.io.readFile})}}},async finalize(e){let t=[],r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Map,o=/* @__PURE__ */ new Map,s=[],c=/* @__PURE__ */ new Map,l=/* @__PURE__ */ new Map,d=[],f=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),m=e.routes.all(),g=w(m,e.localeContext),_=ee(m),v=_.length>0?_:void 0;f.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let b=new Map(f.map(({path:e,source:t})=>[e,t])),S=/* @__PURE__ */ new Map;for(let{path:e}of f)N.test(e)&&S.set(O.dirname(e),e);let C=/* @__PURE__ */ new Set;for(let{path:e,source:t}of f)for(let n of ne(t,e))C.add(n);let A={routes:e.routes,report:e=>r.push(e),readFile:async t=>b.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:S},j=async(n,r)=>{if(n.nodes.length===0)return;await x({io:e.io,routes:e.routes,logger:e.logger,nodes:n.nodes,versionedDirectories:_});let i=J.withArgs({nodes:n.nodes,versionedDirectories:v},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),l.set(i,n.nodes);let a=/* @__PURE__ */ new Map;for(let r of e.localeContext.locales){let e=J.withArgs({nodes:n.nodes,locale:r,slugOverrides:g[r]??{},versionedDirectories:v});t.push(e),a.set(r,e)}return c.set(i,a),i};for(let{path:t,source:n}of f){if(C.has(t))continue;let c=await y({...A,file:{path:t},source:n}),l=await j(c,t);if(l===void 0)continue;a.set(t,l);let u=t.startsWith(`@l10n/`)?null:$(c.nodes);u!==null&&d.push({path:t,link:u}),s.push(await X(c,e));for(let e of c.assignedRouteSlugs){let n=o.get(e);n!==void 0&&r.push({code:`sidebar/route-conflict`,message:`Page "${e}" is in sidebars ${n} and ${t}; it shows ${t}.`,location:{filePath:t}}),i.set(e,l),o.set(e,t)}}ce(i,s);let M=new Map(m.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=M.get(t);if(e===void 0||e.originFilePath===null)continue;let o=se(n);if(o===null)continue;let s=O.normalize(o.startsWith(`/`)?o.slice(1):O.join(O.dirname(e.originFilePath),o)),c=a.get(s);if(c===void 0){r.push({code:`sidebar/missing-target`,message:`Front matter sidebar "${o}" is not a sidebar file of this project.`,location:{filePath:e.originFilePath}});continue}i.set(e.slug,c)}let F=await le(e.entities),I=/* @__PURE__ */ new Set,L=/* @__PURE__ */ new Map,R=/* @__PURE__ */ new Map;for(let t of F){let n=i.get(t.route);if(n===void 0){let r=await te({...A,file:{path:P},entries:t.entries});if(n=await j(r),n===void 0)continue;let a=(await X(r,e)).keys();for(let e of[...r.assignedRouteSlugs,...a])i.has(e)||(i.set(e,n),I.add(e))}let r=L.get(n);L.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=R.get(n);R.set(n,a===void 0?t.breadcrumbs??[]:ue(a,t.breadcrumbs))}if(f.length===0&&m.length>0){let e=await y({...A,file:{path:P},source:`- directory: .
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import"../../../../shared/constants/l10n/defaults.js";import{NAV_ITEM_RBAC as i}from"../../../../server/rbac/types.js";import{compareStrings as a}from"../../../../shared/utils/compare-strings.js";import{isObject as o}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as s}from"../../../../shared/utils/l10n.js";import{resolveContentPath as c}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as l}from"../assets/extensions.js";import{splitUrlSuffix as u}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolvePageTarget as d}from"../../../../shared/utils/routes/resolve-page-target.js";import{toPublicVersionedSlug as f}from"../../../../shared/constants/versions.js";import{collectVersionGroups as p,findVersionedDirectories as ee}from"../../../versions/version-groups.js";import{publicLink as m}from"../../../versions/public-link.js";import{linkedPageAccess as h}from"../../utils/link-access.js";import{safeDecodeURI as g}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as _,parseSrcSet as v}from"../assets/srcset.js";import{bundleSidebar as y,bundleSidebarEntries as te,collectSidebarLinkRefs as b,collectSidebarRefTargets as ne,stampDefaultVersions as x}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as S,sidebarStartEntityKey as re}from"./contributions.js";import{applySubtree as C}from"./subtree.js";import{collectSlugOverrides as w}from"../../utils/slug-overrides.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as ie,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as T,SIDEBAR_ROUTE_DEP_KEY as E,localizedSidebarDepKey as D}from"../../../../shared/constants/route-deps.js";import{SITE_START_ENTITY_KEY as ae}from"../../../../shared/constants/site-start.js";import{posix as O}from"node:path";import{REDOCLY_TEAMS_RBAC as k}from"@redocly/config";const A=`internal.sidebar`,j=r(A,`aggregate`),M=/(^|\/)(?:[^/]*\.)?sidebars\.ya?ml$/i,N=/(^|\/)sidebars\.ya?ml$/i,P=`sidebars.yaml`,F=`redocly.yaml`;function I(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function L(e){if(Array.isArray(e))return e.find(e=>R(e.label)!==void 0)?.label}function R(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function z(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function B(e,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,a=e?await t.loadEntity(e):void 0,o=r.tabId!==void 0,s=o?{...r,isGroup:!0,label:r.label??L(a)}:r,c=a===void 0?[s]:C(s,a);for(let e of c){let a=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],s=e[k]??(a===void 0&&e.link!==void 0?t.accessOf(e.link)??void 0:void 0);n.push({type:e.type,expanded:e.expanded,selectFirstItemOnExpand:e.selectFirstItemOnExpand,external:e.external,target:e.target,languageInsensitive:e.languageInsensitive,icon:e.icon===void 0?void 0:await t.resolveAsset(e.icon),srcSet:e.srcSet===void 0?void 0:await V(e.srcSet,t),items:e.items?await B(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await B(e.menu,t):void 0,label:o?e.label??z(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?f(e.link,e.versionGroup,e.version,e.isDefaultVersion===!0):e.link,separatorLine:e.separatorLine,linePosition:e.linePosition,variant:e.variant,menuStyle:e.menuStyle,sublabel:e.sublabel,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,httpVerb:e.httpVerb,deprecated:e.deprecated,badges:e.badges,[k]:s,[i]:a})}}return n}async function V(e,t){let n=v(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return _(r)}function H(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!l(r))return r;let i=await e.resolveImageReference(r,``),a=c(g(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function U(e){return e.tabId!==void 0}function W(e){return U(e)&&e.link!==void 0}function G(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[k]:e[k],[i]:e[i]}}function K(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function q(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(W).map(K)}}const J=t(j,async e=>{let t=H(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,o=i.length===0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:i}),c=await B(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??s(e,n)))??a(e),accessOf:t=>h(t,e.routes,o),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(U).map(q)}:c,...t.collected()}});async function oe(e){let t=await e.loadEntity(e.subtreeKey);return B(C({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function se(e){let t=typeof e==`string`?e:o(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function Y(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function X(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(C({link:r},await t.entities.load(i)))}return n}function ce(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function le(e){let t=[];for(let n of await e.list({type:S}))t.push(...await e.load(n.key));return t}function ue(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function de(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=fe(e,t,n);return r===null?null:{item:e,link:r.link,label:await Z(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=c(i,F),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function fe(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=u(e.page.trim()),o=d(r,F,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${m(s,n)}${i}`,anchor:a,route:s}}async function Z(e,t,n){let r=R(e.label)??R(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,a=i?await n(i):void 0;return(o(a)?R(a.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function pe(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?f(t.link,t.versionGroup,t.version,!0):t.link}function me(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&N.test(e))??t).link}function he(e){let t=null;for(let{slug:n,originFilePath:r,locale:i,versionGroup:o}of e)r!==null&&i===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&a(n,t)<0)&&(t=n);return t}const ge=e({id:A,version:`1.23.1`,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
2
|
`,skipRoutes:I}),t=await j(e);if(t!==void 0){for(let n of e.assignedRouteSlugs)i.has(n)||i.set(n,t);let n=$(e.nodes);n!==null&&d.push({path:P,link:n})}}let z=me(d)??he(m);if(z!==null){let{path:e}=u(z);t.push(n(e,{stableKey:ae}))}let B=/* @__PURE__ */ new Map;for(let e of m){if(e.originFilePath===null)continue;let t=Y(e);B.set(t,[...B.get(t)??[],e.slug])}for(let[e,t]of[...i]){let n=M.get(e);for(let e of(n&&B.get(Y(n)))??[])i.has(e)||i.set(e,t)}let V=/* @__PURE__ */ new Map,H=(e.config.navbar?.items??[]).filter(e=>e.linkedSidebars?.length),U=/* @__PURE__ */ new Map,W=R.size===0&&H.length===0||v===void 0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:v});for(let[t,n]of await de(H,e.routes,W,a,t=>e.entities.load(t)))R.set(t,[n,...R.get(t)??[]]);let G=({label:t,link:n,icon:r})=>({label:t,link:n,icon:r,[k]:h(n,e.routes,W)??void 0});for(let[e,r]of L){if(r===null)continue;let i=n(G(r));t.push(i),V.set(e,i)}for(let[e,r]of R){if(r.length===0)continue;let i=n(r.map(G));t.push(i),U.set(e,i)}for(let r of new Set(F.map(e=>e.route))){let a=i.get(r),o=a===void 0?void 0:l.get(a),s=o===void 0?null:pe(o,e.routes.bySlug(r)?.version??null);s!==null&&t.push(n(s,{stableKey:re(r)}))}return{entities:t,attach:[...i.entries()].map(([e,t])=>{let n={[E]:t},r=V.get(t);r!==void 0&&(n[ie]=r);let i=U.get(t);if(i!==void 0&&(n[T]=i),M.get(e)?.locale===``)for(let[e,r]of c.get(t)??[])n[D(e)]=r;return{slug:e,deps:n}}),problems:r}},loaders:[J]});export{N as FOLDER_SIDEBAR_FILENAME_REGEX,j as SIDEBAR_AGGREGATOR_LOADER_ID,M as SIDEBAR_FILENAME_REGEX,A as SIDEBAR_PLUGIN_ID,E as SIDEBAR_ROUTE_DEP_KEY,I as isTabbedSidebar,oe as resolveAutoSidebar,ge as sidebarContentPlugin};
|
|
@@ -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{
|
|
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{publicOrigin as o}from"../../../utils/request-origin.js";import{isEntityScopeVisible as s}from"../../../../../server/rbac/entity-scope.js";import{notFoundResponse as c}from"../../../../../server/plugin-context.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 c();let f=o(d.request),p=await d.entities.list({type:i}),m=await Promise.all(p.map(async n=>{let{slug:i,title:a,description:o}=n.metadata??{};if(typeof i!=`string`||!s(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:o??``,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 c();let n=e.req.param(`slug`)??``,r=a(n),i=await t.entities.get(r);if(!i||!s(i,t.request.teams,e=>t.logger?.warn(e)))return c();let{content:o}=await t.entities.load(r);return e.body(o,200,{"Content-Type":`text/markdown; charset=utf-8`,...l})}export{f as skillMarkdown,d as skillsIndex};
|
|
@@ -37,12 +37,22 @@ export type SearchFragmentUse = {
|
|
|
37
37
|
* string or a list of strings; a document matches a filter when any of its values is selected.
|
|
38
38
|
*/
|
|
39
39
|
export type SearchDocumentFacets = Record<string, string | string[]>;
|
|
40
|
+
/**
|
|
41
|
+
* Search curation. A query that contains one of `includes` shows the document before the
|
|
42
|
+
* ranked hits; a query that contains one of `excludes` does not show the document. A query
|
|
43
|
+
* contains a keyword when it has the keyword's words next to each other, in the same order,
|
|
44
|
+
* in any case. `excludes` wins over `includes`. A keyword of more than 10 words is ignored.
|
|
45
|
+
*/
|
|
46
|
+
export type SearchDocumentKeywords = {
|
|
47
|
+
includes?: string[];
|
|
48
|
+
excludes?: string[];
|
|
49
|
+
};
|
|
40
50
|
/**
|
|
41
51
|
* One full-text search document an entity contributes; `docKey` is unique per entity.
|
|
42
52
|
* `groupKey` is the display label the search dialog groups hits under. `anchor` is the
|
|
43
53
|
* fragment a hit opens at (`routeSlug#anchor`), for documents that cover one page section.
|
|
44
|
-
* `facets` are the document's values for the facets configured in
|
|
45
|
-
* picked by the producer from its source's metadata. `rbacScope` (an operation's `x-rbac`)
|
|
54
|
+
* `facets` are the document's values for the default facets and the facets configured in
|
|
55
|
+
* `search.filters.facets`, picked by the producer from its source's metadata. `rbacScope` (an operation's `x-rbac`)
|
|
46
56
|
* narrows the route's audience to the viewers it also admits; it never widens it.
|
|
47
57
|
*/
|
|
48
58
|
export type SearchDocument = {
|
|
@@ -54,6 +64,7 @@ export type SearchDocument = {
|
|
|
54
64
|
groupKey?: string;
|
|
55
65
|
facets?: SearchDocumentFacets;
|
|
56
66
|
rbacScope?: RbacScope;
|
|
67
|
+
keywords?: SearchDocumentKeywords;
|
|
57
68
|
httpMethod?: string;
|
|
58
69
|
httpPath?: string;
|
|
59
70
|
deprecated?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{splitUrlSuffix as e}from"../../../shared/utils/routes/split-url-suffix.js";import{toPhysicalVersionedSlug as t}from"../../../shared/constants/versions.js";
|
|
1
|
+
import{splitUrlSuffix as e}from"../../../shared/utils/routes/split-url-suffix.js";import{toPhysicalVersionedSlug as t}from"../../../shared/constants/versions.js";function n(t,n,i){if(!t.startsWith(`/`))return;let{path:a}=e(t),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(e,n){let r=[...n].sort(([e],[t])=>t.length-e.length);for(let[n,i]of r){if(!i.defaultVersion)continue;let r=t(e,n,i.defaultVersion);if(r!==null&&r!==e)return r}return null}export{n as linkedPageAccess};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Problem, ProblemCategory, ProblemDraft, ProblemSeverity } from './types.js';
|
|
2
|
+
type ProblemCodeDefaults = {
|
|
3
|
+
category: ProblemCategory;
|
|
4
|
+
severity: ProblemSeverity;
|
|
5
|
+
};
|
|
6
|
+
/** Problems a new load of the same input can clear; ingest marks their entities stale. */
|
|
7
|
+
export declare const RETRYABLE_PROBLEM_CODES: readonly string[];
|
|
8
|
+
export declare function resolveProblemDefaults(code: string): ProblemCodeDefaults;
|
|
9
|
+
export declare function createProblem(draft: ProblemDraft): Problem;
|
|
10
|
+
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
const e={"link/missing-target":{category:`links`,severity:`error`},"link/missing-anchor":{category:`links`,severity:`error`},"markdoc/parse-error":{category:`markdown`,severity:`error`},"markdoc/validation-error":{category:`markdown`,severity:`error`},"markdown/frontmatter-parse":{category:`markdown`,severity:`warning`},"search/facet-invalid":{category:`search`,severity:`warning`},"spec/parse-failed":{category:`spec`,severity:`error`},"routing/slug-collision":{category:`routing`,severity:`error`},"routing/reserved-slug":{category:`routing`,severity:`error`},"routing/wildcard-shadowing":{category:`routing`,severity:`warning`},"plugin/extract-failed":{category:`plugin`,severity:`error`},"plugin/extract-all-failed":{category:`plugin`,severity:`error`},"plugin/finalize-failed":{category:`plugin`,severity:`error`},"plugin/loader-failed":{category:`plugin`,severity:`error`},"plugin/searchable-failed":{category:`plugin`,severity:`error`},"plugin/static-file-invalid":{category:`plugin`,severity:`error`},"plugin/static-file-conflict":{category:`plugin`,severity:`error`},"configuration/invalid":{category:`configuration`,severity:`error`},"configuration/ignored":{category:`configuration`,severity:`warning`},"configuration/deprecated":{category:`configuration`,severity:`warning`},"configuration/l10n-invalid":{category:`configuration`,severity:`error`},"configuration/l10n-layout":{category:`configuration`,severity:`warning`},"configuration/l10n-translations-invalid":{category:`configuration`,severity:`warning`},"configuration/app-data-namespace-conflict":{category:`configuration`,severity:`error`},"configuration/attach-conflict":{category:`configuration`,severity:`error`},"configuration/package-not-allowed":{category:`configuration`,severity:`error`},"sidebar/missing-target":{category:`configuration`,severity:`warning`},"sidebar/invalid-entry":{category:`configuration`,severity:`warning`},"sidebar/route-conflict":{category:`configuration`,severity:`warning`},"scorecard/lint-failed":{category:`spec`,severity:`warning`},"react-page/render-failed":{category:`page`,severity:`error`},"system/ingest-failed":{category:`system`,severity:`error`}},t={category:`plugin`,severity:`error`};function
|
|
1
|
+
const e={"link/missing-target":{category:`links`,severity:`error`},"link/missing-anchor":{category:`links`,severity:`error`},"markdoc/parse-error":{category:`markdown`,severity:`error`},"markdoc/validation-error":{category:`markdown`,severity:`error`},"markdoc/diagram-service-failed":{category:`markdown`,severity:`warning`},"markdown/frontmatter-parse":{category:`markdown`,severity:`warning`},"search/facet-invalid":{category:`search`,severity:`warning`},"spec/parse-failed":{category:`spec`,severity:`error`},"routing/slug-collision":{category:`routing`,severity:`error`},"routing/reserved-slug":{category:`routing`,severity:`error`},"routing/wildcard-shadowing":{category:`routing`,severity:`warning`},"plugin/extract-failed":{category:`plugin`,severity:`error`},"plugin/extract-all-failed":{category:`plugin`,severity:`error`},"plugin/finalize-failed":{category:`plugin`,severity:`error`},"plugin/loader-failed":{category:`plugin`,severity:`error`},"plugin/searchable-failed":{category:`plugin`,severity:`error`},"plugin/static-file-invalid":{category:`plugin`,severity:`error`},"plugin/static-file-conflict":{category:`plugin`,severity:`error`},"configuration/invalid":{category:`configuration`,severity:`error`},"configuration/ignored":{category:`configuration`,severity:`warning`},"configuration/deprecated":{category:`configuration`,severity:`warning`},"configuration/l10n-invalid":{category:`configuration`,severity:`error`},"configuration/l10n-layout":{category:`configuration`,severity:`warning`},"configuration/l10n-translations-invalid":{category:`configuration`,severity:`warning`},"configuration/app-data-namespace-conflict":{category:`configuration`,severity:`error`},"configuration/attach-conflict":{category:`configuration`,severity:`error`},"configuration/package-not-allowed":{category:`configuration`,severity:`error`},"sidebar/missing-target":{category:`configuration`,severity:`warning`},"sidebar/invalid-entry":{category:`configuration`,severity:`warning`},"sidebar/route-conflict":{category:`configuration`,severity:`warning`},"scorecard/lint-failed":{category:`spec`,severity:`warning`},"react-page/render-failed":{category:`page`,severity:`error`},"system/ingest-failed":{category:`system`,severity:`error`}},t=[`markdoc/diagram-service-failed`],n={category:`plugin`,severity:`error`};function r(t){return e[t]??n}function i(e){let t=r(e.code);return{code:e.code,category:t.category,severity:e.severity??t.severity,message:e.message,location:e.location,data:e.data}}export{t as RETRYABLE_PROBLEM_CODES,i as createProblem,r as resolveProblemDefaults};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{entities as e}from"../database/schema.js";import{runWithSqliteBusyRetry as t}from"../database/connection.js";import{and as n,eq as r}from"drizzle-orm";async function i(i,a){let[o]=await i.db.select({id:e.id,isCurrent:e.isCurrent}).from(e).where(n(r(e.key,a.key),r(e.revisionCreatedAt,a.revisionCreatedAt))).limit(1);return o?o.isCurrent===1?`refused-current`:(await t(()=>i.db.delete(e).where(r(e.id,o.id)),{operation:`delete entity revision`}),`deleted`):`not-found`}export{i as deleteEntityRevision};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{ContentParser as e}from"./content-parser.js";import{
|
|
1
|
+
import{ContentParser as e}from"./content-parser.js";import{Statistic as t}from"./radix-tree/statistic.js";import{DocumentField as n}from"./field.js";var r=class{fields=[];limit;parser=new e(new t);constructor(e){this.limit=e.limit;for(let t of e.fields)this.fields.push(new n(t))}search(e,t={}){let n=a(this.parser.getQueryTokens(e));if(n.length===0)return[];let r=e=>t.terms?.get(e)??/* @__PURE__ */ new Set([e]),o=this.fields.map(e=>({field:e,matches:e.match(n,r)})),s=t.documentFrequencies===void 0?i(o.filter(({field:e})=>e.countsTowardFrequency).map(({matches:e})=>e),n):new Map(n.map(e=>[e,t.documentFrequencies?.get(e)??0])),c=/* @__PURE__ */ new Map,l=/* @__PURE__ */ new Map;for(let{field:e,matches:t}of o){let r=e.rank(t,n,s);for(let[t,{rank:n,offsets:i,tokens:a}]of Object.entries(r)){let r=Number(t),o=c.get(r);o?(o.rank+=n*e.weight,o.fields.push({name:e.name,offsets:i,tokens:a})):c.set(r,{id:r,rank:n*e.weight,fields:[{name:e.name,offsets:i,tokens:a}]});let s=l.get(r);s||l.set(r,s=/* @__PURE__ */ new Set);for(let e of a)s.add(e)}}let u=n.filter(e=>!t.optional?.has(e)),d=u.length>0?u:n;for(let e of c.values()){let t=l.get(e.id),n=d.filter(e=>t?.has(e)).length;e.rank*=n/d.length}return Array.from(c.values()).sort((e,t)=>t.rank-e.rank).slice(0,this.limit)}};function i(e,t){let n=/* @__PURE__ */ new Map;for(let r of t){let t=/* @__PURE__ */ new Set;for(let n of e)for(let[e,i]of n)i[r]?.length&&t.add(e);n.set(r,t.size)}return n}function a(e){return[...new Set([...e].reverse())].reverse()}export{r as SearchEngine};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{SEARCH_GROUP_FACET_FIELD as e,SEARCH_PRODUCT_FACET_FIELD as t,SEARCH_TEAMS_FACET_FIELD as n,SEARCH_VERSION_FACET_FIELD as r,isReservedSearchFacetField as i,searchVersionFacetValue as a}from"../../shared/search/facets.js";import{normalizeFacetValue as o}from"./facet-values.js";function
|
|
1
|
+
import{SEARCH_GROUP_FACET_FIELD as e,SEARCH_PRODUCT_FACET_FIELD as t,SEARCH_TEAMS_FACET_FIELD as n,SEARCH_VERSION_FACET_FIELD as r,isReservedSearchFacetField as i,searchVersionFacetValue as a}from"../../shared/search/facets.js";import{normalizeFacetValue as o}from"./facet-values.js";import{SEARCH_HIDE_FACET_FIELD as s,SEARCH_PIN_FACET_FIELD as c,curationPhrase as l}from"./keywords.js";function u(u){let d={},{facets:f,onDropped:p}=u;if(f!==void 0){if(typeof f!=`object`||!f||Array.isArray(f))p?.(`facets`,`not-an-object`);else for(let[e,t]of Object.entries(f)){if(i(e)){p?.(e,`reserved`);continue}if(!u.configuredFields.has(e))continue;let n=o(t);if(n===null){p?.(e,`invalid`);continue}let r=n.filter(e=>e.length<=500);r.length<n.length&&p?.(e,`too-long`),r.length>0&&(d[e]=r)}}if(d[e]=[u.groupKey||`Results`],u.teams.length>0&&(d[n]=[...new Set(u.teams)]),u.version!==null){let{group:e,version:t}=u.version;d[r]=[a(e,t)]}u.product!==null&&(d[t]=[u.product]);let m=e=>{let t=/* @__PURE__ */ new Set;for(let n of(e??[]).map(l))n!==``&&(n.length>500?p?.(`keywords`,`too-long`):n.split(` `).length>10?p?.(`keywords`,`too-many-words`):t.add(n));return t},h=m(u.keywords?.excludes),g=[...m(u.keywords?.includes)].filter(e=>!h.has(e));return g.length>0&&(d[c]=g),h.size>0&&(d[s]=[...h]),d}export{u as buildDocumentFacets};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { SearchDocumentKeywords } from '../plugins/types/search.js';
|
|
2
|
+
/** Curation: the query phrases that show the document before the ranked hits. */
|
|
3
|
+
export declare const SEARCH_PIN_FACET_FIELD = "redocly_pin";
|
|
4
|
+
/** Curation: the query phrases that hide the document. */
|
|
5
|
+
export declare const SEARCH_HIDE_FACET_FIELD = "redocly_hide";
|
|
6
|
+
/** The most words a curation keyword has; a longer keyword is not stored. */
|
|
7
|
+
export declare const CURATION_MAX_KEYWORD_WORDS = 10;
|
|
8
|
+
/**
|
|
9
|
+
* The front matter `keywords` object (`{ includes, excludes }`) as curation keywords;
|
|
10
|
+
* undefined for another shape or when both lists are empty. A number or boolean item
|
|
11
|
+
* becomes its string, as in the classic engine; other items are dropped.
|
|
12
|
+
*/
|
|
13
|
+
export declare function curationKeywordsOf(value: unknown): SearchDocumentKeywords | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* A keyword or a query as the curation compares them: its query tokens joined by one space.
|
|
16
|
+
* A query contains a keyword when ` <query> ` contains ` <keyword> `.
|
|
17
|
+
*/
|
|
18
|
+
export declare function curationPhrase(text: string): string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{isObject as e}from"../../shared/utils/is-object.js";import{tokenizeSearchQuery as t}from"./tokenize.js";const n=`redocly_pin`,r=`redocly_hide`;function i(t){if(!e(t))return;let n=e=>Array.isArray(e)?e.filter(e=>[`string`,`number`,`boolean`].includes(typeof e)).map(e=>String(e)):[],r=n(t.includes),i=n(t.excludes);if(r.length!==0||i.length!==0)return{...r.length>0?{includes:r}:{},...i.length>0?{excludes:i}:{}}}function a(e){return t(e).join(` `)}export{r as SEARCH_HIDE_FACET_FIELD,n as SEARCH_PIN_FACET_FIELD,i as curationKeywordsOf,a as curationPhrase};
|