@tanstack/react-query 5.17.19 → 5.18.1
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.
- package/build/codemods/coverage/clover.xml +2 -2
- package/build/codemods/coverage/coverage-final.json +2 -2
- package/build/codemods/coverage/index.html +1 -1
- package/build/codemods/coverage/utils/index.html +1 -1
- package/build/codemods/coverage/utils/index.js.html +1 -1
- package/build/codemods/coverage/utils/transformers/index.html +1 -1
- package/build/codemods/coverage/utils/transformers/query-cache-transformer.js.html +1 -1
- package/build/codemods/coverage/utils/transformers/query-client-transformer.js.html +1 -1
- package/build/codemods/coverage/utils/transformers/use-query-like-transformer.js.html +1 -1
- package/build/codemods/coverage/v4/index.html +1 -1
- package/build/codemods/coverage/v4/key-transformation.js.html +1 -1
- package/build/codemods/coverage/v4/replace-import-specifier.js.html +1 -1
- package/build/codemods/coverage/v4/utils/replacers/index.html +1 -1
- package/build/codemods/coverage/v4/utils/replacers/key-replacer.js.html +1 -1
- package/build/codemods/coverage/v5/is-loading/index.html +1 -1
- package/build/codemods/coverage/v5/is-loading/is-loading.js.html +1 -1
- package/build/codemods/coverage/v5/keep-previous-data/index.html +1 -1
- package/build/codemods/coverage/v5/keep-previous-data/keep-previous-data.js.html +1 -1
- package/build/codemods/coverage/v5/keep-previous-data/utils/already-has-placeholder-data-property.js.html +1 -1
- package/build/codemods/coverage/v5/keep-previous-data/utils/index.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/index.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/remove-overloads.js.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/transformers/filter-aware-usage-transformer.js.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/transformers/index.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/transformers/query-fn-aware-usage-transformer.js.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/utils/index.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/utils/index.js.html +1 -1
- package/build/codemods/coverage/v5/remove-overloads/utils/unknown-usage-error.js.html +1 -1
- package/build/codemods/coverage/v5/rename-hydrate/index.html +1 -1
- package/build/codemods/coverage/v5/rename-hydrate/rename-hydrate.js.html +1 -1
- package/build/codemods/coverage/v5/rename-properties/index.html +1 -1
- package/build/codemods/coverage/v5/rename-properties/rename-properties.js.html +1 -1
- package/build/legacy/types.cjs.map +1 -1
- package/build/legacy/types.d.cts +2 -2
- package/build/legacy/types.d.ts +2 -2
- package/build/legacy/useQueries.cjs.map +1 -1
- package/build/legacy/useQueries.d.cts +6 -6
- package/build/legacy/useQueries.d.ts +6 -6
- package/build/legacy/useQueries.js.map +1 -1
- package/build/legacy/useSuspenseQueries.cjs.map +1 -1
- package/build/legacy/useSuspenseQueries.d.cts +6 -6
- package/build/legacy/useSuspenseQueries.d.ts +6 -6
- package/build/legacy/useSuspenseQueries.js.map +1 -1
- package/build/modern/types.cjs.map +1 -1
- package/build/modern/types.d.cts +2 -2
- package/build/modern/types.d.ts +2 -2
- package/build/modern/useQueries.cjs.map +1 -1
- package/build/modern/useQueries.d.cts +6 -6
- package/build/modern/useQueries.d.ts +6 -6
- package/build/modern/useQueries.js.map +1 -1
- package/build/modern/useSuspenseQueries.cjs.map +1 -1
- package/build/modern/useSuspenseQueries.d.cts +6 -6
- package/build/modern/useSuspenseQueries.d.ts +6 -6
- package/build/modern/useSuspenseQueries.js.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/QueryResetErrorBoundary.test.tsx +1 -1
- package/src/__tests__/suspense.test.tsx +2 -2
- package/src/__tests__/useIsFetching.test.tsx +6 -6
- package/src/__tests__/useMutationState.test.tsx +9 -9
- package/src/__tests__/useQuery.test.tsx +5 -5
- package/src/__tests__/utils.tsx +3 -3
- package/src/types.ts +5 -1
- package/src/useQueries.ts +12 -12
- package/src/useSuspenseQueries.ts +12 -12
|
@@ -14,12 +14,12 @@ import type { MutationState, MutationStatus } from '@tanstack/query-core'
|
|
|
14
14
|
|
|
15
15
|
describe('useIsMutating', () => {
|
|
16
16
|
it('should return the number of fetching mutations', async () => {
|
|
17
|
-
const
|
|
17
|
+
const isMutatingArray: Array<number> = []
|
|
18
18
|
const queryClient = createQueryClient()
|
|
19
19
|
|
|
20
20
|
function IsMutating() {
|
|
21
21
|
const isMutating = useIsMutating()
|
|
22
|
-
|
|
22
|
+
isMutatingArray.push(isMutating)
|
|
23
23
|
return null
|
|
24
24
|
}
|
|
25
25
|
|
|
@@ -59,16 +59,16 @@ describe('useIsMutating', () => {
|
|
|
59
59
|
}
|
|
60
60
|
|
|
61
61
|
renderWithClient(queryClient, <Page />)
|
|
62
|
-
await waitFor(() => expect(
|
|
62
|
+
await waitFor(() => expect(isMutatingArray).toEqual([0, 1, 2, 1, 0]))
|
|
63
63
|
})
|
|
64
64
|
|
|
65
65
|
it('should filter correctly by mutationKey', async () => {
|
|
66
|
-
const
|
|
66
|
+
const isMutatingArray: Array<number> = []
|
|
67
67
|
const queryClient = createQueryClient()
|
|
68
68
|
|
|
69
69
|
function IsMutating() {
|
|
70
70
|
const isMutating = useIsMutating({ mutationKey: ['mutation1'] })
|
|
71
|
-
|
|
71
|
+
isMutatingArray.push(isMutating)
|
|
72
72
|
return null
|
|
73
73
|
}
|
|
74
74
|
|
|
@@ -97,11 +97,11 @@ describe('useIsMutating', () => {
|
|
|
97
97
|
}
|
|
98
98
|
|
|
99
99
|
renderWithClient(queryClient, <Page />)
|
|
100
|
-
await waitFor(() => expect(
|
|
100
|
+
await waitFor(() => expect(isMutatingArray).toEqual([0, 1, 0]))
|
|
101
101
|
})
|
|
102
102
|
|
|
103
103
|
it('should filter correctly by predicate', async () => {
|
|
104
|
-
const
|
|
104
|
+
const isMutatingArray: Array<number> = []
|
|
105
105
|
const queryClient = createQueryClient()
|
|
106
106
|
|
|
107
107
|
function IsMutating() {
|
|
@@ -109,7 +109,7 @@ describe('useIsMutating', () => {
|
|
|
109
109
|
predicate: (mutation) =>
|
|
110
110
|
mutation.options.mutationKey?.[0] === 'mutation1',
|
|
111
111
|
})
|
|
112
|
-
|
|
112
|
+
isMutatingArray.push(isMutating)
|
|
113
113
|
return null
|
|
114
114
|
}
|
|
115
115
|
|
|
@@ -138,7 +138,7 @@ describe('useIsMutating', () => {
|
|
|
138
138
|
}
|
|
139
139
|
|
|
140
140
|
renderWithClient(queryClient, <Page />)
|
|
141
|
-
await waitFor(() => expect(
|
|
141
|
+
await waitFor(() => expect(isMutatingArray).toEqual([0, 1, 0]))
|
|
142
142
|
})
|
|
143
143
|
|
|
144
144
|
it('should use provided custom queryClient', async () => {
|
|
@@ -1183,7 +1183,7 @@ describe('useQuery', () => {
|
|
|
1183
1183
|
)
|
|
1184
1184
|
})
|
|
1185
1185
|
|
|
1186
|
-
it('should not update disabled query when
|
|
1186
|
+
it('should not update disabled query when refetching with refetchQueries', async () => {
|
|
1187
1187
|
const key = queryKey()
|
|
1188
1188
|
const states: Array<UseQueryResult<number>> = []
|
|
1189
1189
|
let count = 0
|
|
@@ -2722,7 +2722,7 @@ describe('useQuery', () => {
|
|
|
2722
2722
|
await waitFor(() => rendered.getByText('data: 1, isFetching: false'))
|
|
2723
2723
|
})
|
|
2724
2724
|
|
|
2725
|
-
it('should calculate focus
|
|
2725
|
+
it('should calculate focus behavior for `refetchOnWindowFocus` depending on function', async () => {
|
|
2726
2726
|
const key = queryKey()
|
|
2727
2727
|
const states: Array<UseQueryResult<number>> = []
|
|
2728
2728
|
let count = 0
|
|
@@ -2859,7 +2859,7 @@ describe('useQuery', () => {
|
|
|
2859
2859
|
const { status, error } = useQuery({
|
|
2860
2860
|
queryKey: key,
|
|
2861
2861
|
queryFn: () => {
|
|
2862
|
-
return Promise.reject(new Error('Error test
|
|
2862
|
+
return Promise.reject(new Error('Error test'))
|
|
2863
2863
|
},
|
|
2864
2864
|
retry: false,
|
|
2865
2865
|
})
|
|
@@ -2875,7 +2875,7 @@ describe('useQuery', () => {
|
|
|
2875
2875
|
const rendered = renderWithClient(queryClient, <Page />)
|
|
2876
2876
|
|
|
2877
2877
|
await waitFor(() => rendered.getByText('error'))
|
|
2878
|
-
await waitFor(() => rendered.getByText('Error test
|
|
2878
|
+
await waitFor(() => rendered.getByText('Error test'))
|
|
2879
2879
|
|
|
2880
2880
|
consoleMock.mockRestore()
|
|
2881
2881
|
})
|
|
@@ -2889,7 +2889,7 @@ describe('useQuery', () => {
|
|
|
2889
2889
|
function Page() {
|
|
2890
2890
|
const { status, error } = useQuery<unknown, string>({
|
|
2891
2891
|
queryKey: key,
|
|
2892
|
-
queryFn: () => Promise.reject(new Error('Error test
|
|
2892
|
+
queryFn: () => Promise.reject(new Error('Error test')),
|
|
2893
2893
|
retry: false,
|
|
2894
2894
|
throwOnError: true,
|
|
2895
2895
|
})
|
package/src/__tests__/utils.tsx
CHANGED
|
@@ -78,9 +78,9 @@ export function setActTimeout(fn: () => void, ms?: number) {
|
|
|
78
78
|
}, ms)
|
|
79
79
|
}
|
|
80
80
|
|
|
81
|
-
export type Equal<
|
|
82
|
-
|
|
83
|
-
>() => T extends
|
|
81
|
+
export type Equal<TTargetA, TTargetB> = (<T>() => T extends TTargetA
|
|
82
|
+
? 1
|
|
83
|
+
: 2) extends <T>() => T extends TTargetB ? 1 : 2
|
|
84
84
|
? true
|
|
85
85
|
: false
|
|
86
86
|
|
package/src/types.ts
CHANGED
|
@@ -168,4 +168,8 @@ export type UseMutationResult<
|
|
|
168
168
|
TContext = unknown,
|
|
169
169
|
> = UseBaseMutationResult<TData, TError, TVariables, TContext>
|
|
170
170
|
|
|
171
|
-
type Override<
|
|
171
|
+
type Override<TTargetA, TTargetB> = {
|
|
172
|
+
[AKey in keyof TTargetA]: AKey extends keyof TTargetB
|
|
173
|
+
? TTargetB[AKey]
|
|
174
|
+
: TTargetA[AKey]
|
|
175
|
+
}
|
package/src/useQueries.ts
CHANGED
|
@@ -159,19 +159,19 @@ type GetResults<T> =
|
|
|
159
159
|
*/
|
|
160
160
|
export type QueriesOptions<
|
|
161
161
|
T extends Array<any>,
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
> =
|
|
162
|
+
TResult extends Array<any> = [],
|
|
163
|
+
TDepth extends ReadonlyArray<number> = [],
|
|
164
|
+
> = TDepth['length'] extends MAXIMUM_DEPTH
|
|
165
165
|
? Array<UseQueryOptionsForUseQueries>
|
|
166
166
|
: T extends []
|
|
167
167
|
? []
|
|
168
168
|
: T extends [infer Head]
|
|
169
|
-
? [...
|
|
169
|
+
? [...TResult, GetOptions<Head>]
|
|
170
170
|
: T extends [infer Head, ...infer Tail]
|
|
171
171
|
? QueriesOptions<
|
|
172
172
|
[...Tail],
|
|
173
|
-
[...
|
|
174
|
-
[...
|
|
173
|
+
[...TResult, GetOptions<Head>],
|
|
174
|
+
[...TDepth, 1]
|
|
175
175
|
>
|
|
176
176
|
: Array<unknown> extends T
|
|
177
177
|
? T
|
|
@@ -201,19 +201,19 @@ export type QueriesOptions<
|
|
|
201
201
|
*/
|
|
202
202
|
export type QueriesResults<
|
|
203
203
|
T extends Array<any>,
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
> =
|
|
204
|
+
TResult extends Array<any> = [],
|
|
205
|
+
TDepth extends ReadonlyArray<number> = [],
|
|
206
|
+
> = TDepth['length'] extends MAXIMUM_DEPTH
|
|
207
207
|
? Array<UseQueryResult>
|
|
208
208
|
: T extends []
|
|
209
209
|
? []
|
|
210
210
|
: T extends [infer Head]
|
|
211
|
-
? [...
|
|
211
|
+
? [...TResult, GetResults<Head>]
|
|
212
212
|
: T extends [infer Head, ...infer Tail]
|
|
213
213
|
? QueriesResults<
|
|
214
214
|
[...Tail],
|
|
215
|
-
[...
|
|
216
|
-
[...
|
|
215
|
+
[...TResult, GetResults<Head>],
|
|
216
|
+
[...TDepth, 1]
|
|
217
217
|
>
|
|
218
218
|
: T extends Array<
|
|
219
219
|
UseQueryOptionsForUseQueries<
|
|
@@ -100,19 +100,19 @@ type GetSuspenseResults<T> =
|
|
|
100
100
|
*/
|
|
101
101
|
export type SuspenseQueriesOptions<
|
|
102
102
|
T extends Array<any>,
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
> =
|
|
103
|
+
TResult extends Array<any> = [],
|
|
104
|
+
TDepth extends ReadonlyArray<number> = [],
|
|
105
|
+
> = TDepth['length'] extends MAXIMUM_DEPTH
|
|
106
106
|
? Array<UseSuspenseQueryOptions>
|
|
107
107
|
: T extends []
|
|
108
108
|
? []
|
|
109
109
|
: T extends [infer Head]
|
|
110
|
-
? [...
|
|
110
|
+
? [...TResult, GetSuspenseOptions<Head>]
|
|
111
111
|
: T extends [infer Head, ...infer Tail]
|
|
112
112
|
? SuspenseQueriesOptions<
|
|
113
113
|
[...Tail],
|
|
114
|
-
[...
|
|
115
|
-
[...
|
|
114
|
+
[...TResult, GetSuspenseOptions<Head>],
|
|
115
|
+
[...TDepth, 1]
|
|
116
116
|
>
|
|
117
117
|
: Array<unknown> extends T
|
|
118
118
|
? T
|
|
@@ -137,19 +137,19 @@ export type SuspenseQueriesOptions<
|
|
|
137
137
|
*/
|
|
138
138
|
export type SuspenseQueriesResults<
|
|
139
139
|
T extends Array<any>,
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
> =
|
|
140
|
+
TResult extends Array<any> = [],
|
|
141
|
+
TDepth extends ReadonlyArray<number> = [],
|
|
142
|
+
> = TDepth['length'] extends MAXIMUM_DEPTH
|
|
143
143
|
? Array<UseSuspenseQueryResult>
|
|
144
144
|
: T extends []
|
|
145
145
|
? []
|
|
146
146
|
: T extends [infer Head]
|
|
147
|
-
? [...
|
|
147
|
+
? [...TResult, GetSuspenseResults<Head>]
|
|
148
148
|
: T extends [infer Head, ...infer Tail]
|
|
149
149
|
? SuspenseQueriesResults<
|
|
150
150
|
[...Tail],
|
|
151
|
-
[...
|
|
152
|
-
[...
|
|
151
|
+
[...TResult, GetSuspenseResults<Head>],
|
|
152
|
+
[...TDepth, 1]
|
|
153
153
|
>
|
|
154
154
|
: T extends Array<
|
|
155
155
|
UseSuspenseQueryOptions<
|