@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
@@ -0,0 +1,164 @@
1
+ import type { RequestInstance, ExtractAdapterExtraType, ExtractAdapterType, ExtractErrorType } from "@hyper-fetch/core";
2
+ import { scopeKey } from "@hyper-fetch/core";
3
+ import { useCallback, useEffect, useRef, useSyncExternalStore } from "react";
4
+
5
+ import type { UseStreamOptionsType, UseStreamReturnType } from "./use-stream.types";
6
+
7
+ type StreamState<T extends RequestInstance> = {
8
+ text: string;
9
+ chunks: Uint8Array[];
10
+ streaming: boolean;
11
+ done: boolean;
12
+ error: ExtractErrorType<T> | null;
13
+ extra: ExtractAdapterExtraType<ExtractAdapterType<T>> | null;
14
+ status: number | null;
15
+ };
16
+
17
+ const getInitialState = <T extends RequestInstance>(): StreamState<T> => ({
18
+ text: "",
19
+ chunks: [],
20
+ streaming: false,
21
+ done: false,
22
+ error: null,
23
+ extra: null,
24
+ status: null,
25
+ });
26
+
27
+ /**
28
+ * Hook for consuming streaming responses chunk-by-chunk.
29
+ * Works with any request that uses the fetch adapter's `streaming: true` option.
30
+ *
31
+ * Provides both accumulated `text` (for LLM/SSE use cases) and raw `chunks`
32
+ * (for binary streaming / file downloads).
33
+ */
34
+ export const useStream = <T extends RequestInstance>(
35
+ request: T,
36
+ options?: UseStreamOptionsType,
37
+ ): UseStreamReturnType<T> => {
38
+ const { autoStart = false } = options || {};
39
+
40
+ const state = useRef<StreamState<T>>(getInitialState<T>());
41
+ const abortRef = useRef<(() => void) | null>(null);
42
+ const startedRef = useRef(false);
43
+
44
+ // useSyncExternalStore for re-renders
45
+ const versionRef = useRef(0);
46
+ const listenerRef = useRef<(() => void) | null>(null);
47
+
48
+ const subscribe = useCallback((listener: () => void) => {
49
+ listenerRef.current = listener;
50
+ return () => {
51
+ listenerRef.current = null;
52
+ };
53
+ }, []);
54
+
55
+ const getSnapshot = useCallback(() => versionRef.current, []);
56
+
57
+ useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
58
+
59
+ const emitChange = () => {
60
+ versionRef.current += 1;
61
+ listenerRef.current?.();
62
+ };
63
+
64
+ const consumeStream = async (stream: ReadableStream<Uint8Array>) => {
65
+ const reader = stream.getReader();
66
+ const decoder = new TextDecoder();
67
+
68
+ try {
69
+ // eslint-disable-next-line no-constant-condition
70
+ while (true) {
71
+ // eslint-disable-next-line no-await-in-loop
72
+ const { done, value } = await reader.read();
73
+ if (done) break;
74
+
75
+ state.current.chunks = [...state.current.chunks, value];
76
+ state.current.text += decoder.decode(value, { stream: true });
77
+ emitChange();
78
+ }
79
+
80
+ state.current.streaming = false;
81
+ state.current.done = true;
82
+ emitChange();
83
+ } catch (err) {
84
+ state.current.streaming = false;
85
+ state.current.error = err as ExtractErrorType<T>;
86
+ emitChange();
87
+ }
88
+ };
89
+
90
+ const start = useCallback(() => {
91
+ if (state.current.streaming) return;
92
+
93
+ state.current = {
94
+ ...getInitialState<T>(),
95
+ streaming: true,
96
+ };
97
+ emitChange();
98
+
99
+ const streamingRequest = request.setOptions({ streaming: true } as any);
100
+
101
+ streamingRequest.send().then((response) => {
102
+ const { data, error, status, extra } = response;
103
+
104
+ state.current.status = status as number | null;
105
+ state.current.extra = extra as ExtractAdapterExtraType<ExtractAdapterType<T>> | null;
106
+
107
+ if (error) {
108
+ state.current.streaming = false;
109
+ state.current.error = error;
110
+ emitChange();
111
+ return;
112
+ }
113
+
114
+ if (data && typeof (data as any).getReader === "function") {
115
+ consumeStream(data as unknown as ReadableStream<Uint8Array>);
116
+ } else {
117
+ state.current.streaming = false;
118
+ state.current.text = typeof data === "string" ? data : JSON.stringify(data);
119
+ state.current.done = true;
120
+ emitChange();
121
+ }
122
+ });
123
+
124
+ abortRef.current = () => {
125
+ request.client.requestManager.abortByKey(scopeKey(request.abortKey, request.scope));
126
+ };
127
+ // eslint-disable-next-line react-hooks/exhaustive-deps
128
+ }, [request]);
129
+
130
+ const abort = useCallback(() => {
131
+ abortRef.current?.();
132
+ state.current.streaming = false;
133
+ emitChange();
134
+ // eslint-disable-next-line react-hooks/exhaustive-deps
135
+ }, []);
136
+
137
+ const reset = useCallback(() => {
138
+ abortRef.current?.();
139
+ state.current = getInitialState<T>();
140
+ startedRef.current = false;
141
+ emitChange();
142
+ // eslint-disable-next-line react-hooks/exhaustive-deps
143
+ }, []);
144
+
145
+ useEffect(() => {
146
+ if (autoStart && !startedRef.current) {
147
+ startedRef.current = true;
148
+ start();
149
+ }
150
+ }, [autoStart, start]);
151
+
152
+ return {
153
+ text: state.current.text,
154
+ chunks: state.current.chunks,
155
+ streaming: state.current.streaming,
156
+ done: state.current.done,
157
+ error: state.current.error,
158
+ extra: state.current.extra,
159
+ status: state.current.status,
160
+ start,
161
+ abort,
162
+ reset,
163
+ };
164
+ };
@@ -0,0 +1,53 @@
1
+ import type { RequestInstance, ExtractErrorType, ExtractAdapterExtraType, ExtractAdapterType } from "@hyper-fetch/core";
2
+
3
+ export type UseStreamOptionsType = {
4
+ /**
5
+ * When true, the stream starts automatically on mount. Defaults to false.
6
+ */
7
+ autoStart?: boolean;
8
+ };
9
+
10
+ export type UseStreamReturnType<T extends RequestInstance> = {
11
+ /**
12
+ * Accumulated text from all stream chunks decoded as UTF-8.
13
+ * Useful for text-based streaming like LLM responses or SSE.
14
+ */
15
+ text: string;
16
+ /**
17
+ * Raw binary chunks received from the stream.
18
+ * Useful for binary streaming like file downloads.
19
+ */
20
+ chunks: Uint8Array[];
21
+ /**
22
+ * Whether the stream is currently being consumed.
23
+ */
24
+ streaming: boolean;
25
+ /**
26
+ * Whether the stream has finished (all chunks consumed).
27
+ */
28
+ done: boolean;
29
+ /**
30
+ * Error from the request or stream consumption.
31
+ */
32
+ error: ExtractErrorType<T> | null;
33
+ /**
34
+ * Response extra metadata (headers, etc.).
35
+ */
36
+ extra: ExtractAdapterExtraType<ExtractAdapterType<T>> | null;
37
+ /**
38
+ * HTTP status code from the response.
39
+ */
40
+ status: number | null;
41
+ /**
42
+ * Start consuming the stream. The request is sent with `streaming: true`.
43
+ */
44
+ start: () => void;
45
+ /**
46
+ * Abort the ongoing stream.
47
+ */
48
+ abort: () => void;
49
+ /**
50
+ * Reset state to initial values, allowing a fresh stream.
51
+ */
52
+ reset: () => void;
53
+ };
@@ -1,6 +1,6 @@
1
- import { RequestInstance, RequiredKeys } from "@hyper-fetch/core";
1
+ import type { RequestInstance, RequiredKeys } from "@hyper-fetch/core";
2
2
 
