redoc 2.2.0 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redoc",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "ReDoc",
   "repository": {
     "type": "git",
@@ -61,6 +61,7 @@
     "pre-commit": "pretty-quick --staged && npm run lint"
   },
   "devDependencies": {
+    "@cfaester/enzyme-adapter-react-18": "^0.8.0",
     "@cypress/webpack-preprocessor": "^5.17.1",
     "@size-limit/file": "^11.1.4",
     "@types/chai": "^4.2.18",
@@ -123,7 +124,7 @@
     "typescript": "^4.9.0",
     "unfetch": "^4.2.0",
     "url": "^0.11.1",
-    "webpack": "^5.88.2",
+    "webpack": "^5.94.0",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1",
     "webpack-node-externals": "^3.0.0",
@@ -132,12 +133,11 @@
   "peerDependencies": {
     "core-js": "^3.1.4",
     "mobx": "^6.0.4",
-    "react": "^16.8.4 || ^17.0.0 || ^18.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0",
+    "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0",
     "styled-components": "^4.1.1 || ^5.1.1 || ^6.0.5"
   },
   "dependencies": {
-    "@cfaester/enzyme-adapter-react-18": "^0.8.0",
     "@redocly/openapi-core": "^1.4.0",
     "classnames": "^2.3.2",
     "decko": "^1.2.0",

package/typings/components/ApiInfo/ApiInfo.d.ts

@@ -4,6 +4,5 @@ export interface ApiInfoProps {
     store: AppStore;
 }
 export declare class ApiInfo extends React.Component<ApiInfoProps> {
-    handleDownloadClick: (e: any) => void;
     render(): React.JSX.Element;
 }

package/typings/components/Fields/EnumValues.d.ts

@@ -1,12 +1,15 @@
 import * as React from 'react';
 export interface EnumValuesProps {
-    values: string[];
-    isArrayType: boolean;
+    values?: string[] | {
+        [name: string]: string;
+    };
+    type: string | string[];
 }
 export interface EnumValuesState {
     collapsed: boolean;
 }
 export declare class EnumValues extends React.PureComponent<EnumValuesProps, EnumValuesState> {
+    constructor(props: EnumValuesProps);
     state: EnumValuesState;
     static contextType: React.Context<import("../../services/RedocNormalizedOptions").RedocNormalizedOptions>;
     private toggle;

package/typings/components/Fields/Field.d.ts

@@ -1,15 +1,19 @@
 import * as React from 'react';
 import type { SchemaOptions } from '../Schema/Schema';
 import type { FieldModel } from '../../services/models';
+import { RedocNormalizedOptions } from '../../services/RedocNormalizedOptions';
 export interface FieldProps extends SchemaOptions {
     className?: string;
     isLast?: boolean;
     showExamples?: boolean;
     field: FieldModel;
     expandByDefault?: boolean;
+    fieldParentsName?: string[];
     renderDiscriminatorSwitch?: (opts: FieldProps) => JSX.Element;
 }
 export declare class Field extends React.Component<FieldProps> {
+    static contextType: React.Context<RedocNormalizedOptions>;
+    context: RedocNormalizedOptions;
     toggle: () => void;
     handleKeyPress: (e: any) => void;
     render(): React.JSX.Element;

package/typings/components/Schema/ObjectSchema.d.ts

@@ -6,5 +6,6 @@ export interface ObjectSchemaProps extends SchemaProps {
         fieldName: string;
         parentSchema: SchemaModel;
     };
+    fieldParentsName?: string[];
 }
-export declare const ObjectSchema: ({ schema: { fields, title }, showTitle, discriminator, skipReadOnly, skipWriteOnly, level, }: ObjectSchemaProps) => React.JSX.Element;
+export declare const ObjectSchema: ({ schema: { fields, title }, showTitle, discriminator, skipReadOnly, skipWriteOnly, level, fieldParentsName, }: ObjectSchemaProps) => React.JSX.Element;

package/typings/components/Schema/Schema.d.ts

@@ -8,6 +8,7 @@ export interface SchemaOptions {
 }
 export interface SchemaProps extends SchemaOptions {
     schema: SchemaModel;
+    fieldParentsName?: string[];
 }
 export declare class Schema extends React.Component<Partial<SchemaProps>> {
     render(): React.JSX.Element | null;

package/typings/services/MenuBuilder.d.ts

@@ -1,4 +1,4 @@
-import type { OpenAPISpec } from '../types';
+import type { OpenAPITag } from '../types';
 import { GroupModel, OperationModel } from './models';
 import type { OpenAPIParser } from './OpenAPIParser';
 import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
@@ -40,10 +40,11 @@ export declare class MenuBuilder {
     /**
      * collects tags and maps each tag to list of operations belonging to this tag
      */
-    static getTagsWithOperations(parser: OpenAPIParser, spec: OpenAPISpec): TagsInfoMap;
-    static getTagRelatedSchema({ parser, tag, parent, }: {
+    static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
+    static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
         parser: OpenAPIParser;
         tag: TagInfo;
         parent: GroupModel;
+        schemaDefinitionsTagName?: string;
     }): GroupModel[];
 }

package/typings/services/RedocNormalizedOptions.d.ts

@@ -1,12 +1,17 @@
 import { ResolvedThemeInterface, ThemeInterface } from '../theme';
 import { SideNavStyleEnum } from './types';
 import type { LabelsConfigRaw, MDXComponentMeta } from './types';
+export type DownloadUrlsConfig = {
+    title?: string;
+    url: string;
+}[];
 export interface RedocRawOptions {
     theme?: ThemeInterface;
     scrollYOffset?: number | string | (() => number);
     hideHostname?: boolean | string;
     expandResponses?: string | 'all';
     requiredPropsFirst?: boolean | string;
+    sortRequiredPropsFirst?: boolean | string;
     sortPropsAlphabetically?: boolean | string;
     sortEnumValuesAlphabetically?: boolean | string;
     sortOperationsAlphabetically?: boolean | string;
@@ -14,10 +19,13 @@ export interface RedocRawOptions {
     nativeScrollbars?: boolean | string;
     pathInMiddlePanel?: boolean | string;
     untrustedSpec?: boolean | string;
+    sanitize?: boolean | string;
     hideLoading?: boolean | string;
     hideDownloadButton?: boolean | string;
+    hideDownloadButtons?: boolean | string;
     downloadFileName?: string;
     downloadDefinitionUrl?: string;
+    downloadUrls?: DownloadUrlsConfig;
     disableSearch?: boolean | string;
     onlyRequiredInSamples?: boolean | string;
     showExtensions?: boolean | string | string[];
@@ -26,11 +34,14 @@ export interface RedocRawOptions {
     hideRequestPayloadSample?: boolean;
     menuToggle?: boolean | string;
     jsonSampleExpandLevel?: number | string | 'all';
+    jsonSamplesExpandLevel?: number | string | 'all';
     hideSchemaTitles?: boolean | string;
     simpleOneOfTypeLabel?: boolean | string;
     payloadSampleIdx?: number;
     expandSingleSchemaField?: boolean | string;
     schemaExpansionLevel?: number | string | 'all';
+    schemasExpansionLevel?: number | string | 'all';
+    schemaDefinitionsTagName?: string;
     showObjectSchemaExamples?: boolean | string;
     showSecuritySchemeType?: boolean;
     hideSecuritySection?: boolean;
@@ -43,10 +54,12 @@ export interface RedocRawOptions {
     ignoreNamedSchemas?: string[] | string;
     hideSchemaPattern?: boolean;
     generatedPayloadSamplesMaxDepth?: number;
+    generatedSamplesMaxDepth?: number;
     nonce?: string;
     hideFab?: boolean;
     minCharacterLengthToInitSearch?: number;
     showWebhookVerb?: boolean;
+    hidePropertiesPrefix?: boolean;
 }
 export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
 export declare class RedocNormalizedOptions {
@@ -64,17 +77,18 @@ export declare class RedocNormalizedOptions {
     expandResponses: {
         [code: string]: boolean;
     } | 'all';
-    requiredPropsFirst: boolean;
+    sortRequiredPropsFirst: boolean;
     sortPropsAlphabetically: boolean;
     sortEnumValuesAlphabetically: boolean;
     sortOperationsAlphabetically: boolean;
     sortTagsAlphabetically: boolean;
     nativeScrollbars: boolean;
     pathInMiddlePanel: boolean;
-    untrustedSpec: boolean;
-    hideDownloadButton: boolean;
+    sanitize: boolean;
+    hideDownloadButtons: boolean;
     downloadFileName?: string;
     downloadDefinitionUrl?: string;
+    downloadUrls?: DownloadUrlsConfig;
     disableSearch: boolean;
     onlyRequiredInSamples: boolean;
     showExtensions: boolean | string[];
@@ -82,13 +96,14 @@ export declare class RedocNormalizedOptions {
     hideSingleRequestSampleTab: boolean;
     hideRequestPayloadSample: boolean;
     menuToggle: boolean;
-    jsonSampleExpandLevel: number;
+    jsonSamplesExpandLevel: number;
     enumSkipQuotes: boolean;
     hideSchemaTitles: boolean;
     simpleOneOfTypeLabel: boolean;
     payloadSampleIdx: number;
     expandSingleSchemaField: boolean;
-    schemaExpansionLevel: number;
+    schemasExpansionLevel: number;
+    schemaDefinitionsTagName?: string;
     showObjectSchemaExamples: boolean;
     showSecuritySchemeType?: boolean;
     hideSecuritySection?: boolean;
@@ -98,10 +113,11 @@ export declare class RedocNormalizedOptions {
     maxDisplayedEnumValues?: number;
     ignoreNamedSchemas: Set<string>;
     hideSchemaPattern: boolean;
-    generatedPayloadSamplesMaxDepth: number;
+    generatedSamplesMaxDepth: number;
     hideFab: boolean;
     minCharacterLengthToInitSearch: number;
     showWebhookVerb: boolean;
+    hidePropertiesPrefix?: boolean;
     nonce?: string;
     constructor(raw: RedocRawOptions, defaults?: RedocRawOptions);
 }

package/typings/services/models/ApiInfo.d.ts

@@ -11,9 +11,13 @@ export declare class ApiInfoModel implements OpenAPIInfo {
     termsOfService?: string;
     contact?: OpenAPIContact;
     license?: OpenAPILicense;
-    downloadLink?: string;
+    downloadUrls: {
+        title?: string;
+        url?: string;
+    }[];
     downloadFileName?: string;
     constructor(parser: OpenAPIParser, options?: RedocNormalizedOptions);
+    private getDownloadUrls;
     private getDownloadLink;
     private getDownloadFileName;
 }

package/typings/services/models/MediaType.d.ts

@@ -11,7 +11,7 @@ export declare class MediaTypeModel {
     name: string;
     isRequestType: boolean;
     onlyRequiredInSamples: boolean;
-    generatedPayloadSamplesMaxDepth: number;
+    generatedSamplesMaxDepth: number;
     /**
      * @param isRequestType needed to know if skipe RO/RW fields in objects
      */

package/typings/services/models/Schema.d.ts

@@ -36,6 +36,9 @@ export declare class SchemaModel {
     rawSchema: OpenAPISchema;
     schema: MergedOpenAPISchema;
     extensions?: Record<string, any>;
+    'x-enumDescriptions': {
+        [name: string]: string;
+    };
     const: any;
     contentEncoding?: string;
     contentMediaType?: string;

package/typings/utils/openapi.d.ts

@@ -17,7 +17,7 @@ export declare function serializeParameterValueWithMime(value: any, mime: string
 export declare function serializeParameterValue(parameter: (OpenAPIParameter & {
     serializationMime?: string;
 }) | FieldModel, value: any): string;
-export declare function getSerializedValue(field: FieldModel, example: any): string;
+export declare function getSerializedValue(field: FieldModel, example: any): any;
 export declare function langFromMime(contentType: string): string;
 export declare function isNamedDefinition(pointer?: string): boolean;
 export declare function getDefinitionName(pointer?: string): string | undefined;