@tanstack/solid-query 4.4.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 (108) hide show
  1. package/build/lib/QueryClientProvider.d.ts +24 -0
  2. package/build/lib/QueryClientProvider.esm.js +68 -0
  3. package/build/lib/QueryClientProvider.esm.js.map +1 -0
  4. package/build/lib/QueryClientProvider.js +74 -0
  5. package/build/lib/QueryClientProvider.js.map +1 -0
  6. package/build/lib/QueryClientProvider.mjs +68 -0
  7. package/build/lib/QueryClientProvider.mjs.map +1 -0
  8. package/build/lib/createBaseQuery.d.ts +4 -0
  9. package/build/lib/createBaseQuery.esm.js +77 -0
  10. package/build/lib/createBaseQuery.esm.js.map +1 -0
  11. package/build/lib/createBaseQuery.js +81 -0
  12. package/build/lib/createBaseQuery.js.map +1 -0
  13. package/build/lib/createBaseQuery.mjs +77 -0
  14. package/build/lib/createBaseQuery.mjs.map +1 -0
  15. package/build/lib/createInfiniteQuery.d.ts +5 -0
  16. package/build/lib/createInfiniteQuery.esm.js +20 -0
  17. package/build/lib/createInfiniteQuery.esm.js.map +1 -0
  18. package/build/lib/createInfiniteQuery.js +24 -0
  19. package/build/lib/createInfiniteQuery.js.map +1 -0
  20. package/build/lib/createInfiniteQuery.mjs +20 -0
  21. package/build/lib/createInfiniteQuery.mjs.map +1 -0
  22. package/build/lib/createMutation.d.ts +6 -0
  23. package/build/lib/createMutation.esm.js +45 -0
  24. package/build/lib/createMutation.esm.js.map +1 -0
  25. package/build/lib/createMutation.js +49 -0
  26. package/build/lib/createMutation.js.map +1 -0
  27. package/build/lib/createMutation.mjs +45 -0
  28. package/build/lib/createMutation.mjs.map +1 -0
  29. package/build/lib/createQueries.d.ts +49 -0
  30. package/build/lib/createQueries.esm.js +54 -0
  31. package/build/lib/createQueries.esm.js.map +1 -0
  32. package/build/lib/createQueries.js +58 -0
  33. package/build/lib/createQueries.js.map +1 -0
  34. package/build/lib/createQueries.mjs +54 -0
  35. package/build/lib/createQueries.mjs.map +1 -0
  36. package/build/lib/createQuery.d.ts +23 -0
  37. package/build/lib/createQuery.esm.js +25 -0
  38. package/build/lib/createQuery.esm.js.map +1 -0
  39. package/build/lib/createQuery.js +29 -0
  40. package/build/lib/createQuery.js.map +1 -0
  41. package/build/lib/createQuery.mjs +25 -0
  42. package/build/lib/createQuery.mjs.map +1 -0
  43. package/build/lib/index.d.ts +10 -0
  44. package/build/lib/index.esm.js +9 -0
  45. package/build/lib/index.esm.js.map +1 -0
  46. package/build/lib/index.js +31 -0
  47. package/build/lib/index.js.map +1 -0
  48. package/build/lib/index.mjs +9 -0
  49. package/build/lib/index.mjs.map +1 -0
  50. package/build/lib/types.d.ts +47 -0
  51. package/build/lib/useIsFetching.d.ts +7 -0
  52. package/build/lib/useIsFetching.esm.js +29 -0
  53. package/build/lib/useIsFetching.esm.js.map +1 -0
  54. package/build/lib/useIsFetching.js +33 -0
  55. package/build/lib/useIsFetching.js.map +1 -0
  56. package/build/lib/useIsFetching.mjs +29 -0
  57. package/build/lib/useIsFetching.mjs.map +1 -0
  58. package/build/lib/useIsMutating.d.ts +8 -0
  59. package/build/lib/useIsMutating.esm.js +22 -0
  60. package/build/lib/useIsMutating.esm.js.map +1 -0
  61. package/build/lib/useIsMutating.js +26 -0
  62. package/build/lib/useIsMutating.js.map +1 -0
  63. package/build/lib/useIsMutating.mjs +22 -0
  64. package/build/lib/useIsMutating.mjs.map +1 -0
  65. package/build/lib/utils.d.ts +14 -0
  66. package/build/lib/utils.esm.js +63 -0
  67. package/build/lib/utils.esm.js.map +1 -0
  68. package/build/lib/utils.js +72 -0
  69. package/build/lib/utils.js.map +1 -0
  70. package/build/lib/utils.mjs +63 -0
  71. package/build/lib/utils.mjs.map +1 -0
  72. package/build/solid/QueryClientProvider.jsx +42 -0
  73. package/build/solid/createBaseQuery.js +69 -0
  74. package/build/solid/createInfiniteQuery.js +16 -0
  75. package/build/solid/createMutation.js +40 -0
  76. package/build/solid/createQueries.js +39 -0
  77. package/build/solid/createQuery.js +16 -0
  78. package/build/solid/index.js +11 -0
  79. package/build/solid/types.js +1 -0
  80. package/build/solid/useIsFetching.js +23 -0
  81. package/build/solid/useIsMutating.js +16 -0
  82. package/build/solid/utils.js +45 -0
  83. package/build/umd/index.development.js +3467 -0
  84. package/build/umd/index.development.js.map +1 -0
  85. package/build/umd/index.production.js +2 -0
  86. package/build/umd/index.production.js.map +1 -0
  87. package/package.json +52 -0
  88. package/src/QueryClientProvider.tsx +100 -0
  89. package/src/__tests__/QueryClientProvider.test.tsx +267 -0
  90. package/src/__tests__/createInfiniteQuery.test.tsx +1889 -0
  91. package/src/__tests__/createMutation.test.tsx +1205 -0
  92. package/src/__tests__/createQueries.test.tsx +1163 -0
  93. package/src/__tests__/createQuery.test.tsx +6487 -0
  94. package/src/__tests__/createQuery.types.test.tsx +160 -0
  95. package/src/__tests__/suspense.test.tsx +1093 -0
  96. package/src/__tests__/useIsFetching.test.tsx +298 -0
  97. package/src/__tests__/useIsMutating.test.tsx +301 -0
  98. package/src/__tests__/utils.tsx +75 -0
  99. package/src/createBaseQuery.ts +121 -0
  100. package/src/createInfiniteQuery.ts +116 -0
  101. package/src/createMutation.ts +131 -0
  102. package/src/createQueries.ts +203 -0
  103. package/src/createQuery.ts +157 -0
  104. package/src/index.ts +17 -0
  105. package/src/types.ts +167 -0
  106. package/src/useIsFetching.ts +58 -0
  107. package/src/useIsMutating.ts +42 -0
  108. package/src/utils.ts +85 -0
