@tanstack/react-query 5.0.0-alpha.1 → 5.0.0-alpha.10

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/lib/HydrationBoundary.esm.js +1 -0
  2. package/build/lib/HydrationBoundary.esm.js.map +1 -1
  3. package/build/lib/HydrationBoundary.js +1 -0
  4. package/build/lib/HydrationBoundary.js.map +1 -1
  5. package/build/lib/HydrationBoundary.mjs +1 -0
  6. package/build/lib/HydrationBoundary.mjs.map +1 -1
  7. package/build/lib/QueryClientProvider.esm.js +1 -0
  8. package/build/lib/QueryClientProvider.esm.js.map +1 -1
  9. package/build/lib/QueryClientProvider.js +1 -0
  10. package/build/lib/QueryClientProvider.js.map +1 -1
  11. package/build/lib/QueryClientProvider.mjs +1 -0
  12. package/build/lib/QueryClientProvider.mjs.map +1 -1
  13. package/build/lib/QueryErrorResetBoundary.esm.js +1 -0
  14. package/build/lib/QueryErrorResetBoundary.esm.js.map +1 -1
  15. package/build/lib/QueryErrorResetBoundary.js +1 -0
  16. package/build/lib/QueryErrorResetBoundary.js.map +1 -1
  17. package/build/lib/QueryErrorResetBoundary.mjs +1 -0
  18. package/build/lib/QueryErrorResetBoundary.mjs.map +1 -1
  19. package/build/lib/__tests__/ssr.test.d.ts +0 -3
  20. package/build/lib/__tests__/utils.d.ts +2 -3
  21. package/build/lib/errorBoundaryUtils.esm.js +1 -0
  22. package/build/lib/errorBoundaryUtils.esm.js.map +1 -1
  23. package/build/lib/errorBoundaryUtils.js +1 -0
  24. package/build/lib/errorBoundaryUtils.js.map +1 -1
  25. package/build/lib/errorBoundaryUtils.mjs +1 -0
  26. package/build/lib/errorBoundaryUtils.mjs.map +1 -1
  27. package/build/lib/isRestoring.esm.js +1 -0
  28. package/build/lib/isRestoring.esm.js.map +1 -1
  29. package/build/lib/isRestoring.js +1 -0
  30. package/build/lib/isRestoring.js.map +1 -1
  31. package/build/lib/isRestoring.mjs +1 -0
  32. package/build/lib/isRestoring.mjs.map +1 -1
  33. package/build/lib/suspense.esm.js +5 -5
  34. package/build/lib/suspense.esm.js.map +1 -1
  35. package/build/lib/suspense.js +5 -5
  36. package/build/lib/suspense.js.map +1 -1
  37. package/build/lib/types.d.ts +14 -14
  38. package/build/lib/useBaseQuery.esm.js +1 -0
  39. package/build/lib/useBaseQuery.esm.js.map +1 -1
  40. package/build/lib/useBaseQuery.js +1 -0
  41. package/build/lib/useBaseQuery.js.map +1 -1
  42. package/build/lib/useBaseQuery.mjs +1 -0
  43. package/build/lib/useBaseQuery.mjs.map +1 -1
  44. package/build/lib/useInfiniteQuery.d.ts +2 -2
  45. package/build/lib/useInfiniteQuery.esm.js +1 -0
  46. package/build/lib/useInfiniteQuery.esm.js.map +1 -1
  47. package/build/lib/useInfiniteQuery.js +1 -0
  48. package/build/lib/useInfiniteQuery.js.map +1 -1
  49. package/build/lib/useInfiniteQuery.mjs +1 -0
  50. package/build/lib/useInfiniteQuery.mjs.map +1 -1
  51. package/build/lib/useIsFetching.esm.js +1 -0
  52. package/build/lib/useIsFetching.esm.js.map +1 -1
  53. package/build/lib/useIsFetching.js +1 -0
  54. package/build/lib/useIsFetching.js.map +1 -1
  55. package/build/lib/useIsFetching.mjs +1 -0
  56. package/build/lib/useIsFetching.mjs.map +1 -1
  57. package/build/lib/useMutation.d.ts +2 -2
  58. package/build/lib/useMutation.esm.js +1 -0
  59. package/build/lib/useMutation.esm.js.map +1 -1
  60. package/build/lib/useMutation.js +1 -0
  61. package/build/lib/useMutation.js.map +1 -1
  62. package/build/lib/useMutation.mjs +1 -0
  63. package/build/lib/useMutation.mjs.map +1 -1
  64. package/build/lib/useMutationState.d.ts +4 -4
  65. package/build/lib/useMutationState.esm.js +1 -0
  66. package/build/lib/useMutationState.esm.js.map +1 -1
  67. package/build/lib/useMutationState.js +1 -0
  68. package/build/lib/useMutationState.js.map +1 -1
  69. package/build/lib/useMutationState.mjs +1 -0
  70. package/build/lib/useMutationState.mjs.map +1 -1
  71. package/build/lib/useQueries.d.ts +5 -6
  72. package/build/lib/useQueries.esm.js +13 -10
  73. package/build/lib/useQueries.esm.js.map +1 -1
  74. package/build/lib/useQueries.js +13 -10
  75. package/build/lib/useQueries.js.map +1 -1
  76. package/build/lib/useQueries.mjs +3 -3
  77. package/build/lib/useQueries.mjs.map +1 -1
  78. package/build/lib/useQuery.d.ts +5 -5
  79. package/build/lib/useQuery.esm.js +1 -0
  80. package/build/lib/useQuery.esm.js.map +1 -1
  81. package/build/lib/useQuery.js +1 -0
  82. package/build/lib/useQuery.js.map +1 -1
  83. package/build/lib/useQuery.mjs +1 -0
  84. package/build/lib/useQuery.mjs.map +1 -1
  85. package/build/umd/index.development.js +75 -61
  86. package/build/umd/index.development.js.map +1 -1
  87. package/build/umd/index.production.js +1 -1
  88. package/build/umd/index.production.js.map +1 -1
  89. package/package.json +3 -3
  90. package/src/__tests__/HydrationBoundary.test.tsx +4 -3
  91. package/src/__tests__/QueryClientProvider.test.tsx +2 -1
  92. package/src/__tests__/QueryResetErrorBoundary.test.tsx +12 -11
  93. package/src/__tests__/ssr-hydration.test.tsx +11 -10
  94. package/src/__tests__/ssr.test.tsx +4 -7
  95. package/src/__tests__/suspense.test.tsx +14 -13
  96. package/src/__tests__/useInfiniteQuery.test.tsx +18 -16
  97. package/src/__tests__/useInfiniteQuery.type.test.tsx +110 -2
  98. package/src/__tests__/useMutation.test.tsx +21 -20
  99. package/src/__tests__/useMutationState.test.tsx +24 -58
  100. package/src/__tests__/useQueries.test.tsx +23 -81
  101. package/src/__tests__/useQuery.test.tsx +30 -36
  102. package/src/__tests__/utils.tsx +3 -2
  103. package/src/errorBoundaryUtils.ts +1 -0
  104. package/src/types.ts +14 -14
  105. package/src/useBaseQuery.ts +1 -0
  106. package/src/useInfiniteQuery.ts +3 -2
  107. package/src/useIsFetching.ts +1 -0
  108. package/src/useMutation.ts +3 -2
  109. package/src/useMutationState.ts +7 -6
  110. package/src/useQueries.ts +12 -10
  111. package/src/useQuery.ts +7 -10
