@hyper-fetch/react 7.5.3 → 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 (212) hide show
  1. package/.eslintrc.cjs +12 -0
  2. package/__tests__/features/helpers/use-request-events/use-request-events.base.spec.ts +4 -4
  3. package/__tests__/features/helpers/use-request-events/use-request-events.utils.spec.ts +3 -3
  4. package/__tests__/features/helpers/use-socket-state/use-socket-state.base.spec.ts +44 -6
  5. package/__tests__/features/helpers/use-tracked-state/use-tacked-state.actions.spec.ts +177 -9
  6. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.base.spec.ts +47 -8
  7. package/__tests__/features/helpers/use-tracked-state/use-tracked-state.utils.spec.ts +6 -6
  8. package/__tests__/features/provider/provider.hydration.spec.tsx +7 -3
  9. package/__tests__/features/provider/use-config-provider.base.spec.tsx +2 -1
  10. package/__tests__/features/use-app-manager/use-app-manager.base.spec.ts +1 -1
  11. package/__tests__/features/use-cache/use-cache.base.spec.ts +9 -6
  12. package/__tests__/features/use-cache/use-cache.helpers.ts +1 -1
  13. package/__tests__/features/use-cache/use-cache.typescript.spec.ts +111 -0
  14. package/__tests__/features/use-emitter/use-emitter.base.spec.ts +2 -2
  15. package/__tests__/features/use-fetch/use-fetch.base.spec.ts +103 -15
  16. package/__tests__/features/use-fetch/use-fetch.cancel.spec.ts +2 -2
  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 +3 -3
  19. package/__tests__/features/use-fetch/use-fetch.debounce.spec.ts +5 -5
  20. package/__tests__/features/use-fetch/use-fetch.deduplication.spec.ts +1 -1
  21. package/__tests__/features/use-fetch/use-fetch.infinite.ts +1 -1
  22. package/__tests__/features/use-fetch/use-fetch.integration.spec.tsx +3 -3
  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 +34 -34
  25. package/__tests__/features/use-fetch/use-fetch.offline.spec.ts +3 -3
  26. package/__tests__/features/use-fetch/use-fetch.pagination.ts +1 -1
  27. package/__tests__/features/use-fetch/use-fetch.prefetch.spec.tsx +1 -1
  28. package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +41 -7
  29. package/__tests__/features/use-fetch/use-fetch.rerender.spec.tsx +2 -2
  30. package/__tests__/features/use-fetch/use-fetch.retry.ts +1 -1
  31. package/__tests__/features/use-fetch/use-fetch.revalidate.spec.ts +6 -4
  32. package/__tests__/features/use-fetch/use-fetch.suspense.spec.tsx +505 -0
  33. package/__tests__/features/use-fetch/use-fetch.typescript.spec.ts +179 -56
  34. package/__tests__/features/use-fetch/use-fetch.window.spec.ts +75 -3
  35. package/__tests__/features/use-listener/use-listener.base.spec.ts +3 -3
  36. package/__tests__/features/use-queue/use-queue.actions.spec.ts +1 -1
  37. package/__tests__/features/use-queue/use-queue.base.spec.ts +259 -1
  38. package/__tests__/features/use-queue/use-queue.resolve.spec.ts +173 -0
  39. package/__tests__/features/use-stream/use-stream.base.spec.ts +481 -0
  40. package/__tests__/features/use-submit/use-submit.base.spec.ts +2 -2
  41. package/__tests__/features/use-submit/use-submit.cancel.spec.ts +1 -1
  42. package/__tests__/features/use-submit/use-submit.concurrency.spec.ts +1 -1
  43. package/__tests__/features/use-submit/use-submit.debounce.spec.ts +8 -8
  44. package/__tests__/features/use-submit/use-submit.methods.spec.ts +44 -46
  45. package/__tests__/features/use-submit/use-submit.optimistic.spec.ts +548 -0
  46. package/__tests__/features/use-submit/use-submit.queue.spec.ts +3 -3
  47. package/__tests__/features/use-submit/use-submit.retry.spec.ts +4 -4
  48. package/__tests__/features/use-submit/use-submit.revalidate.spec.ts +5 -5
  49. package/__tests__/features/use-submit/use-submit.submit.spec.ts +4 -3
  50. package/__tests__/features/use-submit/use-submit.typescript.spec.ts +325 -0
  51. package/__tests__/shared/isolation.tests.ts +1 -1
  52. package/__tests__/shared/response.tests.ts +5 -4
  53. package/__tests__/tsconfig.json +21 -2
  54. package/__tests__/utils/cache.utils.ts +6 -4
  55. package/__tests__/utils/emitter.utils.ts +3 -2
  56. package/__tests__/utils/listener.utils.ts +3 -2
  57. package/__tests__/utils/request.utils.ts +6 -6
  58. package/__tests__/utils/state.utils.ts +1 -1
  59. package/__tests__/utils/use-app-manager.utils.ts +1 -1
  60. package/__tests__/utils/use-cache.utils.ts +3 -2
  61. package/__tests__/utils/use-emitter.utils.ts +3 -2
  62. package/__tests__/utils/use-fetch.utils.ts +4 -3
  63. package/__tests__/utils/use-listener.utils.ts +3 -2
  64. package/__tests__/utils/use-queue.utils.ts +4 -2
  65. package/__tests__/utils/use-request-events.utils.ts +3 -2
  66. package/__tests__/utils/use-socket-state.utils.ts +3 -2
  67. package/__tests__/utils/use-submit.utils.ts +3 -2
  68. package/__tests__/utils/use-tracked-state.utils.ts +3 -2
  69. package/__tests__/vitest.setup.ts +8 -0
  70. package/dist/helpers/index.d.ts +4 -0
  71. package/dist/helpers/index.d.ts.map +1 -0
  72. package/dist/helpers/use-request-events/index.d.ts +3 -0
  73. package/dist/helpers/use-request-events/index.d.ts.map +1 -0
  74. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts +10 -0
  75. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -0
  76. package/dist/helpers/use-request-events/use-request-events.types.d.ts +78 -0
  77. package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -0
  78. package/dist/helpers/use-socket-state/index.d.ts +4 -0
  79. package/dist/helpers/use-socket-state/index.d.ts.map +1 -0
  80. package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts +4 -0
  81. package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts.map +1 -0
  82. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +24 -0
  83. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts.map +1 -0
  84. package/dist/helpers/use-socket-state/use-socket-state.types.d.ts +12 -0
  85. package/dist/helpers/use-socket-state/use-socket-state.types.d.ts.map +1 -0
  86. package/dist/helpers/use-tracked-state/index.d.ts +5 -0
  87. package/dist/helpers/use-tracked-state/index.d.ts.map +1 -0
  88. package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts +3 -0
  89. package/dist/helpers/use-tracked-state/use-tracked-state.constants.d.ts.map +1 -0
  90. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts +12 -0
  91. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -0
  92. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts +113 -0
  93. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts.map +1 -0
  94. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +29 -0
  95. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts.map +1 -0
  96. package/dist/hooks/use-app-manager/index.d.ts +3 -0
  97. package/dist/hooks/use-app-manager/index.d.ts.map +1 -0
  98. package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts +4 -0
  99. package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts.map +1 -0
  100. package/dist/hooks/use-app-manager/use-app-manager.types.d.ts +19 -0
  101. package/dist/hooks/use-app-manager/use-app-manager.types.d.ts.map +1 -0
  102. package/dist/hooks/use-cache/index.d.ts +4 -0
  103. package/dist/hooks/use-cache/index.d.ts.map +1 -0
  104. package/dist/hooks/use-cache/use-cache.constants.d.ts +6 -0
  105. package/dist/hooks/use-cache/use-cache.constants.d.ts.map +1 -0
  106. package/dist/hooks/use-cache/use-cache.hooks.d.ts +4 -0
  107. package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -0
  108. package/dist/hooks/use-cache/use-cache.types.d.ts +24 -0
  109. package/dist/hooks/use-cache/use-cache.types.d.ts.map +1 -0
  110. package/dist/hooks/use-emitter/index.d.ts +3 -0
  111. package/dist/hooks/use-emitter/index.d.ts.map +1 -0
  112. package/dist/hooks/use-emitter/use-emitter.hooks.d.ts +26 -0
  113. package/dist/hooks/use-emitter/use-emitter.hooks.d.ts.map +1 -0
  114. package/dist/hooks/use-emitter/use-emitter.types.d.ts +4 -0
  115. package/dist/hooks/use-emitter/use-emitter.types.d.ts.map +1 -0
  116. package/dist/hooks/use-fetch/index.d.ts +5 -0
  117. package/dist/hooks/use-fetch/index.d.ts.map +1 -0
  118. package/dist/hooks/use-fetch/use-fetch.constants.d.ts +8 -0
  119. package/dist/hooks/use-fetch/use-fetch.constants.d.ts.map +1 -0
  120. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts +10 -0
  121. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -0
  122. package/dist/hooks/use-fetch/use-fetch.types.d.ts +118 -0
  123. package/dist/hooks/use-fetch/use-fetch.types.d.ts.map +1 -0
  124. package/dist/hooks/use-fetch/use-fetch.utils.d.ts +2 -0
  125. package/dist/hooks/use-fetch/use-fetch.utils.d.ts.map +1 -0
  126. package/dist/hooks/use-listener/index.d.ts +3 -0
  127. package/dist/hooks/use-listener/index.d.ts.map +1 -0
  128. package/dist/hooks/use-listener/use-listener.hooks.d.ts +31 -0
  129. package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -0
  130. package/dist/hooks/use-listener/use-listener.types.d.ts +4 -0
  131. package/dist/hooks/use-listener/use-listener.types.d.ts.map +1 -0
  132. package/dist/hooks/use-queue/index.d.ts +4 -0
  133. package/dist/hooks/use-queue/index.d.ts.map +1 -0
  134. package/dist/hooks/use-queue/use-queue.constants.d.ts +4 -0
  135. package/dist/hooks/use-queue/use-queue.constants.d.ts.map +1 -0
  136. package/dist/hooks/use-queue/use-queue.hooks.d.ts +10 -0
  137. package/dist/hooks/use-queue/use-queue.hooks.d.ts.map +1 -0
  138. package/dist/hooks/use-queue/use-queue.types.d.ts +58 -0
  139. package/dist/hooks/use-queue/use-queue.types.d.ts.map +1 -0
  140. package/dist/hooks/use-stream/index.d.ts +3 -0
  141. package/dist/hooks/use-stream/index.d.ts.map +1 -0
  142. package/dist/hooks/use-stream/use-stream.hooks.d.ts +11 -0
  143. package/dist/hooks/use-stream/use-stream.hooks.d.ts.map +1 -0
  144. package/dist/hooks/use-stream/use-stream.types.d.ts +52 -0
  145. package/dist/hooks/use-stream/use-stream.types.d.ts.map +1 -0
  146. package/dist/hooks/use-submit/index.d.ts +4 -0
  147. package/dist/hooks/use-submit/index.d.ts.map +1 -0
  148. package/dist/hooks/use-submit/use-submit.constants.d.ts +8 -0
  149. package/dist/hooks/use-submit/use-submit.constants.d.ts.map +1 -0
  150. package/dist/hooks/use-submit/use-submit.hooks.d.ts +10 -0
  151. package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -0
  152. package/dist/hooks/use-submit/use-submit.types.d.ts +115 -0
  153. package/dist/hooks/use-submit/use-submit.types.d.ts.map +1 -0
  154. package/dist/index.d.ts +12 -733
  155. package/dist/index.d.ts.map +1 -0
  156. package/dist/index.mjs +1935 -0
  157. package/dist/index.mjs.map +1 -0
  158. package/dist/provider/index.d.ts +3 -0
  159. package/dist/provider/index.d.ts.map +1 -0
  160. package/dist/provider/provider.d.ts +13 -0
  161. package/dist/provider/provider.d.ts.map +1 -0
  162. package/dist/provider/provider.types.d.ts +31 -0
  163. package/dist/provider/provider.types.d.ts.map +1 -0
  164. package/dist/utils/bounce.utils.d.ts +8 -0
  165. package/dist/utils/bounce.utils.d.ts.map +1 -0
  166. package/dist/utils/deep-equal.utils.d.ts +14 -0
  167. package/dist/utils/deep-equal.utils.d.ts.map +1 -0
  168. package/dist/utils/index.d.ts +4 -0
  169. package/dist/utils/index.d.ts.map +1 -0
  170. package/dist/utils/tracked-proxy.utils.d.ts +7 -0
  171. package/dist/utils/tracked-proxy.utils.d.ts.map +1 -0
  172. package/package.json +21 -13
  173. package/src/helpers/use-request-events/use-request-events.hooks.ts +60 -14
  174. package/src/helpers/use-request-events/use-request-events.types.ts +19 -12
  175. package/src/helpers/use-socket-state/use-socket-state.constants.ts +2 -2
  176. package/src/helpers/use-socket-state/use-socket-state.hooks.ts +47 -13
  177. package/src/helpers/use-socket-state/use-socket-state.types.ts +1 -1
  178. package/src/helpers/use-tracked-state/use-tracked-state.constants.ts +1 -1
  179. package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +74 -22
  180. package/src/helpers/use-tracked-state/use-tracked-state.types.ts +7 -2
  181. package/src/helpers/use-tracked-state/use-tracked-state.utils.ts +39 -4
  182. package/src/hooks/use-app-manager/use-app-manager.hooks.ts +2 -2
  183. package/src/hooks/use-cache/use-cache.hooks.ts +33 -41
  184. package/src/hooks/use-cache/use-cache.types.ts +3 -3
  185. package/src/hooks/use-emitter/use-emitter.hooks.ts +17 -16
  186. package/src/hooks/use-fetch/use-fetch.constants.ts +5 -2
  187. package/src/hooks/use-fetch/use-fetch.hooks.ts +109 -51
  188. package/src/hooks/use-fetch/use-fetch.types.ts +18 -3
  189. package/src/hooks/use-listener/use-listener.hooks.ts +19 -27
  190. package/src/hooks/use-queue/use-queue.constants.ts +2 -2
  191. package/src/hooks/use-queue/use-queue.hooks.ts +25 -6
  192. package/src/hooks/use-queue/use-queue.types.ts +8 -2
  193. package/src/hooks/use-stream/index.ts +2 -0
  194. package/src/hooks/use-stream/use-stream.hooks.ts +164 -0
  195. package/src/hooks/use-stream/use-stream.types.ts +53 -0
  196. package/src/hooks/use-submit/use-submit.constants.ts +2 -2
  197. package/src/hooks/use-submit/use-submit.hooks.ts +43 -48
  198. package/src/hooks/use-submit/use-submit.types.ts +9 -9
  199. package/src/index.ts +1 -0
  200. package/src/provider/provider.tsx +1 -1
  201. package/src/provider/provider.types.ts +8 -8
  202. package/src/utils/index.ts +1 -0
  203. package/src/utils/tracked-proxy.utils.ts +19 -0
  204. package/tsconfig.json +1 -1
  205. package/vite.config.ts +45 -0
  206. package/.eslintrc.json +0 -11
  207. package/__tests__/features/use-fetch/use-fetch.suspense.ts +0 -37
  208. package/__tests__/global.d.ts +0 -1
  209. package/__tests__/jest.setup.ts +0 -9
  210. package/dist/index.js +0 -1541
  211. package/dist/index.js.map +0 -7
  212. package/jest.config.ts +0 -6
