@hyper-fetch/react 7.5.3 → 8.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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,10 +1,13 @@
1
1
  import { useDidUpdate } from "@better-hooks/lifecycle";
2
- import { getRequestDispatcher, RequestInstance } from "@hyper-fetch/core";
2
+ import type { RequestInstance } from "@hyper-fetch/core";
3
+ import { getRequestDispatcher } from "@hyper-fetch/core";
3
4
  import { useRef } from "react";
4
5
 
5
- import { UseCacheOptionsType, useCacheDefaultOptions, UseCacheReturnType } from "hooks/use-cache";
6
+ import type { UseCacheOptionsType, UseCacheReturnType } from "hooks/use-cache";
7
+ import { useCacheDefaultOptions } from "hooks/use-cache";
6
8
  import { useRequestEvents, useTrackedState } from "helpers";
7
9
  import { useProvider } from "provider";
10
+ import { createTrackedProxy } from "utils";
8
11
 
9
12
  export const useCache = <T extends RequestInstance>(
10
13
  request: T,
@@ -72,44 +75,33 @@ export const useCache = <T extends RequestInstance>(
72
75
  cache.invalidate(cacheKeys ?? cacheKey);
73
76
  };
74
77
 
75
- return {
76
- get data() {
77
- setRenderKey("data");
78
- return state.data;
79
- },
80
- get error() {
81
- setRenderKey("error");
82
- return state.error;
83
- },
84
- get loading() {
85
- setRenderKey("loading");
86
- return state.loading;
87
- },
88
- get status() {
89
- setRenderKey("status");
90
- return state.status;
91
- },
92
- get success() {
93
- setRenderKey("success");
94
- return state.success;
95
- },
96
- get extra() {
97
- setRenderKey("extra");
98
- return state.extra;
99
- },
100
- get retries() {
101
- setRenderKey("retries");
102
- return state.retries;
103
- },
104
- get responseTimestamp() {
105
- setRenderKey("responseTimestamp");
106
- return state.responseTimestamp;
107
- },
108
- get requestTimestamp() {
109
- setRenderKey("requestTimestamp");
110
- return state.requestTimestamp;
78
+ const trackedKeys = [
79
+ "data",
80
+ "error",
81
+ "loading",
82
+ "status",
83
+ "success",
84
+ "extra",
85
+ "retries",
86
+ "responseTimestamp",
87
+ "requestTimestamp",
88
+ ] as const;
89
+
90
+ return createTrackedProxy(
91
+ {
92
+ data: state.data,
93
+ error: state.error,
94
+ loading: state.loading,
95
+ status: state.status,
96
+ success: state.success,
97
+ extra: state.extra,
98
+ retries: state.retries,
99
+ responseTimestamp: state.responseTimestamp,
100
+ requestTimestamp: state.requestTimestamp,
101
+ ...actions,
102
+ invalidate,
111
103
  },
112
- ...actions,
113
- invalidate,
114
- };
104
+ trackedKeys,
105
+ setRenderKey,
106
+ ) as UseCacheReturnType<T>;
115
107
  };
@@ -1,7 +1,7 @@
1
- import { RequestInstance, ExtractResponseType, ExtractErrorType, CacheValueType } from "@hyper-fetch/core";
1
+ import type { RequestInstance, ExtractResponseType, ExtractErrorType, CacheValueType } from "@hyper-fetch/core";
2
2
 
3
- import { isEqual } from "utils";
4
- import { UseTrackedStateActions, UseTrackedStateType } from "helpers";
3
+ import type { isEqual } from "utils";
4
+ import type { UseTrackedStateActions, UseTrackedStateType } from "helpers";
5
5
 
6
6
  export type UseCacheOptionsType<T extends RequestInstance> = {
7
7
  /**
@@ -1,10 +1,11 @@
1
- import { EmitterInstance, EmitterCallbackErrorType, EmitType } from "@hyper-fetch/sockets";
1
+ import type { EmitterInstance, EmitterCallbackErrorType, EmitType } from "@hyper-fetch/sockets";
2
2
  import { useDidUpdate } from "@better-hooks/lifecycle";
3
3
  import { useRef } from "react";
4
4
 
5
- import { UseEmitterOptionsType } from "hooks/use-emitter";
5
+ import type { UseEmitterOptionsType } from "hooks/use-emitter";
6
6
  import { useSocketState } from "helpers";
7
7
  import { useProvider } from "provider";
8
+ import { createTrackedProxy } from "utils";
8
9
 
9
10
  export const useEmitter = <EmitterType extends EmitterInstance>(
10
11
  emitter: EmitterType,
@@ -63,19 +64,19 @@ export const useEmitter = <EmitterType extends EmitterInstance>(
63
64
  onEventErrorCallback.current = callback;
64
65
  };
65
66
 
66
- return {
67
- get connected() {
68
- setRenderKey("connected");
69
- return state.connected;
70
- },
71
- get connecting() {
72
- setRenderKey("connecting");
73
- return state.connecting;
67
+ const trackedKeys = ["connected", "connecting"] as const;
68
+
69
+ return createTrackedProxy(
70
+ {
71
+ connected: state.connected,
72
+ connecting: state.connecting,
73
+ ...actions,
74
+ ...callbacks,
75
+ onEmit,
76
+ onEmitError,
77
+ emit,
74
78
  },
75
- ...actions,
76
- ...callbacks,
77
- onEmit,
78
- onEmitError,
79
- emit,
80
- };
79
+ trackedKeys,
80
+ setRenderKey,
81
+ );
81
82
  };
@@ -1,17 +1,20 @@
1
- import { Time, RequestInstance, RequiredKeys } from "@hyper-fetch/core";
1
+ import type { RequestInstance, RequiredKeys } from "@hyper-fetch/core";
2
+ import { Time } from "@hyper-fetch/core";
2
3
 
3
- import { UseFetchOptionsType } from "hooks/use-fetch";
4
+ import type { UseFetchOptionsType } from "hooks/use-fetch";
4
5
 
5
6
  type DefaultOptionsType = RequiredKeys<Omit<UseFetchOptionsType<RequestInstance>, "initialResponse">> & {
6
7
  initialResponse: null;
7
8
  };
8
9
 
9
10
  export const useFetchDefaultOptions: DefaultOptionsType = {
11
+ suspense: false,
10
12
  dependencies: [],
11
13
  disabled: false,
12
14
  dependencyTracking: true,
13
15
  revalidate: true,
14
16
  initialResponse: null,
17
+ keepPreviousData: "auto",
15
18
  refresh: false,
16
19
  refreshTime: Time.HOUR,
17
20
  refetchBlurred: true,
@@ -1,17 +1,23 @@
1
1
  import { useDidUpdate, useDidMount, useWillUnmount } from "@better-hooks/lifecycle";
2
2
  import { useDebounce, useThrottle } from "@better-hooks/performance";
3
- import {
3
+ import type {
4
4
  RequestInstance,
5
5
  ExtractAdapterStatusType,
6
6
  ExtractAdapterType,
7
7
  ExtractAdapterExtraType,
8
8
  } from "@hyper-fetch/core";
9
+ import { scopeKey } from "@hyper-fetch/core";
9
10
  import { useRef } from "react";
10
11
 
11
12
  import { useRequestEvents, useTrackedState } from "helpers";
12
- import { UseFetchOptionsType, useFetchDefaultOptions, UseFetchReturnType } from "hooks/use-fetch";
13
+ import type { UseFetchOptionsType, UseFetchReturnType } from "hooks/use-fetch";
14
+ import { useFetchDefaultOptions } from "hooks/use-fetch";
13
15
  import { useProvider } from "provider";
14
- import { getBounceData } from "utils";
16
+ import { createTrackedProxy, getBounceData } from "utils";
17
+
18
+ type SuspenseEntry = { promise: Promise<void>; resolve: () => void; cleanup: () => void };
19
+ const suspensePromiseMap = new Map<string, SuspenseEntry>();
20
+ const suspenseResultMap = new Map<string, { data: any; error: any; status: any; extra: any; success: boolean }>();
15
21
 
16
22
  /**
17
23
  * This hooks aims to retrieve data from server.
@@ -26,11 +32,13 @@ export const useFetch = <R extends RequestInstance>(
26
32
  // Build the configuration options
27
33
  const { config: globalConfig } = useProvider();
28
34
  const {
35
+ suspense,
29
36
  dependencies,
30
37
  disabled,
31
38
  dependencyTracking,
32
39
  revalidate,
33
40
  initialResponse,
41
+ keepPreviousData,
34
42
  refresh,
35
43
  refreshTime,
36
44
  refetchBlurred,
@@ -71,6 +79,7 @@ export const useFetch = <R extends RequestInstance>(
71
79
  initialResponse,
72
80
  deepCompare,
73
81
  dependencyTracking,
82
+ keepPreviousData,
74
83
  disabled,
75
84
  revalidate,
76
85
  });
@@ -106,7 +115,7 @@ export const useFetch = <R extends RequestInstance>(
106
115
  // ******************
107
116
 
108
117
  function handleRefresh() {
109
- if (!refresh) {
118
+ if (!refresh || disabled) {
110
119
  refreshDebounce.reset();
111
120
  return;
112
121
  }
@@ -115,8 +124,9 @@ export const useFetch = <R extends RequestInstance>(
115
124
  const isBlurred = !appManager.isFocused;
116
125
 
117
126
  // If window tab is not active should we refresh the cache
118
- const isFetching = dispatcher.hasRunningRequests(request.queryKey);
119
- const isQueued = dispatcher.getIsActiveQueue(request.queryKey);
127
+ const scopedQueryKey = scopeKey(request.queryKey, request.scope);
128
+ const isFetching = dispatcher.hasRunningRequests(scopedQueryKey);
129
+ const isQueued = dispatcher.getIsActiveQueue(scopedQueryKey);
120
130
  const isActive = isFetching || isQueued;
121
131
  const canRefreshBlurred = isBlurred && refetchBlurred && !isActive;
122
132
  const canRefreshFocused = !isBlurred && !isActive;
@@ -186,19 +196,19 @@ export const useFetch = <R extends RequestInstance>(
186
196
  addLifecycleListeners(request as unknown as R);
187
197
 
188
198
  const focusUnmount = appManager.events.onFocus(() => {
189
- if (refetchOnFocus) {
199
+ if (refetchOnFocus && !disabled) {
190
200
  handleFetch();
191
201
  handleRefresh();
192
202
  }
193
203
  });
194
204
  const blurUnmount = appManager.events.onBlur(() => {
195
- if (refetchOnBlur) {
205
+ if (refetchOnBlur && !disabled) {
196
206
  handleFetch();
197
207
  handleRefresh();
198
208
  }
199
209
  });
200
210
  const onlineUnmount = appManager.events.onOnline(() => {
201
- if (refetchOnReconnect) {
211
+ if (refetchOnReconnect && !disabled) {
202
212
  handleFetch();
203
213
  handleRefresh();
204
214
  }
@@ -227,7 +237,7 @@ export const useFetch = <R extends RequestInstance>(
227
237
  * Initialization of the events related to data exchange with cache and queue
228
238
  * This allows to share the state with other hooks and keep it related
229
239
  */
230
- useDidUpdate(handleMountEvents, [updateKey], true);
240
+ useDidUpdate(handleMountEvents, [updateKey, disabled], true);
231
241
 
232
242
  /**
233
243
  * Initial fetch triggered once data is stale or we use the refetch strategy
@@ -251,46 +261,94 @@ export const useFetch = <R extends RequestInstance>(
251
261
  ignoreReact18DoubleRender.current = true;
252
262
  });
253
263
 
254
- return {
255
- get data() {
256
- setRenderKey("data");
257
- return state.data;
258
- },
259
- get error() {
260
- setRenderKey("error");
261
- return state.error;
262
- },
263
- get loading() {
264
- setRenderKey("loading");
265
- return state.loading;
266
- },
267
- get status() {
268
- setRenderKey("status");
269
- return state.status as ExtractAdapterStatusType<ExtractAdapterType<R>>;
270
- },
271
- get success() {
272
- setRenderKey("success");
273
- return state.success;
274
- },
275
- get extra() {
276
- setRenderKey("extra");
277
- return state.extra as ExtractAdapterExtraType<ExtractAdapterType<R>>;
278
- },
279
- get retries() {
280
- setRenderKey("retries");
281
- return state.retries;
282
- },
283
- get responseTimestamp() {
284
- setRenderKey("responseTimestamp");
285
- return state.responseTimestamp;
286
- },
287
- get requestTimestamp() {
288
- setRenderKey("requestTimestamp");
289
- return state.requestTimestamp;
264
+ // ******************
265
+ // Suspense
266
+ // ******************
267
+ if (suspense && !disabled) {
268
+ // Apply any cached suspense result (covers error responses that aren't stored in cache)
269
+ const suspenseResult = suspenseResultMap.get(cacheKey);
270
+ if (suspenseResult) {
271
+ suspenseResultMap.delete(cacheKey);
272
+ if (suspenseResult.data !== null) state.data = suspenseResult.data;
273
+ if (suspenseResult.error !== null) state.error = suspenseResult.error;
274
+ if (suspenseResult.status !== null) state.status = suspenseResult.status;
275
+ if (suspenseResult.extra !== null) state.extra = suspenseResult.extra;
276
+ state.success = suspenseResult.success;
277
+ }
278
+
279
+ const hasData = state.data !== null || state.error !== null;
280
+
281
+ if (!hasData) {
282
+ let entry = suspensePromiseMap.get(cacheKey);
283
+ if (!entry) {
284
+ let resolvePromise: () => void;
285
+ const promise = new Promise<void>((r) => {
286
+ resolvePromise = r;
287
+ });
288
+
289
+ const unsubscribe = cache.events.onDataByKey(cacheKey, (cacheData: any) => {
290
+ suspenseResultMap.set(cacheKey, {
291
+ data: cacheData.data ?? null,
292
+ error: cacheData.error ?? null,
293
+ status: cacheData.status ?? null,
294
+ extra: cacheData.extra ?? null,
295
+ success: cacheData.success ?? false,
296
+ });
297
+ resolvePromise();
298
+ unsubscribe();
299
+ suspensePromiseMap.delete(cacheKey);
300
+ });
301
+
302
+ entry = { promise, resolve: resolvePromise!, cleanup: unsubscribe };
303
+ suspensePromiseMap.set(cacheKey, entry);
304
+ }
305
+
306
+ // Ensure the request is dispatched before suspending —
307
+ // effects never run when a component suspends.
308
+ if (!dispatcher.hasRunningRequests(queryKey)) {
309
+ dispatcher.add(request as unknown as R);
310
+ }
311
+
312
+ throw entry.promise;
313
+ }
314
+
315
+ // Data has arrived — clean up any leftover entry
316
+ const entry = suspensePromiseMap.get(cacheKey);
317
+ if (entry) {
318
+ entry.cleanup();
319
+ suspensePromiseMap.delete(cacheKey);
320
+ }
321
+ }
322
+
323
+ const trackedKeys = [
324
+ "data",
325
+ "error",
326
+ "loading",
327
+ "status",
328
+ "success",
329
+ "extra",
330
+ "retries",
331
+ "responseTimestamp",
332
+ "requestTimestamp",
333
+ ] as const;
334
+
335
+ return createTrackedProxy(
336
+ {
337
+ data: state.data,
338
+ error: state.error,
339
+ loading: state.loading,
340
+ status: state.status as ExtractAdapterStatusType<ExtractAdapterType<R>>,
341
+ success: state.success,
342
+ extra: state.extra as ExtractAdapterExtraType<ExtractAdapterType<R>>,
343
+ retries: state.retries,
344
+ responseTimestamp: state.responseTimestamp,
345
+ requestTimestamp: state.requestTimestamp,
346
+ bounce: getBounceData(bounceData),
347
+ ...actions,
348
+ ...(callbacks as any),
349
+ refetch,
290
350
  },
291
- bounce: getBounceData(bounceData),
292
- ...actions,
293
- ...(callbacks as any),
294
- refetch,
295
- };
351
+ trackedKeys,
352
+ setRenderKey,
353
+ ) as UseFetchReturnType<R>;
296
354
  };
@@ -1,7 +1,7 @@
1
- import { RequestInstance, NullableType, ExtractAdapterResolvedType } from "@hyper-fetch/core";
1
+ import type { RequestInstance, NullableType, ExtractAdapterResolvedType } from "@hyper-fetch/core";
2
2
 
3
- import { UseRequestEventsActionsType, UseTrackedStateActions, UseTrackedStateType } from "helpers";
4
- import { isEqual } from "utils";
3
+ import type { UseRequestEventsActionsType, UseTrackedStateActions, UseTrackedStateType } from "helpers";
4
+ import type { isEqual } from "utils";
5
5
 
6
6
  // export type UseFetchCastRequest<R extends RequestInstance> = ExtendRequest<
7
7
  // R,
@@ -15,6 +15,12 @@ import { isEqual } from "utils";
15
15
  // export type UseFetchRequest<R extends RequestInstance> = R extends UseFetchCastRequest<R> ? R : UseFetchCastRequest<R>;
16
16
 
17
17
  export type UseFetchOptionsType<R extends RequestInstance> = {
18
+ /**
19
+ * Enable React Suspense mode. When true, the hook throws a Promise while loading,
20
+ * which is caught by the nearest Suspense boundary. The component re-renders
21
+ * with data available once the request resolves.
22
+ */
23
+ suspense?: boolean;
18
24
  /**
19
25
  * Refetch dependencies
20
26
  */
@@ -35,6 +41,15 @@ export type UseFetchOptionsType<R extends RequestInstance> = {
35
41
  * If cache is empty we can use placeholder data.
36
42
  */
37
43
  initialResponse?: NullableType<Partial<ExtractAdapterResolvedType<R>>>;
44
+ /**
45
+ * Controls what happens to the current state when the cache key changes (e.g. params or query params change).
46
+ *
47
+ * - "auto" (default) — Smart mode: clears state when URL params change (different resource),
48
+ * preserves state when only query params change (pagination/filtering).
49
+ * - "preserve" — Always keeps previous data visible until new data arrives.
50
+ * - "clean" — Always resets state to initial values when cache key changes.
51
+ */
52
+ keepPreviousData?: "auto" | "preserve" | "clean";
38
53
  /**
39
54
  * Enable/disable refresh data
40
55
  */
@@ -1,10 +1,11 @@
1
1
  import { useDidUpdate, useWillUnmount } from "@better-hooks/lifecycle";
2
- import { ListenerInstance, ExtractListenerResponseType } from "@hyper-fetch/sockets";
2
+ import type { ListenerInstance, ExtractListenerResponseType } from "@hyper-fetch/sockets";
3
3
  import { useRef } from "react";
4
4
 
5
5
  import { useSocketState } from "helpers";
6
- import { UseListenerOptionsType } from "hooks/use-listener";
6
+ import type { UseListenerOptionsType } from "hooks/use-listener";
7
7
  import { useProvider } from "provider";
8
+ import { createTrackedProxy } from "utils";
8
9
 
9
10
  export const useListener = <ListenerType extends ListenerInstance>(
10
11
  listener: ListenerType,
@@ -63,30 +64,21 @@ export const useListener = <ListenerType extends ListenerInstance>(
63
64
  stopListener();
64
65
  });
65
66
 
66
- return {
67
- get data() {
68
- setRenderKey("data");
69
- return state.data;
70
- },
71
- get extra() {
72
- setRenderKey("extra");
73
- return state.extra;
74
- },
75
- get connected() {
76
- setRenderKey("connected");
77
- return state.connected;
78
- },
79
- get connecting() {
80
- setRenderKey("connecting");
81
- return state.connecting;
82
- },
83
- get timestamp() {
84
- setRenderKey("timestamp");
85
- return state.timestamp;
67
+ const trackedKeys = ["data", "extra", "connected", "connecting", "timestamp"] as const;
68
+
69
+ return createTrackedProxy(
70
+ {
71
+ data: state.data,
72
+ extra: state.extra,
73
+ connected: state.connected,
74
+ connecting: state.connecting,
75
+ timestamp: state.timestamp,
76
+ ...actions,
77
+ ...callbacks,
78
+ ...additionalCallbacks,
79
+ listen,
86
80
  },
87
- ...actions,
88
- ...callbacks,
89
- ...additionalCallbacks,
90
- listen,
91
- };
81
+ trackedKeys,
82
+ setRenderKey,
83
+ );
92
84
  };
@@ -1,6 +1,6 @@
1
- import { RequiredKeys } from "@hyper-fetch/core";
1
+ import type { RequiredKeys } from "@hyper-fetch/core";
2
2
 
3
- import { UseQueueOptionsType } from "hooks/use-queue";
3
+ import type { UseQueueOptionsType } from "hooks/use-queue";
4
4
 
5
5
  export const useQueueDefaultOptions: RequiredKeys<UseQueueOptionsType> = {
6
6
  dispatcherType: "auto",
@@ -1,7 +1,9 @@
1
- import { RequestInstance, getRequestDispatcher, QueueItemType, QueueDataType } from "@hyper-fetch/core";
1
+ import type { RequestInstance, ResolvedQueueItemType, QueueDataType, QueueItemType } from "@hyper-fetch/core";
2
+ import { Request, getRequestDispatcher, scopeKey } from "@hyper-fetch/core";
2
3
  import { useState, useEffect, useCallback } from "react";
3
4
 
4
- import { UseQueueOptionsType, useQueueDefaultOptions, QueueRequest, UseQueueReturnType } from "hooks/use-queue";
5
+ import type { UseQueueOptionsType, QueueRequest, UseQueueReturnType } from "hooks/use-queue";
6
+ import { useQueueDefaultOptions } from "hooks/use-queue";
5
7
  import { useProvider } from "provider";
6
8
 
7
9
  const canUpdate = (
@@ -31,7 +33,9 @@ export const useQueue = <Request extends RequestInstance>(
31
33
  ...options,
32
34
  };
33
35
 
34
- const { abortKey, queryKey, client } = request;
36
+ const { abortKey: rawAbortKey, queryKey: rawQueryKey, scope, client } = request;
37
+ const abortKey = scopeKey(rawAbortKey, scope);
38
+ const queryKey = scopeKey(rawQueryKey, scope);
35
39
  const { requestManager } = client;
36
40
 
37
41
  const [dispatcher] = getRequestDispatcher(request, dispatcherType);
@@ -44,7 +48,10 @@ export const useQueue = <Request extends RequestInstance>(
44
48
  // ******************
45
49
 
46
50
  const createRequestsArray = useCallback(
47
- (queueElements: QueueItemType<Request>[], prevRequests?: QueueRequest<Request>[]): QueueRequest<Request>[] => {
51
+ (
52
+ queueElements: ResolvedQueueItemType<Request>[],
53
+ prevRequests?: QueueRequest<Request>[],
54
+ ): QueueRequest<Request>[] => {
48
55
  const newRequests = queueElements
49
56
  // Keep only unique requests
50
57
  .filter((el) => !prevRequests?.some((prevEl) => prevEl.requestId === el.requestId))
@@ -106,12 +113,24 @@ export const useQueue = <Request extends RequestInstance>(
106
113
  setRequests(createRequestsArray(requestQueue.requests));
107
114
  };
108
115
 
116
+ const resolveQueueItems = useCallback(
117
+ (items: QueueItemType<Request>[]): ResolvedQueueItemType<Request>[] => {
118
+ return items.map((item) => {
119
+ if (item.request instanceof Request) {
120
+ return item as ResolvedQueueItemType<Request>;
121
+ }
122
+ return { ...item, request: client.fromJSON(item.request) as Request };
123
+ });
124
+ },
125
+ [client],
126
+ );
127
+
109
128
  const updateQueueState = useCallback(
110
129
  (values: QueueDataType<Request>) => {
111
130
  setStopped(values.stopped);
112
- setRequests((prev) => createRequestsArray(values.requests, prev));
131
+ setRequests((prev) => createRequestsArray(resolveQueueItems(values.requests), prev));
113
132
  },
114
- [createRequestsArray],
133
+ [createRequestsArray, resolveQueueItems],
115
134
  );
116
135
 
117
136
  // ******************
@@ -1,11 +1,17 @@
1
- import { ProgressType, RequestInstance, QueueItemType, Dispatcher, ExtractAdapterType } from "@hyper-fetch/core";
1
+ import type {
2
+ ProgressType,
3
+ RequestInstance,
4
+ ResolvedQueueItemType,
5
+ Dispatcher,
6
+ ExtractAdapterType,
7
+ } from "@hyper-fetch/core";
2
8
 
3
9
  export type UseQueueOptionsType = {
4
10
  dispatcherType?: "auto" | "fetch" | "submit";
5
11
  keepFinishedRequests?: boolean;
6
12
  };
7
13
 
8
- export type QueueRequest<Request extends RequestInstance> = QueueItemType<Request> & {
14
+ export type QueueRequest<Request extends RequestInstance> = ResolvedQueueItemType<Request> & {
9
15
  failed?: boolean;
10
16
  canceled?: boolean;
11
17
  removed?: boolean;
@@ -0,0 +1,2 @@
1
+ export * from "./use-stream.hooks";
2
+ export * from "./use-stream.types";