@redocly/redoc 0.138.0-next.12 → 0.138.0-next.14

package/dist/server/plugins/mcp/utils/telemetry-attributes.js

@@ -1 +0,0 @@
-function r(e){return{id:e,object:"mcpServer",uri:`urn:redocly:realm:mcp:server:${e}`}}function i(e){return{client:e?.client,clientVersion:e?.clientVersion,requestId:e?.requestId,messageId:e?.messageId}}export{i as callAttribution,r as serverAttributes};

package/dist/server/plugins/mcp/utils/tool-registration.d.ts

@@ -1,18 +0,0 @@
-import type { McpToolSchema } from '../../../types';
-import type { ToolArgs } from '../types.js';
-export declare function normalizeToolDisplayName(tool: McpToolSchema): McpToolSchema;
-/** The `registerTool` config for a tool schema, with its input and output schemas compiled for validation. */
-export declare function toRegisterToolConfig(tool: McpToolSchema): {
-    title: string | undefined;
-    description: string;
-    inputSchema: import("@modelcontextprotocol/server").StandardSchemaWithJSON<ToolArgs, ToolArgs>;
-    outputSchema?: import("@modelcontextprotocol/server").StandardSchemaWithJSON<unknown, unknown> | undefined;
-    annotations: {
-        title?: string | undefined;
-        readOnlyHint?: boolean | undefined;
-        destructiveHint?: boolean | undefined;
-        idempotentHint?: boolean | undefined;
-        openWorldHint?: boolean | undefined;
-    } | undefined;
-};
-//# sourceMappingURL=tool-registration.d.ts.map

package/dist/server/plugins/mcp/utils/tool-registration.js

@@ -1 +0,0 @@
-import{fromJsonSchema as i}from"@modelcontextprotocol/server";import{mcpJsonSchemaValidator as e}from"./json-schema-validator.js";function c(t){const n=t.title??t.annotations?.title;return n?{...t,title:n,annotations:{...t.annotations,title:n}}:t}function u(t){const{title:n,description:a,schema:r,outputSchema:o,annotations:m}=c(t);return{title:n,description:a,inputSchema:i(r,e),...o?{outputSchema:i(o,e)}:{},annotations:m}}export{c as normalizeToolDisplayName,u as toRegisterToolConfig};

package/dist/server/plugins/mcp/utils/xmcp-utils.d.ts

@@ -1,11 +0,0 @@
-import type { OpenAPIDefinition } from '@redocly/api-docs';
-import type { XMcpConfig, XMcpSection } from '../types.js';
-/** Whether the path or operation is hidden for `section`. */
-export declare function isEndpointHidden(endpoint: {
-    'x-mcp'?: XMcpConfig;
-} | undefined, section: XMcpSection): boolean;
-/** Whether the definition's info-level x-mcp hides it for `section` (defaults to `docs`). */
-export declare function isDefinitionHidden(info?: OpenAPIDefinition['info'], section?: XMcpSection): boolean;
-/** Whether the API explicitly opts into the gateway via `x-mcp.gateway`. */
-export declare function hasGatewayConfig(info: OpenAPIDefinition['info'] | undefined): boolean;
-//# sourceMappingURL=xmcp-utils.d.ts.map

package/dist/server/plugins/mcp/utils/xmcp-utils.js

@@ -1 +0,0 @@
-function r(t,e){return!!t?.["x-mcp"]?.[e]?.hide}function o(t,e){if(!t)return!1;const n=t["x-mcp"];return!n||typeof n!="object"?!1:e?n[e]?.hide===!0:n.docs?.hide===!0}function i(t){if(!t)return!1;const e=t["x-mcp"];return!!(e&&typeof e=="object"&&e.gateway)}export{i as hasGatewayConfig,o as isDefinitionHidden,r as isEndpointHidden};

package/dist/server/plugins/mcp/utils.d.ts

@@ -1,94 +0,0 @@
-import type { DocumentNode } from 'graphql';
-import type { ApiFunctionsUser, RbacConfig, RedirectConfig } from '@redocly/config';
-import type { ApiDescriptionInfo, GraphqlDescriptionInfo } from './types.js';
-import type { OpenAPIDefinition } from '@redocly/api-docs';
-import type { BundledApiDefinition } from '../api-docs/loader.js';
-/** OpenAPI specs only; MCP lists paths/servers from OpenAPI documents. */
-export type McpOpenApiSpec = {
-    relativePath: string;
-    definition: OpenAPIDefinition;
-};
-export type McpGraphqlSpec = {
-    relativePath: string;
-    definition: DocumentNode;
-    options: BundledApiDefinition['options'];
-};
-export declare function bundledOpenApiDocumentsToMcpOpenApi(bundled: BundledApiDefinition[]): McpOpenApiSpec[];
-export declare function bundledGraphqlDocumentsToMcpOpenApi(bundled: BundledApiDefinition[]): McpGraphqlSpec[];
-/**
- * Filters out localizations and definitions with no public paths.
- *
- * This function removes definitions that are localization files (starting with 'l10n' or 'i18n')
- * and definitions that don't have any public API paths. It also cleans up the remaining
- * definitions by removing internal parsing artifacts.
- *
- * @param apiDescriptions - Array of OpenAPI definitions to filter.
- * @returns Filtered array of definitions with only those containing public paths.
- *
- * @example
- * getCleanedUpDefinitions([
- *   { relativePath: 'l10n/en.yaml', definition: { paths: {} } },
- *   { relativePath: 'api.yaml', definition: { paths: { '/users': {} } } }
- * ]); // Returns only the api.yaml definition
- */
-export declare function getCleanedUpApiDescriptions(apiDescriptions: McpOpenApiSpec[]): McpOpenApiSpec[];
-/**
- * Filters OpenAPI definitions based on user RBAC permissions.
- *
- * This function checks each definition against the user's role-based access control
- * permissions and filters out definitions the user doesn't have access to. It also
- * applies deep filtering to the definition content based on the user's permissions.
- *
- * @param apiDescriptions - Array of OpenAPI definitions to filter.
- * @param user - The user object containing role and permission information.
- * @param rbac - RBAC configuration defining access rules.
- * @param requiresLogin - Whether login is required for access.
- * @returns Array of definitions the user has access to with filtered content.
- *
- * @example
- * filterDefinitionsByRbac(definitions, user, rbac, true);
- * // Returns only definitions the user can access with filtered content
- */
-export declare function filterApiDescriptionsByRbac(apiDescriptions: Record<string, ApiDescriptionInfo>, user: ApiFunctionsUser, rbac: RbacConfig, requiresLogin: boolean): Record<string, ApiDescriptionInfo>;
-export declare function filterGraphqlDescriptionsByRbac(graphqlDescriptions: GraphqlDescriptionInfo[], user: ApiFunctionsUser, rbac: RbacConfig, requiresLogin: boolean): GraphqlDescriptionInfo[];
-export declare function buildGraphqlDescriptions(definitions: McpGraphqlSpec[]): GraphqlDescriptionInfo[];
-export declare function filterIgnoredApiDescriptions<T extends {
-    relativePath: string;
-}>(apiDescriptions: T[], ignoredPaths: string[]): T[];
-/**
- * Registered page routes whose source file `mcp.docs.ignore` matches, as exact route slugs
- * for the `search` tool to drop. The catalog tools filter definitions by path; `search` reads
- * the site-wide semantic index, which only knows page URLs — so the affected routes are looked
- * up in the route table at static-data time rather than derived from file paths (a derived
- * slug bypasses the content-slugs transforms and cannot see operation pages).
- */
-export declare function collectIgnoredRoutes(routes: {
-    fsPath?: string;
-    slug: string;
-}[], ignoredPaths: string[]): string[];
-/**
- * Checks if the MCP route (/mcp) appears in redirect configuration.
- *
- * This function checks if the reserved MCP route is used as either a source
- * or target in any redirect configuration. Returns true if found.
- *
- * @param config - The Redocly configuration containing redirects.
- * @returns true if /mcp is found in redirects, false otherwise.
- *
- * @example
- * isMcpInRedirects({ redirects: { '/mcp': '/docs' } }); // true
- * isMcpInRedirects({ redirects: { '/docs': '/mcp' } }); // true
- * isMcpInRedirects({ redirects: { '/docs': '/api' } }); // false
- */
-export declare function isMcpInRedirects(redirects?: {
-    [key: string]: RedirectConfig;
-}): boolean;
-/** Whether an API definition is part of the Docs MCP catalog (not a localized copy, has public paths, not ignored via mcp.docs.ignore). */
-export declare function isApiIncludedInDocsMcp(relativePath: string, definition: {
-    paths?: Record<string, unknown>;
-} | undefined, mcpConfig: {
-    docs?: {
-        ignore?: readonly string[];
-    };
-} | undefined): boolean;
-//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/mcp/utils.js

