@tanstack/vue-query 5.0.0-beta.18 → 5.0.0-beta.22

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 (104) hide show
  1. package/build/legacy/devtools/devtools.cjs.map +1 -1
  2. package/build/legacy/devtools/devtools.js.map +1 -1
  3. package/build/legacy/mutationCache.cjs.map +1 -1
  4. package/build/legacy/mutationCache.d.cts +1 -1
  5. package/build/legacy/mutationCache.d.ts +1 -1
  6. package/build/legacy/mutationCache.js.map +1 -1
  7. package/build/legacy/queryCache.cjs.map +1 -1
  8. package/build/legacy/queryCache.d.cts +1 -1
  9. package/build/legacy/queryCache.d.ts +1 -1
  10. package/build/legacy/queryCache.js.map +1 -1
  11. package/build/legacy/queryClient.cjs.map +1 -1
  12. package/build/legacy/queryClient.d.cts +2 -2
  13. package/build/legacy/queryClient.d.ts +2 -2
  14. package/build/legacy/queryClient.js.map +1 -1
  15. package/build/legacy/useBaseQuery.cjs +7 -0
  16. package/build/legacy/useBaseQuery.cjs.map +1 -1
  17. package/build/legacy/useBaseQuery.js +8 -0
  18. package/build/legacy/useBaseQuery.js.map +1 -1
  19. package/build/legacy/useIsFetching.cjs +13 -9
  20. package/build/legacy/useIsFetching.cjs.map +1 -1
  21. package/build/legacy/useIsFetching.js +14 -10
  22. package/build/legacy/useIsFetching.js.map +1 -1
  23. package/build/legacy/useMutation.cjs +7 -0
  24. package/build/legacy/useMutation.cjs.map +1 -1
  25. package/build/legacy/useMutation.js +8 -0
  26. package/build/legacy/useMutation.js.map +1 -1
  27. package/build/legacy/useMutationState.cjs +7 -0
  28. package/build/legacy/useMutationState.cjs.map +1 -1
  29. package/build/legacy/useMutationState.js +15 -1
  30. package/build/legacy/useMutationState.js.map +1 -1
  31. package/build/legacy/useQueries.cjs +7 -0
  32. package/build/legacy/useQueries.cjs.map +1 -1
  33. package/build/legacy/useQueries.d.cts +6 -4
  34. package/build/legacy/useQueries.d.ts +6 -4
  35. package/build/legacy/useQueries.js +15 -1
  36. package/build/legacy/useQueries.js.map +1 -1
  37. package/build/legacy/useQueryClient.cjs +4 -4
  38. package/build/legacy/useQueryClient.cjs.map +1 -1
  39. package/build/legacy/useQueryClient.js +5 -5
  40. package/build/legacy/useQueryClient.js.map +1 -1
  41. package/build/legacy/utils.cjs.map +1 -1
  42. package/build/legacy/utils.d.cts +1 -1
  43. package/build/legacy/utils.d.ts +1 -1
  44. package/build/legacy/utils.js.map +1 -1
  45. package/build/modern/devtools/devtools.cjs.map +1 -1
  46. package/build/modern/devtools/devtools.js.map +1 -1
  47. package/build/modern/mutationCache.cjs.map +1 -1
  48. package/build/modern/mutationCache.d.cts +1 -1
  49. package/build/modern/mutationCache.d.ts +1 -1
  50. package/build/modern/mutationCache.js.map +1 -1
  51. package/build/modern/queryCache.cjs.map +1 -1
  52. package/build/modern/queryCache.d.cts +1 -1
  53. package/build/modern/queryCache.d.ts +1 -1
  54. package/build/modern/queryCache.js.map +1 -1
  55. package/build/modern/queryClient.cjs.map +1 -1
  56. package/build/modern/queryClient.d.cts +2 -2
  57. package/build/modern/queryClient.d.ts +2 -2
  58. package/build/modern/queryClient.js.map +1 -1
  59. package/build/modern/useBaseQuery.cjs +7 -0
  60. package/build/modern/useBaseQuery.cjs.map +1 -1
  61. package/build/modern/useBaseQuery.js +8 -0
  62. package/build/modern/useBaseQuery.js.map +1 -1
  63. package/build/modern/useIsFetching.cjs +13 -9
  64. package/build/modern/useIsFetching.cjs.map +1 -1
  65. package/build/modern/useIsFetching.js +14 -10
  66. package/build/modern/useIsFetching.js.map +1 -1
  67. package/build/modern/useMutation.cjs +7 -0
  68. package/build/modern/useMutation.cjs.map +1 -1
  69. package/build/modern/useMutation.js +8 -0
  70. package/build/modern/useMutation.js.map +1 -1
  71. package/build/modern/useMutationState.cjs +7 -0
  72. package/build/modern/useMutationState.cjs.map +1 -1
  73. package/build/modern/useMutationState.js +15 -1
  74. package/build/modern/useMutationState.js.map +1 -1
  75. package/build/modern/useQueries.cjs +7 -0
  76. package/build/modern/useQueries.cjs.map +1 -1
  77. package/build/modern/useQueries.d.cts +6 -4
  78. package/build/modern/useQueries.d.ts +6 -4
  79. package/build/modern/useQueries.js +15 -1
  80. package/build/modern/useQueries.js.map +1 -1
  81. package/build/modern/useQueryClient.cjs +4 -3
  82. package/build/modern/useQueryClient.cjs.map +1 -1
  83. package/build/modern/useQueryClient.js +5 -4
  84. package/build/modern/useQueryClient.js.map +1 -1
  85. package/build/modern/utils.cjs.map +1 -1
  86. package/build/modern/utils.d.cts +1 -1
  87. package/build/modern/utils.d.ts +1 -1
  88. package/build/modern/utils.js.map +1 -1
  89. package/package.json +6 -6
  90. package/src/__mocks__/useBaseQuery.ts +1 -1
  91. package/src/__tests__/useMutation.test.ts +3 -3
  92. package/src/__tests__/useQueryClient.test.ts +4 -4
  93. package/src/__tests__/utils.test.ts +1 -1
  94. package/src/devtools/devtools.ts +2 -2
  95. package/src/mutationCache.ts +1 -1
  96. package/src/queryCache.ts +1 -1
  97. package/src/queryClient.ts +2 -2
  98. package/src/useBaseQuery.ts +9 -0
  99. package/src/useIsFetching.ts +16 -10
  100. package/src/useMutation.ts +9 -0
  101. package/src/useMutationState.ts +17 -2
  102. package/src/useQueries.ts +49 -26
  103. package/src/useQueryClient.ts +6 -5
  104. package/src/utils.ts +1 -1
