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

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

@@ -0,0 +1,190 @@
+"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 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(
+              "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, import("redux").AnyAction>;
+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 @@
+/// <reference types="react" />
+declare function SecuritySchemes(props: any): JSX.Element | null;
+export default SecuritySchemes;

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

@@ -0,0 +1,380 @@
+"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 Link_1 = __importDefault(require("@docusaurus/Link"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+function SecuritySchemes(props) {
+  const options = (0, hooks_1.useTypedSelector)((state) => state.auth.options);
+  const selected = (0, hooks_1.useTypedSelector)(
+    (state) => state.auth.selected
+  );
+  const infoAuthPath = `/${props.infoPath}#authentication`;
+  if (selected === undefined) return null;
+  if (options[selected]?.[0]?.type === undefined) {
+    return null;
+  }
+  const selectedAuth = options[selected];
+  return react_1.default.createElement(
+    "details",
+    { className: "openapi-security__details", open: false },
+    react_1.default.createElement(
+      "summary",
+      { className: "openapi-security__summary-container" },
+      react_1.default.createElement(
+        "h4",
+        { className: "openapi-security__summary-header" },
+        "Authorization: ",
+        selectedAuth[0].name ?? selectedAuth[0].type
+      )
+    ),
+    selectedAuth.map((auth) => {
+      const isHttp = auth.type === "http";
+      const isApiKey = auth.type === "apiKey";
+      const isOauth2 = auth.type === "oauth2";
+      const isOpenId = auth.type === "openIdConnect";
+      if (isHttp) {
+        if (auth.scheme === "bearer") {
+          const { name, key, type, scopes, ...rest } = auth;
+          return react_1.default.createElement(
+            react_1.default.Fragment,
+            { key: auth.key },
+            react_1.default.createElement(
+              "pre",
+              {
+                style: {
+                  display: "flex",
+                  flexDirection: "column",
+                  background: "var(--openapi-card-background-color)",
+                },
+              },
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "name:"),
+                " ",
+                react_1.default.createElement(
+                  Link_1.default,
+                  { to: infoAuthPath },
+                  name ?? key
+                )
+              ),
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "type: "),
+                type
+              ),
+              scopes &&
+                scopes.length > 0 &&
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  react_1.default.createElement("strong", null, "scopes: "),
+                  react_1.default.createElement(
+                    "code",
+                    null,
+                    auth.scopes.length > 0 ? auth.scopes.toString() : "[]"
+                  )
+                ),
+              Object.keys(rest).map((k, i) => {
+                return react_1.default.createElement(
+                  "span",
+                  { key: k },
+                  react_1.default.createElement("strong", null, k, ": "),
+                  typeof rest[k] === "object"
+                    ? JSON.stringify(rest[k], null, 2)
+                    : String(rest[k])
+                );
+              })
+            )
+          );
+        }
+        if (auth.scheme === "basic") {
+          const { name, key, type, scopes, ...rest } = auth;
+          return react_1.default.createElement(
+            react_1.default.Fragment,
+            { key: auth.key },
+            react_1.default.createElement(
+              "pre",
+              {
+                style: {
+                  display: "flex",
+                  flexDirection: "column",
+                  background: "var(--openapi-card-background-color)",
+                },
+              },
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "name:"),
+                " ",
+                react_1.default.createElement(
+                  Link_1.default,
+                  { to: infoAuthPath },
+                  name ?? key
+                )
+              ),
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "type: "),
+                type
+              ),
+              scopes &&
+                scopes.length > 0 &&
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  react_1.default.createElement("strong", null, "scopes: "),
+                  react_1.default.createElement(
+                    "code",
+                    null,
+                    auth.scopes.length > 0 ? auth.scopes.toString() : "[]"
+                  )
+                ),
+              Object.keys(rest).map((k, i) => {
+                return react_1.default.createElement(
+                  "span",
+                  { key: k },
+                  react_1.default.createElement("strong", null, k, ": "),
+                  typeof rest[k] === "object"
+                    ? JSON.stringify(rest[k], null, 2)
+                    : String(rest[k])
+                );
+              })
+            )
+          );
+        }
+        return react_1.default.createElement(
+          react_1.default.Fragment,
+          { key: auth.key },
+          react_1.default.createElement(
+            "pre",
+            {
+              style: {
+                display: "flex",
+                flexDirection: "column",
+                background: "var(--openapi-card-background-color)",
+              },
+            },
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "name:"),
+              " ",
+              react_1.default.createElement(
+                Link_1.default,
+                { to: infoAuthPath },
+                auth.name ?? auth.key
+              )
+            ),
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "type: "),
+              auth.type
+            ),
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "in: "),
+              auth.in
+            )
+          )
+        );
+      }
+      if (isApiKey) {
+        const { name, key, type, scopes, ...rest } = auth;
+        return react_1.default.createElement(
+          react_1.default.Fragment,
+          { key: auth.key },
+          react_1.default.createElement(
+            "pre",
+            {
+              style: {
+                display: "flex",
+                flexDirection: "column",
+                background: "var(--openapi-card-background-color)",
+              },
+            },
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "name:"),
+              " ",
+              react_1.default.createElement(
+                Link_1.default,
+                { to: infoAuthPath },
+                name ?? key
+              )
+            ),
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "type: "),
+              type
+            ),
+            scopes &&
+              scopes.length > 0 &&
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "scopes: "),
+                react_1.default.createElement(
+                  "code",
+                  null,
+                  auth.scopes.length > 0 ? auth.scopes.toString() : "[]"
+                )
+              ),
+            Object.keys(rest).map((k, i) => {
+              return react_1.default.createElement(
+                "span",
+                { key: k },
+                react_1.default.createElement("strong", null, k, ": "),
+                typeof rest[k] === "object"
+                  ? JSON.stringify(rest[k], null, 2)
+                  : String(rest[k])
+              );
+            })
+          )
+        );
+      }
+      if (isOauth2) {
+        const { name, key, type, scopes, flows, ...rest } = auth;
+        return react_1.default.createElement(
+          react_1.default.Fragment,
+          { key: selected },
+          react_1.default.createElement(
+            "pre",
+            {
+              style: {
+                display: "flex",
+                flexDirection: "column",
+                background: "var(--openapi-card-background-color)",
+              },
+            },
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "name:"),
+              " ",
+              react_1.default.createElement(
+                Link_1.default,
+                { to: infoAuthPath },
+                name ?? key
+              )
+            ),
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "type: "),
+              type
+            ),
+            scopes &&
+              scopes.length > 0 &&
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "scopes: "),
+                react_1.default.createElement(
+                  "code",
+                  null,
+                  auth.scopes.length > 0 ? auth.scopes.toString() : "[]"
+                )
+              ),
+            Object.keys(rest).map((k, i) => {
+              return react_1.default.createElement(
+                "span",
+                { key: k },
+                react_1.default.createElement("strong", null, k, ": "),
+                typeof rest[k] === "object"
+                  ? JSON.stringify(rest[k], null, 2)
+                  : String(rest[k])
+              );
+            }),
+            flows &&
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement(
+                  "code",
+                  null,
+                  react_1.default.createElement("strong", null, "flows: "),
+                  JSON.stringify(flows, null, 2)
+                )
+              )
+          )
+        );
+      }
+      if (isOpenId) {
+        const { name, key, scopes, type, ...rest } = auth;
+        return react_1.default.createElement(
+          react_1.default.Fragment,
+          { key: auth.key },
+          react_1.default.createElement(
+            "pre",
+            {
+              style: {
+                display: "flex",
+                flexDirection: "column",
+                background: "var(--openapi-card-background-color)",
+              },
+            },
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "name:"),
+              " ",
+              react_1.default.createElement(
+                Link_1.default,
+                { to: infoAuthPath },
+                name ?? key
+              )
+            ),
+            react_1.default.createElement(
+              "span",
+              null,
+              react_1.default.createElement("strong", null, "type: "),
+              type
+            ),
+            scopes &&
+              scopes.length > 0 &&
+              react_1.default.createElement(
+                "span",
+                null,
+                react_1.default.createElement("strong", null, "scopes: "),
+                react_1.default.createElement(
+                  "code",
+                  null,
+                  auth.scopes.length > 0 ? auth.scopes.toString() : "[]"
+                )
+              ),
+            Object.keys(rest).map((k, i) => {
+              return react_1.default.createElement(
+                "span",
+                { key: k },
+                react_1.default.createElement("strong", null, k, ": "),
+                typeof rest[k] === "object"
+                  ? JSON.stringify(rest[k], null, 2)
+                  : String(rest[k])
+              );
+            })
+          )
+        );
+      }
+      return undefined;
+    })
+  );
+}
+exports.default = SecuritySchemes;

package/{src/theme/ApiDemoPanel/Request/styles.module.css → lib/theme/ApiExplorer/Server/_Server.scss}

@@ -1,8 +1,4 @@
-.optionsPanel:empty {
-  display: none;
-}
-
-.optionsPanel {
+.openapi-explorer__server-container {
   background: var(--openapi-card-background-color);
   border-radius: var(--openapi-card-border-radius);
   color: var(--ifm-pre-color);
@@ -10,9 +6,21 @@
   margin-bottom: var(--ifm-spacing-vertical);
   margin-top: 0;
   overflow: auto;
-  padding-top: 0 !important;
-  padding: var(--ifm-pre-padding);
 
   /* hack for view calculation when monaco is hidden */
   position: relative;
+
+  &:empty {
+    display: none;
+  }
+}
+
+.openapi-explorer__server-url {
+  font-size: var(--openapi-explorer-font-size-input);
+  font-family: var(--ifm-font-family-monospace);
+}
+
+.openapi-explorer__server-description {
+  padding-left: 0.5rem;
+  font-weight: var(--ifm-font-weight-bold);
 }

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

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