@tanstack/vue-query 5.87.1 → 5.89.0

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 (80) hide show
  1. package/build/legacy/devtools/devtools.d.cts +1 -1
  2. package/build/legacy/devtools/devtools.d.ts +1 -1
  3. package/build/legacy/index.d.cts +1 -1
  4. package/build/legacy/index.d.ts +1 -1
  5. package/build/legacy/infiniteQueryOptions.d.cts +1 -1
  6. package/build/legacy/infiniteQueryOptions.d.ts +1 -1
  7. package/build/legacy/mutationCache.cjs.map +1 -1
  8. package/build/legacy/mutationCache.d.cts +1 -1
  9. package/build/legacy/mutationCache.d.ts +1 -1
  10. package/build/legacy/mutationCache.js.map +1 -1
  11. package/build/legacy/{queryClient-CEu47BH9.d.cts → queryClient-BxG1Ao7e.d.cts} +1 -1
  12. package/build/legacy/{queryClient-CAHOJcvF.d.ts → queryClient-Q5krKVnP.d.ts} +1 -1
  13. package/build/legacy/queryClient.cjs.map +1 -1
  14. package/build/legacy/queryClient.d.cts +1 -1
  15. package/build/legacy/queryClient.d.ts +1 -1
  16. package/build/legacy/queryClient.js.map +1 -1
  17. package/build/legacy/queryOptions.d.cts +1 -1
  18. package/build/legacy/queryOptions.d.ts +1 -1
  19. package/build/legacy/useBaseQuery.d.cts +1 -1
  20. package/build/legacy/useBaseQuery.d.ts +1 -1
  21. package/build/legacy/useInfiniteQuery.d.cts +1 -1
  22. package/build/legacy/useInfiniteQuery.d.ts +1 -1
  23. package/build/legacy/useIsFetching.d.cts +1 -1
  24. package/build/legacy/useIsFetching.d.ts +1 -1
  25. package/build/legacy/useMutation.cjs.map +1 -1
  26. package/build/legacy/useMutation.d.cts +10 -10
  27. package/build/legacy/useMutation.d.ts +10 -10
  28. package/build/legacy/useMutation.js.map +1 -1
  29. package/build/legacy/useMutationState.d.cts +1 -1
  30. package/build/legacy/useMutationState.d.ts +1 -1
  31. package/build/legacy/useQueries.d.cts +1 -1
  32. package/build/legacy/useQueries.d.ts +1 -1
  33. package/build/legacy/useQuery.d.cts +1 -1
  34. package/build/legacy/useQuery.d.ts +1 -1
  35. package/build/legacy/useQueryClient.d.cts +1 -1
  36. package/build/legacy/useQueryClient.d.ts +1 -1
  37. package/build/legacy/vueQueryPlugin.d.cts +1 -1
  38. package/build/legacy/vueQueryPlugin.d.ts +1 -1
  39. package/build/modern/devtools/devtools.d.cts +1 -1
  40. package/build/modern/devtools/devtools.d.ts +1 -1
  41. package/build/modern/index.d.cts +1 -1
  42. package/build/modern/index.d.ts +1 -1
  43. package/build/modern/infiniteQueryOptions.d.cts +1 -1
  44. package/build/modern/infiniteQueryOptions.d.ts +1 -1
  45. package/build/modern/mutationCache.cjs.map +1 -1
  46. package/build/modern/mutationCache.d.cts +1 -1
  47. package/build/modern/mutationCache.d.ts +1 -1
  48. package/build/modern/mutationCache.js.map +1 -1
  49. package/build/modern/{queryClient-CEu47BH9.d.cts → queryClient-BxG1Ao7e.d.cts} +1 -1
  50. package/build/modern/{queryClient-CAHOJcvF.d.ts → queryClient-Q5krKVnP.d.ts} +1 -1
  51. package/build/modern/queryClient.cjs.map +1 -1
  52. package/build/modern/queryClient.d.cts +1 -1
  53. package/build/modern/queryClient.d.ts +1 -1
  54. package/build/modern/queryClient.js.map +1 -1
  55. package/build/modern/queryOptions.d.cts +1 -1
  56. package/build/modern/queryOptions.d.ts +1 -1
  57. package/build/modern/useBaseQuery.d.cts +1 -1
  58. package/build/modern/useBaseQuery.d.ts +1 -1
  59. package/build/modern/useInfiniteQuery.d.cts +1 -1
  60. package/build/modern/useInfiniteQuery.d.ts +1 -1
  61. package/build/modern/useIsFetching.d.cts +1 -1
  62. package/build/modern/useIsFetching.d.ts +1 -1
  63. package/build/modern/useMutation.cjs.map +1 -1
  64. package/build/modern/useMutation.d.cts +10 -10
  65. package/build/modern/useMutation.d.ts +10 -10
  66. package/build/modern/useMutation.js.map +1 -1
  67. package/build/modern/useMutationState.d.cts +1 -1
  68. package/build/modern/useMutationState.d.ts +1 -1
  69. package/build/modern/useQueries.d.cts +1 -1
  70. package/build/modern/useQueries.d.ts +1 -1
  71. package/build/modern/useQuery.d.cts +1 -1
  72. package/build/modern/useQuery.d.ts +1 -1
  73. package/build/modern/useQueryClient.d.cts +1 -1
  74. package/build/modern/useQueryClient.d.ts +1 -1
  75. package/build/modern/vueQueryPlugin.d.cts +1 -1
  76. package/build/modern/vueQueryPlugin.d.ts +1 -1
  77. package/package.json +2 -2
  78. package/src/mutationCache.ts +2 -2
  79. package/src/queryClient.ts +2 -2
  80. package/src/useMutation.ts +31 -20
