@redocly/config 0.44.2 → 0.46.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 +4 -0
- package/lib/default-theme-config-schema.js +1 -0
- package/lib/ex-theme-config-schemas.d.ts +4 -0
- package/lib/ex-theme-config-schemas.js +5 -1
- package/lib/product-override-schema.d.ts +3 -1
- package/lib/root-config-schema.d.ts +36 -4
- package/lib/root-config-schema.js +2 -2
- package/lib/types/portal-shared-types.d.ts +3 -2
- package/lib-esm/default-theme-config-schema.d.ts +4 -0
- package/lib-esm/default-theme-config-schema.js +2 -1
- package/lib-esm/ex-theme-config-schemas.d.ts +4 -0
- package/lib-esm/ex-theme-config-schemas.js +4 -0
- package/lib-esm/product-override-schema.d.ts +3 -1
- package/lib-esm/root-config-schema.d.ts +36 -4
- package/lib-esm/root-config-schema.js +3 -3
- package/lib-esm/types/portal-shared-types.d.ts +3 -2
- package/package.json +2 -2
|
@@ -1016,6 +1016,10 @@ export declare const themeConfigSchema: {
|
|
|
1016
1016
|
};
|
|
1017
1017
|
readonly additionalProperties: false;
|
|
1018
1018
|
};
|
|
1019
|
+
readonly palette: {
|
|
1020
|
+
readonly type: "string";
|
|
1021
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
1022
|
+
};
|
|
1019
1023
|
readonly navigation: {
|
|
1020
1024
|
readonly type: "object";
|
|
1021
1025
|
readonly properties: {
|
|
@@ -28,6 +28,7 @@ exports.themeConfigSchema = {
|
|
|
28
28
|
search: ex_theme_config_schemas_1.searchConfigSchema,
|
|
29
29
|
aiAssistant: ex_theme_config_schemas_1.aiAssistantSchema,
|
|
30
30
|
colorMode: ex_theme_config_schemas_1.colorModeConfigSchema,
|
|
31
|
+
palette: ex_theme_config_schemas_1.paletteConfigSchema,
|
|
31
32
|
navigation: ex_theme_config_schemas_1.navigationConfigSchema,
|
|
32
33
|
codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema,
|
|
33
34
|
markdown: ex_theme_config_schemas_1.markdownConfigSchema,
|
|
@@ -1049,6 +1049,10 @@ export declare const colorModeConfigSchema: {
|
|
|
1049
1049
|
};
|
|
1050
1050
|
readonly additionalProperties: false;
|
|
1051
1051
|
};
|
|
1052
|
+
export declare const paletteConfigSchema: {
|
|
1053
|
+
readonly type: "string";
|
|
1054
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
1055
|
+
};
|
|
1052
1056
|
export declare const navigationConfigSchema: {
|
|
1053
1057
|
readonly type: "object";
|
|
1054
1058
|
readonly properties: {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.asyncapiConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.aiAssistantSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
3
|
+
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.asyncapiConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.paletteConfigSchema = exports.colorModeConfigSchema = exports.aiAssistantSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
4
4
|
const redoc_config_schema_1 = require("./redoc-config-schema");
|
|
5
5
|
const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
|
|
6
6
|
const common_1 = require("./common");
|
|
@@ -275,6 +275,10 @@ exports.colorModeConfigSchema = {
|
|
|
275
275
|
} }, hideConfigSchema.properties),
|
|
276
276
|
additionalProperties: false,
|
|
277
277
|
};
|
|
278
|
+
exports.paletteConfigSchema = {
|
|
279
|
+
type: 'string',
|
|
280
|
+
enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris'],
|
|
281
|
+
};
|
|
278
282
|
const navigationActionsConfigSchema = {
|
|
279
283
|
type: 'object',
|
|
280
284
|
properties: Object.assign(Object.assign({}, hideConfigSchema.properties), { items: {
|
|
@@ -3007,7 +3007,9 @@ export declare const productConfigOverrideSchema: {
|
|
|
3007
3007
|
};
|
|
3008
3008
|
readonly rbac: {
|
|
3009
3009
|
readonly type: "object";
|
|
3010
|
-
readonly additionalProperties:
|
|
3010
|
+
readonly additionalProperties: {
|
|
3011
|
+
readonly type: "string";
|
|
3012
|
+
};
|
|
3011
3013
|
};
|
|
3012
3014
|
readonly openapi: {
|
|
3013
3015
|
readonly properties: {
|
|
@@ -826,7 +826,9 @@ export declare const apiConfigSchema: {
|
|
|
826
826
|
};
|
|
827
827
|
readonly rbac: {
|
|
828
828
|
readonly type: "object";
|
|
829
|
-
readonly additionalProperties:
|
|
829
|
+
readonly additionalProperties: {
|
|
830
|
+
readonly type: "string";
|
|
831
|
+
};
|
|
830
832
|
};
|
|
831
833
|
readonly openapi: {
|
|
832
834
|
readonly properties: {
|
|
@@ -8458,6 +8460,10 @@ export declare const redoclyConfigSchema: {
|
|
|
8458
8460
|
};
|
|
8459
8461
|
readonly additionalProperties: false;
|
|
8460
8462
|
};
|
|
8463
|
+
readonly palette: {
|
|
8464
|
+
readonly type: "string";
|
|
8465
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
8466
|
+
};
|
|
8461
8467
|
readonly navigation: {
|
|
8462
8468
|
readonly type: "object";
|
|
8463
8469
|
readonly properties: {
|
|
@@ -15475,6 +15481,10 @@ export declare const redoclyConfigSchema: {
|
|
|
15475
15481
|
};
|
|
15476
15482
|
readonly additionalProperties: false;
|
|
15477
15483
|
};
|
|
15484
|
+
readonly palette: {
|
|
15485
|
+
readonly type: "string";
|
|
15486
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
15487
|
+
};
|
|
15478
15488
|
readonly navigation: {
|
|
15479
15489
|
readonly type: "object";
|
|
15480
15490
|
readonly properties: {
|
|
@@ -22099,7 +22109,9 @@ export declare const redoclyConfigSchema: {
|
|
|
22099
22109
|
};
|
|
22100
22110
|
readonly rbac: {
|
|
22101
22111
|
readonly type: "object";
|
|
22102
|
-
readonly additionalProperties:
|
|
22112
|
+
readonly additionalProperties: {
|
|
22113
|
+
readonly type: "string";
|
|
22114
|
+
};
|
|
22103
22115
|
};
|
|
22104
22116
|
readonly openapi: {
|
|
22105
22117
|
readonly properties: {
|
|
@@ -29356,6 +29368,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
29356
29368
|
additionalProperties: false;
|
|
29357
29369
|
type: "object";
|
|
29358
29370
|
};
|
|
29371
|
+
palette: {
|
|
29372
|
+
enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
|
|
29373
|
+
type: "string";
|
|
29374
|
+
};
|
|
29359
29375
|
navigation: {
|
|
29360
29376
|
properties: {
|
|
29361
29377
|
nextButton: {
|
|
@@ -35232,6 +35248,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35232
35248
|
additionalProperties: false;
|
|
35233
35249
|
type: "object";
|
|
35234
35250
|
};
|
|
35251
|
+
palette: {
|
|
35252
|
+
enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
|
|
35253
|
+
type: "string";
|
|
35254
|
+
};
|
|
35235
35255
|
navigation: {
|
|
35236
35256
|
properties: {
|
|
35237
35257
|
nextButton: {
|
|
@@ -40435,7 +40455,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
40435
40455
|
type: "string";
|
|
40436
40456
|
};
|
|
40437
40457
|
rbac: {
|
|
40438
|
-
additionalProperties:
|
|
40458
|
+
additionalProperties: {
|
|
40459
|
+
type: "string";
|
|
40460
|
+
};
|
|
40439
40461
|
type: "object";
|
|
40440
40462
|
};
|
|
40441
40463
|
output: {
|
|
@@ -42180,6 +42202,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
42180
42202
|
};
|
|
42181
42203
|
readonly additionalProperties: false;
|
|
42182
42204
|
};
|
|
42205
|
+
readonly palette: {
|
|
42206
|
+
readonly type: "string";
|
|
42207
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
42208
|
+
};
|
|
42183
42209
|
readonly navigation: {
|
|
42184
42210
|
readonly type: "object";
|
|
42185
42211
|
readonly properties: {
|
|
@@ -49197,6 +49223,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
49197
49223
|
};
|
|
49198
49224
|
readonly additionalProperties: false;
|
|
49199
49225
|
};
|
|
49226
|
+
readonly palette: {
|
|
49227
|
+
readonly type: "string";
|
|
49228
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
49229
|
+
};
|
|
49200
49230
|
readonly navigation: {
|
|
49201
49231
|
readonly type: "object";
|
|
49202
49232
|
readonly properties: {
|
|
@@ -55821,7 +55851,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
55821
55851
|
};
|
|
55822
55852
|
readonly rbac: {
|
|
55823
55853
|
readonly type: "object";
|
|
55824
|
-
readonly additionalProperties:
|
|
55854
|
+
readonly additionalProperties: {
|
|
55855
|
+
readonly type: "string";
|
|
55856
|
+
};
|
|
55825
55857
|
};
|
|
55826
55858
|
readonly openapi: {
|
|
55827
55859
|
readonly properties: {
|
|
@@ -137,7 +137,7 @@ exports.bannersConfigSchema = {
|
|
|
137
137
|
};
|
|
138
138
|
exports.apiConfigSchema = {
|
|
139
139
|
type: 'object',
|
|
140
|
-
properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac:
|
|
140
|
+
properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: exports.rbacScopeItemsSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema,
|
|
141
141
|
/**
|
|
142
142
|
* @deprecated left for backwards compatibility
|
|
143
143
|
*/
|
|
@@ -555,7 +555,7 @@ exports.redoclyConfigSchema = {
|
|
|
555
555
|
*/
|
|
556
556
|
theme: default_theme_config_schema_1.themeConfigSchema, reunite: reunite_config_schema_1.reuniteConfigSchema,
|
|
557
557
|
// Ex theme properties
|
|
558
|
-
logo: ex_theme_config_schemas_1.logoConfigSchema, navbar: ex_theme_config_schemas_1.navbarConfigSchema, products: ex_theme_config_schemas_1.productsConfigSchema, footer: ex_theme_config_schemas_1.footerConfigSchema, sidebar: ex_theme_config_schemas_1.sidebarConfigSchema, scripts: ex_theme_config_schemas_1.scriptsConfigSchema, links: ex_theme_config_schemas_1.linksConfigSchema, feedback: feedback_config_schema_1.feedbackConfigSchema, search: ex_theme_config_schemas_1.searchConfigSchema, aiAssistant: ex_theme_config_schemas_1.aiAssistantSchema, colorMode: ex_theme_config_schemas_1.colorModeConfigSchema, navigation: ex_theme_config_schemas_1.navigationConfigSchema, codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema, markdown: ex_theme_config_schemas_1.markdownConfigSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, analytics: ex_theme_config_schemas_1.analyticsConfigSchema, userMenu: ex_theme_config_schemas_1.userMenuConfigSchema, versionPicker: ex_theme_config_schemas_1.versionPickerConfigSchema, breadcrumbs: ex_theme_config_schemas_1.breadcrumbsConfigSchema,
|
|
558
|
+
logo: ex_theme_config_schemas_1.logoConfigSchema, navbar: ex_theme_config_schemas_1.navbarConfigSchema, products: ex_theme_config_schemas_1.productsConfigSchema, footer: ex_theme_config_schemas_1.footerConfigSchema, sidebar: ex_theme_config_schemas_1.sidebarConfigSchema, scripts: ex_theme_config_schemas_1.scriptsConfigSchema, links: ex_theme_config_schemas_1.linksConfigSchema, feedback: feedback_config_schema_1.feedbackConfigSchema, search: ex_theme_config_schemas_1.searchConfigSchema, aiAssistant: ex_theme_config_schemas_1.aiAssistantSchema, colorMode: ex_theme_config_schemas_1.colorModeConfigSchema, palette: ex_theme_config_schemas_1.paletteConfigSchema, navigation: ex_theme_config_schemas_1.navigationConfigSchema, codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema, markdown: ex_theme_config_schemas_1.markdownConfigSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, analytics: ex_theme_config_schemas_1.analyticsConfigSchema, userMenu: ex_theme_config_schemas_1.userMenuConfigSchema, versionPicker: ex_theme_config_schemas_1.versionPickerConfigSchema, breadcrumbs: ex_theme_config_schemas_1.breadcrumbsConfigSchema,
|
|
559
559
|
/**
|
|
560
560
|
* @deprecated Should use `catalogClassic` instead
|
|
561
561
|
*/
|
|
@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
|
|
|
3
3
|
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } 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' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
|
|
6
|
+
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'palette' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
|
|
7
7
|
auth?: {
|
|
8
8
|
idpsInfo?: {
|
|
9
9
|
idpId: string;
|
|
@@ -158,8 +158,9 @@ export type ResolvedSidebar = {
|
|
|
158
158
|
catalogConfig?: CatalogEntityConfig;
|
|
159
159
|
};
|
|
160
160
|
};
|
|
161
|
-
export type ResolvedBannerConfig = BannerConfig & {
|
|
161
|
+
export type ResolvedBannerConfig = Omit<BannerConfig, 'content'> & {
|
|
162
162
|
ast: unknown;
|
|
163
|
+
hash: string;
|
|
163
164
|
};
|
|
164
165
|
export type CompilationError = {
|
|
165
166
|
message: string;
|
|
@@ -1016,6 +1016,10 @@ export declare const themeConfigSchema: {
|
|
|
1016
1016
|
};
|
|
1017
1017
|
readonly additionalProperties: false;
|
|
1018
1018
|
};
|
|
1019
|
+
readonly palette: {
|
|
1020
|
+
readonly type: "string";
|
|
1021
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
1022
|
+
};
|
|
1019
1023
|
readonly navigation: {
|
|
1020
1024
|
readonly type: "object";
|
|
1021
1025
|
readonly properties: {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { graphqlConfigSchema } from './graphql-config-schema';
|
|
2
2
|
import { asyncapiConfigSchema } from './asyncapi-config-schema';
|
|
3
3
|
import { feedbackConfigSchema } from './feedback-config-schema';
|
|
4
|
-
import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
|
|
4
|
+
import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, paletteConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
|
|
5
5
|
import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
|
|
6
6
|
import { scorecardsConfigSchema } from './scorecards-config-schema';
|
|
7
7
|
export const themeConfigSchema = {
|
|
@@ -25,6 +25,7 @@ export const themeConfigSchema = {
|
|
|
25
25
|
search: searchConfigSchema,
|
|
26
26
|
aiAssistant: aiAssistantSchema,
|
|
27
27
|
colorMode: colorModeConfigSchema,
|
|
28
|
+
palette: paletteConfigSchema,
|
|
28
29
|
navigation: navigationConfigSchema,
|
|
29
30
|
codeSnippet: codeSnippetConfigSchema,
|
|
30
31
|
markdown: markdownConfigSchema,
|
|
@@ -1049,6 +1049,10 @@ export declare const colorModeConfigSchema: {
|
|
|
1049
1049
|
};
|
|
1050
1050
|
readonly additionalProperties: false;
|
|
1051
1051
|
};
|
|
1052
|
+
export declare const paletteConfigSchema: {
|
|
1053
|
+
readonly type: "string";
|
|
1054
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
1055
|
+
};
|
|
1052
1056
|
export declare const navigationConfigSchema: {
|
|
1053
1057
|
readonly type: "object";
|
|
1054
1058
|
readonly properties: {
|
|
@@ -272,6 +272,10 @@ export const colorModeConfigSchema = {
|
|
|
272
272
|
} }, hideConfigSchema.properties),
|
|
273
273
|
additionalProperties: false,
|
|
274
274
|
};
|
|
275
|
+
export const paletteConfigSchema = {
|
|
276
|
+
type: 'string',
|
|
277
|
+
enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris'],
|
|
278
|
+
};
|
|
275
279
|
const navigationActionsConfigSchema = {
|
|
276
280
|
type: 'object',
|
|
277
281
|
properties: Object.assign(Object.assign({}, hideConfigSchema.properties), { items: {
|
|
@@ -3007,7 +3007,9 @@ export declare const productConfigOverrideSchema: {
|
|
|
3007
3007
|
};
|
|
3008
3008
|
readonly rbac: {
|
|
3009
3009
|
readonly type: "object";
|
|
3010
|
-
readonly additionalProperties:
|
|
3010
|
+
readonly additionalProperties: {
|
|
3011
|
+
readonly type: "string";
|
|
3012
|
+
};
|
|
3011
3013
|
};
|
|
3012
3014
|
readonly openapi: {
|
|
3013
3015
|
readonly properties: {
|
|
@@ -826,7 +826,9 @@ export declare const apiConfigSchema: {
|
|
|
826
826
|
};
|
|
827
827
|
readonly rbac: {
|
|
828
828
|
readonly type: "object";
|
|
829
|
-
readonly additionalProperties:
|
|
829
|
+
readonly additionalProperties: {
|
|
830
|
+
readonly type: "string";
|
|
831
|
+
};
|
|
830
832
|
};
|
|
831
833
|
readonly openapi: {
|
|
832
834
|
readonly properties: {
|
|
@@ -8458,6 +8460,10 @@ export declare const redoclyConfigSchema: {
|
|
|
8458
8460
|
};
|
|
8459
8461
|
readonly additionalProperties: false;
|
|
8460
8462
|
};
|
|
8463
|
+
readonly palette: {
|
|
8464
|
+
readonly type: "string";
|
|
8465
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
8466
|
+
};
|
|
8461
8467
|
readonly navigation: {
|
|
8462
8468
|
readonly type: "object";
|
|
8463
8469
|
readonly properties: {
|
|
@@ -15475,6 +15481,10 @@ export declare const redoclyConfigSchema: {
|
|
|
15475
15481
|
};
|
|
15476
15482
|
readonly additionalProperties: false;
|
|
15477
15483
|
};
|
|
15484
|
+
readonly palette: {
|
|
15485
|
+
readonly type: "string";
|
|
15486
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
15487
|
+
};
|
|
15478
15488
|
readonly navigation: {
|
|
15479
15489
|
readonly type: "object";
|
|
15480
15490
|
readonly properties: {
|
|
@@ -22099,7 +22109,9 @@ export declare const redoclyConfigSchema: {
|
|
|
22099
22109
|
};
|
|
22100
22110
|
readonly rbac: {
|
|
22101
22111
|
readonly type: "object";
|
|
22102
|
-
readonly additionalProperties:
|
|
22112
|
+
readonly additionalProperties: {
|
|
22113
|
+
readonly type: "string";
|
|
22114
|
+
};
|
|
22103
22115
|
};
|
|
22104
22116
|
readonly openapi: {
|
|
22105
22117
|
readonly properties: {
|
|
@@ -29356,6 +29368,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
29356
29368
|
additionalProperties: false;
|
|
29357
29369
|
type: "object";
|
|
29358
29370
|
};
|
|
29371
|
+
palette: {
|
|
29372
|
+
enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
|
|
29373
|
+
type: "string";
|
|
29374
|
+
};
|
|
29359
29375
|
navigation: {
|
|
29360
29376
|
properties: {
|
|
29361
29377
|
nextButton: {
|
|
@@ -35232,6 +35248,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35232
35248
|
additionalProperties: false;
|
|
35233
35249
|
type: "object";
|
|
35234
35250
|
};
|
|
35251
|
+
palette: {
|
|
35252
|
+
enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
|
|
35253
|
+
type: "string";
|
|
35254
|
+
};
|
|
35235
35255
|
navigation: {
|
|
35236
35256
|
properties: {
|
|
35237
35257
|
nextButton: {
|
|
@@ -40435,7 +40455,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
40435
40455
|
type: "string";
|
|
40436
40456
|
};
|
|
40437
40457
|
rbac: {
|
|
40438
|
-
additionalProperties:
|
|
40458
|
+
additionalProperties: {
|
|
40459
|
+
type: "string";
|
|
40460
|
+
};
|
|
40439
40461
|
type: "object";
|
|
40440
40462
|
};
|
|
40441
40463
|
output: {
|
|
@@ -42180,6 +42202,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
42180
42202
|
};
|
|
42181
42203
|
readonly additionalProperties: false;
|
|
42182
42204
|
};
|
|
42205
|
+
readonly palette: {
|
|
42206
|
+
readonly type: "string";
|
|
42207
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
42208
|
+
};
|
|
42183
42209
|
readonly navigation: {
|
|
42184
42210
|
readonly type: "object";
|
|
42185
42211
|
readonly properties: {
|
|
@@ -49197,6 +49223,10 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
49197
49223
|
};
|
|
49198
49224
|
readonly additionalProperties: false;
|
|
49199
49225
|
};
|
|
49226
|
+
readonly palette: {
|
|
49227
|
+
readonly type: "string";
|
|
49228
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
49229
|
+
};
|
|
49200
49230
|
readonly navigation: {
|
|
49201
49231
|
readonly type: "object";
|
|
49202
49232
|
readonly properties: {
|
|
@@ -55821,7 +55851,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
55821
55851
|
};
|
|
55822
55852
|
readonly rbac: {
|
|
55823
55853
|
readonly type: "object";
|
|
55824
|
-
readonly additionalProperties:
|
|
55854
|
+
readonly additionalProperties: {
|
|
55855
|
+
readonly type: "string";
|
|
55856
|
+
};
|
|
55825
55857
|
};
|
|
55826
55858
|
readonly openapi: {
|
|
55827
55859
|
readonly properties: {
|
|
@@ -5,7 +5,7 @@ import { feedbackConfigSchema } from './feedback-config-schema';
|
|
|
5
5
|
import { graphqlConfigSchema } from './graphql-config-schema';
|
|
6
6
|
import { removePropertyRecursively } from './remove-property-recursively';
|
|
7
7
|
import { reuniteConfigSchema } from './reunite-config-schema';
|
|
8
|
-
import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
|
|
8
|
+
import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, paletteConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
|
|
9
9
|
import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
|
|
10
10
|
import { scorecardsConfigSchema } from './scorecards-config-schema';
|
|
11
11
|
import { configGovernanceSchema } from './common';
|
|
@@ -134,7 +134,7 @@ export const bannersConfigSchema = {
|
|
|
134
134
|
};
|
|
135
135
|
export const apiConfigSchema = {
|
|
136
136
|
type: 'object',
|
|
137
|
-
properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac:
|
|
137
|
+
properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: rbacScopeItemsSchema, openapi: openapiConfigSchema, graphql: graphqlConfigSchema,
|
|
138
138
|
/**
|
|
139
139
|
* @deprecated left for backwards compatibility
|
|
140
140
|
*/
|
|
@@ -552,7 +552,7 @@ export const redoclyConfigSchema = {
|
|
|
552
552
|
*/
|
|
553
553
|
theme: themeConfigSchema, reunite: reuniteConfigSchema,
|
|
554
554
|
// Ex theme properties
|
|
555
|
-
logo: logoConfigSchema, navbar: navbarConfigSchema, products: productsConfigSchema, footer: footerConfigSchema, sidebar: sidebarConfigSchema, scripts: scriptsConfigSchema, links: linksConfigSchema, feedback: feedbackConfigSchema, search: searchConfigSchema, aiAssistant: aiAssistantSchema, colorMode: colorModeConfigSchema, navigation: navigationConfigSchema, codeSnippet: codeSnippetConfigSchema, markdown: markdownConfigSchema, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, analytics: analyticsConfigSchema, userMenu: userMenuConfigSchema, versionPicker: versionPickerConfigSchema, breadcrumbs: breadcrumbsConfigSchema,
|
|
555
|
+
logo: logoConfigSchema, navbar: navbarConfigSchema, products: productsConfigSchema, footer: footerConfigSchema, sidebar: sidebarConfigSchema, scripts: scriptsConfigSchema, links: linksConfigSchema, feedback: feedbackConfigSchema, search: searchConfigSchema, aiAssistant: aiAssistantSchema, colorMode: colorModeConfigSchema, palette: paletteConfigSchema, navigation: navigationConfigSchema, codeSnippet: codeSnippetConfigSchema, markdown: markdownConfigSchema, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, analytics: analyticsConfigSchema, userMenu: userMenuConfigSchema, versionPicker: versionPickerConfigSchema, breadcrumbs: breadcrumbsConfigSchema,
|
|
556
556
|
/**
|
|
557
557
|
* @deprecated Should use `catalogClassic` instead
|
|
558
558
|
*/
|
|
@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
|
|
|
3
3
|
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } 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' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
|
|
6
|
+
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'palette' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
|
|
7
7
|
auth?: {
|
|
8
8
|
idpsInfo?: {
|
|
9
9
|
idpId: string;
|
|
@@ -158,8 +158,9 @@ export type ResolvedSidebar = {
|
|
|
158
158
|
catalogConfig?: CatalogEntityConfig;
|
|
159
159
|
};
|
|
160
160
|
};
|
|
161
|
-
export type ResolvedBannerConfig = BannerConfig & {
|
|
161
|
+
export type ResolvedBannerConfig = Omit<BannerConfig, 'content'> & {
|
|
162
162
|
ast: unknown;
|
|
163
|
+
hash: string;
|
|
163
164
|
};
|
|
164
165
|
export type CompilationError = {
|
|
165
166
|
message: string;
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/config",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.46.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"module": "./lib-esm/index.js",
|
|
7
7
|
"types": "./lib/index.d.ts",
|
|
8
8
|
"devDependencies": {
|
|
9
9
|
"@markdoc/markdoc": "0.5.2",
|
|
10
|
-
"@redocly/openapi-core": "2.
|
|
10
|
+
"@redocly/openapi-core": "2.25.2",
|
|
11
11
|
"@types/node": "22.18.13",
|
|
12
12
|
"@types/react": "^19.2.7",
|
|
13
13
|
"@vitest/coverage-v8": "4.0.10",
|