3
- import { UseSubmitOptionsType } from "./use-submit.types";
3
+ import type { UseSubmitOptionsType } from "./use-submit.types";
4
4
 
5
5
  type DefaultOptionsType = RequiredKeys<Omit<UseSubmitOptionsType<RequestInstance>, "initialResponse">> & {
6
6
  initialResponse: null;
@@ -1,7 +1,6 @@
1
- import {
1
+ import type {
2
2
  ExtractAdapterResolvedType,
3
3
  RequestInstance,
4
- sendRequest,
5
4
  ResponseType,
6
5
  ExtractResponseType,
7
6
  ExtractErrorType,
@@ -9,14 +8,17 @@ import {
9
8
  RequestSendType,
10
9
  ExtractAdapterType,
11
10
  } from "@hyper-fetch/core";
11
+ import { sendRequest } from "@hyper-fetch/core";
12
12
  import { useDidMount } from "@better-hooks/lifecycle";
13
13
  import { useDebounce, useThrottle } from "@better-hooks/performance";
14
14
  import { useMemo, useRef } from "react";
15
15
 
16
- import { UseSubmitOptionsType, useSubmitDefaultOptions, UseSubmitReturnType } from "hooks/use-submit";
16
+ import type { UseSubmitOptionsType, UseSubmitReturnType } from "hooks/use-submit";
17
+ import { useSubmitDefaultOptions } from "hooks/use-submit";
18
+ import type { UseTrackedStateType } from "helpers";
17
19
  import { useTrackedState, useRequestEvents } from "helpers";
18
20
  import { useProvider } from "provider";
19
- import { getBounceData } from "utils";
21
+ import { createTrackedProxy, getBounceData } from "utils";
20
22
 
21
23
  /**
22
24
  * This hooks aims to mutate data on the server.
@@ -119,7 +121,7 @@ export const useSubmit = <RequestType extends RequestInstance>(
119
121
  dispatcherType: "submit",
120
122
  ...(submitOptions as RequestSendOptionsType<RequestType>),
121
123
  onBeforeSent: (data) => {
122
- addLifecycleListeners(requestClone, data.requestId);
124
+ addLifecycleListeners(requestClone, data.requestId, data.mutationContext);
123
125
  submitOptions?.onBeforeSent?.(data);
124
126
  },
125
127
  };
@@ -199,48 +201,41 @@ export const useSubmit = <RequestType extends RequestInstance>(
199
201
  addCacheDataListener(request);
200
202
  });
201
203
 
202
- return {
203
- submit: handleSubmit,
204
- get data() {
205
- setRenderKey("data");
206
- return state.data;
207
- },
208
- get error() {
209
- setRenderKey("error");
210
- return state.error;
211
- },
212
- get submitting() {
213
- setRenderKey("loading");
214
- return state.loading;
215
- },
216
- get status() {
217
- setRenderKey("status");
218
- return state.status;
219
- },
220
- get success() {
221
- setRenderKey("success");
222
- return state.success;
223
- },
224
- get extra() {
225
- setRenderKey("extra");
226
- return state.extra;
227
- },
228
- get retries() {
229
- setRenderKey("retries");
230
- return state.retries;
231
- },
232
- get responseTimestamp() {
233
- setRenderKey("responseTimestamp");
234
- return state.responseTimestamp;
235
- },
236
- get requestTimestamp() {
237
- setRenderKey("requestTimestamp");
238
- return state.requestTimestamp;
239
- },
240
- abort: callbacks.abort,
241
- ...actions,
242
- ...handlers,
243
- bounce: getBounceData(bounceData),
244
- refetch,
204
+ const setSubmitRenderKey = (key: string) => {
205
+ setRenderKey((key === "submitting" ? "loading" : key) as keyof UseTrackedStateType);
245
206
  };
207
+
208
+ const trackedKeys = [
209
+ "data",
210
+ "error",
211
+ "submitting",
212
+ "status",
213
+ "success",
214
+ "extra",
215
+ "retries",
216
+ "responseTimestamp",
217
+ "requestTimestamp",
218
+ ] as const;
219
+
220
+ return createTrackedProxy(
221
+ {
222
+ submit: handleSubmit,
223
+ data: state.data,
224
+ error: state.error,
225
+ submitting: state.loading,
226
+ status: state.status,
227
+ success: state.success,
228
+ extra: state.extra,
229
+ retries: state.retries,
230
+ responseTimestamp: state.responseTimestamp,
231
+ requestTimestamp: state.requestTimestamp,
232
+ abort: callbacks.abort,
233
+ ...actions,
234
+ ...handlers,
235
+ bounce: getBounceData(bounceData),
236
+ refetch,
237
+ },
238
+ trackedKeys,
239
+ setSubmitRenderKey,
240
+ ) as UseSubmitReturnType<RequestType>;
246
241
  };
@@ -1,12 +1,12 @@
1
- import { ExtractAdapterResolvedType, NullableType, RequestInstance, RequestSendType } from "@hyper-fetch/core";
1
+ import type { ExtractAdapterResolvedType, NullableType, RequestInstance, RequestSendType } from "@hyper-fetch/core";
2
2
 
3
- import { isEqual } from "utils";
4
- import {
5
- OnErrorCallbackType,
6
- OnFinishedCallbackType,
3
+ import type { isEqual } from "utils";
4
+ import type {
7
5
  OnProgressCallbackType,
8
6
  OnStartCallbackType,
9
7
  OnSuccessCallbackType,
8
+ OnErrorCallbackType,
9
+ OnFinishedCallbackType,
10
10
  UseTrackedStateType,
11
11
  UseTrackedStateActions,
12
12
  } from "helpers";
@@ -69,15 +69,15 @@ export type UseSubmitReturnType<RequestType extends RequestInstance> = Omit<
69
69
  */
70
70
  abort: () => void;
71
71
  /**
72
- * Helper hook listening on success response.
72
+ * Helper hook listening on success response. Includes `mutationContext` when `setOptimistic` is configured.
73
73
  */
74
74
  onSubmitSuccess: (callback: OnSuccessCallbackType<RequestType>) => void;
75
75
  /**
76
- * Helper hook listening on error response.
76
+ * Helper hook listening on error response. Includes `mutationContext` when `setOptimistic` is configured.
77
77
  */
78
78
  onSubmitError: (callback: OnErrorCallbackType<RequestType>) => void;
79
79
  /**
80
- * Helper hook listening on any response.
80
+ * Helper hook listening on any response. Includes `mutationContext` when `setOptimistic` is configured.
81
81
  */
82
82
  onSubmitFinished: (callback: OnFinishedCallbackType<RequestType>) => void;
83
83
  /**
@@ -97,7 +97,7 @@ export type UseSubmitReturnType<RequestType extends RequestInstance> = Omit<
97
97
  */
98
98
  onSubmitUploadProgress: (callback: OnProgressCallbackType) => void;
99
99
  /**
100
- * Helper hook listening on aborting of requests. Abort events are not triggering onError callbacks.
100
+ * Helper hook listening on aborting of requests. Includes `mutationContext` when `setOptimistic` is configured. Abort events are not triggering onError callbacks.
101
101
  */
102
102
  onSubmitAbort: (callback: OnErrorCallbackType<RequestType>) => void;
103
103
  /**
package/src/index.ts CHANGED
@@ -2,6 +2,7 @@ export * from "./hooks/use-fetch";
2
2
  export * from "./hooks/use-submit";
3
3
  export * from "./hooks/use-queue";
4
4
  export * from "./hooks/use-cache";
5
+ export * from "./hooks/use-stream";
5
6
  export * from "./hooks/use-listener";
6
7
  export * from "./hooks/use-emitter";
7
8
  export * from "./hooks/use-app-manager";
@@ -1,6 +1,6 @@
1
1
  import React, { useContext, useMemo, useState } from "react";
2
2
 
3
- import { ProviderProps, ProviderValueType } from "./provider.types";
3
+ import type { ProviderProps, ProviderValueType } from "./provider.types";
4
4
 
5
5
  const ConfigContext = React.createContext<ProviderValueType>({
6
6
  config: {},
@@ -1,12 +1,12 @@
1
- import { RequestInstance } from "@hyper-fetch/core";
2
- import React from "react";
1
+ import type { RequestInstance } from "@hyper-fetch/core";
2
+ import type React from "react";
3
3
 
4
- import { UseSubmitOptionsType } from "hooks/use-submit";
5
- import { UseCacheOptionsType } from "hooks/use-cache";
6
- import { UseQueueOptionsType } from "hooks/use-queue";
7
- import { UseListenerOptionsType } from "hooks/use-listener";
8
- import { UseEmitterOptionsType } from "hooks/use-emitter";
9
- import { UseFetchOptionsType } from "hooks/use-fetch";
4
+ import type { UseSubmitOptionsType } from "hooks/use-submit";
5
+ import type { UseCacheOptionsType } from "hooks/use-cache";
6
+ import type { UseQueueOptionsType } from "hooks/use-queue";
7
+ import type { UseListenerOptionsType } from "hooks/use-listener";
8
+ import type { UseEmitterOptionsType } from "hooks/use-emitter";
9
+ import type { UseFetchOptionsType } from "hooks/use-fetch";
10
10
 
11
11
  export type ProviderOptionsType = {
12
12
  useFetchConfig?: Partial<UseFetchOptionsType<RequestInstance>>;
@@ -1,2 +1,3 @@
1
1
  export * from "./deep-equal.utils";
2
2
  export * from "./bounce.utils";
3
+ export * from "./tracked-proxy.utils";
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Wraps a plain object in a Proxy that calls `setRenderKey` when tracked properties are accessed.
3
+ * Unlike getter-based tracking, Proxy-wrapped objects display their actual values in console.log,
4
+ * making debugging significantly easier while preserving field-level dependency tracking.
5
+ */
6
+ export const createTrackedProxy = <T extends Record<string, unknown>, K extends string>(
7
+ target: T,
8
+ trackedKeys: ReadonlyArray<K>,
9
+ setRenderKey: (key: K) => void,
10
+ ): T => {
11
+ return new Proxy(target, {
12
+ get(obj, prop, receiver) {
13
+ if (typeof prop === "string" && trackedKeys.includes(prop as K)) {
14
+ setRenderKey(prop as K);
15
+ }
16
+ return Reflect.get(obj, prop, receiver);
17
+ },
18
+ });
19
+ };
package/tsconfig.json CHANGED
@@ -5,5 +5,5 @@
5
5
  "baseUrl": "./src",
6
6
  "jsx": "react-jsx"
7
7
  },
8
- "exclude": ["node_modules", "dist", "jest.config.ts", "__tests__"]
8
+ "exclude": ["node_modules", "dist", "vite.config.ts", "__tests__"]
9
9
  }
package/vite.config.ts ADDED
@@ -0,0 +1,45 @@
1
+ /// <reference types="vitest/config" />
2
+ import { defineConfig } from "vite";
3
+ import dts from "vite-plugin-dts";
4
+ import tsconfigPaths from "vite-tsconfig-paths";
5
+ import path from "path";
6
+ import { getDtsCompilerOptionsForPackage } from "../../scripts/vite-dts-internal-paths";
7
+ import { getRollupExternalsFromPackageJson } from "../../scripts/vite-lib-externals-from-package";
8
+
9
+ export default defineConfig({
10
+ build: {
11
+ lib: {
12
+ entry: "src/index.ts",
13
+ formats: ["es"],
14
+ fileName: "index",
15
+ },
16
+ sourcemap: true,
17
+ minify: false,
18
+ rollupOptions: {
19
+ external: getRollupExternalsFromPackageJson(__dirname),
20
+ },
21
+ },
22
+ plugins: [
23
+ dts({
24
+ entryRoot: "src",
25
+ compilerOptions: getDtsCompilerOptionsForPackage(__dirname),
26
+ }),
27
+ tsconfigPaths(),
28
+ ],
29
+ test: {
30
+ globals: true,
31
+ environment: "jsdom",
32
+ setupFiles: ["./__tests__/vitest.setup.ts"],
33
+ include: ["__tests__/**/*.spec.{ts,tsx}", "src/**/*.spec.{ts,tsx}"],
34
+ coverage: {
35
+ provider: "v8",
36
+ include: ["src/**/*.{ts,tsx}"],
37
+ exclude: ["**/*.spec.*", "**/types.*", "**/constants.*", "**/index.ts"],
38
+ },
39
+ alias: {
40
+ "@hyper-fetch/core": path.resolve(__dirname, "../core/src/index.ts"),
41
+ "@hyper-fetch/sockets": path.resolve(__dirname, "../sockets/src/index.ts"),
42
+ "@hyper-fetch/testing": path.resolve(__dirname, "../testing/src/index.ts"),
43
+ },
44
+ },
45
+ });
package/.eslintrc.json DELETED
@@ -1,11 +0,0 @@
1
- {
2
- "extends": ["plugin:@nx/react", "../../.eslintrc.js"],
3
- "parserOptions": {
4
- "project": ["./tsconfig.json"]
5
- },
6
- "rules": {
7
- "react/jsx-props-no-spreading": 0,
8
- "react/require-default-props": 0
9
- },
10
- "ignorePatterns": ["dist/", "coverage/", "jest.config.ts", "/*.js"]
11
- }
@@ -1,37 +0,0 @@
1
- import { createHttpMockingServer } from "@hyper-fetch/testing";
2
-
3
- import { client } from "../../utils";
4
-
5
- const { resetMocks, startServer, stopServer } = createHttpMockingServer();
6
-
7
- describe("useFetch [ Suspense ]", () => {
8
- beforeAll(() => {
9
- startServer();
10
- });
11
-
12
- afterEach(() => {
13
- resetMocks();
14
- });
15
-
16
- afterAll(() => {
17
- stopServer();
18
- });
19
-
20
- beforeEach(() => {
21
- jest.resetModules();
22
- client.clear();
23
- });
24
-
25
- it("should render fallback", async () => {
26
- // TODO
27
- });
28
- it("should render multiple fallbacks", async () => {
29
- // TODO
30
- });
31
- it("should throw errors", async () => {
32
- // TODO
33
- });
34
- it("should render cached data with error", async () => {
35
- // TODO
36
- });
37
- });
@@ -1 +0,0 @@
1
- import "jest-extended";
@@ -1,9 +0,0 @@
1
- // jest-dom adds custom jest matchers for asserting on DOM nodes.
2
- // allows you to do things like:
3
- // expect(element).toHaveTextContent(/react/i)
4
- // learn more: https://github.com/testing-library/jest-dom
5
- import "@testing-library/jest-dom";
6
-
7
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
8
- // @ts-ignore
9
- global.IS_REACT_ACT_ENVIRONMENT = true;