docusaurus-theme-openapi-docs 1.0.0

package/lib/theme/ApiDemoPanel/buildPostmanRequest.js

@@ -0,0 +1,329 @@
+"use strict";
+
+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.
+ * ========================================================================== */
+// @ts-ignore
+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"
+
+
+    if (param.allowEmptyValue) {
+      if (param.value === "true") {
+        return new _postmanCollection.default.QueryParam({
+          key: param.name,
+          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({
+      key: param.name,
+      value: param.value || `:${param.name}`
+    });
+  });
+  postman.url.variables.assimilate(source, false);
+}
+
+function buildCookie(cookieParams) {
+  const cookies = cookieParams.map(param => {
+    if (param.value && !Array.isArray(param.value)) {
+      return new _postmanCollection.default.Cookie({
+        // TODO: Is this right?
+        path: "",
+        domain: "",
+        key: param.name,
+        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({
+        key: param.name,
+        value: param.value
+      });
+    }
+  });
+  other.forEach(header => {
+    postman.addHeader(header);
+  });
+
+  if (cookie) {
+    postman.addHeader({
+      key: "Cookie",
+      value: cookie
+    });
+  }
+} // 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";
+    clonedPostman.body.file = {
+      src: body.content.value.src
+    };
+    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({
+              key: key,
+              ...content
+            });
+          }
+
+          return new _postmanCollection.default.FormParam({
+            key: key,
+            value: content.value
+          });
+        });
+        (_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({
+              key: key,
+              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
+
+
+function buildPostmanRequest(postman, {
+  queryParams,
+  pathParams,
+  cookieParams,
+  contentType,
+  accept,
+  headerParams,
+  body,
+  server,
+  auth
+}) {
+  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) {
+        continue;
+      }
+
+      otherHeaders.push({
+        key: "Authorization",
+        value: `Bearer ${token}`
+      });
+      continue;
+    } // 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
+
+
+    if (a.type === "apiKey" && a.in === "header") {
+      const {
+        apikey
+      } = auth.data[a.key];
+
+      if (apikey === undefined) {
+        otherHeaders.push({
+          key: a.name,
+          value: "API_KEY_VALUE"
+        });
+        continue;
+      }
+
+      otherHeaders.push({
+        key: a.name,
+        value: apikey
+      });
+      continue;
+    }
+  }
+
+  setHeaders(clonedPostman, contentType, accept, cookie, headerParams, otherHeaders);
+  setBody(clonedPostman, body);
+  return clonedPostman;
+}
+
+var _default = buildPostmanRequest;
+exports.default = _default;

package/lib/theme/ApiDemoPanel/hooks.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTypedSelector = exports.useTypedDispatch = void 0;
+
+var _reactRedux = require("react-redux");
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+const useTypedDispatch = () => (0, _reactRedux.useDispatch)();
+
+exports.useTypedDispatch = useTypedDispatch;
+const useTypedSelector = _reactRedux.useSelector;
+exports.useTypedSelector = useTypedSelector;

package/lib/theme/ApiDemoPanel/index.js

