@redocly/redoc-reef 0.138.0-next.13 → 0.138.0-next.14

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

@@ -1,145 +0,0 @@
-import type { ApiFunctionsContext, ApiFunctionsContextMethods, McpToolDefinition, McpToolFileSystem, McpToolJsonValue, PageStaticData } from '@redocly/config';
-import type { AuthInfo, CallToolResult, RequestId, RequestMeta, StandardSchemaWithJSON, ToolCallback } from '@modelcontextprotocol/server';
-import type { OpenAPIPath, OpenAPIServer, OpenAPIOperation } from '@redocly/api-docs';
-import type { McpErrorCodes, McpServerType } from './constants';
-import type { McpToolSchema } from '../../types';
-import type { Skill } from '../../types/plugins/skills.js';
-import type { UpstreamSecrets } from './gateway-mcp/secret-store.js';
-import type { SiteBranding } from './handlers/credentials-page/types.js';
-type ObjectValues<T> = T[keyof T];
-export type McpServerType = ObjectValues<typeof McpServerType>;
-export type McpErrorCodeTypes = ObjectValues<typeof McpErrorCodes>;
-export type ApiDescriptionInfo = {
-    name: string;
-    relativePath: string;
-    description?: string;
-    version?: string;
-    servers?: OpenAPIServer[];
-    fetchEligible?: boolean;
-};
-export type GraphqlDescriptionInfo = {
-    name: string;
-    relativePath: string;
-    description?: string;
-};
-export type McpDocsStaticDataPropsConfig = {
-    mcpDocsServerName: string;
-    apiDescriptionsMap: Record<string, ApiDescriptionInfo>;
-    graphqlDescriptions: GraphqlDescriptionInfo[];
-    mcpMode: McpMode;
-    elicitationEnabled: boolean;
-    gatewayFetchBudgetPerExec: number;
-    searchIgnoredRoutes?: string[];
-    isPublicEndpoint?: boolean;
-};
-export type McpDocsStaticData = PageStaticData & {
-    props: {
-        config: McpDocsStaticDataPropsConfig;
-        serverOutDir?: string;
-        tools?: McpToolSchema[];
-        skills?: Skill[];
-        skillsBaseUrl?: string;
-    };
-};
-export type CredentialsPageStaticData = PageStaticData & {
-    props?: {
-        branding?: SiteBranding;
-    };
-};
-export type SkillMcpResource = {
-    slug: string;
-    name: string;
-    description: string;
-    content: string;
-    uri: string;
-};
-export type McpPath = {
-    'x-mcp'?: XMcpConfig;
-} & OpenAPIPath;
-export type XMcpConfig = {
-    docs?: {
-        hide?: boolean;
-    };
-    gateway?: {
-        hide?: boolean;
-    };
-};
-export type XMcpSection = keyof XMcpConfig;
-export type McpEndpoint = OpenAPIOperation & {
-    'x-mcp'?: XMcpConfig;
-};
-export type McpMode = 'tools' | 'code';
-export type SemanticSearchResult = {
-    title: string;
-    url: string;
-    content: string;
-};
-export type McpErrorClass = 'tool_error' | 'sandbox_error' | 'client_error' | 'server_error';
-export type McpToolWorkerResponse = CallToolResult & {
-    errorClass?: McpErrorClass;
-};
-export type ToolArgs = Record<string, unknown>;
-export type McpToolCallback = ToolCallback<StandardSchemaWithJSON<ToolArgs, ToolArgs>>;
-/** The caller and request fields every MCP telemetry event and audit record carries. */
-export type McpCallAttribution = Pick<McpToolContext, 'client' | 'clientVersion' | 'requestId' | 'messageId'>;
-export type McpToolExtra = {
-    sessionId?: string;
-    authInfo?: AuthInfo;
-    requestId: RequestId;
-    _meta?: RequestMeta;
-};
-export type McpToolContext = Omit<ApiFunctionsContext, 'telemetry' | 'getKv' | keyof ApiFunctionsContextMethods> & {
-    apiDescriptionsMap: Record<string, ApiDescriptionInfo>;
-    graphqlDescriptions: GraphqlDescriptionInfo[];
-    products?: string[];
-    accessToken?: string;
-    metadata?: Record<string, unknown>;
-    upstreamAuthorization?: string;
-    mcpMode?: McpMode;
-    elicitationEnabled?: boolean;
-    gatewayFetchBudgetPerExec?: number;
-    clientIp?: string;
-    client?: string;
-    clientVersion?: string;
-    requestId?: string;
-    messageId?: string;
-    upstreamSecrets?: UpstreamSecrets;
-    searchIgnoredRoutes?: string[];
-    internalBaseUrl?: string;
-    sandboxToolSchemas?: Record<string, Record<string, unknown>>;
-    fs?: McpToolFileSystem;
-};
-export type McpToolHandler<TArgs extends ToolArgs = ToolArgs> = (args: TArgs, context: McpToolContext, extra: McpToolExtra) => Promise<McpToolWorkerResponse | McpToolJsonValue>;
-export type McpToolIsAvailable = (context: McpToolContext) => boolean | Promise<boolean>;
-export type McpToolHandlerExtended<TArgs extends ToolArgs = ToolArgs> = {
-    execute: McpToolHandler<TArgs>;
-    isAvailable?: McpToolIsAvailable;
-};
-export type McpToolExecutionParams = {
-    toolName: string;
-    args: ToolArgs;
-    context: McpToolContext;
-    extra: McpToolExtra;
-};
-export type CustomMcpToolsState = {
-    registeredToolNames: string[];
-    warnedNoOutputSchemaTools: Set<string>;
-};
-export type ToolDefinitionValidationResult = {
-    ok: true;
-    schema: McpToolSchema;
-} | {
-    ok: false;
-    errors: string[];
-};
-export type ToolFileDefaultExport = Partial<McpToolDefinition> | null | undefined;
-export type McpToolModuleGetter = () => Promise<{
-    default: McpToolModuleExport;
-}>;
-export type McpToolMapExport = Record<string, McpToolHandler | McpToolHandlerExtended | undefined>;
-export type McpToolFileExport = McpToolHandlerExtended & {
-    description: string;
-};
-export type McpToolModuleExport = McpToolMapExport | McpToolFileExport;
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/server/plugins/mcp/utils/available-sandbox-tools.d.ts

