docusaurus-theme-openapi-docs 4.4.0 → 4.5.1

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/String.js

@@ -116,7 +116,7 @@ function CodeBlockString({
                   getLineProps: getLineProps,
                   getTokenProps: getTokenProps,
                   classNames: lineClassNames[i],
-                  showLineNumbers: showLineNumbers,
+                  showLineNumbers: !!showLineNumbers,
                 })
               )
             )
@@ -142,9 +142,9 @@ function CodeBlockString({
           ),
           code: code,
           language: language ?? "text",
-          showLineNumbers: showLineNumbers,
+          showLineNumbers: !!showLineNumbers,
           blockClassName: blockClassName,
-          title: title,
+          title: typeof title === "string" ? title : undefined,
           lineClassNames: lineClassNames,
         })
       )

package/lib/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.d.ts

@@ -1,3 +1,7 @@
 import React from "react";
-import { CopyButtonProps } from "@docusaurus/theme-common/internal";
+interface CopyButtonProps {
+    code: string;
+    className?: string;
+}
 export default function CopyButton({ code, className, }: CopyButtonProps): React.JSX.Element;
+export {};

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

@@ -96,7 +96,7 @@ exports.slice = (0, toolkit_1.createSlice)({
     },
   },
 });
-(_a = exports.slice.actions),
+((_a = exports.slice.actions),
   (exports.setAuthData = _a.setAuthData),
-  (exports.setSelectedAuth = _a.setSelectedAuth);
+  (exports.setSelectedAuth = _a.setSelectedAuth));
 exports.default = exports.slice.reducer;

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

@@ -87,11 +87,11 @@ exports.slice = (0, toolkit_1.createSlice)({
     },
   },
 });
-(_a = exports.slice.actions),
+((_a = exports.slice.actions),
   (exports.clearRawBody = _a.clearRawBody),
   (exports.setStringRawBody = _a.setStringRawBody),
   (exports.setFileRawBody = _a.setFileRawBody),
   (exports.clearFormBodyKey = _a.clearFormBodyKey),
   (exports.setStringFormBody = _a.setStringFormBody),
-  (exports.setFileFormBody = _a.setFileFormBody);
+  (exports.setFileFormBody = _a.setFileFormBody));
 exports.default = exports.slice.reducer;

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

@@ -1,10 +1,10 @@
-import { type JSX } from "react";
-import sdk from "postman-collection";
+import React from "react";
+import * as sdk from "postman-collection";
 import { CodeSample, Language } from "./code-snippets-types";
 export declare const languageSet: Language[];
 export interface Props {
     postman: sdk.Request;
     codeSamples: CodeSample[];
 }
-declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
+declare function CodeSnippets({ postman, codeSamples }: Props): React.JSX.Element | null;
 export default CodeSnippets;

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

