redoc 2.0.0-rc.21 → 2.0.0-rc.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redoc",
-  "version": "2.0.0-rc.21",
+  "version": "2.0.0-rc.25",
   "description": "ReDoc",
   "repository": {
     "type": "git",
@@ -42,7 +42,7 @@
     "stats": "webpack --env.standalone --json --profile --mode=production > stats.json",
     "prettier": "prettier --write \"cli/index.ts\" \"src/**/*.{ts,tsx}\"",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
-    "lint": "tslint --project tsconfig.json",
+    "lint": "eslint 'src/**/*.{js,ts,tsx}'",
     "benchmark": "node ./benchmark/benchmark.js",
     "start:demo": "webpack-dev-server --hot --config demo/webpack.config.ts --mode=development",
     "compile:cli": "tsc custom.d.ts cli/index.ts --target es6 --module commonjs --types yargs",
@@ -52,47 +52,52 @@
     "docker:build": "docker build -f config/docker/Dockerfile -t redoc ."
   },
   "devDependencies": {
-    "@babel/core": "7.7.5",
-    "@babel/plugin-syntax-decorators": "7.7.4",
-    "@babel/plugin-syntax-dynamic-import": "^7.7.4",
-    "@babel/plugin-syntax-jsx": "7.7.4",
-    "@babel/plugin-syntax-typescript": "7.7.4",
-    "@cypress/webpack-preprocessor": "4.1.1",
-    "@hot-loader/react-dom": "^16.11.0",
-    "@types/chai": "4.2.7",
-    "@types/dompurify": "^2.0.0",
-    "@types/enzyme": "^3.10.4",
+    "@babel/core": "7.8.7",
+    "@babel/plugin-syntax-decorators": "7.8.3",
+    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
+    "@babel/plugin-syntax-jsx": "7.8.3",
+    "@babel/plugin-syntax-typescript": "7.8.3",
+    "@cypress/webpack-preprocessor": "4.1.3",
+    "@hot-loader/react-dom": "^16.12.0",
+    "@types/chai": "4.2.10",
+    "@types/dompurify": "^2.0.1",
+    "@types/enzyme": "^3.10.5",
     "@types/enzyme-to-json": "^1.5.3",
-    "@types/jest": "^24.0.23",
+    "@types/jest": "^25.1.4",
     "@types/json-pointer": "^1.0.30",
     "@types/lodash": "^4.14.149",
     "@types/lunr": "^2.3.2",
     "@types/mark.js": "^8.11.5",
-    "@types/marked": "^0.7.2",
+    "@types/marked": "^0.7.3",
     "@types/prismjs": "^1.16.0",
     "@types/prop-types": "^15.7.3",
-    "@types/react": "^16.9.16",
-    "@types/react-dom": "^16.9.4",
+    "@types/react": "^16.9.23",
+    "@types/react-dom": "^16.9.5",
     "@types/react-tabs": "^2.3.1",
     "@types/styled-components": "^4.4.1",
-    "@types/tapable": "1.0.4",
-    "@types/webpack": "^4.41.0",
-    "@types/webpack-env": "^1.14.1",
+    "@types/tapable": "1.0.5",
+    "@types/webpack": "^4.41.7",
+    "@types/webpack-env": "^1.15.1",
     "@types/yargs": "^13.0.3",
+    "@typescript-eslint/eslint-plugin": "^2.24.0",
+    "@typescript-eslint/parser": "^2.24.0",
     "babel-loader": "8.0.6",
-    "babel-plugin-styled-components": "^1.10.6",
+    "babel-plugin-styled-components": "^1.10.7",
     "beautify-benchmark": "^0.2.4",
     "bundlesize": "^0.18.0",
-    "conventional-changelog-cli": "^2.0.28",
+    "conventional-changelog-cli": "^2.0.31",
     "copy-webpack-plugin": "^5.1.1",
     "core-js": "^3.5.0",
     "coveralls": "^3.0.9",
-    "css-loader": "^3.3.0",
+    "css-loader": "^3.4.2",
     "cypress": "~3.7.0",
     "deploy-to-gh-pages": "^1.3.7",
-    "enzyme": "^3.10.0",
-    "enzyme-adapter-react-16": "^1.15.1",
-    "enzyme-to-json": "^3.4.3",
+    "enzyme": "^3.11.0",
+    "enzyme-adapter-react-16": "^1.15.2",
+    "enzyme-to-json": "^3.4.4",
+    "eslint": "^6.8.0",
+    "eslint-plugin-import": "^2.20.1",
+    "eslint-plugin-react": "^7.19.0",
     "fork-ts-checker-webpack-plugin": "3.1.1",
     "html-webpack-plugin": "^3.1.0",
     "jest": "^24.9.0",
@@ -100,27 +105,24 @@
     "lodash": "^4.17.15",
     "mobx": "^4.3.1",
     "prettier": "^1.19.1",
-    "prettier-eslint": "^9.0.1",
     "raf": "^3.4.1",
-    "react": "^16.12.0",
-    "react-hot-loader": "^4.12.18",
-    "react-dom": "^16.12.0",
-    "rimraf": "^3.0.0",
+    "react": "^16.13.0",
+    "react-dom": "^16.13.0",
+    "react-hot-loader": "^4.12.19",
+    "rimraf": "^3.0.2",
     "shelljs": "^0.8.3",
     "source-map-loader": "^0.2.4",
-    "style-loader": "^1.0.1",
+    "style-loader": "^1.1.3",
     "styled-components": "^4.4.1",
     "ts-jest": "24.2.0",
     "ts-loader": "6.2.1",
-    "ts-node": "^8.5.4",
-    "tslint": "^5.20.1",
-    "tslint-react": "^4.1.0",
-    "typescript": "^3.7.3",
+    "ts-node": "^8.6.2",
+    "typescript": "^3.8.3",
     "unfetch": "^4.1.0",
-    "url-polyfill": "^1.1.7",
-    "webpack": "^4.41.2",
-    "webpack-cli": "^3.3.10",
-    "webpack-dev-server": "^3.9.0",
+    "url-polyfill": "^1.1.8",
+    "webpack": "^4.42.0",
+    "webpack-cli": "^3.3.11",
+    "webpack-dev-server": "^3.10.3",
     "webpack-node-externals": "^1.6.0",
     "workerize-loader": "^1.1.0",
     "yaml-js": "^0.2.3"
@@ -135,7 +137,7 @@
   "dependencies": {
     "classnames": "^2.2.6",
     "decko": "^1.2.0",
-    "dompurify": "^2.0.7",
+    "dompurify": "^2.0.8",
     "eventemitter3": "^4.0.0",
     "json-pointer": "^0.6.0",
     "json-schema-ref-parser": "^6.1.0",
@@ -143,18 +145,18 @@
     "mark.js": "^8.11.1",
     "marked": "^0.7.0",
     "memoize-one": "~5.1.1",
-    "mobx-react": "^6.1.4",
+    "mobx-react": "6.1.5",
     "openapi-sampler": "1.0.0-beta.15",
     "perfect-scrollbar": "^1.4.0",
-    "polished": "^3.4.2",
-    "prismjs": "^1.17.1",
+    "polished": "^3.4.4",
+    "prismjs": "^1.19.0",
     "prop-types": "^15.7.2",
-    "react-dropdown": "^1.6.4",
-    "react-tabs": "^3.0.0",
-    "slugify": "^1.3.6",
+    "react-dropdown": "^1.7.0",
+    "react-tabs": "^3.1.0",
+    "slugify": "^1.4.0",
     "stickyfill": "^1.1.1",
-    "swagger2openapi": "^5.3.1",
-    "tslib": "^1.10.0",
+    "swagger2openapi": "^5.3.4",
+    "tslib": "^1.11.1",
     "url-template": "^2.0.8"
   },
   "bundlesize": [

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

@@ -3,7 +3,7 @@ export declare const MiddlePanel: import("styled-components").StyledComponent<"d
     compact?: boolean | undefined;
 }, never>;
 export declare const Section: import("styled-components").StyledComponent<"div", import("../theme").ResolvedThemeInterface, {
-    [SECTION_ATTR]: string | undefined;
+    "data-section-id": string | undefined;
 } & {
     underlined?: boolean | undefined;
 }, "data-section-id">;

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

@@ -6,6 +6,7 @@ export interface FieldProps extends SchemaOptions {
     isLast?: boolean;
     showExamples?: boolean;
     field: FieldModel;
+    expandByDefault?: boolean;
     renderDiscriminatorSwitch?: (opts: FieldProps) => JSX.Element;
 }
 export declare class Field extends React.Component<FieldProps> {

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

@@ -10,6 +10,7 @@ export interface BaseMarkdownProps {
 export declare type MarkdownProps = BaseMarkdownProps & StylingMarkdownProps & {
     source: string;
     className?: string;
+    'data-role'?: string;
 };
 export declare class Markdown extends React.Component<MarkdownProps> {
     render(): JSX.Element;

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

@@ -3,4 +3,5 @@ import { StylingMarkdownProps } from './Markdown';
 export declare function SanitizedMarkdownHTML(props: StylingMarkdownProps & {
     html: string;
     className?: string;
+    'data-role'?: string;
 }): JSX.Element;

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

@@ -1,6 +1,6 @@
-import Dropdown from 'react-dropdown';
+import ReactDropdown from 'react-dropdown';
 export declare const MimeLabel: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
 export declare const DropdownLabel: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {}, never>;
 export declare const DropdownWrapper: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
-export declare const InvertedSimpleDropdown: import("styled-components").StyledComponent<typeof Dropdown, import("../../theme").ResolvedThemeInterface, {}, never>;
+export declare const InvertedSimpleDropdown: import("styled-components").StyledComponent<typeof ReactDropdown, import("../../theme").ResolvedThemeInterface, {}, never>;
 export declare const NoSampleLabel: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;

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

@@ -8,6 +8,7 @@ export interface ObjectSchemaProps extends SchemaProps {
     };
 }
 export declare class ObjectSchema extends React.Component<ObjectSchemaProps> {
+    static contextType: React.Context<import("../..").RedocNormalizedOptions>;
     get parentSchema(): SchemaModel;
     render(): JSX.Element;
 }

package/typings/components/SearchBox/SearchBox.d.ts

@@ -23,6 +23,7 @@ export declare class SearchBox extends React.PureComponent<SearchBoxProps, Searc
     clear: () => void;
     handleKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
     setResults(results: SearchResult[], term: string): void;
+    searchCallback(searchTerm: string): void;
     search: (event: React.ChangeEvent<HTMLInputElement>) => void;
     render(): JSX.Element;
 }

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

@@ -1,18 +1,19 @@
-export declare const OperationBadge: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {
+import { ResolvedThemeInterface } from '../../styled-components';
+export declare const OperationBadge: import("styled-components").StyledComponent<"span", ResolvedThemeInterface, {
     className: string;
 } & {
     type: string;
 }, "className">;
-export declare const MenuItemUl: import("styled-components").StyledComponent<"ul", import("../../theme").ResolvedThemeInterface, {
+export declare const MenuItemUl: import("styled-components").StyledComponent<"ul", ResolvedThemeInterface, {
     expanded: boolean;
 }, never>;
-export declare const MenuItemLi: import("styled-components").StyledComponent<"li", import("../../theme").ResolvedThemeInterface, {
+export declare const MenuItemLi: import("styled-components").StyledComponent<"li", ResolvedThemeInterface, {
     depth: number;
 }, never>;
 export declare const menuItemDepth: {
-    0: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, import("../../theme").ResolvedThemeInterface>>;
-    1: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, import("../../theme").ResolvedThemeInterface>>;
-    2: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, import("../../theme").ResolvedThemeInterface>>;
+    0: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, ResolvedThemeInterface>>;
+    1: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, ResolvedThemeInterface>>;
+    2: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, ResolvedThemeInterface>>;
 };
 export interface MenuItemLabelType {
     depth: number;
@@ -20,11 +21,11 @@ export interface MenuItemLabelType {
     deprecated?: boolean;
     type?: string;
 }
-export declare const MenuItemLabel: import("styled-components").StyledComponent<"label", import("../../theme").ResolvedThemeInterface, {
+export declare const MenuItemLabel: import("styled-components").StyledComponent<"label", ResolvedThemeInterface, {
     role: "menuitem";
     className: any;
 } & MenuItemLabelType, "className" | "role">;
-export declare const MenuItemTitle: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {
+export declare const MenuItemTitle: import("styled-components").StyledComponent<"span", ResolvedThemeInterface, {
     width?: string | undefined;
 }, never>;
-export declare const RedocAttribution: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
+export declare const RedocAttribution: import("styled-components").StyledComponent<"div", ResolvedThemeInterface, {}, never>;

package/typings/services/OpenAPIParser.d.ts

@@ -47,7 +47,7 @@ export declare class OpenAPIParser {
      * returns map of definition pointer to definition name
      * @param $refs array of references to find derived from
      */
-    findDerived($refs: string[]): Dict<string[]>;
+    findDerived($refs: string[]): Dict<string[] | string>;
     exitParents(shema: MergedOpenAPISchema): void;
     private hoistOneOfs;
 }

package/typings/services/RedocNormalizedOptions.d.ts

@@ -22,6 +22,7 @@ export interface RedocRawOptions {
     jsonSampleExpandLevel?: number | string | 'all';
     hideSchemaTitles?: boolean | string;
     payloadSampleIdx?: number;
+    expandSingleSchemaField?: boolean | string;
     unstable_ignoreMimeParameters?: boolean;
     allowedMdComponents?: Dict<MDXComponentMeta>;
     labels?: LabelsConfigRaw;
@@ -57,6 +58,7 @@ export declare class RedocNormalizedOptions {
     enumSkipQuotes: boolean;
     hideSchemaTitles: boolean;
     payloadSampleIdx: number;
+    expandSingleSchemaField: boolean;
     unstable_ignoreMimeParameters: boolean;
     allowedMdComponents: Dict<MDXComponentMeta>;
     expandDefaultServerVariables: boolean;

package/typings/services/SearchStore.d.ts

@@ -5,6 +5,7 @@ export declare class SearchStore<T> {
     searchWorker: Worker;
     indexItems(groups: Array<IMenuItem | OperationModel>): void;
     add(title: string, body: string, meta?: T): void;
+    dispose(): void;
     search(q: string): Promise<import("./SearchWorker.worker").SearchResult<T>[]>;
     toJS(): Promise<{
         store: any[];

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

@@ -6,7 +6,7 @@ import { SchemaModel } from './Schema';
  * Field or Parameter model ready to be used by components
  */
 export declare class FieldModel {
-    expanded: boolean;
+    expanded: boolean | undefined;
     schema: SchemaModel;
     name: string;
     required: boolean;

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

@@ -7,7 +7,6 @@ import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
  * Contains multiple MediaTypes and keeps track of the currently active one
  */
 export declare class MediaContentModel {
-    parser: OpenAPIParser;
     isRequestType: boolean;
     mediaTypes: MediaTypeModel[];
     activeMimeIdx: number;

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

@@ -42,7 +42,6 @@ export declare class OperationModel implements IMenuItem {
     path: string;
     servers: OpenAPIServer[];
     security: SecurityRequirementModel[];
-    codeSamples: Array<OpenAPIXCodeSample | XPayloadSample>;
     extensions: Dict<any>;
     constructor(parser: OpenAPIParser, operationSpec: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: RedocNormalizedOptions);
     /**
@@ -56,6 +55,7 @@ export declare class OperationModel implements IMenuItem {
     expand(): void;
     collapse(): void;
     get requestBody(): RequestBodyModel | undefined;
+    get codeSamples(): (OpenAPIXCodeSample | XPayloadSample)[];
     get parameters(): FieldModel[];
     get responses(): ResponseModel[];
 }

package/typings/theme.d.ts

@@ -99,7 +99,7 @@ export interface ResolvedThemeInterface {
             hover: string;
         };
     };
-    menu: {
+    sidebar: {
         width: string;
         backgroundColor: string;
         textColor: string;
@@ -125,7 +125,7 @@ export interface ResolvedThemeInterface {
         textColor: string;
         width: string;
     };
-    codeSample: {
+    codeBlock: {
         backgroundColor: string;
     };
     extensionsHook?: (name: string, props: any) => string;

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

@@ -144,6 +144,7 @@ export interface OpenAPISchema {
 export interface OpenAPIDiscriminator {
   propertyName: string;
   mapping?: { [name: string]: string };
+  'x-explicitMappingOnly'?: boolean;
 }
 
 export interface OpenAPIMediaType {

package/typings/utils/highlight.d.ts

@@ -5,6 +5,7 @@ import 'prismjs/components/prism-coffeescript.js';
 import 'prismjs/components/prism-cpp.js';
 import 'prismjs/components/prism-csharp.js';
 import 'prismjs/components/prism-go.js';
+import 'prismjs/components/prism-http.js';
 import 'prismjs/components/prism-java.js';
 import 'prismjs/components/prism-lua.js';
 import 'prismjs/components/prism-markup-templating.js';