redoc 3.0.0-rc.3 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (513) hide show
  1. package/bundles/redoc.d.ts +328 -31
  2. package/bundles/redoc.js +1078 -1349
  3. package/bundles/redoc.standalone.d.ts +327 -31
  4. package/bundles/redoc.standalone.js +1003 -1087
  5. package/package.json +42 -36
  6. package/typings/.tsbuildinfo +0 -1
  7. package/typings/RedocStandalone.d.ts +0 -43
  8. package/typings/RedoclyApiDocs.d.ts +0 -22
  9. package/typings/RedoclyApiDocsStandalone.d.ts +0 -22
  10. package/typings/adapters/asyncapi/build/context.d.ts +0 -9
  11. package/typings/adapters/asyncapi/build/navigation.d.ts +0 -2
  12. package/typings/adapters/asyncapi/build/utils.d.ts +0 -3
  13. package/typings/adapters/asyncapi/buildContext.d.ts +0 -2
  14. package/typings/adapters/asyncapi/index.d.ts +0 -13
  15. package/typings/adapters/asyncapi/items/channel/content.d.ts +0 -5
  16. package/typings/adapters/asyncapi/items/channel/item.d.ts +0 -13
  17. package/typings/adapters/asyncapi/items/operation/content.d.ts +0 -4
  18. package/typings/adapters/asyncapi/items/operation/item.d.ts +0 -15
  19. package/typings/adapters/asyncapi/items/overview/content.d.ts +0 -10
  20. package/typings/adapters/asyncapi/items/overview/item.d.ts +0 -16
  21. package/typings/adapters/asyncapi/panels/brokers.d.ts +0 -7
  22. package/typings/adapters/asyncapi/panels/download.d.ts +0 -3
  23. package/typings/adapters/asyncapi/panels/group.d.ts +0 -16
  24. package/typings/adapters/asyncapi/panels/overview.d.ts +0 -3
  25. package/typings/adapters/asyncapi/store.d.ts +0 -4
  26. package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts +0 -4
  27. package/typings/adapters/asyncapi/utils/get-channel-label.d.ts +0 -3
  28. package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts +0 -24
  29. package/typings/adapters/asyncapi/utils/resolve-schema.d.ts +0 -2
  30. package/typings/adapters/asyncapi/utils/resolve-server-variables.d.ts +0 -3
  31. package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts +0 -2
  32. package/typings/adapters/asyncapi/utils/security.d.ts +0 -12
  33. package/typings/adapters/build.d.ts +0 -15
  34. package/typings/adapters/graphql/build/context.d.ts +0 -9
  35. package/typings/adapters/graphql/buildContext.d.ts +0 -2
  36. package/typings/adapters/graphql/buildStoreFromSdl.d.ts +0 -2
  37. package/typings/adapters/graphql/group/custom.d.ts +0 -2
  38. package/typings/adapters/graphql/group/default.d.ts +0 -2
  39. package/typings/adapters/graphql/group/errors.d.ts +0 -1
  40. package/typings/adapters/graphql/group/itemBuilders.d.ts +0 -5
  41. package/typings/adapters/graphql/group/utils.d.ts +0 -8
  42. package/typings/adapters/graphql/index.d.ts +0 -9
  43. package/typings/adapters/graphql/items/directive/content.d.ts +0 -4
  44. package/typings/adapters/graphql/items/directive/item.d.ts +0 -3
  45. package/typings/adapters/graphql/items/enum/content.d.ts +0 -4
  46. package/typings/adapters/graphql/items/enum/item.d.ts +0 -3
  47. package/typings/adapters/graphql/items/input/content.d.ts +0 -4
  48. package/typings/adapters/graphql/items/input/item.d.ts +0 -3
  49. package/typings/adapters/graphql/items/interface/content.d.ts +0 -4
  50. package/typings/adapters/graphql/items/interface/item.d.ts +0 -3
  51. package/typings/adapters/graphql/items/mutation/content.d.ts +0 -4
  52. package/typings/adapters/graphql/items/mutation/item.d.ts +0 -3
  53. package/typings/adapters/graphql/items/object/content.d.ts +0 -4
  54. package/typings/adapters/graphql/items/object/item.d.ts +0 -3
  55. package/typings/adapters/graphql/items/operation/content.d.ts +0 -7
  56. package/typings/adapters/graphql/items/overview/content.d.ts +0 -11
  57. package/typings/adapters/graphql/items/overview/item.d.ts +0 -4
  58. package/typings/adapters/graphql/items/query/content.d.ts +0 -4
  59. package/typings/adapters/graphql/items/query/item.d.ts +0 -3
  60. package/typings/adapters/graphql/items/scalar/content.d.ts +0 -4
  61. package/typings/adapters/graphql/items/scalar/item.d.ts +0 -3
  62. package/typings/adapters/graphql/items/subscription/content.d.ts +0 -4
  63. package/typings/adapters/graphql/items/subscription/item.d.ts +0 -3
  64. package/typings/adapters/graphql/items/types.d.ts +0 -7
  65. package/typings/adapters/graphql/items/union/content.d.ts +0 -4
  66. package/typings/adapters/graphql/items/union/item.d.ts +0 -3
  67. package/typings/adapters/graphql/panels/download.d.ts +0 -3
  68. package/typings/adapters/graphql/panels/group-items.d.ts +0 -4
  69. package/typings/adapters/graphql/panels/overview.d.ts +0 -3
  70. package/typings/adapters/graphql/serializeType.d.ts +0 -4
  71. package/typings/adapters/graphql/store.d.ts +0 -3
  72. package/typings/adapters/graphql/utils/configMetadataRows.d.ts +0 -3
  73. package/typings/adapters/graphql/utils/constants.d.ts +0 -24
  74. package/typings/adapters/graphql/utils/createApiItem.d.ts +0 -15
  75. package/typings/adapters/graphql/utils/getBadges.d.ts +0 -4
  76. package/typings/adapters/graphql/utils/ignoreInternalItems.d.ts +0 -3
  77. package/typings/adapters/graphql/utils/isRootType.d.ts +0 -2
  78. package/typings/adapters/graphql/utils/menuSlashRegex.d.ts +0 -1
  79. package/typings/adapters/graphql/utils/normalizeMenu.d.ts +0 -3
  80. package/typings/adapters/graphql/utils/shouldIncludeItem.d.ts +0 -2
  81. package/typings/adapters/graphql/utils/summary.d.ts +0 -4
  82. package/typings/adapters/graphql/utils/validateMenuConfig.d.ts +0 -3
  83. package/typings/adapters/helpers.d.ts +0 -44
  84. package/typings/adapters/openapi/build/context.d.ts +0 -13
  85. package/typings/adapters/openapi/build-code-sample-source.d.ts +0 -4
  86. package/typings/adapters/openapi/buildContext.d.ts +0 -2
  87. package/typings/adapters/openapi/constants.d.ts +0 -4
  88. package/typings/adapters/openapi/group/content.d.ts +0 -25
  89. package/typings/adapters/openapi/group/item.d.ts +0 -8
  90. package/typings/adapters/openapi/index.d.ts +0 -11
  91. package/typings/adapters/openapi/items/mcp/content.d.ts +0 -5
  92. package/typings/adapters/openapi/items/mcp/item.d.ts +0 -9
  93. package/typings/adapters/openapi/items/operation/content.d.ts +0 -12
  94. package/typings/adapters/openapi/items/operation/item.d.ts +0 -9
  95. package/typings/adapters/openapi/items/overview/content.d.ts +0 -17
  96. package/typings/adapters/openapi/items/overview/item.d.ts +0 -3
  97. package/typings/adapters/openapi/items/schema/content.d.ts +0 -3
  98. package/typings/adapters/openapi/items/schema/item.d.ts +0 -9
  99. package/typings/adapters/openapi/panels/download.d.ts +0 -3
  100. package/typings/adapters/openapi/panels/mcp.d.ts +0 -3
  101. package/typings/adapters/openapi/panels/overview.d.ts +0 -3
  102. package/typings/adapters/openapi/panels/servers.d.ts +0 -3
  103. package/typings/adapters/openapi/resolve-openapi-example-value.d.ts +0 -3
  104. package/typings/adapters/openapi/store.d.ts +0 -4
  105. package/typings/adapters/openapi/utils/JsonPointer.d.ts +0 -50
  106. package/typings/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.d.ts +0 -1
  107. package/typings/adapters/openapi/utils/helpers.d.ts +0 -12
  108. package/typings/adapters/openapi/utils/operation.d.ts +0 -24
  109. package/typings/adapters/openapi/utils/resolvePathItemRef.d.ts +0 -2
  110. package/typings/adapters/openapi/utils/url.d.ts +0 -2
  111. package/typings/adapters/rbac.d.ts +0 -10
  112. package/typings/adapters/scopedContext.d.ts +0 -5
  113. package/typings/adapters/utils/dompurify.d.ts +0 -5
  114. package/typings/adapters/utils/isPlainText.d.ts +0 -6
  115. package/typings/adapters/utils/markdoc.d.ts +0 -54
  116. package/typings/adapters/utils/parseMarkdown.d.ts +0 -8
  117. package/typings/adapters/utils/simplifyAstStructure.d.ts +0 -2
  118. package/typings/ajv-stub.d.ts +0 -4
  119. package/typings/components/AdmonitionItem.d.ts +0 -6
  120. package/typings/components/ChannelAddressItem.d.ts +0 -7
  121. package/typings/components/ContainerItem.d.ts +0 -9
  122. package/typings/components/EmptyMessageItem.d.ts +0 -6
  123. package/typings/components/ErrorBoundary.d.ts +0 -20
  124. package/typings/components/ExtensionsItem.d.ts +0 -7
  125. package/typings/components/ExternalDocsItem.d.ts +0 -8
  126. package/typings/components/Header/HeaderItem.d.ts +0 -10
  127. package/typings/components/Header/HeaderPageActions.d.ts +0 -4
  128. package/typings/components/Header/HeaderResponseCodeTabs.d.ts +0 -8
  129. package/typings/components/Header/PageActions.d.ts +0 -4
  130. package/typings/components/Header/ResponseDeepLinkAnchor.d.ts +0 -9
  131. package/typings/components/Header/hooks.d.ts +0 -5
  132. package/typings/components/InfoMetadataItem.d.ts +0 -7
  133. package/typings/components/ItemContent/ItemContentRenderer.d.ts +0 -8
  134. package/typings/components/ItemContent/SectionHeader.d.ts +0 -8
  135. package/typings/components/ItemContent/hooks.d.ts +0 -17
  136. package/typings/components/ItemContent/sections/BodyMimeTypeField.d.ts +0 -12
  137. package/typings/components/ItemContent/sections/BodySection.d.ts +0 -7
  138. package/typings/components/ItemContent/sections/CallbacksSection.d.ts +0 -5
  139. package/typings/components/ItemContent/sections/FieldsSection.d.ts +0 -7
  140. package/typings/components/ItemContent/sections/MessagesSection.d.ts +0 -5
  141. package/typings/components/ItemContent/sections/ParametersSection.d.ts +0 -6
  142. package/typings/components/ItemContent/sections/ResponsesSection.d.ts +0 -5
  143. package/typings/components/ItemContent/sections/ValuesSection.d.ts +0 -5
  144. package/typings/components/Mapper.d.ts +0 -22
  145. package/typings/components/MarkdownItem.d.ts +0 -6
  146. package/typings/components/Mcp/McpPrompt.d.ts +0 -8
  147. package/typings/components/Mcp/McpResource.d.ts +0 -8
  148. package/typings/components/Mcp/McpTool.d.ts +0 -8
  149. package/typings/components/Mcp/styled.d.ts +0 -22
  150. package/typings/components/Mcp/utils.d.ts +0 -7
  151. package/typings/components/MessageLinksItem.d.ts +0 -7
  152. package/typings/components/PrePaintColorModeScript.d.ts +0 -12
  153. package/typings/components/Schema/SchemaDescription.d.ts +0 -5
  154. package/typings/components/Schema/SchemaView.d.ts +0 -20
  155. package/typings/components/Schema/helpers.d.ts +0 -1
  156. package/typings/components/Schema/hooks/useSchemaDocument.d.ts +0 -7
  157. package/typings/components/Schema/hooks/useSchemaFieldDeepLink.d.ts +0 -5
  158. package/typings/components/Schema/hooks/useVariantIndexFromHash.d.ts +0 -1
  159. package/typings/components/Schema/styled.d.ts +0 -235
  160. package/typings/components/Schema/utils.d.ts +0 -15
  161. package/typings/components/Schema/views/ArrayRenderer.d.ts +0 -12
  162. package/typings/components/Schema/views/CollapsibleNestedFields.d.ts +0 -24
  163. package/typings/components/Schema/views/DefaultMappingOptionLabel.d.ts +0 -5
  164. package/typings/components/Schema/views/DiscriminatorPropertyRow.d.ts +0 -13
  165. package/typings/components/Schema/views/Examples.d.ts +0 -7
  166. package/typings/components/Schema/views/ExpandableExample.d.ts +0 -4
  167. package/typings/components/Schema/views/ObjectRenderer.d.ts +0 -13
  168. package/typings/components/Schema/views/Pattern.d.ts +0 -6
  169. package/typings/components/Schema/views/PrimitiveRenderer.d.ts +0 -5
  170. package/typings/components/Schema/views/PropertyFieldRow.d.ts +0 -15
  171. package/typings/components/Schema/views/PropertyRenderer.d.ts +0 -14
  172. package/typings/components/Schema/views/SchemaEnumDescriptions.d.ts +0 -9
  173. package/typings/components/Schema/views/SchemaEnumValues.d.ts +0 -8
  174. package/typings/components/Schema/views/SchemaTitleLabel.d.ts +0 -5
  175. package/typings/components/Schema/views/SchemaVariantSelector.d.ts +0 -11
  176. package/typings/components/Schema/views/SwitcherRenderer.d.ts +0 -13
  177. package/typings/components/Schema/views/VariantDropdown.d.ts +0 -14
  178. package/typings/components/Search/Search.d.ts +0 -10
  179. package/typings/components/Search/SearchDialog.d.ts +0 -7
  180. package/typings/components/Search/SearchTrigger.d.ts +0 -9
  181. package/typings/components/Search/index.d.ts +0 -1
  182. package/typings/components/Security/Divider.d.ts +0 -4
  183. package/typings/components/Security/RequiredScopes.d.ts +0 -4
  184. package/typings/components/Security/ScopeTagWithTooltip.d.ts +0 -11
  185. package/typings/components/Security/SecurityButtonPanel.d.ts +0 -5
  186. package/typings/components/Security/SecurityFlowDetail.d.ts +0 -5
  187. package/typings/components/Security/SecurityModal.d.ts +0 -6
  188. package/typings/components/Security/SecuritySection.d.ts +0 -3
  189. package/typings/components/Security/styled.d.ts +0 -127
  190. package/typings/components/Security/types.d.ts +0 -3
  191. package/typings/components/SideMenu/SideMenu.d.ts +0 -7
  192. package/typings/components/SideMenu/buildMenuItems.d.ts +0 -29
  193. package/typings/components/SideMenu/useMenuItems.d.ts +0 -14
  194. package/typings/components/StickySidebar/FloatingButton.d.ts +0 -1
  195. package/typings/components/StickySidebar/RedoclyAttributionLogo.d.ts +0 -5
  196. package/typings/components/StickySidebar/SidebarActions.d.ts +0 -2
  197. package/typings/components/StickySidebar/StickySidebar.d.ts +0 -7
  198. package/typings/components/common/Badge.d.ts +0 -32
  199. package/typings/components/common/Breadcrumbs.d.ts +0 -11
  200. package/typings/components/common/ContentWrapper.d.ts +0 -13
  201. package/typings/components/common/DeepLinkAnchor.d.ts +0 -20
  202. package/typings/components/common/ExpandAllButton.d.ts +0 -6
  203. package/typings/components/common/ExternalDocumentation.d.ts +0 -10
  204. package/typings/components/common/LazyMount.d.ts +0 -9
  205. package/typings/components/common/LazySection.d.ts +0 -14
  206. package/typings/components/common/Markdown.d.ts +0 -7
  207. package/typings/components/common/MoreDetailsButton.d.ts +0 -5
  208. package/typings/components/common/NestedToggleButton.d.ts +0 -10
  209. package/typings/components/common/PanelItem.d.ts +0 -27
  210. package/typings/components/common/ResponseCodeTabs.d.ts +0 -9
  211. package/typings/components/common/Tag.d.ts +0 -3
  212. package/typings/components/common/VendorExtensions.d.ts +0 -7
  213. package/typings/components/common/ViewNested.d.ts +0 -13
  214. package/typings/components/graphql/ArrowIcon.d.ts +0 -7
  215. package/typings/components/graphql/GraphQLArgumentsSection.d.ts +0 -10
  216. package/typings/components/graphql/GraphQLEnumEmbedded.d.ts +0 -5
  217. package/typings/components/graphql/GraphQLFieldView.d.ts +0 -12
  218. package/typings/components/graphql/GraphQLFieldsEmbedded.d.ts +0 -9
  219. package/typings/components/graphql/GraphQLGroupTypeList.d.ts +0 -5
  220. package/typings/components/graphql/GraphQLHeaderExtras.d.ts +0 -7
  221. package/typings/components/graphql/GraphQLReturnTypeDetails.d.ts +0 -11
  222. package/typings/components/graphql/GraphQLTypeView.d.ts +0 -9
  223. package/typings/components/graphql/GraphQLUnionEmbedded.d.ts +0 -5
  224. package/typings/components/graphql/RequiresScopesButton.d.ts +0 -9
  225. package/typings/components/graphql/RequiresScopesModal.d.ts +0 -9
  226. package/typings/components/graphql/ViewNested.d.ts +0 -14
  227. package/typings/components/graphql/renderDescription.d.ts +0 -2
  228. package/typings/components/graphql/sections/GraphQLArgsSection.d.ts +0 -5
  229. package/typings/components/graphql/sections/GraphQLFieldsSection.d.ts +0 -5
  230. package/typings/components/graphql/sections/ImplementedBySection.d.ts +0 -5
  231. package/typings/components/graphql/sections/ImplementsSection.d.ts +0 -5
  232. package/typings/components/graphql/sections/PossibleTypesSection.d.ts +0 -5
  233. package/typings/components/graphql/sections/RequiresScopesSection.d.ts +0 -5
  234. package/typings/components/graphql/sections/ReturnTypeSection.d.ts +0 -5
  235. package/typings/components/graphql/styled.d.ts +0 -55
  236. package/typings/components/markdoc/Heading.d.ts +0 -11
  237. package/typings/components/markdoc/SchemaDefinition.d.ts +0 -11
  238. package/typings/components/markdoc/apiDocsMarkdocComponents.d.ts +0 -6
  239. package/typings/components/markdoc/buildMarkdocOptions.d.ts +0 -9
  240. package/typings/components/markdoc/defaultMarkdocConfig.d.ts +0 -4
  241. package/typings/components/markdoc/html/html-jsx-attribute-mapping.d.ts +0 -5
  242. package/typings/components/markdoc/html/process-html-tokens.d.ts +0 -2
  243. package/typings/components/markdoc/markdocAdapter.d.ts +0 -12
  244. package/typings/components/markdoc/markdocParser.d.ts +0 -8
  245. package/typings/components/markdoc/markdocRenderer.d.ts +0 -8
  246. package/typings/components/markdoc/tags/mcp-tag-schemas.d.ts +0 -2
  247. package/typings/components/markdoc/tags/schema-definition-tag.d.ts +0 -2
  248. package/typings/components/panels/ConnectMcpButton.d.ts +0 -5
  249. package/typings/components/panels/DownloadPanelItem.d.ts +0 -5
  250. package/typings/components/panels/ExampleItem/CallbackPayloadItem.d.ts +0 -5
  251. package/typings/components/panels/ExampleItem/CodeSampleItem.d.ts +0 -5
  252. package/typings/components/panels/ExampleItem/ExamplesPanelItem.d.ts +0 -3
  253. package/typings/components/panels/ExampleItem/GraphQLQueryItem.d.ts +0 -5
  254. package/typings/components/panels/ExampleItem/GraphQLResponseItem.d.ts +0 -5
  255. package/typings/components/panels/ExampleItem/GraphQLTypeSampleItem.d.ts +0 -5
  256. package/typings/components/panels/ExampleItem/GraphQLVariablesItem.d.ts +0 -5
  257. package/typings/components/panels/ExampleItem/PayloadExampleItem.d.ts +0 -5
  258. package/typings/components/panels/ExampleItem/ResponseExampleItem.d.ts +0 -5
  259. package/typings/components/panels/ExampleItem/ServerDropdown.d.ts +0 -17
  260. package/typings/components/panels/ExampleItem/hooks.d.ts +0 -28
  261. package/typings/components/panels/ExampleItem/selectors.d.ts +0 -42
  262. package/typings/components/panels/ExampleItem/styled.d.ts +0 -98
  263. package/typings/components/panels/ExampleItem/types.d.ts +0 -6
  264. package/typings/components/panels/ExampleItem/useCodeSampleLanguages.d.ts +0 -22
  265. package/typings/components/panels/GroupPanelItem.d.ts +0 -5
  266. package/typings/components/panels/LanguageItem/LanguageDropdown.d.ts +0 -15
  267. package/typings/components/panels/LanguageItem/LanguageItem.d.ts +0 -11
  268. package/typings/components/panels/LanguageItem/styled.d.ts +0 -58
  269. package/typings/components/panels/LocationsPanelItem.d.ts +0 -5
  270. package/typings/components/panels/McpExamplePanelItem.d.ts +0 -5
  271. package/typings/components/panels/McpPanelItem.d.ts +0 -3
  272. package/typings/components/panels/OverviewPanelItem.d.ts +0 -3
  273. package/typings/components/panels/PanelMapper.d.ts +0 -5
  274. package/typings/components/panels/PanelNodeProps.d.ts +0 -4
  275. package/typings/components/panels/ReferencesPanelItem.d.ts +0 -5
  276. package/typings/components/panels/ServerItem/ServerDescriptionTooltip.d.ts +0 -4
  277. package/typings/components/panels/ServerItem/ServerItem.d.ts +0 -5
  278. package/typings/components/panels/ServerItem/ServerPanelItem.d.ts +0 -5
  279. package/typings/components/panels/asyncapi/BrokerItem/BrokerBindingsSection.d.ts +0 -7
  280. package/typings/components/panels/asyncapi/BrokerItem/BrokerModal.d.ts +0 -8
  281. package/typings/components/panels/asyncapi/BrokerItem/BrokerOverviewSection.d.ts +0 -6
  282. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanel.styled.d.ts +0 -21
  283. package/typings/components/panels/asyncapi/BrokerItem/BrokerPanelItem.d.ts +0 -5
  284. package/typings/components/panels/asyncapi/ChannelBindingItem/ChannelBindingItem.d.ts +0 -5
  285. package/typings/components/panels/asyncapi/MessageBindingItem/MessageBindingItem.d.ts +0 -5
  286. package/typings/components/panels/asyncapi/MessageReferencesItem/MessageReferencesItem.d.ts +0 -5
  287. package/typings/components/panels/asyncapi/OperationBindingItem/OperationBindingItem.d.ts +0 -5
  288. package/typings/components/panels/asyncapi/common/bindingPanel.d.ts +0 -30
  289. package/typings/components/panels/shared-panel-styles.d.ts +0 -13
  290. package/typings/components/panels/styled.d.ts +0 -12
  291. package/typings/constants/openapi.d.ts +0 -25
  292. package/typings/constants/rendering.d.ts +0 -8
  293. package/typings/contexts/markdownAdapter.d.ts +0 -21
  294. package/typings/contexts/telemetry.d.ts +0 -4
  295. package/typings/crypto-compat.d.ts +0 -5
  296. package/typings/crypto-uuid-compat.d.ts +0 -1
  297. package/typings/empty-linkedom.d.ts +0 -1
  298. package/typings/empty.d.ts +0 -7
  299. package/typings/events/codeSampleCopy.d.ts +0 -2
  300. package/typings/events/creator.d.ts +0 -2
  301. package/typings/events/languageSwitch.d.ts +0 -2
  302. package/typings/events/serverSwitch.d.ts +0 -2
  303. package/typings/events/types.d.ts +0 -6
  304. package/typings/hoc/withItemId.d.ts +0 -6
  305. package/typings/hoc/withRouter.d.ts +0 -4
  306. package/typings/hoc/withStoreProvider.d.ts +0 -24
  307. package/typings/hooks/code-highlight-languages.d.ts +0 -6
  308. package/typings/hooks/deepLinkHash.d.ts +0 -7
  309. package/typings/hooks/useAgentTools.d.ts +0 -6
  310. package/typings/hooks/useApiDocsRoutes.d.ts +0 -8
  311. package/typings/hooks/useApiDocsScroll.d.ts +0 -9
  312. package/typings/hooks/useBodyScrollLock.d.ts +0 -1
  313. package/typings/hooks/useCodeHighlight.d.ts +0 -15
  314. package/typings/hooks/useCopyCodeTelemetry.d.ts +0 -14
  315. package/typings/hooks/useCopySpecSlice.d.ts +0 -9
  316. package/typings/hooks/useDeepLinkSection.d.ts +0 -16
  317. package/typings/hooks/useExpandableSection.d.ts +0 -4
  318. package/typings/hooks/useHashLinkRedirect.d.ts +0 -4
  319. package/typings/hooks/useInitialTelemetry.d.ts +0 -3
  320. package/typings/hooks/useIsExpanded.d.ts +0 -1
  321. package/typings/hooks/useIsHydrated.d.ts +0 -4
  322. package/typings/hooks/useManualScrollAnchor.d.ts +0 -19
  323. package/typings/hooks/useModalDismiss.d.ts +0 -2
  324. package/typings/hooks/useNormalizeUrl.d.ts +0 -2
  325. package/typings/hooks/usePageTelemetry.d.ts +0 -3
  326. package/typings/hooks/usePageViewTelemetry.d.ts +0 -2
  327. package/typings/hooks/usePerformanceMetricsTelemetry.d.ts +0 -5
  328. package/typings/hooks/useRouterHashBridge.d.ts +0 -24
  329. package/typings/hooks/useScrollSpyUrlSync.d.ts +0 -3
  330. package/typings/hooks/useSearchEngine.d.ts +0 -7
  331. package/typings/hooks/useSessionSummaryTelemetry.d.ts +0 -7
  332. package/typings/hooks/useTelemetry.d.ts +0 -2
  333. package/typings/hooks/useTranslate.d.ts +0 -5
  334. package/typings/hooks/useUrlHash.d.ts +0 -8
  335. package/typings/hooks/useUrlHashReassert.d.ts +0 -2
  336. package/typings/hooks/useUserScrollIntent.d.ts +0 -18
  337. package/typings/hooks/useVisitedChannelsTracker.d.ts +0 -6
  338. package/typings/icons/CSharpIcon/CSharpIcon.d.ts +0 -3
  339. package/typings/icons/CurlIcon/CurlIcon.d.ts +0 -13
  340. package/typings/icons/DefaultMappingIcon/DefaultMappingIcon.d.ts +0 -13
  341. package/typings/icons/GOIcon/GOIcon.d.ts +0 -3
  342. package/typings/icons/JavaIcon/JavaIcon.d.ts +0 -3
  343. package/typings/icons/JavaScriptIcon/JavaScriptIcon.d.ts +0 -3
  344. package/typings/icons/ListIcon/ListIcon.d.ts +0 -9
  345. package/typings/icons/NodeJSIcon/NodeJSIcon.d.ts +0 -3
  346. package/typings/icons/PHPIcon/PHPIcon.d.ts +0 -3
  347. package/typings/icons/PayloadIcon/PayloadIcon.d.ts +0 -3
  348. package/typings/icons/PlusCircleIcon/PlusCircleIcon.d.ts +0 -7
  349. package/typings/icons/PythonIcon/PythonIcon.d.ts +0 -3
  350. package/typings/icons/RIcon/RIcon.d.ts +0 -3
  351. package/typings/icons/RubyIcon/RubyIcon.d.ts +0 -3
  352. package/typings/index.d.ts +0 -9
  353. package/typings/jotai/app.d.ts +0 -66
  354. package/typings/jotai/examples.d.ts +0 -5
  355. package/typings/jotai/graphql.d.ts +0 -10
  356. package/typings/jotai/itemStore.d.ts +0 -60
  357. package/typings/jotai/routes.d.ts +0 -4
  358. package/typings/jotai/schema.d.ts +0 -3
  359. package/typings/jotai/store.d.ts +0 -22
  360. package/typings/jotai/telemetry.d.ts +0 -46
  361. package/typings/options/constants.d.ts +0 -10
  362. package/typings/options/editionOverrides.d.ts +0 -3
  363. package/typings/options/helpers.d.ts +0 -19
  364. package/typings/options/normalizeOptions.d.ts +0 -2
  365. package/typings/options/standaloneLayoutVars.d.ts +0 -3
  366. package/typings/otel-semantic-conventions.d.ts +0 -10
  367. package/typings/pages/EntryPage.d.ts +0 -25
  368. package/typings/pages/GroupPage.d.ts +0 -1
  369. package/typings/pages/ItemPage.d.ts +0 -1
  370. package/typings/pages/NotFoundPage.d.ts +0 -6
  371. package/typings/pages/OverviewPage.d.ts +0 -1
  372. package/typings/pages/TopLevelEntryView.d.ts +0 -17
  373. package/typings/services/agent-tools/index.d.ts +0 -10
  374. package/typings/services/agent-tools/operations.d.ts +0 -20
  375. package/typings/services/agent-tools/results.d.ts +0 -6
  376. package/typings/services/agent-tools/security.d.ts +0 -13
  377. package/typings/services/agent-tools/spec-slice-detail.d.ts +0 -12
  378. package/typings/services/agent-tools/types.d.ts +0 -55
  379. package/typings/services/agent-tools/webmcp.d.ts +0 -14
  380. package/typings/services/code-samples/convertSampleToString.d.ts +0 -3
  381. package/typings/services/code-samples/discriminator.d.ts +0 -65
  382. package/typings/services/code-samples/example-key.d.ts +0 -13
  383. package/typings/services/code-samples/index.d.ts +0 -2
  384. package/typings/services/code-samples/language-availability.d.ts +0 -4
  385. package/typings/services/code-samples/normalize-servers.d.ts +0 -3
  386. package/typings/services/code-samples/server-env.d.ts +0 -3
  387. package/typings/services/code-samples/server-variables.d.ts +0 -9
  388. package/typings/services/code-samples/source.d.ts +0 -81
  389. package/typings/services/schema/dialects/graphqlSchema.d.ts +0 -1
  390. package/typings/services/schema/dialects/jsonSchema.d.ts +0 -7
  391. package/typings/services/schema/index.d.ts +0 -1
  392. package/typings/services/schema/propertyBuilder.d.ts +0 -31
  393. package/typings/services/schema/propertyTreeBuilder.d.ts +0 -21
  394. package/typings/services/schema/schemaProcessor.d.ts +0 -2
  395. package/typings/services/schema/variant-label.d.ts +0 -6
  396. package/typings/services/search/engine/collapse.d.ts +0 -5
  397. package/typings/services/search/engine/constants.d.ts +0 -22
  398. package/typings/services/search/engine/flexsearch.d.ts +0 -6
  399. package/typings/services/search/engine/index.d.ts +0 -11
  400. package/typings/services/search/engine/lowered.d.ts +0 -34
  401. package/typings/services/search/engine/match.d.ts +0 -12
  402. package/typings/services/search/engine/present.d.ts +0 -5
  403. package/typings/services/search/engine/query.d.ts +0 -6
  404. package/typings/services/search/engine/score.d.ts +0 -7
  405. package/typings/services/search/engine/text.d.ts +0 -3
  406. package/typings/services/search/engine/types.d.ts +0 -19
  407. package/typings/services/search/highlight.d.ts +0 -3
  408. package/typings/services/search/indexer/context.d.ts +0 -8
  409. package/typings/services/search/indexer/deep-links.d.ts +0 -12
  410. package/typings/services/search/indexer/extractors/asyncapi.d.ts +0 -8
  411. package/typings/services/search/indexer/extractors/body.d.ts +0 -2
  412. package/typings/services/search/indexer/extractors/callbacks.d.ts +0 -4
  413. package/typings/services/search/indexer/extractors/context.d.ts +0 -25
  414. package/typings/services/search/indexer/extractors/examples.d.ts +0 -3
  415. package/typings/services/search/indexer/extractors/graphql.d.ts +0 -2
  416. package/typings/services/search/indexer/extractors/heading-sections.d.ts +0 -3
  417. package/typings/services/search/indexer/extractors/index.d.ts +0 -11
  418. package/typings/services/search/indexer/extractors/mcp.d.ts +0 -9
  419. package/typings/services/search/indexer/extractors/named-rows.d.ts +0 -2
  420. package/typings/services/search/indexer/extractors/panels.d.ts +0 -10
  421. package/typings/services/search/indexer/extractors/parameters.d.ts +0 -2
  422. package/typings/services/search/indexer/extractors/responses.d.ts +0 -2
  423. package/typings/services/search/indexer/extractors/schema-page.d.ts +0 -9
  424. package/typings/services/search/indexer/extractors/security.d.ts +0 -4
  425. package/typings/services/search/indexer/index.d.ts +0 -14
  426. package/typings/services/search/indexer/param.d.ts +0 -7
  427. package/typings/services/search/indexer/places.d.ts +0 -36
  428. package/typings/services/search/indexer/schema-walker.d.ts +0 -29
  429. package/typings/services/search/indexer/text.d.ts +0 -2
  430. package/typings/services/search/init.d.ts +0 -7
  431. package/typings/services/search/text-match.d.ts +0 -5
  432. package/typings/services/search/types.d.ts +0 -31
  433. package/typings/services/spec-convert/asyncapi.d.ts +0 -11
  434. package/typings/services/spec-convert/index.d.ts +0 -5
  435. package/typings/services/spec-convert/swagger/parameters.d.ts +0 -6
  436. package/typings/services/spec-convert/swagger/refs.d.ts +0 -34
  437. package/typings/services/spec-convert/swagger/responses.d.ts +0 -2
  438. package/typings/services/spec-convert/swagger/schema.d.ts +0 -1
  439. package/typings/services/spec-convert/swagger.d.ts +0 -7
  440. package/typings/services/spec-slice/assistant-links.d.ts +0 -9
  441. package/typings/services/spec-slice/asyncapi-slice.d.ts +0 -5
  442. package/typings/services/spec-slice/clone-strip.d.ts +0 -1
  443. package/typings/services/spec-slice/component-closure.d.ts +0 -6
  444. package/typings/services/spec-slice/graphql-slice.d.ts +0 -2
  445. package/typings/services/spec-slice/index.d.ts +0 -6
  446. package/typings/services/spec-slice/openapi-slice.d.ts +0 -6
  447. package/typings/services/spec-slice/resolve-scope.d.ts +0 -4
  448. package/typings/services/spec-slice/types.d.ts +0 -37
  449. package/typings/standalone.d.ts +0 -20
  450. package/typings/standaloneThemeConfig.d.ts +0 -3
  451. package/typings/telemetry/RedocTelemetry.d.ts +0 -22
  452. package/typings/telemetry/TypeOfUsageContext.d.ts +0 -3
  453. package/typings/telemetry/defaults.d.ts +0 -7
  454. package/typings/telemetry/events.d.ts +0 -41
  455. package/typings/telemetry/fields.d.ts +0 -7
  456. package/typings/telemetry/index.d.ts +0 -15
  457. package/typings/telemetry/initialPayload.d.ts +0 -56
  458. package/typings/telemetry/page.d.ts +0 -5
  459. package/typings/telemetry/reportDefinitionLoadFailed.d.ts +0 -9
  460. package/typings/telemetry/sanitizeError.d.ts +0 -4
  461. package/typings/telemetry/security.d.ts +0 -14
  462. package/typings/telemetry/useRedocTelemetryInstance.d.ts +0 -3
  463. package/typings/telemetry/useSchemaFieldTelemetry.d.ts +0 -4
  464. package/typings/telemetry/useSidebarItemTelemetry.d.ts +0 -11
  465. package/typings/types/asyncapi.d.ts +0 -314
  466. package/typings/types/code-samples-config.d.ts +0 -12
  467. package/typings/types/common.d.ts +0 -163
  468. package/typings/types/content.d.ts +0 -479
  469. package/typings/types/edition-config.d.ts +0 -6
  470. package/typings/types/events.d.ts +0 -48
  471. package/typings/types/graphql-store.d.ts +0 -60
  472. package/typings/types/graphql.d.ts +0 -53
  473. package/typings/types/openapi.d.ts +0 -515
  474. package/typings/types/options.d.ts +0 -90
  475. package/typings/types/schema.d.ts +0 -162
  476. package/typings/types/store.d.ts +0 -160
  477. package/typings/utils/calculateMaxLength.d.ts +0 -6
  478. package/typings/utils/compose.d.ts +0 -7
  479. package/typings/utils/cookies.d.ts +0 -7
  480. package/typings/utils/deep-link.d.ts +0 -163
  481. package/typings/utils/definitionLoadError.d.ts +0 -7
  482. package/typings/utils/environments.d.ts +0 -6
  483. package/typings/utils/expansion.d.ts +0 -3
  484. package/typings/utils/extract-extensions.d.ts +0 -4
  485. package/typings/utils/form-urlencoded.d.ts +0 -9
  486. package/typings/utils/graphql-directive-utils.d.ts +0 -6
  487. package/typings/utils/graphql-parse.d.ts +0 -1
  488. package/typings/utils/graphql-reference-map.d.ts +0 -3
  489. package/typings/utils/graphql-samples.d.ts +0 -29
  490. package/typings/utils/graphql-scopes.d.ts +0 -6
  491. package/typings/utils/graphql-type-expansion.d.ts +0 -5
  492. package/typings/utils/http-methods.d.ts +0 -8
  493. package/typings/utils/is-record.d.ts +0 -1
  494. package/typings/utils/languages.d.ts +0 -18
  495. package/typings/utils/loadAndBundleSpec.d.ts +0 -4
  496. package/typings/utils/logo.d.ts +0 -8
  497. package/typings/utils/media-type.d.ts +0 -5
  498. package/typings/utils/refPointer.d.ts +0 -2
  499. package/typings/utils/resolveSpec.d.ts +0 -20
  500. package/typings/utils/resolveText.d.ts +0 -2
  501. package/typings/utils/routeKind.d.ts +0 -6
  502. package/typings/utils/routing.d.ts +0 -49
  503. package/typings/utils/scroll-anchoring.d.ts +0 -4
  504. package/typings/utils/security-scope.d.ts +0 -3
  505. package/typings/utils/serialize-parameter.d.ts +0 -8
  506. package/typings/utils/session-storage.d.ts +0 -2
  507. package/typings/utils/split-badges-by-position.d.ts +0 -5
  508. package/typings/utils/status-code.d.ts +0 -1
  509. package/typings/utils/string.d.ts +0 -14
  510. package/typings/utils/url.d.ts +0 -9
  511. package/typings/utils/x-logo.d.ts +0 -13
  512. package/typings/utils/xml.d.ts +0 -1
  513. package/typings/utils/yaml.d.ts +0 -2
