@tanstack/vue-query 5.17.15 → 5.18.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 (111) hide show
  1. package/build/legacy/index.d.cts +1 -1
  2. package/build/legacy/index.d.ts +1 -1
  3. package/build/legacy/queryClient.cjs.map +1 -1
  4. package/build/legacy/queryClient.d.cts +2 -2
  5. package/build/legacy/queryClient.d.ts +2 -2
  6. package/build/legacy/queryClient.js.map +1 -1
  7. package/build/legacy/queryOptions.d.cts +1 -1
  8. package/build/legacy/queryOptions.d.ts +1 -1
  9. package/build/legacy/types.cjs.map +1 -1
  10. package/build/legacy/types.d.cts +2 -2
  11. package/build/legacy/types.d.ts +2 -2
  12. package/build/legacy/useBaseQuery.cjs +1 -1
  13. package/build/legacy/useBaseQuery.cjs.map +1 -1
  14. package/build/legacy/useBaseQuery.d.cts +1 -1
  15. package/build/legacy/useBaseQuery.d.ts +1 -1
  16. package/build/legacy/useBaseQuery.js +1 -1
  17. package/build/legacy/useBaseQuery.js.map +1 -1
  18. package/build/legacy/useInfiniteQuery.d.cts +1 -1
  19. package/build/legacy/useInfiniteQuery.d.ts +1 -1
  20. package/build/legacy/useIsFetching.cjs +1 -1
  21. package/build/legacy/useIsFetching.cjs.map +1 -1
  22. package/build/legacy/useIsFetching.js +1 -1
  23. package/build/legacy/useIsFetching.js.map +1 -1
  24. package/build/legacy/useMutation.cjs +1 -1
  25. package/build/legacy/useMutation.cjs.map +1 -1
  26. package/build/legacy/useMutation.d.cts +1 -1
  27. package/build/legacy/useMutation.d.ts +1 -1
  28. package/build/legacy/useMutation.js +1 -1
  29. package/build/legacy/useMutation.js.map +1 -1
  30. package/build/legacy/useMutationState.cjs +10 -6
  31. package/build/legacy/useMutationState.cjs.map +1 -1
  32. package/build/legacy/useMutationState.js +10 -6
  33. package/build/legacy/useMutationState.js.map +1 -1
  34. package/build/legacy/useQueries.cjs +1 -1
  35. package/build/legacy/useQueries.cjs.map +1 -1
  36. package/build/legacy/useQueries.d.cts +7 -7
  37. package/build/legacy/useQueries.d.ts +7 -7
  38. package/build/legacy/useQueries.js +1 -1
  39. package/build/legacy/useQueries.js.map +1 -1
  40. package/build/legacy/{useQuery-CPqkvEsh.d.ts → useQuery-E3oRpddL.d.ts} +3 -3
  41. package/build/legacy/{useQuery-bwd-ixSz.d.cts → useQuery-XNC2YZeo.d.cts} +3 -3
  42. package/build/legacy/useQuery.d.cts +1 -1
  43. package/build/legacy/useQuery.d.ts +1 -1
  44. package/build/legacy/utils.cjs +5 -5
  45. package/build/legacy/utils.cjs.map +1 -1
  46. package/build/legacy/utils.d.cts +1 -1
  47. package/build/legacy/utils.d.ts +1 -1
  48. package/build/legacy/utils.js +5 -5
  49. package/build/legacy/utils.js.map +1 -1
  50. package/build/modern/index.d.cts +1 -1
  51. package/build/modern/index.d.ts +1 -1
  52. package/build/modern/queryClient.cjs.map +1 -1
  53. package/build/modern/queryClient.d.cts +2 -2
  54. package/build/modern/queryClient.d.ts +2 -2
  55. package/build/modern/queryClient.js.map +1 -1
  56. package/build/modern/queryOptions.d.cts +1 -1
  57. package/build/modern/queryOptions.d.ts +1 -1
  58. package/build/modern/types.cjs.map +1 -1
  59. package/build/modern/types.d.cts +2 -2
  60. package/build/modern/types.d.ts +2 -2
  61. package/build/modern/useBaseQuery.cjs +1 -1
  62. package/build/modern/useBaseQuery.cjs.map +1 -1
  63. package/build/modern/useBaseQuery.d.cts +1 -1
  64. package/build/modern/useBaseQuery.d.ts +1 -1
  65. package/build/modern/useBaseQuery.js +1 -1
  66. package/build/modern/useBaseQuery.js.map +1 -1
  67. package/build/modern/useInfiniteQuery.d.cts +1 -1
  68. package/build/modern/useInfiniteQuery.d.ts +1 -1
  69. package/build/modern/useIsFetching.cjs +1 -1
  70. package/build/modern/useIsFetching.cjs.map +1 -1
  71. package/build/modern/useIsFetching.js +1 -1
  72. package/build/modern/useIsFetching.js.map +1 -1
  73. package/build/modern/useMutation.cjs +1 -1
  74. package/build/modern/useMutation.cjs.map +1 -1
  75. package/build/modern/useMutation.d.cts +1 -1
  76. package/build/modern/useMutation.d.ts +1 -1
  77. package/build/modern/useMutation.js +1 -1
  78. package/build/modern/useMutation.js.map +1 -1
  79. package/build/modern/useMutationState.cjs +10 -6
  80. package/build/modern/useMutationState.cjs.map +1 -1
  81. package/build/modern/useMutationState.js +10 -6
  82. package/build/modern/useMutationState.js.map +1 -1
  83. package/build/modern/useQueries.cjs +1 -1
  84. package/build/modern/useQueries.cjs.map +1 -1
  85. package/build/modern/useQueries.d.cts +7 -7
  86. package/build/modern/useQueries.d.ts +7 -7
  87. package/build/modern/useQueries.js +1 -1
  88. package/build/modern/useQueries.js.map +1 -1
  89. package/build/modern/{useQuery-CPqkvEsh.d.ts → useQuery-E3oRpddL.d.ts} +3 -3
  90. package/build/modern/{useQuery-bwd-ixSz.d.cts → useQuery-XNC2YZeo.d.cts} +3 -3
  91. package/build/modern/useQuery.d.cts +1 -1
  92. package/build/modern/useQuery.d.ts +1 -1
  93. package/build/modern/utils.cjs +5 -5
  94. package/build/modern/utils.cjs.map +1 -1
  95. package/build/modern/utils.d.cts +1 -1
  96. package/build/modern/utils.d.ts +1 -1
  97. package/build/modern/utils.js +5 -5
  98. package/build/modern/utils.js.map +1 -1
  99. package/package.json +2 -2
  100. package/src/__tests__/test-utils.ts +3 -3
  101. package/src/__tests__/useQuery.test.ts +4 -4
  102. package/src/__tests__/useQuery.types.test.ts +2 -2
  103. package/src/__tests__/utils.test.ts +1 -1
  104. package/src/queryClient.ts +7 -6
  105. package/src/types.ts +5 -5
  106. package/src/useBaseQuery.ts +6 -6
  107. package/src/useIsFetching.ts +1 -1
  108. package/src/useMutation.ts +3 -3
  109. package/src/useMutationState.ts +10 -6
  110. package/src/useQueries.ts +13 -13
  111. package/src/utils.ts +5 -5
