redoc 2.0.0 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redoc",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "ReDoc",
   "repository": {
     "type": "git",
@@ -44,15 +44,14 @@
     "bundle:standalone": "webpack --env production --env standalone --mode=production",
     "bundle:lib": "webpack --mode=production && npm run declarations",
     "bundle:browser": "webpack --env production --env browser --mode=production",
-    "bundle": "npm run bundle:clean && npm run bundle:lib && npm run bundle:browser && npm run bundle:standalone && npm run compile:cli",
+    "bundle": "npm run bundle:clean && npm run bundle:lib && npm run bundle:browser && npm run bundle:standalone",
     "declarations": "tsc --emitDeclarationOnly -p tsconfig.lib.json && cp -R src/types typings/",
     "stats": "webpack --env production --env standalone --json --profile --mode=production > stats.json",
-    "prettier": "prettier --write \"cli/index.ts\" \"src/**/*.{ts,tsx}\"",
+    "prettier": "prettier --write \"src/**/*.{ts,tsx}\"",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
     "lint": "eslint --fix 'src/**/*.{js,ts,tsx}' --cache",
     "benchmark": "node ./benchmark/benchmark.js",
     "start:demo": "webpack serve --hot --config demo/webpack.config.ts --mode=development",
-    "compile:cli": "tsc custom.d.ts cli/index.ts --target es6 --module commonjs --types yargs",
     "build:demo": "webpack --mode=production --config demo/webpack.config.ts",
     "publish-cdn": "scripts/publish-cdn.sh",
     "deploy:demo": "aws s3 sync demo/dist s3://production-redoc-demo --acl=public-read",
@@ -62,9 +61,9 @@
     "pre-commit": "pretty-quick --staged && npm run lint"
   },
   "devDependencies": {
-    "@cypress/webpack-preprocessor": "^5.12.0",
+    "@cypress/webpack-preprocessor": "^5.17.1",
     "@hot-loader/react-dom": "^17.0.2",
-    "@size-limit/preset-app": "^7.0.4",
+    "@size-limit/preset-app": "^8.2.6",
     "@types/chai": "^4.2.18",
     "@types/dompurify": "^2.2.2",
     "@types/enzyme": "^3.10.5",
@@ -83,21 +82,21 @@
     "@types/styled-components": "^5.1.1",
     "@types/tapable": "^2.2.2",
     "@types/webpack": "^5.28.0",
-    "@types/webpack-env": "^1.16.0",
+    "@types/webpack-env": "^1.18.0",
     "@types/yargs": "^17.0.0",
     "@typescript-eslint/eslint-plugin": "^4.26.0",
     "@typescript-eslint/parser": "^4.26.0",
     "@wojtekmaj/enzyme-adapter-react-17": "^0.6.1",
     "beautify-benchmark": "^0.2.4",
-    "conventional-changelog-cli": "^2.0.34",
+    "conventional-changelog-cli": "^3.0.0",
     "copy-webpack-plugin": "^9.0.0",
     "core-js": "^3.13.1",
-    "coveralls": "^3.1.0",
+    "coveralls": "^3.1.1",
     "css-loader": "^5.2.6",
-    "cypress": "^7.4.0",
+    "cypress": "^12.17.1",
     "enzyme": "^3.11.0",
     "enzyme-to-json": "^3.6.2",
-    "esbuild-loader": "^2.18.0",
+    "esbuild-loader": "^3.0.1",
     "eslint": "^7.27.0",
     "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-react": "^7.25.1",
@@ -119,29 +118,30 @@
     "react-hot-loader": "^4.13.0",
     "rimraf": "^3.0.2",
     "shelljs": "^0.8.4",
-    "size-limit": "^7.0.4",
+    "size-limit": "^8.2.6",
+    "style-loader": "^3.3.1",
     "styled-components": "^5.3.0",
     "ts-jest": "^27.0.2",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.0.0",
+    "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
-    "typescript": "~4.1.0",
+    "typescript": "^4.8.4",
     "unfetch": "^4.2.0",
-    "webpack": "^5.50.1",
-    "webpack-cli": "^4.7.2",
-    "webpack-dev-server": "^4.6.0",
+    "url": "^0.11.1",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.15.1",
     "webpack-node-externals": "^3.0.0",
     "workerize-loader": "github:redocly/workerize-loader#webpack-5-dist"
   },
   "peerDependencies": {
     "core-js": "^3.1.4",
     "mobx": "^6.0.4",
-    "react": "^16.8.4 || ^17.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0",
-    "styled-components": "^4.1.1 || ^5.1.1"
+    "react": "^16.8.4 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0",
+    "styled-components": "^4.1.1 || ^5.1.1 || ^6.0.5"
   },
   "dependencies": {
-    "@redocly/openapi-core": "^1.0.0-beta.104",
+    "@redocly/openapi-core": "^1.0.0-rc.2",
     "classnames": "^2.3.1",
     "decko": "^1.2.0",
     "dompurify": "^2.2.8",
@@ -151,7 +151,7 @@
     "mark.js": "^8.11.1",
     "marked": "^4.0.15",
     "mobx-react": "^7.2.0",
-    "openapi-sampler": "^1.3.0",
+    "openapi-sampler": "^1.3.1",
     "path-browserify": "^1.0.1",
     "perfect-scrollbar": "^1.5.5",
     "polished": "^4.1.3",
@@ -160,7 +160,6 @@
     "react-tabs": "^3.2.2",
     "slugify": "~1.4.7",
     "stickyfill": "^1.1.1",
-    "style-loader": "^3.3.1",
     "swagger2openapi": "^7.0.6",
     "url-template": "^2.0.8"
   },