@@ -1,15 +0,0 @@
1
- import type { GraphqlItemVariant, TypeGroupFilter } from '../../../types/graphql.js';
2
- import type { ApiItem } from '../../../types/store.js';
3
- type CreateApiItemParams<T> = {
4
- name: string;
5
- variant: GraphqlItemVariant;
6
- processedItems?: Set<string>;
7
- filter?: TypeGroupFilter;
8
- menuCommonFilter?: TypeGroupFilter;
9
- label?: string;
10
- deprecated?: boolean;
11
- source: T;
12
- parentPath?: string;
13
- };
14
- export declare function createApiItem<T>(params: CreateApiItemParams<T>): ApiItem | null;
15
- export {};
@@ -1,4 +0,0 @@
1
- import type { GraphQLSchema } from 'graphql';
2
- import type { Badge } from '../../../types/common.js';
3
- import type { GraphqlItemVariant } from '../../../types/graphql.js';
4
- export declare function getBadges(schema: GraphQLSchema, item: string, typeGroup?: GraphqlItemVariant): Badge[] | undefined;
@@ -1,3 +0,0 @@
1
- export declare function ignoreInternalItems<T extends {
2
- name: string;
3
- }>(items: T[]): T[];
@@ -1,2 +0,0 @@
1
- import type { GraphQLNamedType, GraphQLSchema } from 'graphql';
2
- export declare function isRootType(type: GraphQLNamedType, schema: GraphQLSchema): boolean;
@@ -1 +0,0 @@
1
- export declare const MENU_SLASH_DELIMITED_REGEX: RegExp;
@@ -1,3 +0,0 @@
1
- import type { GraphQLSchema } from 'graphql';
2
- import type { MenuConfig } from '../../../types/graphql.js';
3
- export declare function normalizeMenuConfig(menu?: MenuConfig, schema?: GraphQLSchema): MenuConfig | undefined;
@@ -1,2 +0,0 @@
1
- import type { TypeGroupFilter } from '../../../types/graphql.js';
2
- export declare function shouldIncludeItem(itemName: string, specific?: TypeGroupFilter, common?: TypeGroupFilter): boolean;
@@ -1,4 +0,0 @@
1
- import type { GraphQLSchema } from 'graphql';
2
- import type { GraphqlItemVariant } from '../../../types/graphql.js';
3
- import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
4
- export declare function getSummary(schema: GraphQLSchema, item: string, markdownOptions: ParseMarkdownOptions, typeGroup?: GraphqlItemVariant): string | undefined;
@@ -1,3 +0,0 @@
1
- import type { GraphQLSchema } from 'graphql';
2
- import type { MenuConfig } from '../../../types/graphql.js';
3
- export declare function validateGraphqlMenuConfig(schema: GraphQLSchema, menuConfig?: MenuConfig): void;
@@ -1,44 +0,0 @@
1
- import type { SchemaEntry, ExampleEntry, SecuritySchemeEntry, StoreContext } from '../types/store.js';
2
- import type { OpenAPIRef, Referenced } from '../types/common.js';
3
- import type { OpenAPIMediaType, OpenAPIExample } from '../types/openapi.js';
4
- import { isRecord } from '../utils/is-record.js';
5
- export { isRecord };
6
- export declare function stableStringify(data: unknown, seen?: Set<unknown>): string;
7
- export declare function registerSchema(schemaStore: Record<string, SchemaEntry>, hashIndex: Record<string, string>, entry: Omit<SchemaEntry, 'id'> & {
8
- id?: string;
9
- }): string;
10
- /** Accepts a raw markdown string or a host-pre-parsed AST node; drops anything else. */
11
- export declare function pickRenderableDescription(value: unknown): ExampleEntry['description'];
12
- export declare function registerExample(exampleStore: Record<string, ExampleEntry>, entry: Omit<ExampleEntry, 'id'> & {
13
- id?: string;
14
- }): string;
15
- export declare function registerSecurityScheme(securitySchemeStore: Record<string, SecuritySchemeEntry>, entry: SecuritySchemeEntry): string;
16
- export declare function createStoreContext(document: Record<string, unknown>): StoreContext;
17
- /**
18
- * Safely coerce a value to Record<string, unknown>.
19
- * Returns an empty object if the value is not a valid record.
20
- */
21
- export declare function toRecord(value: unknown): Record<string, unknown>;
22
- export declare function resolveRef<T>(spec: Record<string, unknown>, value: Referenced<T>, ignoreNamedSchemas?: Set<string>): T | undefined;
23
- export type MediaTypesMap = {
24
- [mime: string]: OpenAPIMediaType;
25
- };
26
- export declare function isOpenAPIRef(value: unknown): value is OpenAPIRef;
27
- type LegacyExampleHost = {
28
- content?: {
29
- [mime: string]: Referenced<OpenAPIMediaType>;
30
- };
31
- 'x-examples'?: {
32
- [mime: string]: {
33
- [name: string]: Referenced<OpenAPIExample>;
34
- };
35
- };
36
- 'x-example'?: {
37
- [mime: string]: unknown;
38
- };
39
- };
40
- /** Follows a `components.mediaTypes` reference chain; `undefined` when it is broken or cyclic. */
41
- export declare function resolveMediaType(spec: Record<string, unknown>, entry: Referenced<OpenAPIMediaType>): OpenAPIMediaType | undefined;
42
- /** `undefined` when there is no media type left to render. */
43
- export declare function resolveContent(spec: Record<string, unknown>, info: LegacyExampleHost | null | undefined): MediaTypesMap | undefined;
44
- export declare function resolveJsonPointer(spec: Record<string, unknown>, ref: string): Record<string, unknown> | undefined;
@@ -1,13 +0,0 @@
1
- import type { OpenAPIDefinition, OpenAPICallback, OpenApiBuildContext as BuildContext, NormalizedCallback } from '../../../types/openapi.js';
2
- import type { Referenced } from '../../../types/common.js';
3
- import type { AdapterBuildContextInput, StoreContext } from '../../../types/store.js';
4
- type BuildContextWithDocument = AdapterBuildContextInput & {
5
- document: OpenAPIDefinition;
6
- storeCtx: StoreContext;
7
- processContent?: boolean;
8
- };
9
- export declare function createBuildContext({ document, options, basePath, storeCtx, processContent }: BuildContextWithDocument): BuildContext;
10
- export declare function normalizeCallbacks(callbacks: {
11
- [name: string]: Referenced<OpenAPICallback>;
12
- } | undefined, document: Record<string, unknown>, ignoreNamedSchemas?: Set<string>): NormalizedCallback[] | undefined;
13
- export {};
@@ -1,4 +0,0 @@
1
- import type { OperationInfo } from '../../types/openapi.js';
2
- import type { StoreContext } from '../../types/store.js';
3
- import type { CodeSampleSource } from '../../services/code-samples/index.js';
4
- export declare function buildCodeSampleSource(operationInfo: OperationInfo, storeCtx: StoreContext, ignoreNamedSchemas?: Set<string>, isWebhook?: boolean, href?: string): CodeSampleSource;
@@ -1,2 +0,0 @@
1
- import type { OpenApiBuildContext as BuildContext } from '../../types/openapi.js';
2
- export declare const openApiContext: import("../scopedContext.js").ScopedContext<BuildContext>;
@@ -1,4 +0,0 @@
1
- export declare const SUPPORTED_MCP_TYPES: readonly ['tools', 'resources', 'prompts'];
2
- export type McpCollectionType = (typeof SUPPORTED_MCP_TYPES)[number];
3
- export declare const MCP_SERVER_EXPERIMENTAL_CAPABILITIES = "experimental";
4
- export declare const PAGE_ACTIONS_MCP: ("mcp-cursor" | "mcp-vscode")[];
@@ -1,25 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { ApiItemContent } from '../../../types/content.js';
3
- import type { BreadcrumbItem, GroupItem } from '../../../types/store.js';
4
- import type { OpenAPITagExtended, OperationInfo } from '../../../types/openapi.js';
5
- import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
6
- import type { McpGroupItems } from '../items/mcp/item.js';
7
- export type ChildTagInfo = {
8
- displayName: string;
9
- summary?: string;
10
- slug: string;
11
- };
12
- export declare function buildGroupContent({ tag, tagName, headerLabel, description, operations, schemasItems, mcpItems, tagSlug, basePath, breadcrumbs, childTags, markdownOptions }: {
13
- tag: OpenAPITagExtended;
14
- tagName: string;
15
- headerLabel?: string;
16
- description?: string | Node[] | Node;
17
- operations: OperationInfo[];
18
- schemasItems?: GroupItem[];
19
- mcpItems?: McpGroupItems;
20
- tagSlug: string;
21
- basePath: string;
22
- breadcrumbs?: BreadcrumbItem[];
23
- childTags?: ChildTagInfo[];
24
- markdownOptions: ParseMarkdownOptions;
25
- }): ApiItemContent;
@@ -1,8 +0,0 @@
1
- import type { ApiItem } from '../../../types/store.js';
2
- import type { OpenAPIDefinition } from '../../../types/openapi.js';
3
- export declare function addTagItems(document: OpenAPIDefinition, result: ApiItem[]): void;
4
- export declare function processTagGroups(xTagGroups: Array<{
5
- name: string;
6
- tags: string[];
7
- }>, result: ApiItem[]): void;
8
- export declare function processRootTags(tagOrder: string[], childTagNames: Set<string>, result: ApiItem[]): void;
@@ -1,11 +0,0 @@
1
- import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
2
- import type { OpenAPIDefinition } from '../../types/openapi.js';
3
- import type { ApiDocsOptions } from '../../types/options.js';
4
- export declare function processOpenApiDocument({ document, basePath, options, processContent }: ApiDocAdapterProps & {
5
- document: OpenAPIDefinition;
6
- options: ApiDocsOptions;
7
- processContent?: boolean;
8
- }): Promise<{
9
- items: ApiItem[];
10
- store: ApiStore;
11
- }>;
@@ -1,5 +0,0 @@
1
- import type { ApiItemContent } from '../../../../types/content.js';
2
- import type { ApiDocsOptions } from '../../../../types/options.js';
3
- type McpItemType = 'tool' | 'rsrc' | 'prompt';
4
- export declare function buildMcpItemContent(mcpType: McpItemType, name: string, id: string, title: string, options: ApiDocsOptions): ApiItemContent;
5
- export {};
@@ -1,9 +0,0 @@
1
- import type { ApiItem, GroupItem } from '../../../../types/store.js';
2
- import { type McpCollectionType } from '../../constants.js';
3
- export declare function addMcpItems({ tagName, tagSlug, result, groupItems }: {
4
- tagName: string;
5
- tagSlug: string;
6
- result: ApiItem[];
7
- groupItems?: McpGroupItems;
8
- }): void;
9
- export type McpGroupItems = Record<McpCollectionType, GroupItem[]>;
@@ -1,12 +0,0 @@
1
- import type { ApiItemContent } from '../../../../types/content.js';
2
- import type { OperationInfo } from '../../../../types/openapi.js';
3
- /**
4
- * Callback ids in the legacy `<name>/<verb>` shape, so previously shared links still resolve.
5
- * One entry is emitted per url expression, so that pair can repeat within an operation —
6
- * later duplicates take a `~<n>` suffix.
7
- *
8
- * The separator is deliberately not `/`: an id must never be a path-segment prefix of a
9
- * sibling's, or hash matching would treat `<name>/<verb>` as also naming `<name>/<verb>~1`.
10
- */
11
- export declare function createCallbackIdFactory(): (name: string, httpVerb: string) => string;
12
- export declare function buildItemContent(operationInfo: OperationInfo, pageSlug: string): ApiItemContent;
@@ -1,9 +0,0 @@
1
- import type { ApiItem } from '../../../../types/store.js';
2
- import type { OperationInfo } from '../../../../types/openapi.js';
3
- import { type RbacScope } from '../../../rbac.js';
4
- export declare function addOperationItems({ operations, result, basePath: basePathOverride, parentRbac }: {
5
- operations: OperationInfo[];
6
- result: ApiItem[];
7
- basePath?: string;
8
- parentRbac?: RbacScope;
9
- }): void;
@@ -1,17 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { ContentNode, ApiItemContent } from '../../../../types/content.js';
3
- import type { OpenAPIDefinition } from '../../../../types/openapi.js';
4
- import type { ApiDocsOptions, NormalizedDownloadUrl } from '../../../../types/options.js';
5
- type OverviewContentOptions = {
6
- downloadUrls?: NormalizedDownloadUrl[];
7
- basePath: string;
8
- sanitize: ApiDocsOptions['sanitize'];
9
- markdownParser: ApiDocsOptions['markdownParser'];
10
- } & Partial<ApiDocsOptions>;
11
- export declare function buildOverviewContent({ document, description, sectionChildren, options }: {
12
- document: OpenAPIDefinition;
13
- description: string | Node[] | undefined;
14
- sectionChildren: ContentNode[];
15
- options: OverviewContentOptions;
16
- }): ApiItemContent;
17
- export {};
@@ -1,3 +0,0 @@
1
- import type { ApiItem } from '../../../../types/store.js';
2
- import type { OpenAPIDefinition } from '../../../../types/openapi.js';
3
- export declare function buildOverviewItems(document: OpenAPIDefinition): ApiItem[];
@@ -1,3 +0,0 @@
1
- import type { ApiItemContent } from '../../../../types/content.js';
2
- import type { ApiDocsOptions } from '../../../../types/options.js';
3
- export declare function buildSchemaDefinitionContent(schemaName: string, title: string | undefined, options: ApiDocsOptions): ApiItemContent;
@@ -1,9 +0,0 @@
1
- import type { ApiItem, GroupItem } from '../../../../types/store.js';
2
- import type { OpenAPIDefinition } from '../../../../types/openapi.js';
3
- export declare function getSchemaNamesForTag(tagName: string, document: OpenAPIDefinition, schemaDefinitionsTagName: string | undefined): string[];
4
- export declare function addSchemaDefinitionItems({ tagName, tagSlug, result, groupItems }: {
5
- tagName: string;
6
- tagSlug: string;
7
- result: ApiItem[];
8
- groupItems?: GroupItem[];
9
- }): void;
@@ -1,3 +0,0 @@
1
- import type { DownloadNode } from '../../../types/content.js';
2
- import type { NormalizedDownloadUrl } from '../../../types/options.js';
3
- export declare function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode;
@@ -1,3 +0,0 @@
1
- import type { McpNode } from '../../../types/content.js';
2
- import type { OpenAPIDefinition } from '../../../types/openapi.js';
3
- export declare function buildMcpPanelContent(document: OpenAPIDefinition): McpNode | null;
@@ -1,3 +0,0 @@
1
- import type { OverviewNode } from '../../../types/content.js';
2
- import type { OpenAPIInfo } from '../../../types/openapi.js';
3
- export declare function buildOverviewPanelContent(info: OpenAPIInfo | undefined): OverviewNode;
@@ -1,3 +0,0 @@
1
- import type { ServerData } from '../../../types/common.js';
2
- import type { ServersNode } from '../../../types/content.js';
3
- export declare function buildServersPanelContent(servers: ServerData[]): ServersNode | null;
@@ -1,3 +0,0 @@
1
- import type { OpenAPIExample } from '../../types/openapi.js';
2
- export declare function resolveOpenApiExampleValue(example: OpenAPIExample | undefined): unknown;
3
- export declare function hasOpenApiExampleValue(example: OpenAPIExample | undefined): boolean;
@@ -1,4 +0,0 @@
1
- import type { ApiStore, StoreContext } from '../../types/store.js';
2
- import type { OpenAPIDefinition } from '../../types/openapi.js';
3
- import type { ApiDocsOptions } from '../../types/options.js';
4
- export declare function populateOpenApiStore(document: OpenAPIDefinition, storeCtx: StoreContext, options: ApiDocsOptions): ApiStore;
@@ -1,50 +0,0 @@
1
- /**
2
- * Wrapper for JsonPointer. Provides common operations
3
- */
4
- export declare class JsonPointer {
5
- /**
6
- * returns last JsonPointer token
7
- * if level > 1 returns levels last (second last/third last)
8
- * @example
9
- * // returns subpath
10
- * JsonPointerHelper.baseName('/path/0/subpath')
11
- * // returns foo
12
- * JsonPointerHelper.baseName('/path/foo/subpath', 2)
13
- */
14
- static baseName(pointer?: string, level?: number): string;
15
- /**
16
- * returns dirname of pointer
17
- * if level > 1 returns corresponding dirname in the hierarchy
18
- * @example
19
- * // returns /path/0
20
- * JsonPointerHelper.dirName('/path/0/subpath')
21
- * // returns /path
22
- * JsonPointerHelper.dirName('/path/foo/subpath', 2)
23
- */
24
- static dirName(pointer: string, level?: number): string;
25
- /**
26
- * returns relative path tokens
27
- * @example
28
- * // returns ['subpath']
29
- * JsonPointerHelper.relative('/path/0', '/path/0/subpath')
30
- * // returns ['foo', 'subpath']
31
- * JsonPointerHelper.relative('/path', '/path/foo/subpath')
32
- */
33
- static relative(from: string, to: string): string[];
34
- /**
35
- * overridden JsonPointer original parse to take care of prefixing '#' symbol
36
- * that is not valid JsonPointer
37
- */
38
- static parse(pointer?: string): string[];
39
- /**
40
- * Creates a JSON pointer path, by joining one or more tokens to a base path.
41
- *
42
- * @param {string} base - The base path
43
- * @param {string|string[]} tokens - The token(s) to append (e.g. ["name", "first"])
44
- * @returns {string}
45
- */
46
- static join(base: string, tokens: string | string[]): string;
47
- static get<T>(object: GenericObject, pointer: string): T;
48
- static compile(tokens: string[]): string;
49
- static escape(pointer: string): string;
50
- }
@@ -1 +0,0 @@
1
- export declare function applyIgnoreNamedSchemasDeep(value: unknown, ignoreNamedSchemas?: Set<string>): unknown;
@@ -1,12 +0,0 @@
1
- export declare function stripTrailingSlash(path: string): string;
2
- export declare function isAbsoluteUrl(url: string): boolean;
3
- /**
4
- * simple resolve URL which doesn't break on strings with url fragments
5
- * e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
6
- */
7
- export declare function resolveUrl(url: string, to: string): string;
8
- export declare function titleize(text: string): string;
9
- export declare function removeQueryStringAndHash(serverUrl: string): string;
10
- export declare function escapeHTMLAttrChars(str: string): string;
11
- export declare function sanitizeItemId(id: string): string;
12
- export declare function getDefinitionName(pointer?: string): string | undefined;
@@ -1,24 +0,0 @@
1
- import type { OperationInfo, OpenAPIXBadges } from '../../../types/openapi.js';
2
- import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
3
- type OperationData = {
4
- slug: string;
5
- label: string;
6
- badges?: OpenAPIXBadges[];
7
- deprecated: boolean;
8
- isAdditionalOperation?: boolean;
9
- httpVerb: string;
10
- httpPath: string;
11
- isWebhook: boolean;
12
- };
13
- export declare function getOperationData(operation: OperationInfo, basePath: string): OperationData;
14
- export declare function getOperationSummary(operation: OperationInfo, markdownOptions: ParseMarkdownOptions): string | undefined;
15
- type OperationColorProps = {
16
- deprecated?: boolean;
17
- isAdditionalOperation?: boolean;
18
- httpVerb: string;
19
- };
20
- export declare function getOperationColor({ deprecated, isAdditionalOperation, httpVerb }: OperationColorProps): string;
21
- /** Operation servers win when non-empty; an empty array falls through to the
22
- * document servers (see the empty-array test — a `??` fallback would not). */
23
- export declare function pickOperationServers<T>(operationServers: T[] | undefined, documentServers: T[] | undefined): T[];
24
- export {};
@@ -1,2 +0,0 @@
1
- import type { OpenAPIPath } from '../../../types/openapi.js';
2
- export declare function resolvePathItemRef(document: Record<string, unknown>, pathItem: OpenAPIPath | undefined | null, openapi?: string): OpenAPIPath | undefined;
@@ -1,2 +0,0 @@
1
- export declare function urlParse(url: string, slashesDenoteHost?: boolean): URL | null;
2
- export declare function getUrlDirname(urlLikeString: string): string | undefined;
@@ -1,10 +0,0 @@
1
- export type RbacScope = Record<string, string>;
2
- export declare function readRbacScope(_source: unknown): RbacScope | undefined;
3
- export declare function hasRbacScope(_source: unknown): boolean;
4
- export type RbacProp = Record<never, never>;
5
- export declare function rbacProp(_scope: RbacScope | undefined): RbacProp;
6
- export declare function isRbacKey(_key: string): boolean;
7
- export declare function splitRbacSection<T>(map: Record<string, T> | undefined): {
8
- sectionRbac: RbacScope | undefined;
9
- entries: [string, T][];
10
- };
@@ -1,5 +0,0 @@
1
- export type ScopedContext<T> = {
2
- run<R>(ctx: T, fn: () => R): R;
3
- get(): T;
4
- };
5
- export declare function createScopedContext<T>(name: string): ScopedContext<T>;
@@ -1,5 +0,0 @@
1
- type DOMPurifyInstance = {
2
- sanitize(source: string): string;
3
- };
4
- export declare function getDOMPurify(): DOMPurifyInstance;
5
- export {};
@@ -1,6 +0,0 @@
1
- /**
2
- * True when a description string contains no markdown/markdoc/HTML syntax, so parsing it would
3
- * only wrap it in a paragraph. Such strings can stay plain in the items/store JSON (an AST is
4
- * ~10x the raw size) and render as-is on the client.
5
- */
6
- export declare function isPlainText(value: string): boolean;
@@ -1,54 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { ContentNode } from '../../types/content.js';
3
- import type { ApiItem } from '../../types/store.js';
4
- import type { ApiDocsOptions } from '../../types/options.js';
5
- import type { MarkdownHeading } from '../../types/openapi.js';
6
- import type { ParseMarkdownOptions } from './parseMarkdown.js';
7
- export type { MarkdownHeading };
8
- export type MarkdownSanitizeOptions = {
9
- sanitize?: ApiDocsOptions['sanitize'];
10
- };
11
- export type DescriptionSegment = {
12
- kind: 'markdoc';
13
- node: ContentNode;
14
- } | {
15
- kind: 'schemaDefinition';
16
- node: ContentNode;
17
- };
18
- type ExtractDescriptionSegmentsOptions = {
19
- sliceAtFirstHeading?: boolean;
20
- };
21
- export declare function extractContentUntilFirstHeading(ast: Node | Node[] | string | undefined, options?: ParseMarkdownOptions): Node[] | string | undefined;
22
- export declare function extractDescriptionSegments(ast: Node | Node[] | string | undefined, options?: ParseMarkdownOptions, { sliceAtFirstHeading }?: ExtractDescriptionSegmentsOptions): DescriptionSegment[];
23
- export declare function resolveMarkdocHeadingDeepSuffix(id: string, operationId: string, deepLinkSuffix?: string): string;
24
- export declare const HEADING_SCOPE_VARIABLE = "$$apiDocsHeadingScope";
25
- export type HeadingScope = {
26
- operationId: string;
27
- deepLinkSuffix?: string;
28
- };
29
- /** Scope of a partial outside any `#` section of the overview: the ids inline headings get. */
30
- export declare const OVERVIEW_ROOT_SCOPE: HeadingScope;
31
- export declare function scopedHeadingAttributes(relativeId: string, { operationId, deepLinkSuffix }: HeadingScope): {
32
- id: string;
33
- deepLinkHash: string;
34
- };
35
- export declare function resolveMarkdocHeadingIds(ast: Node | Node[] | string, operationId: string, deepLinkSuffix?: string): void;
36
- export declare function extractMarkdownSections(description: Node | Node[] | string | undefined, options?: ParseMarkdownOptions, operationId?: string, isTagContext?: boolean): MarkdownHeading[];
37
- export declare function buildMarkdownSectionItem({ heading, basePath, withContent }: {
38
- heading: MarkdownHeading;
39
- basePath: string;
40
- /** `false` builds the navigation entry only: `content` is null. */
41
- withContent?: boolean;
42
- }): ApiItem;
43
- export declare function collectMarkdownSections(description: Node | Node[] | string | undefined, basePath: string, options: ParseMarkdownOptions): {
44
- sectionItems: ApiItem[];
45
- sectionChildren: ContentNode[];
46
- };
47
- export declare function extractFullText(ast: Node | Node[] | string): string;
48
- export declare function extractFirstParagraphText(ast: Node | Node[] | string, maxLength?: number): string | undefined;
49
- export declare function extractSummaryText(description: string | Node | Node[] | undefined | null, options?: ParseMarkdownOptions): string | undefined;
50
- /** One Markdoc node, or a non-empty list of them. */
51
- export declare function isMarkdocAst(value: unknown): value is Node | Node[];
52
- export declare function collectTextContent(node: Node): string;
53
- export declare function collectMarkdownPlainText(ast: Node | Node[] | string): string;
54
- export declare function sanitizeMarkdownSource(source: string, options?: MarkdownSanitizeOptions): string;
@@ -1,8 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { MarkdownParser } from '../../types/options.js';
3
- import type { MarkdownSanitizeOptions } from './markdoc.js';
4
- export type { MarkdownParser };
5
- export type ParseMarkdownOptions = MarkdownSanitizeOptions & {
6
- markdownParser: MarkdownParser;
7
- };
8
- export declare function parseMarkdown(markdown: string | undefined | null | Node | Node[], options?: ParseMarkdownOptions): string | Node | Node[] | undefined;
@@ -1,2 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- export declare const simplifyAstStructure: (ast: Node) => Node | Node[];
@@ -1,4 +0,0 @@
1
- export declare class Ajv2020 {
2
- constructor();
3
- }
4
- export default Ajv2020;
@@ -1,6 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { AdmonitionNode } from '../types/content.js';
3
- export type AdmonitionItemProps = {
4
- node: AdmonitionNode;
5
- };
6
- export declare function AdmonitionItem({ node }: AdmonitionItemProps): ReactElement;
@@ -1,7 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { ChannelAddressNode } from '../types/content.js';
3
- declare function ChannelAddressItemComponent({ node }: {
4
- node: ChannelAddressNode;
5
- }): ReactElement;
6
- export declare const ChannelAddressItem: import("react").MemoExoticComponent<typeof ChannelAddressItemComponent>;
7
- export {};
@@ -1,9 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { ContainerNode } from '../types/content.js';
3
- declare function ContainerItemComponent({ node, itemPath, sectionId }: {
4
- node: ContainerNode;
5
- itemPath?: string;
6
- sectionId?: string;
7
- }): ReactElement;
8
- export declare const ContainerItem: import("react").MemoExoticComponent<typeof ContainerItemComponent>;
9
- export {};
@@ -1,6 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { EmptyMessageNode } from '../types/content.js';
3
- export type EmptyMessageItemProps = {
4
- node: EmptyMessageNode;
5
- };
6
- export declare function EmptyMessageItem({ node }: EmptyMessageItemProps): ReactElement;
@@ -1,20 +0,0 @@
1
- import { Component } from 'react';
2
- import type { ReactNode, ErrorInfo, ContextType } from 'react';
3
- import { TelemetryContext } from '../telemetry/index.js';
4
- type ErrorBoundaryProps = {
5
- children: ReactNode;
6
- fallback?: ReactNode;
7
- };
8
- type ErrorBoundaryState = {
9
- hasError: boolean;
10
- error: Error | null;
11
- };
12
- export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
13
- static contextType: import("react").Context<import("../telemetry/RedocTelemetry.js").RedocTelemetry>;
14
- context: ContextType<typeof TelemetryContext>;
15
- constructor(props: ErrorBoundaryProps);
16
- static getDerivedStateFromError(error: Error): ErrorBoundaryState;
17
- componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
18
- render(): ReactNode;
19
- }
20
- export {};
@@ -1,7 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { ExtensionsNode } from '../types/content.js';
3
- declare function ExtensionsItemComponent({ node }: {
4
- node: ExtensionsNode;
5
- }): ReactElement;
6
- export declare const ExtensionsItem: import("react").MemoExoticComponent<typeof ExtensionsItemComponent>;
7
- export {};
@@ -1,8 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { ExternalDocsNode } from '../types/content.js';
3
- export type ExternalDocsItemProps = {
4
- node: ExternalDocsNode;
5
- };
6
- declare function ExternalDocsItemComponent({ node }: ExternalDocsItemProps): ReactElement | null;
7
- export declare const ExternalDocsItem: import("react").MemoExoticComponent<typeof ExternalDocsItemComponent>;
8
- export {};
@@ -1,10 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { ContentNode, HeaderNode } from '../../types/content.js';
3
- export type HeaderItemProps = {
4
- node: HeaderNode;
5
- path: string;
6
- parentNode?: ContentNode;
7
- };
8
- declare function HeaderItemComponent({ node, path, parentNode }: HeaderItemProps): ReactElement | null;
9
- export declare const HeaderItem: import("react").MemoExoticComponent<typeof HeaderItemComponent>;
10
- export {};
@@ -1,4 +0,0 @@
1
- import type { JSX } from 'react';
2
- export declare function HeaderPageActions({ pageSlug }: {
3
- pageSlug: string;
4
- }): JSX.Element | null;
@@ -1,8 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- type HeaderResponseCodeTabsProps = {
3
- codes: string[];
4
- itemId: string;
5
- firstCode: string;
6
- };
7
- export declare const HeaderResponseCodeTabs: import("react").MemoExoticComponent<({ codes, itemId, firstCode, }: HeaderResponseCodeTabsProps) => ReactElement>;
8
- export {};
@@ -1,4 +0,0 @@
1
- import type { JSX } from 'react';
2
- export declare function PageActions({ pageSlug }: {
3
- pageSlug: string;
4
- }): JSX.Element | null;