@redocly/config - npm Package Compare versions

Comparing version 0.44.1 to 0.44.2

lib-esm/root-config-schema.js

@@ -511,3 +511,11 @@ import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants/shared';
             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',
@@ -530,4 +538,16 @@ additionalProperties: {
             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
@@ -534,0 +554,0 @@ */

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

@@ -35,4 +35,25 @@ import type { FromSchema } from 'json-schema-to-ts';
 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
@@ -39,0 +60,0 @@ */

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

 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?: {
@@ -21,2 +21,3 @@ idpsInfo?: {
     };
+    banner?: ResolvedBannerConfig[];
 };
@@ -161,2 +162,5 @@ /**
 };
+export type ResolvedBannerConfig = BannerConfig & {
+    ast: unknown;
+};
 export type CompilationError = {
@@ -163,0 +167,0 @@ message: string;

lib/root-config-schema.js

@@ -514,3 +514,11 @@ "use strict";
             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',
@@ -533,4 +541,16 @@ additionalProperties: {
             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
@@ -537,0 +557,0 @@ */

lib/types/config-types.d.ts

@@ -35,4 +35,25 @@ import type { FromSchema } from 'json-schema-to-ts';
 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
@@ -39,0 +60,0 @@ */

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

 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?: {
@@ -21,2 +21,3 @@ idpsInfo?: {
     };
+    banner?: ResolvedBannerConfig[];
 };
@@ -161,2 +162,5 @@ /**
 };
+export type ResolvedBannerConfig = BannerConfig & {
+    ast: unknown;
+};
 export type CompilationError = {
@@ -163,0 +167,0 @@ message: string;

package.json

 {
   "name": "@redocly/config",
-  "version": "0.44.1",
+  "version": "0.44.2",
   "license": "MIT",
@@ -10,3 +10,3 @@ "main": "./lib/index.js",
     "@markdoc/markdoc": "0.5.2",
-    "@redocly/openapi-core": "2.20.4",
+    "@redocly/openapi-core": "2.24.0",
     "@types/node": "22.18.13",
@@ -13,0 +13,0 @@ "@types/react": "^19.2.7",

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11054569

0.04%

Lines of code

197018

0.08%

No dependency changes