redoc 2.5.4 → 3.0.0-rc.1
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/LICENSE +2 -2
- package/README.md +90 -52
- package/bundles/redoc.d.ts +1860 -0
- package/bundles/redoc.js +13775 -0
- package/bundles/redoc.standalone.d.ts +1574 -0
- package/bundles/redoc.standalone.js +13547 -1562
- package/package.json +107 -186
- package/typings/.tsbuildinfo +1 -0
- package/typings/RedocStandalone.d.ts +36 -0
- package/typings/RedoclyApiDocs.d.ts +23 -0
- package/typings/RedoclyApiDocsStandalone.d.ts +22 -0
- package/typings/adapters/asyncapi/build/context.d.ts +9 -0
- package/typings/adapters/asyncapi/build/navigation.d.ts +2 -0
- package/typings/adapters/asyncapi/build/utils.d.ts +3 -0
- package/typings/adapters/asyncapi/buildContext.d.ts +2 -0
- package/typings/adapters/asyncapi/index.d.ts +13 -0
- package/typings/adapters/asyncapi/items/channel/content.d.ts +5 -0
- package/typings/adapters/asyncapi/items/channel/item.d.ts +13 -0
- package/typings/adapters/asyncapi/items/operation/content.d.ts +4 -0
- package/typings/adapters/asyncapi/items/operation/item.d.ts +15 -0
- package/typings/adapters/asyncapi/items/overview/content.d.ts +10 -0
- package/typings/adapters/asyncapi/items/overview/item.d.ts +16 -0
- package/typings/adapters/asyncapi/panels/brokers.d.ts +4 -0
- package/typings/adapters/asyncapi/panels/download.d.ts +3 -0
- package/typings/adapters/asyncapi/panels/group.d.ts +16 -0
- package/typings/adapters/asyncapi/panels/overview.d.ts +3 -0
- package/typings/adapters/asyncapi/store.d.ts +3 -0
- package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts +4 -0
- package/typings/adapters/asyncapi/utils/get-channel-label.d.ts +3 -0
- package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts +24 -0
- package/typings/adapters/asyncapi/utils/get-server-host.d.ts +3 -0
- package/typings/adapters/asyncapi/utils/resolve-schema.d.ts +2 -0
- package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts +2 -0
- package/typings/adapters/build.d.ts +31 -0
- package/typings/adapters/graphql/build/context.d.ts +9 -0
- package/typings/adapters/graphql/buildContext.d.ts +2 -0
- package/typings/adapters/graphql/buildStoreFromSdl.d.ts +2 -0
- package/typings/adapters/graphql/group/custom.d.ts +2 -0
- package/typings/adapters/graphql/group/default.d.ts +2 -0
- package/typings/adapters/graphql/group/errors.d.ts +1 -0
- package/typings/adapters/graphql/group/itemBuilders.d.ts +5 -0
- package/typings/adapters/graphql/group/utils.d.ts +8 -0
- package/typings/adapters/graphql/index.d.ts +10 -0
- package/typings/adapters/graphql/items/directive/content.d.ts +4 -0
- package/typings/adapters/graphql/items/directive/item.d.ts +3 -0
- package/typings/adapters/graphql/items/enum/content.d.ts +4 -0
- package/typings/adapters/graphql/items/enum/item.d.ts +3 -0
- package/typings/adapters/graphql/items/input/content.d.ts +4 -0
- package/typings/adapters/graphql/items/input/item.d.ts +3 -0
- package/typings/adapters/graphql/items/interface/content.d.ts +4 -0
- package/typings/adapters/graphql/items/interface/item.d.ts +3 -0
- package/typings/adapters/graphql/items/mutation/content.d.ts +4 -0
- package/typings/adapters/graphql/items/mutation/item.d.ts +3 -0
- package/typings/adapters/graphql/items/object/content.d.ts +4 -0
- package/typings/adapters/graphql/items/object/item.d.ts +3 -0
- package/typings/adapters/graphql/items/operation/content.d.ts +7 -0
- package/typings/adapters/graphql/items/overview/content.d.ts +11 -0
- package/typings/adapters/graphql/items/overview/item.d.ts +4 -0
- package/typings/adapters/graphql/items/query/content.d.ts +4 -0
- package/typings/adapters/graphql/items/query/item.d.ts +3 -0
- package/typings/adapters/graphql/items/scalar/content.d.ts +4 -0
- package/typings/adapters/graphql/items/scalar/item.d.ts +3 -0
- package/typings/adapters/graphql/items/subscription/content.d.ts +4 -0
- package/typings/adapters/graphql/items/subscription/item.d.ts +3 -0
- package/typings/adapters/graphql/items/types.d.ts +7 -0
- package/typings/adapters/graphql/items/union/content.d.ts +4 -0
- package/typings/adapters/graphql/items/union/item.d.ts +3 -0
- package/typings/adapters/graphql/panels/download.d.ts +3 -0
- package/typings/adapters/graphql/panels/group-items.d.ts +4 -0
- package/typings/adapters/graphql/panels/overview.d.ts +3 -0
- package/typings/adapters/graphql/serializeType.d.ts +5 -0
- package/typings/adapters/graphql/store.d.ts +3 -0
- package/typings/adapters/graphql/utils/configMetadataRows.d.ts +3 -0
- package/typings/adapters/graphql/utils/constants.d.ts +23 -0
- package/typings/adapters/graphql/utils/createApiItem.d.ts +15 -0
- package/typings/adapters/graphql/utils/getBadges.d.ts +4 -0
- package/typings/adapters/graphql/utils/ignoreInternalItems.d.ts +3 -0
- package/typings/adapters/graphql/utils/isRootType.d.ts +2 -0
- package/typings/adapters/graphql/utils/menuSlashRegex.d.ts +1 -0
- package/typings/adapters/graphql/utils/normalizeMenu.d.ts +3 -0
- package/typings/adapters/graphql/utils/shouldIncludeItem.d.ts +2 -0
- package/typings/adapters/graphql/utils/summary.d.ts +4 -0
- package/typings/adapters/graphql/utils/validateMenuConfig.d.ts +3 -0
- package/typings/adapters/helpers.d.ts +40 -0
- package/typings/adapters/openapi/build/context.d.ts +13 -0
- package/typings/adapters/openapi/build-code-sample-source.d.ts +4 -0
- package/typings/adapters/openapi/buildContext.d.ts +2 -0
- package/typings/adapters/openapi/configure/apply-request-values.d.ts +3 -0
- package/typings/adapters/openapi/configure/index.d.ts +3 -0
- package/typings/adapters/openapi/configure/merge-utils.d.ts +30 -0
- package/typings/adapters/openapi/configure/resolve-request-values.d.ts +15 -0
- package/typings/adapters/openapi/constants.d.ts +4 -0
- package/typings/adapters/openapi/group/content.d.ts +25 -0
- package/typings/adapters/openapi/group/item.d.ts +8 -0
- package/typings/adapters/openapi/index.d.ts +13 -0
- package/typings/adapters/openapi/items/mcp/content.d.ts +5 -0
- package/typings/adapters/openapi/items/mcp/item.d.ts +9 -0
- package/typings/adapters/openapi/items/operation/content.d.ts +12 -0
- package/typings/adapters/openapi/items/operation/item.d.ts +9 -0
- package/typings/adapters/openapi/items/overview/content.d.ts +17 -0
- package/typings/adapters/openapi/items/overview/item.d.ts +3 -0
- package/typings/adapters/openapi/items/schema/content.d.ts +3 -0
- package/typings/adapters/openapi/items/schema/item.d.ts +9 -0
- package/typings/adapters/openapi/panels/download.d.ts +3 -0
- package/typings/adapters/openapi/panels/mcp.d.ts +3 -0
- package/typings/adapters/openapi/panels/overview.d.ts +3 -0
- package/typings/adapters/openapi/panels/servers.d.ts +3 -0
- package/typings/adapters/openapi/resolve-openapi-example-value.d.ts +3 -0
- package/typings/adapters/openapi/store.d.ts +4 -0
- package/typings/{utils → adapters/openapi/utils}/JsonPointer.d.ts +6 -6
- package/typings/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts +1 -0
- package/typings/adapters/openapi/utils/helpers.d.ts +14 -0
- package/typings/adapters/openapi/utils/merge-mock-server.d.ts +8 -0
- package/typings/adapters/openapi/utils/operation.d.ts +23 -0
- package/typings/adapters/openapi/utils/resolvePathItemRef.d.ts +2 -0
- package/typings/adapters/openapi/utils/url.d.ts +2 -0
- package/typings/adapters/rbac.d.ts +10 -0
- package/typings/adapters/scopedContext.d.ts +5 -0
- package/typings/adapters/utils/convertSwagger2OpenAPI.d.ts +2 -0
- package/typings/adapters/utils/dompurify.d.ts +5 -0
- package/typings/adapters/utils/isPlainText.d.ts +6 -0
- package/typings/adapters/utils/markdoc.d.ts +55 -0
- package/typings/adapters/utils/parseMarkdown.d.ts +8 -0
- package/typings/adapters/utils/seo.d.ts +3 -0
- package/typings/adapters/utils/simplifyAstStructure.d.ts +2 -0
- package/typings/components/AdmonitionItem.d.ts +6 -0
- package/typings/components/ChannelAddressItem.d.ts +7 -0
- package/typings/components/ContainerItem.d.ts +9 -0
- package/typings/components/EmptyMessageItem.d.ts +6 -0
- package/typings/components/ErrorBoundary.d.ts +19 -7
- package/typings/components/ExtensionsItem.d.ts +7 -0
- package/typings/components/ExternalDocsItem.d.ts +8 -0
- package/typings/components/Header/HeaderItem.d.ts +10 -0
- package/typings/components/Header/HeaderPageActions.d.ts +4 -0
- package/typings/components/Header/HeaderResponseCodeTabs.d.ts +8 -0
- package/typings/components/Header/PageActions.d.ts +4 -0
- package/typings/components/Header/ResponseDeepLinkAnchor.d.ts +9 -0
- package/typings/components/Header/hooks.d.ts +5 -0
- package/typings/components/InfoMetadataItem.d.ts +7 -0
- package/typings/components/ItemContent/ItemContentRenderer.d.ts +8 -0
- package/typings/components/ItemContent/SectionHeader.d.ts +8 -0
- package/typings/components/ItemContent/hooks.d.ts +16 -0
- package/typings/components/ItemContent/sections/BodyMimeTypeField.d.ts +12 -0
- package/typings/components/ItemContent/sections/BodySection.d.ts +7 -0
- package/typings/components/ItemContent/sections/CallbacksSection.d.ts +5 -0
- package/typings/components/ItemContent/sections/FieldsSection.d.ts +7 -0
- package/typings/components/ItemContent/sections/MessagesSection.d.ts +5 -0
- package/typings/components/ItemContent/sections/ParametersSection.d.ts +6 -0
- package/typings/components/ItemContent/sections/ResponsesSection.d.ts +5 -0
- package/typings/components/ItemContent/sections/ValuesSection.d.ts +5 -0
- package/typings/components/Mapper.d.ts +25 -0
- package/typings/components/MarkdownItem.d.ts +6 -0
- package/typings/components/Mcp/McpPrompt.d.ts +8 -0
- package/typings/components/Mcp/McpResource.d.ts +8 -0
- package/typings/components/Mcp/McpTool.d.ts +8 -0
- package/typings/components/Mcp/styled.d.ts +22 -0
- package/typings/components/Mcp/utils.d.ts +7 -0
- package/typings/components/MessageLinksItem.d.ts +7 -0
- package/typings/components/PrePaintColorModeScript.d.ts +12 -0
- package/typings/components/Schema/SchemaDescription.d.ts +5 -0
- package/typings/components/Schema/SchemaView.d.ts +20 -0
- package/typings/components/Schema/helpers.d.ts +1 -0
- package/typings/components/Schema/hooks/useSchemaDocument.d.ts +7 -0
- package/typings/components/Schema/hooks/useSchemaFieldDeepLink.d.ts +5 -0
- package/typings/components/Schema/hooks/useVariantIndexFromHash.d.ts +1 -0
- package/typings/components/Schema/styled.d.ts +235 -0
- package/typings/components/Schema/utils.d.ts +26 -0
- package/typings/components/Schema/views/ArrayRenderer.d.ts +13 -0
- package/typings/components/Schema/views/CollapsibleNestedFields.d.ts +25 -0
- package/typings/components/Schema/views/DefaultMappingOptionLabel.d.ts +5 -0
- package/typings/components/Schema/views/DiscriminatorPropertyRow.d.ts +13 -0
- package/typings/components/Schema/views/Examples.d.ts +7 -0
- package/typings/components/Schema/views/ExpandableExample.d.ts +4 -0
- package/typings/components/Schema/views/ObjectRenderer.d.ts +14 -0
- package/typings/components/Schema/views/Pattern.d.ts +6 -0
- package/typings/components/Schema/views/PrimitiveRenderer.d.ts +5 -0
- package/typings/components/Schema/views/PropertyFieldRow.d.ts +16 -0
- package/typings/components/Schema/views/PropertyRenderer.d.ts +15 -0
- package/typings/components/Schema/views/SchemaEnumDescriptions.d.ts +9 -0
- package/typings/components/Schema/views/SchemaEnumValues.d.ts +8 -0
- package/typings/components/Schema/views/SchemaTitleLabel.d.ts +5 -0
- package/typings/components/Schema/views/SchemaVariantSelector.d.ts +11 -0
- package/typings/components/Schema/views/SwitcherRenderer.d.ts +14 -0
- package/typings/components/Schema/views/VariantDropdown.d.ts +14 -0
- package/typings/components/Search/Search.d.ts +10 -0
- package/typings/components/Search/SearchDialog.d.ts +7 -0
- package/typings/components/Search/SearchTrigger.d.ts +9 -0
- package/typings/components/Search/index.d.ts +3 -0
- package/typings/components/Security/Divider.d.ts +4 -0
- package/typings/components/Security/RequiredScopes.d.ts +4 -0
- package/typings/components/Security/ScopeTagWithTooltip.d.ts +11 -0
- package/typings/components/Security/SecurityButtonPanel.d.ts +5 -0
- package/typings/components/Security/SecurityFlowDetail.d.ts +5 -0
- package/typings/components/Security/SecurityModal.d.ts +6 -0
- package/typings/components/Security/SecuritySection.d.ts +3 -0
- package/typings/components/Security/styled.d.ts +127 -0
- package/typings/components/Security/types.d.ts +3 -0
- package/typings/components/SideMenu/SideMenu.d.ts +6 -14
- package/typings/components/SideMenu/buildMenuItems.d.ts +29 -0
- package/typings/components/SideMenu/useMenuItems.d.ts +14 -0
- package/typings/components/StickySidebar/FloatingButton.d.ts +1 -0
- package/typings/components/StickySidebar/RedoclyAttributionLogo.d.ts +5 -0
- package/typings/components/StickySidebar/SidebarActions.d.ts +2 -0
- package/typings/components/StickySidebar/StickySidebar.d.ts +7 -0
- package/typings/components/common/Badge.d.ts +32 -0
- package/typings/components/common/Breadcrumbs.d.ts +11 -0
- package/typings/components/common/ContentWrapper.d.ts +24 -0
- package/typings/components/common/DeepLinkAnchor.d.ts +20 -0
- package/typings/components/common/ExpandAllButton.d.ts +6 -0
- package/typings/components/common/ExternalDocumentation.d.ts +10 -0
- package/typings/components/common/LazyMount.d.ts +9 -0
- package/typings/components/common/LazySection.d.ts +14 -0
- package/typings/components/common/Markdown.d.ts +7 -0
- package/typings/components/common/MoreDetailsButton.d.ts +5 -0
- package/typings/components/common/NestedToggleButton.d.ts +10 -0
- package/typings/components/common/PanelItem.d.ts +65 -0
- package/typings/components/common/ResponseCodeTabs.d.ts +9 -0
- package/typings/components/common/Tag.d.ts +3 -0
- package/typings/components/common/VendorExtensions.d.ts +7 -0
- package/typings/components/common/ViewNested.d.ts +16 -0
- package/typings/components/graphql/ArrowIcon.d.ts +7 -0
- package/typings/components/graphql/GraphQLArgumentsSection.d.ts +10 -0
- package/typings/components/graphql/GraphQLEnumEmbedded.d.ts +5 -0
- package/typings/components/graphql/GraphQLFieldView.d.ts +12 -0
- package/typings/components/graphql/GraphQLFieldsEmbedded.d.ts +9 -0
- package/typings/components/graphql/GraphQLGroupTypeList.d.ts +5 -0
- package/typings/components/graphql/GraphQLHeaderExtras.d.ts +7 -0
- package/typings/components/graphql/GraphQLReturnTypeDetails.d.ts +11 -0
- package/typings/components/graphql/GraphQLTypeView.d.ts +9 -0
- package/typings/components/graphql/GraphQLUnionEmbedded.d.ts +5 -0
- package/typings/components/graphql/RequiresScopesButton.d.ts +9 -0
- package/typings/components/graphql/RequiresScopesModal.d.ts +9 -0
- package/typings/components/graphql/ViewNested.d.ts +14 -0
- package/typings/components/graphql/renderDescription.d.ts +2 -0
- package/typings/components/graphql/sections/GraphQLArgsSection.d.ts +5 -0
- package/typings/components/graphql/sections/GraphQLFieldsSection.d.ts +5 -0
- package/typings/components/graphql/sections/ImplementedBySection.d.ts +5 -0
- package/typings/components/graphql/sections/ImplementsSection.d.ts +5 -0
- package/typings/components/graphql/sections/PossibleTypesSection.d.ts +5 -0
- package/typings/components/graphql/sections/RequiresScopesSection.d.ts +5 -0
- package/typings/components/graphql/sections/ReturnTypeSection.d.ts +5 -0
- package/typings/components/graphql/styled.d.ts +62 -0
- package/typings/components/markdoc/Heading.d.ts +11 -0
- package/typings/components/markdoc/SchemaDefinition.d.ts +11 -0
- package/typings/components/markdoc/apiDocsMarkdocComponents.d.ts +6 -0
- package/typings/components/markdoc/buildMarkdocOptions.d.ts +9 -0
- package/typings/components/markdoc/defaultMarkdocConfig.d.ts +14 -0
- package/typings/components/markdoc/html/html-jsx-attribute-mapping.d.ts +5 -0
- package/typings/components/markdoc/html/process-html-tokens.d.ts +1 -0
- package/typings/components/markdoc/markdocAdapter.d.ts +11 -0
- package/typings/components/markdoc/markdocParser.d.ts +8 -0
- package/typings/components/markdoc/markdocRenderer.d.ts +8 -0
- package/typings/components/markdoc/tags/mcp-tag-schemas.d.ts +2 -0
- package/typings/components/markdoc/tags/schema-definition-tag.d.ts +2 -0
- package/typings/components/panels/ConnectMcpButton.d.ts +5 -0
- package/typings/components/panels/DownloadPanelItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/CallbackPayloadItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/CodeSampleItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/ExamplesPanelItem.d.ts +3 -0
- package/typings/components/panels/ExampleItem/GraphQLQueryItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/GraphQLResponseItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/GraphQLTypeSampleItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/GraphQLVariablesItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/PayloadExampleItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/ResponseExampleItem.d.ts +5 -0
- package/typings/components/panels/ExampleItem/ServerDropdown.d.ts +17 -0
- package/typings/components/panels/ExampleItem/hooks.d.ts +25 -0
- package/typings/components/panels/ExampleItem/selectors.d.ts +39 -0
- package/typings/components/panels/ExampleItem/styled.d.ts +101 -0
- package/typings/components/panels/ExampleItem/types.d.ts +9 -0
- package/typings/components/panels/ExampleItem/useActiveServer.d.ts +17 -0
- package/typings/components/panels/ExampleItem/useCodeSampleLanguages.d.ts +23 -0
- package/typings/components/panels/GroupPanelItem.d.ts +5 -0
- package/typings/components/panels/LanguageItem/LanguageDropdown.d.ts +15 -0
- package/typings/components/panels/LanguageItem/LanguageItem.d.ts +11 -0
- package/typings/components/panels/LanguageItem/LanguageListSkeleton.d.ts +4 -0
- package/typings/components/panels/LanguageItem/constants.d.ts +2 -0
- package/typings/components/panels/LanguageItem/styled.d.ts +71 -0
- package/typings/components/panels/LocationsPanelItem.d.ts +5 -0
- package/typings/components/panels/McpExamplePanelItem.d.ts +5 -0
- package/typings/components/panels/McpPanelItem.d.ts +3 -0
- package/typings/components/panels/OverviewPanelItem.d.ts +3 -0
- package/typings/components/panels/PanelMapper.d.ts +5 -0
- package/typings/components/panels/PanelNodeProps.d.ts +4 -0
- package/typings/components/panels/ReferencesPanelItem.d.ts +5 -0
- package/typings/components/panels/ServerItem/ServerDescriptionTooltip.d.ts +4 -0
- package/typings/components/panels/ServerItem/ServerItem.d.ts +5 -0
- package/typings/components/panels/ServerItem/ServerPanelItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/BrokerItem/BrokerBindingsSection.d.ts +7 -0
- package/typings/components/panels/asyncapi/BrokerItem/BrokerModal.d.ts +8 -0
- package/typings/components/panels/asyncapi/BrokerItem/BrokerOverviewSection.d.ts +6 -0
- package/typings/components/panels/asyncapi/BrokerItem/BrokerPanel.styled.d.ts +21 -0
- package/typings/components/panels/asyncapi/BrokerItem/BrokerPanelItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/ChannelBindingItem/ChannelBindingItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/MessageBindingItem/MessageBindingItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/MessageReferencesItem/MessageReferencesItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/OperationBindingItem/OperationBindingItem.d.ts +5 -0
- package/typings/components/panels/asyncapi/common/bindingPanel.d.ts +30 -0
- package/typings/components/panels/shared-panel-styles.d.ts +16 -0
- package/typings/components/panels/styled.d.ts +18 -0
- package/typings/constants/openapi.d.ts +30 -0
- package/typings/constants/rendering.d.ts +8 -0
- package/typings/contexts/markdownAdapter.d.ts +21 -0
- package/typings/contexts/telemetry.d.ts +4 -0
- package/typings/crypto-compat.d.ts +5 -0
- package/typings/crypto-uuid-compat.d.ts +1 -0
- package/typings/empty-linkedom.d.ts +1 -0
- package/typings/empty.d.ts +7 -0
- package/typings/events/codeSampleCopy.d.ts +2 -0
- package/typings/events/creator.d.ts +2 -0
- package/typings/events/index.d.ts +6 -0
- package/typings/events/languageSwitch.d.ts +2 -0
- package/typings/events/panelToggle.d.ts +2 -0
- package/typings/events/serverSwitch.d.ts +2 -0
- package/typings/events/types.d.ts +7 -0
- package/typings/hoc/withItemId.d.ts +6 -0
- package/typings/hoc/withRouter.d.ts +4 -0
- package/typings/hoc/withStoreProvider.d.ts +24 -0
- package/typings/hooks/deepLinkHash.d.ts +7 -0
- package/typings/hooks/useAgentTools.d.ts +6 -0
- package/typings/hooks/useApiDocsRoutes.d.ts +8 -0
- package/typings/hooks/useApiDocsScroll.d.ts +9 -0
- package/typings/hooks/useBodyScrollLock.d.ts +1 -0
- package/typings/{utils/highlight.d.ts → hooks/useCodeHighlight.d.ts} +17 -23
- package/typings/hooks/useCopyCodeTelemetry.d.ts +14 -0
- package/typings/hooks/useCopySpecSlice.d.ts +9 -0
- package/typings/hooks/useDeepLinkSection.d.ts +23 -0
- package/typings/hooks/useExpandableSection.d.ts +4 -0
- package/typings/hooks/useHashLinkRedirect.d.ts +4 -0
- package/typings/hooks/useInitialTelemetry.d.ts +3 -0
- package/typings/hooks/useIsExpanded.d.ts +1 -0
- package/typings/hooks/useIsHydrated.d.ts +4 -0
- package/typings/hooks/useManualScrollAnchor.d.ts +19 -0
- package/typings/hooks/useModalDismiss.d.ts +2 -0
- package/typings/hooks/useNormalizeUrl.d.ts +2 -0
- package/typings/hooks/usePageTelemetry.d.ts +3 -0
- package/typings/hooks/usePageViewTelemetry.d.ts +2 -0
- package/typings/hooks/usePerformanceMetricsTelemetry.d.ts +5 -0
- package/typings/hooks/useRouterHashBridge.d.ts +25 -0
- package/typings/hooks/useScrollSpyUrlSync.d.ts +3 -0
- package/typings/hooks/useSearchEngine.d.ts +7 -0
- package/typings/hooks/useSessionSummaryTelemetry.d.ts +7 -0
- package/typings/hooks/useTelemetry.d.ts +2 -0
- package/typings/hooks/useTranslate.d.ts +5 -0
- package/typings/hooks/useUrlHash.d.ts +8 -0
- package/typings/hooks/useUrlHashReassert.d.ts +2 -0
- package/typings/hooks/useUserScrollIntent.d.ts +18 -0
- package/typings/hooks/useVisitedChannelsTracker.d.ts +6 -0
- package/typings/icons/CSharpIcon/CSharpIcon.d.ts +4 -0
- package/typings/icons/CSharpIcon/index.d.ts +1 -0
- package/typings/icons/CurlIcon/CurlIcon.d.ts +6 -0
- package/typings/icons/CurlIcon/index.d.ts +1 -0
- package/typings/icons/DefaultMappingIcon/DefaultMappingIcon.d.ts +6 -0
- package/typings/icons/DefaultMappingIcon/index.d.ts +1 -0
- package/typings/icons/GOIcon/GOIcon.d.ts +4 -0
- package/typings/icons/GOIcon/index.d.ts +1 -0
- package/typings/icons/JavaIcon/JavaIcon.d.ts +4 -0
- package/typings/icons/JavaIcon/index.d.ts +1 -0
- package/typings/icons/JavaScriptIcon/JavaScriptIcon.d.ts +4 -0
- package/typings/icons/JavaScriptIcon/index.d.ts +1 -0
- package/typings/icons/ListIcon/ListIcon.d.ts +10 -0
- package/typings/icons/NodeJSIcon/NodeJSIcon.d.ts +4 -0
- package/typings/icons/NodeJSIcon/index.d.ts +1 -0
- package/typings/icons/PHPIcon/PHPIcon.d.ts +4 -0
- package/typings/icons/PHPIcon/index.d.ts +1 -0
- package/typings/icons/PayloadIcon/PayloadIcon.d.ts +4 -0
- package/typings/icons/PayloadIcon/index.d.ts +1 -0
- package/typings/icons/PlusCircleIcon/PlusCircleIcon.d.ts +7 -0
- package/typings/icons/PythonIcon/PythonIcon.d.ts +4 -0
- package/typings/icons/PythonIcon/index.d.ts +1 -0
- package/typings/icons/RIcon/RIcon.d.ts +4 -0
- package/typings/icons/RIcon/index.d.ts +1 -0
- package/typings/icons/RubyIcon/RubyIcon.d.ts +4 -0
- package/typings/icons/RubyIcon/index.d.ts +1 -0
- package/typings/index.d.ts +9 -8
- package/typings/jotai/app.d.ts +75 -0
- package/typings/jotai/examples.d.ts +5 -0
- package/typings/jotai/graphql.d.ts +10 -0
- package/typings/jotai/itemStore.d.ts +51 -0
- package/typings/jotai/routes.d.ts +4 -0
- package/typings/jotai/schema.d.ts +3 -0
- package/typings/jotai/store.d.ts +22 -0
- package/typings/jotai/telemetry.d.ts +46 -0
- package/typings/options/constants.d.ts +10 -0
- package/typings/options/editionOverrides.d.ts +3 -0
- package/typings/options/helpers.d.ts +25 -0
- package/typings/options/normalizeOptions.d.ts +2 -0
- package/typings/options/standaloneLayoutVars.d.ts +3 -0
- package/typings/otel-semantic-conventions.d.ts +10 -0
- package/typings/pages/EntryPage.d.ts +25 -0
- package/typings/pages/GroupPage.d.ts +1 -0
- package/typings/pages/ItemPage.d.ts +1 -0
- package/typings/pages/NotFoundPage.d.ts +6 -0
- package/typings/pages/OverviewPage.d.ts +1 -0
- package/typings/pages/TopLevelEntryView.d.ts +17 -0
- package/typings/services/agent-tools/index.d.ts +11 -0
- package/typings/services/agent-tools/operations.d.ts +20 -0
- package/typings/services/agent-tools/results.d.ts +6 -0
- package/typings/services/agent-tools/security.d.ts +13 -0
- package/typings/services/agent-tools/spec-slice-detail.d.ts +12 -0
- package/typings/services/agent-tools/types.d.ts +54 -0
- package/typings/services/agent-tools/webmcp.d.ts +14 -0
- package/typings/services/code-samples/apply-env-variables.d.ts +8 -0
- package/typings/services/code-samples/convertSampleToString.d.ts +3 -0
- package/typings/services/code-samples/discriminator.d.ts +66 -0
- package/typings/services/code-samples/example-key.d.ts +25 -0
- package/typings/services/code-samples/index.d.ts +2 -0
- package/typings/services/code-samples/language-availability.d.ts +4 -0
- package/typings/services/code-samples/normalize-servers.d.ts +3 -0
- package/typings/services/code-samples/server-env.d.ts +3 -0
- package/typings/services/code-samples/server-variables.d.ts +11 -0
- package/typings/services/code-samples/source.d.ts +104 -0
- package/typings/services/schema/dialects/graphqlSchema.d.ts +1 -0
- package/typings/services/schema/dialects/jsonSchema.d.ts +7 -0
- package/typings/services/schema/index.d.ts +1 -0
- package/typings/services/schema/propertyBuilder.d.ts +32 -0
- package/typings/services/schema/propertyTreeBuilder.d.ts +21 -0
- package/typings/services/schema/schemaProcessor.d.ts +2 -0
- package/typings/services/schema/variant-label.d.ts +6 -0
- package/typings/services/search/engine/collapse.d.ts +5 -0
- package/typings/services/search/engine/constants.d.ts +22 -0
- package/typings/services/search/engine/flexsearch.d.ts +6 -0
- package/typings/services/search/engine/index.d.ts +11 -0
- package/typings/services/search/engine/lowered.d.ts +34 -0
- package/typings/services/search/engine/match.d.ts +12 -0
- package/typings/services/search/engine/present.d.ts +5 -0
- package/typings/services/search/engine/query.d.ts +6 -0
- package/typings/services/search/engine/score.d.ts +7 -0
- package/typings/services/search/engine/text.d.ts +3 -0
- package/typings/services/search/engine/types.d.ts +19 -0
- package/typings/services/search/highlight.d.ts +3 -0
- package/typings/services/search/index.d.ts +4 -0
- package/typings/services/search/indexer/context.d.ts +8 -0
- package/typings/services/search/indexer/deep-links.d.ts +12 -0
- package/typings/services/search/indexer/extractors/asyncapi.d.ts +8 -0
- package/typings/services/search/indexer/extractors/body.d.ts +2 -0
- package/typings/services/search/indexer/extractors/callbacks.d.ts +4 -0
- package/typings/services/search/indexer/extractors/context.d.ts +25 -0
- package/typings/services/search/indexer/extractors/examples.d.ts +3 -0
- package/typings/services/search/indexer/extractors/graphql.d.ts +2 -0
- package/typings/services/search/indexer/extractors/heading-sections.d.ts +3 -0
- package/typings/services/search/indexer/extractors/index.d.ts +12 -0
- package/typings/services/search/indexer/extractors/mcp.d.ts +9 -0
- package/typings/services/search/indexer/extractors/named-rows.d.ts +9 -0
- package/typings/services/search/indexer/extractors/panels.d.ts +10 -0
- package/typings/services/search/indexer/extractors/parameters.d.ts +2 -0
- package/typings/services/search/indexer/extractors/responses.d.ts +2 -0
- package/typings/services/search/indexer/extractors/schema-page.d.ts +9 -0
- package/typings/services/search/indexer/extractors/security.d.ts +4 -0
- package/typings/services/search/indexer/index.d.ts +14 -0
- package/typings/services/search/indexer/param.d.ts +7 -0
- package/typings/services/search/indexer/places.d.ts +42 -0
- package/typings/services/search/indexer/schema-walker.d.ts +29 -0
- package/typings/services/search/indexer/text.d.ts +2 -0
- package/typings/services/search/init.d.ts +7 -0
- package/typings/services/search/text-match.d.ts +5 -0
- package/typings/services/search/types.d.ts +32 -0
- package/typings/services/spec-slice/assistant-links.d.ts +9 -0
- package/typings/services/spec-slice/asyncapi-slice.d.ts +5 -0
- package/typings/services/spec-slice/clone-strip.d.ts +1 -0
- package/typings/services/spec-slice/component-closure.d.ts +6 -0
- package/typings/services/spec-slice/graphql-slice.d.ts +2 -0
- package/typings/services/spec-slice/index.d.ts +6 -0
- package/typings/services/spec-slice/openapi-slice.d.ts +6 -0
- package/typings/services/spec-slice/resolve-scope.d.ts +4 -0
- package/typings/services/spec-slice/types.d.ts +37 -0
- package/typings/standalone.d.ts +20 -0
- package/typings/standaloneThemeConfig.d.ts +3 -0
- package/typings/telemetry/RedocTelemetry.d.ts +22 -0
- package/typings/telemetry/TypeOfUsageContext.d.ts +3 -0
- package/typings/telemetry/defaults.d.ts +7 -0
- package/typings/telemetry/events.d.ts +42 -0
- package/typings/telemetry/fields.d.ts +7 -0
- package/typings/telemetry/index.d.ts +15 -0
- package/typings/telemetry/initialPayload.d.ts +56 -0
- package/typings/telemetry/page.d.ts +5 -0
- package/typings/telemetry/reportDefinitionLoadFailed.d.ts +9 -0
- package/typings/telemetry/sanitizeError.d.ts +4 -0
- package/typings/telemetry/security.d.ts +15 -0
- package/typings/telemetry/useRedocTelemetryInstance.d.ts +3 -0
- package/typings/telemetry/useSchemaFieldTelemetry.d.ts +4 -0
- package/typings/telemetry/useSidebarItemTelemetry.d.ts +11 -0
- package/typings/types/asyncapi.d.ts +348 -0
- package/typings/types/code-samples-config.d.ts +12 -0
- package/typings/types/common.d.ts +162 -0
- package/typings/types/content.d.ts +503 -0
- package/typings/types/edition-config.d.ts +6 -0
- package/typings/types/events.d.ts +64 -0
- package/typings/types/graphql-store.d.ts +60 -0
- package/typings/types/graphql.d.ts +54 -0
- package/typings/types/index.d.ts +10 -2
- package/typings/types/openapi.d.ts +556 -0
- package/typings/types/options.d.ts +132 -0
- package/typings/types/pluggable.d.ts +4 -0
- package/typings/types/schema.d.ts +156 -0
- package/typings/types/store.d.ts +176 -0
- package/typings/url-compat.d.ts +22 -0
- package/typings/utils/calculateMaxLength.d.ts +6 -0
- package/typings/utils/compose.d.ts +8 -0
- package/typings/utils/cookies.d.ts +7 -0
- package/typings/utils/deep-link.d.ts +171 -0
- package/typings/utils/definitionLoadError.d.ts +7 -0
- package/typings/utils/environments.d.ts +6 -0
- package/typings/utils/expansion.d.ts +3 -0
- package/typings/utils/extract-extensions.d.ts +4 -0
- package/typings/utils/form-urlencoded.d.ts +6 -0
- package/typings/utils/graphql-directive-utils.d.ts +6 -0
- package/typings/utils/graphql-parse.d.ts +1 -0
- package/typings/utils/graphql-reference-map.d.ts +3 -0
- package/typings/utils/graphql-samples.d.ts +25 -0
- package/typings/utils/graphql-scopes.d.ts +6 -0
- package/typings/utils/graphql-type-expansion.d.ts +5 -0
- package/typings/utils/http-methods.d.ts +8 -0
- package/typings/utils/is-record.d.ts +1 -0
- package/typings/utils/languages.d.ts +18 -0
- package/typings/utils/loadAndBundleSpec.d.ts +4 -3
- package/typings/utils/logo.d.ts +8 -0
- package/typings/utils/media-type.d.ts +7 -0
- package/typings/utils/multipart.d.ts +7 -0
- package/typings/utils/overview-partial-sections.d.ts +7 -0
- package/typings/utils/refPointer.d.ts +2 -0
- package/typings/utils/resolveText.d.ts +2 -0
- package/typings/utils/routeKind.d.ts +6 -0
- package/typings/utils/routing.d.ts +51 -0
- package/typings/utils/scroll-anchoring.d.ts +4 -0
- package/typings/utils/security-scope.d.ts +3 -0
- package/typings/utils/serialize-parameter.d.ts +8 -0
- package/typings/utils/serialize-querystring.d.ts +6 -0
- package/typings/utils/session-storage.d.ts +2 -0
- package/typings/utils/split-badges-by-position.d.ts +5 -0
- package/typings/utils/status-code.d.ts +1 -0
- package/typings/utils/string.d.ts +18 -0
- package/typings/utils/telemetry.d.ts +1 -0
- package/typings/utils/url.d.ts +9 -0
- package/typings/utils/x-logo.d.ts +13 -0
- package/typings/utils/xml.d.ts +1 -0
- package/typings/yaml-compat.d.ts +7 -0
- package/bundles/d87bcbdbea8f8f5aa26f.worker.js.LICENSE.txt +0 -68
- package/bundles/d87bcbdbea8f8f5aa26f.worker.js.map +0 -1
- package/bundles/redoc.browser.lib.js +0 -1845
- package/bundles/redoc.browser.lib.js.LICENSE.txt +0 -6
- package/bundles/redoc.browser.lib.js.map +0 -1
- package/bundles/redoc.lib.js +0 -1845
- package/bundles/redoc.lib.js.LICENSE.txt +0 -6
- package/bundles/redoc.lib.js.map +0 -1
- package/bundles/redoc.standalone.js.LICENSE.txt +0 -102
- package/bundles/redoc.standalone.js.map +0 -1
- package/typings/common-elements/CopyButtonWrapper.d.ts +0 -10
- package/typings/common-elements/Dropdown/Dropdown.d.ts +0 -3
- package/typings/common-elements/Dropdown/index.d.ts +0 -2
- package/typings/common-elements/Dropdown/styled.d.ts +0 -7
- package/typings/common-elements/Dropdown/types.d.ts +0 -23
- package/typings/common-elements/PrismDiv.d.ts +0 -1
- package/typings/common-elements/Tooltip.d.ts +0 -8
- package/typings/common-elements/fields-layout.d.ts +0 -14
- package/typings/common-elements/fields.d.ts +0 -20
- package/typings/common-elements/headers.d.ts +0 -6
- package/typings/common-elements/index.d.ts +0 -11
- package/typings/common-elements/linkify.d.ts +0 -10
- package/typings/common-elements/mixins.d.ts +0 -1
- package/typings/common-elements/panels.d.ts +0 -11
- package/typings/common-elements/perfect-scrollbar.d.ts +0 -19
- package/typings/common-elements/samples.d.ts +0 -5
- package/typings/common-elements/schema.d.ts +0 -8
- package/typings/common-elements/shelfs.d.ts +0 -13
- package/typings/common-elements/tabs.d.ts +0 -3
- package/typings/components/ApiInfo/ApiInfo.d.ts +0 -8
- package/typings/components/ApiInfo/index.d.ts +0 -1
- package/typings/components/ApiInfo/styled.elements.d.ts +0 -8
- package/typings/components/ApiLogo/ApiLogo.d.ts +0 -7
- package/typings/components/ApiLogo/styled.elements.d.ts +0 -4
- package/typings/components/CallbackSamples/CallbackReqSamples.d.ts +0 -11
- package/typings/components/CallbackSamples/CallbackSamples.d.ts +0 -13
- package/typings/components/Callbacks/CallbackDetails.d.ts +0 -8
- package/typings/components/Callbacks/CallbackOperation.d.ts +0 -8
- package/typings/components/Callbacks/CallbackTitle.d.ts +0 -10
- package/typings/components/Callbacks/CallbacksList.d.ts +0 -8
- package/typings/components/Callbacks/index.d.ts +0 -3
- package/typings/components/Callbacks/styled.elements.d.ts +0 -2
- package/typings/components/ContentItems/ContentItems.d.ts +0 -22
- package/typings/components/DropdownOrLabel/DropdownOrLabel.d.ts +0 -10
- package/typings/components/Endpoint/Endpoint.d.ts +0 -16
- package/typings/components/Endpoint/styled.elements.d.ts +0 -17
- package/typings/components/ExternalDocumentation/ExternalDocumentation.d.ts +0 -8
- package/typings/components/Fields/ArrayItemDetails.d.ts +0 -5
- package/typings/components/Fields/EnumValues.d.ts +0 -17
- package/typings/components/Fields/Examples.d.ts +0 -5
- package/typings/components/Fields/Extensions.d.ts +0 -9
- package/typings/components/Fields/Field.d.ts +0 -20
- package/typings/components/Fields/FieldConstraints.d.ts +0 -7
- package/typings/components/Fields/FieldDetail.d.ts +0 -7
- package/typings/components/Fields/FieldDetails.d.ts +0 -4
- package/typings/components/Fields/Pattern.d.ts +0 -5
- package/typings/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +0 -22
- package/typings/components/JsonViewer/JsonViewer.d.ts +0 -6
- package/typings/components/JsonViewer/index.d.ts +0 -1
- package/typings/components/JsonViewer/style.d.ts +0 -1
- package/typings/components/Loading/Loading.d.ts +0 -7
- package/typings/components/Loading/Spinner.svg.d.ts +0 -5
- package/typings/components/Markdown/AdvancedMarkdown.d.ts +0 -11
- package/typings/components/Markdown/Markdown.d.ts +0 -17
- package/typings/components/Markdown/SanitizedMdBlock.d.ts +0 -7
- package/typings/components/Markdown/styled.elements.d.ts +0 -7
- package/typings/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +0 -17
- package/typings/components/Operation/Operation.d.ts +0 -5
- package/typings/components/OptionsProvider.d.ts +0 -5
- package/typings/components/Parameters/Parameters.d.ts +0 -16
- package/typings/components/Parameters/ParametersGroup.d.ts +0 -9
- package/typings/components/PayloadSamples/Example.d.ts +0 -8
- package/typings/components/PayloadSamples/ExampleValue.d.ts +0 -6
- package/typings/components/PayloadSamples/MediaTypeSamples.d.ts +0 -18
- package/typings/components/PayloadSamples/PayloadSamples.d.ts +0 -9
- package/typings/components/PayloadSamples/exernalExampleHook.d.ts +0 -2
- package/typings/components/PayloadSamples/styled.elements.d.ts +0 -7
- package/typings/components/Redoc/Redoc.d.ts +0 -14
- package/typings/components/Redoc/styled.elements.d.ts +0 -3
- package/typings/components/RedocStandalone.d.ts +0 -9
- package/typings/components/RequestSamples/RequestSamples.d.ts +0 -11
- package/typings/components/ResponseSamples/ResponseSamples.d.ts +0 -9
- package/typings/components/Responses/Response.d.ts +0 -6
- package/typings/components/Responses/ResponseDetails.d.ts +0 -8
- package/typings/components/Responses/ResponseHeaders.d.ts +0 -8
- package/typings/components/Responses/ResponseTitle.d.ts +0 -11
- package/typings/components/Responses/ResponsesList.d.ts +0 -9
- package/typings/components/Responses/styled.elements.d.ts +0 -6
- package/typings/components/Schema/ArraySchema.d.ts +0 -5
- package/typings/components/Schema/DiscriminatorDropdown.d.ts +0 -11
- package/typings/components/Schema/ObjectSchema.d.ts +0 -11
- package/typings/components/Schema/OneOfSchema.d.ts +0 -15
- package/typings/components/Schema/RecursiveSchema.d.ts +0 -3
- package/typings/components/Schema/Schema.d.ts +0 -15
- package/typings/components/Schema/index.d.ts +0 -5
- package/typings/components/SchemaDefinition/SchemaDefinition.d.ts +0 -18
- package/typings/components/SearchBox/SearchBox.d.ts +0 -32
- package/typings/components/SearchBox/styled.elements.d.ts +0 -12
- package/typings/components/SecurityRequirement/OAuthFlow.d.ts +0 -9
- package/typings/components/SecurityRequirement/RequiredScopesRow.d.ts +0 -3
- package/typings/components/SecurityRequirement/SecurityDetails.d.ts +0 -8
- package/typings/components/SecurityRequirement/SecurityHeader.d.ts +0 -8
- package/typings/components/SecurityRequirement/SecurityRequirement.d.ts +0 -6
- package/typings/components/SecurityRequirement/styled.elements.d.ts +0 -17
- package/typings/components/SecuritySchemes/SecuritySchemes.d.ts +0 -14
- package/typings/components/SeeMore/SeeMore.d.ts +0 -7
- package/typings/components/SelectOnClick/SelectOnClick.d.ts +0 -6
- package/typings/components/SideMenu/Logo.d.ts +0 -1
- package/typings/components/SideMenu/MenuItem.d.ts +0 -22
- package/typings/components/SideMenu/MenuItems.d.ts +0 -13
- package/typings/components/SideMenu/index.d.ts +0 -4
- package/typings/components/SideMenu/styled.elements.d.ts +0 -30
- package/typings/components/SourceCode/SourceCode.d.ts +0 -7
- package/typings/components/StickySidebar/ChevronSvg.d.ts +0 -4
- package/typings/components/StickySidebar/StickyResponsiveSidebar.d.ts +0 -23
- package/typings/components/StoreBuilder.d.ts +0 -26
- package/typings/components/index.d.ts +0 -34
- package/typings/services/AppStore.d.ts +0 -33
- package/typings/services/ClipboardService.d.ts +0 -8
- package/typings/services/HistoryService.d.ts +0 -12
- package/typings/services/Labels.d.ts +0 -3
- package/typings/services/MarkdownRenderer.d.ts +0 -26
- package/typings/services/MarkerService.d.ts +0 -11
- package/typings/services/MenuBuilder.d.ts +0 -50
- package/typings/services/MenuStore.d.ts +0 -89
- package/typings/services/OpenAPIParser.d.ts +0 -50
- package/typings/services/RedocNormalizedOptions.d.ts +0 -123
- package/typings/services/ScrollService.d.ts +0 -17
- package/typings/services/SearchStore.d.ts +0 -16
- package/typings/services/SearchWorker.worker.d.ts +0 -20
- package/typings/services/SpecStore.d.ts +0 -20
- package/typings/services/index.d.ts +0 -14
- package/typings/services/models/ApiInfo.d.ts +0 -23
- package/typings/services/models/Callback.d.ts +0 -11
- package/typings/services/models/Example.d.ts +0 -13
- package/typings/services/models/Field.d.ts +0 -32
- package/typings/services/models/Group.model.d.ts +0 -25
- package/typings/services/models/MediaContent.d.ts +0 -24
- package/typings/services/models/MediaType.d.ts +0 -20
- package/typings/services/models/Operation.d.ts +0 -72
- package/typings/services/models/RequestBody.d.ts +0 -17
- package/typings/services/models/Response.d.ts +0 -26
- package/typings/services/models/Schema.d.ts +0 -62
- package/typings/services/models/SecurityRequirement.d.ts +0 -12
- package/typings/services/models/SecuritySchemes.d.ts +0 -26
- package/typings/services/models/Webhook.d.ts +0 -9
- package/typings/services/models/index.d.ts +0 -13
- package/typings/services/types.d.ts +0 -106
- package/typings/styled-components.d.ts +0 -12
- package/typings/styled-patch.d.ts +0 -22
- package/typings/theme.d.ts +0 -163
- package/typings/types/index.ts +0 -3
- package/typings/types/open-api.d.ts +0 -314
- package/typings/types/open-api.ts +0 -304
- package/typings/utils/debug.d.ts +0 -2
- package/typings/utils/decorators.d.ts +0 -1
- package/typings/utils/dom.d.ts +0 -9
- package/typings/utils/helpers.d.ts +0 -43
- package/typings/utils/index.d.ts +0 -10
- package/typings/utils/jsonToHtml.d.ts +0 -1
- package/typings/utils/memoize.d.ts +0 -1
- package/typings/utils/openapi.d.ts +0 -43
- package/typings/utils/sort.d.ts +0 -6
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
export * from './RedocStandalone';
|
|
2
|
-
export * from './Redoc/Redoc';
|
|
3
|
-
export * from './ApiInfo/ApiInfo';
|
|
4
|
-
export * from './ApiLogo/ApiLogo';
|
|
5
|
-
export * from './ContentItems/ContentItems';
|
|
6
|
-
export { ApiContentWrap, BackgroundStub, RedocWrap } from './Redoc/styled.elements';
|
|
7
|
-
export * from './Schema/';
|
|
8
|
-
export * from './SearchBox/SearchBox';
|
|
9
|
-
export * from './Operation/Operation';
|
|
10
|
-
export * from './Loading/Loading';
|
|
11
|
-
export * from './JsonViewer';
|
|
12
|
-
export * from './Markdown/Markdown';
|
|
13
|
-
export { StyledMarkdownBlock } from './Markdown/styled.elements';
|
|
14
|
-
export * from './SecuritySchemes/SecuritySchemes';
|
|
15
|
-
export * from './Responses/Response';
|
|
16
|
-
export * from './Responses/ResponseDetails';
|
|
17
|
-
export * from './Responses/ResponseHeaders';
|
|
18
|
-
export * from './Responses/ResponsesList';
|
|
19
|
-
export * from './Responses/ResponseTitle';
|
|
20
|
-
export * from './ResponseSamples/ResponseSamples';
|
|
21
|
-
export * from './PayloadSamples/PayloadSamples';
|
|
22
|
-
export * from './PayloadSamples/styled.elements';
|
|
23
|
-
export * from './MediaTypeSwitch/MediaTypesSwitch';
|
|
24
|
-
export * from './Parameters/Parameters';
|
|
25
|
-
export * from './PayloadSamples/Example';
|
|
26
|
-
export * from './DropdownOrLabel/DropdownOrLabel';
|
|
27
|
-
export * from './ErrorBoundary';
|
|
28
|
-
export * from './StoreBuilder';
|
|
29
|
-
export * from './OptionsProvider';
|
|
30
|
-
export * from './SideMenu/';
|
|
31
|
-
export * from './StickySidebar/StickyResponsiveSidebar';
|
|
32
|
-
export * from './SearchBox/SearchBox';
|
|
33
|
-
export * from './SchemaDefinition/SchemaDefinition';
|
|
34
|
-
export * from './SourceCode/SourceCode';
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import type { OpenAPISpec } from '../types';
|
|
2
|
-
import { MarkerService } from './MarkerService';
|
|
3
|
-
import { MenuStore } from './MenuStore';
|
|
4
|
-
import { SpecStore } from './models';
|
|
5
|
-
import { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
6
|
-
import type { RedocRawOptions } from './RedocNormalizedOptions';
|
|
7
|
-
import { SearchStore } from './SearchStore';
|
|
8
|
-
import type { StoreState } from './types';
|
|
9
|
-
export declare function createStore(spec: object, specUrl: string | undefined, options?: RedocRawOptions): Promise<AppStore>;
|
|
10
|
-
export declare class AppStore {
|
|
11
|
-
/**
|
|
12
|
-
* deserialize store
|
|
13
|
-
* **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
|
|
14
|
-
*/
|
|
15
|
-
static fromJS(state: StoreState): AppStore;
|
|
16
|
-
menu: MenuStore;
|
|
17
|
-
spec: SpecStore;
|
|
18
|
-
rawOptions: RedocRawOptions;
|
|
19
|
-
options: RedocNormalizedOptions;
|
|
20
|
-
search?: SearchStore<string>;
|
|
21
|
-
marker: MarkerService;
|
|
22
|
-
private scroll;
|
|
23
|
-
private disposer;
|
|
24
|
-
constructor(spec: OpenAPISpec, specUrl?: string, options?: RedocRawOptions, createSearchIndex?: boolean);
|
|
25
|
-
onDidMount(): void;
|
|
26
|
-
dispose(): void;
|
|
27
|
-
/**
|
|
28
|
-
* serializes store
|
|
29
|
-
* **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
|
|
30
|
-
*/
|
|
31
|
-
toJS(): Promise<StoreState>;
|
|
32
|
-
private updateMarkOnMenu;
|
|
33
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export declare class ClipboardService {
|
|
2
|
-
static isSupported(): boolean;
|
|
3
|
-
static selectElement(element: any): void;
|
|
4
|
-
static deselect(): void;
|
|
5
|
-
static copySelected(): boolean;
|
|
6
|
-
static copyElement(element: any): boolean;
|
|
7
|
-
static copyCustom(text: string): boolean;
|
|
8
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
export declare class HistoryService {
|
|
2
|
-
private _emiter;
|
|
3
|
-
constructor();
|
|
4
|
-
get currentId(): string;
|
|
5
|
-
linkForId(id: string): string;
|
|
6
|
-
subscribe(cb: any): () => void;
|
|
7
|
-
emit: () => void;
|
|
8
|
-
bind(): void;
|
|
9
|
-
dispose(): void;
|
|
10
|
-
replace(id: string | null, rewriteHistory?: boolean): void;
|
|
11
|
-
}
|
|
12
|
-
export declare const history: HistoryService;
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { marked } from 'marked';
|
|
2
|
-
import { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
3
|
-
import type { MarkdownHeading, MDXComponentMeta } from './types';
|
|
4
|
-
export declare const LEGACY_REGEXP = "^ {0,3}<!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?-->\\s*$";
|
|
5
|
-
export declare const MDX_COMPONENT_REGEXP: string;
|
|
6
|
-
export declare const COMPONENT_REGEXP: string;
|
|
7
|
-
export declare function buildComponentComment(name: string): string;
|
|
8
|
-
export declare class MarkdownRenderer {
|
|
9
|
-
options?: RedocNormalizedOptions | undefined;
|
|
10
|
-
parentId?: string | undefined;
|
|
11
|
-
static containsComponent(rawText: string, componentName: string): boolean;
|
|
12
|
-
static getTextBeforeHading(md: string, heading: string): string;
|
|
13
|
-
headings: MarkdownHeading[];
|
|
14
|
-
currentTopHeading: MarkdownHeading;
|
|
15
|
-
parser: marked.Parser;
|
|
16
|
-
private headingEnhanceRenderer;
|
|
17
|
-
private originalHeadingRule;
|
|
18
|
-
constructor(options?: RedocNormalizedOptions | undefined, parentId?: string | undefined);
|
|
19
|
-
saveHeading(name: string, level: number, container?: MarkdownHeading[], parentId?: string): MarkdownHeading;
|
|
20
|
-
flattenHeadings(container?: MarkdownHeading[]): MarkdownHeading[];
|
|
21
|
-
attachHeadingsDescriptions(rawText: string): void;
|
|
22
|
-
headingRule: (text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: marked.Slugger) => string;
|
|
23
|
-
renderMd(rawText: string, extractHeadings?: boolean): string;
|
|
24
|
-
extractHeadings(rawText: string): MarkdownHeading[];
|
|
25
|
-
renderMdWithComponents(rawText: string): Array<string | MDXComponentMeta>;
|
|
26
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import * as Mark from 'mark.js';
|
|
2
|
-
export declare class MarkerService {
|
|
3
|
-
map: Map<Element, Mark>;
|
|
4
|
-
private prevTerm;
|
|
5
|
-
add(el: HTMLElement): void;
|
|
6
|
-
delete(el: Element): void;
|
|
7
|
-
addOnly(elements: Element[]): void;
|
|
8
|
-
clearAll(): void;
|
|
9
|
-
mark(term?: string): void;
|
|
10
|
-
unmark(): void;
|
|
11
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import type { OpenAPITag } from '../types';
|
|
2
|
-
import { GroupModel, OperationModel } from './models';
|
|
3
|
-
import type { OpenAPIParser } from './OpenAPIParser';
|
|
4
|
-
import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
5
|
-
import type { ContentItemModel, TagGroup, TagInfo, TagsInfoMap } from './types';
|
|
6
|
-
export declare const GROUP_DEPTH = 0;
|
|
7
|
-
export declare class MenuBuilder {
|
|
8
|
-
/**
|
|
9
|
-
* Builds page content structure based on tags
|
|
10
|
-
*/
|
|
11
|
-
static buildStructure(parser: OpenAPIParser, options: RedocNormalizedOptions): ContentItemModel[];
|
|
12
|
-
/**
|
|
13
|
-
* extracts items from markdown description
|
|
14
|
-
* @param description - markdown source
|
|
15
|
-
*/
|
|
16
|
-
static addMarkdownItems(description: string, parent: GroupModel | undefined, initialDepth: number, options: RedocNormalizedOptions): ContentItemModel[];
|
|
17
|
-
/**
|
|
18
|
-
* Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
|
|
19
|
-
* @param tags value of `x-tagGroups` vendor extension
|
|
20
|
-
*/
|
|
21
|
-
static getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: RedocNormalizedOptions): GroupModel[];
|
|
22
|
-
/**
|
|
23
|
-
* Returns array of OperationsGroup items for the tags of the group or for all tags
|
|
24
|
-
* @param parser
|
|
25
|
-
* @param tagsMap tags info returned from `getTagsWithOperations`
|
|
26
|
-
* @param parent parent item
|
|
27
|
-
* @param group group which this tag belongs to. if not provided gets all tags
|
|
28
|
-
* @param options normalized options
|
|
29
|
-
*/
|
|
30
|
-
static getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: RedocNormalizedOptions): ContentItemModel[];
|
|
31
|
-
/**
|
|
32
|
-
* Returns array of Operation items for the tag
|
|
33
|
-
* @param parser
|
|
34
|
-
* @param parent parent OperationsGroup
|
|
35
|
-
* @param tag tag info returned from `getTagsWithOperations`
|
|
36
|
-
* @param depth items depth
|
|
37
|
-
* @param options - normalized options
|
|
38
|
-
*/
|
|
39
|
-
static getOperationsItems(parser: OpenAPIParser, parent: GroupModel | undefined, tag: TagInfo, depth: number, options: RedocNormalizedOptions): OperationModel[];
|
|
40
|
-
/**
|
|
41
|
-
* collects tags and maps each tag to list of operations belonging to this tag
|
|
42
|
-
*/
|
|
43
|
-
static getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;
|
|
44
|
-
static getTagRelatedSchema({ parser, tag, parent, schemaDefinitionsTagName, }: {
|
|
45
|
-
parser: OpenAPIParser;
|
|
46
|
-
tag: TagInfo;
|
|
47
|
-
parent: GroupModel;
|
|
48
|
-
schemaDefinitionsTagName?: string;
|
|
49
|
-
}): GroupModel[];
|
|
50
|
-
}
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
import { HistoryService } from './HistoryService';
|
|
2
|
-
import type { SpecStore } from './models';
|
|
3
|
-
import type { ScrollService } from './ScrollService';
|
|
4
|
-
import type { IMenuItem } from './types';
|
|
5
|
-
/** Generic interface for MenuItems */
|
|
6
|
-
export declare const SECTION_ATTR = "data-section-id";
|
|
7
|
-
/**
|
|
8
|
-
* Stores all side-menu related information
|
|
9
|
-
*/
|
|
10
|
-
export declare class MenuStore {
|
|
11
|
-
scroll: ScrollService;
|
|
12
|
-
history: HistoryService;
|
|
13
|
-
/**
|
|
14
|
-
* Statically try update scroll position
|
|
15
|
-
* Used before hydrating from server-side rendered html to scroll page faster
|
|
16
|
-
*/
|
|
17
|
-
static updateOnHistory(id: string | undefined, scroll: ScrollService): void;
|
|
18
|
-
/**
|
|
19
|
-
* active item absolute index (when flattened). -1 means nothing is selected
|
|
20
|
-
*/
|
|
21
|
-
activeItemIdx: number;
|
|
22
|
-
/**
|
|
23
|
-
* whether sidebar with menu is opened or not
|
|
24
|
-
*/
|
|
25
|
-
sideBarOpened: boolean;
|
|
26
|
-
items: IMenuItem[];
|
|
27
|
-
flatItems: IMenuItem[];
|
|
28
|
-
/**
|
|
29
|
-
* cached flattened menu items to support absolute indexing
|
|
30
|
-
*/
|
|
31
|
-
private _unsubscribe;
|
|
32
|
-
private _hashUnsubscribe;
|
|
33
|
-
/**
|
|
34
|
-
*
|
|
35
|
-
* @param spec [SpecStore](#SpecStore) which contains page content structure
|
|
36
|
-
* @param scroll scroll service instance used by this menu
|
|
37
|
-
*/
|
|
38
|
-
constructor(spec: SpecStore, scroll: ScrollService, history: HistoryService);
|
|
39
|
-
subscribe(): void;
|
|
40
|
-
toggleSidebar(): void;
|
|
41
|
-
closeSidebar(): void;
|
|
42
|
-
/**
|
|
43
|
-
* update active items on scroll
|
|
44
|
-
* @param isScrolledDown whether last scroll was downside
|
|
45
|
-
*/
|
|
46
|
-
updateOnScroll: (isScrolledDown: boolean) => void;
|
|
47
|
-
/**
|
|
48
|
-
* update active items on hash change
|
|
49
|
-
* @param id current hash
|
|
50
|
-
*/
|
|
51
|
-
updateOnHistory: (id?: string) => void;
|
|
52
|
-
/**
|
|
53
|
-
* get section/operation DOM Node related to the item or null if it doesn't exist
|
|
54
|
-
* @param idx item absolute index
|
|
55
|
-
*/
|
|
56
|
-
getElementAt(idx: number): Element | null;
|
|
57
|
-
/**
|
|
58
|
-
* get section/operation DOM Node related to the item or if it is group item, returns first item of the group
|
|
59
|
-
* @param idx item absolute index
|
|
60
|
-
*/
|
|
61
|
-
getElementAtOrFirstChild(idx: number): Element | null;
|
|
62
|
-
/**
|
|
63
|
-
* current active item
|
|
64
|
-
*/
|
|
65
|
-
get activeItem(): IMenuItem;
|
|
66
|
-
getItemById: (id: string) => IMenuItem | undefined;
|
|
67
|
-
/**
|
|
68
|
-
* activate menu item
|
|
69
|
-
* @param item item to activate
|
|
70
|
-
* @param updateLocation [true] whether to update location
|
|
71
|
-
* @param rewriteHistory [false] whether to rewrite browser history (do not create new entry)
|
|
72
|
-
*/
|
|
73
|
-
activate(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean): void;
|
|
74
|
-
/**
|
|
75
|
-
* makes item and all the parents not active
|
|
76
|
-
* @param item item to deactivate
|
|
77
|
-
*/
|
|
78
|
-
deactivate(item: IMenuItem | undefined): void;
|
|
79
|
-
/**
|
|
80
|
-
* activate menu item and scroll to it
|
|
81
|
-
* @see MenuStore.activate
|
|
82
|
-
*/
|
|
83
|
-
activateAndScroll(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean): void;
|
|
84
|
-
/**
|
|
85
|
-
* scrolls to active section
|
|
86
|
-
*/
|
|
87
|
-
scrollToActive(): void;
|
|
88
|
-
dispose(): void;
|
|
89
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIRef, OpenAPISpec } from '../types';
|
|
2
|
-
import { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
3
|
-
import type { MergedOpenAPISchema } from './types';
|
|
4
|
-
/**
|
|
5
|
-
* Loads and keeps spec. Provides raw spec operations
|
|
6
|
-
*/
|
|
7
|
-
export declare function pushRef(stack: string[], ref?: string): string[];
|
|
8
|
-
export declare function concatRefStacks(base: string[], stack?: string[]): string[];
|
|
9
|
-
export declare class OpenAPIParser {
|
|
10
|
-
private options;
|
|
11
|
-
specUrl?: string;
|
|
12
|
-
spec: OpenAPISpec;
|
|
13
|
-
private readonly allowMergeRefs;
|
|
14
|
-
constructor(spec: OpenAPISpec, specUrl?: string, options?: RedocNormalizedOptions);
|
|
15
|
-
validate(spec: Record<string, any>): void;
|
|
16
|
-
/**
|
|
17
|
-
* get spec part by JsonPointer ($ref)
|
|
18
|
-
*/
|
|
19
|
-
byRef: <T = any>(ref: string) => T | undefined;
|
|
20
|
-
/**
|
|
21
|
-
* checks if the object is OpenAPI reference (contains $ref property)
|
|
22
|
-
*/
|
|
23
|
-
isRef<T>(obj: OpenAPIRef | T): obj is OpenAPIRef;
|
|
24
|
-
/**
|
|
25
|
-
* Resolve given reference object or return as is if it is not a reference
|
|
26
|
-
* @param obj object to dereference
|
|
27
|
-
* @param forceCircular whether to dereference even if it is circular ref
|
|
28
|
-
* @param mergeAsAllOf
|
|
29
|
-
*/
|
|
30
|
-
deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean): {
|
|
31
|
-
resolved: T;
|
|
32
|
-
refsStack: string[];
|
|
33
|
-
};
|
|
34
|
-
mergeRefs<T>(ref: OpenAPIRef, resolved: T, mergeAsAllOf: boolean): T;
|
|
35
|
-
/**
|
|
36
|
-
* Merge allOf constraints.
|
|
37
|
-
* @param schema schema with allOF
|
|
38
|
-
* @param $ref pointer of the schema
|
|
39
|
-
* @param forceCircular whether to dereference children even if it is a circular ref
|
|
40
|
-
* @param used$Refs
|
|
41
|
-
*/
|
|
42
|
-
mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[]): MergedOpenAPISchema;
|
|
43
|
-
/**
|
|
44
|
-
* Find all derived definitions among #/components/schemas from any of $refs
|
|
45
|
-
* returns map of definition pointer to definition name
|
|
46
|
-
* @param $refs array of references to find derived from
|
|
47
|
-
*/
|
|
48
|
-
findDerived($refs: string[]): Record<string, string[] | string>;
|
|
49
|
-
private hoistOneOfs;
|
|
50
|
-
}
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
import { ResolvedThemeInterface, ThemeInterface } from '../theme';
|
|
2
|
-
import { SideNavStyleEnum } from './types';
|
|
3
|
-
import type { LabelsConfigRaw, MDXComponentMeta } from './types';
|
|
4
|
-
export type DownloadUrlsConfig = {
|
|
5
|
-
title?: string;
|
|
6
|
-
url: string;
|
|
7
|
-
}[];
|
|
8
|
-
export interface RedocRawOptions {
|
|
9
|
-
theme?: ThemeInterface;
|
|
10
|
-
scrollYOffset?: number | string | (() => number);
|
|
11
|
-
hideHostname?: boolean | string;
|
|
12
|
-
expandResponses?: string | 'all';
|
|
13
|
-
requiredPropsFirst?: boolean | string;
|
|
14
|
-
sortRequiredPropsFirst?: boolean | string;
|
|
15
|
-
sortPropsAlphabetically?: boolean | string;
|
|
16
|
-
sortEnumValuesAlphabetically?: boolean | string;
|
|
17
|
-
sortOperationsAlphabetically?: boolean | string;
|
|
18
|
-
sortTagsAlphabetically?: boolean | string;
|
|
19
|
-
nativeScrollbars?: boolean | string;
|
|
20
|
-
pathInMiddlePanel?: boolean | string;
|
|
21
|
-
untrustedSpec?: boolean | string;
|
|
22
|
-
sanitize?: boolean | string;
|
|
23
|
-
hideLoading?: boolean | string;
|
|
24
|
-
hideDownloadButton?: boolean | string;
|
|
25
|
-
hideDownloadButtons?: boolean | string;
|
|
26
|
-
downloadFileName?: string;
|
|
27
|
-
downloadDefinitionUrl?: string;
|
|
28
|
-
downloadUrls?: DownloadUrlsConfig;
|
|
29
|
-
disableSearch?: boolean | string;
|
|
30
|
-
onlyRequiredInSamples?: boolean | string;
|
|
31
|
-
showExtensions?: boolean | string | string[];
|
|
32
|
-
sideNavStyle?: SideNavStyleEnum;
|
|
33
|
-
hideSingleRequestSampleTab?: boolean | string;
|
|
34
|
-
hideRequestPayloadSample?: boolean;
|
|
35
|
-
menuToggle?: boolean | string;
|
|
36
|
-
jsonSampleExpandLevel?: number | string | 'all';
|
|
37
|
-
jsonSamplesExpandLevel?: number | string | 'all';
|
|
38
|
-
hideSchemaTitles?: boolean | string;
|
|
39
|
-
simpleOneOfTypeLabel?: boolean | string;
|
|
40
|
-
payloadSampleIdx?: number;
|
|
41
|
-
expandSingleSchemaField?: boolean | string;
|
|
42
|
-
schemaExpansionLevel?: number | string | 'all';
|
|
43
|
-
schemasExpansionLevel?: number | string | 'all';
|
|
44
|
-
schemaDefinitionsTagName?: string;
|
|
45
|
-
showObjectSchemaExamples?: boolean | string;
|
|
46
|
-
showSecuritySchemeType?: boolean;
|
|
47
|
-
hideSecuritySection?: boolean;
|
|
48
|
-
unstable_ignoreMimeParameters?: boolean;
|
|
49
|
-
allowedMdComponents?: Record<string, MDXComponentMeta>;
|
|
50
|
-
labels?: LabelsConfigRaw;
|
|
51
|
-
enumSkipQuotes?: boolean | string;
|
|
52
|
-
expandDefaultServerVariables?: boolean;
|
|
53
|
-
maxDisplayedEnumValues?: number;
|
|
54
|
-
ignoreNamedSchemas?: string[] | string;
|
|
55
|
-
hideSchemaPattern?: boolean;
|
|
56
|
-
generatedPayloadSamplesMaxDepth?: number;
|
|
57
|
-
generatedSamplesMaxDepth?: number;
|
|
58
|
-
nonce?: string;
|
|
59
|
-
hideFab?: boolean;
|
|
60
|
-
minCharacterLengthToInitSearch?: number;
|
|
61
|
-
showWebhookVerb?: boolean;
|
|
62
|
-
hidePropertiesPrefix?: boolean;
|
|
63
|
-
}
|
|
64
|
-
export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
|
|
65
|
-
export declare class RedocNormalizedOptions {
|
|
66
|
-
static normalizeExpandResponses(value: RedocRawOptions['expandResponses']): {};
|
|
67
|
-
static normalizeHideHostname(value: RedocRawOptions['hideHostname']): boolean;
|
|
68
|
-
static normalizeScrollYOffset(value: RedocRawOptions['scrollYOffset']): () => number;
|
|
69
|
-
static normalizeShowExtensions(value: RedocRawOptions['showExtensions']): string[] | boolean;
|
|
70
|
-
static normalizeSideNavStyle(value: RedocRawOptions['sideNavStyle']): SideNavStyleEnum;
|
|
71
|
-
static normalizePayloadSampleIdx(value: RedocRawOptions['payloadSampleIdx']): number;
|
|
72
|
-
private static normalizeJsonSampleExpandLevel;
|
|
73
|
-
private static normalizeGeneratedPayloadSamplesMaxDepth;
|
|
74
|
-
theme: ResolvedThemeInterface;
|
|
75
|
-
scrollYOffset: () => number;
|
|
76
|
-
hideHostname: boolean;
|
|
77
|
-
expandResponses: {
|
|
78
|
-
[code: string]: boolean;
|
|
79
|
-
} | 'all';
|
|
80
|
-
sortRequiredPropsFirst: boolean;
|
|
81
|
-
sortPropsAlphabetically: boolean;
|
|
82
|
-
sortEnumValuesAlphabetically: boolean;
|
|
83
|
-
sortOperationsAlphabetically: boolean;
|
|
84
|
-
sortTagsAlphabetically: boolean;
|
|
85
|
-
nativeScrollbars: boolean;
|
|
86
|
-
pathInMiddlePanel: boolean;
|
|
87
|
-
sanitize: boolean;
|
|
88
|
-
hideDownloadButtons: boolean;
|
|
89
|
-
downloadFileName?: string;
|
|
90
|
-
downloadDefinitionUrl?: string;
|
|
91
|
-
downloadUrls?: DownloadUrlsConfig;
|
|
92
|
-
disableSearch: boolean;
|
|
93
|
-
onlyRequiredInSamples: boolean;
|
|
94
|
-
showExtensions: boolean | string[];
|
|
95
|
-
sideNavStyle: SideNavStyleEnum;
|
|
96
|
-
hideSingleRequestSampleTab: boolean;
|
|
97
|
-
hideRequestPayloadSample: boolean;
|
|
98
|
-
menuToggle: boolean;
|
|
99
|
-
jsonSamplesExpandLevel: number;
|
|
100
|
-
enumSkipQuotes: boolean;
|
|
101
|
-
hideSchemaTitles: boolean;
|
|
102
|
-
simpleOneOfTypeLabel: boolean;
|
|
103
|
-
payloadSampleIdx: number;
|
|
104
|
-
expandSingleSchemaField: boolean;
|
|
105
|
-
schemasExpansionLevel: number;
|
|
106
|
-
schemaDefinitionsTagName?: string;
|
|
107
|
-
showObjectSchemaExamples: boolean;
|
|
108
|
-
showSecuritySchemeType?: boolean;
|
|
109
|
-
hideSecuritySection?: boolean;
|
|
110
|
-
unstable_ignoreMimeParameters: boolean;
|
|
111
|
-
allowedMdComponents: Record<string, MDXComponentMeta>;
|
|
112
|
-
expandDefaultServerVariables: boolean;
|
|
113
|
-
maxDisplayedEnumValues?: number;
|
|
114
|
-
ignoreNamedSchemas: Set<string>;
|
|
115
|
-
hideSchemaPattern: boolean;
|
|
116
|
-
generatedSamplesMaxDepth: number;
|
|
117
|
-
hideFab: boolean;
|
|
118
|
-
minCharacterLengthToInitSearch: number;
|
|
119
|
-
showWebhookVerb: boolean;
|
|
120
|
-
hidePropertiesPrefix?: boolean;
|
|
121
|
-
nonce?: string;
|
|
122
|
-
constructor(raw: RedocRawOptions, defaults?: RedocRawOptions);
|
|
123
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
2
|
-
export declare class ScrollService {
|
|
3
|
-
private options;
|
|
4
|
-
private _scrollParent;
|
|
5
|
-
private _emiter;
|
|
6
|
-
private _prevOffsetY;
|
|
7
|
-
constructor(options: RedocNormalizedOptions);
|
|
8
|
-
bind(): void;
|
|
9
|
-
dispose(): void;
|
|
10
|
-
scrollY(): number;
|
|
11
|
-
isElementBellow(el: Element | null): boolean | undefined;
|
|
12
|
-
isElementAbove(el: Element | null): boolean | undefined;
|
|
13
|
-
subscribe(cb: any): () => void;
|
|
14
|
-
scrollIntoView(element: Element | null): void;
|
|
15
|
-
scrollIntoViewBySelector(selector: string): void;
|
|
16
|
-
handleScroll(): void;
|
|
17
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import type { IMenuItem } from './types';
|
|
2
|
-
import type { OperationModel } from './models';
|
|
3
|
-
import Worker from './SearchWorker.worker';
|
|
4
|
-
export declare class SearchStore<T> {
|
|
5
|
-
searchWorker: Worker;
|
|
6
|
-
indexItems(groups: Array<IMenuItem | OperationModel>): void;
|
|
7
|
-
add(title: string, body: string, meta?: T): void;
|
|
8
|
-
dispose(): void;
|
|
9
|
-
search(q: string): Promise<import("./types").SearchResult<T>[]>;
|
|
10
|
-
toJS(): Promise<{
|
|
11
|
-
store: any[];
|
|
12
|
-
index: object;
|
|
13
|
-
}>;
|
|
14
|
-
load(state: any): void;
|
|
15
|
-
fromExternalJS(path?: string, exportName?: string): void;
|
|
16
|
-
}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import type { SearchResult } from './types';
|
|
2
|
-
export default class Worker {
|
|
3
|
-
add: typeof add;
|
|
4
|
-
done: typeof done;
|
|
5
|
-
search: typeof search;
|
|
6
|
-
toJS: typeof toJS;
|
|
7
|
-
load: typeof load;
|
|
8
|
-
dispose: typeof dispose;
|
|
9
|
-
fromExternalJS: typeof fromExternalJS;
|
|
10
|
-
}
|
|
11
|
-
export declare function add<T>(title: string, description: string, meta?: T): void;
|
|
12
|
-
export declare function done(): Promise<void>;
|
|
13
|
-
export declare function toJS(): Promise<{
|
|
14
|
-
store: any[];
|
|
15
|
-
index: object;
|
|
16
|
-
}>;
|
|
17
|
-
export declare function fromExternalJS(path: string, exportName: string): Promise<void>;
|
|
18
|
-
export declare function load(state: any): Promise<void>;
|
|
19
|
-
export declare function dispose(): Promise<void>;
|
|
20
|
-
export declare function search<Meta = string>(q: string, limit?: number): Promise<Array<SearchResult<Meta>>>;
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIExternalDocumentation, OpenAPISpec } from '../types';
|
|
2
|
-
import { ApiInfoModel } from './models/ApiInfo';
|
|
3
|
-
import { WebhookModel } from './models/Webhook';
|
|
4
|
-
import { SecuritySchemesModel } from './models/SecuritySchemes';
|
|
5
|
-
import { OpenAPIParser } from './OpenAPIParser';
|
|
6
|
-
import type { RedocNormalizedOptions } from './RedocNormalizedOptions';
|
|
7
|
-
import type { ContentItemModel } from './types';
|
|
8
|
-
/**
|
|
9
|
-
* Store that contains all the specification related information in the form of tree
|
|
10
|
-
*/
|
|
11
|
-
export declare class SpecStore {
|
|
12
|
-
private options;
|
|
13
|
-
parser: OpenAPIParser;
|
|
14
|
-
info: ApiInfoModel;
|
|
15
|
-
externalDocs?: OpenAPIExternalDocumentation;
|
|
16
|
-
contentItems: ContentItemModel[];
|
|
17
|
-
securitySchemes: SecuritySchemesModel;
|
|
18
|
-
webhooks?: WebhookModel;
|
|
19
|
-
constructor(spec: OpenAPISpec, specUrl: string | undefined, options: RedocNormalizedOptions);
|
|
20
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
export * from './AppStore';
|
|
2
|
-
export * from './OpenAPIParser';
|
|
3
|
-
export * from './MarkdownRenderer';
|
|
4
|
-
export * from './MenuStore';
|
|
5
|
-
export * from './ScrollService';
|
|
6
|
-
export * from './SpecStore';
|
|
7
|
-
export * from './ClipboardService';
|
|
8
|
-
export * from './HistoryService';
|
|
9
|
-
export * from './models';
|
|
10
|
-
export * from './RedocNormalizedOptions';
|
|
11
|
-
export * from './MenuBuilder';
|
|
12
|
-
export * from './SearchStore';
|
|
13
|
-
export * from './MarkerService';
|
|
14
|
-
export * from './types';
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIContact, OpenAPIInfo, OpenAPILicense } from '../../types';
|
|
2
|
-
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
3
|
-
import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
|
|
4
|
-
export declare class ApiInfoModel implements OpenAPIInfo {
|
|
5
|
-
private parser;
|
|
6
|
-
private options;
|
|
7
|
-
title: string;
|
|
8
|
-
version: string;
|
|
9
|
-
description: string;
|
|
10
|
-
summary: string;
|
|
11
|
-
termsOfService?: string;
|
|
12
|
-
contact?: OpenAPIContact;
|
|
13
|
-
license?: OpenAPILicense;
|
|
14
|
-
downloadUrls: {
|
|
15
|
-
title?: string;
|
|
16
|
-
url?: string;
|
|
17
|
-
}[];
|
|
18
|
-
downloadFileName?: string;
|
|
19
|
-
constructor(parser: OpenAPIParser, options?: RedocNormalizedOptions);
|
|
20
|
-
private getDownloadUrls;
|
|
21
|
-
private getDownloadLink;
|
|
22
|
-
private getDownloadFileName;
|
|
23
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { OperationModel } from './Operation';
|
|
2
|
-
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
3
|
-
import type { OpenAPICallback, Referenced } from '../../types';
|
|
4
|
-
import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
|
|
5
|
-
export declare class CallbackModel {
|
|
6
|
-
expanded: boolean;
|
|
7
|
-
name: string;
|
|
8
|
-
operations: OperationModel[];
|
|
9
|
-
constructor(parser: OpenAPIParser, name: string, infoOrRef: Referenced<OpenAPICallback>, pointer: string, options: RedocNormalizedOptions);
|
|
10
|
-
toggle(): void;
|
|
11
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIEncoding, OpenAPIExample, Referenced } from '../../types';
|
|
2
|
-
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
3
|
-
export declare class ExampleModel {
|
|
4
|
-
mime: string;
|
|
5
|
-
value: any;
|
|
6
|
-
summary?: string;
|
|
7
|
-
description?: string;
|
|
8
|
-
externalValueUrl?: string;
|
|
9
|
-
constructor(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIExample>, mime: string, encoding?: {
|
|
10
|
-
[field: string]: OpenAPIEncoding;
|
|
11
|
-
});
|
|
12
|
-
getExternalValue(mimeType: string): Promise<any>;
|
|
13
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIParameter, OpenAPIParameterLocation, OpenAPIParameterStyle, Referenced } from '../../types';
|
|
2
|
-
import type { RedocNormalizedOptions } from '../RedocNormalizedOptions';
|
|
3
|
-
import type { OpenAPIParser } from '../OpenAPIParser';
|
|
4
|
-
import { SchemaModel } from './Schema';
|
|
5
|
-
import { ExampleModel } from './Example';
|
|
6
|
-
/**
|
|
7
|
-
* Field or Parameter model ready to be used by components
|
|
8
|
-
*/
|
|
9
|
-
export declare class FieldModel {
|
|
10
|
-
expanded: boolean | undefined;
|
|
11
|
-
schema: SchemaModel;
|
|
12
|
-
name: string;
|
|
13
|
-
required: boolean;
|
|
14
|
-
description: string;
|
|
15
|
-
example?: string;
|
|
16
|
-
examples?: Record<string, ExampleModel> | any[];
|
|
17
|
-
deprecated: boolean;
|
|
18
|
-
in?: OpenAPIParameterLocation;
|
|
19
|
-
kind: string;
|
|
20
|
-
extensions?: Record<string, any>;
|
|
21
|
-
explode: boolean;
|
|
22
|
-
style?: OpenAPIParameterStyle;
|
|
23
|
-
const?: any;
|
|
24
|
-
serializationMime?: string;
|
|
25
|
-
constructor(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIParameter> & {
|
|
26
|
-
name?: string;
|
|
27
|
-
kind?: string;
|
|
28
|
-
}, pointer: string, options: RedocNormalizedOptions, refsStack?: string[]);
|
|
29
|
-
toggle(): void;
|
|
30
|
-
collapse(): void;
|
|
31
|
-
expand(): void;
|
|
32
|
-
}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import type { OpenAPIExternalDocumentation, OpenAPITag } from '../../types';
|
|
2
|
-
import type { ContentItemModel, IMenuItem, MarkdownHeading, MenuItemGroupType } from '../types';
|
|
3
|
-
/**
|
|
4
|
-
* Operations Group model ready to be used by components
|
|
5
|
-
*/
|
|
6
|
-
export declare class GroupModel implements IMenuItem {
|
|
7
|
-
id: string;
|
|
8
|
-
absoluteIdx?: number;
|
|
9
|
-
name: string;
|
|
10
|
-
sidebarLabel: string;
|
|
11
|
-
description?: string;
|
|
12
|
-
type: MenuItemGroupType;
|
|
13
|
-
items: ContentItemModel[];
|
|
14
|
-
parent?: GroupModel;
|
|
15
|
-
externalDocs?: OpenAPIExternalDocumentation;
|
|
16
|
-
active: boolean;
|
|
17
|
-
expanded: boolean;
|
|
18
|
-
depth: number;
|
|
19
|
-
level: number;
|
|
20
|
-
constructor(type: MenuItemGroupType, tagOrGroup: OpenAPITag | MarkdownHeading, parent?: GroupModel);
|
|
21
|
-
activate(): void;
|
|
22
|
-
expand(): void;
|
|
23
|
-
collapse(): void;
|
|
24
|
-
deactivate(): void;
|
|
25
|
-
}
|