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

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

@@ -1,257 +1,380 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-var _hooks = require("@theme/ApiItem/hooks");
-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 Link_1 = __importDefault(require("@docusaurus/Link"));
+const hooks_1 = require("@theme/ApiItem/hooks");
 function SecuritySchemes(props) {
-  var _options$selected, _options$selected$;
-  const options = (0, _hooks.useTypedSelector)(state => state.auth.options);
-  const selected = (0, _hooks.useTypedSelector)(state => state.auth.selected);
+  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 = options[selected]) === null || _options$selected === void 0 ? void 0 : (_options$selected$ = _options$selected[0]) === null || _options$selected$ === void 0 ? void 0 : _options$selected$.type) === undefined) {
+  if (options[selected]?.[0]?.type === undefined) {
     return null;
   }
   const selectedAuth = options[selected];
-  return <details className="openapi-demo__details" open={false}>
-      <summary className="openapi-demo__summary-container">
-        <h4 className="openapi-demo__summary-header">Authorization</h4>
-      </summary>
-      {selectedAuth.map(auth => {
+  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) {
-        var _auth$name;
         if (auth.scheme === "bearer") {
-          const {
-            name,
-            key,
-            type,
-            scopes,
-            ...rest
-          } = auth;
-          return <_react.default.Fragment key={auth.key}>
-                <pre style={{
-              display: "flex",
-              flexDirection: "column",
-              background: "var(--openapi-card-background-color)"
-            }}>
-                  <span>
-                    <strong>name:</strong>{" "}
-                    <_Link.default to={infoAuthPath}>{name !== null && name !== void 0 ? name : key}</_Link.default>
-                  </span>
-                  <span>
-                    <strong>type: </strong>
-                    {type}
-                  </span>
-                  {scopes && scopes.length > 0 && <span>
-                      <strong>scopes: </strong>
-                      <code>
-                        {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                      </code>
-                    </span>}
-                  {Object.keys(rest).map((k, i) => {
-                return <span key={k}>
-                        <strong>{k}: </strong>
-                        {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])}
-                      </span>;
-              })}
-                </pre>
-              </_react.default.Fragment>;
+          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.default.Fragment key={auth.key}>
-                <pre style={{
-              display: "flex",
-              flexDirection: "column",
-              background: "var(--openapi-card-background-color)"
-            }}>
-                  <span>
-                    <strong>name:</strong>{" "}
-                    <_Link.default to={infoAuthPath}>{name !== null && name !== void 0 ? name : key}</_Link.default>
-                  </span>
-                  <span>
-                    <strong>type: </strong>
-                    {type}
-                  </span>
-                  {scopes && scopes.length > 0 && <span>
-                      <strong>scopes: </strong>
-                      <code>
-                        {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                      </code>
-                    </span>}
-                  {Object.keys(rest).map((k, i) => {
-                return <span key={k}>
-                        <strong>{k}: </strong>
-                        {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])}
-                      </span>;
-              })}
-                </pre>
-              </_react.default.Fragment>;
+          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.default.Fragment key={auth.key}>
-              <pre style={{
-            display: "flex",
-            flexDirection: "column",
-            background: "var(--openapi-card-background-color)"
-          }}>
-                <span>
-                  <strong>name:</strong>{" "}
-                  <_Link.default to={infoAuthPath}>{(_auth$name = auth.name) !== null && _auth$name !== void 0 ? _auth$name : auth.key}</_Link.default>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {auth.type}
-                </span>
-                <span>
-                  <strong>in: </strong>
-                  {auth.in}
-                </span>
-              </pre>
-            </_react.default.Fragment>;
+        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.default.Fragment key={auth.key}>
-              <pre style={{
-            display: "flex",
-            flexDirection: "column",
-            background: "var(--openapi-card-background-color)"
-          }}>
-                <span>
-                  <strong>name:</strong>{" "}
-                  <_Link.default to={infoAuthPath}>{name !== null && name !== void 0 ? name : key}</_Link.default>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>}
-                {Object.keys(rest).map((k, i) => {
-              return <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])}
-                    </span>;
-            })}
-              </pre>
-            </_react.default.Fragment>;
+        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.default.Fragment key={selected}>
-              <pre style={{
-            display: "flex",
-            flexDirection: "column",
-            background: "var(--openapi-card-background-color)"
-          }}>
-                <span>
-                  <strong>name:</strong>{" "}
-                  <_Link.default to={infoAuthPath}>{name !== null && name !== void 0 ? name : key}</_Link.default>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>}
-                {Object.keys(rest).map((k, i) => {
-              return <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])}
-                    </span>;
-            })}
-                {flows && <span>
-                    <code>
-                      <strong>flows: </strong>
-                      {JSON.stringify(flows, null, 2)}
-                    </code>
-                  </span>}
-              </pre>
-            </_react.default.Fragment>;
+        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.default.Fragment key={auth.key}>
-              <pre style={{
-            display: "flex",
-            flexDirection: "column",
-            background: "var(--openapi-card-background-color)"
-          }}>
-                <span>
-                  <strong>name:</strong>{" "}
-                  <_Link.default to={infoAuthPath}>{name !== null && name !== void 0 ? name : key}</_Link.default>
-                </span>
-                <span>
-                  <strong>type: </strong>
-                  {type}
-                </span>
-                {scopes && scopes.length > 0 && <span>
-                    <strong>scopes: </strong>
-                    <code>
-                      {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"}
-                    </code>
-                  </span>}
-                {Object.keys(rest).map((k, i) => {
-              return <span key={k}>
-                      <strong>{k}: </strong>
-                      {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])}
-                    </span>;
-            })}
-              </pre>
-            </_react.default.Fragment>;
+        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;
-    })}
-    </details>;
+    })
+  );
 }
-var _default = SecuritySchemes;
-exports.default = _default;
+exports.default = SecuritySchemes;

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.d.ts

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