@redocly/config 0.41.1 → 0.41.2

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.
Files changed (9) hide show
  1. package/lib/root-config-schema.d.ts +412 -0
  2. package/lib/root-config-schema.js +17 -3
  3. package/lib/types/catalog-entity-types.d.ts +1 -1
  4. package/lib/types/portal-shared-types.d.ts +2 -1
  5. package/lib-esm/root-config-schema.d.ts +412 -0
  6. package/lib-esm/root-config-schema.js +16 -2
  7. package/lib-esm/types/catalog-entity-types.d.ts +1 -1
  8. package/lib-esm/types/portal-shared-types.d.ts +2 -1
  9. package/package.json +7 -3
package/lib/root-config-schema.d.ts CHANGED
@@ -6085,6 +6085,106 @@ export declare const l10nConfigSchema: {
6085
6085
  readonly additionalProperties: false;
6086
6086
  readonly required: readonly ["defaultLocale"];
6087
6087
  };
6088
+ export declare const accessConfigSchema: {
6089
+ readonly type: "object";
6090
+ readonly properties: {
6091
+ readonly requiresLogin: {
6092
+ readonly type: "boolean";
6093
+ };
6094
+ readonly logoutReturnUrl: {
6095
+ readonly type: "string";
6096
+ readonly pattern: "^https?://.*";
6097
+ };
6098
+ readonly residency: {
6099
+ readonly type: "string";
6100
+ readonly pattern: "^https?://.*";
6101
+ };
6102
+ readonly sso: {
6103
+ readonly oneOf: readonly [{
6104
+ readonly type: "array";
6105
+ readonly items: {
6106
+ readonly type: "string";
6107
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6108
+ };
6109
+ readonly uniqueItems: true;
6110
+ }, {
6111
+ readonly type: "string";
6112
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6113
+ }];
6114
+ };
6115
+ readonly rbac: {
6116
+ readonly type: "object";
6117
+ readonly properties: {
6118
+ readonly teamNamePatterns: {
6119
+ readonly type: "array";
6120
+ readonly items: {
6121
+ readonly type: "string";
6122
+ };
6123
+ };
6124
+ readonly teamFolders: {
6125
+ readonly type: "array";
6126
+ readonly items: {
6127
+ readonly type: "string";
6128
+ };
6129
+ };
6130
+ readonly teamFoldersBaseRoles: {
6131
+ readonly type: "object";
6132
+ readonly additionalProperties: {
6133
+ readonly type: "string";
6134
+ };
6135
+ };
6136
+ readonly cms: {
6137
+ readonly type: "object";
6138
+ readonly additionalProperties: {
6139
+ readonly type: "string";
6140
+ };
6141
+ };
6142
+ readonly reunite: {
6143
+ readonly type: "object";
6144
+ readonly additionalProperties: {
6145
+ readonly type: "string";
6146
+ };
6147
+ };
6148
+ readonly features: {
6149
+ readonly type: "object";
6150
+ readonly properties: {
6151
+ readonly aiSearch: {
6152
+ readonly type: "object";
6153
+ readonly additionalProperties: {
6154
+ readonly type: "string";
6155
+ };
6156
+ };
6157
+ };
6158
+ readonly additionalProperties: false;
6159
+ };
6160
+ readonly content: {
6161
+ readonly type: "object";
6162
+ readonly properties: {
6163
+ readonly '**': {
6164
+ readonly type: "object";
6165
+ readonly additionalProperties: {
6166
+ readonly type: "string";
6167
+ };
6168
+ };
6169
+ };
6170
+ readonly additionalProperties: {
6171
+ readonly type: "object";
6172
+ readonly additionalProperties: {
6173
+ readonly type: "string";
6174
+ };
6175
+ };
6176
+ };
6177
+ };
6178
+ readonly additionalProperties: {
6179
+ readonly type: "object";
6180
+ readonly additionalProperties: {
6181
+ readonly type: "string";
6182
+ };
6183
+ };
6184
+ };
6185
+ };
6186
+ readonly additionalProperties: false;
6187
+ };
6088
6188
  export declare const redoclyConfigSchema: {
6089
6189
  readonly type: "object";
6090
6190
  readonly properties: {
@@ -6253,6 +6353,110 @@ export declare const redoclyConfigSchema: {
6253
6353
  readonly type: "string";
6254
6354
  readonly pattern: "^https?://.*";
6255
6355
  };
6356
+ readonly logoutReturnUrl: {
6357
+ readonly type: "string";
6358
+ readonly pattern: "^https?://.*";
6359
+ };
6360
+ readonly access: {
6361
+ readonly type: "object";
6362
+ readonly properties: {
6363
+ readonly requiresLogin: {
6364
+ readonly type: "boolean";
6365
+ };
6366
+ readonly logoutReturnUrl: {
6367
+ readonly type: "string";
6368
+ readonly pattern: "^https?://.*";
6369
+ };
6370
+ readonly residency: {
6371
+ readonly type: "string";
6372
+ readonly pattern: "^https?://.*";
6373
+ };
6374
+ readonly sso: {
6375
+ readonly oneOf: readonly [{
6376
+ readonly type: "array";
6377
+ readonly items: {
6378
+ readonly type: "string";
6379
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6380
+ };
6381
+ readonly uniqueItems: true;
6382
+ }, {
6383
+ readonly type: "string";
6384
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6385
+ }];
6386
+ };
6387
+ readonly rbac: {
6388
+ readonly type: "object";
6389
+ readonly properties: {
6390
+ readonly teamNamePatterns: {
6391
+ readonly type: "array";
6392
+ readonly items: {
6393
+ readonly type: "string";
6394
+ };
6395
+ };
6396
+ readonly teamFolders: {
6397
+ readonly type: "array";
6398
+ readonly items: {
6399
+ readonly type: "string";
6400
+ };
6401
+ };
6402
+ readonly teamFoldersBaseRoles: {
6403
+ readonly type: "object";
6404
+ readonly additionalProperties: {
6405
+ readonly type: "string";
6406
+ };
6407
+ };
6408
+ readonly cms: {
6409
+ readonly type: "object";
6410
+ readonly additionalProperties: {
6411
+ readonly type: "string";
6412
+ };
6413
+ };
6414
+ readonly reunite: {
6415
+ readonly type: "object";
6416
+ readonly additionalProperties: {
6417
+ readonly type: "string";
6418
+ };
6419
+ };
6420
+ readonly features: {
6421
+ readonly type: "object";
6422
+ readonly properties: {
6423
+ readonly aiSearch: {
6424
+ readonly type: "object";
6425
+ readonly additionalProperties: {
6426
+ readonly type: "string";
6427
+ };
6428
+ };
6429
+ };
6430
+ readonly additionalProperties: false;
6431
+ };
6432
+ readonly content: {
6433
+ readonly type: "object";
6434
+ readonly properties: {
6435
+ readonly '**': {
6436
+ readonly type: "object";
6437
+ readonly additionalProperties: {
6438
+ readonly type: "string";
6439
+ };
6440
+ };
6441
+ };
6442
+ readonly additionalProperties: {
6443
+ readonly type: "object";
6444
+ readonly additionalProperties: {
6445
+ readonly type: "string";
6446
+ };
6447
+ };
6448
+ };
6449
+ };
6450
+ readonly additionalProperties: {
6451
+ readonly type: "object";
6452
+ readonly additionalProperties: {
6453
+ readonly type: "string";
6454
+ };
6455
+ };
6456
+ };
6457
+ };
6458
+ readonly additionalProperties: false;
6459
+ };
6256
6460
  readonly developerOnboarding: {
6257
6461
  readonly type: "object";
6258
6462
  readonly required: readonly ["adapters"];
@@ -31689,6 +31893,110 @@ export declare const rootRedoclyConfigSchema: {
31689
31893
  type: "string";
31690
31894
  pattern: "^https?://.*";
31691
31895
  };
31896
+ logoutReturnUrl: {
31897
+ type: "string";
31898
+ pattern: "^https?://.*";
31899
+ };
31900
+ access: {
31901
+ properties: {
31902
+ sso: {
31903
+ oneOf: ({
31904
+ items: {
31905
+ enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
31906
+ type: "string";
31907
+ };
31908
+ type: "array";
31909
+ uniqueItems: true;
31910
+ } | {
31911
+ enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
31912
+ type: "string";
31913
+ })[];
31914
+ };
31915
+ residency: {
31916
+ type: "string";
31917
+ pattern: "^https?://.*";
31918
+ };
31919
+ logoutReturnUrl: {
31920
+ type: "string";
31921
+ pattern: "^https?://.*";
31922
+ };
31923
+ rbac: {
31924
+ properties: {
31925
+ content: {
31926
+ properties: {
31927
+ "**": {
31928
+ additionalProperties: {
31929
+ type: "string";
31930
+ };
31931
+ type: "object";
31932
+ };
31933
+ };
31934
+ additionalProperties: {
31935
+ additionalProperties: {
31936
+ type: "string";
31937
+ };
31938
+ type: "object";
31939
+ };
31940
+ type: "object";
31941
+ };
31942
+ reunite: {
31943
+ additionalProperties: {
31944
+ type: "string";
31945
+ };
31946
+ type: "object";
31947
+ };
31948
+ teamNamePatterns: {
31949
+ items: {
31950
+ type: "string";
31951
+ };
31952
+ type: "array";
31953
+ };
31954
+ teamFolders: {
31955
+ items: {
31956
+ type: "string";
31957
+ };
31958
+ type: "array";
31959
+ };
31960
+ teamFoldersBaseRoles: {
31961
+ additionalProperties: {
31962
+ type: "string";
31963
+ };
31964
+ type: "object";
31965
+ };
31966
+ cms: {
31967
+ additionalProperties: {
31968
+ type: "string";
31969
+ };
31970
+ type: "object";
31971
+ };
31972
+ features: {
31973
+ properties: {
31974
+ aiSearch: {
31975
+ additionalProperties: {
31976
+ type: "string";
31977
+ };
31978
+ type: "object";
31979
+ };
31980
+ };
31981
+ additionalProperties: false;
31982
+ type: "object";
31983
+ };
31984
+ };
31985
+ additionalProperties: {
31986
+ additionalProperties: {
31987
+ type: "string";
31988
+ };
31989
+ type: "object";
31990
+ };
31991
+ type: "object";
31992
+ };
31993
+ requiresLogin: {
31994
+ type: "boolean";
31995
+ };
31996
+ };
31997
+ additionalProperties: false;
31998
+ type: "object";
31999
+ };
31692
32000
  developerOnboarding: {
31693
32001
  properties: {
31694
32002
  adapters: {
@@ -37764,6 +38072,110 @@ export declare const rootRedoclyConfigSchema: {
37764
38072
  readonly type: "string";
37765
38073
  readonly pattern: "^https?://.*";
37766
38074
  };
38075
+ readonly logoutReturnUrl: {
38076
+ readonly type: "string";
38077
+ readonly pattern: "^https?://.*";
38078
+ };
38079
+ readonly access: {
38080
+ readonly type: "object";
38081
+ readonly properties: {
38082
+ readonly requiresLogin: {
38083
+ readonly type: "boolean";
38084
+ };
38085
+ readonly logoutReturnUrl: {
38086
+ readonly type: "string";
38087
+ readonly pattern: "^https?://.*";
38088
+ };
38089
+ readonly residency: {
38090
+ readonly type: "string";
38091
+ readonly pattern: "^https?://.*";
38092
+ };
38093
+ readonly sso: {
38094
+ readonly oneOf: readonly [{
38095
+ readonly type: "array";
38096
+ readonly items: {
38097
+ readonly type: "string";
38098
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
38099
+ };
38100
+ readonly uniqueItems: true;
38101
+ }, {
38102
+ readonly type: "string";
38103
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
38104
+ }];
38105
+ };
38106
+ readonly rbac: {
38107
+ readonly type: "object";
38108
+ readonly properties: {
38109
+ readonly teamNamePatterns: {
38110
+ readonly type: "array";
38111
+ readonly items: {
38112
+ readonly type: "string";
38113
+ };
38114
+ };
38115
+ readonly teamFolders: {
38116
+ readonly type: "array";
38117
+ readonly items: {
38118
+ readonly type: "string";
38119
+ };
38120
+ };
38121
+ readonly teamFoldersBaseRoles: {
38122
+ readonly type: "object";
38123
+ readonly additionalProperties: {
38124
+ readonly type: "string";
38125
+ };
38126
+ };
38127
+ readonly cms: {
38128
+ readonly type: "object";
38129
+ readonly additionalProperties: {
38130
+ readonly type: "string";
38131
+ };
38132
+ };
38133
+ readonly reunite: {
38134
+ readonly type: "object";
38135
+ readonly additionalProperties: {
38136
+ readonly type: "string";
38137
+ };
38138
+ };
38139
+ readonly features: {
38140
+ readonly type: "object";
38141
+ readonly properties: {
38142
+ readonly aiSearch: {
38143
+ readonly type: "object";
38144
+ readonly additionalProperties: {
38145
+ readonly type: "string";
38146
+ };
38147
+ };
38148
+ };
38149
+ readonly additionalProperties: false;
38150
+ };
38151
+ readonly content: {
38152
+ readonly type: "object";
38153
+ readonly properties: {
38154
+ readonly '**': {
38155
+ readonly type: "object";
38156
+ readonly additionalProperties: {
38157
+ readonly type: "string";
38158
+ };
38159
+ };
38160
+ };
38161
+ readonly additionalProperties: {
38162
+ readonly type: "object";
38163
+ readonly additionalProperties: {
38164
+ readonly type: "string";
38165
+ };
38166
+ };
38167
+ };
38168
+ };
38169
+ readonly additionalProperties: {
38170
+ readonly type: "object";
38171
+ readonly additionalProperties: {
38172
+ readonly type: "string";
38173
+ };
38174
+ };
38175
+ };
38176
+ };
38177
+ readonly additionalProperties: false;
38178
+ };
37767
38179
  readonly developerOnboarding: {
37768
38180
  readonly type: "object";
37769
38181
  readonly required: readonly ["adapters"];
package/lib/root-config-schema.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.bannersConfigSchema = exports.bannerConfigSchema = exports.bannerColorSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
3
+ exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.accessConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.bannersConfigSchema = exports.bannerConfigSchema = exports.bannerColorSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
4
4
  const constants_1 = require("./constants");
5
5
  const default_theme_config_schema_1 = require("./default-theme-config-schema");
6
6
  const feedback_config_schema_1 = require("./feedback-config-schema");
@@ -86,6 +86,9 @@ exports.ssoConfigSchema = {
86
86
  },
87
87
  ],
88
88
  };
89
+ const requiresLoginSchema = { type: 'boolean' };
90
+ const logoutReturnUrlSchema = { type: 'string', pattern: '^https?://.*' };
91
+ const residencySchema = { type: 'string', pattern: '^https?://.*' };
89
92
  exports.redirectConfigSchema = {
90
93
  type: 'object',
91
94
  properties: {
@@ -428,6 +431,17 @@ const mcpConfigSchema = {
428
431
  },
429
432
  },
430
433
  };
434
+ exports.accessConfigSchema = {
435
+ type: 'object',
436
+ properties: {
437
+ requiresLogin: requiresLoginSchema,
438
+ logoutReturnUrl: logoutReturnUrlSchema,
439
+ residency: residencySchema,
440
+ sso: exports.ssoConfigSchema,
441
+ rbac: exports.rbacConfigSchema,
442
+ },
443
+ additionalProperties: false,
444
+ };
431
445
  exports.redoclyConfigSchema = {
432
446
  type: 'object',
433
447
  properties: Object.assign(Object.assign(Object.assign(Object.assign({
@@ -437,7 +451,7 @@ exports.redoclyConfigSchema = {
437
451
  imports: {
438
452
  type: 'array',
439
453
  items: { type: 'string' },
440
- }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: { type: 'boolean' }, responseHeaders: {
454
+ }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
441
455
  type: 'object',
442
456
  additionalProperties: {
443
457
  type: 'array',
@@ -455,7 +469,7 @@ exports.redoclyConfigSchema = {
455
469
  }, apis: {
456
470
  type: 'object',
457
471
  additionalProperties: exports.apiConfigSchema,
458
- }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: { type: 'string', pattern: '^https?://.*' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
472
+ }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { 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' } },
459
473
  /**
460
474
  * @deprecated properties moved to the root of the config
461
475
  */
package/lib/types/catalog-entity-types.d.ts CHANGED
@@ -54,7 +54,7 @@ export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
54
54
  export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
55
55
  export type EntityBaseFileSchema = {
56
56
  version?: string | null;
57
- revision?: string | null;
57
+ revision?: string;
58
58
  key: string;
59
59
  title: string;
60
60
  summary?: string | null;
package/lib/types/portal-shared-types.d.ts CHANGED
@@ -151,7 +151,8 @@ export type ResolvedSidebar = {
151
151
  items: ResolvedNavItem[];
152
152
  catalogEntity?: {
153
153
  key: string;
154
- catalogConfig: CatalogEntityConfig;
154
+ version?: string;
155
+ catalogConfig?: CatalogEntityConfig;
155
156
  };
156
157
  };
157
158
  export type CompilationError = {
package/lib-esm/root-config-schema.d.ts CHANGED
@@ -6085,6 +6085,106 @@ export declare const l10nConfigSchema: {
6085
6085
  readonly additionalProperties: false;
6086
6086
  readonly required: readonly ["defaultLocale"];
6087
6087
  };
6088
+ export declare const accessConfigSchema: {
6089
+ readonly type: "object";
6090
+ readonly properties: {
6091
+ readonly requiresLogin: {
6092
+ readonly type: "boolean";
6093
+ };
6094
+ readonly logoutReturnUrl: {
6095
+ readonly type: "string";
6096
+ readonly pattern: "^https?://.*";
6097
+ };
6098
+ readonly residency: {
6099
+ readonly type: "string";
6100
+ readonly pattern: "^https?://.*";
6101
+ };
6102
+ readonly sso: {
6103
+ readonly oneOf: readonly [{
6104
+ readonly type: "array";
6105
+ readonly items: {
6106
+ readonly type: "string";
6107
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6108
+ };
6109
+ readonly uniqueItems: true;
6110
+ }, {
6111
+ readonly type: "string";
6112
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6113
+ }];
6114
+ };
6115
+ readonly rbac: {
6116
+ readonly type: "object";
6117
+ readonly properties: {
6118
+ readonly teamNamePatterns: {
6119
+ readonly type: "array";
6120
+ readonly items: {
6121
+ readonly type: "string";
6122
+ };
6123
+ };
6124
+ readonly teamFolders: {
6125
+ readonly type: "array";
6126
+ readonly items: {
6127
+ readonly type: "string";
6128
+ };
6129
+ };
6130
+ readonly teamFoldersBaseRoles: {
6131
+ readonly type: "object";
6132
+ readonly additionalProperties: {
6133
+ readonly type: "string";
6134
+ };
6135
+ };
6136
+ readonly cms: {
6137
+ readonly type: "object";
6138
+ readonly additionalProperties: {
6139
+ readonly type: "string";
6140
+ };
6141
+ };
6142
+ readonly reunite: {
6143
+ readonly type: "object";
6144
+ readonly additionalProperties: {
6145
+ readonly type: "string";
6146
+ };
6147
+ };
6148
+ readonly features: {
6149
+ readonly type: "object";
6150
+ readonly properties: {
6151
+ readonly aiSearch: {
6152
+ readonly type: "object";
6153
+ readonly additionalProperties: {
6154
+ readonly type: "string";
6155
+ };
6156
+ };
6157
+ };
6158
+ readonly additionalProperties: false;
6159
+ };
6160
+ readonly content: {
6161
+ readonly type: "object";
6162
+ readonly properties: {
6163
+ readonly '**': {
6164
+ readonly type: "object";
6165
+ readonly additionalProperties: {
6166
+ readonly type: "string";
6167
+ };
6168
+ };
6169
+ };
6170
+ readonly additionalProperties: {
6171
+ readonly type: "object";
6172
+ readonly additionalProperties: {
6173
+ readonly type: "string";
6174
+ };
6175
+ };
6176
+ };
6177
+ };
6178
+ readonly additionalProperties: {
6179
+ readonly type: "object";
6180
+ readonly additionalProperties: {
6181
+ readonly type: "string";
6182
+ };
6183
+ };
6184
+ };
6185
+ };
6186
+ readonly additionalProperties: false;
6187
+ };
6088
6188
  export declare const redoclyConfigSchema: {
6089
6189
  readonly type: "object";
6090
6190
  readonly properties: {
@@ -6253,6 +6353,110 @@ export declare const redoclyConfigSchema: {
6253
6353
  readonly type: "string";
6254
6354
  readonly pattern: "^https?://.*";
6255
6355
  };
6356
+ readonly logoutReturnUrl: {
6357
+ readonly type: "string";
6358
+ readonly pattern: "^https?://.*";
6359
+ };
6360
+ readonly access: {
6361
+ readonly type: "object";
6362
+ readonly properties: {
6363
+ readonly requiresLogin: {
6364
+ readonly type: "boolean";
6365
+ };
6366
+ readonly logoutReturnUrl: {
6367
+ readonly type: "string";
6368
+ readonly pattern: "^https?://.*";
6369
+ };
6370
+ readonly residency: {
6371
+ readonly type: "string";
6372
+ readonly pattern: "^https?://.*";
6373
+ };
6374
+ readonly sso: {
6375
+ readonly oneOf: readonly [{
6376
+ readonly type: "array";
6377
+ readonly items: {
6378
+ readonly type: "string";
6379
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6380
+ };
6381
+ readonly uniqueItems: true;
6382
+ }, {
6383
+ readonly type: "string";
6384
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
6385
+ }];
6386
+ };
6387
+ readonly rbac: {
6388
+ readonly type: "object";
6389
+ readonly properties: {
6390
+ readonly teamNamePatterns: {
6391
+ readonly type: "array";
6392
+ readonly items: {
6393
+ readonly type: "string";
6394
+ };
6395
+ };
6396
+ readonly teamFolders: {
6397
+ readonly type: "array";
6398
+ readonly items: {
6399
+ readonly type: "string";
6400
+ };
6401
+ };
6402
+ readonly teamFoldersBaseRoles: {
6403
+ readonly type: "object";
6404
+ readonly additionalProperties: {
6405
+ readonly type: "string";
6406
+ };
6407
+ };
6408
+ readonly cms: {
6409
+ readonly type: "object";
6410
+ readonly additionalProperties: {
6411
+ readonly type: "string";
6412
+ };
6413
+ };
6414
+ readonly reunite: {
6415
+ readonly type: "object";
6416
+ readonly additionalProperties: {
6417
+ readonly type: "string";
6418
+ };
6419
+ };
6420
+ readonly features: {
6421
+ readonly type: "object";
6422
+ readonly properties: {
6423
+ readonly aiSearch: {
6424
+ readonly type: "object";
6425
+ readonly additionalProperties: {
6426
+ readonly type: "string";
6427
+ };
6428
+ };
6429
+ };
6430
+ readonly additionalProperties: false;
6431
+ };
6432
+ readonly content: {
6433
+ readonly type: "object";
6434
+ readonly properties: {
6435
+ readonly '**': {
6436
+ readonly type: "object";
6437
+ readonly additionalProperties: {
6438
+ readonly type: "string";
6439
+ };
6440
+ };
6441
+ };
6442
+ readonly additionalProperties: {
6443
+ readonly type: "object";
6444
+ readonly additionalProperties: {
6445
+ readonly type: "string";
6446
+ };
6447
+ };
6448
+ };
6449
+ };
6450
+ readonly additionalProperties: {
6451
+ readonly type: "object";
6452
+ readonly additionalProperties: {
6453
+ readonly type: "string";
6454
+ };
6455
+ };
6456
+ };
6457
+ };
6458
+ readonly additionalProperties: false;
6459
+ };
6256
6460
  readonly developerOnboarding: {
6257
6461
  readonly type: "object";
6258
6462
  readonly required: readonly ["adapters"];
@@ -31689,6 +31893,110 @@ export declare const rootRedoclyConfigSchema: {
31689
31893
  type: "string";
31690
31894
  pattern: "^https?://.*";
31691
31895
  };
31896
+ logoutReturnUrl: {
31897
+ type: "string";
31898
+ pattern: "^https?://.*";
31899
+ };
31900
+ access: {
31901
+ properties: {
31902
+ sso: {
31903
+ oneOf: ({
31904
+ items: {
31905
+ enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
31906
+ type: "string";
31907
+ };
31908
+ type: "array";
31909
+ uniqueItems: true;
31910
+ } | {
31911
+ enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
31912
+ type: "string";
31913
+ })[];
31914
+ };
31915
+ residency: {
31916
+ type: "string";
31917
+ pattern: "^https?://.*";
31918
+ };
31919
+ logoutReturnUrl: {
31920
+ type: "string";
31921
+ pattern: "^https?://.*";
31922
+ };
31923
+ rbac: {
31924
+ properties: {
31925
+ content: {
31926
+ properties: {
31927
+ "**": {
31928
+ additionalProperties: {
31929
+ type: "string";
31930
+ };
31931
+ type: "object";
31932
+ };
31933
+ };
31934
+ additionalProperties: {
31935
+ additionalProperties: {
31936
+ type: "string";
31937
+ };
31938
+ type: "object";
31939
+ };
31940
+ type: "object";
31941
+ };
31942
+ reunite: {
31943
+ additionalProperties: {
31944
+ type: "string";
31945
+ };
31946
+ type: "object";
31947
+ };
31948
+ teamNamePatterns: {
31949
+ items: {
31950
+ type: "string";
31951
+ };
31952
+ type: "array";
31953
+ };
31954
+ teamFolders: {
31955
+ items: {
31956
+ type: "string";
31957
+ };
31958
+ type: "array";
31959
+ };
31960
+ teamFoldersBaseRoles: {
31961
+ additionalProperties: {
31962
+ type: "string";
31963
+ };
31964
+ type: "object";
31965
+ };
31966
+ cms: {
31967
+ additionalProperties: {
31968
+ type: "string";
31969
+ };
31970
+ type: "object";
31971
+ };
31972
+ features: {
31973
+ properties: {
31974
+ aiSearch: {
31975
+ additionalProperties: {
31976
+ type: "string";
31977
+ };
31978
+ type: "object";
31979
+ };
31980
+ };
31981
+ additionalProperties: false;
31982
+ type: "object";
31983
+ };
31984
+ };
31985
+ additionalProperties: {
31986
+ additionalProperties: {
31987
+ type: "string";
31988
+ };
31989
+ type: "object";
31990
+ };
31991
+ type: "object";
31992
+ };
31993
+ requiresLogin: {
31994
+ type: "boolean";
31995
+ };
31996
+ };
31997
+ additionalProperties: false;
31998
+ type: "object";
31999
+ };
31692
32000
  developerOnboarding: {
31693
32001
  properties: {
31694
32002
  adapters: {
@@ -37764,6 +38072,110 @@ export declare const rootRedoclyConfigSchema: {
37764
38072
  readonly type: "string";
37765
38073
  readonly pattern: "^https?://.*";
37766
38074
  };
38075
+ readonly logoutReturnUrl: {
38076
+ readonly type: "string";
38077
+ readonly pattern: "^https?://.*";
38078
+ };
38079
+ readonly access: {
38080
+ readonly type: "object";
38081
+ readonly properties: {
38082
+ readonly requiresLogin: {
38083
+ readonly type: "boolean";
38084
+ };
38085
+ readonly logoutReturnUrl: {
38086
+ readonly type: "string";
38087
+ readonly pattern: "^https?://.*";
38088
+ };
38089
+ readonly residency: {
38090
+ readonly type: "string";
38091
+ readonly pattern: "^https?://.*";
38092
+ };
38093
+ readonly sso: {
38094
+ readonly oneOf: readonly [{
38095
+ readonly type: "array";
38096
+ readonly items: {
38097
+ readonly type: "string";
38098
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
38099
+ };
38100
+ readonly uniqueItems: true;
38101
+ }, {
38102
+ readonly type: "string";
38103
+ readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
38104
+ }];
38105
+ };
38106
+ readonly rbac: {
38107
+ readonly type: "object";
38108
+ readonly properties: {
38109
+ readonly teamNamePatterns: {
38110
+ readonly type: "array";
38111
+ readonly items: {
38112
+ readonly type: "string";
38113
+ };
38114
+ };
38115
+ readonly teamFolders: {
38116
+ readonly type: "array";
38117
+ readonly items: {
38118
+ readonly type: "string";
38119
+ };
38120
+ };
38121
+ readonly teamFoldersBaseRoles: {
38122
+ readonly type: "object";
38123
+ readonly additionalProperties: {
38124
+ readonly type: "string";
38125
+ };
38126
+ };
38127
+ readonly cms: {
38128
+ readonly type: "object";
38129
+ readonly additionalProperties: {
38130
+ readonly type: "string";
38131
+ };
38132
+ };
38133
+ readonly reunite: {
38134
+ readonly type: "object";
38135
+ readonly additionalProperties: {
38136
+ readonly type: "string";
38137
+ };
38138
+ };
38139
+ readonly features: {
38140
+ readonly type: "object";
38141
+ readonly properties: {
38142
+ readonly aiSearch: {
38143
+ readonly type: "object";
38144
+ readonly additionalProperties: {
38145
+ readonly type: "string";
38146
+ };
38147
+ };
38148
+ };
38149
+ readonly additionalProperties: false;
38150
+ };
38151
+ readonly content: {
38152
+ readonly type: "object";
38153
+ readonly properties: {
38154
+ readonly '**': {
38155
+ readonly type: "object";
38156
+ readonly additionalProperties: {
38157
+ readonly type: "string";
38158
+ };
38159
+ };
38160
+ };
38161
+ readonly additionalProperties: {
38162
+ readonly type: "object";
38163
+ readonly additionalProperties: {
38164
+ readonly type: "string";
38165
+ };
38166
+ };
38167
+ };
38168
+ };
38169
+ readonly additionalProperties: {
38170
+ readonly type: "object";
38171
+ readonly additionalProperties: {
38172
+ readonly type: "string";
38173
+ };
38174
+ };
38175
+ };
38176
+ };
38177
+ readonly additionalProperties: false;
38178
+ };
37767
38179
  readonly developerOnboarding: {
37768
38180
  readonly type: "object";
37769
38181
  readonly required: readonly ["adapters"];
package/lib-esm/root-config-schema.js CHANGED
@@ -83,6 +83,9 @@ export const ssoConfigSchema = {
83
83
  },
84
84
  ],
85
85
  };
86
+ const requiresLoginSchema = { type: 'boolean' };
87
+ const logoutReturnUrlSchema = { type: 'string', pattern: '^https?://.*' };
88
+ const residencySchema = { type: 'string', pattern: '^https?://.*' };
86
89
  export const redirectConfigSchema = {
87
90
  type: 'object',
88
91
  properties: {
@@ -425,6 +428,17 @@ const mcpConfigSchema = {
425
428
  },
426
429
  },
427
430
  };
431
+ export const accessConfigSchema = {
432
+ type: 'object',
433
+ properties: {
434
+ requiresLogin: requiresLoginSchema,
435
+ logoutReturnUrl: logoutReturnUrlSchema,
436
+ residency: residencySchema,
437
+ sso: ssoConfigSchema,
438
+ rbac: rbacConfigSchema,
439
+ },
440
+ additionalProperties: false,
441
+ };
428
442
  export const redoclyConfigSchema = {
429
443
  type: 'object',
430
444
  properties: Object.assign(Object.assign(Object.assign(Object.assign({
@@ -434,7 +448,7 @@ export const redoclyConfigSchema = {
434
448
  imports: {
435
449
  type: 'array',
436
450
  items: { type: 'string' },
437
- }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: { type: 'boolean' }, responseHeaders: {
451
+ }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
438
452
  type: 'object',
439
453
  additionalProperties: {
440
454
  type: 'array',
@@ -452,7 +466,7 @@ export const redoclyConfigSchema = {
452
466
  }, apis: {
453
467
  type: 'object',
454
468
  additionalProperties: apiConfigSchema,
455
- }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: { type: 'string', pattern: '^https?://.*' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
469
+ }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { 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' } },
456
470
  /**
457
471
  * @deprecated properties moved to the root of the config
458
472
  */
package/lib-esm/types/catalog-entity-types.d.ts CHANGED
@@ -54,7 +54,7 @@ export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
54
54
  export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
55
55
  export type EntityBaseFileSchema = {
56
56
  version?: string | null;
57
- revision?: string | null;
57
+ revision?: string;
58
58
  key: string;
59
59
  title: string;
60
60
  summary?: string | null;
package/lib-esm/types/portal-shared-types.d.ts CHANGED
@@ -151,7 +151,8 @@ export type ResolvedSidebar = {
151
151
  items: ResolvedNavItem[];
152
152
  catalogEntity?: {
153
153
  key: string;
154
- catalogConfig: CatalogEntityConfig;
154
+ version?: string;
155
+ catalogConfig?: CatalogEntityConfig;
155
156
  };
156
157
  };
157
158
  export type CompilationError = {
package/package.json CHANGED
@@ -1,17 +1,20 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.41.1",
3
+ "version": "0.41.2",
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.14.3",
10
11
  "@types/node": "22.18.13",
11
12
  "@types/react": "^19.2.7",
13
+ "@vitest/coverage-v8": "4.0.10",
12
14
  "react-router-dom": "^6.21.1",
13
15
  "rimraf": "5.0.7",
14
- "typescript": "5.9.3"
16
+ "typescript": "5.9.3",
17
+ "vitest": "4.0.10"
15
18
  },
16
19
  "dependencies": {
17
20
  "json-schema-to-ts": "2.7.2"
@@ -19,6 +22,7 @@
19
22
  "scripts": {
20
23
  "clean": "rimraf lib",
21
24
  "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.lib-esm.json",
22
- "build": "npm run clean && npm run compile"
25
+ "build": "npm run clean && npm run compile",
26
+ "test": "vitest run src"
23
27
  }
24
28
  }