@redocly/api-docs 0.0.2

package/lib/RedoclyApiDocs.d.ts

@@ -0,0 +1,22 @@
+import type { LayoutVariant } from '@redocly/config';
+import type { ReactElement } from 'react';
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import type { RedocTelemetryConfig } from './telemetry/RedocTelemetry.js';
+import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
+type RedoclyApiDocsInnerProps = {
+    items: ApiItem[];
+    basePath: string;
+    markdownAdapter: MarkdownAdapter;
+    telemetryConfig?: Partial<RedocTelemetryConfig>;
+};
+type RedoclyApiDocsProps = RedoclyApiDocsInnerProps & {
+    store: ApiStore;
+    options: RawApiDocsOptions;
+    layout?: LayoutVariant;
+};
+declare const RedoclyApiDocsComponent: (props: RedoclyApiDocsInnerProps) => ReactElement;
+declare const RedoclyApiDocs: import("react").FC<RedoclyApiDocsProps>;
+export { RedoclyApiDocs, RedoclyApiDocsComponent };
+export type { RedoclyApiDocsProps };
+export default RedoclyApiDocs;

package/lib/RedoclyApiDocs.js

@@ -0,0 +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};

package/lib/RedoclyApiDocsStandalone.d.ts

@@ -0,0 +1,18 @@
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import type { RedocTelemetryConfig } from './telemetry/RedocTelemetry.js';
+import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
+import type { RawLogo } from './types/common.js';
+type RedoclyApiDocsStandaloneProps = {
+    items: ApiItem[];
+    store: ApiStore;
+    basePath: string;
+    options: RawApiDocsOptions;
+    logo?: RawLogo;
+    telemetryConfig?: Partial<RedocTelemetryConfig>;
+    markdownAdapter?: MarkdownAdapter;
+};
+declare const RedoclyApiDocsStandalone: import("react").FC<any>;
+export { RedoclyApiDocsStandalone };
+export type { RedoclyApiDocsStandaloneProps };
+export default RedoclyApiDocsStandalone;

package/lib/RedoclyApiDocsStandalone.js

@@ -0,0 +1,26 @@
+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`
+  display: flex;
+  position: relative;
+  min-height: 100vh;
+  text-align: left;
+  background-color: var(--bg-color);
+  font-family: var(--font-family-base);
+  font-size: var(--font-size-base);
+  line-height: var(--line-height-base);
+  font-weight: var(--font-weight-regular);
+  color: var(--text-color-primary);
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+
+  [data-section-id],
+  [id]:has([data-deep-link-anchor]) {
+    scroll-margin-top: calc(var(--navbar-height, 0) + var(--banner-height, 0));
+  }
+
+  * {
+    box-sizing: border-box;
+  }
+`,Q=h.div`
+  flex: 1;
+  min-width: 0;
+`;var uo=p;export{p as RedoclyApiDocsStandalone,uo as default};

package/lib/adapters/asyncapi/build/context.d.ts

@@ -0,0 +1,10 @@
+import type { AsyncApiDefinition } from '../../../types/asyncapi.js';
+import type { AsyncApiBuildContext as BuildContext } from '../../../types/asyncapi.js';
+import type { AdapterBuildContextInput, StoreContext } from '../../../types/store.js';
+type CreateBuildContextInputWithDocument = AdapterBuildContextInput & {
+    document: AsyncApiDefinition;
+    storeCtx: StoreContext;
+    processContent?: boolean;
+};
+export declare function createBuildContext({ document, options, basePath, storeCtx, processContent, }: CreateBuildContextInputWithDocument): BuildContext;
+export {};

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

@@ -0,0 +1 @@
+import{findFirstBinding as o,mapChannelToOperations as a}from"./utils.js";function s({document:n,options:e,basePath:r,storeCtx:i,processContent:t=!0}){return{document:n,options:e,basePath:r,storeCtx:i,protocol:o(n),channelToOperations:a(n),groups:{},items:[],descriptionItems:[],channelSummaries:new Map,processContent:t}}export{s as createBuildContext};

package/lib/adapters/asyncapi/build/navigation.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function buildNavigationItems(): ApiItem[];

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

@@ -0,0 +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};

package/lib/adapters/asyncapi/build/utils.d.ts

@@ -0,0 +1,3 @@
+import type { ProtocolVariant, AsyncApiDefinition } from '../../../types/asyncapi.js';
+export declare function findFirstBinding(obj: unknown, visited?: Set<unknown>): ProtocolVariant | null;
+export declare function mapChannelToOperations(rawAsyncApiDoc: AsyncApiDefinition): Record<string, string[]>;

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

@@ -0,0 +1 @@
+function f(e,s=new Set){if(s.has(e)||typeof e!="object"||e===null)return null;s.add(e);const o=e;for(const l of Object.keys(o)){const n=o[l];if(n&&typeof n=="object"&&"bindings"in n&&n.bindings)return Object.keys(n.bindings)[0];const t=f(n,s);if(t)return t}return null}function d(e){const s=e.operations??{},o=e.channels??{},l=Object.keys(o),n={},t={};for(const[i,a]of Object.entries(o))t[i]=[],a.address&&(n[a.address]=i);for(const[i,a]of Object.entries(s)){const r=a.channel;if(!r)continue;let c;typeof r.$ref=="string"?c=r.$ref.split("/").pop():typeof r.address=="string"&&(c=n[r.address]),!(!c||!l.includes(c))&&t[c].push(i)}return t}export{f as findFirstBinding,d as mapChannelToOperations};

package/lib/adapters/asyncapi/buildContext.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncApiBuildContext as BuildContext } from '../../types/asyncapi.js';
+export declare const asyncApiContext: import("../scopedContext.js").ScopedContext<BuildContext>;

