@hyper-fetch/react 9.2.0 → 9.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/__tests__/features/helpers/use-request-events/use-request-events.base.spec.ts +2 -2
  2. package/__tests__/features/strict-mode/strict-mode.requests.spec.ts +45 -0
  3. package/__tests__/features/strict-mode/strict-mode.sockets.spec.ts +21 -0
  4. package/__tests__/features/use-cache/use-cache.select.spec.tsx +117 -0
  5. package/__tests__/features/use-cache/use-cache.typescript.spec.ts +10 -0
  6. package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +17 -14
  7. package/__tests__/features/use-fetch/use-fetch.select.spec.tsx +420 -0
  8. package/__tests__/features/use-fetch/use-fetch.throw-on-error.spec.tsx +213 -0
  9. package/__tests__/features/use-fetch/use-fetch.typescript.spec.ts +41 -0
  10. package/__tests__/features/use-is-fetching/use-is-fetching.base.spec.tsx +117 -0
  11. package/__tests__/features/use-listener/use-listener.select.spec.tsx +183 -0
  12. package/__tests__/features/use-listener/use-listener.typescript.spec.ts +23 -0
  13. package/__tests__/features/use-submit/use-submit.select.spec.tsx +55 -0
  14. package/__tests__/features/use-submit/use-submit.typescript.spec.ts +14 -0
  15. package/__tests__/utils/use-fetch.utils.ts +4 -1
  16. package/dist/helpers/use-request-events/use-request-events.types.d.ts +1 -1
  17. package/dist/helpers/use-request-events/use-request-events.types.d.ts.map +1 -1
  18. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +2 -0
  19. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts.map +1 -1
  20. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts +2 -2
  21. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts.map +1 -1
  22. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts +23 -10
  23. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts.map +1 -1
  24. package/dist/hooks/use-cache/use-cache.constants.d.ts +1 -0
  25. package/dist/hooks/use-cache/use-cache.constants.d.ts.map +1 -1
  26. package/dist/hooks/use-cache/use-cache.hooks.d.ts +2 -2
  27. package/dist/hooks/use-cache/use-cache.hooks.d.ts.map +1 -1
  28. package/dist/hooks/use-cache/use-cache.types.d.ts +12 -3
  29. package/dist/hooks/use-cache/use-cache.types.d.ts.map +1 -1
  30. package/dist/hooks/use-fetch/use-fetch.constants.d.ts +1 -1
  31. package/dist/hooks/use-fetch/use-fetch.constants.d.ts.map +1 -1
  32. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts +2 -2
  33. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts.map +1 -1
  34. package/dist/hooks/use-fetch/use-fetch.types.d.ts +18 -4
  35. package/dist/hooks/use-fetch/use-fetch.types.d.ts.map +1 -1
  36. package/dist/hooks/use-is-fetching/index.d.ts +3 -0
  37. package/dist/hooks/use-is-fetching/index.d.ts.map +1 -0
  38. package/dist/hooks/use-is-fetching/use-is-fetching.hooks.d.ts +17 -0
  39. package/dist/hooks/use-is-fetching/use-is-fetching.hooks.d.ts.map +1 -0
  40. package/dist/hooks/use-is-fetching/use-is-fetching.types.d.ts +12 -0
  41. package/dist/hooks/use-is-fetching/use-is-fetching.types.d.ts.map +1 -0
  42. package/dist/hooks/use-listener/use-listener.hooks.d.ts +3 -3
  43. package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -1
  44. package/dist/hooks/use-listener/use-listener.types.d.ts +12 -1
  45. package/dist/hooks/use-listener/use-listener.types.d.ts.map +1 -1
  46. package/dist/hooks/use-submit/use-submit.constants.d.ts +1 -1
  47. package/dist/hooks/use-submit/use-submit.constants.d.ts.map +1 -1
  48. package/dist/hooks/use-submit/use-submit.hooks.d.ts +2 -2
  49. package/dist/hooks/use-submit/use-submit.hooks.d.ts.map +1 -1
  50. package/dist/hooks/use-submit/use-submit.types.d.ts +13 -4
  51. package/dist/hooks/use-submit/use-submit.types.d.ts.map +1 -1
  52. package/dist/index.d.ts +1 -0
  53. package/dist/index.d.ts.map +1 -1
  54. package/dist/index.mjs +181 -35
  55. package/dist/index.mjs.map +1 -1
  56. package/dist/provider/provider.types.d.ts +6 -4
  57. package/dist/provider/provider.types.d.ts.map +1 -1
  58. package/package.json +1 -1
  59. package/src/helpers/use-request-events/use-request-events.types.ts +1 -1
  60. package/src/helpers/use-socket-state/use-socket-state.hooks.ts +3 -1
  61. package/src/helpers/use-tracked-state/use-tracked-state.hooks.ts +112 -26
  62. package/src/helpers/use-tracked-state/use-tracked-state.types.ts +27 -9
  63. package/src/hooks/use-cache/use-cache.constants.ts +1 -0
  64. package/src/hooks/use-cache/use-cache.hooks.ts +9 -7
  65. package/src/hooks/use-cache/use-cache.types.ts +16 -4
  66. package/src/hooks/use-emitter/use-emitter.hooks.ts +1 -1
  67. package/src/hooks/use-fetch/use-fetch.constants.ts +3 -1
  68. package/src/hooks/use-fetch/use-fetch.hooks.ts +38 -6
  69. package/src/hooks/use-fetch/use-fetch.types.ts +33 -5
  70. package/src/hooks/use-is-fetching/index.ts +2 -0
  71. package/src/hooks/use-is-fetching/use-is-fetching.hooks.ts +51 -0
  72. package/src/hooks/use-is-fetching/use-is-fetching.types.ts +12 -0
  73. package/src/hooks/use-listener/use-listener.hooks.ts +61 -6
  74. package/src/hooks/use-listener/use-listener.types.ts +12 -1
  75. package/src/hooks/use-submit/use-submit.constants.ts +2 -1
  76. package/src/hooks/use-submit/use-submit.hooks.ts +22 -7
  77. package/src/hooks/use-submit/use-submit.types.ts +23 -7
  78. package/src/index.ts +1 -0
  79. package/src/provider/provider.types.ts +8 -4
