@redocly/redoc-reef 0.138.0-next.13 → 0.138.0-next.14

package/dist/server/plugins/catalog-entities/database/repositories/utils/semantic-version-sort.js

@@ -1,34 +0,0 @@
-import{sql as o}from"drizzle-orm";const $="not_specified_version";function h(e){return o.raw(`
-    CASE
-      ${s(e)}
-      ${S(e)}
-      ${a(e)}
-      ${E(e)}
-    END
-  `)}function s(e){return`WHEN ${e} = '${$}' THEN '!not_specified'`}function S(e){return`WHEN ${e} IS NULL OR ${e} = '' THEN '0000000000.0000000000.0000000000'`}function a(e){return`WHEN ${e} GLOB '*[^0-9.]*' THEN 'ZZZZZZZZZZ.' || ${e}`}function E(e){return`ELSE ${c(e)}`}function c(e){const r=u(e),i=N(e),t=T(e);return`PRINTF('%010d.%010d.%010d', ${r}, ${i}, ${t})`}function u(e){const r=`${e} || '.0.0'`;return`CAST(COALESCE(NULLIF(SUBSTR(${r}, 1, INSTR(${r}, '.') - 1), ''), '0') AS INTEGER)`}function N(e){const r=`${e} || '.0.0'`,i=`SUBSTR(${r}, INSTR(${r}, '.') + 1) || '.0'`;return`CAST(COALESCE(NULLIF(SUBSTR(${i}, 1, INSTR(${i}, '.') - 1), ''), '0') AS INTEGER)`}function T(e){const r=`${e} || '.0.0'`,i=`SUBSTR(${r}, INSTR(${r}, '.') + 1) || '.0'`,t=`SUBSTR(${i}, INSTR(${i}, '.') + 1) || '.0'`;return`CAST(COALESCE(NULLIF(SUBSTR(${t}, 1, INSTR(${t}, '.') - 1), ''), '0') AS INTEGER)`}function d(e){return`
-    CASE
-      ${s(e)}
-      ${S(e)}
-      ${a(e)}
-      ${E(e)}
-    END
-  `}function l(e,r,i){const t=d("higher_version.version"),n=d(r);return o.raw(`
-    NOT EXISTS (
-      SELECT 1 FROM (
-        -- Combine all current, non-deleted entities from both databases
-        SELECT key, version, revision FROM remote.entities WHERE is_current = 1 AND is_deleted = 0
-        UNION ALL
-        SELECT key, version, revision FROM entities WHERE is_current = 1 AND is_deleted = 0
-      ) higher_version
-      WHERE higher_version.key = ${e}
-        AND (
-          -- Case 1: Another entity has a strictly higher version
-          (${t}) > (${n})
-          OR (
-            -- Case 2: Same version, but another entity has a higher revision
-            (${t}) = (${n})
-            AND higher_version.revision > ${i}
-          )
-        )
-    )
-  `)}export{l as buildNoHigherVersionExistsFilter,h as buildSemanticVersionSortExpr};

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

@@ -1,135 +0,0 @@
-export declare const createEntityFieldsForSelect: (tableAlias?: string, idAlias?: string) => {
-    id: import("drizzle-orm").SQL.Aliased<unknown> | import("drizzle-orm").SQL<unknown>;
-    organizationId: import("drizzle-orm").SQL<unknown>;
-    projectId: import("drizzle-orm").SQL<unknown>;
-    key: import("drizzle-orm").SQL<unknown>;
-    type: import("drizzle-orm").SQL<unknown>;
-    title: import("drizzle-orm").SQL<unknown>;
-    summary: import("drizzle-orm").SQL<unknown>;
-    tags: import("drizzle-orm").SQL<unknown>;
-    metadata: import("drizzle-orm").SQL<unknown>;
-    git: import("drizzle-orm").SQL<unknown>;
-    contact: import("drizzle-orm").SQL<unknown>;
-    links: import("drizzle-orm").SQL<unknown>;
-    createdAt: import("drizzle-orm").SQL<unknown>;
-    updatedAt: import("drizzle-orm").SQL<unknown>;
-    source: import("drizzle-orm").SQL<unknown>;
-    sourceFile: import("drizzle-orm").SQL<unknown>;
-    fileHash: import("drizzle-orm").SQL<unknown>;
-    version: import("drizzle-orm").SQL<unknown>;
-    revision: import("drizzle-orm").SQL<unknown>;
-    hash: import("drizzle-orm").SQL<unknown>;
-    isCurrent: import("drizzle-orm").SQL<unknown>;
-    isDefaultVersion: import("drizzle-orm").SQL<unknown>;
-    isDeleted: import("drizzle-orm").SQL<unknown>;
-    scorecardsStatus: import("drizzle-orm").SQL<unknown>;
-};
-export declare const createEntityRelationFieldsForSelect: (tableAlias?: string, idAlias?: string) => {
-    id: import("drizzle-orm").SQL.Aliased<unknown> | import("drizzle-orm").SQL<unknown>;
-    organizationId: import("drizzle-orm").SQL<unknown>;
-    projectId: import("drizzle-orm").SQL<unknown>;
-    sourceKey: import("drizzle-orm").SQL<unknown>;
-    sourceVersion: import("drizzle-orm").SQL<unknown>;
-    sourceRevision: import("drizzle-orm").SQL<unknown>;
-    sourceToTargetRelation: import("drizzle-orm").SQL<unknown>;
-    targetKey: import("drizzle-orm").SQL<unknown>;
-    targetVersion: import("drizzle-orm").SQL<unknown>;
-    targetRevision: import("drizzle-orm").SQL<unknown>;
-    targetToSourceRelation: import("drizzle-orm").SQL<unknown>;
-    fileHash: import("drizzle-orm").SQL<unknown>;
-    createdAt: import("drizzle-orm").SQL<unknown>;
-    updatedAt: import("drizzle-orm").SQL<unknown>;
-};
-export declare const createQualifiedEntityFieldsForSelect: (tableAlias?: string) => {
-    id: import("drizzle-orm").SQL<unknown>;
-    organizationId: import("drizzle-orm").SQL<unknown>;
-    projectId: import("drizzle-orm").SQL<unknown>;
-    key: import("drizzle-orm").SQL<unknown>;
-    type: import("drizzle-orm").SQL<unknown>;
-    title: import("drizzle-orm").SQL<unknown>;
-    summary: import("drizzle-orm").SQL<unknown>;
-    tags: import("drizzle-orm").SQL<unknown>;
-    metadata: import("drizzle-orm").SQL<unknown>;
-    git: import("drizzle-orm").SQL<unknown>;
-    contact: import("drizzle-orm").SQL<unknown>;
-    links: import("drizzle-orm").SQL<unknown>;
-    createdAt: import("drizzle-orm").SQL<unknown>;
-    updatedAt: import("drizzle-orm").SQL<unknown>;
-    source: import("drizzle-orm").SQL<unknown>;
-    sourceFile: import("drizzle-orm").SQL<unknown>;
-    fileHash: import("drizzle-orm").SQL<unknown>;
-    version: import("drizzle-orm").SQL<unknown>;
-    revision: import("drizzle-orm").SQL<unknown>;
-    hash: import("drizzle-orm").SQL<unknown>;
-    isCurrent: import("drizzle-orm").SQL<unknown>;
-    isDefaultVersion: import("drizzle-orm").SQL<unknown>;
-    isDeleted: import("drizzle-orm").SQL<unknown>;
-};
-export declare const createQualifiedEntityFieldsForSelectWithAliases: (tableAlias?: string) => {
-    id: import("drizzle-orm").SQL.Aliased<unknown>;
-    organizationId: import("drizzle-orm").SQL.Aliased<unknown>;
-    projectId: import("drizzle-orm").SQL.Aliased<unknown>;
-    key: import("drizzle-orm").SQL.Aliased<unknown>;
-    type: import("drizzle-orm").SQL.Aliased<unknown>;
-    title: import("drizzle-orm").SQL.Aliased<unknown>;
-    summary: import("drizzle-orm").SQL.Aliased<unknown>;
-    tags: import("drizzle-orm").SQL.Aliased<unknown>;
-    metadata: import("drizzle-orm").SQL.Aliased<unknown>;
-    git: import("drizzle-orm").SQL.Aliased<unknown>;
-    contact: import("drizzle-orm").SQL.Aliased<unknown>;
-    links: import("drizzle-orm").SQL.Aliased<unknown>;
-    createdAt: import("drizzle-orm").SQL.Aliased<unknown>;
-    updatedAt: import("drizzle-orm").SQL.Aliased<unknown>;
-    source: import("drizzle-orm").SQL.Aliased<unknown>;
-    sourceFile: import("drizzle-orm").SQL.Aliased<unknown>;
-    fileHash: import("drizzle-orm").SQL.Aliased<unknown>;
-    version: import("drizzle-orm").SQL.Aliased<unknown>;
-    revision: import("drizzle-orm").SQL.Aliased<unknown>;
-    hash: import("drizzle-orm").SQL.Aliased<unknown>;
-    isCurrent: import("drizzle-orm").SQL.Aliased<unknown>;
-    isDefaultVersion: import("drizzle-orm").SQL.Aliased<unknown>;
-    isDeleted: import("drizzle-orm").SQL.Aliased<unknown>;
-};
-export declare const FIELDS_TO_SELECT_FOR_ENTITY: {
-    id: import("drizzle-orm").SQL.Aliased<unknown> | import("drizzle-orm").SQL<unknown>;
-    organizationId: import("drizzle-orm").SQL<unknown>;
-    projectId: import("drizzle-orm").SQL<unknown>;
-    key: import("drizzle-orm").SQL<unknown>;
-    type: import("drizzle-orm").SQL<unknown>;
-    title: import("drizzle-orm").SQL<unknown>;
-    summary: import("drizzle-orm").SQL<unknown>;
-    tags: import("drizzle-orm").SQL<unknown>;
-    metadata: import("drizzle-orm").SQL<unknown>;
-    git: import("drizzle-orm").SQL<unknown>;
-    contact: import("drizzle-orm").SQL<unknown>;
-    links: import("drizzle-orm").SQL<unknown>;
-    createdAt: import("drizzle-orm").SQL<unknown>;
-    updatedAt: import("drizzle-orm").SQL<unknown>;
-    source: import("drizzle-orm").SQL<unknown>;
-    sourceFile: import("drizzle-orm").SQL<unknown>;
-    fileHash: import("drizzle-orm").SQL<unknown>;
-    version: import("drizzle-orm").SQL<unknown>;
-    revision: import("drizzle-orm").SQL<unknown>;
-    hash: import("drizzle-orm").SQL<unknown>;
-    isCurrent: import("drizzle-orm").SQL<unknown>;
-    isDefaultVersion: import("drizzle-orm").SQL<unknown>;
-    isDeleted: import("drizzle-orm").SQL<unknown>;
-    scorecardsStatus: import("drizzle-orm").SQL<unknown>;
-};
-export declare const FIELDS_TO_SELECT_FOR_ENTITY_RELATION: {
-    id: import("drizzle-orm").SQL.Aliased<unknown> | import("drizzle-orm").SQL<unknown>;
-    organizationId: import("drizzle-orm").SQL<unknown>;
-    projectId: import("drizzle-orm").SQL<unknown>;
-    sourceKey: import("drizzle-orm").SQL<unknown>;
-    sourceVersion: import("drizzle-orm").SQL<unknown>;
-    sourceRevision: import("drizzle-orm").SQL<unknown>;
-    sourceToTargetRelation: import("drizzle-orm").SQL<unknown>;
-    targetKey: import("drizzle-orm").SQL<unknown>;
-    targetVersion: import("drizzle-orm").SQL<unknown>;
-    targetRevision: import("drizzle-orm").SQL<unknown>;
-    targetToSourceRelation: import("drizzle-orm").SQL<unknown>;
-    fileHash: import("drizzle-orm").SQL<unknown>;
-    createdAt: import("drizzle-orm").SQL<unknown>;
-    updatedAt: import("drizzle-orm").SQL<unknown>;
-};
-//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/catalog-entities/database/repositories/utils.js