package/lib/adapters/asyncapi/buildContext.js

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

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

@@ -0,0 +1,14 @@
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
+import type { AsyncApiDefinition } from '../../types/asyncapi.js';
+import type { StoreContext } from '../../types/store.js';
+export declare function processAsyncApiDocument(props: ApiDocAdapterProps & {
+    document: AsyncApiDefinition;
+    processContent?: boolean;
+}): {
+    items: ApiItem[];
+    store: ApiStore;
+};
+export declare function buildAsyncApiItems({ document, options, basePath, processContent, }: ApiDocAdapterProps & {
+    document: AsyncApiDefinition;
+    processContent?: boolean;
+}, storeCtx: StoreContext): ApiItem[];

package/lib/adapters/asyncapi/index.js

@@ -0,0 +1 @@
+import{populateAsyncApiStore as u}from"./store.js";import{createStoreContext as l,toRecord as a}from"../helpers.js";import{collectMarkdownSections as f}from"../utils/markdoc.js";import{buildOverviewItem as S}from"./items/overview/item.js";import{createBuildContext as d}from"./build/context.js";import{buildNavigationItems as x}from"./build/navigation.js";import{asyncApiContext as I}from"./buildContext.js";function k(t){const r=t.processContent??!0,e=l(a(t.document));return r&&u(t.document,e),{items:h({...t,processContent:r},e),store:{schemaStore:e.schemaStore,exampleStore:e.exampleStore,securitySchemeStore:e.securitySchemeStore}}}function h({document:t,options:r,basePath:e,processContent:i=!0},n){const o=d({document:t,options:r,basePath:e,storeCtx:n,processContent:i});return I.run(o,()=>{const{sectionItems:c,sectionChildren:s}=i?f(t.info?.description,o.basePath,o.options):{sectionItems:[],sectionChildren:[]},m=S(t.info??{},{basePath:e,document:t,options:r,protocol:o.protocol,sectionChildren:s,processContent:i});o.descriptionItems.push(...c);const p=x();return[m,...o.descriptionItems,...p]})}export{h as buildAsyncApiItems,k as processAsyncApiDocument};

package/lib/adapters/asyncapi/items/channel/content.d.ts

@@ -0,0 +1,5 @@
+import type { ApiItemContent, MessageReferencesGroups } from '../../../../types/content.js';
+import type { AsyncApiChannel, AsyncApiDefinition, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildMessageReferencesGroups(document: AsyncApiDefinition, messageKey: string, protocol: ProtocolVariant | null | undefined): MessageReferencesGroups;
+export declare function buildChannelContent(channelId: string, channel: AsyncApiChannel, document: AsyncApiDefinition, markdownOptions: ParseMarkdownOptions, protocol?: ProtocolVariant | null): ApiItemContent;

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

@@ -0,0 +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};

package/lib/adapters/asyncapi/items/channel/item.d.ts

@@ -0,0 +1,13 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { AsyncApiChannel } from '../../../../types/asyncapi.js';
+export declare function buildTaggedChannelItem({ channelId, channel, operationIds, tagName, }: {
+    channelId: string;
+    channel: AsyncApiChannel;
+    operationIds: string[];
+    tagName: string;
+}): ApiItem;
+export declare function buildUntaggedChannelItem({ channelId, channel, operationIds, }: {
+    channelId: string;
+    channel: AsyncApiChannel;
+    operationIds: string[];
+}): ApiItem;

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

@@ -0,0 +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};

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

@@ -0,0 +1,4 @@
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOperationContent(operationId: string, operation: AsyncApiOperation, document: AsyncApiDefinition, pageSlug: string, options: ApiDocsOptions, protocol?: ProtocolVariant | null, groupHeaderLabel?: string, showDivider?: boolean): ApiItemContent;

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