@@ -1,4 +0,0 @@
-import type { McpToolSchema } from '../../../types';
-import type { McpToolContext } from '../types.js';
-export declare function availableSandboxTools(candidates: McpToolSchema[], context: McpToolContext): Promise<McpToolSchema[]>;
-//# sourceMappingURL=available-sandbox-tools.d.ts.map

package/dist/server/plugins/mcp/utils/available-sandbox-tools.js

@@ -1 +0,0 @@
-import{logger as a}from"../../../tools/notifiers/logger.js";import{mcpToolWorkers as n,MCP_TOOL_AVAILABILITY_KEY as m}from"../../../workers/mcp-tool-worker-pool.js";async function p(t,l){if(t.length===0)return t;const e=t.map(o=>o.name);let r;try{r=await n.exec(m,[{toolNames:e,context:l}],{timeout:1e4})}catch(o){return i(t,o instanceof Error?o.message:String(o))}return!r||typeof r!="object"?i(t,"the worker returned no availability map"):t.filter(o=>r[o.name]!==!1)}function i(t,l){const e=t.filter(r=>r.hasAvailabilityGate);return e.length===0?t:(a.warn(`MCP tool availability is unknown (${l}); the sandbox tool list drops the gated tools: ${e.map(r=>r.name).join(", ")}.`),t.filter(r=>!r.hasAvailabilityGate))}export{p as availableSandboxTools};

package/dist/server/plugins/mcp/utils/disabled-tools.d.ts

@@ -1,3 +0,0 @@
-import type { McpToolContext } from '../types.js';
-export declare function isToolDisabledByCaller(toolName: string, metadata: McpToolContext['metadata']): boolean;
-//# sourceMappingURL=disabled-tools.d.ts.map

package/dist/server/plugins/mcp/utils/disabled-tools.js

@@ -1 +0,0 @@
-function r(o,s){const l=s?.disabledTools;return Array.isArray(l)&&l.includes(o)}export{r as isToolDisabledByCaller};

