docusaurus-theme-openapi-docs 0.0.0-beta.646 → 0.0.0-beta.651

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

@@ -5,13 +5,58 @@
  * 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 });
-const react_1 = __importDefault(require("react"));
+// @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")
@@ -21,20 +66,77 @@ const Authorization_1 = __importDefault(
   require("@theme/ApiDemoPanel/Authorization")
 );
 const Body_1 = __importDefault(require("@theme/ApiDemoPanel/Body"));
-const Execute_1 = __importDefault(require("@theme/ApiDemoPanel/Execute"));
+const buildPostmanRequest_1 = __importDefault(
+  require("@theme/ApiDemoPanel/buildPostmanRequest")
+);
+const ContentType_1 = __importDefault(
+  require("@theme/ApiDemoPanel/ContentType")
+);
 const ParamOptions_1 = __importDefault(
   require("@theme/ApiDemoPanel/ParamOptions")
 );
+const slice_1 = require("@theme/ApiDemoPanel/Response/slice");
 const Server_1 = __importDefault(require("@theme/ApiDemoPanel/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 response = (0, hooks_1.useTypedSelector)(
-    (state) => state.response.value
-  );
   const postman = new postman_collection_1.default.Request(item.postman);
   const metadata = (0, internal_1.useDoc)();
-  const { proxy, hide_send_button } = metadata.frontMatter;
-  const params = {
+  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: [],
@@ -42,45 +144,222 @@ function Request({ item }) {
   };
   item.parameters?.forEach((param) => {
     const paramType = param.in;
-    const paramsArray = params[paramType];
+    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_1.default.Fragment,
-    null,
+    react_hook_form_1.FormProvider,
+    { ...methods },
     react_1.default.createElement(
-      "details",
-      { className: "openapi-demo__details", open: response ? false : true },
+      "form",
+      {
+        className: "openapi-demo__request-form",
+        onSubmit: methods.handleSubmit(onSubmit),
+      },
       react_1.default.createElement(
-        "summary",
-        { className: "openapi-demo__summary-container" },
+        "div",
+        { className: "openapi-demo__request-header-container" },
         react_1.default.createElement(
-          "div",
-          { className: "openapi-demo__summary-content" },
-          react_1.default.createElement(
-            "h4",
-            { className: "openapi-demo__summary-header" },
-            "Request"
-          ),
-          item.servers &&
-            !hide_send_button &&
-            react_1.default.createElement(Execute_1.default, {
-              postman: postman,
-              proxy: proxy,
-            })
-        )
+          "span",
+          { className: "openapi-demo__request-title" },
+          "Request "
+        ),
+        allDetailsExpanded
+          ? react_1.default.createElement(
+              "span",
+              {
+                className: "openapi-demo__expand-details-btn",
+                onClick: collapseAllDetails,
+              },
+              "Collapse all"
+            )
+          : react_1.default.createElement(
+              "span",
+              {
+                className: "openapi-demo__expand-details-btn",
+                onClick: expandAllDetails,
+              },
+              "Expand all"
+            )
       ),
       react_1.default.createElement(
         "div",
-        { className: "openapi-demo__options-panel" },
-        react_1.default.createElement(Server_1.default, null),
-        react_1.default.createElement(Authorization_1.default, null),
-        react_1.default.createElement(ParamOptions_1.default, null),
-        react_1.default.createElement(Body_1.default, {
-          jsonRequestBodyExample: item.jsonRequestBodyExample,
-          requestBodyMetadata: item.requestBody,
-        }),
-        react_1.default.createElement(Accept_1.default, null)
+        { className: "openapi-demo__details-outer-container" },
+        showServerOptions &&
+          react_1.default.createElement(
+            "details",
+            {
+              open: expandServer,
+              className: "openapi-demo__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-demo__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-demo__details-container" },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-demo__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-demo__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-demo__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-demo__details-container" },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-demo__details-summary",
+                onClick: (e) => {
+                  e.preventDefault();
+                  setExpandBody(!expandBody);
+                },
+              },
+              "Body",
+              " ",
+              requestBodyRequired &&
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  react_1.default.createElement(
+                    "small",
+                    null,
+                    react_1.default.createElement(
+                      "strong",
+                      { className: "request-body required" },
+                      " ",
+                      "required"
+                    )
+                  )
+                )
+            ),
+            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-demo__details-container",
+            },
+            react_1.default.createElement(
+              "summary",
+              {
+                className: "openapi-demo__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-demo__request-btn", type: "submit" },
+            "Send API Request"
+          )
       )
     )
   );

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

