Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues with queryOptions factory method types #8394

Merged
merged 9 commits into from
Dec 17, 2024
+124 −23
Merged

Fix issues with queryOptions factory method types #8394

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
00bd10e
Fix issues with queryOptions factory method types
Nick-Lucas Dec 3, 2024
f3deaf1
Apply the same fixes to infiniteQueryOptions
Nick-Lucas Dec 4, 2024
59313c0
Revert change to failing test
Nick-Lucas Dec 4, 2024
2c4ec39
Fix test in more userland way
Nick-Lucas Dec 4, 2024
1f7d0b2
Unused import
Nick-Lucas Dec 4, 2024
9623166
Add tRPC-style solution
Nick-Lucas Dec 11, 2024
b369e80
Merge branch 'main' into fixing-type-issues
Nick-Lucas Dec 11, 2024
e464740
Unused import
Nick-Lucas Dec 11, 2024
3b26d75
Merge branch 'main' into fixing-type-issues
TkDodo Dec 17, 2024
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
9 changes: 2 additions & 7 deletions packages/query-core/src/__tests__/queryClient.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,16 +228,11 @@ describe('fully typed usage', () => {
TData,
TError,
TData,
QueryKey & DataTag<unknown, TData, TError>
DataTag<QueryKey, TData, TError>
> = {
predicate(query) {
expectTypeOf(query).toEqualTypeOf<
Query<
TData,
TError,
TData,
QueryKey & DataTag<unknown, TData, TError>
>
Query<TData, TError, TData, DataTag<QueryKey, TData, TError>>
>()
expectTypeOf(query.state.data).toEqualTypeOf<TData | undefined>()
expectTypeOf(query.state.error).toEqualTypeOf<TError | null>()
Expand Down
4 changes: 2 additions & 2 deletions packages/query-core/src/__tests__/utils.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ describe('QueryFilters', () => {
TData,
Error,
TData,
QueryKey & DataTag<unknown, TData>
DataTag<QueryKey, TData>
> = {
predicate(query) {
expectTypeOf(query.setData({ a: 1, b: '1' })).toEqualTypeOf<TData>()
Expand All @@ -37,7 +37,7 @@ describe('QueryFilters', () => {
TData,
TError,
TData,
QueryKey & DataTag<unknown, TData, TError>
DataTag<QueryKey, TData, TError>
> = {
predicate(query) {
expectTypeOf(query.setData({ a: 1, b: '1' })).toEqualTypeOf<TData>()
Expand Down
16 changes: 13 additions & 3 deletions packages/query-core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,20 @@ export declare const dataTagSymbol: unique symbol
export declare const dataTagErrorSymbol: unique symbol
export declare const unsetMarker: unique symbol
export type UnsetMarker = typeof unsetMarker
export type DataTag<TType, TValue, TError = UnsetMarker> = TType & {
[dataTagSymbol]: TValue
[dataTagErrorSymbol]: TError
export type AnyDataTag = {
[dataTagSymbol]: any
[dataTagErrorSymbol]: any
}
export type DataTag<
TType,
TValue,
TError = UnsetMarker,
> = TType extends AnyDataTag
? TType
: TType & {
[dataTagSymbol]: TValue
[dataTagErrorSymbol]: TError
}
TkDodo marked this conversation as resolved.
Show resolved Hide resolved

export type QueryFunction<
T = unknown,
Expand Down
40 changes: 39 additions & 1 deletion packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import { infiniteQueryOptions } from '../infiniteQueryOptions'
import { useInfiniteQuery } from '../useInfiniteQuery'
import { useSuspenseInfiniteQuery } from '../useSuspenseInfiniteQuery'
import { useQuery } from '../useQuery'
import type { InfiniteData, InitialDataFunction } from '@tanstack/query-core'
import type {
DataTag,
InfiniteData,
InitialDataFunction,
} from '@tanstack/query-core'

describe('infiniteQueryOptions', () => {
it('should not allow excess properties', () => {
Expand Down Expand Up @@ -200,4 +204,38 @@ describe('infiniteQueryOptions', () => {
| undefined
>()
})

it('should return a custom query key type', () => {
type MyQueryKey = [Array<string>, { type: 'foo' }]

const options = infiniteQueryOptions({
queryKey: [['key'], { type: 'foo' }] as MyQueryKey,
queryFn: () => Promise.resolve(1),
getNextPageParam: () => 1,
initialPageParam: 1,
})

expectTypeOf(options.queryKey).toEqualTypeOf<
DataTag<MyQueryKey, InfiniteData<number>, Error>
>()
})

it('should return a custom query key type with datatag', () => {
type MyQueryKey = DataTag<
[Array<string>, { type: 'foo' }],
number,
Error & { myMessage: string }
>

const options = infiniteQueryOptions({
queryKey: [['key'], { type: 'foo' }] as MyQueryKey,
queryFn: () => Promise.resolve(1),
getNextPageParam: () => 1,
initialPageParam: 1,
})

expectTypeOf(options.queryKey).toEqualTypeOf<
DataTag<MyQueryKey, InfiniteData<number>, Error & { myMessage: string }>
>()
})
})
35 changes: 34 additions & 1 deletion packages/react-query/src/__tests__/queryOptions.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { useQueries } from '../useQueries'
import { useSuspenseQuery } from '../useSuspenseQuery'
import type { UseQueryOptions } from '../types'
import type {
DataTag,
InitialDataFunction,
QueryObserverResult,
} from '@tanstack/query-core'
Expand Down Expand Up @@ -236,7 +237,9 @@ describe('queryOptions', () => {
})

it('should be passable to UseQueryOptions', () => {
function somethingWithQueryOptions(options: UseQueryOptions<number>) {
function somethingWithQueryOptions(
options: UseQueryOptions<number, any, any, Array<string>>,
Nick-Lucas marked this conversation as resolved.
Show resolved Hide resolved
) {
TkDodo marked this conversation as resolved.
Show resolved Hide resolved
return options.queryKey
}

Expand All @@ -247,4 +250,34 @@ describe('queryOptions', () => {

somethingWithQueryOptions(options)
})

it('should return a custom query key type', () => {
type MyQueryKey = [Array<string>, { type: 'foo' }]

const options = queryOptions({
queryKey: [['key'], { type: 'foo' }] as MyQueryKey,
queryFn: () => Promise.resolve(1),
})

expectTypeOf(options.queryKey).toEqualTypeOf<
DataTag<MyQueryKey, number, Error>
>()
})

it('should return a custom query key type with datatag', () => {
type MyQueryKey = DataTag<
[Array<string>, { type: 'foo' }],
number,
Error & { myMessage: string }
>

const options = queryOptions({
queryKey: [['key'], { type: 'foo' }] as MyQueryKey,
queryFn: () => Promise.resolve(1),
})

expectTypeOf(options.queryKey).toEqualTypeOf<
DataTag<MyQueryKey, number, Error & { myMessage: string }>
>()
})
})
6 changes: 3 additions & 3 deletions packages/react-query/src/infiniteQueryOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ export function infiniteQueryOptions<
TQueryKey,
TPageParam
> & {
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
}

export function infiniteQueryOptions<
Expand All @@ -128,7 +128,7 @@ export function infiniteQueryOptions<
TQueryKey,
TPageParam
> & {
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
}

export function infiniteQueryOptions<
Expand All @@ -152,7 +152,7 @@ export function infiniteQueryOptions<
TQueryKey,
TPageParam
> & {
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
}

export function infiniteQueryOptions(options: unknown) {
Expand Down
10 changes: 5 additions & 5 deletions packages/react-query/src/queryOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ export function queryOptions<
TQueryKey extends QueryKey = QueryKey,
>(
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): DefinedInitialDataOptions<TQueryFnData, TError, TData> & {
queryKey: DataTag<QueryKey, TQueryFnData>
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}

export function queryOptions<
Expand All @@ -66,8 +66,8 @@ export function queryOptions<
TQueryKey extends QueryKey = QueryKey,
>(
options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>,
): UnusedSkipTokenOptions<TQueryFnData, TError, TData> & {
queryKey: DataTag<QueryKey, TQueryFnData>
): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}

export function queryOptions<
Expand All @@ -78,7 +78,7 @@ export function queryOptions<
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData>
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}

export function queryOptions(options: unknown) {
Expand Down
Loading