@@ -45,12 +45,12 @@ describe("useRequestEvents [ Base ]", () => {
45
45
  });
46
46
 
47
47
  it("should not change loading state during cache processing", async () => {
48
+ const spy = vi.fn();
48
49
  const { result, rerender } = renderUseRequestEvents(request, {
50
+ actions: { setLoading: spy },
49
51
  getIsDataProcessing: () => false,
50
52
  });
51
53
 
52
- const spy = vi.spyOn(request.client.fetchDispatcher, "hasRunningRequests");
53
-
54
54
  act(() => {
55
55
  result.current[1].addCacheDataListener(request);
56
56
  request.client.requestManager.events.emitLoading({
@@ -1,6 +1,9 @@
1
1
  import { createHttpMockingServer } from "@hyper-fetch/testing";
2
2
  import { act, renderHook, waitFor } from "@testing-library/react";
3
3
  import { useAppManager } from "hooks/use-app-manager";
4
+ import { useCache } from "hooks/use-cache";
5
+ import { useFetch } from "hooks/use-fetch";
6
+ import { useIsFetching } from "hooks/use-is-fetching";
4
7
  import { useSubmit } from "hooks/use-submit";
5
8
  import { StrictMode } from "react";
6
9
 
@@ -107,4 +110,46 @@ describe("Requests hooks [ StrictMode ]", () => {
107
110
  });
108
111
  });
109
112
  });
113
+
114
+ describe("given selectors are used in StrictMode", () => {
115
+ it("should select the fetched data and follow cache updates", async () => {
116
+ const getRequest = createRequest<{ a: number; b: number }>();
117
+ mockRequest(getRequest, { data: { a: 1, b: 1 } });
118
+ const { result } = renderHook(
119
+ () => ({
120
+ fetched: useFetch(getRequest, { select: (value) => value.a }),
121
+ cached: useCache(getRequest, { select: (value) => value.b }),
122
+ }),
123
+ { wrapper: StrictMode },
124
+ );
125
+
126
+ await waitFor(() => {
127
+ expect(result.current.fetched.data).toBe(1);
128
+ expect(result.current.cached.data).toBe(1);
129
+ });
130
+
131
+ act(() => {
132
+ client.cache.update(getRequest, (prev) => ({ ...prev, data: { a: 2, b: 3 } }));
133
+ });
134
+
135
+ expect(result.current.fetched.data).toBe(2);
136
+ expect(result.current.cached.data).toBe(3);
137
+ });
138
+ it("should count the running requests", async () => {
139
+ const getRequest = createRequest();
140
+ mockRequest(getRequest, { delay: 20 });
141
+ const { result } = renderHook(() => useIsFetching(client), { wrapper: StrictMode });
142
+
143
+ act(() => {
144
+ client.fetchDispatcher.add(getRequest);
145
+ });
146
+
147
+ await waitFor(() => {
148
+ expect(result.current).toBe(1);
149
+ });
150
+ await waitFor(() => {
151
+ expect(result.current).toBe(0);
152
+ });
153
+ });
154
+ });
110
155
  });
