@ribbon-studios/js-utils 1.4.2 → 1.5.0

package/README.md

@@ -28,6 +28,7 @@ Collection of generic javascript utilities curated by the Rainbow Cafe~
     - [`rfetch.patch`](#rfetchpatch)
     - [`rfetch.remove`](#rfetchremove)
     - [`rfetch.interceptors`](#rfetchinterceptors)
+    - [`rfetch.delimiters`](#rfetchdelimiters)
 
 ## Promises
 
@@ -221,6 +222,33 @@ rfetch.interceptors.remove(interceptor); // Remove the interceptor
 rfetch.interceptors.clear(); // Clear all interceptors
 ```
 
+### `rfetch.delimiters`
+
+Specifies which delimiters should be used.
+
+```tsx
+import { rfetch, DelimiterType } from '@ribbon-studios/js-utils';
+
+rfetch.delimiters(DelimiterType.DUPLICATE); // Use duplicate query params
+
+// This is the default functionality
+// https://ribbonstudios.com?hello=world&hello=welt
+await rfetch.get('https://ribbonstudios.com', {
+  params: {
+    hello: ['world', 'welt'],
+  },
+});
+
+rfetch.delimiters(DelimiterType.COMMA); // Use comma separators
+
+// https://ribbonstudios.com?hello=world,welt
+await rfetch.get('https://ribbonstudios.com', {
+  params: {
+    hello: ['world', 'welt'],
+  },
+});
+```
+
 [_**Want to Contribute?**_](/CONTRIBUTING.md)
 
 [npm-version-image]: https://img.shields.io/npm/v/@ribbon-studios/js-utils.svg

package/dist/index.cjs

@@ -41,42 +41,53 @@ async function retry(fn, n) {
     }
   }
 }
+var DelimiterType = /* @__PURE__ */ ((DelimiterType2) => {
+  DelimiterType2[DelimiterType2["COMMA"] = 0] = "COMMA";
+  DelimiterType2[DelimiterType2["DUPLICATE"] = 1] = "DUPLICATE";
+  return DelimiterType2;
+})(DelimiterType || {});
 let fetchInterceptors = [];
-async function rfetch(url, options) {
+let delimiter = 1;
+async function rfetch(url, { params, body, ...options } = {}) {
   var _a, _b;
   const requestInit = {
-    method: (options == null ? void 0 : options.method) ?? "GET"
+    method: "GET",
+    ...options
   };
   const internalURL = url instanceof URL ? url : new URL(url, url.startsWith("/") ? location.origin : void 0);
-  if (options == null ? void 0 : options.params) {
-    for (const [key, values] of Object.entries(options.params)) {
+  if (params) {
+    for (const [key, values] of Object.entries(params)) {
       if (Array.isArray(values)) {
-        for (const value of values) {
-          internalURL.searchParams.append(key, value.toString());
+        switch (delimiter) {
+          case 0:
+            internalURL.searchParams.set(key, values.map((value) => value.toString()).join(","));
+            break;
+          case 1:
+            values.forEach((value) => {
+              internalURL.searchParams.append(key, value.toString());
+            });
+            break;
         }
       } else {
         internalURL.searchParams.append(key, values.toString());
       }
     }
   }
-  if (requestInit.method !== "GET" && (options == null ? void 0 : options.body)) {
-    if (options.body instanceof FormData) {
-      requestInit.body = options.body;
+  if (requestInit.method !== "GET" && body) {
+    if (body instanceof FormData) {
+      requestInit.body = body;
       requestInit.headers = {
-        "Content-Type": "application/x-www-form-urlencoded",
-        ...requestInit.headers
+        "Content-Type": "application/x-www-form-urlencoded"
       };
-    } else if (typeof options.body === "string") {
-      requestInit.body = options.body;
+    } else if (typeof body === "string") {
+      requestInit.body = body;
       requestInit.headers = {
-        "Content-Type": "application/json",
-        ...requestInit.headers
+        "Content-Type": "application/json"
       };
     } else {
-      requestInit.body = JSON.stringify(options.body);
+      requestInit.body = JSON.stringify(body);
       requestInit.headers = {
-        "Content-Type": "application/json",
-        ...requestInit.headers
+        "Content-Type": "application/json"
       };
     }
   }
@@ -132,6 +143,10 @@ async function rfetch(url, options) {
     });
   }
   rfetch2.remove = remove;
+  async function delimiters(type) {
+    delimiter = type;
+  }
+  rfetch2.delimiters = delimiters;
   rfetch2.interceptors = {
     add(interceptor) {
       fetchInterceptors.push(interceptor);
@@ -146,6 +161,7 @@ async function rfetch(url, options) {
     }
   };
 })(rfetch || (rfetch = {}));
+exports.DelimiterType = DelimiterType;
 exports.assert = assert;
 exports.delay = delay;
 exports.never = never;

package/dist/index.js

@@ -39,42 +39,53 @@ async function retry(fn, n) {
     }
   }
 }
+var DelimiterType = /* @__PURE__ */ ((DelimiterType2) => {
+  DelimiterType2[DelimiterType2["COMMA"] = 0] = "COMMA";
+  DelimiterType2[DelimiterType2["DUPLICATE"] = 1] = "DUPLICATE";
+  return DelimiterType2;
+})(DelimiterType || {});
 let fetchInterceptors = [];
-async function rfetch(url, options) {
+let delimiter = 1;
+async function rfetch(url, { params, body, ...options } = {}) {
   var _a, _b;
   const requestInit = {
-    method: (options == null ? void 0 : options.method) ?? "GET"
+    method: "GET",
+    ...options
   };
   const internalURL = url instanceof URL ? url : new URL(url, url.startsWith("/") ? location.origin : void 0);
-  if (options == null ? void 0 : options.params) {
-    for (const [key, values] of Object.entries(options.params)) {
+  if (params) {
+    for (const [key, values] of Object.entries(params)) {
       if (Array.isArray(values)) {
-        for (const value of values) {
-          internalURL.searchParams.append(key, value.toString());
+        switch (delimiter) {
+          case 0:
+            internalURL.searchParams.set(key, values.map((value) => value.toString()).join(","));
+            break;
+          case 1:
+            values.forEach((value) => {
+              internalURL.searchParams.append(key, value.toString());
+            });
+            break;
         }
       } else {
         internalURL.searchParams.append(key, values.toString());
       }
     }
   }
-  if (requestInit.method !== "GET" && (options == null ? void 0 : options.body)) {
-    if (options.body instanceof FormData) {
-      requestInit.body = options.body;
+  if (requestInit.method !== "GET" && body) {
+    if (body instanceof FormData) {
+      requestInit.body = body;
       requestInit.headers = {
-        "Content-Type": "application/x-www-form-urlencoded",
-        ...requestInit.headers
+        "Content-Type": "application/x-www-form-urlencoded"
       };
-    } else if (typeof options.body === "string") {
-      requestInit.body = options.body;
+    } else if (typeof body === "string") {
+      requestInit.body = body;
       requestInit.headers = {
-        "Content-Type": "application/json",
-        ...requestInit.headers
+        "Content-Type": "application/json"
       };
     } else {
-      requestInit.body = JSON.stringify(options.body);
+      requestInit.body = JSON.stringify(body);
       requestInit.headers = {
-        "Content-Type": "application/json",
-        ...requestInit.headers
+        "Content-Type": "application/json"
       };
     }
   }
@@ -130,6 +141,10 @@ async function rfetch(url, options) {
     });
   }
   rfetch2.remove = remove;
+  async function delimiters(type) {
+    delimiter = type;
+  }
+  rfetch2.delimiters = delimiters;
   rfetch2.interceptors = {
     add(interceptor) {
       fetchInterceptors.push(interceptor);
@@ -145,6 +160,7 @@ async function rfetch(url, options) {
   };
 })(rfetch || (rfetch = {}));
 export {
+  DelimiterType,
   assert,
   delay,
   never,

package/dist/rfetch.d.ts

@@ -11,6 +11,10 @@ export type RibbonFetchError<R> = {
     content: R;
 };
 export type RibbonFetchInterceptor = (url: URL, options: RequestInit) => RequestInit | Promise<RequestInit>;
+export declare enum DelimiterType {
+    COMMA = 0,
+    DUPLICATE = 1
+}
 /**
  * A lightweight wrapper around fetch to simplify its usage.
  *
@@ -18,7 +22,7 @@ export type RibbonFetchInterceptor = (url: URL, options: RequestInit) => Request
  * @param options The request options.
  * @returns The typed response or an error containing the `status` and the `content`
  */
-export declare function rfetch<T = any, O extends RibbonFetchOptions = RibbonFetchOptions>(url: string | URL, options?: O): Promise<T>;
+export declare function rfetch<T = any>(url: string | URL, { params, body, ...options }?: RibbonFetchOptions): Promise<T>;
 export declare namespace rfetch {
     /**
      * Shorthand method for a GET request
@@ -61,6 +65,7 @@ export declare namespace rfetch {
      * @note This is named `remove` purely because `delete` is a reserved key
      */
     function remove<T>(url: string | URL, options?: RibbonFetchBodyOptions): Promise<T>;
+    function delimiters(type: DelimiterType): Promise<void>;
     const interceptors: {
         add(interceptor: RibbonFetchInterceptor): void;
         remove(interceptor: RibbonFetchInterceptor): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ribbon-studios/js-utils",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Collection of generic javascript utilities curated by the Rainbow Cafe~",
   "type": "module",
   "source": "src/*.ts",