@@ -1,59 +1,182 @@
1
- import { useFetch } from "hooks/use-fetch";
1
+ import { expectType, expectNotType, expectFunctionParametersType } from "@hyper-fetch/testing";
2
+ import { Client } from "@hyper-fetch/core";
2
3
 
3
- describe("useFetch", () => {
4
- it("dummy test", () => {
5
- expect(useFetch).toBeDefined();
6
- });
4
+ import type { UseFetchReturnType } from "hooks/use-fetch";
5
+
6
+ const client = new Client({
7
+ url: "http://localhost:3000",
8
+ });
9
+
10
+ // ---- Request definitions ----
11
+
12
+ const getUsers = client.createRequest<{
13
+ response: { id: string; name: string }[];
14
+ }>()({
15
+ method: "GET",
16
+ endpoint: "/users",
17
+ });
18
+
19
+ const getUser = client.createRequest<{
20
+ response: { id: string; name: string; email: string };
21
+ }>()({
22
+ method: "GET",
23
+ endpoint: "/users/:userId",
24
+ });
25
+
26
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
27
+ const getUserWithQuery = client.createRequest<{
28
+ response: { id: string; name: string }[];
29
+ queryParams: { search: string; page: number };
30
+ }>()({
31
+ method: "GET",
32
+ endpoint: "/users",
33
+ });
34
+
35
+ const getUserWithError = client.createRequest<{
36
+ response: { id: string };
37
+ error: { code: number; message: string; details: string[] };
38
+ }>()({
39
+ method: "GET",
40
+ endpoint: "/users/:userId",
7
41
  });
8
42
 
9
- // import { expectType } from "@hyper-fetch/testing";
10
- // import { Client, ExtractHasPayloadType, ExtractHasParamsType, ExtractHasQueryParamsType } from "@hyper-fetch/core";
11
-
12
- // import { UseFetchRequest } from "hooks/use-fetch";
13
-
14
- // const client = new Client({
15
- // url: "http://localhost:3000",
16
- // });
17
-
18
- // describe("when using useFetch request", () => {
19
- // it("should require params", () => {
20
- // const getUser = client.createRequest<{ response: { id: string } }>()({
21
- // method: "GET",
22
- // endpoint: "/users/:id",
23
- // });
24
- // const getUserWithParams = getUser.setParams({ id: 1 });
25
- // expectType<ExtractHasParamsType<UseFetchRequest<typeof getUser>>>().assert(false);
26
- // expectType<ExtractHasParamsType<UseFetchRequest<typeof getUserWithParams>>>().assert(true);
27
- // });
28
- // it("should require payload", () => {
29
- // const postUser = client.createRequest<{ response: { id: string }; payload: { name: string } }>()({
30
- // method: "POST",
31
- // endpoint: "/users",
32
- // });
33
- // const postUserWithPayload = postUser.setPayload({ name: "test" });
34
-
35
- // expectType<ExtractHasPayloadType<UseFetchRequest<typeof postUser>>>().assert(false);
36
- // expectType<ExtractHasPayloadType<UseFetchRequest<typeof postUserWithPayload>>>().assert(true);
37
- // });
38
- // it("should require params and payload", () => {
39
- // const patchUser = client.createRequest<{
40
- // response: { id: string };
41
- // payload: { name: string };
42
- // queryParams: { name: string };
43
- // }>()({
44
- // method: "PATCH",
45
- // endpoint: "/users/:id",
46
- // });
47
- // const patchUserWithParams = patchUser.setParams({ id: 1 });
48
- // const patchUserWithPayload = patchUser.setPayload({ name: "test" });
49
- // const patchUserWithQueryParams = patchUser.setQueryParams({ name: "test" });
50
-
51
- // expectType<false>().assert<ExtractHasParamsType<UseFetchRequest<typeof patchUser>>>(false);
52
- // expectType<false>().assert<ExtractHasPayloadType<UseFetchRequest<typeof patchUser>>>(false);
53
- // expectType<false>().assert<ExtractHasQueryParamsType<UseFetchRequest<typeof patchUser>>>(false);
54
-
55
- // expectType<true>().assert<ExtractHasParamsType<UseFetchRequest<typeof patchUserWithParams>>>(true);
56
- // expectType<true>().assert<ExtractHasPayloadType<UseFetchRequest<typeof patchUserWithPayload>>>(true);
57
- // expectType<true>().assert<ExtractHasQueryParamsType<UseFetchRequest<typeof patchUserWithQueryParams>>>(true);
58
- // });
59
- // });
43
+ // ---- Type-level tests using return type directly ----
44
+
45
+ type GetUsersReturn = UseFetchReturnType<typeof getUsers>;
46
+ type GetUserReturn = UseFetchReturnType<typeof getUser>;
47
+ type GetUserWithErrorReturn = UseFetchReturnType<typeof getUserWithError>;
48
+
49
+ describe("useFetch [Types]", () => {
50
+ describe("return type: data", () => {
51
+ it("should type data as response type or null", () => {
52
+ const data = null as unknown as GetUsersReturn["data"];
53
+ expectType<{ id: string; name: string }[] | null>().assert(data);
54
+ });
55
+
56
+ it("should not type data as just the response type (missing null)", () => {
57
+ const data = null as unknown as GetUsersReturn["data"];
58
+ expectNotType<{ id: string; name: string }[]>().assert(data);
59
+ });
60
+
61
+ it("should type data correctly for parameterized requests", () => {
62
+ const data = null as unknown as GetUserReturn["data"];
63
+ expectType<{ id: string; name: string; email: string } | null>().assert(data);
64
+ });
65
+ });
66
+
67
+ describe("return type: error", () => {
68
+ it("should type error as Error or null for default error type", () => {
69
+ const error = null as unknown as GetUsersReturn["error"];
70
+ expectType<Error | null>().assert(error);
71
+ });
72
+
73
+ it("should type error with custom error type", () => {
74
+ const error = null as unknown as GetUserWithErrorReturn["error"];
75
+ expectType<{ code: number; message: string; details: string[] } | Error | null>().assert(error);
76
+ });
77
+ });
78
+
79
+ describe("return type: loading", () => {
80
+ it("should type loading as boolean", () => {
81
+ const loading = false as GetUsersReturn["loading"];
82
+ expectType<boolean>().assert(loading);
83
+ });
84
+ });
85
+
86
+ describe("return type: success", () => {
87
+ it("should type success as boolean", () => {
88
+ const success = false as GetUsersReturn["success"];
89
+ expectType<boolean>().assert(success);
90
+ });
91
+ });
92
+
93
+ describe("return type: retries", () => {
94
+ it("should type retries as number", () => {
95
+ const retries = 0 as GetUsersReturn["retries"];
96
+ expectType<number>().assert(retries);
97
+ });
98
+ });
99
+
100
+ describe("return type: timestamps", () => {
101
+ it("should type responseTimestamp as Date or null", () => {
102
+ const ts = null as unknown as GetUsersReturn["responseTimestamp"];
103
+ expectType<Date | null>().assert(ts);
104
+ });
105
+
106
+ it("should type requestTimestamp as Date or null", () => {
107
+ const ts = null as unknown as GetUsersReturn["requestTimestamp"];
108
+ expectType<Date | null>().assert(ts);
109
+ });
110
+ });
111
+
112
+ describe("return type: actions", () => {
113
+ it("should have setData accepting the response type", () => {
114
+ const setData = (() => null) as unknown as GetUsersReturn["setData"];
115
+ expectFunctionParametersType(setData).assert([[{ id: "1", name: "test" }]]);
116
+ });
117
+
118
+ it("should have setData accepting null", () => {
119
+ const setData = (() => null) as unknown as GetUsersReturn["setData"];
120
+ expectFunctionParametersType(setData).assert([null]);
121
+ });
122
+
123
+ it("should have setLoading accepting boolean", () => {
124
+ const setLoading = (() => null) as unknown as GetUsersReturn["setLoading"];
125
+ expectFunctionParametersType(setLoading).assert([true]);
126
+ expectFunctionParametersType(setLoading).assert([false]);
127
+ });
128
+
129
+ it("should have setError accepting the error type or null", () => {
130
+ const setError = (() => null) as unknown as GetUserWithErrorReturn["setError"];
131
+ expectFunctionParametersType(setError).assert([
132
+ { code: 400, message: "Bad Request", details: ["field is required"] },
133
+ ]);
134
+ expectFunctionParametersType(setError).assert([null]);
135
+ });
136
+ });
137
+
138
+ describe("return type: event callbacks", () => {
139
+ it("should have onSuccess callback", () => {
140
+ const onSuccess = (() => null) as unknown as GetUsersReturn["onSuccess"];
141
+ expectType<(callback: any) => void>().assert(onSuccess);
142
+ });
143
+
144
+ it("should have onError callback", () => {
145
+ const onError = (() => null) as unknown as GetUsersReturn["onError"];
146
+ expectType<(callback: any) => void>().assert(onError);
147
+ });
148
+
149
+ it("should have onFinished callback", () => {
150
+ const onFinished = (() => null) as unknown as GetUsersReturn["onFinished"];
151
+ expectType<(callback: any) => void>().assert(onFinished);
152
+ });
153
+
154
+ it("should have abort function", () => {
155
+ const abort = (() => null) as unknown as GetUsersReturn["abort"];
156
+ expectType<() => void>().assert(abort);
157
+ });
158
+
159
+ it("should have onRequestStart callback", () => {
160
+ const onRequestStart = (() => null) as unknown as GetUsersReturn["onRequestStart"];
161
+ expectType<(callback: any) => void>().assert(onRequestStart);
162
+ });
163
+
164
+ it("should have onResponseStart callback", () => {
165
+ const onResponseStart = (() => null) as unknown as GetUsersReturn["onResponseStart"];
166
+ expectType<(callback: any) => void>().assert(onResponseStart);
167
+ });
168
+ });
169
+
170
+ describe("return type: refetch and bounce", () => {
171
+ it("should have refetch function", () => {
172
+ const refetch = (() => null) as unknown as GetUsersReturn["refetch"];
173
+ expectType<() => void>().assert(refetch);
174
+ });
175
+
176
+ it("should have bounce state with active and reset", () => {
177
+ const bounce = {} as GetUsersReturn["bounce"];
178
+ expectType<boolean>().assert(bounce.active);
179
+ expectType<() => void>().assert(bounce.reset);
180
+ });
181
+ });
182
+ });
@@ -21,13 +21,13 @@ describe("useFetch [ Basic ]", () => {
21
21
  });
22
22
 
23
23
  beforeEach(() => {
24
- jest.resetModules();
24
+ vi.resetModules();
25
25
  request = createRequest({ cancelable: true });
26
26
  client.clear();
27
27
  });
28
28
 
29
29
  it("should refresh on tab focus", async () => {
30
- const spy = jest.fn();
30
+ const spy = vi.fn();
31
31
  mockRequest(request, { delay: 0 });
32
32
  const response = renderUseFetch(request, { refetchOnFocus: true });
33
33
 
@@ -43,7 +43,7 @@ describe("useFetch [ Basic ]", () => {
43
43
  });
44
44
  });
45
45
  it("should refresh on tab blur", async () => {
46
- const spy = jest.fn();
46
+ const spy = vi.fn();
47
47
  mockRequest(request, { delay: 0 });
48
48
  const response = renderUseFetch(request, { refetchOnBlur: true });
49
49
 
@@ -56,4 +56,76 @@ describe("useFetch [ Basic ]", () => {
56
56
  expect(spy).toHaveBeenCalledTimes(1);
57
57
  });
58
58
  });
59
+ it("should not refetch on focus when disabled is true", async () => {
60
+ const spy = vi.fn();
61
+ mockRequest(request, { delay: 0 });
62
+ const response = renderUseFetch(request, { refetchOnFocus: true, disabled: true });
63
+
64
+ await waitForRender();
65
+
66
+ act(() => {
67
+ response.result.current.onRequestStart(spy);
68
+ client.appManager.setFocused(false);
69
+ client.appManager.setFocused(true);
70
+ });
71
+
72
+ await waitForRender();
73
+ expect(spy).not.toHaveBeenCalled();
74
+ });
75
+ it("should not refetch on blur when disabled is true", async () => {
76
+ const spy = vi.fn();
77
+ mockRequest(request, { delay: 0 });
78
+ const response = renderUseFetch(request, { refetchOnBlur: true, disabled: true });
79
+
80
+ await waitForRender();
81
+
82
+ act(() => {
83
+ response.result.current.onRequestStart(spy);
84
+ window.dispatchEvent(new Event("blur"));
85
+ });
86
+
87
+ await waitForRender();
88
+ expect(spy).not.toHaveBeenCalled();
89
+ });
90
+ it("should not refetch on reconnect when disabled is true", async () => {
91
+ const spy = vi.fn();
92
+ mockRequest(request, { delay: 0 });
93
+ const response = renderUseFetch(request, { refetchOnReconnect: true, disabled: true });
94
+
95
+ await waitForRender();
96
+
97
+ act(() => {
98
+ response.result.current.onRequestStart(spy);
99
+ client.appManager.setOnline(false);
100
+ client.appManager.setOnline(true);
101
+ });
102
+
103
+ await waitForRender();
104
+ expect(spy).not.toHaveBeenCalled();
105
+ });
106
+ it("should stop refetching on focus after disabled changes from false to true", async () => {
107
+ const spy = vi.fn();
108
+ mockRequest(request, { delay: 0 });
109
+ const response = renderUseFetch(request, { refetchOnFocus: true, disabled: false });
110
+
111
+ await waitForRender();
112
+
113
+ act(() => {
114
+ response.result.current.onRequestStart(spy);
115
+ });
116
+
117
+ act(() => {
118
+ response.rerender({ disabled: true });
119
+ });
120
+
121
+ await waitForRender();
122
+
123
+ act(() => {
124
+ client.appManager.setFocused(false);
125
+ client.appManager.setFocused(true);
126
+ });
127
+
128
+ await waitForRender();
129
+ expect(spy).not.toHaveBeenCalled();
130
+ });
59
131
  });
