@redocly/revel 0.128.0-next.0 → 0.128.0-next.10

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

@@ -1,13 +1,14 @@
 import type { BundledDefinition } from '../../../../asyncapi-docs/asyncapi-doc-loader';
 import type { EntityFileSchema } from '@redocly/config';
-import { BaseApiEntitiesExtractor, type BaseApiEntitiesExtractorParams } from './base.js';
+import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
+import { BaseApiEntitiesExtractor } from './base.js';
 type Params = BaseApiEntitiesExtractorParams;
 export declare class AsyncApiEntitiesExtractor extends BaseApiEntitiesExtractor<BundledDefinition> {
     #private;
     constructor(params: Params);
     mapApiDescriptionToEntity(description: BundledDefinition): EntityFileSchema;
     loadApiDescriptions(): Promise<BundledDefinition[]>;
-    processApiDescription(description: BundledDefinition, descriptionUniqueKey: string): Promise<void>;
+    processApiDescription(description: BundledDefinition): Promise<Set<string>>;
 }
 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 u}from"@redocly/theme/core/utils";import{toKebabCase as i}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as l,promiseMapLimitWithStatus as h}from"../../../../../utils/async.js";import{removeMarkdocTags as f}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as p}from"./base.js";import{extractPartsFromComponentsRef as m}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as g}from"../../../entities/validate-entity.js";import{extractPartsFromChannelsMessageRef as d}from"../../../utils/extract-parts-from-channels-message-ref.js";const o=15;class b extends p{constructor(e){super("asyncapi",e)}mapApiDescriptionToEntity(e){const t=u(e.realRelativePath),a=e.document.info.title,s=i(a);return{type:this.type,key:s,title:a,summary:f(e.document.info.description),tags:e.document.info.tags?.map(n=>n.name),metadata:{specType:this.specType,descriptionFile:t}}}async loadApiDescriptions(){return(await this.context.cache.load(".","asyncapi-docs")).data}async processApiDescription(e,t){const a=this.#t(e),[s]=await Promise.allSettled([this.#a(e,t),this.#n(a,e,t)]);s.status==="rejected"&&this.context.logger.error("Schema processing failed:",s.reason)}#t=e=>{const t=e.documentWithReferences.operations;return t?Object.entries(t).map(([a,s])=>({operationName:a,operation:s})):[]};#a=async(e,t)=>{const a=e.document.components?.schemas;if(!a)return;const s=Object.entries(a);if(s.length===0)return;const n=await h(s,o,async([r,c])=>{const y=await this.#s({schemaName:r,schema:c,description:e});await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"uses",targetKey:y,fileHash:e.hash})},this.context.logger);n.count.failed>0&&this.context.logger.warn(`Schema processing completed with ${n.count.failed} failures out of ${s.length} schemas for ${e.realRelativePath}`)};#s=async({schemaName:e,schema:t,description:a})=>{const s=i(e),n="title"in t?t.title??t.description:null,r=JSON.stringify(t),c={type:"data-schema",key:s,title:e,summary:n,tags:[],metadata:{specType:this.specType,schema:r}};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:a.realRelativePath,fileHash:a.hash}),c.key};#n=async(e,t,a)=>e.length?{failedCount:(await h(e,o,async({operationName:n,operation:r})=>{await this.#r(r,n,t,a)},this.context.logger)).count.failed,totalCount:e.length}:{failedCount:0,totalCount:0};#r=async(e,t,a,s)=>{const n=await this.#c({apiOperationKey:i(t),operation:e,descriptionUniqueKey:s,description:a});await this.#i(t,e,n,a)};#i=async(e,t,a,s)=>{const n={type:"api-operation",key:i(e),title:t.title||e,summary:t.summary??"",tags:t.tags?.map(r=>r.name)??[],metadata:{method:t.action==="send"?"PUBLISH":"SUBSCRIBE",path:t.channel.address??"",payload:t.action==="receive"?a:[],responses:t.action==="send"?a:[]}};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:n,sourceFile:s.realRelativePath,fileHash:s.hash}),n.key};#c=async({apiOperationKey:e,operation:t,descriptionUniqueKey:a,description:s})=>(await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:a,fileHash:s.hash}),await this.#o(t,e),!Array.isArray(t.messages)||!t.messages?.length?[]:await this.#l(t.messages,e,s));#o=async(e,t)=>{e["x-catalog-relations"]?.length&&await l(e["x-catalog-relations"],o,async a=>{try{g(a),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:a.type,targetKey:a.key})}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)=>e.length===0?[]:(await l(e,o,async n=>await this.#h(n,t,a)??"")).filter(n=>!!n);#h=async(e,t,a)=>"$ref"in e?this.#m(e,t,a):e.payload?this.#u(e,t,a):null;#m=async(e,t,a)=>{const s=e.$ref.startsWith("#/channels/")?this.#y(e.$ref,a):e.$ref;if(!s)return null;const n=m(s);if(!n||!n.componentName||n.componentType!=="messages")return null;const r=a.documentWithReferences.components?.messages[n.componentName];return!r?.payload||!("$ref"in r.payload)||!r.payload.$ref?null:this.#e(r.payload.$ref,t,a)};#y=(e,t)=>{const a=d(e);if(!a||!a.channelName||!a.messageName)return null;const s=t.documentWithReferences.channels?.[a.channelName];if(!s?.messages)return null;const n=s.messages[a.messageName];return!n||!("$ref"in n)||typeof n.$ref!="string"||!n.$ref.startsWith("#/components/messages/")?null:n.$ref};#u=async(e,t,a)=>!e.payload||!("$ref"in e.payload)||!e.payload.$ref?null:this.#e(e.payload.$ref,t,a);#e=async(e,t,a)=>{const s=m(e);if(!s||!s.componentName||s.componentType!=="schemas")return null;const n=i(s.componentName);return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"uses",targetKey:n,fileHash:a.hash}),n}}export{b as AsyncApiEntitiesExtractor};
+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};

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

@@ -1,32 +1,24 @@
 import type { FileInfo, LifecycleContext, ProcessContentActions } from '../../../../../types';
 import type { CatalogEntitiesService } from '../../../database/catalog-entities-service.js';
 import type { EntityFileSchema } from '@redocly/config';
-import type { ApiDescriptionMetadataSchema } from '@redocly/config';
 import type { BaseEntitiesExtractor } from '../base';
-import type { FileHashesService } from '../../../../../persistence/file-hashes/services/file-hashes-service.js';
-import { HashManager } from '../../../utils/hash-manager.js';
-type SpecType = Exclude<ApiDescriptionMetadataSchema['specType'], 'jsonschema' | 'avro' | 'zod' | 'protobuf'>;
-export type BaseApiEntitiesExtractorParams = {
-    actions: ProcessContentActions;
-    context: LifecycleContext;
-    catalogEntitiesService: CatalogEntitiesService;
-    fileHashesService?: FileHashesService;
-    hashesCache?: Map<string, string>;
-};
+import type { FileType } from '../../../../../persistence/file-hashes/types.js';
+import type { HashManager } from '../../../utils/hash-manager.js';
+import type { BaseApiEntitiesExtractorParams, SpecType } from '../../../types/extractors.js';
 export declare abstract class BaseApiEntitiesExtractor<BundledApiDefinition extends Pick<FileInfo, 'realRelativePath' | 'relativePath' | 'isVirtual' | 'hash'>> implements BaseEntitiesExtractor {
     #private;
     protected type: "api-description";
     protected specType: SpecType;
+    protected fileType: FileType;
     protected actions: ProcessContentActions;
     protected context: LifecycleContext;
     protected catalogEntitiesService: CatalogEntitiesService;
-    protected hashManager: HashManager;
+    protected fileHashManager: HashManager;
     protected entitySources: Record<string, string>;
     constructor(specType: SpecType, params: BaseApiEntitiesExtractorParams);
     extract(): Promise<void>;
     protected abstract loadApiDescriptions(): Promise<BundledApiDefinition[]>;
     protected abstract mapApiDescriptionToEntity(definition: BundledApiDefinition): EntityFileSchema;
-    protected abstract processApiDescription(definition: BundledApiDefinition, definitionUniqueKey: string): Promise<void>;
+    protected abstract processApiDescription(definition: BundledApiDefinition): Promise<Set<string>>;
 }
-export {};
 //# sourceMappingURL=base.d.ts.map

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

@@ -1 +1 @@
-import{FileHashStatus as h,FileType as s}from"../../../../../persistence/file-hashes/types.js";import{promiseMapLimit as r}from"../../../../../utils/async.js";import{UniqueKeyResolver as c}from"../../../../../utils/conflict-resolvers.js";import{HashManager as o}from"../../../utils/hash-manager.js";const n=3,l={openapi:s.OPENAPI_DESCRIPTION,asyncapi:s.ASYNCAPI_DESCRIPTION,arazzo:s.ARAZZO_DESCRIPTION,graphql:s.GRAPHQL_DESCRIPTION};class A{type="api-description";specType;actions;context;catalogEntitiesService;hashManager;entitySources={};#e=new c;constructor(i,t){this.specType=i,this.actions=t.actions,this.context=t.context,this.catalogEntitiesService=t.catalogEntitiesService,this.hashManager=new o({hashManagerUpdateService:t.catalogEntitiesService,fileType:l[this.specType],fileHashesService:t.fileHashesService,localHashesCache:t.hashesCache})}async extract(){const i=await this.loadApiDescriptions();let t=0;await this.hashManager.markAllHashesAsOutdated(),await r(i,n,async e=>{try{if(e.isVirtual||!e.hash)return;if(t++,process.env.FORCE_CATALOG_CACHE_REVALIDATE!=="true"&&await this.hashManager.getHash(e.hash)){await this.hashManager.setHash(e.hash,h.UP_TO_DATE);return}const a=this.mapApiDescriptionToEntity(e);a.key=this.#e.resolve(a.key),await this.processApiDescription(e,a.key),await this.catalogEntitiesService.createEntityInLocalDatabase({entity:a,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:a.type==="api-description"}),await this.hashManager.setHash(e.hash,h.UP_TO_DATE)}catch(a){this.context.logger.warn(`Error extracting entities from ${this.specType} description: ${e.realRelativePath}`),this.context.logger.warn(a)}}),await this.hashManager.clearOutdatedHashesAndRelatedRecords()}}export{A as BaseApiEntitiesExtractor};
+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};

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

@@ -1,7 +1,8 @@
 import type { GraphQLSchema } from 'graphql';
 import type { EntityFileSchema } from '@redocly/config';
 import type { FileInfo } from '../../../../../types';
-import { BaseApiEntitiesExtractor, type BaseApiEntitiesExtractorParams } from './base.js';
+import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
+import { BaseApiEntitiesExtractor } from './base.js';
 type GraphqlBundledDefinition = Omit<Pick<FileInfo, 'realRelativePath' | 'relativePath' | 'isVirtual' | 'hash'>, 'hash'> & {
     hash: string;
     schema: GraphQLSchema;
@@ -13,7 +14,7 @@ export declare class GraphqlEntitiesExtractor extends BaseApiEntitiesExtractor<G
     constructor(params: BaseApiEntitiesExtractorParams);
     loadApiDescriptions(): Promise<GraphqlBundledDefinition[]>;
     mapApiDescriptionToEntity(description: GraphqlBundledDefinition): EntityFileSchema;
-    processApiDescription(description: GraphqlBundledDefinition, descriptionUniqueKey: string): Promise<void>;
+    processApiDescription(description: GraphqlBundledDefinition): Promise<Set<string>>;
 }
 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 b,isObjectType as y,isScalarType as I,isEnumType as R,isInterfaceType as g,isUnionType as T,isInputObjectType as d,getNamedType as h,printType as O}from"graphql";import{removeLeadingSlash as $}from"@redocly/theme/core/utils";import{toKebabCase as m}from"../../../../../../utils/string/to-kebab-case.js";import{capitalize as D}from"../../../../../../utils/string/capitalize.js";import{promiseMapLimit as u,promiseMapLimitWithStatus as w}from"../../../../../utils/async.js";import{removeMarkdocTags as L}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as v}from"./base.js";import{sha1 as A}from"../../../../../utils/crypto.js";const S=15,E=15,F=new Set(["String","ID","Int","Float","Boolean","DateTime","Date","Time","URL","URI","JSON","JSONObject","BigInt","BigDecimal"]);class q extends v{#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:n,metadata:r}=a.data,s=b(n),o=A(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){const e=$(t.realRelativePath),a=t.relativePath.replace(/\.(gql|graphql)$/,""),n=this.#s(a.split("/").pop()||"GraphQL Schema"),r=m(n),s=this.#c(t.metadata?.tags);return{type:this.type,key:r,title:n,summary:t.metadata?.description||null,tags:s.concat("graphql"),metadata:{specType:this.specType,descriptionFile:e}}}async processApiDescription(t,e){const{schema:a}=t;a&&await Promise.all([this.#a(t,e),this.#f(t,e)])}#a=async(t,e)=>{const{schema:a}=t,n=a.getTypeMap(),r=this.#i(a),s=Object.entries(n).filter(([c])=>!c.startsWith("__")&&!F.has(c)&&!r.has(c));if(s.length===0)return;const o=await w(s,E,async([c,i])=>{const l=await this.#l({typeName:c,type:i,description:t,parentKey:e});await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"uses",targetKey:l,fileHash:t.hash})},this.#t);o.count.failed>0&&this.#t.warn(`Schema processing completed with ${o.count.failed} failures out of ${s.length} types for ${t.realRelativePath}`),await this.#h({description:t,descriptionUniqueKey:e,userTypes:s})};#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}-${m(t)}`;#n=t=>y(t)?"object":g(t)?"interface":T(t)?"union":R(t)?"enum":d(t)?"input":I(t)?"scalar":"unknown";#i=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};#r(t){const e=[],a=t.getQueryType();if(a){const s=a.getFields();for(const[o,c]of Object.entries(s))e.push({fieldName:o,field:c,operationType:"QUERY",rootTypeName:a.name})}const n=t.getMutationType();if(n){const s=n.getFields();for(const[o,c]of Object.entries(s))e.push({fieldName:o,field:c,operationType:"MUTATION",rootTypeName:n.name})}const r=t.getSubscriptionType();if(r){const s=r.getFields();for(const[o,c]of Object.entries(s))e.push({fieldName:o,field:c,operationType:"SUBSCRIBE",rootTypeName:r.name})}return e}#o=(t,e)=>{const a=[];if(t.args)for(const s of t.args){const o=h(s.type);o&&!o.name.startsWith("__")&&a.push(this.#e(o.name,e))}const n=[],r=h(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})=>{const r=this.#e(t,n),s=e.description??null,o=this.#n(e),c={type:"data-schema",key:r,title:t,summary:s,tags:["graphql"],metadata:{specType:this.specType,typeKind:o,sdl:this.#p(e,a.schema)}};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:a.realRelativePath,fileHash:a.hash}),c.key};#p=(t,e)=>{const a=new Set,n=[],r=new Set(["String","ID","Int","Float","Boolean"]),s=i=>{if(!i)return;const l=i.name;if(l.startsWith("__")||r.has(l)||a.has(l))return;const p=e.getType(l);p&&(a.add(l),n.push(p))};for(s(t);n.length>0;){const i=n.pop();if(y(i)){for(const p of i.getInterfaces?.()??[])s(p);const l=i.getFields();for(const p of Object.values(l)){s(h(p.type));for(const f of p.args??[])s(h(f.type))}}else if(g(i)){const l=i.getFields();for(const p of Object.values(l))s(h(p.type))}else if(T(i))for(const l of i.getTypes())s(l);else if(d(i)){const l=i.getFields();for(const p of Object.values(l))s(h(p.type))}}const o=[t.name,...[...a].filter(i=>i!==t.name)],c=[];for(const i of o){const l=e.getType(i);l&&c.push(O(l))}return c.join(`
+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(`
 
-`)};#h=async({description:t,descriptionUniqueKey:e,userTypes:a})=>{const n=a.filter(([,r])=>y(r));n.length!==0&&await u(n,E,async([r,s])=>{const c=s.getInterfaces?.()??[];if(!c.length)return;const i=this.#e(r,e);await u([...c],5,async l=>{const p=this.#e(l.name,e);try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:i,type:"implements",targetKey:p,fileHash:t.hash})}catch(f){this.#t.warn(`Failed to create 'implements' relation ${i} -> ${p}: ${f instanceof Error?f.message:"Unknown error"}`)}})})};#f=async(t,e)=>{const{schema:a}=t,n=this.#r(a);if(n.length===0)return;const s=(await w(n,S,async({fieldName:o,field:c,operationType:i,rootTypeName:l})=>{await this.#y(o,c,i,l,t,e)},this.#t)).count.failed;s>0&&this.#t.warn(`Operation extraction completed with ${s} failures out of ${n.length} operations for ${e}`)};#y=async(t,e,a,n,r,s)=>{const{inputTypes:o,returnTypes:c}=this.#o(e,s),i=await this.#m({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:o,returnTypes:c,description:r});await this.#u({apiOperationKey:i,inputTypes:o,returnTypes:c,descriptionUniqueKey:s,description:r})};#m=async({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:r,returnTypes:s,description:o})=>{const c=t,i=`${this.mapApiDescriptionToEntity(o).key}-${m(`${a.toLowerCase()}-${t}`)}`,l={type:"api-operation",key:i,title:c,summary:e.description?L(e.description):null,tags:["graphql"],metadata:{method:a,path:`${n}.${t}`,payload:r,responses:s}};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:l,sourceFile:o.realRelativePath,fileHash:o.hash}),i};#u=async({apiOperationKey:t,inputTypes:e,returnTypes:a,descriptionUniqueKey:n,description:r})=>{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:"partOf",targetKey:n,fileHash:r.hash});const s=[...new Set(e)],o=[...new Set(a)],c=[...s.map(i=>({key:i,relationType:"uses"})),...o.map(i=>({key:i,relationType:"returns"}))];await u(c,S,async({key:i,relationType:l})=>{try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:t,type:l,targetKey:i,fileHash:r.hash})}catch(p){this.#t.warn(`Failed to create relation between operation ${t} and type ${i} (${l}): ${p instanceof Error?p.message:"Unknown error"}`)}})}}export{q as GraphqlEntitiesExtractor};
+`)};#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};

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

@@ -1,11 +1,12 @@
 import type { BundledDefinition } from '../../../../openapi-docs/load-definition';
 import type { EntityFileSchema } from '@redocly/config';
-import { BaseApiEntitiesExtractor, type BaseApiEntitiesExtractorParams } from './base.js';
+import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
+import { BaseApiEntitiesExtractor } from './base.js';
 export declare class OpenApiEntitiesExtractor extends BaseApiEntitiesExtractor<BundledDefinition> {
     #private;
     constructor(params: BaseApiEntitiesExtractorParams);
     loadApiDescriptions(): Promise<BundledDefinition[]>;
     mapApiDescriptionToEntity(description: BundledDefinition): EntityFileSchema;
-    processApiDescription(description: BundledDefinition, descriptionUniqueKey: string): Promise<void>;
+    processApiDescription(description: BundledDefinition): Promise<Set<string>>;
 }
 //# 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 g}from"@redocly/theme/core/utils";import{toKebabCase as m}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as p,promiseMapLimitWithStatus as R}from"../../../../../utils/async.js";import{removeMarkdocTags as l}from"../../../../markdown/markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as E}from"./base.js";import{OpenapiSchemaResolver as y}from"../../../utils/openapi-schema-resolver.js";import{extractPartsFromComponentsRef as S}from"../../../utils/extract-parts-from-components-ref.js";import{validateEntityRelation as $}from"../../../entities/validate-entity.js";const v=["get","post","put","delete","patch"],u=15,w=15;function d(f){if(!f||typeof f!="string")return!1;const e=f.trim();return e?![/^\[.*\/.*\]/,/^\//,/\{\?/,/\?[\w=&]+/].some(t=>t.test(e)):!1}class C extends E{#e;#a=new Map;constructor(e){super("openapi",e),this.#e=e.context.logger}async loadApiDescriptions(){return this.actions.loadOpenApiDefinitions(this.context)}mapApiDescriptionToEntity(e){const n=g(e.realRelativePath),t=e.definition.info.title,s=m(t);return{type:this.type,key:s,title:t,summary:l(e.definition.info.description),tags:e.definition.tags?.filter(a=>a.name&&d(a.name)).map(a=>a.name),metadata:{specType:this.specType,descriptionFile:n}}}async processApiDescription(e,n){if(y.clearSchemaCache(),this.#a.clear(),!e?.definition?.paths)return;await this.#r(e,n);const t=this.#s(e.definition.paths);if(t.length===0)return;const a=(await R(t,u,async({operation:r,path:o,method:i})=>{await this.#i(r,o,i,e,n)},this.#e)).count.failed;a>0&&this.#e.warn(`Extraction completed with ${a} failures out of ${t.length} operations for ${n}`)}#s(e){return Object.entries(e).flatMap(([n,t])=>v.filter(s=>t[s]).map(s=>{const a=t[s];if(!a)throw new Error(`Operation not found for method ${s} on path ${n}`);return{operation:a,path:n,method:s.toUpperCase()}}))}async#r(e,n){const t=e.definition.components?.schemas;if(!t)return;const s=Object.entries(t);s.length!==0&&await p(s,w,async([a,r])=>{const o=await this.#o({schemaName:a,schema:r,description:e});await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:n,type:"uses",targetKey:o,fileHash:e.hash})})}async#o({schemaName:e,schema:n,description:t}){const s=this.#a.get(e),a=s??y.resolveSchemaRefs(n,t);s||this.#a.set(e,a);const r={type:"data-schema",key:m(e),title:e,summary:a.description??a.title??null,tags:[],metadata:{specType:this.specType,schema:JSON.stringify(a)}};return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:r,sourceFile:t.realRelativePath,fileHash:t.hash}),r.key}async#i(e,n,t,s,a){const[r,o]=await Promise.all([this.#c(e,s),this.#h(e,s)]),i=await this.#l({path:n,method:t,operation:e,requestBodySchemasKeys:r,responseSchemasKeys:o,description:s});await this.#y({apiOperationKey:i,operationRelations:e["x-catalog-relations"],descriptionUniqueKey:a,description:s})}async#c(e,n){if(!e.requestBody||!e.operationId)return[];const t=this.#m(e.requestBody,n);return t.errors.length>0&&this.#e.warn(`Schema extraction errors for operation ${e.operationId}: ${t.errors.join(", ")}`),await this.#n(t.schemaNames,e.operationId,n.hash)}async#h(e,n){if(!e.responses||!e.operationId)return[];const t=this.#f(e.responses,n);return t.errors.length>0&&this.#e.warn(`Response schema extraction errors for operation ${e.operationId}: ${t.errors.join(", ")}`),await this.#n(t.schemaNames,e.operationId,n.hash)}#m(e,n){const t=[],s=[];try{if(e&&"content"in e&&e.content)for(const a of Object.values(e.content)){if(!a.schema?.$ref)continue;const r=this.#t(a.schema.$ref);r?.componentType==="schemas"&&r.componentName&&t.push(r.componentName)}if(e&&e.$ref){const a=this.#t(e.$ref);if(a?.componentType==="requestBodies"&&a.componentName){const r=n.definition.components?.requestBodies?.[a.componentName];if(r&&"content"in r)for(const o of Object.values(r.content??{})){if(!o.schema?.$ref)continue;const i=this.#t(o.schema.$ref);i?.componentType==="schemas"&&i.componentName&&t.push(i.componentName)}}}}catch(a){s.push(`Failed to extract request body schemas: ${a instanceof Error?a.message:"Unknown error"}`)}return{schemaNames:[...new Set(t)],errors:s}}#f(e,n){const t=[],s=[];try{for(const a of Object.values(e)){if(a&&"content"in a&&a.content)for(const r of Object.values(a.content)){if(!r.schema?.$ref)continue;const o=this.#t(r.schema.$ref);o?.componentType==="schemas"&&o.componentName&&t.push(o.componentName)}if(a&&a.$ref){const r=this.#t(a.$ref);if(r?.componentType==="responses"&&r.componentName){const o=n.definition.components?.responses?.[r.componentName];if(o&&"content"in o)for(const i of Object.values(o.content??{})){if(!i.schema?.$ref)continue;const c=this.#t(i.schema.$ref);c?.componentType==="schemas"&&c.componentName&&t.push(c.componentName)}}}}}catch(a){s.push(`Failed to extract response schemas: ${a instanceof Error?a.message:"Unknown error"}`)}return{schemaNames:[...new Set(t)],errors:s}}#t(e){try{return S(e)}catch{return{componentType:"",componentName:null}}}async#n(e,n,t){return e.length===0?[]:await p(e,w,async s=>await this.#p({operationId:n,schemaName:s,descriptionHash:t}))}async#p({operationId:e,schemaName:n,descriptionHash:t}){const s=m(n);try{return await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:m(e),type:"uses",targetKey:s,fileHash:t}),s}catch(a){throw this.#e.error(`Failed to create relation between operation ${e} and schema ${n}: ${a instanceof Error?a.message:"Unknown error"}`),a}}async#l({path:e,method:n,operation:t,requestBodySchemasKeys:s,responseSchemasKeys:a,description:r}){const o=`${t.operationId}`,i=m(o),c={type:"api-operation",key:i,title:o,summary:l(t.summary),tags:t.tags?.filter(h=>d(h)),metadata:{path:e,method:n,payload:s,responses:a}};try{return await this.catalogEntitiesService.createEntityInLocalDatabase({entity:c,sourceFile:r.realRelativePath,fileHash:r.hash}),i}catch(h){throw this.#e.error(`Failed to create API operation entity for ${o}: ${h instanceof Error?h.message:"Unknown error"}`),h}}async#y({apiOperationKey:e,operationRelations:n,descriptionUniqueKey:t,description:s}){try{await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:"partOf",targetKey:t,fileHash:s.hash}),await this.#u(e,n)}catch(a){this.#e.error(`Failed to create API operation relations for ${e}: ${a instanceof Error?a.message:"Unknown error"}`)}}async#u(e,n){n?.length&&await p(n,u,async t=>{try{$(t),await this.catalogEntitiesService.createEntityRelationInLocalDatabase({sourceKey:e,type:t.type,targetKey:t.key})}catch(s){this.context.logger.warn(`Error creating entity relation for operation ${e} based on custom property: ${s instanceof Error?s.message:"Unknown error"}`)}})}}export{C as OpenApiEntitiesExtractor};
+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};

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

@@ -1,28 +1,16 @@
-import type { EntitiesCatalogConfig } from '@redocly/config';
+import type { HashManager } from '../../utils/hash-manager.js';
 import type { LifecycleContext } from '../../../../types/plugins/common';
-import type { BaseEntitiesExtractor } from './base.js';
 import type { CatalogEntitiesService } from '../../database/catalog-entities-service.js';
-import type { FileHashesService } from '../../../../persistence/file-hashes/services/file-hashes-service.js';
-type FsEntitiesExtractorParams = {
-    context: LifecycleContext;
-    catalogEntitiesService: CatalogEntitiesService;
-    fileHashesService?: FileHashesService;
-    isDevMode: boolean;
-    isFirstPluginRun: boolean;
-    catalogConfig: EntitiesCatalogConfig;
-};
-export type FsChange = {
-    event: 'add' | 'change' | 'unlink';
-    path: string;
-} | {
-    event: 'code-updated';
-};
-export declare class FsEntitiesExtractor implements BaseEntitiesExtractor {
+import type { EntitiesCatalogConfig } from '@redocly/config';
+export declare class FsEntitiesExtractor {
     #private;
-    protected context: LifecycleContext;
-    protected catalogEntitiesService: CatalogEntitiesService;
-    constructor(params: FsEntitiesExtractorParams);
-    extract(): Promise<void>;
+    constructor({ fileHashManager, context, catalogEntitiesService, catalogConfig, shouldCalculateEntities, }: {
+        fileHashManager: HashManager;
+        context: LifecycleContext;
+        catalogEntitiesService: CatalogEntitiesService;
+        catalogConfig: EntitiesCatalogConfig;
+        shouldCalculateEntities: boolean;
+    });
+    extract(path?: string): Promise<void>;
 }
-export {};
 //# sourceMappingURL=fs-entities-extractor.d.ts.map

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

@@ -1 +1 @@
-import{ENTITY_SCHEMA_EXCLUDED_FOLDERS as c,CATALOG_ENTITIES_FILES_REGEX as n}from"../../../../constants/plugins/catalog-entities.js";import{parseAndValidateEntity as h}from"../../entities/validate-entity.js";import{promiseMapLimit as l}from"../../../../utils/async.js";import{extractEntitiesContent as o}from"../../entities/extract-entities-content.js";import{sha1 as r}from"../../../../utils/crypto.js";import{HashManager as f}from"../../utils/hash-manager.js";import{FileHashStatus as E,FileType as g}from"../../../../persistence/file-hashes/types.js";import{fsChangesStore as d}from"../../../../fs/utils/async-storage.js";const m=15;class x{context;catalogEntitiesService;#t;#e;#i;#a;constructor(t){this.context=t.context,this.catalogEntitiesService=t.catalogEntitiesService,this.#t=new f({hashManagerUpdateService:t.catalogEntitiesService,fileType:g.ENTITY_DEFINITION,fileHashesService:t.fileHashesService}),this.#e=t.isDevMode,this.#i=t.isFirstPluginRun,this.#a=t.catalogConfig}async extract(){if(this.#e&&!this.#i){const e=d?.getStore()??[];await this.#r(e);return}const t=await this.context.fs.scan(n);await this.#t.markAllHashesAsOutdated(),await l(t,m,async({relativePath:e})=>{if(c.some(s=>e.includes(s)))return;const i=await o(e,this.context);if(!i)return;const a=r(JSON.stringify(i));if(await this.#t.getHash(a)){await this.#t.setHash(a,E.UP_TO_DATE);return}await this.#s(i,a,e)}),await this.#t.clearOutdatedHashesAndRelatedRecords()}#n=async t=>{await this.catalogEntitiesService.deleteEntitiesAndRelationsByFilePathInLocalDatabase(t)};#o=async t=>{if(!t.match(n))return;await this.catalogEntitiesService.deleteEntitiesAndRelationsByFilePathInLocalDatabase(t);const e=await o(t,this.context);if(!e)return;const i=r(JSON.stringify(e));await this.#s(e,i,t)};#r=async t=>{for(const e of t)switch(e.event){case"add":case"change":await this.#o(e.path);break;case"unlink":await this.#n(e.path);break}};#s=async(t,e,i)=>{for(const a of t.entities)try{const s=h(a,this.#a);await this.catalogEntitiesService.createEntityInLocalDatabase({entity:s,sourceFile:i,fileHash:e})}catch(s){this.context.logger.warn(`Error extracting entity from ${i}. ${s.message}.`)}}}export{x as FsEntitiesExtractor};
+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};

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

@@ -1 +1 @@
-import{CatalogEntitiesService as h}from"./database/catalog-entities-service.js";import{createPaginationParamsValidator as b}from"../../providers/database/pagination/schemas";import{parseSearch as E}from"../../providers/database/pagination/search";import{OPERATORS as F}from"../../providers/database/pagination/constants.js";import{CacheService as v}from"../../persistence/cache/services/cache-service.js";import{sha1 as A}from"../../utils/crypto.js";import{CATALOG_FILTERS_CACHE_NAMESPACE as w,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:n={}})=>{const l=await h.getInstance({baseDbDir:a}),c=M.concat("domains","owners"),o=b(c).parse(n),d=t.excludes?.map(s=>s.key)??[],p=e.filter(s=>s!=="all"),r=V(p,d);return o.filter?o.filter={op:F.AND,conditions:[o.filter,r]}:o.filter=r,await l.getEntitiesWithRelations({sort:[{field:"type",order:"ASC"}],limit:10,...o})},R=async(e,a,t)=>{const n=await h.getInstance({baseDbDir:a}),l=await n.getEntityWithRelationsByKey(e);if(!l)return null;const c=l.type==="data-schema"?await n.getRelatedEntities(e,{limit:1,filter:{field:"type",operator:"equal",value:"api-description"}}).then(p=>p.items?.[0]??null):null,o=T[l.type]??void 0,d=await n.getRelatedEntities(e,{limit:10,sort:[{field:"title",order:"ASC"}],filter:o,search:t?.search?E(t?.search,["key","type","title","summary"]):void 0});return{status:"success",entity:l,relatedEntity:c,relations:d}},_=e=>{const a=JSON.stringify({entitiesTypes:e.entitiesTypes.sort(),filtersConfig:e.filtersConfig});return A(a)},P=async({serverOutDir:e,entitiesTypes:a,filtersConfig:t})=>{if(!t||t.length===0)return{};const n=_({entitiesTypes:a,filtersConfig:t}),l=await v.getInstance({baseDbDir:e}),c=await l.get({key:n,namespace:w});if(c)return c;const o=await h.getInstance({baseDbDir:e}),d=[],p=new Map;for(const s of t)!s.options||s.options.length===0?d.push(s.property):p.set(s.property,s.options);const r=await o.getCatalogFilters({entitiesTypes:a,emptyFilters:d}),u={};for(const s of t){const g=p.get(s.property);if(!g){const i=r[s.property];u[s.property]=i&&i.length>0?i:[];continue}const m=(await o.getCatalogFilters({entitiesTypes:a,emptyFilters:[s.property]}))[s.property];if(!m){u[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})}u[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 l.set({key:n,value:u,namespace:w,ttlInSeconds:I}),u},L=async(e,{props:a},t,{serverOutDir:n,getRouteSharedDataByFsPath:l})=>{const c=a?.catalogConfig||{};if(!e.params||!a?.catalogConfig)return{status:"notFound"};const[o,d,p]=e.params;if(!o)return{status:"notFound"};const r=N(c,o),u=r?.includes?.map(f=>f.type)??[];if(!r)return{status:"notFound"};if(!p&&d!=="entities"){if(r.hide)return{status:"notFound"};const f=await P({entitiesTypes:u,serverOutDir:n,filtersConfig:r.filters}),i=e.queries?.viewMode??"table";return{status:"success",catalogSwitcherItems:O(c,r),entitiesTypes:u,entities:await D({entitiesTypes:u,serverOutDir:n,catalogConfig:r,queries:e.queries}),catalogConfig:r,filters:f,initialViewMode:i}}const s=await R(p,n,e.queries),g=s?.entity.sourceFile,C=s?.entity.type==="api-description",m=g&&C&&l(g)||{};return s?{status:"success",entity:s.entity,relatedEntity:s.relatedEntity,relations:s.relations,entitiesCatalogConfig:c,catalogConfig:r,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,n)=>t.slug.localeCompare(n.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 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};

package/dist/server/plugins/catalog-entities/plugin.js

@@ -1 +1 @@
-import{telemetryTraceStep as S}from"../../../cli/telemetry/helpers/trace-step.js";import{CATALOG_BASE_SLUG as o,CATALOG_FILTERS_CACHE_NAMESPACE as T,ENTITIES_MAP_GLOBAL_DATA_KEY as v}from"../../constants/plugins/catalog-entities.js";import{CacheService as _}from"../../persistence/cache/services/cache-service.js";import{FileHashesService as D}from"../../persistence/file-hashes/services/file-hashes-service.js";import{getTemplatePath as g}from"./utils/get-template-path.js";import{CatalogEntitiesService as w}from"./database/catalog-entities-service.js";import{ArazzoEntitiesExtractor as y}from"./extensions/extractors/api-description/arazzo-entities-extractor.js";import{AsyncApiEntitiesExtractor as O}from"./extensions/extractors/api-description/asyncapi-entities-extractor.js";import{GraphqlEntitiesExtractor as L}from"./extensions/extractors/api-description/graphql-entities-extractor.js";import{OpenApiEntitiesExtractor as P}from"./extensions/extractors/api-description/openapi-entities-extractor.js";import{FsEntitiesExtractor as I}from"./extensions/extractors/fs-entities-extractor.js";import{getCompleteCatalogConfig as b}from"./get-complete-catalog-config.js";const G="catalog-entity-template",N="catalog-entity",R=new Map,x=new Map,M=new Map,H=new Map;let c=!0;async function z(){return{id:"CatalogEntities",requiredEntitlements:["catalog"],async processContent(e,t){await S("build.plugin.catalog_entities",async m=>{if(process.env.NEW_CATALOG_ENABLED!=="true")return;const u=await t.getConfig(),i=b(u.entitiesCatalog);if(m?.setAttribute("config",JSON.stringify(i)),!i.show)return;const{logger:n}=t,r=process.env.NODE_ENV==="development"||process.env.REDOCLY_LOCAL_DEV==="true",a=await w.getInstance({baseDbDir:e.serverOutDir,removeExisting:c&&r,runOnlyLocalDatabase:!0,runWithPragmaWalWriteOptimization:!0}),s=r?void 0:await D.getInstance({baseDbDir:e.serverOutDir}),E=[new I({context:t,catalogEntitiesService:a,fileHashesService:s,isDevMode:r,isFirstPluginRun:c,catalogConfig:i}),new P({actions:e,context:t,catalogEntitiesService:a,fileHashesService:s,hashesCache:r?R:void 0}),new O({actions:e,context:t,catalogEntitiesService:a,fileHashesService:s,hashesCache:r?x:void 0}),new L({actions:e,context:t,catalogEntitiesService:a,fileHashesService:s,hashesCache:r?M:void 0}),new y({actions:e,context:t,catalogEntitiesService:a,fileHashesService:s,hashesCache:r?H:void 0})];n.info("Starting entities extractors...");const f=n.startTiming();await a.transaction(async()=>{await Promise.all(E.map(async p=>p.extract()))});const h=a.getEntitySources();e.setGlobalData({[v]:h}),await(await _.getInstance({baseDbDir:e.serverOutDir})).deleteByNamespace(T),n.infoTime(f,"Entities extractors finished");const d=e.registerServerPropsGetter(N,g("../get-server-props.js")),C=e.createTemplate(G,g("../template/index.js"));e.addRoute({duplicateInAllLocales:!0,slug:o,fsPath:"",templateId:C,excludeFromSidebar:!0,hasClientRoutes:!0,serverPropsGetterIds:[d],getNavText:()=>Promise.resolve("Catalog"),getStaticData:async()=>({props:{catalogConfig:i}})});const[l]=Object.entries(i.catalogs??{}).find(([p,A])=>!A?.hide)||[];l&&e.addRedirect(o,{type:302,to:`${o}/${l}`}),n.info("Catalog Entities plugin finished"),c=!1})}}}var X=z;export{z as catalogEntitiesPlugin,X as default};
+import{FileType as c}from"../../persistence/file-hashes/types.js";import{telemetryTraceStep as _}from"../../../cli/telemetry/helpers/trace-step.js";import{catalogDataCollector as P}from"./utils/catalog-data-collector.js";import{CATALOG_BASE_SLUG as p,CATALOG_FILTERS_CACHE_NAMESPACE as I,ENTITIES_MAP_GLOBAL_DATA_KEY as v}from"../../constants/plugins/catalog-entities.js";import{CacheService as h}from"../../persistence/cache/services/cache-service.js";import{getTemplatePath as E}from"./utils/get-template-path.js";import{getCompleteCatalogConfig as N}from"./get-complete-catalog-config.js";import{AsyncApiEntitiesExtractor as b}from"./extensions/extractors/api-description/asyncapi-entities-extractor.js";import{GraphqlEntitiesExtractor as L}from"./extensions/extractors/api-description/graphql-entities-extractor.js";import{FileHashesService as w}from"../../persistence/file-hashes/services/file-hashes-service.js";import{CatalogEntitiesService as R}from"./database/catalog-entities-service.js";import{ArazzoEntitiesExtractor as G}from"./extensions/extractors/api-description/arazzo-entities-extractor.js";import{FsEntitiesExtractor as x}from"./extensions/extractors/fs-entities-extractor.js";import{HashManager as F}from"./utils/hash-manager.js";import{OpenApiEntitiesExtractor as B}from"./extensions/extractors/api-description/openapi-entities-extractor.js";const H="catalog-entity-template",M="catalog-entity";let u=!0;async function Y(){return{id:"CatalogEntities",requiredEntitlements:["catalog"],async processContent(t,i){await _("build.plugin.catalog_entities",async r=>{if(process.env.NEW_CATALOG_ENABLED!=="true")return;const f=await i.getConfig(),s=N(f.entitiesCatalog);if(r?.setAttribute("config",JSON.stringify(s)),!s.show)return;const{logger:l}=i,A=process.env.NODE_ENV==="development"||process.env.REDOCLY_LOCAL_DEV==="true",a=u&&A,e=await R.getInstance({baseDbDir:t.serverOutDir,removeExisting:a,runOnlyLocalDatabase:!0,runWithPragmaWalWriteOptimization:!0}),C=await w.getInstance({baseDbDir:t.serverOutDir}),o=new F(C),T=[new x({fileHashManager:o,context:i,catalogEntitiesService:e,catalogConfig:s,shouldCalculateEntities:a}),new B({actions:t,context:i,catalogEntitiesService:e,fileHashManager:o,fileType:c.OPENAPI_DESCRIPTION,shouldCalculateEntities:a}),new b({actions:t,context:i,catalogEntitiesService:e,fileHashManager:o,fileType:c.ASYNCAPI_DESCRIPTION,shouldCalculateEntities:a}),new L({actions:t,context:i,catalogEntitiesService:e,fileHashManager:o,fileType:c.GRAPHQL_DESCRIPTION,shouldCalculateEntities:a}),new G({actions:t,context:i,catalogEntitiesService:e,fileHashManager:o,fileType:c.ARAZZO_DESCRIPTION,shouldCalculateEntities:a})];l.info("Starting entities extractors...");const y=l.startTiming();await e.transaction(async()=>{await Promise.all(T.map(async m=>m.extract()))});const d=e.getEntitySources();t.setGlobalData({[v]:d}),await(await h.getInstance({baseDbDir:t.serverOutDir})).deleteByNamespace(I),l.infoTime(y,"Entities extractors finished");const S=t.registerServerPropsGetter(M,E("../get-server-props.js")),D=t.createTemplate(H,E("../template/index.js"));t.addRoute({duplicateInAllLocales:!0,slug:p,fsPath:"",templateId:D,excludeFromSidebar:!0,hasClientRoutes:!0,serverPropsGetterIds:[S],getNavText:()=>Promise.resolve("Catalog"),getStaticData:async()=>({props:{catalogConfig:s}})});const[g]=Object.entries(s.catalogs??{}).find(([m,O])=>!O?.hide)||[];g&&t.addRedirect(p,{type:302,to:`${p}/${g}`});const n=await P.getCatalogEntitiesData(e);r?.setAttribute("totalEntities",n.totalEntitiesCount),r?.setAttribute("entitiesCountByType",JSON.stringify(n.countOfEntitiesByType)),r?.setAttribute("totalFilesSkippedByHash",n.totalFilesSkippedByHash),r?.setAttribute("totalProcessedFiles",n.totalProcessedFiles),r?.setAttribute("extractors",n.extractors),l.info("Catalog Entities plugin finished"),u=!1})}}}var rt=Y;export{Y as catalogEntitiesPlugin,rt as default};

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

@@ -17,6 +17,12 @@ export declare const entityRelationDatabaseSchema: {
         readonly source_id: {
             readonly type: readonly ["string", "null"];
         };
+        readonly source_version: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly source_revision: {
+            readonly type: readonly ["string", "null"];
+        };
         readonly source_to_target_relation: {
             readonly type: "string";
         };
@@ -26,20 +32,29 @@ export declare const entityRelationDatabaseSchema: {
         readonly target_id: {
             readonly type: readonly ["string", "null"];
         };
+        readonly target_version: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly target_revision: {
+            readonly type: readonly ["string", "null"];
+        };
         readonly target_to_source_relation: {
             readonly type: "string";
         };
+        readonly source_file: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly file_hash: {
+            readonly type: readonly ["string", "null"];
+        };
         readonly created_at: {
             readonly type: "string";
         };
         readonly updated_at: {
             readonly type: "string";
         };
-        readonly schema_version: {
-            readonly type: "number";
-        };
     };
-    readonly required: readonly ["id", "organization_id", "project_id", "source_key", "source_to_target_relation", "target_key", "target_to_source_relation", "created_at", "updated_at", "schema_version"];
+    readonly required: readonly ["id", "organization_id", "project_id", "source_key", "source_to_target_relation", "target_key", "target_to_source_relation", "created_at", "updated_at"];
     readonly additionalProperties: false;
 };
 export declare const entityDatabaseSchema: {
@@ -96,11 +111,23 @@ export declare const entityDatabaseSchema: {
         readonly file_hash: {
             readonly type: readonly ["string", "null"];
         };
-        readonly schema_version: {
-            readonly type: "number";
+        readonly version: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly revision: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly hash: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly is_current: {
+            readonly type: readonly ["boolean", "null"];
+        };
+        readonly is_default_version: {
+            readonly type: readonly ["boolean", "null"];
         };
     };
-    readonly required: readonly ["id", "organization_id", "project_id", "key", "type", "title", "created_at", "updated_at", "source", "schema_version"];
+    readonly required: readonly ["id", "organization_id", "project_id", "key", "type", "title", "created_at", "updated_at", "source"];
     readonly additionalProperties: false;
 };
 export declare const relatedEntityDatabaseSchema: {
@@ -143,6 +170,9 @@ export declare const relatedEntityDatabaseSchema: {
         readonly metadata: {
             readonly type: readonly ["string", "null"];
         };
+        readonly version: {
+            readonly type: readonly ["string", "null"];
+        };
     };
     readonly required: readonly ["id", "key", "title", "type", "source"];
     readonly additionalProperties: false;

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_to_target_relation:{type:"string"},target_key:{type:"string"},target_id:{type:["string","null"]},target_to_source_relation:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},schema_version:{type:"number"}},required:["id","organization_id","project_id","source_key","source_to_target_relation","target_key","target_to_source_relation","created_at","updated_at","schema_version"],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"]},schema_version:{type:"number"}},required:["id","organization_id","project_id","key","type","title","created_at","updated_at","source","schema_version"],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"]}},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 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};

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

@@ -20,9 +20,21 @@ export declare const entityRelationDtoSchema: {
         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"];
+        };
+        readonly targetRevision: {
+            readonly type: readonly ["string", "null"];
+        };
         readonly sourceFile: {
             readonly type: readonly ["string", "null"];
         };
@@ -55,9 +67,21 @@ export declare const entitiesRelationsDtoSchema: {
             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"];
+            };
+            readonly targetRevision: {
+                readonly type: readonly ["string", "null"];
+            };
             readonly sourceFile: {
                 readonly type: readonly ["string", "null"];
             };

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"]},targetId:{type:["string","null"]},sourceFile:{type:["string","null"]},fileHash:{type:["string","null"]}},required:["type","sourceKey","targetKey"],additionalProperties:!1},n={type:"array",items:t};export{n 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},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};

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

@@ -24,6 +24,18 @@ export declare const entityRelationReadModelSchema: {
         readonly targetId: {
             readonly type: "string";
         };
+        readonly sourceVersion: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly sourceRevision: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly targetVersion: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly targetRevision: {
+            readonly type: readonly ["string", "null"];
+        };
         readonly type: {
             readonly type: "string";
         };
@@ -86,6 +98,21 @@ export declare const entityReadModelSchema: {
         readonly sourceFile: {
             readonly type: readonly ["string", "null"];
         };
+        readonly version: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly revision: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly hash: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly isCurrent: {
+            readonly type: readonly ["boolean", "null"];
+        };
+        readonly isDefaultVersion: {
+            readonly type: readonly ["boolean", "null"];
+        };
         readonly createdAt: {
             readonly type: readonly ["string", "null"];
         };
@@ -145,6 +172,11 @@ export type EntityReadModelSchema = {
     id: string;
     source: string;
     sourceFile?: string | null;
+    version?: string | null;
+    revision?: string | null;
+    hash?: string | null;
+    isCurrent?: boolean | null;
+    isDefaultVersion?: boolean | null;
     createdAt?: string | null;
     updatedAt?: string | null;
     object: 'catalogEntity';