@redocly/redoc 0.129.0-next.2 → 0.129.0-next.3

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/arazzo-entities-extractor.d.ts

@@ -6,9 +6,9 @@ type Params = BaseApiEntitiesExtractorParams;
 export declare class ArazzoEntitiesExtractor extends BaseApiEntitiesExtractor<BundledDefinition> {
     #private;
     constructor(params: Params);
-    mapApiDescriptionToEntity(description: BundledDefinition): EntityFileSchema;
+    mapApiDescriptionToEntity(description: BundledDefinition, version: string): EntityFileSchema;
     loadApiDescriptions(): Promise<BundledDefinition[]>;
-    processApiDescription(description: BundledDefinition): Promise<Set<string>>;
+    processApiDescription(description: BundledDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
     resolveSourceDescriptionUrl(url: string, baseRelativePath: string): string | null;
 }
 export {};

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/arazzo-entities-extractor.js

@@ -1 +1 @@
-import h from"node:path";import{removeLeadingSlash as u}from"@redocly/theme/core/utils";import{toKebabCase as p}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as y}from"../../../../../utils/async/promise-map-limit.js";import{removeMarkdocTags as d}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{resolveEntityVersion as g}from"../../../utils/resolve-entity-version.js";import{BaseApiEntitiesExtractor as w}from"./base.js";const m=15;class A extends w{constructor(t){super("arazzo",t)}mapApiDescriptionToEntity(t){const o=u(t.realRelativePath),a=t.document.info.title,c=o.replace(/\.[^.]+$/,""),e=p(c.replace(/[\\/]/g,"-")),r=t.document["x-redocly-catalog-key"],n=typeof r=="string"&&r.trim()?p(r.trim()):e,l=t.document.info.version,s=g(l,t.realRelativePath);if(!s.success)throw new Error(`Arazzo "${a}" in file "${t.realRelativePath}" has conflicting versions: spec version "${s.fileVersion}" differs from folder version "${s.folderVersion}". Entity will not be created.`);return{type:this.type,key:n,title:a,summary:t.document.info.description?d(t.document.info.description):null,tags:["arazzo"],metadata:{specType:this.specType,descriptionFile:o},version:s.version}}async loadApiDescriptions(){return(await this.context.cache.load(".","arazzo-docs")).data}async processApiDescription(t){const o=new Set;if(!this.#t(t))return this.context.logger.warn(`Skipping Arazzo description without source descriptions: ${t.realRelativePath}`),o;const a=this.mapApiDescriptionToEntity(t);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:a,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0}),o.add(a.key),await this.#e(t,a.key,a.version,o);const c=t.document.sourceDescriptions||[];return await y(c,m,async e=>{if(!(e.type!=="openapi"||!e.url))try{const r=this.resolveSourceDescriptionUrl(e.url,t.realRelativePath);if(!r){!e.url.startsWith("http://")&&!e.url.startsWith("https://")&&this.context.logger.warn(`Could not resolve URL to local path: ${e.url}`);return}const n=await this.context.cache.load(r,"load-oas");if(!(n.data&&Array.isArray(n.data)&&n.data.length>0)){this.context.logger.warn(`No OpenAPI definition found at path: ${r}`);return}const s=n.data[0],i=p(u(s.realRelativePath).replace(/\.[^.]+$/,"").replace(/[\\/]/g,"-"));await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:a.key,type:"relatesTo",targetKey:i,fileHash:t.hash}),await this.#r(t,e.name,s,a.key,i,a.version)}catch(r){this.context.logger.warn(`Failed to create relation to OpenAPI source "${e.url}": ${r instanceof Error?r.message:"Unknown error"}`)}}),o}#t=t=>!!t?.document?.sourceDescriptions&&t.document.sourceDescriptions.length>0;#e=async(t,o,a,c)=>{try{const e=t.document.components?.inputs,r=e?Object.entries(e):[],n=[];for(const[l,s]of r)n.push(async()=>{const i=await this.#a({schemaName:l,schema:s,description:t,parentKey:o,parentVersion:a});c.add(i),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:o,type:"uses",targetKey:i,fileHash:t.hash,sourceVersion:a,targetVersion:a})});if(n.length===0)return;await y(n,m,l=>l())}catch(e){this.context.logger.warn(`Failed to create data schema entities for Arazzo description: ${e instanceof Error?e.message:"Unknown error"}`)}};#a=async({schemaName:t,schema:o,description:a,parentKey:c,parentVersion:e})=>{const r={type:"data-schema",key:`${c}-${p(t)}`,title:t,summary:o.description||o.title||null,tags:["arazzo"],metadata:{specType:this.specType,descriptionFile:a.realRelativePath,schema:"{}"},version:e};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:r,sourceFile:a.realRelativePath,fileHash:a.hash}),r.key};#r=async(t,o,a,c,e,r)=>{const n=t.document.workflows||[];if(n.length===0)return;const l=new Set;for(const s of n)for(const i of s.steps||[]){if(!i.operationId)continue;const f=i.operationId.startsWith(`${o}.`)?i.operationId.substring(`${o}.`.length):i.operationId;f&&l.add(f)}l.size!==0&&await y(Array.from(l),m,async s=>{try{const i=`${e}-${p(s)}`;await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:c,type:"uses",targetKey:i,fileHash:t.hash,sourceVersion:r,targetVersion:r})}catch(i){this.context.logger.warn(`Failed to create relation to operation "${s}": ${i instanceof Error?i.message:"Unknown error"}`)}})};resolveSourceDescriptionUrl(t,o){try{const a=t.trim(),c=a.startsWith("@")?a.slice(1):a,[e]=c.split("#");if(e.startsWith("http://")||e.startsWith("https://"))return null;if(e.startsWith("/"))return u(h.posix.normalize(e));const r=h.posix.dirname(o);return e.startsWith(r+"/")?h.posix.normalize(e):h.posix.normalize(h.posix.join(r,e))}catch{return this.context.logger.warn(`Failed to resolve URL: ${t}`),null}}}export{A as ArazzoEntitiesExtractor};
+import u from"node:path";import{removeLeadingSlash as m}from"@redocly/theme/core/utils";import{toKebabCase as y}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as f}from"../../../../../utils/async/promise-map-limit.js";import{removeMarkdocTags as d}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as w}from"./base.js";const g=15;class k extends w{constructor(t){super("arazzo",t)}mapApiDescriptionToEntity(t,o){const r=m(t.realRelativePath),c=t.document.info.title,e=r.replace(/\.[^.]+$/,""),n=y(e.replace(/[\\/]/g,"-")),a=t.document["x-redocly-catalog-key"],i=typeof a=="string"&&a.trim()?y(a.trim()):n;return{type:this.type,key:i,title:c,summary:t.document.info.description?d(t.document.info.description):null,tags:["arazzo"],metadata:{specType:this.specType,descriptionFile:r},version:o}}async loadApiDescriptions(){return(await this.context.cache.load(".","arazzo-docs")).data}async processApiDescription(t,o,r,c){if(!this.#t(t)){this.context.logger.warn(`Skipping Arazzo description without source descriptions: ${t.realRelativePath}`);return}const e=this.mapApiDescriptionToEntity(t,r);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:e,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0,revision:o}),c.delete(`${e.key}:${r}`),await this.#e(t,e.key,e.version,r,o,c);const n=t.document.sourceDescriptions||[];await f(n,g,async a=>{if(!(a.type!=="openapi"||!a.url))try{const i=this.resolveSourceDescriptionUrl(a.url,t.realRelativePath);if(!i){!a.url.startsWith("http://")&&!a.url.startsWith("https://")&&this.context.logger.warn(`Could not resolve URL to local path: ${a.url}`);return}const l=await this.context.cache.load(i,"load-oas");if(!(l.data&&Array.isArray(l.data)&&l.data.length>0)){this.context.logger.warn(`No OpenAPI definition found at path: ${i}`);return}const s=l.data[0],p=y(m(s.realRelativePath).replace(/\.[^.]+$/,"").replace(/[\\/]/g,"-"));await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e.key,type:"relatesTo",targetKey:p,fileHash:t.hash}),await this.#r(t,a.name,s,e.key,p,e.version,o)}catch(i){this.context.logger.warn(`Failed to create relation to OpenAPI source "${a.url}": ${i instanceof Error?i.message:"Unknown error"}`)}})}#t=t=>!!t?.document?.sourceDescriptions&&t.document.sourceDescriptions.length>0;#e=async(t,o,r,c,e,n)=>{try{const a=t.document.components?.inputs,i=a?Object.entries(a):[],l=[];for(const[h,s]of i)l.push(async()=>{const p=await this.#a({schemaName:h,schema:s,description:t,parentKey:o,parentVersion:r,parentRevision:e});n.delete(`${p.entityKey}:${c}`),p.result==="created"&&await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:o,type:"uses",targetKey:p.entityKey,fileHash:t.hash,sourceVersion:r,targetVersion:r,sourceRevision:e,targetRevision:e})});if(l.length===0)return;await f(l,g,h=>h())}catch(a){this.context.logger.warn(`Failed to create data schema entities for Arazzo description: ${a instanceof Error?a.message:"Unknown error"}`)}};#a=async({schemaName:t,schema:o,description:r,parentKey:c,parentVersion:e,parentRevision:n})=>{const a={type:"data-schema",key:`${c}-${y(t)}`,title:t,summary:o.description||o.title||null,tags:["arazzo"],metadata:{specType:this.specType,descriptionFile:r.realRelativePath,schema:"{}"},version:e};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:a,sourceFile:r.realRelativePath,fileHash:r.hash,revision:n})};#r=async(t,o,r,c,e,n,a)=>{const i=t.document.workflows||[];if(i.length===0)return;const l=new Set;for(const h of i)for(const s of h.steps||[]){if(!s.operationId)continue;const p=s.operationId.startsWith(`${o}.`)?s.operationId.substring(`${o}.`.length):s.operationId;p&&l.add(p)}l.size!==0&&await f(Array.from(l),g,async h=>{try{const s=`${e}-${y(h)}`;await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:c,type:"uses",targetKey:s,fileHash:t.hash,sourceVersion:n,targetVersion:n,sourceRevision:a,targetRevision:a})}catch(s){this.context.logger.warn(`Failed to create relation to operation "${h}": ${s instanceof Error?s.message:"Unknown error"}`)}})};resolveSourceDescriptionUrl(t,o){try{const r=t.trim(),c=r.startsWith("@")?r.slice(1):r,[e]=c.split("#");if(e.startsWith("http://")||e.startsWith("https://"))return null;if(e.startsWith("/"))return m(u.posix.normalize(e));const n=u.posix.dirname(o);return e.startsWith(n+"/")?u.posix.normalize(e):u.posix.normalize(u.posix.join(n,e))}catch{return this.context.logger.warn(`Failed to resolve URL: ${t}`),null}}}export{k as ArazzoEntitiesExtractor};

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/asyncapi-entities-extractor.d.ts

@@ -6,9 +6,9 @@ type Params = BaseApiEntitiesExtractorParams;
 export declare class AsyncApiEntitiesExtractor extends BaseApiEntitiesExtractor<BundledDefinition> {
     #private;
     constructor(params: Params);
-    mapApiDescriptionToEntity(description: BundledDefinition): EntityFileSchema;
+    mapApiDescriptionToEntity(description: BundledDefinition, version: string): EntityFileSchema;
     loadApiDescriptions(): Promise<BundledDefinition[]>;
-    processApiDescription(description: BundledDefinition): Promise<Set<string>>;
+    processApiDescription(description: BundledDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
 }
 export {};
 //# sourceMappingURL=asyncapi-entities-extractor.d.ts.map

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/asyncapi-entities-extractor.js

@@ -1 +1 @@
-import{removeLeadingSlash as p}from"@redocly/theme/core/utils";import{toKebabCase as l}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as y}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as f}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as g}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as d}from"./base.js";import{extractPartsFromComponentsRef as u}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as R}from"../../../entities/validate-entity.js";import{extractPartsFromChannelsMessageRef as E}from"../../../utils/extract-parts-from-channels-message-ref.js";import{resolveEntityVersion as $}from"../../../utils/resolve-entity-version.js";const m=15;class I extends d{constructor(e){super("asyncapi",e)}mapApiDescriptionToEntity(e){const t=p(e.realRelativePath),a=e.document.info.title,n=t.replace(/\.[^.]+$/,""),s=l(n.replace(/[\\/]/g,"-")),r=e.document["x-redocly-catalog-key"],i=typeof r=="string"&&r.trim()?l(r.trim()):s,o=e.document.info.version,c=$(o,e.realRelativePath);if(!c.success)throw new Error(`AsyncAPI "${a}" in file "${e.realRelativePath}" has conflicting versions: spec version "${c.fileVersion}" differs from folder version "${c.folderVersion}". Entity will not be created.`);return{type:this.type,key:i,title:a,summary:g(e.document.info.description),tags:e.document.info.tags?.map(h=>h.name),metadata:{specType:this.specType,descriptionFile:t},version:c.version}}async loadApiDescriptions(){return(await this.context.cache.load(".","asyncapi-docs")).data}async processApiDescription(e){const t=new Set,a=this.mapApiDescriptionToEntity(e);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:a,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:!0}),t.add(a.key);const n=this.#t(e),[s,r]=await Promise.allSettled([this.#a(e,a.key,a.version,t),this.#n(n,e,a.key,a.version,t)]);return s.status!=="fulfilled"&&this.context.logger.error("Schema processing failed:",s.reason),r.status!=="fulfilled"&&this.context.logger.error("Operation processing failed:",r.reason),t}#t=e=>{const t=e.documentWithReferences.operations;return t?Object.entries(t).map(([a,n])=>({operationName:a,operation:n})):[]};#a=async(e,t,a,n)=>{const s=e.document.components?.schemas;if(!s)return;const r=Object.entries(s);if(r.length===0)return;const i=await f(r,m,async([o,c])=>{const h=await this.#s({schemaName:o,schema:c,description:e,parentKey:t,parentVersion:a});n.add(h),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"uses",targetKey:h,fileHash:e.hash,sourceVersion:a,targetVersion:a})},this.context.logger);i.count.failed>0&&this.context.logger.warn(`Schema processing completed with ${i.count.failed} failures out of ${r.length} schemas for ${e.realRelativePath}`)};#s=async({schemaName:e,schema:t,description:a,parentKey:n,parentVersion:s})=>{const r=`${n}-${l(e)}`,i="title"in t?t.title??t.description:null,o=JSON.stringify(t),c={type:"data-schema",key:r,title:e,summary:i,tags:[],metadata:{specType:this.specType,schema:o},version:s};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:a.realRelativePath,fileHash:a.hash}),c.key};#n=async(e,t,a,n,s)=>{if(!e.length)return;const r=await f(e,m,async({operationName:i,operation:o})=>{const c=await this.#r(o,i,t,a,n);c&&s.add(c)},this.context.logger);r.count.failed>0&&this.context.logger.warn(`Operation processing completed with ${r.count.failed} failures out of ${e.length} operations for ${t.realRelativePath}`)};#r=async(e,t,a,n,s)=>{const r=`${n}-${l(t)}`,i=await this.#o({apiOperationKey:r,operation:e,descriptionUniqueKey:n,description:a,descriptionVersion:s});return await this.#i(t,e,i,a,n,s)??null};#i=async(e,t,a,n,s,r)=>{const i={type:"api-operation",key:`${s}-${l(e)}`,title:t.title||e,summary:t.summary??"",tags:t.tags?.map(o=>o.name)??[],metadata:{method:t.action==="send"?"PUBLISH":"SUBSCRIBE",path:t.channel.address??"",payload:t.action==="receive"?a:[],responses:t.action==="send"?a:[]},version:r};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:i,sourceFile:n.realRelativePath,fileHash:n.hash}),i.key};#o=async({apiOperationKey:e,operation:t,descriptionUniqueKey:a,description:n,descriptionVersion:s})=>(await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:a,fileHash:n.hash,sourceVersion:s,targetVersion:s}),await this.#c(t,e,s),!Array.isArray(t.messages)||!t.messages?.length?[]:await this.#l(t.messages,e,n,a,s));#c=async(e,t,a)=>{e["x-catalog-relations"]?.length&&await y(e["x-catalog-relations"],m,async n=>{try{R(n),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:n.type,targetKey:n.key,sourceVersion:a,targetVersion:a})}catch(s){this.context.logger.warn(`Error creating entity relation for operation ${t} based on custom property: ${s instanceof Error?s.message:"Unknown error"}`)}})};#l=async(e,t,a,n,s)=>e.length===0?[]:(await y(e,m,async i=>await this.#h(i,t,a,n,s)??"")).filter(i=>!!i);#h=async(e,t,a,n,s)=>"$ref"in e?this.#m(e,t,a,n,s):e.payload?this.#f(e,t,a,n,s):null;#m=async(e,t,a,n,s)=>{const r=e.$ref.startsWith("#/channels/")?this.#y(e.$ref,a):e.$ref;if(!r)return null;const i=u(r);if(!i||!i.componentName||i.componentType!=="messages")return null;const o=a.documentWithReferences.components?.messages[i.componentName];return!o?.payload||!("$ref"in o.payload)||!o.payload.$ref?null:this.#e(o.payload.$ref,t,a,n,s)};#y=(e,t)=>{const a=E(e);if(!a||!a.channelName||!a.messageName)return null;const n=t.documentWithReferences.channels?.[a.channelName];if(!n?.messages)return null;const s=n.messages[a.messageName];return!s||!("$ref"in s)||typeof s.$ref!="string"||!s.$ref.startsWith("#/components/messages/")?null:s.$ref};#f=async(e,t,a,n,s)=>!e.payload||!("$ref"in e.payload)||!e.payload.$ref?null:this.#e(e.payload.$ref,t,a,n,s);#e=async(e,t,a,n,s)=>{const r=u(e);if(!r||!r.componentName||r.componentType!=="schemas")return null;const i=`${n}-${l(r.componentName)}`;return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"uses",targetKey:i,fileHash:a.hash,sourceVersion:s,targetVersion:s}),i}}export{I as AsyncApiEntitiesExtractor};
+import{removeLeadingSlash as $}from"@redocly/theme/core/utils";import{toKebabCase as h}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as p}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as g}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as d}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as R}from"./base.js";import{extractPartsFromComponentsRef as y}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as E}from"../../../entities/validate-entity.js";import{extractPartsFromChannelsMessageRef as w}from"../../../utils/extract-parts-from-channels-message-ref.js";const f=15;class k extends R{constructor(e){super("asyncapi",e)}mapApiDescriptionToEntity(e,a){const s=$(e.realRelativePath),n=e.document.info.title,t=s.replace(/\.[^.]+$/,""),r=h(t.replace(/[\\/]/g,"-")),o=e.document["x-redocly-catalog-key"],c=typeof o=="string"&&o.trim()?h(o.trim()):r;return{type:this.type,key:c,title:n,summary:d(e.document.info.description),tags:e.document.info.tags?.map(i=>i.name),metadata:{specType:this.specType,descriptionFile:s},version:a}}async loadApiDescriptions(){return(await this.context.cache.load(".","asyncapi-docs")).data}async processApiDescription(e,a,s,n){const t=this.mapApiDescriptionToEntity(e,s);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:t,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:!0,revision:a}),n.delete(`${t.key}:${s}`);const r=this.#a(e),[o,c]=await Promise.allSettled([this.#s(e,t.key,t.version,s,a,n),this.#r(r,e,t.key,t.version,s,a,n)]);o.status!=="fulfilled"&&this.context.logger.error("Schema processing failed:",o.reason),c.status!=="fulfilled"&&this.context.logger.error("Operation processing failed:",c.reason)}#a=e=>{const a=e.documentWithReferences.operations;return a?Object.entries(a).map(([s,n])=>({operationName:s,operation:n})):[]};#s=async(e,a,s,n,t,r)=>{const o=e.document.components?.schemas;if(!o)return;const c=Object.entries(o);if(c.length===0)return;const i=await g(c,f,async([l,m])=>{const u=await this.#n({schemaName:l,schema:m,description:e,parentKey:a,parentVersion:s,parentRevision:t});r.delete(`${u.entityKey}:${n}`),u.result==="created"&&await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:a,type:"uses",targetKey:u.entityKey,fileHash:e.hash,sourceVersion:s,targetVersion:s,sourceRevision:t,targetRevision:t})},this.context.logger);i.count.failed>0&&this.context.logger.warn(`Schema processing completed with ${i.count.failed} failures out of ${c.length} schemas for ${e.realRelativePath}`)};#n=async({schemaName:e,schema:a,description:s,parentKey:n,parentVersion:t,parentRevision:r})=>{const o=`${n}-${h(e)}`,c="title"in a?a.title??a.description:null,i=JSON.stringify(a),l={type:"data-schema",key:o,title:e,summary:c,tags:[],metadata:{specType:this.specType,schema:i},version:t};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:l,sourceFile:s.realRelativePath,fileHash:s.hash,revision:r})};#r=async(e,a,s,n,t,r,o)=>{if(!e.length)return;const c=await g(e,f,async({operationName:i,operation:l})=>{const m=await this.#c(l,i,a,s,n,r);m&&o.delete(`${m}:${t}`)},this.context.logger);c.count.failed>0&&this.context.logger.warn(`Operation processing completed with ${c.count.failed} failures out of ${e.length} operations for ${a.realRelativePath}`)};#c=async(e,a,s,n,t,r)=>{const o=await this.#o(e.messages??[],s,n),c=await this.#i(a,e,o,s,n,t,r);return c.result==="created"&&await this.#l({apiOperationKey:c.entityKey,operation:e,descriptionUniqueKey:n,description:s,descriptionVersion:t,parentRevision:r}),c.entityKey??null};#o=async(e,a,s)=>{if(!e||e.length===0)return[];const n=new Set;for(const t of e){let r=null;if("$ref"in t){const o=t.$ref.startsWith("#/channels/")?this.#e(t.$ref,a):t.$ref;if(o){const c=y(o);if(c?.componentName&&c.componentType==="messages"){const i=a.documentWithReferences.components?.messages[c.componentName];i?.payload&&"$ref"in i.payload&&i.payload.$ref&&(r=i.payload.$ref)}}}else t.payload&&"$ref"in t.payload&&t.payload.$ref&&(r=t.payload.$ref);if(r){const o=y(r);o?.componentName&&o.componentType==="schemas"&&n.add(`${s}-${h(o.componentName)}`)}}return Array.from(n)};#i=async(e,a,s,n,t,r,o)=>{const c={type:"api-operation",key:`${t}-${h(e)}`,title:a.title||e,summary:a.summary??"",tags:a.tags?.map(l=>l.name)??[],metadata:{method:a.action==="send"?"PUBLISH":"SUBSCRIBE",path:a.channel.address??"",payload:a.action==="receive"?s:[],responses:a.action==="send"?s:[]},version:r};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:n.realRelativePath,fileHash:n.hash,revision:o})};#l=async({apiOperationKey:e,operation:a,descriptionUniqueKey:s,description:n,descriptionVersion:t,parentRevision:r})=>(await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:s,fileHash:n.hash,sourceVersion:t,targetVersion:t,sourceRevision:r,targetRevision:r}),await this.#h(a,e,t,r),!Array.isArray(a.messages)||!a.messages?.length?[]:await this.#m(a.messages,e,n,s,t,r));#h=async(e,a,s,n)=>{e["x-catalog-relations"]?.length&&await p(e["x-catalog-relations"],f,async t=>{try{E(t),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:a,type:t.type,targetKey:t.key,sourceVersion:s,targetVersion:s,sourceRevision:n,targetRevision:n})}catch(r){this.context.logger.warn(`Error creating entity relation for operation ${a} based on custom property: ${r instanceof Error?r.message:"Unknown error"}`)}})};#m=async(e,a,s,n,t,r)=>e.length===0?[]:(await p(e,f,async c=>await this.#y(c,a,s,n,t,r)??"")).filter(c=>!!c);#y=async(e,a,s,n,t,r)=>"$ref"in e?this.#f(e,a,s,n,t,r):e.payload?this.#u(e,a,s,n,t,r):null;#f=async(e,a,s,n,t,r)=>{const o=e.$ref.startsWith("#/channels/")?this.#e(e.$ref,s):e.$ref;if(!o)return null;const c=y(o);if(!c||!c.componentName||c.componentType!=="messages")return null;const i=s.documentWithReferences.components?.messages[c.componentName];return!i?.payload||!("$ref"in i.payload)||!i.payload.$ref?null:this.#t(i.payload.$ref,a,s,n,t,r)};#e=(e,a)=>{const s=w(e);if(!s||!s.channelName||!s.messageName)return null;const n=a.documentWithReferences.channels?.[s.channelName];if(!n?.messages)return null;const t=n.messages[s.messageName];return!t||!("$ref"in t)||typeof t.$ref!="string"||!t.$ref.startsWith("#/components/messages/")?null:t.$ref};#u=async(e,a,s,n,t,r)=>!e.payload||!("$ref"in e.payload)||!e.payload.$ref?null:this.#t(e.payload.$ref,a,s,n,t,r);#t=async(e,a,s,n,t,r)=>{const o=y(e);if(!o||!o.componentName||o.componentType!=="schemas")return null;const c=`${n}-${h(o.componentName)}`;return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:a,type:"uses",targetKey:c,fileHash:s.hash,sourceVersion:t,targetVersion:t,sourceRevision:r,targetRevision:r}),c}}export{k as AsyncApiEntitiesExtractor};

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/base.d.ts

