docusaurus-theme-openapi-docs 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Palo Alto Networks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/babel.config.js

@@ -0,0 +1,35 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+module.exports = {
+  env: {
+    // USED FOR NODE/RUNTIME
+    // maybe we should differenciate both cases because
+    // we mostly need to transpile some features so that node does not crash...
+    lib: {
+      presets: [
+        ["@babel/preset-typescript", { isTSX: true, allExtensions: true }],
+      ],
+      // Useful to transpile for older node versions
+      plugins: [
+        "@babel/plugin-transform-modules-commonjs",
+        "@babel/plugin-proposal-nullish-coalescing-operator",
+        "@babel/plugin-proposal-optional-chaining",
+      ],
+    },
+
+    // USED FOR JS SWIZZLE
+    // /lib-next folder is used as source to swizzle JS source code
+    // This JS code is created from TS source code
+    // This source code should look clean/human readable to be usable
+    "lib-next": {
+      presets: [
+        ["@babel/preset-typescript", { isTSX: true, allExtensions: true }],
+      ],
+    },
+  },
+};

package/lib/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = docusaurusThemeOpenAPI;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _webpack = require("webpack");
+
+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 docusaurusThemeOpenAPI() {
+  return {
+    name: "docusaurus-theme-openapi",
+
+    getThemePath() {
+      return _path.default.join(__dirname, "..", "lib-next", "theme");
+    },
+
+    getTypeScriptThemePath() {
+      return _path.default.resolve(__dirname, "..", "src", "theme");
+    },
+
+    configureWebpack() {
+      return {
+        plugins: [new _webpack.ProvidePlugin({
+          Buffer: [require.resolve("buffer/"), "Buffer"],
+          process: require.resolve("process/browser")
+        })],
+        resolve: {
+          fallback: {
+            buffer: require.resolve("buffer/"),
+            process: require.resolve("process/browser")
+          }
+        }
+      };
+    }
+
+  };
+}

