@redocly/config 0.38.0 → 0.40.0

package/lib/root-config-schema.js

@@ -443,7 +443,11 @@ exports.redoclyConfigSchema = {
         /**
          * @deprecated Should use `catalogClassic` instead
          */
-        catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, mcp: mcpConfigSchema }),
+        catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, 
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
+        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: ex_theme_config_schemas_1.scorecardsConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, mcp: mcpConfigSchema }),
     default: { redirects: {}, seo: exports.seoConfigSchema.default },
     additionalProperties: true,
 };

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

@@ -30,6 +30,7 @@ export type ApiFunctionsContext = {
     params: Record<string, string | string[]>;
     query: Record<string, string | string[]>;
     cookies: Record<string, string>;
+    getStorage: () => Promise<KvService>;
     /**
      * @deprecated `telemetry` is deprecated.
      */
@@ -39,6 +40,53 @@ export type ApiFunctionsContext = {
         } & Record<string, string | number>) => void;
     };
 } & ApiFunctionsContextMethods;
+export type KvService = {
+    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<KvReadSchema<T> | null>;
+    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvReadSchema<T> | null)[]>;
+    list: <T extends KvValue = KvValue>(selector: KvListSelector, options?: KvListOptions) => Promise<KvListResponse<T>>;
+    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<string | null>;
+    delete: (key: KvKey) => Promise<boolean>;
+    clearExpired: () => Promise<void>;
+    transaction: <T>(operation: (tx: KvTransaction) => Promise<T>) => Promise<T>;
+};
+export type KvValue = Record<string, unknown> | unknown[] | unknown;
+export type KvKeyPart = string | number | boolean;
+export type KvKey = KvKeyPart[];
+export type KvSetOptions = {
+    ttlInSeconds?: number;
+};
+export type KvReadSchema<T extends KvValue = KvValue> = {
+    key: KvKey;
+    value: T | null;
+};
+export type KvListSelector = {
+    prefix: KvKey;
+} | {
+    prefix: KvKey;
+    start: KvKey;
+} | {
+    prefix: KvKey;
+    end: KvKey;
+} | {
+    start: KvKey;
+    end: KvKey;
+};
+export type KvListOptions = {
+    limit?: number;
+    reverse?: boolean;
+    cursor?: string;
+};
+export type KvListResponse<T extends KvValue = KvValue> = {
+    items: KvReadSchema<T>[];
+    total: number;
+    cursor: string | null;
+};
+export type KvTransaction = {
+    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<KvReadSchema<T> | null>;
+    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvReadSchema<T> | null)[]>;
+    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<string | null>;
+    delete: (key: KvKey) => Promise<boolean>;
+};
 export type ApiRoutesHandler = (request: Request, context: ApiFunctionsContext, 
 /**
  * @deprecated `staticData` is deprecated.
@@ -54,4 +102,4 @@ export interface CookieOptions {
     signed?: boolean;
     sameSite?: 'Strict' | 'Lax' | 'None';
 }
-export type ServerPropsContext = ApiFunctionsContext;
+export type ServerPropsContext = Omit<ApiFunctionsContext, 'getStorage'>;

package/lib/types/catalog-entity-types.d.ts

@@ -53,6 +53,8 @@ export type EntityContactFileSchema = FromSchema<typeof entityContactFileSchema>
 export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
 export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
 export type EntityBaseFileSchema = {
+    version?: string | null;
+    revision?: string | null;
     key: string;
     title: string;
     summary?: string | null;

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

@@ -4,7 +4,7 @@ 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 { RedocConfigTypes } from './redoc-types';
 import type { GraphQLConfigTypes } from './graphql-types';
-import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
+import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, scorecardsConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
 /**
@@ -27,6 +27,7 @@ export type CatalogConfig = FromSchema<typeof catalogSchema>;
 export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 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'> & {
     /**

package/lib/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' | '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'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;
@@ -44,6 +44,7 @@ export type ResolvedNavLinkItem = {
     routeSlug?: string;
     active?: boolean;
     deprecated?: boolean;
+    isAdditionalOperation?: boolean;
     icon?: string;
     srcSet?: string;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;

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

@@ -0,0 +1,3 @@
+export type ScorecardsConfig = {
+    test: boolean;
+};

package/lib/types/scorecards-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scorecards-types.js.map

package/lib-esm/default-theme-config-schema.d.ts

@@ -3457,6 +3457,58 @@ export declare const themeConfigSchema: {
                 readonly showBuiltInDirectives: {
                     readonly type: "boolean";
                 };
+                readonly info: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                        };
+                        readonly termsOfService: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                        };
+                        readonly contact: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly email: {
+                                    readonly type: "string";
+                                    readonly format: "email";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly license: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly identifier: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
             };
             readonly additionalProperties: false;
         };
@@ -5285,6 +5337,9 @@ export declare const themeConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
         readonly scorecard: {
             readonly type: "object";
             readonly additionalProperties: true;
@@ -5534,6 +5589,266 @@ export declare const themeConfigSchema: {
                 };
             };
         };
+        readonly scorecards: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+            readonly required: readonly [];
+            readonly properties: {
+                readonly test: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                };
+            };
+        };
+        readonly scorecardClassic: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+            readonly required: readonly [];
+            readonly properties: {
+                readonly ignoreNonCompliant: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly teamMetadataProperty: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly property: {
+                            readonly type: "string";
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly default: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly levels: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["name"];
+                        readonly properties: {
+                            readonly decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_0Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async3Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly arazzo1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly overlay1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_0Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async3Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly arazzo1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly overlay1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_0Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly async2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly async3Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly arazzo1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly overlay1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly name: {
+                                readonly type: "string";
+                            };
+                            readonly color: {
+                                readonly type: "string";
+                            };
+                            readonly extends: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly targets: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["where"];
+                        readonly properties: {
+                            readonly minimumLevel: {
+                                readonly type: "string";
+                            };
+                            readonly rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly where: {
+                                readonly type: "object";
+                                readonly required: readonly ["metadata"];
+                                readonly properties: {
+                                    readonly metadata: {
+                                        readonly type: "object";
+                                        readonly additionalProperties: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly ignore: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly fromProjectUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                };
+            };
+        };
     };
     readonly additionalProperties: true;
 };

package/lib-esm/default-theme-config-schema.js

@@ -1,6 +1,6 @@
 import { graphqlConfigSchema } from './graphql-config-schema';
 import { feedbackConfigSchema } from './feedback-config-schema';
-import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
+import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, scorecardsConfigSchema, } from './ex-theme-config-schemas';
 import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
 export const themeConfigSchema = {
     type: 'object',
@@ -38,7 +38,12 @@ export const themeConfigSchema = {
         catalog: catalogsConfigSchema,
         entitiesCatalog: entitiesCatalogConfigSchema,
         catalogClassic: catalogsConfigSchema,
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
         scorecard: scorecardConfigSchema,
+        scorecards: scorecardsConfigSchema,
+        scorecardClassic: scorecardConfigSchema,
     },
     additionalProperties: true,
 };