docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/StatusCodes/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 });
+const react_1 = __importDefault(require("react"));
+const ApiTabs_1 = __importDefault(require("@theme/ApiTabs"));
+const Details_1 = __importDefault(require("@theme/Details"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const ResponseHeaders_1 = __importDefault(require("@theme/ResponseHeaders"));
+const ResponseSchema_1 = __importDefault(require("@theme/ResponseSchema"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const StatusCodes = ({ label, id, responses }) => {
+  if (!responses) return null;
+  const codes = Object.keys(responses);
+  if (codes.length === 0) return null;
+  return react_1.default.createElement(
+    ApiTabs_1.default,
+    { label: label, id: id },
+    codes.map((code) => {
+      const response = responses[code];
+      const responseHeaders = response.headers;
+      return (
+        // @ts-ignore
+        react_1.default.createElement(
+          TabItem_1.default,
+          { key: code, label: code, value: code },
+          react_1.default.createElement(
+            "div",
+            null,
+            response.description &&
+              react_1.default.createElement(
+                "div",
+                { style: { marginTop: ".5rem", marginBottom: ".5rem" } },
+                react_1.default.createElement(
+                  Markdown_1.default,
+                  null,
+                  response.description
+                )
+              )
+          ),
+          responseHeaders &&
+            react_1.default.createElement(
+              Details_1.default,
+              {
+                className: "openapi-markdown__details",
+                "data-collapsed": true,
+                open: false,
+                style: { textAlign: "left", marginBottom: "1rem" },
+                summary: react_1.default.createElement(
+                  "summary",
+                  null,
+                  react_1.default.createElement(
+                    "strong",
+                    null,
+                    "Response Headers"
+                  )
+                ),
+              },
+              react_1.default.createElement(ResponseHeaders_1.default, {
+                responseHeaders: responseHeaders,
+              })
+            ),
+          react_1.default.createElement(ResponseSchema_1.default, {
+            title: "Schema",
+            body: { content: response.content },
+          })
+        )
+      );
+    })
+  );
+};
+exports.default = StatusCodes;

package/lib/theme/styles.scss

@@ -0,0 +1,212 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+/* API Demo Panel */
+@use "./ApiExplorer/CodeTabs/CodeTabs";
+@use "./ApiExplorer/FloatingButton/FloatingButton";
+@use "./ApiExplorer/FormFileUpload/FormFileUpload";
+@use "./ApiExplorer/FormItem/FormItem";
+@use "./ApiExplorer/FormMultiSelect/FormMultiSelect";
+@use "./ApiExplorer/FormSelect/FormSelect";
+@use "./ApiExplorer/FormTextInput/FormTextInput";
+@use "./ApiExplorer/LiveEditor/LiveEditor";
+@use "./ApiExplorer/MethodEndpoint/MethodEndpoint";
+@use "./ApiExplorer/ParamOptions/ParamOptions";
+@use "./ApiExplorer/Request/Request";
+@use "./ApiExplorer/Response/Response";
+@use "./ApiExplorer/Server/Server";
+
+/* Api Demo Panel / ApiCodeBlock */
+@use "./ApiExplorer/ApiCodeBlock/Container/Container";
+@use "./ApiExplorer/ApiCodeBlock/Content/Content";
+@use "./ApiExplorer/ApiCodeBlock/CopyButton/CopyButton";
+@use "./ApiExplorer/ApiCodeBlock/ExitButton/ExitButton";
+@use "./ApiExplorer/ApiCodeBlock/ExpandButton/ExpandButton";
+@use "./ApiExplorer/ApiCodeBlock/Line/Line";
+@use "./ApiExplorer/ApiCodeBlock/WordWrapButton/WordWrapButton";
+
+/* Schema Styling */
+@use "./ParamsItem/ParamsItem";
+@use "./SchemaItem/SchemaItem";
+/* Tabs Styling */
+@use "./ApiTabs/ApiTabs";
+@use "./DiscriminatorTabs/DiscriminatorTabs";
+@use "./MimeTabs/MimeTabs";
+@use "./SchemaTabs/SchemaTabs";
+@use "./OperationTabs/OperationTabs";
+/* Code Samples */
+@use "./ResponseSamples/ResponseSamples";
+/* Markdown Styling */
+@use "./Markdown/Details/Details";
+
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-deprecated: var(--ifm-color-warning);
+  --openapi-nullable: var(--ifm-color-info);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-input-border: var(--ifm-color-primary);
+  --openapi-input-background: var(--openapi-card-background-color);
+  --openapi-tree-line-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color-python: #ffdb50;
+  --openapi-code-tab-border-color-bash: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-go: var(--ifm-color-info);
+  --openapi-code-tab-border-color-js: var(--ifm-color-warning);
+  --openapi-code-tab-border-color-ruby: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-csharp: #9b4f96;
+  --openapi-code-tab-border-color-nodejs: var(--ifm-color-success);
+  --openapi-code-tab-border-color-php: #6181b6;
+  --openapi-code-tab-border-color-java: #0374bd;
+  --openapi-code-tab-border-color-powershell: #00adef;
+  --openapi-code-tab-shadow-color-python: rgba(255, 219, 80, 0.25);
+  --openapi-code-tab-shadow-color-bash: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-go: rgba(84, 199, 236, 0.25);
+  --openapi-code-tab-shadow-color-js: rgba(255, 186, 0, 0.25);
+  --openapi-code-tab-shadow-color-ruby: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-csharp: rgba(155, 79, 150, 0.25);
+  --opeanpi-code-tab-shadow-color-nodejs: rgba(0, 164, 0, 0.25);
+  --openapi-code-tab-shadow-color-php: rgba(97, 129, 182, 0.25);
+  --openapi-code-tab-shadow-color-java: rgba(3, 116, 189, 0.25);
+  --opeanpi-code-tab-shadow-color-powershell: rgba(3, 116, 189, 0.25);
+  --openapi-explorer-font-size-input: 12px;
+  --openapi-explorer-font-size-code: 12px;
+  --openapi-explorer-padding-input: 0.5rem;
+  --openapi-explorer-border-color: var(--ifm-toc-border-color);
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>');
+  --openapi-skeleton-background: var(--ifm-color-emphasis-100);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24" fill="white"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>') !important;
+}
+
+.docs-wrapper {
+  height: 100%;
+}
+
+// @media (min-width: 997px) {
+//   .docItemCol {
+//     max-width: 75% !important;
+//   }
+
+//   /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+//   .tocMobile {
+//     display: none;
+//   }
+// }
+
+/* Begin OpenAPI theme styles */
+// [data-theme="dark"] {
+//   --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+// }
+
+// .theme-api-markdown div[class^="collapsibleContent"] {
+//   margin-top: 0 !important;
+//   padding-left: 2px;
+// }
+
+/* Demo panel details */
+
+// .theme-api-markdown .openapi-explorer__details > div > div > pre {
+//   border-top-left-radius: 0;
+//   border-top-right-radius: 0;
+// }
+
+/* Code block */
+
+// .theme-api-markdown code {
+//   max-width: 600px;
+//   max-height: 500px;
+//   overflow: auto;
+// }
+
+/* Version button */
+
+.version-button div {
+  display: block;
+}
+
+.version-button div > button > span::after {
+  border-color: currentcolor transparent;
+  border-style: solid;
+  border-width: 0.4em 0.4em 0;
+  content: "";
+  margin-left: 0.3em;
+  position: relative;
+  transform: translateY(-50%);
+  display: inline-block;
+  font-size: 0.8rem;
+  top: 1px;
+}
+
+.openapi__logo {
+  width: 250px;
+}
+
+.openapi__heading {
+  font-size: 2rem;
+  margin-bottom: 0.5rem !important;
+}
+
+.openapi-left-panel__container {
+  border-right: thin solid var(--ifm-toc-border-color);
+}
+
+@media (max-width: 997px) {
+  .schema {
+    margin-bottom: 1rem;
+  }
+}
+
+.openapi-tabs__heading {
+  margin-bottom: 1rem;
+}
+
+/* Loading Skeleton */
+@keyframes pulsing {
+  0% {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-100);
+  }
+  50% {
+    opacity: 0.6;
+    background-color: var(--ifm-toc-border-color);
+  }
+  100% {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-100);
+  }
+}
+
+.openapi-skeleton {
+  animation: pulsing 2s infinite ease-in-out;
+}
+
+/* Loading Skeleton */
+.openapi-skeleton {
+  border-radius: var(--ifm-pre-border-radius);
+  background-color: var(--openapi-skeleton-background);
+  max-width: 100%;
+  margin: 1rem auto;
+}
+
+.openapi-skeleton.sm {
+  height: 100px;
+}
+
+.openapi-skeleton.md {
+  height: 350px;
+}
+
+.openapi-skeleton.lg {
+  height: 96.5%;
+}

package/lib/types.d.ts

@@ -0,0 +1,157 @@
+import type { FrontMatterTag } from "@docusaurus/utils";
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+export interface ThemeConfig {
+    api?: {
+        proxy?: string;
+        authPersistance?: false | "localStorage" | "sessionStorage";
+    };
+}
+interface Map<T> {
+    [key: string]: T;
+}
+export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    allOf?: SchemaObject[];
+    oneOf?: SchemaObject[];
+    anyOf?: SchemaObject[];
+    not?: SchemaObject;
+    items?: SchemaObject;
+    properties?: Map<SchemaObject>;
+    additionalProperties?: boolean | SchemaObject;
+    nullable?: boolean;
+    discriminator?: DiscriminatorObject;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: XMLObject;
+    externalDocs?: ExternalDocumentationObject;
+    example?: any;
+    deprecated?: boolean;
+};
+export interface DiscriminatorObject {
+    propertyName: string;
+    mapping?: Map<string>;
+}
+export interface XMLObject {
+    name?: string;
+    namespace?: string;
+    prefix?: string;
+    attribute?: boolean;
+    wrapped?: boolean;
+}
+export interface ExternalDocumentationObject {
+    description?: string;
+    url: string;
+}
+export type FileChange = {
+    author?: string;
+    /** Date can be any
+     * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
+     */
+    date?: Date | string;
+};
+export type DocFrontMatter = {
+    /**
+     * The last part of the doc ID (will be refactored in the future to be the
+     * full ID instead)
+     * @see {@link DocMetadata.id}
+     */
+    id?: string;
+    /**
+     * Will override the default title collected from h1 heading.
+     * @see {@link DocMetadata.title}
+     */
+    title?: string;
+    /**
+     * Front matter tags, unnormalized.
+     * @see {@link DocMetadata.tags}
+     */
+    tags?: FrontMatterTag[];
+    /**
+     * If there isn't a Markdown h1 heading (which, if there is, we don't
+     * remove), this front matter will cause the front matter title to not be
+     * displayed in the doc page.
+     */
+    hide_title?: boolean;
+    /** Hide the TOC on the right. */
+    hide_table_of_contents?: boolean;
+    /** Used in the head meta. */
+    keywords?: string[];
+    /** Used in the head meta. Should use `assets.image` in priority. */
+    image?: string;
+    /**
+     * Will override the default excerpt.
+     * @see {@link DocMetadata.description}
+     */
+    description?: string;
+    /**
+     * Custom slug appended after /<baseUrl>/<routeBasePath>/<versionPath>
+     * @see {@link DocMetadata.slug}
+     */
+    slug?: string;
+    /** Customizes the sidebar label for this doc. Will default to its title. */
+    sidebar_label?: string;
+    /**
+     * Controls the position of a doc inside the generated sidebar slice when
+     * using autogenerated sidebar items.
+     *
+     * @see https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadata
+     */
+    sidebar_position?: number;
+    /**
+     * Gives the corresponding sidebar label a special class name when using
+     * autogenerated sidebars.
+     */
+    sidebar_class_name?: string;
+    /**
+     * Will be propagated to the final sidebars data structure. Useful if you
+     * have swizzled sidebar-related code or simply querying doc data through
+     * sidebars.
+     */
+    sidebar_custom_props?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Changes the sidebar association of the current doc. Use `null` to make
+     * the current doc not associated to any sidebar.
+     */
+    displayed_sidebar?: string | null;
+    /**
+     * Customizes the pagination label for this doc. Will default to the sidebar
+     * label.
+     */
+    pagination_label?: string;
+    /** Overrides the default URL computed for this doc. */
+    custom_edit_url?: string | null;
+    /**
+     * Whether number prefix parsing is disabled on this doc.
+     * @see https://docusaurus.io/docs/sidebar#using-number-prefixes
+     */
+    parse_number_prefixes?: boolean;
+    /**
+     * Minimum TOC heading level. Must be between 2 and 6 and lower or equal to
+     * the max value.
+     */
+    toc_min_heading_level?: number;
+    /** Maximum TOC heading level. Must be between 2 and 6. */
+    toc_max_heading_level?: number;
+    /**
+     * The ID of the documentation you want the "Next" pagination to link to.
+     * Use `null` to disable showing "Next" for this page.
+     * @see {@link DocMetadata.next}
+     */
+    pagination_next?: string | null;
+    /**
+     * The ID of the documentation you want the "Previous" pagination to link
+     * to. Use `null` to disable showing "Previous" for this page.
+     * @see {@link DocMetadata.prev}
+     */
+    pagination_prev?: string | null;
+    /** Should this doc be excluded from production builds? */
+    draft?: boolean;
+    /** Allows overriding the last updated author and/or date. */
+    last_update?: FileChange;
+    /** Provides OpenAPI Docs with a reference path to their respective Info Doc */
+    info_path?: string;
+};
+export {};