@@ -0,0 +1,134 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
+
+var _postmanCollection = _interopRequireDefault(require("@paloaltonetworks/postman-collection"));
+
+var _reactRedux = require("react-redux");
+
+var _Accept = _interopRequireDefault(require("./Accept"));
+
+var _slice = require("./Authorization/slice");
+
+var _Body = _interopRequireDefault(require("./Body"));
+
+var _Curl = _interopRequireDefault(require("./Curl"));
+
+var _MethodEndpoint = _interopRequireDefault(require("./MethodEndpoint"));
+
+var _ParamOptions = _interopRequireDefault(require("./ParamOptions"));
+
+var _persistanceMiddleware = require("./persistanceMiddleware");
+
+var _Response = _interopRequireDefault(require("./Response"));
+
+var _SecuritySchemes = _interopRequireDefault(require("./SecuritySchemes"));
+
+var _Server = _interopRequireDefault(require("./Server"));
+
+var _store = require("./store");
+
+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
+// @ts-ignore
+function ApiDemoPanel({
+  item
+}) {
+  var _item$responses, _item$requestBody$con, _item$requestBody, _item$servers, _item$parameters, _xCodeSamples;
+
+  const {
+    siteConfig
+  } = (0, _useDocusaurusContext.default)();
+  const themeConfig = siteConfig.themeConfig;
+  const options = themeConfig.api;
+  const postman = new _postmanCollection.default.Request(item.postman);
+  const acceptArray = Array.from(new Set(Object.values((_item$responses = item.responses) !== null && _item$responses !== void 0 ? _item$responses : {}) // @ts-ignore
+  .map(response => {
+    var _response$content;
+
+    return Object.keys((_response$content = response.content) !== null && _response$content !== void 0 ? _response$content : {});
+  }).flat()));
+  const content = (_item$requestBody$con = (_item$requestBody = item.requestBody) === null || _item$requestBody === void 0 ? void 0 : _item$requestBody.content) !== null && _item$requestBody$con !== void 0 ? _item$requestBody$con : {};
+  const contentTypeArray = Object.keys(content);
+  const servers = (_item$servers = item.servers) !== null && _item$servers !== void 0 ? _item$servers : [];
+  const params = {
+    path: [],
+    query: [],
+    header: [],
+    cookie: []
+  };
+  (_item$parameters = item.parameters) === null || _item$parameters === void 0 ? void 0 : _item$parameters.forEach(param => {
+    // @ts-ignore
+    params[param.in].push(param);
+  });
+  const auth = (0, _slice.createAuth)({
+    security: item.security,
+    securitySchemes: item.securitySchemes,
+    options
+  });
+  const persistanceMiddleware = (0, _persistanceMiddleware.createPersistanceMiddleware)(options);
+  const store2 = (0, _store.createStoreWithState)({
+    accept: {
+      value: acceptArray[0],
+      options: acceptArray
+    },
+    contentType: {
+      value: contentTypeArray[0],
+      options: contentTypeArray
+    },
+    server: {
+      value: servers[0],
+      options: servers
+    },
+    response: {
+      value: undefined
+    },
+    body: {
+      type: "empty"
+    },
+    params,
+    auth
+  }, [persistanceMiddleware]);
+  const {
+    path,
+    method
+  } = item;
+  return <_reactRedux.Provider store={store2}>
+      <div className={_stylesModule.default.apiDemoPanelContainer}>
+        <_MethodEndpoint.default method={method} path={path} />
+
+        <_SecuritySchemes.default />
+
+        <div className={_stylesModule.default.optionsPanel}>
+          <_ParamOptions.default />
+          <_Body.default jsonRequestBodyExample={item.jsonRequestBodyExample} requestBodyMetadata={item.requestBody} />
+          <_Accept.default />
+        </div>
+
+        <_Server.default />
+
+        <_Curl.default postman={postman} codeSamples={(_xCodeSamples = item["x-code-samples"]) !== null && _xCodeSamples !== void 0 ? _xCodeSamples : []} />
+
+        <_Response.default />
+      </div>
+    </_reactRedux.Provider>;
+}
+
+var _default = ApiDemoPanel;
+exports.default = _default;

package/lib/theme/ApiDemoPanel/persistanceMiddleware.js

@@ -0,0 +1,44 @@
+"use strict";
+
+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)(options === null || options === void 0 ? void 0 : options.authPersistance);
+
+    if (action.type === _slice.setAuthData.type) {
+      for (const [key, value] of Object.entries(state.auth.data)) {
+        if (Object.values(value).filter(Boolean).length > 0) {
+          storage.setItem(key, JSON.stringify(value));
+        } else {
+          storage.removeItem(key);
+        }
+      }
+    }
+
+    if (action.type === _slice.setSelectedAuth.type) {
+      if (state.auth.selected) {
+        storage.setItem((0, _storageUtils.hashArray)(Object.keys(state.auth.options)), state.auth.selected);
+      }
+    }
+
+    return result;
+  };
+
+  return persistanceMiddleware;
+}

