docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiExplorer/Body/json2xml.js

@@ -0,0 +1,43 @@
+/* ============================================================================
+ * 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 default function json2xml(o, tab) {
+  var toXml = function (v, name, ind) {
+      var xml = "";
+      if (v instanceof Array) {
+        for (var i = 0, n = v.length; i < n; i++)
+          xml += ind + toXml(v[i], name, ind + "\t") + "\n";
+      } else if (typeof v == "object") {
+        var hasChild = false;
+        xml += ind + "<" + name;
+        for (var m in v) {
+          if (m.charAt(0) === "@")
+            xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
+          else hasChild = true;
+        }
+        xml += hasChild ? ">" : "/>";
+        if (hasChild) {
+          for (var m2 in v) {
+            if (m2 === "#text") xml += v[m2];
+            else if (m2 === "#cdata") xml += "<![CDATA[" + v[m2] + "]]>";
+            else if (m2.charAt(0) !== "@") xml += toXml(v[m2], m2, ind + "\t");
+          }
+          xml +=
+            (xml.charAt(xml.length - 1) === "\n" ? ind : "") +
+            "</" +
+            name +
+            ">";
+        }
+      } else {
+        xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
+      }
+      return xml;
+    },
+    xml = "";
+  for (var m3 in o) xml += toXml(o[m3], m3, "");
+  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}

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

@@ -0,0 +1,82 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface FileContent {
+    type: "file";
+    value: {
+        src: string;
+        content: Blob;
+    };
+}
+export interface StringContent {
+    type: "string";
+    value?: string;
+}
+export type Content = FileContent | StringContent | undefined;
+export interface FormBody {
+    type: "form";
+    content: {
+        [key: string]: Content;
+    };
+}
+export interface RawBody {
+    type: "raw";
+    content: Content;
+}
+export interface EmptyBody {
+    type: "empty";
+}
+export type Body = EmptyBody | FormBody | RawBody;
+export type State = Body;
+export declare const slice: import("@reduxjs/toolkit").Slice<FormBody | RawBody | EmptyBody, {
+    clearRawBody: (_state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>) => {
+        type: "empty";
+    };
+    setStringRawBody: (_state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>, action: PayloadAction<string>) => {
+        type: "raw";
+        content: {
+            type: "string";
+            value: string;
+        };
+    };
+    setFileRawBody: (_state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>, action: PayloadAction<FileContent["value"]>) => {
+        type: "raw";
+        content: {
+            type: "file";
+            value: {
+                src: string;
+                content: Blob;
+            };
+        };
+    };
+    clearFormBodyKey: (state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>, action: PayloadAction<string>) => void;
+    setStringFormBody: (state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>, action: PayloadAction<{
+        key: string;
+        value: string;
+    }>) => import("immer/dist/internal").WritableDraft<FormBody>;
+    setFileFormBody: (state: import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody> | import("immer/dist/internal").WritableDraft<EmptyBody>, action: PayloadAction<{
+        key: string;
+        value: FileContent["value"];
+    }>) => import("immer/dist/internal").WritableDraft<FormBody> | {
+        type: "form";
+        content: {
+            [x: string]: {
+                type: "file";
+                value: {
+                    src: string;
+                    content: Blob;
+                };
+            };
+        };
+    };
+}, "body">;
+export declare const clearRawBody: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"body/clearRawBody">, setStringRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "body/setStringRawBody">, setFileRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    src: string;
+    content: Blob;
+}, "body/setFileRawBody">, clearFormBodyKey: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "body/clearFormBodyKey">, setStringFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    key: string;
+    value: string;
+}, "body/setStringFormBody">, setFileFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    key: string;
+    value: FileContent["value"];
+}, "body/setFileFormBody">;
+declare const _default: import("redux").Reducer<FormBody | RawBody | EmptyBody>;
+export default _default;

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

@@ -0,0 +1,97 @@
+"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 _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFileFormBody =
+  exports.setStringFormBody =
+  exports.clearFormBodyKey =
+  exports.setFileRawBody =
+  exports.setStringRawBody =
+  exports.clearRawBody =
+  exports.slice =
+    void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "body",
+  initialState,
+  reducers: {
+    clearRawBody: (_state) => {
+      return {
+        type: "empty",
+      };
+    },
+    setStringRawBody: (_state, action) => {
+      return {
+        type: "raw",
+        content: {
+          type: "string",
+          value: action.payload,
+        },
+      };
+    },
+    setFileRawBody: (_state, action) => {
+      return {
+        type: "raw",
+        content: {
+          type: "file",
+          value: action.payload,
+        },
+      };
+    },
+    clearFormBodyKey: (state, action) => {
+      if (state?.type === "form") {
+        delete state.content[action.payload];
+      }
+    },
+    setStringFormBody: (state, action) => {
+      if (state?.type !== "form") {
+        return {
+          type: "form",
+          content: {
+            [action.payload.key]: {
+              type: "string",
+              value: action.payload.value,
+            },
+          },
+        };
+      }
+      state.content[action.payload.key] = {
+        type: "string",
+        value: action.payload.value,
+      };
+      return state;
+    },
+    setFileFormBody: (state, action) => {
+      if (state?.type !== "form") {
+        return {
+          type: "form",
+          content: {
+            [action.payload.key]: {
+              type: "file",
+              value: action.payload.value,
+            },
+          },
+        };
+      }
+      state.content[action.payload.key] = {
+        type: "file",
+        value: action.payload.value,
+      };
+      return state;
+    },
+  },
+});
+(_a = exports.slice.actions),
+  (exports.clearRawBody = _a.clearRawBody),
+  (exports.setStringRawBody = _a.setStringRawBody),
+  (exports.setFileRawBody = _a.setFileRawBody),
+  (exports.clearFormBodyKey = _a.clearFormBodyKey),
+  (exports.setStringFormBody = _a.setStringFormBody),
+  (exports.setFileFormBody = _a.setFileFormBody);
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.d.ts

@@ -0,0 +1,21 @@
+export type CodeSampleLanguage = "C" | "C#" | "C++" | "CoffeeScript" | "CSS" | "Dart" | "DM" | "Elixir" | "Go" | "Groovy" | "HTML" | "Java" | "JavaScript" | "Kotlin" | "Objective-C" | "OCaml" | "Perl" | "PHP" | "PowerShell" | "Python" | "R" | "Ruby" | "Rust" | "Scala" | "Shell" | "Swift" | "TypeScript";
+export interface Language {
+    highlight: string;
+    language: string;
+    codeSampleLanguage: CodeSampleLanguage;
+    logoClass: string;
+    variant: string;
+    variants: string[];
+    options?: {
+        [key: string]: boolean;
+    };
+    sample?: string;
+    samples?: string[];
+    samplesSources?: string[];
+    samplesLabels?: string[];
+}
+export interface CodeSample {
+    source: string;
+    lang: CodeSampleLanguage;
+    label?: string;
+}

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-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/lib/theme/ApiExplorer/CodeSnippets/index.d.ts

@@ -0,0 +1,10 @@
+import { type JSX } from "react";
+import sdk from "postman-collection";
+import { CodeSample, Language } from "./code-snippets-types";
+export declare const languageSet: Language[];
+export interface Props {
+    postman: sdk.Request;
+    codeSamples: CodeSample[];
+}
+declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
+export default CodeSnippets;

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

@@ -0,0 +1,389 @@
+"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 __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  (function () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __setModuleDefault(result, mod);
+      return result;
+    };
+  })();
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.languageSet = void 0;
+const react_1 = __importStar(require("react"));
+const useDocusaurusContext_1 = __importDefault(
+  require("@docusaurus/useDocusaurusContext")
+);
+const ApiCodeBlock_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock")
+);
+const buildPostmanRequest_1 = __importDefault(
+  require("@theme/ApiExplorer/buildPostmanRequest")
+);
+const CodeTabs_1 = __importDefault(require("@theme/ApiExplorer/CodeTabs"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const postman_code_generators_1 = __importDefault(
+  require("postman-code-generators")
+);
+const languages_1 = require("./languages");
+exports.languageSet = (0, languages_1.generateLanguageSet)();
+function CodeTab({ children, hidden, className }) {
+  return react_1.default.createElement(
+    "div",
+    { role: "tabpanel", className: className, hidden },
+    children
+  );
+}
+function CodeSnippets({ postman, codeSamples }) {
+  const { siteConfig } = (0, useDocusaurusContext_1.default)();
+  const contentType = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  const accept = (0, hooks_1.useTypedSelector)((state) => state.accept.value);
+  const server = (0, hooks_1.useTypedSelector)((state) => state.server.value);
+  const body = (0, hooks_1.useTypedSelector)((state) => state.body);
+  const pathParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.path
+  );
+  const queryParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.query
+  );
+  const cookieParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.cookie
+  );
+  const headerParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.header
+  );
+  const auth = (0, hooks_1.useTypedSelector)((state) => state.auth);
+  const clonedAuth = (0, cloneDeep_1.default)(auth);
+  let placeholder;
+  function cleanCredentials(obj) {
+    for (const key in obj) {
+      if (typeof obj[key] === "object" && obj[key] !== null) {
+        // use name as placeholder if exists
+        const comboAuthId = Object.keys(obj).join(" and ");
+        const authOptions =
+          clonedAuth?.options?.[key] ?? clonedAuth?.options?.[comboAuthId];
+        placeholder = authOptions?.[0]?.name;
+        obj[key] = cleanCredentials(obj[key]);
+      } else {
+        obj[key] = `<${placeholder ?? key}>`;
+      }
+    }
+    return obj;
+  }
+  // scrub credentials from code snippets
+  const cleanedAuth = {
+    ...clonedAuth,
+    data: cleanCredentials(clonedAuth.data),
+  };
+  // Create a Postman request object using cleanedAuth
+  const cleanedPostmanRequest = (0, buildPostmanRequest_1.default)(postman, {
+    queryParams,
+    pathParams,
+    cookieParams,
+    contentType,
+    accept,
+    headerParams,
+    body,
+    server,
+    auth: cleanedAuth,
+  });
+  // User-defined languages array
+  // Can override languageSet, change order of langs, override options and variants
+  const userDefinedLanguageSet =
+    siteConfig?.themeConfig?.languageTabs ?? exports.languageSet;
+  // Filter languageSet by user-defined langs
+  const filteredLanguageSet = exports.languageSet.filter((ls) => {
+    return userDefinedLanguageSet?.some((lang) => {
+      return lang.language === ls.language;
+    });
+  });
+  // Merge user-defined langs into languageSet
+  const mergedLangs = (0, languages_1.mergeCodeSampleLanguage)(
+    (0, languages_1.mergeArraysbyLanguage)(
+      userDefinedLanguageSet,
+      filteredLanguageSet
+    ),
+    codeSamples
+  );
+  // Read defaultLang from localStorage
+  const defaultLang = mergedLangs.filter(
+    (lang) =>
+      lang.language === localStorage.getItem("docusaurus.tab.code-samples")
+  );
+  const [selectedVariant, setSelectedVariant] = (0, react_1.useState)();
+  const [selectedSample, setSelectedSample] = (0, react_1.useState)();
+  const [language, setLanguage] = (0, react_1.useState)(() => {
+    // Return first index if only 1 user-defined language exists
+    if (mergedLangs.length === 1) {
+      return mergedLangs[0];
+    }
+    // Fall back to language in localStorage or first user-defined language
+    return defaultLang[0] ?? mergedLangs[0];
+  });
+  const [codeText, setCodeText] = (0, react_1.useState)("");
+  const [codeSampleCodeText, setCodeSampleCodeText] = (0, react_1.useState)(
+    () => (0, languages_1.getCodeSampleSourceFromLanguage)(language)
+  );
+  (0, react_1.useEffect)(() => {
+    if (language && !!language.sample) {
+      setCodeSampleCodeText(
+        (0, languages_1.getCodeSampleSourceFromLanguage)(language)
+      );
+    }
+    if (language && !!language.options) {
+      postman_code_generators_1.default.convert(
+        language.language,
+        language.variant,
+        cleanedPostmanRequest,
+        language.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    } else if (language && !language.options) {
+      const langSource = mergedLangs.filter(
+        (lang) => lang.language === language.language
+      );
+      // Merges user-defined language with default languageSet
+      // This allows users to define only the minimal properties necessary in languageTabs
+      // User-defined properties should override languageSet properties
+      const mergedLanguage = { ...langSource[0], ...language };
+      postman_code_generators_1.default.convert(
+        mergedLanguage.language,
+        mergedLanguage.variant,
+        cleanedPostmanRequest,
+        mergedLanguage.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    } else {
+      setCodeText("");
+    }
+  }, [
+    accept,
+    body,
+    contentType,
+    cookieParams,
+    headerParams,
+    language,
+    pathParams,
+    postman,
+    queryParams,
+    server,
+    cleanedPostmanRequest,
+    mergedLangs,
+  ]);
+  // no dependencies was intentionally set for this particular hook. it's safe as long as if conditions are set
+  (0, react_1.useEffect)(function onSelectedVariantUpdate() {
+    if (selectedVariant && selectedVariant !== language?.variant) {
+      postman_code_generators_1.default.convert(
+        language.language,
+        selectedVariant,
+        cleanedPostmanRequest,
+        language.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    }
+  });
+  // no dependencies was intentionally set for this particular hook. it's safe as long as if conditions are set
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  (0, react_1.useEffect)(function onSelectedSampleUpdate() {
+    if (
+      language &&
+      language.samples &&
+      language.samplesSources &&
+      selectedSample &&
+      selectedSample !== language.sample
+    ) {
+      const sampleIndex = language.samples.findIndex(
+        (smp) => smp === selectedSample
+      );
+      setCodeSampleCodeText(language.samplesSources[sampleIndex]);
+    }
+  });
+  if (language === undefined) {
+    return null;
+  }
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    react_1.default.createElement(
+      CodeTabs_1.default,
+      {
+        groupId: "code-samples",
+        action: {
+          setLanguage: setLanguage,
+          setSelectedVariant: setSelectedVariant,
+          setSelectedSample: setSelectedSample,
+        },
+        languageSet: mergedLangs,
+        defaultValue: defaultLang[0]?.language ?? mergedLangs[0].language,
+        lazy: true,
+      },
+      mergedLangs.map((lang) => {
+        return react_1.default.createElement(
+          CodeTab,
+          {
+            value: lang.language,
+            label: lang.language,
+            key: lang.language,
+            attributes: {
+              className: `openapi-tabs__code-item--${lang.logoClass}`,
+            },
+          },
+          lang.samples &&
+            react_1.default.createElement(
+              CodeTabs_1.default,
+              {
+                className: "openapi-tabs__code-container-inner",
+                action: {
+                  setLanguage: setLanguage,
+                  setSelectedSample: setSelectedSample,
+                },
+                includeSample: true,
+                currentLanguage: lang.language,
+                defaultValue: selectedSample,
+                languageSet: mergedLangs,
+                lazy: true,
+              },
+              lang.samples.map((sample, index) => {
+                return react_1.default.createElement(
+                  CodeTab,
+                  {
+                    value: sample,
+                    label: lang.samplesLabels
+                      ? lang.samplesLabels[index]
+                      : sample,
+                    key: `${lang.language}-${lang.sample}`,
+                    attributes: {
+                      className: `openapi-tabs__code-item--sample`,
+                    },
+                  },
+                  react_1.default.createElement(
+                    ApiCodeBlock_1.default,
+                    {
+                      language: lang.highlight,
+                      className: "openapi-explorer__code-block",
+                      showLineNumbers: true,
+                    },
+                    codeSampleCodeText
+                  )
+                );
+              })
+            ),
+          react_1.default.createElement(
+            CodeTabs_1.default,
+            {
+              className: "openapi-tabs__code-container-inner",
+              action: {
+                setLanguage: setLanguage,
+                setSelectedVariant: setSelectedVariant,
+              },
+              includeVariant: true,
+              currentLanguage: lang.language,
+              defaultValue: selectedVariant,
+              languageSet: mergedLangs,
+              lazy: true,
+            },
+            lang.variants.map((variant, index) => {
+              return react_1.default.createElement(
+                CodeTab,
+                {
+                  value: variant.toLowerCase(),
+                  label: variant.toUpperCase(),
+                  key: `${lang.language}-${lang.variant}`,
+                  attributes: {
+                    className: `openapi-tabs__code-item--variant`,
+                  },
+                },
+                react_1.default.createElement(
+                  ApiCodeBlock_1.default,
+                  {
+                    language: lang.highlight,
+                    className: "openapi-explorer__code-block",
+                    showLineNumbers: true,
+                  },
+                  codeText
+                )
+              );
+            })
+          )
+        );
+      })
+    )
+  );
+}
+exports.default = CodeSnippets;

package/lib/theme/ApiExplorer/CodeSnippets/languages.d.ts

@@ -0,0 +1,5 @@
+import { CodeSample, Language } from "./code-snippets-types";
+export declare function mergeCodeSampleLanguage(languages: Language[], codeSamples: CodeSample[]): Language[];
+export declare const mergeArraysbyLanguage: (arr1: any, arr2: any) => any[];
+export declare function getCodeSampleSourceFromLanguage(language: Language): string;
+export declare function generateLanguageSet(): Language[];