@redocly/api-docs 0.2.0-next.5 → 0.2.0-next.7

package/lib/services/spec-slice/asyncapi-slice.js

@@ -0,0 +1 @@
+import{isRecord as i,resolveJsonPointer as O}from"../../adapters/helpers.js";import{collectComponentClosure as C,buildComponentsFromClosure as b}from"./component-closure.js";import{cloneStrip as I}from"./clone-strip.js";import{parsePointerTokens as h}from"./openapi-slice.js";function A(n){return typeof n.asyncapi=="string"&&n.asyncapi.startsWith("3.")}const v=["asyncapi","id","info","defaultContentType","servers"];function x(n){const e=h(n);if(!(e.length<2)){if(e[0]==="channels")return{kind:"channel",channelId:e[1]};if(e[0]==="operations")return{kind:"async-operation",operationId:e[1]}}}function F(n,e){if(!A(n))return;if(e.kind==="document")return{document:I(n,new Map)};const t=S(n,e);if(!t)return;const{keptChannels:p,keptOperations:f}=t,s={};for(const o of v)n[o]!==void 0&&(s[o]=n[o]);const u=i(n.channels)?n.channels:{},a=i(n.operations)?n.operations:{},r={};for(const[o,d]of Object.entries(u))p.has(o)&&(r[o]=d);const c={};for(const[o,d]of Object.entries(a))f.has(o)&&(c[o]=d);s.channels=r,Object.keys(c).length&&(s.operations=c);const l=C(n,[s],o=>{if(o.startsWith("#/servers/"))return n.servers!==void 0;const d=h(o);return d[0]==="channels"?p.has(d[1]):d[0]==="operations"?f.has(d[1]):!1}),y=b(n,l.keep);return y&&(s.components=y),{document:I(s,l.inlineTargets)}}function g(n){if(!i(n)||!i(n.channel))return;const e=n.channel.$ref;if(typeof e!="string")return;const t=h(e);return t[0]==="channels"&&t.length>=2?t[1]:void 0}function R(n,e){return!i(n)||!Array.isArray(n.tags)?!1:n.tags.some(t=>i(t)&&t.name===e)}function S(n,e){const t=i(n.channels)?n.channels:{},p=i(n.operations)?n.operations:{},f=new Set,s=new Set,u=a=>{for(const[r,c]of Object.entries(p))g(c)===a&&s.add(r)};switch(e.kind){case"channel":{if(!(e.channelId in t))return;f.add(e.channelId),u(e.channelId);break}case"async-operation":{const a=p[e.operationId];if(!i(a))return;s.add(e.operationId);const r=g(a);r&&r in t&&f.add(r);break}case"tag":{for(const[a,r]of Object.entries(t))R(r,e.tagName)&&(f.add(a),u(a));if(f.size===0)return;break}default:return}for(const a of s){const r=p[a];if(!i(r))continue;const c=T(n,r.reply),k=i(c?.channel)?c.channel.$ref:void 0;if(typeof k!="string")continue;const l=h(k);l[0]==="channels"&&l[1]&&l[1]in t&&f.add(l[1])}return{keptChannels:f,keptOperations:s}}function T(n,e){if(i(e)){if(typeof e.$ref=="string"&&e.$ref.startsWith("#/")){const t=O(n,e.$ref);return i(t)?t:void 0}return e}}export{F as extractAsyncApiSlice,x as scopeFromAsyncApiPointer};

package/lib/services/spec-slice/clone-strip.d.ts

@@ -0,0 +1 @@
+export declare function cloneStrip(value: unknown, inlineTargets: ReadonlyMap<string, unknown>): unknown;

package/lib/services/spec-slice/clone-strip.js

@@ -0,0 +1 @@
+import{REDOCLY_TEAMS_RBAC as E,REDOCLY_ROUTE_RBAC as S}from"@redocly/config";import{isRecord as l}from"../../adapters/helpers.js";const h=new Set([E,S,"x-circular-ref","x-original-ref"]);function w(p,a){const r=new WeakSet,s=new Set,c=e=>{if(Array.isArray(e)){if(r.has(e))throw new Error("spec-slice: circular object graph in the source document");r.add(e);const t=e.map(c);return r.delete(e),t}if(!l(e))return e;if(r.has(e))throw new Error("spec-slice: circular object graph in the source document");const i=typeof e.$ref=="string"?e.$ref:void 0;if(i&&a.has(i)){if(s.has(i))return{};s.add(i),r.add(e);const t=c(a.get(i));s.delete(i);const n={};for(const[f,u]of Object.entries(e))f==="$ref"||h.has(f)||u===void 0||(n[f]=c(u));return r.delete(e),l(t)?{...t,...n}:t}r.add(e);const o={};for(const[t,n]of Object.entries(e))h.has(t)||n===void 0||(o[t]=c(n));return r.delete(e),o};return c(p)}export{w as cloneStrip};

package/lib/services/spec-slice/component-closure.d.ts

@@ -0,0 +1,6 @@
+export type ComponentClosure = {
+    keep: Map<string, Set<string>>;
+    inlineTargets: Map<string, unknown>;
+};
+export declare function collectComponentClosure(document: Record<string, unknown>, seeds: unknown[], retainRef?: (ref: string) => boolean): ComponentClosure;
+export declare function buildComponentsFromClosure(document: Record<string, unknown>, keep: Map<string, Set<string>>): Record<string, unknown> | undefined;

package/lib/services/spec-slice/component-closure.js

@@ -0,0 +1 @@
+import{isRecord as r,resolveJsonPointer as N}from"../../adapters/helpers.js";import{encodeJsonPointerSegment as b}from"../../utils/refPointer.js";const O="#/components/";function $(a){return a.replace(/~1/g,"/").replace(/~0/g,"~")}function w(a,d,g){const u=new Map,p=new Map,f=[...d],h=new WeakSet;let c;const y=()=>{if(c)return c;c=new Map;const e=r(a.components)?a.components.schemas:void 0;if(r(e)){const n=`${O}schemas/`;for(const[o,t]of Object.entries(e))if(!(!r(t)||!Array.isArray(t.allOf)))for(const s of t.allOf){if(!r(s)||typeof s.$ref!="string"||!s.$ref.startsWith(n))continue;const i=$(s.$ref.slice(n.length)),m=e[i];if(!r(m)||!(m.discriminator||m["x-discriminator"]))continue;const k=c.get(i)??[];k.push(o),c.set(i,k)}}return c},l=(e,n)=>{const o=$(n);let t=u.get(e);if(t||(t=new Set,u.set(e,t)),t.has(o))return;const s=`${O}${e}/${n}`,i=N(a,s);if(i&&(t.add(o),f.push(i),e==="schemas"&&(i.discriminator||i["x-discriminator"])))for(const m of y().get(o)??[])l("schemas",b(m))},j=e=>{if(e.startsWith(O)){const[n,o]=e.slice(O.length).split("/");if(n&&o){l(n,o);return}}if(!g?.(e)&&e.startsWith("#/")){if(p.has(e))return;const n=N(a,e);if(!n)return;p.set(e,n),f.push(n);return}};for(;f.length;){const e=f.pop();if(Array.isArray(e)){f.push(...e);continue}if(!r(e)||h.has(e))continue;h.add(e);for(const[t,s]of Object.entries(e)){if(t==="$ref"&&typeof s=="string"){j(s);continue}if(t==="security"&&Array.isArray(s)){for(const i of s)if(r(i))for(const m of Object.keys(i))l("securitySchemes",b(m))}f.push(s)}const n=e.discriminator??e["x-discriminator"],o=r(n)?n.mapping:void 0;if(r(o))for(const t of Object.values(o))typeof t=="string"&&(t.startsWith("#/")?j(t):l("schemas",b(t)))}return{keep:u,inlineTargets:p}}function x(a,d){const g=a.components;if(!r(g)||d.size===0)return;const u={};for(const[p,f]of Object.entries(g)){const h=d.get(p);if(!h?.size||!r(f))continue;const c={};for(const[y,l]of Object.entries(f))h.has(y)&&(c[y]=l);Object.keys(c).length&&(u[p]=c)}return Object.keys(u).length?u:void 0}export{x as buildComponentsFromClosure,w as collectComponentClosure};

