@redocly/openapi-docs 3.12.0-rc.7 → 3.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. package/dist/redocly-openapi-docs.min.js +2153 -1963
  2. package/lib/components/ApiInfo/ApiInfo.js +29 -1
  3. package/lib/components/ApiInfo/Metadata.js +29 -1
  4. package/lib/components/ApiInfo/index.js +2 -1
  5. package/lib/components/ApiInfo/styled.js +17 -8
  6. package/lib/components/CallbackSamples/CallbackSamples.js +25 -4
  7. package/lib/components/CallbackSamples/index.js +2 -1
  8. package/lib/components/Callbacks/CallbackDetails.js +17 -3
  9. package/lib/components/Callbacks/CallbackOperation.js +24 -3
  10. package/lib/components/Callbacks/CallbackSummary.js +19 -3
  11. package/lib/components/Callbacks/CallbacksList.js +16 -1
  12. package/lib/components/Callbacks/index.js +4 -1
  13. package/lib/components/Callbacks/styled.js +6 -3
  14. package/lib/components/Content/Content.js +10 -1
  15. package/lib/components/Content/index.js +2 -1
  16. package/lib/components/Content/useAutoScroll.js +50 -1
  17. package/lib/components/ContentItem/ContentItem.js +31 -1
  18. package/lib/components/ContentItem/index.js +2 -1
  19. package/lib/components/ContentItem/useIsExpanded.js +33 -1
  20. package/lib/components/ContentItems/ContentItems.js +19 -1
  21. package/lib/components/ContentItems/Items.js +13 -1
  22. package/lib/components/ContentItems/VirtualList.js +35 -1
  23. package/lib/components/ContentItems/helpers.js +49 -1
  24. package/lib/components/ContentItems/index.js +2 -1
  25. package/lib/components/ContentItems/useScrollOnRender.js +26 -1
  26. package/lib/components/Discriminator/Discriminator.js +27 -2
  27. package/lib/components/Discriminator/index.js +2 -1
  28. package/lib/components/Download/DownloadSpecification.js +46 -4
  29. package/lib/components/Download/index.js +2 -1
  30. package/lib/components/Download/types.js +2 -0
  31. package/lib/components/Download/useDownloadInfo.js +42 -1
  32. package/lib/components/ErrorBoundary/ErrorBoundary.js +22 -2
  33. package/lib/components/ErrorBoundary/index.js +2 -1
  34. package/lib/components/ExpandAllButton/ExpandAllButton.js +31 -2
  35. package/lib/components/ExpandAllButton/index.js +2 -1
  36. package/lib/components/ExternalDocumentation/ExternalDocumentation.js +18 -4
  37. package/lib/components/ExternalDocumentation/index.js +2 -1
  38. package/lib/components/Language/LanguageDropdown.js +21 -1
  39. package/lib/components/Language/LanguageItem.js +33 -1
  40. package/lib/components/Language/LanguageList.js +93 -1
  41. package/lib/components/Language/_tests_/LanguageDropdown.test.js +23 -1
  42. package/lib/components/Language/constants.js +3 -1
  43. package/lib/components/Language/index.js +4 -1
  44. package/lib/components/Language/styled.js +29 -15
  45. package/lib/components/Markdown/Markdown.js +64 -1
  46. package/lib/components/Markdown/index.js +3 -1
  47. package/lib/components/Markdown/types.js +2 -0
  48. package/lib/components/MediaTypeSwitch/MediaTypesSwitch.js +51 -1
  49. package/lib/components/MediaTypeSwitch/index.js +2 -1
  50. package/lib/components/OperationItem/Description.d.ts +1 -4
  51. package/lib/components/OperationItem/Description.js +9 -1
  52. package/lib/components/OperationItem/OperationItem.js +70 -5
  53. package/lib/components/OperationItem/_tests_/OperationItem.test.js +70 -1
  54. package/lib/components/OperationItem/_tests_/__mocks__/mock-intersection-observer.js +40 -1
  55. package/lib/components/OperationItem/index.js +2 -1
  56. package/lib/components/OperationItem/types.js +2 -0
  57. package/lib/components/Overlay.js +48 -3
  58. package/lib/components/Overview/Overview.js +20 -1
  59. package/lib/components/Overview/index.js +2 -1
  60. package/lib/components/PageFooter/PageFooter.js +19 -1
  61. package/lib/components/PageFooter/index.js +2 -1
  62. package/lib/components/Panel/ResponsePanel.js +12 -6
  63. package/lib/components/Panel/Trigger.js +4 -2
  64. package/lib/components/Panel/index.js +3 -1
  65. package/lib/components/PanelItem/PanelItem.js +6 -1
  66. package/lib/components/PanelItem/index.js +3 -1
  67. package/lib/components/PanelItem/styled.js +20 -10
  68. package/lib/components/PayloadSamples/Example.js +6 -1
  69. package/lib/components/PayloadSamples/ExampleValue.js +30 -1
  70. package/lib/components/PayloadSamples/MediaTypeSamples.js +36 -2
  71. package/lib/components/PayloadSamples/PayloadSamples.js +26 -1
  72. package/lib/components/PayloadSamples/index.js +7 -1
  73. package/lib/components/PayloadSamples/styled.js +9 -4
  74. package/lib/components/PayloadSamples/types.js +2 -0
  75. package/lib/components/PropertyDetails/DescriptionEnums.js +19 -3
  76. package/lib/components/PropertyDetails/EnumValues.js +37 -1
  77. package/lib/components/PropertyDetails/Examples.js +26 -1
  78. package/lib/components/PropertyDetails/Extensions.js +17 -2
  79. package/lib/components/PropertyDetails/FieldDetail.js +15 -2
  80. package/lib/components/PropertyDetails/FieldDetails.js +51 -6
  81. package/lib/components/PropertyDetails/Pattern.js +21 -1
  82. package/lib/components/PropertyDetails/PlusCircleIcon.js +10 -4
  83. package/lib/components/PropertyDetails/PropertyDetails.js +22 -5
  84. package/lib/components/PropertyDetails/SchemaTypeInfo.js +10 -2
  85. package/lib/components/PropertyDetails/SimpleEnums.js +13 -2
  86. package/lib/components/PropertyDetails/cycleColorsByLevel.js +18 -1
  87. package/lib/components/PropertyDetails/index.js +4 -1
  88. package/lib/components/PropertyDetails/styled.js +15 -7
  89. package/lib/components/PropertyDetails/types.js +2 -0
  90. package/lib/components/RedoclyOpenAPIDocs/Providers.js +114 -1
  91. package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +57 -1
  92. package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js +86 -1
  93. package/lib/components/RedoclyOpenAPIDocs/index.js +5 -1
  94. package/lib/components/RedoclyOpenAPIDocs/styled.js +4 -2
  95. package/lib/components/RedoclyOpenAPIDocs/types.js +2 -0
  96. package/lib/components/RedoclyOpenAPIDocs/utils.js +33 -1
  97. package/lib/components/RenderHook/RenderHook.js +17 -1
  98. package/lib/components/RenderHook/index.js +2 -1
  99. package/lib/components/Replay/EmbeddedReplay.js +41 -3
  100. package/lib/components/Replay/Replay.js +99 -1
  101. package/lib/components/Replay/index.js +3 -1
  102. package/lib/components/Replay/utils.js +208 -1
  103. package/lib/components/Request/RequestDetails.js +33 -2
  104. package/lib/components/Request/types.js +2 -0
  105. package/lib/components/RequestParameters/Body.js +8 -1
  106. package/lib/components/RequestParameters/ParametersGroup.js +19 -4
  107. package/lib/components/RequestParameters/RequestParameters.js +40 -1
  108. package/lib/components/RequestParameters/index.js +4 -1
  109. package/lib/components/RequestSamples/CodeSample.js +55 -2
  110. package/lib/components/RequestSamples/Example.js +37 -1
  111. package/lib/components/RequestSamples/RequestSamples.js +89 -5
  112. package/lib/components/RequestSamples/index.js +3 -1
  113. package/lib/components/RequestSamples/useCodeSamples.js +92 -1
  114. package/lib/components/ResponseSamples/ResponseSamples.js +47 -1
  115. package/lib/components/ResponseSamples/Summary.js +9 -1
  116. package/lib/components/ResponseSamples/index.js +2 -1
  117. package/lib/components/Responses/OperationResponseList.js +42 -2
  118. package/lib/components/Responses/ResponseDetails.js +18 -1
  119. package/lib/components/Responses/ResponseHeaders.js +15 -1
  120. package/lib/components/Responses/index.js +6 -1
  121. package/lib/components/Responses/styled.js +14 -6
  122. package/lib/components/Responses/types.js +2 -0
  123. package/lib/components/RightPanel/RightPanel.js +21 -1
  124. package/lib/components/RightPanel/index.js +2 -1
  125. package/lib/components/Samples/ExampleSwitch.js +33 -1
  126. package/lib/components/Samples/index.js +3 -1
  127. package/lib/components/Samples/use-example-key.js +12 -1
  128. package/lib/components/Schema/ArraySchema.js +45 -1
  129. package/lib/components/Schema/ObjectSchema.js +29 -1
  130. package/lib/components/Schema/OneOfSchema.js +47 -3
  131. package/lib/components/Schema/RecursiveSchema.js +10 -1
  132. package/lib/components/Schema/Schema.js +63 -2
  133. package/lib/components/Schema/SubSchema.js +20 -1
  134. package/lib/components/Schema/helpers.js +16 -1
  135. package/lib/components/Schema/index.js +5 -1
  136. package/lib/components/Schema/types.js +2 -0
  137. package/lib/components/Schema/useOneOfLocationIdx.js +11 -1
  138. package/lib/components/SchemaDefinition/SchemaDefinition.js +65 -2
  139. package/lib/components/SchemaDefinition/index.js +2 -1
  140. package/lib/components/SectionContent/SectionContent.js +49 -6
  141. package/lib/components/SectionContent/index.js +2 -1
  142. package/lib/components/SectionItem/SectionItem.js +14 -1
  143. package/lib/components/SectionItem/index.js +2 -1
  144. package/lib/components/Security/Divider.js +9 -2
  145. package/lib/components/Security/OAuthFlow.js +11 -1
  146. package/lib/components/Security/OAuthScopes.js +59 -9
  147. package/lib/components/Security/Security.js +15 -1
  148. package/lib/components/Security/SecurityButton.js +31 -7
  149. package/lib/components/Security/SecurityFlow.js +28 -4
  150. package/lib/components/Security/SecurityModal.js +34 -5
  151. package/lib/components/Security/SecuritySchemeItem.js +15 -4
  152. package/lib/components/Security/helper.js +16 -1
  153. package/lib/components/Security/index.js +11 -1
  154. package/lib/components/Security/styled.js +6 -3
  155. package/lib/components/SelectOrLabel/SelectOrLabel.js +12 -2
  156. package/lib/components/SelectOrLabel/index.js +2 -1
  157. package/lib/components/ServerList/ServerList.js +36 -10
  158. package/lib/components/ServerList/index.js +2 -1
  159. package/lib/components/ServerList/types.js +2 -0
  160. package/lib/components/ServerListDropdown/ServerListDropdown.js +54 -1
  161. package/lib/components/ServerListDropdown/index.js +2 -1
  162. package/lib/components/ServerListDropdown/styled.js +15 -6
  163. package/lib/components/SideMenu/SideMenu.js +13 -2
  164. package/lib/components/SideMenu/hooks/useMenuItems.js +110 -1
  165. package/lib/components/SideMenu/index.js +2 -1
  166. package/lib/components/SideMenu/types.js +2 -0
  167. package/lib/components/StickySidebar/SidebarActions.js +14 -2
  168. package/lib/components/StickySidebar/StickyResponsiveSidebar.js +37 -7
  169. package/lib/components/StickySidebar/index.js +2 -1
  170. package/lib/components/Tabs/Tabs.js +16 -5
  171. package/lib/components/Tabs/index.js +3 -1
  172. package/lib/components/Tabs/useTabsState.js +22 -1
  173. package/lib/components/TagItem/OperationNavigationItems.js +18 -4
  174. package/lib/components/TagItem/OperationsNavigation.js +46 -2
  175. package/lib/components/TagItem/TagItem.js +41 -8
  176. package/lib/components/TagItem/index.js +2 -1
  177. package/lib/components/TagItem/styled.js +5 -2
  178. package/lib/components/TagItem/types.js +2 -0
  179. package/lib/components/ViewNested/ViewNested.js +42 -9
  180. package/lib/components/ViewNested/index.js +2 -1
  181. package/lib/components/common/Badges.js +21 -5
  182. package/lib/components/common/BodyContent/BodyContent.js +31 -4
  183. package/lib/components/common/BodyContent/index.js +2 -1
  184. package/lib/components/common/ClearButton/ClearButton.js +5 -1
  185. package/lib/components/common/ClearButton/index.js +3 -1
  186. package/lib/components/common/ClearButton/styled.js +5 -2
  187. package/lib/components/common/ClearButton/types.js +2 -0
  188. package/lib/components/common/CodeBlockPanel.js +7 -3
  189. package/lib/components/common/ConstraintsView.js +14 -2
  190. package/lib/components/common/Dropdown/Dropdown.js +22 -4
  191. package/lib/components/common/Dropdown/index.js +2 -1
  192. package/lib/components/common/ExpandableExample/ExpandableExample.js +24 -3
  193. package/lib/components/common/ExpandableExample/index.js +2 -1
  194. package/lib/components/common/Extensions.js +17 -2
  195. package/lib/components/common/Fields/fields-layout.js +76 -51
  196. package/lib/components/common/Fields/fields.js +39 -17
  197. package/lib/components/common/Fields/index.js +3 -1
  198. package/lib/components/common/LinkToField.js +33 -6
  199. package/lib/components/common/OperationItemTitle.d.ts +1 -0
  200. package/lib/components/common/OperationItemTitle.js +16 -5
  201. package/lib/components/common/SchemaSelection/SchemaSelection.js +51 -1
  202. package/lib/components/common/SchemaSelection/index.js +2 -1
  203. package/lib/components/common/Select/Select.js +21 -1
  204. package/lib/components/common/Select/index.js +3 -1
  205. package/lib/components/common/Select/styled.js +17 -9
  206. package/lib/components/common/Select/types.js +2 -0
  207. package/lib/components/common/Skeleton/LanguageListSkeleton.js +16 -6
  208. package/lib/components/common/Skeleton/Skeleton.js +15 -5
  209. package/lib/components/common/Skeleton/index.js +3 -1
  210. package/lib/components/common/headers.js +4 -2
  211. package/lib/components/common/index.js +14 -1
  212. package/lib/components/common/linkify.js +28 -4
  213. package/lib/components/common/mixins.js +4 -2
  214. package/lib/components/common/panels.js +58 -33
  215. package/lib/components/common/schema.js +16 -8
  216. package/lib/components/common/styled.js +15 -7
  217. package/lib/components/index.js +25 -1
  218. package/lib/components/pluggable/RedocExample.js +20 -1
  219. package/lib/components/pluggable/RedocSchema.js +22 -1
  220. package/lib/components/pluggable/index.js +3 -1
  221. package/lib/components/pluggable/styled.components.js +9 -4
  222. package/lib/constants.js +30 -1
  223. package/lib/empty.js +7 -1
  224. package/lib/events/codeSampleCopy.js +19 -1
  225. package/lib/events/creator.js +5 -1
  226. package/lib/events/index.js +8 -1
  227. package/lib/events/languageSwitch.js +18 -1
  228. package/lib/events/panelToggle.js +16 -1
  229. package/lib/events/serverSwitch.js +13 -1
  230. package/lib/events/tryItOpen.js +12 -1
  231. package/lib/events/tryItSent.js +12 -1
  232. package/lib/events/types.js +11 -1
  233. package/lib/hoc/types.js +2 -0
  234. package/lib/hoc/utils.js +4 -1
  235. package/lib/hoc/withRouter.js +17 -1
  236. package/lib/hoc/withStore.js +28 -1
  237. package/lib/hooks/index.js +9 -1
  238. package/lib/hooks/useActivateExample.js +35 -1
  239. package/lib/hooks/useActiveWithFallback.js +12 -1
  240. package/lib/hooks/useContentItems.js +10 -1
  241. package/lib/hooks/useLicense.js +17 -1
  242. package/lib/hooks/usePerformanceMetrics.js +26 -1
  243. package/lib/hooks/useRouter.js +17 -1
  244. package/lib/hooks/useTelemetry.js +5 -1
  245. package/lib/hooks/useTranslate.js +6 -1
  246. package/lib/hooks/useUppercase2LowercaseRedirect.js +12 -1
  247. package/lib/icons/CSharpIcon/CSharpIcon.js +7 -1
  248. package/lib/icons/CSharpIcon/index.js +2 -1
  249. package/lib/icons/CurlIcon/CurlIcon.js +8 -2
  250. package/lib/icons/CurlIcon/index.js +2 -1
  251. package/lib/icons/GOIcon/GOIcon.js +7 -1
  252. package/lib/icons/GOIcon/index.js +2 -1
  253. package/lib/icons/JavaIcon/JavaIcon.js +7 -1
  254. package/lib/icons/JavaIcon/index.js +2 -1
  255. package/lib/icons/JavaScriptIcon/JavaScriptIcon.js +7 -1
  256. package/lib/icons/JavaScriptIcon/index.js +2 -1
  257. package/lib/icons/NodeJSIcon/NodeJSIcon.js +7 -1
  258. package/lib/icons/NodeJSIcon/index.js +2 -1
  259. package/lib/icons/PHPIcon/PHPIcon.js +7 -1
  260. package/lib/icons/PHPIcon/index.js +2 -1
  261. package/lib/icons/PayloadIcon/PayloadIcon.js +7 -1
  262. package/lib/icons/PayloadIcon/index.js +2 -1
  263. package/lib/icons/PythonIcon/PythonIcon.js +7 -1
  264. package/lib/icons/PythonIcon/index.js +2 -1
  265. package/lib/icons/RIcon/RIcon.js +7 -1
  266. package/lib/icons/RIcon/index.js +2 -1
  267. package/lib/icons/RubyIcon/RubyIcon.js +7 -1
  268. package/lib/icons/RubyIcon/index.js +2 -1
  269. package/lib/index.js +49 -1
  270. package/lib/jotai/app.js +113 -1
  271. package/lib/jotai/operation.js +28 -1
  272. package/lib/jotai/replay.js +5 -1
  273. package/lib/jotai/store.js +8 -1
  274. package/lib/jotai/use-write-atom.js +9 -1
  275. package/lib/models/callback.js +28 -1
  276. package/lib/models/code-sample-options.js +2 -0
  277. package/lib/models/example.js +17 -1
  278. package/lib/models/field.js +109 -1
  279. package/lib/models/group.js +38 -1
  280. package/lib/models/index.js +14 -1
  281. package/lib/models/mediaContent.js +26 -1
  282. package/lib/models/mediaType.js +153 -1
  283. package/lib/models/operation.js +166 -1
  284. package/lib/models/request.js +25 -1
  285. package/lib/models/response.js +46 -1
  286. package/lib/models/schema.js +474 -2
  287. package/lib/models/security.js +84 -1
  288. package/lib/models/tab.js +2 -0
  289. package/lib/models/types.js +2 -0
  290. package/lib/services/OpenAPIParser.js +321 -1
  291. package/lib/services/check.js +104 -1
  292. package/lib/services/code-samples/constants.js +16 -1
  293. package/lib/services/code-samples/generator.js +540 -1
  294. package/lib/services/code-samples/httpsnippet/helpers/code-builder.d.ts +5 -1
  295. package/lib/services/code-samples/httpsnippet/helpers/code-builder.js +252 -3
  296. package/lib/services/code-samples/httpsnippet/helpers/code-helpers.d.ts +2 -2
  297. package/lib/services/code-samples/httpsnippet/helpers/code-helpers.js +90 -2
  298. package/lib/services/code-samples/httpsnippet/helpers/constants.js +28 -1
  299. package/lib/services/code-samples/httpsnippet/helpers/lodash-int.js +173 -1
  300. package/lib/services/code-samples/httpsnippet/helpers/mocks/code-helpers-mock.js +76 -37
  301. package/lib/services/code-samples/httpsnippet/helpers/reducer.js +16 -1
  302. package/lib/services/code-samples/httpsnippet/helpers/shell.js +20 -1
  303. package/lib/services/code-samples/httpsnippet/helpers/string-utility.js +19 -1
  304. package/lib/services/code-samples/httpsnippet/index.js +166 -1
  305. package/lib/services/code-samples/httpsnippet/targets/__mocks__/mock.js +2340 -146
  306. package/lib/services/code-samples/httpsnippet/targets/csharp/httpclient.js +227 -2
  307. package/lib/services/code-samples/httpsnippet/targets/csharp/index.js +11 -1
  308. package/lib/services/code-samples/httpsnippet/targets/csharpNewtonsoft/httpclient.js +185 -2
  309. package/lib/services/code-samples/httpsnippet/targets/csharpNewtonsoft/index.js +11 -1
  310. package/lib/services/code-samples/httpsnippet/targets/go/index.js +11 -1
  311. package/lib/services/code-samples/httpsnippet/targets/go/native.js +222 -3
  312. package/lib/services/code-samples/httpsnippet/targets/index.js +28 -1
  313. package/lib/services/code-samples/httpsnippet/targets/java/httpclient.js +184 -3
  314. package/lib/services/code-samples/httpsnippet/targets/java/index.js +11 -1
  315. package/lib/services/code-samples/httpsnippet/targets/java8/apachehttp.js +223 -2
  316. package/lib/services/code-samples/httpsnippet/targets/java8/index.js +11 -1
  317. package/lib/services/code-samples/httpsnippet/targets/javascript/fetch.js +147 -1
  318. package/lib/services/code-samples/httpsnippet/targets/javascript/index.js +11 -1
  319. package/lib/services/code-samples/httpsnippet/targets/node/fetch.js +199 -1
  320. package/lib/services/code-samples/httpsnippet/targets/node/index.js +11 -1
  321. package/lib/services/code-samples/httpsnippet/targets/php/curl.js +203 -5
  322. package/lib/services/code-samples/httpsnippet/targets/php/index.js +11 -1
  323. package/lib/services/code-samples/httpsnippet/targets/php/types.js +2 -0
  324. package/lib/services/code-samples/httpsnippet/targets/php/utils.js +106 -5
  325. package/lib/services/code-samples/httpsnippet/targets/python/index.js +11 -1
  326. package/lib/services/code-samples/httpsnippet/targets/python/requests.js +185 -6
  327. package/lib/services/code-samples/httpsnippet/targets/r/httr.js +111 -1
  328. package/lib/services/code-samples/httpsnippet/targets/r/index.js +11 -1
  329. package/lib/services/code-samples/httpsnippet/targets/r/utils.js +18 -6
  330. package/lib/services/code-samples/httpsnippet/targets/ruby/index.js +11 -1
  331. package/lib/services/code-samples/httpsnippet/targets/ruby/native.js +169 -1
  332. package/lib/services/code-samples/httpsnippet/targets/shell/curl.js +94 -6
  333. package/lib/services/code-samples/httpsnippet/targets/shell/index.js +11 -1
  334. package/lib/services/code-samples/index.js +3 -1
  335. package/lib/services/code-samples/types.js +2 -0
  336. package/lib/services/config-options/helpers.js +49 -1
  337. package/lib/services/config-options/index.js +3 -1
  338. package/lib/services/config-options/normalizeOptions.js +83 -1
  339. package/lib/services/config-options/types.js +2 -0
  340. package/lib/services/history/helpers.js +63 -1
  341. package/lib/services/history/index.js +2 -1
  342. package/lib/services/index.js +9 -1
  343. package/lib/services/menu/builder.js +47 -1
  344. package/lib/services/menu/index.js +2 -1
  345. package/lib/services/menu/markdown.js +93 -1
  346. package/lib/services/menu/operation.js +50 -1
  347. package/lib/services/menu/tags.js +166 -1
  348. package/lib/services/types.d.ts +0 -3
  349. package/lib/services/types.js +2 -0
  350. package/lib/services/utils.js +83 -1
  351. package/lib/standalone.js +68 -1
  352. package/lib/styled-components.js +6 -1
  353. package/lib/types/app.js +2 -0
  354. package/lib/types/index.js +4 -1
  355. package/lib/types/open-api.d.ts +1 -0
  356. package/lib/types/open-api.js +2 -0
  357. package/lib/types/security.js +2 -0
  358. package/lib/utils/JsonPointer.js +84 -1
  359. package/lib/utils/areArraysEqual.js +4 -1
  360. package/lib/utils/argValuesHelpers.js +35 -1
  361. package/lib/utils/compose.js +2 -1
  362. package/lib/utils/configure-helpers.js +223 -1
  363. package/lib/utils/convertSwagger2OpenAPI.js +14 -1
  364. package/lib/utils/cookies.js +73 -1
  365. package/lib/utils/debounce.js +22 -1
  366. package/lib/utils/debug.js +11 -1
  367. package/lib/utils/dom.js +65 -1
  368. package/lib/utils/environments.js +13 -1
  369. package/lib/utils/helpers.js +222 -12
  370. package/lib/utils/index.js +25 -1
  371. package/lib/utils/isMobile.js +13 -1
  372. package/lib/utils/loadAndBundleSpec.js +32 -1
  373. package/lib/utils/local-storage.js +12 -1
  374. package/lib/utils/object.js +31 -1
  375. package/lib/utils/openapi.js +592 -1
  376. package/lib/utils/parameters.js +13 -1
  377. package/lib/utils/path.js +22 -1
  378. package/lib/utils/queryString.js +60 -1
  379. package/lib/utils/replaceVariables.js +14 -1
  380. package/lib/utils/saveTextBeforeHeading.js +35 -1
  381. package/lib/utils/security-details.js +49 -1
  382. package/lib/utils/session-storage.js +12 -1
  383. package/lib/utils/simplifyAstStructure.js +22 -1
  384. package/lib/utils/sort.js +21 -1
  385. package/lib/utils/string.js +65 -1
  386. package/lib/utils/telemetry.js +7 -1
  387. package/lib/utils/test-utils.js +26 -1
  388. package/lib/utils/theme-helpers.js +24 -3
  389. package/lib/utils/url.js +38 -1
  390. package/package.json +5 -5
