From bd0ca5babd7267bdeccf2be5eda7849eb7f3772e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Sun, 21 Jul 2024 19:43:50 +0200 Subject: [PATCH] Fix @gitbook/react-openapi when react import are mandatory (#2389) --- .changeset/funny-emus-promise.md | 5 +++++ packages/react-openapi/README.md | 11 ++--------- packages/react-openapi/src/Markdown.tsx | 1 + packages/react-openapi/src/OpenAPICodeSample.tsx | 2 +- packages/react-openapi/src/OpenAPIOperation.tsx | 1 + packages/react-openapi/src/OpenAPIRequestBody.tsx | 2 ++ packages/react-openapi/src/OpenAPIResponse.tsx | 1 + packages/react-openapi/src/OpenAPIResponseExample.tsx | 1 + packages/react-openapi/src/OpenAPIResponses.tsx | 1 + packages/react-openapi/src/OpenAPISecurities.tsx | 1 + packages/react-openapi/src/OpenAPIServerURL.tsx | 1 + .../react-openapi/src/OpenAPIServerURLVariable.tsx | 2 +- packages/react-openapi/src/OpenAPISpec.tsx | 1 + 13 files changed, 19 insertions(+), 11 deletions(-) create mode 100644 .changeset/funny-emus-promise.md diff --git a/.changeset/funny-emus-promise.md b/.changeset/funny-emus-promise.md new file mode 100644 index 000000000..9779a7983 --- /dev/null +++ b/.changeset/funny-emus-promise.md @@ -0,0 +1,5 @@ +--- +'@gitbook/react-openapi': minor +--- + +Fix missing react imports diff --git a/packages/react-openapi/README.md b/packages/react-openapi/README.md index f4f557b0c..ed9f183bd 100644 --- a/packages/react-openapi/README.md +++ b/packages/react-openapi/README.md @@ -1,12 +1,5 @@ # `@gitbook/react-openapi` -React components to render OpenAPI operations. +Style-less React components to render OpenAPI operation blocks. -## Features - -- Generate code samples for the request -- Support custom cde samples with `x-codeSamples` (Redocly syntax) - -## TODO - -- Support for trying out the request +Note: The package is a TypeScript package and do not expose JS built files. diff --git a/packages/react-openapi/src/Markdown.tsx b/packages/react-openapi/src/Markdown.tsx index fa2cbf29b..d85b026eb 100644 --- a/packages/react-openapi/src/Markdown.tsx +++ b/packages/react-openapi/src/Markdown.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import classNames from 'classnames'; export function Markdown(props: { source: string; className?: string }) { diff --git a/packages/react-openapi/src/OpenAPICodeSample.tsx b/packages/react-openapi/src/OpenAPICodeSample.tsx index cb2e2b545..981a9ca22 100644 --- a/packages/react-openapi/src/OpenAPICodeSample.tsx +++ b/packages/react-openapi/src/OpenAPICodeSample.tsx @@ -1,4 +1,4 @@ -import { OpenAPIV3 } from 'openapi-types'; +import * as React from 'react'; import { CodeSampleInput, codeSampleGenerators } from './code-samples'; import { OpenAPIOperationData, toJSON } from './fetchOpenAPIOperation'; diff --git a/packages/react-openapi/src/OpenAPIOperation.tsx b/packages/react-openapi/src/OpenAPIOperation.tsx index 7787e5c67..15b292142 100644 --- a/packages/react-openapi/src/OpenAPIOperation.tsx +++ b/packages/react-openapi/src/OpenAPIOperation.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import classNames from 'classnames'; import { OpenAPIOperationData, toJSON } from './fetchOpenAPIOperation'; diff --git a/packages/react-openapi/src/OpenAPIRequestBody.tsx b/packages/react-openapi/src/OpenAPIRequestBody.tsx index b156bb871..c19a2341f 100644 --- a/packages/react-openapi/src/OpenAPIRequestBody.tsx +++ b/packages/react-openapi/src/OpenAPIRequestBody.tsx @@ -1,3 +1,5 @@ +import * as React from 'react'; + import { OpenAPIV3 } from 'openapi-types'; import { OpenAPIRootSchema } from './OpenAPISchema'; import { noReference } from './utils'; diff --git a/packages/react-openapi/src/OpenAPIResponse.tsx b/packages/react-openapi/src/OpenAPIResponse.tsx index fb9ff0fe9..29473397f 100644 --- a/packages/react-openapi/src/OpenAPIResponse.tsx +++ b/packages/react-openapi/src/OpenAPIResponse.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import classNames from 'classnames'; import { OpenAPIV3 } from 'openapi-types'; import { OpenAPIRootSchema, OpenAPISchemaProperties } from './OpenAPISchema'; diff --git a/packages/react-openapi/src/OpenAPIResponseExample.tsx b/packages/react-openapi/src/OpenAPIResponseExample.tsx index bf4c616f6..ed1bbe486 100644 --- a/packages/react-openapi/src/OpenAPIResponseExample.tsx +++ b/packages/react-openapi/src/OpenAPIResponseExample.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import { InteractiveSection } from './InteractiveSection'; import { OpenAPIOperationData } from './fetchOpenAPIOperation'; import { generateSchemaExample } from './generateSchemaExample'; diff --git a/packages/react-openapi/src/OpenAPIResponses.tsx b/packages/react-openapi/src/OpenAPIResponses.tsx index 35f8cdbbc..bf8bf0cad 100644 --- a/packages/react-openapi/src/OpenAPIResponses.tsx +++ b/packages/react-openapi/src/OpenAPIResponses.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import classNames from 'classnames'; import { OpenAPIV3 } from 'openapi-types'; import { noReference } from './utils'; diff --git a/packages/react-openapi/src/OpenAPISecurities.tsx b/packages/react-openapi/src/OpenAPISecurities.tsx index d44a5993d..bea9aa335 100644 --- a/packages/react-openapi/src/OpenAPISecurities.tsx +++ b/packages/react-openapi/src/OpenAPISecurities.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import { OpenAPIV3 } from 'openapi-types'; import { OpenAPIClientContext } from './types'; import { InteractiveSection } from './InteractiveSection'; diff --git a/packages/react-openapi/src/OpenAPIServerURL.tsx b/packages/react-openapi/src/OpenAPIServerURL.tsx index 63064720c..e81fb47ba 100644 --- a/packages/react-openapi/src/OpenAPIServerURL.tsx +++ b/packages/react-openapi/src/OpenAPIServerURL.tsx @@ -1,3 +1,4 @@ +import * as React from 'react'; import { OpenAPIV3 } from 'openapi-types'; import { OpenAPIServerURLVariable } from './OpenAPIServerURLVariable'; diff --git a/packages/react-openapi/src/OpenAPIServerURLVariable.tsx b/packages/react-openapi/src/OpenAPIServerURLVariable.tsx index 60c4e0006..408c84117 100644 --- a/packages/react-openapi/src/OpenAPIServerURLVariable.tsx +++ b/packages/react-openapi/src/OpenAPIServerURLVariable.tsx @@ -1,8 +1,8 @@ 'use client'; +import * as React from 'react'; import classNames from 'classnames'; import { OpenAPIV3 } from 'openapi-types'; -import React from 'react'; /** * Interactive component to show the value of a server variable and let the user change it. diff --git a/packages/react-openapi/src/OpenAPISpec.tsx b/packages/react-openapi/src/OpenAPISpec.tsx index 34bde07b6..ab56435a2 100644 --- a/packages/react-openapi/src/OpenAPISpec.tsx +++ b/packages/react-openapi/src/OpenAPISpec.tsx @@ -1,5 +1,6 @@ 'use client'; +import * as React from 'react'; import { OpenAPIV3 } from 'openapi-types'; import { OpenAPIOperationData, fromJSON } from './fetchOpenAPIOperation';