@@ -1 +0,0 @@
-import u,{join as l}from"node:path";import s from"picomatch";import{PUBLIC_API_DEFINITIONS_FOLDER as m,L10N_DIR_NAME as p,I18N_DIR_NAME as c}from"../../constants/common.js";import{RESERVED_ROUTES as h}from"../../plugins/get-reserved-routes.js";import{removeL10nPrefix as D}from"../../fs/utils/remove-l10n-prefix.js";import{removeTrailingSlash as g}from"../../../utils/url/remove-trailing-slash.js";import{slash as A}from"../../../utils/path/slash.js";import{canDownloadApiDefinition as d}from"../../utils/rbac.js";function T(e){return e.filter(t=>t.type==="openapi").map(t=>({relativePath:t.relativePath,definition:t.document}))}function W(e){return e.filter(t=>t.type==="graphql").map(t=>({relativePath:t.relativePath,definition:t.document,options:t.options}))}function f(e){if(typeof e!="object"||e===null)return e;if(Array.isArray(e))return e.map(f);const t={};for(const i in e)if(Object.hasOwn(e,i)){if(i.toString().startsWith("x-parsed-"))continue;t[i]=f(e[i])}return t}function b(e){return e.reduce((t,i)=>(i.relativePath.startsWith(p)||i.relativePath.startsWith(c)||!i.definition||typeof i.definition!="object"||!("paths"in i.definition)||i.definition?.paths&&Object.keys(i.definition.paths).length>0&&t.push({...i,definition:f(i.definition)}),t),[])}function M(e,t,i,r){const n={};for(const[o,a]of Object.entries(e))d(l(m,a.relativePath),i,r,t)&&(n[o]=a);return n}function N(e,t,i,r){return e.filter(n=>d(l(m,n.relativePath),i,r,t))}function S(e){return e.filter(({relativePath:t})=>!t.startsWith(p)&&!t.startsWith(c)).map(({relativePath:t,options:i})=>({name:i.info?.title||u.basename(t,u.extname(t)),description:i.info?.description,relativePath:t}))}function v(e,t){const i=s(t||[]);return e.filter(({relativePath:r})=>!i(r))}function k(e,t){if(!t?.length)return[];const i=s(t),r=e.filter(({fsPath:n})=>{if(!n)return!1;const o=A(n);return i(o)||i(D(o))}).map(({slug:n})=>g(n));return[...new Set(r)].sort()}function q(e={}){for(const[t,i]of Object.entries(e))if(t===h.mcp||(typeof i=="string"?i:i.to)===h.mcp)return!0;return!1}function w(e,t,i){return e.startsWith(p)||e.startsWith(c)||!t?.paths||Object.keys(t.paths).length===0?!1:!s(i?.docs?.ignore||[])(e)}export{S as buildGraphqlDescriptions,W as bundledGraphqlDocumentsToMcpOpenApi,T as bundledOpenApiDocumentsToMcpOpenApi,k as collectIgnoredRoutes,M as filterApiDescriptionsByRbac,N as filterGraphqlDescriptionsByRbac,v as filterIgnoredApiDescriptions,b as getCleanedUpApiDescriptions,w as isApiIncludedInDocsMcp,q as isMcpInRedirects};

package/dist/server/plugins/mcp/workers/execute-mcp-tool.d.ts

@@ -1,9 +0,0 @@
-import type { McpToolContext, McpToolExecutionParams, McpToolHandler, McpToolHandlerExtended, McpToolModuleExport, McpToolWorkerResponse } from '../types.js';
-export declare function executeMcpTool(params: McpToolExecutionParams): Promise<McpToolWorkerResponse>;
-export declare function resolveToolHandler(moduleDefault: McpToolModuleExport, toolName: string): McpToolHandler | McpToolHandlerExtended | undefined;
-export declare function isMcpToolAvailable(params: Omit<McpToolExecutionParams, 'args' | 'extra'>): Promise<boolean>;
-export declare function mcpToolAvailability(params: {
-    toolNames: string[];
-    context: McpToolContext;
-}): Promise<Record<string, boolean>>;
-//# sourceMappingURL=execute-mcp-tool.d.ts.map

package/dist/server/plugins/mcp/workers/execute-mcp-tool.js

@@ -1 +0,0 @@
-import{telemetry as h}from"../../../telemetry/index.js";import{McpServerType as c}from"../constants.js";import{EXECUTE_TOOL_NAME as w}from"../codemode/constants.js";import{isPlainObject as p}from"../../../../utils/guards/is-plain-object.js";import{logMcpToolCallAudit as g,reportMcpToolCalled as b,reportMcpToolError as u}from"./mcp-tool-telemetry.js";import{isToolDisabledByCaller as S}from"../utils/disabled-tools.js";import{attachToolFileSystem as E}from"./tool-file-system.js";import{callAttribution as M}from"../utils/telemetry-attributes.js";import{importMcpToolHandlers as A}from"./import-mcp-tool-handlers.js";function O(e){return e.content.map(t=>t.type==="text"?t.text:"")}async function X(e){h.initialize();const{toolName:t,args:o,extra:s}=e,r=E(e.context),n=r?.mcpMode??"tools",a=M(r),d=performance.now();try{const i=await C(t);if(!i)throw new Error(`MCP tool "${t}" is not registered or its module does not export a handler for "${t}". Expected \`export default { '${t}': handler }\` or a single tool definition with \`description\` and \`execute\` as the default export.`);const v=typeof i=="function"?i:i.execute,l=L(t,await v(o,r,s),n),m=Math.round(performance.now()-d),{errorClass:y}=l;delete l.errorClass;const f=l.isError?y??(t===w?"sandbox_error":"tool_error"):void 0,_=t===w&&y==="tool_error",x=O(l),T=x.join("");return g({tool:t,mode:n,serverType:c.Docs,args:o,result:T,errorClass:f,...a}),f?_||u({tool:t,message:x.join(" "),mode:n,serverType:c.Docs,durationMs:m,errorClass:f,...a}):b({tool:t,mode:n,serverType:c.Docs,durationMs:m,outputLength:T.length,...a}),l}catch(i){throw g({tool:t,mode:n,serverType:c.Docs,args:o,errorClass:"server_error",...a}),u({tool:t,message:i instanceof Error?i.message:String(i),mode:n,serverType:c.Docs,durationMs:Math.round(performance.now()-d),stack:i instanceof Error&&i.stack||"",errorClass:"server_error",...a}),i}}function P(e){return"execute"in e&&typeof e.execute=="function"&&"description"in e&&typeof e.description=="string"}async function C(e){const t=(await A())[e];if(!t)return;const{default:o}=await t();return k(o,e)}function k(e,t){return P(e)?e:e[t]}function L(e,t,o){if(N(t))return t;if(typeof t=="string")return{content:[{type:"text",text:t}]};let s;try{s=JSON.stringify(t)}catch(n){throw new Error(`MCP tool "${e}" returned a value that cannot be serialized to JSON: `+(n instanceof Error?n.message:String(n)))}if(s===void 0)throw new Error(`MCP tool "${e}" returned an invalid result.`);const r=o==="code"?JSON.parse(s):void 0;return p(r)?{content:[{type:"text",text:s}],structuredContent:r}:{content:[{type:"text",text:s}]}}const j=new Set(["text","image","audio","resource","resource_link"]);function N(e){if(!p(e))return!1;const{content:t}=e;return Array.isArray(t)&&t.every(o=>p(o)&&j.has(o.type))}async function $(e){h.initialize();const{toolName:t}=e;if(S(t,e.context.metadata))return!1;const o=E(e.context),s=performance.now();try{const r=await C(t);return r?typeof r=="object"&&typeof r.isAvailable=="function"?await r.isAvailable(o):!0:!1}catch(r){throw u({tool:t,message:"Failed to check if MCP tool is available: "+(r instanceof Error?r.message:String(r)),mode:o?.mcpMode??"tools",serverType:c.Docs,durationMs:Math.round(performance.now()-s),stack:r instanceof Error&&r.stack||"",errorClass:"server_error",...M(o)}),r}}async function Y(e){const{toolNames:t,context:o}=e,s=await Promise.all(t.map(r=>$({toolName:r,context:o}).catch(()=>!1)));return Object.fromEntries(t.map((r,n)=>[r,s[n]]))}export{X as executeMcpTool,$ as isMcpToolAvailable,Y as mcpToolAvailability,k as resolveToolHandler};