package/src/types.ts CHANGED
@@ -11,12 +11,12 @@ import type {
11
11
  MutateFunction,
12
12
  DefinedQueryObserverResult,
13
13
  WithRequired,
14
- RegisteredError,
14
+ DefaultError,
15
15
  } from '@tanstack/query-core'
16
16
 
17
17
  export interface UseBaseQueryOptions<
18
18
  TQueryFnData = unknown,
19
- TError = RegisteredError,
19
+ TError = DefaultError,
20
20
  TData = TQueryFnData,
21
21
  TQueryData = TQueryFnData,
22
22
  TQueryKey extends QueryKey = QueryKey,
@@ -27,7 +27,7 @@ export interface UseBaseQueryOptions<
27
27
 
28
28
  export interface UseQueryOptions<
29
29
  TQueryFnData = unknown,
30
- TError = RegisteredError,
30
+ TError = DefaultError,
31
31
  TData = TQueryFnData,
32
32
  TQueryKey extends QueryKey = QueryKey,
33
33
  > extends WithRequired<
@@ -37,7 +37,7 @@ export interface UseQueryOptions<
37
37
 
38
38
  export interface UseInfiniteQueryOptions<
39
39
  TQueryFnData = unknown,
40
- TError = RegisteredError,
40
+ TError = DefaultError,
41
41
  TData = TQueryFnData,