package/lib/markdown/createDescription.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDescription = createDescription;
+
+/* ============================================================================
+ * 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 createDescription(description) {
+  if (!description) {
+    return "";
+  }
+
+  return `\n\n${description}\n\n`;
+}

package/lib/markdown/schema.js

@@ -0,0 +1,121 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getQualifierMessage = getQualifierMessage;
+exports.getSchemaName = getSchemaName;
+
+/* ============================================================================
+ * 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 prettyName(schema, circular) {
+  var _schema$title;
+
+  if (schema.$ref) {
+    return schema.$ref.replace("#/components/schemas/", "") + circular ? " (circular)" : "";
+  }
+
+  if (schema.format) {
+    return schema.format;
+  }
+
+  if (schema.allOf) {
+    return "object";
+  }
+
+  if (schema.type === "object") {
+    var _schema$xml$name, _schema$xml;
+
+    return (_schema$xml$name = (_schema$xml = schema.xml) === null || _schema$xml === void 0 ? void 0 : _schema$xml.name) !== null && _schema$xml$name !== void 0 ? _schema$xml$name : schema.type;
+  }
+
+  return (_schema$title = schema.title) !== null && _schema$title !== void 0 ? _schema$title : schema.type;
+}
+
+function getSchemaName(schema, circular) {
+  var _prettyName;
+
+  if (schema.items) {
+    return prettyName(schema.items, circular) + "[]";
+  }
+
+  return (_prettyName = prettyName(schema, circular)) !== null && _prettyName !== void 0 ? _prettyName : "";
+}
+
+function getQualifierMessage(schema) {
+  // TODO:
+  // - maxItems
+  // - minItems
+  // - uniqueItems
+  // - maxProperties
+  // - minProperties
+  // - multipleOf
+  if (!schema) {
+    return undefined;
+  }
+
+  if (schema.items) {
+    return getQualifierMessage(schema.items);
+  }
+
+  let message = "**Possible values:** ";
+  let qualifierGroups = [];
+
+  if (schema.minLength || schema.maxLength) {
+    let lengthQualifier = "";
+
+    if (schema.minLength) {
+      lengthQualifier += `${schema.minLength} ≤ `;
+    }
+
+    lengthQualifier += "length";
+
+    if (schema.maxLength) {
+      lengthQualifier += ` ≤ ${schema.maxLength}`;
+    }
+
+    qualifierGroups.push(lengthQualifier);
+  }
+
+  if (schema.minimum || schema.maximum || typeof schema.exclusiveMinimum === "number" || typeof schema.exclusiveMaximum === "number") {
+    let minmaxQualifier = "";
+
+    if (typeof schema.exclusiveMinimum === "number") {
+      minmaxQualifier += `${schema.exclusiveMinimum} < `;
+    } else if (schema.minimum && !schema.exclusiveMinimum) {
+      minmaxQualifier += `${schema.minimum} ≤ `;
+    } else if (schema.minimum && schema.exclusiveMinimum === true) {
+      minmaxQualifier += `${schema.minimum} < `;
+    }
+
+    minmaxQualifier += "value";
+
+    if (typeof schema.exclusiveMaximum === "number") {
+      minmaxQualifier += ` < ${schema.exclusiveMaximum}`;
+    } else if (schema.maximum && !schema.exclusiveMaximum) {
+      minmaxQualifier += ` ≤ ${schema.maximum}`;
+    } else if (schema.maximum && schema.exclusiveMaximum === true) {
+      minmaxQualifier += ` < ${schema.maximum}`;
+    }
+
+    qualifierGroups.push(minmaxQualifier);
+  }
+
+  if (schema.pattern) {
+    qualifierGroups.push(`Value must match regular expression \`${schema.pattern}\``);
+  }
+
+  if (schema.enum) {
+    qualifierGroups.push(`[${schema.enum.map(e => `\`${e}\``).join(", ")}]`);
+  }
+
+  if (qualifierGroups.length === 0) {
+    return undefined;
+  }
+
+  return message + qualifierGroups.join(", ");
+}

package/lib/markdown/utils.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.create = create;
+exports.guard = guard;
+exports.render = render;
+
+/* ============================================================================
+ * 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 create(tag, props) {
+  const {
+    children,
+    ...rest
+  } = props;
+  let propString = "";
+
+  for (const [key, value] of Object.entries(rest)) {
+    propString += ` ${key}={${JSON.stringify(value)}}`;
+  }
+
+  return `<${tag}${propString}>${render(children)}</${tag}>`;
+}
+
+function guard(value, cb) {
+  if (value) {
+    const children = cb(value);
+    return render(children);
+  }
+
+  return "";
+}
+
+function render(children) {
+  if (Array.isArray(children)) {
+    return children.filter(c => c !== undefined).join("");
+  }
+
+  return children !== null && children !== void 0 ? children : "";
+}

package/lib/theme/ApiDemoPanel/Accept/index.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _hooks = require("../hooks");
+
+var _FormItem = _interopRequireDefault(require("./../FormItem"));
+
+var _FormSelect = _interopRequireDefault(require("./../FormSelect"));
+
+var _slice = require("./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.
+ * ========================================================================== */
+function Accept() {
+  const value = (0, _hooks.useTypedSelector)(state => state.accept.value);
+  const options = (0, _hooks.useTypedSelector)(state => state.accept.options);
+  const dispatch = (0, _hooks.useTypedDispatch)();
+
+  if (options.length <= 1) {
+    return null;
+  }
+
+  return <_FormItem.default label="Accept">
+      <_FormSelect.default value={value} options={options} onChange={e => dispatch((0, _slice.setAccept)(e.target.value))} />
+    </_FormItem.default>;
+}
+
+var _default = Accept;
+exports.default = _default;

