@redocly/realm 0.130.0-custom.21 → 0.130.0-custom.22

package/dist/server/plugins/openapi-docs/index.js

@@ -1 +1 @@
-import{REDOCLY_TEAMS_RBAC as O}from"@redocly/config";import{combineUrls as Y}from"@redocly/theme/core/utils";import{OPENAPI_DOCS_TEMPLATE_ID as Z,PUBLIC_RBAC_SCOPE_ITEM as ee}from"../../../constants/common.js";import{DEPRECATED_PUBLIC_API_DEFINITIONS_FOLDER as ge,PUBLIC_API_DEFINITIONS_FOLDER as Ie}from"../../constants/common.js";import{OPENAPI_CUSTOM_FIELDS_SERVER_PROPS_GETTER_ID as Pe,OPENAPI_SHARED_DATA_PREFIX as Se}from"../../constants/plugins/openapi-docs.js";import{envConfig as te}from"../../config/env-config.js";import{logger as w}from"../../tools/notifiers/logger.js";import{searchResolver as De}from"./search/search-resolver.js";import{convertOpenAPIDocs2Sidebar as ye,shouldAddRoute as Ae}from"./utils.js";import{getTemplatePath as U}from"./get-template-path.js";import{storeDefinitionBundles as Re}from"./store-definition-bundles.js";import{definitionLoader as ve,definitionsLoader as ke}from"./load-definition.js";import{getAiDocumentsStore as _e}from"./search/get-ai-search-documents.js";import{buildInstanceMetadata as be,fetchRegistryApiIdByPath as Ee,filterInstancesForApiVersion as Te,getResolvedApiVersion as Fe,hasTemplateVariables as xe,loadLinkedInstancesByApiId as Ce,patchOpenApiDefinitionWithVariables as Oe,resolveApiIdForDefinition as we}from"./instances.js";import{fromCurrentDir as Be}from"../../utils/paths.js";import{telemetryTraceStep as Me}from"../../../cli/telemetry/helpers/trace-step.js";const j="openapi-spec-download";async function at(){let a=[],r={},i={},f=new Set;return{id:"openapi",requiredEntitlements:["openapi"],loaders:{"load-oas-docs":ke,"load-oas":ve},processContent:async(e,c)=>{await Me("build.plugin.openapi_docs",async l=>{e.createRequestHandler(j,Be(import.meta.url,"./spec-download.api.js")),e.addApiRoute({slug:Ie+"/*",requestHandlerId:j,httpMethod:"all",[O]:ee,getStaticData:async()=>({props:{}})}),e.addApiRoute({slug:ge+"/*",requestHandlerId:j,httpMethod:"all",[O]:ee,getStaticData:async()=>({props:{}})});const u=e.createTemplate(Z,U("../../../client/templates/openapi-docs/template.js")),m=e.registerServerPropsGetter(Z,U("./get-server-props.js")),p=e.registerServerPropsGetter(Pe,U("./get-server-props-custom-fields.js")),n=await c.getConfig();l?.setAttribute("config",JSON.stringify(n.openapi||{}));const P=n.rules?.["custom-fields-schema"];r={},i={};const v=w.startTiming("Loading openapi definitions..."),h=await e.loadOpenApiDefinitions(c);w.infoTime(v,"Loading openapi definitions...");const B=await Ee(),E=await Ce(c);a=h.map(({markdocChunks:S,relativePath:y,customOutputRelativeFile:g,isVirtual:d,realRelativePath:M})=>({chunks:S,relativePath:y,realRelativePath:M,isVirtual:g!=null||d})),Re(h,e.outdir);const T={};for(const S of h||[]){const{definition:y,config:g,relativePath:d,customOutputRelativeFile:M,contentItems:oe,flatItems:L,parser:$,options:q,rawOptions:ne,hash:ae}=S,F=M||d,{definition:ie}=$||{},{info:A}=ie||{},I=we(S,B),se={...A?.["x-metadata"]||{}},N=!!g.openapi?.excludeFromSearch||!!g.theme?.openapi?.excludeFromSearch||!!n.openapi?.excludeFromSearch||!!n.theme?.openapi?.excludeFromSearch,z={title:A?.title,description:A?.description,summary:A?.summary,...g.metadata,...se},re=Fe(S),x=I?Te(E.get(I)||[],re):[],K=Le(y,x),W=K.map(t=>({key:t.key,title:t.title,summary:t.summary,tags:t.tags,routePrefix:t.routePrefix,routeSuffixesByItemId:{}})),ce=new Map(W.map(t=>[t.key,t])),k={untagged:[],tagged:new Map};for(const t of L){const{operationDefinition:o}=t;if(o){const{tags:_}=o;if(_)for(const R of _)k.tagged.has(R)||k.tagged.set(R,[]),k.tagged.get(R)?.push(t);else k.untagged.push(t)}}for(const t of K){const o=[],_={},R=ce.get(t.key);if(!R)continue;const pe=t.routePrefix?`${F.replace(/\.[^.]+$/,"")}/${t.routePrefix}`:F;for(const s of L){const{id:b,href:D,operationDefinition:Q}=s;if(te.isDevelopMode){const C=Q?.pointer;C&&(_[`#${C}`]=Ne(s.href,t.routePrefix))}if(!Ae({item:s}))continue;const H=s,me=H.type==="section"&&!!H.infoDefinition,X=$e(D,"");R.routeSuffixesByItemId[b]=X;const he=Q?.[O];o.push({excludeFromSearch:N,slugSuffix:X,fsPath:pe,metadata:{subType:"openapi-operation"},httpVerb:s?.httpVerb||"",path:d,templateId:u,[O]:he||g.rbac,getAiDocumentsStore:_e({parser:$,options:q,info:A,tagOperations:k,openapiContentItem:H,metadata:z,relativePath:d,getSearchFacets:e.getSearchFacets,includeInLLMsTxt:me,excludeFromSearch:N}),getStaticData:async C=>({props:{dynamicMarkdocComponents:["openapi"],baseSlug:C.baseSlug,seo:s["x-metadata"]?.seo||{title:s.name,description:s.description},itemId:b,disableAutoScroll:!0}})})}if(!o.length)continue;const J=t.key!==""&&!!t.sourceInstance,de=J&&I&&t.sourceInstance?be(t.sourceInstance,I):{},le=J?{}:{...x.length>0?{instanceCount:x.length}:{},...x.length===0&&xe(y)?{isTemplate:!0}:{}},V=t.definition?.info?.title;o[0]={...o[0],metadata:{type:"openapi",...z,...de,...le,...I?{apiId:I}:{}},hasClientRoutes:!0,getSidebar:(s,b)=>{const D=[];return ye({contentItems:oe,sidebarItems:D,routeSlug:s.slug,navItem:b}),V&&D.length>0&&D[0]&&!b?.label&&(D[0].label=V),D},getNavText:()=>V||A?.title,getSearchDocuments:De($,q,L,e.getSearchFacets,e.setSearchFacets,N)},I&&t.key===""&&(T[I]={slug:o[0]?.slug||""});const fe=o[0];o[0]=o[o.length-1],o[o.length-1]=fe;const ue=te.isDevelopMode?d:void 0,G=`${Se}${F}::${t.id}`;i[d]=[...i[d]||[],G],r[G]={fsPath:F,definition:t.definition,options:ne,instances:W,currentInstanceKey:t.key,sourcePath:ue,routesMapping:_,hash:ae};for(const s of o)e.addRoute({...s,sharedData:[{id:G,key:"openAPIDocsStore"}],serverPropsGetterIds:P?[m,p]:[m]})}}e.setGlobalData({apiProducts:T})})},afterRoutesCreated:async(e,c)=>{const l=w.startTiming("Parsing openapi markdoc chunks..."),u=new Set;for(const{chunks:p,relativePath:n,isVirtual:P,realRelativePath:v}of a){const h=(await c.cache.load(v,"load-oas")).compoundHash,B=i[n]||[];await c.cache.load(n,{loader:async function(){for(const{node:T,markdown:S,key:y,relativePath:g}of p){const{ast:d}=await e.parseMarkdoc({content:S,relativePath:g,isVirtual:P},c,{sharedDataIds:B});T[`x-parsed-md-${y}`]={result:d}}},name:"openapi-markdoc-inline-parser"},[h]);for(const{pointer:E}of p)u.add(E)}w.infoTime(l,"Parsing openapi markdoc chunks...");const m=f.difference(u);for(const p of m)c.cache.delete(p);f=u;for(const[p,n]of Object.entries(r)){for(const P of n.instances||[]){const v=P.routePrefix?`${n.fsPath.replace(/\.[^.]+$/,"")}/${P.routePrefix}`:n.fsPath,h=e.getRouteByFsPath(v);h&&(P.baseSlug=h.baseSlug)}await e.createSharedData(p,{...n,baseSlug:e.getRouteByFsPath(n.fsPath)?.baseSlug},n.hash)}}}}function Le(a,r){const i=[{id:"default",key:"",title:"Default",routePrefix:"",definition:a}],f=new Set;for(const e of r){const c=Ve(e.key)||"instance";let l=`instances/${c}`,u=2;for(;f.has(l);)l=`instances/${c}-${u}`,u++;f.add(l);const m=Oe(a,e.variables),p=e.title?{...m,info:{...m.info||{},title:e.title}}:m;i.push({id:`instance-${l.replace(/[\/:]/g,"-")}`,key:e.key,title:e.title,summary:e.summary,tags:e.tags,routePrefix:l,definition:p,sourceInstance:e})}return i}function $e(a,r){const i=a.split("#")[0]+"/";return r?Y("/",r,i):i}function Ne(a,r){if(!r)return a;const[i="",f]=a.split("#"),e=Y("/",r,i||"/");return f?`${e}#${f}`:e}function Ve(a){return a.trim().toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}export{at as openAPIDocsPlugin};
+import{REDOCLY_TEAMS_RBAC as O}from"@redocly/config";import{combineUrls as Z}from"@redocly/theme/core/utils";import{OPENAPI_DOCS_TEMPLATE_ID as ee,PUBLIC_RBAC_SCOPE_ITEM as te}from"../../../constants/common.js";import{DEPRECATED_PUBLIC_API_DEFINITIONS_FOLDER as ge,PUBLIC_API_DEFINITIONS_FOLDER as Ie}from"../../constants/common.js";import{OPENAPI_CUSTOM_FIELDS_SERVER_PROPS_GETTER_ID as Pe,OPENAPI_SHARED_DATA_PREFIX as Se}from"../../constants/plugins/openapi-docs.js";import{envConfig as oe}from"../../config/env-config.js";import{logger as w}from"../../tools/notifiers/logger.js";import{searchResolver as De}from"./search/search-resolver.js";import{convertOpenAPIDocs2Sidebar as ye,shouldAddRoute as Ae}from"./utils.js";import{getTemplatePath as U}from"./get-template-path.js";import{storeDefinitionBundles as Re,storeDefinitionBundle as ve}from"./store-definition-bundles.js";import{definitionLoader as ke,definitionsLoader as _e}from"./load-definition.js";import{getAiDocumentsStore as be}from"./search/get-ai-search-documents.js";import{buildInstanceMetadata as Ee,fetchRegistryApiIdByPath as Te,filterInstancesForApiVersion as xe,getResolvedApiVersion as Fe,hasTemplateVariables as Ce,loadLinkedInstancesByApiId as Oe,patchOpenApiDefinitionWithVariables as we,resolveApiIdForDefinition as Be}from"./instances.js";import{fromCurrentDir as Me}from"../../utils/paths.js";import{telemetryTraceStep as Le}from"../../../cli/telemetry/helpers/trace-step.js";const j="openapi-spec-download";async function it(){let a=[],r={},i={},f=new Set;return{id:"openapi",requiredEntitlements:["openapi"],loaders:{"load-oas-docs":_e,"load-oas":ke},processContent:async(e,c)=>{await Le("build.plugin.openapi_docs",async l=>{e.createRequestHandler(j,Me(import.meta.url,"./spec-download.api.js")),e.addApiRoute({slug:Ie+"/*",requestHandlerId:j,httpMethod:"all",[O]:te,getStaticData:async()=>({props:{}})}),e.addApiRoute({slug:ge+"/*",requestHandlerId:j,httpMethod:"all",[O]:te,getStaticData:async()=>({props:{}})});const u=e.createTemplate(ee,U("../../../client/templates/openapi-docs/template.js")),m=e.registerServerPropsGetter(ee,U("./get-server-props.js")),p=e.registerServerPropsGetter(Pe,U("./get-server-props-custom-fields.js")),n=await c.getConfig();l?.setAttribute("config",JSON.stringify(n.openapi||{}));const P=n.rules?.["custom-fields-schema"];r={},i={};const v=w.startTiming("Loading openapi definitions..."),h=await e.loadOpenApiDefinitions(c);w.infoTime(v,"Loading openapi definitions...");const B=await Te(),E=await Oe(c);a=h.map(({markdocChunks:S,relativePath:y,customOutputRelativeFile:g,isVirtual:d,realRelativePath:M})=>({chunks:S,relativePath:y,realRelativePath:M,isVirtual:g!=null||d})),Re(h,e.outdir);const T={};for(const S of h||[]){const{definition:y,config:g,relativePath:d,customOutputRelativeFile:M,contentItems:ne,flatItems:L,parser:$,options:q,rawOptions:ae,hash:ie}=S,x=M||d,{definition:se}=$||{},{info:A}=se||{},I=Be(S,B),re={...A?.["x-metadata"]||{}},N=!!g.openapi?.excludeFromSearch||!!g.theme?.openapi?.excludeFromSearch||!!n.openapi?.excludeFromSearch||!!n.theme?.openapi?.excludeFromSearch,z={title:A?.title,description:A?.description,summary:A?.summary,...g.metadata,...re},ce=Fe(S),F=I?xe(E.get(I)||[],ce):[],K=$e(y,F),W=K.map(t=>({key:t.key,title:t.title,summary:t.summary,tags:t.tags,routePrefix:t.routePrefix,routeSuffixesByItemId:{}})),pe=new Map(W.map(t=>[t.key,t])),k={untagged:[],tagged:new Map};for(const t of L){const{operationDefinition:o}=t;if(o){const{tags:_}=o;if(_)for(const R of _)k.tagged.has(R)||k.tagged.set(R,[]),k.tagged.get(R)?.push(t);else k.untagged.push(t)}}for(const t of K){const o=[],_={},R=pe.get(t.key);if(!R)continue;const J=t.routePrefix?`${x.replace(/\.[^.]+$/,"")}/${t.routePrefix}`:x;t.routePrefix&&ve(t.definition,J,e.outdir);for(const s of L){const{id:b,href:D,operationDefinition:X}=s;if(oe.isDevelopMode){const C=X?.pointer;C&&(_[`#${C}`]=Ve(s.href,t.routePrefix))}if(!Ae({item:s}))continue;const H=s,me=H.type==="section"&&!!H.infoDefinition,Y=Ne(D,"");R.routeSuffixesByItemId[b]=Y;const he=X?.[O];o.push({excludeFromSearch:N,slugSuffix:Y,fsPath:J,metadata:{subType:"openapi-operation"},httpVerb:s?.httpVerb||"",path:d,templateId:u,[O]:he||g.rbac,getAiDocumentsStore:be({parser:$,options:q,info:A,tagOperations:k,openapiContentItem:H,metadata:z,relativePath:d,getSearchFacets:e.getSearchFacets,includeInLLMsTxt:me,excludeFromSearch:N}),getStaticData:async C=>({props:{dynamicMarkdocComponents:["openapi"],baseSlug:C.baseSlug,seo:s["x-metadata"]?.seo||{title:s.name,description:s.description},itemId:b,disableAutoScroll:!0}})})}if(!o.length)continue;const Q=t.key!==""&&!!t.sourceInstance,de=Q&&I&&t.sourceInstance?Ee(t.sourceInstance,I):{},le=Q?{}:{...F.length>0?{instanceCount:F.length}:{},...F.length===0&&Ce(y)?{isTemplate:!0}:{}},V=t.definition?.info?.title;o[0]={...o[0],metadata:{type:"openapi",...z,...de,...le,...I?{apiId:I}:{}},hasClientRoutes:!0,getSidebar:(s,b)=>{const D=[];return ye({contentItems:ne,sidebarItems:D,routeSlug:s.slug,navItem:b}),V&&D.length>0&&D[0]&&!b?.label&&(D[0].label=V),D},getNavText:()=>V||A?.title,getSearchDocuments:De($,q,L,e.getSearchFacets,e.setSearchFacets,N)},I&&t.key===""&&(T[I]={slug:o[0]?.slug||""});const fe=o[0];o[0]=o[o.length-1],o[o.length-1]=fe;const ue=oe.isDevelopMode?d:void 0,G=`${Se}${x}::${t.id}`;i[d]=[...i[d]||[],G],r[G]={fsPath:x,definition:t.definition,options:ae,instances:W,currentInstanceKey:t.key,sourcePath:ue,routesMapping:_,hash:ie};for(const s of o)e.addRoute({...s,sharedData:[{id:G,key:"openAPIDocsStore"}],serverPropsGetterIds:P?[m,p]:[m]})}}e.setGlobalData({apiProducts:T})})},afterRoutesCreated:async(e,c)=>{const l=w.startTiming("Parsing openapi markdoc chunks..."),u=new Set;for(const{chunks:p,relativePath:n,isVirtual:P,realRelativePath:v}of a){const h=(await c.cache.load(v,"load-oas")).compoundHash,B=i[n]||[];await c.cache.load(n,{loader:async function(){for(const{node:T,markdown:S,key:y,relativePath:g}of p){const{ast:d}=await e.parseMarkdoc({content:S,relativePath:g,isVirtual:P},c,{sharedDataIds:B});T[`x-parsed-md-${y}`]={result:d}}},name:"openapi-markdoc-inline-parser"},[h]);for(const{pointer:E}of p)u.add(E)}w.infoTime(l,"Parsing openapi markdoc chunks...");const m=f.difference(u);for(const p of m)c.cache.delete(p);f=u;for(const[p,n]of Object.entries(r)){for(const P of n.instances||[]){const v=P.routePrefix?`${n.fsPath.replace(/\.[^.]+$/,"")}/${P.routePrefix}`:n.fsPath,h=e.getRouteByFsPath(v);h&&(P.baseSlug=h.baseSlug)}await e.createSharedData(p,{...n,baseSlug:e.getRouteByFsPath(n.fsPath)?.baseSlug},n.hash)}}}}function $e(a,r){const i=[{id:"default",key:"",title:"Default",routePrefix:"",definition:a}],f=new Set;for(const e of r){const c=Ge(e.key)||"instance";let l=`instances/${c}`,u=2;for(;f.has(l);)l=`instances/${c}-${u}`,u++;f.add(l);const m=we(a,e.variables),p=e.title?{...m,info:{...m.info||{},title:e.title}}:m;i.push({id:`instance-${l.replace(/[\/:]/g,"-")}`,key:e.key,title:e.title,summary:e.summary,tags:e.tags,routePrefix:l,definition:p,sourceInstance:e})}return i}function Ne(a,r){const i=a.split("#")[0]+"/";return r?Z("/",r,i):i}function Ve(a,r){if(!r)return a;const[i="",f]=a.split("#"),e=Z("/",r,i||"/");return f?`${e}#${f}`:e}function Ge(a){return a.trim().toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}export{it as openAPIDocsPlugin};