@@ -0,0 +1,1163 @@
1
+ import { fireEvent, render, screen, waitFor } from 'solid-testing-library'
2
+
3
+ import * as QueriesObserverModule from '../../../query-core/src/queriesObserver'
4
+
5
+ import type { QueryFunctionContext } from '@tanstack/query-core'
6
+ import {
7
+ createContext,
8
+ createMemo,
9
+ createRenderEffect,
10
+ createSignal,
11
+ ErrorBoundary,
12
+ } from 'solid-js'
13
+ import type {
14
+ CreateQueryOptions,
15
+ CreateQueryResult,
16
+ QueryClient,
17
+ QueryFunction,
18
+ QueryObserverResult,
19
+ SolidQueryKey,
20
+ } from '..'
21
+ import {
22
+ createQueries,
23
+ QueriesObserver,
24
+ QueryCache,
25
+ QueryClientProvider,
26
+ } from '..'
27
+ import {
28
+ createQueryClient,
29
+ expectType,
30
+ expectTypeNotAny,
31
+ queryKey,
32
+ sleep,
33
+ } from './utils'
34
+
35
+ describe('useQueries', () => {
36
+ const queryCache = new QueryCache()
37
+ const queryClient = createQueryClient({ queryCache })
38
+
39
+ it('should return the correct states', async () => {
40
+ const key1 = queryKey()
41
+ const key2 = queryKey()
42
+ const results: CreateQueryResult[][] = []
43
+
44
+ function Page() {
45
+ const result = createQueries({
46
+ queries: [
47
+ {
48
+ queryKey: key1,
49
+ queryFn: async () => {
50
+ await sleep(10)
51
+ return 1
52
+ },
53
+ },
54
+ {
55
+ queryKey: key2,
56
+ queryFn: async () => {
57
+ await sleep(100)
58
+ return 2
59
+ },
60
+ },
61
+ ],
62
+ })
63
+
64
+ createRenderEffect(() => {
65
+ results.push([...result])
66
+ })
67
+
68
+ return (
69
+ <div>
70
+ <div>
71
+ data1: {String(result[0].data ?? 'null')}, data2:{' '}
72
+ {String(result[1].data ?? 'null')}
73
+ </div>
74
+ </div>
75
+ )
76
+ }
77
+
78
+ render(() => (
79
+ <QueryClientProvider client={queryClient}>
80
+ <Page />
81
+ </QueryClientProvider>
82
+ ))
83
+
84
+ await waitFor(() => screen.getByText('data1: 1, data2: 2'))
85
+
86
+ expect(results.length).toBe(3)
87
+ expect(results[0]).toMatchObject([{ data: undefined }, { data: undefined }])
88
+ expect(results[1]).toMatchObject([{ data: 1 }, { data: undefined }])
89
+ expect(results[2]).toMatchObject([{ data: 1 }, { data: 2 }])
90
+ })
91
+
92
+ it('should keep previous data if amount of queries is the same', async () => {
93
+ const key1 = queryKey()
94
+ const key2 = queryKey()
95
+ const states: CreateQueryResult[][] = []
96
+
97
+ function Page() {
98
+ const [count, setCount] = createSignal(1)
99
+ const result = createQueries({
100
+ queries: [
101
+ {
102
+ queryKey: () => [key1(), count()],
103
+ keepPreviousData: true,
104
+ queryFn: async () => {
105
+ await sleep(10)
106
+ return count() * 2
107
+ },
108
+ },
109
+ {
110
+ queryKey: () => [key2(), count()],
111
+ keepPreviousData: true,
112
+ queryFn: async () => {
113
+ await sleep(35)
114
+ return count() * 5
115
+ },
116
+ },
117
+ ],
118
+ })
119
+
120
+ createRenderEffect(() => {
121
+ states.push([...result])
122
+ })
123
+
124
+ const isFetching = createMemo(() => result.some((r) => r.isFetching))
125
+
126
+ return (
127
+ <div>
128
+ <div>
129
+ data1: {String(result[0].data ?? 'null')}, data2:{' '}
130
+ {String(result[1].data ?? 'null')}
131
+ </div>
132
+ <div>isFetching: {String(isFetching())}</div>
133
+ <button onClick={() => setCount((prev) => prev + 1)}>inc</button>
134
+ </div>
135
+ )
136
+ }
137
+
138
+ render(() => (
139
+ <QueryClientProvider client={queryClient}>
140
+ <Page />
141
+ </QueryClientProvider>
142
+ ))
143
+
144
+ await waitFor(() => screen.getByText('data1: 2, data2: 5'))
145
+ fireEvent.click(screen.getByRole('button', { name: /inc/i }))
146
+
147
+ await waitFor(() => screen.getByText('data1: 4, data2: 10'))
148
+ await waitFor(() => screen.getByText('isFetching: false'))
149
+
150
+ expect(states[states.length - 1]).toMatchObject([
151
+ { status: 'success', data: 4, isPreviousData: false, isFetching: false },
152
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
153
+ ])
154
+ })
155
+
156
+ it('should keep previous data for variable amounts of useQueries', async () => {
157
+ const key = queryKey()
158
+ const states: CreateQueryResult[][] = []
159
+
160
+ function Page() {
161
+ const [count, setCount] = createSignal(2)
162
+ const result = createQueries({
163
+ // TODO(lukemurray): reactive queries doesn't appear to work
164
+ get queries() {
165
+ return Array.from({ length: count() }, (_, i) => ({
166
+ queryKey: () => [key(), count(), i + 1],
167
+ keepPreviousData: true,
168
+ queryFn: async () => {
169
+ await sleep(35 * (i + 1))
170
+ return (i + 1) * count() * 2
171
+ },
172
+ }))
173
+ },
174
+ })
175
+
176
+ createRenderEffect(() => {
177
+ states.push([...result])
178
+ })
179
+
180
+ const isFetching = createMemo(() => result.some((r) => r.isFetching))
181
+
182
+ return (
183
+ <div>
184
+ <div>data: {result.map((it) => it.data).join(',')}</div>
185
+ <div>isFetching: {String(isFetching())}</div>
186
+ <button onClick={() => setCount((prev) => prev + 1)}>inc</button>
187
+ </div>
188
+ )
189
+ }
190
+
191
+ render(() => (
192
+ <QueryClientProvider client={queryClient}>
193
+ <Page />
194
+ </QueryClientProvider>
195
+ ))
196
+
197
+ await waitFor(() => screen.getByText('data: 4,8'))
198
+ fireEvent.click(screen.getByRole('button', { name: /inc/i }))
199
+
200
+ await waitFor(() => screen.getByText('data: 6,12,18'))
201
+ await waitFor(() => screen.getByText('isFetching: false'))
202
+
203
+ expect(states[states.length - 1]).toMatchObject([
204
+ { status: 'success', data: 6, isPreviousData: false, isFetching: false },
205
+ { status: 'success', data: 12, isPreviousData: false, isFetching: false },
206
+ { status: 'success', data: 18, isPreviousData: false, isFetching: false },
207
+ ])
208
+ })
209
+
210
+ it('should keep previous data when switching between queries', async () => {
211
+ const key = queryKey()
212
+ const states: CreateQueryResult[][] = []
213
+
214
+ function Page() {
215
+ const [series1, setSeries1] = createSignal(1)
216
+ const [series2, setSeries2] = createSignal(2)
217
+ const ids = [series1, series2]
218
+
219
+ const result = createQueries({
220
+ queries: ids.map((id) => {
221
+ return {
222
+ queryKey: () => [key(), id()],
223
+ queryFn: async () => {
224
+ await sleep(5)
225
+ return id() * 5
226
+ },
227
+ keepPreviousData: true,
228
+ }
229
+ }),
230
+ })
231
+
232
+ createRenderEffect(() => {
233
+ states.push([...result])
234
+ })
235
+
236
+ const isFetching = createMemo(() => result.some((r) => r.isFetching))
237
+
238
+ return (
239
+ <div>
240
+ <div>
241
+ data1: {String(result[0]?.data ?? 'null')}, data2:{' '}
242
+ {String(result[1]?.data ?? 'null')}
243
+ </div>
244
+ <div>isFetching: {String(isFetching())}</div>
245
+ <button onClick={() => setSeries2(3)}>setSeries2</button>
246
+ <button onClick={() => setSeries1(2)}>setSeries1</button>
247
+ </div>
248
+ )
249
+ }
250
+
251
+ render(() => (
252
+ <QueryClientProvider client={queryClient}>
253
+ <Page />
254
+ </QueryClientProvider>
255
+ ))
256
+
257
+ await waitFor(() => screen.getByText('data1: 5, data2: 10'))
258
+ fireEvent.click(screen.getByRole('button', { name: /setSeries2/i }))
259
+
260
+ await waitFor(() => screen.getByText('data1: 5, data2: 15'))
261
+ fireEvent.click(screen.getByRole('button', { name: /setSeries1/i }))
262
+
263
+ await waitFor(() => screen.getByText('data1: 10, data2: 15'))
264
+ await waitFor(() => screen.getByText('isFetching: false'))
265
+
266
+ expect(states[states.length - 1]).toMatchObject([
267
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
268
+ { status: 'success', data: 15, isPreviousData: false, isFetching: false },
269
+ ])
270
+ })
271
+
272
+ it('should not go to infinite render loop with previous data when toggling queries', async () => {
273
+ const key = queryKey()
274
+ const states: CreateQueryResult[][] = []
275
+
276
+ function Page() {
277
+ const [enableId1, setEnableId1] = createSignal(true)
278
+ const ids = createMemo(() => (enableId1() ? [1, 2] : [2]))
279
+
280
+ const result = createQueries({
281
+ // TODO(lukemurray): same issue queries should be reactive
282
+ get queries() {
283
+ return ids().map((id) => {
284
+ return {
285
+ queryKey: () => [key(), id],
286
+ queryFn: async () => {
287
+ await sleep(5)
288
+ return id * 5
289
+ },
290
+ keepPreviousData: true,
291
+ }
292
+ })
293
+ },
294
+ })
295
+
296
+ createRenderEffect(() => {
297
+ states.push([...result])
298
+ })
299
+
300
+ const text = createMemo(() => {
301
+ return result
302
+ .map((r, idx) => `data${idx + 1}: ${r.data ?? 'null'}`)
303
+ .join(' ')
304
+ })
305
+
306
+ const isFetching = createMemo(() => result.some((r) => r.isFetching))
307
+
308
+ return (
309
+ <div>
310
+ <div>{text()}</div>
311
+ <div>isFetching: {String(isFetching())}</div>
312
+ <button onClick={() => setEnableId1(false)}>set1Disabled</button>
313
+ <button onClick={() => setEnableId1(true)}>set2Enabled</button>
314
+ </div>
315
+ )
316
+ }
317
+
318
+ render(() => (
319
+ <QueryClientProvider client={queryClient}>
320
+ <Page />
321
+ </QueryClientProvider>
322
+ ))
323
+
324
+ await waitFor(() => screen.getByText('data1: 5 data2: 10'))
325
+ fireEvent.click(screen.getByRole('button', { name: /set1Disabled/i }))
326
+
327
+ await waitFor(() => screen.getByText('data1: 10'))
328
+ await waitFor(() => screen.getByText('isFetching: false'))
329
+ fireEvent.click(screen.getByRole('button', { name: /set2Enabled/i }))
330
+
331
+ await waitFor(() => screen.getByText('data1: 5 data2: 10'))
332
+ await waitFor(() => screen.getByText('isFetching: false'))
333
+
334
+ await waitFor(() => expect(states.length).toBe(5))
335
+
336
+ expect(states[0]).toMatchObject([
337
+ {
338
+ status: 'loading',
339
+ data: undefined,
340
+ isPreviousData: false,
341
+ isFetching: true,
342
+ },
343
+ {
344
+ status: 'loading',
345
+ data: undefined,
346
+ isPreviousData: false,
347
+ isFetching: true,
348
+ },
349
+ ])
350
+ expect(states[1]).toMatchObject([
351
+ { status: 'success', data: 5, isPreviousData: false, isFetching: false },
352
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
353
+ ])
354
+ expect(states[2]).toMatchObject([
355
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
356
+ ])
357
+ expect(states[3]).toMatchObject([
358
+ { status: 'success', data: 5, isPreviousData: false, isFetching: true },
359
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
360
+ ])
361
+ expect(states[4]).toMatchObject([
362
+ { status: 'success', data: 5, isPreviousData: false, isFetching: false },
363
+ { status: 'success', data: 10, isPreviousData: false, isFetching: false },
364
+ ])
365
+ })
366
+
367
+ it('handles type parameter - tuple of tuples', async () => {
368
+ const key1 = queryKey()
369
+ const key2 = queryKey()
370
+ const key3 = queryKey()
371
+
372
+ // @ts-expect-error (Page component is not rendered)
373
+ // eslint-disable-next-line
374
+ function Page() {
375
+ const result1 = createQueries<[[number], [string], [string[], boolean]]>({
376
+ queries: [
377
+ {
378
+ queryKey: key1,
379
+ queryFn: () => 1,
380
+ },
381
+ {
382
+ queryKey: key2,
383
+ queryFn: () => 'string',
384
+ },
385
+ {
386
+ queryKey: key3,
387
+ queryFn: () => ['string[]'],
388
+ },
389
+ ],
390
+ })
391
+ expectType<QueryObserverResult<number, unknown>>(result1[0])
392
+ expectType<QueryObserverResult<string, unknown>>(result1[1])
393
+ expectType<QueryObserverResult<string[], boolean>>(result1[2])
394
+ expectType<number | undefined>(result1[0].data)
395
+ expectType<string | undefined>(result1[1].data)
396
+ expectType<string[] | undefined>(result1[2].data)
397
+ expectType<boolean | null>(result1[2].error)
398
+
399
+ // TData (3rd element) takes precedence over TQueryFnData (1st element)
400
+ const result2 = createQueries<
401
+ [[string, unknown, string], [string, unknown, number]]
402
+ >({
403
+ queries: [
404
+ {
405
+ queryKey: key1,
406
+ queryFn: () => 'string',
407
+ select: (a) => {
408
+ expectType<string>(a)
409
+ expectTypeNotAny(a)
410
+ return a.toLowerCase()
411
+ },
412
+ },
413
+ {
414
+ queryKey: key2,
415
+ queryFn: () => 'string',
416
+ select: (a) => {
417
+ expectType<string>(a)
418
+ expectTypeNotAny(a)
419
+ return parseInt(a)
420
+ },
421
+ },
422
+ ],
423
+ })
424
+ expectType<QueryObserverResult<string, unknown>>(result2[0])
425
+ expectType<QueryObserverResult<number, unknown>>(result2[1])
426
+ expectType<string | undefined>(result2[0].data)
427
+ expectType<number | undefined>(result2[1].data)
428
+
429
+ // types should be enforced
430
+ createQueries<[[string, unknown, string], [string, boolean, number]]>({
431
+ queries: [
432
+ {
433
+ queryKey: key1,
434
+ queryFn: () => 'string',
435
+ select: (a) => {
436
+ expectType<string>(a)
437
+ expectTypeNotAny(a)
438
+ return a.toLowerCase()
439
+ },
440
+ onSuccess: (a) => {
441
+ expectType<string>(a)
442
+ expectTypeNotAny(a)
443
+ },
444
+ placeholderData: 'string',
445
+ // @ts-expect-error (initialData: string)
446
+ initialData: 123,
447
+ },
448
+ {
449
+ queryKey: key2,
450
+ queryFn: () => 'string',
451
+ select: (a) => {
452
+ expectType<string>(a)
453
+ expectTypeNotAny(a)
454
+ return parseInt(a)
455
+ },
456
+ onSuccess: (a) => {
457
+ expectType<number>(a)
458
+ expectTypeNotAny(a)
459
+ },
460
+ onError: (e) => {
461
+ expectType<boolean>(e)
462
+ expectTypeNotAny(e)
463
+ },
464
+ placeholderData: 'string',
465
+ // @ts-expect-error (initialData: string)
466
+ initialData: 123,
467
+ },
468
+ ],
469
+ })
470
+
471
+ // field names should be enforced
472
+ createQueries<[[string]]>({
473
+ queries: [
474
+ {
475
+ queryKey: key1,
476
+ queryFn: () => 'string',
477
+ // @ts-expect-error (invalidField)
478
+ someInvalidField: [],
479
+ },
480
+ ],
481
+ })
482
+ }
483
+ })
484
+
485
+ it('handles type parameter - tuple of objects', async () => {
486
+ const key1 = queryKey()
487
+ const key2 = queryKey()
488
+ const key3 = queryKey()
489
+
490
+ // @ts-expect-error (Page component is not rendered)
491
+ // eslint-disable-next-line
492
+ function Page() {
493
+ const result1 = createQueries<
494
+ [
495
+ { queryFnData: number },
496
+ { queryFnData: string },
497
+ { queryFnData: string[]; error: boolean },
498
+ ]
499
+ >({
500
+ queries: [
501
+ {
502
+ queryKey: key1,
503
+ queryFn: () => 1,
504
+ },
505
+ {
506
+ queryKey: key2,
507
+ queryFn: () => 'string',
508
+ },
509
+ {
510
+ queryKey: key3,
511
+ queryFn: () => ['string[]'],
512
+ },
513
+ ],
514
+ })
515
+ expectType<QueryObserverResult<number, unknown>>(result1[0])
516
+ expectType<QueryObserverResult<string, unknown>>(result1[1])
517
+ expectType<QueryObserverResult<string[], boolean>>(result1[2])
518
+ expectType<number | undefined>(result1[0].data)
519
+ expectType<string | undefined>(result1[1].data)
520
+ expectType<string[] | undefined>(result1[2].data)
521
+ expectType<boolean | null>(result1[2].error)
522
+
523
+ // TData (data prop) takes precedence over TQueryFnData (queryFnData prop)
524
+ const result2 = createQueries<
525
+ [
526
+ { queryFnData: string; data: string },
527
+ { queryFnData: string; data: number },
528
+ ]
529
+ >({
530
+ queries: [
531
+ {
532
+ queryKey: key1,
533
+ queryFn: () => 'string',
534
+ select: (a) => {
535
+ expectType<string>(a)
536
+ expectTypeNotAny(a)
537
+ return a.toLowerCase()
538
+ },
539
+ },
540
+ {
541
+ queryKey: key2,
542
+ queryFn: () => 'string',
543
+ select: (a) => {
544
+ expectType<string>(a)
545
+ expectTypeNotAny(a)
546
+ return parseInt(a)
547
+ },
548
+ },
549
+ ],
550
+ })
551
+ expectType<QueryObserverResult<string, unknown>>(result2[0])
552
+ expectType<QueryObserverResult<number, unknown>>(result2[1])
553
+ expectType<string | undefined>(result2[0].data)
554
+ expectType<number | undefined>(result2[1].data)
555
+
556
+ // can pass only TData (data prop) although TQueryFnData will be left unknown
557
+ const result3 = createQueries<[{ data: string }, { data: number }]>({
558
+ queries: [
559
+ {
560
+ queryKey: key1,
561
+ queryFn: () => 'string',
562
+ select: (a) => {
563
+ expectType<unknown>(a)
564
+ expectTypeNotAny(a)
565
+ return a as string
566
+ },
567
+ },
568
+ {
569
+ queryKey: key2,
570
+ queryFn: () => 'string',
571
+ select: (a) => {
572
+ expectType<unknown>(a)
573
+ expectTypeNotAny(a)
574
+ return a as number
575
+ },
576
+ },
577
+ ],
578
+ })
579
+ expectType<QueryObserverResult<string, unknown>>(result3[0])
580
+ expectType<QueryObserverResult<number, unknown>>(result3[1])
581
+ expectType<string | undefined>(result3[0].data)
582
+ expectType<number | undefined>(result3[1].data)
583
+
584
+ // types should be enforced
585
+ createQueries<
586
+ [
587
+ { queryFnData: string; data: string },
588
+ { queryFnData: string; data: number; error: boolean },
589
+ ]
590
+ >({
591
+ queries: [
592
+ {
593
+ queryKey: key1,
594
+ queryFn: () => 'string',
595
+ select: (a) => {
596
+ expectType<string>(a)
597
+ expectTypeNotAny(a)
598
+ return a.toLowerCase()
599
+ },
600
+ onSuccess: (a) => {
601
+ expectType<string>(a)
602
+ expectTypeNotAny(a)
603
+ },
604
+ placeholderData: 'string',
605
+ // @ts-expect-error (initialData: string)
606
+ initialData: 123,
607
+ },
608
+ {
609
+ queryKey: key2,
610
+ queryFn: () => 'string',
611
+ select: (a) => {
612
+ expectType<string>(a)
613
+ expectTypeNotAny(a)
614
+ return parseInt(a)
615
+ },
616
+ onSuccess: (a) => {
617
+ expectType<number>(a)
618
+ expectTypeNotAny(a)
619
+ },
620
+ onError: (e) => {
621
+ expectType<boolean>(e)
622
+ expectTypeNotAny(e)
623
+ },
624
+ placeholderData: 'string',
625
+ // @ts-expect-error (initialData: string)
626
+ initialData: 123,
627
+ },
628
+ ],
629
+ })
630
+
631
+ // field names should be enforced
632
+ createQueries<[{ queryFnData: string }]>({
633
+ queries: [
634
+ {
635
+ queryKey: key1,
636
+ queryFn: () => 'string',
637
+ // @ts-expect-error (invalidField)
638
+ someInvalidField: [],
639
+ },
640
+ ],
641
+ })
642
+ }
643
+ })
644
+
645
+ it('handles array literal without type parameter to infer result type', async () => {
646
+ const key1 = queryKey()
647
+ const key2 = queryKey()
648
+ const key3 = queryKey()
649
+ const key4 = queryKey()
650
+
651
+ // @ts-expect-error (Page component is not rendered)
652
+ // eslint-disable-next-line
653
+ function Page() {
654
+ // Array.map preserves TQueryFnData
655
+ const result1 = createQueries({
656
+ queries: Array(50).map((_, i) => ({
657
+ queryKey: () => ['key', i] as const,
658
+ queryFn: () => i + 10,
659
+ })),
660
+ })
661
+ expectType<QueryObserverResult<number, unknown>[]>(result1)
662
+ expectType<number | undefined>(result1[0]?.data)
663
+
664
+ // Array.map preserves TData
665
+ const result2 = createQueries({
666
+ queries: Array(50).map((_, i) => ({
667
+ queryKey: () => ['key', i] as const,
668
+ queryFn: () => i + 10,
669
+ select: (data: number) => data.toString(),
670
+ })),
671
+ })
672
+ expectType<QueryObserverResult<string, unknown>[]>(result2)
673
+
674
+ const result3 = createQueries({
675
+ queries: [
676
+ {
677
+ queryKey: key1,
678
+ queryFn: () => 1,
679
+ },
680
+ {
681
+ queryKey: key2,
682
+ queryFn: () => 'string',
683
+ },
684
+ {
685
+ queryKey: key3,
686
+ queryFn: () => ['string[]'],
687
+ select: () => 123,
688
+ },
689
+ ],
690
+ })
691
+ expectType<QueryObserverResult<number, unknown>>(result3[0])
692
+ expectType<QueryObserverResult<string, unknown>>(result3[1])
693
+ expectType<QueryObserverResult<number, unknown>>(result3[2])
694
+ expectType<number | undefined>(result3[0].data)
695
+ expectType<string | undefined>(result3[1].data)
696
+ // select takes precedence over queryFn
697
+ expectType<number | undefined>(result3[2].data)
698
+
699
+ // initialData/placeholderData are enforced
700
+ createQueries({
701
+ queries: [
702
+ {
703
+ queryKey: key1,
704
+ queryFn: () => 'string',
705
+ placeholderData: 'string',
706
+ // @ts-expect-error (initialData: string)
707
+ initialData: 123,
708
+ },
709
+ {
710
+ queryKey: key2,
711
+ queryFn: () => 123,
712
+ // @ts-expect-error (placeholderData: number)
713
+ placeholderData: 'string',
714
+ initialData: 123,
715
+ },
716
+ ],
717
+ })
718
+
719
+ // select / onSuccess / onSettled params are "indirectly" enforced
720
+ createQueries({
721
+ queries: [
722
+ // unfortunately TS will not suggest the type for you
723
+ {
724
+ queryKey: key1,
725
+ queryFn: () => 'string',
726
+ // @ts-expect-error (noImplicitAny)
727
+ onSuccess: (a) => null,
728
+ // @ts-expect-error (noImplicitAny)
729
+ onSettled: (a) => null,
730
+ },
731
+ // however you can add a type to the callback
732
+ {
733
+ queryKey: key2,
734
+ queryFn: () => 'string',
735
+ onSuccess: (a: string) => {
736
+ expectType<string>(a)
737
+ expectTypeNotAny(a)
738
+ },
739
+ onSettled: (a: string | undefined) => {
740
+ expectType<string | undefined>(a)
741
+ expectTypeNotAny(a)
742
+ },
743
+ },
744
+ // the type you do pass is enforced
745
+ {
746
+ queryKey: key3,
747
+ queryFn: () => 'string',
748
+ // @ts-expect-error (only accepts string)
749
+ onSuccess: (a: number) => null,
750
+ },
751
+ {
752
+ queryKey: key4,
753
+ queryFn: () => 'string',
754
+ select: (a: string) => parseInt(a),
755
+ // @ts-expect-error (select is defined => only accepts number)
756
+ onSuccess: (a: string) => null,
757
+ onSettled: (a: number | undefined) => {
758
+ expectType<number | undefined>(a)
759
+ expectTypeNotAny(a)
760
+ },
761
+ },
762
+ ],
763
+ })
764
+
765
+ // callbacks are also indirectly enforced with Array.map
766
+ createQueries({
767
+ // @ts-expect-error (onSuccess only accepts string)
768
+ queries: Array(50).map((_, i) => ({
769
+ queryKey: ['key', i] as const,
770
+ queryFn: () => i + 10,
771
+ select: (data: number) => data.toString(),
772
+ onSuccess: (_data: number) => null,
773
+ })),
774
+ })
775
+ createQueries({
776
+ queries: Array(50).map((_, i) => ({
777
+ queryKey: () => ['key', i] as const,
778
+ queryFn: () => i + 10,
779
+ select: (data: number) => data.toString(),
780
+ onSuccess: (_data: string) => null,
781
+ })),
782
+ })
783
+
784
+ // results inference works when all the handlers are defined
785
+ const result4 = createQueries({
786
+ queries: [
787
+ {
788
+ queryKey: key1,
789
+ queryFn: () => 'string',
790
+ // @ts-expect-error (noImplicitAny)
791
+ onSuccess: (a) => null,
792
+ // @ts-expect-error (noImplicitAny)
793
+ onSettled: (a) => null,
794
+ },
795
+ {
796
+ queryKey: key2,
797
+ queryFn: () => 'string',
798
+ onSuccess: (a: string) => {
799
+ expectType<string>(a)
800
+ expectTypeNotAny(a)
801
+ },
802
+ onSettled: (a: string | undefined) => {
803
+ expectType<string | undefined>(a)
804
+ expectTypeNotAny(a)
805
+ },
806
+ },
807
+ {
808
+ queryKey: key4,
809
+ queryFn: () => 'string',
810
+ select: (a: string) => parseInt(a),
811
+ onSuccess: (_a: number) => null,
812
+ onSettled: (a: number | undefined) => {
813
+ expectType<number | undefined>(a)
814
+ expectTypeNotAny(a)
815
+ },
816
+ },
817
+ ],
818
+ })
819
+ expectType<QueryObserverResult<string, unknown>>(result4[0])
820
+ expectType<QueryObserverResult<string, unknown>>(result4[1])
821
+ expectType<QueryObserverResult<number, unknown>>(result4[2])
822
+
823
+ // handles when queryFn returns a Promise
824
+ const result5 = createQueries({
825
+ queries: [
826
+ {
827
+ queryKey: key1,
828
+ queryFn: () => Promise.resolve('string'),
829
+ onSuccess: (a: string) => {
830
+ expectType<string>(a)
831
+ expectTypeNotAny(a)
832
+ },
833
+ // @ts-expect-error (refuses to accept a Promise)
834
+ onSettled: (a: Promise<string>) => null,
835
+ },
836
+ ],
837
+ })
838
+ expectType<QueryObserverResult<string, unknown>>(result5[0])
839
+
840
+ // Array as const does not throw error
841
+ const result6 = createQueries({
842
+ queries: [
843
+ {
844
+ queryKey: () => ['key1'],
845
+ queryFn: () => 'string',
846
+ },
847
+ {
848
+ queryKey: () => ['key1'],
849
+ queryFn: () => 123,
850
+ },
851
+ ],
852
+ } as const)
853
+ expectType<QueryObserverResult<string, unknown>>(result6[0])
854
+ expectType<QueryObserverResult<number, unknown>>(result6[1])
855
+
856
+ // field names should be enforced - array literal
857
+ createQueries({
858
+ queries: [
859
+ {
860
+ queryKey: key1,
861
+ queryFn: () => 'string',
862
+ // @ts-expect-error (invalidField)
863
+ someInvalidField: [],
864
+ },
865
+ ],
866
+ })
867
+
868
+ // field names should be enforced - Array.map() result
869
+ createQueries({
870
+ // @ts-expect-error (invalidField)
871
+ queries: Array(10).map(() => ({
872
+ someInvalidField: '',
873
+ })),
874
+ })
875
+
876
+ // field names should be enforced - array literal
877
+ createQueries({
878
+ queries: [
879
+ {
880
+ queryKey: key1,
881
+ queryFn: () => 'string',
882
+ // @ts-expect-error (invalidField)
883
+ someInvalidField: [],
884
+ },
885
+ ],
886
+ })
887
+
888
+ // supports queryFn using fetch() to return Promise<any> - Array.map() result
889
+ createQueries({
890
+ queries: Array(50).map((_, i) => ({
891
+ queryKey: () => ['key', i] as const,
892
+ queryFn: () =>
893
+ fetch('return Promise<any>').then((resp) => resp.json()),
894
+ })),
895
+ })
896
+
897
+ // supports queryFn using fetch() to return Promise<any> - array literal
898
+ createQueries({
899
+ queries: [
900
+ {
901
+ queryKey: key1,
902
+ queryFn: () =>
903
+ fetch('return Promise<any>').then((resp) => resp.json()),
904
+ },
905
+ ],
906
+ })
907
+ }
908
+ })
909
+
910
+ it('handles strongly typed queryFn factories and useQueries wrappers', () => {
911
+ // QueryKey + queryFn factory
912
+ type QueryKeyA = ['queryA']
913
+ const getQueryKeyA = (): QueryKeyA => ['queryA']
914
+ type GetQueryFunctionA = () => QueryFunction<number, QueryKeyA>
915
+ const getQueryFunctionA: GetQueryFunctionA = () => async () => {
916
+ return 1
917
+ }
918
+ type SelectorA = (data: number) => [number, string]
919
+ const getSelectorA = (): SelectorA => (data) => [data, data.toString()]
920
+
921
+ type QueryKeyB = ['queryB', string]
922
+ const getQueryKeyB = (id: string): QueryKeyB => ['queryB', id]
923
+ type GetQueryFunctionB = () => QueryFunction<string, QueryKeyB>
924
+ const getQueryFunctionB: GetQueryFunctionB = () => async () => {
925
+ return '1'
926
+ }
927
+ type SelectorB = (data: string) => [string, number]
928
+ const getSelectorB = (): SelectorB => (data) => [data, +data]
929
+
930
+ // Wrapper with strongly typed array-parameter
931
+ function useWrappedQueries<
932
+ TQueryFnData,
933
+ TError,
934
+ TData,
935
+ TQueryKey extends SolidQueryKey,
936
+ >(queries: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>[]) {
937
+ return createQueries({
938
+ queries: queries.map(
939
+ // no need to type the mapped query
940
+ (query) => {
941
+ const { queryFn: fn, queryKey: key, onError: err } = query
942
+ expectType<
943
+ QueryFunction<TQueryFnData, ReturnType<TQueryKey>> | undefined
944
+ >(fn)
945
+ return {
946
+ queryKey: key,
947
+ onError: err,
948
+ queryFn: fn
949
+ ? (ctx: QueryFunctionContext<ReturnType<TQueryKey>>) => {
950
+ expectType<ReturnType<TQueryKey>>(ctx.queryKey)
951
+ return fn.call({}, ctx)
952
+ }
953
+ : undefined,
954
+ }
955
+ },
956
+ ),
957
+ })
958
+ }
959
+
960
+ // @ts-expect-error (Page component is not rendered)
961
+ // eslint-disable-next-line
962
+ function Page() {
963
+ const result = createQueries({
964
+ queries: [
965
+ {
966
+ queryKey: () => getQueryKeyA(),
967
+ queryFn: getQueryFunctionA(),
968
+ },
969
+ {
970
+ queryKey: () => getQueryKeyB('id'),
971
+ queryFn: getQueryFunctionB(),
972
+ },
973
+ ],
974
+ })
975
+ expectType<QueryObserverResult<number, unknown>>(result[0])
976
+ expectType<QueryObserverResult<string, unknown>>(result[1])
977
+
978
+ const withSelector = createQueries({
979
+ queries: [
980
+ {
981
+ queryKey: () => getQueryKeyA(),
982
+ queryFn: getQueryFunctionA(),
983
+ select: getSelectorA(),
984
+ },
985
+ {
986
+ queryKey: () => getQueryKeyB('id'),
987
+ queryFn: getQueryFunctionB(),
988
+ select: getSelectorB(),
989
+ },
990
+ ],
991
+ })
992
+ expectType<QueryObserverResult<[number, string], unknown>>(
993
+ withSelector[0],
994
+ )
995
+ expectType<QueryObserverResult<[string, number], unknown>>(
996
+ withSelector[1],
997
+ )
998
+
999
+ const withWrappedQueries = useWrappedQueries(
1000
+ Array(10).map(() => ({
1001
+ queryKey: () => getQueryKeyA(),
1002
+ queryFn: getQueryFunctionA(),
1003
+ select: getSelectorA(),
1004
+ })),
1005
+ )
1006
+
1007
+ expectType<QueryObserverResult<number | undefined, unknown>[]>(
1008
+ withWrappedQueries,
1009
+ )
1010
+ }
1011
+ })
1012
+
1013
+ it('should not change state if unmounted', async () => {
1014
+ const key1 = queryKey()
1015
+
1016
+ // We have to mock the QueriesObserver to not unsubscribe
1017
+ // the listener when the component is unmounted
1018
+ class QueriesObserverMock extends QueriesObserver {
1019
+ subscribe(listener: any) {
1020
+ super.subscribe(listener)
1021
+ return () => void 0
1022
+ }
1023
+ }
1024
+
1025
+ const QueriesObserverSpy = jest
1026
+ .spyOn(QueriesObserverModule, 'QueriesObserver')
1027
+ .mockImplementation((fn) => {
1028
+ return new QueriesObserverMock(fn)
1029
+ })
1030
+
1031
+ function Queries() {
1032
+ createQueries({
1033
+ queries: [
1034
+ {
1035
+ queryKey: key1,
1036
+ queryFn: async () => {
1037
+ await sleep(10)
1038
+ return 1
1039
+ },
1040
+ },
1041
+ ],
1042
+ })
1043
+
1044
+ return (
1045
+ <div>
1046
+ <span>queries</span>
1047
+ </div>
1048
+ )
1049
+ }
1050
+
1051
+ function Page() {
1052
+ const [mounted, setMounted] = createSignal(true)
1053
+
1054
+ return (
1055
+ <div>
1056
+ <button onClick={() => setMounted(false)}>unmount</button>
1057
+ {mounted() && <Queries />}
1058
+ </div>
1059
+ )
1060
+ }
1061
+
1062
+ render(() => (
1063
+ <QueryClientProvider client={queryClient}>
1064
+ <Page />
1065
+ </QueryClientProvider>
1066
+ ))
1067
+ fireEvent.click(screen.getByText('unmount'))
1068
+
1069
+ // Should not display the console error
1070
+ // "Warning: Can't perform a React state update on an unmounted component"
1071
+
1072
+ await sleep(20)
1073
+ QueriesObserverSpy.mockRestore()
1074
+ })
1075
+
1076
+ describe('with custom context', () => {
1077
+ it('should return the correct states', async () => {
1078
+ const context = createContext<QueryClient | undefined>(undefined)
1079
+
1080
+ const key1 = queryKey()
1081
+ const key2 = queryKey()
1082
+ const results: CreateQueryResult[][] = []
1083
+
1084
+ function Page() {
1085
+ const result = createQueries({
1086
+ context,
1087
+ queries: [
1088
+ {
1089
+ queryKey: key1,
1090
+ queryFn: async () => {
1091
+ await sleep(5)
1092
+ return 1
1093
+ },
1094
+ },
1095
+ {
1096
+ queryKey: key2,
1097
+ queryFn: async () => {
1098
+ await sleep(10)
1099
+ return 2
1100
+ },
1101
+ },
1102
+ ],
1103
+ })
1104
+ createRenderEffect(() => {
1105
+ results.push([...result])
1106
+ })
1107
+ return null
1108
+ }
1109
+
1110
+ render(() => (
1111
+ <QueryClientProvider client={queryClient} context={context}>
1112
+ <Page />
1113
+ </QueryClientProvider>
1114
+ ))
1115
+
1116
+ await sleep(30)
1117
+
1118
+ expect(results[0]).toMatchObject([
1119
+ { data: undefined },
1120
+ { data: undefined },
1121
+ ])
1122
+ expect(results[results.length - 1]).toMatchObject([
1123
+ { data: 1 },
1124
+ { data: 2 },
1125
+ ])
1126
+ })
1127
+
1128
+ it('should throw if the context is necessary and is not passed to useQueries', async () => {
1129
+ const context = createContext<QueryClient | undefined>(undefined)
1130
+
1131
+ const key1 = queryKey()
1132
+ const key2 = queryKey()
1133
+ const results: CreateQueryResult[][] = []
1134
+
1135
+ function Page() {
1136
+ const result = createQueries({
1137
+ queries: [
1138
+ {
1139
+ queryKey: key1,
1140
+ queryFn: async () => 1,
1141
+ },
1142
+ {
1143
+ queryKey: key2,
1144
+ queryFn: async () => 2,
1145
+ },
1146
+ ],
1147
+ })
1148
+ results.push(result)
1149
+ return null
1150
+ }
1151
+
1152
+ render(() => (
1153
+ <QueryClientProvider client={queryClient} context={context}>
1154
+ <ErrorBoundary fallback={() => <div>error boundary</div>}>
1155
+ <Page />
1156
+ </ErrorBoundary>
1157
+ </QueryClientProvider>
1158
+ ))
1159
+
1160
+ await waitFor(() => screen.getByText('error boundary'))
1161
+ })
1162
+ })
1163
+ })