@@ -18,7 +18,7 @@ export declare abstract class BaseApiEntitiesExtractor<BundledApiDefinition exte
     constructor(specType: SpecType, params: BaseApiEntitiesExtractorParams);
     extract(): Promise<void>;
     protected abstract loadApiDescriptions(): Promise<BundledApiDefinition[]>;
-    protected abstract mapApiDescriptionToEntity(definition: BundledApiDefinition): EntityFileSchema;
-    protected abstract processApiDescription(definition: BundledApiDefinition): Promise<Set<string>>;
+    protected abstract mapApiDescriptionToEntity(definition: BundledApiDefinition, version: string): EntityFileSchema;
+    protected abstract processApiDescription(definition: BundledApiDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
 }
 //# sourceMappingURL=base.d.ts.map

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/base.js

@@ -1 +1 @@
-import{FileHashStatus as a}from"../../../../../persistence/file-hashes/types.js";import{promiseMapLimit as r}from"../../../../../utils/async/promise-map-limit.js";import{catalogDataCollector as s}from"../../../utils/catalog-data-collector.js";const o=3;class p{type="api-description";specType;fileType;actions;context;catalogEntitiesService;fileHashManager;entitySources={};#e;constructor(t,e){this.specType=t,this.fileType=e.fileType,this.actions=e.actions,this.context=e.context,this.catalogEntitiesService=e.catalogEntitiesService,this.fileHashManager=e.fileHashManager,this.#e=e.shouldCalculateEntities??!1}async extract(){const t=await this.loadApiDescriptions();await this.fileHashManager.markAllAsOutdated(this.fileType),t.length&&s.addExtractor(this.specType),await r(t,o,async e=>{try{if(e.isVirtual||!e.hash)return;if(!((await this.fileHashManager.getByPath(e.realRelativePath))?.hash!==e.hash||this.#e||process.env.FORCE_CATALOG_CACHE_REVALIDATE==="true")){s.increaseSkippedFilesCount(),await this.fileHashManager.upsert(this.fileType,e.realRelativePath,e.hash,a.UP_TO_DATE);return}const l=await this.processApiDescription(e);await this.#i(l,e.realRelativePath),s.increaseProcessedFilesCount(),await this.fileHashManager.upsert(this.fileType,e.realRelativePath,e.hash,a.UP_TO_DATE)}catch(i){this.context.logger.warn(`Error extracting entities from ${this.specType} description: ${e.realRelativePath}`),this.context.logger.warn(i)}}),await this.#t()}#t=async()=>{const t=await this.fileHashManager.getAllOutdated(this.fileType);if(!t||t.length===0)return;const e=await this.catalogEntitiesService.getEntities({limit:200,filter:{op:"AND",conditions:[{field:"source_file",operator:"in",value:t.map(({filePath:i})=>i)},{field:"is_current",operator:"equal",value:!0}]}});e&&e.items.length>0&&await this.catalogEntitiesService.deleteEntitiesInLocalDatabase({field:"key",operator:"in",value:e.items.map(({key:i})=>i)}),await this.fileHashManager.deleteFileHashes({op:"AND",conditions:[{field:"file_type",operator:"equal",value:this.fileType},{field:"status",operator:"equal",value:a.OUTDATED}]})};#i=async(t,e)=>{t.size!==0&&await this.catalogEntitiesService.deleteEntitiesInLocalDatabase({op:"AND",conditions:[{field:"key",operator:"in",value:Array.from(t),modifier:"not"},{field:"source",operator:"equal",value:"file"},{field:"source_file",operator:"equal",value:e}]})}}export{p as BaseApiEntitiesExtractor};
+import{FileHashStatus as c}from"../../../../../persistence/file-hashes/types.js";import{promiseMapLimit as v}from"../../../../../utils/async/promise-map-limit.js";import{OPERATORS as u}from"../../../../../providers/database/pagination/constants.js";import{VERSION_NOT_SPECIFIED as f}from"@redocly/theme/core/constants";import{resolveEntityVersion as g}from"../../../utils/resolve-entity-version.js";import{catalogDataCollector as h}from"../../../utils/catalog-data-collector.js";const E=3;class D{type="api-description";specType;fileType;actions;context;catalogEntitiesService;fileHashManager;entitySources={};#e;constructor(t,e){this.specType=t,this.fileType=e.fileType,this.actions=e.actions,this.context=e.context,this.catalogEntitiesService=e.catalogEntitiesService,this.fileHashManager=e.fileHashManager,this.#e=e.shouldCalculateEntities??!1}async extract(){const t=await this.loadApiDescriptions();await this.fileHashManager.markAllAsOutdated(this.fileType),t.length&&h.addExtractor(this.specType),await v(t,E,async e=>{try{if(e.isVirtual||!e.hash)return;if(!((await this.fileHashManager.getByPath(e.realRelativePath))?.hash!==e.hash||this.#e||process.env.FORCE_CATALOG_CACHE_REVALIDATE==="true")){h.increaseSkippedFilesCount(),await this.fileHashManager.upsert(this.fileType,e.realRelativePath,e.hash,c.UP_TO_DATE);return}const a=await this.catalogEntitiesService.getEntityKeysAndVersionsBySourceFile(e.realRelativePath),o=new Date().toISOString(),n=this.#a(e);await this.processApiDescription(e,o,n,a),await this.#i(a,e.realRelativePath,o,e.hash),h.increaseProcessedFilesCount(),await this.fileHashManager.upsert(this.fileType,e.realRelativePath,e.hash,c.UP_TO_DATE)}catch(i){this.context.logger.warn(`Error extracting entities from ${this.specType} description: ${e.realRelativePath}`),this.context.logger.warn(i)}}),await this.#t()}#t=async()=>{const t=await this.fileHashManager.getAllOutdated(this.fileType);if(!t||t.length===0)return;const e=await this.catalogEntitiesService.getEntities({limit:1e3,filter:{op:"AND",conditions:[{field:"source_file",operator:"in",value:t.map(({filePath:i})=>i)},{field:"is_current",operator:"equal",value:!0}]}});e&&e.items.length>0&&await this.catalogEntitiesService.deleteEntitiesInLocalDatabase({field:"key",operator:"in",value:e.items.map(({key:i})=>i)}),await this.fileHashManager.deleteFileHashes({op:"AND",conditions:[{field:"file_type",operator:"equal",value:this.fileType},{field:"status",operator:"equal",value:c.OUTDATED}]})};#i=async(t,e,i,r)=>{if(t.size===0)return;const a=Array.from(t).map(s=>{const[l,p]=s.split(":");return{key:l,version:p}}),o=Array.from(new Set(a.map(({key:s})=>s))),n=a.map(({key:s,version:l})=>({op:u.AND,conditions:[{field:"key",operator:"equal",value:s},{field:"version",operator:"equal",value:l}]}));await this.catalogEntitiesService.softDeleteEntitiesInLocalDatabase({revision:i,fileHash:r,filter:{op:"AND",conditions:[{field:"key",operator:"in",value:o},{op:u.OR,conditions:n},{field:"source",operator:"equal",value:"file"},{field:"source_file",operator:"equal",value:e}]}})};#a(t){const e=t.document?.info?.version??t.definition?.info?.version??null,i=g(e,t.realRelativePath);return i.success?i.version??f:f}}export{D as BaseApiEntitiesExtractor};

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/graphql-entities-extractor.d.ts

@@ -13,8 +13,8 @@ export declare class GraphqlEntitiesExtractor extends BaseApiEntitiesExtractor<G
     #private;
     constructor(params: BaseApiEntitiesExtractorParams);
     loadApiDescriptions(): Promise<GraphqlBundledDefinition[]>;
-    mapApiDescriptionToEntity(description: GraphqlBundledDefinition): EntityFileSchema;
-    processApiDescription(description: GraphqlBundledDefinition): Promise<Set<string>>;
+    mapApiDescriptionToEntity(description: GraphqlBundledDefinition, version: string): EntityFileSchema;
+    processApiDescription(description: GraphqlBundledDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
 }
 export {};
 //# sourceMappingURL=graphql-entities-extractor.d.ts.map

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/graphql-entities-extractor.js

@@ -1,3 +1,3 @@
-import{buildSchema as v,isObjectType as m,isScalarType as R,isEnumType as I,isInterfaceType as T,isUnionType as d,isInputObjectType as w,getNamedType as y,printType as $}from"graphql";import{removeLeadingSlash as O}from"@redocly/theme/core/utils";import{toKebabCase as f}from"../../../../../../utils/string/to-kebab-case.js";import{capitalize as D}from"../../../../../../utils/string/capitalize.js";import{promiseMapLimit as u}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as S}from"../../../../../utils/async/promise-map-limit-with-status.js";import{sha1 as L}from"../../../../../utils/crypto/sha1.js";import{removeMarkdocTags as F}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{resolveEntityVersion as A}from"../../../utils/resolve-entity-version.js";import{BaseApiEntitiesExtractor as j}from"./base.js";const E=15,b=15,N=new Set(["String","ID","Int","Float","Boolean","DateTime","Date","Time","URL","URI","JSON","JSONObject","BigInt","BigDecimal"]);class Q extends j{#t;constructor(t){super("graphql",t),this.#t=t.context.logger}async loadApiDescriptions(){const t=[];for(const{relativePath:e}of await this.context.fs.scan(/(\.gql|\.graphql)$/))try{if(e.includes("@l10n")||await this.context.isPathIgnored(e))continue;const a=await this.context.cache.load(e,"graphql-doc");if(!a.data)continue;const{content:s,metadata:o}=a.data,r=v(s),l=L(s);t.push({realRelativePath:e,relativePath:e,isVirtual:!1,hash:l,schema:r,content:s,metadata:o})}catch(a){this.#t.warn(`Failed to load GraphQL schema from ${e}: ${a instanceof Error?a.message:"Unknown error"}`)}return t}mapApiDescriptionToEntity(t){const e=O(t.realRelativePath),a=t.relativePath.replace(/\.(gql|graphql)$/,""),s=this.#s(a.split("/").pop()||"GraphQL Schema"),o=e.replace(/\.(gql|graphql)$/,""),r=f(o.replace(/[\\/]/g,"-")),l=this.#c(t.metadata?.tags),c=t.metadata?.["x-redocly-catalog-key"],i=typeof c=="string"&&c.trim()?f(c.trim()):r,n=A(null,t.realRelativePath),p=n.success?n.version:null;return{type:this.type,key:i,title:s,summary:t.metadata?.description||null,tags:l.concat("graphql"),metadata:{specType:this.specType,descriptionFile:e},version:p}}async processApiDescription(t){const e=new Set,{schema:a}=t;if(!a)return e;const s=this.mapApiDescriptionToEntity(t);return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:s,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0}),e.add(s.key),await Promise.all([this.#a(t,s.key,s.version,e),this.#y(t,s.key,s.version,e)]),e}#a=async(t,e,a,s)=>{const{schema:o}=t,r=o.getTypeMap(),l=this.#r(o),c=Object.entries(r).filter(([n])=>!n.startsWith("__")&&!N.has(n)&&!l.has(n));if(c.length===0)return;const i=await S(c,b,async([n,p])=>{const h=await this.#l({typeName:n,type:p,description:t,parentKey:e,parentVersion:a});s.add(h),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"uses",targetKey:h,fileHash:t.hash,sourceVersion:a,targetVersion:a})},this.#t);i.count.failed>0&&this.#t.warn(`Schema processing completed with ${i.count.failed} failures out of ${c.length} types for ${t.realRelativePath}`),await this.#h({description:t,descriptionUniqueKey:e,userTypes:c})};#s=t=>{const e=t.replace(/[^A-Za-z0-9]+/g," ").trim();return e?e.split(" ").map(a=>a&&D(a)).join(" "):"GraphQL Schema"};#e=(t,e)=>`${e}-${f(t)}`;#n=t=>m(t)?"object":T(t)?"interface":d(t)?"union":I(t)?"enum":w(t)?"input":R(t)?"scalar":"unknown";#r=t=>{const e=new Set,a=t.getQueryType();a&&e.add(a.name);const s=t.getMutationType();s&&e.add(s.name);const o=t.getSubscriptionType();return o&&e.add(o.name),e};#i(t){const e=[],a=t.getQueryType();if(a){const r=a.getFields();for(const[l,c]of Object.entries(r))e.push({fieldName:l,field:c,operationType:"QUERY",rootTypeName:a.name})}const s=t.getMutationType();if(s){const r=s.getFields();for(const[l,c]of Object.entries(r))e.push({fieldName:l,field:c,operationType:"MUTATION",rootTypeName:s.name})}const o=t.getSubscriptionType();if(o){const r=o.getFields();for(const[l,c]of Object.entries(r))e.push({fieldName:l,field:c,operationType:"SUBSCRIBE",rootTypeName:o.name})}return e}#o=(t,e)=>{const a=[];if(t.args)for(const r of t.args){const l=y(r.type);l&&!l.name.startsWith("__")&&a.push(this.#e(l.name,e))}const s=[],o=y(t.type);return o&&!o.name.startsWith("__")&&s.push(this.#e(o.name,e)),{inputTypes:a,returnTypes:s}};#c=t=>{if(Array.isArray(t))return t.map(e=>String(e)).map(e=>e.trim()).filter(e=>e.length>0);if(typeof t=="string"){const e=t.trim();return e?[e]:[]}return[]};#l=async({typeName:t,type:e,description:a,parentKey:s,parentVersion:o})=>{const r=this.#e(t,s),l=e.description??null,c=this.#n(e),i={type:"data-schema",key:r,title:t,summary:l,tags:["graphql"],metadata:{specType:this.specType,typeKind:c,sdl:this.#p(e,a.schema)},version:o};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:i,sourceFile:a.realRelativePath,fileHash:a.hash}),i.key};#p=(t,e)=>{const a=new Set,s=[],o=new Set(["String","ID","Int","Float","Boolean"]),r=i=>{if(!i)return;const n=i.name;if(n.startsWith("__")||o.has(n)||a.has(n))return;const p=e.getType(n);p&&(a.add(n),s.push(p))};for(r(t);s.length>0;){const i=s.pop();if(m(i)){for(const p of i.getInterfaces?.()??[])r(p);const n=i.getFields();for(const p of Object.values(n)){r(y(p.type));for(const h of p.args??[])r(y(h.type))}}else if(T(i)){const n=i.getFields();for(const p of Object.values(n))r(y(p.type))}else if(d(i))for(const n of i.getTypes())r(n);else if(w(i)){const n=i.getFields();for(const p of Object.values(n))r(y(p.type))}}const l=[t.name,...[...a].filter(i=>i!==t.name)],c=[];for(const i of l){const n=e.getType(i);n&&c.push($(n))}return c.join(`
+import{buildSchema as R,isObjectType as g,isScalarType as O,isEnumType as D,isInterfaceType as S,isUnionType as w,isInputObjectType as E,getNamedType as u,printType as L}from"graphql";import{removeLeadingSlash as v}from"@redocly/theme/core/utils";import{toKebabCase as m}from"../../../../../../utils/string/to-kebab-case.js";import{capitalize as A}from"../../../../../../utils/string/capitalize.js";import{promiseMapLimit as T}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as b}from"../../../../../utils/async/promise-map-limit-with-status.js";import{sha1 as j}from"../../../../../utils/crypto/sha1.js";import{removeMarkdocTags as K}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as N}from"./base.js";const $=15,I=15,F=new Set(["String","ID","Int","Float","Boolean","DateTime","Date","Time","URL","URI","JSON","JSONObject","BigInt","BigDecimal"]);class Q extends N{#t;constructor(t){super("graphql",t),this.#t=t.context.logger}async loadApiDescriptions(){const t=[];for(const{relativePath:e}of this.context.fs.scan(/(\.gql|\.graphql)$/))try{if(e.includes("@l10n")||await this.context.isPathIgnored(e))continue;const a=await this.context.cache.load(e,"graphql-doc");if(!a.data)continue;const{content:n,metadata:r}=a.data,s=R(n),o=j(n);t.push({realRelativePath:e,relativePath:e,isVirtual:!1,hash:o,schema:s,content:n,metadata:r})}catch(a){this.#t.warn(`Failed to load GraphQL schema from ${e}: ${a instanceof Error?a.message:"Unknown error"}`)}return t}mapApiDescriptionToEntity(t,e){const a=v(t.realRelativePath),n=t.relativePath.replace(/\.(gql|graphql)$/,""),r=this.#s(n.split("/").pop()||"GraphQL Schema"),s=a.replace(/\.(gql|graphql)$/,""),o=m(s.replace(/[\\/]/g,"-")),p=this.#c(t.metadata?.tags),c=t.metadata?.["x-redocly-catalog-key"],i=typeof c=="string"&&c.trim()?m(c.trim()):o;return{type:this.type,key:i,title:r,summary:t.metadata?.description||null,tags:p.concat("graphql"),metadata:{specType:this.specType,descriptionFile:a},version:e}}async processApiDescription(t,e,a,n){const{schema:r}=t;if(!r)return;const s=this.mapApiDescriptionToEntity(t,a);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:s,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0,revision:e}),n.delete(`${s.key}:${a}`),await Promise.all([this.#a(t,s.key,s.version,a,e,n),this.#y(t,s.key,s.version,a,e,n)])}#a=async(t,e,a,n,r,s)=>{const{schema:o}=t,p=o.getTypeMap(),c=this.#r(o),i=Object.entries(p).filter(([h])=>!h.startsWith("__")&&!F.has(h)&&!c.has(h));if(i.length===0)return;const l=await b(i,I,async([h,y])=>{const f=await this.#l({typeName:h,type:y,description:t,parentKey:e,parentVersion:a,parentRevision:r});s.delete(`${f.entityKey}:${n}`),f.result==="created"&&await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"uses",targetKey:f.entityKey,fileHash:t.hash,sourceVersion:a,targetVersion:a,sourceRevision:r,targetRevision:r})},this.#t);l.count.failed>0&&this.#t.warn(`Schema processing completed with ${l.count.failed} failures out of ${i.length} types for ${t.realRelativePath}`),await this.#h({description:t,descriptionUniqueKey:e,userTypes:i,parentRevision:r})};#s=t=>{const e=t.replace(/[^A-Za-z0-9]+/g," ").trim();return e?e.split(" ").map(a=>a&&A(a)).join(" "):"GraphQL Schema"};#e=(t,e)=>`${e}-${m(t)}`;#n=t=>g(t)?"object":S(t)?"interface":w(t)?"union":D(t)?"enum":E(t)?"input":O(t)?"scalar":"unknown";#r=t=>{const e=new Set,a=t.getQueryType();a&&e.add(a.name);const n=t.getMutationType();n&&e.add(n.name);const r=t.getSubscriptionType();return r&&e.add(r.name),e};#i(t){const e=[],a=t.getQueryType();if(a){const s=a.getFields();for(const[o,p]of Object.entries(s))e.push({fieldName:o,field:p,operationType:"QUERY",rootTypeName:a.name})}const n=t.getMutationType();if(n){const s=n.getFields();for(const[o,p]of Object.entries(s))e.push({fieldName:o,field:p,operationType:"MUTATION",rootTypeName:n.name})}const r=t.getSubscriptionType();if(r){const s=r.getFields();for(const[o,p]of Object.entries(s))e.push({fieldName:o,field:p,operationType:"SUBSCRIBE",rootTypeName:r.name})}return e}#o=(t,e)=>{const a=[];if(t.args)for(const s of t.args){const o=u(s.type);o&&!o.name.startsWith("__")&&a.push(this.#e(o.name,e))}const n=[],r=u(t.type);return r&&!r.name.startsWith("__")&&n.push(this.#e(r.name,e)),{inputTypes:a,returnTypes:n}};#c=t=>{if(Array.isArray(t))return t.map(e=>String(e)).map(e=>e.trim()).filter(e=>e.length>0);if(typeof t=="string"){const e=t.trim();return e?[e]:[]}return[]};#l=async({typeName:t,type:e,description:a,parentKey:n,parentVersion:r,parentRevision:s})=>{const o=this.#e(t,n),p=e.description??null,c=this.#n(e),i={type:"data-schema",key:o,title:t,summary:p,tags:["graphql"],metadata:{specType:this.specType,typeKind:c,sdl:this.#p(e,a.schema)},version:r};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:i,sourceFile:a.realRelativePath,fileHash:a.hash,revision:s})};#p=(t,e)=>{const a=new Set,n=[],r=new Set(["String","ID","Int","Float","Boolean"]),s=c=>{if(!c)return;const i=c.name;if(i.startsWith("__")||r.has(i)||a.has(i))return;const l=e.getType(i);l&&(a.add(i),n.push(l))};for(s(t);n.length>0;){const c=n.pop();if(g(c)){for(const l of c.getInterfaces?.()??[])s(l);const i=c.getFields();for(const l of Object.values(i)){s(u(l.type));for(const h of l.args??[])s(u(h.type))}}else if(S(c)){const i=c.getFields();for(const l of Object.values(i))s(u(l.type))}else if(w(c))for(const i of c.getTypes())s(i);else if(E(c)){const i=c.getFields();for(const l of Object.values(i))s(u(l.type))}}const o=[t.name,...[...a].filter(c=>c!==t.name)],p=[];for(const c of o){const i=e.getType(c);i&&p.push(L(i))}return p.join(`
 
-`)};#h=async({description:t,descriptionUniqueKey:e,userTypes:a})=>{const s=a.filter(([,o])=>m(o));s.length!==0&&await u(s,b,async([o,r])=>{const c=r.getInterfaces?.()??[];if(!c.length)return;const i=this.#e(o,e);await u([...c],5,async n=>{const p=this.#e(n.name,e);try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:i,type:"implements",targetKey:p,fileHash:t.hash})}catch(h){this.#t.warn(`Failed to create 'implements' relation ${i} -> ${p}: ${h instanceof Error?h.message:"Unknown error"}`)}})})};#y=async(t,e,a,s)=>{const{schema:o}=t,r=this.#i(o);if(r.length===0)return;const c=(await S(r,E,async({fieldName:i,field:n,operationType:p,rootTypeName:h})=>{const g=await this.#f(i,n,p,h,t,e,a);g&&s.add(g)},this.#t)).count.failed;c>0&&this.#t.warn(`Operation extraction completed with ${c} failures out of ${r.length} operations for ${e}`)};#f=async(t,e,a,s,o,r,l)=>{const{inputTypes:c,returnTypes:i}=this.#o(e,r),n=await this.#m({fieldName:t,field:e,operationType:a,rootTypeName:s,inputTypes:c,returnTypes:i,description:o,descriptionUniqueKey:r,descriptionVersion:l});return await this.#u({apiOperationKey:n,inputTypes:c,returnTypes:i,descriptionUniqueKey:r,description:o,descriptionVersion:l}),n??null};#m=async({fieldName:t,field:e,operationType:a,rootTypeName:s,inputTypes:o,returnTypes:r,description:l,descriptionUniqueKey:c,descriptionVersion:i})=>{const n=t,p=`${c}-${f(`${a.toLowerCase()}-${t}`)}`,h={type:"api-operation",key:p,title:n,summary:e.description?F(e.description):null,tags:["graphql"],metadata:{method:a,path:`${s}.${t}`,payload:o,responses:r},version:i};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:h,sourceFile:l.realRelativePath,fileHash:l.hash}),p};#u=async({apiOperationKey:t,inputTypes:e,returnTypes:a,descriptionUniqueKey:s,description:o,descriptionVersion:r})=>{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"partOf",targetKey:s,fileHash:o.hash,sourceVersion:r,targetVersion:r});const l=[...new Set(e)],c=[...new Set(a)],i=[...l.map(n=>({key:n,relationType:"uses"})),...c.map(n=>({key:n,relationType:"returns"}))];await u(i,E,async({key:n,relationType:p})=>{try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:p,targetKey:n,fileHash:o.hash,sourceVersion:r,targetVersion:r})}catch(h){this.#t.warn(`Failed to create relation between operation ${t} and type ${n} (${p}): ${h instanceof Error?h.message:"Unknown error"}`)}})}}export{Q as GraphqlEntitiesExtractor};
+`)};#h=async({description:t,descriptionUniqueKey:e,userTypes:a,parentRevision:n})=>{const r=a.filter(([,s])=>g(s));r.length!==0&&await T(r,I,async([s,o])=>{const c=o.getInterfaces?.()??[];if(!c.length)return;const i=this.#e(s,e);await T([...c],5,async l=>{const h=this.#e(l.name,e);try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:i,type:"implements",targetKey:h,fileHash:t.hash,sourceRevision:n,targetRevision:n})}catch(y){this.#t.warn(`Failed to create 'implements' relation ${i} -> ${h}: ${y instanceof Error?y.message:"Unknown error"}`)}})})};#y=async(t,e,a,n,r,s)=>{const{schema:o}=t,p=this.#i(o);if(p.length===0)return;const i=(await b(p,$,async({fieldName:l,field:h,operationType:y,rootTypeName:f})=>{const d=await this.#f(l,h,y,f,t,e,a,r);d&&s.delete(`${d}:${n}`)},this.#t)).count.failed;i>0&&this.#t.warn(`Operation extraction completed with ${i} failures out of ${p.length} operations for ${e}`)};#f=async(t,e,a,n,r,s,o,p)=>{const{inputTypes:c,returnTypes:i}=this.#o(e,s),l=await this.#u({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:c,returnTypes:i,description:r,descriptionUniqueKey:s,descriptionVersion:o,parentRevision:p});return l.result==="created"&&await this.#m({apiOperationKey:l.entityKey,inputTypes:c,returnTypes:i,descriptionUniqueKey:s,description:r,descriptionVersion:o,parentRevision:p}),l.entityKey??null};#u=async({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:r,returnTypes:s,description:o,descriptionUniqueKey:p,descriptionVersion:c,parentRevision:i})=>{const l=t,y={type:"api-operation",key:`${p}-${m(`${a.toLowerCase()}-${t}`)}`,title:l,summary:e.description?K(e.description):null,tags:["graphql"],metadata:{method:a,path:`${n}.${t}`,payload:r,responses:s},version:c};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:y,sourceFile:o.realRelativePath,fileHash:o.hash,revision:i})};#m=async({apiOperationKey:t,inputTypes:e,returnTypes:a,descriptionUniqueKey:n,description:r,descriptionVersion:s,parentRevision:o})=>{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"partOf",targetKey:n,fileHash:r.hash,sourceVersion:s,targetVersion:s,sourceRevision:o,targetRevision:o});const p=[...new Set(e)],c=[...new Set(a)],i=[...p.map(l=>({key:l,relationType:"uses"})),...c.map(l=>({key:l,relationType:"returns"}))];await T(i,$,async({key:l,relationType:h})=>{try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:h,targetKey:l,fileHash:r.hash,sourceVersion:s,targetVersion:s,sourceRevision:o,targetRevision:o})}catch(y){this.#t.warn(`Failed to create relation between operation ${t} and type ${l} (${h}): ${y instanceof Error?y.message:"Unknown error"}`)}})}}export{Q as GraphqlEntitiesExtractor};

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/openapi-entities-extractor.d.ts

