redoc 2.5.2 → 3.0.0-rc.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.
Files changed (178) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +22 -14
  3. package/bundle/redoc.d.ts +683 -0
  4. package/bundle/redoc.js +2224 -0
  5. package/bundle/redoc.standalone.js +2264 -0
  6. package/package.json +115 -180
  7. package/CHANGELOG.md +0 -2354
  8. package/bundles/cfb294d7f6536ffa8d42.worker.js.LICENSE.txt +0 -68
  9. package/bundles/cfb294d7f6536ffa8d42.worker.js.map +0 -1
  10. package/bundles/redoc.browser.lib.js +0 -1832
  11. package/bundles/redoc.browser.lib.js.LICENSE.txt +0 -6
  12. package/bundles/redoc.browser.lib.js.map +0 -1
  13. package/bundles/redoc.lib.js +0 -1832
  14. package/bundles/redoc.lib.js.LICENSE.txt +0 -6
  15. package/bundles/redoc.lib.js.map +0 -1
  16. package/bundles/redoc.standalone.js +0 -1832
  17. package/bundles/redoc.standalone.js.LICENSE.txt +0 -102
  18. package/bundles/redoc.standalone.js.map +0 -1
  19. package/typings/common-elements/CopyButtonWrapper.d.ts +0 -10
  20. package/typings/common-elements/Dropdown/Dropdown.d.ts +0 -3
  21. package/typings/common-elements/Dropdown/index.d.ts +0 -2
  22. package/typings/common-elements/Dropdown/styled.d.ts +0 -7
  23. package/typings/common-elements/Dropdown/types.d.ts +0 -23
  24. package/typings/common-elements/PrismDiv.d.ts +0 -1
  25. package/typings/common-elements/Tooltip.d.ts +0 -8
  26. package/typings/common-elements/fields-layout.d.ts +0 -14
  27. package/typings/common-elements/fields.d.ts +0 -20
  28. package/typings/common-elements/headers.d.ts +0 -6
  29. package/typings/common-elements/index.d.ts +0 -11
  30. package/typings/common-elements/linkify.d.ts +0 -10
  31. package/typings/common-elements/mixins.d.ts +0 -1
  32. package/typings/common-elements/panels.d.ts +0 -11
  33. package/typings/common-elements/perfect-scrollbar.d.ts +0 -19
  34. package/typings/common-elements/samples.d.ts +0 -5
  35. package/typings/common-elements/schema.d.ts +0 -8
  36. package/typings/common-elements/shelfs.d.ts +0 -13
  37. package/typings/common-elements/tabs.d.ts +0 -3
  38. package/typings/components/ApiInfo/ApiInfo.d.ts +0 -8
  39. package/typings/components/ApiInfo/index.d.ts +0 -1
  40. package/typings/components/ApiInfo/styled.elements.d.ts +0 -8
  41. package/typings/components/ApiLogo/ApiLogo.d.ts +0 -7
  42. package/typings/components/ApiLogo/styled.elements.d.ts +0 -4
  43. package/typings/components/CallbackSamples/CallbackReqSamples.d.ts +0 -11
  44. package/typings/components/CallbackSamples/CallbackSamples.d.ts +0 -13
  45. package/typings/components/Callbacks/CallbackDetails.d.ts +0 -8
  46. package/typings/components/Callbacks/CallbackOperation.d.ts +0 -8
  47. package/typings/components/Callbacks/CallbackTitle.d.ts +0 -10
  48. package/typings/components/Callbacks/CallbacksList.d.ts +0 -8
  49. package/typings/components/Callbacks/index.d.ts +0 -3
  50. package/typings/components/Callbacks/styled.elements.d.ts +0 -2
  51. package/typings/components/ContentItems/ContentItems.d.ts +0 -22
  52. package/typings/components/DropdownOrLabel/DropdownOrLabel.d.ts +0 -10
  53. package/typings/components/Endpoint/Endpoint.d.ts +0 -16
  54. package/typings/components/Endpoint/styled.elements.d.ts +0 -17
  55. package/typings/components/ErrorBoundary.d.ts +0 -8
  56. package/typings/components/ExternalDocumentation/ExternalDocumentation.d.ts +0 -8
  57. package/typings/components/Fields/ArrayItemDetails.d.ts +0 -5
  58. package/typings/components/Fields/EnumValues.d.ts +0 -17
  59. package/typings/components/Fields/Examples.d.ts +0 -5
  60. package/typings/components/Fields/Extensions.d.ts +0 -9
  61. package/typings/components/Fields/Field.d.ts +0 -20
  62. package/typings/components/Fields/FieldConstraints.d.ts +0 -7
  63. package/typings/components/Fields/FieldDetail.d.ts +0 -7
  64. package/typings/components/Fields/FieldDetails.d.ts +0 -4
  65. package/typings/components/Fields/Pattern.d.ts +0 -5
  66. package/typings/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +0 -22
  67. package/typings/components/JsonViewer/JsonViewer.d.ts +0 -6
  68. package/typings/components/JsonViewer/index.d.ts +0 -1
  69. package/typings/components/JsonViewer/style.d.ts +0 -1
  70. package/typings/components/Loading/Loading.d.ts +0 -7
  71. package/typings/components/Loading/Spinner.svg.d.ts +0 -5
  72. package/typings/components/Markdown/AdvancedMarkdown.d.ts +0 -11
  73. package/typings/components/Markdown/Markdown.d.ts +0 -17
  74. package/typings/components/Markdown/SanitizedMdBlock.d.ts +0 -7
  75. package/typings/components/Markdown/styled.elements.d.ts +0 -7
  76. package/typings/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +0 -17
  77. package/typings/components/Operation/Operation.d.ts +0 -5
  78. package/typings/components/OptionsProvider.d.ts +0 -5
  79. package/typings/components/Parameters/Parameters.d.ts +0 -16
  80. package/typings/components/Parameters/ParametersGroup.d.ts +0 -9
  81. package/typings/components/PayloadSamples/Example.d.ts +0 -8
  82. package/typings/components/PayloadSamples/ExampleValue.d.ts +0 -6
  83. package/typings/components/PayloadSamples/MediaTypeSamples.d.ts +0 -18
  84. package/typings/components/PayloadSamples/PayloadSamples.d.ts +0 -9
  85. package/typings/components/PayloadSamples/exernalExampleHook.d.ts +0 -2
  86. package/typings/components/PayloadSamples/styled.elements.d.ts +0 -7
  87. package/typings/components/Redoc/Redoc.d.ts +0 -14
  88. package/typings/components/Redoc/styled.elements.d.ts +0 -3
  89. package/typings/components/RedocStandalone.d.ts +0 -9
  90. package/typings/components/RequestSamples/RequestSamples.d.ts +0 -11
  91. package/typings/components/ResponseSamples/ResponseSamples.d.ts +0 -9
  92. package/typings/components/Responses/Response.d.ts +0 -6
  93. package/typings/components/Responses/ResponseDetails.d.ts +0 -8
  94. package/typings/components/Responses/ResponseHeaders.d.ts +0 -8
  95. package/typings/components/Responses/ResponseTitle.d.ts +0 -11
  96. package/typings/components/Responses/ResponsesList.d.ts +0 -9
  97. package/typings/components/Responses/styled.elements.d.ts +0 -6
  98. package/typings/components/Schema/ArraySchema.d.ts +0 -5
  99. package/typings/components/Schema/DiscriminatorDropdown.d.ts +0 -11
  100. package/typings/components/Schema/ObjectSchema.d.ts +0 -11
  101. package/typings/components/Schema/OneOfSchema.d.ts +0 -15
  102. package/typings/components/Schema/RecursiveSchema.d.ts +0 -3
  103. package/typings/components/Schema/Schema.d.ts +0 -15
  104. package/typings/components/Schema/index.d.ts +0 -5
  105. package/typings/components/SchemaDefinition/SchemaDefinition.d.ts +0 -18
  106. package/typings/components/SearchBox/SearchBox.d.ts +0 -32
  107. package/typings/components/SearchBox/styled.elements.d.ts +0 -12
  108. package/typings/components/SecurityRequirement/OAuthFlow.d.ts +0 -9
  109. package/typings/components/SecurityRequirement/RequiredScopesRow.d.ts +0 -3
  110. package/typings/components/SecurityRequirement/SecurityDetails.d.ts +0 -8
  111. package/typings/components/SecurityRequirement/SecurityHeader.d.ts +0 -8
  112. package/typings/components/SecurityRequirement/SecurityRequirement.d.ts +0 -6
  113. package/typings/components/SecurityRequirement/styled.elements.d.ts +0 -17
  114. package/typings/components/SecuritySchemes/SecuritySchemes.d.ts +0 -14
  115. package/typings/components/SeeMore/SeeMore.d.ts +0 -7
  116. package/typings/components/SelectOnClick/SelectOnClick.d.ts +0 -6
  117. package/typings/components/SideMenu/Logo.d.ts +0 -1
  118. package/typings/components/SideMenu/MenuItem.d.ts +0 -22
  119. package/typings/components/SideMenu/MenuItems.d.ts +0 -13
  120. package/typings/components/SideMenu/SideMenu.d.ts +0 -15
  121. package/typings/components/SideMenu/index.d.ts +0 -4
  122. package/typings/components/SideMenu/styled.elements.d.ts +0 -30
  123. package/typings/components/SourceCode/SourceCode.d.ts +0 -7
  124. package/typings/components/StickySidebar/ChevronSvg.d.ts +0 -4
  125. package/typings/components/StickySidebar/StickyResponsiveSidebar.d.ts +0 -23
  126. package/typings/components/StoreBuilder.d.ts +0 -26
  127. package/typings/components/index.d.ts +0 -34
  128. package/typings/index.d.ts +0 -8
  129. package/typings/services/AppStore.d.ts +0 -33
  130. package/typings/services/ClipboardService.d.ts +0 -8
  131. package/typings/services/HistoryService.d.ts +0 -12
  132. package/typings/services/Labels.d.ts +0 -3
  133. package/typings/services/MarkdownRenderer.d.ts +0 -26
  134. package/typings/services/MarkerService.d.ts +0 -11
  135. package/typings/services/MenuBuilder.d.ts +0 -50
  136. package/typings/services/MenuStore.d.ts +0 -89
  137. package/typings/services/OpenAPIParser.d.ts +0 -50
  138. package/typings/services/RedocNormalizedOptions.d.ts +0 -123
  139. package/typings/services/ScrollService.d.ts +0 -17
  140. package/typings/services/SearchStore.d.ts +0 -16
  141. package/typings/services/SearchWorker.worker.d.ts +0 -20
  142. package/typings/services/SpecStore.d.ts +0 -20
  143. package/typings/services/index.d.ts +0 -14
  144. package/typings/services/models/ApiInfo.d.ts +0 -23
  145. package/typings/services/models/Callback.d.ts +0 -11
  146. package/typings/services/models/Example.d.ts +0 -13
  147. package/typings/services/models/Field.d.ts +0 -32
  148. package/typings/services/models/Group.model.d.ts +0 -25
  149. package/typings/services/models/MediaContent.d.ts +0 -24
  150. package/typings/services/models/MediaType.d.ts +0 -20
  151. package/typings/services/models/Operation.d.ts +0 -72
  152. package/typings/services/models/RequestBody.d.ts +0 -17
  153. package/typings/services/models/Response.d.ts +0 -26
  154. package/typings/services/models/Schema.d.ts +0 -62
  155. package/typings/services/models/SecurityRequirement.d.ts +0 -12
  156. package/typings/services/models/SecuritySchemes.d.ts +0 -26
  157. package/typings/services/models/Webhook.d.ts +0 -9
  158. package/typings/services/models/index.d.ts +0 -13
  159. package/typings/services/types.d.ts +0 -106
  160. package/typings/styled-components.d.ts +0 -12
  161. package/typings/styled-patch.d.ts +0 -22
  162. package/typings/theme.d.ts +0 -163
  163. package/typings/types/index.d.ts +0 -2
  164. package/typings/types/index.ts +0 -3
  165. package/typings/types/open-api.d.ts +0 -314
  166. package/typings/types/open-api.ts +0 -304
  167. package/typings/utils/JsonPointer.d.ts +0 -51
  168. package/typings/utils/debug.d.ts +0 -2
  169. package/typings/utils/decorators.d.ts +0 -1
  170. package/typings/utils/dom.d.ts +0 -9
  171. package/typings/utils/helpers.d.ts +0 -43
  172. package/typings/utils/highlight.d.ts +0 -34
  173. package/typings/utils/index.d.ts +0 -10
  174. package/typings/utils/jsonToHtml.d.ts +0 -1
  175. package/typings/utils/loadAndBundleSpec.d.ts +0 -3
  176. package/typings/utils/memoize.d.ts +0 -1
  177. package/typings/utils/openapi.d.ts +0 -43
  178. package/typings/utils/sort.d.ts +0 -6
