docusaurus-theme-openapi-docs 4.3.3 → 4.3.4

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.js

@@ -78,7 +78,8 @@ const FormTextInput_1 = __importDefault(
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
 const react_hook_form_1 = require("react-hook-form");
-function ArrayItem({ param, onChange }) {
+function ArrayItem({ param, onChange, initialValue }) {
+  const [value, setValue] = (0, react_1.useState)(initialValue || "");
   if (param.schema?.items?.type === "boolean") {
     return react_1.default.createElement(FormSelect_1.default, {
       options: ["---", "true", "false"],
@@ -90,7 +91,9 @@ function ArrayItem({ param, onChange }) {
   }
   return react_1.default.createElement(FormTextInput_1.default, {
     placeholder: param.description || param.name,
+    value: value,
     onChange: (e) => {
+      setValue(e.target.value);
       onChange(e.target.value);
     },
   });
@@ -122,6 +125,15 @@ function ParamArrayFormItem({ param }) {
     );
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [items]);
+  (0, react_1.useEffect)(() => {
+    if (param.schema?.example?.length > 0) {
+      const examplesWithIds = param.schema.example.map((item) => ({
+        id: (0, toolkit_1.nanoid)(),
+        value: item.toString(),
+      }));
+      setItems(examplesWithIds);
+    }
+  }, [param.schema.example, param.schema.length]);
   function handleDeleteItem(itemToDelete) {
     return () => {
       const newItems = items.filter((i) => i.id !== itemToDelete.id);
@@ -158,6 +170,7 @@ function ParamArrayFormItem({ param }) {
               react_1.default.createElement(ArrayItem, {
                 param: param,
                 onChange: handleChangeItem(item, onChange),
+                initialValue: item.value,
               }),
               react_1.default.createElement(
                 "button",

package/lib/theme/ApiExplorer/buildPostmanRequest.js

@@ -20,15 +20,79 @@ function setQueryParams(postman, queryParams) {
       if (!param.value) {
         return undefined;
       }
+      // Handle array values
       if (Array.isArray(param.value)) {
+        if (param.style === "spaceDelimited") {
+          return new postman_collection_1.default.QueryParam({
+            key: param.name,
+            value: param.value.join(" "),
+          });
+        } else if (param.style === "pipeDelimited") {
+          return new postman_collection_1.default.QueryParam({
+            key: param.name,
+            value: param.value.join("|"),
+          });
+        } else if (param.explode) {
+          return param.value.map(
+            (val) =>
+              new postman_collection_1.default.QueryParam({
+                key: param.name,
+                value: val,
+              })
+          );
+        } else {
+          return new postman_collection_1.default.QueryParam({
+            key: param.name,
+            value: param.value.join(","),
+          });
+        }
+      }
+      const decodedValue = decodeURI(param.value);
+      const tryJson = () => {
+        try {
+          return JSON.parse(decodedValue);
+        } catch (e) {
+          return false;
+        }
+      };
+      const jsonResult = tryJson();
+      // Handle object values
+      if (jsonResult && typeof jsonResult === "object") {
+        if (param.style === "deepObject") {
+          return Object.entries(jsonResult).map(
+            ([key, val]) =>
+              new postman_collection_1.default.QueryParam({
+                key: `${param.name}[${key}]`,
+                value: val,
+              })
+          );
+        } else if (param.explode) {
+          return Object.entries(jsonResult).map(
+            ([key, val]) =>
+              new postman_collection_1.default.QueryParam({
+                key: key,
+                value: val,
+              })
+          );
+        } else {
+          return new postman_collection_1.default.QueryParam({
+            key: param.name,
+            value: Object.entries(jsonResult)
+              .map(([key, val]) => `${key},${val}`)
+              .join(","),
+          });
+        }
+      }
+      // Handle boolean values
+      if (typeof decodedValue === "boolean") {
         return new postman_collection_1.default.QueryParam({
           key: param.name,
-          value: param.value.join(","),
+          value: decodedValue ? "true" : "false",
         });
       }
       // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
-        if (param.value === "true") {
+        if (decodedValue === "true") {
           return new postman_collection_1.default.QueryParam({
             key: param.name,
             value: null,
@@ -41,16 +105,58 @@ function setQueryParams(postman, queryParams) {
         value: param.value,
       });
     })
+    .flat() // Flatten the array in case of nested arrays from map
     .filter((item) => item !== undefined);
   if (qp.length > 0) {
     postman.addQueryParams(qp);
   }
 }
-function setPathParams(postman, queryParams) {
-  const source = queryParams.map((param) => {
+function setPathParams(postman, pathParams) {
+  // Map through the path parameters
+  const source = pathParams.map((param) => {
+    if (!param.value) {
+      return undefined;
+    }
+    let serializedValue;
+    // Handle different styles
+    if (Array.isArray(param.value)) {
+      if (param.style === "label") {
+        serializedValue = `.${param.value.join(".")}`;
+      } else if (param.style === "matrix") {
+        serializedValue = `;${param.name}=${param.value.join(";")}`;
+      } else {
+        serializedValue = param.value.join(",");
+      }
+      return new postman_collection_1.default.Variable({
+        key: param.name,
+        value: serializedValue,
+      });
+    }
+    const decodedValue = decodeURI(param.value);
+    const tryJson = () => {
+      try {
+        return JSON.parse(decodedValue);
+      } catch (e) {
+        return false;
+      }
+    };
+    const jsonResult = tryJson();
+    if (typeof jsonResult === "object") {
+      if (param.style === "matrix") {
+        serializedValue = Object.entries(jsonResult)
+          .map(([key, val]) => `;${key}=${val}`)
+          .join("");
+      } else {
+        serializedValue = Object.entries(jsonResult)
+          .map(([key, val]) => `${key}=${val}`)
+          .join(",");
+      }
+    } else {
+      serializedValue = decodedValue || `:${param.name}`;
+    }
     return new postman_collection_1.default.Variable({
       key: param.name,
-      value: param.value || `:${param.name}`,
+      value: serializedValue,
     });
   });
   postman.url.variables.assimilate(source, false);
@@ -58,17 +164,49 @@ function setPathParams(postman, queryParams) {
 function buildCookie(cookieParams) {
   const cookies = cookieParams
     .map((param) => {
-      if (param.value && !Array.isArray(param.value)) {
-        return new postman_collection_1.default.Cookie({
-          // TODO: Is this right?
-          path: "",
-          domain: "",
-          key: param.name,
-          value: param.value,
-        });
+      if (param.value) {
+        const decodedValue = decodeURI(param.value);
+        const tryJson = () => {
+          try {
+            return JSON.parse(decodedValue);
+          } catch (e) {
+            return false;
+          }
+        };
+        const jsonResult = tryJson();
+        if (typeof jsonResult === "object") {
+          if (param.style === "form") {
+            // Handle form style
+            if (param.explode) {
+              // Serialize each key-value pair as a separate cookie
+              return Object.entries(jsonResult).map(
+                ([key, val]) =>
+                  new postman_collection_1.default.Cookie({
+                    key: key,
+                    value: val,
+                  })
+              );
+            } else {
+              // Serialize the object as a single cookie with key-value pairs joined by commas
+              return new postman_collection_1.default.Cookie({
+                key: param.name,
+                value: Object.entries(jsonResult)
+                  .map(([key, val]) => `${key},${val}`)
+                  .join(","),
+              });
+            }
+          }
+        } else {
+          // Handle scalar values
+          return new postman_collection_1.default.Cookie({
+            key: param.name,
+            value: param.value,
+          });
+        }
       }
       return undefined;
     })
+    .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);
   return list.toString();
@@ -82,8 +220,52 @@ function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
     postman.addHeader({ key: "Accept", value: accept });
   }
   headerParams.forEach((param) => {
-    if (param.value && !Array.isArray(param.value)) {
-      postman.addHeader({ key: param.name, value: param.value });
+    if (param.value) {
+      const decodedValue = decodeURI(param.value);
+      const tryJson = () => {
+        try {
+          return JSON.parse(decodedValue);
+        } catch (e) {
+          return false;
+        }
+      };
+      const jsonResult = tryJson();
+      if (Array.isArray(param.value)) {
+        if (param.style === "simple") {
+          if (param.explode) {
+            // Each item in the array is a separate header
+            jsonResult.forEach((val) => {
+              postman.addHeader({ key: param.name, value: val });
+            });
+          } else {
+            // Array values are joined by commas
+            postman.addHeader({
+              key: param.name,
+              value: param.value.join(","),
+            });
+          }
+        }
+      } else if (typeof jsonResult === "object") {
+        if (param.style === "simple") {
+          if (param.explode) {
+            // Each key-value pair in the object is a separate header
+            Object.entries(jsonResult).forEach(([key, val]) => {
+              postman.addHeader({ key: param.name, value: `${key}=${val}` });
+            });
+          } else {
+            // Object is serialized as a single header with key-value pairs joined by commas
+            postman.addHeader({
+              key: param.name,
+              value: Object.entries(jsonResult)
+                .map(([key, val]) => `${key},${val}`)
+                .join(","),
+            });
+          }
+        }
+      } else {
+        // Handle scalar values
+        postman.addHeader({ key: param.name, value: param.value });
+      }
     }
   });
   other.forEach((header) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "4.3.3",
+  "version": "4.3.4",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -75,5 +75,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4ec42960414d640952c235afc3757fd3245fb2d2"
+  "gitHead": "97d0fc7e9ed0f18f0cf02b8de3bc502b0cd52c34"
 }

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx

@@ -22,7 +22,10 @@ export interface ParamProps {
 function ArrayItem({
   param,
   onChange,
-}: ParamProps & { onChange(value?: string): any }) {
+  initialValue,
+}: ParamProps & { onChange(value?: string): any; initialValue?: string }) {
+  const [value, setValue] = useState(initialValue || "");
+
   if (param.schema?.items?.type === "boolean") {
     return (
       <FormSelect
@@ -38,7 +41,9 @@ function ArrayItem({
   return (
     <FormTextInput
       placeholder={param.description || param.name}
+      value={value}
       onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
+        setValue(e.target.value);
         onChange(e.target.value);
       }}
     />
@@ -77,9 +82,21 @@ export default function ParamArrayFormItem({ param }: ParamProps) {
         value: values.length > 0 ? values : undefined,
       })
     );
+
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [items]);
 
+  useEffect(() => {
+    if (param.schema?.example?.length > 0) {
+      const examplesWithIds = param.schema.example.map((item: any) => ({
+        id: nanoid(),
+        value: item.toString(),
+      }));
+
+      setItems(examplesWithIds);
+    }
+  }, [param.schema.example, param.schema.length]);
+
   function handleDeleteItem(itemToDelete: { id: string }) {
     return () => {
       const newItems = items.filter((i) => i.id !== itemToDelete.id);
@@ -113,6 +130,7 @@ export default function ParamArrayFormItem({ param }: ParamProps) {
                 <ArrayItem
                   param={param}
                   onChange={handleChangeItem(item, onChange)}
+                  initialValue={item.value}
                 />
                 <button
                   className="openapi-explorer__delete-btn"

package/src/theme/ApiExplorer/buildPostmanRequest.ts

@@ -27,16 +27,84 @@ function setQueryParams(postman: sdk.Request, queryParams: Param[]) {
         return undefined;
       }
 
+      // Handle array values
       if (Array.isArray(param.value)) {
+        if (param.style === "spaceDelimited") {
+          return new sdk.QueryParam({
+            key: param.name,
+            value: param.value.join(" "),
+          });
+        } else if (param.style === "pipeDelimited") {
+          return new sdk.QueryParam({
+            key: param.name,
+            value: param.value.join("|"),
+          });
+        } else if (param.explode) {
+          return param.value.map(
+            (val) =>
+              new sdk.QueryParam({
+                key: param.name,
+                value: val,
+              })
+          );
+        } else {
+          return new sdk.QueryParam({
+            key: param.name,
+            value: param.value.join(","),
+          });
+        }
+      }
+
+      const decodedValue = decodeURI(param.value);
+      const tryJson = () => {
+        try {
+          return JSON.parse(decodedValue);
+        } catch (e) {
+          return false;
+        }
+      };
+
+      const jsonResult = tryJson();
+
+      // Handle object values
+      if (jsonResult && typeof jsonResult === "object") {
+        if (param.style === "deepObject") {
+          return Object.entries(jsonResult).map(
+            ([key, val]) =>
+              new sdk.QueryParam({
+                key: `${param.name}[${key}]`,
+                value: val,
+              })
+          );
+        } else if (param.explode) {
+          return Object.entries(jsonResult).map(
+            ([key, val]) =>
+              new sdk.QueryParam({
+                key: key,
+                value: val,
+              })
+          );
+        } else {
+          return new sdk.QueryParam({
+            key: param.name,
+            value: Object.entries(jsonResult)
+              .map(([key, val]) => `${key},${val}`)
+              .join(","),
+          });
+        }
+      }
+
+      // Handle boolean values
+      if (typeof decodedValue === "boolean") {
         return new sdk.QueryParam({
           key: param.name,
-          value: param.value.join(","),
+          value: decodedValue ? "true" : "false",
         });
       }
 
       // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
-        if (param.value === "true") {
+        if (decodedValue === "true") {
           return new sdk.QueryParam({
             key: param.name,
             value: null,
@@ -50,38 +118,121 @@ function setQueryParams(postman: sdk.Request, queryParams: Param[]) {
         value: param.value,
       });
     })
-    .filter((item): item is sdk.QueryParam => item !== undefined);
+    .flat() // Flatten the array in case of nested arrays from map
+    .filter((item) => item !== undefined);
 
   if (qp.length > 0) {
     postman.addQueryParams(qp);
   }
 }
 
-function setPathParams(postman: sdk.Request, queryParams: Param[]) {
-  const source = queryParams.map((param) => {
+function setPathParams(postman: sdk.Request, pathParams: Param[]) {
+  // Map through the path parameters
+  const source = pathParams.map((param) => {
+    if (!param.value) {
+      return undefined;
+    }
+
+    let serializedValue;
+
+    // Handle different styles
+    if (Array.isArray(param.value)) {
+      if (param.style === "label") {
+        serializedValue = `.${param.value.join(".")}`;
+      } else if (param.style === "matrix") {
+        serializedValue = `;${param.name}=${param.value.join(";")}`;
+      } else {
+        serializedValue = param.value.join(",");
+      }
+      return new sdk.Variable({
+        key: param.name,
+        value: serializedValue,
+      });
+    }
+
+    const decodedValue = decodeURI(param.value);
+    const tryJson = () => {
+      try {
+        return JSON.parse(decodedValue);
+      } catch (e) {
+        return false;
+      }
+    };
+
+    const jsonResult = tryJson();
+
+    if (typeof jsonResult === "object") {
+      if (param.style === "matrix") {
+        serializedValue = Object.entries(jsonResult)
+          .map(([key, val]) => `;${key}=${val}`)
+          .join("");
+      } else {
+        serializedValue = Object.entries(jsonResult)
+          .map(([key, val]) => `${key}=${val}`)
+          .join(",");
+      }
+    } else {
+      serializedValue = decodedValue || `:${param.name}`;
+    }
+
     return new sdk.Variable({
       key: param.name,
-      value: param.value || `:${param.name}`,
+      value: serializedValue,
     });
   });
+
   postman.url.variables.assimilate(source, false);
 }
 
 function buildCookie(cookieParams: Param[]) {
   const cookies = cookieParams
     .map((param) => {
-      if (param.value && !Array.isArray(param.value)) {
-        return new sdk.Cookie({
-          // TODO: Is this right?
-          path: "",
-          domain: "",
-          key: param.name,
-          value: param.value,
-        });
+      if (param.value) {
+        const decodedValue = decodeURI(param.value as string);
+        const tryJson = () => {
+          try {
+            return JSON.parse(decodedValue);
+          } catch (e) {
+            return false;
+          }
+        };
+
+        const jsonResult = tryJson();
+        if (typeof jsonResult === "object") {
+          if (param.style === "form") {
+            // Handle form style
+            if (param.explode) {
+              // Serialize each key-value pair as a separate cookie
+              return Object.entries(jsonResult).map(
+                ([key, val]) =>
+                  new sdk.Cookie({
+                    key: key,
+                    value: val,
+                  })
+              );
+            } else {
+              // Serialize the object as a single cookie with key-value pairs joined by commas
+              return new sdk.Cookie({
+                key: param.name,
+                value: Object.entries(jsonResult)
+                  .map(([key, val]) => `${key},${val}`)
+                  .join(","),
+              });
+            }
+          }
+        } else {
+          // Handle scalar values
+          return new sdk.Cookie({
+            key: param.name,
+            value: param.value,
+          });
+        }
       }
       return undefined;
     })
-    .filter((item): item is sdk.Cookie => item !== undefined);
+    .flat() // Flatten the array in case of nested arrays from map
+    .filter((item) => item !== undefined);
+
   const list = new sdk.CookieList(null, cookies);
   return list.toString();
 }
@@ -95,15 +246,63 @@ function setHeaders(
   other: { key: string; value: string }[]
 ) {
   postman.headers.clear();
+
   if (contentType) {
     postman.addHeader({ key: "Content-Type", value: contentType });
   }
+
   if (accept) {
     postman.addHeader({ key: "Accept", value: accept });
   }
+
   headerParams.forEach((param) => {
-    if (param.value && !Array.isArray(param.value)) {
-      postman.addHeader({ key: param.name, value: param.value });
+    if (param.value) {
+      const decodedValue = decodeURI(param.value as string);
+      const tryJson = () => {
+        try {
+          return JSON.parse(decodedValue);
+        } catch (e) {
+          return false;
+        }
+      };
+
+      const jsonResult = tryJson();
+      if (Array.isArray(param.value)) {
+        if (param.style === "simple") {
+          if (param.explode) {
+            // Each item in the array is a separate header
+            jsonResult.forEach((val: any) => {
+              postman.addHeader({ key: param.name, value: val });
+            });
+          } else {
+            // Array values are joined by commas
+            postman.addHeader({
+              key: param.name,
+              value: param.value.join(","),
+            });
+          }
+        }
+      } else if (typeof jsonResult === "object") {
+        if (param.style === "simple") {
+          if (param.explode) {
+            // Each key-value pair in the object is a separate header
+            Object.entries(jsonResult).forEach(([key, val]) => {
+              postman.addHeader({ key: param.name, value: `${key}=${val}` });
+            });
+          } else {
+            // Object is serialized as a single header with key-value pairs joined by commas
+            postman.addHeader({
+              key: param.name,
+              value: Object.entries(jsonResult)
+                .map(([key, val]) => `${key},${val}`)
+                .join(","),
+            });
+          }
+        }
+      } else {
+        // Handle scalar values
+        postman.addHeader({ key: param.name, value: param.value });
+      }
     }
   });