docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.4

package/lib-next/index.js

@@ -1,68 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-import path from "path";
-const NodePolyfillPlugin = require("node-polyfill-webpack-plugin");
-export default function docusaurusThemeOpenAPI() {
-  return {
-    name: "docusaurus-theme-openapi",
-    getClientModules() {
-      const modules = [require.resolve("./theme/styles.scss")];
-      return modules;
-    },
-    getThemePath() {
-      return path.join(__dirname, "..", "lib-next", "theme");
-    },
-    getTypeScriptThemePath() {
-      return path.resolve(__dirname, "..", "src", "theme");
-    },
-    configureWebpack(_, isServer, utils) {
-      const { getStyleLoaders } = utils;
-      const isProd = process.env.NODE_ENV === "production";
-      return {
-        plugins: [new NodePolyfillPlugin()],
-        module: {
-          rules: [
-            {
-              test: /\.s[ca]ss$/,
-              oneOf: [
-                {
-                  test: /\.module\.s[ca]ss$/,
-                  use: [
-                    ...getStyleLoaders(isServer, {
-                      modules: {
-                        localIdentName: isProd
-                          ? `[local]_[hash:base64:4]`
-                          : `[local]_[path][name]`,
-                        exportOnlyLocals: isServer,
-                      },
-                      importLoaders: 2,
-                      sourceMap: !isProd,
-                    }),
-                    {
-                      loader: require.resolve("sass-loader"),
-                      options: {},
-                    },
-                  ],
-                },
-                {
-                  use: [
-                    ...getStyleLoaders(isServer, {}),
-                    {
-                      loader: require.resolve("sass-loader"),
-                      options: {},
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-        },
-      };
-    },
-  };
-}

package/lib-next/markdown/createDescription.js

@@ -1,13 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-export function createDescription(description) {
-  if (!description) {
-    return "";
-  }
-  return `\n\n${description}\n\n`;
-}

package/lib-next/markdown/schema.js

@@ -1,153 +0,0 @@
-/* ============================================================================
- * 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) {
-  if (schema.format) {
-    return schema.format;
-  }
-  if (schema.allOf) {
-    if (typeof schema.allOf[0] === "string") {
-      // @ts-ignore
-      if (schema.allOf[0].includes("circular")) {
-        return schema.allOf[0];
-      }
-    }
-    return "object";
-  }
-  if (schema.oneOf) {
-    return "object";
-  }
-  if (schema.anyOf) {
-    return "object";
-  }
-  if (schema.type === "object") {
-    return schema.xml?.name ?? schema.type;
-    // return schema.type;
-  }
-
-  if (schema.type === "array") {
-    return schema.xml?.name ?? schema.type;
-    // return schema.type;
-  }
-
-  return schema.title ?? schema.type;
-}
-export function getSchemaName(schema, circular) {
-  if (schema.items) {
-    return prettyName(schema.items, circular) + "[]";
-  }
-  return prettyName(schema, circular) ?? "";
-}
-export function getQualifierMessage(schema) {
-  // TODO:
-  // - uniqueItems
-  // - maxProperties
-  // - minProperties
-  // - multipleOf
-  if (!schema) {
-    return undefined;
-  }
-  if (
-    schema.items &&
-    schema.minItems === undefined &&
-    schema.maxItems === undefined
-  ) {
-    return getQualifierMessage(schema.items);
-  }
-  let message = "**Possible values:** ";
-  let qualifierGroups = [];
-  if (schema.items && schema.items.enum) {
-    if (schema.items.enum) {
-      qualifierGroups.push(
-        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`
-      );
-    }
-  }
-  if (schema.minLength || schema.maxLength) {
-    let lengthQualifier = "";
-    let minLength;
-    let maxLength;
-    if (schema.minLength && schema.minLength > 1) {
-      minLength = `\`>= ${schema.minLength} characters\``;
-    }
-    if (schema.minLength && schema.minLength === 1) {
-      minLength = `\`non-empty\``;
-    }
-    if (schema.maxLength) {
-      maxLength = `\`<= ${schema.maxLength} characters\``;
-    }
-    if (minLength && !maxLength) {
-      lengthQualifier += minLength;
-    }
-    if (maxLength && !minLength) {
-      lengthQualifier += maxLength;
-    }
-    if (minLength && maxLength) {
-      lengthQualifier += `${minLength} and ${maxLength}`;
-    }
-    qualifierGroups.push(lengthQualifier);
-  }
-  if (
-    schema.minimum ||
-    schema.maximum ||
-    typeof schema.exclusiveMinimum === "number" ||
-    typeof schema.exclusiveMaximum === "number"
-  ) {
-    let minmaxQualifier = "";
-    let minimum;
-    let maximum;
-    if (typeof schema.exclusiveMinimum === "number") {
-      minimum = `\`> ${schema.exclusiveMinimum}\``;
-    } else if (schema.minimum && !schema.exclusiveMinimum) {
-      minimum = `\`>= ${schema.minimum}\``;
-    } else if (schema.minimum && schema.exclusiveMinimum === true) {
-      minimum = `\`> ${schema.minimum}\``;
-    }
-    if (typeof schema.exclusiveMaximum === "number") {
-      maximum = `\`< ${schema.exclusiveMaximum}\``;
-    } else if (schema.maximum && !schema.exclusiveMaximum) {
-      maximum = `\`<= ${schema.maximum}\``;
-    } else if (schema.maximum && schema.exclusiveMaximum === true) {
-      maximum = `\`< ${schema.maximum}\``;
-    }
-    if (minimum && !maximum) {
-      minmaxQualifier += minimum;
-    }
-    if (maximum && !minimum) {
-      minmaxQualifier += maximum;
-    }
-    if (minimum && maximum) {
-      minmaxQualifier += `${minimum} and ${maximum}`;
-    }
-    qualifierGroups.push(minmaxQualifier);
-  }
-  if (schema.pattern) {
-    qualifierGroups.push(
-      `Value must match regular expression \`${schema.pattern}\``
-    );
-  }
-
-  // Check if discriminator mapping
-  const discriminator = schema;
-  if (discriminator.mapping) {
-    const values = Object.keys(discriminator.mapping);
-    qualifierGroups.push(`[${values.map((e) => `\`${e}\``).join(", ")}]`);
-  }
-  if (schema.enum) {
-    qualifierGroups.push(`[${schema.enum.map((e) => `\`${e}\``).join(", ")}]`);
-  }
-  if (schema.minItems) {
-    qualifierGroups.push(`\`>= ${schema.minItems}\``);
-  }
-  if (schema.maxItems) {
-    qualifierGroups.push(`\`<= ${schema.maxItems}\``);
-  }
-  if (qualifierGroups.length === 0) {
-    return undefined;
-  }
-  return message + qualifierGroups.join(", ");
-}

package/lib-next/markdown/utils.js

@@ -1,44 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-export 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}>`;
-}
-export function guard(value, cb) {
-  if (!!value) {
-    const children = cb(value);
-    return render(children);
-  }
-  return "";
-}
-export function render(children) {
-  if (Array.isArray(children)) {
-    return children.filter((c) => c !== undefined).join("");
-  }
-  return children ?? "";
-}
-export function toString(value) {
-  // Return as-is if already string
-  if (typeof value === "string") {
-    return value;
-  }
-  // Return undefined if null or undefined
-  if (value == null) {
-    return undefined;
-  }
-  // Return formatted array if Array
-  if (Array.isArray(value)) {
-    return `[${value.join(", ")}]`;
-  }
-  // Coerce to string in all other cases,
-  return value + "";
-}

package/lib-next/postman-code-generators.d.ts

@@ -1,9 +0,0 @@
-/* ============================================================================
- * 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-next/react-magic-dropzone.d.ts

@@ -1,9 +0,0 @@
-/* ============================================================================
- * 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-next/theme/ApiDemoPanel/Accept/index.js

@@ -1,30 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-import React from "react";
-import FormItem from "@theme/ApiDemoPanel/FormItem";
-import FormSelect from "@theme/ApiDemoPanel/FormSelect";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import { setAccept } from "./slice";
-function Accept() {
-  const value = useTypedSelector((state) => state.accept.value);
-  const options = useTypedSelector((state) => state.accept.options);
-  const dispatch = useTypedDispatch();
-  if (options.length <= 1) {
-    return null;
-  }
-  return (
-    <FormItem label="Accept">
-      <FormSelect
-        value={value}
-        options={options}
-        onChange={(e) => dispatch(setAccept(e.target.value))}
-      />
-    </FormItem>
-  );
-}
-export default Accept;

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

@@ -1,29 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-export function getAuthDataKeys(security) {
-  // Bearer Auth
-  if (security.type === "http" && security.scheme === "bearer") {
-    return ["token"];
-  }
-  if (security.type === "oauth2") {
-    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-next/theme/ApiDemoPanel/Authorization/index.js

@@ -1,142 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-import React from "react";
-import FormItem from "@theme/ApiDemoPanel/FormItem";
-import FormSelect from "@theme/ApiDemoPanel/FormSelect";
-import FormTextInput from "@theme/ApiDemoPanel/FormTextInput";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import { setAuthData, setSelectedAuth } from "./slice";
-function Authorization() {
-  const data = useTypedSelector((state) => state.auth.data);
-  const options = useTypedSelector((state) => state.auth.options);
-  const selected = useTypedSelector((state) => state.auth.selected);
-  const dispatch = useTypedDispatch();
-  if (selected === undefined) {
-    return null;
-  }
-  const selectedAuth = options[selected];
-  const optionKeys = Object.keys(options);
-  return (
-    <div>
-      {optionKeys.length > 1 && (
-        <FormItem label="Security Scheme">
-          <FormSelect
-            options={optionKeys}
-            value={selected}
-            onChange={(e) => {
-              dispatch(setSelectedAuth(e.target.value));
-            }}
-          />
-        </FormItem>
-      )}
-      {selectedAuth.map((a) => {
-        if (a.type === "http" && a.scheme === "bearer") {
-          return (
-            <FormItem label="Bearer Token" key={a.key + "-bearer"}>
-              <FormTextInput
-                placeholder="Bearer Token"
-                value={data[a.key].token ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "token",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        if (a.type === "oauth2") {
-          return (
-            <FormItem label="Bearer Token" key={a.key + "-oauth2"}>
-              <FormTextInput
-                placeholder="Bearer Token"
-                value={data[a.key].token ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "token",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        if (a.type === "http" && a.scheme === "basic") {
-          return (
-            <React.Fragment key={a.key + "-basic"}>
-              <FormItem label="Username">
-                <FormTextInput
-                  placeholder="Username"
-                  value={data[a.key].username ?? ""}
-                  onChange={(e) => {
-                    const value = e.target.value;
-                    dispatch(
-                      setAuthData({
-                        scheme: a.key,
-                        key: "username",
-                        value: value ? value : undefined,
-                      })
-                    );
-                  }}
-                />
-              </FormItem>
-              <FormItem label="Password">
-                <FormTextInput
-                  placeholder="Password"
-                  password
-                  value={data[a.key].password ?? ""}
-                  onChange={(e) => {
-                    const value = e.target.value;
-                    dispatch(
-                      setAuthData({
-                        scheme: a.key,
-                        key: "password",
-                        value: value ? value : undefined,
-                      })
-                    );
-                  }}
-                />
-              </FormItem>
-            </React.Fragment>
-          );
-        }
-        if (a.type === "apiKey") {
-          return (
-            <FormItem label={`${a.key}`} key={a.key + "-apikey"}>
-              <FormTextInput
-                placeholder={`${a.key}`}
-                value={data[a.key].apiKey ?? ""}
-                onChange={(e) => {
-                  const value = e.target.value;
-                  dispatch(
-                    setAuthData({
-                      scheme: a.key,
-                      key: "apiKey",
-                      value: value ? value : undefined,
-                    })
-                  );
-                }}
-              />
-            </FormItem>
-          );
-        }
-        return null;
-      })}
-    </div>
-  );
-}
-export default Authorization;