@@ -1 +1,18 @@
1
- const C=e=>{if(e===void 0)return;const n=["#9D00FF","#615CEA","#147DF5","#08BFCC","#08CC7A","#81CC08","#E5BE00","#FF8700","#FF00B8"];return n[e%n.length]};export{C as cycleColorsByLevel};
1
+ export const cycleColorsByLevel = (level) => {
2
+ if (level === undefined) {
3
+ return undefined;
4
+ }
5
+ const levelColors = [
6
+ '#9D00FF',
7
+ '#615CEA',
8
+ '#147DF5',
9
+ '#08BFCC',
10
+ '#08CC7A',
11
+ '#81CC08',
12
+ '#E5BE00',
13
+ '#FF8700',
14
+ '#FF00B8',
15
+ ];
16
+ return levelColors[level % levelColors.length];
17
+ };
18
+ //# sourceMappingURL=cycleColorsByLevel.js.map
@@ -1 +1,4 @@
1
- import{PropertyDetails as r}from"./PropertyDetails.js";import{FieldDetails as i}from"./FieldDetails.js";import{Extensions as s}from"./Extensions.js";export{s as Extensions,i as FieldDetails,r as PropertyDetails};
1
+ export { PropertyDetails } from './PropertyDetails.js';
2
+ export { FieldDetails } from './FieldDetails.js';
3
+ export { Extensions } from './Extensions.js';
4
+ //# sourceMappingURL=index.js.map
@@ -1,22 +1,30 @@
1
- import{Markdown as o}from"@redocly/theme/components/Markdown/Markdown";import{styled as e}from"../../styled-components.js";const i=e(o)`
1
+ import { Markdown as MarkdownWrapper } from '@redocly/theme/components/Markdown/Markdown';
2
+ import { styled } from '../../styled-components.js';
3
+ export const DescriptionEnumsBlock = styled(MarkdownWrapper) `
2
4
  table.md {
3
5
  margin: var(--spacing-xs) 0 0;
4
6
  }
