@hyper-fetch/react 1.7.1 → 2.1.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 (56) hide show
  1. package/README.md +18 -16
  2. package/dist/config-provider/config-provider.types.d.ts +7 -7
  3. package/dist/helpers/index.d.ts +1 -0
  4. package/dist/helpers/use-command-events/use-command-events.hooks.d.ts +2 -3
  5. package/dist/helpers/use-command-events/use-command-events.types.d.ts +12 -12
  6. package/dist/helpers/use-socket-state/index.d.ts +3 -0
  7. package/dist/helpers/use-socket-state/use-socket-state.constants.d.ts +2 -0
  8. package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +16 -0
  9. package/dist/helpers/use-socket-state/use-socket-state.types.d.ts +9 -0
  10. package/dist/helpers/use-tracked-state/use-tracked-state.hooks.d.ts +1 -2
  11. package/dist/helpers/use-tracked-state/use-tracked-state.types.d.ts +5 -5
  12. package/dist/helpers/use-tracked-state/use-tracked-state.utils.d.ts +5 -5
  13. package/dist/hooks/use-app-manager/use-app-manager.hooks.d.ts +2 -3
  14. package/dist/hooks/use-app-manager/use-app-manager.types.d.ts +1 -1
  15. package/dist/hooks/use-cache/use-cache.hooks.d.ts +2 -3
  16. package/dist/hooks/use-cache/use-cache.types.d.ts +4 -4
  17. package/dist/hooks/use-emitter/index.d.ts +2 -0
  18. package/dist/hooks/use-emitter/use-emitter.hooks.d.ts +19 -0
  19. package/dist/hooks/use-emitter/use-emitter.types.d.ts +3 -0
  20. package/dist/hooks/use-event-messages/index.d.ts +2 -0
  21. package/dist/hooks/use-event-messages/use-event-messages.hooks.d.ts +24 -0
  22. package/dist/hooks/use-event-messages/use-event-messages.types.d.ts +4 -0
  23. package/dist/hooks/use-fetch/use-fetch.constants.d.ts +2 -2
  24. package/dist/hooks/use-fetch/use-fetch.hooks.d.ts +2 -3
  25. package/dist/hooks/use-fetch/use-fetch.types.d.ts +5 -5
  26. package/dist/hooks/use-listener/index.d.ts +2 -0
  27. package/dist/hooks/use-listener/use-listener.hooks.d.ts +20 -0
  28. package/dist/hooks/use-listener/use-listener.types.d.ts +3 -0
  29. package/dist/hooks/use-queue/use-queue.constants.d.ts +1 -1
  30. package/dist/hooks/use-queue/use-queue.hooks.d.ts +2 -3
  31. package/dist/hooks/use-queue/use-queue.types.d.ts +3 -3
  32. package/dist/hooks/use-submit/use-submit.constants.d.ts +1 -1
  33. package/dist/hooks/use-submit/use-submit.hooks.d.ts +2 -3
  34. package/dist/hooks/use-submit/use-submit.types.d.ts +5 -5
  35. package/dist/index.cjs.js +1 -1
  36. package/dist/index.cjs.js.map +4 -4
  37. package/dist/index.d.ts +3 -0
  38. package/dist/index.esm.js +1 -1
  39. package/dist/index.esm.js.map +4 -4
  40. package/dist/types/invalidation.types.d.ts +1 -1
  41. package/package.json +11 -3
  42. package/src/helpers/index.ts +1 -0
  43. package/src/helpers/use-socket-state/index.ts +3 -0
  44. package/src/helpers/use-socket-state/use-socket-state.constants.ts +8 -0
  45. package/src/helpers/use-socket-state/use-socket-state.hooks.ts +135 -0
  46. package/src/helpers/use-socket-state/use-socket-state.types.ts +10 -0
  47. package/src/hooks/use-emitter/index.ts +2 -0
  48. package/src/hooks/use-emitter/use-emitter.hooks.ts +47 -0
  49. package/src/hooks/use-emitter/use-emitter.types.ts +3 -0
  50. package/src/hooks/use-event-messages/index.ts +2 -0
  51. package/src/hooks/use-event-messages/use-event-messages.hooks.ts +65 -0
  52. package/src/hooks/use-event-messages/use-event-messages.types.ts +4 -0
  53. package/src/hooks/use-listener/index.ts +2 -0
  54. package/src/hooks/use-listener/use-listener.hooks.ts +75 -0
  55. package/src/hooks/use-listener/use-listener.types.ts +3 -0
  56. package/src/index.ts +3 -0