package/typings/common-elements/fields.d.ts

@@ -6,8 +6,12 @@ export declare const TypePrefix: import("styled-components").StyledComponent<"sp
 export declare const TypeName: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;
 export declare const TypeTitle: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;
 export declare const TypeFormat: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;
-export declare const RequiredLabel: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {}, never>;
-export declare const PropertyLabel: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {}, never>;
+export declare const RequiredLabel: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {
+    as: string;
+}, "as">;
+export declare const PropertyLabel: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {
+    as: string;
+}, "as">;
 export declare const RecursiveLabel: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;
 export declare const PatternLabel: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;
 export declare const ExampleValue: import("styled-components").StyledComponent<"span", import("../theme").ResolvedThemeInterface, {}, never>;

package/typings/common-elements/panels.d.ts

@@ -1,4 +1,3 @@
-import { SECTION_ATTR } from '../services/MenuStore';
 export declare const MiddlePanel: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {
     compact?: boolean | undefined;
 }, never>;

package/typings/common-elements/samples.d.ts

@@ -1,3 +1,5 @@
 export declare const SampleControls: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {}, never>;
 export declare const SampleControlsWrap: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {}, never>;
-export declare const StyledPre: import("styled-components").StyledComponent<"pre", import("../theme").ResolvedThemeInterface, {}, never>;
+export declare const StyledPre: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {
+    as: string;
+}, "as">;

package/typings/components/DropdownOrLabel/DropdownOrLabel.d.ts

