@redocly/api-docs 0.0.2

package/lib/adapters/openapi/buildContext.js

@@ -0,0 +1 @@
+import{createScopedContext as e}from"../scopedContext.js";const t=e("OpenAPI");export{t as openApiContext};

package/lib/adapters/openapi/configure/apply-request-values.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
+import type { OperationInfo, OpenAPIServer } from '../../../types/openapi.js';
+export declare function applyRequestValuesToOperationInfo(operationInfo: OperationInfo, requestValues: ConfigureRequestValues | ConfigureServerRequestValues, mergedServers?: OpenAPIServer[]): void;

package/lib/adapters/openapi/configure/apply-request-values.js

@@ -0,0 +1 @@
+import{isRecord as y,resolveRef as d,isOpenAPIRef as p}from"../../helpers.js";import{openApiContext as R}from"../buildContext.js";import{applyServerVariableDefaults as b,getEffectiveRequestValues as v,getParamValueMap as O,isDirectRequestValues as x,mergeBodyValue as h,updateObjectProperties as k}from"./merge-utils.js";import{hasOpenApiExampleValue as j}from"../resolve-openapi-example-value.js";import{excludeMockServers as E}from"../utils/merge-mock-server.js";function V(t,e,o,r){const n=t.parameters;if(n?.length)for(let f=0;f<n.length;f++){const s=n[f],a=p(s),i=a?d(e,s,o):s;if(!i?.in||!i.name)continue;const u=O(i.in,r)?.[i.name];u!==void 0&&(a?n[f]={...i,example:u}:i.example=u)}}function g(t,e){if(!j(t))return;const o=t.dataValue!==void 0?"dataValue":t.serializedValue!==void 0?"serializedValue":"value",r=t[o],n=y(r)&&y(e)?k(r,e):e;n!==void 0&&(t[o]=n)}function w(t,e,o,r){if(r.body===void 0)return;const n=t.requestBody;if(!n)return;const f=d(e,n,o)??n;if(!(p(f)||!f.content))for(const s of Object.values(f.content)){if(!s)continue;if(s.example!==void 0){const i=h(s.example,r.body);i!==void 0&&(s.example=i)}if(s.examples)for(const i of Object.values(s.examples)){const c=d(e,i,o)??i;p(c)||g(c,r.body)}const a=s.formExamples;if(a&&typeof a=="object")for(const i of Object.keys(a)){const c=a[i];if(!c||typeof c!="object")continue;const u=d(e,c,o)??c;p(u)||g(u,r.body)}}}function B(t,e){(e.security||e.envVariables||e.body!==void 0)&&(t.requestValues={...t.requestValues,...e.security&&{security:e.security},...e.envVariables&&{envVariables:e.envVariables},...e.body!==void 0&&{body:e.body}})}function S(t,e){const o={};for(const r of t){const n=e[r.url];n&&(n.serverVariables&&b(t,n.serverVariables,r.url),o[r.url]={headers:n.headers,queryString:n.query,cookies:n.cookie,security:n.security,...n.envVariables&&{envVariables:n.envVariables},...n.body!==void 0&&{body:n.body}})}return o}function M(t,e){if(x(t))return t;const o=new Set(e.filter(r=>r.isMockServer).map(r=>r.url));return o.size===0?t:Object.fromEntries(Object.entries(t).filter(([r])=>!o.has(r)))}function F(t,e,o){if(!e||Object.keys(e).length===0)return;const{options:r,storeCtx:n,document:f}=R.get(),{ignoreNamedSchemas:s}=r,a=f.servers??[],i=t.servers,c=o&&o.length>0?o:i&&i.length>0?i:a,u=E(c),l=u.length>0?v(M(e,c),u):v(e,c);if(l&&(V(t,n.document,s,l),w(t,n.document,s,l),B(t,l)),x(e)){b(c,e.serverVariables);return}const m=S(c,e);Object.keys(m).length>0&&(t.requestValues={...t.requestValues,serverRequestValues:m})}export{F as applyRequestValuesToOperationInfo};

package/lib/adapters/openapi/configure/index.d.ts

@@ -0,0 +1,3 @@
+export { resolveRequestValues } from './resolve-request-values.js';
+export type { ResolveRequestValuesParams } from './resolve-request-values.js';
+export { applyRequestValuesToOperationInfo } from './apply-request-values.js';

package/lib/adapters/openapi/configure/index.js

@@ -0,0 +1 @@
+import{resolveRequestValues as r}from"./resolve-request-values.js";import{applyRequestValuesToOperationInfo as s}from"./apply-request-values.js";export{s as applyRequestValuesToOperationInfo,r as resolveRequestValues};

package/lib/adapters/openapi/configure/merge-utils.d.ts

@@ -0,0 +1,32 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues, SecurityDetails } from '@redocly/theme/ext/configure';
+import type { OpenAPIParameterLocation, OpenAPIServer } from '../../../types/openapi.js';
+import type { SecuritySchemeCredentials } from '../../../services/code-samples/source.js';
+export declare function getParamValueMap(loc: OpenAPIParameterLocation, source: ConfigureRequestValues): Record<string, string> | undefined;
+export declare function mergeBodyValue(base: unknown, overlay: unknown): unknown;
+export type SchemeForCredentials = {
+    id: string;
+    type?: string;
+    scheme?: string;
+    scopes?: string[];
+    serverValues?: Record<string, SecuritySchemeCredentials>;
+};
+export declare function updateObjectProperties(original: unknown, updates: unknown): unknown;
+export declare function isDirectRequestValues(value: ConfigureRequestValues | ConfigureServerRequestValues | undefined | null): value is ConfigureRequestValues;
+export declare function getEffectiveRequestValues(requestValues: ConfigureRequestValues | ConfigureServerRequestValues | undefined, servers: readonly {
+    url: string;
+}[] | undefined): ConfigureRequestValues | undefined;
+export declare function createSecurityUpdates(scheme: SchemeForCredentials, securityValues: Record<string, SecurityDetails>): SecuritySchemeCredentials;
+export declare function mergeSecurityIntoScheme<S extends SchemeForCredentials>(scheme: S, securityValues: Record<string, SecurityDetails>): S & SecuritySchemeCredentials;
+export declare function mergeSecurityIntoScheme<S extends SchemeForCredentials>(scheme: S, securityValues: Record<string, SecurityDetails>, serverUrl: string): S & {
+    serverValues: Record<string, SecuritySchemeCredentials>;
+};
+export declare function applyServerVariableDefaults(servers: OpenAPIServer[] | undefined, serverVariables: Record<string, string> | undefined, targetServerUrl?: string): void;
+/** Immutable variant of {@link applyServerVariableDefaults} for the Replay runtime path. */
+export declare function withServerVariableDefaults<T extends {
+    url: string;
+    variables?: Record<string, {
+        default?: string;
+        enum?: string[];
+        description?: string;
+    }>;
+}>(servers: readonly T[], serverVariables: Record<string, string> | undefined, targetServerUrl?: string): T[];

package/lib/adapters/openapi/configure/merge-utils.js

@@ -0,0 +1 @@
+import{isRecord as u}from"../../helpers.js";function y(e,n){switch(e){case"header":return n.headers;case"query":return n.query;case"path":return n.path;case"cookie":return n.cookie;default:return}}function b(e,n){return n===void 0?e:u(e)&&u(n)?a(e,n):n}function a(e,n){if(!u(e)&&!Array.isArray(e))return n;if(Array.isArray(e)&&Array.isArray(n)){const t=e[0];if(e.length>0&&u(t)){const i=Object.keys(t),f=n.filter(o=>{if(!u(o))return!1;const c=Object.keys(o);return i.some(s=>s in o)&&c.every(s=>i.includes(s))});return f.length>0?f:e}return n}if(Array.isArray(e))return[...e];const r={...e};if(!u(n))return r;for(const[t,i]of Object.entries(n)){if(!(t in e))continue;const f=e[t];Array.isArray(f)||u(f)&&u(i)?r[t]=a(f,i):r[t]=i}return r}function d(e){return u(e)?"headers"in e||"body"in e||"query"in e||"path"in e||"cookie"in e||"security"in e||"envVariables"in e||"serverVariables"in e:!1}function k(e,n){if(!e)return;if(d(e))return e;const r=e;if(n?.length){for(const i of n)if(r[i.url])return r[i.url]}const t=Object.keys(r)[0];return t?r[t]:void 0}function l(e,n){const r=n[e.id]??n.default??{},t={};return r.token?.access_token!==void 0&&(t["x-defaultAccessToken"]=r.token.access_token,t["x-defaultTokenType"]=r.token.token_type||"Bearer"),r.client_id!==void 0&&(t["x-defaultClientId"]=r.client_id),r.client_secret!==void 0&&(t["x-defaultClientSecret"]=r.client_secret),r.scopes!==void 0?t.scopes=r.scopes:e.scopes!==void 0&&(t.scopes=e.scopes),e.type==="http"&&e.scheme==="basic"&&(r.username!==void 0&&(t["x-defaultUsername"]=r.username),r.password!==void 0&&(t["x-defaultPassword"]=r.password),delete t["x-defaultAccessToken"],delete t["x-defaultTokenType"]),t}function x(e,n,r){const t=l(e,n);return r?{...e,serverValues:{...e.serverValues??{},[r]:t}}:{...e,...t}}function A(e,n,r){if(!n||Object.keys(n).length===0||!e?.length)return;const t=r?e.filter(i=>i.url===r):e;for(const i of t)if(i.variables)for(const[f,o]of Object.entries(n)){const c=i.variables[f];c&&(c.default=o)}}function h(e,n,r){return!n||Object.keys(n).length===0?e:e.map(t=>{if(r&&t.url!==r||!t.variables)return t;let i;for(const[f,o]of Object.entries(n))t.variables[f]&&(i||(i={...t.variables}),i[f]={...i[f],default:o});return i?{...t,variables:i}:t})}export{A as applyServerVariableDefaults,l as createSecurityUpdates,k as getEffectiveRequestValues,y as getParamValueMap,d as isDirectRequestValues,b as mergeBodyValue,x as mergeSecurityIntoScheme,a as updateObjectProperties,h as withServerVariableDefaults};

package/lib/adapters/openapi/configure/resolve-request-values.d.ts

