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,43 +0,0 @@
|
|
|
1
|
-
import type { ReactElement, ReactNode } from 'react';
|
|
2
|
-
import type { ApiItem, ApiStore } from './types/store.js';
|
|
3
|
-
import type { ApiSpecType } from './types/common.js';
|
|
4
|
-
import type { RawApiDocsOptions } from './types/options.js';
|
|
5
|
-
import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
|
|
6
|
-
import type { RedoclyApiDocsStandaloneProps } from './RedoclyApiDocsStandalone.js';
|
|
7
|
-
import type { BuildTimings } from './telemetry/index.js';
|
|
8
|
-
type RedocStandaloneProps = {
|
|
9
|
-
/** Parsed API description object, its JSON or YAML text, or a GraphQL SDL string. */
|
|
10
|
-
spec?: Record<string, unknown> | string;
|
|
11
|
-
/** URL of the API description. Ignored when `spec` is provided. */
|
|
12
|
-
specUrl?: string;
|
|
13
|
-
options?: Partial<RawApiDocsOptions>;
|
|
14
|
-
basePath?: string;
|
|
15
|
-
logo?: RedoclyApiDocsStandaloneProps['logo'];
|
|
16
|
-
markdownAdapter?: MarkdownAdapter;
|
|
17
|
-
onLoaded?: (error?: Error) => void;
|
|
18
|
-
/** Rendered while the spec is loading. */
|
|
19
|
-
children?: ReactNode;
|
|
20
|
-
};
|
|
21
|
-
type PreparedApiDocs = {
|
|
22
|
-
items: ApiItem[];
|
|
23
|
-
store: ApiStore;
|
|
24
|
-
options: RawApiDocsOptions;
|
|
25
|
-
specType: ApiSpecType;
|
|
26
|
-
/** Bundled spec, or the raw SDL string for GraphQL. */
|
|
27
|
-
document?: Record<string, unknown> | string;
|
|
28
|
-
timings: BuildTimings;
|
|
29
|
-
};
|
|
30
|
-
/**
|
|
31
|
-
* Resolves the spec and builds the item model. `convertedDownload: false` keeps the default
|
|
32
|
-
* download on `specUrl` for an AsyncAPI 2.x source instead of a `blob:` URL of the converted
|
|
33
|
-
* document, which a server pass cannot create; the caller revokes any `blob:` download URL.
|
|
34
|
-
*/
|
|
35
|
-
declare function prepareApiDocs({ spec, specUrl, options, basePath, convertedDownload }: Pick<RedocStandaloneProps, 'spec' | 'specUrl' | 'options' | 'basePath'> & {
|
|
36
|
-
convertedDownload?: boolean;
|
|
37
|
-
}): Promise<PreparedApiDocs>;
|
|
38
|
-
declare function isTelemetryDisabled(value: unknown): boolean;
|
|
39
|
-
/** Loads and bundles the spec, builds the item model, and renders `RedoclyApiDocsStandalone`. */
|
|
40
|
-
declare const RedocStandalone: ({ spec, specUrl, options, basePath, logo, markdownAdapter, onLoaded, children, }: RedocStandaloneProps) => ReactElement | null;
|
|
41
|
-
export { RedocStandalone, prepareApiDocs, isTelemetryDisabled };
|
|
42
|
-
export type { RedocStandaloneProps };
|
|
43
|
-
export default RedocStandalone;
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { type ReactElement } from 'react';
|
|
2
|
-
import type { LayoutVariant } from '@redocly/config';
|
|
3
|
-
import type { ApiItem, ApiStore } from './types/store.js';
|
|
4
|
-
import type { RawApiDocsOptions } from './types/options.js';
|
|
5
|
-
import { type MarkdownAdapter } from './contexts/markdownAdapter.js';
|
|
6
|
-
import { type InitialTelemetryContext, type RedocTelemetryConfig } from './telemetry/index.js';
|
|
7
|
-
type RedoclyApiDocsInnerProps = {
|
|
8
|
-
items: ApiItem[];
|
|
9
|
-
basePath: string;
|
|
10
|
-
markdownAdapter: MarkdownAdapter;
|
|
11
|
-
telemetryConfig?: Partial<RedocTelemetryConfig>;
|
|
12
|
-
initialTelemetry?: InitialTelemetryContext;
|
|
13
|
-
};
|
|
14
|
-
type RedoclyApiDocsProps = RedoclyApiDocsInnerProps & {
|
|
15
|
-
store: ApiStore;
|
|
16
|
-
options: RawApiDocsOptions;
|
|
17
|
-
layout?: LayoutVariant;
|
|
18
|
-
};
|
|
19
|
-
declare const RedoclyApiDocsComponent: (props: RedoclyApiDocsInnerProps) => ReactElement;
|
|
20
|
-
declare const RedoclyApiDocs: import("react").FC<any>;
|
|
21
|
-
export { RedoclyApiDocs, RedoclyApiDocsComponent };
|
|
22
|
-
export type { RedoclyApiDocsProps };
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import type { ApiItem, ApiStore } from './types/store.js';
|
|
2
|
-
import type { RawApiDocsOptions } from './types/options.js';
|
|
3
|
-
import type { RedocTelemetryConfig } from './telemetry/RedocTelemetry.js';
|
|
4
|
-
import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
|
|
5
|
-
import type { RawLogo } from './types/common.js';
|
|
6
|
-
import type { BuildTimings } from './telemetry/index.js';
|
|
7
|
-
type RedoclyApiDocsStandaloneProps = {
|
|
8
|
-
items: ApiItem[];
|
|
9
|
-
store: ApiStore;
|
|
10
|
-
basePath: string;
|
|
11
|
-
options: RawApiDocsOptions;
|
|
12
|
-
logo?: RawLogo;
|
|
13
|
-
telemetryConfig?: Partial<RedocTelemetryConfig>;
|
|
14
|
-
markdownAdapter?: MarkdownAdapter;
|
|
15
|
-
spec?: Record<string, unknown> | string;
|
|
16
|
-
specUrl?: string;
|
|
17
|
-
buildTimings?: BuildTimings;
|
|
18
|
-
};
|
|
19
|
-
declare const RedoclyApiDocsStandalone: import("react").FC<any>;
|
|
20
|
-
export { RedoclyApiDocsStandalone };
|
|
21
|
-
export type { RedoclyApiDocsStandaloneProps };
|
|
22
|
-
export default RedoclyApiDocsStandalone;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiDefinition, AsyncApiBuildContext as BuildContext } from '../../../types/asyncapi.js';
|
|
2
|
-
import type { AdapterBuildContextInput, StoreContext } from '../../../types/store.js';
|
|
3
|
-
type CreateBuildContextInputWithDocument = AdapterBuildContextInput & {
|
|
4
|
-
document: AsyncApiDefinition;
|
|
5
|
-
storeCtx: StoreContext;
|
|
6
|
-
processContent?: boolean;
|
|
7
|
-
};
|
|
8
|
-
export declare function createBuildContext({ document, options, basePath, storeCtx, processContent }: CreateBuildContextInputWithDocument): BuildContext;
|
|
9
|
-
export {};
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ProtocolVariant, AsyncApiDefinition } from '../../../types/asyncapi.js';
|
|
2
|
-
export declare function findFirstBinding(obj: unknown, visited?: Set<unknown>): ProtocolVariant | null;
|
|
3
|
-
export declare function mapChannelToOperations(rawAsyncApiDoc: AsyncApiDefinition): Record<string, string[]>;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { ApiDocAdapterProps, ApiItem, ApiStore, StoreContext } from '../../types/store.js';
|
|
2
|
-
import type { AsyncApiDefinition } from '../../types/asyncapi.js';
|
|
3
|
-
export declare function processAsyncApiDocument(props: ApiDocAdapterProps & {
|
|
4
|
-
document: AsyncApiDefinition;
|
|
5
|
-
processContent?: boolean;
|
|
6
|
-
}): {
|
|
7
|
-
items: ApiItem[];
|
|
8
|
-
store: ApiStore;
|
|
9
|
-
};
|
|
10
|
-
export declare function buildAsyncApiItems({ document, options, basePath, processContent }: ApiDocAdapterProps & {
|
|
11
|
-
document: AsyncApiDefinition;
|
|
12
|
-
processContent?: boolean;
|
|
13
|
-
}, storeCtx: StoreContext): ApiItem[];
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { ApiItemContent, MessageReferencesGroups } from '../../../../types/content.js';
|
|
2
|
-
import type { AsyncApiChannel, AsyncApiDefinition, ProtocolVariant } from '../../../../types/asyncapi.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildMessageReferencesGroups(document: AsyncApiDefinition, messageKey: string, protocol: ProtocolVariant | null | undefined): MessageReferencesGroups;
|
|
5
|
-
export declare function buildChannelContent(channelId: string, channel: AsyncApiChannel, document: AsyncApiDefinition, markdownOptions: ParseMarkdownOptions, protocol?: ProtocolVariant | null): ApiItemContent;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { AsyncApiChannel } from '../../../../types/asyncapi.js';
|
|
3
|
-
export declare function buildTaggedChannelItem({ channelId, channel, operationIds, tagName }: {
|
|
4
|
-
channelId: string;
|
|
5
|
-
channel: AsyncApiChannel;
|
|
6
|
-
operationIds: string[];
|
|
7
|
-
tagName: string;
|
|
8
|
-
}): ApiItem;
|
|
9
|
-
export declare function buildUntaggedChannelItem({ channelId, channel, operationIds }: {
|
|
10
|
-
channelId: string;
|
|
11
|
-
channel: AsyncApiChannel;
|
|
12
|
-
operationIds: string[];
|
|
13
|
-
}): ApiItem;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
2
|
-
import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
|
|
3
|
-
import type { ApiDocsOptions } from '../../../../types/options.js';
|
|
4
|
-
export declare function buildOperationContent(operationId: string, operation: AsyncApiOperation, document: AsyncApiDefinition, pageSlug: string, options: ApiDocsOptions, protocol?: ProtocolVariant | null, groupHeaderLabel?: string, showDivider?: boolean): ApiItemContent;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
|
|
3
|
-
import type { ApiDocsOptions } from '../../../../types/options.js';
|
|
4
|
-
export declare function buildOperationItem({ operationId, operation, linkParts, channelBindings, document, options, protocol, groupHeaderLabel, processContent, showDivider }: {
|
|
5
|
-
operationId: string;
|
|
6
|
-
operation: AsyncApiOperation;
|
|
7
|
-
linkParts: string[];
|
|
8
|
-
channelBindings?: Record<string, unknown>;
|
|
9
|
-
document: AsyncApiDefinition;
|
|
10
|
-
options: ApiDocsOptions;
|
|
11
|
-
protocol?: ProtocolVariant | null;
|
|
12
|
-
groupHeaderLabel?: string;
|
|
13
|
-
processContent?: boolean;
|
|
14
|
-
showDivider?: boolean;
|
|
15
|
-
}): ApiItem;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
|
|
2
|
-
import type { ApiItemContent, ContentNode } from '../../../../types/content.js';
|
|
3
|
-
import type { ApiDocsOptions } from '../../../../types/options.js';
|
|
4
|
-
export declare function buildOverviewContent({ document, options, protocol, sectionChildren, basePath }: {
|
|
5
|
-
document: AsyncApiDefinition;
|
|
6
|
-
options: ApiDocsOptions;
|
|
7
|
-
protocol: string | null;
|
|
8
|
-
sectionChildren: ContentNode[];
|
|
9
|
-
basePath: string;
|
|
10
|
-
}): ApiItemContent;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { ContentNode } from '../../../../types/content.js';
|
|
3
|
-
import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
|
|
4
|
-
import type { ApiDocsOptions } from '../../../../types/options.js';
|
|
5
|
-
type Options = {
|
|
6
|
-
basePath: string;
|
|
7
|
-
document: AsyncApiDefinition;
|
|
8
|
-
options: ApiDocsOptions;
|
|
9
|
-
protocol: string | null;
|
|
10
|
-
sectionChildren: ContentNode[];
|
|
11
|
-
processContent?: boolean;
|
|
12
|
-
};
|
|
13
|
-
export declare function buildOverviewItem(info: {
|
|
14
|
-
title?: string;
|
|
15
|
-
}, options: Options): ApiItem;
|
|
16
|
-
export {};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiDefinition, AsyncApiServer } from '../../../types/asyncapi.js';
|
|
2
|
-
import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
|
|
3
|
-
import { type BrokersNode } from '../../../types/content.js';
|
|
4
|
-
import type { BrokerData } from '../../../types/asyncapi.js';
|
|
5
|
-
export declare function buildBrokersPanelContent(servers: Record<string, AsyncApiServer>, protocol: string | null, markdownOptions: ParseMarkdownOptions, document: AsyncApiDefinition): BrokersNode;
|
|
6
|
-
/** Maps a `servers` entry, given inline or as a `$ref`, to the broker the servers panels render. */
|
|
7
|
-
export declare function toBrokerData(name: string, entry: AsyncApiServer, document: AsyncApiDefinition, markdownOptions: ParseMarkdownOptions, sectionRbac?: Record<string, string>): BrokerData;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import type { GroupItemNode } from '../../../types/content.js';
|
|
2
|
-
import type { AsyncApiBuildContext } from '../../../types/asyncapi.js';
|
|
3
|
-
import type { ApiItem } from '../../../types/store.js';
|
|
4
|
-
export declare function buildGroupItemsPanel({ group, protocol, channelByLink, context }: {
|
|
5
|
-
group: ApiItem[];
|
|
6
|
-
protocol: AsyncApiBuildContext['protocol'];
|
|
7
|
-
channelByLink: Map<string, {
|
|
8
|
-
bindings?: Record<string, unknown>;
|
|
9
|
-
} | undefined>;
|
|
10
|
-
context: AsyncApiBuildContext;
|
|
11
|
-
}): GroupItemNode['children'][0];
|
|
12
|
-
type VisibleGroupItem = ApiItem & {
|
|
13
|
-
link: string;
|
|
14
|
-
};
|
|
15
|
-
export declare function isVisibleGroupItem(item: ApiItem): item is VisibleGroupItem;
|
|
16
|
-
export {};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { ApiStore, StoreContext } from '../../types/store.js';
|
|
2
|
-
import type { AsyncApiDefinition } from '../../types/asyncapi.js';
|
|
3
|
-
import type { ApiDocsOptions } from '../../types/options.js';
|
|
4
|
-
export declare function populateAsyncApiStore(document: AsyncApiDefinition, existingCtx: StoreContext, options: ApiDocsOptions): ApiStore;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiChannelBinding, ProtocolVariant } from '../../../types/asyncapi.js';
|
|
2
|
-
type Options = {
|
|
3
|
-
channel: string;
|
|
4
|
-
channels: string;
|
|
5
|
-
servers: string;
|
|
6
|
-
server: string;
|
|
7
|
-
send: string;
|
|
8
|
-
receive: string;
|
|
9
|
-
sendLabel: string;
|
|
10
|
-
receiveLabel: string;
|
|
11
|
-
channelBinding: string;
|
|
12
|
-
payload: string;
|
|
13
|
-
};
|
|
14
|
-
type Params = {
|
|
15
|
-
protocol: string | null;
|
|
16
|
-
channelBindings?: AsyncApiChannelBinding;
|
|
17
|
-
};
|
|
18
|
-
export declare function componentLabelsByProtocol({ protocol, channelBindings }: Params): Options;
|
|
19
|
-
export declare function itemLabelsByProtocol(protocol: ProtocolVariant | null, channelBindings?: AsyncApiChannelBinding): {
|
|
20
|
-
channel: string;
|
|
21
|
-
send: string;
|
|
22
|
-
receive: string;
|
|
23
|
-
};
|
|
24
|
-
export {};
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiDefinition, AsyncApiServerVariables } from '../../../types/asyncapi.js';
|
|
2
|
-
/** The server's variables with `$ref` entries resolved; unresolvable entries are kept as-is. */
|
|
3
|
-
export declare function resolveServerVariables(document: AsyncApiDefinition, variables: AsyncApiServerVariables | undefined): AsyncApiServerVariables | undefined;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { AsyncApiDefinition, AsyncApiSecurityRequirement, AsyncApiSecurityScheme } from '../../../types/asyncapi.js';
|
|
2
|
-
import type { SecurityRequirementDetail } from '../../../types/content.js';
|
|
3
|
-
import type { SecuritySchemeEntry, StoreContext } from '../../../types/store.js';
|
|
4
|
-
import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
|
|
5
|
-
export declare function buildSecuritySchemeEntry(id: string, scheme: AsyncApiSecurityScheme, options: ParseMarkdownOptions): SecuritySchemeEntry;
|
|
6
|
-
/**
|
|
7
|
-
* One requirement per `security` entry, in order. A 2.x requirement object (`{ name: scopes }`)
|
|
8
|
-
* is one requirement whose schemes are all required. Schemes that resolve to nothing are dropped,
|
|
9
|
-
* and so are requirements left empty. A component scheme keeps its name, an inline one is named
|
|
10
|
-
* by its type.
|
|
11
|
-
*/
|
|
12
|
-
export declare function buildSecurityRequirements(security: AsyncApiSecurityRequirement[] | undefined, storeCtx: StoreContext, document: AsyncApiDefinition, options: ParseMarkdownOptions): SecurityRequirementDetail[];
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../types/store.js';
|
|
2
|
-
import type { ApiSpecType } from '../types/common.js';
|
|
3
|
-
import type { RawApiDocsOptions } from '../types/options.js';
|
|
4
|
-
import type { MarkdownParser } from './utils/parseMarkdown.js';
|
|
5
|
-
type ApiDocProps = Omit<ApiDocAdapterProps, 'options'> & {
|
|
6
|
-
options: RawApiDocsOptions;
|
|
7
|
-
markdownParser: MarkdownParser;
|
|
8
|
-
};
|
|
9
|
-
type BuildItemsResult = {
|
|
10
|
-
items: ApiItem[];
|
|
11
|
-
store: ApiStore;
|
|
12
|
-
specType: ApiSpecType;
|
|
13
|
-
};
|
|
14
|
-
export declare function buildItems(props: ApiDocProps): Promise<BuildItemsResult>;
|
|
15
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { DocumentNode, GraphQLSchema } from 'graphql';
|
|
2
|
-
import type { AdapterBuildContextInput } from '../../../types/store.js';
|
|
3
|
-
import type { GraphqlBuildContext as BuildContext } from '../../../types/graphql.js';
|
|
4
|
-
export type CreateBuildContextInputWithDocumentAndSchema = AdapterBuildContextInput & {
|
|
5
|
-
document: DocumentNode;
|
|
6
|
-
prebuiltSchema?: GraphQLSchema;
|
|
7
|
-
processContent?: boolean;
|
|
8
|
-
};
|
|
9
|
-
export declare function createBuildContext({ document, options, basePath, prebuiltSchema, processContent }: CreateBuildContextInputWithDocumentAndSchema): BuildContext;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare function getItemDoesNotMatchAnyGroupErrorMessage(itemDescription: string): string;
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { GraphqlItemVariant } from '../../../types/graphql.js';
|
|
2
|
-
import type { ApiItem } from '../../../types/store.js';
|
|
3
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../items/types.js';
|
|
4
|
-
export type GraphqlMenuGroupItemsBuilder = (args?: GraphqlMenuGroupItemsBuildParams) => ApiItem[];
|
|
5
|
-
export declare const GRAPHQL_MENU_GROUP_ITEM_BUILDERS: Record<GraphqlItemVariant, GraphqlMenuGroupItemsBuilder>;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../types/store.js';
|
|
2
|
-
import type { GraphqlItemVariant } from '../../../types/graphql.js';
|
|
3
|
-
export declare function createGroup({ typeGroup, items, label, parentPath }: {
|
|
4
|
-
items: ApiItem[];
|
|
5
|
-
typeGroup?: GraphqlItemVariant;
|
|
6
|
-
label?: string;
|
|
7
|
-
parentPath?: string;
|
|
8
|
-
}): ApiItem;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { DocumentNode } from 'graphql';
|
|
2
|
-
import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
|
|
3
|
-
export declare function processGraphqlDocument({ document, options, basePath, processContent }: ApiDocAdapterProps & {
|
|
4
|
-
document: DocumentNode;
|
|
5
|
-
processContent?: boolean;
|
|
6
|
-
}): {
|
|
7
|
-
items: ApiItem[];
|
|
8
|
-
store: ApiStore;
|
|
9
|
-
};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLDirective } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildDirectiveContent(directive: GraphQLDirective, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildDirectiveItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLEnumType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildEnumContent(enumType: GraphQLEnumType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLInputObjectType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildInputContent(input: GraphQLInputObjectType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildInputItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLInterfaceType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildInterfaceContent(interfaceType: GraphQLInterfaceType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildInterfaceItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLField } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildMutationContent(mutation: GraphQLField<unknown, unknown>, mutationName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildMutationItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLObjectType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildObjectContent(object: GraphQLObjectType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildObjectItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { GraphQLField } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ItemVariant } from '../../../../types/common.js';
|
|
4
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
5
|
-
type OperationType = 'query' | 'mutation' | 'subscription';
|
|
6
|
-
export declare function buildOperationContent(operation: GraphQLField<unknown, unknown>, rootTypeName: string, operationType: OperationType, variant: ItemVariant, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
7
|
-
export {};
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { Node } from '@markdoc/markdoc';
|
|
2
|
-
import type { ApiItemContent, ContentNode } from '../../../../types/content.js';
|
|
3
|
-
import type { ApiDocsOptions } from '../../../../types/options.js';
|
|
4
|
-
type OverviewOptions = {
|
|
5
|
-
options: ApiDocsOptions;
|
|
6
|
-
markdoc?: string | Node[];
|
|
7
|
-
sectionChildren: ContentNode[];
|
|
8
|
-
basePath: string;
|
|
9
|
-
};
|
|
10
|
-
export declare function buildOverviewContent(overviewOptions: OverviewOptions): ApiItemContent;
|
|
11
|
-
export {};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { ContentNode } from '../../../../types/content.js';
|
|
3
|
-
import type { GraphqlBuildContext as BuildContext } from '../../../../types/graphql.js';
|
|
4
|
-
export declare function buildOverviewItem(context: BuildContext, sectionChildren: ContentNode[]): ApiItem;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLField } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildQueryContent(query: GraphQLField<unknown, unknown>, queryName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildQueryItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLScalarType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildScalarContent(scalar: GraphQLScalarType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildScalarItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLField } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildSubscriptionContent(subscription: GraphQLField<unknown, unknown>, subscriptionName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildSubscriptionItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLUnionType } from 'graphql';
|
|
2
|
-
import type { ApiItemContent } from '../../../../types/content.js';
|
|
3
|
-
import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
|
|
4
|
-
export declare function buildUnionContent(union: GraphQLUnionType, markdownOptions: ParseMarkdownOptions): ApiItemContent;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import type { ApiItem } from '../../../../types/store.js';
|
|
2
|
-
import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
|
|
3
|
-
export declare function buildUnionItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { ResolvedNavLinkItem } from '@redocly/config';
|
|
2
|
-
import type { GroupItemNode } from '../../../types/content.js';
|
|
3
|
-
import type { GraphqlBuildContext, GraphqlItemVariant } from '../../../types/graphql.js';
|
|
4
|
-
export declare function buildGroupItemsPanelContent(items: ResolvedNavLinkItem[], context: GraphqlBuildContext, typeGroup?: GraphqlItemVariant): GroupItemNode;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { GraphQLDirective, GraphQLNamedType } from 'graphql';
|
|
2
|
-
import type { GraphqlDirectiveData, GraphqlTypeData } from '../../types/graphql-store.js';
|
|
3
|
-
export declare function serializeNamedType(type: GraphQLNamedType): GraphqlTypeData;
|
|
4
|
-
export declare function serializeDirective(directive: GraphQLDirective): GraphqlDirectiveData;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import type { GraphqlItemVariant } from '../../../types/graphql.js';
|
|
2
|
-
/**
|
|
3
|
-
* Built-in GraphQL scalar types.
|
|
4
|
-
* These are the standard scalars defined in the GraphQL specification.
|
|
5
|
-
*/
|
|
6
|
-
export declare const BUILT_IN_SCALARS: ReadonlySet<string>;
|
|
7
|
-
/**
|
|
8
|
-
* Built-in GraphQL directives.
|
|
9
|
-
* These are the standard directives defined in the GraphQL specification.
|
|
10
|
-
*/
|
|
11
|
-
export declare const BUILT_IN_DIRECTIVES: ReadonlySet<string>;
|
|
12
|
-
export declare const GRAPHQL_VARIANTS: readonly ["query", "mutation", "subscription", "directive", "object", "interface", "union", "enum", "input", "scalar"];
|
|
13
|
-
declare const menuGroupFilterKey: {
|
|
14
|
-
readonly ITEMS: 'items';
|
|
15
|
-
readonly QUERIES: 'queries';
|
|
16
|
-
readonly MUTATIONS: 'mutations';
|
|
17
|
-
readonly SUBSCRIPTIONS: 'subscriptions';
|
|
18
|
-
readonly TYPES: 'types';
|
|
19
|
-
readonly DIRECTIVES: 'directives';
|
|
20
|
-
};
|
|
21
|
-
export type MenuGroupFilterKey = (typeof menuGroupFilterKey)[keyof typeof menuGroupFilterKey];
|
|
22
|
-
export declare const MENU_GROUP_FILTER_KEYS: MenuGroupFilterKey[];
|
|
23
|
-
export declare const DEFAULT_GROUP_LABELS: Record<GraphqlItemVariant, string>;
|
|
24
|
-
export {};
|