@stoplight/elements-core 9.0.25-beta-0.1 → 9.0.25-beta-0.2

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 (415) hide show
  1. package/.storybook/main.js +6 -0
  2. package/.storybook/manager.js +1 -0
  3. package/.storybook/preview.jsx +50 -0
  4. package/dist/LICENSE +190 -0
  5. package/dist/README.md +46 -0
  6. package/{components → dist/components}/TryIt/Response/Response.d.ts +1 -0
  7. package/{index.esm.js → dist/index.esm.js} +256 -182
  8. package/{index.js → dist/index.js} +255 -181
  9. package/{index.mjs → dist/index.mjs} +256 -182
  10. package/dist/package.json +65 -0
  11. package/{utils → dist/utils}/exampleGeneration/exampleGeneration.d.ts +1 -0
  12. package/jest.config.js +10 -0
  13. package/package.json +74 -14
  14. package/src/__fixtures__/articles/basic.md +10 -0
  15. package/src/__fixtures__/articles/kitchen-sink.md +318 -0
  16. package/src/__fixtures__/articles/long-page-heading.md +955 -0
  17. package/src/__fixtures__/articles/multiple-try-its.md +54 -0
  18. package/src/__fixtures__/articles/schema-with-refs.ts +82 -0
  19. package/src/__fixtures__/http-request.json +11 -0
  20. package/src/__fixtures__/models/model-with-no-examples.json +15 -0
  21. package/src/__fixtures__/models/model-with-one-example.json +23 -0
  22. package/src/__fixtures__/models/model-with-three-examples.json +35 -0
  23. package/src/__fixtures__/operations/application-octet-stream-post.ts +39 -0
  24. package/src/__fixtures__/operations/base64-file-upload.ts +43 -0
  25. package/src/__fixtures__/operations/big-response.ts +4690 -0
  26. package/src/__fixtures__/operations/bundled-parameter.ts +128 -0
  27. package/src/__fixtures__/operations/empty-response.ts +15 -0
  28. package/src/__fixtures__/operations/examples-request-body.ts +135 -0
  29. package/src/__fixtures__/operations/head-todos.ts +49 -0
  30. package/src/__fixtures__/operations/invalid-response-example.ts +45 -0
  31. package/src/__fixtures__/operations/multipart-formdata-post.ts +61 -0
  32. package/src/__fixtures__/operations/operation-minimal.ts +11 -0
  33. package/src/__fixtures__/operations/operation-parameters.ts +337 -0
  34. package/src/__fixtures__/operations/operation-with-examples.ts +113 -0
  35. package/src/__fixtures__/operations/operation-without-servers.ts +16 -0
  36. package/src/__fixtures__/operations/patch-todos.ts +49 -0
  37. package/src/__fixtures__/operations/put-todos.ts +862 -0
  38. package/src/__fixtures__/operations/referenced-body.ts +62 -0
  39. package/src/__fixtures__/operations/request-body-empty-schema.ts +35 -0
  40. package/src/__fixtures__/operations/request-body.ts +62 -0
  41. package/src/__fixtures__/operations/securedOperation.ts +118 -0
  42. package/src/__fixtures__/operations/security-basic.ts +24 -0
  43. package/src/__fixtures__/operations/security-bearer.ts +25 -0
  44. package/src/__fixtures__/operations/simple-get.ts +17 -0
  45. package/src/__fixtures__/operations/simple.ts +103 -0
  46. package/src/__fixtures__/operations/string-numeric-enums.ts +32 -0
  47. package/src/__fixtures__/operations/urlencoded-post-oneof.ts +81 -0
  48. package/src/__fixtures__/operations/urlencoded-post.ts +54 -0
  49. package/src/__fixtures__/operations/vendor-extensions.ts +337 -0
  50. package/src/__fixtures__/operations/with-url-variables.ts +47 -0
  51. package/src/__fixtures__/operations/x-code-samples.ts +348 -0
  52. package/src/__fixtures__/schemas/circular.ts +1906 -0
  53. package/src/__fixtures__/schemas/contact.json +293 -0
  54. package/src/__fixtures__/schemas/media-entry.json +69 -0
  55. package/src/__fixtures__/schemas/simple.json +27 -0
  56. package/src/__fixtures__/schemas/todo-full.v1.json +35 -0
  57. package/src/__fixtures__/schemas/todo-partial.v1.json +14 -0
  58. package/src/__fixtures__/schemas/user.v1.json +17 -0
  59. package/src/__fixtures__/security-schemes/index.ts +38 -0
  60. package/src/__fixtures__/services/petstore.ts +167 -0
  61. package/src/__fixtures__/services/with-unnamed-servers.ts +38 -0
  62. package/src/__fixtures__/services/with-url-variables.ts +83 -0
  63. package/src/__fixtures__/services/without-origin.ts +20 -0
  64. package/src/__fixtures__/table-of-contents/nested.ts +44 -0
  65. package/src/__fixtures__/table-of-contents/studio-template.ts +100 -0
  66. package/src/__fixtures__/table-of-contents/studio.ts +559 -0
  67. package/src/components/Docs/Article/Article.spec.tsx +38 -0
  68. package/src/components/Docs/Article/Article.stories.tsx +17 -0
  69. package/src/components/Docs/Article/index.tsx +38 -0
  70. package/src/components/Docs/Docs.stories.tsx +33 -0
  71. package/src/components/Docs/Docs.tsx +231 -0
  72. package/src/components/Docs/HttpOperation/Badges.tsx +49 -0
  73. package/src/components/Docs/HttpOperation/Body.tsx +79 -0
  74. package/src/components/Docs/HttpOperation/Callbacks.tsx +89 -0
  75. package/src/components/Docs/HttpOperation/HttpOperation.spec.tsx +787 -0
  76. package/src/components/Docs/HttpOperation/HttpOperation.stories.ts +14 -0
  77. package/src/components/Docs/HttpOperation/HttpOperation.tsx +255 -0
  78. package/src/components/Docs/HttpOperation/Parameters.spec.tsx +101 -0
  79. package/src/components/Docs/HttpOperation/Parameters.tsx +118 -0
  80. package/src/components/Docs/HttpOperation/Request.tsx +140 -0
  81. package/src/components/Docs/HttpOperation/Responses.tsx +247 -0
  82. package/src/components/Docs/HttpOperation/index.ts +1 -0
  83. package/src/components/Docs/HttpService/AdditionalInfo.stories.ts +48 -0
  84. package/src/components/Docs/HttpService/AdditionalInfo.tsx +61 -0
  85. package/src/components/Docs/HttpService/ExportButton.tsx +35 -0
  86. package/src/components/Docs/HttpService/HttpService.spec.tsx +429 -0
  87. package/src/components/Docs/HttpService/HttpService.stories.ts +14 -0
  88. package/src/components/Docs/HttpService/HttpService.tsx +99 -0
  89. package/src/components/Docs/HttpService/SecuritySchemes.tsx +82 -0
  90. package/src/components/Docs/HttpService/ServerInfo.tsx +196 -0
  91. package/src/components/Docs/HttpService/index.ts +1 -0
  92. package/src/components/Docs/Model/Model.spec.tsx +241 -0
  93. package/src/components/Docs/Model/Model.stories.tsx +16 -0
  94. package/src/components/Docs/Model/Model.tsx +160 -0
  95. package/src/components/Docs/Model/index.ts +1 -0
  96. package/src/components/Docs/NodeVendorExtensions.tsx +55 -0
  97. package/src/components/Docs/Sections.tsx +54 -0
  98. package/src/components/Docs/Security/PanelContent.tsx +38 -0
  99. package/src/components/Docs/Security/index.ts +1 -0
  100. package/src/components/Docs/Skeleton.tsx +12 -0
  101. package/src/components/Docs/TwoColumnLayout.tsx +28 -0
  102. package/src/components/Docs/index.ts +1 -0
  103. package/src/components/Docs/story-helper.ts +46 -0
  104. package/src/components/Docs/story-renderer-helper.tsx +56 -0
  105. package/src/components/Layout/MobileTopNav.tsx +78 -0
  106. package/src/components/Layout/ResponsiveSidebarLayout.tsx +175 -0
  107. package/src/components/Layout/SidebarLayout.tsx +107 -0
  108. package/src/components/LinkHeading.tsx +21 -0
  109. package/src/components/LoadMore.tsx +20 -0
  110. package/src/components/Loading/Loading.tsx +9 -0
  111. package/src/components/Logo.tsx +25 -0
  112. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.spec.ts +90 -0
  113. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.tsx +164 -0
  114. package/src/components/MarkdownViewer/CustomComponents/Provider.tsx +20 -0
  115. package/src/components/MarkdownViewer/CustomComponents/ReactRouterLink.tsx +27 -0
  116. package/src/components/MarkdownViewer/CustomComponents/ResolvedImage.tsx +86 -0
  117. package/src/components/MarkdownViewer/CustomComponents/ScrollToHashElement.tsx +96 -0
  118. package/src/components/MarkdownViewer/MarkdownViewer.spec.tsx +170 -0
  119. package/src/components/MarkdownViewer/index.tsx +10 -0
  120. package/src/components/NonIdealState.tsx +20 -0
  121. package/src/components/PoweredByLink.tsx +30 -0
  122. package/src/components/RequestSamples/RequestSamples.stories.tsx +67 -0
  123. package/src/components/RequestSamples/RequestSamples.tsx +246 -0
  124. package/src/components/RequestSamples/__tests__/RequestSamples.test.tsx +131 -0
  125. package/src/components/RequestSamples/__tests__/__snapshots__/convertRequestToSample.spec.ts.snap +746 -0
  126. package/src/components/RequestSamples/__tests__/convertRequestToSample.spec.ts +118 -0
  127. package/src/components/RequestSamples/convertRequestToSample.ts +56 -0
  128. package/src/components/RequestSamples/extractCodeSamples.ts +50 -0
  129. package/src/components/RequestSamples/index.ts +2 -0
  130. package/src/components/RequestSamples/requestSampleConfigs.ts +182 -0
  131. package/src/components/ResponseExamples/ResponseExamples.spec.tsx +121 -0
  132. package/src/components/ResponseExamples/ResponseExamples.stories.tsx +21 -0
  133. package/src/components/ResponseExamples/ResponseExamples.tsx +79 -0
  134. package/src/components/TableOfContents/TableOfContents.spec.tsx +699 -0
  135. package/src/components/TableOfContents/TableOfContents.stories.tsx +136 -0
  136. package/src/components/TableOfContents/TableOfContents.tsx +536 -0
  137. package/src/components/TableOfContents/constants.ts +45 -0
  138. package/src/components/TableOfContents/index.ts +2 -0
  139. package/src/components/TableOfContents/types.ts +59 -0
  140. package/src/components/TableOfContents/utils.ts +84 -0
  141. package/src/components/TryIt/Auth/APIKeyAuth.tsx +19 -0
  142. package/src/components/TryIt/Auth/Auth.tsx +169 -0
  143. package/src/components/TryIt/Auth/AuthTokenInput.tsx +37 -0
  144. package/src/components/TryIt/Auth/BasicAuth.tsx +62 -0
  145. package/src/components/TryIt/Auth/BearerAuth.tsx +19 -0
  146. package/src/components/TryIt/Auth/DigestAuth.tsx +35 -0
  147. package/src/components/TryIt/Auth/OAuth2Auth.tsx +19 -0
  148. package/src/components/TryIt/Auth/authentication-utils.ts +113 -0
  149. package/src/components/TryIt/Body/BinaryBody.tsx +52 -0
  150. package/src/components/TryIt/Body/FormDataBody.tsx +145 -0
  151. package/src/components/TryIt/Body/RequestBody.tsx +71 -0
  152. package/src/components/TryIt/Body/__tests__/BinaryBody.test.tsx +29 -0
  153. package/src/components/TryIt/Body/__tests__/FormDataBody.test.tsx +94 -0
  154. package/src/components/TryIt/Body/request-body-utils.ts +127 -0
  155. package/src/components/TryIt/Body/useTextRequestBodyState.ts +27 -0
  156. package/src/components/TryIt/Mocking/MockingButton.tsx +98 -0
  157. package/src/components/TryIt/Mocking/mocking-utils.ts +56 -0
  158. package/src/components/TryIt/Mocking/useMockingOptions.ts +6 -0
  159. package/src/components/TryIt/Parameters/FileUploadParameterEditors.tsx +62 -0
  160. package/src/components/TryIt/Parameters/OperationParameters.tsx +39 -0
  161. package/src/components/TryIt/Parameters/ParameterEditor.tsx +135 -0
  162. package/src/components/TryIt/Parameters/__tests__/parameter-utils.spec.ts +60 -0
  163. package/src/components/TryIt/Parameters/parameter-utils.spec.ts +118 -0
  164. package/src/components/TryIt/Parameters/parameter-utils.ts +245 -0
  165. package/src/components/TryIt/Parameters/useOperationParameters.ts +60 -0
  166. package/src/components/TryIt/Response/ReponseCodeViewer.tsx +28 -0
  167. package/src/components/TryIt/Response/Response.spec.tsx +174 -0
  168. package/src/components/TryIt/Response/Response.tsx +173 -0
  169. package/src/components/TryIt/Response/hooks/useLineCount.ts +7 -0
  170. package/src/components/TryIt/Servers/ServerVariables.tsx +33 -0
  171. package/src/components/TryIt/Servers/ServersDropdown.tsx +53 -0
  172. package/src/components/TryIt/Servers/VariableEditor.tsx +64 -0
  173. package/src/components/TryIt/Servers/useServerVariables.ts +19 -0
  174. package/src/components/TryIt/TryIt.spec.tsx +1571 -0
  175. package/src/components/TryIt/TryIt.stories.tsx +77 -0
  176. package/src/components/TryIt/TryIt.tsx +404 -0
  177. package/src/components/TryIt/TryItWithRequestSamples.spec.tsx +143 -0
  178. package/src/components/TryIt/TryItWithRequestSamples.stories.tsx +32 -0
  179. package/src/components/TryIt/TryItWithRequestSamples.tsx +42 -0
  180. package/src/components/TryIt/build-request.spec.ts +261 -0
  181. package/src/components/TryIt/build-request.ts +357 -0
  182. package/src/components/TryIt/chosenServer.ts +5 -0
  183. package/src/components/TryIt/index.ts +3 -0
  184. package/src/components/__tests__/LinkHeading.spec.tsx +125 -0
  185. package/src/constants.ts +176 -0
  186. package/src/containers/MockingProvider.tsx +23 -0
  187. package/src/context/InlineRefResolver.spec.tsx +183 -0
  188. package/src/context/InlineRefResolver.tsx +94 -0
  189. package/src/context/Options.tsx +27 -0
  190. package/src/context/Persistence.tsx +24 -0
  191. package/src/context/RouterType.tsx +9 -0
  192. package/src/core.css +97 -0
  193. package/src/hoc/utils.ts +5 -0
  194. package/src/hoc/withMosaicProvider.spec.tsx +48 -0
  195. package/src/hoc/withMosaicProvider.tsx +28 -0
  196. package/src/hoc/withQueryClientProvider.spec.tsx +38 -0
  197. package/src/hoc/withQueryClientProvider.tsx +35 -0
  198. package/src/hoc/withRouter.tsx +71 -0
  199. package/src/hooks/useBundleRefsIntoDocument.ts +60 -0
  200. package/src/hooks/useFirstRender.ts +8 -0
  201. package/src/hooks/useIsCompact.ts +26 -0
  202. package/src/hooks/useParsedData.ts +99 -0
  203. package/src/hooks/useParsedValue.ts +19 -0
  204. package/src/hooks/useResponsiveLayout.tsx +51 -0
  205. package/src/hooks/useRouter.tsx +31 -0
  206. package/src/hooks/useUniqueId.ts +4 -0
  207. package/src/index.ts +48 -0
  208. package/src/styled.tsx +22 -0
  209. package/src/styles.css +4 -0
  210. package/src/types.ts +170 -0
  211. package/src/utils/__tests__/securitySchemes.spec.ts +137 -0
  212. package/src/utils/exampleGeneration/exampleGeneration.spec.tsx +664 -0
  213. package/src/utils/exampleGeneration/exampleGeneration.ts +332 -0
  214. package/src/utils/fileToBase64.ts +11 -0
  215. package/src/utils/guards.ts +48 -0
  216. package/src/utils/headers.ts +316 -0
  217. package/src/utils/http-spec/IServer.ts +100 -0
  218. package/src/utils/http-spec/__tests__/IServer.spec.ts +51 -0
  219. package/src/utils/http-spec/examples.ts +5 -0
  220. package/src/utils/http.ts +9 -0
  221. package/src/utils/jotai/persistAtom.ts +31 -0
  222. package/src/utils/node.ts +19 -0
  223. package/src/utils/oas/__tests__/security.spec.ts +18 -0
  224. package/src/utils/oas/security.ts +76 -0
  225. package/src/utils/ref-resolving/ReferenceResolver.ts +29 -0
  226. package/src/utils/ref-resolving/resolvedObject.test.ts +415 -0
  227. package/src/utils/ref-resolving/resolvedObject.ts +189 -0
  228. package/src/utils/securitySchemes.ts +117 -0
  229. package/src/utils/string.ts +15 -0
  230. package/src/utils/tests/chooseOption.ts +7 -0
  231. package/src/web-components/createElementClass.ts +154 -0
  232. package/tsconfig.build.json +14 -0
  233. package/tsconfig.json +7 -0
  234. /package/{__fixtures__ → dist/__fixtures__}/articles/schema-with-refs.d.ts +0 -0
  235. /package/{__fixtures__ → dist/__fixtures__}/operations/application-octet-stream-post.d.ts +0 -0
  236. /package/{__fixtures__ → dist/__fixtures__}/operations/base64-file-upload.d.ts +0 -0
  237. /package/{__fixtures__ → dist/__fixtures__}/operations/big-response.d.ts +0 -0
  238. /package/{__fixtures__ → dist/__fixtures__}/operations/examples-request-body.d.ts +0 -0
  239. /package/{__fixtures__ → dist/__fixtures__}/operations/head-todos.d.ts +0 -0
  240. /package/{__fixtures__ → dist/__fixtures__}/operations/multipart-formdata-post.d.ts +0 -0
  241. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-minimal.d.ts +0 -0
  242. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-parameters.d.ts +0 -0
  243. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-with-examples.d.ts +0 -0
  244. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-without-servers.d.ts +0 -0
  245. /package/{__fixtures__ → dist/__fixtures__}/operations/patch-todos.d.ts +0 -0
  246. /package/{__fixtures__ → dist/__fixtures__}/operations/put-todos.d.ts +0 -0
  247. /package/{__fixtures__ → dist/__fixtures__}/operations/referenced-body.d.ts +0 -0
  248. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body-empty-schema.d.ts +0 -0
  249. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body.d.ts +0 -0
  250. /package/{__fixtures__ → dist/__fixtures__}/operations/securedOperation.d.ts +0 -0
  251. /package/{__fixtures__ → dist/__fixtures__}/operations/security-basic.d.ts +0 -0
  252. /package/{__fixtures__ → dist/__fixtures__}/operations/security-bearer.d.ts +0 -0
  253. /package/{__fixtures__ → dist/__fixtures__}/operations/simple-get.d.ts +0 -0
  254. /package/{__fixtures__ → dist/__fixtures__}/operations/string-numeric-enums.d.ts +0 -0
  255. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post-oneof.d.ts +0 -0
  256. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post.d.ts +0 -0
  257. /package/{__fixtures__ → dist/__fixtures__}/operations/with-url-variables.d.ts +0 -0
  258. /package/{__fixtures__ → dist/__fixtures__}/security-schemes/index.d.ts +0 -0
  259. /package/{__fixtures__ → dist/__fixtures__}/services/petstore.d.ts +0 -0
  260. /package/{__fixtures__ → dist/__fixtures__}/services/with-unnamed-servers.d.ts +0 -0
  261. /package/{__fixtures__ → dist/__fixtures__}/services/with-url-variables.d.ts +0 -0
  262. /package/{__fixtures__ → dist/__fixtures__}/services/without-origin.d.ts +0 -0
  263. /package/{components → dist/components}/Docs/Article/Article.spec.d.ts +0 -0
  264. /package/{components → dist/components}/Docs/Article/Article.stories.d.ts +0 -0
  265. /package/{components → dist/components}/Docs/Article/index.d.ts +0 -0
  266. /package/{components → dist/components}/Docs/Docs.d.ts +0 -0
  267. /package/{components → dist/components}/Docs/Docs.stories.d.ts +0 -0
  268. /package/{components → dist/components}/Docs/HttpOperation/Badges.d.ts +0 -0
  269. /package/{components → dist/components}/Docs/HttpOperation/Body.d.ts +0 -0
  270. /package/{components → dist/components}/Docs/HttpOperation/Callbacks.d.ts +0 -0
  271. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.d.ts +0 -0
  272. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.spec.d.ts +0 -0
  273. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.stories.d.ts +0 -0
  274. /package/{components → dist/components}/Docs/HttpOperation/Parameters.d.ts +0 -0
  275. /package/{components → dist/components}/Docs/HttpOperation/Parameters.spec.d.ts +0 -0
  276. /package/{components → dist/components}/Docs/HttpOperation/Request.d.ts +0 -0
  277. /package/{components → dist/components}/Docs/HttpOperation/Responses.d.ts +0 -0
  278. /package/{components → dist/components}/Docs/HttpOperation/index.d.ts +0 -0
  279. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.d.ts +0 -0
  280. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.stories.d.ts +0 -0
  281. /package/{components → dist/components}/Docs/HttpService/ExportButton.d.ts +0 -0
  282. /package/{components → dist/components}/Docs/HttpService/HttpService.d.ts +0 -0
  283. /package/{components → dist/components}/Docs/HttpService/HttpService.spec.d.ts +0 -0
  284. /package/{components → dist/components}/Docs/HttpService/HttpService.stories.d.ts +0 -0
  285. /package/{components → dist/components}/Docs/HttpService/SecuritySchemes.d.ts +0 -0
  286. /package/{components → dist/components}/Docs/HttpService/ServerInfo.d.ts +0 -0
  287. /package/{components → dist/components}/Docs/HttpService/index.d.ts +0 -0
  288. /package/{components → dist/components}/Docs/Model/Model.d.ts +0 -0
  289. /package/{components → dist/components}/Docs/Model/Model.spec.d.ts +0 -0
  290. /package/{components → dist/components}/Docs/Model/Model.stories.d.ts +0 -0
  291. /package/{components → dist/components}/Docs/Model/index.d.ts +0 -0
  292. /package/{components → dist/components}/Docs/NodeVendorExtensions.d.ts +0 -0
  293. /package/{components → dist/components}/Docs/Sections.d.ts +0 -0
  294. /package/{components → dist/components}/Docs/Security/PanelContent.d.ts +0 -0
  295. /package/{components → dist/components}/Docs/Security/index.d.ts +0 -0
  296. /package/{components → dist/components}/Docs/Skeleton.d.ts +0 -0
  297. /package/{components → dist/components}/Docs/TwoColumnLayout.d.ts +0 -0
  298. /package/{components → dist/components}/Docs/index.d.ts +0 -0
  299. /package/{components → dist/components}/Docs/story-helper.d.ts +0 -0
  300. /package/{components → dist/components}/Docs/story-renderer-helper.d.ts +0 -0
  301. /package/{components → dist/components}/Layout/MobileTopNav.d.ts +0 -0
  302. /package/{components → dist/components}/Layout/ResponsiveSidebarLayout.d.ts +0 -0
  303. /package/{components → dist/components}/Layout/SidebarLayout.d.ts +0 -0
  304. /package/{components → dist/components}/LinkHeading.d.ts +0 -0
  305. /package/{components → dist/components}/LoadMore.d.ts +0 -0
  306. /package/{components → dist/components}/Loading/Loading.d.ts +0 -0
  307. /package/{components → dist/components}/Logo.d.ts +0 -0
  308. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.d.ts +0 -0
  309. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.spec.d.ts +0 -0
  310. /package/{components → dist/components}/MarkdownViewer/CustomComponents/Provider.d.ts +0 -0
  311. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ReactRouterLink.d.ts +0 -0
  312. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ResolvedImage.d.ts +0 -0
  313. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ScrollToHashElement.d.ts +0 -0
  314. /package/{components → dist/components}/MarkdownViewer/MarkdownViewer.spec.d.ts +0 -0
  315. /package/{components → dist/components}/MarkdownViewer/index.d.ts +0 -0
  316. /package/{components → dist/components}/NonIdealState.d.ts +0 -0
  317. /package/{components → dist/components}/PoweredByLink.d.ts +0 -0
  318. /package/{components → dist/components}/RequestSamples/RequestSamples.d.ts +0 -0
  319. /package/{components → dist/components}/RequestSamples/RequestSamples.stories.d.ts +0 -0
  320. /package/{components → dist/components}/RequestSamples/convertRequestToSample.d.ts +0 -0
  321. /package/{components → dist/components}/RequestSamples/extractCodeSamples.d.ts +0 -0
  322. /package/{components → dist/components}/RequestSamples/index.d.ts +0 -0
  323. /package/{components → dist/components}/RequestSamples/requestSampleConfigs.d.ts +0 -0
  324. /package/{components → dist/components}/ResponseExamples/ResponseExamples.d.ts +0 -0
  325. /package/{components → dist/components}/ResponseExamples/ResponseExamples.spec.d.ts +0 -0
  326. /package/{components → dist/components}/ResponseExamples/ResponseExamples.stories.d.ts +0 -0
  327. /package/{components → dist/components}/TableOfContents/TableOfContents.d.ts +0 -0
  328. /package/{components → dist/components}/TableOfContents/TableOfContents.spec.d.ts +0 -0
  329. /package/{components → dist/components}/TableOfContents/TableOfContents.stories.d.ts +0 -0
  330. /package/{components → dist/components}/TableOfContents/constants.d.ts +0 -0
  331. /package/{components → dist/components}/TableOfContents/index.d.ts +0 -0
  332. /package/{components → dist/components}/TableOfContents/types.d.ts +0 -0
  333. /package/{components → dist/components}/TableOfContents/utils.d.ts +0 -0
  334. /package/{components → dist/components}/TryIt/Auth/APIKeyAuth.d.ts +0 -0
  335. /package/{components → dist/components}/TryIt/Auth/Auth.d.ts +0 -0
  336. /package/{components → dist/components}/TryIt/Auth/AuthTokenInput.d.ts +0 -0
  337. /package/{components → dist/components}/TryIt/Auth/BasicAuth.d.ts +0 -0
  338. /package/{components → dist/components}/TryIt/Auth/BearerAuth.d.ts +0 -0
  339. /package/{components → dist/components}/TryIt/Auth/DigestAuth.d.ts +0 -0
  340. /package/{components → dist/components}/TryIt/Auth/OAuth2Auth.d.ts +0 -0
  341. /package/{components → dist/components}/TryIt/Auth/authentication-utils.d.ts +0 -0
  342. /package/{components → dist/components}/TryIt/Body/BinaryBody.d.ts +0 -0
  343. /package/{components → dist/components}/TryIt/Body/FormDataBody.d.ts +0 -0
  344. /package/{components → dist/components}/TryIt/Body/RequestBody.d.ts +0 -0
  345. /package/{components → dist/components}/TryIt/Body/request-body-utils.d.ts +0 -0
  346. /package/{components → dist/components}/TryIt/Body/useTextRequestBodyState.d.ts +0 -0
  347. /package/{components → dist/components}/TryIt/Mocking/MockingButton.d.ts +0 -0
  348. /package/{components → dist/components}/TryIt/Mocking/mocking-utils.d.ts +0 -0
  349. /package/{components → dist/components}/TryIt/Mocking/useMockingOptions.d.ts +0 -0
  350. /package/{components → dist/components}/TryIt/Parameters/FileUploadParameterEditors.d.ts +0 -0
  351. /package/{components → dist/components}/TryIt/Parameters/OperationParameters.d.ts +0 -0
  352. /package/{components → dist/components}/TryIt/Parameters/ParameterEditor.d.ts +0 -0
  353. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.d.ts +0 -0
  354. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.spec.d.ts +0 -0
  355. /package/{components → dist/components}/TryIt/Parameters/useOperationParameters.d.ts +0 -0
  356. /package/{components → dist/components}/TryIt/Response/ReponseCodeViewer.d.ts +0 -0
  357. /package/{components → dist/components}/TryIt/Response/Response.spec.d.ts +0 -0
  358. /package/{components → dist/components}/TryIt/Response/hooks/useLineCount.d.ts +0 -0
  359. /package/{components → dist/components}/TryIt/Servers/ServerVariables.d.ts +0 -0
  360. /package/{components → dist/components}/TryIt/Servers/ServersDropdown.d.ts +0 -0
  361. /package/{components → dist/components}/TryIt/Servers/VariableEditor.d.ts +0 -0
  362. /package/{components → dist/components}/TryIt/Servers/useServerVariables.d.ts +0 -0
  363. /package/{components → dist/components}/TryIt/TryIt.d.ts +0 -0
  364. /package/{components → dist/components}/TryIt/TryIt.spec.d.ts +0 -0
  365. /package/{components → dist/components}/TryIt/TryIt.stories.d.ts +0 -0
  366. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.d.ts +0 -0
  367. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.spec.d.ts +0 -0
  368. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.stories.d.ts +0 -0
  369. /package/{components → dist/components}/TryIt/build-request.d.ts +0 -0
  370. /package/{components → dist/components}/TryIt/build-request.spec.d.ts +0 -0
  371. /package/{components → dist/components}/TryIt/chosenServer.d.ts +0 -0
  372. /package/{components → dist/components}/TryIt/index.d.ts +0 -0
  373. /package/{constants.d.ts → dist/constants.d.ts} +0 -0
  374. /package/{containers → dist/containers}/MockingProvider.d.ts +0 -0
  375. /package/{context → dist/context}/InlineRefResolver.d.ts +0 -0
  376. /package/{context → dist/context}/InlineRefResolver.spec.d.ts +0 -0
  377. /package/{context → dist/context}/Options.d.ts +0 -0
  378. /package/{context → dist/context}/Persistence.d.ts +0 -0
  379. /package/{context → dist/context}/RouterType.d.ts +0 -0
  380. /package/{core.css → dist/core.css} +0 -0
  381. /package/{hoc → dist/hoc}/utils.d.ts +0 -0
  382. /package/{hoc → dist/hoc}/withMosaicProvider.d.ts +0 -0
  383. /package/{hoc → dist/hoc}/withMosaicProvider.spec.d.ts +0 -0
  384. /package/{hoc → dist/hoc}/withQueryClientProvider.d.ts +0 -0
  385. /package/{hoc → dist/hoc}/withQueryClientProvider.spec.d.ts +0 -0
  386. /package/{hoc → dist/hoc}/withRouter.d.ts +0 -0
  387. /package/{hooks → dist/hooks}/useBundleRefsIntoDocument.d.ts +0 -0
  388. /package/{hooks → dist/hooks}/useFirstRender.d.ts +0 -0
  389. /package/{hooks → dist/hooks}/useIsCompact.d.ts +0 -0
  390. /package/{hooks → dist/hooks}/useParsedData.d.ts +0 -0
  391. /package/{hooks → dist/hooks}/useParsedValue.d.ts +0 -0
  392. /package/{hooks → dist/hooks}/useResponsiveLayout.d.ts +0 -0
  393. /package/{hooks → dist/hooks}/useRouter.d.ts +0 -0
  394. /package/{hooks → dist/hooks}/useUniqueId.d.ts +0 -0
  395. /package/{index.d.ts → dist/index.d.ts} +0 -0
  396. /package/{styled.d.ts → dist/styled.d.ts} +0 -0
  397. /package/{styles.min.css → dist/styles.min.css} +0 -0
  398. /package/{types.d.ts → dist/types.d.ts} +0 -0
  399. /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.spec.d.ts +0 -0
  400. /package/{utils → dist/utils}/fileToBase64.d.ts +0 -0
  401. /package/{utils → dist/utils}/guards.d.ts +0 -0
  402. /package/{utils → dist/utils}/headers.d.ts +0 -0
  403. /package/{utils → dist/utils}/http-spec/IServer.d.ts +0 -0
  404. /package/{utils → dist/utils}/http-spec/examples.d.ts +0 -0
  405. /package/{utils → dist/utils}/http.d.ts +0 -0
  406. /package/{utils → dist/utils}/jotai/persistAtom.d.ts +0 -0
  407. /package/{utils → dist/utils}/node.d.ts +0 -0
  408. /package/{utils → dist/utils}/oas/security.d.ts +0 -0
  409. /package/{utils → dist/utils}/ref-resolving/ReferenceResolver.d.ts +0 -0
  410. /package/{utils → dist/utils}/ref-resolving/resolvedObject.d.ts +0 -0
  411. /package/{utils → dist/utils}/ref-resolving/resolvedObject.test.d.ts +0 -0
  412. /package/{utils → dist/utils}/securitySchemes.d.ts +0 -0
  413. /package/{utils → dist/utils}/string.d.ts +0 -0
  414. /package/{utils → dist/utils}/tests/chooseOption.d.ts +0 -0
  415. /package/{web-components → dist/web-components}/createElementClass.d.ts +0 -0
