@zayne-labs/callapi 1.11.1 → 1.11.2

package/README.md

@@ -1,19 +1,22 @@
 <h1 align="center">CallApi</h1>
 
 <p align="center">
-   <img src="https://raw.githubusercontent.com/zayne-labs/callapi/refs/heads/main/apps/docs/public/logo.png" alt="CallApi Logo" width="30%">
+  <img src="https://raw.githubusercontent.com/zayne-labs/callapi/refs/heads/main/apps/docs/public/logo.png" alt="CallApi Logo" width="30%">
 </p>
 
 <p align="center">
+   <!-- <a href="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D"><img src="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D" alt="bundle size"></a> -->
    <a href="https://www.npmjs.com/package/@zayne-labs/callapi"><img src="https://img.shields.io/npm/v/@zayne-labs/callapi?style=flat&color=EFBA5F" alt="npm version"></a>
    <a href="https://github.com/zayne-labs/callapi/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@zayne-labs/callapi?style=flat&color=EFBA5F" alt="license"></a>
    <a href="https://www.npmjs.com/package/@zayne-labs/callapi"><img src="https://img.shields.io/npm/dm/@zayne-labs/callapi?style=flat&color=EFBA5F" alt="downloads per month"></a>
    <a href="https://github.com/zayne-labs/callapi/graphs/commit-activity"><img src="https://img.shields.io/github/commit-activity/m/zayne-labs/callapi?style=flat&color=EFBA5F" alt="commit activity"></a>
-   <a href="https://deepwiki.com/zayne-labs/callapi"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
-   <a href="https://code2tutorial.com/tutorial/02b6c57c-4847-4e76-b91e-d64dde370609/index.md"><img src="https://img.shields.io/badge/Code2Tutorial-blue?color=blue&logo=victoriametrics" alt="Code2Tutorial"></a>
-</p>
+ <a href="https://deepwiki.com/zayne-labs/callapi"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+   <a href="https://code2tutorial.com/tutorial/f77cfbd0-3c37-4c37-9608-b3c977e46f00/index.md"><img src="https://img.shields.io/badge/Code2Tutorial-blue?color=blue&logo=victoriametrics" alt="Code2Tutorial"></a>
+ </p>
 
-<p align="center">A fetch wrapper that actually solves real problems.</p>
+<p align="center">
+  <strong>An advanced fetch library that actually solves real problems.</strong>
+</p>
 
 <p align="center">
   <a href="https://zayne-labs-callapi.netlify.app"><strong>Documentation</strong></a> ·
@@ -23,9 +26,11 @@
 
 ---
 
-Stop writing the same HTTP boilerplate in every project. CallApi is a drop-in replacement for fetch with all the features you'd build yourself anyway - just done properly.
+## Why?
 
-**Under 6KB. Zero dependencies. Runs everywhere.**
+Fetch is too basic for real apps. You end up writing the same boilerplate: error handling, retries, deduplication, response parsing etc. CallApi handles all of that and practically more.
+
+**Drop-in replacement for fetch. Under 6KB. Zero dependencies.**
 
 ```js
 import { callApi } from "@zayne-labs/callapi";
@@ -33,180 +38,118 @@ import { callApi } from "@zayne-labs/callapi";
 const { data, error } = await callApi("/api/users");
 ```
 
-## The Problem
-
-Fetch is great for simple requests, but real apps need more:
-
-- Handling duplicate requests (user spam-clicks a button)
-- Retrying failed requests (network flaky, API rate-limiting)
-- Parsing responses (stop writing `await response.json()` everywhere)
-- Error handling that makes sense (not just `response.ok`)
-- TypeScript types that actually work
+## Features
 
-You end up writing the same code over and over. Or pulling in a 100KB library.
-
-## What CallApi Does
-
-It's fetch, but with the stuff you actually need:
-
-### Request Deduplication
-
-User spam-clicks? No problem. Duplicate requests are handled automatically.
+**Request Deduplication** - User spam-clicks a button? Handled. No race conditions.
 
 ```js
-// These share the same request - no race conditions
 const req1 = callApi("/api/user");
-const req2 = callApi("/api/user"); // Reuses req1's response
+const req2 = callApi("/api/user"); // Shares req1's response
 ```
 