5
- `,p=e.div`
7
+ `;
8
+ export const TypeWrapper = styled.div `
6
9
  line-height: 20px;
7
- `,a=e.label`
10
+ `;
11
+ export const ExampleSummary = styled.label `
8
12
  display: block;
9
13
  font-size: inherit;
10
14
  margin-bottom: 0.2em;
11
15
  font-weight: var(--font-weight-bold);
12
- `,n=e.div`
16
+ `;
17
+ export const ExampleWrap = styled.div `
13
18
  margin-top: 1em;
14
19
  font-size: var(--field-name-font-size);
15
- `,m=e.div`
20
+ `;
21
+ export const ExamplesList = styled.div `
16
22
  padding-left: 1.5em;
17
23
  margin-bottom: 1em;
18
- `,s=e.div`
24
+ `;
25
+ export const FieldDescriptionWrapper = styled.div `
19
26
  p {
20
27
  overflow-wrap: anywhere;
21
28
  }
22
- `;export{i as DescriptionEnumsBlock,a as ExampleSummary,n as ExampleWrap,m as ExamplesList,s as FieldDescriptionWrapper,p as TypeWrapper};
29
+ `;
30
+ //# sourceMappingURL=styled.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -1 +1,114 @@
1
- import{jsx as d}from"react/jsx-runtime";import{memo as v,useCallback as b,useEffect as g,useMemo as y}from"react";import S from"@markdoc/markdoc";import{LayoutVariant as O}from"@redocly/config";import{createStore as E,Provider as A}from"jotai";import{Heading as N}from"@redocly/theme/markdoc/components/Heading/Heading";import{normalizeOptions as D,OpenAPIParser as j}from"../../services/index.js";import{getMarkdownHeaderId as k}from"./utils.js";import{normalizeServers as x}from"../../utils/index.js";import{SchemaDefinition as C}from"../SchemaDefinition/index.js";import{appStore as P,appStoreOverrideAtom as M,environmentAtom as H,layoutAtom as l,userClaimsAtom as I}from"../../jotai/app.js";import{mapObject as L}from"../../utils/object.js";import{mergeInMockServer as R}from"../../models/operation.js";import{getDefaultOperationStore as T,operationStore as V}from"../../jotai/operation.js";import{getServerEnvName as z}from"../../utils/environments.js";import{globalStoreAtom as _}from"../../jotai/store.js";const q={ignoreNamedSchemas:["java.io.ObjectStreamField"],maxDisplayedEnumValues:10,markdocOptions:{tags:{schemaDefinition:{render:"SchemaDefinition",attributes:{schemaRef:{type:String},exampleRef:{type:String},showReadOnly:{type:Boolean},showWriteOnly:{type:Boolean},htmlWrap:{type:String,default:!1}}}},nodes:{heading:{children:["inline"],attributes:{id:{type:String},level:{type:Number,required:!0,default:1}},transform(n,i){const t=n.transformAttributes(i),m=n.transformChildren(i),e=typeof t.id=="string"?t.id:k(m);return new S.Tag("Heading",{...t,id:e,level:n.attributes.level},m)}}},components:{SchemaDefinition:C,Heading:N}}},oe=v(({children:n,options:i,definitionUrl:t,definition:m,withState:e})=>{const p=b(()=>{const r=D(i,q),o=new j(m,t,r);return{options:r,parser:o}},[m,t,i]),a=y(()=>{const r=E(),o=p();r.set(_,o);const u=x(o.parser.definitionUrl,R(o.parser.definition?.servers||[],o.options.mockServer)),f=Object.fromEntries(u.map(s=>[z(s),{server:s.url,...L(s.variables||{},c=>c.default||"")}]));if(r.sub(P,()=>{}),r.set(l,o.options?.layout||O.THREE_PANEL),r.set(H,{environments:f}),r.set(I,e?.userClaims||{}),e&&r.set(M,{environment:e.environment,environments:e.environments,activeMimeName:e.activeMimeName,userClaims:e.userClaims}),e?.operation){const s=T(e.operation.pointer,e.operation.state.requestValues,e.operation.state.activeExampleName);r.set(V(e.operation.pointer),s)}return r},[p,e]);return g(()=>{e?.layout&&a.set(l,e?.layout)},[a,e?.layout]),d(A,{store:a,children:n})});export{oe as StoreProvider};
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { memo, useCallback, useEffect, useMemo } from 'react';
3
+ import markdocLib from '@markdoc/markdoc';
4
+ import { LayoutVariant } from '@redocly/config';
5
+ import { createStore, Provider } from 'jotai';
6
+ import { Heading } from '@redocly/theme/markdoc/components/Heading/Heading';
7
+ import { normalizeOptions, OpenAPIParser } from '../../services/index.js';
8
+ import { getMarkdownHeaderId } from './utils.js';
9
+ import { normalizeServers } from '../../utils/index.js';
10
+ import { SchemaDefinition } from '../SchemaDefinition/index.js';
11
+ import { appStore, appStoreOverrideAtom, environmentAtom, layoutAtom, userClaimsAtom, } from '../../jotai/app.js';
12
+ import { mapObject } from '../../utils/object.js';
13
+ import { mergeInMockServer } from '../../models/operation.js';
14
+ import { getDefaultOperationStore, operationStore } from '../../jotai/operation.js';
15
+ import { getServerEnvName } from '../../utils/environments.js';
16
+ import { globalStoreAtom } from '../../jotai/store.js';
17
+ const DEFAULT_OPTIONS = {
18
+ // java.io.ObjectStreamField is something generated from java code which is too deep so our docs build crash because of RAM
19
+ ignoreNamedSchemas: ['java.io.ObjectStreamField'],
20
+ maxDisplayedEnumValues: 10,
21
+ markdocOptions: {
22
+ tags: {
23
+ schemaDefinition: {
24
+ render: 'SchemaDefinition',
25
+ attributes: {
26
+ schemaRef: {
27
+ type: String,
28
+ },
29
+ exampleRef: {
30
+ type: String,
31
+ },
32
+ showReadOnly: {
33
+ type: Boolean,
34
+ },
35
+ showWriteOnly: {
36
+ type: Boolean,
37
+ },
38
+ htmlWrap: {
39
+ type: String,
40
+ default: false,
41
+ },
42
+ },
43
+ },
44
+ },
45
+ nodes: {
46
+ heading: {
47
+ children: ['inline'],
48
+ attributes: {
49
+ id: { type: String },
50
+ level: { type: Number, required: true, default: 1 },
51
+ },
52
+ transform(node, config) {
53
+ const attributes = node.transformAttributes(config);
54
+ const children = node.transformChildren(config);
55
+ const id = typeof attributes.id === 'string' ? attributes.id : getMarkdownHeaderId(children);
56
+ return new markdocLib.Tag('Heading', {
57
+ ...attributes,
58
+ id,
59
+ level: node.attributes.level,
60
+ }, children);
61
+ },
62
+ },
63
+ },
64
+ components: {
65
+ SchemaDefinition: SchemaDefinition,
66
+ Heading,
67
+ },
68
+ },
69
+ };
70
+ export const StoreProvider = memo(({ children, options: rawOptions, definitionUrl, definition, withState, }) => {
71
+ const createGlobalStore = useCallback(() => {
72
+ const options = normalizeOptions(rawOptions, DEFAULT_OPTIONS);
73
+ const parser = new OpenAPIParser(definition, definitionUrl, options);
74
+ return { options, parser };
75
+ }, [definition, definitionUrl, rawOptions]);
76
+ const initializedStore = useMemo(() => {
77
+ const store = createStore();
78
+ const globalStoreValue = createGlobalStore();
79
+ store.set(globalStoreAtom, globalStoreValue);
80
+ // fixme: move into separate function + collect all servers from all operations/paths
81
+ const globalServers = normalizeServers(globalStoreValue.parser.definitionUrl, mergeInMockServer(globalStoreValue.parser.definition?.servers || [], globalStoreValue.options.mockServer));
82
+ const serverEnvs = Object.fromEntries(globalServers.map((server) => [
83
+ getServerEnvName(server),
84
+ {
85
+ server: server.url,
86
+ ...mapObject(server.variables || {}, (variable) => variable.default || ''),
87
+ },
88
+ ]));
89
+ store.sub(appStore, () => undefined); // force mount so init data is read from storage
90
+ store.set(layoutAtom, globalStoreValue.options?.layout || LayoutVariant.THREE_PANEL); // set layout atom to update appStore atom with correct layout value
91
+ store.set(environmentAtom, { environments: serverEnvs });
92
+ store.set(userClaimsAtom, withState?.userClaims || {});
93
+ if (withState) {
94
+ store.set(appStoreOverrideAtom, {
95
+ environment: withState.environment,
96
+ environments: withState.environments,
97
+ activeMimeName: withState.activeMimeName,
98
+ userClaims: withState.userClaims,
99
+ });
100
+ }
101
+ if (withState?.operation) {
102
+ const defaultStore = getDefaultOperationStore(withState.operation.pointer, withState.operation.state.requestValues, withState.operation.state.activeExampleName);
103
+ store.set(operationStore(withState.operation.pointer), defaultStore);
104
+ }
105
+ return store;
106
+ }, [createGlobalStore, withState]);
107
+ useEffect(() => {
108
+ if (!withState?.layout)
109
+ return;
110
+ initializedStore.set(layoutAtom, withState?.layout);
111
+ }, [initializedStore, withState?.layout]);
112
+ return _jsx(Provider, { store: initializedStore, children: children });
113
+ });
114
+ //# sourceMappingURL=Providers.js.map
@@ -1 +1,57 @@
1
- import{jsx as o,jsxs as n,Fragment as E}from"react/jsx-runtime";import{memo as O,useRef as T}from"react";import{LayoutVariant as p}from"@redocly/config";import{useSetAtom as w}from"jotai";import{ThreePanelLayout as A}from"@redocly/theme/layouts/ThreePanelLayout";import{SidebarLogo as _}from"@redocly/theme/components/SidebarLogo/SidebarLogo";import{GlobalStyle as I,useMount as j}from"@redocly/theme/core/openapi";import{StoreProvider as N}from"./Providers.js";import{Overlay as v}from"../Overlay.js";import{RedocWrap as D}from"./styled.js";import{StickyResponsiveSidebar as k}from"../StickySidebar/index.js";import{SideMenu as B}from"../SideMenu/index.js";import{Content as K}from"../Content/index.js";import{useContentItems as M,useUppercase2LowercaseRedirect as V,useTelemetry as F,usePerformanceMetrics as H}from"../../hooks/index.js";import{withRouter as U}from"../../hoc/withRouter.js";import{withStore as Y}from"../../hoc/withStore.js";import{compose as G}from"../../utils/index.js";import{useLicense as W}from"../../hooks/useLicense.js";import{allOperationsAtom as q}from"../../jotai/replay.js";const z=G(U,Y,O)(({licenseKey:s,onLoaded:m,children:e,options:t,layout:f,collapsedSidebar:d,parser:a,withCommonStyles:h})=>{const b=T(null),{isValid:c,licenseInfo:R}=W(s),S=w(q),u=F();V();const{contentItems:y,flatItems:g}=M({parser:a,options:t});H({sendTelemetry:l=>{const r=Object.fromEntries(Object.entries(l).map(([x,C])=>[x.toLowerCase(),C]));u.send({type:"openapi_docs.performance_metrics",payload:{cls:r.cls,lcp:r.lcp,fcp:r.fcp,ttfb:r.ttfb}})}}),j(()=>{if(m?.(),u.send({type:"openapi_docs.viewed",payload:{layout:f}}),!t.hideReplay){const l=g.filter(r=>r.type==="operation");S(l)}});const{hideSidebar:L,scrollYOffset:P}=t||{},i=a.definition?.info?.["x-logo"];return n(E,{children:[h&&o(I,{}),n(D,{className:"redoc-wrap",ref:b,children:[!c&&o(v,{licenseInfo:R}),!L&&n(k,{scrollYOffset:P,className:"menu-content",collapsedSidebar:!d,children:[o(_,{imageUrl:i?.url,href:i?.href||a.definition?.info?.contact?.url,altText:i?.altText,backgroundColor:i?.backgroundColor}),o(B,{items:c?y:[]})]}),n(A,{className:"api-content",id:"api-content",layout:f===p.THREE_PANEL?p.THREE_PANEL:p.STACKED,collapsedSidebar:d,children:[o(K,{items:c?y:[],routingBasePath:t.routingBasePath}),e]})]})]})});function ue({onLoaded:s,children:m,store:e,withCommonStyles:t}){return e?.definition?o(N,{...e,children:o(z,{onLoaded:s,basePath:e.options?.routingBasePath,licenseKey:e.options?.licenseKey,disableRouter:e.options?.disableRouter,withCommonStyles:t,children:m})}):null}export{ue as RedoclyOpenAPIDocs};
1
+ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
2
+ import { memo, useRef } from 'react';
3
+ import { LayoutVariant } from '@redocly/config';
4
+ import { useSetAtom } from 'jotai';
5
+ import { ThreePanelLayout } from '@redocly/theme/layouts/ThreePanelLayout';
6
+ import { SidebarLogo } from '@redocly/theme/components/SidebarLogo/SidebarLogo';
7
+ import { GlobalStyle as ThemeCommonStyle, useMount } from '@redocly/theme/core/openapi';
8
+ import { StoreProvider } from './Providers.js';
9
+ import { Overlay } from '../Overlay.js';
10
+ import { RedocWrap } from './styled.js';
11
+ import { StickyResponsiveSidebar } from '../StickySidebar/index.js';
12
+ import { SideMenu } from '../SideMenu/index.js';
13
+ import { Content } from '../Content/index.js';
14
+ import { useContentItems, useUppercase2LowercaseRedirect, useTelemetry, usePerformanceMetrics, } from '../../hooks/index.js';
15
+ import { withRouter } from '../../hoc/withRouter.js';
16
+ import { withStore } from '../../hoc/withStore.js';
17
+ import { compose } from '../../utils/index.js';
18
+ import { useLicense } from '../../hooks/useLicense.js'; // we need a full import path for overriding license in portal
19
+ import { allOperationsAtom } from '../../jotai/replay.js';
20
+ const RedoclyOpenAPIDocsComponent = compose(withRouter, withStore, memo)(({ licenseKey, onLoaded, children, options, layout, collapsedSidebar, parser, withCommonStyles, }) => {
21
+ const rootElementRef = useRef(null);
22
+ const { isValid: hasValidLicense, licenseInfo } = useLicense(licenseKey);
23
+ const setAllOperations = useSetAtom(allOperationsAtom);
24
+ const telemetry = useTelemetry();
25
+ // remove this when no more warnings are logged (https://github.com/Redocly/redocly/issues/6778)
26
+ useUppercase2LowercaseRedirect();
27
+ const { contentItems, flatItems } = useContentItems({ parser, options });
28
+ usePerformanceMetrics({
29
+ sendTelemetry: (data) => {
30
+ const lowercaseData = Object.fromEntries(Object.entries(data).map(([key, value]) => [key.toLowerCase(), value]));
31
+ telemetry.send({
32
+ type: 'openapi_docs.performance_metrics',
33
+ payload: {
34
+ cls: lowercaseData.cls,
35
+ lcp: lowercaseData.lcp,
36
+ fcp: lowercaseData.fcp,
37
+ ttfb: lowercaseData.ttfb,
38
+ },
39
+ });
40
+ },
41
+ });
42
+ useMount(() => {
43
+ onLoaded?.();
44
+ telemetry.send({ type: 'openapi_docs.viewed', payload: { layout: layout } });
45
+ if (!options.hideReplay) {
46
+ const operations = flatItems.filter((item) => item.type === 'operation');
47
+ setAllOperations(operations);
48
+ }
49
+ });
50
+ const { hideSidebar, scrollYOffset } = options || {};
51
+ const xLogo = parser.definition?.info?.['x-logo'];
52
+ return (_jsxs(_Fragment, { children: [withCommonStyles && _jsx(ThemeCommonStyle, {}), _jsxs(RedocWrap, { className: "redoc-wrap", ref: rootElementRef, children: [!hasValidLicense && _jsx(Overlay, { licenseInfo: licenseInfo }), !hideSidebar && (_jsxs(StickyResponsiveSidebar, { scrollYOffset: scrollYOffset, className: "menu-content", collapsedSidebar: !collapsedSidebar, children: [_jsx(SidebarLogo, { imageUrl: xLogo?.url, href: xLogo?.href || parser.definition?.info?.contact?.url, altText: xLogo?.altText, backgroundColor: xLogo?.backgroundColor }), _jsx(SideMenu, { items: hasValidLicense ? contentItems : [] })] })), _jsxs(ThreePanelLayout, { className: "api-content", id: "api-content", layout: layout === LayoutVariant.THREE_PANEL ? LayoutVariant.THREE_PANEL : LayoutVariant.STACKED, collapsedSidebar: collapsedSidebar, children: [_jsx(Content, { items: hasValidLicense ? contentItems : [], routingBasePath: options.routingBasePath }), children] })] })] }));
53
+ });
54
+ export function RedoclyOpenAPIDocs({ onLoaded, children, store, withCommonStyles, }) {
55
+ return store?.definition ? (_jsx(StoreProvider, { ...store, children: _jsx(RedoclyOpenAPIDocsComponent, { onLoaded: onLoaded, basePath: store.options?.routingBasePath, licenseKey: store.options?.licenseKey, disableRouter: store.options?.disableRouter, withCommonStyles: withCommonStyles, children: children }) })) : null;
56
+ }
57
+ //# sourceMappingURL=RedoclyOpenAPIDocs.js.map
@@ -1 +1,86 @@
1
- import{jsx as s}from"react/jsx-runtime";import{cloneElement as S,isValidElement as w,useEffect as f,useMemo as x,useState as d}from"react";import{Loading as y}from"@redocly/theme/components/Loaders/Loading";import{useDeepCompareMemoize as v,fixSpec as A}from"./utils.js";import{argValueToBoolean as D}from"../../utils/index.js";import{RedoclyOpenAPIDocs as I}from"./RedoclyOpenAPIDocs.js";import{loadAndBundleDefinition as u}from"../../utils/loadAndBundleSpec.js";async function k(e,n,t){let o;if(t?.skipBundle){if(!e)throw new Error('spec must be specified when using "skipBundleAndConvert"');o=e}else o=await u(e||n);try{A(o)}catch{}return o}function _(e,n){return e.endsWith(".md")?u({openapi:"3.0.0",info:{title:n||"",version:"1.0",description:{$ref:e}},paths:{}}):u(e)}const B=({options:e,definitionUrl:n,definition:t,activeSampleLanguage:o,children:r})=>{const[,l]=d(),[m,c]=d(!0),[i,p]=d(null);f(()=>{async function h(){c(!0);try{p(await k(t,n,e))}catch(g){l(()=>{throw g})}}h()},[t,n,e]);const a=x(()=>{if(i)return e?.unstable_hooks?.onInit&&e.unstable_hooks?.onInit?.({store:{definition:i,options:e,definitionUrl:n,activeSampleLanguage:o}}),{definition:i,options:e,definitionUrl:n,activeSampleLanguage:o}},v([i,e,n]));return f(()=>{a&&c(!1)},[a]),a?m?D(e?.hideLoading,!1)?null:s(y,{color:"--loading-spinner-color"}):w(r)?S(r,{store:a}):null:null};function j({definition:e,definitionUrl:n,options:t={},activeItemId:o,activeSampleLanguage:r,activeDeepLink:l}){return s(B,{definition:e,definitionUrl:n,options:t,activeItemId:o,activeSampleLanguage:r,activeDeepLink:l,children:s(I,{withCommonStyles:!0})})}export{B as AppProvider,j as RedoclyOpenAPIDocsStandalone,_ as loadAndBundleSpecOrMd,k as loadSingle};
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { cloneElement, isValidElement, useEffect, useMemo, useState } from 'react';
3
+ import { Loading } from '@redocly/theme/components/Loaders/Loading';
4
+ import { useDeepCompareMemoize, fixSpec } from './utils.js';
5
+ import { argValueToBoolean } from '../../utils/index.js';
6
+ import { RedoclyOpenAPIDocs } from './RedoclyOpenAPIDocs.js';
7
+ import { loadAndBundleDefinition } from '../../utils/loadAndBundleSpec.js';
8
+ export async function loadSingle(spec, specUrl, options) {
9
+ let resolvedDefinition;
10
+ if (options?.skipBundle) {
11
+ if (!spec) {
12
+ throw new Error('spec must be specified when using "skipBundleAndConvert"');
13
+ }
14
+ resolvedDefinition = spec;
15
+ }
16
+ else {
17
+ resolvedDefinition = await loadAndBundleDefinition(spec || specUrl);
18
+ }
19
+ try {
20
+ fixSpec(resolvedDefinition);
21
+ }
22
+ catch {
23
+ // nope
24
+ }
25
+ return resolvedDefinition;
26
+ }
27
+ export function loadAndBundleSpecOrMd(url, title) {
28
+ if (url.endsWith('.md')) {
29
+ return loadAndBundleDefinition({
30
+ openapi: '3.0.0',
31
+ info: {
32
+ title: title || '',
33
+ version: '1.0',
34
+ description: { $ref: url },
35
+ },
36
+ paths: {},
37
+ });
38
+ }
39
+ else {
40
+ return loadAndBundleDefinition(url);
41
+ }
42
+ }
43
+ export const AppProvider = ({ options, definitionUrl, definition, activeSampleLanguage, children, }) => {
44
+ const [, setError] = useState();
45
+ const [loading, setLoading] = useState(true);
46
+ const [loadedSpec, setLoadedSpec] = useState(null);
47
+ useEffect(() => {
48
+ async function load() {
49
+ setLoading(true);
50
+ try {
51
+ setLoadedSpec(await loadSingle(definition, definitionUrl, options));
52
+ }
53
+ catch (e) {
54
+ setError(() => {
55
+ throw e;
56
+ });
57
+ }
58
+ }
59
+ load();
60
+ }, [definition, definitionUrl, options]); // do not reload based on options
61
+ const store = useMemo(() => {
62
+ if (!loadedSpec)
63
+ return undefined;
64
+ if (options?.unstable_hooks?.onInit) {
65
+ options.unstable_hooks?.onInit?.({
66
+ store: { definition: loadedSpec, options, definitionUrl, activeSampleLanguage },
67
+ });
68
+ }
69
+ return { definition: loadedSpec, options, definitionUrl, activeSampleLanguage };
70
+ },
71
+ // eslint-disable-next-line react-hooks/exhaustive-deps
72
+ useDeepCompareMemoize([loadedSpec, options, definitionUrl]));
73
+ useEffect(() => {
74
+ if (!store)
75
+ return;
76
+ setLoading(false);
77
+ }, [store]);
78
+ if (!store) {
79
+ return null;
80
+ }
81
+ return !loading ? (isValidElement(children) ? (cloneElement(children, { store })) : null) : argValueToBoolean(options?.hideLoading, false) ? null : (_jsx(Loading, { color: "--loading-spinner-color" }));
82
+ };
83
+ export function RedoclyOpenAPIDocsStandalone({ definition, definitionUrl, options = {}, activeItemId, activeSampleLanguage, activeDeepLink, }) {
84
+ return (_jsx(AppProvider, { definition: definition, definitionUrl: definitionUrl, options: options, activeItemId: activeItemId, activeSampleLanguage: activeSampleLanguage, activeDeepLink: activeDeepLink, children: _jsx(RedoclyOpenAPIDocs, { withCommonStyles: true }) }));
85
+ }
86
+ //# sourceMappingURL=RedoclyOpenAPIDocsStandalone.js.map
@@ -1 +1,5 @@
1
- import{RedoclyOpenAPIDocs as r}from"./RedoclyOpenAPIDocs.js";import{StoreProvider as m}from"./Providers.js";export*from"./types.js";import{fixSpec as f,useDeepCompareMemoize as x,getMarkdownHeaderId as a}from"./utils.js";export{r as RedoclyOpenAPIDocs,m as StoreProvider,f as fixSpec,a as getMarkdownHeaderId,x as useDeepCompareMemoize};
1
+ export { RedoclyOpenAPIDocs } from './RedoclyOpenAPIDocs.js';
2
+ export { StoreProvider } from './Providers.js';
3
+ export * from './types.js';
4
+ export { fixSpec, useDeepCompareMemoize, getMarkdownHeaderId } from './utils.js';
5
+ //# sourceMappingURL=index.js.map
@@ -1,4 +1,5 @@
1
- import{styled as t}from"../../styled-components.js";const e=t.div`
1
+ import { styled } from '../../styled-components.js';
2
+ export const RedocWrap = styled.div `
2
3
  display: flex;
