@redocly/openapi-docs 3.0.0-alpha.14.beta.2 → 3.0.0-alpha.14.beta.3
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 +6934 -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 +9 -2
- package/lib/components/common/LinkToField.js +8 -21
- 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/AuthPanel/AuthPanel.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 +19 -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 +13 -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 +230 -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.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 -1
- 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 +4 -6
- 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 +9 -2
- package/lib-esm/components/common/LinkToField.js +8 -21
- 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/AuthPanel/AuthPanel.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 +19 -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 +13 -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 +230 -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.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 -1
- 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 +4 -6
- 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 -6206
- 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 -6308
- 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
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";var __awaiter=this&&this.__awaiter||function(e,t,i,n){return new(i||(i=Promise))((function(c,r){function s(e){try{u(n.next(e))}catch(e){r(e)}}function o(e){try{u(n.throw(e))}catch(e){r(e)}}function u(e){var t;e.done?c(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(s,o)}u((n=n.apply(e,t||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.useLicense=void 0;const react_1=require("react"),check_1=__importDefault(require("../services/check"));function useLicense(e){const[t,i]=(0,react_1.useState)("development"===process.env.NODE_ENV?{valid:!0,allowed:!0}:{});return(0,react_1.useEffect)((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){const t=yield(0,check_1.default)(e);i(t)}))}()}),[e]),{licenseInfo:t,isValid:isValidLicense(t)}}function isValidLicense(e){return e.valid&&e.allowed&&!e.expired||!!e.local}exports.useLicense=useLicense;
|
|
2
|
+
//# sourceMappingURL=useLicense.js.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as React from 'react';
|
|
2
|
+
import type { RouterType } from '../types';
|
|
3
|
+
interface RouterProps {
|
|
4
|
+
basename?: string;
|
|
5
|
+
location?: string;
|
|
6
|
+
}
|
|
7
|
+
export declare const useRouter: (router: RouterType, basePath: string) => {
|
|
8
|
+
Router: React.ComponentType<{}>;
|
|
9
|
+
routerProps: RouterProps;
|
|
10
|
+
};
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useRouter=void 0;const react_router_dom_1=require("react-router-dom"),RouterComponent={history:react_router_dom_1.BrowserRouter,memory:react_router_dom_1.MemoryRouter,hash:react_router_dom_1.HashRouter},useRouter=(e,r)=>({Router:RouterComponent[e],routerProps:Object.assign({},"memory"!==e&&{basename:r})});exports.useRouter=useRouter;
|
|
2
|
+
//# sourceMappingURL=useRouter.js.map
|
package/lib/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export * from './events/index';
|
|
|
5
5
|
export * from './constants';
|
|
6
6
|
export { setSecurityDetails, setSecurityDetailsVariants, setParameterValue, isOperationName, JsonPointer, } from './utils';
|
|
7
7
|
export type { SecurityDetails, OpenAPIDefinition, OpenAPIOperation, OpenAPIParameterLocation, OpenAPISchema, } from './types';
|
|
8
|
-
export
|
|
8
|
+
export { OpenAPIParser } from './services';
|
|
9
|
+
export { buildContentItems, normalizeOptions } from './services';
|
|
9
10
|
export type { OAuth2 } from './services/OAuth2';
|
|
10
11
|
export type { OpenApiResponseData } from './components/rightPanel/types';
|
package/lib/index.js
CHANGED
|
@@ -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 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}),exports.JsonPointer=exports.isOperationName=exports.setParameterValue=exports.setSecurityDetailsVariants=exports.setSecurityDetails=void 0,__exportStar(require("./components/index"),exports),__exportStar(require("./services/index"),exports),__exportStar(require("./models/index"),exports),__exportStar(require("./events/index"),exports),__exportStar(require("./constants"),exports);var utils_1=require("./utils");Object.defineProperty(exports,"setSecurityDetails",{enumerable:!0,get:function(){return utils_1.setSecurityDetails}}),Object.defineProperty(exports,"setSecurityDetailsVariants",{enumerable:!0,get:function(){return utils_1.setSecurityDetailsVariants}}),Object.defineProperty(exports,"setParameterValue",{enumerable:!0,get:function(){return utils_1.setParameterValue}}),Object.defineProperty(exports,"isOperationName",{enumerable:!0,get:function(){return utils_1.isOperationName}}),Object.defineProperty(exports,"JsonPointer",{enumerable:!0,get:function(){return utils_1.JsonPointer}});
|
|
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}),exports.normalizeOptions=exports.buildContentItems=exports.OpenAPIParser=exports.JsonPointer=exports.isOperationName=exports.setParameterValue=exports.setSecurityDetailsVariants=exports.setSecurityDetails=void 0,__exportStar(require("./components/index"),exports),__exportStar(require("./services/index"),exports),__exportStar(require("./models/index"),exports),__exportStar(require("./events/index"),exports),__exportStar(require("./constants"),exports);var utils_1=require("./utils");Object.defineProperty(exports,"setSecurityDetails",{enumerable:!0,get:function(){return utils_1.setSecurityDetails}}),Object.defineProperty(exports,"setSecurityDetailsVariants",{enumerable:!0,get:function(){return utils_1.setSecurityDetailsVariants}}),Object.defineProperty(exports,"setParameterValue",{enumerable:!0,get:function(){return utils_1.setParameterValue}}),Object.defineProperty(exports,"isOperationName",{enumerable:!0,get:function(){return utils_1.isOperationName}}),Object.defineProperty(exports,"JsonPointer",{enumerable:!0,get:function(){return utils_1.JsonPointer}});var services_1=require("./services");Object.defineProperty(exports,"OpenAPIParser",{enumerable:!0,get:function(){return services_1.OpenAPIParser}});var services_2=require("./services");Object.defineProperty(exports,"buildContentItems",{enumerable:!0,get:function(){return services_2.buildContentItems}}),Object.defineProperty(exports,"normalizeOptions",{enumerable:!0,get:function(){return services_2.normalizeOptions}});
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Options } from 'src/services/Options';
|
|
2
|
+
import type { OpenAPIParser } from 'src/services/OpenAPIParser';
|
|
3
|
+
import type { OpenAPICallback, Referenced } from '../types';
|
|
4
|
+
import type { CallbackModel, GroupModel } from './types';
|
|
5
|
+
export declare function getCallback(parser: OpenAPIParser, name: string, infoOrRef: Referenced<OpenAPICallback>, parentPointer: string, options: Options, href: string, parent?: GroupModel): CallbackModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getCallback=void 0;const utils_1=require("../utils"),operation_1=require("./operation"),services_1=require("../services");function getCallback(e,t,r,s,o,a,i){const{resolved:n}=e.deref(r),c=[];for(const r of Object.keys(n)){const l=n[r],p=Object.keys(l).filter(utils_1.isOperationName);for(const n of p){const p=l[n],u=(0,operation_1.getOperation)(e,Object.assign(Object.assign({},p),{pathName:r,pointer:utils_1.JsonPointer.join(s,["callbacks",t,n]),httpVerb:n,pathParameters:l.parameters||[],pathServers:l.servers}),i,o,a,{isCallback:!0,id:(0,services_1.joinWithSeparator)(t,n)});c.push(u)}}return{name:t,operations:c}}exports.getCallback=getCallback;
|
|
2
|
+
//# sourceMappingURL=callback.js.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { OpenAPIExample, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { ExampleModel } from './types';
|
|
4
|
+
export declare function getExternalExampleValue(mimeType: string, externalValueUrl?: string): Promise<string | undefined>;
|
|
5
|
+
type GetExamplesInput = Pick<ExampleModel, 'mime' | 'encoding'> & {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
infoOrRef: Referenced<OpenAPIExample>;
|
|
8
|
+
};
|
|
9
|
+
export declare function getExamples({ parser, infoOrRef, mime, encoding }: GetExamplesInput): ExampleModel;
|
|
10
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getExamples=exports.getExternalExampleValue=void 0;const url_1=require("url"),utils_1=require("../utils"),ExternalExamplesCache={};function getExternalExampleValue(e,r){return r?(r in ExternalExamplesCache||(ExternalExamplesCache[r]=fetch(r).then((r=>r.text().then((t=>{if(!r.ok)return Promise.reject(new Error(t));if(!(0,utils_1.isJsonLike)(e))return t;try{return JSON.parse(t)}catch(e){return t}}))))),ExternalExamplesCache[r]):Promise.resolve(void 0)}function getExamples({parser:e,infoOrRef:r,mime:t,encoding:l}){let a;const{resolved:n}=e.deref(r),s=n.value,u=n.value,i=n.summary,x=n.description;return n.externalValue&&(a=(0,url_1.resolve)(e.definitionUrl||"",n.externalValue)),{value:u,rawValue:s,externalValueUrl:a,summary:i,description:x,mime:t,encoding:l}}exports.getExternalExampleValue=getExternalExampleValue,exports.getExamples=getExamples;
|
|
2
|
+
//# sourceMappingURL=example.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { OpenAPIParser, Options } from '../services';
|
|
2
|
+
import type { OpenAPIParameter, Referenced } from '../types';
|
|
3
|
+
import type { FieldModel, Deps } from './types';
|
|
4
|
+
export declare function getField(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIParameter> & {
|
|
5
|
+
name?: string;
|
|
6
|
+
kind?: string;
|
|
7
|
+
}, pointer: string, options: Options, deps: Deps, refsStack?: string[]): FieldModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getField=void 0;const utils_1=require("../utils"),schema_1=require("./schema"),example_1=require("./example"),DEFAULT_SERIALIZATION={path:{style:"simple",explode:!1},query:{style:"form",explode:!0},header:{style:"simple",explode:!1},cookie:{style:"form",explode:!0}};function getField(e,l,i,t,s,o){var n,d,a,r,p,c;const{resolved:m}=e.deref(l),u=l.kind||"field",x=l.name||m.name,v=m.in,h=!!m.required;let f,F,g=m.schema,_="";if(!g&&m.in&&m.content){_=Object.keys(m.content)[0];const l=m.content[_];g=l&&(null==l?void 0:l.example)?Object.assign(Object.assign({},e.deref(l.schema,o,!0).resolved),{example:m.example||l.example}):l.schema}const y=(null==s?void 0:s.parentFieldFullPath)?s.parentFieldFullPath+"/"+x:x,O=(0,schema_1.getSchema)({parser:e,schemaOrRef:g||{},pointer:i,options:t,baseRefsStack:o,deps:Object.assign(Object.assign({},s),{parentFieldFullPath:y,in:v})}),E=void 0===m.description?O.description||"":m.description,A=m.example||O.example,I=m.examples||(null===(d=null===(n=m.content)||void 0===n?void 0:n[_])||void 0===d?void 0:d.examples),b=I?(0,utils_1.mapValues)(I,((l,i)=>(0,example_1.getExamples)({parser:e,infoOrRef:l,mime:i,encoding:m.encoding}))):void 0;_?f=_:m.style?F=m.style:v&&(F=null!==(r=null===(a=DEFAULT_SERIALIZATION[v])||void 0===a?void 0:a.style)&&void 0!==r?r:"form");const j=void 0===m.explode&&v?null===(c=null===(p=DEFAULT_SERIALIZATION[v])||void 0===p?void 0:p.explode)||void 0===c||c:!!m.explode;return{deps:s||{},schema:O,name:x,required:h,description:E,example:A,examples:b,deprecated:void 0===m.deprecated?O.deprecated:m.deprecated,in:v,kind:u,extensions:t.showExtensions?(0,utils_1.extractExtensions)(m,t.showExtensions):void 0,explode:j,style:F,const:(null==O?void 0:O.const)||(null==m?void 0:m.const)||"",serializationMime:f,fieldFullPath:y}}exports.getField=getField;
|
|
2
|
+
//# sourceMappingURL=field.js.map
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { OpenAPITag } from '../types';
|
|
2
|
+
import type { MarkdownHeading, MenuItemGroupType, Options } from '../services';
|
|
3
|
+
import type { GroupModel } from './types';
|
|
4
|
+
export declare function getGroup(type: MenuItemGroupType, tagOrGroup: OpenAPITag | MarkdownHeading, { pagination, markdownHeadingsAnchorLevel, }: Pick<Options, 'pagination' | 'markdownHeadingsAnchorLevel'>, parent?: GroupModel): GroupModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getGroup=void 0;const utils_1=require("../utils"),operation_1=require("../services/menu/operation"),saveTextBeforeHeading_1=require("../utils/saveTextBeforeHeading");function getGroup(e,t,{pagination:i,markdownHeadingsAnchorLevel:r},o){const s=t.id||e+"/"+(0,utils_1.safeSlugify)(t.name),a=t["x-displayName"]||t.name,n=t.level||1,p=t.isSchema,u=t.ast||void 0;return{id:s,type:e,parent:o,name:a,level:n,depth:0,isSchema:p,description:(0,saveTextBeforeHeading_1.saveTextBeforeHeading)(t.description||"",r),items:t.items,ast:u,externalDocs:t.externalDocs,href:(0,operation_1.getHref)({id:s,parent:o,type:e},i)}}exports.getGroup=getGroup;
|
|
2
|
+
//# sourceMappingURL=group.js.map
|
package/lib/models/index.d.ts
CHANGED
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
export * from './code-sample-options';
|
|
2
2
|
export * from './file-upload';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
11
|
-
export
|
|
12
|
-
export
|
|
13
|
-
export
|
|
14
|
-
export
|
|
15
|
-
export * from './
|
|
16
|
-
export * from './Webhook';
|
|
3
|
+
export { getGroup } from './group';
|
|
4
|
+
export { getOperation, isPayloadSample } from './operation';
|
|
5
|
+
export type { Sample, XPayloadSample } from './operation';
|
|
6
|
+
export { getRequestBody } from './request';
|
|
7
|
+
export { getExamples, getExternalExampleValue } from './example';
|
|
8
|
+
export { getActiveMediaType, getMediaContent } from './mediaContent';
|
|
9
|
+
export type { MediaContentModel, OperationModel, GroupModel, SchemaModel } from './types';
|
|
10
|
+
export { getMediaType } from './mediaType';
|
|
11
|
+
export { getResponse } from './response';
|
|
12
|
+
export { getSchema } from './schema';
|
|
13
|
+
export { getField } from './field';
|
|
14
|
+
export { getCallback } from './callback';
|
|
15
|
+
export * from './security';
|
|
17
16
|
export * from './types';
|
package/lib/models/index.js
CHANGED
|
@@ -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,o){void 0===o&&(o=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,o,n)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=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}),exports.getCallback=exports.getField=exports.getSchema=exports.getResponse=exports.getMediaType=exports.getMediaContent=exports.getActiveMediaType=exports.getExternalExampleValue=exports.getExamples=exports.getRequestBody=exports.isPayloadSample=exports.getOperation=exports.getGroup=void 0,__exportStar(require("./code-sample-options"),exports),__exportStar(require("./file-upload"),exports);var group_1=require("./group");Object.defineProperty(exports,"getGroup",{enumerable:!0,get:function(){return group_1.getGroup}});var operation_1=require("./operation");Object.defineProperty(exports,"getOperation",{enumerable:!0,get:function(){return operation_1.getOperation}}),Object.defineProperty(exports,"isPayloadSample",{enumerable:!0,get:function(){return operation_1.isPayloadSample}});var request_1=require("./request");Object.defineProperty(exports,"getRequestBody",{enumerable:!0,get:function(){return request_1.getRequestBody}});var example_1=require("./example");Object.defineProperty(exports,"getExamples",{enumerable:!0,get:function(){return example_1.getExamples}}),Object.defineProperty(exports,"getExternalExampleValue",{enumerable:!0,get:function(){return example_1.getExternalExampleValue}});var mediaContent_1=require("./mediaContent");Object.defineProperty(exports,"getActiveMediaType",{enumerable:!0,get:function(){return mediaContent_1.getActiveMediaType}}),Object.defineProperty(exports,"getMediaContent",{enumerable:!0,get:function(){return mediaContent_1.getMediaContent}});var mediaType_1=require("./mediaType");Object.defineProperty(exports,"getMediaType",{enumerable:!0,get:function(){return mediaType_1.getMediaType}});var response_1=require("./response");Object.defineProperty(exports,"getResponse",{enumerable:!0,get:function(){return response_1.getResponse}});var schema_1=require("./schema");Object.defineProperty(exports,"getSchema",{enumerable:!0,get:function(){return schema_1.getSchema}});var field_1=require("./field");Object.defineProperty(exports,"getField",{enumerable:!0,get:function(){return field_1.getField}});var callback_1=require("./callback");Object.defineProperty(exports,"getCallback",{enumerable:!0,get:function(){return callback_1.getCallback}}),__exportStar(require("./security"),exports),__exportStar(require("./types"),exports);
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { MediaContentModel, MediaContentModelInput } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* MediaContent model ready to be sued by React components
|
|
4
|
+
* Contains multiple MediaTypes and keeps track of the currently active one
|
|
5
|
+
*/
|
|
6
|
+
export declare function getMediaContent({ parser, info, isRequestType, options, data: { operation, type, response }, }: MediaContentModelInput): MediaContentModel;
|
|
7
|
+
export declare function getActiveMediaType(content: MediaContentModel, mime?: string): import("./types").MediaTypeModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getActiveMediaType=exports.getMediaContent=void 0;const recoil_nexus_1=require("recoil-nexus"),utils_1=require("../utils"),mediaType_1=require("./mediaType"),app_1=require("../recoil/app");function getMediaContent({parser:e,info:t,isRequestType:i,options:r,data:{operation:p,type:a,response:s}}){r.unstable_ignoreMimeParameters&&(t=(0,utils_1.mergeSimilarMediaTypes)(t));const o=Object.keys(t).map((o=>{const n=t[o];return(0,mediaType_1.getMediaType)(e,o,i,n,r,{operation:p,type:a,response:s})})),n=o.filter((e=>!!e.examples)).length>0;return{mediaTypes:o,isRequestType:i,hasSample:n,operation:p}}function getActiveMediaType(e,t){const i=t||(0,recoil_nexus_1.getRecoil)(app_1.activeMimeNameSelector);return i&&e.mediaTypes.find((e=>e.name===i))||e.mediaTypes[0]}exports.getMediaContent=getMediaContent,exports.getActiveMediaType=getActiveMediaType;
|
|
2
|
+
//# sourceMappingURL=mediaContent.js.map
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { OpenAPIMediaType } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Options } from 'src/services/Options/types';
|
|
4
|
+
import type { MediaTypeModel, ResponseModel, OperationModel } from './types';
|
|
5
|
+
/**
|
|
6
|
+
* @param parser
|
|
7
|
+
* @param name
|
|
8
|
+
* @param isRequestType needed to know if skip RO/RW fields in objects
|
|
9
|
+
* @param info
|
|
10
|
+
* @param options
|
|
11
|
+
* @param operation
|
|
12
|
+
* @param type
|
|
13
|
+
* @param response
|
|
14
|
+
*/
|
|
15
|
+
export declare function getMediaType(parser: OpenAPIParser, name: string, isRequestType: boolean, info: OpenAPIMediaType, options: Options, { operation, type, response, }: {
|
|
16
|
+
operation: OperationModel;
|
|
17
|
+
type?: 'request' | 'response';
|
|
18
|
+
response?: ResponseModel;
|
|
19
|
+
}): MediaTypeModel;
|
|
@@ -0,0 +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};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getMediaType=void 0;const Sampler=__importStar(require("openapi-sampler")),schema_1=require("./schema"),utils_1=require("../utils"),example_1=require("./example");function generateExamples({parser:e,info:{encoding:t,schema:a},schema:r,mime:i,isRequestType:n,onlyRequiredInSamples:o,generatedPayloadSamplesMaxDepth:s}){const p={skipReadOnly:n,skipWriteOnly:!n,skipNonRequired:n&&o,maxSampleDepth:s};let l={};if(r&&r.oneOf)for(const a of r.oneOf){const n=Sampler.sample(a.rawSchema,p,e.definition);r.discriminatorProp&&"object"==typeof n&&n&&(n[r.discriminatorProp]=a.title),l[a.title]=(0,example_1.getExamples)({parser:e,infoOrRef:{value:n},mime:i,encoding:t})}else r&&(l={default:(0,example_1.getExamples)({parser:e,infoOrRef:{value:Sampler.sample(a,p,e.definition)},mime:i,encoding:t})});return l}function getMediaType(e,t,a,r,i,{operation:n,type:o,response:s}){let p;const l=r.schema&&(0,schema_1.getSchema)({parser:e,schemaOrRef:r.schema,pointer:"",options:i,deps:{operation:n,type:o,response:s}}),{onlyRequiredInSamples:m,generatedPayloadSamplesMaxDepth:u}=i,{encoding:d,examples:c,example:f}=r;return void 0!==c?p=(0,utils_1.mapValues)(c,(a=>(0,example_1.getExamples)({parser:e,infoOrRef:a,mime:t,encoding:d}))):void 0!==f?p={default:(0,example_1.getExamples)({parser:e,infoOrRef:{value:e.deref(f).resolved},mime:t,encoding:d})}:((0,utils_1.isJsonLike)(t)||(0,utils_1.isFormUrlEncoded)(t))&&(p=generateExamples({parser:e,info:r,schema:l,mime:t,isRequestType:a,onlyRequiredInSamples:m,generatedPayloadSamplesMaxDepth:u})),{examples:p,schema:l,name:t,isRequestType:a,onlyRequiredInSamples:m,operation:n}}exports.getMediaType=getMediaType;
|
|
2
|
+
//# sourceMappingURL=mediaType.js.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { ExtendedOpenAPIOperation, Unstable_ExternalCodeSample, OpenAPIParser, Options } from '../services';
|
|
2
|
+
import type { OpenAPIXCodeSample } from '../types';
|
|
3
|
+
import type { MediaContentModel, OperationModel, GroupModel } from './types';
|
|
4
|
+
export interface Sample {
|
|
5
|
+
lang: string;
|
|
6
|
+
label?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface XPayloadSample extends Sample {
|
|
9
|
+
lang: 'payload';
|
|
10
|
+
requestBodyContent: MediaContentModel;
|
|
11
|
+
source: string;
|
|
12
|
+
}
|
|
13
|
+
export interface Callback {
|
|
14
|
+
isCallback: boolean;
|
|
15
|
+
id?: string;
|
|
16
|
+
}
|
|
17
|
+
export declare function isPayloadSample(sample: XPayloadSample | OpenAPIXCodeSample | Unstable_ExternalCodeSample): sample is XPayloadSample;
|
|
18
|
+
export declare function getOperation(parser: OpenAPIParser, operationDefinition: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: Options, href: string, callback?: Callback): OperationModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getOperation=exports.isPayloadSample=void 0;const utils_1=require("../utils"),utils_2=require("../components/rightPanel/utils"),callback_1=require("./callback"),field_1=require("./field"),request_1=require("./request"),security_1=require("./security"),services_1=require("../services"),response_1=require("./response");function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}exports.isPayloadSample=isPayloadSample;let isCodeSamplesWarningPrinted=!1;function getOperation(e,t,s,a,r,i){var l,o,n,p;const d=t.isWebhook,u={operationDefinition:t,parent:s,pointer:t.pointer,description:t.description,externalDocs:t.externalDocs,deprecated:!!t.deprecated,httpVerb:t.httpVerb,operationId:t.operationId,path:t.pathName,isWebhook:d,isCallback:Boolean(null==i?void 0:i.isCallback),isEvent:(null==i?void 0:i.isCallback)||d,name:(0,utils_1.getOperationName)(t),defaultExampleName:t.defaultSampleName,type:"operation",callbackId:null==i?void 0:i.id,href:r,get callbacks(){return Object.keys(t.callbacks||[]).map((i=>{var l;return(0,callback_1.getCallback)(e,i,null===(l=t.callbacks)||void 0===l?void 0:l[i],u.pointer,a,r,s)}))},get responses(){let s=!1;return Object.keys(t.responses||[]).filter((e=>"default"===e||("success"===(0,utils_1.getStatusCodeType)(e)&&(s=!0),(0,utils_1.isStatusCode)(e)))).map((r=>(0,response_1.getResponse)({parser:e,code:r,defaultAsError:s,infoOrRef:t.responses[r],options:a,isEvent:u.isEvent,operation:u})))},get parameters(){let s=(0,utils_1.mergeParams)(e,t.pathParameters,t.parameters).map((t=>(0,field_1.getField)(e,t,u.pointer,a,{operation:u,type:"request"})));return a.sortPropsAlphabetically&&(s=(0,utils_1.sortByField)(s,"name")),a.requiredPropsFirst&&(s=(0,utils_1.sortByRequired)(s)),s}};(null==i?void 0:i.isCallback)?(u.security=(t.security||[]).map((t=>(0,security_1.getSecurityRequirement)({requirement:t,parser:e}))),u.servers=(0,utils_1.normalizeServers)("",t.servers||t.pathServers||[])):(u.id=(0,utils_1.getOperationId)(t,s),u.security=(t.security||e.definition.security||[]).map((t=>(0,security_1.getSecurityRequirement)({requirement:t,parser:e}))),u.servers=(0,utils_1.normalizeServers)(e.definitionUrl,mergeInMockServer(t.servers||t.pathServers||e.definition.servers||[],a.mockServer))),a.showExtensions&&(u.extensions=(0,utils_1.extractExtensions)(t,a.showExtensions)),u.activeServer=(0,utils_2.getInitialServerWithVariables)(u.servers),u.requestBody=t.requestBody&&(0,request_1.getRequestBody)({parser:e,infoOrRef:t.requestBody,options:a,operation:u,isEvent:u.isEvent});const c=null===(o=null===(l=u.requestBody)||void 0===l?void 0:l.content)||void 0===o?void 0:o.mediaTypes,[m]=c||[],[v]=Object.keys((null==m?void 0:m.examples)||[]);u.activeExampleName=!1===t.defaultSampleName?void 0:t.defaultSampleName||v;const g=null===(n=u.requestBody)||void 0===n?void 0:n.content;u.payload=(null==g?void 0:g.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:g}:void 0,u.definitionSamples=t["x-codeSamples"]||t["x-code-samples"]||[],t["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),u.hasSamples=(null==g?void 0:g.hasSample)||u.definitionSamples.length>0;const{payloadSampleIdx:y,hideRequestPayloadSample:S}=a;let f=[];if(!d){const t=a.generateCodeSamples||{},s=new Set(u.definitionSamples.map((({lang:e})=>e.toLowerCase())));f=generateCodeSamples((null===(p=t.languages)||void 0===p?void 0:p.filter((({lang:e})=>!s.has(e.toLowerCase()))))||[],t,e.definition,a.generatedPayloadSamplesMaxDepth)}const h=u.definitionSamples.concat(f),b=Math.min(h.length,y);return u.payload&&!S&&h.splice(b,0,u.payload),u.allCodeSamples=h,u.hideTryItPanel=!0===t["x-hideTryItPanel"],u}function generateCodeSamples(e,{skipOptionalParameters:t,withOAuth2Call:s},a,r){return e.map((({lang:e,label:i,options:l})=>({lang:e,label:i,get:i=>(0,services_1.getCodeSample)(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},l),{skipOptionalParameters:t,withOAuth2Call:s,spec:a,generatedPayloadSamplesMaxDepth:r})}))})))}function mergeInMockServer(e,t){if(!t)return e;const s={url:t.url,description:t.description};switch(t.position){case"first":return[s,...e];case"last":return[...e,s];case"replace":return[s];default:return e}}exports.getOperation=getOperation;
|
|
2
|
+
//# sourceMappingURL=operation.js.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { OpenAPIRequestBody, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser, Options } from '../services';
|
|
3
|
+
import type { RequestBodyModel, OperationModel } from './types';
|
|
4
|
+
type GetRequestBodyInput = {
|
|
5
|
+
parser: OpenAPIParser;
|
|
6
|
+
infoOrRef: Referenced<OpenAPIRequestBody>;
|
|
7
|
+
options: Options;
|
|
8
|
+
isEvent?: boolean;
|
|
9
|
+
operation: OperationModel;
|
|
10
|
+
};
|
|
11
|
+
export declare function getRequestBody({ parser, infoOrRef, options, isEvent, operation, }: GetRequestBodyInput): RequestBodyModel;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getRequestBody=void 0;const utils_1=require("../utils"),mediaContent_1=require("./mediaContent");function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:i,operation:n}){const{resolved:r}=e.deref(t),s=r.description||"",d=!!r.required;let u;const p=!i,a=(0,utils_1.getContentWithLegacyExamples)(r);return void 0!==a&&(u=(0,mediaContent_1.getMediaContent)({parser:e,info:a,isRequestType:p,options:o,data:{operation:n,type:"request"}})),{description:s,required:d,content:u}}exports.getRequestBody=getRequestBody;
|
|
2
|
+
//# sourceMappingURL=request.js.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { OpenAPIResponse, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Options } from 'src/services/Options';
|
|
4
|
+
import type { ResponseModel, OperationModel } from './types';
|
|
5
|
+
type ResponseProps = {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
code: string;
|
|
8
|
+
defaultAsError: boolean;
|
|
9
|
+
infoOrRef: Referenced<OpenAPIResponse>;
|
|
10
|
+
options: Options;
|
|
11
|
+
operation: OperationModel;
|
|
12
|
+
isEvent?: boolean;
|
|
13
|
+
};
|
|
14
|
+
export declare function getResponse({ parser, code, defaultAsError, infoOrRef, options, isEvent, operation, }: ResponseProps): ResponseModel;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getResponse=void 0;const utils_1=require("../utils"),field_1=require("./field"),mediaContent_1=require("./mediaContent");function getResponse({parser:e,code:s,defaultAsError:t,infoOrRef:o,options:n,isEvent:i,operation:r}){var p;const d=!!i,a="all"===n.expandResponses||(null===(p=n.expandResponses)||void 0===p?void 0:p[s])||!1,{resolved:u}=e.deref(o),c={code:s,expanded:a};void 0!==u["x-summary"]?(c.summary=u["x-summary"],c.description=u.description||""):(c.summary=u.description||"",c.description=""),c.type=(0,utils_1.getStatusCodeType)(s,t);const l=u.headers;void 0!==l&&(c.headers=Object.keys(l).map((s=>{const t=l[s];return(0,field_1.getField)(e,Object.assign(Object.assign({},t),{name:s}),"",n,{operation:r,type:"response",response:c})})));const m=(0,utils_1.getContentWithLegacyExamples)(u);return void 0!==m&&(c.content=(0,mediaContent_1.getMediaContent)({parser:e,info:m,isRequestType:d,options:n,data:{operation:r,type:"response",response:c}})),c}exports.getResponse=getResponse;
|
|
2
|
+
//# sourceMappingURL=response.js.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { OpenAPISchema, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Deps, SchemaModel } from './types';
|
|
4
|
+
import type { Options } from 'src/services/Options';
|
|
5
|
+
export declare function getSchema({ parser, schemaOrRef, pointer, options, isChild, baseRefsStack, deps, }: {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
schemaOrRef: Referenced<OpenAPISchema>;
|
|
8
|
+
pointer: string;
|
|
9
|
+
options: Options;
|
|
10
|
+
isChild?: boolean;
|
|
11
|
+
baseRefsStack?: string[];
|
|
12
|
+
deps: Deps;
|
|
13
|
+
}): SchemaModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";var __rest=this&&this.__rest||function(e,i){var t={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&i.indexOf(r)<0&&(t[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(r=Object.getOwnPropertySymbols(e);n<r.length;n++)i.indexOf(r[n])<0&&Object.prototype.propertyIsEnumerable.call(e,r[n])&&(t[r[n]]=e[r[n]])}return t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSchema=void 0;const OpenAPIParser_1=require("../services/OpenAPIParser"),utils_1=require("../utils"),services_1=require("../services"),field_1=require("./field");function getSchema({parser:e,schemaOrRef:i,pointer:t,options:r,isChild:n=!1,baseRefsStack:s=[],deps:a}){var o,l,p,d,c,f,m,u;const{resolved:y,refsStack:O}=e.deref(i,s,!0),h=i.$ref||t||"",v=(0,OpenAPIParser_1.pushRef)(O,h),b=e.mergeAllOf(y,h,v),g=b.type||(0,utils_1.detectType)(b),x={parser:e,options:r,deps:a,schemaOrRef:i,isChild:n,typePrefix:"",pointer:h,refsStack:v,rawSchema:y,type:g,isCircular:!!b["x-circular-ref"],title:b.title||(0,utils_1.isNamedDefinition)(h)&&utils_1.JsonPointer.baseName(h)||"",description:b.description||"",format:b.format,enum:b.enum||[],example:b.example,deprecated:!!b.deprecated,pattern:b.pattern,externalDocs:b.externalDocs,displayFormat:b.format,isPrimitive:(0,utils_1.isPrimitiveType)(b,g),constraints:(0,utils_1.humanizeConstraints)(b),default:b.default,readOnly:!!b.readOnly,writeOnly:!!b.writeOnly,const:b.const||"",contentEncoding:b.contentEncoding,contentMediaType:b.contentMediaType,minItems:b.minItems,maxItems:b.maxItems,nullable:b.nullable||b["x-nullable"],schema:b,displayType:"",items:void 0,extensions:void 0,oneOfType:"",discriminatorProp:void 0,oneOf:void 0,"x-enumDescriptions":b["x-enumDescriptions"],get fields(){return hasType(x,"object")||hasType(x,"array")&&(Array.isArray(b.items)||Array.isArray(b.prefixItems))?buildFields(e,b,h,r,v,a):void 0}};if((b.nullable||b["x-nullable"])&&(Array.isArray(x.type)&&!x.type.some((e=>null===e||"null"===e))?x.type=[...x.type,"null"]:Array.isArray(x.type)||null===x.type&&"null"===x.type||(x.type=[x.type,"null"])),x.displayType=Array.isArray(x.type)?x.type.map((e=>null===e?"null":e)).join(" or "):x.type,x.isCircular)return x;if(b.if&&b.then||b.if&&b.else){const{oneOf:i,oneOfType:t}=initConditionalOperators({schema:b,parser:e,pointer:h,options:r,deps:a,refsStack:v});return x.oneOf=i,x.oneOfType=t,x}if(!n&&void 0!==getDiscriminator(b)){const{oneOf:i,discriminatorProp:t}=initDiscriminator({schema:b,parser:e,deps:a,mergedSchema:b,options:r,pointer:h,refsStack:v});return x.oneOf=i,x.discriminatorProp=t,x}if(n&&Array.isArray(b.oneOf)&&b.oneOf.find((e=>e.$ref===h))&&delete b.oneOf,void 0!==b.oneOf){const{oneOf:i,displayType:t}=initOneOf({schemaOneOf:b.oneOf,parser:e,deps:a,options:r,pointer:h,refsStack:v,schema:b});return x.oneOfType="One of",i&&(x.oneOf=i),x.displayType=t,void 0!==b.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${h}`),x}if(void 0!==b.anyOf){const{oneOf:i,displayType:t}=initOneOf({schemaOneOf:b.anyOf,parser:e,deps:a,options:r,pointer:h,refsStack:v,schema:b});return i&&(x.oneOf=i),x.displayType=t,x.oneOfType="Any of",x}if(hasType(x,"array")&&(b.items&&(x.items=getSchema({parser:e,schemaOrRef:b.items,pointer:h+"/items",options:r,baseRefsStack:v,deps:a})),x.displayType=b.prefixItems||Array.isArray(b.items)?"items":(0,utils_1.pluralizeType)((null===(o=x.items)||void 0===o?void 0:o.displayType)||x.displayType),x.displayFormat=(null===(l=x.items)||void 0===l?void 0:l.format)||"",x.typePrefix=(null===(p=x.items)||void 0===p?void 0:p.typePrefix)||""+(0,services_1.l)("arrayOf"),x.title=x.title||(null===(d=x.items)||void 0===d?void 0:d.title)||"",x.isPrimitive=void 0!==(null===(c=x.items)||void 0===c?void 0:c.isPrimitive)?null===(f=x.items)||void 0===f?void 0:f.isPrimitive:x.isPrimitive,void 0===x.example&&void 0!==(null===(m=x.items)||void 0===m?void 0:m.example)&&(x.example=[x.items.example]),(null===(u=x.items)||void 0===u?void 0:u.isPrimitive)&&(x.enum=x.items.enum,x["x-enumDescriptions"]=x.items["x-enumDescriptions"]),Array.isArray(x.type))){const e=x.type.filter((e=>"array"!==e));e.length&&(x.displayType+=` or ${e.join(" or ")}`)}return x.enum.length&&r.sortEnumValuesAlphabetically&&x.enum.sort(),r.showExtensions&&(x.extensions=(0,utils_1.extractExtensions)(b,r.showExtensions)),x}function initDiscriminator({schema:e,parser:i,pointer:t,options:r,refsStack:n,deps:s,mergedSchema:a}){const o=getDiscriminator(e),l=null==o?void 0:o.propertyName,p=i.findDerived([...a["x-parentRefs"]||[],t]);if(e.oneOf)for(const i of e.oneOf){if(void 0===i.$ref)continue;const e=utils_1.JsonPointer.baseName(i.$ref);p[i.$ref]=e}const d=(null==o?void 0:o.mapping)||{};let c=(null==o?void 0:o["x-explicitMappingOnly"])||!1;0===Object.keys(d).length&&(c=!1);const f={};for(const e in d){const i=d[e];Array.isArray(f[i])?f[i].push(e):f[i]=[e]}const m=c?Object.assign({},f):Object.assign(Object.assign({},p),f);let u=[];for(const e of Object.keys(m)){const i=m[e];if(Array.isArray(i))for(const t of i)u.push({$ref:e,name:t});else u.push({$ref:e,name:i})}const y=Object.keys(d);0!==y.length&&(u=u.sort(((e,i)=>{const t=y.indexOf(e.name),r=y.indexOf(i.name);return t<0&&r<0?e.name.localeCompare(i.name):t<0?1:r<0?-1:t-r})));return{oneOf:u.map((({$ref:e,name:t},a)=>{const o=getSchema({parser:i,schemaOrRef:{$ref:e},pointer:e,options:r,isChild:!0,baseRefsStack:n.slice(0,-1),deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+a:a.toString()})});return o.title=t,o})),discriminatorProp:l}}function initOneOf({schemaOneOf:e,parser:i,refsStack:t,pointer:r,schema:n,options:s,deps:a}){const o=e.map(((e,o)=>{const{resolved:l,refsStack:p}=i.deref(e,t,!0),d=i.mergeAllOf(l,r+"/oneOf/"+o,p),c=(0,utils_1.isNamedDefinition)(e.$ref)&&!d.title?utils_1.JsonPointer.baseName(e.$ref):`${d.title||""}${d.const&&JSON.stringify(d.const)||""}`;return getSchema({parser:i,schemaOrRef:Object.assign(Object.assign({},d),{title:c,allOf:[Object.assign(Object.assign({},n),{oneOf:void 0,anyOf:void 0})],discriminator:l.allOf?void 0:d.discriminator}),pointer:e.$ref||r+"/oneOf/"+o,options:s,baseRefsStack:p,deps:Object.assign(Object.assign({},a),{parentFieldFullPath:a.parentFieldFullPath?a.parentFieldFullPath+"/"+o:o.toString()})})}));let l;if(s.simpleOneOfTypeLabel){l=collectUniqueOneOfTypesDeep(n).join(" or ")}else l=o.map((e=>{let i=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return i.indexOf(" or ")>-1&&(i=`(${i})`),i})).join(" or ");return{oneOf:o,displayType:l}}function initConditionalOperators({schema:e,parser:i,pointer:t,options:r,refsStack:n,deps:s}){const{if:a,else:o={},then:l={}}=e,p=__rest(e,["if","else","then"]);return{oneOf:[{allOf:[p,l,a],title:a&&a["x-displayName"]||(null==a?void 0:a.title)||"case 1"},{allOf:[p,o],title:o&&o["x-displayName"]||(null==o?void 0:o.title)||"case 2"}].map(((e,a)=>getSchema({parser:i,schemaOrRef:Object.assign({},e),pointer:t+"/oneOf/"+a,options:r,baseRefsStack:n,deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+a:a.toString()})}))),oneOfType:"One of"}}function normalizeField(e,i,t){return e||(console.warn(`Field "${i}" is invalid, skipping.\n Field must be an object but got ${typeof e} at "${t}"`),{})}function buildFields(e,i,t,r,n,s){const a=i.properties||i.prefixItems||i.items||{},o=i.patternProperties||{},l=i.additionalProperties||i.unevaluatedProperties,p=i.prefixItems?i.items:i.additionalItems,d=i.default||{};let c=Object.keys(a).map((o=>{var l;const p=normalizeField(a[o],o,t),c=void 0!==i.required&&i.required.indexOf(o)>-1;return(0,field_1.getField)(e,{name:i.properties?o:`[${o}]`,required:c,schema:Object.assign(Object.assign({},p),{example:(null===(l=i.example)||void 0===l?void 0:l[o])||p.example,default:void 0===p.default&&d?d[o]:p.default})},t+"/properties/"+o,r,s,n)}));return r.sortPropsAlphabetically&&(c=(0,utils_1.sortByField)(c,"name")),r.requiredPropsFirst&&(c=(0,utils_1.sortByRequired)(c,r.sortPropsAlphabetically?void 0:i.required)),c.push(...Object.keys(o).map((i=>{const a=normalizeField(o[i],i,t);return(0,field_1.getField)(e,{name:i,required:!1,schema:a,kind:"patternProperties"},`${t}/patternProperties/${i}`,r,s,n)}))),((0,utils_1.isObject)(l)||!0===l)&&c.push((0,field_1.getField)(e,{name:((0,utils_1.isObject)(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},t+"/additionalProperties",r,s,n)),c.push(...buildAdditionalItems({parser:e,schema:p,fieldsCount:c.length,$ref:t,options:r,refsStack:n,deps:s})),c}function buildAdditionalItems({parser:e,schema:i=!1,fieldsCount:t,$ref:r,options:n,refsStack:s,deps:a}){return"boolean"==typeof i?i?[(0,field_1.getField)(e,{name:`[${t}...]`,schema:{},kind:"additionalItems"},`${r}/additionalItems`,n,a,s)]:[]:Array.isArray(i)?[...i.map(((i,o)=>(0,field_1.getField)(e,{name:`[${t+o}]`,schema:i,kind:"additionalItems"},`${r}/additionalItems/${o}`,n,a,s)))]:(0,utils_1.isObject)(i)?[(0,field_1.getField)(e,{name:`[${t}...]`,schema:i,kind:"additionalItems"},`${r}/additionalItems`,n,a,s)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function collectUniqueOneOfTypesDeep(e){const i=new Set;return function e(t){for(const r of t.oneOf||[])r.oneOf?e(r):r.type&&i.add(r.type)}(e),Array.from(i.values())}function hasType(e,i){return e.type===i||Array.isArray(e.type)&&e.type.includes(i)}exports.getSchema=getSchema;
|
|
2
|
+
//# sourceMappingURL=schema.js.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { OpenAPISecurityRequirement, OpenAPISecurityScheme, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { SecurityRequirement, SecurityScheme } from './types';
|
|
4
|
+
type GetSecurityRequirementsInput = {
|
|
5
|
+
requirement: OpenAPISecurityRequirement;
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
};
|
|
8
|
+
export declare function getSecurityRequirement({ requirement, parser, }: GetSecurityRequirementsInput): SecurityRequirement;
|
|
9
|
+
export declare function getSecurityScheme(parser: Partial<OpenAPIParser>, id: string, scheme: Referenced<OpenAPISecurityScheme>): SecurityScheme;
|
|
10
|
+
export declare function getSecuritySchemes({ parser, }: {
|
|
11
|
+
parser: Partial<OpenAPIParser>;
|
|
12
|
+
}): Array<SecurityScheme>;
|
|
13
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";function getSecurityRequirement({requirement:e,parser:t}){const r=t.definition.components&&t.definition.components.securitySchemes||{};return{schemes:Object.keys(e||{}).map((i=>{const c=t.deref(r[i]).resolved,n=e[i]||[];if(c)return Object.assign(Object.assign({},c),{id:i,sectionId:i,scopes:n});console.warn(`Non existing security scheme referenced: ${i}. Skipping`)})).filter(Boolean)}}function getSecurityScheme(e,t,r){if(!(null==e?void 0:e.deref))return{};const{resolved:i}=e.deref(r),c=t,n=i.type,s=i.description||"";let o,u,p,m={};switch(i.type){case"apiKey":o={name:i.name,in:i.in};break;case"http":u={scheme:i.scheme,bearerFormat:i.bearerFormat};break;case"openIdConnect":p={connectUrl:i.openIdConnectUrl};break;case"oauth2":m=i.flows}return{id:t,sectionId:c,type:n,description:s,apiKey:o,http:u,flows:m,openId:p}}function getSecuritySchemes({parser:e}){var t,r;if(!e)return[];const i=(null===(r=null===(t=e.definition)||void 0===t?void 0:t.components)||void 0===r?void 0:r.securitySchemes)||{};return Object.keys(i).map((t=>getSecurityScheme(e,t,i[t])))}Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSecuritySchemes=exports.getSecurityScheme=exports.getSecurityRequirement=void 0,exports.getSecurityRequirement=getSecurityRequirement,exports.getSecurityScheme=getSecurityScheme,exports.getSecuritySchemes=getSecuritySchemes;
|
|
2
|
+
//# sourceMappingURL=security.js.map
|
package/lib/models/types.d.ts
CHANGED
|
@@ -1,3 +1,230 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
|
|
1
|
+
import type { Node } from '@markdoc/markdoc';
|
|
2
|
+
import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, Server, OpenAPIServer, OpenAPIXCodeSample, OpenAPISchema, Referenced } from '../types';
|
|
3
|
+
import type { OpenAPIParser } from '../services/OpenAPIParser';
|
|
4
|
+
import type { Options } from '../services/Options';
|
|
5
|
+
import type { ExtendedOpenAPIOperation, MenuItemGroupType, MenuItemType, MergedOpenAPISchema, Unstable_ExternalCodeSample } from '../services/types';
|
|
6
|
+
export type ContentItemModel = GroupModel | OperationMenuItem;
|
|
7
|
+
export interface ExtendedOpenAPISecurityScheme extends OpenAPISecurityScheme {
|
|
8
|
+
id: string;
|
|
9
|
+
sectionId: string;
|
|
10
|
+
scopes: string[];
|
|
11
|
+
'x-defaultClientId'?: string;
|
|
12
|
+
}
|
|
13
|
+
export interface SecurityRequirement {
|
|
14
|
+
schemes: ExtendedOpenAPISecurityScheme[];
|
|
15
|
+
}
|
|
16
|
+
export interface SecurityScheme {
|
|
17
|
+
id: string;
|
|
18
|
+
sectionId: string;
|
|
19
|
+
type: OpenAPISecurityScheme['type'];
|
|
20
|
+
description: string | GenericObject;
|
|
21
|
+
apiKey?: {
|
|
22
|
+
name: string;
|
|
23
|
+
in: OpenAPISecurityScheme['in'];
|
|
24
|
+
};
|
|
25
|
+
http?: {
|
|
26
|
+
scheme: string;
|
|
27
|
+
bearerFormat?: string;
|
|
28
|
+
};
|
|
29
|
+
openId?: {
|
|
30
|
+
connectUrl: string;
|
|
31
|
+
};
|
|
32
|
+
flows: OpenAPISecurityScheme['flows'];
|
|
33
|
+
}
|
|
34
|
+
export type RequestBodyModel = {
|
|
35
|
+
description: string | GenericObject;
|
|
36
|
+
required: boolean;
|
|
37
|
+
content: MediaContentModel | undefined;
|
|
38
|
+
};
|
|
39
|
+
export type ExampleModel = {
|
|
40
|
+
value: any;
|
|
41
|
+
rawValue: any;
|
|
42
|
+
externalValueUrl?: string;
|
|
43
|
+
summary?: string;
|
|
44
|
+
description?: string | GenericObject;
|
|
45
|
+
mime: string;
|
|
46
|
+
encoding?: {
|
|
47
|
+
[field: string]: OpenAPIEncoding;
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
export type MediaTypeModel = {
|
|
51
|
+
examples?: {
|
|
52
|
+
[name: string]: ExampleModel;
|
|
53
|
+
};
|
|
54
|
+
schema?: SchemaModel;
|
|
55
|
+
name: string;
|
|
56
|
+
isRequestType: boolean;
|
|
57
|
+
onlyRequiredInSamples: boolean;
|
|
58
|
+
operation: OperationModel;
|
|
59
|
+
};
|
|
60
|
+
export type MediaContentModel = {
|
|
61
|
+
mediaTypes: MediaTypeModel[];
|
|
62
|
+
isRequestType: boolean;
|
|
63
|
+
hasSample: boolean;
|
|
64
|
+
operation: OperationModel;
|
|
65
|
+
};
|
|
66
|
+
export type MediaContentModelInput = {
|
|
67
|
+
parser: OpenAPIParser;
|
|
68
|
+
info: Record<string, OpenAPIMediaType>;
|
|
69
|
+
isRequestType: boolean;
|
|
70
|
+
options: Options;
|
|
71
|
+
data: {
|
|
72
|
+
operation: OperationModel;
|
|
73
|
+
type?: 'request' | 'response';
|
|
74
|
+
response?: ResponseModel;
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
export type ResponseModel = {
|
|
78
|
+
expanded: boolean;
|
|
79
|
+
content?: MediaContentModel;
|
|
80
|
+
code: string;
|
|
81
|
+
summary: string | GenericObject;
|
|
82
|
+
description: string | GenericObject;
|
|
83
|
+
type: string;
|
|
84
|
+
headers: FieldModel[];
|
|
85
|
+
};
|
|
86
|
+
export type FieldModel = {
|
|
87
|
+
schema: SchemaModel;
|
|
88
|
+
name: string;
|
|
89
|
+
required: boolean;
|
|
90
|
+
description: string | GenericObject;
|
|
91
|
+
example?: string;
|
|
92
|
+
examples?: Record<string, ExampleModel>;
|
|
93
|
+
deprecated: boolean;
|
|
94
|
+
in?: OpenAPIParameterLocation;
|
|
95
|
+
kind: string;
|
|
96
|
+
extensions?: GenericObject;
|
|
97
|
+
explode: boolean;
|
|
98
|
+
style?: OpenAPIParameterStyle;
|
|
99
|
+
const?: any;
|
|
100
|
+
serializationMime?: string;
|
|
101
|
+
fieldFullPath?: string;
|
|
102
|
+
deps: Deps;
|
|
103
|
+
};
|
|
104
|
+
export type CallbackModel = {
|
|
105
|
+
name: string;
|
|
106
|
+
operations: OperationModel[];
|
|
107
|
+
};
|
|
108
|
+
export type OperationModel = {
|
|
109
|
+
id: string;
|
|
110
|
+
absoluteIdx?: number;
|
|
111
|
+
name: string;
|
|
112
|
+
description?: string | GenericObject;
|
|
113
|
+
ast?: Node[];
|
|
114
|
+
href: string;
|
|
115
|
+
type: MenuItemType;
|
|
116
|
+
parent?: GroupModel;
|
|
117
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
118
|
+
items: ContentItemModel[];
|
|
119
|
+
depth: number;
|
|
120
|
+
activeExampleName?: string;
|
|
121
|
+
activeServer: Server;
|
|
122
|
+
defaultExampleName?: string | false;
|
|
123
|
+
defaultMimeType?: string;
|
|
124
|
+
pointer: string;
|
|
125
|
+
operationId?: string;
|
|
126
|
+
httpVerb: string;
|
|
127
|
+
deprecated: boolean;
|
|
128
|
+
path: string;
|
|
129
|
+
servers: OpenAPIServer[];
|
|
130
|
+
security: SecurityRequirement[];
|
|
131
|
+
extensions: GenericObject;
|
|
132
|
+
isCallback: boolean;
|
|
133
|
+
isWebhook: boolean;
|
|
134
|
+
isEvent: boolean;
|
|
135
|
+
callbackId: string;
|
|
136
|
+
requestBody?: RequestBodyModel;
|
|
137
|
+
payload?: {
|
|
138
|
+
lang: string;
|
|
139
|
+
label: string;
|
|
140
|
+
source: string;
|
|
141
|
+
requestBodyContent: MediaContentModel;
|
|
142
|
+
};
|
|
143
|
+
definitionSamples?: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
|
|
144
|
+
hasSamples: boolean;
|
|
145
|
+
allCodeSamples: OpenAPIXCodeSample[];
|
|
146
|
+
parameters: FieldModel[];
|
|
147
|
+
responses: ResponseModel[];
|
|
148
|
+
callbacks: CallbackModel[];
|
|
149
|
+
hideTryItPanel: boolean;
|
|
150
|
+
};
|
|
151
|
+
export type GroupModel = {
|
|
152
|
+
id: string;
|
|
153
|
+
href: string;
|
|
154
|
+
name: string;
|
|
155
|
+
description?: string | GenericObject;
|
|
156
|
+
isSchema?: boolean;
|
|
157
|
+
type: MenuItemGroupType;
|
|
158
|
+
items: ContentItemModel[];
|
|
159
|
+
ast?: Node[];
|
|
160
|
+
parent?: GroupModel;
|
|
161
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
162
|
+
depth: number;
|
|
163
|
+
level: number;
|
|
164
|
+
};
|
|
165
|
+
export type OperationMenuItem = {
|
|
166
|
+
id: string;
|
|
167
|
+
href: string;
|
|
168
|
+
name: string;
|
|
169
|
+
operationDefinition: ExtendedOpenAPIOperation;
|
|
170
|
+
depth: number;
|
|
171
|
+
items: ContentItemModel[];
|
|
172
|
+
parent?: GroupModel;
|
|
173
|
+
deprecated?: boolean;
|
|
174
|
+
type: 'operation';
|
|
175
|
+
httpVerb: string;
|
|
176
|
+
path: string;
|
|
177
|
+
isWebhook: boolean;
|
|
178
|
+
operationId?: string;
|
|
179
|
+
};
|
|
180
|
+
export type SchemaModel = {
|
|
181
|
+
parser: OpenAPIParser;
|
|
182
|
+
options: Options;
|
|
183
|
+
deps: Deps;
|
|
184
|
+
schemaOrRef: Referenced<OpenAPISchema>;
|
|
185
|
+
isChild: boolean;
|
|
186
|
+
refsStack: string[];
|
|
187
|
+
pointer: string;
|
|
188
|
+
type: string | string[];
|
|
189
|
+
displayType: string;
|
|
190
|
+
typePrefix: string;
|
|
191
|
+
title: string;
|
|
192
|
+
description: string | GenericObject;
|
|
193
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
194
|
+
isPrimitive: boolean;
|
|
195
|
+
isCircular: boolean;
|
|
196
|
+
format?: string;
|
|
197
|
+
displayFormat?: string;
|
|
198
|
+
nullable: boolean;
|
|
199
|
+
deprecated: boolean;
|
|
200
|
+
pattern?: string;
|
|
201
|
+
example?: any;
|
|
202
|
+
enum: any[];
|
|
203
|
+
default?: any;
|
|
204
|
+
readOnly: boolean;
|
|
205
|
+
writeOnly: boolean;
|
|
206
|
+
constraints: string[];
|
|
207
|
+
fields?: FieldModel[];
|
|
208
|
+
items?: SchemaModel;
|
|
209
|
+
oneOf?: SchemaModel[];
|
|
210
|
+
oneOfType: string;
|
|
211
|
+
discriminatorProp?: string;
|
|
212
|
+
rawSchema: OpenAPISchema;
|
|
213
|
+
schema: MergedOpenAPISchema;
|
|
214
|
+
extensions?: GenericObject;
|
|
215
|
+
'x-enumDescriptions'?: {
|
|
216
|
+
[name: string]: string;
|
|
217
|
+
};
|
|
218
|
+
const: any;
|
|
219
|
+
contentEncoding?: string;
|
|
220
|
+
contentMediaType?: string;
|
|
221
|
+
minItems?: number;
|
|
222
|
+
maxItems?: number;
|
|
223
|
+
};
|
|
224
|
+
export type Deps = {
|
|
225
|
+
parentFieldFullPath?: string;
|
|
226
|
+
operation: OperationModel;
|
|
227
|
+
type?: 'request' | 'response';
|
|
228
|
+
response?: ResponseModel;
|
|
229
|
+
in?: string;
|
|
230
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { CodeSampleConfig } from '../services';
|
|
2
|
+
import type { OperationModel } from '../models';
|
|
3
|
+
import { LayoutVariant } from '../constants';
|
|
4
|
+
export type AppSessionStore = {
|
|
5
|
+
activeVersionIdx: number;
|
|
6
|
+
showRightPanelToggle: boolean;
|
|
7
|
+
};
|
|
8
|
+
export type AppLocalStore = {
|
|
9
|
+
layout: LayoutVariant;
|
|
10
|
+
activeSampleLanguage: CodeSampleConfig['lang'] | string;
|
|
11
|
+
};
|
|
12
|
+
export type AppStore = {
|
|
13
|
+
isSidebarOpened: boolean;
|
|
14
|
+
tryItOperation?: OperationModel;
|
|
15
|
+
activeMimeName: string;
|
|
16
|
+
};
|
|
17
|
+
export declare const appStore: import("recoil").RecoilState<AppStore>;
|
|
18
|
+
export declare const isSidebarOpenedSelector: import("recoil").RecoilState<boolean>;
|
|
19
|
+
export declare const activeMimeNameSelector: import("recoil").RecoilState<string>;
|
|
20
|
+
export declare const tryItOperationSelector: import("recoil").RecoilState<OperationModel | undefined>;
|
|
21
|
+
/**
|
|
22
|
+
* appLocalStore saved to local storage
|
|
23
|
+
*/
|
|
24
|
+
export declare const appLocalStore: import("recoil").RecoilState<AppLocalStore>;
|
|
25
|
+
export declare const layoutSelector: import("recoil").RecoilState<LayoutVariant>;
|
|
26
|
+
export declare const activeSampleLanguageSelector: import("recoil").RecoilState<string>;
|
|
27
|
+
/**
|
|
28
|
+
* appSessionStore saved to session storage
|
|
29
|
+
*/
|
|
30
|
+
export declare const appSessionStore: import("recoil").RecoilState<AppSessionStore>;
|
|
31
|
+
export declare const showRightPanelToggleSelector: import("recoil").RecoilState<boolean>;
|
|
32
|
+
export declare const activeVersionIdxSelector: import("recoil").RecoilState<number>;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.activeVersionIdxSelector=exports.showRightPanelToggleSelector=exports.appSessionStore=exports.activeSampleLanguageSelector=exports.layoutSelector=exports.appLocalStore=exports.tryItOperationSelector=exports.activeMimeNameSelector=exports.isSidebarOpenedSelector=exports.appStore=void 0;const recoil_1=require("recoil"),utils_1=require("../utils"),constants_1=require("../constants");exports.appStore=(0,recoil_1.atom)({key:"appStore",default:{isSidebarOpened:!1,tryItOperation:void 0,activeMimeName:""}}),exports.isSidebarOpenedSelector=(0,recoil_1.selector)({key:"isSidebarOpened",get:({get:e})=>e(exports.appStore).isSidebarOpened,set:({set:e,get:t},o)=>{const s=t(exports.appStore);e(exports.appStore,Object.assign(Object.assign({},s),{isSidebarOpened:o}))}}),exports.activeMimeNameSelector=(0,recoil_1.selector)({key:"activeMimeName",get:({get:e})=>e(exports.appStore).activeMimeName,set:({set:e,get:t},o)=>{const s=t(exports.appStore);e(exports.appStore,Object.assign(Object.assign({},s),{activeMimeName:o}))}}),exports.tryItOperationSelector=(0,recoil_1.selector)({key:"tryItOperation",get:({get:e})=>e(exports.appStore).tryItOperation,set:({set:e,get:t},o)=>{if(o instanceof recoil_1.DefaultValue)return;const s=t(exports.appStore);e(exports.appStore,Object.assign(Object.assign({},s),{tryItOperation:o}))}}),exports.appLocalStore=(0,recoil_1.atom)({key:"appLocalStore",default:{layout:constants_1.LayoutVariant.THREE_PANEL,activeSampleLanguage:""},effects:[({onSet:e,setSelf:t})=>{const o=(0,utils_1.fromLocalStorage)("appLocalStore");null!=o&&""!==o&&t(JSON.parse(o)),e((e=>{e instanceof recoil_1.DefaultValue?utils_1.IS_BROWSER&&localStorage.removeItem("appLocalStore"):(0,utils_1.toLocalStorage)("appLocalStore",JSON.stringify(e))}))}]}),exports.layoutSelector=(0,recoil_1.selector)({key:"layout",get:({get:e})=>e(exports.appLocalStore).layout,set:({set:e,get:t},o=constants_1.LayoutVariant.STACKED)=>{const s=t(exports.appLocalStore),a=o===constants_1.LayoutVariant.STACKED?constants_1.LayoutVariant.THREE_PANEL:constants_1.LayoutVariant.STACKED;e(exports.appLocalStore,Object.assign(Object.assign({},s),{layout:a}))}}),exports.activeSampleLanguageSelector=(0,recoil_1.selector)({key:"activeSampleLanguage",get:({get:e})=>e(exports.appLocalStore).activeSampleLanguage,set:({set:e,get:t},o)=>{const s=t(exports.appLocalStore);e(exports.appLocalStore,Object.assign(Object.assign({},s),{activeSampleLanguage:o}))}}),exports.appSessionStore=(0,recoil_1.atom)({key:"appSessionStore",default:{activeVersionIdx:0,showRightPanelToggle:!0},effects:[({onSet:e,setSelf:t})=>{const o=(0,utils_1.fromSessionStorage)("appSessionStore");null!=o&&""!==o&&t(JSON.parse(o)),e((e=>{e instanceof recoil_1.DefaultValue?utils_1.IS_BROWSER&&localStorage.removeItem("appSessionStore"):(0,utils_1.toSessionStorage)("appSessionStore",JSON.stringify(e))}))}]}),exports.showRightPanelToggleSelector=(0,recoil_1.selector)({key:"showRightPanelToggle",get:({get:e})=>e(exports.appSessionStore).showRightPanelToggle,set:({set:e,get:t},o)=>{const s=t(exports.appSessionStore);e(exports.appSessionStore,Object.assign(Object.assign({},s),{showRightPanelToggle:o}))}}),exports.activeVersionIdxSelector=(0,recoil_1.selector)({key:"activeVersionIdx",get:({get:e})=>e(exports.appSessionStore).activeVersionIdx,set:({set:e,get:t},o)=>{const s=t(exports.appSessionStore);e(exports.appSessionStore,Object.assign(Object.assign({},s),{activeVersionIdx:o}))}});
|
|
2
|
+
//# sourceMappingURL=app.js.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { Server } from '../types/server';
|
|
2
|
+
type OperationStore = {
|
|
3
|
+
activeExampleName?: string;
|
|
4
|
+
activeOneOf: number;
|
|
5
|
+
activeServer?: Server;
|
|
6
|
+
requestValues: {
|
|
7
|
+
[field: string]: any;
|
|
8
|
+
};
|
|
9
|
+
};
|
|
10
|
+
export declare const operationStore: (param: string) => import("recoil").RecoilState<OperationStore>;
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.operationStore=void 0;const recoil_1=require("recoil");exports.operationStore=(0,recoil_1.atomFamily)({key:"operation",default:{activeExampleName:void 0,activeOneOf:0,activeServer:void 0,requestValues:{}}});
|
|
2
|
+
//# sourceMappingURL=operation.js.map
|