fix: improve tanstack query cancellation and type/test safety

Author: Frank-III

package.json

@@ -40,7 +40,8 @@
 	"license": "MIT",
 	"scripts": {
 		"build": "tsdown",
-		"test": "bun test",
+		"test": "bun test && bun run test:types",
+		"test:types": "bunx tsc --project tsconfig.test.json",
 		"prepublishOnly": "bun run build"
 	},
 	"peerDependencies": {

src/index.ts

@@ -103,6 +103,17 @@ async function dataOrThrow<T>(
     return result.data as T
 }
 
+function withContextSignal(
+    fetch: RequestInit | undefined,
+    signal: AbortSignal | undefined
+): RequestInit | undefined {
+    if (!signal || fetch?.signal) return fetch
+    return {
+        ...(fetch ?? {}),
+        signal
+    }
+}
+
 interface ProxyContext {
     raw: any
     prefix: QueryKey
@@ -147,9 +158,14 @@ function createMethodDecorator(
     ): EdenQueryOptions<TData> => {
         return {
             queryKey: fn.queryKey(input),
-            queryFn: () => {
+            queryFn: (context) => {
                 const materializedPath = materializePath(pathTemplate, input?.params)
-                return dataOrThrow(callTreaty(ctx.raw, materializedPath, method, input))
+                return dataOrThrow(
+                    callTreaty(ctx.raw, materializedPath, method, {
+                        ...input,
+                        fetch: withContextSignal(input.fetch, context?.signal)
+                    })
+                )
             },
             ...overrides
         }
@@ -172,7 +188,8 @@ function createMethodDecorator(
                 }
                 return dataOrThrow<TData>(callTreaty(ctx.raw, materializedPath, method, {
                     ...input,
-                    query: queryWithCursor
+                    query: queryWithCursor,
+                    fetch: withContextSignal(input.fetch, context.signal)
                 }))
             },
             initialPageParam: opts.initialPageParam,

src/types.ts

@@ -50,6 +50,10 @@ type ExtractError<Res> = Res extends Record<number, unknown>
           }[Exclude<keyof Res, SuccessCodeRange>]
     : { status: unknown; value: unknown }
 
+type TreatyResponseMap<Res> = Res extends Record<number, unknown>
+    ? Res
+    : Record<number, unknown>
+
 interface TQParamBase {
     fetch?: RequestInit
 }
@@ -93,7 +97,7 @@ type TQMethodParam<
 
 export interface EdenQueryOptions<TData = unknown, TError = unknown> {
     queryKey: QueryKey
-    queryFn: () => Promise<TData>
+    queryFn: (context?: QueryFunctionContext<QueryKey>) => Promise<TData>
     enabled?: boolean
     staleTime?: number
     gcTime?: number
@@ -160,7 +164,7 @@ export interface EdenTQMethod<
     <TQueryFnData = ExtractData<Res>>(
         input: TQMethodParam<Body, Headers, Query, Params>,
         options?: RequestInit
-    ): Promise<Treaty.TreatyResponse<Res>>
+    ): Promise<Treaty.TreatyResponse<TreatyResponseMap<Res>>>
 
     queryKey(input?: OmitQueryInput<TQMethodParam<Body, Headers, Query, Params>>): QueryKey
 

test/tanstack-query-advanced.test.ts

@@ -1,7 +1,7 @@
 import { Elysia, t } from 'elysia'
 import { createEdenTQ, createEdenTQUtils } from '../src'
 import { QueryClient } from '@tanstack/query-core'
-import { describe, expect, it, beforeAll, afterAll, mock, test } from 'bun:test'
+import { describe, expect, it, mock, test } from 'bun:test'
 
 const posts = Array.from({ length: 50 }, (_, i) => ({
     id: `post-${i + 1}`,
@@ -53,21 +53,11 @@ const app = new Elysia()
         query: t.Object({
             page: t.Optional(t.String())
         })
-    })
-
-let server: ReturnType<typeof app.listen>
-
-beforeAll(() => {
-    server = app.listen(3459)
 })
 
-afterAll(() => {
-    server.stop()
-})
+const eden = createEdenTQ<typeof app>(app)
 
 describe('Infinite Query', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3459')
-
     it('generates infiniteQueryOptions with cursor pagination', async () => {
         const options = eden.posts.get.infiniteQueryOptions(
             { query: { limit: '5' } },
@@ -187,8 +177,6 @@ describe('Infinite Query', () => {
 })
 
 describe('EdenTQ Utils', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3459')
-
     it('creates utils with bound QueryClient', () => {
         const queryClient = new QueryClient()
         const utils = createEdenTQUtils(eden, queryClient)
@@ -267,8 +255,6 @@ describe('EdenTQ Utils', () => {
 })
 
 describe('Prefetch and Cache helpers on EdenTQ', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3459')
-
     it('prefetch works directly on eden', async () => {
         const queryClient = new QueryClient()
 
@@ -302,8 +288,6 @@ describe('Prefetch and Cache helpers on EdenTQ', () => {
 })
 
 describe('Query Options extensions', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3459')
-
     it('queryOptions accepts extended options', () => {
         const options = eden.get.queryOptions({}, {
             staleTime: 1000,

test/tanstack-query-integration.test.ts

@@ -1,7 +1,7 @@
 import { Elysia, t } from 'elysia'
 import { createEdenTQ } from '../src'
 import { QueryClient } from '@tanstack/query-core'
-import { describe, expect, it, beforeAll, afterAll, test } from 'bun:test'
+import { describe, expect, it, test } from 'bun:test'
 import { expectTypeOf } from 'expect-type'
 
 const ShareLinkSchema = t.Object({
@@ -108,19 +108,9 @@ const app = new Elysia()
         })
     )
 
-let server: ReturnType<typeof app.listen>
-
-beforeAll(() => {
-    server = app.listen(3458)
-})
-
-afterAll(() => {
-    server.stop()
-})
+const eden = createEdenTQ<typeof app>(app)
 
 describe('TanStack Query Integration', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3458')
-
     describe('Works with real QueryClient', () => {
         it('queryOptions works with QueryClient.fetchQuery', async () => {
             const queryClient = new QueryClient()
@@ -289,8 +279,6 @@ describe('TanStack Query Integration', () => {
 })
 
 describe('Usage Examples - Before vs After', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3458')
-
     test('Share Links Query - shows reduced boilerplate', async () => {
         const caseId = 'demo-case'
 

test/tanstack-query-real-world.test.ts

@@ -1,6 +1,6 @@
 import { Elysia, t } from 'elysia'
 import { createEdenTQ } from '../src'
-import { describe, expect, it, beforeAll, afterAll, mock, test } from 'bun:test'
+import { describe, expect, it, mock, test } from 'bun:test'
 import { expectTypeOf } from 'expect-type'
 
 const ShareLinkSchema = t.Object({
@@ -93,19 +93,9 @@ const app = new Elysia()
         })
     )
 
-let server: ReturnType<typeof app.listen>
-
-beforeAll(() => {
-    server = app.listen(3457)
-})
-
-afterAll(() => {
-    server.stop()
-})
+const eden = createEdenTQ<typeof app>(app)
 
 describe('Real-world API patterns', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3457')
-
     describe('Share Links Query', () => {
         it('generates correct queryOptions with type-safe response', async () => {
             const caseId = 'case-123'
@@ -293,8 +283,6 @@ describe('Real-world API patterns', () => {
 })
 
 describe('Comparison: Before vs After', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3457')
-
     it('shows the difference in boilerplate', async () => {
         const caseId = 'demo-case'
 

test/tanstack-query.test.ts

@@ -1,6 +1,6 @@
 import { Elysia, t } from 'elysia'
 import { createEdenTQ } from '../src'
-import { describe, expect, it, beforeAll, afterAll, mock, test } from 'bun:test'
+import { describe, expect, it, mock, test } from 'bun:test'
 
 const app = new Elysia()
     .get('/', () => 'hello')
@@ -23,18 +23,8 @@ const app = new Elysia()
         })
     })
 
-let server: ReturnType<typeof app.listen>
-
-beforeAll(() => {
-    server = app.listen(3456)
-})
-
-afterAll(() => {
-    server.stop()
-})
-
 describe('createEdenTQ', () => {
-    const eden = createEdenTQ<typeof app>('http://localhost:3456')
+    const eden = createEdenTQ<typeof app>(app)
 
     describe('queryKey', () => {
         it('generates query key for simple route', () => {

tsconfig.test.json

@@ -0,0 +1,10 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"noEmit": true,
+		"rootDir": ".",
+		"types": ["bun"]
+	},
+	"include": ["src/**/*", "test/types/**/*"],
+	"exclude": ["node_modules", "dist"]
+}