@redocly/api-docs 0.2.0-next.1 → 0.2.0-next.10

package/lib/RedocStandalone.d.ts

@@ -0,0 +1,38 @@
+import type { ReactElement, ReactNode } from 'react';
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { ApiSpecType } from './types/common.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import type { RedocTelemetryConfig } from './telemetry/RedocTelemetry.js';
+import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
+import type { RedoclyApiDocsStandaloneProps } from './RedoclyApiDocsStandalone.js';
+type RedocStandaloneProps = {
+    /** Parsed definition object, or a GraphQL SDL string when `specType` is `graphql`. */
+    definition?: Record<string, unknown> | string;
+    /** URL to fetch the definition from. Ignored when `definition` is provided. */
+    definitionUrl?: string;
+    /** Detected automatically when omitted (`.graphql`/`.gql` URL or document shape). */
+    specType?: ApiSpecType;
+    options?: Partial<RawApiDocsOptions>;
+    basePath?: string;
+    logo?: RedoclyApiDocsStandaloneProps['logo'];
+    markdownAdapter?: MarkdownAdapter;
+    telemetryConfig?: Partial<RedocTelemetryConfig>;
+    onLoaded?: (error?: Error) => void;
+    /** Rendered while the definition is loading. */
+    children?: ReactNode;
+};
+type PreparedApiDocs = {
+    items: ApiItem[];
+    store: ApiStore;
+    options: RawApiDocsOptions;
+    specType: ApiSpecType;
+    /** Bundled definition, or the raw SDL string for GraphQL. */
+    document?: Record<string, unknown> | string;
+};
+export declare function detectSpecType({ definition, definitionUrl, specType, }: Pick<RedocStandaloneProps, 'definition' | 'definitionUrl' | 'specType'>): ApiSpecType | undefined;
+declare function prepareApiDocs({ definition, definitionUrl, specType, options, basePath, }: Pick<RedocStandaloneProps, 'definition' | 'definitionUrl' | 'specType' | 'options' | 'basePath'>): Promise<PreparedApiDocs>;
+/** Loads and bundles the definition, builds the item model, and renders `RedoclyApiDocsStandalone`. */
+declare const RedocStandalone: ({ definition, definitionUrl, specType, options, basePath, logo, markdownAdapter, telemetryConfig, onLoaded, children, }: RedocStandaloneProps) => ReactElement | null;
+export { RedocStandalone, prepareApiDocs };
+export type { RedocStandaloneProps };
+export default RedocStandalone;

package/lib/RedocStandalone.js

