@redocly/config 0.45.0 → 0.46.1

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.
@@ -1018,8 +1018,7 @@ export declare const themeConfigSchema: {
1018
1018
  };
1019
1019
  readonly palette: {
1020
1020
  readonly type: "string";
1021
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
1022
- readonly default: "default";
1021
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
1023
1022
  };
1024
1023
  readonly navigation: {
1025
1024
  readonly type: "object";
@@ -1051,8 +1051,7 @@ export declare const colorModeConfigSchema: {
1051
1051
  };
1052
1052
  export declare const paletteConfigSchema: {
1053
1053
  readonly type: "string";
1054
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
1055
- readonly default: "default";
1054
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
1056
1055
  };
1057
1056
  export declare const navigationConfigSchema: {
1058
1057
  readonly type: "object";
@@ -277,8 +277,7 @@ exports.colorModeConfigSchema = {
277
277
  };
278
278
  exports.paletteConfigSchema = {
279
279
  type: 'string',
280
- enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris', 'default'],
281
- default: 'default',
280
+ enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris'],
282
281
  };
283
282
  const navigationActionsConfigSchema = {
284
283
  type: 'object',
@@ -2688,6 +2688,10 @@ export declare const productThemeOverrideSchema: {
2688
2688
  };
2689
2689
  readonly additionalProperties: false;
2690
2690
  };
2691
+ readonly palette: {
2692
+ readonly type: "string";
2693
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
2694
+ };
2691
2695
  readonly mockServer: {
2692
2696
  readonly type: "object";
2693
2697
  readonly properties: {
@@ -3007,7 +3011,9 @@ export declare const productConfigOverrideSchema: {
3007
3011
  };
3008
3012
  readonly rbac: {
3009
3013
  readonly type: "object";
3010
- readonly additionalProperties: true;
3014
+ readonly additionalProperties: {
3015
+ readonly type: "string";
3016
+ };
3011
3017
  };
3012
3018
  readonly openapi: {
3013
3019
  readonly properties: {
@@ -10337,6 +10343,10 @@ export declare const productConfigOverrideSchema: {
10337
10343
  };
10338
10344
  readonly additionalProperties: false;
10339
10345
  };
10346
+ readonly palette: {
10347
+ readonly type: "string";
10348
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
10349
+ };
10340
10350
  readonly mockServer: {
10341
10351
  readonly type: "object";
10342
10352
  readonly properties: {
@@ -13086,6 +13096,10 @@ export declare const productConfigOverrideSchema: {
13086
13096
  };
13087
13097
  readonly additionalProperties: false;
13088
13098
  };
13099
+ readonly palette: {
13100
+ readonly type: "string";
13101
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
13102
+ };
13089
13103
  readonly mockServer: {
13090
13104
  readonly type: "object";
13091
13105
  readonly properties: {
@@ -16,6 +16,7 @@ exports.productThemeOverrideSchema = {
16
16
  breadcrumbs: default_theme_config_schema_1.themeConfigSchema.properties.breadcrumbs,
17
17
  openapi: default_theme_config_schema_1.themeConfigSchema.properties.openapi,
18
18
  feedback: default_theme_config_schema_1.themeConfigSchema.properties.feedback,
19
+ palette: ex_theme_config_schemas_1.paletteConfigSchema,
19
20
  mockServer: root_config_schema_1.redoclyConfigSchema.properties.mockServer,
20
21
  analytics: {
21
22
  type: 'object',
@@ -826,7 +826,9 @@ export declare const apiConfigSchema: {
826
826
  };
827
827
  readonly rbac: {
828
828
  readonly type: "object";
829
- readonly additionalProperties: true;
829
+ readonly additionalProperties: {
830
+ readonly type: "string";
831
+ };
830
832
  };
831
833
  readonly openapi: {
832
834
  readonly properties: {
@@ -8460,8 +8462,7 @@ export declare const redoclyConfigSchema: {
8460
8462
  };
8461
8463
  readonly palette: {
8462
8464
  readonly type: "string";
8463
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
8464
- readonly default: "default";
8465
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
8465
8466
  };
8466
8467
  readonly navigation: {
8467
8468
  readonly type: "object";
@@ -15482,8 +15483,7 @@ export declare const redoclyConfigSchema: {
15482
15483
  };
15483
15484
  readonly palette: {
15484
15485
  readonly type: "string";
15485
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
15486
- readonly default: "default";
15486
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
15487
15487
  };
15488
15488
  readonly navigation: {
15489
15489
  readonly type: "object";
@@ -22109,7 +22109,9 @@ export declare const redoclyConfigSchema: {
22109
22109
  };
22110
22110
  readonly rbac: {
22111
22111
  readonly type: "object";
22112
- readonly additionalProperties: true;
22112
+ readonly additionalProperties: {
22113
+ readonly type: "string";
22114
+ };
22113
22115
  };
22114
22116
  readonly openapi: {
22115
22117
  readonly properties: {
@@ -29367,7 +29369,7 @@ export declare const rootRedoclyConfigSchema: {
29367
29369
  type: "object";
29368
29370
  };
29369
29371
  palette: {
29370
- enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29372
+ enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29371
29373
  type: "string";
29372
29374
  };
29373
29375
  navigation: {
@@ -35247,7 +35249,7 @@ export declare const rootRedoclyConfigSchema: {
35247
35249
  type: "object";
35248
35250
  };
35249
35251
  palette: {
35250
- enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35252
+ enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35251
35253
  type: "string";
35252
35254
  };
35253
35255
  navigation: {
@@ -40453,7 +40455,9 @@ export declare const rootRedoclyConfigSchema: {
40453
40455
  type: "string";
40454
40456
  };
40455
40457
  rbac: {
40456
- additionalProperties: true;
40458
+ additionalProperties: {
40459
+ type: "string";
40460
+ };
40457
40461
  type: "object";
40458
40462
  };
40459
40463
  output: {
@@ -42200,8 +42204,7 @@ export declare const rootRedoclyConfigSchema: {
42200
42204
  };
42201
42205
  readonly palette: {
42202
42206
  readonly type: "string";
42203
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
42204
- readonly default: "default";
42207
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
42205
42208
  };
42206
42209
  readonly navigation: {
42207
42210
  readonly type: "object";
@@ -49222,8 +49225,7 @@ export declare const rootRedoclyConfigSchema: {
49222
49225
  };
49223
49226
  readonly palette: {
49224
49227
  readonly type: "string";
49225
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
49226
- readonly default: "default";
49228
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
49227
49229
  };
49228
49230
  readonly navigation: {
49229
49231
  readonly type: "object";
@@ -55849,7 +55851,9 @@ export declare const rootRedoclyConfigSchema: {
55849
55851
  };
55850
55852
  readonly rbac: {
55851
55853
  readonly type: "object";
55852
- readonly additionalProperties: true;
55854
+ readonly additionalProperties: {
55855
+ readonly type: "string";
55856
+ };
55853
55857
  };
55854
55858
  readonly openapi: {
55855
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: { type: 'object', additionalProperties: true }, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema,
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
  */
@@ -27,6 +27,8 @@ export type ApiFunctionsUser = {
27
27
  export type ApiFunctionsContext = {
28
28
  user: ApiFunctionsUser;
29
29
  config: RedoclyConfig;
30
+ outdir?: string;
31
+ baseUrl?: string;
30
32
  params: Record<string, string | string[]>;
31
33
  query: Record<string, string | string[]>;
32
34
  cookies: Record<string, string>;
@@ -318,7 +318,7 @@ export type BreadcrumbItem = {
318
318
  link?: string;
319
319
  icon?: string;
320
320
  };
321
- export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback'> & {
321
+ export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback' | 'palette' | 'mockServer'> & {
322
322
  analytics?: {
323
323
  ga?: ProductGoogleAnalyticsConfig;
324
324
  };
@@ -1018,8 +1018,7 @@ export declare const themeConfigSchema: {
1018
1018
  };
1019
1019
  readonly palette: {
1020
1020
  readonly type: "string";
1021
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
1022
- readonly default: "default";
1021
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
1023
1022
  };
1024
1023
  readonly navigation: {
1025
1024
  readonly type: "object";
@@ -1051,8 +1051,7 @@ export declare const colorModeConfigSchema: {
1051
1051
  };
1052
1052
  export declare const paletteConfigSchema: {
1053
1053
  readonly type: "string";
1054
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
1055
- readonly default: "default";
1054
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
1056
1055
  };
1057
1056
  export declare const navigationConfigSchema: {
1058
1057
  readonly type: "object";
@@ -274,8 +274,7 @@ export const colorModeConfigSchema = {
274
274
  };
275
275
  export const paletteConfigSchema = {
276
276
  type: 'string',
277
- enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris', 'default'],
278
- default: 'default',
277
+ enum: ['slate', 'pink', 'coral', 'amber', 'jade', 'cyan', 'ocean', 'indigo', 'iris'],
279
278
  };
280
279
  const navigationActionsConfigSchema = {
281
280
  type: 'object',
@@ -2688,6 +2688,10 @@ export declare const productThemeOverrideSchema: {
2688
2688
  };
2689
2689
  readonly additionalProperties: false;
2690
2690
  };
2691
+ readonly palette: {
2692
+ readonly type: "string";
2693
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
2694
+ };
2691
2695
  readonly mockServer: {
2692
2696
  readonly type: "object";
2693
2697
  readonly properties: {
@@ -3007,7 +3011,9 @@ export declare const productConfigOverrideSchema: {
3007
3011
  };
3008
3012
  readonly rbac: {
3009
3013
  readonly type: "object";
3010
- readonly additionalProperties: true;
3014
+ readonly additionalProperties: {
3015
+ readonly type: "string";
3016
+ };
3011
3017
  };
3012
3018
  readonly openapi: {
3013
3019
  readonly properties: {
@@ -10337,6 +10343,10 @@ export declare const productConfigOverrideSchema: {
10337
10343
  };
10338
10344
  readonly additionalProperties: false;
10339
10345
  };
10346
+ readonly palette: {
10347
+ readonly type: "string";
10348
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
10349
+ };
10340
10350
  readonly mockServer: {
10341
10351
  readonly type: "object";
10342
10352
  readonly properties: {
@@ -13086,6 +13096,10 @@ export declare const productConfigOverrideSchema: {
13086
13096
  };
13087
13097
  readonly additionalProperties: false;
13088
13098
  };
13099
+ readonly palette: {
13100
+ readonly type: "string";
13101
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
13102
+ };
13089
13103
  readonly mockServer: {
13090
13104
  readonly type: "object";
13091
13105
  readonly properties: {
@@ -1,5 +1,5 @@
1
1
  import { themeConfigSchema } from './default-theme-config-schema';
2
- import { productGoogleAnalyticsConfigSchema } from './ex-theme-config-schemas';
2
+ import { paletteConfigSchema, productGoogleAnalyticsConfigSchema } from './ex-theme-config-schemas';
3
3
  import { apiConfigSchema, redoclyConfigSchema } from './root-config-schema';
4
4
  export const productThemeOverrideSchema = {
5
5
  type: 'object',
@@ -13,6 +13,7 @@ export const productThemeOverrideSchema = {
13
13
  breadcrumbs: themeConfigSchema.properties.breadcrumbs,
14
14
  openapi: themeConfigSchema.properties.openapi,
15
15
  feedback: themeConfigSchema.properties.feedback,
16
+ palette: paletteConfigSchema,
16
17
  mockServer: redoclyConfigSchema.properties.mockServer,
17
18
  analytics: {
18
19
  type: 'object',
@@ -826,7 +826,9 @@ export declare const apiConfigSchema: {
826
826
  };
827
827
  readonly rbac: {
828
828
  readonly type: "object";
829
- readonly additionalProperties: true;
829
+ readonly additionalProperties: {
830
+ readonly type: "string";
831
+ };
830
832
  };
831
833
  readonly openapi: {
832
834
  readonly properties: {
@@ -8460,8 +8462,7 @@ export declare const redoclyConfigSchema: {
8460
8462
  };
8461
8463
  readonly palette: {
8462
8464
  readonly type: "string";
8463
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
8464
- readonly default: "default";
8465
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
8465
8466
  };
8466
8467
  readonly navigation: {
8467
8468
  readonly type: "object";
@@ -15482,8 +15483,7 @@ export declare const redoclyConfigSchema: {
15482
15483
  };
15483
15484
  readonly palette: {
15484
15485
  readonly type: "string";
15485
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
15486
- readonly default: "default";
15486
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
15487
15487
  };
15488
15488
  readonly navigation: {
15489
15489
  readonly type: "object";
@@ -22109,7 +22109,9 @@ export declare const redoclyConfigSchema: {
22109
22109
  };
22110
22110
  readonly rbac: {
22111
22111
  readonly type: "object";
22112
- readonly additionalProperties: true;
22112
+ readonly additionalProperties: {
22113
+ readonly type: "string";
22114
+ };
22113
22115
  };
22114
22116
  readonly openapi: {
22115
22117
  readonly properties: {
@@ -29367,7 +29369,7 @@ export declare const rootRedoclyConfigSchema: {
29367
29369
  type: "object";
29368
29370
  };
29369
29371
  palette: {
29370
- enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29372
+ enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29371
29373
  type: "string";
29372
29374
  };
29373
29375
  navigation: {
@@ -35247,7 +35249,7 @@ export declare const rootRedoclyConfigSchema: {
35247
35249
  type: "object";
35248
35250
  };
35249
35251
  palette: {
35250
- enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35252
+ enum: ("slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35251
35253
  type: "string";
35252
35254
  };
35253
35255
  navigation: {
@@ -40453,7 +40455,9 @@ export declare const rootRedoclyConfigSchema: {
40453
40455
  type: "string";
40454
40456
  };
40455
40457
  rbac: {
40456
- additionalProperties: true;
40458
+ additionalProperties: {
40459
+ type: "string";
40460
+ };
40457
40461
  type: "object";
40458
40462
  };
40459
40463
  output: {
@@ -42200,8 +42204,7 @@ export declare const rootRedoclyConfigSchema: {
42200
42204
  };
42201
42205
  readonly palette: {
42202
42206
  readonly type: "string";
42203
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
42204
- readonly default: "default";
42207
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
42205
42208
  };
42206
42209
  readonly navigation: {
42207
42210
  readonly type: "object";
@@ -49222,8 +49225,7 @@ export declare const rootRedoclyConfigSchema: {
49222
49225
  };
49223
49226
  readonly palette: {
49224
49227
  readonly type: "string";
49225
- readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
49226
- readonly default: "default";
49228
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
49227
49229
  };
49228
49230
  readonly navigation: {
49229
49231
  readonly type: "object";
@@ -55849,7 +55851,9 @@ export declare const rootRedoclyConfigSchema: {
55849
55851
  };
55850
55852
  readonly rbac: {
55851
55853
  readonly type: "object";
55852
- readonly additionalProperties: true;
55854
+ readonly additionalProperties: {
55855
+ readonly type: "string";
55856
+ };
55853
55857
  };
55854
55858
  readonly openapi: {
55855
55859
  readonly properties: {
@@ -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: { type: 'object', additionalProperties: true }, openapi: openapiConfigSchema, graphql: graphqlConfigSchema,
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
  */
@@ -27,6 +27,8 @@ export type ApiFunctionsUser = {
27
27
  export type ApiFunctionsContext = {
28
28
  user: ApiFunctionsUser;
29
29
  config: RedoclyConfig;
30
+ outdir?: string;
31
+ baseUrl?: string;
30
32
  params: Record<string, string | string[]>;
31
33
  query: Record<string, string | string[]>;
32
34
  cookies: Record<string, string>;
@@ -318,7 +318,7 @@ export type BreadcrumbItem = {
318
318
  link?: string;
319
319
  icon?: string;
320
320
  };
321
- export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback'> & {
321
+ export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback' | 'palette' | 'mockServer'> & {
322
322
  analytics?: {
323
323
  ga?: ProductGoogleAnalyticsConfig;
324
324
  };
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.45.0",
3
+ "version": "0.46.1",
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.24.0",
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",