docusaurus-theme-openapi-docs 4.3.6 → 4.4.0

package/lib/theme/ApiExplorer/FormFileUpload/_FormFileUpload.scss

@@ -13,7 +13,8 @@
 
   &:hover {
     border: 2px dashed var(--ifm-color-primary);
-    background: linear-gradient(
+    background:
+      linear-gradient(
         var(--openapi-dropzone-hover-shim),
         var(--openapi-dropzone-hover-shim)
       ),
@@ -38,7 +39,8 @@
   font-size: var(--ifm-code-font-size);
   border: 2px dashed var(--ifm-color-primary);
 
-  background: linear-gradient(
+  background:
+    linear-gradient(
       var(--openapi-dropzone-hover-shim),
       var(--openapi-dropzone-hover-shim)
     ),

package/lib/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -45,8 +45,8 @@
   line-height: 1.5;
 
   transition-property: color, background, border-color, box-shadow;
-  transition-duration: 100ms, 100ms, 100ms,
-    var(--ifm-button-transition-duration);
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
   transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
 
   -webkit-user-select: none;
@@ -85,8 +85,8 @@
   padding: 0.5rem 1rem;
   font-size: 12px;
   transition-property: color, background, border-color, box-shadow;
-  transition-duration: 100ms, 100ms, 100ms,
-    var(--ifm-button-transition-duration);
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
   transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
   user-select: none;
   white-space: nowrap;

package/lib/theme/ApiExplorer/Request/index.js

@@ -158,15 +158,36 @@ function Request({ item }) {
     paramsArray.push(param);
   });
   const methods = (0, react_hook_form_1.useForm)({ shouldFocusError: false });
+  const handleEventStream = async (res) => {
+    res.headers &&
+      dispatch((0, slice_1.setHeaders)(Object.fromEntries(res.headers)));
+    dispatch((0, slice_1.setCode)(res.status));
+    const reader = res.body.getReader();
+    const decoder = new TextDecoder();
+    let result = "";
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      result += decoder.decode(value, { stream: true });
+      dispatch((0, slice_1.setResponse)(result));
+    }
+  };
+  const handleResponse = async (res) => {
+    dispatch((0, slice_1.setResponse)(await res.text()));
+    dispatch((0, slice_1.setCode)(res.status));
+    res.headers &&
+      dispatch((0, slice_1.setHeaders)(Object.fromEntries(res.headers)));
+  };
   const onSubmit = async (data) => {
     dispatch((0, slice_1.setResponse)("Fetching..."));
     try {
       await delay(1200);
       const res = await (0, makeRequest_1.default)(postmanRequest, proxy, body);
-      dispatch((0, slice_1.setResponse)(await res.text()));
-      dispatch((0, slice_1.setCode)(res.status));
-      res.headers &&
-        dispatch((0, slice_1.setHeaders)(Object.fromEntries(res.headers)));
+      if (res.headers.get("content-type")?.includes("text/event-stream")) {
+        await handleEventStream(res);
+      } else {
+        await handleResponse(res);
+      }
     } catch (e) {
       console.log(e);
       dispatch((0, slice_1.setResponse)("Connection failed"));

package/lib/theme/DiscriminatorTabs/index.js

@@ -238,7 +238,10 @@ function TabsComponent(props) {
 }
 function DiscriminatorTabs(props) {
   const isBrowser = (0, useIsBrowser_1.default)();
-  if (!props.length)
+  if (
+    !props.children ||
+    (Array.isArray(props.children) && props.children.length === 0)
+  )
     return react_1.default.createElement(react_1.default.Fragment, null);
   return react_1.default.createElement(
     TabsComponent,

package/lib/theme/ParamsItem/index.js

@@ -44,9 +44,12 @@ function ParamsItem({ param, ...rest }) {
   } = param;
   let schema = param.schema;
   let defaultValue;
-  if (!schema || !schema?.type) {
+  if (!schema) {
     schema = { type: "any" };
   }
+  if (!schema.type) {
+    schema.type = "any";
+  }
   if (schema) {
     if (schema.items) {
       defaultValue = schema.items.default;

package/lib/theme/Schema/index.js

@@ -344,7 +344,8 @@ const DiscriminatorNode = ({ discriminator, schema, schemaType }) => {
       mergedSubSchema = mergeAllOf(subSchema);
     }
     const subProperties = subSchema.properties || mergedSubSchema.properties;
-    if (subProperties[discriminator.propertyName]) {
+    // Add a safeguard check to avoid referencing subProperties if it's undefined
+    if (subProperties && subProperties[discriminator.propertyName]) {
       if (schema.properties) {
         schema.properties[discriminator.propertyName] = {
           ...schema.properties[discriminator.propertyName],
@@ -777,6 +778,37 @@ const SchemaEdge = ({ name, schema, required, discriminator, schemaType }) => {
     children: null,
   });
 };
+function renderChildren(schema, schemaType) {
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    schema.oneOf &&
+      react_1.default.createElement(AnyOneOf, {
+        schema: schema,
+        schemaType: schemaType,
+      }),
+    schema.anyOf &&
+      react_1.default.createElement(AnyOneOf, {
+        schema: schema,
+        schemaType: schemaType,
+      }),
+    schema.properties &&
+      react_1.default.createElement(Properties, {
+        schema: schema,
+        schemaType: schemaType,
+      }),
+    schema.additionalProperties &&
+      react_1.default.createElement(AdditionalProperties, {
+        schema: schema,
+        schemaType: schemaType,
+      }),
+    schema.items &&
+      react_1.default.createElement(Items, {
+        schema: schema,
+        schemaType: schemaType,
+      })
+  );
+}
 const SchemaNode = ({ schema, schemaType }) => {
   if (
     (schemaType === "request" && schema.readOnly) ||
@@ -826,12 +858,6 @@ const SchemaNode = ({ schema, schemaType }) => {
         })
     );
   }
-  if (schema.oneOf || schema.anyOf) {
-    return react_1.default.createElement(AnyOneOf, {
-      schema: schema,
-      schemaType: schemaType,
-    });
-  }
   // Handle primitives
   if (
     schema.type &&
@@ -854,34 +880,6 @@ const SchemaNode = ({ schema, schemaType }) => {
       children: null,
     });
   }
-  return react_1.default.createElement(
-    "div",
-    null,
-    schema.oneOf &&
-      react_1.default.createElement(AnyOneOf, {
-        schema: schema,
-        schemaType: schemaType,
-      }),
-    schema.anyOf &&
-      react_1.default.createElement(AnyOneOf, {
-        schema: schema,
-        schemaType: schemaType,
-      }),
-    schema.properties &&
-      react_1.default.createElement(Properties, {
-        schema: schema,
-        schemaType: schemaType,
-      }),
-    schema.additionalProperties &&
-      react_1.default.createElement(AdditionalProperties, {
-        schema: schema,
-        schemaType: schemaType,
-      }),
-    schema.items &&
-      react_1.default.createElement(Items, {
-        schema: schema,
-        schemaType: schemaType,
-      })
-  );
+  return renderChildren(schema, schemaType);
 };
 exports.default = SchemaNode;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "4.3.6",
+  "version": "4.4.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -36,7 +36,7 @@
     "@types/lodash": "^4.14.176",
     "@types/pako": "^2.0.3",
     "concurrently": "^5.2.0",
-    "docusaurus-plugin-openapi-docs": "^4.3.6",
+    "docusaurus-plugin-openapi-docs": "^4.4.0",
     "docusaurus-plugin-sass": "^0.2.3",
     "eslint-plugin-prettier": "^5.0.1"
   },
@@ -79,5 +79,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "852aca183dfbda7e28ba961d74fb639736be76a3"
+  "gitHead": "808e4a252af8e24201e38a6ecbddb05b844891a2"
 }

package/src/theme/ApiExplorer/Body/index.tsx

@@ -237,8 +237,7 @@ function Body({
         try {
           // If the value is already valid JSON we shouldn't double encode the value
           JSON.parse(example.value);
-        }
-        catch (e) {
+        } catch (e) {
           body = JSON.stringify(example.value, null, 2);
         }
 

package/src/theme/ApiExplorer/FormFileUpload/_FormFileUpload.scss

@@ -13,7 +13,8 @@
 
   &:hover {
     border: 2px dashed var(--ifm-color-primary);
-    background: linear-gradient(
+    background:
+      linear-gradient(
         var(--openapi-dropzone-hover-shim),
         var(--openapi-dropzone-hover-shim)
       ),
@@ -38,7 +39,8 @@
   font-size: var(--ifm-code-font-size);
   border: 2px dashed var(--ifm-color-primary);
 
-  background: linear-gradient(
+  background:
+    linear-gradient(
       var(--openapi-dropzone-hover-shim),
       var(--openapi-dropzone-hover-shim)
     ),

package/src/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -45,8 +45,8 @@
   line-height: 1.5;
 
   transition-property: color, background, border-color, box-shadow;
-  transition-duration: 100ms, 100ms, 100ms,
-    var(--ifm-button-transition-duration);
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
   transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
 
   -webkit-user-select: none;
@@ -85,8 +85,8 @@
   padding: 0.5rem 1rem;
   font-size: 12px;
   transition-property: color, background, border-color, box-shadow;
-  transition-duration: 100ms, 100ms, 100ms,
-    var(--ifm-button-transition-duration);
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
   transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
   user-select: none;
   white-space: nowrap;

package/src/theme/ApiExplorer/Request/index.tsx

@@ -95,14 +95,37 @@ function Request({ item }: { item: ApiItem }) {
 
   const methods = useForm({ shouldFocusError: false });
 
+  const handleEventStream = async (res) => {
+    res.headers && dispatch(setHeaders(Object.fromEntries(res.headers)));
+    dispatch(setCode(res.status));
+
+    const reader = res.body.getReader();
+    const decoder = new TextDecoder();
+    let result = "";
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      result += decoder.decode(value, { stream: true });
+      dispatch(setResponse(result));
+    }
+  };
+
+  const handleResponse = async (res) => {
+    dispatch(setResponse(await res.text()));
+    dispatch(setCode(res.status));
+    res.headers && dispatch(setHeaders(Object.fromEntries(res.headers)));
+  };
+
   const onSubmit = async (data) => {
     dispatch(setResponse("Fetching..."));
     try {
       await delay(1200);
       const res = await makeRequest(postmanRequest, proxy, body);
-      dispatch(setResponse(await res.text()));
-      dispatch(setCode(res.status));
-      res.headers && dispatch(setHeaders(Object.fromEntries(res.headers)));
+      if (res.headers.get("content-type")?.includes("text/event-stream")) {
+        await handleEventStream(res);
+      } else {
+        await handleResponse(res);
+      }
     } catch (e: any) {
       console.log(e);
       dispatch(setResponse("Connection failed"));

package/src/theme/DiscriminatorTabs/index.tsx

@@ -210,7 +210,11 @@ function TabsComponent(props: TabProps): React.JSX.Element {
 export default function DiscriminatorTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
 
-  if (!props.length) return <React.Fragment />;
+  if (
+    !props.children ||
+    (Array.isArray(props.children) && props.children.length === 0)
+  )
+    return <React.Fragment />;
 
   return (
     <TabsComponent

package/src/theme/ParamsItem/index.tsx

@@ -70,9 +70,14 @@ function ParamsItem({ param, ...rest }: Props) {
   let schema = param.schema;
   let defaultValue: string | undefined;
 
-  if (!schema || !schema?.type) {
+  if (!schema) {
     schema = { type: "any" };
   }
+
+  if (!schema.type) {
+    schema.type = "any";
+  }
+
   if (schema) {
     if (schema.items) {
       defaultValue = schema.items.default;

package/src/theme/Schema/index.tsx

@@ -352,7 +352,8 @@ const DiscriminatorNode: React.FC<DiscriminatorNodeProps> = ({
     }
 
     const subProperties = subSchema.properties || mergedSubSchema.properties;
-    if (subProperties[discriminator.propertyName]) {
+    // Add a safeguard check to avoid referencing subProperties if it's undefined
+    if (subProperties && subProperties[discriminator.propertyName]) {
       if (schema.properties) {
         schema.properties![discriminator.propertyName] = {
           ...schema.properties![discriminator.propertyName],
@@ -840,6 +841,25 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
   );
 };
 
+function renderChildren(
+  schema: SchemaObject,
+  schemaType: "request" | "response"
+) {
+  return (
+    <>
+      {schema.oneOf && <AnyOneOf schema={schema} schemaType={schemaType} />}
+      {schema.anyOf && <AnyOneOf schema={schema} schemaType={schemaType} />}
+      {schema.properties && (
+        <Properties schema={schema} schemaType={schemaType} />
+      )}
+      {schema.additionalProperties && (
+        <AdditionalProperties schema={schema} schemaType={schemaType} />
+      )}
+      {schema.items && <Items schema={schema} schemaType={schemaType} />}
+    </>
+  );
+}
+
 const SchemaNode: React.FC<SchemaProps> = ({ schema, schemaType }) => {
   if (
     (schemaType === "request" && schema.readOnly) ||
@@ -888,10 +908,6 @@ const SchemaNode: React.FC<SchemaProps> = ({ schema, schemaType }) => {
     );
   }
 
-  if (schema.oneOf || schema.anyOf) {
-    return <AnyOneOf schema={schema} schemaType={schemaType} />;
-  }
-
   // Handle primitives
   if (
     schema.type &&
@@ -917,19 +933,7 @@ const SchemaNode: React.FC<SchemaProps> = ({ schema, schemaType }) => {
     );
   }
 
-  return (
-    <div>
-      {schema.oneOf && <AnyOneOf schema={schema} schemaType={schemaType} />}
-      {schema.anyOf && <AnyOneOf schema={schema} schemaType={schemaType} />}
-      {schema.properties && (
-        <Properties schema={schema} schemaType={schemaType} />
-      )}
-      {schema.additionalProperties && (
-        <AdditionalProperties schema={schema} schemaType={schemaType} />
-      )}
-      {schema.items && <Items schema={schema} schemaType={schemaType} />}
-    </div>
-  );
+  return renderChildren(schema, schemaType);
 };
 
 export default SchemaNode;