@redocly/openapi-docs 3.0.0-alpha.12 → 3.0.0-alpha.14
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/dist/console.redocly-openapi-docs.min.js +507 -0
- package/dist/oauth2-redirect.js +3 -3
- package/dist/redocly-openapi-docs.min.js +6792 -0
- package/lib/components/ApiInfo/ApiInfo.d.ts +1 -4
- package/lib/components/ApiInfo/ApiInfo.js +1 -1
- package/lib/components/ApiInfo/index.d.ts +0 -1
- package/lib/components/ApiInfo/styled.d.ts +3 -1
- package/lib/components/ApiInfo/styled.js +1 -1
- package/lib/components/ApiInfo/types.d.ts +9 -4
- package/lib/components/CallbackSamples/CallbackSamples.d.ts +2 -3
- package/lib/components/CallbackSamples/CallbackSamples.js +1 -1
- package/lib/components/Callbacks/CallbackDetails.d.ts +1 -1
- package/lib/components/Callbacks/CallbackDetails.js +1 -1
- package/lib/components/Callbacks/CallbackOperation.js +1 -1
- package/lib/components/Callbacks/CallbacksList.js +1 -1
- package/lib/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib/components/ChangeViewButton/ChangeViewButton.js +2 -0
- package/lib/components/ChangeViewButton/index.d.ts +1 -0
- package/lib/components/ChangeViewButton/index.js +2 -0
- package/lib/components/ChangeViewButton/styled.d.ts +3 -0
- package/lib/components/ChangeViewButton/styled.js +18 -0
- package/lib/components/ContentItem/ContentItem.d.ts +6 -6
- package/lib/components/ContentItem/ContentItem.js +1 -1
- package/lib/components/ContentItems/ContentItems.d.ts +10 -4
- package/lib/components/ContentItems/ContentItems.js +1 -1
- package/lib/components/ContentItems/helpers.d.ts +11 -0
- package/lib/components/ContentItems/helpers.js +2 -0
- package/lib/components/ContentItems/useAutoScroll.d.ts +1 -0
- package/lib/components/ContentItems/useAutoScroll.js +2 -0
- package/lib/components/DiscriminatorDropdown/DiscriminatorDropdown.d.ts +2 -2
- package/lib/components/DiscriminatorDropdown/DiscriminatorDropdown.js +1 -1
- package/lib/components/Download/DownloadButtonWithLabel.d.ts +3 -4
- package/lib/components/Download/DownloadButtonWithLabel.js +1 -1
- package/lib/components/Download/types.d.ts +12 -0
- package/lib/components/Download/useDownloadInfo.d.ts +2 -0
- package/lib/components/Download/useDownloadInfo.js +2 -0
- package/lib/components/Endpoint/Endpoint.js +1 -1
- package/lib/components/Endpoint/ServerList.js +1 -1
- package/lib/components/ExternalDocumentation/ExternalDocumentation.d.ts +2 -2
- package/lib/components/ExternalDocumentation/ExternalDocumentation.js +2 -2
- package/lib/components/Fields/DescriptionEnums.js +1 -1
- package/lib/components/Fields/EnumValues.js +1 -1
- package/lib/components/Fields/Examples.js +1 -1
- package/lib/components/Fields/Extensions.js +2 -2
- package/lib/components/Fields/Field.d.ts +3 -2
- package/lib/components/Fields/Field.js +1 -1
- package/lib/components/Fields/FieldDetails.d.ts +2 -3
- package/lib/components/Fields/FieldDetails.js +1 -1
- package/lib/components/Fields/SimpleEnums.js +1 -1
- package/lib/components/Fields/types.d.ts +0 -1
- package/lib/components/GenericChildrenSwitcher/GenericChildrenSwitcher.js +1 -1
- package/lib/components/Markdown/Markdown.d.ts +1 -1
- package/lib/components/Markdown/Markdown.js +1 -1
- package/lib/components/Markdown/index.d.ts +0 -2
- package/lib/components/Markdown/index.js +1 -1
- package/lib/components/Markdown/styled.js +1 -3
- package/lib/components/Markdown/types.d.ts +5 -13
- package/lib/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +2 -2
- package/lib/components/MediaTypeSwitch/MediaTypesSwitch.js +1 -1
- package/lib/components/NextSectionButton/NextSectionButton.d.ts +8 -0
- package/lib/components/NextSectionButton/NextSectionButton.js +2 -0
- package/lib/components/NextSectionButton/index.d.ts +1 -0
- package/lib/components/NextSectionButton/index.js +2 -0
- package/lib/components/NextSectionButton/styled.d.ts +1 -0
- package/lib/components/NextSectionButton/styled.js +18 -0
- package/lib/components/OperationItem/OperationItem.d.ts +3 -0
- package/lib/components/OperationItem/OperationItem.js +9 -0
- package/lib/components/OperationItem/index.d.ts +2 -0
- package/lib/components/OperationItem/index.js +2 -0
- package/lib/components/OperationItem/types.d.ts +4 -0
- package/lib/components/{Operation → OperationItem}/types.js +0 -0
- package/lib/components/Overlay.d.ts +2 -7
- package/lib/components/Overlay.js +1 -1
- package/lib/components/Panel/ResponsePanel.js +2 -2
- package/lib/components/Parameters/BodyContent.d.ts +3 -2
- package/lib/components/Parameters/BodyContent.js +1 -1
- package/lib/components/Parameters/ParametersGroup.js +1 -1
- package/lib/components/PayloadSamples/MediaTypeSamples.d.ts +2 -3
- package/lib/components/PayloadSamples/MediaTypeSamples.js +1 -1
- package/lib/components/PayloadSamples/PayloadSamples.d.ts +2 -3
- package/lib/components/PayloadSamples/PayloadSamples.js +1 -1
- package/lib/components/PayloadSamples/types.d.ts +1 -2
- package/lib/components/PayloadSamples/useExternalExample.js +1 -1
- package/lib/components/RedoclyOpenAPIDocs/Providers.d.ts +6 -0
- package/lib/components/RedoclyOpenAPIDocs/Providers.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.d.ts +4 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/index.d.ts +5 -0
- package/lib/components/RedoclyOpenAPIDocs/index.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/styled.d.ts +13 -0
- package/lib/components/RedoclyOpenAPIDocs/styled.js +170 -0
- package/lib/components/RedoclyOpenAPIDocs/types.d.ts +63 -0
- package/lib/components/{types.js → RedoclyOpenAPIDocs/types.js} +0 -0
- package/lib/components/RedoclyOpenAPIDocs/utils.d.ts +10 -0
- package/lib/components/RedoclyOpenAPIDocs/utils.js +2 -0
- package/lib/components/RequestSamples/CodeSample.d.ts +1 -1
- package/lib/components/RequestSamples/CodeSample.js +1 -1
- package/lib/components/RequestSamples/Example.d.ts +2 -2
- package/lib/components/RequestSamples/Example.js +1 -1
- package/lib/components/RequestSamples/RequestSamples.d.ts +1 -1
- package/lib/components/RequestSamples/RequestSamples.js +1 -1
- package/lib/components/ResponseSamples/ResponseSamples.d.ts +4 -1
- package/lib/components/ResponseSamples/ResponseSamples.js +1 -1
- package/lib/components/Responses/Response.d.ts +1 -3
- package/lib/components/Responses/Response.js +1 -1
- package/lib/components/Responses/ResponseSummary.js +14 -1
- package/lib/components/Responses/styled.js +2 -2
- package/lib/components/Samples/SamplesTabs.d.ts +3 -2
- package/lib/components/Samples/SamplesTabs.js +1 -1
- package/lib/components/Samples/use-example-key.d.ts +1 -1
- package/lib/components/Samples/use-example-key.js +1 -1
- package/lib/components/Schema/ObjectSchema.d.ts +1 -1
- package/lib/components/Schema/ObjectSchema.js +1 -1
- package/lib/components/Schema/OneOfSchema.d.ts +1 -1
- package/lib/components/Schema/OneOfSchema.js +1 -1
- package/lib/components/Schema/RecursiveSchema.d.ts +1 -1
- package/lib/components/Schema/RecursiveSchema.js +1 -1
- package/lib/components/Schema/Schema.d.ts +1 -1
- package/lib/components/Schema/Schema.js +1 -1
- package/lib/components/SchemaDefinition/SchemaDefinition.d.ts +1 -7
- package/lib/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib/components/Search/MenuItemSearch.d.ts +2 -0
- package/lib/components/Search/MenuItemSearch.js +2 -0
- package/lib/components/Search/Search.d.ts +3 -0
- package/lib/components/Search/Search.js +2 -0
- package/lib/components/Search/SearchBox.d.ts +2 -8
- package/lib/components/Search/SearchBox.js +1 -1
- package/lib/components/Search/index.d.ts +1 -0
- package/lib/components/Search/index.js +1 -1
- package/lib/components/Search/types.d.ts +11 -8
- package/lib/components/Search/utils.js +1 -1
- package/lib/components/SectionContent/SectionContent.d.ts +15 -0
- package/lib/components/SectionContent/SectionContent.js +2 -0
- package/lib/components/SectionContent/index.d.ts +1 -0
- package/lib/components/SectionContent/index.js +2 -0
- package/lib/components/SectionItem/SectionItem.d.ts +2 -3
- package/lib/components/SectionItem/SectionItem.js +1 -1
- package/lib/components/SecurityRequirement/PanelDescription.d.ts +1 -6
- package/lib/components/SecurityRequirement/RequirementElement.d.ts +2 -7
- package/lib/components/SecurityRequirement/RequirementElement.js +3 -3
- package/lib/components/SecurityRequirement/SecurityDefs.d.ts +1 -7
- package/lib/components/SecurityRequirement/SecurityDefs.js +1 -1
- package/lib/components/SecurityRequirement/SecurityRequirement.d.ts +3 -6
- package/lib/components/SecurityRequirement/SecurityRequirement.js +1 -1
- package/lib/components/SecurityRequirement/constants.d.ts +6 -6
- package/lib/components/SecurityRequirement/constants.js +1 -1
- package/lib/components/SecurityRequirement/types.d.ts +19 -0
- package/lib/components/SecurityRequirement/types.js +2 -0
- package/lib/components/SecurityRequirement/useSecurityRequirements.d.ts +3 -0
- package/lib/components/SecurityRequirement/useSecurityRequirements.js +2 -0
- package/lib/components/SecuritySchemes/OAuthFlow.d.ts +3 -0
- package/lib/components/SecuritySchemes/OAuthFlow.js +2 -0
- package/lib/components/SecuritySchemes/helpers.d.ts +1 -1
- package/lib/components/SecuritySchemes/index.d.ts +1 -1
- package/lib/components/SecuritySchemes/index.js +1 -1
- package/lib/components/SecuritySchemes/types.d.ts +0 -1
- package/lib/components/SideMenu/MenuItem.d.ts +7 -5
- package/lib/components/SideMenu/MenuItem.js +1 -1
- package/lib/components/SideMenu/MenuItemEternalLink.d.ts +1 -2
- package/lib/components/SideMenu/MenuItemEternalLink.js +1 -1
- package/lib/components/SideMenu/MenuItemLink.d.ts +3 -0
- package/lib/components/SideMenu/MenuItemLink.js +2 -0
- package/lib/components/SideMenu/MenuItems.d.ts +2 -1
- package/lib/components/SideMenu/MenuItems.js +1 -1
- package/lib/components/SideMenu/MenuOperationItemContent.d.ts +5 -3
- package/lib/components/SideMenu/MenuOperationItemContent.js +2 -2
- package/lib/components/SideMenu/SideMenu.d.ts +8 -5
- package/lib/components/SideMenu/SideMenu.js +1 -1
- package/lib/components/SideMenu/styled.d.ts +10 -5
- package/lib/components/SideMenu/styled.js +12 -12
- package/lib/components/SideMenu/types.d.ts +10 -4
- package/lib/components/SideMenu/useMenuItemLink.d.ts +18 -0
- package/lib/components/SideMenu/useMenuItemLink.js +2 -0
- package/lib/components/StickySidebar/StickyResponsiveSidebar.d.ts +4 -6
- package/lib/components/StickySidebar/StickyResponsiveSidebar.js +2 -3
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabs.d.ts +2 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabs.js +1 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabsBase.d.ts +1 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabsBase.js +1 -1
- package/lib/components/TagItem/TagItem.d.ts +2 -0
- package/lib/components/TagItem/TagItem.js +2 -0
- package/lib/components/TagItem/index.d.ts +1 -0
- package/lib/components/TagItem/index.js +2 -0
- package/lib/components/TagItems/TagItems.d.ts +13 -0
- package/lib/components/TagItems/TagItems.js +2 -0
- package/lib/components/TagItems/index.d.ts +1 -0
- package/lib/components/TagItems/index.js +2 -0
- package/lib/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/ToggleRightPanelButton.js +2 -0
- package/lib/components/ToggleRightPanelButton/index.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/index.js +2 -0
- package/lib/components/ToggleRightPanelButton/styled.d.ts +3 -0
- package/lib/components/ToggleRightPanelButton/styled.js +17 -0
- package/lib/components/VersionSwitcher.d.ts +4 -3
- package/lib/components/VersionSwitcher.js +1 -1
- package/lib/components/common/Dropdown/Dropdown.js +2 -2
- package/lib/components/common/Fields/fields-layout.d.ts +0 -1
- package/lib/components/common/Fields/fields-layout.js +1 -6
- package/lib/components/common/LinkToField.d.ts +11 -2
- package/lib/components/common/LinkToField.js +9 -22
- package/lib/components/common/Portal/Portal.d.ts +6 -0
- package/lib/components/common/Portal/Portal.js +2 -0
- package/lib/components/common/Portal/index.d.ts +1 -0
- package/lib/components/common/Portal/index.js +2 -0
- package/lib/components/{ContentItems → common/Skeleton}/Skeleton.d.ts +0 -0
- package/lib/components/{ContentItems → common/Skeleton}/Skeleton.js +2 -2
- package/lib/components/common/Skeleton/index.d.ts +1 -0
- package/lib/components/common/Skeleton/index.js +2 -0
- package/lib/components/common/headers.d.ts +0 -6
- package/lib/components/common/headers.js +1 -25
- package/lib/components/common/index.d.ts +4 -2
- package/lib/components/common/index.js +1 -1
- package/lib/components/common/linkify.d.ts +3 -7
- package/lib/components/common/linkify.js +6 -51
- package/lib/components/common/panels.js +7 -4
- package/lib/components/common/perfect-scrollbar.js +2 -2
- package/lib/components/icons/LockIcon.d.ts +1 -1
- package/lib/components/icons/Spinner.d.ts +1 -1
- package/lib/components/index.d.ts +8 -9
- package/lib/components/index.js +1 -1
- package/lib/components/pluggable/PullRight.d.ts +3 -2
- package/lib/components/pluggable/PullRight.js +1 -55
- package/lib/components/pluggable/RedocExample.d.ts +1 -3
- package/lib/components/pluggable/RedocExample.js +1 -1
- package/lib/components/pluggable/RedocRequestBody.d.ts +1 -3
- package/lib/components/pluggable/RedocRequestBody.js +1 -1
- package/lib/components/pluggable/RedocResponse.d.ts +1 -3
- package/lib/components/pluggable/RedocResponse.js +1 -1
- package/lib/components/pluggable/RedocSchema.d.ts +1 -3
- package/lib/components/pluggable/RedocSchema.js +1 -1
- package/lib/components/rightPanel/CodemirrorInput/CodemirrorInput.js +1 -1
- package/lib/components/rightPanel/CodemirrorInput/helpers.d.ts +1 -10
- package/lib/components/rightPanel/CodemirrorInput/helpers.js +1 -1
- package/lib/components/rightPanel/Console/Console.d.ts +2 -2
- package/lib/components/rightPanel/Console/Console.js +1 -1
- package/lib/components/rightPanel/Console/ConsoleLazy.js +1 -1
- package/lib/components/rightPanel/Console/ConsoleWrapper.d.ts +5 -2
- package/lib/components/rightPanel/Console/ConsoleWrapper.js +1 -1
- package/lib/components/rightPanel/Console/Request.d.ts +3 -12
- package/lib/components/rightPanel/Console/Request.js +1 -1
- package/lib/components/rightPanel/Console/types.d.ts +14 -3
- package/lib/components/rightPanel/OAuth2Flow/OAuth2Flow.js +1 -1
- package/lib/components/rightPanel/OpenIDConnect.d.ts +2 -2
- package/lib/components/rightPanel/RequestBody/Body.d.ts +1 -1
- package/lib/components/rightPanel/RequestBody/Body.js +1 -1
- package/lib/components/rightPanel/RequestBody/RequestBody.d.ts +1 -1
- package/lib/components/rightPanel/RequestBody/RequestBody.js +1 -1
- package/lib/components/rightPanel/RequestBody/types.d.ts +1 -0
- package/lib/components/rightPanel/RequestBodyForm.d.ts +6 -3
- package/lib/components/rightPanel/RequestBodyForm.js +1 -1
- package/lib/components/rightPanel/ResponseHeadersList.js +1 -1
- package/lib/components/rightPanel/ServerVariable.d.ts +1 -1
- package/lib/components/rightPanel/ServerVariable.js +1 -1
- package/lib/components/rightPanel/ServersDropdown/ServersDropdown.d.ts +2 -1
- package/lib/components/rightPanel/ServersDropdown/ServersDropdown.js +1 -1
- package/lib/components/rightPanel/utils.d.ts +3 -2
- package/lib/components/rightPanel/utils.js +1 -1
- package/lib/constants.d.ts +0 -2
- package/lib/constants.js +1 -1
- package/lib/events/codeSampleCopy.js +1 -1
- package/lib/events/types.d.ts +2 -2
- package/lib/hoc/types.d.ts +38 -0
- package/lib/hoc/types.js +2 -0
- package/lib/hoc/utils.d.ts +2 -0
- package/lib/hoc/utils.js +2 -0
- package/lib/hoc/withRouter.d.ts +3 -0
- package/lib/hoc/withRouter.js +2 -0
- package/lib/hooks/index.d.ts +4 -0
- package/lib/hooks/index.js +1 -1
- package/lib/hooks/useActivateExample.d.ts +2 -0
- package/lib/hooks/useActivateExample.js +2 -0
- package/lib/hooks/useContentItems.d.ts +12 -0
- package/lib/hooks/useContentItems.js +2 -0
- package/lib/hooks/useLicense.d.ts +5 -0
- package/lib/hooks/useLicense.js +2 -0
- package/lib/hooks/useRouter.d.ts +11 -0
- package/lib/hooks/useRouter.js +2 -0
- package/lib/index.d.ts +2 -1
- package/lib/index.js +1 -1
- package/lib/models/callback.d.ts +5 -0
- package/lib/models/callback.js +2 -0
- package/lib/models/example.d.ts +10 -0
- package/lib/models/example.js +2 -0
- package/lib/models/field.d.ts +7 -0
- package/lib/models/field.js +2 -0
- package/lib/models/group.d.ts +4 -0
- package/lib/models/group.js +2 -0
- package/lib/models/index.d.ts +13 -14
- package/lib/models/index.js +1 -1
- package/lib/models/mediaContent.d.ts +7 -0
- package/lib/models/mediaContent.js +2 -0
- package/lib/models/mediaType.d.ts +20 -0
- package/lib/models/mediaType.js +2 -0
- package/lib/models/operation.d.ts +18 -0
- package/lib/models/operation.js +2 -0
- package/lib/models/request.d.ts +12 -0
- package/lib/models/request.js +2 -0
- package/lib/models/response.d.ts +15 -0
- package/lib/models/response.js +2 -0
- package/lib/models/schema.d.ts +14 -0
- package/lib/models/schema.js +2 -0
- package/lib/models/security.d.ts +13 -0
- package/lib/models/security.js +2 -0
- package/lib/models/types.d.ts +233 -3
- package/lib/recoil/app.d.ts +32 -0
- package/lib/recoil/app.js +2 -0
- package/lib/recoil/operation.d.ts +11 -0
- package/lib/recoil/operation.js +2 -0
- package/lib/recoil/store.d.ts +19 -0
- package/lib/recoil/store.js +2 -0
- package/lib/services/OpenAPIParser.d.ts +1 -1
- package/lib/services/OpenAPIParser.js +1 -1
- package/lib/services/Options/index.d.ts +1 -1
- package/lib/services/Options/index.js +1 -1
- package/lib/services/Options/{NormalizedOptions.d.ts → normalizeOptions.d.ts} +1 -1
- package/lib/services/Options/normalizeOptions.js +2 -0
- package/lib/services/Options/types.d.ts +31 -15
- package/lib/services/code-samples/generator.js +1 -1
- package/lib/services/code-samples/httpsnippet/targets/index.d.ts +1 -1
- package/lib/services/code-samples/httpsnippet/targets/javascript/index.d.ts +1 -1
- package/lib/services/code-samples/httpsnippet/targets/shell/curl.d.ts +2 -2
- package/lib/services/code-samples/types.d.ts +2 -2
- package/lib/services/history/helpers.d.ts +1 -1
- package/lib/services/history/helpers.js +1 -1
- package/lib/services/history/index.d.ts +1 -4
- package/lib/services/history/index.js +1 -1
- package/lib/services/index.d.ts +2 -7
- package/lib/services/index.js +1 -1
- package/lib/services/menu/builder.d.ts +9 -0
- package/lib/services/menu/builder.js +2 -0
- package/lib/services/menu/helpers.d.ts +6 -0
- package/lib/services/menu/helpers.js +2 -0
- package/lib/services/menu/index.d.ts +1 -0
- package/lib/services/menu/index.js +2 -0
- package/lib/services/menu/markdown.d.ts +11 -0
- package/lib/services/menu/markdown.js +2 -0
- package/lib/services/menu/operation.d.ts +13 -0
- package/lib/services/menu/operation.js +2 -0
- package/lib/services/menu/tags.d.ts +27 -0
- package/lib/services/menu/tags.js +2 -0
- package/lib/services/search/DeepSearchStore.d.ts +3 -3
- package/lib/services/search/DeepSearchStore.js +1 -1
- package/lib/services/search/SearchStore.d.ts +1 -1
- package/lib/services/search/useSearch.d.ts +13 -0
- package/lib/services/search/useSearch.js +2 -0
- package/lib/services/types.d.ts +42 -91
- package/lib/services/types.js +1 -1
- package/lib/services/utils.d.ts +1 -0
- package/lib/services/utils.js +1 -1
- package/lib/standalone.d.ts +5 -5
- package/lib/standalone.js +1 -1
- package/lib/testProviders.d.ts +2 -2
- package/lib/testProviders.js +1 -1
- package/lib/types/app.d.ts +1 -0
- package/lib/types/app.js +2 -0
- package/lib/types/index.d.ts +1 -0
- package/lib/types/index.js +1 -1
- package/lib/types/open-api.d.ts +15 -15
- package/lib/utils/compose.d.ts +1 -0
- package/lib/utils/compose.js +2 -0
- package/lib/utils/helpers.d.ts +2 -1
- package/lib/utils/helpers.js +1 -1
- package/lib/utils/index.d.ts +3 -2
- package/lib/utils/index.js +1 -1
- package/lib/utils/local-storage.js +1 -1
- package/lib/utils/openapi.d.ts +11 -7
- package/lib/utils/openapi.js +1 -1
- package/lib/utils/saveTextBeforeHeading.d.ts +1 -0
- package/lib/utils/saveTextBeforeHeading.js +2 -0
- package/lib/utils/typeGuards.d.ts +3 -0
- package/lib/utils/typeGuards.js +2 -0
- package/lib-esm/components/ApiInfo/ApiInfo.d.ts +1 -4
- package/lib-esm/components/ApiInfo/ApiInfo.js +1 -1
- package/lib-esm/components/ApiInfo/index.d.ts +0 -1
- package/lib-esm/components/ApiInfo/styled.d.ts +3 -1
- package/lib-esm/components/ApiInfo/styled.js +1 -1
- package/lib-esm/components/ApiInfo/types.d.ts +9 -4
- package/lib-esm/components/CallbackSamples/CallbackSamples.d.ts +2 -3
- package/lib-esm/components/CallbackSamples/CallbackSamples.js +1 -1
- package/lib-esm/components/Callbacks/CallbackDetails.d.ts +1 -1
- package/lib-esm/components/Callbacks/CallbackDetails.js +1 -1
- package/lib-esm/components/Callbacks/CallbackOperation.js +1 -1
- package/lib-esm/components/Callbacks/CallbacksList.js +1 -1
- package/lib-esm/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/ChangeViewButton.js +2 -0
- package/lib-esm/components/ChangeViewButton/index.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/index.js +2 -0
- package/lib-esm/components/ChangeViewButton/styled.d.ts +3 -0
- package/lib-esm/components/ChangeViewButton/styled.js +18 -0
- package/lib-esm/components/ContentItem/ContentItem.d.ts +6 -6
- package/lib-esm/components/ContentItem/ContentItem.js +1 -1
- package/lib-esm/components/ContentItems/ContentItems.d.ts +10 -4
- package/lib-esm/components/ContentItems/ContentItems.js +1 -1
- package/lib-esm/components/ContentItems/helpers.d.ts +11 -0
- package/lib-esm/components/ContentItems/helpers.js +2 -0
- package/lib-esm/components/ContentItems/useAutoScroll.d.ts +1 -0
- package/lib-esm/components/ContentItems/useAutoScroll.js +2 -0
- package/lib-esm/components/DiscriminatorDropdown/DiscriminatorDropdown.d.ts +2 -2
- package/lib-esm/components/DiscriminatorDropdown/DiscriminatorDropdown.js +1 -1
- package/lib-esm/components/Download/DownloadButtonWithLabel.d.ts +3 -4
- package/lib-esm/components/Download/DownloadButtonWithLabel.js +1 -1
- package/lib-esm/components/Download/types.d.ts +12 -0
- package/lib-esm/components/Download/useDownloadInfo.d.ts +2 -0
- package/lib-esm/components/Download/useDownloadInfo.js +2 -0
- package/lib-esm/components/Endpoint/Endpoint.js +1 -1
- package/lib-esm/components/Endpoint/ServerList.js +1 -1
- package/lib-esm/components/ExternalDocumentation/ExternalDocumentation.d.ts +2 -2
- package/lib-esm/components/ExternalDocumentation/ExternalDocumentation.js +3 -3
- package/lib-esm/components/Fields/DescriptionEnums.js +1 -1
- package/lib-esm/components/Fields/EnumValues.js +1 -1
- package/lib-esm/components/Fields/Examples.js +1 -1
- package/lib-esm/components/Fields/Extensions.js +2 -2
- package/lib-esm/components/Fields/Field.d.ts +3 -2
- package/lib-esm/components/Fields/Field.js +1 -1
- package/lib-esm/components/Fields/FieldDetails.d.ts +2 -3
- package/lib-esm/components/Fields/FieldDetails.js +1 -1
- package/lib-esm/components/Fields/SimpleEnums.js +1 -1
- package/lib-esm/components/Fields/types.d.ts +0 -1
- package/lib-esm/components/GenericChildrenSwitcher/GenericChildrenSwitcher.js +1 -1
- package/lib-esm/components/Markdown/Markdown.d.ts +1 -1
- package/lib-esm/components/Markdown/Markdown.js +1 -1
- package/lib-esm/components/Markdown/index.d.ts +0 -2
- package/lib-esm/components/Markdown/index.js +1 -1
- package/lib-esm/components/Markdown/styled.js +1 -3
- package/lib-esm/components/Markdown/types.d.ts +5 -13
- package/lib-esm/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +2 -2
- package/lib-esm/components/MediaTypeSwitch/MediaTypesSwitch.js +1 -1
- package/lib-esm/components/NextSectionButton/NextSectionButton.d.ts +8 -0
- package/lib-esm/components/NextSectionButton/NextSectionButton.js +2 -0
- package/lib-esm/components/NextSectionButton/index.d.ts +1 -0
- package/lib-esm/components/NextSectionButton/index.js +2 -0
- package/lib-esm/components/NextSectionButton/styled.d.ts +1 -0
- package/lib-esm/components/NextSectionButton/styled.js +18 -0
- package/lib-esm/components/OperationItem/OperationItem.d.ts +3 -0
- package/lib-esm/components/OperationItem/OperationItem.js +9 -0
- package/lib-esm/components/OperationItem/index.d.ts +2 -0
- package/lib-esm/components/OperationItem/index.js +2 -0
- package/lib-esm/components/OperationItem/types.d.ts +4 -0
- package/lib-esm/components/{Operation → OperationItem}/types.js +0 -0
- package/lib-esm/components/Overlay.d.ts +2 -7
- package/lib-esm/components/Overlay.js +1 -1
- package/lib-esm/components/Panel/ResponsePanel.js +1 -1
- package/lib-esm/components/Parameters/BodyContent.d.ts +3 -2
- package/lib-esm/components/Parameters/BodyContent.js +1 -1
- package/lib-esm/components/Parameters/ParametersGroup.js +1 -1
- package/lib-esm/components/PayloadSamples/MediaTypeSamples.d.ts +2 -3
- package/lib-esm/components/PayloadSamples/MediaTypeSamples.js +1 -1
- package/lib-esm/components/PayloadSamples/PayloadSamples.d.ts +2 -3
- package/lib-esm/components/PayloadSamples/PayloadSamples.js +1 -1
- package/lib-esm/components/PayloadSamples/types.d.ts +1 -2
- package/lib-esm/components/PayloadSamples/useExternalExample.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/Providers.d.ts +6 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/Providers.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.d.ts +4 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/index.d.ts +5 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/index.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.d.ts +13 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.js +170 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/types.d.ts +63 -0
- package/lib-esm/components/{types.js → RedoclyOpenAPIDocs/types.js} +0 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/utils.d.ts +10 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/utils.js +2 -0
- package/lib-esm/components/RequestSamples/CodeSample.d.ts +1 -1
- package/lib-esm/components/RequestSamples/CodeSample.js +1 -1
- package/lib-esm/components/RequestSamples/Example.d.ts +2 -2
- package/lib-esm/components/RequestSamples/Example.js +1 -1
- package/lib-esm/components/RequestSamples/RequestSamples.d.ts +1 -1
- package/lib-esm/components/RequestSamples/RequestSamples.js +1 -1
- package/lib-esm/components/ResponseSamples/ResponseSamples.d.ts +4 -1
- package/lib-esm/components/ResponseSamples/ResponseSamples.js +1 -1
- package/lib-esm/components/Responses/Response.d.ts +1 -3
- package/lib-esm/components/Responses/Response.js +1 -1
- package/lib-esm/components/Responses/ResponseSummary.js +14 -1
- package/lib-esm/components/Responses/styled.js +2 -2
- package/lib-esm/components/Samples/SamplesTabs.d.ts +3 -2
- package/lib-esm/components/Samples/SamplesTabs.js +1 -1
- package/lib-esm/components/Samples/use-example-key.d.ts +1 -1
- package/lib-esm/components/Samples/use-example-key.js +1 -1
- package/lib-esm/components/Schema/ObjectSchema.d.ts +1 -1
- package/lib-esm/components/Schema/ObjectSchema.js +1 -1
- package/lib-esm/components/Schema/OneOfSchema.d.ts +1 -1
- package/lib-esm/components/Schema/OneOfSchema.js +1 -1
- package/lib-esm/components/Schema/RecursiveSchema.d.ts +1 -1
- package/lib-esm/components/Schema/RecursiveSchema.js +1 -1
- package/lib-esm/components/Schema/Schema.d.ts +1 -1
- package/lib-esm/components/Schema/Schema.js +1 -1
- package/lib-esm/components/SchemaDefinition/SchemaDefinition.d.ts +1 -7
- package/lib-esm/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib-esm/components/Search/MenuItemSearch.d.ts +2 -0
- package/lib-esm/components/Search/MenuItemSearch.js +2 -0
- package/lib-esm/components/Search/Search.d.ts +3 -0
- package/lib-esm/components/Search/Search.js +2 -0
- package/lib-esm/components/Search/SearchBox.d.ts +2 -8
- package/lib-esm/components/Search/SearchBox.js +1 -1
- package/lib-esm/components/Search/index.d.ts +1 -0
- package/lib-esm/components/Search/index.js +1 -1
- package/lib-esm/components/Search/types.d.ts +11 -8
- package/lib-esm/components/Search/utils.js +1 -1
- package/lib-esm/components/SectionContent/SectionContent.d.ts +15 -0
- package/lib-esm/components/SectionContent/SectionContent.js +2 -0
- package/lib-esm/components/SectionContent/index.d.ts +1 -0
- package/lib-esm/components/SectionContent/index.js +2 -0
- package/lib-esm/components/SectionItem/SectionItem.d.ts +2 -3
- package/lib-esm/components/SectionItem/SectionItem.js +1 -1
- package/lib-esm/components/SecurityRequirement/PanelDescription.d.ts +1 -6
- package/lib-esm/components/SecurityRequirement/RequirementElement.d.ts +2 -7
- package/lib-esm/components/SecurityRequirement/RequirementElement.js +1 -1
- package/lib-esm/components/SecurityRequirement/SecurityDefs.d.ts +1 -7
- package/lib-esm/components/SecurityRequirement/SecurityDefs.js +1 -1
- package/lib-esm/components/SecurityRequirement/SecurityRequirement.d.ts +3 -6
- package/lib-esm/components/SecurityRequirement/SecurityRequirement.js +1 -1
- package/lib-esm/components/SecurityRequirement/constants.d.ts +6 -6
- package/lib-esm/components/SecurityRequirement/constants.js +1 -1
- package/lib-esm/components/SecurityRequirement/types.d.ts +19 -0
- package/lib-esm/components/SecurityRequirement/types.js +2 -0
- package/lib-esm/components/SecurityRequirement/useSecurityRequirements.d.ts +3 -0
- package/lib-esm/components/SecurityRequirement/useSecurityRequirements.js +2 -0
- package/lib-esm/components/SecuritySchemes/OAuthFlow.d.ts +3 -0
- package/lib-esm/components/SecuritySchemes/OAuthFlow.js +2 -0
- package/lib-esm/components/SecuritySchemes/helpers.d.ts +1 -1
- package/lib-esm/components/SecuritySchemes/index.d.ts +1 -1
- package/lib-esm/components/SecuritySchemes/index.js +1 -1
- package/lib-esm/components/SecuritySchemes/types.d.ts +0 -1
- package/lib-esm/components/SideMenu/MenuItem.d.ts +7 -5
- package/lib-esm/components/SideMenu/MenuItem.js +1 -1
- package/lib-esm/components/SideMenu/MenuItemEternalLink.d.ts +1 -2
- package/lib-esm/components/SideMenu/MenuItemEternalLink.js +1 -1
- package/lib-esm/components/SideMenu/MenuItemLink.d.ts +3 -0
- package/lib-esm/components/SideMenu/MenuItemLink.js +2 -0
- package/lib-esm/components/SideMenu/MenuItems.d.ts +2 -1
- package/lib-esm/components/SideMenu/MenuItems.js +1 -1
- package/lib-esm/components/SideMenu/MenuOperationItemContent.d.ts +5 -3
- package/lib-esm/components/SideMenu/MenuOperationItemContent.js +2 -2
- package/lib-esm/components/SideMenu/SideMenu.d.ts +8 -5
- package/lib-esm/components/SideMenu/SideMenu.js +1 -1
- package/lib-esm/components/SideMenu/styled.d.ts +10 -5
- package/lib-esm/components/SideMenu/styled.js +12 -12
- package/lib-esm/components/SideMenu/types.d.ts +10 -4
- package/lib-esm/components/SideMenu/useMenuItemLink.d.ts +18 -0
- package/lib-esm/components/SideMenu/useMenuItemLink.js +2 -0
- package/lib-esm/components/StickySidebar/StickyResponsiveSidebar.d.ts +4 -6
- package/lib-esm/components/StickySidebar/StickyResponsiveSidebar.js +2 -3
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabs.d.ts +2 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabs.js +1 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabsBase.d.ts +1 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabsBase.js +1 -1
- package/lib-esm/components/TagItem/TagItem.d.ts +2 -0
- package/lib-esm/components/TagItem/TagItem.js +2 -0
- package/lib-esm/components/TagItem/index.d.ts +1 -0
- package/lib-esm/components/TagItem/index.js +2 -0
- package/lib-esm/components/TagItems/TagItems.d.ts +13 -0
- package/lib-esm/components/TagItems/TagItems.js +2 -0
- package/lib-esm/components/TagItems/index.d.ts +1 -0
- package/lib-esm/components/TagItems/index.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/ToggleRightPanelButton.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/index.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/index.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/styled.d.ts +3 -0
- package/lib-esm/components/ToggleRightPanelButton/styled.js +17 -0
- package/lib-esm/components/VersionSwitcher.d.ts +4 -3
- package/lib-esm/components/VersionSwitcher.js +1 -1
- package/lib-esm/components/common/Dropdown/Dropdown.js +2 -2
- package/lib-esm/components/common/Fields/fields-layout.d.ts +0 -1
- package/lib-esm/components/common/Fields/fields-layout.js +0 -5
- package/lib-esm/components/common/LinkToField.d.ts +11 -2
- package/lib-esm/components/common/LinkToField.js +9 -22
- package/lib-esm/components/common/Portal/Portal.d.ts +6 -0
- package/lib-esm/components/common/Portal/Portal.js +2 -0
- package/lib-esm/components/common/Portal/index.d.ts +1 -0
- package/lib-esm/components/common/Portal/index.js +2 -0
- package/lib-esm/components/{ContentItems → common/Skeleton}/Skeleton.d.ts +0 -0
- package/lib-esm/components/{ContentItems → common/Skeleton}/Skeleton.js +1 -1
- package/lib-esm/components/common/Skeleton/index.d.ts +1 -0
- package/lib-esm/components/common/Skeleton/index.js +2 -0
- package/lib-esm/components/common/headers.d.ts +0 -6
- package/lib-esm/components/common/headers.js +1 -25
- package/lib-esm/components/common/index.d.ts +4 -2
- package/lib-esm/components/common/index.js +1 -1
- package/lib-esm/components/common/linkify.d.ts +3 -7
- package/lib-esm/components/common/linkify.js +6 -51
- package/lib-esm/components/common/panels.js +13 -10
- package/lib-esm/components/common/perfect-scrollbar.js +2 -2
- package/lib-esm/components/icons/LockIcon.d.ts +1 -1
- package/lib-esm/components/icons/Spinner.d.ts +1 -1
- package/lib-esm/components/index.d.ts +8 -9
- package/lib-esm/components/index.js +1 -1
- package/lib-esm/components/pluggable/PullRight.d.ts +3 -2
- package/lib-esm/components/pluggable/PullRight.js +1 -55
- package/lib-esm/components/pluggable/RedocExample.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocExample.js +1 -1
- package/lib-esm/components/pluggable/RedocRequestBody.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocRequestBody.js +1 -1
- package/lib-esm/components/pluggable/RedocResponse.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocResponse.js +1 -1
- package/lib-esm/components/pluggable/RedocSchema.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocSchema.js +1 -1
- package/lib-esm/components/rightPanel/CodemirrorInput/CodemirrorInput.js +1 -1
- package/lib-esm/components/rightPanel/CodemirrorInput/helpers.d.ts +1 -10
- package/lib-esm/components/rightPanel/CodemirrorInput/helpers.js +1 -1
- package/lib-esm/components/rightPanel/Console/Console.d.ts +2 -2
- package/lib-esm/components/rightPanel/Console/Console.js +1 -1
- package/lib-esm/components/rightPanel/Console/ConsoleLazy.js +1 -1
- package/lib-esm/components/rightPanel/Console/ConsoleWrapper.d.ts +5 -2
- package/lib-esm/components/rightPanel/Console/ConsoleWrapper.js +1 -1
- package/lib-esm/components/rightPanel/Console/Request.d.ts +3 -12
- package/lib-esm/components/rightPanel/Console/Request.js +1 -1
- package/lib-esm/components/rightPanel/Console/types.d.ts +14 -3
- package/lib-esm/components/rightPanel/OAuth2Flow/OAuth2Flow.js +1 -1
- package/lib-esm/components/rightPanel/OpenIDConnect.d.ts +2 -2
- package/lib-esm/components/rightPanel/RequestBody/Body.d.ts +1 -1
- package/lib-esm/components/rightPanel/RequestBody/Body.js +1 -1
- package/lib-esm/components/rightPanel/RequestBody/RequestBody.d.ts +1 -1
- package/lib-esm/components/rightPanel/RequestBody/RequestBody.js +1 -1
- package/lib-esm/components/rightPanel/RequestBody/types.d.ts +1 -0
- package/lib-esm/components/rightPanel/RequestBodyForm.d.ts +6 -3
- package/lib-esm/components/rightPanel/RequestBodyForm.js +1 -1
- package/lib-esm/components/rightPanel/ResponseHeadersList.js +1 -1
- package/lib-esm/components/rightPanel/ServerVariable.d.ts +1 -1
- package/lib-esm/components/rightPanel/ServerVariable.js +1 -1
- package/lib-esm/components/rightPanel/ServersDropdown/ServersDropdown.d.ts +2 -1
- package/lib-esm/components/rightPanel/ServersDropdown/ServersDropdown.js +1 -1
- package/lib-esm/components/rightPanel/utils.d.ts +3 -2
- package/lib-esm/components/rightPanel/utils.js +1 -1
- package/lib-esm/constants.d.ts +0 -2
- package/lib-esm/constants.js +1 -1
- package/lib-esm/events/codeSampleCopy.js +1 -1
- package/lib-esm/events/types.d.ts +2 -2
- package/lib-esm/hoc/types.d.ts +38 -0
- package/lib-esm/hoc/types.js +2 -0
- package/lib-esm/hoc/utils.d.ts +2 -0
- package/lib-esm/hoc/utils.js +2 -0
- package/lib-esm/hoc/withRouter.d.ts +3 -0
- package/lib-esm/hoc/withRouter.js +2 -0
- package/lib-esm/hooks/index.d.ts +4 -0
- package/lib-esm/hooks/index.js +1 -1
- package/lib-esm/hooks/useActivateExample.d.ts +2 -0
- package/lib-esm/hooks/useActivateExample.js +2 -0
- package/lib-esm/hooks/useContentItems.d.ts +12 -0
- package/lib-esm/hooks/useContentItems.js +2 -0
- package/lib-esm/hooks/useLicense.d.ts +5 -0
- package/lib-esm/hooks/useLicense.js +2 -0
- package/lib-esm/hooks/useRouter.d.ts +11 -0
- package/lib-esm/hooks/useRouter.js +2 -0
- package/lib-esm/index.d.ts +2 -1
- package/lib-esm/index.js +1 -1
- package/lib-esm/models/callback.d.ts +5 -0
- package/lib-esm/models/callback.js +2 -0
- package/lib-esm/models/example.d.ts +10 -0
- package/lib-esm/models/example.js +2 -0
- package/lib-esm/models/field.d.ts +7 -0
- package/lib-esm/models/field.js +2 -0
- package/lib-esm/models/group.d.ts +4 -0
- package/lib-esm/models/group.js +2 -0
- package/lib-esm/models/index.d.ts +13 -14
- package/lib-esm/models/index.js +1 -1
- package/lib-esm/models/mediaContent.d.ts +7 -0
- package/lib-esm/models/mediaContent.js +2 -0
- package/lib-esm/models/mediaType.d.ts +20 -0
- package/lib-esm/models/mediaType.js +2 -0
- package/lib-esm/models/operation.d.ts +18 -0
- package/lib-esm/models/operation.js +2 -0
- package/lib-esm/models/request.d.ts +12 -0
- package/lib-esm/models/request.js +2 -0
- package/lib-esm/models/response.d.ts +15 -0
- package/lib-esm/models/response.js +2 -0
- package/lib-esm/models/schema.d.ts +14 -0
- package/lib-esm/models/schema.js +2 -0
- package/lib-esm/models/security.d.ts +13 -0
- package/lib-esm/models/security.js +2 -0
- package/lib-esm/models/types.d.ts +233 -3
- package/lib-esm/recoil/app.d.ts +32 -0
- package/lib-esm/recoil/app.js +2 -0
- package/lib-esm/recoil/operation.d.ts +11 -0
- package/lib-esm/recoil/operation.js +2 -0
- package/lib-esm/recoil/store.d.ts +19 -0
- package/lib-esm/recoil/store.js +2 -0
- package/lib-esm/services/OpenAPIParser.d.ts +1 -1
- package/lib-esm/services/OpenAPIParser.js +1 -1
- package/lib-esm/services/Options/index.d.ts +1 -1
- package/lib-esm/services/Options/index.js +1 -1
- package/lib-esm/services/Options/{NormalizedOptions.d.ts → normalizeOptions.d.ts} +1 -1
- package/lib-esm/services/Options/normalizeOptions.js +2 -0
- package/lib-esm/services/Options/types.d.ts +31 -15
- package/lib-esm/services/code-samples/generator.js +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/index.d.ts +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/javascript/index.d.ts +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/shell/curl.d.ts +2 -2
- package/lib-esm/services/code-samples/types.d.ts +2 -2
- package/lib-esm/services/history/helpers.d.ts +1 -1
- package/lib-esm/services/history/helpers.js +1 -1
- package/lib-esm/services/history/index.d.ts +1 -4
- package/lib-esm/services/history/index.js +1 -1
- package/lib-esm/services/index.d.ts +2 -7
- package/lib-esm/services/index.js +1 -1
- package/lib-esm/services/menu/builder.d.ts +9 -0
- package/lib-esm/services/menu/builder.js +2 -0
- package/lib-esm/services/menu/helpers.d.ts +6 -0
- package/lib-esm/services/menu/helpers.js +2 -0
- package/lib-esm/services/menu/index.d.ts +1 -0
- package/lib-esm/services/menu/index.js +2 -0
- package/lib-esm/services/menu/markdown.d.ts +11 -0
- package/lib-esm/services/menu/markdown.js +2 -0
- package/lib-esm/services/menu/operation.d.ts +13 -0
- package/lib-esm/services/menu/operation.js +2 -0
- package/lib-esm/services/menu/tags.d.ts +27 -0
- package/lib-esm/services/menu/tags.js +2 -0
- package/lib-esm/services/search/DeepSearchStore.d.ts +3 -3
- package/lib-esm/services/search/DeepSearchStore.js +1 -1
- package/lib-esm/services/search/SearchStore.d.ts +1 -1
- package/lib-esm/services/search/useSearch.d.ts +13 -0
- package/lib-esm/services/search/useSearch.js +2 -0
- package/lib-esm/services/types.d.ts +42 -91
- package/lib-esm/services/types.js +1 -1
- package/lib-esm/services/utils.d.ts +1 -0
- package/lib-esm/services/utils.js +1 -1
- package/lib-esm/standalone.d.ts +5 -5
- package/lib-esm/standalone.js +1 -1
- package/lib-esm/testProviders.d.ts +2 -2
- package/lib-esm/testProviders.js +1 -1
- package/lib-esm/types/app.d.ts +1 -0
- package/lib-esm/types/app.js +2 -0
- package/lib-esm/types/index.d.ts +1 -0
- package/lib-esm/types/index.js +1 -1
- package/lib-esm/types/open-api.d.ts +15 -15
- package/lib-esm/utils/compose.d.ts +1 -0
- package/lib-esm/utils/compose.js +2 -0
- package/lib-esm/utils/helpers.d.ts +2 -1
- package/lib-esm/utils/helpers.js +1 -1
- package/lib-esm/utils/index.d.ts +3 -2
- package/lib-esm/utils/index.js +1 -1
- package/lib-esm/utils/local-storage.js +1 -1
- package/lib-esm/utils/openapi.d.ts +11 -7
- package/lib-esm/utils/openapi.js +1 -1
- package/lib-esm/utils/saveTextBeforeHeading.d.ts +1 -0
- package/lib-esm/utils/saveTextBeforeHeading.js +2 -0
- package/lib-esm/utils/typeGuards.d.ts +3 -0
- package/lib-esm/utils/typeGuards.js +2 -0
- package/package.json +13 -17
- package/bin/cli/assets/redoc-fast-scroll.js +0 -22
- package/bin/cli/assets/template.hbs +0 -24
- package/bin/cli/commands/redocly-docs-cli.min.js +0 -6130
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +0 -325
- package/dist/console.redocly-reference-docs.min.js +0 -507
- package/dist/redocly-reference-docs.min.js +0 -6218
- package/lib/cli/assets/redoc-fast-scroll.d.ts +0 -0
- package/lib/cli/assets/redoc-fast-scroll.js +0 -2
- package/lib/cli/cli.d.ts +0 -2
- package/lib/cli/cli.js +0 -3
- package/lib/cli/commands/bundle.d.ts +0 -1
- package/lib/cli/commands/bundle.js +0 -2
- package/lib/cli/commands/index.d.ts +0 -1
- package/lib/cli/commands/index.js +0 -2
- package/lib/cli/constants.d.ts +0 -3
- package/lib/cli/constants.js +0 -2
- package/lib/cli/utils.d.ts +0 -16
- package/lib/cli/utils.js +0 -2
- package/lib/components/Markdown/AdvancedMarkdown.d.ts +0 -2
- package/lib/components/Markdown/AdvancedMarkdown.js +0 -2
- package/lib/components/Markdown/SanitizedMarkdownHTML.d.ts +0 -6
- package/lib/components/Markdown/SanitizedMarkdownHTML.js +0 -2
- package/lib/components/NextSectionButton.d.ts +0 -13
- package/lib/components/NextSectionButton.js +0 -8
- package/lib/components/Operation/Operation.d.ts +0 -4
- package/lib/components/Operation/Operation.js +0 -8
- package/lib/components/Operation/index.d.ts +0 -2
- package/lib/components/Operation/index.js +0 -2
- package/lib/components/Operation/types.d.ts +0 -6
- package/lib/components/ProProviders.d.ts +0 -9
- package/lib/components/ProProviders.js +0 -2
- package/lib/components/RedoclyReferenceDocs.d.ts +0 -26
- package/lib/components/RedoclyReferenceDocs.js +0 -54
- package/lib/components/RedoclyReferenceDocsMultiStandalone.d.ts +0 -7
- package/lib/components/RedoclyReferenceDocsMultiStandalone.js +0 -2
- package/lib/components/Search/MenuItemProSearch.d.ts +0 -2
- package/lib/components/Search/MenuItemProSearch.js +0 -2
- package/lib/components/SecuritySchemes/SecuritySchemes.d.ts +0 -3
- package/lib/components/SecuritySchemes/SecuritySchemes.js +0 -2
- package/lib/components/SideMenu/MenuItemLinkOrLabel.d.ts +0 -7
- package/lib/components/SideMenu/MenuItemLinkOrLabel.js +0 -2
- package/lib/components/StoreProvider.d.ts +0 -22
- package/lib/components/StoreProvider.js +0 -2
- package/lib/components/styled.elements.d.ts +0 -19
- package/lib/components/styled.elements.js +0 -166
- package/lib/components/types.d.ts +0 -8
- package/lib/context/OptionsProvider.d.ts +0 -6
- package/lib/context/OptionsProvider.js +0 -2
- package/lib/context/StoreProvider.d.ts +0 -6
- package/lib/context/StoreProvider.js +0 -2
- package/lib/context/index.d.ts +0 -2
- package/lib/context/index.js +0 -2
- package/lib/models/ApiInfo.d.ts +0 -17
- package/lib/models/ApiInfo.js +0 -2
- package/lib/models/Callback.d.ts +0 -11
- package/lib/models/Callback.js +0 -2
- package/lib/models/Example.d.ts +0 -17
- package/lib/models/Example.js +0 -2
- package/lib/models/Field.d.ts +0 -34
- package/lib/models/Field.js +0 -2
- package/lib/models/Group.d.ts +0 -26
- package/lib/models/Group.js +0 -2
- package/lib/models/MediaContent.d.ts +0 -31
- package/lib/models/MediaContent.js +0 -2
- package/lib/models/MediaType.d.ts +0 -27
- package/lib/models/MediaType.js +0 -2
- package/lib/models/Operation.d.ts +0 -92
- package/lib/models/Operation.js +0 -2
- package/lib/models/RequestBody.d.ts +0 -18
- package/lib/models/RequestBody.js +0 -2
- package/lib/models/Response.d.ts +0 -28
- package/lib/models/Response.js +0 -2
- package/lib/models/Schema.d.ts +0 -78
- package/lib/models/Schema.js +0 -2
- package/lib/models/SecurityRequirement.d.ts +0 -12
- package/lib/models/SecurityRequirement.js +0 -2
- package/lib/models/SecuritySchemes.d.ts +0 -25
- package/lib/models/SecuritySchemes.js +0 -2
- package/lib/models/Webhook.d.ts +0 -8
- package/lib/models/Webhook.js +0 -2
- package/lib/services/MarkdownRenderer.d.ts +0 -23
- package/lib/services/MarkdownRenderer.js +0 -2
- package/lib/services/MenuBuilder.d.ts +0 -63
- package/lib/services/MenuBuilder.js +0 -2
- package/lib/services/Options/NormalizedOptions.js +0 -2
- package/lib/services/ProMenu.d.ts +0 -108
- package/lib/services/ProMenu.js +0 -2
- package/lib/services/ProStore.d.ts +0 -92
- package/lib/services/ProStore.js +0 -2
- package/lib/services/ScrollService.d.ts +0 -18
- package/lib/services/ScrollService.js +0 -2
- package/lib/services/SpecStore.d.ts +0 -18
- package/lib/services/SpecStore.js +0 -2
- package/lib/services/VersionedSpecStore.d.ts +0 -42
- package/lib/services/VersionedSpecStore.js +0 -2
- package/lib/services/history/FakeHistoryService.d.ts +0 -20
- package/lib/services/history/FakeHistoryService.js +0 -2
- package/lib/services/history/HistoryService.d.ts +0 -15
- package/lib/services/history/HistoryService.js +0 -2
- package/lib/services/history/ProHashHistoryService.d.ts +0 -25
- package/lib/services/history/ProHashHistoryService.js +0 -2
- package/lib/services/history/PushStateHistoryService.d.ts +0 -24
- package/lib/services/history/PushStateHistoryService.js +0 -2
- package/lib/utils/memoize.d.ts +0 -1
- package/lib/utils/memoize.js +0 -2
- package/lib/utils/store.d.ts +0 -3
- package/lib/utils/store.js +0 -2
- package/lib-esm/cli/assets/redoc-fast-scroll.d.ts +0 -0
- package/lib-esm/cli/assets/redoc-fast-scroll.js +0 -2
- package/lib-esm/cli/cli.d.ts +0 -2
- package/lib-esm/cli/cli.js +0 -3
- package/lib-esm/cli/commands/bundle.d.ts +0 -1
- package/lib-esm/cli/commands/bundle.js +0 -2
- package/lib-esm/cli/commands/index.d.ts +0 -1
- package/lib-esm/cli/commands/index.js +0 -2
- package/lib-esm/cli/constants.d.ts +0 -3
- package/lib-esm/cli/constants.js +0 -2
- package/lib-esm/cli/utils.d.ts +0 -16
- package/lib-esm/cli/utils.js +0 -2
- package/lib-esm/components/Markdown/AdvancedMarkdown.d.ts +0 -2
- package/lib-esm/components/Markdown/AdvancedMarkdown.js +0 -2
- package/lib-esm/components/Markdown/SanitizedMarkdownHTML.d.ts +0 -6
- package/lib-esm/components/Markdown/SanitizedMarkdownHTML.js +0 -2
- package/lib-esm/components/NextSectionButton.d.ts +0 -13
- package/lib-esm/components/NextSectionButton.js +0 -8
- package/lib-esm/components/Operation/Operation.d.ts +0 -4
- package/lib-esm/components/Operation/Operation.js +0 -8
- package/lib-esm/components/Operation/index.d.ts +0 -2
- package/lib-esm/components/Operation/index.js +0 -2
- package/lib-esm/components/Operation/types.d.ts +0 -6
- package/lib-esm/components/ProProviders.d.ts +0 -9
- package/lib-esm/components/ProProviders.js +0 -2
- package/lib-esm/components/RedoclyReferenceDocs.d.ts +0 -26
- package/lib-esm/components/RedoclyReferenceDocs.js +0 -54
- package/lib-esm/components/RedoclyReferenceDocsMultiStandalone.d.ts +0 -7
- package/lib-esm/components/RedoclyReferenceDocsMultiStandalone.js +0 -2
- package/lib-esm/components/Search/MenuItemProSearch.d.ts +0 -2
- package/lib-esm/components/Search/MenuItemProSearch.js +0 -2
- package/lib-esm/components/SecuritySchemes/SecuritySchemes.d.ts +0 -3
- package/lib-esm/components/SecuritySchemes/SecuritySchemes.js +0 -2
- package/lib-esm/components/SideMenu/MenuItemLinkOrLabel.d.ts +0 -7
- package/lib-esm/components/SideMenu/MenuItemLinkOrLabel.js +0 -2
- package/lib-esm/components/StoreProvider.d.ts +0 -22
- package/lib-esm/components/StoreProvider.js +0 -2
- package/lib-esm/components/styled.elements.d.ts +0 -19
- package/lib-esm/components/styled.elements.js +0 -166
- package/lib-esm/components/types.d.ts +0 -8
- package/lib-esm/context/OptionsProvider.d.ts +0 -6
- package/lib-esm/context/OptionsProvider.js +0 -2
- package/lib-esm/context/StoreProvider.d.ts +0 -6
- package/lib-esm/context/StoreProvider.js +0 -2
- package/lib-esm/context/index.d.ts +0 -2
- package/lib-esm/context/index.js +0 -2
- package/lib-esm/models/ApiInfo.d.ts +0 -17
- package/lib-esm/models/ApiInfo.js +0 -2
- package/lib-esm/models/Callback.d.ts +0 -11
- package/lib-esm/models/Callback.js +0 -2
- package/lib-esm/models/Example.d.ts +0 -17
- package/lib-esm/models/Example.js +0 -2
- package/lib-esm/models/Field.d.ts +0 -34
- package/lib-esm/models/Field.js +0 -2
- package/lib-esm/models/Group.d.ts +0 -26
- package/lib-esm/models/Group.js +0 -2
- package/lib-esm/models/MediaContent.d.ts +0 -31
- package/lib-esm/models/MediaContent.js +0 -2
- package/lib-esm/models/MediaType.d.ts +0 -27
- package/lib-esm/models/MediaType.js +0 -2
- package/lib-esm/models/Operation.d.ts +0 -92
- package/lib-esm/models/Operation.js +0 -2
- package/lib-esm/models/RequestBody.d.ts +0 -18
- package/lib-esm/models/RequestBody.js +0 -2
- package/lib-esm/models/Response.d.ts +0 -28
- package/lib-esm/models/Response.js +0 -2
- package/lib-esm/models/Schema.d.ts +0 -78
- package/lib-esm/models/Schema.js +0 -2
- package/lib-esm/models/SecurityRequirement.d.ts +0 -12
- package/lib-esm/models/SecurityRequirement.js +0 -2
- package/lib-esm/models/SecuritySchemes.d.ts +0 -25
- package/lib-esm/models/SecuritySchemes.js +0 -2
- package/lib-esm/models/Webhook.d.ts +0 -8
- package/lib-esm/models/Webhook.js +0 -2
- package/lib-esm/services/MarkdownRenderer.d.ts +0 -23
- package/lib-esm/services/MarkdownRenderer.js +0 -2
- package/lib-esm/services/MenuBuilder.d.ts +0 -63
- package/lib-esm/services/MenuBuilder.js +0 -2
- package/lib-esm/services/Options/NormalizedOptions.js +0 -2
- package/lib-esm/services/ProMenu.d.ts +0 -108
- package/lib-esm/services/ProMenu.js +0 -2
- package/lib-esm/services/ProStore.d.ts +0 -92
- package/lib-esm/services/ProStore.js +0 -2
- package/lib-esm/services/ScrollService.d.ts +0 -18
- package/lib-esm/services/ScrollService.js +0 -2
- package/lib-esm/services/SpecStore.d.ts +0 -18
- package/lib-esm/services/SpecStore.js +0 -2
- package/lib-esm/services/VersionedSpecStore.d.ts +0 -42
- package/lib-esm/services/VersionedSpecStore.js +0 -2
- package/lib-esm/services/history/FakeHistoryService.d.ts +0 -20
- package/lib-esm/services/history/FakeHistoryService.js +0 -2
- package/lib-esm/services/history/HistoryService.d.ts +0 -15
- package/lib-esm/services/history/HistoryService.js +0 -2
- package/lib-esm/services/history/ProHashHistoryService.d.ts +0 -25
- package/lib-esm/services/history/ProHashHistoryService.js +0 -2
- package/lib-esm/services/history/PushStateHistoryService.d.ts +0 -24
- package/lib-esm/services/history/PushStateHistoryService.js +0 -2
- package/lib-esm/utils/memoize.d.ts +0 -1
- package/lib-esm/utils/memoize.js +0 -2
- package/lib-esm/utils/store.d.ts +0 -3
- package/lib-esm/utils/store.js +0 -2
package/lib/models/Response.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var __decorate=this&&this.__decorate||function(e,t,o,r){var i,s=arguments.length,n=s<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var a=e.length-1;a>=0;a--)(i=e[a])&&(n=(s<3?i(n):s>3?i(t,o,n):i(t,o))||n);return s>3&&n&&Object.defineProperty(t,o,n),n};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ResponseModel=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),Field_1=require("./Field"),MediaContent_1=require("./MediaContent");class ResponseModel{constructor(e){Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"content",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"code",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"summary",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headers",{enumerable:!0,configurable:!0,writable:!0,value:[]});const{parser:t,code:o,defaultAsError:r,infoOrRef:i,options:s,isEvent:n,operation:a}=e,d=!!n;(0,mobx_1.makeObservable)(this),this.expanded="all"===s.expandResponses||s.expandResponses[o];const{resolved:l}=t.deref(i);this.code=o;const p=(0,utils_1.getContentWithLegacyExamples)(l);void 0!==p&&(this.content=new MediaContent_1.MediaContentModel(t,p,d,s,{operation:a,type:"response",response:this})),void 0!==l["x-summary"]?(this.summary=l["x-summary"],this.description=l.description||""):(this.summary=l.description||"",this.description=""),this.type=(0,utils_1.getStatusCodeType)(o,r);const c=l.headers;void 0!==c&&(this.headers=Object.keys(c).map((e=>{const o=c[e];return new Field_1.FieldModel(t,Object.assign(Object.assign({},o),{name:e}),"",s,void 0,{operation:a,type:"response",response:this})})))}toggle(){this.expanded=!this.expanded}expand(){this.expanded=!0}}__decorate([mobx_1.observable],ResponseModel.prototype,"expanded",void 0),__decorate([mobx_1.action],ResponseModel.prototype,"toggle",null),__decorate([mobx_1.action],ResponseModel.prototype,"expand",null),exports.ResponseModel=ResponseModel;
|
|
2
|
-
//# sourceMappingURL=Response.js.map
|
package/lib/models/Schema.d.ts
DELETED
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIExternalDocumentation, OpenAPISchema, Referenced } from '../types';
|
|
2
|
-
import type { OpenAPIParser, MergedOpenAPISchema } from '../services';
|
|
3
|
-
import type { OperationModel } from './Operation';
|
|
4
|
-
import type { ResponseModel } from './Response';
|
|
5
|
-
import type { Options } from 'src/services/Options';
|
|
6
|
-
import { FieldModel } from './Field';
|
|
7
|
-
export type Deps = {
|
|
8
|
-
parentFieldFullPath?: string;
|
|
9
|
-
operation?: OperationModel;
|
|
10
|
-
type?: 'request' | 'response';
|
|
11
|
-
response?: ResponseModel;
|
|
12
|
-
in?: string;
|
|
13
|
-
};
|
|
14
|
-
export declare class SchemaModel {
|
|
15
|
-
private parser;
|
|
16
|
-
private options;
|
|
17
|
-
private refsStack;
|
|
18
|
-
private deps;
|
|
19
|
-
pointer: string;
|
|
20
|
-
type: string | string[];
|
|
21
|
-
displayType: string;
|
|
22
|
-
typePrefix: string;
|
|
23
|
-
title: string;
|
|
24
|
-
description: string;
|
|
25
|
-
externalDocs?: OpenAPIExternalDocumentation;
|
|
26
|
-
isPrimitive: boolean;
|
|
27
|
-
isCircular: boolean;
|
|
28
|
-
format?: string;
|
|
29
|
-
displayFormat?: string;
|
|
30
|
-
nullable: boolean;
|
|
31
|
-
deprecated: boolean;
|
|
32
|
-
pattern?: string;
|
|
33
|
-
example?: any;
|
|
34
|
-
enum: any[];
|
|
35
|
-
default?: any;
|
|
36
|
-
readOnly: boolean;
|
|
37
|
-
writeOnly: boolean;
|
|
38
|
-
constraints: string[];
|
|
39
|
-
private _fields?;
|
|
40
|
-
items?: SchemaModel;
|
|
41
|
-
oneOf?: SchemaModel[];
|
|
42
|
-
oneOfType: string;
|
|
43
|
-
discriminatorProp: string;
|
|
44
|
-
activeOneOf: number;
|
|
45
|
-
rawSchema: OpenAPISchema;
|
|
46
|
-
schema: MergedOpenAPISchema;
|
|
47
|
-
extensions?: GenericObject;
|
|
48
|
-
'x-enumDescriptions': {
|
|
49
|
-
[name: string]: string;
|
|
50
|
-
};
|
|
51
|
-
const: any;
|
|
52
|
-
contentEncoding?: string;
|
|
53
|
-
contentMediaType?: string;
|
|
54
|
-
minItems?: number;
|
|
55
|
-
maxItems?: number;
|
|
56
|
-
/**
|
|
57
|
-
* @param parser
|
|
58
|
-
* @param schemaOrRef
|
|
59
|
-
* @param pointer
|
|
60
|
-
* @param options - normalized options
|
|
61
|
-
* @param isChild if schema discriminator Child
|
|
62
|
-
* When true forces dereferencing in allOfs even if circular
|
|
63
|
-
* @param refsStack - $ref stack leading to this Schema, used for circular resolution
|
|
64
|
-
* @param deps - items depth
|
|
65
|
-
*/
|
|
66
|
-
constructor(parser: OpenAPIParser, schemaOrRef: Referenced<OpenAPISchema>, pointer: string, options: Options, isChild?: boolean, refsStack?: string[], deps?: Deps);
|
|
67
|
-
/**
|
|
68
|
-
* Set specified alternative schema as active
|
|
69
|
-
* @param idx oneOf index
|
|
70
|
-
*/
|
|
71
|
-
activateOneOf(idx: number): void;
|
|
72
|
-
hasType(type: string): boolean;
|
|
73
|
-
get fields(): FieldModel[] | undefined;
|
|
74
|
-
init(parser: OpenAPIParser, isChild: boolean): void;
|
|
75
|
-
private initOneOf;
|
|
76
|
-
private initDiscriminator;
|
|
77
|
-
private initConditionalOperators;
|
|
78
|
-
}
|
package/lib/models/Schema.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var __decorate=this&&this.__decorate||function(e,i,t,r){var s,n=arguments.length,a=n<3?i:null===r?r=Object.getOwnPropertyDescriptor(i,t):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)a=Reflect.decorate(e,i,t,r);else for(var o=e.length-1;o>=0;o--)(s=e[o])&&(a=(n<3?s(a):n>3?s(i,t,a):s(i,t))||a);return n>3&&a&&Object.defineProperty(i,t,a),a},__rest=this&&this.__rest||function(e,i){var t={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&i.indexOf(r)<0&&(t[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var s=0;for(r=Object.getOwnPropertySymbols(e);s<r.length;s++)i.indexOf(r[s])<0&&Object.prototype.propertyIsEnumerable.call(e,r[s])&&(t[r[s]]=e[r[s]])}return t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SchemaModel=void 0;const mobx_1=require("mobx"),OpenAPIParser_1=require("../services/OpenAPIParser"),utils_1=require("../utils"),services_1=require("../services"),Field_1=require("./Field");class SchemaModel{constructor(e,i,t,r,s=!1,n=[],a={}){Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"refsStack",{enumerable:!0,configurable:!0,writable:!0,value:n}),Object.defineProperty(this,"deps",{enumerable:!0,configurable:!0,writable:!0,value:a}),Object.defineProperty(this,"pointer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"displayType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"typePrefix",{enumerable:!0,configurable:!0,writable:!0,value:""}),Object.defineProperty(this,"title",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isPrimitive",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isCircular",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"format",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"displayFormat",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"nullable",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"deprecated",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"pattern",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"example",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"enum",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"default",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"readOnly",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"writeOnly",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"constraints",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_fields",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"oneOf",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"oneOfType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"discriminatorProp",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeOneOf",{enumerable:!0,configurable:!0,writable:!0,value:0}),Object.defineProperty(this,"rawSchema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"schema",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"extensions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"x-enumDescriptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"const",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"contentEncoding",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"contentMediaType",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"minItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"maxItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),(0,mobx_1.makeObservable)(this),this.pointer=i.$ref||t||"";const{resolved:o,refsStack:l}=e.deref(i,n,!0);this.refsStack=(0,OpenAPIParser_1.pushRef)(l,this.pointer),this.rawSchema=o,this.schema=e.mergeAllOf(this.rawSchema,this.pointer,this.refsStack),this.init(e,s),r.showExtensions&&(this.extensions=(0,utils_1.extractExtensions)(this.schema,r.showExtensions))}activateOneOf(e){var i,t;this.activeOneOf=e;const r=null===(i=this.oneOf)||void 0===i?void 0:i[e].title;r&&(null===(t=this.deps.operation)||void 0===t||t.activateExampleName(r))}hasType(e){return this.type===e||Array.isArray(this.type)&&this.type.includes(e)}get fields(){if(!this.isCircular)return!this._fields&&this.hasType("object")&&(this._fields=buildFields(this.parser,this.schema,this.pointer,this.options,this.refsStack,this.deps)),this._fields}init(e,i){var t,r,s,n,a,o,l,d;const p=this.schema;if(this.isCircular=!!p["x-circular-ref"],this.title=p.title||(0,utils_1.isNamedDefinition)(this.pointer)&&utils_1.JsonPointer.baseName(this.pointer)||"",this.description=p.description||"",this.type=p.type||(0,utils_1.detectType)(p),this.format=p.format,this.enum=p.enum||[],this["x-enumDescriptions"]=p["x-enumDescriptions"],this.example=p.example,this.deprecated=!!p.deprecated,this.pattern=p.pattern,this.externalDocs=p.externalDocs,this.constraints=(0,utils_1.humanizeConstraints)(p),this.displayFormat=this.format,this.isPrimitive=(0,utils_1.isPrimitiveType)(p,this.type),this.default=p.default,this.readOnly=!!p.readOnly,this.writeOnly=!!p.writeOnly,this.const=p.const||"",this.contentEncoding=p.contentEncoding,this.contentMediaType=p.contentMediaType,this.minItems=p.minItems,this.maxItems=p.maxItems,(p.nullable||p["x-nullable"])&&(Array.isArray(this.type)&&!this.type.some((e=>null===e||"null"===e))?this.type=[...this.type,"null"]:Array.isArray(this.type)||null===this.type&&"null"===this.type||(this.type=[this.type,"null"])),this.displayType=Array.isArray(this.type)?this.type.map((e=>null===e?"null":e)).join(" or "):this.type,!this.isCircular)if(p.if&&p.then||p.if&&p.else)this.initConditionalOperators(p,e);else if(i||void 0===getDiscriminator(p)){if(i&&Array.isArray(p.oneOf)&&p.oneOf.find((e=>e.$ref===this.pointer))&&delete p.oneOf,void 0!==p.oneOf)return this.initOneOf(p.oneOf,e),this.oneOfType="One of",void(void 0!==p.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${this.pointer}`));if(void 0!==p.anyOf)return this.initOneOf(p.anyOf,e),void(this.oneOfType="Any of");if(this.hasType("array")&&(Array.isArray(p.items)||Array.isArray(p.prefixItems)?this._fields=buildFields(e,p,this.pointer,this.options,this.refsStack,this.deps):p.items&&(this.items=new SchemaModel(e,p.items,this.pointer+"/items",this.options,!1,this.refsStack,this.deps)),this.displayType=p.prefixItems||Array.isArray(p.items)?"items":(0,utils_1.pluralizeType)((null===(t=this.items)||void 0===t?void 0:t.displayType)||this.displayType),this.displayFormat=(null===(r=this.items)||void 0===r?void 0:r.format)||"",this.typePrefix=(null===(s=this.items)||void 0===s?void 0:s.typePrefix)||""+(0,services_1.l)("arrayOf"),this.title=this.title||(null===(n=this.items)||void 0===n?void 0:n.title)||"",this.isPrimitive=void 0!==(null===(a=this.items)||void 0===a?void 0:a.isPrimitive)?null===(o=this.items)||void 0===o?void 0:o.isPrimitive:this.isPrimitive,void 0===this.example&&void 0!==(null===(l=this.items)||void 0===l?void 0:l.example)&&(this.example=[this.items.example]),(null===(d=this.items)||void 0===d?void 0:d.isPrimitive)&&(this.enum=this.items.enum,this["x-enumDescriptions"]=this.items["x-enumDescriptions"]),Array.isArray(this.type))){const e=this.type.filter((e=>"array"!==e));e.length&&(this.displayType+=` or ${e.join(" or ")}`)}this.enum.length&&this.options.sortEnumValuesAlphabetically&&this.enum.sort()}else this.initDiscriminator(p,e)}initOneOf(e,i){if(this.oneOf=e.map(((e,t)=>{const{resolved:r,refsStack:s}=i.deref(e,this.refsStack,!0),n=i.mergeAllOf(r,this.pointer+"/oneOf/"+t,s),a=(0,utils_1.isNamedDefinition)(e.$ref)&&!n.title?utils_1.JsonPointer.baseName(e.$ref):`${n.title||""}${n.const&&JSON.stringify(n.const)||""}`;return new SchemaModel(i,Object.assign(Object.assign({},n),{title:a,allOf:[Object.assign(Object.assign({},this.schema),{oneOf:void 0,anyOf:void 0})],discriminator:r.allOf?void 0:n.discriminator}),e.$ref||this.pointer+"/oneOf/"+t,this.options,!1,s,Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+t:t.toString()}))})),this.options.simpleOneOfTypeLabel){const e=collectUniqueOneOfTypesDeep(this);this.displayType=e.join(" or ")}else this.displayType=this.oneOf.map((e=>{let i=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return i.indexOf(" or ")>-1&&(i=`(${i})`),i})).join(" or ")}initDiscriminator(e,i){const t=getDiscriminator(e);this.discriminatorProp=null==t?void 0:t.propertyName;const r=i.findDerived([...this.schema["x-parentRefs"]||[],this.pointer]);if(e.oneOf)for(const i of e.oneOf){if(void 0===i.$ref)continue;const e=utils_1.JsonPointer.baseName(i.$ref);r[i.$ref]=e}const s=(null==t?void 0:t.mapping)||{};let n=(null==t?void 0:t["x-explicitMappingOnly"])||!1;0===Object.keys(s).length&&(n=!1);const a={};for(const e in s){const i=s[e];Array.isArray(a[i])?a[i].push(e):a[i]=[e]}const o=n?Object.assign({},a):Object.assign(Object.assign({},r),a);let l=[];for(const e of Object.keys(o)){const i=o[e];if(Array.isArray(i))for(const t of i)l.push({$ref:e,name:t});else l.push({$ref:e,name:i})}const d=Object.keys(s);0!==d.length&&(l=l.sort(((e,i)=>{const t=d.indexOf(e.name),r=d.indexOf(i.name);return t<0&&r<0?e.name.localeCompare(i.name):t<0?1:r<0?-1:t-r}))),this.oneOf=l.map((({$ref:e,name:t},r)=>{const s=new SchemaModel(i,{$ref:e},e,this.options,!0,this.refsStack.slice(0,-1),Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+r:r.toString()}));return s.title=t,s}))}initConditionalOperators(e,i){const{if:t,else:r={},then:s={}}=e,n=__rest(e,["if","else","then"]),a=[{allOf:[n,s,t],title:t&&t["x-displayName"]||(null==t?void 0:t.title)||"case 1"},{allOf:[n,r],title:r&&r["x-displayName"]||(null==r?void 0:r.title)||"case 2"}];this.oneOf=a.map(((e,t)=>new SchemaModel(i,Object.assign({},e),this.pointer+"/oneOf/"+t,this.options,!1,this.refsStack,Object.assign(Object.assign({},this.deps),{parentFieldFullPath:this.deps.parentFieldFullPath?this.deps.parentFieldFullPath+this.options.deepLinkSeparator+t:t.toString()})))),this.oneOfType="One of"}}function normalizeField(e,i,t){return e||(console.warn(`Field "${i}" is invalid, skipping.\n Field must be an object but got ${typeof e} at "${t}"`),{})}function buildFields(e,i,t,r,s,n){const a=i.properties||i.prefixItems||i.items||{},o=i.patternProperties||{},l=i.additionalProperties||i.unevaluatedProperties,d=i.prefixItems?i.items:i.additionalItems,p=i.default||{};let c=Object.keys(a).map((o=>{var l;const d=normalizeField(a[o],o,t),c=void 0!==i.required&&i.required.indexOf(o)>-1;return new Field_1.FieldModel(e,{name:i.properties?o:`[${o}]`,required:c,schema:Object.assign(Object.assign({},d),{example:(null===(l=i.example)||void 0===l?void 0:l[o])||d.example,default:void 0===d.default&&p?p[o]:d.default})},t+"/properties/"+o,r,s,n)}));return r.sortPropsAlphabetically&&(c=(0,utils_1.sortByField)(c,"name")),r.requiredPropsFirst&&(c=(0,utils_1.sortByRequired)(c,r.sortPropsAlphabetically?void 0:i.required)),c.push(...Object.keys(o).map((i=>{const a=normalizeField(o[i],i,t);return new Field_1.FieldModel(e,{name:i,required:!1,schema:a,kind:"patternProperties"},`${t}/patternProperties/${i}`,r,s,n)}))),((0,utils_1.isObject)(l)||!0===l)&&c.push(new Field_1.FieldModel(e,{name:((0,utils_1.isObject)(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},t+"/additionalProperties",r,s,n)),c.push(...buildAdditionalItems({parser:e,schema:d,fieldsCount:c.length,$ref:t,options:r,refsStack:s,deps:n})),c}function buildAdditionalItems({parser:e,schema:i=!1,fieldsCount:t,$ref:r,options:s,refsStack:n,deps:a}){return"boolean"==typeof i?i?[new Field_1.FieldModel(e,{name:`[${t}...]`,schema:{},kind:"additionalItems"},`${r}/additionalItems`,s,n,a)]:[]:Array.isArray(i)?[...i.map(((i,o)=>new Field_1.FieldModel(e,{name:`[${t+o}]`,schema:i,kind:"additionalItems"},`${r}/additionalItems/${o}`,s,n,a)))]:(0,utils_1.isObject)(i)?[new Field_1.FieldModel(e,{name:`[${t}...]`,schema:i,kind:"additionalItems"},`${r}/additionalItems`,s,n,a)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function collectUniqueOneOfTypesDeep(e){const i=new Set;return function e(t){for(const r of t.oneOf||[])r.oneOf?e(r):r.type&&i.add(r.type)}(e),Array.from(i.values())}__decorate([mobx_1.observable],SchemaModel.prototype,"activeOneOf",void 0),__decorate([mobx_1.action],SchemaModel.prototype,"activateOneOf",null),exports.SchemaModel=SchemaModel;
|
|
2
|
-
//# sourceMappingURL=Schema.js.map
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { OpenAPISecurityRequirement, OpenAPISecurityScheme } from '../types';
|
|
2
|
-
import type { OpenAPIParser } from '../services';
|
|
3
|
-
export interface SecurityScheme extends OpenAPISecurityScheme {
|
|
4
|
-
id: string;
|
|
5
|
-
sectionId: string;
|
|
6
|
-
scopes: string[];
|
|
7
|
-
'x-defaultClientId'?: string;
|
|
8
|
-
}
|
|
9
|
-
export declare class SecurityRequirementModel {
|
|
10
|
-
schemes: SecurityScheme[];
|
|
11
|
-
constructor(requirement: OpenAPISecurityRequirement, parser: OpenAPIParser);
|
|
12
|
-
}
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SecurityRequirementModel=void 0;class SecurityRequirementModel{constructor(e,t){Object.defineProperty(this,"schemes",{enumerable:!0,configurable:!0,writable:!0,value:void 0});const i=t.definition.components&&t.definition.components.securitySchemes||{};this.schemes=Object.keys(e||{}).map((s=>{const r=t.deref(i[s]).resolved,o=e[s]||[];if(r)return Object.assign(Object.assign({},r),{id:s,sectionId:s,scopes:o});console.warn(`Non existing security scheme referenced: ${s}. Skipping`)})).filter((e=>void 0!==e))}}exports.SecurityRequirementModel=SecurityRequirementModel;
|
|
2
|
-
//# sourceMappingURL=SecurityRequirement.js.map
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import type { OpenAPISecurityScheme, Referenced } from '../types';
|
|
2
|
-
import type { OpenAPIParser } from '../services';
|
|
3
|
-
export declare class SecuritySchemeModel {
|
|
4
|
-
id: string;
|
|
5
|
-
sectionId: string;
|
|
6
|
-
type: OpenAPISecurityScheme['type'];
|
|
7
|
-
description: string;
|
|
8
|
-
apiKey?: {
|
|
9
|
-
name: string;
|
|
10
|
-
in: OpenAPISecurityScheme['in'];
|
|
11
|
-
};
|
|
12
|
-
http?: {
|
|
13
|
-
scheme: string;
|
|
14
|
-
bearerFormat?: string;
|
|
15
|
-
};
|
|
16
|
-
flows: OpenAPISecurityScheme['flows'];
|
|
17
|
-
openId?: {
|
|
18
|
-
connectUrl: string;
|
|
19
|
-
};
|
|
20
|
-
constructor(parser: OpenAPIParser, id: string, scheme: Referenced<OpenAPISecurityScheme>);
|
|
21
|
-
}
|
|
22
|
-
export declare class SecuritySchemesModel {
|
|
23
|
-
schemes: SecuritySchemeModel[];
|
|
24
|
-
constructor(parser: OpenAPIParser);
|
|
25
|
-
}
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SecuritySchemesModel=exports.SecuritySchemeModel=void 0;class SecuritySchemeModel{constructor(e,t,i){Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sectionId",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"apiKey",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"http",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"flows",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"openId",{enumerable:!0,configurable:!0,writable:!0,value:void 0});const{resolved:r}=e.deref(i);this.id=t,this.sectionId=t,this.type=r.type,this.description=r.description||"","apiKey"===r.type&&(this.apiKey={name:r.name,in:r.in}),"http"===r.type&&(this.http={scheme:r.scheme,bearerFormat:r.bearerFormat}),"openIdConnect"===r.type&&(this.openId={connectUrl:r.openIdConnectUrl}),"oauth2"===r.type&&r.flows&&(this.flows=r.flows)}}exports.SecuritySchemeModel=SecuritySchemeModel;class SecuritySchemesModel{constructor(e){Object.defineProperty(this,"schemes",{enumerable:!0,configurable:!0,writable:!0,value:void 0});const t=e.definition.components&&e.definition.components.securitySchemes||{};this.schemes=Object.keys(t).map((i=>new SecuritySchemeModel(e,i,t[i])))}}exports.SecuritySchemesModel=SecuritySchemesModel;
|
|
2
|
-
//# sourceMappingURL=SecuritySchemes.js.map
|
package/lib/models/Webhook.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIPath, Referenced } from '../types';
|
|
2
|
-
import type { OpenAPIParser, Options } from '../services';
|
|
3
|
-
import { OperationModel } from './Operation';
|
|
4
|
-
export declare class WebhookModel {
|
|
5
|
-
operations: OperationModel[];
|
|
6
|
-
constructor(parser: OpenAPIParser, options: Options, infoOrRef?: Referenced<OpenAPIPath>);
|
|
7
|
-
initWebhooks(parser: OpenAPIParser, webhooks: OpenAPIPath, options: Options): void;
|
|
8
|
-
}
|
package/lib/models/Webhook.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.WebhookModel=void 0;const utils_1=require("../utils"),Operation_1=require("./Operation");class WebhookModel{constructor(e,o,t){Object.defineProperty(this,"operations",{enumerable:!0,configurable:!0,writable:!0,value:[]});const{resolved:s}=e.deref(t||{});this.initWebhooks(e,s,o)}initWebhooks(e,o,t){for(const s of Object.keys(o)){const i=o[s],r=Object.keys(i).filter(utils_1.isOperationName);for(const o of r){const s=i[o];if(i.$ref){const s=e.deref(i||{});this.initWebhooks(e,{[o]:s},t)}if(!s)continue;const r=new Operation_1.OperationModel(e,Object.assign(Object.assign({},s),{httpVerb:o}),void 0,t,!1);this.operations.push(r)}}}}exports.WebhookModel=WebhookModel;
|
|
2
|
-
//# sourceMappingURL=Webhook.js.map
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { marked } from 'marked';
|
|
2
|
-
import type { MarkdownHeading, MDXComponentMeta } from './types';
|
|
3
|
-
import type { Options } from './Options/types';
|
|
4
|
-
export declare function buildComponentComment(name: string): string;
|
|
5
|
-
export declare class MarkdownRenderer {
|
|
6
|
-
options?: Options | undefined;
|
|
7
|
-
static containsComponent(rawText: string, componentName: string): boolean;
|
|
8
|
-
static getTextBeforeHading(md: string, heading: string): string;
|
|
9
|
-
headings: MarkdownHeading[];
|
|
10
|
-
currentTopHeading: MarkdownHeading;
|
|
11
|
-
private readonly headingSectionLevel;
|
|
12
|
-
private readonly headingEnhanceRenderer;
|
|
13
|
-
private readonly originalHeadingRule;
|
|
14
|
-
parser: marked.Parser;
|
|
15
|
-
constructor(options?: Options | undefined);
|
|
16
|
-
saveHeading(name: string, level: number, container?: MarkdownHeading[], parentId?: string): MarkdownHeading;
|
|
17
|
-
flattenHeadings(container?: MarkdownHeading[]): MarkdownHeading[];
|
|
18
|
-
attachHeadingsDescriptions(rawText: string): void;
|
|
19
|
-
headingRule: (text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: marked.Slugger) => string;
|
|
20
|
-
renderMd(rawText: string, extractHeadings?: boolean): string;
|
|
21
|
-
extractHeadings(rawText: string): MarkdownHeading[];
|
|
22
|
-
renderMdWithComponents(rawText: string): Array<string | MDXComponentMeta>;
|
|
23
|
-
}
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MarkdownRenderer=exports.buildComponentComment=void 0;const marked_1=require("marked"),utils_1=require("../utils"),constants_1=require("../constants"),renderer=new marked_1.marked.Renderer;function buildComponentComment(e){return`\x3c!-- ReDoc-Inject: <${e}> --\x3e`}marked_1.marked.setOptions({renderer:renderer,highlight:(e,n)=>(0,utils_1.highlight)(e,n)}),exports.buildComponentComment=buildComponentComment;class MarkdownRenderer{static containsComponent(e,n){return new RegExp(constants_1.COMPONENT_REGEXP.replace(/{component}/g,n),"gmi").test(e)}static getTextBeforeHading(e,n){const r=e.search(new RegExp(`^(>\\s+#+|#+)?\\s+${n}`,"m"));return r>-1?e.substring(0,r):e}constructor(e){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"headings",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"currentTopHeading",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingSectionLevel",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingEnhanceRenderer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"originalHeadingRule",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"parser",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"headingRule",{enumerable:!0,configurable:!0,writable:!0,value:(e,n,r,t)=>{var i,s;return 1===n?this.currentTopHeading=this.saveHeading(e,n):n<=this.headingSectionLevel&&this.saveHeading(e,n,null===(i=this.currentTopHeading)||void 0===i?void 0:i.items,null===(s=this.currentTopHeading)||void 0===s?void 0:s.id),this.originalHeadingRule(e,n,r,t)}}),this.headingEnhanceRenderer=new marked_1.marked.Renderer,this.parser=new marked_1.marked.Parser,this.originalHeadingRule=this.headingEnhanceRenderer.heading.bind(this.headingEnhanceRenderer),this.headingEnhanceRenderer.heading=this.headingRule,this.headingSectionLevel=(null==e?void 0:e.markdownHeadingsAnchorLevel)||2}saveHeading(e,n,r=this.headings,t){e=(0,utils_1.unescapeHTMLChars)(e);const i={id:t?`${t}/${(0,utils_1.safeSlugify)(e)}`:`section/${(0,utils_1.safeSlugify)(e)}`,name:e,level:n,items:[]};return r.push(i),i}flattenHeadings(e){if(void 0===e)return[];const n=[];for(const r of e)n.push(r),n.push(...this.flattenHeadings(r.items));return n}attachHeadingsDescriptions(e){const n=e=>new RegExp(`##?\\s+${e.name.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&")}`),r=this.flattenHeadings(this.headings);if(r.length<1)return;let t=r[0],i=n(t),s=e.search(i);for(let a=1;a<r.length;a++){const o=r[a],d=n(o),c=e.substr(s+1).search(d)+s+1;t.description=e.substring(s,c).replace(i,"").trim(),t=o,i=d,s=c}t.description=e.substring(s).replace(i,"").trim()}renderMd(e,n=!1){const r=n?{renderer:this.headingEnhanceRenderer}:void 0;return(0,marked_1.marked)(e.toString(),r)}extractHeadings(e){this.renderMd(e,!0),this.attachHeadingsDescriptions(e);const n=this.headings;return this.headings=[],n}renderMdWithComponents(e){const n=this.options&&this.options.allowedMdComponents;if(!n||0===Object.keys(n).length)return[this.renderMd(e)];const r=Object.keys(n).join("|"),t=new RegExp(constants_1.COMPONENT_REGEXP.replace(/{component}/g,r),"mig"),i=[],s=[];let a=t.exec(e),o=0;for(;a;){i.push(e.substring(o,a.index)),o=t.lastIndex;const r=n[a[1]||a[2]||a[5]],d=a[3]||a[6],c=a[4];r&&s.push({component:r.component,propsSelector:r.propsSelector,props:Object.assign(Object.assign(Object.assign({},parseProps(d)),r.props),{children:c})}),a=t.exec(e)}i.push(e.substring(o));const d=[];for(let e=0;e<i.length;e++){const n=i[e];n&&d.push(this.renderMd(n)),s[e]&&d.push(s[e])}return d}}function parseProps(e){if(!e)return{};const n=/([\w-]+)\s*=\s*(?:{([^}]+?)}|"([^"]+?)")/gim,r={};let t;for(;null!==(t=n.exec(e));)if(t[3])r[t[1]]=t[3];else if(t[2]){let e;try{e=JSON.parse(t[2])}catch(e){}r[t[1]]=e}return r}exports.MarkdownRenderer=MarkdownRenderer;
|
|
2
|
-
//# sourceMappingURL=MarkdownRenderer.js.map
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
import type { OpenAPITag } from '../types';
|
|
2
|
-
import type { OpenAPIParser } from './OpenAPIParser';
|
|
3
|
-
import type { TagGroup, TagInfo, TagsInfoMap } from './types';
|
|
4
|
-
import type { ContentItemModel } from '../models';
|
|
5
|
-
import type { Options } from './Options/types';
|
|
6
|
-
import { GroupModel, OperationModel } from '../models';
|
|
7
|
-
export declare class MenuBuilder {
|
|
8
|
-
/**
|
|
9
|
-
* Builds page content structure based on tags
|
|
10
|
-
*/
|
|
11
|
-
static buildStructure(parser: OpenAPIParser, options: Options): ContentItemModel[];
|
|
12
|
-
/**
|
|
13
|
-
* extracts items from markdown description
|
|
14
|
-
* @param description - markdown source
|
|
15
|
-
* @param parent
|
|
16
|
-
* @param initialDepth - number of items depth
|
|
17
|
-
* @param options - normalized options
|
|
18
|
-
*/
|
|
19
|
-
static addMarkdownItems(description: string, parent: GroupModel | undefined, initialDepth: number, options: Options): ContentItemModel[];
|
|
20
|
-
/**
|
|
21
|
-
* Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
|
|
22
|
-
* @param parser
|
|
23
|
-
* @param parent
|
|
24
|
-
* @param groups
|
|
25
|
-
* @param tags value of `x-tagGroups` vendor extension
|
|
26
|
-
* @param options - normalized options
|
|
27
|
-
*/
|
|
28
|
-
static getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: Options): GroupModel[];
|
|
29
|
-
/**
|
|
30
|
-
* Returns array of OperationsGroup items for the tags of the group or for all tags
|
|
31
|
-
* @param parser
|
|
32
|
-
* @param tagsMap tags info returned from `getTagsWithOperations`
|
|
33
|
-
* @param parent parent item
|
|
34
|
-
* @param group group which this tag belongs to. if not provided gets all tags
|
|
35
|
-
* @param options - normalized options
|
|
36
|
-
*/
|
|
37
|
-
static getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: Options): ContentItemModel[];
|
|
38
|
-
/**
|
|
39
|
-
* Returns array of schemas with reference to tag, or schemas with reference to schemaDefinitionsTagName tag
|
|
40
|
-
* @param tagsMap all tags
|
|
41
|
-
* @param tag tag to find reference of schema
|
|
42
|
-
* @param schemaDefinitionsTagName config
|
|
43
|
-
*/
|
|
44
|
-
static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
|
|
45
|
-
parser: OpenAPIParser;
|
|
46
|
-
tag: TagInfo;
|
|
47
|
-
parent: GroupModel;
|
|
48
|
-
schemaDefinitionsTagName?: string;
|
|
49
|
-
}): GroupModel[];
|
|
50
|
-
/**
|
|
51
|
-
* Returns array of Operation items for the tag
|
|
52
|
-
* @param parser
|
|
53
|
-
* @param parent parent OperationsGroup
|
|
54
|
-
* @param tag tag info returned from `getTagsWithOperations`
|
|
55
|
-
* @param depth items depth
|
|
56
|
-
* @param options - normalized options
|
|
57
|
-
*/
|
|
58
|
-
static getOperationsItems(parser: OpenAPIParser, parent: GroupModel | undefined, tag: TagInfo, depth: number, options: Options): OperationModel[];
|
|
59
|
-
/**
|
|
60
|
-
* collects tags and maps each tag to list of operations belonging to this tag
|
|
61
|
-
*/
|
|
62
|
-
static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
|
|
63
|
-
}
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MenuBuilder=void 0;const utils_1=require("../utils"),MarkdownRenderer_1=require("./MarkdownRenderer"),models_1=require("../models"),constants_1=require("../constants");class MenuBuilder{static buildStructure(e,t){const s=e.definition,n=[],o=[...s.tags||[]]||[];!o.find((e=>(null==e?void 0:e.name)===t.schemaDefinitionsTagName))&&t.schemaDefinitionsTagName&&o.push({name:t.schemaDefinitionsTagName});const i=MenuBuilder.getTagsWithOperations(e,o),r=s["x-tagGroups"];return n.push(...MenuBuilder.addMarkdownItems(s.info.description||"",void 0,1,t)),r&&r.length>0?n.push(...MenuBuilder.getTagGroupsItems(e,void 0,r,i,t)):n.push(...MenuBuilder.getTagsItems(e,i,void 0,void 0,t)),n}static addMarkdownItems(e,t,s,n){const o=new MarkdownRenderer_1.MarkdownRenderer(n).extractHeadings(e||"");o.length&&t&&t.description&&(t.description=MarkdownRenderer_1.MarkdownRenderer.getTextBeforeHading(t.description,o[0].name));const i=(e,t,s=1)=>t.map((t=>{const n=new models_1.GroupModel("section",t,e);return n.depth=s,t.items&&(n.items=i(n,t.items,s+1)),n}));return i(t,o,s)}static getTagGroupsItems(e,t,s,n,o){const i=[];for(const r of s){const s=new models_1.GroupModel("group",r,t);s.depth=constants_1.GROUP_DEPTH,s.items=MenuBuilder.getTagsItems(e,n,s,r,o),i.push(s)}return i}static getTagsItems(e,t,s,n,o){let i;if(i=void 0===n?Object.keys(t):n.tags,!Array.isArray(i))return console.warn("Unexpected values of tags. Check tags or x-tagGroups in your definition."),[];const r=i.map((e=>t[e]?(t[e].used=!0,t[e]):(console.warn(`Non-existing tag "${e}" is added to the group "${null==n?void 0:n.name}"`),null))),a=[];for(const t of r){if(!t)continue;const n=new models_1.GroupModel("tag",t,s);if(n.depth=constants_1.GROUP_DEPTH+1,""===t.name){const s=[...MenuBuilder.addMarkdownItems(t.description||"",n,n.depth+1,o),...this.getOperationsItems(e,void 0,t,n.depth+1,o)];a.push(...s);continue}const i=this.getTagRelatedSchema({parser:e,tag:t,parent:n,schemaDefinitionsTagName:o.schemaDefinitionsTagName});n.items=[...i,...MenuBuilder.addMarkdownItems(t.description||"",n,n.depth+1,o),...this.getOperationsItems(e,n,t,n.depth+1,o)],a.push(n)}return o.sortTagsAlphabetically&&a.sort((0,utils_1.alphabeticallyByProp)("name")),a}static getTagRelatedSchema({parser:e,tag:t,parent:s,schemaDefinitionsTagName:n}){var o;const i=n?[n]:[];return Object.entries((null===(o=e.definition.components)||void 0===o?void 0:o.schemas)||{}).map((([e,n])=>{if(!(n["x-tags"]||i).includes(t.name))return null;const o=new models_1.GroupModel("schema",{name:e,"x-displayName":`${n.title||e}`,description:`<SchemaDefinition showWriteOnly={true} schemaRef="#/components/schemas/${e}" />`,isSchema:!0,level:2},s);return o.depth=s.depth+1,o})).filter(Boolean)}static getOperationsItems(e,t,s,n,o){if(0===s.operations.length)return[];const i=[];for(const r of s.operations){const s=new models_1.OperationModel(e,r,t,o);s.depth=n,i.push(s)}return o.sortOperationsAlphabetically&&i.sort((0,utils_1.alphabeticallyByProp)("name")),i}static getTagsWithOperations(e,t){const s={},{definition:n}=e,o=n["x-webhooks"]||n.webhooks;for(const e of t||[])s[e.name]=Object.assign(Object.assign({},e),{operations:[]});function i(e,t,n){for(const o of Object.keys(t||{})){const r=t[o],a=Object.keys(r).filter(utils_1.isOperationName);for(const t of a){const a=r[t];if(r.$ref){const{resolved:t}=e.deref(r);i(e,{[o]:t},n);continue}let d=null==a?void 0:a.tags;d&&d.length||(d=[""]);for(const e of d){let i=s[e];void 0===i&&(i={name:e,operations:[]},s[e]=i),i["x-traitTag"]||i.operations.push(Object.assign(Object.assign({},a),{pathName:o,pointer:utils_1.JsonPointer.compile(["paths",o,t]),httpVerb:t,pathParameters:r.parameters||[],pathServers:r.servers,isWebhook:!!n}))}}}}return n.paths&&i(e,n.paths),o&&i(e,o,!0),s}}exports.MenuBuilder=MenuBuilder;
|
|
2
|
-
//# sourceMappingURL=MenuBuilder.js.map
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.NormalizedOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),types_1=require("./types"),utils_1=require("../../utils"),utils_2=require("../utils"),helpers_1=require("./helpers"),types_2=require("../types");function NormalizedOptions(e,a){var o,l,n;e=Object.assign(Object.assign({},a),e);const t=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(o=e.ignoreNamedSchemas)||void 0===o?void 0:o.split(",").map((e=>e.trim())),i={corsProxyUrl:(0,helpers_1.addTrailingSlash)(e.corsProxyUrl),authCorsProxyUrl:(0,helpers_1.addTrailingSlash)(e.authCorsProxyUrl),ctrlFHijack:(0,utils_1.argValueToBoolean)(e.ctrlFHijack,!0),disableDeepLinks:(0,utils_1.argValueToBoolean)(e.disableDeepLinks,!1),disableTryItRequestUrlEncoding:(0,utils_1.argValueToBoolean)(e.disableTryItRequestUrlEncoding,!1),minCharacterLengthToInitSearch:(0,utils_1.argValueToNumber)(e.minCharacterLengthToInitSearch,3),disableSearch:(0,utils_1.argValueToBoolean)(e.disableSearch,!1),disableSidebar:(0,utils_1.argValueToBoolean)(e.disableSidebar,!1),expandResponses:(0,helpers_1.normalizeExpandResponses)(e.expandResponses),jsonSampleExpandLevel:(0,utils_1.argValueToExpandLevel)(e.jsonSampleExpandLevel,2),expandDefaultServerVariables:(0,utils_1.argValueToBoolean)(e.expandDefaultServerVariables,!1),expandDefaultRequest:(0,utils_1.argValueToBoolean)(e.expandDefaultRequest,!0),expandDefaultResponse:(0,utils_1.argValueToBoolean)(e.expandDefaultResponse,!0),expandSingleSchemaField:(0,utils_1.argValueToBoolean)(e.expandSingleSchemaField,!1),generatedPayloadSamplesMaxDepth:(0,utils_1.argValueToInt)(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButton:void 0===e.hideDownloadButton?null:(0,utils_1.argValueToBoolean)(e.hideDownloadButton),hideInfoDescription:(0,utils_1.argValueToBoolean)(e.hideInfoDescription),hideHostname:(0,utils_1.argValueToBoolean)(e.hideHostname,!1),hideInfoSection:(0,utils_1.argValueToBoolean)(e.hideInfoSection,!1),hideLoading:(0,utils_1.argValueToBoolean)(e.hideLoading,!1),hideLogo:(0,utils_1.argValueToBoolean)(e.hideLogo,!1),hideFab:(0,utils_1.argValueToBoolean)(e.hideFab,!1),hideRequestPayloadSample:(0,utils_1.argValueToBoolean)(e.hideRequestPayloadSample,!1),hideRightPanel:(0,utils_1.argValueToBoolean)(e.hideRightPanel,!1),hideSchemaPattern:(0,utils_1.argValueToBoolean)(e.hideSchemaPattern,!1),hideOneOfDescription:(0,utils_1.argValueToBoolean)(e.hideOneOfDescription,!1),hideSchemaTitles:(0,utils_1.argValueToBoolean)(e.hideSchemaTitles,!1),hideSingleRequestSampleTab:(0,utils_1.argValueToBoolean)(e.hideSingleRequestSampleTab,!1),hideTryItPanel:(0,utils_1.argValueToBoolean)(e.hideTryItPanel,!1),showObjectSchemaExamples:(0,utils_1.argValueToBoolean)(e.showObjectSchemaExamples,!1),showAccessMode:(0,utils_1.argValueToBoolean)(e.showAccessMode,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),maxResponseHeadersToShowInTryIt:(0,utils_1.argValueToNumber)(e.maxResponseHeadersToShowInTryIt,0),menuToggle:(0,utils_1.argValueToBoolean)(e.menuToggle,!0),mockServer:(null===(l=e.mockServer)||void 0===l?void 0:l.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,nativeScrollbars:(0,utils_1.argValueToBoolean)(e.nativeScrollbars,!1),oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:(0,utils_1.argValueToBoolean)(e.onlyRequiredInSamples,!1),pathInMiddlePanel:(0,utils_1.argValueToBoolean)(e.pathInMiddlePanel,!1),onDeepLinkClick:e.onDeepLinkClick||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:e.routingBasePath&&(0,utils_2.normalizePath)(e.routingBasePath)||"",routingStrategy:e.routingStrategy,schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),pagination:e.pagination||"none",payloadSampleIdx:(0,helpers_1.normalizePayloadSampleIdx)(e.payloadSampleIdx,0),requiredPropsFirst:(0,utils_1.argValueToBoolean)(e.requiredPropsFirst,!1),markdownHeadingsAnchorLevel:(0,utils_1.argValueToNumber)(e.markdownHeadingsAnchorLevel,2),samplesTabsMaxCount:(0,utils_1.argValueToInt)(e.samplesTabsMaxCount,5),scrollYOffset:(0,helpers_1.normalizeScrollYOffset)(e.scrollYOffset),searchAutoExpand:(0,utils_1.argValueToBoolean)(e.searchAutoExpand,!0),searchFieldLevelBoost:(0,utils_1.argValueToNumber)(e.searchFieldLevelBoost,.95),searchMaxDepth:(0,utils_1.argValueToNumber)(e.searchMaxDepth,constants_1.DEFAULT_SEARCH_MAX_DEPTH),searchOperationTitleBoost:(0,utils_1.argValueToNumber)(e.searchOperationTitleBoost,4),searchTagTitleBoost:(0,utils_1.argValueToNumber)(e.searchTagTitleBoost,8),sendXUserAgentInTryIt:(0,utils_1.argValueToBoolean)(e.sendXUserAgentInTryIt,!1),showWebhookVerb:(0,utils_1.argValueToBoolean)(e.showWebhookVerb,!1),showChangeLayoutButton:(0,utils_1.argValueToBoolean)(e.showChangeLayoutButton,!0),showConsole:null!=e.hideTryItPanel?!e.hideTryItPanel:null===(n=e.showConsole)||void 0===n||n,showExtensions:(0,helpers_1.normalizeShowExtensions)(e.showExtensions),preserveOriginalExtensionsName:(0,utils_1.argValueToBoolean)(e.preserveOriginalExtensionsName,!1),showNextButton:(0,utils_1.argValueToBoolean)(e.showNextButton,!0),showRightPanelToggle:(0,utils_1.argValueToBoolean)(e.showRightPanelToggle,!0),showSecuritySchemeType:(0,utils_1.argValueToBoolean)(e.showSecuritySchemeType,!0),hideSecuritySection:(0,utils_1.argValueToBoolean)(e.hideSecuritySection,!1),simpleOneOfTypeLabel:(0,utils_1.argValueToBoolean)(e.simpleOneOfTypeLabel,!1),sortEnumValuesAlphabetically:(0,utils_1.argValueToBoolean)(e.sortEnumValuesAlphabetically),sortOperationsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortOperationsAlphabetically),sortPropsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortPropsAlphabetically,!1),sortTagsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortTagsAlphabetically,!1),unstable_ignoreMimeParameters:(0,utils_1.argValueToBoolean)(e.unstable_ignoreMimeParameters,!1),untrustedDefinition:(0,utils_1.argValueToBoolean)(e.untrustedDefinition,!1),enumSkipQuotes:(0,utils_1.argValueToBoolean)(e.enumSkipQuotes),whiteLabel:(0,utils_1.argValueToBoolean)(e.whiteLabel),linkForId:e.linkForId||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.LINK_FOR_ID),generateDeepLink:e.generateDeepLink||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.GENERATE_DEEP_LINK),skipBundleAndConvert:(0,utils_1.argValueToBoolean)(e.skipBundleAndConvert),disablePaginationLoadingAnimation:(0,utils_1.argValueToBoolean)(!!e.disablePaginationLoadingAnimation),disableErrorBoundary:(0,utils_1.argValueToBoolean)(e.disableErrorBoundary),ignoreNamedSchemas:new Set(t),mediaQueries:(0,theme_1.generateMediaQueries)((null==e?void 0:e.breakpoints)||{}),showAtBreakpoint:e.showAtBreakpoint,allowedMdComponents:(null==e?void 0:e.allowedMdComponents)||{}};null!=e.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.');const s="object"==typeof e.layout?e.layout:null;if(!(null==e?void 0:e.pagination)&&(null==s?void 0:s.scope))switch(console.warn('"layout.scope" and "routingStrategy" settings are deprecated. Please, use "pagination" instead.'),null==s?void 0:s.scope){case"all":default:i.pagination="none",i.routingStrategy="hash";break;case"section":i.pagination="section",i.routingStrategy="browser";break;case"item":i.pagination="item",i.routingStrategy="browser"}return i.routingStrategy=void 0!==e.routingStrategy?e.routingStrategy:"none"===i.pagination?"hash":"browser",i.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||"none"===i.pagination,Object.assign(DEFAULT_USER_OPTIONS,e,i)}exports.NormalizedOptions=NormalizedOptions;const DEFAULT_USER_OPTIONS={defaultSampleLanguage:"",generateCodeSamples:{languages:[]},layout:constants_1.LayoutVariant.THREE_PANEL,sideNavStyle:types_2.SideNavStyle.SummaryOnly,searchMode:types_1.SearchMode.Default,sidebarLinks:{},events:{},hooks:(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_tryItButtonOverride:null,unstable_externalCodeSamples:[],deepLinkSeparator:"/",deepLinkPrefix:"!",markdownItemsPagination:"none"};
|
|
2
|
-
//# sourceMappingURL=NormalizedOptions.js.map
|
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
import type { IMenuItem, ScrollService, HistoryService, MenuItemType, SpecStore } from '../services';
|
|
2
|
-
import type { Options } from './Options/types';
|
|
3
|
-
import type { SchemaModel } from '../models';
|
|
4
|
-
import { VersionedSpecStore } from './VersionedSpecStore';
|
|
5
|
-
export type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
|
|
6
|
-
type: MenuItemType | 'spec';
|
|
7
|
-
linkable?: boolean;
|
|
8
|
-
href?: string;
|
|
9
|
-
httpVerb?: string;
|
|
10
|
-
path?: string;
|
|
11
|
-
};
|
|
12
|
-
/**
|
|
13
|
-
* Stores all side-menu related information
|
|
14
|
-
*/
|
|
15
|
-
export declare class ProMenu {
|
|
16
|
-
definition: SpecStore | VersionedSpecStore;
|
|
17
|
-
scroll: ScrollService;
|
|
18
|
-
options: Options;
|
|
19
|
-
history: HistoryService;
|
|
20
|
-
/**
|
|
21
|
-
* Statically try update scroll position
|
|
22
|
-
* Used before hydrating from server-side rendered html to scroll page faster
|
|
23
|
-
*/
|
|
24
|
-
static updateOnHistory(id: string | undefined, scroll: ScrollService): void;
|
|
25
|
-
flatItems: (ExtendedMenuItem & IMenuItem)[];
|
|
26
|
-
items: (ExtendedMenuItem & IMenuItem)[];
|
|
27
|
-
activeRenderItemIdx: number;
|
|
28
|
-
renderItems: ExtendedMenuItem[];
|
|
29
|
-
/**
|
|
30
|
-
* active item absolute index (when flattened). -1 means nothing is selected
|
|
31
|
-
*/
|
|
32
|
-
activeItemIdx: number;
|
|
33
|
-
/**
|
|
34
|
-
* whether sidebar with menu is opened or not
|
|
35
|
-
*/
|
|
36
|
-
sideBarOpened: boolean;
|
|
37
|
-
private _unsubscribe;
|
|
38
|
-
private _hashUnsubscribe;
|
|
39
|
-
/**
|
|
40
|
-
*
|
|
41
|
-
* @param definition [SpecStore](#SpecStore) which contains page content structure
|
|
42
|
-
* @param scroll scroll service instance used by this menu
|
|
43
|
-
* @param options normalized options
|
|
44
|
-
* @param history
|
|
45
|
-
*/
|
|
46
|
-
constructor(definition: SpecStore | VersionedSpecStore, scroll: ScrollService, options: Options, history: HistoryService);
|
|
47
|
-
subscribe(): void;
|
|
48
|
-
toggleSidebar(): void;
|
|
49
|
-
closeSidebar(): void;
|
|
50
|
-
/**
|
|
51
|
-
* get section/operation DOM Node related to the item or null if it doesn't exist
|
|
52
|
-
* @param idx item absolute index
|
|
53
|
-
*/
|
|
54
|
-
getElementAt(idx: number): Element | null;
|
|
55
|
-
/**
|
|
56
|
-
* get section/operation DOM Node related to the item or if it is group item, returns first item of the group
|
|
57
|
-
* @param idx item absolute index
|
|
58
|
-
*/
|
|
59
|
-
getElementAtOrFirstChild(idx: number): Element | null;
|
|
60
|
-
/**
|
|
61
|
-
* current active item
|
|
62
|
-
*/
|
|
63
|
-
get activeItem(): IMenuItem;
|
|
64
|
-
getItemById: (id: string) => (ExtendedMenuItem & IMenuItem) | undefined;
|
|
65
|
-
/**
|
|
66
|
-
* update active items on initial page load
|
|
67
|
-
* @param currentId
|
|
68
|
-
*/
|
|
69
|
-
initOnHistory: (currentId?: string) => void;
|
|
70
|
-
/**
|
|
71
|
-
* update active items on hash change
|
|
72
|
-
* @param currentId
|
|
73
|
-
*/
|
|
74
|
-
updateOnHistory: (currentId?: string) => void;
|
|
75
|
-
updateVersionOnHistory: (id: string) => void;
|
|
76
|
-
updateItemsByVersionChange(updateLocation?: boolean, currentItemId?: string): void;
|
|
77
|
-
buildRenderItems(idx: number): ExtendedMenuItem[];
|
|
78
|
-
/**
|
|
79
|
-
* activate menu item
|
|
80
|
-
* @param item item to activate
|
|
81
|
-
* @param updateLocation [true] whether to update location
|
|
82
|
-
* @param rewriteHistory [false] whether to rewrite browser history (do not create new entry)
|
|
83
|
-
* @param fieldFullPath
|
|
84
|
-
*/
|
|
85
|
-
activateBase(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean, fieldFullPath?: string): void;
|
|
86
|
-
activate(item: ExtendedMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean, scroll?: boolean, fieldFullPath?: string): void;
|
|
87
|
-
/**
|
|
88
|
-
* update active items on scroll
|
|
89
|
-
* @param isScrolledDown whether last scroll was downside
|
|
90
|
-
*/
|
|
91
|
-
updateOnScroll: (isScrolledDown: boolean) => void;
|
|
92
|
-
activateField(pathArr: string[], schema?: SchemaModel): void;
|
|
93
|
-
/**
|
|
94
|
-
* makes item and all the parents not active
|
|
95
|
-
* @param item item to deactivate
|
|
96
|
-
*/
|
|
97
|
-
deactivate(item: IMenuItem | undefined): void;
|
|
98
|
-
/**
|
|
99
|
-
* activate menu item and scroll to it
|
|
100
|
-
* @see MenuStore.activate
|
|
101
|
-
*/
|
|
102
|
-
activateAndScroll(item?: IMenuItem | ExtendedMenuItem, updateLocation?: boolean, rewriteHistory?: boolean, currentId?: string): void;
|
|
103
|
-
/**
|
|
104
|
-
* scrolls to active section
|
|
105
|
-
*/
|
|
106
|
-
scrollToActive(fieldPath?: string): void;
|
|
107
|
-
dispose(): void;
|
|
108
|
-
}
|
package/lib/services/ProMenu.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var __decorate=this&&this.__decorate||function(e,t,i,s){var n,o=arguments.length,r=o<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)r=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(n=e[a])&&(r=(o<3?n(r):o>3?n(t,i,r):n(t,i))||r);return o>3&&r&&Object.defineProperty(t,i,r),r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ProMenu=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),constants_1=require("../constants"),history_1=require("./history"),VersionedSpecStore_1=require("./VersionedSpecStore");class ProMenu{static updateOnHistory(e=history_1.history.currentId,t){e&&t.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(e)}"]`)}constructor(e,t,i,s){Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"history",{enumerable:!0,configurable:!0,writable:!0,value:s}),Object.defineProperty(this,"flatItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeRenderItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"renderItems",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"activeItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"sideBarOpened",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"_unsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_hashUnsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"getItemById",{enumerable:!0,configurable:!0,writable:!0,value:e=>this.flatItems.find((t=>t.id===e))}),Object.defineProperty(this,"initOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i&&(this.activate(i,!1,!1,!1,e),i.active=!1)}}),Object.defineProperty(this,"updateOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i?this.activateAndScroll(i,!1,void 0,e):(this.scroll.prevOffsetY=0,this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t)}"]`))}}),Object.defineProperty(this,"updateVersionOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:e=>{if(!("versionsInfo"in this.definition))return;const[t]=e.split("/");let i=this.definition.versionsInfo.findIndex((e=>e.id===t));i<0&&(i=this.definition.versionsInfo.findIndex((e=>e.isDefault))),this.definition.activeVersionIdx!==i&&(this.definition.changeVersion(i<0?0:i),this.updateItemsByVersionChange(!1,e))}}),Object.defineProperty(this,"updateOnScroll",{enumerable:!0,configurable:!0,writable:!0,value:e=>{const t=e?1:-1;let i=this.activeItemIdx;for(;(-1!==i||e)&&!(i>=this.flatItems.length-1&&e);){if(e){let e=!1;const t=this.flatItems[i+1];switch(this.options.pagination){case"section":e=t&&("spec"===t.type||"group"===t.type||"tag"===t.type);break;case"item":e="section"!==(null==t?void 0:t.type)}const s=this.getElementAt(i+1);if(-1===i&&"tag"===this.flatItems[0].type&&(e=!1),this.scroll.isElementBellow(s)||e)break}else{const e=this.flatItems[i]&&this.flatItems[i].type,t="section"===this.options.pagination&&("spec"===e||"group"===e||"tag"===e)||"item"===this.options.pagination&&"section"!==e,s=this.getElementAt(i);if(this.scroll.isElementAbove(s)||t)break}i+=t}const s=this.flatItems[i];"none"===this.options.pagination||"section"===this.options.pagination?s&&s.active||this.activate(s,!0,!0,!1):s&&"section"===s.type&&(s.active||this.activate(s,!0,!0,!1))}}),(0,mobx_1.makeObservable)(this),this.items=e.contentItems,this.flatItems=(0,utils_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>e.absoluteIdx=t)),i.disableSidebar||this.subscribe(),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,i.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history))),this.renderItems=this.buildRenderItems(0),this.activeItemIdx=-1,this.activeRenderItemIdx=-1,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.subscribe(this.updateVersionOnHistory)}subscribe(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)}toggleSidebar(){this.sideBarOpened=!this.sideBarOpened}closeSidebar(){this.sideBarOpened=!1}getElementAt(e){const t=this.flatItems[e];return t&&(0,utils_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t.id)}"]`)||null}getElementAtOrFirstChild(e){let t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&(0,utils_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t.id)}"]`)||null}get activeItem(){return this.flatItems[this.activeItemIdx]||void 0}updateItemsByVersionChange(e,t){if(!("versionsInfo"in this.definition))return;const i=this.activeItem&&this.activeItem.active?this.activeItem.absoluteIdx:-1;t=t&&withoutVersion(t)||this.activeItem&&this.activeItem.active&&withoutVersion(this.activeItem.id)||"",this.deactivate(this.activeItem),this.items=this.definition.contentItems,this.flatItems=(0,utils_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,this.options.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history)));const s=t?(this.flatItems.find((e=>withoutVersion(e.id)===t))||{absoluteIdx:-1}).absoluteIdx:-1;if(-1!==s&&"none"!==this.options.pagination||(this.renderItems=this.buildRenderItems(0)),this.activeItemIdx=-1,-1!==s)this.activate(this.flatItems[s],e);else if(-1!==i)this.activateAndScroll(this.flatItems[0],e);else if(e){const e=this.definition.versionsInfo[this.definition.activeVersionIdx];if(!this.history.currentId&&e.isDefault)return;this.history.replace(e.id)}}buildRenderItems(e){if("none"===this.options.pagination)return this.items;let t=this.flatItems[e];if(t||(t=this.flatItems[0]),"spec"===t.type)return this.buildRenderItems(e+1);if("section"===t.type){const e=[],i=getParentOfType(t,"tag");if("section"===this.options.pagination&&i)return[i];if("item"===this.options.pagination&&i)return[Object.assign(Object.assign({},i),{items:getLeadingSectionItems(i)})];const s=getParentSpecItem(t),n=(null==s?void 0:s.items)||this.items;for(let t=0;t<n.length&&"section"===n[t].type;t++)e.push(n[t]);return e}switch(this.options.pagination){case"section":if(("operation"===t.type||"schema"===t.type)&&t.parent)return[t.parent];if("group"!==t.type)return[t];case"item":return"operation"===t.type||"schema"===t.type?[t]:[Object.assign(Object.assign({},t),{items:getLeadingSectionItems(t)})];default:return[]}}activateBase(e,t=!0,i=!1,s){var n,o,r,a,l;if((null===(n=this.activeItem)||void 0===n?void 0:n.id)===(null==e?void 0:e.id)&&!s)return t&&e&&this.history.replace(encodeURI(e.id),i),void(e&&!e.active&&e.activate());if(e&&"group"===e.type)return;if(this.deactivate(this.activeItem),!e)return void this.history.replace("",i);if(e.depth<=constants_1.GROUP_DEPTH)return;this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(encodeURI(e.id),i),e.activate(),e.expand();const c=new URLSearchParams(s),d="request"===c.get("t"),u="response"===c.get("t"),h=c.get("c"),p=c.get("ct"),f=c.get("in"),m=c.get("path"),v=(null==m?void 0:m.split(this.options.deepLinkSeparator))||[],b=e;if(f){let e=b.parameters;for(const t of v){const i=null==e?void 0:e.find((e=>e.name===t));null==i||i.expand(),e=null===(o=null==i?void 0:i.schema)||void 0===o?void 0:o.fields}}else if(d){const e=null===(r=b.requestBody)||void 0===r?void 0:r.content;null===(a=b.activateMimeName)||void 0===a||a.call(b,p||b.activeMimeName),setTimeout((()=>{var t;return this.activateField(v,null===(t=null==e?void 0:e.active)||void 0===t?void 0:t.schema)}),0)}else if(u){const e=b.responses.find((e=>e.code===h));(null==e?void 0:e.expanded)||null==e||e.expand(),null===(l=b.activateMimeName)||void 0===l||l.call(b,p||b.activeMimeName),setTimeout((()=>{var t,i;return this.activateField(v,null===(i=null===(t=null==e?void 0:e.content)||void 0===t?void 0:t.active)||void 0===i?void 0:i.schema)}),0)}}activate(e,t=!0,i=!1,s=!0,n){if("none"===this.options.pagination)return this.activateBase(e,t,i,n),void(!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0));if("group"!==(null==e?void 0:e.type)){if(e&&"item"===this.options.pagination&&"tag"===e.type&&!e.description){if(e.expanded)return void e.collapse();e.expand(),e=this.flatItems[e.absoluteIdx+1]}if(this.activateBase(e,e&&t,i,n),this.activeRenderItemIdx=e?e.absoluteIdx:this.activeRenderItemIdx,this.activeRenderItemIdx>=0){const e=this.buildRenderItems(this.activeRenderItemIdx);e.some(((e,t)=>e.id!==this.renderItems[t].id))&&(this.renderItems=e),this.renderItems[0]&&(this.activeRenderItemIdx=this.renderItems[0].absoluteIdx)}s&&setTimeout((()=>this.scrollToActive())),!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0)}}activateField(e,t){var i;for(let s=0;s<e.length-1;s++){const n=e[s],o=s===e.length-1;if((null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items),null==t?void 0:t.oneOf){const e=Number(n);if(isNaN(e))return;null==t||t.activateOneOf(e),t=null==t?void 0:t.oneOf[e];continue}(null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items);const r=null===(i=null==t?void 0:t.fields)||void 0===i?void 0:i.find((e=>e.name===n));o||null==r||r.expand(),t=null==r?void 0:r.schema}}deactivate(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent}activateAndScroll(e,t,i,s=""){const[,n]=s.split(this.options.deepLinkPrefix),o=e&&this.getItemById(e.id)||e;this.activate(o,t,i,!1,n),this.scrollToActive(n?s:""),o&&o.items.length||this.closeSidebar()}scrollToActive(e){e?setTimeout((()=>this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(e)}"]`)),0):this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))}dispose(){var e,t;null===(e=this._unsubscribe)||void 0===e||e.call(this),null===(t=this._hashUnsubscribe)||void 0===t||t.call(this)}}function withoutVersion(e){return e.split("/").slice(1).join("/")}function getParentSpecItem(e){for(;e;){if("spec"===e.type)return e;e=e.parent}}function getParentOfType(e,t){if(e&&e.parent)return e.parent.type===t?e.parent:getParentOfType(e.parent,t)}function getLeadingSectionItems(e){const t=[];for(const i of e.items){if("section"!==i.type)break;t.push(i)}return t}function normalizeItem(e,t,i,s,n){if(e.absoluteIdx=t,"none"!==i){const t=getParentOfType(e,"tag");if(e.parent&&t&&!("_id_normalized"in e)){if(s){const[i,s]=e.id.split("/"),n=withoutVersion(e.id);if("operation"===e.type&&!s.startsWith("operation"))return;e.id=i+"/"+withoutVersion(t.id)+"/"+n}else{if("operation"===e.type&&!e.id.startsWith("operation"))return;e.id=t.id+"/"+e.id}e._id_normalized=!0}}"group"!==e.type&&(e.href=n.linkForId(e.id))}__decorate([mobx_1.observable],ProMenu.prototype,"flatItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"items",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeRenderItemIdx",void 0),__decorate([mobx_1.observable.ref],ProMenu.prototype,"renderItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeItemIdx",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"sideBarOpened",void 0),__decorate([mobx_1.action],ProMenu.prototype,"toggleSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"closeSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"activateBase",null),__decorate([mobx_1.action],ProMenu.prototype,"activate",null),__decorate([mobx_1.action.bound],ProMenu.prototype,"activateAndScroll",null),exports.ProMenu=ProMenu;
|
|
2
|
-
//# sourceMappingURL=ProMenu.js.map
|
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
import type { IValueDidChange } from 'mobx';
|
|
2
|
-
import type { IMenuItem } from '../services';
|
|
3
|
-
import type { LicenseInfo } from './check';
|
|
4
|
-
import type { SpecVersions } from './VersionedSpecStore';
|
|
5
|
-
import type { OpenAPIDefinition, OpenAPIExternalDocumentation } from '../types';
|
|
6
|
-
import type { OperationModel, ContentItemModel } from '../models';
|
|
7
|
-
import type { Options, RawOptions } from './Options/types';
|
|
8
|
-
import type { SearchResultMeta, SearchStore } from './search';
|
|
9
|
-
import { VersionedSpecStore } from './VersionedSpecStore';
|
|
10
|
-
import { SpecStore, MarkerService } from '../services';
|
|
11
|
-
import { LayoutVariant } from '../constants';
|
|
12
|
-
import { ProMenu } from './ProMenu';
|
|
13
|
-
export interface ProStoreState {
|
|
14
|
-
menu: {
|
|
15
|
-
activeItemIdx: number;
|
|
16
|
-
};
|
|
17
|
-
definition: {
|
|
18
|
-
url?: string;
|
|
19
|
-
data: GenericObject;
|
|
20
|
-
activeVersionIdx?: number;
|
|
21
|
-
};
|
|
22
|
-
searchIndex?: number;
|
|
23
|
-
tryItOperationId?: string;
|
|
24
|
-
options: RawOptions;
|
|
25
|
-
searchIndexPath?: string;
|
|
26
|
-
searchIndexExport?: string;
|
|
27
|
-
}
|
|
28
|
-
export declare class NestingGroup implements IMenuItem {
|
|
29
|
-
id: string;
|
|
30
|
-
absoluteIdx?: number;
|
|
31
|
-
name: string;
|
|
32
|
-
description?: string;
|
|
33
|
-
type: 'group';
|
|
34
|
-
linkable: boolean;
|
|
35
|
-
items: ContentItemModel[];
|
|
36
|
-
parent?: NestingGroup;
|
|
37
|
-
externalDocs?: OpenAPIExternalDocumentation;
|
|
38
|
-
active: boolean;
|
|
39
|
-
expanded: boolean;
|
|
40
|
-
depth: number;
|
|
41
|
-
level: number;
|
|
42
|
-
httpVerb?: string;
|
|
43
|
-
path?: string;
|
|
44
|
-
constructor(id: string, items: ContentItemModel[], name?: string, linkable?: boolean);
|
|
45
|
-
activate(): void;
|
|
46
|
-
expand(): void;
|
|
47
|
-
collapse(): void;
|
|
48
|
-
deactivate(): void;
|
|
49
|
-
}
|
|
50
|
-
export declare class ProStore {
|
|
51
|
-
rawOptions: RawOptions;
|
|
52
|
-
options: Options;
|
|
53
|
-
menu: ProMenu;
|
|
54
|
-
definition: SpecStore | VersionedSpecStore;
|
|
55
|
-
marker: MarkerService;
|
|
56
|
-
private readonly scroll;
|
|
57
|
-
private readonly disposer;
|
|
58
|
-
search?: SearchStore<SearchResultMeta>;
|
|
59
|
-
tryItOperation?: OperationModel;
|
|
60
|
-
showRightPanel: boolean;
|
|
61
|
-
layout: LayoutVariant;
|
|
62
|
-
activeSampleLanguage: string;
|
|
63
|
-
isLoading: boolean;
|
|
64
|
-
l: Promise<LicenseInfo>;
|
|
65
|
-
constructor(spec: OpenAPIDefinition | SpecVersions | Array<{
|
|
66
|
-
title: string;
|
|
67
|
-
url: string;
|
|
68
|
-
}> | string, specUrl?: string, options?: RawOptions, createIndex?: boolean);
|
|
69
|
-
initProOptions(options: RawOptions): void;
|
|
70
|
-
initSearch(options: Options, createIndex: boolean): void;
|
|
71
|
-
onDidMount(): void;
|
|
72
|
-
toggleRightPanel(value?: boolean): void;
|
|
73
|
-
toggleLayout(layout?: LayoutVariant): void;
|
|
74
|
-
disableConsole(): void;
|
|
75
|
-
enableConsole(): void;
|
|
76
|
-
tryItOut(operation?: OperationModel): void;
|
|
77
|
-
setActiveSampleLanguage(language: string): void;
|
|
78
|
-
activateSampleLanguage(language: string): void;
|
|
79
|
-
startLoader(): void;
|
|
80
|
-
stopLoader(): void;
|
|
81
|
-
dereferenceSpecForTryIt(operation: OperationModel): Promise<GenericObject>;
|
|
82
|
-
observeAllAndRemark(): void;
|
|
83
|
-
remark(change: IValueDidChange): void;
|
|
84
|
-
/**
|
|
85
|
-
* deserialize store
|
|
86
|
-
* **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
|
|
87
|
-
*/
|
|
88
|
-
static fromJS(state: ProStoreState): ProStore;
|
|
89
|
-
toJS(): Promise<ProStoreState>;
|
|
90
|
-
dispose(): void;
|
|
91
|
-
private updateMarkOnMenu;
|
|
92
|
-
}
|
package/lib/services/ProStore.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var __decorate=this&&this.__decorate||function(e,t,i,o){var r,n=arguments.length,a=n<3?t:null===o?o=Object.getOwnPropertyDescriptor(t,i):o;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)a=Reflect.decorate(e,t,i,o);else for(var s=e.length-1;s>=0;s--)(r=e[s])&&(a=(n<3?r(a):n>3?r(t,i,a):r(t,i))||a);return n>3&&a&&Object.defineProperty(t,i,a),a},__awaiter=this&&this.__awaiter||function(e,t,i,o){return new(i||(i=Promise))((function(r,n){function a(e){try{l(o.next(e))}catch(e){n(e)}}function s(e){try{l(o.throw(e))}catch(e){n(e)}}function l(e){var t;e.done?r(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(a,s)}l((o=o.apply(e,t||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ProStore=exports.NestingGroup=void 0;const mobx_1=require("mobx"),openapi_core_1=require("@redocly/openapi-core"),decko_1=require("decko"),SchemaDefinition_1=require("../components/SchemaDefinition/SchemaDefinition"),check_1=__importDefault(require("./check")),VersionedSpecStore_1=require("./VersionedSpecStore"),services_1=require("../services"),utils_1=require("../utils"),SecurityRequirement_1=require("../components/SecurityRequirement"),constants_1=require("../constants"),pluggable_1=require("../components/pluggable"),history_1=require("./history"),ProMenu_1=require("./ProMenu"),NormalizedOptions_1=require("./Options/NormalizedOptions"),search_1=require("./search"),global="undefined"==typeof window?{__REDOCLY_SEARCH_URL:void 0}:window;class NestingGroup{constructor(e,t,i,o){Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"linkable",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"level",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"httpVerb",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"path",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),(0,mobx_1.makeObservable)(this),this.id="section/"+e,this.type="nesting-group",this.name=i||"",this.level=1,this.depth=1,this.description="",this.parent=void 0,this.expanded=!1,this.items=t,this.linkable=!!o,t.forEach((e=>e.parent=this)),increaseDepthDeep(t)}activate(){this.active=!0}expand(){this.expanded=!0,this.parent&&this.parent.expand()}collapse(){this.expanded=!1}deactivate(){this.active=!1}}function increaseDepthDeep(e){Array.isArray(e)&&e.forEach((e=>{e.depth++,e.parent&&"group"===e.parent.type&&(e.depth=e.parent.depth),increaseDepthDeep(e.items)}))}__decorate([mobx_1.observable],NestingGroup.prototype,"active",void 0),__decorate([mobx_1.observable],NestingGroup.prototype,"expanded",void 0),__decorate([mobx_1.action],NestingGroup.prototype,"activate",null),__decorate([mobx_1.action],NestingGroup.prototype,"expand",null),__decorate([mobx_1.action],NestingGroup.prototype,"collapse",null),__decorate([mobx_1.action],NestingGroup.prototype,"deactivate",null),exports.NestingGroup=NestingGroup;class ProStore{constructor(e,t,i={},o=!0){Object.defineProperty(this,"rawOptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"menu",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"marker",{enumerable:!0,configurable:!0,writable:!0,value:new services_1.MarkerService}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"disposer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"search",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"tryItOperation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showRightPanel",{enumerable:!0,configurable:!0,writable:!0,value:!0}),Object.defineProperty(this,"layout",{enumerable:!0,configurable:!0,writable:!0,value:constants_1.LayoutVariant.THREE_PANEL}),Object.defineProperty(this,"activeSampleLanguage",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isLoading",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"l",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),(0,mobx_1.makeObservable)(this),this.initProOptions(i),utils_1.IS_BROWSER&&(this.l=(0,check_1.default)(i.licenseKey),this.l.then((e=>{e.valid&&e.allowed&&!e.expired||e.local||(this.menu.items=[],this.menu.flatItems=this.menu.flatItems.slice(0,1),this.menu.renderItems=[])})));const r="object"==typeof e&&"versions"in e,n=this.options.disableSidebar?new history_1.FakeHistoryService(this.options):"browser"===this.options.routingStrategy?new history_1.PushStateHistoryService(this.options,r):new history_1.ProHashHistoryService(this.options,r);this.definition=r?new VersionedSpecStore_1.VersionedSpecStore(e,this.options,n.currentId.split("/")[0]):new services_1.SpecStore(e,t,this.options),i.downloadDefinitionUrl&&(this.definition.info.downloadFileName=""),this.scroll=new services_1.ScrollService(this.options),this.options.disableSidebar||ProMenu_1.ProMenu.updateOnHistory(n.currentId,this.scroll),this.menu=new ProMenu_1.ProMenu(this.definition,this.scroll,this.options,n),this.menu.initOnHistory(),this.options.disableSearch||this.initSearch(this.options,o),this.disposer=(0,mobx_1.observe)(this.menu,"none"===this.options.pagination?"activeItemIdx":"activeRenderItemIdx",(e=>{setTimeout((()=>this.updateMarkOnMenu(e.newValue)))})),(0,utils_1.setGlobalStore)(this)}initProOptions(e){e=deepClone(e),this.rawOptions=e,this.options=(0,NormalizedOptions_1.NormalizedOptions)(this.rawOptions,DEFAULT_OPTIONS)}initSearch(e,t){global.__REDOCLY_SEARCH_URL?this.search=new search_1.RemoteSearch(global.__REDOCLY_SEARCH_URL):this.search=new search_1.DeepSearchStore(e),t&&setTimeout((()=>{var e;return null===(e=this.search)||void 0===e?void 0:e.indexItems(this.menu.items)}),50),this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&(0,mobx_1.observe)(this.definition,"activeVersionIdx",(t=>{var i,o;const r=this.definition;null===(i=this.search)||void 0===i||i.dispose(),this.search=new search_1.DeepSearchStore(e);const n=r.versions[t.newValue]._searchIndexName;if(utils_1.IS_BROWSER&&n){const e=r.versions[t.newValue]._searchIndexName,i=new URL(window.location.href);i.pathname=joinURLs(this.options.routingBasePath,e),null===(o=this.search)||void 0===o||o.fromExternalJS(i.toString(),__redoc_state.searchIndexExport),this.observeAllAndRemark()}else setTimeout((()=>{var e;null===(e=this.search)||void 0===e||e.indexItems(this.menu.items)}),0)})),utils_1.IS_BROWSER&&this.observeAllAndRemark()}onDidMount(){if(this.menu.updateOnHistory(),this.updateMarkOnMenu(this.menu.activeItemIdx),this.layout=(0,utils_1.fromLocalStorage)("layoutVariant")||this.options.layout||this.layout,this.activeSampleLanguage=(0,utils_1.fromLocalStorage)("activeSampleLanguage")||this.options.defaultSampleLanguage,this.options.showRightPanelToggle){const e=(0,utils_1.fromSessionStorage)("showRightPanelToggleState");e&&(this.showRightPanel="true"===e)}}toggleRightPanel(e){this.showRightPanel=null!=e?e:!this.showRightPanel,(0,utils_1.toSessionStorage)("showRightPanelToggleState",JSON.stringify(this.showRightPanel))}toggleLayout(e=constants_1.LayoutVariant.THREE_PANEL){this.layout=e,(0,utils_1.toLocalStorage)("layoutVariant",e)}disableConsole(){this.options.showConsole=!1}enableConsole(){this.options.showConsole=!0}tryItOut(e){this.tryItOperation=e}setActiveSampleLanguage(e){if(this.activeSampleLanguage===e)return this.stopLoader();this.activeSampleLanguage=e,(0,utils_1.toLocalStorage)("activeSampleLanguage",e)}activateSampleLanguage(e){this.setActiveSampleLanguage(e)}startLoader(){this.isLoading||(this.isLoading=!0)}stopLoader(){this.isLoading&&(this.isLoading=!1)}dereferenceSpecForTryIt(e){var t,i,o,r;return __awaiter(this,void 0,void 0,(function*(){const n=this.definition.parser.definition,a=JSON.parse(JSON.stringify(n)),s=Object.assign(Object.assign({},getSpecVersionObj(a)),{components:a.components,paths:{[e.path]:{[e.httpVerb]:null===(i=null===(t=a.paths)||void 0===t?void 0:t[e.path])||void 0===i?void 0:i[e.httpVerb],parameters:null===(r=null===(o=a.paths)||void 0===o?void 0:o[e.path])||void 0===r?void 0:r.parameters}}}),l={config:new openapi_core_1.Config({}),doc:(0,utils_1.createParsedDocument)(s),dereference:!0};return yield(0,openapi_core_1.bundle)(l),a}))}observeAllAndRemark(){const e=t=>{for(const i of t)if("operation"===i.type){const e=i.responses;for(const t of e)(0,mobx_1.observe)(t,"expanded",(e=>this.remark(e)))}else"tag"===i.type&&e(i.items||[])};e(this.menu.renderItems),"none"!==this.options.pagination&&(0,mobx_1.observe)(this.menu,"renderItems",(()=>e(this.menu.renderItems)))}remark(e){e.newValue&&setTimeout((()=>this.marker.mark()),0)}static fromJS(e){var t;const i=new ProStore(e.definition.data,e.definition.url,e.options,!1);(0,utils_1.setGlobalStore)(i),i.menu.activeItemIdx=void 0!==e.menu.activeItemIdx?e.menu.activeItemIdx:-1,i.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&e.definition.activeVersionIdx&&(i.definition.activeVersionIdx=e.definition.activeVersionIdx||0);const o=i.menu.flatItems[i.menu.activeItemIdx];if(o&&i.menu.activate(o,!1),!i.options.disableSearch){const o=new URL(window.location.href);o.pathname=e.searchIndexPath&&e.searchIndexPath.startsWith("/")?e.searchIndexPath:o.pathname+(o.pathname.endsWith("/")?"":"/")+e.searchIndexPath,null===(t=i.search)||void 0===t||t.fromExternalJS(o.toString(),e.searchIndexExport)}return e.tryItOperationId&&(i.tryItOperation=i.menu.flatItems.find((t=>t.id===e.tryItOperationId))),setTimeout((()=>i.observeAllAndRemark()),0),i}toJS(){var e;return __awaiter(this,void 0,void 0,(function*(){return{menu:{activeItemIdx:this.menu.activeItemIdx},definition:this.definition instanceof VersionedSpecStore_1.VersionedSpecStore?{url:void 0,data:this.definition.toJS()}:{url:this.definition.parser.definitionUrl,data:this.definition.parser.definition},searchIndex:this.search?yield this.search.toJS():void 0,options:this.rawOptions,tryItOperationId:null===(e=this.tryItOperation)||void 0===e?void 0:e.id}}))}dispose(){this.scroll.dispose(),this.menu.dispose(),this.search&&this.search.dispose(),this.disposer()}updateMarkOnMenu(e){const t=Math.max(0,e),i=Math.min(this.menu.flatItems.length,t+5),o=[];for(let e=t;e<i;e++){const t=this.menu.getElementAt(e);t&&(t&&o.push(t))}if("item"===this.options.pagination){const{parent:t}=this.menu.flatItems[e]||{};if(null==t?void 0:t.absoluteIdx){const e=this.menu.getElementAt(t.absoluteIdx);e&&o.push(e)}}this.marker.addOnly(o),this.marker.mark()}}__decorate([mobx_1.observable],ProStore.prototype,"search",void 0),__decorate([mobx_1.observable],ProStore.prototype,"tryItOperation",void 0),__decorate([mobx_1.observable],ProStore.prototype,"showRightPanel",void 0),__decorate([mobx_1.observable],ProStore.prototype,"layout",void 0),__decorate([mobx_1.observable],ProStore.prototype,"activeSampleLanguage",void 0),__decorate([mobx_1.observable],ProStore.prototype,"isLoading",void 0),__decorate([mobx_1.action],ProStore.prototype,"onDidMount",null),__decorate([mobx_1.action],ProStore.prototype,"toggleRightPanel",null),__decorate([mobx_1.action],ProStore.prototype,"toggleLayout",null),__decorate([mobx_1.action],ProStore.prototype,"disableConsole",null),__decorate([mobx_1.action],ProStore.prototype,"enableConsole",null),__decorate([mobx_1.action],ProStore.prototype,"tryItOut",null),__decorate([mobx_1.action],ProStore.prototype,"setActiveSampleLanguage",null),__decorate([decko_1.bind,(0,decko_1.debounce)(500)],ProStore.prototype,"activateSampleLanguage",null),__decorate([mobx_1.action],ProStore.prototype,"startLoader",null),__decorate([mobx_1.action],ProStore.prototype,"stopLoader",null),exports.ProStore=ProStore;const DEFAULT_OPTIONS={ignoreNamedSchemas:["java.io.ObjectStreamField"],breakpoints:constants_1.defaultTheme.breakpoints,showAtBreakpoint:constants_1.defaultTheme.showAtBreakpoint,allowedMdComponents:{RedocResponse:{component:pluggable_1.RedocResponse,propsSelector:e=>({store:e})},PullRight:{component:pluggable_1.PullRight,propsSelector:()=>({})},[utils_1.SCHEMA_DEFINITION_JSX_NAME]:{component:SchemaDefinition_1.SchemaDefinition,propsSelector:e=>({parser:e.definition.parser,options:e.options,layout:e.layout,showRightPanel:e.showRightPanel})},[utils_1.SECURITY_DEFINITIONS_COMPONENT_NAME]:{component:SecurityRequirement_1.SecurityDefs,propsSelector:e=>({securitySchemes:e.definition.securitySchemes})},[utils_1.SECURITY_DEFINITIONS_JSX_NAME]:{component:SecurityRequirement_1.SecurityDefs,propsSelector:e=>({securitySchemes:e.definition.securitySchemes})}}};function joinURLs(e,t){return e.endsWith("/")&&(e=e.slice(0,-1)),t.startsWith("/")&&(t=t.substring(1)),`${e}/${t}`}function getSpecVersionObj(e){return e.openapi?{openapi:e.openapi}:e.swagger?{swagger:e.swagger}:void 0}function deepClone(e){if("object"!=typeof e||null===e)return e;const t=Array.isArray(e)?[]:{};for(const i in e){const o=e[i];t[i]=deepClone(o)}return t}
|
|
2
|
-
//# sourceMappingURL=ProStore.js.map
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import type { Options } from 'src/services/Options';
|
|
2
|
-
export declare class ScrollService {
|
|
3
|
-
private options;
|
|
4
|
-
private readonly _scrollParent;
|
|
5
|
-
private _emitter;
|
|
6
|
-
private _prevOffsetY;
|
|
7
|
-
constructor(options: Options);
|
|
8
|
-
set prevOffsetY(prevOffsetY: number);
|
|
9
|
-
bind(): void;
|
|
10
|
-
dispose(): void;
|
|
11
|
-
scrollY(): number;
|
|
12
|
-
isElementBellow(el: Element | null): boolean | void;
|
|
13
|
-
isElementAbove(el: Element | null): boolean | void;
|
|
14
|
-
subscribe(cb: (...args: any[]) => void): () => void;
|
|
15
|
-
scrollIntoView(element: Element | null, options?: ScrollIntoViewOptions): void;
|
|
16
|
-
scrollIntoViewBySelector(selector: string, options?: ScrollIntoViewOptions): void;
|
|
17
|
-
handleScroll(): void;
|
|
18
|
-
}
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var __decorate=this&&this.__decorate||function(e,t,r,l){var o,i=arguments.length,s=i<3?t:null===l?l=Object.getOwnPropertyDescriptor(t,r):l;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(e,t,r,l);else for(var n=e.length-1;n>=0;n--)(o=e[n])&&(s=(i<3?o(s):i>3?o(t,r,s):o(t,r))||s);return i>3&&s&&Object.defineProperty(t,r,s),s},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ScrollService=void 0;const decko_1=require("decko"),eventemitter3_1=__importDefault(require("eventemitter3")),utils_1=require("../utils"),EVENT="scroll";class ScrollService{constructor(e){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"_scrollParent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_emitter",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_prevOffsetY",{enumerable:!0,configurable:!0,writable:!0,value:0}),this._scrollParent=utils_1.IS_BROWSER?window:void 0,this._emitter=new eventemitter3_1.default,this.bind()}set prevOffsetY(e){this._prevOffsetY=e}bind(){this._prevOffsetY=this.scrollY(),this._scrollParent&&this._scrollParent.addEventListener(EVENT,this.handleScroll)}dispose(){this._scrollParent&&this._scrollParent.removeEventListener(EVENT,this.handleScroll),this._emitter.removeAllListeners(EVENT)}scrollY(){return"undefined"!=typeof HTMLElement&&this._scrollParent instanceof HTMLElement?this._scrollParent.scrollTop:void 0!==this._scrollParent?this._scrollParent.pageYOffset:0}isElementBellow(e){if(null!==e)return e.getBoundingClientRect().top>this.options.scrollYOffset()}isElementAbove(e){if(null===e)return;const t=e.getBoundingClientRect().top;return(t>0?Math.floor(t):Math.ceil(t))<=this.options.scrollYOffset()}subscribe(e){const t=this._emitter.addListener(EVENT,e);return()=>t.removeListener(EVENT,e)}scrollIntoView(e,t){if(null!==e&&(e.scrollIntoView(t),this._scrollParent&&this._scrollParent.scrollBy)){const[e,t]=[0,-Math.floor(this.options.scrollYOffset())];this._scrollParent.scrollBy(e,t)}}scrollIntoViewBySelector(e,t){const r=(0,utils_1.querySelector)(e);this.scrollIntoView(r,t)}handleScroll(){const e=this.scrollY()-this._prevOffsetY>0;this._prevOffsetY=this.scrollY(),this._emitter.emit(EVENT,e)}}__decorate([decko_1.bind,(0,utils_1.Throttle)(100)],ScrollService.prototype,"handleScroll",null),exports.ScrollService=ScrollService;
|
|
2
|
-
//# sourceMappingURL=ScrollService.js.map
|