package/dist/server/plugins/openapi-docs/store-definition-bundles.d.ts

@@ -1,4 +1,5 @@
 import type { BundledDefinition } from './load-definition';
 export declare function storeDefinitionBundles(definitions: BundledDefinition[], outDir: string): void;
+export declare function storeDefinitionBundle(definition: unknown, relativePath: string, outDir: string): void;
 export declare function replaceFileExtension(filePath: string, fileExt: string): string;
 //# sourceMappingURL=store-definition-bundles.d.ts.map

package/dist/server/plugins/openapi-docs/store-definition-bundles.js

@@ -1 +1 @@
-import{writeFileSync as u}from"fs";import o from"path";import{dump as x}from"js-yaml";import{PUBLIC_API_DEFINITIONS_FOLDER as g,PUBLIC_STATIC_FOLDER as c}from"../../constants/common.js";import{logger as h}from"../../tools/notifiers/logger.js";import{ensureDir as D}from"../../utils/fs.js";const a=new Map;function j(i,t){const r=g.slice(1);try{for(const n of i){const{definition:m,originalDefinition:p,relativePath:e,hash:s}=n,f=p||m;if(a.get(e)!==s){if(e.startsWith(c+"/")){const d=o.posix.extname(e);l({outDir:t,definitionFolder:".",relativePath:e.replace(c+"/",""),definitionString:d===".json"?JSON.stringify(f,null,2):x(f)}),a.set(e,s);continue}l({outDir:t,definitionFolder:r,relativePath:F(e,".json"),definitionString:JSON.stringify(f,null,2)}),a.set(e,s)}}}catch(n){h.error("failed to store definition bundles",n)}}function F(i,t){const r=o.posix.dirname(i),n=o.posix.basename(i,o.posix.extname(i))+t;return o.posix.join(r,n)}function l({outDir:i,definitionString:t,relativePath:r,definitionFolder:n}){u(D(o.resolve(i,`${n}/${r}`)),t,"utf8")}export{F as replaceFileExtension,j as storeDefinitionBundles};
+import{writeFileSync as S}from"fs";import r from"path";import{dump as h}from"js-yaml";import{PUBLIC_API_DEFINITIONS_FOLDER as d,PUBLIC_STATIC_FOLDER as p}from"../../constants/common.js";import{logger as m}from"../../tools/notifiers/logger.js";import{ensureDir as D}from"../../utils/fs.js";const l=new Map;function v(i,n){const t=d.slice(1);try{for(const e of i){const{definition:s,originalDefinition:x,relativePath:o,hash:f}=e,c=x||s;if(l.get(o)!==f){if(o.startsWith(p+"/")){const g=r.posix.extname(o);a({outDir:n,definitionFolder:".",relativePath:o.replace(p+"/",""),definitionString:g===".json"?JSON.stringify(c,null,2):h(c)}),l.set(o,f);continue}a({outDir:n,definitionFolder:t,relativePath:u(o,".json"),definitionString:JSON.stringify(c,null,2)}),l.set(o,f)}}}catch(e){m.error("failed to store definition bundles",e)}}function _(i,n,t){const e=d.slice(1);try{a({outDir:t,definitionFolder:e,relativePath:u(n,".json"),definitionString:JSON.stringify(i,null,2)})}catch(s){m.error(`failed to store definition bundle for ${n}`,s)}}function u(i,n){const t=r.posix.dirname(i),e=r.posix.basename(i,r.posix.extname(i))+n;return r.posix.join(t,e)}function a({outDir:i,definitionString:n,relativePath:t,definitionFolder:e}){S(D(r.resolve(i,`${e}/${t}`)),n,"utf8")}export{u as replaceFileExtension,_ as storeDefinitionBundle,v as storeDefinitionBundles};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/realm",
-  "version": "0.130.0-custom.21",
+  "version": "0.130.0-custom.22",
   "description": "",
   "type": "module",
   "bin": {
@@ -91,14 +91,14 @@
     "xpath": "0.0.34",
     "yaml-ast-parser": "0.0.43",
     "zod": "^3.25.76",
-    "@redocly/asyncapi-docs": "1.7.0-custom.2",
-    "@redocly/openapi-docs": "3.18.0-custom.1",
     "@redocly/graphql-docs": "1.7.0-custom.2",
-    "@redocly/config": "0.43.0-custom.1",
-    "@redocly/portal-plugin-mock-server": "0.16.0-next.4",
+    "@redocly/asyncapi-docs": "1.7.0-custom.2",
     "@redocly/portal-legacy-ui": "0.14.0-next.0",
+    "@redocly/openapi-docs": "3.18.0-custom.1",
     "@redocly/realm-asyncapi-sdk": "0.9.0-next.1",
-    "@redocly/theme": "0.62.0-custom.2"
+    "@redocly/theme": "0.62.0-custom.2",
+    "@redocly/config": "0.43.0-custom.1",
+    "@redocly/portal-plugin-mock-server": "0.16.0-next.4"
   },
   "peerDependencies": {
     "react": "^19.2.4",