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,60 +0,0 @@
1
- import type { Atom } from 'jotai';
2
- export type ItemStore = {
3
- activeDiscriminator: Record<string, number>;
4
- activeOneOf: Record<string, number>;
5
- activeResponseCode: string;
6
- activeExampleKey: string;
7
- activeMessageKey: string;
8
- selectedCallback: string;
9
- expandableSections: Record<string, boolean | undefined>;
10
- collapsibles: Record<string, boolean>;
11
- };
12
- export type ItemStoreKey = keyof ItemStore;
13
- export type ItemStoreFieldParams<K extends ItemStoreKey = ItemStoreKey> = {
14
- itemId: string;
15
- key: K;
16
- };
17
- type ItemStoreUpdate = Partial<ItemStore> | ((current: ItemStore) => Partial<ItemStore>);
18
- export declare const itemStoreAtom: import("jotai-family").AtomFamily<string, import("jotai").WritableAtom<ItemStore, [update: ItemStoreUpdate], void>>;
19
- export declare function itemStoreFieldAtom<K extends ItemStoreKey>(params: ItemStoreFieldParams<K>): Atom<ItemStore[K]>;
20
- export type VariantSection = {
21
- t?: string;
22
- c?: string;
23
- cb?: string;
24
- schemaId?: string;
25
- };
26
- export declare const REQUEST_VARIANT_SECTION: VariantSection;
27
- export declare function buildVariantStoreId(itemId: string, section: VariantSection | null | undefined): string;
28
- export declare function buildVariantStateKey(parentPath: ReadonlyArray<string> | undefined, localPart: string): string;
29
- export type DeepLinkSectionData = {
30
- /** Route-level item id (slug) */
31
- id: string;
32
- /** "request" | "response" for OpenAPI body/param sections */
33
- t?: string;
34
- /** "query" | "header" | "path" | "cookie" for OpenAPI parameter location */
35
- in?: string;
36
- /** Response status code */
37
- c?: string;
38
- /** Callback id */
39
- cb?: string;
40
- /** Content-type name (when multiple media types) */
41
- ct?: string;
42
- /** When true, nested field deep-links use `path=<field>` only */
43
- pathOnly?: boolean;
44
- schemaId?: string;
45
- /** AsyncAPI message key */
46
- messageKey?: string;
47
- /** AsyncAPI sub-section: "headers" | "payload" | "send" | "receive" | "parameters" | "messages" */
48
- asyncSection?: string;
49
- /** GraphQL type section: "field" | "argument" | "return-type" | "possible-types" | "implements" | "enum-value" */
50
- graphqlType?: string;
51
- /** GraphQL parent type name (e.g. "Query", "User") */
52
- graphqlTypeName?: string;
53
- };
54
- export declare function activeDiscriminatorSelectAtom(itemId: string): Atom<ItemStore['activeDiscriminator']>;
55
- export declare function activeOneOfSelectAtom(itemId: string): Atom<ItemStore['activeOneOf']>;
56
- export declare function expandableSectionAtom(itemId: string, key: string): Atom<boolean | undefined>;
57
- export declare function buildCollapsibleEntryKey(sectionKey: string, instanceId: string): string;
58
- export declare function collapsibleEntrySection(entryKey: string): string;
59
- export declare function expandableSectionKeysAtom(itemId: string): Atom<string[]>;
60
- export {};
@@ -1,4 +0,0 @@
1
- import type { RouteIndex } from '../utils/routing.js';
2
- export declare const routeIndexAtom: import("jotai").PrimitiveAtom<RouteIndex | null> & {
3
- init: RouteIndex | null;
4
- };
@@ -1,3 +0,0 @@
1
- import type { SchemaEntry } from '../types/store.js';
2
- export declare const schemaStoreAtom: import("jotai").Atom<Record<string, SchemaEntry>>;
3
- export declare const schemaEntryAtom: import("jotai-family").AtomFamily<string, import("jotai").Atom<SchemaEntry | undefined>>;
@@ -1,22 +0,0 @@
1
- import type { ApiItem, ApiStore } from '../types/store.js';
2
- import type { ApiSpecType } from '../types/common.js';
3
- import type { ApiDocsOptions } from '../types/options.js';
4
- export type GlobalStoreAtom = {
5
- items: ApiItem[];
6
- store: ApiStore;
7
- options: ApiDocsOptions;
8
- definition?: Record<string, unknown> | string;
9
- definitionUrl?: string;
10
- };
11
- export declare const globalStoreAtom: import("jotai").PrimitiveAtom<GlobalStoreAtom> & {
12
- init: GlobalStoreAtom;
13
- };
14
- export declare const globalItemsAtom: import("jotai").Atom<ApiItem[]>;
15
- /** Maps a component-schema name to the route slug of its schema-definition page (if it has one). */
16
- export declare const schemaDefinitionSlugMapAtom: import("jotai").Atom<Record<string, string>>;
17
- export declare const globalOptionsAtom: import("jotai").Atom<ApiDocsOptions>;
18
- export declare const specTypeAtom: import("jotai").Atom<ApiSpecType>;
19
- export declare const routingBasePathAtom: import("jotai").Atom<string>;
20
- export declare const storeAtom: import("jotai").Atom<ApiStore>;
21
- export declare const definitionAtom: import("jotai").Atom<string | Record<string, unknown> | undefined>;
22
- export declare const definitionUrlAtom: import("jotai").Atom<string | undefined>;
@@ -1,46 +0,0 @@
1
- import type { EventType } from '@redocly/redoc-opentelemetry';
2
- export type NavigationCause = 'sidebar' | 'search' | 'referencedIn' | 'history';
3
- export type TelemetrySession = {
4
- firstInteractionMs?: number;
5
- sections: ReadonlySet<string>;
6
- sidebarClicks: number;
7
- schemaExpands: number;
8
- maxSchemaDepth: number;
9
- searches: number;
10
- interactions: number;
11
- hiddenCount: number;
12
- hiddenMs: number;
13
- hiddenSince?: number;
14
- schemaExpandEvents: number;
15
- cappedEvents: boolean;
16
- };
17
- /** Per-load cap on `schemaField.expanded` events sent over the network; counters stay complete. */
18
- export declare const SCHEMA_EXPAND_EVENT_CAP = 50;
19
- export declare const telemetrySessionAtom: import("jotai").PrimitiveAtom<TelemetrySession> & {
20
- init: TelemetrySession;
21
- };
22
- /** Counts one UI event; returns `false` when the event is over the per-load cap and must not be sent. */
23
- export declare const recordTelemetryEventAtom: import("jotai").WritableAtom<null, [{
24
- event: EventType;
25
- data: unknown[];
26
- }], boolean> & {
27
- init: null;
28
- };
29
- export declare const recordSectionViewedAtom: import("jotai").WritableAtom<null, [sectionId: string], void> & {
30
- init: null;
31
- };
32
- export declare const recordVisibilityAtom: import("jotai").WritableAtom<null, [hidden: boolean], void> & {
33
- init: null;
34
- };
35
- export declare const navigationCauseAtom: import("jotai").PrimitiveAtom<{
36
- via: NavigationCause;
37
- at: number;
38
- } | null> & {
39
- init: {
40
- via: NavigationCause;
41
- at: number;
42
- } | null;
43
- };
44
- export declare const markNavigationCauseAtom: import("jotai").WritableAtom<null, [via: NavigationCause], void> & {
45
- init: null;
46
- };
@@ -1,10 +0,0 @@
1
- import { LayoutVariant } from '@redocly/config';
2
- export declare const DEFAULT_LAYOUT = LayoutVariant.THREE_PANEL;
3
- export declare const DEFAULT_MAX_DISPLAYED_ENUM_VALUES = 10;
4
- export declare const DEFAULT_ROUTING_BASE_PATH = "";
5
- export declare const GRAPHQL_DEFAULT_JSON_SAMPLES_DEPTH = 1;
6
- export declare const ASYNCAPI_DEFAULT_JSON_SAMPLES_DEPTH = 3;
7
- export declare const GRAPHQL_DEFAULT_SAMPLES_MAX_INLINE_ARGS = 2;
8
- export declare const GRAPHQL_DEFAULT_FIELD_EXPAND_LEVEL = 4;
9
- export declare const JSON_SAMPLES_EXPAND_LEVEL_DEFAULT = 2;
10
- export declare const GENERATED_SAMPLES_MAX_DEPTH_DEFAULT = 8;
@@ -1,3 +0,0 @@
1
- import type { RawApiDocsOptions } from '../types/options.js';
2
- /** Option overrides applied on top of host options in `normalizeOptions`. */
3
- export declare const EDITION_OPTION_OVERRIDES: Partial<RawApiDocsOptions>;
@@ -1,19 +0,0 @@
1
- import { LayoutVariant, type RedocConfig } from '@redocly/config';
2
- import type { ApiSpecType } from '../types/common.js';
3
- import type { RawApiDocsOptions } from '../types/options.js';
4
- import type { CodeSamplesConfig } from '../types/code-samples-config.js';
5
- export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
6
- export declare function argValueToNumber(value: number | string | undefined, defaultValue?: number): number;
7
- export declare function argValueToInt(value: number | string | undefined, defaultValue?: number): number;
8
- export declare function argValueToExpandLevel(value?: number | string | undefined, defaultValue?: number): number | undefined;
9
- export declare function normalizePath(path: string): string;
10
- export declare function normalizeShowExtensions(value: RedocConfig['showExtensions']): string[] | boolean;
11
- /** Normalize scrollYOffset for OpenAPI options. Safe for SSR: no DOM (querySelector). */
12
- export declare function normalizeScrollYOffset(value: RedocConfig['scrollYOffset']): () => number;
13
- export declare function normalizeCodeSamples(value?: RedocConfig['codeSamples']): CodeSamplesConfig;
14
- export declare function normalizeIgnoreNamedSchemas(value: RawApiDocsOptions['ignoreNamedSchemas']): string[];
15
- export declare function normalizeDownloadUrls(downloadUrls: unknown, type: ApiSpecType): {
16
- title: string;
17
- url: string;
18
- }[];
19
- export declare function normalizeLayout(layout: RawApiDocsOptions['layout']): LayoutVariant;
@@ -1,2 +0,0 @@
1
- import type { ApiDocsOptions, RawApiDocsOptions } from '../types/options.js';
2
- export declare function normalizeOptions(rawOptions: RawApiDocsOptions): ApiDocsOptions;
@@ -1,3 +0,0 @@
1
- import type { CSSProperties } from 'react';
2
- import type { ApiDocsOptions } from '../types/options.js';
3
- export declare function getStandaloneLayoutStyle({ scrollYOffset }: ApiDocsOptions): CSSProperties;
@@ -1,10 +0,0 @@
1
- export declare const ATTR_EXCEPTION_MESSAGE = "exception.message";
2
- export declare const ATTR_EXCEPTION_STACKTRACE = "exception.stacktrace";
3
- export declare const ATTR_EXCEPTION_TYPE = "exception.type";
4
- export declare const ATTR_SERVICE_NAME = "service.name";
5
- export declare const ATTR_SERVICE_VERSION = "service.version";
6
- export declare const ATTR_TELEMETRY_SDK_LANGUAGE = "telemetry.sdk.language";
7
- export declare const ATTR_TELEMETRY_SDK_NAME = "telemetry.sdk.name";
8
- export declare const ATTR_TELEMETRY_SDK_VERSION = "telemetry.sdk.version";
9
- export declare const TELEMETRY_SDK_LANGUAGE_VALUE_NODEJS = "nodejs";
10
- export declare const TELEMETRY_SDK_LANGUAGE_VALUE_WEBJS = "webjs";
@@ -1,25 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { RouteIndex } from '../utils/routing.js';
3
- type EntryPageProps = {
4
- routeIndex: RouteIndex;
5
- basePath: string;
6
- };
7
- /**
8
- * Renders the whole API as one persistent tree with two layers of laziness:
9
- *
10
- * 1. **Top-level LazySections** — one per top-level entry (root page,
11
- * every top-level tag, any standalone non-tag route). Each
12
- * observer-mounts when scrolled near the viewport and stays mounted.
13
- *
14
- * 2. **Ops inside a tag** — when the tag is in scope (active route OR an
15
- * ancestor of the active route), every op renders as a nested
16
- * LazySection. The active op is eager; the rest are placeholders that
17
- * observer-mount on scroll. When the tag goes out of scope, its ops
18
- * unmount; the active op of the new tag becomes eager.
19
- *
20
- * Section pointer routes (`route.content === null`) live inside the root
21
- * page's overview body — when one is active, the root page is eager.
22
- */
23
- declare function EntryPageComponent({ routeIndex, basePath }: EntryPageProps): ReactElement;
24
- export declare const EntryPage: import("react").MemoExoticComponent<typeof EntryPageComponent>;
25
- export {};
@@ -1 +0,0 @@
1
- export declare const GroupPage: import("react").FC<any>;
@@ -1 +0,0 @@
1
- export declare const ItemPage: import("react").FC<any>;
@@ -1,6 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- type NotFoundPageProps = {
3
- routingBasePath: string;
4
- };
5
- export declare function NotFoundPage({ routingBasePath }: NotFoundPageProps): ReactElement;
6
- export {};
@@ -1 +0,0 @@
1
- export declare const OverviewPage: import("react").FC<any>;
@@ -1,17 +0,0 @@
1
- import type { ReactElement } from 'react';
2
- import type { TopLevelEntry } from '../utils/routing.js';
3
- type TopLevelEntryViewProps = {
4
- entry: TopLevelEntry;
5
- activePath: string | undefined;
6
- entryEager: boolean;
7
- eagerOpSlug: string | null;
8
- shouldRenderOps: boolean;
9
- opsStartIndex?: number;
10
- renderEntrySection?: boolean;
11
- };
12
- /** Renders one top-level entry as a LazySection plus, when in scope, its op
13
- * LazySections. The op LazySections are siblings (not children) of the
14
- * entry's LazySection so the entry's memo bail doesn't keep a stale `eager`
15
- * prop on the active op during sibling-op navigation. */
16
- export declare const TopLevelEntryView: import("react").MemoExoticComponent<({ entry, activePath, entryEager, eagerOpSlug, shouldRenderOps, opsStartIndex, renderEntrySection, }: TopLevelEntryViewProps) => ReactElement>;
17
- export {};
@@ -1,10 +0,0 @@
1
- import type { AgentTool, ApiDocsAgentToolsParams } from './types.js';
2
- export { agentTextResult } from './results.js';
3
- export { registerAgentTools } from './webmcp.js';
4
- export { createSpecSliceOperationDetail } from './spec-slice-detail.js';
5
- export type { AgentTool, ApiDocsAgentToolsParams, } from './types.js';
6
- /**
7
- * Tools describing the API rendered on the current page. A host supplies how its URLs are shaped
8
- * and where operation detail comes from; everything else is read from the item tree and store.
9
- */
10
- export declare function buildApiDocsAgentTools({ items, store, resolveDocUrl, getOperationDetail }: ApiDocsAgentToolsParams): AgentTool[];
@@ -1,20 +0,0 @@
1
- import type { ApiItem } from '../../types/store.js';
2
- import type { ApiOperationSummary } from './types.js';
3
- /**
4
- * Request path of an OpenAPI operation, from its pointer: `/paths/~1museum-hours/get` is
5
- * `GET /museum-hours`. AsyncAPI channel pointers hold an identifier rather than an address,
6
- * so they are left without a path.
7
- */
8
- export declare function pathFromPointer(pointer: string | undefined): string | undefined;
9
- /**
10
- * Flattens the navigation tree into the operations it documents: HTTP operations, webhooks,
11
- * AsyncAPI channel operations, `x-mcp` entities, and GraphQL queries, mutations and subscriptions.
12
- */
13
- export declare function collectOperations(items: ApiItem[], resolveDocUrl?: (link: string) => string): ApiOperationSummary[];
14
- /** Matches on a documentation URL when given one, otherwise on method and path or title. */
15
- export declare function findOperation(operations: ApiOperationSummary[], criteria: {
16
- url?: string;
17
- method?: string;
18
- path?: string;
19
- }): ApiOperationSummary | undefined;
20
- export declare function filterOperations(operations: ApiOperationSummary[], query: string): ApiOperationSummary[];
@@ -1,6 +0,0 @@
1
- import type { AgentToolResult } from './types.js';
2
- /** Longest text one tool result may carry. */
3
- export declare const MAX_AGENT_RESULT_CHARS = 24000;
4
- export declare function agentTextResult(text: string): AgentToolResult;
5
- export declare function agentJsonResult(value: unknown): AgentToolResult;
6
- export declare function agentErrorResult(message: string): AgentToolResult;
@@ -1,13 +0,0 @@
1
- import type { ApiStore } from '../../types/store.js';
2
- type ApiSecuritySummary = {
3
- servers: Array<{
4
- url: string;
5
- description?: string;
6
- }>;
7
- securitySchemes: Array<Record<string, unknown> & {
8
- id: string;
9
- }>;
10
- };
11
- /** Servers and security schemes of the documented API, with every stored credential removed. */
12
- export declare function summarizeSecurity(store: ApiStore): ApiSecuritySummary;
13
- export {};
@@ -1,12 +0,0 @@
1
- import type { ApiSpecType } from '../../types/common.js';
2
- import type { ApiItem } from '../../types/store.js';
3
- import type { ApiOperationSummary } from './types.js';
4
- type SpecSliceDetailParams = {
5
- items: ApiItem[];
6
- specType: ApiSpecType;
7
- /** The bundled definition, or GraphQL SDL. */
8
- definition: Record<string, unknown> | string;
9
- };
10
- /** Operation detail for hosts that hold the definition: the slice the page actions copy. */
11
- export declare function createSpecSliceOperationDetail({ items, specType, definition }: SpecSliceDetailParams): (operation: ApiOperationSummary) => Promise<string | undefined>;
12
- export {};
@@ -1,55 +0,0 @@
1
- import type { ApiItem, ApiStore } from '../../types/store.js';
2
- /** One operation of the documented API, flattened out of the navigation tree. */
3
- export type ApiOperationSummary = {
4
- /** Upper-case HTTP method, or the entity kind for items such as `x-mcp` tools. */
5
- method: string;
6
- title: string;
7
- /** Documentation URL, already in the host's URL space. */
8
- url: string;
9
- path?: string;
10
- /** Tag or group the operation is listed under. */
11
- section?: string;
12
- deprecated?: boolean;
13
- };
14
- export type AgentToolResult = {
15
- content: Array<{
16
- type: 'text';
17
- text: string;
18
- }>;
19
- isError?: boolean;
20
- };
21
- /** Hints an agent uses to decide whether a tool is safe to call unattended. */
22
- type AgentToolAnnotations = {
23
- readOnlyHint?: boolean;
24
- untrustedContentHint?: boolean;
25
- /** The tool changes something outside the page, so an agent should confirm before calling it. */
26
- consequentialHint?: boolean;
27
- };
28
- /** A tool an agent can read and call, in the shape both WebMCP and MCP accept. */
29
- export type AgentTool = {
30
- name: string;
31
- title: string;
32
- description: string;
33
- inputSchema?: Record<string, unknown>;
34
- annotations?: AgentToolAnnotations;
35
- execute: (input: Record<string, unknown>, options?: {
36
- signal?: AbortSignal;
37
- }) => Promise<AgentToolResult>;
38
- };
39
- export type ApiDocsAgentToolsParams = {
40
- items: ApiItem[];
41
- store: ApiStore;
42
- /** Rewrites an item link into the host's URL space; identity when omitted. */
43
- resolveDocUrl?: (link: string) => string;
44
- /** Full reference text for one operation; without it `get_api_operation` returns the summary. */
45
- getOperationDetail?: (operation: ApiOperationSummary, options?: {
46
- signal?: AbortSignal;
47
- }) => Promise<string | undefined>;
48
- };
49
- export type AgentToolOutcome = 'answered' | 'rejected' | 'failed';
50
- /** How a host records use of the tools. */
51
- export type AgentToolsTelemetry = {
52
- registered: (toolCount: number) => void;
53
- called: (toolName: string, outcome: AgentToolOutcome) => void;
54
- };
55
- export {};
@@ -1,14 +0,0 @@
1
- import type { AgentTool, AgentToolsTelemetry } from './types.js';
2
- type ModelContextLike = {
3
- registerTool: (tool: Record<string, unknown>, options?: {
4
- signal?: AbortSignal;
5
- }) => Promise<void> | void;
6
- };
7
- /** The browser's WebMCP entry point: `document.modelContext`, then `navigator.modelContext`. */
8
- export declare function getModelContext(): ModelContextLike | undefined;
9
- /**
10
- * Registers every tool with the browser; aborting the shared signal unregisters them all.
11
- * Returns the names that registered; none when the browser has no WebMCP.
12
- */
13
- export declare function registerAgentTools(tools: AgentTool[], signal: AbortSignal, telemetry?: AgentToolsTelemetry): Promise<string[]>;
14
- export {};
@@ -1,3 +0,0 @@
1
- type RawSchema = Record<string, unknown> | undefined;
2
- export declare function convertSampleToString(sample: unknown, mime: string, schema?: RawSchema, repeat?: boolean): unknown;
3
- export {};
@@ -1,65 +0,0 @@
1
- import type { SchemaEntry } from '../../types/store.js';
2
- type EffectiveDiscriminator = {
3
- propertyName: string;
4
- mapping: Record<string, string>;
5
- defaultMapping?: string;
6
- variantsNode?: Record<string, unknown>;
7
- };
8
- export declare function findEffectiveDiscriminator(schemaData: Record<string, unknown> | undefined, schemaStore: Record<string, SchemaEntry>, visited?: Set<string>): EffectiveDiscriminator | undefined;
9
- type SchemaVariantOption = {
10
- label: string;
11
- schemaId: string;
12
- mappingKey?: string;
13
- isDefaultMapping?: boolean;
14
- isDeprecated?: boolean;
15
- };
16
- export type SchemaVariantAxis = {
17
- kind: 'discriminator' | 'oneOf' | 'anyOf';
18
- stateKey: string;
19
- options: SchemaVariantOption[];
20
- localPart: string;
21
- parentPath: string[];
22
- };
23
- export declare function collectNestedVariantAxes(schemaData: Record<string, unknown> | undefined, schemaStore: Record<string, SchemaEntry>, out?: Map<string, SchemaVariantAxis>, visitedRefs?: Set<string>, path?: string[]): Map<string, SchemaVariantAxis>;
24
- export declare function findSchemaVariantAxis(schemaId: string, schemaStore: Record<string, SchemaEntry>, { includeNested }?: {
25
- includeNested?: boolean;
26
- }): SchemaVariantAxis | undefined;
27
- export declare function resolveActiveVariantIndex(axis: SchemaVariantAxis, activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>): number;
28
- export type SchemaVariantPick = {
29
- axis: SchemaVariantAxis;
30
- idx: number;
31
- };
32
- export type SchemaVariantLeaf = SchemaVariantOption & {
33
- key: string;
34
- /** The option to select on each axis, outermost first. */
35
- picks: SchemaVariantPick[];
36
- };
37
- type VariantState = {
38
- activeDiscriminator?: Record<string, number>;
39
- activeOneOf?: Record<string, number>;
40
- };
41
- /**
42
- * Whether the store rewrite samples `hostData` as the selected variant merged with the
43
- * host's own keywords: the host declares the axis itself (not through an inherited
44
- * discriminator), and the variant is not a discriminator host whose own variant would be lost.
45
- */
46
- export declare function samplesVariantThroughHost(hostData: Record<string, unknown> | undefined, variantData: Record<string, unknown> | undefined): boolean;
47
- /** Whether the sampler store rewrites this host: it declares the axis rather than inheriting it. */
48
- export declare function declaresVariantAxis(hostData: Record<string, unknown> | undefined): boolean;
49
- export declare function findSchemaVariantLeaves(schemaId: string, schemaStore: Record<string, SchemaEntry>, options?: {
50
- includeNested?: boolean;
51
- }): SchemaVariantLeaf[] | undefined;
52
- /** The state fields selecting `picks` changes: each axis writes to the record its kind owns. */
53
- export declare function withVariantPicks(state: VariantState, picks: readonly SchemaVariantPick[]): VariantState;
54
- export declare function resolveActiveVariantLeafIndex(leaves: SchemaVariantLeaf[], activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>): number;
55
- /**
56
- * Deep-collapse inline nested variant axes to the active option so generated
57
- * samples follow the switcher: oneOf/anyOf collapse to the active branch
58
- * (default 0) — so null branches sample as `null`: the sampler turns any
59
- * surviving `oneOf: [{type: 'null'}]` wrapper into `{}` — and inline
60
- * discriminator hosts collapse to the active variant with its mapping key
61
- * stamped. Returns a structural clone.
62
- */
63
- export declare function applyActiveVariantsToSchema(data: Record<string, unknown>, schemaStore: Record<string, SchemaEntry>, activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>, parentPath?: string[]): Record<string, unknown>;
64
- export declare function applyActiveVariantsToStore(schemaStore: Record<string, SchemaEntry>, activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>): Record<string, Record<string, unknown>>;
65
- export {};
@@ -1,13 +0,0 @@
1
- type ResolveExample = (id: string) => {
2
- key?: string;
3
- } | undefined;
4
- /**
5
- * Resolves a spec-level example key to a store example id.
6
- * Spec-level keys (e.g. `beta` under `examples:`) never equal the generated
7
- * store ids (`example_N`), so the lookup goes through the entry's `key`;
8
- * direct id equality is kept for callers that already hold a store id.
9
- * Keys are matched across the whole list before falling back to id equality,
10
- * so an author key that happens to look like a store id can't be shadowed.
11
- */
12
- export declare function findExampleIdByKey(exampleIds: string[] | undefined, key: string | undefined, resolveExample: ResolveExample): string | undefined;
13
- export {};
@@ -1,2 +0,0 @@
1
- export type * from './source.js';
2
- export { convertSampleToString } from './convertSampleToString.js';
@@ -1,4 +0,0 @@
1
- /** Community edition: only the payload tab and languages with spec-provided `x-codeSamples` are offered. */
2
- export declare function filterAvailableLanguages<L extends {
3
- key: string;
4
- }>(languages: L[], definitionSampleKeys: Set<string>): L[];
@@ -1,3 +0,0 @@
1
- import type { OpenAPIServer } from '../../types/openapi.js';
2
- export declare function resolveServerUrl(url: string, specUrl?: string): string;
3
- export declare function normalizeServers(specUrl: string | undefined, servers: OpenAPIServer[]): OpenAPIServer[];
@@ -1,3 +0,0 @@
1
- import type { OpenAPIServer } from '../../types/openapi.js';
2
- /** Seeds one environment per global server so a saved environment name can resolve to a server in a fresh session. */
3
- export declare function buildServerEnvValues(servers: OpenAPIServer[]): Record<string, Record<string, string>>;
@@ -1,9 +0,0 @@
1
- type ServerWithVariables = {
2
- url: string;
3
- variables?: Record<string, {
4
- default?: string;
5
- }>;
6
- };
7
- /** Substitutes `{variable}` placeholders in a server URL with the variables' default values. */
8
- export declare function replaceServerVariables(server: ServerWithVariables): string;
9
- export {};
@@ -1,81 +0,0 @@
1
- import type { OpenAPIParameterLocation } from '../../types/openapi.js';
2
- import type { SecuritySchemeIn, SecuritySchemeType, securitySchemeType, panelKind } from '../../types/common.js';
3
- import type { OAuthFlowsData } from '../../types/store.js';
4
- type ServerVariable = {
5
- default?: string;
6
- enum?: string[];
7
- description?: string;
8
- };
9
- export type ServerEntry = {
10
- url: string;
11
- name?: string;
12
- description?: string;
13
- variables?: Record<string, ServerVariable>;
14
- };
15
- export type ParameterEntry = {
16
- name: string;
17
- in: OpenAPIParameterLocation;
18
- required?: boolean;
19
- deprecated?: boolean;
20
- example?: unknown;
21
- schemaId?: string;
22
- serializationMime?: string;
23
- style?: string;
24
- explode?: boolean;
25
- allowReserved?: boolean;
26
- };
27
- export type SecuritySchemeEntry = {
28
- id: string;
29
- type: Exclude<SecuritySchemeType, typeof securitySchemeType.MUTUAL_TLS>;
30
- name?: string;
31
- in?: SecuritySchemeIn;
32
- scheme?: string;
33
- bearerFormat?: string;
34
- openIdConnectUrl?: string;
35
- flows?: OAuthFlowsData;
36
- };
37
- /** One AND-group: all schemes in the array must be satisfied together */
38
- export type SecurityRequirement = {
39
- schemes: SecuritySchemeEntry[];
40
- scopes: string[];
41
- };
42
- export type MediaTypeEntry = {
43
- schemaId?: string;
44
- exampleIds?: string[];
45
- };
46
- type DefinitionCodeSample = {
47
- lang: string;
48
- label?: string;
49
- source: string;
50
- };
51
- export type CodeSampleSource = {
52
- kind: typeof panelKind.CODE_SAMPLE;
53
- operationType: 'http' | 'webhook' | 'callback';
54
- method: string;
55
- path: string;
56
- servers: ServerEntry[];
57
- parameters: {
58
- path: ParameterEntry[];
59
- query: ParameterEntry[];
60
- querystring: ParameterEntry[];
61
- header: ParameterEntry[];
62
- cookie: ParameterEntry[];
63
- };
64
- security: SecurityRequirement[];
65
- /** mediaType name → { schemaId, exampleIds } */
66
- requestBody?: Record<string, MediaTypeEntry>;
67
- /** Pre-authored code samples from the spec (x-codeSamples) */
68
- definitionSamples?: DefinitionCodeSample[];
69
- /** Response status codes (for generators that include expected status) */
70
- responseCodes?: string[];
71
- /** Raw pointer into the spec (for deep linking) */
72
- pointer?: string;
73
- /** Docs route slug of the operation page, relative to the routing base path
74
- * (e.g. `operations/getmuseumhours`) — lets hosts link back to the description */
75
- href?: string;
76
- /** OpenAPI `operationId` — should match the loaded spec so hosts can resolve the operation */
77
- openApiOperationId?: string;
78
- /** OpenAPI operation `summary` — the human-readable operation name */
79
- summary?: string;
80
- };
81
- export {};
@@ -1 +0,0 @@
1
- export declare const GraphqlSchemaDialectId: 'graphql-schema';
@@ -1,7 +0,0 @@
1
- import type { SchemaProcessorDialect, Document } from '../../../types/schema.js';
2
- export declare function getImplicitDiscriminatorChildren(document: Document): Record<string, Array<{
3
- ref: string;
4
- value: string;
5
- }>>;
6
- export declare const JsonSchemaDialectId: "json-schema";
7
- export declare const jsonSchemaDialect: SchemaProcessorDialect;
@@ -1 +0,0 @@
1
- export { schemaProcessor as processSchema } from './schemaProcessor.js';