@@ -0,0 +1 @@
+import{Fragment as b,jsx as d,jsxs as x}from"react/jsx-runtime";import{useEffect as E,useMemo as L,useState as P}from"react";import{Loading as S}from"@redocly/theme/components/Loaders/Loading";import{RedoclyApiDocsStandalone as T}from"./RedoclyApiDocsStandalone.js";import{buildItems as k}from"./adapters/build.js";import{markdocParser as D}from"./components/markdoc/markdocParser.js";import{argValueToBoolean as w}from"./options/helpers.js";import{loadAndBundleDefinition as I}from"./utils/loadAndBundleSpec.js";import{logoFromDefinition as v}from"./utils/x-logo.js";import{apiSpecType as s}from"./types/common.js";const B=/\.(graphql|gql)([?#]|$)/i;function F({definition:e,definitionUrl:r,specType:o}){if(o)return o;if(typeof e=="string"||B.test(r??""))return s.GRAPHQL;if(e&&typeof e=="object")return"asyncapi"in e?s.ASYNCAPI:s.OPENAPI}function G(e){if(typeof e!="object"||e===null)throw new Error('"definition" must be an object when "skipBundle" is enabled');return e}async function H({definition:e,definitionUrl:r,specType:o,skipBundle:a}){if(e===void 0&&r===void 0)throw new Error('Either "definition" or "definitionUrl" must be provided');const n=F({definition:e,definitionUrl:r,specType:o});if(n===s.GRAPHQL){const p=typeof e=="string"?e:await(await fetch(r)).text(),{parse:i}=await import("./utils/graphql-parse.js");return{document:i(p),type:s.GRAPHQL,sdl:p}}const t=a?G(e):await I(e??r),c=n??(t&&typeof t=="object"&&"asyncapi"in t?s.ASYNCAPI:s.OPENAPI);return{document:t,type:c}}async function h({definition:e,definitionUrl:r,specType:o,options:a={},basePath:n="/"}){const t=await H({definition:e,definitionUrl:r,specType:o,skipBundle:w(a.skipBundle,!1)}),c={specType:t.type,metadata:{type:t.type},...a},{items:p,store:i}=await k({type:t.type,document:t.document,options:c,basePath:n,markdownParser:D});return{items:p,store:i,options:c,specType:t.type,document:t.type===s.GRAPHQL?t.sdl:t.document}}const j=({definition:e,definitionUrl:r,specType:o,options:a,basePath:n="/",logo:t,markdownAdapter:c,telemetryConfig:p,onLoaded:i,children:f})=>{const[u,y]=P(null),[g,A]=P(null),R=L(()=>({typeOfUsage:"react",...p}),[p]);return E(()=>{let m=!1;return y(null),A(null),h({definition:e,definitionUrl:r,specType:o,options:a,basePath:n}).then(l=>{m||(y(l),i?.())}).catch(l=>{m||(A(l),i?.(l))}),()=>{m=!0}},[e,r,o,n]),g?x("div",{role:"alert",style:{padding:"1em",fontFamily:"monospace",color:"#e53e3e"},children:["Failed to load API definition: ",g.message]}):u?d(T,{items:u.items,store:u.store,basePath:n,options:u.options,logo:t??v(u.document),markdownAdapter:c,telemetryConfig:R,definition:u.document,definitionUrl:r}):f!==void 0?d(b,{children:f}):w(a?.hideLoading,!1)?null:d(S,{color:"--loading-spinner-color"})};var z=j;export{j as RedocStandalone,z as default,F as detectSpecType,h as prepareApiDocs};

package/lib/RedoclyApiDocs.js

@@ -1 +1 @@
-import{jsx as t,jsxs as f}from"react/jsx-runtime";import{memo as g,useCallback as S,useMemo as b}from"react";import{useAtomValue as v}from"jotai";import{GlobalStyle as T}from"@redocly/theme/core/openapi";import{RedocTelemetry as w}from"./telemetry/RedocTelemetry.js";import{TelemetryContext as x}from"./contexts/telemetry.js";import{MarkdownAdapterProvider as R}from"./contexts/markdownAdapter.js";import{specTypeAtom as P}from"./jotai/store.js";import{useApiDocsRoutes as A}from"./hooks/useApiDocsRoutes.js";import{useTelemetry as C}from"./hooks/useTelemetry.js";import{useVisitedChannelsTracker as k}from"./hooks/useVisitedChannelsTracker.js";import{useRouterHashBridge as j}from"./hooks/useRouterHashBridge.js";import{useScrollSpyUrlSync as D}from"./hooks/useScrollSpyUrlSync.js";import{useTelemetryPageMetrics as E}from"./hooks/useTelemetryPageMetrics.js";import{EntryPage as V}from"./pages/EntryPage.js";import{ErrorBoundary as B}from"./components/ErrorBoundary.js";import{compose as M}from"./utils/compose.js";import{withRouter as U}from"./hoc/withRouter.js";import{withStoreProvider as I}from"./hoc/withStoreProvider.js";import{withReplayPrefetch as N}from"./hoc/withReplayPrefetch.js";const u=r=>{const{items:s=[],basePath:o,markdownAdapter:m,telemetryConfig:e}=r,{routeIndex:c}=A(s,o),i=v(P),n=e?.specType,l=e?.collectorUrl,p=e?.serviceName,a=e?.serviceVersion,d=e?.disabled,h=b(()=>new w({specType:n??i,collectorUrl:l,serviceName:p??"realm-ui",serviceVersion:a,disabled:d}),[i,n,l,p,a,d]);return t(R,{value:m,children:f(x.Provider,{value:h,children:[t(H,{}),t(_,{routeIndex:c,basePath:o})]})})};function H(){return k(),j(),D(),null}const _=({routeIndex:r,basePath:s})=>{const o=C();E();const m=S((e,c)=>{o.sendErrorMessage([{id:"errorBoundaryCatch",object:"error",uri:typeof window<"u"?window.location.href:"",details:{message:e.message,stack:c.componentStack??void 0}}])},[o]);return f(B,{onError:m,children:[t(T,{}),t(V,{routeIndex:r,basePath:s})]})},y=M(I,U,g,r=>N(r,{respectHideReplay:!0}))(u);var ce=y;export{y as RedoclyApiDocs,u as RedoclyApiDocsComponent,ce as default};
+import{Fragment as T,jsx as o,jsxs as f}from"react/jsx-runtime";import{memo as v,useMemo as S}from"react";import{useAtomValue as x}from"jotai";import{GlobalStyle as R}from"@redocly/theme/core/openapi";import{RedocTelemetry as b}from"./telemetry/RedocTelemetry.js";import{TelemetryContext as P}from"./contexts/telemetry.js";import{MarkdownAdapterProvider as A}from"./contexts/markdownAdapter.js";import{specTypeAtom as w}from"./jotai/store.js";import{useApiDocsRoutes as U}from"./hooks/useApiDocsRoutes.js";import{useVisitedChannelsTracker as C}from"./hooks/useVisitedChannelsTracker.js";import{useRouterHashBridge as D}from"./hooks/useRouterHashBridge.js";import{useScrollSpyUrlSync as V}from"./hooks/useScrollSpyUrlSync.js";import{useTelemetryPageMetrics as j}from"./hooks/useTelemetryPageMetrics.js";import{useInitialTelemetry as I}from"./hooks/useInitialTelemetry.js";import{EntryPage as k}from"./pages/EntryPage.js";import{ErrorBoundary as B}from"./components/ErrorBoundary.js";import{compose as M}from"./utils/compose.js";import{withRouter as N}from"./hoc/withRouter.js";import{withStoreProvider as O}from"./hoc/withStoreProvider.js";import{withLicenseGate as _}from"./hoc/withLicenseGate.js";import{withReplayPrefetch as E}from"./hoc/withReplayPrefetch.js";const d=e=>{const{items:t=[],basePath:m,markdownAdapter:y,telemetryConfig:r}=e,{routeIndex:g}=U(t,m),s=x(w),i=r?.specType,c=r?.collectorUrl,p=r?.serviceName,n=r?.serviceVersion,l=r?.disabled,a=r?.typeOfUsage,h=S(()=>new b({specType:i??s,collectorUrl:c,serviceName:p,serviceVersion:n,disabled:l,typeOfUsage:a}),[s,i,c,p,n,l,a]);return o(A,{value:y,children:f(P.Provider,{value:h,children:[o(F,{}),o(G,{routeIndex:g,basePath:m})]})})};function F(){return C(),D(),V(),null}const G=({routeIndex:e,basePath:t})=>(j(),I(),f(T,{children:[o(R,{}),o(B,{children:o(k,{routeIndex:e,basePath:t})})]})),u=M(O,N,v,e=>_(e),e=>E(e,{respectHideReplay:!0}))(d);var ne=u;export{u as RedoclyApiDocs,d as RedoclyApiDocsComponent,ne as default};

package/lib/RedoclyApiDocsStandalone.d.ts

@@ -11,6 +11,8 @@ type RedoclyApiDocsStandaloneProps = {
     logo?: RawLogo;
     telemetryConfig?: Partial<RedocTelemetryConfig>;
     markdownAdapter?: MarkdownAdapter;
+    definition?: Record<string, unknown> | string;
+    definitionUrl?: string;
 };
 declare const RedoclyApiDocsStandalone: import("react").FC<any>;
 export { RedoclyApiDocsStandalone };

package/lib/RedoclyApiDocsStandalone.js

@@ -1,4 +1,4 @@
-import{Fragment as j,jsx as o,jsxs as f}from"react/jsx-runtime";import{memo as D,useMemo as a}from"react";import{createMarkdocAdapter as O}from"./components/markdoc/markdocAdapter.js";import{styled as h}from"styled-components";import{useAtomValue as e}from"jotai";import{SidebarLogo as z}from"@redocly/theme/components/SidebarLogo/SidebarLogo";import{ThemeDataContext as I}from"@redocly/theme/core/openapi";import{RedoclyApiDocsComponent as M}from"./RedoclyApiDocs.js";import{SideMenu as P}from"./components/SideMenu/SideMenu.js";import{StickySidebar as T}from"./components/StickySidebar/StickySidebar.js";import{isGraphqlDocsSidebarHidden as H}from"./options/helpers.js";import{toSidebarLogo as R}from"./utils/logo.js";import{globalOptionsAtom as V,licenseKeyAtom as _,storeAtom as F}from"./jotai/store.js";import{collapsedSidebarAtom as K}from"./jotai/app.js";import{useLicense as q}from"./hooks/useLicense.js";import{LicenseOverlay as G}from"./components/LicenseOverlay.js";import{compose as N}from"./utils/compose.js";import{withRouter as Y}from"./hoc/withRouter.js";import{withStoreProvider as $}from"./hoc/withStoreProvider.js";import{useCodeHighlight as B}from"./hooks/useCodeHighlight.js";const E=({children:t})=>{const r=a(()=>({hooks:{useCodeHighlight:()=>({highlight:B})}}),[]);return o(I.Provider,{value:r,children:t})},p=N($,Y,D)(({items:t,basePath:r,logo:g,telemetryConfig:b,markdownAdapter:n})=>{const i=e(V),u=e(F),v=e(_),{isValid:s,licenseInfo:y,isPending:S}=q(v),m=s?t:[],{hideSidebar:x,scrollYOffset:l,markdocOptions:d}=i,A=a(()=>n??O(d),[n,d]),k=e(K),w=!x&&!H(i),L=R(g)??i.apiLogo??u.logo,C=a(()=>{const c=l?.()??0;return c>0?{"--navbar-height":`${c}px`}:void 0},[l]);return o(E,{children:f(J,{style:C,children:[!S&&!s&&o(G,{licenseInfo:y}),w&&o(j,{children:f(T,{className:"menu-content",collapsedSidebar:k,children:[o(z,{dataTestId:"logo",...L}),o(P,{items:m})]})}),o(Q,{children:o(M,{items:m,basePath:r,markdownAdapter:A,telemetryConfig:b})})]})})}),J=h.div`
+import{jsx as o,jsxs as l}from"react/jsx-runtime";import{memo as S,useMemo as i}from"react";import{createMarkdocAdapter as x}from"./components/markdoc/markdocAdapter.js";import{styled as d}from"styled-components";import{useAtomValue as a}from"jotai";import{SidebarLogo as k}from"@redocly/theme/components/SidebarLogo/SidebarLogo";import{ThemeDataContext as A}from"@redocly/theme/core/openapi";import{RedoclyApiDocsComponent as w}from"./RedoclyApiDocs.js";import{SideMenu as L}from"./components/SideMenu/SideMenu.js";import{StickySidebar as C}from"./components/StickySidebar/StickySidebar.js";import{getStandaloneLayoutStyle as j}from"./options/standaloneLayoutVars.js";import{toSidebarLogo as z}from"./utils/logo.js";import{globalOptionsAtom as D,storeAtom as M}from"./jotai/store.js";import{collapsedSidebarAtom as T}from"./jotai/app.js";import{useLicenseGate as O}from"./hooks/useLicenseGate.js";import{compose as P}from"./utils/compose.js";import{withRouter as R}from"./hoc/withRouter.js";import{withStoreProvider as H}from"./hoc/withStoreProvider.js";import{useCodeHighlight as I}from"./hooks/useCodeHighlight.js";const _=({children:e})=>{const r=i(()=>({hooks:{useCodeHighlight:()=>({highlight:I})}}),[]);return o(A.Provider,{value:r,children:e})},c=P(H,R,S)(({items:e,basePath:r,logo:p,telemetryConfig:h,markdownAdapter:n})=>{const t=a(D),f=a(M),{gatedItems:m,overlay:g}=O(e),{markdocOptions:s}=t,b=i(()=>n??x(s),[n,s]),u=a(T),v=z(p)??t.apiLogo??f.logo,y=i(()=>j(t),[t]);return o(_,{children:l(G,{style:y,children:[g,l(C,{className:"menu-content",collapsedSidebar:u,children:[o(k,{dataTestId:"logo",...v}),o(L,{items:m})]}),o(N,{children:o(w,{items:m,basePath:r,markdownAdapter:b,telemetryConfig:h})})]})})}),G=d.div`
   display: flex;
   position: relative;
   min-height: 100vh;
@@ -20,7 +20,7 @@ import{Fragment as j,jsx as o,jsxs as f}from"react/jsx-runtime";import{memo as D
   * {
     box-sizing: border-box;
   }
-`,Q=h.div`
+`,N=d.div`
   flex: 1;
   min-width: 0;
-`;var uo=p;export{p as RedoclyApiDocsStandalone,uo as default};
+`;var ao=c;export{c as RedoclyApiDocsStandalone,ao as default};

package/lib/adapters/asyncapi/build/navigation.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as I}from"@redocly/config";import{combineUrls as T}from"@redocly/theme/core/openapi";import{contentType as k,nodeTypes as l}from"../../../types/common.js";import{asString as x,safeSlugify as u}from"../../../utils/string.js";import{buildMarkdownSectionItem as E,extractMarkdownSections as L,extractContentUntilFirstHeading as A,extractSummaryText as O}from"../../utils/markdoc.js";import{parseMarkdown as M}from"../../utils/parseMarkdown.js";import{itemLabelsByProtocol as D}from"../utils/get-protocol-labels.js";import{buildTaggedChannelItem as R,buildUntaggedChannelItem as v}from"../items/channel/item.js";import{asyncApiContext as P}from"../buildContext.js";import{buildGroupItemsPanel as N}from"../panels/group.js";function Y(){const n=P.get(),{document:a,basePath:m,channelToOperations:S,protocol:g,processContent:f}=n,w=a.channels||{},d=a.components?.tags||{},h=new Map;for(const[t,e]of Object.entries(S)){const o=w[t];if(!o)continue;const r=[];for(const s of o.tags??[]){const p=x(s?.name);p&&r.push(p)}const i=`${D(g,o.bindings).channel}s`;for(const s of r){const p=u(s).toLowerCase();n.groups[s]||(n.groups[s]=[]);const y=T(m,p,i,t).toLowerCase(),C=x(o.summary)??O(o.description,n.options);C&&n.channelSummaries.set(y,C),h.set(y,o),n.groups[s].push(R({channelId:t,channel:o,operationIds:e,tagName:s}))}r.length||n.items.push(v({channelId:t,channel:o,operationIds:e}))}if(f)for(const t of Object.keys(n.groups)){const e=d[t];for(const o of L(e?.description,n.options,u(t).toLowerCase()))n.groups[t].push(E({heading:o,basePath:m}))}const b=[...Object.keys(n.groups).map(t=>{const e=n.groups[t],o=T(m,u(t)).toLowerCase(),r=d[t],c=n.options,i=r?.externalDocs,s=A(r?.description,c);return{label:t,type:"group",link:o,routeSlug:o,items:e,content:f?{contentType:k.GROUP,children:[{nodeType:l.CONTAINER,children:[{nodeType:l.HEADER,level:2,label:t,showPageActions:!0},...s?[{nodeType:l.MARKDOC,content:s}]:[],...i?.url?[{nodeType:l.EXTERNAL_DOCS,url:i.url,description:M(i.description,c)??[]}]:[]],panels:[{children:[N({group:e,protocol:g,channelByLink:h,context:n})]}]}]}:null}}),...n.items];if(a["x-tagGroups"]&&a["x-tagGroups"].length>0){const t=[],e=new Map;return b.forEach(o=>{o.label&&e.set(o.label,o)}),a["x-tagGroups"].forEach(o=>{t.push({label:o.name,type:"separator",[I]:o[I],content:null}),o.tags.forEach(r=>{const c=e.get(r);c&&t.push(c)})}),t}return b}export{Y as buildNavigationItems};
+import{combineUrls as I}from"@redocly/theme/core/openapi";import{contentType as w,nodeTypes as l}from"../../../types/common.js";import{asString as x,safeSlugify as u}from"../../../utils/string.js";import{buildMarkdownSectionItem as k,extractMarkdownSections as L,extractContentUntilFirstHeading as E,extractSummaryText as O}from"../../utils/markdoc.js";import{parseMarkdown as A}from"../../utils/parseMarkdown.js";import{readRbacScope as M,rbacProp as D}from"../../rbac.js";import{itemLabelsByProtocol as P}from"../utils/get-protocol-labels.js";import{buildTaggedChannelItem as R,buildUntaggedChannelItem as v}from"../items/channel/item.js";import{asyncApiContext as N}from"../buildContext.js";import{buildGroupItemsPanel as U}from"../panels/group.js";function q(){const n=N.get(),{document:a,basePath:m,channelToOperations:S,protocol:g,processContent:f}=n,T=a.channels||{},d=a.components?.tags||{},h=new Map;for(const[t,e]of Object.entries(S)){const o=T[t];if(!o)continue;const r=[];for(const s of o.tags??[]){const p=x(s?.name);p&&r.push(p)}const i=`${P(g,o.bindings).channel}s`;for(const s of r){const p=u(s).toLowerCase();n.groups[s]||(n.groups[s]=[]);const y=I(m,p,i,t).toLowerCase(),C=x(o.summary)??O(o.description,n.options);C&&n.channelSummaries.set(y,C),h.set(y,o),n.groups[s].push(R({channelId:t,channel:o,operationIds:e,tagName:s}))}r.length||n.items.push(v({channelId:t,channel:o,operationIds:e}))}if(f)for(const t of Object.keys(n.groups)){const e=d[t];for(const o of L(e?.description,n.options,u(t).toLowerCase()))n.groups[t].push(k({heading:o,basePath:m}))}const b=[...Object.keys(n.groups).map(t=>{const e=n.groups[t],o=I(m,u(t)).toLowerCase(),r=d[t],c=n.options,i=r?.externalDocs,s=E(r?.description,c);return{label:t,type:"group",link:o,routeSlug:o,items:e,content:f?{contentType:w.GROUP,children:[{nodeType:l.CONTAINER,children:[{nodeType:l.HEADER,level:2,label:t,showPageActions:!0},...s?[{nodeType:l.MARKDOC,content:s}]:[],...i?.url?[{nodeType:l.EXTERNAL_DOCS,url:i.url,description:A(i.description,c)??[]}]:[]],panels:[{children:[U({group:e,protocol:g,channelByLink:h,context:n})]}]}]}:null}}),...n.items];if(a["x-tagGroups"]&&a["x-tagGroups"].length>0){const t=[],e=new Map;return b.forEach(o=>{o.label&&e.set(o.label,o)}),a["x-tagGroups"].forEach(o=>{t.push({label:o.name,type:"separator",...D(M(o)),content:null}),o.tags.forEach(r=>{const c=e.get(r);c&&t.push(c)})}),t}return b}export{q as buildNavigationItems};

package/lib/adapters/asyncapi/items/channel/content.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as w}from"@redocly/config";import{combineUrls as Q}from"@redocly/theme/core/openapi";import{asString as G,safeSlugify as ne}from"../../../../utils/string.js";import{normalizePath as te}from"../../../../utils/url.js";import{JsonPointer as ae}from"../../../openapi/utils/JsonPointer.js";import{contentType as oe,itemVariant as ie,nodeTypes as c,panelKind as R,schemaKind as v}from"../../../../types/common.js";import{registerSchema as B,registerExample as re,readRbacScope as O,rbacProp as b,splitRbacSection as J}from"../../../helpers.js";import{parseMarkdown as I}from"../../../utils/parseMarkdown.js";import{componentLabelsByProtocol as le,itemLabelsByProtocol as ce}from"../../utils/get-protocol-labels.js";import{resolveInDoc as $}from"../../utils/resolveInDoc.js";import{getServerHost as H}from"../../utils/get-server-host.js";import{resolveAsyncApiSchema as Y}from"../../utils/resolve-schema.js";import{getChannelLabel as W}from"../../utils/get-channel-label.js";import{asyncApiContext as pe}from"../../buildContext.js";function de(S,n,f){const l={exchanges:[],queues:[]};if(!S.channels)return l;for(const[h,a]of Object.entries(S.channels)){if(!a?.messages?.[n])continue;const E=`${ce(f??null,a.bindings).channel}s`,i=a.tags?.map(N=>G(N?.name)).find(Boolean),p=i?ne(i).toLowerCase():void 0,k=te(p?Q(p,E,h).toLowerCase():Q(E,h).toLowerCase()),C={key:h,label:W(a,h),link:k};a.bindings?.amqp?.is==="routingKey"?l.exchanges.push(C):l.queues.push(C)}return l}function Re(S,n,f,l,h){const{storeCtx:a}=pe.get(),L=[],E=W(n,S),i=le({protocol:h??null,channelBindings:n.bindings}),p=[{nodeType:c.HEADER,level:2,label:E,badges:n["x-badges"],showPageActions:!0,protocolTag:{label:i.channel,color:i.channel.toLowerCase()}}],k=G(n.address);k&&p.push({nodeType:c.CHANNEL_ADDRESS,address:k});const C=I(n.summary,l);C&&p.push({nodeType:c.MARKDOC,content:C});const N=I(n.description,l);N&&p.push({nodeType:c.MARKDOC,content:N});const j=n.externalDocs;if(j?.url&&p.push({nodeType:c.EXTERNAL_DOCS,url:j.url,description:I(j.description,l)??[]}),n.parameters&&Object.keys(n.parameters).length>0){const{sectionRbac:d,entries:x}=J(n.parameters),g=x.map(([u,o])=>{const e=$(f,o)??o,m={type:e.location||"string"};e.enum&&(m.enum=e.enum),e.default!==void 0&&(m.default=e.default),e.description&&(m.description=e.description),e.examples?.length&&(m.examples=e.examples);const P=B(a.schemaStore,a.hashIndex,{kind:v.JSON_SCHEMA,data:m});return{name:u,in:"path",schemaId:P,description:e.description,...b(O(e))}});p.push({nodeType:c.HEADER,level:4,label:"Parameters",labelTranslationKey:"parameters",deepLinkSuffix:"parameters",...b(d)},{nodeType:c.ITEM,variant:"parameters",parameters:g,pointer:`channels/${S}/parameters`,...b(d)})}const D=[];if(f.servers&&n.servers){const d=n.servers.map(o=>$(f,o)).filter(o=>!!o&&!!H(o)),{sectionRbac:x,entries:g}=J(f.servers),u=g.filter(([,o])=>d.some(e=>H(e)===H(o)));u.length>0&&D.push({children:[{kind:R.BROKERS,panelLabel:i.servers,brokers:u.map(([o,e])=>({name:o,url:H(e),description:I(e.description,l)??[],protocol:e.protocol,protocolVersion:e.protocolVersion,pathname:e.pathname,title:e.title,summary:e.summary,tags:e.tags,externalDocs:e.externalDocs,bindings:e.bindings,variables:e.variables,...b(O(e)??x)}))}]})}if(n.bindings){const d=Object.entries(n.bindings);if(d.length>0){const[x,g]=d[0];D.push({title:i.channelBinding,children:[{kind:R.CHANNEL_BINDING,panelLabel:i.channelBinding,bindingKey:x,bindingValue:g}]})}}if(L.push({nodeType:c.CONTAINER,children:p,panels:D.length>0?D:void 0}),n.messages&&Object.keys(n.messages).length>0){const{sectionRbac:d,entries:x}=J(n.messages),g=[{nodeType:c.HEADER,level:4,label:"Messages",labelTranslationKey:"messages",deepLinkSuffix:"messages"}],u={},o=x.map(([t,y])=>{const s=$(f,y)??y;let A,F;const _=[],U=O(y)??O(s);if(a&&s.payload&&typeof s.payload=="object"){const r=Y(s.payload);r&&(A=B(a.schemaStore,a.hashIndex,{kind:v.JSON_SCHEMA,data:r}))}if(a&&s.headers&&typeof s.headers=="object"){const r=Y(s.headers);r&&(F=B(a.schemaStore,a.hashIndex,{kind:v.JSON_SCHEMA,data:r}))}if(a&&s.examples&&Array.isArray(s.examples)){for(const r of s.examples)if(r.payload){const M=re(a.exampleStore,{value:r.payload,summary:r.summary||r.name});_.push(M)}}if(a&&s.bindings){const r=Object.entries(s.bindings);for(const[M,K]of r){if(!K||typeof K!="object")continue;let X;if(M==="kafka"){const q=K.key;if(q&&typeof q=="object"){const se=Y(q);X=B(a.schemaStore,a.hashIndex,{kind:v.JSON_SCHEMA,data:{type:"object",properties:{key:se}}})}}u[t]={bindingKey:M,bindingValue:K,keySchemaId:X,...b(U)};break}}const V=s.externalDocs,ee=V?.url?{url:V.url,description:I(V.description,l)??[]}:void 0;return{name:t,label:s.title||s.name||t,summary:typeof s.summary=="string"?s.summary:void 0,description:I(s.description,l),contentType:s.contentType,schemaId:A,headerSchemaId:F,exampleIds:_.length>0?_:void 0,payload:s.payload,payloadLabel:i.payload,headers:s.headers,externalDocs:ee,...b(U)}});g.push({nodeType:c.ITEM,variant:"messages",messages:o,pointer:`channels/${S}/messages`});const e=o.filter(t=>!t[w]),m=e.flatMap(t=>t.exampleIds??[]),P=e.find(t=>t.schemaId)?.schemaId,Z=o.some(t=>t.schemaId||(t.exampleIds?.length??0)>0),z={};for(const t of o){const y=t[w];z[t.name]={schemaId:t.schemaId,exampleIds:t.exampleIds,...b(y)}}const T=[];if(Z&&T.push({children:[{kind:R.PAYLOAD,panelLabel:i.payload,exampleIds:m.length>0?m:void 0,schemaId:P,examples:m.map(()=>({})),messagesByKey:z}]}),Object.keys(u).length>0&&T.push({title:"Message configuration",children:[{kind:R.MESSAGE_BINDING,bindingsByMessageKey:u}]}),h==="amqp"){const t={};let y=!1;for(const s of o){const A=de(f,s.name,h);(A.exchanges.length>0||A.queues.length>0)&&(t[s.name]=A,y=!0)}y&&T.push({children:[{kind:R.MESSAGE_REFERENCES,referencesByMessageKey:t}]})}L.push({nodeType:c.CONTAINER,children:g,panels:T.length>0?T:void 0,...b(d)})}return{contentType:oe.ITEM,itemVariant:ie.CHANNEL,meta:{name:E,pointer:ae.compile(["channels",S]),protocolTag:{label:i.channel,color:i.channel.toLowerCase()}},seo:{title:E,description:G(n.description)},children:L}}export{Re as buildChannelContent,de as buildMessageReferencesGroups};
+import{combineUrls as w}from"@redocly/theme/core/openapi";import{asString as G,safeSlugify as se}from"../../../../utils/string.js";import{normalizePath as ne}from"../../../../utils/url.js";import{JsonPointer as te}from"../../../openapi/utils/JsonPointer.js";import{contentType as ae,itemVariant as oe,nodeTypes as c,panelKind as R,schemaKind as B}from"../../../../types/common.js";import{registerSchema as H,registerExample as ie}from"../../../helpers.js";import{readRbacScope as k,rbacProp as b,hasRbacScope as re,splitRbacSection as J}from"../../../rbac.js";import{parseMarkdown as A}from"../../../utils/parseMarkdown.js";import{componentLabelsByProtocol as le,itemLabelsByProtocol as ce}from"../../utils/get-protocol-labels.js";import{resolveInDoc as $}from"../../utils/resolveInDoc.js";import{getServerHost as O}from"../../utils/get-server-host.js";import{resolveAsyncApiSchema as z}from"../../utils/resolve-schema.js";import{getChannelLabel as Q}from"../../utils/get-channel-label.js";import{asyncApiContext as pe}from"../../buildContext.js";function de(S,n,f){const l={exchanges:[],queues:[]};if(!S.channels)return l;for(const[h,a]of Object.entries(S.channels)){if(!a?.messages?.[n])continue;const E=`${ce(f??null,a.bindings).channel}s`,i=a.tags?.map(D=>G(D?.name)).find(Boolean),p=i?se(i).toLowerCase():void 0,N=ne(p?w(p,E,h).toLowerCase():w(E,h).toLowerCase()),C={key:h,label:Q(a,h),link:N};a.bindings?.amqp?.is==="routingKey"?l.exchanges.push(C):l.queues.push(C)}return l}function Re(S,n,f,l,h){const{storeCtx:a}=pe.get(),L=[],E=Q(n,S),i=le({protocol:h??null,channelBindings:n.bindings}),p=[{nodeType:c.HEADER,level:2,label:E,badges:n["x-badges"],showPageActions:!0,protocolTag:{label:i.channel,color:i.channel.toLowerCase()}}],N=G(n.address);N&&p.push({nodeType:c.CHANNEL_ADDRESS,address:N});const C=A(n.summary,l);C&&p.push({nodeType:c.MARKDOC,content:C});const D=A(n.description,l);D&&p.push({nodeType:c.MARKDOC,content:D});const j=n.externalDocs;if(j?.url&&p.push({nodeType:c.EXTERNAL_DOCS,url:j.url,description:A(j.description,l)??[]}),n.parameters&&Object.keys(n.parameters).length>0){const{sectionRbac:d,entries:x}=J(n.parameters),g=x.map(([u,o])=>{const e=$(f,o)??o,m={type:e.location||"string"};e.enum&&(m.enum=e.enum),e.default!==void 0&&(m.default=e.default),e.description&&(m.description=e.description),e.examples?.length&&(m.examples=e.examples);const P=H(a.schemaStore,a.hashIndex,{kind:B.JSON_SCHEMA,data:m});return{name:u,in:"path",schemaId:P,description:e.description,...b(k(e))}});p.push({nodeType:c.HEADER,level:4,label:"Parameters",labelTranslationKey:"parameters",deepLinkSuffix:"parameters",...b(d)},{nodeType:c.ITEM,variant:"parameters",parameters:g,pointer:`channels/${S}/parameters`,...b(d)})}const M=[];if(f.servers&&n.servers){const d=n.servers.map(o=>$(f,o)).filter(o=>!!o&&!!O(o)),{sectionRbac:x,entries:g}=J(f.servers),u=g.filter(([,o])=>d.some(e=>O(e)===O(o)));u.length>0&&M.push({children:[{kind:R.BROKERS,panelLabel:i.servers,brokers:u.map(([o,e])=>({name:o,url:O(e),description:A(e.description,l)??[],protocol:e.protocol,protocolVersion:e.protocolVersion,pathname:e.pathname,title:e.title,summary:e.summary,tags:e.tags,externalDocs:e.externalDocs,bindings:e.bindings,variables:e.variables,...b(k(e)??x)}))}]})}if(n.bindings){const d=Object.entries(n.bindings);if(d.length>0){const[x,g]=d[0];M.push({title:i.channelBinding,children:[{kind:R.CHANNEL_BINDING,panelLabel:i.channelBinding,bindingKey:x,bindingValue:g}]})}}if(L.push({nodeType:c.CONTAINER,children:p,panels:M.length>0?M:void 0}),n.messages&&Object.keys(n.messages).length>0){const{sectionRbac:d,entries:x}=J(n.messages),g=[{nodeType:c.HEADER,level:4,label:"Messages",labelTranslationKey:"messages",deepLinkSuffix:"messages"}],u={},o=x.map(([t,y])=>{const s=$(f,y)??y;let I,U;const _=[],X=k(y)??k(s);if(a&&s.payload&&typeof s.payload=="object"){const r=z(s.payload);r&&(I=H(a.schemaStore,a.hashIndex,{kind:B.JSON_SCHEMA,data:r}))}if(a&&s.headers&&typeof s.headers=="object"){const r=z(s.headers);r&&(U=H(a.schemaStore,a.hashIndex,{kind:B.JSON_SCHEMA,data:r}))}if(a&&s.examples&&Array.isArray(s.examples)){for(const r of s.examples)if(r.payload){const K=ie(a.exampleStore,{value:r.payload,summary:r.summary||r.name});_.push(K)}}if(a&&s.bindings){const r=Object.entries(s.bindings);for(const[K,v]of r){if(!v||typeof v!="object")continue;let Y;if(K==="kafka"){const q=v.key;if(q&&typeof q=="object"){const ee=z(q);Y=H(a.schemaStore,a.hashIndex,{kind:B.JSON_SCHEMA,data:{type:"object",properties:{key:ee}}})}}u[t]={bindingKey:K,bindingValue:v,keySchemaId:Y,...b(X)};break}}const V=s.externalDocs,Z=V?.url?{url:V.url,description:A(V.description,l)??[]}:void 0;return{name:t,label:s.title||s.name||t,summary:typeof s.summary=="string"?s.summary:void 0,description:A(s.description,l),contentType:s.contentType,schemaId:I,headerSchemaId:U,exampleIds:_.length>0?_:void 0,payload:s.payload,payloadLabel:i.payload,headers:s.headers,externalDocs:Z,...b(X)}});g.push({nodeType:c.ITEM,variant:"messages",messages:o,pointer:`channels/${S}/messages`});const e=o.filter(t=>!re(t)),m=e.flatMap(t=>t.exampleIds??[]),P=e.find(t=>t.schemaId)?.schemaId,W=o.some(t=>t.schemaId||(t.exampleIds?.length??0)>0),F={};for(const t of o){const y=k(t);F[t.name]={schemaId:t.schemaId,exampleIds:t.exampleIds,...b(y)}}const T=[];if(W&&T.push({children:[{kind:R.PAYLOAD,panelLabel:i.payload,exampleIds:m.length>0?m:void 0,schemaId:P,examples:m.map(()=>({})),messagesByKey:F}]}),Object.keys(u).length>0&&T.push({title:"Message configuration",children:[{kind:R.MESSAGE_BINDING,bindingsByMessageKey:u}]}),h==="amqp"){const t={};let y=!1;for(const s of o){const I=de(f,s.name,h);(I.exchanges.length>0||I.queues.length>0)&&(t[s.name]=I,y=!0)}y&&T.push({children:[{kind:R.MESSAGE_REFERENCES,referencesByMessageKey:t}]})}L.push({nodeType:c.CONTAINER,children:g,panels:T.length>0?T:void 0,...b(d)})}return{contentType:ae.ITEM,itemVariant:oe.CHANNEL,meta:{name:E,pointer:te.compile(["channels",S]),protocolTag:{label:i.channel,color:i.channel.toLowerCase()}},seo:{title:E,description:G(n.description)},children:L}}export{Re as buildChannelContent,de as buildMessageReferencesGroups};

package/lib/adapters/asyncapi/items/channel/item.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as S}from"@redocly/config";import{combineUrls as h}from"@redocly/theme/core/openapi";import{asString as D,safeSlugify as T}from"../../../../utils/string.js";import{componentLabelsByProtocol as x,itemLabelsByProtocol as y}from"../../utils/get-protocol-labels.js";import{buildChannelContent as B}from"./content.js";import{buildOperationItem as O}from"../operation/item.js";import{asyncApiContext as k}from"../../buildContext.js";import{resolveItemSeo as E}from"../../../utils/seo.js";import{extractSeoDescriptionText as R}from"../../../utils/markdoc.js";import{getChannelLabel as U}from"../../utils/get-channel-label.js";function P(o,e,r){const n=U(o,e),s=R(o.description,r)??D(o.summary);return{label:n,seo:E(o,{title:n,description:s})}}function w(o,e,r){const n=o.filter(t=>e[t]?.action==="send"),s=o.filter(t=>e[t]?.action==="receive");return[...n,...s].map(t=>n[0]===t?{operationId:t,groupHeaderLabel:r.send}:s[0]===t?{operationId:t,groupHeaderLabel:r.receive}:{operationId:t})}function F({channelId:o,channel:e,operationIds:r,tagName:n}){const{document:s,basePath:i,options:t,protocol:l,processContent:a}=k.get(),d=s.operations||{},f=r.length>0,c=y(l??null,e.bindings),p=x({protocol:l??null,channelBindings:e.bindings}),m=`${c.channel}s`,u=T(n).toLowerCase(),L=h(i,u,m,o).toLowerCase(),C=w(r,d,{send:p.sendLabel,receive:p.receiveLabel}),{label:b,seo:v}=P(e,o,t);return{label:b,type:"group",link:L,routeSlug:L,badges:e?.["x-badges"]||[],httpVerb:c.channel,metadata:{seo:v},content:a?B(o,e,s,t,l):null,[S]:e?.[S],...f?{items:C.map(({operationId:g,groupHeaderLabel:H},A)=>O({operationId:g,operation:d[g],linkParts:[i,u,m,o,"operations",g],channelBindings:e.bindings,document:s,options:t,protocol:l,groupHeaderLabel:H,processContent:a,showDivider:A!==C.length-1}))}:{}}}function J({channelId:o,channel:e,operationIds:r}){const{document:n,basePath:s,options:i,protocol:t,processContent:l}=k.get(),a=n.operations||{},d=r.length>0,f=y(t??null,e.bindings),c=x({protocol:t??null,channelBindings:e.bindings}),p=`${f.channel}s`,m=h(s,p,o).toLowerCase(),u=w(r,a,{send:c.sendLabel,receive:c.receiveLabel}),{label:L,seo:C}=P(e,o,i);return{label:L,type:"group",link:m,routeSlug:m,httpVerb:f.channel,badges:e?.["x-badges"]||[],metadata:{seo:C},[S]:e?.[S],content:l?B(o,e,n,i,t):null,...d?{items:u.map(({operationId:b,groupHeaderLabel:v},g)=>O({operationId:b,operation:a[b],linkParts:[s,p,o,"operations",b],channelBindings:e.bindings,document:n,options:i,protocol:t,groupHeaderLabel:v,processContent:l,showDivider:g!==u.length-1}))}:{}}}export{F as buildTaggedChannelItem,J as buildUntaggedChannelItem};
+import{combineUrls as v}from"@redocly/theme/core/openapi";import{asString as T,safeSlugify as U}from"../../../../utils/string.js";import{componentLabelsByProtocol as h,itemLabelsByProtocol as x}from"../../utils/get-protocol-labels.js";import{buildChannelContent as y}from"./content.js";import{buildOperationItem as P}from"../operation/item.js";import{asyncApiContext as k}from"../../buildContext.js";import{readRbacScope as B,rbacProp as O}from"../../../rbac.js";import{resolveItemSeo as V}from"../../../utils/seo.js";import{extractSeoDescriptionText as $}from"../../../utils/markdoc.js";import{getChannelLabel as G}from"../../utils/get-channel-label.js";function w(o,e,r){const n=G(o,e),s=$(o.description,r)??T(o.summary);return{label:n,seo:V(o,{title:n,description:s})}}function H(o,e,r){const n=o.filter(t=>e[t]?.action==="send"),s=o.filter(t=>e[t]?.action==="receive");return[...n,...s].map(t=>n[0]===t?{operationId:t,groupHeaderLabel:r.send}:s[0]===t?{operationId:t,groupHeaderLabel:r.receive}:{operationId:t})}function N({channelId:o,channel:e,operationIds:r,tagName:n}){const{document:s,basePath:i,options:t,protocol:l,processContent:a}=k.get(),d=s.operations||{},f=r.length>0,c=x(l??null,e.bindings),p=h({protocol:l??null,channelBindings:e.bindings}),m=`${c.channel}s`,b=U(n).toLowerCase(),L=v(i,b,m,o).toLowerCase(),C=H(r,d,{send:p.sendLabel,receive:p.receiveLabel}),{label:u,seo:S}=w(e,o,t);return{label:u,type:"group",link:L,routeSlug:L,badges:e?.["x-badges"]||[],httpVerb:c.channel,metadata:{seo:S},content:a?y(o,e,s,t,l):null,...O(B(e)),...f?{items:C.map(({operationId:g,groupHeaderLabel:D},A)=>P({operationId:g,operation:d[g],linkParts:[i,b,m,o,"operations",g],channelBindings:e.bindings,document:s,options:t,protocol:l,groupHeaderLabel:D,processContent:a,showDivider:A!==C.length-1}))}:{}}}function Q({channelId:o,channel:e,operationIds:r}){const{document:n,basePath:s,options:i,protocol:t,processContent:l}=k.get(),a=n.operations||{},d=r.length>0,f=x(t??null,e.bindings),c=h({protocol:t??null,channelBindings:e.bindings}),p=`${f.channel}s`,m=v(s,p,o).toLowerCase(),b=H(r,a,{send:c.sendLabel,receive:c.receiveLabel}),{label:L,seo:C}=w(e,o,i);return{label:L,type:"group",link:m,routeSlug:m,httpVerb:f.channel,badges:e?.["x-badges"]||[],metadata:{seo:C},...O(B(e)),content:l?y(o,e,n,i,t):null,...d?{items:b.map(({operationId:u,groupHeaderLabel:S},g)=>P({operationId:u,operation:a[u],linkParts:[s,p,o,"operations",u],channelBindings:e.bindings,document:n,options:i,protocol:t,groupHeaderLabel:S,processContent:l,showDivider:g!==b.length-1}))}:{}}}export{N as buildTaggedChannelItem,Q as buildUntaggedChannelItem};

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

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as l}from"@redocly/config";import{combineUrls as C}from"@redocly/theme/core/openapi";import{asString as e}from"../../../../utils/string.js";import{itemLabelsByProtocol as L}from"../../utils/get-protocol-labels.js";import{resolveItemSeo as k}from"../../../utils/seo.js";import{extractSeoDescriptionText as O}from"../../../utils/markdoc.js";import{buildOperationContent as P}from"./content.js";function h({operationId:m,operation:t,linkParts:n,channelBindings:c,document:a,options:o,protocol:s,groupHeaderLabel:f,processContent:u=!0,showDivider:b}){const d=L(s??null,c),[p,...S]=n;let r=p??"";for(const y of S)r=C(r,y);r=r.toLowerCase();const i=e(t.title)??e(t.summary)??m,g=O(t.description,o)??e(t.summary),x=k(t,{title:i,description:g});return{label:i,type:"link",link:r,routeSlug:r,httpVerb:d[t.action]||"",badges:t?.["x-badges"]||[],metadata:{seo:x},[l]:t?.[l],content:u?P(m,t,a,r,o,s,f,b):null}}export{h as buildOperationItem};
+import{combineUrls as y}from"@redocly/theme/core/openapi";import{asString as e}from"../../../../utils/string.js";import{itemLabelsByProtocol as P}from"../../utils/get-protocol-labels.js";import{readRbacScope as k,rbacProp as L}from"../../../rbac.js";import{resolveItemSeo as C}from"../../../utils/seo.js";import{extractSeoDescriptionText as O}from"../../../utils/markdoc.js";import{buildOperationContent as h}from"./content.js";function U({operationId:o,operation:t,linkParts:l,channelBindings:c,document:n,options:m,protocol:s,groupHeaderLabel:a,processContent:b=!0,showDivider:f}){const u=P(s??null,c),[p,...d]=l;let r=p??"";for(const x of d)r=y(r,x);r=r.toLowerCase();const i=e(t.title)??e(t.summary)??o,S=O(t.description,m)??e(t.summary),g=C(t,{title:i,description:S});return{label:i,type:"link",link:r,routeSlug:r,httpVerb:u[t.action]||"",badges:t?.["x-badges"]||[],metadata:{seo:g},...L(k(t)),content:b?h(o,t,n,r,m,s,a,f):null}}export{U as buildOperationItem};

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