@@ -0,0 +1,17 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
+import type { UserClaims } from '@redocly/theme/core/types';
+import type { OpenAPIServer } from '@redocly/theme/core/types';
+import type { OperationInfo } from '../../../types/openapi.js';
+export type ResolveRequestValuesParams = {
+    operationInfo: OperationInfo;
+    info: Record<string, unknown>;
+    servers: OpenAPIServer[];
+    basePath: string;
+    userClaims?: UserClaims;
+    dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
+};
+/**
+ * Builds configure context, calls the ejected configure() function, and returns
+ * merged request values: dynamicRequestValues ?? configResult.requestValues ?? {}.
+ */
+export declare function resolveRequestValues(params: ResolveRequestValuesParams): ConfigureRequestValues | ConfigureServerRequestValues;

package/lib/adapters/openapi/configure/resolve-request-values.js

@@ -0,0 +1 @@
+import{configure as c}from"@redocly/theme/ext/configure";import{getOperationData as m}from"../utils/operation.js";function d(n){const{operationInfo:e,info:r,servers:a,basePath:s,userClaims:i,dynamicRequestValues:t}=n;if(t!=null&&Object.keys(t).length>0)return t;const{slug:u}=m(e,s),l=e.summary||e.operationId||e.pathName||"Unknown Operation",p={userClaims:i,info:r,operation:{name:l,path:e.pathName??"",operationId:e.operationId,href:u,method:e.httpVerb??""},servers:a},o=(c(p)??{}).requestValues;return o!=null&&Object.keys(o).length>0?o:{}}export{d as resolveRequestValues};

package/lib/adapters/openapi/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const SUPPORTED_MCP_TYPES: readonly ['tools', 'resources', 'prompts'];
+export type McpCollectionType = (typeof SUPPORTED_MCP_TYPES)[number];
+export declare const MCP_SERVER_EXPERIMENTAL_CAPABILITIES = "experimental";
+export declare const PAGE_ACTIONS_MCP: "mcp-cursor"[];

package/lib/adapters/openapi/constants.js

@@ -0,0 +1 @@
+const o=["tools","resources","prompts"],r="experimental",t=["mcp-cursor"];export{r as MCP_SERVER_EXPERIMENTAL_CAPABILITIES,t as PAGE_ACTIONS_MCP,o as SUPPORTED_MCP_TYPES};

package/lib/adapters/openapi/group/content.d.ts

@@ -0,0 +1,28 @@
+import type { Node } from '@markdoc/markdoc';
+import type { ApiItemContent } from '../../../types/content.js';
+import type { BreadcrumbItem, GroupItem } from '../../../types/store.js';
+import type { OpenAPITagExtended, OperationInfo } from '../../../types/openapi.js';
+import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
+import type { McpGroupItems } from '../items/mcp/item.js';
+export type ChildTagInfo = {
+    displayName: string;
+    summary?: string;
+    slug: string;
+};
+export declare function buildGroupContent({ tag, tagName, headerLabel, description, operations, schemasItems, mcpItems, tagSlug, basePath, breadcrumbs, childTags, markdownOptions, feedback, }: {
+    tag: OpenAPITagExtended;
+    tagName: string;
+    headerLabel?: string;
+    description?: string | Node[] | Node;
+    operations: OperationInfo[];
+    schemasItems?: GroupItem[];
+    mcpItems?: McpGroupItems;
+    tagSlug: string;
+    basePath: string;
+    breadcrumbs?: BreadcrumbItem[];
+    childTags?: ChildTagInfo[];
+    markdownOptions: ParseMarkdownOptions;
+    feedback?: {
+        hide?: boolean;
+    };
+}): ApiItemContent;

package/lib/adapters/openapi/group/content.js

@@ -0,0 +1 @@
+import{WEBHOOKS_GROUP_TITLE as W}from"../../../constants/openapi.js";import{contentType as B,nodeTypes as i,panelKind as s}from"../../../types/common.js";import{normalizePath as h,toRelativePath as u}from"../../../utils/url.js";import{parseMarkdown as H}from"../../utils/parseMarkdown.js";import{extractDescriptionSegments as v}from"../../utils/markdoc.js";import{getOperationColor as w,getOperationData as F,getOperationSummary as V}from"../utils/operation.js";import{readRbacScope as j,rbacProp as z}from"../../helpers.js";const X={tools:{title:"MCP Tools",translationKey:"openapi.mcp.tools"},resources:{title:"MCP Resources",translationKey:"openapi.mcp.resources"},prompts:{title:"MCP Prompts",translationKey:"openapi.mcp.prompts"}};function te({tag:r,tagName:f,headerLabel:K,description:A,operations:M,schemasItems:l,mcpItems:T,tagSlug:y,basePath:a,breadcrumbs:N,childTags:c,markdownOptions:d,feedback:_}){const p={nodeType:i.CONTAINER,children:[{nodeType:i.HEADER,level:2,label:K??f,showPageActions:!0}],panels:[]},g=[],O=[],E=[],P=[];for(const e of M){const{slug:o,badges:m,deprecated:n,httpVerb:D,isAdditionalOperation:G,isWebhook:U}=F(e,y),L={name:D,color:w({httpVerb:D,deprecated:n,isAdditionalOperation:G})},I={title:e.pathName,summary:V(e,d),prefix:L,badges:m??[],link:h(u(o,a)),deprecated:n,...z(j(e))};U?(n?P:E).push(I):(n?O:g).push(I)}const R=[...g,...O],S=[...E,...P],t=[];if(c&&c.length>0){const e=c.map(o=>({title:o.displayName,summary:o.summary,link:h(u(o.slug,a)),deprecated:!1,childTag:!0}));t.push({kind:s.GROUP_ITEMS,title:"",items:e})}if(l&&l.length>0&&t.push({kind:s.GROUP_ITEMS,title:"Schemas",titleTranslationKey:"schemas",items:l}),R.length>0&&t.push({kind:s.GROUP_ITEMS,title:"Operations",titleTranslationKey:"operations",items:R}),S.length>0&&t.push({kind:s.GROUP_ITEMS,title:W,titleTranslationKey:"webhooks",items:S}),T){for(const[e,o]of Object.entries(T))if(o.length>0){const{title:m,translationKey:n}=X[e];t.push({kind:s.GROUP_ITEMS,title:m,titleTranslationKey:n,items:o})}}if(t.length>0){const e={children:t};p.panels?.push(e)}const b=v(A,d,{sliceAtFirstHeading:!0}),x=b.some(e=>e.kind==="schemaDefinition"),k=[];for(const e of b){if(!x){p.children?.push(e.node);continue}k.push(e.kind==="schemaDefinition"?e.node:{nodeType:i.CONTAINER,children:[e.node],panels:[]})}if(r.externalDocs){const e=H(r.externalDocs.description,d)??[];p.children?.push({nodeType:i.EXTERNAL_DOCS,url:r.externalDocs.url,description:e})}const C=[p,...k];return _?.hide!==!0&&t.length===0&&C.push({nodeType:i.CONTAINER,children:[{nodeType:i.FEEDBACK,pageSlug:h(u(y,a))}],panels:[]}),{contentType:B.GROUP,seo:r["x-seo"],meta:{name:f,breadcrumbs:N},children:C}}export{te as buildGroupContent};

package/lib/adapters/openapi/group/item.d.ts

@@ -0,0 +1,11 @@
+import { REDOCLY_TEAMS_RBAC } from '@redocly/config';
+import type { RbacScopeItems } from '@redocly/config';
+import type { ApiItem } from '../../../types/store.js';
+import type { OpenAPIDefinition } from '../../../types/openapi.js';
+export declare function addTagItems(document: OpenAPIDefinition, result: ApiItem[]): void;
+export declare function processTagGroups(xTagGroups: Array<{
+    name: string;
+    tags: string[];
+    [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+}>, result: ApiItem[]): void;
+export declare function processRootTags(tagOrder: string[], childTagNames: Set<string>, result: ApiItem[]): void;

package/lib/adapters/openapi/group/item.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as f}from"@redocly/config";import{DEFAULT_WEBHOOKS_TAG_NAME as C,GROUP_DEPTH as E,MAX_NESTING_TAGS_LEVEL as _}from"../../../constants/openapi.js";import{encodeBackSlashes as w,safeSlugify as A}from"../../../utils/string.js";import{joinWithSeparator as S,toRelativePath as v}from"../../../utils/url.js";import{extractMarkdownSections as L,buildMarkdownSectionItem as N}from"../../utils/markdoc.js";import{buildGroupContent as R}from"./content.js";import{addOperationItems as P}from"../items/operation/item.js";import{addSchemaDefinitionItems as B}from"../items/schema/item.js";import{addMcpItems as W}from"../items/mcp/item.js";import{openApiContext as p}from"../buildContext.js";function tt(t,n){const r=p.get(),o=U(r.tagsMap),e=j(t),s=t["x-tagGroups"];o.size>0?k(e,o,n):s?.length?H(s,n):k(e,o,n)}function H(t,n){const r=p.get();for(const o of t){n.push({type:"separator",label:o.name,[f]:o[f],content:null});for(const e of o.tags||[]){const s=r.tagsMap.get(e);s&&O(e,s,n,[],void 0,o[f])}}}function k(t,n,r){const o=p.get(),e=new Set;for(const s of t)if(!n.has(s)){const a=o.tagsMap.get(s);a&&G(s,a,r,e)}}function D(t){return t.kind==="badge"||t.kind==="audience"}function b(t,n){return S(t,w(A(n).toLowerCase()))}function U(t){const n=new Set;for(const r of t.values()){const{tag:o}=r;o.parent&&!D(o)&&n.add(o.name)}return n}function j(t){const n=p.get(),o=[...n.hasTopLevelTags?(t.tags||[]).map(s=>s.name):n.collectedTagOrder],e=n.options.schemaDefinitionsTagName;e&&!o.includes(e)&&o.push(e);for(const s of n.collectedTagOrder)o.includes(s)||o.push(s);return o}function G(t,n,r,o,e=E,s,a){const i=p.get();if(o.has(t)||D(n.tag))return;if(e>_){console.warn("Tags exceed the maximum nesting level.");return}o.add(t);const d=b(s??i.basePath,t),m=n.tag[f]??a,u=[];for(const g of n.children){const c=i.tagsMap.get(g);c&&G(g,c,u,o,e+1,d,m)}O(t,n,r,u,d,a)}function z(t){const n=p.get(),r=[];let o=n.tagsMap.get(t)?.tag;for(;o?.parent;){const e=n.tagsMap.get(o.parent);if(!e)break;r.unshift({label:e.tag.summary||e.tag["x-displayName"]||e.tag.name}),o=e.tag}return r}function O(t,n,r,o,e,s){const a=p.get(),{tag:i,operations:d,description:m}=n,u=i[f]??s;if(t===""){P({operations:d,result:r});return}e||(e=b(a.basePath,t));const g=i.summary||i["x-displayName"]||t,c=[];if(m&&a.processContent){const l=v(e,a.basePath);for(const M of L(m,a.options,l,!!t))c.push(N({heading:M,basePath:a.basePath}))}P({operations:d,result:c,basePath:e,parentRbac:u});const h=[];B({tagName:t,tagSlug:e,result:c,groupItems:h});const x={tools:[],resources:[],prompts:[]};if(W({tagName:t,tagSlug:e,result:c,groupItems:x}),c.push(...o),t===C&&c.length===0)return;const I=z(t),y=n.children.map(l=>{const T=a.tagsMap.get(l)?.tag;return{displayName:T?.summary||T?.["x-displayName"]||l,summary:T?.summary,slug:b(e,l)}});r.push({type:"group",label:g,link:e,routeSlug:e,items:c,[f]:u,content:a.processContent?R({tag:i,tagName:t,headerLabel:g,description:m,operations:d,schemasItems:h.length>0?h:void 0,mcpItems:x,tagSlug:e,basePath:a.basePath,breadcrumbs:I.length>0?I:void 0,childTags:y.length>0?y:void 0,markdownOptions:a.options,feedback:a.options.feedback}):null})}export{tt as addTagItems,k as processRootTags,H as processTagGroups};

