Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/svelte-query-no-infer-tdata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/svelte-query': patch
---

fix(svelte-query): wrap `TData` in `NoInfer` on `createQuery` and `createInfiniteQuery` return types so `TData` is inferred from the input options only (matching `react-query`, `preact-query`, and `vue-query`). Prevents the result-type annotation from silently widening `TData` and improves `select` inference (#7673).
3 changes: 2 additions & 1 deletion packages/svelte-query/src/createInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { createBaseQuery } from './createBaseQuery.svelte.js'
import type {
DefaultError,
InfiniteData,
NoInfer,
QueryClient,
QueryKey,
QueryObserver,
Expand Down Expand Up @@ -30,7 +31,7 @@ export function createInfiniteQuery<
>
>,
queryClient?: Accessor<QueryClient>,
): CreateInfiniteQueryResult<TData, TError> {
): CreateInfiniteQueryResult<NoInfer<TData>, TError> {
return createBaseQuery(
options,
InfiniteQueryObserver as typeof QueryObserver,
Expand Down
13 changes: 9 additions & 4 deletions packages/svelte-query/src/createQuery.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { QueryObserver } from '@tanstack/query-core'
import { createBaseQuery } from './createBaseQuery.svelte.js'
import type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'
import type {
DefaultError,
NoInfer,
QueryClient,
QueryKey,
} from '@tanstack/query-core'
import type {
Accessor,
CreateQueryOptions,
Expand All @@ -22,7 +27,7 @@ export function createQuery<
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
queryClient?: Accessor<QueryClient>,
): CreateQueryResult<TData, TError>
): CreateQueryResult<NoInfer<TData>, TError>

export function createQuery<
TQueryFnData = unknown,
Expand All @@ -34,7 +39,7 @@ export function createQuery<
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
queryClient?: Accessor<QueryClient>,
): DefinedCreateQueryResult<TData, TError>
): DefinedCreateQueryResult<NoInfer<TData>, TError>

export function createQuery<
TQueryFnData,
Expand All @@ -44,7 +49,7 @@ export function createQuery<
>(
options: Accessor<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
queryClient?: Accessor<QueryClient>,
): CreateQueryResult<TData, TError>
): CreateQueryResult<NoInfer<TData>, TError>

export function createQuery(
options: Accessor<CreateQueryOptions>,
Expand Down
39 changes: 39 additions & 0 deletions packages/svelte-query/tests/createQuery/createQuery.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,47 @@
import { describe, expectTypeOf, it } from 'vitest'
import { queryKey } from '@tanstack/query-test-utils'
import { createQuery, queryOptions } from '../../src/index.js'
import type { CreateQueryResult } from '../../src/index.js'

describe('createQuery', () => {
describe('select', () => {
it('should infer select data type from queryFn return (issue #7673)', () => {
const key = queryKey()
const { data } = createQuery(() => ({
queryKey: key,
queryFn: () => Promise.resolve({ a: { b: { c: 'hello' } } }),
select: (input) => input.a.b.c,
}))

expectTypeOf(data).toEqualTypeOf<string | undefined>()
})

it('should infer select data type when options come from queryOptions', () => {
const key = queryKey()
const options = queryOptions({
queryKey: key,
queryFn: () => Promise.resolve(1),
})
const { data } = createQuery(() => ({
...options,
select: (input) => input > 1,
}))

expectTypeOf(data).toEqualTypeOf<boolean | undefined>()
})

// eslint-disable-next-line vitest/expect-expect
it('TData should depend on arguments only, not on the result type annotation', () => {
// @ts-expect-error TData inferred from queryFn ({ wow: boolean }), not from result
const result: CreateQueryResult<{ wow: string }> = createQuery(() => ({
queryKey: queryKey(),
queryFn: () => ({ wow: true }),
}))

void result
})
})

describe('initialData', () => {
describe('Config object overload', () => {
it('TData should always be defined when initialData is provided as an object', () => {
Expand Down
Loading