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,163 +0,0 @@
1
- import type { Node } from '@markdoc/markdoc';
2
- export type ObjectValues<T> = T[keyof T];
3
- export type OpenAPIRef = {
4
- $ref: string;
5
- 'x-refsStack'?: string[];
6
- summary?: string;
7
- description?: string | Node[] | Node;
8
- };
9
- export type Referenced<T> = T | OpenAPIRef;
10
- export type ExternalDocsData = {
11
- url: string;
12
- description?: string | Node[] | Node;
13
- };
14
- export type BadgeData = {
15
- name: string;
16
- color?: string;
17
- position?: 'before' | 'after';
18
- icon?: string;
19
- description?: string;
20
- };
21
- export type Badge = {
22
- name: string;
23
- color?: string;
24
- icon?: string;
25
- description?: string;
26
- };
27
- export type ServerData = {
28
- url: string;
29
- name?: string;
30
- description?: string;
31
- variables?: Record<string, {
32
- enum?: string[];
33
- default: string;
34
- description?: string | Node[] | Node;
35
- examples?: string[];
36
- }>;
37
- };
38
- export declare const apiSpecType: {
39
- readonly OPENAPI: 'openapi';
40
- readonly ASYNCAPI: 'asyncapi';
41
- readonly GRAPHQL: 'graphql';
42
- };
43
- export type ApiSpecType = ObjectValues<typeof apiSpecType>;
44
- export declare const contentType: {
45
- readonly OVERVIEW: 'overview';
46
- readonly GROUP: 'group';
47
- readonly ITEM: 'item';
48
- };
49
- export type ContentType = ObjectValues<typeof contentType>;
50
- export declare const itemVariant: {
51
- readonly HTTP_ITEM: 'httpItem';
52
- readonly SCHEMA: 'schema';
53
- readonly CHANNEL: 'channel';
54
- readonly CHANNEL_OPERATION: 'channelOperation';
55
- readonly MESSAGE: 'message';
56
- readonly QUERY: 'query';
57
- readonly MUTATION: 'mutation';
58
- readonly SUBSCRIPTION: 'subscription';
59
- readonly DIRECTIVE: 'directive';
60
- readonly OBJECT: 'object';
61
- readonly INTERFACE: 'interface';
62
- readonly INPUT: 'input';
63
- readonly UNION: 'union';
64
- readonly ENUM: 'enum';
65
- readonly SCALAR: 'scalar';
66
- readonly MARKDOWN: 'markdown';
67
- };
68
- export type ItemVariant = ObjectValues<typeof itemVariant>;
69
- export declare const securitySchemeType: {
70
- readonly API_KEY: 'apiKey';
71
- readonly HTTP: 'http';
72
- readonly OAUTH2: 'oauth2';
73
- readonly OPEN_ID_CONNECT: 'openIdConnect';
74
- readonly MUTUAL_TLS: 'mutualTLS';
75
- };
76
- export type SecuritySchemeType = ObjectValues<typeof securitySchemeType>;
77
- export declare const asyncApiSecuritySchemeType: {
78
- readonly USER_PASSWORD: 'userPassword';
79
- readonly API_KEY: 'apiKey';
80
- readonly X509: 'X509';
81
- readonly SYMMETRIC_ENCRYPTION: 'symmetricEncryption';
82
- readonly ASYMMETRIC_ENCRYPTION: 'asymmetricEncryption';
83
- readonly HTTP_API_KEY: 'httpApiKey';
84
- readonly HTTP: 'http';
85
- readonly OAUTH2: 'oauth2';
86
- readonly OPEN_ID_CONNECT: 'openIdConnect';
87
- readonly PLAIN: 'plain';
88
- readonly SCRAM_SHA256: 'scramSha256';
89
- readonly SCRAM_SHA512: 'scramSha512';
90
- readonly GSSAPI: 'gssapi';
91
- };
92
- export type AsyncApiSecuritySchemeType = ObjectValues<typeof asyncApiSecuritySchemeType>;
93
- export declare const securitySchemeIn: {
94
- readonly QUERY: 'query';
95
- readonly HEADER: 'header';
96
- readonly COOKIE: 'cookie';
97
- readonly QUERYSTRING: 'querystring';
98
- };
99
- export type SecuritySchemeIn = ObjectValues<typeof securitySchemeIn>;
100
- export declare const nodeTypes: {
101
- readonly CONTAINER: 'container';
102
- readonly HEADER: 'header';
103
- readonly EMPTY_MESSAGE: 'empty-message';
104
- readonly ITEM: 'item-content';
105
- readonly SECURITY: 'security';
106
- readonly MARKDOC: 'markdoc';
107
- readonly ADMONITION: 'admonition';
108
- readonly OVERVIEW_SECTION_WRAPPER: 'overview-section-wrapper';
109
- readonly EXTERNAL_DOCS: 'external-docs';
110
- readonly CHANNEL_ADDRESS: 'channel-address';
111
- readonly MESSAGE_LINKS: 'message-links';
112
- readonly INFO_METADATA: 'info-metadata';
113
- readonly EXTENSIONS: 'extensions';
114
- };
115
- export type NodeTypes = ObjectValues<typeof nodeTypes>;
116
- export declare const panelKind: {
117
- readonly LOCATIONS: 'locations';
118
- readonly GROUP_ITEMS: 'group-items';
119
- readonly EXTERNAL_LINK: 'externallink';
120
- readonly EMAIL: 'email';
121
- readonly PAYLOAD: 'payload';
122
- readonly TAGS: 'tags';
123
- readonly CONNECT_MCP_BUTTON: 'connect-mcp-button';
124
- readonly ATTRIBUTE: 'attribute';
125
- readonly DOWNLOAD: 'download';
126
- readonly SERVERS: 'servers';
127
- readonly BROKERS: 'brokers';
128
- readonly CHANNEL_BINDING: 'channel-binding';
129
- readonly OPERATION_BINDING: 'operation-binding';
130
- readonly MESSAGE_BINDING: 'message-binding';
131
- readonly MESSAGE_REFERENCES: 'message-references';
132
- readonly REFERENCES: 'references';
133
- readonly CODE_SAMPLE: 'code-sample';
134
- readonly CALLBACK_PAYLOAD: 'callback-payload';
135
- readonly RESPONSE: 'response';
136
- readonly GRAPHQL_QUERY: 'graphql-query';
137
- readonly GRAPHQL_RESPONSE: 'graphql-response';
138
- readonly GRAPHQL_VARIABLES: 'graphql-variables';
139
- readonly GRAPHQL_TYPE_SAMPLE: 'graphql-type-sample';
140
- readonly MCP_EXAMPLE: 'mcp-example';
141
- };
142
- export declare const schemaKind: {
143
- readonly JSON_SCHEMA: 'json-schema';
144
- readonly GRAPHQL_TYPE: 'graphql-type';
145
- };
146
- export type SchemaKind = ObjectValues<typeof schemaKind>;
147
- /** A logo as authored, keyed by `url`: OpenAPI `info.x-logo` and the standalone `logo` prop. */
148
- export type RawLogo = {
149
- url?: string;
150
- href?: string;
151
- altText?: string;
152
- backgroundColor?: string;
153
- };
154
- /**
155
- * A logo normalized to what the `SidebarLogo` component renders, keyed by `imageUrl`.
156
- * Also the shape of the `apiLogo` option, which is authored this way already.
157
- */
158
- export type SidebarLogo = {
159
- imageUrl?: string;
160
- href?: string;
161
- altText?: string;
162
- backgroundColor?: string;
163
- };
@@ -1,479 +0,0 @@
1
- import type { AdmonitionProps } from '@redocly/theme/components/Admonition/Admonition';
2
- import type { Node } from '@markdoc/markdoc';
3
- import type { OpenAPIResponse } from './openapi.js';
4
- import type { CodeSampleSource } from '../services/code-samples/index.js';
5
- import type { BadgeData, ServerData, nodeTypes, panelKind } from './common.js';
6
- import type { GroupItem, ApiItemContent, SecuritySchemeEntry } from './store.js';
7
- import type { AsyncAPISchema, BrokerData } from './asyncapi.js';
8
- import type { BadgeType, ExampleType } from './schema.js';
9
- import type { FormFieldEncoding } from '../utils/form-urlencoded.js';
10
- export type { ApiItemContent };
11
- export type ContentNode = ContainerNode | OverviewSectionWrapperNode | HeaderNode | EmptyMessageNode | ItemContentNode | SecurityNode | MarkdocNode | AdmonitionNode | ExternalDocsNode | ChannelAddressNode | MessageLinksNode | InfoMetadataNode | ExtensionsNode;
12
- export type PanelNode = DownloadNode | ServersNode | BrokersNode | ChannelBindingNode | OperationBindingNode | MessageBindingNode | MessageReferencesNode | OverviewNode | McpNode | ExamplesNode | McpExampleNode | ReferencesNode | LocationsPanelNode | GroupItemNode;
13
- export type ContainerNode = {
14
- nodeType: typeof nodeTypes.CONTAINER;
15
- panels?: PanelNode[];
16
- children: ContentNode[];
17
- };
18
- export type OverviewSectionWrapperNode = {
19
- nodeType: typeof nodeTypes.OVERVIEW_SECTION_WRAPPER;
20
- children: ContentNode[];
21
- sectionId: string;
22
- };
23
- export type HeaderNode = {
24
- nodeType: typeof nodeTypes.HEADER;
25
- level: number;
26
- label: string;
27
- labelTranslationKey?: string;
28
- badges?: BadgeData[];
29
- deprecated?: boolean;
30
- isWebhook?: boolean;
31
- showPageActions?: boolean;
32
- protocolTag?: {
33
- label: string;
34
- color?: string;
35
- };
36
- deepLinkSuffix?: string;
37
- graphqlReturnType?: string;
38
- graphqlArgs?: {
39
- name: string;
40
- }[];
41
- graphqlDeprecated?: boolean;
42
- graphqlOperationType?: 'query' | 'mutation' | 'subscription';
43
- };
44
- export type EmptyMessageNode = {
45
- nodeType: typeof nodeTypes.EMPTY_MESSAGE;
46
- label: string;
47
- labelTranslationKey?: string;
48
- };
49
- export type ParameterData = {
50
- name: string;
51
- in?: string;
52
- schemaId: string;
53
- description?: string | Node | Node[];
54
- required?: boolean;
55
- deprecated?: boolean;
56
- example?: unknown;
57
- examples?: Record<string, ExampleType>;
58
- badges?: BadgeType[];
59
- extensions?: Record<string, unknown>;
60
- };
61
- export type GraphqlFieldData = {
62
- name: string;
63
- type: string;
64
- description?: string | Node[] | Node;
65
- deprecated?: boolean;
66
- deprecationReason?: string;
67
- defaultValue?: unknown;
68
- args?: Array<{
69
- name: string;
70
- type: string;
71
- description?: string | Node[] | Node;
72
- deprecationReason?: string;
73
- defaultValue?: unknown;
74
- }>;
75
- };
76
- export type GraphqlReturnTypeData = {
77
- type: string;
78
- description?: string | Node[] | Node;
79
- fields?: GraphqlFieldData[];
80
- };
81
- export type ItemContentNode = {
82
- nodeType: typeof nodeTypes.ITEM;
83
- variant: 'headers' | 'query' | 'querystring' | 'querystring-body' | 'path' | 'parameters' | 'cookies' | 'body' | 'properties' | 'arguments' | 'fields' | 'responses' | 'callback' | 'messages' | 'values' | 'graphql-fields' | 'graphql-args' | 'return-type' | 'possible-types' | 'implements' | 'implemented-by' | 'requires-scopes';
84
- label?: string;
85
- labelTranslationKey?: string;
86
- schemaId?: string;
87
- exampleIds?: string[];
88
- parameters?: ParameterData[];
89
- graphqlSchema?: GraphqlFieldData[] | GraphqlReturnTypeData;
90
- required?: boolean;
91
- /** Webhook/callback body: the server sends it, so readOnly stays and writeOnly is dropped. */
92
- isEvent?: boolean;
93
- mediaTypes?: string[];
94
- mediaTypeSchemas?: Record<string, MediaTypeContent>;
95
- pointer?: string;
96
- description?: string | Node | Node[];
97
- graphqlTypeName?: string;
98
- graphqlFieldName?: string;
99
- graphqlOperationType?: 'query' | 'mutation' | 'subscription';
100
- graphqlInterfaceNames?: string[];
101
- graphqlTypeNames?: string[];
102
- responses?: Array<{
103
- code: string;
104
- summary?: string | Node[] | Node;
105
- description?: string | Node[] | Node;
106
- mediaType?: string;
107
- mediaTypes?: string[];
108
- mediaTypeContent?: Record<string, MediaTypeContent>;
109
- schemaId?: string;
110
- exampleIds?: string[];
111
- headers?: OpenAPIResponse['headers'];
112
- headerSchemaId?: string;
113
- }>;
114
- callback?: {
115
- httpVerb: string;
116
- pathName: string;
117
- summary?: string;
118
- operationId?: string;
119
- description?: string | Node | Node[];
120
- deprecated?: boolean;
121
- callbackName: string;
122
- callbackId: string;
123
- externalDocs?: {
124
- url: string;
125
- description?: string;
126
- };
127
- extensions?: Record<string, unknown>;
128
- contentChildren?: ContentNode[];
129
- };
130
- messages?: Array<{
131
- name: string;
132
- label: string;
133
- summary?: string;
134
- description?: string | Node[] | Node;
135
- contentType?: string;
136
- schemaId?: string;
137
- headerSchemaId?: string;
138
- exampleIds?: string[];
139
- payload?: AsyncAPISchema;
140
- payloadLabel?: string;
141
- headers?: AsyncAPISchema;
142
- externalDocs?: {
143
- url: string;
144
- description?: string | Node[] | Node;
145
- };
146
- correlationId?: {
147
- location: string;
148
- description?: string | Node[] | Node;
149
- };
150
- }>;
151
- values?: Array<{
152
- name: string;
153
- description?: string | Node[] | Node;
154
- deprecated?: boolean;
155
- type?: string;
156
- }>;
157
- };
158
- export type SecuritySchemeDetail = {
159
- name: string;
160
- type?: string;
161
- scheme?: string;
162
- bearerFormat?: string;
163
- in?: string;
164
- paramName?: string;
165
- scopes?: string[];
166
- description?: string | Node[] | Node;
167
- openIdConnectUrl?: string;
168
- oauth2MetadataUrl?: string;
169
- flows?: SecuritySchemeEntry['flows'];
170
- deprecated?: boolean;
171
- };
172
- /** Schemes required together; separate requirements are alternatives. */
173
- export type SecurityRequirementDetail = {
174
- schemes: SecuritySchemeDetail[];
175
- };
176
- export type SecurityNode = {
177
- nodeType: typeof nodeTypes.SECURITY;
178
- requirements: SecurityRequirementDetail[];
179
- };
180
- export type MarkdocNode = {
181
- nodeType: typeof nodeTypes.MARKDOC;
182
- content: string | Node[] | Node;
183
- };
184
- export type AdmonitionNode = {
185
- nodeType: typeof nodeTypes.ADMONITION;
186
- admonitionType: NonNullable<AdmonitionProps['type']>;
187
- name?: string;
188
- nameTranslationKey?: string;
189
- content?: string | Node[] | Node;
190
- };
191
- export type ExternalDocsNode = {
192
- nodeType: typeof nodeTypes.EXTERNAL_DOCS;
193
- url: string;
194
- description: string | Node[] | Node;
195
- };
196
- export type ChannelAddressNode = {
197
- nodeType: typeof nodeTypes.CHANNEL_ADDRESS;
198
- address: string;
199
- };
200
- export type MessageLinksNode = {
201
- nodeType: typeof nodeTypes.MESSAGE_LINKS;
202
- channelLink: string;
203
- messages: Array<{
204
- name: string;
205
- label: string;
206
- }>;
207
- };
208
- export type InfoMetadataRow = {
209
- key: string;
210
- value: string;
211
- };
212
- export type InfoMetadataNode = {
213
- nodeType: typeof nodeTypes.INFO_METADATA;
214
- rows: InfoMetadataRow[];
215
- };
216
- export type ExtensionsNode = {
217
- nodeType: typeof nodeTypes.EXTENSIONS;
218
- extensions: Record<string, unknown>;
219
- };
220
- type PanelItemsByKind<TKind extends PanelItem['kind']> = Extract<PanelItem, {
221
- kind: TKind;
222
- }>;
223
- type SingleChildPanelBase<TKind extends PanelItem['kind']> = {
224
- title?: string;
225
- titleTranslationKey?: string;
226
- children: [PanelItemsByKind<TKind>];
227
- };
228
- type MultiChildPanelBase<TKind extends PanelItem['kind']> = {
229
- title?: string;
230
- titleTranslationKey?: string;
231
- children: PanelItemsByKind<TKind>[];
232
- };
233
- export type PanelTag = {
234
- text: string;
235
- color?: string;
236
- icon?: string;
237
- };
238
- export type DownloadPanelItem = {
239
- kind: typeof panelKind.DOWNLOAD;
240
- label: string;
241
- labelTranslationKey?: string;
242
- url: string;
243
- icon?: string;
244
- };
245
- export type ExternalLinkPanelItem = {
246
- kind: typeof panelKind.EXTERNAL_LINK;
247
- title?: string;
248
- titleTranslationKey?: string;
249
- label: string;
250
- labelTranslationKey?: string;
251
- url: string;
252
- withCopyButton?: boolean;
253
- copyContent?: string;
254
- };
255
- export type EmailPanelItem = {
256
- kind: typeof panelKind.EMAIL;
257
- title?: string;
258
- titleTranslationKey?: string;
259
- email: string;
260
- label: string;
261
- labelTranslationKey?: string;
262
- withCopyButton?: boolean;
263
- copyContent?: string;
264
- };
265
- export type ServersPanelItem = {
266
- kind: typeof panelKind.SERVERS;
267
- servers: ServerData[];
268
- mode?: string;
269
- };
270
- export type BrokersPanelItem = {
271
- kind: typeof panelKind.BROKERS;
272
- panelLabel?: string;
273
- brokers: BrokerData[];
274
- };
275
- export type ChannelBindingPanelItem = {
276
- kind: typeof panelKind.CHANNEL_BINDING;
277
- panelLabel?: string;
278
- bindingKey: string;
279
- bindingValue: Record<string, unknown>;
280
- };
281
- export type OperationBindingPanelItem = {
282
- kind: typeof panelKind.OPERATION_BINDING;
283
- panelLabel?: string;
284
- bindingKey: string;
285
- bindingValue: Record<string, unknown>;
286
- groupIdSchemaId?: string;
287
- clientIdSchemaId?: string;
288
- };
289
- export type KeyValuePanelItem = {
290
- kind: typeof panelKind.ATTRIBUTE;
291
- title?: string;
292
- titleTranslationKey?: string;
293
- label: string;
294
- labelTranslationKey?: string;
295
- value: string;
296
- withCopyButton?: boolean;
297
- copyContent?: string;
298
- };
299
- export type TagsPanelItem = {
300
- kind: typeof panelKind.TAGS;
301
- title?: string;
302
- titleTranslationKey?: string;
303
- tags: PanelTag[];
304
- };
305
- export type ConnectMcpButtonPanelItem = {
306
- kind: typeof panelKind.CONNECT_MCP_BUTTON;
307
- title?: string;
308
- titleTranslationKey?: string;
309
- mcpUrl: string;
310
- actions: string[];
311
- };
312
- export type BaseExamplePanelItem = {
313
- schemaId?: string;
314
- examples: {
315
- name?: string;
316
- summary?: string;
317
- statusCode?: string;
318
- mediaType?: string;
319
- value?: unknown;
320
- }[];
321
- };
322
- export type PayloadExamplesPanelItem = BaseExamplePanelItem & {
323
- kind: typeof panelKind.PAYLOAD;
324
- panelLabel?: string;
325
- exampleIds?: string[];
326
- mediaTypes?: string[];
327
- mediaTypeSchemas?: Record<string, MediaTypeContent>;
328
- messagesByKey?: Record<string, {
329
- schemaId?: string;
330
- exampleIds?: string[];
331
- }>;
332
- };
333
- export type MessageBindingData = {
334
- bindingKey: string;
335
- bindingValue: Record<string, unknown>;
336
- keySchemaId?: string;
337
- };
338
- export type MessageBindingPanelItem = {
339
- kind: typeof panelKind.MESSAGE_BINDING;
340
- panelLabel?: string;
341
- bindingsByMessageKey: Record<string, MessageBindingData>;
342
- };
343
- export type MessageChannelReference = {
344
- key: string;
345
- label: string;
346
- link: string;
347
- };
348
- export type MessageReferencesGroups = {
349
- exchanges: MessageChannelReference[];
350
- queues: MessageChannelReference[];
351
- };
352
- export type MessageReferencesPanelItem = {
353
- kind: typeof panelKind.MESSAGE_REFERENCES;
354
- panelLabel?: string;
355
- referencesByMessageKey: Record<string, MessageReferencesGroups>;
356
- };
357
- export type DefinitionCodeSample = {
358
- lang: string;
359
- label?: string;
360
- source: string;
361
- };
362
- export type CodeSamplePanelItem = BaseExamplePanelItem & {
363
- kind: typeof panelKind.CODE_SAMPLE;
364
- source: CodeSampleSource;
365
- definitionSamples?: DefinitionCodeSample[];
366
- isWebhook?: boolean;
367
- servers?: {
368
- url: string;
369
- name?: string;
370
- description?: string;
371
- variables?: Record<string, {
372
- default?: string;
373
- }>;
374
- }[];
375
- exampleIds?: string[];
376
- mediaTypes?: string[];
377
- mediaTypeSchemas?: Record<string, MediaTypeContent>;
378
- };
379
- export type ResponseExamplesPanelItem = BaseExamplePanelItem & {
380
- kind: typeof panelKind.RESPONSE;
381
- exampleIds?: string[];
382
- responseCodes?: ResponseCodeEntry[];
383
- /** Webhook response: the client sends it, so samples drop readOnly like a request. */
384
- isEvent?: boolean;
385
- hideHeaderTitle?: boolean;
386
- };
387
- export type GraphQLQueryPanelItem = BaseExamplePanelItem & {
388
- kind: typeof panelKind.GRAPHQL_QUERY;
389
- graphqlOperationData?: GraphQLOperationData;
390
- };
391
- export type GraphQLResponsePanelItem = BaseExamplePanelItem & {
392
- kind: typeof panelKind.GRAPHQL_RESPONSE;
393
- graphqlOperationData?: GraphQLOperationData;
394
- };
395
- export type GraphQLVariablesPanelItem = BaseExamplePanelItem & {
396
- kind: typeof panelKind.GRAPHQL_VARIABLES;
397
- graphqlOperationData?: GraphQLOperationData;
398
- };
399
- export type GraphQLTypeSamplePanelItem = BaseExamplePanelItem & {
400
- kind: typeof panelKind.GRAPHQL_TYPE_SAMPLE;
401
- graphqlOperationData?: GraphQLOperationData;
402
- };
403
- export type CallbackPayloadPanelItem = BaseExamplePanelItem & {
404
- kind: typeof panelKind.CALLBACK_PAYLOAD;
405
- callbackName?: string;
406
- path?: string;
407
- httpVerb?: string;
408
- servers?: {
409
- url: string;
410
- name?: string;
411
- description?: string;
412
- variables?: Record<string, {
413
- default?: string;
414
- }>;
415
- }[];
416
- definitionSamples?: DefinitionCodeSample[];
417
- mediaTypes?: string[];
418
- mediaTypeSchemas?: Record<string, MediaTypeContent>;
419
- };
420
- export type ExamplePanelItem = PayloadExamplesPanelItem | CodeSamplePanelItem | ResponseExamplesPanelItem | CallbackPayloadPanelItem | GraphQLQueryPanelItem | GraphQLResponsePanelItem | GraphQLVariablesPanelItem | GraphQLTypeSamplePanelItem;
421
- export type ReferencesPanelItem = {
422
- kind: typeof panelKind.REFERENCES;
423
- graphqlTypeName?: string;
424
- references: {
425
- name: string;
426
- pointer: string;
427
- field?: string;
428
- }[];
429
- };
430
- export type LocationsPanelItem = {
431
- kind: typeof panelKind.LOCATIONS;
432
- locations: string[];
433
- };
434
- export type GroupItemsPanelItem = {
435
- kind: typeof panelKind.GROUP_ITEMS;
436
- title: string;
437
- titleTranslationKey?: string;
438
- items: GroupItem[];
439
- };
440
- export type OverviewPanelItem = ExternalLinkPanelItem | EmailPanelItem | KeyValuePanelItem;
441
- export type McpPanelItem = KeyValuePanelItem | TagsPanelItem | ExternalLinkPanelItem | ConnectMcpButtonPanelItem;
442
- export type McpExamplePanelItem = {
443
- kind: typeof panelKind.MCP_EXAMPLE;
444
- headerTitleTranslationKey: string;
445
- data: unknown;
446
- language?: string;
447
- };
448
- export type PanelItem = DownloadPanelItem | OverviewPanelItem | ServersPanelItem | BrokersPanelItem | ChannelBindingPanelItem | OperationBindingPanelItem | MessageBindingPanelItem | MessageReferencesPanelItem | McpPanelItem | McpExamplePanelItem | ExamplePanelItem | ReferencesPanelItem | LocationsPanelItem | GroupItemsPanelItem;
449
- export type DownloadNode = MultiChildPanelBase<typeof panelKind.DOWNLOAD>;
450
- export type ServersNode = SingleChildPanelBase<typeof panelKind.SERVERS>;
451
- export type BrokersNode = SingleChildPanelBase<typeof panelKind.BROKERS>;
452
- export type ChannelBindingNode = SingleChildPanelBase<typeof panelKind.CHANNEL_BINDING>;
453
- export type OperationBindingNode = SingleChildPanelBase<typeof panelKind.OPERATION_BINDING>;
454
- export type MessageBindingNode = SingleChildPanelBase<typeof panelKind.MESSAGE_BINDING>;
455
- export type MessageReferencesNode = SingleChildPanelBase<typeof panelKind.MESSAGE_REFERENCES>;
456
- export type OverviewNode = MultiChildPanelBase<typeof panelKind.EXTERNAL_LINK | typeof panelKind.EMAIL | typeof panelKind.ATTRIBUTE>;
457
- export type McpNode = MultiChildPanelBase<typeof panelKind.ATTRIBUTE | typeof panelKind.TAGS | typeof panelKind.EXTERNAL_LINK | typeof panelKind.CONNECT_MCP_BUTTON>;
458
- export type MediaTypeContent = {
459
- schemaId?: string;
460
- exampleIds?: string[];
461
- encoding?: Record<string, FormFieldEncoding>;
462
- };
463
- export type ResponseCodeEntry = {
464
- code: string;
465
- schemaId?: string;
466
- exampleIds?: string[];
467
- mediaTypes?: string[];
468
- mediaTypeContent?: Record<string, MediaTypeContent>;
469
- };
470
- export type GraphQLOperationData = {
471
- operationType: 'query' | 'mutation' | 'subscription';
472
- operationName: string;
473
- typeName: string;
474
- };
475
- export type ExamplesNode = MultiChildPanelBase<typeof panelKind.PAYLOAD | typeof panelKind.CODE_SAMPLE | typeof panelKind.RESPONSE | typeof panelKind.CALLBACK_PAYLOAD | typeof panelKind.GRAPHQL_QUERY | typeof panelKind.GRAPHQL_RESPONSE | typeof panelKind.GRAPHQL_VARIABLES | typeof panelKind.GRAPHQL_TYPE_SAMPLE>;
476
- export type ReferencesNode = SingleChildPanelBase<typeof panelKind.REFERENCES>;
477
- export type LocationsPanelNode = SingleChildPanelBase<typeof panelKind.LOCATIONS>;
478
- export type GroupItemNode = MultiChildPanelBase<typeof panelKind.GROUP_ITEMS>;
479
- export type McpExampleNode = SingleChildPanelBase<typeof panelKind.MCP_EXAMPLE>;
@@ -1,6 +0,0 @@
1
- import type { AsyncApiConfig, GraphQLConfig, RedocConfig } from '@redocly/config';
2
- type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks';
3
- export type EditionRedocConfig = Omit<RedocConfig, EnterpriseOnlyOptionKey>;
4
- export type EditionAsyncApiConfig = Omit<AsyncApiConfig, EnterpriseOnlyOptionKey>;
5
- export type EditionGraphQLConfig = Omit<GraphQLConfig, EnterpriseOnlyOptionKey>;
6
- export {};
@@ -1,48 +0,0 @@
1
- import type { Operation } from './options.js';
2
- export type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'TargetServerSwitched';
3
- export type AnalyticsEvent = {
4
- eventType: AnalyticsEventType;
5
- resource: 'Redocly_CodeSample' | 'Redocly_Operation';
6
- action: 'LanguageSwitched' | 'CodeSampleCopied' | 'TargetServerSwitched';
7
- operationId?: string;
8
- operationPath: string;
9
- operationHttpVerb: string;
10
- operationSummary?: string | Record<string, unknown>;
11
- };
12
- export type CodeSamplesLanguageSwitchedEvent = AnalyticsEvent & {
13
- lang: string;
14
- label: string;
15
- exampleId?: string;
16
- };
17
- export type CodeSamplesCopiedEvent = AnalyticsEvent & {
18
- lang: string;
19
- label: string;
20
- type: 'request' | 'response';
21
- exampleId?: string;
22
- exampleMimeType?: string;
23
- };
24
- export type TargetServerSwitchedEvent = AnalyticsEvent & {
25
- serverUrl: string;
26
- };
27
- export type Events = {
28
- codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
29
- codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
30
- targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
31
- };
32
- export type LanguageSwitchProps = {
33
- operation: Operation;
34
- sample: Record<string, unknown>;
35
- };
36
- export type CodeSampleCopyProps = {
37
- operation: Operation;
38
- lang?: string;
39
- label?: string;
40
- type: 'request' | 'response';
41
- exampleId?: string;
42
- activeExampleName?: string;
43
- activeMimeName: string;
44
- };
45
- export type TargetServerSwitchProps = {
46
- operation: Operation;
47
- serverUrl: string;
48
- };