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.
Files changed (513) hide show
  1. package/bundles/redoc.d.ts +328 -31
  2. package/bundles/redoc.js +1078 -1349
  3. package/bundles/redoc.standalone.d.ts +327 -31
  4. package/bundles/redoc.standalone.js +1003 -1087
  5. package/package.json +42 -36
  6. package/typings/.tsbuildinfo +0 -1
  7. package/typings/RedocStandalone.d.ts +0 -43
  8. package/typings/RedoclyApiDocs.d.ts +0 -22
  9. package/typings/RedoclyApiDocsStandalone.d.ts +0 -22
  10. package/typings/adapters/asyncapi/build/context.d.ts +0 -9
  11. package/typings/adapters/asyncapi/build/navigation.d.ts +0 -2
  12. package/typings/adapters/asyncapi/build/utils.d.ts +0 -3
  13. package/typings/adapters/asyncapi/buildContext.d.ts +0 -2
  14. package/typings/adapters/asyncapi/index.d.ts +0 -13
  15. package/typings/adapters/asyncapi/items/channel/content.d.ts +0 -5
  16. package/typings/adapters/asyncapi/items/channel/item.d.ts +0 -13
  17. package/typings/adapters/asyncapi/items/operation/content.d.ts +0 -4
  18. package/typings/adapters/asyncapi/items/operation/item.d.ts +0 -15
  19. package/typings/adapters/asyncapi/items/overview/content.d.ts +0 -10
  20. package/typings/adapters/asyncapi/items/overview/item.d.ts +0 -16
  21. package/typings/adapters/asyncapi/panels/brokers.d.ts +0 -7
  22. package/typings/adapters/asyncapi/panels/download.d.ts +0 -3
  23. package/typings/adapters/asyncapi/panels/group.d.ts +0 -16
  24. package/typings/adapters/asyncapi/panels/overview.d.ts +0 -3
  25. package/typings/adapters/asyncapi/store.d.ts +0 -4
  26. package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts +0 -4
  27. package/typings/adapters/asyncapi/utils/get-channel-label.d.ts +0 -3
  28. package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts +0 -24
  29. package/typings/adapters/asyncapi/utils/resolve-schema.d.ts +0 -2
  30. package/typings/adapters/asyncapi/utils/resolve-server-variables.d.ts +0 -3
  31. package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts +0 -2
  32. package/typings/adapters/asyncapi/utils/security.d.ts +0 -12
  33. package/typings/adapters/build.d.ts +0 -15
  34. package/typings/adapters/graphql/build/context.d.ts +0 -9
  35. package/typings/adapters/graphql/buildContext.d.ts +0 -2
  36. package/typings/adapters/graphql/buildStoreFromSdl.d.ts +0 -2
  37. package/typings/adapters/graphql/group/custom.d.ts +0 -2
  38. package/typings/adapters/graphql/group/default.d.ts +0 -2
  39. package/typings/adapters/graphql/group/errors.d.ts +0 -1
  40. package/typings/adapters/graphql/group/itemBuilders.d.ts +0 -5
  41. package/typings/adapters/graphql/group/utils.d.ts +0 -8
  42. package/typings/adapters/graphql/index.d.ts +0 -9
  43. package/typings/adapters/graphql/items/directive/content.d.ts +0 -4
  44. package/typings/adapters/graphql/items/directive/item.d.ts +0 -3
  45. package/typings/adapters/graphql/items/enum/content.d.ts +0 -4
  46. package/typings/adapters/graphql/items/enum/item.d.ts +0 -3
  47. package/typings/adapters/graphql/items/input/content.d.ts +0 -4
  48. package/typings/adapters/graphql/items/input/item.d.ts +0 -3
  49. package/typings/adapters/graphql/items/interface/content.d.ts +0 -4
  50. package/typings/adapters/graphql/items/interface/item.d.ts +0 -3
  51. package/typings/adapters/graphql/items/mutation/content.d.ts +0 -4
  52. package/typings/adapters/graphql/items/mutation/item.d.ts +0 -3
  53. package/typings/adapters/graphql/items/object/content.d.ts +0 -4
  54. package/typings/adapters/graphql/items/object/item.d.ts +0 -3
  55. package/typings/adapters/graphql/items/operation/content.d.ts +0 -7
  56. package/typings/adapters/graphql/items/overview/content.d.ts +0 -11
  57. package/typings/adapters/graphql/items/overview/item.d.ts +0 -4
  58. package/typings/adapters/graphql/items/query/content.d.ts +0 -4
  59. package/typings/adapters/graphql/items/query/item.d.ts +0 -3
  60. package/typings/adapters/graphql/items/scalar/content.d.ts +0 -4
  61. package/typings/adapters/graphql/items/scalar/item.d.ts +0 -3
  62. package/typings/adapters/graphql/items/subscription/content.d.ts +0 -4
  63. package/typings/adapters/graphql/items/subscription/item.d.ts +0 -3
  64. package/typings/adapters/graphql/items/types.d.ts +0 -7
  65. package/typings/adapters/graphql/items/union/content.d.ts +0 -4
  66. package/typings/adapters/graphql/items/union/item.d.ts +0 -3
  67. package/typings/adapters/graphql/panels/download.d.ts +0 -3
  68. package/typings/adapters/graphql/panels/group-items.d.ts +0 -4
  69. package/typings/adapters/graphql/panels/overview.d.ts +0 -3
  70. package/typings/adapters/graphql/serializeType.d.ts +0 -4
  71. package/typings/adapters/graphql/store.d.ts +0 -3
  72. package/typings/adapters/graphql/utils/configMetadataRows.d.ts +0 -3
  73. package/typings/adapters/graphql/utils/constants.d.ts +0 -24
  74. package/typings/adapters/graphql/utils/createApiItem.d.ts +0 -15
  75. package/typings/adapters/graphql/utils/getBadges.d.ts +0 -4
  76. package/typings/adapters/graphql/utils/ignoreInternalItems.d.ts +0 -3
  77. package/typings/adapters/graphql/utils/isRootType.d.ts +0 -2
  78. package/typings/adapters/graphql/utils/menuSlashRegex.d.ts +0 -1
  79. package/typings/adapters/graphql/utils/normalizeMenu.d.ts +0 -3
  80. package/typings/adapters/graphql/utils/shouldIncludeItem.d.ts +0 -2
  81. package/typings/adapters/graphql/utils/summary.d.ts +0 -4
  82. package/typings/adapters/graphql/utils/validateMenuConfig.d.ts +0 -3
  83. package/typings/adapters/helpers.d.ts +0 -44
  84. package/typings/adapters/openapi/build/context.d.ts +0 -13
  85. package/typings/adapters/openapi/build-code-sample-source.d.ts +0 -4
  86. package/typings/adapters/openapi/buildContext.d.ts +0 -2
  87. package/typings/adapters/openapi/constants.d.ts +0 -4
  88. package/typings/adapters/openapi/group/content.d.ts +0 -25
  89. package/typings/adapters/openapi/group/item.d.ts +0 -8
  90. package/typings/adapters/openapi/index.d.ts +0 -11
  91. package/typings/adapters/openapi/items/mcp/content.d.ts +0 -5
  92. package/typings/adapters/openapi/items/mcp/item.d.ts +0 -9
  93. package/typings/adapters/openapi/items/operation/content.d.ts +0 -12
  94. package/typings/adapters/openapi/items/operation/item.d.ts +0 -9
  95. package/typings/adapters/openapi/items/overview/content.d.ts +0 -17
  96. package/typings/adapters/openapi/items/overview/item.d.ts +0 -3
  97. package/typings/adapters/openapi/items/schema/content.d.ts +0 -3
  98. package/typings/adapters/openapi/items/schema/item.d.ts +0 -9
  99. package/typings/adapters/openapi/panels/download.d.ts +0 -3
  100. package/typings/adapters/openapi/panels/mcp.d.ts +0 -3
  101. package/typings/adapters/openapi/panels/overview.d.ts +0 -3
  102. package/typings/adapters/openapi/panels/servers.d.ts +0 -3
  103. package/typings/adapters/openapi/resolve-openapi-example-value.d.ts +0 -3
  104. package/typings/adapters/openapi/store.d.ts +0 -4
  105. package/typings/adapters/openapi/utils/JsonPointer.d.ts +0 -50
  106. package/typings/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts +0 -1
  107. package/typings/adapters/openapi/utils/helpers.d.ts +0 -12
  108. package/typings/adapters/openapi/utils/operation.d.ts +0 -24
  109. package/typings/adapters/openapi/utils/resolvePathItemRef.d.ts +0 -2
  110. package/typings/adapters/openapi/utils/url.d.ts +0 -2
  111. package/typings/adapters/rbac.d.ts +0 -10
  112. package/typings/adapters/scopedContext.d.ts +0 -5
  113. package/typings/adapters/utils/dompurify.d.ts +0 -5
  114. package/typings/adapters/utils/isPlainText.d.ts +0 -6
  115. package/typings/adapters/utils/markdoc.d.ts +0 -54
  116. package/typings/adapters/utils/parseMarkdown.d.ts +0 -8
  117. package/typings/adapters/utils/simplifyAstStructure.d.ts +0 -2
  118. package/typings/ajv-stub.d.ts +0 -4
  119. package/typings/components/AdmonitionItem.d.ts +0 -6
  120. package/typings/components/ChannelAddressItem.d.ts +0 -7
  121. package/typings/components/ContainerItem.d.ts +0 -9
  122. package/typings/components/EmptyMessageItem.d.ts +0 -6
  123. package/typings/components/ErrorBoundary.d.ts +0 -20
  124. package/typings/components/ExtensionsItem.d.ts +0 -7
  125. package/typings/components/ExternalDocsItem.d.ts +0 -8
  126. package/typings/components/Header/HeaderItem.d.ts +0 -10
  127. package/typings/components/Header/HeaderPageActions.d.ts +0 -4
  128. package/typings/components/Header/HeaderResponseCodeTabs.d.ts +0 -8
  129. package/typings/components/Header/PageActions.d.ts +0 -4
  130. package/typings/components/Header/ResponseDeepLinkAnchor.d.ts +0 -9
  131. package/typings/components/Header/hooks.d.ts +0 -5
  132. package/typings/components/InfoMetadataItem.d.ts +0 -7
  133. package/typings/components/ItemContent/ItemContentRenderer.d.ts +0 -8
  134. package/typings/components/ItemContent/SectionHeader.d.ts +0 -8
  135. package/typings/components/ItemContent/hooks.d.ts +0 -17
  136. package/typings/components/ItemContent/sections/BodyMimeTypeField.d.ts +0 -12
  137. package/typings/components/ItemContent/sections/BodySection.d.ts +0 -7
  138. package/typings/components/ItemContent/sections/CallbacksSection.d.ts +0 -5
  139. package/typings/components/ItemContent/sections/FieldsSection.d.ts +0 -7
  140. package/typings/components/ItemContent/sections/MessagesSection.d.ts +0 -5
  141. package/typings/components/ItemContent/sections/ParametersSection.d.ts +0 -6
  142. package/typings/components/ItemContent/sections/ResponsesSection.d.ts +0 -5
  143. package/typings/components/ItemContent/sections/ValuesSection.d.ts +0 -5
  144. package/typings/components/Mapper.d.ts +0 -22
  145. package/typings/components/MarkdownItem.d.ts +0 -6
  146. package/typings/components/Mcp/McpPrompt.d.ts +0 -8
  147. package/typings/components/Mcp/McpResource.d.ts +0 -8
  148. package/typings/components/Mcp/McpTool.d.ts +0 -8
  149. package/typings/components/Mcp/styled.d.ts +0 -22
  150. package/typings/components/Mcp/utils.d.ts +0 -7
  151. package/typings/components/MessageLinksItem.d.ts +0 -7
  152. package/typings/components/PrePaintColorModeScript.d.ts +0 -12
  153. package/typings/components/Schema/SchemaDescription.d.ts +0 -5
  154. package/typings/components/Schema/SchemaView.d.ts +0 -20
  155. package/typings/components/Schema/helpers.d.ts +0 -1
  156. package/typings/components/Schema/hooks/useSchemaDocument.d.ts +0 -7
  157. package/typings/components/Schema/hooks/useSchemaFieldDeepLink.d.ts +0 -5
  158. package/typings/components/Schema/hooks/useVariantIndexFromHash.d.ts +0 -1
  159. package/typings/components/Schema/styled.d.ts +0 -235
  160. package/typings/components/Schema/utils.d.ts +0 -15
  161. package/typings/components/Schema/views/ArrayRenderer.d.ts +0 -12
  162. package/typings/components/Schema/views/CollapsibleNestedFields.d.ts +0 -24
  163. package/typings/components/Schema/views/DefaultMappingOptionLabel.d.ts +0 -5
  164. package/typings/components/Schema/views/DiscriminatorPropertyRow.d.ts +0 -13
  165. package/typings/components/Schema/views/Examples.d.ts +0 -7
  166. package/typings/components/Schema/views/ExpandableExample.d.ts +0 -4
  167. package/typings/components/Schema/views/ObjectRenderer.d.ts +0 -13
  168. package/typings/components/Schema/views/Pattern.d.ts +0 -6
  169. package/typings/components/Schema/views/PrimitiveRenderer.d.ts +0 -5
  170. package/typings/components/Schema/views/PropertyFieldRow.d.ts +0 -15
  171. package/typings/components/Schema/views/PropertyRenderer.d.ts +0 -14
  172. package/typings/components/Schema/views/SchemaEnumDescriptions.d.ts +0 -9
  173. package/typings/components/Schema/views/SchemaEnumValues.d.ts +0 -8
  174. package/typings/components/Schema/views/SchemaTitleLabel.d.ts +0 -5
  175. package/typings/components/Schema/views/SchemaVariantSelector.d.ts +0 -11
  176. package/typings/components/Schema/views/SwitcherRenderer.d.ts +0 -13
  177. package/typings/components/Schema/views/VariantDropdown.d.ts +0 -14
  178. package/typings/components/Search/Search.d.ts +0 -10
  179. package/typings/components/Search/SearchDialog.d.ts +0 -7
  180. package/typings/components/Search/SearchTrigger.d.ts +0 -9
  181. package/typings/components/Search/index.d.ts +0 -1
  182. package/typings/components/Security/Divider.d.ts +0 -4
  183. package/typings/components/Security/RequiredScopes.d.ts +0 -4
  184. package/typings/components/Security/ScopeTagWithTooltip.d.ts +0 -11
  185. package/typings/components/Security/SecurityButtonPanel.d.ts +0 -5
  186. package/typings/components/Security/SecurityFlowDetail.d.ts +0 -5
  187. package/typings/components/Security/SecurityModal.d.ts +0 -6
  188. package/typings/components/Security/SecuritySection.d.ts +0 -3
  189. package/typings/components/Security/styled.d.ts +0 -127
  190. package/typings/components/Security/types.d.ts +0 -3
  191. package/typings/components/SideMenu/SideMenu.d.ts +0 -7
  192. package/typings/components/SideMenu/buildMenuItems.d.ts +0 -29
  193. package/typings/components/SideMenu/useMenuItems.d.ts +0 -14
  194. package/typings/components/StickySidebar/FloatingButton.d.ts +0 -1
  195. package/typings/components/StickySidebar/RedoclyAttributionLogo.d.ts +0 -5
  196. package/typings/components/StickySidebar/SidebarActions.d.ts +0 -2
  197. package/typings/components/StickySidebar/StickySidebar.d.ts +0 -7
  198. package/typings/components/common/Badge.d.ts +0 -32
  199. package/typings/components/common/Breadcrumbs.d.ts +0 -11
  200. package/typings/components/common/ContentWrapper.d.ts +0 -13
  201. package/typings/components/common/DeepLinkAnchor.d.ts +0 -20
  202. package/typings/components/common/ExpandAllButton.d.ts +0 -6
  203. package/typings/components/common/ExternalDocumentation.d.ts +0 -10
  204. package/typings/components/common/LazyMount.d.ts +0 -9
  205. package/typings/components/common/LazySection.d.ts +0 -14
  206. package/typings/components/common/Markdown.d.ts +0 -7
  207. package/typings/components/common/MoreDetailsButton.d.ts +0 -5
  208. package/typings/components/common/NestedToggleButton.d.ts +0 -10
  209. package/typings/components/common/PanelItem.d.ts +0 -27
  210. package/typings/components/common/ResponseCodeTabs.d.ts +0 -9
  211. package/typings/components/common/Tag.d.ts +0 -3
  212. package/typings/components/common/VendorExtensions.d.ts +0 -7
  213. package/typings/components/common/ViewNested.d.ts +0 -13
  214. package/typings/components/graphql/ArrowIcon.d.ts +0 -7
  215. package/typings/components/graphql/GraphQLArgumentsSection.d.ts +0 -10
  216. package/typings/components/graphql/GraphQLEnumEmbedded.d.ts +0 -5
  217. package/typings/components/graphql/GraphQLFieldView.d.ts +0 -12
  218. package/typings/components/graphql/GraphQLFieldsEmbedded.d.ts +0 -9
  219. package/typings/components/graphql/GraphQLGroupTypeList.d.ts +0 -5
  220. package/typings/components/graphql/GraphQLHeaderExtras.d.ts +0 -7
  221. package/typings/components/graphql/GraphQLReturnTypeDetails.d.ts +0 -11
  222. package/typings/components/graphql/GraphQLTypeView.d.ts +0 -9
  223. package/typings/components/graphql/GraphQLUnionEmbedded.d.ts +0 -5
  224. package/typings/components/graphql/RequiresScopesButton.d.ts +0 -9
  225. package/typings/components/graphql/RequiresScopesModal.d.ts +0 -9
  226. package/typings/components/graphql/ViewNested.d.ts +0 -14
  227. package/typings/components/graphql/renderDescription.d.ts +0 -2
  228. package/typings/components/graphql/sections/GraphQLArgsSection.d.ts +0 -5
  229. package/typings/components/graphql/sections/GraphQLFieldsSection.d.ts +0 -5
  230. package/typings/components/graphql/sections/ImplementedBySection.d.ts +0 -5
  231. package/typings/components/graphql/sections/ImplementsSection.d.ts +0 -5
  232. package/typings/components/graphql/sections/PossibleTypesSection.d.ts +0 -5
  233. package/typings/components/graphql/sections/RequiresScopesSection.d.ts +0 -5
  234. package/typings/components/graphql/sections/ReturnTypeSection.d.ts +0 -5
  235. package/typings/components/graphql/styled.d.ts +0 -55
  236. package/typings/components/markdoc/Heading.d.ts +0 -11
  237. package/typings/components/markdoc/SchemaDefinition.d.ts +0 -11
  238. package/typings/components/markdoc/apiDocsMarkdocComponents.d.ts +0 -6
  239. package/typings/components/markdoc/buildMarkdocOptions.d.ts +0 -9
  240. package/typings/components/markdoc/defaultMarkdocConfig.d.ts +0 -4
  241. package/typings/components/markdoc/html/html-jsx-attribute-mapping.d.ts +0 -5
  242. package/typings/components/markdoc/html/process-html-tokens.d.ts +0 -2
  243. package/typings/components/markdoc/markdocAdapter.d.ts +0 -12
  244. package/typings/components/markdoc/markdocParser.d.ts +0 -8
  245. package/typings/components/markdoc/markdocRenderer.d.ts +0 -8
  246. package/typings/components/markdoc/tags/mcp-tag-schemas.d.ts +0 -2
  247. package/typings/components/markdoc/tags/schema-definition-tag.d.ts +0 -2
  248. package/typings/components/panels/ConnectMcpButton.d.ts +0 -5
  249. package/typings/components/panels/DownloadPanelItem.d.ts +0 -5
  250. package/typings/components/panels/ExampleItem/CallbackPayloadItem.d.ts +0 -5
  251. package/typings/components/panels/ExampleItem/CodeSampleItem.d.ts +0 -5
  252. package/typings/components/panels/ExampleItem/ExamplesPanelItem.d.ts +0 -3
  253. package/typings/components/panels/ExampleItem/GraphQLQueryItem.d.ts +0 -5
  254. package/typings/components/panels/ExampleItem/GraphQLResponseItem.d.ts +0 -5
  255. package/typings/components/panels/ExampleItem/GraphQLTypeSampleItem.d.ts +0 -5
  256. package/typings/components/panels/ExampleItem/GraphQLVariablesItem.d.ts +0 -5
  257. package/typings/components/panels/ExampleItem/PayloadExampleItem.d.ts +0 -5
  258. package/typings/components/panels/ExampleItem/ResponseExampleItem.d.ts +0 -5
  259. package/typings/components/panels/ExampleItem/ServerDropdown.d.ts +0 -17
  260. package/typings/components/panels/ExampleItem/hooks.d.ts +0 -28
  261. package/typings/components/panels/ExampleItem/selectors.d.ts +0 -42
  262. package/typings/components/panels/ExampleItem/styled.d.ts +0 -98
  263. package/typings/components/panels/ExampleItem/types.d.ts +0 -6
  264. package/typings/components/panels/ExampleItem/useCodeSampleLanguages.d.ts +0 -22
  265. package/typings/components/panels/GroupPanelItem.d.ts +0 -5
  266. package/typings/components/panels/LanguageItem/LanguageDropdown.d.ts +0 -15
  267. package/typings/components/panels/LanguageItem/LanguageItem.d.ts +0 -11
  268. package/typings/components/panels/LanguageItem/styled.d.ts +0 -58
  269. package/typings/components/panels/LocationsPanelItem.d.ts +0 -5
  270. package/typings/components/panels/McpExamplePanelItem.d.ts +0 -5
  271. package/typings/components/panels/McpPanelItem.d.ts +0 -3
  272. package/typings/components/panels/OverviewPanelItem.d.ts +0 -3
  273. package/typings/components/panels/PanelMapper.d.ts +0 -5
  274. package/typings/components/panels/PanelNodeProps.d.ts +0 -4
  275. package/typings/components/panels/ReferencesPanelItem.d.ts +0 -5
  276. package/typings/components/panels/ServerItem/ServerDescriptionTooltip.d.ts +0 -4
  277. package/typings/components/panels/ServerItem/ServerItem.d.ts +0 -5
  278. package/typings/components/panels/ServerItem/ServerPanelItem.d.ts +0 -5
  279. package/typings/components/panels/asyncapi/BrokerItem/BrokerBindingsSection.d.ts +0 -7
  280. package/typings/components/panels/asyncapi/BrokerItem/BrokerModal.d.ts +0 -8
  281. package/typings/components/panels/asyncapi/BrokerItem/BrokerOverviewSection.d.ts +0 -6
  282. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanel.styled.d.ts +0 -21
  283. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanelItem.d.ts +0 -5
  284. package/typings/components/panels/asyncapi/ChannelBindingItem/ChannelBindingItem.d.ts +0 -5
  285. package/typings/components/panels/asyncapi/MessageBindingItem/MessageBindingItem.d.ts +0 -5
  286. package/typings/components/panels/asyncapi/MessageReferencesItem/MessageReferencesItem.d.ts +0 -5
  287. package/typings/components/panels/asyncapi/OperationBindingItem/OperationBindingItem.d.ts +0 -5
  288. package/typings/components/panels/asyncapi/common/bindingPanel.d.ts +0 -30
  289. package/typings/components/panels/shared-panel-styles.d.ts +0 -13
  290. package/typings/components/panels/styled.d.ts +0 -12
  291. package/typings/constants/openapi.d.ts +0 -25
  292. package/typings/constants/rendering.d.ts +0 -8
  293. package/typings/contexts/markdownAdapter.d.ts +0 -21
  294. package/typings/contexts/telemetry.d.ts +0 -4
  295. package/typings/crypto-compat.d.ts +0 -5
  296. package/typings/crypto-uuid-compat.d.ts +0 -1
  297. package/typings/empty-linkedom.d.ts +0 -1
  298. package/typings/empty.d.ts +0 -7
  299. package/typings/events/codeSampleCopy.d.ts +0 -2
  300. package/typings/events/creator.d.ts +0 -2
  301. package/typings/events/languageSwitch.d.ts +0 -2
  302. package/typings/events/serverSwitch.d.ts +0 -2
  303. package/typings/events/types.d.ts +0 -6
  304. package/typings/hoc/withItemId.d.ts +0 -6
  305. package/typings/hoc/withRouter.d.ts +0 -4
  306. package/typings/hoc/withStoreProvider.d.ts +0 -24
  307. package/typings/hooks/code-highlight-languages.d.ts +0 -6
  308. package/typings/hooks/deepLinkHash.d.ts +0 -7
  309. package/typings/hooks/useAgentTools.d.ts +0 -6
  310. package/typings/hooks/useApiDocsRoutes.d.ts +0 -8
  311. package/typings/hooks/useApiDocsScroll.d.ts +0 -9
  312. package/typings/hooks/useBodyScrollLock.d.ts +0 -1
  313. package/typings/hooks/useCodeHighlight.d.ts +0 -15
  314. package/typings/hooks/useCopyCodeTelemetry.d.ts +0 -14
  315. package/typings/hooks/useCopySpecSlice.d.ts +0 -9
  316. package/typings/hooks/useDeepLinkSection.d.ts +0 -16
  317. package/typings/hooks/useExpandableSection.d.ts +0 -4
  318. package/typings/hooks/useHashLinkRedirect.d.ts +0 -4
  319. package/typings/hooks/useInitialTelemetry.d.ts +0 -3
  320. package/typings/hooks/useIsExpanded.d.ts +0 -1
  321. package/typings/hooks/useIsHydrated.d.ts +0 -4
  322. package/typings/hooks/useManualScrollAnchor.d.ts +0 -19
  323. package/typings/hooks/useModalDismiss.d.ts +0 -2
  324. package/typings/hooks/useNormalizeUrl.d.ts +0 -2
  325. package/typings/hooks/usePageTelemetry.d.ts +0 -3
  326. package/typings/hooks/usePageViewTelemetry.d.ts +0 -2
  327. package/typings/hooks/usePerformanceMetricsTelemetry.d.ts +0 -5
  328. package/typings/hooks/useRouterHashBridge.d.ts +0 -24
  329. package/typings/hooks/useScrollSpyUrlSync.d.ts +0 -3
  330. package/typings/hooks/useSearchEngine.d.ts +0 -7
  331. package/typings/hooks/useSessionSummaryTelemetry.d.ts +0 -7
  332. package/typings/hooks/useTelemetry.d.ts +0 -2
  333. package/typings/hooks/useTranslate.d.ts +0 -5
  334. package/typings/hooks/useUrlHash.d.ts +0 -8
  335. package/typings/hooks/useUrlHashReassert.d.ts +0 -2
  336. package/typings/hooks/useUserScrollIntent.d.ts +0 -18
  337. package/typings/hooks/useVisitedChannelsTracker.d.ts +0 -6
  338. package/typings/icons/CSharpIcon/CSharpIcon.d.ts +0 -3
  339. package/typings/icons/CurlIcon/CurlIcon.d.ts +0 -13
  340. package/typings/icons/DefaultMappingIcon/DefaultMappingIcon.d.ts +0 -13
  341. package/typings/icons/GOIcon/GOIcon.d.ts +0 -3
  342. package/typings/icons/JavaIcon/JavaIcon.d.ts +0 -3
  343. package/typings/icons/JavaScriptIcon/JavaScriptIcon.d.ts +0 -3
  344. package/typings/icons/ListIcon/ListIcon.d.ts +0 -9
  345. package/typings/icons/NodeJSIcon/NodeJSIcon.d.ts +0 -3
  346. package/typings/icons/PHPIcon/PHPIcon.d.ts +0 -3
  347. package/typings/icons/PayloadIcon/PayloadIcon.d.ts +0 -3
  348. package/typings/icons/PlusCircleIcon/PlusCircleIcon.d.ts +0 -7
  349. package/typings/icons/PythonIcon/PythonIcon.d.ts +0 -3
  350. package/typings/icons/RIcon/RIcon.d.ts +0 -3
  351. package/typings/icons/RubyIcon/RubyIcon.d.ts +0 -3
  352. package/typings/index.d.ts +0 -9
  353. package/typings/jotai/app.d.ts +0 -66
  354. package/typings/jotai/examples.d.ts +0 -5
  355. package/typings/jotai/graphql.d.ts +0 -10
  356. package/typings/jotai/itemStore.d.ts +0 -60
  357. package/typings/jotai/routes.d.ts +0 -4
  358. package/typings/jotai/schema.d.ts +0 -3
  359. package/typings/jotai/store.d.ts +0 -22
  360. package/typings/jotai/telemetry.d.ts +0 -46
  361. package/typings/options/constants.d.ts +0 -10
  362. package/typings/options/editionOverrides.d.ts +0 -3
  363. package/typings/options/helpers.d.ts +0 -19
  364. package/typings/options/normalizeOptions.d.ts +0 -2
  365. package/typings/options/standaloneLayoutVars.d.ts +0 -3
  366. package/typings/otel-semantic-conventions.d.ts +0 -10
  367. package/typings/pages/EntryPage.d.ts +0 -25
  368. package/typings/pages/GroupPage.d.ts +0 -1
  369. package/typings/pages/ItemPage.d.ts +0 -1
  370. package/typings/pages/NotFoundPage.d.ts +0 -6
  371. package/typings/pages/OverviewPage.d.ts +0 -1
  372. package/typings/pages/TopLevelEntryView.d.ts +0 -17
  373. package/typings/services/agent-tools/index.d.ts +0 -10
  374. package/typings/services/agent-tools/operations.d.ts +0 -20
  375. package/typings/services/agent-tools/results.d.ts +0 -6
  376. package/typings/services/agent-tools/security.d.ts +0 -13
  377. package/typings/services/agent-tools/spec-slice-detail.d.ts +0 -12
  378. package/typings/services/agent-tools/types.d.ts +0 -55
  379. package/typings/services/agent-tools/webmcp.d.ts +0 -14
  380. package/typings/services/code-samples/convertSampleToString.d.ts +0 -3
  381. package/typings/services/code-samples/discriminator.d.ts +0 -65
  382. package/typings/services/code-samples/example-key.d.ts +0 -13
  383. package/typings/services/code-samples/index.d.ts +0 -2
  384. package/typings/services/code-samples/language-availability.d.ts +0 -4
  385. package/typings/services/code-samples/normalize-servers.d.ts +0 -3
  386. package/typings/services/code-samples/server-env.d.ts +0 -3
  387. package/typings/services/code-samples/server-variables.d.ts +0 -9
  388. package/typings/services/code-samples/source.d.ts +0 -81
  389. package/typings/services/schema/dialects/graphqlSchema.d.ts +0 -1
  390. package/typings/services/schema/dialects/jsonSchema.d.ts +0 -7
  391. package/typings/services/schema/index.d.ts +0 -1
  392. package/typings/services/schema/propertyBuilder.d.ts +0 -31
  393. package/typings/services/schema/propertyTreeBuilder.d.ts +0 -21
  394. package/typings/services/schema/schemaProcessor.d.ts +0 -2
  395. package/typings/services/schema/variant-label.d.ts +0 -6
  396. package/typings/services/search/engine/collapse.d.ts +0 -5
  397. package/typings/services/search/engine/constants.d.ts +0 -22
  398. package/typings/services/search/engine/flexsearch.d.ts +0 -6
  399. package/typings/services/search/engine/index.d.ts +0 -11
  400. package/typings/services/search/engine/lowered.d.ts +0 -34
  401. package/typings/services/search/engine/match.d.ts +0 -12
  402. package/typings/services/search/engine/present.d.ts +0 -5
  403. package/typings/services/search/engine/query.d.ts +0 -6
  404. package/typings/services/search/engine/score.d.ts +0 -7
  405. package/typings/services/search/engine/text.d.ts +0 -3
  406. package/typings/services/search/engine/types.d.ts +0 -19
  407. package/typings/services/search/highlight.d.ts +0 -3
  408. package/typings/services/search/indexer/context.d.ts +0 -8
  409. package/typings/services/search/indexer/deep-links.d.ts +0 -12
  410. package/typings/services/search/indexer/extractors/asyncapi.d.ts +0 -8
  411. package/typings/services/search/indexer/extractors/body.d.ts +0 -2
  412. package/typings/services/search/indexer/extractors/callbacks.d.ts +0 -4
  413. package/typings/services/search/indexer/extractors/context.d.ts +0 -25
  414. package/typings/services/search/indexer/extractors/examples.d.ts +0 -3
  415. package/typings/services/search/indexer/extractors/graphql.d.ts +0 -2
  416. package/typings/services/search/indexer/extractors/heading-sections.d.ts +0 -3
  417. package/typings/services/search/indexer/extractors/index.d.ts +0 -11
  418. package/typings/services/search/indexer/extractors/mcp.d.ts +0 -9
  419. package/typings/services/search/indexer/extractors/named-rows.d.ts +0 -2
  420. package/typings/services/search/indexer/extractors/panels.d.ts +0 -10
  421. package/typings/services/search/indexer/extractors/parameters.d.ts +0 -2
  422. package/typings/services/search/indexer/extractors/responses.d.ts +0 -2
  423. package/typings/services/search/indexer/extractors/schema-page.d.ts +0 -9
  424. package/typings/services/search/indexer/extractors/security.d.ts +0 -4
  425. package/typings/services/search/indexer/index.d.ts +0 -14
  426. package/typings/services/search/indexer/param.d.ts +0 -7
  427. package/typings/services/search/indexer/places.d.ts +0 -36
  428. package/typings/services/search/indexer/schema-walker.d.ts +0 -29
  429. package/typings/services/search/indexer/text.d.ts +0 -2
  430. package/typings/services/search/init.d.ts +0 -7
  431. package/typings/services/search/text-match.d.ts +0 -5
  432. package/typings/services/search/types.d.ts +0 -31
  433. package/typings/services/spec-convert/asyncapi.d.ts +0 -11
  434. package/typings/services/spec-convert/index.d.ts +0 -5
  435. package/typings/services/spec-convert/swagger/parameters.d.ts +0 -6
  436. package/typings/services/spec-convert/swagger/refs.d.ts +0 -34
  437. package/typings/services/spec-convert/swagger/responses.d.ts +0 -2
  438. package/typings/services/spec-convert/swagger/schema.d.ts +0 -1
  439. package/typings/services/spec-convert/swagger.d.ts +0 -7
  440. package/typings/services/spec-slice/assistant-links.d.ts +0 -9
  441. package/typings/services/spec-slice/asyncapi-slice.d.ts +0 -5
  442. package/typings/services/spec-slice/clone-strip.d.ts +0 -1
  443. package/typings/services/spec-slice/component-closure.d.ts +0 -6
  444. package/typings/services/spec-slice/graphql-slice.d.ts +0 -2
  445. package/typings/services/spec-slice/index.d.ts +0 -6
  446. package/typings/services/spec-slice/openapi-slice.d.ts +0 -6
  447. package/typings/services/spec-slice/resolve-scope.d.ts +0 -4
  448. package/typings/services/spec-slice/types.d.ts +0 -37
  449. package/typings/standalone.d.ts +0 -20
  450. package/typings/standaloneThemeConfig.d.ts +0 -3
  451. package/typings/telemetry/RedocTelemetry.d.ts +0 -22
  452. package/typings/telemetry/TypeOfUsageContext.d.ts +0 -3
  453. package/typings/telemetry/defaults.d.ts +0 -7
  454. package/typings/telemetry/events.d.ts +0 -41
  455. package/typings/telemetry/fields.d.ts +0 -7
  456. package/typings/telemetry/index.d.ts +0 -15
  457. package/typings/telemetry/initialPayload.d.ts +0 -56
  458. package/typings/telemetry/page.d.ts +0 -5
  459. package/typings/telemetry/reportDefinitionLoadFailed.d.ts +0 -9
  460. package/typings/telemetry/sanitizeError.d.ts +0 -4
  461. package/typings/telemetry/security.d.ts +0 -14
  462. package/typings/telemetry/useRedocTelemetryInstance.d.ts +0 -3
  463. package/typings/telemetry/useSchemaFieldTelemetry.d.ts +0 -4
  464. package/typings/telemetry/useSidebarItemTelemetry.d.ts +0 -11
  465. package/typings/types/asyncapi.d.ts +0 -314
  466. package/typings/types/code-samples-config.d.ts +0 -12
  467. package/typings/types/common.d.ts +0 -163
  468. package/typings/types/content.d.ts +0 -479
  469. package/typings/types/edition-config.d.ts +0 -6
  470. package/typings/types/events.d.ts +0 -48
  471. package/typings/types/graphql-store.d.ts +0 -60
  472. package/typings/types/graphql.d.ts +0 -53
  473. package/typings/types/openapi.d.ts +0 -515
  474. package/typings/types/options.d.ts +0 -90
  475. package/typings/types/schema.d.ts +0 -162
  476. package/typings/types/store.d.ts +0 -160
  477. package/typings/utils/calculateMaxLength.d.ts +0 -6
  478. package/typings/utils/compose.d.ts +0 -7
  479. package/typings/utils/cookies.d.ts +0 -7
  480. package/typings/utils/deep-link.d.ts +0 -163
  481. package/typings/utils/definitionLoadError.d.ts +0 -7
  482. package/typings/utils/environments.d.ts +0 -6
  483. package/typings/utils/expansion.d.ts +0 -3
  484. package/typings/utils/extract-extensions.d.ts +0 -4
  485. package/typings/utils/form-urlencoded.d.ts +0 -9
  486. package/typings/utils/graphql-directive-utils.d.ts +0 -6
  487. package/typings/utils/graphql-parse.d.ts +0 -1
  488. package/typings/utils/graphql-reference-map.d.ts +0 -3
  489. package/typings/utils/graphql-samples.d.ts +0 -29
  490. package/typings/utils/graphql-scopes.d.ts +0 -6
  491. package/typings/utils/graphql-type-expansion.d.ts +0 -5
  492. package/typings/utils/http-methods.d.ts +0 -8
  493. package/typings/utils/is-record.d.ts +0 -1
  494. package/typings/utils/languages.d.ts +0 -18
  495. package/typings/utils/loadAndBundleSpec.d.ts +0 -4
  496. package/typings/utils/logo.d.ts +0 -8
  497. package/typings/utils/media-type.d.ts +0 -5
  498. package/typings/utils/refPointer.d.ts +0 -2
  499. package/typings/utils/resolveSpec.d.ts +0 -20
  500. package/typings/utils/resolveText.d.ts +0 -2
  501. package/typings/utils/routeKind.d.ts +0 -6
  502. package/typings/utils/routing.d.ts +0 -49
  503. package/typings/utils/scroll-anchoring.d.ts +0 -4
  504. package/typings/utils/security-scope.d.ts +0 -3
  505. package/typings/utils/serialize-parameter.d.ts +0 -8
  506. package/typings/utils/session-storage.d.ts +0 -2
  507. package/typings/utils/split-badges-by-position.d.ts +0 -5
  508. package/typings/utils/status-code.d.ts +0 -1
  509. package/typings/utils/string.d.ts +0 -14
  510. package/typings/utils/url.d.ts +0 -9
  511. package/typings/utils/x-logo.d.ts +0 -13
  512. package/typings/utils/xml.d.ts +0 -1
  513. package/typings/utils/yaml.d.ts +0 -2