@@ -0,0 +1,135 @@
1
+ import { useRef } from "react";
2
+ import { SocketInstance } from "@hyper-fetch/sockets";
3
+ import { useDidMount, useDidUpdate, useForceUpdate } from "@better-typed/react-lifecycle-hooks";
4
+
5
+ import { UseSocketStateType, initialSocketState, UseSocketStateProps } from "helpers";
6
+
7
+ export const useSocketState = <DataType>(socket: SocketInstance, { dependencyTracking }: UseSocketStateProps) => {
8
+ const forceUpdate = useForceUpdate();
9
+
10
+ const onOpenCallback = useRef<null | VoidFunction>(null);
11
+ const onCloseCallback = useRef<null | VoidFunction>(null);
12
+ const onErrorCallback = useRef<null | ((event: any) => void)>(null);
13
+ const onConnectingCallback = useRef<null | VoidFunction>(null);
14
+ const onReconnectingCallback = useRef<null | ((attempts: number) => void)>(null);
15
+ const onReconnectingStopCallback = useRef<null | ((attempts: number) => void)>(null);
16
+
17
+ const state = useRef<UseSocketStateType<DataType>>(initialSocketState);
18
+ const renderKeys = useRef<Array<keyof UseSocketStateType<DataType>>>([]);
19
+
20
+ // ******************
21
+ // Dependency Tracking
22
+ // ******************
23
+
24
+ const renderKeyTrigger = (keys: Array<keyof UseSocketStateType<DataType>>) => {
25
+ const shouldRerender = renderKeys.current.some((renderKey) => keys.includes(renderKey));
26
+ if (shouldRerender) forceUpdate();
27
+ };
28
+
29
+ const setRenderKey = (renderKey: keyof UseSocketStateType<DataType>) => {
30
+ if (!renderKeys.current.includes(renderKey)) {
31
+ renderKeys.current.push(renderKey);
32
+ }
33
+ };
34
+
35
+ // ******************
36
+ // Turn off dependency tracking
37
+ // ******************
38
+
39
+ useDidUpdate(
40
+ () => {
41
+ const handleDependencyTracking = () => {
42
+ if (!dependencyTracking) {
43
+ Object.keys(state.current).forEach((key) => setRenderKey(key as Parameters<typeof setRenderKey>[0]));
44
+ }
45
+ };
46
+
47
+ handleDependencyTracking();
48
+ },
49
+ [dependencyTracking],
50
+ true,
51
+ );
52
+
53
+ // ******************
54
+ // Actions
55
+ // ******************
56
+
57
+ const actions = {
58
+ setData: (data: DataType | null) => {
59
+ state.current.data = data;
60
+ renderKeyTrigger(["data"]);
61
+ },
62
+ setConnected: (connected: boolean) => {
63
+ state.current.connected = connected;
64
+ renderKeyTrigger(["data"]);
65
+ },
66
+ setConnecting: (connecting: boolean) => {
67
+ state.current.connecting = connecting;
68
+ renderKeyTrigger(["data"]);
69
+ },
70
+ setTimestamp: (timestamp: number | null) => {
71
+ state.current.timestamp = timestamp;
72
+ renderKeyTrigger(["timestamp"]);
73
+ },
74
+ };
75
+
76
+ const callbacks = {
77
+ onOpen: (callback: VoidFunction) => {
78
+ onOpenCallback.current = callback;
79
+ },
80
+ onClose: (callback: VoidFunction) => {
81
+ onCloseCallback.current = callback;
82
+ },
83
+ onError: <ErrorType = Event>(callback: (event: ErrorType) => void) => {
84
+ onErrorCallback.current = callback;
85
+ },
86
+ onConnecting: (callback: VoidFunction) => {
87
+ onConnectingCallback.current = callback;
88
+ },
89
+ onReconnecting: (callback: (attempts: number) => void) => {
90
+ onReconnectingCallback.current = callback;
91
+ },
92
+ onReconnectingStop: (callback: (attempts: number) => void) => {
93
+ onReconnectingStopCallback.current = callback;
94
+ },
95
+ };
96
+
97
+ // ******************
98
+ // Hook to events
99
+ // ******************
100
+
101
+ useDidMount(() => {
102
+ const umountOnError = socket.events.onError((event) => {
103
+ onErrorCallback.current?.(event);
104
+ });
105
+ const umountOnConnecting = socket.events.onConnecting(() => {
106
+ actions.setConnecting(true);
107
+ onConnectingCallback.current?.();
108
+ });
109
+ const umountOnOpen = socket.events.onOpen(() => {
110
+ actions.setConnected(true);
111
+ onOpenCallback.current?.();
112
+ });
113
+ const umountOnClose = socket.events.onClose(() => {
114
+ actions.setConnected(false);
115
+ onCloseCallback.current?.();
116
+ });
117
+ const umountOnReconnecting = socket.events.onReconnecting((attempts) => {
118
+ onReconnectingCallback.current?.(attempts);
119
+ });
120
+ const umountOnReconnectingStop = socket.events.onReconnectingStop((attempts) => {
121
+ onReconnectingStopCallback.current?.(attempts);
122
+ });
123
+
124
+ return () => {
125
+ umountOnError();
126
+ umountOnConnecting();
127
+ umountOnOpen();
128
+ umountOnClose();
129
+ umountOnReconnecting();
130
+ umountOnReconnectingStop();
131
+ };
132
+ });
133
+
134
+ return [state.current, actions, callbacks, { setRenderKey }] as const;
135
+ };
@@ -0,0 +1,10 @@
1
+ export type UseSocketStateType<DataType = any> = {
2
+ data: DataType | null;
3
+ connected: boolean;
4
+ connecting: boolean;
5
+ timestamp: number | null;
6
+ };
7
+
8
+ export type UseSocketStateProps = {
9
+ dependencyTracking?: boolean;
10
+ };
@@ -0,0 +1,2 @@
1
+ export * from "./use-emitter.hooks";
2
+ export * from "./use-emitter.types";
@@ -0,0 +1,47 @@
1
+ import { useRef } from "react";
2
+ import { EmitterInstance } from "@hyper-fetch/sockets";
3
+
4
+ import { UseEmitterOptionsType } from "hooks/use-emitter";
5
+ import { useSocketState } from "helpers";
6
+
7
+ // Todo bounce
8
+
9
+ export const useEmitter = <EmitterType extends EmitterInstance>(
10
+ emitter: EmitterType,
11
+ { dependencyTracking }: UseEmitterOptionsType,
12
+ ) => {
13
+ const onEventCallback = useRef<null | ((emitter: EmitterType) => void)>(null);
14
+ const [state, actions, callbacks, { setRenderKey }] = useSocketState(emitter.socket, { dependencyTracking });
15
+
16
+ const additionalCallbacks = {
17
+ onEvent: (callback: (emitter: EmitterType) => void) => {
18
+ onEventCallback.current = callback;
19
+ },
20
+ };
21
+
22
+ const emit: typeof emitter.emit = (...args) => {
23
+ actions.setTimestamp(+new Date());
24
+ onEventCallback.current?.(emitter);
25
+ return emitter.emit(...args);
26
+ };
27
+
28
+ return {
29
+ get connected() {
30
+ setRenderKey("connected");
31
+ return state.connected;
32
+ },
33
+ get connecting() {
34
+ setRenderKey("connecting");
35
+ return state.connecting;
36
+ },
37
+ get timestamp() {
38
+ setRenderKey("timestamp");
39
+ return state.timestamp;
40
+ },
41
+ ...actions,
42
+ ...callbacks,
43
+ ...additionalCallbacks,
44
+ emit,
45
+ reconnect: emitter.socket.reconnect,
46
+ };
47
+ };
@@ -0,0 +1,3 @@
1
+ export type UseEmitterOptionsType = {
2
+ dependencyTracking?: boolean;
3
+ };
@@ -0,0 +1,2 @@
1
+ export * from "./use-event-messages.hooks";
2
+ export * from "./use-event-messages.types";
@@ -0,0 +1,65 @@
1
+ import { useRef } from "react";
2
+ import { useDidUpdate } from "@better-typed/react-lifecycle-hooks";
3
+ import { SocketInstance } from "@hyper-fetch/sockets";
4
+
5
+ import { useSocketState } from "helpers";
6
+ import { UseEventMessagesOptionsType } from "hooks/use-event-messages";
7
+
8
+ /**
9
+ * Allow to listen to all event messages received with sockets
10
+ * @param socket
11
+ * @param options
12
+ * @returns
13
+ */
14
+ export const useEventMessages = <ResponsesType>(
15
+ socket: SocketInstance,
16
+ { dependencyTracking = false, filter }: UseEventMessagesOptionsType<ResponsesType>,
17
+ ) => {
18
+ const onEventCallback = useRef<null | ((data: ResponsesType, event: MessageEvent<ResponsesType>) => void)>(null);
19
+ const [state, actions, callbacks, { setRenderKey }] = useSocketState(socket, { dependencyTracking });
20
+
21
+ useDidUpdate(
22
+ () => {
23
+ const unmountListener = socket.events.onListenerEvent((data, event) => {
24
+ const filterFn = typeof filter === "function" ? () => filter(data, event) : () => filter.includes(data.name);
25
+ const isFiltered = filter ? filterFn() : false;
26
+ if (!isFiltered) {
27
+ onEventCallback.current?.(data, event);
28
+ actions.setData(data);
29
+ actions.setTimestamp(+new Date());
30
+ }
31
+ });
32
+ return unmountListener;
33
+ },
34
+ [socket, filter],
35
+ true,
36
+ );
37
+
38
+ const additionalCallbacks = {
39
+ onEvent: (callback: NonNullable<typeof onEventCallback.current>) => {
40
+ onEventCallback.current = callback;
41
+ },
42
+ };
43
+
44
+ return {
45
+ get data() {
46
+ setRenderKey("data");
47
+ return state.data;
48
+ },
49
+ get connected() {
50
+ setRenderKey("connected");
51
+ return state.connected;
52
+ },
53
+ get connecting() {
54
+ setRenderKey("connecting");
55
+ return state.connecting;
56
+ },
57
+ get timestamp() {
58
+ setRenderKey("timestamp");
59
+ return state.timestamp;
60
+ },
61
+ ...actions,
62
+ ...callbacks,
63
+ ...additionalCallbacks,
64
+ };
65
+ };
@@ -0,0 +1,4 @@
1
+ export type UseEventMessagesOptionsType<ResponsesType> = {
2
+ dependencyTracking?: boolean;
3
+ filter?: ((data: ResponsesType, event: MessageEvent<ResponsesType>) => boolean) | string[];
4
+ };
@@ -0,0 +1,2 @@
1
+ export * from "./use-listener.hooks";
2
+ export * from "./use-listener.types";
@@ -0,0 +1,75 @@
1
+ import { useRef } from "react";
2
+ import { useDidUpdate, useWillUnmount } from "@better-typed/react-lifecycle-hooks";
3
+ import { ListenerInstance, ExtractListenerDataType } from "@hyper-fetch/sockets";
4
+
5
+ import { useSocketState } from "helpers";
6
+ import { UseListenerOptionsType } from "hooks/use-listener";
7
+
8
+ export const useListener = <ListenerType extends ListenerInstance>(
9
+ listener: ListenerType,
10
+ { dependencyTracking }: UseListenerOptionsType,
11
+ ) => {
12
+ const onEventCallback = useRef<
13
+ | null
14
+ | ((
15
+ data: ExtractListenerDataType<ListenerType>,
16
+ event: MessageEvent<ExtractListenerDataType<ListenerType>>,
17
+ ) => void)
18
+ >(null);
19
+ const removeListenerRef = useRef<ReturnType<typeof listener.listen> | null>(null);
20
+ const [state, actions, callbacks, { setRenderKey }] = useSocketState(listener.socket, { dependencyTracking });
21
+
22
+ const stopListener = () => {
23
+ removeListenerRef.current?.[0]();
24
+ };
25
+
26
+ const listen = () => {
27
+ stopListener();
28
+ removeListenerRef.current = listener.listen((data, event) => {
29
+ onEventCallback.current?.(data, event);
30
+ actions.setData(data);
31
+ actions.setTimestamp(+new Date());
32
+ });
33
+ };
34
+
35
+ useDidUpdate(
36
+ () => {
37
+ listen();
38
+ },
39
+ [listener],
40
+ true,
41
+ );
42
+
43
+ useWillUnmount(() => {
44
+ stopListener();
45
+ });
46
+
47
+ const additionalCallbacks = {
48
+ onEvent: (callback: NonNullable<typeof onEventCallback.current>) => {
49
+ onEventCallback.current = callback;
50
+ },
51
+ };
52
+
53
+ return {
54
+ get data() {
55
+ setRenderKey("data");
56
+ return state.data;
57
+ },
58
+ get connected() {
59
+ setRenderKey("connected");
60
+ return state.connected;
61
+ },
62
+ get connecting() {
63
+ setRenderKey("connecting");
64
+ return state.connecting;
65
+ },
66
+ get timestamp() {
67
+ setRenderKey("timestamp");
68
+ return state.timestamp;
69
+ },
70
+ ...actions,
71
+ ...callbacks,
72
+ ...additionalCallbacks,
73
+ listen,
74
+ };
75
+ };
@@ -0,0 +1,3 @@
1
+ export type UseListenerOptionsType = {
2
+ dependencyTracking?: boolean;
3
+ };
package/src/index.ts CHANGED
@@ -2,6 +2,9 @@ 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-listener";
6
+ export * from "./hooks/use-emitter";
7
+ export * from "./hooks/use-event-messages";
5
8
  export * from "./hooks/use-app-manager";
6
9
  export * from "./helpers";
7
10
  export * from "./types";