@@ -0,0 +1,3 @@
+import{contentType as q,itemVariant as Q,nodeTypes as t,panelKind as U,schemaKind as K}from"../../../../types/common.js";import{registerSchema as $}from"../../../helpers.js";import{parseMarkdown as T}from"../../../utils/parseMarkdown.js";import{asString as I,safeSlugify as W}from"../../../../utils/string.js";import{normalizePath as B,toRelativePath as _}from"../../../../utils/url.js";import{JsonPointer as Y}from"../../../openapi/utils/JsonPointer.js";import{componentLabelsByProtocol as Z}from"../../utils/get-protocol-labels.js";import{resolveInDoc as g}from"../../utils/resolveInDoc.js";import{resolveAsyncApiSchema as H}from"../../utils/resolve-schema.js";import{asyncApiContext as w}from"../../buildContext.js";function de(O,e,h,S,m,V,k,J){const{basePath:R}=w.get(),A=I(e.title)??I(e.summary)??O,y=Z({protocol:V??null}),{feedback:G}=m,z=e.action==="send"?y.sendLabel:y.receiveLabel,M=e.action==="send"?y.send:y.receive,r=[];k&&r.push({nodeType:t.HEADER,level:4,label:k}),r.push({nodeType:t.HEADER,level:5,label:A,badges:e["x-badges"]||[],showPageActions:!0,protocolTag:{label:M,color:e.action}});const N=T(typeof e.summary=="string"?e.summary:void 0,m);N&&r.push({nodeType:t.MARKDOC,content:N});const v=T(e.description,m);v&&r.push({nodeType:t.MARKDOC,content:v});const C=e.externalDocs;C?.url&&r.push({nodeType:t.EXTERNAL_DOCS,url:C.url,description:T(C.description,m)??[]});const D=e.channel?g(h,e.channel):void 0,F=D?.bindings;if(e.messages&&e.messages.length>0){const l=S.split("/operations/")[0].toLowerCase(),p=B(_(l,R)),i=D?.messages??{},a=e.messages.map(n=>{const d=n.$ref,c=typeof d=="string"?d.split("/messages/").pop():void 0;let s=Object.keys(i).find(o=>{const b=i[o].$ref?.split("/messages/").pop();return b!==void 0&&b===c})??c,u=n;for(let o=0;o<4&&u?.$ref;o++)u=g(h,u);const f=u??n;if(!s){const o=f.payload?.$ref;for(const[b,P]of Object.entries(i)){const j=g(h,P)??P,x=j.payload?.$ref;if(o&&x&&o===x||f.title&&j.title===f.title){s=b;break}}}const X=f.title||f.name||s||"Message";if(!s){const o=I(f.title);s=f.name||(o?W(o):void 0)}return s?{name:s,label:X}:void 0}).filter(n=>!!n);a.length>0&&r.push({nodeType:t.MESSAGE_LINKS,channelLink:p,messages:a})}if(e.reply){const l=[];e.reply.address?.location&&l.push(`Address: \`${e.reply.address.location}\``);const p=g(h,e.reply.channel);if(p?.address&&l.push(`${y.channel}: \`${p.address}\``),e.reply.messages?.length){const i=e.reply.messages.map(a=>{const n=g(h,a);return n?.title||n?.name||a.title||a.name||"Message"}).join(", ");l.push(`Messages: ${i}`)}l.length>0&&r.push({nodeType:t.HEADER,level:4,label:"Reply",labelTranslationKey:"reply",deepLinkSuffix:"reply"},{nodeType:t.MARKDOC,content:T(l.join(`
+
+`),m)??[]})}const E=[];if(e.bindings){const l=Object.entries(e.bindings);if(l.length>0){const[p,i]=l[0];let a,n;const d=w.get().storeCtx;if(d&&p==="kafka"&&i&&typeof i=="object"){const c=i;if(c.groupId&&typeof c.groupId=="object"){const s=H(c.groupId);a=$(d.schemaStore,d.hashIndex,{kind:K.JSON_SCHEMA,data:{type:"object",properties:{groupId:s}}})}if(c.clientId&&typeof c.clientId=="object"){const s=H(c.clientId);n=$(d.schemaStore,d.hashIndex,{kind:K.JSON_SCHEMA,data:{type:"object",properties:{clientId:s}}})}}E.push({title:"Operation configuration",children:[{kind:U.OPERATION_BINDING,bindingKey:p,bindingValue:i,groupIdSchemaId:a,clientIdSchemaId:n}]})}}const L=[{nodeType:t.CONTAINER,children:r,panels:E.length>0?E:void 0}];return G?.hide!==!0&&L.push({nodeType:t.CONTAINER,children:[{nodeType:t.FEEDBACK,pageSlug:B(_(S,R).toLowerCase())}],panels:[]}),{contentType:q.ITEM,itemVariant:Q.CHANNEL_OPERATION,meta:{name:A,pointer:Y.compile(["operations",O]),protocolTag:{label:M,color:e.action},action:e.action,actionLabel:z,channelBindings:F},seo:{title:A,description:I(e.description)},children:L,showDivider:J}}export{de as buildOperationContent};

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

@@ -0,0 +1,15 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOperationItem({ operationId, operation, linkParts, channelBindings, document, options, protocol, groupHeaderLabel, processContent, showDivider, }: {
+    operationId: string;
+    operation: AsyncApiOperation;
+    linkParts: string[];
+    channelBindings?: Record<string, unknown>;
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol?: ProtocolVariant | null;
+    groupHeaderLabel?: string;
+    processContent?: boolean;
+    showDivider?: boolean;
+}): ApiItem;

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

@@ -0,0 +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};

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

@@ -0,0 +1,10 @@
+import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
+import type { ApiItemContent, ContentNode } from '../../../../types/content.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOverviewContent({ document, options, protocol, sectionChildren, basePath, }: {
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol: string | null;
+    sectionChildren: ContentNode[];
+    basePath: string;
+}): ApiItemContent;

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

@@ -0,0 +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};

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

@@ -0,0 +1,16 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { ContentNode } from '../../../../types/content.js';
+import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+type Options = {
+    basePath: string;
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol: string | null;
+    sectionChildren: ContentNode[];
+    processContent?: boolean;
+};
+export declare function buildOverviewItem(info: {
+    title?: string;
+}, options: Options): ApiItem;
+export {};

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

@@ -0,0 +1 @@
+import{buildOverviewContent as u}from"./content.js";function p(e,n){const{basePath:t,document:o,options:i,protocol:l,sectionChildren:r,processContent:s=!0}=n;return{type:"link",label:e.title??"Overview",labelTranslationKey:e.title?void 0:"asyncapi.info.title",link:t,routeSlug:t,content:s?u({document:o,options:i,protocol:l,sectionChildren:r,basePath:t}):null}}export{p as buildOverviewItem};

package/lib/adapters/asyncapi/panels/brokers.d.ts

@@ -0,0 +1,4 @@
+import type { AsyncApiServer } from '../../../types/asyncapi.js';
+import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
+import { type BrokersNode } from '../../../types/content.js';
+export declare function buildBrokersPanelContent(servers: Record<string, AsyncApiServer>, protocol: string | null, markdownOptions: ParseMarkdownOptions): BrokersNode;

package/lib/adapters/asyncapi/panels/brokers.js