@@ -1 +0,0 @@
-import{sql as a}from"drizzle-orm";const i=(t="",r)=>{const e=t?`${t}.`:"";return{id:r?a.raw(e+"id").as(r):a.raw(e+"id"),organizationId:a.raw(e+"organization_id"),projectId:a.raw(e+"project_id"),key:a.raw(e+"key"),type:a.raw(e+"type"),title:a.raw(e+"title"),summary:a.raw(e+"summary"),tags:a.raw(e+"tags"),metadata:a.raw(e+"metadata"),git:a.raw(e+"git"),contact:a.raw(e+"contact"),links:a.raw(e+"links"),createdAt:a.raw(e+"created_at"),updatedAt:a.raw(e+"updated_at"),source:a.raw(e+"source"),sourceFile:a.raw(e+"source_file"),fileHash:a.raw(e+"file_hash"),version:a.raw(e+"version"),revision:a.raw(e+"revision"),hash:a.raw(e+"hash"),isCurrent:a.raw(e+"is_current"),isDefaultVersion:a.raw(e+"is_default_version"),isDeleted:a.raw(e+"is_deleted"),scorecardsStatus:a.raw(e+"scorecards_status")}},s=(t="",r)=>{const e=t?`${t}.`:"";return{id:r?a.raw(e+"id").as(r):a.raw(e+"id"),organizationId:a.raw(e+"organization_id"),projectId:a.raw(e+"project_id"),sourceKey:a.raw(e+"source_key"),sourceVersion:a.raw(e+"source_version"),sourceRevision:a.raw(e+"source_revision"),sourceToTargetRelation:a.raw(e+"source_to_target_relation"),targetKey:a.raw(e+"target_key"),targetVersion:a.raw(e+"target_version"),targetRevision:a.raw(e+"target_revision"),targetToSourceRelation:a.raw(e+"target_to_source_relation"),fileHash:a.raw(e+"file_hash"),createdAt:a.raw(e+"created_at"),updatedAt:a.raw(e+"updated_at")}},n=(t="")=>{const r=t?`${t}.`:"";return{id:a.raw(r+"entity_id"),organizationId:a.raw(r+"organization_id"),projectId:a.raw(r+"project_id"),key:a.raw(r+"key"),type:a.raw(r+"type"),title:a.raw(r+"title"),summary:a.raw(r+"summary"),tags:a.raw(r+"tags"),metadata:a.raw(r+"metadata"),git:a.raw(r+"git"),contact:a.raw(r+"contact"),links:a.raw(r+"links"),createdAt:a.raw(r+"created_at"),updatedAt:a.raw(r+"updated_at"),source:a.raw(r+"source"),sourceFile:a.raw(r+"source_file"),fileHash:a.raw(r+"file_hash"),version:a.raw(r+"version"),revision:a.raw(r+"revision"),hash:a.raw(r+"hash"),isCurrent:a.raw(r+"is_current"),isDefaultVersion:a.raw(r+"is_default_version"),isDeleted:a.raw(r+"is_deleted")}},w=(t="")=>{const r=t?`${t}.`:"";return{id:a.raw(r+"entity_id").as("id"),organizationId:a.raw(r+"organization_id").as("organization_id"),projectId:a.raw(r+"project_id").as("project_id"),key:a.raw(r+"key").as("key"),type:a.raw(r+"type").as("type"),title:a.raw(r+"title").as("title"),summary:a.raw(r+"summary").as("summary"),tags:a.raw(r+"tags").as("tags"),metadata:a.raw(r+"metadata").as("metadata"),git:a.raw(r+"git").as("git"),contact:a.raw(r+"contact").as("contact"),links:a.raw(r+"links").as("links"),createdAt:a.raw(r+"created_at").as("created_at"),updatedAt:a.raw(r+"updated_at").as("updated_at"),source:a.raw(r+"source").as("source"),sourceFile:a.raw(r+"source_file").as("source_file"),fileHash:a.raw(r+"file_hash").as("file_hash"),version:a.raw(r+"version").as("version"),revision:a.raw(r+"revision").as("revision"),hash:a.raw(r+"hash").as("hash"),isCurrent:a.raw(r+"is_current").as("is_current"),isDefaultVersion:a.raw(r+"is_default_version").as("is_default_version"),isDeleted:a.raw(r+"is_deleted").as("is_deleted")}},d=i(),c=s();export{d as FIELDS_TO_SELECT_FOR_ENTITY,c as FIELDS_TO_SELECT_FOR_ENTITY_RELATION,i as createEntityFieldsForSelect,s as createEntityRelationFieldsForSelect,n as createQualifiedEntityFieldsForSelect,w as createQualifiedEntityFieldsForSelectWithAliases};

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

@@ -1,27 +0,0 @@
-import type { DatabaseConnectionFactory } from '../../../providers/database/database-connection-factory';
-export type PublishCatalogEntitiesParams = {
-    baseDbDir: string;
-    chunkSize?: number;
-    changedSourceFiles?: string[];
-    removedSourceFiles?: string[];
-};
-export type PublishCatalogEntitiesRunResult = {
-    runId: string;
-    published: boolean;
-    shouldFinalizeFileHashes: boolean;
-};
-export type PublishRowsResult = {
-    upserted: number;
-    skipped: number;
-};
-export type DatabaseConnection = NonNullable<Awaited<ReturnType<typeof DatabaseConnectionFactory.create>>>;
-export type SourceFilesFilter = string[] | 'none';
-export type BulkSyncResult<T> = Array<{
-    status: 'ok';
-    resource: T | null;
-} | {
-    key: string;
-    status: 'error';
-    error: string;
-}>;
-//# sourceMappingURL=types.d.ts.map

package/dist/server/plugins/catalog-entities/entities/extract-file-content.d.ts

@@ -1,4 +0,0 @@
-import type { LifecycleContext } from '../../../types';
-import type { EntitiesFileSchema } from './types.js';
-export declare const extractFileContent: (filePath: string, context: LifecycleContext) => Promise<EntitiesFileSchema | null>;
-//# sourceMappingURL=extract-file-content.d.ts.map

package/dist/server/plugins/catalog-entities/entities/extract-file-content.js

@@ -1 +0,0 @@
-import{parseYaml as s}from"@redocly/openapi-core";import{logger as i}from"../../../tools/notifiers/logger.js";const l=async(t,n)=>{try{const r=await n.fs.read(t);if(!r)return null;const e=s(r),o=Array.isArray(e)?e:[e];return{path:t,entities:o}}catch(r){return i.error(`Error reading file ${t}:`,r),null}};export{l as extractFileContent};

package/dist/server/plugins/catalog-entities/entities/types.d.ts

@@ -1,6 +0,0 @@
-export type EntitiesFileSchema = {
-    path: string;
-    entities: unknown[];
-};
-export type ScorecardsStatus = 'UP_TO_DATE' | 'CANCELLED' | 'OUTDATED' | 'CALCULATING';
-//# sourceMappingURL=types.d.ts.map

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

