import { describe, expectTypeOf, it, test } from 'vitest' import { sleep } from '@tanstack/query-test-utils' import { injectQuery, queryOptions } from '..' import type { Signal } from '@angular/core' describe('initialData', () => { describe('Config object overload', () => { it('TData should always be defined when initialData is provided as an object', () => { const { data } = injectQuery(() => ({ queryKey: ['key'], queryFn: () => ({ wow: true }), initialData: { wow: true }, })) expectTypeOf(data).toEqualTypeOf>() }) it('TData should be defined when passed through queryOptions', () => { const options = () => queryOptions({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: { wow: true, }, }) const { data } = injectQuery(options) expectTypeOf(data).toEqualTypeOf>() }) 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 = injectQuery(() => ({ ...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 } = injectQuery(() => ({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => ({ wow: true, }), })) expectTypeOf(data).toEqualTypeOf>() }) it('TData should have undefined in the union when initialData is NOT provided', () => { const { data } = injectQuery(() => ({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, })) expectTypeOf(data).toEqualTypeOf>() }) it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => { const { data } = injectQuery(() => ({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => undefined as { wow: boolean } | undefined, })) expectTypeOf(data).toEqualTypeOf>() }) it('TData should be narrowed after an isSuccess check when initialData is provided as a function which can return undefined', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => { return { wow: true, } }, initialData: () => undefined as { wow: boolean } | undefined, })) if (query.isSuccess()) { expectTypeOf(query.data).toEqualTypeOf>() } }) }) describe('structuralSharing', () => { it('should be able to use structuralSharing with unknown types', () => { // https://github.com/TanStack/query/issues/6525#issuecomment-1938411343 injectQuery(() => ({ queryKey: ['key'], queryFn: () => 5, structuralSharing: (oldData, newData) => { expectTypeOf(oldData).toBeUnknown() expectTypeOf(newData).toBeUnknown() return newData }, })) }) }) }) describe('Discriminated union return type', () => { test('data should be possibly undefined by default', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) expectTypeOf(query.data).toEqualTypeOf>() }) test('data should be defined when query is success', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) if (query.isSuccess()) { expectTypeOf(query.data).toEqualTypeOf>() } }) test('error should be null when query is success', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) if (query.isSuccess()) { expectTypeOf(query.error).toEqualTypeOf>() } }) test('data should be undefined when query is pending', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) if (query.isPending()) { expectTypeOf(query.data).toEqualTypeOf>() } }) test('error should be defined when query is error', () => { const query = injectQuery(() => ({ queryKey: ['key'], queryFn: () => sleep(0).then(() => 'Some data'), })) if (query.isError()) { expectTypeOf(query.error).toEqualTypeOf>() } }) })