-Three strategies:
-
-- **Cancel**: Latest request wins (perfect for search-as-you-type)
-- **Defer**: Share response between duplicates (when multiple components need the same data)
-- **None**: Let them all through (for polling)
-
-### Smart Response Parsing
-
-Looks at Content-Type and does the right thing. No more manual parsing.
+**Smart Response Parsing** - Looks at Content-Type, does the right thing.
 
 ```js
 const { data } = await callApi("/api/data"); // JSON? Parsed.
-const { data } = await callApi("/page.html"); // HTML? String.
-const { data } = await callApi("/image.png"); // Image? Blob.
 ```
 
-### Error Handling That Makes Sense
+**Error Handling** - Structured errors you can actually use.
 
 ```js
 const { data, error } = await callApi("/api/users");
-
 if (error) {
-	console.log(error.name); // "HTTPError", "ValidationError", "TimeoutError"
-	console.log(error.errorData); // The actual error response from your API
+	console.log(error.name); // "HTTPError", "ValidationError"
+	console.log(error.errorData); // Actual API response
 }
 ```
 
-No more `try/catch` hell. No more checking `response.ok`. Just clean, predictable errors.
-
-### Retries That Actually Work
-
-Network flaky? API rate-limiting you? Handled.
+**Retries** - Exponential backoff, custom conditions.
 
 ```js
 await callApi("/api/data", {
 	retryAttempts: 3,
-	retryStrategy: "exponential", // 1s, 2s, 4s, 8s...
+	retryStrategy: "exponential",
 	retryStatusCodes: [429, 500, 502, 503],
 });
 ```
 
-### Schema Validation (Type-Safe + Runtime)
-
-Define your API schema once, get TypeScript types AND runtime validation:
+**Schema Validation** - TypeScript types + runtime validation.
 
 ```js
 import { z } from "zod";
 import { defineSchema, createFetchClient } from "@zayne-labs/callapi";
 
 const api = createFetchClient({
-	baseURL: "https://api.example.com",
 	schema: defineSchema({
 		"/users/:id": {
 			data: z.object({
 				id: z.number(),
 				name: z.string(),
-				email: z.string(),
 			}),
 		},
 	}),
 });
 
-const user = await api("/users/123");
-// TypeScript knows the exact shape
-// Runtime validates it matches
-// If it doesn't? ValidationError with details
-```
-
-Works with Zod, Valibot, ArkType, or any Standard Schema validator.
-
-### URL Helpers
-
-```js
-// Dynamic params
-await callApi("/users/:id/posts/:postId", {
-	params: { id: 123, postId: 456 },
-}); // → /users/123/posts/456
-
-// Query strings
-await callApi("/search", {
-	query: { q: "javascript", limit: 10 },
-}); // → /search?q=javascript&limit=10
-
-// Method prefixes
-await callApi("@delete/users/123"); // Sets method to DELETE
+const user = await api("/users/123"); // Fully typed + validated
 ```
 
-### Hooks for Everything
+**Hooks** - Intercept at any point.
 
 ```js
 const api = createFetchClient({
 	onRequest: ({ request }) => {
-		// Add auth, modify headers
 		request.headers.set("Authorization", `Bearer ${token}`);
 	},
-
-	onResponse: ({ data, response }) => {
-		// Log, cache, transform
-		console.log(`${response.status} - ${response.url}`);
-	},
-
 	onError: ({ error }) => {
-		// Send to error tracking
 		Sentry.captureException(error);
 	},
-
-	onRequestStream: ({ event }) => {
-		// Upload progress
-		console.log(`Uploaded ${event.progress}%`);
-	},
-
 	onResponseStream: ({ event }) => {
-		// Download progress
-		updateProgressBar(event.progress);
+		console.log(`Downloaded ${event.progress}%`);
 	},
 });
 ```
 
-### Plugin System
-
-Build plugins for caching, upload progress with XHR, offline detection, whatever you need:
+**Plugins** - Extend with middleware.
 
 ```js
 const cachingPlugin = definePlugin({
-	id: "caching",
+	id: "caching-plugin",
+	name: "Caching plugin",
 
-	middlewares: ({ options }) => {
+	middlewares: (ctx) => {
 		const cache = new Map();
 
 		return {
 			fetchMiddleware: (fetchImpl) => async (input, init) => {
-				// Check cache first
-				const cached = cache.get(input.toString());
-				if (cached && !isExpired(cached)) {
-					return cached.response.clone();
+				const key = input.toString();
+
+				if (cache.has(key)) {
+					return cache.get(key).clone();
 				}
 
-				// Fetch and cache
 				const response = await fetchImpl(input, init);
-				cache.set(input.toString(), { response: response.clone(), timestamp: Date.now() });
+				cache.set(key, response.clone());
+
 				return response;
 			},
 		};
 	},
 });
+
+const callBackendApi = createFetchClient({
+	plugins: [cachingPlugin],
+});
 ```
 