@@ -1,26 +0,0 @@
1
- import * as React from 'react';
2
- import { AppStore } from '../services/';
3
- import { RedocRawOptions } from '../services/RedocNormalizedOptions';
4
- export interface StoreBuilderProps {
5
- specUrl?: string;
6
- spec?: object;
7
- store?: AppStore;
8
- options?: RedocRawOptions;
9
- onLoaded?: (e?: Error) => void;
10
- children: (props: {
11
- loading: boolean;
12
- store: AppStore | null;
13
- }) => any;
14
- }
15
- export interface StoreBuilderState {
16
- error?: Error;
17
- loading: boolean;
18
- resolvedSpec?: any;
19
- prevSpec?: any;
20
- prevSpecUrl?: string;
21
- }
22
- declare const StoreContext: React.Context<AppStore | undefined>;
23
- declare const Provider: React.Provider<AppStore | undefined>, Consumer: React.Consumer<AppStore | undefined>;
24
- export { Provider as StoreProvider, Consumer as StoreConsumer, StoreContext };
25
- export declare function StoreBuilder(props: StoreBuilderProps): any;
26
- export declare function useStore(): AppStore | undefined;
@@ -1,34 +0,0 @@
1
- export * from './RedocStandalone';
2
- export * from './Redoc/Redoc';
3
- export * from './ApiInfo/ApiInfo';
4
- export * from './ApiLogo/ApiLogo';
5
- export * from './ContentItems/ContentItems';
6
- export { ApiContentWrap, BackgroundStub, RedocWrap } from './Redoc/styled.elements';
7
- export * from './Schema/';
8
- export * from './SearchBox/SearchBox';
9
- export * from './Operation/Operation';
10
- export * from './Loading/Loading';
11
- export * from './JsonViewer';
12
- export * from './Markdown/Markdown';
13
- export { StyledMarkdownBlock } from './Markdown/styled.elements';
14
- export * from './SecuritySchemes/SecuritySchemes';
15
- export * from './Responses/Response';
16
- export * from './Responses/ResponseDetails';
17
- export * from './Responses/ResponseHeaders';
18
- export * from './Responses/ResponsesList';
19
- export * from './Responses/ResponseTitle';
20
- export * from './ResponseSamples/ResponseSamples';
21
- export * from './PayloadSamples/PayloadSamples';
22
- export * from './PayloadSamples/styled.elements';
23
- export * from './MediaTypeSwitch/MediaTypesSwitch';
24
- export * from './Parameters/Parameters';
25
- export * from './PayloadSamples/Example';
26
- export * from './DropdownOrLabel/DropdownOrLabel';
27
- export * from './ErrorBoundary';
28
- export * from './StoreBuilder';
29
- export * from './OptionsProvider';
30
- export * from './SideMenu/';
31
- export * from './StickySidebar/StickyResponsiveSidebar';
32
- export * from './SearchBox/SearchBox';
33
- export * from './SchemaDefinition/SchemaDefinition';
34
- export * from './SourceCode/SourceCode';
@@ -1,8 +0,0 @@
1
- export * from './components';
2
- export { MiddlePanel, Row, RightPanel, Section, Dropdown, SimpleDropdown, } from './common-elements/';
3
- export type { DropdownOption } from './common-elements';
4
- export type { OpenAPIEncoding } from './types';
5
- export * from './services';
6
- export * from './utils';
7
- export * from './styled-components';
8
- export { default as styled } from './styled-components';
@@ -1,33 +0,0 @@
1
- import type { OpenAPISpec } from '../types';
2
- import { MarkerService } from './MarkerService';
3
- import { MenuStore } from './MenuStore';
4
- import { SpecStore } from './models';
5
- import { RedocNormalizedOptions } from './RedocNormalizedOptions';
6
- import type { RedocRawOptions } from './RedocNormalizedOptions';
7
- import { SearchStore } from './SearchStore';
8
- import type { StoreState } from './types';
9
- export declare function createStore(spec: object, specUrl: string | undefined, options?: RedocRawOptions): Promise<AppStore>;
10
- export declare class AppStore {
11
- /**
12
- * deserialize store
13
- * **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
14
- */
15
- static fromJS(state: StoreState): AppStore;
16
- menu: MenuStore;
17
- spec: SpecStore;
18
- rawOptions: RedocRawOptions;
19
- options: RedocNormalizedOptions;
20
- search?: SearchStore<string>;
21
- marker: MarkerService;
22
- private scroll;
23
- private disposer;
24
- constructor(spec: OpenAPISpec, specUrl?: string, options?: RedocRawOptions, createSearchIndex?: boolean);
25
- onDidMount(): void;
26
- dispose(): void;
27
- /**
28
- * serializes store
29
- * **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
30
- */
31
- toJS(): Promise<StoreState>;
32
- private updateMarkOnMenu;
33
- }
@@ -1,8 +0,0 @@
1
- export declare class ClipboardService {
2
- static isSupported(): boolean;
3
- static selectElement(element: any): void;
4
- static deselect(): void;
5
- static copySelected(): boolean;
6
- static copyElement(element: any): boolean;
7
- static copyCustom(text: string): boolean;
8
- }
@@ -1,12 +0,0 @@
1
- export declare class HistoryService {
2
- private _emiter;
3
- constructor();
4
- get currentId(): string;
5
- linkForId(id: string): string;
6
- subscribe(cb: any): () => void;
7
- emit: () => void;
8
- bind(): void;
9
- dispose(): void;
10
- replace(id: string | null, rewriteHistory?: boolean): void;
11
- }
12
- export declare const history: HistoryService;
@@ -1,3 +0,0 @@
1
- import type { LabelsConfig, LabelsConfigRaw } from './types';
2
- export declare function setRedocLabels(_labels?: LabelsConfigRaw): void;
3
- export declare function l(key: keyof LabelsConfig, idx?: number): string;
@@ -1,26 +0,0 @@
1
- import { marked } from 'marked';
2
- import { RedocNormalizedOptions } from './RedocNormalizedOptions';
3
- import type { MarkdownHeading, MDXComponentMeta } from './types';
4
- export declare const LEGACY_REGEXP = "^ {0,3}<!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?-->\\s*$";
5
- export declare const MDX_COMPONENT_REGEXP: string;
6
- export declare const COMPONENT_REGEXP: string;
7
- export declare function buildComponentComment(name: string): string;
8
- export declare class MarkdownRenderer {
9
- options?: RedocNormalizedOptions | undefined;
10
- parentId?: string | undefined;
11
- static containsComponent(rawText: string, componentName: string): boolean;
12
- static getTextBeforeHading(md: string, heading: string): string;
13
- headings: MarkdownHeading[];
14
- currentTopHeading: MarkdownHeading;
15
- parser: marked.Parser;
16
- private headingEnhanceRenderer;
17
- private originalHeadingRule;
18
- constructor(options?: RedocNormalizedOptions | undefined, parentId?: string | undefined);
19
- saveHeading(name: string, level: number, container?: MarkdownHeading[], parentId?: string): MarkdownHeading;
20
- flattenHeadings(container?: MarkdownHeading[]): MarkdownHeading[];
21
- attachHeadingsDescriptions(rawText: string): void;
22
- headingRule: (text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: marked.Slugger) => string;
23
- renderMd(rawText: string, extractHeadings?: boolean): string;
24
- extractHeadings(rawText: string): MarkdownHeading[];
25
- renderMdWithComponents(rawText: string): Array<string | MDXComponentMeta>;
26
- }
@@ -1,11 +0,0 @@
1
- import * as Mark from 'mark.js';
2
- export declare class MarkerService {
3
- map: Map<Element, Mark>;
4
- private prevTerm;
5
- add(el: HTMLElement): void;
6
- delete(el: Element): void;
7
- addOnly(elements: Element[]): void;
8
- clearAll(): void;
9
- mark(term?: string): void;
10
- unmark(): void;
11
- }
@@ -1,50 +0,0 @@
1
- import type { OpenAPITag } from '../types';
2
- import { GroupModel, OperationModel } from './models';
3
- import type { OpenAPIParser } from './OpenAPIParser';
4
- import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
5
- import type { ContentItemModel, TagGroup, TagInfo, TagsInfoMap } from './types';
6
- export declare const GROUP_DEPTH = 0;
7
- export declare class MenuBuilder {
8
- /**
9
- * Builds page content structure based on tags
10
- */
11
- static buildStructure(parser: OpenAPIParser, options: RedocNormalizedOptions): ContentItemModel[];
12
- /**
13
- * extracts items from markdown description
14
- * @param description - markdown source
15
- */
16
- static addMarkdownItems(description: string, parent: GroupModel | undefined, initialDepth: number, options: RedocNormalizedOptions): ContentItemModel[];
17
- /**
18
- * Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
19
- * @param tags value of `x-tagGroups` vendor extension
20
- */
21
- static getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: RedocNormalizedOptions): GroupModel[];
22
- /**
23
- * Returns array of OperationsGroup items for the tags of the group or for all tags
24
- * @param parser
25
- * @param tagsMap tags info returned from `getTagsWithOperations`
26
- * @param parent parent item
27
- * @param group group which this tag belongs to. if not provided gets all tags
28
- * @param options normalized options
29
- */
30
- static getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: RedocNormalizedOptions): ContentItemModel[];
31
- /**
32
- * Returns array of Operation items for the tag
33
- * @param parser
34
- * @param parent parent OperationsGroup
35
- * @param tag tag info returned from `getTagsWithOperations`
36
- * @param depth items depth
37
- * @param options - normalized options
38
- */
39
- static getOperationsItems(parser: OpenAPIParser, parent: GroupModel | undefined, tag: TagInfo, depth: number, options: RedocNormalizedOptions): OperationModel[];
40
- /**
41
- * collects tags and maps each tag to list of operations belonging to this tag
42
- */
43
- static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
44
- static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
45
- parser: OpenAPIParser;
46
- tag: TagInfo;
47
- parent: GroupModel;
48
- schemaDefinitionsTagName?: string;
49
- }): GroupModel[];
50
- }
@@ -1,89 +0,0 @@
1
- import { HistoryService } from './HistoryService';
2
- import type { SpecStore } from './models';
3
- import type { ScrollService } from './ScrollService';
4
- import type { IMenuItem } from './types';
5
- /** Generic interface for MenuItems */
6
- export declare const SECTION_ATTR = "data-section-id";
7
- /**
8
- * Stores all side-menu related information
9
- */
10
- export declare class MenuStore {
11
- scroll: ScrollService;
12
- history: HistoryService;
13
- /**
14
- * Statically try update scroll position
15
- * Used before hydrating from server-side rendered html to scroll page faster
16
- */
17
- static updateOnHistory(id: string | undefined, scroll: ScrollService): void;
18
- /**
19
- * active item absolute index (when flattened). -1 means nothing is selected
20
- */
21
- activeItemIdx: number;
22
- /**
23
- * whether sidebar with menu is opened or not
24
- */
25
- sideBarOpened: boolean;
26
- items: IMenuItem[];
27
- flatItems: IMenuItem[];
28
- /**
29
- * cached flattened menu items to support absolute indexing
30
- */
31
- private _unsubscribe;
32
- private _hashUnsubscribe;
33
- /**
34
- *
35
- * @param spec [SpecStore](#SpecStore) which contains page content structure
36
- * @param scroll scroll service instance used by this menu
37
- */
38
- constructor(spec: SpecStore, scroll: ScrollService, history: HistoryService);
39
- subscribe(): void;
40
- toggleSidebar(): void;
41
- closeSidebar(): void;
42
- /**
43
- * update active items on scroll
44
- * @param isScrolledDown whether last scroll was downside
45
- */
46
- updateOnScroll: (isScrolledDown: boolean) => void;
47
- /**
48
- * update active items on hash change
49
- * @param id current hash
50
- */
51
- updateOnHistory: (id?: string) => void;
52
- /**
53
- * get section/operation DOM Node related to the item or null if it doesn't exist
54
- * @param idx item absolute index
55
- */
56
- getElementAt(idx: number): Element | null;
57
- /**
58
- * get section/operation DOM Node related to the item or if it is group item, returns first item of the group
59
- * @param idx item absolute index
60
- */
61
- getElementAtOrFirstChild(idx: number): Element | null;
62
- /**
63
- * current active item
64
- */
65
- get activeItem(): IMenuItem;
66
- getItemById: (id: string) => IMenuItem | undefined;
67
- /**
68
- * activate menu item
69
- * @param item item to activate
70
- * @param updateLocation [true] whether to update location
71
- * @param rewriteHistory [false] whether to rewrite browser history (do not create new entry)
72
- */
73
- activate(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean): void;
74
- /**
75
- * makes item and all the parents not active
76
- * @param item item to deactivate
77
- */
78
- deactivate(item: IMenuItem | undefined): void;
79
- /**
80
- * activate menu item and scroll to it
81
- * @see MenuStore.activate
82
- */
83
- activateAndScroll(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean): void;
84
- /**
85
- * scrolls to active section
86
- */
87
- scrollToActive(): void;
88
- dispose(): void;
89
- }
@@ -1,50 +0,0 @@
1
- import type { OpenAPIRef, OpenAPISpec } from '../types';
2
- import { RedocNormalizedOptions } from './RedocNormalizedOptions';
3
- import type { MergedOpenAPISchema } from './types';
4
- /**
5
- * Loads and keeps spec. Provides raw spec operations
6
- */
7
- export declare function pushRef(stack: string[], ref?: string): string[];
8
- export declare function concatRefStacks(base: string[], stack?: string[]): string[];
9
- export declare class OpenAPIParser {
10
- private options;
11
- specUrl?: string;
12
- spec: OpenAPISpec;
13
- private readonly allowMergeRefs;
14
- constructor(spec: OpenAPISpec, specUrl?: string, options?: RedocNormalizedOptions);
15
- validate(spec: Record<string, any>): void;
16
- /**
17
- * get spec part by JsonPointer ($ref)
18
- */
19
- byRef: <T = any>(ref: string) => T | undefined;
20
- /**
21
- * checks if the object is OpenAPI reference (contains $ref property)
22
- */
23
- isRef<T>(obj: OpenAPIRef | T): obj is OpenAPIRef;
24
- /**
25
- * Resolve given reference object or return as is if it is not a reference
26
- * @param obj object to dereference
27
- * @param forceCircular whether to dereference even if it is circular ref
28
- * @param mergeAsAllOf
29
- */
30
- deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean): {
31
- resolved: T;
32
- refsStack: string[];
33
- };
34
- mergeRefs<T>(ref: OpenAPIRef, resolved: T, mergeAsAllOf: boolean): T;
35
- /**
36
- * Merge allOf constraints.
37
- * @param schema schema with allOF
38
- * @param $ref pointer of the schema
39
- * @param forceCircular whether to dereference children even if it is a circular ref
40
- * @param used$Refs
41
- */
42
- mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[]): MergedOpenAPISchema;
43
- /**
44
- * Find all derived definitions among #/components/schemas from any of $refs
45
- * returns map of definition pointer to definition name
46
- * @param $refs array of references to find derived from
47
- */
48
- findDerived($refs: string[]): Record<string, string[] | string>;
49
- private hoistOneOfs;
50
- }
@@ -1,123 +0,0 @@
1
- import { ResolvedThemeInterface, ThemeInterface } from '../theme';
2
- import { SideNavStyleEnum } from './types';
3
- import type { LabelsConfigRaw, MDXComponentMeta } from './types';
4
- export type DownloadUrlsConfig = {
5
- title?: string;
6
- url: string;
7
- }[];
8
- export interface RedocRawOptions {
9
- theme?: ThemeInterface;
10
- scrollYOffset?: number | string | (() => number);
11
- hideHostname?: boolean | string;
12
- expandResponses?: string | 'all';
13
- requiredPropsFirst?: boolean | string;
14
- sortRequiredPropsFirst?: boolean | string;
15
- sortPropsAlphabetically?: boolean | string;
16
- sortEnumValuesAlphabetically?: boolean | string;
17
- sortOperationsAlphabetically?: boolean | string;
18
- sortTagsAlphabetically?: boolean | string;
19
- nativeScrollbars?: boolean | string;
20
- pathInMiddlePanel?: boolean | string;
21
- untrustedSpec?: boolean | string;
22
- sanitize?: boolean | string;
23
- hideLoading?: boolean | string;
24
- hideDownloadButton?: boolean | string;
25
- hideDownloadButtons?: boolean | string;
26
- downloadFileName?: string;
27
- downloadDefinitionUrl?: string;
28
- downloadUrls?: DownloadUrlsConfig;
29
- disableSearch?: boolean | string;
30
- onlyRequiredInSamples?: boolean | string;
31
- showExtensions?: boolean | string | string[];
32
- sideNavStyle?: SideNavStyleEnum;
33
- hideSingleRequestSampleTab?: boolean | string;
34
- hideRequestPayloadSample?: boolean;
35
- menuToggle?: boolean | string;
36
- jsonSampleExpandLevel?: number | string | 'all';
37
- jsonSamplesExpandLevel?: number | string | 'all';
38
- hideSchemaTitles?: boolean | string;
39
- simpleOneOfTypeLabel?: boolean | string;
40
- payloadSampleIdx?: number;
41
- expandSingleSchemaField?: boolean | string;
42
- schemaExpansionLevel?: number | string | 'all';
43
- schemasExpansionLevel?: number | string | 'all';
44
- schemaDefinitionsTagName?: string;
45
- showObjectSchemaExamples?: boolean | string;
46
- showSecuritySchemeType?: boolean;
47
- hideSecuritySection?: boolean;
48
- unstable_ignoreMimeParameters?: boolean;
49
- allowedMdComponents?: Record<string, MDXComponentMeta>;
50
- labels?: LabelsConfigRaw;
51
- enumSkipQuotes?: boolean | string;
52
- expandDefaultServerVariables?: boolean;
53
- maxDisplayedEnumValues?: number;
54
- ignoreNamedSchemas?: string[] | string;
55
- hideSchemaPattern?: boolean;
56
- generatedPayloadSamplesMaxDepth?: number;
57
- generatedSamplesMaxDepth?: number;
58
- nonce?: string;
59
- hideFab?: boolean;
60
- minCharacterLengthToInitSearch?: number;
61
- showWebhookVerb?: boolean;
62
- hidePropertiesPrefix?: boolean;
63
- }
64
- export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
65
- export declare class RedocNormalizedOptions {
66
- static normalizeExpandResponses(value: RedocRawOptions['expandResponses']): {};
67
- static normalizeHideHostname(value: RedocRawOptions['hideHostname']): boolean;
68
- static normalizeScrollYOffset(value: RedocRawOptions['scrollYOffset']): () => number;
69
- static normalizeShowExtensions(value: RedocRawOptions['showExtensions']): string[] | boolean;
70
- static normalizeSideNavStyle(value: RedocRawOptions['sideNavStyle']): SideNavStyleEnum;
71
- static normalizePayloadSampleIdx(value: RedocRawOptions['payloadSampleIdx']): number;
72
- private static normalizeJsonSampleExpandLevel;
73
- private static normalizeGeneratedPayloadSamplesMaxDepth;
74
- theme: ResolvedThemeInterface;
75
- scrollYOffset: () => number;
76
- hideHostname: boolean;
77
- expandResponses: {
78
- [code: string]: boolean;
79
- } | 'all';
80
- sortRequiredPropsFirst: boolean;
81
- sortPropsAlphabetically: boolean;
82
- sortEnumValuesAlphabetically: boolean;
83
- sortOperationsAlphabetically: boolean;
84
- sortTagsAlphabetically: boolean;
85
- nativeScrollbars: boolean;
86
- pathInMiddlePanel: boolean;
87
- sanitize: boolean;
88
- hideDownloadButtons: boolean;
89
- downloadFileName?: string;
90
- downloadDefinitionUrl?: string;
91
- downloadUrls?: DownloadUrlsConfig;
92
- disableSearch: boolean;
93
- onlyRequiredInSamples: boolean;
94
- showExtensions: boolean | string[];
95
- sideNavStyle: SideNavStyleEnum;
96
- hideSingleRequestSampleTab: boolean;
97
- hideRequestPayloadSample: boolean;
98
- menuToggle: boolean;
99
- jsonSamplesExpandLevel: number;
100
- enumSkipQuotes: boolean;
101
- hideSchemaTitles: boolean;
102
- simpleOneOfTypeLabel: boolean;
103
- payloadSampleIdx: number;
104
- expandSingleSchemaField: boolean;
105
- schemasExpansionLevel: number;
106
- schemaDefinitionsTagName?: string;
107
- showObjectSchemaExamples: boolean;
108
- showSecuritySchemeType?: boolean;
109
- hideSecuritySection?: boolean;
110
- unstable_ignoreMimeParameters: boolean;
111
- allowedMdComponents: Record<string, MDXComponentMeta>;
112
- expandDefaultServerVariables: boolean;
113
- maxDisplayedEnumValues?: number;
114
- ignoreNamedSchemas: Set<string>;
115
- hideSchemaPattern: boolean;
116
- generatedSamplesMaxDepth: number;
117
- hideFab: boolean;
118
- minCharacterLengthToInitSearch: number;
119
- showWebhookVerb: boolean;
120
- hidePropertiesPrefix?: boolean;
121
- nonce?: string;
122
- constructor(raw: RedocRawOptions, defaults?: RedocRawOptions);
123
- }
@@ -1,17 +0,0 @@
1
- import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
2
- export declare class ScrollService {
3
- private options;
4
- private _scrollParent;
5
- private _emiter;
6
- private _prevOffsetY;
7
- constructor(options: RedocNormalizedOptions);
8
- bind(): void;
9
- dispose(): void;
10
- scrollY(): number;
11
- isElementBellow(el: Element | null): boolean | undefined;
12
- isElementAbove(el: Element | null): boolean | undefined;
13
- subscribe(cb: any): () => void;
14
- scrollIntoView(element: Element | null): void;
15
- scrollIntoViewBySelector(selector: string): void;
16
- handleScroll(): void;
17
- }
@@ -1,16 +0,0 @@
1
- import type { IMenuItem } from './types';
2
- import type { OperationModel } from './models';
3
- import Worker from './SearchWorker.worker';
4
- export declare class SearchStore<T> {
5
- searchWorker: Worker;
6
- indexItems(groups: Array<IMenuItem | OperationModel>): void;
7
- add(title: string, body: string, meta?: T): void;
8
- dispose(): void;
9
- search(q: string): Promise<import("./types").SearchResult<T>[]>;
10
- toJS(): Promise<{
11
- store: any[];
12
- index: object;
13
- }>;
14
- load(state: any): void;
15
- fromExternalJS(path?: string, exportName?: string): void;
16
- }
@@ -1,20 +0,0 @@
1
- import type { SearchResult } from './types';
2
- export default class Worker {
3
- add: typeof add;
4
- done: typeof done;
5
- search: typeof search;
6
- toJS: typeof toJS;
7
- load: typeof load;
8
- dispose: typeof dispose;
9
- fromExternalJS: typeof fromExternalJS;
10
- }
11
- export declare function add<T>(title: string, description: string, meta?: T): void;
12
- export declare function done(): Promise<void>;
13
- export declare function toJS(): Promise<{
14
- store: any[];
15
- index: object;
16
- }>;
17
- export declare function fromExternalJS(path: string, exportName: string): Promise<void>;
18
- export declare function load(state: any): Promise<void>;
19
- export declare function dispose(): Promise<void>;
20
- export declare function search<Meta = string>(q: string, limit?: number): Promise<Array<SearchResult<Meta>>>;
@@ -1,20 +0,0 @@
1
- import type { OpenAPIExternalDocumentation, OpenAPISpec } from '../types';
2
- import { ApiInfoModel } from './models/ApiInfo';
3
- import { WebhookModel } from './models/Webhook';
4
- import { SecuritySchemesModel } from './models/SecuritySchemes';
5
- import { OpenAPIParser } from './OpenAPIParser';
6
- import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
7
- import type { ContentItemModel } from './types';
8
- /**
9
- * Store that contains all the specification related information in the form of tree
10
- */
11
- export declare class SpecStore {
12
- private options;
13
- parser: OpenAPIParser;
14
- info: ApiInfoModel;
15
- externalDocs?: OpenAPIExternalDocumentation;
16
- contentItems: ContentItemModel[];
17
- securitySchemes: SecuritySchemesModel;
18
- webhooks?: WebhookModel;
19
- constructor(spec: OpenAPISpec, specUrl: string | undefined, options: RedocNormalizedOptions);
20
- }
@@ -1,14 +0,0 @@
1
- export * from './AppStore';
2
- export * from './OpenAPIParser';
3
- export * from './MarkdownRenderer';
4
- export * from './MenuStore';
5
- export * from './ScrollService';
6
- export * from './SpecStore';
7
- export * from './ClipboardService';
8
- export * from './HistoryService';
9
- export * from './models';
10
- export * from './RedocNormalizedOptions';
11
- export * from './MenuBuilder';
12
- export * from './SearchStore';
13
- export * from './MarkerService';
14
- export * from './types';
@@ -1,23 +0,0 @@
1
- import type { OpenAPIContact, OpenAPIInfo, OpenAPILicense } from '../../types';
2
- import type { OpenAPIParser } from '../OpenAPIParser';
3
- import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
4
- export declare class ApiInfoModel implements OpenAPIInfo {
5
- private parser;
6
- private options;
7
- title: string;
8
- version: string;
9
- description: string;
10
- summary: string;
11
- termsOfService?: string;
12
- contact?: OpenAPIContact;
13
- license?: OpenAPILicense;
14
- downloadUrls: {
15
- title?: string;
16
- url?: string;
17
- }[];
18
- downloadFileName?: string;
19
- constructor(parser: OpenAPIParser, options?: RedocNormalizedOptions);
20
- private getDownloadUrls;
21
- private getDownloadLink;
22
- private getDownloadFileName;
23
- }
@@ -1,11 +0,0 @@
1
- import { OperationModel } from './Operation';
2
- import type { OpenAPIParser } from '../OpenAPIParser';
3
- import type { OpenAPICallback, Referenced } from '../../types';
4
- import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
5
- export declare class CallbackModel {
6
- expanded: boolean;
7
- name: string;
8
- operations: OperationModel[];
9
- constructor(parser: OpenAPIParser, name: string, infoOrRef: Referenced<OpenAPICallback>, pointer: string, options: RedocNormalizedOptions);
10
- toggle(): void;
11
- }
@@ -1,13 +0,0 @@
1
- import type { OpenAPIEncoding, OpenAPIExample, Referenced } from '../../types';
2
- import type { OpenAPIParser } from '../OpenAPIParser';
3
- export declare class ExampleModel {
4
- mime: string;
5
- value: any;
6
- summary?: string;
7
- description?: string;
8
- externalValueUrl?: string;
9
- constructor(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIExample>, mime: string, encoding?: {
10
- [field: string]: OpenAPIEncoding;
11
- });
12
- getExternalValue(mimeType: string): Promise<any>;
13
- }
@@ -1,32 +0,0 @@
1
- import type { OpenAPIParameter, OpenAPIParameterLocation, OpenAPIParameterStyle, Referenced } from '../../types';
2
- import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
3
- import type { OpenAPIParser } from '../OpenAPIParser';
4
- import { SchemaModel } from './Schema';
5
- import { ExampleModel } from './Example';
6
- /**
7
- * Field or Parameter model ready to be used by components
8
- */
9
- export declare class FieldModel {
10
- expanded: boolean | undefined;
11
- schema: SchemaModel;
12
- name: string;
13
- required: boolean;
14
- description: string;
15
- example?: string;
16
- examples?: Record<string, ExampleModel> | any[];
17
- deprecated: boolean;
18
- in?: OpenAPIParameterLocation;
19
- kind: string;
20
- extensions?: Record<string, any>;
21
- explode: boolean;
22
- style?: OpenAPIParameterStyle;
23
- const?: any;
24
- serializationMime?: string;
25
- constructor(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIParameter> & {
26
- name?: string;
27
- kind?: string;
28
- }, pointer: string, options: RedocNormalizedOptions, refsStack?: string[]);
29
- toggle(): void;
30
- collapse(): void;
31
- expand(): void;
32
- }