package/lib/theme/ApiDemoPanel/Accept/slice.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.slice = exports.setAccept = exports.default = void 0;
+
+var _toolkit = require("@reduxjs/toolkit");
+
+/* ============================================================================
+ * 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 initialState = {};
+const slice = (0, _toolkit.createSlice)({
+  name: "accept",
+  initialState,
+  reducers: {
+    setAccept: (state, action) => {
+      state.value = action.payload;
+    }
+  }
+});
+exports.slice = slice;
+const {
+  setAccept
+} = slice.actions;
+exports.setAccept = setAccept;
+var _default = slice.reducer;
+exports.default = _default;

package/lib/theme/ApiDemoPanel/Authorization/auth-types.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuthDataKeys = getAuthDataKeys;
+
+/* ============================================================================
+ * 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 getAuthDataKeys(security) {
+  // Bearer Auth
+  if (security.type === "http" && security.scheme === "bearer") {
+    return ["token"];
+  } // Basic Auth
+
+
+  if (security.type === "http" && security.scheme === "basic") {
+    return ["username", "password"];
+  } // API Auth
+
+
+  if (security.type === "apiKey") {
+    return ["apiKey"];
+  } // none
+
+
+  return [];
+}

package/lib/theme/ApiDemoPanel/Authorization/index.js

@@ -0,0 +1,174 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _FormItem = _interopRequireDefault(require("../FormItem"));
+
+var _FormSelect = _interopRequireDefault(require("../FormSelect"));
+
+var _FormTextInput = _interopRequireDefault(require("../FormTextInput"));
+
+var _hooks = require("../hooks");
+
+var _stylesModule = _interopRequireDefault(require("../styles.module.css"));
+
+var _slice = require("./slice");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+/* ============================================================================
+ * 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 LockButton({
+  mode,
+  children,
+  style,
+  ...rest
+}) {
+  return <button className={(0, _clsx.default)("button", "button--primary", {
+    "button--outline": mode !== "locked"
+  })} style={{
+    marginLeft: "auto",
+    display: "flex",
+    alignItems: "center",
+    marginBottom: "var(--ifm-spacing-vertical)",
+    ...style
+  }} {...rest}>
+      <span>{children}</span>
+
+      <svg style={{
+      marginLeft: "12px",
+      width: "18px",
+      height: "18px",
+      fill: "currentColor"
+    }} viewBox="0 0 20 20" id={mode}>
+        {mode === "locked" ? <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"></path> : <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>}
+      </svg>
+    </button>;
+}
+
+function validateData(selectedAuth, data) {
+  for (const scheme of selectedAuth) {
+    if (data[scheme.key] === undefined) {
+      return false;
+    }
+
+    const hasMissingKeys = Object.values(data[scheme.key]).includes(undefined);
+
+    if (hasMissingKeys) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+function Authorization() {
+  const [editing, setEditing] = (0, _react.useState)(false);
+  const data = (0, _hooks.useTypedSelector)(state => state.auth.data);
+  const options = (0, _hooks.useTypedSelector)(state => state.auth.options);
+  const selected = (0, _hooks.useTypedSelector)(state => state.auth.selected);
+  const dispatch = (0, _hooks.useTypedDispatch)();
+
+  if (selected === undefined) {
+    return null;
+  }
+
+  const selectedAuth = options[selected];
+  const authenticated = validateData(selectedAuth, data);
+  const optionKeys = Object.keys(options);
+
+  if (editing) {
+    return <div className={_stylesModule.default.optionsPanel}>
+        {optionKeys.length > 1 && <_FormItem.default label="Security Scheme">
+            <_FormSelect.default options={optionKeys} value={selected} onChange={e => {
+          dispatch((0, _slice.setSelectedAuth)(e.target.value));
+        }} />
+          </_FormItem.default>}
+        {selectedAuth.map(a => {
+        if (a.type === "http" && a.scheme === "bearer") {
+          var _data$a$key$token;
+
+          return <_FormItem.default label="Bearer Token" key={selected + "-bearer"}>
+                <_FormTextInput.default placeholder="Bearer Token" value={(_data$a$key$token = data[a.key].token) !== null && _data$a$key$token !== void 0 ? _data$a$key$token : ""} onChange={e => {
+              const value = e.target.value.trim();
+              dispatch((0, _slice.setAuthData)({
+                scheme: a.key,
+                key: "token",
+                value: value ? value : undefined
+              }));
+            }} />
+              </_FormItem.default>;
+        }
+
+        if (a.type === "http" && a.scheme === "basic") {
+          var _data$a$key$username, _data$a$key$password;
+
+          return <_react.default.Fragment key={selected + "-basic"}>
+                <_FormItem.default label="Username">
+                  <_FormTextInput.default placeholder="Username" value={(_data$a$key$username = data[a.key].username) !== null && _data$a$key$username !== void 0 ? _data$a$key$username : ""} onChange={e => {
+                const value = e.target.value.trim();
+                dispatch((0, _slice.setAuthData)({
+                  scheme: a.key,
+                  key: "username",
+                  value: value ? value : undefined
+                }));
+              }} />
+                </_FormItem.default>
+                <_FormItem.default label="Password">
+                  <_FormTextInput.default placeholder="Password" password value={(_data$a$key$password = data[a.key].password) !== null && _data$a$key$password !== void 0 ? _data$a$key$password : ""} onChange={e => {
+                const value = e.target.value.trim();
+                dispatch((0, _slice.setAuthData)({
+                  scheme: a.key,
+                  key: "password",
+                  value: value ? value : undefined
+                }));
+              }} />
+                </_FormItem.default>
+              </_react.default.Fragment>;
+        }
+
+        return null;
+      })}
+        <LockButton mode="unlocked" style={{
+        marginTop: "var(--ifm-spacing-vertical)",
+        marginBottom: 0
+      }} onClick={() => {
+        setEditing(false);
+      }}>
+          Save
+        </LockButton>
+      </div>;
+  }
+
+  if (authenticated) {
+    return <LockButton mode="locked" onClick={() => {
+      setEditing(true);
+    }}>
+        Authorized
+      </LockButton>;
+  }
+
+  return <LockButton mode="unlocked" onClick={() => {
+    setEditing(true);
+  }}>
+      Authorize
+    </LockButton>;
+}
+
+var _default = Authorization;
+exports.default = _default;