@@ -242,6 +242,27 @@ describe("Sockets hooks [ StrictMode ]", () => {
242
242
 
243
243
  expect(spy).not.toHaveBeenCalled();
244
244
  });
245
+ it("should select the message data", async () => {
246
+ const listener = createListener();
247
+ const view = renderHook(() => useListener(listener, { select: (message) => message.name }), {
248
+ wrapper: StrictMode,
249
+ });
250
+ act(() => {
251
+ view.result.current.onEvent(spy);
252
+ });
253
+ await waitFor(() => {
254
+ expect(view.result.current.connected).toBeTrue();
255
+ });
256
+ // Read data like a rendering component would - dependency tracking subscribes to the accessed values
257
+ expect(view.result.current.data).toBeNull();
258
+
259
+ emitListenerEvent(listener, { name: "Maciej", age: 99 });
260
+
261
+ await waitFor(() => {
262
+ expect(view.result.current.data).toBe("Maciej");
263
+ });
264
+ expect(spy).toHaveBeenCalledTimes(1);
265
+ });
245
266
  });
246
267
 
247
268
  describe("given useEmitter is rendered in StrictMode", () => {
@@ -0,0 +1,117 @@
1
+ import { act, render, screen } from "@testing-library/react";
2
+ import { useCache } from "hooks/use-cache";
3
+
4
+ import { client, createRequest } from "../../utils";
5
+
6
+ type Todos = { items: { id: number; done: boolean }[]; total: number };
7
+
8
+ describe("useCache [ Select ]", () => {
9
+ let request = createRequest<Todos>();
10
+
11
+ const setCacheData = (data: Todos) => {
12
+ act(() => {
13
+ client.cache.set(request, {
14
+ data,
15
+ error: null,
16
+ status: 200,
17
+ success: true,
18
+ extra: { headers: {} },
19
+ retries: 0,
20
+ isCanceled: false,
21
+ isOffline: false,
22
+ willRetry: false,
23
+ addedTimestamp: Date.now(),
24
+ triggerTimestamp: Date.now(),
25
+ requestTimestamp: Date.now(),
26
+ responseTimestamp: Date.now(),
27
+ });
28
+ });
29
+ };
30
+
31
+ beforeEach(() => {
32
+ client.clear();
33
+ request = createRequest<Todos>();
34
+ });
35
+
36
+ it("should return the selected cache data", () => {
37
+ setCacheData({ items: [{ id: 1, done: false }], total: 1 });
38
+
39
+ function Page() {
40
+ const { data } = useCache(request, { select: (value) => value.total });
41
+ return <div data-testid="result">{JSON.stringify(data)}</div>;
42
+ }
43
+
44
+ render(<Page />);
45
+
46
+ expect(screen.getByTestId("result").textContent).toBe("1");
47
+ });
48
+
49
+ it("should rerender only when the selected value changes", () => {
50
+ setCacheData({ items: [{ id: 1, done: false }], total: 1 });
51
+ let renders = 0;
52
+
53
+ function Page() {
54
+ const { data } = useCache(request, { select: (value) => value.items.filter((item) => item.done) });
55
+ renders += 1;
56
+ return <div data-testid="result">{JSON.stringify(data)}</div>;
57
+ }
58
+
59
+ render(<Page />);
60
+ expect(renders).toBe(1);
61
+
62
+ // New undone item - the filtered result is still an empty list
63
+ setCacheData({
64
+ items: [
65
+ { id: 1, done: false },
66
+ { id: 2, done: false },
67
+ ],
68
+ total: 2,
69
+ });
70
+ expect(renders).toBe(1);
71
+
72
+ setCacheData({
73
+ items: [
74
+ { id: 1, done: true },
75
+ { id: 2, done: false },
76
+ ],
77
+ total: 2,
78
+ });
79
+ expect(renders).toBe(2);
80
+ expect(screen.getByTestId("result").textContent).toBe(JSON.stringify([{ id: 1, done: true }]));
81
+ });
82
+
83
+ it("should return null without cache data", () => {
84
+ const selectSpy = vi.fn((value: Todos) => value.total);
85
+
86
+ function Page() {
87
+ const { data } = useCache(request, { select: selectSpy });
88
+ return <div data-testid="result">{JSON.stringify(data)}</div>;
89
+ }
90
+
91
+ render(<Page />);
92
+
93
+ expect(screen.getByTestId("result").textContent).toBe("null");
94
+ expect(selectSpy).not.toHaveBeenCalled();
95
+ });
96
+
97
+ it("should reset the selected data on clear", () => {
98
+ setCacheData({ items: [], total: 3 });
99
+ let clearState: (() => void) | null = null;
100
+
101
+ function Page() {
102
+ const view = useCache(request, { select: (value) => value.total });
103
+ ({ clearState } = view);
104
+ return <div data-testid="result">{JSON.stringify(view.data)}</div>;
105
+ }
106
+
107
+ const view = render(<Page />);
108
+ expect(screen.getByTestId("result").textContent).toBe("3");
109
+
110
+ act(() => {
111
+ clearState?.();
112
+ });
113
+ view.rerender(<Page />);
114
+
115
+ expect(screen.getByTestId("result").textContent).toBe("null");
116
+ });
117
+ });
@@ -1,6 +1,7 @@
1
1
  import { Client } from "@hyper-fetch/core";
2
2
  import { expectType, expectNotType, expectFunctionParametersType } from "@hyper-fetch/testing";
3
3
  import type { UseCacheReturnType } from "hooks/use-cache";
4
+ import { useCache } from "hooks/use-cache";
4
5
 
5
6
  const client = new Client({
6
7
  url: "http://localhost:3000",
@@ -107,4 +108,13 @@ describe("useCache [Types]", () => {
107
108
  expectFunctionParametersType(invalidate).assert([/users/]);
108
109
  });
109
110
  });
111
+
112
+ describe("select", () => {
113
+ it("should infer the selected data type", () => {
114
+ const useSelected = () => useCache(getUsers, { select: (users) => users.length });
115
+ const data = null as unknown as ReturnType<typeof useSelected>["data"];
116
+ expectType<number | null>().assert(data);
117
+ expectNotType<{ id: string; name: string }[] | null>().assert(data);
118
+ });
119
+ });
110
120
  });
