@redocly/config 0.41.2 → 0.41.3

package/lib/entities-catalog-entity-file-schema.js

@@ -4,6 +4,7 @@ exports.entityFileDefaultSchema = exports.entityFileSchema = exports.entityBaseP
 const constants_1 = require("./constants");
 exports.userMetadataSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY_METADATA,
     properties: {
         email: {
             type: 'string',
@@ -15,6 +16,7 @@ exports.userMetadataSchema = {
 };
 exports.apiDescriptionMetadataSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
     properties: {
         specType: {
             type: 'string',
@@ -31,6 +33,7 @@ exports.apiDescriptionMetadataSchema = {
 };
 exports.apiOperationMetadataSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_METADATA,
     properties: {
         method: {
             type: 'string',
@@ -61,6 +64,7 @@ exports.apiOperationMetadataSchema = {
 };
 exports.dataSchemaMetadataSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
     properties: {
         specType: {
             type: 'string',
@@ -81,37 +85,33 @@ exports.dataSchemaMetadataSchema = {
 };
 exports.defaultMetadataSchema = {
     type: 'object',
+    properties: {},
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_METADATA,
     additionalProperties: true,
 };
 exports.slackChannelFileSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CHANNEL,
     properties: {
         name: {
             type: 'string',
             minLength: 2,
             maxLength: 150,
         },
+        url: {
+            type: 'string',
+        },
     },
     required: ['name'],
     additionalProperties: false,
 };
 exports.slackContactFileSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CONTACT,
     properties: {
         channels: {
             type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    name: {
-                        type: 'string',
-                        minLength: 2,
-                        maxLength: 150,
-                    },
-                },
-                required: ['name'],
-                additionalProperties: false,
-            },
+            items: exports.slackChannelFileSchema,
         },
     },
     required: ['channels'],
@@ -119,37 +119,15 @@ exports.slackContactFileSchema = {
 };
 exports.entityContactFileSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_CONTACT,
     properties: {
-        slack: {
-            type: 'object',
-            properties: {
-                channels: {
-                    type: 'array',
-                    items: {
-                        type: 'object',
-                        properties: {
-                            name: {
-                                type: 'string',
-                                minLength: 2,
-                                maxLength: 150,
-                            },
-                            url: {
-                                type: 'string',
-                            },
-                        },
-                        required: ['name'],
-                        additionalProperties: false,
-                    },
-                },
-            },
-            required: ['channels'],
-            additionalProperties: false,
-        },
+        slack: exports.slackContactFileSchema,
     },
     additionalProperties: false,
 };
 exports.entityLinkFileSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK,
     properties: {
         label: {
             type: 'string',
@@ -165,6 +143,7 @@ exports.entityLinkFileSchema = {
 };
 exports.entityRelationFileSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION,
     properties: {
         type: {
             type: 'string',
@@ -227,16 +206,15 @@ exports.entityBaseProperties = {
     contact: exports.entityContactFileSchema,
     links: {
         type: 'array',
+        nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK_LIST,
         items: exports.entityLinkFileSchema,
     },
     relations: {
         type: 'array',
+        nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
         items: exports.entityRelationFileSchema,
     },
-    metadata: {
-        type: 'object',
-        additionalProperties: true,
-    },
+    metadata: exports.defaultMetadataSchema,
 };
 exports.entityFileSchema = {
     type: 'object',
@@ -249,39 +227,46 @@ exports.entityFileSchema = {
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'user' }, metadata: exports.userMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.SERVICE_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.DOMAIN_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: constants_1.NODE_TYPE_NAMES.TEAM_ENTITY,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
@@ -290,6 +275,7 @@ exports.entityFileSchema = {
 };
 exports.entityFileDefaultSchema = {
     type: 'object',
+    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY,
     properties: Object.assign({}, exports.entityBaseProperties),
     required: ['key', 'title', 'type'],
     additionalProperties: false,

package/lib/index.d.ts

@@ -3,5 +3,5 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema'
 export { redocConfigSchema } from './redoc-config-schema';
 export * from './types';
 export * from './common';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, NODE_TYPE_NAMES, } from './constants';
 export * from './entities-catalog-entity-file-schema';

package/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENTITY_RELATION_TYPES = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
+exports.NODE_TYPE_NAMES = exports.ENTITY_RELATION_TYPES = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
 var product_override_schema_1 = require("./product-override-schema");
 Object.defineProperty(exports, "productThemeOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productThemeOverrideSchema; } });
 Object.defineProperty(exports, "productConfigOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productConfigOverrideSchema; } });
@@ -33,5 +33,6 @@ Object.defineProperty(exports, "LayoutVariant", { enumerable: true, get: functio
 Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });
 Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_ROUTE_RBAC; } });
 Object.defineProperty(exports, "ENTITY_RELATION_TYPES", { enumerable: true, get: function () { return constants_1.ENTITY_RELATION_TYPES; } });
+Object.defineProperty(exports, "NODE_TYPE_NAMES", { enumerable: true, get: function () { return constants_1.NODE_TYPE_NAMES; } });
 __exportStar(require("./entities-catalog-entity-file-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/root-config-schema.d.ts

@@ -12344,6 +12344,9 @@ export declare const redoclyConfigSchema: {
                             readonly name: {
                                 readonly type: "string";
                             };
+                            readonly key: {
+                                readonly type: "string";
+                            };
                             readonly description: {
                                 readonly type: "string";
                             };
@@ -12873,7 +12876,7 @@ export declare const redoclyConfigSchema: {
                                 }];
                             };
                         };
-                        readonly required: readonly ["name", "entities", "levels"];
+                        readonly required: readonly ["name", "key", "entities", "levels"];
                         readonly additionalProperties: false;
                     };
                 };
@@ -18873,6 +18876,9 @@ export declare const redoclyConfigSchema: {
                     readonly name: {
                         readonly type: "string";
                     };
+                    readonly key: {
+                        readonly type: "string";
+                    };
                     readonly description: {
                         readonly type: "string";
                     };
@@ -19402,7 +19408,7 @@ export declare const redoclyConfigSchema: {
                         }];
                     };
                 };
-                readonly required: readonly ["name", "entities", "levels"];
+                readonly required: readonly ["name", "key", "entities", "levels"];
                 readonly additionalProperties: false;
             };
         };
@@ -29076,6 +29082,9 @@ export declare const rootRedoclyConfigSchema: {
                                         description: {
                                             type: "string";
                                         };
+                                        key: {
+                                            type: "string";
+                                        };
                                         entities: {
                                             oneOf: ({
                                                 items: {
@@ -29171,7 +29180,7 @@ export declare const rootRedoclyConfigSchema: {
                                     };
                                     additionalProperties: false;
                                     type: "object";
-                                    required: ("name" | "entities" | "levels")[];
+                                    required: ("name" | "key" | "entities" | "levels")[];
                                 };
                                 type: "array";
                             };
@@ -35089,6 +35098,9 @@ export declare const rootRedoclyConfigSchema: {
                                 description: {
                                     type: "string";
                                 };
+                                key: {
+                                    type: "string";
+                                };
                                 entities: {
                                     oneOf: ({
                                         items: {
@@ -35249,7 +35261,7 @@ export declare const rootRedoclyConfigSchema: {
                             };
                             additionalProperties: false;
                             type: "object";
-                            required: ("name" | "entities" | "levels")[];
+                            required: ("name" | "key" | "entities" | "levels")[];
                         };
                         type: "array";
                     };
@@ -44063,6 +44075,9 @@ export declare const rootRedoclyConfigSchema: {
                             readonly name: {
                                 readonly type: "string";
                             };
+                            readonly key: {
+                                readonly type: "string";
+                            };
                             readonly description: {
                                 readonly type: "string";
                             };
@@ -44592,7 +44607,7 @@ export declare const rootRedoclyConfigSchema: {
                                 }];
                             };
                         };
-                        readonly required: readonly ["name", "entities", "levels"];
+                        readonly required: readonly ["name", "key", "entities", "levels"];
                         readonly additionalProperties: false;
                     };
                 };
@@ -50592,6 +50607,9 @@ export declare const rootRedoclyConfigSchema: {
                     readonly name: {
                         readonly type: "string";
                     };
+                    readonly key: {
+                        readonly type: "string";
+                    };
                     readonly description: {
                         readonly type: "string";
                     };
@@ -51121,7 +51139,7 @@ export declare const rootRedoclyConfigSchema: {
                         }];
                     };
                 };
-                readonly required: readonly ["name", "entities", "levels"];
+                readonly required: readonly ["name", "key", "entities", "levels"];
                 readonly additionalProperties: false;
             };
         };