package/lib/adapters/openapi/index.d.ts

@@ -0,0 +1,13 @@
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
+import type { OpenAPIDefinition } from '../../types/openapi.js';
+import type { ApiDocsOptions } from '../../types/options.js';
+export type { OpenApiBuildContext as BuildContext, TagData } from '../../types/openapi.js';
+export declare function processOpenApiDocument({ document, basePath, options, processContent, }: ApiDocAdapterProps & {
+    document: OpenAPIDefinition;
+    options: ApiDocsOptions;
+    processContent?: boolean;
+}): Promise<{
+    items: ApiItem[];
+    store: ApiStore;
+}>;
+export declare function buildOpenApiItems(): ApiItem[];

package/lib/adapters/openapi/index.js

@@ -0,0 +1 @@
+import{createStoreContext as s,toRecord as l}from"../helpers.js";import{populateOpenApiStore as p}from"./store.js";import{createBuildContext as u}from"./build/context.js";import{buildOverviewItems as f}from"./items/overview/item.js";import{addTagItems as S}from"./group/item.js";import{openApiContext as m}from"./buildContext.js";import{mergeInMockServer as g}from"./utils/merge-mock-server.js";import{toSidebarLogo as v}from"../../utils/logo.js";function d(){return new Promise(r=>setTimeout(r,0))}function x(r,t){const o=r.servers??[];return g(o.filter(e=>typeof e?.url=="string"),t.mockServer).map(e=>({url:e.url,...e.name&&{name:e.name},...e.isMockServer&&{isMockServer:!0},...typeof e.description=="string"&&e.description&&{description:e.description},...e.variables&&Object.keys(e.variables).length>0&&{variables:e.variables}}))}async function M({document:r,basePath:t="/",options:o,processContent:i=!0}){const e=s(l(r));i&&(p(r,e,o),await d());const a=u({document:r,options:o,basePath:t,storeCtx:e,processContent:i}),n=x(r,o),c=v(r.info?.["x-logo"],r.info?.contact?.url);return m.run(a,()=>({items:b(),store:{schemaStore:e.schemaStore,exampleStore:e.exampleStore,securitySchemeStore:e.securitySchemeStore,mcp:e.document["x-mcp"],schemaCatalogLink:r["x-schema-catalog-link"],...n.length>0&&{servers:n},...c&&{logo:c}}}))}function b(){const r=m.get(),t=[...f(r.document)];return S(r.document,t),t}export{b as buildOpenApiItems,M as processOpenApiDocument};

package/lib/adapters/openapi/items/mcp/content.d.ts

@@ -0,0 +1,5 @@
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+type McpItemType = 'tool' | 'rsrc' | 'prompt';
+export declare function buildMcpItemContent(mcpType: McpItemType, name: string, id: string, title: string, options: ApiDocsOptions): ApiItemContent;
+export {};

package/lib/adapters/openapi/items/mcp/content.js

@@ -0,0 +1 @@
+import{contentType as d,nodeTypes as e}from"../../../../types/common.js";import{parseMarkdown as l}from"../../../utils/parseMarkdown.js";import{escapeHTMLAttrChars as n}from"../../utils/helpers.js";const i={tool:"mcpTool",rsrc:"mcpResource",prompt:"mcpPrompt"};function y(r,o,c,t,p){const s=i[r],m=n(o),a=n(c),T=`{% ${s} name="${m}" id="${a}" /%}`;return{contentType:d.ITEM,seo:{title:t},meta:{name:o},children:[{nodeType:e.CONTAINER,children:[{nodeType:e.HEADER,level:2,label:t,showPageActions:!0}],panels:[]},{nodeType:e.MARKDOC,content:l(T,p)??[]}]}}export{y as buildMcpItemContent};

package/lib/adapters/openapi/items/mcp/item.d.ts

@@ -0,0 +1,9 @@
+import type { ApiItem, GroupItem } from '../../../../types/store.js';
+import { type McpCollectionType } from '../../constants.js';
+export declare function addMcpItems({ tagName, tagSlug, result, groupItems, }: {
+    tagName: string;
+    tagSlug: string;
+    result: ApiItem[];
+    groupItems?: McpGroupItems;
+}): void;
+export type McpGroupItems = Record<McpCollectionType, GroupItem[]>;

package/lib/adapters/openapi/items/mcp/item.js

@@ -0,0 +1 @@
+import{encodeBackSlashes as E,safeSlugify as g}from"../../../../utils/string.js";import{SUPPORTED_MCP_TYPES as M}from"../../constants.js";import{titleize as S}from"../../utils/helpers.js";import{joinWithSeparator as d,normalizePath as T,toRelativePath as b}from"../../../../utils/url.js";import{buildMcpItemContent as k}from"./content.js";import{openApiContext as x}from"../../buildContext.js";const I={tools:"tool",resources:"rsrc",prompts:"prompt"};function _(p,n){const s=n["x-mcp"];if(!s)return[];const i=[];for(const o of M){const c=s[o];if(!c)continue;const m=S(o);for(const e of c)(e.tags?.length?e.tags:[m]).includes(p)&&i.push({entity:e,collectionType:o})}return i}function v({tagName:p,tagSlug:n,result:s,groupItems:i}){const{document:o,options:c,processContent:m,basePath:e}=x.get(),f=_(p,o);for(const{entity:t,collectionType:u}of f){const r=I[u],a=t.title||t.name,h=E(g(t.name).toLowerCase()||t.name.toLowerCase()),l=T(d(n,h)),y=d(n,g(t.name)),P={type:"link",label:a,link:l,routeSlug:l,httpVerb:r,content:m?k(r,t.name,y,a,c):null};s.push(P);const C={title:a,prefix:{name:r,color:r},link:T(b(l,e)),deprecated:!1};i?.[u]?.push(C)}}export{v as addMcpItems};

package/lib/adapters/openapi/items/operation/content.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { OperationInfo } from '../../../../types/openapi.js';
+export declare function buildItemContent(operationInfo: OperationInfo, pageSlug: string): ApiItemContent;