@@ -1 +1 @@
-import{extractContentUntilFirstHeading as u}from"../../../utils/markdoc.js";import{parseMarkdown as T}from"../../../utils/parseMarkdown.js";import{contentType as h,nodeTypes as n}from"../../../../types/common.js";import{buildDownloadPanelContent as C}from"../../panels/download.js";import{buildOverviewPanelContent as R}from"../../panels/overview.js";import{buildBrokersPanelContent as v}from"../../panels/brokers.js";import{buildInfoMetadataContentNode as I}from"../../../utils/infoMetadata.js";function V({document:t,options:o,protocol:a,sectionChildren:p,basePath:s}){const e=t.info,c=u(e?.description,o),f=[C(o.downloadUrls??[]),R(e),...t.servers?[v(t.servers,a,o)]:[]],r={nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.HEADER,showPageActions:!0,level:1,label:`${e?.title??""} ${e?.version??""}`.trim()}],sectionId:s};c?.length&&r.children.push({nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.MARKDOC,content:c}],sectionId:s});const i=e?.externalDocs;if(i?.url){const m=T(i.description,o)??[];r.children.push({nodeType:n.EXTERNAL_DOCS,url:i.url,description:m})}const l=I(e,o.hideInfoMetadata),d=[r];l&&d.push(l),d.push(...p);const E={nodeType:n.CONTAINER,panels:f,children:d};return{contentType:h.OVERVIEW,children:[E]}}export{V as buildOverviewContent};
+import{extractContentUntilFirstHeading as u}from"../../../utils/markdoc.js";import{parseMarkdown as T}from"../../../utils/parseMarkdown.js";import{contentType as h,nodeTypes as n}from"../../../../types/common.js";import{buildDownloadPanelContent as C}from"../../panels/download.js";import{buildOverviewPanelContent as R}from"../../panels/overview.js";import{buildBrokersPanelContent as v}from"../../panels/brokers.js";import{buildInfoMetadataContentNode as I}from"../../../utils/infoMetadata.js";function V({document:t,options:o,protocol:a,sectionChildren:p,basePath:s}){const e=t.info,c=u(e?.description,o),f=[C(o.downloadUrls??[]),R(e),...t.servers?[v(t.servers,a,o)]:[]],r={nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.HEADER,showPageActions:!0,level:1,label:`${e?.title??""} ${e?.version??""}`.trim()}],sectionId:s};c?.length&&r.children.push({nodeType:n.OVERVIEW_SECTION_WRAPPER,children:[{nodeType:n.MARKDOC,content:c}],sectionId:s});const i=e?.externalDocs;if(i?.url){const m=T(i.description,o)??[];r.children.push({nodeType:n.EXTERNAL_DOCS,url:i.url,description:m})}const d=[r],l=I(e,o.hideInfoMetadata);l&&d.push(l),d.push(...p);const E={nodeType:n.CONTAINER,panels:f,children:d};return{contentType:h.OVERVIEW,children:[E]}}export{V as buildOverviewContent};