package/dist/server/plugins/mcp/workers/import-mcp-tool-handlers.d.ts

@@ -1,5 +0,0 @@
-import type { McpToolModuleGetter } from '../types.js';
-type McpToolHandlers = Record<string, McpToolModuleGetter | undefined>;
-export declare function importMcpToolHandlers(): Promise<McpToolHandlers>;
-export {};
-//# sourceMappingURL=import-mcp-tool-handlers.d.ts.map

package/dist/server/plugins/mcp/workers/import-mcp-tool-handlers.js

@@ -1 +0,0 @@
-import{stat as e}from"node:fs/promises";import{join as i}from"node:path";import{pathToFileURL as m}from"node:url";import{envConfig as a}from"../../../config/env-config.js";import{workerBaseDir as s}from"../../../workers/worker-pool.js";let t;async function y(){if(a.isRuntimeMode)return(await import("../../../../client/mcp-tool-handlers-entry.js")).mcpToolHandlers;const o=i(s,"mcp-tool-handlers-entry.js"),{mtimeMs:r}=await e(o);if(t?.mtimeMs!==r){const n=await import(`${m(o).href}?${r}`);t={mtimeMs:r,handlers:n.mcpToolHandlers}}return t.handlers}export{y as importMcpToolHandlers};

package/dist/server/plugins/mcp/workers/mcp-tool-telemetry.d.ts

@@ -1,28 +0,0 @@
-import type { McpCallAttribution, McpErrorClass, McpMode, McpServerType } from '../types.js';
-type McpToolEvent = McpCallAttribution & {
-    tool: string;
-    mode: McpMode;
-    serverType: McpServerType;
-    durationMs: number;
-};
-export declare function reportMcpToolCalled({ tool, mode, serverType, durationMs, outputLength, client, clientVersion, requestId, messageId, }: McpToolEvent & {
-    outputLength: number;
-}): void;
-/**
- * Arguments and result identity for one MCP tool call. `tool` and `mode` repeat the
- * `mcpServer.toolCalled` telemetry event so a Grafana row joins onto this line; `args_sha256`
- * identifies the invocation. The result body itself is never recorded — a tool can return
- * credentials no pattern will recognise — so only its digest lands here.
- */
-export declare function logMcpToolCallAudit({ tool, mode, serverType, args, result, errorClass, client, clientVersion, requestId, messageId, }: Omit<McpToolEvent, 'durationMs'> & {
-    args: unknown;
-    result?: string;
-    errorClass?: McpErrorClass;
-}): void;
-export declare function reportMcpToolError({ tool, mode, serverType, durationMs, message, stack, errorClass, client, clientVersion, requestId, messageId, }: McpToolEvent & {
-    message: string;
-    stack?: string;
-    errorClass: McpErrorClass;
-}): void;
-export {};
-//# sourceMappingURL=mcp-tool-telemetry.d.ts.map

package/dist/server/plugins/mcp/workers/mcp-tool-telemetry.js

@@ -1 +0,0 @@
-import{telemetry as p}from"../../../telemetry/index.js";import{serverAttributes as _}from"../utils/telemetry-attributes.js";import{EXECUTE_TOOL_NAME as g}from"../codemode/constants.js";import{auditInput as m,auditOutputDigest as f,auditSha256 as M,logAuditRecord as h}from"../audit/audit-log.js";function b({tool:e,mode:t,serverType:s,durationMs:o,outputLength:r,client:i,clientVersion:n,requestId:a,messageId:l}){p.sendMcpToolCalledMessage([{..._(s),tool:e,mode:t,output_length:r,duration_ms:o,client:i,client_version:n,message_id:l}],{requestId:a})}function v({tool:e,mode:t,serverType:s,args:o,result:r,errorClass:i,client:n,clientVersion:a,requestId:l,messageId:d}){if(e===g)return;const u=y(o),c=r===void 0?void 0:f(r);h("Record MCP tool call",{tool:e,mode:t,server_type:s,error_class:i,client:n,client_version:a,request_id:l,message_id:d,args_sha256:M(u),args:m(u),result_sha256:c?.sha256,result_bytes:c?.bytes})}function y(e){try{return JSON.stringify(e)??String(e)}catch{return"\xAB[unserializable]\xBB"}}function O({tool:e,mode:t,serverType:s,durationMs:o,message:r,stack:i="",errorClass:n,client:a,clientVersion:l,requestId:d,messageId:u}){p.sendMcpErrorMessage([{..._(s),tool:e,message:r,stack:i,error_class:n,mode:t,duration_ms:o,client:a,client_version:l,message_id:u}],{requestId:d})}export{v as logMcpToolCallAudit,b as reportMcpToolCalled,O as reportMcpToolError};

package/dist/server/plugins/mcp/workers/tool-file-system.d.ts

@@ -1,6 +0,0 @@
-import type { McpToolFileSystem } from '@redocly/config';
-import type { McpToolContext } from '../types.js';
-export declare function attachToolFileSystem(context: McpToolContext): McpToolContext & {
-    fs: McpToolFileSystem;
-};
-//# sourceMappingURL=tool-file-system.d.ts.map

package/dist/server/plugins/mcp/workers/tool-file-system.js

@@ -1 +0,0 @@
-import{readFile as s,realpath as i}from"node:fs/promises";import{resolve as l,sep as n}from"node:path";function m(r){return{...r,fs:c(r.outdir)}}function c(r){return{async readFile(o){if(!r)throw new Error("Project files are not available in this environment.");const e=await i(r),t=l(e,o.replace(/^\/+/,"")),a=t.startsWith(e+n)?await i(t):t;if(!a.startsWith(e+n))throw new Error(`Invalid file path "${o}".`);return await s(a,"utf8")}}}export{m as attachToolFileSystem};

package/dist/server/plugins/nav-utils.d.ts

@@ -1,12 +0,0 @@
-import type { RedoclyConfig, ResolvedConfigLinks, ResolvedNavItem, RawNavConfig, NavItem } from '@redocly/config';
-import type { AfterRoutesCreatedActions, LifecycleContext, ResolveItemsOptions } from '../types';
-export type ResolveLinkContext = Pick<AfterRoutesCreatedActions, 'outdir' | 'getRouteByFsPath' | 'contentDir' | 'getAllRoutesForLocale' | 'getRouteBySlug'>;
-export declare function resolveLinksFromConfig(rawConfig: RawNavConfig, contentDir: string, actions: ResolveLinkContext, context: LifecycleContext, options: ResolveItemsOptions): Promise<ResolvedConfigLinks>;
-export declare function normalizeItems(items: NavItem[]): NavItem[];
-export declare function resolveItems(items: NavItem[] | undefined, fromDir: string, actions: ResolveLinkContext, context: LifecycleContext, options: ResolveItemsOptions): Promise<ResolvedNavItem[] | undefined>;
-export declare function resolveItem(item: NavItem, fromDir: string, actions: ResolveLinkContext, context: LifecycleContext, options: ResolveItemsOptions): Promise<ResolvedNavItem | ResolvedNavItem[]>;
-export declare function collectItemsLinkedToSidebars(navbar: RedoclyConfig['navbar'], actions: AfterRoutesCreatedActions, context: LifecycleContext, options: ResolveItemsOptions): Promise<Map<string, {
-    label?: string;
-    link?: string;
-}>>;
-//# sourceMappingURL=nav-utils.d.ts.map

package/dist/server/plugins/nav-utils.js

