@stoplight/elements-core 9.0.11 → 9.0.12-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.
- 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} +60 -1
- package/{index.js → dist/index.js} +60 -1
- package/{index.mjs → dist/index.mjs} +60 -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,48 @@
|
|
|
1
|
+
import { Meta, StoryObj } from '@storybook/react';
|
|
2
|
+
|
|
3
|
+
import { AdditionalInfo } from './AdditionalInfo';
|
|
4
|
+
|
|
5
|
+
const meta: Meta<typeof AdditionalInfo> = {
|
|
6
|
+
title: `Internal/Docs/AdditionalInfo`,
|
|
7
|
+
component: AdditionalInfo,
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
export default meta;
|
|
11
|
+
type Story = StoryObj<typeof AdditionalInfo>;
|
|
12
|
+
|
|
13
|
+
// Story when only the license URL is provided
|
|
14
|
+
export const LicenseWithOnlyURL: Story = {
|
|
15
|
+
name: 'License with only URL',
|
|
16
|
+
args: {
|
|
17
|
+
id: 'id',
|
|
18
|
+
license: {
|
|
19
|
+
name: 'MIT License',
|
|
20
|
+
url: 'https://mit.edu/license.html',
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
// Story when only the license identifier is provided
|
|
26
|
+
export const LicenseWithOnlyIdentifier: Story = {
|
|
27
|
+
name: 'License with only Identifier',
|
|
28
|
+
args: {
|
|
29
|
+
id: 'id',
|
|
30
|
+
license: {
|
|
31
|
+
name: 'MIT License',
|
|
32
|
+
identifier: `MIT`,
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
// Story when both the license URL and identifier are provided (URL should take precedence)
|
|
38
|
+
export const LicenseWithURLAndIdentifier: Story = {
|
|
39
|
+
name: 'License with URL and Identifier (URL takes precedence)',
|
|
40
|
+
args: {
|
|
41
|
+
id: 'id',
|
|
42
|
+
license: {
|
|
43
|
+
name: 'MIT License',
|
|
44
|
+
identifier: 'MIT',
|
|
45
|
+
url: 'https://mit.edu/license.html',
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { NodeAnnotation, Panel } from '@stoplight/mosaic';
|
|
2
|
+
import { IHttpService } from '@stoplight/types';
|
|
3
|
+
import React from 'react';
|
|
4
|
+
|
|
5
|
+
import { useOptionsCtx } from '../../../context/Options';
|
|
6
|
+
import { MarkdownViewer } from '../../MarkdownViewer';
|
|
7
|
+
|
|
8
|
+
interface AdditionalInfoProps {
|
|
9
|
+
id: string;
|
|
10
|
+
termsOfService?: string;
|
|
11
|
+
contact?: IHttpService['contact'];
|
|
12
|
+
license?: IHttpService['license'];
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export const AdditionalInfo: React.FC<AdditionalInfoProps> = ({ id, termsOfService, contact, license }) => {
|
|
16
|
+
const { nodeHasChanged } = useOptionsCtx();
|
|
17
|
+
const hasChanged = nodeHasChanged?.({ nodeId: id, attr: ['termsOfService', 'contact', 'license'] });
|
|
18
|
+
|
|
19
|
+
const contactLink =
|
|
20
|
+
contact?.name && contact?.url
|
|
21
|
+
? `[Contact ${contact.name}](${contact.url})`
|
|
22
|
+
: contact?.email
|
|
23
|
+
? `[Contact ${contact.name || contact.email}](mailto:${contact.email})`
|
|
24
|
+
: '';
|
|
25
|
+
|
|
26
|
+
//use spdx to look up url for license identifier if available
|
|
27
|
+
// The licenseUrl is determined based on the mutual exclusivity of the `url` and `identifier` fields.
|
|
28
|
+
// If a `license.url` is provided, it takes precedence over the `license.identifier`.
|
|
29
|
+
// This is because the OpenAPI specification defines `url` and `identifier` as mutually exclusive fields,
|
|
30
|
+
// meaning you should use either one or the other, but not both. If both are provided, the `url` should be used.
|
|
31
|
+
// See: https://spec.openapis.org/oas/latest.html#license-object
|
|
32
|
+
const licenseUrl = license?.url
|
|
33
|
+
? license?.url
|
|
34
|
+
: license?.identifier
|
|
35
|
+
? `https://spdx.org/licenses/${license?.identifier}.html`
|
|
36
|
+
: undefined;
|
|
37
|
+
|
|
38
|
+
const licenseLink =
|
|
39
|
+
license?.name && licenseUrl
|
|
40
|
+
? `[${license.name}](${licenseUrl})`
|
|
41
|
+
: license?.identifier && licenseUrl
|
|
42
|
+
? `[${license?.identifier}](${licenseUrl})`
|
|
43
|
+
: '';
|
|
44
|
+
const tosLink = termsOfService ? `[Terms of Service](${termsOfService})` : '';
|
|
45
|
+
|
|
46
|
+
return contactLink || licenseLink || tosLink ? (
|
|
47
|
+
<Panel rounded isCollapsible={false} pos="relative">
|
|
48
|
+
<Panel.Titlebar bg="canvas-300">
|
|
49
|
+
<span role="heading">Additional Information</span>
|
|
50
|
+
</Panel.Titlebar>
|
|
51
|
+
|
|
52
|
+
<Panel.Content p={0}>
|
|
53
|
+
<Panel.Content>
|
|
54
|
+
<MarkdownViewer style={{ fontSize: 12 }} markdown={`${contactLink}\n \n${licenseLink}\n \n ${tosLink}`} />
|
|
55
|
+
</Panel.Content>
|
|
56
|
+
</Panel.Content>
|
|
57
|
+
|
|
58
|
+
<NodeAnnotation change={hasChanged} />
|
|
59
|
+
</Panel>
|
|
60
|
+
) : null;
|
|
61
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Box, Button, Menu, MenuActionItem, MenuItems } from '@stoplight/mosaic';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
|
|
4
|
+
type ExportMenuProps = Pick<MenuActionItem, 'href' | 'onPress'>;
|
|
5
|
+
|
|
6
|
+
export interface ExportButtonProps {
|
|
7
|
+
original: ExportMenuProps;
|
|
8
|
+
bundled: ExportMenuProps;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export const ExportButton: React.FC<ExportButtonProps> = ({ original, bundled }) => {
|
|
12
|
+
const menuItems = React.useMemo(() => {
|
|
13
|
+
const items: MenuItems = [
|
|
14
|
+
{ id: 'original', title: 'Original', ...original },
|
|
15
|
+
{ id: 'bundled', title: 'Bundled References', ...bundled },
|
|
16
|
+
];
|
|
17
|
+
|
|
18
|
+
return items;
|
|
19
|
+
}, [original, bundled]);
|
|
20
|
+
|
|
21
|
+
return (
|
|
22
|
+
<Box>
|
|
23
|
+
<Menu
|
|
24
|
+
aria-label="Export"
|
|
25
|
+
items={menuItems}
|
|
26
|
+
placement="bottom right"
|
|
27
|
+
renderTrigger={({ isOpen }) => (
|
|
28
|
+
<Button iconRight="chevron-down" appearance="default" ml={2} active={isOpen} size="sm">
|
|
29
|
+
Export
|
|
30
|
+
</Button>
|
|
31
|
+
)}
|
|
32
|
+
/>
|
|
33
|
+
</Box>
|
|
34
|
+
);
|
|
35
|
+
};
|
|
@@ -0,0 +1,429 @@
|
|
|
1
|
+
import { Provider as MosaicProvider } from '@stoplight/mosaic';
|
|
2
|
+
import { render, screen, waitFor } from '@testing-library/react';
|
|
3
|
+
import { renderHook } from '@testing-library/react-hooks';
|
|
4
|
+
import userEvent from '@testing-library/user-event';
|
|
5
|
+
import * as React from 'react';
|
|
6
|
+
import { BrowserRouter as Router } from 'react-router-dom';
|
|
7
|
+
|
|
8
|
+
import { apiKey, oauth } from '../../../__fixtures__/security-schemes';
|
|
9
|
+
import httpService from '../../../__fixtures__/services/petstore';
|
|
10
|
+
import { httpServiceWithUnnamedServers } from '../../../__fixtures__/services/with-unnamed-servers';
|
|
11
|
+
import { httpServiceWithUrlVariables } from '../../../__fixtures__/services/with-url-variables';
|
|
12
|
+
import { httpServiceWithoutOrigin } from '../../../__fixtures__/services/without-origin';
|
|
13
|
+
import { AdditionalInfo } from './AdditionalInfo';
|
|
14
|
+
import { HttpService } from './index';
|
|
15
|
+
import { SecuritySchemes } from './SecuritySchemes';
|
|
16
|
+
import { ServerInfo, useSplitUrl } from './ServerInfo';
|
|
17
|
+
|
|
18
|
+
describe('HttpService', () => {
|
|
19
|
+
it('Should render correctly', () => {
|
|
20
|
+
const wrapper = render(
|
|
21
|
+
<Router>
|
|
22
|
+
<HttpService data={httpService} />
|
|
23
|
+
</Router>,
|
|
24
|
+
);
|
|
25
|
+
|
|
26
|
+
expect(wrapper.getByText(httpService.name).tagName.toLowerCase()).toBe('h1');
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
it('should not display servers when hideServerInfo is provided', () => {
|
|
30
|
+
render(
|
|
31
|
+
<Router>
|
|
32
|
+
<HttpService layoutOptions={{ hideServerInfo: true }} data={{ ...httpService, security: [] }} />
|
|
33
|
+
</Router>,
|
|
34
|
+
);
|
|
35
|
+
|
|
36
|
+
const serverUrl = screen.queryByLabelText('Production API');
|
|
37
|
+
expect(serverUrl).not.toBeInTheDocument();
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
it('displays all server urls', () => {
|
|
41
|
+
render(<ServerInfo servers={httpService.servers ?? []} />);
|
|
42
|
+
|
|
43
|
+
const serverUrl = screen.getByLabelText('Production API');
|
|
44
|
+
expect(serverUrl).toHaveTextContent('https://api.stoplight.io');
|
|
45
|
+
|
|
46
|
+
const secondServerUrl = screen.getByLabelText('Staging API');
|
|
47
|
+
expect(secondServerUrl).toHaveTextContent('https://api.{environment}.stoplight.io');
|
|
48
|
+
|
|
49
|
+
const thirdServerUrl = screen.getByLabelText('Development API');
|
|
50
|
+
expect(thirdServerUrl).toHaveTextContent('https://localhost:{port}');
|
|
51
|
+
|
|
52
|
+
expect(screen.queryByLabelText('Mock Server')).not.toBeInTheDocument();
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it('generates names for servers without descriptions', () => {
|
|
56
|
+
render(<ServerInfo servers={httpServiceWithUnnamedServers.servers ?? []} />);
|
|
57
|
+
|
|
58
|
+
const secondServerUrl = screen.getByLabelText('Server 2');
|
|
59
|
+
expect(secondServerUrl).toHaveTextContent('https://api.staging.stoplight.io');
|
|
60
|
+
|
|
61
|
+
const fourthServerUrl = screen.getByLabelText('Server 4');
|
|
62
|
+
expect(fourthServerUrl).toHaveTextContent('https://localhost:4060');
|
|
63
|
+
|
|
64
|
+
expect(screen.queryByLabelText('Mock Server')).not.toBeInTheDocument();
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it('keeps url variables in displayed url', () => {
|
|
68
|
+
render(<ServerInfo servers={httpServiceWithUrlVariables.servers ?? []} />);
|
|
69
|
+
|
|
70
|
+
const serverUrl = screen.getByLabelText('Production API');
|
|
71
|
+
expect(serverUrl).toHaveTextContent('{protocol}://{namespace}.stoplight.io');
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it('shows url variables in an expandable panel', async () => {
|
|
75
|
+
render(<ServerInfo servers={httpServiceWithUrlVariables.servers ?? []} />);
|
|
76
|
+
|
|
77
|
+
await waitFor(() => expect(screen.queryByRole('region')).toBeInTheDocument());
|
|
78
|
+
|
|
79
|
+
expect(screen.getByRole('region')).toHaveTextContent(
|
|
80
|
+
`protocolstringAllowed values:ftphttphttpsDefault:ftpnamespacestringDefault:default-namespace`,
|
|
81
|
+
);
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
it('hides subsequent panels with server variables ', async () => {
|
|
85
|
+
const servers = [
|
|
86
|
+
...httpServiceWithUrlVariables.servers!.slice(0, -1),
|
|
87
|
+
{
|
|
88
|
+
id: '?http-server-3?',
|
|
89
|
+
url: 'https://localhost:{port}',
|
|
90
|
+
description: 'Development API',
|
|
91
|
+
variables: {
|
|
92
|
+
port: {
|
|
93
|
+
default: '443',
|
|
94
|
+
},
|
|
95
|
+
},
|
|
96
|
+
},
|
|
97
|
+
];
|
|
98
|
+
|
|
99
|
+
render(<ServerInfo servers={servers} />);
|
|
100
|
+
|
|
101
|
+
await waitFor(() => expect(screen.queryAllByRole('region')).toHaveLength(1));
|
|
102
|
+
|
|
103
|
+
const serverUrl = screen.getByLabelText('Development API');
|
|
104
|
+
userEvent.click(serverUrl.parentElement!);
|
|
105
|
+
|
|
106
|
+
await waitFor(() => expect(screen.queryAllByRole('region')).toHaveLength(2));
|
|
107
|
+
|
|
108
|
+
expect(screen.getAllByRole('region')[1]).toHaveTextContent(`portstringDefault:443`);
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
it('handles urls without an origin', () => {
|
|
112
|
+
render(<ServerInfo servers={httpServiceWithoutOrigin.servers ?? []} />);
|
|
113
|
+
|
|
114
|
+
const serverUrl = screen.getByLabelText('Production API');
|
|
115
|
+
expect(serverUrl).toHaveTextContent('api');
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
it('displays mock server url when embedded in Stoplight Project', async () => {
|
|
119
|
+
render(<ServerInfo servers={httpService.servers ?? []} mockUrl="https://foo.stoplight.io/prism/123" />);
|
|
120
|
+
|
|
121
|
+
const mockServer = screen.queryByLabelText('Mock Server');
|
|
122
|
+
await waitFor(() => expect(mockServer).toHaveTextContent('https://foo.stoplight.io/prism/123'));
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it('Base URL block handles an invalid URL', () => {
|
|
126
|
+
const modifiedData = {
|
|
127
|
+
...httpService,
|
|
128
|
+
servers: [
|
|
129
|
+
{
|
|
130
|
+
id: '?http-server-0?',
|
|
131
|
+
url: 'https://///',
|
|
132
|
+
name: 'Production API',
|
|
133
|
+
},
|
|
134
|
+
],
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
render(
|
|
138
|
+
<Router>
|
|
139
|
+
<HttpService data={modifiedData} />
|
|
140
|
+
</Router>,
|
|
141
|
+
);
|
|
142
|
+
|
|
143
|
+
expect(screen.queryByText(/api base url/i)).toBeInTheDocument();
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
describe('Security schemes', () => {
|
|
147
|
+
it('should render single security scheme', () => {
|
|
148
|
+
render(<SecuritySchemes secSchemes={[[apiKey]]} parentId="2@adfg4F" />);
|
|
149
|
+
|
|
150
|
+
const title = screen.getByRole('heading', { name: 'Security' });
|
|
151
|
+
const scheme = screen.getByRole('heading', { name: 'API Key' });
|
|
152
|
+
|
|
153
|
+
expect(title).toBeInTheDocument();
|
|
154
|
+
expect(scheme).toBeInTheDocument();
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
it('should not render if no security schemes provided', () => {
|
|
158
|
+
render(
|
|
159
|
+
<Router>
|
|
160
|
+
<HttpService data={{ ...httpService, security: [] }} />
|
|
161
|
+
</Router>,
|
|
162
|
+
);
|
|
163
|
+
|
|
164
|
+
const security = screen.queryByRole('heading', { name: 'Security' });
|
|
165
|
+
expect(security).not.toBeInTheDocument();
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it('should not render if hideSecurityInfo is provided', () => {
|
|
169
|
+
render(
|
|
170
|
+
<Router>
|
|
171
|
+
<HttpService layoutOptions={{ hideSecurityInfo: true }} data={{ ...httpService, security: [] }} />
|
|
172
|
+
</Router>,
|
|
173
|
+
);
|
|
174
|
+
|
|
175
|
+
const security = screen.queryByRole('heading', { name: 'Security' });
|
|
176
|
+
expect(security).not.toBeInTheDocument();
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
it('should render default description', () => {
|
|
180
|
+
render(<SecuritySchemes secSchemes={[[apiKey]]} parentId="2@adfg4F" />);
|
|
181
|
+
|
|
182
|
+
const description = screen.getByText(/An API key/);
|
|
183
|
+
expect(description).toBeInTheDocument();
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
it('should render custom description', () => {
|
|
187
|
+
render(
|
|
188
|
+
<SecuritySchemes secSchemes={[[{ ...apiKey, description: 'Api Key description' }]]} parentId="2@adfg4F" />,
|
|
189
|
+
);
|
|
190
|
+
|
|
191
|
+
const description = screen.getByText('Api Key description');
|
|
192
|
+
expect(description).toBeInTheDocument();
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
it('should render both custom description and other scheme details', () => {
|
|
196
|
+
render(
|
|
197
|
+
<SecuritySchemes secSchemes={[[{ ...oauth, description: 'A custom description' }]]} parentId="2@adfg4F" />,
|
|
198
|
+
);
|
|
199
|
+
|
|
200
|
+
const description = screen.getByText('A custom description');
|
|
201
|
+
const implicit = screen.getByText('Implicit OAuth Flow');
|
|
202
|
+
|
|
203
|
+
expect(description).toBeInTheDocument();
|
|
204
|
+
expect(implicit).toBeInTheDocument();
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
it('should render oauth flows for default description', () => {
|
|
208
|
+
render(<SecuritySchemes secSchemes={[[oauth]]} parentId="2@adfg4F" />);
|
|
209
|
+
|
|
210
|
+
const implicit = screen.getByText('Implicit OAuth Flow');
|
|
211
|
+
const password = screen.getByText('Password OAuth Flow');
|
|
212
|
+
const clientCredentials = screen.getByText('Client Credentials OAuth Flow');
|
|
213
|
+
const authCode = screen.getByText('Authorization Code OAuth Flow');
|
|
214
|
+
|
|
215
|
+
expect(implicit).toBeInTheDocument();
|
|
216
|
+
expect(password).toBeInTheDocument();
|
|
217
|
+
expect(clientCredentials).toBeInTheDocument();
|
|
218
|
+
expect(authCode).toBeInTheDocument();
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
it('should render multiple schemes', () => {
|
|
222
|
+
render(<SecuritySchemes secSchemes={[[apiKey], [oauth]]} parentId="2@adfg4F" />);
|
|
223
|
+
|
|
224
|
+
const apiKeyScheme = screen.getByRole('heading', { name: 'API Key' });
|
|
225
|
+
const oauthScheme = screen.getByRole('heading', { name: 'OAuth 2.0' });
|
|
226
|
+
const expandButtons = screen.getAllByRole('button');
|
|
227
|
+
|
|
228
|
+
expect(apiKeyScheme).toBeInTheDocument();
|
|
229
|
+
expect(oauthScheme).toBeInTheDocument();
|
|
230
|
+
expect(expandButtons.length).toEqual(2);
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
it('should expand first scheme by default', () => {
|
|
234
|
+
render(<SecuritySchemes secSchemes={[[apiKey], [oauth]]} parentId="2@adfg4F" />);
|
|
235
|
+
|
|
236
|
+
const apiKeyDescription = screen.queryByText(/An API key/);
|
|
237
|
+
let oauthDescription = screen.queryByText('Implicit OAuth Flow');
|
|
238
|
+
|
|
239
|
+
expect(apiKeyDescription).toBeInTheDocument();
|
|
240
|
+
expect(oauthDescription).not.toBeInTheDocument();
|
|
241
|
+
|
|
242
|
+
const oauthScheme = screen.getByRole('heading', { name: 'OAuth 2.0' });
|
|
243
|
+
userEvent.click(oauthScheme);
|
|
244
|
+
oauthDescription = screen.queryByText('Implicit OAuth Flow');
|
|
245
|
+
expect(oauthDescription).toBeInTheDocument();
|
|
246
|
+
});
|
|
247
|
+
});
|
|
248
|
+
|
|
249
|
+
describe('Additional information', () => {
|
|
250
|
+
it('should render additional information', () => {
|
|
251
|
+
const contact = {
|
|
252
|
+
name: 'Developer',
|
|
253
|
+
email: 'developer@stoplight.io',
|
|
254
|
+
url: 'https://stoplight.io/contact-us/',
|
|
255
|
+
};
|
|
256
|
+
|
|
257
|
+
const license = {
|
|
258
|
+
name: 'MIT',
|
|
259
|
+
url: 'https://opensource.org/licenses/MIT',
|
|
260
|
+
};
|
|
261
|
+
render(
|
|
262
|
+
<AdditionalInfo id="a" contact={contact} license={license} termsOfService="https://stoplight.io/terms/" />,
|
|
263
|
+
);
|
|
264
|
+
|
|
265
|
+
const title = screen.getByRole('heading', { name: 'Additional Information' });
|
|
266
|
+
|
|
267
|
+
expect(title).toBeInTheDocument();
|
|
268
|
+
});
|
|
269
|
+
|
|
270
|
+
it('should render additional information with SPDX license identifier', () => {
|
|
271
|
+
const contact = {
|
|
272
|
+
name: 'Developer',
|
|
273
|
+
email: 'developer@stoplight.io',
|
|
274
|
+
url: 'https://stoplight.io/contact-us/',
|
|
275
|
+
};
|
|
276
|
+
|
|
277
|
+
const license = {
|
|
278
|
+
name: 'MIT License',
|
|
279
|
+
identifier: 'MIT',
|
|
280
|
+
};
|
|
281
|
+
|
|
282
|
+
render(
|
|
283
|
+
<AdditionalInfo id="a" contact={contact} license={license} termsOfService="https://stoplight.io/terms/" />,
|
|
284
|
+
);
|
|
285
|
+
|
|
286
|
+
const licenseLink = screen.getByText('MIT License');
|
|
287
|
+
expect(licenseLink).toHaveAttribute('href', 'https://spdx.org/licenses/MIT.html');
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
it('should prefer license URL over SPDX identifier if both are provided', () => {
|
|
291
|
+
const license = {
|
|
292
|
+
name: 'MIT License',
|
|
293
|
+
url: 'https://opensource.org/licenses/MIT',
|
|
294
|
+
identifier: 'MIT',
|
|
295
|
+
};
|
|
296
|
+
|
|
297
|
+
render(<AdditionalInfo id="a" license={license} />);
|
|
298
|
+
|
|
299
|
+
const licenseLink = screen.getByText('MIT License');
|
|
300
|
+
expect(licenseLink).toHaveAttribute('href', 'https://opensource.org/licenses/MIT');
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
it('should not render if contact, license, and terms of service do not exist', () => {
|
|
304
|
+
render(<AdditionalInfo id="a" />);
|
|
305
|
+
|
|
306
|
+
const title = screen.queryByRole('heading', { name: 'Additional Information' });
|
|
307
|
+
expect(title).not.toBeInTheDocument();
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
it('should not render if props do not have sufficient subprops', () => {
|
|
311
|
+
const contact = {
|
|
312
|
+
name: 'Developer',
|
|
313
|
+
};
|
|
314
|
+
|
|
315
|
+
render(<AdditionalInfo id="a" contact={contact} />);
|
|
316
|
+
|
|
317
|
+
const title = screen.queryByRole('heading', { name: 'Additional Information' });
|
|
318
|
+
expect(title).not.toBeInTheDocument();
|
|
319
|
+
});
|
|
320
|
+
});
|
|
321
|
+
|
|
322
|
+
describe('export button', () => {
|
|
323
|
+
it('should render correctly', () => {
|
|
324
|
+
const wrapper = render(
|
|
325
|
+
<Router>
|
|
326
|
+
<MosaicProvider>
|
|
327
|
+
<HttpService
|
|
328
|
+
data={httpService}
|
|
329
|
+
exportProps={{ original: { onPress: jest.fn() }, bundled: { onPress: jest.fn() } }}
|
|
330
|
+
/>
|
|
331
|
+
</MosaicProvider>
|
|
332
|
+
</Router>,
|
|
333
|
+
);
|
|
334
|
+
|
|
335
|
+
const exportButton = wrapper.getByRole('button', { name: 'Export' });
|
|
336
|
+
expect(exportButton).toBeInTheDocument();
|
|
337
|
+
|
|
338
|
+
userEvent.click(exportButton);
|
|
339
|
+
expect(wrapper.getByRole('menuitem', { name: 'Original' })).toBeInTheDocument();
|
|
340
|
+
expect(wrapper.getByRole('menuitem', { name: 'Bundled References' })).toBeInTheDocument();
|
|
341
|
+
});
|
|
342
|
+
|
|
343
|
+
it('should not render if hideExport is true', () => {
|
|
344
|
+
const wrapper = render(
|
|
345
|
+
<Router>
|
|
346
|
+
<MosaicProvider>
|
|
347
|
+
<HttpService
|
|
348
|
+
data={httpService}
|
|
349
|
+
exportProps={{ original: { onPress: jest.fn() }, bundled: { onPress: jest.fn() } }}
|
|
350
|
+
layoutOptions={{ hideExport: true }}
|
|
351
|
+
/>
|
|
352
|
+
</MosaicProvider>
|
|
353
|
+
</Router>,
|
|
354
|
+
);
|
|
355
|
+
|
|
356
|
+
const exportButton = wrapper.queryByRole('button', { name: 'Export' });
|
|
357
|
+
expect(exportButton).not.toBeInTheDocument();
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
it('should not render if no exportProps are present', () => {
|
|
361
|
+
const wrapper = render(
|
|
362
|
+
<Router>
|
|
363
|
+
<MosaicProvider>
|
|
364
|
+
<HttpService data={httpService} />
|
|
365
|
+
</MosaicProvider>
|
|
366
|
+
</Router>,
|
|
367
|
+
);
|
|
368
|
+
|
|
369
|
+
const exportButton = wrapper.queryByRole('button', { name: 'Export' });
|
|
370
|
+
expect(exportButton).not.toBeInTheDocument();
|
|
371
|
+
});
|
|
372
|
+
});
|
|
373
|
+
});
|
|
374
|
+
|
|
375
|
+
describe('useSplitUrl hook', () => {
|
|
376
|
+
it('should correctly distinguish variables from static parts', () => {
|
|
377
|
+
let { result } = renderHook(() => useSplitUrl('https://{api}.stoplight.io:{port}'));
|
|
378
|
+
|
|
379
|
+
expect(result.current).toStrictEqual([
|
|
380
|
+
{ kind: 'static', value: 'https://' },
|
|
381
|
+
{ kind: 'variable', value: '{api}' },
|
|
382
|
+
{ kind: 'static', value: '.stoplight.io:' },
|
|
383
|
+
{ kind: 'variable', value: '{port}' },
|
|
384
|
+
]);
|
|
385
|
+
|
|
386
|
+
({ result } = renderHook(() => useSplitUrl('{protocol}://stoplight.io:{port}')));
|
|
387
|
+
|
|
388
|
+
expect(result.current).toStrictEqual([
|
|
389
|
+
{ kind: 'variable', value: '{protocol}' },
|
|
390
|
+
{ kind: 'static', value: '://stoplight.io:' },
|
|
391
|
+
{ kind: 'variable', value: '{port}' },
|
|
392
|
+
]);
|
|
393
|
+
|
|
394
|
+
({ result } = renderHook(() => useSplitUrl('https://{version}{username}.stoplight.io')));
|
|
395
|
+
|
|
396
|
+
expect(result.current).toStrictEqual([
|
|
397
|
+
{ kind: 'static', value: 'https://' },
|
|
398
|
+
{ kind: 'variable', value: '{version}' },
|
|
399
|
+
{ kind: 'variable', value: '{username}' },
|
|
400
|
+
{ kind: 'static', value: '.stoplight.io' },
|
|
401
|
+
]);
|
|
402
|
+
|
|
403
|
+
({ result } = renderHook(() => useSplitUrl('https://www.stoplight.io')));
|
|
404
|
+
|
|
405
|
+
expect(result.current).toStrictEqual([{ kind: 'static', value: 'https://www.stoplight.io' }]);
|
|
406
|
+
});
|
|
407
|
+
|
|
408
|
+
it('should gracefully handle invalid input', () => {
|
|
409
|
+
let { result } = renderHook(() => useSplitUrl('https://{{{{}'));
|
|
410
|
+
|
|
411
|
+
expect(result.current).toStrictEqual([{ kind: 'static', value: 'https://{{{{}' }]);
|
|
412
|
+
|
|
413
|
+
({ result } = renderHook(() => useSplitUrl('{protocol://stoplight.io:{api}')));
|
|
414
|
+
|
|
415
|
+
expect(result.current).toStrictEqual([
|
|
416
|
+
{ kind: 'static', value: '{protocol://stoplight.io:' },
|
|
417
|
+
{ kind: 'variable', value: '{api}' },
|
|
418
|
+
]);
|
|
419
|
+
|
|
420
|
+
({ result } = renderHook(() => useSplitUrl('https://{version}{username}.stoplight.io{test')));
|
|
421
|
+
|
|
422
|
+
expect(result.current).toStrictEqual([
|
|
423
|
+
{ kind: 'static', value: 'https://' },
|
|
424
|
+
{ kind: 'variable', value: '{version}' },
|
|
425
|
+
{ kind: 'variable', value: '{username}' },
|
|
426
|
+
{ kind: 'static', value: '.stoplight.io{test' },
|
|
427
|
+
]);
|
|
428
|
+
});
|
|
429
|
+
});
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { httpService } from '../../../__fixtures__/services/petstore';
|
|
2
|
+
import { createStoriesForDocsComponent } from '../story-helper';
|
|
3
|
+
import { renderExtensionRenderer } from '../story-renderer-helper';
|
|
4
|
+
import { HttpService } from './HttpService';
|
|
5
|
+
|
|
6
|
+
const { meta, createHoistedStory } = createStoriesForDocsComponent(HttpService, 'HttpService');
|
|
7
|
+
|
|
8
|
+
export default meta;
|
|
9
|
+
|
|
10
|
+
export const Story = createHoistedStory({
|
|
11
|
+
data: httpService,
|
|
12
|
+
layoutOptions: { compact: 600 },
|
|
13
|
+
renderExtensionAddon: renderExtensionRenderer,
|
|
14
|
+
});
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { Box, Flex, Heading, NodeAnnotation, VStack } from '@stoplight/mosaic';
|
|
2
|
+
import { withErrorBoundary } from '@stoplight/react-error-boundary';
|
|
3
|
+
import { IHttpService } from '@stoplight/types';
|
|
4
|
+
import * as React from 'react';
|
|
5
|
+
|
|
6
|
+
import { MockingContext } from '../../../containers/MockingProvider';
|
|
7
|
+
import { useResolvedObject } from '../../../context/InlineRefResolver';
|
|
8
|
+
import { useOptionsCtx } from '../../../context/Options';
|
|
9
|
+
import { useIsCompact } from '../../../hooks/useIsCompact';
|
|
10
|
+
import { MarkdownViewer } from '../../MarkdownViewer';
|
|
11
|
+
import { PoweredByLink } from '../../PoweredByLink';
|
|
12
|
+
import { DocsComponentProps } from '..';
|
|
13
|
+
import { VersionBadge } from '../HttpOperation/Badges';
|
|
14
|
+
import { AdditionalInfo } from './AdditionalInfo';
|
|
15
|
+
import { ExportButton } from './ExportButton';
|
|
16
|
+
import { SecuritySchemes } from './SecuritySchemes';
|
|
17
|
+
import { ServerInfo } from './ServerInfo';
|
|
18
|
+
|
|
19
|
+
export type HttpServiceProps = DocsComponentProps<Partial<IHttpService>>;
|
|
20
|
+
|
|
21
|
+
const HttpServiceComponent = React.memo<HttpServiceProps>(
|
|
22
|
+
({ data: unresolvedData, location = {}, layoutOptions, exportProps }) => {
|
|
23
|
+
const { nodeHasChanged } = useOptionsCtx();
|
|
24
|
+
const data = useResolvedObject(unresolvedData) as IHttpService;
|
|
25
|
+
const { ref: layoutRef, isCompact } = useIsCompact(layoutOptions);
|
|
26
|
+
|
|
27
|
+
const { search, pathname } = location;
|
|
28
|
+
const mocking = React.useContext(MockingContext);
|
|
29
|
+
const query = new URLSearchParams(search);
|
|
30
|
+
|
|
31
|
+
const nameChanged = nodeHasChanged?.({ nodeId: data.id, attr: 'name' });
|
|
32
|
+
const versionChanged = nodeHasChanged?.({ nodeId: data.id, attr: 'version' });
|
|
33
|
+
const descriptionChanged = nodeHasChanged?.({ nodeId: data.id, attr: 'description' });
|
|
34
|
+
|
|
35
|
+
return (
|
|
36
|
+
<Box ref={layoutRef} mb={10} className="HttpService">
|
|
37
|
+
{data.name && !layoutOptions?.noHeading && (
|
|
38
|
+
<Flex justifyContent="between" alignItems="center">
|
|
39
|
+
<Box pos="relative">
|
|
40
|
+
<Heading size={1} mb={4} fontWeight="semibold">
|
|
41
|
+
{data.name}
|
|
42
|
+
</Heading>
|
|
43
|
+
<NodeAnnotation change={nameChanged} />
|
|
44
|
+
</Box>
|
|
45
|
+
{exportProps && !layoutOptions?.hideExport && !isCompact && <ExportButton {...exportProps} />}
|
|
46
|
+
</Flex>
|
|
47
|
+
)}
|
|
48
|
+
|
|
49
|
+
{data.version && (
|
|
50
|
+
<Box mb={5} pos="relative">
|
|
51
|
+
<VersionBadge value={data.version} />
|
|
52
|
+
<NodeAnnotation change={versionChanged} />
|
|
53
|
+
</Box>
|
|
54
|
+
)}
|
|
55
|
+
|
|
56
|
+
{pathname && layoutOptions?.showPoweredByLink && (
|
|
57
|
+
<PoweredByLink source={data.name ?? 'no-title'} pathname={pathname} packageType="elements" layout="stacked" />
|
|
58
|
+
)}
|
|
59
|
+
|
|
60
|
+
<VStack spacing={6}>
|
|
61
|
+
{layoutOptions?.hideServerInfo ? null : <ServerInfo servers={data.servers ?? []} mockUrl={mocking.mockUrl} />}
|
|
62
|
+
|
|
63
|
+
{layoutOptions?.hideSecurityInfo ? null : (
|
|
64
|
+
<Box data-test="security">
|
|
65
|
+
{data.security?.length ? (
|
|
66
|
+
<SecuritySchemes
|
|
67
|
+
secSchemes={data.security}
|
|
68
|
+
defaultScheme={query.get('security') || undefined}
|
|
69
|
+
parentId={data.id}
|
|
70
|
+
/>
|
|
71
|
+
) : null}
|
|
72
|
+
</Box>
|
|
73
|
+
)}
|
|
74
|
+
|
|
75
|
+
<Box data-test="additional-info">
|
|
76
|
+
{(data.contact?.email || data.license || data.termsOfService) && (
|
|
77
|
+
<AdditionalInfo
|
|
78
|
+
id={data.id}
|
|
79
|
+
contact={data.contact}
|
|
80
|
+
license={data.license}
|
|
81
|
+
termsOfService={data.termsOfService}
|
|
82
|
+
/>
|
|
83
|
+
)}
|
|
84
|
+
</Box>
|
|
85
|
+
</VStack>
|
|
86
|
+
|
|
87
|
+
{data.description && (
|
|
88
|
+
<Box pos="relative">
|
|
89
|
+
<MarkdownViewer className="sl-my-5" markdown={data.description} />
|
|
90
|
+
<NodeAnnotation change={descriptionChanged} />
|
|
91
|
+
</Box>
|
|
92
|
+
)}
|
|
93
|
+
</Box>
|
|
94
|
+
);
|
|
95
|
+
},
|
|
96
|
+
);
|
|
97
|
+
HttpServiceComponent.displayName = 'HttpService.Component';
|
|
98
|
+
|
|
99
|
+
export const HttpService = withErrorBoundary<HttpServiceProps>(HttpServiceComponent, { recoverableProps: ['data'] });
|