@@ -1,6 +0,0 @@
1
- export type ComponentClosure = {
2
- keep: Map<string, Set<string>>;
3
- inlineTargets: Map<string, unknown>;
4
- };
5
- export declare function collectComponentClosure(document: Record<string, unknown>, seeds: unknown[], retainRef?: (ref: string) => boolean): ComponentClosure;
6
- export declare function buildComponentsFromClosure(document: Record<string, unknown>, keep: Map<string, Set<string>>): Record<string, unknown> | undefined;
@@ -1,2 +0,0 @@
1
- import type { SpecSliceScope } from './types.js';
2
- export declare function extractGraphqlSlice(sdl: string, scope: SpecSliceScope): string | undefined;
@@ -1,6 +0,0 @@
1
- import type { ApiSpecType } from '../../types/common.js';
2
- import type { SpecSliceScope } from './types.js';
3
- export { resolveSpecSliceScope } from './resolve-scope.js';
4
- export { ASSISTANT_LINK_BASES, buildInlinePromptLink, buildFetchSpecPromptLink, } from './assistant-links.js';
5
- export type { SliceContentKind, SpecSliceScope } from './types.js';
6
- export declare function buildSpecSlice(specType: ApiSpecType, document: unknown, scope: SpecSliceScope): Promise<string | undefined>;
@@ -1,6 +0,0 @@
1
- import type { SpecSliceScope } from './types.js';
2
- export declare function parsePointerTokens(pointer: string): string[];
3
- export declare function operationScopeFromPointer(pointer: string, isWebhook: boolean | undefined): SpecSliceScope | undefined;
4
- export declare function extractOpenApiSlice(document: Record<string, unknown>, scope: SpecSliceScope): {
5
- document: Record<string, unknown>;
6
- } | undefined;
@@ -1,4 +0,0 @@
1
- import type { ApiItemContent } from '../../types/store.js';
2
- import type { ApiSpecType } from '../../types/common.js';
3
- import type { SpecSliceScope } from './types.js';
4
- export declare function resolveSpecSliceScope(specType: ApiSpecType, content: ApiItemContent | null | undefined, label: string | undefined, groupMemberContents?: Array<ApiItemContent | null | undefined>): SpecSliceScope | undefined;
@@ -1,37 +0,0 @@
1
- export type GraphqlOperationType = 'query' | 'mutation' | 'subscription';
2
- export type GraphqlItemScope = {
3
- kind: 'graphql-operation';
4
- operationType: GraphqlOperationType;
5
- name: string;
6
- } | {
7
- kind: 'graphql-type';
8
- name: string;
9
- } | {
10
- kind: 'graphql-directive';
11
- name: string;
12
- };
13
- export type SpecSliceScope = {
14
- kind: 'document';
15
- } | {
16
- kind: 'tag';
17
- tagName: string;
18
- } | {
19
- kind: 'operation';
20
- pathName: string;
21
- httpVerb: string;
22
- source: 'paths' | 'webhooks';
23
- } | {
24
- kind: 'schema';
25
- name: string;
26
- } | {
27
- kind: 'channel';
28
- channelId: string;
29
- } | {
30
- kind: 'async-operation';
31
- operationId: string;
32
- } | GraphqlItemScope | {
33
- kind: 'graphql-group';
34
- label?: string;
35
- members: GraphqlItemScope[];
36
- };
37
- export type SliceContentKind = 'yaml' | 'graphql';
@@ -1,20 +0,0 @@
1
- import './crypto-uuid-compat.js';
2
- import { type Root } from 'react-dom/client';
3
- import type { RedocStandaloneProps } from './RedocStandalone.js';
4
- import type { TypeOfUsage } from './telemetry/RedocTelemetry.js';
5
- import { RedocStandalone } from './RedocStandalone.js';
6
- export { RedocStandalone };
7
- export type { RedocStandaloneProps };
8
- export type InitOptions = NonNullable<RedocStandaloneProps['options']> & {
9
- router?: 'hash' | 'history';
10
- disableTelemetry?: boolean;
11
- /** The Docker image sets `type-of-usage="docker"` on the `<redoc>` element. */
12
- typeOfUsage?: TypeOfUsage;
13
- basePath?: string;
14
- };
15
- export declare function init(specOrSpecUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): Root;
16
- /**
17
- * Attaches to server-rendered markup instead of replacing it. The spec must be
18
- * the same pre-bundled document the server pass rendered from.
19
- */
20
- export declare function hydrate(specOrSpecUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): Promise<void>;
@@ -1,3 +0,0 @@
1
- import type { ThemeDataTransferObject } from '@redocly/theme/core/openapi';
2
- /** Hides theme UI that needs a backend the standalone does not have — the code-block report button and all generic page actions. Only the spec-driven x-mcp connect actions remain. */
3
- export declare const STANDALONE_THEME_CONFIG: ThemeDataTransferObject['config'] | undefined;
@@ -1,22 +0,0 @@
1
- import { Telemetry } from '@redocly/redoc-opentelemetry';
2
- import type { EventType, EventPayload } from '@redocly/redoc-opentelemetry';
3
- export type SpecType = 'openapi' | 'asyncapi' | 'graphql';
4
- export type TypeOfUsage = 'html' | 'cli' | 'react' | 'init' | 'docker';
5
- /** Sees every array payload before it is sent; returning `false` drops the event. */
6
- export type BeforeSend = (event: EventType, items: unknown[]) => boolean | void;
7
- export interface RedocTelemetryConfig {
8
- specType?: SpecType;
9
- collectorUrl?: string;
10
- serviceName?: string;
11
- disabled?: boolean;
12
- serviceVersion?: string;
13
- typeOfUsage?: TypeOfUsage;
14
- beforeSend?: BeforeSend;
15
- }
16
- export declare class RedocTelemetry extends Telemetry {
17
- private specType;
18
- private beforeSend;
19
- readonly typeOfUsage: TypeOfUsage | undefined;
20
- constructor(config: RedocTelemetryConfig);
21
- send<T extends EventType>(event: T, data?: EventPayload<T>): void;
22
- }
@@ -1,3 +0,0 @@
1
- import type { TypeOfUsage } from './RedocTelemetry.js';
2
- /** How the page embeds Redoc: `init()` provides `html` or `docker`, `hydrate()` provides `cli`. */
3
- export declare const TypeOfUsageContext: import("react").Context<TypeOfUsage | undefined>;
@@ -1,7 +0,0 @@
1
- import type { TypeOfUsage } from './RedocTelemetry.js';
2
- export declare const TELEMETRY_DISABLED_BY_DEFAULT = false;
3
- export declare const DEFAULT_SERVICE_NAME = "redoc-ce";
4
- export declare const DEFAULT_TYPE_OF_USAGE: TypeOfUsage | undefined;
5
- /** Page identifier used by page-level events and as the PageResource of UI events; `undefined` means `location.href`. */
6
- export declare const PAGE_URI: string | undefined;
7
- export declare const PAGE_VIEWED_PER_ROUTE = true;
@@ -1,41 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- type UiResource<O extends string, I extends string> = {
3
- id: I;
4
- object: O;
5
- uri: `urn:redocly:redoc:ui:${O}:${I}`;
6
- };
7
- export declare function uiResource<O extends string, I extends string>(object: O, id: I): UiResource<O, I>;
8
- export declare const RESOURCES: {
9
- readonly asyncapiDocsChannelLink: UiResource<"link", "asyncapiDocsChannelLink">;
10
- readonly changeLayoutButton: UiResource<"button", "changeLayoutButton">;
11
- readonly colorMode: UiResource<"button", "colorMode">;
12
- readonly connectMcp: UiResource<"button", "connectMcp">;
13
- readonly copyCodeSnippetButton: UiResource<"button", "copyCodeSnippetButton">;
14
- readonly definitionLoad: UiResource<"definition", "definitionLoad">;
15
- readonly downloadDefinition: UiResource<"definition", "downloadDefinition">;
16
- readonly examplesSwitcherButton: UiResource<"button", "examplesSwitcherButton">;
17
- readonly expandCollapseAllButton: UiResource<"button", "expandCollapseAllButton">;
18
- readonly graphqlDocsReferencedInLink: UiResource<"link", "graphqlDocsReferencedInLink">;
19
- readonly messageLink: UiResource<"link", "messageLink">;
20
- readonly pageActions: UiResource<"button", "pageActions">;
21
- readonly redoclyAttribution: UiResource<"link", "redoclyAttribution">;
22
- readonly redocSecurityButton: UiResource<"button", "redocSecurityButton">;
23
- readonly redocSecurityButtonClose: UiResource<"button", "redocSecurityButtonClose">;
24
- readonly requiredScopesButton: UiResource<"button", "requiredScopesButton">;
25
- readonly responseCodeTab: UiResource<"tab", "responseCodeTab">;
26
- readonly schemaFieldToggle: UiResource<"button", "schemaFieldToggle">;
27
- readonly searchDialog: UiResource<"search", "searchDialog">;
28
- readonly searchInputResetButton: UiResource<"button", "searchInputResetButton">;
29
- readonly searchQuery: UiResource<"search", "searchQuery">;
30
- readonly securityOptionalScopesToggle: UiResource<"button", "securityOptionalScopesToggle">;
31
- readonly selectLanguageButton: UiResource<"button", "selectLanguageButton">;
32
- readonly serverModalButton: UiResource<"button", "serverModalButton">;
33
- readonly sidebarCollapse: UiResource<"button", "sidebarCollapse">;
34
- readonly sidebarItem: UiResource<"sidebar", "sidebarItem">;
35
- readonly switchExampleButton: UiResource<"button", "switchExampleButton">;
36
- readonly switchMessageButton: UiResource<"button", "switchMessageButton">;
37
- readonly switchServersButton: UiResource<"button", "switchServersButton">;
38
- };
39
- /** Item for `downloadDefinition.clicked`: the constant resource when `PAGE_URI` is set, so no host, URL or label is sent; otherwise the resolved download URL. */
40
- export declare function downloadDefinitionItem(label: string | undefined, url: string): EventPayload<'com.redocly.downloadDefinition.clicked'>[0];
41
- export {};
@@ -1,7 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- export type StatusClass = NonNullable<EventPayload<'com.redocly.responseCodeTab.clicked'>[0]['statusClass']>;
3
- export type Protocol = NonNullable<EventPayload<'com.redocly.switchServers.clicked'>[0]['protocol']>;
4
- /** A built-in language key, or `other` for a site-authored name (`x-codeSamples` lang or label, `codeSamples.languages` label). */
5
- export declare function languageOf(value: string): string;
6
- export declare function statusClassOf(code: string): StatusClass;
7
- export declare function normalizeProtocol(value: string | undefined): Protocol;
@@ -1,15 +0,0 @@
1
- export { useTelemetry } from '../hooks/useTelemetry.js';
2
- export { TelemetryContext } from '../contexts/telemetry.js';
3
- export type { RedocTelemetryConfig } from './RedocTelemetry.js';
4
- export { useRedocTelemetryInstance } from './useRedocTelemetryInstance.js';
5
- export { RESOURCES, downloadDefinitionItem, uiResource } from './events.js';
6
- export { languageOf, normalizeProtocol, statusClassOf } from './fields.js';
7
- export { OAUTH2_FLOW_NAMES, countSchemes } from './security.js';
8
- export type { Oauth2Flow } from './security.js';
9
- export { getPageUri } from './page.js';
10
- export { sanitizeErrorDetails } from './sanitizeError.js';
11
- export { reportDefinitionLoadFailed } from './reportDefinitionLoadFailed.js';
12
- export { useSchemaFieldTelemetry } from './useSchemaFieldTelemetry.js';
13
- export { useSidebarItemTelemetry } from './useSidebarItemTelemetry.js';
14
- export { nonDefaultOptions } from './initialPayload.js';
15
- export type { BuildTimings, InitialTelemetryContext } from './initialPayload.js';
@@ -1,56 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- import type { LayoutVariant } from '@redocly/config';
3
- import type { ApiItem, ApiStore } from '../types/store.js';
4
- import type { ItemVariant } from '../types/common.js';
5
- import type { RouteKind } from '../utils/routeKind.js';
6
- import type { TypeOfUsage } from './RedocTelemetry.js';
7
- type InitialItem = EventPayload<'com.redocly.redoc.initialized'>[0];
8
- type Shape = NonNullable<InitialItem['shape']>;
9
- type RedocExtensions = NonNullable<InitialItem['redocExtensions']>;
10
- type ProtocolFlags = NonNullable<Shape['protocols']>;
11
- export type BuildTimings = {
12
- resolveSpecMs: number;
13
- buildItemsMs: number;
14
- };
15
- export type TelemetryOptionValue = string | number | boolean;
16
- export type InitialTelemetryContext = {
17
- buildTimings?: BuildTimings;
18
- options?: Record<string, TelemetryOptionValue>;
19
- };
20
- export declare function countItems(items: ApiItem[]): {
21
- byVariant: Partial<Record<ItemVariant, number>>;
22
- operations: number;
23
- groups: number;
24
- webhooks: number;
25
- deprecated: number;
26
- };
27
- export declare function securityShape(securitySchemeStore: ApiStore['securitySchemeStore']): Pick<Shape, 'securitySchemes' | 'schemeTypes' | 'oauth2Flows'>;
28
- type DocumentScan = {
29
- specVersion?: string;
30
- extensionsCount: number;
31
- redocExtensions: RedocExtensions;
32
- hasCodeSamples: boolean;
33
- callbacks: number;
34
- servers: number;
35
- hasBindings: boolean;
36
- hasReply: boolean;
37
- protocols?: ProtocolFlags;
38
- };
39
- export declare function scanDocument(document: Record<string, unknown>): DocumentScan;
40
- export declare function openApiSecurityShape(document: Record<string, unknown>): Pick<Shape, 'hasGlobalSecurity' | 'securedOperations' | 'optionalSecurityOperations' | 'combinedSecurityOperations' | 'alternativeSecurityOperations'>;
41
- export declare function isLocalhost(hostname: string): boolean;
42
- export declare function nonDefaultOptions(raw: Record<string, unknown> | undefined): Record<string, TelemetryOptionValue> | undefined;
43
- export type InitialPayloadInput = {
44
- uri: string;
45
- layout: LayoutVariant;
46
- typeOfUsage?: TypeOfUsage;
47
- items: ApiItem[];
48
- apiStore: ApiStore;
49
- definition?: Record<string, unknown> | string;
50
- hostname: string;
51
- landedOn: RouteKind;
52
- buildTimings?: BuildTimings;
53
- options?: Record<string, TelemetryOptionValue>;
54
- };
55
- export declare function buildInitialPayload(input: InitialPayloadInput): InitialItem;
56
- export {};
@@ -1,5 +0,0 @@
1
- import type { EventType } from '@redocly/redoc-opentelemetry';
2
- export declare function getPageUri(): string;
3
- export declare const PAGE_LEVEL_EVENTS: ReadonlySet<EventType>;
4
- /** Appends the constant page item so the SDK does not inject `location.href` and the referrer. */
5
- export declare function withPageItem(event: EventType, items: unknown[]): unknown[];
@@ -1,9 +0,0 @@
1
- import type { RedocTelemetryConfig } from './RedocTelemetry.js';
2
- type ReportOptions = {
3
- source: 'url' | 'inline';
4
- durationMs: number;
5
- telemetryConfig?: Partial<RedocTelemetryConfig>;
6
- };
7
- /** Sends `definition.loadFailed` with its own instance: the loader renders above any provider. */
8
- export declare function reportDefinitionLoadFailed(error: unknown, { source, durationMs, telemetryConfig }: ReportOptions): void;
9
- export {};
@@ -1,4 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- type ErrorDetails = NonNullable<EventPayload<'com.redocly.error.occurred'>[0]['details']>;
3
- export declare function sanitizeErrorDetails(error: Error, componentStack?: string | null): ErrorDetails;
4
- export {};
@@ -1,14 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- type SecurityDetails = EventPayload<'com.redocly.viewSecurityDetails.clicked'>[0];
3
- export type SchemeTypeKey = keyof NonNullable<SecurityDetails['schemeTypes']>;
4
- export type Oauth2Flow = keyof NonNullable<SecurityDetails['oauth2Flows']>;
5
- export declare const OAUTH2_FLOW_NAMES: ReadonlySet<string>;
6
- export declare function countSchemes(schemes: Iterable<{
7
- type?: string;
8
- scheme?: string;
9
- flows?: object | null;
10
- }>): {
11
- schemeTypes: Partial<Record<SchemeTypeKey, number>>;
12
- oauth2Flows: Partial<Record<Oauth2Flow, number>>;
13
- };
14
- export {};
@@ -1,3 +0,0 @@
1
- import type { RedocTelemetryConfig } from './RedocTelemetry.js';
2
- import { RedocTelemetry } from './RedocTelemetry.js';
3
- export declare function useRedocTelemetryInstance(config?: Partial<RedocTelemetryConfig>): RedocTelemetry;
@@ -1,4 +0,0 @@
1
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
2
- import { RESOURCES } from './events.js';
3
- export type SchemaFieldToggle = Omit<EventPayload<'com.redocly.schemaField.expanded'>[0], keyof typeof RESOURCES.schemaFieldToggle | 'specType'>;
4
- export declare function useSchemaFieldTelemetry(): (toggle: SchemaFieldToggle) => void;
@@ -1,11 +0,0 @@
1
- import type { MouseEvent } from 'react';
2
- import type { EventPayload } from '@redocly/redoc-opentelemetry';
3
- type SidebarItemType = EventPayload<'com.redocly.sidebarItem.clicked'>[0]['type'];
4
- type SidebarItemClick = {
5
- type: SidebarItemType;
6
- depth: number;
7
- navigates: boolean;
8
- };
9
- export declare function sidebarItemFromTarget(target: Element): SidebarItemClick | null;
10
- export declare function useSidebarItemTelemetry(): (event: MouseEvent<HTMLElement>) => void;
11
- export {};
@@ -1,314 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { JSONSchema7 } from 'json-schema';
3
- import type { AsyncApiSecuritySchemeType, ObjectValues } from './common.js';
4
- import type { ApiItem, StoreContext } from './store.js';
5
- import type { SecurityRequirementDetail } from './content.js';
6
- import type { ApiDocsOptions } from './options.js';
7
- export type AsyncApiDefinition = {
8
- asyncapi: string;
9
- id?: string;
10
- info: AsyncApiInfo;
11
- servers?: Record<string, AsyncApiServer>;
12
- defaultContentType?: string;
13
- channels?: AsyncApiChannels;
14
- operations?: AsyncApiOperations;
15
- components?: AsyncApiComponents;
16
- 'x-tagGroups'?: {
17
- name: string;
18
- tags: string[];
19
- }[];
20
- };
21
- export type AsyncApiInfo = {
22
- title: string;
23
- version: string;
24
- description?: string | Node[] | Node;
25
- termsOfService?: string;
26
- contact?: AsyncApiContact;
27
- license?: AsyncApiLicense;
28
- tags?: AsyncApiTag[];
29
- externalDocs?: AsyncApiExternalDocs;
30
- };
31
- export type AsyncApiContact = {
32
- name?: string;
33
- url?: string;
34
- email?: string;
35
- };
36
- export type AsyncApiLicense = {
37
- name: string;
38
- url?: string;
39
- };
40
- export type AsyncApiTag = {
41
- name: string;
42
- description?: string | Node[] | Node;
43
- externalDocs?: AsyncApiExternalDocs;
44
- };
45
- export type AsyncApiExternalDocs = {
46
- description?: string | Node[] | Node;
47
- url: string;
48
- };
49
- export type AsyncApiServer = {
50
- host: string;
51
- protocol: string;
52
- protocolVersion?: string;
53
- pathname?: string;
54
- description?: string | Node[] | Node;
55
- title?: string;
56
- summary?: string;
57
- variables?: AsyncApiServerVariables;
58
- tags?: AsyncApiTag[];
59
- externalDocs?: AsyncApiExternalDocs;
60
- bindings?: AsyncApiServerBinding;
61
- security?: AsyncApiSecurityRequirement[];
62
- };
63
- export type AsyncApiOAuthFlow = {
64
- authorizationUrl?: string;
65
- tokenUrl?: string;
66
- refreshUrl?: string;
67
- availableScopes?: Record<string, string>;
68
- };
69
- export type AsyncApiSecurityScheme = {
70
- type: AsyncApiSecuritySchemeType;
71
- description?: string | Node[] | Node;
72
- name?: string;
73
- in?: 'user' | 'password' | 'query' | 'header' | 'cookie';
74
- scheme?: string;
75
- bearerFormat?: string;
76
- openIdConnectUrl?: string;
77
- scopes?: string[];
78
- flows?: AsyncApiOAuthFlows;
79
- };
80
- export type AsyncApiOAuthFlows = {
81
- implicit?: AsyncApiOAuthFlow;
82
- password?: AsyncApiOAuthFlow;
83
- clientCredentials?: AsyncApiOAuthFlow;
84
- authorizationCode?: AsyncApiOAuthFlow;
85
- };
86
- /** 2.x requirement kept by the 2.x conversion: component scheme name → required scopes, all required. */
87
- export type AsyncApiSecurityRequirementObject = Record<string, string[]>;
88
- export type AsyncApiSecurityRequirement = AsyncApiSecurityScheme | {
89
- $ref: string;
90
- } | AsyncApiSecurityRequirementObject;
91
- export type AsyncApiServerVariables = {
92
- [name: string]: AsyncApiServerVariable;
93
- };
94
- export type AsyncApiChannels = {
95
- [name: string]: AsyncApiChannel;
96
- };
97
- export type AsyncApiServerVariable = {
98
- enum?: string[];
99
- default: string;
100
- description?: string | Node[] | Node;
101
- examples?: string[];
102
- };
103
- export type AsyncApiServerBinding = {
104
- kafka?: AsyncApiServerKafkaBinding;
105
- };
106
- export type AsyncApiServerKafkaBinding = {
107
- schemaRegistryUrl?: string;
108
- schemaRegistryVendor?: string;
109
- bindingVersion?: string;
110
- };
111
- export type AsyncApiChannel = {
112
- address?: string;
113
- messages?: AsyncApiMessages;
114
- title?: string;
115
- summary?: string;
116
- description?: string | Node[] | Node;
117
- servers?: AsyncApiServer[];
118
- parameters?: AsyncApiParameters;
119
- tags?: AsyncApiTag[];
120
- externalDocs?: AsyncApiExternalDocs;
121
- bindings?: AsyncApiChannelBinding;
122
- 'x-badges'?: AsyncApiXBadges[];
123
- };
124
- export type AsyncApiXBadges = {
125
- name: string;
126
- position?: 'before' | 'after';
127
- color?: string;
128
- };
129
- export type AsyncApiChannelBinding = {
130
- kafka?: AsyncApiChannelKafkaBinding;
131
- amqp?: AsyncApiChannelAMQPBinding;
132
- };
133
- export type AsyncApiChannelKafkaBinding = {
134
- topic?: string;
135
- partitions?: number;
136
- replicas?: number;
137
- bindingVersion?: string;
138
- topicConfiguration?: {
139
- 'cleanup.policy'?: string[];
140
- 'retention.ms'?: number;
141
- 'retention.bytes'?: number;
142
- 'delete.retention.ms'?: number;
143
- 'max.message.bytes'?: number;
144
- 'confluent.key.schema.validation'?: boolean;
145
- 'confluent.key.subject.name.strategy'?: string;
146
- 'confluent.value.schema.validation'?: boolean;
147
- 'confluent.value.subject.name.strategy'?: string;
148
- };
149
- };
150
- export type AsyncApiChannelAMQPBinding = {
151
- is: 'routingKey' | 'queue';
152
- };
153
- export type AsyncApiMessages = {
154
- [name: string]: AsyncApiMessage;
155
- };
156
- export type AsyncApiParameters = {
157
- [name: string]: AsyncApiParameter;
158
- };
159
- export type AsyncApiParameter = {
160
- enum?: string[];
161
- default?: string;
162
- description?: string | Node[] | Node;
163
- examples?: string[];
164
- location?: string;
165
- };
166
- export type AsyncApiMessage = {
167
- headers?: AsyncAPISchema;
168
- payload?: AsyncAPISchema;
169
- correlationId?: AsyncApiCorrelationId;
170
- contentType?: string;
171
- name?: string;
172
- title?: string;
173
- summary?: string;
174
- description?: string | Node[] | Node;
175
- tags?: AsyncApiTag[];
176
- externalDocs?: AsyncApiExternalDocs;
177
- bindings?: AsyncApiMessageBinding;
178
- examples?: AsyncApiMessageExample[];
179
- };
180
- export type AsyncApiCorrelationId = {
181
- description?: string | Node[] | Node;
182
- location: string;
183
- };
184
- export type AsyncApiMessageBinding = {
185
- kafka?: AsyncApiMessageKafkaBinding;
186
- };
187
- export type AsyncApiMessageKafkaBinding = {
188
- key?: JSONSchema7;
189
- schemaIdLocation?: string;
190
- schemaIdPayloadEncoding?: string;
191
- schemaLookupStrategy?: string;
192
- bindingVersion?: string;
193
- };
194
- export type AsyncApiMessageExample = {
195
- headers?: Record<string, unknown>;
196
- payload?: Record<string, unknown>;
197
- name?: string;
198
- summary?: string;
199
- };
200
- export type MultiFormatSchemaObject = {
201
- schema: JSONSchema7 | AvroSchema;
202
- schemaFormat: string;
203
- };
204
- export type AsyncApiOperations = {
205
- [name: string]: AsyncApiOperation;
206
- };
207
- export type AsyncApiOperation = {
208
- action: 'send' | 'receive';
209
- channel: AsyncApiChannel;
210
- title?: string;
211
- summary?: string;
212
- description?: string | Node[] | Node;
213
- tags?: AsyncApiTag[];
214
- externalDocs?: AsyncApiExternalDocs;
215
- bindings?: AsyncApiOperationBinding;
216
- traits?: AsyncApiOperationTraits[];
217
- messages?: AsyncApiMessage[];
218
- reply?: AsyncApiOperationReply;
219
- security?: AsyncApiSecurityRequirement[];
220
- 'x-badges'?: AsyncApiXBadges[];
221
- };
222
- export type AsyncApiOperationReply = {
223
- address?: {
224
- description?: string | Node[] | Node;
225
- location: string;
226
- };
227
- channel?: AsyncApiChannel;
228
- messages?: AsyncApiMessage[];
229
- };
230
- export type AsyncApiOperationTraits = {
231
- title?: string;
232
- summary?: string;
233
- description?: string | Node[] | Node;
234
- tags?: AsyncApiTag[];
235
- externalDocs?: AsyncApiExternalDocs;
236
- bindings?: AsyncApiOperationBinding;
237
- };
238
- export type AsyncApiOperationBinding = {
239
- kafka?: AsyncApiOperationKafkaBinding;
240
- };
241
- export type AsyncApiOperationKafkaBinding = {
242
- groupId?: {
243
- type: string;
244
- enum: string[];
245
- };
246
- clientId?: {
247
- type: string;
248
- enum: string[];
249
- };
250
- bindingVersion?: string;
251
- };
252
- export type AsyncApiComponents = {
253
- messages: Record<string, AsyncApiMessage>;
254
- schemas: Record<string, AsyncAPISchema>;
255
- tags: Record<string, AsyncApiTag>;
256
- securitySchemes?: Record<string, AsyncApiSecurityScheme>;
257
- correlationIds?: Record<string, AsyncApiCorrelationId>;
258
- };
259
- export type AvroSchema = {
260
- type: string | string[] | AvroSchema[];
261
- name?: string;
262
- doc?: string;
263
- symbols?: string[];
264
- fields?: Array<{
265
- name: string;
266
- type: AvroSchema | string | (string | AvroSchema)[];
267
- doc?: string;
268
- default?: unknown;
269
- }>;
270
- items?: AvroSchema | string;
271
- values?: AvroSchema | string;
272
- };
273
- export type AsyncAPISchema = JSONSchema7 | MultiFormatSchemaObject;
274
- export declare const CONST_PROTOCOL_VARIANT: {
275
- readonly DEFAULT: 'default';
276
- readonly KAFKA: 'kafka';
277
- readonly AMQP: 'amqp';
278
- readonly WSS: 'wss';
279
- };
280
- export type ProtocolVariant = ObjectValues<typeof CONST_PROTOCOL_VARIANT>;
281
- export type AsyncApiBuildContext = {
282
- document: AsyncApiDefinition;
283
- options: ApiDocsOptions;
284
- basePath: string;
285
- storeCtx: StoreContext;
286
- protocol: ProtocolVariant | null;
287
- channelToOperations: Record<string, string[]>;
288
- groups: Record<string, ApiItem[]>;
289
- items: ApiItem[];
290
- descriptionItems: ApiItem[];
291
- channelSummaries: Map<string, string>;
292
- processContent: boolean;
293
- };
294
- export type BrokerData = {
295
- /** Server host; absent only for invalid documents. */
296
- url?: string;
297
- description?: string | Node[] | Node;
298
- name?: string;
299
- variables?: Record<string, {
300
- enum?: string[];
301
- default: string;
302
- description?: string | Node[] | Node;
303
- examples?: string[];
304
- }>;
305
- protocol?: string;
306
- protocolVersion?: string;
307
- pathname?: string;
308
- title?: string;
309
- summary?: string;
310
- tags?: AsyncApiTag[];
311
- externalDocs?: AsyncApiExternalDocs;
312
- bindings?: AsyncApiServerBinding;
313
- security?: SecurityRequirementDetail[];
314
- };
@@ -1,12 +0,0 @@
1
- /**
2
- * Community edition: generated code samples are not included. The language
3
- * list survives only to drive the payload tab and `x-codeSamples` matching.
4
- * `key` and `label` are stamped onto every entry by `normalizeCodeSamples()`.
5
- */
6
- export interface CodeSamplesConfig {
7
- languages: {
8
- lang: string;
9
- label: string;
10
- key: string;
11
- }[];
12
- }