docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib-next/theme/ApiDemoPanel/ParamOptions/index.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React, { useState, useEffect } from "react";
 import { nanoid } from "@reduxjs/toolkit";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
@@ -13,28 +14,24 @@ import FormSelect from "./../FormSelect";
 import FormTextInput from "./../FormTextInput";
 import { setParam } from "./slice";
 import styles from "./styles.module.css";
-
 function ParamOption({ param }) {
   if (param.schema?.type === "array" && param.schema.items?.enum) {
     return <ParamMultiSelectFormItem param={param} />;
   }
-
   if (param.schema?.type === "array") {
     return <ParamArrayFormItem param={param} />;
   }
-
   if (param.schema?.enum) {
     return <ParamSelectFormItem param={param} />;
   }
-
   if (param.schema?.type === "boolean") {
     return <ParamBooleanFormItem param={param} />;
-  } // integer, number, string, int32, int64, float, double, object, byte, binary,
-  // date-time, date, password
+  }
 
+  // integer, number, string, int32, int64, float, double, object, byte, binary,
+  // date-time, date, password
   return <ParamTextFormItem param={param} />;
 }
-
 function ParamOptionWrapper({ param }) {
   return (
     <FormItem label={param.name} type={param.in} required={param.required}>
@@ -42,7 +39,6 @@ function ParamOptionWrapper({ param }) {
     </FormItem>
   );
 }
-
 function ParamOptions() {
   const [showOptional, setShowOptional] = useState(false);
   const pathParams = useTypedSelector((state) => state.params.path);
@@ -121,7 +117,6 @@ function ParamOptions() {
     </>
   );
 }
-
 function ArrayItem({ param, onChange }) {
   if (param.schema?.items?.type === "boolean") {
     return (
@@ -134,7 +129,6 @@ function ArrayItem({ param, onChange }) {
       />
     );
   }
-
   return (
     <FormTextInput
       placeholder={param.description || param.name}
@@ -144,11 +138,9 @@ function ArrayItem({ param, onChange }) {
     />
   );
 }
-
 function ParamArrayFormItem({ param }) {
   const [items, setItems] = useState([]);
   const dispatch = useTypedDispatch();
-
   function handleAddItem() {
     setItems((i) => [
       ...i,
@@ -157,34 +149,36 @@ function ParamArrayFormItem({ param }) {
       },
     ]);
   }
-
   useEffect(() => {
     const values = items.map((item) => item.value).filter((item) => !!item);
     dispatch(
-      setParam({ ...param, value: values.length > 0 ? values : undefined })
-    ); // eslint-disable-next-line react-hooks/exhaustive-deps
+      setParam({
+        ...param,
+        value: values.length > 0 ? values : undefined,
+      })
+    );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [items]);
-
   function handleDeleteItem(itemToDelete) {
     return () => {
       const newItems = items.filter((i) => i.id !== itemToDelete.id);
       setItems(newItems);
     };
   }
-
   function handleChangeItem(itemToUpdate) {
     return (value) => {
       const newItems = items.map((i) => {
         if (i.id === itemToUpdate.id) {
-          return { ...i, value: value };
+          return {
+            ...i,
+            value: value,
+          };
         }
-
         return i;
       });
       setItems(newItems);
     };
   }
-
   return (
     <>
       {items.map((item) => (
@@ -221,7 +215,6 @@ function ParamArrayFormItem({ param }) {
     </>
   );
 }
-
 function ParamSelectFormItem({ param }) {
   const dispatch = useTypedDispatch();
   const options = param.schema?.enum ?? [];
@@ -231,13 +224,15 @@ function ParamSelectFormItem({ param }) {
       onChange={(e) => {
         const val = e.target.value;
         dispatch(
-          setParam({ ...param, value: val === "---" ? undefined : val })
+          setParam({
+            ...param,
+            value: val === "---" ? undefined : val,
+          })
         );
       }}
     />
   );
 }
-
 function ParamBooleanFormItem({ param }) {
   const dispatch = useTypedDispatch();
   return (
@@ -246,13 +241,15 @@ function ParamBooleanFormItem({ param }) {
       onChange={(e) => {
         const val = e.target.value;
         dispatch(
-          setParam({ ...param, value: val === "---" ? undefined : val })
+          setParam({
+            ...param,
+            value: val === "---" ? undefined : val,
+          })
         );
       }}
     />
   );
 }
-
 function ParamMultiSelectFormItem({ param }) {
   const dispatch = useTypedDispatch();
   const options = param.schema?.items?.enum ?? [];
@@ -264,21 +261,29 @@ function ParamMultiSelectFormItem({ param }) {
           .call(e.target.options, (o) => o.selected)
           .map((o) => o.value);
         dispatch(
-          setParam({ ...param, value: values.length > 0 ? values : undefined })
+          setParam({
+            ...param,
+            value: values.length > 0 ? values : undefined,
+          })
         );
       }}
     />
   );
 }
-
 function ParamTextFormItem({ param }) {
   const dispatch = useTypedDispatch();
   return (
     <FormTextInput
       placeholder={param.description || param.name}
-      onChange={(e) => dispatch(setParam({ ...param, value: e.target.value }))}
+      onChange={(e) =>
+        dispatch(
+          setParam({
+            ...param,
+            value: e.target.value,
+          })
+        )
+      }
     />
   );
 }
-
 export default ParamOptions;

package/lib-next/theme/ApiDemoPanel/ParamOptions/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({

package/lib-next/theme/ApiDemoPanel/Request/index.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import sdk from "@paloaltonetworks/postman-collection";
@@ -15,7 +16,6 @@ import Execute from "../Execute";
 import ParamOptions from "../ParamOptions";
 import Server from "../Server";
 import styles from "./styles.module.css";
-
 function Request({ item }) {
   const response = useTypedSelector((state) => state.response.value);
   const { siteConfig } = useDocusaurusContext();
@@ -58,5 +58,4 @@ function Request({ item }) {
     </div>
   );
 }
-
 export default Request;

package/lib-next/theme/ApiDemoPanel/Response/index.js

@@ -4,11 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import CodeBlock from "@theme/CodeBlock";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
-import { clearResponse } from "./slice"; // TODO: We probably shouldn't attempt to format XML...
+import { clearResponse } from "./slice";
 
+// TODO: We probably shouldn't attempt to format XML...
 function formatXml(xml) {
   const tab = "  ";
   let formatted = "";
@@ -18,9 +20,7 @@ function formatXml(xml) {
       // decrease indent by one 'tab'
       indent = indent.substring(tab.length);
     }
-
     formatted += indent + "<" + node + ">\r\n";
-
     if (node.match(/^<?\w[^>]*[^/]$/)) {
       // increase indent
       indent += tab;
@@ -28,17 +28,13 @@ function formatXml(xml) {
   });
   return formatted.substring(1, formatted.length - 3);
 }
-
 function Response() {
   const response = useTypedSelector((state) => state.response.value);
   const dispatch = useTypedDispatch();
-
   if (response === undefined) {
     return null;
   }
-
   let prettyResponse = response;
-
   try {
     prettyResponse = JSON.stringify(JSON.parse(response), null, 2);
   } catch {
@@ -46,7 +42,6 @@ function Response() {
       prettyResponse = formatXml(response);
     }
   }
-
   return (
     <details className={`details__demo-panel`} open={true}>
       <summary>
@@ -66,5 +61,4 @@ function Response() {
     </details>
   );
 }
-
 export default Response;

package/lib-next/theme/ApiDemoPanel/Response/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({

package/lib-next/theme/ApiDemoPanel/SecuritySchemes/index.js

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import Link from "@docusaurus/Link";
 import { useTypedSelector } from "../../ApiItem/hooks";
-
 function SecuritySchemes(props) {
   const options = useTypedSelector((state) => state.auth.options);
   const selected = useTypedSelector((state) => state.auth.selected);
@@ -23,7 +23,6 @@ function SecuritySchemes(props) {
         const isApiKey = auth.type === "apiKey";
         const isBearer = auth.type === "http" && auth.key === "Bearer";
         const isOauth2 = auth.type === "oauth2";
-
         if (isApiKey || isBearer) {
           return (
             <React.Fragment key={auth.key}>
@@ -43,7 +42,6 @@ function SecuritySchemes(props) {
             </React.Fragment>
           );
         }
-
         if (isOauth2) {
           return (
             <React.Fragment key={selected}>
@@ -67,11 +65,9 @@ function SecuritySchemes(props) {
             </React.Fragment>
           );
         }
-
         return undefined;
       })}
     </details>
   );
 }
-
 export default SecuritySchemes;

package/lib-next/theme/ApiDemoPanel/Server/index.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React, { useState } from "react";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FloatingButton from "../FloatingButton";
@@ -12,41 +13,34 @@ import FormSelect from "./../FormSelect";
 import FormTextInput from "./../FormTextInput";
 import { setServer, setServerVariable } from "./slice";
 import styles from "./styles.module.css";
-
 function Server() {
   const [isEditing, setIsEditing] = useState(false);
   const value = useTypedSelector((state) => state.server.value);
   const options = useTypedSelector((state) => state.server.options);
   const dispatch = useTypedDispatch();
-
   if (options.length <= 0) {
     return null;
   }
-
   if (options.length < 1 && value?.variables === undefined) {
     return null;
   }
-
   if (!value) {
     const defaultOption = options[0];
     dispatch(setServer(JSON.stringify(defaultOption)));
-  } // Default to first option when existing server state is mismatched
+  }
 
+  // Default to first option when existing server state is mismatched
   if (value) {
     const urlExists = options.find((s) => s.url === value.url);
-
     if (!urlExists) {
       const defaultOption = options[0];
       dispatch(setServer(JSON.stringify(defaultOption)));
     }
   }
-
   if (!isEditing) {
     let url = "";
-
     if (value) {
       url = value.url.replace(/\/$/, "");
-
       if (value.variables) {
         Object.keys(value.variables).forEach((variable) => {
           url = url.replace(
@@ -56,7 +50,6 @@ function Server() {
         });
       }
     }
-
     return (
       <FloatingButton onClick={() => setIsEditing(true)} label="Edit">
         <FormItem label="Base URL">
@@ -72,7 +65,6 @@ function Server() {
       </FloatingButton>
     );
   }
-
   return (
     <div className={styles.optionsPanel}>
       <FloatingButton onClick={() => setIsEditing(false)} label="Hide">
@@ -114,7 +106,6 @@ function Server() {
                 </FormItem>
               );
             }
-
             return (
               <FormItem label={key}>
                 <FormTextInput
@@ -138,5 +129,4 @@ function Server() {
     </div>
   );
 }
-
 export default Server;

package/lib-next/theme/ApiDemoPanel/Server/slice.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import { createSlice } from "@reduxjs/toolkit";
 const initialState = {};
 export const slice = createSlice({