@@ -87,11 +87,11 @@ const ParamOptions_1 = __importDefault(
 const slice_1 = require("@theme/ApiExplorer/Response/slice");
 const Server_1 = __importDefault(require("@theme/ApiExplorer/Server"));
 const hooks_1 = require("@theme/ApiItem/hooks");
-const postman_collection_1 = __importDefault(require("postman-collection"));
+const sdk = __importStar(require("postman-collection"));
 const react_hook_form_1 = require("react-hook-form");
 const makeRequest_1 = __importDefault(require("./makeRequest"));
 function Request({ item }) {
-  const postman = new postman_collection_1.default.Request(item.postman);
+  const postman = new sdk.Request(item.postman);
   const metadata = (0, client_1.useDoc)();
   const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;
   const pathParams = (0, hooks_1.useTypedSelector)(

package/lib/theme/ApiExplorer/Request/makeRequest.d.ts

@@ -1,4 +1,4 @@
 import { Body } from "@theme/ApiExplorer/Body/slice";
-import sdk from "postman-collection";
+import * as sdk from "postman-collection";
 declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body): Promise<any>;
 export default makeRequest;

package/lib/theme/ApiExplorer/Request/makeRequest.js

@@ -136,8 +136,9 @@ async function makeRequest(request, proxy, _body) {
         // The Content-Type header will be set automatically based on the type of body.
         myHeaders.delete("Content-Type");
         myBody = new FormData();
-        if (Array.isArray(request.body.formdata.members)) {
-          for (const data of request.body.formdata.members) {
+        const members = request.body?.formdata?.members;
+        if (Array.isArray(members)) {
+          for (const data of members) {
             if (data.key && data.value.content) {
               myBody.append(data.key, data.value.content);
             }

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

@@ -41,11 +41,11 @@ exports.slice = (0, toolkit_1.createSlice)({
     },
   },
 });
-(_a = exports.slice.actions),
+((_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.clearHeaders = _a.clearHeaders));
 exports.default = exports.slice.reducer;

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

@@ -27,7 +27,7 @@ exports.slice = (0, toolkit_1.createSlice)({
     },
   },
 });
-(_a = exports.slice.actions),
+((_a = exports.slice.actions),
   (exports.setServer = _a.setServer),
-  (exports.setServerVariable = _a.setServerVariable);
+  (exports.setServerVariable = _a.setServerVariable));
 exports.default = exports.slice.reducer;

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

@@ -1,7 +1,7 @@
 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";
+import * as sdk from "postman-collection";
 type Param = {
     value?: string | string[];
 } & ParameterObject;

package/lib/theme/ApiExplorer/buildPostmanRequest.js

@@ -5,6 +5,62 @@
  * 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) {
@@ -12,7 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-const postman_collection_1 = __importDefault(require("postman-collection"));
+const sdk = __importStar(require("postman-collection"));
 function setQueryParams(postman, queryParams) {
   postman.url.query.clear();
   const qp = queryParams
@@ -23,25 +79,25 @@ function setQueryParams(postman, queryParams) {
       // Handle array values
       if (Array.isArray(param.value)) {
         if (param.style === "spaceDelimited") {
-          return new postman_collection_1.default.QueryParam({
+          return new sdk.QueryParam({
             key: param.name,
             value: param.value.join(" "),
           });
         } else if (param.style === "pipeDelimited") {
-          return new postman_collection_1.default.QueryParam({
+          return new sdk.QueryParam({
             key: param.name,
             value: param.value.join("|"),
           });
         } else if (param.explode) {
           return param.value.map(
             (val) =>
-              new postman_collection_1.default.QueryParam({
+              new sdk.QueryParam({
                 key: param.name,
                 value: val,
               })
           );
         } else {
-          return new postman_collection_1.default.QueryParam({
+          return new sdk.QueryParam({
             key: param.name,
             value: param.value.join(","),
           });
@@ -61,21 +117,21 @@ function setQueryParams(postman, queryParams) {
         if (param.style === "deepObject") {
           return Object.entries(jsonResult).map(
             ([key, val]) =>
-              new postman_collection_1.default.QueryParam({
+              new sdk.QueryParam({
                 key: `${param.name}[${key}]`,
-                value: val,
+                value: String(val),
               })
           );
         } else if (param.explode) {
           return Object.entries(jsonResult).map(
             ([key, val]) =>
-              new postman_collection_1.default.QueryParam({
+              new sdk.QueryParam({
                 key: key,
-                value: val,
+                value: String(val),
               })
           );
         } else {
-          return new postman_collection_1.default.QueryParam({
+          return new sdk.QueryParam({
             key: param.name,
             value: Object.entries(jsonResult)
               .map(([key, val]) => `${key},${val}`)
@@ -85,7 +141,7 @@ function setQueryParams(postman, queryParams) {
       }
       // Handle boolean values
       if (typeof decodedValue === "boolean") {
-        return new postman_collection_1.default.QueryParam({
+        return new sdk.QueryParam({
           key: param.name,
           value: decodedValue ? "true" : "false",
         });
@@ -93,14 +149,14 @@ function setQueryParams(postman, queryParams) {
       // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
         if (decodedValue === "true") {
-          return new postman_collection_1.default.QueryParam({
+          return new sdk.QueryParam({
             key: param.name,
             value: null,
           });
         }
         return undefined;
       }
-      return new postman_collection_1.default.QueryParam({
+      return new sdk.QueryParam({
         key: param.name,
         value: param.value,
       });
@@ -127,7 +183,7 @@ function setPathParams(postman, pathParams) {
       } else {
         serializedValue = param.value.join(",");
       }
-      return new postman_collection_1.default.Variable({
+      return new sdk.Variable({
         key: param.name,
         value: serializedValue,
       });
@@ -154,12 +210,15 @@ function setPathParams(postman, pathParams) {
     } else {
       serializedValue = decodedValue || `:${param.name}`;
     }
-    return new postman_collection_1.default.Variable({
+    return new sdk.Variable({
       key: param.name,
       value: serializedValue,
     });
   });
-  postman.url.variables.assimilate(source, false);
+  postman.url.variables.assimilate(
+    source.filter((v) => v !== undefined),
+    false
+  );
 }
 function buildCookie(cookieParams) {
   const cookies = cookieParams
@@ -181,26 +240,32 @@ function buildCookie(cookieParams) {
               // Serialize each key-value pair as a separate cookie
               return Object.entries(jsonResult).map(
                 ([key, val]) =>
-                  new postman_collection_1.default.Cookie({
+                  new sdk.Cookie({
                     key: key,
-                    value: val,
+                    value: String(val),
+                    domain: "",
+                    path: "",
                   })
               );
             } else {
               // Serialize the object as a single cookie with key-value pairs joined by commas
-              return new postman_collection_1.default.Cookie({
+              return new sdk.Cookie({
                 key: param.name,
                 value: Object.entries(jsonResult)
                   .map(([key, val]) => `${key},${val}`)
                   .join(","),
+                domain: "",
+                path: "",
               });
             }
           }
         } else {
           // Handle scalar values
-          return new postman_collection_1.default.Cookie({
+          return new sdk.Cookie({
             key: param.name,
-            value: param.value,
+            value: String(param.value),
+            domain: "",
+            path: "",
           });
         }
       }
@@ -208,7 +273,7 @@ function buildCookie(cookieParams) {
     })
     .flat() // Flatten the array in case of nested arrays from map
     .filter((item) => item !== undefined);
-  const list = new postman_collection_1.default.CookieList(null, cookies);
+  const list = new sdk.CookieList(null, cookies);
   return list.toString();
 }
 function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
@@ -312,15 +377,9 @@ function setBody(clonedPostman, body) {
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
           if (content.type === "file") {
-            return new postman_collection_1.default.FormParam({
-              key: key,
-              ...content,
-            });
+            return new sdk.FormParam({ key: key, ...content });
           }
-          return new postman_collection_1.default.FormParam({
-            key: key,
-            value: content.value,
-          });
+          return new sdk.FormParam({ key: key, value: content.value });
         });
       clonedPostman.body.formdata?.assimilate(params, false);
       return;
@@ -337,10 +396,7 @@ function setBody(clonedPostman, body) {
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
           if (content.type !== "file" && content.value) {
-            return new postman_collection_1.default.QueryParam({
-              key: key,
-              value: content.value,
-            });
+            return new sdk.QueryParam({ key: key, value: content.value });
           }
           return undefined;
         })
@@ -379,9 +435,8 @@ function buildPostmanRequest(
     }
     clonedPostman.url.host = [url];
   }
-  setQueryParams(clonedPostman, queryParams);
-  setPathParams(clonedPostman, pathParams);
-  const cookie = buildCookie(cookieParams);
+  const enhancedQueryParams = [...queryParams];
+  const enhancedCookieParams = [...cookieParams];
   let otherHeaders = [];
   let selectedAuth = [];
   if (auth.selected !== undefined) {
@@ -434,23 +489,41 @@ function buildPostmanRequest(
       });
       continue;
     }
-    // API Key
+    // API Key in header
     if (a.type === "apiKey" && a.in === "header") {
       const { apiKey } = auth.data[a.key];
-      if (apiKey === undefined) {
-        otherHeaders.push({
-          key: a.name,
-          value: `<${a.name ?? a.type}>`,
-        });
-        continue;
-      }
       otherHeaders.push({
         key: a.name,
-        value: apiKey,
+        value: apiKey || `<${a.name ?? a.type}>`,
+      });
+      continue;
+    }
+    // API Key in query
+    if (a.type === "apiKey" && a.in === "query") {
+      const { apiKey } = auth.data[a.key];
+      enhancedQueryParams.push({
+        name: a.name,
+        in: "query",
+        value: apiKey || `<${a.name ?? a.type}>`,
+      });
+      continue;
+    }
+    // API Key in cookie
+    if (a.type === "apiKey" && a.in === "cookie") {
+      const { apiKey } = auth.data[a.key];
+      enhancedCookieParams.push({
+        name: a.name,
+        in: "cookie",
+        value: apiKey || `<${a.name ?? a.type}>`,
       });
       continue;
     }
   }
+  // Use the enhanced params that might include API keys
+  setQueryParams(clonedPostman, enhancedQueryParams);
+  setPathParams(clonedPostman, pathParams);
+  // Use enhanced cookie params that might include API keys
+  const cookie = buildCookie(enhancedCookieParams);
   setHeaders(
     clonedPostman,
     contentType,

package/lib/theme/ApiExplorer/index.js

@@ -5,6 +5,62 @@
  * 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) {
@@ -20,9 +76,15 @@ const Response_1 = __importDefault(require("@theme/ApiExplorer/Response"));
 const SecuritySchemes_1 = __importDefault(
   require("@theme/ApiExplorer/SecuritySchemes")
 );
-const postman_collection_1 = __importDefault(require("postman-collection"));
+const sdk = __importStar(require("postman-collection"));
 function ApiExplorer({ item, infoPath }) {
-  const postman = new postman_collection_1.default.Request(item.postman);
+  const postman = new sdk.Request(
+    item.postman
+      ? sdk.Request.isRequest(item.postman)
+        ? item.postman.toJSON()
+        : item.postman
+      : {}
+  );
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,

package/lib/theme/CodeSamples/_CodeSamples.scss

@@ -0,0 +1,3 @@
+.openapi-code__code-samples-container {
+  margin-top: 2rem;
+}

package/lib/theme/CodeSamples/index.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Language } from "prism-react-renderer";
+export interface Props {
+    readonly example: string;
+    readonly language: Language;
+}
+declare function CodeSamples({ example, language }: Props): React.JSX.Element;
+export default CodeSamples;

package/lib/theme/{ResponseSamples → CodeSamples}/index.js

@@ -13,15 +13,15 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
 const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
-function ResponseSamples({ responseExample, language }) {
+function CodeSamples({ example, language }) {
   return react_1.default.createElement(
     "div",
-    { className: "openapi-code__response-samples-container" },
+    { className: "openapi-code__code-samples-container" },
     react_1.default.createElement(
       CodeBlock_1.default,
       { language: language ? language : "json" },
-      responseExample
+      example
     )
   );
 }
-exports.default = ResponseSamples;
+exports.default = CodeSamples;

package/lib/theme/ParamsItem/index.d.ts

@@ -1,7 +1,4 @@
 import React from "react";
-interface Map<T> {
-    [key: string]: T;
-}
 export interface ExampleObject {
     summary?: string;
     description?: string;
@@ -13,7 +10,7 @@ export interface Props {
     param: {
         description: string;
         example: any;
-        examples: Map<ExampleObject>;
+        examples: Record<string, ExampleObject>;
         name: string;
         required: boolean;
         deprecated: boolean;

package/lib/theme/ResponseExamples/index.js

@@ -17,8 +17,8 @@ exports.ExampleFromSchema =
     void 0;
 exports.json2xml = json2xml;
 const react_1 = __importDefault(require("react"));
+const CodeSamples_1 = __importDefault(require("@theme/CodeSamples"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
-const ResponseSamples_1 = __importDefault(require("@theme/ResponseSamples"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
 const createResponseExample_1 = require("docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample");
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
@@ -80,8 +80,8 @@ const ResponseExamples = ({ responseExamples, mimeType }) => {
               { className: "openapi-example__summary" },
               exampleValue.summary
             ),
-          react_1.default.createElement(ResponseSamples_1.default, {
-            responseExample: responseExample,
+          react_1.default.createElement(CodeSamples_1.default, {
+            example: responseExample,
             language: language,
           })
         )
@@ -114,8 +114,8 @@ const ResponseExample = ({ responseExample, mimeType }) => {
           { className: "openapi-example__summary" },
           responseExample.summary
         ),
-      react_1.default.createElement(ResponseSamples_1.default, {
-        responseExample: exampleContent,
+      react_1.default.createElement(CodeSamples_1.default, {
+        example: exampleContent,
         language: language,
       })
     )
@@ -164,8 +164,8 @@ const ExampleFromSchema = ({ schema, mimeType }) => {
         react_1.default.createElement(
           TabItem_1.default,
           { label: "Example (auto)", value: "Example (auto)" },
-          react_1.default.createElement(ResponseSamples_1.default, {
-            responseExample: xmlExample,
+          react_1.default.createElement(CodeSamples_1.default, {
+            example: xmlExample,
             language: "xml",
           })
         )
@@ -181,8 +181,8 @@ const ExampleFromSchema = ({ schema, mimeType }) => {
       react_1.default.createElement(
         TabItem_1.default,
         { label: "Example (auto)", value: "Example (auto)" },
-        react_1.default.createElement(ResponseSamples_1.default, {
-          responseExample: JSON.stringify(responseExample, null, 2),
+        react_1.default.createElement(CodeSamples_1.default, {
+          example: JSON.stringify(responseExample, null, 2),
           language: "json",
         })
       )