eden-tanstack-query 0.0.1 → 0.0.3

package/README.md

@@ -1,4 +1,4 @@
-# @elysiajs/eden-tanstack-query
+# eden-tanstack-query
 
 A TanStack Query integration for [Eden Treaty](https://eden.ts), the type-safe client for [Elysia](https://elysiajs.com).
 
@@ -15,7 +15,7 @@ A TanStack Query integration for [Eden Treaty](https://eden.ts), the type-safe c
 ## Installation
 
 ```bash
-bun add @elysiajs/eden-tanstack-query @tanstack/query-core
+bun add eden-tanstack-query @tanstack/query-core
 ```
 
 ## Basic Usage
@@ -24,7 +24,7 @@ bun add @elysiajs/eden-tanstack-query @tanstack/query-core
 
 ```typescript
 import { treaty } from '@elysiajs/eden/treaty2'
-import { createEdenQuery } from '@elysiajs/eden-tanstack-query'
+import { createEdenQuery } from 'eden-tanstack-query'
 import { useQuery } from '@tanstack/svelte-query'
 
 // Your Elysia app type
@@ -91,19 +91,56 @@ const data = queryClient.getQueryData(eden.users.get.queryKey())
 
 ## Error Handling
 
-### Throw on Error (Default for most apps)
+### Global Error Handler
+
+Define error handling logic once when creating the client:
+
+```typescript
+import type { EdenErrorContext } from 'eden-tanstack-query'
+
+const eden = createEdenQuery<App>('http://localhost:8080', {
+  throwOnError: true,
+  onError: ({ error, path, method, type }: EdenErrorContext) => {
+    // Runs for ALL queries and mutations before throwing
+
+    if (error.status === 401) {
+      authStore.logout()
+      router.push('/login')
+    }
+
+    if (error.status === 403) {
+      toast.error('Not authorized')
+    }
+
+    if (error.status >= 500) {
+      toast.error('Server error, please try again')
+      logger.error('API Error', { path, method, error })
+    }
+  }
+})
+```
+
+The `EdenErrorContext` provides:
+- `error` - The `EdenFetchError` with status and value
+- `queryKey` - The generated query key
+- `method` - HTTP method ('get', 'post', etc.)
+- `path` - API path segments (['users', 'posts'])
+- `input` - The request input
+- `type` - Either 'query' or 'mutation'
+
+### Throw on Error (Default)
 
 ```typescript
 const eden = createEdenQuery<App>('http://localhost:8080', {
   throwOnError: true
 })
 
+// Per-query error handling (in addition to global handler)
 useQuery(eden.users.get.queryOptions(undefined, {
   onError: (error: EdenFetchError) => {
-    // error.status and error.value are available
-    // extra context is attached: error.queryKey, error.method, error.path, error.input
-    if (error.status === 401) {
-      router.push('/login')
+    // Runs after global handler, only for this query
+    if (error.status === 404) {
+      // Handle not found specifically for this query
     }
   }
 }))
@@ -123,6 +160,23 @@ const eden = createEdenQuery<App>('http://localhost:8080', {
 })
 ```
 
+### Known Limitation: `onSuccess` Data Type
+
+When using `throwOnError: true`, errors are thrown before reaching `onSuccess`. However, TypeScript cannot narrow the data type at compile-time since `throwOnError` is a runtime configuration. This means the `data` parameter in `onSuccess` may still include error union types from your response schema.
+
+**Workaround**: Use the `vars` parameter instead of `data` when you only need input values (e.g., for cache invalidation):
+
+```typescript
+useMutation(eden.users.post.mutationOptions({
+  onSuccess: (_, vars) => {
+    // Use vars instead of data for invalidation
+    queryClient.invalidateQueries({
+      queryKey: eden.users({ id: vars.userId }).get.queryKey()
+    })
+  }
+}))
+```
+
 ## Advanced Usage
 
 ### Custom Eden Treaty Options

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { QueryFilters, QueryKey, QueryObserverOptions, QueryFunctionContext, MutationOptions, InfiniteQueryObserverOptions } from '@tanstack/query-core';
+import * as _elysiajs_eden from '@elysiajs/eden';
 import { EdenFetchError } from '@elysiajs/eden';
+import { QueryFilters, QueryKey, QueryObserverOptions, QueryFunctionContext, MutationOptions, InfiniteQueryObserverOptions } from '@tanstack/query-core';
 import { Elysia } from 'elysia';
 import { Treaty } from '@elysiajs/eden/treaty2';
 export { Treaty, treaty } from '@elysiajs/eden/treaty2';
@@ -13,9 +14,18 @@ interface EdenThrowOnErrorContext {
     input: unknown;
 }
 type EdenThrowOnError = ((queryKey: readonly unknown[], status: number) => boolean) | ((context: EdenThrowOnErrorContext) => boolean);
+interface EdenErrorContext {
+    error: _elysiajs_eden.EdenFetchError;
+    queryKey: readonly unknown[];
+    method: HTTPMethod;
+    path: string[];
+    input: unknown;
+    type: 'query' | 'mutation';
+}
 interface EdenQueryConfig {
     throwOnError?: boolean | EdenThrowOnError;
     queryKeyPrefix?: string | string[];
+    onError?: (context: EdenErrorContext) => void;
 }
 interface EdenOptions<TEden = unknown> {
     eden?: TEden;
@@ -56,4 +66,4 @@ declare function createEdenQuery<App extends Elysia<any, any, any, any, any, any
     treaty?: Treaty.Config;
 }): EdenQueryify<Treaty.Create<App>>;
 
-export { type EdenInfiniteQueryOptions, type EdenMutationMethod, type EdenMutationOptions, type EdenOptions, type EdenQueryConfig, type EdenQueryKey, type EdenQueryMethod, type EdenQueryOptions, type EdenQueryify, type EdenThrowOnError, type EdenThrowOnErrorContext, type HTTPMethod, createEdenQuery };
+export { type EdenErrorContext, type EdenInfiniteQueryOptions, type EdenMutationMethod, type EdenMutationOptions, type EdenOptions, type EdenQueryConfig, type EdenQueryKey, type EdenQueryMethod, type EdenQueryOptions, type EdenQueryify, type EdenThrowOnError, type EdenThrowOnErrorContext, type HTTPMethod, createEdenQuery };

package/dist/index.js

@@ -50,6 +50,14 @@ function createQueryOptions(treatyCall, paths, method, globalConfig) {
           error.input = finalInput;
           error.response = result.response;
           error.headers = result.headers;
+          globalConfig.onError?.({
+            error,
+            queryKey,
+            method,
+            path: paths,
+            input: finalInput,
+            type: "query"
+          });
           if (shouldThrowOnError(globalConfig, {
             queryKey,
             status: result.status,
@@ -110,6 +118,14 @@ function createMutationOptions(treatyCall, paths, method, globalConfig) {
           error.input = variables;
           error.response = result.response;
           error.headers = result.headers;
+          globalConfig.onError?.({
+            error,
+            queryKey: mutationKey,
+            method,
+            path: paths,
+            input: variables,
+            type: "mutation"
+          });
           if (shouldThrowOnError2(globalConfig, {
             queryKey: mutationKey,
             status: result.status,
@@ -186,7 +202,8 @@ function createEdenQuery(domain, options) {
     [],
     {
       throwOnError: options?.throwOnError ?? true,
-      queryKeyPrefix: options?.queryKeyPrefix
+      queryKeyPrefix: options?.queryKeyPrefix,
+      onError: options?.onError
     }
   );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eden-tanstack-query",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "TanStack Query integration for Eden Treaty",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,14 +21,14 @@
   },
   "peerDependencies": {
     "@elysiajs/eden": ">=1.0.0",
-    "@tanstack/query-core": "^5.0.0"
+    "@tanstack/query-core": "^5.90.12"
   },
   "devDependencies": {
-    "@elysiajs/eden": "file:../..",
-    "@tanstack/react-query": "^5.0.0",
-    "@tanstack/svelte-query": "^5.0.0",
+    "@elysiajs/eden": "^1.4.6",
+    "@tanstack/react-query": "^5.90.12",
+    "@tanstack/svelte-query": "^5.90.2",
     "bun-types": "latest",
-    "typescript": "^5.0.0"
+    "typescript": "^5.9.3"
   },
   "keywords": [
     "elysia",