@@ -0,0 +1 @@
+import{panelKind as l}from"../../../types/common.js";import{componentLabelsByProtocol as e}from"../utils/get-protocol-labels.js";import{getServerHost as m}from"../utils/get-server-host.js";import{parseMarkdown as s}from"../../utils/parseMarkdown.js";import{readRbacScope as b,rbacProp as d,splitRbacSection as f}from"../../helpers.js";function x(n,i,a){const t=e({protocol:i}).servers,{sectionRbac:c,entries:p}=f(n);return{title:t,children:[{kind:l.BROKERS,panelLabel:t,brokers:p.map(([r,o])=>({name:r,url:m(o),description:s(o.description,a)??[],variables:o.variables,protocol:o.protocol,protocolVersion:o.protocolVersion,pathname:o.pathname,title:o.title,summary:o.summary,tags:o.tags,externalDocs:o.externalDocs,bindings:o.bindings,...d(b(o)??c)}))}]}}export{x as buildBrokersPanelContent};

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

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

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

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

package/lib/adapters/asyncapi/panels/group.d.ts

@@ -0,0 +1,16 @@
+import type { GroupItemNode } from '../../../types/content.js';
+import type { AsyncApiBuildContext } from '../../../types/asyncapi.js';
+import type { ApiItem } from '../../../types/store.js';
+export declare function buildGroupItemsPanel({ group, protocol, channelByLink, context, }: {
+    group: ApiItem[];
+    protocol: AsyncApiBuildContext['protocol'];
+    channelByLink: Map<string, {
+        bindings?: Record<string, unknown>;
+    } | undefined>;
+    context: AsyncApiBuildContext;
+}): GroupItemNode['children'][0];
+type VisibleGroupItem = ApiItem & {
+    link: string;
+};
+export declare function isVisibleGroupItem(item: ApiItem): item is VisibleGroupItem;
+export {};

package/lib/adapters/asyncapi/panels/group.js

@@ -0,0 +1 @@
+import{panelKind as f}from"../../../types/common.js";import{normalizePath as d,toRelativePath as k}from"../../../utils/url.js";import{componentLabelsByProtocol as r}from"../utils/get-protocol-labels.js";function w({group:t,protocol:e,channelByLink:c,context:m}){const{channelSummaries:p,basePath:u}=m,s=t.filter(L),l=s.map(n=>{const i=c.get(n.link);return r({protocol:e,channelBindings:i?.bindings})}),h=new Set(l.map(n=>n.channels)),a=r({protocol:e}),b=h.size===1?l[0]?.channels??a.channels:a.channels;return{kind:f.GROUP_ITEMS,title:b,items:s.map((n,i)=>{const o=l[i]?.channel??a.channel;return{title:n.label??n.link,summary:p.get(n.link),link:d(k(n.link,u)).toLowerCase(),prefix:{name:o,color:o.toLowerCase()},deprecated:!1}})}}function L(t){const{link:e}=t;return typeof e=="string"&&!e.includes("section")}export{w as buildGroupItemsPanel,L as isVisibleGroupItem};

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

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

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

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

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

@@ -0,0 +1,4 @@
+import type { ApiStore } from '../../types/store.js';
+import type { AsyncApiDefinition } from '../../types/asyncapi.js';
+import type { StoreContext } from '../../types/store.js';
+export declare function populateAsyncApiStore(document: AsyncApiDefinition, existingCtx: StoreContext): ApiStore;

package/lib/adapters/asyncapi/store.js

@@ -0,0 +1 @@
+import{schemaKind as d}from"../../types/common.js";import{registerSchema as l,registerExample as u,readRbacScope as x,rbacProp as n,splitRbacSection as S}from"../helpers.js";import{resolveAsyncApiSchema as f}from"./utils/resolve-schema.js";function v(y,g){const{schemaStore:t,exampleStore:m,hashIndex:r}=g,c=y.components;if(!c)return{schemaStore:t,exampleStore:m,securitySchemeStore:{}};if(c.schemas){const{sectionRbac:i,entries:p}=S(c.schemas);for(const[a,e]of p){const o=f(e);o&&l(t,r,{id:`components/schemas/${a}`,kind:d.JSON_SCHEMA,title:a,data:o,...n(i)})}}if(c.messages){const{sectionRbac:i,entries:p}=S(c.messages);for(const[a,e]of p){const o=x(e)??i;if(e.payload){const s=f(e.payload);s&&l(t,r,{id:`components/messages/${a}/payload`,kind:d.JSON_SCHEMA,title:`${a} payload`,data:s,...n(o)})}if(e.headers){const s=f(e.headers);s&&l(t,r,{id:`components/messages/${a}/headers`,kind:d.JSON_SCHEMA,title:`${a} headers`,data:s,...n(o)})}if(e.examples)for(let s=0;s<e.examples.length;s++){const h=e.examples[s];u(m,{id:`components/messages/${a}/examples/${s}`,value:h.payload,summary:h.summary,...n(o)})}}}return{schemaStore:t,exampleStore:m,securitySchemeStore:{}}}export{v as populateAsyncApiStore};

package/lib/adapters/asyncapi/utils/avro-to-json-schema.d.ts

@@ -0,0 +1,4 @@
+import type { AvroSchema } from '../../../types/asyncapi.js';
+type JsonSchemaObject = Record<string, unknown>;
+export declare function avroToJsonSchema(avroSchema: AvroSchema): JsonSchemaObject;
+export {};

package/lib/adapters/asyncapi/utils/avro-to-json-schema.js