package/lib/adapters/openapi/items/operation/content.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as ee}from"@redocly/config";import{contentType as je,itemVariant as Ne,nodeTypes as u,panelKind as le,schemaKind as H}from"../../../../types/common.js";import{readRbacScope as T,rbacProp as O,registerExample as te,registerSchema as K,resolveContent as pe,resolveRef as D}from"../../../helpers.js";import{applyIgnoreNamedSchemasDeep as Te}from"../../utils/applyIgnoreNamedSchemasDeep.js";import{isStatusCode as Pe}from"../../../../utils/status-code.js";import{parseMarkdown as F}from"../../../utils/parseMarkdown.js";import{extractDescriptionSegments as $e,resolveMarkdocHeadingIds as me}from"../../../utils/markdoc.js";import{getExtensionsForDisplay as ue}from"../../../../utils/extract-extensions.js";import{openApiContext as _}from"../../buildContext.js";import{buildCodeSampleSource as De}from"../../build-code-sample-source.js";import{mergeInMockServer as Be,pickOperationServers as He}from"../../utils/merge-mock-server.js";import{normalizePath as Ke,toRelativePath as Ee}from"../../../../utils/url.js";import{encodeJsonPointerSegment as B}from"../../../../utils/refPointer.js";import{hasOpenApiExampleValue as ge,resolveOpenApiExampleValue as ye}from"../../resolve-openapi-example-value.js";const se="request",ke="responses";function it(e,n){const{options:i,storeCtx:c,basePath:s}=_.get(),t=e.summary||e.operationId||e.pathName||"Unknown Operation",r=[],{feedback:y}=i,d=e.isWebhook||!1,p=[{nodeType:u.HEADER,level:2,label:t,badges:e["x-badges"],isWebhook:d,deprecated:e.deprecated,showPageActions:!0}],o=ue(e,i.showExtensions);Object.keys(o).length>0&&p.push({nodeType:u.EXTENSIONS,extensions:o}),r.push({nodeType:u.CONTAINER,children:p,panels:[]});const m=i.ignoreNamedSchemas,f=e["x-codeSamples"]?.map(({lang:a,label:x,source:h})=>({lang:a,label:x,source:h})),S=He(e.servers,c?.document?.servers),E=Be(S.filter(a=>typeof a?.url=="string"),i.mockServer).map(a=>{const x=T(a);return{url:a.url??"",name:a.name,description:typeof a.description=="string"?a.description:void 0,...a.isMockServer&&{isMockServer:!0},variables:a.variables&&Object.keys(a.variables).length>0?Object.fromEntries(Object.entries(a.variables).map(([h,M])=>[h,{default:M.default}])):void 0,...O(x)}}),b=Oe(e,m),R=Ee(n,s);let l=[];e.description&&(me(e.description,R,se),l=$e(e.description,i));const A=l.some(a=>a.kind==="schemaDefinition"),g=b.find(a=>a.nodeType===u.ITEM&&a.variant==="body"),v=Fe(e,m,d,R||void 0),j=g?.schemaId,q=g?.mediaTypes,N=g?.mediaTypeSchemas,$=T(g),C=[{children:[{kind:le.CODE_SAMPLE,source:v,definitionSamples:f?.length?f:void 0,isWebhook:d,hideReplay:e["x-hideReplay"]===!0,servers:E?.length?E:void 0,schemaId:j,exampleIds:g?.exampleIds,mediaTypes:q,mediaTypeSchemas:N,examples:g?.exampleIds?.map(()=>({}))??[]}],...O($)}];if(b.length>0||l.length>0)if(A){r.push({nodeType:u.CONTAINER,children:[{nodeType:u.HEADER,level:4,label:"Request",labelTranslationKey:"request",deepLinkSuffix:se}],panels:[]});for(const a of l)a.kind==="schemaDefinition"?r.push(a.node):r.push({nodeType:u.CONTAINER,children:[a.node],panels:[]});r.push({nodeType:u.CONTAINER,children:[...b],panels:C})}else r.push({nodeType:u.CONTAINER,children:[{nodeType:u.HEADER,level:4,label:"Request",labelTranslationKey:"request",deepLinkSuffix:se},...l.map(a=>a.node),...b],panels:C});else r.push({nodeType:u.CONTAINER,children:[{nodeType:u.HEADER,level:4,label:"Request",labelTranslationKey:"request",deepLinkSuffix:se},{nodeType:u.EMPTY_MESSAGE,label:"No request data",labelTranslationKey:"noRequestData"}],panels:C});if(e.responses){const a=Re(e,i,R,m);if(a){const x=a.responses?.some(k=>k.schemaId||(k.exampleIds?.length??0)>0),h=a?.responses?.map(k=>{const re=k[ee];return{code:k.code,schemaId:k.schemaId,exampleIds:k.exampleIds,mediaTypes:k.mediaTypes,mediaTypeContent:k.mediaTypeContent,...O(re)}}),M=[];x&&M.push({children:[{kind:le.RESPONSE,headerTitle:"Response",responseCodes:h,examples:[]}]});const U=T(e.responses);r.push({nodeType:u.CONTAINER,children:[{nodeType:u.HEADER,level:4,label:"Responses",labelTranslationKey:"responses",deepLinkSuffix:"responses"},a],panels:M.length>0?M:[],...O(U)})}}if(Array.isArray(e.callbacks)&&e.callbacks.length>0){r.push({nodeType:u.CONTAINER,children:[{nodeType:u.HEADER,level:4,label:"Callbacks",labelTranslationKey:"callbacks",deepLinkSuffix:"callbacks"}],panels:[]});let a=0;for(const x of e.callbacks)if(x.operations)for(const h of x.operations){const M=h.httpVerb??"post",U=`${x.name}/${M}/${a}`,k={pointer:e.pointer+"/callbacks/"+x.name+"/"+M,pathName:h.pathName??x.url??"",httpVerb:M,summary:h.summary,deprecated:h.deprecated,isWebhook:!1,isAdditionalOperation:!1,tags:[],parameters:h.parameters,requestBody:h.requestBody,responses:h.responses,servers:h.servers,security:h.security},re=Oe(k,m),he=Re(k,i,`${R}/callbacks/${U}`,m),oe=[...re];he&&oe.push(he);const ie=h.externalDocs,fe=ue(h,i.showExtensions),Ae={httpVerb:M,pathName:k.pathName,summary:k.summary,operationId:typeof h.operationId=="string"?h.operationId:void 0,description:h.description?F(h.description,i):void 0,deprecated:k.deprecated,callbackName:x.name,callbackId:U,externalDocs:ie?{url:ie.url,description:ie.description}:void 0,extensions:Object.keys(fe).length>0?fe:void 0,contentChildren:oe.length>0?oe:void 0},be=[];if(h.requestBody&&"content"in h.requestBody){const ce=c?.document??{},qe=D(ce,h.requestBody,m)??h.requestBody,ae=pe(ce,qe,m);if(ae){const xe=Object.keys(ae);let X=!1;const de={};for(const[W,P]of Object.entries(ae)){let Q;if(P.schema){const V=P.schema;Q=K(c.schemaStore,c.hashIndex,{kind:H.JSON_SCHEMA,data:V})}const G=`${k.pointer}/requestBody/content/${B(W)}`.replace(/^\//,""),L=[];if(P.example!==void 0){const V=te(c.exampleStore,{value:P.example,id:`${G}/example`});L.push(V),X=!0}if(P.examples)for(const[V,Ie]of Object.entries(P.examples)){const Z=D(ce,Ie,m);if(Z&&ge(Z)){const Me=te(c.exampleStore,{value:ye(Z),summary:Z.summary??V,id:`${G}/examples/${B(V)}`});L.push(Me),X=!0}}de[W]={schemaId:Q,exampleIds:L.length>0?L:void 0},Q&&(X=!0)}const Se=h["x-codeSamples"];if(X||(Se?.length??0)>0){const W=h.servers?.filter(P=>P.url).map(({url:P,name:Q,description:G,variables:L})=>({url:P,name:Q,description:G,variables:L}));be.push({children:[{kind:le.CALLBACK_PAYLOAD,callbackName:U,path:k.pathName,httpVerb:M,servers:W?.length?W:void 0,definitionSamples:Se,mediaTypes:xe.length>0?xe:void 0,mediaTypeSchemas:Object.keys(de).length>0?de:void 0,examples:[]}]})}}}const ve=T(x);r.push({nodeType:u.CONTAINER,children:[{nodeType:u.ITEM,variant:"callback",callback:Ae,pointer:e.pointer+"/callbacks"}],panels:be,...O(ve)}),a++}}y?.hide!==!0&&r.push({nodeType:u.CONTAINER,children:[{nodeType:u.FEEDBACK,pageSlug:Ke(Ee(n,s))}],panels:[]});const w=b.some(a=>{const x=a;return x.variant==="body"&&((x.exampleIds?.length??0)>0||!!x.schemaId)})||(f?.length??0)>0;return{contentType:je.ITEM,itemVariant:Ne.HTTP_ITEM,seo:e["x-seo"],meta:{sourceId:e.operationId,name:t,deprecated:e.deprecated,isWebhook:e.isWebhook||!1,pointer:e.pointer,hasSamples:w},children:r}}function _e(e,n,i){const c=D(n,e,i)??e,{$ref:s,...t}=e,r=typeof s=="string"?{...c,...t}:c;return Te(r,i)}function Y(e,n,i){if(!e||typeof e!="object")return;const c=e,s=D(n,c,i)??c;return Te(s,i)}function we(e,n,i){if(!e||typeof e!="object")return;const c=T(e),s={},t=[];for(const[r,y]of Object.entries(e)){if(r===ee)continue;const d=D(n,y,i)??y,p=d.content,o=p?p[Object.keys(p)[0]]:void 0,m=d.schema??o?.schema??o?.itemSchema,f=Y(m,n,i);if(!f)continue;const S=Ce(d.examples,n,i),E=T(y)??T(d)??c;s[r]={...f,...d.description!==void 0&&{description:d.description},...d.example!==void 0&&{example:d.example},...S&&{examples:S},...O(E)},d.required&&t.push(r)}if(Object.keys(s).length!==0)return{type:"object",properties:s,...t.length>0?{required:t}:{}}}function Le(e){if(typeof e=="string"||e&&typeof e=="object"&&"$$mdtype"in e||Array.isArray(e)&&e.length>0&&e.every(n=>!!n&&typeof n=="object"&&"$$mdtype"in n))return e}function z(e,n){const{storeCtx:i,options:c}=_.get(),s=i.document;return e.map(t=>{const r=t.schema;let y={};if(r&&typeof r=="object")y=r;else if(t.content&&typeof t.content=="object"){const S=t.content,E=Object.keys(S)[0],b=E?S[E]?.schema:void 0;b&&typeof b=="object"&&(y=b)}const d=K(i.schemaStore,i.hashIndex,{kind:H.JSON_SCHEMA,data:y}),p=t["x-badges"],o=y["x-badges"],m=Array.isArray(p)?p:Array.isArray(o)?o:void 0,f=ue(t,c.showExtensions);return{name:String(t.name??""),in:typeof t.in=="string"?t.in:void 0,schemaId:d,description:Le(t.description),required:t.required===!0?!0:void 0,deprecated:t.deprecated===!0?!0:void 0,example:t.example,examples:Ce(t.examples,s,n),...m?.length?{badges:m}:{},...Object.keys(f).length?{extensions:f}:{},...O(T(t))}})}function Ce(e,n,i){if(!e||typeof e!="object")return;const c={};for(const[s,t]of Object.entries(e)){if(!t||typeof t!="object")continue;const r=D(n,t,i)??t;if(!ge(r))continue;const y=ye(r);c[s]={...typeof r.summary=="string"&&{summary:r.summary},...typeof r.description=="string"&&{description:r.description},...y!==void 0&&{value:typeof y=="string"?y:JSON.stringify(y)}}}return Object.keys(c).length>0?c:void 0}function Oe(e,n){const{storeCtx:i,options:c}=_.get(),s=[],t=i.document,r=Ve(e);if(r&&s.push(r),e.parameters&&Array.isArray(e.parameters)){const d=e.parameters.map(l=>_e(l,t,n)),p=d.filter(l=>l.in==="header"),o=d.filter(l=>l.in==="query"),m=d.filter(l=>l.in==="path"),f=d.filter(l=>l.in==="cookie"),S=d.filter(l=>l.in==="querystring"),E=S.filter(l=>!l.content||typeof l.content!="object"),b=S.filter(l=>l.content&&typeof l.content=="object"),R=S.length>0;m.length>0&&s.push({nodeType:u.ITEM,variant:"path",label:"Path",labelTranslationKey:"path",parameters:z(m,n),pointer:e.pointer+"/parameters"}),o.length>0&&!R&&s.push({nodeType:u.ITEM,variant:"query",label:"Query",labelTranslationKey:"query",parameters:z(o,n),pointer:e.pointer+"/parameters"}),E.length>0&&s.push({nodeType:u.ITEM,variant:"querystring",label:"Query String",labelTranslationKey:"querystring",parameters:z(E,n),pointer:e.pointer+"/parameters"});for(const l of b){const A=l.content,g=Object.keys(A),v={};for(const $ of g){const C=A[$];if(!C)continue;let I;const J=C.itemSchema,w=C.schema??J,a=Y(w,t,n);a&&(I=K(i.schemaStore,i.hashIndex,{kind:H.JSON_SCHEMA,data:a}));const x=ne(C,n);v[$]={schemaId:I,exampleIds:x,...O(T(w))}}const j=g[0],q=j?v[j]:void 0,N=F(l.description,c);s.push({nodeType:u.ITEM,variant:"querystring-body",label:String(l.name??""),required:l.required===!0?!0:void 0,mediaTypes:g.length>0?g:void 0,mediaTypeSchemas:Object.keys(v).length>0?v:void 0,schemaId:q?.schemaId,exampleIds:q?.exampleIds,pointer:e.pointer+"/parameters",...N!==void 0?{description:N}:{},...O(T(l))})}f.length>0&&s.push({nodeType:u.ITEM,variant:"cookies",label:"Cookies",labelTranslationKey:"cookie",parameters:z(f,n),pointer:e.pointer+"/parameters"}),p.length>0&&s.push({nodeType:u.ITEM,variant:"headers",label:"Headers",labelTranslationKey:"header",parameters:z(p,n),pointer:e.pointer+"/parameters"})}if(e.requestBody){const y=D(t,e.requestBody,n)??e.requestBody,d=pe(t,y,n),p=d?Object.keys(d):void 0;let o,m,f;if(d&&p){f={};for(const l of p){const A=d[l];if(!A)continue;let g;const v=A.itemSchema,j=A.schema??v,q=Y(j,t,n);q&&(g=K(i.schemaStore,i.hashIndex,{kind:H.JSON_SCHEMA,data:q}));const N=ne(A,n,`${e.pointer}/requestBody/content/${B(l)}`);f[l]={schemaId:g,exampleIds:N,...O(T(j))}}const b=p[0],R=b?f[b]:void 0;o=R?.schemaId,m=R?.exampleIds}const S=F(y.description,c),E=T(e.requestBody)??T(y);s.push({nodeType:u.ITEM,variant:"body",label:"Request Body",labelTranslationKey:"body",required:y.required,mediaTypes:p,mediaTypeSchemas:f,schemaId:o,exampleIds:m,pointer:e.pointer+"/requestBody",...S!==void 0?{description:S}:{},...O(E)})}return s}function Re(e,n,i,c){if(!e.responses)return;const{storeCtx:s}=_.get(),t=s?.document??{},r=e.responses,d=Object.entries(r).filter(([p])=>Pe(p)).map(([p,o])=>{const m=D(t,o,c)??o;let f=T(o)??T(m);const S=pe(t,m,c),E=S?Object.keys(S):[],b=E[0],R=b&&S?S[b]:void 0;let l,A,g,v;if(S&&E.length>0){v={};for(const C of E){const I=S[C];if(!I)continue;let J;const w=I.itemSchema,a=I.schema??w,x=Y(a,t,c);x&&(J=K(s.schemaStore,s.hashIndex,{kind:H.JSON_SCHEMA,data:x}));const h=ne(I,c,`${e.pointer}/responses/${B(p)}/content/${B(C)}`);v[C]={schemaId:J,exampleIds:h,...O(T(a))}}const $=b?v[b]:void 0;l=$?.schemaId,A=$?.exampleIds}else if(R){const $=R.itemSchema,C=R.schema??$,I=Y(C,t,c);I&&(f=f??T(C),l=K(s.schemaStore,s.hashIndex,{kind:H.JSON_SCHEMA,data:I})),A=ne(R,c,b?`${e.pointer}/responses/${B(p)}/content/${B(b)}`:void 0)}const j=we(m.headers,t,c);j&&(g=K(s.schemaStore,s.hashIndex,{kind:H.JSON_SCHEMA,data:j}));let q;m.description&&(q=F(m.description,n),me(q??[],i,`${ke}/${p}`));const N=m["x-summary"]?F(m["x-summary"],n):void 0;return N&&me(N,i,`${ke}/${p}/summary`),{code:p,summary:N,description:q,mediaType:b,mediaTypes:E.length>0?E:void 0,mediaTypeContent:v,schemaId:l,exampleIds:A,headers:m.headers,headerSchemaId:g,...O(f)}});return{nodeType:u.ITEM,variant:"responses",responses:d,pointer:e.pointer+"/responses"}}function ne(e,n,i){const{storeCtx:c}=_.get(),s=[],t=c.document,r=i?.replace(/^\//,"");if(e.example!==void 0){const y=te(c.exampleStore,{value:e.example,...r&&{id:`${r}/example`}});s.push(y)}if(e.examples&&typeof e.examples=="object"){const y=T(e.examples);for(const[d,p]of Object.entries(e.examples)){if(d===ee||!p||typeof p!="object")continue;const o=D(t,p,n)??p,m=T(p)??T(o)??y,f=te(c.exampleStore,{value:ye(o),key:d,summary:typeof o.summary=="string"?o.summary:d,description:typeof o.description=="string"?o.description:void 0,externalValue:typeof o.externalValue=="string"?o.externalValue:void 0,...O(m),...r&&{id:`${r}/examples/${B(d)}`}});s.push(f)}}return s.length>0?s:void 0}function Ve(e){const{storeCtx:n,options:i}=_.get();if(!e.security||!Array.isArray(e.security)||e.security.length===0)return;const c=e.security.map(s=>{const t=Object.entries(s);if(t.length===0)return null;const r=n?.document?.components?.securitySchemes,y=t.map(([d,p])=>{const o=n?.securitySchemeStore[d],m=T(r?.[d])??o?.[ee];return{name:d,scopes:Array.isArray(p)?p:void 0,type:o?.type,scheme:o?.scheme,bearerFormat:o?.bearerFormat,in:o?.in,paramName:o?.paramName,description:o?.description?F(o.description,i):o?.description,openIdConnectUrl:o?.openIdConnectUrl,oauth2MetadataUrl:o?.oauth2MetadataUrl,deprecated:o?.deprecated,flows:o?.flows,...O(m)}}).filter(d=>d.name);return y.length>0?{schemes:y}:null}).filter(s=>s!==null);if(c.length!==0)return{nodeType:u.SECURITY,requirements:c}}function Fe(e,n,i,c){const{storeCtx:s,options:t}=_.get();if(!s)throw new Error("OpenAPI store context is not initialized");return De(e,s,t,n,i,c)}export{it as buildItemContent};

package/lib/adapters/openapi/items/operation/item.d.ts

@@ -0,0 +1,9 @@
+import { REDOCLY_TEAMS_RBAC } from '@redocly/config';
+import type { ApiItem } from '../../../../types/store.js';
+import type { OperationInfo } from '../../../../types/openapi.js';
+export declare function addOperationItems({ operations, result, basePath: basePathOverride, parentRbac, }: {
+    operations: OperationInfo[];
+    result: ApiItem[];
+    basePath?: string;
+    parentRbac?: OperationInfo[typeof REDOCLY_TEAMS_RBAC];
+}): void;

package/lib/adapters/openapi/items/operation/item.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as h}from"@redocly/config";import{WEBHOOKS_GROUP_TITLE as k}from"../../../../constants/openapi.js";import{buildItemContent as v}from"./content.js";import{getOperationData as y}from"../../utils/operation.js";import{resolveRequestValues as R,applyRequestValuesToOperationInfo as C}from"../../configure/index.js";import{openApiContext as d}from"../../buildContext.js";import{mergeInMockServer as I,pickOperationServers as S}from"../../utils/merge-mock-server.js";function j({operations:t,result:o,basePath:n,parentRbac:s}){const{basePath:r}=d.get(),e=n??r,{regular:c,regularDeprecated:u,webhooks:p,webhooksDeprecated:a}=D(t);for(const i of[...c,...u])O(i,e,o,s);const f=p.length>0||a.length>0,m=c.length>0||u.length>0;f&&m&&o.push({type:"separator",label:k,variant:"secondary",content:null});for(const i of[...p,...a])O(i,e,o,s)}function D(t){const o=[],n=[],s=[],r=[];for(const e of t)e.isWebhook?(e.deprecated?r:s).push(e):(e.deprecated?n:o).push(e);return{regular:o,regularDeprecated:n,webhooks:s,webhooksDeprecated:r}}function O(t,o,n,s){const{document:r,options:e,processContent:c}=d.get(),u=S(t.servers,r.servers),p=I(u.filter(l=>typeof l?.url=="string"),e.mockServer);if(c){const l=R({operationInfo:t,info:r.info??{},servers:p,basePath:o,userClaims:e.userClaims,dynamicRequestValues:e.dynamicRequestValues});l&&Object.keys(l).length>0&&C(t,l,p)}const{slug:a,badges:f,httpPath:m,seo:i,...b}=y(t,o),g={...b,type:"link",link:a,routeSlug:a,metadata:{...i?{seo:i}:{}},[h]:t[h]??s,content:c?v(t,a):null};f&&Object.assign(g,{badges:f}),m&&Object.assign(g,{httpPath:m}),n.push(g)}export{j as addOperationItems};

package/lib/adapters/openapi/items/overview/content.d.ts

@@ -0,0 +1,18 @@
+import type { Node } from '@markdoc/markdoc';
+import type { ContentNode, ApiItemContent } from '../../../../types/content.js';
+import type { OpenAPIDefinition } from '../../../../types/openapi.js';
+import type { ApiDocsOptions, NormalizedDownloadUrl } from '../../../../types/options.js';
+type OverviewContentOptions = {
+    downloadUrls?: NormalizedDownloadUrl[];
+    basePath: string;
+    unstable_hooks: ApiDocsOptions['unstable_hooks'];
+    sanitize: ApiDocsOptions['sanitize'];
+    markdownParser: ApiDocsOptions['markdownParser'];
+} & Partial<ApiDocsOptions>;
+export declare function buildOverviewContent({ document, description, sectionChildren, options, }: {
+    document: OpenAPIDefinition;
+    description: string | Node[] | undefined;
+    sectionChildren: ContentNode[];
+    options: OverviewContentOptions;
+}): ApiItemContent;
+export {};

package/lib/adapters/openapi/items/overview/content.js

@@ -0,0 +1 @@
+import{contentType as A,nodeTypes as n}from"../../../../types/common.js";import{asString as S}from"../../../../utils/string.js";import{parseMarkdown as l}from"../../../utils/parseMarkdown.js";import{buildDownloadPanelContent as M}from"../../panels/download.js";import{buildInfoMetadataContentNode as N}from"../../../utils/infoMetadata.js";import{buildOverviewPanelContent as x}from"../../panels/overview.js";import{buildLanguagesPanelContent as V}from"../../panels/languages.js";import{buildMcpPanelContent as W}from"../../panels/mcp.js";import{buildServersPanelContent as _}from"../../panels/servers.js";import{mergeInMockServer as k}from"../../utils/merge-mock-server.js";function G({document:i,description:T,sectionChildren:g,options:o}){const{downloadUrls:p,hideDownloadButtons:y,hideInfoMetadata:D,basePath:m}=o,u=o.codeSamples?.languages??[],e=i.info,f=e?.["x-seo"],c=S(f?.title)??S(e?.title)??"API Documentation",I=e?.version?`${c} (${e.version})`:c,t=[];!y&&p&&t.push(M(p)),t.push(x(e)),u.length&&t.push(V(u));const h=W(i);h&&t.push(h);const O=k(i.servers??[],o.mockServer).map(r=>({...r,description:typeof r.description=="string"?r.description:void 0})),v=_(O);v&&t.push(v);const s={nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.HEADER,level:1,label:I,showPageActions:!0}],sectionId:m},C=l(e.summary,o);C&&s.children.push({nodeType:n.MARKDOC,content:C});const E=l(T,o);E&&s.children.push({nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.MARKDOC,content:E}],sectionId:m});const R=o,a=i.externalDocs||e?.externalDocs;if(a?.url){const r=l(a.description,R)??[];s.children.push({nodeType:n.EXTERNAL_DOCS,url:a.url,description:r})}const P=N(e,D),d=[s];P&&d.push(P),d.push(...g);const b={nodeType:n.CONTAINER,panels:t,children:d},w={name:c};return{contentType:A.OVERVIEW,seo:f,meta:w,children:[b]}}export{G as buildOverviewContent};

package/lib/adapters/openapi/items/overview/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { OpenAPIDefinition } from '../../../../types/openapi.js';
+export declare function buildOverviewItems(document: OpenAPIDefinition): ApiItem[];

package/lib/adapters/openapi/items/overview/item.js

@@ -0,0 +1 @@
+import{extractContentUntilFirstHeading as c,collectMarkdownSections as a}from"../../../utils/markdoc.js";import{buildOverviewContent as f}from"./content.js";import{openApiContext as v}from"../../buildContext.js";import{asString as r}from"../../../../utils/string.js";function C(t){const o=v.get(),{basePath:i}=o,s=c(t.info?.description,o.options),{sectionItems:l,sectionChildren:p}=a(t.info?.description,i,o.options),e=f({document:t,description:s,sectionChildren:p,options:{...o.options,basePath:i}}),n=r(e?.seo?.title)??r(t.info?.title);return[{type:"link",label:n||"Overview",labelTranslationKey:n?void 0:"openapi.info.title",link:i,routeSlug:i,content:e},...l]}export{C as buildOverviewItems};

package/lib/adapters/openapi/items/schema/content.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildSchemaDefinitionContent(schemaName: string, title: string | undefined, options: ApiDocsOptions): ApiItemContent;

package/lib/adapters/openapi/items/schema/content.js

@@ -0,0 +1 @@
+import{contentType as c,itemVariant as p,nodeTypes as n}from"../../../../types/common.js";import{parseMarkdown as a}from"../../../utils/parseMarkdown.js";function d(e,r,s){const t=r??e,o=a(`{% schemaDefinition showWriteOnly=true schemaRef="#/components/schemas/${e}" /%}`,s),i=[{nodeType:n.CONTAINER,children:[{nodeType:n.HEADER,level:2,label:t,showPageActions:!0}],panels:[]}];return o&&i.push({nodeType:n.MARKDOC,content:o}),{contentType:c.ITEM,itemVariant:p.SCHEMA,meta:{name:e},seo:{title:t},children:i}}export{d as buildSchemaDefinitionContent};

package/lib/adapters/openapi/items/schema/item.d.ts

@@ -0,0 +1,9 @@
+import type { ApiItem, GroupItem } from '../../../../types/store.js';
+import type { OpenAPIDefinition } from '../../../../types/openapi.js';
+export declare function getSchemaNamesForTag(tagName: string, document: OpenAPIDefinition, schemaDefinitionsTagName: string | undefined): string[];
+export declare function addSchemaDefinitionItems({ tagName, tagSlug, result, groupItems, }: {
+    tagName: string;
+    tagSlug: string;
+    result: ApiItem[];
+    groupItems?: GroupItem[];
+}): void;

package/lib/adapters/openapi/items/schema/item.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as T}from"@redocly/config";import{encodeBackSlashes as x,safeSlugify as R}from"../../../../utils/string.js";import{joinWithSeparator as k,normalizePath as g,toRelativePath as w}from"../../../../utils/url.js";import{readRbacScope as S,rbacProp as d}from"../../../helpers.js";import{buildSchemaDefinitionContent as N}from"./content.js";import{openApiContext as P}from"../../buildContext.js";function A(r,i,a){const c=i.components?.schemas;if(!c)return[];const o=a?[a]:[],s=[];for(const[e,n]of Object.entries(c)){if(e===T)continue;const m=n["x-tags"];(m?.length?m:o).includes(r)&&s.push(e)}return s.sort((e,n)=>e.localeCompare(n))}function O({tagName:r,tagSlug:i,result:a,groupItems:c}){const{document:o,options:s,processContent:e,basePath:n}=P.get(),l=A(r,o,s.schemaDefinitionsTagName),m=S(o.components?.schemas);for(const t of l){const f=o.components?.schemas?.[t],h=f?.title??t,b=x(R(t).toLowerCase()||t.toLowerCase()),p=g(k(i,b)),u=S(f)??m,C={type:"link",label:h,link:p,routeSlug:p,httpVerb:"schema",content:e?N(t,h,s):null,...d(u)};a.push(C),c?.push({title:h,link:g(w(p,n)),deprecated:!1,...d(u)})}}export{O as addSchemaDefinitionItems,A as getSchemaNamesForTag};

package/lib/adapters/openapi/panels/download.d.ts

@@ -0,0 +1,3 @@
+import type { DownloadNode } from '../../../types/content.js';
+import type { NormalizedDownloadUrl } from '../../../types/options.js';
+export declare function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode;

package/lib/adapters/openapi/panels/download.js

@@ -0,0 +1 @@
+import{panelKind as e}from"../../../types/common.js";function l(n){return{title:"Download OpenAPI description",titleTranslationKey:"download.description.title",children:n.map(t=>({kind:e.DOWNLOAD,label:t.title||t.url,url:t.url}))}}export{l as buildDownloadPanelContent};

package/lib/adapters/openapi/panels/languages.d.ts

@@ -0,0 +1,3 @@
+import type { LanguagesNode } from '../../../types/content.js';
+import type { CodeSamplesConfig } from '../../../types/options.js';
+export declare function buildLanguagesPanelContent(languages: CodeSamplesConfig['languages']): LanguagesNode;

package/lib/adapters/openapi/panels/languages.js

@@ -0,0 +1 @@
+import{panelKind as e}from"../../../types/common.js";function l(t){return{title:"Languages",titleTranslationKey:"languages.title",children:[{kind:e.LANGUAGES,options:t.map(n=>({key:n.key,title:n.label,lang:n.lang}))}]}}export{l as buildLanguagesPanelContent};

package/lib/adapters/openapi/panels/mcp.d.ts

@@ -0,0 +1,3 @@
+import type { McpNode } from '../../../types/content.js';
+import type { OpenAPIDefinition } from '../../../types/openapi.js';
+export declare function buildMcpPanelContent(document: OpenAPIDefinition): McpNode | null;

package/lib/adapters/openapi/panels/mcp.js

@@ -0,0 +1 @@
+import{panelKind as i}from"../../../types/common.js";import{MCP_SERVER_EXPERIMENTAL_CAPABILITIES as a,PAGE_ACTIONS_MCP as p}from"../constants.js";function u(o){const t=o?.["x-mcp"];if(!t)return null;const n=(t?.servers??o.servers??[])[0]?.url??"",e=[];if(t?.protocolVersion&&e.push({kind:i.ATTRIBUTE,label:"Protocol version",labelTranslationKey:"mcp.protocolVersion",value:t?.protocolVersion??"",withCopyButton:!0,copyContent:t?.protocolVersion??""}),t?.capabilities&&typeof t.capabilities=="object"){const r=Object.keys(t.capabilities).filter(l=>l!==a).map(l=>({text:l,color:"green",icon:"checkmark"}));r.length>0&&e.push({kind:i.TAGS,title:"Capabilities",titleTranslationKey:"mcp.capabilities",tags:r})}return t?.capabilities?.[a]&&e.push({kind:i.ATTRIBUTE,title:"Experimental capabilities",titleTranslationKey:"mcp.experimentalCapabilities",label:"Value",labelTranslationKey:"value",value:JSON.stringify(t.capabilities.experimental),withCopyButton:!0,copyContent:JSON.stringify(t.capabilities.experimental)}),e.push({kind:i.EXTERNAL_LINK,title:"Endpoint",titleTranslationKey:"mcp.endpoint",label:n,url:n,withCopyButton:!0,copyContent:n}),e.push({kind:i.CONNECT_MCP_BUTTON,title:"Connect",actions:p,mcpUrl:n}),{title:"MCP server",titleTranslationKey:"mcp.title",children:e}}export{u as buildMcpPanelContent};

package/lib/adapters/openapi/panels/overview.d.ts

@@ -0,0 +1,3 @@
+import type { OverviewNode } from '../../../types/content.js';
+import type { OpenAPIInfo } from '../../../types/openapi.js';
+export declare function buildOverviewPanelContent(info: OpenAPIInfo | undefined): OverviewNode;

package/lib/adapters/openapi/panels/overview.js

@@ -0,0 +1 @@
+import{panelKind as l}from"../../../types/common.js";function n(e){const t=[];return e?.contact?.url&&t.push({kind:l.EXTERNAL_LINK,title:"URL",titleTranslationKey:"info.contact.url",label:e.contact.url,url:e.contact.url}),e?.contact?.email&&t.push({kind:l.EMAIL,title:e.contact.name||"E-mail",titleTranslationKey:e.contact.name?void 0:"info.contact.name",email:e.contact.email,label:e.contact.email,withCopyButton:!0,copyContent:e.contact.email}),e?.license?.url&&(e.license.identifier||e.license.name)&&t.push({kind:l.EXTERNAL_LINK,title:"License",titleTranslationKey:"info.license",label:e.license.identifier||e.license.name||"",url:e.license.url}),!e?.license?.url&&(e?.license?.identifier||e?.license?.name)&&t.push({kind:l.ATTRIBUTE,title:"License",titleTranslationKey:"info.license",label:e.license?.identifier||e.license?.name||"License",value:e.license?.identifier||e.license?.name||"License"}),e?.termsOfService&&t.push({kind:l.EXTERNAL_LINK,label:"Terms of Service",labelTranslationKey:"info.termsOfService",url:e.termsOfService}),{title:"Overview",titleTranslationKey:"info.title",children:t}}export{n as buildOverviewPanelContent};

package/lib/adapters/openapi/panels/servers.d.ts

@@ -0,0 +1,3 @@
+import type { ServerData } from '../../../types/common.js';
+import type { ServersNode } from '../../../types/content.js';
+export declare function buildServersPanelContent(servers: ServerData[]): ServersNode | null;

package/lib/adapters/openapi/panels/servers.js

@@ -0,0 +1 @@
+import{panelKind as t}from"../../../types/common.js";function l(e){return!e||e.length===0?null:{title:"Servers",titleTranslationKey:"servers.title",children:[{kind:t.SERVERS,servers:e,mode:"default"}]}}export{l as buildServersPanelContent};

package/lib/adapters/openapi/resolve-openapi-example-value.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIExample } from '../../types/openapi.js';
+export declare function resolveOpenApiExampleValue(example: OpenAPIExample | undefined): unknown;
+export declare function hasOpenApiExampleValue(example: OpenAPIExample | undefined): boolean;

