npm - @tanstack/vue-query - Versions diffs - 5.0.0-beta.9 → 5.0.0-rc.11 - Mend

@tanstack/vue-query 5.0.0-beta.9 → 5.0.0-rc.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (175) hide show

package/build/legacy/devtools/devtools.cjs.map +1 -1
package/build/legacy/devtools/devtools.js.map +1 -1
package/build/legacy/index.d.cts +2 -2
package/build/legacy/index.d.ts +2 -2
package/build/legacy/mutationCache.cjs.map +1 -1
package/build/legacy/mutationCache.d.cts +1 -1
package/build/legacy/mutationCache.d.ts +1 -1
package/build/legacy/mutationCache.js.map +1 -1
package/build/legacy/queryCache.cjs.map +1 -1
package/build/legacy/queryCache.d.cts +1 -1
package/build/legacy/queryCache.d.ts +1 -1
package/build/legacy/queryCache.js.map +1 -1
package/build/legacy/queryClient.cjs +3 -4
package/build/legacy/queryClient.cjs.map +1 -1
package/build/legacy/queryClient.d.cts +4 -4
package/build/legacy/queryClient.d.ts +4 -4
package/build/legacy/queryClient.js +3 -4
package/build/legacy/queryClient.js.map +1 -1
package/build/legacy/types.cjs.map +1 -1
package/build/legacy/types.d.cts +8 -2
package/build/legacy/types.d.ts +8 -2
package/build/legacy/useBaseQuery.cjs +62 -32
package/build/legacy/useBaseQuery.cjs.map +1 -1
package/build/legacy/useBaseQuery.d.cts +1 -1
package/build/legacy/useBaseQuery.d.ts +1 -1
package/build/legacy/useBaseQuery.js +64 -33
package/build/legacy/useBaseQuery.js.map +1 -1
package/build/legacy/useInfiniteQuery.cjs +1 -6
package/build/legacy/useInfiniteQuery.cjs.map +1 -1
package/build/legacy/useInfiniteQuery.d.cts +1 -1
package/build/legacy/useInfiniteQuery.d.ts +1 -1
package/build/legacy/useInfiniteQuery.js +1 -6
package/build/legacy/useInfiniteQuery.js.map +1 -1
package/build/legacy/useIsFetching.cjs +13 -13
package/build/legacy/useIsFetching.cjs.map +1 -1
package/build/legacy/useIsFetching.js +14 -14
package/build/legacy/useIsFetching.js.map +1 -1
package/build/legacy/useMutation.cjs +18 -7
package/build/legacy/useMutation.cjs.map +1 -1
package/build/legacy/useMutation.js +20 -8
package/build/legacy/useMutation.js.map +1 -1
package/build/legacy/useMutationState.cjs +10 -7
package/build/legacy/useMutationState.cjs.map +1 -1
package/build/legacy/useMutationState.js +18 -8
package/build/legacy/useMutationState.js.map +1 -1
package/build/legacy/useQueries.cjs +12 -2
package/build/legacy/useQueries.cjs.map +1 -1
package/build/legacy/useQueries.d.cts +7 -5
package/build/legacy/useQueries.d.ts +7 -5
package/build/legacy/useQueries.js +20 -3
package/build/legacy/useQueries.js.map +1 -1
package/build/legacy/{useQuery-846c66db.d.ts → useQuery-62b5e5ac.d.ts} +9 -7
package/build/legacy/{useQuery-ebff9211.d.ts → useQuery-f89ce9b1.d.ts} +9 -7
package/build/legacy/useQuery.cjs +1 -4
package/build/legacy/useQuery.cjs.map +1 -1
package/build/legacy/useQuery.d.cts +1 -1
package/build/legacy/useQuery.d.ts +1 -1
package/build/legacy/useQuery.js +1 -4
package/build/legacy/useQuery.js.map +1 -1
package/build/legacy/useQueryClient.cjs +4 -4
package/build/legacy/useQueryClient.cjs.map +1 -1
package/build/legacy/useQueryClient.js +5 -5
package/build/legacy/useQueryClient.js.map +1 -1
package/build/legacy/utils.cjs +8 -0
package/build/legacy/utils.cjs.map +1 -1
package/build/legacy/utils.d.cts +2 -1
package/build/legacy/utils.d.ts +2 -1
package/build/legacy/utils.js +7 -0
package/build/legacy/utils.js.map +1 -1
package/build/legacy/vueQueryPlugin.cjs +2 -0
package/build/legacy/vueQueryPlugin.cjs.map +1 -1
package/build/legacy/vueQueryPlugin.d.cts +3 -2
package/build/legacy/vueQueryPlugin.d.ts +3 -2
package/build/legacy/vueQueryPlugin.js +2 -0
package/build/legacy/vueQueryPlugin.js.map +1 -1
package/build/modern/devtools/devtools.cjs.map +1 -1
package/build/modern/devtools/devtools.js.map +1 -1
package/build/modern/index.d.cts +2 -2
package/build/modern/index.d.ts +2 -2
package/build/modern/mutationCache.cjs.map +1 -1
package/build/modern/mutationCache.d.cts +1 -1
package/build/modern/mutationCache.d.ts +1 -1
package/build/modern/mutationCache.js.map +1 -1
package/build/modern/queryCache.cjs.map +1 -1
package/build/modern/queryCache.d.cts +1 -1
package/build/modern/queryCache.d.ts +1 -1
package/build/modern/queryCache.js.map +1 -1
package/build/modern/queryClient.cjs +3 -4
package/build/modern/queryClient.cjs.map +1 -1
package/build/modern/queryClient.d.cts +4 -4
package/build/modern/queryClient.d.ts +4 -4
package/build/modern/queryClient.js +3 -4
package/build/modern/queryClient.js.map +1 -1
package/build/modern/types.cjs.map +1 -1
package/build/modern/types.d.cts +8 -2
package/build/modern/types.d.ts +8 -2
package/build/modern/useBaseQuery.cjs +62 -32
package/build/modern/useBaseQuery.cjs.map +1 -1
package/build/modern/useBaseQuery.d.cts +1 -1
package/build/modern/useBaseQuery.d.ts +1 -1
package/build/modern/useBaseQuery.js +64 -33
package/build/modern/useBaseQuery.js.map +1 -1
package/build/modern/useInfiniteQuery.cjs +1 -6
package/build/modern/useInfiniteQuery.cjs.map +1 -1
package/build/modern/useInfiniteQuery.d.cts +1 -1
package/build/modern/useInfiniteQuery.d.ts +1 -1
package/build/modern/useInfiniteQuery.js +1 -6
package/build/modern/useInfiniteQuery.js.map +1 -1
package/build/modern/useIsFetching.cjs +13 -13
package/build/modern/useIsFetching.cjs.map +1 -1
package/build/modern/useIsFetching.js +14 -14
package/build/modern/useIsFetching.js.map +1 -1
package/build/modern/useMutation.cjs +18 -7
package/build/modern/useMutation.cjs.map +1 -1
package/build/modern/useMutation.js +20 -8
package/build/modern/useMutation.js.map +1 -1
package/build/modern/useMutationState.cjs +10 -7
package/build/modern/useMutationState.cjs.map +1 -1
package/build/modern/useMutationState.js +18 -8
package/build/modern/useMutationState.js.map +1 -1
package/build/modern/useQueries.cjs +12 -2
package/build/modern/useQueries.cjs.map +1 -1
package/build/modern/useQueries.d.cts +7 -5
package/build/modern/useQueries.d.ts +7 -5
package/build/modern/useQueries.js +20 -3
package/build/modern/useQueries.js.map +1 -1
package/build/modern/{useQuery-846c66db.d.ts → useQuery-62b5e5ac.d.ts} +9 -7
package/build/modern/{useQuery-ebff9211.d.ts → useQuery-f89ce9b1.d.ts} +9 -7
package/build/modern/useQuery.cjs +1 -4
package/build/modern/useQuery.cjs.map +1 -1
package/build/modern/useQuery.d.cts +1 -1
package/build/modern/useQuery.d.ts +1 -1
package/build/modern/useQuery.js +1 -4
package/build/modern/useQuery.js.map +1 -1
package/build/modern/useQueryClient.cjs +4 -3
package/build/modern/useQueryClient.cjs.map +1 -1
package/build/modern/useQueryClient.js +5 -4
package/build/modern/useQueryClient.js.map +1 -1
package/build/modern/utils.cjs +8 -0
package/build/modern/utils.cjs.map +1 -1
package/build/modern/utils.d.cts +2 -1
package/build/modern/utils.d.ts +2 -1
package/build/modern/utils.js +7 -0
package/build/modern/utils.js.map +1 -1
package/build/modern/vueQueryPlugin.cjs +1 -0
package/build/modern/vueQueryPlugin.cjs.map +1 -1
package/build/modern/vueQueryPlugin.d.cts +3 -2
package/build/modern/vueQueryPlugin.d.ts +3 -2
package/build/modern/vueQueryPlugin.js +1 -0
package/build/modern/vueQueryPlugin.js.map +1 -1
package/package.json +6 -6
package/src/__mocks__/useBaseQuery.ts +1 -1
package/src/__tests__/queryClient.test.ts +4 -4
package/src/__tests__/useInfiniteQuery.test.ts +1 -1
package/src/__tests__/useInfiniteQuery.types.test.tsx +5 -5
package/src/__tests__/useMutation.test.ts +23 -3
package/src/__tests__/useQueries.test.ts +23 -0
package/src/__tests__/useQuery.test.ts +76 -1
package/src/__tests__/useQueryClient.test.ts +4 -4
package/src/__tests__/utils.test.ts +1 -1
package/src/devtools/devtools.ts +2 -2
package/src/mutationCache.ts +1 -1
package/src/queryCache.ts +1 -1
package/src/queryClient.ts +17 -10
package/src/types.ts +25 -1
package/src/useBaseQuery.ts +90 -37
package/src/useInfiniteQuery.ts +19 -9
package/src/useIsFetching.ts +16 -14
package/src/useMutation.ts +25 -8
package/src/useMutationState.ts +20 -9
package/src/useQueries.ts +55 -28
package/src/useQuery.ts +22 -9
package/src/useQueryClient.ts +6 -5
package/src/utils.ts +12 -0
package/src/vueQueryPlugin.ts +3 -2

