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

package/src/theme/ApiExplorer/Request/_Request.scss

@@ -0,0 +1,122 @@
+.openapi-explorer__request-form {
+  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;
+
+  /* hack for view calculation when monaco is hidden */
+  position: relative;
+
+  &:empty {
+    display: none;
+  }
+
+  &: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);
+  }
+
+  .required {
+    font-size: var(--ifm-code-font-size);
+    color: var(--openapi-required);
+
+    &.request-body {
+      padding-left: 0.25rem;
+    }
+  }
+}
+
+.openapi-explorer__request-header-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__expand-details-btn {
+  &:hover {
+    cursor: pointer;
+  }
+}
+
+.openapi-explorer__details-outer-container {
+  padding: 1rem;
+}
+
+.openapi-explorer__details-container[open] {
+  .openapi-explorer__details-summary::before {
+    transform: rotate(180deg);
+    margin-top: 0.25rem;
+  }
+}
+
+.openapi-explorer__details-summary {
+  display: inline-flex;
+  align-items: center;
+  padding: 0.35rem 0;
+  font-size: 14px;
+  list-style: none;
+
+  &:hover {
+    cursor: pointer;
+  }
+
+  &::-webkit-details-marker {
+    display: none;
+  }
+
+  &::before {
+    margin-right: 0.25rem;
+    margin-bottom: 0.25rem;
+    margin-top: 0.25rem;
+    background-image: var(--openapi-explorer-caret-bg);
+    border: none !important;
+    transform: rotate(90deg);
+    content: "";
+    height: 1rem;
+    width: 1rem;
+  }
+}
+
+.openapi-explorer__request-btn {
+  border: none;
+  border-radius: var(--ifm-global-radius);
+  padding: 0.5rem 1rem;
+  margin-top: 1rem;
+  background-color: var(--ifm-color-primary-light);
+  text-transform: uppercase;
+  font-weight: bold;
+  font-size: 12px;
+  color: white;
+  cursor: pointer;
+  transition: 300ms;
+
+  &:hover {
+    background-color: var(--ifm-color-primary-lightest);
+  }
+
+  &:active {
+    background-color: var(--ifm-color-primary-light);
+  }
+}
+
+// Prevent auto zoom on mobile iOS devices when focusing on input elmenents
+@media screen and (-webkit-min-device-pixel-ratio: 0) and (max-device-width: 1024px) {
+  .prism-code,
+  select,
+  input {
+    font-size: 1rem;
+  }
+}

package/src/theme/ApiExplorer/Request/index.tsx

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

package/src/theme/{ApiDemoPanel/Execute → ApiExplorer/Request}/makeRequest.ts

@@ -6,7 +6,7 @@
  * ========================================================================== */
 
 import sdk from "@paloaltonetworks/postman-collection";
-import { Body } from "@theme/ApiDemoPanel/Body/slice";
+import { Body } from "@theme/ApiExplorer/Body/slice";
 
 function fetchWithtimeout(
   url: string,
@@ -152,11 +152,14 @@ async function makeRequest(
         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);
             }
           }
         }
@@ -188,7 +191,7 @@ async function makeRequest(
 
   return await fetchWithtimeout(finalUrl, requestOptions).then(
     (response: any) => {
-      return response.text();
+      return response;
     }
   );
 }

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

@@ -0,0 +1,119 @@
+.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;
+}
+
+/* loading spinner */
+.openapi-response__lds-ring {
+  display: inline-block;
+  position: relative;
+  width: 80px;
+  height: 80px;
+}
+.openapi-response__lds-ring div {
+  box-sizing: border-box;
+  display: block;
+  position: absolute;
+  width: 64px;
+  height: 64px;
+  margin: 8px;
+  border: 5px solid #dfc;
+  border-radius: 50%;
+  animation: openapi-response__lds-ring 1.2s cubic-bezier(0.5, 0, 0.5, 1)
+    infinite;
+  border-color: var(--ifm-color-primary) transparent transparent transparent;
+}
+.openapi-response__lds-ring div:nth-child(1) {
+  animation-delay: -0.45s;
+}
+.openapi-response__lds-ring div:nth-child(2) {
+  animation-delay: -0.3s;
+}
+.openapi-response__lds-ring div:nth-child(3) {
+  animation-delay: -0.15s;
+}
+@keyframes openapi-response__lds-ring {
+  0% {
+    transform: rotate(0deg);
+  }
+  100% {
+    transform: rotate(360deg);
+  }
+}