docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib/theme/ApiDemoPanel/buildPostmanRequest.js

@@ -4,34 +4,30 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _postmanCollection = _interopRequireDefault(require("@paloaltonetworks/postman-collection"));
-
 var _cloneDeep = _interopRequireDefault(require("lodash/cloneDeep"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 function setQueryParams(postman, queryParams) {
   postman.url.query.clear();
   const qp = queryParams.map(param => {
     if (!param.value) {
       return undefined;
     }
-
     if (Array.isArray(param.value)) {
       return new _postmanCollection.default.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 _postmanCollection.default.QueryParam({
@@ -39,21 +35,17 @@ function setQueryParams(postman, queryParams) {
           value: null
         });
       }
-
       return undefined;
     }
-
     return new _postmanCollection.default.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 _postmanCollection.default.Variable({
@@ -63,7 +55,6 @@ function setPathParams(postman, queryParams) {
   });
   postman.url.variables.assimilate(source, false);
 }
-
 function buildCookie(cookieParams) {
   const cookies = cookieParams.map(param => {
     if (param.value && !Array.isArray(param.value)) {
@@ -75,30 +66,25 @@ function buildCookie(cookieParams) {
         value: param.value
       });
     }
-
     return undefined;
   }).filter(item => item !== undefined);
   const list = new _postmanCollection.default.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({
@@ -110,28 +96,24 @@ 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) {
   var _body$content;
-
   if (clonedPostman.body === undefined) {
     return;
   }
-
   if (body.type === "empty") {
     clonedPostman.body = undefined;
     return;
   }
-
   if (body.type === "raw" && ((_body$content = body.content) === null || _body$content === void 0 ? void 0 : _body$content.type) === "file") {
     // treat it like file.
     clonedPostman.body.mode = "file";
@@ -140,37 +122,29 @@ function setBody(clonedPostman, body) {
     };
     return;
   }
-
   switch (clonedPostman.body.mode) {
     case "raw":
       {
         var _body$content2, _body$content$value, _body$content3;
-
         // check file even though it should already be set from above
         if (body.type !== "raw" || ((_body$content2 = body.content) === null || _body$content2 === void 0 ? void 0 : _body$content2.type) === "file") {
           clonedPostman.body = undefined;
           return;
         }
-
         clonedPostman.body.raw = (_body$content$value = (_body$content3 = body.content) === null || _body$content3 === void 0 ? void 0 : _body$content3.value) !== null && _body$content$value !== void 0 ? _body$content$value : "";
         return;
       }
-
     case "formdata":
       {
         var _clonedPostman$body$f, _clonedPostman$body$f2;
-
         (_clonedPostman$body$f = clonedPostman.body.formdata) === null || _clonedPostman$body$f === void 0 ? void 0 : _clonedPostman$body$f.clear();
-
         if (body.type !== "form") {
           var _body$content4;
-
           // treat it like raw.
           clonedPostman.body.mode = "raw";
           clonedPostman.body.raw = `${(_body$content4 = body.content) === null || _body$content4 === void 0 ? void 0 : _body$content4.value}`;
           return;
         }
-
         const params = Object.entries(body.content).filter(entry => !!entry[1]).map(([key, content]) => {
           if (content.type === "file") {
             return new _postmanCollection.default.FormParam({
@@ -178,7 +152,6 @@ function setBody(clonedPostman, body) {
               ...content
             });
           }
-
           return new _postmanCollection.default.FormParam({
             key: key,
             value: content.value
@@ -187,22 +160,17 @@ function setBody(clonedPostman, body) {
         (_clonedPostman$body$f2 = clonedPostman.body.formdata) === null || _clonedPostman$body$f2 === void 0 ? void 0 : _clonedPostman$body$f2.assimilate(params, false);
         return;
       }
-
     case "urlencoded":
       {
         var _clonedPostman$body$u, _clonedPostman$body$u2;
-
         (_clonedPostman$body$u = clonedPostman.body.urlencoded) === null || _clonedPostman$body$u === void 0 ? void 0 : _clonedPostman$body$u.clear();
-
         if (body.type !== "form") {
           var _body$content5;
-
           // treat it like raw.
           clonedPostman.body.mode = "raw";
           clonedPostman.body.raw = `${(_body$content5 = body.content) === null || _body$content5 === void 0 ? void 0 : _body$content5.value}`;
           return;
         }
-
         const params = Object.entries(body.content).filter(entry => !!entry[1]).map(([key, content]) => {
           if (content.type !== "file" && content.value) {
             return new _postmanCollection.default.QueryParam({
@@ -210,18 +178,17 @@ function setBody(clonedPostman, body) {
               value: content.value
             });
           }
-
           return undefined;
         }).filter(item => item !== undefined);
         (_clonedPostman$body$u2 = clonedPostman.body.urlencoded) === null || _clonedPostman$body$u2 === void 0 ? void 0 : _clonedPostman$body$u2.assimilate(params, false);
         return;
       }
-
     default:
       return;
   }
-} // TODO: finish these types
+}
 
+// TODO: finish these types
 
 function buildPostmanRequest(postman, {
   queryParams,
@@ -237,37 +204,30 @@ function buildPostmanRequest(postman, {
   const clonedPostman = (0, _cloneDeep.default)(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",
@@ -275,21 +235,17 @@ function buildPostmanRequest(postman, {
         });
         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",
@@ -297,38 +253,34 @@ function buildPostmanRequest(postman, {
         });
         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,
@@ -336,7 +288,6 @@ function buildPostmanRequest(postman, {
         });
         continue;
       }
-
       otherHeaders.push({
         key: a.name,
         value: apiKey
@@ -344,11 +295,9 @@ function buildPostmanRequest(postman, {
       continue;
     }
   }
-
   setHeaders(clonedPostman, contentType, accept, cookie, headerParams, otherHeaders);
   setBody(clonedPostman, body);
   return clonedPostman;
 }
-
 var _default = buildPostmanRequest;
 exports.default = _default;

package/lib/theme/ApiDemoPanel/index.js

@@ -4,43 +4,32 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _postmanCollection = _interopRequireDefault(require("@paloaltonetworks/postman-collection"));
-
 var _Curl = _interopRequireDefault(require("./Curl"));
-
 var _MethodEndpoint = _interopRequireDefault(require("./MethodEndpoint"));
-
 var _Request = _interopRequireDefault(require("./Request"));
-
 var _Response = _interopRequireDefault(require("./Response"));
-
 var _SecuritySchemes = _interopRequireDefault(require("./SecuritySchemes"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 function ApiDemoPanel({
   item,
   infoPath
 }) {
   var _xCodeSamples;
-
   const postman = new _postmanCollection.default.Request(item.postman);
   const {
     path,
     method
   } = item;
-  return <div className={_stylesModule.default.apiDemoPanelContainer}>
+  return <div>
       <_MethodEndpoint.default method={method} path={path} />
       <_SecuritySchemes.default infoPath={infoPath} />
       <_Request.default item={item} />
@@ -48,6 +37,5 @@ function ApiDemoPanel({
       <_Curl.default postman={postman} codeSamples={(_xCodeSamples = item["x-code-samples"]) !== null && _xCodeSamples !== void 0 ? _xCodeSamples : []} />
     </div>;
 }
-
 var _default = ApiDemoPanel;
 exports.default = _default;

package/lib/theme/ApiDemoPanel/persistanceMiddleware.js

@@ -4,23 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createPersistanceMiddleware = createPersistanceMiddleware;
-
 var _slice = require("./Authorization/slice");
-
 var _storageUtils = require("./storage-utils");
-
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 function createPersistanceMiddleware(options) {
   const persistanceMiddleware = storeAPI => next => action => {
     const result = next(action);
     const state = storeAPI.getState();
     const storage = (0, _storageUtils.createStorage)("sessionStorage");
-
     if (action.type === _slice.setAuthData.type) {
       for (const [key, value] of Object.entries(state.auth.data)) {
         if (Object.values(value).filter(Boolean).length > 0) {
@@ -30,36 +27,33 @@ function createPersistanceMiddleware(options) {
         }
       }
     }
-
     if (action.type === _slice.setSelectedAuth.type) {
       if (state.auth.selected) {
         storage.setItem((0, _storageUtils.hashArray)(Object.keys(state.auth.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);
     // }
 
-
     if (action.type === "server/setServer") {
       storage.setItem("server", action.payload);
     }
-
     if (action.type === "server/setServerVariable") {
       var _storage$getItem;
-
       const server = (_storage$getItem = storage.getItem("server")) !== null && _storage$getItem !== void 0 ? _storage$getItem : "{}";
       const variables = JSON.parse(action.payload);
       let serverObject = JSON.parse(server);
       serverObject.variables[variables.key].default = variables.value;
       storage.setItem("server", JSON.stringify(serverObject));
     }
-
     return result;
   };
-
   return persistanceMiddleware;
 }

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

@@ -5,28 +5,24 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createStorage = createStorage;
 exports.hashArray = hashArray;
-
 var _cryptoJs = _interopRequireDefault(require("crypto-js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 function hashArray(arr) {
   function hash(message) {
     return _cryptoJs.default.SHA1(message).toString();
   }
-
   const hashed = arr.map(item => hash(item));
   hashed.sort();
   const res = hashed.join();
   return hash(res);
 }
-
 function createStorage(persistance) {
   if (persistance === false) {
     return {
@@ -38,10 +34,8 @@ function createStorage(persistance) {
       length: 0
     };
   }
-
   if (persistance === "sessionStorage") {
     return sessionStorage;
   }
-
   return localStorage;
 }

package/lib/theme/ApiItem/Layout/index.js

@@ -4,42 +4,26 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = DocItemLayout;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _themeCommon = require("@docusaurus/theme-common");
-
 var _internal = require("@docusaurus/theme-common/internal");
-
 var _DocBreadcrumbs = _interopRequireDefault(require("@theme/DocBreadcrumbs"));
-
+var _Content = _interopRequireDefault(require("@theme/DocItem/Content"));
+var _Footer = _interopRequireDefault(require("@theme/DocItem/Footer"));
+var _Paginator = _interopRequireDefault(require("@theme/DocItem/Paginator"));
+var _Desktop = _interopRequireDefault(require("@theme/DocItem/TOC/Desktop"));
+var _Mobile = _interopRequireDefault(require("@theme/DocItem/TOC/Mobile"));
 var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
-
 var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
-
 var _clsx = _interopRequireDefault(require("clsx"));
-
-var _Content = _interopRequireDefault(require("../Content"));
-
-var _Footer = _interopRequireDefault(require("../Footer"));
-
-var _Paginator = _interopRequireDefault(require("../Paginator"));
-
-var _Desktop = _interopRequireDefault(require("../TOC/Desktop"));
-
-var _Mobile = _interopRequireDefault(require("../TOC/Mobile"));
-
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-// @ts-ignore
 
 /**
  * Decide if the toc should be rendered, on mobile or desktop viewports
@@ -60,7 +44,6 @@ function useDocTOC() {
     desktop
   };
 }
-
 function DocItemLayout({
   children
 }) {