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

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

@@ -0,0 +1,363 @@
+"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 });
+// @ts-nocheck
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const postman_collection_1 = __importDefault(
+  require("@paloaltonetworks/postman-collection")
+);
+const Accept_1 = __importDefault(require("@theme/ApiExplorer/Accept"));
+const Authorization_1 = __importDefault(
+  require("@theme/ApiExplorer/Authorization")
+);
+const Body_1 = __importDefault(require("@theme/ApiExplorer/Body"));
+const buildPostmanRequest_1 = __importDefault(
+  require("@theme/ApiExplorer/buildPostmanRequest")
+);
+const ContentType_1 = __importDefault(
+  require("@theme/ApiExplorer/ContentType")
+);
+const ParamOptions_1 = __importDefault(
+  require("@theme/ApiExplorer/ParamOptions")
+);
+const slice_1 = require("@theme/ApiExplorer/Response/slice");
+const Server_1 = __importDefault(require("@theme/ApiExplorer/Server"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const react_hook_form_1 = require("react-hook-form");
+const makeRequest_1 = __importDefault(require("./makeRequest"));
+function Request({ item }) {
+  const postman = new postman_collection_1.default.Request(item.postman);
+  const metadata = (0, internal_1.useDoc)();
+  const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;
+  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 contentType = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  const headerParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.header
+  );
+  const body = (0, hooks_1.useTypedSelector)((state) => state.body);
+  const accept = (0, hooks_1.useTypedSelector)((state) => state.accept.value);
+  const acceptOptions = (0, hooks_1.useTypedDispatch)(
+    (state) => state.accept.options
+  );
+  const authSelected = (0, hooks_1.useTypedSelector)(
+    (state) => state.auth.selected
+  );
+  const server = (0, hooks_1.useTypedSelector)((state) => state.server.value);
+  const serverOptions = (0, hooks_1.useTypedSelector)(
+    (state) => state.server.options
+  );
+  const auth = (0, hooks_1.useTypedSelector)((state) => state.auth);
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const [expandAccept, setExpandAccept] = (0, react_1.useState)(true);
+  const [expandAuth, setExpandAuth] = (0, react_1.useState)(true);
+  const [expandBody, setExpandBody] = (0, react_1.useState)(true);
+  const [expandParams, setExpandParams] = (0, react_1.useState)(true);
+  const [expandServer, setExpandServer] = (0, react_1.useState)(true);
+  const allParams = [
+    ...pathParams,
+    ...queryParams,
+    ...cookieParams,
+    ...headerParams,
+  ];
+  const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
+    queryParams,
+    pathParams,
+    cookieParams,
+    contentType,
+    accept,
+    headerParams,
+    body,
+    server,
+    auth,
+  });
+  const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+  const paramsObject = {
+    path: [],
+    query: [],
+    header: [],
+    cookie: [],
+  };
+  item.parameters?.forEach((param) => {
+    const paramType = param.in;
+    const paramsArray = paramsObject[paramType];
+    paramsArray.push(param);
+  });
+  const methods = (0, react_hook_form_1.useForm)({ shouldFocusError: false });
+  const onSubmit = async (data) => {
+    dispatch((0, slice_1.setResponse)("Fetching..."));
+    try {
+      await delay(1200);
+      const res = await (0, makeRequest_1.default)(postmanRequest, proxy, body);
+      dispatch((0, slice_1.setResponse)(await res.text()));
+      dispatch((0, slice_1.setCode)(res.status));
+      res.headers &&
+        dispatch((0, slice_1.setHeaders)(Object.fromEntries(res.headers)));
+    } catch (e) {
+      console.log(e);
+      dispatch((0, slice_1.setResponse)("Connection failed"));
+      dispatch((0, slice_1.clearCode)());
+      dispatch((0, slice_1.clearHeaders)());
+    }
+  };
+  const showServerOptions = serverOptions.length > 0;
+  const showAcceptOptions = acceptOptions.length > 1;
+  const showRequestBody = contentType !== undefined;
+  const showRequestButton = item.servers && !hideSendButton;
+  const showAuth = authSelected !== undefined;
+  const showParams = allParams.length > 0;
+  const requestBodyRequired = item.requestBody?.required;
+  if (
+    !showAcceptOptions &&
+    !showAuth &&
+    !showParams &&
+    !showRequestBody &&
+    !showServerOptions
+  ) {
+    return null;
+  }
+  const expandAllDetails = () => {
+    setExpandAccept(true);
+    setExpandAuth(true);
+    setExpandBody(true);
+    setExpandParams(true);
+    setExpandServer(true);
+  };
+  const collapseAllDetails = () => {
+    setExpandAccept(false);
+    setExpandAuth(false);
+    setExpandBody(false);
+    setExpandParams(false);
+    setExpandServer(false);
+  };
+  const allDetailsExpanded =
+    expandParams && expandBody && expandServer && expandAuth && expandAccept;
+  return react_1.default.createElement(
+    react_hook_form_1.FormProvider,
+    { ...methods },
+    react_1.default.createElement(
+      "form",
+      {
+        className: "openapi-explorer__request-form",
+        onSubmit: methods.handleSubmit(onSubmit),
+      },
+      react_1.default.createElement(
+        "div",
+        { className: "openapi-explorer__request-header-container" },
+        react_1.default.createElement(
+          "span",
+          { className: "openapi-explorer__request-title" },
+          "Request "
+        ),
+        allDetailsExpanded
+          ? react_1.default.createElement(
+              "span",
+              {
+                className: "openapi-explorer__expand-details-btn",
+                onClick: collapseAllDetails,
+              },
+              "Collapse all"
+            )
+          : react_1.default.createElement(
+              "span",
+              {
+                className: "openapi-explorer__expand-details-btn",
+                onClick: expandAllDetails,
+              },
+              "Expand all"
+            )
+      ),
+      react_1.default.createElement(
+        "div",
+        { className: "openapi-explorer__details-outer-container" },
+        showServerOptions &&
+          react_1.default.createElement(
+            "details",
+            {
+              open: expandServer,
+              className: "openapi-explorer__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-explorer__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandServer(!expandServer);
+                },
+              },
+              "Base URL"
+            ),
+            react_1.default.createElement(Server_1.default, null)
+          ),
+        showAuth &&
+          react_1.default.createElement(
+            "details",
+            {
+              open: expandAuth,
+              className: "openapi-explorer__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-explorer__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandAuth(!expandAuth);
+                },
+              },
+              "Auth"
+            ),
+            react_1.default.createElement(Authorization_1.default, null)
+          ),
+        showParams &&
+          react_1.default.createElement(
+            "details",
+            {
+              open:
+                expandParams || Object.keys(methods.formState.errors).length,
+              className: "openapi-explorer__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-explorer__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandParams(!expandParams);
+                },
+              },
+              "Parameters"
+            ),
+            react_1.default.createElement(ParamOptions_1.default, null)
+          ),
+        showRequestBody &&
+          react_1.default.createElement(
+            "details",
+            {
+              open: expandBody,
+              className: "openapi-explorer__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-explorer__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandBody(!expandBody);
+                },
+              },
+              "Body",
+              requestBodyRequired &&
+                react_1.default.createElement(
+                  "span",
+                  { className: "openapi-schema__required" },
+                  "\u00A0required"
+                )
+            ),
+            react_1.default.createElement(
+              react_1.default.Fragment,
+              null,
+              react_1.default.createElement(ContentType_1.default, null),
+              react_1.default.createElement(Body_1.default, {
+                jsonRequestBodyExample: item.jsonRequestBodyExample,
+                requestBodyMetadata: item.requestBody,
+                required: requestBodyRequired,
+              })
+            )
+          ),
+        showAcceptOptions &&
+          react_1.default.createElement(
+            "details",
+            {
+              open: expandAccept,
+              className: "openapi-explorer__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-explorer__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandAccept(!expandAccept);
+                },
+              },
+              "Accept"
+            ),
+            react_1.default.createElement(Accept_1.default, null)
+          ),
+        showRequestButton &&
+          react_1.default.createElement(
+            "button",
+            { className: "openapi-explorer__request-btn", type: "submit" },
+            "Send API Request"
+          )
+      )
+    )
+  );
+}
+exports.default = Request;