package/lib/adapters/graphql/group/utils.js

@@ -1 +1 @@
-import{contentType as s,nodeTypes as a}from"../../../types/common.js";import{safeSlugify as c}from"../../../utils/string.js";import{joinWithSeparator as m}from"../../../utils/url.js";import{DEFAULT_GROUP_LABELS as u}from"../utils/constants.js";import{buildGroupItemsPanelContent as f}from"../panels/group-items.js";import{graphqlContext as g}from"../buildContext.js";function y({typeGroup:e,items:n,label:r,parentPath:p}){const t=g.get(),o=r??(e?u[e]:"Overview"),l=r?void 0:e?o.toLowerCase():"info.title",i=m(p??t.basePath,c(o?.toLowerCase()));return{type:"group",label:o,labelTranslationKey:l,link:i,routeSlug:i,items:n,content:t.processContent?{contentType:s.GROUP,children:[{nodeType:a.CONTAINER,children:[{nodeType:a.HEADER,level:2,label:o,labelTranslationKey:l,showPageActions:!0}],panels:[f(n,t,e)]}]}:null}}export{y as createGroup};
+import{contentType as m,nodeTypes as l}from"../../../types/common.js";import{safeSlugify as p}from"../../../utils/string.js";import{joinWithSeparator as u}from"../../../utils/url.js";import{itemVariant as e}from"../../../types/common.js";import{DEFAULT_GROUP_LABELS as T}from"../utils/constants.js";import{buildGroupItemsPanelContent as E}from"../panels/group-items.js";import{graphqlContext as f}from"../buildContext.js";const A={[e.QUERY]:"queries",[e.MUTATION]:"mutations",[e.SUBSCRIPTION]:"subscriptions",[e.DIRECTIVE]:"directives",[e.OBJECT]:"objects",[e.INTERFACE]:"interfaces",[e.INPUT]:"inputs",[e.UNION]:"unions",[e.ENUM]:"enums",[e.SCALAR]:"scalars"};function d({typeGroup:t,items:r,label:i,parentPath:c}){const o=f.get(),n=i??(t?T[t]:"Overview"),s=i?void 0:t?A[t]:"info.title",a=u(c??o.basePath,p(n?.toLowerCase()));return{type:"group",label:n,labelTranslationKey:s,link:a,routeSlug:a,items:r,content:o.processContent?{contentType:m.GROUP,children:[{nodeType:l.CONTAINER,children:[{nodeType:l.HEADER,level:2,label:n,labelTranslationKey:s,showPageActions:!0}],panels:[E(r,o,t)]}]}:null}}export{d as createGroup};

