@redocly/config 0.39.0 → 0.41.0

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

@@ -4,8 +4,9 @@ import { feedbackConfigSchema } from './feedback-config-schema';
 import { graphqlConfigSchema } from './graphql-config-schema';
 import { removePropertyRecursively } from './remove-property-recursively';
 import { reuniteConfigSchema } from './reunite-config-schema';
-import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scorecardsConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
+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';
 import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
+import { scorecardsConfigSchema } from './scorecards-config-schema';
 import { ruleSchemas, preprocessorSchemas, decoratorsSchemas } from './common';
 export const oidcIssuerMetadataSchema = {
     type: 'object',
@@ -95,6 +96,27 @@ export const redirectsConfigSchema = {
     additionalProperties: redirectConfigSchema,
     default: {},
 };
+export const bannerColorSchema = {
+    type: 'string',
+    enum: ['info', 'success', 'warning', 'error'],
+    default: 'info',
+};
+export const bannerConfigSchema = {
+    type: 'object',
+    properties: {
+        content: { type: 'string' },
+        dismissible: { type: 'boolean', default: false },
+        target: { type: 'string' },
+        color: bannerColorSchema,
+    },
+    required: ['content'],
+    additionalProperties: false,
+};
+export const bannersConfigSchema = {
+    type: 'array',
+    items: bannerConfigSchema,
+    default: [],
+};
 export const apiConfigSchema = {
     type: 'object',
     properties: Object.assign(Object.assign(Object.assign(Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: { type: 'object', additionalProperties: true }, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, 
@@ -440,7 +462,11 @@ export const redoclyConfigSchema = {
         /**
          * @deprecated Should use `catalogClassic` instead
          */
-        catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, scorecard: scorecardConfigSchema, scorecards: scorecardsConfigSchema, mcp: mcpConfigSchema }),
+        catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, 
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
+        scorecard: scorecardConfigSchema, scorecards: scorecardsConfigSchema, scorecardClassic: scorecardConfigSchema, mcp: mcpConfigSchema, banner: bannersConfigSchema }),
     default: { redirects: {}, seo: seoConfigSchema.default },
     additionalProperties: true,
 };