@@ -6,15 +6,15 @@ import { renderUseListener } from "../../utils/use-listener.utils";
6
6
 
7
7
  describe("useListener [ Base ]", () => {
8
8
  const { startServer, stopServer, emitListenerEvent } = createWebsocketMockingServer();
9
- const spy = jest.fn();
9
+ const spy = vi.fn();
10
10
  let listener = createListener();
11
11
 
12
12
  beforeEach(async () => {
13
13
  startServer();
14
14
  listener = createListener();
15
15
  await waitForConnection(listener.socket);
16
- jest.resetModules();
17
- jest.resetAllMocks();
16
+ vi.resetModules();
17
+ vi.resetAllMocks();
18
18
  });
19
19
 
20
20
  afterEach(() => {
@@ -29,7 +29,7 @@ describe("useQueue [ Actions ]", () => {
29
29
  });
30
30
 
31
31
  beforeEach(() => {
32
- jest.resetModules();
32
+ vi.resetModules();
33
33
  request = createRequest({ method: "POST" });
34
34
  client.clear();
35
35
  });
@@ -21,7 +21,7 @@ describe("useQueue [ Base ]", () => {
21
21
  });
22
22
 
23
23
  beforeEach(() => {
24
- jest.resetModules();
24
+ vi.resetModules();
25
25
  client.clear();
26
26
  request = createRequest({ method: "POST" });
27
27
  });
@@ -106,4 +106,262 @@ describe("useQueue [ Base ]", () => {
106
106
  });
107
107
  });
108
108
  });