@@ -1,15 +0,0 @@
-import type { BundledDefinition } from '../../../../arazzo-docs/arazzo-doc-loader.js';
-import type { EntityFileSchema } from '@redocly/config';
-import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
-import { BaseApiEntitiesExtractor } from './base.js';
-type Params = BaseApiEntitiesExtractorParams;
-export declare class ArazzoEntitiesExtractor extends BaseApiEntitiesExtractor<BundledDefinition> {
-    #private;
-    constructor(params: Params);
-    mapApiDescriptionToEntity(description: BundledDefinition, version: string): EntityFileSchema;
-    loadApiDescriptions(): Promise<BundledDefinition[]>;
-    processApiDescription(description: BundledDefinition, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
-    resolveSourceDescriptionUrl(url: string, baseRelativePath: string): string | null;
-}
-export {};
-//# sourceMappingURL=arazzo-entities-extractor.d.ts.map

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

@@ -1 +0,0 @@
-import u from"node:path";import{removeLeadingSlash as w}from"@redocly/theme/core/utils";import{toKebabCase as f}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as g}from"../../../../../utils/async/promise-map-limit.js";import{removeMarkdocTags as v}from"../../../../../../markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as E}from"./base.js";const d=15;class K extends E{constructor(t){super("arazzo",t)}mapApiDescriptionToEntity(t,o){const r=w(t.realRelativePath),c=t.document.info.title,e=this.resolveEntityKey({realRelativePath:t.realRelativePath,customKey:t.document["x-redocly-catalog-key"]});return{type:this.type,key:e,title:c,summary:t.document.info.description?v(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))throw new Error("Arazzo description has no source descriptions");const e=this.getRbacTeamsForDefinition(t.relativePath),i=this.mapApiDescriptionToEntity(t,r);await this.catalogEntitiesService.createEntity({entity:{...i},revision:o,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0,rbacTeams:e,source:"file"}),c.delete(`${i.key}:${r}`),await this.#e(t,i.key,i.version,r,o,c,e);const l=t.document.sourceDescriptions||[];await g(l,d,async a=>{if(!(a.type!=="openapi"||!a.url))try{const n=this.resolveSourceDescriptionUrl(a.url,t.realRelativePath);if(!n){!a.url.startsWith("http://")&&!a.url.startsWith("https://")&&this.context.logger.warn(`Could not resolve URL to local path: ${a.url}`);return}const s=((await this.context.cache.load(n,"api-doc")).data??[]).filter(m=>m.type==="openapi");if(s.length===0){this.context.logger.warn(`No OpenAPI definition found at path: ${n}`);return}const p=s[0],y=this.resolveEntityKey({realRelativePath:p.realRelativePath,customKey:p.document["x-redocly-catalog-key"]});await this.catalogEntitiesService.createEntityRelation({sourceKey:i.key,type:"relatesTo",targetKey:y,sourceFile:t.realRelativePath,fileHash:t.hash}),await this.#r(t,a.name,p,i.key,y,i.version,o)}catch(n){this.context.logger.warn(`Failed to create relation to OpenAPI source "${a.url}": ${n instanceof Error?n.message:"Unknown error"}`)}})}#t=t=>!!t?.document?.sourceDescriptions&&t.document.sourceDescriptions.length>0;#e=async(t,o,r,c,e,i,l)=>{try{const a=t.document.components?.inputs,n=a?Object.entries(a):[],h=[];for(const[s,p]of n)h.push(async()=>{const y=`${o}-${f(s)}`,m=await this.#a({schemaName:s,schema:p,description:t,parentKey:o,parentVersion:r,parentRevision:e,rbacTeams:l});i.delete(`${y}:${c}`),m&&await this.catalogEntitiesService.createEntityRelation({sourceKey:o,type:"uses",targetKey:m.key,sourceFile:t.realRelativePath,fileHash:t.hash,sourceVersion:r,targetVersion:r,sourceRevision:e,targetRevision:e})});if(h.length===0)return;await g(h,d,s=>s())}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:i,rbacTeams:l})=>{const a={type:"data-schema",key:`${c}-${f(t)}`,title:t,summary:o.description||o.title||null,tags:["arazzo"],metadata:{specType:this.specType,descriptionFile:r.realRelativePath,schema:"{}"},version:e};try{return await this.catalogEntitiesService.createEntity({entity:a,sourceFile:r.realRelativePath,fileHash:r.hash,rbacTeams:l,source:"file",revision:i})}catch(n){return this.context.logger.warn(`Failed to create data schema entity for ${t}: ${n instanceof Error?n.message:"Unknown error"}`),null}};#r=async(t,o,r,c,e,i,l)=>{const a=t.document.workflows||[];if(a.length===0)return;const n=new Set;for(const h of a)for(const s of h.steps||[]){if(!s.operationId)continue;const p=s.operationId.startsWith(`${o}.`)?s.operationId.substring(`${o}.`.length):s.operationId;p&&n.add(p)}n.size!==0&&await g(Array.from(n),d,async h=>{try{const s=`${e}-${f(h)}`;await this.catalogEntitiesService.createEntityRelation({sourceKey:c,type:"uses",targetKey:s,sourceFile:t.realRelativePath,fileHash:t.hash,sourceVersion:i,targetVersion:i,sourceRevision:l,targetRevision:l})}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 w(u.posix.normalize(e));const i=u.posix.dirname(o);return e.startsWith(i+"/")?u.posix.normalize(e):u.posix.normalize(u.posix.join(i,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