package/lib/services/spec-slice/graphql-slice.d.ts

@@ -0,0 +1,2 @@
+import type { SpecSliceScope } from './types.js';
+export declare function extractGraphqlSlice(sdl: string, scope: SpecSliceScope): string | undefined;

package/lib/services/spec-slice/graphql-slice.js

@@ -0,0 +1 @@
+import{Kind as t,OperationTypeNode as O,parse as g,print as F,visit as Y}from"graphql";const C=new Set([t.SCALAR_TYPE_DEFINITION,t.OBJECT_TYPE_DEFINITION,t.INTERFACE_TYPE_DEFINITION,t.UNION_TYPE_DEFINITION,t.ENUM_TYPE_DEFINITION,t.INPUT_OBJECT_TYPE_DEFINITION]),A=new Set([t.SCALAR_TYPE_EXTENSION,t.OBJECT_TYPE_EXTENSION,t.INTERFACE_TYPE_EXTENSION,t.UNION_TYPE_EXTENSION,t.ENUM_TYPE_EXTENSION,t.INPUT_OBJECT_TYPE_EXTENSION]);function S(o){return C.has(o.kind)}function v(o){return A.has(o.kind)}const P={query:O.QUERY,mutation:O.MUTATION,subscription:O.SUBSCRIPTION},M=["query","mutation","subscription"],k={query:"Query",mutation:"Mutation",subscription:"Subscription"};function R(o){const i={typeDefs:new Map,typeExts:new Map,directiveDefs:new Map,schemaExts:[]};for(const n of o.definitions)if(S(n))i.typeDefs.set(n.name.value,n);else if(v(n)){const r=n.name.value,s=i.typeExts.get(r)??[];s.push(n),i.typeExts.set(r,s)}else n.kind===t.DIRECTIVE_DEFINITION?i.directiveDefs.set(n.name.value,n):n.kind===t.SCHEMA_DEFINITION?i.schemaDef=n:n.kind===t.SCHEMA_EXTENSION&&i.schemaExts.push(n);return i}function x(o){const i={typeNames:[],directiveNames:[],operationFields:new Map},n=r=>{if(r.kind==="graphql-type")i.typeNames.push(r.name);else if(r.kind==="graphql-directive")i.directiveNames.push(r.name);else{const s=i.operationFields.get(r.operationType)??[];s.push(r.name),i.operationFields.set(r.operationType,s)}};if(o.kind==="graphql-type"||o.kind==="graphql-directive"||o.kind==="graphql-operation")return n(o),i;if(o.kind==="graphql-group")return o.members.forEach(n),i}function w(o,i){const n=P[i];for(const r of[o.schemaDef,...o.schemaExts])for(const s of r?.operationTypes??[])if(s.operation===n)return s.type.name.value;return k[i]}function q(o,i,n){const r=[],s=new Set,c=[i,...o.typeExts.get(i.name.value)??[]];for(const d of c)if(!(d.kind!==t.OBJECT_TYPE_DEFINITION&&d.kind!==t.OBJECT_TYPE_EXTENSION))for(const T of d.fields??[]){const a=T.name.value;n.has(a)&&!s.has(a)&&(s.add(a),r.push(T))}return r}function B(o,i){const n=x(i);if(!n)return;let r;try{r=g(o,{noLocation:!0})}catch{return}const s=R(r),c=new Map,d=[];let T=!1;for(const e of M){const f=n.operationFields.get(e);if(!f?.length)continue;const E=w(s,e),I=s.typeDefs.get(E);if(I?.kind!==t.OBJECT_TYPE_DEFINITION)continue;const _=q(s,I,new Set(f));if(!_.length)continue;const y=c.get(E);c.set(E,{kind:t.OBJECT_TYPE_DEFINITION,name:I.name,description:I.description,directives:I.directives,fields:y?[...y.fields??[],..._]:_}),d.push({kind:t.OPERATION_TYPE_DEFINITION,operation:P[e],type:{kind:t.NAMED_TYPE,name:{kind:t.NAME,value:E}}}),E!==k[e]&&(T=!0)}const a=d.length&&(s.schemaDef||T)?{kind:t.SCHEMA_DEFINITION,description:s.schemaDef?.description,directives:s.schemaDef?.directives,operationTypes:d}:void 0,p=new Set,l=new Set,N=[],h=e=>{if(p.has(e))return;const f=s.typeDefs.get(e);if(!f)return;p.add(e);const E=c.get(e);if(E){N.push(E);return}N.push(f,...s.typeExts.get(e)??[])},D=e=>{if(l.has(e))return;const f=s.directiveDefs.get(e);f&&(l.add(e),N.push(f))};a&&N.push(a);for(const e of c.keys())h(e);for(const e of n.typeNames)h(e);for(const e of n.directiveNames)D(e);if(p.size===0&&l.size===0)return;for(;N.length;){const e=N.pop();e&&Y(e,{NamedType(f){h(f.name.value)},Directive(f){D(f.name.value)}})}const u=[];let m=!1;for(const e of r.definitions)if(e.kind===t.SCHEMA_DEFINITION)a&&(u.push(a),m=!0);else if(S(e)){const f=e.name.value;p.has(f)&&u.push(c.get(f)??e)}else if(v(e)){const f=e.name.value;p.has(f)&&!c.has(f)&&u.push(e)}else e.kind===t.DIRECTIVE_DEFINITION&&l.has(e.name.value)&&u.push(e);if(a&&!m&&u.unshift(a),u.length!==0)return F({kind:t.DOCUMENT,definitions:u})}export{B as extractGraphqlSlice};

package/lib/services/spec-slice/index.d.ts

@@ -0,0 +1,6 @@
+import type { ApiSpecType } from '../../types/common.js';
+import type { SpecSliceScope } from './types.js';
+export { resolveSpecSliceScope } from './resolve-scope.js';
+export { ASSISTANT_LINK_BASES, buildInlinePromptLink, buildFetchSpecPromptLink, } from './assistant-links.js';
+export type { SliceContentKind, SpecSliceScope } from './types.js';
+export declare function buildSpecSlice(specType: ApiSpecType, document: unknown, scope: SpecSliceScope): Promise<string | undefined>;

package/lib/services/spec-slice/index.js

