redoc 3.0.0-rc.3 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundles/redoc.d.ts +328 -31
- package/bundles/redoc.js +1078 -1349
- package/bundles/redoc.standalone.d.ts +327 -31
- package/bundles/redoc.standalone.js +1003 -1087
- package/package.json +42 -36
- package/typings/.tsbuildinfo +0 -1
- package/typings/RedocStandalone.d.ts +0 -43
- package/typings/RedoclyApiDocs.d.ts +0 -22
- package/typings/RedoclyApiDocsStandalone.d.ts +0 -22
- package/typings/adapters/asyncapi/build/context.d.ts +0 -9
- package/typings/adapters/asyncapi/build/navigation.d.ts +0 -2
- package/typings/adapters/asyncapi/build/utils.d.ts +0 -3
- package/typings/adapters/asyncapi/buildContext.d.ts +0 -2
- package/typings/adapters/asyncapi/index.d.ts +0 -13
- package/typings/adapters/asyncapi/items/channel/content.d.ts +0 -5
- package/typings/adapters/asyncapi/items/channel/item.d.ts +0 -13
- package/typings/adapters/asyncapi/items/operation/content.d.ts +0 -4
- package/typings/adapters/asyncapi/items/operation/item.d.ts +0 -15
- package/typings/adapters/asyncapi/items/overview/content.d.ts +0 -10
- package/typings/adapters/asyncapi/items/overview/item.d.ts +0 -16
- package/typings/adapters/asyncapi/panels/brokers.d.ts +0 -7
- package/typings/adapters/asyncapi/panels/download.d.ts +0 -3
- package/typings/adapters/asyncapi/panels/group.d.ts +0 -16
- package/typings/adapters/asyncapi/panels/overview.d.ts +0 -3
- package/typings/adapters/asyncapi/store.d.ts +0 -4
- package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts +0 -4
- package/typings/adapters/asyncapi/utils/get-channel-label.d.ts +0 -3
- package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts +0 -24
- package/typings/adapters/asyncapi/utils/resolve-schema.d.ts +0 -2
- package/typings/adapters/asyncapi/utils/resolve-server-variables.d.ts +0 -3
- package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts +0 -2
- package/typings/adapters/asyncapi/utils/security.d.ts +0 -12
- package/typings/adapters/build.d.ts +0 -15
- package/typings/adapters/graphql/build/context.d.ts +0 -9
- package/typings/adapters/graphql/buildContext.d.ts +0 -2
- package/typings/adapters/graphql/buildStoreFromSdl.d.ts +0 -2
- package/typings/adapters/graphql/group/custom.d.ts +0 -2
- package/typings/adapters/graphql/group/default.d.ts +0 -2
- package/typings/adapters/graphql/group/errors.d.ts +0 -1
- package/typings/adapters/graphql/group/itemBuilders.d.ts +0 -5
- package/typings/adapters/graphql/group/utils.d.ts +0 -8
- package/typings/adapters/graphql/index.d.ts +0 -9
- package/typings/adapters/graphql/items/directive/content.d.ts +0 -4
- package/typings/adapters/graphql/items/directive/item.d.ts +0 -3
- package/typings/adapters/graphql/items/enum/content.d.ts +0 -4
- package/typings/adapters/graphql/items/enum/item.d.ts +0 -3
- package/typings/adapters/graphql/items/input/content.d.ts +0 -4
- package/typings/adapters/graphql/items/input/item.d.ts +0 -3
- package/typings/adapters/graphql/items/interface/content.d.ts +0 -4
- package/typings/adapters/graphql/items/interface/item.d.ts +0 -3
- package/typings/adapters/graphql/items/mutation/content.d.ts +0 -4
- package/typings/adapters/graphql/items/mutation/item.d.ts +0 -3
- package/typings/adapters/graphql/items/object/content.d.ts +0 -4
- package/typings/adapters/graphql/items/object/item.d.ts +0 -3
- package/typings/adapters/graphql/items/operation/content.d.ts +0 -7
- package/typings/adapters/graphql/items/overview/content.d.ts +0 -11
- package/typings/adapters/graphql/items/overview/item.d.ts +0 -4
- package/typings/adapters/graphql/items/query/content.d.ts +0 -4
- package/typings/adapters/graphql/items/query/item.d.ts +0 -3
- package/typings/adapters/graphql/items/scalar/content.d.ts +0 -4
- package/typings/adapters/graphql/items/scalar/item.d.ts +0 -3
- package/typings/adapters/graphql/items/subscription/content.d.ts +0 -4
- package/typings/adapters/graphql/items/subscription/item.d.ts +0 -3
- package/typings/adapters/graphql/items/types.d.ts +0 -7
- package/typings/adapters/graphql/items/union/content.d.ts +0 -4
- package/typings/adapters/graphql/items/union/item.d.ts +0 -3
- package/typings/adapters/graphql/panels/download.d.ts +0 -3
- package/typings/adapters/graphql/panels/group-items.d.ts +0 -4
- package/typings/adapters/graphql/panels/overview.d.ts +0 -3
- package/typings/adapters/graphql/serializeType.d.ts +0 -4
- package/typings/adapters/graphql/store.d.ts +0 -3
- package/typings/adapters/graphql/utils/configMetadataRows.d.ts +0 -3
- package/typings/adapters/graphql/utils/constants.d.ts +0 -24
- package/typings/adapters/graphql/utils/createApiItem.d.ts +0 -15
- package/typings/adapters/graphql/utils/getBadges.d.ts +0 -4
- package/typings/adapters/graphql/utils/ignoreInternalItems.d.ts +0 -3
- package/typings/adapters/graphql/utils/isRootType.d.ts +0 -2
- package/typings/adapters/graphql/utils/menuSlashRegex.d.ts +0 -1
- package/typings/adapters/graphql/utils/normalizeMenu.d.ts +0 -3
- package/typings/adapters/graphql/utils/shouldIncludeItem.d.ts +0 -2
- package/typings/adapters/graphql/utils/summary.d.ts +0 -4
- package/typings/adapters/graphql/utils/validateMenuConfig.d.ts +0 -3
- package/typings/adapters/helpers.d.ts +0 -44
- package/typings/adapters/openapi/build/context.d.ts +0 -13
- package/typings/adapters/openapi/build-code-sample-source.d.ts +0 -4
- package/typings/adapters/openapi/buildContext.d.ts +0 -2
- package/typings/adapters/openapi/constants.d.ts +0 -4
- package/typings/adapters/openapi/group/content.d.ts +0 -25
- package/typings/adapters/openapi/group/item.d.ts +0 -8
- package/typings/adapters/openapi/index.d.ts +0 -11
- package/typings/adapters/openapi/items/mcp/content.d.ts +0 -5
- package/typings/adapters/openapi/items/mcp/item.d.ts +0 -9
- package/typings/adapters/openapi/items/operation/content.d.ts +0 -12
- package/typings/adapters/openapi/items/operation/item.d.ts +0 -9
- package/typings/adapters/openapi/items/overview/content.d.ts +0 -17
- package/typings/adapters/openapi/items/overview/item.d.ts +0 -3
- package/typings/adapters/openapi/items/schema/content.d.ts +0 -3
- package/typings/adapters/openapi/items/schema/item.d.ts +0 -9
- package/typings/adapters/openapi/panels/download.d.ts +0 -3
- package/typings/adapters/openapi/panels/mcp.d.ts +0 -3
- package/typings/adapters/openapi/panels/overview.d.ts +0 -3
- package/typings/adapters/openapi/panels/servers.d.ts +0 -3
- package/typings/adapters/openapi/resolve-openapi-example-value.d.ts +0 -3
- package/typings/adapters/openapi/store.d.ts +0 -4
- package/typings/adapters/openapi/utils/JsonPointer.d.ts +0 -50
- package/typings/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts +0 -1
- package/typings/adapters/openapi/utils/helpers.d.ts +0 -12
- package/typings/adapters/openapi/utils/operation.d.ts +0 -24
- package/typings/adapters/openapi/utils/resolvePathItemRef.d.ts +0 -2
- package/typings/adapters/openapi/utils/url.d.ts +0 -2
- package/typings/adapters/rbac.d.ts +0 -10
- package/typings/adapters/scopedContext.d.ts +0 -5
- package/typings/adapters/utils/dompurify.d.ts +0 -5
- package/typings/adapters/utils/isPlainText.d.ts +0 -6
- package/typings/adapters/utils/markdoc.d.ts +0 -54
- package/typings/adapters/utils/parseMarkdown.d.ts +0 -8
- package/typings/adapters/utils/simplifyAstStructure.d.ts +0 -2
- package/typings/ajv-stub.d.ts +0 -4
- package/typings/components/AdmonitionItem.d.ts +0 -6
- package/typings/components/ChannelAddressItem.d.ts +0 -7
- package/typings/components/ContainerItem.d.ts +0 -9
- package/typings/components/EmptyMessageItem.d.ts +0 -6
- package/typings/components/ErrorBoundary.d.ts +0 -20
- package/typings/components/ExtensionsItem.d.ts +0 -7
- package/typings/components/ExternalDocsItem.d.ts +0 -8
- package/typings/components/Header/HeaderItem.d.ts +0 -10
- package/typings/components/Header/HeaderPageActions.d.ts +0 -4
- package/typings/components/Header/HeaderResponseCodeTabs.d.ts +0 -8
- package/typings/components/Header/PageActions.d.ts +0 -4
- package/typings/components/Header/ResponseDeepLinkAnchor.d.ts +0 -9
- package/typings/components/Header/hooks.d.ts +0 -5
- package/typings/components/InfoMetadataItem.d.ts +0 -7
- package/typings/components/ItemContent/ItemContentRenderer.d.ts +0 -8
- package/typings/components/ItemContent/SectionHeader.d.ts +0 -8
- package/typings/components/ItemContent/hooks.d.ts +0 -17
- package/typings/components/ItemContent/sections/BodyMimeTypeField.d.ts +0 -12
- package/typings/components/ItemContent/sections/BodySection.d.ts +0 -7
- package/typings/components/ItemContent/sections/CallbacksSection.d.ts +0 -5
- package/typings/components/ItemContent/sections/FieldsSection.d.ts +0 -7
- package/typings/components/ItemContent/sections/MessagesSection.d.ts +0 -5
- package/typings/components/ItemContent/sections/ParametersSection.d.ts +0 -6
- package/typings/components/ItemContent/sections/ResponsesSection.d.ts +0 -5
- package/typings/components/ItemContent/sections/ValuesSection.d.ts +0 -5
- package/typings/components/Mapper.d.ts +0 -22
- package/typings/components/MarkdownItem.d.ts +0 -6
- package/typings/components/Mcp/McpPrompt.d.ts +0 -8
- package/typings/components/Mcp/McpResource.d.ts +0 -8
- package/typings/components/Mcp/McpTool.d.ts +0 -8
- package/typings/components/Mcp/styled.d.ts +0 -22
- package/typings/components/Mcp/utils.d.ts +0 -7
- package/typings/components/MessageLinksItem.d.ts +0 -7
- package/typings/components/PrePaintColorModeScript.d.ts +0 -12
- package/typings/components/Schema/SchemaDescription.d.ts +0 -5
- package/typings/components/Schema/SchemaView.d.ts +0 -20
- package/typings/components/Schema/helpers.d.ts +0 -1
- package/typings/components/Schema/hooks/useSchemaDocument.d.ts +0 -7
- package/typings/components/Schema/hooks/useSchemaFieldDeepLink.d.ts +0 -5
- package/typings/components/Schema/hooks/useVariantIndexFromHash.d.ts +0 -1
- package/typings/components/Schema/styled.d.ts +0 -235
- package/typings/components/Schema/utils.d.ts +0 -15
- package/typings/components/Schema/views/ArrayRenderer.d.ts +0 -12
- package/typings/components/Schema/views/CollapsibleNestedFields.d.ts +0 -24
- package/typings/components/Schema/views/DefaultMappingOptionLabel.d.ts +0 -5
- package/typings/components/Schema/views/DiscriminatorPropertyRow.d.ts +0 -13
- package/typings/components/Schema/views/Examples.d.ts +0 -7
- package/typings/components/Schema/views/ExpandableExample.d.ts +0 -4
- package/typings/components/Schema/views/ObjectRenderer.d.ts +0 -13
- package/typings/components/Schema/views/Pattern.d.ts +0 -6
- package/typings/components/Schema/views/PrimitiveRenderer.d.ts +0 -5
- package/typings/components/Schema/views/PropertyFieldRow.d.ts +0 -15
- package/typings/components/Schema/views/PropertyRenderer.d.ts +0 -14
- package/typings/components/Schema/views/SchemaEnumDescriptions.d.ts +0 -9
- package/typings/components/Schema/views/SchemaEnumValues.d.ts +0 -8
- package/typings/components/Schema/views/SchemaTitleLabel.d.ts +0 -5
- package/typings/components/Schema/views/SchemaVariantSelector.d.ts +0 -11
- package/typings/components/Schema/views/SwitcherRenderer.d.ts +0 -13
- package/typings/components/Schema/views/VariantDropdown.d.ts +0 -14
- package/typings/components/Search/Search.d.ts +0 -10
- package/typings/components/Search/SearchDialog.d.ts +0 -7
- package/typings/components/Search/SearchTrigger.d.ts +0 -9
- package/typings/components/Search/index.d.ts +0 -1
- package/typings/components/Security/Divider.d.ts +0 -4
- package/typings/components/Security/RequiredScopes.d.ts +0 -4
- package/typings/components/Security/ScopeTagWithTooltip.d.ts +0 -11
- package/typings/components/Security/SecurityButtonPanel.d.ts +0 -5
- package/typings/components/Security/SecurityFlowDetail.d.ts +0 -5
- package/typings/components/Security/SecurityModal.d.ts +0 -6
- package/typings/components/Security/SecuritySection.d.ts +0 -3
- package/typings/components/Security/styled.d.ts +0 -127
- package/typings/components/Security/types.d.ts +0 -3
- package/typings/components/SideMenu/SideMenu.d.ts +0 -7
- package/typings/components/SideMenu/buildMenuItems.d.ts +0 -29
- package/typings/components/SideMenu/useMenuItems.d.ts +0 -14
- package/typings/components/StickySidebar/FloatingButton.d.ts +0 -1
- package/typings/components/StickySidebar/RedoclyAttributionLogo.d.ts +0 -5
- package/typings/components/StickySidebar/SidebarActions.d.ts +0 -2
- package/typings/components/StickySidebar/StickySidebar.d.ts +0 -7
- package/typings/components/common/Badge.d.ts +0 -32
- package/typings/components/common/Breadcrumbs.d.ts +0 -11
- package/typings/components/common/ContentWrapper.d.ts +0 -13
- package/typings/components/common/DeepLinkAnchor.d.ts +0 -20
- package/typings/components/common/ExpandAllButton.d.ts +0 -6
- package/typings/components/common/ExternalDocumentation.d.ts +0 -10
- package/typings/components/common/LazyMount.d.ts +0 -9
- package/typings/components/common/LazySection.d.ts +0 -14
- package/typings/components/common/Markdown.d.ts +0 -7
- package/typings/components/common/MoreDetailsButton.d.ts +0 -5
- package/typings/components/common/NestedToggleButton.d.ts +0 -10
- package/typings/components/common/PanelItem.d.ts +0 -27
- package/typings/components/common/ResponseCodeTabs.d.ts +0 -9
- package/typings/components/common/Tag.d.ts +0 -3
- package/typings/components/common/VendorExtensions.d.ts +0 -7
- package/typings/components/common/ViewNested.d.ts +0 -13
- package/typings/components/graphql/ArrowIcon.d.ts +0 -7
- package/typings/components/graphql/GraphQLArgumentsSection.d.ts +0 -10
- package/typings/components/graphql/GraphQLEnumEmbedded.d.ts +0 -5
- package/typings/components/graphql/GraphQLFieldView.d.ts +0 -12
- package/typings/components/graphql/GraphQLFieldsEmbedded.d.ts +0 -9
- package/typings/components/graphql/GraphQLGroupTypeList.d.ts +0 -5
- package/typings/components/graphql/GraphQLHeaderExtras.d.ts +0 -7
- package/typings/components/graphql/GraphQLReturnTypeDetails.d.ts +0 -11
- package/typings/components/graphql/GraphQLTypeView.d.ts +0 -9
- package/typings/components/graphql/GraphQLUnionEmbedded.d.ts +0 -5
- package/typings/components/graphql/RequiresScopesButton.d.ts +0 -9
- package/typings/components/graphql/RequiresScopesModal.d.ts +0 -9
- package/typings/components/graphql/ViewNested.d.ts +0 -14
- package/typings/components/graphql/renderDescription.d.ts +0 -2
- package/typings/components/graphql/sections/GraphQLArgsSection.d.ts +0 -5
- package/typings/components/graphql/sections/GraphQLFieldsSection.d.ts +0 -5
- package/typings/components/graphql/sections/ImplementedBySection.d.ts +0 -5
- package/typings/components/graphql/sections/ImplementsSection.d.ts +0 -5
- package/typings/components/graphql/sections/PossibleTypesSection.d.ts +0 -5
- package/typings/components/graphql/sections/RequiresScopesSection.d.ts +0 -5
- package/typings/components/graphql/sections/ReturnTypeSection.d.ts +0 -5
- package/typings/components/graphql/styled.d.ts +0 -55
- package/typings/components/markdoc/Heading.d.ts +0 -11
- package/typings/components/markdoc/SchemaDefinition.d.ts +0 -11
- package/typings/components/markdoc/apiDocsMarkdocComponents.d.ts +0 -6
- package/typings/components/markdoc/buildMarkdocOptions.d.ts +0 -9
- package/typings/components/markdoc/defaultMarkdocConfig.d.ts +0 -4
- package/typings/components/markdoc/html/html-jsx-attribute-mapping.d.ts +0 -5
- package/typings/components/markdoc/html/process-html-tokens.d.ts +0 -2
- package/typings/components/markdoc/markdocAdapter.d.ts +0 -12
- package/typings/components/markdoc/markdocParser.d.ts +0 -8
- package/typings/components/markdoc/markdocRenderer.d.ts +0 -8
- package/typings/components/markdoc/tags/mcp-tag-schemas.d.ts +0 -2
- package/typings/components/markdoc/tags/schema-definition-tag.d.ts +0 -2
- package/typings/components/panels/ConnectMcpButton.d.ts +0 -5
- package/typings/components/panels/DownloadPanelItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/CallbackPayloadItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/CodeSampleItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/ExamplesPanelItem.d.ts +0 -3
- package/typings/components/panels/ExampleItem/GraphQLQueryItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/GraphQLResponseItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/GraphQLTypeSampleItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/GraphQLVariablesItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/PayloadExampleItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/ResponseExampleItem.d.ts +0 -5
- package/typings/components/panels/ExampleItem/ServerDropdown.d.ts +0 -17
- package/typings/components/panels/ExampleItem/hooks.d.ts +0 -28
- package/typings/components/panels/ExampleItem/selectors.d.ts +0 -42
- package/typings/components/panels/ExampleItem/styled.d.ts +0 -98
- package/typings/components/panels/ExampleItem/types.d.ts +0 -6
- package/typings/components/panels/ExampleItem/useCodeSampleLanguages.d.ts +0 -22
- package/typings/components/panels/GroupPanelItem.d.ts +0 -5
- package/typings/components/panels/LanguageItem/LanguageDropdown.d.ts +0 -15
- package/typings/components/panels/LanguageItem/LanguageItem.d.ts +0 -11
- package/typings/components/panels/LanguageItem/styled.d.ts +0 -58
- package/typings/components/panels/LocationsPanelItem.d.ts +0 -5
- package/typings/components/panels/McpExamplePanelItem.d.ts +0 -5
- package/typings/components/panels/McpPanelItem.d.ts +0 -3
- package/typings/components/panels/OverviewPanelItem.d.ts +0 -3
- package/typings/components/panels/PanelMapper.d.ts +0 -5
- package/typings/components/panels/PanelNodeProps.d.ts +0 -4
- package/typings/components/panels/ReferencesPanelItem.d.ts +0 -5
- package/typings/components/panels/ServerItem/ServerDescriptionTooltip.d.ts +0 -4
- package/typings/components/panels/ServerItem/ServerItem.d.ts +0 -5
- package/typings/components/panels/ServerItem/ServerPanelItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/BrokerItem/BrokerBindingsSection.d.ts +0 -7
- package/typings/components/panels/asyncapi/BrokerItem/BrokerModal.d.ts +0 -8
- package/typings/components/panels/asyncapi/BrokerItem/BrokerOverviewSection.d.ts +0 -6
- package/typings/components/panels/asyncapi/BrokerItem/BrokerPanel.styled.d.ts +0 -21
- package/typings/components/panels/asyncapi/BrokerItem/BrokerPanelItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/ChannelBindingItem/ChannelBindingItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/MessageBindingItem/MessageBindingItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/MessageReferencesItem/MessageReferencesItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/OperationBindingItem/OperationBindingItem.d.ts +0 -5
- package/typings/components/panels/asyncapi/common/bindingPanel.d.ts +0 -30
- package/typings/components/panels/shared-panel-styles.d.ts +0 -13
- package/typings/components/panels/styled.d.ts +0 -12
- package/typings/constants/openapi.d.ts +0 -25
- package/typings/constants/rendering.d.ts +0 -8
- package/typings/contexts/markdownAdapter.d.ts +0 -21
- package/typings/contexts/telemetry.d.ts +0 -4
- package/typings/crypto-compat.d.ts +0 -5
- package/typings/crypto-uuid-compat.d.ts +0 -1
- package/typings/empty-linkedom.d.ts +0 -1
- package/typings/empty.d.ts +0 -7
- package/typings/events/codeSampleCopy.d.ts +0 -2
- package/typings/events/creator.d.ts +0 -2
- package/typings/events/languageSwitch.d.ts +0 -2
- package/typings/events/serverSwitch.d.ts +0 -2
- package/typings/events/types.d.ts +0 -6
- package/typings/hoc/withItemId.d.ts +0 -6
- package/typings/hoc/withRouter.d.ts +0 -4
- package/typings/hoc/withStoreProvider.d.ts +0 -24
- package/typings/hooks/code-highlight-languages.d.ts +0 -6
- package/typings/hooks/deepLinkHash.d.ts +0 -7
- package/typings/hooks/useAgentTools.d.ts +0 -6
- package/typings/hooks/useApiDocsRoutes.d.ts +0 -8
- package/typings/hooks/useApiDocsScroll.d.ts +0 -9
- package/typings/hooks/useBodyScrollLock.d.ts +0 -1
- package/typings/hooks/useCodeHighlight.d.ts +0 -15
- package/typings/hooks/useCopyCodeTelemetry.d.ts +0 -14
- package/typings/hooks/useCopySpecSlice.d.ts +0 -9
- package/typings/hooks/useDeepLinkSection.d.ts +0 -16
- package/typings/hooks/useExpandableSection.d.ts +0 -4
- package/typings/hooks/useHashLinkRedirect.d.ts +0 -4
- package/typings/hooks/useInitialTelemetry.d.ts +0 -3
- package/typings/hooks/useIsExpanded.d.ts +0 -1
- package/typings/hooks/useIsHydrated.d.ts +0 -4
- package/typings/hooks/useManualScrollAnchor.d.ts +0 -19
- package/typings/hooks/useModalDismiss.d.ts +0 -2
- package/typings/hooks/useNormalizeUrl.d.ts +0 -2
- package/typings/hooks/usePageTelemetry.d.ts +0 -3
- package/typings/hooks/usePageViewTelemetry.d.ts +0 -2
- package/typings/hooks/usePerformanceMetricsTelemetry.d.ts +0 -5
- package/typings/hooks/useRouterHashBridge.d.ts +0 -24
- package/typings/hooks/useScrollSpyUrlSync.d.ts +0 -3
- package/typings/hooks/useSearchEngine.d.ts +0 -7
- package/typings/hooks/useSessionSummaryTelemetry.d.ts +0 -7
- package/typings/hooks/useTelemetry.d.ts +0 -2
- package/typings/hooks/useTranslate.d.ts +0 -5
- package/typings/hooks/useUrlHash.d.ts +0 -8
- package/typings/hooks/useUrlHashReassert.d.ts +0 -2
- package/typings/hooks/useUserScrollIntent.d.ts +0 -18
- package/typings/hooks/useVisitedChannelsTracker.d.ts +0 -6
- package/typings/icons/CSharpIcon/CSharpIcon.d.ts +0 -3
- package/typings/icons/CurlIcon/CurlIcon.d.ts +0 -13
- package/typings/icons/DefaultMappingIcon/DefaultMappingIcon.d.ts +0 -13
- package/typings/icons/GOIcon/GOIcon.d.ts +0 -3
- package/typings/icons/JavaIcon/JavaIcon.d.ts +0 -3
- package/typings/icons/JavaScriptIcon/JavaScriptIcon.d.ts +0 -3
- package/typings/icons/ListIcon/ListIcon.d.ts +0 -9
- package/typings/icons/NodeJSIcon/NodeJSIcon.d.ts +0 -3
- package/typings/icons/PHPIcon/PHPIcon.d.ts +0 -3
- package/typings/icons/PayloadIcon/PayloadIcon.d.ts +0 -3
- package/typings/icons/PlusCircleIcon/PlusCircleIcon.d.ts +0 -7
- package/typings/icons/PythonIcon/PythonIcon.d.ts +0 -3
- package/typings/icons/RIcon/RIcon.d.ts +0 -3
- package/typings/icons/RubyIcon/RubyIcon.d.ts +0 -3
- package/typings/index.d.ts +0 -9
- package/typings/jotai/app.d.ts +0 -66
- package/typings/jotai/examples.d.ts +0 -5
- package/typings/jotai/graphql.d.ts +0 -10
- package/typings/jotai/itemStore.d.ts +0 -60
- package/typings/jotai/routes.d.ts +0 -4
- package/typings/jotai/schema.d.ts +0 -3
- package/typings/jotai/store.d.ts +0 -22
- package/typings/jotai/telemetry.d.ts +0 -46
- package/typings/options/constants.d.ts +0 -10
- package/typings/options/editionOverrides.d.ts +0 -3
- package/typings/options/helpers.d.ts +0 -19
- package/typings/options/normalizeOptions.d.ts +0 -2
- package/typings/options/standaloneLayoutVars.d.ts +0 -3
- package/typings/otel-semantic-conventions.d.ts +0 -10
- package/typings/pages/EntryPage.d.ts +0 -25
- package/typings/pages/GroupPage.d.ts +0 -1
- package/typings/pages/ItemPage.d.ts +0 -1
- package/typings/pages/NotFoundPage.d.ts +0 -6
- package/typings/pages/OverviewPage.d.ts +0 -1
- package/typings/pages/TopLevelEntryView.d.ts +0 -17
- package/typings/services/agent-tools/index.d.ts +0 -10
- package/typings/services/agent-tools/operations.d.ts +0 -20
- package/typings/services/agent-tools/results.d.ts +0 -6
- package/typings/services/agent-tools/security.d.ts +0 -13
- package/typings/services/agent-tools/spec-slice-detail.d.ts +0 -12
- package/typings/services/agent-tools/types.d.ts +0 -55
- package/typings/services/agent-tools/webmcp.d.ts +0 -14
- package/typings/services/code-samples/convertSampleToString.d.ts +0 -3
- package/typings/services/code-samples/discriminator.d.ts +0 -65
- package/typings/services/code-samples/example-key.d.ts +0 -13
- package/typings/services/code-samples/index.d.ts +0 -2
- package/typings/services/code-samples/language-availability.d.ts +0 -4
- package/typings/services/code-samples/normalize-servers.d.ts +0 -3
- package/typings/services/code-samples/server-env.d.ts +0 -3
- package/typings/services/code-samples/server-variables.d.ts +0 -9
- package/typings/services/code-samples/source.d.ts +0 -81
- package/typings/services/schema/dialects/graphqlSchema.d.ts +0 -1
- package/typings/services/schema/dialects/jsonSchema.d.ts +0 -7
- package/typings/services/schema/index.d.ts +0 -1
- package/typings/services/schema/propertyBuilder.d.ts +0 -31
- package/typings/services/schema/propertyTreeBuilder.d.ts +0 -21
- package/typings/services/schema/schemaProcessor.d.ts +0 -2
- package/typings/services/schema/variant-label.d.ts +0 -6
- package/typings/services/search/engine/collapse.d.ts +0 -5
- package/typings/services/search/engine/constants.d.ts +0 -22
- package/typings/services/search/engine/flexsearch.d.ts +0 -6
- package/typings/services/search/engine/index.d.ts +0 -11
- package/typings/services/search/engine/lowered.d.ts +0 -34
- package/typings/services/search/engine/match.d.ts +0 -12
- package/typings/services/search/engine/present.d.ts +0 -5
- package/typings/services/search/engine/query.d.ts +0 -6
- package/typings/services/search/engine/score.d.ts +0 -7
- package/typings/services/search/engine/text.d.ts +0 -3
- package/typings/services/search/engine/types.d.ts +0 -19
- package/typings/services/search/highlight.d.ts +0 -3
- package/typings/services/search/indexer/context.d.ts +0 -8
- package/typings/services/search/indexer/deep-links.d.ts +0 -12
- package/typings/services/search/indexer/extractors/asyncapi.d.ts +0 -8
- package/typings/services/search/indexer/extractors/body.d.ts +0 -2
- package/typings/services/search/indexer/extractors/callbacks.d.ts +0 -4
- package/typings/services/search/indexer/extractors/context.d.ts +0 -25
- package/typings/services/search/indexer/extractors/examples.d.ts +0 -3
- package/typings/services/search/indexer/extractors/graphql.d.ts +0 -2
- package/typings/services/search/indexer/extractors/heading-sections.d.ts +0 -3
- package/typings/services/search/indexer/extractors/index.d.ts +0 -11
- package/typings/services/search/indexer/extractors/mcp.d.ts +0 -9
- package/typings/services/search/indexer/extractors/named-rows.d.ts +0 -2
- package/typings/services/search/indexer/extractors/panels.d.ts +0 -10
- package/typings/services/search/indexer/extractors/parameters.d.ts +0 -2
- package/typings/services/search/indexer/extractors/responses.d.ts +0 -2
- package/typings/services/search/indexer/extractors/schema-page.d.ts +0 -9
- package/typings/services/search/indexer/extractors/security.d.ts +0 -4
- package/typings/services/search/indexer/index.d.ts +0 -14
- package/typings/services/search/indexer/param.d.ts +0 -7
- package/typings/services/search/indexer/places.d.ts +0 -36
- package/typings/services/search/indexer/schema-walker.d.ts +0 -29
- package/typings/services/search/indexer/text.d.ts +0 -2
- package/typings/services/search/init.d.ts +0 -7
- package/typings/services/search/text-match.d.ts +0 -5
- package/typings/services/search/types.d.ts +0 -31
- package/typings/services/spec-convert/asyncapi.d.ts +0 -11
- package/typings/services/spec-convert/index.d.ts +0 -5
- package/typings/services/spec-convert/swagger/parameters.d.ts +0 -6
- package/typings/services/spec-convert/swagger/refs.d.ts +0 -34
- package/typings/services/spec-convert/swagger/responses.d.ts +0 -2
- package/typings/services/spec-convert/swagger/schema.d.ts +0 -1
- package/typings/services/spec-convert/swagger.d.ts +0 -7
- package/typings/services/spec-slice/assistant-links.d.ts +0 -9
- package/typings/services/spec-slice/asyncapi-slice.d.ts +0 -5
- package/typings/services/spec-slice/clone-strip.d.ts +0 -1
- package/typings/services/spec-slice/component-closure.d.ts +0 -6
- package/typings/services/spec-slice/graphql-slice.d.ts +0 -2
- package/typings/services/spec-slice/index.d.ts +0 -6
- package/typings/services/spec-slice/openapi-slice.d.ts +0 -6
- package/typings/services/spec-slice/resolve-scope.d.ts +0 -4
- package/typings/services/spec-slice/types.d.ts +0 -37
- package/typings/standalone.d.ts +0 -20
- package/typings/standaloneThemeConfig.d.ts +0 -3
- package/typings/telemetry/RedocTelemetry.d.ts +0 -22
- package/typings/telemetry/TypeOfUsageContext.d.ts +0 -3
- package/typings/telemetry/defaults.d.ts +0 -7
- package/typings/telemetry/events.d.ts +0 -41
- package/typings/telemetry/fields.d.ts +0 -7
- package/typings/telemetry/index.d.ts +0 -15
- package/typings/telemetry/initialPayload.d.ts +0 -56
- package/typings/telemetry/page.d.ts +0 -5
- package/typings/telemetry/reportDefinitionLoadFailed.d.ts +0 -9
- package/typings/telemetry/sanitizeError.d.ts +0 -4
- package/typings/telemetry/security.d.ts +0 -14
- package/typings/telemetry/useRedocTelemetryInstance.d.ts +0 -3
- package/typings/telemetry/useSchemaFieldTelemetry.d.ts +0 -4
- package/typings/telemetry/useSidebarItemTelemetry.d.ts +0 -11
- package/typings/types/asyncapi.d.ts +0 -314
- package/typings/types/code-samples-config.d.ts +0 -12
- package/typings/types/common.d.ts +0 -163
- package/typings/types/content.d.ts +0 -479
- package/typings/types/edition-config.d.ts +0 -6
- package/typings/types/events.d.ts +0 -48
- package/typings/types/graphql-store.d.ts +0 -60
- package/typings/types/graphql.d.ts +0 -53
- package/typings/types/openapi.d.ts +0 -515
- package/typings/types/options.d.ts +0 -90
- package/typings/types/schema.d.ts +0 -162
- package/typings/types/store.d.ts +0 -160
- package/typings/utils/calculateMaxLength.d.ts +0 -6
- package/typings/utils/compose.d.ts +0 -7
- package/typings/utils/cookies.d.ts +0 -7
- package/typings/utils/deep-link.d.ts +0 -163
- package/typings/utils/definitionLoadError.d.ts +0 -7
- package/typings/utils/environments.d.ts +0 -6
- package/typings/utils/expansion.d.ts +0 -3
- package/typings/utils/extract-extensions.d.ts +0 -4
- package/typings/utils/form-urlencoded.d.ts +0 -9
- package/typings/utils/graphql-directive-utils.d.ts +0 -6
- package/typings/utils/graphql-parse.d.ts +0 -1
- package/typings/utils/graphql-reference-map.d.ts +0 -3
- package/typings/utils/graphql-samples.d.ts +0 -29
- package/typings/utils/graphql-scopes.d.ts +0 -6
- package/typings/utils/graphql-type-expansion.d.ts +0 -5
- package/typings/utils/http-methods.d.ts +0 -8
- package/typings/utils/is-record.d.ts +0 -1
- package/typings/utils/languages.d.ts +0 -18
- package/typings/utils/loadAndBundleSpec.d.ts +0 -4
- package/typings/utils/logo.d.ts +0 -8
- package/typings/utils/media-type.d.ts +0 -5
- package/typings/utils/refPointer.d.ts +0 -2
- package/typings/utils/resolveSpec.d.ts +0 -20
- package/typings/utils/resolveText.d.ts +0 -2
- package/typings/utils/routeKind.d.ts +0 -6
- package/typings/utils/routing.d.ts +0 -49
- package/typings/utils/scroll-anchoring.d.ts +0 -4
- package/typings/utils/security-scope.d.ts +0 -3
- package/typings/utils/serialize-parameter.d.ts +0 -8
- package/typings/utils/session-storage.d.ts +0 -2
- package/typings/utils/split-badges-by-position.d.ts +0 -5
- package/typings/utils/status-code.d.ts +0 -1
- package/typings/utils/string.d.ts +0 -14
- package/typings/utils/url.d.ts +0 -9
- package/typings/utils/x-logo.d.ts +0 -13
- package/typings/utils/xml.d.ts +0 -1
- package/typings/utils/yaml.d.ts +0 -2
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import type { ReactNode } from 'react';
|
|
2
|
-
export type { MarkdownParser } from '../adapters/utils/parseMarkdown.js';
|
|
3
|
-
/**
|
|
4
|
-
* Host-provided markdown handling. api-docs core does not bundle a markdown engine — embedders
|
|
5
|
-
* supply an adapter so they own how descriptions become React:
|
|
6
|
-
* - `parse` normalizes a source — a raw markdown string, or an already-parsed AST — into whatever
|
|
7
|
-
* `render` consumes. It is opaque to api-docs. Item descriptions are parsed at build, so they
|
|
8
|
-
* reach `parse` as ASTs; the lazily-rendered schema descriptions reach it as raw strings.
|
|
9
|
-
* - `render` turns the parsed value into React.
|
|
10
|
-
*
|
|
11
|
-
* The standalone build supplies a Markdoc-based adapter (`createMarkdocAdapter`). Embedders that
|
|
12
|
-
* pre-parse upstream supply a `parse` no-op plus their own `render`, so the Markdoc
|
|
13
|
-
* parser never enters their client bundle.
|
|
14
|
-
*/
|
|
15
|
-
export type MarkdownRenderer = (parsed: unknown) => ReactNode;
|
|
16
|
-
export type MarkdownAdapter = {
|
|
17
|
-
parse: (source: unknown) => unknown;
|
|
18
|
-
render: MarkdownRenderer;
|
|
19
|
-
};
|
|
20
|
-
export declare const MarkdownAdapterProvider: import("react").Provider<MarkdownAdapter | null>;
|
|
21
|
-
export declare function useMarkdownAdapter(): MarkdownAdapter;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const parseHTML: () => never;
|
package/typings/empty.d.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
export declare const AnalyticsEvent: {
|
|
2
|
-
readonly CodeSampleLanguageSwitched: 'CodeSampleLanguageSwitched';
|
|
3
|
-
readonly CodeSampleCopied: 'CodeSampleCopied';
|
|
4
|
-
readonly OperationServerExpanded: 'OperationServerExpanded';
|
|
5
|
-
readonly TargetServerSwitched: 'TargetServerSwitched';
|
|
6
|
-
};
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { type PropsWithChildren, type ReactElement, type ComponentType, type FC } from 'react';
|
|
2
|
-
import { LayoutVariant } from '@redocly/config';
|
|
3
|
-
import type { ApiItem, ApiStore } from '../types/store.js';
|
|
4
|
-
import type { RawApiDocsOptions } from '../types/options.js';
|
|
5
|
-
import type { OpenAPIDefinition } from '../types/openapi.js';
|
|
6
|
-
type WithStoreProviderProps = {
|
|
7
|
-
items: ApiItem[];
|
|
8
|
-
store: ApiStore;
|
|
9
|
-
options: RawApiDocsOptions;
|
|
10
|
-
layout?: LayoutVariant;
|
|
11
|
-
basePath?: string;
|
|
12
|
-
spec?: Record<string, unknown> | string;
|
|
13
|
-
specUrl?: string;
|
|
14
|
-
};
|
|
15
|
-
export type StoreProviderProps = {
|
|
16
|
-
options?: RawApiDocsOptions;
|
|
17
|
-
/** Pre-built store (e.g. from server-side `buildItems`). Preferred path — no client-side indexing. */
|
|
18
|
-
apiStore?: ApiStore;
|
|
19
|
-
/** Raw OpenAPI definition to index client-side. Used by json-schema tag which constructs a synthetic definition. */
|
|
20
|
-
definition?: OpenAPIDefinition;
|
|
21
|
-
};
|
|
22
|
-
export declare function withStoreProvider<P extends WithStoreProviderProps>(WrappedComponent: ComponentType<P>): FC<P>;
|
|
23
|
-
export declare const StoreProvider: import("react").MemoExoticComponent<({ children, definition, apiStore: apiStoreProp, options: rawOptions, }: PropsWithChildren<StoreProviderProps>) => ReactElement>;
|
|
24
|
-
export {};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Code-sample languages `@tanstack/highlight` ships no grammar for. Each is a claim-ordered
|
|
3
|
-
* pattern list in the style of the bundled grammars; `cpp` fences use the C grammar, which
|
|
4
|
-
* also knows the C++ keywords.
|
|
5
|
-
*/
|
|
6
|
-
export declare const extraLanguages: import("@tanstack/highlight").LanguageDefinition<string>[];
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The deep-link part of a URL fragment. Redoc standalone's hash router puts the route in the
|
|
3
|
-
* fragment too (`#/route#deep-link`); a fragment holding a route alone has no deep link.
|
|
4
|
-
*/
|
|
5
|
-
export declare function deepLinkHash(fragment: string): string;
|
|
6
|
-
/** macOS percent-encodes the second `#`, so Safari and Arc relay `#/route%23deep-link`. */
|
|
7
|
-
export declare function decodeDeepLinkSeparator(fragment: string): string;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../types/store.js';
|
|
2
|
-
/**
|
|
3
|
-
* Publishes the API reference tools to a browser AI agent through WebMCP, for hosts that render
|
|
4
|
-
* the docs on their own. Operation detail is sliced out of the definition the host loaded.
|
|
5
|
-
*/
|
|
6
|
-
export declare function useAgentTools(items: ApiItem[]): void;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../types/store.js';
|
|
2
|
-
import type { RouteItem, RouteIndex } from '../utils/routing.js';
|
|
3
|
-
type UseApiDocsRoutesResult = {
|
|
4
|
-
routes: RouteItem[];
|
|
5
|
-
routeIndex: RouteIndex;
|
|
6
|
-
};
|
|
7
|
-
export declare function useApiDocsRoutes(apiItems: ApiItem[], basePath?: string): UseApiDocsRoutesResult;
|
|
8
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { RouteIndex, RouteItem } from '../utils/routing.js';
|
|
2
|
-
type UseApiDocsScrollOptions = {
|
|
3
|
-
activeRoute: RouteItem | undefined;
|
|
4
|
-
routeIndex: RouteIndex;
|
|
5
|
-
basePath: string;
|
|
6
|
-
isHydrated?: boolean;
|
|
7
|
-
};
|
|
8
|
-
export declare function useApiDocsScroll({ activeRoute, routeIndex, basePath, isHydrated }: UseApiDocsScrollOptions): void;
|
|
9
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare function useBodyScrollLock(locked: boolean): void;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
export type CodeHighlightOptions = {
|
|
2
|
-
startLineNumber?: number;
|
|
3
|
-
withLineNumbers?: boolean;
|
|
4
|
-
};
|
|
5
|
-
/**
|
|
6
|
-
* Highlights `source` as HTML for the code block: `<code class="th-code th-code--<lang>">` with
|
|
7
|
-
* `th-token th-<class>` spans colored through the theme's `--code-block-tokens-*` variables.
|
|
8
|
-
* Unknown languages render as escaped plain text.
|
|
9
|
-
*/
|
|
10
|
-
export declare function highlight(source: string, language?: string, options?: CodeHighlightOptions): string;
|
|
11
|
-
declare const codeHighlight: {
|
|
12
|
-
highlight: typeof highlight;
|
|
13
|
-
};
|
|
14
|
-
export declare function useCodeHighlight(): typeof codeHighlight;
|
|
15
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Returns a factory: `onCopy(language?)` produces a `copy.onClick` handler for
|
|
3
|
-
* `@redocly/theme` CodeBlock controls that fires `sendCopyCodeSnippetClickedMessage`
|
|
4
|
-
* with the given `snippetType` and optional `language` (reported via `languageOf`).
|
|
5
|
-
* When supplied via `controls.copy.onClick`, this overrides the theme's built-in
|
|
6
|
-
* generic copy event.
|
|
7
|
-
*
|
|
8
|
-
* `specType` is auto-added by `RedocTelemetry.send()`.
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* const onCopy = useCopyCodeTelemetry('response');
|
|
12
|
-
* <CodeBlock header={{ controls: { copy: { onClick: onCopy('xml') } } }} />
|
|
13
|
-
*/
|
|
14
|
-
export declare function useCopyCodeTelemetry(snippetType: 'request' | 'response'): (language?: string) => () => void;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { SliceContentKind, SpecSliceScope } from '../services/spec-slice/index.js';
|
|
2
|
-
type CopySpecSlice = {
|
|
3
|
-
getText: () => Promise<string>;
|
|
4
|
-
contentKind: SliceContentKind;
|
|
5
|
-
scope: SpecSliceScope;
|
|
6
|
-
specUrl?: string;
|
|
7
|
-
};
|
|
8
|
-
export declare function useCopySpecSlice(pageSlug: string): CopySpecSlice | null;
|
|
9
|
-
export {};
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import type { DeepLinkSectionData } from '../jotai/itemStore.js';
|
|
2
|
-
export declare const ItemIdContext: import("react").Context<string | undefined>;
|
|
3
|
-
/** Callback id of the enclosing callback panel, if any. */
|
|
4
|
-
export declare const CallbackScopeContext: import("react").Context<string | undefined>;
|
|
5
|
-
export declare function useCallbackScope(): string | undefined;
|
|
6
|
-
export declare function useHashItemId(): string;
|
|
7
|
-
/** Section data carried via context to the schema subtree. `id` is omitted —
|
|
8
|
-
* it comes from `ItemIdContext` separately. `null` means "no section". */
|
|
9
|
-
export type DeepLinkSectionValue = Omit<DeepLinkSectionData, 'id'>;
|
|
10
|
-
export declare const DeepLinkSectionContext: import("react").Context<DeepLinkSectionValue | null>;
|
|
11
|
-
/** Build a normalized deep-link URL for a *section* of the current item, using its
|
|
12
|
-
* `ItemIdContext` and the given suffix. Inside a callback the suffix is prefixed with
|
|
13
|
-
* `callbacks/<callbackId>` so the section cannot collide with the parent operation's.
|
|
14
|
-
* Returns `''` when no item is in scope (e.g. rendered outside a page wrapper). */
|
|
15
|
-
export declare function useDeepLinkUrl(suffix: string): string;
|
|
16
|
-
export declare function useFieldDeepLinkUrl(suffix: string): string;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
export declare function useExpandableSection(key: string | undefined, enabled?: boolean): boolean | undefined;
|
|
2
|
-
export declare function useCollapsibleEntryKey(sectionKey: string | undefined): string | undefined;
|
|
3
|
-
/** Mirror this collapsible's expansion state into the store so the expand/collapse-all button sees real state. */
|
|
4
|
-
export declare function useRegisterCollapsibleEntry(entryKey: string | undefined, isExpanded: boolean): void;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { MouseEvent } from 'react';
|
|
2
|
-
import type { RouteIndex } from '../utils/routing.js';
|
|
3
|
-
/** Routes a legacy in-description hash link straight to its target route on click, so the hash never blinks in the URL on the current page. */
|
|
4
|
-
export declare function useHashLinkRedirect(basePath: string, routeIndex: RouteIndex): (event: MouseEvent<HTMLElement>) => void;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare function useIsExpanded(id: string): boolean;
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import type { RefObject } from 'react';
|
|
2
|
-
/**
|
|
3
|
-
* Manual scroll anchoring for browsers without native `overflow-anchor`
|
|
4
|
-
* support (Safari). On the placeholder→content swap, if the element is above
|
|
5
|
-
* the viewport, adjust `scrollY` by the height delta in a `useLayoutEffect`
|
|
6
|
-
* — before the browser paints — so the user sees no jump.
|
|
7
|
-
*
|
|
8
|
-
* No-op on browsers that implement native scroll anchoring (they handle this
|
|
9
|
-
* automatically and our manual adjustment would compound theirs into a
|
|
10
|
-
* double-shift).
|
|
11
|
-
*/
|
|
12
|
-
export declare function useManualScrollAnchor({ ref, mounted, placeholderHeight }: {
|
|
13
|
-
ref: RefObject<HTMLElement | null>;
|
|
14
|
-
/** `true` once the real content is rendered (replacing the placeholder). */
|
|
15
|
-
mounted: boolean;
|
|
16
|
-
/** Height the placeholder reserved before the swap. The element's measured
|
|
17
|
-
* height minus this gives the delta to compensate. */
|
|
18
|
-
placeholderHeight: number;
|
|
19
|
-
}): void;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Bridges router-driven hash changes to `useUrlHash` subscribers. React-router
|
|
3
|
-
* navigations (`<Link>`, `navigate()`) go through `history.pushState`, which
|
|
4
|
-
* fires no `hashchange`, so hash consumers would go stale. Mounted once at the
|
|
5
|
-
* docs root as a single `useLocation()` subscriber (same pattern as
|
|
6
|
-
* `VisitedChannelsTracker`), it re-dispatches one synthetic `hashchange` when
|
|
7
|
-
* the hash actually changes via router navigation.
|
|
8
|
-
*
|
|
9
|
-
* Real `hashchange`/`popstate` events only sync the guard ref, so
|
|
10
|
-
* browser-initiated hash changes are never dispatched twice. Scroll-spy URL
|
|
11
|
-
* writes (`useScrollSpyUrlSync`) use raw `history.replaceState` and bypass the
|
|
12
|
-
* router entirely, so scrolling never reaches this bridge — which preserves
|
|
13
|
-
* the perf rationale documented in `useUrlHash`. Those silent writes do move
|
|
14
|
-
* `window.location` away from the router's remembered hash, though, so
|
|
15
|
-
* scroll-spy announces them via `URL_REPLACE_EVENT` and the bridge re-syncs
|
|
16
|
-
* its guard ref (without notifying subscribers) — otherwise a later router
|
|
17
|
-
* navigation back to the remembered hash would be treated as a no-op.
|
|
18
|
-
*
|
|
19
|
-
* A `hashchange` that arrives with the hash unchanged can only be synthetic: a host
|
|
20
|
-
* re-landing on the current URL without routing. It is announced as a reassert.
|
|
21
|
-
*/
|
|
22
|
-
/** Fired after a raw `history.replaceState` URL write that bypasses the router. */
|
|
23
|
-
export declare const URL_REPLACE_EVENT = "redocly:urlreplace";
|
|
24
|
-
export declare function useRouterHashBridge(): void;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { ApiItem, ApiStore } from '../types/store.js';
|
|
2
|
-
import type { SearchItemData } from '../services/search/types.js';
|
|
3
|
-
export declare function useSearchEngine(items: ApiItem[], store: ApiStore, basePath: string, document?: Record<string, unknown>): {
|
|
4
|
-
search: (query: string) => Promise<SearchItemData[]>;
|
|
5
|
-
isReady: boolean;
|
|
6
|
-
ensureIndex: () => void;
|
|
7
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Sends the `page.time` summary of the current page load on every hide, on `pagehide` and on
|
|
3
|
-
* unmount (a host navigating away from the API docs keeps the tab visible).
|
|
4
|
-
* Counters are cumulative and a snapshot that adds nothing is skipped; consumers keep the
|
|
5
|
-
* largest snapshot per session.
|
|
6
|
-
*/
|
|
7
|
-
export declare function useSessionSummaryTelemetry(): void;
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { TFunction } from '@redocly/theme/core/openapi';
|
|
2
|
-
import type { ApiSpecType } from '../types/common.js';
|
|
3
|
-
export type { TFunction };
|
|
4
|
-
export declare function useTranslate(specType?: ApiSpecType): TFunction;
|
|
5
|
-
export declare function useSpecTranslate(): TFunction;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
type Options = {
|
|
2
|
-
trackSilentReplaces?: boolean;
|
|
3
|
-
};
|
|
4
|
-
/** Current URL hash. Under Redoc standalone's hash router (`#/route#deep-link`) only the
|
|
5
|
-
* trailing deep-link part, or `''` when the fragment holds a route alone. Ignores scroll-spy's
|
|
6
|
-
* silent hash clears (so hash-driven state survives) unless `trackSilentReplaces` is set. */
|
|
7
|
-
export declare function useUrlHash(options?: Options): string;
|
|
8
|
-
export {};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import type { RefObject } from 'react';
|
|
2
|
-
/** Gestures that mean the user is scrolling (not a programmatic scroll). */
|
|
3
|
-
export declare const USER_SCROLL_INTENT_EVENTS: readonly ['wheel', 'touchmove', 'keydown', 'mousedown'];
|
|
4
|
-
/** Cumulative wheel distance below this is trackpad noise (resting fingers
|
|
5
|
-
* emit 1-10px ticks), not intent. One physical mouse-wheel notch (~100px, or
|
|
6
|
-
* 3 lines in line-mode) crosses it immediately. Shared with the anchor-drift
|
|
7
|
-
* tolerance in useApiDocsScroll so the two intent signals agree. */
|
|
8
|
-
export declare const WHEEL_INTENT_THRESHOLD_PX = 48;
|
|
9
|
-
/** Stateful intent classifier for one settle window / navigation: wheel
|
|
10
|
-
* deltas accumulate up to {@link WHEEL_INTENT_THRESHOLD_PX} before counting
|
|
11
|
-
* as intent; touchmove, scroll keys, and scrollbar drags count immediately.
|
|
12
|
-
* Without the accumulation, a single 2px trackpad tick during the lazy-mount
|
|
13
|
-
* layout pump opens the scroll-spy gate and cancels deep-link anchoring, so
|
|
14
|
-
* landing on a section route rewrites the URL to a neighboring section. */
|
|
15
|
-
export declare function createScrollIntentTracker(): (event: Event) => boolean;
|
|
16
|
-
/** Ref (`.current`) that flips true once the user scrolls; re-arms whenever
|
|
17
|
-
* `resetKey` changes (pass `location.key` to re-arm per navigation). */
|
|
18
|
-
export declare function useUserScrollIntent(resetKey: string): RefObject<boolean>;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Records visited pathnames into `visitedChannelsAtom`. Mounted once at the
|
|
3
|
-
* docs root as the single `useLocation()` subscriber — per-item panels read
|
|
4
|
-
* the atom instead of subscribing to the router.
|
|
5
|
-
*/
|
|
6
|
-
export declare function useVisitedChannelsTracker(): void;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
type IconProps = React.SVGProps<SVGSVGElement> & {
|
|
2
|
-
'data-component-name'?: string;
|
|
3
|
-
};
|
|
4
|
-
export declare const CurlIcon: import("styled-components/dist/types").IStyledComponentBase<"web", Omit<import("styled-components/dist/types").Merged<Omit<import("react").SVGProps<SVGSVGElement> & {
|
|
5
|
-
'data-component-name'?: string;
|
|
6
|
-
}, "style"> & {
|
|
7
|
-
style?: import("react").CSSProperties | import("styled-components/dist/types").CSSPropertiesWithVars | undefined;
|
|
8
|
-
}, IconProps>, "data-component-name"> & Partial<Pick<import("styled-components/dist/types").Merged<Omit<import("react").SVGProps<SVGSVGElement> & {
|
|
9
|
-
'data-component-name'?: string;
|
|
10
|
-
}, "style"> & {
|
|
11
|
-
style?: import("react").CSSProperties | import("styled-components/dist/types").CSSPropertiesWithVars | undefined;
|
|
12
|
-
}, IconProps>, "data-component-name">>> & string & Omit<(props: IconProps) => import("react").JSX.Element, keyof import("react").Component<any, {}, any>>;
|
|
13
|
-
export {};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
type IconProps = React.SVGProps<SVGSVGElement> & {
|
|
2
|
-
'data-component-name'?: string;
|
|
3
|
-
};
|
|
4
|
-
export declare const DefaultMappingIcon: import("styled-components/dist/types").IStyledComponentBase<"web", Omit<import("styled-components/dist/types").Merged<Omit<import("react").SVGProps<SVGSVGElement> & {
|
|
5
|
-
'data-component-name'?: string;
|
|
6
|
-
}, "style"> & {
|
|
7
|
-
style?: import("react").CSSProperties | import("styled-components/dist/types").CSSPropertiesWithVars | undefined;
|
|
8
|
-
}, IconProps>, "data-component-name"> & Partial<Pick<import("styled-components/dist/types").Merged<Omit<import("react").SVGProps<SVGSVGElement> & {
|
|
9
|
-
'data-component-name'?: string;
|
|
10
|
-
}, "style"> & {
|
|
11
|
-
style?: import("react").CSSProperties | import("styled-components/dist/types").CSSPropertiesWithVars | undefined;
|
|
12
|
-
}, IconProps>, "data-component-name">>> & string & Omit<(props: IconProps) => import("react").JSX.Element, keyof import("react").Component<any, {}, any>>;
|
|
13
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
type IconProps = React.SVGProps<SVGSVGElement> & {
|
|
2
|
-
size?: string;
|
|
3
|
-
};
|
|
4
|
-
export declare const ListIcon: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Merged<Omit<import("react").SVGProps<SVGSVGElement> & {
|
|
5
|
-
size?: string;
|
|
6
|
-
}, "style"> & {
|
|
7
|
-
style?: import("react").CSSProperties | import("styled-components/dist/types").CSSPropertiesWithVars | undefined;
|
|
8
|
-
}, IconProps>> & string & Omit<(props: IconProps) => import("react").JSX.Element, keyof import("react").Component<any, {}, any>>;
|
|
9
|
-
export {};
|
package/typings/index.d.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export { RedocStandalone, prepareApiDocs } from './RedocStandalone.js';
|
|
2
|
-
export type { RedocStandaloneProps } from './RedocStandalone.js';
|
|
3
|
-
export { RedoclyApiDocsStandalone } from './RedoclyApiDocsStandalone.js';
|
|
4
|
-
export type { RedoclyApiDocsStandaloneProps } from './RedoclyApiDocsStandalone.js';
|
|
5
|
-
export { convertSwagger2OpenAPI } from './services/spec-convert/index.js';
|
|
6
|
-
export { logoFromSpec } from './utils/x-logo.js';
|
|
7
|
-
export { ServerStyleSheet } from 'styled-components';
|
|
8
|
-
export { RedoclyApiDocs as Redoc } from './RedoclyApiDocs.js';
|
|
9
|
-
export type { RedoclyApiDocsProps as RedocProps } from './RedoclyApiDocs.js';
|
package/typings/jotai/app.d.ts
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
import { LayoutVariant } from '@redocly/config';
|
|
2
|
-
import type { AsyncLocalStorage } from 'node:async_hooks';
|
|
3
|
-
declare global {
|
|
4
|
-
var redoclyCookieStorage: AsyncLocalStorage<string> | undefined;
|
|
5
|
-
}
|
|
6
|
-
export type TabType<T extends object = object> = {
|
|
7
|
-
title: string;
|
|
8
|
-
key: string;
|
|
9
|
-
} & T;
|
|
10
|
-
export type AppSessionStore = {
|
|
11
|
-
collapsedSidebar: boolean;
|
|
12
|
-
unsupportedFeatureScreen: boolean;
|
|
13
|
-
};
|
|
14
|
-
export type AppStore = {
|
|
15
|
-
activeMimeName: string;
|
|
16
|
-
layout: LayoutVariant;
|
|
17
|
-
colorMode: string;
|
|
18
|
-
language: string;
|
|
19
|
-
environment: string;
|
|
20
|
-
environments: Record<string, Record<string, string>>;
|
|
21
|
-
allowedEnvironments: string[] | null;
|
|
22
|
-
};
|
|
23
|
-
type LanguageAtom = {
|
|
24
|
-
languages?: (TabType & {
|
|
25
|
-
order?: number;
|
|
26
|
-
lang: string;
|
|
27
|
-
})[];
|
|
28
|
-
activeLanguage: string;
|
|
29
|
-
};
|
|
30
|
-
/** Raw `light` | `dark`; localStorage so it survives on `file://`, where cookies are dropped. */
|
|
31
|
-
export declare const COLOR_MODE_STORAGE_KEY = "redoc.colorMode";
|
|
32
|
-
export declare const appStore: import("jotai").WritableAtom<AppStore, [typeof import("jotai/utils").RESET | AppStore | ((prev: AppStore) => typeof import("jotai/utils").RESET | AppStore)], void>;
|
|
33
|
-
export declare const environmentAtom: import("jotai").WritableAtom<[Record<string, string>, string], [{
|
|
34
|
-
environment?: string;
|
|
35
|
-
environments?: Record<string, Record<string, string>>;
|
|
36
|
-
}], void>;
|
|
37
|
-
export declare const savedEnvironmentNameAtom: import("jotai").Atom<string>;
|
|
38
|
-
export declare const activeMimeNameAtom: import("jotai").WritableAtom<string, [string], void>;
|
|
39
|
-
export declare const mediaTypeOverrideAtom: import("jotai").PrimitiveAtom<string | undefined> & {
|
|
40
|
-
init: string | undefined;
|
|
41
|
-
};
|
|
42
|
-
export declare const activeMediaTypeAtom: import("jotai").WritableAtom<string | undefined, [string | undefined], void>;
|
|
43
|
-
export declare const layoutAtom: import("jotai").WritableAtom<LayoutVariant, LayoutVariant[], void>;
|
|
44
|
-
/** Mobile sidebar drawer — open state is per-view, never persisted. */
|
|
45
|
-
export declare const isSidebarOpenedAtom: import("jotai").PrimitiveAtom<boolean> & {
|
|
46
|
-
init: boolean;
|
|
47
|
-
};
|
|
48
|
-
export declare const colorModeAtom: import("jotai").WritableAtom<string, string[], void>;
|
|
49
|
-
export declare const collapsedSidebarAtom: import("jotai").WritableAtom<boolean, boolean[], void>;
|
|
50
|
-
export declare const languageAtom: import("jotai").WritableAtom<LanguageAtom, [string], void>;
|
|
51
|
-
/**
|
|
52
|
-
* The `data-section-id` of whatever section is currently nearest the top of
|
|
53
|
-
* the viewport (computed by `useScrollSpyUrlSync` via `useActiveSectionId`).
|
|
54
|
-
* Used only for the standalone API docs with sidebar.
|
|
55
|
-
*/
|
|
56
|
-
export declare const activeScrollSectionAtom: import("jotai").PrimitiveAtom<string | null> & {
|
|
57
|
-
init: string | null;
|
|
58
|
-
};
|
|
59
|
-
/**
|
|
60
|
-
* Lowercased pathnames visited this session. Written only by the root-mounted
|
|
61
|
-
* `useVisitedChannelsTracker` so per-item panels don't subscribe to the router.
|
|
62
|
-
*/
|
|
63
|
-
export declare const visitedChannelsAtom: import("jotai").PrimitiveAtom<string[]> & {
|
|
64
|
-
init: string[];
|
|
65
|
-
};
|
|
66
|
-
export {};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { ExampleEntry } from '../types/store.js';
|
|
2
|
-
export declare const exampleStoreAtom: import("jotai").Atom<Record<string, ExampleEntry>>;
|
|
3
|
-
export declare const itemSpecForSamplerAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<Record<string, unknown>>>;
|
|
4
|
-
export declare function buildExampleAtomKey(schemaId: string, context?: 'request' | 'response', mediaType?: string, itemId?: string): string;
|
|
5
|
-
export declare const generatedExampleAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<unknown>>;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import type { GraphqlDirectiveData, GraphqlStoreFieldData, GraphqlTypeData, GraphqlTypeReference } from '../types/graphql-store.js';
|
|
2
|
-
import type { GraphqlTypeLookup } from '../utils/graphql-samples.js';
|
|
3
|
-
export declare const graphqlTypeLookupAtom: import("jotai").Atom<GraphqlTypeLookup>;
|
|
4
|
-
export declare const graphqlTypeDataAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<GraphqlTypeData | undefined>>;
|
|
5
|
-
export declare const graphqlDirectiveDataAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<GraphqlDirectiveData | undefined>>;
|
|
6
|
-
export type GraphqlOperationType = 'query' | 'mutation' | 'subscription';
|
|
7
|
-
export declare function graphqlOperationKey(operationType: GraphqlOperationType | undefined, operationName: string | undefined): string;
|
|
8
|
-
export declare const graphqlOperationAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<GraphqlStoreFieldData | undefined>>;
|
|
9
|
-
export declare const graphqlTypeSlugMapAtom: import("jotai").Atom<Record<string, string>>;
|
|
10
|
-
export declare const graphqlReferenceMapAtom: import("jotai").Atom<Record<string, GraphqlTypeReference[]>>;
|