redoc 2.5.4 → 3.0.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (700) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +90 -52
  3. package/bundles/redoc.d.ts +1860 -0
  4. package/bundles/redoc.js +13775 -0
  5. package/bundles/redoc.standalone.d.ts +1574 -0
  6. package/bundles/redoc.standalone.js +13547 -1562
  7. package/package.json +107 -186
  8. package/typings/.tsbuildinfo +1 -0
  9. package/typings/RedocStandalone.d.ts +36 -0
  10. package/typings/RedoclyApiDocs.d.ts +23 -0
  11. package/typings/RedoclyApiDocsStandalone.d.ts +22 -0
  12. package/typings/adapters/asyncapi/build/context.d.ts +9 -0
  13. package/typings/adapters/asyncapi/build/navigation.d.ts +2 -0
  14. package/typings/adapters/asyncapi/build/utils.d.ts +3 -0
  15. package/typings/adapters/asyncapi/buildContext.d.ts +2 -0
  16. package/typings/adapters/asyncapi/index.d.ts +13 -0
  17. package/typings/adapters/asyncapi/items/channel/content.d.ts +5 -0
  18. package/typings/adapters/asyncapi/items/channel/item.d.ts +13 -0
  19. package/typings/adapters/asyncapi/items/operation/content.d.ts +4 -0
  20. package/typings/adapters/asyncapi/items/operation/item.d.ts +15 -0
  21. package/typings/adapters/asyncapi/items/overview/content.d.ts +10 -0
  22. package/typings/adapters/asyncapi/items/overview/item.d.ts +16 -0
  23. package/typings/adapters/asyncapi/panels/brokers.d.ts +4 -0
  24. package/typings/adapters/asyncapi/panels/download.d.ts +3 -0
  25. package/typings/adapters/asyncapi/panels/group.d.ts +16 -0
  26. package/typings/adapters/asyncapi/panels/overview.d.ts +3 -0
  27. package/typings/adapters/asyncapi/store.d.ts +3 -0
  28. package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts +4 -0
  29. package/typings/adapters/asyncapi/utils/get-channel-label.d.ts +3 -0
  30. package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts +24 -0
  31. package/typings/adapters/asyncapi/utils/get-server-host.d.ts +3 -0
  32. package/typings/adapters/asyncapi/utils/resolve-schema.d.ts +2 -0
  33. package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts +2 -0
  34. package/typings/adapters/build.d.ts +31 -0
  35. package/typings/adapters/graphql/build/context.d.ts +9 -0
  36. package/typings/adapters/graphql/buildContext.d.ts +2 -0
  37. package/typings/adapters/graphql/buildStoreFromSdl.d.ts +2 -0
  38. package/typings/adapters/graphql/group/custom.d.ts +2 -0
  39. package/typings/adapters/graphql/group/default.d.ts +2 -0
  40. package/typings/adapters/graphql/group/errors.d.ts +1 -0
  41. package/typings/adapters/graphql/group/itemBuilders.d.ts +5 -0
  42. package/typings/adapters/graphql/group/utils.d.ts +8 -0
  43. package/typings/adapters/graphql/index.d.ts +10 -0
  44. package/typings/adapters/graphql/items/directive/content.d.ts +4 -0
  45. package/typings/adapters/graphql/items/directive/item.d.ts +3 -0
  46. package/typings/adapters/graphql/items/enum/content.d.ts +4 -0
  47. package/typings/adapters/graphql/items/enum/item.d.ts +3 -0
  48. package/typings/adapters/graphql/items/input/content.d.ts +4 -0
  49. package/typings/adapters/graphql/items/input/item.d.ts +3 -0
  50. package/typings/adapters/graphql/items/interface/content.d.ts +4 -0
  51. package/typings/adapters/graphql/items/interface/item.d.ts +3 -0
  52. package/typings/adapters/graphql/items/mutation/content.d.ts +4 -0
  53. package/typings/adapters/graphql/items/mutation/item.d.ts +3 -0
  54. package/typings/adapters/graphql/items/object/content.d.ts +4 -0
  55. package/typings/adapters/graphql/items/object/item.d.ts +3 -0
  56. package/typings/adapters/graphql/items/operation/content.d.ts +7 -0
  57. package/typings/adapters/graphql/items/overview/content.d.ts +11 -0
  58. package/typings/adapters/graphql/items/overview/item.d.ts +4 -0
  59. package/typings/adapters/graphql/items/query/content.d.ts +4 -0
  60. package/typings/adapters/graphql/items/query/item.d.ts +3 -0
  61. package/typings/adapters/graphql/items/scalar/content.d.ts +4 -0
  62. package/typings/adapters/graphql/items/scalar/item.d.ts +3 -0
  63. package/typings/adapters/graphql/items/subscription/content.d.ts +4 -0
  64. package/typings/adapters/graphql/items/subscription/item.d.ts +3 -0
  65. package/typings/adapters/graphql/items/types.d.ts +7 -0
  66. package/typings/adapters/graphql/items/union/content.d.ts +4 -0
  67. package/typings/adapters/graphql/items/union/item.d.ts +3 -0
  68. package/typings/adapters/graphql/panels/download.d.ts +3 -0
  69. package/typings/adapters/graphql/panels/group-items.d.ts +4 -0
  70. package/typings/adapters/graphql/panels/overview.d.ts +3 -0
  71. package/typings/adapters/graphql/serializeType.d.ts +5 -0
  72. package/typings/adapters/graphql/store.d.ts +3 -0
  73. package/typings/adapters/graphql/utils/configMetadataRows.d.ts +3 -0
  74. package/typings/adapters/graphql/utils/constants.d.ts +23 -0
  75. package/typings/adapters/graphql/utils/createApiItem.d.ts +15 -0
  76. package/typings/adapters/graphql/utils/getBadges.d.ts +4 -0
  77. package/typings/adapters/graphql/utils/ignoreInternalItems.d.ts +3 -0
  78. package/typings/adapters/graphql/utils/isRootType.d.ts +2 -0
  79. package/typings/adapters/graphql/utils/menuSlashRegex.d.ts +1 -0
  80. package/typings/adapters/graphql/utils/normalizeMenu.d.ts +3 -0
  81. package/typings/adapters/graphql/utils/shouldIncludeItem.d.ts +2 -0
  82. package/typings/adapters/graphql/utils/summary.d.ts +4 -0
  83. package/typings/adapters/graphql/utils/validateMenuConfig.d.ts +3 -0
  84. package/typings/adapters/helpers.d.ts +40 -0
  85. package/typings/adapters/openapi/build/context.d.ts +13 -0
  86. package/typings/adapters/openapi/build-code-sample-source.d.ts +4 -0
  87. package/typings/adapters/openapi/buildContext.d.ts +2 -0
  88. package/typings/adapters/openapi/configure/apply-request-values.d.ts +3 -0
  89. package/typings/adapters/openapi/configure/index.d.ts +3 -0
  90. package/typings/adapters/openapi/configure/merge-utils.d.ts +30 -0
  91. package/typings/adapters/openapi/configure/resolve-request-values.d.ts +15 -0
  92. package/typings/adapters/openapi/constants.d.ts +4 -0
  93. package/typings/adapters/openapi/group/content.d.ts +25 -0
  94. package/typings/adapters/openapi/group/item.d.ts +8 -0
  95. package/typings/adapters/openapi/index.d.ts +13 -0
  96. package/typings/adapters/openapi/items/mcp/content.d.ts +5 -0
  97. package/typings/adapters/openapi/items/mcp/item.d.ts +9 -0
  98. package/typings/adapters/openapi/items/operation/content.d.ts +12 -0
  99. package/typings/adapters/openapi/items/operation/item.d.ts +9 -0
  100. package/typings/adapters/openapi/items/overview/content.d.ts +17 -0
  101. package/typings/adapters/openapi/items/overview/item.d.ts +3 -0
  102. package/typings/adapters/openapi/items/schema/content.d.ts +3 -0
  103. package/typings/adapters/openapi/items/schema/item.d.ts +9 -0
  104. package/typings/adapters/openapi/panels/download.d.ts +3 -0
  105. package/typings/adapters/openapi/panels/mcp.d.ts +3 -0
  106. package/typings/adapters/openapi/panels/overview.d.ts +3 -0
  107. package/typings/adapters/openapi/panels/servers.d.ts +3 -0
  108. package/typings/adapters/openapi/resolve-openapi-example-value.d.ts +3 -0
  109. package/typings/adapters/openapi/store.d.ts +4 -0
  110. package/typings/{utils → adapters/openapi/utils}/JsonPointer.d.ts +6 -6
  111. package/typings/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts +1 -0
  112. package/typings/adapters/openapi/utils/helpers.d.ts +14 -0
  113. package/typings/adapters/openapi/utils/merge-mock-server.d.ts +8 -0
  114. package/typings/adapters/openapi/utils/operation.d.ts +23 -0
  115. package/typings/adapters/openapi/utils/resolvePathItemRef.d.ts +2 -0
  116. package/typings/adapters/openapi/utils/url.d.ts +2 -0
  117. package/typings/adapters/rbac.d.ts +10 -0
  118. package/typings/adapters/scopedContext.d.ts +5 -0
  119. package/typings/adapters/utils/convertSwagger2OpenAPI.d.ts +2 -0
  120. package/typings/adapters/utils/dompurify.d.ts +5 -0
  121. package/typings/adapters/utils/isPlainText.d.ts +6 -0
  122. package/typings/adapters/utils/markdoc.d.ts +55 -0
  123. package/typings/adapters/utils/parseMarkdown.d.ts +8 -0
  124. package/typings/adapters/utils/seo.d.ts +3 -0
  125. package/typings/adapters/utils/simplifyAstStructure.d.ts +2 -0
  126. package/typings/components/AdmonitionItem.d.ts +6 -0
  127. package/typings/components/ChannelAddressItem.d.ts +7 -0
  128. package/typings/components/ContainerItem.d.ts +9 -0
  129. package/typings/components/EmptyMessageItem.d.ts +6 -0
  130. package/typings/components/ErrorBoundary.d.ts +19 -7
  131. package/typings/components/ExtensionsItem.d.ts +7 -0
  132. package/typings/components/ExternalDocsItem.d.ts +8 -0
  133. package/typings/components/Header/HeaderItem.d.ts +10 -0
  134. package/typings/components/Header/HeaderPageActions.d.ts +4 -0
  135. package/typings/components/Header/HeaderResponseCodeTabs.d.ts +8 -0
  136. package/typings/components/Header/PageActions.d.ts +4 -0
  137. package/typings/components/Header/ResponseDeepLinkAnchor.d.ts +9 -0
  138. package/typings/components/Header/hooks.d.ts +5 -0
  139. package/typings/components/InfoMetadataItem.d.ts +7 -0
  140. package/typings/components/ItemContent/ItemContentRenderer.d.ts +8 -0
  141. package/typings/components/ItemContent/SectionHeader.d.ts +8 -0
  142. package/typings/components/ItemContent/hooks.d.ts +16 -0
  143. package/typings/components/ItemContent/sections/BodyMimeTypeField.d.ts +12 -0
  144. package/typings/components/ItemContent/sections/BodySection.d.ts +7 -0
  145. package/typings/components/ItemContent/sections/CallbacksSection.d.ts +5 -0
  146. package/typings/components/ItemContent/sections/FieldsSection.d.ts +7 -0
  147. package/typings/components/ItemContent/sections/MessagesSection.d.ts +5 -0
  148. package/typings/components/ItemContent/sections/ParametersSection.d.ts +6 -0
  149. package/typings/components/ItemContent/sections/ResponsesSection.d.ts +5 -0
  150. package/typings/components/ItemContent/sections/ValuesSection.d.ts +5 -0
  151. package/typings/components/Mapper.d.ts +25 -0
  152. package/typings/components/MarkdownItem.d.ts +6 -0
  153. package/typings/components/Mcp/McpPrompt.d.ts +8 -0
  154. package/typings/components/Mcp/McpResource.d.ts +8 -0
  155. package/typings/components/Mcp/McpTool.d.ts +8 -0
  156. package/typings/components/Mcp/styled.d.ts +22 -0
  157. package/typings/components/Mcp/utils.d.ts +7 -0
  158. package/typings/components/MessageLinksItem.d.ts +7 -0
  159. package/typings/components/PrePaintColorModeScript.d.ts +12 -0
  160. package/typings/components/Schema/SchemaDescription.d.ts +5 -0
  161. package/typings/components/Schema/SchemaView.d.ts +20 -0
  162. package/typings/components/Schema/helpers.d.ts +1 -0
  163. package/typings/components/Schema/hooks/useSchemaDocument.d.ts +7 -0
  164. package/typings/components/Schema/hooks/useSchemaFieldDeepLink.d.ts +5 -0
  165. package/typings/components/Schema/hooks/useVariantIndexFromHash.d.ts +1 -0
  166. package/typings/components/Schema/styled.d.ts +235 -0
  167. package/typings/components/Schema/utils.d.ts +26 -0
  168. package/typings/components/Schema/views/ArrayRenderer.d.ts +13 -0
  169. package/typings/components/Schema/views/CollapsibleNestedFields.d.ts +25 -0
  170. package/typings/components/Schema/views/DefaultMappingOptionLabel.d.ts +5 -0
  171. package/typings/components/Schema/views/DiscriminatorPropertyRow.d.ts +13 -0
  172. package/typings/components/Schema/views/Examples.d.ts +7 -0
  173. package/typings/components/Schema/views/ExpandableExample.d.ts +4 -0
  174. package/typings/components/Schema/views/ObjectRenderer.d.ts +14 -0
  175. package/typings/components/Schema/views/Pattern.d.ts +6 -0
  176. package/typings/components/Schema/views/PrimitiveRenderer.d.ts +5 -0
  177. package/typings/components/Schema/views/PropertyFieldRow.d.ts +16 -0
  178. package/typings/components/Schema/views/PropertyRenderer.d.ts +15 -0
  179. package/typings/components/Schema/views/SchemaEnumDescriptions.d.ts +9 -0
  180. package/typings/components/Schema/views/SchemaEnumValues.d.ts +8 -0
  181. package/typings/components/Schema/views/SchemaTitleLabel.d.ts +5 -0
  182. package/typings/components/Schema/views/SchemaVariantSelector.d.ts +11 -0
  183. package/typings/components/Schema/views/SwitcherRenderer.d.ts +14 -0
  184. package/typings/components/Schema/views/VariantDropdown.d.ts +14 -0
  185. package/typings/components/Search/Search.d.ts +10 -0
  186. package/typings/components/Search/SearchDialog.d.ts +7 -0
  187. package/typings/components/Search/SearchTrigger.d.ts +9 -0
  188. package/typings/components/Search/index.d.ts +3 -0
  189. package/typings/components/Security/Divider.d.ts +4 -0
  190. package/typings/components/Security/RequiredScopes.d.ts +4 -0
  191. package/typings/components/Security/ScopeTagWithTooltip.d.ts +11 -0
  192. package/typings/components/Security/SecurityButtonPanel.d.ts +5 -0
  193. package/typings/components/Security/SecurityFlowDetail.d.ts +5 -0
  194. package/typings/components/Security/SecurityModal.d.ts +6 -0
  195. package/typings/components/Security/SecuritySection.d.ts +3 -0
  196. package/typings/components/Security/styled.d.ts +127 -0
  197. package/typings/components/Security/types.d.ts +3 -0
  198. package/typings/components/SideMenu/SideMenu.d.ts +6 -14
  199. package/typings/components/SideMenu/buildMenuItems.d.ts +29 -0
  200. package/typings/components/SideMenu/useMenuItems.d.ts +14 -0
  201. package/typings/components/StickySidebar/FloatingButton.d.ts +1 -0
  202. package/typings/components/StickySidebar/RedoclyAttributionLogo.d.ts +5 -0
  203. package/typings/components/StickySidebar/SidebarActions.d.ts +2 -0
  204. package/typings/components/StickySidebar/StickySidebar.d.ts +7 -0
  205. package/typings/components/common/Badge.d.ts +32 -0
  206. package/typings/components/common/Breadcrumbs.d.ts +11 -0
  207. package/typings/components/common/ContentWrapper.d.ts +24 -0
  208. package/typings/components/common/DeepLinkAnchor.d.ts +20 -0
  209. package/typings/components/common/ExpandAllButton.d.ts +6 -0
  210. package/typings/components/common/ExternalDocumentation.d.ts +10 -0
  211. package/typings/components/common/LazyMount.d.ts +9 -0
  212. package/typings/components/common/LazySection.d.ts +14 -0
  213. package/typings/components/common/Markdown.d.ts +7 -0
  214. package/typings/components/common/MoreDetailsButton.d.ts +5 -0
  215. package/typings/components/common/NestedToggleButton.d.ts +10 -0
  216. package/typings/components/common/PanelItem.d.ts +65 -0
  217. package/typings/components/common/ResponseCodeTabs.d.ts +9 -0
  218. package/typings/components/common/Tag.d.ts +3 -0
  219. package/typings/components/common/VendorExtensions.d.ts +7 -0
  220. package/typings/components/common/ViewNested.d.ts +16 -0
  221. package/typings/components/graphql/ArrowIcon.d.ts +7 -0
  222. package/typings/components/graphql/GraphQLArgumentsSection.d.ts +10 -0
  223. package/typings/components/graphql/GraphQLEnumEmbedded.d.ts +5 -0
  224. package/typings/components/graphql/GraphQLFieldView.d.ts +12 -0
  225. package/typings/components/graphql/GraphQLFieldsEmbedded.d.ts +9 -0
  226. package/typings/components/graphql/GraphQLGroupTypeList.d.ts +5 -0
  227. package/typings/components/graphql/GraphQLHeaderExtras.d.ts +7 -0
  228. package/typings/components/graphql/GraphQLReturnTypeDetails.d.ts +11 -0
  229. package/typings/components/graphql/GraphQLTypeView.d.ts +9 -0
  230. package/typings/components/graphql/GraphQLUnionEmbedded.d.ts +5 -0
  231. package/typings/components/graphql/RequiresScopesButton.d.ts +9 -0
  232. package/typings/components/graphql/RequiresScopesModal.d.ts +9 -0
  233. package/typings/components/graphql/ViewNested.d.ts +14 -0
  234. package/typings/components/graphql/renderDescription.d.ts +2 -0
  235. package/typings/components/graphql/sections/GraphQLArgsSection.d.ts +5 -0
  236. package/typings/components/graphql/sections/GraphQLFieldsSection.d.ts +5 -0
  237. package/typings/components/graphql/sections/ImplementedBySection.d.ts +5 -0
  238. package/typings/components/graphql/sections/ImplementsSection.d.ts +5 -0
  239. package/typings/components/graphql/sections/PossibleTypesSection.d.ts +5 -0
  240. package/typings/components/graphql/sections/RequiresScopesSection.d.ts +5 -0
  241. package/typings/components/graphql/sections/ReturnTypeSection.d.ts +5 -0
  242. package/typings/components/graphql/styled.d.ts +62 -0
  243. package/typings/components/markdoc/Heading.d.ts +11 -0
  244. package/typings/components/markdoc/SchemaDefinition.d.ts +11 -0
  245. package/typings/components/markdoc/apiDocsMarkdocComponents.d.ts +6 -0
  246. package/typings/components/markdoc/buildMarkdocOptions.d.ts +9 -0
  247. package/typings/components/markdoc/defaultMarkdocConfig.d.ts +14 -0
  248. package/typings/components/markdoc/html/html-jsx-attribute-mapping.d.ts +5 -0
  249. package/typings/components/markdoc/html/process-html-tokens.d.ts +1 -0
  250. package/typings/components/markdoc/markdocAdapter.d.ts +11 -0
  251. package/typings/components/markdoc/markdocParser.d.ts +8 -0
  252. package/typings/components/markdoc/markdocRenderer.d.ts +8 -0
  253. package/typings/components/markdoc/tags/mcp-tag-schemas.d.ts +2 -0
  254. package/typings/components/markdoc/tags/schema-definition-tag.d.ts +2 -0
  255. package/typings/components/panels/ConnectMcpButton.d.ts +5 -0
  256. package/typings/components/panels/DownloadPanelItem.d.ts +5 -0
  257. package/typings/components/panels/ExampleItem/CallbackPayloadItem.d.ts +5 -0
  258. package/typings/components/panels/ExampleItem/CodeSampleItem.d.ts +5 -0
  259. package/typings/components/panels/ExampleItem/ExamplesPanelItem.d.ts +3 -0
  260. package/typings/components/panels/ExampleItem/GraphQLQueryItem.d.ts +5 -0
  261. package/typings/components/panels/ExampleItem/GraphQLResponseItem.d.ts +5 -0
  262. package/typings/components/panels/ExampleItem/GraphQLTypeSampleItem.d.ts +5 -0
  263. package/typings/components/panels/ExampleItem/GraphQLVariablesItem.d.ts +5 -0
  264. package/typings/components/panels/ExampleItem/PayloadExampleItem.d.ts +5 -0
  265. package/typings/components/panels/ExampleItem/ResponseExampleItem.d.ts +5 -0
  266. package/typings/components/panels/ExampleItem/ServerDropdown.d.ts +17 -0
  267. package/typings/components/panels/ExampleItem/hooks.d.ts +25 -0
  268. package/typings/components/panels/ExampleItem/selectors.d.ts +39 -0
  269. package/typings/components/panels/ExampleItem/styled.d.ts +101 -0
  270. package/typings/components/panels/ExampleItem/types.d.ts +9 -0
  271. package/typings/components/panels/ExampleItem/useActiveServer.d.ts +17 -0
  272. package/typings/components/panels/ExampleItem/useCodeSampleLanguages.d.ts +23 -0
  273. package/typings/components/panels/GroupPanelItem.d.ts +5 -0
  274. package/typings/components/panels/LanguageItem/LanguageDropdown.d.ts +15 -0
  275. package/typings/components/panels/LanguageItem/LanguageItem.d.ts +11 -0
  276. package/typings/components/panels/LanguageItem/LanguageListSkeleton.d.ts +4 -0
  277. package/typings/components/panels/LanguageItem/constants.d.ts +2 -0
  278. package/typings/components/panels/LanguageItem/styled.d.ts +71 -0
  279. package/typings/components/panels/LocationsPanelItem.d.ts +5 -0
  280. package/typings/components/panels/McpExamplePanelItem.d.ts +5 -0
  281. package/typings/components/panels/McpPanelItem.d.ts +3 -0
  282. package/typings/components/panels/OverviewPanelItem.d.ts +3 -0
  283. package/typings/components/panels/PanelMapper.d.ts +5 -0
  284. package/typings/components/panels/PanelNodeProps.d.ts +4 -0
  285. package/typings/components/panels/ReferencesPanelItem.d.ts +5 -0
  286. package/typings/components/panels/ServerItem/ServerDescriptionTooltip.d.ts +4 -0
  287. package/typings/components/panels/ServerItem/ServerItem.d.ts +5 -0
  288. package/typings/components/panels/ServerItem/ServerPanelItem.d.ts +5 -0
  289. package/typings/components/panels/asyncapi/BrokerItem/BrokerBindingsSection.d.ts +7 -0
  290. package/typings/components/panels/asyncapi/BrokerItem/BrokerModal.d.ts +8 -0
  291. package/typings/components/panels/asyncapi/BrokerItem/BrokerOverviewSection.d.ts +6 -0
  292. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanel.styled.d.ts +21 -0
  293. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanelItem.d.ts +5 -0
  294. package/typings/components/panels/asyncapi/ChannelBindingItem/ChannelBindingItem.d.ts +5 -0
  295. package/typings/components/panels/asyncapi/MessageBindingItem/MessageBindingItem.d.ts +5 -0
  296. package/typings/components/panels/asyncapi/MessageReferencesItem/MessageReferencesItem.d.ts +5 -0
  297. package/typings/components/panels/asyncapi/OperationBindingItem/OperationBindingItem.d.ts +5 -0
  298. package/typings/components/panels/asyncapi/common/bindingPanel.d.ts +30 -0
  299. package/typings/components/panels/shared-panel-styles.d.ts +16 -0
  300. package/typings/components/panels/styled.d.ts +18 -0
  301. package/typings/constants/openapi.d.ts +30 -0
  302. package/typings/constants/rendering.d.ts +8 -0
  303. package/typings/contexts/markdownAdapter.d.ts +21 -0
  304. package/typings/contexts/telemetry.d.ts +4 -0
  305. package/typings/crypto-compat.d.ts +5 -0
  306. package/typings/crypto-uuid-compat.d.ts +1 -0
  307. package/typings/empty-linkedom.d.ts +1 -0
  308. package/typings/empty.d.ts +7 -0
  309. package/typings/events/codeSampleCopy.d.ts +2 -0
  310. package/typings/events/creator.d.ts +2 -0
  311. package/typings/events/index.d.ts +6 -0
  312. package/typings/events/languageSwitch.d.ts +2 -0
  313. package/typings/events/panelToggle.d.ts +2 -0
  314. package/typings/events/serverSwitch.d.ts +2 -0
  315. package/typings/events/types.d.ts +7 -0
  316. package/typings/hoc/withItemId.d.ts +6 -0
  317. package/typings/hoc/withRouter.d.ts +4 -0
  318. package/typings/hoc/withStoreProvider.d.ts +24 -0
  319. package/typings/hooks/deepLinkHash.d.ts +7 -0
  320. package/typings/hooks/useAgentTools.d.ts +6 -0
  321. package/typings/hooks/useApiDocsRoutes.d.ts +8 -0
  322. package/typings/hooks/useApiDocsScroll.d.ts +9 -0
  323. package/typings/hooks/useBodyScrollLock.d.ts +1 -0
  324. package/typings/{utils/highlight.d.ts → hooks/useCodeHighlight.d.ts} +17 -23
  325. package/typings/hooks/useCopyCodeTelemetry.d.ts +14 -0
  326. package/typings/hooks/useCopySpecSlice.d.ts +9 -0
  327. package/typings/hooks/useDeepLinkSection.d.ts +23 -0
  328. package/typings/hooks/useExpandableSection.d.ts +4 -0
  329. package/typings/hooks/useHashLinkRedirect.d.ts +4 -0
  330. package/typings/hooks/useInitialTelemetry.d.ts +3 -0
  331. package/typings/hooks/useIsExpanded.d.ts +1 -0
  332. package/typings/hooks/useIsHydrated.d.ts +4 -0
  333. package/typings/hooks/useManualScrollAnchor.d.ts +19 -0
  334. package/typings/hooks/useModalDismiss.d.ts +2 -0
  335. package/typings/hooks/useNormalizeUrl.d.ts +2 -0
  336. package/typings/hooks/usePageTelemetry.d.ts +3 -0
  337. package/typings/hooks/usePageViewTelemetry.d.ts +2 -0
  338. package/typings/hooks/usePerformanceMetricsTelemetry.d.ts +5 -0
  339. package/typings/hooks/useRouterHashBridge.d.ts +25 -0
  340. package/typings/hooks/useScrollSpyUrlSync.d.ts +3 -0
  341. package/typings/hooks/useSearchEngine.d.ts +7 -0
  342. package/typings/hooks/useSessionSummaryTelemetry.d.ts +7 -0
  343. package/typings/hooks/useTelemetry.d.ts +2 -0
  344. package/typings/hooks/useTranslate.d.ts +5 -0
  345. package/typings/hooks/useUrlHash.d.ts +8 -0
  346. package/typings/hooks/useUrlHashReassert.d.ts +2 -0
  347. package/typings/hooks/useUserScrollIntent.d.ts +18 -0
  348. package/typings/hooks/useVisitedChannelsTracker.d.ts +6 -0
  349. package/typings/icons/CSharpIcon/CSharpIcon.d.ts +4 -0
  350. package/typings/icons/CSharpIcon/index.d.ts +1 -0
  351. package/typings/icons/CurlIcon/CurlIcon.d.ts +6 -0
  352. package/typings/icons/CurlIcon/index.d.ts +1 -0
  353. package/typings/icons/DefaultMappingIcon/DefaultMappingIcon.d.ts +6 -0
  354. package/typings/icons/DefaultMappingIcon/index.d.ts +1 -0
  355. package/typings/icons/GOIcon/GOIcon.d.ts +4 -0
  356. package/typings/icons/GOIcon/index.d.ts +1 -0
  357. package/typings/icons/JavaIcon/JavaIcon.d.ts +4 -0
  358. package/typings/icons/JavaIcon/index.d.ts +1 -0
  359. package/typings/icons/JavaScriptIcon/JavaScriptIcon.d.ts +4 -0
  360. package/typings/icons/JavaScriptIcon/index.d.ts +1 -0
  361. package/typings/icons/ListIcon/ListIcon.d.ts +10 -0
  362. package/typings/icons/NodeJSIcon/NodeJSIcon.d.ts +4 -0
  363. package/typings/icons/NodeJSIcon/index.d.ts +1 -0
  364. package/typings/icons/PHPIcon/PHPIcon.d.ts +4 -0
  365. package/typings/icons/PHPIcon/index.d.ts +1 -0
  366. package/typings/icons/PayloadIcon/PayloadIcon.d.ts +4 -0
  367. package/typings/icons/PayloadIcon/index.d.ts +1 -0
  368. package/typings/icons/PlusCircleIcon/PlusCircleIcon.d.ts +7 -0
  369. package/typings/icons/PythonIcon/PythonIcon.d.ts +4 -0
  370. package/typings/icons/PythonIcon/index.d.ts +1 -0
  371. package/typings/icons/RIcon/RIcon.d.ts +4 -0
  372. package/typings/icons/RIcon/index.d.ts +1 -0
  373. package/typings/icons/RubyIcon/RubyIcon.d.ts +4 -0
  374. package/typings/icons/RubyIcon/index.d.ts +1 -0
  375. package/typings/index.d.ts +9 -8
  376. package/typings/jotai/app.d.ts +75 -0
  377. package/typings/jotai/examples.d.ts +5 -0
  378. package/typings/jotai/graphql.d.ts +10 -0
  379. package/typings/jotai/itemStore.d.ts +51 -0
  380. package/typings/jotai/routes.d.ts +4 -0
  381. package/typings/jotai/schema.d.ts +3 -0
  382. package/typings/jotai/store.d.ts +22 -0
  383. package/typings/jotai/telemetry.d.ts +46 -0
  384. package/typings/options/constants.d.ts +10 -0
  385. package/typings/options/editionOverrides.d.ts +3 -0
  386. package/typings/options/helpers.d.ts +25 -0
  387. package/typings/options/normalizeOptions.d.ts +2 -0
  388. package/typings/options/standaloneLayoutVars.d.ts +3 -0
  389. package/typings/otel-semantic-conventions.d.ts +10 -0
  390. package/typings/pages/EntryPage.d.ts +25 -0
  391. package/typings/pages/GroupPage.d.ts +1 -0
  392. package/typings/pages/ItemPage.d.ts +1 -0
  393. package/typings/pages/NotFoundPage.d.ts +6 -0
  394. package/typings/pages/OverviewPage.d.ts +1 -0
  395. package/typings/pages/TopLevelEntryView.d.ts +17 -0
  396. package/typings/services/agent-tools/index.d.ts +11 -0
  397. package/typings/services/agent-tools/operations.d.ts +20 -0
  398. package/typings/services/agent-tools/results.d.ts +6 -0
  399. package/typings/services/agent-tools/security.d.ts +13 -0
  400. package/typings/services/agent-tools/spec-slice-detail.d.ts +12 -0
  401. package/typings/services/agent-tools/types.d.ts +54 -0
  402. package/typings/services/agent-tools/webmcp.d.ts +14 -0
  403. package/typings/services/code-samples/apply-env-variables.d.ts +8 -0
  404. package/typings/services/code-samples/convertSampleToString.d.ts +3 -0
  405. package/typings/services/code-samples/discriminator.d.ts +66 -0
  406. package/typings/services/code-samples/example-key.d.ts +25 -0
  407. package/typings/services/code-samples/index.d.ts +2 -0
  408. package/typings/services/code-samples/language-availability.d.ts +4 -0
  409. package/typings/services/code-samples/normalize-servers.d.ts +3 -0
  410. package/typings/services/code-samples/server-env.d.ts +3 -0
  411. package/typings/services/code-samples/server-variables.d.ts +11 -0
  412. package/typings/services/code-samples/source.d.ts +104 -0
  413. package/typings/services/schema/dialects/graphqlSchema.d.ts +1 -0
  414. package/typings/services/schema/dialects/jsonSchema.d.ts +7 -0
  415. package/typings/services/schema/index.d.ts +1 -0
  416. package/typings/services/schema/propertyBuilder.d.ts +32 -0
  417. package/typings/services/schema/propertyTreeBuilder.d.ts +21 -0
  418. package/typings/services/schema/schemaProcessor.d.ts +2 -0
  419. package/typings/services/schema/variant-label.d.ts +6 -0
  420. package/typings/services/search/engine/collapse.d.ts +5 -0
  421. package/typings/services/search/engine/constants.d.ts +22 -0
  422. package/typings/services/search/engine/flexsearch.d.ts +6 -0
  423. package/typings/services/search/engine/index.d.ts +11 -0
  424. package/typings/services/search/engine/lowered.d.ts +34 -0
  425. package/typings/services/search/engine/match.d.ts +12 -0
  426. package/typings/services/search/engine/present.d.ts +5 -0
  427. package/typings/services/search/engine/query.d.ts +6 -0
  428. package/typings/services/search/engine/score.d.ts +7 -0
  429. package/typings/services/search/engine/text.d.ts +3 -0
  430. package/typings/services/search/engine/types.d.ts +19 -0
  431. package/typings/services/search/highlight.d.ts +3 -0
  432. package/typings/services/search/index.d.ts +4 -0
  433. package/typings/services/search/indexer/context.d.ts +8 -0
  434. package/typings/services/search/indexer/deep-links.d.ts +12 -0
  435. package/typings/services/search/indexer/extractors/asyncapi.d.ts +8 -0
  436. package/typings/services/search/indexer/extractors/body.d.ts +2 -0
  437. package/typings/services/search/indexer/extractors/callbacks.d.ts +4 -0
  438. package/typings/services/search/indexer/extractors/context.d.ts +25 -0
  439. package/typings/services/search/indexer/extractors/examples.d.ts +3 -0
  440. package/typings/services/search/indexer/extractors/graphql.d.ts +2 -0
  441. package/typings/services/search/indexer/extractors/heading-sections.d.ts +3 -0
  442. package/typings/services/search/indexer/extractors/index.d.ts +12 -0
  443. package/typings/services/search/indexer/extractors/mcp.d.ts +9 -0
  444. package/typings/services/search/indexer/extractors/named-rows.d.ts +9 -0
  445. package/typings/services/search/indexer/extractors/panels.d.ts +10 -0
  446. package/typings/services/search/indexer/extractors/parameters.d.ts +2 -0
  447. package/typings/services/search/indexer/extractors/responses.d.ts +2 -0
  448. package/typings/services/search/indexer/extractors/schema-page.d.ts +9 -0
  449. package/typings/services/search/indexer/extractors/security.d.ts +4 -0
  450. package/typings/services/search/indexer/index.d.ts +14 -0
  451. package/typings/services/search/indexer/param.d.ts +7 -0
  452. package/typings/services/search/indexer/places.d.ts +42 -0
  453. package/typings/services/search/indexer/schema-walker.d.ts +29 -0
  454. package/typings/services/search/indexer/text.d.ts +2 -0
  455. package/typings/services/search/init.d.ts +7 -0
  456. package/typings/services/search/text-match.d.ts +5 -0
  457. package/typings/services/search/types.d.ts +32 -0
  458. package/typings/services/spec-slice/assistant-links.d.ts +9 -0
  459. package/typings/services/spec-slice/asyncapi-slice.d.ts +5 -0
  460. package/typings/services/spec-slice/clone-strip.d.ts +1 -0
  461. package/typings/services/spec-slice/component-closure.d.ts +6 -0
  462. package/typings/services/spec-slice/graphql-slice.d.ts +2 -0
  463. package/typings/services/spec-slice/index.d.ts +6 -0
  464. package/typings/services/spec-slice/openapi-slice.d.ts +6 -0
  465. package/typings/services/spec-slice/resolve-scope.d.ts +4 -0
  466. package/typings/services/spec-slice/types.d.ts +37 -0
  467. package/typings/standalone.d.ts +20 -0
  468. package/typings/standaloneThemeConfig.d.ts +3 -0
  469. package/typings/telemetry/RedocTelemetry.d.ts +22 -0
  470. package/typings/telemetry/TypeOfUsageContext.d.ts +3 -0
  471. package/typings/telemetry/defaults.d.ts +7 -0
  472. package/typings/telemetry/events.d.ts +42 -0
  473. package/typings/telemetry/fields.d.ts +7 -0
  474. package/typings/telemetry/index.d.ts +15 -0
  475. package/typings/telemetry/initialPayload.d.ts +56 -0
  476. package/typings/telemetry/page.d.ts +5 -0
  477. package/typings/telemetry/reportDefinitionLoadFailed.d.ts +9 -0
  478. package/typings/telemetry/sanitizeError.d.ts +4 -0
  479. package/typings/telemetry/security.d.ts +15 -0
  480. package/typings/telemetry/useRedocTelemetryInstance.d.ts +3 -0
  481. package/typings/telemetry/useSchemaFieldTelemetry.d.ts +4 -0
  482. package/typings/telemetry/useSidebarItemTelemetry.d.ts +11 -0
  483. package/typings/types/asyncapi.d.ts +348 -0
  484. package/typings/types/code-samples-config.d.ts +12 -0
  485. package/typings/types/common.d.ts +162 -0
  486. package/typings/types/content.d.ts +503 -0
  487. package/typings/types/edition-config.d.ts +6 -0
  488. package/typings/types/events.d.ts +64 -0
  489. package/typings/types/graphql-store.d.ts +60 -0
  490. package/typings/types/graphql.d.ts +54 -0
  491. package/typings/types/index.d.ts +10 -2
  492. package/typings/types/openapi.d.ts +556 -0
  493. package/typings/types/options.d.ts +132 -0
  494. package/typings/types/pluggable.d.ts +4 -0
  495. package/typings/types/schema.d.ts +156 -0
  496. package/typings/types/store.d.ts +176 -0
  497. package/typings/url-compat.d.ts +22 -0
  498. package/typings/utils/calculateMaxLength.d.ts +6 -0
  499. package/typings/utils/compose.d.ts +8 -0
  500. package/typings/utils/cookies.d.ts +7 -0
  501. package/typings/utils/deep-link.d.ts +171 -0
  502. package/typings/utils/definitionLoadError.d.ts +7 -0
  503. package/typings/utils/environments.d.ts +6 -0
  504. package/typings/utils/expansion.d.ts +3 -0
  505. package/typings/utils/extract-extensions.d.ts +4 -0
  506. package/typings/utils/form-urlencoded.d.ts +6 -0
  507. package/typings/utils/graphql-directive-utils.d.ts +6 -0
  508. package/typings/utils/graphql-parse.d.ts +1 -0
  509. package/typings/utils/graphql-reference-map.d.ts +3 -0
  510. package/typings/utils/graphql-samples.d.ts +25 -0
  511. package/typings/utils/graphql-scopes.d.ts +6 -0
  512. package/typings/utils/graphql-type-expansion.d.ts +5 -0
  513. package/typings/utils/http-methods.d.ts +8 -0
  514. package/typings/utils/is-record.d.ts +1 -0
  515. package/typings/utils/languages.d.ts +18 -0
  516. package/typings/utils/loadAndBundleSpec.d.ts +4 -3
  517. package/typings/utils/logo.d.ts +8 -0
  518. package/typings/utils/media-type.d.ts +7 -0
  519. package/typings/utils/multipart.d.ts +7 -0
  520. package/typings/utils/overview-partial-sections.d.ts +7 -0
  521. package/typings/utils/refPointer.d.ts +2 -0
  522. package/typings/utils/resolveText.d.ts +2 -0
  523. package/typings/utils/routeKind.d.ts +6 -0
  524. package/typings/utils/routing.d.ts +51 -0
  525. package/typings/utils/scroll-anchoring.d.ts +4 -0
  526. package/typings/utils/security-scope.d.ts +3 -0
  527. package/typings/utils/serialize-parameter.d.ts +8 -0
  528. package/typings/utils/serialize-querystring.d.ts +6 -0
  529. package/typings/utils/session-storage.d.ts +2 -0
  530. package/typings/utils/split-badges-by-position.d.ts +5 -0
  531. package/typings/utils/status-code.d.ts +1 -0
  532. package/typings/utils/string.d.ts +18 -0
  533. package/typings/utils/telemetry.d.ts +1 -0
  534. package/typings/utils/url.d.ts +9 -0
  535. package/typings/utils/x-logo.d.ts +13 -0
  536. package/typings/utils/xml.d.ts +1 -0
  537. package/typings/yaml-compat.d.ts +7 -0
  538. package/bundles/d87bcbdbea8f8f5aa26f.worker.js.LICENSE.txt +0 -68
  539. package/bundles/d87bcbdbea8f8f5aa26f.worker.js.map +0 -1
  540. package/bundles/redoc.browser.lib.js +0 -1845
  541. package/bundles/redoc.browser.lib.js.LICENSE.txt +0 -6
  542. package/bundles/redoc.browser.lib.js.map +0 -1
  543. package/bundles/redoc.lib.js +0 -1845
  544. package/bundles/redoc.lib.js.LICENSE.txt +0 -6
  545. package/bundles/redoc.lib.js.map +0 -1
  546. package/bundles/redoc.standalone.js.LICENSE.txt +0 -102
  547. package/bundles/redoc.standalone.js.map +0 -1
  548. package/typings/common-elements/CopyButtonWrapper.d.ts +0 -10
  549. package/typings/common-elements/Dropdown/Dropdown.d.ts +0 -3
  550. package/typings/common-elements/Dropdown/index.d.ts +0 -2
  551. package/typings/common-elements/Dropdown/styled.d.ts +0 -7
  552. package/typings/common-elements/Dropdown/types.d.ts +0 -23
  553. package/typings/common-elements/PrismDiv.d.ts +0 -1
  554. package/typings/common-elements/Tooltip.d.ts +0 -8
  555. package/typings/common-elements/fields-layout.d.ts +0 -14
  556. package/typings/common-elements/fields.d.ts +0 -20
  557. package/typings/common-elements/headers.d.ts +0 -6
  558. package/typings/common-elements/index.d.ts +0 -11
  559. package/typings/common-elements/linkify.d.ts +0 -10
  560. package/typings/common-elements/mixins.d.ts +0 -1
  561. package/typings/common-elements/panels.d.ts +0 -11
  562. package/typings/common-elements/perfect-scrollbar.d.ts +0 -19
  563. package/typings/common-elements/samples.d.ts +0 -5
  564. package/typings/common-elements/schema.d.ts +0 -8
  565. package/typings/common-elements/shelfs.d.ts +0 -13
  566. package/typings/common-elements/tabs.d.ts +0 -3
  567. package/typings/components/ApiInfo/ApiInfo.d.ts +0 -8
  568. package/typings/components/ApiInfo/index.d.ts +0 -1
  569. package/typings/components/ApiInfo/styled.elements.d.ts +0 -8
  570. package/typings/components/ApiLogo/ApiLogo.d.ts +0 -7
  571. package/typings/components/ApiLogo/styled.elements.d.ts +0 -4
  572. package/typings/components/CallbackSamples/CallbackReqSamples.d.ts +0 -11
  573. package/typings/components/CallbackSamples/CallbackSamples.d.ts +0 -13
  574. package/typings/components/Callbacks/CallbackDetails.d.ts +0 -8
  575. package/typings/components/Callbacks/CallbackOperation.d.ts +0 -8
  576. package/typings/components/Callbacks/CallbackTitle.d.ts +0 -10
  577. package/typings/components/Callbacks/CallbacksList.d.ts +0 -8
  578. package/typings/components/Callbacks/index.d.ts +0 -3
  579. package/typings/components/Callbacks/styled.elements.d.ts +0 -2
  580. package/typings/components/ContentItems/ContentItems.d.ts +0 -22
  581. package/typings/components/DropdownOrLabel/DropdownOrLabel.d.ts +0 -10
  582. package/typings/components/Endpoint/Endpoint.d.ts +0 -16
  583. package/typings/components/Endpoint/styled.elements.d.ts +0 -17
  584. package/typings/components/ExternalDocumentation/ExternalDocumentation.d.ts +0 -8
  585. package/typings/components/Fields/ArrayItemDetails.d.ts +0 -5
  586. package/typings/components/Fields/EnumValues.d.ts +0 -17
  587. package/typings/components/Fields/Examples.d.ts +0 -5
  588. package/typings/components/Fields/Extensions.d.ts +0 -9
  589. package/typings/components/Fields/Field.d.ts +0 -20
  590. package/typings/components/Fields/FieldConstraints.d.ts +0 -7
  591. package/typings/components/Fields/FieldDetail.d.ts +0 -7
  592. package/typings/components/Fields/FieldDetails.d.ts +0 -4
  593. package/typings/components/Fields/Pattern.d.ts +0 -5
  594. package/typings/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +0 -22
  595. package/typings/components/JsonViewer/JsonViewer.d.ts +0 -6
  596. package/typings/components/JsonViewer/index.d.ts +0 -1
  597. package/typings/components/JsonViewer/style.d.ts +0 -1
  598. package/typings/components/Loading/Loading.d.ts +0 -7
  599. package/typings/components/Loading/Spinner.svg.d.ts +0 -5
  600. package/typings/components/Markdown/AdvancedMarkdown.d.ts +0 -11
  601. package/typings/components/Markdown/Markdown.d.ts +0 -17
  602. package/typings/components/Markdown/SanitizedMdBlock.d.ts +0 -7
  603. package/typings/components/Markdown/styled.elements.d.ts +0 -7
  604. package/typings/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +0 -17
  605. package/typings/components/Operation/Operation.d.ts +0 -5
  606. package/typings/components/OptionsProvider.d.ts +0 -5
  607. package/typings/components/Parameters/Parameters.d.ts +0 -16
  608. package/typings/components/Parameters/ParametersGroup.d.ts +0 -9
  609. package/typings/components/PayloadSamples/Example.d.ts +0 -8
  610. package/typings/components/PayloadSamples/ExampleValue.d.ts +0 -6
  611. package/typings/components/PayloadSamples/MediaTypeSamples.d.ts +0 -18
  612. package/typings/components/PayloadSamples/PayloadSamples.d.ts +0 -9
  613. package/typings/components/PayloadSamples/exernalExampleHook.d.ts +0 -2
  614. package/typings/components/PayloadSamples/styled.elements.d.ts +0 -7
  615. package/typings/components/Redoc/Redoc.d.ts +0 -14
  616. package/typings/components/Redoc/styled.elements.d.ts +0 -3
  617. package/typings/components/RedocStandalone.d.ts +0 -9
  618. package/typings/components/RequestSamples/RequestSamples.d.ts +0 -11
  619. package/typings/components/ResponseSamples/ResponseSamples.d.ts +0 -9
  620. package/typings/components/Responses/Response.d.ts +0 -6
  621. package/typings/components/Responses/ResponseDetails.d.ts +0 -8
  622. package/typings/components/Responses/ResponseHeaders.d.ts +0 -8
  623. package/typings/components/Responses/ResponseTitle.d.ts +0 -11
  624. package/typings/components/Responses/ResponsesList.d.ts +0 -9
  625. package/typings/components/Responses/styled.elements.d.ts +0 -6
  626. package/typings/components/Schema/ArraySchema.d.ts +0 -5
  627. package/typings/components/Schema/DiscriminatorDropdown.d.ts +0 -11
  628. package/typings/components/Schema/ObjectSchema.d.ts +0 -11
  629. package/typings/components/Schema/OneOfSchema.d.ts +0 -15
  630. package/typings/components/Schema/RecursiveSchema.d.ts +0 -3
  631. package/typings/components/Schema/Schema.d.ts +0 -15
  632. package/typings/components/Schema/index.d.ts +0 -5
  633. package/typings/components/SchemaDefinition/SchemaDefinition.d.ts +0 -18
  634. package/typings/components/SearchBox/SearchBox.d.ts +0 -32
  635. package/typings/components/SearchBox/styled.elements.d.ts +0 -12
  636. package/typings/components/SecurityRequirement/OAuthFlow.d.ts +0 -9
  637. package/typings/components/SecurityRequirement/RequiredScopesRow.d.ts +0 -3
  638. package/typings/components/SecurityRequirement/SecurityDetails.d.ts +0 -8
  639. package/typings/components/SecurityRequirement/SecurityHeader.d.ts +0 -8
  640. package/typings/components/SecurityRequirement/SecurityRequirement.d.ts +0 -6
  641. package/typings/components/SecurityRequirement/styled.elements.d.ts +0 -17
  642. package/typings/components/SecuritySchemes/SecuritySchemes.d.ts +0 -14
  643. package/typings/components/SeeMore/SeeMore.d.ts +0 -7
  644. package/typings/components/SelectOnClick/SelectOnClick.d.ts +0 -6
  645. package/typings/components/SideMenu/Logo.d.ts +0 -1
  646. package/typings/components/SideMenu/MenuItem.d.ts +0 -22
  647. package/typings/components/SideMenu/MenuItems.d.ts +0 -13
  648. package/typings/components/SideMenu/index.d.ts +0 -4
  649. package/typings/components/SideMenu/styled.elements.d.ts +0 -30
  650. package/typings/components/SourceCode/SourceCode.d.ts +0 -7
  651. package/typings/components/StickySidebar/ChevronSvg.d.ts +0 -4
  652. package/typings/components/StickySidebar/StickyResponsiveSidebar.d.ts +0 -23
  653. package/typings/components/StoreBuilder.d.ts +0 -26
  654. package/typings/components/index.d.ts +0 -34
  655. package/typings/services/AppStore.d.ts +0 -33
  656. package/typings/services/ClipboardService.d.ts +0 -8
  657. package/typings/services/HistoryService.d.ts +0 -12
  658. package/typings/services/Labels.d.ts +0 -3
  659. package/typings/services/MarkdownRenderer.d.ts +0 -26
  660. package/typings/services/MarkerService.d.ts +0 -11
  661. package/typings/services/MenuBuilder.d.ts +0 -50
  662. package/typings/services/MenuStore.d.ts +0 -89
  663. package/typings/services/OpenAPIParser.d.ts +0 -50
  664. package/typings/services/RedocNormalizedOptions.d.ts +0 -123
  665. package/typings/services/ScrollService.d.ts +0 -17
  666. package/typings/services/SearchStore.d.ts +0 -16
  667. package/typings/services/SearchWorker.worker.d.ts +0 -20
  668. package/typings/services/SpecStore.d.ts +0 -20
  669. package/typings/services/index.d.ts +0 -14
  670. package/typings/services/models/ApiInfo.d.ts +0 -23
  671. package/typings/services/models/Callback.d.ts +0 -11
  672. package/typings/services/models/Example.d.ts +0 -13
  673. package/typings/services/models/Field.d.ts +0 -32
  674. package/typings/services/models/Group.model.d.ts +0 -25
  675. package/typings/services/models/MediaContent.d.ts +0 -24
  676. package/typings/services/models/MediaType.d.ts +0 -20
  677. package/typings/services/models/Operation.d.ts +0 -72
  678. package/typings/services/models/RequestBody.d.ts +0 -17
  679. package/typings/services/models/Response.d.ts +0 -26
  680. package/typings/services/models/Schema.d.ts +0 -62
  681. package/typings/services/models/SecurityRequirement.d.ts +0 -12
  682. package/typings/services/models/SecuritySchemes.d.ts +0 -26
  683. package/typings/services/models/Webhook.d.ts +0 -9
  684. package/typings/services/models/index.d.ts +0 -13
  685. package/typings/services/types.d.ts +0 -106
  686. package/typings/styled-components.d.ts +0 -12
  687. package/typings/styled-patch.d.ts +0 -22
  688. package/typings/theme.d.ts +0 -163
  689. package/typings/types/index.ts +0 -3
  690. package/typings/types/open-api.d.ts +0 -314
  691. package/typings/types/open-api.ts +0 -304
  692. package/typings/utils/debug.d.ts +0 -2
  693. package/typings/utils/decorators.d.ts +0 -1
  694. package/typings/utils/dom.d.ts +0 -9
  695. package/typings/utils/helpers.d.ts +0 -43
  696. package/typings/utils/index.d.ts +0 -10
  697. package/typings/utils/jsonToHtml.d.ts +0 -1
  698. package/typings/utils/memoize.d.ts +0 -1
  699. package/typings/utils/openapi.d.ts +0 -43
  700. package/typings/utils/sort.d.ts +0 -6
