docusaurus-theme-openapi-docs 0.0.0-1047 → 0.0.0-1054

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

@@ -5,6 +5,7 @@ export declare const languageSet: Language[];
 export interface Props {
     postman: sdk.Request;
     codeSamples: CodeSample[];
+    maskCredentials?: boolean;
 }
-declare function CodeSnippets({ postman, codeSamples }: Props): React.JSX.Element | null;
+declare function CodeSnippets({ postman, codeSamples, maskCredentials: propMaskCredentials, }: Props): React.JSX.Element | null;
 export default CodeSnippets;

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

@@ -93,7 +93,11 @@ function CodeTab({ children, hidden, className }) {
     children
   );
 }
-function CodeSnippets({ postman, codeSamples }) {
+function CodeSnippets({
+  postman,
+  codeSamples,
+  maskCredentials: propMaskCredentials,
+}) {
   const { siteConfig } = (0, useDocusaurusContext_1.default)();
   const contentType = (0, hooks_1.useTypedSelector)(
     (state) => state.contentType.value
@@ -114,29 +118,36 @@ function CodeSnippets({ postman, codeSamples }) {
     (state) => state.params.header
   );
   const auth = (0, hooks_1.useTypedSelector)((state) => state.auth);
-  const clonedAuth = (0, cloneDeep_1.default)(auth);
-  let placeholder;
-  function cleanCredentials(obj) {
-    for (const key in obj) {
-      if (typeof obj[key] === "object" && obj[key] !== null) {
-        // use name as placeholder if exists
-        const comboAuthId = Object.keys(obj).join(" and ");
-        const authOptions =
-          clonedAuth?.options?.[key] ?? clonedAuth?.options?.[comboAuthId];
-        placeholder = authOptions?.[0]?.name;
-        obj[key] = cleanCredentials(obj[key]);
-      } else {
-        obj[key] = `<${placeholder ?? key}>`;
-      }
-    }
-    return obj;
-  }
-  // scrub credentials from code snippets
-  const cleanedAuth = {
-    ...clonedAuth,
-    data: cleanCredentials(clonedAuth.data),
-  };
-  // Create a Postman request object using cleanedAuth
+  // Check if credential masking is enabled (default: true)
+  const maskCredentials = propMaskCredentials ?? true;
+  // Clone Auth if maskCredentials is not false
+  const cleanedAuth = maskCredentials
+    ? (() => {
+        const clonedAuth = (0, cloneDeep_1.default)(auth);
+        let placeholder;
+        function cleanCredentials(obj) {
+          for (const key in obj) {
+            if (typeof obj[key] === "object" && obj[key] !== null) {
+              // use name as placeholder if exists
+              const comboAuthId = Object.keys(obj).join(" and ");
+              const authOptions =
+                clonedAuth?.options?.[key] ??
+                clonedAuth?.options?.[comboAuthId];
+              placeholder = authOptions?.[0]?.name;
+              obj[key] = cleanCredentials(obj[key]);
+            } else {
+              obj[key] = `<${placeholder ?? key}>`;
+            }
+          }
+          return obj;
+        }
+        return {
+          ...clonedAuth,
+          data: cleanCredentials(clonedAuth.data),
+        };
+      })()
+    : auth;
+  // Create a Postman request object using cleanedAuth or original auth
   const cleanedPostmanRequest = (0, buildPostmanRequest_1.default)(postman, {
     queryParams,
     pathParams,

package/lib/theme/ApiExplorer/index.js

@@ -68,6 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const client_1 = require("@docusaurus/plugin-content-docs/client");
 const CodeSnippets_1 = __importDefault(
   require("@theme/ApiExplorer/CodeSnippets")
 );
@@ -78,6 +79,8 @@ const SecuritySchemes_1 = __importDefault(
 );
 const sdk = __importStar(require("postman-collection"));
 function ApiExplorer({ item, infoPath }) {
+  const metadata = (0, client_1.useDoc)();
+  const { mask_credentials } = metadata.frontMatter;
   const postman = new sdk.Request(
     item.postman
       ? sdk.Request.isRequest(item.postman)
@@ -95,6 +98,7 @@ function ApiExplorer({ item, infoPath }) {
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,
         codeSamples: item["x-codeSamples"] ?? [],
+        maskCredentials: mask_credentials,
       }),
     react_1.default.createElement(Request_1.default, { item: item }),
     react_1.default.createElement(Response_1.default, { item: item })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1047",
+  "version": "0.0.0-1054",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -38,7 +38,7 @@
     "@types/postman-collection": "^3.5.11",
     "@types/react-modal": "^3.16.3",
     "concurrently": "^9.2.0",
-    "docusaurus-plugin-openapi-docs": "0.0.0-1047",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1054",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -81,5 +81,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e380211820c49df8c5942e1452d6245df7409ef7"
+  "gitHead": "0e1499ea1924c58ddb345c8674ce22b9b3ec0922"
 }

package/src/theme/ApiExplorer/CodeSnippets/index.tsx

@@ -29,6 +29,7 @@ export const languageSet: Language[] = generateLanguageSet();
 export interface Props {
   postman: sdk.Request;
   codeSamples: CodeSample[];
+  maskCredentials?: boolean;
 }
 
 function CodeTab({ children, hidden, className }: any): React.JSX.Element {
@@ -39,7 +40,11 @@ function CodeTab({ children, hidden, className }: any): React.JSX.Element {
   );
 }
 
-function CodeSnippets({ postman, codeSamples }: Props) {
+function CodeSnippets({
+  postman,
+  codeSamples,
+  maskCredentials: propMaskCredentials,
+}: Props) {
   const { siteConfig } = useDocusaurusContext();
 
   const contentType = useTypedSelector((state: any) => state.contentType.value);
@@ -53,33 +58,42 @@ function CodeSnippets({ postman, codeSamples }: Props) {
   const headerParams = useTypedSelector((state: any) => state.params.header);
 
   const auth = useTypedSelector((state: any) => state.auth);
-  const clonedAuth = cloneDeep(auth);
-  let placeholder: string;
 
-  function cleanCredentials(obj: any) {
-    for (const key in obj) {
-      if (typeof obj[key] === "object" && obj[key] !== null) {
-        // use name as placeholder if exists
-        const comboAuthId = Object.keys(obj).join(" and ");
-        const authOptions =
-          clonedAuth?.options?.[key] ?? clonedAuth?.options?.[comboAuthId];
-        placeholder = authOptions?.[0]?.name;
-        obj[key] = cleanCredentials(obj[key]);
-      } else {
-        obj[key] = `<${placeholder ?? key}>`;
-      }
-    }
+  // Check if credential masking is enabled (default: true)
+  const maskCredentials = propMaskCredentials ?? true;
 
-    return obj;
-  }
+  // Clone Auth if maskCredentials is not false
+  const cleanedAuth = maskCredentials
+    ? (() => {
+        const clonedAuth = cloneDeep(auth);
+        let placeholder: string;
+
+        function cleanCredentials(obj: any) {
+          for (const key in obj) {
+            if (typeof obj[key] === "object" && obj[key] !== null) {
+              // use name as placeholder if exists
+              const comboAuthId = Object.keys(obj).join(" and ");
+              const authOptions =
+                clonedAuth?.options?.[key] ??
+                clonedAuth?.options?.[comboAuthId];
+              placeholder = authOptions?.[0]?.name;
+              obj[key] = cleanCredentials(obj[key]);
+            } else {
+              obj[key] = `<${placeholder ?? key}>`;
+            }
+          }
+
+          return obj;
+        }
 
-  // scrub credentials from code snippets
-  const cleanedAuth = {
-    ...clonedAuth,
-    data: cleanCredentials(clonedAuth.data),
-  };
+        return {
+          ...clonedAuth,
+          data: cleanCredentials(clonedAuth.data),
+        };
+      })()
+    : auth;
 
-  // Create a Postman request object using cleanedAuth
+  // Create a Postman request object using cleanedAuth or original auth
   const cleanedPostmanRequest = buildPostmanRequest(postman, {
     queryParams,
     pathParams,

package/src/theme/ApiExplorer/index.tsx

@@ -7,6 +7,7 @@
 
 import React from "react";
 
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import CodeSnippets from "@theme/ApiExplorer/CodeSnippets";
 import Request from "@theme/ApiExplorer/Request";
 import Response from "@theme/ApiExplorer/Response";
@@ -21,6 +22,9 @@ function ApiExplorer({
   item: NonNullable<ApiItem>;
   infoPath: string;
 }) {
+  const metadata = useDoc();
+  const { mask_credentials } = metadata.frontMatter;
+
   const postman = new sdk.Request(
     item.postman
       ? sdk.Request.isRequest(item.postman)
@@ -36,6 +40,7 @@ function ApiExplorer({
         <CodeSnippets
           postman={postman}
           codeSamples={(item as any)["x-codeSamples"] ?? []}
+          maskCredentials={mask_credentials}
         />
       )}
       <Request item={item} />