@redocly/openapi-docs 3.0.0-alpha.13 → 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 +11 -15
- 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 -6187
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +0 -358
- package/dist/console.redocly-reference-docs.min.js +0 -507
- package/dist/redocly-reference-docs.min.js +0 -6289
- 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
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __rest=this&&this.__rest||function(e,t){var r={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(r[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var
|
|
1
|
+
"use strict";var __rest=this&&this.__rest||function(e,t){var r={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(r[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(i=Object.getOwnPropertySymbols(e);n<i.length;n++)t.indexOf(i[n])<0&&Object.prototype.propertyIsEnumerable.call(e,i[n])&&(r[i[n]]=e[i[n]])}return r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.OpenAPIParser=exports.concatRefStacks=exports.pushRef=void 0;const utils_1=require("../utils"),JsonPointer_1=require("../utils/JsonPointer"),normalizeOptions_1=require("./Options/normalizeOptions");function pushRef(e,t){return t&&e[e.length-1]!==t?[...e,t]:e}function concatRefStacks(e,t){return t?e.concat(t):e}exports.pushRef=pushRef,exports.concatRefStacks=concatRefStacks;class OpenAPIParser{constructor(e,t,r=(0,normalizeOptions_1.normalizeOptions)({})){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"definitionUrl",{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,"allowMergeRefs",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"byRef",{enumerable:!0,configurable:!0,writable:!0,value:e=>{let t;if(this.definition){"#"!==e.charAt(0)&&(e="#"+e),e=decodeURIComponent(e);try{t=JsonPointer_1.JsonPointer.get(this.definition,e)}catch(e){}return t||{}}}}),this.validate(e),this.preprocess(e),this.definition=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const i=utils_1.IS_BROWSER?window.location.href:"";"string"==typeof t&&(this.definitionUrl=new URL(t,i).href)}validate(e){if(void 0===e.openapi)throw new Error("Document must be valid OpenAPI 3.0.0 definition")}preprocess(e){e.info&&this.options.hideInfoDescription&&(e.info.description="")}isRef(e){return!!e&&(void 0!==e.$ref&&null!==e.$ref)}deref(e,t=[],r=!1){const i=null==e?void 0:e["x-refsStack"];if(t=concatRefStacks(t,i),this.isRef(e)){const i=(0,utils_1.getDefinitionName)(e.$ref);if(i&&this.options.ignoreNamedSchemas.has(i))return{resolved:{type:"object",title:i},refsStack:t};let n=this.byRef(e.$ref);if(!n)throw new Error(`Failed to resolve $ref "${e.$ref}"`);let s=t;if(t.includes(e.$ref))n=Object.assign({},n,{"x-circular-ref":!0});else if(this.isRef(n)){const e=this.deref(n,t,r);s=e.refsStack,n=e.resolved}return s=pushRef(t,e.$ref),n=this.allowMergeRefs?this.mergeRefs(e,n,r):n,{resolved:n,refsStack:s}}return{resolved:e,refsStack:concatRefStacks(t,i)}}mergeRefs(e,t,r){const{$ref:i}=e,n=__rest(e,["$ref"]),s=Object.keys(n);if(0===s.length)return t;if(r&&s.some((e=>!["description","title","externalDocs","x-refsStack","x-parentRefs","readOnly","writeOnly"].includes(e)))){const e=n,{description:r,title:i,readOnly:s,writeOnly:o}=e;return{allOf:[{description:r,title:i,readOnly:s,writeOnly:o},t,__rest(e,["description","title","readOnly","writeOnly"])]}}return Object.assign(Object.assign({},t),n)}mergeAllOf(e,t,r,i=""){var n;if(e["x-circular-ref"])return e;if(void 0===(e=this.hoistOneOfs(e)).allOf)return Object.assign({absolutePointer:i},e);let s=Object.assign(Object.assign({},e),{"x-parentRefs":[],absolutePointer:JsonPointer_1.JsonPointer.join(i,["allOf"]),allOf:void 0,title:e.title||(0,utils_1.getDefinitionName)(t)});void 0!==s.properties&&"object"==typeof s.properties&&(s.properties=Object.assign({},s.properties)),void 0!==s.items&&"object"==typeof s.items&&(s.items=Object.assign({},s.items));const o=e.allOf.map(((e,t)=>{var n;const{resolved:o,refsStack:a}=this.deref(e,r,!0),l=e.$ref,f=l||JsonPointer_1.JsonPointer.join(i,[String(t)]),c=this.mergeAllOf(o,l,a,f);if(!c["x-circular-ref"]||!c.allOf)return l&&(null===(n=s["x-parentRefs"])||void 0===n||n.push(...c["x-parentRefs"]||[],l)),{$ref:l,refsStack:pushRef(a,l),schema:c,absolutePointer:f}})).filter((e=>void 0!==e));for(const[e,{schema:r,refsStack:i,absolutePointer:a}]of o.entries()){const{type:o,enum:l,properties:f,items:c,required:p,title:d,description:O,readOnly:u,writeOnly:y,oneOf:b,anyOf:h,"x-circular-ref":m}=r,v=__rest(r,["type","enum","properties","items","required","title","description","readOnly","writeOnly","oneOf","anyOf","x-circular-ref"]);if(s.type!==o&&void 0!==s.type&&void 0!==o&&console.warn(`Incompatible types in allOf at "${t}": "${s.type}" and "${o}"`),void 0!==o&&(Array.isArray(o)&&Array.isArray(s.type)?s.type=[...o,...s.type]:s.type=o),void 0!==l&&(Array.isArray(l)&&Array.isArray(s.enum)?s.enum=Array.from(new Set([...l,...s.enum])):s.enum=l),void 0!==f&&"object"==typeof f){s.properties=s.properties||{};for(const r in f){const o=concatRefStacks(i,null===(n=f[r])||void 0===n?void 0:n["x-refsStack"]);if(s.properties[r]){if(!m){const i=this.mergeAllOf({allOf:[s.properties[r],f[r]],"x-refsStack":o},t+"/properties/"+r,o,JsonPointer_1.JsonPointer.join(a,["allOf",String(e),"properties",r]));s.properties[r]=i}}else s.properties[r]=Object.assign(Object.assign({},f[r]),{absolutePointer:JsonPointer_1.JsonPointer.join(a,["properties",r]),"x-refsStack":o})}}if(void 0!==c&&!m){const e="boolean"==typeof s.items?{}:Object.assign({},s.items),n="boolean"==typeof r.items?{}:Object.assign({},r.items);s.items=this.mergeAllOf({allOf:[e,n]},t+"/items",i)}void 0!==b&&(s.oneOf=b),void 0!==h&&(s.anyOf=h),void 0!==p&&(s.required=[...s.required||[],...p]),s=Object.assign(Object.assign(Object.assign({},s),{title:s.title||d,description:s.description||O,readOnly:void 0!==s.readOnly?s.readOnly:u,writeOnly:void 0!==s.writeOnly?s.writeOnly:y,"x-circular-ref":s["x-circular-ref"]||m}),v)}return s}findDerived(e){const t={},r=this.definition.components&&this.definition.components.schemas||{};for(const i in r){const{resolved:n}=this.deref(r[i]);void 0!==n.allOf&&n.allOf.find((t=>void 0!==t.$ref&&e.indexOf(t.$ref)>-1))&&(t["#/components/schemas/"+i]=[n["x-discriminator-value"]||i])}return t}hoistOneOfs(e){if(void 0===e.allOf)return e;const t=e.allOf;for(let e=0;e<t.length;e++){const r=t[e];if(Array.isArray(r.oneOf)){const i=t.slice(0,e),n=t.slice(e+1);return{oneOf:r.oneOf.map((e=>({allOf:[...i,e,...n]})))}}}return e}}exports.OpenAPIParser=OpenAPIParser;
|
|
2
2
|
//# sourceMappingURL=OpenAPIParser.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './
|
|
1
|
+
export * from './normalizeOptions';
|
|
2
2
|
export * from './types';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./normalizeOptions"),exports),__exportStar(require("./types"),exports);
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { Options, RawOptions } from './types';
|
|
2
|
-
export declare function
|
|
2
|
+
export declare function normalizeOptions(raw?: RawOptions, defaultOptions?: RawOptions): Options;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=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 normalizeOptions(e,a){var o,l,n,i,s,t,r,u,d,g,p,h;e=Object.assign(Object.assign(Object.assign({},a),e),{allowedMdComponents:Object.assign(Object.assign({},null==e?void 0:e.allowedMdComponents),{components:Object.assign(Object.assign({},null===(o=null==a?void 0:a.allowedMdComponents)||void 0===o?void 0:o.components),null===(l=null==e?void 0:e.allowedMdComponents)||void 0===l?void 0:l.components),tags:Object.assign(Object.assign({},null===(n=null==a?void 0:a.allowedMdComponents)||void 0===n?void 0:n.tags),null===(i=null==e?void 0:e.allowedMdComponents)||void 0===i?void 0:i.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(s=null==a?void 0:a.allowedMdComponents)||void 0===s?void 0:s.nodes),null===(t=null==e?void 0:e.allowedMdComponents)||void 0===t?void 0:t.nodes),{heading:(null===(u=null===(r=null==a?void 0:a.allowedMdComponents)||void 0===r?void 0:r.nodes)||void 0===u?void 0:u.heading)||(null===(d=null==e?void 0:e.allowedMdComponents)||void 0===d?void 0:d.nodes.heading)})})});const c=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(g=e.ignoreNamedSchemas)||void 0===g?void 0:g.split(",").map((e=>e.trim())),m={downloadDefinitionUrl:e.downloadDefinitionUrl,schemaDefinitionsTagName:e.schemaDefinitionsTagName,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===(p=e.mockServer)||void 0===p?void 0:p.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:(0,utils_1.isUndefined)(e.enableRouter)?"":e.routingBasePath&&(0,utils_2.normalizePath)(e.routingBasePath)||"",schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),pagination:e.pagination||types_2.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===(h=e.showConsole)||void 0===h||h,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),skipBundleAndConvert:(0,utils_1.argValueToBoolean)(e.skipBundleAndConvert),disablePaginationLoadingAnimation:(0,utils_1.argValueToBoolean)(!!e.disablePaginationLoadingAnimation),disableErrorBoundary:(0,utils_1.argValueToBoolean)(e.disableErrorBoundary),ignoreNamedSchemas:new Set(c),mediaQueries:(0,theme_1.generateMediaQueries)((null==e?void 0:e.breakpoints)||{}),showAtBreakpoint:e.showAtBreakpoint,allowedMdComponents:null==e?void 0:e.allowedMdComponents,defaultSampleLanguage:e.defaultSampleLanguage||"",generateCodeSamples:e.generateCodeSamples||{languages:[]},layout:e.layout||constants_1.LayoutVariant.THREE_PANEL,sideNavStyle:e.sideNavStyle||types_2.SideNavStyle.SummaryOnly,searchMode:e.searchMode||types_1.SearchMode.Default,sidebarLinks:e.sidebarLinks||{},events:e.events||{},hooks:e.hooks||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_tryItButtonOverride:e.unstable_tryItButtonOverride||null,unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],markdownItemsPagination:e.markdownItemsPagination||"none"};return null!=e.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.'),m.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||m.pagination===types_2.Pagination.None,m}exports.normalizeOptions=normalizeOptions;
|
|
2
|
+
//# sourceMappingURL=normalizeOptions.js.map
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import type React from 'react';
|
|
2
|
+
import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
|
|
1
3
|
import type { LayoutVariant } from 'src/constants';
|
|
2
4
|
import type { CodeSamplesConfig, Languages } from '../code-samples';
|
|
3
|
-
import type { ExternalLink, HooksConfig, MarkdownItemsPagination,
|
|
5
|
+
import type { ExternalLink, HooksConfig, MarkdownItemsPagination, Pagination, SideNavStyle, Unstable_ExternalCodeSample, PaginationType } from '../types';
|
|
4
6
|
import type { Events } from '../../events';
|
|
5
7
|
import type { MediaQueries } from '@redocly/theme';
|
|
6
|
-
import type { OperationModel } from '
|
|
8
|
+
import type { OperationModel } from '../../models/types';
|
|
7
9
|
import type { LabelsConfigRaw } from '../labels/types';
|
|
8
10
|
export declare enum SearchMode {
|
|
9
11
|
Default = "default",
|
|
@@ -89,8 +91,6 @@ export interface RawOptions {
|
|
|
89
91
|
showRightPanelToggle?: boolean;
|
|
90
92
|
layout?: LayoutVariant;
|
|
91
93
|
defaultSampleLanguage?: Languages | string;
|
|
92
|
-
deepLinkSeparator?: string;
|
|
93
|
-
deepLinkPrefix?: string;
|
|
94
94
|
disableDeepLinks?: boolean;
|
|
95
95
|
sideNavStyle?: SideNavStyle;
|
|
96
96
|
whiteLabel?: boolean;
|
|
@@ -100,15 +100,13 @@ export interface RawOptions {
|
|
|
100
100
|
events?: Events;
|
|
101
101
|
corsProxyUrl?: string;
|
|
102
102
|
authCorsProxyUrl?: string;
|
|
103
|
-
linkForId?: ((id: string) => string) | null;
|
|
104
|
-
generateDeepLink?: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
|
|
105
103
|
onDeepLinkClick?: ((link: string) => void) | undefined | null;
|
|
106
104
|
requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
107
105
|
sidebarLinks?: {
|
|
108
106
|
beforeInfo?: Array<ExternalLink>;
|
|
109
107
|
end?: Array<ExternalLink>;
|
|
110
108
|
};
|
|
111
|
-
pagination?:
|
|
109
|
+
pagination?: PaginationType;
|
|
112
110
|
showNextButton?: boolean;
|
|
113
111
|
routingStrategy?: 'hash' | 'browser';
|
|
114
112
|
markdownItemsPagination?: MarkdownItemsPagination;
|
|
@@ -125,7 +123,15 @@ export interface RawOptions {
|
|
|
125
123
|
mediaQueries?: MediaQueries;
|
|
126
124
|
ignoreNamedSchemas?: string[] | string;
|
|
127
125
|
breakpoints?: Omit<MediaQueries, 'print'>;
|
|
128
|
-
allowedMdComponents?:
|
|
126
|
+
allowedMdComponents?: {
|
|
127
|
+
tags: Record<string, Schema>;
|
|
128
|
+
nodes: Record<string, Schema>;
|
|
129
|
+
components: Record<string, React.ComponentType>;
|
|
130
|
+
variables?: Record<string, any>;
|
|
131
|
+
partials?: Record<string, any>;
|
|
132
|
+
functions?: Record<string, ConfigFunction>;
|
|
133
|
+
};
|
|
134
|
+
enableRouter?: boolean;
|
|
129
135
|
}
|
|
130
136
|
export interface DefaultOptions {
|
|
131
137
|
mediaQueries?: MediaQueries;
|
|
@@ -135,7 +141,14 @@ export interface DefaultOptions {
|
|
|
135
141
|
sidebar?: keyof Omit<MediaQueries, 'print'>;
|
|
136
142
|
samplesPanel?: keyof Omit<MediaQueries, 'print'>;
|
|
137
143
|
};
|
|
138
|
-
allowedMdComponents?:
|
|
144
|
+
allowedMdComponents?: {
|
|
145
|
+
tags: Record<string, Schema>;
|
|
146
|
+
nodes: Record<string, Schema>;
|
|
147
|
+
components: Record<string, React.ComponentType>;
|
|
148
|
+
variables?: Record<string, any>;
|
|
149
|
+
partials?: Record<string, any>;
|
|
150
|
+
functions?: Record<string, ConfigFunction>;
|
|
151
|
+
};
|
|
139
152
|
}
|
|
140
153
|
export interface Options {
|
|
141
154
|
showAtBreakpoint: {
|
|
@@ -158,7 +171,7 @@ export interface Options {
|
|
|
158
171
|
pathInMiddlePanel: boolean;
|
|
159
172
|
untrustedDefinition: boolean;
|
|
160
173
|
hideLoading: boolean;
|
|
161
|
-
hideDownloadButton: boolean;
|
|
174
|
+
hideDownloadButton: boolean | null;
|
|
162
175
|
downloadDefinitionUrl?: string;
|
|
163
176
|
disableSearch: boolean;
|
|
164
177
|
searchAutoExpand: boolean;
|
|
@@ -192,7 +205,14 @@ export interface Options {
|
|
|
192
205
|
position: 'first' | 'last' | 'replace' | 'off';
|
|
193
206
|
description: string;
|
|
194
207
|
};
|
|
195
|
-
allowedMdComponents
|
|
208
|
+
allowedMdComponents?: {
|
|
209
|
+
tags: Record<string, Schema>;
|
|
210
|
+
nodes: Record<string, Schema>;
|
|
211
|
+
components: Record<string, React.ComponentType>;
|
|
212
|
+
variables?: Record<string, any>;
|
|
213
|
+
partials?: Record<string, any>;
|
|
214
|
+
functions?: Record<string, ConfigFunction>;
|
|
215
|
+
};
|
|
196
216
|
labels?: LabelsConfigRaw;
|
|
197
217
|
enumSkipQuotes: boolean;
|
|
198
218
|
expandDefaultServerVariables: boolean;
|
|
@@ -221,8 +241,6 @@ export interface Options {
|
|
|
221
241
|
showRightPanelToggle: boolean;
|
|
222
242
|
layout: LayoutVariant;
|
|
223
243
|
defaultSampleLanguage: Languages | string;
|
|
224
|
-
deepLinkSeparator: string;
|
|
225
|
-
deepLinkPrefix: string;
|
|
226
244
|
disableDeepLinks: boolean;
|
|
227
245
|
sideNavStyle: SideNavStyle;
|
|
228
246
|
whiteLabel: boolean;
|
|
@@ -232,8 +250,6 @@ export interface Options {
|
|
|
232
250
|
events: Events;
|
|
233
251
|
corsProxyUrl?: string;
|
|
234
252
|
authCorsProxyUrl?: string;
|
|
235
|
-
linkForId: ((id: string) => string) | null | undefined;
|
|
236
|
-
generateDeepLink: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
|
|
237
253
|
onDeepLinkClick: ((link: string) => void) | undefined | null;
|
|
238
254
|
requestInterceptor: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
239
255
|
sidebarLinks?: {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,r){void 0===r&&(r=a);var i=Object.getOwnPropertyDescriptor(t,a);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,r,i)}:function(e,t,a,r){void 0===r&&(r=a),e[r]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.capitalizeFirst=exports.isDefined=exports.getCodeSample=void 0;const query_string_1=require("query-string"),Sampler=__importStar(require("openapi-sampler")),deepmerge_1=__importDefault(require("deepmerge")),mobx_1=require("mobx"),utils_1=require("../../utils"),utils_2=require("../utils"),constants_1=require("../../constants"),labels_1=require("../labels"),httpsnippet_1=require("./httpsnippet"),string_utility_1=__importDefault(require("./httpsnippet/helpers/string-utility"));function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:o={}}){var l,u,p,c,d,m,h,_,f,v;const{securityHeaders:y,securityCookies:g,securityQueries:O,securityOAuth2ExtraCalls:b,basicAuth:S}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),T=null===(p=null===(u=e.requestBody)||void 0===u?void 0:u.content)||void 0===p?void 0:p.active,C={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},D={path:(0,mobx_1.toJS)(null===(c=null==e?void 0:e.requestValues)||void 0===c?void 0:c.path),cookie:(0,mobx_1.toJS)(null===(d=null==e?void 0:e.requestValues)||void 0===d?void 0:d.cookie),header:(0,mobx_1.toJS)(null===(m=null==e?void 0:e.requestValues)||void 0===m?void 0:m.header),query:(0,mobx_1.toJS)(null===(h=null==e?void 0:e.requestValues)||void 0===h?void 0:h.query),body:(0,mobx_1.toJS)(null===(_=null==e?void 0:e.requestValues)||void 0===_?void 0:_.body)};let q=!1;const E=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=D.header)||void 0===t?void 0:t[e.name])||(0,utils_1.getParameterValue)("header",e.name)||(0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))}})).map((e=>((null==T?void 0:T.name)&&"content-type"===e.name.toLowerCase()&&(q=!0,e.value=T.name),e))).concat(y);!q&&(null==T?void 0:T.name)&&E.unshift({name:"Content-Type",value:null==T?void 0:T.name});const j=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=D.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(g),P=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:(0,utils_1.isArrayOfObjects)(null===(a=D.query)||void 0===a?void 0:a[s])&&JSON.stringify((0,utils_1.deleteEmptyArrayItem)(null===(r=D.query)||void 0===r?void 0:r[s]))||String((null===(i=D.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(O),w=`${null===(f=e.activeServer)||void 0===f?void 0:f.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,A=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=D.path)||void 0===a?void 0:a[i])||n[i]||(0,utils_1.getParameterValue)(r,i),e}),{}),x=null===(v=null==T?void 0:T.examples)||void 0===v?void 0:v[t],R=(null==T?void 0:T.examples)||{},[k]=Object.values(R),M=D.body||(null==x?void 0:x.value)||(null==k?void 0:k.value)||(null==T?void 0:T.schema)&&Sampler.sample(null==T?void 0:T.schema.rawSchema,C,i),H=null==T?void 0:T.name.toLowerCase();let N="",z=[];switch((0,utils_2.normalizeMimeType)(H)){case constants_1.MediaTypes.JSON:N=JSON.stringify(getDataRequest(M,o));break;case constants_1.MediaTypes.URL_ENCODED:case constants_1.MediaTypes.MULTIPART:N=(0,query_string_1.stringify)(getDataRequest(M,o)),z=objectToHarParams(getDataRequest(M,o));break;default:N=String(M||"")}const U=N?{mimeType:(null==T?void 0:T.name)||constants_1.MediaTypes.OCTET_STREAM,text:N,params:z}:void 0,V=e.responses.map((e=>e.code));return{method:e.httpVerb,url:w,httpVersion:"HTTP/1.1",cookies:j,headers:E,queryString:P,postData:U,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:b,basicAuth:S,pathParameters:A,serverVariables:e.activeServer.variables,allResponseCodes:V}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={}}){try{const{skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}=s,p=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}),c=new httpsnippet_1.HTTPSnippet(p);return langToSnippetConfig[e]?c.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t){var a,r,i,s;const n={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const o of(null==e?void 0:e.schemes)||[]){const e=(0,utils_1.getSecurityDetails)(o.id);switch(o.type){case"openIdConnect":null===(a=n.securityHeaders)||void 0===a||a.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";o.flows.clientCredentials&&t?n.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(o.flows.clientCredentials,o.scopes,e)):o.flows.password&&t&&n.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(o.flows.password,o.scopes,e)),null===(r=n.securityHeaders)||void 0===r||r.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===o.in&&(null===(i=n.securityHeaders)||void 0===i||i.push({name:o.name,value:t})),"cookie"===o.in&&n.securityCookies.push({name:o.name,value:t}),"query"===o.in&&n.securityQueries.push({name:o.name,value:t});break}case"http":"basic"===o.scheme?n.basicAuth={username:e.username||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicUsername"))}>`,password:e.password||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicPassword"))}>`}:null===(s=n.securityHeaders)||void 0===s||s.push({name:"Authorization",value:`${capitalizeFirst(o.scheme||"bearer")} <YOUR_${o.bearerFormat||"TOKEN"}_HERE>`})}}return n}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return(0,deepmerge_1.default)(e,t,{arrayMerge:utils_2.arrayMergeStrategy});try{return(0,deepmerge_1.default)(JSON.parse(e),t,{arrayMerge:utils_2.arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e){const t=[];for(const[a,r]of Object.entries(e))t.push({name:a,value:String(r)});return t}function isDefined(e){return void 0!==e}function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}exports.getCodeSample=getCodeSample,exports.isDefined=isDefined,exports.capitalizeFirst=capitalizeFirst;
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,r){void 0===r&&(r=a);var i=Object.getOwnPropertyDescriptor(t,a);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,r,i)}:function(e,t,a,r){void 0===r&&(r=a),e[r]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.capitalizeFirst=exports.isDefined=exports.getCodeSample=void 0;const query_string_1=require("query-string"),Sampler=__importStar(require("openapi-sampler")),deepmerge_1=__importDefault(require("deepmerge")),recoil_nexus_1=require("recoil-nexus"),utils_1=require("../../utils"),utils_2=require("../utils"),constants_1=require("../../constants"),labels_1=require("../labels"),httpsnippet_1=require("./httpsnippet"),string_utility_1=__importDefault(require("./httpsnippet/helpers/string-utility")),models_1=require("../../models"),operation_1=require("../../recoil/operation");function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:o={}}){var l,u,p;const{securityHeaders:c,securityCookies:d,securityQueries:m,securityOAuth2ExtraCalls:h,basicAuth:_}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),{activeServer:f,requestValues:v}=(0,recoil_nexus_1.getRecoil)((0,operation_1.operationStore)(e.pointer)),y=(null===(u=null==e?void 0:e.requestBody)||void 0===u?void 0:u.content)&&(0,models_1.getActiveMediaType)(e.requestBody.content),g={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},O={path:null==v?void 0:v.path,cookie:null==v?void 0:v.cookie,header:null==v?void 0:v.header,query:null==v?void 0:v.query,body:null==v?void 0:v.body};let T=!1;const b=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=O.header)||void 0===t?void 0:t[e.name])||(0,utils_1.getParameterValue)("header",e.name)||(0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))}})).map((e=>((null==y?void 0:y.name)&&"content-type"===e.name.toLowerCase()&&(T=!0,e.value=y.name),e))).concat(c);!T&&(null==y?void 0:y.name)&&b.unshift({name:"Content-Type",value:null==y?void 0:y.name});const S=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=O.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(d),C=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:(0,utils_1.isArrayOfObjects)(null===(a=O.query)||void 0===a?void 0:a[s])&&JSON.stringify((0,utils_1.deleteEmptyArrayItem)(null===(r=O.query)||void 0===r?void 0:r[s]))||String((null===(i=O.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(m),D=`${null==f?void 0:f.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,E=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=O.path)||void 0===a?void 0:a[i])||n[i]||(0,utils_1.getParameterValue)(r,i),e}),{}),q=null===(p=null==y?void 0:y.examples)||void 0===p?void 0:p[t],j=(null==y?void 0:y.examples)||{},[P]=Object.values(j),A=O.body||(null==q?void 0:q.value)||(null==P?void 0:P.value)||(null==y?void 0:y.schema)&&Sampler.sample(null==y?void 0:y.schema.rawSchema,g,i),w=null==y?void 0:y.name.toLowerCase();let R="",k=[];switch((0,utils_2.normalizeMimeType)(w)){case constants_1.MediaTypes.JSON:R=JSON.stringify(getDataRequest(A,o));break;case constants_1.MediaTypes.URL_ENCODED:case constants_1.MediaTypes.MULTIPART:R=(0,query_string_1.stringify)(getDataRequest(A,o)),k=objectToHarParams(getDataRequest(A,o));break;default:R=String(A||"")}const x=R?{mimeType:(null==y?void 0:y.name)||constants_1.MediaTypes.OCTET_STREAM,text:R,params:k}:void 0,M=e.responses.map((e=>e.code));return{method:e.httpVerb,url:D,httpVersion:"HTTP/1.1",cookies:S,headers:b,queryString:C,postData:x,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:h,basicAuth:_,pathParameters:E,serverVariables:(null==f?void 0:f.variables)||e.activeServer.variables,allResponseCodes:M}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={}}){try{const{skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}=s,p=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}),c=new httpsnippet_1.HTTPSnippet(p);return langToSnippetConfig[e]?c.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t){var a,r,i,s;const n={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const o of(null==e?void 0:e.schemes)||[]){const e=(0,utils_1.getSecurityDetails)(o.id);switch(o.type){case"openIdConnect":null===(a=n.securityHeaders)||void 0===a||a.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";o.flows.clientCredentials&&t?n.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(o.flows.clientCredentials,o.scopes,e)):o.flows.password&&t&&n.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(o.flows.password,o.scopes,e)),null===(r=n.securityHeaders)||void 0===r||r.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===o.in&&(null===(i=n.securityHeaders)||void 0===i||i.push({name:o.name,value:t})),"cookie"===o.in&&n.securityCookies.push({name:o.name,value:t}),"query"===o.in&&n.securityQueries.push({name:o.name,value:t});break}case"http":"basic"===o.scheme?n.basicAuth={username:e.username||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicUsername"))}>`,password:e.password||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicPassword"))}>`}:null===(s=n.securityHeaders)||void 0===s||s.push({name:"Authorization",value:`${capitalizeFirst(o.scheme||"bearer")} <YOUR_${o.bearerFormat||"TOKEN"}_HERE>`})}}return n}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return(0,deepmerge_1.default)(e,t,{arrayMerge:utils_2.arrayMergeStrategy});try{return(0,deepmerge_1.default)(JSON.parse(e),t,{arrayMerge:utils_2.arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e){const t=[];for(const[a,r]of Object.entries(e))t.push({name:a,value:String(r)});return t}function isDefined(e){return void 0!==e}function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}exports.getCodeSample=getCodeSample,exports.isDefined=isDefined,exports.capitalizeFirst=capitalizeFirst;
|
|
2
2
|
//# sourceMappingURL=generator.js.map
|
|
@@ -7,7 +7,7 @@ declare const targets: {
|
|
|
7
7
|
default: string;
|
|
8
8
|
};
|
|
9
9
|
fetch: import("..").LanguageHandler<(import("../..").BasicLanguageOptions & {
|
|
10
|
-
credentials?: "
|
|
10
|
+
credentials?: "same-origin" | "omit" | "include" | undefined;
|
|
11
11
|
}) | undefined>;
|
|
12
12
|
};
|
|
13
13
|
node: {
|
|
@@ -6,7 +6,7 @@ declare const _default: {
|
|
|
6
6
|
default: string;
|
|
7
7
|
};
|
|
8
8
|
fetch: import("../..").LanguageHandler<(import("../../..").BasicLanguageOptions & {
|
|
9
|
-
credentials?: "
|
|
9
|
+
credentials?: "same-origin" | "omit" | "include" | undefined;
|
|
10
10
|
}) | undefined>;
|
|
11
11
|
};
|
|
12
12
|
export default _default;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { LanguageHandler } from '../..';
|
|
2
|
-
import type {
|
|
3
|
-
declare const handler: LanguageHandler<
|
|
2
|
+
import type { CurlCodeSampleConfig } from '../../../types';
|
|
3
|
+
declare const handler: LanguageHandler<CurlCodeSampleConfig['options']>;
|
|
4
4
|
export declare const info: {
|
|
5
5
|
key: string;
|
|
6
6
|
title: string;
|
|
@@ -9,7 +9,7 @@ interface CodeSampleBasicConfig {
|
|
|
9
9
|
label?: string;
|
|
10
10
|
options?: BasicLanguageOptions;
|
|
11
11
|
}
|
|
12
|
-
export interface
|
|
12
|
+
export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
|
|
13
13
|
lang: 'curl';
|
|
14
14
|
options?: BasicLanguageOptions & {
|
|
15
15
|
binary?: boolean;
|
|
@@ -48,7 +48,7 @@ export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
|
|
|
48
48
|
export interface RCodeSampleConfig extends CodeSampleBasicConfig {
|
|
49
49
|
lang: 'R';
|
|
50
50
|
}
|
|
51
|
-
export type CodeSampleConfig =
|
|
51
|
+
export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
|
|
52
52
|
/**
|
|
53
53
|
* Code Samples Generator rules
|
|
54
54
|
* - Reference docs always displays all user custom x-code-samples
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { FieldModel } from '../../models';
|
|
2
2
|
export declare function isSameHash(a: string, b: string): boolean;
|
|
3
|
-
export declare function constructFieldDeepFragment(field: FieldModel): string
|
|
3
|
+
export declare function constructFieldDeepFragment(field: FieldModel): string;
|
|
4
4
|
export declare function joinWithSeparator(base?: string, path?: string, sep?: string): string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.joinWithSeparator=exports.constructFieldDeepFragment=exports.isSameHash=void 0;const query_string_1=require("query-string");function isSameHash(e,o){return e===o||"#"+e===o||e==="#"+o}function getContentTypeName(e){var o,
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.joinWithSeparator=exports.constructFieldDeepFragment=exports.isSameHash=void 0;const query_string_1=require("query-string"),models_1=require("../../models");function isSameHash(e,o){return e===o||"#"+e===o||e==="#"+o}function getContentTypeName(e){var o,t,n,i,s,d,r,p,l,a,u,v,c;if(!e.in)return"request"===e.deps.type&&(null===(n=null===(t=null===(o=e.deps.operation)||void 0===o?void 0:o.requestBody)||void 0===t?void 0:t.content)||void 0===n?void 0:n.mediaTypes)?(null===(d=null===(s=null===(i=e.deps.operation)||void 0===i?void 0:i.requestBody)||void 0===s?void 0:s.content)||void 0===d?void 0:d.mediaTypes.length)>1?(null===(p=null===(r=e.deps.operation)||void 0===r?void 0:r.requestBody)||void 0===p?void 0:p.content)&&(0,models_1.getActiveMediaType)(e.deps.operation.requestBody.content).name:void 0:"response"===e.deps.type&&(null===(a=null===(l=e.deps.response)||void 0===l?void 0:l.content)||void 0===a?void 0:a.mediaTypes)&&(null===(v=null===(u=e.deps.response)||void 0===u?void 0:u.content)||void 0===v?void 0:v.mediaTypes.length)>1?(null===(c=e.deps.response)||void 0===c?void 0:c.content)&&(0,models_1.getActiveMediaType)(e.deps.response.content).name:void 0}function constructFieldDeepFragment(e){var o,t;if(!e)return"";const n={t:e.deps.type,in:e.in||e.deps.in,c:"response"===e.deps.type?null===(o=e.deps.response)||void 0===o?void 0:o.code:void 0,cb:(null===(t=e.deps.operation)||void 0===t?void 0:t.isCallback)?e.deps.operation.callbackId:void 0,ct:getContentTypeName(e),path:e.fieldFullPath};return(0,query_string_1.stringify)(n,{encode:!1,sort:!1})}function joinWithSeparator(e="",o="",t="/"){return e.endsWith(t)&&(e=e.slice(0,-t.length)),o.startsWith(t)&&(o=o.slice(t.length)),e&&o?e+t+o:e+o}exports.isSameHash=isSameHash,exports.constructFieldDeepFragment=constructFieldDeepFragment,exports.joinWithSeparator=joinWithSeparator;
|
|
2
2
|
//# sourceMappingURL=helpers.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./helpers"),exports);
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
package/lib/services/index.d.ts
CHANGED
|
@@ -1,17 +1,12 @@
|
|
|
1
|
-
export * from './ProStore';
|
|
2
1
|
export * from './history';
|
|
3
2
|
export * from './code-samples';
|
|
4
3
|
export * from './types';
|
|
5
4
|
export * from './labels';
|
|
6
5
|
export { OpenAPIParser } from './OpenAPIParser';
|
|
7
|
-
export {
|
|
8
|
-
export { ScrollService } from './ScrollService';
|
|
9
|
-
export { SpecStore } from './SpecStore';
|
|
10
|
-
export { MenuBuilder } from './MenuBuilder';
|
|
11
|
-
export { ProMenu } from './ProMenu';
|
|
12
|
-
export type { ExtendedMenuItem } from './ProMenu';
|
|
6
|
+
export { buildContentItems } from './menu';
|
|
13
7
|
export { SearchStore } from './search';
|
|
14
8
|
export type { SearchResultMeta } from './search';
|
|
15
9
|
export { MarkerService } from './MarkerService';
|
|
16
10
|
export * from './types';
|
|
17
11
|
export * from './Options';
|
|
12
|
+
export { deepClone } from './utils';
|
package/lib/services/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,n){void 0===n&&(n=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,n,o)}:function(e,r,t,n){void 0===n&&(n=t),e[n]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.deepClone=exports.MarkerService=exports.SearchStore=exports.buildContentItems=exports.OpenAPIParser=void 0,__exportStar(require("./history"),exports),__exportStar(require("./code-samples"),exports),__exportStar(require("./types"),exports),__exportStar(require("./labels"),exports);var OpenAPIParser_1=require("./OpenAPIParser");Object.defineProperty(exports,"OpenAPIParser",{enumerable:!0,get:function(){return OpenAPIParser_1.OpenAPIParser}});var menu_1=require("./menu");Object.defineProperty(exports,"buildContentItems",{enumerable:!0,get:function(){return menu_1.buildContentItems}});var search_1=require("./search");Object.defineProperty(exports,"SearchStore",{enumerable:!0,get:function(){return search_1.SearchStore}});var MarkerService_1=require("./MarkerService");Object.defineProperty(exports,"MarkerService",{enumerable:!0,get:function(){return MarkerService_1.MarkerService}}),__exportStar(require("./types"),exports),__exportStar(require("./Options"),exports);var utils_1=require("./utils");Object.defineProperty(exports,"deepClone",{enumerable:!0,get:function(){return utils_1.deepClone}});
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
2
|
+
import type { Options } from '../Options';
|
|
3
|
+
import type { ContentItemModel } from '../../models';
|
|
4
|
+
import type { ExtendedMenuItem, IMenuItem } from '../types';
|
|
5
|
+
export declare function buildMenuStructure(parser: OpenAPIParser, options: Options): ContentItemModel[];
|
|
6
|
+
export declare function buildContentItems(parser: OpenAPIParser, options: Options): {
|
|
7
|
+
contentItems: ContentItemModel[];
|
|
8
|
+
flatItems: (ExtendedMenuItem & IMenuItem)[];
|
|
9
|
+
};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=exports.buildMenuStructure=void 0;const tags_1=require("./tags"),markdown_1=require("./markdown"),utils_1=require("../../utils");function buildMenuStructure(t,e){const{definition:n}=t,s=[],i=[...n.tags||[]]||[];!i.find((t=>(null==t?void 0:t.name)===e.schemaDefinitionsTagName))&&e.schemaDefinitionsTagName&&i.push({name:e.schemaDefinitionsTagName});const u=(0,tags_1.getTagsWithOperations)(t,i),o=n["x-tagGroups"];return s.push(...(0,markdown_1.addMarkdownItems)(n.info.description||"",void 0,1,e.markdownHeadingsAnchorLevel,e.pagination)),o&&o.length>0?s.push(...(0,tags_1.getTagGroupsItems)(t,void 0,o,u,e)):s.push(...(0,tags_1.getTagsItems)(t,u,void 0,void 0,e)),s}function buildContentItems(t,e){const n=buildMenuStructure(t,e);return{contentItems:n,flatItems:(0,utils_1.flattenByProp)(n||[],"items")}}exports.buildMenuStructure=buildMenuStructure,exports.buildContentItems=buildContentItems;
|
|
2
|
+
//# sourceMappingURL=builder.js.map
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { IMenuItem, ExtendedMenuItem } from '../types';
|
|
2
|
+
export declare function getItemById(itemId: string, flatItems: (ExtendedMenuItem & IMenuItem)[]): (ExtendedMenuItem & IMenuItem) | undefined;
|
|
3
|
+
export declare function withoutVersion(path: string): string;
|
|
4
|
+
export declare function getParentSpecItem(item: any): any;
|
|
5
|
+
export declare function getParentOfType(item: ExtendedMenuItem, type: string): any;
|
|
6
|
+
export declare function getLeadingSectionItems(item: ExtendedMenuItem): IMenuItem[];
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";function getItemById(e,t){return t.find((({id:t})=>t===e))}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 n of e.items){if("section"!==n.type)break;t.push(n)}return t}Object.defineProperty(exports,"__esModule",{value:!0}),exports.getLeadingSectionItems=exports.getParentOfType=exports.getParentSpecItem=exports.withoutVersion=exports.getItemById=void 0,exports.getItemById=getItemById,exports.withoutVersion=withoutVersion,exports.getParentSpecItem=getParentSpecItem,exports.getParentOfType=getParentOfType,exports.getLeadingSectionItems=getLeadingSectionItems;
|
|
2
|
+
//# sourceMappingURL=helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { buildContentItems } from './builder';
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=void 0;var builder_1=require("./builder");Object.defineProperty(exports,"buildContentItems",{enumerable:!0,get:function(){return builder_1.buildContentItems}});
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { ContentItemModel, GroupModel } from '../../models';
|
|
2
|
+
import { Pagination } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* extracts items from markdown description
|
|
5
|
+
* @param description - markdown source
|
|
6
|
+
* @param parent
|
|
7
|
+
* @param initialDepth - number of items depth
|
|
8
|
+
* @param markdownHeadingsAnchorLevel - level of headings renders as a section from markdown.
|
|
9
|
+
* @param pagination
|
|
10
|
+
*/
|
|
11
|
+
export declare function addMarkdownItems(description: string | GenericObject, parent: GroupModel | undefined, initialDepth: number, markdownHeadingsAnchorLevel?: number, pagination?: Pagination): ContentItemModel[];
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.addMarkdownItems=void 0;const markdoc_1=require("@markdoc/markdoc"),types_1=require("../types"),models_1=require("../../models"),utils_1=require("../../utils");function addMarkdownItems(e,t,i,n=2,o=types_1.Pagination.Section){const s=(0,utils_1.isString)(e)?(0,markdoc_1.parse)(e):markdoc_1.Ast.fromJSON(null==e?void 0:e.result),r=[];let d;const l=(e,t,i=r,n,o)=>{let s;e=(0,utils_1.unescapeHTMLChars)(e),n.attributes.id?s=n.attributes.id:(s=o?`${o}/${(0,utils_1.safeSlugify)(e)}`:`section/${(0,utils_1.safeSlugify)(e)}`,n.attributes.id=s);const d={id:s,name:e,level:t,items:[],ast:[n]};return i.push(d),d},a=(e,t)=>{var i,n;null===(n=null===(i=e[e.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(t)},u=e=>{var t;for(const i of e.children){const e=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?d=l(e,i.attributes.level,void 0,i):i.attributes.level<=n?l(e,i.attributes.level,null==d?void 0:d.items,i,null==d?void 0:d.id):(null===(t=null==d?void 0:d.items)||void 0===t?void 0:t.length)?a(null==d?void 0:d.items,i):(null==r?void 0:r.length)&&a(r,i)}};if(Array.isArray(s))for(const e of s)u(e);else u(s);return mapHeadingsDeep(t,r,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(e,t,i=1,n){return t.map((t=>{const o=(0,models_1.getGroup)("section",t,n,e);return o.depth=i,t.items&&(o.items=mapHeadingsDeep(o,t.items,i+1,n)),o}))}function getMarkdownContent(e){var t,i;return"string"==typeof(null===(t=null==e?void 0:e.attributes)||void 0===t?void 0:t.content)?null===(i=e.attributes)||void 0===i?void 0:i.content:(null==e?void 0:e.children)?getMarkdownContent(e.children[0]):void 0}exports.addMarkdownItems=addMarkdownItems;
|
|
2
|
+
//# sourceMappingURL=markdown.js.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { GroupModel, OperationMenuItem, ContentItemModel } from '../../models';
|
|
2
|
+
import type { TagInfo } from '../types';
|
|
3
|
+
import type { Options } from '../Options';
|
|
4
|
+
import { Pagination } from '../types';
|
|
5
|
+
/**
|
|
6
|
+
* Returns array of Operation items for the tag
|
|
7
|
+
* @param parent parent OperationsGroup
|
|
8
|
+
* @param tag tag info returned from `getTagsWithOperations`
|
|
9
|
+
* @param depth items depth
|
|
10
|
+
* @param options - normalized options
|
|
11
|
+
*/
|
|
12
|
+
export declare function getOperationsItems(parent: GroupModel | undefined, tag: TagInfo, depth: number, options: Options): OperationMenuItem[];
|
|
13
|
+
export declare function getHref({ type, id, parent }: Pick<ContentItemModel, 'id' | 'parent' | 'type'>, pagination: Pagination): string;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getHref=exports.getOperationsItems=void 0;const utils_1=require("../../utils"),types_1=require("../types"),utils_2=require("../utils"),history_1=require("../history");function getOperationsItems(t,e,i,r){if(0===e.operations.length)return[];const o=[];for(const a of e.operations){const e=(0,utils_1.getOperationId)(a,t),n="operation";o.push({id:e,type:n,parent:t,operationDefinition:a,depth:i,name:(0,utils_1.getOperationName)(a),httpVerb:a.httpVerb,path:a.pathName,items:[],isWebhook:a.isWebhook,operationId:a.operationId,href:getHref({id:e,type:n,parent:t},r.pagination)})}return r.sortOperationsAlphabetically&&o.sort((0,utils_1.alphabeticallyByProp)("name")),o}function getHref({type:t,id:e,parent:i},r){switch(r){case types_1.Pagination.None:return`#${e}`;case types_1.Pagination.Item:return"section"===t?"tag"===(null==i?void 0:i.type)?(0,utils_2.normalizePath)((0,history_1.joinWithSeparator)(i.id,e,"#")):`#${e}`:i&&"group"!==i.type?(0,utils_2.normalizePath)((0,history_1.joinWithSeparator)(i.id,e)):(0,utils_2.normalizePath)(e);case types_1.Pagination.Section:return"operation"===t?i?(0,utils_2.normalizePath)((0,history_1.joinWithSeparator)(i.id,e,"#")):(0,utils_2.normalizePath)(`#${e}`):"section"===t?i?`#${e}`:(0,utils_2.normalizePath)(`#${e}`):(0,utils_2.normalizePath)(e);default:return""}}exports.getOperationsItems=getOperationsItems,exports.getHref=getHref;
|
|
2
|
+
//# sourceMappingURL=operation.js.map
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
2
|
+
import type { ContentItemModel, GroupModel } from '../../models';
|
|
3
|
+
import type { TagGroup, TagsInfoMap } from '../types';
|
|
4
|
+
import type { Options } from '../Options';
|
|
5
|
+
import type { OpenAPITag } from '../../types';
|
|
6
|
+
/**
|
|
7
|
+
* Returns array of OperationsGroup items for the tags of the group or for all tags
|
|
8
|
+
* @param parser
|
|
9
|
+
* @param tagsMap tags info returned from `getTagsWithOperations`
|
|
10
|
+
* @param parent parent item
|
|
11
|
+
* @param group group which this tag belongs to. if not provided gets all tags
|
|
12
|
+
* @param options - normalized options
|
|
13
|
+
*/
|
|
14
|
+
export declare function getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: Options): ContentItemModel[];
|
|
15
|
+
/**
|
|
16
|
+
* Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
|
|
17
|
+
* @param parser
|
|
18
|
+
* @param parent
|
|
19
|
+
* @param groups
|
|
20
|
+
* @param tags value of `x-tagGroups` vendor extension
|
|
21
|
+
* @param options - normalized options
|
|
22
|
+
*/
|
|
23
|
+
export declare function getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: Options): GroupModel[];
|
|
24
|
+
/**
|
|
25
|
+
* collects tags and maps each tag to list of operations belonging to this tag
|
|
26
|
+
*/
|
|
27
|
+
export declare function getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getTagsWithOperations=exports.getTagGroupsItems=exports.getTagsItems=void 0;const models_1=require("../../models"),constants_1=require("../../constants"),utils_1=require("../../utils"),operation_1=require("./operation"),markdown_1=require("./markdown");function getTagsItems(e,t,n,o,s){let a;if(a=void 0===o?Object.keys(t):o.tags,!Array.isArray(a))return console.warn("Unexpected values of tags. Check tags or x-tagGroups in your definition."),[];const i=a.map((e=>t[e]?(t[e].used=!0,t[e]):(console.warn(`Non-existing tag "${e}" is added to the group "${null==o?void 0:o.name}"`),null))),r=[];for(const t of i){if(!t)continue;const o=(0,models_1.getGroup)("tag",t,{pagination:s.pagination,markdownHeadingsAnchorLevel:s.markdownHeadingsAnchorLevel},n);if(o.depth=constants_1.GROUP_DEPTH+1,""===t.name){const e=[...(0,markdown_1.addMarkdownItems)(t.description||"",o,o.depth+1,s.markdownHeadingsAnchorLevel,s.pagination),...(0,operation_1.getOperationsItems)(void 0,t,o.depth+1,s)];r.push(...e);continue}const a=getTagRelatedSchema({definition:e.definition,tag:t,parent:o,schemaDefinitionsTagName:s.schemaDefinitionsTagName,options:{pagination:s.pagination,markdownHeadingsAnchorLevel:s.markdownHeadingsAnchorLevel}});o.items=[...a,...(0,markdown_1.addMarkdownItems)(t.description||"",o,o.depth+1,s.markdownHeadingsAnchorLevel,s.pagination),...(0,operation_1.getOperationsItems)(o,t,o.depth+1,s)],r.push(o)}return s.sortTagsAlphabetically&&r.sort((0,utils_1.alphabeticallyByProp)("name")),r}function getTagGroupsItems(e,t,n,o,s){const a=[];for(const i of n){const n=(0,models_1.getGroup)("group",i,{pagination:s.pagination,markdownHeadingsAnchorLevel:s.markdownHeadingsAnchorLevel},t);n.depth=constants_1.GROUP_DEPTH,n.items=getTagsItems(e,o,n,i,s),a.push(n)}return a}function getTagRelatedSchema({definition:e,tag:t,parent:n,schemaDefinitionsTagName:o,options:s}){var a;const i=o?[o]:[];return Object.entries((null===(a=e.components)||void 0===a?void 0:a.schemas)||{}).map((([e,o])=>{if(!(o["x-tags"]||i).includes(t.name))return null;const a=(0,models_1.getGroup)("schema",{name:e,"x-displayName":`${o.title||e}`,description:`{% schemaDefinition showWriteOnly="true" schemaRef="#/components/schemas/${e}" /%}`,isSchema:!0,level:2},s,n);return a.depth=n.depth+1,a})).filter(Boolean)}function getTagsWithOperations(e,t){const{definition:n}=e,o={},s=n["x-webhooks"]||n.webhooks;for(const e of t||[])o[e.name]=Object.assign(Object.assign({},e),{operations:[]});return n.paths&&getTags(e,n.paths,o),s&&getTags(e,s,o,!0),o}function getTags(e,t,n,o){for(const s of Object.keys(t||{})){const a=t[s],i=Object.keys(a).filter(utils_1.isOperationName);for(const t of i){const i=a[t];if(a.$ref){const{resolved:t}=e.deref(a);getTags(e,{[s]:t},n,o);continue}let r=null==i?void 0:i.tags;r&&r.length||(r=[""]);for(const e of r){let r=n[e];void 0===r&&(r={name:e,operations:[]},n[e]=r),r["x-traitTag"]||r.operations.push(Object.assign(Object.assign({},i),{pathName:s,pointer:utils_1.JsonPointer.compile(["paths",s]),httpVerb:t,pathParameters:a.parameters||[],pathServers:a.servers,isWebhook:!!o}))}}}}exports.getTagsItems=getTagsItems,exports.getTagGroupsItems=getTagGroupsItems,exports.getTagsWithOperations=getTagsWithOperations;
|
|
2
|
+
//# sourceMappingURL=tags.js.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { SearchResult, SearchResultMeta } from './types';
|
|
2
|
-
import type {
|
|
2
|
+
import type { OperationMenuItem } from '../../models';
|
|
3
3
|
import type { IMenuItem } from '../types';
|
|
4
|
-
import type { Options } from '../Options
|
|
4
|
+
import type { Options } from '../Options';
|
|
5
5
|
import { SearchStore } from './SearchStore';
|
|
6
6
|
export declare class DeepSearchStore extends SearchStore<SearchResultMeta> {
|
|
7
7
|
operationTitleBoost: number;
|
|
@@ -10,7 +10,7 @@ export declare class DeepSearchStore extends SearchStore<SearchResultMeta> {
|
|
|
10
10
|
pathOnly: boolean;
|
|
11
11
|
searchMaxDepth: number;
|
|
12
12
|
constructor(options: Options);
|
|
13
|
-
indexItems(groups: Array<IMenuItem |
|
|
13
|
+
indexItems(groups: Array<IMenuItem | OperationMenuItem>): void;
|
|
14
14
|
private indexSchema;
|
|
15
15
|
add(title: string, body: string, meta?: SearchResultMeta): void;
|
|
16
16
|
search<T = SearchResultMeta>(q: string): Promise<Array<SearchResult<T>>>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __awaiter=this&&this.__awaiter||function(e,t,o,r){return new(o||(o=Promise))((function(i,
|
|
1
|
+
"use strict";var __awaiter=this&&this.__awaiter||function(e,t,o,r){return new(o||(o=Promise))((function(i,s){function a(e){try{c(r.next(e))}catch(e){s(e)}}function n(e){try{c(r.throw(e))}catch(e){s(e)}}function c(e){var t;e.done?i(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(a,n)}c((r=r.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DeepSearchStore=void 0;const recoil_nexus_1=require("recoil-nexus"),SearchStore_1=require("./SearchStore"),constants_1=require("../../constants"),store_1=require("../../recoil/store"),models_1=require("../../models"),operation_1=require("../../recoil/operation"),utils_1=require("../../utils");function removeMarkdown(e){return(0,utils_1.normalizeText)(e).replace(/\[(.*?)][[(].*?[\])]/g,"$1")}class DeepSearchStore extends SearchStore_1.SearchStore{constructor(e){super(),Object.defineProperty(this,"operationTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:4}),Object.defineProperty(this,"tagTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:8}),Object.defineProperty(this,"fieldLevelBoost",{enumerable:!0,configurable:!0,writable:!0,value:.95}),Object.defineProperty(this,"pathOnly",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"searchMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:constants_1.DEFAULT_SEARCH_MAX_DEPTH}),e.searchOperationTitleBoost&&(this.operationTitleBoost=e.searchOperationTitleBoost),e.searchTagTitleBoost&&(this.tagTitleBoost=e.searchTagTitleBoost),e.searchFieldLevelBoost&&(this.fieldLevelBoost=e.searchFieldLevelBoost),"path-only"===e.searchMode&&(this.pathOnly=!0),e.searchMaxDepth&&(this.searchMaxDepth=e.searchMaxDepth)}indexItems(e){const t=e=>{e&&e.forEach((e=>{if("operation"===e.type&&this.pathOnly){const t=e;this.add(t.path,"",{menuId:t.id,boost:this.operationTitleBoost})}else{if("group"===e.type||this.pathOnly||(this.add(e.name,"operation"===e.type?e.path:"",{menuId:e.id,boost:"operation"===e.type?this.operationTitleBoost:this.tagTitleBoost}),e.description&&this.add("",removeMarkdown(e.description||""),{menuId:e.id})),"operation"===e.type){const t=e.operationDefinition,{parser:o,options:r}=(0,recoil_nexus_1.getRecoil)(store_1.globalStoreSelector),i=(0,models_1.getOperation)(o,t,void 0,r,e.href);for(const t of i.parameters||[])this.add(t.name,removeMarkdown(t.description),{menuId:e.id,place:"parameters",path:[t.name]});const s=i.requestBody&&i.requestBody.content&&(0,models_1.getActiveMediaType)(i.requestBody.content).schema;this.indexSchema(s,e.id,"request fields"),i.responses.forEach((t=>{const o=t.content&&(0,models_1.getActiveMediaType)(t.content).schema;o&&this.indexSchema(o,e.id,`response ${t.code} fields`)}))}t(e.items)}}))};t(e),this.searchWorker.done()}indexSchema(e,t,o,r=[],i=0){if(!e)return;if(i>this.searchMaxDepth||e.isCircular)return;const{activeOneOf:s}=(0,recoil_nexus_1.getRecoil)((0,operation_1.operationStore)(e.deps.operation.pointer));if((e=e.oneOf&&e.oneOf[s]||e).fields)for(const s of e.fields){const e=r.concat([s.name]);"additionalProperties"!==s.kind&&(this.add(s.name,removeMarkdown(s.description),{menuId:t,place:o,path:e,boost:Math.pow(this.fieldLevelBoost,i)}),this.indexSchema(s.schema,t,o,e,i+1))}e.items&&this.indexSchema(e.items,t,o,r,i+1)}add(e,t,o){this.searchWorker.add(e,t,o)}search(e){return __awaiter(this,void 0,void 0,(function*(){return yield this.searchWorker.search(e)}))}toJS(){return __awaiter(this,void 0,void 0,(function*(){return this.searchWorker.toJS()}))}dispose(){"terminate"in this.searchWorker&&this.searchWorker.terminate(),this.searchWorker.dispose&&this.searchWorker.dispose()}}exports.DeepSearchStore=DeepSearchStore;
|
|
2
2
|
//# sourceMappingURL=DeepSearchStore.js.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Options } from '../Options';
|
|
2
|
+
import type { SearchStore } from './SearchStore';
|
|
3
|
+
import type { SearchResultMeta } from './types';
|
|
4
|
+
import type { ContentItemModel } from '../../models';
|
|
5
|
+
type UseSearchInput = {
|
|
6
|
+
options: Options;
|
|
7
|
+
contentItems: ContentItemModel[];
|
|
8
|
+
};
|
|
9
|
+
type UseSearchReturnType = {
|
|
10
|
+
search?: SearchStore<SearchResultMeta>;
|
|
11
|
+
};
|
|
12
|
+
export declare function useSearch({ options, contentItems }: UseSearchInput): UseSearchReturnType;
|
|
13
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useSearch=void 0;const RemoteSearch_1=require("./RemoteSearch"),DeepSearchStore_1=require("./DeepSearchStore"),global="undefined"==typeof window?{__REDOCLY_SEARCH_URL:void 0}:window;function useSearch({options:e,contentItems:r}){let t;return e.disableSearch||t||(t=initSearch(e),null==t||t.indexItems(r)),{search:t}}function initSearch(e){return global.__REDOCLY_SEARCH_URL?new RemoteSearch_1.RemoteSearch(global.__REDOCLY_SEARCH_URL):new DeepSearchStore_1.DeepSearchStore(e)}exports.useSearch=useSearch;
|
|
2
|
+
//# sourceMappingURL=useSearch.js.map
|