package/lib/adapters/openapi/resolve-openapi-example-value.js

@@ -0,0 +1 @@
+function n(e){if(e)return e.dataValue!==void 0?e.dataValue:e.serializedValue!==void 0?e.serializedValue:e.value}function u(e){return e?e.dataValue!==void 0||e.serializedValue!==void 0||e.value!==void 0:!1}export{u as hasOpenApiExampleValue,n as resolveOpenApiExampleValue};

package/lib/adapters/openapi/store.d.ts

@@ -0,0 +1,4 @@
+import type { ApiStore, StoreContext } from '../../types/store.js';
+import type { OpenAPIDefinition } from '../../types/openapi.js';
+import type { ApiDocsOptions } from '../../types/options.js';
+export declare function populateOpenApiStore(document: OpenAPIDefinition, storeCtx: StoreContext, options: ApiDocsOptions): ApiStore;

package/lib/adapters/openapi/store.js

@@ -0,0 +1 @@
+import{schemaKind as w}from"../../types/common.js";import{registerSchema as v,registerExample as E,registerSecurityScheme as V,resolveRef as S,isRecord as y,readRbacScope as l,rbacProp as b,splitRbacSection as g}from"../helpers.js";import{applyIgnoreNamedSchemasDeep as k}from"./utils/applyIgnoreNamedSchemasDeep.js";import{parseMarkdown as A}from"../utils/parseMarkdown.js";import{resolveOpenApiExampleValue as C}from"./resolve-openapi-example-value.js";const I=["x-defaultClientId","x-defaultAccessToken","x-defaultTokenType","x-defaultClientSecret","x-defaultUsername","x-defaultPassword"];function M(d){const c={},r=d;for(const n of I)r[n]&&(c[n]=r[n]);return r["x-serverValues"]&&(c.serverValues=r["x-serverValues"]),c}function j(d,c,r){const{schemaStore:n,exampleStore:f,securitySchemeStore:u,hashIndex:R}=c,{ignoreNamedSchemas:p}=r,x=c.document,a=d.components,h=d["x-root"];if(y(h)){const s=k(h,p),o=y(s)?s:h;v(n,R,{id:"x-root",kind:w.JSON_SCHEMA,title:typeof o.title=="string"?o.title:"Root",data:o})}if(!a)return{schemaStore:n,exampleStore:f,securitySchemeStore:u};if(a.schemas){const{sectionRbac:s,entries:o}=g(a.schemas);for(const[i,t]of o){const e=S(x,t,p)??t,m=k(e,p);y(m)&&v(n,R,{id:`components/schemas/${i}`,kind:w.JSON_SCHEMA,title:typeof m.title=="string"?m.title:i,data:m,...b(s)})}}if(a.examples){const{sectionRbac:s,entries:o}=g(a.examples);for(const[i,t]of o){const e=S(x,t,p)??t;!e||typeof e!="object"||E(f,{id:`components/examples/${i}`,value:C(e),summary:typeof e.summary=="string"?e.summary:void 0,description:typeof e.description=="string"?e.description:void 0,externalValue:e.externalValue,...b(l(t)??l(e)??s)})}}if(a.securitySchemes){const{sectionRbac:s,entries:o}=g(a.securitySchemes);for(const[i,t]of o){if(!t||typeof t!="object")continue;const e=S(x,t,p)??t;if(!e)continue;const m={id:i,type:e.type,scheme:e.scheme,bearerFormat:e.bearerFormat,description:e.description?A(e.description,r):void 0,in:e.in,paramName:e.name,openIdConnectUrl:e.openIdConnectUrl,oauth2MetadataUrl:e.oauth2MetadataUrl,deprecated:e.deprecated,flows:e.flows,...M(e),...b(l(t)??l(e)??s)};V(u,m)}}return{schemaStore:n,exampleStore:f,securitySchemeStore:u}}export{j as populateOpenApiStore};