package/lib/scorecards-config-schema.d.ts

@@ -4,6 +4,9 @@ export declare const scorecardSchema: {
         readonly name: {
             readonly type: "string";
         };
+        readonly key: {
+            readonly type: "string";
+        };
         readonly description: {
             readonly type: "string";
         };
@@ -533,7 +536,7 @@ export declare const scorecardSchema: {
             }];
         };
     };
-    readonly required: readonly ["name", "entities", "levels"];
+    readonly required: readonly ["name", "key", "entities", "levels"];
     readonly additionalProperties: false;
 };
 export declare const scorecardsConfigSchema: {
@@ -544,6 +547,9 @@ export declare const scorecardsConfigSchema: {
             readonly name: {
                 readonly type: "string";
             };
+            readonly key: {
+                readonly type: "string";
+            };
             readonly description: {
                 readonly type: "string";
             };
@@ -1073,7 +1079,7 @@ export declare const scorecardsConfigSchema: {
                 }];
             };
         };
-        readonly required: readonly ["name", "entities", "levels"];
+        readonly required: readonly ["name", "key", "entities", "levels"];
         readonly additionalProperties: false;
     };
 };

package/lib/scorecards-config-schema.js

@@ -208,6 +208,7 @@ exports.scorecardSchema = {
     type: 'object',
     properties: {
         name: { type: 'string' },
+        key: { type: 'string' },
         description: { type: 'string' },
         entities: {
             oneOf: [
@@ -230,7 +231,7 @@ exports.scorecardSchema = {
         },
         trigger: triggerSchema,
     },
-    required: ['name', 'entities', 'levels'],
+    required: ['name', 'key', 'entities', 'levels'],
     additionalProperties: false,
 };
 exports.scorecardsConfigSchema = {

package/lib-esm/constants.d.ts

@@ -14,3 +14,25 @@ export declare enum LayoutVariant {
     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", "returns", "returnedBy"];
+export declare const NODE_TYPE_NAMES: {
+    readonly USER_ENTITY: "UserEntity";
+    readonly USER_ENTITY_METADATA: "UserEntityMetadata";
+    readonly API_DESCRIPTION_ENTITY: "ApiDescriptionEntity";
+    readonly API_DESCRIPTION_METADATA: "ApiDescriptionEntityMetadata";
+    readonly API_OPERATION_ENTITY: "ApiOperationEntity";
+    readonly API_OPERATION_METADATA: "ApiOperationEntityMetadata";
+    readonly DATA_SCHEMA_ENTITY: "DataSchemaEntity";
+    readonly DATA_SCHEMA_METADATA: "DataSchemaEntityMetadata";
+    readonly SERVICE_ENTITY: "ServiceEntity";
+    readonly DOMAIN_ENTITY: "DomainEntity";
+    readonly TEAM_ENTITY: "TeamEntity";
+    readonly ENTITY: "Entity";
+    readonly ENTITY_METADATA: "EntityMetadata";
+    readonly ENTITY_LINK_LIST: "EntityLinkList";
+    readonly ENTITY_LINK: "EntityLink";
+    readonly ENTITY_RELATION: "EntityRelation";
+    readonly ENTITY_RELATION_LIST: "EntityRelationList";
+    readonly ENTITY_CONTACT: "EntityContact";
+    readonly SLACK_CONTACT: "EntitySlackContact";
+    readonly SLACK_CHANNEL: "EntitySlackChannel";
+};

package/lib-esm/constants.js

@@ -45,4 +45,26 @@ export const ENTITY_RELATION_TYPES = [
     'returns',
     'returnedBy',
 ];
+export const NODE_TYPE_NAMES = {
+    USER_ENTITY: 'UserEntity',
+    USER_ENTITY_METADATA: 'UserEntityMetadata',
+    API_DESCRIPTION_ENTITY: 'ApiDescriptionEntity',
+    API_DESCRIPTION_METADATA: 'ApiDescriptionEntityMetadata',
+    API_OPERATION_ENTITY: 'ApiOperationEntity',
+    API_OPERATION_METADATA: 'ApiOperationEntityMetadata',
+    DATA_SCHEMA_ENTITY: 'DataSchemaEntity',
+    DATA_SCHEMA_METADATA: 'DataSchemaEntityMetadata',
+    SERVICE_ENTITY: 'ServiceEntity',
+    DOMAIN_ENTITY: 'DomainEntity',
+    TEAM_ENTITY: 'TeamEntity',
+    ENTITY: 'Entity',
+    ENTITY_METADATA: 'EntityMetadata',
+    ENTITY_LINK_LIST: 'EntityLinkList',
+    ENTITY_LINK: 'EntityLink',
+    ENTITY_RELATION: 'EntityRelation',
+    ENTITY_RELATION_LIST: 'EntityRelationList',
+    ENTITY_CONTACT: 'EntityContact',
+    SLACK_CONTACT: 'EntitySlackContact',
+    SLACK_CHANNEL: 'EntitySlackChannel',
+};
 //# sourceMappingURL=constants.js.map

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

@@ -5615,6 +5615,9 @@ export declare const themeConfigSchema: {
                     readonly name: {
                         readonly type: "string";
                     };
+                    readonly key: {
+                        readonly type: "string";
+                    };
                     readonly description: {
                         readonly type: "string";
                     };
@@ -6144,7 +6147,7 @@ export declare const themeConfigSchema: {
                         }];
                     };
                 };
-                readonly required: readonly ["name", "entities", "levels"];
+                readonly required: readonly ["name", "key", "entities", "levels"];
                 readonly additionalProperties: false;
             };
         };