@ribbon-studios/js-utils 1.3.0 → 1.4.0

package/README.md

@@ -27,6 +27,7 @@ Collection of generic javascript utilities curated by the Rainbow Cafe~
     - [`rfetch.post`](#rfetchpost)
     - [`rfetch.patch`](#rfetchpatch)
     - [`rfetch.remove`](#rfetchremove)
+    - [`rfetch.interceptors`](#rfetchinterceptors)
 
 ## Promises
 
@@ -204,6 +205,22 @@ import { rfetch, type RibbonFetchError } from '@ribbon-studios/js-utils';
 await rfetch.remove<MyExpectedResponse>('https://ribbonstudios.com');
 ```
 
+### `rfetch.interceptors`
+
+Useful for enhancing requests with additional information
+
+```tsx
+import { rfetch, type RibbonFetchError } from '@ribbon-studios/js-utils';
+
+const interceptor = (url: URL, options: RequestInit): RequestInit | Promise<RequestInit> => {
+  return options; // Return the modified options!
+};
+
+rfetch.interceptors.add(interceptor); // Add the interceptor
+rfetch.interceptors.remove(interceptor); // Remove the interceptor
+rfetch.interceptors.clear(); // Clear all interceptors
+```
+
 [_**Want to Contribute?**_](/CONTRIBUTING.md)
 
 [npm-version-image]: https://img.shields.io/npm/v/@ribbon-studios/js-utils.svg

package/dist/index.cjs

@@ -41,16 +41,15 @@ async function retry(fn, n) {
     }
   }
 }
+let fetchInterceptors = [];
 async function rfetch(url, options) {
   var _a, _b;
-  const { params, headers, body, ...internalOptions } = {
-    method: "GET",
-    headers: {},
-    ...options
+  const requestInit = {
+    method: (options == null ? void 0 : options.method) ?? "GET"
   };
   const internalURL = url instanceof URL ? url : new URL(url, url.startsWith("/") ? location.origin : void 0);
-  if (params) {
-    for (const [key, values] of Object.entries(params)) {
+  if (options == null ? void 0 : options.params) {
+    for (const [key, values] of Object.entries(options.params)) {
       if (Array.isArray(values)) {
         for (const value of values) {
           internalURL.searchParams.append(key, value.toString());
@@ -60,18 +59,34 @@ async function rfetch(url, options) {
       }
     }
   }
-  let internalBody = void 0;
-  if (body) {
-    internalBody = body instanceof FormData ? body : JSON.stringify(body);
+  if (requestInit.method !== "GET" && (options == null ? void 0 : options.body)) {
+    if (options.body instanceof FormData) {
+      requestInit.body = options.body;
+      requestInit.headers = {
+        "Content-Type": "application/x-www-form-urlencoded",
+        ...requestInit.headers
+      };
+    } else if (typeof options.body === "string") {
+      requestInit.body = options.body;
+      requestInit.headers = {
+        "Content-Type": "application/json",
+        ...requestInit.headers
+      };
+    } else {
+      requestInit.body = JSON.stringify(options.body);
+      requestInit.headers = {
+        "Content-Type": "application/json",
+        ...requestInit.headers
+      };
+    }
   }
-  const response = await fetch(internalURL, {
-    ...internalOptions,
-    headers: {
-      "Content-Type": internalBody instanceof FormData ? "application/x-www-form-urlencoded" : "application/json",
-      ...headers
-    },
-    body: internalBody
-  });
+  const response = await fetch(
+    internalURL,
+    await fetchInterceptors.reduce(
+      async (output, interceptor) => await interceptor(internalURL, await output),
+      Promise.resolve(requestInit)
+    )
+  );
   const content = ((_b = (_a = response.headers.get("Content-Type")) == null ? void 0 : _a.toLowerCase()) == null ? void 0 : _b.includes("json")) ? await response.json() : await response.text();
   if (response.ok) {
     return content;
@@ -117,6 +132,19 @@ async function rfetch(url, options) {
     });
   }
   rfetch2.remove = remove;
+  rfetch2.interceptors = {
+    add(interceptor) {
+      fetchInterceptors.push(interceptor);
+    },
+    remove(interceptor) {
+      const index = fetchInterceptors.indexOf(interceptor);
+      if (index === -1) return;
+      fetchInterceptors.splice(index, 1);
+    },
+    clear() {
+      fetchInterceptors = [];
+    }
+  };
 })(rfetch || (rfetch = {}));
 exports.assert = assert;
 exports.delay = delay;

package/dist/index.js

@@ -39,16 +39,15 @@ async function retry(fn, n) {
     }
   }
 }
+let fetchInterceptors = [];
 async function rfetch(url, options) {
   var _a, _b;
-  const { params, headers, body, ...internalOptions } = {
-    method: "GET",
-    headers: {},
-    ...options
+  const requestInit = {
+    method: (options == null ? void 0 : options.method) ?? "GET"
   };
   const internalURL = url instanceof URL ? url : new URL(url, url.startsWith("/") ? location.origin : void 0);
-  if (params) {
-    for (const [key, values] of Object.entries(params)) {
+  if (options == null ? void 0 : options.params) {
+    for (const [key, values] of Object.entries(options.params)) {
       if (Array.isArray(values)) {
         for (const value of values) {
           internalURL.searchParams.append(key, value.toString());
@@ -58,18 +57,34 @@ async function rfetch(url, options) {
       }
     }
   }
-  let internalBody = void 0;
-  if (body) {
-    internalBody = body instanceof FormData ? body : JSON.stringify(body);
+  if (requestInit.method !== "GET" && (options == null ? void 0 : options.body)) {
+    if (options.body instanceof FormData) {
+      requestInit.body = options.body;
+      requestInit.headers = {
+        "Content-Type": "application/x-www-form-urlencoded",
+        ...requestInit.headers
+      };
+    } else if (typeof options.body === "string") {
+      requestInit.body = options.body;
+      requestInit.headers = {
+        "Content-Type": "application/json",
+        ...requestInit.headers
+      };
+    } else {
+      requestInit.body = JSON.stringify(options.body);
+      requestInit.headers = {
+        "Content-Type": "application/json",
+        ...requestInit.headers
+      };
+    }
   }
-  const response = await fetch(internalURL, {
-    ...internalOptions,
-    headers: {
-      "Content-Type": internalBody instanceof FormData ? "application/x-www-form-urlencoded" : "application/json",
-      ...headers
-    },
-    body: internalBody
-  });
+  const response = await fetch(
+    internalURL,
+    await fetchInterceptors.reduce(
+      async (output, interceptor) => await interceptor(internalURL, await output),
+      Promise.resolve(requestInit)
+    )
+  );
   const content = ((_b = (_a = response.headers.get("Content-Type")) == null ? void 0 : _a.toLowerCase()) == null ? void 0 : _b.includes("json")) ? await response.json() : await response.text();
   if (response.ok) {
     return content;
@@ -115,6 +130,19 @@ async function rfetch(url, options) {
     });
   }
   rfetch2.remove = remove;
+  rfetch2.interceptors = {
+    add(interceptor) {
+      fetchInterceptors.push(interceptor);
+    },
+    remove(interceptor) {
+      const index = fetchInterceptors.indexOf(interceptor);
+      if (index === -1) return;
+      fetchInterceptors.splice(index, 1);
+    },
+    clear() {
+      fetchInterceptors = [];
+    }
+  };
 })(rfetch || (rfetch = {}));
 export {
   assert,

package/dist/rfetch.d.ts

@@ -11,6 +11,7 @@ export type RibbonFetchError<R> = {
     status: number;
     content: R;
 };
+export type RibbonFetchInterceptor = (url: URL, options: RequestInit) => RibbonFetchOptions | Promise<RibbonFetchOptions>;
 /**
  * A lightweight wrapper around fetch to simplify its usage.
  *
@@ -18,7 +19,7 @@ export type RibbonFetchError<R> = {
  * @param options The request options.
  * @returns The typed response or an error containing the `status` and the `content`
  */
-export declare function rfetch<T = any>(url: string | URL, options?: RibbonFetchOptions): Promise<T>;
+export declare function rfetch<T = any, O extends RibbonFetchOptions = RibbonFetchOptions>(url: string | URL, options?: O): Promise<T>;
 export declare namespace rfetch {
     /**
      * Shorthand method for a GET request
@@ -61,5 +62,10 @@ 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>;
+    const interceptors: {
+        add(interceptor: RibbonFetchInterceptor): void;
+        remove(interceptor: RibbonFetchInterceptor): void;
+        clear(): void;
+    };
 }
 export {};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ribbon-studios/js-utils",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Collection of generic javascript utilities curated by the Rainbow Cafe~",
   "type": "module",
   "source": "src/*.ts",
   "main": "./dist/index.cjs",
   "module": "./dist/index.module.js",
   "unpkg": "./dist/index.umd.js",
-  "types": "dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {