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,31 +0,0 @@
1
- import type { SchemaNode, DiscriminatorObject, PropertyType, AccessMode } from '../../types/schema.js';
2
- export declare function detectJsonSchemaType(schema: SchemaNode): string;
3
- export declare function schemaHasType(type: string | string[], target: string): boolean;
4
- export declare function isStructuredArrayItems(items: SchemaNode): boolean;
5
- export declare function isPrimitiveLikeSchema(schema: SchemaNode, type: string | string[]): boolean;
6
- /**
7
- * Primitive items that carry their own documentation are rendered as a nested
8
- * `[i]` row, so the array row keeps only the array-level info; trivial primitive
9
- * items stay flattened into the array row with their metadata promoted onto it.
10
- */
11
- export declare function primitiveArrayItemsHaveOwnInfo(items: SchemaNode): boolean;
12
- export declare function humanizeConstraints(schema: SchemaNode): string[];
13
- export declare function buildDisplayType(schema: SchemaNode, type: string | string[]): {
14
- typePrefix: string;
15
- displayType: string;
16
- displayFormat: string;
17
- };
18
- export declare function getDocumentedPrimitiveArrayItems(schema: SchemaNode, type: string | string[]): SchemaNode | undefined;
19
- export declare function stringifyValue(value: unknown): string;
20
- export declare function toPropertyExample(value: unknown, exampleSerializer?: (value: unknown) => string): PropertyType['example'];
21
- export declare function getAccessMode(schema: SchemaNode): AccessMode;
22
- export declare function getEnum(schema: SchemaNode): PropertyType['enum'];
23
- export declare function getDiscriminatorObject(schema: SchemaNode): DiscriminatorObject | undefined;
24
- export type PropertyShellOptions = {
25
- isRequired?: boolean;
26
- isAdditionalProperty?: boolean;
27
- isPatternProperty?: boolean;
28
- exampleSerializer?: (value: unknown) => string;
29
- };
30
- export declare function buildPropertyShell(schema: SchemaNode, options?: PropertyShellOptions): PropertyType;
31
- export declare function promotePrimitiveArrayMetadata(property: PropertyType, schema: SchemaNode, type: string | string[], exampleSerializer?: (value: unknown) => string): void;
@@ -1,21 +0,0 @@
1
- import type { SchemaNode, PropertyType } from '../../types/schema.js';
2
- export type SchemaTreeContext = {
3
- prepareVariant(ref: SchemaNode): SchemaNode;
4
- propertyRefCache: Map<string, PropertyType>;
5
- variantResolutionCache: Map<string, SchemaNode>;
6
- isChild?: boolean;
7
- implicitDiscriminatorChildren?: Record<string, ImplicitDiscriminatorChild[]>;
8
- exampleSerializer?: (value: unknown) => string;
9
- sortRequiredPropsFirst?: boolean;
10
- /** Refs open on the current DFS path; reaching one again is a cycle. */
11
- activeRefs: Set<string>;
12
- depth: number;
13
- /** Refs on a reference cycle; memoized by ref alone so a cyclic component expands once. */
14
- recursiveRefs: ReadonlySet<string>;
15
- };
16
- type ImplicitDiscriminatorChild = {
17
- ref: string;
18
- value: string;
19
- };
20
- export declare function buildPropertyTree(preparedRoot: SchemaNode, ctx: SchemaTreeContext, rootJsonPointer: string): PropertyType;
21
- export {};
@@ -1,2 +0,0 @@
1
- import type { PropertyType, SchemaNode, Document, SchemaProcessorOptions } from '../../types/schema.js';
2
- export declare function schemaProcessor(schema: SchemaNode, document: Document, options?: SchemaProcessorOptions): PropertyType;
@@ -1,6 +0,0 @@
1
- import type { SchemaNode } from '../../types/schema.js';
2
- export type VariantLabel = {
3
- label: string;
4
- typeLabel: string;
5
- };
6
- export declare function deriveVariantLabel(variant: SchemaNode, parentSchema: SchemaNode): VariantLabel;
@@ -1,5 +0,0 @@
1
- import type { SearchDocument } from '../types.js';
2
- import type { LowerDocument } from './lowered.js';
3
- import type { Candidate, ParsedQuery } from './types.js';
4
- export type LoweredLookup = (document: SearchDocument) => LowerDocument;
5
- export declare function collapseSharedFields(candidates: Candidate[], query: ParsedQuery, lowered: LoweredLookup): Candidate[];
@@ -1,22 +0,0 @@
1
- export declare const SEARCH_LIMIT = 100;
2
- export declare const SHARED_FIELD_COPIES = 3;
3
- export declare const SEARCH_CANDIDATE_LIMIT = 500;
4
- export { HIGHLIGHTED_TEXT_MAX_LENGTH } from '../highlight.js';
5
- export declare const SEARCH_INDEX_FIELDS: string[];
6
- export declare const SEARCH_SCORE: {
7
- readonly titleExact: 2000;
8
- readonly titlePrefix: 800;
9
- readonly titleAllWords: 400;
10
- readonly titlePartial: 150;
11
- readonly paramNameExact: 250;
12
- readonly paramNamePartial: 120;
13
- readonly sectionTitleExact: 180;
14
- readonly sectionTitlePartial: 90;
15
- readonly paramValue: 40;
16
- readonly paramPlace: 5;
17
- readonly titleCoverage: 100;
18
- readonly httpPath: 60;
19
- readonly httpMethod: 50;
20
- readonly text: 10;
21
- readonly deprecated: -40;
22
- };
@@ -1,6 +0,0 @@
1
- import { type Document, type Id, type DocumentData } from 'flexsearch';
2
- import type { SearchDocument } from '../types.js';
3
- export declare function createSearchIndex(): Document;
4
- /** Joins the values the index needs. The copy is temporary — the engine keeps the original. */
5
- export declare function toIndexedDocument(document: SearchDocument): DocumentData;
6
- export declare function candidateIds(index: Document, query: string): Promise<Set<Id>>;
@@ -1,11 +0,0 @@
1
- import type { SearchDocument, SearchItemData } from '../types.js';
2
- export declare class SearchEngine {
3
- private _index;
4
- private _documents;
5
- private _lowerDocuments;
6
- addDocument(document: SearchDocument): void;
7
- search(query: string): Promise<SearchItemData[]>;
8
- private rankCandidates;
9
- private appendCandidates;
10
- private lowered;
11
- }
@@ -1,34 +0,0 @@
1
- import type { SearchDocument } from '../types.js';
2
- import type { ParsedQuery } from './types.js';
3
- /**
4
- * Lowercased copy of a document for substring matching. `parameters` holds every parameter's
5
- * fields (name, description, path, example, enum, place) joined by newlines; `bounds` holds
6
- * `PARAMETER_STRIDE` offsets per parameter — the start of each field, then the end of the last.
7
- */
8
- export type LowerDocument = {
9
- title: string;
10
- text: string;
11
- httpMethod: string;
12
- httpPath: string;
13
- path: string;
14
- parameters: string;
15
- bounds: Uint32Array;
16
- };
17
- export declare enum ParameterField {
18
- Name = 0,
19
- Description = 1,
20
- Path = 2,
21
- Example = 3,
22
- Enum = 4,
23
- Place = 5
24
- }
25
- /** Matching is substring-based, so every value is lowered once here rather than per query. */
26
- export declare function lowerDocument(document: SearchDocument): LowerDocument;
27
- /** One lowered field of parameter `index`, as a slice of the document blob. */
28
- export declare function field(page: LowerDocument, index: number, kind: ParameterField): string;
29
- /**
30
- * Parameters whose text holds at least one query word, in definition order. Found by
31
- * scanning the joined blob once per word, so parameters that cannot score are never
32
- * visited — on large operations that is most of them.
33
- */
34
- export declare function parametersMentioning(page: LowerDocument, count: number, query: ParsedQuery): number[];
@@ -1,12 +0,0 @@
1
- import type { SearchDocument } from '../types.js';
2
- import type { LowerDocument } from './lowered.js';
3
- import type { DocumentMatch, ParameterHit, ParsedQuery } from './types.js';
4
- /**
5
- * FlexSearch reports the index field, but the UI reads `title`, `text`, `httpPath`,
6
- * `path` and `parameters`. So the hit fields come from the document, not from the index.
7
- */
8
- export declare function resolveMatch(page: LowerDocument, document: SearchDocument, query: ParsedQuery): DocumentMatch;
9
- /** One value holds every query word, like the index intersects its terms per field. */
10
- export declare function coversInOneValue(page: LowerDocument, document: SearchDocument, query: ParsedQuery): boolean;
11
- /** Best matching parameter of every message other than the primary match's. */
12
- export declare function otherMessageMatches(page: LowerDocument, document: SearchDocument, match: DocumentMatch, query: ParsedQuery): ParameterHit[];
@@ -1,5 +0,0 @@
1
- import type { SearchDocument, SearchItemData } from '../types.js';
2
- import type { LowerDocument } from './lowered.js';
3
- import type { DocumentMatch, ParsedQuery } from './types.js';
4
- export declare function resolveDeepLink(page: LowerDocument, document: SearchDocument, match: DocumentMatch, query: ParsedQuery): SearchDocument;
5
- export declare function prepareHighlight(document: SearchDocument, query: string, match: DocumentMatch): SearchItemData['highlight'];
@@ -1,6 +0,0 @@
1
- import type { ParsedQuery } from './types.js';
2
- export declare function parseQuery(query: string): ParsedQuery;
3
- export declare function coverage(query: ParsedQuery, lowered: string): number;
4
- export declare function bestCoverage(query: ParsedQuery, values: string[]): number;
5
- export declare function coversQuery(query: ParsedQuery, lowered: string): boolean;
6
- export declare function matchesWords(query: ParsedQuery, lowered: string): boolean;
@@ -1,7 +0,0 @@
1
- import type { SearchDocument } from '../types.js';
2
- import type { LowerDocument } from './lowered.js';
3
- import type { DocumentMatch, ParsedQuery } from './types.js';
4
- /** A page whose title is the query wins; a page that only mentions it in prose loses. */
5
- export declare function scoreMatch(page: LowerDocument, document: SearchDocument, match: DocumentMatch, query: ParsedQuery): number;
6
- /** How well the query matched one parameter; the value is also its ranking bonus. */
7
- export declare function scoreParameter(page: LowerDocument, document: SearchDocument, index: number, query: ParsedQuery): number;
@@ -1,3 +0,0 @@
1
- export declare function toText(value: string | string[] | undefined): string;
2
- /** Lowercased text; array items are joined by newlines so a query word never spans two. */
3
- export declare function lowerText(value: unknown): string;
@@ -1,19 +0,0 @@
1
- import type { OperationParameter, SearchDocument } from '../types.js';
2
- export type ParsedQuery = {
3
- text: string;
4
- words: string[];
5
- };
6
- export type DocumentMatch = {
7
- fields: string[];
8
- parameter: OperationParameter | undefined;
9
- parameterScore: number;
10
- };
11
- export type Candidate = {
12
- document: SearchDocument;
13
- match: DocumentMatch;
14
- score: number;
15
- };
16
- export type ParameterHit = {
17
- parameter: OperationParameter;
18
- score: number;
19
- };
@@ -1,3 +0,0 @@
1
- export declare const HIGHLIGHTED_TEXT_MAX_LENGTH = 150;
2
- export declare function highlightTextForSearch(query: string, text: string): string;
3
- export declare function markMatchedValue(query: string, value: string): string | undefined;
@@ -1,8 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- export type AsyncMessageSubsection = 'payload' | 'headers' | 'bindings';
3
- export type DescriptionFormatter = (desc: string | Node | Node[]) => string;
4
- export type WalkScope = {
5
- callbackId?: string;
6
- messageKey?: string;
7
- pathOnly?: boolean;
8
- };
@@ -1,12 +0,0 @@
1
- import type { AsyncMessageSubsection, WalkScope } from './context.js';
2
- export type FieldDeepLink = {
3
- slug: string;
4
- type: string;
5
- in?: string;
6
- contentType?: string;
7
- responseCode?: string;
8
- fieldPath: string[];
9
- scope: WalkScope;
10
- };
11
- export declare function buildFieldDeepLink({ slug, type, in: inValue, contentType, responseCode, fieldPath, scope }: FieldDeepLink): string;
12
- export declare function buildAsyncMessageDeepLink(slug: string, messageKey: string | undefined, subsection: AsyncMessageSubsection, fieldPath: string[]): string;
@@ -1,8 +0,0 @@
1
- import type { ContainerNode, ContentNode } from '../../../../types/content.js';
2
- import type { ExtractContext, Extractor } from './context.js';
3
- export declare const messagesExtractor: Extractor;
4
- export declare function extractMessageBindingFields(container: ContainerNode, ctx: ExtractContext): void;
5
- /** The channel address, rendered under the channel title; sits inside the page container. */
6
- export declare function extractChannelAddress(children: ContentNode[]): string | undefined;
7
- /** One row per server (broker) the page lists: name, host, title, summary and description. */
8
- export declare function extractServerFields(container: ContainerNode, ctx: ExtractContext): void;
@@ -1,2 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- export declare const bodyExtractor: Extractor;
@@ -1,4 +0,0 @@
1
- import type { ContentNode, ItemContentNode } from '../../../../types/content.js';
2
- import type { ExtractContext } from './context.js';
3
- export type VisitNodes = (nodes: ContentNode[], ctx: ExtractContext) => void;
4
- export declare function extractCallback(callback: NonNullable<ItemContentNode['callback']>, ctx: ExtractContext, visit: VisitNodes): void;
@@ -1,25 +0,0 @@
1
- import type { OperationParameter } from '@redocly/theme/core/openapi';
2
- import type { Node } from '@markdoc/markdoc';
3
- import type { ItemContentNode } from '../../../../types/content.js';
4
- import type { ExampleEntry } from '../../../../types/store.js';
5
- import type { SchemaWalker } from '../schema-walker.js';
6
- import type { DescriptionFormatter, WalkScope } from '../context.js';
7
- export type ExtractContext = {
8
- slug: string;
9
- scope: WalkScope;
10
- paramsMap: Record<string, OperationParameter>;
11
- visited: Set<string>;
12
- walker: SchemaWalker;
13
- formatDescription: DescriptionFormatter;
14
- hasSchemas: boolean;
15
- exampleStore?: Record<string, ExampleEntry>;
16
- /** True on the API overview page; parts that should lead there only are gated on it. */
17
- isOverview: boolean;
18
- };
19
- export type Extractor = {
20
- matches(node: ItemContentNode): boolean;
21
- extract(node: ItemContentNode, ctx: ExtractContext): void;
22
- };
23
- export declare function addRow(ctx: ExtractContext, param: OperationParameter): void;
24
- export declare function describe(ctx: ExtractContext, desc: string | Node | Node[] | undefined): string;
25
- export declare function withScope(ctx: ExtractContext, scope: Partial<WalkScope>): ExtractContext;
@@ -1,3 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- /** Rows for the example selector labels of a request body, each response, and each message. */
3
- export declare const examplesExtractor: Extractor;
@@ -1,2 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- export declare const graphqlExtractor: Extractor;
@@ -1,3 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- import type { ExtractContext } from './context.js';
3
- export declare function extractHeadingSections(content: string | Node | Node[] | undefined, ctx: ExtractContext): void;
@@ -1,11 +0,0 @@
1
- import type { ItemContentNode } from '../../../../types/content.js';
2
- import type { Extractor } from './context.js';
3
- export declare function extractorsFor(node: ItemContentNode): Extractor[];
4
- export type { ExtractContext, Extractor } from './context.js';
5
- export { extractCallback } from './callbacks.js';
6
- export { extractHeadingSections } from './heading-sections.js';
7
- export { extractChannelAddress, extractMessageBindingFields, extractServerFields, } from './asyncapi.js';
8
- export { extractMcpFields } from './mcp.js';
9
- export { extractInfoMetadataRows, extractPanelRows } from './panels.js';
10
- export { extractSecurityRows } from './security.js';
11
- export { extractSchemaPageFields } from './schema-page.js';
@@ -1,9 +0,0 @@
1
- import type { OperationParameter } from '@redocly/theme/core/openapi';
2
- import type { ApiItem } from '../../../../types/store.js';
3
- import type { ExtractContext } from './context.js';
4
- type McpFields = {
5
- text: string;
6
- parameters: OperationParameter[];
7
- };
8
- export declare function extractMcpFields(item: ApiItem, document: Record<string, unknown> | undefined, ctx: ExtractContext): McpFields | undefined;
9
- export {};
@@ -1,2 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- export declare const namedRowsExtractor: Extractor;
@@ -1,10 +0,0 @@
1
- import type { ContainerNode, InfoMetadataNode, ServersPanelItem } from '../../../../types/content.js';
2
- import type { ExtractContext } from './context.js';
3
- type ServerVariables = ServersPanelItem['servers'][number]['variables'];
4
- /** One row per server variable, on the overview page only, so a variable leads to the servers panel there. */
5
- export declare function extractServerVariableRows(variables: ServerVariables, ctx: ExtractContext): void;
6
- /** Rows for the side panels of a page: servers, and the info attributes (contact, license, terms). */
7
- export declare function extractPanelRows(container: ContainerNode, ctx: ExtractContext): void;
8
- /** One row per key/value of the overview's metadata table. */
9
- export declare function extractInfoMetadataRows(node: InfoMetadataNode, ctx: ExtractContext): void;
10
- export {};
@@ -1,2 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- export declare const parametersExtractor: Extractor;
@@ -1,2 +0,0 @@
1
- import type { Extractor } from './context.js';
2
- export declare const responsesExtractor: Extractor;
@@ -1,9 +0,0 @@
1
- import type { OperationParameter } from '@redocly/theme/core/openapi';
2
- import type { SchemaEntry } from '../../../../types/store.js';
3
- import type { ExtractContext } from './context.js';
4
- type SchemaPageFields = {
5
- parameters: OperationParameter[];
6
- description: string;
7
- };
8
- export declare function extractSchemaPageFields(schemaName: string, schemaStore: Record<string, SchemaEntry> | undefined, ctx: ExtractContext): SchemaPageFields;
9
- export {};
@@ -1,4 +0,0 @@
1
- import type { SecurityNode } from '../../../../types/content.js';
2
- import type { ExtractContext } from './context.js';
3
- /** One row per security scheme the operation accepts: name plus the short type line and scopes. */
4
- export declare function extractSecurityRows(node: SecurityNode, ctx: ExtractContext): void;
@@ -1,14 +0,0 @@
1
- import type { ApiItem, ExampleEntry, SchemaEntry } from '../../../types/store.js';
2
- import type { SearchDocument } from '../types.js';
3
- import type { DescriptionFormatter } from './context.js';
4
- export type SearchIndexerOptions = {
5
- formatDescription?: DescriptionFormatter;
6
- /** Enables example rows (the example selector labels); without it they are skipped. */
7
- exampleStore?: Record<string, ExampleEntry>;
8
- };
9
- export declare class ApiDocsSearchIndexer {
10
- #private;
11
- constructor(basePath: string, schemaStore?: Record<string, SchemaEntry>, document?: Record<string, unknown>, options?: SearchIndexerOptions);
12
- addItem(item: ApiItem, ancestors?: string[]): void;
13
- getResult(): SearchDocument[];
14
- }
@@ -1,7 +0,0 @@
1
- import type { OperationParameter } from '@redocly/theme/core/openapi';
2
- export declare function makeParam(fields: Partial<OperationParameter> & {
3
- name: string | string[];
4
- place: string;
5
- }): OperationParameter;
6
- export declare function truncateIndexedExample(example: string): string;
7
- export declare function getParameterId(param: OperationParameter, callbackId?: string, messageKey?: string): string;
@@ -1,36 +0,0 @@
1
- import type { AsyncMessageSubsection } from './context.js';
2
- export declare const REQUEST_BODY_PLACE = "request body";
3
- export declare const SCHEMA_FIELDS_PLACE = "schema fields";
4
- export declare const DESCRIPTION_PLACE = "description";
5
- export declare const CALLBACK_PLACE = "callback";
6
- export declare const MESSAGE_PLACE = "message";
7
- export declare const MESSAGE_PAYLOAD_PLACE = "message payload";
8
- export declare const MESSAGE_HEADERS_PLACE = "message headers";
9
- export declare const MESSAGE_BINDINGS_PLACE = "message bindings";
10
- export declare const SERVER_PLACE = "server";
11
- export declare const SERVER_VARIABLES_PLACE = "server variables";
12
- export declare const OVERVIEW_PLACE = "overview";
13
- export declare const METADATA_PLACE = "metadata";
14
- export declare const SECURITY_PLACE = "security";
15
- export declare const REQUEST_EXAMPLES_PLACE = "request examples";
16
- export declare const MESSAGE_EXAMPLES_PLACE = "message examples";
17
- export declare const GRAPHQL_ARGUMENTS_PLACE = "arguments";
18
- export declare const MCP_INPUT_SCHEMA_PLACE = "input schema";
19
- export declare const MCP_OUTPUT_SCHEMA_PLACE = "output schema";
20
- export declare const MCP_PROMPT_ARGUMENTS_PLACE = "arguments";
21
- /** Place of a top-level parameter, by its content-node variant. */
22
- export declare function parameterPlaceOf(variant: string | undefined): string;
23
- /** Place of schema/graphql field rows, by their content-node variant. */
24
- export declare function fieldsPlaceOf(variant: string | undefined): string;
25
- export declare function responseSectionPlace(code: string): string;
26
- export declare function responseFieldsPlace(code: string): string;
27
- export declare function responseHeadersPlace(code: string): string;
28
- export declare function responseExamplesPlace(code: string): string;
29
- /** Prefixes places produced inside a callback so search entries read as the callback's. */
30
- export declare function scopedPlace(place: string, callbackId?: string): string;
31
- export declare function responseCodeOf(place: string): string | undefined;
32
- export declare function asyncSubsectionOf(place: string): AsyncMessageSubsection | undefined;
33
- /** Markdown-heading rows: `description`, or `callback description` inside a callback. */
34
- export declare function isDescriptionPlace(place: string): boolean;
35
- /** Example selector labels: `request examples`, `response 201 examples`, `message examples`. */
36
- export declare function isExamplesPlace(place: string): boolean;
@@ -1,29 +0,0 @@
1
- import type { OperationParameter } from '@redocly/theme/core/openapi';
2
- import type { SchemaEntry } from '../../../types/store.js';
3
- import type { SchemaNode } from '../../../types/schema.js';
4
- import type { DescriptionFormatter, WalkScope } from './context.js';
5
- export type SchemaFieldsArgs = {
6
- schemaId: string;
7
- place: string;
8
- paramsMap: Record<string, OperationParameter>;
9
- slug: string;
10
- mediaType?: string;
11
- hasMultipleMediaTypes?: boolean;
12
- isResponse?: boolean;
13
- linkType?: string;
14
- visited?: Set<string>;
15
- };
16
- /** Walks raw JSON schemas from the schema store into flat `OperationParameter` rows. */
17
- export declare class SchemaWalker {
18
- #private;
19
- constructor(deps: {
20
- schemaStore?: Record<string, SchemaEntry>;
21
- document?: Record<string, unknown>;
22
- formatDescription: DescriptionFormatter;
23
- });
24
- extractSchemaFields({ schemaId, ...args }: SchemaFieldsArgs, scope?: WalkScope): void;
25
- /** Walks a schema that is not in the store (MCP input/output schemas, prompt arguments). */
26
- extractSchemaNodeFields(schema: SchemaNode, { place, paramsMap, slug, mediaType, hasMultipleMediaTypes, isResponse, linkType, visited }: Omit<SchemaFieldsArgs, 'schemaId'>, scope?: WalkScope): void;
27
- resolveParameterType(schemaId: string): string;
28
- resolveEffectiveSchema(schema: SchemaNode): SchemaNode;
29
- }
@@ -1,2 +0,0 @@
1
- import type { ContentNode } from '../../../types/content.js';
2
- export declare function extractText(children: ContentNode[]): string;
@@ -1,7 +0,0 @@
1
- import type { ApiItem, ApiStore } from '../../types/store.js';
2
- import type { SearchItemData } from './types.js';
3
- export type SearchApi = {
4
- search: (query: string) => Promise<SearchItemData[]>;
5
- };
6
- /** Builds the client-side search index from the item model, yielding to the event loop so large APIs don't block rendering. */
7
- export declare function initializeSearch(items: ApiItem[], store: ApiStore, basePath: string, document?: Record<string, unknown>): Promise<SearchApi>;
@@ -1,5 +0,0 @@
1
- export declare const MIN_QUERY_WORD_LENGTH = 2;
2
- export declare const MIN_INFIX_MATCH_LENGTH = 3;
3
- export declare function isWordChar(char: string | undefined): boolean;
4
- export declare function matchableQueryWords(query: string): string[];
5
- export declare function containsQueryWord(lowered: string, word: string): boolean;
@@ -1,31 +0,0 @@
1
- import type { OperationParameter, ParameterHighlight as ThemeParameterHighlight } from '@redocly/theme/core/openapi';
2
- import type { ItemBadge } from '@redocly/config';
3
- import type { RouteKind } from '../../utils/routeKind.js';
4
- export type ParameterHighlight = ThemeParameterHighlight & {
5
- enum?: string;
6
- example?: string;
7
- };
8
- export type SearchDocument = {
9
- id: string;
10
- url: string;
11
- title: string | string[];
12
- text: string | string[];
13
- path?: string[];
14
- httpMethod?: string;
15
- httpPath?: string | string[];
16
- isAdditionalOperation?: boolean;
17
- isSchemaDefinition?: boolean;
18
- deprecated?: boolean;
19
- security?: string[];
20
- parameters?: OperationParameter[];
21
- badges?: ItemBadge[];
22
- kind?: RouteKind;
23
- };
24
- export type SearchItemData = {
25
- document: SearchDocument;
26
- highlight: Record<string, string> & {
27
- parameters?: ParameterHighlight[];
28
- path?: string[];
29
- };
30
- };
31
- export type { OperationParameter } from '@redocly/theme/core/openapi';
@@ -1,11 +0,0 @@
1
- import type { AsyncApiDefinition } from '../../types/asyncapi.js';
2
- type Obj = Record<string, unknown>;
3
- /**
4
- * Converts the definition in place to AsyncAPI 3.x and returns it, with operation and message
5
- * traits merged into the objects that declare them. A 2.x document becomes 3.0.0 from the
6
- * application's point of view (`publish` → `receive`, `subscribe` → `send`); its traits keep 2.x
7
- * precedence (trait values win), 3.x traits lose to the object's own values. Objects that hold a
8
- * `description` keep their identity unless they are inlined into a second location.
9
- */
10
- export declare function normalizeAsyncApiDefinition(definition: Obj): AsyncApiDefinition;
11
- export {};
@@ -1,5 +0,0 @@
1
- import type { OpenAPIDefinition } from '../../types/openapi.js';
2
- export { convertSwaggerToOpenApi } from './swagger.js';
3
- export { normalizeAsyncApiDefinition } from './asyncapi.js';
4
- /** Promise form of `convertSwaggerToOpenApi`; rejects with the error it throws. */
5
- export declare const convertSwagger2OpenAPI: (document: Record<string, unknown>) => Promise<OpenAPIDefinition>;
@@ -1,6 +0,0 @@
1
- import type { Context, Obj } from './refs.js';
2
- export declare const TYPE_PROPERTIES: readonly ['format', 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum', 'minLength', 'maxLength', 'multipleOf', 'minItems', 'maxItems', 'uniqueItems', 'minProperties', 'maxProperties', 'additionalProperties', 'pattern', 'enum', 'default'];
3
- export declare function fixParamRef(param: Obj): void;
4
- /** Converts one parameter in place and returns the operation, which is replaced when a body is attached. */
5
- export declare function processParameter(ctx: Context, input: unknown, operation?: Obj, path?: Obj, method?: string): Obj | undefined;
6
- export declare function mediaTypes(own: unknown, root: unknown): unknown[];
@@ -1,34 +0,0 @@
1
- export type Obj = Record<string, unknown>;
2
- export interface RequestBodyEntry {
3
- name: string;
4
- body: Obj;
5
- refs: string[];
6
- }
7
- export interface Context {
8
- doc: Obj;
9
- parameters: Obj;
10
- examples: Obj;
11
- /** Original definition name → component schema name. */
12
- schemaNames: Map<string, string>;
13
- /** Local pointer that was hoisted into components → the component ref that replaces it. */
14
- refMap: Map<string, string>;
15
- /** Parameters folded into a request body; they are dropped from their lists. */
16
- folded: WeakSet<object>;
17
- /** Preferred component name for each request body. */
18
- bodyNames: WeakMap<object, string>;
19
- }
20
- export declare function sanitise(name: string): string;
21
- export declare function sanitiseAll(name: string): string;
22
- export declare function toCamelCase(text: string): string;
23
- export declare function renameStrict(section: Obj, kind: string, visit: (value: unknown) => void): void;
24
- export declare function sanitiseRequirements(security: unknown): void;
25
- export declare function fixRefs(ctx: Context, node: unknown, parent: Obj | unknown[], parentKey: string): void;
26
- export declare function rec(value: unknown): Obj | undefined;
27
- export declare function cloneJson<T>(value: T): T;
28
- export declare function moveKey(node: Obj, from: string, to: string): void;
29
- export declare function safeDecode(text: string): string;
30
- export declare function escapePointer(token: string): string;
31
- /** Java-style 32-bit string hash. */
32
- export declare function hashString(text: string): number;
33
- export declare function resolvePointer(root: unknown, ref: string): unknown;
34
- export declare function setPointer(root: Obj, ref: string, value: unknown): void;
@@ -1,2 +0,0 @@
1
- import type { Context, Obj } from './refs.js';
2
- export declare function processResponse(ctx: Context, input: unknown, op?: Obj): void;
@@ -1 +0,0 @@
1
- export declare function fixUpSchema(root: unknown): void;
@@ -1,7 +0,0 @@
1
- /**
2
- * Converts a Swagger 2.0 document to OpenAPI 3.2.0. The input is never mutated. An OpenAPI 3.x
3
- * input is returned as a copy with only its `info` and `paths` patched. Throws an `Error` when the
4
- * version is unsupported, `info` is not an object, or two security schemes, parameters or
5
- * responses sanitise to the same component name.
6
- */
7
- export declare function convertSwaggerToOpenApi(document: Record<string, unknown>): Record<string, unknown>;
@@ -1,9 +0,0 @@
1
- import type { SliceContentKind, SpecSliceScope } from './types.js';
2
- export declare const ASSISTANT_LINK_BASES: {
3
- readonly chatgpt: 'https://chatgpt.com';
4
- readonly claude: 'https://claude.ai/new';
5
- };
6
- export declare const MAX_ASSISTANT_URL_LENGTH = 8000;
7
- export declare function buildInlinePromptLink(baseUrl: string, content: string, contentKind?: SliceContentKind): string | undefined;
8
- export declare function describeSliceScope(scope: SpecSliceScope): string | undefined;
9
- export declare function buildFetchSpecPromptLink(baseUrl: string, specUrl: string, scope: SpecSliceScope): string;
@@ -1,5 +0,0 @@
1
- import type { SpecSliceScope } from './types.js';
2
- export declare function scopeFromAsyncApiPointer(pointer: string): SpecSliceScope | undefined;
3
- export declare function extractAsyncApiSlice(document: Record<string, unknown>, scope: SpecSliceScope): {
4
- document: Record<string, unknown>;
5
- } | undefined;
@@ -1 +0,0 @@
1
- export declare function cloneStrip(value: unknown, inlineTargets: ReadonlyMap<string, unknown>): unknown;