@@ -6,7 +6,7 @@ export declare class OpenApiEntitiesExtractor extends BaseApiEntitiesExtractor<B
     #private;
     constructor(params: BaseApiEntitiesExtractorParams);
     loadApiDescriptions(): Promise<BundledDefinition[]>;
-    mapApiDescriptionToEntity(description: BundledDefinition): EntityFileSchema;
-    processApiDescription(description: BundledDefinition): Promise<Set<string>>;
+    mapApiDescriptionToEntity(description: BundledDefinition, version: string): EntityFileSchema;
+    processApiDescription(description: BundledDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
 }
 //# sourceMappingURL=openapi-entities-extractor.d.ts.map

package/dist/server/plugins/catalog-entities/extensions/extractors/api-description/openapi-entities-extractor.js

@@ -1 +1 @@
-import{removeLeadingSlash as E}from"@redocly/theme/core/utils";import{toKebabCase as h}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as l}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as R}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as p}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as d}from"./base.js";import{OpenapiSchemaResolver as y}from"../../../utils/openapi-schema-resolver.js";import{extractPartsFromComponentsRef as v}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as S}from"../../../entities/validate-entity.js";import{resolveEntityVersion as N}from"../../../utils/resolve-entity-version.js";import{isValidTagName as u}from"../../../utils/is-valid-tag-name.js";const x=["get","post","put","delete","patch"],g=15,$=15;class j extends d{#e;constructor(e){super("openapi",e),this.#e=e.context.logger}async loadApiDescriptions(){return await this.actions.loadOpenApiDefinitions(this.context)}mapApiDescriptionToEntity(e){const o=E(e.realRelativePath),a=e.definition.info.title,n=o.replace(/\.[^.]+$/,""),t=h(n.replace(/[\\/]/g,"-")),s=e.definition["x-redocly-catalog-key"],r=typeof s=="string"&&s.trim()?h(s.trim()):t,c=e.definition.info.version,i=N(c,e.realRelativePath);if(!i.success)throw new Error(`API "${a}" in file "${e.realRelativePath}" has conflicting versions: spec version "${i.fileVersion}" differs from folder version "${i.folderVersion}". Entity will not be created.`);return{type:this.type,key:r,title:a,summary:p(e.definition.info.description),tags:e.definition.tags?.filter(m=>m.name&&u(m.name)).map(m=>m.name),metadata:{specType:this.specType,descriptionFile:o},version:i.version}}async processApiDescription(e){const o=new Set;if(y.clearSchemaCache(),!e?.definition?.paths)return o;const a=this.mapApiDescriptionToEntity(e);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:a,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:!0}),o.add(a.key),await this.#n(e,a.key,a.version,o);const n=this.#s(e.definition.paths);if(n.length!==0){const s=(await R(n,g,async({operation:r,path:c,method:i})=>{if(!r.operationId)return;const m=await this.#r(r,c,i,e,a.key,a.version);m&&o.add(m)},this.#e)).count.failed;s>0&&this.#e.warn(`Extraction completed with ${s} failures out of ${n.length} operations for ${a.key}`)}return o}#s(e){return Object.entries(e).flatMap(([o,a])=>x.filter(n=>a[n]).map(n=>{const t=a[n];if(!t)throw new Error(`Operation not found for method ${n} on path ${o}`);return{operation:t,path:o,method:n.toUpperCase()}}))}async#n(e,o,a,n){const t=e.definition.components?.schemas;if(!t)return;const s=Object.entries(t);s.length!==0&&await l(s,$,async([r,c])=>{const i=await this.#o({schemaName:r,schema:c,description:e,parentKey:o,parentVersion:a});n.add(i),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:o,type:"uses",targetKey:i,sourceVersion:a,targetVersion:a,fileHash:e.hash})})}async#o({schemaName:e,schema:o,description:a,parentKey:n,parentVersion:t}){const s=y.resolveSchemaRefs(o,a),r=JSON.stringify(s),c={type:"data-schema",key:`${n}-${h(e)}`,title:e,summary:s.description??s.title??null,tags:[],metadata:{specType:this.specType,schema:r},version:t};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:a.realRelativePath,fileHash:a.hash}),c.key}async#r(e,o,a,n,t,s){const[r,c]=await Promise.all([this.#i(e,n,t,s),this.#c(e,n,t,s)]),i=await this.#l({path:o,method:a,operation:e,requestBodySchemasKeys:r,responseSchemasKeys:c,description:n,parentKey:t,parentVersion:s});return await this.#p({apiOperationKey:i,operationRelations:e["x-catalog-relations"],descriptionUniqueKey:t,description:n,parentVersion:s}),i??null}async#i(e,o,a,n){if(!e.requestBody||!e.operationId)return[];const t=this.#m(e.requestBody,o);return t.errors.length>0&&this.#e.warn(`Schema extraction errors for operation ${e.operationId}: ${t.errors.join(", ")}`),await this.#a(t.schemaNames,e.operationId,o.hash,a,n)}async#c(e,o,a,n){if(!e.responses||!e.operationId)return[];const t=this.#h(e.responses,o);return t.errors.length>0&&this.#e.warn(`Response schema extraction errors for operation ${e.operationId}: ${t.errors.join(", ")}`),await this.#a(t.schemaNames,e.operationId,o.hash,a,n)}#m(e,o){const a=[],n=[];try{if(e&&"content"in e&&e.content)for(const t of Object.values(e.content)){if(!t.schema?.$ref)continue;const s=this.#t(t.schema.$ref);s?.componentType==="schemas"&&s.componentName&&a.push(s.componentName)}if(e&&e.$ref){const t=this.#t(e.$ref);if(t?.componentType==="requestBodies"&&t.componentName){const s=o.definition.components?.requestBodies?.[t.componentName];if(s&&"content"in s)for(const r of Object.values(s.content??{})){if(!r.schema?.$ref)continue;const c=this.#t(r.schema.$ref);c?.componentType==="schemas"&&c.componentName&&a.push(c.componentName)}}}}catch(t){n.push(`Failed to extract request body schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(a)],errors:n}}#h(e,o){const a=[],n=[];try{for(const t of Object.values(e)){if(t&&"content"in t&&t.content)for(const s of Object.values(t.content)){if(!s.schema?.$ref)continue;const r=this.#t(s.schema.$ref);r?.componentType==="schemas"&&r.componentName&&a.push(r.componentName)}if(t&&t.$ref){const s=this.#t(t.$ref);if(s?.componentType==="responses"&&s.componentName){const r=o.definition.components?.responses?.[s.componentName];if(r&&"content"in r)for(const c of Object.values(r.content??{})){if(!c.schema?.$ref)continue;const i=this.#t(c.schema.$ref);i?.componentType==="schemas"&&i.componentName&&a.push(i.componentName)}}}}}catch(t){n.push(`Failed to extract response schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(a)],errors:n}}#t(e){try{return v(e)}catch{return{componentType:"",componentName:null}}}async#a(e,o,a,n,t){return e.length===0?[]:await l(e,$,async s=>await this.#f({operationId:o,schemaName:s,descriptionHash:a,parentKey:n,parentVersion:t}))}async#f({operationId:e,schemaName:o,descriptionHash:a,parentKey:n,parentVersion:t}){const s=`${n}-${h(o)}`;try{return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:`${n}-${h(e)}`,type:"uses",targetKey:s,fileHash:a,sourceVersion:t,targetVersion:t}),s}catch(r){throw this.#e.error(`Failed to create relation between operation ${e} and schema ${o}: ${r instanceof Error?r.message:"Unknown error"}`),r}}async#l({path:e,method:o,operation:a,requestBodySchemasKeys:n,responseSchemasKeys:t,description:s,parentKey:r,parentVersion:c}){const i=`${a.operationId}`,m=`${r}-${h(i)}`,w={type:"api-operation",key:m,title:i,summary:p(a.summary),tags:a.tags?.filter(f=>u(f)),metadata:{path:e,method:o,payload:n,responses:t},version:c};try{return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:w,sourceFile:s.realRelativePath,fileHash:s.hash}),m}catch(f){throw this.#e.error(`Failed to create API operation entity for ${i}: ${f instanceof Error?f.message:"Unknown error"}`),f}}async#p({apiOperationKey:e,operationRelations:o,descriptionUniqueKey:a,description:n,parentVersion:t}){try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:a,fileHash:n.hash,sourceVersion:t,targetVersion:t}),await this.#y(e,o,t)}catch(s){this.#e.error(`Failed to create API operation relations for ${e}: ${s instanceof Error?s.message:"Unknown error"}`)}}async#y(e,o,a){o?.length&&await l(o,g,async n=>{try{S(n),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:n.type,targetKey:n.key,sourceVersion:a,targetVersion:a})}catch(t){this.context.logger.warn(`Error creating entity relation for operation ${e} based on custom property: ${t instanceof Error?t.message:"Unknown error"}`)}})}}export{j as OpenApiEntitiesExtractor};
+import{removeLeadingSlash as S}from"@redocly/theme/core/utils";import{toKebabCase as p}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as u}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as O}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as g}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as d}from"./base.js";import{OpenapiSchemaResolver as $}from"../../../utils/openapi-schema-resolver.js";import{extractPartsFromComponentsRef as N}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as x}from"../../../entities/validate-entity.js";import{isValidTagName as E}from"../../../utils/is-valid-tag-name.js";const v=["get","post","put","delete","patch"],w=15,R=15;class F extends d{#e;constructor(e){super("openapi",e),this.#e=e.context.logger}async loadApiDescriptions(){return await this.actions.loadOpenApiDefinitions(this.context)}mapApiDescriptionToEntity(e,o){const s=S(e.realRelativePath),n=e.definition.info.title,t=s.replace(/\.[^.]+$/,""),a=p(t.replace(/[\\/]/g,"-")),r=e.definition["x-redocly-catalog-key"],i=typeof r=="string"&&r.trim()?p(r.trim()):a;return{type:this.type,key:i,title:n,summary:g(e.definition.info.description),tags:e.definition.tags?.filter(c=>c.name&&E(c.name)).map(c=>c.name),metadata:{specType:this.specType,descriptionFile:s},version:o}}async processApiDescription(e,o,s,n){if($.clearSchemaCache(),!e?.definition?.paths)return;const t=this.mapApiDescriptionToEntity(e,s);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:t,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:!0,revision:o}),n.delete(`${t.key}:${s}`),await this.#n(e,t.key,t.version,s,o,n);const a=this.#s(e.definition.paths);if(a.length!==0){const i=(await O(a,w,async({operation:c,path:h,method:l})=>{if(!c.operationId)return;const f=await this.#r(c,h,l,e,t.key,t.version,o);f&&n.delete(`${f}:${s}`)},this.#e)).count.failed;i>0&&this.#e.warn(`Extraction completed with ${i} failures out of ${a.length} operations for ${t.key}`)}}#s(e){return Object.entries(e).flatMap(([o,s])=>v.filter(n=>s[n]).map(n=>{const t=s[n];if(!t)throw new Error(`Operation not found for method ${n} on path ${o}`);return{operation:t,path:o,method:n.toUpperCase()}}))}async#n(e,o,s,n,t,a){const r=e.definition.components?.schemas;if(!r)return;const i=Object.entries(r);i.length!==0&&await u(i,R,async([c,h])=>{const l=await this.#o({schemaName:c,schema:h,description:e,parentKey:o,parentVersion:s,parentRevision:t});a.delete(`${l.entityKey}:${n}`),l.result==="created"&&await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:o,sourceVersion:s,sourceRevision:t,type:"uses",targetKey:l.entityKey,targetVersion:s,targetRevision:t,fileHash:e.hash})})}async#o({schemaName:e,schema:o,description:s,parentKey:n,parentVersion:t,parentRevision:a}){const r=$.resolveSchemaRefs(o,s),i=JSON.stringify(r),c={type:"data-schema",key:`${n}-${p(e)}`,title:e,summary:r.description??r.title??null,tags:[],metadata:{specType:this.specType,schema:i},version:t};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:s.realRelativePath,fileHash:s.hash,revision:a})}async#r(e,o,s,n,t,a,r){const i=await Promise.all([this.#h(e.requestBody??null,n),this.#m(e.responses??{},n)]),c=i[0].schemaNames,h=i[1].schemaNames;i[0].errors.length>0&&this.#e.warn(`Schema extraction errors for operation ${e.operationId}: ${i[0].errors.join(", ")}`),i[1].errors.length>0&&this.#e.warn(`Response schema extraction errors for operation ${e.operationId}: ${i[1].errors.join(", ")}`);const l=c.map(y=>`${t}-${p(y)}`),f=h.map(y=>`${t}-${p(y)}`),m=await this.#p({path:o,method:s,operation:e,requestBodySchemasKeys:l,responseSchemasKeys:f,description:n,parentKey:t,parentVersion:a,parentRevision:r});return m.result==="created"&&await Promise.all([this.#i(c,e.operationId??"",n.hash,t,a,r),this.#c(h,e.operationId??"",n.hash,t,a,r),this.#f({apiOperationKey:m.entityKey,operationRelations:e["x-catalog-relations"],descriptionUniqueKey:t,description:n,parentVersion:a,parentRevision:r})]),m.entityKey??null}async#i(e,o,s,n,t,a){return e.length===0||!o?[]:await this.#a(e,o,s,n,t,a)}async#c(e,o,s,n,t,a){return e.length===0||!o?[]:await this.#a(e,o,s,n,t,a)}#h(e,o){const s=[],n=[];try{if(e&&"content"in e&&e.content)for(const t of Object.values(e.content)){if(!t.schema?.$ref)continue;const a=this.#t(t.schema.$ref);a?.componentType==="schemas"&&a.componentName&&s.push(a.componentName)}if(e&&e.$ref){const t=this.#t(e.$ref);if(t?.componentType==="requestBodies"&&t.componentName){const a=o.definition.components?.requestBodies?.[t.componentName];if(a&&"content"in a)for(const r of Object.values(a.content??{})){if(!r.schema?.$ref)continue;const i=this.#t(r.schema.$ref);i?.componentType==="schemas"&&i.componentName&&s.push(i.componentName)}}}}catch(t){n.push(`Failed to extract request body schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(s)],errors:n}}#m(e,o){const s=[],n=[];try{for(const t of Object.values(e)){if(t&&"content"in t&&t.content)for(const a of Object.values(t.content)){if(!a.schema?.$ref)continue;const r=this.#t(a.schema.$ref);r?.componentType==="schemas"&&r.componentName&&s.push(r.componentName)}if(t&&t.$ref){const a=this.#t(t.$ref);if(a?.componentType==="responses"&&a.componentName){const r=o.definition.components?.responses?.[a.componentName];if(r&&"content"in r)for(const i of Object.values(r.content??{})){if(!i.schema?.$ref)continue;const c=this.#t(i.schema.$ref);c?.componentType==="schemas"&&c.componentName&&s.push(c.componentName)}}}}}catch(t){n.push(`Failed to extract response schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(s)],errors:n}}#t(e){try{return N(e)}catch{return{componentType:"",componentName:null}}}async#a(e,o,s,n,t,a){return e.length===0?[]:await u(e,R,async r=>await this.#l({operationId:o,schemaName:r,descriptionHash:s,parentKey:n,parentVersion:t,parentRevision:a}))}async#l({operationId:e,schemaName:o,descriptionHash:s,parentKey:n,parentVersion:t,parentRevision:a}){const r=`${n}-${p(o)}`;try{return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:`${n}-${p(e)}`,type:"uses",targetKey:r,fileHash:s,sourceVersion:t,targetVersion:t,sourceRevision:a,targetRevision:a}),r}catch(i){throw this.#e.error(`Failed to create relation between operation ${e} and schema ${o}: ${i instanceof Error?i.message:"Unknown error"}`),i}}async#p({path:e,method:o,operation:s,requestBodySchemasKeys:n,responseSchemasKeys:t,description:a,parentKey:r,parentVersion:i,parentRevision:c}){const h=`${s.operationId}`,f={type:"api-operation",key:`${r}-${p(h)}`,title:h,summary:g(s.summary),tags:s.tags?.filter(m=>E(m)),metadata:{path:e,method:o,payload:n,responses:t},version:i};try{return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:f,sourceFile:a.realRelativePath,fileHash:a.hash,revision:c})}catch(m){throw this.#e.error(`Failed to create API operation entity for ${h}: ${m instanceof Error?m.message:"Unknown error"}`),m}}async#f({apiOperationKey:e,operationRelations:o,descriptionUniqueKey:s,description:n,parentVersion:t,parentRevision:a}){try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:s,fileHash:n.hash,sourceVersion:t,targetVersion:t,sourceRevision:a,targetRevision:a}),await this.#y(e,o,t,a)}catch(r){this.#e.error(`Failed to create API operation relations for ${e}: ${r instanceof Error?r.message:"Unknown error"}`)}}async#y(e,o,s,n){o?.length&&await u(o,w,async t=>{try{x(t),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:t.type,targetKey:t.key,sourceVersion:s,targetVersion:s,sourceRevision:n,targetRevision:n})}catch(a){this.context.logger.warn(`Error creating entity relation for operation ${e} based on custom property: ${a instanceof Error?a.message:"Unknown error"}`)}})}}export{F as OpenApiEntitiesExtractor};

package/dist/server/plugins/catalog-entities/extensions/extractors/fs-entities-extractor.js

@@ -1 +1 @@
-import{CATALOG_ENTITIES_FILES_REGEX as f,ENTITY_SCHEMA_EXCLUDED_FOLDERS as E}from"../../../../constants/plugins/catalog-entities.js";import{FileHashStatus as c,FileType as a}from"../../../../persistence/file-hashes/types.js";import{promiseMapLimit as u}from"../../../../utils/async/promise-map-limit.js";import{extractFileContent as d}from"../../entities/extract-entities-content.js";import{resolveEntityVersion as h}from"../../utils/resolve-entity-version.js";import{parseAndValidateEntities as g}from"../../entities/validate-entity.js";import{catalogDataCollector as l}from"../../utils/catalog-data-collector.js";const m=15;class D{#e;#t;#i;#r;#s;constructor({fileHashManager:t,context:e,catalogEntitiesService:i,catalogConfig:s,shouldCalculateEntities:o}){this.#e=t,this.#t=e,this.#i=i,this.#r=s,this.#s=o}async extract(t){try{if(t&&this.#o(t)){await this.#n(t);return}await this.#e.markAllAsOutdated(a.ENTITY_DEFINITION);const i=(await this.#t.fs.scan(f)).filter(({relativePath:s})=>this.#o(s));i.length&&l.addExtractor("fs"),await u(i,m,async({relativePath:s})=>{await this.#n(s)}),await this.#f()}catch(e){this.#t.logger.error("Error extracting entities.",e)}}#o=t=>!!(t.match(f)&&!E.some(e=>t.includes(e)));#n=async t=>{try{const e=await d(t,this.#t);if(!e){this.#t.logger.warn(`Error extracting content from ${t}.`);return}const i=await this.#e.computeFileHash(e);if(!((await this.#e.getByPath(t))?.hash!==i||this.#s||process.env.FORCE_CATALOG_CACHE_REVALIDATE==="true")){l.increaseSkippedFilesCount(),await this.#e.upsert(a.ENTITY_DEFINITION,t,i,c.UP_TO_DATE);return}const r=this.#a(e.entities,t);if(!r)return;const n=await this.#c(r,t,i);await this.#l(n,t),l.increaseProcessedFilesCount(),await this.#e.upsert(a.ENTITY_DEFINITION,t,i,c.UP_TO_DATE)}catch(e){this.#t.logger.warn(`Error processing file "${t}". ${e instanceof Error?e.message:String(e)}.`)}};#a=(t,e)=>{try{return g(t,this.#r)}catch(i){return this.#t.logger.warn(`Error validating entities in "${e}". ${i instanceof Error?i.message:String(i)}.`),null}};#c=async(t,e,i)=>{const s=new Set;for(const o of t)try{const r=h(o.version,e);if(!r.success){this.#t.logger.warn(`Entity "${o.key}" in file "${e}" has conflicting versions: file version "${r.fileVersion}" differs from folder version "${r.folderVersion}". Entity will not be created.`);continue}const n={...o,version:r.version};await this.#i.createEntityInLocalDatabase({entity:n,sourceFile:e,fileHash:i}),o.key&&s.add(o.key)}catch(r){const n=o.key??"unknown";this.#t.logger.warn(`Error processing entity "${n}" from "${e}". ${r instanceof Error?r.message:String(r)}.`)}return s};#l=async(t,e)=>{t.size!==0&&await this.#i.deleteEntitiesInLocalDatabase({op:"AND",conditions:[{field:"key",operator:"in",value:Array.from(t),modifier:"not"},{field:"source",operator:"equal",value:"file"},{field:"source_file",operator:"equal",value:e}]})};#f=async()=>{const t=await this.#e.getAllOutdated(a.ENTITY_DEFINITION);if(!t||t.length===0)return;const e=await this.#i.getEntities({limit:200,filter:{op:"AND",conditions:[{field:"source_file",operator:"in",value:t.map(({filePath:i})=>i)},{field:"is_current",operator:"equal",value:!0}]}});!e||e.items.length===0||(await this.#i.deleteEntitiesInLocalDatabase({field:"key",operator:"in",value:e.items.map(({key:i})=>i)}),await this.#e.deleteFileHashes({op:"AND",conditions:[{field:"file_type",operator:"equal",value:a.ENTITY_DEFINITION},{field:"status",operator:"equal",value:c.OUTDATED}]}))}}export{D as FsEntitiesExtractor};
+import{CATALOG_ENTITIES_FILES_REGEX as E,ENTITY_SCHEMA_EXCLUDED_FOLDERS as d}from"../../../../constants/plugins/catalog-entities.js";import{FileHashStatus as l,FileType as a}from"../../../../persistence/file-hashes/types.js";import{OPERATORS as u}from"../../../../providers/database/pagination/constants.js";import{promiseMapLimit as h}from"../../../../utils/async/promise-map-limit.js";import{VERSION_NOT_SPECIFIED as m}from"@redocly/theme/core/constants";import{extractFileContent as p}from"../../entities/extract-file-content.js";import{resolveEntityVersion as g}from"../../utils/resolve-entity-version.js";import{parseAndValidateEntities as y}from"../../entities/validate-entity.js";import{catalogDataCollector as f}from"../../utils/catalog-data-collector.js";const I=15;class v{#t;#e;#i;#r;#s;constructor({fileHashManager:e,context:t,catalogEntitiesService:i,catalogConfig:o,shouldCalculateEntities:s}){this.#t=e,this.#e=t,this.#i=i,this.#r=o,this.#s=s}async extract(e){try{if(e&&this.#o(e)){await this.#n(e);return}await this.#t.markAllAsOutdated(a.ENTITY_DEFINITION);const i=this.#e.fs.scan(E).filter(({relativePath:o})=>this.#o(o));i.length&&f.addExtractor("fs"),await h(i,I,async({relativePath:o})=>{await this.#n(o)}),await this.#f()}catch(t){this.#e.logger.error("Error extracting entities.",t)}}#o=e=>!!(e.match(E)&&!d.some(t=>e.includes(t)));#n=async e=>{try{const t=await p(e,this.#e);if(!t){this.#e.logger.warn(`Error extracting content from ${e}.`);return}const i=await this.#t.computeFileHash(t);if(!((await this.#t.getByPath(e))?.hash!==i||this.#s||process.env.FORCE_CATALOG_CACHE_REVALIDATE==="true")){f.increaseSkippedFilesCount(),await this.#t.upsert(a.ENTITY_DEFINITION,e,i,l.UP_TO_DATE);return}const r=this.#a(t.entities,e);if(!r)return;const n=await this.#i.getEntityKeysAndVersionsBySourceFile(e);await this.#c(r,e,i,n),await this.#l(n,e),f.increaseProcessedFilesCount(),await this.#t.upsert(a.ENTITY_DEFINITION,e,i,l.UP_TO_DATE)}catch(t){this.#e.logger.warn(`Error processing file "${e}". ${t instanceof Error?t.message:String(t)}.`)}};#a=(e,t)=>{try{return y(e,this.#r)}catch(i){return this.#e.logger.warn(`Error validating entities in "${t}". ${i instanceof Error?i.message:String(i)}.`),null}};#c=async(e,t,i,o)=>{for(const s of e)try{const r=g(s.version,t);if(!r.success){this.#e.logger.warn(`Entity "${s.key}" in file "${t}" has conflicting versions: file version "${r.fileVersion}" differs from folder version "${r.folderVersion}". Entity will not be created.`);continue}const n={...s,version:r.version};if(await this.#i.createEntityInLocalDatabase({entity:n,sourceFile:t,fileHash:i}),s.key){const c=r.version??m;o.delete(`${s.key}:${c}`)}}catch(r){const n=s.key??"unknown";this.#e.logger.warn(`Error processing entity "${n}" from "${t}". ${r instanceof Error?r.message:String(r)}.`)}};#l=async(e,t)=>{if(e.size===0)return;const i=Array.from(e).map(r=>{const[n,c]=r.split(":");return{key:n,version:c}}),o=Array.from(new Set(i.map(({key:r})=>r))),s=i.map(({key:r,version:n})=>({op:u.AND,conditions:[{field:"key",operator:"equal",value:r},{field:"version",operator:"equal",value:n}]}));await this.#i.deleteEntitiesInLocalDatabase({op:"AND",conditions:[{field:"key",operator:"in",value:o},{op:u.OR,conditions:s},{field:"source",operator:"equal",value:"file"},{field:"source_file",operator:"equal",value:t}]})};#f=async()=>{const e=await this.#t.getAllOutdated(a.ENTITY_DEFINITION);if(!e||e.length===0)return;const t=await this.#i.getEntities({limit:1e3,filter:{op:"AND",conditions:[{field:"source_file",operator:"in",value:e.map(({filePath:i})=>i)},{field:"is_current",operator:"equal",value:!0}]}});!t||t.items.length===0||(await this.#i.deleteEntitiesInLocalDatabase({field:"key",operator:"in",value:t.items.map(({key:i})=>i)}),await this.#t.deleteFileHashes({op:"AND",conditions:[{field:"file_type",operator:"equal",value:a.ENTITY_DEFINITION},{field:"status",operator:"equal",value:l.OUTDATED}]}))}}export{v as FsEntitiesExtractor};

package/dist/server/plugins/catalog-entities/get-server-props.d.ts

@@ -1,7 +1,6 @@
-import type { BffCatalogEntity, BffCatalogEntityList, BffCatalogRelatedEntity, BffCatalogRelatedEntityList, CatalogSwitcherItem, CatalogViewMode } from '@redocly/theme/core/types';
+import type { BffCatalogEntity, BffCatalogEntityList, BffCatalogRelatedEntity, BffCatalogRelatedEntityList, CatalogSwitcherItem, CatalogViewMode, CatalogFiltersWithCounts } from '@redocly/theme/core/types';
 import type { EntitiesCatalogConfig, CatalogEntityConfig } from '@redocly/config';
 import type { GetServerPropsFn } from '../../types/plugins/common';
-import type { CatalogFiltersWithCounts } from '@redocly/theme/core/types';
 export type ServerSideProps = {
     status: 'success';
     entitiesTypes: string[];

package/dist/server/plugins/catalog-entities/get-server-props.js

@@ -1 +1 @@
-import{sha1 as E}from"../../utils/crypto/sha1.js";import{CatalogEntitiesService as h}from"./database/catalog-entities-service.js";import{createPaginationParamsValidator as w}from"../../providers/database/pagination/schemas";import{parseSearch as F}from"../../providers/database/pagination/search";import{OPERATORS as v}from"../../providers/database/pagination/constants.js";import{CacheService as A}from"../../persistence/cache/services/cache-service.js";import{CATALOG_FILTERS_CACHE_NAMESPACE as b,CATALOG_FILTERS_CACHE_TTL_IN_SECONDS as I}from"../../constants/plugins/catalog-entities.js";const x={all:"all",domains:"domain",services:"service",teams:"team",users:"user","api-descriptions":"api-description","data-schemas":"data-schema"},T={team:{field:"type",operator:"equal",value:"user"},"api-description":{field:"type",operator:"equal",value:"api-operation"}},D=async({entitiesTypes:e,serverOutDir:a,catalogConfig:t,queries:o={}})=>{const p=await h.getInstance({baseDbDir:a}),r=M.concat("domains","owners"),l=w(r).parse(o),d=t.excludes?.map(s=>s.key)??[],u=e.filter(s=>s!=="all"),n=V(u,d);return l.filter?l.filter={op:v.AND,conditions:[l.filter,n]}:l.filter=n,await p.getEntitiesWithRelations({sort:[{field:"type",order:"ASC"}],limit:10,...l})},P=async(e,a,t)=>{const o=await h.getInstance({baseDbDir:a}),p=w(["version","revision"]).parse(t??{}),r=await o.getEntityWithRelationsByKey(e,p);if(!r)return null;const l=r.type==="data-schema"?await o.getRelatedEntities(e,{limit:1,filter:{field:"type",operator:"equal",value:"api-description"}}).then(n=>n.items?.[0]??null):null,d=T[r.type]??void 0,u=await o.getRelatedEntities(e,{limit:10,sort:[{field:"title",order:"ASC"}],filter:d,search:t?.search?F(t?.search,["key","type","title","summary"]):void 0});return{status:"success",entity:r,relatedEntity:l,relations:u}},R=e=>{const a=JSON.stringify({entitiesTypes:e.entitiesTypes.sort(),filtersConfig:e.filtersConfig});return E(a)},_=async({serverOutDir:e,entitiesTypes:a,filtersConfig:t})=>{if(!t||t.length===0)return{};const o=R({entitiesTypes:a,filtersConfig:t}),p=await A.getInstance({baseDbDir:e}),r=await p.get({key:o,namespace:b});if(r)return r;const l=await h.getInstance({baseDbDir:e}),d=[],u=new Map;for(const s of t)!s.options||s.options.length===0?d.push(s.property):u.set(s.property,s.options);const n=await l.getCatalogFilters({entitiesTypes:a,emptyFilters:d}),c={};for(const s of t){const g=u.get(s.property);if(!g){const i=n[s.property];c[s.property]=i&&i.length>0?i:[];continue}const m=(await l.getCatalogFilters({entitiesTypes:a,emptyFilters:[s.property]}))[s.property];if(!m){c[s.property]=[];continue}const f=new Map;for(const i of m){const y=i.value.toLowerCase().trim();f.set(y,{originalValue:i.value,count:i.count})}c[s.property]=g.map(i=>{const y=i.toLowerCase().trim(),S=f.get(y);return{value:S?.originalValue??i,count:S?.count??0}}).filter(i=>i.count>0).sort((i,y)=>i.value.localeCompare(y.value))}return await p.set({key:o,value:c,namespace:b,ttlInSeconds:I}),c},L=async(e,{props:a},t,{serverOutDir:o,getRouteSharedDataByFsPath:p})=>{const r=a?.catalogConfig||{};if(!e.params||!a?.catalogConfig)return{status:"notFound"};const[l,d,u]=e.params;if(!l)return{status:"notFound"};const n=N(r,l),c=n?.includes?.map(f=>f.type)??[];if(!n)return{status:"notFound"};if(!u&&d!=="entities"){if(n.hide)return{status:"notFound"};const f=await _({entitiesTypes:c,serverOutDir:o,filtersConfig:n.filters}),i=e.queries?.viewMode??"table";return{status:"success",catalogSwitcherItems:O(r,n),entitiesTypes:c,entities:await D({entitiesTypes:c,serverOutDir:o,catalogConfig:n,queries:e.queries}),catalogConfig:n,filters:f,initialViewMode:i}}const s=await P(u,o,e.queries),g=s?.entity.sourceFile,C=s?.entity.type==="api-description",m=g&&C&&p(g)||{};return s?{status:"success",entity:s.entity,relatedEntity:s.relatedEntity,relations:s.relations,entitiesCatalogConfig:r,catalogConfig:n,sharedDataIds:m}:{status:"notFound"}},N=(e,a)=>Object.values(e.catalogs??{}).find(t=>t&&typeof t=="object"&&"slug"in t&&t.slug===a),O=(e,a)=>Object.values(e.catalogs??{}).filter(t=>!t?.hide).map(t=>({labelTranslationKey:t?.catalogSwitcherLabelTranslationKey??t?.slug??"",slug:t?.slug??"",selected:t?.slug===a.slug})).sort((t,o)=>t.slug.localeCompare(o.slug)),V=(e,a)=>({op:"AND",conditions:[...e.length?[{field:"type",operator:"in",value:e}]:[],...a.length?[{field:"key",operator:"in",value:a,modifier:"not"}]:[]]}),M=["type","key","title","summary","tags","metadata","metadata.*","git","contact","links","id","source","sourceFile","createdAt","updatedAt"];var z=L;export{z as default};
+import{sha1 as b}from"../../utils/crypto/sha1.js";import{isValidSanitizedString as E}from"../../utils/validate-and-sanitize-string";import{CatalogEntitiesService as h}from"./database/catalog-entities-service.js";import{createPaginationParamsValidator as F}from"../../providers/database/pagination/schemas";import{parseSearch as A}from"../../providers/database/pagination/search";import{OPERATORS as C}from"../../providers/database/pagination/constants.js";import{CacheService as I}from"../../persistence/cache/services/cache-service.js";import{CATALOG_FILTERS_CACHE_NAMESPACE as w,CATALOG_FILTERS_CACHE_TTL_IN_SECONDS as D}from"../../constants/plugins/catalog-entities.js";import{isValidIsoDate as T}from"../../utils/is-valid-iso-date.js";const Z={all:"all",domains:"domain",services:"service",teams:"team",users:"user","api-descriptions":"api-description","data-schemas":"data-schema"},R={team:{field:"type",operator:"equal",value:"user"},"api-description":{field:"type",operator:"equal",value:"api-operation"}},V=async({entitiesTypes:e,serverOutDir:s,catalogConfig:t,queries:a={}})=>{const n=await h.getInstance({baseDbDir:s}),c=K.concat("domains","owners"),r=F(c).parse(a),p=t.excludes?.map(i=>i.key)??[],d=e.filter(i=>i!=="all"),l=k(d,p);return r.filter?r.filter={op:C.AND,conditions:[r.filter,l]}:r.filter=l,await n.getEntitiesWithRelations({sort:[{field:"type",order:"ASC"}],limit:10,...r})},_=async(e,s,t)=>{const a=await h.getInstance({baseDbDir:s});let n=null;const c=t?.revision;c&&T(c)&&(n=c);const r=t?.version;if(!E(r,{pattern:/^[a-zA-Z0-9._-]+$/,maxLength:100,allowEmpty:!0}))return null;const p=await a.getEntityWithRelationsByKey(e,{revision:n,version:r});if(!p)return null;const d=p.type==="data-schema"?await a.getRelatedEntities(e,{limit:1,filter:{field:"type",operator:"equal",value:"api-description"}}).then(f=>f.items?.[0]??null):null,l=R[p.type]??void 0,u=q(l,r,n),i=await a.getRelatedEntities(e,{limit:10,sort:[{field:"title",order:"ASC"}],filter:u,search:t?.search?A(t?.search,["key","type","title","summary"]):void 0});return{status:"success",entity:p,relatedEntity:d,relations:i}},N=e=>{const s=JSON.stringify({entitiesTypes:e.entitiesTypes.sort(),filtersConfig:e.filtersConfig});return b(s)},P=async({serverOutDir:e,entitiesTypes:s,filtersConfig:t})=>{if(!t||t.length===0)return{};const a=N({entitiesTypes:s,filtersConfig:t}),n=await I.getInstance({baseDbDir:e}),c=await n.get({key:a,namespace:w});if(c)return c;const r=await h.getInstance({baseDbDir:e}),p=[],d=new Map;for(const i of t)!i.options||i.options.length===0?p.push(i.property):d.set(i.property,i.options);const l=await r.getCatalogFilters({entitiesTypes:s,emptyFilters:p}),u={};for(const i of t){const f=d.get(i.property);if(!f){const o=l[i.property];u[i.property]=o&&o.length>0?o:[];continue}const y=(await r.getCatalogFilters({entitiesTypes:s,emptyFilters:[i.property]}))[i.property];if(!y){u[i.property]=[];continue}const g=new Map;for(const o of y){const m=o.value.toLowerCase().trim();g.set(m,{originalValue:o.value,count:o.count})}u[i.property]=f.map(o=>{const m=o.toLowerCase().trim(),S=g.get(m);return{value:S?.originalValue??o,count:S?.count??0}}).filter(o=>o.count>0).sort((o,m)=>o.value.localeCompare(m.value))}return await n.set({key:a,value:u,namespace:w,ttlInSeconds:D}),u},L=async(e,{props:s},t,{serverOutDir:a,getRouteSharedDataByFsPath:n})=>{const c=s?.catalogConfig||{};if(!e.params||!s?.catalogConfig)return{status:"notFound"};const[r,p,d]=e.params;if(!r)return{status:"notFound"};const l=O(c,r),u=l?.includes?.map(g=>g.type)??[];if(!l)return{status:"notFound"};if(!d&&p!=="entities"){if(l.hide)return{status:"notFound"};const g=await P({entitiesTypes:u,serverOutDir:a,filtersConfig:l.filters}),o=e.queries?.viewMode??"table";return{status:"success",catalogSwitcherItems:M(c,l),entitiesTypes:u,entities:await V({entitiesTypes:u,serverOutDir:a,catalogConfig:l,queries:e.queries}),catalogConfig:l,filters:g,initialViewMode:o}}const i=await _(d,a,e.queries),f=i?.entity.sourceFile,v=i?.entity.type==="api-description",y=f&&v&&n(f)||{};return i?{status:"success",entity:i.entity,relatedEntity:i.relatedEntity,relations:i.relations,entitiesCatalogConfig:c,catalogConfig:l,sharedDataIds:y}:{status:"notFound"}},O=(e,s)=>Object.values(e.catalogs??{}).find(t=>t&&typeof t=="object"&&"slug"in t&&t.slug===s),M=(e,s)=>Object.values(e.catalogs??{}).filter(t=>!t?.hide).map(t=>({labelTranslationKey:t?.catalogSwitcherLabelTranslationKey??t?.slug??"",slug:t?.slug??"",selected:t?.slug===s.slug})).sort((t,a)=>t.slug.localeCompare(a.slug)),k=(e,s)=>({op:"AND",conditions:[...e.length?[{field:"type",operator:"in",value:e}]:[],...s.length?[{field:"key",operator:"in",value:s,modifier:"not"}]:[]]}),q=(e,s,t)=>{let a=e;if(s!==void 0){const n={field:"version",operator:"equal",value:s};a=a?{op:C.AND,conditions:[a,n]}:n}if(t){const n={field:"revision",operator:"equal",value:t};a=a?{op:C.AND,conditions:[a,n]}:n}return a},K=["type","key","title","summary","tags","metadata","metadata.*","git","contact","links","id","source","sourceFile","createdAt","updatedAt"];var $=L;export{$ as default};

package/dist/server/plugins/catalog-entities/schemas/database-schemas.d.ts

@@ -126,6 +126,9 @@ export declare const entityDatabaseSchema: {
         readonly is_default_version: {
             readonly type: readonly ["boolean", "null"];
         };
+        readonly is_deleted: {
+            readonly type: readonly ["boolean", "null"];
+        };
     };
     readonly required: readonly ["id", "organization_id", "project_id", "key", "type", "title", "created_at", "updated_at", "source"];
     readonly additionalProperties: false;
@@ -177,7 +180,68 @@ export declare const relatedEntityDatabaseSchema: {
     readonly required: readonly ["id", "key", "title", "type", "source"];
     readonly additionalProperties: false;
 };
+/**
+ * Schema for "query rows" coming from SQL/drizzle selects (joins/unions), normalized to a stable
+ * snake_case shape in mappers before validating.
+ */
+export declare const relatedEntityQueryRowDatabaseSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly key: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly title: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly type: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly summary: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly source: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly source_file: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly created_at: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly updated_at: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly metadata: {
+            readonly type: readonly ["string", "object", "null"];
+        };
+        readonly version: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly revision: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly direction: {
+            readonly type: "string";
+            readonly enum: readonly ["outgoing", "incoming"];
+        };
+        readonly relation_field: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+    };
+    readonly required: readonly ["id", "key", "title", "type", "source", "direction", "relation_field"];
+    readonly additionalProperties: false;
+};
 export type EntityRelationDto = FromSchema<typeof entityRelationDatabaseSchema>;
 export type EntityDto = FromSchema<typeof entityDatabaseSchema>;
 export type RelatedEntityDto = FromSchema<typeof relatedEntityDatabaseSchema>;
+export type RelatedEntityQueryRowDto = FromSchema<typeof relatedEntityQueryRowDatabaseSchema>;
 //# sourceMappingURL=database-schemas.d.ts.map

package/dist/server/plugins/catalog-entities/schemas/database-schemas.js

@@ -1 +1 @@
-import{ENTITY_RELATION_TYPES as t}from"@redocly/config";const r={type:"object",properties:{id:{type:"string"},organization_id:{type:"string"},project_id:{type:"string"},source_key:{type:"string"},source_id:{type:["string","null"]},source_version:{type:["string","null"]},source_revision:{type:["string","null"]},source_to_target_relation:{type:"string"},target_key:{type:"string"},target_id:{type:["string","null"]},target_version:{type:["string","null"]},target_revision:{type:["string","null"]},target_to_source_relation:{type:"string"},source_file:{type:["string","null"]},file_hash:{type:["string","null"]},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","organization_id","project_id","source_key","source_to_target_relation","target_key","target_to_source_relation","created_at","updated_at"],additionalProperties:!1},i={type:"object",properties:{id:{type:"string"},organization_id:{type:"string"},project_id:{type:"string"},key:{type:"string"},type:{type:"string"},title:{type:"string"},summary:{type:["string","null"]},tags:{type:["string","null"]},metadata:{type:["string","null"]},git:{type:["string","null"]},contact:{type:["string","null"]},links:{type:["string","null"]},created_at:{type:"string"},updated_at:{type:"string"},source:{type:"string"},source_file:{type:["string","null"]},file_hash:{type:["string","null"]},version:{type:["string","null"]},revision:{type:["string","null"]},hash:{type:["string","null"]},is_current:{type:["boolean","null"]},is_default_version:{type:["boolean","null"]}},required:["id","organization_id","project_id","key","type","title","created_at","updated_at","source"],additionalProperties:!1},n={type:"object",properties:{id:{type:"string"},key:{type:"string"},title:{type:"string"},type:{type:"string"},summary:{type:["string","null"]},source:{type:"string"},relation_role:{type:["string","null"]},relation_type:{type:["string","null"],enum:t},source_file:{type:["string","null"]},created_at:{type:["string","null"]},updated_at:{type:["string","null"]},metadata:{type:["string","null"]},version:{type:["string","null"]}},required:["id","key","title","type","source"],additionalProperties:!1};export{i as entityDatabaseSchema,r as entityRelationDatabaseSchema,n as relatedEntityDatabaseSchema};
+import{ENTITY_RELATION_TYPES as t}from"@redocly/config";const i={type:"object",properties:{id:{type:"string"},organization_id:{type:"string"},project_id:{type:"string"},source_key:{type:"string"},source_id:{type:["string","null"]},source_version:{type:["string","null"]},source_revision:{type:["string","null"]},source_to_target_relation:{type:"string"},target_key:{type:"string"},target_id:{type:["string","null"]},target_version:{type:["string","null"]},target_revision:{type:["string","null"]},target_to_source_relation:{type:"string"},source_file:{type:["string","null"]},file_hash:{type:["string","null"]},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","organization_id","project_id","source_key","source_to_target_relation","target_key","target_to_source_relation","created_at","updated_at"],additionalProperties:!1},n={type:"object",properties:{id:{type:"string"},organization_id:{type:"string"},project_id:{type:"string"},key:{type:"string"},type:{type:"string"},title:{type:"string"},summary:{type:["string","null"]},tags:{type:["string","null"]},metadata:{type:["string","null"]},git:{type:["string","null"]},contact:{type:["string","null"]},links:{type:["string","null"]},created_at:{type:"string"},updated_at:{type:"string"},source:{type:"string"},source_file:{type:["string","null"]},file_hash:{type:["string","null"]},version:{type:["string","null"]},revision:{type:["string","null"]},hash:{type:["string","null"]},is_current:{type:["boolean","null"]},is_default_version:{type:["boolean","null"]},is_deleted:{type:["boolean","null"]}},required:["id","organization_id","project_id","key","type","title","created_at","updated_at","source"],additionalProperties:!1},r={type:"object",properties:{id:{type:"string"},key:{type:"string"},title:{type:"string"},type:{type:"string"},summary:{type:["string","null"]},source:{type:"string"},relation_role:{type:["string","null"]},relation_type:{type:["string","null"],enum:t},source_file:{type:["string","null"]},created_at:{type:["string","null"]},updated_at:{type:["string","null"]},metadata:{type:["string","null"]},version:{type:["string","null"]}},required:["id","key","title","type","source"],additionalProperties:!1},s={type:"object",properties:{id:{type:"string",minLength:1},key:{type:"string",minLength:1},title:{type:"string",minLength:1},type:{type:"string",minLength:1},summary:{type:["string","null"]},source:{type:"string",minLength:1},source_file:{type:["string","null"]},created_at:{type:["string","null"]},updated_at:{type:["string","null"]},metadata:{type:["string","object","null"]},version:{type:["string","null"]},revision:{type:["string","null"]},direction:{type:"string",enum:["outgoing","incoming"]},relation_field:{type:"string",minLength:1}},required:["id","key","title","type","source","direction","relation_field"],additionalProperties:!1};export{n as entityDatabaseSchema,i as entityRelationDatabaseSchema,r as relatedEntityDatabaseSchema,s as relatedEntityQueryRowDatabaseSchema};

package/dist/server/plugins/catalog-entities/schemas/dto-schemas.d.ts

@@ -17,18 +17,12 @@ export declare const entityRelationDtoSchema: {
             readonly minLength: 2;
             readonly maxLength: 150;
         };
-        readonly sourceId: {
-            readonly type: readonly ["string", "null"];
-        };
         readonly sourceVersion: {
             readonly type: readonly ["string", "null"];
         };
         readonly sourceRevision: {
             readonly type: readonly ["string", "null"];
         };
-        readonly targetId: {
-            readonly type: readonly ["string", "null"];
-        };
         readonly targetVersion: {
             readonly type: readonly ["string", "null"];
         };
@@ -41,6 +35,9 @@ export declare const entityRelationDtoSchema: {
         readonly fileHash: {
             readonly type: readonly ["string", "null"];
         };
+        readonly isDeleted: {
+            readonly type: readonly ["boolean", "null"];
+        };
     };
     readonly required: readonly ["type", "sourceKey", "targetKey"];
     readonly additionalProperties: false;
@@ -64,18 +61,12 @@ export declare const entitiesRelationsDtoSchema: {
                 readonly minLength: 2;
                 readonly maxLength: 150;
             };
-            readonly sourceId: {
-                readonly type: readonly ["string", "null"];
-            };
             readonly sourceVersion: {
                 readonly type: readonly ["string", "null"];
             };
             readonly sourceRevision: {
                 readonly type: readonly ["string", "null"];
             };
-            readonly targetId: {
-                readonly type: readonly ["string", "null"];
-            };
             readonly targetVersion: {
                 readonly type: readonly ["string", "null"];
             };
@@ -88,6 +79,9 @@ export declare const entitiesRelationsDtoSchema: {
             readonly fileHash: {
                 readonly type: readonly ["string", "null"];
             };
+            readonly isDeleted: {
+                readonly type: readonly ["boolean", "null"];
+            };
         };
         readonly required: readonly ["type", "sourceKey", "targetKey"];
         readonly additionalProperties: false;

package/dist/server/plugins/catalog-entities/schemas/dto-schemas.js

@@ -1 +1 @@
-import{ENTITY_RELATION_TYPES as e}from"@redocly/config";const t={type:"object",properties:{type:{type:"string",enum:e},sourceKey:{type:"string",minLength:2,maxLength:150},targetKey:{type:"string",minLength:2,maxLength:150},sourceId:{type:["string","null"]},sourceVersion:{type:["string","null"]},sourceRevision:{type:["string","null"]},targetId:{type:["string","null"]},targetVersion:{type:["string","null"]},targetRevision:{type:["string","null"]},sourceFile:{type:["string","null"]},fileHash:{type:["string","null"]}},required:["type","sourceKey","targetKey"],additionalProperties:!1},r={type:"array",items:t};export{r as entitiesRelationsDtoSchema,t as entityRelationDtoSchema};
+import{ENTITY_RELATION_TYPES as e}from"@redocly/config";const t={type:"object",properties:{type:{type:"string",enum:e},sourceKey:{type:"string",minLength:2,maxLength:150},targetKey:{type:"string",minLength:2,maxLength:150},sourceVersion:{type:["string","null"]},sourceRevision:{type:["string","null"]},targetVersion:{type:["string","null"]},targetRevision:{type:["string","null"]},sourceFile:{type:["string","null"]},fileHash:{type:["string","null"]},isDeleted:{type:["boolean","null"]}},required:["type","sourceKey","targetKey"],additionalProperties:!1},i={type:"array",items:t};export{i as entitiesRelationsDtoSchema,t as entityRelationDtoSchema};

package/dist/server/plugins/catalog-entities/schemas/read-model-schemas.d.ts

@@ -18,12 +18,6 @@ export declare const entityRelationReadModelSchema: {
         readonly targetKey: {
             readonly type: "string";
         };
-        readonly sourceId: {
-            readonly type: "string";
-        };
-        readonly targetId: {
-            readonly type: "string";
-        };
         readonly sourceVersion: {
             readonly type: readonly ["string", "null"];
         };
@@ -46,7 +40,7 @@ export declare const entityRelationReadModelSchema: {
             readonly type: readonly ["string", "null"];
         };
     };
-    readonly required: readonly ["id", "organizationId", "projectId", "sourceKey", "targetKey", "sourceId", "targetId", "type"];
+    readonly required: readonly ["id", "organizationId", "projectId", "sourceKey", "targetKey", "type"];
     readonly additionalProperties: false;
 };
 export declare const entityReadModelSchema: {
@@ -173,14 +167,16 @@ export type EntityReadModelSchema = {
     source: string;
     sourceFile?: string | null;
     version?: string | null;
-    revision?: string | null;
+    revision: string;
     hash?: string | null;
     isCurrent?: boolean | null;
     isDefaultVersion?: boolean | null;
+    isDeleted?: boolean | null;
     createdAt?: string | null;
     updatedAt?: string | null;
     object: 'catalogEntity';
     domains?: RelatedEntitySchema[];
     owners?: RelatedEntitySchema[];
 };
+export type EntityRevisionSummary = Pick<EntityReadModelSchema, 'version' | 'revision' | 'isCurrent' | 'createdAt' | 'updatedAt' | 'isDefaultVersion' | 'isDeleted'>;
 //# sourceMappingURL=read-model-schemas.d.ts.map

package/dist/server/plugins/catalog-entities/schemas/read-model-schemas.js

@@ -1 +1 @@
-const t={type:"object",properties:{id:{type:"string"},organizationId:{type:"string"},projectId:{type:"string"},sourceKey:{type:"string"},targetKey:{type:"string"},sourceId:{type:"string"},targetId:{type:"string"},sourceVersion:{type:["string","null"]},sourceRevision:{type:["string","null"]},targetVersion:{type:["string","null"]},targetRevision:{type:["string","null"]},type:{type:"string"},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["id","organizationId","projectId","sourceKey","targetKey","sourceId","targetId","type"],additionalProperties:!1},e={type:"object",properties:{type:{type:"string"},key:{type:"string"},title:{type:"string"},summary:{type:["string","null"]},tags:{type:["array","null"],items:{type:"string"}},metadata:{type:["object","null"],additionalProperties:!0},git:{type:["array","null"],items:{type:"string"}},contact:{type:["object","null"]},links:{type:["array","null"],items:{type:"object"}},id:{type:"string"},source:{type:"string"},sourceFile:{type:["string","null"]},version:{type:["string","null"]},revision:{type:["string","null"]},hash:{type:["string","null"]},isCurrent:{type:["boolean","null"]},isDefaultVersion:{type:["boolean","null"]},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["type","key","title","id","source"],additionalProperties:!1},r={type:"object",properties:{id:{type:"string"},key:{type:"string"},title:{type:"string"},type:{type:"string"},summary:{type:["string","null"]},source:{type:"string"},sourceFile:{type:["string","null"]},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["id","key","title","type","source"],additionalProperties:!1};export{e as entityReadModelSchema,t as entityRelationReadModelSchema,r as relatedEntitySchema};
+const t={type:"object",properties:{id:{type:"string"},organizationId:{type:"string"},projectId:{type:"string"},sourceKey:{type:"string"},targetKey:{type:"string"},sourceVersion:{type:["string","null"]},sourceRevision:{type:["string","null"]},targetVersion:{type:["string","null"]},targetRevision:{type:["string","null"]},type:{type:"string"},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["id","organizationId","projectId","sourceKey","targetKey","type"],additionalProperties:!1},e={type:"object",properties:{type:{type:"string"},key:{type:"string"},title:{type:"string"},summary:{type:["string","null"]},tags:{type:["array","null"],items:{type:"string"}},metadata:{type:["object","null"],additionalProperties:!0},git:{type:["array","null"],items:{type:"string"}},contact:{type:["object","null"]},links:{type:["array","null"],items:{type:"object"}},id:{type:"string"},source:{type:"string"},sourceFile:{type:["string","null"]},version:{type:["string","null"]},revision:{type:["string","null"]},hash:{type:["string","null"]},isCurrent:{type:["boolean","null"]},isDefaultVersion:{type:["boolean","null"]},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["type","key","title","id","source"],additionalProperties:!1},r={type:"object",properties:{id:{type:"string"},key:{type:"string"},title:{type:"string"},type:{type:"string"},summary:{type:["string","null"]},source:{type:"string"},sourceFile:{type:["string","null"]},createdAt:{type:["string","null"]},updatedAt:{type:["string","null"]}},required:["id","key","title","type","source"],additionalProperties:!1};export{e as entityReadModelSchema,t as entityRelationReadModelSchema,r as relatedEntitySchema};

package/dist/server/plugins/catalog-entities/utils/catalog-data-collector.js

@@ -1 +1 @@
-const i="error";class a{#t=new Set;#e;#s;#i=0;#o=0;addExtractor(t){this.#t.add(t)}increaseSkippedFilesCount(){this.#i++}increaseProcessedFilesCount(){this.#o++}async getCatalogEntitiesData(t){this.#e=this.#n(t),this.#s=this.#a(t);const[s,e]=await Promise.allSettled([this.#e,this.#s]);return{totalEntitiesCount:s.status==="fulfilled"?s.value:i,countOfEntitiesByType:e.status==="fulfilled"?e.value:i,extractors:Array.from(this.#t),totalFilesSkippedByHash:this.#i,totalProcessedFiles:this.#o}}async#n(t){return(await t.getEntities({})).page.total}async#a(t){return(await t.getEntitiesCountByTypes()).reduce((e,{type:o,count:n})=>(e[o]=n,e),{})}}const l=new a;export{a as CatalogDataCollector,l as catalogDataCollector};
+const i="error";class n{#t=new Set;#e;#s;#i=0;#o=0;addExtractor(t){this.#t.add(t)}increaseSkippedFilesCount(){this.#i++}increaseProcessedFilesCount(){this.#o++}async getCatalogEntitiesData(t){this.#e=this.#a(t),this.#s=this.#n(t);const[s,e]=await Promise.allSettled([this.#e,this.#s]);return{totalEntitiesCount:s.status==="fulfilled"?s.value:i,countOfEntitiesByType:e.status==="fulfilled"?e.value:i,extractors:Array.from(this.#t),totalFilesSkippedByHash:this.#i,totalProcessedFiles:this.#o}}async#a(t){return(await t.getEntities({limit:1,filter:{field:"is_deleted",operator:"equal",value:!1}})).page.total}async#n(t){return(await t.getEntitiesCountByTypes()).reduce((e,{type:o,count:a})=>(e[o]=a,e),{})}}const r=new n;export{n as CatalogDataCollector,r as catalogDataCollector};