docusaurus-theme-openapi-docs 0.0.0-1000

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/lib/theme/ApiExplorer/Server/_Server.scss

@@ -0,0 +1,26 @@
+.openapi-explorer__server-container {
+  background: var(--openapi-card-background-color);
+  border-radius: var(--openapi-card-border-radius);
+  color: var(--ifm-pre-color);
+  line-height: var(--ifm-pre-line-height);
+  margin-bottom: var(--ifm-spacing-vertical);
+  margin-top: 0;
+  overflow: auto;
+
+  /* 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 @@
+import React from "react";
+declare function Server(): React.JSX.Element | null;
+export default Server;

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

@@ -0,0 +1,199 @@
+"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 __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 () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __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 = __importStar(require("react"));
+const FloatingButton_1 = __importDefault(
+  require("@theme/ApiExplorer/FloatingButton")
+);
+const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
+const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const FormTextInput_1 = __importDefault(
+  require("@theme/ApiExplorer/FormTextInput")
+);
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("./slice");
+function Server() {
+  const [isEditing, setIsEditing] = (0, react_1.useState)(false);
+  const value = (0, hooks_1.useTypedSelector)((state) => state.server.value);
+  const options = (0, hooks_1.useTypedSelector)(
+    (state) => state.server.options
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (options.length <= 0) {
+    return null;
+  }
+  if (options.length < 1 && value?.variables === undefined) {
+    return null;
+  }
+  if (!value) {
+    const defaultOption = options[0];
+    dispatch((0, slice_1.setServer)(JSON.stringify(defaultOption)));
+  }
+  // Default to first option when existing server state is mismatched
+  if (value) {
+    const urlExists = options.find((s) => s.url === value.url);
+    if (!urlExists) {
+      const defaultOption = options[0];
+      dispatch((0, slice_1.setServer)(JSON.stringify(defaultOption)));
+    }
+  }
+  if (!isEditing) {
+    let url = "";
+    if (value) {
+      url = value.url.replace(/\/$/, "");
+      if (value.variables) {
+        Object.keys(value.variables).forEach((variable) => {
+          url = url.replace(
+            `{${variable}}`,
+            value.variables?.[variable].default ?? ""
+          );
+        });
+      }
+    }
+    return react_1.default.createElement(
+      FloatingButton_1.default,
+      { onClick: () => setIsEditing(true), label: "Edit" },
+      react_1.default.createElement(
+        FormItem_1.default,
+        null,
+        react_1.default.createElement(
+          "span",
+          { className: "openapi-explorer__server-url", title: url },
+          url
+        )
+      )
+    );
+  }
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-explorer__server-container" },
+    react_1.default.createElement(
+      FloatingButton_1.default,
+      { onClick: () => setIsEditing(false), label: "Hide" },
+      react_1.default.createElement(
+        FormItem_1.default,
+        null,
+        react_1.default.createElement(FormSelect_1.default, {
+          options: options.map((s) => s.url),
+          onChange: (e) => {
+            dispatch(
+              (0, slice_1.setServer)(
+                JSON.stringify(
+                  options.filter((s) => s.url === e.target.value)[0]
+                )
+              )
+            );
+          },
+          value: value?.url,
+        }),
+        react_1.default.createElement(
+          "small",
+          { className: "openapi-explorer__server-description" },
+          value?.description
+        )
+      ),
+      value?.variables &&
+        Object.keys(value.variables).map((key) => {
+          if (value.variables?.[key].enum !== undefined) {
+            return react_1.default.createElement(
+              FormItem_1.default,
+              { label: key },
+              react_1.default.createElement(FormSelect_1.default, {
+                options: value.variables[key].enum,
+                onChange: (e) => {
+                  dispatch(
+                    (0, slice_1.setServerVariable)(
+                      JSON.stringify({ key, value: e.target.value })
+                    )
+                  );
+                },
+                value: value?.variables[key].default,
+              })
+            );
+          }
+          return react_1.default.createElement(
+            FormItem_1.default,
+            { label: key },
+            react_1.default.createElement(FormTextInput_1.default, {
+              placeholder: value.variables?.[key].default,
+              onChange: (e) => {
+                dispatch(
+                  (0, slice_1.setServerVariable)(
+                    JSON.stringify({ key, value: e.target.value })
+                  )
+                );
+              },
+              value: value?.variables?.[key].default,
+            })
+          );
+        })
+    )
+  );
+}
+exports.default = Server;

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

@@ -0,0 +1,13 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+export interface State {
+    value?: ServerObject;
+    options: ServerObject[];
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<State, {
+    setServer: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+    setServerVariable: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+}, "server">;
+export declare const setServer: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "server/setServer">, setServerVariable: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "server/setServerVariable">;
+declare const _default: import("redux").Reducer<State>;
+export default _default;

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

@@ -0,0 +1,33 @@
+"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.setServerVariable = exports.setServer = exports.slice = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "server",
+  initialState,
+  reducers: {
+    setServer: (state, action) => {
+      state.value = state.options.find(
+        (s) => s.url === JSON.parse(action.payload).url
+      );
+    },
+    setServerVariable: (state, action) => {
+      if (state.value?.variables) {
+        const parsedPayload = JSON.parse(action.payload);
+        state.value.variables[parsedPayload.key].default = parsedPayload.value;
+      }
+    },
+  },
+});
+(_a = exports.slice.actions),
+  (exports.setServer = _a.setServer),
+  (exports.setServerVariable = _a.setServerVariable);
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/buildPostmanRequest.d.ts

@@ -0,0 +1,20 @@
+import { AuthState } from "@theme/ApiExplorer/Authorization/slice";
+import { Body } from "@theme/ApiExplorer/Body/slice";
+import { ParameterObject, ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+import sdk from "postman-collection";
+type Param = {
+    value?: string | string[];
+} & ParameterObject;
+interface Options {
+    server?: ServerObject;
+    queryParams: Param[];
+    pathParams: Param[];
+    cookieParams: Param[];
+    headerParams: Param[];
+    contentType: string;
+    accept: string;
+    body: Body;
+    auth: AuthState;
+}
+declare function buildPostmanRequest(postman: sdk.Request, { queryParams, pathParams, cookieParams, contentType, accept, headerParams, body, server, auth, }: Options): sdk.Request;
+export default buildPostmanRequest;