package/src/useQueries.ts CHANGED
@@ -1,6 +1,13 @@
1
1
  /* eslint-disable @typescript-eslint/no-explicit-any */
2
2
  import { QueriesObserver } from '@tanstack/query-core'
3
- import { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'
3
+ import {
4
+ computed,
5
+ getCurrentScope,
6
+ onScopeDispose,
7
+ readonly,
8
+ ref,
9
+ watch,
10
+ } from 'vue-demi'
4
11
 
5
12
  import { useQueryClient } from './useQueryClient'
6
13
  import { cloneDeepUnref } from './utils'
@@ -93,61 +100,69 @@ type GetResults<T> =
93
100
  * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
94
101
  */
95
102
  export type UseQueriesOptions<
96
- T extends any[],
97
- Result extends any[] = [],
103
+ T extends Array<any>,
104
+ Result extends Array<any> = [],
98
105
  Depth extends ReadonlyArray<number> = [],
99
106
  > = Depth['length'] extends MAXIMUM_DEPTH
100
- ? UseQueryOptionsForUseQueries[]
107
+ ? Array<UseQueryOptionsForUseQueries>
101
108
  : T extends []
102
109
  ? []
103
110
  : T extends [infer Head]
104
111
  ? [...Result, GetOptions<Head>]
105
112
  : T extends [infer Head, ...infer Tail]
106
113
  ? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>
107
- : unknown[] extends T
114
+ : Array<unknown> extends T
108
115
  ? T
109
116
  : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
110
117
  // use this to infer the param types in the case of Array.map() argument
111
- T extends UseQueryOptionsForUseQueries<
112
- infer TQueryFnData,
113
- infer TError,
114
- infer TData,
115
- infer TQueryKey
116
- >[]
117
- ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[]
118
+ T extends Array<
119
+ UseQueryOptionsForUseQueries<
120
+ infer TQueryFnData,
121
+ infer TError,
122
+ infer TData,
123
+ infer TQueryKey
124
+ >
125
+ >
126
+ ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>>
118
127
  : // Fallback
119
- UseQueryOptionsForUseQueries[]
128
+ Array<UseQueryOptionsForUseQueries>
120
129
 
121
130
  /**
122
131
  * UseQueriesResults reducer recursively maps type param to results
123
132
  */
124
133
  export type UseQueriesResults<
125
- T extends any[],
126
- Result extends any[] = [],
134
+ T extends Array<any>,
135
+ Result extends Array<any> = [],
127
136
  Depth extends ReadonlyArray<number> = [],
128
137
  > = Depth['length'] extends MAXIMUM_DEPTH
129
- ? QueryObserverResult[]
138
+ ? Array<QueryObserverResult>
130
139
  : T extends []
131
140
  ? []
132
141
  : T extends [infer Head]
133
142
  ? [...Result, GetResults<Head>]
134
143
  : T extends [infer Head, ...infer Tail]
135
144
  ? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>
136
- : T extends UseQueryOptionsForUseQueries<
137
- infer TQueryFnData,
138
- infer TError,
139
- infer TData,
140
- any
141
- >[]
145
+ : T extends Array<
146
+ UseQueryOptionsForUseQueries<
147
+ infer TQueryFnData,
148
+ infer TError,
149
+ infer TData,
150
+ any
151
+ >
152
+ >
142
153
  ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
143
- QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[]
154
+ Array<
155
+ QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>
156
+ >
144
157
  : // Fallback
145
- QueryObserverResult[]
158
+ Array<QueryObserverResult>
146
159
 
147
- type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>]
160
+ type UseQueriesOptionsArg<T extends Array<any>> = readonly [
161
+ ...UseQueriesOptions<T>,
162
+ ]
148
163
 
