docusaurus-theme-openapi-docs 2.0.0-beta.1 → 2.0.0-beta.3

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

@@ -1,31 +1,34 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _themeCommon = require("@docusaurus/theme-common");
-var _hooks = require("@theme/ApiItem/hooks");
-var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
-var _SchemaTabs = _interopRequireDefault(require("@theme/SchemaTabs"));
-var _TabItem = _interopRequireDefault(require("@theme/TabItem"));
-var _clsx = _interopRequireDefault(require("clsx"));
-var _slice = require("./slice");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /* ============================================================================
  * 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/ApiDemoPanel/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 => {
+  xml.split(/>\s*</).forEach((node) => {
     if (node.match(/^\/\w/)) {
       // decrease indent by one 'tab'
       indent = indent.substring(tab.length);
@@ -38,64 +41,141 @@ function formatXml(xml) {
   });
   return formatted.substring(1, formatted.length - 3);
 }
-function Response() {
-  const prismTheme = (0, _themeCommon.usePrismTheme)();
-  const code = (0, _hooks.useTypedSelector)(state => state.response.code);
-  const headers = (0, _hooks.useTypedSelector)(state => state.response.headers);
-  const response = (0, _hooks.useTypedSelector)(state => state.response.value);
-  const dispatch = (0, _hooks.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 (response === undefined) {
+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;
-  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 <details className="openapi-demo__details" open={true}>
-      <summary className="openapi-demo__summary-container">
-        <div className="openapi-demo__summary-content">
-          <h4 className="openapi-demo__summary-header">Response</h4>
-          <button className="button button--sm button--secondary" onClick={() => {
-          dispatch((0, _slice.clearResponse)());
-          dispatch((0, _slice.clearCode)());
-          dispatch((0, _slice.clearHeaders)());
-        }}>
-            Clear
-          </button>
-        </div>
-      </summary>
-
-      <div style={{
-      backgroundColor: prismTheme.plain.backgroundColor,
-      paddingLeft: "1rem",
-      paddingTop: "1rem",
-      ...((prettyResponse === "Fetching..." || !code) && {
-        paddingBottom: "1rem"
-      })
-    }}>
-        {code && prettyResponse !== "Fetching..." ? <_SchemaTabs.default lazy>
-            {/* @ts-ignore */}
-            <_TabItem.default label={` ${code}`} value="body" attributes={{
-          className: (0, _clsx.default)("openapi-response__dot", responseStatusClass)
-        }} default>
-              <_CodeBlock.default className="openapi-response__status-code" language={response.startsWith("<") ? `xml` : `json`}>
-                {prettyResponse || "No Response"}
-              </_CodeBlock.default>
-            </_TabItem.default>
-            {/* @ts-ignore */}
-            <_TabItem.default label="Headers" value="headers">
-              <_CodeBlock.default className="openapi-response__status-headers" language={response.startsWith("<") ? `xml` : `json`}>
-                {JSON.stringify(headers, undefined, 2)}
-              </_CodeBlock.default>
-            </_TabItem.default>
-          </_SchemaTabs.default> : prettyResponse || "No Response"}
-      </div>
-    </details>;
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-demo__response-container" },
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-demo__response-title-container" },
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-demo__response-title" },
+        "Response"
+      ),
+      react_1.default.createElement(
+        "span",
+        {
+          className: "openapi-demo__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-demo__code-block openapi-response__status-code",
+                  language: response.startsWith("<") ? `xml` : `json`,
+                },
+                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(
+              TabItem_1.default,
+              { label: "Headers", value: "headers" },
+              react_1.default.createElement(
+                ApiCodeBlock_1.default,
+                {
+                  className:
+                    "openapi-demo__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-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!"
+          )
+    )
+  );
 }
-var _default = Response;
-exports.default = _default;
+exports.default = Response;

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

@@ -0,0 +1,17 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface State {
+    value?: string;
+    code?: string;
+    headers?: string;
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<State, {
+    setResponse: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+    setCode: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+    setHeaders: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+    clearResponse: (state: import("immer/dist/internal").WritableDraft<State>) => void;
+    clearCode: (state: import("immer/dist/internal").WritableDraft<State>) => void;
+    clearHeaders: (state: import("immer/dist/internal").WritableDraft<State>) => void;
+}, "response">;
+export declare const setResponse: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "response/setResponse">, clearResponse: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"response/clearResponse">, setCode: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "response/setCode">, clearCode: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"response/clearCode">, setHeaders: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "response/setHeaders">, clearHeaders: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"response/clearHeaders">;
+declare const _default: import("redux").Reducer<State, import("redux").AnyAction>;
+export default _default;

package/lib/theme/ApiDemoPanel/Response/slice.js

@@ -1,19 +1,23 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.slice = exports.setResponse = exports.setHeaders = exports.setCode = exports.default = exports.clearResponse = exports.clearHeaders = exports.clearCode = void 0;
-var _toolkit = require("@reduxjs/toolkit");
 /* ============================================================================
  * 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.clearHeaders =
+  exports.setHeaders =
+  exports.clearCode =
+  exports.setCode =
+  exports.clearResponse =
+  exports.setResponse =
+  exports.slice =
+    void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
 const initialState = {};
-const slice = (0, _toolkit.createSlice)({
+exports.slice = (0, toolkit_1.createSlice)({
   name: "response",
   initialState,
   reducers: {
@@ -26,31 +30,22 @@ const slice = (0, _toolkit.createSlice)({
     setHeaders: (state, action) => {
       state.headers = action.payload;
     },
-    clearResponse: state => {
+    clearResponse: (state) => {
       state.value = undefined;
     },
-    clearCode: state => {
+    clearCode: (state) => {
       state.code = undefined;
     },
-    clearHeaders: state => {
+    clearHeaders: (state) => {
       state.headers = undefined;
-    }
-  }
+    },
+  },
 });
-exports.slice = slice;
-const {
-  setResponse,
-  clearResponse,
-  setCode,
-  clearCode,
-  setHeaders,
-  clearHeaders
-} = slice.actions;
-exports.clearHeaders = clearHeaders;
-exports.setHeaders = setHeaders;
-exports.clearCode = clearCode;
-exports.setCode = setCode;
-exports.clearResponse = clearResponse;
-exports.setResponse = setResponse;
-var _default = slice.reducer;
-exports.default = _default;
+(_a = exports.slice.actions),
+  (exports.setResponse = _a.setResponse),
+  (exports.clearResponse = _a.clearResponse),
+  (exports.setCode = _a.setCode),
+  (exports.clearCode = _a.clearCode),
+  (exports.setHeaders = _a.setHeaders),
+  (exports.clearHeaders = _a.clearHeaders);
+exports.default = exports.slice.reducer;

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

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare function SecuritySchemes(props: any): JSX.Element | null;
+export default SecuritySchemes;