docusaurus-theme-openapi-docs 0.0.0-1000

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

@@ -0,0 +1,121 @@
+.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);
+  }
+}

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

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

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

@@ -0,0 +1,193 @@
+"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 client_1 = require("@docusaurus/plugin-content-docs/client");
+const theme_common_1 = require("@docusaurus/theme-common");
+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, client_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:
+            code && prettyResponse !== "Fetching..."
+              ? prismTheme.plain.backgroundColor
+              : "transparent",
+          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(
+                "div",
+                { className: "openapi-response__lds-ring" },
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null)
+              )
+            )
+          : 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;

package/lib/theme/ApiExplorer/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>;
+export default _default;

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

@@ -0,0 +1,51 @@
+"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 _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 = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "response",
+  initialState,
+  reducers: {
+    setResponse: (state, action) => {
+      state.value = action.payload;
+    },
+    setCode: (state, action) => {
+      state.code = action.payload;
+    },
+    setHeaders: (state, action) => {
+      state.headers = action.payload;
+    },
+    clearResponse: (state) => {
+      state.value = undefined;
+    },
+    clearCode: (state) => {
+      state.code = undefined;
+    },
+    clearHeaders: (state) => {
+      state.headers = undefined;
+    },
+  },
+});
+(_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/ApiExplorer/SecuritySchemes/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare function SecuritySchemes(props: any): React.JSX.Element | null;
+export default SecuritySchemes;