@@ -0,0 +1 @@
+import{dump as n}from"js-yaml";import{isRecord as f}from"../../adapters/helpers.js";import{apiSpecType as t}from"../../types/common.js";import{extractOpenApiSlice as c}from"./openapi-slice.js";import{extractAsyncApiSlice as p}from"./asyncapi-slice.js";import{resolveSpecSliceScope as x}from"./resolve-scope.js";import{ASSISTANT_LINK_BASES as h,buildInlinePromptLink as I,buildFetchSpecPromptLink as y}from"./assistant-links.js";async function s(o,e,i){switch(o){case t.GRAPHQL:{if(typeof e!="string")return;if(i.kind==="document")return e;const{extractGraphqlSlice:r}=await import("./graphql-slice.js");return r(e,i)}case t.OPENAPI:{if(f(e)){const r=c(e,i);if(r)return n(r.document,{noRefs:!0,lineWidth:-1})}return}case t.ASYNCAPI:{if(f(e)){const r=p(e,i);if(r)return n(r.document,{noRefs:!0,lineWidth:-1})}return}default:return}}export{h as ASSISTANT_LINK_BASES,y as buildFetchSpecPromptLink,I as buildInlinePromptLink,s as buildSpecSlice,x as resolveSpecSliceScope};

package/lib/services/spec-slice/openapi-slice.d.ts

@@ -0,0 +1,6 @@
+import type { SpecSliceScope } from './types.js';
+export declare function parsePointerTokens(pointer: string): string[];
+export declare function operationScopeFromPointer(pointer: string, isWebhook: boolean | undefined): SpecSliceScope | undefined;
+export declare function extractOpenApiSlice(document: Record<string, unknown>, scope: SpecSliceScope): {
+    document: Record<string, unknown>;
+} | undefined;

package/lib/services/spec-slice/openapi-slice.js

@@ -0,0 +1 @@
+import{isRecord as f}from"../../adapters/helpers.js";import{resolvePathItemRef as A}from"../../adapters/openapi/utils/resolvePathItemRef.js";import{JsonPointer as O}from"../../adapters/openapi/utils/JsonPointer.js";import{isOperationName as v}from"../../utils/http-methods.js";import{encodeJsonPointerSegment as w}from"../../utils/refPointer.js";import{DEFAULT_WEBHOOKS_TAG_NAME as x}from"../../constants/openapi.js";import{collectComponentClosure as S,buildComponentsFromClosure as T}from"./component-closure.js";import{cloneStrip as g}from"./clone-strip.js";const N=["openapi","info","jsonSchemaDialect","externalDocs","servers","security"];function I(e){const n=e.startsWith("/")||e.startsWith("#")?e:`/${e}`;try{return O.parse(n)}catch{return[]}}function L(e,n){const r=I(e);if(!(r.length<3||r[0]!=="paths"))return{kind:"operation",pathName:r[1],httpVerb:r[2],source:n?"webhooks":"paths"}}function W(e,n){if(typeof e.openapi!="string")return;if(n.kind==="document")return{document:g(e,new Map)};const r=M(e,n);if(!r)return;const{draft:s,extraSeeds:o=[]}=r,i=S(e,[s,...o]),t=T(e,i.keep);return t&&(s.components=t),{document:g(s,i.inlineTargets)}}function M(e,n){const r={};for(const p of N)e[p]!==void 0&&(r[p]=e[p]);if(n.kind==="schema"){const p=f(e.components)?e.components.schemas:void 0;if(!f(p)||!(n.name in p))return;r.paths={};const d={$ref:`#/components/schemas/${w(n.name)}`};return{draft:r,extraSeeds:[d]}}const s=e["x-webhooks"]?"x-webhooks":"webhooks",o=e["x-webhooks"]??e.webhooks;let i,t;if(n.kind==="operation"){i=new Map,t=new Map;const p=n.source==="webhooks"?o:e.paths,d=P(e,p,n.pathName,n.httpVerb);if(!d)return;(n.source==="webhooks"?t:i).set(n.pathName,d)}else if(n.kind==="tag"){if(i=k(e,e.paths,n.tagName,!1),t=k(e,o,n.tagName,!0),i.size===0&&t.size===0)return}else return;const a=new Set;for(const p of[...i.values(),...t.values()])for(const{operation:d}of p.operations){const l=d.tags;if(Array.isArray(l))for(const h of l)typeof h=="string"&&a.add(h)}const c=K(e,a);c.length&&(r.tags=c);const u=_(e,a);return u.length&&(r["x-tagGroups"]=u),r.paths=b(i),t.size&&(r[s]=b(t)),{draft:r}}function m(e,n){if(f(n))try{const r=A(e,n,e.openapi);return f(r)?r:void 0}catch{return}}function P(e,n,r,s){if(!f(n))return;const o=m(e,n[r]);if(!o)return;const i=o[s];if(f(i))return{pathItem:o,operations:[{operation:i,verbKey:s,isAdditional:!1}]};if(s==="query"&&f(o["x-query"]))return{pathItem:o,operations:[{operation:o["x-query"],verbKey:"x-query",isAdditional:!1}]};const t=f(o.additionalOperations)?o.additionalOperations[s]:void 0;if(f(t))return{pathItem:o,operations:[{operation:t,verbKey:s,isAdditional:!0}]}}function y(e,n,r){return(Array.isArray(e.tags)?e.tags:[r?x:""]).includes(n)}function k(e,n,r,s){const o=new Map;if(!f(n))return o;for(const i of Object.keys(n)){const t=m(e,n[i]);if(!t)continue;const a=[];for(const[c,u]of Object.entries(t))!v(c)||!f(u)||y(u,r,s)&&a.push({operation:u,verbKey:c,isAdditional:!1});if(f(t.additionalOperations))for(const[c,u]of Object.entries(t.additionalOperations))f(u)&&y(u,r,s)&&a.push({operation:u,verbKey:c,isAdditional:!0});a.length&&o.set(i,{pathItem:t,operations:a})}return o}const E=["summary","description","parameters","servers"];function b(e){const n={};for(const[r,{pathItem:s,operations:o}]of e){const i={};for(const a of E)s[a]!==void 0&&(i[a]=s[a]);const t={};for(const{operation:a,verbKey:c,isAdditional:u}of o)u?t[c]=a:i[c]=a;Object.keys(t).length&&(i.additionalOperations=t),n[r]=i}return n}function K(e,n){const r=Array.isArray(e.tags)?e.tags:[],s=new Map;for(const t of r)f(t)&&typeof t.name=="string"&&s.set(t.name,t);const o=new Set,i=t=>{if(o.has(t))return;const a=s.get(t);a&&(o.add(t),typeof a.parent=="string"&&i(a.parent))};for(const t of n)i(t);return r.filter(t=>f(t)&&o.has(t.name))}function _(e,n){const r=e["x-tagGroups"];if(!Array.isArray(r))return[];const s=[];for(const o of r){if(!f(o)||!Array.isArray(o.tags))continue;const i=o.tags.filter(t=>typeof t=="string"&&n.has(t));i.length&&s.push({...o,tags:i})}return s}export{W as extractOpenApiSlice,L as operationScopeFromPointer,I as parsePointerTokens};

package/lib/services/spec-slice/resolve-scope.d.ts

@@ -0,0 +1,4 @@
+import type { ApiItemContent } from '../../types/store.js';
+import type { ApiSpecType } from '../../types/common.js';
+import type { SpecSliceScope } from './types.js';
+export declare function resolveSpecSliceScope(specType: ApiSpecType, content: ApiItemContent | null | undefined, label: string | undefined, groupMemberContents?: Array<ApiItemContent | null | undefined>): SpecSliceScope | undefined;

package/lib/services/spec-slice/resolve-scope.js

