docusaurus-theme-openapi-docs 0.0.0-346 → 0.0.0-350

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

@@ -26,9 +26,13 @@ function SecuritySchemes() {
     marginBottom: "var(--ifm-table-cell-padding)"
   }}>
       {selectedAuth.map(auth => {
-      if (auth.type === "apiKey") {
-        return <_react.default.Fragment key={selected + "-apiKey"}>
-              <b>Authorization: {auth.name}</b>
+      const isApiKey = auth.type === "apiKey";
+      const isBearer = auth.type === "http" && auth.key === "Bearer";
+      const isClientCredentials = auth.type === "oauth2" && auth.key === "ClientCredentials";
+
+      if (isApiKey || isBearer) {
+        return <_react.default.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
               <pre style={{
             display: "flex",
             flexDirection: "column",
@@ -42,6 +46,20 @@ function SecuritySchemes() {
             </_react.default.Fragment>;
       }
 
+      if (isClientCredentials) {
+        return <_react.default.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
+              <pre style={{
+            display: "flex",
+            flexDirection: "column",
+            background: "var(--openapi-card-background-color)",
+            borderRadius: "var(--openapi-card-border-radius)"
+          }}>
+                <span>type: {auth.type}</span>
+              </pre>
+            </_react.default.Fragment>;
+      }
+
       return null;
     })}
     </div>;

package/lib/theme/ApiDemoPanel/buildPostmanRequest.js

@@ -269,6 +269,10 @@ function buildPostmanRequest(postman, {
       } = auth.data[a.key];
 
       if (token === undefined) {
+        otherHeaders.push({
+          key: "Authorization",
+          value: "Bearer <TOKEN>"
+        });
         continue;
       }
 
@@ -306,7 +310,7 @@ function buildPostmanRequest(postman, {
       if (apikey === undefined) {
         otherHeaders.push({
           key: a.name,
-          value: "API_KEY_VALUE"
+          value: "<API_KEY_VALUE>"
         });
         continue;
       }

package/lib/theme/ApiItem/styles.module.css

@@ -1,5 +1,9 @@
 :root {
   --openapi-required: var(--ifm-color-danger);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
 }
 
 .apiItemContainer article > *:first-child,

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

@@ -19,10 +19,15 @@ function SecuritySchemes() {
       }}
     >
       {selectedAuth.map((auth) => {
-        if (auth.type === "apiKey") {
+        const isApiKey = auth.type === "apiKey";
+        const isBearer = auth.type === "http" && auth.key === "Bearer";
+        const isClientCredentials =
+          auth.type === "oauth2" && auth.key === "ClientCredentials";
+
+        if (isApiKey || isBearer) {
           return (
-            <React.Fragment key={selected + "-apiKey"}>
-              <b>Authorization: {auth.name}</b>
+            <React.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
               <pre
                 style={{
                   display: "flex",
@@ -39,6 +44,24 @@ function SecuritySchemes() {
           );
         }
 
+        if (isClientCredentials) {
+          return (
+            <React.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
+              <pre
+                style={{
+                  display: "flex",
+                  flexDirection: "column",
+                  background: "var(--openapi-card-background-color)",
+                  borderRadius: "var(--openapi-card-border-radius)",
+                }}
+              >
+                <span>type: {auth.type}</span>
+              </pre>
+            </React.Fragment>
+          );
+        }
+
         return null;
       })}
     </div>

package/lib-next/theme/ApiDemoPanel/buildPostmanRequest.js

@@ -251,6 +251,10 @@ function buildPostmanRequest(
       const { token } = auth.data[a.key];
 
       if (token === undefined) {
+        otherHeaders.push({
+          key: "Authorization",
+          value: "Bearer <TOKEN>",
+        });
         continue;
       }
 
@@ -281,7 +285,7 @@ function buildPostmanRequest(
       if (apikey === undefined) {
         otherHeaders.push({
           key: a.name,
-          value: "API_KEY_VALUE",
+          value: "<API_KEY_VALUE>",
         });
         continue;
       }

package/lib-next/theme/ApiItem/styles.module.css

@@ -1,5 +1,9 @@
 :root {
   --openapi-required: var(--ifm-color-danger);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
 }
 
 .apiItemContainer article > *:first-child,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-346",
+  "version": "0.0.0-350",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -51,7 +51,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-346",
+    "docusaurus-plugin-openapi-docs": "0.0.0-350",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "monaco-editor": "^0.31.1",
@@ -70,5 +70,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c60f384a51dc8579be88e0f35829cf366444f23b"
+  "gitHead": "c66039acf120aeef0024c18d5ca0d842f38b32a6"
 }

package/src/theme/ApiDemoPanel/SecuritySchemes/index.tsx

@@ -20,10 +20,15 @@ function SecuritySchemes() {
   return (
     <div style={{ marginBottom: "var(--ifm-table-cell-padding)" }}>
       {selectedAuth.map((auth) => {
-        if (auth.type === "apiKey") {
+        const isApiKey = auth.type === "apiKey";
+        const isBearer = auth.type === "http" && auth.key === "Bearer";
+        const isClientCredentials =
+          auth.type === "oauth2" && auth.key === "ClientCredentials";
+
+        if (isApiKey || isBearer) {
           return (
-            <React.Fragment key={selected + "-apiKey"}>
-              <b>Authorization: {auth.name}</b>
+            <React.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
               <pre
                 style={{
                   display: "flex",
@@ -40,6 +45,24 @@ function SecuritySchemes() {
           );
         }
 
+        if (isClientCredentials) {
+          return (
+            <React.Fragment key={selected}>
+              <b>Authorization: {auth.key}</b>
+              <pre
+                style={{
+                  display: "flex",
+                  flexDirection: "column",
+                  background: "var(--openapi-card-background-color)",
+                  borderRadius: "var(--openapi-card-border-radius)",
+                }}
+              >
+                <span>type: {auth.type}</span>
+              </pre>
+            </React.Fragment>
+          );
+        }
+
         return null;
       })}
     </div>

package/src/theme/ApiDemoPanel/buildPostmanRequest.ts

@@ -248,6 +248,10 @@ function buildPostmanRequest(
     if (a.type === "http" && a.scheme === "bearer") {
       const { token } = auth.data[a.key];
       if (token === undefined) {
+        otherHeaders.push({
+          key: "Authorization",
+          value: "Bearer <TOKEN>",
+        });
         continue;
       }
       otherHeaders.push({
@@ -276,7 +280,7 @@ function buildPostmanRequest(
       if (apikey === undefined) {
         otherHeaders.push({
           key: a.name,
-          value: "API_KEY_VALUE",
+          value: "<API_KEY_VALUE>",
         });
         continue;
       }

package/src/theme/ApiItem/styles.module.css

@@ -1,5 +1,9 @@
 :root {
   --openapi-required: var(--ifm-color-danger);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
 }
 
 .apiItemContainer article > *:first-child,

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

@@ -1,174 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _FormItem = _interopRequireDefault(require("../FormItem"));
-
-var _FormSelect = _interopRequireDefault(require("../FormSelect"));
-
-var _FormTextInput = _interopRequireDefault(require("../FormTextInput"));
-
-var _hooks = require("../hooks");
-
-var _stylesModule = _interopRequireDefault(require("../styles.module.css"));
-
-var _slice = require("./slice");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-/* ============================================================================
- * 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.
- * ========================================================================== */
-function LockButton({
-  mode,
-  children,
-  style,
-  ...rest
-}) {
-  return <button className={(0, _clsx.default)("button", "button--primary", {
-    "button--outline": mode !== "locked"
-  })} style={{
-    marginLeft: "auto",
-    display: "flex",
-    alignItems: "center",
-    marginBottom: "var(--ifm-spacing-vertical)",
-    ...style
-  }} {...rest}>
-      <span>{children}</span>
-
-      <svg style={{
-      marginLeft: "12px",
-      width: "18px",
-      height: "18px",
-      fill: "currentColor"
-    }} viewBox="0 0 20 20" id={mode}>
-        {mode === "locked" ? <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"></path> : <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>}
-      </svg>
-    </button>;
-}
-
-function validateData(selectedAuth, data) {
-  for (const scheme of selectedAuth) {
-    if (data[scheme.key] === undefined) {
-      return false;
-    }
-
-    const hasMissingKeys = Object.values(data[scheme.key]).includes(undefined);
-
-    if (hasMissingKeys) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-function Authorization() {
-  const [editing, setEditing] = (0, _react.useState)(false);
-  const data = (0, _hooks.useTypedSelector)(state => state.auth.data);
-  const options = (0, _hooks.useTypedSelector)(state => state.auth.options);
-  const selected = (0, _hooks.useTypedSelector)(state => state.auth.selected);
-  const dispatch = (0, _hooks.useTypedDispatch)();
-
-  if (selected === undefined) {
-    return null;
-  }
-
-  const selectedAuth = options[selected];
-  const authenticated = validateData(selectedAuth, data);
-  const optionKeys = Object.keys(options);
-
-  if (editing) {
-    return <div className={_stylesModule.default.optionsPanel}>
-        {optionKeys.length > 1 && <_FormItem.default label="Security Scheme">
-            <_FormSelect.default options={optionKeys} value={selected} onChange={e => {
-          dispatch((0, _slice.setSelectedAuth)(e.target.value));
-        }} />
-          </_FormItem.default>}
-        {selectedAuth.map(a => {
-        if (a.type === "http" && a.scheme === "bearer") {
-          var _data$a$key$token;
-
-          return <_FormItem.default label="Bearer Token" key={selected + "-bearer"}>
-                <_FormTextInput.default placeholder="Bearer Token" value={(_data$a$key$token = data[a.key].token) !== null && _data$a$key$token !== void 0 ? _data$a$key$token : ""} onChange={e => {
-              const value = e.target.value.trim();
-              dispatch((0, _slice.setAuthData)({
-                scheme: a.key,
-                key: "token",
-                value: value ? value : undefined
-              }));
-            }} />
-              </_FormItem.default>;
-        }
-
-        if (a.type === "http" && a.scheme === "basic") {
-          var _data$a$key$username, _data$a$key$password;
-
-          return <_react.default.Fragment key={selected + "-basic"}>
-                <_FormItem.default label="Username">
-                  <_FormTextInput.default placeholder="Username" value={(_data$a$key$username = data[a.key].username) !== null && _data$a$key$username !== void 0 ? _data$a$key$username : ""} onChange={e => {
-                const value = e.target.value.trim();
-                dispatch((0, _slice.setAuthData)({
-                  scheme: a.key,
-                  key: "username",
-                  value: value ? value : undefined
-                }));
-              }} />
-                </_FormItem.default>
-                <_FormItem.default label="Password">
-                  <_FormTextInput.default placeholder="Password" password value={(_data$a$key$password = data[a.key].password) !== null && _data$a$key$password !== void 0 ? _data$a$key$password : ""} onChange={e => {
-                const value = e.target.value.trim();
-                dispatch((0, _slice.setAuthData)({
-                  scheme: a.key,
-                  key: "password",
-                  value: value ? value : undefined
-                }));
-              }} />
-                </_FormItem.default>
-              </_react.default.Fragment>;
-        }
-
-        return null;
-      })}
-        <LockButton mode="unlocked" style={{
-        marginTop: "var(--ifm-spacing-vertical)",
-        marginBottom: 0
-      }} onClick={() => {
-        setEditing(false);
-      }}>
-          Save
-        </LockButton>
-      </div>;
-  }
-
-  if (authenticated) {
-    return <LockButton mode="locked" onClick={() => {
-      setEditing(true);
-    }}>
-        Authorized
-      </LockButton>;
-  }
-
-  return <LockButton mode="unlocked" onClick={() => {
-    setEditing(true);
-  }}>
-      Authorize
-    </LockButton>;
-}
-
-var _default = Authorization;
-exports.default = _default;

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

@@ -1,85 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _hooks = require("../hooks");
-
-var _slice = require("../Response/slice");
-
-var _buildPostmanRequest = _interopRequireDefault(require("./../buildPostmanRequest"));
-
-var _makeRequest = _interopRequireDefault(require("./makeRequest"));
-
-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.
- * ========================================================================== */
-function validateRequest(params) {
-  for (let paramList of Object.values(params)) {
-    for (let param of paramList) {
-      if (param.required && !param.value) {
-        return false;
-      }
-    }
-  }
-
-  return true;
-}
-
-function Execute({
-  postman,
-  proxy
-}) {
-  const pathParams = (0, _hooks.useTypedSelector)(state => state.params.path);
-  const queryParams = (0, _hooks.useTypedSelector)(state => state.params.query);
-  const cookieParams = (0, _hooks.useTypedSelector)(state => state.params.cookie);
-  const headerParams = (0, _hooks.useTypedSelector)(state => state.params.header);
-  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
-  const body = (0, _hooks.useTypedSelector)(state => state.body);
-  const accept = (0, _hooks.useTypedSelector)(state => state.accept.value);
-  const server = (0, _hooks.useTypedSelector)(state => state.server.value);
-  const params = (0, _hooks.useTypedSelector)(state => state.params);
-  const auth = (0, _hooks.useTypedSelector)(state => state.auth);
-  const isValidRequest = validateRequest(params);
-  const dispatch = (0, _hooks.useTypedDispatch)();
-  const postmanRequest = (0, _buildPostmanRequest.default)(postman, {
-    queryParams,
-    pathParams,
-    cookieParams,
-    contentType,
-    accept,
-    headerParams,
-    body,
-    server,
-    auth
-  });
-  return <button className="button button--block button--primary" style={{
-    height: "48px",
-    marginBottom: "var(--ifm-spacing-vertical)"
-  }} disabled={!isValidRequest} onClick={async () => {
-    dispatch((0, _slice.setResponse)("loading..."));
-
-    try {
-      const res = await (0, _makeRequest.default)(postmanRequest, proxy, body);
-      dispatch((0, _slice.setResponse)(res));
-    } catch (e) {
-      var _e$message;
-
-      dispatch((0, _slice.setResponse)((_e$message = e.message) !== null && _e$message !== void 0 ? _e$message : "Error fetching."));
-    }
-  }}>
-      Execute
-    </button>;
-}
-
-var _default = Execute;
-exports.default = _default;