package/src/useQueries.ts CHANGED Viewed

@@ -1,6 +1,13 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { QueriesObserver } from '@tanstack/query-core'
-import { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'
+import {
+  computed,
+  getCurrentScope,
+  onScopeDispose,
+  readonly,
+  ref,
+  watch,
+} from 'vue-demi'
 import { useQueryClient } from './useQueryClient'
 import { cloneDeepUnref } from './utils'
@@ -93,61 +100,69 @@ type GetResults<T> =
  * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
  */
 export type UseQueriesOptions<
-  T extends any[],
-  Result extends any[] = [],
+  T extends Array<any>,
+  Result extends Array<any> = [],
   Depth extends ReadonlyArray<number> = [],
 > = Depth['length'] extends MAXIMUM_DEPTH
-  ? UseQueryOptionsForUseQueries[]
+  ? Array<UseQueryOptionsForUseQueries>
   : T extends []
   ? []
   : T extends [infer Head]
   ? [...Result, GetOptions<Head>]
   : T extends [infer Head, ...infer Tail]
   ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>
-  : unknown[] extends T
+  : Array<unknown> extends T
   ? T
   : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
   // use this to infer the param types in the case of Array.map() argument
-  T extends UseQueryOptionsForUseQueries<
-      infer TQueryFnData,
-      infer TError,
-      infer TData,
-      infer TQueryKey
-    >[]
-  ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[]
+  T extends Array<
+      UseQueryOptionsForUseQueries<
+        infer TQueryFnData,
+        infer TError,
+        infer TData,
+        infer TQueryKey
+      >
+    >
+  ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>>
   : // Fallback
-    UseQueryOptionsForUseQueries[]
+    Array<UseQueryOptionsForUseQueries>
 /**
  * UseQueriesResults reducer recursively maps type param to results
  */
 export type UseQueriesResults<
-  T extends any[],
-  Result extends any[] = [],
+  T extends Array<any>,
+  Result extends Array<any> = [],
   Depth extends ReadonlyArray<number> = [],
 > = Depth['length'] extends MAXIMUM_DEPTH
-  ? QueryObserverResult[]
+  ? Array<QueryObserverResult>
   : T extends []
   ? []
   : T extends [infer Head]
   ? [...Result, GetResults<Head>]
   : T extends [infer Head, ...infer Tail]
   ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>
-  : T extends UseQueryOptionsForUseQueries<
-      infer TQueryFnData,
-      infer TError,
-      infer TData,
-      any
-    >[]
+  : T extends Array<
+      UseQueryOptionsForUseQueries<
+        infer TQueryFnData,
+        infer TError,
+        infer TData,
+        any
+      >
+    >
   ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
-    QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[]
+    Array<
+      QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>
+    >
   : // Fallback
-    QueryObserverResult[]
+    Array<QueryObserverResult>
-type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>]
+type UseQueriesOptionsArg<T extends Array<any>> = readonly [
+  ...UseQueriesOptions<T>,
+]
 export function useQueries<
