type(vue-query): introduce ShallowOption to unify shallow type and JSDoc (#9277)

Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com>

Author: Mini-ghost

packages/vue-query/src/types.ts

@@ -55,19 +55,18 @@ export type DeepUnwrapRef<T> = T extends UnwrapLeaf
         }
       : UnwrapRef<T>
 
+export type ShallowOption = {
+  /**
+   * Return data in a shallow ref object (it is `false` by default). It can be set to `true` to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
+   */
+  shallow?: boolean
+}
+
 export interface DefaultOptions<TError = DefaultError> {
-  queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'queryKey'> & {
-    /**
-     * Return data in a shallow ref object (it is `false` by default). It can be set to `true` to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
-     */
-    shallow?: boolean
-  }
-  mutations?: MutationObserverOptions<unknown, TError, unknown, unknown> & {
-    /**
-     * Return data in a shallow ref object (it is `false` by default). It can be set to `true` to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
-     */
-    shallow?: boolean
-  }
+  queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'queryKey'> &
+    ShallowOption
+  mutations?: MutationObserverOptions<unknown, TError, unknown, unknown> &
+    ShallowOption
   hydrate?: HydrateOptions['defaultOptions']
   dehydrate?: DehydrateOptions
 }

packages/vue-query/src/useInfiniteQuery.ts

@@ -20,6 +20,7 @@ import type {
   MaybeRef,
   MaybeRefDeep,
   MaybeRefOrGetter,
+  ShallowOption,
 } from './types'
 import type { QueryClient } from './queryClient'
 
@@ -55,9 +56,7 @@ export type UseInfiniteQueryOptions<
             TPageParam
           >[Property]
         >
-  } & {
-    shallow?: boolean
-  }
+  } & ShallowOption
 >
 
 export type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<
@@ -122,7 +121,6 @@ export function useInfiniteQuery(
   queryClient?: QueryClient,
 ) {
   return useBaseQuery(
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     InfiniteQueryObserver as typeof QueryObserver,
     options,
     queryClient,

packages/vue-query/src/useMutation.ts

@@ -21,7 +21,7 @@ import type {
   MutationObserverOptions,
   MutationObserverResult,
 } from '@tanstack/query-core'
-import type { MaybeRefDeep } from './types'
+import type { MaybeRefDeep, ShallowOption } from './types'
 import type { QueryClient } from './queryClient'
 
 type MutationResult<TData, TError, TVariables, TContext> = DistributiveOmit<
@@ -30,12 +30,7 @@ type MutationResult<TData, TError, TVariables, TContext> = DistributiveOmit<
 >
 
 type UseMutationOptionsBase<TData, TError, TVariables, TContext> =
-  MutationObserverOptions<TData, TError, TVariables, TContext> & {
-    /**
-     * Return data in a shallow ref object (it is `false` by default). It can be set to `true` to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
-     */
-    shallow?: boolean
-  }
+  MutationObserverOptions<TData, TError, TVariables, TContext> & ShallowOption
 
 export type UseMutationOptions<
   TData = unknown,

packages/vue-query/src/useQueries.ts

@@ -24,7 +24,7 @@ import type {
 } from '@tanstack/query-core'
 import type { UseQueryOptions } from './useQuery'
 import type { QueryClient } from './queryClient'
-import type { DeepUnwrapRef, MaybeRefDeep } from './types'
+import type { DeepUnwrapRef, MaybeRefDeep, ShallowOption } from './types'
 
 // This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.
 // `placeholderData` function does not have a parameter
@@ -238,7 +238,7 @@ export function useQueries<
   {
     queries,
     ...options
-  }: {
+  }: ShallowOption & {
     queries:
       | MaybeRefDeep<UseQueriesOptionsArg<T>>
       | MaybeRefDeep<
@@ -247,7 +247,6 @@ export function useQueries<
           ]
         >
     combine?: (result: UseQueriesResults<T>) => TCombinedResult
-    shallow?: boolean
   },
   queryClient?: QueryClient,
 ): Readonly<Ref<TCombinedResult>> {

packages/vue-query/src/useQuery.ts

@@ -14,6 +14,7 @@ import type {
   MaybeRef,
   MaybeRefDeep,
   MaybeRefOrGetter,
+  ShallowOption,
 } from './types'
 import type { QueryClient } from './queryClient'
 
@@ -50,12 +51,7 @@ export type UseQueryOptions<
             DeepUnwrapRef<TQueryKey>
           >[Property]
         >
-  } & {
-    /**
-     * Return data in a shallow ref object (it is `false` by default). It can be set to `true` to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
-     */
-    shallow?: boolean
-  }
+  } & ShallowOption
 >
 
 export type UndefinedInitialQueryOptions<