@@ -1,22 +0,0 @@
-import type { AsyncApiDefinitionReferenced } from '@redocly/api-docs';
-import type { BundledApiDefinition } from '../../../../api-docs/loader.js';
-import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
-import type { EntityDtoSchema } from '../../../schemas/dto-schemas';
-import { BaseApiEntitiesExtractor } from './base.js';
-type Params = BaseApiEntitiesExtractorParams;
-type AsyncApiCatalogBundle = Omit<BundledApiDefinition, 'document' | 'isVirtual'> & {
-    type: 'asyncapi';
-    document: AsyncApiDefinitionReferenced & {
-        'x-redocly-catalog-key'?: string;
-    };
-    isVirtual: boolean;
-};
-export declare class AsyncApiEntitiesExtractor extends BaseApiEntitiesExtractor<AsyncApiCatalogBundle> {
-    #private;
-    constructor(params: Params);
-    loadApiDescriptions(): Promise<AsyncApiCatalogBundle[]>;
-    mapApiDescriptionToEntity(description: AsyncApiCatalogBundle, version: string): EntityDtoSchema;
-    processApiDescription(description: AsyncApiCatalogBundle, 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 +0,0 @@
-import{removeLeadingSlash as d}from"@redocly/theme/core/utils";import{toKebabCase as f}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as p}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as $}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as E}from"../../../../../../markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as w}from"./base.js";import{extractPartsFromComponentsRef as y}from"../../../utils/extract-parts-from-components-ref.js";import{extractPartsFromChannelsMessageRef as S}from"../../../utils/extract-parts-from-channels-message-ref.js";const u=15;class T extends w{constructor(e){super("asyncapi",e)}async loadApiDescriptions(){return(await this.actions.loadApiDocuments(this.context)).filter(t=>t.type==="asyncapi").map(t=>({...t,isVirtual:t.isVirtual??!1}))}mapApiDescriptionToEntity(e,t){const a=d(e.realRelativePath),r=e.document.info.title,s=this.resolveEntityKey({realRelativePath:e.realRelativePath,customKey:e.document["x-redocly-catalog-key"]});return{type:this.type,key:s,title:r,summary:E(typeof e.document.info.description=="string"?e.document.info.description:void 0),tags:e.document.info.tags?.map(n=>n.name),metadata:{specType:this.specType,descriptionFile:a},version:t}}async processApiDescription(e,t,a,r){const s=this.getRbacTeamsForDefinition(e.relativePath),n=this.mapApiDescriptionToEntity(e,a);await this.catalogEntitiesService.createEntity({entity:n,sourceFile:e.realRelativePath,fileHash:e.hash,isRootEntity:!0,rbacTeams:s,source:"file"}),r.delete(`${n.key}:${a}`);const o=this.#a(e),[i,c]=await Promise.allSettled([this.#s(e,n.key,n.version,a,t,r,s),this.#n(o,e,n.key,n.version,a,t,r,s)]);i.status!=="fulfilled"&&this.context.logger.error("Schema processing failed:",i.reason),c.status!=="fulfilled"&&this.context.logger.error("Operation processing failed:",c.reason)}#a=e=>{const t=e.document.operations;return t?Object.entries(t).map(([a,r])=>({operationName:a,operation:r})):[]};#s=async(e,t,a,r,s,n,o)=>{const i=e.document.components?.schemas;if(!i)return;const c=Object.entries(i);if(c.length===0)return;const l=await $(c,u,async([h,m])=>{const R=`${t}-${f(h)}`,g=await this.#r({schemaName:h,schema:m,description:e,parentKey:t,parentVersion:a,parentRevision:s,rbacTeams:o});n.delete(`${R}:${r}`),g&&await this.catalogEntitiesService.createEntityRelation({sourceKey:t,type:"uses",targetKey:g.key,sourceFile:e.realRelativePath,fileHash:e.hash,sourceVersion:a,targetVersion:a,sourceRevision:s,targetRevision:s})},this.context.logger);l.count.failed>0&&this.context.logger.warn(`Schema processing completed with ${l.count.failed} failures out of ${c.length} schemas for ${e.realRelativePath}`)};#r=async({schemaName:e,schema:t,description:a,parentKey:r,parentVersion:s,parentRevision:n,rbacTeams:o})=>{const i=`${r}-${f(e)}`,c="title"in t?t.title??t.description:null,l=JSON.stringify(t),h={type:"data-schema",key:i,title:e,summary:c,tags:[],metadata:{specType:this.specType,schema:l},version:s};try{return await this.catalogEntitiesService.createEntity({entity:h,sourceFile:a.realRelativePath,fileHash:a.hash,rbacTeams:o,source:"file",revision:n})}catch(m){return this.context.logger.warn(`Failed to create data schema entity for ${e}: ${m instanceof Error?m.message:"Unknown error"}`),null}};#n=async(e,t,a,r,s,n,o,i)=>{if(!e.length)return;const c=await $(e,u,async({operationName:l,operation:h})=>{const m=await this.#o(h,l,t,a,r,n,i);o.delete(`${m}:${s}`)},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 ${t.realRelativePath}`)};#o=async(e,t,a,r,s,n,o)=>{const i=`${r}-${f(t)}`,c=await this.#i(e.messages??[],a,r),l=await this.#c(t,e,c,a,r,s,n,o);return l&&await this.#l({apiOperationKey:l.key,operation:e,descriptionUniqueKey:r,description:a,descriptionVersion:s,parentRevision:n}),i};#i=async(e,t,a)=>{if(!e||e.length===0)return[];const r=new Set;for(const s of e){let n=null;if("$ref"in s){const o=s.$ref.startsWith("#/channels/")?this.#e(s.$ref,t):s.$ref;if(o){const i=y(o);if(i?.componentName&&i.componentType==="messages"){const c=t.document.components?.messages[i.componentName];c?.payload&&"$ref"in c.payload&&c.payload.$ref&&(n=c.payload.$ref)}}}else s.payload&&"$ref"in s.payload&&s.payload.$ref&&(n=s.payload.$ref);if(n){const o=y(n);o?.componentName&&o.componentType==="schemas"&&r.add(`${a}-${f(o.componentName)}`)}}return Array.from(r)};#c=async(e,t,a,r,s,n,o,i)=>{const c={type:"api-operation",key:`${s}-${f(e)}`,title:t.title||e,summary:t.summary??"",tags:t.tags?.map(l=>l.name)??[],metadata:{method:t.action==="send"?"PUBLISH":"SUBSCRIBE",path:t.channel.address??"",payload:t.action==="receive"?a:[],responses:t.action==="send"?a:[]},version:n};try{return await this.catalogEntitiesService.createEntity({entity:c,sourceFile:r.realRelativePath,fileHash:r.hash,rbacTeams:i,source:"file",revision:o})}catch(l){return this.context.logger.warn(`Failed to create API operation entity for ${e}: ${l instanceof Error?l.message:"Unknown error"}`),null}};#l=async({apiOperationKey:e,operation:t,descriptionUniqueKey:a,description:r,descriptionVersion:s,parentRevision:n})=>(await this.catalogEntitiesService.createEntityRelation({sourceKey:e,type:"partOf",targetKey:a,sourceFile:r.realRelativePath,fileHash:r.hash,sourceVersion:s,targetVersion:s,sourceRevision:n,targetRevision:n}),await this.#h(t,e,r,s,n),!Array.isArray(t.messages)||!t.messages?.length?[]:await this.#m(t.messages,e,r,a,s,n));#h=async(e,t,a,r,s)=>{e["x-catalogRelations"]?.length&&await p(e["x-catalogRelations"],u,async n=>{try{this.validateEntityRelationFileSchema(n),await this.catalogEntitiesService.createEntityRelation({sourceKey:t,type:n.type,targetKey:n.key,sourceFile:a.realRelativePath,fileHash:a.hash,sourceVersion:r,targetVersion:"",sourceRevision:s,targetRevision:""})}catch(o){this.context.logger.warn(`Error creating entity relation for operation ${t} based on custom property: ${o instanceof Error?o.message:"Unknown error"}`)}})};#m=async(e,t,a,r,s,n)=>e.length===0?[]:(await p(e,u,async i=>await this.#f(i,t,a,r,s,n)??"")).filter(i=>!!i);#f=async(e,t,a,r,s,n)=>"$ref"in e?this.#y(e,t,a,r,s,n):e.payload?this.#u(e,t,a,r,s,n):null;#y=async(e,t,a,r,s,n)=>{const o=e.$ref.startsWith("#/channels/")?this.#e(e.$ref,a):e.$ref;if(!o)return null;const i=y(o);if(!i||!i.componentName||i.componentType!=="messages")return null;const c=a.document.components?.messages[i.componentName];return!c?.payload||!("$ref"in c.payload)||!c.payload.$ref?null:this.#t(c.payload.$ref,t,a,r,s,n)};#e=(e,t)=>{const a=S(e);if(!a||!a.channelName||!a.messageName)return null;const r=t.document.channels?.[a.channelName];if(!r?.messages)return null;const s=r.messages[a.messageName];return!s||!("$ref"in s)||typeof s.$ref!="string"||!s.$ref.startsWith("#/components/messages/")?null:s.$ref};#u=async(e,t,a,r,s,n)=>!e.payload||!("$ref"in e.payload)||!e.payload.$ref?null:this.#t(e.payload.$ref,t,a,r,s,n);#t=async(e,t,a,r,s,n)=>{const o=y(e);if(!o||!o.componentName||o.componentType!=="schemas")return null;const i=`${r}-${f(o.componentName)}`;return await this.catalogEntitiesService.createEntityRelation({sourceKey:t,type:"uses",targetKey:i,sourceFile:a.realRelativePath,fileHash:a.hash,sourceVersion:s,targetVersion:s,sourceRevision:n,targetRevision:n}),i}}export{T as AsyncApiEntitiesExtractor};

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