@@ -0,0 +1,1574 @@
1
+ import type { AdmonitionProps } from '@redocly/theme/components/Admonition/Admonition';
2
+ import type { AsyncApiConfig } from '@redocly/config';
3
+ import type { ConfigureRequestValues } from '@redocly/theme/ext/configure';
4
+ import type { ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
5
+ import type { EventType } from '@redocly/redoc-opentelemetry';
6
+ import type { GraphQLConfig } from '@redocly/config';
7
+ import type { JSONSchema7 } from 'json-schema';
8
+ import type { LayoutVariant } from '@redocly/config';
9
+ import type { Node as Node_2 } from '@markdoc/markdoc';
10
+ import type { ReactElement } from 'react';
11
+ import type { ReactNode } from 'react';
12
+ import type { RedocConfig } from '@redocly/config';
13
+ import type { ResolvedNavItem } from '@redocly/config';
14
+ import { Root } from 'react-dom/client';
15
+
16
+ declare type AdmonitionNode = {
17
+ nodeType: typeof nodeTypes.ADMONITION;
18
+ admonitionType: NonNullable<AdmonitionProps['type']>;
19
+ name?: string;
20
+ nameTranslationKey?: string;
21
+ content?: string | Node_2[] | Node_2;
22
+ };
23
+
24
+ declare type AnalyticsEvent = {
25
+ eventType: AnalyticsEventType;
26
+ resource: 'Redocly_CodeSample' | 'Redocly_Operation';
27
+ action: 'LanguageSwitched' | 'PanelToggled' | 'CodeSampleCopied' | 'TargetServerSwitched';
28
+ operationId?: string;
29
+ operationPath: string;
30
+ operationHttpVerb: string;
31
+ operationSummary?: string | Record<string, unknown>;
32
+ };
33
+
34
+ declare type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'PanelToggle' | 'TargetServerSwitched';
35
+
36
+ declare type ApiDocsMetadata = {
37
+ title?: string;
38
+ description?: string | Node_2[] | Node_2;
39
+ summary?: string;
40
+ version?: string;
41
+ [key: string]: unknown;
42
+ };
43
+
44
+ declare type ApiDocsOptions = {
45
+ schemaDefinitionsTagName?: string;
46
+ jsonSamplesExpandLevel: number;
47
+ generatedSamplesMaxDepth: number;
48
+ hideDownloadButtons: boolean;
49
+ hideSchemaTitles: boolean;
50
+ hideSchemaPattern: boolean;
51
+ maxDisplayedEnumValues: number;
52
+ onlyRequiredInSamples: boolean;
53
+ onDeepLinkClick: ((link: string) => void) | undefined | null;
54
+ schemasExpansionLevel?: number;
55
+ sortRequiredPropsFirst: boolean;
56
+ sanitize: boolean;
57
+ showExtensions: string[] | boolean;
58
+ ignoreNamedSchemas: Set<string>;
59
+ markdownParser: MarkdownParser;
60
+ codeSamples?: CodeSamplesConfig;
61
+ events: Events;
62
+ hidePropertiesPrefix: boolean;
63
+ dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
64
+ protocol?: ProtocolVariant;
65
+ scrollYOffset: () => number;
66
+ hideLoading: boolean;
67
+ skipBundle: boolean;
68
+ basePath: string;
69
+ specType: ApiSpecType;
70
+ metadata: ApiDocsMetadata;
71
+ downloadUrls?: NormalizedDownloadUrl[];
72
+ layout: LayoutVariant;
73
+ apiLogo?: SidebarLogo;
74
+ jsonSamplesDepth: number;
75
+ samplesMaxInlineArgs: number;
76
+ fieldExpandLevel: number;
77
+ } & GraphQLOptions;
78
+
79
+ declare type ApiItem = ResolvedNavItem & {
80
+ content: ApiItemContent | null;
81
+ httpVerb?: string;
82
+ };
83
+
84
+ declare type ApiItemContent = {
85
+ contentType: ContentType;
86
+ seo?: SeoData;
87
+ itemVariant?: ItemVariant;
88
+ meta?: ItemMeta;
89
+ children: ContentNode[];
90
+ showDivider?: boolean;
91
+ };
92
+
93
+ declare type ApiSpecType = ObjectValues<typeof apiSpecType>;
94
+
95
+ declare const apiSpecType: {
96
+ readonly OPENAPI: 'openapi';
97
+ readonly ASYNCAPI: 'asyncapi';
98
+ readonly GRAPHQL: 'graphql';
99
+ };
100
+
101
+ declare type ApiStore = {
102
+ schemaStore: Record<string, SchemaEntry>;
103
+ exampleStore: Record<string, ExampleEntry>;
104
+ securitySchemeStore: Record<string, SecuritySchemeEntry_2>;
105
+ graphqlMeta?: GraphqlStoreMeta;
106
+ servers?: ServerData[];
107
+ mcp?: McpData;
108
+ /** From OpenAPI `info.x-logo`. Rendered by the standalone sidebar. */
109
+ logo?: SidebarLogo;
110
+ specType?: ApiSpecType;
111
+ };
112
+
113
+ declare type AsyncApiExternalDocs = {
114
+ description?: string | Node_2[] | Node_2;
115
+ url: string;
116
+ };
117
+
118
+ declare type AsyncAPISchema = JSONSchema7 | MultiFormatSchemaObject;
119
+
120
+ declare type AsyncApiServerBinding = {
121
+ kafka?: AsyncApiServerKafkaBinding;
122
+ };
123
+
124
+ declare type AsyncApiServerKafkaBinding = {
125
+ schemaRegistryUrl?: string;
126
+ schemaRegistryVendor?: string;
127
+ bindingVersion?: string;
128
+ };
129
+
130
+ declare type AsyncApiTag = {
131
+ name: string;
132
+ description?: string | Node_2[] | Node_2;
133
+ externalDocs?: AsyncApiExternalDocs;
134
+ };
135
+
136
+ declare type AvroSchema = {
137
+ type: string | string[] | AvroSchema[];
138
+ name?: string;
139
+ doc?: string;
140
+ symbols?: string[];
141
+ fields?: Array<{
142
+ name: string;
143
+ type: AvroSchema | string | (string | AvroSchema)[];
144
+ doc?: string;
145
+ default?: unknown;
146
+ }>;
147
+ items?: AvroSchema | string;
148
+ values?: AvroSchema | string;
149
+ };
150
+
151
+ declare type Badge = {
152
+ name: string;
153
+ color?: string;
154
+ icon?: string;
155
+ description?: string;
156
+ };
157
+
158
+ declare type BadgeData = {
159
+ name: string;
160
+ color?: string;
161
+ position?: 'before' | 'after';
162
+ icon?: string;
163
+ description?: string;
164
+ };
165
+
166
+ declare type BadgeType = {
167
+ name: string;
168
+ position: 'before' | 'after';
169
+ color: string;
170
+ };
171
+
172
+ declare type BaseExamplePanelItem = {
173
+ schemaId?: string;
174
+ examples: {
175
+ name?: string;
176
+ summary?: string;
177
+ statusCode?: string;
178
+ mediaType?: string;
179
+ value?: unknown;
180
+ }[];
181
+ };
182
+
183
+ declare type BaseRequired = WithRequired<GraphQLConfig, 'jsonSamplesDepth' | 'samplesMaxInlineArgs' | 'fieldExpandLevel'>;
184
+
185
+ /** Sees every array payload before it is sent; returning `false` drops the event. */
186
+ declare type BeforeSend = (event: EventType, items: unknown[]) => boolean | void;
187
+
188
+ declare type BreadcrumbItem = {
189
+ label: string;
190
+ };
191
+
192
+ declare type BrokerData = {
193
+ /** Server host (3.x `host`, 2.x `url`); absent only for invalid documents. */
194
+ url?: string;
195
+ description?: string | Node_2[] | Node_2;
196
+ name?: string;
197
+ variables?: Record<string, {
198
+ enum?: string[];
199
+ default: string;
200
+ description?: string | Node_2[] | Node_2;
201
+ examples?: string[];
202
+ }>;
203
+ protocol?: string;
204
+ protocolVersion?: string;
205
+ pathname?: string;
206
+ title?: string;
207
+ summary?: string;
208
+ tags?: AsyncApiTag[];
209
+ externalDocs?: AsyncApiExternalDocs;
210
+ bindings?: AsyncApiServerBinding;
211
+ };
212
+
213
+ declare type BrokersNode = SingleChildPanelBase<typeof panelKind.BROKERS>;
214
+
215
+ declare type BrokersPanelItem = {
216
+ kind: typeof panelKind.BROKERS;
217
+ panelLabel?: string;
218
+ brokers: BrokerData[];
219
+ };
220
+
221
+ declare type BuildTimings = {
222
+ resolveSpecMs: number;
223
+ buildItemsMs: number;
224
+ };
225
+
226
+ declare type CallbackPayloadPanelItem = BaseExamplePanelItem & {
227
+ kind: typeof panelKind.CALLBACK_PAYLOAD;
228
+ callbackName?: string;
229
+ path?: string;
230
+ httpVerb?: string;
231
+ servers?: {
232
+ url: string;
233
+ name?: string;
234
+ description?: string;
235
+ variables?: Record<string, {
236
+ default?: string;
237
+ }>;
238
+ /** Set on entries injected by `mergeInMockServer` (never present in specs). */
239
+ isMockServer?: boolean;
240
+ }[];
241
+ definitionSamples?: DefinitionCodeSample_2[];
242
+ mediaTypes?: string[];
243
+ mediaTypeSchemas?: Record<string, MediaTypeContent>;
244
+ };
245
+
246
+ declare type ChannelAddressNode = {
247
+ nodeType: typeof nodeTypes.CHANNEL_ADDRESS;
248
+ address: string;
249
+ };
250
+
251
+ declare type ChannelBindingNode = SingleChildPanelBase<typeof panelKind.CHANNEL_BINDING>;
252
+
253
+ declare type ChannelBindingPanelItem = {
254
+ kind: typeof panelKind.CHANNEL_BINDING;
255
+ panelLabel?: string;
256
+ bindingKey: string;
257
+ bindingValue: Record<string, unknown>;
258
+ };
259
+
260
+ declare type CodeSamplePanelItem = BaseExamplePanelItem & {
261
+ kind: typeof panelKind.CODE_SAMPLE;
262
+ source: CodeSampleSource;
263
+ definitionSamples?: DefinitionCodeSample_2[];
264
+ isWebhook?: boolean;
265
+ servers?: {
266
+ url: string;
267
+ name?: string;
268
+ description?: string;
269
+ variables?: Record<string, {
270
+ default?: string;
271
+ }>;
272
+ /** Set on entries injected by `mergeInMockServer` (never present in specs). */
273
+ isMockServer?: boolean;
274
+ }[];
275
+ exampleIds?: string[];
276
+ mediaTypes?: string[];
277
+ mediaTypeSchemas?: Record<string, MediaTypeContent>;
278
+ };
279
+
280
+ declare type CodeSampleRequestValues = {
281
+ security?: Record<string, unknown>;
282
+ envVariables?: Record<string, string>;
283
+ serverEnvVariables?: Record<string, Record<string, string>>;
284
+ body?: unknown;
285
+ serverBody?: Record<string, unknown>;
286
+ };
287
+
288
+ /**
289
+ * Community edition: generated code samples are not included. The language
290
+ * list survives only to drive the payload tab and `x-codeSamples` matching.
291
+ * `key` and `label` are stamped onto every entry by `normalizeCodeSamples()`.
292
+ */
293
+ declare interface CodeSamplesConfig {
294
+ languages: {
295
+ lang: string;
296
+ label: string;
297
+ key: string;
298
+ }[];
299
+ }
300
+
301
+ declare type CodeSamplesCopiedEvent = AnalyticsEvent & {
302
+ lang: string;
303
+ label: string;
304
+ type: 'request' | 'response';
305
+ exampleId?: string;
306
+ exampleMimeType?: string;
307
+ };
308
+
309
+ declare type CodeSamplesLanguageSwitchedEvent = AnalyticsEvent & {
310
+ lang: string;
311
+ label: string;
312
+ exampleId?: string;
313
+ };
314
+
315
+ declare type CodeSampleSource = {
316
+ kind: typeof panelKind.CODE_SAMPLE;
317
+ operationType: 'http' | 'webhook' | 'callback';
318
+ method: string;
319
+ path: string;
320
+ servers: ServerEntry[];
321
+ parameters: {
322
+ path: ParameterEntry[];
323
+ query: ParameterEntry[];
324
+ querystring: ParameterEntry[];
325
+ header: ParameterEntry[];
326
+ cookie: ParameterEntry[];
327
+ };
328
+ security: SecurityRequirement[];
329
+ /** mediaType name → { schemaId, exampleIds } */
330
+ requestBody?: Record<string, MediaTypeEntry>;
331
+ /** Pre-authored code samples from the spec (x-codeSamples) */
332
+ definitionSamples?: DefinitionCodeSample[];
333
+ /** Response status codes (for generators that include expected status) */
334
+ responseCodes?: string[];
335
+ /** Configure request values (security credentials, env vars, per-server env vars) */
336
+ requestValues?: CodeSampleRequestValues;
337
+ /** Raw pointer into the spec (for deep linking) */
338
+ pointer?: string;
339
+ /** Docs route slug of the operation page, relative to the routing base path
340
+ * (e.g. `operations/getmuseumhours`) — lets hosts link back to the description */
341
+ href?: string;
342
+ /** OpenAPI `operationId` — should match the loaded spec so hosts can resolve the operation */
343
+ openApiOperationId?: string;
344
+ /** OpenAPI operation `summary` — the human-readable operation name */
345
+ summary?: string;
346
+ };
347
+
348
+ declare type ConnectMcpButtonPanelItem = {
349
+ kind: typeof panelKind.CONNECT_MCP_BUTTON;
350
+ title?: string;
351
+ titleTranslationKey?: string;
352
+ mcpUrl: string;
353
+ actions: string[];
354
+ };
355
+
356
+ declare const CONST_PROTOCOL_VARIANT: {
357
+ readonly DEFAULT: 'default';
358
+ readonly KAFKA: 'kafka';
359
+ readonly AMQP: 'amqp';
360
+ readonly WSS: 'wss';
361
+ };
362
+
363
+ declare type ContainerNode = {
364
+ nodeType: typeof nodeTypes.CONTAINER;
365
+ panels?: PanelNode[];
366
+ children: ContentNode[];
367
+ };
368
+
369
+ declare type ContentNode = ContainerNode | OverviewSectionWrapperNode | HeaderNode | EmptyMessageNode | ItemContentNode | SecurityNode | MarkdocNode | AdmonitionNode | ExternalDocsNode | ChannelAddressNode | MessageLinksNode | InfoMetadataNode | ExtensionsNode;
370
+
371
+ declare type ContentType = ObjectValues<typeof contentType>;
372
+
373
+ declare const contentType: {
374
+ readonly OVERVIEW: 'overview';
375
+ readonly GROUP: 'group';
376
+ readonly ITEM: 'item';
377
+ };
378
+
379
+ declare type DefinitionCodeSample = {
380
+ lang: string;
381
+ label?: string;
382
+ source: string;
383
+ };
384
+
385
+ declare type DefinitionCodeSample_2 = {
386
+ lang: string;
387
+ label?: string;
388
+ source: string;
389
+ };
390
+
391
+ declare type DownloadNode = MultiChildPanelBase<typeof panelKind.DOWNLOAD>;
392
+
393
+ declare type DownloadPanelItem = {
394
+ kind: typeof panelKind.DOWNLOAD;
395
+ label: string;
396
+ labelTranslationKey?: string;
397
+ url: string;
398
+ icon?: string;
399
+ };
400
+
401
+ declare type DownloadUrl = {
402
+ title?: string;
403
+ url: string;
404
+ };
405
+
406
+ declare type EditionAsyncApiConfig = Omit<AsyncApiConfig, EnterpriseOnlyOptionKey>;
407
+
408
+ declare type EditionGraphQLConfig = Omit<GraphQLConfig, EnterpriseOnlyOptionKey>;
409
+
410
+ declare type EditionRedocConfig = Omit<RedocConfig, EnterpriseOnlyOptionKey>;
411
+
412
+ declare type EmailPanelItem = {
413
+ kind: typeof panelKind.EMAIL;
414
+ title?: string;
415
+ titleTranslationKey?: string;
416
+ email: string;
417
+ label: string;
418
+ labelTranslationKey?: string;
419
+ withCopyButton?: boolean;
420
+ copyContent?: string;
421
+ };
422
+
423
+ declare type EmptyMessageNode = {
424
+ nodeType: typeof nodeTypes.EMPTY_MESSAGE;
425
+ label: string;
426
+ labelTranslationKey?: string;
427
+ };
428
+
429
+ declare type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks';
430
+
431
+ declare type Events = {
432
+ codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
433
+ codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
434
+ panelToggle?: (event: PanelToggleEvent) => void;
435
+ targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
436
+ };
437
+
438
+ declare type ExampleEntry = {
439
+ id: string;
440
+ value: unknown;
441
+ key?: string;
442
+ summary?: string;
443
+ description?: string | Node_2 | Node_2[];
444
+ mediaType?: string;
445
+ externalValue?: string;
446
+ };
447
+
448
+ declare type ExamplePanelItem = PayloadExamplesPanelItem | CodeSamplePanelItem | ResponseExamplesPanelItem | CallbackPayloadPanelItem | GraphQLQueryPanelItem | GraphQLResponsePanelItem | GraphQLVariablesPanelItem | GraphQLTypeSamplePanelItem;
449
+
450
+ declare type ExamplesNode = MultiChildPanelBase<typeof panelKind.PAYLOAD | typeof panelKind.CODE_SAMPLE | typeof panelKind.RESPONSE | typeof panelKind.CALLBACK_PAYLOAD | typeof panelKind.GRAPHQL_QUERY | typeof panelKind.GRAPHQL_RESPONSE | typeof panelKind.GRAPHQL_VARIABLES | typeof panelKind.GRAPHQL_TYPE_SAMPLE>;
451
+
452
+ declare type ExampleType = {
453
+ summary?: string;
454
+ description?: string;
455
+ value?: string;
456
+ };
457
+
458
+ declare type ExtensionsNode = {
459
+ nodeType: typeof nodeTypes.EXTENSIONS;
460
+ extensions: Record<string, unknown>;
461
+ };
462
+
463
+ declare type ExternalDocsNode = {
464
+ nodeType: typeof nodeTypes.EXTERNAL_DOCS;
465
+ url: string;
466
+ description: string | Node_2[] | Node_2;
467
+ };
468
+
469
+ declare type ExternalLinkPanelItem = {
470
+ kind: typeof panelKind.EXTERNAL_LINK;
471
+ title?: string;
472
+ titleTranslationKey?: string;
473
+ label: string;
474
+ labelTranslationKey?: string;
475
+ url: string;
476
+ withCopyButton?: boolean;
477
+ copyContent?: string;
478
+ };
479
+
480
+ declare type GraphQLContact = {
481
+ name?: string;
482
+ url?: string;
483
+ email?: string;
484
+ };
485
+
486
+ declare type GraphqlFieldData = {
487
+ name: string;
488
+ type: string;
489
+ description?: string | Node_2[] | Node_2;
490
+ deprecated?: boolean;
491
+ deprecationReason?: string;
492
+ defaultValue?: unknown;
493
+ args?: Array<{
494
+ name: string;
495
+ type: string;
496
+ description?: string | Node_2[] | Node_2;
497
+ deprecationReason?: string;
498
+ defaultValue?: unknown;
499
+ }>;
500
+ };
501
+
502
+ declare type GraphQLInfo = {
503
+ title?: string;
504
+ version?: string;
505
+ description?: string;
506
+ termsOfService?: string;
507
+ contact?: GraphQLContact;
508
+ license?: GraphQLLicense;
509
+ };
510
+
511
+ declare type GraphQLLicense = {
512
+ name?: string;
513
+ url?: string;
514
+ identifier?: string;
515
+ };
516
+
517
+ declare type GraphQLOperationData = {
518
+ operationType: 'query' | 'mutation' | 'subscription';
519
+ operationName: string;
520
+ typeName: string;
521
+ };
522
+
523
+ declare type GraphQLOptions = Omit<BaseRequired, 'layout'> & {
524
+ layout: LayoutVariant;
525
+ info?: GraphQLInfo;
526
+ menu?: GraphQLConfig['menu'];
527
+ };
528
+
529
+ declare type GraphQLQueryPanelItem = BaseExamplePanelItem & {
530
+ kind: typeof panelKind.GRAPHQL_QUERY;
531
+ graphqlOperationData?: GraphQLOperationData;
532
+ };
533
+
534
+ declare type GraphQLResponsePanelItem = BaseExamplePanelItem & {
535
+ kind: typeof panelKind.GRAPHQL_RESPONSE;
536
+ graphqlOperationData?: GraphQLOperationData;
537
+ };
538
+
539
+ declare type GraphqlReturnTypeData = {
540
+ type: string;
541
+ description?: string | Node_2[] | Node_2;
542
+ fields?: GraphqlFieldData[];
543
+ };
544
+
545
+ declare type GraphqlStoreMeta = {
546
+ rootTypes: {
547
+ query?: string;
548
+ mutation?: string;
549
+ subscription?: string;
550
+ };
551
+ };
552
+
553
+ declare type GraphQLTypeSamplePanelItem = BaseExamplePanelItem & {
554
+ kind: typeof panelKind.GRAPHQL_TYPE_SAMPLE;
555
+ graphqlOperationData?: GraphQLOperationData;
556
+ };
557
+
558
+ declare type GraphQLVariablesPanelItem = BaseExamplePanelItem & {
559
+ kind: typeof panelKind.GRAPHQL_VARIABLES;
560
+ graphqlOperationData?: GraphQLOperationData;
561
+ };
562
+
563
+ declare type GroupItem = {
564
+ title: string;
565
+ summary?: string;
566
+ prefix?: Badge;
567
+ badges?: Badge[];
568
+ link: string;
569
+ deprecated: boolean;
570
+ childTag?: boolean;
571
+ };
572
+
573
+ declare type GroupItemNode = MultiChildPanelBase<typeof panelKind.GROUP_ITEMS>;
574
+
575
+ declare type GroupItemsPanelItem = {
576
+ kind: typeof panelKind.GROUP_ITEMS;
577
+ title: string;
578
+ titleTranslationKey?: string;
579
+ items: GroupItem[];
580
+ };
581
+
582
+ declare type HeaderNode = {
583
+ nodeType: typeof nodeTypes.HEADER;
584
+ level: number;
585
+ label: string;
586
+ labelTranslationKey?: string;
587
+ badges?: BadgeData[];
588
+ deprecated?: boolean;
589
+ isWebhook?: boolean;
590
+ showPageActions?: boolean;
591
+ protocolTag?: {
592
+ label: string;
593
+ color?: string;
594
+ };
595
+ deepLinkSuffix?: string;
596
+ graphqlReturnType?: string;
597
+ graphqlArgs?: {
598
+ name: string;
599
+ }[];
600
+ graphqlDeprecated?: boolean;
601
+ graphqlOperationType?: 'query' | 'mutation' | 'subscription';
602
+ };
603
+
604
+ /**
605
+ * Attaches to server-rendered markup instead of replacing it. The spec must be
606
+ * the same pre-bundled document the server pass rendered from.
607
+ */
608
+ export declare function hydrate(specOrSpecUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): Promise<void>;
609
+
610
+ declare type InfoMetadataNode = {
611
+ nodeType: typeof nodeTypes.INFO_METADATA;
612
+ rows: InfoMetadataRow[];
613
+ };
614
+
615
+ declare type InfoMetadataRow = {
616
+ key: string;
617
+ value: string;
618
+ };
619
+
620
+ export declare function init(specOrSpecUrl: string | Record<string, unknown>, options?: InitOptions, element?: Element | null): Root;
621
+
622
+ export declare type InitOptions = NonNullable<RedocStandaloneProps['options']> & {
623
+ router?: 'hash' | 'history';
624
+ disableTelemetry?: boolean;
625
+ /** The Docker image sets `type-of-usage="docker"` on the `<redoc>` element. */
626
+ typeOfUsage?: TypeOfUsage;
627
+ basePath?: string;
628
+ };
629
+
630
+ declare type ItemContentNode = {
631
+ nodeType: typeof nodeTypes.ITEM;
632
+ variant: 'headers' | 'query' | 'querystring' | 'querystring-body' | 'path' | 'parameters' | 'cookies' | 'body' | 'properties' | 'arguments' | 'fields' | 'responses' | 'callback' | 'messages' | 'values' | 'graphql-fields' | 'graphql-args' | 'return-type' | 'possible-types' | 'implements' | 'implemented-by' | 'requires-scopes';
633
+ label?: string;
634
+ labelTranslationKey?: string;
635
+ schemaId?: string;
636
+ exampleIds?: string[];
637
+ parameters?: ParameterData[];
638
+ graphqlSchema?: GraphqlFieldData[] | GraphqlReturnTypeData;
639
+ required?: boolean;
640
+ /** Webhook/callback body: the server sends it, so readOnly stays and writeOnly is dropped. */
641
+ isEvent?: boolean;
642
+ mediaTypes?: string[];
643
+ mediaTypeSchemas?: Record<string, MediaTypeContent>;
644
+ pointer?: string;
645
+ description?: string | Node_2 | Node_2[];
646
+ graphqlTypeName?: string;
647
+ graphqlFieldName?: string;
648
+ graphqlOperationType?: 'query' | 'mutation' | 'subscription';
649
+ graphqlInterfaceNames?: string[];
650
+ graphqlTypeNames?: string[];
651
+ responses?: Array<{
652
+ code: string;
653
+ summary?: string | Node_2[] | Node_2;
654
+ description?: string | Node_2[] | Node_2;
655
+ mediaType?: string;
656
+ mediaTypes?: string[];
657
+ mediaTypeContent?: Record<string, MediaTypeContent>;
658
+ schemaId?: string;
659
+ exampleIds?: string[];
660
+ headers?: OpenAPIResponse['headers'];
661
+ headerSchemaId?: string;
662
+ }>;
663
+ callback?: {
664
+ httpVerb: string;
665
+ pathName: string;
666
+ summary?: string;
667
+ operationId?: string;
668
+ description?: string | Node_2 | Node_2[];
669
+ deprecated?: boolean;
670
+ callbackName: string;
671
+ callbackId: string;
672
+ externalDocs?: {
673
+ url: string;
674
+ description?: string;
675
+ };
676
+ extensions?: Record<string, unknown>;
677
+ contentChildren?: ContentNode[];
678
+ };
679
+ messages?: Array<{
680
+ name: string;
681
+ label: string;
682
+ summary?: string;
683
+ description?: string | Node_2[] | Node_2;
684
+ contentType?: string;
685
+ schemaId?: string;
686
+ headerSchemaId?: string;
687
+ exampleIds?: string[];
688
+ payload?: AsyncAPISchema;
689
+ payloadLabel?: string;
690
+ headers?: AsyncAPISchema;
691
+ externalDocs?: {
692
+ url: string;
693
+ description?: string | Node_2[] | Node_2;
694
+ };
695
+ }>;
696
+ values?: Array<{
697
+ name: string;
698
+ description?: string | Node_2[] | Node_2;
699
+ deprecated?: boolean;
700
+ type?: string;
701
+ }>;
702
+ };
703
+
704
+ declare type ItemMeta = {
705
+ sourceId?: string;
706
+ name?: string;
707
+ deprecated?: boolean;
708
+ isWebhook?: boolean;
709
+ hasSamples?: boolean;
710
+ badges?: BadgeData[];
711
+ pointer?: string;
712
+ position?: {
713
+ start: {
714
+ lineNumber: number;
715
+ column: number;
716
+ };
717
+ end?: {
718
+ lineNumber: number;
719
+ column: number;
720
+ };
721
+ };
722
+ protocolTag?: {
723
+ label: string;
724
+ color: string;
725
+ };
726
+ breadcrumbs?: BreadcrumbItem[];
727
+ action?: 'send' | 'receive';
728
+ actionLabel?: string;
729
+ channelBindings?: Record<string, unknown>;
730
+ returnType?: string;
731
+ };
732
+
733
+ declare type ItemVariant = ObjectValues<typeof itemVariant>;
734
+
735
+ declare const itemVariant: {
736
+ readonly HTTP_ITEM: 'httpItem';
737
+ readonly SCHEMA: 'schema';
738
+ readonly CHANNEL: 'channel';
739
+ readonly CHANNEL_OPERATION: 'channelOperation';
740
+ readonly MESSAGE: 'message';
741
+ readonly QUERY: 'query';
742
+ readonly MUTATION: 'mutation';
743
+ readonly SUBSCRIPTION: 'subscription';
744
+ readonly DIRECTIVE: 'directive';
745
+ readonly OBJECT: 'object';
746
+ readonly INTERFACE: 'interface';
747
+ readonly INPUT: 'input';
748
+ readonly UNION: 'union';
749
+ readonly ENUM: 'enum';
750
+ readonly SCALAR: 'scalar';
751
+ readonly MARKDOWN: 'markdown';
752
+ };
753
+
754
+ declare type KeyValuePanelItem = {
755
+ kind: typeof panelKind.ATTRIBUTE;
756
+ title?: string;
757
+ titleTranslationKey?: string;
758
+ label: string;
759
+ labelTranslationKey?: string;
760
+ value: string;
761
+ withCopyButton?: boolean;
762
+ copyContent?: string;
763
+ };
764
+
765
+ declare type LocationsPanelItem = {
766
+ kind: typeof panelKind.LOCATIONS;
767
+ locations: string[];
768
+ };
769
+
770
+ declare type LocationsPanelNode = SingleChildPanelBase<typeof panelKind.LOCATIONS>;
771
+
772
+ declare type MarkdocNode = {
773
+ nodeType: typeof nodeTypes.MARKDOC;
774
+ content: string | Node_2[] | Node_2;
775
+ };
776
+
777
+ declare type MarkdownAdapter = {
778
+ parse: (source: unknown) => unknown;
779
+ render: MarkdownRenderer;
780
+ };
781
+
782
+ /**
783
+ * Turns a raw markdown string into an AST. api-docs core does not bundle a markdown engine — the
784
+ * host supplies the parser (the standalone build supplies a Markdoc-based one; see
785
+ * `markdocParser`). It is the single seam where markdown text becomes an AST.
786
+ */
787
+ declare type MarkdownParser = (markdown: string, sanitizeOptions?: {
788
+ sanitize?: ApiDocsOptions['sanitize'];
789
+ }) => Node_2 | Node_2[] | undefined;
790
+
791
+ /**
792
+ * Host-provided markdown handling. api-docs core does not bundle a markdown engine — embedders
793
+ * supply an adapter so they own how descriptions become React:
794
+ * - `parse` normalizes a source — a raw markdown string, or an already-parsed AST — into whatever
795
+ * `render` consumes. It is opaque to api-docs. Item descriptions are parsed at build, so they
796
+ * reach `parse` as ASTs; the lazily-rendered schema descriptions reach it as raw strings.
797
+ * - `render` turns the parsed value into React.
798
+ *
799
+ * The standalone build supplies a Markdoc-based adapter (`createMarkdocAdapter`). Embedders that
800
+ * pre-parse upstream (e.g. realm) supply a `parse` no-op plus their own `render`, so the Markdoc
801
+ * parser never enters their client bundle.
802
+ */
803
+ declare type MarkdownRenderer = (parsed: unknown) => ReactNode;
804
+
805
+ declare type McpData = {
806
+ tools?: McpTool[];
807
+ resources?: McpResource[];
808
+ prompts?: McpPrompt[];
809
+ };
810
+
811
+ declare type McpExampleNode = SingleChildPanelBase<typeof panelKind.MCP_EXAMPLE>;
812
+
813
+ declare type McpExamplePanelItem = {
814
+ kind: typeof panelKind.MCP_EXAMPLE;
815
+ headerTitleTranslationKey: string;
816
+ data: unknown;
817
+ language?: string;
818
+ };
819
+
820
+ declare type McpNode = MultiChildPanelBase<typeof panelKind.ATTRIBUTE | typeof panelKind.TAGS | typeof panelKind.EXTERNAL_LINK | typeof panelKind.CONNECT_MCP_BUTTON>;
821
+
822
+ declare type McpPanelItem = KeyValuePanelItem | TagsPanelItem | ExternalLinkPanelItem | ConnectMcpButtonPanelItem;
823
+
824
+ declare type McpPrompt = {
825
+ name: string;
826
+ title?: string;
827
+ description: string | Node_2[] | Node_2;
828
+ arguments: McpPromptArgument[];
829
+ security?: OpenAPISecurityRequirement[];
830
+ tags?: string[];
831
+ 'x-badges'?: OpenAPIXBadges[];
832
+ };
833
+
834
+ declare type McpPromptArgument = {
835
+ name: string;
836
+ description: string | Node_2[] | Node_2;
837
+ required: boolean;
838
+ example?: string;
839
+ };
840
+
841
+ declare type McpResource = {
842
+ name: string;
843
+ title?: string;
844
+ description?: string | Node_2[] | Node_2;
845
+ uri: string;
846
+ mimeType: string;
847
+ blob?: string;
848
+ text?: string;
849
+ security?: OpenAPISecurityRequirement[];
850
+ tags?: string[];
851
+ 'x-badges'?: OpenAPIXBadges[];
852
+ };
853
+
854
+ declare type McpTool = {
855
+ name: string;
856
+ title?: string;
857
+ description?: string | Node_2[] | Node_2;
858
+ inputSchema: OpenAPISchema;
859
+ outputSchema?: OpenAPISchema;
860
+ security?: OpenAPISecurityRequirement[];
861
+ tags?: string[];
862
+ 'x-badges'?: OpenAPIXBadges[];
863
+ };
864
+
865
+ declare type MediaTypeContent = {
866
+ schemaId?: string;
867
+ exampleIds?: string[];
868
+ };
869
+
870
+ declare type MediaTypeEntry = {
871
+ schemaId?: string;
872
+ exampleIds?: string[];
873
+ };
874
+
875
+ declare type MessageBindingData = {
876
+ bindingKey: string;
877
+ bindingValue: Record<string, unknown>;
878
+ keySchemaId?: string;
879
+ };
880
+
881
+ declare type MessageBindingNode = SingleChildPanelBase<typeof panelKind.MESSAGE_BINDING>;
882
+
883
+ declare type MessageBindingPanelItem = {
884
+ kind: typeof panelKind.MESSAGE_BINDING;
885
+ panelLabel?: string;
886
+ bindingsByMessageKey: Record<string, MessageBindingData>;
887
+ };
888
+
889
+ declare type MessageChannelReference = {
890
+ key: string;
891
+ label: string;
892
+ link: string;
893
+ };
894
+
895
+ declare type MessageLinksNode = {
896
+ nodeType: typeof nodeTypes.MESSAGE_LINKS;
897
+ channelLink: string;
898
+ messages: Array<{
899
+ name: string;
900
+ label: string;
901
+ }>;
902
+ };
903
+
904
+ declare type MessageReferencesGroups = {
905
+ exchanges: MessageChannelReference[];
906
+ queues: MessageChannelReference[];
907
+ };
908
+
909
+ declare type MessageReferencesNode = SingleChildPanelBase<typeof panelKind.MESSAGE_REFERENCES>;
910
+
911
+ declare type MessageReferencesPanelItem = {
912
+ kind: typeof panelKind.MESSAGE_REFERENCES;
913
+ panelLabel?: string;
914
+ referencesByMessageKey: Record<string, MessageReferencesGroups>;
915
+ };
916
+
917
+ declare type MultiChildPanelBase<TKind extends PanelItem['kind']> = {
918
+ title?: string;
919
+ titleTranslationKey?: string;
920
+ children: PanelItemsByKind<TKind>[];
921
+ };
922
+
923
+ declare type MultiFormatSchemaObject = {
924
+ schema: JSONSchema7 | AvroSchema;
925
+ schemaFormat: string;
926
+ };
927
+
928
+ declare const nodeTypes: {
929
+ readonly CONTAINER: 'container';
930
+ readonly HEADER: 'header';
931
+ readonly EMPTY_MESSAGE: 'empty-message';
932
+ readonly ITEM: 'item-content';
933
+ readonly SECURITY: 'security';
934
+ readonly MARKDOC: 'markdoc';
935
+ readonly ADMONITION: 'admonition';
936
+ readonly OVERVIEW_SECTION_WRAPPER: 'overview-section-wrapper';
937
+ readonly EXTERNAL_DOCS: 'external-docs';
938
+ readonly CHANNEL_ADDRESS: 'channel-address';
939
+ readonly MESSAGE_LINKS: 'message-links';
940
+ readonly INFO_METADATA: 'info-metadata';
941
+ readonly EXTENSIONS: 'extensions';
942
+ };
943
+
944
+ declare type NormalizedDownloadUrl = DownloadUrl & {
945
+ title: string;
946
+ };
947
+
948
+ declare type OAuthFlowsData = {
949
+ implicit?: {
950
+ authorizationUrl?: string;
951
+ refreshUrl?: string;
952
+ scopes: Record<string, string>;
953
+ };
954
+ password?: {
955
+ tokenUrl: string;
956
+ refreshUrl?: string;
957
+ scopes: Record<string, string>;
958
+ };
959
+ clientCredentials?: {
960
+ tokenUrl: string;
961
+ refreshUrl?: string;
962
+ scopes: Record<string, string>;
963
+ };
964
+ authorizationCode?: {
965
+ authorizationUrl: string;
966
+ tokenUrl: string;
967
+ refreshUrl?: string;
968
+ scopes: Record<string, string>;
969
+ 'x-usePkce'?: boolean;
970
+ };
971
+ deviceAuthorization?: {
972
+ deviceAuthorizationUrl: string;
973
+ tokenUrl: string;
974
+ refreshUrl?: string;
975
+ scopes: Record<string, string>;
976
+ 'x-defaultClientId'?: string;
977
+ };
978
+ };
979
+
980
+ declare type ObjectValues<T> = T[keyof T];
981
+
982
+ declare type OpenAPIDiscriminator = {
983
+ propertyName: string;
984
+ mapping?: {
985
+ [name: string]: string;
986
+ };
987
+ 'x-explicitMappingOnly'?: boolean;
988
+ defaultMapping?: string;
989
+ };
990
+
991
+ declare type OpenAPIEncoding = {
992
+ contentType: string;
993
+ headers?: {
994
+ [name: string]: Referenced<OpenAPIHeader>;
995
+ };
996
+ style: OpenAPIParameterStyle;
997
+ explode: boolean;
998
+ allowReserved: boolean;
999
+ };
1000
+
1001
+ declare type OpenAPIExample = {
1002
+ value?: unknown;
1003
+ dataValue?: unknown;
1004
+ serializedValue?: string;
1005
+ summary?: string;
1006
+ description?: string | Node_2[] | Node_2;
1007
+ externalValue?: string;
1008
+ };
1009
+
1010
+ declare type OpenAPIExternalDocumentation = {
1011
+ description?: string | Node_2[] | Node_2;
1012
+ url: string;
1013
+ };
1014
+
1015
+ declare type OpenAPIHeader = Omit<OpenAPIParameter, 'in' | 'name'>;
1016
+
1017
+ declare type OpenAPILink = {
1018
+ $ref?: string;
1019
+ };
1020
+
1021
+ declare type OpenAPIMediaType = {
1022
+ schema?: Referenced<OpenAPISchema>;
1023
+ itemSchema?: Referenced<OpenAPISchema>;
1024
+ example?: unknown;
1025
+ examples?: {
1026
+ [name: string]: Referenced<OpenAPIExample>;
1027
+ };
1028
+ encoding?: {
1029
+ [field: string]: OpenAPIEncoding;
1030
+ };
1031
+ };
1032
+
1033
+ declare type OpenAPIParameter = {
1034
+ name: string;
1035
+ in?: OpenAPIParameterLocation;
1036
+ description?: string | Node_2[] | Node_2;
1037
+ required?: boolean;
1038
+ deprecated?: boolean;
1039
+ allowEmptyValue?: boolean;
1040
+ style?: OpenAPIParameterStyle;
1041
+ explode?: boolean;
1042
+ allowReserved?: boolean;
1043
+ schema?: Referenced<OpenAPISchema>;
1044
+ example?: unknown;
1045
+ examples?: {
1046
+ [media: string]: Referenced<OpenAPIExample>;
1047
+ };
1048
+ content?: {
1049
+ [media: string]: OpenAPIMediaType;
1050
+ };
1051
+ encoding?: Record<string, OpenAPIEncoding>;
1052
+ const?: unknown;
1053
+ };
1054
+
1055
+ declare type OpenAPIParameterLocation = ObjectValues<typeof parameterLocation>;
1056
+
1057
+ declare type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
1058
+
1059
+ declare type OpenAPIRef = {
1060
+ $ref: string;
1061
+ 'x-refsStack'?: string[];
1062
+ summary?: string;
1063
+ description?: string | Node_2[] | Node_2;
1064
+ };
1065
+
1066
+ declare type OpenAPIResponse = {
1067
+ description?: string | Node_2[] | Node_2;
1068
+ headers?: {
1069
+ [name: string]: Referenced<OpenAPIHeader>;
1070
+ };
1071
+ content?: {
1072
+ [mime: string]: OpenAPIMediaType;
1073
+ };
1074
+ links?: {
1075
+ [name: string]: Referenced<OpenAPILink>;
1076
+ };
1077
+ $ref?: string;
1078
+ 'x-examples'?: {
1079
+ [mime: string]: {
1080
+ [name: string]: Referenced<OpenAPIExample>;
1081
+ };
1082
+ };
1083
+ 'x-example'?: {
1084
+ [mime: string]: unknown;
1085
+ };
1086
+ 'x-summary'?: string;
1087
+ };
1088
+
1089
+ declare type OpenAPISchema = {
1090
+ $ref?: string;
1091
+ type?: string | string[];
1092
+ properties?: {
1093
+ [name: string]: OpenAPISchema;
1094
+ };
1095
+ patternProperties?: {
1096
+ [name: string]: OpenAPISchema;
1097
+ };
1098
+ additionalProperties?: boolean | OpenAPISchema;
1099
+ unevaluatedProperties?: boolean | OpenAPISchema;
1100
+ description?: string | Node_2[] | Node_2;
1101
+ default?: unknown;
1102
+ items?: OpenAPISchema | OpenAPISchema[] | boolean;
1103
+ required?: string[];
1104
+ readOnly?: boolean;
1105
+ writeOnly?: boolean;
1106
+ deprecated?: boolean;
1107
+ format?: string;
1108
+ externalDocs?: OpenAPIExternalDocumentation;
1109
+ discriminator?: OpenAPIDiscriminator;
1110
+ nullable?: boolean;
1111
+ oneOf?: OpenAPISchema[];
1112
+ anyOf?: OpenAPISchema[];
1113
+ allOf?: OpenAPISchema[];
1114
+ not?: OpenAPISchema;
1115
+ title?: string;
1116
+ multipleOf?: number;
1117
+ maximum?: number;
1118
+ exclusiveMaximum?: boolean | number;
1119
+ minimum?: number;
1120
+ exclusiveMinimum?: boolean | number;
1121
+ maxLength?: number;
1122
+ minLength?: number;
1123
+ pattern?: string;
1124
+ maxItems?: number;
1125
+ minItems?: number;
1126
+ uniqueItems?: boolean;
1127
+ maxProperties?: number;
1128
+ minProperties?: number;
1129
+ enum?: unknown[];
1130
+ example?: unknown;
1131
+ examples?: unknown[] | Record<string, ExampleType>;
1132
+ const?: string;
1133
+ contentEncoding?: string;
1134
+ contentMediaType?: string;
1135
+ if?: OpenAPISchema;
1136
+ else?: OpenAPISchema;
1137
+ then?: OpenAPISchema;
1138
+ prefixItems?: OpenAPISchema[];
1139
+ additionalItems?: OpenAPISchema | boolean;
1140
+ xml?: XMLObject;
1141
+ };
1142
+
1143
+ declare type OpenAPISecurityRequirement = {
1144
+ [name: string]: string[];
1145
+ };
1146
+
1147
+ declare type OpenAPIXBadges = {
1148
+ name: string;
1149
+ color?: string;
1150
+ position?: 'before' | 'after';
1151
+ icon?: string;
1152
+ description?: string;
1153
+ };
1154
+
1155
+ declare type OperationBindingNode = SingleChildPanelBase<typeof panelKind.OPERATION_BINDING>;
1156
+
1157
+ declare type OperationBindingPanelItem = {
1158
+ kind: typeof panelKind.OPERATION_BINDING;
1159
+ panelLabel?: string;
1160
+ bindingKey: string;
1161
+ bindingValue: Record<string, unknown>;
1162
+ groupIdSchemaId?: string;
1163
+ clientIdSchemaId?: string;
1164
+ };
1165
+
1166
+ declare type OverviewNode = MultiChildPanelBase<typeof panelKind.EXTERNAL_LINK | typeof panelKind.EMAIL | typeof panelKind.ATTRIBUTE>;
1167
+
1168
+ declare type OverviewPanelItem = ExternalLinkPanelItem | EmailPanelItem | KeyValuePanelItem;
1169
+
1170
+ declare type OverviewSectionWrapperNode = {
1171
+ nodeType: typeof nodeTypes.OVERVIEW_SECTION_WRAPPER;
1172
+ children: ContentNode[];
1173
+ sectionId: string;
1174
+ };
1175
+
1176
+ declare type PanelItem = DownloadPanelItem | OverviewPanelItem | ServersPanelItem | BrokersPanelItem | ChannelBindingPanelItem | OperationBindingPanelItem | MessageBindingPanelItem | MessageReferencesPanelItem | McpPanelItem | McpExamplePanelItem | ExamplePanelItem | ReferencesPanelItem | LocationsPanelItem | GroupItemsPanelItem;
1177
+
1178
+ declare type PanelItemsByKind<TKind extends PanelItem['kind']> = Extract<PanelItem, {
1179
+ kind: TKind;
1180
+ }>;
1181
+
1182
+ declare const panelKind: {
1183
+ readonly LOCATIONS: 'locations';
1184
+ readonly GROUP_ITEMS: 'group-items';
1185
+ readonly EXTERNAL_LINK: 'externallink';
1186
+ readonly EMAIL: 'email';
1187
+ readonly PAYLOAD: 'payload';
1188
+ readonly TAGS: 'tags';
1189
+ readonly CONNECT_MCP_BUTTON: 'connect-mcp-button';
1190
+ readonly ATTRIBUTE: 'attribute';
1191
+ readonly DOWNLOAD: 'download';
1192
+ readonly SERVERS: 'servers';
1193
+ readonly BROKERS: 'brokers';
1194
+ readonly CHANNEL_BINDING: 'channel-binding';
1195
+ readonly OPERATION_BINDING: 'operation-binding';
1196
+ readonly MESSAGE_BINDING: 'message-binding';
1197
+ readonly MESSAGE_REFERENCES: 'message-references';
1198
+ readonly REFERENCES: 'references';
1199
+ readonly CODE_SAMPLE: 'code-sample';
1200
+ readonly CALLBACK_PAYLOAD: 'callback-payload';
1201
+ readonly RESPONSE: 'response';
1202
+ readonly GRAPHQL_QUERY: 'graphql-query';
1203
+ readonly GRAPHQL_RESPONSE: 'graphql-response';
1204
+ readonly GRAPHQL_VARIABLES: 'graphql-variables';
1205
+ readonly GRAPHQL_TYPE_SAMPLE: 'graphql-type-sample';
1206
+ readonly MCP_EXAMPLE: 'mcp-example';
1207
+ };
1208
+
1209
+ declare type PanelNode = DownloadNode | ServersNode | BrokersNode | ChannelBindingNode | OperationBindingNode | MessageBindingNode | MessageReferencesNode | OverviewNode | McpNode | ExamplesNode | McpExampleNode | ReferencesNode | LocationsPanelNode | GroupItemNode;
1210
+
1211
+ declare type PanelTag = {
1212
+ text: string;
1213
+ color?: string;
1214
+ icon?: string;
1215
+ };
1216
+
1217
+ declare type PanelToggleEvent = AnalyticsEvent & {
1218
+ panelType: PanelType;
1219
+ state: 'expanded' | 'collapsed';
1220
+ operationId: string;
1221
+ operationPath: string;
1222
+ operationHttpVerb: string;
1223
+ operationSummary?: string | Record<string, unknown>;
1224
+ };
1225
+
1226
+ declare type PanelType = 'request' | 'responses' | 'request-samples' | 'response-samples';
1227
+
1228
+ declare type ParameterData = {
1229
+ name: string;
1230
+ in?: string;
1231
+ schemaId: string;
1232
+ description?: string | Node_2 | Node_2[];
1233
+ required?: boolean;
1234
+ deprecated?: boolean;
1235
+ example?: unknown;
1236
+ examples?: Record<string, ExampleType>;
1237
+ badges?: BadgeType[];
1238
+ extensions?: Record<string, unknown>;
1239
+ };
1240
+
1241
+ declare type ParameterEntry = {
1242
+ name: string;
1243
+ in: OpenAPIParameterLocation;
1244
+ required?: boolean;
1245
+ deprecated?: boolean;
1246
+ example?: unknown;
1247
+ schemaId?: string;
1248
+ serializationMime?: string;
1249
+ style?: string;
1250
+ explode?: boolean;
1251
+ allowReserved?: boolean;
1252
+ /** Per-server example overrides: serverUrl → example value */
1253
+ serverValues?: Record<string, {
1254
+ example?: unknown;
1255
+ }>;
1256
+ };
1257
+
1258
+ declare const parameterLocation: {
1259
+ readonly QUERY: 'query';
1260
+ readonly HEADER: 'header';
1261
+ readonly PATH: 'path';
1262
+ readonly COOKIE: 'cookie';
1263
+ readonly QUERYSTRING: 'querystring';
1264
+ };
1265
+
1266
+ declare type PayloadExamplesPanelItem = BaseExamplePanelItem & {
1267
+ kind: typeof panelKind.PAYLOAD;
1268
+ panelLabel?: string;
1269
+ exampleIds?: string[];
1270
+ mediaTypes?: string[];
1271
+ mediaTypeSchemas?: Record<string, MediaTypeContent>;
1272
+ messagesByKey?: Record<string, {
1273
+ schemaId?: string;
1274
+ exampleIds?: string[];
1275
+ }>;
1276
+ };
1277
+
1278
+ declare type ProtocolVariant = ObjectValues<typeof CONST_PROTOCOL_VARIANT>;
1279
+
1280
+ declare type RawApiDocsOptions = EditionRedocConfig & EditionAsyncApiConfig & EditionGraphQLConfig & {
1281
+ specType: ApiSpecType;
1282
+ markdownParser: MarkdownParser;
1283
+ basePath?: string;
1284
+ hideSchemaPattern?: boolean;
1285
+ disableTelemetry?: boolean;
1286
+ requiredPropsFirst?: boolean;
1287
+ protocol?: ProtocolVariant;
1288
+ dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
1289
+ layout?: EditionRedocConfig['layout'] | EditionAsyncApiConfig['layout'] | EditionGraphQLConfig['layout'];
1290
+ };
1291
+
1292
+ /** A logo as authored, keyed by `url`: OpenAPI `info.x-logo` and the standalone `logo` prop. */
1293
+ declare type RawLogo = {
1294
+ url?: string;
1295
+ href?: string;
1296
+ altText?: string;
1297
+ backgroundColor?: string;
1298
+ };
1299
+
1300
+ declare type RedoclyApiDocsStandaloneProps = {
1301
+ items: ApiItem[];
1302
+ store: ApiStore;
1303
+ basePath: string;
1304
+ options: RawApiDocsOptions;
1305
+ logo?: RawLogo;
1306
+ telemetryConfig?: Partial<RedocTelemetryConfig>;
1307
+ markdownAdapter?: MarkdownAdapter;
1308
+ spec?: Record<string, unknown> | string;
1309
+ specUrl?: string;
1310
+ buildTimings?: BuildTimings;
1311
+ };
1312
+
1313
+ /** Loads and bundles the spec, builds the item model, and renders `RedoclyApiDocsStandalone`. */
1314
+ export declare const RedocStandalone: ({ spec, specUrl, options, basePath, logo, markdownAdapter, onLoaded, children, }: RedocStandaloneProps) => ReactElement | null;
1315
+
1316
+ export declare type RedocStandaloneProps = {
1317
+ /** Parsed API description object, or a GraphQL SDL string. */
1318
+ spec?: Record<string, unknown> | string;
1319
+ /** URL of the API description. Ignored when `spec` is provided. */
1320
+ specUrl?: string;
1321
+ options?: Partial<RawApiDocsOptions>;
1322
+ basePath?: string;
1323
+ logo?: RedoclyApiDocsStandaloneProps['logo'];
1324
+ markdownAdapter?: MarkdownAdapter;
1325
+ onLoaded?: (error?: Error) => void;
1326
+ /** Rendered while the spec is loading. */
1327
+ children?: ReactNode;
1328
+ };
1329
+
1330
+ declare interface RedocTelemetryConfig {
1331
+ specType?: SpecType;
1332
+ collectorUrl?: string;
1333
+ serviceName?: string;
1334
+ disabled?: boolean;
1335
+ serviceVersion?: string;
1336
+ typeOfUsage?: TypeOfUsage;
1337
+ beforeSend?: BeforeSend;
1338
+ }
1339
+
1340
+ declare type Referenced<T> = T | OpenAPIRef;
1341
+
1342
+ declare type ReferencesNode = SingleChildPanelBase<typeof panelKind.REFERENCES>;
1343
+
1344
+ declare type ReferencesPanelItem = {
1345
+ kind: typeof panelKind.REFERENCES;
1346
+ graphqlTypeName?: string;
1347
+ references: {
1348
+ name: string;
1349
+ pointer: string;
1350
+ field?: string;
1351
+ }[];
1352
+ };
1353
+
1354
+ declare type ResponseCodeEntry = {
1355
+ code: string;
1356
+ schemaId?: string;
1357
+ exampleIds?: string[];
1358
+ mediaTypes?: string[];
1359
+ mediaTypeContent?: Record<string, MediaTypeContent>;
1360
+ };
1361
+
1362
+ declare type ResponseExamplesPanelItem = BaseExamplePanelItem & {
1363
+ kind: typeof panelKind.RESPONSE;
1364
+ exampleIds?: string[];
1365
+ responseCodes?: ResponseCodeEntry[];
1366
+ /** Webhook response: the client sends it, so samples drop readOnly like a request. */
1367
+ isEvent?: boolean;
1368
+ hideHeaderTitle?: boolean;
1369
+ exampleKey?: string;
1370
+ };
1371
+
1372
+ declare type SchemaEntry = {
1373
+ id: string;
1374
+ kind: SchemaKind;
1375
+ title?: string;
1376
+ data: Record<string, unknown>;
1377
+ };
1378
+
1379
+ declare type SchemaKind = ObjectValues<typeof schemaKind>;
1380
+
1381
+ declare const schemaKind: {
1382
+ readonly JSON_SCHEMA: 'json-schema';
1383
+ readonly GRAPHQL_TYPE: 'graphql-type';
1384
+ };
1385
+
1386
+ declare type SecurityNode = {
1387
+ nodeType: typeof nodeTypes.SECURITY;
1388
+ requirements: Array<{
1389
+ schemes: SecuritySchemeDetail[];
1390
+ }>;
1391
+ };
1392
+
1393
+ /** One AND-group: all schemes in the array must be satisfied together */
1394
+ declare type SecurityRequirement = {
1395
+ schemes: SecuritySchemeEntry[];
1396
+ scopes: string[];
1397
+ };
1398
+
1399
+ declare type SecuritySchemeCredentials = {
1400
+ 'x-defaultAccessToken'?: string;
1401
+ 'x-defaultTokenType'?: string;
1402
+ 'x-defaultClientId'?: string;
1403
+ 'x-defaultClientSecret'?: string;
1404
+ 'x-defaultUsername'?: string;
1405
+ 'x-defaultPassword'?: string;
1406
+ scopes?: string[];
1407
+ };
1408
+
1409
+ declare type SecuritySchemeDetail = {
1410
+ name: string;
1411
+ type?: string;
1412
+ scheme?: string;
1413
+ bearerFormat?: string;
1414
+ in?: string;
1415
+ paramName?: string;
1416
+ scopes?: string[];
1417
+ description?: string | Node_2[] | Node_2;
1418
+ openIdConnectUrl?: string;
1419
+ oauth2MetadataUrl?: string;
1420
+ flows?: SecuritySchemeEntry_2['flows'];
1421
+ deprecated?: boolean;
1422
+ };
1423
+
1424
+ declare type SecuritySchemeEntry = {
1425
+ id: string;
1426
+ type: Exclude<SecuritySchemeType, typeof securitySchemeType.MUTUAL_TLS>;
1427
+ name?: string;
1428
+ in?: SecuritySchemeIn;
1429
+ scheme?: string;
1430
+ bearerFormat?: string;
1431
+ openIdConnectUrl?: string;
1432
+ flows?: OAuthFlowsData;
1433
+ 'x-defaultAccessToken'?: string;
1434
+ 'x-defaultTokenType'?: string;
1435
+ 'x-defaultClientId'?: string;
1436
+ 'x-defaultClientSecret'?: string;
1437
+ 'x-defaultUsername'?: string;
1438
+ 'x-defaultPassword'?: string;
1439
+ /** Per-server auth overrides */
1440
+ serverValues?: Record<string, SecuritySchemeCredentials>;
1441
+ };
1442
+
1443
+ declare type SecuritySchemeEntry_2 = {
1444
+ id: string;
1445
+ type: SecuritySchemeType;
1446
+ scheme?: string;
1447
+ bearerFormat?: string;
1448
+ description?: string | Node_2[] | Node_2;
1449
+ in?: SecuritySchemeIn;
1450
+ paramName?: string;
1451
+ openIdConnectUrl?: string;
1452
+ deprecated?: boolean;
1453
+ oauth2MetadataUrl?: string;
1454
+ 'x-defaultClientId'?: string;
1455
+ 'x-defaultAccessToken'?: string;
1456
+ 'x-defaultTokenType'?: string;
1457
+ 'x-defaultClientSecret'?: string;
1458
+ 'x-defaultUsername'?: string;
1459
+ 'x-defaultPassword'?: string;
1460
+ serverValues?: Record<string, SecuritySchemeCredentials>;
1461
+ flows?: OAuthFlowsData;
1462
+ };
1463
+
1464
+ declare type SecuritySchemeIn = ObjectValues<typeof securitySchemeIn>;
1465
+
1466
+ declare const securitySchemeIn: {
1467
+ readonly QUERY: 'query';
1468
+ readonly HEADER: 'header';
1469
+ readonly COOKIE: 'cookie';
1470
+ readonly QUERYSTRING: 'querystring';
1471
+ };
1472
+
1473
+ declare type SecuritySchemeType = ObjectValues<typeof securitySchemeType>;
1474
+
1475
+ declare const securitySchemeType: {
1476
+ readonly API_KEY: 'apiKey';
1477
+ readonly HTTP: 'http';
1478
+ readonly OAUTH2: 'oauth2';
1479
+ readonly OPEN_ID_CONNECT: 'openIdConnect';
1480
+ readonly MUTUAL_TLS: 'mutualTLS';
1481
+ };
1482
+
1483
+ declare type SeoData = {
1484
+ title?: string;
1485
+ description?: string;
1486
+ keywords?: string;
1487
+ image?: string;
1488
+ };
1489
+
1490
+ declare type ServerData = {
1491
+ url: string;
1492
+ name?: string;
1493
+ description?: string;
1494
+ variables?: Record<string, {
1495
+ enum?: string[];
1496
+ default: string;
1497
+ description?: string | Node_2[] | Node_2;
1498
+ examples?: string[];
1499
+ }>;
1500
+ };
1501
+
1502
+ declare type ServerEntry = {
1503
+ url: string;
1504
+ name?: string;
1505
+ description?: string;
1506
+ variables?: Record<string, ServerVariable>;
1507
+ /** Set on entries injected by `mergeInMockServer` (never present in specs). */
1508
+ isMockServer?: boolean;
1509
+ };
1510
+
1511
+ declare type ServersNode = SingleChildPanelBase<typeof panelKind.SERVERS>;
1512
+
1513
+ declare type ServersPanelItem = {
1514
+ kind: typeof panelKind.SERVERS;
1515
+ servers: ServerData[];
1516
+ mode?: string;
1517
+ };
1518
+
1519
+ declare type ServerVariable = {
1520
+ default?: string;
1521
+ enum?: string[];
1522
+ description?: string;
1523
+ };
1524
+
1525
+ /**
1526
+ * A logo normalized to what the `SidebarLogo` component renders, keyed by `imageUrl`.
1527
+ * Also the shape of the `apiLogo` option, which is authored this way already.
1528
+ */
1529
+ declare type SidebarLogo = {
1530
+ imageUrl?: string;
1531
+ href?: string;
1532
+ altText?: string;
1533
+ backgroundColor?: string;
1534
+ };
1535
+
1536
+ declare type SingleChildPanelBase<TKind extends PanelItem['kind']> = {
1537
+ title?: string;
1538
+ titleTranslationKey?: string;
1539
+ children: [PanelItemsByKind<TKind>];
1540
+ };
1541
+
1542
+ declare type SpecType = 'openapi' | 'asyncapi' | 'graphql';
1543
+
1544
+ declare type TagsPanelItem = {
1545
+ kind: typeof panelKind.TAGS;
1546
+ title?: string;
1547
+ titleTranslationKey?: string;
1548
+ tags: PanelTag[];
1549
+ };
1550
+
1551
+ declare type TargetServerSwitchedEvent = AnalyticsEvent & {
1552
+ serverUrl: string;
1553
+ };
1554
+
1555
+ declare type TypeOfUsage = 'html' | 'cli' | 'react' | 'init' | 'docker';
1556
+
1557
+ declare type WithRequired<T, K extends keyof T> = T & {
1558
+ [P in K]-?: T[P];
1559
+ };
1560
+
1561
+ declare type XMLNodeType = 'element' | 'attribute' | 'text' | 'cdata' | 'none';
1562
+
1563
+ declare type XMLObject = {
1564
+ nodeType?: XMLNodeType;
1565
+ name?: string;
1566
+ namespace?: string;
1567
+ prefix?: string;
1568
+ /** @deprecated Use nodeType: "attribute" instead */
1569
+ attribute?: boolean;
1570
+ /** @deprecated Use nodeType: "element" instead (for wrapped arrays) */
1571
+ wrapped?: boolean;
1572
+ };
1573
+
1574
+ export { }