import { describe, expectTypeOf, it } from 'vitest' import { computed, reactive, ref } from 'vue-demi' import { sleep } from '@tanstack/query-test-utils' import { queryOptions, useQuery } from '..' import type { OmitKeyof, UseQueryOptions } from '..' describe('useQuery', () => { describe('Config object overload', () => { it('TData should always be defined when initialData is provided as an object', () => { const { data } = reactive( useQuery({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: { wow: true, }, }), ) expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>() }) it('TData should be defined when passed through queryOptions', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: { wow: true, }, }) const { data } = reactive(useQuery(options)) expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>() }) it('should be possible to define a different TData than TQueryFnData using select with queryOptions spread into useQuery', () => { const options = queryOptions({ queryKey: ['key'], queryFn: () => Promise.resolve(1), }) const query = reactive( useQuery({ ...options, select: (data) => data > 1, }), ) expectTypeOf(query.data).toEqualTypeOf() }) it('TData should always be defined when initialData is provided as a function which ALWAYS returns the data', () => { const { data } = reactive( useQuery({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => ({ wow: true, }), }), ) expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>() }) it('TData should have undefined in the union when initialData is NOT provided', () => { const { data } = reactive( useQuery({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, }), ) expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>() }) it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => { const { data } = reactive( useQuery({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => undefined as { wow: boolean } | undefined, }), ) expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>() }) it('TData should be narrowed after an isSuccess check when initialData is provided as a function which can return undefined', () => { const { data, isSuccess } = reactive( useQuery({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => undefined as { wow: boolean } | undefined, }), ) if (isSuccess) { expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>() } }) it('data should not have undefined when initialData is provided', () => { const { data } = reactive( useQuery({ queryKey: ['query-key'], initialData: 42, }), ) expectTypeOf(data).toEqualTypeOf() }) }) describe('custom composable', () => { it('should allow custom composable using UseQueryOptions', () => { const useCustomQuery = ( options?: OmitKeyof< UseQueryOptions, 'queryKey' | 'queryFn', 'safely' >, ) => { return useQuery({ ...options, queryKey: ['todos-key'], queryFn: () => Promise.resolve('data'), }) } const { data } = reactive(useCustomQuery()) expectTypeOf(data).toEqualTypeOf() }) }) describe('structuralSharing', () => { it('should be able to use structuralSharing with unknown types', () => { // https://github.com/TanStack/query/issues/6525#issuecomment-1938411343 useQuery({ queryKey: ['key'], queryFn: () => 5, structuralSharing: (oldData, newData) => { expectTypeOf(oldData).toBeUnknown() expectTypeOf(newData).toBeUnknown() return newData }, }) }) }) describe('Discriminated union return type', () => { it('data should be possibly undefined by default', () => { const query = reactive( useQuery({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) expectTypeOf(query.data).toEqualTypeOf() }) it('data should be defined when query is success', () => { const query = reactive( useQuery({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) if (query.isSuccess) { expectTypeOf(query.data).toEqualTypeOf() } }) it('error should be null when query is success', () => { const query = reactive( useQuery({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) if (query.isSuccess) { expectTypeOf(query.error).toEqualTypeOf() } }) it('data should be undefined when query is pending', () => { const query = reactive( useQuery({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) if (query.isPending) { expectTypeOf(query.data).toEqualTypeOf() } }) it('error should be defined when query is error', () => { const query = reactive( useQuery({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) if (query.isError) { expectTypeOf(query.error).toEqualTypeOf() } }) }) describe('accept ref options', () => { it('should accept ref options', () => { const options = ref({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }) const query = reactive(useQuery(options)) if (query.isSuccess) { expectTypeOf(query.data).toEqualTypeOf() } }) it('should accept computed options', () => { const options = computed(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) const query = reactive(useQuery(options)) if (query.isSuccess) { expectTypeOf(query.data).toEqualTypeOf() } }) it('should accept computed query options', () => { const options = computed(() => queryOptions({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), }), ) const query = reactive(useQuery(options)) if (query.isSuccess) { expectTypeOf(query.data).toEqualTypeOf() } }) }) })