package/lib/adapters/graphql/utils/createApiItem.js

@@ -1 +1 @@
-import{itemVariant as n}from"../../../types/common.js";import{safeSlugify as d}from"../../../utils/string.js";import{joinWithSeparator as f,normalizePath as m,toRelativePath as C}from"../../../utils/url.js";import{shouldIncludeItem as a}from"../utils/shouldIncludeItem.js";import{appendGraphqlItemFeedback as s}from"./appendGraphqlItemFeedback.js";import{buildDirectiveContent as I}from"../items/directive/content.js";import{buildQueryContent as T}from"../items/query/content.js";import{buildMutationContent as b}from"../items/mutation/content.js";import{buildSubscriptionContent as N}from"../items/subscription/content.js";import{buildUnionContent as E}from"../items/union/content.js";import{buildEnumContent as p}from"../items/enum/content.js";import{buildScalarContent as h}from"../items/scalar/content.js";import{buildInputContent as P}from"../items/input/content.js";import{buildObjectContent as S}from"../items/object/content.js";import{buildInterfaceContent as U}from"../items/interface/content.js";import{graphqlContext as A}from"../buildContext.js";const R={[n.QUERY]:"queries",[n.MUTATION]:"mutations",[n.SUBSCRIPTION]:"subscriptions",[n.DIRECTIVE]:"directives",[n.OBJECT]:"objects",[n.INTERFACE]:"interfaces",[n.UNION]:"unions",[n.ENUM]:"enums",[n.INPUT]:"inputs",[n.SCALAR]:"scalars"};function $(e){const t=A.get(),i=`${e.variant}:${e.name}`;if(e.processedItems?.has(i)||(e.filter||e.menuCommonFilter)&&!a(e.name,e.filter,e.menuCommonFilter))return null;const o=e.parentPath?e.parentPath:f(t.basePath,R[e.variant]),u=f(o,d(e.name.toLowerCase())),l=e.label??e.name;if(e.processedItems?.add(i),!t.processContent)return{type:"link",label:l,link:u,routeSlug:u,...e.deprecated&&{deprecated:!0},content:null};let r=g({variant:e.variant,source:e.source,name:e.name,markdownOptions:t.options});t.options.feedback?.hide!==!0&&r&&(r=s(r,m(C(u,t.basePath))));const c=v(e.source);return c&&r?.meta&&(r.meta.position=c),{type:"link",label:l,link:u,routeSlug:u,...e.deprecated&&{deprecated:!0},content:r}}function g({variant:e,source:t,name:i,markdownOptions:o}){switch(e){case n.DIRECTIVE:return I(t,o);case n.QUERY:return T(t,i,o);case n.MUTATION:return b(t,i,o);case n.SUBSCRIPTION:return N(t,i,o);case n.UNION:return E(t,o);case n.ENUM:return p(t,o);case n.SCALAR:return h(t,o);case n.INPUT:return P(t,o);case n.OBJECT:return S(t,o);case n.INTERFACE:return U(t,o);default:return}}function v(e){const t=e?.astNode?.loc;if(t?.startToken)return{start:{lineNumber:t.startToken.line,column:t.startToken.column},end:t.endToken?{lineNumber:t.endToken.line,column:t.endToken.column}:void 0}}export{$ as createApiItem};
+import{itemVariant as n}from"../../../types/common.js";import{safeSlugify as d}from"../../../utils/string.js";import{joinWithSeparator as f}from"../../../utils/url.js";import{normalizePath as m,toRelativePath as C}from"../../../utils/url.js";import{shouldIncludeItem as a}from"../utils/shouldIncludeItem.js";import{appendGraphqlItemFeedback as s}from"./appendGraphqlItemFeedback.js";import{buildDirectiveContent as I}from"../items/directive/content.js";import{buildQueryContent as T}from"../items/query/content.js";import{buildMutationContent as b}from"../items/mutation/content.js";import{buildSubscriptionContent as N}from"../items/subscription/content.js";import{buildUnionContent as E}from"../items/union/content.js";import{buildEnumContent as p}from"../items/enum/content.js";import{buildScalarContent as h}from"../items/scalar/content.js";import{buildInputContent as P}from"../items/input/content.js";import{buildObjectContent as S}from"../items/object/content.js";import{buildInterfaceContent as U}from"../items/interface/content.js";import{graphqlContext as A}from"../buildContext.js";const R={[n.QUERY]:"queries",[n.MUTATION]:"mutations",[n.SUBSCRIPTION]:"subscriptions",[n.DIRECTIVE]:"directives",[n.OBJECT]:"objects",[n.INTERFACE]:"interfaces",[n.UNION]:"unions",[n.ENUM]:"enums",[n.INPUT]:"inputs",[n.SCALAR]:"scalars"};function z(t){const e=A.get(),r=`${t.variant}:${t.name}`;if(t.processedItems?.has(r)||(t.filter||t.menuCommonFilter)&&!a(t.name,t.filter,t.menuCommonFilter))return null;const o=t.parentPath?t.parentPath:f(e.basePath,R[t.variant]),u=f(o,d(t.name.toLowerCase())),l=t.label??t.name;if(t.processedItems?.add(r),!e.processContent)return{type:"link",label:l,link:u,routeSlug:u,...t.deprecated&&{deprecated:!0},content:null};let i=g({variant:t.variant,source:t.source,name:t.name,markdownOptions:e.options});e.options.feedback?.hide!==!0&&i&&(i=s(i,m(C(u,e.basePath))));const c=v(t.source);return c&&i?.meta&&(i.meta.position=c),{type:"link",label:l,link:u,routeSlug:u,...t.deprecated&&{deprecated:!0},content:i}}function g({variant:t,source:e,name:r,markdownOptions:o}){switch(t){case n.DIRECTIVE:return I(e,o);case n.QUERY:return T(e,r,o);case n.MUTATION:return b(e,r,o);case n.SUBSCRIPTION:return N(e,r,o);case n.UNION:return E(e,o);case n.ENUM:return p(e,o);case n.SCALAR:return h(e,o);case n.INPUT:return P(e,o);case n.OBJECT:return S(e,o);case n.INTERFACE:return U(e,o);default:return}}function v(t){const e=t?.astNode?.loc;if(e?.startToken)return{start:{lineNumber:e.startToken.line,column:e.startToken.column},end:e.endToken?{lineNumber:e.endToken.line,column:e.endToken.column}:void 0}}export{z as createApiItem};