@@ -1,41 +0,0 @@
-import type { AfterRoutesCreatedActions, FileInfo, LifecycleContext } from '../../../../../types';
-import type { CatalogEntitiesService } from '../../../database/catalog-entities-service.js';
-import type { BaseEntitiesExtractor } from '../base';
-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';
-import type { EntityDtoSchema } from '../../../schemas/dto-schemas.js';
-export declare abstract class BaseApiEntitiesExtractor<BundledApiDefinition extends Pick<FileInfo, 'realRelativePath' | 'relativePath' | 'isVirtual' | 'hash'> & {
-    definition?: unknown;
-}> implements BaseEntitiesExtractor {
-    #private;
-    protected type: 'api-description';
-    protected specType: SpecType;
-    protected fileType: FileType;
-    protected actions: AfterRoutesCreatedActions;
-    protected context: LifecycleContext;
-    protected catalogEntitiesService: CatalogEntitiesService;
-    protected fileHashManager: HashManager;
-    protected entitySources: Record<string, string>;
-    constructor(specType: SpecType, params: BaseApiEntitiesExtractorParams);
-    protected getDescriptionHash(description: BundledApiDefinition): string | undefined;
-    extract(): Promise<void>;
-    protected validateEntityRelationFileSchema(relation: unknown): void;
-    protected getRbacTeamsForDefinition(relativePath: string): string[];
-    /**
-     * Resolves the entity key for an API description.
-     * Uses x-redocly-catalog-key if present and non-empty, otherwise derives a key from the file path.
-     * @param realRelativePath - The real relative path of the description file
-     * @param customKey - Optional custom key from x-redocly-catalog-key
-     * @param extensionPattern - Optional regex to strip file extension (default: any extension)
-     */
-    protected resolveEntityKey({ realRelativePath, customKey, extensionPattern, }: {
-        realRelativePath: string;
-        customKey?: string | null;
-        extensionPattern?: RegExp;
-    }): string;
-    protected abstract loadApiDescriptions(): Promise<BundledApiDefinition[]>;
-    protected abstract mapApiDescriptionToEntity(definition: BundledApiDefinition, version: string, revision?: string): EntityDtoSchema;
-    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 +0,0 @@
-import{entityRelationFileSchema as P}from"@redocly/config";import{removeLeadingSlash as _}from"@redocly/theme/core/utils";import{sha1 as S}from"../../../../../utils/crypto/sha1.js";import{toKebabCase as R}from"../../../../../../utils/string/to-kebab-case.js";import{FileHashStatus as g}from"../../../../../persistence/file-hashes/types.js";import{promiseMapLimit as w}from"../../../../../utils/async/promise-map-limit.js";import{OPERATORS as A}from"../../../../../providers/database/pagination/constants.js";import{VERSION_NOT_SPECIFIED as T}from"@redocly/theme/core/constants";import{getRbacTeamsListForResource as D}from"../../../../../utils/rbac.js";import{envConfig as u}from"../../../../../config/env-config.js";import{resolveEntityVersion as F}from"../../../utils/resolve-entity-version.js";import{catalogDataCollector as p}from"../../../utils/catalog-data-collector.js";import{createValidator as H}from"../../../utils/ajv-validator.js";const O=15,C=200,k=500;class Y{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}getDescriptionHash(t){return t.definition===void 0?t.hash:S(JSON.stringify(t.definition))}async extract(){const t=await this.loadApiDescriptions(),e=await this.fileHashManager.getStatusSnapshot(this.fileType);await this.fileHashManager.markAllAsOutdated(this.fileType),t.length&&p.addExtractor(this.specType);const a=this.#s(t),i={skipped:0,fileHashMissing:0,fileHashMismatch:0,shouldCalculateFlag:0,forceRevalidateFlag:0,previouslyUnconfirmed:0},r=[],o=new Set;await w(Array.from(a.values()),O,async c=>{for(const{description:s,version:l}of c)try{const n=this.getDescriptionHash(s);if(!n)continue;o.add(s.realRelativePath);const h=await this.fileHashManager.getByPath(s.realRelativePath),m=h?.hash!==n,v=e.get(s.realRelativePath),y=v!==void 0&&v!==g.UP_TO_DATE,f=this.#i({fileHashChanged:m,hasExistingHashRecord:!!h,previouslyUnconfirmed:y});if(!(f!==null)){i.skipped++,p.increaseSkippedFilesCount(),await this.fileHashManager.upsert(this.fileType,s.realRelativePath,n,g.UP_TO_DATE);continue}f&&i[f]++,f==="fileHashMismatch"&&h&&r.length<3&&r.push({path:s.realRelativePath,stored:h.hash,incoming:n});const d=await this.catalogEntitiesService.getEntityKeysAndVersionsBySourceFile(s.realRelativePath);await this.#a(d);const E=new Date().toISOString();await this.processApiDescription(s,E,l,d),(m||y||u.FORCE_CATALOG_CACHE_REVALIDATE)&&p.markSourceFileAsChanged(s.realRelativePath),await this.#o(d,s.realRelativePath,E,n),p.increaseProcessedFilesCount(),await this.fileHashManager.upsert(this.fileType,s.realRelativePath,n,g.OUTDATED),p.markFileHashPendingConfirmation({fileType:this.fileType,filePath:s.realRelativePath,hash:n})}catch(n){this.context.logger.warn(`Error extracting entities from ${this.specType} description: ${s.realRelativePath}`),this.context.logger.warn(n)}}),await this.#r(o)}#i({fileHashChanged:t,hasExistingHashRecord:e,previouslyUnconfirmed:a}){return t?e?"fileHashMismatch":"fileHashMissing":a?"previouslyUnconfirmed":this.#e?"shouldCalculateFlag":u.FORCE_CATALOG_CACHE_REVALIDATE?"forceRevalidateFlag":null}#a=async t=>{u.FORCE_CATALOG_CACHE_REVALIDATE&&(await this.catalogEntitiesService.deleteEntities({field:"key",operator:"in",value:Array.from(t).map(e=>e.split(":")[0])}),t.clear())};#t=async t=>{let e=0,a=0;for(;;){const i=await this.catalogEntitiesService.getEntities({paginationParams:{limit:k,filter:t}});if(!i||i.items.length===0)break;await this.catalogEntitiesService.deleteEntities({field:"id",operator:"in",value:i.items.map(({id:r})=>r)}),e+=i.items.length,a+=1}return{total:e,pages:a}};#s(t){const e=new Map;for(const a of t)if(!(a.isVirtual||!a.hash))try{const i=this.#n(a),r=this.mapApiDescriptionToEntity(a,i),o=e.get(r.key)??[];o.push({description:a,version:i}),e.set(r.key,o)}catch(i){this.context.logger.warn(`Error resolving entity key for ${this.specType} description (skipping): ${a.realRelativePath}`),this.context.logger.warn(i)}return e}#r=async t=>{const e=await this.fileHashManager.getAllOutdated(this.fileType);if(!e||e.length===0)return;const a=e.filter(({filePath:l})=>!t.has(l));if(a.length===0)return;a.forEach(({filePath:l})=>{p.markSourceFileAsRemoved(l)});const i=a.map(({filePath:l})=>l),{total:r,pages:o}=await this.#t({op:"AND",conditions:[{field:"source_file",operator:"in",value:i},{field:"is_current",operator:"equal",value:!0}]}),{total:c,pages:s}=await this.#t({field:"source_file",operator:"in",value:i});this.context.logger.info(`[${this.specType}] removed-files cleanup: files=${i.length} currentRevisionsDeleted=${r} currentPages=${o} orphanRevisionsDeleted=${c} orphanPages=${s} removedFiles=${i.slice(0,3).join(", ")}${i.length>3?`, +${i.length-3} more`:""}`)};#o=async(t,e,a,i)=>{if(t.size===0||u.FORCE_CATALOG_CACHE_REVALIDATE)return;const r=Array.from(t).map(o=>{const[c,s]=o.split(":");return{key:c,version:s}});for(let o=0;o<r.length;o+=C){const c=r.slice(o,o+C),s=Array.from(new Set(c.map(({key:n})=>n))),l=c.map(({key:n,version:h})=>({op:A.AND,conditions:[{field:"key",operator:"equal",value:n},{field:"version",operator:"equal",value:h}]}));await this.catalogEntitiesService.softDeleteEntitiesWithRelations({revision:a,fileHash:i,filter:{op:"AND",conditions:[{field:"key",operator:"in",value:s},{op:A.OR,conditions:l},{field:"source",operator:"equal",value:"file"},{field:"source_file",operator:"equal",value:e},{field:"is_current",operator:"equal",value:!0}]}})}};#n(t){const e=t.document?.info?.version??null,a=F(e,t.realRelativePath);return a.success?a.version??T:T}validateEntityRelationFileSchema(t){H(P,{errorPrefix:"Entity relation validation failed:",dataVar:"relation"})(t)}getRbacTeamsForDefinition(t){const e=this.actions.getConfig().access?.rbac,a=this.actions.getRouteByFsPath(t);return D(a||{fsPath:t},e||{})}resolveEntityKey({realRelativePath:t,customKey:e,extensionPattern:a}){const i=this.#l(t,a);return typeof e=="string"&&e.trim()?R(e.trim()):i}#l(t,e){let i=_(t);for(;/^@[^/]+\//.test(i);)i=i.replace(/^@[^/]+\//,"");i=i.replace(/\/@[^/]+/g,"");const r=e?i.replace(e,""):i.replace(/\.[^.]+$/,"");return R(r.replace(/[\\/]/g,"-"))}}export{Y as BaseApiEntitiesExtractor};

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

@@ -1,21 +0,0 @@
-import type { DocumentNode, GraphQLSchema } from 'graphql';
-import type { BundledApiDefinition } from '../../../../api-docs/loader.js';
-import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
-import type { EntityDtoSchema } from '../../../schemas/dto-schemas.js';
-import { BaseApiEntitiesExtractor } from './base.js';
-type GraphqlBundledDefinition = Omit<BundledApiDefinition, 'document' | 'isVirtual'> & {
-    type: 'graphql';
-    document: DocumentNode;
-    schema: GraphQLSchema;
-    metadata?: Record<string, unknown>;
-    isVirtual: boolean;
-};
-export declare class GraphqlEntitiesExtractor extends BaseApiEntitiesExtractor<GraphqlBundledDefinition> {
-    #private;
-    constructor(params: BaseApiEntitiesExtractorParams);
-    loadApiDescriptions(): Promise<GraphqlBundledDefinition[]>;
-    mapApiDescriptionToEntity(description: GraphqlBundledDefinition, version: string): EntityDtoSchema;
-    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 +0,0 @@
-import{buildASTSchema as v,isObjectType as T,isScalarType as I,isEnumType as P,isInterfaceType as S,isUnionType as E,isInputObjectType as $,getNamedType as u,printType as A}from"graphql";import{removeLeadingSlash as F}from"@redocly/theme/core/utils";import{toKebabCase as d}from"../../../../../../utils/string/to-kebab-case.js";import{capitalize as k}from"../../../../../../utils/string/capitalize.js";import{promiseMapLimit as w}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as R}from"../../../../../utils/async/promise-map-limit-with-status.js";import{removeMarkdocTags as C}from"../../../../../../markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as j}from"./base.js";import{getApiConfigByPath as D}from"../../../../get-api-config.js";const O=15,b=15,L=new Set(["String","ID","Int","Float","Boolean","DateTime","Date","Time","URL","URI","JSON","JSONObject","BigInt","BigDecimal"]);class U extends j{#t;constructor(t){super("graphql",t),this.#t=t.context.logger}async loadApiDescriptions(){const t=await this.actions.loadApiDocuments(this.context),e=await this.context.getConfig(),a=[];for(const n of t)if(n.type==="graphql")try{const r=n.document,s=v(r),i=D(e.apis,n.relativePath);a.push({...n,document:r,schema:s,metadata:i?.metadata,isVirtual:n.isVirtual??!1})}catch(r){this.#t.warn(`Failed to load GraphQL schema from ${n.relativePath}: ${r instanceof Error?r.message:"Unknown error"}`)}return a}mapApiDescriptionToEntity(t,e){const a=F(t.realRelativePath),n=t.relativePath.replace(/\.(gql|graphql)$/,""),r=this.#s(n.split("/").pop()||"GraphQL Schema"),s=this.#c(t.metadata?.tags),i=t.metadata?.["x-redocly-catalog-key"],h=this.resolveEntityKey({realRelativePath:t.realRelativePath,customKey:typeof i=="string"?i:void 0,extensionPattern:/\.(gql|graphql)$/});return{type:this.type,key:h,title:r,summary:t.metadata?.description||null,tags:s.concat("graphql"),metadata:{specType:this.specType,descriptionFile:a},version:e}}async processApiDescription(t,e,a,n){const{schema:r}=t;if(!r)throw new Error("GraphQL definition is missing a parsed schema");const s=this.getRbacTeamsForDefinition(t.relativePath),i=this.mapApiDescriptionToEntity(t,a);await this.catalogEntitiesService.createEntity({entity:i,sourceFile:t.realRelativePath,fileHash:t.hash,isRootEntity:!0,rbacTeams:s,source:"file",revision:e}),n.delete(`${i.key}:${a}`),await Promise.all([this.#a(t,i.key,i.version,a,e,n,s),this.#f(t,i.key,i.version,a,e,n,s)])}#a=async(t,e,a,n,r,s,i)=>{const{schema:h}=t,c=h.getTypeMap(),l=this.#i(h),o=Object.entries(c).filter(([f])=>!f.startsWith("__")&&!L.has(f)&&!l.has(f));if(o.length===0)return;const p=await R(o,b,async([f,m])=>{const y=this.#e(f,e),g=await this.#l({typeName:f,type:m,description:t,parentKey:e,parentVersion:a,parentRevision:r,rbacTeams:i});s.delete(`${y}:${n}`),g&&await this.catalogEntitiesService.createEntityRelation({sourceKey:e,type:"uses",targetKey:g.key,sourceFile:t.realRelativePath,fileHash:t.hash,sourceVersion:a,targetVersion:a,sourceRevision:r,targetRevision:r})},this.#t);p.count.failed>0&&this.#t.warn(`Schema processing completed with ${p.count.failed} failures out of ${o.length} types for ${t.realRelativePath}`),await this.#p({description:t,descriptionUniqueKey:e,userTypes:o,parentRevision:r})};#s=t=>{const e=t.replace(/[^A-Za-z0-9]+/g," ").trim();return e?e.split(" ").map(a=>a&&k(a)).join(" "):"GraphQL Schema"};#e=(t,e)=>`${e}-${d(t)}`;#r=t=>T(t)?"object":S(t)?"interface":E(t)?"union":P(t)?"enum":$(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};#n(t){const e=[],a=t.getQueryType();if(a){const s=a.getFields();for(const[i,h]of Object.entries(s))e.push({fieldName:i,field:h,operationType:"QUERY",rootTypeName:a.name})}const n=t.getMutationType();if(n){const s=n.getFields();for(const[i,h]of Object.entries(s))e.push({fieldName:i,field:h,operationType:"MUTATION",rootTypeName:n.name})}const r=t.getSubscriptionType();if(r){const s=r.getFields();for(const[i,h]of Object.entries(s))e.push({fieldName:i,field:h,operationType:"SUBSCRIBE",rootTypeName:r.name})}return e}#o=(t,e)=>{const a=[];if(t.args)for(const s of t.args){const i=u(s.type);i&&!i.name.startsWith("__")&&a.push(this.#e(i.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,rbacTeams:i})=>{const h=this.#e(t,n),c=e.description??null,l=this.#r(e),o={type:"data-schema",key:h,title:t,summary:c,tags:["graphql"],metadata:{specType:this.specType,typeKind:l,sdl:this.#h(e,a.schema)},version:r};try{return await this.catalogEntitiesService.createEntity({entity:o,sourceFile:a.realRelativePath,fileHash:a.hash,rbacTeams:i,source:"file",revision:s})}catch(p){return this.#t.warn(`Failed to create data schema entity for ${t}: ${p instanceof Error?p.message:"Unknown error"}`),null}};#h=(t,e)=>{const a=new Set,n=[],r=new Set(["String","ID","Int","Float","Boolean"]),s=c=>{if(!c)return;const l=c.name;if(l.startsWith("__")||r.has(l)||a.has(l))return;const o=e.getType(l);o&&(a.add(l),n.push(o))};for(s(t);n.length>0;){const c=n.pop();if(T(c)){for(const o of c.getInterfaces?.()??[])s(o);const l=c.getFields();for(const o of Object.values(l)){s(u(o.type));for(const p of o.args??[])s(u(p.type))}}else if(S(c)){const l=c.getFields();for(const o of Object.values(l))s(u(o.type))}else if(E(c))for(const l of c.getTypes())s(l);else if($(c)){const l=c.getFields();for(const o of Object.values(l))s(u(o.type))}}const i=[t.name,...[...a].filter(c=>c!==t.name)],h=[];for(const c of i){const l=e.getType(c);l&&h.push(A(l))}return h.join(`
-
-`)};#p=async({description:t,descriptionUniqueKey:e,userTypes:a,parentRevision:n})=>{const r=a.filter(([,s])=>T(s));r.length!==0&&await w(r,b,async([s,i])=>{const c=i.getInterfaces?.()??[];if(!c.length)return;const l=this.#e(s,e);await w([...c],5,async o=>{const p=this.#e(o.name,e);try{await this.catalogEntitiesService.createEntityRelation({sourceKey:l,type:"implements",targetKey:p,sourceFile:t.realRelativePath,fileHash:t.hash,sourceRevision:n,targetRevision:n})}catch(f){this.#t.warn(`Failed to create 'implements' relation ${l} -> ${p}: ${f instanceof Error?f.message:"Unknown error"}`)}})})};#f=async(t,e,a,n,r,s,i)=>{const{schema:h}=t,c=this.#n(h);if(c.length===0)return;const o=(await R(c,O,async({fieldName:p,field:f,operationType:m,rootTypeName:y})=>{const g=await this.#y(p,f,m,y,t,e,a,r,i);s.delete(`${g}:${n}`)},this.#t)).count.failed;o>0&&this.#t.warn(`Operation extraction completed with ${o} failures out of ${c.length} operations for ${e}`)};#y=async(t,e,a,n,r,s,i,h,c)=>{const l=`${s}-${d(`${a.toLowerCase()}-${t}`)}`,{inputTypes:o,returnTypes:p}=this.#o(e,s),f=await this.#u({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:o,returnTypes:p,description:r,descriptionUniqueKey:s,descriptionVersion:i,parentRevision:h,rbacTeams:c});return f&&await this.#m({apiOperationKey:f.key,inputTypes:o,returnTypes:p,descriptionUniqueKey:s,description:r,descriptionVersion:i,parentRevision:h}),l};#u=async({fieldName:t,field:e,operationType:a,rootTypeName:n,inputTypes:r,returnTypes:s,description:i,descriptionUniqueKey:h,descriptionVersion:c,parentRevision:l,rbacTeams:o})=>{const p=t,m={type:"api-operation",key:`${h}-${d(`${a.toLowerCase()}-${t}`)}`,title:p,summary:e.description?C(e.description):null,tags:["graphql"],metadata:{method:a,path:`${n}.${t}`,payload:r,responses:s},version:c};try{return await this.catalogEntitiesService.createEntity({entity:m,sourceFile:i.realRelativePath,fileHash:i.hash,rbacTeams:o,source:"file",revision:l})}catch(y){return this.#t.warn(`Failed to create API operation entity for ${p}: ${y instanceof Error?y.message:"Unknown error"}`),null}};#m=async({apiOperationKey:t,inputTypes:e,returnTypes:a,descriptionUniqueKey:n,description:r,descriptionVersion:s,parentRevision:i})=>{await this.catalogEntitiesService.createEntityRelation({sourceKey:t,type:"partOf",targetKey:n,sourceFile:r.realRelativePath,fileHash:r.hash,sourceVersion:s,targetVersion:s,sourceRevision:i,targetRevision:i});const h=[...new Set(e)],c=[...new Set(a)],l=[...h.map(o=>({key:o,relationType:"uses"})),...c.map(o=>({key:o,relationType:"returns"}))];await w(l,O,async({key:o,relationType:p})=>{try{await this.catalogEntitiesService.createEntityRelation({sourceKey:t,type:p,targetKey:o,sourceFile:r.realRelativePath,fileHash:r.hash,sourceVersion:s,targetVersion:s,sourceRevision:i,targetRevision:i})}catch(f){this.#t.warn(`Failed to create relation between operation ${t} and type ${o} (${p}): ${f instanceof Error?f.message:"Unknown error"}`)}})}}export{U as GraphqlEntitiesExtractor};

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

@@ -1,19 +0,0 @@
-import type { OpenAPIDefinition } from '@redocly/api-docs';
-import type { BundledApiDefinition } from '../../../../api-docs/loader.js';
-import type { BaseApiEntitiesExtractorParams } from '../../../types/extractors.js';
-import type { EntityDtoSchema } from '../../../schemas/dto-schemas';
-import { BaseApiEntitiesExtractor } from './base.js';
-type OpenApiCatalogBundle = Omit<BundledApiDefinition, 'isVirtual'> & {
-    type: 'openapi';
-    document: OpenAPIDefinition;
-    isVirtual: boolean;
-};
-export declare class OpenApiEntitiesExtractor extends BaseApiEntitiesExtractor<OpenApiCatalogBundle> {
-    #private;
-    constructor(params: BaseApiEntitiesExtractorParams);
-    loadApiDescriptions(): Promise<OpenApiCatalogBundle[]>;
-    mapApiDescriptionToEntity(description: OpenApiCatalogBundle, version: string): EntityDtoSchema;
-    processApiDescription(description: OpenApiCatalogBundle, revision: string, version: string, entitiesToRemoveFromFile: Set<string>): Promise<void>;
-}
-export {};
-//# sourceMappingURL=openapi-entities-extractor.d.ts.map

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

@@ -1 +0,0 @@
-import{REDOCLY_TEAMS_RBAC as R}from"@redocly/config";import{removeLeadingSlash as O}from"@redocly/theme/core/utils";import{toKebabCase as y}from"../../../../../../utils/string/to-kebab-case.js";import{promiseMapLimit as E}from"../../../../../utils/async/promise-map-limit.js";import{promiseMapLimitWithStatus as x}from"../../../../../utils/async/promise-map-limit-with-status.js";import{extractTeamsFromScopeItems as $}from"../../../../../utils/rbac.js";import{removeMarkdocTags as S}from"../../../../../../markdoc/helpers/remove-markdoc-tags.js";import{BaseApiEntitiesExtractor as b}from"./base.js";import{OpenapiSchemaResolver as w}from"../../../utils/openapi-schema-resolver.js";import{extractPartsFromComponentsRef as N}from"../../../utils/extract-parts-from-components-ref.js";import{isValidTagName as d}from"../../../utils/is-valid-tag-name.js";const A=["get","post","put","delete","patch"],T=15,v=15;class V extends b{#e;constructor(e){super("openapi",e),this.#e=e.context.logger}async loadApiDescriptions(){return(await this.actions.loadApiDocuments(this.context)).filter(o=>o.type==="openapi").map(o=>({...o,isVirtual:o.isVirtual??!1}))}mapApiDescriptionToEntity(e,o){const n=O(e.realRelativePath),s=e.document.info.title,t=this.resolveEntityKey({realRelativePath:e.realRelativePath,customKey:e.document["x-redocly-catalog-key"]});return{type:this.type,key:t,title:s,summary:S(typeof e.document.info.description=="string"?e.document.info.description:void 0),tags:e.document.tags?.filter(a=>a.name&&d(a.name)).map(a=>a.name),metadata:{specType:this.specType,descriptionFile:n},version:o}}async processApiDescription(e,o,n,s){if(w.clearSchemaCache(),!e?.document)throw new Error("OpenAPI definition is missing a bundled document");const t=this.getRbacTeamsForDefinition(e.relativePath),a=this.mapApiDescriptionToEntity(e,n);await this.catalogEntitiesService.createEntity({entity:a,sourceFile:e.realRelativePath,fileHash:e.hash,source:"file",isRootEntity:!0,rbacTeams:t,revision:o}),s.delete(`${a.key}:${n}`),await this.#o(e,a.key,a.version,n,o,s,t);const r=this.#n(e.document.paths);if(r.length!==0){const i=(await x(r,T,async({operation:m,path:h,method:f})=>{if(!m.operationId)return;const l=await this.#c(m,h,f,e,a.key,a.version,o,t);s.delete(`${l}:${n}`)},this.#e)).count.failed;i>0&&this.#e.warn(`Extraction completed with ${i} failures out of ${r.length} operations for ${a.key}`)}}#n(e){return Object.entries(e??{}).flatMap(([o,n])=>A.filter(s=>n[s]).map(s=>{const t=n[s];if(!t)throw new Error(`Operation not found for method ${s} on path ${o}`);return{operation:t,path:o,method:s.toUpperCase()}}))}async#o(e,o,n,s,t,a,r){const c=e.document.components?.schemas;if(!c)return;const i=Object.entries(c);i.length!==0&&await E(i,v,async([m,h])=>{const f=`${o}-${y(m)}`,l=await this.#r({schemaName:m,schema:h,description:e,parentKey:o,parentVersion:n,parentRevision:t,rbacTeams:r});a.delete(`${f}:${s}`),l&&await this.catalogEntitiesService.createEntityRelation({sourceKey:o,sourceVersion:n,sourceRevision:t,type:"uses",targetKey:l.key,targetVersion:n,targetRevision:t,sourceFile:e.realRelativePath,fileHash:e.hash})})}async#r({schemaName:e,schema:o,description:n,parentKey:s,parentVersion:t,parentRevision:a,rbacTeams:r}){const c=w.resolveSchemaRefs(o,n.document),i=JSON.stringify(c),m=c[R]?$(c[R]):r,h=$(c["x-rbac"]),f={type:"data-schema",key:`${s}-${y(e)}`,title:e,summary:(typeof c.description=="string"?c.description:c.title)??null,tags:[],metadata:{specType:this.specType,schema:i},version:t};try{return await this.catalogEntitiesService.createEntity({entity:f,sourceFile:n.realRelativePath,fileHash:n.hash,rbacTeams:h.length?h:m,source:"file",revision:a})}catch(l){return this.#e.error(`Failed to create data schema entity for ${e}: ${l instanceof Error?l.message:"Unknown error"}`),null}}async#c(e,o,n,s,t,a,r,c){const i=`${t}-${y(`${e.operationId}`)}`,m=await Promise.all([this.#h(e.requestBody??null,s),this.#l(e.responses??{},s)]),h=m[0].schemaNames,f=m[1].schemaNames;m[0].errors.length>0&&this.#e.warn(`Schema extraction errors for operation ${e.operationId}: ${m[0].errors.join(", ")}`),m[1].errors.length>0&&this.#e.warn(`Response schema extraction errors for operation ${e.operationId}: ${m[1].errors.join(", ")}`);const l=h.map(p=>`${t}-${y(p)}`),u=f.map(p=>`${t}-${y(p)}`),g=await this.#p({path:o,method:n,operation:e,requestBodySchemasKeys:l,responseSchemasKeys:u,description:s,parentKey:t,parentVersion:a,parentRevision:r,rbacTeams:c});return g&&await Promise.all([this.#i(h,e.operationId??"",s.realRelativePath,s.hash,t,a,r),this.#m(f,e.operationId??"",s.realRelativePath,s.hash,t,a,r),this.#y({apiOperationKey:g.key,operationRelations:e["x-catalogRelations"],descriptionUniqueKey:t,description:s,parentVersion:a,parentRevision:r})]),i}async#i(e,o,n,s,t,a,r){return e.length===0||!o?[]:await this.#s(e,o,n,s,t,a,r)}async#m(e,o,n,s,t,a,r){return e.length===0||!o?[]:await this.#s(e,o,n,s,t,a,r)}#h(e,o){const n=[],s=[];try{if(e&&"content"in e&&e.content)for(const t of Object.values(e.content)){const a=this.#a(t,o);if(!a)continue;const r=this.#t(a);r?.componentType==="schemas"&&r.componentName&&n.push(r.componentName)}if(e&&e.$ref){const t=this.#t(e.$ref);if(t?.componentType==="requestBodies"&&t.componentName){const a=o.document.components?.requestBodies?.[t.componentName];if(a&&"content"in a)for(const r of Object.values(a.content??{})){const c=this.#a(r,o);if(!c)continue;const i=this.#t(c);i?.componentType==="schemas"&&i.componentName&&n.push(i.componentName)}}}}catch(t){s.push(`Failed to extract request body schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(n)],errors:s}}#l(e,o){const n=[],s=[];try{for(const t of Object.values(e)){if(t&&"content"in t&&t.content)for(const a of Object.values(t.content)){const r=this.#a(a,o);if(!r)continue;const c=this.#t(r);c?.componentType==="schemas"&&c.componentName&&n.push(c.componentName)}if(t&&t.$ref){const a=this.#t(t.$ref);if(a?.componentType==="responses"&&a.componentName){const r=o.document.components?.responses?.[a.componentName];if(r&&"content"in r)for(const c of Object.values(r.content??{})){const i=this.#a(c,o);if(!i)continue;const m=this.#t(i);m?.componentType==="schemas"&&m.componentName&&n.push(m.componentName)}}}}}catch(t){s.push(`Failed to extract response schemas: ${t instanceof Error?t.message:"Unknown error"}`)}return{schemaNames:[...new Set(n)],errors:s}}#a(e,o){const n=new Set;let s=e;for(;s&&"$ref"in s;){const t=this.#t(s.$ref),a=t?.componentName;if(t?.componentType!=="mediaTypes"||!a||n.has(a))return;n.add(a),s=o.document.components?.mediaTypes?.[a]}return s?.schema?.$ref}#t(e){try{return N(e)}catch{return{componentType:"",componentName:null}}}async#s(e,o,n,s,t,a,r){return e.length===0?[]:await E(e,v,async c=>await this.#f({operationId:o,schemaName:c,descriptionSourceFile:n,descriptionHash:s,parentKey:t,parentVersion:a,parentRevision:r}))}async#f({operationId:e,schemaName:o,descriptionSourceFile:n,descriptionHash:s,parentKey:t,parentVersion:a,parentRevision:r}){const c=`${t}-${y(o)}`;try{return await this.catalogEntitiesService.createEntityRelation({sourceKey:`${t}-${y(e)}`,type:"uses",targetKey:c,sourceFile:n,fileHash:s,sourceVersion:a,targetVersion:a,sourceRevision:r,targetRevision:r}),c}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:n,requestBodySchemasKeys:s,responseSchemasKeys:t,description:a,parentKey:r,parentVersion:c,parentRevision:i,rbacTeams:m}){const h=`${n.operationId}`,f=`${r}-${y(h)}`,l=n[R]?$(n[R]):m,u=$(n["x-rbac"]),g={type:"api-operation",key:f,title:h,summary:S(n.summary),tags:n.tags?.filter(p=>d(p)),metadata:{path:e,method:o,payload:s,responses:t},version:c};try{return await this.catalogEntitiesService.createEntity({entity:g,sourceFile:a.realRelativePath,fileHash:a.hash,rbacTeams:u.length>0?u:l,source:"file",revision:i})}catch(p){return this.#e.error(`Failed to create API operation entity for ${h}: ${p instanceof Error?p.message:"Unknown error"}`),null}}async#y({apiOperationKey:e,operationRelations:o,descriptionUniqueKey:n,description:s,parentVersion:t,parentRevision:a}){try{await this.catalogEntitiesService.createEntityRelation({sourceKey:e,type:"partOf",targetKey:n,sourceFile:s.realRelativePath,fileHash:s.hash,sourceVersion:t,targetVersion:t,sourceRevision:a,targetRevision:a}),await this.#u(e,s,o,t,a)}catch(r){this.#e.error(`Failed to create API operation relations for ${e}: ${r instanceof Error?r.message:"Unknown error"}`)}}async#u(e,o,n,s,t){n?.length&&await E(n,T,async a=>{try{this.validateEntityRelationFileSchema(a),await this.catalogEntitiesService.createEntityRelation({sourceKey:e,type:a.type,targetKey:a.key,sourceFile:o.realRelativePath,fileHash:o.hash,sourceVersion:s,targetVersion:"",sourceRevision:t,targetRevision:""})}catch(r){this.context.logger.warn(`Error creating entity relation for operation ${e} based on custom property: ${r instanceof Error?r.message:"Unknown error"}`)}})}}export{V as OpenApiEntitiesExtractor};

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