package/lib/adapters/openapi/utils/JsonPointer.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Wrapper for JsonPointer. Provides common operations
+ */
+export declare class JsonPointer {
+    /**
+     * returns last JsonPointer token
+     * if level > 1 returns levels last (second last/third last)
+     * @example
+     * // returns subpath
+     * JsonPointerHelper.baseName('/path/0/subpath')
+     * // returns foo
+     * JsonPointerHelper.baseName('/path/foo/subpath', 2)
+     */
+    static baseName(pointer?: string, level?: number): string;
+    /**
+     * returns dirname of pointer
+     * if level > 1 returns corresponding dirname in the hierarchy
+     * @example
+     * // returns /path/0
+     * JsonPointerHelper.dirName('/path/0/subpath')
+     * // returns /path
+     * JsonPointerHelper.dirName('/path/foo/subpath', 2)
+     */
+    static dirName(pointer: string, level?: number): string;
+    /**
+     * returns relative path tokens
+     * @example
+     * // returns ['subpath']
+     * JsonPointerHelper.relative('/path/0', '/path/0/subpath')
+     * // returns ['foo', 'subpath']
+     * JsonPointerHelper.relative('/path', '/path/foo/subpath')
+     */
+    static relative(from: string, to: string): string[];
+    /**
+     * overridden JsonPointer original parse to take care of prefixing '#' symbol
+     * that is not valid JsonPointer
+     */
+    static parse(pointer?: string): string[];
+    /**
+     * Creates a JSON pointer path, by joining one or more tokens to a base path.
+     *
+     * @param {string} base - The base path
+     * @param {string|string[]} tokens - The token(s) to append (e.g. ["name", "first"])
+     * @returns {string}
+     */
+    static join(base: string, tokens: string | string[]): string;
+    static get<T>(object: GenericObject, pointer: string): T;
+    static compile(tokens: string[]): string;
+    static escape(pointer: string): string;
+}
+export default JsonPointer;

