@redocly/config 0.44.1 → 0.44.2

package/lib/root-config-schema.d.ts

@@ -6878,6 +6878,9 @@ export declare const redoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -6891,10 +6894,16 @@ export declare const redoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -21546,6 +21555,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -21784,6 +21796,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };
@@ -40585,6 +40600,9 @@ export declare const rootRedoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -40598,10 +40616,16 @@ export declare const rootRedoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -55253,6 +55277,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -55491,6 +55518,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };

package/lib/root-config-schema.js

@@ -511,7 +511,15 @@ exports.redoclyConfigSchema = {
         imports: {
             type: 'array',
             items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, 
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
+        rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, 
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
+        requiresLogin: requiresLoginSchema, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
@@ -529,7 +537,19 @@ exports.redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
-        } }, 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' } }, 
+        } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, 
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
+        sso: exports.ssoConfigSchema, 
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
+        residency: residencySchema, 
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
+        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' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

package/lib/types/config-types.d.ts

@@ -32,7 +32,28 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
 export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
-export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
+type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
+export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
+    /**
+     * @deprecated Should use `access.rbac` instead
+     */
+    rbac?: RootRedoclyConfig['rbac'];
+    /**
+     * @deprecated Should use `access.requiresLogin` instead
+     */
+    requiresLogin?: RootRedoclyConfig['requiresLogin'];
+    /**
+     * @deprecated Should use `access.sso` instead
+     */
+    sso?: RootRedoclyConfig['sso'];
+    /**
+     * @deprecated Should use `access.residency` instead
+     */
+    residency?: RootRedoclyConfig['residency'];
+    /**
+     * @deprecated Should use `access.logoutReturnUrl` instead
+     */
+    logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
     /**
      * @deprecated properties moved to the root of the config
      */

package/lib/types/portal-shared-types.d.ts

@@ -1,9 +1,9 @@
 import type { Node } from '@markdoc/markdoc/dist/src/types';
 import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
-import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
+import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } from './config-types';
 import type { CatalogEntityConfig } from './catalog-entity-types';
 export * from './code-walkthrough-types';
-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'> & {
+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'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
     products?: {
         [key: string]: ProductUiConfig;
     };
+    banner?: ResolvedBannerConfig[];
 };
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
@@ -157,6 +158,9 @@ export type ResolvedSidebar = {
         catalogConfig?: CatalogEntityConfig;
     };
 };
+export type ResolvedBannerConfig = BannerConfig & {
+    ast: unknown;
+};
 export type CompilationError = {
     message: string;
     sourceFileRelativePath: string;

package/lib-esm/root-config-schema.d.ts

@@ -6878,6 +6878,9 @@ export declare const redoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -6891,10 +6894,16 @@ export declare const redoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -21546,6 +21555,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -21784,6 +21796,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };
@@ -40585,6 +40600,9 @@ export declare const rootRedoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -40598,10 +40616,16 @@ export declare const rootRedoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -55253,6 +55277,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -55491,6 +55518,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };

package/lib-esm/root-config-schema.js

@@ -508,7 +508,15 @@ export const redoclyConfigSchema = {
         imports: {
             type: 'array',
             items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, 
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
+        rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, 
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
+        requiresLogin: requiresLoginSchema, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
@@ -526,7 +534,19 @@ export const redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: apiConfigSchema,
-        } }, 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' } }, 
+        } }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema, 
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
+        sso: ssoConfigSchema, 
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
+        residency: residencySchema, 
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
+        logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

package/lib-esm/types/config-types.d.ts

@@ -32,7 +32,28 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
 export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
-export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
+type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
+export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
+    /**
+     * @deprecated Should use `access.rbac` instead
+     */
+    rbac?: RootRedoclyConfig['rbac'];
+    /**
+     * @deprecated Should use `access.requiresLogin` instead
+     */
+    requiresLogin?: RootRedoclyConfig['requiresLogin'];
+    /**
+     * @deprecated Should use `access.sso` instead
+     */
+    sso?: RootRedoclyConfig['sso'];
+    /**
+     * @deprecated Should use `access.residency` instead
+     */
+    residency?: RootRedoclyConfig['residency'];
+    /**
+     * @deprecated Should use `access.logoutReturnUrl` instead
+     */
+    logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
     /**
      * @deprecated properties moved to the root of the config
      */

package/lib-esm/types/portal-shared-types.d.ts

@@ -1,9 +1,9 @@
 import type { Node } from '@markdoc/markdoc/dist/src/types';
 import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
-import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
+import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } from './config-types';
 import type { CatalogEntityConfig } from './catalog-entity-types';
 export * from './code-walkthrough-types';
-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'> & {
+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'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
     products?: {
         [key: string]: ProductUiConfig;
     };
+    banner?: ResolvedBannerConfig[];
 };
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
@@ -157,6 +158,9 @@ export type ResolvedSidebar = {
         catalogConfig?: CatalogEntityConfig;
     };
 };
+export type ResolvedBannerConfig = BannerConfig & {
+    ast: unknown;
+};
 export type CompilationError = {
     message: string;
     sourceFileRelativePath: string;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@redocly/config",
-  "version": "0.44.1",
+  "version": "0.44.2",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
   "types": "./lib/index.d.ts",
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
-    "@redocly/openapi-core": "2.20.4",
+    "@redocly/openapi-core": "2.24.0",
     "@types/node": "22.18.13",
     "@types/react": "^19.2.7",
     "@vitest/coverage-v8": "4.0.10",