@@ -1,4 +0,0 @@
-export type BaseEntitiesExtractor = {
-    extract(): Promise<void>;
-};
-//# sourceMappingURL=base.d.ts.map

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

@@ -1,16 +0,0 @@
-import type { HashManager } from '../../utils/hash-manager.js';
-import type { LifecycleContext } from '../../../../types/plugins/common';
-import type { CatalogEntitiesService } from '../../database/catalog-entities-service.js';
-import type { EntitiesCatalogConfig } from '@redocly/config';
-export declare class FsEntitiesExtractor {
-    #private;
-    constructor({ fileHashManager, context, catalogEntitiesService, catalogConfig, shouldCalculateEntities, }: {
-        fileHashManager: HashManager;
-        context: LifecycleContext;
-        catalogEntitiesService: CatalogEntitiesService;
-        catalogConfig: EntitiesCatalogConfig;
-        shouldCalculateEntities: boolean;
-    });
-    extract(path?: string): Promise<void>;
-}
-//# sourceMappingURL=fs-entities-extractor.d.ts.map

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

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

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

@@ -1,3 +0,0 @@
-import type { EntitiesCatalogConfig } from '@redocly/config';
-export declare function getCompleteCatalogConfig(config?: EntitiesCatalogConfig): EntitiesCatalogConfig;
-//# sourceMappingURL=get-complete-catalog-config.d.ts.map