@@ -1,3 +1,57 @@
+.openapi-demo__response-container {
+  background-color: var(--ifm-pre-background);
+  border-radius: var(--openapi-card-border-radius);
+  border: 1px solid var(--openapi-demo-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-demo__code-block code {
+    padding-top: 0;
+  }
+}
+
+.openapi-demo__response-title-container {
+  display: flex;
+  justify-content: space-between;
+  border-bottom: 1px solid var(--openapi-demo-border-color);
+  margin: 0;
+  padding: 0.75rem var(--ifm-pre-padding);
+  text-transform: uppercase;
+  font-size: 12px;
+  font-weight: bold;
+}
+
+.openapi-demo__response-placeholder-message {
+  font-size: 12px;
+  padding: 1.25rem;
+  margin-bottom: 0;
+  text-align: center;
+}
+
+.openapi-demo__response-clear-btn {
+  &:hover {
+    cursor: pointer;
+  }
+}
+
+.openapi-demo__loading-container {
+  width: 100%;
+  display: flex;
+  justify-content: center;
+}
+
 .openapi-response__dot::before {
   margin-right: 0.2rem;
   margin-bottom: 0.15rem;

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

@@ -1,3 +1,6 @@
 /// <reference types="react" />
-declare function Response(): JSX.Element | null;
+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/ApiDemoPanel/Response/index.js

@@ -13,6 +13,8 @@ var __importDefault =
 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 hooks_1 = require("@theme/ApiItem/hooks");
 const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
@@ -37,7 +39,9 @@ function formatXml(xml) {
   });
   return formatted.substring(1, formatted.length - 3);
 }
