react-fetch-utils 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Craig Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Readme.md

@@ -0,0 +1,326 @@
+# react-fetch-utils
+
+Lightweight React hooks and utilities for fetch requests with cancellation support.
+
+## Install
+
+```bash
+npm install react-fetch-utils
+```
+
+## Requirements
+
+- React 16.8+
+- Node 18+ (for package development/build tooling)
+
+## Import
+
+```ts
+import {
+    FetchPromise,
+    useQueries,
+    useRequest,
+    statusEnum,
+    type CancellablePromise,
+    type FetchPromiseParams,
+    type Status,
+} from "react-fetch-utils";
+```
+
+## Exports
+
+- `FetchPromise`
+- `useQueries`
+- `useRequest`
+- `statusEnum`
+- `CancellablePromise` (type)
+- `FetchPromiseParams` (type)
+- `Status` (type)
+
+## Quick Start
+
+```tsx
+import { useEffect } from "react";
+import { FetchPromise, useRequest } from "react-fetch-utils";
+
+type Todo = { id: number; title: string; completed: boolean };
+
+function getTodo() {
+    return FetchPromise<Todo>({
+        url: "https://jsonplaceholder.typicode.com/todos/1",
+        method: "GET",
+    });
+}
+
+export function TodoCard() {
+    const { status, response } = useRequest(getTodo);
+
+    useEffect(() => {
+        if (status !== 2 || !response) return;
+        console.log("Loaded:", response.title);
+    }, [status, response]);
+
+    if (status === 0) return <p>Idle</p>;
+    if (status === 1) return <p>Loading...</p>;
+    return <p>{response?.title}</p>;
+}
+```
+
+## API
+
+### `FetchPromise`
+
+Creates a cancellable promise around `fetch`.
+
+Signature:
+
+```ts
+function FetchPromise<T = unknown>(
+    params: FetchPromiseParams,
+): CancellablePromise<T>;
+```
+
+`FetchPromiseParams`:
+
+```ts
+type FetchPromiseParams = {
+    url: string;
+    method: string;
+    body?: object | null;
+    respType?: "raw" | "json" | null;
+};
+```
+
+Behavior:
+
+- Sends JSON body with `JSON.stringify(params.body)`.
+- Sends headers:
+    - `Accept: application/json` (or `blob` when `respType: "raw"`)
+    - `Content-Type: application/json`
+- Resolves with `response.json()` by default.
+- Resolves with `response.blob()` when `respType: "raw"`.
+- Rejects `401` with `{ reason: "Unauthorized", details: Response }`.
+- Rejects all other failures as `{ reason: "Unknown", details: error }`.
+- Returns a promise with `.cancel()` that aborts the underlying request.
+
+Example (JSON):
+
+```ts
+import { FetchPromise } from "react-fetch-utils";
+
+type User = { id: number; name: string };
+
+export function getUser() {
+    return FetchPromise<User>({
+        url: "/api/user",
+        method: "POST",
+        body: { includeDetails: true },
+    });
+}
+```
+
+Example (raw `Blob` + cancellation):
+
+```ts
+import { FetchPromise } from "react-fetch-utils";
+
+const download = FetchPromise<Blob>({
+    url: "/api/report",
+    method: "GET",
+    respType: "raw",
+});
+
+// Cancel if no longer needed
+download.cancel();
+```
+
+### `useQueries`
+
+Tracks active cancellable promises and provides list management helpers.
+
+Signature:
+
+```ts
+function useQueries(): {
+    list: CancellablePromise[];
+    cancelAll: () => void;
+    add: (query: CancellablePromise) => void;
+    remove: (query: CancellablePromise) => void;
+};
+```
+
+Example:
+
+```tsx
+import { useEffect } from "react";
+import { FetchPromise, useQueries } from "react-fetch-utils";
+
+export function SearchBox({ term }: { term: string }) {
+    const queries = useQueries();
+
+    useEffect(() => {
+        // Cancel older in-flight requests before starting a new one
+        queries.cancelAll();
+
+        const query = FetchPromise({
+            url: `/api/search?q=${encodeURIComponent(term)}`,
+            method: "GET",
+        });
+
+        queries.add(query);
+
+        query
+            .then(result => {
+                console.log(result);
+            })
+            .catch(error => {
+                // Abort rejections are surfaced in error.details
+                if (error?.details?.name === "AbortError") return;
+                console.error(error);
+            })
+            .finally(() => {
+                queries.remove(query);
+            });
+    }, [term]);
+
+    return <div>Active queries: {queries.list.length}</div>;
+}
+```
+
+### `useRequest`
+
+Runs a cancellable request factory on mount, tracks status, and caches by factory function name.
+
+Signature:
+
+```ts
+function useRequest<T = unknown>(
+    fetchPromise: (() => CancellablePromise<T>) | null | undefined,
+    disableCache?: boolean,
+): { status: Status; response: T | null };
+```
+
+Behavior:
+
+- Status transitions: `0` (idle) -> `1` (fetching) -> `2` (done)
+- Uses `fetchPromise.name` as cache key.
+- On cache hit and `disableCache === false`, returns cached data.
+- On cache miss, cancels tracked queries, runs request, tracks/removes it, then stores response.
+- Does not auto-run again on dependency changes; it executes once on mount for that hook instance.
+
+Example (cached by default):
+
+```tsx
+import { useEffect } from "react";
+import { FetchPromise, useRequest, statusEnum } from "react-fetch-utils";
+
+type Profile = { name: string; role: string };
+
+function loadProfile() {
+    return FetchPromise<Profile>({
+        url: "/api/profile",
+        method: "GET",
+    });
+}
+
+export function ProfilePanel() {
+    const { status, response } = useRequest(loadProfile);
+
+    useEffect(() => {
+        if (status !== 2 || !response) return;
+        console.log("Ready:", response.name);
+    }, [status, response]);
+
+    return <p>State: {statusEnum[status]}</p>;
+}
+```
+
+Example (disable cache):
+
+```tsx
+const { status, response } = useRequest(loadProfile, true);
+```
+
+### `statusEnum`
+
+Maps `Status` values to labels.
+
+```ts
+const statusEnum = {
+    0: "idle",
+    1: "fetching",
+    2: "done",
+} as const;
+```
+
+Example:
+
+```ts
+import { statusEnum, type Status } from "react-fetch-utils";
+
+function labelFor(status: Status) {
+    return statusEnum[status];
+}
+```
+
+### `CancellablePromise` (type)
+
+```ts
+type CancellablePromise<T = unknown> = Promise<T> & {
+    cancel: () => void;
+};
+```
+
+Example:
+
+```ts
+import { type CancellablePromise, FetchPromise } from "react-fetch-utils";
+
+const req: CancellablePromise<{ ok: boolean }> = FetchPromise({
+    url: "/api/health",
+    method: "GET",
+});
+
+req.cancel();
+```
+
+### `FetchPromiseParams` (type)
+
+Example:
+
+```ts
+import { type FetchPromiseParams, FetchPromise } from "react-fetch-utils";
+
+const request: FetchPromiseParams = {
+    url: "/api/items",
+    method: "POST",
+    body: { page: 1 },
+    respType: "json",
+};
+
+FetchPromise(request);
+```
+
+### `Status` (type)
+
+```ts
+type Status = 0 | 1 | 2;
+```
+
+Example:
+
+```ts
+import { type Status, statusEnum } from "react-fetch-utils";
+
+const status: Status = 1;
+console.log(statusEnum[status]); // "fetching"
+```
+
+## Notes
+
+- `useRequest` is built on top of `useQueries`.
+- For errors, attach `.catch(...)` where you create and consume `CancellablePromise` requests.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,45 @@
+interface FetchPromiseParams {
+    url: string;
+    method: string;
+    body?: object | null;
+    respType?: "raw" | "json" | null;
+}
+interface CancellablePromise<T = unknown> extends Promise<T> {
+    cancel: () => void;
+}
+/**
+ * @param params - Request configuration
+ * @returns A promise with a `.cancel()` method that calls `AbortController.abort()`
+ */
+declare const FetchPromise: <T = unknown>(params: FetchPromiseParams) => CancellablePromise<T>;
+
+declare function useQueries(): {
+    list: CancellablePromise<unknown>[];
+    cancelAll: () => void;
+    add: (query: CancellablePromise) => void;
+    remove: (query: CancellablePromise) => void;
+};
+
+/**
+ * Status enumerator.
+ * 0 = "idle"
+ * 1 = "fetching"
+ * 2 = "done"
+ */
+declare const statusEnum: {
+    readonly 0: "idle";
+    readonly 1: "fetching";
+    readonly 2: "done";
+};
+type Status = 0 | 1 | 2;
+/**
+ * @param fetchPromise - A factory function that returns a `CancellablePromise`
+ * @param disableCache - Disable cache and force a re-fetch every time this hook runs
+ * @returns `{ status, response }` where status is 0 (idle), 1 (fetching), or 2 (done)
+ */
+declare const useRequest: <T = unknown>(fetchPromise: (() => CancellablePromise<T>) | null | undefined, disableCache?: boolean) => {
+    status: Status;
+    response: T | null;
+};
+
+export { type CancellablePromise, FetchPromise, type FetchPromiseParams, type Status, statusEnum, useQueries, useRequest };

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+interface FetchPromiseParams {
+    url: string;
+    method: string;
+    body?: object | null;
+    respType?: "raw" | "json" | null;
+}
+interface CancellablePromise<T = unknown> extends Promise<T> {
+    cancel: () => void;
+}
+/**
+ * @param params - Request configuration
+ * @returns A promise with a `.cancel()` method that calls `AbortController.abort()`
+ */
+declare const FetchPromise: <T = unknown>(params: FetchPromiseParams) => CancellablePromise<T>;
+
+declare function useQueries(): {
+    list: CancellablePromise<unknown>[];
+    cancelAll: () => void;
+    add: (query: CancellablePromise) => void;
+    remove: (query: CancellablePromise) => void;
+};
+
+/**
+ * Status enumerator.
+ * 0 = "idle"
+ * 1 = "fetching"
+ * 2 = "done"
+ */
+declare const statusEnum: {
+    readonly 0: "idle";
+    readonly 1: "fetching";
+    readonly 2: "done";
+};
+type Status = 0 | 1 | 2;
+/**
+ * @param fetchPromise - A factory function that returns a `CancellablePromise`
+ * @param disableCache - Disable cache and force a re-fetch every time this hook runs
+ * @returns `{ status, response }` where status is 0 (idle), 1 (fetching), or 2 (done)
+ */
+declare const useRequest: <T = unknown>(fetchPromise: (() => CancellablePromise<T>) | null | undefined, disableCache?: boolean) => {
+    status: Status;
+    response: T | null;
+};
+
+export { type CancellablePromise, FetchPromise, type FetchPromiseParams, type Status, statusEnum, useQueries, useRequest };