-Plugins can wrap fetch (middleware), add hooks, define custom options. They compose automatically.
+**URL Helpers** - Dynamic params, query strings, method prefixes.
+
+```js
+await callApi("/users/:id", { params: { id: 123 } });
+await callApi("/search", { query: { q: "test" } });
+await callApi("@delete/users/123");
+```
+
+And so much more.
 
 ## Installation
 
@@ -217,42 +160,33 @@ npm install @zayne-labs/callapi
 ```js
 import { callApi, createFetchClient } from "@zayne-labs/callapi";
 
-// Simple usage
-const { data, error } = await callApi("/api/users");
+// Simple
+const { data } = await callApi("/api/users");
 
-// Configured client
+// Configured
 const api = createFetchClient({
 	baseURL: "https://api.example.com",
 	retryAttempts: 2,
 	timeout: 10000,
-	dedupeStrategy: "cancel",
 	onError: ({ error }) => trackError(error),
 });
-
-const users = await api("/users");
 ```
 
-### CDN (No Build Step)
+### CDN
 
 ```html
 <script type="module">
 	import { callApi } from "https://esm.run/@zayne-labs/callapi";
-
-	const { data } = await callApi("/api/users");
 </script>
 ```
 
-## Why It's Nice to Use
-
-**TypeScript just works.** Full inference everywhere. Your editor knows what `data` is without you telling it.
-
-**The API feels familiar.** If you know fetch, you know 90% of CallApi. The rest is just additions that make sense.
-
-**It's actually small.** Under 6KB. Zero dependencies. Tree-shakeable. Not one of those "lightweight" libraries that's actually 50KB.
-
-**It's fast.** Built on native Web APIs (Fetch, AbortController, Streams). No abstractions that slow things down.
+## What makes it worth considering?
 
-**It works everywhere.** Browsers, Node 18+, Deno, Bun, Cloudflare Workers. If it runs JavaScript, it runs CallApi.
+- **TypeScript-first** - Full inference everywhere
+- **Familiar API** - If you know fetch, you know CallApi
+- **Actually small** - Zero dependencies and Under 6KB, unlike other 50kb libs in the wild
+- **Fast** - Built on native Web APIs
+- **Works everywhere** - Browsers, Node 18+, Deno, Bun, Cloudflare Workers
 
 ## License
 

package/dist/esm/{common-B2rPuIEQ.js → common-CNM4LjFu.js}

@@ -529,9 +529,13 @@ const getInitFetchImpl = (customFetchImpl) => {
 	if (typeof globalThis !== "undefined" && isFunction(globalThis.fetch)) return globalThis.fetch;
 	throw new Error("No fetch implementation found");
 };
-const getFetchImpl = (customFetchImpl, fetchMiddleware) => {
-	const initFetchApi = getInitFetchImpl(customFetchImpl);
-	return fetchMiddleware ? fetchMiddleware(initFetchApi) : initFetchApi;
+const getFetchImpl = (context) => {
+	const { customFetchImpl, fetchMiddleware, requestContext } = context;
+	const initFetchImpl = getInitFetchImpl(customFetchImpl);
+	return fetchMiddleware ? fetchMiddleware({
+		...requestContext,
+		fetchImpl: initFetchImpl
+	}) : initFetchImpl;
 };
 const PromiseWithResolvers = () => {
 	let reject;
@@ -573,4 +577,4 @@ const toArray = (value) => isArray(value) ? value : [value];
 
 //#endregion
 export { HTTPError, ValidationError, createCombinedSignal, createTimeoutSignal, deterministicHashFn, extraOptionDefaults, fallBackRouteSchemaKey, getBody, getCurrentRouteSchemaKeyAndMainInitURL, getFetchImpl, getFullAndNormalizedURL, getHeaders, getMethod, handleConfigValidation, handleSchemaValidation, isArray, isBoolean, isFunction, isHTTPError, isHTTPErrorInstance, isJavascriptError, isObject, isPlainObject, isReadableStream, isString, isValidationError, isValidationErrorInstance, splitBaseConfig, splitConfig, toQueryString, waitFor };
-//# sourceMappingURL=common-B2rPuIEQ.js.map
+//# sourceMappingURL=common-CNM4LjFu.js.map