@stoplight/elements-core 9.0.11 → 9.0.12-beta-0.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.
- package/.storybook/main.js +6 -0
- package/.storybook/manager.js +1 -0
- package/.storybook/preview.jsx +50 -0
- package/dist/LICENSE +190 -0
- package/dist/README.md +1 -0
- package/{index.esm.js → dist/index.esm.js} +59 -1
- package/{index.js → dist/index.js} +59 -1
- package/{index.mjs → dist/index.mjs} +59 -1
- package/dist/package.json +64 -0
- package/jest.config.js +10 -0
- package/package.json +74 -14
- package/src/__fixtures__/articles/basic.md +10 -0
- package/src/__fixtures__/articles/kitchen-sink.md +318 -0
- package/src/__fixtures__/articles/long-page-heading.md +955 -0
- package/src/__fixtures__/articles/multiple-try-its.md +54 -0
- package/src/__fixtures__/articles/schema-with-refs.ts +82 -0
- package/src/__fixtures__/http-request.json +11 -0
- package/src/__fixtures__/models/model-with-no-examples.json +15 -0
- package/src/__fixtures__/models/model-with-one-example.json +23 -0
- package/src/__fixtures__/models/model-with-three-examples.json +35 -0
- package/src/__fixtures__/operations/application-octet-stream-post.ts +39 -0
- package/src/__fixtures__/operations/base64-file-upload.ts +43 -0
- package/src/__fixtures__/operations/big-response.ts +4690 -0
- package/src/__fixtures__/operations/bundled-parameter.ts +128 -0
- package/src/__fixtures__/operations/empty-response.ts +15 -0
- package/src/__fixtures__/operations/examples-request-body.ts +135 -0
- package/src/__fixtures__/operations/head-todos.ts +49 -0
- package/src/__fixtures__/operations/invalid-response-example.ts +45 -0
- package/src/__fixtures__/operations/multipart-formdata-post.ts +61 -0
- package/src/__fixtures__/operations/operation-minimal.ts +11 -0
- package/src/__fixtures__/operations/operation-parameters.ts +337 -0
- package/src/__fixtures__/operations/operation-with-examples.ts +113 -0
- package/src/__fixtures__/operations/operation-without-servers.ts +16 -0
- package/src/__fixtures__/operations/patch-todos.ts +49 -0
- package/src/__fixtures__/operations/put-todos.ts +862 -0
- package/src/__fixtures__/operations/referenced-body.ts +62 -0
- package/src/__fixtures__/operations/request-body-empty-schema.ts +35 -0
- package/src/__fixtures__/operations/request-body.ts +62 -0
- package/src/__fixtures__/operations/securedOperation.ts +118 -0
- package/src/__fixtures__/operations/security-basic.ts +24 -0
- package/src/__fixtures__/operations/security-bearer.ts +25 -0
- package/src/__fixtures__/operations/simple-get.ts +17 -0
- package/src/__fixtures__/operations/simple.ts +103 -0
- package/src/__fixtures__/operations/string-numeric-enums.ts +32 -0
- package/src/__fixtures__/operations/urlencoded-post-oneof.ts +81 -0
- package/src/__fixtures__/operations/urlencoded-post.ts +54 -0
- package/src/__fixtures__/operations/vendor-extensions.ts +337 -0
- package/src/__fixtures__/operations/with-url-variables.ts +47 -0
- package/src/__fixtures__/operations/x-code-samples.ts +348 -0
- package/src/__fixtures__/schemas/circular.ts +1906 -0
- package/src/__fixtures__/schemas/contact.json +293 -0
- package/src/__fixtures__/schemas/media-entry.json +69 -0
- package/src/__fixtures__/schemas/simple.json +27 -0
- package/src/__fixtures__/schemas/todo-full.v1.json +35 -0
- package/src/__fixtures__/schemas/todo-partial.v1.json +14 -0
- package/src/__fixtures__/schemas/user.v1.json +17 -0
- package/src/__fixtures__/security-schemes/index.ts +38 -0
- package/src/__fixtures__/services/petstore.ts +167 -0
- package/src/__fixtures__/services/with-unnamed-servers.ts +38 -0
- package/src/__fixtures__/services/with-url-variables.ts +83 -0
- package/src/__fixtures__/services/without-origin.ts +20 -0
- package/src/__fixtures__/table-of-contents/nested.ts +44 -0
- package/src/__fixtures__/table-of-contents/studio-template.ts +100 -0
- package/src/__fixtures__/table-of-contents/studio.ts +559 -0
- package/src/components/Docs/Article/Article.spec.tsx +38 -0
- package/src/components/Docs/Article/Article.stories.tsx +17 -0
- package/src/components/Docs/Article/index.tsx +38 -0
- package/src/components/Docs/Docs.stories.tsx +33 -0
- package/src/components/Docs/Docs.tsx +272 -0
- package/src/components/Docs/HttpOperation/Badges.tsx +49 -0
- package/src/components/Docs/HttpOperation/Body.tsx +115 -0
- package/src/components/Docs/HttpOperation/Callbacks.tsx +89 -0
- package/src/components/Docs/HttpOperation/HttpOperation.spec.tsx +787 -0
- package/src/components/Docs/HttpOperation/HttpOperation.stories.ts +14 -0
- package/src/components/Docs/HttpOperation/HttpOperation.tsx +260 -0
- package/src/components/Docs/HttpOperation/LazySchemaTreePreviewer.tsx +651 -0
- package/src/components/Docs/HttpOperation/Parameters.spec.tsx +101 -0
- package/src/components/Docs/HttpOperation/Parameters.tsx +118 -0
- package/src/components/Docs/HttpOperation/Request.tsx +152 -0
- package/src/components/Docs/HttpOperation/Responses.tsx +301 -0
- package/src/components/Docs/HttpOperation/index.ts +1 -0
- package/src/components/Docs/HttpService/AdditionalInfo.stories.ts +48 -0
- package/src/components/Docs/HttpService/AdditionalInfo.tsx +61 -0
- package/src/components/Docs/HttpService/ExportButton.tsx +35 -0
- package/src/components/Docs/HttpService/HttpService.spec.tsx +429 -0
- package/src/components/Docs/HttpService/HttpService.stories.ts +14 -0
- package/src/components/Docs/HttpService/HttpService.tsx +99 -0
- package/src/components/Docs/HttpService/SecuritySchemes.tsx +82 -0
- package/src/components/Docs/HttpService/ServerInfo.tsx +196 -0
- package/src/components/Docs/HttpService/index.ts +1 -0
- package/src/components/Docs/Model/Model.spec.tsx +241 -0
- package/src/components/Docs/Model/Model.stories.tsx +16 -0
- package/src/components/Docs/Model/Model.tsx +192 -0
- package/src/components/Docs/Model/index.ts +1 -0
- package/src/components/Docs/NodeVendorExtensions.tsx +55 -0
- package/src/components/Docs/Sections.tsx +54 -0
- package/src/components/Docs/Security/PanelContent.tsx +38 -0
- package/src/components/Docs/Security/index.ts +1 -0
- package/src/components/Docs/Skeleton.tsx +12 -0
- package/src/components/Docs/TwoColumnLayout.tsx +27 -0
- package/src/components/Docs/index.ts +1 -0
- package/src/components/Docs/story-helper.ts +46 -0
- package/src/components/Docs/story-renderer-helper.tsx +56 -0
- package/src/components/Layout/MobileTopNav.tsx +78 -0
- package/src/components/Layout/ResponsiveSidebarLayout.tsx +175 -0
- package/src/components/Layout/SidebarLayout.tsx +107 -0
- package/src/components/LinkHeading.tsx +21 -0
- package/src/components/LoadMore.tsx +20 -0
- package/src/components/Loading/Loading.tsx +9 -0
- package/src/components/Logo.tsx +25 -0
- package/src/components/MarkdownViewer/CustomComponents/CodeComponent.spec.ts +90 -0
- package/src/components/MarkdownViewer/CustomComponents/CodeComponent.tsx +164 -0
- package/src/components/MarkdownViewer/CustomComponents/Provider.tsx +20 -0
- package/src/components/MarkdownViewer/CustomComponents/ReactRouterLink.tsx +27 -0
- package/src/components/MarkdownViewer/CustomComponents/ResolvedImage.tsx +86 -0
- package/src/components/MarkdownViewer/CustomComponents/ScrollToHashElement.tsx +96 -0
- package/src/components/MarkdownViewer/MarkdownViewer.spec.tsx +170 -0
- package/src/components/MarkdownViewer/index.tsx +10 -0
- package/src/components/NonIdealState.tsx +20 -0
- package/src/components/PoweredByLink.tsx +30 -0
- package/src/components/RequestSamples/RequestSamples.stories.tsx +67 -0
- package/src/components/RequestSamples/RequestSamples.tsx +246 -0
- package/src/components/RequestSamples/__tests__/RequestSamples.test.tsx +131 -0
- package/src/components/RequestSamples/__tests__/__snapshots__/convertRequestToSample.spec.ts.snap +746 -0
- package/src/components/RequestSamples/__tests__/convertRequestToSample.spec.ts +118 -0
- package/src/components/RequestSamples/convertRequestToSample.ts +56 -0
- package/src/components/RequestSamples/extractCodeSamples.ts +50 -0
- package/src/components/RequestSamples/index.ts +2 -0
- package/src/components/RequestSamples/requestSampleConfigs.ts +182 -0
- package/src/components/ResponseExamples/ResponseExamples.spec.tsx +121 -0
- package/src/components/ResponseExamples/ResponseExamples.stories.tsx +21 -0
- package/src/components/ResponseExamples/ResponseExamples.tsx +79 -0
- package/src/components/TableOfContents/TableOfContents.spec.tsx +301 -0
- package/src/components/TableOfContents/TableOfContents.stories.tsx +121 -0
- package/src/components/TableOfContents/TableOfContents.tsx +406 -0
- package/src/components/TableOfContents/constants.ts +45 -0
- package/src/components/TableOfContents/index.ts +2 -0
- package/src/components/TableOfContents/types.ts +51 -0
- package/src/components/TableOfContents/utils.ts +84 -0
- package/src/components/TryIt/Auth/APIKeyAuth.tsx +19 -0
- package/src/components/TryIt/Auth/Auth.tsx +169 -0
- package/src/components/TryIt/Auth/AuthTokenInput.tsx +37 -0
- package/src/components/TryIt/Auth/BasicAuth.tsx +62 -0
- package/src/components/TryIt/Auth/BearerAuth.tsx +19 -0
- package/src/components/TryIt/Auth/DigestAuth.tsx +35 -0
- package/src/components/TryIt/Auth/OAuth2Auth.tsx +19 -0
- package/src/components/TryIt/Auth/authentication-utils.ts +113 -0
- package/src/components/TryIt/Body/BinaryBody.tsx +52 -0
- package/src/components/TryIt/Body/FormDataBody.tsx +145 -0
- package/src/components/TryIt/Body/RequestBody.tsx +71 -0
- package/src/components/TryIt/Body/__tests__/BinaryBody.test.tsx +29 -0
- package/src/components/TryIt/Body/__tests__/FormDataBody.test.tsx +94 -0
- package/src/components/TryIt/Body/request-body-utils.ts +127 -0
- package/src/components/TryIt/Body/useTextRequestBodyState.ts +27 -0
- package/src/components/TryIt/Mocking/MockingButton.tsx +98 -0
- package/src/components/TryIt/Mocking/mocking-utils.ts +56 -0
- package/src/components/TryIt/Mocking/useMockingOptions.ts +6 -0
- package/src/components/TryIt/Parameters/FileUploadParameterEditors.tsx +62 -0
- package/src/components/TryIt/Parameters/OperationParameters.tsx +39 -0
- package/src/components/TryIt/Parameters/ParameterEditor.tsx +118 -0
- package/src/components/TryIt/Parameters/__tests__/parameter-utils.spec.ts +60 -0
- package/src/components/TryIt/Parameters/parameter-utils.spec.ts +118 -0
- package/src/components/TryIt/Parameters/parameter-utils.ts +179 -0
- package/src/components/TryIt/Parameters/useOperationParameters.ts +60 -0
- package/src/components/TryIt/Response/ReponseCodeViewer.tsx +28 -0
- package/src/components/TryIt/Response/Response.spec.tsx +174 -0
- package/src/components/TryIt/Response/Response.tsx +172 -0
- package/src/components/TryIt/Response/hooks/useLineCount.ts +7 -0
- package/src/components/TryIt/Servers/ServerVariables.tsx +33 -0
- package/src/components/TryIt/Servers/ServersDropdown.tsx +53 -0
- package/src/components/TryIt/Servers/VariableEditor.tsx +51 -0
- package/src/components/TryIt/Servers/useServerVariables.ts +19 -0
- package/src/components/TryIt/TryIt.spec.tsx +1511 -0
- package/src/components/TryIt/TryIt.stories.tsx +77 -0
- package/src/components/TryIt/TryIt.tsx +384 -0
- package/src/components/TryIt/TryItWithRequestSamples.spec.tsx +143 -0
- package/src/components/TryIt/TryItWithRequestSamples.stories.tsx +32 -0
- package/src/components/TryIt/TryItWithRequestSamples.tsx +42 -0
- package/src/components/TryIt/build-request.spec.ts +213 -0
- package/src/components/TryIt/build-request.ts +357 -0
- package/src/components/TryIt/chosenServer.ts +5 -0
- package/src/components/TryIt/index.ts +3 -0
- package/src/components/__tests__/LinkHeading.spec.tsx +125 -0
- package/src/constants.ts +176 -0
- package/src/containers/MockingProvider.tsx +23 -0
- package/src/context/InlineRefResolver.spec.tsx +183 -0
- package/src/context/InlineRefResolver.tsx +94 -0
- package/src/context/Options.tsx +27 -0
- package/src/context/Persistence.tsx +24 -0
- package/src/context/RouterType.tsx +9 -0
- package/src/core.css +97 -0
- package/src/hoc/utils.ts +5 -0
- package/src/hoc/withMosaicProvider.spec.tsx +48 -0
- package/src/hoc/withMosaicProvider.tsx +28 -0
- package/src/hoc/withQueryClientProvider.spec.tsx +38 -0
- package/src/hoc/withQueryClientProvider.tsx +35 -0
- package/src/hoc/withRouter.tsx +71 -0
- package/src/hooks/useBundleRefsIntoDocument.ts +60 -0
- package/src/hooks/useFirstRender.ts +8 -0
- package/src/hooks/useIsCompact.ts +26 -0
- package/src/hooks/useParsedData.ts +99 -0
- package/src/hooks/useParsedValue.ts +19 -0
- package/src/hooks/useResponsiveLayout.tsx +51 -0
- package/src/hooks/useRouter.tsx +31 -0
- package/src/hooks/useUniqueId.ts +4 -0
- package/src/index.ts +48 -0
- package/src/styled.tsx +22 -0
- package/src/styles.css +4 -0
- package/src/types.ts +170 -0
- package/src/utils/__tests__/securitySchemes.spec.ts +137 -0
- package/src/utils/exampleGeneration/exampleGeneration.spec.tsx +18 -0
- package/src/utils/exampleGeneration/exampleGeneration.ts +110 -0
- package/src/utils/fileToBase64.ts +11 -0
- package/src/utils/guards.ts +48 -0
- package/src/utils/headers.ts +316 -0
- package/src/utils/http-spec/IServer.ts +100 -0
- package/src/utils/http-spec/__tests__/IServer.spec.ts +51 -0
- package/src/utils/http-spec/examples.ts +5 -0
- package/src/utils/http.ts +9 -0
- package/src/utils/jotai/persistAtom.ts +31 -0
- package/src/utils/node.ts +19 -0
- package/src/utils/oas/__tests__/security.spec.ts +18 -0
- package/src/utils/oas/security.ts +76 -0
- package/src/utils/ref-resolving/ReferenceResolver.ts +29 -0
- package/src/utils/ref-resolving/resolvedObject.test.ts +415 -0
- package/src/utils/ref-resolving/resolvedObject.ts +109 -0
- package/src/utils/securitySchemes.ts +117 -0
- package/src/utils/string.ts +15 -0
- package/src/utils/tests/chooseOption.ts +7 -0
- package/src/web-components/createElementClass.ts +154 -0
- package/tsconfig.build.json +14 -0
- package/tsconfig.json +7 -0
- /package/{__fixtures__ → dist/__fixtures__}/articles/schema-with-refs.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/application-octet-stream-post.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/base64-file-upload.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/big-response.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/examples-request-body.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/head-todos.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/multipart-formdata-post.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/operation-minimal.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/operation-parameters.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/operation-with-examples.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/operation-without-servers.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/patch-todos.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/put-todos.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/referenced-body.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/request-body-empty-schema.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/request-body.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/securedOperation.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/security-basic.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/security-bearer.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/simple-get.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/string-numeric-enums.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post-oneof.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/operations/with-url-variables.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/security-schemes/index.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/services/petstore.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/services/with-unnamed-servers.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/services/with-url-variables.d.ts +0 -0
- /package/{__fixtures__ → dist/__fixtures__}/services/without-origin.d.ts +0 -0
- /package/{components → dist/components}/Docs/Article/Article.spec.d.ts +0 -0
- /package/{components → dist/components}/Docs/Article/Article.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/Article/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/Docs.d.ts +0 -0
- /package/{components → dist/components}/Docs/Docs.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Badges.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Body.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Callbacks.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.spec.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/LazySchemaTreePreviewer.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Parameters.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Parameters.spec.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Request.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/Responses.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpOperation/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/ExportButton.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/HttpService.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/HttpService.spec.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/HttpService.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/SecuritySchemes.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/ServerInfo.d.ts +0 -0
- /package/{components → dist/components}/Docs/HttpService/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/Model/Model.d.ts +0 -0
- /package/{components → dist/components}/Docs/Model/Model.spec.d.ts +0 -0
- /package/{components → dist/components}/Docs/Model/Model.stories.d.ts +0 -0
- /package/{components → dist/components}/Docs/Model/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/NodeVendorExtensions.d.ts +0 -0
- /package/{components → dist/components}/Docs/Sections.d.ts +0 -0
- /package/{components → dist/components}/Docs/Security/PanelContent.d.ts +0 -0
- /package/{components → dist/components}/Docs/Security/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/Skeleton.d.ts +0 -0
- /package/{components → dist/components}/Docs/TwoColumnLayout.d.ts +0 -0
- /package/{components → dist/components}/Docs/index.d.ts +0 -0
- /package/{components → dist/components}/Docs/story-helper.d.ts +0 -0
- /package/{components → dist/components}/Docs/story-renderer-helper.d.ts +0 -0
- /package/{components → dist/components}/Layout/MobileTopNav.d.ts +0 -0
- /package/{components → dist/components}/Layout/ResponsiveSidebarLayout.d.ts +0 -0
- /package/{components → dist/components}/Layout/SidebarLayout.d.ts +0 -0
- /package/{components → dist/components}/LinkHeading.d.ts +0 -0
- /package/{components → dist/components}/LoadMore.d.ts +0 -0
- /package/{components → dist/components}/Loading/Loading.d.ts +0 -0
- /package/{components → dist/components}/Logo.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.spec.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/Provider.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/ReactRouterLink.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/ResolvedImage.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/CustomComponents/ScrollToHashElement.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/MarkdownViewer.spec.d.ts +0 -0
- /package/{components → dist/components}/MarkdownViewer/index.d.ts +0 -0
- /package/{components → dist/components}/NonIdealState.d.ts +0 -0
- /package/{components → dist/components}/PoweredByLink.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/RequestSamples.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/RequestSamples.stories.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/convertRequestToSample.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/extractCodeSamples.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/index.d.ts +0 -0
- /package/{components → dist/components}/RequestSamples/requestSampleConfigs.d.ts +0 -0
- /package/{components → dist/components}/ResponseExamples/ResponseExamples.d.ts +0 -0
- /package/{components → dist/components}/ResponseExamples/ResponseExamples.spec.d.ts +0 -0
- /package/{components → dist/components}/ResponseExamples/ResponseExamples.stories.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/TableOfContents.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/TableOfContents.spec.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/TableOfContents.stories.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/constants.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/index.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/types.d.ts +0 -0
- /package/{components → dist/components}/TableOfContents/utils.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/APIKeyAuth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/Auth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/AuthTokenInput.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/BasicAuth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/BearerAuth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/DigestAuth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/OAuth2Auth.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Auth/authentication-utils.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Body/BinaryBody.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Body/FormDataBody.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Body/RequestBody.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Body/request-body-utils.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Body/useTextRequestBodyState.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Mocking/MockingButton.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Mocking/mocking-utils.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Mocking/useMockingOptions.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/FileUploadParameterEditors.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/OperationParameters.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/ParameterEditor.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/parameter-utils.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/parameter-utils.spec.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Parameters/useOperationParameters.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Response/ReponseCodeViewer.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Response/Response.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Response/Response.spec.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Response/hooks/useLineCount.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Servers/ServerVariables.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Servers/ServersDropdown.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Servers/VariableEditor.d.ts +0 -0
- /package/{components → dist/components}/TryIt/Servers/useServerVariables.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryIt.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryIt.spec.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryIt.stories.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryItWithRequestSamples.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryItWithRequestSamples.spec.d.ts +0 -0
- /package/{components → dist/components}/TryIt/TryItWithRequestSamples.stories.d.ts +0 -0
- /package/{components → dist/components}/TryIt/build-request.d.ts +0 -0
- /package/{components → dist/components}/TryIt/build-request.spec.d.ts +0 -0
- /package/{components → dist/components}/TryIt/chosenServer.d.ts +0 -0
- /package/{components → dist/components}/TryIt/index.d.ts +0 -0
- /package/{constants.d.ts → dist/constants.d.ts} +0 -0
- /package/{containers → dist/containers}/MockingProvider.d.ts +0 -0
- /package/{context → dist/context}/InlineRefResolver.d.ts +0 -0
- /package/{context → dist/context}/InlineRefResolver.spec.d.ts +0 -0
- /package/{context → dist/context}/Options.d.ts +0 -0
- /package/{context → dist/context}/Persistence.d.ts +0 -0
- /package/{context → dist/context}/RouterType.d.ts +0 -0
- /package/{core.css → dist/core.css} +0 -0
- /package/{hoc → dist/hoc}/utils.d.ts +0 -0
- /package/{hoc → dist/hoc}/withMosaicProvider.d.ts +0 -0
- /package/{hoc → dist/hoc}/withMosaicProvider.spec.d.ts +0 -0
- /package/{hoc → dist/hoc}/withQueryClientProvider.d.ts +0 -0
- /package/{hoc → dist/hoc}/withQueryClientProvider.spec.d.ts +0 -0
- /package/{hoc → dist/hoc}/withRouter.d.ts +0 -0
- /package/{hooks → dist/hooks}/useBundleRefsIntoDocument.d.ts +0 -0
- /package/{hooks → dist/hooks}/useFirstRender.d.ts +0 -0
- /package/{hooks → dist/hooks}/useIsCompact.d.ts +0 -0
- /package/{hooks → dist/hooks}/useParsedData.d.ts +0 -0
- /package/{hooks → dist/hooks}/useParsedValue.d.ts +0 -0
- /package/{hooks → dist/hooks}/useResponsiveLayout.d.ts +0 -0
- /package/{hooks → dist/hooks}/useRouter.d.ts +0 -0
- /package/{hooks → dist/hooks}/useUniqueId.d.ts +0 -0
- /package/{index.d.ts → dist/index.d.ts} +0 -0
- /package/{styled.d.ts → dist/styled.d.ts} +0 -0
- /package/{styles.min.css → dist/styles.min.css} +0 -0
- /package/{types.d.ts → dist/types.d.ts} +0 -0
- /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.d.ts +0 -0
- /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.spec.d.ts +0 -0
- /package/{utils → dist/utils}/fileToBase64.d.ts +0 -0
- /package/{utils → dist/utils}/guards.d.ts +0 -0
- /package/{utils → dist/utils}/headers.d.ts +0 -0
- /package/{utils → dist/utils}/http-spec/IServer.d.ts +0 -0
- /package/{utils → dist/utils}/http-spec/examples.d.ts +0 -0
- /package/{utils → dist/utils}/http.d.ts +0 -0
- /package/{utils → dist/utils}/jotai/persistAtom.d.ts +0 -0
- /package/{utils → dist/utils}/node.d.ts +0 -0
- /package/{utils → dist/utils}/oas/security.d.ts +0 -0
- /package/{utils → dist/utils}/ref-resolving/ReferenceResolver.d.ts +0 -0
- /package/{utils → dist/utils}/ref-resolving/resolvedObject.d.ts +0 -0
- /package/{utils → dist/utils}/ref-resolving/resolvedObject.test.d.ts +0 -0
- /package/{utils → dist/utils}/securitySchemes.d.ts +0 -0
- /package/{utils → dist/utils}/string.d.ts +0 -0
- /package/{utils → dist/utils}/tests/chooseOption.d.ts +0 -0
- /package/{web-components → dist/web-components}/createElementClass.d.ts +0 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import { Button, Menu, MenuItems, Panel } from '@stoplight/mosaic';
|
|
2
|
+
import { HttpSecurityScheme } from '@stoplight/types';
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
|
|
5
|
+
import { getReadableSecurityName, getReadableSecurityNames, shouldAddKey } from '../../../utils/oas/security';
|
|
6
|
+
import { APIKeyAuth } from './APIKeyAuth';
|
|
7
|
+
import { createUndefinedValuedSchemes, HttpSecuritySchemeWithValues } from './authentication-utils';
|
|
8
|
+
import { BasicAuth } from './BasicAuth';
|
|
9
|
+
import { BearerAuth } from './BearerAuth';
|
|
10
|
+
import { DigestAuth } from './DigestAuth';
|
|
11
|
+
import { OAuth2Auth } from './OAuth2Auth';
|
|
12
|
+
|
|
13
|
+
interface TryItAuthProps {
|
|
14
|
+
operationSecuritySchemes: HttpSecurityScheme[][];
|
|
15
|
+
operationAuthValue: HttpSecuritySchemeWithValues[] | undefined;
|
|
16
|
+
setOperationAuthValue: React.Dispatch<HttpSecuritySchemeWithValues | undefined>;
|
|
17
|
+
setCurrentScheme: React.Dispatch<HttpSecuritySchemeWithValues[] | undefined>;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const checkViableCurrentAuth = (
|
|
21
|
+
current: HttpSecuritySchemeWithValues[] | undefined,
|
|
22
|
+
operationSecuritySchemes: HttpSecurityScheme[][],
|
|
23
|
+
) => {
|
|
24
|
+
if (current === undefined) return false;
|
|
25
|
+
|
|
26
|
+
const flattened = operationSecuritySchemes.flat(1);
|
|
27
|
+
for (const element of current) {
|
|
28
|
+
if (!flattened.some(flat => flat.id === element.scheme.id)) return false;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
return true;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
const createMenuChild = (name: string, currentItemName: string | undefined, onPress: () => void) => {
|
|
35
|
+
return {
|
|
36
|
+
id: `security-scheme-${name}`,
|
|
37
|
+
title: name,
|
|
38
|
+
isChecked: name === currentItemName,
|
|
39
|
+
onPress,
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
export const TryItAuth: React.FC<TryItAuthProps> = ({
|
|
44
|
+
operationSecuritySchemes,
|
|
45
|
+
operationAuthValue,
|
|
46
|
+
setOperationAuthValue,
|
|
47
|
+
setCurrentScheme,
|
|
48
|
+
}) => {
|
|
49
|
+
const filteredSecurityItems = operationSecuritySchemes.filter(
|
|
50
|
+
auth => auth.length === 0 || auth.every(scheme => securitySchemeKeys.includes(scheme.type)),
|
|
51
|
+
);
|
|
52
|
+
|
|
53
|
+
const menuName = operationAuthValue
|
|
54
|
+
? getReadableSecurityNames(operationAuthValue.map(auth => auth.scheme))
|
|
55
|
+
: 'Security Scheme';
|
|
56
|
+
|
|
57
|
+
const currentName = operationAuthValue
|
|
58
|
+
? getReadableSecurityNames(
|
|
59
|
+
operationAuthValue.map(auth => auth.scheme),
|
|
60
|
+
shouldAddKey(
|
|
61
|
+
operationAuthValue.map(auth => auth.scheme),
|
|
62
|
+
operationSecuritySchemes,
|
|
63
|
+
),
|
|
64
|
+
)
|
|
65
|
+
: undefined;
|
|
66
|
+
|
|
67
|
+
const handleChange = (scheme: HttpSecurityScheme, authValue?: string) => {
|
|
68
|
+
setOperationAuthValue({ scheme, authValue });
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
React.useEffect(() => {
|
|
72
|
+
if (checkViableCurrentAuth(operationAuthValue, operationSecuritySchemes) === false) {
|
|
73
|
+
setCurrentScheme(createUndefinedValuedSchemes(operationSecuritySchemes[0]));
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
const menuItems = React.useMemo(() => {
|
|
78
|
+
const items: MenuItems = [
|
|
79
|
+
{
|
|
80
|
+
type: 'group',
|
|
81
|
+
title: 'Security Schemes',
|
|
82
|
+
children: filteredSecurityItems.map(auth =>
|
|
83
|
+
createMenuChild(
|
|
84
|
+
getReadableSecurityNames(auth, shouldAddKey(auth, operationSecuritySchemes)),
|
|
85
|
+
currentName,
|
|
86
|
+
() => setCurrentScheme(createUndefinedValuedSchemes(auth)),
|
|
87
|
+
),
|
|
88
|
+
),
|
|
89
|
+
},
|
|
90
|
+
];
|
|
91
|
+
|
|
92
|
+
return items;
|
|
93
|
+
}, [currentName, filteredSecurityItems, operationSecuritySchemes, setCurrentScheme]);
|
|
94
|
+
|
|
95
|
+
if (filteredSecurityItems.length === 0) return null;
|
|
96
|
+
|
|
97
|
+
return (
|
|
98
|
+
<Panel defaultIsOpen data-test="try-it-auth">
|
|
99
|
+
<Panel.Titlebar
|
|
100
|
+
rightComponent={
|
|
101
|
+
filteredSecurityItems.length > 1 && (
|
|
102
|
+
<Menu
|
|
103
|
+
aria-label="security-schemes"
|
|
104
|
+
items={menuItems}
|
|
105
|
+
closeOnPress
|
|
106
|
+
renderTrigger={({ isOpen }) => (
|
|
107
|
+
<Button appearance="minimal" size="sm" iconRight={['fas', 'sort']} active={isOpen}>
|
|
108
|
+
{menuName}
|
|
109
|
+
</Button>
|
|
110
|
+
)}
|
|
111
|
+
/>
|
|
112
|
+
)
|
|
113
|
+
}
|
|
114
|
+
>
|
|
115
|
+
Auth
|
|
116
|
+
</Panel.Titlebar>
|
|
117
|
+
{operationAuthValue && operationAuthValue.length > 0 ? (
|
|
118
|
+
operationAuthValue.map(scheme => (
|
|
119
|
+
<SecuritySchemeComponent
|
|
120
|
+
key={scheme.scheme.key}
|
|
121
|
+
scheme={scheme.scheme}
|
|
122
|
+
onChange={(authValue?: string) => handleChange(scheme.scheme, authValue)}
|
|
123
|
+
value={scheme.authValue ?? ''}
|
|
124
|
+
/>
|
|
125
|
+
))
|
|
126
|
+
) : (
|
|
127
|
+
<OptionalMessageContainer />
|
|
128
|
+
)}
|
|
129
|
+
</Panel>
|
|
130
|
+
);
|
|
131
|
+
};
|
|
132
|
+
|
|
133
|
+
const GenericMessageContainer: React.FC<{ scheme: HttpSecurityScheme }> = ({ scheme }) => {
|
|
134
|
+
return <Panel.Content data-test="auth-try-it-row">Coming Soon: {getReadableSecurityName(scheme)}</Panel.Content>;
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
const OptionalMessageContainer: React.FC = () => {
|
|
138
|
+
return <Panel.Content>No auth selected</Panel.Content>;
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
interface SecuritySchemeComponentProps {
|
|
142
|
+
scheme: HttpSecurityScheme;
|
|
143
|
+
onChange: (AuthObject: any) => void;
|
|
144
|
+
value: string;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
const SecuritySchemeComponent: React.FC<SecuritySchemeComponentProps> = ({ scheme, ...rest }) => {
|
|
148
|
+
switch (scheme.type) {
|
|
149
|
+
case 'apiKey':
|
|
150
|
+
return <APIKeyAuth scheme={scheme} {...rest} />;
|
|
151
|
+
case 'oauth2':
|
|
152
|
+
return <OAuth2Auth scheme={scheme} {...rest} />;
|
|
153
|
+
case 'http':
|
|
154
|
+
switch (scheme.scheme) {
|
|
155
|
+
case 'basic':
|
|
156
|
+
return <BasicAuth {...rest} />;
|
|
157
|
+
case 'digest':
|
|
158
|
+
return <DigestAuth {...rest} />;
|
|
159
|
+
case 'bearer':
|
|
160
|
+
return <BearerAuth scheme={scheme} {...rest} />;
|
|
161
|
+
default:
|
|
162
|
+
return <GenericMessageContainer scheme={scheme} {...rest} />;
|
|
163
|
+
}
|
|
164
|
+
default:
|
|
165
|
+
return <GenericMessageContainer scheme={scheme} {...rest} />;
|
|
166
|
+
}
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
const securitySchemeKeys: Array<HttpSecurityScheme['type']> = ['apiKey', 'http', 'oauth2', 'openIdConnect'];
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Flex, Input, Text } from '@stoplight/mosaic';
|
|
2
|
+
import { HttpSecurityScheme } from '@stoplight/types';
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
|
|
5
|
+
import { useUniqueId } from '../../../hooks/useUniqueId';
|
|
6
|
+
|
|
7
|
+
interface AuthTokenInputProps {
|
|
8
|
+
onChange: (value: string) => void;
|
|
9
|
+
type: HttpSecurityScheme['type'];
|
|
10
|
+
name: string;
|
|
11
|
+
value: string;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export const AuthTokenInput: React.FC<AuthTokenInputProps> = ({ type, name, value, onChange }) => {
|
|
15
|
+
const inputId = useUniqueId(`id_auth_${name}_`);
|
|
16
|
+
return (
|
|
17
|
+
<>
|
|
18
|
+
<label aria-hidden="true" htmlFor={inputId}>
|
|
19
|
+
{name}
|
|
20
|
+
</label>
|
|
21
|
+
<Text mx={3}>:</Text>
|
|
22
|
+
<Flex flex={1}>
|
|
23
|
+
<Input
|
|
24
|
+
id={inputId}
|
|
25
|
+
aria-label={name}
|
|
26
|
+
appearance="minimal"
|
|
27
|
+
flex={1}
|
|
28
|
+
placeholder={type === 'oauth2' ? 'Bearer 123' : '123'}
|
|
29
|
+
value={value}
|
|
30
|
+
type="text"
|
|
31
|
+
required
|
|
32
|
+
onChange={e => onChange(e.currentTarget.value)}
|
|
33
|
+
/>
|
|
34
|
+
</Flex>
|
|
35
|
+
</>
|
|
36
|
+
);
|
|
37
|
+
};
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { Flex, Input, Panel, Text } from '@stoplight/mosaic';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
|
|
4
|
+
interface BasicAuthProps {
|
|
5
|
+
onChange: (value: string) => void;
|
|
6
|
+
value: string;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export const BasicAuth: React.FC<BasicAuthProps> = ({ onChange, value }) => {
|
|
10
|
+
const [username = '', password = ''] = decode(value).split(':');
|
|
11
|
+
|
|
12
|
+
const onCredentialsChange = (username: string, password: string) => {
|
|
13
|
+
onChange(encode(`${username}:${password}`));
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
return (
|
|
17
|
+
<Panel.Content className="ParameterGrid" data-test="auth-try-it-row">
|
|
18
|
+
<div>Username</div>
|
|
19
|
+
<Text mx={3}>:</Text>
|
|
20
|
+
<Flex flex={1}>
|
|
21
|
+
<Input
|
|
22
|
+
style={{ paddingLeft: 15 }}
|
|
23
|
+
aria-label="Username"
|
|
24
|
+
appearance="minimal"
|
|
25
|
+
flex={1}
|
|
26
|
+
placeholder="username"
|
|
27
|
+
value={username}
|
|
28
|
+
type="text"
|
|
29
|
+
required
|
|
30
|
+
onChange={e => onCredentialsChange(e.currentTarget.value, password)}
|
|
31
|
+
/>
|
|
32
|
+
</Flex>
|
|
33
|
+
<div>Password</div>
|
|
34
|
+
<Text mx={3}>:</Text>
|
|
35
|
+
<Flex flex={1}>
|
|
36
|
+
<Input
|
|
37
|
+
style={{ paddingLeft: 15 }}
|
|
38
|
+
aria-label="Password"
|
|
39
|
+
appearance="minimal"
|
|
40
|
+
flex={1}
|
|
41
|
+
placeholder="password"
|
|
42
|
+
value={password}
|
|
43
|
+
type="password"
|
|
44
|
+
required
|
|
45
|
+
onChange={e => onCredentialsChange(username, e.currentTarget.value)}
|
|
46
|
+
/>
|
|
47
|
+
</Flex>
|
|
48
|
+
</Panel.Content>
|
|
49
|
+
);
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
function encode(value: string) {
|
|
53
|
+
return btoa(value);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
function decode(encoded: string) {
|
|
57
|
+
try {
|
|
58
|
+
return atob(encoded);
|
|
59
|
+
} catch {
|
|
60
|
+
return '';
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Panel } from '@stoplight/mosaic';
|
|
2
|
+
import { IBearerSecurityScheme } from '@stoplight/types';
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
|
|
5
|
+
import { AuthTokenInput } from './AuthTokenInput';
|
|
6
|
+
|
|
7
|
+
interface BearerAuthProps {
|
|
8
|
+
scheme: IBearerSecurityScheme;
|
|
9
|
+
onChange: (value: string) => void;
|
|
10
|
+
value: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export const BearerAuth: React.FC<BearerAuthProps> = ({ value, onChange }) => {
|
|
14
|
+
return (
|
|
15
|
+
<Panel.Content className="ParameterGrid" data-test="auth-try-it-row">
|
|
16
|
+
<AuthTokenInput type="http" name="Token" value={value} onChange={onChange} />
|
|
17
|
+
</Panel.Content>
|
|
18
|
+
);
|
|
19
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Panel, Text } from '@stoplight/mosaic';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
|
|
4
|
+
interface DigestAuthProps {
|
|
5
|
+
onChange: (value: string) => void;
|
|
6
|
+
value: string;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
const digestPlaceholder = `Digest username="User Name",
|
|
10
|
+
realm="testrealm@host.com",
|
|
11
|
+
nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093",
|
|
12
|
+
uri="/dir/index.html",
|
|
13
|
+
qop=auth,
|
|
14
|
+
nc=00000001,
|
|
15
|
+
cnonce="0a4f113b",
|
|
16
|
+
response="6629fae49393a05397450978507c4ef1",
|
|
17
|
+
opaque="5ccc069c403ebaf9f0171e9517f40e41"
|
|
18
|
+
`;
|
|
19
|
+
|
|
20
|
+
export const DigestAuth: React.FC<DigestAuthProps> = ({ onChange, value }) => {
|
|
21
|
+
return (
|
|
22
|
+
<Panel.Content className="ParameterGrid" data-test="auth-try-it-row">
|
|
23
|
+
<div>Authorization</div>
|
|
24
|
+
<Text mx={3}>:</Text>
|
|
25
|
+
<textarea
|
|
26
|
+
className="sl-relative sl-z-10 sl-w-full sl-text-base sl-bg-canvas-100 sl-p-1 sl-pr-2.5 sl-pl-2.5 sl-rounded sl-border-transparent hover:sl-border-input focus:sl-border-primary sl-border"
|
|
27
|
+
aria-label="Authorization"
|
|
28
|
+
placeholder={digestPlaceholder}
|
|
29
|
+
value={value}
|
|
30
|
+
onChange={e => onChange(e.currentTarget.value)}
|
|
31
|
+
rows={9}
|
|
32
|
+
/>
|
|
33
|
+
</Panel.Content>
|
|
34
|
+
);
|
|
35
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Panel } from '@stoplight/mosaic';
|
|
2
|
+
import { IOauth2SecurityScheme } from '@stoplight/types';
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
|
|
5
|
+
import { AuthTokenInput } from './AuthTokenInput';
|
|
6
|
+
|
|
7
|
+
interface OAuth2AuthProps {
|
|
8
|
+
scheme: IOauth2SecurityScheme;
|
|
9
|
+
onChange: (value: string) => void;
|
|
10
|
+
value: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export const OAuth2Auth: React.FC<OAuth2AuthProps> = ({ value, onChange }) => {
|
|
14
|
+
return (
|
|
15
|
+
<Panel.Content className="ParameterGrid" data-test="auth-try-it-row">
|
|
16
|
+
<AuthTokenInput type="oauth2" name="Token" value={value} onChange={onChange} />
|
|
17
|
+
</Panel.Content>
|
|
18
|
+
);
|
|
19
|
+
};
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import {
|
|
2
|
+
Dictionary,
|
|
3
|
+
HttpSecurityScheme,
|
|
4
|
+
IApiKeySecurityScheme,
|
|
5
|
+
IBasicSecurityScheme,
|
|
6
|
+
IBearerSecurityScheme,
|
|
7
|
+
IHttpHeaderParam,
|
|
8
|
+
IHttpQueryParam,
|
|
9
|
+
IOauth2SecurityScheme,
|
|
10
|
+
} from '@stoplight/types';
|
|
11
|
+
import { atom, useAtom } from 'jotai';
|
|
12
|
+
import { flatten, isObject, isPlainObject } from 'lodash';
|
|
13
|
+
import React from 'react';
|
|
14
|
+
|
|
15
|
+
import { persistAtom } from '../../../utils/jotai/persistAtom';
|
|
16
|
+
import { caseInsensitivelyEquals } from '../../../utils/string';
|
|
17
|
+
|
|
18
|
+
export type HttpSecuritySchemeWithValues = {
|
|
19
|
+
scheme: HttpSecurityScheme;
|
|
20
|
+
authValue: string | undefined;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export const isApiKeySecurityScheme = (maybeIApiKey: HttpSecurityScheme): maybeIApiKey is IApiKeySecurityScheme =>
|
|
24
|
+
isObject(maybeIApiKey) && maybeIApiKey.type === 'apiKey';
|
|
25
|
+
|
|
26
|
+
export const isOAuth2SecurityScheme = (maybeIOAuth2: HttpSecurityScheme): maybeIOAuth2 is IOauth2SecurityScheme =>
|
|
27
|
+
isObject(maybeIOAuth2) && maybeIOAuth2.type === 'oauth2';
|
|
28
|
+
|
|
29
|
+
export const isBasicSecurityScheme = (maybeIBasic: HttpSecurityScheme): maybeIBasic is IBasicSecurityScheme =>
|
|
30
|
+
isObject(maybeIBasic) && maybeIBasic.type === 'http' && maybeIBasic.scheme === 'basic';
|
|
31
|
+
|
|
32
|
+
export const isBearerSecurityScheme = (maybeIBearer: HttpSecurityScheme): maybeIBearer is IBearerSecurityScheme =>
|
|
33
|
+
isObject(maybeIBearer) && maybeIBearer.type === 'http' && maybeIBearer.scheme === 'bearer';
|
|
34
|
+
|
|
35
|
+
export const isDigestSecurityScheme = (maybeIBearer: HttpSecurityScheme): maybeIBearer is IBasicSecurityScheme =>
|
|
36
|
+
isObject(maybeIBearer) && maybeIBearer.type === 'http' && maybeIBearer.scheme === 'digest';
|
|
37
|
+
|
|
38
|
+
export function filterOutAuthorizationParams(
|
|
39
|
+
queryParams: IHttpQueryParam[],
|
|
40
|
+
securitySchemes?: HttpSecurityScheme[][],
|
|
41
|
+
): IHttpQueryParam[];
|
|
42
|
+
export function filterOutAuthorizationParams(
|
|
43
|
+
queryParams: IHttpHeaderParam[],
|
|
44
|
+
securitySchemes?: HttpSecurityScheme[][],
|
|
45
|
+
): IHttpHeaderParam[];
|
|
46
|
+
export function filterOutAuthorizationParams(
|
|
47
|
+
queryParams: (IHttpQueryParam | IHttpHeaderParam)[],
|
|
48
|
+
securitySchemes: HttpSecurityScheme[][] = [],
|
|
49
|
+
): (IHttpQueryParam | IHttpHeaderParam)[] {
|
|
50
|
+
const flattenedSecuritySchemes = flatten(securitySchemes);
|
|
51
|
+
const securitySchemeNames = getSecuritySchemeNames(flattenedSecuritySchemes);
|
|
52
|
+
|
|
53
|
+
return queryParams.filter(queryParam => !securitySchemeNames.some(caseInsensitivelyEquals(queryParam.name)));
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const getSecuritySchemeNames = (securitySchemes: HttpSecurityScheme[]): string[] =>
|
|
57
|
+
securitySchemes.flatMap(scheme => {
|
|
58
|
+
if (isApiKeySecurityScheme(scheme)) {
|
|
59
|
+
return scheme.name;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
if (isOAuth2SecurityScheme(scheme)) {
|
|
63
|
+
return 'Authorization';
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
return [];
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
type SecuritySchemeValues = Dictionary<string>;
|
|
70
|
+
|
|
71
|
+
const isSecuritySchemeValues = (
|
|
72
|
+
maybeSecuritySchemeValues: unknown,
|
|
73
|
+
): maybeSecuritySchemeValues is SecuritySchemeValues => isPlainObject(maybeSecuritySchemeValues);
|
|
74
|
+
|
|
75
|
+
const securitySchemeValuesAtom = persistAtom('TryIt_securitySchemeValues', atom<SecuritySchemeValues>({}));
|
|
76
|
+
export const usePersistedSecuritySchemeWithValues = (): [
|
|
77
|
+
HttpSecuritySchemeWithValues[] | undefined,
|
|
78
|
+
React.Dispatch<HttpSecuritySchemeWithValues | undefined>,
|
|
79
|
+
React.Dispatch<HttpSecuritySchemeWithValues[] | undefined>,
|
|
80
|
+
] => {
|
|
81
|
+
const [currentScheme, setCurrentScheme] = React.useState<HttpSecuritySchemeWithValues[] | undefined>();
|
|
82
|
+
const [securitySchemeValues, setSecuritySchemeValues] = useAtom(securitySchemeValuesAtom);
|
|
83
|
+
|
|
84
|
+
const setPersistedAuthenticationSettings = (securitySchemeWithValues: HttpSecuritySchemeWithValues | undefined) => {
|
|
85
|
+
if (securitySchemeWithValues) {
|
|
86
|
+
const key = securitySchemeWithValues.scheme.key;
|
|
87
|
+
const value = securitySchemeWithValues.authValue;
|
|
88
|
+
|
|
89
|
+
if (value !== undefined) {
|
|
90
|
+
setSecuritySchemeValues({
|
|
91
|
+
...securitySchemeValues,
|
|
92
|
+
[key]: value,
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
const schemeWithPersistedValue = React.useMemo(() => {
|
|
99
|
+
if (!currentScheme) return undefined;
|
|
100
|
+
return currentScheme.map(scheme => {
|
|
101
|
+
return {
|
|
102
|
+
scheme: scheme.scheme,
|
|
103
|
+
authValue: isSecuritySchemeValues(securitySchemeValues) ? securitySchemeValues[scheme.scheme.key] : undefined,
|
|
104
|
+
};
|
|
105
|
+
});
|
|
106
|
+
}, [currentScheme, securitySchemeValues]);
|
|
107
|
+
|
|
108
|
+
return [schemeWithPersistedValue, setPersistedAuthenticationSettings, setCurrentScheme];
|
|
109
|
+
};
|
|
110
|
+
|
|
111
|
+
export const createUndefinedValuedSchemes = (schemes: HttpSecurityScheme[]): HttpSecuritySchemeWithValues[] => {
|
|
112
|
+
return schemes.map(scheme => ({ scheme, authValue: undefined }));
|
|
113
|
+
};
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { SchemaTree } from '@stoplight/json-schema-tree';
|
|
2
|
+
import { Choice, useChoices } from '@stoplight/json-schema-viewer';
|
|
3
|
+
import { Panel } from '@stoplight/mosaic';
|
|
4
|
+
import { IMediaTypeContent } from '@stoplight/types';
|
|
5
|
+
import * as React from 'react';
|
|
6
|
+
|
|
7
|
+
import { FileUploadParameterEditor } from '../Parameters/FileUploadParameterEditors';
|
|
8
|
+
import { OneOfMenu } from './FormDataBody';
|
|
9
|
+
import { BodyParameterValues } from './request-body-utils';
|
|
10
|
+
|
|
11
|
+
export interface BinaryBodyProps {
|
|
12
|
+
specification?: IMediaTypeContent;
|
|
13
|
+
values: BodyParameterValues;
|
|
14
|
+
onChangeValues: (newValues: BodyParameterValues) => void;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export const BinaryBody: React.FC<BinaryBodyProps> = ({ specification, values, onChangeValues }) => {
|
|
18
|
+
const schema: any = React.useMemo(() => {
|
|
19
|
+
const schema = specification?.schema ?? {};
|
|
20
|
+
const tree = new SchemaTree(schema, { mergeAllOf: true, refResolver: null });
|
|
21
|
+
tree.populate();
|
|
22
|
+
return tree.root.children[0];
|
|
23
|
+
}, [specification]);
|
|
24
|
+
|
|
25
|
+
const { selectedChoice, choices, setSelectedChoice } = useChoices(schema);
|
|
26
|
+
|
|
27
|
+
const onSchemaChange = (choice: Choice) => {
|
|
28
|
+
// Erase existing values; the old and new schemas may have nothing in common.
|
|
29
|
+
onChangeValues({});
|
|
30
|
+
setSelectedChoice(choice);
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
return (
|
|
34
|
+
<Panel defaultIsOpen>
|
|
35
|
+
<Panel.Titlebar
|
|
36
|
+
rightComponent={<OneOfMenu choices={choices} choice={selectedChoice} onChange={onSchemaChange} />}
|
|
37
|
+
>
|
|
38
|
+
Body
|
|
39
|
+
</Panel.Titlebar>
|
|
40
|
+
<Panel.Content className="sl-overflow-y-auto ParameterGrid OperationParametersContent">
|
|
41
|
+
<FileUploadParameterEditor
|
|
42
|
+
key={'file'}
|
|
43
|
+
parameter={{ name: 'file' }}
|
|
44
|
+
value={values.file instanceof File ? values.file : undefined}
|
|
45
|
+
onChange={newValue => {
|
|
46
|
+
newValue ? onChangeValues({ file: newValue }) : onChangeValues({});
|
|
47
|
+
}}
|
|
48
|
+
/>
|
|
49
|
+
</Panel.Content>
|
|
50
|
+
</Panel>
|
|
51
|
+
);
|
|
52
|
+
};
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import { isRegularNode, SchemaNode, SchemaTree } from '@stoplight/json-schema-tree';
|
|
2
|
+
import { Choice, useChoices, visibleChildren } from '@stoplight/json-schema-viewer';
|
|
3
|
+
import { Button, Menu, Panel } from '@stoplight/mosaic';
|
|
4
|
+
import { IMediaTypeContent } from '@stoplight/types';
|
|
5
|
+
import { omit } from 'lodash';
|
|
6
|
+
import * as React from 'react';
|
|
7
|
+
|
|
8
|
+
import { FileUploadParameterEditor } from '../Parameters/FileUploadParameterEditors';
|
|
9
|
+
import { parameterSupportsFileUpload, toParameterSpec } from '../Parameters/parameter-utils';
|
|
10
|
+
import { ParameterEditor } from '../Parameters/ParameterEditor';
|
|
11
|
+
import { BodyParameterValues, ParameterOptional } from './request-body-utils';
|
|
12
|
+
|
|
13
|
+
export interface FormDataBodyProps {
|
|
14
|
+
specification: IMediaTypeContent;
|
|
15
|
+
values: BodyParameterValues;
|
|
16
|
+
onChangeValues: (newValues: BodyParameterValues) => void;
|
|
17
|
+
onChangeParameterAllow: (newValue: ParameterOptional) => void;
|
|
18
|
+
isAllowedEmptyValues: ParameterOptional;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export const FormDataBody: React.FC<FormDataBodyProps> = ({
|
|
22
|
+
specification,
|
|
23
|
+
values,
|
|
24
|
+
onChangeValues,
|
|
25
|
+
onChangeParameterAllow,
|
|
26
|
+
isAllowedEmptyValues,
|
|
27
|
+
}) => {
|
|
28
|
+
const schema: SchemaNode = React.useMemo(() => {
|
|
29
|
+
const schema = specification.schema ?? {};
|
|
30
|
+
const tree = new SchemaTree(schema, { mergeAllOf: true, refResolver: null });
|
|
31
|
+
tree.populate();
|
|
32
|
+
return tree.root.children[0];
|
|
33
|
+
}, [specification]);
|
|
34
|
+
|
|
35
|
+
const { selectedChoice, choices, setSelectedChoice } = useChoices(schema);
|
|
36
|
+
|
|
37
|
+
const formFieldRows = visibleChildren(selectedChoice.type);
|
|
38
|
+
|
|
39
|
+
const onSchemaChange = (choice: Choice) => {
|
|
40
|
+
// Erase existing values; the old and new schemas may have nothing in common.
|
|
41
|
+
onChangeValues({});
|
|
42
|
+
setSelectedChoice(choice);
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
return (
|
|
46
|
+
<Panel defaultIsOpen>
|
|
47
|
+
<Panel.Titlebar
|
|
48
|
+
rightComponent={<OneOfMenu choices={choices} choice={selectedChoice} onChange={onSchemaChange} />}
|
|
49
|
+
>
|
|
50
|
+
Body
|
|
51
|
+
</Panel.Titlebar>
|
|
52
|
+
<Panel.Content className="sl-overflow-y-auto ParameterGrid OperationParametersContent">
|
|
53
|
+
{formFieldRows
|
|
54
|
+
.filter(isRegularNode)
|
|
55
|
+
.map(toParameterSpec)
|
|
56
|
+
.map(parameter => {
|
|
57
|
+
const supportsFileUpload = parameterSupportsFileUpload(parameter);
|
|
58
|
+
const value = values[parameter.name ?? ''];
|
|
59
|
+
|
|
60
|
+
if (supportsFileUpload) {
|
|
61
|
+
return (
|
|
62
|
+
<FileUploadParameterEditor
|
|
63
|
+
key={parameter.name}
|
|
64
|
+
parameter={parameter}
|
|
65
|
+
value={value instanceof File ? value : undefined}
|
|
66
|
+
onChange={newValue =>
|
|
67
|
+
newValue
|
|
68
|
+
? onChangeValues({ ...values, [parameter.name]: newValue })
|
|
69
|
+
: onChangeValues(omit(values, parameter.name))
|
|
70
|
+
}
|
|
71
|
+
/>
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return (
|
|
76
|
+
<ParameterEditor
|
|
77
|
+
key={parameter.name}
|
|
78
|
+
parameter={parameter}
|
|
79
|
+
value={typeof value === 'string' ? value : undefined}
|
|
80
|
+
onChange={value =>
|
|
81
|
+
onChangeValues({
|
|
82
|
+
...values,
|
|
83
|
+
[parameter.name]: typeof value === 'number' ? String(value) : (value as any),
|
|
84
|
+
})
|
|
85
|
+
}
|
|
86
|
+
onChangeOptional={value => onChangeParameterAllow({ ...isAllowedEmptyValues, [parameter.name]: value })}
|
|
87
|
+
canChangeOptional={true}
|
|
88
|
+
isOptional={isAllowedEmptyValues[parameter.name] ?? false}
|
|
89
|
+
/>
|
|
90
|
+
);
|
|
91
|
+
})}
|
|
92
|
+
</Panel.Content>
|
|
93
|
+
</Panel>
|
|
94
|
+
);
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
export interface OneOfMenuProps {
|
|
98
|
+
/** all of the available sub-schemas that can be picked */
|
|
99
|
+
choices: Choice[];
|
|
100
|
+
|
|
101
|
+
/** the currently selected sub-schema */
|
|
102
|
+
choice: Choice;
|
|
103
|
+
|
|
104
|
+
/** called when the selection changes */
|
|
105
|
+
onChange: (choice: Choice) => void;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* When the top level schema is `oneOf`, a drop-down menu that allows the user
|
|
110
|
+
* to select among the sub-schemas; otherwise `null`.
|
|
111
|
+
*/
|
|
112
|
+
export function OneOfMenu({ choices: subSchemas, choice, onChange }: OneOfMenuProps) {
|
|
113
|
+
const onSubSchemaSelect = React.useCallback(onChange, [onChange]);
|
|
114
|
+
|
|
115
|
+
const menuItems = React.useMemo(
|
|
116
|
+
() =>
|
|
117
|
+
subSchemas.map(subSchema => {
|
|
118
|
+
const label = subSchema.title;
|
|
119
|
+
return {
|
|
120
|
+
id: `request-subschema-${label}`,
|
|
121
|
+
title: label,
|
|
122
|
+
onPress: () => onSubSchemaSelect(subSchema),
|
|
123
|
+
};
|
|
124
|
+
}),
|
|
125
|
+
[subSchemas, onSubSchemaSelect],
|
|
126
|
+
);
|
|
127
|
+
|
|
128
|
+
if (!subSchemas || subSchemas.length < 2) {
|
|
129
|
+
return null;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
const title = choice?.title ?? 'Variants';
|
|
133
|
+
|
|
134
|
+
return (
|
|
135
|
+
<Menu
|
|
136
|
+
aria-label={title}
|
|
137
|
+
items={menuItems}
|
|
138
|
+
renderTrigger={({ isOpen }) => (
|
|
139
|
+
<Button appearance="minimal" size="sm" iconRight={['fas', 'sort']} active={isOpen} data-testid="oneof-menu">
|
|
140
|
+
{title}
|
|
141
|
+
</Button>
|
|
142
|
+
)}
|
|
143
|
+
/>
|
|
144
|
+
);
|
|
145
|
+
}
|