fix(vue-query): re-export core filter types

.changeset/tidy-pandas-fetch.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/vue-query': patch
+---
+
+Re-export core query and mutation filter types without shadowing them with Vue-specific filter types.

packages/vue-query/src/__tests__/filterTypes.test-d.ts

@@ -0,0 +1,22 @@
+import { describe, expectTypeOf, it } from 'vitest'
+import type {
+  MutationFilters as CoreMutationFilters,
+  QueryFilters as CoreQueryFilters,
+} from '@tanstack/query-core'
+import type { MutationFilters, QueryFilters } from '../index'
+
+describe('filter type exports', () => {
+  it('should re-export core query filters', () => {
+    expectTypeOf<QueryFilters>().toEqualTypeOf<CoreQueryFilters>()
+    expectTypeOf<QueryFilters<readonly ['todos', string]>>().toEqualTypeOf<
+      CoreQueryFilters<readonly ['todos', string]>
+    >()
+  })
+
+  it('should re-export core mutation filters', () => {
+    expectTypeOf<MutationFilters>().toEqualTypeOf<CoreMutationFilters>()
+    expectTypeOf<
+      MutationFilters<string, Error, number, boolean>
+    >().toEqualTypeOf<CoreMutationFilters<string, Error, number, boolean>>()
+  })
+})

packages/vue-query/src/index.ts

@@ -44,6 +44,9 @@ export type {
 export type { UseMutationOptions, UseMutationReturnType } from './useMutation'
 export type { MutationOptions } from './types'
 export type { UseQueriesOptions, UseQueriesResults } from './useQueries'
-export type { MutationFilters, MutationStateOptions } from './useMutationState'
-export type { QueryFilters } from './useIsFetching'
+export type {
+  MutationStateOptions,
+  UseIsMutatingFilters,
+} from './useMutationState'
+export type { UseIsFetchingFilters } from './useIsFetching'
 export type { VueQueryPluginOptions } from './vueQueryPlugin'

packages/vue-query/src/useIsFetching.ts

@@ -2,14 +2,16 @@ import { getCurrentScope, onScopeDispose, ref, watchEffect } from 'vue-demi'
 import { useQueryClient } from './useQueryClient'
 import { cloneDeepUnref } from './utils'
 import type { Ref } from 'vue-demi'
-import type { QueryFilters as QF } from '@tanstack/query-core'
+import type { QueryFilters } from '@tanstack/query-core'
 import type { MaybeRefDeep } from './types'
 import type { QueryClient } from './queryClient'
 
-export type QueryFilters = MaybeRefDeep<QF> | (() => MaybeRefDeep<QF>)
+export type UseIsFetchingFilters =
+  | MaybeRefDeep<QueryFilters>
+  | (() => MaybeRefDeep<QueryFilters>)
 
 export function useIsFetching(
-  fetchingFilters: QueryFilters = {},
+  fetchingFilters: UseIsFetchingFilters = {},
   queryClient?: QueryClient,
 ): Ref<number> {
   if (process.env.NODE_ENV === 'development') {

packages/vue-query/src/useMutationState.ts

@@ -10,18 +10,22 @@ import { useQueryClient } from './useQueryClient'
 import { cloneDeepUnref } from './utils'
 import type { Ref } from 'vue-demi'
 import type {
-  MutationFilters as MF,
   Mutation,
+  MutationFilters,
   MutationState,
 } from '@tanstack/query-core'
 import type { QueryClient } from './queryClient'
 import type { MaybeRefDeep } from './types'
 import type { MutationCache } from './mutationCache'
 
-export type MutationFilters = MaybeRefDeep<MF>
+type VueMutationFilters = MaybeRefDeep<MutationFilters>
+
+export type UseIsMutatingFilters =
+  | VueMutationFilters
+  | (() => VueMutationFilters)
 
 export function useIsMutating(
-  filters: MutationFilters | (() => MutationFilters) = {},
+  filters: UseIsMutatingFilters = {},
   queryClient?: QueryClient,
 ): Ref<number> {
   if (process.env.NODE_ENV === 'development') {
@@ -64,7 +68,7 @@ export type MutationStateOptions<
   TMutation extends Mutation<any, any, any, any> =
     MutationTypeFromResult<TResult>,
 > = {
-  filters?: MutationFilters
+  filters?: VueMutationFilters
   select?: (mutation: TMutation) => TResult
 }