@@ -0,0 +1,77 @@
1
+ import { Meta, Story } from '@storybook/react';
2
+ import * as React from 'react';
3
+
4
+ import { examplesRequestBody } from '../../__fixtures__/operations/examples-request-body';
5
+ import { httpOperation as multipartOperation } from '../../__fixtures__/operations/multipart-formdata-post';
6
+ import { httpOperation as putTodosOperation } from '../../__fixtures__/operations/put-todos';
7
+ import { requestBody } from '../../__fixtures__/operations/request-body';
8
+ import { duplicatedSecurityScheme } from '../../__fixtures__/operations/securedOperation';
9
+ import { operation as simpleGetOperation } from '../../__fixtures__/operations/simple-get';
10
+ import { httpOperation as urlEncodedOperation } from '../../__fixtures__/operations/urlencoded-post';
11
+ import { httpOperation as urlEncodedOneOfOperation } from '../../__fixtures__/operations/urlencoded-post-oneof';
12
+ import { operationWithUrlVariables } from '../../__fixtures__/operations/with-url-variables';
13
+ import { TryIt, TryItProps } from './TryIt';
14
+
15
+ export default {
16
+ title: 'Internal/TryIt Component',
17
+ component: TryIt,
18
+ } as Meta<TryItProps>;
19
+
20
+ const Template: Story<TryItProps> = args => <TryIt {...args} />;
21
+
22
+ export const SimpleGET = Template.bind({});
23
+ SimpleGET.args = {
24
+ httpOperation: simpleGetOperation,
25
+ };
26
+
27
+ export const WithParameters = Template.bind({});
28
+ WithParameters.args = {
29
+ httpOperation: putTodosOperation,
30
+ };
31
+
32
+ export const WithVariables = Template.bind({});
33
+ WithVariables.args = {
34
+ httpOperation: operationWithUrlVariables,
35
+ };
36
+
37
+ export const UrlEncoded = Template.bind({});
38
+ UrlEncoded.args = {
39
+ httpOperation: urlEncodedOperation,
40
+ };
41
+ UrlEncoded.storyName = 'application/x-www-form-urlencoded';
42
+
43
+ export const UrlEncodedOneOf = Template.bind({});
44
+ UrlEncodedOneOf.args = {
45
+ httpOperation: urlEncodedOneOfOperation,
46
+ };
47
+ UrlEncodedOneOf.storyName = 'application/x-www-form-urlencoded with oneOf';
48
+
49
+ export const Multipart = Template.bind({});
50
+ Multipart.args = {
51
+ httpOperation: multipartOperation,
52
+ };
53
+ Multipart.storyName = 'multipart/form-data (with file upload)';
54
+
55
+ export const RequestBodySchema = Template.bind({});
56
+ RequestBodySchema.args = {
57
+ httpOperation: requestBody,
58
+ };
59
+ RequestBodySchema.storyName = 'Request Body From Schema';
60
+
61
+ export const RequestBodyExamples = Template.bind({});
62
+ RequestBodyExamples.args = {
63
+ httpOperation: examplesRequestBody,
64
+ };
65
+ RequestBodyExamples.storyName = 'Request Body from Examples';
66
+
67
+ export const TryItAuth = Template.bind({});
68
+ TryItAuth.args = {
69
+ httpOperation: putTodosOperation,
70
+ };
71
+ TryItAuth.storyName = 'TryIt Auth';
72
+
73
+ export const TryItAuthDuplicated = Template.bind({});
74
+ TryItAuthDuplicated.args = {
75
+ httpOperation: duplicatedSecurityScheme,
76
+ };
77
+ TryItAuthDuplicated.storyName = 'TryIt Auth (Duplicated Parameters)';
@@ -0,0 +1,404 @@
1
+ import { Box, Button, HStack, Icon, ITextColorProps, Panel, useThemeIsDark } from '@stoplight/mosaic';
2
+ import type { HttpMethod, IHttpEndpointOperation, IServer } from '@stoplight/types';
3
+ import { Request as HarRequest } from 'har-format';
4
+ import { useAtom } from 'jotai';
5
+ import * as React from 'react';
6
+
7
+ import { HttpMethodColors } from '../../constants';
8
+ import { stringifyExampleWithResolvedSchema } from '../../utils/exampleGeneration/exampleGeneration';
9
+ import { isHttpOperation, isHttpWebhookOperation } from '../../utils/guards';
10
+ import { getServersToDisplay, getServerVariables } from '../../utils/http-spec/IServer';
11
+ import { extractCodeSamples, RequestSamples } from '../RequestSamples';
12
+ import { TryItAuth } from './Auth/Auth';
13
+ import { usePersistedSecuritySchemeWithValues } from './Auth/authentication-utils';
14
+ import { BinaryBody } from './Body/BinaryBody';
15
+ import { FormDataBody } from './Body/FormDataBody';
16
+ import { BodyParameterValues, useBodyParameterState } from './Body/request-body-utils';
17
+ import { RequestBody } from './Body/RequestBody';
18
+ import { useTextRequestBodyState } from './Body/useTextRequestBodyState';
19
+ import { buildFetchRequest, buildHarRequest } from './build-request';
20
+ import { chosenServerAtom } from './chosenServer';
21
+ import { getMockData } from './Mocking/mocking-utils';
22
+ import { MockingButton } from './Mocking/MockingButton';
23
+ import { useMockingOptions } from './Mocking/useMockingOptions';
24
+ import { OperationParameters } from './Parameters/OperationParameters';
25
+ import { useRequestParameters } from './Parameters/useOperationParameters';
26
+ import {
27
+ ErrorState,
28
+ getResponseType,
29
+ NetworkError,
30
+ ResponseError,
31
+ ResponseState,
32
+ TryItResponse,
33
+ } from './Response/Response';
34
+ import { ServersDropdown } from './Servers/ServersDropdown';
35
+ import { ServerVariables } from './Servers/ServerVariables';
36
+ import { useServerVariables } from './Servers/useServerVariables';
37
+
38
+ export interface TryItProps {
39
+ httpOperation: IHttpEndpointOperation;
40
+
41
+ /**
42
+ * The base URL of the prism mock server to redirect traffic to.
43
+ *
44
+ * While non-prism based mocks may work to some limited extent, they might not understand the Prefer header as prism does.
45
+ *
46
+ * When a mockUrl is provided, a button to enable mocking via TryIt will be shown
47
+ */
48
+ mockUrl?: string;
49
+
50
+ /**
51
+ * Callback to retrieve the current request in a HAR format.
52
+ * Called whenever the request was changed in any way. Changing `httpOperation`, user entering parameter values, etc.
53
+ */
54
+ onRequestChange?: (currentRequest: HarRequest) => void;
55
+ requestBodyIndex?: number;
56
+ /**
57
+ * True when TryIt is embedded in Markdown doc
58
+ */
59
+ embeddedInMd?: boolean;
60
+
61
+ /**
62
+ * True when TryIt Panel should be hidden
63
+ */
64
+ hideTryItPanel?: boolean;
65
+
66
+ /**
67
+ * Fetch credentials policy for TryIt component
68
+ * For more information: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
69
+ * @default "omit"
70
+ */
71
+ tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
72
+ corsProxy?: string;
73
+ }
74
+
75
+ /**
76
+ * Displays the TryIt component for a given IHttpOperation.
77
+ * Relies on jotai, needs to be wrapped in a PersistenceContextProvider
78
+ */
79
+
80
+ const defaultServers: IServer[] = [];
81
+
82
+ export const TryIt: React.FC<TryItProps> = ({
83
+ httpOperation,
84
+ mockUrl,
85
+ onRequestChange,
86
+ requestBodyIndex,
87
+ embeddedInMd = false,
88
+ hideTryItPanel = false,
89
+ tryItCredentialsPolicy,
90
+ corsProxy,
91
+ }) => {
92
+ TryIt.displayName = 'TryIt';
93
+ const isDark = useThemeIsDark();
94
+
95
+ const [response, setResponse] = React.useState<ResponseState | ErrorState | undefined>();
96
+ const [requestData, setRequestData] = React.useState<HarRequest | undefined>();
97
+
98
+ const [loading, setLoading] = React.useState<boolean>(false);
99
+ const [validateParameters, setValidateParameters] = React.useState<boolean>(false);
100
+
101
+ const mediaTypeContent = httpOperation.request?.body?.contents?.[requestBodyIndex ?? 0];
102
+
103
+ const { allParameters, updateParameterValue, parameterValuesWithDefaults } = useRequestParameters(httpOperation);
104
+ const [mockingOptions, setMockingOptions] = useMockingOptions();
105
+
106
+ const [bodyParameterValues, setBodyParameterValues, isAllowedEmptyValues, setAllowedEmptyValues, formDataState] =
107
+ useBodyParameterState(mediaTypeContent);
108
+
109
+ const [textRequestBody, setTextRequestBody] = useTextRequestBodyState(
110
+ mediaTypeContent,
111
+ !isHttpWebhookOperation(httpOperation),
112
+ );
113
+
114
+ const [operationAuthValue, setOperationAuthValue, setCurrentScheme] = usePersistedSecuritySchemeWithValues();
115
+
116
+ const servers = React.useMemo(() => {
117
+ return getServersToDisplay(httpOperation.servers || defaultServers, mockUrl, false);
118
+ }, [httpOperation.servers, mockUrl]);
119
+ const firstServer = servers[0] || null;
120
+ const [chosenServer, setChosenServer] = useAtom(chosenServerAtom);
121
+ const serverVariables = getServerVariables(chosenServer);
122
+ const { serverVariables: serverVariableValues, updateServerVariableValue } = useServerVariables();
123
+ const isMockingEnabled = mockUrl && chosenServer?.url === mockUrl;
124
+
125
+ const hasRequiredButEmptyParameters = allParameters.some(
126
+ parameter => parameter.required && !parameterValuesWithDefaults[parameter.name],
127
+ );
128
+
129
+ const customCodeSamples = extractCodeSamples(httpOperation);
130
+
131
+ const getValues = () =>
132
+ Object.keys(bodyParameterValues)
133
+ .filter(param => !isAllowedEmptyValues[param] ?? true)
134
+ .reduce<BodyParameterValues>((previousValue, currentValue) => {
135
+ previousValue[currentValue] = bodyParameterValues[currentValue];
136
+ return previousValue;
137
+ }, {});
138
+
139
+ const getBinaryValue = () => bodyParameterValues.file;
140
+
141
+ React.useEffect(() => {
142
+ const currentUrl = chosenServer?.url;
143
+
144
+ // simple attempt to preserve / sync up active server if the URLs are the same between re-renders / navigation
145
+ const exists = currentUrl && servers.find(s => s.url === currentUrl);
146
+ if (!exists) {
147
+ setChosenServer(firstServer);
148
+ } else if (exists.id !== chosenServer.id) {
149
+ setChosenServer(exists);
150
+ }
151
+ }, [servers, firstServer, chosenServer, setChosenServer]);
152
+
153
+ React.useEffect(() => {
154
+ let isMounted = true;
155
+ if (isHttpOperation(httpOperation) && (onRequestChange || embeddedInMd)) {
156
+ buildHarRequest({
157
+ mediaTypeContent,
158
+ parameterValues: parameterValuesWithDefaults,
159
+ serverVariableValues,
160
+ httpOperation,
161
+ bodyInput: formDataState.isFormDataBody
162
+ ? getValues()
163
+ : formDataState.isBinaryBody
164
+ ? getBinaryValue()
165
+ : textRequestBody,
166
+ auth: operationAuthValue,
167
+ ...(isMockingEnabled && { mockData: getMockData(mockUrl, httpOperation, mockingOptions) }),
168
+ chosenServer,
169
+ corsProxy,
170
+ }).then(request => {
171
+ if (isMounted) {
172
+ if (onRequestChange) {
173
+ onRequestChange(request);
174
+ }
175
+ if (embeddedInMd) {
176
+ setRequestData(request);
177
+ }
178
+ }
179
+ });
180
+ }
181
+ return () => {
182
+ isMounted = false;
183
+ };
184
+ // disabling because we don't want to react on `onRequestChange` change
185
+ // eslint-disable-next-line react-hooks/exhaustive-deps
186
+ }, [
187
+ httpOperation,
188
+ parameterValuesWithDefaults,
189
+ formDataState.isFormDataBody,
190
+ bodyParameterValues,
191
+ serverVariableValues,
192
+ isAllowedEmptyValues,
193
+ textRequestBody,
194
+ operationAuthValue,
195
+ mockingOptions,
196
+ chosenServer,
197
+ corsProxy,
198
+ embeddedInMd,
199
+ ]);
200
+
201
+ const handleSendRequest = async () => {
202
+ setValidateParameters(true);
203
+
204
+ if (hasRequiredButEmptyParameters || !isHttpOperation(httpOperation)) return;
205
+
206
+ try {
207
+ setLoading(true);
208
+ const mockData = isMockingEnabled ? getMockData(mockUrl, httpOperation, mockingOptions) : undefined;
209
+
210
+ const request = await buildFetchRequest({
211
+ parameterValues: parameterValuesWithDefaults,
212
+ serverVariableValues,
213
+ httpOperation,
214
+ mediaTypeContent,
215
+ bodyInput: formDataState.isFormDataBody
216
+ ? getValues()
217
+ : formDataState.isBinaryBody
218
+ ? getBinaryValue()
219
+ : textRequestBody,
220
+ mockData,
221
+ auth: operationAuthValue,
222
+ chosenServer,
223
+ credentials: tryItCredentialsPolicy,
224
+ corsProxy,
225
+ });
226
+ let response: Response | undefined;
227
+ try {
228
+ response = await fetch(...request);
229
+ } catch (e: any) {
230
+ setResponse({ error: new NetworkError(e.message) });
231
+ }
232
+ if (response) {
233
+ const contentType = response.headers.get('Content-Type');
234
+ const type = contentType ? getResponseType(contentType) : undefined;
235
+
236
+ let bodyText = type !== 'image' ? await response.text() : undefined;
237
+ const blob = type === 'image' ? await response.blob() : undefined;
238
+
239
+ let skipBodyParsing = false;
240
+
241
+ if (mockData && type === 'json' && bodyText) {
242
+ const responseMediaType = contentType?.split(';')[0];
243
+ const responseSchema = httpOperation.responses
244
+ .find(({ code }) => code === String(response?.status))
245
+ ?.contents?.find(({ mediaType }) => mediaType === responseMediaType)?.schema;
246
+
247
+ if (responseSchema) {
248
+ try {
249
+ bodyText = stringifyExampleWithResolvedSchema(JSON.parse(bodyText), responseSchema);
250
+ skipBodyParsing = true;
251
+ } catch {
252
+ // Preserve the original mock response if it is not valid JSON.
253
+ }
254
+ }
255
+ }
256
+
257
+ setResponse(undefined); // setting undefined to handle rendering large responses
258
+ setResponse({
259
+ status: response.status,
260
+ bodyText,
261
+ blob,
262
+ contentType,
263
+ skipBodyParsing,
264
+ });
265
+ }
266
+ } catch (e: any) {
267
+ setResponse({ error: e });
268
+ } finally {
269
+ setLoading(false);
270
+ }
271
+ };
272
+
273
+ const isOnlySendButton =
274
+ !httpOperation.security?.length && !allParameters.length && !formDataState.isFormDataBody && !mediaTypeContent;
275
+
276
+ const tryItPanelContents = (
277
+ <>
278
+ {httpOperation.security?.length ? (
279
+ <TryItAuth
280
+ operationSecuritySchemes={httpOperation.security}
281
+ operationAuthValue={operationAuthValue}
282
+ setOperationAuthValue={setOperationAuthValue}
283
+ setCurrentScheme={setCurrentScheme}
284
+ />
285
+ ) : null}
286
+
287
+ {isHttpOperation(httpOperation) && serverVariables.length > 0 && (
288
+ <ServerVariables
289
+ variables={serverVariables}
290
+ values={serverVariableValues}
291
+ onChangeValue={updateServerVariableValue}
292
+ />
293
+ )}
294
+
295
+ {allParameters.length > 0 && (
296
+ <OperationParameters
297
+ parameters={allParameters}
298
+ values={parameterValuesWithDefaults}
299
+ onChangeValue={updateParameterValue}
300
+ validate={validateParameters}
301
+ />
302
+ )}
303
+
304
+ <Box pb={1}>
305
+ {formDataState.isFormDataBody ? (
306
+ <FormDataBody
307
+ specification={formDataState.bodySpecification}
308
+ values={bodyParameterValues}
309
+ onChangeValues={setBodyParameterValues}
310
+ onChangeParameterAllow={setAllowedEmptyValues}
311
+ isAllowedEmptyValues={isAllowedEmptyValues}
312
+ />
313
+ ) : formDataState.isBinaryBody ? (
314
+ <BinaryBody
315
+ specification={formDataState.bodySpecification}
316
+ values={bodyParameterValues}
317
+ onChangeValues={setBodyParameterValues}
318
+ />
319
+ ) : mediaTypeContent ? (
320
+ <RequestBody
321
+ examples={mediaTypeContent.examples ?? []}
322
+ requestBody={textRequestBody}
323
+ onChange={setTextRequestBody}
324
+ />
325
+ ) : null}
326
+ </Box>
327
+
328
+ {isHttpOperation(httpOperation) ? (
329
+ <Panel.Content className="SendButtonHolder" pt={!isOnlySendButton && !embeddedInMd ? 0 : undefined}>
330
+ <HStack alignItems="center" spacing={2}>
331
+ <Button appearance="primary" loading={loading} disabled={loading} onPress={handleSendRequest} size="sm">
332
+ Send API Request
333
+ </Button>
334
+
335
+ {servers.length > 1 && <ServersDropdown servers={servers} />}
336
+
337
+ {isMockingEnabled && (
338
+ <MockingButton options={mockingOptions} onOptionsChange={setMockingOptions} operation={httpOperation} />
339
+ )}
340
+ </HStack>
341
+
342
+ {validateParameters && hasRequiredButEmptyParameters && (
343
+ <Box mt={4} color="danger-light" fontSize="sm">
344
+ <Icon icon={['fas', 'exclamation-triangle']} className="sl-mr-1" />
345
+ You didn't provide all of the required parameters!
346
+ </Box>
347
+ )}
348
+ </Panel.Content>
349
+ ) : null}
350
+ </>
351
+ );
352
+
353
+ let tryItPanelElem;
354
+
355
+ // when TryIt is embedded, we need to show extra context at the top about the method + path
356
+ if (embeddedInMd) {
357
+ let path: string;
358
+
359
+ if (isHttpOperation(httpOperation)) {
360
+ path = httpOperation.path;
361
+ } else if (isHttpWebhookOperation(httpOperation)) {
362
+ path = httpOperation.name;
363
+ } else {
364
+ throw new RangeError('unsupported type');
365
+ }
366
+
367
+ tryItPanelElem = (
368
+ <Panel isCollapsible={false} p={0} className="TryItPanel">
369
+ <Panel.Titlebar bg="canvas-300">
370
+ <Box
371
+ fontWeight="bold"
372
+ color={
373
+ !isDark ? (HttpMethodColors[httpOperation.method as HttpMethod] as ITextColorProps['color']) : undefined
374
+ }
375
+ >
376
+ {httpOperation.method.toUpperCase()}
377
+ </Box>
378
+ <Box fontWeight="medium" ml={2} textOverflow="truncate" overflowX="hidden">
379
+ {`${chosenServer?.url || ''}${path}`}
380
+ </Box>
381
+ </Panel.Titlebar>
382
+
383
+ {tryItPanelContents}
384
+ </Panel>
385
+ );
386
+ } else {
387
+ tryItPanelElem = (
388
+ <Box className="TryItPanel" bg="canvas-100">
389
+ {tryItPanelContents}
390
+ </Box>
391
+ );
392
+ }
393
+
394
+ return (
395
+ <Box rounded="lg" overflowY="hidden">
396
+ {hideTryItPanel ? null : tryItPanelElem}
397
+ {requestData && embeddedInMd && (
398
+ <RequestSamples request={requestData} customCodeSamples={customCodeSamples} embeddedInMd />
399
+ )}
400
+ {response && !('error' in response) && <TryItResponse response={response} />}
401
+ {response && 'error' in response && <ResponseError state={response} />}
402
+ </Box>
403
+ );
404
+ };
@@ -0,0 +1,143 @@
1
+ import { act, render, screen, waitFor } from '@testing-library/react';
2
+ import userEvent from '@testing-library/user-event';
3
+ import * as React from 'react';
4
+
5
+ import { httpOperation as putTodosOperation } from '../../__fixtures__/operations/put-todos';
6
+ import { operationWithUrlVariables } from '../../__fixtures__/operations/with-url-variables';
7
+ import { withPersistenceBoundary } from '../../context/Persistence';
8
+ import { withMosaicProvider } from '../../hoc/withMosaicProvider';
9
+ import { chooseOption } from '../../utils/tests/chooseOption';
10
+ import { TryItWithRequestSamples as RawComponent } from './TryItWithRequestSamples';
11
+
12
+ const TryItWithRequestSamples = withMosaicProvider(withPersistenceBoundary(RawComponent));
13
+
14
+ describe('TryItWithRequestSamples', () => {
15
+ it('displays RequestSamples and TryIt', async () => {
16
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
17
+
18
+ expect(await screen.findByText('Request Sample: Shell / cURL')).toBeVisible();
19
+ expect(await screen.findByRole('button', { name: /Send API Request/i })).toBeVisible();
20
+
21
+ const codeViewer = await screen.findByLabelText(/curl/);
22
+ expect(codeViewer).toHaveTextContent(/PUT/i);
23
+ });
24
+
25
+ it('RequestSamples hidden', async () => {
26
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} hideSamples={true} />);
27
+
28
+ await waitFor(() => expect(screen.queryByText('Request Sample: Shell / cURL')).not.toBeInTheDocument());
29
+ });
30
+
31
+ it('TryIt hidden', async () => {
32
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} hideTryIt={true} />);
33
+
34
+ await waitFor(() => expect(screen.queryByRole('button', { name: /Send API Request/i })).not.toBeInTheDocument());
35
+ });
36
+
37
+ it('reacts to parameter input', async () => {
38
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
39
+
40
+ const todoIdField = await screen.findByLabelText('todoId');
41
+ userEvent.type(todoIdField, '123456789');
42
+
43
+ const codeViewer = await screen.findByLabelText(/curl/);
44
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/todos\/123456789/));
45
+ });
46
+
47
+ it('reacts to mocking', async () => {
48
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} mockUrl="https://mock-todos.stoplight.io" />);
49
+
50
+ const serversButton = screen.getByRole('button', { name: /server/i });
51
+ act(() => userEvent.click(serversButton));
52
+
53
+ // enable mocking
54
+ let enableItem = screen.getByRole('menuitemradio', { name: /mock server/i });
55
+ act(() => userEvent.click(enableItem));
56
+
57
+ // open mock dropdown
58
+ const mockButton = screen.getByRole('button', { name: /mock settings/i });
59
+ act(() => userEvent.click(mockButton));
60
+
61
+ // set response code
62
+ const responseCodeItem = screen.getByRole('menuitemcheckbox', { name: '200' });
63
+ act(() => userEvent.click(responseCodeItem));
64
+
65
+ const codeViewer = await screen.findByLabelText(/curl/);
66
+ expect(codeViewer).toHaveTextContent(/https:\/\/mock-todos\.stoplight\.io/);
67
+ expect(codeViewer).toHaveTextContent(/Prefer: code=200/);
68
+ });
69
+
70
+ it('includes renders authentication data with suggested value initially', async () => {
71
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
72
+
73
+ const codeViewer = await screen.findByLabelText(/curl/);
74
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/&API\+Key=123'/));
75
+
76
+ const apiKeyField = await screen.findByLabelText('API Key');
77
+ userEvent.type(apiKeyField, '123456789');
78
+
79
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/&API\+Key=123456789'/));
80
+
81
+ userEvent.clear(apiKeyField);
82
+ userEvent.type(apiKeyField, '23456789');
83
+
84
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/&API\+Key=23456789'/));
85
+
86
+ userEvent.clear(apiKeyField);
87
+
88
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/&API\+Key=123'/));
89
+ });
90
+
91
+ it('displays parameter name for empty path parameter', async () => {
92
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
93
+
94
+ const codeViewer = await screen.findByLabelText(/curl/);
95
+ await waitFor(() => expect(codeViewer).toHaveTextContent(/todos\/{todoId}/));
96
+ });
97
+
98
+ it('displays base url correctly', async () => {
99
+ render(<TryItWithRequestSamples httpOperation={operationWithUrlVariables} />);
100
+
101
+ const codeViewer = await screen.findByLabelText(/curl/);
102
+ expect(codeViewer).toHaveTextContent('ftp://default-namespace.stoplight.io/api/eu/todos');
103
+ });
104
+
105
+ it('by default displays 1st server url in request samples', async () => {
106
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
107
+
108
+ const codeViewer = await screen.findByLabelText(/curl/);
109
+ expect(codeViewer).toHaveTextContent('https://todos.stoplight.io');
110
+ });
111
+
112
+ it('changes request sample when changing server', async () => {
113
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
114
+
115
+ const serversButton = screen.getByRole('button', { name: /server/i });
116
+ act(() => userEvent.click(serversButton));
117
+
118
+ let enableItem = screen.getByRole('menuitemradio', { name: /development/i });
119
+ act(() => userEvent.click(enableItem));
120
+
121
+ const codeViewer = await screen.findByLabelText(/curl/);
122
+ expect(codeViewer).toHaveTextContent('https://todos-dev.stoplight.io');
123
+ });
124
+
125
+ it('changes request sample when changing server variables', async () => {
126
+ render(<TryItWithRequestSamples httpOperation={putTodosOperation} />);
127
+
128
+ const serversButton = screen.getByRole('button', { name: /server/i });
129
+ userEvent.click(serversButton);
130
+
131
+ let enableItem = screen.getByRole('menuitemradio', { name: /pr/i });
132
+ userEvent.click(enableItem);
133
+
134
+ const protoField = screen.getByLabelText('proto');
135
+ chooseOption(protoField, 'https');
136
+
137
+ const prField = screen.getByLabelText('pr');
138
+ userEvent.type(prField, '123');
139
+
140
+ const codeViewer = await screen.findByLabelText(/curl/);
141
+ expect(codeViewer).toHaveTextContent('https://x-123.todos-pr.stoplight.io');
142
+ });
143
+ });
@@ -0,0 +1,32 @@
1
+ import { Meta, Story } from '@storybook/react';
2
+ import * as React from 'react';
3
+
4
+ import { httpOperation as putTodosOperation } from '../../__fixtures__/operations/put-todos';
5
+ import { operationWithUrlVariables } from '../../__fixtures__/operations/with-url-variables';
6
+ import { TryItWithRequestSamples, TryItWithRequestSamplesProps } from './TryItWithRequestSamples';
7
+
8
+ export default {
9
+ title: 'Internal/TryItWithRequestSamples',
10
+ component: TryItWithRequestSamples,
11
+ } as Meta<TryItWithRequestSamplesProps>;
12
+
13
+ const Template: Story<TryItWithRequestSamplesProps> = args => <TryItWithRequestSamples {...args} />;
14
+
15
+ export const WithParameters = Template.bind({});
16
+ WithParameters.args = {
17
+ httpOperation: putTodosOperation,
18
+ };
19
+ WithParameters.storyName = 'With Parameters';
20
+
21
+ export const WithVariables = Template.bind({});
22
+ WithVariables.args = {
23
+ httpOperation: operationWithUrlVariables,
24
+ };
25
+ WithVariables.storyName = 'With Server Variables';
26
+
27
+ export const WithoutTryItPanel = Template.bind({});
28
+ WithoutTryItPanel.args = {
29
+ hideTryIt: true,
30
+ httpOperation: operationWithUrlVariables,
31
+ };
32
+ WithoutTryItPanel.storyName = 'Without Try It Panel';