package/lib/types.js

@@ -0,0 +1,8 @@
+"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 });

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "docusaurus-theme-openapi-docs",
+  "description": "OpenAPI theme for Docusaurus.",
+  "version": "0.0.0-1000",
+  "license": "MIT",
+  "keywords": [
+    "openapi",
+    "documentation",
+    "docusaurus",
+    "websites",
+    "theme"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PaloAltoNetworks/docusaurus-openapi-docs.git",
+    "directory": "packages/docusaurus-theme-openapi-docs"
+  },
+  "bugs": {
+    "url": "https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues"
+  },
+  "types": "src/theme-openapi.d.ts",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "tsc --build && node ../../scripts/copyUntypedFiles.mjs && prettier --config ../../.prettierrc.json --write \"lib/theme/**/*.js\"",
+    "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\""
+  },
+  "devDependencies": {
+    "@docusaurus/theme-classic": "^3.5.0",
+    "@docusaurus/theme-common": "^3.5.0",
+    "@docusaurus/types": "^3.5.0",
+    "@types/crypto-js": "^4.1.0",
+    "@types/file-saver": "^2.0.5",
+    "@types/lodash": "^4.14.176",
+    "@types/pako": "^2.0.3",
+    "concurrently": "^5.2.0",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1000",
+    "docusaurus-plugin-sass": "^0.2.3",
+    "eslint-plugin-prettier": "^5.0.1"
+  },
+  "dependencies": {
+    "@hookform/error-message": "^2.0.1",
+    "@reduxjs/toolkit": "^1.7.1",
+    "allof-merge": "^0.6.6",
+    "buffer": "^6.0.3",
+    "clsx": "^1.1.1",
+    "copy-text-to-clipboard": "^3.1.0",
+    "crypto-js": "^4.1.1",
+    "file-saver": "^2.0.5",
+    "lodash": "^4.17.20",
+    "pako": "^2.1.0",
+    "postman-code-generators": "^1.10.1",
+    "postman-collection": "^4.4.0",
+    "prism-react-renderer": "^2.3.0",
+    "process": "^0.11.10",
+    "react-hook-form": "^7.43.8",
+    "react-live": "^4.0.0",
+    "react-magic-dropzone": "^1.0.1",
+    "react-markdown": "^8.0.1",
+    "react-modal": "^3.15.1",
+    "react-redux": "^7.2.0",
+    "rehype-raw": "^6.1.1",
+    "remark-gfm": "3.0.1",
+    "sass": "^1.80.4",
+    "sass-loader": "^16.0.2",
+    "unist-util-visit": "^5.0.0",
+    "url": "^0.11.1",
+    "xml-formatter": "^2.6.1"
+  },
+  "peerDependencies": {
+    "@docusaurus/theme-common": "^3.5.0",
+    "docusaurus-plugin-openapi-docs": "^4.0.0",
+    "docusaurus-plugin-sass": "^0.2.3",
+    "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "gitHead": "abdd081aa1d8100eaed69342192f8d84fec853f7"
+}

package/src/index.ts

@@ -0,0 +1,85 @@
+/* ============================================================================
+ * 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";
+
+import type { Plugin } from "@docusaurus/types";
+
+export default function docusaurusThemeOpenAPI(): Plugin<void> {
+  return {
+    name: "docusaurus-theme-openapi",
+
+    getClientModules() {
+      const modules = [
+        require.resolve(
+          path.join(__dirname, "..", "lib", "theme", "styles.scss")
+        ),
+      ];
+      return modules;
+    },
+
+    getThemePath() {
+      return path.join(__dirname, "..", "lib", "theme");
+    },
+
+    getTypeScriptThemePath() {
+      return path.resolve(__dirname, "..", "src", "theme");
+    },
+
+    configureWebpack(_, isServer, utils) {
+      const rules: any = _.module?.rules ?? [];
+      const sassLoaderRule = rules.filter((r: any) => {
+        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.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/src/markdown/createDescription.ts

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