@redocly/config 0.40.0 → 0.41.0

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

@@ -0,0 +1,237 @@
+const operatorSchema = {
+    type: 'string',
+    enum: [
+        'eq',
+        'in',
+        'gt',
+        'gte',
+        'lt',
+        'lte',
+        'contains',
+        'startsWith',
+        'endsWith',
+        'exists',
+        'isEmpty',
+        'between',
+        'matches',
+        'some',
+        'every',
+        'none',
+        'and',
+        'or',
+        'not',
+    ],
+};
+// Base condition schema with field, operator, value, and match properties
+const conditionSchema = {
+    type: 'object',
+    properties: {
+        field: { type: 'string' },
+        operator: operatorSchema,
+        value: {
+            oneOf: [{ type: 'boolean' }, { type: 'string' }, { type: 'number' }],
+        },
+        match: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    field: { type: 'string' },
+                    operator: operatorSchema,
+                    value: {
+                        oneOf: [{ type: 'boolean' }, { type: 'string' }, { type: 'number' }],
+                    },
+                },
+            },
+        },
+    },
+};
+// Schema for a logical operator with conditions (used for nesting)
+const logicalOperatorConditionSchema = {
+    type: 'object',
+    properties: {
+        operator: operatorSchema,
+        conditions: {
+            type: 'array',
+            items: conditionSchema, // At the deepest level, only simple conditions
+        },
+    },
+    required: ['operator', 'conditions'],
+    additionalProperties: false,
+};
+// Conditions schema allowing nested conditions with up to 2 levels of recursion
+const conditionsSchema = {
+    type: 'array',
+    items: {
+        oneOf: [
+            conditionSchema,
+            {
+                type: 'object',
+                properties: {
+                    operator: operatorSchema,
+                    conditions: {
+                        type: 'array',
+                        items: {
+                            oneOf: [conditionSchema, logicalOperatorConditionSchema],
+                        },
+                    },
+                },
+                required: ['operator', 'conditions'],
+                additionalProperties: false,
+            },
+        ],
+    },
+};
+const entityRuleAssertionSchema = {
+    type: 'object',
+    properties: {
+        defined: { type: 'boolean' },
+        nonEmpty: { type: 'boolean' },
+        eq: {},
+        gt: { type: 'number' },
+        gte: { type: 'number' },
+        lt: { type: 'number' },
+        lte: { type: 'number' },
+        const: {},
+    },
+    additionalProperties: false,
+};
+const entityRuleWhereSchema = {
+    type: 'array',
+    items: {
+        type: 'object',
+        properties: {
+            subject: {
+                type: 'object',
+                properties: {
+                    type: {
+                        type: 'string',
+                        enum: ['Entity', 'EntityMetadata', 'EntityRelations', 'EntityRelation'],
+                    },
+                    property: { type: 'string' },
+                },
+                required: ['type', 'property'],
+                additionalProperties: false,
+            },
+            assertions: entityRuleAssertionSchema,
+        },
+        required: ['subject', 'assertions'],
+        additionalProperties: false,
+    },
+};
+const entityRuleSchema = {
+    type: 'object',
+    properties: {
+        title: { type: 'string' },
+        subject: {
+            type: 'object',
+            properties: {
+                type: {
+                    type: 'string',
+                    enum: ['Entity', 'EntityMetadata', 'EntityRelations', 'EntityRelation'],
+                },
+                property: { type: 'string' },
+            },
+            required: ['type', 'property'],
+            additionalProperties: false,
+        },
+        severity: {
+            type: 'string',
+            enum: ['error', 'warn', 'off'],
+        },
+        message: { type: 'string' },
+        assertions: entityRuleAssertionSchema,
+        where: entityRuleWhereSchema,
+        weight: { type: 'number', default: 1 },
+    },
+    required: ['subject', 'assertions'],
+    additionalProperties: false,
+};
+// Supports both OpenAPI/AsyncAPI rules (backward compatibility) and entity rules
+const levelRulesSchema = {
+    type: 'object',
+    additionalProperties: {
+        oneOf: [
+            { type: 'string' },
+            {
+                type: 'object',
+                properties: {
+                    severity: {
+                        type: 'string',
+                        enum: ['error', 'warn', 'off'],
+                    },
+                    weight: { type: 'number', default: 1 },
+                },
+                additionalProperties: true,
+            },
+            entityRuleSchema,
+        ],
+    },
+};
+const levelSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        extends: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        rules: levelRulesSchema,
+    },
+    required: ['name'],
+    additionalProperties: false,
+};
+const triggerEventSchema = {
+    type: 'object',
+    properties: {
+        event: {
+            type: 'string',
+            enum: ['runtime', 'manual'],
+        },
+    },
+    required: ['event'],
+    additionalProperties: false,
+};
+const triggerSchema = {
+    oneOf: [
+        triggerEventSchema,
+        {
+            type: 'array',
+            items: triggerEventSchema,
+        },
+    ],
+};
+export const scorecardSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        description: { type: 'string' },
+        entities: {
+            oneOf: [
+                conditionsSchema,
+                {
+                    type: 'object',
+                    properties: {
+                        operator: operatorSchema,
+                        conditions: conditionsSchema,
+                    },
+                    required: ['operator', 'conditions'],
+                    additionalProperties: false,
+                },
+            ],
+        },
+        levels: {
+            type: 'array',
+            items: levelSchema,
+            minItems: 1,
+        },
+        trigger: triggerSchema,
+    },
+    required: ['name', 'entities', 'levels'],
+    additionalProperties: false,
+};
+export const scorecardsConfigSchema = {
+    type: 'array',
+    items: scorecardSchema,
+};
+//# sourceMappingURL=scorecards-config-schema.js.map