@@ -0,0 +1 @@
+function c(n,e){switch(n){case"null":return{type:"null"};case"boolean":return{type:"boolean"};case"int":case"long":return{type:"integer"};case"float":case"double":return{type:"number"};case"bytes":return{type:"string",contentEncoding:"base64"};case"string":return{type:"string"};default:{const t=e[n];return t?{...t}:{type:"null"}}}}function s(n){return{type:"string",enum:n.symbols,title:n.name,description:n.doc}}function a(n,e){const t={},r=[];return n.fields?.forEach(i=>{t[i.name]=u(i.type,e),i.doc&&(t[i.name].description=i.doc),i.default!==void 0&&(t[i.name].default=i.default),i.default===void 0&&!f(i.type)&&r.push(i.name)}),{type:"object",title:n.name,description:n.doc,properties:t,required:r.length>0?r:void 0,additionalProperties:!1}}function f(n){return Array.isArray(n)?n.some(e=>e==="null"||typeof e=="object"&&!Array.isArray(e)&&e.type==="null"):!1}function o(n,e){return{type:"array",items:u(n.items,e),description:n.doc}}function l(n,e){return{type:"object",additionalProperties:u(n.values,e),description:n.doc}}function d(n,e){const t=n.findIndex(r=>r==="null"||typeof r=="object"&&!Array.isArray(r)&&r.type==="null");if(t!==-1){const r=[...n];return r.splice(t,1),r.length===1?{...u(r[0],e),nullable:!0}:{oneOf:r.map(i=>u(i,e)),nullable:!0}}return{oneOf:n.map(r=>u(r,e))}}function u(n,e){if(typeof n=="string")return c(n,e);if(!n)return{type:"null"};let t={};if(Array.isArray(n))t=d(n,e);else if(typeof n.type=="string")switch(n.type){case"record":t=a(n,e);break;case"enum":t=s(n);break;case"array":t=o(n,e);break;case"map":t=l(n,e);break;default:t=c(n.type,e)}else n.items?t=o(n,e):n.values&&(t=l(n,e));return!Array.isArray(n)&&n.name&&(e[n.name]=t),t}function b(n){return{...u(n,{})}}export{b as avroToJsonSchema};

package/lib/adapters/asyncapi/utils/get-channel-label.d.ts

@@ -0,0 +1,3 @@
+import type { AsyncApiChannel } from '../../../types/asyncapi.js';
+/** Shared by the nav item, the page header and message references so all three stay in sync. */
+export declare function getChannelLabel(channel: AsyncApiChannel | undefined, channelId: string): string;

package/lib/adapters/asyncapi/utils/get-channel-label.js

@@ -0,0 +1 @@
+import{asString as t}from"../../../utils/string.js";function m(r,e){return t(r?.title)??t(r?.summary)??t(r?.address)??e}export{m as getChannelLabel};

package/lib/adapters/asyncapi/utils/get-protocol-labels.d.ts

@@ -0,0 +1,24 @@
+import type { AsyncApiChannelBinding, ProtocolVariant } from '../../../types/asyncapi.js';
+type Options = {
+    channel: string;
+    channels: string;
+    servers: string;
+    server: string;
+    send: string;
+    receive: string;
+    sendLabel: string;
+    receiveLabel: string;
+    channelBinding: string;
+    payload: string;
+};
+type Params = {
+    protocol: string | null;
+    channelBindings?: AsyncApiChannelBinding;
+};
+export declare function componentLabelsByProtocol({ protocol, channelBindings }: Params): Options;
+export declare function itemLabelsByProtocol(protocol: ProtocolVariant | null, channelBindings?: AsyncApiChannelBinding): {
+    channel: string;
+    send: string;
+    receive: string;
+};
+export {};

package/lib/adapters/asyncapi/utils/get-protocol-labels.js

@@ -0,0 +1 @@
+const a={channel:"Channel",channels:"Channels",servers:"Servers",server:"Server",send:"Send",receive:"Receive",sendLabel:"Send",receiveLabel:"Receive",channelBinding:"Channel binding",payload:"Payload"},s={channel:"Topic",channels:"Topics",servers:"Brokers",server:"Broker",send:"Pub",receive:"Sub",sendLabel:"Publish",receiveLabel:"Subscribe",channelBinding:"Topic configuration",payload:"Value"},c={channel:"Exchange",channels:"Exchanges",servers:"Brokers",server:"Broker",send:"Pub",receive:"Cons",sendLabel:"Publish",receiveLabel:"Consume",channelBinding:"Exchange configuration",payload:"Payload"},i={channel:"Queue",channels:"Queues",servers:"Brokers",server:"Broker",send:"Pub",receive:"Cons",sendLabel:"Publish",receiveLabel:"Consume",channelBinding:"Queue configuration",payload:"Payload"};function o({protocol:e,channelBindings:n}){const r=n?.amqp?.is==="routingKey";switch(e){case"kafka":return s;case"amqp":return r?c:i;default:return a}}function l(e,n){switch(e){case"kafka":return{channel:"topic",send:"pub",receive:"sub"};case"amqp":return{channel:n?.amqp?.is==="routingKey"?"exch":"queue",send:"pub",receive:"cons"};default:return{channel:"channel",send:"send",receive:"receive"}}}export{o as componentLabelsByProtocol,l as itemLabelsByProtocol};

package/lib/adapters/asyncapi/utils/get-server-host.d.ts

@@ -0,0 +1,3 @@
+import type { AsyncApiServer } from '../../../types/asyncapi.js';
+/** AsyncAPI 3.x uses `host`; 2.x documents provide `url` instead. */
+export declare function getServerHost(server: AsyncApiServer): string | undefined;

package/lib/adapters/asyncapi/utils/get-server-host.js

@@ -0,0 +1 @@
+function o(t){return t.host??t.url}export{o as getServerHost};

package/lib/adapters/asyncapi/utils/resolve-schema.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncAPISchema } from '../../../types/asyncapi.js';
+export declare function resolveAsyncApiSchema(value: AsyncAPISchema | undefined): Record<string, unknown> | undefined;

