@redocly/config 0.31.0 → 0.33.0

package/lib/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/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayoutVariant = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = exports.DEFAULT_TEAM_CLAIM_NAME = void 0;
+exports.ENTITY_RELATION_TYPES = exports.LayoutVariant = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = exports.DEFAULT_TEAM_CLAIM_NAME = void 0;
 exports.DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
 var AuthProviderType;
 (function (AuthProviderType) {
@@ -19,4 +19,31 @@ var LayoutVariant;
     LayoutVariant["STACKED"] = "stacked";
     LayoutVariant["THREE_PANEL"] = "three-panel";
 })(LayoutVariant || (exports.LayoutVariant = LayoutVariant = {}));
+exports.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/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: {

package/lib/entities-catalog-config-schema.d.ts

@@ -152,9 +152,435 @@ export declare const entityCatalogSpecificCatalogSchema: {
     };
     readonly additionalProperties: false;
 };
+export declare const entityCatalogMetadataSchemaPropertySchema: {
+    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;
+};
+export declare const entityCatalogMetadataSchema: {
+    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;
+};
+export declare const entityCatalogEntityTypeSchema: {
+    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;
+};
+export declare const entityCatalogEntityTypesSchema: {
+    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;
+    };
+};
 export declare const entitiesCatalogConfigSchema: {
     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: {