package/src/useMutation.ts CHANGED
@@ -47,8 +47,8 @@ export type UseMutationReturnType<
47
47
  TError,
48
48
  TVariables,
49
49
  TContext,
50
- Result = MutationResult<TData, TError, TVariables, TContext>,
51
- > = ToRefs<Readonly<Result>> & {
50
+ TResult = MutationResult<TData, TError, TVariables, TContext>,
51
+ > = ToRefs<Readonly<TResult>> & {
52
52
  mutate: MutateSyncFunction<TData, TError, TVariables, TContext>
53
53
  mutateAsync: MutateFunction<TData, TError, TVariables, TContext>
54
54
  reset: MutationObserverResult<TData, TError, TVariables, TContext>['reset']
@@ -68,7 +68,7 @@ export function useMutation<
68
68
  if (process.env.NODE_ENV === 'development') {
69
69
  if (!getCurrentScope()) {
70
70
  console.warn(
71
- '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.',
71
+ 'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
72
72
  )
73
73
  }
74
74
  }
package/src/useMutationState.ts CHANGED
@@ -28,18 +28,22 @@ export function useIsMutating(
28
28
  if (process.env.NODE_ENV === 'development') {
29
29
  if (!getCurrentScope()) {
30
30
  console.warn(
31
- '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.',
31
+ 'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
32
32
  )
33
33
  }
34
34
  }
35
35
 
36
36
  const client = queryClient || useQueryClient()
37
- const unreffedFilters = computed(() => ({
38
- ...cloneDeepUnref(filters),
39
- status: 'pending' as const,
40
- }))
41
37
 
42
- const mutationState = useMutationState({ filters: unreffedFilters }, client)
38
+ const mutationState = useMutationState(
39
+ {
40
+ filters: computed(() => ({
41
+ ...cloneDeepUnref(filters),
42
+ status: 'pending' as const,
43
+ })),
44
+ },
45
+ client,
46
+ )
43
47
  const length = computed(() => mutationState.value.length)
44
48
 
45
49
  return length
package/src/useQueries.ts CHANGED
@@ -169,19 +169,19 @@ type GetResults<T> =
169
169
  */
170
170
  export type UseQueriesOptions<
171
171
  T extends Array<any>,
172
- Result extends Array<any> = [],
173
- Depth extends ReadonlyArray<number> = [],
174
- > = Depth['length'] extends MAXIMUM_DEPTH
172
+ TResult extends Array<any> = [],
173
+ TDepth extends ReadonlyArray<number> = [],
174
+ > = TDepth['length'] extends MAXIMUM_DEPTH
175
175
  ? Array<UseQueryOptionsForUseQueries>
176
176
  : T extends []
177
177
  ? []
178
178
  : T extends [infer Head]
179
- ? [...Result, GetOptions<Head>]
179
+ ? [...TResult, GetOptions<Head>]
180
180
  : T extends [infer Head, ...infer Tail]
181
181
  ? UseQueriesOptions<
182
182
  [...Tail],
183
- [...Result, GetOptions<Head>],
184
- [...Depth, 1]
183
+ [...TResult, GetOptions<Head>],
184
+ [...TDepth, 1]
185
185
  >
186
186
  : Array<unknown> extends T
187
187
  ? T
@@ -211,19 +211,19 @@ export type UseQueriesOptions<
211
211
  */
212
212
  export type UseQueriesResults<
213
213
  T extends Array<any>,
214
- Result extends Array<any> = [],
215
- Depth extends ReadonlyArray<number> = [],
216
- > = Depth['length'] extends MAXIMUM_DEPTH
214
+ TResult extends Array<any> = [],
215
+ TDepth extends ReadonlyArray<number> = [],
216
+ > = TDepth['length'] extends MAXIMUM_DEPTH
217
217
  ? Array<QueryObserverResult>
218
218
  : T extends []
219
219
  ? []
220
220
  : T extends [infer Head]
221
- ? [...Result, GetResults<Head>]
221
+ ? [...TResult, GetResults<Head>]
222
222
  : T extends [infer Head, ...infer Tail]
223
223
  ? UseQueriesResults<
224
224
  [...Tail],
225
- [...Result, GetResults<Head>],
226
- [...Depth, 1]
225
+ [...TResult, GetResults<Head>],
226
+ [...TDepth, 1]
227
227
  >
228
228
  : T extends Array<
229
229
  UseQueryOptionsForUseQueries<
@@ -263,7 +263,7 @@ export function useQueries<
263
263
  if (process.env.NODE_ENV === 'development') {
264
264
  if (!getCurrentScope()) {
265
265
  console.warn(
266
- '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.',
266
+ 'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
267
267
  )
268
268
  }
269
269
  }
package/src/utils.ts CHANGED
@@ -19,10 +19,10 @@ export function updateState(
19
19
 
20
20
  export function cloneDeep<T>(
21
21
  value: MaybeRefDeep<T>,
22
- customizer?: (val: MaybeRefDeep<T>) => T | undefined,
22
+ customize?: (val: MaybeRefDeep<T>) => T | undefined,
23
23
  ): T {
24
- if (customizer) {
25
- const result = customizer(value)
24
+ if (customize) {
25
+ const result = customize(value)
26
26
  // If it's a ref of undefined, return undefined
27
27
  if (result === undefined && isRef(value)) {
28
28
  return result as T
@@ -33,13 +33,13 @@ export function cloneDeep<T>(
33
33
  }
34
34
 
35
35
  if (Array.isArray(value)) {
36
- return value.map((val) => cloneDeep(val, customizer)) as unknown as T
36
+ return value.map((val) => cloneDeep(val, customize)) as unknown as T
37
37
  }
38
38
 
39
39
  if (typeof value === 'object' && isPlainObject(value)) {
40
40
  const entries = Object.entries(value).map(([key, val]) => [
41
41
  key,
42
- cloneDeep(val, customizer),
42
+ cloneDeep(val, customize),
43
43
  ])
44
44
  return Object.fromEntries(entries)
45
45
  }