endpoint-fetcher 1.0.1 → 1.1.0

package/README.md

@@ -146,7 +146,7 @@ await api.deleteUser({ id: '123' });
 
 ### 6. Custom Handler for Special Cases
 
-Use custom handlers when you need full control over the request (e.g., file uploads, custom headers, non-JSON responses).
+Use custom handlers when you need full control over the request (e.g., file uploads, custom headers, non-JSON responses). The handler receives `{ input, fetch, method, path, baseUrl }`.
 
 ```typescript
 const api = createApiClient(
@@ -154,12 +154,12 @@ const api = createApiClient(
     uploadFile: {
       method: 'POST',
       path: '/upload',
-      handler: async ({ input, fetch }) => {
+      handler: async ({ input, fetch, path, baseUrl }) => {
         const formData = new FormData();
         formData.append('file', input.file);
         formData.append('category', input.category);
   
-        const response = await fetch('https://api.example.com/upload', {
+        const response = await fetch(`${baseUrl}${path}`, {
           method: 'POST',
           body: formData,
           // Note: Don't set Content-Type for FormData
@@ -171,17 +171,17 @@ const api = createApiClient(
   
         return response.json();
       },
-    } as EndpointConfig
+    } as EndpointConfig<
       { file: File; category: string }, 
       { url: string; id: string }
     >,
 
     downloadFile: {
       method: 'GET',
-      path: '/download',
-      handler: async ({ input, fetch }) => {
+      path: (input: { id: string }) => `/files/${input.id}`,
+      handler: async ({ input, fetch, path, baseUrl }) => {
         const response = await fetch(
-          `https://api.example.com/files/${input.id}`,
+          `${baseUrl}${path}`,
           { method: 'GET' }
         );
   
@@ -353,21 +353,21 @@ const api = createApiClient(
     searchPosts: {
       method: 'GET',
       path: '/posts/search',
-      handler: async ({ input, fetch, path }) => {
+      handler: async ({ input, fetch, path, baseUrl }) => {
         const params = new URLSearchParams({
           q: input.query,
           ...(input.limit && { limit: input.limit.toString() }),
         });
   
         const response = await fetch(
-          `https://api.example.com${path}?${params}`,
+          `${baseUrl}${path}?${params}`,
           { method: 'GET' }
         );
   
         if (!response.ok) throw new Error('Search failed');
         return response.json();
       },
-    } as EndpointConfig
+    } as EndpointConfig<
       { query: string; limit?: number }, 
       Post[], 
       ApiError
@@ -398,18 +398,28 @@ Creates a type-safe API client.
 **Parameters:**
 
 - `endpoints`: Object mapping endpoint names to configurations
-
   - `method`: HTTP method ('GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE')
   - `path`: Static string or function `(input) => string`
-  - `handler`: Optional custom handler function (receives `{ input, fetch, method, path }`)
+  - `handler`: Optional custom handler function (receives `{ input, fetch, method, path, baseUrl }`)
 - `config`: Client configuration
-
   - `baseUrl`: Base URL for all requests
   - `fetch`: Optional custom fetch instance
   - `defaultHeaders`: Optional headers applied to all requests
 
 **Returns:** Type-safe client object with methods for each endpoint
 
+### Custom Handler Parameters
+
+When using a custom handler, you receive an object with:
+
+- `input`: The typed input parameters passed to the endpoint
+- `fetch`: The fetch instance (either custom or global)
+- `method`: The HTTP method for this endpoint
+- `path`: The resolved path (after applying input to path function if applicable)
+- `baseUrl`: The base URL from the client configuration
+
+This allows you to construct full URLs using `${baseUrl}${path}` in your custom handlers.
+
 ## TypeScript Support
 
 Full TypeScript support with generic types:
@@ -424,4 +434,4 @@ EndpointConfig<TInput, TOutput, TError>
 
 ## License
 
-MIT
+MIT

package/dist/index.d.mts

@@ -7,15 +7,28 @@ type EndpointConfig<TInput = any, TOutput = any, TError = any> = {
         fetch: typeof fetch;
         method: HttpMethod;
         path: string;
+        baseUrl: string;
     }) => Promise<TOutput>;
 };
+type Hooks = {
+    beforeRequest?: (url: string, init: RequestInit) => Promise<{
+        url: string;
+        init: RequestInit;
+    }> | {
+        url: string;
+        init: RequestInit;
+    };
+    afterResponse?: (response: Response, url: string, init: RequestInit) => Promise<Response> | Response;
+    onError?: (error: unknown) => Promise<void> | void;
+};
 type ApiConfig = {
     baseUrl: string;
     fetch?: typeof fetch;
     defaultHeaders?: HeadersInit;
+    hooks?: Hooks;
 };
 type EndpointDefinitions = Record<string, EndpointConfig>;
 
 declare function createApiClient<TEndpoints extends EndpointDefinitions>(endpoints: TEndpoints, config: ApiConfig): { [K in keyof TEndpoints]: TEndpoints[K] extends infer T ? T extends TEndpoints[K] ? T extends EndpointConfig<infer TInput, infer TOutput, any> ? (input: TInput) => Promise<TOutput> : never : never : never; };
 
-export { type ApiConfig, type EndpointConfig, type EndpointDefinitions, type HttpMethod, createApiClient };
+export { type ApiConfig, type EndpointConfig, type EndpointDefinitions, type Hooks, type HttpMethod, createApiClient };

package/dist/index.d.ts

@@ -7,15 +7,28 @@ type EndpointConfig<TInput = any, TOutput = any, TError = any> = {
         fetch: typeof fetch;
         method: HttpMethod;
         path: string;
+        baseUrl: string;
     }) => Promise<TOutput>;
 };
