docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib-next/theme/ApiDemoPanel/buildPostmanRequest.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 sdk from "@paloaltonetworks/postman-collection";
 import cloneDeep from "lodash/cloneDeep";
-
 function setQueryParams(postman, queryParams) {
   postman.url.query.clear();
   const qp = queryParams
@@ -14,14 +14,14 @@ function setQueryParams(postman, queryParams) {
       if (!param.value) {
         return undefined;
       }
-
       if (Array.isArray(param.value)) {
         return new sdk.QueryParam({
           key: param.name,
           value: param.value.join(","),
         });
-      } // Parameter allows empty value: "/hello?extended"
+      }
 
+      // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
         if (param.value === "true") {
           return new sdk.QueryParam({
@@ -29,22 +29,18 @@ function setQueryParams(postman, queryParams) {
             value: null,
           });
         }
-
         return undefined;
       }
-
       return new sdk.QueryParam({
         key: param.name,
         value: param.value,
       });
     })
     .filter((item) => item !== undefined);
-
   if (qp.length > 0) {
     postman.addQueryParams(qp);
   }
 }
-
 function setPathParams(postman, queryParams) {
   const source = queryParams.map((param) => {
     return new sdk.Variable({
@@ -54,7 +50,6 @@ function setPathParams(postman, queryParams) {
   });
   postman.url.variables.assimilate(source, false);
 }
-
 function buildCookie(cookieParams) {
   const cookies = cookieParams
     .map((param) => {
@@ -67,31 +62,26 @@ function buildCookie(cookieParams) {
           value: param.value,
         });
       }
-
       return undefined;
     })
     .filter((item) => item !== undefined);
   const list = new sdk.CookieList(null, cookies);
   return list.toString();
 }
-
 function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
   postman.headers.clear();
-
   if (contentType) {
     postman.addHeader({
       key: "Content-Type",
       value: contentType,
     });
   }
-
   if (accept) {
     postman.addHeader({
       key: "Accept",
       value: accept,
     });
   }
-
   headerParams.forEach((param) => {
     if (param.value && !Array.isArray(param.value)) {
       postman.addHeader({
@@ -103,25 +93,23 @@ function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
   other.forEach((header) => {
     postman.addHeader(header);
   });
-
   if (cookie) {
     postman.addHeader({
       key: "Cookie",
       value: cookie,
     });
   }
-} // TODO: this is all a bit hacky
+}
 
+// TODO: this is all a bit hacky
 function setBody(clonedPostman, body) {
   if (clonedPostman.body === undefined) {
     return;
   }
-
   if (body.type === "empty") {
     clonedPostman.body = undefined;
     return;
   }
-
   if (body.type === "raw" && body.content?.type === "file") {
     // treat it like file.
     clonedPostman.body.mode = "file";
@@ -130,7 +118,6 @@ function setBody(clonedPostman, body) {
     };
     return;
   }
-
   switch (clonedPostman.body.mode) {
     case "raw": {
       // check file even though it should already be set from above
@@ -138,21 +125,17 @@ function setBody(clonedPostman, body) {
         clonedPostman.body = undefined;
         return;
       }
-
       clonedPostman.body.raw = body.content?.value ?? "";
       return;
     }
-
     case "formdata": {
       clonedPostman.body.formdata?.clear();
-
       if (body.type !== "form") {
         // treat it like raw.
         clonedPostman.body.mode = "raw";
         clonedPostman.body.raw = `${body.content?.value}`;
         return;
       }
-
       const params = Object.entries(body.content)
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
@@ -162,7 +145,6 @@ function setBody(clonedPostman, body) {
               ...content,
             });
           }
-
           return new sdk.FormParam({
             key: key,
             value: content.value,
@@ -171,17 +153,14 @@ function setBody(clonedPostman, body) {
       clonedPostman.body.formdata?.assimilate(params, false);
       return;
     }
-
     case "urlencoded": {
       clonedPostman.body.urlencoded?.clear();
-
       if (body.type !== "form") {
         // treat it like raw.
         clonedPostman.body.mode = "raw";
         clonedPostman.body.raw = `${body.content?.value}`;
         return;
       }
-
       const params = Object.entries(body.content)
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
@@ -191,18 +170,18 @@ function setBody(clonedPostman, body) {
               value: content.value,
             });
           }
-
           return undefined;
         })
         .filter((item) => item !== undefined);
       clonedPostman.body.urlencoded?.assimilate(params, false);
       return;
     }
-
     default:
       return;
   }
-} // TODO: finish these types
+}
+
+// TODO: finish these types
 
 function buildPostmanRequest(
   postman,
@@ -221,35 +200,28 @@ function buildPostmanRequest(
   const clonedPostman = cloneDeep(postman);
   clonedPostman.url.protocol = undefined;
   clonedPostman.url.host = [window.location.origin];
-
   if (server) {
     let url = server.url.replace(/\/$/, "");
     const variables = server.variables;
-
     if (variables) {
       Object.keys(variables).forEach((variable) => {
         url = url.replace(`{${variable}}`, variables[variable].default);
       });
     }
-
     clonedPostman.url.host = [url];
   }
-
   setQueryParams(clonedPostman, queryParams);
   setPathParams(clonedPostman, pathParams);
   const cookie = buildCookie(cookieParams);
   let otherHeaders = [];
   let selectedAuth = [];
-
   if (auth.selected !== undefined) {
     selectedAuth = auth.options[auth.selected];
   }
-
   for (const a of selectedAuth) {
     // Bearer Auth
     if (a.type === "http" && a.scheme === "bearer") {
       const { token } = auth.data[a.key];
-
       if (token === undefined) {
         otherHeaders.push({
           key: "Authorization",
@@ -257,21 +229,17 @@ function buildPostmanRequest(
         });
         continue;
       }
-
       otherHeaders.push({
         key: "Authorization",
         value: `Bearer ${token}`,
       });
       continue;
     }
-
     if (a.type === "oauth2") {
       let token;
-
       if (auth.data[a.key]) {
         token = auth.data[a.key].token;
       }
-
       if (token === undefined) {
         otherHeaders.push({
           key: "Authorization",
@@ -279,31 +247,29 @@ function buildPostmanRequest(
         });
         continue;
       }
-
       otherHeaders.push({
         key: "Authorization",
         value: `Bearer ${token}`,
       });
       continue;
-    } // Basic Auth
+    }
 
+    // Basic Auth
     if (a.type === "http" && a.scheme === "basic") {
       const { username, password } = auth.data[a.key];
-
       if (username === undefined || password === undefined) {
         continue;
       }
-
       otherHeaders.push({
         key: "Authorization",
         value: `Basic ${window.btoa(`${username}:${password}`)}`,
       });
       continue;
-    } // API Key
+    }
 
+    // API Key
     if (a.type === "apiKey" && a.in === "header") {
       const { apiKey } = auth.data[a.key];
-
       if (apiKey === undefined) {
         otherHeaders.push({
           key: a.name,
@@ -311,7 +277,6 @@ function buildPostmanRequest(
         });
         continue;
       }
-
       otherHeaders.push({
         key: a.name,
         value: apiKey,
@@ -319,7 +284,6 @@ function buildPostmanRequest(
       continue;
     }
   }
-
   setHeaders(
     clonedPostman,
     contentType,
@@ -331,5 +295,4 @@ function buildPostmanRequest(
   setBody(clonedPostman, body);
   return clonedPostman;
 }
-
 export default buildPostmanRequest;

package/lib-next/theme/ApiDemoPanel/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 sdk from "@paloaltonetworks/postman-collection";
 import Curl from "./Curl";
@@ -11,13 +12,11 @@ import MethodEndpoint from "./MethodEndpoint";
 import Request from "./Request";
 import Response from "./Response";
 import SecuritySchemes from "./SecuritySchemes";
-import styles from "./styles.module.css";
-
 function ApiDemoPanel({ item, infoPath }) {
   const postman = new sdk.Request(item.postman);
   const { path, method } = item;
   return (
-    <div className={styles.apiDemoPanelContainer}>
+    <div>
       <MethodEndpoint method={method} path={path} />
       <SecuritySchemes infoPath={infoPath} />
       <Request item={item} />
@@ -26,5 +25,4 @@ function ApiDemoPanel({ item, infoPath }) {
     </div>
   );
 }
-
 export default ApiDemoPanel;

package/lib-next/theme/ApiDemoPanel/persistanceMiddleware.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 { setAuthData, setSelectedAuth } from "./Authorization/slice";
 import { createStorage, hashArray } from "./storage-utils";
 export function createPersistanceMiddleware(options) {
@@ -11,7 +12,6 @@ export function createPersistanceMiddleware(options) {
     const result = next(action);
     const state = storeAPI.getState();
     const storage = createStorage("sessionStorage");
-
     if (action.type === setAuthData.type) {
       for (const [key, value] of Object.entries(state.auth.data)) {
         if (Object.values(value).filter(Boolean).length > 0) {
@@ -21,7 +21,6 @@ export function createPersistanceMiddleware(options) {
         }
       }
     }
-
     if (action.type === setSelectedAuth.type) {
       if (state.auth.selected) {
         storage.setItem(
@@ -29,10 +28,13 @@ export function createPersistanceMiddleware(options) {
           state.auth.selected
         );
       }
-    } // TODO: determine way to rehydrate without flashing
+    }
+
+    // TODO: determine way to rehydrate without flashing
     // if (action.type === "contentType/setContentType") {
     //   storage.setItem("contentType", action.payload);
     // }
+
     // if (action.type === "accept/setAccept") {
     //   storage.setItem("accept", action.payload);
     // }
@@ -40,7 +42,6 @@ export function createPersistanceMiddleware(options) {
     if (action.type === "server/setServer") {
       storage.setItem("server", action.payload);
     }
-
     if (action.type === "server/setServerVariable") {
       const server = storage.getItem("server") ?? "{}";
       const variables = JSON.parse(action.payload);
@@ -48,9 +49,7 @@ export function createPersistanceMiddleware(options) {
       serverObject.variables[variables.key].default = variables.value;
       storage.setItem("server", JSON.stringify(serverObject));
     }
-
     return result;
   };
-
   return persistanceMiddleware;
 }

package/lib-next/theme/ApiDemoPanel/storage-utils.js

@@ -4,12 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import crypto from "crypto-js";
 export function hashArray(arr) {
   function hash(message) {
     return crypto.SHA1(message).toString();
   }
-
   const hashed = arr.map((item) => hash(item));
   hashed.sort();
   const res = hashed.join();
@@ -26,10 +26,8 @@ export function createStorage(persistance) {
       length: 0,
     };
   }
-
   if (persistance === "sessionStorage") {
     return sessionStorage;
   }
-
   return localStorage;
 }

package/lib-next/theme/ApiItem/Layout/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 from "react";
-import { useWindowSize } from "@docusaurus/theme-common"; // @ts-ignore
 
+import React from "react";
+import { useWindowSize } from "@docusaurus/theme-common";
 import { useDoc } from "@docusaurus/theme-common/internal";
 import DocBreadcrumbs from "@theme/DocBreadcrumbs";
+import DocItemContent from "@theme/DocItem/Content";
+import DocItemFooter from "@theme/DocItem/Footer";
+import DocItemPaginator from "@theme/DocItem/Paginator";
+import DocItemTOCDesktop from "@theme/DocItem/TOC/Desktop";
+import DocItemTOCMobile from "@theme/DocItem/TOC/Mobile";
 import DocVersionBadge from "@theme/DocVersionBadge";
 import DocVersionBanner from "@theme/DocVersionBanner";
 import clsx from "clsx";
-import DocItemContent from "../Content";
-import DocItemFooter from "../Footer";
-import DocItemPaginator from "../Paginator";
-import DocItemTOCDesktop from "../TOC/Desktop";
-import DocItemTOCMobile from "../TOC/Mobile";
 import styles from "./styles.module.css";
+
 /**
  * Decide if the toc should be rendered, on mobile or desktop viewports
  */
-
 function useDocTOC() {
   const { frontMatter, toc } = useDoc();
   const windowSize = useWindowSize();
@@ -38,7 +38,6 @@ function useDocTOC() {
     desktop,
   };
 }
-
 export default function DocItemLayout({ children }) {
   const docTOC = useDocTOC();
   const {