package/dist/index.js

@@ -0,0 +1,127 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  FetchPromise: () => FetchPromise_default,
+  statusEnum: () => statusEnum,
+  useQueries: () => useQueries,
+  useRequest: () => useRequest
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/FetchPromise.ts
+var FetchPromise = (params) => {
+  const controller = new AbortController();
+  const signal = controller.signal;
+  const promise = new Promise(async function(resolve, reject) {
+    const headers = {
+      Accept: params.respType === "raw" ? "blob" : "application/json",
+      "Content-Type": "application/json"
+    };
+    await fetch(params.url, {
+      method: params.method,
+      signal,
+      headers,
+      body: JSON.stringify(params.body)
+    }).then((response) => {
+      if (response.status === 401) {
+        reject({ reason: "Unauthorized", details: response });
+      }
+      if (!response.ok) {
+        throw new Error(response.statusText);
+      }
+      if (params.respType === "raw") {
+        return response.blob();
+      }
+      return response.json();
+    }).then((data) => {
+      if (data !== void 0) resolve(data);
+    }).catch((error) => {
+      reject({ reason: "Unknown", details: error });
+    });
+  });
+  promise.cancel = () => controller.abort();
+  return promise;
+};
+var FetchPromise_default = FetchPromise;
+
+// src/useQueries.ts
+var import_react = require("react");
+function useQueries() {
+  const [list, setList] = (0, import_react.useState)([]);
+  return {
+    list,
+    cancelAll: () => {
+      const tempList = [...list];
+      if (tempList.length > 0) {
+        tempList.forEach((q) => q.cancel());
+        setList([]);
+      }
+    },
+    add: (query) => {
+      setList((prev) => [...prev, query]);
+    },
+    remove: (query) => {
+      setList((prev) => prev.filter((q) => q !== query));
+    }
+  };
+}
+
+// src/useRequest.ts
+var import_react2 = require("react");
+var statusEnum = {
+  0: "idle",
+  1: "fetching",
+  2: "done"
+};
+var useRequest = (fetchPromise, disableCache = false) => {
+  const cache = (0, import_react2.useRef)({});
+  const queries = useQueries();
+  const [status, setStatus] = (0, import_react2.useState)(0);
+  const [response, setResponse] = (0, import_react2.useState)(null);
+  (0, import_react2.useEffect)(() => {
+    if (!fetchPromise) return;
+    setStatus(1);
+    const cacheKey = fetchPromise.name;
+    if (cache.current[cacheKey] && !disableCache) {
+      setResponse(cache.current[cacheKey]);
+      setStatus(2);
+    } else {
+      queries.cancelAll();
+      const query = fetchPromise();
+      queries.add(query);
+      query.then((res) => {
+        queries.remove(query);
+        cache.current[cacheKey] = res;
+        setResponse(res);
+        setStatus(2);
+      });
+    }
+  }, []);
+  return { status, response };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FetchPromise,
+  statusEnum,
+  useQueries,
+  useRequest
+});