-function Response() {
+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)(
@@ -55,43 +59,41 @@ function Response() {
         : parseInt(code) >= 200 && parseInt(code) < 300
         ? "openapi-response__dot--success"
         : "openapi-response__dot--info");
-  if (response === undefined) {
+  if (!item.servers || hideSendButton) {
     return null;
   }
   let prettyResponse = response;
-  try {
-    prettyResponse = JSON.stringify(JSON.parse(response), null, 2);
-  } catch {
-    if (response.startsWith("<")) {
-      prettyResponse = formatXml(response);
+  if (prettyResponse) {
+    try {
+      prettyResponse = JSON.stringify(JSON.parse(response), null, 2);
+    } catch {
+      if (response.startsWith("<")) {
+        prettyResponse = formatXml(response);
+      }
     }
   }
   return react_1.default.createElement(
-    "details",
-    { className: "openapi-demo__details", open: true },
+    "div",
+    { className: "openapi-demo__response-container" },
     react_1.default.createElement(
-      "summary",
-      { className: "openapi-demo__summary-container" },
+      "div",
+      { className: "openapi-demo__response-title-container" },
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-demo__response-title" },
+        "Response"
+      ),
       react_1.default.createElement(
-        "div",
-        { className: "openapi-demo__summary-content" },
-        react_1.default.createElement(
-          "h4",
-          { className: "openapi-demo__summary-header" },
-          "Response"
-        ),
-        react_1.default.createElement(
-          "button",
-          {
-            className: "button button--sm button--secondary",
-            onClick: () => {
-              dispatch((0, slice_1.clearResponse)());
-              dispatch((0, slice_1.clearCode)());
-              dispatch((0, slice_1.clearHeaders)());
-            },
+        "span",
+        {
+          className: "openapi-demo__response-clear-btn",
+          onClick: () => {
+            dispatch((0, slice_1.clearResponse)());
+            dispatch((0, slice_1.clearCode)());
+            dispatch((0, slice_1.clearHeaders)());
           },
-          "Clear"
-        )
+        },
+        "Clear"
       )
     ),
     react_1.default.createElement(
@@ -130,7 +132,18 @@ function Response() {
                     "openapi-demo__code-block openapi-response__status-code",
                   language: response.startsWith("<") ? `xml` : `json`,
                 },
-                prettyResponse || "No Response"
+                prettyResponse ||
+                  react_1.default.createElement(
+                    "p",
+                    { className: "openapi-demo__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(
@@ -147,7 +160,19 @@ function Response() {
               )
             )
           )
-        : prettyResponse || "No Response"
+        : prettyResponse === "Fetching..."
+        ? react_1.default.createElement(
+            "div",
+            { className: "openapi-demo__loading-container" },
+            react_1.default.createElement(react_2.Loading, { color: "success" })
+          )
+        : react_1.default.createElement(
+            "p",
+            { className: "openapi-demo__response-placeholder-message" },
+            "Click the ",
+            react_1.default.createElement("code", null, "Send API Request"),
+            " button above and see the response here!"
+          )
     )
   );
 }

package/lib/theme/ApiDemoPanel/Server/_Server.scss

@@ -14,3 +14,13 @@
     display: none;
   }
 }
+
+.openapi-demo__server-url {
+  font-size: var(--openapi-demo-font-size-input);
+  font-family: var(--ifm-font-family-monospace);
+}
+
+.openapi-demo__server-description {
+  padding-left: 0.5rem;
+  font-weight: var(--ifm-font-weight-bold);
+}

package/lib/theme/ApiDemoPanel/Server/index.js

@@ -109,16 +109,11 @@ function Server() {
       { onClick: () => setIsEditing(true), label: "Edit" },
       react_1.default.createElement(
         FormItem_1.default,
-        { label: "Base URL" },
+        null,
         react_1.default.createElement(
-          "pre",
-          {
-            style: {
-              background: "var(--openapi-card-background-color)",
-              paddingLeft: "0px",
-            },
-          },
-          react_1.default.createElement("code", { title: url }, url)
+          "span",
+          { className: "openapi-demo__server-url", title: url },
+          url
         )
       )
     );
@@ -131,7 +126,7 @@ function Server() {
       { onClick: () => setIsEditing(false), label: "Hide" },
       react_1.default.createElement(
         FormItem_1.default,
-        { label: "Base URL" },
+        null,
         react_1.default.createElement(FormSelect_1.default, {
           options: options.map((s) => s.url),
           onChange: (e) => {
@@ -145,7 +140,11 @@ function Server() {
           },
           value: value?.url,
         }),
-        react_1.default.createElement("small", null, value?.description)
+        react_1.default.createElement(
+          "small",
+          { className: "openapi-demo__server-description" },
+          value?.description
+        )
       ),
       value?.variables &&
         Object.keys(value.variables).map((key) => {

package/lib/theme/ApiDemoPanel/index.js

@@ -28,7 +28,7 @@ function ApiDemoPanel({ item, infoPath }) {
       codeSamples: item["x-code-samples"] ?? [],
     }),
     react_1.default.createElement(Request_1.default, { item: item }),
-    react_1.default.createElement(Response_1.default, null)
+    react_1.default.createElement(Response_1.default, { item: item })
   );
 }
 exports.default = ApiDemoPanel;

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -51,7 +51,6 @@
 
 .openapi-tabs__schema-container {
   width: 100%;
-  margin-top: 1rem;
   display: flex;
   align-items: center;
   overflow: hidden;