package/lib/adapters/asyncapi/utils/resolve-schema.js

@@ -0,0 +1 @@
+import{avroToJsonSchema as t}from"./avro-to-json-schema.js";const n=["application/vnd.apache.avro","application/vnd.apache.avro+json","application/vnd.apache.avro+yaml"];function c(o){return o?n.some(r=>o.startsWith(r)):!1}function i(o){return typeof o=="object"&&o!==null&&"schema"in o&&"schemaFormat"in o}function e(o){return!o||typeof o!="object"?o:i(o)?c(o.schemaFormat)?t(o.schema):o.schema:o}export{e as resolveAsyncApiSchema};

package/lib/adapters/asyncapi/utils/resolveInDoc.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncApiDefinition } from '../../../types/asyncapi.js';
+export declare function resolveInDoc<T>(document: AsyncApiDefinition, value: unknown): T | undefined;

package/lib/adapters/asyncapi/utils/resolveInDoc.js

@@ -0,0 +1 @@
+import{resolveRef as r}from"../../helpers.js";function t(e,o){return r(e,o)}export{t as resolveInDoc};

package/lib/adapters/build.d.ts

@@ -0,0 +1,31 @@
+import type { DocumentNode } from 'graphql';
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../types/store.js';
+import type { OpenAPIDefinition } from '../types/openapi.js';
+import type { AsyncApiDefinition } from '../types/asyncapi.js';
+import type { ApiSpecType } from '../types/common.js';
+import type { RawApiDocsOptions } from '../types/options.js';
+import type { MarkdownParser } from './utils/parseMarkdown.js';
+type ApiDocProps = Omit<ApiDocAdapterProps, 'options'> & {
+    options: RawApiDocsOptions;
+    markdownParser: MarkdownParser;
+};
+type BuildItemsResult = {
+    items: ApiItem[];
+    store: ApiStore;
+    specType: ApiSpecType;
+};
+export declare function buildItems(props: ApiDocProps): Promise<BuildItemsResult>;
+export declare function isOpenApiDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'openapi';
+    document: OpenAPIDefinition;
+};
+export declare function isAsyncApiDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'asyncapi';
+    document: AsyncApiDefinition;
+};
+export declare function isGraphqlDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'graphql';
+    document: DocumentNode;
+};
+export declare function buildNavItems(props: ApiDocProps): Promise<Omit<BuildItemsResult, 'store'>>;
+export {};

package/lib/adapters/build.js

@@ -0,0 +1 @@
+import{normalizeOptions as s}from"../options/normalizeOptions.js";import{propagateRbacToReferencedEntries as m}from"./rbac-schema-propagation.js";async function f(e){const i=e.type,o={...s(e.options),markdownParser:e.markdownParser};let t;if(r(e)){const{processOpenApiDocument:n}=await import("./openapi/index.js");t=await n({...e,options:o})}else if(c(e)){const{processAsyncApiDocument:n}=await import("./asyncapi/index.js");t=n({...e,options:o})}else if(a(e)){const{processGraphqlDocument:n}=await import("./graphql/index.js");t=n({...e,options:o})}return t?(m(t.items,t.store),{items:t.items,store:t.store,specType:i}):{items:[],store:{schemaStore:{},exampleStore:{},securitySchemeStore:{}},specType:i}}function r(e){return e.type==="openapi"}function c(e){return e.type==="asyncapi"}function a(e){return e.type==="graphql"}async function l(e){const i=e.type,o={...s(e.options),markdownParser:e.markdownParser};if(r(e)){const{processOpenApiDocument:t}=await import("./openapi/index.js"),{items:n}=await t({...e,options:o,processContent:!1});return{items:n,specType:i}}else if(c(e)){const{processAsyncApiDocument:t}=await import("./asyncapi/index.js"),{items:n}=t({...e,options:o,processContent:!1});return{items:n,specType:i}}else if(a(e)){const{processGraphqlDocument:t}=await import("./graphql/index.js"),{items:n}=t({...e,options:o,processContent:!1});return{items:n,specType:i}}return{items:[],specType:i}}export{f as buildItems,l as buildNavItems,c as isAsyncApiDefinition,a as isGraphqlDefinition,r as isOpenApiDefinition};

package/lib/adapters/graphql/build/context.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentNode, GraphQLSchema } from 'graphql';
+import type { AdapterBuildContextInput } from '../../../types/store.js';
+import type { GraphqlBuildContext as BuildContext } from '../../../types/graphql.js';
+export type CreateBuildContextInputWithDocumentAndSchema = AdapterBuildContextInput & {
+    document: DocumentNode;
+    prebuiltSchema?: GraphQLSchema;
+    processContent?: boolean;
+};
+export declare function createBuildContext({ document, options, basePath, prebuiltSchema, processContent, }: CreateBuildContextInputWithDocumentAndSchema): BuildContext;

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

@@ -0,0 +1 @@
+import{buildASTSchema as m}from"graphql";import{normalizeMenuConfig as f}from"../utils/normalizeMenu.js";import{extractInfoFromDirectives as a}from"../../../utils/graphql-directive-utils.js";function h({document:t,options:e,basePath:o,prebuiltSchema:r,processContent:i=!0}){const c=r??m(t),n=a(c);return{basePath:o,schema:c,menuConfig:f(e?.menu,c),options:n?{...e,info:{...n,...e?.info,contact:{...n.contact,...e?.info?.contact},license:{...n.license,...e?.info?.license}}}:e,processContent:i}}export{h as createBuildContext};

package/lib/adapters/graphql/buildContext.d.ts

