@bquery/bquery 1.7.0 → 1.8.2
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.
- package/README.md +760 -716
- package/dist/{a11y-C5QOVvRn.js → a11y-DVBCy09c.js} +3 -3
- package/dist/a11y-DVBCy09c.js.map +1 -0
- package/dist/a11y.es.mjs +1 -1
- package/dist/component/library.d.ts.map +1 -1
- package/dist/{component-CuuTijA6.js → component-L3-JfOFz.js} +5 -5
- package/dist/component-L3-JfOFz.js.map +1 -0
- package/dist/component.es.mjs +1 -1
- package/dist/{config-BW35FKuA.js → config-DhT9auRm.js} +1 -1
- package/dist/{config-BW35FKuA.js.map → config-DhT9auRm.js.map} +1 -1
- package/dist/{constraints-3lV9yyBw.js → constraints-D5RHQLmP.js} +1 -1
- package/dist/constraints-D5RHQLmP.js.map +1 -0
- package/dist/core/collection.d.ts +86 -0
- package/dist/core/collection.d.ts.map +1 -1
- package/dist/core/element.d.ts +28 -0
- package/dist/core/element.d.ts.map +1 -1
- package/dist/core/shared.d.ts +6 -0
- package/dist/core/shared.d.ts.map +1 -1
- package/dist/core-DdtZHzsS.js +168 -0
- package/dist/core-DdtZHzsS.js.map +1 -0
- package/dist/{core-Cjl7GUu8.js → core-EMYSLzaT.js} +289 -259
- package/dist/core-EMYSLzaT.js.map +1 -0
- package/dist/core.es.mjs +48 -47
- package/dist/{custom-directives-7wAShnnd.js → custom-directives-Dr4C5lVV.js} +1 -1
- package/dist/custom-directives-Dr4C5lVV.js.map +1 -0
- package/dist/{devtools-D2fQLhDN.js → devtools-BhB2iDPT.js} +2 -2
- package/dist/devtools-BhB2iDPT.js.map +1 -0
- package/dist/devtools.es.mjs +1 -1
- package/dist/{dnd-B8EgyzaI.js → dnd-NwZBYh4l.js} +1 -1
- package/dist/dnd-NwZBYh4l.js.map +1 -0
- package/dist/dnd.es.mjs +1 -1
- package/dist/{env-NeVmr4Gf.js → env-CTdvLaH2.js} +1 -1
- package/dist/env-CTdvLaH2.js.map +1 -0
- package/dist/forms/create-form.d.ts.map +1 -1
- package/dist/forms/index.d.ts +3 -2
- package/dist/forms/index.d.ts.map +1 -1
- package/dist/forms/types.d.ts +46 -0
- package/dist/forms/types.d.ts.map +1 -1
- package/dist/forms/use-field.d.ts +34 -0
- package/dist/forms/use-field.d.ts.map +1 -0
- package/dist/forms/validators.d.ts +25 -0
- package/dist/forms/validators.d.ts.map +1 -1
- package/dist/forms-UcRHsYxC.js +227 -0
- package/dist/forms-UcRHsYxC.js.map +1 -0
- package/dist/forms.es.mjs +14 -12
- package/dist/full.d.ts +17 -26
- package/dist/full.d.ts.map +1 -1
- package/dist/full.es.mjs +206 -181
- package/dist/full.iife.js +33 -33
- package/dist/full.iife.js.map +1 -1
- package/dist/full.umd.js +33 -33
- package/dist/full.umd.js.map +1 -1
- package/dist/function-Cybd57JV.js +33 -0
- package/dist/function-Cybd57JV.js.map +1 -0
- package/dist/{i18n-BnnhTFOS.js → i18n-kuF6Ekj6.js} +3 -3
- package/dist/i18n-kuF6Ekj6.js.map +1 -0
- package/dist/i18n.es.mjs +1 -1
- package/dist/index.es.mjs +251 -228
- package/dist/media/breakpoints.d.ts.map +1 -1
- package/dist/media/types.d.ts +2 -2
- package/dist/media/types.d.ts.map +1 -1
- package/dist/{media-Di2Ta22s.js → media-i-fB5WxI.js} +3 -3
- package/dist/media-i-fB5WxI.js.map +1 -0
- package/dist/media.es.mjs +1 -1
- package/dist/{motion-qPj_TYGv.js → motion-BJsAuULb.js} +2 -2
- package/dist/motion-BJsAuULb.js.map +1 -0
- package/dist/motion.es.mjs +1 -1
- package/dist/{mount-SM07RUa6.js → mount-B4Y8bk8Z.js} +5 -5
- package/dist/mount-B4Y8bk8Z.js.map +1 -0
- package/dist/{platform-CPbCprb6.js → platform-Dw2gE3zI.js} +3 -3
- package/dist/{platform-CPbCprb6.js.map → platform-Dw2gE3zI.js.map} +1 -1
- package/dist/platform.es.mjs +2 -2
- package/dist/plugin/registry.d.ts.map +1 -1
- package/dist/{plugin-cPoOHFLY.js → plugin-C2WuC8SF.js} +20 -18
- package/dist/plugin-C2WuC8SF.js.map +1 -0
- package/dist/plugin.es.mjs +1 -1
- package/dist/reactive/async-data.d.ts +28 -3
- package/dist/reactive/async-data.d.ts.map +1 -1
- package/dist/reactive/computed.d.ts +3 -0
- package/dist/reactive/computed.d.ts.map +1 -1
- package/dist/reactive/effect.d.ts +3 -0
- package/dist/reactive/effect.d.ts.map +1 -1
- package/dist/reactive/http.d.ts +194 -0
- package/dist/reactive/http.d.ts.map +1 -0
- package/dist/reactive/index.d.ts +2 -2
- package/dist/reactive/index.d.ts.map +1 -1
- package/dist/reactive/pagination.d.ts +126 -0
- package/dist/reactive/pagination.d.ts.map +1 -0
- package/dist/reactive/polling.d.ts +55 -0
- package/dist/reactive/polling.d.ts.map +1 -0
- package/dist/reactive/readonly.d.ts +20 -1
- package/dist/reactive/readonly.d.ts.map +1 -1
- package/dist/reactive/rest.d.ts +293 -0
- package/dist/reactive/rest.d.ts.map +1 -0
- package/dist/reactive/scope.d.ts +140 -0
- package/dist/reactive/scope.d.ts.map +1 -0
- package/dist/reactive/signal.d.ts +16 -2
- package/dist/reactive/signal.d.ts.map +1 -1
- package/dist/reactive/to-value.d.ts +57 -0
- package/dist/reactive/to-value.d.ts.map +1 -0
- package/dist/reactive/websocket.d.ts +285 -0
- package/dist/reactive/websocket.d.ts.map +1 -0
- package/dist/reactive-DwkhUJfP.js +1148 -0
- package/dist/reactive-DwkhUJfP.js.map +1 -0
- package/dist/reactive.es.mjs +38 -19
- package/dist/{registry-CWf368tT.js → registry-B08iilIh.js} +1 -1
- package/dist/{registry-CWf368tT.js.map → registry-B08iilIh.js.map} +1 -1
- package/dist/router/constraints.d.ts.map +1 -1
- package/dist/router/index.d.ts +1 -1
- package/dist/router/index.d.ts.map +1 -1
- package/dist/router/router.d.ts.map +1 -1
- package/dist/router/state.d.ts +25 -2
- package/dist/router/state.d.ts.map +1 -1
- package/dist/router-CQikC9Ed.js +492 -0
- package/dist/router-CQikC9Ed.js.map +1 -0
- package/dist/router.es.mjs +9 -8
- package/dist/ssr/hydrate.d.ts.map +1 -1
- package/dist/{ssr-B2qd_WBB.js → ssr-_dAcGdzu.js} +4 -4
- package/dist/ssr-_dAcGdzu.js.map +1 -0
- package/dist/ssr.es.mjs +1 -1
- package/dist/store/persisted.d.ts.map +1 -1
- package/dist/{store-DWpyH6p5.js → store-Cb3gPRve.js} +7 -7
- package/dist/store-Cb3gPRve.js.map +1 -0
- package/dist/store.es.mjs +2 -2
- package/dist/storybook.es.mjs.map +1 -1
- package/dist/{testing-CsqjNUyy.js → testing-C5Sjfsna.js} +8 -8
- package/dist/testing-C5Sjfsna.js.map +1 -0
- package/dist/testing.es.mjs +1 -1
- package/dist/{type-guards-Do9DWgNp.js → type-guards-BMX2c0LP.js} +1 -1
- package/dist/{type-guards-Do9DWgNp.js.map → type-guards-BMX2c0LP.js.map} +1 -1
- package/dist/untrack-D0fnO5k2.js +36 -0
- package/dist/untrack-D0fnO5k2.js.map +1 -0
- package/dist/view/custom-directives.d.ts.map +1 -1
- package/dist/view.es.mjs +4 -4
- package/package.json +178 -177
- package/src/a11y/announce.ts +131 -131
- package/src/a11y/audit.ts +314 -314
- package/src/a11y/index.ts +68 -68
- package/src/a11y/media-preferences.ts +255 -255
- package/src/a11y/roving-tab-index.ts +164 -164
- package/src/a11y/skip-link.ts +255 -255
- package/src/a11y/trap-focus.ts +184 -184
- package/src/a11y/types.ts +183 -183
- package/src/component/component.ts +599 -599
- package/src/component/html.ts +153 -153
- package/src/component/index.ts +52 -52
- package/src/component/library.ts +540 -542
- package/src/component/scope.ts +212 -212
- package/src/component/types.ts +310 -310
- package/src/core/collection.ts +876 -707
- package/src/core/element.ts +1015 -981
- package/src/core/env.ts +60 -60
- package/src/core/index.ts +49 -49
- package/src/core/shared.ts +77 -62
- package/src/core/utils/index.ts +148 -148
- package/src/devtools/devtools.ts +410 -410
- package/src/devtools/index.ts +48 -48
- package/src/devtools/types.ts +104 -104
- package/src/dnd/draggable.ts +296 -296
- package/src/dnd/droppable.ts +228 -228
- package/src/dnd/index.ts +62 -62
- package/src/dnd/sortable.ts +307 -307
- package/src/dnd/types.ts +293 -293
- package/src/forms/create-form.ts +320 -278
- package/src/forms/index.ts +70 -65
- package/src/forms/types.ts +203 -154
- package/src/forms/use-field.ts +231 -0
- package/src/forms/validators.ts +294 -265
- package/src/full.ts +554 -480
- package/src/i18n/formatting.ts +67 -67
- package/src/i18n/i18n.ts +200 -200
- package/src/i18n/index.ts +67 -67
- package/src/i18n/translate.ts +182 -182
- package/src/i18n/types.ts +171 -171
- package/src/index.ts +108 -108
- package/src/media/battery.ts +116 -116
- package/src/media/breakpoints.ts +129 -131
- package/src/media/clipboard.ts +80 -80
- package/src/media/device-sensors.ts +158 -158
- package/src/media/geolocation.ts +119 -119
- package/src/media/index.ts +76 -76
- package/src/media/media-query.ts +92 -92
- package/src/media/network.ts +115 -115
- package/src/media/types.ts +177 -177
- package/src/media/viewport.ts +84 -84
- package/src/motion/index.ts +57 -57
- package/src/motion/morph.ts +151 -151
- package/src/motion/parallax.ts +120 -120
- package/src/motion/reduced-motion.ts +66 -66
- package/src/motion/types.ts +271 -271
- package/src/motion/typewriter.ts +164 -164
- package/src/plugin/index.ts +37 -37
- package/src/plugin/registry.ts +284 -269
- package/src/plugin/types.ts +137 -137
- package/src/reactive/async-data.ts +250 -29
- package/src/reactive/computed.ts +144 -130
- package/src/reactive/effect.ts +29 -6
- package/src/reactive/http.ts +790 -0
- package/src/reactive/index.ts +60 -0
- package/src/reactive/pagination.ts +317 -0
- package/src/reactive/polling.ts +179 -0
- package/src/reactive/readonly.ts +52 -8
- package/src/reactive/rest.ts +859 -0
- package/src/reactive/scope.ts +276 -0
- package/src/reactive/signal.ts +61 -1
- package/src/reactive/to-value.ts +71 -0
- package/src/reactive/websocket.ts +849 -0
- package/src/router/bq-link.ts +279 -279
- package/src/router/constraints.ts +204 -201
- package/src/router/index.ts +49 -49
- package/src/router/match.ts +312 -312
- package/src/router/path-pattern.ts +52 -52
- package/src/router/query.ts +38 -38
- package/src/router/router.ts +421 -402
- package/src/router/state.ts +51 -3
- package/src/router/types.ts +139 -139
- package/src/router/use-route.ts +68 -68
- package/src/router/utils.ts +157 -157
- package/src/security/index.ts +12 -12
- package/src/ssr/hydrate.ts +84 -82
- package/src/ssr/index.ts +70 -70
- package/src/ssr/render.ts +508 -508
- package/src/ssr/serialize.ts +296 -296
- package/src/ssr/types.ts +81 -81
- package/src/store/create-store.ts +467 -467
- package/src/store/index.ts +27 -27
- package/src/store/persisted.ts +245 -249
- package/src/store/types.ts +247 -247
- package/src/store/utils.ts +135 -135
- package/src/storybook/index.ts +480 -480
- package/src/testing/index.ts +42 -42
- package/src/testing/testing.ts +593 -593
- package/src/testing/types.ts +170 -170
- package/src/view/custom-directives.ts +28 -30
- package/src/view/evaluate.ts +292 -292
- package/src/view/process.ts +108 -108
- package/dist/a11y-C5QOVvRn.js.map +0 -1
- package/dist/component-CuuTijA6.js.map +0 -1
- package/dist/constraints-3lV9yyBw.js.map +0 -1
- package/dist/core-Cjl7GUu8.js.map +0 -1
- package/dist/core-DnlyjbF2.js +0 -112
- package/dist/core-DnlyjbF2.js.map +0 -1
- package/dist/custom-directives-7wAShnnd.js.map +0 -1
- package/dist/devtools-D2fQLhDN.js.map +0 -1
- package/dist/dnd-B8EgyzaI.js.map +0 -1
- package/dist/env-NeVmr4Gf.js.map +0 -1
- package/dist/forms-C3yovgH9.js +0 -141
- package/dist/forms-C3yovgH9.js.map +0 -1
- package/dist/i18n-BnnhTFOS.js.map +0 -1
- package/dist/media-Di2Ta22s.js.map +0 -1
- package/dist/motion-qPj_TYGv.js.map +0 -1
- package/dist/mount-SM07RUa6.js.map +0 -1
- package/dist/plugin-cPoOHFLY.js.map +0 -1
- package/dist/reactive-Cfv0RK6x.js +0 -233
- package/dist/reactive-Cfv0RK6x.js.map +0 -1
- package/dist/router-BrthaP_z.js +0 -473
- package/dist/router-BrthaP_z.js.map +0 -1
- package/dist/ssr-B2qd_WBB.js.map +0 -1
- package/dist/store-DWpyH6p5.js.map +0 -1
- package/dist/testing-CsqjNUyy.js.map +0 -1
- package/dist/untrack-DJVQQ2WM.js +0 -33
- package/dist/untrack-DJVQQ2WM.js.map +0 -1
|
@@ -0,0 +1,849 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reactive WebSocket composable with auto-reconnect, heartbeat,
|
|
3
|
+
* message history, and signal-based connection state.
|
|
4
|
+
*
|
|
5
|
+
* @module bquery/reactive
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { computed } from './computed';
|
|
9
|
+
import { Signal, signal } from './core';
|
|
10
|
+
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
// Types
|
|
13
|
+
// ---------------------------------------------------------------------------
|
|
14
|
+
|
|
15
|
+
/** Connection status for a WebSocket. */
|
|
16
|
+
export type WebSocketStatus = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
|
|
17
|
+
/** Connection status for an EventSource. */
|
|
18
|
+
export type EventSourceStatus = 'CONNECTING' | 'OPEN' | 'CLOSED';
|
|
19
|
+
|
|
20
|
+
/** Configuration for automatic reconnection. */
|
|
21
|
+
export interface WebSocketReconnectConfig {
|
|
22
|
+
/** Maximum number of reconnection attempts. Use `0` to disable reconnection (default: Infinity / unlimited). */
|
|
23
|
+
maxAttempts?: number;
|
|
24
|
+
/** Base delay in ms between reconnects (default: 1000). */
|
|
25
|
+
delay?: number;
|
|
26
|
+
/** Maximum delay in ms between reconnects (default: 30000). */
|
|
27
|
+
maxDelay?: number;
|
|
28
|
+
/** Multiply factor for exponential backoff (default: 2). */
|
|
29
|
+
factor?: number;
|
|
30
|
+
/** Custom predicate — return `false` to prevent a reconnect attempt. */
|
|
31
|
+
shouldReconnect?: (event: CloseEvent, attempts: number) => boolean;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Reconnect configuration supported by `useEventSource()`. */
|
|
35
|
+
export type EventSourceReconnectConfig = Pick<
|
|
36
|
+
WebSocketReconnectConfig,
|
|
37
|
+
'maxAttempts' | 'delay' | 'maxDelay' | 'factor'
|
|
38
|
+
>;
|
|
39
|
+
|
|
40
|
+
/** Configuration for keep-alive heartbeats. */
|
|
41
|
+
export interface WebSocketHeartbeatConfig {
|
|
42
|
+
/** Outgoing ping message (default: `'ping'`). */
|
|
43
|
+
message?: string | ArrayBufferLike | Blob | ArrayBufferView;
|
|
44
|
+
/** Interval in ms between heartbeat pings (default: 30 000). */
|
|
45
|
+
interval?: number;
|
|
46
|
+
/** Time in ms to wait for a pong before assuming the connection is dead (default: 10 000). */
|
|
47
|
+
pongTimeout?: number;
|
|
48
|
+
/** Expected response message. If set, only messages matching this value reset the pong timer. */
|
|
49
|
+
responseMessage?: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** Serializer/deserializer for typed messaging. */
|
|
53
|
+
export interface WebSocketSerializer<TSend = unknown, TReceive = unknown> {
|
|
54
|
+
/** Serialize a value before sending over the wire. Default: `JSON.stringify`. */
|
|
55
|
+
serialize?: (data: TSend) => string | ArrayBufferLike | Blob | ArrayBufferView;
|
|
56
|
+
/** Deserialize an incoming message. Default: `JSON.parse`. */
|
|
57
|
+
deserialize?: (event: MessageEvent) => TReceive;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/** Full configuration accepted by `useWebSocket()`. */
|
|
61
|
+
export interface UseWebSocketOptions<
|
|
62
|
+
TSend = unknown,
|
|
63
|
+
TReceive = unknown,
|
|
64
|
+
> extends WebSocketSerializer<TSend, TReceive> {
|
|
65
|
+
/** Sub-protocols to request during the WebSocket handshake. */
|
|
66
|
+
protocols?: string | string[];
|
|
67
|
+
/** Open the connection immediately (default: true). */
|
|
68
|
+
immediate?: boolean;
|
|
69
|
+
/** Automatically reconnect on unexpected close (default: true). Pass `false` or config. */
|
|
70
|
+
autoReconnect?: boolean | WebSocketReconnectConfig;
|
|
71
|
+
/** Keep-alive heartbeat configuration. Pass `true` for defaults or a config object. */
|
|
72
|
+
heartbeat?: boolean | WebSocketHeartbeatConfig;
|
|
73
|
+
/** Maximum number of messages to keep in `history` (default: 0 = disabled). */
|
|
74
|
+
historySize?: number;
|
|
75
|
+
/** Called when the connection opens. */
|
|
76
|
+
onOpen?: (event: Event) => void;
|
|
77
|
+
/** Called when a message is received (after deserialization). */
|
|
78
|
+
onMessage?: (data: TReceive, event: MessageEvent) => void;
|
|
79
|
+
/** Called when the connection closes. */
|
|
80
|
+
onClose?: (event: CloseEvent) => void;
|
|
81
|
+
/** Called when a connection error occurs. */
|
|
82
|
+
onError?: (event: Event) => void;
|
|
83
|
+
/** Called after a successful reconnection. Receives the reconnection attempt count. */
|
|
84
|
+
onReconnect?: (attempts: number) => void;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** Return value of `useWebSocket()`. */
|
|
88
|
+
export interface UseWebSocketReturn<TSend = unknown, TReceive = unknown> {
|
|
89
|
+
/** Reactive connection status. */
|
|
90
|
+
status: { readonly value: WebSocketStatus; peek(): WebSocketStatus };
|
|
91
|
+
/** Reactive last received message (deserialized). */
|
|
92
|
+
data: Signal<TReceive | undefined>;
|
|
93
|
+
/** Last error event. */
|
|
94
|
+
error: Signal<Event | null>;
|
|
95
|
+
/** Rolling message history (newest last). */
|
|
96
|
+
history: Signal<TReceive[]>;
|
|
97
|
+
/** Computed boolean — `true` when the socket is `OPEN`. */
|
|
98
|
+
isConnected: { readonly value: boolean; peek(): boolean };
|
|
99
|
+
/** Number of reconnection attempts since last successful open. */
|
|
100
|
+
reconnectAttempts: Signal<number>;
|
|
101
|
+
/** Round-trip latency in ms measured via heartbeat pings (requires `heartbeat` option). */
|
|
102
|
+
latency: Signal<number>;
|
|
103
|
+
/** Timestamp of the last unexpected disconnection, or 0 if never disconnected. */
|
|
104
|
+
lastDisconnectedAt: Signal<number>;
|
|
105
|
+
/**
|
|
106
|
+
* Send a message.
|
|
107
|
+
*
|
|
108
|
+
* If the socket is not `OPEN`, the message is queued and sent once a
|
|
109
|
+
* connection is (re)established, subject to the configured options.
|
|
110
|
+
*/
|
|
111
|
+
send: (data: TSend) => void;
|
|
112
|
+
/**
|
|
113
|
+
* Send raw data without serialization.
|
|
114
|
+
*
|
|
115
|
+
* Uses the same queuing behavior as {@link send}: data is queued when the
|
|
116
|
+
* socket is not `OPEN` and flushed once a connection is (re)established.
|
|
117
|
+
*/
|
|
118
|
+
sendRaw: (data: string | ArrayBufferLike | Blob | ArrayBufferView) => void;
|
|
119
|
+
/** Manually open / reconnect the WebSocket. */
|
|
120
|
+
open: () => void;
|
|
121
|
+
/** Gracefully close the connection. */
|
|
122
|
+
close: (code?: number, reason?: string) => void;
|
|
123
|
+
/** Tear down all resources (close + remove listeners + stop reconnect/heartbeat). */
|
|
124
|
+
dispose: () => void;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// ---------------------------------------------------------------------------
|
|
128
|
+
// Internal helpers
|
|
129
|
+
// ---------------------------------------------------------------------------
|
|
130
|
+
|
|
131
|
+
/** @internal */
|
|
132
|
+
function resolveReconnect(
|
|
133
|
+
opt: UseWebSocketOptions['autoReconnect']
|
|
134
|
+
): WebSocketReconnectConfig | false;
|
|
135
|
+
/** @internal */
|
|
136
|
+
function resolveReconnect(
|
|
137
|
+
opt: UseEventSourceOptions['autoReconnect']
|
|
138
|
+
): EventSourceReconnectConfig | false;
|
|
139
|
+
/** @internal */
|
|
140
|
+
function resolveReconnect(
|
|
141
|
+
opt: boolean | WebSocketReconnectConfig | EventSourceReconnectConfig | undefined
|
|
142
|
+
): WebSocketReconnectConfig | EventSourceReconnectConfig | false {
|
|
143
|
+
if (opt === false) return false;
|
|
144
|
+
if (opt === true || opt === undefined) return {};
|
|
145
|
+
return opt;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
/** @internal */
|
|
149
|
+
const resolveHeartbeat = (
|
|
150
|
+
opt: UseWebSocketOptions['heartbeat']
|
|
151
|
+
): WebSocketHeartbeatConfig | false => {
|
|
152
|
+
if (!opt) return false;
|
|
153
|
+
if (opt === true) return {};
|
|
154
|
+
return opt;
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
/** @internal */
|
|
158
|
+
const computeDelay = (attempt: number, config: WebSocketReconnectConfig): number => {
|
|
159
|
+
const base = config.delay ?? 1000;
|
|
160
|
+
const factor = config.factor ?? 2;
|
|
161
|
+
const max = config.maxDelay ?? 30_000;
|
|
162
|
+
return Math.min(base * factor ** attempt, max);
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
// ---------------------------------------------------------------------------
|
|
166
|
+
// useWebSocket
|
|
167
|
+
// ---------------------------------------------------------------------------
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Reactive WebSocket composable with auto-reconnect, heartbeat,
|
|
171
|
+
* typed messaging, and signal-based connection state.
|
|
172
|
+
*
|
|
173
|
+
* @template TSend - Type of outgoing messages (serialized via `serialize`)
|
|
174
|
+
* @template TReceive - Type of incoming messages (deserialized via `deserialize`)
|
|
175
|
+
* @param url - WebSocket URL (`ws://` or `wss://`) or a getter returning one
|
|
176
|
+
* @param options - Connection, reconnect, heartbeat, and serialization options
|
|
177
|
+
* @returns Reactive WebSocket state with `send()`, `open()`, `close()`, and `dispose()`
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
* ```ts
|
|
181
|
+
* import { useWebSocket } from '@bquery/bquery/reactive';
|
|
182
|
+
*
|
|
183
|
+
* const ws = useWebSocket<{ type: string; payload: unknown }>('wss://api.example.com/ws', {
|
|
184
|
+
* autoReconnect: { maxAttempts: 5, delay: 2000 },
|
|
185
|
+
* heartbeat: true,
|
|
186
|
+
* historySize: 50,
|
|
187
|
+
* onMessage: (data) => console.log('Received:', data),
|
|
188
|
+
* });
|
|
189
|
+
*
|
|
190
|
+
* ws.send({ type: 'subscribe', payload: { channel: 'updates' } });
|
|
191
|
+
*
|
|
192
|
+
* // Reactive state
|
|
193
|
+
* effect(() => {
|
|
194
|
+
* console.log('Connected:', ws.isConnected.value);
|
|
195
|
+
* console.log('Last message:', ws.data.value);
|
|
196
|
+
* });
|
|
197
|
+
*
|
|
198
|
+
* // Cleanup
|
|
199
|
+
* ws.dispose();
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
export const useWebSocket = <TSend = string, TReceive = string>(
|
|
203
|
+
url: string | URL | (() => string | URL),
|
|
204
|
+
options: UseWebSocketOptions<TSend, TReceive> = {}
|
|
205
|
+
): UseWebSocketReturn<TSend, TReceive> => {
|
|
206
|
+
const {
|
|
207
|
+
protocols,
|
|
208
|
+
immediate = true,
|
|
209
|
+
historySize = 0,
|
|
210
|
+
onOpen,
|
|
211
|
+
onMessage,
|
|
212
|
+
onClose,
|
|
213
|
+
onError,
|
|
214
|
+
onReconnect,
|
|
215
|
+
} = options;
|
|
216
|
+
|
|
217
|
+
const serialize = options.serialize ?? ((d: TSend) => JSON.stringify(d));
|
|
218
|
+
const deserialize =
|
|
219
|
+
options.deserialize ??
|
|
220
|
+
((event: MessageEvent) => {
|
|
221
|
+
const raw = event.data;
|
|
222
|
+
if (typeof raw === 'string') {
|
|
223
|
+
try {
|
|
224
|
+
return JSON.parse(raw) as TReceive;
|
|
225
|
+
} catch {
|
|
226
|
+
return raw as unknown as TReceive;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
return raw as TReceive;
|
|
230
|
+
});
|
|
231
|
+
|
|
232
|
+
// --- Reactive state ---
|
|
233
|
+
const status = signal<WebSocketStatus>('CLOSED');
|
|
234
|
+
const data = signal<TReceive | undefined>(undefined);
|
|
235
|
+
const error = signal<Event | null>(null);
|
|
236
|
+
const history = signal<TReceive[]>([]);
|
|
237
|
+
const reconnectAttempts = signal(0);
|
|
238
|
+
const latency = signal(0);
|
|
239
|
+
const lastDisconnectedAt = signal(0);
|
|
240
|
+
const isConnected = computed(() => status.value === 'OPEN');
|
|
241
|
+
|
|
242
|
+
// --- Internal state ---
|
|
243
|
+
let ws: WebSocket | null = null;
|
|
244
|
+
let disposed = false;
|
|
245
|
+
let explicitClose = false;
|
|
246
|
+
let reconnectTimer: ReturnType<typeof setTimeout> | undefined;
|
|
247
|
+
let heartbeatTimer: ReturnType<typeof setInterval> | undefined;
|
|
248
|
+
let pongTimer: ReturnType<typeof setTimeout> | undefined;
|
|
249
|
+
let internalReconnectCount = 0;
|
|
250
|
+
let isAutoReconnecting = false;
|
|
251
|
+
let pingSentAt = 0;
|
|
252
|
+
const sendQueue: Array<string | ArrayBufferLike | Blob | ArrayBufferView> = [];
|
|
253
|
+
|
|
254
|
+
const reconnectConfig = resolveReconnect(options.autoReconnect);
|
|
255
|
+
const heartbeatConfig = resolveHeartbeat(options.heartbeat);
|
|
256
|
+
|
|
257
|
+
// --- Heartbeat ---
|
|
258
|
+
const startHeartbeat = (): void => {
|
|
259
|
+
if (!heartbeatConfig) return;
|
|
260
|
+
stopHeartbeat();
|
|
261
|
+
const interval = heartbeatConfig.interval ?? 30_000;
|
|
262
|
+
const timeout = heartbeatConfig.pongTimeout ?? 10_000;
|
|
263
|
+
const pingMsg = heartbeatConfig.message ?? 'ping';
|
|
264
|
+
|
|
265
|
+
heartbeatTimer = setInterval(() => {
|
|
266
|
+
if (ws?.readyState === WebSocket.OPEN) {
|
|
267
|
+
pingSentAt = Date.now();
|
|
268
|
+
ws.send(pingMsg);
|
|
269
|
+
if (pongTimer !== undefined) {
|
|
270
|
+
clearTimeout(pongTimer);
|
|
271
|
+
}
|
|
272
|
+
pongTimer = setTimeout(() => {
|
|
273
|
+
// No pong received — force close to trigger reconnect
|
|
274
|
+
ws?.close(4000, 'Heartbeat timeout');
|
|
275
|
+
}, timeout);
|
|
276
|
+
}
|
|
277
|
+
}, interval);
|
|
278
|
+
};
|
|
279
|
+
|
|
280
|
+
const stopHeartbeat = (): void => {
|
|
281
|
+
if (heartbeatTimer !== undefined) {
|
|
282
|
+
clearInterval(heartbeatTimer);
|
|
283
|
+
heartbeatTimer = undefined;
|
|
284
|
+
}
|
|
285
|
+
if (pongTimer !== undefined) {
|
|
286
|
+
clearTimeout(pongTimer);
|
|
287
|
+
pongTimer = undefined;
|
|
288
|
+
}
|
|
289
|
+
};
|
|
290
|
+
|
|
291
|
+
const resetPongTimer = (): void => {
|
|
292
|
+
if (pongTimer !== undefined) {
|
|
293
|
+
clearTimeout(pongTimer);
|
|
294
|
+
pongTimer = undefined;
|
|
295
|
+
}
|
|
296
|
+
if (pingSentAt > 0) {
|
|
297
|
+
latency.value = Date.now() - pingSentAt;
|
|
298
|
+
pingSentAt = 0;
|
|
299
|
+
}
|
|
300
|
+
};
|
|
301
|
+
|
|
302
|
+
// --- Reconnect ---
|
|
303
|
+
const scheduleReconnect = (event: CloseEvent): void => {
|
|
304
|
+
if (disposed || explicitClose || !reconnectConfig) return;
|
|
305
|
+
|
|
306
|
+
const maxAttempts = reconnectConfig.maxAttempts ?? Infinity;
|
|
307
|
+
|
|
308
|
+
if (internalReconnectCount >= maxAttempts) return;
|
|
309
|
+
|
|
310
|
+
if (
|
|
311
|
+
reconnectConfig.shouldReconnect &&
|
|
312
|
+
!reconnectConfig.shouldReconnect(event, internalReconnectCount)
|
|
313
|
+
) {
|
|
314
|
+
return;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
const delay = computeDelay(internalReconnectCount, reconnectConfig);
|
|
318
|
+
reconnectTimer = setTimeout(() => {
|
|
319
|
+
internalReconnectCount++;
|
|
320
|
+
reconnectAttempts.value = internalReconnectCount;
|
|
321
|
+
isAutoReconnecting = true;
|
|
322
|
+
open();
|
|
323
|
+
}, delay);
|
|
324
|
+
};
|
|
325
|
+
|
|
326
|
+
const cancelReconnect = (): void => {
|
|
327
|
+
if (reconnectTimer !== undefined) {
|
|
328
|
+
clearTimeout(reconnectTimer);
|
|
329
|
+
reconnectTimer = undefined;
|
|
330
|
+
}
|
|
331
|
+
};
|
|
332
|
+
|
|
333
|
+
// --- Queue ---
|
|
334
|
+
const flushQueue = (): void => {
|
|
335
|
+
if (!ws || ws.readyState !== WebSocket.OPEN) {
|
|
336
|
+
return;
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
let index = 0;
|
|
340
|
+
for (; index < sendQueue.length; index++) {
|
|
341
|
+
if (ws.readyState !== WebSocket.OPEN) {
|
|
342
|
+
break;
|
|
343
|
+
}
|
|
344
|
+
ws.send(sendQueue[index]);
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
if (index > 0) {
|
|
348
|
+
sendQueue.splice(0, index);
|
|
349
|
+
}
|
|
350
|
+
};
|
|
351
|
+
|
|
352
|
+
// --- Core ---
|
|
353
|
+
const resolveUrl = (): string => {
|
|
354
|
+
const resolved = typeof url === 'function' ? url() : url;
|
|
355
|
+
return resolved instanceof URL ? resolved.toString() : resolved;
|
|
356
|
+
};
|
|
357
|
+
|
|
358
|
+
const open = (): void => {
|
|
359
|
+
if (disposed) return;
|
|
360
|
+
cancelReconnect();
|
|
361
|
+
|
|
362
|
+
// Clean up any existing connection
|
|
363
|
+
if (ws) {
|
|
364
|
+
stopHeartbeat();
|
|
365
|
+
pingSentAt = 0;
|
|
366
|
+
ws.onopen = null;
|
|
367
|
+
ws.onmessage = null;
|
|
368
|
+
ws.onclose = null;
|
|
369
|
+
ws.onerror = null;
|
|
370
|
+
if (ws.readyState === WebSocket.OPEN || ws.readyState === WebSocket.CONNECTING) {
|
|
371
|
+
ws.close();
|
|
372
|
+
}
|
|
373
|
+
ws = null;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
explicitClose = false;
|
|
377
|
+
status.value = 'CONNECTING';
|
|
378
|
+
error.value = null;
|
|
379
|
+
|
|
380
|
+
try {
|
|
381
|
+
ws = new WebSocket(resolveUrl(), protocols);
|
|
382
|
+
} catch {
|
|
383
|
+
status.value = 'CLOSED';
|
|
384
|
+
return;
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
ws.onopen = (event: Event): void => {
|
|
388
|
+
status.value = 'OPEN';
|
|
389
|
+
const wasReconnecting = isAutoReconnecting;
|
|
390
|
+
const reconnectCount = internalReconnectCount;
|
|
391
|
+
internalReconnectCount = 0;
|
|
392
|
+
reconnectAttempts.value = 0;
|
|
393
|
+
isAutoReconnecting = false;
|
|
394
|
+
flushQueue();
|
|
395
|
+
startHeartbeat();
|
|
396
|
+
onOpen?.(event);
|
|
397
|
+
if (wasReconnecting) {
|
|
398
|
+
onReconnect?.(reconnectCount);
|
|
399
|
+
}
|
|
400
|
+
};
|
|
401
|
+
|
|
402
|
+
ws.onmessage = (event: MessageEvent): void => {
|
|
403
|
+
// Heartbeat pong detection
|
|
404
|
+
if (heartbeatConfig) {
|
|
405
|
+
const responseMsg = heartbeatConfig.responseMessage;
|
|
406
|
+
if (responseMsg === undefined || event.data === responseMsg) {
|
|
407
|
+
resetPongTimer();
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
const deserialized = deserialize(event);
|
|
412
|
+
data.value = deserialized;
|
|
413
|
+
|
|
414
|
+
if (historySize > 0) {
|
|
415
|
+
const current = history.peek();
|
|
416
|
+
const updated = [...current, deserialized];
|
|
417
|
+
history.value = updated.length > historySize ? updated.slice(-historySize) : updated;
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
onMessage?.(deserialized, event);
|
|
421
|
+
};
|
|
422
|
+
|
|
423
|
+
ws.onclose = (event: CloseEvent): void => {
|
|
424
|
+
status.value = 'CLOSED';
|
|
425
|
+
stopHeartbeat();
|
|
426
|
+
|
|
427
|
+
if (!explicitClose) {
|
|
428
|
+
lastDisconnectedAt.value = Date.now();
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
onClose?.(event);
|
|
432
|
+
|
|
433
|
+
if (!explicitClose && !disposed) {
|
|
434
|
+
scheduleReconnect(event);
|
|
435
|
+
}
|
|
436
|
+
};
|
|
437
|
+
|
|
438
|
+
ws.onerror = (event: Event): void => {
|
|
439
|
+
error.value = event;
|
|
440
|
+
onError?.(event);
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
|
|
444
|
+
const close = (code?: number, reason?: string): void => {
|
|
445
|
+
explicitClose = true;
|
|
446
|
+
cancelReconnect();
|
|
447
|
+
stopHeartbeat();
|
|
448
|
+
|
|
449
|
+
if (ws) {
|
|
450
|
+
if (ws.readyState === WebSocket.OPEN || ws.readyState === WebSocket.CONNECTING) {
|
|
451
|
+
status.value = 'CLOSING';
|
|
452
|
+
ws.close(code, reason);
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
};
|
|
456
|
+
|
|
457
|
+
const send = (msg: TSend): void => {
|
|
458
|
+
if (disposed) return;
|
|
459
|
+
const serialized = serialize(msg);
|
|
460
|
+
sendRaw(serialized);
|
|
461
|
+
};
|
|
462
|
+
|
|
463
|
+
const sendRaw = (raw: string | ArrayBufferLike | Blob | ArrayBufferView): void => {
|
|
464
|
+
if (disposed) return;
|
|
465
|
+
if (ws?.readyState === WebSocket.OPEN) {
|
|
466
|
+
ws.send(raw);
|
|
467
|
+
} else {
|
|
468
|
+
sendQueue.push(raw);
|
|
469
|
+
}
|
|
470
|
+
};
|
|
471
|
+
|
|
472
|
+
const dispose = (): void => {
|
|
473
|
+
if (disposed) return;
|
|
474
|
+
disposed = true;
|
|
475
|
+
close();
|
|
476
|
+
sendQueue.length = 0;
|
|
477
|
+
ws = null;
|
|
478
|
+
};
|
|
479
|
+
|
|
480
|
+
// --- Start ---
|
|
481
|
+
if (immediate) {
|
|
482
|
+
open();
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
return {
|
|
486
|
+
status,
|
|
487
|
+
data,
|
|
488
|
+
error,
|
|
489
|
+
history,
|
|
490
|
+
isConnected,
|
|
491
|
+
reconnectAttempts,
|
|
492
|
+
latency,
|
|
493
|
+
lastDisconnectedAt,
|
|
494
|
+
send,
|
|
495
|
+
sendRaw,
|
|
496
|
+
open,
|
|
497
|
+
close,
|
|
498
|
+
dispose,
|
|
499
|
+
};
|
|
500
|
+
};
|
|
501
|
+
|
|
502
|
+
// ---------------------------------------------------------------------------
|
|
503
|
+
// useWebSocketChannel — topic-based multiplexer
|
|
504
|
+
// ---------------------------------------------------------------------------
|
|
505
|
+
|
|
506
|
+
/** Default channel message format used by `useWebSocketChannel()`. */
|
|
507
|
+
export interface ChannelMessage<T = unknown> {
|
|
508
|
+
/** Channel / topic name. */
|
|
509
|
+
channel: string;
|
|
510
|
+
/** Message payload. */
|
|
511
|
+
data: T;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/** Configuration for `useWebSocketChannel()`. */
|
|
515
|
+
export interface UseWebSocketChannelOptions<TSend = unknown, TReceive = unknown> {
|
|
516
|
+
/**
|
|
517
|
+
* Extract the channel name from an incoming deserialized message.
|
|
518
|
+
* Default: reads `(msg as ChannelMessage).channel`.
|
|
519
|
+
*/
|
|
520
|
+
getChannel?: (msg: TReceive) => string | undefined;
|
|
521
|
+
/**
|
|
522
|
+
* Wrap a payload + channel into the wire format before sending.
|
|
523
|
+
* Default: `{ channel, data }`.
|
|
524
|
+
*/
|
|
525
|
+
wrap?: (channel: string, data: TSend) => TReceive;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
/** A single channel subscription returned by `subscribe()`. */
|
|
529
|
+
export interface ChannelSubscription<TReceive = unknown> {
|
|
530
|
+
/** Reactive last message received on this channel. */
|
|
531
|
+
data: Signal<TReceive | undefined>;
|
|
532
|
+
/** Unsubscribe from this channel. */
|
|
533
|
+
unsubscribe: () => void;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/** Return value of `useWebSocketChannel()`. */
|
|
537
|
+
export interface UseWebSocketChannelReturn<TSend = unknown, TReceive = unknown> {
|
|
538
|
+
/** Subscribe to a topic. Multiple subscriptions to the same channel share a signal. */
|
|
539
|
+
subscribe: (channel: string) => ChannelSubscription<TReceive>;
|
|
540
|
+
/** Publish a message to a channel. */
|
|
541
|
+
publish: (channel: string, data: TSend) => void;
|
|
542
|
+
/** The underlying `useWebSocket` return for direct access. */
|
|
543
|
+
ws: UseWebSocketReturn<TReceive, TReceive>;
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* Topic-based channel multiplexer over a single WebSocket connection.
|
|
548
|
+
*
|
|
549
|
+
* Builds on `useWebSocket()` and routes incoming messages to per-channel
|
|
550
|
+
* reactive signals based on a configurable channel extractor.
|
|
551
|
+
*
|
|
552
|
+
* @template TSend - Type of outgoing message payloads
|
|
553
|
+
* @template TReceive - Type of incoming deserialized messages
|
|
554
|
+
* @param url - WebSocket URL
|
|
555
|
+
* @param wsOptions - All `useWebSocket` options
|
|
556
|
+
* @param channelOptions - Channel routing configuration
|
|
557
|
+
* @returns Channel multiplexer with `subscribe()`, `publish()`, and the underlying `ws`
|
|
558
|
+
*
|
|
559
|
+
* @example
|
|
560
|
+
* ```ts
|
|
561
|
+
* import { useWebSocketChannel } from '@bquery/bquery/reactive';
|
|
562
|
+
*
|
|
563
|
+
* const chat = useWebSocketChannel('wss://chat.example.com/ws');
|
|
564
|
+
*
|
|
565
|
+
* const general = chat.subscribe('general');
|
|
566
|
+
* const updates = chat.subscribe('updates');
|
|
567
|
+
*
|
|
568
|
+
* effect(() => console.log('General:', general.data.value));
|
|
569
|
+
*
|
|
570
|
+
* chat.publish('general', { text: 'Hello!' });
|
|
571
|
+
* ```
|
|
572
|
+
*/
|
|
573
|
+
export const useWebSocketChannel = <TSend = unknown, TReceive = unknown>(
|
|
574
|
+
url: string | URL | (() => string | URL),
|
|
575
|
+
wsOptions: UseWebSocketOptions<TReceive, TReceive> = {},
|
|
576
|
+
channelOptions: UseWebSocketChannelOptions<TSend, TReceive> = {}
|
|
577
|
+
): UseWebSocketChannelReturn<TSend, TReceive> => {
|
|
578
|
+
const getChannel =
|
|
579
|
+
channelOptions.getChannel ?? ((msg: TReceive) => (msg as ChannelMessage).channel);
|
|
580
|
+
|
|
581
|
+
const wrap =
|
|
582
|
+
channelOptions.wrap ??
|
|
583
|
+
((ch: string, data: TSend) => ({ channel: ch, data }) as unknown as TReceive);
|
|
584
|
+
|
|
585
|
+
const channels = new Map<string, Signal<TReceive | undefined>>();
|
|
586
|
+
const channelSubscriptions = new Map<string, number>();
|
|
587
|
+
|
|
588
|
+
const ws = useWebSocket<TReceive, TReceive>(url, {
|
|
589
|
+
...wsOptions,
|
|
590
|
+
onMessage: (msg, event) => {
|
|
591
|
+
const ch = getChannel(msg);
|
|
592
|
+
if (ch !== undefined) {
|
|
593
|
+
const sig = channels.get(ch);
|
|
594
|
+
if (sig) {
|
|
595
|
+
sig.value = msg;
|
|
596
|
+
}
|
|
597
|
+
}
|
|
598
|
+
wsOptions.onMessage?.(msg, event);
|
|
599
|
+
},
|
|
600
|
+
});
|
|
601
|
+
|
|
602
|
+
const subscribe = (channel: string): ChannelSubscription<TReceive> => {
|
|
603
|
+
let sig = channels.get(channel);
|
|
604
|
+
if (!sig) {
|
|
605
|
+
sig = signal<TReceive | undefined>(undefined);
|
|
606
|
+
channels.set(channel, sig);
|
|
607
|
+
}
|
|
608
|
+
channelSubscriptions.set(channel, (channelSubscriptions.get(channel) ?? 0) + 1);
|
|
609
|
+
let unsubscribed = false;
|
|
610
|
+
|
|
611
|
+
return {
|
|
612
|
+
data: sig,
|
|
613
|
+
unsubscribe: () => {
|
|
614
|
+
if (unsubscribed) return;
|
|
615
|
+
unsubscribed = true;
|
|
616
|
+
const remaining = (channelSubscriptions.get(channel) ?? 1) - 1;
|
|
617
|
+
if (remaining <= 0) {
|
|
618
|
+
channelSubscriptions.delete(channel);
|
|
619
|
+
channels.delete(channel);
|
|
620
|
+
} else {
|
|
621
|
+
channelSubscriptions.set(channel, remaining);
|
|
622
|
+
}
|
|
623
|
+
},
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
|
|
627
|
+
const publish = (channel: string, data: TSend): void => {
|
|
628
|
+
ws.send(wrap(channel, data));
|
|
629
|
+
};
|
|
630
|
+
|
|
631
|
+
return { subscribe, publish, ws };
|
|
632
|
+
};
|
|
633
|
+
|
|
634
|
+
// ---------------------------------------------------------------------------
|
|
635
|
+
// useEventSource
|
|
636
|
+
// ---------------------------------------------------------------------------
|
|
637
|
+
|
|
638
|
+
/** Configuration for `useEventSource()`. */
|
|
639
|
+
export interface UseEventSourceOptions<TData = unknown> {
|
|
640
|
+
/** Whether to open the connection immediately (default: true). */
|
|
641
|
+
immediate?: boolean;
|
|
642
|
+
/** Automatically reconnect on error (default: true). Pass a reconnect config to customize delay and attempt limits. */
|
|
643
|
+
autoReconnect?: boolean | EventSourceReconnectConfig;
|
|
644
|
+
/** Event names to listen for besides the default `message` event. */
|
|
645
|
+
events?: string[];
|
|
646
|
+
/** Deserializer for incoming event data. Default: `JSON.parse` with string fallback. */
|
|
647
|
+
deserialize?: (data: string) => TData;
|
|
648
|
+
/** EventSource init options (e.g. `withCredentials`). */
|
|
649
|
+
eventSourceInit?: EventSourceInit;
|
|
650
|
+
/** Called when the connection opens. */
|
|
651
|
+
onOpen?: (event: Event) => void;
|
|
652
|
+
/** Called when a message is received. */
|
|
653
|
+
onMessage?: (data: TData, event: MessageEvent) => void;
|
|
654
|
+
/** Called when an error occurs. */
|
|
655
|
+
onError?: (event: Event) => void;
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
/** Return value of `useEventSource()`. */
|
|
659
|
+
export interface UseEventSourceReturn<TData = unknown> {
|
|
660
|
+
/** Current connection status (`CONNECTING`, `OPEN`, `CLOSED`). */
|
|
661
|
+
status: { readonly value: EventSourceStatus; peek(): EventSourceStatus };
|
|
662
|
+
/** Last received data (deserialized). */
|
|
663
|
+
data: Signal<TData | undefined>;
|
|
664
|
+
/** Last event name that delivered data. */
|
|
665
|
+
eventName: Signal<string | undefined>;
|
|
666
|
+
/** Last error event. */
|
|
667
|
+
error: Signal<Event | null>;
|
|
668
|
+
/** Computed boolean — `true` when the EventSource is open. */
|
|
669
|
+
isConnected: { readonly value: boolean; peek(): boolean };
|
|
670
|
+
/** Manually open / reconnect the EventSource. */
|
|
671
|
+
open: () => void;
|
|
672
|
+
/** Close the connection. */
|
|
673
|
+
close: () => void;
|
|
674
|
+
/** Tear down all resources. */
|
|
675
|
+
dispose: () => void;
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Reactive Server-Sent Events (SSE) composable.
|
|
680
|
+
*
|
|
681
|
+
* Wraps the native `EventSource` API with reactive signals, auto-reconnect,
|
|
682
|
+
* and typed deserialization.
|
|
683
|
+
*
|
|
684
|
+
* @template TData - Type of deserialized event data
|
|
685
|
+
* @param url - SSE endpoint URL or a getter returning one
|
|
686
|
+
* @param options - EventSource options
|
|
687
|
+
* @returns Reactive EventSource state with `open()`, `close()`, and `dispose()`
|
|
688
|
+
*
|
|
689
|
+
* @example
|
|
690
|
+
* ```ts
|
|
691
|
+
* import { useEventSource } from '@bquery/bquery/reactive';
|
|
692
|
+
*
|
|
693
|
+
* const sse = useEventSource<{ type: string; message: string }>('/api/events', {
|
|
694
|
+
* events: ['notification', 'update'],
|
|
695
|
+
* onMessage: (data) => console.log('Event:', data),
|
|
696
|
+
* });
|
|
697
|
+
*
|
|
698
|
+
* effect(() => {
|
|
699
|
+
* if (sse.data.value) {
|
|
700
|
+
* console.log(`[${sse.eventName.value}]`, sse.data.value);
|
|
701
|
+
* }
|
|
702
|
+
* });
|
|
703
|
+
*
|
|
704
|
+
* sse.dispose();
|
|
705
|
+
* ```
|
|
706
|
+
*/
|
|
707
|
+
export const useEventSource = <TData = unknown>(
|
|
708
|
+
url: string | URL | (() => string | URL),
|
|
709
|
+
options: UseEventSourceOptions<TData> = {}
|
|
710
|
+
): UseEventSourceReturn<TData> => {
|
|
711
|
+
const { immediate = true, events = [], eventSourceInit, onOpen, onMessage, onError } = options;
|
|
712
|
+
|
|
713
|
+
const deserialize =
|
|
714
|
+
options.deserialize ??
|
|
715
|
+
((raw: string) => {
|
|
716
|
+
try {
|
|
717
|
+
return JSON.parse(raw) as TData;
|
|
718
|
+
} catch {
|
|
719
|
+
return raw as unknown as TData;
|
|
720
|
+
}
|
|
721
|
+
});
|
|
722
|
+
|
|
723
|
+
const status = signal<EventSourceStatus>('CLOSED');
|
|
724
|
+
const data = signal<TData | undefined>(undefined);
|
|
725
|
+
const eventName = signal<string | undefined>(undefined);
|
|
726
|
+
const error = signal<Event | null>(null);
|
|
727
|
+
const isConnected = computed(() => status.value === 'OPEN');
|
|
728
|
+
|
|
729
|
+
const reconnectConfig = resolveReconnect(options.autoReconnect);
|
|
730
|
+
|
|
731
|
+
let es: EventSource | null = null;
|
|
732
|
+
let disposed = false;
|
|
733
|
+
let explicitClose = false;
|
|
734
|
+
let reconnectTimer: ReturnType<typeof setTimeout> | undefined;
|
|
735
|
+
let reconnectAttemptCount = 0;
|
|
736
|
+
|
|
737
|
+
const resolveUrl = (): string => {
|
|
738
|
+
const resolved = typeof url === 'function' ? url() : url;
|
|
739
|
+
return resolved instanceof URL ? resolved.toString() : resolved;
|
|
740
|
+
};
|
|
741
|
+
|
|
742
|
+
const handleMessage =
|
|
743
|
+
(name: string) =>
|
|
744
|
+
(event: MessageEvent): void => {
|
|
745
|
+
const deserialized = deserialize(event.data);
|
|
746
|
+
data.value = deserialized;
|
|
747
|
+
eventName.value = name;
|
|
748
|
+
onMessage?.(deserialized, event);
|
|
749
|
+
};
|
|
750
|
+
|
|
751
|
+
const cancelReconnect = (): void => {
|
|
752
|
+
if (reconnectTimer !== undefined) {
|
|
753
|
+
clearTimeout(reconnectTimer);
|
|
754
|
+
reconnectTimer = undefined;
|
|
755
|
+
}
|
|
756
|
+
};
|
|
757
|
+
|
|
758
|
+
const scheduleReconnect = (): void => {
|
|
759
|
+
if (disposed || explicitClose || !reconnectConfig) return;
|
|
760
|
+
|
|
761
|
+
const maxAttempts = reconnectConfig.maxAttempts ?? Infinity;
|
|
762
|
+
if (reconnectAttemptCount >= maxAttempts) return;
|
|
763
|
+
|
|
764
|
+
const delay = computeDelay(reconnectAttemptCount, reconnectConfig);
|
|
765
|
+
reconnectTimer = setTimeout(() => {
|
|
766
|
+
reconnectAttemptCount++;
|
|
767
|
+
open();
|
|
768
|
+
}, delay);
|
|
769
|
+
};
|
|
770
|
+
|
|
771
|
+
const open = (): void => {
|
|
772
|
+
if (disposed) return;
|
|
773
|
+
cancelReconnect();
|
|
774
|
+
|
|
775
|
+
if (es) {
|
|
776
|
+
es.close();
|
|
777
|
+
es = null;
|
|
778
|
+
}
|
|
779
|
+
|
|
780
|
+
explicitClose = false;
|
|
781
|
+
status.value = 'CONNECTING';
|
|
782
|
+
error.value = null;
|
|
783
|
+
|
|
784
|
+
try {
|
|
785
|
+
es = new EventSource(resolveUrl(), eventSourceInit);
|
|
786
|
+
} catch {
|
|
787
|
+
status.value = 'CLOSED';
|
|
788
|
+
return;
|
|
789
|
+
}
|
|
790
|
+
|
|
791
|
+
es.onopen = (event: Event): void => {
|
|
792
|
+
status.value = 'OPEN';
|
|
793
|
+
reconnectAttemptCount = 0;
|
|
794
|
+
onOpen?.(event);
|
|
795
|
+
};
|
|
796
|
+
|
|
797
|
+
es.onerror = (event: Event): void => {
|
|
798
|
+
error.value = event;
|
|
799
|
+
onError?.(event);
|
|
800
|
+
|
|
801
|
+
// EventSource closes on error when readyState is CLOSED
|
|
802
|
+
if (es?.readyState === EventSource.CLOSED) {
|
|
803
|
+
status.value = 'CLOSED';
|
|
804
|
+
if (!explicitClose && !disposed) {
|
|
805
|
+
scheduleReconnect();
|
|
806
|
+
}
|
|
807
|
+
}
|
|
808
|
+
};
|
|
809
|
+
|
|
810
|
+
// Default "message" event
|
|
811
|
+
es.addEventListener('message', handleMessage('message'));
|
|
812
|
+
|
|
813
|
+
// Named events
|
|
814
|
+
for (const name of events) {
|
|
815
|
+
es.addEventListener(name, handleMessage(name) as EventListener);
|
|
816
|
+
}
|
|
817
|
+
};
|
|
818
|
+
|
|
819
|
+
const close = (): void => {
|
|
820
|
+
explicitClose = true;
|
|
821
|
+
cancelReconnect();
|
|
822
|
+
if (es) {
|
|
823
|
+
es.close();
|
|
824
|
+
es = null;
|
|
825
|
+
}
|
|
826
|
+
status.value = 'CLOSED';
|
|
827
|
+
};
|
|
828
|
+
|
|
829
|
+
const dispose = (): void => {
|
|
830
|
+
if (disposed) return;
|
|
831
|
+
disposed = true;
|
|
832
|
+
close();
|
|
833
|
+
};
|
|
834
|
+
|
|
835
|
+
if (immediate) {
|
|
836
|
+
open();
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
return {
|
|
840
|
+
status,
|
|
841
|
+
data,
|
|
842
|
+
eventName,
|
|
843
|
+
error,
|
|
844
|
+
isConnected,
|
|
845
|
+
open,
|
|
846
|
+
close,
|
|
847
|
+
dispose,
|
|
848
|
+
};
|
|
849
|
+
};
|