package/dist/server/plugins/catalog-entities/get-complete-catalog-config.js

@@ -1 +0,0 @@
-import{CATALOG_ENTITIES_DEFAULT_CONFIG as o}from"../../constants/plugins/catalog-entities.js";import{isPredefinedCatalogType as l,predefinedCatalogTypes as r}from"./utils/is-predefined-catalog-type.js";function C(t){if(!t)return o;const e={...t.catalogs};for(const a of r)e[a]={...o.catalogs?.[a],...t.catalogs?.[a]};if(t.catalogs)for(const[a,s]of Object.entries(t.catalogs))l(a)||(e[a]={...s,...s?.slug?{}:{slug:a}});return{...o,show:t.show,catalogs:e,entityTypes:t.entityTypes}}export{C as getCompleteCatalogConfig};

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

@@ -1,25 +0,0 @@
-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';
-export type ServerSideProps = {
-    status: 'success';
-    entitiesTypes: string[];
-    entities: BffCatalogEntityList;
-    catalogConfig: CatalogEntityConfig;
-    filters: CatalogFiltersWithCounts;
-    catalogSwitcherItems: CatalogSwitcherItem[];
-    initialViewMode?: CatalogViewMode;
-} | {
-    status: 'success';
-    entity: BffCatalogEntity;
-    relatedEntity: BffCatalogRelatedEntity | null;
-    relations: BffCatalogRelatedEntityList;
-    entitiesCatalogConfig: EntitiesCatalogConfig;
-    catalogConfig: CatalogEntityConfig;
-    sharedDataIds?: Record<string, string>;
-} | {
-    status: 'notFound';
-};
-declare const getServerProps: GetServerPropsFn;
-export default getServerProps;
-//# sourceMappingURL=get-server-props.d.ts.map

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

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

