@foundatiofx/fetchclient 1.0.0 → 1.0.1

package/esm/src/FetchClient.js

@@ -248,7 +248,8 @@ export class FetchClient {
                 return this.problemToResponse(problem, url);
             }
         }
-        if (init?.body && typeof init.body === "object") {
+        if (init?.body && typeof init.body === "object" &&
+            !(init.body instanceof FormData)) {
             init.body = JSON.stringify(init.body);
         }
         const accessToken = this.options.accessTokenFunc?.() ?? null;
@@ -419,11 +420,12 @@ export class FetchClient {
         return value;
     }
     buildRequestInit(method, body, options) {
-        const isDefinitelyJsonBody = body !== undefined &&
-            body !== null &&
-            typeof body === "object";
+        const isFormData = typeof FormData !== "undefined" &&
+            body instanceof FormData;
+        const isJsonLikeObject = body !== undefined && body !== null &&
+            typeof body === "object" && !isFormData;
         const headers = {};
-        if (isDefinitelyJsonBody) {
+        if (isJsonLikeObject) {
             headers["Content-Type"] = "application/json";
         }
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foundatiofx/fetchclient",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A typed JSON fetch client with middleware support for Deno, Node and the browser.",
   "keywords": [
     "Fetch",
@@ -43,7 +43,7 @@
   "devDependencies": {
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0",
-    "zod": "^4.1.4",
+    "zod": "^4.1.11",
     "@deno/shim-deno": "~0.18.0"
   },
   "_generatedBy": "dnt@dev"

package/readme.md

@@ -6,298 +6,36 @@
 [![Build status](https://github.com/foundatiofx/foundatio/workflows/Build/badge.svg)](https://github.com/foundatiofx/foundatio/actions)
 [![Discord](https://img.shields.io/discord/715744504891703319)](https://discord.gg/6HxgFCx)
 
-<!-- deno-fmt-ignore-file -->
-
-FetchClient is a library that makes it easier to use the fetch API for JSON
-APIs. It provides the following features:
-
-- [Typed Response](#typed-response) - Full TypeScript support with strongly
-  typed responses
-- [Functional](#functional) - Standalone functions for simple usage
-- [Model Validator](#model-validator) - Built-in validation with Problem Details
-  support
-- [Caching](#caching) - Response caching with TTL and programmatic invalidation
-- [Middleware](#middleware) - Extensible middleware pipeline for
-  request/response handling
-- [Rate Limiting](#rate-limiting) - Built-in rate limiting with per-domain
-  support
-- [Request Timeout](#request-timeout) - Configurable timeouts with AbortSignal
-  support
-- [Error Handling](#error-handling) - Comprehensive error handling with Problem
-  Details
-- [Authentication](#authentication) - Built-in Bearer token support
-- [Base URL](#base-url) - Global base URL configuration
-- [Loading State](#loading-state) - Track request loading state with events
+FetchClient is a tiny, typed wrapper around `fetch` with JSON helpers, caching,
+middleware, rate limiting, timeouts, and friendly error handling.
 
 ## Install
 
-```shell
-npm install --save @foundatiofx/fetchclient
+```bash
+npm install @foundatiofx/fetchclient
 ```
 
-## Docs
-
-[API Documentation](https://jsr.io/@foundatiofx/fetchclient/doc)
-
-## Usage
-
-### Typed Response
+## Quick Example
 
 ```ts
 import { FetchClient } from "@foundatiofx/fetchclient";
 
-type Products = {
-  products: Array<{ id: number; name: string }>;
-};
+type Products = { products: Array<{ id: number; name: string }> };
 
 const client = new FetchClient();
-const response = await client.getJSON<Products>(
+const { data } = await client.getJSON<Products>(
   `https://dummyjson.com/products/search?q=iphone&limit=10`,
 );
 
-const products = response.data;
-```
-
-### Functional
-
-```ts
-import { getJSON, postJSON } from "@foundatiofx/fetchclient";
-
-type Product = { id: number; title: string };
-type Products = { products: Product[] };
-
-const response = await postJSON<Product>(
-  "https://dummyjson.com/products/add",
-  {
-    name: "iPhone 13",
-  },
-);
-
-const product = await getJSON<Product>(
-  `https://dummyjson.com/products/${response.data!.id}`,
-);
-```
-
-### Model Validator
-
-```ts
-import { FetchClient, setModelValidator } from "@foundatiofx/fetchclient";
-
-setModelValidator(async (data: object | null) => {
-  // use zod or any other validator
-  const problem = new ProblemDetails();
-  const d = data as { password: string };
-  if (d?.password?.length < 6) {
-    problem.errors.password = [
-      "Password must be longer than or equal to 6 characters.",
-    ];
-  }
-  return problem;
-});
-
-const client = new FetchClient();
-const data = {
-  email: "test@test",
-  password: "test",
-};
-
-const response = await client.postJSON(
-  "https://jsonplaceholder.typicode.com/todos/1",
-  data,
-);
-
-if (!response.ok) {
-  // check response problem
-  console.log(response.problem.detail);
-}
-```
-
-### Caching
-
-```ts
-import { FetchClient } from "@foundatiofx/fetchclient";
-
-type Todo = { userId: number; id: number; title: string; completed: boolean };
-
-const client = new FetchClient();
-const response = await client.getJSON<Todo>(
-  `https://jsonplaceholder.typicode.com/todos/1`,
-  {
-    cacheKey: ["todos", "1"],
-    cacheDuration: 1000 * 60, // expires in 1 minute
-  },
-);
-
-// invalidate programmatically
-client.cache.delete(["todos", "1"]);
-```
-
-### Middleware
-
-```ts
-import { FetchClient, useMiddleware } from "@foundatiofx/fetchclient";
-
-type Products = {
-  products: Array<{ id: number; name: string }>;
-};
-
-useMiddleware(async (ctx, next) => {
-  console.log("starting request");
-  await next();
-  console.log("completed request");
-});
-
-const client = new FetchClient();
-const response = await client.getJSON<Products>(
-  `https://dummyjson.com/products/search?q=iphone&limit=10`,
-);
-```
-
-### Rate Limiting
-
-```ts
-import { FetchClient, useRateLimit } from "@foundatiofx/fetchclient";
-
-// Enable rate limiting globally with 100 requests per minute
-useRateLimit({
-  maxRequests: 100,
-  windowSeconds: 60,
-});
-
-const client = new FetchClient();
-const response = await client.getJSON(
-  `https://api.example.com/data`,
-);
-```
-
-### Request Timeout
-
-```ts
-import { FetchClient } from "@foundatiofx/fetchclient";
-
-const client = new FetchClient();
-
-// Set timeout for individual requests
-const response = await client.getJSON(
-  `https://api.example.com/data`,
-  { timeout: 5000 }, // 5 seconds
-);
-
-// Use AbortSignal for cancellation
-const controller = new AbortController();
-setTimeout(() => controller.abort(), 1000);
-
-const response2 = await client.getJSON(
-  `https://api.example.com/data`,
-  { signal: controller.signal },
-);
-```
-
-### Error Handling
-
-```ts
-import { FetchClient } from "@foundatiofx/fetchclient";
-
-const client = new FetchClient();
-
-try {
-  const response = await client.getJSON(`https://api.example.com/data`);
-} catch (error) {
-  // Handle HTTP errors (4xx, 5xx)
-  if (error.problem) {
-    console.log(error.problem.title);
-    console.log(error.problem.detail);
-  }
-}
-
-// Or handle specific status codes
-const response = await client.getJSON(
-  `https://api.example.com/data`,
-  {
-    expectedStatusCodes: [404, 500],
-    errorCallback: (response) => {
-      if (response.status === 404) {
-        console.log("Resource not found");
-        return true; // Don't throw
-      }
-    },
-  },
-);
-```
-
-### Authentication
-
-```ts
-import { FetchClient, setAccessTokenFunc } from "@foundatiofx/fetchclient";
-
-// Set global access token function
-setAccessTokenFunc(() => localStorage.getItem("token"));
-
-const client = new FetchClient();
-const response = await client.getJSON(`https://api.example.com/data`);
-// Automatically adds Authorization: Bearer <token> header
+console.log(data?.products.length);
 ```
 
-### Base URL
-
-```ts
-import { FetchClient, setBaseUrl } from "@foundatiofx/fetchclient";
+## Documentation
 
-// Set global base URL
-setBaseUrl("https://api.example.com");
-
-const client = new FetchClient();
-const response = await client.getJSON(`/users/123`);
-// Requests to https://api.example.com/users/123
-```
-
-### Loading State
-
-```ts
-import { FetchClient } from "@foundatiofx/fetchclient";
-
-const client = new FetchClient();
-
-// Track loading state
-client.loading.on((isLoading) => {
-  console.log(`Loading: ${isLoading}`);
-});
-
-// Check current loading state
-console.log(client.isLoading);
-console.log(client.requestCount);
-```
-
-Also, take a look at the tests:
-
-[FetchClient Tests](src/FetchClient.test.ts)
-
-## Contributing
-
-Run tests:
-
-```shell
-deno run test
-```
-
-Lint code:
-
-```shell
-deno lint
-```
-
-Format code:
-
-```shell
-deno fmt
-```
-
-Type check code:
-
-```shell
-deno run check
-```
+- Guide & Examples: <https://fetchclient.foundatio.dev>
+  - Getting Started, Usage Examples, Contributing
+- API Reference: <https://jsr.io/@foundatiofx/fetchclient/doc>
 
-## License
+---
 
 MIT © [Foundatio](https://exceptionless.com)

package/script/src/FetchClient.js

@@ -251,7 +251,8 @@ class FetchClient {
                 return this.problemToResponse(problem, url);
             }
         }
-        if (init?.body && typeof init.body === "object") {
+        if (init?.body && typeof init.body === "object" &&
+            !(init.body instanceof FormData)) {
             init.body = JSON.stringify(init.body);
         }
         const accessToken = this.options.accessTokenFunc?.() ?? null;
@@ -422,11 +423,12 @@ class FetchClient {
         return value;
     }
     buildRequestInit(method, body, options) {
-        const isDefinitelyJsonBody = body !== undefined &&
-            body !== null &&
-            typeof body === "object";
+        const isFormData = typeof FormData !== "undefined" &&
+            body instanceof FormData;
+        const isJsonLikeObject = body !== undefined && body !== null &&
+            typeof body === "object" && !isFormData;
         const headers = {};
-        if (isDefinitelyJsonBody) {
+        if (isJsonLikeObject) {
             headers["Content-Type"] = "application/json";
         }
         return {

package/types/src/FetchClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FetchClient.d.ts","sourceRoot":"","sources":["../../src/src/FetchClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAElE,KAAK,KAAK,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AAKrC;;GAEG;AACH,qBAAa,WAAW;;IAOtB;;;OAGG;gBACS,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,mBAAmB;IA0BxE;;OAEG;IACH,IAAW,QAAQ,IAAI,mBAAmB,CAEzC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,kBAAkB,CAEvC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,gBAAgB,CAEnC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,KAAK,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAE1C;IAED;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,qBAAqB,EAAE,GAAG,WAAW;IAKvD;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAMlC;;;;;;;OAOG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,EACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;OAQG;IACH,SAAS,CAAC,CAAC,EACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAMpB,QAAQ;YAmBR,aAAa;YAwIb,gBAAgB;IAa9B,OAAO,CAAC,iBAAiB;YAuBX,eAAe;IA2C7B,OAAO,CAAC,eAAe;IAkBvB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,gBAAgB;IAwBxB,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,iBAAiB;IAiCzB,OAAO,CAAC,QAAQ;IAuDhB,OAAO,CAAC,gBAAgB;CAiCzB"}
+{"version":3,"file":"FetchClient.d.ts","sourceRoot":"","sources":["../../src/src/FetchClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAElE,KAAK,KAAK,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AAKrC;;GAEG;AACH,qBAAa,WAAW;;IAOtB;;;OAGG;gBACS,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,mBAAmB;IA0BxE;;OAEG;IACH,IAAW,QAAQ,IAAI,mBAAmB,CAEzC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,kBAAkB,CAEvC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,gBAAgB,CAEnC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,KAAK,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAE1C;IAED;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,qBAAqB,EAAE,GAAG,WAAW;IAKvD;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAMlC;;;;;;;OAOG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,EACR,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;;OAQG;IACH,OAAO,CAAC,CAAC,EACP,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;OAQG;IACH,SAAS,CAAC,CAAC,EACT,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAUlC;;;;;;OAMG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAexC;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAMpB,QAAQ;YAmBR,aAAa;YA2Ib,gBAAgB;IAa9B,OAAO,CAAC,iBAAiB;YAuBX,eAAe;IA2C7B,OAAO,CAAC,eAAe;IAkBvB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,gBAAgB;IAyBxB,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,iBAAiB;IAiCzB,OAAO,CAAC,QAAQ;IAuDhB,OAAO,CAAC,gBAAgB;CAiCzB"}