redoc 2.0.0-rc.9 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +920 -10
- package/README.md +244 -187
- package/bundles/756674defce81e90acea.worker.js.LICENSE.txt +68 -0
- package/bundles/756674defce81e90acea.worker.js.map +1 -0
- package/bundles/redoc.browser.lib.js +1820 -0
- package/bundles/redoc.browser.lib.js.LICENSE.txt +6 -0
- package/bundles/redoc.browser.lib.js.map +1 -0
- package/bundles/redoc.lib.js +1744 -13438
- package/bundles/redoc.lib.js.LICENSE.txt +6 -0
- package/bundles/redoc.lib.js.map +1 -1
- package/bundles/redoc.standalone.js +1819 -122
- package/bundles/redoc.standalone.js.LICENSE.txt +95 -0
- package/bundles/redoc.standalone.js.map +1 -1
- package/package.json +131 -112
- package/typings/common-elements/CopyButtonWrapper.d.ts +4 -10
- package/typings/common-elements/Dropdown/Dropdown.d.ts +3 -0
- package/typings/common-elements/Dropdown/index.d.ts +2 -0
- package/typings/common-elements/Dropdown/styled.d.ts +8 -0
- package/typings/common-elements/Dropdown/types.d.ts +24 -0
- package/typings/common-elements/fields.d.ts +7 -2
- package/typings/common-elements/headers.d.ts +1 -1
- package/typings/common-elements/index.d.ts +1 -1
- package/typings/common-elements/linkify.d.ts +4 -8
- package/typings/common-elements/mixins.d.ts +1 -1
- package/typings/common-elements/panels.d.ts +4 -3
- package/typings/common-elements/samples.d.ts +3 -1
- package/typings/common-elements/schema.d.ts +3 -2
- package/typings/common-elements/shelfs.d.ts +2 -6
- package/typings/components/ApiInfo/styled.elements.d.ts +3 -1
- package/typings/components/ApiLogo/styled.elements.d.ts +1 -0
- package/typings/components/CallbackSamples/CallbackReqSamples.d.ts +11 -0
- package/typings/components/CallbackSamples/CallbackSamples.d.ts +13 -0
- package/typings/components/Callbacks/CallbackDetails.d.ts +8 -0
- package/typings/components/Callbacks/CallbackOperation.d.ts +8 -0
- package/typings/components/Callbacks/CallbackTitle.d.ts +10 -0
- package/typings/components/Callbacks/CallbacksList.d.ts +8 -0
- package/typings/components/Callbacks/index.d.ts +3 -0
- package/typings/components/Callbacks/styled.elements.d.ts +3 -0
- package/typings/components/ContentItems/ContentItems.d.ts +2 -2
- package/typings/components/DropdownOrLabel/DropdownOrLabel.d.ts +6 -3
- package/typings/components/Endpoint/Endpoint.d.ts +1 -0
- package/typings/components/Endpoint/styled.elements.d.ts +3 -2
- package/typings/components/ErrorBoundary.d.ts +2 -2
- package/typings/components/Fields/ArrayItemDetails.d.ts +5 -0
- package/typings/components/Fields/EnumValues.d.ts +8 -2
- package/typings/components/Fields/Examples.d.ts +5 -0
- package/typings/components/Fields/Field.d.ts +4 -2
- package/typings/components/Fields/FieldDetail.d.ts +1 -3
- package/typings/components/Fields/FieldDetails.d.ts +2 -3
- package/typings/components/Fields/Pattern.d.ts +5 -0
- package/typings/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +22 -0
- package/typings/components/JsonViewer/JsonViewer.d.ts +2 -15
- package/typings/components/JsonViewer/style.d.ts +1 -1
- package/typings/components/Loading/Spinner.svg.d.ts +2 -1
- package/typings/components/Markdown/AdvancedMarkdown.d.ts +1 -0
- package/typings/components/Markdown/Markdown.d.ts +2 -1
- package/typings/components/Markdown/SanitizedMdBlock.d.ts +2 -0
- package/typings/components/Markdown/styled.elements.d.ts +1 -1
- package/typings/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +3 -4
- package/typings/components/Operation/Operation.d.ts +4 -6
- package/typings/components/OptionsProvider.d.ts +2 -2
- package/typings/components/Parameters/Parameters.d.ts +7 -1
- package/typings/components/PayloadSamples/Example.d.ts +1 -0
- package/typings/components/PayloadSamples/ExampleValue.d.ts +1 -0
- package/typings/components/PayloadSamples/MediaTypeSamples.d.ts +11 -1
- package/typings/components/PayloadSamples/styled.elements.d.ts +6 -2
- package/typings/components/RedocStandalone.d.ts +2 -11
- package/typings/components/Responses/Response.d.ts +3 -5
- package/typings/components/Responses/ResponseTitle.d.ts +1 -3
- package/typings/components/Responses/ResponsesList.d.ts +1 -0
- package/typings/components/Responses/styled.elements.d.ts +6 -3
- package/typings/components/Schema/DiscriminatorDropdown.d.ts +2 -4
- package/typings/components/Schema/ObjectSchema.d.ts +2 -5
- package/typings/components/Schema/RecursiveSchema.d.ts +3 -0
- package/typings/components/Schema/Schema.d.ts +2 -1
- package/typings/components/SchemaDefinition/SchemaDefinition.d.ts +18 -0
- package/typings/components/SearchBox/SearchBox.d.ts +6 -4
- package/typings/components/SearchBox/styled.elements.d.ts +2 -1
- package/typings/components/SecurityRequirement/OAuthFlow.d.ts +9 -0
- package/typings/components/SecurityRequirement/RequiredScopesRow.d.ts +4 -0
- package/typings/components/SecurityRequirement/SecurityDetails.d.ts +8 -0
- package/typings/components/SecurityRequirement/SecurityHeader.d.ts +8 -0
- package/typings/components/SecurityRequirement/SecurityRequirement.d.ts +2 -10
- package/typings/components/SecurityRequirement/styled.elements.d.ts +17 -0
- package/typings/components/SecuritySchemes/SecuritySchemes.d.ts +7 -9
- package/typings/components/SeeMore/SeeMore.d.ts +7 -0
- package/typings/components/SelectOnClick/SelectOnClick.d.ts +1 -1
- package/typings/components/SideMenu/Logo.d.ts +2 -0
- package/typings/components/SideMenu/MenuItem.d.ts +7 -4
- package/typings/components/SideMenu/MenuItems.d.ts +1 -1
- package/typings/components/SideMenu/SideMenu.d.ts +3 -1
- package/typings/components/SideMenu/styled.elements.d.ts +12 -13
- package/typings/components/SourceCode/SourceCode.d.ts +3 -7
- package/typings/components/StickySidebar/ChevronSvg.d.ts +1 -0
- package/typings/components/StickySidebar/StickyResponsiveSidebar.d.ts +10 -3
- package/typings/components/StoreBuilder.d.ts +7 -18
- package/typings/components/index.d.ts +6 -0
- package/typings/index.d.ts +3 -1
- package/typings/services/AppStore.d.ts +4 -13
- package/typings/services/HistoryService.d.ts +1 -1
- package/typings/services/Labels.d.ts +1 -12
- package/typings/services/MarkdownRenderer.d.ts +7 -16
- package/typings/services/MenuBuilder.d.ts +16 -21
- package/typings/services/MenuStore.d.ts +10 -23
- package/typings/services/OpenAPIParser.d.ts +21 -23
- package/typings/services/RedocNormalizedOptions.d.ts +61 -6
- package/typings/services/ScrollService.d.ts +1 -1
- package/typings/services/SearchStore.d.ts +5 -3
- package/typings/services/SearchWorker.worker.d.ts +5 -9
- package/typings/services/SpecStore.d.ts +6 -4
- package/typings/services/index.d.ts +1 -0
- package/typings/services/models/ApiInfo.d.ts +6 -3
- package/typings/services/models/Callback.d.ts +11 -0
- package/typings/services/models/Example.d.ts +2 -2
- package/typings/services/models/Field.d.ts +12 -6
- package/typings/services/models/Group.model.d.ts +3 -4
- package/typings/services/models/MediaContent.d.ts +6 -7
- package/typings/services/models/MediaType.d.ts +4 -3
- package/typings/services/models/Operation.d.ts +29 -11
- package/typings/services/models/RequestBody.d.ts +12 -5
- package/typings/services/models/Response.d.ts +14 -4
- package/typings/services/models/Schema.d.ts +16 -7
- package/typings/services/models/SecurityRequirement.d.ts +3 -2
- package/typings/services/models/SecuritySchemes.d.ts +3 -2
- package/typings/services/models/Webhook.d.ts +9 -0
- package/typings/services/models/index.d.ts +1 -0
- package/typings/services/types.d.ts +107 -0
- package/typings/styled-components.d.ts +6 -9
- package/typings/styled-patch.d.ts +0 -10
- package/typings/theme.d.ts +32 -6
- package/typings/types/index.d.ts +0 -6
- package/typings/types/index.ts +3 -0
- package/typings/types/open-api.d.ts +251 -213
- package/typings/types/open-api.ts +297 -0
- package/typings/utils/dom.d.ts +1 -0
- package/typings/utils/helpers.d.ts +10 -5
- package/typings/utils/highlight.d.ts +6 -2
- package/typings/utils/index.d.ts +1 -0
- package/typings/utils/jsonToHtml.d.ts +1 -1
- package/typings/utils/openapi.d.ts +23 -14
- package/typings/utils/sort.d.ts +6 -0
- package/bundles/63bafba847dac11ff66b.worker.js.map +0 -1
- package/bundles/ad47ff28a70e23aac7c4.worker.js.map +0 -1
- package/typings/common-elements/dropdown.d.ts +0 -13
- package/typings/types/components.d.ts +0 -5
- /package/typings/components/Fields/{FieldContstraints.d.ts → FieldConstraints.d.ts} +0 -0
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { StyledComponent } from 'styled-components';
|
|
3
|
+
import { DropdownProps } from '../../common-elements/Dropdown';
|
|
3
4
|
export interface DropdownOrLabelProps extends DropdownProps {
|
|
4
|
-
Label?:
|
|
5
|
-
Dropdown?: React.
|
|
5
|
+
Label?: StyledComponent<any, any, Record<string, any>, never>;
|
|
6
|
+
Dropdown?: StyledComponent<React.NamedExoticComponent<DropdownProps>, any, {
|
|
7
|
+
fullWidth?: boolean | undefined;
|
|
8
|
+
}, never>;
|
|
6
9
|
}
|
|
7
10
|
export declare function DropdownOrLabel(props: DropdownOrLabelProps): JSX.Element;
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
export declare const OperationEndpointWrap: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
2
2
|
export declare const ServerRelativeURL: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
3
|
-
export declare const EndpointInfo: import("styled-components").StyledComponent<"
|
|
3
|
+
export declare const EndpointInfo: import("styled-components").StyledComponent<"button", import("../../theme").ResolvedThemeInterface, {
|
|
4
4
|
expanded?: boolean | undefined;
|
|
5
5
|
inverted?: boolean | undefined;
|
|
6
6
|
}, never>;
|
|
7
7
|
export declare const HttpVerb: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {
|
|
8
|
-
className: string
|
|
8
|
+
className: `http-verb ${string}`;
|
|
9
9
|
} & {
|
|
10
10
|
type: string;
|
|
11
|
+
compact?: boolean | undefined;
|
|
11
12
|
}, "className">;
|
|
12
13
|
export declare const ServersOverlay: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {
|
|
13
14
|
expanded: boolean;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
export declare class ErrorBoundary extends React.Component<
|
|
2
|
+
export declare class ErrorBoundary extends React.Component<React.PropsWithChildren<unknown>, {
|
|
3
3
|
error?: Error;
|
|
4
4
|
}> {
|
|
5
5
|
constructor(props: any);
|
|
6
6
|
componentDidCatch(error: any): boolean;
|
|
7
|
-
render():
|
|
7
|
+
render(): JSX.Element;
|
|
8
8
|
}
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
export interface EnumValuesProps {
|
|
3
3
|
values: string[];
|
|
4
|
-
|
|
4
|
+
isArrayType: boolean;
|
|
5
5
|
}
|
|
6
|
-
export
|
|
6
|
+
export interface EnumValuesState {
|
|
7
|
+
collapsed: boolean;
|
|
8
|
+
}
|
|
9
|
+
export declare class EnumValues extends React.PureComponent<EnumValuesProps, EnumValuesState> {
|
|
10
|
+
state: EnumValuesState;
|
|
11
|
+
static contextType: React.Context<import("../../services/RedocNormalizedOptions").RedocNormalizedOptions>;
|
|
12
|
+
private toggle;
|
|
7
13
|
render(): JSX.Element | null;
|
|
8
14
|
}
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
2
|
+
import type { SchemaOptions } from '../Schema/Schema';
|
|
3
|
+
import type { FieldModel } from '../../services/models';
|
|
4
4
|
export interface FieldProps extends SchemaOptions {
|
|
5
5
|
className?: string;
|
|
6
6
|
isLast?: boolean;
|
|
7
7
|
showExamples?: boolean;
|
|
8
8
|
field: FieldModel;
|
|
9
|
+
expandByDefault?: boolean;
|
|
9
10
|
renderDiscriminatorSwitch?: (opts: FieldProps) => JSX.Element;
|
|
10
11
|
}
|
|
11
12
|
export declare class Field extends React.Component<FieldProps> {
|
|
12
13
|
toggle: () => void;
|
|
14
|
+
handleKeyPress: (e: any) => void;
|
|
13
15
|
render(): JSX.Element;
|
|
14
16
|
}
|
|
@@ -4,6 +4,4 @@ export interface FieldDetailProps {
|
|
|
4
4
|
label: string;
|
|
5
5
|
raw?: boolean;
|
|
6
6
|
}
|
|
7
|
-
export declare
|
|
8
|
-
render(): JSX.Element | null;
|
|
9
|
-
}
|
|
7
|
+
export declare const FieldDetail: React.NamedExoticComponent<FieldDetailProps>;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import { FieldProps } from './Field';
|
|
3
|
-
export declare
|
|
4
|
-
|
|
5
|
-
}
|
|
3
|
+
export declare const FieldDetailsComponent: (props: FieldProps) => JSX.Element;
|
|
4
|
+
export declare const FieldDetails: React.NamedExoticComponent<FieldProps>;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { DropdownProps, DropdownOption } from '../../common-elements/Dropdown';
|
|
3
|
+
export interface GenericChildrenSwitcherProps<T> {
|
|
4
|
+
items?: T[];
|
|
5
|
+
options: DropdownOption[];
|
|
6
|
+
label?: string;
|
|
7
|
+
renderDropdown: (props: DropdownProps) => JSX.Element;
|
|
8
|
+
children: (activeItem: T) => JSX.Element;
|
|
9
|
+
}
|
|
10
|
+
export interface GenericChildrenSwitcherState {
|
|
11
|
+
activeItemIdx: number;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* TODO: Refactor this component:
|
|
15
|
+
* Implement rendering dropdown/label directly in this component
|
|
16
|
+
* Accept as a parameter mapper-function for building dropdown option labels
|
|
17
|
+
*/
|
|
18
|
+
export declare class GenericChildrenSwitcher<T> extends React.Component<GenericChildrenSwitcherProps<T>, GenericChildrenSwitcherState> {
|
|
19
|
+
constructor(props: any);
|
|
20
|
+
switchItem: ({ idx }: DropdownOption) => void;
|
|
21
|
+
render(): JSX.Element | null;
|
|
22
|
+
}
|
|
@@ -1,19 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
export interface JsonProps {
|
|
3
3
|
data: any;
|
|
4
4
|
className?: string;
|
|
5
5
|
}
|
|
6
|
-
declare
|
|
7
|
-
node: HTMLDivElement;
|
|
8
|
-
render(): JSX.Element;
|
|
9
|
-
renderInner: ({ renderCopyButton }: {
|
|
10
|
-
renderCopyButton: any;
|
|
11
|
-
}) => JSX.Element;
|
|
12
|
-
expandAll: () => void;
|
|
13
|
-
collapseAll: () => void;
|
|
14
|
-
clickListener: (event: MouseEvent) => void;
|
|
15
|
-
componentDidMount(): void;
|
|
16
|
-
componentWillUnmount(): void;
|
|
17
|
-
}
|
|
18
|
-
export declare const JsonViewer: import("styled-components").StyledComponent<typeof Json, import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
19
|
-
export {};
|
|
6
|
+
export declare const JsonViewer: import("styled-components").StyledComponent<(props: JsonProps) => JSX.Element, import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const jsonStyles: import("styled-components").FlattenInterpolation<import("styled-components").
|
|
1
|
+
export declare const jsonStyles: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, import("../../theme").ResolvedThemeInterface>>;
|
|
@@ -3,6 +3,7 @@ import { AppStore, RedocNormalizedOptions } from '../../services';
|
|
|
3
3
|
import { BaseMarkdownProps } from './Markdown';
|
|
4
4
|
export interface AdvancedMarkdownProps extends BaseMarkdownProps {
|
|
5
5
|
htmlWrap?: (part: JSX.Element) => JSX.Element;
|
|
6
|
+
parentId?: string;
|
|
6
7
|
}
|
|
7
8
|
export declare class AdvancedMarkdown extends React.Component<AdvancedMarkdownProps> {
|
|
8
9
|
render(): JSX.Element;
|
|
@@ -7,9 +7,10 @@ export interface BaseMarkdownProps {
|
|
|
7
7
|
sanitize?: boolean;
|
|
8
8
|
source: string;
|
|
9
9
|
}
|
|
10
|
-
export
|
|
10
|
+
export type MarkdownProps = BaseMarkdownProps & StylingMarkdownProps & {
|
|
11
11
|
source: string;
|
|
12
12
|
className?: string;
|
|
13
|
+
'data-role'?: string;
|
|
13
14
|
};
|
|
14
15
|
export declare class Markdown extends React.Component<MarkdownProps> {
|
|
15
16
|
render(): JSX.Element;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ResolvedThemeInterface } from '../../styled-components';
|
|
2
2
|
import { StyledComponent } from 'styled-components';
|
|
3
|
-
export declare const linksCss: import("styled-components").FlattenInterpolation<import("styled-components").
|
|
3
|
+
export declare const linksCss: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<object, ResolvedThemeInterface>>;
|
|
4
4
|
export declare const StyledMarkdownBlock: StyledComponent<"div", ResolvedThemeInterface, {
|
|
5
5
|
compact?: boolean | undefined;
|
|
6
6
|
inline?: boolean | undefined;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { DropdownProps } from '../../common-elements/
|
|
2
|
+
import { DropdownOption, DropdownProps } from '../../common-elements/Dropdown';
|
|
3
3
|
import { MediaContentModel, MediaTypeModel, SchemaModel } from '../../services/models';
|
|
4
4
|
export interface MediaTypeChildProps {
|
|
5
5
|
schema: SchemaModel;
|
|
@@ -7,12 +7,11 @@ export interface MediaTypeChildProps {
|
|
|
7
7
|
}
|
|
8
8
|
export interface MediaTypesSwitchProps {
|
|
9
9
|
content?: MediaContentModel;
|
|
10
|
+
withLabel?: boolean;
|
|
10
11
|
renderDropdown: (props: DropdownProps) => JSX.Element;
|
|
11
12
|
children: (activeMime: MediaTypeModel) => JSX.Element;
|
|
12
13
|
}
|
|
13
14
|
export declare class MediaTypesSwitch extends React.Component<MediaTypesSwitchProps> {
|
|
14
|
-
switchMedia: ({
|
|
15
|
-
value: any;
|
|
16
|
-
}) => void;
|
|
15
|
+
switchMedia: ({ idx }: DropdownOption) => void;
|
|
17
16
|
render(): JSX.Element | null;
|
|
18
17
|
}
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
import { OperationModel
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { OperationModel } from '../../services/models';
|
|
3
3
|
export interface OperationProps {
|
|
4
|
-
operation:
|
|
5
|
-
}
|
|
6
|
-
export declare class Operation extends React.Component<OperationProps> {
|
|
7
|
-
render(): JSX.Element;
|
|
4
|
+
operation: OperationModel;
|
|
8
5
|
}
|
|
6
|
+
export declare const Operation: ({ operation }: OperationProps) => JSX.Element;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import { RedocNormalizedOptions } from '../services/RedocNormalizedOptions';
|
|
3
3
|
export declare const OptionsContext: React.Context<RedocNormalizedOptions>;
|
|
4
|
-
export declare const OptionsProvider: React.
|
|
5
|
-
export declare const OptionsConsumer: React.
|
|
4
|
+
export declare const OptionsProvider: React.Provider<RedocNormalizedOptions>;
|
|
5
|
+
export declare const OptionsConsumer: React.Consumer<RedocNormalizedOptions>;
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
+
import { MediaContentModel } from '../../services';
|
|
2
3
|
import { FieldModel, RequestBodyModel } from '../../services/models';
|
|
3
4
|
export interface ParametersProps {
|
|
4
5
|
parameters?: FieldModel[];
|
|
5
6
|
body?: RequestBodyModel;
|
|
6
7
|
}
|
|
7
8
|
export declare class Parameters extends React.PureComponent<ParametersProps> {
|
|
8
|
-
orderParams(params: FieldModel[]):
|
|
9
|
+
orderParams(params: FieldModel[]): Record<string, FieldModel[]>;
|
|
9
10
|
render(): JSX.Element | null;
|
|
10
11
|
}
|
|
12
|
+
export declare function BodyContent(props: {
|
|
13
|
+
content: MediaContentModel;
|
|
14
|
+
description?: string;
|
|
15
|
+
bodyRequired?: boolean;
|
|
16
|
+
}): JSX.Element;
|
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
+
import { DropdownOption, DropdownProps } from '../../common-elements';
|
|
2
3
|
import { MediaTypeModel } from '../../services/models';
|
|
3
4
|
export interface PayloadSamplesProps {
|
|
4
5
|
mediaType: MediaTypeModel;
|
|
6
|
+
renderDropdown: (props: DropdownProps) => JSX.Element;
|
|
5
7
|
}
|
|
6
|
-
|
|
8
|
+
interface MediaTypeSamplesState {
|
|
9
|
+
activeIdx: number;
|
|
10
|
+
}
|
|
11
|
+
export declare class MediaTypeSamples extends React.Component<PayloadSamplesProps, MediaTypeSamplesState> {
|
|
12
|
+
state: {
|
|
13
|
+
activeIdx: number;
|
|
14
|
+
};
|
|
15
|
+
switchMedia: ({ idx }: DropdownOption) => void;
|
|
7
16
|
render(): JSX.Element;
|
|
8
17
|
}
|
|
18
|
+
export {};
|
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
export declare const MimeLabel: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
3
|
-
export declare const
|
|
3
|
+
export declare const DropdownLabel: import("styled-components").StyledComponent<"span", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
4
|
+
export declare const DropdownWrapper: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
5
|
+
export declare const InvertedSimpleDropdown: import("styled-components").StyledComponent<import("react").NamedExoticComponent<import("../../common-elements/Dropdown").DropdownProps>, import("../../theme").ResolvedThemeInterface, {
|
|
6
|
+
fullWidth?: boolean | undefined;
|
|
7
|
+
}, never>;
|
|
4
8
|
export declare const NoSampleLabel: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
import * as React from 'react';
|
|
1
|
+
/// <reference types="react" />
|
|
3
2
|
import { RedocRawOptions } from '../services/RedocNormalizedOptions';
|
|
4
3
|
export interface RedocStandaloneProps {
|
|
5
4
|
spec?: object;
|
|
@@ -7,12 +6,4 @@ export interface RedocStandaloneProps {
|
|
|
7
6
|
options?: RedocRawOptions;
|
|
8
7
|
onLoaded?: (e?: Error) => any;
|
|
9
8
|
}
|
|
10
|
-
export declare
|
|
11
|
-
static propTypes: {
|
|
12
|
-
spec: (props: any, _: any, componentName: any) => Error | null;
|
|
13
|
-
specUrl: (props: any, _: any, componentName: any) => Error | null;
|
|
14
|
-
options: PropTypes.Requireable<any>;
|
|
15
|
-
onLoaded: PropTypes.Requireable<any>;
|
|
16
|
-
};
|
|
17
|
-
render(): JSX.Element;
|
|
18
|
-
}
|
|
9
|
+
export declare const RedocStandalone: (props: RedocStandaloneProps) => JSX.Element;
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { ResponseModel } from '../../services/models';
|
|
3
|
-
export
|
|
2
|
+
import type { ResponseModel } from '../../services/models';
|
|
3
|
+
export interface ResponseViewProps {
|
|
4
4
|
response: ResponseModel;
|
|
5
|
-
}> {
|
|
6
|
-
toggle: () => void;
|
|
7
|
-
render(): JSX.Element;
|
|
8
5
|
}
|
|
6
|
+
export declare const ResponseView: ({ response }: ResponseViewProps) => React.ReactElement;
|
|
@@ -8,6 +8,4 @@ export interface ResponseTitleProps {
|
|
|
8
8
|
className?: string;
|
|
9
9
|
onClick?: () => void;
|
|
10
10
|
}
|
|
11
|
-
export declare
|
|
12
|
-
render(): JSX.Element;
|
|
13
|
-
}
|
|
11
|
+
export declare const ResponseTitle: React.NamedExoticComponent<ResponseTitleProps>;
|
|
@@ -2,6 +2,7 @@ import * as React from 'react';
|
|
|
2
2
|
import { ResponseModel } from '../../services/models';
|
|
3
3
|
export interface ResponseListProps {
|
|
4
4
|
responses: ResponseModel[];
|
|
5
|
+
isCallback?: boolean;
|
|
5
6
|
}
|
|
6
7
|
export declare class ResponsesList extends React.PureComponent<ResponseListProps> {
|
|
7
8
|
render(): JSX.Element | null;
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
export declare const StyledResponseTitle: import("styled-components").StyledComponent<
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
export declare const StyledResponseTitle: import("styled-components").StyledComponent<import("react").NamedExoticComponent<import("./ResponseTitle").ResponseTitleProps>, import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
3
3
|
export declare const ResponseDetailsWrap: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
4
|
-
export declare const HeadersCaption: import("styled-components").StyledComponent<"
|
|
4
|
+
export declare const HeadersCaption: import("styled-components").StyledComponent<"h5", import("../../theme").ResolvedThemeInterface, {
|
|
5
|
+
as: string;
|
|
6
|
+
}, "as">;
|
|
7
|
+
export declare const Code: import("styled-components").StyledComponent<"strong", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { DropdownOption } from '../../common-elements/
|
|
2
|
+
import { DropdownOption } from '../../common-elements/Dropdown';
|
|
3
3
|
import { SchemaModel } from '../../services/models';
|
|
4
4
|
export declare class DiscriminatorDropdown extends React.Component<{
|
|
5
5
|
parent: SchemaModel;
|
|
@@ -7,7 +7,5 @@ export declare class DiscriminatorDropdown extends React.Component<{
|
|
|
7
7
|
}> {
|
|
8
8
|
sortOptions(options: DropdownOption[], enumValues: string[]): void;
|
|
9
9
|
render(): JSX.Element | null;
|
|
10
|
-
changeActiveChild: (
|
|
11
|
-
value: any;
|
|
12
|
-
}) => void;
|
|
10
|
+
changeActiveChild: (option: DropdownOption) => void;
|
|
13
11
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
import { SchemaModel } from '../../services/models';
|
|
3
3
|
import { SchemaProps } from './Schema';
|
|
4
4
|
export interface ObjectSchemaProps extends SchemaProps {
|
|
@@ -7,7 +7,4 @@ export interface ObjectSchemaProps extends SchemaProps {
|
|
|
7
7
|
parentSchema: SchemaModel;
|
|
8
8
|
};
|
|
9
9
|
}
|
|
10
|
-
export declare
|
|
11
|
-
readonly parentSchema: SchemaModel;
|
|
12
|
-
render(): JSX.Element;
|
|
13
|
-
}
|
|
10
|
+
export declare const ObjectSchema: ({ schema: { fields, title }, showTitle, discriminator, skipReadOnly, skipWriteOnly, level, }: ObjectSchemaProps) => JSX.Element;
|
|
@@ -4,10 +4,11 @@ export interface SchemaOptions {
|
|
|
4
4
|
showTitle?: boolean;
|
|
5
5
|
skipReadOnly?: boolean;
|
|
6
6
|
skipWriteOnly?: boolean;
|
|
7
|
+
level?: number;
|
|
7
8
|
}
|
|
8
9
|
export interface SchemaProps extends SchemaOptions {
|
|
9
10
|
schema: SchemaModel;
|
|
10
11
|
}
|
|
11
12
|
export declare class Schema extends React.Component<Partial<SchemaProps>> {
|
|
12
|
-
render(): JSX.Element;
|
|
13
|
+
render(): JSX.Element | null;
|
|
13
14
|
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { OpenAPIParser, RedocNormalizedOptions } from '../../services';
|
|
3
|
+
export interface ObjectDescriptionProps {
|
|
4
|
+
schemaRef: string;
|
|
5
|
+
exampleRef?: string;
|
|
6
|
+
showReadOnly?: boolean;
|
|
7
|
+
showWriteOnly?: boolean;
|
|
8
|
+
showExample?: boolean;
|
|
9
|
+
parser: OpenAPIParser;
|
|
10
|
+
options: RedocNormalizedOptions;
|
|
11
|
+
}
|
|
12
|
+
export declare class SchemaDefinition extends React.PureComponent<ObjectDescriptionProps> {
|
|
13
|
+
private static getMediaType;
|
|
14
|
+
private _mediaModel;
|
|
15
|
+
private get mediaModel();
|
|
16
|
+
render(): JSX.Element;
|
|
17
|
+
private renderDropdown;
|
|
18
|
+
}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { IMenuItem } from '../../services/
|
|
3
|
-
import { SearchStore } from '../../services/SearchStore';
|
|
2
|
+
import type { IMenuItem, SearchResult } from '../../services/types';
|
|
3
|
+
import type { SearchStore } from '../../services/SearchStore';
|
|
4
|
+
import type { MarkerService } from '../../services/MarkerService';
|
|
4
5
|
import { MenuItem } from '../SideMenu/MenuItem';
|
|
5
|
-
import { MarkerService } from '../../services/MarkerService';
|
|
6
|
-
import { SearchResult } from '../../services/SearchWorker.worker';
|
|
7
6
|
export interface SearchBoxProps {
|
|
8
7
|
search: SearchStore<string>;
|
|
9
8
|
marker: MarkerService;
|
|
@@ -13,16 +12,19 @@ export interface SearchBoxProps {
|
|
|
13
12
|
}
|
|
14
13
|
export interface SearchBoxState {
|
|
15
14
|
results: SearchResult[];
|
|
15
|
+
noResults: boolean;
|
|
16
16
|
term: string;
|
|
17
17
|
activeItemIdx: number;
|
|
18
18
|
}
|
|
19
19
|
export declare class SearchBox extends React.PureComponent<SearchBoxProps, SearchBoxState> {
|
|
20
20
|
activeItemRef: MenuItem | null;
|
|
21
|
+
static contextType: React.Context<import("../..").RedocNormalizedOptions>;
|
|
21
22
|
constructor(props: any);
|
|
22
23
|
clearResults(term: string): void;
|
|
23
24
|
clear: () => void;
|
|
24
25
|
handleKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
|
|
25
26
|
setResults(results: SearchResult[], term: string): void;
|
|
27
|
+
searchCallback(searchTerm: string): void;
|
|
26
28
|
search: (event: React.ChangeEvent<HTMLInputElement>) => void;
|
|
27
29
|
render(): JSX.Element;
|
|
28
30
|
}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
1
2
|
export declare const SearchWrap: import("styled-components").StyledComponent<"div", import("../../theme").ResolvedThemeInterface, {}, never>;
|
|
2
3
|
export declare const SearchInput: import("styled-components").StyledComponent<"input", import("../../theme").ResolvedThemeInterface, {
|
|
3
4
|
className: "search-input";
|
|
4
5
|
}, "className">;
|
|
5
6
|
export declare const SearchIcon: import("styled-components").StyledComponent<(props: {
|
|
6
|
-
className?: string
|
|
7
|
+
className?: string;
|
|
7
8
|
}) => JSX.Element, import("../../theme").ResolvedThemeInterface, {
|
|
8
9
|
className: "search-icon";
|
|
9
10
|
}, "className">;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { OpenAPISecurityScheme } from '../../types';
|
|
3
|
+
export interface OAuthFlowProps {
|
|
4
|
+
type: string;
|
|
5
|
+
flow: OpenAPISecurityScheme['flows'][keyof OpenAPISecurityScheme['flows']];
|
|
6
|
+
RequiredScopes?: JSX.Element;
|
|
7
|
+
}
|
|
8
|
+
export declare function OAuthFlowComponent(props: OAuthFlowProps): JSX.Element;
|
|
9
|
+
export declare const OAuthFlow: React.NamedExoticComponent<OAuthFlowProps>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { SecuritySchemeModel } from '../../services';
|
|
3
|
+
interface SecuritySchemaProps {
|
|
4
|
+
RequiredScopes?: JSX.Element;
|
|
5
|
+
scheme: SecuritySchemeModel;
|
|
6
|
+
}
|
|
7
|
+
export declare function SecurityDetails(props: SecuritySchemaProps): JSX.Element;
|
|
8
|
+
export {};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { SecurityRequirementModel } from '../../services/models/SecurityRequirement';
|
|
3
|
+
export interface SecurityRequirementProps {
|
|
4
|
+
security: SecurityRequirementModel;
|
|
5
|
+
showSecuritySchemeType?: boolean;
|
|
6
|
+
expanded: boolean;
|
|
7
|
+
}
|
|
8
|
+
export declare function SecurityHeader(props: SecurityRequirementProps): JSX.Element;
|
|
@@ -1,14 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
import { SecurityRequirementModel } from '../../services/models/SecurityRequirement';
|
|
3
|
-
export interface SecurityRequirementProps {
|
|
4
|
-
security: SecurityRequirementModel;
|
|
5
|
-
}
|
|
6
|
-
export declare class SecurityRequirement extends React.PureComponent<SecurityRequirementProps> {
|
|
7
|
-
render(): JSX.Element;
|
|
8
|
-
}
|
|
9
3
|
export interface SecurityRequirementsProps {
|
|
10
4
|
securities: SecurityRequirementModel[];
|
|
11
5
|
}
|
|
12
|
-
export declare
|
|
13
|
-
render(): JSX.Element | null;
|
|
14
|
-
}
|
|
6
|
+
export declare function SecurityRequirements(props: SecurityRequirementsProps): JSX.Element | null;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare const Header: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
2
|
+
export declare const ScopeNameList: import("styled-components").StyledComponent<"ul", any, {}, never>;
|
|
3
|
+
export declare const ScopeName: import("styled-components").StyledComponent<"code", any, {}, never>;
|
|
4
|
+
export declare const SecurityRequirementAndWrap: import("styled-components").StyledComponent<"span", any, {}, never>;
|
|
5
|
+
export declare const SecurityRequirementOrWrap: import("styled-components").StyledComponent<"span", any, {
|
|
6
|
+
expanded?: boolean | undefined;
|
|
7
|
+
}, never>;
|
|
8
|
+
export declare const AuthHeaderColumn: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
9
|
+
export declare const SecuritiesColumn: import("styled-components").StyledComponent<"div", any, {
|
|
10
|
+
expanded?: boolean | undefined;
|
|
11
|
+
}, never>;
|
|
12
|
+
export declare const AuthHeader: import("styled-components").StyledComponent<"h5", any, {}, never>;
|
|
13
|
+
export declare const Wrap: import("styled-components").StyledComponent<"div", any, {
|
|
14
|
+
expanded?: boolean | undefined;
|
|
15
|
+
}, never>;
|
|
16
|
+
export declare const SecurityRow: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
17
|
+
export declare const SecurityDetailsStyle: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { SecuritySchemesModel } from '../../services
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
render(): JSX.Element;
|
|
10
|
-
}
|
|
2
|
+
import { SecuritySchemesModel } from '../../services';
|
|
3
|
+
export declare const AUTH_TYPES: {
|
|
4
|
+
oauth2: string;
|
|
5
|
+
apiKey: string;
|
|
6
|
+
http: string;
|
|
7
|
+
openIdConnect: string;
|
|
8
|
+
};
|
|
11
9
|
export interface SecurityDefsProps {
|
|
12
10
|
securitySchemes: SecuritySchemesModel;
|
|
13
11
|
}
|