@@ -1 +0,0 @@
-import*as v from"path";import{REDOCLY_ROUTE_RBAC as b,REDOCLY_TEAMS_RBAC as h}from"@redocly/config";import{VERSION_SEPARATOR as M}from"../constants/common.js";import{DEFAULT_LOCALE_PLACEHOLDER as _}from"../../constants/common.js";import{removeTrailingSlash as j}from"../../utils/url/remove-trailing-slash.js";import{isPrimitive as W}from"../../utils/guards/is-primitive.js";import{slash as w}from"../../utils/path/slash.js";import{isAbsoluteUrl as z}from"../../utils/url/is-absolute-url.js";import{normalizeRouteSlug as J}from"../../utils/path/normalize-route-slug.js";import{parsePathVersions as C}from"../../utils/path/parse-path-versions.js";import{logger as A}from"../tools/notifiers/logger.js";import{reporter as S}from"../tools/notifiers/reporter.js";import{shaDirPathShort as R}from"../utils/crypto/sha-dir-path-short.js";import{copyStaticFile as U,FileNotFoundError as E}from"../utils/fs.js";import{isIconPath as H,resolveAssetPath as Y}from"../utils/index.js";import{resolveSrcSet as G}from"../utils/resolve-src-set.js";import{isL10nPath as B}from"../fs/utils/is-l10n-path.js";import{getLocaleFromRelativePath as q}from"../fs/utils/get-locale-from-relative-path.js";async function N(e,i,n,t,a){if(!e)return;const f={...a,ignoreCustomSidebar:!0};if(W(e)){if(typeof e=="string"){const r=F(n.contentDir,i,a,e,t.fs);if(t.fs.exists(r)){if(n.getRouteByFsPath(r))return K({page:e},i,n,t,f);{const g=t.fs.getFileInfo(r);return g?U(n.contentDir,g.realRelativePath,n.outdir):void 0}}}return e}return Array.isArray(e)?I(D(e),i,n,t,f):Object.fromEntries(await Promise.all(Object.entries(e).map(async([r,l])=>[r,await N(l,i,n,t,a)])))}function D(e){return e.map(i=>({...i,items:i.items?D(i.items):void 0}))}async function I(e,i,n,t,a){if(Array.isArray(e))return(await Promise.all(e.map(f=>K(f,i,n,t,a)))).flatMap(f=>f)}async function y(e,i,n,t){let a,f;if(typeof e.icon=="object"){if("srcSet"in e.icon)try{a=await G(e.icon.srcSet,n.fs,{fromFileRelativePath:t.navFile,contentDir:i.contentDir,outdir:i.outdir})}catch(d){d instanceof E?await S.panicOnBuildContentError(`Cannot resolve "item.icon.srcSet" from ${t.navFile}: ${d.message}`):await S.panicOnBuild(`Cannot resolve "item.icon.srcSet" from ${t.navFile}: ${d.message}`)}}else if(typeof e.icon=="string")if(z(e.icon)||H(e.icon))try{f=await Y(e.icon,n.fs,{fromFileRelativePath:t.navFile,contentDir:i.contentDir,outdir:i.outdir})}catch(d){d instanceof E?await S.panicOnBuildContentError(`Cannot resolve "item.icon" from ${t.navFile}: file  ${f} does not exist`):await S.panicOnBuild(`Cannot resolve "item.icon" from ${t.navFile}: ${d.message}`)}else f=e.icon;return{icon:f,srcSet:a}}function Q(e){return i=>{if(i.type==="link"||i.type==="group"){const n=i.metadata;return n?Object.entries(e).every(([t,a])=>Array.isArray(a)?a.some(f=>n[t]===f):n[t]===a):!1}return!0}}async function K(e,i,n,t,a){if(e?.tab!==void 0||e?.menu!==void 0){const s=`Navigation tabs ("tab"/"menu") are only allowed at the top level of a sidebars.yaml file: ${JSON.stringify(e)}`;return await S.panicOnBuildContentError(`Invalid nav item in %rp. ${s}`,a.navFile),{type:"error",label:s}}if(e?.directory&&e.items?.length)return{type:"error",label:`Can't have both "directory" and "items" in the nav item: ${JSON.stringify(e)}`};e?.directory&&e?.group&&(e={...e,directory:void 0,items:[{directory:e.directory}]});const f=e?.directory?F(n.contentDir,i,a,e.directory,t.fs):void 0;if(f!==void 0){const s=f===""?"":f+"/",{locale:u,ignoredRoutes:o}=a;let p=n.getAllRoutesForLocale(u).filter(c=>!o?.has(c.baseSlug||"")&&c.fsPath.startsWith(s)&&!c.excludeFromSidebar).sort((c,P)=>c.fsPath===P.fsPath?0:c.baseSlug.localeCompare(P.baseSlug,void 0,{numeric:!0}));const m=e.includeByMetadata?Q(e.includeByMetadata):Boolean;if(!p.length)return[];const T=(await Promise.all(p.map(async c=>{const P=c.versions?.find(x=>x.active),L=P&&{version:P.version,isDefault:P.default,versionFolderId:P.folderId},V=ee(v.posix.relative(f,c.fsPath)),O=c.getSidebar?.(c);return!a.ignoreCustomSidebar&&O?.length?{type:"group",fsPath:c.fsPath,metadata:c.metadata,link:c.slug,routeSlug:c.slug,label:await c.getNavText?.()||c.slug,[h]:c[h],[b]:c[b],sidebarItems:k(O,L,c[h],c[b]),...L,relativePathFromDirectory:v.relative(f,c.fsPath).replace(/@(?<!@[^/]*?@)[^/]+\//,"")}:{type:"link",fsPath:c.fsPath,metadata:c.metadata,[h]:c[h],[b]:c[b],label:await c.getNavText?.()||c.slug,link:c.slug,routeSlug:c.slug,...L,relativePathFromDirectory:V}}))).filter(m);return e.flatten?$(T,a):Z(T,a)}let d=typeof e=="string"?e:e?.page,r,l;if(d){if(d.includes("#")){const[s,u]=d.split("#");u?l=u:A.warn(`Invalid heading anchor format in sidebar: "${u}". Heading anchors should contain only alphanumeric characters, hyphens, and underscores.`),d=s}if(d=j(d),a.locale&&a.locale!==_){const s=J(v.join(a.locale.toLowerCase(),d));r=n.getRouteBySlug(s)}r||(r=n.getRouteBySlug(d)),r||(r=n.getRouteByFsPath(F(n.contentDir,i,a,d,t.fs)))}const g=r?.metadata;if(e?.$ref){let s=F(n.contentDir,i,a,e.$ref,t.fs);if(a.ref!==void 0&&(s=v.posix.join(a.ref,e.$ref)),!t.fs.exists(s))return await S.panicOnBuildContentError(`Failed to load ${s} file. Make sure sidebar $ref path is correct.`),[];const u=await t.cache.load(s,"yaml"),o=v.dirname(s);return await I(u.data,i,n,t,{...a,navFile:s,ref:o})||[]}if(!r){const s=a.excludedFromLinkCheckerPatterns?.catalog.some(o=>o.test(d||"")),u=a.excludedFromLinkCheckerPatterns?.apiFunctions.some(o=>o.test(d||e.href||""));(u||s)&&(e={...e,href:d||e.href,page:void 0,target:e.target??(u?"_blank":void 0)}),await X(e,a,t,i)}if(r&&!e.disconnect&&!a.ignoreCustomSidebar&&(l||r?.getSidebar)){const s=r.versions?.find(o=>o.active),u=s&&{version:s.version,isDefault:s.default,versionFolderId:s.folderId};if(l){let o=[];if(r.getSidebar&&(o=r.getSidebar(r,{...e,...await y(e,n,t,a)}),o&&o.length>0)){const p=o[0];p&&p.link&&(p.link=`${p.link}#${l}`)}if(!o||o.length===0){let p=e.group||e.label||l;o=[{type:"link",fsPath:r.fsPath,metadata:r.metadata,link:`${r.slug}#${l}`,routeSlug:r.slug,label:p,labelTranslationKey:e.labelTranslationKey,...await y(e,n,t,a),[h]:r[h],[b]:{slug:r.slug,fsPath:r.fsPath},...u}]}return k(o,u,r[h],r[b])}if(r?.getSidebar){const o=r.getSidebar(r,{...e,...await y(e,n,t,a)}),p=e.group&&o?.[0]?.routeSlug===r.slug?o.slice(1):o;return k(a.groupCustomSidebars||e.group?[{type:"group",fsPath:r.fsPath,link:r.slug,routeSlug:r.slug,label:e.group||e.label||await r.getNavText?.()||r.slug,items:p,labelTranslationKey:e.labelTranslationKey,metadata:g,badges:e.badges,...await y(e,n,t,a)}]:o,u,r[h],r[b])}}if(r&&!e.group){const s=l?`${r.slug}#${l}`:r.slug;let u=e.label||l||"";u||(u=await r.getNavText?.()||r.slug);const o=r.versions?.find(m=>m.active),p=o&&{version:o.version,isDefault:o.default,versionFolderId:o.folderId};return{type:"link",fsPath:r.fsPath,linkedSidebars:e.linkedSidebars,metadata:g,[h]:e?.rbac||r[h],[b]:{slug:r.slug,fsPath:r.fsPath},label:u,labelTranslationKey:e.labelTranslationKey,link:s,items:await I(e.items,i,n,t,a),separatorLine:e.separatorLine,linePosition:e.linePosition,routeSlug:e.disconnect?void 0:s,external:e.external,target:e.target,badges:e.badges,...await y(e,n,t,a),...p,additionalProps:e.additionalProps}}else if(e?.group){const s=r?.versions?.find(o=>o.active),u=C(a?.navFile);return{type:"group",fsPath:r?.fsPath,linkedSidebars:e.linkedSidebars,metadata:g,version:s?.version||u?.versionName,versionFolderId:s?.folderId||(u?.versionFolderPath?R(u.versionFolderPath):void 0),label:e.group,link:r?.slug,routeSlug:r?.slug,badges:e.badges,labelTranslationKey:e.groupTranslationKey,items:await I(e.items,i,n,t,a),expanded:e.expanded?e.expanded.toString():void 0,selectFirstItemOnExpand:e.selectFirstItemOnExpand,menuStyle:e.menuStyle,separatorLine:e.separatorLine,linePosition:e.linePosition,...await y(e,n,t,a),[h]:e?.rbac,[b]:{slug:r?.slug||"",fsPath:r?.fsPath||""},additionalProps:e.additionalProps}}else{if(e?.href||e?.label)return{type:"link",metadata:g,link:e.href||"",label:e?.label||e?.href||"",labelTranslationKey:e.labelTranslationKey,external:e.external,target:e.target,separatorLine:e.separatorLine,linePosition:e.linePosition,badges:e.badges,...await y(e,n,t,a),[h]:e?.rbac,additionalProps:e.additionalProps};if(e?.separator!=null||e?.separatorLine!=null){const s=C(a?.navFile);return{type:"separator",metadata:g,version:s?.versionName,versionFolderId:s?.versionFolderPath?R(s.versionFolderPath):void 0,label:e.separator,labelTranslationKey:e.separatorTranslationKey,separatorLine:e.separatorLine,linePosition:e.linePosition,...await y(e,n,t,a),[h]:e?.rbac,additionalProps:e.additionalProps}}else{const s=C(a?.navFile);return{type:"error",label:`Can't resolve page: ${JSON.stringify(e)}`,version:s?.versionName,versionFolderId:s?.versionFolderPath?R(s.versionFolderPath):void 0}}}}async function X(e,i,n,t){const{href:a,page:f}=e;if(a||!f)return;const d=F(n.fs.cwd,t,i,f,n.fs),r=n.fs.exists(d),l=await n.isPathIgnored(d),g=(r?"The page is ignored: ":"Can't resolve page: ")+f;(!r||l)&&S.reportBrokenLink({type:"BROKEN_LINK",brokenLinkType:"LINK",title:e.label||e.group||"",link:d,rawLink:f,message:g,sourceFileRelativePath:i.navFile,sourceFileLocation:{line:0}})}function F(e,i,n,t="",a){if(n.ref!==void 0)return w(v.relative(e,v.resolve(e,v.join(n.ref,t))));if(t.startsWith("/")){const f=B(i)?q(i):void 0,d=f?`${a.localizationFolder}/${f}/`:"",r=t.slice(1);return B(r)?r:d+w(r)}return w(v.relative(e,v.resolve(e,i,t)))}function Z(e,i){const n={};for(const r of e){const l=v.dirname(r.relativePathFromDirectory),g=r.version?M+r.version:"",s=v.basename(r.relativePathFromDirectory)+g;d(l,r,s)}const t=f(a(n));return $(t,i);function a(r){const l=[];for(const g of Object.keys(r)){const s=r[g];l.push({...s,items:s.items?a(s.items):void 0})}return l}function f(r){return r.sort((l,g)=>{const s=typeof l=="string"?l.toLowerCase():l.relativePathFromDirectory||l.label||"",u=typeof g=="string"?g.toLowerCase():g.relativePathFromDirectory||g.label||"";return s.startsWith("index.")?-1:u.startsWith("index.")?1:s.localeCompare(u,void 0,{numeric:!0})})}function d(r,l,g){r==="."&&(r="");const s=r.split("/").filter(Boolean);let u=n;for(const o of s){const p=o+(l?.version||"");u[p]||(u[p]={type:"group",version:l?.version,label:o,isDefault:l?.isDefault,versionFolderId:l.versionFolderId,items:{}}),u=u[p].items}u[g]=l}}function $(e,i){return e.flatMap(n=>n?.sidebarItems?i.groupCustomSidebars?{...n,items:n.sidebarItems,sidebarItems:void 0,relativePathFromDirectory:void 0}:n.sidebarItems:{...n,items:n.items?$(n.items,i):void 0})}function k(e,i,n,t){return e.map(a=>({...a,...i,[h]:a[h]||n,[b]:a[b]||t,items:a.type==="group"&&a.items?k(a.items,i,n):a.items}))}function ee(e){return e.replace(/@(?<!@[^/]*?@)[^/]+\//,"")}async function ye(e,i,n,t){const a=(e?.items||[]).filter(r=>r.linkedSidebars?.length).map(r=>({...r,items:void 0})),f=await N(a,i.contentDir,i,n,t),d=new Map;for(const r of f)if(r.linkedSidebars?.length)for(const l of r.linkedSidebars){if(d.has(l)){A.warn(`Only one navbar item can belong to sidebar. "${l}" on 'linkedSidebars' property on "${r.label}" will be ignored.`);continue}d.set(l,{label:r.label,link:r.link})}return d}export{ye as collectItemsLinkedToSidebars,D as normalizeItems,K as resolveItem,I as resolveItems,N as resolveLinksFromConfig};

package/dist/server/plugins/pages/helpers/parse-tsx-frontmatter.d.ts

@@ -1,2 +0,0 @@
-export declare function parseTsxFrontMatter(content: string): Promise<Record<string, unknown> | undefined>;
-//# sourceMappingURL=parse-tsx-frontmatter.d.ts.map

package/dist/server/plugins/pages/helpers/parse-tsx-frontmatter.js

@@ -1,6 +0,0 @@
-import{reporter}from"../../../tools/notifiers/reporter.js";async function parseTsxFrontMatter(content){const regex=/export\s+(?:const|let|var)\s+frontmatter\s*=\s*(\{[^;]*\});/m,match=regex.exec(content);if(!match)return{};try{const environment=eval(`
-      (function() {
-        const frontmatterTranslate = (key, defaultValue) => \`frontmatterTranslate('\${key}', '\${defaultValue.replace(/'/g, "\\'")}')\`;
-        return (${match[1]});
-      })()
-    `);return environment}catch{await reporter.panicOnBuildContentError("Invalid format of frontmatter. We support only basic object definition.")}}export{parseTsxFrontMatter};

package/dist/server/plugins/pages/index.d.ts

@@ -1,3 +0,0 @@
-import type { LifecyclePluginInstance } from '../../types';
-export declare function customPagesPlugin(): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/pages/index.js

@@ -1 +0,0 @@
-import g from"node:path";import{REDOCLY_TEAMS_RBAC as h}from"@redocly/config";import{slash as S}from"../../../utils/path/slash.js";import{canAccessFeature as y}from"../../utils/entitlements/can-access-feature.js";import{staticDataLoader as b}from"./loaders/static-data-loader.js";import{findFrontmatterSlugs as F,getSidebarSharedDataId as P,resolveFrontmatterSlugs as w}from"../utils.js";import{reactFrontmatterLoader as v}from"./loaders/react-frontmatter-loader.js";import{registerPageProps as D}from"../register-page-props.js";import{telemetryTraceStep as R}from"../../../cli/telemetry/helpers/trace-step.js";import{searchResolver as E}from"./search/search-resolver.js";async function x(){return{loaders:{"react-frontmatter":v},id:"react-pages",requiredEntitlements:["reactPages"],processContent:async(r,a)=>{await R("com.redocly.build.plugin.pages",async()=>{const{fs:o,cache:f}=a;for(const n of o.scan(/\.page\.tsx?$/)){const{relativePath:e,realRelativePath:l}=n;if(await a.isPathIgnored(e))continue;const p=r.createTemplate(S(e),g.resolve(o.cwd,l));await D(n,o,r);const{data:t}=await f.load(e,"react-frontmatter"),u=await F(e,"react-frontmatter",t,a),s=w(u,e);let c=null;t?.sidebar&&(c=await P(t.sidebar,e,a.fs)),(s.length?s.reverse():[void 0]).forEach(i=>{r.addRoute({excludeFromSearch:t?.excludeFromSearch||!1,slug:i,templateId:p,fsPath:e,sharedData:c?[{id:c,key:"sidebar"}]:void 0,[h]:y("rbac")?t?.rbac:void 0,getNavText:async()=>t?.seo?.title,getStaticData:async(m,d)=>({props:await b({frontmatter:t,relativePath:e},a,d)}),getSearchDocuments:E(t,e,r.getSearchFacets,r.setSearchFacets)})});for(const[i,{to:m,type:d}]of Object.entries(t?.redirects||{}))r.addRedirect(i,{to:m||s[0],type:d||301})}})}}}export{x as customPagesPlugin};

package/dist/server/plugins/pages/loaders/react-frontmatter-loader.d.ts

@@ -1,9 +0,0 @@
-import type { LoaderFn } from '../../../types';
-export type ReactLoadResult = Record<string, any> | undefined;
-export declare const reactFrontmatterLoader: LoaderFn;
-/**
- * Processes frontmatter to convert translate() calls into translation key objects
- * that can be resolved at runtime
- */
-export declare function processFrontmatterTranslations(frontmatter: Record<string, any>): Record<string, any>;
-//# sourceMappingURL=react-frontmatter-loader.d.ts.map

package/dist/server/plugins/pages/loaders/react-frontmatter-loader.js

@@ -1 +0,0 @@
-import{parseTsxFrontMatter as i}from"../helpers/parse-tsx-frontmatter.js";import{ensureFrontmatterThemeCompatibility as f}from"../../ensure-frontmatter-theme-compatibility.js";const d=async(n,{fs:o})=>{const e=await o.read(n),t=await i(e);if(!t)return;const r=p(t);return await f(r,n,o)};function p(n){const o=JSON.parse(JSON.stringify(n));function e(t){switch(typeof t){case"string":{const r=t.match(/^frontmatterTranslate\(['"]([^'"]+)['"],\s*['"]([^'"]*)['"]\)$/);if(r){const[,s,a]=r,c=a.replace(/\\'/g,"'");return{__translationKey:s,__defaultValue:c}}return t}case"object":{if(!t)return t;if(Array.isArray(t))return t.map(e);const r={};for(const[s,a]of Object.entries(t))r[s]=e(a);return r}default:return t}}return e(o)}export{p as processFrontmatterTranslations,d as reactFrontmatterLoader};

package/dist/server/plugins/pages/loaders/static-data-loader.d.ts

@@ -1,12 +0,0 @@
-import type { GetStaticDataContext, LifecycleContext } from '../../../types';
-type PropsLoaderPageData = {
-    frontmatter: Record<string, any> | undefined;
-    relativePath: string;
-} & Record<string, any>;
-export declare function staticDataLoader(pageData: PropsLoaderPageData, context: LifecycleContext, dataContext: GetStaticDataContext): Promise<{
-    frontmatter: any;
-    seo: any;
-    lastModified: any;
-}>;
-export {};
-//# sourceMappingURL=static-data-loader.d.ts.map

package/dist/server/plugins/pages/loaders/static-data-loader.js

@@ -1 +0,0 @@
-import{getLocaleFromPathname as _}from"@redocly/theme/core/utils";import{resolveFrontmatterKeys as m}from"../../resolve-frontmatter-keys.js";async function F(a,e,r){const{frontmatter:s,relativePath:o,lastModified:n}=a,i=await b(s||{},r,o);return{frontmatter:await m(i,r.getGlobalConfig("frontMatterKeysToResolve")||[],o,r,e),seo:await m(i?.seo||{},["image"],o,r,e),lastModified:n}}async function b(a,e,r){const s=e.getGlobalData().l10n;if(!s)return a;const{translations:o,defaultLocale:n,locales:i}=s,u=e.getRouteByFsPath(r),g=u?_(u.slug,n,i):n,K=o[g]?.translation||o[n]?.translation||{};function c(t){if(t&&typeof t=="object"){if(Array.isArray(t))return t.map(c);if(t.__translationKey){const l=t.__translationKey,f=t.__defaultValue;return K[l]||f||l}const y={};for(const[l,f]of Object.entries(t))y[l]=c(f);return y}return t}return c(a)}export{F as staticDataLoader};

package/dist/server/plugins/pages/search/search-facets.d.ts

@@ -1,10 +0,0 @@
-import type { SearchFacet } from '@redocly/theme/core/types';
-export declare function setDocumentSearchFacets(documentSearchFacets: {
-    [key: string]: string;
-}, getSearchFacets: () => Map<string, SearchFacet>, setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void): void;
-export declare function extractDocumentSearchFacets(metadata: {
-    [key: string]: unknown;
-}, getSearchFacets: () => Map<string, SearchFacet>): {
-    [key: string]: string;
-};
-//# sourceMappingURL=search-facets.d.ts.map

package/dist/server/plugins/pages/search/search-facets.js

@@ -1 +0,0 @@
-import{SEARCH_GROUP_FACET_FIELD as f}from"../../../../constants/common.js";import{SEARCH_GROUP_NAME_DOCUMENTATION as u}from"../../../constants/plugins/search.js";function S(t,o,e){const c=o();for(const[r,n]of Object.entries(t)){const s=c.get(r);if(s){const a=new Set(s.values??[]).add(n);s.values=Array.from(a)}}e(c)}function h(t,o){const e={[f]:u};if(!t)return e;const c=o();for(const[r,n]of Object.entries(t))c.has(r)&&(e[r]=String(n));return e}export{h as extractDocumentSearchFacets,S as setDocumentSearchFacets};

package/dist/server/plugins/pages/search/search-resolver.d.ts

@@ -1,5 +0,0 @@
-import type { AfterRoutesCreatedActions, PageRouteDetails, SearchDocument } from '../../../types';
-import type { SearchFacet } from '@redocly/theme/core/types';
-import type { ReactLoadResult } from '../loaders/react-frontmatter-loader.js';
-export declare function searchResolver(frontmatter: ReactLoadResult, relativePath: string, getSearchFacets: () => Map<string, SearchFacet>, setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void): (route: PageRouteDetails, staticData: Record<string, unknown>, actions: AfterRoutesCreatedActions) => Promise<SearchDocument[]>;
-//# sourceMappingURL=search-resolver.d.ts.map

package/dist/server/plugins/pages/search/search-resolver.js

@@ -1 +0,0 @@
-import{REDOCLY_ROUTE_RBAC as l,REDOCLY_TEAMS_RBAC as m}from"@redocly/config";import{SEARCH_DOCUMENT_METADATA_KEY as _}from"../../../constants/plugins/search.js";import{canAccessFeature as A}from"../../../utils/entitlements/can-access-feature.js";import{normalizeFrontmatterKeywords as E}from"../../helpers/normalize-frontmatter-keywords.js";import{extractDocumentSearchFacets as x,setDocumentSearchFacets as F}from"./search-facets.js";function O(e,r,i,h){return async(s,R,C)=>{if(!e||e?.excludeFromSearch)return[];const o=e.search?.title||e.seo?.title||e.title,a=e.search?.description||e.seo?.description||e.description;if(!o&&!a)return[];const n=s.slug||r,{result:c}=E(e?.search?.keywords),p=s.metadata||{},d=x(p,i);F(d,i,h);const D=A("rbac")?e?.rbac:void 0,u={id:n,url:n,title:o||r,text:a||"",path:[],facets:d,[m]:D||s[m],[l]:s[l]};if(c){const t={curated:!0};c.includes&&(t.includes=c.includes),c.excludes&&(t.excludes=c.excludes),u[_]=t}return[u]}}export{O as searchResolver};

package/dist/server/plugins/pages/validators/validate-react-pages.d.ts

@@ -1,4 +0,0 @@
-import type { Store } from '../../../store.js';
-import type { LifecycleContext } from '../../../types';
-export declare function validateReactPages(store: Store, lifecycleContext: LifecycleContext): Promise<void>;
-//# sourceMappingURL=validate-react-pages.d.ts.map

package/dist/server/plugins/pages/validators/validate-react-pages.js

@@ -1 +0,0 @@
-import{pathToFileURL as u}from"node:url";import{slash as d}from"../../../../utils/path/slash.js";import{logger as o}from"../../../tools/notifiers/logger.js";import{reporter as n}from"../../../tools/notifiers/reporter.js";import{getServerProps as p}from"../../../ssr/server-side-props/get-server-props.js";import{telemetry as f}from"../../../../cli/telemetry/index.js";async function x(r,i){try{n.clearPageRenderProblems();const e=r.getAllRoutes().filter(t=>t.fsPath.match(/\.page\.tsx?$/));if(!e.length)return;const l=o.startTiming();o.info("Validating react pages");const g=await P(r.serverOutDir);for(const t of e){const c=await r.resolveRouteStaticData(t,i),m=await p(t,null,c,r);let a;try{a=(await g(t,m,null,r,f,!0)).error}catch(s){a=s}a&&n.reportPageRenderError({message:a.name==="PageMissingDefaultExportError"?a.message:`Runtime error: ${a.message}`,sourceFileRelativePath:t.fsPath})}o.infoTime(l,`Validated ${e.length} React pages`)}catch(e){await n.panicOnBuild(`Failed to validate react pages: ${e.message}`)}}async function P(r){const e=await import(u(`${d(r)}/index.mjs`)+"?only-exports=true");if(!e.renderPage)throw new Error("renderPage function not found in bundle");return e.renderPage}export{x as validateReactPages};

package/dist/server/plugins/register-page-props.d.ts

@@ -1,4 +0,0 @@
-import type { ContentFs } from '../fs/content-fs.js';
-import type { FileInfo, ProcessContentActions } from '../types';
-export declare function registerPageProps(file: FileInfo, fs: ContentFs, actions: ProcessContentActions): Promise<void>;
-//# sourceMappingURL=register-page-props.d.ts.map

package/dist/server/plugins/register-page-props.js

@@ -1 +0,0 @@
-import o from"path";async function l(e,t,a){const{realRelativePath:s,relativePath:i}=e;let r;s.match(/\.md$/)&&(r=s.replace(/\.md$/,".props.ts")),s.match(/\.page\.tsx?$/)&&(r=s.replace(/\.page\.tsx?$/,".props.ts"));const p=r?await n(r,t):void 0;p&&a.registerPagePropsGetter(i,p)}async function n(e,t){return await t.exists(e)?o.resolve(t.cwd,e):void 0}export{l as registerPageProps};

package/dist/server/plugins/resolve-frontmatter-keys.d.ts

@@ -1,4 +0,0 @@
-import type { LifecycleContext } from '../types';
-import type { ResolveLinkContext } from './nav-utils.js';
-export declare function resolveFrontmatterKeys(frontmatter: Record<string, unknown>, allowList: string[], relativePath: string, dataContext: ResolveLinkContext, context: LifecycleContext): Promise<any>;
-//# sourceMappingURL=resolve-frontmatter-keys.d.ts.map

package/dist/server/plugins/resolve-frontmatter-keys.js

@@ -1 +0,0 @@
-import*as o from"path";import{resolveLinksFromConfig as a}from"./nav-utils.js";async function f(t,s,e,n,m){return Object.fromEntries(await Promise.all(Object.entries(t).map(async([r,i])=>s.includes(r)?[r,await a(i,o.dirname(o.resolve(n.contentDir,e)),n,m,{navFile:e})]:[r,i])))}export{f as resolveFrontmatterKeys};

package/dist/server/plugins/scorecard-classic/compute-scorecard.d.ts

@@ -1,10 +0,0 @@
-import type { LifecycleContext, ProcessContentActions } from '../../types';
-import type { DetailedScorecardData } from './types.js';
-import { type ScorecardConfig, type RedoclyConfig } from '@redocly/theme/config';
-export declare function computeScorecard({ actions, context, scorecardConfig, reuniteConfig, }: {
-    actions: ProcessContentActions;
-    context: LifecycleContext;
-    scorecardConfig: ScorecardConfig;
-    reuniteConfig: RedoclyConfig['reunite'];
-}): Promise<Record<string, DetailedScorecardData>>;
-//# sourceMappingURL=compute-scorecard.d.ts.map

package/dist/server/plugins/scorecard-classic/compute-scorecard.js

@@ -1,4 +0,0 @@
-import w from"node:path";import S from"picomatch";import{removeLeadingSlash as O}from"@redocly/theme/core/utils";import{parsePathVersions as D}from"../../../utils/path/parse-path-versions.js";import{logger as c}from"../../tools/notifiers/logger.js";import{ScorecardStatus as d}from"./types.js";import{getTarget as M}from"./loaders/scorecard.js";const R=15;async function $({actions:t,context:i,scorecardConfig:e,reuniteConfig:o}){c.info("Computing scorecard...");const a=e.levels||[],n=a[0],u=await t.loadApiDocuments(i),r=B(u),h=e.ignore||[],v=S(h),m=new Set,f=c.startTiming(),p={},l={};for(const s of r){if(!L(s,v,m))continue;const g=s.customOutputRelativeFile||s.realRelativePath;m.add(g);const P=await N(s,i,e,a,n);p[s.realRelativePath]=P,l[P.relativePath]=P}return c.infoTime(f,"Scorecard processed"),T(p,o,e),l}function L(t,i,e){if(t.isVirtual||!t.definition)return!1;const o=t.customOutputRelativeFile||t.realRelativePath,a=O(t.realRelativePath);return i(a)?(c.info(`Skipping scorecard calculation for ignored file: ${t.realRelativePath}`),!1):!e.has(o)}function F(t,i,e){return t-1<i?d.BelowMinimum:i<e-1?d.Minimum:d.Highest}async function N(t,i,e,o,a){let n=a.name;if(e.targets?.length){const l=await i.getConfig(w.posix.dirname(t.realRelativePath)),s=t.definition.info?.["x-metadata"]||{},g={title:t.definition.info?.title,version:t.definition.info?.version,...s,...l.metadata};n=(await M(e.targets,g))?.minimumLevel||a.name}const{data:{levels:u,scorecardLevelIdx:r,scorecardLevel:h}}=await i.cache.load(t.realRelativePath,"scorecard"),v=o.findIndex(l=>l.name===n),m=F(r,v,o.length),f=t.customOutputRelativeFile||t.realRelativePath,p=D(f)?.versionName;return{levels:u,status:m,targetLevel:n,scorecardLevel:h,scorecardLevelIdx:r,relativePath:f,title:t.definition.info?.title,version:p}}function T(t,i,e){const o=Object.values(t).filter(r=>r.status===d.BelowMinimum);if(o.length===0)return;const a=o.map(r=>r.relativePath);let n=`Detected OpenAPI definitions with score below minimum level:
-  - ${a.slice(0,R).map(()=>"%rp").join(`
-  - `)}`;a.length>R&&(n+=`
-  ... and ${a.length-R} more`),i?.ignoreLint??e.ignoreNonCompliant?c.warn(n,...a):c.error(n,...a)}function B(t){const i=[];for(const e of t){if(e.type!=="openapi")continue;const o=e.document;i.push({realRelativePath:e.realRelativePath,customOutputRelativeFile:e.customOutputRelativeFile,isVirtual:e.isVirtual,definition:{info:o.info}})}return i}export{$ as computeScorecard};

package/dist/server/plugins/scorecard-classic/get-scorecard-config.d.ts

@@ -1,156 +0,0 @@
-import type { RedoclyConfig } from '@redocly/config';
-export declare const getScorecardConfig: (config: Partial<RedoclyConfig>) => {
-    ignoreMetadata: boolean | undefined;
-    levels: {
-        arazzo1Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        arazzo1Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        arazzo1Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        arazzo1_1Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        arazzo1_1Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        arazzo1_1Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        async2Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        async2Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        async2Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        async3Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        async3Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        async3Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        color?: string | undefined;
-        decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        extends?: string[] | undefined;
-        graphqlRules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        name: string;
-        oas2Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas2Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas2Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        oas3_0Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_0Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_0Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        oas3_1Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_1Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_1Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        oas3_2Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_2Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        oas3_2Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        openrpc1Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        openrpc1Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        openrpc1Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        overlay1Decorators?: {
-            [x: string]: unknown;
-        } | undefined;
-        overlay1Preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        overlay1Rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-        preprocessors?: {
-            [x: string]: unknown;
-        } | undefined;
-        rules?: {
-            [x: string]: string | {
-                [x: string]: unknown;
-            };
-        } | undefined;
-    }[];
-    fromProjectUrl?: string | undefined;
-    ignore?: string[] | undefined;
-    ignoreNonCompliant?: boolean | undefined;
-    targets?: {
-        minimumLevel?: string | undefined;
-        rules?: {
-            [x: string]: unknown;
-        } | undefined;
-        where: {
-            metadata: {
-                [x: string]: string;
-            };
-        };
-    }[] | undefined;
-    teamMetadataProperty?: {
-        [x: string]: unknown;
-        default?: string | undefined;
-        label?: string | undefined;
-        property?: string | undefined;
-    } | undefined;
-};
-//# sourceMappingURL=get-scorecard-config.d.ts.map

package/dist/server/plugins/scorecard-classic/get-scorecard-config.js

@@ -1 +0,0 @@
-const a=e=>{const r=e?.scorecardClassic??e?.scorecard;return{ignoreMetadata:r?.levels?void 0:!0,levels:[{name:"lint",...e}],...r}};export{a as getScorecardConfig};

package/dist/server/plugins/scorecard-classic/get-template-path.d.ts

@@ -1,2 +0,0 @@
-export declare function getTemplatePath(relativePath: string): string;
-//# sourceMappingURL=get-template-path.d.ts.map

package/dist/server/plugins/scorecard-classic/get-template-path.js

@@ -1 +0,0 @@
-import{fromCurrentDir as t}from"../../utils/paths.js";function m(r){return t(import.meta.url,r)}export{m as getTemplatePath};

package/dist/server/plugins/scorecard-classic/index.d.ts

@@ -1,13 +0,0 @@
-import type { LifecyclePluginInstance } from '../../types';
-import type { Feature } from '../../../types/entitlements.js';
-export type ScorecardInfo = {
-    levelNames: string[];
-    rules: string[];
-    rulesPerLevel: Record<string, string[]>;
-};
-export declare function scorecardClassicPlugin({ id, requiredEntitlements, loadersPrefix, }: {
-    id?: string;
-    requiredEntitlements: Feature[];
-    loadersPrefix?: string;
-}): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/scorecard-classic/index.js

@@ -1 +0,0 @@
-import{writeFileSync as R}from"node:fs";import I from"path";import{SCORECARD_OUTPUT_FILE_NAME as w}from"../../constants/common.js";import{mapObject as L}from"../../../utils/object/map-object.js";import{envConfig as A}from"../../config/env-config.js";import{removeLeadingSlash as j}from"../../../utils/url/remove-leading-slash.js";import{combineUrls as O}from"@redocly/theme/core/utils";import{logger as _}from"../../tools/notifiers/logger.js";import{getRouteSlugToCatalogSlugMap as F}from"../../utils/catalog-classic/get-route-slug-to-catalog-slug-map.js";import{getCatalogSharedDataId as N}from"../../utils/catalog-classic/get-catalog-shared-data-id.js";import{deepEqual as E}from"../../../utils/object/deep-equal.js";import{ensureDir as q}from"../../utils/index.js";import{getTemplatePath as U}from"./get-template-path.js";import{getAllRuleNames as k}from"./lint.js";import{getScorecardConfig as T}from"./get-scorecard-config.js";import{getScorecardSlug as M}from"./shared-utils.js";import{scorecardConfigLoader as W}from"./loaders/scorecard-config.js";import{scorecardLoader as B}from"./loaders/scorecard.js";import{computeScorecard as J}from"./compute-scorecard.js";import{telemetryTraceStep as $}from"../../../cli/telemetry/helpers/trace-step.js";const x="scorecardClassic";let u={},D={};async function ue({id:b,requiredEntitlements:P,loadersPrefix:v=""}){let p=null,y=null,h=!1;return{id:b??"scorecardClassic",requiredEntitlements:P??["scorecard"],loaders:{[`${v}scorecard-config`]:W,[`${v}scorecard`]:B},async processContent(r,l){await $("com.redocly.build.plugin.scorecardClassic",async S=>{const a=r.createTemplate(x,U("./template/index.js")),g=await l.getConfig(),m=T(g),f=g?.reunite??{},i=[()=>p===null,()=>!E(u,m),()=>!E(D,f)].some(e=>e());u=m,S?.setAttribute("config",JSON.stringify(u||{})),D=f;const n=g.catalogClassic??{},c=u.levels||[];if(c.length<1)throw Error("Invalid configuration of levels config");i&&(p=await J({actions:r,context:l,scorecardConfig:u,reuniteConfig:D}));const{data:{configs:t}}=await l.cache.load("",`${v}scorecard-config`),{perLevel:d,all:s}=k(t);y={levelNames:c.map(e=>e.name),rules:s,rulesPerLevel:d};for(const[e,o]of Object.entries(n)){const C=O(o.slug,"scorecard/");r.addRoute({duplicateInAllLocales:!0,slug:C,fsPath:O(o.slug,"scorecard/"),templateId:a,hasClientRoutes:!0,excludeFromSidebar:!0,serverPropsGetterIds:[],sharedData:[{id:"scorecard",key:"scorecard"},{key:"catalog",id:N(e)}],getNavText:()=>Promise.resolve(o.title||"API design scorecard"),getStaticData:async()=>({props:{catalogId:e,catalogConfig:{...o,items:void 0},scorecardConfig:u,scorecardInfo:y}})})}})},afterRoutesCreated:async(r,l)=>{const S=await l.getConfig(),a=S.catalogClassic??{},g=T(S);if(Object.keys(a).length){const i=Object.keys(a).length>1?await F(r,l,a):null,n={};for(const[c,t]of Object.entries(p||{})){const d=r.getRouteByFsPath(c),s=d?.slug;if(s){if(d&&!g.ignoreMetadata){const e=i?i.get(s)??Object.values(a)[0].slug:Object.values(a)[0].slug,o=O(e,"scorecard/");d.metadata={...d.metadata,scorecardStatus:t.status,scorecardLevel:t.scorecardLevel,scorecardLevelIdx:t.scorecardLevelIdx,scorecardLevels:L(t.levels,C=>({uniqueErrors:C.uniqueErrors,uniqueWarnings:C.uniqueWarnings})),scoreCardSlug:o+"apis/"+encodeURIComponent(j(s))}}if(n[s]={...t,levels:L(t.levels,e=>({...e,problems:e.problems.map(o=>({ruleId:o.ruleId,severity:o.severity}))}))},!h){const e=I.resolve(r.outdir,"_scorecard",M(s));R(q(e),JSON.stringify(t))}}}await r.createSharedData("scorecard",n)}const m={};for(const[i,n]of Object.entries(p||{})){const c=r.getRouteByFsPath(i)?.slug;c&&(m[c]=n)}const f=A.REDOCLY_METADATA_OUTPUT_FOLDER;!h&&f&&(_.info("Writing scorecard data..."),R(I.join(f,w),JSON.stringify({scorecardData:m,...y}))),h=!0}}}export{ue as scorecardClassicPlugin};