package/lib/adapters/openapi/utils/JsonPointer.js

@@ -0,0 +1 @@
+import a from"json-pointer";const n=a.parse;class s{static baseName(e="",t=1){const r=s.parse(e);return r[r.length-t]}static dirName(e,t=1){const r=s.parse(e);return a.compile(r.slice(0,r.length-t))}static relative(e,t){const r=s.parse(e);return s.parse(t).slice(r.length)}static parse(e=""){let t=e;return t.charAt(0)==="#"&&(t=t.substring(1)),n(t)}static join(e,t){const c=s.parse(e).concat(t);return a.compile(c)}static get(e,t){return a.get(e,t)}static compile(e){return a.compile(e)}static escape(e){return a.escape(e)}}a.parse=s.parse,Object.assign(s,a);var i=s;export{s as JsonPointer,i as default};

package/lib/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts

@@ -0,0 +1 @@
+export declare function applyIgnoreNamedSchemasDeep(value: unknown, ignoreNamedSchemas?: Set<string>): unknown;

package/lib/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.js

@@ -0,0 +1 @@
+import{isRecord as p}from"../../helpers.js";import{getDefinitionName as e}from"./helpers.js";function o(r,f){if(!f||f.size===0)return r;if(Array.isArray(r))return r.map(t=>o(t,f));if(!p(r))return r;if(typeof r.$ref=="string"){const t=e(r.$ref);return t&&f.has(t)?{type:"object",title:t}:r}const i={};for(const[t,n]of Object.entries(r))i[t]=o(n,f);return i}export{o as applyIgnoreNamedSchemasDeep};

package/lib/adapters/openapi/utils/helpers.d.ts

