docusaurus-theme-openapi-docs 0.0.0-348 → 0.0.0-351

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/postman-code-generators.d.ts

@@ -0,0 +1,9 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
+declare module "@paloaltonetworks/postman-code-generators";

package/lib/react-magic-dropzone.d.ts

@@ -0,0 +1,9 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
+declare module "react-magic-dropzone";

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/slice.js

@@ -0,0 +1,137 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createAuth = createAuth;
+exports.slice = exports.setSelectedAuth = exports.setAuthData = exports.default = void 0;
+
+var _toolkit = require("@reduxjs/toolkit");
+
+var _storageUtils = require("../storage-utils");
+
+var _authTypes = require("./auth-types");
+
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+// The global definitions
+// "securitySchemes": {
+//   "BearerAuth": { "type": "http", "scheme": "BeAreR" },
+//   "BasicAuth": { "type": "http", "scheme": "basic" }
+// },
+// The operation level requirements
+// "security": [
+//   { "BearerAuth": [] },
+//   { "BearerAuth": [], "BasicAuth": [] }
+// ],
+// SLICE_STATE
+// data:
+//   BearerAuth:
+//     token=xxx
+//   BasicAuth:
+//     username=xxx
+//     password=xxx
+//
+// options:
+//    "BearerAuth": [{ key: "BearerAuth", scopes: [], ...rest }]
+//    "BearerAuth and BasicAuth": [{ key: "BearerAuth", scopes: [], ...rest }, { key: "BasicAuth", scopes: [], ...rest }]
+//
+// selected: "BearerAuth and BasicAuth"
+// LOCAL_STORAGE
+// hash(SLICE_STATE.options) -> "BearerAuth and BasicAuth"
+// BearerAuth                -> { token: xxx }
+// BasicAuth                 -> { username: xxx, password: xxx }
+function createAuth({
+  security,
+  securitySchemes,
+  options: opts
+}) {
+  var _persisted;
+
+  const storage = (0, _storageUtils.createStorage)(opts === null || opts === void 0 ? void 0 : opts.authPersistance);
+  let data = {};
+  let options = {};
+
+  for (const option of security !== null && security !== void 0 ? security : []) {
+    const id = Object.keys(option).join(" and ");
+
+    for (const [schemeID, scopes] of Object.entries(option)) {
+      const scheme = securitySchemes === null || securitySchemes === void 0 ? void 0 : securitySchemes[schemeID];
+
+      if (scheme) {
+        if (options[id] === undefined) {
+          options[id] = [];
+        }
+
+        const dataKeys = (0, _authTypes.getAuthDataKeys)(scheme);
+
+        for (const key of dataKeys) {
+          if (data[schemeID] === undefined) {
+            data[schemeID] = {};
+          }
+
+          let persisted = undefined;
+
+          try {
+            var _storage$getItem;
+
+            persisted = JSON.parse((_storage$getItem = storage.getItem(schemeID)) !== null && _storage$getItem !== void 0 ? _storage$getItem : "")[key];
+          } catch {}
+
+          data[schemeID][key] = persisted;
+        }
+
+        options[id].push({ ...scheme,
+          key: schemeID,
+          scopes
+        });
+      }
+    }
+  }
+
+  let persisted = undefined;
+
+  try {
+    var _storage$getItem2;
+
+    persisted = (_storage$getItem2 = storage.getItem((0, _storageUtils.hashArray)(Object.keys(options)))) !== null && _storage$getItem2 !== void 0 ? _storage$getItem2 : undefined;
+  } catch {}
+
+  return {
+    data,
+    options,
+    selected: (_persisted = persisted) !== null && _persisted !== void 0 ? _persisted : Object.keys(options)[0]
+  };
+}
+
+const initialState = {};
+const slice = (0, _toolkit.createSlice)({
+  name: "auth",
+  initialState,
+  reducers: {
+    setAuthData: (state, action) => {
+      const {
+        scheme,
+        key,
+        value
+      } = action.payload;
+      state.data[scheme][key] = value;
+    },
+    setSelectedAuth: (state, action) => {
+      state.selected = action.payload;
+    }
+  }
+});
+exports.slice = slice;
+const {
+  setAuthData,
+  setSelectedAuth
+} = slice.actions;
+exports.setSelectedAuth = setSelectedAuth;
+exports.setAuthData = setAuthData;
+var _default = slice.reducer;
+exports.default = _default;

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

