docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib-next/theme/ApiDemoPanel/Curl/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 useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import codegen from "@paloaltonetworks/postman-code-generators";
@@ -87,7 +88,6 @@ export const languageSet = [
     variant: "cURL",
   },
 ];
-
 function CodeTab({ children, hidden, className, onClick }) {
   return (
     <div
@@ -101,9 +101,9 @@ function CodeTab({ children, hidden, className, onClick }) {
     </div>
   );
 }
-
 function Curl({ postman, codeSamples }) {
   // TODO: match theme for vscode.
+
   const { siteConfig } = useDocusaurusContext();
   const contentType = useTypedSelector((state) => state.contentType.value);
   const accept = useTypedSelector((state) => state.accept.value);
@@ -113,8 +113,9 @@ function Curl({ postman, codeSamples }) {
   const queryParams = useTypedSelector((state) => state.params.query);
   const cookieParams = useTypedSelector((state) => state.params.cookie);
   const headerParams = useTypedSelector((state) => state.params.header);
-  const auth = useTypedSelector((state) => state.auth); // TODO
+  const auth = useTypedSelector((state) => state.auth);
 
+  // TODO
   const langs = [
     ...(siteConfig?.themeConfig?.languageTabs ?? languageSet),
     ...codeSamples,
@@ -127,7 +128,6 @@ function Curl({ postman, codeSamples }) {
     if (langs.length === 1) {
       return langs[0];
     }
-
     return defaultLang[0] ?? langs[0];
   });
   const [codeText, setCodeText] = useState("");
@@ -153,7 +153,6 @@ function Curl({ postman, codeSamples }) {
           if (error) {
             return;
           }
-
           setCodeText(snippet);
         }
       );
@@ -162,11 +161,15 @@ function Curl({ postman, codeSamples }) {
     } else if (language && !language.options) {
       const langSource = languageSet.filter(
         (lang) => lang.language === language.language
-      ); // Merges user-defined language with default languageSet
+      );
+
+      // Merges user-defined language with default languageSet
       // This allows users to define only the minimal properties necessary in languageTabs
       // User-defined properties should override languageSet properties
-
-      const mergedLanguage = { ...langSource[0], ...language };
+      const mergedLanguage = {
+        ...langSource[0],
+        ...language,
+      };
       const postmanRequest = buildPostmanRequest(postman, {
         queryParams,
         pathParams,
@@ -187,7 +190,6 @@ function Curl({ postman, codeSamples }) {
           if (error) {
             return;
           }
-
           setCodeText(snippet);
         }
       );
@@ -207,11 +209,9 @@ function Curl({ postman, codeSamples }) {
     server,
     auth,
   ]);
-
   if (language === undefined) {
     return null;
   }
-
   return (
     <>
       <CodeTabs groupId="code-samples" action={setLanguage}>
@@ -237,5 +237,4 @@ function Curl({ postman, codeSamples }) {
     </>
   );
 }
-
 export default Curl;

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

@@ -4,13 +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 Modal from "react-modal";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import { setResponse } from "../Response/slice";
 import buildPostmanRequest from "./../buildPostmanRequest";
 import makeRequest from "./makeRequest";
-
 function validateRequest(params) {
   for (let paramList of Object.values(params)) {
     for (let param of paramList) {
@@ -19,10 +19,8 @@ function validateRequest(params) {
       }
     }
   }
-
   return true;
 }
-
 function Execute({ postman, proxy }) {
   const pathParams = useTypedSelector((state) => state.params.path);
   const queryParams = useTypedSelector((state) => state.params.query);
@@ -47,26 +45,21 @@ function Execute({ postman, proxy }) {
     server,
     auth,
   });
-
   const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-
   function openModal() {
     setIsOpen(true);
   }
-
   function closeModal() {
     setIsOpen(false);
   }
-
   function acceptAgreement() {
     setIsOpen(false);
     setAgreementAccepted(true);
     sessionStorage.setItem("agreement-ack", "true");
   }
-
-  const [modalIsOpen, setIsOpen] = React.useState(false); // Set the following as default value to persist to session and enable modal
+  const [modalIsOpen, setIsOpen] = React.useState(false);
+  // Set the following as default value to persist to session and enable modal
   // sessionStorage.getItem("agreement-ack") === "true"
-
   const [agreementAccepted, setAgreementAccepted] = React.useState(true);
   const customStyles = {
     overlay: {
@@ -87,15 +80,20 @@ function Execute({ postman, proxy }) {
       maxWidth: "550px",
     },
   };
-
   if (agreementAccepted) {
     return (
       <button
         className="button button--sm button--secondary"
         disabled={!isValidRequest}
+        style={
+          !isValidRequest
+            ? {
+                pointerEvents: "all",
+              }
+            : {}
+        }
         onClick={async () => {
           dispatch(setResponse("Fetching..."));
-
           try {
             await delay(1200);
             const res = await makeRequest(postmanRequest, proxy, body);
@@ -166,5 +164,4 @@ function Execute({ postman, proxy }) {
     );
   }
 }
-
 export default Execute;

package/lib-next/theme/ApiDemoPanel/Execute/makeRequest.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.
  * ========================================================================== */
+
 function fetchWithtimeout(url, options, timeout = 5000) {
   return Promise.race([
     fetch(url, options),
@@ -12,42 +13,37 @@ function fetchWithtimeout(url, options, timeout = 5000) {
     ),
   ]);
 }
-
 async function loadImage(content) {
   return new Promise((accept, reject) => {
     const reader = new FileReader();
-
     reader.onabort = () => {
       console.log("file reading was aborted");
       reject();
     };
-
     reader.onerror = () => {
       console.log("file reading has failed");
       reject();
     };
-
     reader.onload = () => {
       // Do whatever you want with the file contents
       const binaryStr = reader.result;
       accept(binaryStr);
     };
-
     reader.readAsArrayBuffer(content);
   });
 }
-
 async function makeRequest(request, proxy, _body) {
   const headers = request.toJSON().header;
   let myHeaders = new Headers();
-
   if (headers) {
     headers.forEach((header) => {
       if (header.key && header.value) {
         myHeaders.append(header.key, header.value);
       }
     });
-  } // The following code handles multiple files in the same formdata param.
+  }
+
+  // The following code handles multiple files in the same formdata param.
   // It removes the form data params where the src property is an array of filepath strings
   // Splits that array into different form data params with src set as a single filepath string
   // TODO:
@@ -120,12 +116,10 @@ async function makeRequest(request, proxy, _body) {
 
   const body = request.body?.toJSON();
   let myBody = undefined;
-
   if (body !== undefined && Object.keys(body).length > 0) {
     switch (body.mode) {
       case "urlencoded": {
         myBody = new URLSearchParams();
-
         if (Array.isArray(body.urlencoded)) {
           for (const data of body.urlencoded) {
             if (data.key && data.value) {
@@ -133,18 +127,14 @@ async function makeRequest(request, proxy, _body) {
             }
           }
         }
-
         break;
       }
-
       case "raw": {
         myBody = (body.raw ?? "").toString();
         break;
       }
-
       case "formdata": {
         myBody = new FormData();
-
         if (Array.isArray(body.formdata)) {
           for (const data of body.formdata) {
             if (data.key && data.value) {
@@ -152,39 +142,31 @@ async function makeRequest(request, proxy, _body) {
             }
           }
         }
-
         break;
       }
-
       case "file": {
         if (_body.type === "raw" && _body.content?.type === "file") {
           myBody = await loadImage(_body.content.value.content);
         }
-
         break;
       }
-
       default:
         break;
     }
   }
-
   const requestOptions = {
     method: request.method,
     headers: myHeaders,
     body: myBody,
   };
   let finalUrl = request.url.toString();
-
   if (proxy) {
     // Ensure the proxy ends with a slash.
     let normalizedProxy = proxy.replace(/\/$/, "") + "/";
     finalUrl = normalizedProxy + request.url.toString();
   }
-
   return await fetchWithtimeout(finalUrl, requestOptions).then((response) => {
     return response.text();
   });
 }
-
 export default makeRequest;

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

@@ -4,19 +4,16 @@
  * 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 fileSaver from "file-saver";
-
 const saveFile = (url) => {
   let fileName;
-
   if (url.endsWith("json") || url.endsWith("yaml") || url.endsWith("yml")) {
     fileName = url.substring(url.lastIndexOf("/") + 1);
   }
-
   fileSaver.saveAs(url, fileName ? fileName : "openapi.txt");
 };
-
 function Export({ url, proxy }) {
   return (
     <div
@@ -45,5 +42,4 @@ function Export({ url, proxy }) {
     </div>
   );
 }
-
 export default Export;

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

@@ -4,9 +4,9 @@
  * 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 styles from "./styles.module.css";
-
 function FloatingButton({ label, onClick, children }) {
   return (
     <div tabIndex={0} className={styles.floatingButton}>
@@ -19,5 +19,4 @@ function FloatingButton({ label, onClick, children }) {
     </div>
   );
 }
-
 export default FloatingButton;

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

@@ -4,11 +4,11 @@
  * 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 MagicDropzone from "react-magic-dropzone";
 import FloatingButton from "../FloatingButton";
 import styles from "./styles.module.css";
-
 function RenderPreview({ file }) {
   switch (file.type) {
     case "image/png":
@@ -24,7 +24,6 @@ function RenderPreview({ file }) {
           alt=""
         />
       );
-
     default:
       return (
         <div
@@ -58,22 +57,18 @@ function RenderPreview({ file }) {
       );
   }
 }
-
 function FormFileUpload({ placeholder, onChange }) {
   const [hover, setHover] = useState(false);
   const [file, setFile] = useState();
-
   function setAndNotifyFile(file) {
     setFile(file);
     onChange?.(file);
   }
-
   function handleDrop(accepted) {
     const [file] = accepted;
     setAndNotifyFile(file);
     setHover(false);
   }
-
   return (
     <FloatingButton>
       <MagicDropzone
@@ -108,5 +103,4 @@ function FormFileUpload({ placeholder, onChange }) {
     </FloatingButton>
   );
 }
-
 export default FormFileUpload;

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

@@ -4,9 +4,9 @@
  * 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 styles from "./styles.module.css";
-
 function FormItem({ label, type, required, children }) {
   return (
     <div className={styles.formItem}>
@@ -33,5 +33,4 @@ function FormItem({ label, type, required, children }) {
     </div>
   );
 }
-
 export default FormItem;

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

@@ -4,16 +4,14 @@
  * 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 styles from "./styles.module.css";
-
 function FormMultiSelect({ value, options, onChange }) {
   if (options.length === 0) {
     return null;
   }
-
   let height;
-
   if (options.length < 6) {
     const selectPadding = 12 * 2;
     const rawHeight = options.length * 29;
@@ -23,7 +21,6 @@ function FormMultiSelect({ value, options, onChange }) {
     height =
       rawHeight + innerMargins + outerMargins + selectPadding + mysteryScroll;
   }
-
   return (
     <select
       style={{
@@ -45,5 +42,4 @@ function FormMultiSelect({ value, options, onChange }) {
     </select>
   );
 }
-
 export default FormMultiSelect;

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

@@ -4,14 +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 styles from "./styles.module.css";
-
 function FormSelect({ value, options, onChange }) {
   if (!Array.isArray(options) || options.length === 0) {
     return null;
   }
-
   return (
     <select className={styles.selectInput} value={value} onChange={onChange}>
       {options.map((option) => {
@@ -24,5 +23,4 @@ function FormSelect({ value, options, onChange }) {
     </select>
   );
 }
-
 export default FormSelect;

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

@@ -4,9 +4,9 @@
  * 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 styles from "./styles.module.css";
-
 function FormTextInput({ value, placeholder, password, onChange }) {
   placeholder = placeholder?.split("\n")[0];
   return (
@@ -21,5 +21,4 @@ function FormTextInput({ value, placeholder, password, onChange }) {
     />
   );
 }
-
 export default FormTextInput;

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

@@ -4,24 +4,24 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React, { useEffect, useState } from "react";
 import { usePrismTheme } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import { LiveProvider, LiveEditor, withLive } from "react-live";
 import { setStringRawBody } from "../Body/slice";
 import styles from "./styles.module.css";
-
 function Live({ onEdit }) {
   const isBrowser = useIsBrowser();
-  const [editorDisabled, setEditorDisabled] = useState(false); // TODO: Temporary solution for disabling tab key
+  const [editorDisabled, setEditorDisabled] = useState(false);
 
+  // TODO: Temporary solution for disabling tab key
   const handleKeydown = (event) => {
     if (event.key === "Tab") {
       event.preventDefault();
       setEditorDisabled(true);
     }
   };
-
   return (
     <div onClick={() => setEditorDisabled(false)}>
       <LiveEditor
@@ -34,9 +34,7 @@ function Live({ onEdit }) {
     </div>
   );
 }
-
 const LiveComponent = withLive(Live);
-
 function App({ children, transformCode, value, language, action, ...props }) {
   const prismTheme = usePrismTheme();
   const [code, setCode] = React.useState(children);
@@ -57,6 +55,5 @@ function App({ children, transformCode, value, language, action, ...props }) {
     </div>
   );
 }
-
 const LiveApp = withLive(App);
 export default LiveApp;

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

@@ -4,36 +4,29 @@
  * 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";
 const methodStyle = {
   borderRadius: "var(--ifm-global-radius)",
 };
-
 function colorForMethod(method) {
   switch (method.toLowerCase()) {
     case "get":
       return "primary";
-
     case "post":
       return "success";
-
     case "delete":
       return "danger";
-
     case "put":
       return "info";
-
     case "patch":
       return "warning";
-
     case "head":
       return "secondary";
-
     default:
       return undefined;
   }
 }
-
 function MethodEndpoint({ method, path }) {
   return (
     <pre
@@ -52,5 +45,4 @@ function MethodEndpoint({ method, path }) {
     </pre>
   );
 }
-
 export default MethodEndpoint;