@@ -2,7 +2,7 @@ import * as React from 'react';
 import { StyledComponent } from 'styled-components';
 import { DropdownProps } from '../../common-elements/Dropdown';
 export interface DropdownOrLabelProps extends DropdownProps {
-    Label?: StyledComponent<any, any, GenericObject, never>;
+    Label?: StyledComponent<any, any, Record<string, any>, never>;
     Dropdown?: StyledComponent<React.NamedExoticComponent<DropdownProps>, any, {
         fullWidth?: boolean | undefined;
     }, never>;

package/typings/components/Endpoint/styled.elements.d.ts

@@ -5,7 +5,7 @@ export declare const EndpointInfo: import("styled-components").StyledComponent<"
     inverted?: boolean | undefined;
 }, never>;
 export declare const HttpVerb: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {
-    className: string;
+    className: `http-verb ${string}`;
 } & {
     type: string;
     compact?: boolean | undefined;

package/typings/components/Markdown/Markdown.d.ts

@@ -7,7 +7,7 @@ export interface BaseMarkdownProps {
     sanitize?: boolean;
     source: string;
 }
-export declare type MarkdownProps = BaseMarkdownProps & StylingMarkdownProps & {
+export type MarkdownProps = BaseMarkdownProps & StylingMarkdownProps & {
     source: string;
     className?: string;
     'data-role'?: string;

package/typings/components/Parameters/Parameters.d.ts

@@ -12,4 +12,5 @@ export declare class Parameters extends React.PureComponent<ParametersProps> {
 export declare function BodyContent(props: {
     content: MediaContentModel;
     description?: string;
+    bodyRequired?: boolean;
 }): JSX.Element;

package/typings/components/Responses/styled.elements.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="react" />
 export declare const StyledResponseTitle: import("styled-components").StyledComponent<import("react").NamedExoticComponent<import("./ResponseTitle").ResponseTitleProps>, import("../../theme").ResolvedThemeInterface, {}, never>;
 export declare const ResponseDetailsWrap: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
-export declare const HeadersCaption: import("styled-components").StyledComponent<"caption", import("../../theme").ResolvedThemeInterface, {}, never>;
+export declare const HeadersCaption: import("styled-components").StyledComponent<"h5", import("../../theme").ResolvedThemeInterface, {
+    as: string;
+}, "as">;
 export declare const Code: import("styled-components").StyledComponent<"strong", import("../../theme").ResolvedThemeInterface, {}, never>;

package/typings/components/SchemaDefinition/SchemaDefinition.d.ts

@@ -5,6 +5,7 @@ export interface ObjectDescriptionProps {
     exampleRef?: string;
     showReadOnly?: boolean;
     showWriteOnly?: boolean;
+    showExample?: boolean;
     parser: OpenAPIParser;
     options: RedocNormalizedOptions;
 }

package/typings/components/SideMenu/styled.elements.d.ts

@@ -1,6 +1,6 @@
 import { ResolvedThemeInterface } from '../../styled-components';
 export declare const OperationBadge: import("styled-components").StyledComponent<"span", ResolvedThemeInterface, {
-    className: string;
+    className: `operation-type ${string}`;
 } & {
     type: string;
 }, "className">;
@@ -21,9 +21,8 @@ export interface MenuItemLabelType {
     type?: string;
 }
 export declare const MenuItemLabel: import("styled-components").StyledComponent<"label", ResolvedThemeInterface, {
-    role: "menuitem";
     className: string;
-} & MenuItemLabelType, "className" | "role">;
+} & MenuItemLabelType, "className">;
 export declare const MenuItemTitle: import("styled-components").StyledComponent<"span", ResolvedThemeInterface, {
     width?: string | undefined;
 }, never>;

package/typings/services/MenuBuilder.d.ts

@@ -41,4 +41,9 @@ 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, }: {
+        parser: OpenAPIParser;
+        tag: TagInfo;
+        parent: GroupModel;
+    }): GroupModel[];
 }

package/typings/services/OpenAPIParser.d.ts