@@ -0,0 +1,2 @@
+import type { GraphqlBuildContext as BuildContext } from '../../types/graphql.js';
+export declare const graphqlContext: import("../scopedContext.js").ScopedContext<BuildContext>;

package/lib/adapters/graphql/buildContext.js

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

package/lib/adapters/graphql/buildStoreFromSdl.d.ts

@@ -0,0 +1,2 @@
+import type { ApiStore } from '../../types/store.js';
+export declare function buildGraphqlStoreFromSdl(sdl: string): ApiStore;

package/lib/adapters/graphql/buildStoreFromSdl.js

@@ -0,0 +1 @@
+import{buildASTSchema as o,parse as p}from"graphql";import{populateGraphqlStore as t}from"./store.js";function m(r){return t(o(p(r)))}export{m as buildGraphqlStoreFromSdl};

package/lib/adapters/graphql/group/custom.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function groupByCustomMenu(): ApiItem[];

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

@@ -0,0 +1 @@
+import{itemVariant as c}from"../../../types/common.js";import{getItemDoesNotMatchAnyGroupErrorMessage as y}from"./errors.js";import{buildDirectiveItems as C}from"../items/directive/item.js";import{buildQueryItems as E}from"../items/query/item.js";import{buildMutationItems as P}from"../items/mutation/item.js";import{buildSubscriptionItems as S}from"../items/subscription/item.js";import{buildObjectItems as U}from"../items/object/item.js";import{buildEnumItems as L}from"../items/enum/item.js";import{buildScalarItems as O}from"../items/scalar/item.js";import{buildInputItems as R}from"../items/input/item.js";import{buildUnionItems as A}from"../items/union/item.js";import{buildInterfaceItems as B}from"../items/interface/item.js";import{createGroup as p}from"./utils.js";import{graphqlContext as b}from"../buildContext.js";import{joinWithSeparator as d}from"../../../utils/url.js";import{safeSlugify as h}from"../../../utils/string.js";import{DEFAULT_GROUP_LABELS as T,GRAPHQL_VARIANTS as F}from"../utils/constants.js";import{GRAPHQL_MENU_GROUP_ITEM_BUILDERS as G}from"./itemBuilders.js";function et(){const{menuConfig:t}=b.get();if(!t?.groups)return[];const r=[],i=new Set;for(const e of t.groups){const o=M(e,i);o&&r.push(o)}if(t.requireExactGroups){const e=q(i);if(e)throw new Error(y(e))}else{const e=N(i);e&&r.push(e)}return r}function q(t){for(const r of F){const[i]=G[r]({processedItems:t});if(i)return`${w(r)} ${i.label}`}}function w(t){return t===c.QUERY||t===c.MUTATION||t===c.SUBSCRIPTION?"Operation":t===c.DIRECTIVE?"Directive":"Type"}function M(t,r){const e=t.items,o=t.types,m=[],l=b.get(),n=d(l.basePath,h(t.name?.toLowerCase())),s=(u,f)=>{if(!u)return;const I=f();I.length>0&&m.push(...I)},a=Object.entries(t).map(([u])=>u).filter(_);if(e){const u=["queries","mutations","subscriptions","directives","types"];for(const f of u)a.includes(f)||a.push(f)}for(const u of a)switch(u){case"queries":s(!!(t.queries||e),()=>E({filter:t.queries,processedItems:r,menuCommonFilter:e,parentPath:n}));break;case"mutations":s(!!(t.mutations||e),()=>P({filter:t.mutations,processedItems:r,menuCommonFilter:e,parentPath:n}));break;case"subscriptions":s(!!(t.subscriptions||e),()=>S({filter:t.subscriptions,processedItems:r,menuCommonFilter:e,parentPath:n}));break;case"directives":s(!!(t.directives||e),()=>C({filter:t.directives,processedItems:r,menuCommonFilter:e,parentPath:n}));break;case"types":s(!!(o||e),()=>[...U({filter:o,processedItems:r,menuCommonFilter:e,parentPath:n}),...B({filter:o,processedItems:r,menuCommonFilter:e,parentPath:n}),...A({filter:o,processedItems:r,menuCommonFilter:e,parentPath:n}),...L({filter:o,processedItems:r,menuCommonFilter:e,parentPath:n}),...R({filter:o,processedItems:r,menuCommonFilter:e,parentPath:n}),...O({filter:o,processedItems:r,menuCommonFilter:e})]);break}return m.length===0?null:p({label:t.name,items:m})}function N(t){const r=b.get(),i=r.menuConfig?.otherItemsGroupName||"Other",e=d(r.basePath,h(i?.toLowerCase())),o=[];for(const m of F){const l=G[m]({processedItems:t,parentPath:d(e,h(T[m]?.toLowerCase()))});l.length>0&&o.push(p({parentPath:e,typeGroup:m,items:l}))}return o.length===0?null:p({label:i,items:o})}function _(t){return t==="queries"||t==="mutations"||t==="subscriptions"||t==="directives"||t==="types"}export{et as groupByCustomMenu};

package/lib/adapters/graphql/group/default.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function groupByDefault(): ApiItem[];

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

@@ -0,0 +1 @@
+import{GRAPHQL_VARIANTS as p}from"../utils/constants.js";import{GRAPHQL_MENU_GROUP_ITEM_BUILDERS as e}from"./itemBuilders.js";import{createGroup as f}from"./utils.js";function i(){const o=[];for(const r of p){const t=e[r]();t.length>0&&o.push(f({typeGroup:r,items:t}))}return o}export{i as groupByDefault};

package/lib/adapters/graphql/group/errors.d.ts

@@ -0,0 +1 @@
+export declare function getItemDoesNotMatchAnyGroupErrorMessage(itemDescription: string): string;

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