package/dist/server/plugins/mcp/utils/find-gated-tool-names.d.ts

@@ -1,12 +0,0 @@
-import type { McpToolRegistration } from '../../../types';
-import type { McpToolModuleExport } from '../types.js';
-type ToolModuleLoader = (importPath: string) => Promise<{
-    default: McpToolModuleExport;
-}>;
-/**
- * Names of the tools whose handler declares an `isAvailable` predicate — the ones the live
- * server enables per caller. Includes every tool of a handler module that fails to load.
- */
-export declare function findGatedToolNames(registrations: McpToolRegistration[], load?: ToolModuleLoader): Promise<string[]>;
-export {};
-//# sourceMappingURL=find-gated-tool-names.d.ts.map

package/dist/server/plugins/mcp/utils/find-gated-tool-names.js

@@ -1 +0,0 @@
-import{resolveToolHandler as l}from"../workers/execute-mcp-tool.js";const s=t=>import(t);async function d(t,o=s){const n=[];for(const{name:e,importPath:r,hasAvailabilityGate:a}of t){if(a!==void 0){a&&n.push(e);continue}const i=await c(r,o);(!i||f(l(i,e)))&&n.push(e)}return n}async function c(t,o){try{const{default:n}=await o(t);return n}catch{return}}function f(t){return typeof t=="object"&&typeof t.isAvailable=="function"}export{d as findGatedToolNames};

package/dist/server/plugins/mcp/utils/json-schema-validator.d.ts

@@ -1,9 +0,0 @@
-import type { jsonSchemaValidator } from '@modelcontextprotocol/server';
-/**
- * Validates tool arguments with the same engine and options the forked SDK
- * (@redocly/mcp-typescript-sdk) used internally, so migrating to the upstream
- * v2 SDK does not change which arguments are accepted. The SDK default would
- * be a lenient draft-2020-12 engine instead.
- */
-export declare const mcpJsonSchemaValidator: jsonSchemaValidator;
-//# sourceMappingURL=json-schema-validator.d.ts.map

package/dist/server/plugins/mcp/utils/json-schema-validator.js

@@ -1 +0,0 @@
-import{AjvJsonSchemaValidator as a}from"@modelcontextprotocol/server/validators/ajv";import l from"@redocly/ajv";const c=new a(new l({allErrors:!0})),j={getValidator(r){const o=c.getValidator(r),t=Object.keys(r.properties??{});return t.length===0||r.additionalProperties!==!1?o:n=>{const e=o(n),i=Object.keys(n??{}).filter(s=>!t.includes(s));return e.valid||i.length===0?e:{...e,errorMessage:`${e.errorMessage}. Unknown properties: ${i.join(", ")}. Accepted properties: ${t.join(", ")}.`}}}};export{j as mcpJsonSchemaValidator};

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

@@ -1,5 +0,0 @@
-/**
- * Extract JWT token from Authorization header
- */
-export declare function extractTokenFromAuthHeader(authHeader?: string | string[]): string | null;
-//# sourceMappingURL=jwt.d.ts.map

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

@@ -1 +0,0 @@
-function n(r){if(!r)return null;const e=Array.isArray(r)?r[0]:r;return!e||!e.startsWith("Bearer ")?null:e.replace(/^Bearer /,"")}export{n as extractTokenFromAuthHeader};

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

@@ -1,13 +0,0 @@
-/**
- * Both markers are parenthesised so neither can collide with a real client: a name is built out
- * of `[a-z0-9._-]`, which cannot produce a bracket.
- */
-export declare function resolveMcpClient(request: Request): {
-    client: string;
-    clientVersion?: string;
-};
-export declare function parseUserAgent(userAgent: string | null | undefined): {
-    client: string;
-    clientVersion?: string;
-};
-//# sourceMappingURL=mcp-client.d.ts.map

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

