docusaurus-theme-openapi-docs 0.0.0-1000

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.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin } from "@docusaurus/types";
+export default function docusaurusThemeOpenAPI(): Plugin<void>;

package/lib/index.js

@@ -0,0 +1,81 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = docusaurusThemeOpenAPI;
+const path_1 = __importDefault(require("path"));
+function docusaurusThemeOpenAPI() {
+    return {
+        name: "docusaurus-theme-openapi",
+        getClientModules() {
+            const modules = [
+                require.resolve(path_1.default.join(__dirname, "..", "lib", "theme", "styles.scss")),
+            ];
+            return modules;
+        },
+        getThemePath() {
+            return path_1.default.join(__dirname, "..", "lib", "theme");
+        },
+        getTypeScriptThemePath() {
+            return path_1.default.resolve(__dirname, "..", "src", "theme");
+        },
+        configureWebpack(_, isServer, utils) {
+            const rules = _.module?.rules ?? [];
+            const sassLoaderRule = rules.filter((r) => {
+                return String(r.test) === String(/\.s[ca]ss$/);
+            });
+            const { getStyleLoaders } = utils;
+            // Avoid conflicts with docusaurus-plugin-sass
+            if (sassLoaderRule.length === 0) {
+                return {
+                    resolve: {
+                        fallback: {
+                            buffer: require.resolve("buffer/"),
+                        },
+                    },
+                    plugins: [
+                        new utils.currentBundler.instance.ProvidePlugin({
+                            process: require.resolve("process/browser"),
+                            Buffer: ["buffer", "Buffer"],
+                        }),
+                    ],
+                    module: {
+                        rules: [
+                            {
+                                test: /\.s[ac]ss$/,
+                                include: path_1.default.resolve(__dirname, "..", "lib", "theme"),
+                                use: [
+                                    ...getStyleLoaders(isServer, {}),
+                                    {
+                                        loader: require.resolve("sass-loader"),
+                                        options: {},
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                };
+            }
+            return {
+                resolve: {
+                    fallback: {
+                        buffer: require.resolve("buffer/"),
+                    },
+                },
+                plugins: [
+                    new utils.currentBundler.instance.ProvidePlugin({
+                        process: require.resolve("process/browser"),
+                        Buffer: ["buffer", "Buffer"],
+                    }),
+                ],
+            };
+        },
+    };
+}

package/lib/markdown/createDescription.d.ts

@@ -0,0 +1 @@
+export declare function createDescription(description: string | undefined): string;

package/lib/markdown/createDescription.js

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

package/lib/markdown/schema.d.ts

@@ -0,0 +1,3 @@
+import { SchemaObject } from "../types";
+export declare function getSchemaName(schema: SchemaObject, circular?: boolean): string;
+export declare function getQualifierMessage(schema?: SchemaObject): string | undefined;

package/lib/markdown/schema.js

@@ -0,0 +1,149 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSchemaName = getSchemaName;
+exports.getQualifierMessage = getQualifierMessage;
+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;
+}
+function getSchemaName(schema, circular) {
+    if (schema.items) {
+        return prettyName(schema.items, circular) + "[]";
+    }
+    return prettyName(schema, circular) ?? "";
+}
+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 != null ||
+        schema.maximum != null ||
+        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 != null && !schema.exclusiveMinimum) {
+            minimum = `\`>= ${schema.minimum}\``;
+        }
+        else if (schema.minimum != null && schema.exclusiveMinimum === true) {
+            minimum = `\`> ${schema.minimum}\``;
+        }
+        if (typeof schema.exclusiveMaximum === "number") {
+            maximum = `\`< ${schema.exclusiveMaximum}\``;
+        }
+        else if (schema.maximum != null && !schema.exclusiveMaximum) {
+            maximum = `\`<= ${schema.maximum}\``;
+        }
+        else if (schema.maximum != null && 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/markdown/utils.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from "react";
+/** @deprecated use ReactNode from React instead */
+export type Children = ReactNode;
+export type Props = Record<string, any> & {
+    children?: ReactNode;
+};
+export declare function create(tag: string, props: Props): string;
+export declare function guard<T>(value: T | undefined | string, cb: (value: T) => ReactNode): string | number | bigint | boolean | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined>;
+export declare function render(children: ReactNode): string | number | bigint | boolean | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined>;
+export declare function toString(value: any): string | undefined;

package/lib/markdown/utils.js

@@ -0,0 +1,49 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = create;
+exports.guard = guard;
+exports.render = render;
+exports.toString = toString;
+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 || value === 0) {
+        const children = cb(value);
+        return render(children);
+    }
+    return "";
+}
+function render(children) {
+    if (Array.isArray(children)) {
+        return children.filter((c) => c !== undefined).join("");
+    }
+    return children ?? "";
+}
+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/markdown/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/markdown/utils.test.js

@@ -0,0 +1,43 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe("guard", () => {
+    it("should guard empty strings", () => {
+        const actual = (0, utils_1.guard)("", (_) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should guard undefined", () => {
+        const actual = (0, utils_1.guard)(undefined, (value) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should guard false booleans", () => {
+        const actual = (0, utils_1.guard)(false, (value) => `${value}`);
+        expect(actual).toBe("");
+    });
+    it("should not guard strings", () => {
+        const actual = (0, utils_1.guard)("hello", (value) => value);
+        expect(actual).toBe("hello");
+    });
+    it("should not guard numbers", () => {
+        const actual = (0, utils_1.guard)(1, (value) => `${value}`);
+        expect(actual).toBe("1");
+    });
+    it("should not guard numbers equals to 0", () => {
+        const actual = (0, utils_1.guard)(0, (value) => `${value}`);
+        expect(actual).toBe("0");
+    });
+    it("should not guard true booleans", () => {
+        const actual = (0, utils_1.guard)(true, (value) => `${value}`);
+        expect(actual).toBe("true");
+    });
+});

package/lib/theme/ApiExplorer/Accept/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare function Accept(): React.JSX.Element | null;
+export default Accept;

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

@@ -0,0 +1,38 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
+const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("./slice");
+function Accept() {
+  const value = (0, hooks_1.useTypedSelector)((state) => state.accept.value);
+  const options = (0, hooks_1.useTypedSelector)(
+    (state) => state.accept.options
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (options.length <= 1) {
+    return null;
+  }
+  return react_1.default.createElement(
+    FormItem_1.default,
+    { label: "Accept" },
+    react_1.default.createElement(FormSelect_1.default, {
+      value: value,
+      options: options,
+      onChange: (e) => dispatch((0, slice_1.setAccept)(e.target.value)),
+    })
+  );
+}
+exports.default = Accept;

package/lib/theme/ApiExplorer/Accept/slice.d.ts

@@ -0,0 +1,11 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface State {
+    value: string;
+    options: string[];
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<State, {
+    setAccept: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+}, "accept">;
+export declare const setAccept: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "accept/setAccept">;
+declare const _default: import("redux").Reducer<State>;
+export default _default;

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

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

package/lib/theme/ApiExplorer/ApiCodeBlock/Container/_Container.scss

@@ -0,0 +1,7 @@
+.openapi-explorer__code-block-container {
+  height: 100%;
+  background: var(--prism-background-color);
+  color: var(--prism-color);
+  margin-bottom: unset;
+  box-shadow: var(--ifm-global-shadow-lw);
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Container/index.d.ts

@@ -0,0 +1,4 @@
+import React, { ComponentProps } from "react";
+export default function CodeBlockContainer<T extends "div" | "pre">({ as: As, ...props }: {
+    as: T;
+} & ComponentProps<T>): React.JSX.Element;

package/lib/theme/ApiExplorer/ApiCodeBlock/Container/index.js

@@ -0,0 +1,35 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = CodeBlockContainer;
+const react_1 = __importDefault(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const internal_1 = require("@docusaurus/theme-common/internal");
+const clsx_1 = __importDefault(require("clsx"));
+function CodeBlockContainer({ as: As, ...props }) {
+  const prismTheme = (0, theme_common_1.usePrismTheme)();
+  const prismCssVariables = (0, internal_1.getPrismCssVariables)(prismTheme);
+  return react_1.default.createElement(
+    As,
+    // Polymorphic components are hard to type, without `oneOf` generics
+    {
+      ...props,
+      style: prismCssVariables,
+      className: (0, clsx_1.default)(
+        "openapi-explorer__code-block-container",
+        props.className,
+        theme_common_1.ThemeClassNames.common.codeBlock
+      ),
+    }
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/Element.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { Props } from "@theme/CodeBlock/Content/Element";
+export default function CodeBlockJSX({ children, className, }: Props): React.JSX.Element;

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/Element.js

@@ -0,0 +1,41 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = CodeBlockJSX;
+const react_1 = __importDefault(require("react"));
+const Container_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/Container")
+);
+const clsx_1 = __importDefault(require("clsx"));
+// <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
+// the children is not a simple string, we just return a styled block without
+// actually highlighting.
+function CodeBlockJSX({ children, className }) {
+  return react_1.default.createElement(
+    Container_1.default,
+    {
+      as: "pre",
+      tabIndex: 0,
+      className: (0, clsx_1.default)(
+        "openapi-explorer__code-block-standalone",
+        "thin-scrollbar",
+        className
+      ),
+    },
+    react_1.default.createElement(
+      "code",
+      { className: "openapi-explorer__code-block-lines" },
+      children
+    )
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/String.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { Props } from "@theme/CodeBlock/Content/String";
+export default function CodeBlockString({ children, className: blockClassName, metastring, title: titleProp, showLineNumbers: showLineNumbersProp, language: languageProp, }: Props): React.JSX.Element;