package/lib-esm/types/api-functions-types.d.ts

@@ -30,7 +30,7 @@ export type ApiFunctionsContext = {
     params: Record<string, string | string[]>;
     query: Record<string, string | string[]>;
     cookies: Record<string, string>;
-    getStorage: () => Promise<KvService>;
+    getKv: () => Promise<KvService>;
     /**
      * @deprecated `telemetry` is deprecated.
      */
@@ -102,4 +102,4 @@ export interface CookieOptions {
     signed?: boolean;
     sameSite?: 'Strict' | 'Lax' | 'None';
 }
-export type ServerPropsContext = Omit<ApiFunctionsContext, 'getStorage'>;
+export type ServerPropsContext = Omit<ApiFunctionsContext, 'getKv'>;

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

@@ -1,10 +1,11 @@
 import type { FromSchema } from 'json-schema-to-ts';
 import type { themeConfigSchema } from '../default-theme-config-schema';
 import type { productConfigOverrideSchema } from '../product-override-schema';
-import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from '../root-config-schema';
+import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, bannerConfigSchema, bannersConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from '../root-config-schema';
 import type { RedocConfigTypes } from './redoc-types';
 import type { GraphQLConfigTypes } from './graphql-types';
-import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, scorecardsConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
+import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
+import type { scorecardsConfigSchema } from '../scorecards-config-schema';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
 /**
@@ -38,6 +39,8 @@ export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'th
 };
 export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
 export type RedirectsConfig = FromSchema<typeof redirectsConfigSchema>;
+export type BannerConfig = FromSchema<typeof bannerConfigSchema>;
+export type BannersConfig = FromSchema<typeof bannersConfigSchema>;
 export type AuthProviderConfig = FromSchema<typeof authProviderConfigSchema>;
 export type OidcProviderConfig = FromSchema<typeof oidcProviderConfigSchema>;
 export type Saml2ProviderConfig = FromSchema<typeof saml2ProviderConfigSchema>;

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

@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } 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'> & {
+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'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/config",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -8,7 +8,7 @@
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
     "@types/node": "22.18.13",
-    "@types/react": "^19.1.4",
+    "@types/react": "^19.2.7",
     "react-router-dom": "^6.21.1",
     "rimraf": "5.0.7",
     "typescript": "5.9.3"