@@ -1,5 +1,5 @@
1
1
  import { createHttpMockingServer } from "@hyper-fetch/testing";
2
- import { act } from "@testing-library/react";
2
+ import { act, waitFor } from "@testing-library/react";
3
3
 
4
4
  import { client, createRequest, renderUseFetch, waitForRender } from "../../utils";
5
5
 
@@ -44,11 +44,13 @@ describe("useFetch [ Refreshing ]", () => {
44
44
  result.current.onRequestStart(spy);
45
45
  });
46
46
 
47
- await waitForRender();
48
- expect(spy).toHaveBeenCalledTimes(1);
49
- await waitForRender(hookOptions.refreshTime * 1.5);
50
-
51
- expect(spy).toHaveBeenCalledTimes(2);
47
+ // Wait for the events instead of fixed sleeps - the timings stretch on a busy machine
48
+ await waitFor(() => {
49
+ expect(spy).toHaveBeenCalledTimes(1);
50
+ });
51
+ await waitFor(() => {
52
+ expect(spy).toHaveBeenCalledTimes(2);
53
+ });
52
54
  });
53
55
  it("should refresh blurred tab", async () => {
54
56
  const spy = vi.fn();
@@ -60,9 +62,9 @@ describe("useFetch [ Refreshing ]", () => {
60
62
  client.appManager.setFocused(false);
61
63
  });
62
64
 
63
- await waitForRender();
64
- await waitForRender(hookOptions.refreshTime * 1.5);
65
- expect(spy).toHaveBeenCalledTimes(2);
65
+ await waitFor(() => {
66
+ expect(spy).toHaveBeenCalledTimes(2);
67
+ });
66
68
  });
67
69
  it("should not refresh blurred tab", async () => {
68
70
  const spy = vi.fn();
@@ -93,11 +95,12 @@ describe("useFetch [ Refreshing ]", () => {
93
95
  result.current.onRequestStart(spy);
94
96
  });
95
97
 
96
- await waitForRender();
97
- expect(spy).toHaveBeenCalledTimes(1);
98
- await waitForRender(hookOptions.refreshTime * 1.5);
99
-
100
- expect(spy).toHaveBeenCalledTimes(2);
98
+ await waitFor(() => {
99
+ expect(spy).toHaveBeenCalledTimes(1);
100
+ });
101
+ await waitFor(() => {
102
+ expect(spy).toHaveBeenCalledTimes(2);
103
+ });
101
104
 
102
105
  act(() => {
103
106
  rerender({ refresh: false });