package/lib/theme/ApiDemoPanel/postman-collection.d.ts

@@ -0,0 +1,10 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+declare module "@paloaltonetworks/postman-collection" {
+  export = Request.sdk;
+}

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

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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 {
+      getItem: () => null,
+      setItem: () => {},
+      clear: () => {},
+      key: () => null,
+      removeItem: () => {},
+      length: 0
+    };
+  }
+
+  if (persistance === "sessionStorage") {
+    return sessionStorage;
+  }
+
+  return localStorage;
+}

package/lib/theme/ApiDemoPanel/store.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStoreWithState = void 0;
+
+var _toolkit = require("@reduxjs/toolkit");
+
+var _slice = _interopRequireDefault(require("./Accept/slice"));
+
+var _slice2 = _interopRequireDefault(require("./Authorization/slice"));
+
+var _slice3 = _interopRequireDefault(require("./Body/slice"));
+
+var _slice4 = _interopRequireDefault(require("./ContentType/slice"));
+
+var _slice5 = _interopRequireDefault(require("./ParamOptions/slice"));
+
+var _slice6 = _interopRequireDefault(require("./Response/slice"));
+
+var _slice7 = _interopRequireDefault(require("./Server/slice"));
+
+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.
+ * ========================================================================== */
+const rootReducer = (0, _toolkit.combineReducers)({
+  accept: _slice.default,
+  contentType: _slice4.default,
+  response: _slice6.default,
+  server: _slice7.default,
+  body: _slice3.default,
+  params: _slice5.default,
+  auth: _slice2.default
+});
+
+const createStoreWithState = (preloadedState, middlewares) => (0, _toolkit.configureStore)({
+  reducer: rootReducer,
+  preloadedState,
+  middleware: getDefaultMiddleware => getDefaultMiddleware().concat(...middlewares)
+});
+
+exports.createStoreWithState = createStoreWithState;

package/lib/theme/ApiDemoPanel/styles.module.css

@@ -0,0 +1,44 @@
+:root {
+  /* VS Dark mode */
+  --openapi-monaco-background-color-dark: var(--ifm-color-gray-900);
+  --openapi-code-bright-dark: var(--ifm-color-secondary-lighter);
+  --openapi-code-dim-dark: var(--ifm-color-secondary-dark);
+  --openapi-code-blue-dark: var(--ifm-color-primary);
+  --openapi-code-green-dark: var(--ifm-color-success);
+  --openapi-code-select-dark: var(--ifm-color-secondary-lightest);
+
+  /* VS Light mode */
+  --openapi-monaco-background-color-light: var(--ifm-color-gray-100);
+  --openapi-code-bright-light: var(--ifm-color-black);
+  --openapi-code-dim-light: var(--ifm-color-black);
+  --openapi-code-blue-light: var(--ifm-color-primary);
+  --openapi-code-green-light: var(--ifm-color-success);
+  --openapi-code-select-light: var(--ifm-color-secondary-light);
+
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-monaco-border-color: var(--openapi-card-background-color);
+  --openapi-input-border: var(--ifm-color-primary);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+}
+
+.optionsPanel:empty {
+  display: none;
+}
+
+.optionsPanel {
+  background: var(--openapi-card-background-color);
+  border-radius: var(--openapi-card-border-radius);
+  color: var(--ifm-pre-color);
+  line-height: var(--ifm-pre-line-height);
+  margin-bottom: var(--ifm-spacing-vertical);
+  margin-top: 0;
+  overflow: auto;
+  padding: var(--ifm-pre-padding);
+
+  /* hack for view calculation when monaco is hidden */
+  position: relative;
+}