import { assertType, describe, expectTypeOf, it } from 'vitest' import { QueriesObserver, QueryClient, dataTagSymbol, skipToken, } from '@tanstack/query-core' import { queryOptions } from '../queryOptions' import { useQuery } from '../useQuery' import { useQueries } from '../useQueries' import { useSuspenseQuery } from '../useSuspenseQuery' import type { AnyUseQueryOptions } from '../types' import type { DataTag, InitialDataFunction, QueryObserverResult, } from '@tanstack/query-core' describe('queryOptions', () => { it('should not allow excess properties', () => { assertType( queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), // @ts-expect-error this is a good error, because stallTime does not exist! stallTime: 1000, }), ) }) it('should infer types for callbacks', () => { queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), staleTime: 1000, select: (data) => { expectTypeOf(data).toEqualTypeOf() }, }) }) it('should work when passed to useQuery', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const { data } = useQuery(options) expectTypeOf(data).toEqualTypeOf() }) it('should work when passed to useSuspenseQuery', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const { data } = useSuspenseQuery(options) expectTypeOf(data).toEqualTypeOf() }) it('should work when passed to fetchQuery', async () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const data = await new QueryClient().fetchQuery(options) expectTypeOf(data).toEqualTypeOf() }) it('should work when passed to useQueries', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const [{ data }] = useQueries({ queries: [options], }) expectTypeOf(data).toEqualTypeOf() }) it('should tag the queryKey with the result type of the QueryFn', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) expectTypeOf(queryKey[dataTagSymbol]).toEqualTypeOf() }) it('should tag the queryKey even if no promise is returned', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => 5, }) expectTypeOf(queryKey[dataTagSymbol]).toEqualTypeOf() }) it('should tag the queryKey with unknown if there is no queryFn', () => { const { queryKey } = queryOptions({ queryKey: ['key'], }) expectTypeOf(queryKey[dataTagSymbol]).toEqualTypeOf() }) it('should tag the queryKey with the result type of the QueryFn if select is used', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), select: (data) => data.toString(), }) expectTypeOf(queryKey[dataTagSymbol]).toEqualTypeOf() }) it('should return the proper type when passed to getQueryData', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const queryClient = new QueryClient() const data = queryClient.getQueryData(queryKey) expectTypeOf(data).toEqualTypeOf() }) it('should return the proper type when passed to getQueryState', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const queryClient = new QueryClient() const state = queryClient.getQueryState(queryKey) expectTypeOf(state?.data).toEqualTypeOf() }) it('should properly type updaterFn when passed to setQueryData', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const queryClient = new QueryClient() const data = queryClient.setQueryData(queryKey, (prev) => { expectTypeOf(prev).toEqualTypeOf() return prev }) expectTypeOf(data).toEqualTypeOf() }) it('should properly type value when passed to setQueryData', () => { const { queryKey } = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const queryClient = new QueryClient() // @ts-expect-error value should be a number queryClient.setQueryData(queryKey, '5') // @ts-expect-error value should be a number queryClient.setQueryData(queryKey, () => '5') const data = queryClient.setQueryData(queryKey, 5) expectTypeOf(data).toEqualTypeOf() }) it('should infer even if there is a conditional skipToken', () => { const options = queryOptions({ queryKey: ['key'], queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5), }) const queryClient = new QueryClient() const data = queryClient.getQueryData(options.queryKey) expectTypeOf(data).toEqualTypeOf() }) it('should infer to unknown if we disable a query with just a skipToken', () => { const options = queryOptions({ queryKey: ['key'], queryFn: skipToken, }) const queryClient = new QueryClient() const data = queryClient.getQueryData(options.queryKey) expectTypeOf(data).toEqualTypeOf() }) it('should throw a type error when using queryFn with skipToken in a suspense query', () => { const options = queryOptions({ queryKey: ['key'], queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5), }) // @ts-expect-error TS2345 const { data } = useSuspenseQuery(options) expectTypeOf(data).toEqualTypeOf() }) it('should return the proper type when passed to QueriesObserver', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(5), }) const queryClient = new QueryClient() const queriesObserver = new QueriesObserver(queryClient, [options]) expectTypeOf(queriesObserver).toEqualTypeOf< QueriesObserver> >() }) it('should allow undefined response in initialData', () => { assertType((id: string | null) => queryOptions({ queryKey: ['todo', id], queryFn: () => Promise.resolve({ id: '1', title: 'Do Laundry', }), initialData: () => !id ? undefined : { id, title: 'Initial Data', }, }), ) }) it('should allow optional initialData object', () => { const testFn = (id?: string) => { const options = queryOptions({ queryKey: ['test'], queryFn: () => Promise.resolve('something string'), initialData: id ? 'initial string' : undefined, }) expectTypeOf(options.initialData).toMatchTypeOf< InitialDataFunction | string | undefined >() } testFn('id') testFn() }) it('should be passable to UseQueryOptions', () => { function somethingWithQueryOptions( options: TQueryOpts, ) { return options.queryKey } const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(1), }) assertType(somethingWithQueryOptions(options)) }) it('should return a custom query key type', () => { type MyQueryKey = [Array, { type: 'foo' }] const options = queryOptions({ queryKey: [['key'], { type: 'foo' }] as MyQueryKey, queryFn: () => Promise.resolve(1), }) expectTypeOf(options.queryKey).toEqualTypeOf< DataTag >() }) it('should return a custom query key type with datatag', () => { type MyQueryKey = DataTag< [Array, { type: 'foo' }], number, Error & { myMessage: string } > const options = queryOptions({ queryKey: [['key'], { type: 'foo' }] as MyQueryKey, queryFn: () => Promise.resolve(1), }) expectTypeOf(options.queryKey).toEqualTypeOf< DataTag >() }) })