@@ -456,11 +456,11 @@ export class QueryClient extends QC {
456
456
  TData = unknown,
457
457
  TError = DefaultError,
458
458
  TVariables = void,
459
- TContext = unknown,
459
+ TOnMutateResult = unknown,
460
460
  >(
461
461
  mutationKey: MaybeRefDeep<MutationKey>,
462
462
  options: MaybeRefDeep<
463
- MutationObserverOptions<TData, TError, TVariables, TContext>
463
+ MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>
464
464
  >,
465
465
  ): void {
466
466
  super.setMutationDefaults(
@@ -24,53 +24,64 @@ import type {
24
24
  import type { MaybeRefDeep, ShallowOption } from './types'
25
25
  import type { QueryClient } from './queryClient'
26
26
 
27
- type MutationResult<TData, TError, TVariables, TContext> = DistributiveOmit<
28
- MutationObserverResult<TData, TError, TVariables, TContext>,
29
- 'mutate' | 'reset'
30
- >
27
+ type MutationResult<TData, TError, TVariables, TOnMutateResult> =
28
+ DistributiveOmit<
29
+ MutationObserverResult<TData, TError, TVariables, TOnMutateResult>,
30
+ 'mutate' | 'reset'
31
+ >
31
32
 
32
- type UseMutationOptionsBase<TData, TError, TVariables, TContext> =
33
- MutationObserverOptions<TData, TError, TVariables, TContext> & ShallowOption
33
+ type UseMutationOptionsBase<TData, TError, TVariables, TOnMutateResult> =
34
+ MutationObserverOptions<TData, TError, TVariables, TOnMutateResult> &
35
+ ShallowOption
34
36
 
35
37
  export type UseMutationOptions<
36
38
  TData = unknown,
37
39
  TError = DefaultError,
38
40
  TVariables = void,
39
- TContext = unknown,
40
- > = MaybeRefDeep<UseMutationOptionsBase<TData, TError, TVariables, TContext>>
41
+ TOnMutateResult = unknown,
42
+ > = MaybeRefDeep<
43
+ UseMutationOptionsBase<TData, TError, TVariables, TOnMutateResult>
44
+ >
41
45
 
42
46
  type MutateSyncFunction<
43
47
  TData = unknown,
44
48
  TError = DefaultError,
45
49
  TVariables = void,
46
- TContext = unknown,
50
+ TOnMutateResult = unknown,
47
51
  > = (
48
- ...options: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
52
+ ...options: Parameters<
53
+ MutateFunction<TData, TError, TVariables, TOnMutateResult>
54
+ >
49
55
  ) => void
50
56
 
51
57
  export type UseMutationReturnType<
52
58
  TData,
53
59
  TError,
54
60
  TVariables,
55
- TContext,
56
- TResult = MutationResult<TData, TError, TVariables, TContext>,
61
+ TOnMutateResult,
62
+ TResult = MutationResult<TData, TError, TVariables, TOnMutateResult>,
57
63
  > = ToRefs<Readonly<TResult>> & {
58
- mutate: MutateSyncFunction<TData, TError, TVariables, TContext>
59
- mutateAsync: MutateFunction<TData, TError, TVariables, TContext>
60
- reset: MutationObserverResult<TData, TError, TVariables, TContext>['reset']
64
+ mutate: MutateSyncFunction<TData, TError, TVariables, TOnMutateResult>
65
+ mutateAsync: MutateFunction<TData, TError, TVariables, TOnMutateResult>
66
+ reset: MutationObserverResult<
67
+ TData,
68
+ TError,
69
+ TVariables,
70
+ TOnMutateResult
71
+ >['reset']
61
72
  }
62
73
 
63
74
  export function useMutation<
64
75
  TData = unknown,
65
76
  TError = DefaultError,
66
77
  TVariables = void,
67
- TContext = unknown,
78
+ TOnMutateResult = unknown,
68
79
  >(
69
80
  mutationOptions: MaybeRefDeep<
70
- UseMutationOptionsBase<TData, TError, TVariables, TContext>
81
+ UseMutationOptionsBase<TData, TError, TVariables, TOnMutateResult>
71
82
  >,
72
83
  queryClient?: QueryClient,
73
- ): UseMutationReturnType<TData, TError, TVariables, TContext> {
84
+ ): UseMutationReturnType<TData, TError, TVariables, TOnMutateResult> {
74
85
  if (process.env.NODE_ENV === 'development') {
75
86
  if (!getCurrentScope()) {
76
87
  console.warn(
@@ -94,7 +105,7 @@ export function useMutation<
94
105
 
95
106
  const mutate = (
96
107
  variables: TVariables,
97
- mutateOptions?: MutateOptions<TData, TError, TVariables, TContext>,
108
+ mutateOptions?: MutateOptions<TData, TError, TVariables, TOnMutateResult>,
98
109
  ) => {
99
110
  observer.mutate(variables, mutateOptions).catch(() => {
100
111
  // This is intentional
@@ -114,7 +125,7 @@ export function useMutation<
114
125
  : readonly(state)
115
126
 
116
127
  const resultRefs = toRefs(readonlyState) as ToRefs<
117
- Readonly<MutationResult<TData, TError, TVariables, TContext>>
128
+ Readonly<MutationResult<TData, TError, TVariables, TOnMutateResult>>
118
129
  >
119
130
 
120
131
  watch(