3
4
  position: relative;
4
5
  text-align: left;
@@ -18,4 +19,5 @@ import{styled as t}from"../../styled-components.js";const e=t.div`
18
19
  box-sizing: border-box;
19
20
  -webkit-tap-highlight-color: rgba(255, 255, 255, 0);
20
21
  }
21
- `;export{e as RedocWrap};
22
+ `;
23
+ //# sourceMappingURL=styled.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -1 +1,33 @@
1
- import{useRef as n}from"react";import s from"fast-deep-equal";import{safeSlugify as c}from"../../utils/string.js";function u(e){const o=e.components&&e.components.securitySchemes||{};for(const r of Object.keys(o)){const t=o[r];t["x-type"]&&(t.type=t["x-type"]),t["x-scheme"]&&(t.scheme=t["x-scheme"])}}function x(e){const o=n(null),r=n(0);return s(e,o.current)||(o.current=e,r.current+=1),[r.current]}function f(e){if(typeof e[0]=="string")return`section/${c(e[0])}`;if(e.children)return f(e[0])}export{u as fixSpec,f as getMarkdownHeaderId,x as useDeepCompareMemoize};
1
+ import { useRef } from 'react';
2
+ import isDeepEqual from 'fast-deep-equal';
3
+ import { safeSlugify } from '../../utils/string.js';
4
+ export function fixSpec(resolvedSpec) {
5
+ const schemas = (resolvedSpec.components && resolvedSpec.components.securitySchemes) || {};
6
+ for (const s of Object.keys(schemas)) {
7
+ const scheme = schemas[s];
8
+ if (scheme['x-type']) {
9
+ scheme.type = scheme['x-type'];
10
+ }
11
+ if (scheme['x-scheme']) {
12
+ scheme.scheme = scheme['x-scheme'];
13
+ }
14
+ }
15
+ }
16
+ export function useDeepCompareMemoize(value) {
17
+ const ref = useRef(null);
18
+ const signalRef = useRef(0);
19
+ if (!isDeepEqual(value, ref.current)) {
20
+ ref.current = value;
21
+ signalRef.current += 1;
22
+ }
23
+ return [signalRef.current];
24
+ }
25
+ export function getMarkdownHeaderId(children) {
26
+ if (typeof children[0] === 'string') {
27
+ return `section/${safeSlugify(children[0])}`;
28
+ }
29
+ else if (children.children) {
30
+ return getMarkdownHeaderId(children[0]);
31
+ }
32
+ }
33
+ //# sourceMappingURL=utils.js.map
@@ -1 +1,17 @@
1
- import{jsx as o}from"react/jsx-runtime";function l(e){if(!e.Hook)return null;const n=e.Hook(e.props),t=n&&n.html;return t?o("span",{dangerouslySetInnerHTML:{__html:t}}):n}function u(e){return e.readOnly&&"read-only"||e.writeOnly&&"write-only"||null}export{l as RenderHook,u as getAccessModeLabelText};
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ export function RenderHook(props) {
3
+ if (!props.Hook)
4
+ return null;
5
+ const hookResult = props.Hook(props.props);
6
+ const html = hookResult && hookResult.html;
7
+ if (html) {
8
+ return _jsx("span", { dangerouslySetInnerHTML: { __html: html } });
9
+ }
10
+ else {
11
+ return hookResult;
12
+ }
13
+ }
14
+ export function getAccessModeLabelText(schema) {
15
+ return (schema.readOnly && 'read-only') || (schema.writeOnly && 'write-only') || null;
16
+ }
17
+ //# sourceMappingURL=RenderHook.js.map
@@ -1 +1,2 @@
1
- import{RenderHook as r,getAccessModeLabelText as t}from"./RenderHook.js";export{r as RenderHook,t as getAccessModeLabelText};
1
+ export { RenderHook, getAccessModeLabelText } from './RenderHook.js';
2
+ //# sourceMappingURL=index.js.map
@@ -1,10 +1,48 @@
1
- import{jsx as e}from"react/jsx-runtime";import{Suspense as b,lazy as h,memo as S,useEffect as x,useState as E}from"react";import{useAtomValue as o}from"jotai";import{globalOptionsAtom as O}from"../../jotai/store.js";import{operationStore as R}from"../../jotai/operation.js";import{appStore as C,environmentsAtom as L}from"../../jotai/app.js";import{useTranslate as T}from"../../hooks/index.js";import{convertOperationToReplayValue as V}from"./utils.js";import{getDefaultCollectorUrl as j}from"../../utils/telemetry.js";import{styled as i}from"../../styled-components.js";const A=h(async()=>import("@redocly/replay").then(r=>({default:r.EmbeddedReplay})));function k({activeOperationId:r,corsProxyUrl:d,fullOpenApi:l,pointer:t}){const n=T(),{mockServer:m}=o(O),s=o(R(t)),a=o(C),c=o(L),[f,u]=E(!1);return x(()=>{u(!0)},[]),e(U,{children:f?e(b,{fallback:e(p,{children:n("openapi.loading","Loading...")}),children:e(A,{activeOperationId:r,activeOperationPointer:t,api:l,settings:{environment:a.environment,predefinedEnvValues:c,corsProxyUrl:d,mockServer:m,disableCollectionsTab:!0,telemetry:{tracerName:"replay-openapi",collectorUrl:j()},convertOperationToReplayValue:(v,y,g)=>V(v,y,g,void 0,s,a)}})}):e(p,{children:n("openapi.loading","Loading...")})})}const F=S(k),p=i.div`
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { Suspense, lazy, memo, useEffect, useState } from 'react';
3
+ import { useAtomValue } from 'jotai';
4
+ import { globalOptionsAtom } from '../../jotai/store.js';
5
+ import { operationStore } from '../../jotai/operation.js';
6
+ import { appStore, environmentsAtom } from '../../jotai/app.js';
7
+ import { useTranslate } from '../../hooks/index.js';
8
+ import { convertOperationToReplayValue } from './utils.js';
9
+ import { getDefaultCollectorUrl } from '../../utils/telemetry.js';
10
+ import { styled } from '../../styled-components.js';
11
+ const EmbeddedReplayOrig = lazy(async () => import('@redocly/replay').then((module) => ({ default: module.EmbeddedReplay })));
12
+ function EmbeddedReplayComponent({ activeOperationId, corsProxyUrl, fullOpenApi, pointer, }) {
13
+ const translate = useTranslate();
14
+ const { mockServer } = useAtomValue(globalOptionsAtom);
15
+ const operationState = useAtomValue(operationStore(pointer));
16
+ const appState = useAtomValue(appStore);
17
+ const envs = useAtomValue(environmentsAtom);
18
+ // do not render on the server, it produces some SSR Suspense error
19
+ const [loaded, setLoaded] = useState(false);
20
+ useEffect(() => {
21
+ setLoaded(true);
22
+ }, []);
23
+ return (_jsx(CompactWrapper, { children: loaded ? (_jsx(Suspense, { fallback: _jsx(LoadingWrapper, { children: translate('openapi.loading', 'Loading...') }), children: _jsx(EmbeddedReplayOrig, { activeOperationId: activeOperationId, activeOperationPointer: pointer, api: fullOpenApi, settings: {
24
+ environment: appState.environment,
25
+ predefinedEnvValues: envs,
26
+ corsProxyUrl,
27
+ mockServer,
28
+ disableCollectionsTab: true,
29
+ telemetry: {
30
+ tracerName: 'replay-openapi',
31
+ collectorUrl: getDefaultCollectorUrl(),
32
+ },
33
+ convertOperationToReplayValue: (path, method, openAPI) => convertOperationToReplayValue(path, method, openAPI, undefined, operationState, appState),
34
+ } }) })) : (_jsx(LoadingWrapper, { children: translate('openapi.loading', 'Loading...') })) }));
35
+ }
36
+ export const EmbeddedReplay = memo(EmbeddedReplayComponent);
37
+ const LoadingWrapper = styled.div `
2
38
  display: flex;
3
39
  justify-content: center;
4
40
  align-items: center;
5
41
  min-height: 100px;
6
- `,U=i.div`
42
+ `;
43
+ const CompactWrapper = styled.div `
7
44
  border: 1px solid var(--border-color-primary);
8
45
  border-radius: var(--border-radius-lg);
9
46
  padding: 0;
10
- `;export{F as EmbeddedReplay};
47
+ `;
48
+ //# sourceMappingURL=EmbeddedReplay.js.map
@@ -1 +1,99 @@
1
- import{jsx as r,Fragment as U,jsxs as F}from"react/jsx-runtime";import{lazy as B,memo as z,Suspense as J,useCallback as u,useRef as K,useState as M}from"react";import{useAtom as f,useAtomValue as p}from"jotai";import w from"deepmerge";const H=B(async()=>import("@redocly/replay").then(t=>({default:t.ReplayOverlay})));import{Button as Q}from"@redocly/theme/components/Button/Button";import{useFocusTrap as W,useModalScrollLock as X}from"@redocly/theme/core/openapi";import{RocketIcon as Y}from"@redocly/theme/icons/RocketIcon/RocketIcon";import{CircleDashIcon as Z}from"@redocly/theme/icons/CircleDashIcon/CircleDashIcon";import{Portal as $}from"@redocly/theme/components/Portal/Portal";import{globalOptionsAtom as ee,globalStoreAtom as te}from"../../jotai/store.js";import{allOperationsAtom as oe,replayStateAtom as re}from"../../jotai/replay.js";import{allOperations as ne,getDefaultOperationStore as ae}from"../../jotai/operation.js";import{LOADING_STATE as a}from"../../constants.js";import{environmentAtom as se,userClaimsAtom as ie}from"../../jotai/app.js";import{convertOperationToReplayValueForRedoc as le}from"./utils.js";import{useTranslate as me,useTelemetry as pe}from"../../hooks/index.js";import{JsonPointer as ce}from"../../utils/index.js";import{getDefaultCollectorUrl as ue}from"../../utils/telemetry.js";import{createTryItOpenEvent as fe,createTryItSentEvent as de}from"../../events/index.js";function ye({operation:t,corsProxyUrl:D,fullOpenApi:d}){const y=me(),C=pe(),O=K(null),{mockServer:L,oAuth2RedirectURI:b,routingBasePath:c}=p(ee),I=p(oe),{parser:P,options:{events:s}}=p(te),N=p(ie),[l,E]=M(!1),[m,h]=f(re),[g,v]=f(ne),[[,V],A]=f(se);W(O),X(l);const _=u(({operations:e,environment:o,environments:i})=>{const j=e.reduce((S,n)=>{n.requestValues.body=n.requestValues.body instanceof URLSearchParams?Object.fromEntries(n.requestValues.body.entries()):n.requestValues.body;const{path:k,method:G}=n.apiPath,T=ce.compile(["paths",k,G]);return S[T]=w(ae(T),n),S},{});v({...g,...j}),A({environment:o,environments:i})},[g,v,A]),R=()=>{if(m!==a.LOADING){if(!l&&(C.send({type:"openapi_docs.try_it.opened"}),s?.tryItOpen&&t)){const e=fe({operation:t});s.tryItOpen(e)}E(!l)}m===a.NOT_LOADED&&h(a.LOADING)},q=u(e=>{if(s?.tryItSent&&t){const o=de({operation:t,isSuccess:e});s.tryItSent(o)}},[s,t]),x=u(e=>{if(!e)return;const o=I.find(i=>i.operationId===e);return c+o?.href},[I,c]);return d?F(U,{children:[r(Q,{onClick:R,variant:"primary",iconPosition:"left",icon:m===a.LOADING?r(Z,{}):r(Y,{}),children:m===a.LOADING?y("openapi.loading","Loading..."):y("openapi.tryIt","Try it")}),l&&r(J,{children:r($,{mountId:"api-content",children:r("div",{ref:O,children:r(H,{activeOperationId:t.operationId||t.pointer,api:d,onRequestChange:_,onClose:R,onLoad:()=>h(a.LOADED),settings:{corsProxyUrl:D,mockServer:L,environment:V,apiId:P?.definition.info?.["x-metadata"]?.apiId,oAuth2RedirectURI:b,disableCollectionsTab:!0,storageKey:c,telemetry:{tracerName:"try-it",collectorUrl:ue()},convertOperationToReplayValue:(e,o,i)=>le(N)(e,o,i),getOperationUrl:x},onRequestSent:q})})})})]}):null}const xe=z(ye);export{xe as Replay};
1
+ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { lazy, memo, Suspense, useCallback, useRef, useState } from 'react';
3
+ import { useAtom, useAtomValue } from 'jotai';
4
+ import merge from 'deepmerge';
5
+ const ReplayOverlay = lazy(async () => import('@redocly/replay').then((module) => ({ default: module.ReplayOverlay })));
6
+ import { Button } from '@redocly/theme/components/Button/Button';
7
+ import { useFocusTrap, useModalScrollLock } from '@redocly/theme/core/openapi';
8
+ import { RocketIcon } from '@redocly/theme/icons/RocketIcon/RocketIcon';
9
+ import { CircleDashIcon } from '@redocly/theme/icons/CircleDashIcon/CircleDashIcon';
10
+ import { Portal } from '@redocly/theme/components/Portal/Portal';
11
+ import { globalOptionsAtom, globalStoreAtom } from '../../jotai/store.js';
12
+ import { allOperationsAtom, replayStateAtom } from '../../jotai/replay.js';
13
+ import { allOperations, getDefaultOperationStore } from '../../jotai/operation.js';
14
+ import { LOADING_STATE } from '../../constants.js';
15
+ import { environmentAtom, userClaimsAtom } from '../../jotai/app.js';
16
+ import { convertOperationToReplayValueForRedoc } from './utils.js';
17
+ import { useTranslate, useTelemetry } from '../../hooks/index.js';
18
+ import { JsonPointer } from '../../utils/index.js';
19
+ import { getDefaultCollectorUrl } from '../../utils/telemetry.js';
20
+ import { createTryItOpenEvent, createTryItSentEvent } from '../../events/index.js';
21
+ function ReplayComponent({ operation, corsProxyUrl, fullOpenApi }) {
22
+ const translate = useTranslate();
23
+ const telemetry = useTelemetry();
24
+ const replayRef = useRef(null);
25
+ const { mockServer, oAuth2RedirectURI, routingBasePath } = useAtomValue(globalOptionsAtom);
26
+ const operations = useAtomValue(allOperationsAtom);
27
+ const { parser, options: { events }, } = useAtomValue(globalStoreAtom);
28
+ const userClaims = useAtomValue(userClaimsAtom);
29
+ const [isOpened, setIsOpened] = useState(false);
30
+ const [replayState, setReplayState] = useAtom(replayStateAtom);
31
+ const [allOperationsData, setAllOperations] = useAtom(allOperations);
32
+ const [[, envName], setEnvironment] = useAtom(environmentAtom);
33
+ useFocusTrap(replayRef);
34
+ useModalScrollLock(isOpened);
35
+ const handleReplayParamChange = useCallback(({ operations, environment, environments }) => {
36
+ const changedOperations = operations.reduce((acc, op) => {
37
+ op.requestValues.body =
38
+ op.requestValues.body instanceof URLSearchParams
39
+ ? Object.fromEntries(op.requestValues.body.entries())
40
+ : op.requestValues.body;
41
+ const { path, method } = op.apiPath;
42
+ const pointer = JsonPointer.compile(['paths', path, method]);
43
+ acc[pointer] = merge(getDefaultOperationStore(pointer), op);
44
+ return acc;
45
+ }, {});
46
+ setAllOperations({ ...allOperationsData, ...changedOperations });
47
+ setEnvironment({ environment, environments });
48
+ }, [allOperationsData, setAllOperations, setEnvironment]);
49
+ const handleToggle = () => {
50
+ if (replayState !== LOADING_STATE.LOADING) {
51
+ if (!isOpened) {
52
+ telemetry.send({ type: 'openapi_docs.try_it.opened' });
53
+ if (events?.tryItOpen && operation) {
54
+ const eventPayload = createTryItOpenEvent({
55
+ operation: operation,
56
+ });
57
+ events.tryItOpen(eventPayload);
58
+ }
59
+ }
60
+ setIsOpened(!isOpened);
61
+ }
62
+ if (replayState === LOADING_STATE.NOT_LOADED) {
63
+ setReplayState(LOADING_STATE.LOADING);
64
+ }
65
+ };
66
+ const handleTryItSent = useCallback((isSuccess) => {
67
+ if (events?.tryItSent && operation) {
68
+ const eventPayload = createTryItSentEvent({ operation, isSuccess });
69
+ events.tryItSent(eventPayload);
70
+ }
71
+ }, [events, operation]);
72
+ const getOperationUrl = useCallback((operationId) => {
73
+ if (!operationId)
74
+ return;
75
+ const operation = operations.find((op) => op.operationId === operationId);
76
+ return routingBasePath + operation?.href;
77
+ }, [operations, routingBasePath]);
78
+ if (!fullOpenApi)
79
+ return null;
80
+ return (_jsxs(_Fragment, { children: [_jsx(Button, { onClick: handleToggle, variant: "primary", iconPosition: "left", icon: replayState === LOADING_STATE.LOADING ? _jsx(CircleDashIcon, {}) : _jsx(RocketIcon, {}), children: replayState === LOADING_STATE.LOADING
81
+ ? translate('openapi.loading', 'Loading...')
82
+ : translate('openapi.tryIt', 'Try it') }), isOpened && (_jsx(Suspense, { children: _jsx(Portal, { mountId: "api-content", children: _jsx("div", { ref: replayRef, children: _jsx(ReplayOverlay, { activeOperationId: operation.operationId || operation.pointer, api: fullOpenApi, onRequestChange: handleReplayParamChange, onClose: handleToggle, onLoad: () => setReplayState(LOADING_STATE.LOADED), settings: {
83
+ corsProxyUrl,
84
+ mockServer,
85
+ environment: envName,
86
+ apiId: parser?.definition.info?.['x-metadata']?.apiId,
87
+ oAuth2RedirectURI,
88
+ disableCollectionsTab: true,
89
+ storageKey: routingBasePath,
90
+ telemetry: {
91
+ tracerName: 'try-it',
92
+ collectorUrl: getDefaultCollectorUrl(),
93
+ },
94
+ convertOperationToReplayValue: (path, method, openAPI) => convertOperationToReplayValueForRedoc(userClaims)(path, method, openAPI),
95
+ getOperationUrl,
96
+ }, ...{ onRequestSent: handleTryItSent } }) }) }) }))] }));
97
+ }
98
+ export const Replay = memo(ReplayComponent);
99
+ //# sourceMappingURL=Replay.js.map
@@ -1 +1,3 @@
1
- import{Replay as p}from"./Replay.js";import{EmbeddedReplay as d}from"./EmbeddedReplay.js";export{d as EmbeddedReplay,p as Replay};
1
+ export { Replay } from './Replay.js';
2
+ export { EmbeddedReplay } from './EmbeddedReplay.js';
3
+ //# sourceMappingURL=index.js.map