@@ -12,7 +12,7 @@ export declare class OpenAPIParser {
     spec: OpenAPISpec;
     private readonly allowMergeRefs;
     constructor(spec: OpenAPISpec, specUrl?: string, options?: RedocNormalizedOptions);
-    validate(spec: GenericObject): void;
+    validate(spec: Record<string, any>): void;
     /**
      * get spec part by JsonPointer ($ref)
      */

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

@@ -2,7 +2,7 @@ import type { OpenAPIRequestBody, Referenced } from '../../types';
 import type { OpenAPIParser } from '../OpenAPIParser';
 import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
 import { MediaContentModel } from './MediaContent';
-declare type RequestBodyProps = {
+type RequestBodyProps = {
     parser: OpenAPIParser;
     infoOrRef: Referenced<OpenAPIRequestBody>;
     options: RedocNormalizedOptions;
@@ -10,7 +10,7 @@ declare type RequestBodyProps = {
 };
 export declare class RequestBodyModel {
     description: string;
-    required: boolean;
+    required?: boolean;
     content?: MediaContentModel;
     constructor({ parser, infoOrRef, options, isEvent }: RequestBodyProps);
 }

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

@@ -3,7 +3,7 @@ import type { OpenAPIParser } from '../OpenAPIParser';
 import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
 import { FieldModel } from './Field';
 import { MediaContentModel } from './MediaContent';
-declare type ResponseProps = {
+type ResponseProps = {
     parser: OpenAPIParser;
     code: string;
     defaultAsError: boolean;

package/typings/services/types.d.ts

@@ -35,7 +35,7 @@ export interface LabelsConfig {
     requestSamples: string;
     responseSamples: string;
 }
-export declare type LabelsConfigRaw = Partial<LabelsConfig>;
+export type LabelsConfigRaw = Partial<LabelsConfig>;
 export interface MDXComponentMeta {
     component: React.ComponentType;
     propsSelector: (store?: AppStore) => any;
@@ -48,12 +48,12 @@ export interface MarkdownHeading {
     items?: MarkdownHeading[];
     description?: string;
 }
-export declare type ContentItemModel = GroupModel | OperationModel;
-export declare type TagInfo = OpenAPITag & {
+export type ContentItemModel = GroupModel | OperationModel;
+export type TagInfo = OpenAPITag & {
     operations: ExtendedOpenAPIOperation[];
     used?: boolean;
 };
-export declare type ExtendedOpenAPIOperation = {
+export type ExtendedOpenAPIOperation = {
     pointer: string;
     pathName: string;
     httpVerb: string;
@@ -61,13 +61,13 @@ export declare type ExtendedOpenAPIOperation = {
     pathServers: Array<OpenAPIServer> | undefined;
     isWebhook: boolean;
 } & OpenAPIOperation;
-export declare type TagsInfoMap = Record<string, TagInfo>;
+export type TagsInfoMap = Record<string, TagInfo>;
 export interface TagGroup {
     name: string;
     tags: string[];
 }
-export declare type MenuItemGroupType = 'group' | 'tag' | 'section';
-export declare type MenuItemType = MenuItemGroupType | 'operation';
+export type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
+export type MenuItemType = MenuItemGroupType | 'operation';
 export interface IMenuItem {
     id: string;
     absoluteIdx?: number;
@@ -100,7 +100,7 @@ export declare enum SideNavStyleEnum {
     PathOnly = "path-only",
     IdOnly = "id-only"
 }
-export declare type MergedOpenAPISchema = OpenAPISchema & {
+export type MergedOpenAPISchema = OpenAPISchema & {
     'x-refsStack'?: string[];
     'x-parentRefs'?: string[];
     'x-circular-ref'?: boolean;

package/typings/styled-components.d.ts

@@ -1,12 +1,9 @@
 import * as styledComponents from 'styled-components';
 import type { ResolvedThemeInterface } from './theme';
 export type { ResolvedThemeInterface };
-declare const styled: styledComponents.ThemedStyledInterface<ResolvedThemeInterface>, css: styledComponents.ThemedCssFunction<ResolvedThemeInterface>, createGlobalStyle: <P extends object = {}>(first: TemplateStringsArray | styledComponents.CSSObject | styledComponents.InterpolationFunction<styledComponents.ThemedStyledProps<P, ResolvedThemeInterface>>, ...interpolations: styledComponents.Interpolation<styledComponents.ThemedStyledProps<P, ResolvedThemeInterface>>[]) => styledComponents.GlobalStyleComponent<P, ResolvedThemeInterface>, keyframes: {
-    (strings: TemplateStringsArray | styledComponents.CSSKeyframes, ...interpolations: styledComponents.SimpleInterpolation[]): styledComponents.Keyframes;
-    (strings: string[] | TemplateStringsArray, ...interpolations: styledComponents.SimpleInterpolation[]): styledComponents.Keyframes;
-}, ThemeProvider: styledComponents.BaseThemeProviderComponent<ResolvedThemeInterface, ResolvedThemeInterface>;
+declare const styled: styledComponents.ThemedStyledInterface<ResolvedThemeInterface>, css: styledComponents.ThemedCssFunction<ResolvedThemeInterface>, createGlobalStyle: <P extends object = {}>(first: TemplateStringsArray | styledComponents.CSSObject | styledComponents.InterpolationFunction<styledComponents.ThemedStyledProps<P, ResolvedThemeInterface>>, ...interpolations: styledComponents.Interpolation<styledComponents.ThemedStyledProps<P, ResolvedThemeInterface>>[]) => styledComponents.GlobalStyleComponent<P, ResolvedThemeInterface>, keyframes: (strings: TemplateStringsArray | styledComponents.CSSKeyframes, ...interpolations: styledComponents.SimpleInterpolation[]) => styledComponents.Keyframes, ThemeProvider: styledComponents.BaseThemeProviderComponent<ResolvedThemeInterface, ResolvedThemeInterface>;
 export declare const media: {
-    lessThan(breakpoint: any, print?: boolean | undefined, extra?: string | undefined): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>;
+    lessThan(breakpoint: any, print?: boolean, extra?: string): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>;
     greaterThan(breakpoint: any): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>;
     between(firstBreakpoint: any, secondBreakpoint: any): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>;
 };

package/typings/theme.d.ts

@@ -155,9 +155,9 @@ export interface ResolvedThemeInterface {
     };
     extensionsHook?: (name: string, props: any) => string;
 }
-export declare type primitive = string | number | boolean | undefined | null;
-export declare type AdvancedThemeDeep<T> = T extends primitive ? T | ((theme: ResolvedThemeInterface) => T) : AdvancedThemeObject<T>;
-export declare type AdvancedThemeObject<T> = {
+export type primitive = string | number | boolean | undefined | null;
+export type AdvancedThemeDeep<T> = T extends primitive ? T | ((theme: ResolvedThemeInterface) => T) : AdvancedThemeObject<T>;
+export type AdvancedThemeObject<T> = {
     [P in keyof T]?: AdvancedThemeDeep<T[P]>;
 };
-export declare type ThemeInterface = AdvancedThemeObject<ResolvedThemeInterface>;
+export type ThemeInterface = AdvancedThemeObject<ResolvedThemeInterface>;

package/typings/types/index.d.ts

@@ -1,2 +1,2 @@
 export * from './open-api';
-export declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;

package/typings/types/open-api.d.ts

@@ -1,4 +1,4 @@
-import { Omit } from './index';
+import type { Omit } from './index';
 export interface OpenAPISpec {
     openapi: string;
     info: OpenAPIInfo;
@@ -41,7 +41,7 @@ export interface OpenAPIRef {
     summary?: string;
     description?: string;
 }
-export declare type Referenced<T> = OpenAPIRef | T;
+export type Referenced<T> = OpenAPIRef | T;
 export interface OpenAPIPath {
     summary?: string;
     description?: string;
@@ -185,8 +185,8 @@ export interface OpenAPIEncoding {
     explode: boolean;
     allowReserved: boolean;
 }
-export declare type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export declare type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+export type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
+export type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 export interface OpenAPIRequestBody {
     description?: string;
     required?: boolean;
@@ -219,7 +219,7 @@ export interface OpenAPIResponse extends Pick<OpenAPIRequestBody, 'description'
 export interface OpenAPILink {
     $ref?: string;
 }
-export declare type OpenAPIHeader = Omit<OpenAPIParameter, 'in' | 'name'>;
+export type OpenAPIHeader = Omit<OpenAPIParameter, 'in' | 'name'>;
 export interface OpenAPICallback {
     [name: string]: OpenAPIPath;
 }

package/typings/types/open-api.ts

@@ -1,4 +1,4 @@
-import { Omit } from './index';
+import type { Omit } from './index';
 
 export interface OpenAPISpec {
   openapi: string;