109
+ describe("given keepFinishedRequests is true", () => {
110
+ describe("when requests finish", () => {
111
+ it("should keep finished requests in the list", async () => {
112
+ mockRequest(request);
113
+ addQueueElement(request, { stop: true });
114
+ const { result } = renderUseQueue(request, { keepFinishedRequests: true });
115
+
116
+ expect(result.current.requests).toHaveLength(1);
117
+
118
+ addQueueElement(request, { stop: true });
119
+
120
+ await waitFor(() => {
121
+ expect(result.current.requests.length).toBeGreaterThanOrEqual(1);
122
+ });
123
+ });
124
+ });
125
+ });
126
+ describe("given queue events fire", () => {
127
+ describe("when a request succeeds", () => {
128
+ it("should mark the request as success", async () => {
129
+ mockRequest(request);
130
+ let requestId = "";
131
+ const { result } = renderUseQueue(request);
132
+
133
+ act(() => {
134
+ requestId = addQueueElement(request, { stop: true });
135
+ });
136
+
137
+ await waitFor(() => {
138
+ expect(result.current.requests).toHaveLength(1);
139
+ });
140
+
141
+ act(() => {
142
+ client.requestManager.events.emitResponse({
143
+ requestId,
144
+ response: {
145
+ data: "ok",
146
+ error: null,
147
+ status: 200,
148
+ success: true,
149
+ extra: {},
150
+ responseTimestamp: +new Date(),
151
+ requestTimestamp: +new Date(),
152
+ },
153
+ request,
154
+ } as any);
155
+ });
156
+
157
+ await waitFor(() => {
158
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
159
+ expect(req?.success).toBe(true);
160
+ });
161
+ });
162
+ });
163
+ describe("when a request fails", () => {
164
+ it("should mark the request as failed", async () => {
165
+ mockRequest(request);
166
+ let requestId = "";
167
+ const { result } = renderUseQueue(request);
168
+
169
+ act(() => {
170
+ requestId = addQueueElement(request, { stop: true });
171
+ });
172
+
173
+ await waitFor(() => {
174
+ expect(result.current.requests).toHaveLength(1);
175
+ });
176
+
177
+ act(() => {
178
+ client.requestManager.events.emitResponse({
179
+ requestId,
180
+ response: {
181
+ data: null,
182
+ error: { message: "fail" },
183
+ status: 500,
184
+ success: false,
185
+ extra: {},
186
+ responseTimestamp: +new Date(),
187
+ requestTimestamp: +new Date(),
188
+ },
189
+ request,
190
+ } as any);
191
+ });
192
+
193
+ await waitFor(() => {
194
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
195
+ expect(req?.failed).toBe(true);
196
+ });
197
+ });
198
+ });
199
+ describe("when a request is aborted", () => {
200
+ it("should mark the request as canceled", async () => {
201
+ mockRequest(request);
202
+ let requestId = "";
203
+ const { result } = renderUseQueue(request);
204
+
205
+ act(() => {
206
+ requestId = addQueueElement(request, { stop: true });
207
+ });
208
+
209
+ await waitFor(() => {
210
+ expect(result.current.requests).toHaveLength(1);
211
+ });
212
+
213
+ act(() => {
214
+ client.requestManager.events.emitAbort({ requestId, request } as any);
215
+ });
216
+
217
+ await waitFor(() => {
218
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
219
+ expect(req?.canceled).toBe(true);
220
+ });
221
+ });
222
+ });
223
+ describe("when a request is removed", () => {
224
+ it("should mark the request as removed", async () => {
225
+ mockRequest(request);
226
+ let requestId = "";
227
+ const { result } = renderUseQueue(request);
228
+
229
+ act(() => {
230
+ requestId = addQueueElement(request, { stop: true });
231
+ });
232
+
233
+ await waitFor(() => {
234
+ expect(result.current.requests).toHaveLength(1);
235
+ });
236
+
237
+ act(() => {
238
+ client.requestManager.events.emitRemove({ requestId, request } as any);
239
+ });
240
+
241
+ await waitFor(() => {
242
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
243
+ expect(req?.removed).toBe(true);
244
+ });
245
+ });
246
+
247
+ it("should not mark non-matching requests when event fires", async () => {
248
+ mockRequest(request);
249
+ let requestId = "";
250
+ const { result } = renderUseQueue(request);
251
+
252
+ act(() => {
253
+ requestId = addQueueElement(request, { stop: true });
254
+ });
255
+
256
+ await waitFor(() => {
257
+ expect(result.current.requests).toHaveLength(1);
258
+ });
259
+
260
+ act(() => {
261
+ client.requestManager.events.emitResponse({
262
+ requestId: "non-matching-id",
263
+ response: {
264
+ data: null,
265
+ error: { message: "fail" },
266
+ status: 500,
267
+ success: false,
268
+ extra: {},
269
+ responseTimestamp: +new Date(),
270
+ requestTimestamp: +new Date(),
271
+ },
272
+ request,
273
+ } as any);
274
+ });
275
+
276
+ await waitFor(() => {
277
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
278
+ expect(req?.failed).toBe(false);
279
+ expect(req?.success).toBe(false);
280
+ });
281
+
282
+ act(() => {
283
+ client.requestManager.events.emitResponse({
284
+ requestId: "non-matching-id-2",
285
+ response: {
286
+ data: "ok",
287
+ error: null,
288
+ status: 200,
289
+ success: true,
290
+ extra: {},
291
+ responseTimestamp: +new Date(),
292
+ requestTimestamp: +new Date(),
293
+ },
294
+ request,
295
+ } as any);
296
+ });
297
+
298
+ await waitFor(() => {
299
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
300
+ expect(req?.success).toBe(false);
301
+ });
302
+
303
+ act(() => {
304
+ client.requestManager.events.emitAbort({ requestId: "non-matching-id-3", request } as any);
305
+ });
306
+
307
+ await waitFor(() => {
308
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
309
+ expect(req?.canceled).toBe(false);
310
+ });
311
+
312
+ act(() => {
313
+ client.requestManager.events.emitRemove({ requestId: "non-matching-id-4", request } as any);
314
+ });
315
+
316
+ await waitFor(() => {
317
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
318
+ expect(req?.removed).toBe(false);
319
+ });
320
+ });
321
+
322
+ it("should not mark as removed if already succeeded", async () => {
323
+ mockRequest(request);
324
+ let requestId = "";
325
+ const { result } = renderUseQueue(request);
326
+
327
+ act(() => {
328
+ requestId = addQueueElement(request, { stop: true });
329
+ });
330
+
331
+ await waitFor(() => {
332
+ expect(result.current.requests).toHaveLength(1);
333
+ });
334
+
335
+ act(() => {
336
+ client.requestManager.events.emitResponse({
337
+ requestId,
338
+ response: {
339
+ data: "ok",
340
+ error: null,
341
+ status: 200,
342
+ success: true,
343
+ extra: {},
344
+ responseTimestamp: +new Date(),
345
+ requestTimestamp: +new Date(),
346
+ },
347
+ request,
348
+ } as any);
349
+ });
350
+
351
+ await waitFor(() => {
352
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
353
+ expect(req?.success).toBe(true);
354
+ });
355
+
356
+ act(() => {
357
+ client.requestManager.events.emitRemove({ requestId, request } as any);
358
+ });
359
+
360
+ await waitFor(() => {
361
+ const req = result.current.requests.find((r: any) => r.requestId === requestId);
362
+ expect(req?.removed).toBe(false);
363
+ });
364
+ });
365
+ });
366
+ });
109
367
  });