+type Hooks = {
+    beforeRequest?: (url: string, init: RequestInit) => Promise<{
+        url: string;
+        init: RequestInit;
+    }> | {
+        url: string;
+        init: RequestInit;
+    };
+    afterResponse?: (response: Response, url: string, init: RequestInit) => Promise<Response> | Response;
+    onError?: (error: unknown) => Promise<void> | void;
+};
 type ApiConfig = {
     baseUrl: string;
     fetch?: typeof fetch;
     defaultHeaders?: HeadersInit;
+    hooks?: Hooks;
 };
 type EndpointDefinitions = Record<string, EndpointConfig>;
 
 declare function createApiClient<TEndpoints extends EndpointDefinitions>(endpoints: TEndpoints, config: ApiConfig): { [K in keyof TEndpoints]: TEndpoints[K] extends infer T ? T extends TEndpoints[K] ? T extends EndpointConfig<infer TInput, infer TOutput, any> ? (input: TInput) => Promise<TOutput> : never : never : never; };
 
-export { type ApiConfig, type EndpointConfig, type EndpointDefinitions, type HttpMethod, createApiClient };
+export { type ApiConfig, type EndpointConfig, type EndpointDefinitions, type Hooks, type HttpMethod, createApiClient };

package/dist/index.js

@@ -24,11 +24,33 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 function createApiClient(endpoints, config) {
   const fetchInstance = config.fetch ?? globalThis.fetch;
+  const hooks = config.hooks;
   const buildUrl = (path, baseUrl) => {
     const normalizedBase = baseUrl.endsWith("/") ? baseUrl.slice(0, -1) : baseUrl;
     const normalizedPath = path.startsWith("/") ? path : `/${path}`;
     return `${normalizedBase}${normalizedPath}`;
   };
+  const enhancedFetch = async (input, init) => {
+    let url = typeof input === "string" ? input : input instanceof URL ? input.toString() : input.url;
+    let finalInit = { ...init };
+    if (hooks == null ? void 0 : hooks.beforeRequest) {
+      const result = await hooks.beforeRequest(url, finalInit);
+      url = result.url;
+      finalInit = result.init;
+    }
+    try {
+      let response = await fetchInstance(url, finalInit);
+      if (hooks == null ? void 0 : hooks.afterResponse) {
+        response = await hooks.afterResponse(response, url, finalInit);
+      }
+      return response;
+    } catch (error) {
+      if (hooks == null ? void 0 : hooks.onError) {
+        await hooks.onError(error);
+      }
+      throw error;
+    }
+  };
   const defaultHandler = async (method, path, input) => {
     const url = buildUrl(path, config.baseUrl);
     const options = {
@@ -41,7 +63,7 @@ function createApiClient(endpoints, config) {
     if (method !== "GET" && method !== "DELETE" && input !== void 0) {
       options.body = JSON.stringify(input);
     }
-    const response = await fetchInstance(url, options);
+    const response = await enhancedFetch(url, options);
     if (!response.ok) {
       const error = await response.json().catch(() => ({}));
       throw {
@@ -59,9 +81,10 @@ function createApiClient(endpoints, config) {
       if (endpoint.handler) {
         return endpoint.handler({
           input,
-          fetch: fetchInstance,
+          fetch: enhancedFetch,
           method: endpoint.method,
-          path
+          path,
+          baseUrl: config.baseUrl
         });
       }
       return defaultHandler(endpoint.method, path, input);

package/dist/index.mjs

@@ -1,11 +1,33 @@
 // src/index.ts
 function createApiClient(endpoints, config) {
   const fetchInstance = config.fetch ?? globalThis.fetch;
+  const hooks = config.hooks;
   const buildUrl = (path, baseUrl) => {
     const normalizedBase = baseUrl.endsWith("/") ? baseUrl.slice(0, -1) : baseUrl;
     const normalizedPath = path.startsWith("/") ? path : `/${path}`;
     return `${normalizedBase}${normalizedPath}`;
   };
+  const enhancedFetch = async (input, init) => {
+    let url = typeof input === "string" ? input : input instanceof URL ? input.toString() : input.url;
+    let finalInit = { ...init };
+    if (hooks == null ? void 0 : hooks.beforeRequest) {
+      const result = await hooks.beforeRequest(url, finalInit);
+      url = result.url;
+      finalInit = result.init;
+    }
+    try {
+      let response = await fetchInstance(url, finalInit);
+      if (hooks == null ? void 0 : hooks.afterResponse) {
+        response = await hooks.afterResponse(response, url, finalInit);
+      }
+      return response;
+    } catch (error) {
+      if (hooks == null ? void 0 : hooks.onError) {
+        await hooks.onError(error);
+      }
+      throw error;
+    }
+  };
   const defaultHandler = async (method, path, input) => {
     const url = buildUrl(path, config.baseUrl);
     const options = {
@@ -18,7 +40,7 @@ function createApiClient(endpoints, config) {
     if (method !== "GET" && method !== "DELETE" && input !== void 0) {
       options.body = JSON.stringify(input);
     }
-    const response = await fetchInstance(url, options);
+    const response = await enhancedFetch(url, options);
     if (!response.ok) {
       const error = await response.json().catch(() => ({}));
       throw {
@@ -36,9 +58,10 @@ function createApiClient(endpoints, config) {
       if (endpoint.handler) {
         return endpoint.handler({
           input,
-          fetch: fetchInstance,
+          fetch: enhancedFetch,
           method: endpoint.method,
-          path
+          path,
+          baseUrl: config.baseUrl
         });
       }
       return defaultHandler(endpoint.method, path, input);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "endpoint-fetcher",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Type-safe API client builder using fetch",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",