package/dist/server/plugins/catalog-entities/plugin.d.ts

@@ -1,4 +0,0 @@
-import type { LifecyclePluginInstance } from '../../types';
-export declare function catalogEntitiesPlugin(): Promise<LifecyclePluginInstance>;
-export default catalogEntitiesPlugin;
-//# sourceMappingURL=plugin.d.ts.map

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

@@ -1 +0,0 @@
-import{FileHashStatus as v,FileType as h}from"../../persistence/file-hashes/types.js";import{envConfig as C}from"../../config/env-config.js";import{CATALOG_BASE_SLUG as S}from"../../../constants/catalog-entities.js";import{telemetryTraceStep as $}from"../../../cli/telemetry/helpers/trace-step.js";import{catalogDataCollector as f}from"./utils/catalog-data-collector.js";import{CATALOG_FILTERS_CACHE_NAMESPACE as k,ENTITIES_MAP_GLOBAL_DATA_KEY as B}from"../../constants/plugins/catalog-entities.js";import{CacheService as z}from"../../persistence/cache/services/cache-service.js";import{getTemplatePath as R}from"./utils/get-template-path.js";import{getCompleteCatalogConfig as O}from"./get-complete-catalog-config.js";import{AsyncApiEntitiesExtractor as Y}from"./extensions/extractors/api-description/asyncapi-entities-extractor.js";import{GraphqlEntitiesExtractor as U}from"./extensions/extractors/api-description/graphql-entities-extractor.js";import{FileHashesService as j}from"../../persistence/file-hashes/services/file-hashes-service.js";import{CatalogEntitiesService as q}from"./database/catalog-entities-service.js";import{CatalogEntitiesPublisher as V}from"./database/catalog-entities-publisher.js";import{CatalogEntitiesRevisionsPruner as I}from"./database/catalog-entities-revisions-pruner.js";import{DEFAULT_MAX_ENTITY_REVISIONS as W}from"./database/consts.js";import{DatabaseConnectionFactory as J}from"../../providers/database/database-connection-factory.js";import{ArazzoEntitiesExtractor as X}from"./extensions/extractors/api-description/arazzo-entities-extractor.js";import{FsEntitiesExtractor as Z}from"./extensions/extractors/fs-entities-extractor.js";import{HashManager as K}from"./utils/hash-manager.js";import{RbacConfigHashCache as Q}from"./utils/rbac-config-hash-cache.js";import{OpenApiEntitiesExtractor as ee}from"./extensions/extractors/api-description/openapi-entities-extractor.js";const te="catalog-entity-template",ie="catalog-entity";let _=!0;async function ae(){return{id:"CatalogEntities",requiredEntitlements:["catalog"],async processContent(e,i){const o=await i.getConfig(),r=O(o.entitiesCatalog);if(!r.show)return;const{logger:n}=i,a=e.registerServerPropsGetter(ie,R("../get-server-props.js")),g=e.createTemplate(te,R("../template/index.js"));e.addRoute({duplicateInAllLocales:!0,slug:S,fsPath:"",templateId:g,excludeFromSidebar:!0,hasClientRoutes:!0,serverPropsGetterIds:[a],getNavText:()=>Promise.resolve("Catalog"),getStaticData:async()=>({props:{catalogConfig:r}})});const[l]=Object.entries(r.catalogs??{}).find(([P,m])=>!m?.hide)||[];l&&e.addRedirect(S,{type:302,to:`${S}/${l}`},{trackOriginalSource:!1}),n.info("Catalog Entities plugin finished")},async afterRoutesCreated(e,i){await $("com.redocly.build.plugin.catalogEntities",async o=>{const r=await i.getConfig(),n=O(r.entitiesCatalog);if(o?.setAttribute("config",JSON.stringify(n)),!n.show)return;const{logger:a}=i;f.resetForRun();const g=_&&C.isDevelopMode,l=await z.getInstance({baseDbDir:e.serverOutDir,databaseType:"local"}),P=new Q(l),{rbacConfigChanged:m}=await P.syncAndDetectChange(r.access?.rbac??null),c=g||m,s=await q.getInstance({baseDbDir:e.serverOutDir,removeExisting:g,databaseType:"local",runWithPragmaWalWriteOptimization:!0}),T=await j.getInstance({baseDbDir:e.serverOutDir,databaseType:"local"}),u=new K(T),w=[new Z({fileHashManager:u,context:i,catalogEntitiesService:s,catalogConfig:n,shouldCalculateEntities:c}),new ee({actions:e,context:i,catalogEntitiesService:s,fileHashManager:u,fileType:h.OPENAPI_DESCRIPTION,shouldCalculateEntities:c}),new Y({actions:e,context:i,catalogEntitiesService:s,fileHashManager:u,fileType:h.ASYNCAPI_DESCRIPTION,shouldCalculateEntities:c}),new U({actions:e,context:i,catalogEntitiesService:s,fileHashManager:u,fileType:h.GRAPHQL_DESCRIPTION,shouldCalculateEntities:c}),new X({actions:e,context:i,catalogEntitiesService:s,fileHashManager:u,fileType:h.ARAZZO_DESCRIPTION,shouldCalculateEntities:c})];a.info("Starting entities extractors...");const F=a.startTiming();await s.transaction(async()=>{await Promise.all(w.map(async t=>t.extract()))});const H=s.getEntitySources();e.setGlobalData({[B]:H}),await l.deleteByNamespace(k),a.infoTime(F,"Entities extractors finished");const y=C.CATALOG_MAX_REVISIONS??W,d=await J.create({baseDbDir:e.serverOutDir,databaseType:"local"}),N=!C.isDevelopMode&&C.isProductionEnv;let E=[];if(N&&d&&y>0){const t=await I.pruneLocalRevisions({localConnection:d,maxRevisions:y});if(t.prunedEntities>0||t.prunedRelations>0||t.legacyRelationsHealed>0||t.legacyRelationsDeleted>0){a.info(`Pruned entity revision history: entities=${t.prunedEntities} relations=${t.prunedRelations} legacyHealed=${t.legacyRelationsHealed} legacyDeleted=${t.legacyRelationsDeleted} files=${t.affectedSourceFiles.length} (keeping ${y} revisions per entity)`),E=t.affectedSourceFiles;for(const D of E)f.markSourceFileAsChanged(D)}}const{changedSourceFiles:L,removedSourceFiles:b}=f.getPublishDelta(),x=a.startTiming(),A=await V.publishFromLocalToRemote(m?{baseDbDir:e.serverOutDir}:{baseDbDir:e.serverOutDir,changedSourceFiles:L,removedSourceFiles:b});if(A.published&&a.infoTime(x,"Entities published to the database"),A.shouldFinalizeFileHashes){b.length&&await T.deleteFileHashes({op:"AND",conditions:[{field:"status",operator:"equal",value:v.OUTDATED},{field:"file_path",operator:"in",value:b}]});const t=f.getFileHashConfirmations();for(const{fileType:D,filePath:G,hash:M}of t)await T.upsertFileHash({fileType:D,filePath:G,hash:M,status:v.UP_TO_DATE});A.published&&E.length&&d&&await I.confirmPrunedFiles({localConnection:d,sourceFiles:E})}else a.warn("Skipped file_hashes finalization because remote catalog publish connection is unavailable; next build will retry.");const p=await f.getCatalogEntitiesData(s);o?.setAttribute("totalEntities",p.totalEntitiesCount),o?.setAttribute("entitiesCountByType",JSON.stringify(p.countOfEntitiesByType)),o?.setAttribute("totalFilesSkippedByHash",p.totalFilesSkippedByHash),o?.setAttribute("totalProcessedFiles",p.totalProcessedFiles),o?.setAttribute("extractors",p.extractors),_=!1})}}}var ve=ae;export{ae as catalogEntitiesPlugin,ve as default};