@redocly/config 0.46.0 → 0.47.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/product-override-schema.d.ts +12 -0
- package/lib/product-override-schema.js +1 -0
- package/lib/root-config-schema.d.ts +36 -0
- package/lib/root-config-schema.js +10 -1
- package/lib/types/api-functions-types.d.ts +2 -0
- package/lib/types/portal-shared-types.d.ts +1 -1
- package/lib-esm/product-override-schema.d.ts +12 -0
- package/lib-esm/product-override-schema.js +2 -1
- package/lib-esm/root-config-schema.d.ts +36 -0
- package/lib-esm/root-config-schema.js +10 -1
- package/lib-esm/types/api-functions-types.d.ts +2 -0
- package/lib-esm/types/portal-shared-types.d.ts +1 -1
- package/package.json +1 -1
|
@@ -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: {
|
|
@@ -10339,6 +10343,10 @@ export declare const productConfigOverrideSchema: {
|
|
|
10339
10343
|
};
|
|
10340
10344
|
readonly additionalProperties: false;
|
|
10341
10345
|
};
|
|
10346
|
+
readonly palette: {
|
|
10347
|
+
readonly type: "string";
|
|
10348
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
10349
|
+
};
|
|
10342
10350
|
readonly mockServer: {
|
|
10343
10351
|
readonly type: "object";
|
|
10344
10352
|
readonly properties: {
|
|
@@ -13088,6 +13096,10 @@ export declare const productConfigOverrideSchema: {
|
|
|
13088
13096
|
};
|
|
13089
13097
|
readonly additionalProperties: false;
|
|
13090
13098
|
};
|
|
13099
|
+
readonly palette: {
|
|
13100
|
+
readonly type: "string";
|
|
13101
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
13102
|
+
};
|
|
13091
13103
|
readonly mockServer: {
|
|
13092
13104
|
readonly type: "object";
|
|
13093
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',
|
|
@@ -21117,6 +21117,18 @@ export declare const redoclyConfigSchema: {
|
|
|
21117
21117
|
};
|
|
21118
21118
|
};
|
|
21119
21119
|
};
|
|
21120
|
+
readonly corsProxy: {
|
|
21121
|
+
readonly type: "object";
|
|
21122
|
+
readonly properties: {
|
|
21123
|
+
readonly allowedTargets: {
|
|
21124
|
+
readonly type: "array";
|
|
21125
|
+
readonly items: {
|
|
21126
|
+
readonly type: "string";
|
|
21127
|
+
};
|
|
21128
|
+
};
|
|
21129
|
+
};
|
|
21130
|
+
readonly additionalProperties: false;
|
|
21131
|
+
};
|
|
21120
21132
|
readonly banner: {
|
|
21121
21133
|
readonly type: "array";
|
|
21122
21134
|
readonly items: {
|
|
@@ -37887,6 +37899,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37887
37899
|
additionalProperties: false;
|
|
37888
37900
|
type: "object";
|
|
37889
37901
|
};
|
|
37902
|
+
corsProxy: {
|
|
37903
|
+
properties: {
|
|
37904
|
+
allowedTargets: {
|
|
37905
|
+
items: {
|
|
37906
|
+
type: "string";
|
|
37907
|
+
};
|
|
37908
|
+
type: "array";
|
|
37909
|
+
};
|
|
37910
|
+
};
|
|
37911
|
+
additionalProperties: false;
|
|
37912
|
+
type: "object";
|
|
37913
|
+
};
|
|
37890
37914
|
banner: {
|
|
37891
37915
|
items: {
|
|
37892
37916
|
properties: {
|
|
@@ -54859,6 +54883,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
54859
54883
|
};
|
|
54860
54884
|
};
|
|
54861
54885
|
};
|
|
54886
|
+
readonly corsProxy: {
|
|
54887
|
+
readonly type: "object";
|
|
54888
|
+
readonly properties: {
|
|
54889
|
+
readonly allowedTargets: {
|
|
54890
|
+
readonly type: "array";
|
|
54891
|
+
readonly items: {
|
|
54892
|
+
readonly type: "string";
|
|
54893
|
+
};
|
|
54894
|
+
};
|
|
54895
|
+
};
|
|
54896
|
+
readonly additionalProperties: false;
|
|
54897
|
+
};
|
|
54862
54898
|
readonly banner: {
|
|
54863
54899
|
readonly type: "array";
|
|
54864
54900
|
readonly items: {
|
|
@@ -563,7 +563,16 @@ exports.redoclyConfigSchema = {
|
|
|
563
563
|
/**
|
|
564
564
|
* @deprecated Should use `scorecardClassic` instead
|
|
565
565
|
*/
|
|
566
|
-
scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: scorecards_config_schema_1.scorecardsConfigSchema, mcp: mcpConfigSchema,
|
|
566
|
+
scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: scorecards_config_schema_1.scorecardsConfigSchema, mcp: mcpConfigSchema, corsProxy: {
|
|
567
|
+
type: 'object',
|
|
568
|
+
properties: {
|
|
569
|
+
allowedTargets: {
|
|
570
|
+
type: 'array',
|
|
571
|
+
items: { type: 'string' },
|
|
572
|
+
},
|
|
573
|
+
},
|
|
574
|
+
additionalProperties: false,
|
|
575
|
+
}, banner: exports.bannersConfigSchema }),
|
|
567
576
|
default: { redirects: {}, seo: exports.seoConfigSchema.default },
|
|
568
577
|
additionalProperties: true,
|
|
569
578
|
};
|
|
@@ -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
|
};
|
|
@@ -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: {
|
|
@@ -10339,6 +10343,10 @@ export declare const productConfigOverrideSchema: {
|
|
|
10339
10343
|
};
|
|
10340
10344
|
readonly additionalProperties: false;
|
|
10341
10345
|
};
|
|
10346
|
+
readonly palette: {
|
|
10347
|
+
readonly type: "string";
|
|
10348
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
10349
|
+
};
|
|
10342
10350
|
readonly mockServer: {
|
|
10343
10351
|
readonly type: "object";
|
|
10344
10352
|
readonly properties: {
|
|
@@ -13088,6 +13096,10 @@ export declare const productConfigOverrideSchema: {
|
|
|
13088
13096
|
};
|
|
13089
13097
|
readonly additionalProperties: false;
|
|
13090
13098
|
};
|
|
13099
|
+
readonly palette: {
|
|
13100
|
+
readonly type: "string";
|
|
13101
|
+
readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris"];
|
|
13102
|
+
};
|
|
13091
13103
|
readonly mockServer: {
|
|
13092
13104
|
readonly type: "object";
|
|
13093
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',
|
|
@@ -21117,6 +21117,18 @@ export declare const redoclyConfigSchema: {
|
|
|
21117
21117
|
};
|
|
21118
21118
|
};
|
|
21119
21119
|
};
|
|
21120
|
+
readonly corsProxy: {
|
|
21121
|
+
readonly type: "object";
|
|
21122
|
+
readonly properties: {
|
|
21123
|
+
readonly allowedTargets: {
|
|
21124
|
+
readonly type: "array";
|
|
21125
|
+
readonly items: {
|
|
21126
|
+
readonly type: "string";
|
|
21127
|
+
};
|
|
21128
|
+
};
|
|
21129
|
+
};
|
|
21130
|
+
readonly additionalProperties: false;
|
|
21131
|
+
};
|
|
21120
21132
|
readonly banner: {
|
|
21121
21133
|
readonly type: "array";
|
|
21122
21134
|
readonly items: {
|
|
@@ -37887,6 +37899,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37887
37899
|
additionalProperties: false;
|
|
37888
37900
|
type: "object";
|
|
37889
37901
|
};
|
|
37902
|
+
corsProxy: {
|
|
37903
|
+
properties: {
|
|
37904
|
+
allowedTargets: {
|
|
37905
|
+
items: {
|
|
37906
|
+
type: "string";
|
|
37907
|
+
};
|
|
37908
|
+
type: "array";
|
|
37909
|
+
};
|
|
37910
|
+
};
|
|
37911
|
+
additionalProperties: false;
|
|
37912
|
+
type: "object";
|
|
37913
|
+
};
|
|
37890
37914
|
banner: {
|
|
37891
37915
|
items: {
|
|
37892
37916
|
properties: {
|
|
@@ -54859,6 +54883,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
54859
54883
|
};
|
|
54860
54884
|
};
|
|
54861
54885
|
};
|
|
54886
|
+
readonly corsProxy: {
|
|
54887
|
+
readonly type: "object";
|
|
54888
|
+
readonly properties: {
|
|
54889
|
+
readonly allowedTargets: {
|
|
54890
|
+
readonly type: "array";
|
|
54891
|
+
readonly items: {
|
|
54892
|
+
readonly type: "string";
|
|
54893
|
+
};
|
|
54894
|
+
};
|
|
54895
|
+
};
|
|
54896
|
+
readonly additionalProperties: false;
|
|
54897
|
+
};
|
|
54862
54898
|
readonly banner: {
|
|
54863
54899
|
readonly type: "array";
|
|
54864
54900
|
readonly items: {
|
|
@@ -560,7 +560,16 @@ export const redoclyConfigSchema = {
|
|
|
560
560
|
/**
|
|
561
561
|
* @deprecated Should use `scorecardClassic` instead
|
|
562
562
|
*/
|
|
563
|
-
scorecard: scorecardConfigSchema, scorecardClassic: scorecardConfigSchema, scorecards: scorecardsConfigSchema, mcp: mcpConfigSchema,
|
|
563
|
+
scorecard: scorecardConfigSchema, scorecardClassic: scorecardConfigSchema, scorecards: scorecardsConfigSchema, mcp: mcpConfigSchema, corsProxy: {
|
|
564
|
+
type: 'object',
|
|
565
|
+
properties: {
|
|
566
|
+
allowedTargets: {
|
|
567
|
+
type: 'array',
|
|
568
|
+
items: { type: 'string' },
|
|
569
|
+
},
|
|
570
|
+
},
|
|
571
|
+
additionalProperties: false,
|
|
572
|
+
}, banner: bannersConfigSchema }),
|
|
564
573
|
default: { redirects: {}, seo: seoConfigSchema.default },
|
|
565
574
|
additionalProperties: true,
|
|
566
575
|
};
|
|
@@ -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
|
};
|