docusaurus-theme-openapi-docs 0.0.0-619 → 0.0.0-685

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 declare 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 declare type Body = EmptyBody | FormBody | RawBody;
+export declare type State = Body;
+export declare const slice: import("@reduxjs/toolkit").Slice<EmptyBody | FormBody | RawBody, {
+    clearRawBody: (_state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>) => {
+        type: "empty";
+    };
+    setStringRawBody: (_state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>, action: PayloadAction<string>) => {
+        type: "raw";
+        content: {
+            type: "string";
+            value: string;
+        };
+    };
+    setFileRawBody: (_state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>, action: PayloadAction<FileContent["value"]>) => {
+        type: "raw";
+        content: {
+            type: "file";
+            value: {
+                src: string;
+                content: Blob;
+            };
+        };
+    };
+    clearFormBodyKey: (state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>, action: PayloadAction<string>) => void;
+    setStringFormBody: (state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>, action: PayloadAction<{
+        key: string;
+        value: string;
+    }>) => import("immer/dist/internal").WritableDraft<FormBody>;
+    setFileFormBody: (state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>, 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<EmptyBody | FormBody | RawBody, import("redux").AnyAction>;
+export default _default;

package/{lib-next/theme/ApiDemoPanel → lib/theme/ApiExplorer}/Body/slice.js

@@ -1,13 +1,23 @@
+"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.
  * ========================================================================== */
-
-import { createSlice } from "@reduxjs/toolkit";
+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 = {};
-export const slice = createSlice({
+exports.slice = (0, toolkit_1.createSlice)({
   name: "body",
   initialState,
   reducers: {
@@ -77,12 +87,11 @@ export const slice = createSlice({
     },
   },
 });
-export const {
-  clearRawBody,
-  setStringRawBody,
-  setFileRawBody,
-  clearFormBodyKey,
-  setStringFormBody,
-  setFileFormBody,
-} = slice.actions;
-export default slice.reducer;
+(_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/index.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import sdk from "@paloaltonetworks/postman-collection";
+export interface Language {
+    highlight: string;
+    language: string;
+    logoClass: string;
+    variant: string;
+    variants: string[];
+    options: {
+        [key: string]: boolean;
+    };
+    source?: string;
+}
+export declare const languageSet: Language[];
+export interface Props {
+    postman: sdk.Request;
+    codeSamples: any;
+}
+declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
+export default CodeSnippets;

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

@@ -0,0 +1,406 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __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 postman_code_generators_1 = __importDefault(
+  require("@paloaltonetworks/postman-code-generators")
+);
+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 merge_1 = __importDefault(require("lodash/merge"));
+exports.languageSet = [
+  {
+    highlight: "bash",
+    language: "curl",
+    logoClass: "bash",
+    options: {
+      longFormat: false,
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "cURL",
+    variants: ["curl"],
+  },
+  {
+    highlight: "python",
+    language: "python",
+    logoClass: "python",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "requests",
+    variants: ["requests", "http.client"],
+  },
+  {
+    highlight: "go",
+    language: "go",
+    logoClass: "go",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "native",
+    variants: ["native"],
+  },
+  {
+    highlight: "javascript",
+    language: "nodejs",
+    logoClass: "nodejs",
+    options: {
+      ES6_enabled: true,
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "axios",
+    variants: ["axios", "native", "request", "unirest"],
+  },
+  {
+    highlight: "ruby",
+    language: "ruby",
+    logoClass: "ruby",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "Net::HTTP",
+    variants: ["net::http"],
+  },
+  {
+    highlight: "csharp",
+    language: "csharp",
+    logoClass: "csharp",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "RestSharp",
+    variants: ["restsharp", "httpclient"],
+  },
+  {
+    highlight: "php",
+    language: "php",
+    logoClass: "php",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "cURL",
+    variants: ["curl", "guzzle", "pecl_http", "http_request2"],
+  },
+  {
+    highlight: "java",
+    language: "java",
+    logoClass: "java",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "OkHttp",
+    variants: ["okhttp", "unirest"],
+  },
+  {
+    highlight: "powershell",
+    language: "powershell",
+    logoClass: "powershell",
+    options: {
+      followRedirect: true,
+      trimRequestBody: true,
+    },
+    variant: "RestMethod",
+    variants: ["restmethod"],
+  },
+];
+function CodeTab({ children, hidden, className, onClick }) {
+  return react_1.default.createElement(
+    "div",
+    { role: "tabpanel", className: className, ...{ hidden } },
+    children
+  );
+}
+function CodeSnippets({ postman, codeSamples }) {
+  // TODO: match theme for vscode.
+  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);
+  // User-defined languages array
+  // Can override languageSet, change order of langs, override options and variants
+  const langs = [
+    ...(siteConfig?.themeConfig?.languageTabs ?? exports.languageSet),
+    ...codeSamples,
+  ];
+  // Filter languageSet by user-defined langs
+  const filteredLanguageSet = exports.languageSet.filter((ls) => {
+    return langs.some((lang) => {
+      return lang.language === ls.language;
+    });
+  });
+  // Merge user-defined langs into languageSet
+  const mergedLangs = (0, merge_1.default)(filteredLanguageSet, langs);
+  // 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 [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)("");
+  (0, react_1.useEffect)(() => {
+    if (language && !!language.options) {
+      const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
+        queryParams,
+        pathParams,
+        cookieParams,
+        contentType,
+        accept,
+        headerParams,
+        body,
+        server,
+        auth,
+      });
+      postman_code_generators_1.default.convert(
+        language.language,
+        language.variant,
+        postmanRequest,
+        language.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    } else if (language && !!language.source) {
+      setCodeText(language.source);
+    } 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 };
+      const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
+        queryParams,
+        pathParams,
+        cookieParams,
+        contentType,
+        accept,
+        headerParams,
+        body,
+        server,
+        auth,
+      });
+      postman_code_generators_1.default.convert(
+        mergedLanguage.language,
+        mergedLanguage.variant,
+        postmanRequest,
+        mergedLanguage.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    } else {
+      setCodeText("");
+    }
+  }, [
+    accept,
+    body,
+    contentType,
+    cookieParams,
+    headerParams,
+    language,
+    pathParams,
+    postman,
+    queryParams,
+    server,
+    auth,
+    mergedLangs,
+  ]);
+  (0, react_1.useEffect)(() => {
+    if (selectedVariant && selectedVariant !== language.variant) {
+      const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
+        queryParams,
+        pathParams,
+        cookieParams,
+        contentType,
+        accept,
+        headerParams,
+        body,
+        server,
+        auth,
+      });
+      postman_code_generators_1.default.convert(
+        language.language,
+        selectedVariant,
+        postmanRequest,
+        language.options,
+        (error, snippet) => {
+          if (error) {
+            return;
+          }
+          setCodeText(snippet);
+        }
+      );
+    }
+  });
+  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,
+        },
+        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}`,
+            },
+          },
+          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,
+              lazy: true,
+            },
+            lang.variants.map((variant) => {
+              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;