@@ -1 +0,0 @@
-const o="(none)",r="(unparsed)",N=40,i=/^[A-Za-z0-9._\- ]+/,c=/(?<!\s)\s+([0-9]\S*)(?:[^\S\n].*)?$/,l=/^[/\s]+v?([0-9][^\s;,)]*)/;function a(e){return E(e.headers.get("user-agent"))}function E(e){if(e==null)return{client:o};const n=i.exec(e)?.[0]??"",t=n.replace(c,"").trim();if(!t)return{client:r};const s=c.exec(n)?.[1]??l.exec(e.slice(n.length))?.[1];return{client:t.replace(/\s+/g,"-").toLowerCase().slice(0,40),clientVersion:s?.slice(0,40)}}export{E as parseUserAgent,a as resolveMcpClient};

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

@@ -1,20 +0,0 @@
-import type { McpMode } from '../types.js';
-/**
- * Codemode - `execute` sandbox and `describeTools`. Gated by the org-level `mcpMode`
- * entitlement (GrowthBook `mcp-mode` flag → PLAN_GATES JWT).
- *
- * Read the VALUE, never `canAccessFeature('mcpMode')` — 'tools' is truthy.
- * Only call these helpers where EntitlementsProvider is initialized: the build lifecycle
- * and web-server routes. Request handlers and workers run in module graphs with an
- * UNINITIALIZED provider copy — they must read the build-stamped `mcpMode` from static
- * data / McpToolContext instead (see docs-mcp-handler / execute-mcp-tool).
- */
-export declare function isMcpCodeModeEnabled(): boolean;
-/**
- * The gateway capability: a guarded `fetch` in the `execute` sandbox. Requires code mode and a
- * project database.
- */
-export declare function isMcpGatewayEnabled(): boolean;
-export declare function isMcpElicitationEnabled(): boolean;
-export declare function getMcpMode(): McpMode;
-//# sourceMappingURL=mode.d.ts.map

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

@@ -1 +0,0 @@
-import{EntitlementsProvider as e}from"../../../entitlements/entitlements-provider.js";import{hasProjectDatabase as n}from"../../../providers/database/has-project-database.js";function t(){return e.instance().entitlements?.mcpMode==="code"}function o(){return!!e.instance().canAccessFeature("mcpGateway")&&t()&&n()}function i(){return o()}function a(){return t()?"code":"tools"}export{a as getMcpMode,t as isMcpCodeModeEnabled,i as isMcpElicitationEnabled,o as isMcpGatewayEnabled};

package/dist/server/plugins/mcp/utils/public-endpoint.d.ts

@@ -1,9 +0,0 @@
-import type { RedoclyConfig } from '@redocly/config';
-export type PublicMcpEndpointStatus = 'served' | 'disabled' | 'no-protected-content' | 'anonymous-denied';
-/**
- * Whether `/mcp-public` is served for this config, and why not when it is not.
- * Ignores the `mcp` entitlement, so it is safe in request handlers; build-time callers
- * that need the full answer must also check the entitlement.
- */
-export declare function getPublicMcpEndpointStatus(config: Pick<RedoclyConfig, 'mcp' | 'access'>): PublicMcpEndpointStatus;
-//# sourceMappingURL=public-endpoint.d.ts.map

package/dist/server/plugins/mcp/utils/public-endpoint.js

@@ -1 +0,0 @@
-import{canAnonymousAccessMcpFeature as c}from"../../../utils/rbac/can-anonymous-access-mcp-feature.js";import{shouldHandleMcpAuth as i}from"../../../utils/rbac/should-handle-mcp-auth.js";function d(t){const{mcp:n,access:e}=t;if(n?.hide||n?.docs?.hide||!n?.docs?.publicEndpoint)return"disabled";const o=!!e?.requiresLogin,r=e?.rbac||{};return i(o,r)?c(r,o)?"served":"anonymous-denied":"no-protected-content"}export{d as getPublicMcpEndpointStatus};

package/dist/server/plugins/mcp/utils/telemetry-attributes.d.ts

@@ -1,9 +0,0 @@
-import type { McpCallAttribution, McpServerType, McpToolContext } from '../types.js';
-/** CloudEvent resource attributes shared by every `mcpServer` telemetry event. */
-export declare function serverAttributes(serverType: McpServerType): {
-    id: "docs";
-    object: 'mcpServer';
-    uri: string;
-};
-export declare function callAttribution(context: McpToolContext | undefined): McpCallAttribution;
-//# sourceMappingURL=telemetry-attributes.d.ts.map

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};