package/lib/adapters/helpers.d.ts

@@ -1,20 +1,14 @@
-import { REDOCLY_TEAMS_RBAC } from '@redocly/config';
 import type { SchemaEntry, ExampleEntry, SecuritySchemeEntry, StoreContext } from '../types/store.js';
 import type { OpenAPIRef, Referenced } from '../types/common.js';
 import type { OpenAPIMediaType, OpenAPIExample } from '../types/openapi.js';
+export { readRbacScope, rbacProp, splitRbacSection } from './rbac.js';
 export declare function resetStoreCounters(): void;
 export declare function stableStringify(data: unknown, seen?: Set<unknown>): string;
 export declare function registerSchema(schemaStore: Record<string, SchemaEntry>, hashIndex: Record<string, string>, entry: Omit<SchemaEntry, 'id'> & {
     id?: string;
 }): string;
-export declare function readRbacScope(source: unknown): Record<string, string> | undefined;
-export declare function rbacProp(scope: Record<string, string> | undefined): {
-    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
-};
-export declare function splitRbacSection<T>(map: Record<string, T> | undefined): {
-    sectionRbac: Record<string, string> | undefined;
-    entries: [string, T][];
-};
+/** Accepts a raw markdown string or a host-pre-parsed AST node; drops anything else. */
+export declare function pickRenderableDescription(value: unknown): ExampleEntry['description'];
 export declare function registerExample(exampleStore: Record<string, ExampleEntry>, entry: Omit<ExampleEntry, 'id'> & {
     id?: string;
 }): string;
@@ -44,4 +38,3 @@ type LegacyExampleHost = {
 };
 export declare function resolveContent(spec: Record<string, unknown>, info: LegacyExampleHost | null | undefined, ignoreNamedSchemas?: Set<string>): MediaTypesMap | undefined;
 export declare function resolveJsonPointer(spec: Record<string, unknown>, ref: string): Record<string, unknown> | undefined;
-export {};