149
164
  export function useQueries<
150
- T extends any[],
165
+ T extends Array<any>,
151
166
  TCombinedResult = UseQueriesResults<T>,
152
167
  >(
153
168
  {
@@ -159,6 +174,14 @@ export function useQueries<
159
174
  },
160
175
  queryClient?: QueryClient,
161
176
  ): Readonly<Ref<TCombinedResult>> {
177
+ if (process.env.NODE_ENV === 'development') {
178
+ if (!getCurrentScope()) {
179
+ console.warn(
180
+ 'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
181
+ )
182
+ }
183
+ }
184
+
162
185
  const client = queryClient || useQueryClient()
163
186
 
164
187
  const defaultedQueries = computed(() =>
package/src/useQueryClient.ts CHANGED
@@ -1,13 +1,14 @@
1
- import { getCurrentInstance, inject } from 'vue-demi'
1
+ import { hasInjectionContext, inject } from 'vue-demi'
2
2
 
3
3
  import { getClientKey } from './utils'
4
4
  import type { QueryClient } from './queryClient'
5
5
 
6
6
  export function useQueryClient(id = ''): QueryClient {
7
- const vm = getCurrentInstance()?.proxy
8
-
9
- if (!vm) {
10
- throw new Error('vue-query hooks can only be used inside setup() function.')
7
+ // ensures that `inject()` can be used
8
+ if (!hasInjectionContext()) {
9
+ throw new Error(
10
+ 'vue-query hooks can only be used inside setup() function or functions that support injection context.',
11
+ )
11
12
  }
12
13
 
13
14
  const key = getClientKey(id)
package/src/utils.ts CHANGED
@@ -66,7 +66,7 @@ function isPlainObject(value: unknown): value is Object {
66
66
  return prototype === null || prototype === Object.prototype
67
67
  }
68
68
 
69
- export function shouldThrowError<T extends (...args: any[]) => boolean>(
69
+ export function shouldThrowError<T extends (...args: Array<any>) => boolean>(
70
70
  throwOnError: boolean | T | undefined,
71
71
  params: Parameters<T>,
72
72
  ): boolean {