@hyper-fetch/react 7.5.2 → 8.0.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 (214) hide show
  1. package/.eslintrc.cjs +12 -0
  2. package/__tests__/features/helpers/use-request-events/use-request-events.base.spec.ts +115 -0
  3. package/__tests__/features/helpers/use-request-events/use-request-events.utils.spec.ts +69 -0
  4. package/__tests__/features/helpers/use-socket-state/use-socket-state.base.spec.ts +213 -0
  5. package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +550 -0
  6. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.base.spec.ts +566 -0
  7. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.utils.spec.ts +260 -0
  8. package/__tests__/features/provider/provider.hydration.spec.tsx +165 -0
  9. package/__tests__/features/provider/use-config-provider.base.spec.tsx +69 -0
  10. package/__tests__/features/use-app-manager/use-app-manager.base.spec.ts +85 -0
  11. package/__tests__/features/use-cache/use-cache.base.spec.ts +136 -0
  12. package/__tests__/features/use-cache/use-cache.helpers.ts +40 -0
  13. package/__tests__/features/use-cache/use-cache.typescript.spec.ts +111 -0
  14. package/__tests__/features/use-emitter/use-emitter.base.spec.ts +124 -0
  15. package/__tests__/features/use-fetch/use-fetch.base.spec.ts +372 -0
  16. package/__tests__/features/use-fetch/use-fetch.cancel.spec.ts +83 -0
  17. package/__tests__/features/use-fetch/use-fetch.clear-state.spec.ts +82 -0
  18. package/__tests__/features/use-fetch/use-fetch.concurrency.spec.ts +91 -0
  19. package/__tests__/features/use-fetch/use-fetch.debounce.spec.ts +153 -0
  20. package/__tests__/features/use-fetch/use-fetch.deduplication.spec.ts +80 -0
  21. package/__tests__/features/use-fetch/use-fetch.infinite.ts +39 -0
  22. package/__tests__/features/use-fetch/use-fetch.integration.spec.tsx +172 -0
  23. package/__tests__/features/use-fetch/use-fetch.keep-previous-data.spec.ts +215 -0
  24. package/__tests__/features/use-fetch/use-fetch.methods.spec.ts +233 -0
  25. package/__tests__/features/use-fetch/use-fetch.offline.spec.ts +103 -0
  26. package/__tests__/features/use-fetch/use-fetch.pagination.ts +36 -0
  27. package/__tests__/features/use-fetch/use-fetch.prefetch.spec.tsx +73 -0
  28. package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +187 -0
  29. package/__tests__/features/use-fetch/use-fetch.rerender.spec.tsx +151 -0
  30. package/__tests__/features/use-fetch/use-fetch.retry.ts +38 -0
  31. package/__tests__/features/use-fetch/use-fetch.revalidate.spec.ts +237 -0
  32. package/__tests__/features/use-fetch/use-fetch.suspense.spec.tsx +505 -0
  33. package/__tests__/features/use-fetch/use-fetch.typescript.spec.ts +182 -0
  34. package/__tests__/features/use-fetch/use-fetch.utils.spec.ts +26 -0
  35. package/__tests__/features/use-fetch/use-fetch.window.spec.ts +131 -0
  36. package/__tests__/features/use-listener/use-listener.base.spec.ts +57 -0
  37. package/__tests__/features/use-queue/use-queue.actions.spec.ts +238 -0
  38. package/__tests__/features/use-queue/use-queue.base.spec.ts +367 -0
  39. package/__tests__/features/use-queue/use-queue.resolve.spec.ts +173 -0
  40. package/__tests__/features/use-stream/use-stream.base.spec.ts +481 -0
  41. package/__tests__/features/use-submit/use-submit.base.spec.ts +76 -0
  42. package/__tests__/features/use-submit/use-submit.cancel.spec.ts +46 -0
  43. package/__tests__/features/use-submit/use-submit.concurrency.spec.ts +62 -0
  44. package/__tests__/features/use-submit/use-submit.debounce.spec.ts +320 -0
  45. package/__tests__/features/use-submit/use-submit.methods.spec.ts +276 -0
  46. package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +548 -0
  47. package/__tests__/features/use-submit/use-submit.queue.spec.ts +84 -0
  48. package/__tests__/features/use-submit/use-submit.retry.spec.ts +92 -0
  49. package/__tests__/features/use-submit/use-submit.revalidate.spec.ts +99 -0
  50. package/__tests__/features/use-submit/use-submit.submit.spec.ts +234 -0
  51. package/__tests__/features/use-submit/use-submit.typescript.spec.ts +325 -0
  52. package/__tests__/shared/index.ts +2 -0
  53. package/__tests__/shared/isolation.tests.ts +12 -0
  54. package/__tests__/shared/response.tests.ts +128 -0
  55. package/__tests__/tsconfig.json +27 -0
  56. package/__tests__/utils/cache.utils.ts +55 -0
  57. package/__tests__/utils/client.utils.ts +3 -0
  58. package/__tests__/utils/emitter.utils.ts +8 -0
  59. package/__tests__/utils/helpers.utils.ts +9 -0
  60. package/__tests__/utils/index.ts +14 -0
  61. package/__tests__/utils/listener.utils.ts +11 -0
  62. package/__tests__/utils/request.utils.ts +12 -0
  63. package/__tests__/utils/state.utils.ts +7 -0
  64. package/__tests__/utils/use-app-manager.utils.ts +10 -0
  65. package/__tests__/utils/use-cache.utils.ts +12 -0
  66. package/__tests__/utils/use-emitter.utils.ts +12 -0
  67. package/__tests__/utils/use-fetch.utils.ts +12 -0
  68. package/__tests__/utils/use-listener.utils.ts +12 -0
  69. package/__tests__/utils/use-queue.utils.ts +70 -0
  70. package/__tests__/utils/use-request-events.utils.ts +43 -0
  71. package/__tests__/utils/use-socket-state.utils.ts +12 -0
  72. package/__tests__/utils/use-submit.utils.ts +12 -0
  73. package/__tests__/utils/use-tracked-state.utils.ts +27 -0
  74. package/__tests__/vitest.setup.ts +8 -0
  75. package/dist/helpers/index.d.ts +4 -0
  76. package/dist/helpers/index.d.ts.map +1 -0
  77. package/dist/helpers/use-request-events/index.d.ts +3 -0
  78. package/dist/helpers/use-request-events/index.d.ts.map +1 -0
  79. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts +10 -0
  80. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -0
  81. package/dist/helpers/use-request-events/use-request-events.types.d.ts +78 -0
  82. package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -0
  83. package/dist/helpers/use-socket-state/index.d.ts +4 -0
  84. package/dist/helpers/use-socket-state/index.d.ts.map +1 -0
  85. package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts +4 -0
  86. package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts.map +1 -0
  87. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +24 -0
  88. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts.map +1 -0
  89. package/dist/helpers/use-socket-state/use-socket-state.types.d.ts +12 -0
  90. package/dist/helpers/use-socket-state/use-socket-state.types.d.ts.map +1 -0
  91. package/dist/helpers/use-tracked-state/index.d.ts +5 -0
  92. package/dist/helpers/use-tracked-state/index.d.ts.map +1 -0
  93. package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts +3 -0
  94. package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts.map +1 -0
  95. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts +12 -0
  96. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -0
  97. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts +113 -0
  98. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts.map +1 -0
  99. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +29 -0
  100. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -0
  101. package/dist/hooks/use-app-manager/index.d.ts +3 -0
  102. package/dist/hooks/use-app-manager/index.d.ts.map +1 -0
  103. package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts +4 -0
  104. package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts.map +1 -0
  105. package/dist/hooks/use-app-manager/use-app-manager.types.d.ts +19 -0
  106. package/dist/hooks/use-app-manager/use-app-manager.types.d.ts.map +1 -0
  107. package/dist/hooks/use-cache/index.d.ts +4 -0
  108. package/dist/hooks/use-cache/index.d.ts.map +1 -0
  109. package/dist/hooks/use-cache/use-cache.constants.d.ts +6 -0
  110. package/dist/hooks/use-cache/use-cache.constants.d.ts.map +1 -0
  111. package/dist/hooks/use-cache/use-cache.hooks.d.ts +4 -0
  112. package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -0
  113. package/dist/hooks/use-cache/use-cache.types.d.ts +24 -0
  114. package/dist/hooks/use-cache/use-cache.types.d.ts.map +1 -0
  115. package/dist/hooks/use-emitter/index.d.ts +3 -0
  116. package/dist/hooks/use-emitter/index.d.ts.map +1 -0
  117. package/dist/hooks/use-emitter/use-emitter.hooks.d.ts +26 -0
  118. package/dist/hooks/use-emitter/use-emitter.hooks.d.ts.map +1 -0
  119. package/dist/hooks/use-emitter/use-emitter.types.d.ts +4 -0
  120. package/dist/hooks/use-emitter/use-emitter.types.d.ts.map +1 -0
  121. package/dist/hooks/use-fetch/index.d.ts +5 -0
  122. package/dist/hooks/use-fetch/index.d.ts.map +1 -0
  123. package/dist/hooks/use-fetch/use-fetch.constants.d.ts +8 -0
  124. package/dist/hooks/use-fetch/use-fetch.constants.d.ts.map +1 -0
  125. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts +10 -0
  126. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -0
  127. package/dist/hooks/use-fetch/use-fetch.types.d.ts +118 -0
  128. package/dist/hooks/use-fetch/use-fetch.types.d.ts.map +1 -0
  129. package/dist/hooks/use-fetch/use-fetch.utils.d.ts +2 -0
  130. package/dist/hooks/use-fetch/use-fetch.utils.d.ts.map +1 -0
  131. package/dist/hooks/use-listener/index.d.ts +3 -0
  132. package/dist/hooks/use-listener/index.d.ts.map +1 -0
  133. package/dist/hooks/use-listener/use-listener.hooks.d.ts +31 -0
  134. package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -0
  135. package/dist/hooks/use-listener/use-listener.types.d.ts +4 -0
  136. package/dist/hooks/use-listener/use-listener.types.d.ts.map +1 -0
  137. package/dist/hooks/use-queue/index.d.ts +4 -0
  138. package/dist/hooks/use-queue/index.d.ts.map +1 -0
  139. package/dist/hooks/use-queue/use-queue.constants.d.ts +4 -0
  140. package/dist/hooks/use-queue/use-queue.constants.d.ts.map +1 -0
  141. package/dist/hooks/use-queue/use-queue.hooks.d.ts +10 -0
  142. package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -0
  143. package/dist/hooks/use-queue/use-queue.types.d.ts +58 -0
  144. package/dist/hooks/use-queue/use-queue.types.d.ts.map +1 -0
  145. package/dist/hooks/use-stream/index.d.ts +3 -0
  146. package/dist/hooks/use-stream/index.d.ts.map +1 -0
  147. package/dist/hooks/use-stream/use-stream.hooks.d.ts +11 -0
  148. package/dist/hooks/use-stream/use-stream.hooks.d.ts.map +1 -0
  149. package/dist/hooks/use-stream/use-stream.types.d.ts +52 -0
  150. package/dist/hooks/use-stream/use-stream.types.d.ts.map +1 -0
  151. package/dist/hooks/use-submit/index.d.ts +4 -0
  152. package/dist/hooks/use-submit/index.d.ts.map +1 -0
  153. package/dist/hooks/use-submit/use-submit.constants.d.ts +8 -0
  154. package/dist/hooks/use-submit/use-submit.constants.d.ts.map +1 -0
  155. package/dist/hooks/use-submit/use-submit.hooks.d.ts +10 -0
  156. package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -0
  157. package/dist/hooks/use-submit/use-submit.types.d.ts +115 -0
  158. package/dist/hooks/use-submit/use-submit.types.d.ts.map +1 -0
  159. package/dist/index.d.ts +12 -733
  160. package/dist/index.d.ts.map +1 -0
  161. package/dist/index.mjs +1935 -0
  162. package/dist/index.mjs.map +1 -0
  163. package/dist/provider/index.d.ts +3 -0
  164. package/dist/provider/index.d.ts.map +1 -0
  165. package/dist/provider/provider.d.ts +13 -0
  166. package/dist/provider/provider.d.ts.map +1 -0
  167. package/dist/provider/provider.types.d.ts +31 -0
  168. package/dist/provider/provider.types.d.ts.map +1 -0
  169. package/dist/utils/bounce.utils.d.ts +8 -0
  170. package/dist/utils/bounce.utils.d.ts.map +1 -0
  171. package/dist/utils/deep-equal.utils.d.ts +14 -0
  172. package/dist/utils/deep-equal.utils.d.ts.map +1 -0
  173. package/dist/utils/index.d.ts +4 -0
  174. package/dist/utils/index.d.ts.map +1 -0
  175. package/dist/utils/tracked-proxy.utils.d.ts +7 -0
  176. package/dist/utils/tracked-proxy.utils.d.ts.map +1 -0
  177. package/package.json +21 -13
  178. package/project.json +4 -0
  179. package/src/helpers/use-request-events/use-request-events.hooks.ts +60 -14
  180. package/src/helpers/use-request-events/use-request-events.types.ts +19 -12
  181. package/src/helpers/use-socket-state/use-socket-state.constants.ts +2 -2
  182. package/src/helpers/use-socket-state/use-socket-state.hooks.ts +47 -13
  183. package/src/helpers/use-socket-state/use-socket-state.types.ts +1 -1
  184. package/src/helpers/use-tracked-state/use-tracked-state.constants.ts +1 -1
  185. package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +74 -22
  186. package/src/helpers/use-tracked-state/use-tracked-state.types.ts +7 -2
  187. package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +39 -4
  188. package/src/hooks/use-app-manager/use-app-manager.hooks.ts +2 -2
  189. package/src/hooks/use-cache/use-cache.hooks.ts +33 -41
  190. package/src/hooks/use-cache/use-cache.types.ts +3 -3
  191. package/src/hooks/use-emitter/use-emitter.hooks.ts +17 -16
  192. package/src/hooks/use-fetch/use-fetch.constants.ts +5 -2
  193. package/src/hooks/use-fetch/use-fetch.hooks.ts +109 -51
  194. package/src/hooks/use-fetch/use-fetch.types.ts +18 -3
  195. package/src/hooks/use-listener/use-listener.hooks.ts +19 -27
  196. package/src/hooks/use-queue/use-queue.constants.ts +2 -2
  197. package/src/hooks/use-queue/use-queue.hooks.ts +25 -6
  198. package/src/hooks/use-queue/use-queue.types.ts +8 -2
  199. package/src/hooks/use-stream/index.ts +2 -0
  200. package/src/hooks/use-stream/use-stream.hooks.ts +164 -0
  201. package/src/hooks/use-stream/use-stream.types.ts +53 -0
  202. package/src/hooks/use-submit/use-submit.constants.ts +2 -2
  203. package/src/hooks/use-submit/use-submit.hooks.ts +43 -48
  204. package/src/hooks/use-submit/use-submit.types.ts +9 -9
  205. package/src/index.ts +1 -0
  206. package/src/provider/provider.tsx +1 -1
  207. package/src/provider/provider.types.ts +8 -8
  208. package/src/utils/index.ts +1 -0
  209. package/src/utils/tracked-proxy.utils.ts +19 -0
  210. package/tsconfig.json +1 -1
  211. package/vite.config.ts +45 -0
  212. package/.eslintrc.json +0 -11
  213. package/dist/index.js +0 -1541
  214. package/dist/index.js.map +0 -7
