@redocly/config 0.31.0 → 0.33.0

package/lib/root-config-schema.js

@@ -404,7 +404,7 @@ exports.redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
-        }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: { type: 'string' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: { type: 'string', pattern: '^https?://.*' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

package/lib/types/api-functions-types.d.ts

@@ -30,7 +30,7 @@ export type ApiFunctionsContext = {
     query: Record<string, string | string[]>;
     cookies: Record<string, string>;
 } & ApiFunctionsContextMethods;
-export type ApiFunctionsHandler = (request: Request, context: ApiFunctionsContext, 
+export type ApiRoutesHandler = (request: Request, context: ApiFunctionsContext, 
 /**
  * @deprecated `staticData` is deprecated.
  */

package/lib/types/catalog-entity-types.d.ts

@@ -1,6 +1,8 @@
 import type { FromSchema } from 'json-schema-to-ts';
-import type { entityCatalogSpecificCatalogSchema } from '../entities-catalog-config-schema';
+import type { entityCatalogEntityTypeSchema, entityCatalogSpecificCatalogSchema } from '../entities-catalog-config-schema';
+import type { apiDescriptionMetadataSchema, apiOperationMetadataSchema, dataSchemaMetadataSchema, defaultMetadataSchema, entityContactFileSchema, entityLinkFileSchema, entityRelationFileSchema, slackChannelFileSchema, slackContactFileSchema, userMetadataSchema } from '../entities-catalog-entity-file-schema';
 export type EntityCatalogSpecificCatalogConfig = FromSchema<typeof entityCatalogSpecificCatalogSchema>;
+export type EntityCatalogEntityTypeConfig = FromSchema<typeof entityCatalogEntityTypeSchema>;
 export type CatalogConfigEntityExclude = {
     key: string;
 };
@@ -30,7 +32,7 @@ export type CatalogEntityConfig = {
     descriptionTranslationKey?: string;
     catalogSwitcherLabelTranslationKey?: string;
 };
-export type EntitiesCatalogConfigTypes = {
+export type EntitiesCatalogConfig = {
     catalogs?: {
         all?: EntityCatalogSpecificCatalogConfig;
         services?: EntityCatalogSpecificCatalogConfig;
@@ -42,4 +44,42 @@ export type EntitiesCatalogConfigTypes = {
         apiOperations?: EntityCatalogSpecificCatalogConfig;
         [catalogName: string]: EntityCatalogSpecificCatalogConfig | undefined;
     };
+    entityTypes?: Record<string, EntityCatalogEntityTypeConfig>;
 };
+export type SlackChannelFileSchema = FromSchema<typeof slackChannelFileSchema>;
+export type SlackContactFileSchema = FromSchema<typeof slackContactFileSchema>;
+export type EntityContactFileSchema = FromSchema<typeof entityContactFileSchema>;
+export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
+export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
+export type EntityBaseFileSchema = {
+    key: string;
+    title: string;
+    summary?: string | null;
+    tags?: string[] | null;
+    git?: string[] | null;
+    contact?: EntityContactFileSchema | null;
+    links?: EntityLinkFileSchema[] | null;
+    relations?: EntityRelationFileSchema[] | null;
+    type: string;
+    metadata?: DefaultMetadataSchema | null;
+};
+export type EntityFileSchema = (Omit<EntityBaseFileSchema, 'type'> & {
+    type: 'user';
+    metadata: UserMetadataSchema;
+}) | (Omit<EntityBaseFileSchema, 'type'> & {
+    type: 'api-description';
+    metadata: ApiDescriptionMetadataSchema;
+}) | (Omit<EntityBaseFileSchema, 'type'> & {
+    type: 'api-operation';
+    metadata: ApiOperationMetadataSchema;
+}) | (Omit<EntityBaseFileSchema, 'type'> & {
+    type: 'data-schema';
+    metadata: DataSchemaMetadataSchema;
+}) | (Omit<EntityBaseFileSchema, 'type'> & {
+    type: 'service' | 'domain' | 'team';
+});
+export type UserMetadataSchema = FromSchema<typeof userMetadataSchema>;
+export type ApiDescriptionMetadataSchema = FromSchema<typeof apiDescriptionMetadataSchema>;
+export type ApiOperationMetadataSchema = FromSchema<typeof apiOperationMetadataSchema>;
+export type DataSchemaMetadataSchema = FromSchema<typeof dataSchemaMetadataSchema>;
+export type DefaultMetadataSchema = FromSchema<typeof defaultMetadataSchema>;

package/lib/types/config-types.d.ts

@@ -7,7 +7,6 @@ import type { GraphQLConfigTypes } from './graphql-types';
 import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
-import type { EntitiesCatalogConfigTypes } from './catalog-entity-types';
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
  */
@@ -25,7 +24,6 @@ export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSch
 export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
 export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
 export type CatalogConfig = FromSchema<typeof catalogSchema>;
-export type EntitiesCatalogConfig = EntitiesCatalogConfigTypes;
 export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;

package/lib/types/portal-shared-types.d.ts

@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
 import type { CatalogEntityConfig } from './catalog-entity-types';
 export * from './code-walkthrough-types';
-export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard'> & {
+export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'entitiesCatalog'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;

package/lib-esm/constants.d.ts

@@ -13,3 +13,4 @@ export declare enum LayoutVariant {
     STACKED = "stacked",
     THREE_PANEL = "three-panel"
 }
+export declare const ENTITY_RELATION_TYPES: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];

package/lib-esm/constants.js

@@ -16,4 +16,31 @@ export var LayoutVariant;
     LayoutVariant["STACKED"] = "stacked";
     LayoutVariant["THREE_PANEL"] = "three-panel";
 })(LayoutVariant || (LayoutVariant = {}));
+export const ENTITY_RELATION_TYPES = [
+    'partOf',
+    'hasParts',
+    'creates',
+    'createdBy',
+    'owns',
+    'ownedBy',
+    'implements',
+    'implementedBy',
+    'dependsOn',
+    'dependencyOf',
+    'uses',
+    'usedBy',
+    'produces',
+    'consumes',
+    'linksTo',
+    'supersedes',
+    'supersededBy',
+    'compatibleWith',
+    'extends',
+    'extendedBy',
+    'relatesTo',
+    'hasMember',
+    'memberOf',
+    'triggers',
+    'triggeredBy',
+];
 //# sourceMappingURL=constants.js.map

package/lib-esm/default-theme-config-schema.d.ts

@@ -2948,6 +2948,9 @@ export declare const themeConfigSchema: {
                 readonly excludeFromSearch: {
                     readonly type: "boolean";
                 };
+                readonly showSchemaCatalogLinks: {
+                    readonly type: "boolean";
+                };
             };
             readonly type: "object";
             readonly additionalProperties: false;
@@ -3982,6 +3985,109 @@ export declare const themeConfigSchema: {
         readonly entitiesCatalog: {
             readonly type: "object";
             readonly properties: {
+                readonly entityTypes: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly required: readonly ["name", "description", "metadataSchema"];
+                        readonly properties: {
+                            readonly name: {
+                                readonly type: "string";
+                                readonly description: "Display name of the entity type";
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                                readonly description: "Description of the entity type";
+                            };
+                            readonly metadataSchema: {
+                                readonly type: "object";
+                                readonly required: readonly ["type", "properties"];
+                                readonly properties: {
+                                    readonly type: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["object"];
+                                    };
+                                    readonly description: {
+                                        readonly type: "string";
+                                    };
+                                    readonly properties: {
+                                        readonly type: "object";
+                                        readonly additionalProperties: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly type: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+                                                };
+                                                readonly description: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly example: {
+                                                    readonly oneOf: readonly [{
+                                                        readonly type: "string";
+                                                    }, {
+                                                        readonly type: "number";
+                                                    }, {
+                                                        readonly type: "boolean";
+                                                    }, {
+                                                        readonly type: "array";
+                                                    }, {
+                                                        readonly type: "object";
+                                                    }];
+                                                };
+                                                readonly enum: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                                readonly pattern: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly format: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly minimum: {
+                                                    readonly type: "number";
+                                                };
+                                                readonly maximum: {
+                                                    readonly type: "number";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "object";
+                                                };
+                                            };
+                                            readonly additionalProperties: true;
+                                        };
+                                    };
+                                    readonly required: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly additionalProperties: {
+                                        readonly type: "boolean";
+                                    };
+                                };
+                                readonly additionalProperties: true;
+                            };
+                            readonly icon: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly src: {
+                                        readonly type: "string";
+                                    };
+                                    readonly srcSet: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
                 readonly catalogs: {
                     readonly type: "object";
                     readonly properties: {