@@ -0,0 +1,14 @@
+export declare function stripTrailingSlash(path: string): string;
+export declare function isNumeric(value: unknown): value is number;
+export declare function isAbsoluteUrl(url: string): boolean;
+/**
+ * simple resolve URL which doesn't break on strings with url fragments
+ * e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
+ */
+export declare function resolveUrl(url: string, to: string): string;
+export declare function titleize(text: string): string;
+export declare function removeQueryStringAndHash(serverUrl: string): string;
+export declare function escapeHTMLAttrChars(str: string): string;
+export declare function sanitizeItemId(id: string): string;
+export declare function get<T = unknown>(object: GenericObject | undefined, path: string | Array<string>, defval?: T): T | unknown;
+export declare function getDefinitionName(pointer?: string): string | undefined;

package/lib/adapters/openapi/utils/helpers.js

@@ -0,0 +1 @@
+import{urlParse as s}from"./url.js";function o(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function a(e){return!isNaN(parseFloat(e))&&isFinite(e)}function c(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}function f(e,t){let r;if(t.startsWith("//"))r=`${s(e,!0)?.protocol||"https:"}${t}`;else if(c(t))r=t;else if(!t.startsWith("/"))r=o(e)+"/"+t;else{const n=s(e);n?(n.pathname=t,r=n.toString()):r=t}return o(r)}function l(e){return e.charAt(0).toUpperCase()+e.slice(1)}function g(e){try{if(!e)return"";const t=new URL(e);return t.search="",t.hash="",t.toString()}catch{return e}}function h(e){return e.replace(/["\\]/g,"\\$&")}function m(e){return e&&e.replace(/#/g,"_").toLowerCase()}function N(e={},t,r){return typeof t=="string"&&(t=t.split(".")),t.reduce((n,i)=>n&&typeof n=="object"&&i in n?n[i]:r,e)}const u=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function I(e){return e?.match(u)?.pop()}export{h as escapeHTMLAttrChars,N as get,I as getDefinitionName,c as isAbsoluteUrl,a as isNumeric,g as removeQueryStringAndHash,f as resolveUrl,m as sanitizeItemId,o as stripTrailingSlash,l as titleize};

package/lib/adapters/openapi/utils/merge-mock-server.d.ts

@@ -0,0 +1,15 @@
+import type { OpenAPIServer } from '../../../types/openapi.js';
+export type MockServerOptions = {
+    url?: string;
+    position?: 'first' | 'last' | 'replace' | 'off';
+    description?: string;
+} | null | undefined;
+export declare function mergeInMockServer(servers: OpenAPIServer[], mockServerOptions: MockServerOptions): OpenAPIServer[];
+/** Operation servers win when non-empty; an empty array falls through to the
+ *  document servers (see the empty-array test — a `??` fallback would not). */
+export declare function pickOperationServers<T>(operationServers: T[] | undefined, documentServers: T[] | undefined): T[];
+/** Strips servers injected by {@link mergeInMockServer}. Returns the same
+ *  reference when nothing is flagged. */
+export declare function excludeMockServers<T extends {
+    isMockServer?: boolean;
+}>(servers: T[]): T[];

package/lib/adapters/openapi/utils/merge-mock-server.js

@@ -0,0 +1 @@
+function c(r,t){if(!t?.url)return r;const e={url:t.url,description:t.description,isMockServer:!0};switch(t.position){case"first":return[e,...r];case"last":return[...r,e];case"replace":return[e];default:return r}}function u(r,t){return r&&r.length>0?r:t??[]}function n(r){return r.some(t=>t.isMockServer)?r.filter(t=>!t.isMockServer):r}export{n as excludeMockServers,c as mergeInMockServer,u as pickOperationServers};

package/lib/adapters/openapi/utils/operation.d.ts

@@ -0,0 +1,23 @@
+import type { OperationInfo, OpenAPIXBadges } from '../../../types/openapi.js';
+import type { SeoData } from '../../../types/common.js';
+import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
+type OperationData = {
+    slug: string;
+    label: string;
+    badges?: OpenAPIXBadges[];
+    deprecated: boolean;
+    isAdditionalOperation?: boolean;
+    httpVerb: string;
+    httpPath: string;
+    isWebhook: boolean;
+    seo?: SeoData;
+};
+export declare function getOperationData(operation: OperationInfo, basePath: string): OperationData;
+export declare function getOperationSummary(operation: OperationInfo, markdownOptions: ParseMarkdownOptions): string | undefined;
+type OperationColorProps = {
+    deprecated?: boolean;
+    isAdditionalOperation?: boolean;
+    httpVerb: string;
+};
+export declare function getOperationColor({ deprecated, isAdditionalOperation, httpVerb, }: OperationColorProps): string;
+export {};

package/lib/adapters/openapi/utils/operation.js

@@ -0,0 +1 @@
+import{DEFAULT_TAG_SLUG as p}from"../../../constants/openapi.js";import{asString as s,encodeBackSlashes as i}from"../../../utils/string.js";import{extractSeoDescriptionText as u,extractSummaryText as f}from"../../utils/markdoc.js";import{normalizePath as h,joinWithSeparator as m}from"../../../utils/url.js";import{resolveItemSeo as g}from"../../utils/seo.js";import{sanitizeItemId as I}from"./helpers.js";function A(t,r){const e=t.tags?.length===1&&t.tags[0]==="",n=(t.operationId?e?m(p,i(t.operationId)):i(t.operationId):I(x(t.pointer)))||`${t.httpVerb}${i(t.pathName)}`,c=h(m(r,n.toLowerCase())),o=s(t.summary)??s(t.operationId)??s(t.pathName)??"Unknown Operation",l=g(t,{title:o,description:u(t.description)??s(t.summary)}),d={slug:c,label:o,deprecated:t.deprecated??!1,httpVerb:t.httpVerb,httpPath:t.pathName,isAdditionalOperation:t.isAdditionalOperation??!1,isWebhook:t.isWebhook??!1,seo:l};return t?.["x-badges"]&&(d.badges=t["x-badges"]),d}function U(t,r){const{operationId:e,summary:a}=t;return a||e||f(t.description,r)}function W({deprecated:t,isAdditionalOperation:r,httpVerb:e}){return t?"http-deprecated":r?"http-additional-operation":e}function x(t){return t?t.startsWith("/")?t.slice(1):t:""}export{W as getOperationColor,A as getOperationData,U as getOperationSummary};

package/lib/adapters/openapi/utils/resolvePathItemRef.d.ts

@@ -0,0 +1,2 @@
+import type { OpenAPIPath } from '../../../types/openapi.js';
+export declare function resolvePathItemRef(document: Record<string, unknown>, pathItem: OpenAPIPath | undefined | null, openapi?: string): OpenAPIPath | undefined;

package/lib/adapters/openapi/utils/resolvePathItemRef.js

@@ -0,0 +1 @@
+import{resolveJsonPointer as u}from"../../helpers.js";function g(r){return String(r??"").startsWith("3.1")}function p(r,e,o){if(!e||typeof e!="object")return;if(typeof e.$ref!="string")return e;const i=g(o);return c(r,e,i,[])}function c(r,e,o,i){const t=e.$ref;if(typeof t!="string")return e;if(i.includes(t)){const s=u(r,t);return{...s?{...s}:{},"x-circular-ref":!0}}const f=u(r,t);if(!f)throw new Error(`Failed to resolve $ref "${t}" for path item`);let n;if(typeof f.$ref=="string"?n=c(r,f,o,[...i,t]):n={...f},o){const{$ref:s,...l}=e;Object.keys(l).length>0&&(n={...n,...l})}return n}export{p as resolvePathItemRef};

package/lib/adapters/openapi/utils/url.d.ts

@@ -0,0 +1,2 @@
+export declare function urlParse(url: string, slashesDenoteHost?: boolean): URL | null;
+export declare function getUrlDirname(urlLikeString: string): string | undefined;

package/lib/adapters/openapi/utils/url.js

@@ -0,0 +1 @@
+function s(t,e=!1){let r=t;e&&r.startsWith("//")&&(r="http:"+t);try{return URL?.parse?URL?.parse(r):new URL(r)}catch(n){return console.error("Invalid URL: %s",r,n),null}}function o(t){try{const e=new URL(t);let r=e.pathname;if(r.endsWith("/"))return e.origin+r;const n=r.lastIndexOf("/");return n!==-1?(r=r.substring(0,n+1),e.origin+r):e.origin+"/"}catch(e){console.error(`Invalid URL: ${t}`,e);return}}export{o as getUrlDirname,s as urlParse};

package/lib/adapters/rbac-schema-propagation.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem, ApiStore } from '../types/store.js';
+export declare function propagateRbacToReferencedEntries(items: ApiItem[], store: Pick<ApiStore, 'schemaStore' | 'exampleStore'>): void;

package/lib/adapters/rbac-schema-propagation.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as p}from"@redocly/config";import{readRbacScope as g,stableStringify as h}from"./helpers.js";function R(r){return!!r&&typeof r=="object"&&!Array.isArray(r)}function b(r){return r==="schemaId"||r.endsWith("SchemaId")}function E(r,d){const{schemaStore:m,exampleStore:y}=d,f=new Map,u=new Map,l=new Map,A=(n,c,e,o)=>{const t=c[e];if(!t||t[p])return;const s=o??"open",i=n.get(e);n.set(e,i===void 0||i===s?s:"open")},a=(n,c)=>{if(Array.isArray(n)){for(const t of n)a(t,c);return}if(!R(n))return;let e=c;const o=g(n);o&&(e=h(o),f.has(e)||f.set(e,o));for(const[t,s]of Object.entries(n))if(t!==p)if(typeof s=="string"&&b(t))A(u,m,s,e);else if(t==="exampleIds"&&Array.isArray(s))for(const i of s)typeof i=="string"&&A(l,y,i,e);else a(s,e)};a(r,null);const S=(n,c)=>{for(const[e,o]of n){if(o==="open")continue;const t=f.get(o);t&&(c[e][p]=t)}};S(u,m),S(l,y)}export{E as propagateRbacToReferencedEntries};

package/lib/adapters/scopedContext.d.ts

@@ -0,0 +1,5 @@
+export type ScopedContext<T> = {
+    run<R>(ctx: T, fn: () => R): R;
+    get(): T;
+};
+export declare function createScopedContext<T>(name: string): ScopedContext<T>;

package/lib/adapters/scopedContext.js

@@ -0,0 +1 @@
+function u(r){let t=null;return{run(e,n){const o=t;t=e;try{return n()}finally{t=o}},get(){if(!t)throw new Error(`${r} context is not available outside of a build`);return t}}}export{u as createScopedContext};