@stoplight/elements-core 9.0.15 → 9.0.16-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} +6 -5
- package/{index.js → dist/index.js} +6 -5
- package/{index.mjs → dist/index.mjs} +6 -5
- 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 +233 -0
- package/src/components/Docs/HttpOperation/Badges.tsx +49 -0
- package/src/components/Docs/HttpOperation/Body.tsx +79 -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 +255 -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 +140 -0
- package/src/components/Docs/HttpOperation/Responses.tsx +247 -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 +160 -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 +28 -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 +316 -0
- package/src/components/TableOfContents/TableOfContents.stories.tsx +136 -0
- package/src/components/TableOfContents/TableOfContents.tsx +530 -0
- package/src/components/TableOfContents/constants.ts +45 -0
- package/src/components/TableOfContents/index.ts +2 -0
- package/src/components/TableOfContents/types.ts +59 -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 +135 -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 +245 -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 +64 -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 +261 -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 +107 -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/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,90 @@
|
|
|
1
|
+
import { HttpParamStyles, IHttpRequest } from '@stoplight/types';
|
|
2
|
+
|
|
3
|
+
import { parseHttpRequest } from './CodeComponent';
|
|
4
|
+
|
|
5
|
+
describe('parseHttpRequest', () => {
|
|
6
|
+
it('parses HttpRequest with relative url', () => {
|
|
7
|
+
const request: IHttpRequest = {
|
|
8
|
+
id: '?http-request?',
|
|
9
|
+
method: 'get',
|
|
10
|
+
url: '/todos',
|
|
11
|
+
baseUrl: 'http://test',
|
|
12
|
+
query: {},
|
|
13
|
+
headers: {},
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
const httpOperation = parseHttpRequest(request);
|
|
17
|
+
|
|
18
|
+
expect(httpOperation).toEqual({
|
|
19
|
+
id: '?http-operation-id?',
|
|
20
|
+
method: 'get',
|
|
21
|
+
path: '/todos',
|
|
22
|
+
servers: [{ id: '?http-server-/todos?', url: 'http://test' }],
|
|
23
|
+
request: {
|
|
24
|
+
headers: [],
|
|
25
|
+
query: [],
|
|
26
|
+
},
|
|
27
|
+
responses: [],
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it('parses HttpRequest with absolute url', () => {
|
|
32
|
+
const request: IHttpRequest = {
|
|
33
|
+
id: '?http-request?',
|
|
34
|
+
method: 'get',
|
|
35
|
+
url: 'http://test/todos',
|
|
36
|
+
baseUrl: '',
|
|
37
|
+
query: {},
|
|
38
|
+
headers: {},
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
const httpOperation = parseHttpRequest(request);
|
|
42
|
+
|
|
43
|
+
expect(httpOperation).toEqual({
|
|
44
|
+
id: '?http-operation-id?',
|
|
45
|
+
method: 'get',
|
|
46
|
+
path: '/todos',
|
|
47
|
+
servers: [{ id: '?http-server-http://test/todos?', url: 'http://test' }],
|
|
48
|
+
request: {
|
|
49
|
+
headers: [],
|
|
50
|
+
query: [],
|
|
51
|
+
},
|
|
52
|
+
responses: [],
|
|
53
|
+
});
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
it('parses HttpRequest parameters', () => {
|
|
57
|
+
const request: IHttpRequest = {
|
|
58
|
+
id: '?http-request?',
|
|
59
|
+
method: 'post',
|
|
60
|
+
url: '/todos/{id}',
|
|
61
|
+
baseUrl: 'http://test',
|
|
62
|
+
query: {
|
|
63
|
+
limit: ['10'],
|
|
64
|
+
skip: [],
|
|
65
|
+
},
|
|
66
|
+
headers: {
|
|
67
|
+
apikey: '123',
|
|
68
|
+
},
|
|
69
|
+
body: '{}',
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
const httpOperation = parseHttpRequest(request);
|
|
73
|
+
|
|
74
|
+
expect(httpOperation).toMatchObject({
|
|
75
|
+
id: '?http-operation-id?',
|
|
76
|
+
method: 'post',
|
|
77
|
+
path: '/todos/{id}',
|
|
78
|
+
servers: [{ url: 'http://test' }],
|
|
79
|
+
request: {
|
|
80
|
+
query: [
|
|
81
|
+
{ name: 'limit', style: HttpParamStyles.Form, schema: { default: '10' }, required: true },
|
|
82
|
+
{ name: 'skip', style: HttpParamStyles.Form, schema: {}, required: false },
|
|
83
|
+
],
|
|
84
|
+
headers: [{ name: 'apikey', style: HttpParamStyles.Simple, schema: { default: '123' }, required: true }],
|
|
85
|
+
path: [{ name: 'id', style: HttpParamStyles.Simple, required: true }],
|
|
86
|
+
body: { contents: [{ mediaType: 'application/json', schema: { default: '{}' } }] },
|
|
87
|
+
},
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
});
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/* eslint-disable prettier/prettier */
|
|
2
|
+
import { JsonSchemaViewer } from '@stoplight/json-schema-viewer';
|
|
3
|
+
import { DefaultSMDComponents } from '@stoplight/markdown-viewer';
|
|
4
|
+
import { Box, Flex, Icon } from '@stoplight/mosaic';
|
|
5
|
+
import { HttpParamStyles, IHttpOperation, IHttpRequest, NodeType } from '@stoplight/types';
|
|
6
|
+
import { isPlainObject, isString } from 'lodash';
|
|
7
|
+
import React from 'react';
|
|
8
|
+
import URI from 'urijs';
|
|
9
|
+
|
|
10
|
+
import { NodeTypeColors, NodeTypeIconDefs } from '../../../constants';
|
|
11
|
+
import {
|
|
12
|
+
InlineRefResolverProvider,
|
|
13
|
+
useInlineRefResolver,
|
|
14
|
+
useSchemaInlineRefResolver,
|
|
15
|
+
} from '../../../context/InlineRefResolver';
|
|
16
|
+
import { useOptionsCtx } from '../../../context/Options';
|
|
17
|
+
import { PersistenceContextProvider } from '../../../context/Persistence';
|
|
18
|
+
import { useParsedValue } from '../../../hooks/useParsedValue';
|
|
19
|
+
import { JSONSchema } from '../../../types';
|
|
20
|
+
import { isHttpOperation, isJSONSchema } from '../../../utils/guards';
|
|
21
|
+
import { getOriginalObject } from '../../../utils/ref-resolving/resolvedObject';
|
|
22
|
+
import { TryIt } from '../../TryIt';
|
|
23
|
+
import { CustomComponentMapping } from './Provider';
|
|
24
|
+
|
|
25
|
+
type PartialHttpRequest = Pick<IHttpRequest, 'method' | 'url'> & Partial<IHttpRequest>;
|
|
26
|
+
|
|
27
|
+
function isPartialHttpRequest(maybeHttpRequest: unknown): maybeHttpRequest is PartialHttpRequest {
|
|
28
|
+
return (
|
|
29
|
+
isPlainObject(maybeHttpRequest) &&
|
|
30
|
+
isString((maybeHttpRequest as PartialHttpRequest).method) &&
|
|
31
|
+
isString((maybeHttpRequest as PartialHttpRequest).url)
|
|
32
|
+
);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface ISchemaAndDescriptionProps {
|
|
36
|
+
schema: JSONSchema;
|
|
37
|
+
title?: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
const SchemaAndDescription = ({ title: titleProp, schema }: ISchemaAndDescriptionProps) => {
|
|
41
|
+
const [resolveRef, maxRefDepth] = useSchemaInlineRefResolver();
|
|
42
|
+
const { renderExtensionAddon } = useOptionsCtx();
|
|
43
|
+
|
|
44
|
+
const title = titleProp ?? schema.title;
|
|
45
|
+
return (
|
|
46
|
+
<Box py={2}>
|
|
47
|
+
{title && (
|
|
48
|
+
<Flex alignItems="center" p={2}>
|
|
49
|
+
<Icon icon={NodeTypeIconDefs[NodeType.Model]} color={NodeTypeColors[NodeType.Model]} />
|
|
50
|
+
<Box color="muted" px={2}>
|
|
51
|
+
{title}
|
|
52
|
+
</Box>
|
|
53
|
+
</Flex>
|
|
54
|
+
)}
|
|
55
|
+
|
|
56
|
+
<JsonSchemaViewer
|
|
57
|
+
resolveRef={resolveRef}
|
|
58
|
+
maxRefDepth={maxRefDepth}
|
|
59
|
+
schema={getOriginalObject(schema)}
|
|
60
|
+
renderExtensionAddon={renderExtensionAddon}
|
|
61
|
+
/>
|
|
62
|
+
</Box>
|
|
63
|
+
);
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
export { DefaultSMDComponents };
|
|
67
|
+
|
|
68
|
+
export const CodeComponent: CustomComponentMapping['code'] = props => {
|
|
69
|
+
const { title, jsonSchema, http, resolved, children } = props;
|
|
70
|
+
|
|
71
|
+
const resolver = useInlineRefResolver();
|
|
72
|
+
|
|
73
|
+
const value = resolved || String(Array.isArray(children) ? children[0] : children);
|
|
74
|
+
const parsedValue = useParsedValue(value);
|
|
75
|
+
|
|
76
|
+
if (jsonSchema) {
|
|
77
|
+
if (!isJSONSchema(parsedValue)) {
|
|
78
|
+
return null;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
return (
|
|
82
|
+
<InlineRefResolverProvider
|
|
83
|
+
document={parsedValue}
|
|
84
|
+
resolver={resolver?.resolver}
|
|
85
|
+
maxRefDepth={resolver?.maxRefDepth}
|
|
86
|
+
>
|
|
87
|
+
<SchemaAndDescription title={title} schema={parsedValue} />
|
|
88
|
+
</InlineRefResolverProvider>
|
|
89
|
+
);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
if (http) {
|
|
93
|
+
if (!isPlainObject(parsedValue) || (!isPartialHttpRequest(parsedValue) && !isHttpOperation(parsedValue))) {
|
|
94
|
+
return null;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
return (
|
|
98
|
+
<PersistenceContextProvider>
|
|
99
|
+
<TryIt
|
|
100
|
+
httpOperation={isHttpOperation(parsedValue) ? parsedValue : parseHttpRequest(parsedValue)}
|
|
101
|
+
embeddedInMd
|
|
102
|
+
/>
|
|
103
|
+
</PersistenceContextProvider>
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
const DefaultCode = DefaultSMDComponents.code!;
|
|
108
|
+
return <DefaultCode {...props} />;
|
|
109
|
+
};
|
|
110
|
+
|
|
111
|
+
export function parseHttpRequest(data: PartialHttpRequest): IHttpOperation {
|
|
112
|
+
const uri = URI(data.url);
|
|
113
|
+
const pathParam = data.url.match(/[^{\}]+(?=})/g);
|
|
114
|
+
return {
|
|
115
|
+
id: '?http-operation-id?',
|
|
116
|
+
method: data.method,
|
|
117
|
+
path: uri.is('absolute') ? uri.path() : data.url,
|
|
118
|
+
servers: [{ id: `?http-server-${uri.href()}?`, url: uri.is('absolute') ? uri.origin() : data.baseUrl || '' }],
|
|
119
|
+
request: {
|
|
120
|
+
query: Object.entries(data.query || {}).map(([key, value]) => {
|
|
121
|
+
const defaultVal = Array.isArray(value) ? value[0] : value;
|
|
122
|
+
return {
|
|
123
|
+
id: `?http-query-${key}-id?`,
|
|
124
|
+
name: key,
|
|
125
|
+
style: HttpParamStyles.Form,
|
|
126
|
+
schema: { default: defaultVal },
|
|
127
|
+
required: isHttpRequestParamRequired(defaultVal),
|
|
128
|
+
};
|
|
129
|
+
}),
|
|
130
|
+
headers: Object.entries(data.headers || {}).map(([key, value]) => ({
|
|
131
|
+
id: `?http-header-${key}-id?`,
|
|
132
|
+
name: key,
|
|
133
|
+
style: HttpParamStyles.Simple,
|
|
134
|
+
schema: { default: value },
|
|
135
|
+
required: isHttpRequestParamRequired(value),
|
|
136
|
+
})),
|
|
137
|
+
path: pathParam?.map(name => ({
|
|
138
|
+
id: `?http-param-${name}-id?`,
|
|
139
|
+
name,
|
|
140
|
+
style: HttpParamStyles.Simple,
|
|
141
|
+
required: true,
|
|
142
|
+
})),
|
|
143
|
+
...(data.body
|
|
144
|
+
? {
|
|
145
|
+
body: {
|
|
146
|
+
id: '?http-request-body?',
|
|
147
|
+
contents: [
|
|
148
|
+
{
|
|
149
|
+
id: '?http-request-body-media?',
|
|
150
|
+
mediaType: 'application/json',
|
|
151
|
+
schema: { default: data.body },
|
|
152
|
+
},
|
|
153
|
+
],
|
|
154
|
+
},
|
|
155
|
+
}
|
|
156
|
+
: null),
|
|
157
|
+
},
|
|
158
|
+
responses: [],
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
function isHttpRequestParamRequired(value: unknown) {
|
|
163
|
+
return typeof value !== 'undefined';
|
|
164
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import {
|
|
2
|
+
CustomComponentMapping as MDVCustomComponentMapping,
|
|
3
|
+
MarkdownViewerProvider,
|
|
4
|
+
} from '@stoplight/markdown-viewer';
|
|
5
|
+
import * as React from 'react';
|
|
6
|
+
|
|
7
|
+
import { CodeComponent } from './CodeComponent';
|
|
8
|
+
|
|
9
|
+
export type CustomComponentMapping = MDVCustomComponentMapping;
|
|
10
|
+
|
|
11
|
+
interface MarkdownComponentsProviderProps {
|
|
12
|
+
value: Partial<CustomComponentMapping> | undefined;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Provides components to markdown-viewer.
|
|
17
|
+
*/
|
|
18
|
+
export const MarkdownComponentsProvider: React.FC<MarkdownComponentsProviderProps> = ({ value, children }) => {
|
|
19
|
+
return <MarkdownViewerProvider components={{ code: CodeComponent!, ...value }}>{children}</MarkdownViewerProvider>;
|
|
20
|
+
};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { LinkProps } from '@stoplight/mosaic';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
|
|
4
|
+
const externalRegex = new RegExp('^(?:[a-z]+:)?//', 'i');
|
|
5
|
+
|
|
6
|
+
export const ReactRouterMarkdownLink = ({
|
|
7
|
+
title,
|
|
8
|
+
to,
|
|
9
|
+
href: _href,
|
|
10
|
+
children,
|
|
11
|
+
}: Omit<LinkProps, 'target' | 'rel'> & { to?: string }) => {
|
|
12
|
+
const href = to || _href;
|
|
13
|
+
|
|
14
|
+
const isExternal = href !== undefined && externalRegex.test(href);
|
|
15
|
+
if (isExternal) {
|
|
16
|
+
return (
|
|
17
|
+
<a target="_blank" rel="noreferrer noopener" href={href} title={title}>
|
|
18
|
+
{children}
|
|
19
|
+
</a>
|
|
20
|
+
);
|
|
21
|
+
}
|
|
22
|
+
return (
|
|
23
|
+
<a href={href as string} title={title}>
|
|
24
|
+
{children}
|
|
25
|
+
</a>
|
|
26
|
+
);
|
|
27
|
+
};
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { CustomComponentMapping } from '@stoplight/markdown-viewer';
|
|
2
|
+
import { dirname, resolve } from '@stoplight/path';
|
|
3
|
+
import React from 'react';
|
|
4
|
+
import URI from 'urijs';
|
|
5
|
+
|
|
6
|
+
import { BundledBranchNode, IntegrationKind } from '../../../types';
|
|
7
|
+
|
|
8
|
+
export const createResolvedImageComponent = (branchNode: BundledBranchNode) => {
|
|
9
|
+
const ResolvedImage: CustomComponentMapping['img'] = ({ title, alt, src }) => {
|
|
10
|
+
return <img src={resolveImageUrlHandler(src || '', branchNode)} title={title} alt={alt} />;
|
|
11
|
+
};
|
|
12
|
+
return React.memo(ResolvedImage);
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
const resolveImageUrlHandler = (url: string, branchNode: BundledBranchNode) => {
|
|
16
|
+
// don't touch absolute urls no matter which service we're using
|
|
17
|
+
if (URI(url).is('absolute')) {
|
|
18
|
+
return url;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const orgSlug = branchNode.externalOrgSlug;
|
|
22
|
+
const projectSlug = branchNode.externalSlug;
|
|
23
|
+
const branchSlug = branchNode.branchSlug;
|
|
24
|
+
const uri = branchNode.uri;
|
|
25
|
+
|
|
26
|
+
if (!orgSlug || !projectSlug || !branchNode.workspaceIntegration.kind) {
|
|
27
|
+
return url;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const resolvedUri = resolve(dirname(uri || ''), url);
|
|
31
|
+
|
|
32
|
+
let imageUri;
|
|
33
|
+
switch (branchNode.workspaceIntegration.kind) {
|
|
34
|
+
case IntegrationKind.AzureDevopsServer:
|
|
35
|
+
imageUri = new URI(branchNode.workspaceIntegration.hostUrl || '');
|
|
36
|
+
imageUri
|
|
37
|
+
.segmentCoded([...imageUri.segmentCoded(), orgSlug, '_apis', 'git', 'repositories', projectSlug, 'items'])
|
|
38
|
+
.query({
|
|
39
|
+
scopePath: resolvedUri,
|
|
40
|
+
'api-version': '4.1',
|
|
41
|
+
$format: 'OctetStream',
|
|
42
|
+
});
|
|
43
|
+
break;
|
|
44
|
+
|
|
45
|
+
case IntegrationKind.BitbucketServer:
|
|
46
|
+
// need to remove the api path
|
|
47
|
+
imageUri = new URI((branchNode.workspaceIntegration.apiUrl || '').replace(/\/rest\/api\/[0-9.]+/, ''));
|
|
48
|
+
imageUri.segmentCoded([...imageUri.segmentCoded(), 'projects', orgSlug, 'repos', projectSlug || '', 'browse']);
|
|
49
|
+
imageUri.segment([...imageUri.segment(), resolvedUri]).query({ raw: '' });
|
|
50
|
+
break;
|
|
51
|
+
|
|
52
|
+
case IntegrationKind.BitbucketCloud:
|
|
53
|
+
imageUri = new URI(branchNode.workspaceIntegration.hostUrl || '');
|
|
54
|
+
imageUri.segmentCoded([...imageUri.segmentCoded(), orgSlug, projectSlug, 'raw', branchSlug]);
|
|
55
|
+
imageUri.segment([...imageUri.segment(), resolvedUri]);
|
|
56
|
+
break;
|
|
57
|
+
|
|
58
|
+
case IntegrationKind.Github:
|
|
59
|
+
imageUri = new URI(branchNode.workspaceIntegration.hostUrl || '');
|
|
60
|
+
imageUri.hostname(`raw.${imageUri.hostname()}`);
|
|
61
|
+
imageUri.segmentCoded([...imageUri.segmentCoded(), orgSlug, projectSlug, branchSlug]);
|
|
62
|
+
imageUri.segment([...imageUri.segment(), resolvedUri]);
|
|
63
|
+
// if image is svg sanitize true
|
|
64
|
+
if (RegExp(/\.svg$/).test(imageUri.path())) {
|
|
65
|
+
imageUri.setQuery({ sanitize: true });
|
|
66
|
+
}
|
|
67
|
+
break;
|
|
68
|
+
|
|
69
|
+
case IntegrationKind.Gitlab:
|
|
70
|
+
imageUri = new URI(branchNode.workspaceIntegration.hostUrl || '');
|
|
71
|
+
imageUri.segmentCoded([...imageUri.segmentCoded(), orgSlug, projectSlug, 'raw', branchSlug]);
|
|
72
|
+
imageUri.segment([...imageUri.segment(), resolvedUri]);
|
|
73
|
+
break;
|
|
74
|
+
|
|
75
|
+
case IntegrationKind.Gitea:
|
|
76
|
+
imageUri = new URI(branchNode.workspaceIntegration.hostUrl || '');
|
|
77
|
+
imageUri.segmentCoded([...imageUri.segmentCoded(), orgSlug, projectSlug, 'raw', 'branch', branchSlug]);
|
|
78
|
+
imageUri.segment([...imageUri.segment(), resolvedUri]);
|
|
79
|
+
break;
|
|
80
|
+
|
|
81
|
+
default:
|
|
82
|
+
imageUri = new URI(resolvedUri);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
return imageUri.normalize().valueOf();
|
|
86
|
+
};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* This is copied from https://github.com/ncoughlin/scroll-to-hash-element/blob/main/src/index.tsx
|
|
3
|
+
* Unfortunately this package does not contain typescript definitions, so we can not use it directly.
|
|
4
|
+
*/
|
|
5
|
+
import { useEffect, useLayoutEffect, useRef, useState } from 'react';
|
|
6
|
+
|
|
7
|
+
interface ScrollToHashElementProps {
|
|
8
|
+
/** On first run do we jump or scroll? */
|
|
9
|
+
initialBehavior?: ScrollBehavior;
|
|
10
|
+
behavior?: ScrollBehavior;
|
|
11
|
+
inline?: ScrollLogicalPosition;
|
|
12
|
+
block?: ScrollLogicalPosition;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export const ScrollToHashElement = ({
|
|
16
|
+
behavior = 'auto',
|
|
17
|
+
initialBehavior = 'auto',
|
|
18
|
+
inline = 'nearest',
|
|
19
|
+
block = 'start',
|
|
20
|
+
}: ScrollToHashElementProps): null => {
|
|
21
|
+
const [hash, setHash] = useState(window.location.hash);
|
|
22
|
+
const [count, setCount] = useState(0);
|
|
23
|
+
const originalListeners = useRef<{ [key: string]: Function }>({});
|
|
24
|
+
|
|
25
|
+
// We need to know if this is the first run. If it is, we can do an instant jump, no scrolling.
|
|
26
|
+
const [firstRun, setFirstRun] = useState(true);
|
|
27
|
+
useEffect(() => setFirstRun(false), []);
|
|
28
|
+
|
|
29
|
+
useEffect(() => {
|
|
30
|
+
const handleLocationChange = () => {
|
|
31
|
+
setHash(window.location.hash);
|
|
32
|
+
|
|
33
|
+
// We increment count just so the layout effect will run if the hash is the same.
|
|
34
|
+
// Otherwise the user might click a hashlink a second time and it won't go anywhere.
|
|
35
|
+
setCount((count: number) => count + 1);
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
const onPopState = () => {
|
|
39
|
+
window.dispatchEvent(new Event('locationchange'));
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
const addWindowListeners = () => {
|
|
43
|
+
originalListeners.current.pushState = window.history.pushState;
|
|
44
|
+
originalListeners.current.replaceState = window.history.replaceState;
|
|
45
|
+
|
|
46
|
+
window.history.pushState = function (...args: any) {
|
|
47
|
+
const result = originalListeners.current.pushState.apply(this, args);
|
|
48
|
+
window.dispatchEvent(new Event('pushstate'));
|
|
49
|
+
window.dispatchEvent(new Event('locationchange'));
|
|
50
|
+
return result;
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
window.history.replaceState = function (...args: any) {
|
|
54
|
+
const result = originalListeners.current.replaceState.apply(this, args);
|
|
55
|
+
window.dispatchEvent(new Event('replacestate'));
|
|
56
|
+
window.dispatchEvent(new Event('locationchange'));
|
|
57
|
+
return result;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
window.addEventListener('popstate', onPopState);
|
|
61
|
+
window.addEventListener('locationchange', handleLocationChange);
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
// Cleanup the event listeners on component unmount
|
|
65
|
+
const removeWindowListeners = () => {
|
|
66
|
+
window.history.pushState = originalListeners.current.pushState as typeof window.history.pushState;
|
|
67
|
+
window.history.replaceState = originalListeners.current.replaceState as typeof window.history.replaceState;
|
|
68
|
+
window.removeEventListener('popstate', onPopState);
|
|
69
|
+
window.removeEventListener('locationchange', handleLocationChange);
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
addWindowListeners();
|
|
73
|
+
return removeWindowListeners;
|
|
74
|
+
}, []);
|
|
75
|
+
|
|
76
|
+
useLayoutEffect(() => {
|
|
77
|
+
const removeHashCharacter = (str: string) => {
|
|
78
|
+
return str.slice(1);
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
if (hash) {
|
|
82
|
+
const element = document.getElementById(removeHashCharacter(hash));
|
|
83
|
+
|
|
84
|
+
if (element) {
|
|
85
|
+
element.scrollIntoView({
|
|
86
|
+
behavior: firstRun ? initialBehavior : behavior,
|
|
87
|
+
inline: inline,
|
|
88
|
+
block: block,
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
93
|
+
}, [hash, count, firstRun]);
|
|
94
|
+
|
|
95
|
+
return null;
|
|
96
|
+
};
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
2
|
+
|
|
3
|
+
import { NodeType } from '@stoplight/types';
|
|
4
|
+
import { render, screen } from '@testing-library/react';
|
|
5
|
+
import * as React from 'react';
|
|
6
|
+
|
|
7
|
+
import { schemaWithRefs } from '../../__fixtures__/articles/schema-with-refs';
|
|
8
|
+
import { withPersistenceBoundary } from '../../context/Persistence';
|
|
9
|
+
import { IntegrationKind } from '../../types';
|
|
10
|
+
import { MarkdownViewer } from '.';
|
|
11
|
+
import { CodeComponent } from './CustomComponents/CodeComponent';
|
|
12
|
+
import { MarkdownComponentsProvider } from './CustomComponents/Provider';
|
|
13
|
+
import { createResolvedImageComponent } from './CustomComponents/ResolvedImage';
|
|
14
|
+
|
|
15
|
+
describe('MarkdownViewer', () => {
|
|
16
|
+
describe('with ResolvedImage', () => {
|
|
17
|
+
const common = {
|
|
18
|
+
id: 54234624,
|
|
19
|
+
data: 'some data',
|
|
20
|
+
type: NodeType.Article,
|
|
21
|
+
name: 'Some Article',
|
|
22
|
+
uri: '/docs/some-article.md',
|
|
23
|
+
summary: 'some summary',
|
|
24
|
+
branchSlug: 'master',
|
|
25
|
+
workspaceIntegration: {
|
|
26
|
+
kind: IntegrationKind.Github,
|
|
27
|
+
apiUrl: 'https://api.github.com',
|
|
28
|
+
hostUrl: 'https://github.com',
|
|
29
|
+
},
|
|
30
|
+
externalOrgSlug: 'organisation',
|
|
31
|
+
externalSlug: 'project',
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
it.each([
|
|
35
|
+
[
|
|
36
|
+
IntegrationKind.Github,
|
|
37
|
+
{
|
|
38
|
+
...common,
|
|
39
|
+
workspaceIntegration: {
|
|
40
|
+
kind: IntegrationKind.Github,
|
|
41
|
+
apiUrl: 'https://api.github.com',
|
|
42
|
+
hostUrl: 'https://github.com',
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
'https://raw.github.com/organisation/project/master/common/images/icon48.png',
|
|
46
|
+
],
|
|
47
|
+
|
|
48
|
+
[
|
|
49
|
+
IntegrationKind.Gitlab,
|
|
50
|
+
{
|
|
51
|
+
...common,
|
|
52
|
+
workspaceIntegration: {
|
|
53
|
+
kind: IntegrationKind.Gitlab,
|
|
54
|
+
apiUrl: 'https://api.gitlab.com',
|
|
55
|
+
hostUrl: 'https://gitlab.com',
|
|
56
|
+
},
|
|
57
|
+
},
|
|
58
|
+
'https://gitlab.com/organisation/project/raw/master/common/images/icon48.png',
|
|
59
|
+
],
|
|
60
|
+
|
|
61
|
+
[
|
|
62
|
+
IntegrationKind.Gitea,
|
|
63
|
+
{
|
|
64
|
+
...common,
|
|
65
|
+
workspaceIntegration: {
|
|
66
|
+
kind: IntegrationKind.Gitea,
|
|
67
|
+
apiUrl: 'https://api.gitea.com',
|
|
68
|
+
hostUrl: 'https://gitea.com',
|
|
69
|
+
},
|
|
70
|
+
},
|
|
71
|
+
'https://gitea.com/organisation/project/raw/branch/master/common/images/icon48.png',
|
|
72
|
+
],
|
|
73
|
+
|
|
74
|
+
[
|
|
75
|
+
IntegrationKind.BitbucketServer,
|
|
76
|
+
{
|
|
77
|
+
...common,
|
|
78
|
+
workspaceIntegration: {
|
|
79
|
+
kind: IntegrationKind.BitbucketServer,
|
|
80
|
+
apiUrl: 'https://api.bitbucket.com',
|
|
81
|
+
hostUrl: 'https://bitbucket.com',
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
'https://api.bitbucket.com/projects/organisation/repos/project/browse/common/images/icon48.png?raw=',
|
|
85
|
+
],
|
|
86
|
+
|
|
87
|
+
[
|
|
88
|
+
IntegrationKind.BitbucketCloud,
|
|
89
|
+
{
|
|
90
|
+
...common,
|
|
91
|
+
workspaceIntegration: {
|
|
92
|
+
kind: IntegrationKind.BitbucketCloud,
|
|
93
|
+
apiUrl: 'https://api.bitbucket.com',
|
|
94
|
+
hostUrl: 'https://bitbucket.com',
|
|
95
|
+
},
|
|
96
|
+
},
|
|
97
|
+
'https://bitbucket.com/organisation/project/raw/master/common/images/icon48.png',
|
|
98
|
+
],
|
|
99
|
+
])('resolves relative image url for integration with %s', (_, branchNode, expectedUrl) => {
|
|
100
|
+
render(
|
|
101
|
+
<MarkdownComponentsProvider value={{ img: createResolvedImageComponent(branchNode) }}>
|
|
102
|
+
<MarkdownViewer markdown={``} />
|
|
103
|
+
</MarkdownComponentsProvider>,
|
|
104
|
+
);
|
|
105
|
+
|
|
106
|
+
const image = screen.getByTitle('Logo Title Text 1');
|
|
107
|
+
|
|
108
|
+
expect(image).toHaveAttribute('src', expectedUrl);
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
describe('CodeComponent', () => {
|
|
113
|
+
it('Should render TryIt correctly', () => {
|
|
114
|
+
const MarkdownViewerWithTryIt = withPersistenceBoundary(MarkdownViewer);
|
|
115
|
+
const markdown = `### Raw Http Request
|
|
116
|
+
|
|
117
|
+
<!-- type: http -->
|
|
118
|
+
|
|
119
|
+
\`\`\`json
|
|
120
|
+
{
|
|
121
|
+
"method": "get",
|
|
122
|
+
"url": "/gifs/search",
|
|
123
|
+
"baseUrl": "http://api.giphy.com/v1",
|
|
124
|
+
"headers": {},
|
|
125
|
+
"query": {
|
|
126
|
+
"api_key": ["dc6zaTOxFJmzC"],
|
|
127
|
+
"limit": [],
|
|
128
|
+
"q": ["cats"]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
\`\`\`
|
|
132
|
+
`;
|
|
133
|
+
|
|
134
|
+
const { unmount } = render(
|
|
135
|
+
<MarkdownComponentsProvider value={{ code: CodeComponent }}>
|
|
136
|
+
<MarkdownViewerWithTryIt markdown={markdown} />
|
|
137
|
+
</MarkdownComponentsProvider>,
|
|
138
|
+
);
|
|
139
|
+
|
|
140
|
+
expect(screen.getByText('http://api.giphy.com/v1/gifs/search')).toBeInTheDocument();
|
|
141
|
+
|
|
142
|
+
// has default
|
|
143
|
+
expect(screen.getByText('api_key*')).toBeInTheDocument();
|
|
144
|
+
expect(screen.getByLabelText('api_key')).toHaveProperty('value', 'dc6zaTOxFJmzC');
|
|
145
|
+
|
|
146
|
+
expect(screen.getByText('q*')).toBeInTheDocument();
|
|
147
|
+
expect(screen.getByLabelText('q')).toHaveProperty('value', 'cats');
|
|
148
|
+
|
|
149
|
+
// no default
|
|
150
|
+
expect(screen.getByText('limit')).toBeInTheDocument();
|
|
151
|
+
expect(screen.getByLabelText('limit')).toHaveProperty('value', '');
|
|
152
|
+
|
|
153
|
+
unmount();
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
it('Should resolve refs in schema', () => {
|
|
157
|
+
const MarkdownViewerWithTryIt = withPersistenceBoundary(MarkdownViewer);
|
|
158
|
+
|
|
159
|
+
const { unmount } = render(
|
|
160
|
+
<MarkdownComponentsProvider value={{ code: CodeComponent }}>
|
|
161
|
+
<MarkdownViewerWithTryIt markdown={schemaWithRefs} />
|
|
162
|
+
</MarkdownComponentsProvider>,
|
|
163
|
+
);
|
|
164
|
+
|
|
165
|
+
expect(screen.getByText(/Inner referenced object/)).toBeInTheDocument();
|
|
166
|
+
|
|
167
|
+
unmount();
|
|
168
|
+
});
|
|
169
|
+
});
|
|
170
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IMarkdownViewerProps, MarkdownViewer as MarkdownViewerComponent } from '@stoplight/markdown-viewer';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* This wrapper is no longer needed and can be removed in the future.
|
|
6
|
+
*/
|
|
7
|
+
export const MarkdownViewer = (props: IMarkdownViewerProps) => {
|
|
8
|
+
return <MarkdownViewerComponent {...props} />;
|
|
9
|
+
};
|
|
10
|
+
MarkdownViewer.displayName = 'MarkdownViewer';
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Box, Flex, Heading, Icon, IIconProps, Text } from '@stoplight/mosaic';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
|
|
4
|
+
type NonIdealStateProps = {
|
|
5
|
+
description?: React.ReactNode;
|
|
6
|
+
icon?: IIconProps['icon'];
|
|
7
|
+
title?: React.ReactNode;
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
export const NonIdealState: React.FC<NonIdealStateProps> = ({ description, icon, title }) => {
|
|
11
|
+
return (
|
|
12
|
+
<Flex flexDirection="col" alignItems="center" justifyContent="center" textAlign="center" w="full" h="full">
|
|
13
|
+
<Box as={Icon} icon={icon || ['fas', 'exclamation-triangle']} color="light" fontSize="6xl" mb={4} />
|
|
14
|
+
<Heading size={4} mb={4}>
|
|
15
|
+
{title}
|
|
16
|
+
</Heading>
|
|
17
|
+
<Text>{description}</Text>
|
|
18
|
+
</Flex>
|
|
19
|
+
);
|
|
20
|
+
};
|