@@ -0,0 +1 @@
+function t(o){return`All items in the GraphQL definition should belong to some group in strict mode. ${o} doesn't match any of the groups.`}export{t as getItemDoesNotMatchAnyGroupErrorMessage};

package/lib/adapters/graphql/group/itemBuilders.d.ts

@@ -0,0 +1,5 @@
+import type { GraphqlItemVariant } from '../../../types/graphql.js';
+import type { ApiItem } from '../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../items/types.js';
+export type GraphqlMenuGroupItemsBuilder = (args?: GraphqlMenuGroupItemsBuildParams) => ApiItem[];
+export declare const GRAPHQL_MENU_GROUP_ITEM_BUILDERS: Record<GraphqlItemVariant, GraphqlMenuGroupItemsBuilder>;

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

@@ -0,0 +1 @@
+import{itemVariant as m}from"../../../types/common.js";import{buildDirectiveItems as t}from"../items/directive/item.js";import{buildEnumItems as i}from"../items/enum/item.js";import{buildInputItems as r}from"../items/input/item.js";import{buildInterfaceItems as o}from"../items/interface/item.js";import{buildMutationItems as I}from"../items/mutation/item.js";import{buildObjectItems as e}from"../items/object/item.js";import{buildQueryItems as u}from"../items/query/item.js";import{buildScalarItems as p}from"../items/scalar/item.js";import{buildSubscriptionItems as b}from"../items/subscription/item.js";import{buildUnionItems as f}from"../items/union/item.js";const O={[m.QUERY]:u,[m.MUTATION]:I,[m.SUBSCRIPTION]:b,[m.DIRECTIVE]:t,[m.OBJECT]:e,[m.INTERFACE]:o,[m.INPUT]:r,[m.UNION]:f,[m.ENUM]:i,[m.SCALAR]:p};export{O as GRAPHQL_MENU_GROUP_ITEM_BUILDERS};

package/lib/adapters/graphql/group/utils.d.ts

@@ -0,0 +1,8 @@
+import type { ApiItem } from '../../../types/store.js';
+import type { GraphqlItemVariant } from '../../../types/graphql.js';
+export declare function createGroup({ typeGroup, items, label, parentPath, }: {
+    items: ApiItem[];
+    typeGroup?: GraphqlItemVariant;
+    label?: string;
+    parentPath?: string;
+}): ApiItem;

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

@@ -0,0 +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};

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

@@ -0,0 +1,10 @@
+import type { DocumentNode } from 'graphql';
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
+export declare function processGraphqlDocument({ document, options, basePath, processContent, }: ApiDocAdapterProps & {
+    document: DocumentNode;
+    processContent?: boolean;
+}): {
+    items: ApiItem[];
+    store: ApiStore;
+};
+export declare function buildGraphqlItems(): ApiItem[];

package/lib/adapters/graphql/index.js

@@ -0,0 +1 @@
+import{buildASTSchema as c}from"graphql";import{createBuildContext as p}from"./build/context.js";import{populateGraphqlStore as u}from"./store.js";import{collectMarkdownSections as l}from"../utils/markdoc.js";import{groupByDefault as a}from"./group/default.js";import{groupByCustomMenu as f}from"./group/custom.js";import{buildOverviewItem as h}from"./items/overview/item.js";import{graphqlContext as n}from"./buildContext.js";function w({document:t,options:o,basePath:r,processContent:i=!0}){const e=c(t),s=i?u(e):{schemaStore:{},exampleStore:{},securitySchemeStore:{}},m=p({document:t,options:o,basePath:r,prebuiltSchema:e,processContent:i});return n.run(m,()=>({items:S(),store:s}))}function S(){const t=n.get(),{sectionItems:o,sectionChildren:r}=t.processContent?l(t.options.info?.description||"",t.basePath,t.options):{sectionItems:[],sectionChildren:[]},e=[h(t,r),...o];return t.menuConfig?.groups?e.push(...f()):e.push(...a()),e}export{S as buildGraphqlItems,w as processGraphqlDocument};

package/lib/adapters/graphql/items/directive/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLDirective } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildDirectiveContent(directive: GraphQLDirective, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/lib/adapters/graphql/items/directive/content.js

@@ -0,0 +1 @@
+import{contentType as i,itemVariant as r,nodeTypes as a,panelKind as m}from"../../../../types/common.js";import{parseMarkdown as p}from"../../../utils/parseMarkdown.js";function u(n,o){const t=[{nodeType:a.HEADER,level:2,label:`@${n.name}`,showPageActions:!0}],l=p(n.description,o);l&&t.push({nodeType:a.MARKDOC,content:l}),n.args&&n.args.length>0&&t.push({nodeType:a.ITEM,variant:"graphql-args",label:"Arguments",labelTranslationKey:"arguments.label",graphqlTypeName:n.name,graphqlSchema:n.args.map(e=>({name:e.name,type:e.type.toString(),description:p(e.description,o)??[],deprecationReason:e.deprecationReason||void 0,defaultValue:e.defaultValue}))});const s=[];return n.locations&&n.locations.length>0&&s.push({title:"Locations",titleTranslationKey:"locations",children:[{kind:m.LOCATIONS,locations:[...n.locations]}]}),{contentType:i.ITEM,itemVariant:r.DIRECTIVE,meta:{name:n.name},seo:{title:`@${n.name}`,description:n.description||void 0},children:[{nodeType:a.CONTAINER,children:t,panels:s}]}}export{u as buildDirectiveContent};

package/lib/adapters/graphql/items/directive/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildDirectiveItems({ filter, processedItems, menuCommonFilter, parentPath, }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];