@redocly/config 0.36.1 → 0.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/default-theme-config-schema.d.ts +3 -3
- package/lib/entities-catalog-entity-file-schema.d.ts +670 -409
- package/lib/entities-catalog-entity-file-schema.js +36 -26
- package/lib/ex-theme-config-schemas.d.ts +3 -3
- package/lib/ex-theme-config-schemas.js +3 -3
- package/lib/root-config-schema.d.ts +14 -14
- package/lib/types/portal-shared-types.d.ts +2 -2
- package/lib-esm/default-theme-config-schema.d.ts +3 -3
- package/lib-esm/entities-catalog-entity-file-schema.d.ts +670 -409
- package/lib-esm/entities-catalog-entity-file-schema.js +35 -25
- package/lib-esm/ex-theme-config-schemas.d.ts +3 -3
- package/lib-esm/ex-theme-config-schemas.js +3 -3
- package/lib-esm/root-config-schema.d.ts +14 -14
- package/lib-esm/types/portal-shared-types.d.ts +2 -2
- package/package.json +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.entityFileSchema = exports.entityBaseProperties = exports.entityRelationFileSchema = exports.entityLinkFileSchema = exports.entityContactFileSchema = exports.slackContactFileSchema = exports.slackChannelFileSchema = exports.defaultMetadataSchema = exports.dataSchemaMetadataSchema = exports.apiOperationMetadataSchema = exports.apiDescriptionMetadataSchema = exports.userMetadataSchema = void 0;
|
|
3
|
+
exports.entityFileDefaultSchema = exports.entityFileSchema = exports.entityBaseProperties = exports.entityRelationFileSchema = exports.entityLinkFileSchema = exports.entityContactFileSchema = exports.slackContactFileSchema = exports.slackChannelFileSchema = exports.defaultMetadataSchema = exports.dataSchemaMetadataSchema = exports.apiOperationMetadataSchema = exports.apiDescriptionMetadataSchema = exports.userMetadataSchema = void 0;
|
|
4
4
|
const constants_1 = require("./constants");
|
|
5
5
|
exports.userMetadataSchema = {
|
|
6
6
|
type: 'object',
|
|
@@ -76,7 +76,6 @@ exports.dataSchemaMetadataSchema = {
|
|
|
76
76
|
description: 'SDL of the data structure',
|
|
77
77
|
},
|
|
78
78
|
},
|
|
79
|
-
anyOf: [{ required: ['schema'] }, { required: ['sdl'] }],
|
|
80
79
|
required: ['specType'],
|
|
81
80
|
additionalProperties: true,
|
|
82
81
|
};
|
|
@@ -188,18 +187,22 @@ exports.entityBaseProperties = {
|
|
|
188
187
|
minLength: 2,
|
|
189
188
|
maxLength: 150,
|
|
190
189
|
},
|
|
190
|
+
type: {
|
|
191
|
+
type: 'string',
|
|
192
|
+
enum: ['user', 'data-schema', 'api-operation', 'api-description', 'service', 'domain', 'team'],
|
|
193
|
+
},
|
|
191
194
|
title: {
|
|
192
195
|
type: 'string',
|
|
193
196
|
minLength: 2,
|
|
194
197
|
maxLength: 200,
|
|
195
198
|
},
|
|
196
199
|
summary: {
|
|
197
|
-
type:
|
|
200
|
+
type: 'string',
|
|
198
201
|
minLength: 1,
|
|
199
202
|
maxLength: 500,
|
|
200
203
|
},
|
|
201
204
|
tags: {
|
|
202
|
-
type:
|
|
205
|
+
type: 'array',
|
|
203
206
|
items: {
|
|
204
207
|
type: 'string',
|
|
205
208
|
minLength: 1,
|
|
@@ -207,31 +210,23 @@ exports.entityBaseProperties = {
|
|
|
207
210
|
},
|
|
208
211
|
},
|
|
209
212
|
git: {
|
|
210
|
-
type:
|
|
213
|
+
type: 'array',
|
|
211
214
|
items: {
|
|
212
215
|
type: 'string',
|
|
213
216
|
},
|
|
214
217
|
},
|
|
215
|
-
contact:
|
|
216
|
-
anyOf: [{ type: 'null' }, exports.entityContactFileSchema],
|
|
217
|
-
},
|
|
218
|
+
contact: exports.entityContactFileSchema,
|
|
218
219
|
links: {
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
{
|
|
222
|
-
type: 'array',
|
|
223
|
-
items: exports.entityLinkFileSchema,
|
|
224
|
-
},
|
|
225
|
-
],
|
|
220
|
+
type: 'array',
|
|
221
|
+
items: exports.entityLinkFileSchema,
|
|
226
222
|
},
|
|
227
223
|
relations: {
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
],
|
|
224
|
+
type: 'array',
|
|
225
|
+
items: exports.entityRelationFileSchema,
|
|
226
|
+
},
|
|
227
|
+
metadata: {
|
|
228
|
+
type: 'object',
|
|
229
|
+
additionalProperties: true,
|
|
235
230
|
},
|
|
236
231
|
};
|
|
237
232
|
exports.entityFileSchema = {
|
|
@@ -266,13 +261,28 @@ exports.entityFileSchema = {
|
|
|
266
261
|
},
|
|
267
262
|
{
|
|
268
263
|
type: 'object',
|
|
269
|
-
properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: {
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
264
|
+
properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
|
|
265
|
+
required: ['key', 'title', 'type'],
|
|
266
|
+
additionalProperties: false,
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
type: 'object',
|
|
270
|
+
properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
|
|
271
|
+
required: ['key', 'title', 'type'],
|
|
272
|
+
additionalProperties: false,
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
type: 'object',
|
|
276
|
+
properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
|
|
273
277
|
required: ['key', 'title', 'type'],
|
|
274
278
|
additionalProperties: false,
|
|
275
279
|
},
|
|
276
280
|
],
|
|
277
281
|
};
|
|
282
|
+
exports.entityFileDefaultSchema = {
|
|
283
|
+
type: 'object',
|
|
284
|
+
properties: Object.assign({}, exports.entityBaseProperties),
|
|
285
|
+
required: ['key', 'title', 'type'],
|
|
286
|
+
additionalProperties: false,
|
|
287
|
+
};
|
|
278
288
|
//# sourceMappingURL=entities-catalog-entity-file-schema.js.map
|
|
@@ -1022,7 +1022,7 @@ export declare const aiAssistantSchema: {
|
|
|
1022
1022
|
readonly inputIcon: {
|
|
1023
1023
|
readonly type: "string";
|
|
1024
1024
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
1025
|
-
readonly default: "
|
|
1025
|
+
readonly default: "sparkles";
|
|
1026
1026
|
};
|
|
1027
1027
|
};
|
|
1028
1028
|
readonly additionalProperties: false;
|
|
@@ -1085,9 +1085,9 @@ export declare const navigationConfigSchema: {
|
|
|
1085
1085
|
readonly type: "array";
|
|
1086
1086
|
readonly items: {
|
|
1087
1087
|
readonly type: "string";
|
|
1088
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1088
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1089
1089
|
};
|
|
1090
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1090
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1091
1091
|
};
|
|
1092
1092
|
readonly hide: {
|
|
1093
1093
|
readonly type: "boolean";
|
|
@@ -257,7 +257,7 @@ exports.aiAssistantSchema = {
|
|
|
257
257
|
inputIcon: {
|
|
258
258
|
type: 'string',
|
|
259
259
|
enum: ['chat', 'sparkles', 'redocly'],
|
|
260
|
-
default: '
|
|
260
|
+
default: 'sparkles',
|
|
261
261
|
},
|
|
262
262
|
},
|
|
263
263
|
additionalProperties: false,
|
|
@@ -280,9 +280,9 @@ const navigationActionsConfigSchema = {
|
|
|
280
280
|
type: 'array',
|
|
281
281
|
items: {
|
|
282
282
|
type: 'string',
|
|
283
|
-
enum: ['copy', 'view', 'chatgpt', 'claude'],
|
|
283
|
+
enum: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
|
|
284
284
|
},
|
|
285
|
-
default: ['copy', 'view', 'chatgpt', 'claude'],
|
|
285
|
+
default: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
|
|
286
286
|
} }),
|
|
287
287
|
additionalProperties: false,
|
|
288
288
|
};
|
|
@@ -7342,7 +7342,7 @@ export declare const redoclyConfigSchema: {
|
|
|
7342
7342
|
readonly inputIcon: {
|
|
7343
7343
|
readonly type: "string";
|
|
7344
7344
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
7345
|
-
readonly default: "
|
|
7345
|
+
readonly default: "sparkles";
|
|
7346
7346
|
};
|
|
7347
7347
|
};
|
|
7348
7348
|
readonly additionalProperties: false;
|
|
@@ -7405,9 +7405,9 @@ export declare const redoclyConfigSchema: {
|
|
|
7405
7405
|
readonly type: "array";
|
|
7406
7406
|
readonly items: {
|
|
7407
7407
|
readonly type: "string";
|
|
7408
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
7408
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
7409
7409
|
};
|
|
7410
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
7410
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
7411
7411
|
};
|
|
7412
7412
|
readonly hide: {
|
|
7413
7413
|
readonly type: "boolean";
|
|
@@ -12987,7 +12987,7 @@ export declare const redoclyConfigSchema: {
|
|
|
12987
12987
|
readonly inputIcon: {
|
|
12988
12988
|
readonly type: "string";
|
|
12989
12989
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
12990
|
-
readonly default: "
|
|
12990
|
+
readonly default: "sparkles";
|
|
12991
12991
|
};
|
|
12992
12992
|
};
|
|
12993
12993
|
readonly additionalProperties: false;
|
|
@@ -13050,9 +13050,9 @@ export declare const redoclyConfigSchema: {
|
|
|
13050
13050
|
readonly type: "array";
|
|
13051
13051
|
readonly items: {
|
|
13052
13052
|
readonly type: "string";
|
|
13053
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
13053
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
13054
13054
|
};
|
|
13055
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
13055
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
13056
13056
|
};
|
|
13057
13057
|
readonly hide: {
|
|
13058
13058
|
readonly type: "boolean";
|
|
@@ -25141,7 +25141,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
25141
25141
|
properties: {
|
|
25142
25142
|
items: {
|
|
25143
25143
|
items: {
|
|
25144
|
-
enum: ("copy" | "view" | "chatgpt" | "claude")[];
|
|
25144
|
+
enum: ("copy" | "view" | "chatgpt" | "claude" | "docs-mcp-cursor" | "docs-mcp-vscode")[];
|
|
25145
25145
|
type: "string";
|
|
25146
25146
|
};
|
|
25147
25147
|
type: "array";
|
|
@@ -30166,7 +30166,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
30166
30166
|
properties: {
|
|
30167
30167
|
items: {
|
|
30168
30168
|
items: {
|
|
30169
|
-
enum: ("copy" | "view" | "chatgpt" | "claude")[];
|
|
30169
|
+
enum: ("copy" | "view" | "chatgpt" | "claude" | "docs-mcp-cursor" | "docs-mcp-vscode")[];
|
|
30170
30170
|
type: "string";
|
|
30171
30171
|
};
|
|
30172
30172
|
type: "array";
|
|
@@ -35837,7 +35837,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35837
35837
|
readonly inputIcon: {
|
|
35838
35838
|
readonly type: "string";
|
|
35839
35839
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
35840
|
-
readonly default: "
|
|
35840
|
+
readonly default: "sparkles";
|
|
35841
35841
|
};
|
|
35842
35842
|
};
|
|
35843
35843
|
readonly additionalProperties: false;
|
|
@@ -35900,9 +35900,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35900
35900
|
readonly type: "array";
|
|
35901
35901
|
readonly items: {
|
|
35902
35902
|
readonly type: "string";
|
|
35903
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
35903
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
35904
35904
|
};
|
|
35905
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
35905
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
35906
35906
|
};
|
|
35907
35907
|
readonly hide: {
|
|
35908
35908
|
readonly type: "boolean";
|
|
@@ -41482,7 +41482,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
41482
41482
|
readonly inputIcon: {
|
|
41483
41483
|
readonly type: "string";
|
|
41484
41484
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
41485
|
-
readonly default: "
|
|
41485
|
+
readonly default: "sparkles";
|
|
41486
41486
|
};
|
|
41487
41487
|
};
|
|
41488
41488
|
readonly additionalProperties: false;
|
|
@@ -41545,9 +41545,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
41545
41545
|
readonly type: "array";
|
|
41546
41546
|
readonly items: {
|
|
41547
41547
|
readonly type: "string";
|
|
41548
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
41548
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
41549
41549
|
};
|
|
41550
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
41550
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
41551
41551
|
};
|
|
41552
41552
|
readonly hide: {
|
|
41553
41553
|
readonly type: "boolean";
|
|
@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
|
|
|
3
3
|
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
|
|
4
4
|
import type { CatalogEntityConfig } from './catalog-entity-types';
|
|
5
5
|
export * from './code-walkthrough-types';
|
|
6
|
-
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'entitiesCatalog'> & {
|
|
6
|
+
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'entitiesCatalog' | 'mcp'> & {
|
|
7
7
|
auth?: {
|
|
8
8
|
idpsInfo?: {
|
|
9
9
|
idpId: string;
|
|
@@ -170,7 +170,7 @@ export type PageProps = {
|
|
|
170
170
|
frontmatter?: Omit<PageProps, 'frontmatter'> & {
|
|
171
171
|
settings?: any;
|
|
172
172
|
} & Partial<UiAccessibleConfig> & {
|
|
173
|
-
navigation?: {
|
|
173
|
+
navigation?: Partial<UiAccessibleConfig['navigation']> & {
|
|
174
174
|
nextButton?: {
|
|
175
175
|
link?: string;
|
|
176
176
|
label?: string;
|
|
@@ -989,7 +989,7 @@ export declare const themeConfigSchema: {
|
|
|
989
989
|
readonly inputIcon: {
|
|
990
990
|
readonly type: "string";
|
|
991
991
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
992
|
-
readonly default: "
|
|
992
|
+
readonly default: "sparkles";
|
|
993
993
|
};
|
|
994
994
|
};
|
|
995
995
|
readonly additionalProperties: false;
|
|
@@ -1052,9 +1052,9 @@ export declare const themeConfigSchema: {
|
|
|
1052
1052
|
readonly type: "array";
|
|
1053
1053
|
readonly items: {
|
|
1054
1054
|
readonly type: "string";
|
|
1055
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1055
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1056
1056
|
};
|
|
1057
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1057
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1058
1058
|
};
|
|
1059
1059
|
readonly hide: {
|
|
1060
1060
|
readonly type: "boolean";
|