@@ -0,0 +1 @@
+import{apiSpecType as u,contentType as t,itemVariant as i}from"../../types/common.js";import{BUILT_IN_DIRECTIVES as m,BUILT_IN_SCALARS as s}from"../../adapters/graphql/utils/constants.js";import{operationScopeFromPointer as T}from"./openapi-slice.js";import{scopeFromAsyncApiPointer as A}from"./asyncapi-slice.js";function V(e,r,n,p){if(r){if(r.contentType===t.OVERVIEW)return{kind:"document"};switch(e){case u.OPENAPI:return I(r);case u.ASYNCAPI:return S(r,n);case u.GRAPHQL:return r.contentType===t.GROUP?N(n,p):d(r);default:return}}}function I(e){if(e.contentType===t.GROUP){const r=e.meta?.name;return typeof r=="string"?{kind:"tag",tagName:r}:void 0}if(e.contentType===t.ITEM){if(e.itemVariant===i.HTTP_ITEM&&e.meta?.pointer)return T(e.meta.pointer,e.meta.isWebhook);if(e.itemVariant===i.SCHEMA&&e.meta?.name)return{kind:"schema",name:e.meta.name}}}const E={[i.QUERY]:"query",[i.MUTATION]:"mutation",[i.SUBSCRIPTION]:"subscription"},c=new Set([i.OBJECT,i.INTERFACE,i.INPUT,i.UNION,i.ENUM,i.SCALAR]);function d(e){if(e.contentType!==t.ITEM||!e.itemVariant)return;const r=e.meta?.name;if(typeof r!="string"||!r)return;const n=E[e.itemVariant];if(n)return{kind:"graphql-operation",operationType:n,name:r};if(c.has(e.itemVariant))return s.has(r)?void 0:{kind:"graphql-type",name:r};if(e.itemVariant===i.DIRECTIVE)return m.has(r)?void 0:{kind:"graphql-directive",name:r}}function N(e,r){if(!r?.length)return;const n=[],p=new Set;for(const o of r){const a=o?d(o):void 0;if(!a)continue;const f=`${a.kind}/${"operationType"in a?a.operationType:""}/${a.name}`;p.has(f)||(p.add(f),n.push(a))}return n.length?{kind:"graphql-group",label:e,members:n}:void 0}function S(e,r){if(e.contentType===t.GROUP)return r?{kind:"tag",tagName:r}:void 0;if(e.contentType===t.ITEM&&(e.itemVariant===i.CHANNEL||e.itemVariant===i.CHANNEL_OPERATION)&&e.meta?.pointer)return A(e.meta.pointer)}export{V as resolveSpecSliceScope};

package/lib/services/spec-slice/types.d.ts

@@ -0,0 +1,37 @@
+export type GraphqlOperationType = 'query' | 'mutation' | 'subscription';
+export type GraphqlItemScope = {
+    kind: 'graphql-operation';
+    operationType: GraphqlOperationType;
+    name: string;
+} | {
+    kind: 'graphql-type';
+    name: string;
+} | {
+    kind: 'graphql-directive';
+    name: string;
+};
+export type SpecSliceScope = {
+    kind: 'document';
+} | {
+    kind: 'tag';
+    tagName: string;
+} | {
+    kind: 'operation';
+    pathName: string;
+    httpVerb: string;
+    source: 'paths' | 'webhooks';
+} | {
+    kind: 'schema';
+    name: string;
+} | {
+    kind: 'channel';
+    channelId: string;
+} | {
+    kind: 'async-operation';
+    operationId: string;
+} | GraphqlItemScope | {
+    kind: 'graphql-group';
+    label?: string;
+    members: GraphqlItemScope[];
+};
+export type SliceContentKind = 'yaml' | 'graphql';

package/lib/standalone.d.ts

@@ -0,0 +1,19 @@
+import type { RedocStandaloneProps } from './RedocStandalone.js';
+import type { TypeOfUsage } from './telemetry/RedocTelemetry.js';
+import { RedocStandalone } from './RedocStandalone.js';
+export { RedocStandalone };
+export type { RedocStandaloneProps };
+type InitOptions = NonNullable<RedocStandaloneProps['options']> & {
+    router?: 'hash' | 'history';
+    disableTelemetry?: boolean;
+    specType?: RedocStandaloneProps['specType'];
+    /** The Docker image sets `type-of-usage="docker"` on the `<redoc>` element. */
+    typeOfUsage?: TypeOfUsage;
+    basePath?: string;
+};
+export declare function init(definitionOrDefinitionUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): void;
+/**
+ * Attaches to server-rendered markup instead of replacing it. The definition must be
+ * the same pre-bundled document the server pass rendered from.
+ */
+export declare function hydrate(definitionOrDefinitionUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): Promise<void>;

package/lib/standalone.js

