@foundatiofx/fetchclient 1.1.0 → 1.1.1

package/esm/src/DefaultHelpers.js

@@ -73,6 +73,13 @@ export function getCurrentProvider() {
     }
     return getCurrentProviderFunc() ?? defaultProvider;
 }
+/**
+ * Gets the cache from the current provider.
+ * @returns The FetchClientCache instance.
+ */
+export function getCache() {
+    return getCurrentProvider().cache;
+}
 /**
  * Sets the function that retrieves the current FetchClientProvider using whatever scoping mechanism is available.
  * @param getProviderFunc - The function that retrieves the current FetchClientProvider.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foundatiofx/fetchclient",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A typed JSON fetch client with middleware support for Deno, Node and the browser.",
   "keywords": [
     "Fetch",

package/readme.md

@@ -14,7 +14,7 @@ handling.
 
 - **Typed JSON helpers** - `getJSON`, `postJSON`, `putJSON`, `patchJSON`,
   `deleteJSON`
-- **Two API styles** - Functional (no classes) or class-based - your choice
+- **Two API styles** - Functional or class-based - your choice
 - **Response caching** - TTL-based caching with tags for grouped invalidation
 - **Middleware** - Intercept requests/responses for logging, auth, transforms
 - **Rate limiting** - Per-domain rate limits with automatic header detection
@@ -33,15 +33,13 @@ npm install @foundatiofx/fetchclient
 
 FetchClient works two ways - pick whichever style you prefer:
 
-### Functional API (no classes)
+### Functional API
 
 ```ts
 import { getJSON, postJSON, setBaseUrl } from "@foundatiofx/fetchclient";
 
-// Optional: configure once at startup
 setBaseUrl("https://api.example.com");
 
-// Use simple functions anywhere
 const { data: users } = await getJSON<User[]>("/users");
 const { data: created } = await postJSON<User>("/users", { name: "Alice" });
 ```
@@ -69,9 +67,6 @@ const client = new FetchClient({ baseUrl: "https://api.example.com" });
 const { data } = await client.getJSON<User[]>("/users");
 ```
 
-All styles share the same configuration - the functional API wraps a
-[default provider](https://fetchclient.foundatio.dev/guide/provider#default-provider).
-
 ## Caching
 
 ```ts
@@ -112,12 +107,11 @@ usePerDomainRateLimit({
 ## Circuit Breaker
 
 ```ts
-import { FetchClientProvider } from "@foundatiofx/fetchclient";
+import { useCircuitBreaker } from "@foundatiofx/fetchclient";
 
-const provider = new FetchClientProvider();
-provider.useCircuitBreaker({
-  failureThreshold: 5, // Open after 5 failures
-  openDurationMs: 30000, // Stay open for 30 seconds
+useCircuitBreaker({
+  failureThreshold: 5,
+  openDurationMs: 30000,
 });
 
 // When API fails repeatedly, circuit opens
@@ -133,10 +127,9 @@ import { MockRegistry } from "@foundatiofx/fetchclient/mocks";
 const mocks = new MockRegistry();
 mocks.onGet("/api/users").reply(200, [{ id: 1, name: "Alice" }]);
 
-const provider = new FetchClientProvider();
-mocks.install(provider);
+const client = new FetchClient();
+mocks.install(client);
 
-const client = provider.getFetchClient();
 const { data } = await client.getJSON("/api/users");
 // data = [{ id: 1, name: "Alice" }]
 ```

package/script/src/DefaultHelpers.js

@@ -7,6 +7,7 @@ exports.putJSON = putJSON;
 exports.patchJSON = patchJSON;
 exports.deleteJSON = deleteJSON;
 exports.getCurrentProvider = getCurrentProvider;
+exports.getCache = getCache;
 exports.setCurrentProviderFunc = setCurrentProviderFunc;
 exports.setBaseUrl = setBaseUrl;
 exports.setAccessTokenFunc = setAccessTokenFunc;
@@ -92,6 +93,13 @@ function getCurrentProvider() {
     }
     return getCurrentProviderFunc() ?? FetchClientProvider_js_1.defaultInstance;
 }
+/**
+ * Gets the cache from the current provider.
+ * @returns The FetchClientCache instance.
+ */
+function getCache() {
+    return getCurrentProvider().cache;
+}
 /**
  * Sets the function that retrieves the current FetchClientProvider using whatever scoping mechanism is available.
  * @param getProviderFunc - The function that retrieves the current FetchClientProvider.

package/types/src/DefaultHelpers.d.ts

@@ -1,4 +1,5 @@
 import type { FetchClient } from "./FetchClient.js";
+import type { FetchClientCache } from "./FetchClientCache.js";
 import type { FetchClientMiddleware } from "./FetchClientMiddleware.js";
 import type { FetchClientOptions } from "./FetchClientOptions.js";
 import { type FetchClientProvider } from "./FetchClientProvider.js";
@@ -63,6 +64,11 @@ export declare function deleteJSON<T>(url: string, options?: RequestOptions): Pr
  * @returns The current FetchClientProvider.
  */
 export declare function getCurrentProvider(): FetchClientProvider;
+/**
+ * Gets the cache from the current provider.
+ * @returns The FetchClientCache instance.
+ */
+export declare function getCache(): FetchClientCache;
 /**
  * Sets the function that retrieves the current FetchClientProvider using whatever scoping mechanism is available.
  * @param getProviderFunc - The function that retrieves the current FetchClientProvider.

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

@@ -1 +1 @@
-{"version":3,"file":"DefaultHelpers.d.ts","sourceRoot":"","sources":["../../src/src/DefaultHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAI7E;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,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,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAMxD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,MAAM,mBAAmB,GAAG,IAAI,QAGlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,QAEzC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,MAAM,MAAM,GAAG,IAAI,QAGrC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,QAGnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,qBAAqB,QAE9D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,QAExD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,0BAA0B,QAGpC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,IAAI,CAAC,0BAA0B,EAAE,cAAc,CAAC,QAG1D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,+BAA+B,QAE1E;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,cAAc,CAAC,QAGhE"}
+{"version":3,"file":"DefaultHelpers.d.ts","sourceRoot":"","sources":["../../src/src/DefaultHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAI7E;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,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,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAEjC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAMxD;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,gBAAgB,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,MAAM,mBAAmB,GAAG,IAAI,QAGlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,QAEzC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,MAAM,MAAM,GAAG,IAAI,QAGrC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,QAGnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,qBAAqB,QAE9D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,QAExD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,0BAA0B,QAGpC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,IAAI,CAAC,0BAA0B,EAAE,cAAc,CAAC,QAG1D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,+BAA+B,QAE1E;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,cAAc,CAAC,QAGhE"}