42
42
  TQueryData = TQueryFnData,
43
43
  TQueryKey extends QueryKey = QueryKey,
@@ -56,32 +56,32 @@ export interface UseInfiniteQueryOptions<
56
56
 
57
57
  export type UseBaseQueryResult<
58
58
  TData = unknown,
59
- TError = RegisteredError,
59
+ TError = DefaultError,
60
60
  > = QueryObserverResult<TData, TError>
61
61
 
62
62
  export type UseQueryResult<
63
63
  TData = unknown,
64
- TError = RegisteredError,
64
+ TError = DefaultError,
65
65
  > = UseBaseQueryResult<TData, TError>
66
66
 
67
67
  export type DefinedUseBaseQueryResult<
68
68
  TData = unknown,
69
- TError = RegisteredError,
69
+ TError = DefaultError,
70
70
  > = DefinedQueryObserverResult<TData, TError>
71
71
 
72
72
  export type DefinedUseQueryResult<
73
73
  TData = unknown,
74
- TError = RegisteredError,
74
+ TError = DefaultError,
75
75
  > = DefinedUseBaseQueryResult<TData, TError>
76
76
 
77
77
  export type UseInfiniteQueryResult<
78
78
  TData = unknown,
79
- TError = RegisteredError,
79
+ TError = DefaultError,
80
80
  > = InfiniteQueryObserverResult<TData, TError>
81
81
 
82
82
  export interface UseMutationOptions<
83
83
  TData = unknown,
84
- TError = RegisteredError,
84
+ TError = DefaultError,
85
85
  TVariables = void,
86
86
  TContext = unknown,
87
87
  > extends Omit<
@@ -91,7 +91,7 @@ export interface UseMutationOptions<
91
91
 
92
92
  export type UseMutateFunction<
93
93
  TData = unknown,
94
- TError = RegisteredError,
94
+ TError = DefaultError,
95
95
  TVariables = void,
96
96
  TContext = unknown,