@@ -0,0 +1,185 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ContentType = _interopRequireDefault(require("../ContentType"));
+
+var _FormSelect = _interopRequireDefault(require("../FormSelect"));
+
+var _hooks = require("../hooks");
+
+var _FormFileUpload = _interopRequireDefault(require("./../FormFileUpload"));
+
+var _FormItem = _interopRequireDefault(require("./../FormItem"));
+
+var _FormTextInput = _interopRequireDefault(require("./../FormTextInput"));
+
+var _VSCode = _interopRequireDefault(require("./../VSCode"));
+
+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 BodyWrap({
+  requestBodyMetadata,
+  jsonRequestBodyExample
+}) {
+  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value); // NOTE: We used to check if body was required, but opted to always show the request body
+  // to reduce confusion, see: https://github.com/cloud-annotations/docusaurus-openapi/issues/145
+  // No body
+
+  if (contentType === undefined) {
+    return null;
+  }
+
+  return <>
+      <_ContentType.default />
+      <Body requestBodyMetadata={requestBodyMetadata} jsonRequestBodyExample={jsonRequestBodyExample} />
+    </>;
+}
+
+function Body({
+  requestBodyMetadata,
+  jsonRequestBodyExample
+}) {
+  var _requestBodyMetadata$, _requestBodyMetadata$2;
+
+  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
+  const dispatch = (0, _hooks.useTypedDispatch)(); // Lot's of possible content-types:
+  // - application/json
+  // - application/xml
+  // - text/plain
+  // - text/css
+  // - text/html
+  // - text/javascript
+  // - application/javascript
+  // - multipart/form-data
+  // - application/x-www-form-urlencoded
+  // - image/svg+xml;charset=US-ASCII
+  // Show editor:
+  // - application/json
+  // - application/xml
+  // - */*
+  // Show form:
+  // - multipart/form-data
+  // - application/x-www-form-urlencoded
+
+  const schema = requestBodyMetadata === null || requestBodyMetadata === void 0 ? void 0 : (_requestBodyMetadata$ = requestBodyMetadata.content) === null || _requestBodyMetadata$ === void 0 ? void 0 : (_requestBodyMetadata$2 = _requestBodyMetadata$[contentType]) === null || _requestBodyMetadata$2 === void 0 ? void 0 : _requestBodyMetadata$2.schema;
+
+  if ((schema === null || schema === void 0 ? void 0 : schema.format) === "binary") {
+    return <_FormItem.default label="Body">
+        <_FormFileUpload.default placeholder={schema.description || "Body"} onChange={file => {
+        if (file === undefined) {
+          dispatch((0, _slice.clearRawBody)());
+          return;
+        }
+
+        dispatch((0, _slice.setFileRawBody)({
+          src: `/path/to/${file.name}`,
+          content: file
+        }));
+      }} />
+      </_FormItem.default>;
+  }
+
+  if ((contentType === "multipart/form-data" || contentType === "application/x-www-form-urlencoded") && (schema === null || schema === void 0 ? void 0 : schema.type) === "object") {
+    var _schema$properties;
+
+    return <_FormItem.default label="Body">
+        <div style={{
+        marginTop: "calc(var(--ifm-pre-padding) / 2)",
+        borderRadius: "4px",
+        padding: "var(--ifm-pre-padding)",
+        border: "1px solid var(--openapi-monaco-border-color)"
+      }}>
+          {Object.entries((_schema$properties = schema.properties) !== null && _schema$properties !== void 0 ? _schema$properties : {}).map(([key, val]) => {
+          if (val.format === "binary") {
+            return <_FormItem.default key={key} label={key}>
+                  <_FormFileUpload.default placeholder={val.description || key} onChange={file => {
+                if (file === undefined) {
+                  dispatch((0, _slice.clearFormBodyKey)(key));
+                  return;
+                }
+
+                dispatch((0, _slice.setFileFormBody)({
+                  key: key,
+                  value: {
+                    src: `/path/to/${file.name}`,
+                    content: file
+                  }
+                }));
+              }} />
+                </_FormItem.default>;
+          }
+
+          if (val.enum) {
+            return <_FormItem.default key={key} label={key}>
+                  <_FormSelect.default options={["---", ...val.enum]} onChange={e => {
+                const val = e.target.value;
+
+                if (val === "---") {
+                  dispatch((0, _slice.clearFormBodyKey)(key));
+                } else {
+                  dispatch((0, _slice.setStringFormBody)({
+                    key: key,
+                    value: val
+                  }));
+                }
+              }} />
+                </_FormItem.default>;
+          } // TODO: support all the other types.
+
+
+          return <_FormItem.default key={key} label={key}>
+                <_FormTextInput.default placeholder={val.description || key} onChange={e => {
+              dispatch((0, _slice.setStringFormBody)({
+                key: key,
+                value: e.target.value
+              }));
+            }} />
+              </_FormItem.default>;
+        })}
+        </div>
+      </_FormItem.default>;
+  }
+
+  let language = "plaintext";
+  let exampleBodyString = ""; //"body content";
+
+  if (contentType === "application/json") {
+    if (jsonRequestBodyExample) {
+      exampleBodyString = JSON.stringify(jsonRequestBodyExample, null, 2);
+    }
+
+    language = "json";
+  }
+
+  if (contentType === "application/xml") {
+    language = "xml";
+  }
+
+  return <_FormItem.default label="Body">
+      <_VSCode.default value={exampleBodyString} language={language} onChange={value => {
+      if (value.trim() === "") {
+        dispatch((0, _slice.clearRawBody)());
+        return;
+      }
+
+      dispatch((0, _slice.setStringRawBody)(value));
+    }} />
+    </_FormItem.default>;
+}
+
+var _default = BodyWrap;
+exports.default = _default;