package/lib/adapters/helpers.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as u}from"@redocly/config";import{getDefinitionName as l}from"./openapi/utils/helpers.js";let d=0,x=0;function C(){d=0,x=0}function s(e,r){return e==null?String(e):typeof e!="object"?JSON.stringify(e):(r||(r=new Set),r.has(e)?'"[Circular]"':(r.add(e),Array.isArray(e)?"["+e.map(n=>s(n,r)).join(",")+"]":c(e)?"{"+Object.keys(e).sort().map(n=>JSON.stringify(n)+":"+s(e[n],r)).join(",")+"}":"{}"))}function O(e,r,t){const n=g(t);if(t.id&&e[t.id])return t.id;if(!t.id){const o=s(t.data),p=r[o];if(p)return p;const f=`schema_${d++}`;return e[f]={...n,id:f},r[o]=f,f}e[t.id]={...n,id:t.id};const i=s(t.data);return r[i]||(r[i]=t.id),t.id}function g(e){const r=m(e.data);return r?{...e,[u]:r}:e}function m(e){if(!c(e))return;const r=e[u];return c(r)?r:void 0}function A(e){return e?{[u]:e}:{}}function E(e){return e?{sectionRbac:m(e),entries:Object.entries(e).filter(([r])=>r!==u)}:{sectionRbac:void 0,entries:[]}}function $(e,r){const t=r.id??`example_${x++}`;return e[t]||(e[t]={...r,id:t}),t}function k(e,r){return e[r.id]||(e[r.id]=r),r.id}function y(e){return{schemaStore:{},exampleStore:{},securitySchemeStore:{},hashIndex:{},document:e}}function c(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function N(e){return c(e)?e:{}}function a(e,r,t){if(c(r)){if(typeof r.$ref=="string"){const n=r.$ref,i=l(n);return i&&t?.has(i)?{type:"object",title:i}:R(e,n)}return r}}function b(e){return c(e)&&typeof e.$ref=="string"}function _(e,r,t){const n=r?.content;if(!n)return;const i=b(n)?a(e,n,t):n;return S(i,r)}function S(e,r){if(!e)return e;const t=r["x-examples"];if(t){const i={...e};for(const o of Object.keys(t))i[o]={...i[o],examples:t[o]};return i}const n=r["x-example"];if(n){const i={...e};for(const o of Object.keys(n))i[o]={...i[o],example:n[o]};return i}return e}function R(e,r){if(!r.startsWith("#/"))return;const t=r.slice(2).split("/").map(i=>i.replace(/~1/g,"/").replace(/~0/g,"~"));let n=e;for(const i of t){if(!c(n))return;n=n[i]}return c(n)?n:void 0}export{y as createStoreContext,b as isOpenAPIRef,c as isRecord,A as rbacProp,m as readRbacScope,$ as registerExample,O as registerSchema,k as registerSecurityScheme,C as resetStoreCounters,_ as resolveContent,R as resolveJsonPointer,a as resolveRef,E as splitRbacSection,s as stableStringify,N as toRecord};
+import{getDefinitionName as x}from"./openapi/utils/helpers.js";import{readRbacScope as d,rbacProp as l}from"./rbac.js";import{readRbacScope as D,rbacProp as _,splitRbacSection as w}from"./rbac.js";let p=0,m=0;function y(){p=0,m=0}function s(e,r){return e==null?String(e):typeof e!="object"?JSON.stringify(e):(r||(r=new Set),r.has(e)?'"[Circular]"':(r.add(e),Array.isArray(e)?"["+e.map(n=>s(n,r)).join(",")+"]":c(e)?"{"+Object.keys(e).sort().map(n=>JSON.stringify(n)+":"+s(e[n],r)).join(",")+"}":"{}"))}function C(e,r,t){const n=g(t);if(t.id&&e[t.id])return t.id;if(!t.id){const i=s(t.data),u=r[i];if(u)return u;const f=`schema_${p++}`;return e[f]={...n,id:f},r[i]=f,f}e[t.id]={...n,id:t.id};const o=s(t.data);return r[o]||(r[o]=t.id),t.id}function g(e){const r=d(e.data);return r?{...e,...l(r)}:e}function O(e){return typeof e=="string"||typeof e=="object"&&e!==null?e:void 0}function k(e,r){const t=r.id??`example_${m++}`;return e[t]||(e[t]={...r,id:t}),t}function A(e,r){return e[r.id]||(e[r.id]=r),r.id}function E(e){return{schemaStore:{},exampleStore:{},securitySchemeStore:{},hashIndex:{},document:e}}function c(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function $(e){return c(e)?e:{}}function b(e,r,t){if(c(r)){if(typeof r.$ref=="string"){const n=r.$ref,o=x(n);return o&&t?.has(o)?{type:"object",title:o}:h(e,n)}return r}}function a(e){return c(e)&&typeof e.$ref=="string"}function N(e,r,t){const n=r?.content;if(!n)return;const o=a(n)?b(e,n,t):n;return S(o,r)}function S(e,r){if(!e)return e;const t=r["x-examples"];if(t){const o={...e};for(const i of Object.keys(t))o[i]={...o[i],examples:t[i]};return o}const n=r["x-example"];if(n){const o={...e};for(const i of Object.keys(n))o[i]={...o[i],example:n[i]};return o}return e}function h(e,r){if(!r.startsWith("#/"))return;const t=r.slice(2).split("/").map(o=>o.replace(/~1/g,"/").replace(/~0/g,"~"));let n=e;for(const o of t){if(!c(n))return;n=n[o]}return c(n)?n:void 0}export{E as createStoreContext,a as isOpenAPIRef,c as isRecord,O as pickRenderableDescription,_ as rbacProp,D as readRbacScope,k as registerExample,C as registerSchema,A as registerSecurityScheme,y as resetStoreCounters,N as resolveContent,h as resolveJsonPointer,b as resolveRef,w as splitRbacSection,s as stableStringify,$ as toRecord};

package/lib/adapters/openapi/build/context.js

@@ -1 +1 @@
-import{parseMarkdown as M}from"../../utils/parseMarkdown.js";import{JsonPointer as B}from"../utils/JsonPointer.js";import{DEFAULT_WEBHOOKS_TAG_NAME as I}from"../../../constants/openapi.js";import{SUPPORTED_MCP_TYPES as N}from"../constants.js";import{titleize as S}from"../utils/helpers.js";import{resolveRef as b,readRbacScope as C,rbacProp as v}from"../../helpers.js";import{resolvePathItemRef as P}from"../utils/resolvePathItemRef.js";import{HTTP_METHODS as R,isOperationName as _}from"../../../utils/http-methods.js";import{REDOCLY_TEAMS_RBAC as A}from"@redocly/config";function T(t){return t.kind==="badge"||t.kind==="audience"}function Z({document:t,options:e,basePath:a,storeCtx:c,processContent:p=!0}){const n=new Map,i=!!t.tags?.length;for(const o of t.tags||[]){const r=o;n.set(o.name,{tag:r,operations:[],description:o.description,children:[]})}for(const o of t.tags||[]){const r=o;r.parent&&!T(o)&&n.get(r.parent)?.children.push(o.name)}e?.schemaDefinitionsTagName&&L(n,e.schemaDefinitionsTagName);const s=(t.tags||[]).filter(T),f={document:t,options:e,basePath:a,tagsMap:n,hasTopLevelTags:i,collectedTagOrder:[],downloadUrls:e.downloadUrls,storeCtx:c,badgeTags:s,processContent:p};return q(t,f),$(t,f),f}function L(t,e){t.has(e)||t.set(e,{tag:{name:e},operations:[],children:[]})}function q(t,e){t.paths&&x(t.paths,!1,e);const a=t["x-webhooks"]||t.webhooks;a&&x(a,!0,e)}function $(t,e){const a=t["x-mcp"];if(a)for(const c of N){const p=a[c];if(p?.length)for(const n of p){const i=n.tags&&n.tags.length>0?n.tags:[S(c)];for(const s of i)e.tagsMap.has(s)||(e.tagsMap.set(s,{tag:{name:s},operations:[],children:[]}),e.collectedTagOrder.push(s))}}}function k(t,e){return{...e,summary:e.summary??t.summary,description:e.description??t.description,servers:e.servers??t.servers}}function x(t,e,a){const c=a.document,p=a.document.openapi;for(const[n,i]of Object.entries(t)){if(!i)continue;let s;try{s=P(c,i,p)}catch{console.warn(`[OpenAPI] Skipping path "${n}": failed to resolve path item $ref`);continue}if(!s)continue;const f=s.parameters??[];for(const r of Object.keys(s).filter(_)){const l=s[r];!l||typeof l!="object"||w(k(s,l),n,r,e,!1,a,f)}const o=s.additionalOperations;if(o)for(const[r,l]of Object.entries(o))w(k(s,l),n,r,e,!0,a,f)}}function j(t){return typeof t=="object"&&t!==null?t:{}}function H(t,e,a,c){if(!t.length&&!e?.length||!t.length)return e;if(!e?.length)return t;const p=new Set(e.map(i=>{const s=b(a,i,c)??i,f=j(s);return`${f.in}:${f.name}`})),n=[...e];for(const i of t){const s=b(a,i,c)??i,f=j(s),o=`${f.in}:${f.name}`;p.has(o)||n.push(i)}return n}function w(t,e,a,c,p,n,i=[]){const s=t.tags||(c?[I]:[""]),f=U(n.badgeTags,t,e,a,c,p,s,i,n);for(const o of s){let r=n.tagsMap.get(o);r||(r={tag:{name:o},operations:[],children:[]},n.tagsMap.set(o,r),n.collectedTagOrder.push(o)),!T(r.tag)&&(r.tag["x-traitTag"]||r.operations.push(f))}}function D(t){return t.toLowerCase()==="x-query"?"query":t}function U(t,e,a,c,p,n,i,s=[],f){const{options:o,storeCtx:r}=f,l=e.externalDocs,g=e["x-badges"]?.map(m=>({name:m.name,color:m.color,position:m.position}))??[];if(e.tags&&t.length>0)for(const m of e.tags){const d=t.find(u=>u.name===m);d&&g.push({name:d.summary??d.name,color:d.kind==="audience"?"grey":"blue",icon:d.kind==="audience"?"user-group":void 0,position:"after",description:typeof d.description=="string"?d.description:void 0})}return{...e,pointer:B.compile(["paths",a,c]),pathName:a,httpVerb:D(c),operationId:e.operationId,summary:e.summary,description:M(e.description,o),deprecated:e.deprecated,isWebhook:p,isAdditionalOperation:n,tags:i,parameters:H(s,e.parameters,r.document,o.ignoreNamedSchemas),requestBody:e.requestBody,responses:e.responses,servers:e.servers,security:e.security??f.document.security,callbacks:V(e.callbacks,r?.document??{},o.ignoreNamedSchemas),externalDocs:l?{url:l.url,description:l.description}:void 0,"x-seo":e?.["x-seo"],"x-badges":g.length>0?g:void 0}}function V(t,e,a){if(!t||typeof t!="object")return;const c=[];for(const[p,n]of Object.entries(t)){const i=b(e,n,a)??n;if(!i||typeof i!="object")continue;const s=C(i),f=i;for(const[o,r]of Object.entries(f)){if(o===A||!r||typeof r!="object")continue;const l=r.servers,O=r.parameters,g=[];for(const[m,d]of Object.entries(r)){if(!R.has(m.toLowerCase())||!d||typeof d!="object")continue;const u=d,h={httpVerb:D(m.toLowerCase()),pathName:o,summary:u.summary,operationId:u.operationId,description:u.description,deprecated:u.deprecated,requestBody:u.requestBody,responses:u.responses,security:u.security,servers:u.servers??l,parameters:u.parameters??O,externalDocs:u.externalDocs};for(const[y,E]of Object.entries(u))y.startsWith("x-")&&!(y in h)&&(h[y]=E);g.push(h)}g.length>0?c.push({name:p,url:o,operations:g,...v(s)}):c.push({name:p,url:o,...v(s)})}}return c.length>0?c:void 0}export{Z as createBuildContext,V as normalizeCallbacks};
+import{parseMarkdown as M}from"../../utils/parseMarkdown.js";import{JsonPointer as N}from"../utils/JsonPointer.js";import{DEFAULT_WEBHOOKS_TAG_NAME as B}from"../../../constants/openapi.js";import{SUPPORTED_MCP_TYPES as E}from"../constants.js";import{titleize as P}from"../utils/helpers.js";import{resolveRef as b,readRbacScope as S,rbacProp as v}from"../../helpers.js";import{resolvePathItemRef as C}from"../utils/resolvePathItemRef.js";import{HTTP_METHODS as R,isOperationName as q}from"../../../utils/http-methods.js";import{isRbacKey as _}from"../../rbac.js";function O(t){return t.kind==="badge"||t.kind==="audience"}function Z({document:t,options:e,basePath:a,storeCtx:c,processContent:p=!0}){const n=new Map;for(const r of t.tags||[]){const o=r;n.set(r.name,{tag:o,operations:[],description:r.description,children:[]})}for(const r of t.tags||[]){const o=r;o.parent&&!O(r)&&n.get(o.parent)?.children.push(r.name)}e?.schemaDefinitionsTagName&&$(n,e.schemaDefinitionsTagName);const i=(t.tags||[]).filter(O),s={document:t,options:e,basePath:a,tagsMap:n,collectedTagOrder:[],downloadUrls:e.downloadUrls,storeCtx:c,badgeTags:i,processContent:p};return A(t,s),L(t,s),s}function $(t,e){t.has(e)||t.set(e,{tag:{name:e},operations:[],children:[]})}function A(t,e){t.paths&&x(t.paths,!1,e);const a=t["x-webhooks"]||t.webhooks;a&&x(a,!0,e)}function L(t,e){const a=t["x-mcp"];if(a)for(const c of E){const p=a[c];if(p?.length)for(const n of p){const i=n.tags&&n.tags.length>0?n.tags:[P(c)];for(const s of i)e.tagsMap.has(s)||(e.tagsMap.set(s,{tag:{name:s},operations:[],children:[]}),e.collectedTagOrder.push(s))}}}function k(t,e){return{...e,summary:e.summary??t.summary,description:e.description??t.description,servers:e.servers??t.servers}}function x(t,e,a){const c=a.document,p=a.document.openapi;for(const[n,i]of Object.entries(t)){if(!i)continue;let s;try{s=C(c,i,p)}catch{console.warn(`[OpenAPI] Skipping path "${n}": failed to resolve path item $ref`);continue}if(!s)continue;const r=s.parameters??[];for(const f of Object.keys(s).filter(q)){const d=s[f];!d||typeof d!="object"||w(k(s,d),n,f,e,!1,a,r)}const o=s.additionalOperations;if(o)for(const[f,d]of Object.entries(o))w(k(s,d),n,f,e,!0,a,r)}}function j(t){return typeof t=="object"&&t!==null?t:{}}function H(t,e,a,c){if(!t.length&&!e?.length||!t.length)return e;if(!e?.length)return t;const p=new Set(e.map(i=>{const s=b(a,i,c)??i,r=j(s);return`${r.in}:${r.name}`})),n=[...e];for(const i of t){const s=b(a,i,c)??i,r=j(s),o=`${r.in}:${r.name}`;p.has(o)||n.push(i)}return n}function w(t,e,a,c,p,n,i=[]){const s=t.tags||(c?[B]:[""]),r=U(n.badgeTags,t,e,a,c,p,s,i,n);for(const o of s){let f=n.tagsMap.get(o);f||(f={tag:{name:o},operations:[],children:[]},n.tagsMap.set(o,f),n.collectedTagOrder.push(o)),!O(f.tag)&&(f.tag["x-traitTag"]||f.operations.push(r))}}function D(t){return t.toLowerCase()==="x-query"?"query":t}function U(t,e,a,c,p,n,i,s=[],r){const{options:o,storeCtx:f}=r,d=e.externalDocs,g=e["x-badges"]?.map(m=>({name:m.name,color:m.color,position:m.position}))??[];if(e.tags&&t.length>0)for(const m of e.tags){const l=t.find(u=>u.name===m);l&&g.push({name:l.summary??l.name,color:l.kind==="audience"?"grey":"blue",icon:l.kind==="audience"?"user-group":void 0,position:"after",description:typeof l.description=="string"?l.description:void 0})}return{...e,pointer:N.compile(["paths",a,c]),pathName:a,httpVerb:D(c),operationId:e.operationId,summary:e.summary,description:M(e.description,o),deprecated:e.deprecated,isWebhook:p,isAdditionalOperation:n,tags:i,parameters:H(s,e.parameters,f.document,o.ignoreNamedSchemas),requestBody:e.requestBody,responses:e.responses,servers:e.servers,security:e.security??r.document.security,callbacks:V(e.callbacks,f?.document??{},o.ignoreNamedSchemas),externalDocs:d?{url:d.url,description:d.description}:void 0,"x-seo":e?.["x-seo"],"x-badges":g.length>0?g:void 0}}function V(t,e,a){if(!t||typeof t!="object")return;const c=[];for(const[p,n]of Object.entries(t)){const i=b(e,n,a)??n;if(!i||typeof i!="object")continue;const s=S(i),r=i;for(const[o,f]of Object.entries(r)){if(_(o)||!f||typeof f!="object")continue;const d=f.servers,T=f.parameters,g=[];for(const[m,l]of Object.entries(f)){if(!R.has(m.toLowerCase())||!l||typeof l!="object")continue;const u=l,h={httpVerb:D(m.toLowerCase()),pathName:o,summary:u.summary,operationId:u.operationId,description:u.description,deprecated:u.deprecated,requestBody:u.requestBody,responses:u.responses,security:u.security,servers:u.servers??d,parameters:u.parameters??T,externalDocs:u.externalDocs};for(const[y,I]of Object.entries(u))y.startsWith("x-")&&!(y in h)&&(h[y]=I);g.push(h)}g.length>0?c.push({name:p,url:o,operations:g,...v(s)}):c.push({name:p,url:o,...v(s)})}}return c.length>0?c:void 0}export{Z as createBuildContext,V as normalizeCallbacks};

package/lib/adapters/openapi/build-code-sample-source.d.ts

@@ -2,4 +2,4 @@ import type { OperationInfo } from '../../types/openapi.js';
 import type { StoreContext } from '../../types/store.js';
 import type { ApiDocsOptions } from '../../types/options.js';
 import type { CodeSampleSource } from '../../services/code-samples/index.js';
-export declare function buildCodeSampleSource(operationInfo: OperationInfo, storeCtx: StoreContext, options: ApiDocsOptions, ignoreNamedSchemas?: Set<string>, isWebhook?: boolean, href?: string): CodeSampleSource;
+export declare function buildCodeSampleSource(operationInfo: OperationInfo, storeCtx: StoreContext, ignoreNamedSchemas?: Set<string>, isWebhook?: boolean, href?: string, options?: ApiDocsOptions): CodeSampleSource;

package/lib/adapters/openapi/build-code-sample-source.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as X}from"@redocly/config";import{registerExample as $,registerSchema as F,resolveContent as Z,resolveRef as x,readRbacScope as R,rbacProp as I}from"../helpers.js";import{panelKind as ee,schemaKind as K}from"../../types/common.js";import{isStatusCode as re}from"../../utils/status-code.js";import{encodeJsonPointerSegment as N}from"../../utils/refPointer.js";import{applyIgnoreNamedSchemasDeep as te}from"./utils/applyIgnoreNamedSchemasDeep.js";import{mergeInMockServer as se,pickOperationServers as ae}from"./utils/merge-mock-server.js";import{mergeSecurityIntoScheme as D}from"./configure/merge-utils.js";import{hasOpenApiExampleValue as ne,resolveOpenApiExampleValue as G}from"./resolve-openapi-example-value.js";function oe(s,o,q){const u=x(o,s,q)??s;return te(u,q)}function Se(s,o,q,u,J,B){const d=o?.document??{},L=d.servers,H=ae(s.servers,L);let k=se(H.filter(e=>typeof e?.url=="string"),q.mockServer).map(e=>({url:e.url??"",name:e.name,description:typeof e.description=="string"?e.description:void 0,...e.isMockServer&&{isMockServer:!0},variables:e.variables&&Object.keys(e.variables).length>0?Object.fromEntries(Object.entries(e.variables).map(([r,l])=>[r,{default:l.default,enum:l.enum}])):void 0}));k.length===0&&(k=[{url:"/"}]);const z=(s.parameters??[]).map(e=>oe(e,d,u)),O={path:[],query:[],querystring:[],header:[],cookie:[]},f=s.requestValues?.serverRequestValues;for(const e of z){const r=e.in;if(!r||!O[r])continue;const l=e.content,t=l?Object.keys(l)[0]:void 0,a=t&&l?l[t]?.schema:e.schema,c=a&&typeof a=="object"?x(d,a,u)??a:a;let i;c&&o&&(i=F(o.schemaStore,o.hashIndex,{kind:K.JSON_SCHEMA,data:c}));const h=c&&typeof c=="object"&&"example"in c?c.example:void 0;let p;if(e.examples&&typeof e.examples=="object")for(const n of Object.values(e.examples)){if(!n||typeof n!="object")continue;const b=x(d,n,u)??n;if(ne(b)){p=G(b);break}}const v={};if(f&&e.name)for(const[n,b]of Object.entries(f)){const _=b?.[r==="querystring"?"queryString":r==="header"?"headers":r==="cookie"?"cookies":r]?.[e.name];_!=null&&(v[n]={example:_})}O[r].push({name:e.name??"",in:r,required:e.required,example:e.example??p??h,schemaId:i,serializationMime:t,style:e.style,explode:e.explode,...Object.keys(v).length>0&&{serverValues:v}})}const A=s.requestValues?.security,M=s.security,P=[];if(M&&o)for(const e of M){const r=Object.keys(e),l=r.map(t=>o.securitySchemeStore[t]).filter(Boolean).map(t=>{let a={id:t.id,type:t.type,name:t.paramName,in:t.in,scheme:t.scheme,bearerFormat:t.bearerFormat,openIdConnectUrl:t.openIdConnectUrl,flows:t.flows,"x-defaultClientId":t["x-defaultClientId"],"x-defaultAccessToken":t["x-defaultAccessToken"],"x-defaultTokenType":t["x-defaultTokenType"],"x-defaultClientSecret":t["x-defaultClientSecret"],"x-defaultUsername":t["x-defaultUsername"],"x-defaultPassword":t["x-defaultPassword"],serverValues:t.serverValues?{...t.serverValues}:void 0};if(A&&(a=D(a,A)),f)for(const[c,i]of Object.entries(f))i?.security&&(a=D(a,i.security,c));return a});if(l.length>0){const t=r.flatMap(a=>e[a]??[]);P.push({schemes:l,scopes:t})}}const j=s.requestBody,Y=j?x(d,j,u)??j:void 0,T=Z(d,Y,u);let g;if(T&&o){g={};for(const[e,r]of Object.entries(T)){let l;const t=r.itemSchema,a=r.schema??t;if(a){const h=x(d,a,u)??a;l=F(o.schemaStore,o.hashIndex,{kind:K.JSON_SCHEMA,data:h})}const c=s.pointer?`${s.pointer}/requestBody/content/${N(e)}`.replace(/^\//,""):void 0,i=[];if(r.example!==void 0&&i.push($(o.exampleStore,{value:r.example,...c&&{id:`${c}/example`}})),r.examples){const h=R(r.examples);for(const[p,v]of Object.entries(r.examples)){if(p===X)continue;const n=x(d,v,u);if(n){const b=R(v)??R(n)??h,U=$(o.exampleStore,{value:G(n),key:p,summary:typeof n.summary=="string"?n.summary:p,description:typeof n.description=="string"?n.description:void 0,externalValue:typeof n.externalValue=="string"?n.externalValue:void 0,...I(b),...c&&{id:`${c}/examples/${N(p)}`}});i.push(U)}}}g[e]={schemaId:l,...i.length>0&&{exampleIds:i}}}}const S=s.requestValues?.envVariables;let V,m;if(S&&typeof S=="object")if("values"in S){const e=S;V=e.values,m=e.serverValues}else V=S;const E=s.requestValues?.body;let y;if(f)for(const[e,r]of Object.entries(f))r?.body!==void 0&&(y=y??{},y[e]=r.body),r?.envVariables&&(m=m??{},m[e]={...m[e],...r.envVariables});const Q=V||m||s.requestValues?.security||E!==void 0||y?{...s.requestValues?.security&&{security:s.requestValues.security},...V&&{envVariables:V},...m&&{serverEnvVariables:m},...E!==void 0&&{body:E},...y&&{serverBody:y}}:void 0,C=s.responses,W=C?Object.keys(C).filter(re):void 0,w=s.security;return{kind:ee.CODE_SAMPLE,operationType:J?"webhook":"http",method:s.httpVerb?.toUpperCase()??"GET",path:s.pathName??"/",servers:k,parameters:O,security:P,requestBody:g,responseCodes:W,requestValues:Q,pointer:s.pathName,...B&&{href:B},...s.operationId&&{openApiOperationId:s.operationId},...s.summary&&{summary:s.summary},...w&&w.length>1&&{securityGroups:w}}}export{Se as buildCodeSampleSource};
+import{isRbacKey as w}from"../rbac.js";import{registerExample as O,pickRenderableDescription as M,registerSchema as R,resolveContent as P,resolveRef as V,readRbacScope as q,rbacProp as A}from"../helpers.js";import{panelKind as T,schemaKind as j}from"../../types/common.js";import{isStatusCode as U}from"../../utils/status-code.js";import{encodeJsonPointerSegment as B}from"../../utils/refPointer.js";import{applyIgnoreNamedSchemasDeep as C}from"./utils/applyIgnoreNamedSchemasDeep.js";import{pickOperationServers as K}from"./utils/merge-mock-server.js";import{mergeInMockServer as $}from"./utils/merge-mock-server.js";import{mergeSecurityIntoScheme as g}from"./configure/merge-utils.js";import{hasOpenApiExampleValue as F,resolveOpenApiExampleValue as E}from"./resolve-openapi-example-value.js";function L(r,n,a){const u=V(n,r,a)??r;return C(u,a)}function te(r,n,a,u,l,i){const s=n?.document??{},m=N(r,s,i),t=D(r,s,n,a),e=G(r,n),o=J(r,s,n,a),y=_(r),c=r.responses,p=c?Object.keys(c).filter(U):void 0,f=r.security;return{kind:T.CODE_SAMPLE,operationType:u?"webhook":"http",method:r.httpVerb?.toUpperCase()??"GET",path:r.pathName??"/",servers:m,parameters:t,security:e,requestBody:o,responseCodes:p,requestValues:y,pointer:r.pathName,...l&&{href:l},...r.operationId&&{openApiOperationId:r.operationId},...r.summary&&{summary:r.summary},...f&&f.length>1&&{securityGroups:f}}}function N(r,n,a){const u=n.servers;let l=K(r.servers,u);l=$(l.filter(s=>typeof s?.url=="string"),a?.mockServer);const i=l.map(s=>({url:s.url??"",name:s.name,description:typeof s.description=="string"?s.description:void 0,...s.isMockServer&&{isMockServer:!0},variables:s.variables&&Object.keys(s.variables).length>0?Object.fromEntries(Object.entries(s.variables).map(([m,t])=>[m,{default:t.default,enum:t.enum}])):void 0}));return i.length>0?i:[{url:"/"}]}function D(r,n,a,u){const i=(r.parameters??[]).map(t=>L(t,n,u)),s={path:[],query:[],querystring:[],header:[],cookie:[]},m=r.requestValues?.serverRequestValues;for(const t of i){const e=t.in;if(!e||!s[e])continue;const o=t.content,y=o?Object.keys(o)[0]:void 0,c=y&&o?o[y]?.schema:t.schema,p=c&&typeof c=="object"?V(n,c,u)??c:c;let f;p&&a&&(f=R(a.schemaStore,a.hashIndex,{kind:j.JSON_SCHEMA,data:p}));const S=p&&typeof p=="object"&&"example"in p?p.example:void 0;let v;if(t.examples&&typeof t.examples=="object")for(const d of Object.values(t.examples)){if(!d||typeof d!="object")continue;const x=V(n,d,u)??d;if(F(x)){v=E(x);break}}const b={};if(m&&t.name)for(const[d,x]of Object.entries(m)){const k=x?.[e==="querystring"?"queryString":e==="header"?"headers":e==="cookie"?"cookies":e]?.[t.name];k!=null&&(b[d]={example:k})}s[e].push({name:t.name??"",in:e,required:t.required,example:t.example??v??S,schemaId:f,serializationMime:y,style:t.style,explode:t.explode,...Object.keys(b).length>0&&{serverValues:b}})}return s}function G(r,n){const a=r.requestValues?.security,u=r.requestValues?.serverRequestValues,l=r.security,i=[];if(!l||!n)return i;for(const s of l){const m=Object.keys(s),t=m.map(e=>n.securitySchemeStore[e]).filter(Boolean).map(e=>{let o={id:e.id,type:e.type,name:e.paramName,in:e.in,scheme:e.scheme,bearerFormat:e.bearerFormat,openIdConnectUrl:e.openIdConnectUrl,flows:e.flows,"x-defaultClientId":e["x-defaultClientId"],"x-defaultAccessToken":e["x-defaultAccessToken"],"x-defaultTokenType":e["x-defaultTokenType"],"x-defaultClientSecret":e["x-defaultClientSecret"],"x-defaultUsername":e["x-defaultUsername"],"x-defaultPassword":e["x-defaultPassword"],serverValues:e.serverValues?{...e.serverValues}:void 0};if(a&&(o=g(o,a)),u)for(const[y,c]of Object.entries(u))c?.security&&(o=g(o,c.security,y));return o});if(t.length>0){const e=m.flatMap(o=>s[o]??[]);i.push({schemes:t,scopes:e})}}return i}function J(r,n,a,u){const l=r.requestBody,i=l?V(n,l,u)??l:void 0,s=P(n,i,u);if(!s||!a)return;const m={};for(const[t,e]of Object.entries(s)){let o;const y=e.itemSchema,c=e.schema??y;if(c){const S=V(n,c,u)??c;o=R(a.schemaStore,a.hashIndex,{kind:j.JSON_SCHEMA,data:S})}const p=r.pointer?`${r.pointer}/requestBody/content/${B(t)}`.replace(/^\//,""):void 0,f=[];if(e.example!==void 0&&f.push(O(a.exampleStore,{value:e.example,...p&&{id:`${p}/example`}})),e.examples){const S=q(e.examples);for(const[v,b]of Object.entries(e.examples)){if(w(v))continue;const d=V(n,b,u);if(d){const x=q(b)??q(d)??S,h=O(a.exampleStore,{value:E(d),key:v,summary:typeof d.summary=="string"?d.summary:v,description:M(d.description),externalValue:typeof d.externalValue=="string"?d.externalValue:void 0,...A(x),...p&&{id:`${p}/examples/${B(v)}`}});f.push(h)}}}m[t]={schemaId:o,...f.length>0&&{exampleIds:f}}}return m}function _(r){const n=r.requestValues?.serverRequestValues,a=r.requestValues?.envVariables;let u,l;if(a&&typeof a=="object")if("values"in a){const t=a;u=t.values,l=t.serverValues}else u=a;const i=r.requestValues?.body;let s;if(n)for(const[t,e]of Object.entries(n))e?.body!==void 0&&(s=s??{},s[t]=e.body),e?.envVariables&&(l=l??{},l[t]={...l[t],...e.envVariables});return u||l||r.requestValues?.security||i!==void 0||s?{...r.requestValues?.security&&{security:r.requestValues.security},...u&&{envVariables:u},...l&&{serverEnvVariables:l},...i!==void 0&&{body:i},...s&&{serverBody:s}}:void 0}export{te as buildCodeSampleSource};

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

@@ -21,7 +21,7 @@ export declare function mergeSecurityIntoScheme<S extends SchemeForCredentials>(
     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. */
+/** Immutable variant of {@link applyServerVariableDefaults} for runtime callers that must not mutate. */
 export declare function withServerVariableDefaults<T extends {
     url: string;
     variables?: Record<string, {

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

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

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

@@ -1,11 +1,8 @@
-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

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

package/lib/adapters/openapi/index.js

@@ -1 +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};
+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 S}from"./items/overview/item.js";import{addTagItems as f}from"./group/item.js";import{openApiContext as c}from"./buildContext.js";import{mergeInMockServer as v}from"./utils/merge-mock-server.js";import{toSidebarLogo as g}from"../../utils/logo.js";function x(){return new Promise(r=>setTimeout(r,0))}function d(r,t){let o=(r.servers??[]).filter(e=>typeof e?.url=="string");return o=v(o,t.mockServer),o.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:i,processContent:o=!0}){const e=s(l(r));o&&(p(r,e,i),await x());const m=u({document:r,options:i,basePath:t,storeCtx:e,processContent:o}),n=d(r,i),a=g(r.info?.["x-logo"],r.info?.contact?.url);return c.run(m,()=>({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},...a&&{logo:a}}}))}function b(){const r=c.get(),t=[...S(r.document)];return f(r.document,t),t}export{b as buildOpenApiItems,M as processOpenApiDocument};

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

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

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

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

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

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

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

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