97
97
  > = (
@@ -100,14 +100,14 @@ export type UseMutateFunction<
100
100
 
101
101
  export type UseMutateAsyncFunction<
102
102
  TData = unknown,
103
- TError = RegisteredError,
103
+ TError = DefaultError,
104
104
  TVariables = void,
105
105
  TContext = unknown,
106
106
  > = MutateFunction<TData, TError, TVariables, TContext>
107
107
 
108
108
  export type UseBaseMutationResult<
109
109
  TData = unknown,
110
- TError = RegisteredError,
110
+ TError = DefaultError,
111
111
  TVariables = unknown,
112
112
  TContext = unknown,
113
113
  > = Override<
@@ -117,7 +117,7 @@ export type UseBaseMutationResult<
117
117
 
118
118
  export type UseMutationResult<
119
119
  TData = unknown,
120
- TError = RegisteredError,
120
+ TError = DefaultError,
121
121
  TVariables = unknown,
122
122
  TContext = unknown,
123
123
  > = UseBaseMutationResult<TData, TError, TVariables, TContext>
@@ -1,3 +1,4 @@
1
+ 'use client'
1
2
  import * as React from 'react'
2
3
 
3
4
  import type { QueryClient, QueryKey, QueryObserver } from '@tanstack/query-core'
@@ -1,8 +1,9 @@
1
+ 'use client'
1
2
  import type {
2
3
  QueryObserver,
3
4
  QueryKey,
4
5
  QueryClient,
5
- RegisteredError,
6
+ DefaultError,
6
7
  InfiniteData,
7
8
  } from '@tanstack/query-core'
8
9
  import { InfiniteQueryObserver } from '@tanstack/query-core'
@@ -12,7 +13,7 @@ import { useBaseQuery } from './useBaseQuery'
12
13
  // HOOK
13
14
  export function useInfiniteQuery<
14
15
  TQueryFnData,
15
- TError = RegisteredError,
16
+ TError = DefaultError,
16
17
  TData = InfiniteData<TQueryFnData>,
17
18
  TQueryKey extends QueryKey = QueryKey,
18
19
  TPageParam = unknown,
@@ -1,3 +1,4 @@
1
+ 'use client'
1
2
  import * as React from 'react'
2
3
  import type { QueryClient, QueryFilters } from '@tanstack/query-core'
3
4
  import { notifyManager } from '@tanstack/query-core'
@@ -1,5 +1,6 @@
1
+ 'use client'
1
2
  import * as React from 'react'
2
- import type { QueryClient, RegisteredError } from '@tanstack/query-core'
3
+ import type { QueryClient, DefaultError } from '@tanstack/query-core'
3
4
  import { notifyManager, MutationObserver } from '@tanstack/query-core'
4
5
  import { useQueryClient } from './QueryClientProvider'
5
6
  import type {
@@ -13,7 +14,7 @@ import { shouldThrowError } from './utils'
13
14
 
14
15
  export function useMutation<
15
16
  TData = unknown,
16
- TError = RegisteredError,
17
+ TError = DefaultError,
17
18
  TVariables = void,
18
19
  TContext = unknown,
19
20
  >(
@@ -1,3 +1,4 @@
1
+ 'use client'
1
2
  import * as React from 'react'
2
3
 
3
4
  import type {
@@ -5,11 +6,11 @@ import type {
5
6
  QueryClient,
6
7
  Mutation,
7
8
  MutationCache,
8
- RegisteredError,
9
+ DefaultError,
10
+ MutationState,
9
11
  } from '@tanstack/query-core'
10
12
  import { notifyManager, replaceEqualDeep } from '@tanstack/query-core'
11
13
  import { useQueryClient } from './QueryClientProvider'
12
- import type { MutationState } from '@tanstack/query-core/build/lib/mutation'
13
14
 
14
15
  export function useIsMutating(
15
16
  filters?: MutationFilters,
@@ -22,10 +23,10 @@ export function useIsMutating(
22
23
  ).length
23
24
  }
24
25
 
25
- type MutationStateOptions<TResult> = {
26
+ type MutationStateOptions<TResult = MutationState> = {
26
27
  filters?: MutationFilters
27
28
  select?: (
28
- mutation: Mutation<unknown, RegisteredError, unknown, unknown>,
29
+ mutation: Mutation<unknown, DefaultError, unknown, unknown>,
29
30
  ) => TResult
30
31
  }
31
32
 
@@ -39,13 +40,13 @@ function getResult<TResult = MutationState>(
39
40
  (mutation): TResult =>
40
41
  (options.select
41
42
  ? options.select(
42
- mutation as Mutation<unknown, RegisteredError, unknown, unknown>,
43
+ mutation as Mutation<unknown, DefaultError, unknown, unknown>,
43
44
  )
44
45
  : mutation.state) as TResult,
45
46
  )
46
47
  }
47
48
 
48
- export function useMutationState<TResult = unknown>(
49
+ export function useMutationState<TResult = MutationState>(
49
50
  options: MutationStateOptions<TResult> = {},
50
51
  queryClient?: QueryClient,
51
52
  ): Array<TResult> {
package/src/useQueries.ts CHANGED
@@ -1,3 +1,4 @@
1
+ 'use client'
1
2
  import * as React from 'react'
2
3
 
3
4
  import type {
@@ -5,7 +6,7 @@ import type {
5
6
  QueryFunction,
6
7
  QueriesPlaceholderDataFunction,
7
8
  QueryClient,
8
- RegisteredError,
9
+ DefaultError,
9
10
  } from '@tanstack/query-core'
10
11
  import { notifyManager, QueriesObserver } from '@tanstack/query-core'
11
12
  import { useQueryClient } from './QueryClientProvider'
@@ -28,7 +29,7 @@ import {
28
29
  // `placeholderData` function does not have a parameter
29
30
  type UseQueryOptionsForUseQueries<
30
31
  TQueryFnData = unknown,
31
- TError = RegisteredError,
32
+ TError = DefaultError,
32
33
  TData = TQueryFnData,
33
34
  TQueryKey extends QueryKey = QueryKey,
34
35
  > = Omit<
@@ -150,18 +151,19 @@ export type QueriesResults<
150
151
  ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
151
152
  UseQueryResult<
152
153
  unknown extends TData ? TQueryFnData : TData,
153
- unknown extends TError ? RegisteredError : TError
154
+ unknown extends TError ? DefaultError : TError
154
155
  >[]
155
156
  : // Fallback
156
157
  UseQueryResult[]
157
158
 
158
- export function useQueries<T extends any[]>({
159
- queries,
160
- queryClient,
161
- }: {
162
- queries: readonly [...QueriesOptions<T>]
163
- queryClient?: QueryClient
164
- }): QueriesResults<T> {
159
+ export function useQueries<T extends any[]>(
160
+ {
161
+ queries,
162
+ }: {
163
+ queries: readonly [...QueriesOptions<T>]
164
+ },
165
+ queryClient?: QueryClient,
166
+ ): QueriesResults<T> {
165
167
  const client = useQueryClient(queryClient)
166
168
  const isRestoring = useIsRestoring()
167
169
 
package/src/useQuery.ts CHANGED
@@ -1,8 +1,5 @@
1
- import type {
2
- QueryClient,
3
- QueryKey,
4
- RegisteredError,
5
- } from '@tanstack/query-core'
1
+ 'use client'
2
+ import type { QueryClient, QueryKey, DefaultError } from '@tanstack/query-core'
6
3
  import { QueryObserver } from '@tanstack/query-core'
7
4
  import type {
8
5
  DefinedUseQueryResult,
@@ -14,7 +11,7 @@ import { useBaseQuery } from './useBaseQuery'
14
11
  // HOOK
15
12
  type UndefinedInitialDataOptions<
16
13
  TQueryFnData = unknown,
17
- TError = RegisteredError,
14
+ TError = DefaultError,
18
15
  TData = TQueryFnData,
19
16
  TQueryKey extends QueryKey = QueryKey,
20
17
  > = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
@@ -23,7 +20,7 @@ type UndefinedInitialDataOptions<
23
20
 
24
21
  type DefinedInitialDataOptions<
25
22
  TQueryFnData = unknown,
26
- TError = RegisteredError,
23
+ TError = DefaultError,
27
24
  TData = TQueryFnData,
28
25
  TQueryKey extends QueryKey = QueryKey,
29
26
  > = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
@@ -32,7 +29,7 @@ type DefinedInitialDataOptions<
32
29
 
33
30
  export function useQuery<
34
31
  TQueryFnData = unknown,
35
- TError = RegisteredError,
32
+ TError = DefaultError,
36
33
  TData = TQueryFnData,
37
34
  TQueryKey extends QueryKey = QueryKey,
38
35
  >(
@@ -42,7 +39,7 @@ export function useQuery<
42
39
 
43
40
  export function useQuery<
44
41
  TQueryFnData = unknown,
45
- TError = RegisteredError,
42
+ TError = DefaultError,
46
43
  TData = TQueryFnData,
47
44
  TQueryKey extends QueryKey = QueryKey,
48
45
  >(
@@ -52,7 +49,7 @@ export function useQuery<
52
49
 
53
50
  export function useQuery<
54
51
  TQueryFnData = unknown,
55
- TError = RegisteredError,
52
+ TError = DefaultError,
56
53
  TData = TQueryFnData,
57
54
  TQueryKey extends QueryKey = QueryKey,
58
55
  >(