package/lib/theme/ApiExplorer/Request/makeRequest.d.ts

@@ -0,0 +1,4 @@
+import sdk from "@paloaltonetworks/postman-collection";
+import { Body } from "@theme/ApiExplorer/Body/slice";
+declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body): Promise<any>;
+export default makeRequest;

package/{lib-next/theme/ApiDemoPanel/Execute → lib/theme/ApiExplorer/Request}/makeRequest.js

@@ -1,10 +1,11 @@
+"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 });
 function fetchWithtimeout(url, options, timeout = 5000) {
   return Promise.race([
     fetch(url, options),
@@ -42,7 +43,6 @@ async function makeRequest(request, proxy, _body) {
       }
     });
   }
-
   // The following code handles multiple files in the same formdata param.
   // It removes the form data params where the src property is an array of filepath strings
   // Splits that array into different form data params with src set as a single filepath string
@@ -113,7 +113,6 @@ async function makeRequest(request, proxy, _body) {
   //     formdata: formdataArray,
   //   });
   // }
-
   const body = request.body?.toJSON();
   let myBody = undefined;
   if (body !== undefined && Object.keys(body).length > 0) {
@@ -134,11 +133,13 @@ async function makeRequest(request, proxy, _body) {
         break;
       }
       case "formdata": {
+        // The Content-Type header will be set automatically based on the type of body.
+        myHeaders.delete("Content-Type");
         myBody = new FormData();
-        if (Array.isArray(body.formdata)) {
-          for (const data of body.formdata) {
-            if (data.key && data.value) {
-              myBody.append(data.key, data.value);
+        if (Array.isArray(request.body.formdata.members)) {
+          for (const data of request.body.formdata.members) {
+            if (data.key && data.value.content) {
+              myBody.append(data.key, data.value.content);
             }
           }
         }
@@ -169,4 +170,4 @@ async function makeRequest(request, proxy, _body) {
     return response;
   });
 }
-export default makeRequest;
+exports.default = makeRequest;

package/lib/theme/ApiExplorer/Response/_Response.scss

@@ -0,0 +1,81 @@
+.openapi-explorer__response-container {
+  background-color: var(--ifm-pre-background);
+  border-radius: var(--openapi-card-border-radius);
+  border: 1px solid var(--openapi-explorer-border-color);
+  box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+    0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
+  color: var(--ifm-pre-color);
+  line-height: var(--ifm-pre-line-height);
+  margin-bottom: var(--ifm-spacing-vertical);
+  margin-top: 0;
+  overflow: auto;
+  transition: 300ms;
+
+  &:hover {
+    box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+      0 2px 3px hsla(222, 8%, 43%, 0.15),
+      0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
+  }
+
+  .openapi-explorer__code-block code {
+    padding-top: 0;
+  }
+}
+
+.openapi-explorer__response-title-container {
+  display: flex;
+  justify-content: space-between;
+  border-bottom: 1px solid var(--openapi-explorer-border-color);
+  margin: 0;
+  padding: 0.75rem var(--ifm-pre-padding);
+  text-transform: uppercase;
+  font-size: 12px;
+  font-weight: bold;
+}
+
+.openapi-explorer__response-placeholder-message {
+  font-size: 12px;
+  padding: 1.25rem;
+  margin-bottom: 0;
+  text-align: center;
+}
+
+.openapi-explorer__response-clear-btn {
+  &:hover {
+    cursor: pointer;
+  }
+}
+
+.openapi-explorer__loading-container {
+  width: 100%;
+  display: flex;
+  justify-content: center;
+}
+
+.openapi-response__dot::before {
+  margin-right: 0.2rem;
+  margin-bottom: 0.15rem;
+  content: "⬤";
+  color: var(--ifm-color-primary);
+  font-size: 8px;
+}
+
+.openapi-response__dot--danger::before {
+  color: var(--ifm-color-danger);
+}
+
+.openapi-response__dot--success::before {
+  color: var(--ifm-color-success);
+}
+
+.openapi-response__dot--info::before {
+  color: var(--ifm-color-info);
+}
+
+.openapi-response__status-code {
+  margin-left: -1rem;
+}
+
+.openapi-response__status-headers {
+  margin-left: -1rem;
+}

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+declare function Response({ item }: {
+    item: NonNullable<ApiItem>;
+}): JSX.Element | null;
+export default Response;

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

@@ -0,0 +1,184 @@
+"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 theme_common_1 = require("@docusaurus/theme-common");
+const internal_1 = require("@docusaurus/theme-common/internal");
+const react_2 = require("@nextui-org/react");
+const ApiCodeBlock_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock")
+);
+const hooks_1 = require("@theme/ApiItem/hooks");
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const clsx_1 = __importDefault(require("clsx"));
+const slice_1 = require("./slice");
+// TODO: We probably shouldn't attempt to format XML...
+function formatXml(xml) {
+  const tab = "  ";
+  let formatted = "";
+  let indent = "";
+  xml.split(/>\s*</).forEach((node) => {
+    if (node.match(/^\/\w/)) {
+      // decrease indent by one 'tab'
+      indent = indent.substring(tab.length);
+    }
+    formatted += indent + "<" + node + ">\r\n";
+    if (node.match(/^<?\w[^>]*[^/]$/)) {
+      // increase indent
+      indent += tab;
+    }
+  });
+  return formatted.substring(1, formatted.length - 3);
+}
+function Response({ item }) {
+  const metadata = (0, internal_1.useDoc)();
+  const hideSendButton = metadata.frontMatter.hide_send_button;
+  const prismTheme = (0, theme_common_1.usePrismTheme)();
+  const code = (0, hooks_1.useTypedSelector)((state) => state.response.code);
+  const headers = (0, hooks_1.useTypedSelector)(
+    (state) => state.response.headers
+  );
+  const response = (0, hooks_1.useTypedSelector)(
+    (state) => state.response.value
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const responseStatusClass =
+    code &&
+    "openapi-response__dot " +
+      (parseInt(code) >= 400
+        ? "openapi-response__dot--danger"
+        : parseInt(code) >= 200 && parseInt(code) < 300
+        ? "openapi-response__dot--success"
+        : "openapi-response__dot--info");
+  if (!item.servers || hideSendButton) {
+    return null;
+  }
+  let prettyResponse = response;
+  if (prettyResponse) {
+    try {
+      prettyResponse = JSON.stringify(JSON.parse(response), null, 2);
+    } catch {
+      if (response.startsWith("<")) {
+        prettyResponse = formatXml(response);
+      }
+    }
+  }
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-explorer__response-container" },
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-explorer__response-title-container" },
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-explorer__response-title" },
+        "Response"
+      ),
+      react_1.default.createElement(
+        "span",
+        {
+          className: "openapi-explorer__response-clear-btn",
+          onClick: () => {
+            dispatch((0, slice_1.clearResponse)());
+            dispatch((0, slice_1.clearCode)());
+            dispatch((0, slice_1.clearHeaders)());
+          },
+        },
+        "Clear"
+      )
+    ),
+    react_1.default.createElement(
+      "div",
+      {
+        style: {
+          backgroundColor: prismTheme.plain.backgroundColor,
+          paddingLeft: "1rem",
+          paddingTop: "1rem",
+          ...((prettyResponse === "Fetching..." || !code) && {
+            paddingBottom: "1rem",
+          }),
+        },
+      },
+      code && prettyResponse !== "Fetching..."
+        ? react_1.default.createElement(
+            SchemaTabs_1.default,
+            { lazy: true },
+            react_1.default.createElement(
+              TabItem_1.default,
+              {
+                label: ` ${code}`,
+                value: "body",
+                attributes: {
+                  className: (0, clsx_1.default)(
+                    "openapi-response__dot",
+                    responseStatusClass
+                  ),
+                },
+                default: true,
+              },
+              react_1.default.createElement(
+                ApiCodeBlock_1.default,
+                {
+                  className:
+                    "openapi-explorer__code-block openapi-response__status-code",
+                  language: response.startsWith("<") ? `xml` : `json`,
+                },
+                prettyResponse ||
+                  react_1.default.createElement(
+                    "p",
+                    {
+                      className:
+                        "openapi-explorer__response-placeholder-message",
+                    },
+                    "Click the ",
+                    react_1.default.createElement(
+                      "code",
+                      null,
+                      "Send API Request"
+                    ),
+                    " button above and see the response here!"
+                  )
+              )
+            ),
+            react_1.default.createElement(
+              TabItem_1.default,
+              { label: "Headers", value: "headers" },
+              react_1.default.createElement(
+                ApiCodeBlock_1.default,
+                {
+                  className:
+                    "openapi-explorer__code-block openapi-response__status-headers",
+                  language: response.startsWith("<") ? `xml` : `json`,
+                },
+                JSON.stringify(headers, undefined, 2)
+              )
+            )
+          )
+        : prettyResponse === "Fetching..."
+        ? react_1.default.createElement(
+            "div",
+            { className: "openapi-explorer__loading-container" },
+            react_1.default.createElement(react_2.Loading, { color: "success" })
+          )
+        : react_1.default.createElement(
+            "p",
+            { className: "openapi-explorer__response-placeholder-message" },
+            "Click the ",
+            react_1.default.createElement("code", null, "Send API Request"),
+            " button above and see the response here!"
+          )
+    )
+  );
+}
+exports.default = Response;