-  T extends any[],
+  T extends Array<any>,
   TCombinedResult = UseQueriesResults<T>,
 >(
   {
@@ -159,10 +174,22 @@ export function useQueries<
   },
   queryClient?: QueryClient,
 ): Readonly<Ref<TCombinedResult>> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
   const client = queryClient || useQueryClient()
   const defaultedQueries = computed(() =>
     cloneDeepUnref(queries).map((queryOptions) => {
+      if (typeof queryOptions.enabled === 'function') {
+        queryOptions.enabled = queryOptions.enabled()
+      }
       const defaulted = client.defaultQueryOptions(queryOptions)
       defaulted._optimisticResults = client.isRestoring.value
         ? 'isRestoring'
@@ -208,7 +235,7 @@ export function useQueries<
   )
   watch(
-    [defaultedQueries],
+    defaultedQueries,
     () => {
       observer.setQueries(
         defaultedQueries.value,
@@ -219,7 +246,7 @@ export function useQueries<
       )
       state.value = getCombinedResultPersisted()
     },
-    { deep: true },
+    { flush: 'sync' },
   )
   onScopeDispose(() => {

package/src/useQuery.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 import { QueryObserver } from '@tanstack/query-core'
 import { useBaseQuery } from './useBaseQuery'
-import type { ToRefs, UnwrapRef } from 'vue-demi'
+import type { ToRefs } from 'vue-demi'
 import type {
   DefaultError,
   DefinedQueryObserverResult,
@@ -10,7 +10,13 @@ import type {
   WithRequired,
 } from '@tanstack/query-core'
 import type { UseBaseQueryReturnType } from './useBaseQuery'
-import type { DistributiveOmit, MaybeRefDeep } from './types'
+import type {
+  DeepUnwrapRef,
+  DistributiveOmit,
+  MaybeRef,
+  MaybeRefDeep,
+  MaybeRefOrGetter,
+} from './types'
 import type { QueryClient } from './queryClient'
 export type UseQueryOptions<
@@ -19,7 +25,7 @@ export type UseQueryOptions<
   TData = TQueryFnData,
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
-> = {
+> = MaybeRef<{
   [Property in keyof QueryObserverOptions<
     TQueryFnData,
     TError,
@@ -32,8 +38,18 @@ export type UseQueryOptions<
         TError,
         TData,
         TQueryData,
-        UnwrapRef<TQueryKey>
+        DeepUnwrapRef<TQueryKey>
       >[Property]
+    : Property extends 'enabled'
+    ? MaybeRefOrGetter<
+        QueryObserverOptions<
+          TQueryFnData,
+          TError,
+          TData,
+          TQueryData,
+          TQueryKey
+        >[Property]
+      >
     : MaybeRefDeep<
         WithRequired<
           QueryObserverOptions<
@@ -46,7 +62,7 @@ export type UseQueryOptions<
           'queryKey'
         >[Property]
       >
-}
+}>
 export type UseQueryReturnType<TData, TError> = DistributiveOmit<
   UseBaseQueryReturnType<TData, TError>,
@@ -118,8 +134,5 @@ export function useQuery<
   | UseQueryDefinedReturnType<TData, TError> {
   const result = useBaseQuery(QueryObserver, options, queryClient)
-  return {
-    ...result,
-    refetch: result.refetch.value,
-  }
+  return result
 }

package/src/useQueryClient.ts CHANGED Viewed

@@ -1,13 +1,14 @@
-import { getCurrentInstance, inject } from 'vue-demi'
+import { hasInjectionContext, inject } from 'vue-demi'
 import { getClientKey } from './utils'
 import type { QueryClient } from './queryClient'
 export function useQueryClient(id = ''): QueryClient {
-  const vm = getCurrentInstance()?.proxy
-  if (!vm) {
-    throw new Error('vue-query hooks can only be used inside setup() function.')
+  // ensures that `inject()` can be used
+  if (!hasInjectionContext()) {
+    throw new Error(
+      'vue-query hooks can only be used inside setup() function or functions that support injection context.',
+    )
   }
   const key = getClientKey(id)

package/src/utils.ts CHANGED Viewed

@@ -65,3 +65,15 @@ function isPlainObject(value: unknown): value is Object {
   const prototype = Object.getPrototypeOf(value)
   return prototype === null || prototype === Object.prototype
 }
+export function shouldThrowError<T extends (...args: Array<any>) => boolean>(
+  throwOnError: boolean | T | undefined,
+  params: Parameters<T>,
+): boolean {
+  // Allow throwOnError function to override throwing behavior on a per-error basis
+  if (typeof throwOnError === 'function') {
+    return throwOnError(...params)
+  }
+  return !!throwOnError
+}

package/src/vueQueryPlugin.ts CHANGED Viewed

@@ -5,17 +5,17 @@ import { QueryClient } from './queryClient'
 import { getClientKey } from './utils'
 import { setupDevtools } from './devtools/devtools'
 import type { QueryClientConfig } from '@tanstack/query-core'
-import type { MaybeRefDeep } from './types'
 type ClientPersister = (client: QueryClient) => [() => void, Promise<void>]
 interface CommonOptions {
   queryClientKey?: string
   clientPersister?: ClientPersister
+  clientPersisterOnSuccess?: (client: QueryClient) => void
 }
 interface ConfigOptions extends CommonOptions {
-  queryClientConfig?: MaybeRefDeep<QueryClientConfig>
+  queryClientConfig?: QueryClientConfig
 }
 interface ClientOptions extends CommonOptions {
@@ -51,6 +51,7 @@ export const VueQueryPlugin = {
       persisterUnmount = unmount
       promise.then(() => {
         client.isRestoring.value = false
+        options.clientPersisterOnSuccess?.(client)
       })
     }