@@ -0,0 +1,2 @@
+import{createElement as f}from"react";import{createRoot as g,hydrateRoot as E}from"react-dom/client";import{HashRouter as R}from"react-router";import{RedocStandalone as y,prepareApiDocs as S}from"./RedocStandalone.js";import{RedoclyApiDocsStandalone as A}from"./RedoclyApiDocsStandalone.js";import{logoFromDefinition as T}from"./utils/x-logo.js";const C=["html","cli","react","docker"];function M(e,t){return C.includes(e)?e:t}function m(e){return typeof document<"u"?document.querySelector(e):null}function w(e){const t={};for(const o of Array.from(e.attributes))t[o.name]=o.value;return t}function U(e){const t=w(e),o={};for(const r in t){const s=r.replace(/-(.)/g,(n,c)=>c.toUpperCase());o[s]=t[r]}return o}function h(e,t,o,r){const{router:s,disableTelemetry:n,specType:c,typeOfUsage:i,basePath:p,...u}={...t,...U(o)};let l,a;return typeof e=="string"?c==="graphql"&&!H(e)?a=e:l=e:typeof e=="object"&&(a=e),{router:s,props:{definition:a,definitionUrl:l,specType:c,options:u,basePath:p,telemetryConfig:{typeOfUsage:M(i,r),...n!==void 0?{disabled:n===!0||String(n)==="true"}:{}}}}}function d(e,t){return t==="history"?e:f(R,null,e)}function b(e){if(e===null)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');return e}function q(e,t={},o=m("redoc")){const r=b(o),{router:s,props:n}=h(e,t,r,"html");g(r).render(d(f(y,n),s))}const v=/server rendered HTML didn't match the client|error while hydrating|Minified React error #(418|423)/;async function L(e,t={},o=m("redoc")){const r=b(o),{router:s,props:n}=h(e,t,r,"cli"),c=n.basePath??"/",i=await S({...n,basePath:c}),p=f(A,{items:i.items,store:i.store,basePath:c,options:i.options,logo:T(i.document),telemetryConfig:n.telemetryConfig,definition:i.document,definitionUrl:n.definitionUrl});if(r.childElementCount===0){g(r).render(d(p,s));return}E(r,d(p,s),{onRecoverableError:(u,l)=>{const a=u instanceof Error?u.message:String(u);v.test(a)||console.error(a,l)}})}function H(e){return!e.includes(`
+`)&&/^[^\s]+$/.test(e)}function I(){const e=m("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&q(t,{},e)}I();export{y as RedocStandalone,L as hydrate,q as init};

package/lib/standaloneThemeConfig.d.ts

@@ -0,0 +1,3 @@
+import type { ThemeDataTransferObject } from '@redocly/theme/core/openapi';
+/** Theme config injected into the standalone render's `ThemeDataContext`; `undefined` keeps the theme defaults. */
+export declare const STANDALONE_THEME_CONFIG: ThemeDataTransferObject['config'] | undefined;

package/lib/standaloneThemeConfig.js

@@ -0,0 +1 @@
+const e=void 0;export{e as STANDALONE_THEME_CONFIG};

package/lib/telemetry/RedocTelemetry.d.ts

@@ -1,15 +1,18 @@
 import { Telemetry } from '@redocly/redoc-opentelemetry';
 import type { EventType, EventPayload } from '@redocly/redoc-opentelemetry';
 export type SpecType = 'openapi' | 'asyncapi' | 'graphql';
+export type TypeOfUsage = 'html' | 'cli' | 'react' | 'docker';
 export interface RedocTelemetryConfig {
     specType: SpecType;
     collectorUrl?: string;
     serviceName?: string;
     disabled?: boolean;
     serviceVersion?: string;
+    typeOfUsage?: TypeOfUsage;
 }
 export declare class RedocTelemetry extends Telemetry {
     private specType;
+    readonly typeOfUsage: TypeOfUsage | undefined;
     constructor(config: RedocTelemetryConfig);
     send<T extends EventType>(event: T, data?: EventPayload<T>): void;
 }

package/lib/telemetry/RedocTelemetry.js

@@ -1 +1 @@
-import{Telemetry as o}from"@redocly/redoc-opentelemetry";import c from"../../package.json"with{type:"json"};const p="https://otel.cloud.redocly.com/v1/traces";class n extends o{specType;constructor(e){super(),this.specType=e.specType,this.init({otel:{isProd:process.env.NODE_ENV==="production"||process.env.ENABLE_LOCAL_TELEMETRY==="true",serviceVersion:e.serviceVersion||`${c.name}@${c.version}`,version:"1.0.0",collectorTraceUrl:e.collectorUrl||p,serviceName:e.serviceName||"redoc-ce",tracerName:"client-telemetry"},disabled:e.disabled||!1})}send(e,r){r&&Array.isArray(r)&&r.length>0&&(r=r.map(s=>s&&typeof s=="object"?{...s,specType:this.specType}:s)),super.send(e,r,{env:process.env.NODE_ENV})}}export{n as RedocTelemetry};
+import{Telemetry as p}from"@redocly/redoc-opentelemetry";import o from"../../package.json"with{type:"json"};import{DEFAULT_SERVICE_NAME as t,TELEMETRY_DISABLED_BY_DEFAULT as c}from"./defaults.js";const E="https://otel.cloud.redocly.com/v1/traces";class n extends p{specType;typeOfUsage;constructor(e){super(),this.specType=e.specType,this.typeOfUsage=e.typeOfUsage,this.init({otel:{isProd:process.env.NODE_ENV==="production"||process.env.ENABLE_LOCAL_TELEMETRY==="true",serviceVersion:e.serviceVersion||`${o.name}@${o.version}`,version:"1.0.0",collectorTraceUrl:e.collectorUrl||E,serviceName:e.serviceName||t,tracerName:"client-telemetry"},disabled:e.disabled??c})}send(e,s){s&&Array.isArray(s)&&s.length>0&&(s=s.map(r=>r&&typeof r=="object"?{...r,specType:this.specType}:r)),super.send(e,s,{env:process.env.NODE_ENV})}}export{n as RedocTelemetry};

package/lib/telemetry/defaults.d.ts

@@ -0,0 +1,2 @@
+export declare const TELEMETRY_DISABLED_BY_DEFAULT = true;
+export declare const DEFAULT_SERVICE_NAME = "realm-ui";

package/lib/telemetry/defaults.js

@@ -0,0 +1 @@
+const E=!0,t="realm-ui";export{t as DEFAULT_SERVICE_NAME,E as TELEMETRY_DISABLED_BY_DEFAULT};

package/lib/types/code-samples-config.d.ts

@@ -0,0 +1,68 @@
+export type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'C#+Newtonsoft' | 'Ruby' | 'R';
+export interface BasicLanguageOptions {
+    indent?: string;
+    withImports?: boolean;
+    withComments?: boolean;
+}
+interface CodeSampleBasicConfig {
+    lang: Languages | 'Payload';
+    label: string;
+    key: string;
+    options?: BasicLanguageOptions;
+}
+export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'curl';
+    options?: BasicLanguageOptions & {
+        binary?: boolean;
+    };
+}
+export interface JavaScriptCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'JavaScript';
+    options?: BasicLanguageOptions & {
+        credentials?: 'omit' | 'same-origin' | 'include';
+    };
+}
+export interface GoCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Go';
+}
+export interface NodeJsCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Node.js';
+}
+export interface PythonCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Python';
+}
+export interface Java8CodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Java8+Apache';
+}
+export interface JavaCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Java';
+}
+export interface CSharpCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'C#';
+}
+export interface CSharpNewtonsoftCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'C#+Newtonsoft';
+}
+export interface PHPCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'PHP';
+}
+export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Ruby';
+}
+export interface RCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'R';
+}
+export interface PayloadCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Payload';
+}
+export interface CustomLanguageCodeSampleConfig extends Omit<CodeSampleBasicConfig, 'lang'> {
+    lang: string;
+}
+export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | CSharpNewtonsoftCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
+export interface CodeSamplesConfig {
+    languages: (CodeSampleConfig | PayloadCodeSampleConfig | CustomLanguageCodeSampleConfig)[];
+    skipOptionalParameters?: boolean;
+    withOAuth2Call?: boolean;
+    onSampleTabClick?: (label: string) => void;
+}
+export {};

package/lib/types/common.d.ts

@@ -1,6 +1,6 @@
 import type { Node } from '@markdoc/markdoc';
 import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
-import type { UserClaims } from '@redocly/theme/core/types';
+import type { UserClaims } from '@redocly/theme/core/openapi';
 export type { ConfigureRequestValues, ConfigureServerRequestValues };
 export type { UserClaims };
 export type { RbacScopeItems } from '@redocly/config';

package/lib/types/content.d.ts

@@ -1,6 +1,7 @@
 import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
 import type { Node } from '@markdoc/markdoc';
-import type { OpenAPIOperation, OpenAPIResponse } from './openapi.js';
+import type { OpenAPIResponse } from './openapi.js';
+import type { OpenAPIOperation } from './openapi.js';
 import type { CodeSampleSource } from '../services/code-samples/index.js';
 import type { BadgeData, ServerData, nodeTypes, panelKind } from './common.js';
 import type { GroupItem, ApiItemContent, SecuritySchemeEntry } from './store.js';
@@ -405,7 +406,7 @@ export type ResponseExamplesPanelItem = BaseExamplePanelItem & {
     kind: typeof panelKind.RESPONSE;
     exampleIds?: string[];
     responseCodes?: ResponseCodeEntry[];
-    headerTitle?: string;
+    hideHeaderTitle?: boolean;
     exampleKey?: string;
 };
 export type GraphQLQueryPanelItem = BaseExamplePanelItem & {
@@ -468,7 +469,7 @@ export type OverviewPanelItem = ExternalLinkPanelItem | EmailPanelItem | KeyValu
 export type McpPanelItem = KeyValuePanelItem | TagsPanelItem | ExternalLinkPanelItem | ConnectMcpButtonPanelItem;
 export type McpExamplePanelItem = {
     kind: typeof panelKind.MCP_EXAMPLE;
-    headerTitle: string;
+    headerTitleTranslationKey: string;
     data: unknown;
     language?: string;
 };

package/lib/types/edition-config.d.ts

@@ -0,0 +1,4 @@
+import type { AsyncApiConfig, GraphQLConfig, RedocConfig } from '@redocly/config';
+export type EditionRedocConfig = RedocConfig;
+export type EditionAsyncApiConfig = AsyncApiConfig;
+export type EditionGraphQLConfig = GraphQLConfig;

package/lib/types/events.d.ts

@@ -1,8 +1,8 @@
 import type { Operation } from './options.js';
-export type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'PanelToggle' | 'TargetServerSwitched' | 'TryItOpen' | 'TryItSent';
+export type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'PanelToggle' | 'TryItOpen' | 'TryItSent' | 'TargetServerSwitched';
 export type AnalyticsEvent = {
     eventType: AnalyticsEventType;
-    resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
+    resource: 'Redocly_CodeSample' | 'Redocly_OperationTryIt' | 'Redocly_Operation';
     action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'Closed' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
     operationId?: string;
     operationPath: string;

package/lib/types/openapi.d.ts

@@ -1,4 +1,5 @@
-import type { ENTITY_RELATION_TYPES, REDOCLY_TEAMS_RBAC, RbacScopeItems } from '@redocly/config';
+import type { REDOCLY_TEAMS_RBAC, RbacScopeItems } from '@redocly/config';
+import type { ENTITY_RELATION_TYPES } from '@redocly/config';
 import type { Node } from '@markdoc/markdoc';
 import type { SecurityDetails as ThemeSecurityDetails } from '@redocly/theme/ext/configure';
 import type { OpenAPIRef, RawLogo, Referenced, SeoData, ExternalDocsData, SecuritySchemeType, SecuritySchemeIn, ObjectValues } from './common.js';

package/lib/types/options.d.ts

@@ -1,7 +1,9 @@
-import type { AsyncApiConfig, GraphQLConfig, LayoutVariant, RedocConfig } from '@redocly/config';
+import type { LayoutVariant } from '@redocly/config';
+import type { RedocConfig } from '@redocly/config';
+import type { EditionAsyncApiConfig, EditionGraphQLConfig, EditionRedocConfig } from './edition-config.js';
 import type { ConfigFunction, Node, Schema } from '@markdoc/markdoc';
 import type { MarkdocTagSchema } from '@redocly/theme/markdoc/tags/types';
-import type { UserClaims } from '@redocly/theme/core/types';
+import type { UserClaims } from '@redocly/theme/core/openapi';
 import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
 import type { ReactElement } from 'react';
 import type { ComponentType } from 'react';
@@ -9,8 +11,10 @@ import type { ApiSpecType, SidebarLogo } from './common.js';
 import type { ProtocolVariant } from './asyncapi.js';
 import type { GraphQLOptions } from './graphql.js';
 import type { Events } from './events.js';
+import type { CodeSamplesConfig } from './code-samples-config.js';
 import type { OpenAPIInfo, OpenAPIOperation as OpenAPIOperationType, OpenAPIParameter, OpenAPIServer, OpenAPITag } from './openapi.js';
 import type { Referenced } from './common.js';
+export type * from './code-samples-config.js';
 export type Operation = {
     id: string;
     path: string;
@@ -44,19 +48,30 @@ export type MarkdocOptions = {
  * host supplies the parser (the standalone build supplies a Markdoc-based one; see
  * `markdocParser`). It is the single seam where markdown text becomes an AST.
  */
-export type MarkdownParser = (markdown: string, sanitizeOptions?: Partial<Pick<ApiDocsOptions, 'sanitize' | 'unstable_hooks'>>) => Node | Node[] | undefined;
+export type MarkdownParser = (markdown: string, sanitizeOptions?: {
+    sanitize?: ApiDocsOptions['sanitize'];
+    unstable_hooks?: ApiDocsOptions['unstable_hooks'];
+}) => Node | Node[] | undefined;
 export type ApiDocsOptions = {
-    schemaDefinitionsTagName?: string;
     corsProxyUrl?: string;
+    hideInfoMetadata: boolean;
+    hideReplay: boolean;
+    oAuth2RedirectURI?: string;
+    showSchemaCatalogLinks?: boolean;
+    licenseKey?: string;
+    feedback: NonNullable<RedocConfig['feedback']>;
+    mockServer?: {
+        url: string;
+        position: 'first' | 'last' | 'replace' | 'off';
+        description: string;
+    };
+    schemaDefinitionsTagName?: string;
     jsonSamplesExpandLevel: number;
     generatedSamplesMaxDepth: number;
     hideDownloadButtons: boolean;
-    hideInfoMetadata: boolean;
     hideSchemaTitles: boolean;
     hideSchemaPattern: boolean;
     maxDisplayedEnumValues: number;
-    hideReplay: boolean;
-    oAuth2RedirectURI?: string;
     onlyRequiredInSamples: boolean;
     onDeepLinkClick: ((link: string) => void) | undefined | null;
     schemasExpansionLevel?: number;
@@ -72,33 +87,23 @@ export type ApiDocsOptions = {
     unstable_skipSamples?: boolean;
     unstable_externalCodeSamples: Unstable_ExternalCodeSample[];
     hidePropertiesPrefix: boolean;
-    showSchemaCatalogLinks?: boolean;
     dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
     userClaims?: UserClaims;
     protocol?: ProtocolVariant;
     scrollYOffset: () => number;
     hideLoading: boolean;
     skipBundle: boolean;
-    hideSidebar: boolean;
     basePath: string;
     specType: ApiSpecType;
-    licenseKey?: string;
     metadata: ApiDocsMetadata;
     downloadUrls?: NormalizedDownloadUrl[];
     layout: LayoutVariant;
-    feedback: NonNullable<RedocConfig['feedback']>;
-    mockServer?: {
-        url: string;
-        position: 'first' | 'last' | 'replace' | 'off';
-        description: string;
-    };
     apiLogo?: SidebarLogo;
     jsonSamplesDepth: number;
     samplesMaxInlineArgs: number;
     fieldExpandLevel: number;
-    baseUrlPath?: string;
 } & GraphQLOptions;
-export type RawApiDocsOptions = RedocConfig & AsyncApiConfig & GraphQLConfig & {
+export type RawApiDocsOptions = EditionRedocConfig & EditionAsyncApiConfig & EditionGraphQLConfig & {
     specType: ApiSpecType;
     markdownParser: MarkdownParser;
     basePath?: string;
@@ -106,78 +111,10 @@ export type RawApiDocsOptions = RedocConfig & AsyncApiConfig & GraphQLConfig & {
     requiredPropsFirst?: boolean;
     licenseKey?: string;
     protocol?: ProtocolVariant;
-    excludeFromSearch?: boolean;
     dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
     userClaims?: UserClaims;
-    layout?: RedocConfig['layout'] | AsyncApiConfig['layout'] | GraphQLConfig['layout'];
+    layout?: EditionRedocConfig['layout'] | EditionAsyncApiConfig['layout'] | EditionGraphQLConfig['layout'];
 };
-export type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'C#+Newtonsoft' | 'Ruby' | 'R';
-export interface BasicLanguageOptions {
-    indent?: string;
-    withImports?: boolean;
-    withComments?: boolean;
-}
-interface CodeSampleBasicConfig {
-    lang: Languages | 'Payload';
-    label: string;
-    key: string;
-    options?: BasicLanguageOptions;
-}
-export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'curl';
-    options?: BasicLanguageOptions & {
-        binary?: boolean;
-    };
-}
-export interface JavaScriptCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'JavaScript';
-    options?: BasicLanguageOptions & {
-        credentials?: 'omit' | 'same-origin' | 'include';
-    };
-}
-export interface GoCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Go';
-}
-export interface NodeJsCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Node.js';
-}
-export interface PythonCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Python';
-}
-export interface Java8CodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Java8+Apache';
-}
-export interface JavaCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Java';
-}
-export interface CSharpCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'C#';
-}
-export interface CSharpNewtonsoftCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'C#+Newtonsoft';
-}
-export interface PHPCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'PHP';
-}
-export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Ruby';
-}
-export interface RCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'R';
-}
-export interface PayloadCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Payload';
-}
-export interface CustomLanguageCodeSampleConfig extends Omit<CodeSampleBasicConfig, 'lang'> {
-    lang: string;
-}
-export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | CSharpNewtonsoftCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
-export interface CodeSamplesConfig {
-    languages: (CodeSampleConfig | PayloadCodeSampleConfig | CustomLanguageCodeSampleConfig)[];
-    skipOptionalParameters?: boolean;
-    withOAuth2Call?: boolean;
-    onSampleTabClick?: (label: string) => void;
-}
 export type Normalized<T> = {
     [P in keyof T]-?: T[P];
 };
@@ -257,4 +194,3 @@ export type HooksConfig = {
     MiddlePanelFooter?: HookConfig<undefined>;
     MiddlePanelHeader?: HookConfig<undefined>;
 };
-export {};

package/lib/utils/compose.d.ts

@@ -4,4 +4,5 @@ export declare function compose<P>(f: HOC<P>): (Component: ComponentType<P>) =>
 export declare function compose<P>(f: HOC<P>, g: HOC<P>): (Component: ComponentType<P>) => FC<P>;
 export declare function compose<P>(f: HOC<P>, g: HOC<P>, h: HOC<P>): (Component: ComponentType<P>) => FC<P>;
 export declare function compose<P>(f: HOC<P>, g: HOC<P>, h: HOC<P>, i: HOC<P>): (Component: ComponentType<P>) => FC<P>;
+export declare function compose<P>(f: HOC<P>, g: HOC<P>, h: HOC<P>, i: HOC<P>, j: HOC<P>): (Component: ComponentType<P>) => FC<P>;
 export {};

package/lib/utils/deep-link.d.ts

@@ -112,6 +112,7 @@ export declare function isGraphqlDeepLinkAncestor(hash: string, path: string): b
  */
 export declare function getDeepLinkId(deepLink: string | undefined): string | undefined;
 export declare function appendVariantSuffix(fieldParentsName: string[] | undefined, suffix: string): string[];
+export declare function appendArraySuffix(fieldParentsName: string[]): string[];
 /**
  * Remove variant deep-link markers (`&oneof=N`, `&d=N`) from a field-parent path
  * piece, leaving the human-readable name(s). The markers can sit mid-path

package/lib/utils/deep-link.js

@@ -1 +1 @@
-import{encodeBackSlashes as k,tryDecodeURIComponent as a}from"./string.js";import{joinWithSeparator as i,normalizePath as x,toElementId as S}from"./url.js";import{resolveRouteByPathname as A}from"./routing.js";function C(t){const e=[];for(const[n,r]of Object.entries(t))r!==void 0&&e.push(`${n}=${r}`);return e.join("&")}function g(t,e){return t=k(t).replace(/^\/+/,""),(`/${t}#`+i(t,e)).toLowerCase()}function D(t,e,n){const r=g(e,n);return x(i(t,r))}function h(t){const e=t.startsWith("#")?t.slice(1):t;return a(e).toLowerCase()}function b(t){const e=a(t),n=e.indexOf("#");return n>=0?e.slice(n+1):""}function j(t){return C({t:t.t,in:t.in,c:t.c,cb:t.cb,ct:t.ct,path:t.path})}function F(t,e,n){let r=t;return n&&(r=`${r}&c=${n}`),e&&(r=i(r,e)),r}function I(t){const{section:e,messageKey:n,subsection:r}=t;if(!n)return e;let o=`${e}&m=${n}`;return r&&(o+=`&t=${r}`),o}function M(t){return C({t:t.t,path:t.path,arg:t.arg,rt:t.rt})}function P(t,e){return!t||!e?!1:a(t.startsWith("#")?t.slice(1):t).toLowerCase().includes(`path=${e.toLowerCase()}.`)}function v(t){return t&&b(t)||void 0}function z(t,e){const n=[...t??[]];return n.length>0?n[n.length-1]+=e:n.push(e),n}const E=/&(?:oneof|d)=\d+/g;function H(t){return t.replace(E,"")}function q(t){return t.replace(/\[\]/g,"")}function G(t){return(t??[]).filter(e=>e.includes("&")).map(e=>e.slice(e.indexOf("&")))}function U(t,e){return t?a(t.startsWith("#")?t.slice(1):t).toLowerCase().match(new RegExp(`(?:^|[&/])${e}=([^/&]+)`))?.[1]:void 0}const O="callbacks",f=`${O}/`,w="callback-request",T="callback-response",R=[`/${w}`,`/${T}`];function p(t){const e=t.indexOf("path=");return e===-1?t:t.slice(0,e)}function V(t){return t.replace(`/${f}`,"/")}function L(t,e){const n=`cb=${e}`;return t.endsWith(n)||t.includes(`${n}&`)}function W(t,e){const n=`/${e}`;return t.endsWith(n)||t.includes(`${n}/`)}function y(t,e){return t===e||t.startsWith(`${e}/`)}function Q(t,e,n){if(!t||!e||!n)return!1;const r=h(t);if(!y(r,e))return!1;const o=p(r),c=n.toLowerCase();return L(o,c)||W(o,c)}function J(t,e,n){const r=p(t),o=n.toLowerCase();return r.startsWith(i(e,`${f}${o}/`))||r.startsWith(i(e,`${o}/`))||L(r,o)}function X(t,e){const n=p(t).slice(e.length);return!(n.startsWith(`/${f}`)||n.includes("cb=")||R.some(o=>n.includes(o)))}function N(t){const e=["#tag","#operation","#paths"];for(const n of e)if(t.includes(n))return t.replace(n,"").toLowerCase();return""}function Y(t,e,n){const r=h(t);if(!r)return;const o=x(i(e,r));if(A(n,o))return o;const c=N(t);if(!c)return;const l=c.split("/").filter(Boolean);for(let s=l.length;s>0;s--){const $="/"+l.slice(0,s).join("/"),u=n.allRoutes.find(m=>m.path.endsWith($));if(!u)continue;const d=l.slice(s).join("/");return d?`${u.path}#${i(S(u.path,e),d)}`:u.path}}export{O as CALLBACKS_SECTION,w as CALLBACK_REQUEST_SECTION,T as CALLBACK_RESPONSE_SECTION,z as appendVariantSuffix,I as buildAsyncApiSuffix,D as buildDeepLinkUrl,M as buildGraphqlSuffix,j as buildOpenApiFieldSuffix,F as buildOpenApiSectionSuffix,b as deepLinkToId,U as extractDeepLinkParamFromHash,v as getDeepLinkId,N as getLegacyHash,y as hashIsForItem,J as hashIsInsideCallback,X as hashIsOutsideCallbacks,Q as hashTargetsCallback,h as hashToElementId,P as isGraphqlDeepLinkAncestor,g as makeDeepLink,Y as resolveLegacyHashToRoute,C as serializeFieldParams,q as stripArrayMarkers,V as stripCallbacksSegment,H as stripVariantMarkers,G as variantMarkersOnly};
+import{encodeBackSlashes as g,tryDecodeURIComponent as a}from"./string.js";import{joinWithSeparator as i,normalizePath as x,toElementId as k}from"./url.js";import{resolveRouteByPathname as A}from"./routing.js";function h(t){const e=[];for(const[n,r]of Object.entries(t))r!==void 0&&e.push(`${n}=${r}`);return e.join("&")}function b(t,e){return t=g(t).replace(/^\/+/,""),(`/${t}#`+i(t,e)).toLowerCase()}function N(t,e,n){const r=b(e,n);return x(i(t,r))}function C(t){const e=t.startsWith("#")?t.slice(1):t;return a(e).toLowerCase()}function m(t){const e=a(t),n=e.indexOf("#");return n>=0?e.slice(n+1):""}function j(t){return h({t:t.t,in:t.in,c:t.c,cb:t.cb,ct:t.ct,path:t.path})}function F(t,e,n){let r=t;return n&&(r=`${r}&c=${n}`),e&&(r=i(r,e)),r}function I(t){const{section:e,messageKey:n,subsection:r}=t;if(!n)return e;let o=`${e}&m=${n}`;return r&&(o+=`&t=${r}`),o}function M(t){return h({t:t.t,path:t.path,arg:t.arg,rt:t.rt})}function v(t,e){return!t||!e?!1:a(t.startsWith("#")?t.slice(1):t).toLowerCase().includes(`path=${e.toLowerCase()}.`)}function z(t){return t&&m(t)||void 0}function H(t,e){const n=[...t??[]];return n.length>0?n[n.length-1]+=e:n.push(e),n}function q(t){return t.length===0?t:[...t.slice(0,-1),t[t.length-1]+"[]"]}const E=/&(?:oneof|d)=\d+/g;function G(t){return t.replace(E,"")}function U(t){return t.replace(/\[\]/g,"")}function V(t){return(t??[]).filter(e=>e.includes("&")).map(e=>e.slice(e.indexOf("&")))}function P(t,e){return t?a(t.startsWith("#")?t.slice(1):t).toLowerCase().match(new RegExp(`(?:^|[&/])${e}=([^/&]+)`))?.[1]:void 0}const O="callbacks",f=`${O}/`,w="callback-request",T="callback-response",y=[`/${w}`,`/${T}`];function p(t){const e=t.indexOf("path=");return e===-1?t:t.slice(0,e)}function Q(t){return t.replace(`/${f}`,"/")}function L(t,e){const n=`cb=${e}`;return t.endsWith(n)||t.includes(`${n}&`)}function R(t,e){const n=`/${e}`;return t.endsWith(n)||t.includes(`${n}/`)}function W(t,e){return t===e||t.startsWith(`${e}/`)}function J(t,e,n){if(!t||!e||!n)return!1;const r=C(t);if(!W(r,e))return!1;const o=p(r),c=n.toLowerCase();return L(o,c)||R(o,c)}function X(t,e,n){const r=p(t),o=n.toLowerCase();return r.startsWith(i(e,`${f}${o}/`))||r.startsWith(i(e,`${o}/`))||L(r,o)}function Y(t,e){const n=p(t).slice(e.length);return!(n.startsWith(`/${f}`)||n.includes("cb=")||y.some(o=>n.includes(o)))}function _(t){const e=["#tag","#operation","#paths"];for(const n of e)if(t.includes(n))return t.replace(n,"").toLowerCase();return""}function Z(t,e,n){const r=C(t);if(!r)return;const o=x(i(e,r));if(A(n,o))return o;const c=_(t);if(!c)return;const l=c.split("/").filter(Boolean);for(let s=l.length;s>0;s--){const $="/"+l.slice(0,s).join("/"),u=n.allRoutes.find(S=>S.path.endsWith($));if(!u)continue;const d=l.slice(s).join("/");return d?`${u.path}#${i(k(u.path,e),d)}`:u.path}}export{O as CALLBACKS_SECTION,w as CALLBACK_REQUEST_SECTION,T as CALLBACK_RESPONSE_SECTION,q as appendArraySuffix,H as appendVariantSuffix,I as buildAsyncApiSuffix,N as buildDeepLinkUrl,M as buildGraphqlSuffix,j as buildOpenApiFieldSuffix,F as buildOpenApiSectionSuffix,m as deepLinkToId,P as extractDeepLinkParamFromHash,z as getDeepLinkId,_ as getLegacyHash,W as hashIsForItem,X as hashIsInsideCallback,Y as hashIsOutsideCallbacks,J as hashTargetsCallback,C as hashToElementId,v as isGraphqlDeepLinkAncestor,b as makeDeepLink,Z as resolveLegacyHashToRoute,h as serializeFieldParams,U as stripArrayMarkers,Q as stripCallbacksSegment,G as stripVariantMarkers,V as variantMarkersOnly};

package/lib/utils/extract-extensions.js

@@ -1 +1 @@
-const x={"x-circular-ref":!0,"x-complex":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-badges":!0,"x-hideReplay":!0,"x-feedback":!0,"x-assertionType":!0,"x-rbac":!0,"x-seo":!0};function n(r){return r in x}function i(r,t){return Object.keys(r).filter(e=>t===!0?e.startsWith("x-")&&!n(e):e.startsWith("x-")&&t.indexOf(e)>-1).reduce((e,u)=>(e[u]=r[u],e),{})}function a(r,t){return t===!1||t===void 0?{}:i(r,t)}export{i as extractExtensions,a as getExtensionsForDisplay,n as isRedocExtension};
+const x={"x-circular-ref":!0,"x-complex":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-badges":!0,"x-hideReplay":!0,"x-feedback":!0,"x-assertionType":!0,"x-rbac":!0,"x-seo":!0,"x-keywords":!0,"x-mcp":!0,"x-metadata":!0,"x-summary":!0,"x-tags":!0,"x-usePkce":!0,"x-webhooks":!0};function a(r){return r in x}function n(r,t){return Object.keys(r).filter(e=>t===!0?e.startsWith("x-")&&!a(e):e.startsWith("x-")&&t.indexOf(e)>-1).reduce((e,u)=>(e[u]=r[u],e),{})}function i(r,t){return t===!1||t===void 0?{}:n(r,t)}export{n as extractExtensions,i as getExtensionsForDisplay,a as isRedocExtension};

package/lib/utils/x-logo.d.ts

@@ -0,0 +1,13 @@
+type XLogo = {
+    url?: string;
+    href?: string;
+    altText?: string;
+    backgroundColor?: string;
+};
+export type LogoConfig = XLogo;
+/**
+ * Derives the sidebar logo config from the definition's `info['x-logo']`
+ * extension, falling back to `info.contact.url` for the link.
+ */
+export declare function logoFromDefinition(definition: Record<string, unknown> | string | undefined): LogoConfig | undefined;
+export {};

package/lib/utils/x-logo.js

@@ -0,0 +1 @@
+function e(n){if(typeof n=="string")return;const r=n?.info,o=r?.["x-logo"];if(!o?.url)return;const t=r?.contact;return{url:o.url,href:o.href||t?.url,altText:o.altText,backgroundColor:o.backgroundColor}}export{e as logoFromDefinition};