@redocly/config 0.41.2 → 0.41.3

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

@@ -1,6 +1,7 @@
-import { ENTITY_RELATION_TYPES } from './constants';
+import { ENTITY_RELATION_TYPES, NODE_TYPE_NAMES } from './constants';
 export const userMetadataSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY_METADATA,
     properties: {
         email: {
             type: 'string',
@@ -12,6 +13,7 @@ export const userMetadataSchema = {
 };
 export const apiDescriptionMetadataSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
     properties: {
         specType: {
             type: 'string',
@@ -28,6 +30,7 @@ export const apiDescriptionMetadataSchema = {
 };
 export const apiOperationMetadataSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_METADATA,
     properties: {
         method: {
             type: 'string',
@@ -58,6 +61,7 @@ export const apiOperationMetadataSchema = {
 };
 export const dataSchemaMetadataSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
     properties: {
         specType: {
             type: 'string',
@@ -78,37 +82,33 @@ export const dataSchemaMetadataSchema = {
 };
 export const defaultMetadataSchema = {
     type: 'object',
+    properties: {},
+    nodeTypeName: NODE_TYPE_NAMES.ENTITY_METADATA,
     additionalProperties: true,
 };
 export const slackChannelFileSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.SLACK_CHANNEL,
     properties: {
         name: {
             type: 'string',
             minLength: 2,
             maxLength: 150,
         },
+        url: {
+            type: 'string',
+        },
     },
     required: ['name'],
     additionalProperties: false,
 };
 export const slackContactFileSchema = {
     type: 'object',
+    nodeTypeName: 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: slackChannelFileSchema,
         },
     },
     required: ['channels'],
@@ -116,37 +116,15 @@ export const slackContactFileSchema = {
 };
 export const entityContactFileSchema = {
     type: 'object',
+    nodeTypeName: 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: slackContactFileSchema,
     },
     additionalProperties: false,
 };
 export const entityLinkFileSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK,
     properties: {
         label: {
             type: 'string',
@@ -162,6 +140,7 @@ export const entityLinkFileSchema = {
 };
 export const entityRelationFileSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION,
     properties: {
         type: {
             type: 'string',
@@ -224,16 +203,15 @@ export const entityBaseProperties = {
     contact: entityContactFileSchema,
     links: {
         type: 'array',
+        nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK_LIST,
         items: entityLinkFileSchema,
     },
     relations: {
         type: 'array',
+        nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
         items: entityRelationFileSchema,
     },
-    metadata: {
-        type: 'object',
-        additionalProperties: true,
-    },
+    metadata: defaultMetadataSchema,
 };
 export const entityFileSchema = {
     type: 'object',
@@ -246,39 +224,46 @@ export const entityFileSchema = {
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'user' }, metadata: userMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
+            nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-operation' }, metadata: apiOperationMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'data-schema' }, metadata: dataSchemaMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-description' }, metadata: apiDescriptionMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.SERVICE_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'service' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.DOMAIN_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'domain' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
+            nodeTypeName: NODE_TYPE_NAMES.TEAM_ENTITY,
             properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'team' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
@@ -287,6 +272,7 @@ export const entityFileSchema = {
 };
 export const entityFileDefaultSchema = {
     type: 'object',
+    nodeTypeName: NODE_TYPE_NAMES.ENTITY,
     properties: Object.assign({}, entityBaseProperties),
     required: ['key', 'title', 'type'],
     additionalProperties: false,

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

@@ -3,6 +3,6 @@ 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';
 //# sourceMappingURL=index.js.map

package/lib-esm/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-esm/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-esm/scorecards-config-schema.js

@@ -205,6 +205,7 @@ export const scorecardSchema = {
     type: 'object',
     properties: {
         name: { type: 'string' },
+        key: { type: 'string' },
         description: { type: 'string' },
         entities: {
             oneOf: [
@@ -227,7 +228,7 @@ export const scorecardSchema = {
         },
         trigger: triggerSchema,
     },
-    required: ['name', 'entities', 'levels'],
+    required: ['name', 'key', 'entities', 'levels'],
     additionalProperties: false,
 };
 export const scorecardsConfigSchema = {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@redocly/config",
-  "version": "0.41.2",
+  "version": "0.41.3",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
   "types": "./lib/index.d.ts",
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
-    "@redocly/openapi-core": "2.14.3",
+    "@redocly/openapi-core": "0.0.0-snapshot.1769511679",
     "@types/node": "22.18.13",
     "@types/react": "^19.2.7",
     "@vitest/coverage-v8": "4.0.10",
@@ -22,7 +22,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.lib-esm.json",
-    "build": "npm run clean && npm run compile",
+    "build": "pnpm run clean && pnpm run compile",
     "test": "vitest run src"
   }
 }

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

@@ -1,3 +0,0 @@
-export type ScorecardsConfig = {
-    test: boolean;
-};

package/lib/types/scorecards-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=scorecards-types.js.map

package/lib-esm/types/scorecards-types.d.ts

@@ -1,3 +0,0 @@
-export type ScorecardsConfig = {
-    test: boolean;
-};

package/lib-esm/types/scorecards-types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=scorecards-types.js.map