@redocly/framework 1.0.0-next.4 → 1.0.0-next.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundler/build/output-metadata.js +1 -1
- package/dist/bundler/build/run.js +1 -1
- package/dist/bundler/build/vite-config.js +2 -2
- package/dist/bundler/dev/materialization-sweeper.js +1 -1
- package/dist/bundler/dev/routes/dev-problems-route.js +1 -1
- package/dist/bundler/dev/routes/source-sync-route.js +1 -1
- package/dist/bundler/dev/run.js +1 -1
- package/dist/bundler/dev/runtime-app.js +1 -1
- package/dist/bundler/dev/vite-chunk-url.js +1 -1
- package/dist/bundler/user-markdoc-schema.js +1 -1
- package/dist/bundler/vite-config.base.js +3 -3
- package/dist/cli/commands/build.js +1 -1
- package/dist/cli/commands/dev.js +1 -1
- package/dist/cli/commands/ingest.js +1 -1
- package/dist/cli/commands/translate.js +2 -2
- package/dist/cli/dev-console/index.js +1 -1
- package/dist/cli/log-output/index.js +1 -1
- package/dist/cli/validate-react-pages.js +1 -1
- package/dist/client/RuntimeLink.js +1 -1
- package/dist/client/ai-search/use-ai-search.js +1 -1
- package/dist/client/analytics-page-view.js +1 -1
- package/dist/client/app.js +3 -3
- package/dist/client/client-entry.js +1 -1
- package/dist/client/contexts.js +1 -1
- package/dist/client/dev-problems/ProblemsBar.js +1 -1
- package/dist/client/feedback.js +1 -1
- package/dist/client/l10n/use-l10n-config.js +1 -1
- package/dist/client/products.js +1 -1
- package/dist/client/review/ReviewBar.js +50 -50
- package/dist/client/review/use-review.js +1 -1
- package/dist/client/sidebar/SidebarDataProvider.js +1 -1
- package/dist/client/sidebar/drilldown.js +1 -1
- package/dist/client/ssr.js +1 -1
- package/dist/client/telemetry/config.js +1 -1
- package/dist/client/use-entity-revisions.js +1 -1
- package/dist/client/use-page-versions.js +1 -1
- package/dist/client/use-search.js +1 -1
- package/dist/client/webmcp/tools/shared.js +1 -1
- package/dist/client/webmcp/tools/site-tools.js +1 -1
- package/dist/client/webmcp/use-webmcp-tools.js +1 -1
- package/dist/content-layer/config.js +1 -1
- package/dist/content-layer/database/invalidation.js +26 -26
- package/dist/content-layer/ingest/finalize-phase.js +1 -1
- package/dist/content-layer/ingest/normalize-artifacts.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/load-view.js +1 -1
- package/dist/content-layer/link-checker/validate.js +1 -1
- package/dist/content-layer/loaders/context.js +1 -1
- package/dist/content-layer/markdown/client/markdown-text.js +1 -1
- package/dist/content-layer/markdown/constants/builtin-tags.js +1 -1
- package/dist/content-layer/markdown/constants/markdown-text-tag-set.js +1 -1
- package/dist/content-layer/markdown/constants/tag-sets.js +1 -1
- package/dist/content-layer/markdown/nodes/heading.js +1 -1
- package/dist/content-layer/markdown/resolve/ast.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/operation-samples.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc-resolvers/partial.js +1 -1
- package/dist/content-layer/markdown/resolve/markdoc.js +1 -1
- package/dist/content-layer/markdown/resolve/references.js +1 -1
- package/dist/content-layer/markdown/search/to-markdown.js +1 -1
- package/dist/content-layer/markdown/search/to-sections.js +1 -1
- package/dist/content-layer/markdown/server/render.js +1 -1
- package/dist/content-layer/markdown/service.js +1 -1
- package/dist/content-layer/markdown/tags/partial.d.ts +7 -2
- package/dist/content-layer/markdown/tags/partial.js +1 -1
- package/dist/content-layer/markdown/tags/variant.js +1 -1
- package/dist/content-layer/markdown/types/service.d.ts +2 -0
- package/dist/content-layer/markdown/utils/parse-cache.js +1 -1
- package/dist/content-layer/markdown/utils/reparse-example-fences.d.ts +4 -1
- package/dist/content-layer/markdown/utils/reparse-example-fences.js +1 -1
- package/dist/content-layer/markdown/utils/substitute-variables.js +1 -1
- package/dist/content-layer/markdown/utils/walk-markdoc-ast.d.ts +2 -2
- package/dist/content-layer/markdown/utils/walk-markdoc-ast.js +1 -1
- package/dist/content-layer/plugins/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/client/template.js +2 -2
- package/dist/content-layer/plugins/internal/api-docs/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-docs.js +13 -13
- package/dist/content-layer/plugins/internal/api-docs/server/options.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/banner.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/index.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/client/use-catalog-classic.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/index.js +1 -1
- package/dist/content-layer/plugins/internal/index.js +1 -1
- package/dist/content-layer/plugins/internal/markdoc/client/template.js +1 -1
- package/dist/content-layer/plugins/internal/markdoc/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/constants.d.ts +6 -0
- package/dist/content-layer/plugins/internal/mcp/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/ignored-routes.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/audit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/capabilities.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/codemode/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/discover.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/execute-schema.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/execution-budget.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/codemode/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/prompts.js +8 -8
- package/dist/content-layer/plugins/internal/mcp/server/codemode/read-result.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/codemode/return-last-expression.js +6 -0
- package/dist/content-layer/plugins/internal/mcp/server/codemode/returns-from-top-level.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/codemode/sandbox.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/tool-declarations.js +4 -0
- package/dist/content-layer/plugins/internal/mcp/server/codemode/tool-list.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/unknown-tool-hint.js +3 -0
- package/dist/content-layer/plugins/internal/mcp/server/gateway/api-call-operations.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials-page/site-branding.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/elicitation.js +6 -6
- package/dist/content-layer/plugins/internal/mcp/server/gateway/index.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/gateway/subject.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tools.js +4 -4
- package/dist/content-layer/plugins/internal/mcp/server/gateway/upstream-auth-scheme.js +2 -2
- package/dist/content-layer/plugins/internal/mcp/server/mcp-server.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/mcp-telemetry.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/authorize.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/rate-limit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/server-info.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/graphql-constants.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/tools/graphql-document.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/graphql.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-catalog.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-document.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/openapi.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/pages-constants.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/tools/pages-navigation.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/pages.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/tools/schemas.js +1 -0
- package/dist/content-layer/plugins/internal/mcp/server/tools/search.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/submit-feedback.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/tools/whoami.js +1 -1
- package/dist/content-layer/plugins/internal/mock/server/handler.js +1 -1
- package/dist/content-layer/plugins/internal/scorecard-classic/index.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/bundle.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.js +2 -2
- package/dist/content-layer/plugins/internal/skills/index.js +1 -1
- package/dist/content-layer/plugins/project/load.js +2 -2
- package/dist/content-layer/plugins/utils/link-access.js +1 -1
- package/dist/content-layer/plugins/utils/route-index.js +1 -1
- package/dist/content-layer/versions/redirect.js +1 -1
- package/dist/content-layer/versions/resolve.js +1 -1
- package/dist/server/__tests__/rbac-fixture.js +1 -1
- package/dist/server/app.js +3 -3
- package/dist/server/ask-ai/route.js +1 -1
- package/dist/server/auth/middleware.js +1 -1
- package/dist/server/auth/request.js +1 -1
- package/dist/server/auth/routes.js +1 -1
- package/dist/server/constants/system-routes.js +1 -1
- package/dist/server/content.js +13 -13
- package/dist/server/cors-proxy/handler.js +1 -1
- package/dist/server/feedback/route.js +1 -1
- package/dist/server/lambda-entry.js +1 -1
- package/dist/server/manifest-assets.js +4 -4
- package/dist/server/node-entry.js +1 -1
- package/dist/server/plugin-context.js +1 -1
- package/dist/server/rbac/l10n-rules.js +1 -1
- package/dist/server/rbac/team-templates.js +1 -1
- package/dist/server/search/route.js +1 -1
- package/dist/server/seo-tags.js +2 -2
- package/dist/server/static-files/serve.js +1 -1
- package/dist/shared/utils/routes/file-path-to-route-slug.js +1 -1
- package/package.json +2 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{readIgnoredRouteSlugs as e}from"../../ignored-routes.js";import{publicOrigin as t}from"../../../../utils/request-origin.js";import{recoveryToolNames as n}from"./openapi-document.js";import{
|
|
2
|
-
`)}}},
|
|
1
|
+
import{readIgnoredRouteSlugs as e}from"../../ignored-routes.js";import{publicOrigin as t}from"../../../../utils/request-origin.js";import{recoveryToolNames as n}from"./openapi-document.js";import{MAX_PAGE_LINES as r}from"./pages-constants.js";import{GET_PAGE_SCHEMA as i,GREP_PAGES_SCHEMA as a,LIST_PAGES_SCHEMA as o,grepPagesToolSchema as s,listPagesToolSchema as c}from"./schemas.js";import{collectNodeLinks as l,countPages as u,findSection as d,flattenSections as f,loadPageNavigation as p,loadVisiblePages as m,toPageSlug as h,toPublicUrl as g,toSectionId as _}from"./pages-navigation.js";const v=/^(#{1,3}) +(\S.*)$/,y=/^\s*(```|~~~)/,b={schema:o,schemaFor:e=>c(e.mcpMode),async execute(e,n){let{section:r}=e??{},{sections:i}=await p(n),a=t(n.request);if(!r)return{sections:i.map(e=>({id:e.id,title:e.title,items:w(e.id,e.nodes,a)}))};let o=d(i,r,a);if(!o){let e=f(i).slice(0,50).map(({id:e})=>e);throw Error(`No section "${r}". Pass one of these section ids: ${e.join(`; `)}.`)}return{section:{id:o.id,title:o.title},items:w(o.id,o.nodes,a)}}},x={schema:i,async execute(e,i){let{url:a,startLine:o,lines:s}=e??{};if(typeof a!=`string`||a.trim()===``)throw Error(`The "url" parameter is required: a page URL or path.`);let c=t(i.request),l=h(a,c),u=l===null?null:await C(l,i);if(l===null||u===null)throw Error(`No page you can read is at "${a}": it does not exist, or your access does not include it. Do not describe it from other pages. Call ${n(i.mcpMode).listPages} to see the pages you can read.`);let d=D(u.text),f=Math.max(1,Math.floor(o??1));if(f>d.length)throw Error(`Line ${f} is past the end of "${u.title??l}", which has ${d.length} lines.`);let p=T(s,200,r),m=Math.min(d.length,f+p-1);return{url:g(l,c),title:u.title??l,totalLines:d.length,startLine:f,endLine:m,...m<d.length?{nextStartLine:m+1}:{},outline:O(d),content:d.slice(f-1,m).join(`
|
|
2
|
+
`)}}},S={schema:a,schemaFor:e=>s(e.mcpMode),async execute(e,r){let{query:i,section:a,maxMatches:o}=e??{};if(typeof i!=`string`||i===``)throw Error(`The "query" parameter is required: a text to find.`);let s=t(r.request),c,u;if(a){let{sections:e,pages:t}=await p(r),i=d(e,a,s);if(!i)throw Error(`No section "${a}". Call ${n(r.mcpMode).listPages} to see the sections.`);let o=new Set(l(i.nodes));i.link&&o.add(i.link),c=t.filter(e=>o.has(e.slug)),u=i.title}else c=(await m(r)).pages;let f=T(o,20,100),h=i.toLowerCase(),_=c.length,v=[];for(let e of c){let t=(await r.pageMarkdown.readPage(e.slug))?.text??``;if(t.toLowerCase().includes(h))for(let[n,r]of D(t).entries()){let t=r.toLowerCase().indexOf(h);if(t!==-1){if(v.length===f)return{matches:v,searchedPages:_,truncated:!0};v.push({url:g(e.slug,s),title:e.title,line:n+1,text:E(r,t)})}}}return v.length>0?{matches:v,searchedPages:_,truncated:!1}:{matches:v,searchedPages:_,truncated:!1,note:`No page you can read ${u?`in "${u}" contains "${i}". All ${_} pages there were searched.`:`contains "${i}". All ${_} pages were searched. API references are not searched: use ${n(r.mcpMode).listApis} for them.`}`}}};async function C(t,n){return(await e(n.entities)).has(t)?null:n.pageMarkdown.readPage(t)}function w(e,t,n){return t.map(t=>t.type===`page`?{type:`page`,title:t.label,url:g(t.link??``,n)}:{type:`section`,id:_(e,t.label),title:t.label,...t.link?{url:g(t.link,n)}:{},pageCount:u(t.items)})}function T(e,t,n){return Math.min(Math.max(1,Math.floor(e??t)),n)}function E(e,t){let n=Math.max(0,Math.min(t-80,e.length-200));return e.slice(n,n+200).trim()}function D(e){return(e.endsWith(`
|
|
3
3
|
`)?e.slice(0,-1):e).split(`
|
|
4
|
-
`)}function
|
|
4
|
+
`)}function O(e){let t=[],n=!1;return e.forEach((e,r)=>{if(y.test(e)){n=!n;return}let i=n?null:v.exec(e);i&&t.push({line:r+1,level:i[1].length,heading:i[2].trim()})}),t}const k=[b,x,S];export{k as pageTools};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{SUBMIT_FEEDBACK_TOOL_NAME as e}from"../../constants.js";import{toolNameForMode as t}from"../codemode/tool-declarations.js";import{GRAPHQL_LIST_SCOPES as n,GRAPHQL_TYPE_KINDS as r}from"./graphql-constants.js";import{OPERATION_METHODS as i}from"./openapi-document.js";import{MAX_PAGE_LINES as a}from"./pages-constants.js";const o={type:`string`,nullable:!0},s={limit:{type:`number`},total:{type:`number`},page:{type:`number`},totalPages:{type:`number`}},c={codemodeType:`OpenApiServer[]`},l={codemodeType:`OpenApiSecurityRequirement[]`},u={codemodeType:`Record<string, OpenApiSecurityScheme>`},d={codemodeType:`OpenApiDocument`},f={codemodeType:`OpenApiOperation & { path: string; method: string }`},p={codemodeType:`OpenApiComponents`,description:"Components the endpoint references. A `$ref` in `endpoint` resolves against the root of the result."},m={filePath:{type:`string`,description:`API definition file path`},otherMatches:{type:`array`,description:"Other API definitions the lookup also matched. Present only when several matched; pass `filePath` to pick another one",items:{type:`object`,required:[`filePath`],properties:{version:{type:`string`},filePath:{type:`string`}}}}},h="When several definitions match the name, the highest version or the shortest file path is used and the rest are listed in `otherMatches`; tell the user which version or file the answer is based on.",g={readOnlyHint:!0,destructiveHint:!1,openWorldHint:!1};function _(e,t){let n={query:{type:`string`,description:`What to find, as a few words or a short question.`,minLength:1}};return e.length>0&&(n.product={type:`string`,description:`Optional product name to filter search results by specific product.`,enum:[...e,null],nullable:!0}),t.length>0&&(n.locale={type:`string`,description:`Optional locale code to filter search results by documentation language (e.g. 'en', 'ja'). Use the locale matching the language of the user's request. Defaults to the site's default locale.`,enum:[...t,null],nullable:!0}),{name:`search`,title:`Search documentation`,description:`Search the documentation. Returns Markdown text: one section per matching page, with its title and URL as a link.`,summary:`Search the documentation.`,schema:{type:`object`,required:[`query`],additionalProperties:!1,properties:n},annotations:g,outputSchema:{type:`string`}}}const v=_([],[]),y={name:`whoami`,title:`Who am I`,description:`Get information about the currently authenticated user`,summary:`Get the signed-in user.`,schema:{type:`object`,required:[],additionalProperties:!1,properties:{}},annotations:g,outputSchema:{type:`object`,required:[`authenticated`],properties:{authenticated:{type:`boolean`},email:{type:`string`},name:{type:`string`},subject:{type:`string`},clientId:{type:`string`},scope:{type:`string`},issuedAt:{type:`string`},expiresAt:{type:`string`}}}},b={name:e,title:`Submit feedback`,description:`Report a documentation page that is wrong or incomplete. Use it when the user reports a problem with a page on this site, or agrees to report a problem that you found. Do not use it for product bugs or support questions.`,schema:{type:`object`,required:[`path`,`summary`],additionalProperties:!1,properties:{path:{type:`string`,description:`Path or URL of the documentation page the feedback is about (e.g. /guides/auth)`,minLength:1,maxLength:1e3},summary:{type:`string`,description:`One sentence that names what is wrong with the page`,minLength:1,maxLength:500},details:{type:`string`,description:`Expected versus actual behavior, missing steps, or the snippet that failed`,maxLength:4e3,nullable:!0},targetFeature:{type:`string`,description:`The API or feature the page documents`,maxLength:500,nullable:!0}}},annotations:{readOnlyHint:!1,destructiveHint:!1,idempotentHint:!1,openWorldHint:!0},outputSchema:{type:`object`,required:[`status`,`page`,`message`],properties:{status:{type:`string`},page:{type:`string`},message:{type:`string`}}}},x={type:`object`,additionalProperties:!1,required:[],properties:{filter:{type:`string`,description:`Matches part of an API name, or of a description when no name matches`,minLength:1,nullable:!0},page:{type:`number`,description:`Page number`,minimum:1,default:1,nullable:!0},limit:{type:`number`,description:`Number of APIs per page. Default is 300`,minimum:1,default:300,nullable:!0}}};function S(e){return{type:`string`,description:`API definition file path, as returned by \`${t(`list-apis`,e)}\``,nullable:!0}}function C(e){return{type:`object`,required:[],additionalProperties:!1,properties:{name:{type:`string`,description:"API name, or a unique part of it. Required when the project documents more than one API, unless `filePath` is given.",minLength:1,nullable:!0},version:{type:`string`,description:`API version. When omitted and several versions exist, the highest one is used`,nullable:!0},filePath:S(e)}}}function w(e){let{name:t,version:n,filePath:r}=C(e).properties;return{type:`object`,required:[`path`,`method`],additionalProperties:!1,properties:{name:t,path:{type:`string`,description:`Endpoint path (e.g. /api/v1/users)`,minLength:1},method:{type:`string`,description:`HTTP method (GET, POST, PUT, DELETE, etc.)`,enum:[...i.map(e=>e.toUpperCase()),...i],minLength:1},version:n,filePath:r}}}function T(e){let t={name:{type:`string`},description:{type:`string`},version:{type:`string`},servers:c,filePath:{type:`string`,description:`API definition file path`},ambiguousTitle:{type:`boolean`,description:"true = another API shares this title; a lookup picks the highest version, or the shortest file path at the same version, and lists the rest in `otherMatches`. Pass `filePath` to pick another one"}};return e&&(t.callable={type:`boolean`,description:"true = the documented hosts of this API are reachable via `fetch`; false = documentation only"}),{name:`list-apis`,title:`List APIs`,description:`Lists the APIs documented on this site`,summary:`List the available APIs.`,schema:x,annotations:g,outputSchema:{type:`object`,required:[`items`,`limit`,`total`,`page`,`totalPages`],properties:{items:{type:`array`,items:{type:`object`,required:[`name`,`description`,`version`,`servers`,`filePath`],properties:t}},...s}}}}const E=T(!1),D=T(!0);function O(e){return{name:`get-endpoints`,title:`Get endpoints`,description:`Get all endpoints for a specific API. ${h}`,summary:`Get all endpoints for an API.`,schema:C(e),annotations:g,outputSchema:{type:`object`,required:[`api`,`version`,`filePath`,`servers`,`endpoints`],properties:{api:{type:`string`},version:{type:`string`},...m,servers:c,endpoints:{type:`array`,items:{type:`object`,required:[`path`,`method`],properties:{path:{type:`string`},method:{type:`string`},summary:o,description:o,security:l}}}}}}}const k=O(`tools`);function A(e){return{name:`get-endpoint-info`,title:`Get endpoint info`,description:`Get comprehensive information about specific endpoint including parameters, security, and examples. A \`$ref\` in \`endpoint\` points into the \`components\` key at the root of the result: read \`#/components/<section>/<name>\` there. ${h}`,summary:`Get the details of an endpoint.`,schema:w(e),annotations:g,outputSchema:{type:`object`,required:[`api`,`version`,`filePath`,`servers`,`endpoint`,`globalSecurity`,`securitySchemes`],properties:{api:{type:`string`},version:{type:`string`},...m,servers:c,endpoint:f,globalSecurity:l,securitySchemes:u,components:p}}}}const j=A(`tools`);function M(e){return{name:`get-security-schemes`,title:`Get security schemes`,description:`Get the security schemes for a specific API. ${h}`,summary:`Get the security schemes for an API.`,schema:C(e),annotations:g,outputSchema:{type:`object`,required:[`api`,`version`,`filePath`,`securitySchemes`,`security`],properties:{api:{type:`string`},version:{type:`string`},...m,securitySchemes:u,security:l}}}}const N=M(`tools`);function P(e){return{name:`get-full-api-description`,title:`Get full API description`,description:`Get the complete OpenAPI description. ${h}`,summary:`Get the complete OpenAPI description.`,schema:C(e),annotations:g,outputSchema:{type:`object`,required:[`api`,`version`,`filePath`,`definition`],properties:{api:{type:`string`},version:{type:`string`},...m,definition:d}}}}const F=P(`tools`),I={type:`object`,required:[],additionalProperties:!1,properties:{filter:{type:`string`,description:`GraphQL schema name (or part of it)`,minLength:1,nullable:!0},page:{type:`number`,description:`Page number`,minimum:1,default:1,nullable:!0},limit:{type:`number`,description:`Number of results per page. Default is 300`,minimum:1,default:300,nullable:!0}}},L={type:`object`,required:[`name`],additionalProperties:!1,properties:{name:{type:`string`,description:`GraphQL schema name`,minLength:1},kind:{type:`string`,description:`Optional: return only a single category of schema members. With scope "fields", restricts to the fields of that parent category ("objects", "interfaces", or "inputs" only).`,enum:[...r,null],nullable:!0},scope:{type:`string`,description:'Optional: what each list item is. "members" (default) lists top-level types and operations. "fields" flattens every field of every object/interface/input type into "ParentType.fieldName" entries with their descriptions — combine with `filter` to search nested fields anywhere in the schema.',enum:[...n,null],nullable:!0},filter:{type:`string`,description:`Optional: only members whose name or description contains this substring, case-insensitive (e.g. "custom tags")`,minLength:1,nullable:!0},referencesType:{type:`string`,description:`Optional: only members that reference this type directly or transitively (via return, field, argument, union-member or input-field types). Finds cross-cutting members that never name it — e.g. referencesType "Book" surfaces a search query returning a union that includes Book.`,minLength:1,nullable:!0},page:{type:`number`,description:`Page number`,minimum:1,default:1,nullable:!0},limit:{type:`number`,description:`Number of results per page. Default is 300`,minimum:1,default:300,nullable:!0}}},R={type:`object`,required:[`name`],additionalProperties:!1,properties:{name:{type:`string`,description:`GraphQL schema name`,minLength:1},type:{type:`string`,description:`Name of the type, operation, or directive`,minLength:1,nullable:!0},includeReferencedTypes:{type:`boolean`,description:`Also include the SDL of every type referenced transitively. Gives the whole subgraph at once, but can be large for highly-connected types.`,default:!1,nullable:!0}}},z={type:`object`,required:[`name`],additionalProperties:!1,properties:{name:{type:`string`,description:`GraphQL schema name`,minLength:1}}},B={name:`list-graphql-apis`,title:`List GraphQL APIs`,description:`Lists available GraphQL schemas with their context and purpose`,summary:`List the available GraphQL schemas.`,schema:I,annotations:g,outputSchema:{type:`object`,required:[`items`,`limit`,`total`,`page`,`totalPages`],properties:{items:{type:`array`,items:{type:`object`,required:[`name`],properties:{name:{type:`string`},description:o}}},...s}}},V={name:`get-graphql-type-list`,title:`Get GraphQL type list`,description:'List all operations and types in a GraphQL schema as a flat, paginated list. Each item is tagged with its kind (query, object, enum, …) and carries a one-line description; operations also include their return type and argument signature — use it to decide which members to fetch in detail. Narrow the result with `kind` (one category), `filter` (case-insensitive substring of the member name or description, e.g. "book"), or `referencesType` (only members that use a given type, directly or transitively) to explore a domain cheaply instead of pulling the full schema. To search nested fields — not just type names — set scope "fields": it flattens every field of every object/interface/input type into "ParentType.fieldName" entries with their descriptions, so `filter` finds things like an input field whose docstring mentions your keyword.',summary:`List the operations and types in a GraphQL schema.`,schema:L,annotations:g,outputSchema:{type:`object`,required:[`name`,`items`,`limit`,`total`,`page`,`totalPages`],properties:{name:{type:`string`},items:{type:`array`,items:{type:`object`,required:[`kind`,`name`],properties:{kind:{type:`string`,enum:[...r]},name:{type:`string`},description:o,type:{type:`string`},args:{type:`string`},directives:{type:`string`}}}},...s}}};function H(e){return{name:`get-graphql-type`,title:`Get GraphQL type`,description:`Get the SDL for a single GraphQL type, operation (query/mutation/subscription field), or directive. Without includeReferencedTypes, the SDL is followed by a one-level manifest of every directly referenced type's field names (e.g. "input ActionOperationInput { addTags, removeTags }"), so you can see what nested types contain before fetching them. Set includeReferencedTypes to instead pull in the full SDL of every type it references transitively — the whole structural subgraph in one call, ideal for complete exploration of an entity (e.g. Book and all the types it touches). That traversal only follows what the target depends on; to go the other direction and find the members that use a type, call ${t(`get-graphql-type-list`,e)} with \`referencesType\`.`,summary:`Get the SDL of one GraphQL type or operation.`,schema:R,annotations:g,outputSchema:{type:`string`}}}const U=H(`tools`);function W(e){return{name:`get-graphql-schema`,title:`Get GraphQL schema`,description:`Get the complete GraphQL schema as SDL — the whole type graph in one call. Returns everything, so it can be very large and token-expensive for big schemas; prefer ${t(`get-graphql-type-list`,e)} (filter/paginate) plus targeted ${t(`get-graphql-type`,e)} calls, and reach for this only for small schemas or when you truly need the full SDL.`,summary:`Get the complete GraphQL schema.`,schema:z,annotations:g,outputSchema:{type:`string`}}}const G=W(`tools`);function K(e){return`Section id from ${t(`list-pages`,e)} (for example "products/ledger > Integration"), a section title, or a section URL`}function q(e){return{type:`object`,required:[`type`,`title`],properties:{type:{type:`string`,enum:[`page`,`section`]},id:{type:`string`,description:`Section id to pass to ${t(`list-pages`,e)} or ${t(`grep-pages`,e)}`},title:{type:`string`},url:{type:`string`},pageCount:{type:`number`,description:`Pages inside the section`}}}}function J(e){let t=q(e);return{name:`list-pages`,title:`List pages`,description:`Lists the docs navigation, one level per call`,summary:`List the docs navigation, one level per call.`,schema:{type:`object`,additionalProperties:!1,required:[],properties:{section:{type:`string`,nullable:!0,description:`${K(e)}. Omit it to list the top level`}}},annotations:g,outputSchema:{type:`object`,properties:{sections:{type:`array`,description:`Top level, when no section is given`,items:{type:`object`,required:[`id`,`title`,`items`],properties:{id:{type:`string`},title:{type:`string`},items:{type:`array`,items:t}}}},section:{type:`object`,properties:{id:{type:`string`},title:{type:`string`}}},items:{type:`array`,items:t}}}}}const Y=J(`tools`),X={name:`get-page`,title:`Get page`,description:`Reads a docs page as Markdown, in line windows`,summary:`Read a docs page as Markdown, in line windows.`,schema:{type:`object`,additionalProperties:!1,required:[`url`],properties:{url:{type:`string`,minLength:1,description:`Page URL or path, for example "/guides/auth"`},startLine:{type:`integer`,nullable:!0,minimum:1,description:`First line to return (default 1)`},lines:{type:`integer`,nullable:!0,minimum:1,maximum:a,description:`Number of lines to return (default 200)`}}},annotations:g,outputSchema:{type:`object`,required:[`url`,`title`,`totalLines`,`startLine`,`endLine`,`outline`,`content`],properties:{url:{type:`string`},title:{type:`string`},totalLines:{type:`number`},startLine:{type:`number`},endLine:{type:`number`},nextStartLine:{type:`number`,description:`Pass as startLine to read on; absent at the end`},outline:{type:`array`,description:`Headings (levels 1-3) with their line numbers`,items:{type:`object`,required:[`line`,`level`,`heading`],properties:{line:{type:`number`},level:{type:`number`},heading:{type:`string`}}}},content:{type:`string`}}}};function Z(e){return{name:`grep-pages`,title:`Grep pages`,description:`Finds the docs lines that contain a text`,summary:`Find the docs lines that contain a text.`,schema:{type:`object`,additionalProperties:!1,required:[`query`],properties:{query:{type:`string`,minLength:1,description:`Text to find, case-insensitive. Not a regular expression`},section:{type:`string`,nullable:!0,description:`${K(e)}. Omit it to search every page`},maxMatches:{type:`integer`,nullable:!0,minimum:1,maximum:100,description:`Maximum matching lines to return (default 20)`}}},annotations:g,outputSchema:{type:`object`,required:[`matches`,`searchedPages`,`truncated`],properties:{matches:{type:`array`,items:{type:`object`,required:[`url`,`title`,`line`,`text`],properties:{url:{type:`string`},title:{type:`string`},line:{type:`number`},text:{type:`string`}}}},searchedPages:{type:`number`,description:`Pages searched: every page you can read, or every page in the section`},truncated:{type:`boolean`,description:`true = more matches exist; narrow the query or the section`},note:{type:`string`,description:`Present when nothing matches: the docs you can read do not contain the text`}}}}}const Q=Z(`tools`);export{k as GET_ENDPOINTS_SCHEMA,j as GET_ENDPOINT_INFO_SCHEMA,F as GET_FULL_API_DESCRIPTION_SCHEMA,G as GET_GRAPHQL_SCHEMA_SCHEMA,V as GET_GRAPHQL_TYPE_LIST_SCHEMA,U as GET_GRAPHQL_TYPE_SCHEMA,X as GET_PAGE_SCHEMA,N as GET_SECURITY_SCHEMES_SCHEMA,Q as GREP_PAGES_SCHEMA,D as LIST_APIS_CALLABLE_SCHEMA,E as LIST_APIS_SCHEMA,B as LIST_GRAPHQL_APIS_SCHEMA,Y as LIST_PAGES_SCHEMA,g as READ_ONLY_ANNOTATIONS,v as SEARCH_SCHEMA,b as SUBMIT_FEEDBACK_SCHEMA,y as WHOAMI_SCHEMA,A as getEndpointInfoToolSchema,O as getEndpointsToolSchema,P as getFullApiDescriptionToolSchema,W as getGraphqlSchemaToolSchema,H as getGraphqlTypeToolSchema,M as getSecuritySchemesToolSchema,Z as grepPagesToolSchema,J as listPagesToolSchema,_ as searchSchema};
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import{normalizeL10nConfig as e}from"../../../../../../shared/utils/l10n.js";import{withPathPrefix as t}from"../../../../../../shared/path-prefix.js";import{readIgnoredRouteSlugs as n}from"../../ignored-routes.js";import{publicOrigin as r}from"../../../../utils/request-origin.js";import{resolveSemanticSearchUpstreamUrl as i}from"../../../../../../shared/ask-ai/upstream.js";import{SemanticSearchError as a,fetchSemanticSearchDocuments as o,filterSemanticSearchDocuments as s}from"../semantic-search.js";import{SEARCH_SCHEMA as c,searchSchema as l}from"
|
|
1
|
+
import{normalizeL10nConfig as e}from"../../../../../../shared/utils/l10n.js";import{withPathPrefix as t}from"../../../../../../shared/path-prefix.js";import{readIgnoredRouteSlugs as n}from"../../ignored-routes.js";import{publicOrigin as r}from"../../../../utils/request-origin.js";import{resolveSemanticSearchUpstreamUrl as i}from"../../../../../../shared/ask-ai/upstream.js";import{SemanticSearchError as a,fetchSemanticSearchDocuments as o,filterSemanticSearchDocuments as s}from"../semantic-search.js";import{SEARCH_SCHEMA as c,searchSchema as l}from"./schemas.js";const u=`No results found.`;function d(e,n){let r=e=>{try{return new URL(t(e),n).toString()}catch{return e}};return e.map(e=>`### [${e.title}](${r(e.url)})\n\n${e.content}\n`).join(`
|
|
2
2
|
|
|
3
3
|
`).trim()}const f=[{schema:c,schemaFor:t=>l(Object.values(t.config.products??{}).map(e=>e.name),e(t.config.l10n).locales?.map(e=>e.code)??[]),isAvailable:()=>i()!==``,async execute(t,i){let{query:c,product:l,locale:f}=t??{},p;try{p=await o({query:c,product:l||void 0,locale:f||e(i.config.l10n).defaultLocale})}catch(e){throw e instanceof a?(i.logger?.warn(`MCP search: ${e.message} ${e.detail}`),Error(`The search service failed. Try the call again later.`)):e}let m=await n(i.entities),h=await s(p,async e=>!m.has(e)&&i.isSlugVisible(e)&&await i.hasRoute(e));return h.length===0?u:d(h,r(i.request))||u}}];export{f as searchTools};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{publicOrigin as e}from"../../../../utils/request-origin.js";import{submitFeedback as t}from"../../../../../../server/feedback/route.js";import{
|
|
1
|
+
import{publicOrigin as e}from"../../../../utils/request-origin.js";import{submitFeedback as t}from"../../../../../../server/feedback/route.js";import{SUBMIT_FEEDBACK_SCHEMA as n}from"./schemas.js";import{toPageSlug as r,toPublicUrl as i}from"./pages-navigation.js";function a(e){return{content:[{type:`text`,text:JSON.stringify(e)}],isError:!0}}function o(e){return e?.trim()||void 0}function s(e,t){let n=r(e,t);return n===null?void 0:new URL(i(n,t)).toString()}function c(e){return e.feedback?.hide!==!0}const l=[{schema:n,isAvailable:e=>c(e.config),async execute(n,r){let i=n??{},c=o(i.path),l=o(i.summary);if(!c||!l)return a({error:`Invalid arguments`,message:"`path` and `summary` are required."});let u=s(c,e(r.request));if(!u)return a({error:`Invalid arguments`,message:"`path` must be a page path or URL of this site."});let d=o(i.details),f=r.clientVersion?`${r.client}/${r.clientVersion}`:r.client,p;try{p=await t({body:{component:`comment`,path:u,comment:d?`${l}\n\n${d}`:l,agent:f,targetFeature:o(i.targetFeature),origin:`mcp`},request:r.request,isSlugVisible:e=>r.isSlugVisible(e)},{hasRoute:e=>r.hasRoute(e),logger:r.logger})}catch{return a({error:`Failed to submit feedback`,message:`The feedback endpoint could not be reached.`})}let{status:m,data:h}=p;return m===403?a({error:`Forbidden`,message:`You have no access to this page, so feedback for it is not accepted.`}):m===404?a({error:`Not found`,message:`No page exists at ${u}.`}):m===400?a({error:`Invalid feedback`,errors:Array.isArray(h.errors)?h.errors.filter(e=>typeof e==`string`):[]}):m<200||m>299?a({error:`Failed to submit feedback`,message:`The feedback endpoint answered ${m}.`}):{status:`received`,page:u,message:`Thanks for your feedback. The documentation team sees it on the Feedback page.`}}}];export{c as isFeedbackEnabled,l as submitFeedbackTools};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{WHOAMI_SCHEMA as e}from"
|
|
1
|
+
import{WHOAMI_SCHEMA as e}from"./schemas.js";function t(e){let t=typeof e==`number`?e:Number(e);return Number.isFinite(t)&&t>0?(/* @__PURE__ */ new Date(t*1e3)).toISOString():void 0}const n=[{schema:e,isAvailable:e=>e.isProtected,async execute(e,n){let r=n.request.viewer;if(!r?.isAuthenticated)return{authenticated:!1};let i=n.claims??{};return{authenticated:!0,email:r.email,name:r.name,subject:r.sub,clientId:i.client_id,scope:i.scope,issuedAt:t(i.iat),expiresAt:t(i.exp)}}}];export{n as whoamiTools};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{
|
|
1
|
+
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{filePathToRouteSlug as t}from"../../../../../shared/utils/routes/file-path-to-route-slug.js";import{mockPathPrefix as n}from"../../../types/api-entity.js";import{isPlanFeatureGranted as r}from"../../../../../shared/plan-gates.js";import{stripPathPrefix as i}from"../../../../../shared/path-prefix.js";import{notFoundResponse as a}from"../../../../../server/plugin-context.js";const o={"Cache-Control":`no-store`},s=/* @__PURE__ */ new Map;function c(t,n){let r=n.metadata?.mockServer;return{...t,...e(r)?r:{}}}function l(e,t){let{specType:r,routeSlug:i}=e.metadata??{};return r!==`openapi`||typeof i!=`string`||c(t,e).off===!0?null:n(i)}function u(e,t,n=void 0){let r=null,i=-1;for(let a of e){let e=l(a,n);e===null||e.length<=i||d(e,t)&&(r={api:a,path:t.slice(e.length)||`/`},i=e.length)}return r}function d(e,t){return t===e||t.startsWith(`${e}/`)}function f(e,t,{createMockServer:n}){let r=s.get(t.key);if(r&&r.dataHash===t.dataHash)return r.handler;let{strictExamples:i,errorIfForcedExampleNotFound:a}=c(e.config.mockServer,t),o=e.entities.load(t.key).then(e=>n(structuredClone(e),{strictExamples:i,errorIfForcedExampleNotFound:a}));return s.set(t.key,{dataHash:t.dataHash,handler:o}),o.catch(()=>s.delete(t.key)),o}async function p(e,r){let i=await e.entities.list({type:`api`}),a=i.filter(({metadata:e})=>e?.specType!==`openapi`||e.routeSlug!==void 0?!1:d(n(t(String(e.sourcePath))),r));return a.length===0?i:(await Promise.all(a.map(t=>e.entities.load(t.key))),e.entities.list({type:`api`}))}function m(e,t){let n=(e.req.header(`x-http-method-override`)??e.req.method).toUpperCase(),{search:r}=new URL(e.req.url),i;return{path:t,method:n,query:r===``?void 0:r,headers:Object.fromEntries(e.req.raw.headers),getBody:()=>i??=e.req.arrayBuffer().then(e=>e.byteLength>0?Buffer.from(e):void 0)}}function h(e){return(i(new URL(e.req.url).pathname)??``).slice(6)||`/`}async function g(e,t){if(!r(t.config,`mockServer`))return a();let n=h(e),i=u(await p(t,n),n,t.config.mockServer);if(!i||!t.isSlugVisible(String(i.api.metadata?.routeSlug)))return a();let s;try{s=await import(`@redocly/mock-server`)}catch{return new Response(`Mock server is not available on this host`,{status:501})}let c=await(await f(t,i.api,s))(m(e,i.path));return new Response(c.body?new Uint8Array(c.body):null,{status:c.statusCode,headers:{...c.headers,...o}})}export{u as matchMockApi,g as mock,m as toMockRequest};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{toJsonValue as t}from"../../../database/utils/json.js";import{createEntityLoader as n}from"../../../loaders/define.js";import{runtimeFile as r}from"../../utils/runtime-file.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{toJsonValue as t}from"../../../database/utils/json.js";import{createEntityLoader as n}from"../../../loaders/define.js";import{runtimeFile as r}from"../../utils/runtime-file.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{toPosixPath as o}from"../../../../shared/utils/to-posix-path.js";import{isObject as s}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as c}from"../../../../shared/utils/routes/normalize-route-slug.js";import{publicLink as l}from"../../../versions/public-link.js";import{createApiEntityKey as u}from"../../utils/api-entity-key.js";import{API_DOCS_INFO_BLOCK_DEP_KEY as d}from"../api-docs/server/shared.js";import{getLoadedProjectPlugins as f}from"../../project/loaded-set.js";import{API_OUTPUT_MANIFEST_KEY as p}from"../../../api-outputs.js";import{CATALOG_CLASSIC_DEP_KEY as m}from"../catalog-classic/client/contract.js";import{catalogEntityKey as h}from"../catalog-classic/entity-key.js";import{CATALOG_CARD_METADATA_ENTITY_TYPE as g}from"../catalog-classic/card-metadata.js";import{loadVersionGroups as _}from"../catalog-classic/resolve-items.js";import{NON_CONFORMANT as ee,apiPagePath as v,scorecardDetailsFile as y}from"./client/contract.js";import{findTarget as b,readScorecardSettings as x}from"./config.js";import{API_SCORECARD_ENTITY_TYPE as S,RULES_ENTITY_KEY as C,apiScorecardEntityKey as w,isScoredApi as T,scorecardPageEntityKey as E}from"./entities.js";import{collectRuleNames as te,lintApi as ne,resolveLevelConfigs as D,summarizeRules as O}from"./lint.js";import{gzip as k}from"../../../../shared/utils/gzip.js";import{join as A,posix as j,relative as M}from"node:path";import re from"picomatch";const N=`internal.scorecard-classic`,P=`scorecard-classic`,ie=i(N,`api`),ae=i(N,`rules`),oe=i(N,`page`),se=i(N,`card-metadata`),ce=i(N,`badge`),F=n(ie,async e=>{let t=e.file.path,n=e.args.source??t,r=e.routes.byFilePath(t),i=r&&e.routes.get(r.slug);if(!i)return{value:null,metadata:{sourcePath:t}};let a=async t=>({body:await e.createBlobRef(await k(new TextEncoder().encode(JSON.stringify(t))),{format:`binary`}),contentType:`application/gzip`}),o=x(e.config),s=J(e.contentDir),c=b(o.targets,i.metadata),l=b(o.targets.filter(e=>e.rules!==void 0),i.metadata),u=s.paths,d;try{let t=await D({contentDir:e.contentDir,settings:o,plugins:s.plugins,readFile:e.io.readFile});u=[...t.files,...s.paths];let r=l===void 0?void 0:t.targets[o.targets.indexOf(l)];d=await ne({contentDir:e.contentDir,filePath:n,source:await e.io.readFile(A(e.contentDir,n)),configs:Object.fromEntries(o.levels.map(e=>[e.name,r?.[e.name]??t.levels[e.name]]))})}catch(e){return{value:await a(null),metadata:{sourcePath:t},problems:[{code:`scorecard/lint-failed`,message:`The scorecard could not lint this API: ${e instanceof Error?e.message:String(e)}`,location:{filePath:t}}],entityDeps:Y([n,...u])}}let f={...L(o,d.levels,c?.minimumLevel),title:await I(e.entities,t)??j.basename(n),relativePath:t,levels:d.levels};i.version!==null&&(f.version=i.version);let{levels:p,...m}=f,h={...m,levels:Object.fromEntries(Object.entries(p).map(([e,{problems:t,...n}])=>[e,n])),rules:O(p),sourcePath:t,route:i.slug};return{value:await a(f),metadata:h,entityDeps:Y([n,...d.files,...u])}});async function I(e,t){let n=await e.load(u(t)).catch(()=>void 0),r=s(n)&&s(n.info)?n.info:{};return typeof r.title==`string`?r.title:void 0}function L(e,t,n){let r=e.levels.map(e=>e.name),i=r.findIndex(e=>t[e].errors>0),a=i===-1?r.length:i,o=n??r[0],s=r.indexOf(o),c=`HIGHEST`;return a-1<s?c=`BELOW_MINIMUM`:s<r.length-1&&(c=`MINIMUM`),{scorecardLevel:a===0?ee:r[a-1],scorecardLevelIdx:a,targetLevel:o,status:c}}async function R(e,t){let n=await e.get(t);return n!==null&&(n.status!==`ready`||!T(n.metadata))&&(await e.load(t).catch(()=>void 0),n=await e.get(t)),n!==null&&T(n.metadata)?n.metadata:null}async function z(e){let t=[];for(let n of await e.list({type:S})){let r=await R(e,n.key);r!==null&&t.push(r)}return t}function B({sourcePath:e,route:t,...n}){return n}const V=n(ae,async e=>{let t=x(e.config),{perLevel:n,all:r}=await D({contentDir:e.contentDir,settings:t,plugins:J(e.contentDir).plugins,readFile:e.io.readFile}).then(e=>te(e.levels),()=>({perLevel:{},all:[]}));return{value:{levelNames:t.levels.map(e=>e.name),rules:r,rulesPerLevel:n}}}),H=n(oe,async e=>{let t=await e.entities.load(h(e.args.catalogId)),n=await e.entities.load(C),r=(await z(e.entities)).flatMap(t=>{let n=e.routes.get(t.route);return n?[{route:n,api:t}]:[]}),{versionGroups:i,entityDeps:a}=await _(r,e),o=new Map(r.map(({route:e,api:t})=>[l(e,i),B(t)])),s=[];for(let e of t.items){let t=o.get(e.link);t!==void 0&&s.push({...e,metadata:{...e.metadata,scorecard:t,scorecardLevel:t.scorecardLevel}})}let c={...t,items:s,scorecard:{...n,teamMetadataProperty:x(e.config).teamMetadataProperty}},u=JSON.stringify(c);return{value:u.length>65536?await e.createBlobRef(u,{format:`json`}):c,entityDeps:a}}),U=n(se,async e=>({value:(await z(e.entities)).map(e=>({route:e.route,metadata:{scorecardStatus:e.status,scorecardLevel:e.scorecardLevel,scorecardLevelIdx:e.scorecardLevelIdx,scorecardLevels:G(e)}}))})),W=n(ce,async e=>{let t=await R(e.entities,w(e.args.file)),n=t&&e.routes.get(t.route);if(!t||!n)return{value:null};let{versionGroups:r,entityDeps:i}=await _([{route:n}],e),a=l(n,r),o=q(e.config);if(o.length===0)return{value:null};let s=o[0].slug;if(o.length>1){for(let{catalogId:t,slug:n}of o)if((await e.entities.load(h(t))).items.some(e=>e.link===a)){s=n;break}}return{value:{scorecardLevel:t.scorecardLevel,scorecardLevelIdx:t.scorecardLevelIdx,scorecardLevels:G(t),scoreCardSlug:v(K(s),a)},entityDeps:i}});function G(e){return Object.fromEntries(Object.entries(e.levels).map(([e,t])=>[e,{uniqueErrors:t.uniqueErrors,uniqueWarnings:t.uniqueWarnings}]))}function K(e){return j.join(c(e),`scorecard`)}function q(e){return Object.entries(e.catalogClassic??e.catalog??{}).map(([e,t])=>({catalogId:e,slug:String(t.slug)}))}function J(e){let t=f(e)?.lintPlugins??[];return{plugins:t,paths:t.map(t=>o(M(e,t.path))).filter(e=>e!==``&&!e.startsWith(`../`))}}function Y(e){return[...new Set(e)].map(e=>({kind:`file`,path:e}))}function X(e){let t=e=>typeof e==`string`||typeof e==`number`;return t(e.manifest.openapi)||t(e.manifest.swagger)}function Z(e){let t=e.manifest[p];return s(t)&&typeof t.root==`string`?t.root:e.path}function Q(e){let t=Z(e);return F.withArgs(t===e.path?{}:{source:t},{stableKey:w(e.path),type:S,metadata:{sourcePath:e.path}})}function $(e,t){if(!X(e))return!1;let n=(t.scorecardClassic??t.scorecard)?.ignore??[];return n.length===0||!re([...n])(Z(e))}function le(e,t){let n=e.filter(e=>e.status===`BELOW_MINIMUM`).map(e=>e.relativePath);if(n.length===0)return;let r=n.slice(0,15).map(e=>`\n - ${e}`),i=n.length-r.length,a=`Detected OpenAPI definitions with score below minimum level:${r.join(``)}${i>0?`\n ... and ${i} more`:``}`;t.config.platform?.ignoreLint??(t.config.scorecardClassic??t.config.scorecard)?.ignoreNonCompliant?t.logger.warn(a):t.logger.error(a)}const ue=e({id:N,version:`2.3.0`,content:{filter:{extensions:[`.yaml`,`.yml`,`.json`]},extractFile(e,t){return $(e,t.config)?{routes:[],entities:[Q(e)]}:null},extractAll(e){let t=e.config.catalogClassic??e.config.catalog??{};if(!e.files.some(X)&&Object.keys(t).length===0)return{routes:[]};let n=x(e.config),r=[V.withArgs({},{stableKey:C})];n.isDefault||r.push(U.withArgs({},{stableKey:`scorecard-classic:card-metadata`,type:g}));let i=[];for(let[e,n]of Object.entries(t)){let t=K(String(n.slug)),a=H.withArgs({catalogId:e},{stableKey:E(e),metadata:{sourcePath:t}});r.push(a),i.push({deps:{[m]:a},metadata:{title:typeof n.title==`string`?n.title:`API design scorecard`},routeId:e,slug:t,template:P,wildcardPrefix:!0})}return{entities:r,routes:i}}},finalize(e){let t=q(e.config).length>0&&!x(e.config).isDefault,n=[],r=[],i=[];for(let a of e.files){let o=$(a,e.config)?e.routes.byFilePath(a.path):void 0;if(o===void 0||(n.push({path:y(a.path),producer:Q(a),audience:{routeSlug:o.slug}}),!t))continue;let s=W.withArgs({file:a.path},{stableKey:`scorecard-classic:badge:${o.slug}`});r.push(s),i.push({slug:o.slug,deps:{[d]:s}})}return{entities:r,attach:i,staticFiles:n}},async buildMetadata(e){if(await e.entities.get(`scorecard-classic:rules`)===null)return;let n=await e.entities.load(C),r=await z(e.entities),i={};for(let e of r){let{rules:t,...n}=B(e);i[e.relativePath]=n}return le(r,e),{scorecardData:i,...n,reuniteIgnoreLint:t(e.config.platform?.ignoreLint)}},loaders:[F,V,H,U,W],templates:{[P]:a(r(`./client/template.tsx`,import.meta.url))}});export{N as SCORECARD_CLASSIC_PLUGIN_ID,P as SCORECARD_CLASSIC_TEMPLATE_ID,ue as scorecardClassicContentPlugin};
|
|
@@ -1 +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{splitUrlSuffix as n}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolveContentPath as r}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as i}from"../assets/extensions.js";import{toNavItemRbacAnnotation as a}from"../../../../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,n){let i=p.load(e);if(!Array.isArray(i))return[];let a=[],o=e=>{if(t(e)){if(typeof e.$ref==`string`){let t=r(e.$ref,n);t!==null&&a.push(t)}if(Array.isArray(e.items))for(let t of e.items)o(t);if(m(e)&&Array.isArray(e.menu))for(let t of e.menu)o(t)}};for(let e of i)o(e);return a}async function _(e){let t=p.load(e.source);if(!Array.isArray(t))return[];let n=[];return await v({entries:t,ownerFilePath:e.filePath,currentFilePath:e.filePath,readFile:e.readFile,visitedRefs:/* @__PURE__ */ new Set([e.filePath]),refs:n}),n}async function v(e){let{ownerFilePath:t,currentFilePath:n,readFile:i,refs:a}=e;for(let o of e.entries){let s=K(o);if(s===void 0)continue;if(typeof s.$ref==`string`){let o=r(s.$ref,n);if(o===null||i===void 0||e.visitedRefs.has(o))continue;let c;try{c=await i(o)}catch{continue}let l=p.load(c);if(!Array.isArray(l))continue;let u=new Set(e.visitedRefs);u.add(o),await v({entries:l,ownerFilePath:t,currentFilePath:o,readFile:i,visitedRefs:u,refs:a});continue}let c=typeof s.page==`string`?s.page:s.href;typeof c==`string`&&y(a,c,n,t),Array.isArray(s.items)&&await v({...e,entries:s.items}),m(s)&&Array.isArray(s.menu)&&await v({...e,entries:s.menu})}}function y(e,t,n,r){let i=d(t,n);i!==null&&e.push({kind:`link`,raw:t,...i,...n===r?{}:{filePath:n}})}async function b(e){let t=p.load(e.source);if(!Array.isArray(t))throw Error(`Sidebar "${e.file.path}" must be a YAML sequence at the top level.`);return x({...e,entries:t})}async function x(e){let n=e.entries,r=n.filter(e=>t(e)&&m(e));if(r.length>0&&r.length!==n.length)throw Error(`Sidebar "${e.file.path}": when a sidebar uses navigation tabs, every top-level entry must be a tab (found ${n.length-r.length} other entries).`);let i={file:e.file,routes:e.routes,assignedRouteSlugs:/* @__PURE__ */ new Set,versionedDirectories:/* @__PURE__ */ new Set,report:e.report,readFile:e.readFile,skipRoutes:e.skipRoutes,exists:e.exists,sidebarByDirectory:e.sidebarByDirectory??/* @__PURE__ */ new Map,visitedRefs:/* @__PURE__ */ new Set([e.file.path])},a=[];if(r.length>0){for(let[e,t]of r.entries())a.push(await P({...i,entry:t,tabIndex:e}));L({file:e.file,tabs:a,routes:e.routes})}else for(let e of n)a.push(...await S({...i,entry:e}));return{assignedRouteSlugs:[...i.assignedRouteSlugs].sort(),versionedDirectories:[...i.versionedDirectories].sort(),nodes:a}}async function S(e){let n=await C(e),r=t(e.entry)?e.entry.rbac:void 0;if(r===void 0)return n;let i=I({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=K(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${G(e.entry)} is not a page reference or a group.`),[];if(m(t))throw Error(`Sidebar "${e.file.path}": "tab" is only allowed at the top level (found nested tab "${t.tab}").`);if(t.menu!==void 0)throw Error(`Sidebar "${e.file.path}": "menu" is only allowed directly on a tab.`);if(typeof t.$ref==`string`)return D({...e,ref:t.$ref});if(typeof t.directory==`string`&&E(t)&&t.items===void 0)return C({...e,entry:{...t,directory:void 0,items:[{directory:t.directory,flatten:t.flatten}]}});if(typeof t.directory==`string`){let n=r(t.directory,e.file.path);if(n===null)return h(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(n);i.length===0&&h(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await z({...e,directoryPath:n,flatten:t.flatten===!0,pages:i.filter(t=>!e.skipRoutes?.has(t.slug))}),o=J(t.group)??J(t.label);return o===void 0?a:[{type:`group`,...X(t,e),menuStyle:Z(t),items:a.length>0?a:void 0,label:o,labelTranslationKey:T(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...X(t,e),label:t.separator,labelTranslationKey:J(t.separatorTranslationKey)}];let n=await V(t,e),i=n.route;if(i)for(let t of c([i]))e.versionedDirectories.add(t);let a;if(Array.isArray(t.items)){a=[];for(let n of t.items)a.push(...await S({...e,entry:n}))}let o=J(t.group)??J(t.label)??(i===void 0?J(t.href):void 0)??n.anchor,s=E(t);return[{type:w(t,i,n.linksConnectedHeading===!0),...X(t,e),menuStyle:s?Z(t):void 0,external:t.external===!0||void 0,languageInsensitive:n.languageInsensitive?!0:void 0,items:a&&a.length>0?a:void 0,label:o,labelTranslationKey:T(t),link:n.link,isGroup:s?!0:void 0,version:J(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e,t,n){if(E(e)&&!n)return`group`;if(t!==void 0||e.href||e.label)return`link`}function T(e){return J(E(e)?e.groupTranslationKey:e.labelTranslationKey)}function E(e){return J(e.group)!==void 0}async function D(e){let{ref:t}=e,n=r(t,e.file.path);if(n===null)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is outside the content root.`),[];if(e.readFile===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is not supported here.`),[];if(e.visitedRefs.has(n))return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" includes itself.`),[];let i;try{i=await e.readFile(n)}catch{return h(e,`sidebar/missing-target`,`Sidebar $ref "${n}" could not be read.`),[]}let a=p.load(i);return Array.isArray(a)?O(e,n,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${n}" must be a YAML sequence.`),[])}async function O(e,t,n){let r=/* @__PURE__ */ new Set([...e.visitedRefs,t]),i=[];for(let a of n)i.push(...await S({...e,entry:a,file:{path:t},visitedRefs:r}));return i}async function k(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?O({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(A)):[]}function A(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function j(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function M(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function N(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw M({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw M({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw M({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw M({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw M({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw M({file:t,label:r,message:`has an empty "menu"`});if(n.$ref!==void 0||n.directory!==void 0||n.group!==void 0||n.href!==void 0)throw M({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function P(e){let{entry:t}=e,n=t.tab;N({file:e.file,entry:t});let r=j(e.tabIndex,n);if(t.menu!==void 0){let i=Array.isArray(t.menu)?t.menu:[],a=[];for(let[t,n]of i.entries()){let i=await F({...e,tabId:r,index:t,raw:n});i!==void 0&&a.push(i)}return{tab:!0,tabId:r,label:n,menu:a,...Q(t.icon,e),...I({...e,rbac:t.rbac})}}let[i]=await S({...e,entry:{page:t.page,label:n,items:t.items,rbac:t.rbac}}),a=i?.items??[];return{...i,tab:!0,tabId:r,...Q(t.icon,e),items:a}}async function F(e){let{file:t,entry:n,tabId:r,index:i,raw:a}=e,o=n.tab,s=K(a);if(s===void 0||typeof s.page!=`string`)throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" needs "page".`);if(s.page.includes(`#`))throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" page must not contain a heading anchor.`);let c=`${r}/${i}`,[l]=await S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function I(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function L(e){let t=/* @__PURE__ */ new Map,n=(n,r)=>{for(let i of r){let r=t.get(i);if(r!==void 0&&r.tabId!==n.tabId)throw Error(`Sidebar "${e.file.path}": route "${i}" is claimed by two navigation tabs, "${r.label}" and "${n.label}". A route can belong to one tab only.`);t.set(i,n)}};for(let t of e.tabs){if(t.menu!==void 0){for(let r of t.menu)r.tabId!==void 0&&n({tabId:r.tabId,label:`${t.label} > ${r.label??r.link}`},R({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},R({routes:e.routes,link:t.link,items:t.items}))}}function R(e){let t=[],n=n=>{if(n.link===void 0||n.languageInsensitive===!0)return;let r=e.routes.bySlug(n.link);r!==void 0&&r.originFilePath!==null&&t.push(r.slug)};n({link:e.link});let r=e=>{if(e!==void 0)for(let t of e)n(t),r(t.items)};return r(e.items),t}async function z(t){let n=t.directoryPath===``?``:`${t.directoryPath}/`,r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Set,o=t.directoryPath.startsWith(`${e}/`),s=t.pages.filter(e=>o||e.locale===``).map(e=>({route:e,relativePath:e.originFilePath?.startsWith(n)?e.originFilePath.slice(n.length):null})).sort((e,t)=>B(e.relativePath??e.route.slug,t.relativePath??t.route.slug));for(let e of s){let n=e.relativePath?.split(`/`).slice(0,-1)??[],r=c(n);if(r!==void 0){if(!a.has(r.path)){a.add(r.path);let e=await k(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}U(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({type:`link`,link:e.route.slug,version:e.route.version??void 0,versionGroup:e.route.versionGroup??void 0})}return r;function c(e){for(let n=0;n<=e.length;n++){let r=f.join(t.directoryPath,...e.slice(0,n)),i=t.sidebarByDirectory.get(r);if(i!==void 0&&!t.visitedRefs.has(i))return{depth:n,path:i}}}function l(e,n){return t.flatten?[]:e.slice(0,n).filter(e=>!e.startsWith(`@`))}function u(e){let t=r,n=``;for(let r of e){n=n===``?r:`${n}/${r}`;let e=i.get(n);if(e){t=e;continue}let a=[];t.push({type:`group`,items:a,label:r}),i.set(n,a),t=a}return t}}function B(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function V(e,t){if(typeof e.page==`string`){let{path:r,suffix:i,anchor:a}=n(e.page.trim()),o=await H(r,t);if(!o)return{};let s=e.disconnect!==!0;return s&&U(o,t),{link:`${o.slug}${i}`,anchor:a,linksConnectedHeading:s&&a!==void 0,route:o}}if(typeof e.href==`string`){let n=e.href;if(n.startsWith(`/`)){let e=t.routes.bySlug(n);return e?{link:e.slug,route:e}:{link:n,languageInsensitive:!0}}return{link:n,languageInsensitive:!0}}return{}}async function H(e,t){let n=o(e,t.file.path,t.routes);if(n.kind===`escaped`){h(t,`sidebar/invalid-entry`,`Sidebar page "${e}" is outside the content root.`);return}if(n.kind===`missing`){let n=r(e,t.file.path);n!==null&&await t.exists?.(n)&&h(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return n.value}function U(e,t){t.assignedRouteSlugs.add(e.slug)}async function W(e){if(e.versionedDirectories.length===0)return;let t=await s({io:e.io,routes:e.routes,versionedDirectories:e.versionedDirectories}),n=e=>{for(let r of e){if(r.version!==void 0&&r.versionGroup!==void 0){let e=t.get(r.versionGroup),n=e?.labels.get(r.version);n&&(r.versionLabel=n),e?.defaultVersion===r.version&&(r.isDefaultVersion=!0)}r.items&&n(r.items),r.menu&&n(r.menu)}};n(e.nodes)}function G(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function K(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function q(e){if(!Array.isArray(e))return;let n=[];for(let r of e){if(!t(r))continue;let e=J(r.name),i=J(r.icon);(e!==void 0||i!==void 0)&&n.push({name:e??``,color:J(r.color),icon:i,position:r.position===`before`||r.position===`after`?r.position:void 0})}return n.length>0?n:void 0}function J(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function Y(e,t){return t.find(t=>t===e)}function X(e,t){return{badges:q(e.badges),...Q(e.icon,t),expanded:e.expanded===!0?`true`:Y(e.expanded,[`always`]),selectFirstItemOnExpand:e.selectFirstItemOnExpand===!0||void 0,separatorLine:e.separatorLine===!0||void 0,linePosition:Y(e.linePosition,[`top`,`bottom`]),target:J(e.target),sublabel:J(e.sublabel)}}function Z(e){return Y(e.menuStyle,[`drilldown`,`drilldown-header`])}function Q(e,n){let r=t(e)?J(e.srcSet):void 0;if(r!==void 0){let e=u(r);if(e===null)return{srcSet:r};for(let t of e)t.src=$(t.src,n);return{srcSet:l(e)}}let i=J(e);return i===void 0?{}:{icon:$(i,n)}}function $(e,t){if(!i(e))return e;let n=r(e,t.file.path);return n===null?(h(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${n}`}export{b as bundleSidebar,x as bundleSidebarEntries,_ as collectSidebarLinkRefs,g as collectSidebarRefTargets,W as stampDefaultVersions};
|
|
1
|
+
import{L10N_DIR as e}from"../../../../shared/constants/l10n/defaults.js";import{isObject as t}from"../../../../shared/utils/is-object.js";import"../../../../shared/utils/l10n.js";import{resolveContentPath as n}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as r}from"../assets/extensions.js";import{splitUrlSuffix as i}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as a}from"../../../../server/rbac/filter.js";import{resolvePageTarget as o}from"../../../../shared/utils/routes/resolve-page-target.js";import{collectVersionGroups as s,findVersionedDirectories as c}from"../../../versions/version-groups.js";import{joinSrcSet as l,parseSrcSet as u}from"../assets/srcset.js";import{classifyLinkTarget as d}from"../../../link-checker/classify.js";import{posix as f}from"node:path";import p from"js-yaml";function m(e){return typeof e.tab==`string`}function h(e,t,n){e.report?.({code:t,message:n,location:{filePath:e.file.path}})}function g(e,r){let i=p.load(e);if(!Array.isArray(i))return[];let a=[],o=e=>{if(t(e)){if(typeof e.$ref==`string`){let t=n(e.$ref,r);t!==null&&a.push(t)}if(Array.isArray(e.items))for(let t of e.items)o(t);if(m(e)&&Array.isArray(e.menu))for(let t of e.menu)o(t)}};for(let e of i)o(e);return a}async function _(e){let t=p.load(e.source);if(!Array.isArray(t))return[];let n=[];return await v({entries:t,ownerFilePath:e.filePath,currentFilePath:e.filePath,readFile:e.readFile,visitedRefs:/* @__PURE__ */ new Set([e.filePath]),refs:n}),n}async function v(e){let{ownerFilePath:t,currentFilePath:r,readFile:i,refs:a}=e;for(let o of e.entries){let s=K(o);if(s===void 0)continue;if(typeof s.$ref==`string`){let o=n(s.$ref,r);if(o===null||i===void 0||e.visitedRefs.has(o))continue;let c;try{c=await i(o)}catch{continue}let l=p.load(c);if(!Array.isArray(l))continue;let u=new Set(e.visitedRefs);u.add(o),await v({entries:l,ownerFilePath:t,currentFilePath:o,readFile:i,visitedRefs:u,refs:a});continue}let c=typeof s.page==`string`?s.page:s.href;typeof c==`string`&&y(a,c,r,t),Array.isArray(s.items)&&await v({...e,entries:s.items}),m(s)&&Array.isArray(s.menu)&&await v({...e,entries:s.menu})}}function y(e,t,n,r){let i=d(t,n);i!==null&&e.push({kind:`link`,raw:t,...i,...n===r?{}:{filePath:n}})}async function b(e){let t=p.load(e.source);if(!Array.isArray(t))throw Error(`Sidebar "${e.file.path}" must be a YAML sequence at the top level.`);return x({...e,entries:t})}async function x(e){let n=e.entries,r=n.filter(e=>t(e)&&m(e));if(r.length>0&&r.length!==n.length)throw Error(`Sidebar "${e.file.path}": when a sidebar uses navigation tabs, every top-level entry must be a tab (found ${n.length-r.length} other entries).`);let i={file:e.file,routes:e.routes,assignedRouteSlugs:/* @__PURE__ */ new Set,versionedDirectories:/* @__PURE__ */ new Set,report:e.report,readFile:e.readFile,skipRoutes:e.skipRoutes,exists:e.exists,sidebarByDirectory:e.sidebarByDirectory??/* @__PURE__ */ new Map,visitedRefs:/* @__PURE__ */ new Set([e.file.path])},a=[];if(r.length>0){for(let[e,t]of r.entries())a.push(await P({...i,entry:t,tabIndex:e}));L({file:e.file,tabs:a,routes:e.routes})}else for(let e of n)a.push(...await S({...i,entry:e}));return{assignedRouteSlugs:[...i.assignedRouteSlugs].sort(),versionedDirectories:[...i.versionedDirectories].sort(),nodes:a}}async function S(e){let n=await C(e),r=t(e.entry)?e.entry.rbac:void 0;if(r===void 0)return n;let i=I({...e,rbac:r});for(let e of n)Object.assign(e,i);return n}async function C(e){let t=K(e.entry);if(t===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar entry ${G(e.entry)} is not a page reference or a group.`),[];if(m(t))throw Error(`Sidebar "${e.file.path}": "tab" is only allowed at the top level (found nested tab "${t.tab}").`);if(t.menu!==void 0)throw Error(`Sidebar "${e.file.path}": "menu" is only allowed directly on a tab.`);if(typeof t.$ref==`string`)return D({...e,ref:t.$ref});if(typeof t.directory==`string`&&E(t)&&t.items===void 0)return C({...e,entry:{...t,directory:void 0,items:[{directory:t.directory,flatten:t.flatten}]}});if(typeof t.directory==`string`){let r=n(t.directory,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar directory "${t.directory}" is outside the content root.`),[];let i=e.routes.inDirectory(r);i.length===0&&h(e,`sidebar/missing-target`,`Sidebar directory "${t.directory}" has no pages.`);let a=await z({...e,directoryPath:r,flatten:t.flatten===!0,pages:i.filter(t=>!e.skipRoutes?.has(t.slug))}),o=J(t.group)??J(t.label);return o===void 0?a:[{type:`group`,...X(t,e),menuStyle:Z(t),items:a.length>0?a:void 0,label:o,labelTranslationKey:T(t)}]}if(typeof t.separator==`string`)return[{type:`separator`,...X(t,e),label:t.separator,labelTranslationKey:J(t.separatorTranslationKey)}];let r=await V(t,e),i=r.route;if(i)for(let t of c([i]))e.versionedDirectories.add(t);let a;if(Array.isArray(t.items)){a=[];for(let n of t.items)a.push(...await S({...e,entry:n}))}let o=J(t.group)??J(t.label)??(i===void 0?J(t.href):void 0)??r.anchor,s=E(t);return[{type:w(t,i,r.linksConnectedHeading===!0),...X(t,e),menuStyle:s?Z(t):void 0,external:t.external===!0||void 0,languageInsensitive:r.languageInsensitive?!0:void 0,items:a&&a.length>0?a:void 0,label:o,labelTranslationKey:T(t),link:r.link,isGroup:s?!0:void 0,version:J(t.version)??i?.version??void 0,versionGroup:i?.versionGroup??void 0}]}function w(e,t,n){if(E(e)&&!n)return`group`;if(t!==void 0||e.href||e.label)return`link`}function T(e){return J(E(e)?e.groupTranslationKey:e.labelTranslationKey)}function E(e){return J(e.group)!==void 0}async function D(e){let{ref:t}=e,r=n(t,e.file.path);if(r===null)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is outside the content root.`),[];if(e.readFile===void 0)return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${t}" is not supported here.`),[];if(e.visitedRefs.has(r))return h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" includes itself.`),[];let i;try{i=await e.readFile(r)}catch{return h(e,`sidebar/missing-target`,`Sidebar $ref "${r}" could not be read.`),[]}let a=p.load(i);return Array.isArray(a)?O(e,r,a):(h(e,`sidebar/invalid-entry`,`Sidebar $ref "${r}" must be a YAML sequence.`),[])}async function O(e,t,n){let r=/* @__PURE__ */ new Set([...e.visitedRefs,t]),i=[];for(let a of n)i.push(...await S({...e,entry:a,file:{path:t},visitedRefs:r}));return i}async function k(e,t){if(e.readFile===void 0)return[];let n=p.load(await e.readFile(t));return Array.isArray(n)?O({...e,assignedRouteSlugs:/* @__PURE__ */ new Set,report:void 0},t,n.map(A)):[]}function A(e){if(!t(e)||!m(e))return e;let{tab:n,menu:r,...i}=e;return{...i,group:n,items:i.items??r}}function j(e,t){return`${e}-${t.normalize(`NFKD`).replace(/[\u0300-\u036f]/g,``).toLowerCase().replace(/[^a-z0-9]+/g,`-`).replace(/^-+|(?<!-)-+$/g,``)||`tab`}`}function M(e){return/* @__PURE__ */ Error(`Sidebar "${e.file.path}": tab "${e.label}" ${e.message}.`)}function N(e){let{file:t,entry:n}=e,r=n.tab,i=n.menu!==void 0;if(i&&n.items!==void 0)throw M({file:t,label:r,message:`cannot have both "menu" and "items"`});if(i&&n.page!==void 0)throw M({file:t,label:r,message:`has "menu" and cannot also have "page"`});if(!i&&n.page===void 0)throw M({file:t,label:r,message:`needs "page" or "menu"`});if(typeof n.page==`string`&&n.page.includes(`#`))throw M({file:t,label:r,message:`page must not contain a heading anchor`});if(i&&!Array.isArray(n.menu))throw M({file:t,label:r,message:`"menu" must be a list of entries`});if(i&&Array.isArray(n.menu)&&n.menu.length===0)throw M({file:t,label:r,message:`has an empty "menu"`});if(n.$ref!==void 0||n.directory!==void 0||n.group!==void 0||n.href!==void 0)throw M({file:t,label:r,message:`accepts only "page", "items", "menu" and "icon"; move "$ref"/"directory"/"group"/"href" into "items"`})}async function P(e){let{entry:t}=e,n=t.tab;N({file:e.file,entry:t});let r=j(e.tabIndex,n);if(t.menu!==void 0){let i=Array.isArray(t.menu)?t.menu:[],a=[];for(let[t,n]of i.entries()){let i=await F({...e,tabId:r,index:t,raw:n});i!==void 0&&a.push(i)}return{tab:!0,tabId:r,label:n,menu:a,...Q(t.icon,e),...I({...e,rbac:t.rbac})}}let[i]=await S({...e,entry:{page:t.page,label:n,items:t.items,rbac:t.rbac}}),a=i?.items??[];return{...i,tab:!0,tabId:r,...Q(t.icon,e),items:a}}async function F(e){let{file:t,entry:n,tabId:r,index:i,raw:a}=e,o=n.tab,s=K(a);if(s===void 0||typeof s.page!=`string`)throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" needs "page".`);if(s.page.includes(`#`))throw Error(`Sidebar "${t.path}": menu entry ${i+1} of tab "${o}" page must not contain a heading anchor.`);let c=`${r}/${i}`,[l]=await S({...e,entry:s});return l?.link===void 0?void 0:{...l,tabId:c,items:l.items??[]}}function I(e){return a(e.rbac,()=>h(e,`sidebar/invalid-entry`,`Sidebar entry has an invalid "rbac" value, so it is hidden.`))}function L(e){let t=/* @__PURE__ */ new Map,n=(n,r)=>{for(let i of r){let r=t.get(i);if(r!==void 0&&r.tabId!==n.tabId)throw Error(`Sidebar "${e.file.path}": route "${i}" is claimed by two navigation tabs, "${r.label}" and "${n.label}". A route can belong to one tab only.`);t.set(i,n)}};for(let t of e.tabs){if(t.menu!==void 0){for(let r of t.menu)r.tabId!==void 0&&n({tabId:r.tabId,label:`${t.label} > ${r.label??r.link}`},R({routes:e.routes,link:r.link,items:r.items}));continue}t.tabId!==void 0&&n({tabId:t.tabId,label:t.label??t.link??``},R({routes:e.routes,link:t.link,items:t.items}))}}function R(e){let t=[],n=n=>{if(n.link===void 0||n.languageInsensitive===!0)return;let r=e.routes.bySlug(n.link);r!==void 0&&r.originFilePath!==null&&t.push(r.slug)};n({link:e.link});let r=e=>{if(e!==void 0)for(let t of e)n(t),r(t.items)};return r(e.items),t}async function z(t){let n=t.directoryPath===``?``:`${t.directoryPath}/`,r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Set,o=t.directoryPath.startsWith(`${e}/`),s=t.pages.filter(e=>o||e.locale===``).map(e=>({route:e,relativePath:e.originFilePath?.startsWith(n)?e.originFilePath.slice(n.length):null})).sort((e,t)=>B(e.relativePath??e.route.slug,t.relativePath??t.route.slug));for(let e of s){let n=e.relativePath?.split(`/`).slice(0,-1)??[],r=c(n);if(r!==void 0){if(!a.has(r.path)){a.add(r.path);let e=await k(t,r.path);e.length>0&&u(l(n,r.depth)).push(...e)}continue}U(e.route,t),e.route.version&&t.versionedDirectories.add(t.directoryPath),u(l(n,n.length)).push({type:`link`,link:e.route.slug,version:e.route.version??void 0,versionGroup:e.route.versionGroup??void 0})}return r;function c(e){for(let n=0;n<=e.length;n++){let r=f.join(t.directoryPath,...e.slice(0,n)),i=t.sidebarByDirectory.get(r);if(i!==void 0&&!t.visitedRefs.has(i))return{depth:n,path:i}}}function l(e,n){return t.flatten?[]:e.slice(0,n).filter(e=>!e.startsWith(`@`))}function u(e){let t=r,n=``;for(let r of e){n=n===``?r:`${n}/${r}`;let e=i.get(n);if(e){t=e;continue}let a=[];t.push({type:`group`,items:a,label:r}),i.set(n,a),t=a}return t}}function B(e,t){return e.startsWith(`index.`)?-1:t.startsWith(`index.`)?1:e.localeCompare(t,void 0,{numeric:!0})}async function V(e,t){if(typeof e.page==`string`){let{path:n,suffix:r,anchor:a}=i(e.page.trim()),o=await H(n,t);if(!o)return{};let s=e.disconnect!==!0;return s&&U(o,t),{link:`${o.slug}${r}`,anchor:a,linksConnectedHeading:s&&a!==void 0,route:o}}if(typeof e.href==`string`){let n=e.href;if(n.startsWith(`/`)){let e=t.routes.bySlug(n);return e?{link:e.slug,route:e}:{link:n,languageInsensitive:!0}}return{link:n,languageInsensitive:!0}}return{}}async function H(e,t){let r=o(e,t.file.path,t.routes);if(r.kind===`escaped`){h(t,`sidebar/invalid-entry`,`Sidebar page "${e}" is outside the content root.`);return}if(r.kind===`missing`){let r=n(e,t.file.path);r!==null&&await t.exists?.(r)&&h(t,`sidebar/missing-target`,`Sidebar page "${e}" is a file that makes no page.`);return}return r.value}function U(e,t){t.assignedRouteSlugs.add(e.slug)}async function W(e){if(e.versionedDirectories.length===0)return;let t=await s({io:e.io,routes:e.routes,versionedDirectories:e.versionedDirectories}),n=e=>{for(let r of e){if(r.version!==void 0&&r.versionGroup!==void 0){let e=t.get(r.versionGroup),n=e?.labels.get(r.version);n&&(r.versionLabel=n),e?.defaultVersion===r.version&&(r.isDefaultVersion=!0)}r.items&&n(r.items),r.menu&&n(r.menu)}};n(e.nodes)}function G(e){let t=JSON.stringify(e)??String(e);return t.length>80?`${t.slice(0,79)}…`:t}function K(e){return typeof e==`string`?e.trim()===``?void 0:{page:e}:t(e)?e:void 0}function q(e){if(!Array.isArray(e))return;let n=[];for(let r of e){if(!t(r))continue;let e=J(r.name),i=J(r.icon);(e!==void 0||i!==void 0)&&n.push({name:e??``,color:J(r.color),icon:i,position:r.position===`before`||r.position===`after`?r.position:void 0})}return n.length>0?n:void 0}function J(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function Y(e,t){return t.find(t=>t===e)}function X(e,t){return{badges:q(e.badges),...Q(e.icon,t),expanded:e.expanded===!0?`true`:Y(e.expanded,[`always`]),selectFirstItemOnExpand:e.selectFirstItemOnExpand===!0||void 0,separatorLine:e.separatorLine===!0||void 0,linePosition:Y(e.linePosition,[`top`,`bottom`]),target:J(e.target),sublabel:J(e.sublabel)}}function Z(e){return Y(e.menuStyle,[`drilldown`,`drilldown-header`])}function Q(e,n){let r=t(e)?J(e.srcSet):void 0;if(r!==void 0){let e=u(r);if(e===null)return{srcSet:r};for(let t of e)t.src=$(t.src,n);return{srcSet:l(e)}}let i=J(e);return i===void 0?{}:{icon:$(i,n)}}function $(e,t){if(!r(e))return e;let i=n(e,t.file.path);return i===null?(h(t,`sidebar/invalid-entry`,`Sidebar icon "${e}" is outside the content root.`),e):`/${i}`}export{b as bundleSidebar,x as bundleSidebarEntries,_ as collectSidebarLinkRefs,g as collectSidebarRefTargets,W as stampDefaultVersions};
|
|
@@ -1,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{compareStrings as i}from"../../../../shared/utils/compare-strings.js";import{isObject as a}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as o}from"../../../../shared/utils/l10n.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as s,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as c,SIDEBAR_ROUTE_DEP_KEY as l,localizedSidebarDepKey as ee}from"../../../../shared/constants/route-deps.js";import{toPublicVersionedSlug as u}from"../../../../shared/constants/versions.js";import{splitUrlSuffix as d}from"../../../../shared/utils/routes/split-url-suffix.js";import{NAV_ITEM_RBAC as f}from"../../../../server/rbac/types.js";import{resolveContentPath as p}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as m}from"../assets/extensions.js";import{resolvePageTarget as h}from"../../../../shared/utils/routes/resolve-page-target.js";import{collectVersionGroups as g,findVersionedDirectories as _}from"../../../versions/version-groups.js";import{publicLink as v}from"../../../versions/public-link.js";import{linkedPageAccess as y}from"../../utils/link-access.js";import{safeDecodeURI as b}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as x,parseSrcSet as S}from"../assets/srcset.js";import{bundleSidebar as C,bundleSidebarEntries as te,collectSidebarLinkRefs as w,collectSidebarRefTargets as ne,stampDefaultVersions as re}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as T,sidebarStartEntityKey as E}from"./contributions.js";import{applySubtree as D}from"./subtree.js";import{collectSlugOverrides as O}from"../../utils/slug-overrides.js";import{SITE_START_ENTITY_KEY as ie}from"../../../../shared/constants/site-start.js";import{posix as k}from"node:path";import{REDOCLY_TEAMS_RBAC as A}from"@redocly/config";const j=`internal.sidebar`,M=r(j,`aggregate`),N=/(^|\/)(?:[^/]*\.)?sidebars\.ya?ml$/i,P=/(^|\/)sidebars\.ya?ml$/i,F=`sidebars.yaml`,I=`redocly.yaml`;function L(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function R(e){if(Array.isArray(e))return e.find(e=>z(e.label)!==void 0)?.label}function z(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function B(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function V(e,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,i=e?await t.loadEntity(e):void 0,a=r.tabId!==void 0,o=a?{...r,isGroup:!0,label:r.label??R(i)}:r,s=i===void 0?[o]:D(o,i);for(let e of s){let i=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],o=e[A]??(i===void 0&&e.link!==void 0?t.accessOf(e.link)??void 0:void 0);n.push({type:e.type,expanded:e.expanded,selectFirstItemOnExpand:e.selectFirstItemOnExpand,external:e.external,target:e.target,languageInsensitive:e.languageInsensitive,icon:e.icon===void 0?void 0:await t.resolveAsset(e.icon),srcSet:e.srcSet===void 0?void 0:await H(e.srcSet,t),items:e.items?await V(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await V(e.menu,t):void 0,label:a?e.label??B(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?u(e.link,e.versionGroup,e.version,e.isDefaultVersion===!0):e.link,separatorLine:e.separatorLine,linePosition:e.linePosition,variant:e.variant,menuStyle:e.menuStyle,sublabel:e.sublabel,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,httpVerb:e.httpVerb,deprecated:e.deprecated,badges:e.badges,[A]:o,[f]:i})}}return n}async function H(e,t){let n=S(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return x(r)}function U(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!m(r))return r;let i=await e.resolveImageReference(r,``),a=p(b(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function W(e){return e.tabId!==void 0}function G(e){return W(e)&&e.link!==void 0}function K(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[A]:e[A],[f]:e[f]}}function q(e){return{...K(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function J(e){return{...K(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(G).map(q)}}const Y=t(M,async e=>{let t=U(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,s=i.length===0?/* @__PURE__ */ new Map:await g({io:e.io,routes:e.routes,versionedDirectories:i}),c=await V(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??o(e,n)))??a(e),accessOf:t=>y(t,e.routes,s),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(W).map(J)}:c,...t.collected()}});async function ae(e){let t=await e.loadEntity(e.subtreeKey);return V(D({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function oe(e){let t=typeof e==`string`?e:a(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function X(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function Z(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(D({link:r},await t.entities.load(i)))}return n}function se(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function ce(e){let t=[];for(let n of await e.list({type:T}))t.push(...await e.load(n.key));return t}function le(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function ue(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=de(e,t,n);return r===null?null:{item:e,link:r.link,label:await fe(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=p(i,I),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function de(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=d(e.page.trim()),o=h(r,I,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${v(s,n)}${i}`,anchor:a,route:s}}async function fe(e,t,n){let r=z(e.label)??z(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,o=i?await n(i):void 0;return(a(o)?z(o.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function pe(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?u(t.link,t.versionGroup,t.version,!0):t.link}function me(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&P.test(e))??t).link}function he(e){let t=null;for(let{slug:n,originFilePath:r,locale:a,versionGroup:o}of e)r!==null&&a===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&i(n,t)<0)&&(t=n);return t}const ge=e({id:j,version:`1.24.0`,content:{filter:{match:e=>N.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await w({source:n,filePath:e.path,readFile:t.io.readFile})}}},async finalize(e){let t=[],r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Map,o=/* @__PURE__ */ new Map,u=[],f=/* @__PURE__ */ new Map,p=/* @__PURE__ */ new Map,m=[],h=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),v=e.routes.all(),b=O(v,e.localeContext),x=_(v),S=x.length>0?x:void 0;h.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let w=new Map(h.map(({path:e,source:t})=>[e,t])),T=/* @__PURE__ */ new Map;for(let{path:e}of h)P.test(e)&&T.set(k.dirname(e),e);let D=/* @__PURE__ */ new Set;for(let{path:e,source:t}of h)for(let n of ne(t,e))D.add(n);let j={routes:e.routes,report:e=>r.push(e),readFile:async t=>w.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:T},M=async(n,r)=>{if(n.nodes.length===0)return;await re({io:e.io,routes:e.routes,logger:e.logger,nodes:n.nodes,versionedDirectories:x});let i=Y.withArgs({nodes:n.nodes,versionedDirectories:S},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),p.set(i,n.nodes);let a=/* @__PURE__ */ new Map;for(let r of e.localeContext.locales){let e=Y.withArgs({nodes:n.nodes,locale:r,slugOverrides:b[r]??{},versionedDirectories:S});t.push(e),a.set(r,e)}return f.set(i,a),i};for(let{path:t,source:n}of h){if(D.has(t))continue;let s=await C({...j,file:{path:t},source:n}),c=await M(s,t);if(c===void 0)continue;a.set(t,c);let l=t.startsWith(`@l10n/`)?null:$(s.nodes);l!==null&&m.push({path:t,link:l}),u.push(await Z(s,e));for(let e of s.assignedRouteSlugs){let n=o.get(e);n!==void 0&&r.push({code:`sidebar/route-conflict`,message:`Page "${e}" is in sidebars ${n} and ${t}; it shows ${t}.`,location:{filePath:t}}),i.set(e,c),o.set(e,t)}}se(i,u);let N=new Map(v.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=N.get(t);if(e===void 0||e.originFilePath===null)continue;let o=oe(n);if(o===null)continue;let s=k.normalize(o.startsWith(`/`)?o.slice(1):k.join(k.dirname(e.originFilePath),o)),c=a.get(s);if(c===void 0){r.push({code:`sidebar/missing-target`,message:`Front matter sidebar "${o}" is not a sidebar file of this project.`,location:{filePath:e.originFilePath}});continue}i.set(e.slug,c)}let I=await ce(e.entities),L=/* @__PURE__ */ new Set,R=/* @__PURE__ */ new Map,z=/* @__PURE__ */ new Map;for(let t of I){let n=i.get(t.route);if(n===void 0){let r=await te({...j,file:{path:F},entries:t.entries});if(n=await M(r),n===void 0)continue;let a=(await Z(r,e)).keys();for(let e of[...r.assignedRouteSlugs,...a])i.has(e)||(i.set(e,n),L.add(e))}let r=R.get(n);R.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=z.get(n);z.set(n,a===void 0?t.breadcrumbs??[]:le(a,t.breadcrumbs))}if(h.length===0&&v.length>0){let e=await C({...j,file:{path:F},source:`- directory: .
|
|
2
|
-
`,skipRoutes:
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t,createInlineEntity as n}from"../../../loaders/define.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import"../../../../shared/constants/l10n/defaults.js";import{NAV_ITEM_RBAC as i}from"../../../../server/rbac/types.js";import{compareStrings as a}from"../../../../shared/utils/compare-strings.js";import{isObject as o}from"../../../../shared/utils/is-object.js";import{toLocaleSlug as s}from"../../../../shared/utils/l10n.js";import{resolveContentPath as c}from"../../../../shared/utils/resolve-content-path.js";import{isLocalImagePath as l}from"../assets/extensions.js";import{splitUrlSuffix as u}from"../../../../shared/utils/routes/split-url-suffix.js";import{resolvePageTarget as d}from"../../../../shared/utils/routes/resolve-page-target.js";import{toPublicVersionedSlug as f}from"../../../../shared/constants/versions.js";import{collectVersionGroups as p,findVersionedDirectories as ee}from"../../../versions/version-groups.js";import{publicLink as m}from"../../../versions/public-link.js";import{linkedPageAccess as h}from"../../utils/link-access.js";import{safeDecodeURI as g}from"../../../../shared/utils/safe-decode-uri.js";import{joinSrcSet as _,parseSrcSet as v}from"../assets/srcset.js";import{bundleSidebar as y,bundleSidebarEntries as te,collectSidebarLinkRefs as b,collectSidebarRefTargets as ne,stampDefaultVersions as x}from"./bundle.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as S,sidebarStartEntityKey as re}from"./contributions.js";import{applySubtree as C}from"./subtree.js";import{collectSlugOverrides as w}from"../../utils/slug-overrides.js";import{SIDEBAR_BACK_LINK_ROUTE_DEP_KEY as ie,SIDEBAR_BREADCRUMBS_ROUTE_DEP_KEY as T,SIDEBAR_ROUTE_DEP_KEY as E,localizedSidebarDepKey as D}from"../../../../shared/constants/route-deps.js";import{SITE_START_ENTITY_KEY as ae}from"../../../../shared/constants/site-start.js";import{posix as O}from"node:path";import{REDOCLY_TEAMS_RBAC as k}from"@redocly/config";const A=`internal.sidebar`,j=r(A,`aggregate`),M=/(^|\/)(?:[^/]*\.)?sidebars\.ya?ml$/i,N=/(^|\/)sidebars\.ya?ml$/i,P=`sidebars.yaml`,F=`redocly.yaml`;function I(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Array.isArray(e.tabs)}function L(e){if(Array.isArray(e))return e.find(e=>R(e.label)!==void 0)?.label}function R(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function z(e){let t=((e??``).split(/[?#]/)[0]?.split(`/`).filter(Boolean).pop()??``).replace(/[-_]+/g,` `).trim();return t.charAt(0).toUpperCase()+t.slice(1)}async function B(e,t){let n=[];for(let r of e){let e=r.link?t.subtreeKeyOf(r.link):void 0,a=e?await t.loadEntity(e):void 0,o=r.tabId!==void 0,s=o?{...r,isGroup:!0,label:r.label??L(a)}:r,c=a===void 0?[s]:C(s,a);for(let e of c){let a=e[`redocly::nav-item-rbac`]??r[`redocly::nav-item-rbac`],s=e[k]??(a===void 0&&e.link!==void 0?t.accessOf(e.link)??void 0:void 0);n.push({type:e.type,expanded:e.expanded,selectFirstItemOnExpand:e.selectFirstItemOnExpand,external:e.external,target:e.target,languageInsensitive:e.languageInsensitive,icon:e.icon===void 0?void 0:await t.resolveAsset(e.icon),srcSet:e.srcSet===void 0?void 0:await V(e.srcSet,t),items:e.items?await B(e.items,t):void 0,tab:e.tab,tabId:e.tabId,menu:e.menu?await B(e.menu,t):void 0,label:o?e.label??z(e.link):e.label,labelTranslationKey:e.labelTranslationKey,link:e.link!==void 0&&e.versionGroup!==void 0&&e.version!==void 0?f(e.link,e.versionGroup,e.version,e.isDefaultVersion===!0):e.link,separatorLine:e.separatorLine,linePosition:e.linePosition,variant:e.variant,menuStyle:e.menuStyle,sublabel:e.sublabel,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,httpVerb:e.httpVerb,deprecated:e.deprecated,badges:e.badges,[k]:s,[i]:a})}}return n}async function V(e,t){let n=v(e);if(n===null)return e;let r=await Promise.all(n.map(async e=>Object.assign(e,{src:await t.resolveAsset(e.src)})));return _(r)}function H(e){let t=/* @__PURE__ */ new Map,n=/* @__PURE__ */ new Map;return{async resolve(r){if(!l(r))return r;let i=await e.resolveImageReference(r,``),a=c(g(r),``);a!==null&&t.set(`file:${a}`,{kind:`file`,path:a});for(let e of i.entityDeps)t.set(e.kind===`file`?`file:${e.path}`:`entity:${e.key}`,e);for(let e of i.assetUsages)n.set(e.path,e);return i.result.kind===`assetRef`?i.result.url:r},collected(){return{entityDeps:[...t.values()],assetUsages:[...n.values()]}}}}function U(e){return e.tabId!==void 0}function W(e){return U(e)&&e.link!==void 0}function G(e){return{tabId:e.tabId,version:e.version,versionGroup:e.versionGroup,isDefaultVersion:e.isDefaultVersion,versionLabel:e.versionLabel,[k]:e[k],[i]:e[i]}}function K(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon,items:e.items??[]}}function q(e){return{...G(e),label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.menu?void 0:e.link,icon:e.icon,items:e.menu?void 0:e.items??[],menu:e.menu?.filter(W).map(K)}}const J=t(j,async e=>{let t=H(e.markdown),{locale:n,slugOverrides:r={},versionedDirectories:i=[]}=e.args,a=t=>e.routes.bySlug(t)?.sidebarSubtreeEntityKey,o=i.length===0?/* @__PURE__ */ new Map:await p({io:e.io,routes:e.routes,versionedDirectories:i}),c=await B(e.args.nodes,{loadEntity:t=>e.entities.load(t),subtreeKeyOf:e=>(n===void 0?void 0:a(r[e]??s(e,n)))??a(e),accessOf:t=>h(t,e.routes,o),resolveAsset:t.resolve});return{value:e.args.nodes.some(e=>e.tab)?{tabs:c.filter(U).map(q)}:c,...t.collected()}});async function oe(e){let t=await e.loadEntity(e.subtreeKey);return B(C({link:e.routeSlug,...e.version},t),{loadEntity:e.loadEntity,subtreeKeyOf:()=>void 0,accessOf:()=>void 0,resolveAsset:async e=>e})}function se(e){let t=typeof e==`string`?e:o(e)?e.path:void 0;return typeof t==`string`&&t.trim()!==``?t.trim():null}function Y(e){return[e.originPluginId,e.originFilePath,e.routeId].join(`\0`)}async function X(e,t){let n=/* @__PURE__ */ new Map;for(let r of e.assignedRouteSlugs){let e=t.routes.bySlug(r),i=e?.originFilePath===null?e.sidebarSubtreeEntityKey:null;if(!i||await t.entities.get(i)===null)continue;let a=e=>{for(let i of e){let e=i.link===void 0?void 0:t.routes.bySlug(i.link);e!==void 0&&!n.has(e.slug)&&n.set(e.slug,r),i.items&&a(i.items)}};a(C({link:r},await t.entities.load(i)))}return n}function ce(e,t){for(let n of t)for(let[t,r]of n){let n=e.get(r);n!==void 0&&!e.has(t)&&e.set(t,n)}}async function le(e){let t=[];for(let n of await e.list({type:S}))t.push(...await e.load(n.key));return t}function ue(e,t=[]){let n=[];for(let[r,i]of e.entries()){if(t[r]?.link!==i.link)break;n.push(i)}return n}async function de(e,t,n,r,i){let a=await Promise.all(e.map(async e=>{let r=fe(e,t,n);return r===null?null:{item:e,link:r.link,label:await Z(e,r,i)}})),o=/* @__PURE__ */ new Map;for(let{item:e,link:t,label:n}of a.filter(e=>e!==null))for(let i of e.linkedSidebars??[]){let e=c(i,F),a=e===null?void 0:r.get(e);a!==void 0&&!o.has(a)&&o.set(a,{label:n,link:t})}return o}function fe(e,t,n){if(typeof e.href==`string`&&e.href.trim()!==``)return{link:e.href.trim()};if(typeof e.page!=`string`||e.page.trim()===``)return null;let{path:r,suffix:i,anchor:a}=u(e.page.trim()),o=d(r,F,t);if(o.kind!==`found`)return null;let s=o.value;return{link:`${m(s,n)}${i}`,anchor:a,route:s}}async function Z(e,t,n){let r=R(e.label)??R(e.group)??t.anchor;if(r!==void 0)return r;let i=t.route?.sidebarSubtreeEntityKey,a=i?await n(i):void 0;return(o(a)?R(a.label):void 0)??t.link}function Q(e,t){for(let n of e){if(!t(n))continue;if(n.link!==void 0&&n.languageInsensitive!==!0)return n;let e=Q([...n.items??[],...n.menu??[]],t);if(e!==null)return e}return null}function pe(e,t){return Q(e,e=>e.version===void 0||e.version===t)?.link??null}function $(e){let t=Q(e,e=>e.version===void 0||e.isDefaultVersion===!0);return t?.link===void 0?null:t.versionGroup!==void 0&&t.version!==void 0?f(t.link,t.versionGroup,t.version,!0):t.link}function me(e){let[t]=e;if(t===void 0)return null;let n=t.path.split(`/`).length;return(e.find(({path:e})=>e.split(`/`).length===n&&N.test(e))??t).link}function he(e){let t=null;for(let{slug:n,originFilePath:r,locale:i,versionGroup:o}of e)r!==null&&i===``&&o===null&&(t===null||n.length<t.length||n.length===t.length&&a(n,t)<0)&&(t=n);return t}const ge=e({id:A,version:`1.24.0`,content:{filter:{match:e=>M.test(e)},async extractFile(e,t){let n=await t.io.readFile(e.path);return{routes:[],linkRefs:await b({source:n,filePath:e.path,readFile:t.io.readFile})}}},async finalize(e){let t=[],r=[],i=/* @__PURE__ */ new Map,a=/* @__PURE__ */ new Map,o=/* @__PURE__ */ new Map,s=[],c=/* @__PURE__ */ new Map,l=/* @__PURE__ */ new Map,d=[],f=await Promise.all(e.files.map(async t=>({path:t.path,source:await e.io.readFile(t.path)}))),m=e.routes.all(),g=w(m,e.localeContext),_=ee(m),v=_.length>0?_:void 0;f.sort((e,t)=>e.path.split(`/`).length-t.path.split(`/`).length);let b=new Map(f.map(({path:e,source:t})=>[e,t])),S=/* @__PURE__ */ new Map;for(let{path:e}of f)N.test(e)&&S.set(O.dirname(e),e);let C=/* @__PURE__ */ new Set;for(let{path:e,source:t}of f)for(let n of ne(t,e))C.add(n);let A={routes:e.routes,report:e=>r.push(e),readFile:async t=>b.get(t)??e.io.readFile(t),exists:t=>e.io.exists(t),sidebarByDirectory:S},j=async(n,r)=>{if(n.nodes.length===0)return;await x({io:e.io,routes:e.routes,logger:e.logger,nodes:n.nodes,versionedDirectories:_});let i=J.withArgs({nodes:n.nodes,versionedDirectories:v},r===void 0?void 0:{metadata:{sourcePath:r}});t.push(i),l.set(i,n.nodes);let a=/* @__PURE__ */ new Map;for(let r of e.localeContext.locales){let e=J.withArgs({nodes:n.nodes,locale:r,slugOverrides:g[r]??{},versionedDirectories:v});t.push(e),a.set(r,e)}return c.set(i,a),i};for(let{path:t,source:n}of f){if(C.has(t))continue;let c=await y({...A,file:{path:t},source:n}),l=await j(c,t);if(l===void 0)continue;a.set(t,l);let u=t.startsWith(`@l10n/`)?null:$(c.nodes);u!==null&&d.push({path:t,link:u}),s.push(await X(c,e));for(let e of c.assignedRouteSlugs){let n=o.get(e);n!==void 0&&r.push({code:`sidebar/route-conflict`,message:`Page "${e}" is in sidebars ${n} and ${t}; it shows ${t}.`,location:{filePath:t}}),i.set(e,l),o.set(e,t)}}ce(i,s);let M=new Map(m.map(e=>[e.slug,e]));for(let[t,n]of Object.entries(e.routes.metadata(`sidebar`))){let e=M.get(t);if(e===void 0||e.originFilePath===null)continue;let o=se(n);if(o===null)continue;let s=O.normalize(o.startsWith(`/`)?o.slice(1):O.join(O.dirname(e.originFilePath),o)),c=a.get(s);if(c===void 0){r.push({code:`sidebar/missing-target`,message:`Front matter sidebar "${o}" is not a sidebar file of this project.`,location:{filePath:e.originFilePath}});continue}i.set(e.slug,c)}let F=await le(e.entities),I=/* @__PURE__ */ new Set,L=/* @__PURE__ */ new Map,R=/* @__PURE__ */ new Map;for(let t of F){let n=i.get(t.route);if(n===void 0){let r=await te({...A,file:{path:P},entries:t.entries});if(n=await j(r),n===void 0)continue;let a=(await X(r,e)).keys();for(let e of[...r.assignedRouteSlugs,...a])i.has(e)||(i.set(e,n),I.add(e))}let r=L.get(n);L.set(n,r===void 0?t.backLink??null:r!==null&&r.link===t.backLink?.link?r:null);let a=R.get(n);R.set(n,a===void 0?t.breadcrumbs??[]:ue(a,t.breadcrumbs))}if(f.length===0&&m.length>0){let e=await y({...A,file:{path:P},source:`- directory: .
|
|
2
|
+
`,skipRoutes: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{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{slugifySegment as n}from"../../../../shared/utils/routes/slugify-segment.js";import{
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{slugifySegment as n}from"../../../../shared/utils/routes/slugify-segment.js";import{compileContentGlob as r}from"../../utils/glob.js";import{isPlanFeatureGranted as i}from"../../../../shared/plan-gates.js";import{AGENT_SKILLS_BASE as a,SKILLS_FOLDER as o,SKILLS_INDEX_SLUG as s,SKILL_FILENAME as c}from"../../utils/skill-paths.js";import{SKILL_ENTITY_TYPE as l,skillEntityKey as u}from"../../types/skill-entity.js";import{parseSkill as d}from"./parse-skill.js";const f=`internal.skills`,p=`${a}/:slug/${c}`,m=c.toLowerCase();function h(e){let t=e.split(`/`);return t.length===3&&t[0]===`@skills`&&t[2].toLowerCase()===m}function g(e,t){let r=/* @__PURE__ */ new Map;for(let t of e){if(!h(t.path))continue;let[,e,n]=t.path.split(`/`),i=r.get(e);i?i.push(n):r.set(e,[n])}let i=[],a=/* @__PURE__ */ new Map;for(let[e,s]of r){let r=s.includes(`SKILL.md`)?c:s[0];s.length>1&&t.warn(`Multiple skill files in "${o}/${e}" differ only by case; using "${r}".`);let l=n(e),u=a.get(l);if(u!==void 0){t.warn(`Skipping skill folder "${o}/${e}": its slug "${l}" collides with the folder "${u}" after slugification.`);continue}a.set(l,e),i.push({slug:l,sourcePath:`${o}/${e}/${r}`})}return i}const _=e({id:f,version:`1.3.0`,server:{routes:[{method:`GET`,path:s,handler:{filePath:`./server/routes.ts`,importer:import.meta.url,exportName:`skillsIndex`}},{method:`GET`,path:p,handler:{filePath:`./server/routes.ts`,importer:import.meta.url,exportName:`skillMarkdown`}}]},content:{filter:{match:e=>e===`SKILL.md`||h(e)},async extractAll(e){let n=[...e.config.mcp?.ignore??[],...e.config.skills?.excludeFiles??[]],a=n.length>0?r(n):()=>!1,o=process.env.PROJECT_SLUG||`project-docs`,s=g(e.files,e.logger);e.files.some(e=>e.path===`SKILL.md`)&&s.push({slug:o,sourcePath:c});let f=/* @__PURE__ */ new Map,p=/* @__PURE__ */ new Map,m=i(e.config,`rbac`);for(let n of s){if(a(n.sourcePath))continue;let r=await e.io.readFile(n.sourcePath),i=d(n.sourcePath,r);if(`error`in i){e.logger.warn(i.error);continue}let o=p.get(n.slug);o!==void 0&&e.logger.warn(`Skill "${n.slug}" from "${o}" is replaced by "${n.sourcePath}".`);let s={slug:n.slug,title:i.title,description:i.description,sourcePath:n.sourcePath};`rbac`in i&&m&&(s.rbac=i.rbac);let c={content:r};p.set(n.slug,n.sourcePath),f.set(n.slug,t(c,{stableKey:u(n.slug),type:l,metadata:s}))}return{routes:[],entities:[...f.values()]}}}});export{f as SKILLS_PLUGIN_ID,p as SKILL_MARKDOWN_ROUTE_PATH,_ as skillsContentPlugin};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{
|
|
2
|
-
`)}function x(e){return/* @__PURE__ */ Error(`Failed to load project plugins:\n${b(e)}`)}function S(e){return(e.plugins??[]).map(e=>e.trim()).filter(e=>e!==``)}function C(e,t){let n=Object.keys(t).find(t=>e===t||e.startsWith(`${t}/`));return n===void 0?void 0:t[n]}function w(e){let t=Object.keys(c).find(t=>e===t||e===`${t}/plugin.js`);return t===void 0?void 0:c[t]}async function T(e,t,n){if(h(e)){if(await n.exists(e))return e;let r=_(t,e.replace(/^[/\\]+/,``));return await n.exists(r)?r:null}if(e.startsWith(`./`)||e.startsWith(`../`)){let r=_(t,e);return await n.exists(r)?r:null}if(e.includes(`/`)){let r=_(t,e);if(await n.exists(r))return r}return E(e,t)}function E(e,t){try{return d(import.meta.url).resolve(e,{paths:[t,m(f(import.meta.url))]})}catch{return null}}async function D(
|
|
1
|
+
import{hashContentBytes as e}from"../../../shared/utils/content-hash.js";import{createNodePlatformFs as t}from"../../../platform/node/fs.js";import{isObject as n}from"../../../shared/utils/is-object.js";import{loadRedoclyConfig as r}from"../../config.js";import{isPlanFeatureGranted as i}from"../../../shared/plan-gates.js";import{BUILT_IN_CLASSIC_PLUGINS as a,DEFAULT_PROJECT_PLUGIN_FILES as o,INTERNAL_PLUGIN_ID_PREFIX as s,PLAN_GATED_PLUGINS as c}from"./constants.js";import{setLoadedProjectPlugins as l}from"./loaded-set.js";import{createInternalContentPlugins as u}from"../internal/index.js";import{createRequire as d}from"node:module";import{fileURLToPath as f,pathToFileURL as p}from"node:url";import{dirname as m,isAbsolute as h,join as g,resolve as _}from"node:path";async function v(e,n={}){let s=_(e),c=n.fs??t(),{config:l}=await r(s,c),d=[],f=S(l),p=[];for(let e of f){let t=C(e,a);if(t!==void 0){n.logger?.warn(`Project plugin "${e}" is skipped: ${t} are built in. Remove it from \`plugins\` in redocly.yaml.`);continue}let r=w(e),i=r===void 0?await T(e,s,c):E(e,s);if(i===null){d.push({entry:e,message:`Cannot resolve the plugin module from the project root, its node_modules or the Realm Plus installation.`});continue}p.some(e=>e.path===i)||p.push({entry:e,path:i,feature:r??`customPlugins`})}for(let e of o){let t=g(s,e);if(await c.exists(t)){p.some(e=>e.path===t)||p.push({entry:e,path:t,feature:`customPlugins`});break}}let m=[],h=[],v=new Set(u().map(e=>e.id));for(let{entry:e,path:t,feature:r}of p){let a=await D({entry:e,path:t,contentDir:s,config:l,fs:c});if(`lintPlugin`in a){h.push({entry:e,path:t,plugin:a.lintPlugin});continue}if(`message`in a){d.push(a);continue}if(!i(l,r)){n.logger?.warn(`Project plugin "${e}" is skipped: \`${r}\` is not in this project's plan.`);continue}if(v.has(a.plugin.id)){d.push({entry:e,path:t,message:`Plugin id "${a.plugin.id}" is already registered by another plugin.`});continue}v.add(a.plugin.id),m.push(a)}for(let e of d)n.logger?.error(`Project plugin "${e.entry}": ${e.message}`);return{plugins:m,lintPlugins:h,paths:p.map(e=>e.path),entries:f,diagnostics:d}}async function y(e,t={}){let n=await v(e,t);return l(e,n),n}function b(e){return e.map(e=>`- ${e.entry}${e.path?` (${e.path})`:``}: ${e.message}`).join(`
|
|
2
|
+
`)}function x(e){return/* @__PURE__ */ Error(`Failed to load project plugins:\n${b(e)}`)}function S(e){return(e.plugins??[]).map(e=>e.trim()).filter(e=>e!==``)}function C(e,t){let n=Object.keys(t).find(t=>e===t||e.startsWith(`${t}/`));return n===void 0?void 0:t[n]}function w(e){let t=Object.keys(c).find(t=>e===t||e===`${t}/plugin.js`);return t===void 0?void 0:c[t]}async function T(e,t,n){if(h(e)){if(await n.exists(e))return e;let r=_(t,e.replace(/^[/\\]+/,``));return await n.exists(r)?r:null}if(e.startsWith(`./`)||e.startsWith(`../`)){let r=_(t,e);return await n.exists(r)?r:null}if(e.includes(`/`)){let r=_(t,e);if(await n.exists(r))return r}return E(e,t)}function E(e,t){try{return d(import.meta.url).resolve(e,{paths:[t,m(f(import.meta.url))]})}catch{return null}}async function D(t){let{entry:n,path:r}=t,i=await e(await t.fs.readBinaryFile(r)),a=p(r);a.searchParams.set(`v`,i),delete d(r).cache[r];let o;try{o=await import(a.href)}catch(e){return{entry:n,path:r,message:`Cannot import the plugin module: ${M(e)}`}}let s=O(o);if(s===void 0)return{entry:n,path:r,message:`The module has no default export.`};let c=s,l=i;if(typeof s==`function`){l+=`+${await e(new TextEncoder().encode(JSON.stringify(t.config)))}`;try{c=await s({engine:`realm-plus`,contentDir:t.contentDir,config:t.config})}catch(e){return{entry:n,path:r,message:`The plugin factory threw: ${M(e)}`}}}if(A(c))return{lintPlugin:c};let u=j(c);if(u!==null)return{entry:n,path:r,message:u};let f=c;return{entry:n,path:r,plugin:{...f,version:`${f.version}+${l}`}}}function O(e){if(!n(e))return;let t=e.default;return n(t)&&!(`id`in t)&&`default`in t?t.default:t}const k=[`rules`,`preprocessors`,`decorators`,`configs`,`assertions`];function A(e){return n(e)&&typeof e.processContent!=`function`&&typeof e.afterRoutesCreated!=`function`&&e.version===void 0&&k.some(t=>t in e)}function j(e){return n(e)?typeof e.processContent==`function`||typeof e.afterRoutesCreated==`function`?`This is a legacy Realm lifecycle plugin (processContent/afterRoutesCreated). Realm Plus loads content plugins; see docs/guides/authoring-plugins.md.`:typeof e.id!=`string`||e.id.trim()===``?"The plugin needs a non-empty string `id`.":e.id.startsWith(`internal.`)?`The plugin id prefix "${s}" is reserved for built-in plugins.`:typeof e.version!=`string`||e.version.trim()===``?"The plugin needs a non-empty string `version`.":null:`The default export must be a plugin object or a factory that returns one.`}function M(e){return e instanceof Error?e.message:String(e)}export{x as createProjectPluginLoadError,b as formatProjectPluginDiagnostics,y as loadAndRegisterProjectPlugins,v as loadProjectPlugins,S as readPluginEntries,T as resolveProjectPluginPath};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
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};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{hashJsonValue as e,toStableJsonString as t}from"../../database/utils/json.js";import{
|
|
1
|
+
import{hashJsonValue as e,toStableJsonString as t}from"../../database/utils/json.js";import{compileRouteAccessMatcher as n}from"../../../server/rbac/engine.js";import{compareStrings as r}from"../../../shared/utils/compare-strings.js";import{computePathPrefixes as i}from"../../../shared/utils/routes/compute-path-prefixes.js";import{normalizeRoutePath as a}from"../../../shared/utils/routes/normalize-route-path.js";import{resolveRouteScope as o}from"../../../server/rbac/route-scope.js";import{hashEntityListMembership as s,hashEntityRead as c}from"../../database/entity-store.js";import{getRouteByFilePath as l,getRouteBySlug as u,getRoutesInDirectory as d}from"./state-lookup.js";function f(e,t){let f=n(t),m=e=>f===null?null:o(f,{hasRbacKey:`rbac`in e.metadata,rbacValue:e.metadata.rbac,slug:e.slug,sourcePath:e.originFilePath},()=>{})??{},h=e=>{let t=[];for(let n of e)t.push(v(n));return t.sort((e,t)=>r(e.slug,t.slug))};function*g(t){for(let n of e.routeBySlug.values())!n.isFallback&&(t===void 0||t(n))&&(yield n)}let y=e=>e!==void 0&&!e.isFallback?e:void 0,b=t=>{let n=a(t),r=y(u(e,n));if(r)return r;let o=i(n),s;for(let e of g(e=>e.wildcardPrefix&&o.includes(e.slug)))(s===void 0||e.slug.length>s.slug.length)&&(s=e);return s};function x(t,n){switch(t){case`byFilePath`:{let t=l(e,n);return _(t?v(t):void 0)}case`bySlug`:{let t=y(u(e,n));return _(t?v(t):void 0)}case`inDirectory`:return _(h(d(e,n)));case`all`:return _(h(g()));case`get`:{let t=y(u(e,n));return _(t?{...v(t),metadata:t.metadata,access:m(t)}:void 0)}case`getAccess`:{let e=b(n);return _(e?m(e):void 0)}case`list`:{let{sidebarKey:e}=JSON.parse(n);return _(h(g(t=>t.sidebarSubtreeEntityKey===e)))}case`metadata`:{let e={};for(let t of[...g()].sort((e,t)=>r(e.slug,t.slug)))Object.hasOwn(t.metadata,n)&&(e[t.slug]=t.metadata[n]);return _(e)}case`entity`:return{value:void 0,hash:c(e,n)};case`entity-type`:return{value:void 0,hash:s(e,n)};default:return{value:void 0,hash:``}}}return p(x)}function p(e){return{hash:(t,n)=>e(t,n).hash,index(n){let r=(t,r)=>{let i=e(t,r);return n?.({kind:t,argument:r,resultHash:i.hash}),i.value};return{byFilePath:e=>r(`byFilePath`,e),bySlug:e=>r(`bySlug`,e),inDirectory:e=>r(`inDirectory`,e),all:()=>r(`all`,``),get:e=>r(`get`,e),getAccess:e=>r(`getAccess`,e),list:e=>r(`list`,t({sidebarKey:e.sidebarKey})),metadata:e=>r(`metadata`,e)}},memoized(){let t=/* @__PURE__ */ new Map;return p((n,r)=>{if(n===`entity`||n===`entity-type`)return e(n,r);let i=`${n}\u0000${r}`,a=t.get(i);return a===void 0&&(a=e(n,r),t.set(i,a)),a})}}}function m(e,t,n){return f(e,t).index(n)}function h(e){let t=/* @__PURE__ */ new Map;for(let n of e)t.set(`${n.kind}\u0000${n.argument}`,n);return[...t.values()].sort((e,t)=>r(e.kind,t.kind)||r(e.argument,t.argument))}function g(e,t){return e.hash(t.kind,t.argument)!==t.resultHash}function _(t){return{value:t,hash:e(t===void 0?`absent`:t)}}function v(e){return{slug:e.slug,routeId:e.routeId,originPluginId:e.originPluginId,originFilePath:e.originFilePath,versionGroup:e.versionGroup,version:e.version,sidebarSubtreeEntityKey:e.sidebarSubtreeEntityKey,template:e.template,locale:e.locale,canonicalSlug:e.canonicalSlug}}export{m as createRouteIndex,f as createRouteQueryEvaluator,h as dedupeRouteQueryDependencies,g as isRouteQueryStale};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{slugifySegment as e}from"../../shared/utils/routes/slugify-segment.js";import{delocalizeRouteSlug as t,toLocaleSlug as n}from"../../shared/utils/l10n.js";import{
|
|
1
|
+
import{slugifySegment as e}from"../../shared/utils/routes/slugify-segment.js";import{delocalizeRouteSlug as t,toLocaleSlug as n}from"../../shared/utils/l10n.js";import{entities as r,routeDeps as i,routes as a}from"../database/schema.js";import{extractRawQueryParam as o}from"../../shared/utils/routes/extract-raw-query-param.js";import{toPhysicalVersionedSlug as s,toPublicVersionedSlug as c,versionRoutePrefix as l}from"../../shared/constants/versions.js";import{SIDEBAR_ROUTE_DEP_KEY as u,isCoreRouteDepKey as d}from"../../shared/constants/route-deps.js";import{isTabbedSidebar as f}from"../plugins/internal/sidebar/index.js";import{getVersionCatalog as p,resolveVersionGroupInfo as m}from"./resolve.js";import{and as h,eq as g,inArray as _,ne as v}from"drizzle-orm";function y(e){return o(e,`version`)}async function b(e,t,n,r={}){let i=l(t.versionGroup,t.version);if(!t.slug.startsWith(i))return null;let{defaultVersion:o}=await(r.catalog??await p(e)).groupInfo(t.versionGroup),s=o===n,u=`${l(t.versionGroup,n)}${t.slug.slice(i.length)}`,[d]=await e.select({slug:a.slug}).from(a).where(g(a.slug,u)).limit(1);return d?c(d.slug,t.versionGroup,n,s):null}async function x(e,t,n){let[r]=await e.select({versionGroup:a.versionGroup,version:a.version,locale:a.locale}).from(a).where(g(a.slug,t)).limit(1);if(!r?.versionGroup||!r.version||!n(t))return null;let o={slug:t,versionGroup:r.versionGroup,version:r.version},s=await m(e,o.versionGroup),u=l(o.versionGroup,o.version),f=/* @__PURE__ */ new Map([[o.version,o.slug]]);if(o.slug.startsWith(u)){let t=o.slug.slice(u.length);for(let[r,i]of await S(e,o,t,s,n))f.set(r,i)}let p=[...f].filter(([e])=>e!==o.version).map(([,e])=>e),v=p.length>0?await e.select({key:i.key,target:i.target}).from(i).where(h(_(i.routeSlug,p),g(i.dependencyType,`entity`))):[],y=s.defaultVersion!==null&&f.has(s.defaultVersion)?s.defaultVersion:null;return{group:{versions:s.versions.filter(e=>f.has(e)),defaultVersion:y,labels:new Map([...s.labels].filter(([e])=>f.has(e)))},pages:new Map([...f].map(([e,t])=>[e,c(t,o.versionGroup,e,e===s.defaultVersion)])),entityKeys:v.filter(e=>!d(e.key)).map(e=>e.target),links:new Map([...f].map(([e,t])=>[e,e===y?E(t,o.versionGroup,e,r.locale):t]))}}async function S(e,t,n,r,i){let o=r.versions.filter(e=>e!==t.version).map(e=>({version:e,slug:`${l(t.versionGroup,e)}${n}`}));if(o.length===0)return/* @__PURE__ */ new Map;let s=await e.select({slug:a.slug}).from(a).where(_(a.slug,o.map(e=>e.slug))),c=new Set(s.map(e=>e.slug).filter(e=>i(e))),u=o.filter(e=>!c.has(e.slug)).map(e=>e.version),d=u.length>0?await O(e,t.versionGroup,u,i):/* @__PURE__ */ new Map,f=/* @__PURE__ */ new Map;for(let e of o){let t=c.has(e.slug)?e.slug:d.get(e.version);t!==void 0&&i(t)&&f.set(e.version,t)}return f}async function C(e,n,r){let i=await p(e);if(i.pairs.length===0)return null;let a=await T(e,i,n,``,r);if(a)return a;let o=await w(e,n.split(`/`).find(Boolean)),s=o===void 0?void 0:t(n,o);return o===void 0||s===void 0?null:T(e,i,s,o,r)}async function w(t,n){if(n!==void 0)return(await t.selectDistinct({locale:a.locale}).from(a).where(v(a.locale,``))).find(t=>e(t.locale)===n)?.locale}async function T(e,t,r,i,a){if(t.prefixes.some(({prefix:e})=>r===e||r.startsWith(`${e}/`)))return null;let o=new Set(t.pairs.map(e=>e.versionGroup)),s=r.replace(/^\/+/,``).split(`/`).filter(Boolean);for(let r=s.length;r>=0;--r){let c=r===0?`/`:`/${s.slice(0,r).join(`/`)}`;if(!o.has(c))continue;let u=await t.groupInfo(c);if(!u.defaultVersion)continue;let d=s.slice(r).join(`/`),f=l(c,u.defaultVersion),p=d===``?f:`${f}/${d}`,m=await a(n(p,i));if(m)return{kind:`serve`,loaded:m,versionGroup:c,version:u.defaultVersion,locale:i};if(d===``){let t=await D(e,c,u.defaultVersion),r=t===null?null:n(t,i);if(t&&t!==p&&r&&await a(r))return{kind:`redirect`,to:E(r,c,u.defaultVersion,i)}}}return null}function E(e,r,i,a){let o=a===``?e:t(e,a)??e;return n(c(o,r,i,!0),a)}async function D(e,t,n){return(await O(e,t,[n])).get(n)??null}async function O(e,t,n,o=()=>!0){let s=/* @__PURE__ */ new Map;if(n.length===0)return s;let[c,[l]]=await Promise.all([e.select({slug:a.slug,version:a.version}).from(a).where(h(g(a.versionGroup,t),_(a.version,[...n]),g(a.locale,``))),e.select({target:i.target}).from(i).innerJoin(a,g(i.routeSlug,a.slug)).where(h(g(a.versionGroup,t),_(a.version,[...n]),g(a.locale,``),g(i.key,u),g(i.dependencyType,`entity`))).limit(1)]);if(c.length===0)return s;let d=/* @__PURE__ */ new Map;for(let e of c){if(e.version===null||!o(e.slug))continue;let t=d.get(e.version);t||(t=/* @__PURE__ */ new Set,d.set(e.version,t)),t.add(e.slug)}if(l){let[n]=await e.select({data:r.data}).from(r).where(h(g(r.key,l.target),g(r.isCurrent,1))).limit(1),i=n?.data,a=f(i)?i.tabs:i;Array.isArray(a)&&k(a,t,new Set(d.keys()),d,s)}for(let[e,t]of d){if(s.has(e))continue;let n=[...t].sort((e,t)=>e.length-t.length)[0];n&&s.set(e,n)}return s}function k(e,t,n,r,i){for(let a of e){if(n.size===0)return;if(typeof a!=`object`||!a)continue;let e=a;if(typeof e.version==`string`&&n.has(e.version)&&e.versionGroup===t&&typeof e.link==`string`){let a=e.isDefaultVersion===!0?s(e.link,t,e.version):e.link;a!==null&&r.get(e.version)?.has(a)&&(i.set(e.version,a),n.delete(e.version))}Array.isArray(e.menu)&&k(e.menu,t,n,r,i),Array.isArray(e.items)&&k(e.items,t,n,r,i)}}async function A(e,t){if(!t.versionGroup||!t.version||(await m(e,t.versionGroup)).defaultVersion!==t.version)return null;let n=E(t.slug,t.versionGroup,t.version,t.locale);return n===t.slug?null:n}export{y as extractRawVersionParam,D as firstVersionSlug,O as firstVersionSlugs,C as resolveDefaultVersionAlias,b as resolveVersionCounterpart,x as resolveVersionCounterparts,A as resolveVersionlessRedirect,E as toVersionlessSlug};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{entities as e,routes as t}from"../database/schema.js";import{toPhysicalVersionedSlug as n,toPublicVersionedSlug as r,versionRoutePrefix as i,versionsConfigEntityKey as a}from"../../shared/constants/versions.js";import{computeVersionGroupInfo as o}from"./group-info.js";import{and as s,eq as c,isNotNull as l}from"drizzle-orm";function u(e){return d(e)}async function d(e){let n=(await e.selectDistinct({versionGroup:t.versionGroup,version:t.version}).from(t).where(l(t.versionGroup))).filter(e=>e.versionGroup!==null&&e.version!==null),r=n.map(e=>({...e,prefix:i(e.versionGroup,e.version)})).sort((e,t)=>t.prefix.length-e.prefix.length),a=/* @__PURE__ */ new Map;return{pairs:n,prefixes:r,groupInfo:t=>{let r=a.get(t);return r||(r=p(e,t,n.filter(e=>e.versionGroup===t).map(e=>e.version)),a.set(t,r),r.catch(()=>a.delete(t))),r}}}async function f(e,t){return(await u(e)).groupInfo(t)}async function p(e,t,n){return o(n,await m(e,t))}async function m(t,n){let[r]=await t.select({data:e.data}).from(e).where(s(c(e.key,a(n)),c(e.isCurrent,1))).limit(1);return r?.data??null}export{u as getVersionCatalog,f as resolveVersionGroupInfo,n as toPhysicalVersionedSlug,r as toPublicVersionedSlug,i as versionRoutePrefix};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{createNodePlatformFs as e}from"../../platform/node/fs.js";import{entities as t,routeDeps as n}from"../../content-layer/database/schema.js";import{loadRedoclyConfig as r}from"../../content-layer/config.js";import{openContentLayerDatabase as i}from"../../content-layer/database/connection.js";import{invalidateAppDataCache as a}from"../content.js";import{registerLocalContentAssetRoute as o}from"../content-assets/serve-local.js";import{
|
|
1
|
+
import{createNodePlatformFs as e}from"../../platform/node/fs.js";import{entities as t,routeDeps as n}from"../../content-layer/database/schema.js";import{loadRedoclyConfig as r}from"../../content-layer/config.js";import{openContentLayerDatabase as i}from"../../content-layer/database/connection.js";import{invalidateAppDataCache as a}from"../content.js";import{registerLocalContentAssetRoute as o}from"../content-assets/serve-local.js";import{runContentEntityBuild as s}from"../../bundler/build/run.js";import{runContentIngest as c}from"../../content-layer/ingest/run.js";import{dirname as l,join as u}from"node:path";import{mkdir as d,mkdtemp as f,rm as p,writeFile as m}from"node:fs/promises";import{eq as h}from"drizzle-orm";import{tmpdir as g}from"node:os";async function _(e,t){let n=await v(e);try{await t(n)}finally{await n.dispose()}}async function v(t){let n=await f(u(g(),`realm-plus-rbac-`)),o=()=>p(n,{force:!0,recursive:!0});try{for(let[e,r]of Object.entries(t)){let t=u(n,e);await d(l(t),{recursive:!0}),typeof r==`string`?await m(t,r,`utf8`):await m(t,r)}await c({contentDir:n}),await s({contentDir:n});let{config:f}=await r(n,e()),p=await i({contentDir:n,runMigrations:!1});return{config:f,contentDir:n,database:p,dispose:async()=>{try{a(p),await p.close()}finally{await o()}}}}catch(e){throw await o(),e}}function y(e){return t=>o(t,{contentAssetsDir:u(e,`.realm`,`runtime`,`content-assets`)})}function b(e){return{headers:{},ip:`203.0.113.5`,method:`GET`,teams:e,url:`http://runtime.test/x`,userAgent:null}}async function x(e,n){let[r]=await e.db.select({data:t.data}).from(t).where(h(t.key,n)).limit(1);return r?.data??null}async function S(e,t){let[r]=await e.db.select({target:n.target}).from(n).where(h(n.routeSlug,t)).limit(1);if(!r)throw Error(`no route dep found for ${t}`);return r.target}async function C(e,t,n){let r=await S(e,t),i=await x(e,r),a=JSON.stringify(i),o=RegExp(`/content-assets/${n}-[a-f0-9]+(?:\\.a-[a-z0-9]+)?\\.[a-z]+`),s=a.match(o);if(!s)throw Error(`Could not find content-assets URL for "${n}" in page entity "${r}"`);return s[0]}export{v as createFixture,S as documentEntityKeyForRoute,C as extractContentAssetUrlFromPage,x as getEntityJsonData,y as registerContentAssetsRoute,b as requestWithTeams,_ as setupFixture};
|
package/dist/server/app.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import{getPathPrefix as e,stripPathPrefix as t,withPathPrefix as n}from"../shared/path-prefix.js";import{sanitizeRedirectPath as r}from"../shared/utils/redirect-path.js";import{isExternalRedirectTarget as i,withRequestSearch as a}from"../shared/utils/redirect-location.js";import{markdownCopyUrl as o}from"../shared/utils/routes/markdown-copy-url.js";import{realmPlusVersion as s}from"../shared/realm-plus-version.js";import{CORS_PROXY_META_NAME as c,CORS_PROXY_ROUTE_PATH as l}from"../shared/constants/cors-proxy.js";import{createLogger as u}from"../shared/logger.js";import{resolveRbacDenialStatus as d}from"./rbac/engine.js";import{BUILD_ASSETS_URL_PREFIX as f}from"../shared/constants/runtime-layout.js";import{RUNTIME_ENTITY_DATA_PATH_PREFIX as p,RUNTIME_PAGE_PATH_PREFIX as m,RUNTIME_SERVER_FN_PATH_PREFIX as h,SystemRoute as g}from"./constants/system-routes.js";import{normalizeRoutePath as _}from"../shared/utils/routes/normalize-route-path.js";import{extractRawRevisionParam as v}from"../content-layer/revisions/read.js";import{getContentType as y}from"../shared/mime.js";import{resolveViewerTeams as b}from"./rbac/teams.js";import{isAiAgentRequest as ee}from"./ai-agent-request.js";import{escapeHtml as x}from"../shared/utils/escape-html.js";import{createAuthMiddleware as te,getRequestViewer as S}from"./auth/middleware.js";import{readColorModeSettings as C,renderColorModeScript as ne}from"./color-mode.js";import{defaultRedirectStatus as w}from"./redirects.js";import{canonicalPageUrl as re}from"./site-url.js";import{SITEMAP_ROUTE_PATH as ie}from"./sitemap.js";import{isMarkdownCopyHidden as T}from"../content-layer/markdown-copy-rule.js";import{hasPageAtPath as E,hasRouteAtSlug as ae,loadLlmsFullData as oe,loadLlmsIndexData as se,loadPageMarkdownText as D,loadRbacRuntime as ce,loadRuntimePublicAssetFilenames as le,loadSitemapXml as O,parseRuntimeEntityDataPath as k,parseRuntimePagePath as A,parseServerFnPath as j,readBlobCounted as M,resolveBlobDataAccess as N,resolveEntityVisibility as P}from"./content.js";import{createRequestLogMiddleware as F,currentRequestId as I}from"./request-log.js";import{attachmentDisposition as L}from"../shared/utils/attachment-disposition.js";import{createOriginSecretMiddleware as R}from"./origin-secret.js";import{createPublicUrlMiddleware as z}from"./public-url.js";import{renderExperimentsScript as B}from"./experiments.js";import{applyResponseHeaders as V,compileResponseHeaderRules as H,isEditorReferer as U}from"./response-headers.js";import{registerAuthRoutes as W}from"./auth/routes.js";import{registerAiEndpointCors as ue,registerAskAiRoute as de,registerSemanticSearchRoute as fe}from"./ask-ai/route.js";import{registerFeedbackRoute as pe}from"./feedback/route.js";import{registerTelemetryRoute as me}from"./telemetry/route.js";import{registerReplayOAuth2Route as he}from"./replay-oauth2/route.js";import{registerReviewRoutes as ge}from"./review/route.js";import{registerPluginRoutes as _e}from"./plugin-routes.js";import{LLMS_FULL_TXT_DEVELOPMENT_NOTE as ve,renderLlmsFullTxt as ye,renderLlmsTxt as be}from"./llms-txt.js";import{registerSearchRoute as xe}from"./search/route.js";import{registerStaticFileRoute as Se}from"./static-files/serve.js";import{resolve as G,sep as Ce}from"node:path";import{getSlugFromMarkdownCopyPath as we}from"@redocly/theme/core/utils";import{readFile as Te}from"node:fs/promises";import{Hono as Ee}from"hono";function K(e){return t(new URL(e.req.url).pathname)}function De(i){let a=e(),c=new Ee,l=a?c.basePath(a):c,d=i.logger??u({level:`warn`}),v=d.child(`runtime:server`),b=i.getConfig;i.originSecret&&c.use(`*`,R(i.originSecret,v)),c.use(`*`,z()),c.get(g.Health,e=>e.text(`ok`)),l.use(`*`,F(d.child(`http`),{path:e=>K(e)??new URL(e.req.url).pathname,requestId:$})),c.onError((e,t)=>{if(`getResponse`in e&&typeof e.getResponse==`function`){let n=e.getResponse();return t.newResponse(n.body,n)}v.error(`Request failed`,{err:e,method:t.req.method,pathname:K(t)??new URL(t.req.url).pathname});let n=I();return t.text(`Internal Server Error${n?`\nRequest ID: ${n}`:``}`,500)}),i.responseHeaders!==!1&&l.use(`*`,async(e,t)=>{await t();let n=K(e)??new URL(e.req.url).pathname;if(n===g.CorsProxy||n.startsWith(`${g.CorsProxy}/`))return;let r=H(b().responseHeaders);r.length>0&&V(r,n,e.res.headers),U(e.req.header(`referer`))&&e.header(`Cross-Origin-Resource-Policy`,`cross-origin`)});let x=i.requestObserver;if(x&&l.use(`*`,async(e,t)=>{let n=performance.now();x.begin({awsRequestId:$(e),method:e.req.method,path:K(e)??new URL(e.req.url).pathname});let r=500;try{await t(),r=e.res.status}finally{let t=e.get(`realmApiFunctionResponder`);x.end({durationMs:performance.now()-n,status:r,...t?{apiFunctionResponder:t}:{}})}}),ue(l),i.auth){let e=i.database;l.use(`*`,te(i.auth,{...e?{loadPublicAssetFilenames:()=>le({database:e,logger:v}),loadRbacRuntime:()=>ce({config:b(),database:e,logger:v})}:{},...i.manualAuthPaths?{manualAuthPaths:i.manualAuthPaths}:{}})),W(l,i.auth)}if(l.get(`${m}/*`,async e=>{if(X(e),!i.loadPageMetadata)return e.json({error:`Runtime page metadata endpoint is not configured.`},404);let t=K(e),a=t===null?null:A(t);if(!a)return e.json({error:`Invalid runtime page path "${t}".`},400);let o=await i.loadPageMetadata({config:b(),request:Z(e),slug:a});o.cacheControl!==void 0&&e.header(`Cache-Control`,o.cacheControl);let s=o.status===302&&o.redirectTo?r(o.redirectTo):null;if(s)return e.redirect(n(`${m}${s===`/`?`/index`:s}/data.json${new URL(e.req.url).search}`),302);let c=o.status===401&&o.redirectTo?r(o.redirectTo):null;return c?e.json({error:`Unauthorized`,redirectTo:c},401):o.redirect?e.json({error:`Redirect`,redirectTo:q(o.redirect,``)},404):(o.status!==void 0&&e.status(o.status),e.json(o.payload))}),l.get(`${p}/*`,async e=>{if(X(e),!i.loadEntityData)return e.json({error:`Runtime entity data endpoint is not configured.`},404);let t=K(e),n=t===null?null:k(t);if(!n)return e.json({error:`Invalid entity data path "${t}".`},400);let r=await i.loadEntityData({config:b(),key:n.key,locale:e.req.query(`locale`)||void 0,request:Z(e)});return r.status!==void 0&&e.status(r.status),r.cacheControl!==void 0&&e.header(`Cache-Control`,r.cacheControl),e.json(r.payload)}),l.get(`${h}/*`,async e=>{if(X(e),!i.loadServerFnData)return e.json({error:`Runtime server function endpoint is not configured.`},404);let n=new URL(e.req.url),r=t(n.pathname),a=r===null?null:j(r);if(!a)return e.json({error:`Invalid server function path "${r}".`},400);let o=null,s=n.searchParams.get(`args`);if(s!==null)try{o=JSON.parse(s)}catch{return e.json({error:`Invalid server function args for "${a.id}".`},400)}let c=await i.loadServerFnData({args:o,config:b(),id:a.id,request:Z(e)});return c.status!==void 0&&e.status(c.status),e.header(`Cache-Control`,`no-store`),e.json(c.payload)}),i.assetDir&&l.get(`${f}/*`,async e=>{let n=t(e.req.path);if(n===null)return e.notFound();let r=n.slice(f.length+1),a=G(i.assetDir??`.`),o=G(a,r);if(!o.startsWith(a+Ce)&&o!==a)return e.notFound();try{let t=await Te(o);return e.header(`Content-Type`,y(o)),e.body(t)}catch(t){let n=t.code;if(n===`ENOENT`||n===`EISDIR`)return e.notFound();throw t}}),i.database){let e=i.database;l.get(`/blob-data/:keyAndFormat{.+}`,async t=>{let n=t.req.param(`keyAndFormat`),r=n.lastIndexOf(`.`);if(r<0)return t.notFound();let i=n.slice(0,r),a=n.slice(r+1),o=Z(t);if(await N({config:b(),database:e,key:i,request:o})===!1)return Pe(t,o.teams);let s=await M(e,i);return s?(t.header(`Cache-Control`,`public, max-age=31536000, immutable`),a===`json`?(t.header(`Content-Type`,`application/json; charset=utf-8`),t.body(s.content)):a===`text`?(t.header(`Content-Type`,`text/plain; charset=utf-8`),t.body(s.content)):(t.header(`Content-Type`,`application/octet-stream`),t.body(Buffer.from(s.content,`base64`)))):t.notFound()})}if(i.search){if(!i.database)throw Error(`createApp: search requires a database.`);xe(l,{...i.search,getConfig:b,buildRequest:Z,database:i.database,logger:v})}if(l.get(g.Info,e=>e.json({version:s(),engine:`realm-plus`})),de(l,{getConfig:b,buildRequest:Z,logger:v}),i.database){let e=i.database;pe(l,{buildRequest:Z,hasRoute:t=>E(e,t),isSlugVisible:async(t,n)=>(await P({config:b(),database:e,logger:v,request:t}))?.isSlugVisible(n)??!0,logger:v}),fe(l,{getConfig:b,buildRequest:Z,hasRoute:t=>E(e,t),resolveVisibility:t=>P({config:b(),database:e,logger:v,request:t}),logger:v})}if(me(l,{buildRequest:Z,logger:v}),he(l),i.corsProxy&&(l.all(g.CorsProxy,i.corsProxy),l.all(`${g.CorsProxy}/*`,i.corsProxy)),i.auth?.review&&ge(l,{config:i.auth.review}),i.pluginRoutes){if(!i.database)throw Error(`createApp: pluginRoutes requires a database.`);_e(l,{...i.pluginRoutes,getConfig:b,buildRequest:Z,database:i.database,logger:v})}if(i.registerRoutes?.(l),i.staticFiles){if(!i.database)throw Error(`createApp: staticFiles requires a database.`);Se(l,{...i.staticFiles,getConfig:b,buildRequest:Z,database:i.database,logger:v})}l.get(g.Favicon,e=>(e.header(`Cache-Control`,`public, max-age=86400, immutable`),e.body(null,204)));let S=i.database,C=i.loadPageMetadata;if(S){let e={contentDir:i.contentDir,context:i.context,database:S,logger:v};l.get(g.LlmsTxt,async t=>{let n=b(),r=T(n)?null:be({seo:n.seo,pages:await se({...e,config:n}),origin:new URL(t.req.url).origin,logger:v});return t.header(`Cache-Control`,`no-store`),t.header(`Access-Control-Allow-Origin`,`*`),t.header(`Content-Type`,`text/plain; charset=utf-8`),r===null?t.body(Y(404),404):(t.req.query(`download`)!==void 0&&t.header(`Content-Disposition`,`attachment; filename="llms.txt"`),t.body(r))}),l.get(ie,async t=>{let n=await O({...e,config:b()});return t.header(`Cache-Control`,`no-store`),n===null?t.body(null,404):(t.header(`Content-Type`,`application/xml; charset=utf-8`),t.body(n))}),l.get(g.LlmsFullTxt,async t=>{t.header(`Cache-Control`,`no-store`),t.header(`Content-Type`,`text/markdown; charset=utf-8`);let n=b();if(T(n))return t.body(Y(404),404);if(i.development)return t.body(ve);let r=await oe({...e,config:n}),a=ye({...r,seo:n.seo});return a===null?t.body(Y(404),404):t.body(a)})}if(S&&C){let e=(e,t,n,r)=>{if(e.header(`Cache-Control`,`no-store`),e.header(`Access-Control-Allow-Origin`,`*`),e.header(`Content-Type`,`text/markdown; charset=utf-8`),r){e.header(`X-Robots-Tag`,`noindex, follow`);let n=re(b().seo?.siteUrl,t);n&&e.header(`Link`,`<${n}>; rel="canonical"`)}if(e.req.query(`download`)!==void 0){let n=o(t);e.header(`Content-Disposition`,L(n.slice(n.lastIndexOf(`/`)+1)))}return e.body(n)};l.get(`*`,async(t,n)=>{let i=K(t);if(i===null||!i.endsWith(`.md`))return n();let a=we(i);if(a===null||await ae(S,_(i)))return n();let s=await C({config:b(),request:Z(t),slug:a});if(t.header(`Cache-Control`,`no-store`),s.status===302&&s.redirectTo)return t.redirect(`${o(r(s.redirectTo))}${new URL(t.req.url).search}`,302);if(s.status===401&&s.redirectTo){let e=new URL(r(s.redirectTo),t.req.url);return e.searchParams.set(`redirectTo`,i),t.redirect(`${e.pathname}${e.search}`,302)}if(s.status!==200){let e=s.status??404;return t.body(Y(e),e)}let c=await D(S,_(a));return c===null?t.body(Y(404),404):e(t,_(a),c,!0)}),l.get(`*`,async(t,n)=>{if(!ee(e=>t.req.header(e)))return n();let r=K(t);if(r===null)return n();let i=_(r);if((await C({config:b(),request:Z(t),slug:i})).status!==200)return n();let a=await D(S,i);return a===null?n():e(t,i,a,!1)})}return l.get(`*`,async e=>{X(e);let t=new URL(e.req.url),a=K(e)??t.pathname,o=await i.renderPage(Z(e),b());if(o.redirect)return e.redirect(q(o.redirect,new URL(e.req.url).search),o.redirect.status);o.cacheControl!==void 0&&e.header(`Cache-Control`,o.cacheControl);let s=o.status===302&&o.redirectTo?r(o.redirectTo):null;if(s)return e.redirect(n(`${s}${new URL(e.req.url).search}`),302);let c=o.status===401&&o.redirectTo?r(o.redirectTo):null;if(c)return e.redirect(c,302);let{prelude:l,postlude:u}=Oe({bodyTags:o.bodyTags,clientBootstrap:i.clientBootstrap,colorMode:o.colorMode,corsProxy:i.corsProxy!==void 0,favicon:o.favicon,headTags:o.headTags,htmlClass:o.htmlClass,lang:o.lang,page:o.page,title:o.title??`Runtime`});o.status!==void 0&&e.status(o.status);let d=o.appHtml;if(typeof d==`string`){let t=`${l}${d}${u}`;return i.transformHtml&&(t=await i.transformHtml(a,t)),e.html(t)}let f=d,p=new TextEncoder,m=null,h=new ReadableStream({async start(e){e.enqueue(p.encode(l)),m=f.getReader();try{for(;;){let{done:t,value:n}=await m.read();if(t)break;e.enqueue(n)}e.enqueue(p.encode(u)),e.close()}catch(t){e.error(t)}finally{try{m.releaseLock()}catch{}m=null}},cancel(e){m?m.cancel(e):f.cancel(e)}});return e.header(`Content-Type`,`text/html; charset=utf-8`),e.body(h)}),a&&c.get(`/`,e=>e.redirect(a,w())),c}function Oe(t){let n=e();return{prelude:[`<!doctype html>`,`<html lang="${x(t.lang??`en`)}"${t.htmlClass?` class="${x(t.htmlClass)}"`:``}>`,` <head>`,` <meta charset="utf-8" />`,` <meta name="viewport" content="width=device-width, initial-scale=1" />`,` <title>${x(t.title)}</title>`,ke(t.favicon),ne(t.colorMode??C()),t.corsProxy?Ae():``,` <style>body { margin: 0 }</style>`,t.headTags??``,B(),` </head>`,` <body>`,` <div id="app">`].join(`
|
|
2
|
-
`),postlude:[`</div>`,J(
|
|
3
|
-
`)}}function q(e,t){let
|
|
1
|
+
import{createLogger as e}from"../shared/logger.js";import{resolveRbacDenialStatus as t}from"./rbac/engine.js";import{CORS_PROXY_META_NAME as n,CORS_PROXY_ROUTE_PATH as r}from"../shared/constants/cors-proxy.js";import{BUILD_ASSETS_URL_PREFIX as i}from"../shared/constants/runtime-layout.js";import{RUNTIME_ENTITY_DATA_PATH_PREFIX as a,RUNTIME_PAGE_PATH_PREFIX as o,RUNTIME_SERVER_FN_PATH_PREFIX as s,SystemRoute as c}from"./constants/system-routes.js";import{normalizeRoutePath as l}from"../shared/utils/routes/normalize-route-path.js";import{extractRawRevisionParam as u}from"../content-layer/revisions/read.js";import{getContentType as d}from"../shared/mime.js";import{getPathPrefix as f,stripPathPrefix as p,withPathPrefix as m}from"../shared/path-prefix.js";import{resolveViewerTeams as h}from"./rbac/teams.js";import{sanitizeRedirectPath as g}from"../shared/utils/redirect-path.js";import{isExternalRedirectTarget as _,withRequestSearch as v}from"../shared/utils/redirect-location.js";import{markdownCopyUrl as y}from"../shared/utils/routes/markdown-copy-url.js";import{realmPlusVersion as ee}from"../shared/realm-plus-version.js";import{isAiAgentRequest as te}from"./ai-agent-request.js";import{escapeHtml as b}from"../shared/utils/escape-html.js";import{createAuthMiddleware as ne,getRequestViewer as x}from"./auth/middleware.js";import{readColorModeSettings as S,renderColorModeScript as C}from"./color-mode.js";import{defaultRedirectStatus as re}from"./redirects.js";import{canonicalPageUrl as ie}from"./site-url.js";import{SITEMAP_ROUTE_PATH as ae}from"./sitemap.js";import{isMarkdownCopyHidden as w}from"../content-layer/markdown-copy-rule.js";import{hasPageAtPath as T,hasRouteAtSlug as oe,loadLlmsFullData as se,loadLlmsIndexData as ce,loadPageMarkdownText as E,loadRbacRuntime as le,loadRuntimePublicAssetFilenames as D,loadSitemapXml as O,parseRuntimeEntityDataPath as k,parseRuntimePagePath as A,parseServerFnPath as j,readBlobCounted as M,resolveBlobDataAccess as N,resolveEntityVisibility as P}from"./content.js";import{createRequestLogMiddleware as F,currentRequestId as I}from"./request-log.js";import{attachmentDisposition as L}from"../shared/utils/attachment-disposition.js";import{createOriginSecretMiddleware as R}from"./origin-secret.js";import{createPublicUrlMiddleware as z}from"./public-url.js";import{renderExperimentsScript as B}from"./experiments.js";import{applyResponseHeaders as V,compileResponseHeaderRules as H,isEditorReferer as U}from"./response-headers.js";import{registerAuthRoutes as W}from"./auth/routes.js";import{registerAiEndpointCors as ue,registerAskAiRoute as de,registerSemanticSearchRoute as fe}from"./ask-ai/route.js";import{registerFeedbackRoute as pe}from"./feedback/route.js";import{registerTelemetryRoute as me}from"./telemetry/route.js";import{registerReplayOAuth2Route as he}from"./replay-oauth2/route.js";import{registerReviewRoutes as ge}from"./review/route.js";import{registerPluginRoutes as _e}from"./plugin-routes.js";import{LLMS_FULL_TXT_DEVELOPMENT_NOTE as ve,renderLlmsFullTxt as ye,renderLlmsTxt as be}from"./llms-txt.js";import{registerSearchRoute as xe}from"./search/route.js";import{registerStaticFileRoute as Se}from"./static-files/serve.js";import{resolve as G,sep as Ce}from"node:path";import{readFile as we}from"node:fs/promises";import{getSlugFromMarkdownCopyPath as Te}from"@redocly/theme/core/utils";import{Hono as Ee}from"hono";function K(e){return p(new URL(e.req.url).pathname)}function De(t){let n=f(),r=new Ee,u=n?r.basePath(n):r,h=t.logger??e({level:`warn`}),_=h.child(`runtime:server`),v=t.getConfig;t.originSecret&&r.use(`*`,R(t.originSecret,_)),r.use(`*`,z()),r.get(c.Health,e=>e.text(`ok`)),u.use(`*`,F(h.child(`http`),{path:e=>K(e)??new URL(e.req.url).pathname,requestId:$})),r.onError((e,t)=>{if(`getResponse`in e&&typeof e.getResponse==`function`){let n=e.getResponse();return t.newResponse(n.body,n)}_.error(`Request failed`,{err:e,method:t.req.method,pathname:K(t)??new URL(t.req.url).pathname});let n=I();return t.text(`Internal Server Error${n?`\nRequest ID: ${n}`:``}`,500)}),t.responseHeaders!==!1&&u.use(`*`,async(e,t)=>{await t();let n=K(e)??new URL(e.req.url).pathname;if(n===c.CorsProxy||n.startsWith(`${c.CorsProxy}/`))return;let r=H(v().responseHeaders);r.length>0&&V(r,n,e.res.headers),U(e.req.header(`referer`))&&e.header(`Cross-Origin-Resource-Policy`,`cross-origin`)});let b=t.requestObserver;if(b&&u.use(`*`,async(e,t)=>{let n=performance.now();b.begin({awsRequestId:$(e),method:e.req.method,path:K(e)??new URL(e.req.url).pathname});let r=500;try{await t(),r=e.res.status}finally{let t=e.get(`realmApiFunctionResponder`);b.end({durationMs:performance.now()-n,status:r,...t?{apiFunctionResponder:t}:{}})}}),ue(u),t.auth){let e=t.database;u.use(`*`,ne(t.auth,{...e?{loadPublicAssetFilenames:()=>D({database:e,logger:_}),loadRbacRuntime:()=>le({config:v(),database:e,logger:_})}:{},...t.manualAuthPaths?{manualAuthPaths:t.manualAuthPaths}:{}})),W(u,t.auth)}if(u.get(`${o}/*`,async e=>{if(X(e),!t.loadPageMetadata)return e.json({error:`Runtime page metadata endpoint is not configured.`},404);let n=K(e),r=n===null?null:A(n);if(!r)return e.json({error:`Invalid runtime page path "${n}".`},400);let i=await t.loadPageMetadata({config:v(),request:Z(e),slug:r});i.cacheControl!==void 0&&e.header(`Cache-Control`,i.cacheControl);let a=i.status===302&&i.redirectTo?g(i.redirectTo):null;if(a)return e.redirect(m(`${o}${a===`/`?`/index`:a}/data.json${new URL(e.req.url).search}`),302);let s=i.status===401&&i.redirectTo?g(i.redirectTo):null;return s?e.json({error:`Unauthorized`,redirectTo:s},401):i.redirect?e.json({error:`Redirect`,redirectTo:q(i.redirect,``)},404):(i.status!==void 0&&e.status(i.status),e.json(i.payload))}),u.get(`${a}/*`,async e=>{if(X(e),!t.loadEntityData)return e.json({error:`Runtime entity data endpoint is not configured.`},404);let n=K(e),r=n===null?null:k(n);if(!r)return e.json({error:`Invalid entity data path "${n}".`},400);let i=await t.loadEntityData({config:v(),key:r.key,locale:e.req.query(`locale`)||void 0,request:Z(e)});return i.status!==void 0&&e.status(i.status),i.cacheControl!==void 0&&e.header(`Cache-Control`,i.cacheControl),e.json(i.payload)}),u.get(`${s}/*`,async e=>{if(X(e),!t.loadServerFnData)return e.json({error:`Runtime server function endpoint is not configured.`},404);let n=new URL(e.req.url),r=p(n.pathname),i=r===null?null:j(r);if(!i)return e.json({error:`Invalid server function path "${r}".`},400);let a=null,o=n.searchParams.get(`args`);if(o!==null)try{a=JSON.parse(o)}catch{return e.json({error:`Invalid server function args for "${i.id}".`},400)}let s=await t.loadServerFnData({args:a,config:v(),id:i.id,request:Z(e)});return s.status!==void 0&&e.status(s.status),e.header(`Cache-Control`,`no-store`),e.json(s.payload)}),t.assetDir&&u.get(`${i}/*`,async e=>{let n=p(e.req.path);if(n===null)return e.notFound();let r=n.slice(i.length+1),a=G(t.assetDir??`.`),o=G(a,r);if(!o.startsWith(a+Ce)&&o!==a)return e.notFound();try{let t=await we(o);return e.header(`Content-Type`,d(o)),e.body(t)}catch(t){let n=t.code;if(n===`ENOENT`||n===`EISDIR`)return e.notFound();throw t}}),t.database){let e=t.database;u.get(`/blob-data/:keyAndFormat{.+}`,async t=>{let n=t.req.param(`keyAndFormat`),r=n.lastIndexOf(`.`);if(r<0)return t.notFound();let i=n.slice(0,r),a=n.slice(r+1),o=Z(t);if(await N({config:v(),database:e,key:i,request:o})===!1)return Pe(t,o.teams);let s=await M(e,i);return s?(t.header(`Cache-Control`,`public, max-age=31536000, immutable`),a===`json`?(t.header(`Content-Type`,`application/json; charset=utf-8`),t.body(s.content)):a===`text`?(t.header(`Content-Type`,`text/plain; charset=utf-8`),t.body(s.content)):(t.header(`Content-Type`,`application/octet-stream`),t.body(Buffer.from(s.content,`base64`)))):t.notFound()})}if(t.search){if(!t.database)throw Error(`createApp: search requires a database.`);xe(u,{...t.search,getConfig:v,buildRequest:Z,database:t.database,logger:_})}if(u.get(c.Info,e=>e.json({version:ee(),engine:`realm-plus`})),de(u,{getConfig:v,buildRequest:Z,logger:_}),t.database){let e=t.database;pe(u,{buildRequest:Z,hasRoute:t=>T(e,t),isSlugVisible:async(t,n)=>(await P({config:v(),database:e,logger:_,request:t}))?.isSlugVisible(n)??!0,logger:_}),fe(u,{getConfig:v,buildRequest:Z,hasRoute:t=>T(e,t),resolveVisibility:t=>P({config:v(),database:e,logger:_,request:t}),logger:_})}if(me(u,{buildRequest:Z,logger:_}),he(u),t.corsProxy&&(u.all(c.CorsProxy,t.corsProxy),u.all(`${c.CorsProxy}/*`,t.corsProxy)),t.auth?.review&&ge(u,{config:t.auth.review}),t.pluginRoutes){if(!t.database)throw Error(`createApp: pluginRoutes requires a database.`);_e(u,{...t.pluginRoutes,getConfig:v,buildRequest:Z,database:t.database,logger:_})}if(t.registerRoutes?.(u),t.staticFiles){if(!t.database)throw Error(`createApp: staticFiles requires a database.`);Se(u,{...t.staticFiles,getConfig:v,buildRequest:Z,database:t.database,logger:_})}u.get(c.Favicon,e=>(e.header(`Cache-Control`,`public, max-age=86400, immutable`),e.body(null,204)));let x=t.database,S=t.loadPageMetadata;if(x){let e={contentDir:t.contentDir,context:t.context,database:x,logger:_};u.get(c.LlmsTxt,async t=>{let n=v(),r=w(n)?null:be({seo:n.seo,pages:await ce({...e,config:n}),origin:new URL(t.req.url).origin,logger:_});return t.header(`Cache-Control`,`no-store`),t.header(`Access-Control-Allow-Origin`,`*`),t.header(`Content-Type`,`text/plain; charset=utf-8`),r===null?t.body(Y(404),404):(t.req.query(`download`)!==void 0&&t.header(`Content-Disposition`,`attachment; filename="llms.txt"`),t.body(r))}),u.get(ae,async t=>{let n=await O({...e,config:v()});return t.header(`Cache-Control`,`no-store`),n===null?t.body(null,404):(t.header(`Content-Type`,`application/xml; charset=utf-8`),t.body(n))}),u.get(c.LlmsFullTxt,async n=>{n.header(`Cache-Control`,`no-store`),n.header(`Content-Type`,`text/markdown; charset=utf-8`);let r=v();if(w(r))return n.body(Y(404),404);if(t.development)return n.body(ve);let i=await se({...e,config:r}),a=ye({...i,seo:r.seo});return a===null?n.body(Y(404),404):n.body(a)})}if(x&&S){let e=(e,t,n,r)=>{if(e.header(`Cache-Control`,`no-store`),e.header(`Access-Control-Allow-Origin`,`*`),e.header(`Content-Type`,`text/markdown; charset=utf-8`),r){e.header(`X-Robots-Tag`,`noindex, follow`);let n=ie(v().seo?.siteUrl,t);n&&e.header(`Link`,`<${n}>; rel="canonical"`)}if(e.req.query(`download`)!==void 0){let n=y(t);e.header(`Content-Disposition`,L(n.slice(n.lastIndexOf(`/`)+1)))}return e.body(n)};u.get(`*`,async(t,n)=>{let r=K(t);if(r===null||!r.endsWith(`.md`))return n();let i=Te(r);if(i===null||await oe(x,l(r)))return n();let a=await S({config:v(),request:Z(t),slug:i});if(t.header(`Cache-Control`,`no-store`),a.status===302&&a.redirectTo)return t.redirect(`${y(g(a.redirectTo))}${new URL(t.req.url).search}`,302);if(a.status===401&&a.redirectTo){let e=new URL(g(a.redirectTo),t.req.url);return e.searchParams.set(`redirectTo`,r),t.redirect(`${e.pathname}${e.search}`,302)}if(a.status!==200){let e=a.status??404;return t.body(Y(e),e)}let o=await E(x,l(i));return o===null?t.body(Y(404),404):e(t,l(i),o,!0)}),u.get(`*`,async(t,n)=>{if(!te(e=>t.req.header(e)))return n();let r=K(t);if(r===null)return n();let i=l(r);if((await S({config:v(),request:Z(t),slug:i})).status!==200)return n();let a=await E(x,i);return a===null?n():e(t,i,a,!1)})}return u.get(`*`,async e=>{X(e);let n=new URL(e.req.url),r=K(e)??n.pathname,i=await t.renderPage(Z(e),v());if(i.redirect)return e.redirect(q(i.redirect,new URL(e.req.url).search),i.redirect.status);i.cacheControl!==void 0&&e.header(`Cache-Control`,i.cacheControl);let a=i.status===302&&i.redirectTo?g(i.redirectTo):null;if(a)return e.redirect(m(`${a}${new URL(e.req.url).search}`),302);let o=i.status===401&&i.redirectTo?g(i.redirectTo):null;if(o)return e.redirect(o,302);let{prelude:s,postlude:c}=Oe({bodyTags:i.bodyTags,clientBootstrap:t.clientBootstrap,colorMode:i.colorMode,corsProxy:t.corsProxy!==void 0,favicon:i.favicon,headTags:i.headTags,htmlClass:i.htmlClass,lang:i.lang,page:i.page,title:i.title??`Runtime`});i.status!==void 0&&e.status(i.status);let l=i.appHtml;if(typeof l==`string`){let n=`${s}${l}${c}`;return t.transformHtml&&(n=await t.transformHtml(r,n)),e.html(n)}let u=l,d=new TextEncoder,f=null,p=new ReadableStream({async start(e){e.enqueue(d.encode(s)),f=u.getReader();try{for(;;){let{done:t,value:n}=await f.read();if(t)break;e.enqueue(n)}e.enqueue(d.encode(c)),e.close()}catch(t){e.error(t)}finally{try{f.releaseLock()}catch{}f=null}},cancel(e){f?f.cancel(e):u.cancel(e)}});return e.header(`Content-Type`,`text/html; charset=utf-8`),e.body(p)}),n&&r.get(`/`,e=>e.redirect(n,re())),r}function Oe(e){let t=f();return{prelude:[`<!doctype html>`,`<html lang="${b(e.lang??`en`)}"${e.htmlClass?` class="${b(e.htmlClass)}"`:``}>`,` <head>`,` <meta charset="utf-8" />`,` <meta name="viewport" content="width=device-width, initial-scale=1" />`,` <title>${b(e.title)}</title>`,ke(e.favicon),C(e.colorMode??S()),e.corsProxy?Ae():``,` <style>body { margin: 0 }</style>`,e.headTags??``,B(),` </head>`,` <body>`,` <div id="app">`].join(`
|
|
2
|
+
`),postlude:[`</div>`,J(e.page),je(t),e.bodyTags??``,` ${Me(e.clientBootstrap)}`,` </body>`,`</html>`].filter(e=>e!==``).join(`
|
|
3
|
+
`)}}function q(e,t){let n=_(e.location)?e.location:m(e.location);return v(n,t)}function ke(e){let t=m(e??c.Favicon),n=d(t);return` <link rel="icon"${n===`application/octet-stream`?``:` type="${n}"`} href="${b(t)}">`}function Ae(){let e=b(m(`${r}/`));return` <meta name="${n}" content="${e}" />`}function je(e){return e===``?``:` <script>globalThis.__REALM_PATH_PREFIX__ = ${JSON.stringify(e).replaceAll(`<`,`\\u003C`)};<\/script>`}function Me(e){switch(e.type){case`inline-module-import`:return`<script type="module">import ${JSON.stringify(e.specifier)};<\/script>`;case`script-src`:return`<script type="module" src="${m(e.src)}"><\/script>`}}function J(e){return` <script type="application/json" id="__REALM_PAGE__">${JSON.stringify(e??null).replaceAll(`<`,`\\u003C`)}<\/script>`}const Ne={400:`Bad Request`,401:`Unauthorized`,403:`Forbidden`,404:`Not Found`,500:`Internal Server Error`,501:`Not Implemented`};function Y(e){return`# ${e} ${Ne[e]??`Error`}\n`}function Pe(e,n){let r=t(n);return e.header(`Cache-Control`,`no-store`),e.json({error:r===401?`Sign in to access this resource.`:`You do not have access to this resource.`},r)}function X(e){Fe(e)&&e.header(`X-Robots-Tag`,`noindex`)}function Fe(e){return u(e.req.url)!==null}function Z(e){let t={};e.req.raw.headers.forEach((e,n)=>{t[n]=e});let n=e.req.url;if(f()){let t=new URL(e.req.url),r=p(t.pathname);r!==null&&(t.pathname=r,n=t.toString())}let r=x(e);return{headers:Object.freeze(t),ip:Ie(e,t),method:e.req.method,teams:h(r),url:n,userAgent:t[`user-agent`]??t[`x-realm-user-agent`]??null,...r?{viewer:r}:{}}}const Q=`lambda-web-request-id`;function $(e){let t=e.req.header(Q);if(t!==void 0)return t;let n=e.env?.context?.awsRequestId;return typeof n==`string`?n:null}function Ie(e,t){let n=Le(e),r=(t[`x-forwarded-for`]??``).split(`,`).map(e=>e.trim()).filter(e=>e!==``);for(globalThis.process?.env?.AWS_LAMBDA_HTTP_ENDPOINT!==void 0&&t[Q]!==void 0&&r.pop();n!==null&&r.at(-1)===n;)r.pop();let i=t[`x-real-ip`];return r.at(-1)??(i||n)}function Le(e){let t=e.env,n=t?.requestContext?.http?.sourceIp;if(typeof n==`string`&&n!==``)return n;let r=t?.incoming?.socket?.remoteAddress??null;return typeof r==`string`&&r!==``?r:null}export{De as createApp};
|