package/dist/index.mjs

@@ -0,0 +1,97 @@
+// src/FetchPromise.ts
+var FetchPromise = (params) => {
+  const controller = new AbortController();
+  const signal = controller.signal;
+  const promise = new Promise(async function(resolve, reject) {
+    const headers = {
+      Accept: params.respType === "raw" ? "blob" : "application/json",
+      "Content-Type": "application/json"
+    };
+    await fetch(params.url, {
+      method: params.method,
+      signal,
+      headers,
+      body: JSON.stringify(params.body)
+    }).then((response) => {
+      if (response.status === 401) {
+        reject({ reason: "Unauthorized", details: response });
+      }
+      if (!response.ok) {
+        throw new Error(response.statusText);
+      }
+      if (params.respType === "raw") {
+        return response.blob();
+      }
+      return response.json();
+    }).then((data) => {
+      if (data !== void 0) resolve(data);
+    }).catch((error) => {
+      reject({ reason: "Unknown", details: error });
+    });
+  });
+  promise.cancel = () => controller.abort();
+  return promise;
+};
+var FetchPromise_default = FetchPromise;
+
+// src/useQueries.ts
+import { useState } from "react";
+function useQueries() {
+  const [list, setList] = useState([]);
+  return {
+    list,
+    cancelAll: () => {
+      const tempList = [...list];
+      if (tempList.length > 0) {
+        tempList.forEach((q) => q.cancel());
+        setList([]);
+      }
+    },
+    add: (query) => {
+      setList((prev) => [...prev, query]);
+    },
+    remove: (query) => {
+      setList((prev) => prev.filter((q) => q !== query));
+    }
+  };
+}
+
+// src/useRequest.ts
+import { useState as useState2, useRef, useEffect } from "react";
+var statusEnum = {
+  0: "idle",
+  1: "fetching",
+  2: "done"
+};
+var useRequest = (fetchPromise, disableCache = false) => {
+  const cache = useRef({});
+  const queries = useQueries();
+  const [status, setStatus] = useState2(0);
+  const [response, setResponse] = useState2(null);
+  useEffect(() => {
+    if (!fetchPromise) return;
+    setStatus(1);
+    const cacheKey = fetchPromise.name;
+    if (cache.current[cacheKey] && !disableCache) {
+      setResponse(cache.current[cacheKey]);
+      setStatus(2);
+    } else {
+      queries.cancelAll();
+      const query = fetchPromise();
+      queries.add(query);
+      query.then((res) => {
+        queries.remove(query);
+        cache.current[cacheKey] = res;
+        setResponse(res);
+        setStatus(2);
+      });
+    }
+  }, []);
+  return { status, response };
+};
+export {
+  FetchPromise_default as FetchPromise,
+  statusEnum,
+  useQueries,
+  useRequest
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "react-fetch-utils",
+  "version": "1.0.0",
+  "description": "Lightweight React hooks and utilities for fetch requests with cancellation support",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepack": "npm run typecheck && npm run build",
+    "prepublishOnly": "npm run typecheck && npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wilsocr88/react-fetch-utils.git"
+  },
+  "author": "Craig Wilson <wilsocr88@gmail.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "bugs": {
+    "url": "https://github.com/wilsocr88/react-fetch-utils/issues"
+  },
+  "homepage": "https://github.com/wilsocr88/react-fetch-utils#readme",
+  "devDependencies": {
+    "@types/react": "^19.2.17",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vitest": "^3.2.4"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "react",
+    "fetch",
+    "hooks",
+    "cancel",
+    "abort",
+    "request"
+  ]
+}