@redocly/config 0.44.1 → 0.45.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.
@@ -1016,6 +1016,11 @@ 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", "default"];
1022
+ readonly default: "default";
1023
+ };
1019
1024
  readonly navigation: {
1020
1025
  readonly type: "object";
1021
1026
  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,11 @@ 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", "default"];
1055
+ readonly default: "default";
1056
+ };
1052
1057
  export declare const navigationConfigSchema: {
1053
1058
  readonly type: "object";
1054
1059
  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,11 @@ 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', 'default'],
281
+ default: 'default',
282
+ };
278
283
  const navigationActionsConfigSchema = {
279
284
  type: 'object',
280
285
  properties: Object.assign(Object.assign({}, hideConfigSchema.properties), { items: {
@@ -6878,6 +6878,9 @@ export declare const redoclyConfigSchema: {
6878
6878
  };
6879
6879
  };
6880
6880
  };
6881
+ /**
6882
+ * @deprecated Should use `access.sso` instead
6883
+ */
6881
6884
  readonly sso: {
6882
6885
  readonly oneOf: readonly [{
6883
6886
  readonly type: "array";
@@ -6891,10 +6894,16 @@ export declare const redoclyConfigSchema: {
6891
6894
  readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6892
6895
  }];
6893
6896
  };
6897
+ /**
6898
+ * @deprecated Should use `access.residency` instead
6899
+ */
6894
6900
  readonly residency: {
6895
6901
  readonly type: "string";
6896
6902
  readonly pattern: "^https?://.*";
6897
6903
  };
6904
+ /**
6905
+ * @deprecated Should use `access.logoutReturnUrl` instead
6906
+ */
6898
6907
  readonly logoutReturnUrl: {
6899
6908
  readonly type: "string";
6900
6909
  readonly pattern: "^https?://.*";
@@ -8449,6 +8458,11 @@ export declare const redoclyConfigSchema: {
8449
8458
  };
8450
8459
  readonly additionalProperties: false;
8451
8460
  };
8461
+ readonly palette: {
8462
+ readonly type: "string";
8463
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
8464
+ readonly default: "default";
8465
+ };
8452
8466
  readonly navigation: {
8453
8467
  readonly type: "object";
8454
8468
  readonly properties: {
@@ -15466,6 +15480,11 @@ export declare const redoclyConfigSchema: {
15466
15480
  };
15467
15481
  readonly additionalProperties: false;
15468
15482
  };
15483
+ readonly palette: {
15484
+ readonly type: "string";
15485
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
15486
+ readonly default: "default";
15487
+ };
15469
15488
  readonly navigation: {
15470
15489
  readonly type: "object";
15471
15490
  readonly properties: {
@@ -21546,6 +21565,9 @@ export declare const redoclyConfigSchema: {
21546
21565
  };
21547
21566
  readonly additionalProperties: false;
21548
21567
  };
21568
+ /**
21569
+ * @deprecated Should use `access.rbac` instead
21570
+ */
21549
21571
  readonly rbac: {
21550
21572
  readonly type: "object";
21551
21573
  readonly properties: {
@@ -21784,6 +21806,9 @@ export declare const redoclyConfigSchema: {
21784
21806
  };
21785
21807
  readonly additionalProperties: false;
21786
21808
  };
21809
+ /**
21810
+ * @deprecated Should use `access.requiresLogin` instead
21811
+ */
21787
21812
  readonly requiresLogin: {
21788
21813
  readonly type: "boolean";
21789
21814
  };
@@ -29341,6 +29366,10 @@ export declare const rootRedoclyConfigSchema: {
29341
29366
  additionalProperties: false;
29342
29367
  type: "object";
29343
29368
  };
29369
+ palette: {
29370
+ enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29371
+ type: "string";
29372
+ };
29344
29373
  navigation: {
29345
29374
  properties: {
29346
29375
  nextButton: {
@@ -35217,6 +35246,10 @@ export declare const rootRedoclyConfigSchema: {
35217
35246
  additionalProperties: false;
35218
35247
  type: "object";
35219
35248
  };
35249
+ palette: {
35250
+ enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35251
+ type: "string";
35252
+ };
35220
35253
  navigation: {
35221
35254
  properties: {
35222
35255
  nextButton: {
@@ -40585,6 +40618,9 @@ export declare const rootRedoclyConfigSchema: {
40585
40618
  };
40586
40619
  };
40587
40620
  };
40621
+ /**
40622
+ * @deprecated Should use `access.sso` instead
40623
+ */
40588
40624
  readonly sso: {
40589
40625
  readonly oneOf: readonly [{
40590
40626
  readonly type: "array";
@@ -40598,10 +40634,16 @@ export declare const rootRedoclyConfigSchema: {
40598
40634
  readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
40599
40635
  }];
40600
40636
  };
40637
+ /**
40638
+ * @deprecated Should use `access.residency` instead
40639
+ */
40601
40640
  readonly residency: {
40602
40641
  readonly type: "string";
40603
40642
  readonly pattern: "^https?://.*";
40604
40643
  };
40644
+ /**
40645
+ * @deprecated Should use `access.logoutReturnUrl` instead
40646
+ */
40605
40647
  readonly logoutReturnUrl: {
40606
40648
  readonly type: "string";
40607
40649
  readonly pattern: "^https?://.*";
@@ -42156,6 +42198,11 @@ export declare const rootRedoclyConfigSchema: {
42156
42198
  };
42157
42199
  readonly additionalProperties: false;
42158
42200
  };
42201
+ readonly palette: {
42202
+ readonly type: "string";
42203
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
42204
+ readonly default: "default";
42205
+ };
42159
42206
  readonly navigation: {
42160
42207
  readonly type: "object";
42161
42208
  readonly properties: {
@@ -49173,6 +49220,11 @@ export declare const rootRedoclyConfigSchema: {
49173
49220
  };
49174
49221
  readonly additionalProperties: false;
49175
49222
  };
49223
+ readonly palette: {
49224
+ readonly type: "string";
49225
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
49226
+ readonly default: "default";
49227
+ };
49176
49228
  readonly navigation: {
49177
49229
  readonly type: "object";
49178
49230
  readonly properties: {
@@ -55253,6 +55305,9 @@ export declare const rootRedoclyConfigSchema: {
55253
55305
  };
55254
55306
  readonly additionalProperties: false;
55255
55307
  };
55308
+ /**
55309
+ * @deprecated Should use `access.rbac` instead
55310
+ */
55256
55311
  readonly rbac: {
55257
55312
  readonly type: "object";
55258
55313
  readonly properties: {
@@ -55491,6 +55546,9 @@ export declare const rootRedoclyConfigSchema: {
55491
55546
  };
55492
55547
  readonly additionalProperties: false;
55493
55548
  };
55549
+ /**
55550
+ * @deprecated Should use `access.requiresLogin` instead
55551
+ */
55494
55552
  readonly requiresLogin: {
55495
55553
  readonly type: "boolean";
55496
55554
  };
@@ -511,7 +511,15 @@ exports.redoclyConfigSchema = {
511
511
  imports: {
512
512
  type: 'array',
513
513
  items: { type: 'string' },
514
- }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
514
+ }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema,
515
+ /**
516
+ * @deprecated Should use `access.rbac` instead
517
+ */
518
+ rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema,
519
+ /**
520
+ * @deprecated Should use `access.requiresLogin` instead
521
+ */
522
+ requiresLogin: requiresLoginSchema, responseHeaders: {
515
523
  type: 'object',
516
524
  additionalProperties: {
517
525
  type: 'array',
@@ -529,13 +537,25 @@ exports.redoclyConfigSchema = {
529
537
  }, apis: {
530
538
  type: 'object',
531
539
  additionalProperties: exports.apiConfigSchema,
532
- } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
540
+ } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema,
541
+ /**
542
+ * @deprecated Should use `access.sso` instead
543
+ */
544
+ sso: exports.ssoConfigSchema,
545
+ /**
546
+ * @deprecated Should use `access.residency` instead
547
+ */
548
+ residency: residencySchema,
549
+ /**
550
+ * @deprecated Should use `access.logoutReturnUrl` instead
551
+ */
552
+ logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
533
553
  /**
534
554
  * @deprecated properties moved to the root of the config
535
555
  */
536
556
  theme: default_theme_config_schema_1.themeConfigSchema, reunite: reunite_config_schema_1.reuniteConfigSchema,
537
557
  // Ex theme properties
538
- 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,
539
559
  /**
540
560
  * @deprecated Should use `catalogClassic` instead
541
561
  */
@@ -32,7 +32,28 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
32
32
  export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
33
33
  export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
34
34
  export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
35
- export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
35
+ type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
36
+ export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
37
+ /**
38
+ * @deprecated Should use `access.rbac` instead
39
+ */
40
+ rbac?: RootRedoclyConfig['rbac'];
41
+ /**
42
+ * @deprecated Should use `access.requiresLogin` instead
43
+ */
44
+ requiresLogin?: RootRedoclyConfig['requiresLogin'];
45
+ /**
46
+ * @deprecated Should use `access.sso` instead
47
+ */
48
+ sso?: RootRedoclyConfig['sso'];
49
+ /**
50
+ * @deprecated Should use `access.residency` instead
51
+ */
52
+ residency?: RootRedoclyConfig['residency'];
53
+ /**
54
+ * @deprecated Should use `access.logoutReturnUrl` instead
55
+ */
56
+ logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
36
57
  /**
37
58
  * @deprecated properties moved to the root of the config
38
59
  */
@@ -1,9 +1,9 @@
1
1
  import type { Node } from '@markdoc/markdoc/dist/src/types';
2
2
  import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
3
- import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
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' | 'banner'> & {
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;
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
18
18
  products?: {
19
19
  [key: string]: ProductUiConfig;
20
20
  };
21
+ banner?: ResolvedBannerConfig[];
21
22
  };
22
23
  /**
23
24
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
@@ -157,6 +158,10 @@ export type ResolvedSidebar = {
157
158
  catalogConfig?: CatalogEntityConfig;
158
159
  };
159
160
  };
161
+ export type ResolvedBannerConfig = Omit<BannerConfig, 'content'> & {
162
+ ast: unknown;
163
+ hash: string;
164
+ };
160
165
  export type CompilationError = {
161
166
  message: string;
162
167
  sourceFileRelativePath: string;
@@ -1016,6 +1016,11 @@ 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", "default"];
1022
+ readonly default: "default";
1023
+ };
1019
1024
  readonly navigation: {
1020
1025
  readonly type: "object";
1021
1026
  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,11 @@ 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", "default"];
1055
+ readonly default: "default";
1056
+ };
1052
1057
  export declare const navigationConfigSchema: {
1053
1058
  readonly type: "object";
1054
1059
  readonly properties: {
@@ -272,6 +272,11 @@ 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', 'default'],
278
+ default: 'default',
279
+ };
275
280
  const navigationActionsConfigSchema = {
276
281
  type: 'object',
277
282
  properties: Object.assign(Object.assign({}, hideConfigSchema.properties), { items: {
@@ -6878,6 +6878,9 @@ export declare const redoclyConfigSchema: {
6878
6878
  };
6879
6879
  };
6880
6880
  };
6881
+ /**
6882
+ * @deprecated Should use `access.sso` instead
6883
+ */
6881
6884
  readonly sso: {
6882
6885
  readonly oneOf: readonly [{
6883
6886
  readonly type: "array";
@@ -6891,10 +6894,16 @@ export declare const redoclyConfigSchema: {
6891
6894
  readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6892
6895
  }];
6893
6896
  };
6897
+ /**
6898
+ * @deprecated Should use `access.residency` instead
6899
+ */
6894
6900
  readonly residency: {
6895
6901
  readonly type: "string";
6896
6902
  readonly pattern: "^https?://.*";
6897
6903
  };
6904
+ /**
6905
+ * @deprecated Should use `access.logoutReturnUrl` instead
6906
+ */
6898
6907
  readonly logoutReturnUrl: {
6899
6908
  readonly type: "string";
6900
6909
  readonly pattern: "^https?://.*";
@@ -8449,6 +8458,11 @@ export declare const redoclyConfigSchema: {
8449
8458
  };
8450
8459
  readonly additionalProperties: false;
8451
8460
  };
8461
+ readonly palette: {
8462
+ readonly type: "string";
8463
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
8464
+ readonly default: "default";
8465
+ };
8452
8466
  readonly navigation: {
8453
8467
  readonly type: "object";
8454
8468
  readonly properties: {
@@ -15466,6 +15480,11 @@ export declare const redoclyConfigSchema: {
15466
15480
  };
15467
15481
  readonly additionalProperties: false;
15468
15482
  };
15483
+ readonly palette: {
15484
+ readonly type: "string";
15485
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
15486
+ readonly default: "default";
15487
+ };
15469
15488
  readonly navigation: {
15470
15489
  readonly type: "object";
15471
15490
  readonly properties: {
@@ -21546,6 +21565,9 @@ export declare const redoclyConfigSchema: {
21546
21565
  };
21547
21566
  readonly additionalProperties: false;
21548
21567
  };
21568
+ /**
21569
+ * @deprecated Should use `access.rbac` instead
21570
+ */
21549
21571
  readonly rbac: {
21550
21572
  readonly type: "object";
21551
21573
  readonly properties: {
@@ -21784,6 +21806,9 @@ export declare const redoclyConfigSchema: {
21784
21806
  };
21785
21807
  readonly additionalProperties: false;
21786
21808
  };
21809
+ /**
21810
+ * @deprecated Should use `access.requiresLogin` instead
21811
+ */
21787
21812
  readonly requiresLogin: {
21788
21813
  readonly type: "boolean";
21789
21814
  };
@@ -29341,6 +29366,10 @@ export declare const rootRedoclyConfigSchema: {
29341
29366
  additionalProperties: false;
29342
29367
  type: "object";
29343
29368
  };
29369
+ palette: {
29370
+ enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
29371
+ type: "string";
29372
+ };
29344
29373
  navigation: {
29345
29374
  properties: {
29346
29375
  nextButton: {
@@ -35217,6 +35246,10 @@ export declare const rootRedoclyConfigSchema: {
35217
35246
  additionalProperties: false;
35218
35247
  type: "object";
35219
35248
  };
35249
+ palette: {
35250
+ enum: ("default" | "slate" | "pink" | "coral" | "amber" | "jade" | "cyan" | "ocean" | "indigo" | "iris")[];
35251
+ type: "string";
35252
+ };
35220
35253
  navigation: {
35221
35254
  properties: {
35222
35255
  nextButton: {
@@ -40585,6 +40618,9 @@ export declare const rootRedoclyConfigSchema: {
40585
40618
  };
40586
40619
  };
40587
40620
  };
40621
+ /**
40622
+ * @deprecated Should use `access.sso` instead
40623
+ */
40588
40624
  readonly sso: {
40589
40625
  readonly oneOf: readonly [{
40590
40626
  readonly type: "array";
@@ -40598,10 +40634,16 @@ export declare const rootRedoclyConfigSchema: {
40598
40634
  readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
40599
40635
  }];
40600
40636
  };
40637
+ /**
40638
+ * @deprecated Should use `access.residency` instead
40639
+ */
40601
40640
  readonly residency: {
40602
40641
  readonly type: "string";
40603
40642
  readonly pattern: "^https?://.*";
40604
40643
  };
40644
+ /**
40645
+ * @deprecated Should use `access.logoutReturnUrl` instead
40646
+ */
40605
40647
  readonly logoutReturnUrl: {
40606
40648
  readonly type: "string";
40607
40649
  readonly pattern: "^https?://.*";
@@ -42156,6 +42198,11 @@ export declare const rootRedoclyConfigSchema: {
42156
42198
  };
42157
42199
  readonly additionalProperties: false;
42158
42200
  };
42201
+ readonly palette: {
42202
+ readonly type: "string";
42203
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
42204
+ readonly default: "default";
42205
+ };
42159
42206
  readonly navigation: {
42160
42207
  readonly type: "object";
42161
42208
  readonly properties: {
@@ -49173,6 +49220,11 @@ export declare const rootRedoclyConfigSchema: {
49173
49220
  };
49174
49221
  readonly additionalProperties: false;
49175
49222
  };
49223
+ readonly palette: {
49224
+ readonly type: "string";
49225
+ readonly enum: readonly ["slate", "pink", "coral", "amber", "jade", "cyan", "ocean", "indigo", "iris", "default"];
49226
+ readonly default: "default";
49227
+ };
49176
49228
  readonly navigation: {
49177
49229
  readonly type: "object";
49178
49230
  readonly properties: {
@@ -55253,6 +55305,9 @@ export declare const rootRedoclyConfigSchema: {
55253
55305
  };
55254
55306
  readonly additionalProperties: false;
55255
55307
  };
55308
+ /**
55309
+ * @deprecated Should use `access.rbac` instead
55310
+ */
55256
55311
  readonly rbac: {
55257
55312
  readonly type: "object";
55258
55313
  readonly properties: {
@@ -55491,6 +55546,9 @@ export declare const rootRedoclyConfigSchema: {
55491
55546
  };
55492
55547
  readonly additionalProperties: false;
55493
55548
  };
55549
+ /**
55550
+ * @deprecated Should use `access.requiresLogin` instead
55551
+ */
55494
55552
  readonly requiresLogin: {
55495
55553
  readonly type: "boolean";
55496
55554
  };
@@ -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';
@@ -508,7 +508,15 @@ export const redoclyConfigSchema = {
508
508
  imports: {
509
509
  type: 'array',
510
510
  items: { type: 'string' },
511
- }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
511
+ }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema,
512
+ /**
513
+ * @deprecated Should use `access.rbac` instead
514
+ */
515
+ rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema,
516
+ /**
517
+ * @deprecated Should use `access.requiresLogin` instead
518
+ */
519
+ requiresLogin: requiresLoginSchema, responseHeaders: {
512
520
  type: 'object',
513
521
  additionalProperties: {
514
522
  type: 'array',
@@ -526,13 +534,25 @@ export const redoclyConfigSchema = {
526
534
  }, apis: {
527
535
  type: 'object',
528
536
  additionalProperties: apiConfigSchema,
529
- } }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
537
+ } }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema,
538
+ /**
539
+ * @deprecated Should use `access.sso` instead
540
+ */
541
+ sso: ssoConfigSchema,
542
+ /**
543
+ * @deprecated Should use `access.residency` instead
544
+ */
545
+ residency: residencySchema,
546
+ /**
547
+ * @deprecated Should use `access.logoutReturnUrl` instead
548
+ */
549
+ logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
530
550
  /**
531
551
  * @deprecated properties moved to the root of the config
532
552
  */
533
553
  theme: themeConfigSchema, reunite: reuniteConfigSchema,
534
554
  // Ex theme properties
535
- 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,
536
556
  /**
537
557
  * @deprecated Should use `catalogClassic` instead
538
558
  */
@@ -32,7 +32,28 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
32
32
  export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
33
33
  export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
34
34
  export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
35
- export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
35
+ type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
36
+ export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
37
+ /**
38
+ * @deprecated Should use `access.rbac` instead
39
+ */
40
+ rbac?: RootRedoclyConfig['rbac'];
41
+ /**
42
+ * @deprecated Should use `access.requiresLogin` instead
43
+ */
44
+ requiresLogin?: RootRedoclyConfig['requiresLogin'];
45
+ /**
46
+ * @deprecated Should use `access.sso` instead
47
+ */
48
+ sso?: RootRedoclyConfig['sso'];
49
+ /**
50
+ * @deprecated Should use `access.residency` instead
51
+ */
52
+ residency?: RootRedoclyConfig['residency'];
53
+ /**
54
+ * @deprecated Should use `access.logoutReturnUrl` instead
55
+ */
56
+ logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
36
57
  /**
37
58
  * @deprecated properties moved to the root of the config
38
59
  */
@@ -1,9 +1,9 @@
1
1
  import type { Node } from '@markdoc/markdoc/dist/src/types';
2
2
  import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
3
- import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
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' | 'banner'> & {
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;
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
18
18
  products?: {
19
19
  [key: string]: ProductUiConfig;
20
20
  };
21
+ banner?: ResolvedBannerConfig[];
21
22
  };
22
23
  /**
23
24
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
@@ -157,6 +158,10 @@ export type ResolvedSidebar = {
157
158
  catalogConfig?: CatalogEntityConfig;
158
159
  };
159
160
  };
161
+ export type ResolvedBannerConfig = Omit<BannerConfig, 'content'> & {
162
+ ast: unknown;
163
+ hash: string;
164
+ };
160
165
  export type CompilationError = {
161
166
  message: string;
162
167
  sourceFileRelativePath: string;
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.44.1",
3
+ "version": "0.45.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.20.4",
10
+ "@redocly/openapi-core": "2.24.0",
11
11
  "@types/node": "22.18.13",
12
12
  "@types/react": "^19.2.7",
13
13
  "@vitest/coverage-v8": "4.0.10",