@@ -0,0 +1,566 @@
1
+ import { createClient, xhrExtra } from "@hyper-fetch/core";
2
+ import { act, waitFor } from "@testing-library/react";
3
+ import { createHttpMockingServer, sleep } from "@hyper-fetch/testing";
4
+
5
+ import { initialState } from "helpers";
6
+ import { renderUseTrackedState } from "../../../utils";
7
+
8
+ const { resetMocks, startServer, stopServer, mockRequest } = createHttpMockingServer();
9
+
10
+ describe("useTrackingState [ Events ]", () => {
11
+ let client = createClient({ url: "http://localhost:3000" });
12
+ let request = client.createRequest<{ response: any }>()({
13
+ endpoint: "/test",
14
+ });
15
+
16
+ beforeAll(() => {
17
+ startServer();
18
+ });
19
+
20
+ afterEach(() => {
21
+ resetMocks();
22
+ });
23
+
24
+ afterAll(() => {
25
+ stopServer();
26
+ });
27
+
28
+ beforeEach(() => {
29
+ vi.resetModules();
30
+ client = createClient({ url: "http://localhost:3000" });
31
+ request = client.createRequest<{ response: any }>()({
32
+ endpoint: "/test",
33
+ });
34
+ });
35
+
36
+ describe("given state is initialized", () => {
37
+ describe("when cache is empty", () => {
38
+ it("should init with default data", async () => {
39
+ const { result } = renderUseTrackedState(request);
40
+
41
+ expect(result.current[0].data).toBe(initialState.data);
42
+ expect(result.current[0].error).toBe(initialState.error);
43
+ expect(result.current[0].status).toBe(initialState.status);
44
+ expect(result.current[0].success).toBe(initialState.success);
45
+ expect(result.current[0].extra).toStrictEqual(request.client.adapter.defaultExtra);
46
+ expect(result.current[0].retries).toBe(0);
47
+ expect(result.current[0].loading).toBe(initialState.loading);
48
+ });
49
+ });
50
+ });
51
+ describe("given dependency tracking is active", () => {
52
+ describe("when updating the state values and dependency tracking is on", () => {
53
+ it("should not rerender hook when deep equal values are the same", async () => {
54
+ const { result } = renderUseTrackedState(request, { dependencyTracking: true });
55
+ const renderCount = { value: 0 };
56
+
57
+ // Track data changes
58
+ act(() => {
59
+ result.current[2].setRenderKey("data");
60
+ });
61
+
62
+ // Set same data twice
63
+ act(() => {
64
+ result.current[2].setCacheData({
65
+ data: { test: "value" },
66
+ error: null,
67
+ status: 200,
68
+ success: true,
69
+ extra: xhrExtra,
70
+ retries: 0,
71
+ requestTimestamp: +new Date(),
72
+ responseTimestamp: +new Date(),
73
+ addedTimestamp: +new Date(),
74
+ triggerTimestamp: +new Date(),
75
+ cacheKey: request.cacheKey,
76
+ scope: request.scope,
77
+ isCanceled: false,
78
+ isOffline: false,
79
+ willRetry: false,
80
+ staleTime: request.staleTime,
81
+ version: request.client.cache.version,
82
+ cacheTime: Infinity,
83
+ cached: true,
84
+ });
85
+ });
86
+
87
+ const firstRenderData = result.current[0].data;
88
+ renderCount.value += 1;
89
+
90
+ act(() => {
91
+ result.current[2].setCacheData({
92
+ data: { test: "value" },
93
+ error: null,
94
+ status: 200,
95
+ success: true,
96
+ extra: xhrExtra,
97
+ retries: 0,
98
+ requestTimestamp: +new Date(),
99
+ responseTimestamp: +new Date(),
100
+ addedTimestamp: +new Date(),
101
+ triggerTimestamp: +new Date(),
102
+ cacheKey: request.cacheKey,
103
+ scope: request.scope,
104
+ isCanceled: false,
105
+ isOffline: false,
106
+ willRetry: false,
107
+ staleTime: request.staleTime,
108
+ version: request.client.cache.version,
109
+ cacheTime: Infinity,
110
+ cached: true,
111
+ });
112
+ });
113
+
114
+ expect(result.current[0].data).toEqual(firstRenderData);
115
+ });
116
+ it("should rerender component when attribute is used", async () => {
117
+ const { result } = renderUseTrackedState(request, { dependencyTracking: true });
118
+
119
+ // Track data changes
120
+ act(() => {
121
+ result.current[2].setRenderKey("data");
122
+ });
123
+
124
+ const initialData = result.current[0].data;
125
+
126
+ act(() => {
127
+ result.current[2].setCacheData({
128
+ data: "new-data",
129
+ error: null,
130
+ status: 200,
131
+ success: true,
132
+ extra: xhrExtra,
133
+ retries: 0,
134
+ requestTimestamp: +new Date(),
135
+ responseTimestamp: +new Date(),
136
+ addedTimestamp: +new Date(),
137
+ triggerTimestamp: +new Date(),
138
+ cacheKey: request.cacheKey,
139
+ scope: request.scope,
140
+ isCanceled: false,
141
+ isOffline: false,
142
+ willRetry: false,
143
+ staleTime: request.staleTime,
144
+ version: request.client.cache.version,
145
+ cacheTime: Infinity,
146
+ cached: true,
147
+ });
148
+ });
149
+
150
+ expect(result.current[0].data).not.toEqual(initialData);
151
+ expect(result.current[0].data).toBe("new-data");
152
+ });
153
+ it("should not rerender component when attribute is not used", async () => {
154
+ const { result } = renderUseTrackedState(request, { dependencyTracking: true });
155
+
156
+ // Only track error changes
157
+ act(() => {
158
+ result.current[2].setRenderKey("error");
159
+ });
160
+
161
+ const initialData = result.current[0].data;
162
+
163
+ act(() => {
164
+ result.current[2].setCacheData({
165
+ data: "new-data",
166
+ error: null,
167
+ status: 200,
168
+ success: true,
169
+ extra: xhrExtra,
170
+ retries: 0,
171
+ requestTimestamp: +new Date(),
172
+ responseTimestamp: +new Date(),
173
+ addedTimestamp: +new Date(),
174
+ triggerTimestamp: +new Date(),
175
+ cacheKey: request.cacheKey,
176
+ scope: request.scope,
177
+ isCanceled: false,
178
+ isOffline: false,
179
+ willRetry: false,
180
+ staleTime: request.staleTime,
181
+ version: request.client.cache.version,
182
+ cacheTime: Infinity,
183
+ cached: true,
184
+ });
185
+ });
186
+
187
+ // Data should not change since we're only tracking error
188
+ expect(result.current[0].data).toEqual(initialData);
189
+ });
190
+ });
191
+ });
192
+ describe("given dependency tracking is off", () => {
193
+ describe("when updating the state values", () => {
194
+ it("should rerender on any attribute change", async () => {
195
+ const { result } = renderUseTrackedState(request, { dependencyTracking: false });
196
+
197
+ const initialData = result.current[0].data;
198
+
199
+ act(() => {
200
+ result.current[2].setCacheData({
201
+ data: "new-data",
202
+ error: null,
203
+ status: 200,
204
+ success: true,
205
+ extra: xhrExtra,
206
+ retries: 0,
207
+ requestTimestamp: +new Date(),
208
+ responseTimestamp: +new Date(),
209
+ addedTimestamp: +new Date(),
210
+ triggerTimestamp: +new Date(),
211
+ cacheKey: request.cacheKey,
212
+ scope: request.scope,
213
+ isCanceled: false,
214
+ isOffline: false,
215
+ willRetry: false,
216
+ staleTime: request.staleTime,
217
+ version: request.client.cache.version,
218
+ cacheTime: Infinity,
219
+ cached: true,
220
+ });
221
+ });
222
+
223
+ expect(result.current[0].data).not.toEqual(initialData);
224
+ expect(result.current[0].data).toBe("new-data");
225
+ });
226
+ });
227
+ });
228
+ describe("given request is mapping response", () => {
229
+ describe("when receiving data", () => {
230
+ it("should map the data", async () => {
231
+ const { result } = renderUseTrackedState(
232
+ request.setResponseMapper((response) => {
233
+ return { ...response, data: "new-data" } as typeof response;
234
+ }),
235
+ );
236
+
237
+ act(() => {
238
+ result.current[2].setRenderKey("data");
239
+ result.current[2].setCacheData({
240
+ data: true as any,
241
+ error: null,
242
+ status: 200,
243
+ success: true,
244
+ extra: xhrExtra,
245
+ retries: 0,
246
+ requestTimestamp: +new Date(),
247
+ responseTimestamp: +new Date(),
248
+ addedTimestamp: +new Date(),
249
+ triggerTimestamp: +new Date(),
250
+ cacheKey: request.cacheKey,
251
+ scope: request.scope,
252
+ isCanceled: false,
253
+ isOffline: false,
254
+ willRetry: false,
255
+ staleTime: request.staleTime,
256
+ version: request.client.cache.version,
257
+ cacheTime: Infinity,
258
+ cached: true,
259
+ });
260
+ });
261
+
262
+ expect(result.current[0].data).toBe("new-data");
263
+ expect(result.current[0].error).toBe(null);
264
+ });
265
+
266
+ it("should map the cache data", async () => {
267
+ mockRequest(request);
268
+
269
+ await act(async () => {
270
+ await request.send({});
271
+ });
272
+
273
+ const { result, rerender } = renderUseTrackedState(
274
+ request.setResponseMapper((response) => {
275
+ return { ...response, data: "new-data" } as typeof response;
276
+ }),
277
+ );
278
+
279
+ act(() => {
280
+ rerender();
281
+ });
282
+
283
+ expect(result.current[0].data).toBe("new-data");
284
+ expect(result.current[0].error).toBe(null);
285
+ });
286
+
287
+ it("should map the async data", async () => {
288
+ const { result } = renderUseTrackedState(
289
+ request.setResponseMapper(async (response) => {
290
+ return Promise.resolve({ ...response, data: "new-data" } as typeof response);
291
+ }),
292
+ );
293
+
294
+ act(() => {
295
+ result.current[2].setRenderKey("data");
296
+ result.current[2].setCacheData({
297
+ data: true as any,
298
+ error: null,
299
+ status: 200,
300
+ success: true,
301
+ extra: xhrExtra,
302
+ retries: 0,
303
+ requestTimestamp: +new Date(),
304
+ responseTimestamp: +new Date(),
305
+ addedTimestamp: +new Date(),
306
+ triggerTimestamp: +new Date(),
307
+ cacheKey: request.cacheKey,
308
+ scope: request.scope,
309
+ isCanceled: false,
310
+ isOffline: false,
311
+ willRetry: false,
312
+ staleTime: request.staleTime,
313
+ version: request.client.cache.version,
314
+ cacheTime: Infinity,
315
+ cached: true,
316
+ });
317
+ });
318
+
319
+ expect(result.current[0]).toStrictEqual(expect.objectContaining({ ...initialState, extra: xhrExtra }));
320
+
321
+ await waitFor(() => {
322
+ expect(result.current[0].data).toBe("new-data");
323
+ expect(result.current[0].error).toBe(null);
324
+ });
325
+ });
326
+ });
327
+ describe("when deepCompare is function", () => {
328
+ it("should trigger with two values", async () => {
329
+ const customDeepCompare = vi.fn().mockImplementation(() => true);
330
+ const { result } = renderUseTrackedState(request, { deepCompare: customDeepCompare });
331
+
332
+ act(() => {
333
+ result.current[2].setRenderKey("data");
334
+ result.current[2].setCacheData({
335
+ data: "test-data",
336
+ error: null,
337
+ status: 200,
338
+ success: true,
339
+ extra: xhrExtra,
340
+ retries: 0,
341
+ requestTimestamp: +new Date(),
342
+ responseTimestamp: +new Date(),
343
+ addedTimestamp: +new Date(),
344
+ triggerTimestamp: +new Date(),
345
+ cacheKey: request.cacheKey,
346
+ scope: request.scope,
347
+ isCanceled: false,
348
+ isOffline: false,
349
+ willRetry: false,
350
+ staleTime: request.staleTime,
351
+ version: request.client.cache.version,
352
+ cacheTime: Infinity,
353
+ cached: true,
354
+ });
355
+ });
356
+
357
+ expect(customDeepCompare).toHaveBeenCalledWith(null, "test-data");
358
+ });
359
+ });
360
+ describe("when handling async response mapping", () => {
361
+ it("should handle async response mapper rejection", async () => {
362
+ const { result } = renderUseTrackedState(
363
+ request.setResponseMapper(async (response) => {
364
+ await sleep(1000);
365
+ return response;
366
+ }),
367
+ );
368
+
369
+ act(() => {
370
+ result.current[2].setRenderKey("data");
371
+ result.current[2].setCacheData({
372
+ data: true as any,
373
+ error: null,
374
+ status: 200,
375
+ success: true,
376
+ extra: xhrExtra,
377
+ retries: 0,
378
+ requestTimestamp: +new Date(),
379
+ responseTimestamp: +new Date(),
380
+ addedTimestamp: +new Date(),
381
+ triggerTimestamp: +new Date(),
382
+ cacheKey: request.cacheKey,
383
+ scope: request.scope,
384
+ isCanceled: false,
385
+ isOffline: false,
386
+ willRetry: false,
387
+ staleTime: request.staleTime,
388
+ version: request.client.cache.version,
389
+ cacheTime: Infinity,
390
+ cached: true,
391
+ });
392
+ });
393
+
394
+ // Initial state should be maintained while processing
395
+ expect(result.current[0]).toStrictEqual(expect.objectContaining({ ...initialState, extra: xhrExtra }));
396
+
397
+ // Wait for the error to be processed
398
+ await expect(async () => {
399
+ await waitFor(() => {
400
+ expect(result.current[0].data).toBe(true);
401
+ });
402
+ }).not.toThrow();
403
+ });
404
+
405
+ it("should handle concurrent async response mapping", async () => {
406
+ let resolveFirst: (value: any) => void;
407
+ let resolveSecond: (value: any) => void;
408
+
409
+ const firstPromise = new Promise((resolve) => {
410
+ resolveFirst = resolve;
411
+ });
412
+ const secondPromise = new Promise((resolve) => {
413
+ resolveSecond = resolve;
414
+ });
415
+
416
+ let mapperCallCount = 0;
417
+ const { result } = renderUseTrackedState(
418
+ request.setResponseMapper(async (response) => {
419
+ mapperCallCount += 1;
420
+ if (mapperCallCount === 1) {
421
+ return firstPromise.then(() => ({ ...response, data: "first-data" }) as typeof response);
422
+ }
423
+ return secondPromise.then(() => ({ ...response, data: "second-data" }) as typeof response);
424
+ }),
425
+ );
426
+
427
+ // Set first data
428
+ act(() => {
429
+ result.current[2].setRenderKey("data");
430
+ result.current[2].setCacheData({
431
+ data: "initial" as any,
432
+ error: null,
433
+ status: 200,
434
+ success: true,
435
+ extra: xhrExtra,
436
+ retries: 0,
437
+ requestTimestamp: +new Date(),
438
+ responseTimestamp: +new Date(),
439
+ addedTimestamp: +new Date(),
440
+ triggerTimestamp: +new Date(),
441
+ cacheKey: request.cacheKey,
442
+ scope: request.scope,
443
+ isCanceled: false,
444
+ isOffline: false,
445
+ willRetry: false,
446
+ staleTime: request.staleTime,
447
+ version: request.client.cache.version,
448
+ cacheTime: Infinity,
449
+ cached: true,
450
+ });
451
+ });
452
+
453
+ // Set second data before first resolves
454
+ act(() => {
455
+ result.current[2].setCacheData({
456
+ data: "newer" as any,
457
+ error: null,
458
+ status: 200,
459
+ success: true,
460
+ extra: xhrExtra,
461
+ retries: 0,
462
+ requestTimestamp: +new Date(),
463
+ responseTimestamp: +new Date(),
464
+ addedTimestamp: +new Date(),
465
+ triggerTimestamp: +new Date(),
466
+ cacheKey: request.cacheKey,
467
+ scope: request.scope,
468
+ isCanceled: false,
469
+ isOffline: false,
470
+ willRetry: false,
471
+ staleTime: request.staleTime,
472
+ version: request.client.cache.version,
473
+ cacheTime: Infinity,
474
+ cached: true,
475
+ });
476
+ });
477
+
478
+ // Resolve promises in reverse order
479
+ act(() => {
480
+ resolveSecond({});
481
+ });
482
+
483
+ await waitFor(() => {
484
+ expect(result.current[0].data).toBe("second-data");
485
+ });
486
+
487
+ act(() => {
488
+ resolveFirst({});
489
+ });
490
+
491
+ // Should still show second data since it was the last update
492
+ await waitFor(() => {
493
+ expect(result.current[0].data).toBe("second-data");
494
+ });
495
+ });
496
+ });
497
+ });
498
+ describe("given custom deepCompare option is passed", () => {
499
+ describe("when deepCompare is function", () => {
500
+ it("should allow to use custom deepCompare", async () => {
501
+ const deepCompare = vi.fn().mockImplementation(() => false);
502
+ const { result } = renderUseTrackedState(request, { deepCompare, dependencyTracking: true });
503
+
504
+ act(() => {
505
+ result.current[2].setRenderKey("data");
506
+ result.current[2].setCacheData({
507
+ data: true,
508
+ error: null,
509
+ status: 200,
510
+ success: true,
511
+ extra: xhrExtra,
512
+ retries: 0,
513
+ requestTimestamp: +new Date(),
514
+ responseTimestamp: +new Date(),
515
+ addedTimestamp: +new Date(),
516
+ triggerTimestamp: +new Date(),
517
+ cacheKey: request.cacheKey,
518
+ scope: request.scope,
519
+ isCanceled: false,
520
+ isOffline: false,
521
+ willRetry: false,
522
+ staleTime: request.staleTime,
523
+ version: request.client.cache.version,
524
+ cacheTime: Infinity,
525
+ cached: true,
526
+ });
527
+ });
528
+
529
+ expect(deepCompare).toHaveBeenCalled();
530
+ expect(result.current[0].data).toBeTrue();
531
+ });
532
+ });
533
+ describe("when deepCompare is false", () => {
534
+ it("should not compare values", async () => {
535
+ const { result } = renderUseTrackedState(request, { deepCompare: false, dependencyTracking: true });
536
+
537
+ act(() => {
538
+ result.current[2].setRenderKey("data");
539
+ result.current[2].setCacheData({
540
+ data: true,
541
+ error: null,
542
+ status: 200,
543
+ success: true,
544
+ extra: xhrExtra,
545
+ retries: 0,
546
+ requestTimestamp: +new Date(),
547
+ responseTimestamp: +new Date(),
548
+ addedTimestamp: +new Date(),
549
+ triggerTimestamp: +new Date(),
550
+ cacheKey: request.cacheKey,
551
+ scope: request.scope,
552
+ isCanceled: false,
553
+ isOffline: false,
554
+ willRetry: false,
555
+ staleTime: request.staleTime,
556
+ version: request.client.cache.version,
557
+ cacheTime: Infinity,
558
+ cached: true,
559
+ });
560
+ });
561
+
562
+ expect(result.current[0].data).toBeTrue();
563
+ });
564
+ });
565
+ });
566
+ });