react-websocket 4.20.0 → 4.22.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.
- package/dist/ag-ui.cjs +8 -1
- package/dist/ag-ui.cjs.map +1 -1
- package/dist/ag-ui.d.cts +25 -5
- package/dist/ag-ui.d.ts +7 -0
- package/dist/ag-ui.js +8 -1
- package/dist/ag-ui.js.map +1 -1
- package/dist/core.cjs +34 -1
- package/dist/core.cjs.map +1 -1
- package/dist/core.d.cts +23 -5
- package/dist/core.d.ts +23 -5
- package/dist/core.js +34 -1
- package/dist/core.js.map +1 -1
- package/dist/index.d.cts +30 -5
- package/dist/index.d.ts +24 -5
- package/dist/outbox.cjs +27 -13
- package/dist/outbox.cjs.map +1 -1
- package/dist/outbox.d.cts +1 -1
- package/dist/outbox.js +27 -13
- package/dist/outbox.js.map +1 -1
- package/dist/replay.d.cts +1 -0
- package/dist/replay.d.ts +1 -0
- package/dist/tabs.cjs +1 -1
- package/dist/tabs.cjs.map +1 -1
- package/dist/tabs.d.cts +7 -0
- package/dist/tabs.d.ts +7 -0
- package/dist/tabs.js +1 -1
- package/dist/tabs.js.map +1 -1
- package/dist/timeline.d.cts +2 -1
- package/dist/{types-BEecFqIB.d.cts → types-paLT8yQF.d.cts} +11 -6
- package/package.json +11 -11
package/dist/tabs.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tabs.cjs","names":[],"sources":["../src/tabs.ts"],"sourcesContent":["// An entry with no imports: it only implements the `WebSocket` interface.\n\n/**\n * Recognize topic subscriptions, so tabs sharing a socket don't unsubscribe each other. With\n * `json`, only messages that parse are passed to these, and one that throws counts as\n * `undefined`, so heartbeat pings and other plain strings go through.\n */\nexport interface TabsTopics {\n /** The topic an outgoing message subscribes to, or `undefined`. */\n subscribe: (message: any) => string | null | undefined;\n /** The topic an outgoing message unsubscribes from, or `undefined`. */\n unsubscribe: (message: any) => string | null | undefined;\n /**\n * The topic of an incoming message, to deliver it only to the tabs that hold that topic.\n * Without it, every tab gets every message.\n */\n topic?: (message: any) => string | null | undefined;\n}\n\n/** Options for {@link createTabsWebSocket}. */\nexport interface TabsWebSocketOptions {\n /** The `WebSocket` the leading tab opens. Defaults to the global one. */\n WebSocket?: typeof WebSocket;\n /** Messages are JSON: the `topics` functions get them parsed. */\n json?: boolean;\n /** Share topic subscriptions between tabs. See {@link TabsTopics}. */\n topics?: TabsTopics;\n /**\n * How long the leading tab keeps the shared socket open after the last tab using it lets go,\n * in ms, so a reload doesn't close and reopen it.\n * @default 1000\n */\n linger?: number;\n}\n\n/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */\nexport interface TabsWebSocket {\n new (url: string | URL, protocols?: string | string[]): WebSocket;\n readonly prototype: WebSocket;\n readonly CONNECTING: 0;\n readonly OPEN: 1;\n readonly CLOSING: 2;\n readonly CLOSED: 3;\n /**\n * Stop leading and listening in this tab: close the shared sockets it holds and let another\n * tab take over. For tests and hot module reloading; a closed tab does this by itself.\n */\n dispose(): void;\n}\n\nconst CONNECTING = 0;\nconst OPEN = 1;\nconst CLOSING = 2;\nconst CLOSED = 3;\n\n/** What tabs say to each other over the channel. */\ntype Signal =\n | { t: 'connect'; id: string }\n | { t: 'send'; id: string; data: unknown }\n | { t: 'disconnect'; id: string }\n | { t: 'open'; id: string; protocol: string }\n | { t: 'message'; data: unknown; to?: string[] }\n | { t: 'close'; code: number; reason: string; wasClean: boolean }\n | { t: 'leader' };\n\nfunction closeEvent(code: number, reason: string, wasClean: boolean): Event {\n const init = { code, reason, wasClean };\n // Node 22 has no CloseEvent.\n return typeof CloseEvent === 'function'\n ? new CloseEvent('close', init)\n : Object.assign(new Event('close'), init);\n}\n\nlet ids = 0;\n\n// What `read()` returns for a message that isn't JSON.\nconst UNREAD = Symbol();\n\n/**\n * Share one WebSocket between all the tabs of an app. Pass the returned class as the\n * `WebSocket` option: every tab keeps its own client, with its own reconnects, queue, topics and\n * hooks, but only one tab, the leader, opens a connection to the server. The others reach it\n * through a `BroadcastChannel`. Users with ten tabs open cost the server one connection, not ten.\n *\n * - The leader is elected with the Web Locks API. When its tab closes, another tab takes over,\n * and every tab's client reconnects through it.\n * - Each tab's sends go out on the shared socket. Every message from the server reaches every\n * tab, or, with `topics`, only the tabs that hold its topic.\n * - With `topics`, an unsubscribe goes to the server only when no other tab still holds the topic.\n *\n * Where `BroadcastChannel` or the Web Locks API is missing, each tab opens its own socket, as\n * without this.\n *\n * @example\n * ```ts\n * import { createTabsWebSocket } from 'react-websocket/tabs';\n *\n * export const live = createWebSocket(url, {\n * json: true,\n * WebSocket: createTabsWebSocket({\n * json: true,\n * topics: {\n * subscribe: message => (message.type === 'subscribe' ? message.topic : undefined),\n * unsubscribe: message => (message.type === 'unsubscribe' ? message.topic : undefined),\n * topic: message => message.topic\n * }\n * })\n * });\n * ```\n */\nexport function createTabsWebSocket(options: TabsWebSocketOptions = {}): TabsWebSocket {\n const linger = options.linger ?? 1000;\n // One per URL in this tab: it waits to lead, and leads while it holds the lock.\n const agents = new Map<string, { channel: BroadcastChannel; stop: () => void }>();\n\n const read = (data: unknown) => {\n if (!options.json || typeof data !== 'string') return data;\n try {\n return JSON.parse(data);\n } catch {\n return UNREAD;\n }\n };\n\n /** A topic `recognize` finds in `data`, if it parses and `recognize` doesn't throw. */\n const topicOf = (\n recognize: ((message: any) => string | null | undefined) | undefined,\n message: unknown\n ) => {\n if (!recognize || message === UNREAD) return undefined;\n try {\n return recognize(message) ?? undefined;\n } catch {\n return undefined;\n }\n };\n\n // The sockets this tab has on shared ones. A tab that goes away tells the leading tab,\n // which would otherwise keep their topics and the shared socket for them.\n const live = new Set<() => void>();\n let hiding = false;\n const onPageHide = () => {\n for (const leave of [...live]) leave();\n };\n\n function agent(key: string, url: string, protocols: string | string[] | undefined) {\n if (agents.has(key)) return;\n const channel = new BroadcastChannel(key);\n const post = (signal: Signal) => channel.postMessage(signal);\n let real: WebSocket | undefined;\n // The tabs' sockets on the shared one, and whether each has been told it's open.\n const clients = new Map<string, boolean>();\n // Who holds each topic, so an unsubscribe waits for the last one.\n const holders = new Map<string, Set<string>>();\n let lingerTimer: ReturnType<typeof setTimeout> | undefined;\n let release: (() => void) | undefined;\n\n function opened(id: string) {\n clients.set(id, true);\n post({ t: 'open', id, protocol: real!.protocol });\n }\n\n function connect() {\n if (real) return;\n const Impl = options.WebSocket ?? globalThis.WebSocket;\n let socket: WebSocket;\n try {\n socket = real = new Impl(url, protocols);\n } catch {\n clients.clear();\n return post({ t: 'close', code: 1006, reason: '', wasClean: false });\n }\n socket.binaryType = 'arraybuffer';\n socket.onopen = () => {\n for (const [id, told] of clients) if (!told) opened(id);\n };\n socket.onmessage = event => {\n const topic = topicOf(options.topics?.topic, read(event.data));\n if (topic === undefined) return post({ t: 'message', data: event.data });\n const to = [...(holders.get(topic) ?? [])];\n if (to.length) post({ t: 'message', data: event.data, to });\n };\n socket.onerror = () => {};\n socket.onclose = event => {\n if (real !== socket) return;\n real = undefined;\n clients.clear();\n holders.clear();\n post({ t: 'close', code: event.code, reason: event.reason, wasClean: event.wasClean });\n };\n }\n\n function send(id: string, data: unknown) {\n const { topics } = options;\n if (topics) {\n const message = read(data);\n const subscribed = topicOf(topics.subscribe, message);\n if (subscribed !== undefined) {\n if (!holders.has(subscribed)) holders.set(subscribed, new Set());\n holders.get(subscribed)!.add(id);\n }\n const unsubscribed = topicOf(topics.unsubscribe, message);\n if (unsubscribed !== undefined) {\n const set = holders.get(unsubscribed);\n set?.delete(id);\n if (set?.size) return; // another tab still holds it\n holders.delete(unsubscribed);\n }\n }\n if (real?.readyState === OPEN) real.send(data as Parameters<WebSocket['send']>[0]);\n }\n\n function handle(signal: Signal) {\n if (signal.t === 'connect') {\n clearTimeout(lingerTimer);\n clients.set(signal.id, false);\n connect();\n if (real?.readyState === OPEN) opened(signal.id);\n } else if (signal.t === 'send') {\n if (clients.get(signal.id)) send(signal.id, signal.data);\n } else if (signal.t === 'disconnect') {\n clients.delete(signal.id);\n for (const set of holders.values()) set.delete(signal.id);\n if (!clients.size) {\n clearTimeout(lingerTimer);\n lingerTimer = setTimeout(() => {\n if (clients.size || !real) return;\n // Forget it first: a tab connecting while it closes gets a new one.\n const socket = real;\n real = undefined;\n socket.close(1000);\n }, linger);\n }\n }\n }\n\n agents.set(key, {\n channel,\n stop() {\n clearTimeout(lingerTimer);\n channel.close();\n if (real) {\n real.onclose = null;\n real.close(1000);\n }\n release?.();\n }\n });\n void navigator.locks.request(key, () => {\n if (!agents.has(key)) return;\n channel.onmessage = event => handle(event.data as Signal);\n // Sockets that were using the tab that led before start over with this one.\n post({ t: 'leader' });\n // Lead until this tab goes away, or `dispose()`.\n return new Promise<void>(resolve => (release = resolve));\n });\n }\n\n const Fallback = options.WebSocket;\n\n class TabSocket extends EventTarget implements WebSocket {\n static readonly CONNECTING = CONNECTING;\n static readonly OPEN = OPEN;\n static readonly CLOSING = CLOSING;\n static readonly CLOSED = CLOSED;\n readonly CONNECTING = CONNECTING;\n readonly OPEN = OPEN;\n readonly CLOSING = CLOSING;\n readonly CLOSED = CLOSED;\n\n readonly url: string;\n readonly extensions = '';\n onopen: WebSocket['onopen'] = null;\n onmessage: WebSocket['onmessage'] = null;\n onerror: WebSocket['onerror'] = null;\n onclose: WebSocket['onclose'] = null;\n binaryType: BinaryType = 'blob';\n protocol = '';\n\n #id = `${Date.now().toString(36)}-${++ids}-${Math.random().toString(36).slice(2)}`;\n #state: WebSocket['readyState'] = CONNECTING;\n #channel: BroadcastChannel | undefined;\n // The page is going away, or into the back/forward cache: let go of the shared socket, and\n // close, so a page that comes back connects again.\n #leave = () => {\n if (this.#state >= CLOSING) return; // `close()` told the leader already\n this.#post({ t: 'disconnect', id: this.#id });\n this.#end(1001, '', false);\n };\n // Without `BroadcastChannel` or locks: a socket of this tab's own.\n #inner: WebSocket | undefined;\n\n static dispose() {\n for (const { stop } of agents.values()) stop();\n agents.clear();\n }\n\n constructor(url: string | URL, protocols?: string | string[]) {\n super();\n if (typeof window === 'undefined') {\n throw new Error('react-websocket/tabs: no WebSocket here (server render?)');\n }\n for (const type of ['open', 'message', 'error', 'close'] as const) {\n this.addEventListener(type, event =>\n (this[`on${type}`] as ((event: Event) => void) | null)?.call(this, event)\n );\n }\n this.url = String(url);\n if (typeof BroadcastChannel === 'undefined' || !globalThis.navigator?.locks) {\n const inner = (this.#inner = new (Fallback ?? globalThis.WebSocket)(url, protocols));\n // As from the leading tab: `#message` turns it into what `binaryType` asks for.\n inner.binaryType = 'arraybuffer';\n inner.onopen = () => this.#open(inner.protocol);\n inner.onmessage = event => this.#message(event.data);\n inner.onerror = () => this.dispatchEvent(new Event('error'));\n inner.onclose = event => this.#end(event.code, event.reason, event.wasClean);\n return;\n }\n const key = `react-websocket-tabs:${this.url}\\u0000${JSON.stringify(protocols ?? null)}`;\n agent(key, this.url, protocols);\n const channel = (this.#channel = new BroadcastChannel(key));\n channel.onmessage = event => this.#signal(event.data as Signal);\n this.#post({ t: 'connect', id: this.#id });\n live.add(this.#leave);\n if (!hiding) {\n hiding = true;\n addEventListener('pagehide', onPageHide);\n }\n }\n\n get readyState() {\n return this.#state;\n }\n\n get bufferedAmount() {\n return this.#inner?.bufferedAmount ?? 0;\n }\n\n send(data: Parameters<WebSocket['send']>[0]) {\n if (this.#state === CONNECTING) {\n throw new DOMException('WebSocket is still in CONNECTING state', 'InvalidStateError');\n }\n if (this.#state !== OPEN) return;\n if (this.#inner) this.#inner.send(data);\n else this.#post({ t: 'send', id: this.#id, data });\n }\n\n close(code = 1000, reason = '') {\n if (this.#state >= CLOSING) return;\n // First, so that a code the socket rejects throws before anything has changed.\n if (this.#inner) this.#inner.close(code, reason);\n this.#state = CLOSING;\n if (this.#inner) return;\n // Only this tab's socket closes; the shared one stays for the others.\n this.#post({ t: 'disconnect', id: this.#id });\n setTimeout(() => this.#end(code, reason, true), 0);\n }\n\n #post(signal: Signal) {\n this.#channel?.postMessage(signal);\n }\n\n #signal(signal: Signal) {\n if (signal.t === 'open') {\n if (signal.id === this.#id && this.#state === CONNECTING) this.#open(signal.protocol);\n } else if (signal.t === 'message') {\n if (!signal.to || signal.to.includes(this.#id)) this.#message(signal.data);\n } else if (signal.t === 'close') {\n if (this.#state !== CONNECTING) this.#end(signal.code, signal.reason, signal.wasClean);\n else {\n // The shared socket failed before this one opened.\n this.dispatchEvent(new Event('error'));\n this.#end(signal.code, signal.reason, false);\n }\n } else if (signal.t === 'leader') {\n // A new leading tab: start over with it, or ask it to connect us.\n if (this.#state === CONNECTING) this.#post({ t: 'connect', id: this.#id });\n else this.#end(1006, '', false);\n }\n }\n\n #open(protocol: string) {\n this.#state = OPEN;\n this.protocol = protocol;\n this.dispatchEvent(new Event('open'));\n }\n\n #message(data: unknown) {\n if (this.#state !== OPEN) return;\n if (data instanceof ArrayBuffer && this.binaryType === 'blob') data = new Blob([data]);\n this.dispatchEvent(new MessageEvent('message', { data }));\n }\n\n #end(code: number, reason: string, wasClean: boolean) {\n if (this.#state === CLOSED) return;\n this.#state = CLOSED;\n this.#channel?.close();\n live.delete(this.#leave);\n this.dispatchEvent(closeEvent(code, reason, wasClean));\n }\n }\n\n return TabSocket as unknown as TabsWebSocket;\n}\n"],"mappings":";;AAkDA,MAAM,aAAa;AACnB,MAAM,OAAO;AACb,MAAM,UAAU;AAChB,MAAM,SAAS;AAYf,SAAS,WAAW,MAAc,QAAgB,UAA0B;CAC1E,MAAM,OAAO;EAAE;EAAM;EAAQ;CAAS;CAEtC,OAAO,OAAO,eAAe,aACzB,IAAI,WAAW,SAAS,IAAI,IAC5B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG,IAAI;AAC5C;AAEA,IAAI,MAAM;AAGV,MAAM,SAAS,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtB,SAAgB,oBAAoB,UAAgC,CAAC,GAAkB;CACrF,MAAM,SAAS,QAAQ,UAAU;CAEjC,MAAM,yBAAS,IAAI,IAA6D;CAEhF,MAAM,QAAQ,SAAkB;EAC9B,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,UAAU,OAAO;EACtD,IAAI;GACF,OAAO,KAAK,MAAM,IAAI;EACxB,QAAQ;GACN,OAAO;EACT;CACF;;CAGA,MAAM,WACJ,WACA,YACG;EACH,IAAI,CAAC,aAAa,YAAY,QAAQ,OAAO,KAAA;EAC7C,IAAI;GACF,OAAO,UAAU,OAAO,KAAK,KAAA;EAC/B,QAAQ;GACN;EACF;CACF;CAIA,MAAM,uBAAO,IAAI,IAAgB;CACjC,IAAI,SAAS;CACb,MAAM,mBAAmB;EACvB,KAAK,MAAM,SAAS,CAAC,GAAG,IAAI,GAAG,MAAM;CACvC;CAEA,SAAS,MAAM,KAAa,KAAa,WAA0C;EACjF,IAAI,OAAO,IAAI,GAAG,GAAG;EACrB,MAAM,UAAU,IAAI,iBAAiB,GAAG;EACxC,MAAM,QAAQ,WAAmB,QAAQ,YAAY,MAAM;EAC3D,IAAI;EAEJ,MAAM,0BAAU,IAAI,IAAqB;EAEzC,MAAM,0BAAU,IAAI,IAAyB;EAC7C,IAAI;EACJ,IAAI;EAEJ,SAAS,OAAO,IAAY;GAC1B,QAAQ,IAAI,IAAI,IAAI;GACpB,KAAK;IAAE,GAAG;IAAQ;IAAI,UAAU,KAAM;GAAS,CAAC;EAClD;EAEA,SAAS,UAAU;GACjB,IAAI,MAAM;GACV,MAAM,OAAO,QAAQ,aAAa,WAAW;GAC7C,IAAI;GACJ,IAAI;IACF,SAAS,OAAO,IAAI,KAAK,KAAK,SAAS;GACzC,QAAQ;IACN,QAAQ,MAAM;IACd,OAAO,KAAK;KAAE,GAAG;KAAS,MAAM;KAAM,QAAQ;KAAI,UAAU;IAAM,CAAC;GACrE;GACA,OAAO,aAAa;GACpB,OAAO,eAAe;IACpB,KAAK,MAAM,CAAC,IAAI,SAAS,SAAS,IAAI,CAAC,MAAM,OAAO,EAAE;GACxD;GACA,OAAO,aAAY,UAAS;IAC1B,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,OAAO,KAAK,MAAM,IAAI,CAAC;IAC7D,IAAI,UAAU,KAAA,GAAW,OAAO,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;IAAK,CAAC;IACvE,MAAM,KAAK,CAAC,GAAI,QAAQ,IAAI,KAAK,KAAK,CAAC,CAAE;IACzC,IAAI,GAAG,QAAQ,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;KAAM;IAAG,CAAC;GAC5D;GACA,OAAO,gBAAgB,CAAC;GACxB,OAAO,WAAU,UAAS;IACxB,IAAI,SAAS,QAAQ;IACrB,OAAO,KAAA;IACP,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,KAAK;KAAE,GAAG;KAAS,MAAM,MAAM;KAAM,QAAQ,MAAM;KAAQ,UAAU,MAAM;IAAS,CAAC;GACvF;EACF;EAEA,SAAS,KAAK,IAAY,MAAe;GACvC,MAAM,EAAE,WAAW;GACnB,IAAI,QAAQ;IACV,MAAM,UAAU,KAAK,IAAI;IACzB,MAAM,aAAa,QAAQ,OAAO,WAAW,OAAO;IACpD,IAAI,eAAe,KAAA,GAAW;KAC5B,IAAI,CAAC,QAAQ,IAAI,UAAU,GAAG,QAAQ,IAAI,4BAAY,IAAI,IAAI,CAAC;KAC/D,QAAQ,IAAI,UAAU,CAAC,CAAE,IAAI,EAAE;IACjC;IACA,MAAM,eAAe,QAAQ,OAAO,aAAa,OAAO;IACxD,IAAI,iBAAiB,KAAA,GAAW;KAC9B,MAAM,MAAM,QAAQ,IAAI,YAAY;KACpC,KAAK,OAAO,EAAE;KACd,IAAI,KAAK,MAAM;KACf,QAAQ,OAAO,YAAY;IAC7B;GACF;GACA,IAAI,MAAM,eAAe,MAAM,KAAK,KAAK,IAAwC;EACnF;EAEA,SAAS,OAAO,QAAgB;GAC9B,IAAI,OAAO,MAAM,WAAW;IAC1B,aAAa,WAAW;IACxB,QAAQ,IAAI,OAAO,IAAI,KAAK;IAC5B,QAAQ;IACR,IAAI,MAAM,eAAe,MAAM,OAAO,OAAO,EAAE;GACjD,OAAO,IAAI,OAAO,MAAM,QAClB;QAAA,QAAQ,IAAI,OAAO,EAAE,GAAG,KAAK,OAAO,IAAI,OAAO,IAAI;GAAA,OAClD,IAAI,OAAO,MAAM,cAAc;IACpC,QAAQ,OAAO,OAAO,EAAE;IACxB,KAAK,MAAM,OAAO,QAAQ,OAAO,GAAG,IAAI,OAAO,OAAO,EAAE;IACxD,IAAI,CAAC,QAAQ,MAAM;KACjB,aAAa,WAAW;KACxB,cAAc,iBAAiB;MAC7B,IAAI,QAAQ,QAAQ,CAAC,MAAM;MAE3B,MAAM,SAAS;MACf,OAAO,KAAA;MACP,OAAO,MAAM,GAAI;KACnB,GAAG,MAAM;IACX;GACF;EACF;EAEA,OAAO,IAAI,KAAK;GACd;GACA,OAAO;IACL,aAAa,WAAW;IACxB,QAAQ,MAAM;IACd,IAAI,MAAM;KACR,KAAK,UAAU;KACf,KAAK,MAAM,GAAI;IACjB;IACA,UAAU;GACZ;EACF,CAAC;EACD,UAAe,MAAM,QAAQ,WAAW;GACtC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG;GACtB,QAAQ,aAAY,UAAS,OAAO,MAAM,IAAc;GAExD,KAAK,EAAE,GAAG,SAAS,CAAC;GAEpB,OAAO,IAAI,SAAc,YAAY,UAAU,OAAQ;EACzD,CAAC;CACH;CAEA,MAAM,WAAW,QAAQ;CAEzB,MAAM,kBAAkB,YAAiC;EACvD,OAAgB,aAAa;EAC7B,OAAgB,OAAO;EACvB,OAAgB,UAAU;EAC1B,OAAgB,SAAS;EACzB,aAAsB;EACtB,OAAgB;EAChB,UAAmB;EACnB,SAAkB;EAElB;EACA,aAAsB;EACtB,SAA8B;EAC9B,YAAoC;EACpC,UAAgC;EAChC,UAAgC;EAChC,aAAyB;EACzB,WAAW;EAEX,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;EAC/E,SAAkC;EAClC;EAGA,eAAe;GACb,IAAI,KAAK,UAAU,SAAS;GAC5B,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,KAAK,KAAK,MAAM,IAAI,KAAK;EAC3B;EAEA;EAEA,OAAO,UAAU;GACf,KAAK,MAAM,EAAE,UAAU,OAAO,OAAO,GAAG,KAAK;GAC7C,OAAO,MAAM;EACf;EAEA,YAAY,KAAmB,WAA+B;GAC5D,MAAM;GACN,IAAI,OAAO,WAAW,aACpB,MAAM,IAAI,MAAM,0DAA0D;GAE5E,KAAK,MAAM,QAAQ;IAAC;IAAQ;IAAW;IAAS;GAAO,GACrD,KAAK,iBAAiB,OAAM,UACzB,KAAK,KAAK,OAAO,EAAsC,KAAK,MAAM,KAAK,CAC1E;GAEF,KAAK,MAAM,OAAO,GAAG;GACrB,IAAI,OAAO,qBAAqB,eAAe,CAAC,WAAW,WAAW,OAAO;IAC3E,MAAM,QAAS,KAAK,SAAS,KAAK,YAAY,WAAW,WAAW,KAAK,SAAS;IAElF,MAAM,aAAa;IACnB,MAAM,eAAe,KAAK,MAAM,MAAM,QAAQ;IAC9C,MAAM,aAAY,UAAS,KAAK,SAAS,MAAM,IAAI;IACnD,MAAM,gBAAgB,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;IAC3D,MAAM,WAAU,UAAS,KAAK,KAAK,MAAM,MAAM,MAAM,QAAQ,MAAM,QAAQ;IAC3E;GACF;GACA,MAAM,MAAM,wBAAwB,KAAK,IAAI,QAAQ,KAAK,UAAU,aAAa,IAAI;GACrF,MAAM,KAAK,KAAK,KAAK,SAAS;GAC9B,MAAM,UAAW,KAAK,WAAW,IAAI,iBAAiB,GAAG;GACzD,QAAQ,aAAY,UAAS,KAAK,QAAQ,MAAM,IAAc;GAC9D,KAAK,MAAM;IAAE,GAAG;IAAW,IAAI,KAAK;GAAI,CAAC;GACzC,KAAK,IAAI,KAAK,MAAM;GACpB,IAAI,CAAC,QAAQ;IACX,SAAS;IACT,iBAAiB,YAAY,UAAU;GACzC;EACF;EAEA,IAAI,aAAa;GACf,OAAO,KAAK;EACd;EAEA,IAAI,iBAAiB;GACnB,OAAO,KAAK,QAAQ,kBAAkB;EACxC;EAEA,KAAK,MAAwC;GAC3C,IAAI,KAAK,WAAW,YAClB,MAAM,IAAI,aAAa,0CAA0C,mBAAmB;GAEtF,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,KAAK,QAAQ,KAAK,OAAO,KAAK,IAAI;QACjC,KAAK,MAAM;IAAE,GAAG;IAAQ,IAAI,KAAK;IAAK;GAAK,CAAC;EACnD;EAEA,MAAM,OAAO,KAAM,SAAS,IAAI;GAC9B,IAAI,KAAK,UAAU,SAAS;GAE5B,IAAI,KAAK,QAAQ,KAAK,OAAO,MAAM,MAAM,MAAM;GAC/C,KAAK,SAAS;GACd,IAAI,KAAK,QAAQ;GAEjB,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,iBAAiB,KAAK,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC;EACnD;EAEA,MAAM,QAAgB;GACpB,KAAK,UAAU,YAAY,MAAM;EACnC;EAEA,QAAQ,QAAgB;GACtB,IAAI,OAAO,MAAM,QACX;QAAA,OAAO,OAAO,KAAK,OAAO,KAAK,WAAW,YAAY,KAAK,MAAM,OAAO,QAAQ;GAAA,OAC/E,IAAI,OAAO,MAAM,WAClB;QAAA,CAAC,OAAO,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,KAAK,SAAS,OAAO,IAAI;GAAA,OACpE,IAAI,OAAO,MAAM,SAAS;IAC/B,IAAI,KAAK,WAAW,YAAY,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,OAAO,QAAQ;SAChF;KAEH,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;KACrC,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,KAAK;IAC7C;GACF,OAAO,IAAI,OAAO,MAAM,UAAU;IAEhC,IAAI,KAAK,WAAW,YAAY,KAAK,MAAM;KAAE,GAAG;KAAW,IAAI,KAAK;IAAI,CAAC;SACpE,KAAK,KAAK,MAAM,IAAI,KAAK;GAChC;EACF;EAEA,MAAM,UAAkB;GACtB,KAAK,SAAS;GACd,KAAK,WAAW;GAChB,KAAK,cAAc,IAAI,MAAM,MAAM,CAAC;EACtC;EAEA,SAAS,MAAe;GACtB,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,gBAAgB,eAAe,KAAK,eAAe,QAAQ,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC;GACrF,KAAK,cAAc,IAAI,aAAa,WAAW,EAAE,KAAK,CAAC,CAAC;EAC1D;EAEA,KAAK,MAAc,QAAgB,UAAmB;GACpD,IAAI,KAAK,WAAW,QAAQ;GAC5B,KAAK,SAAS;GACd,KAAK,UAAU,MAAM;GACrB,KAAK,OAAO,KAAK,MAAM;GACvB,KAAK,cAAc,WAAW,MAAM,QAAQ,QAAQ,CAAC;EACvD;CACF;CAEA,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"tabs.cjs","names":[],"sources":["../src/tabs.ts"],"sourcesContent":["// An entry with no imports: it only implements the `WebSocket` interface.\n\n/**\n * Recognize topic subscriptions, so tabs sharing a socket don't unsubscribe each other. With\n * `json`, only messages that parse are passed to these, and one that throws counts as\n * `undefined`, so heartbeat pings and other plain strings go through.\n */\nexport interface TabsTopics {\n /** The topic an outgoing message subscribes to, or `undefined`. */\n subscribe: (message: any) => string | null | undefined;\n /** The topic an outgoing message unsubscribes from, or `undefined`. */\n unsubscribe: (message: any) => string | null | undefined;\n /**\n * The topic of an incoming message, to deliver it only to the tabs that hold that topic.\n * Without it, every tab gets every message.\n */\n topic?: (message: any) => string | null | undefined;\n}\n\n/** Options for {@link createTabsWebSocket}. */\nexport interface TabsWebSocketOptions {\n /** The `WebSocket` the leading tab opens. Defaults to the global one. */\n WebSocket?: typeof WebSocket;\n /** Messages are JSON: the `topics` functions get them parsed. */\n json?: boolean;\n /** Share topic subscriptions between tabs. See {@link TabsTopics}. */\n topics?: TabsTopics;\n /**\n * How long the leading tab keeps the shared socket open after the last tab using it lets go,\n * in ms, so a reload doesn't close and reopen it.\n * @default 1000\n */\n linger?: number;\n /**\n * Who is signed in, such as the user's id. Tabs share a connection only with tabs that return\n * the same value, so when another user signs in, `close()` and then `connect()` open a\n * connection of their own instead of joining the one the previous user authenticated. Read\n * for every new socket.\n */\n session?: () => string | null | undefined;\n}\n\n/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */\nexport interface TabsWebSocket {\n new (url: string | URL, protocols?: string | string[]): WebSocket;\n readonly prototype: WebSocket;\n readonly CONNECTING: 0;\n readonly OPEN: 1;\n readonly CLOSING: 2;\n readonly CLOSED: 3;\n /**\n * Stop leading and listening in this tab: close the shared sockets it holds and let another\n * tab take over. For tests and hot module reloading; a closed tab does this by itself.\n */\n dispose(): void;\n}\n\nconst CONNECTING = 0;\nconst OPEN = 1;\nconst CLOSING = 2;\nconst CLOSED = 3;\n\n/** What tabs say to each other over the channel. */\ntype Signal =\n | { t: 'connect'; id: string }\n | { t: 'send'; id: string; data: unknown }\n | { t: 'disconnect'; id: string }\n | { t: 'open'; id: string; protocol: string }\n | { t: 'message'; data: unknown; to?: string[] }\n | { t: 'close'; code: number; reason: string; wasClean: boolean }\n | { t: 'leader' };\n\nfunction closeEvent(code: number, reason: string, wasClean: boolean): Event {\n const init = { code, reason, wasClean };\n // Node 22 has no CloseEvent.\n return typeof CloseEvent === 'function'\n ? new CloseEvent('close', init)\n : Object.assign(new Event('close'), init);\n}\n\nlet ids = 0;\n\n// What `read()` returns for a message that isn't JSON.\nconst UNREAD = Symbol();\n\n/**\n * Share one WebSocket between all the tabs of an app. Pass the returned class as the\n * `WebSocket` option: every tab keeps its own client, with its own reconnects, queue, topics and\n * hooks, but only one tab, the leader, opens a connection to the server. The others reach it\n * through a `BroadcastChannel`. Users with ten tabs open cost the server one connection, not ten.\n *\n * - The leader is elected with the Web Locks API. When its tab closes, another tab takes over,\n * and every tab's client reconnects through it.\n * - Each tab's sends go out on the shared socket. Every message from the server reaches every\n * tab, or, with `topics`, only the tabs that hold its topic.\n * - With `topics`, an unsubscribe goes to the server only when no other tab still holds the topic.\n *\n * Where `BroadcastChannel` or the Web Locks API is missing, each tab opens its own socket, as\n * without this.\n *\n * @example\n * ```ts\n * import { createTabsWebSocket } from 'react-websocket/tabs';\n *\n * export const live = createWebSocket(url, {\n * json: true,\n * WebSocket: createTabsWebSocket({\n * json: true,\n * topics: {\n * subscribe: message => (message.type === 'subscribe' ? message.topic : undefined),\n * unsubscribe: message => (message.type === 'unsubscribe' ? message.topic : undefined),\n * topic: message => message.topic\n * }\n * })\n * });\n * ```\n */\nexport function createTabsWebSocket(options: TabsWebSocketOptions = {}): TabsWebSocket {\n const linger = options.linger ?? 1000;\n // One per URL in this tab: it waits to lead, and leads while it holds the lock.\n const agents = new Map<string, { channel: BroadcastChannel; stop: () => void }>();\n\n const read = (data: unknown) => {\n if (!options.json || typeof data !== 'string') return data;\n try {\n return JSON.parse(data);\n } catch {\n return UNREAD;\n }\n };\n\n /** A topic `recognize` finds in `data`, if it parses and `recognize` doesn't throw. */\n const topicOf = (\n recognize: ((message: any) => string | null | undefined) | undefined,\n message: unknown\n ) => {\n if (!recognize || message === UNREAD) return undefined;\n try {\n return recognize(message) ?? undefined;\n } catch {\n return undefined;\n }\n };\n\n // The sockets this tab has on shared ones. A tab that goes away tells the leading tab,\n // which would otherwise keep their topics and the shared socket for them.\n const live = new Set<() => void>();\n let hiding = false;\n const onPageHide = () => {\n for (const leave of [...live]) leave();\n };\n\n function agent(key: string, url: string, protocols: string | string[] | undefined) {\n if (agents.has(key)) return;\n const channel = new BroadcastChannel(key);\n const post = (signal: Signal) => channel.postMessage(signal);\n let real: WebSocket | undefined;\n // The tabs' sockets on the shared one, and whether each has been told it's open.\n const clients = new Map<string, boolean>();\n // Who holds each topic, so an unsubscribe waits for the last one.\n const holders = new Map<string, Set<string>>();\n let lingerTimer: ReturnType<typeof setTimeout> | undefined;\n let release: (() => void) | undefined;\n\n function opened(id: string) {\n clients.set(id, true);\n post({ t: 'open', id, protocol: real!.protocol });\n }\n\n function connect() {\n if (real) return;\n const Impl = options.WebSocket ?? globalThis.WebSocket;\n let socket: WebSocket;\n try {\n socket = real = new Impl(url, protocols);\n } catch {\n clients.clear();\n return post({ t: 'close', code: 1006, reason: '', wasClean: false });\n }\n socket.binaryType = 'arraybuffer';\n socket.onopen = () => {\n for (const [id, told] of clients) if (!told) opened(id);\n };\n socket.onmessage = event => {\n const topic = topicOf(options.topics?.topic, read(event.data));\n if (topic === undefined) return post({ t: 'message', data: event.data });\n const to = [...(holders.get(topic) ?? [])];\n if (to.length) post({ t: 'message', data: event.data, to });\n };\n socket.onerror = () => {};\n socket.onclose = event => {\n if (real !== socket) return;\n real = undefined;\n clients.clear();\n holders.clear();\n post({ t: 'close', code: event.code, reason: event.reason, wasClean: event.wasClean });\n };\n }\n\n function send(id: string, data: unknown) {\n const { topics } = options;\n if (topics) {\n const message = read(data);\n const subscribed = topicOf(topics.subscribe, message);\n if (subscribed !== undefined) {\n if (!holders.has(subscribed)) holders.set(subscribed, new Set());\n holders.get(subscribed)!.add(id);\n }\n const unsubscribed = topicOf(topics.unsubscribe, message);\n if (unsubscribed !== undefined) {\n const set = holders.get(unsubscribed);\n set?.delete(id);\n if (set?.size) return; // another tab still holds it\n holders.delete(unsubscribed);\n }\n }\n if (real?.readyState === OPEN) real.send(data as Parameters<WebSocket['send']>[0]);\n }\n\n function handle(signal: Signal) {\n if (signal.t === 'connect') {\n clearTimeout(lingerTimer);\n clients.set(signal.id, false);\n connect();\n if (real?.readyState === OPEN) opened(signal.id);\n } else if (signal.t === 'send') {\n if (clients.get(signal.id)) send(signal.id, signal.data);\n } else if (signal.t === 'disconnect') {\n clients.delete(signal.id);\n for (const set of holders.values()) set.delete(signal.id);\n if (!clients.size) {\n clearTimeout(lingerTimer);\n lingerTimer = setTimeout(() => {\n if (clients.size || !real) return;\n // Forget it first: a tab connecting while it closes gets a new one.\n const socket = real;\n real = undefined;\n socket.close(1000);\n }, linger);\n }\n }\n }\n\n agents.set(key, {\n channel,\n stop() {\n clearTimeout(lingerTimer);\n channel.close();\n if (real) {\n real.onclose = null;\n real.close(1000);\n }\n release?.();\n }\n });\n void navigator.locks.request(key, () => {\n if (!agents.has(key)) return;\n channel.onmessage = event => handle(event.data as Signal);\n // Sockets that were using the tab that led before start over with this one.\n post({ t: 'leader' });\n // Lead until this tab goes away, or `dispose()`.\n return new Promise<void>(resolve => (release = resolve));\n });\n }\n\n const Fallback = options.WebSocket;\n\n class TabSocket extends EventTarget implements WebSocket {\n static readonly CONNECTING = CONNECTING;\n static readonly OPEN = OPEN;\n static readonly CLOSING = CLOSING;\n static readonly CLOSED = CLOSED;\n readonly CONNECTING = CONNECTING;\n readonly OPEN = OPEN;\n readonly CLOSING = CLOSING;\n readonly CLOSED = CLOSED;\n\n readonly url: string;\n readonly extensions = '';\n onopen: WebSocket['onopen'] = null;\n onmessage: WebSocket['onmessage'] = null;\n onerror: WebSocket['onerror'] = null;\n onclose: WebSocket['onclose'] = null;\n binaryType: BinaryType = 'blob';\n protocol = '';\n\n #id = `${Date.now().toString(36)}-${++ids}-${Math.random().toString(36).slice(2)}`;\n #state: WebSocket['readyState'] = CONNECTING;\n #channel: BroadcastChannel | undefined;\n // The page is going away, or into the back/forward cache: let go of the shared socket, and\n // close, so a page that comes back connects again.\n #leave = () => {\n if (this.#state >= CLOSING) return; // `close()` told the leader already\n this.#post({ t: 'disconnect', id: this.#id });\n this.#end(1001, '', false);\n };\n // Without `BroadcastChannel` or locks: a socket of this tab's own.\n #inner: WebSocket | undefined;\n\n static dispose() {\n for (const { stop } of agents.values()) stop();\n agents.clear();\n }\n\n constructor(url: string | URL, protocols?: string | string[]) {\n super();\n if (typeof window === 'undefined') {\n throw new Error('react-websocket/tabs: no WebSocket here (server render?)');\n }\n for (const type of ['open', 'message', 'error', 'close'] as const) {\n this.addEventListener(type, event =>\n (this[`on${type}`] as ((event: Event) => void) | null)?.call(this, event)\n );\n }\n this.url = String(url);\n if (typeof BroadcastChannel === 'undefined' || !globalThis.navigator?.locks) {\n const inner = (this.#inner = new (Fallback ?? globalThis.WebSocket)(url, protocols));\n // As from the leading tab: `#message` turns it into what `binaryType` asks for.\n inner.binaryType = 'arraybuffer';\n inner.onopen = () => this.#open(inner.protocol);\n inner.onmessage = event => this.#message(event.data);\n inner.onerror = () => this.dispatchEvent(new Event('error'));\n inner.onclose = event => this.#end(event.code, event.reason, event.wasClean);\n return;\n }\n // The session goes first: Node routes channel messages by the name up to a NUL.\n const session = options.session\n ? `session=${encodeURIComponent(options.session() ?? '')}:`\n : '';\n const key = `react-websocket-tabs:${session}${this.url}\\u0000${JSON.stringify(protocols ?? null)}`;\n agent(key, this.url, protocols);\n const channel = (this.#channel = new BroadcastChannel(key));\n channel.onmessage = event => this.#signal(event.data as Signal);\n this.#post({ t: 'connect', id: this.#id });\n live.add(this.#leave);\n if (!hiding) {\n hiding = true;\n addEventListener('pagehide', onPageHide);\n }\n }\n\n get readyState() {\n return this.#state;\n }\n\n get bufferedAmount() {\n return this.#inner?.bufferedAmount ?? 0;\n }\n\n send(data: Parameters<WebSocket['send']>[0]) {\n if (this.#state === CONNECTING) {\n throw new DOMException('WebSocket is still in CONNECTING state', 'InvalidStateError');\n }\n if (this.#state !== OPEN) return;\n if (this.#inner) this.#inner.send(data);\n else this.#post({ t: 'send', id: this.#id, data });\n }\n\n close(code = 1000, reason = '') {\n if (this.#state >= CLOSING) return;\n // First, so that a code the socket rejects throws before anything has changed.\n if (this.#inner) this.#inner.close(code, reason);\n this.#state = CLOSING;\n if (this.#inner) return;\n // Only this tab's socket closes; the shared one stays for the others.\n this.#post({ t: 'disconnect', id: this.#id });\n setTimeout(() => this.#end(code, reason, true), 0);\n }\n\n #post(signal: Signal) {\n this.#channel?.postMessage(signal);\n }\n\n #signal(signal: Signal) {\n if (signal.t === 'open') {\n if (signal.id === this.#id && this.#state === CONNECTING) this.#open(signal.protocol);\n } else if (signal.t === 'message') {\n if (!signal.to || signal.to.includes(this.#id)) this.#message(signal.data);\n } else if (signal.t === 'close') {\n if (this.#state !== CONNECTING) this.#end(signal.code, signal.reason, signal.wasClean);\n else {\n // The shared socket failed before this one opened.\n this.dispatchEvent(new Event('error'));\n this.#end(signal.code, signal.reason, false);\n }\n } else if (signal.t === 'leader') {\n // A new leading tab: start over with it, or ask it to connect us.\n if (this.#state === CONNECTING) this.#post({ t: 'connect', id: this.#id });\n else this.#end(1006, '', false);\n }\n }\n\n #open(protocol: string) {\n this.#state = OPEN;\n this.protocol = protocol;\n this.dispatchEvent(new Event('open'));\n }\n\n #message(data: unknown) {\n if (this.#state !== OPEN) return;\n if (data instanceof ArrayBuffer && this.binaryType === 'blob') data = new Blob([data]);\n this.dispatchEvent(new MessageEvent('message', { data }));\n }\n\n #end(code: number, reason: string, wasClean: boolean) {\n if (this.#state === CLOSED) return;\n this.#state = CLOSED;\n this.#channel?.close();\n live.delete(this.#leave);\n this.dispatchEvent(closeEvent(code, reason, wasClean));\n }\n }\n\n return TabSocket as unknown as TabsWebSocket;\n}\n"],"mappings":";;AAyDA,MAAM,aAAa;AACnB,MAAM,OAAO;AACb,MAAM,UAAU;AAChB,MAAM,SAAS;AAYf,SAAS,WAAW,MAAc,QAAgB,UAA0B;CAC1E,MAAM,OAAO;EAAE;EAAM;EAAQ;CAAS;CAEtC,OAAO,OAAO,eAAe,aACzB,IAAI,WAAW,SAAS,IAAI,IAC5B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG,IAAI;AAC5C;AAEA,IAAI,MAAM;AAGV,MAAM,SAAS,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtB,SAAgB,oBAAoB,UAAgC,CAAC,GAAkB;CACrF,MAAM,SAAS,QAAQ,UAAU;CAEjC,MAAM,yBAAS,IAAI,IAA6D;CAEhF,MAAM,QAAQ,SAAkB;EAC9B,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,UAAU,OAAO;EACtD,IAAI;GACF,OAAO,KAAK,MAAM,IAAI;EACxB,QAAQ;GACN,OAAO;EACT;CACF;;CAGA,MAAM,WACJ,WACA,YACG;EACH,IAAI,CAAC,aAAa,YAAY,QAAQ,OAAO,KAAA;EAC7C,IAAI;GACF,OAAO,UAAU,OAAO,KAAK,KAAA;EAC/B,QAAQ;GACN;EACF;CACF;CAIA,MAAM,uBAAO,IAAI,IAAgB;CACjC,IAAI,SAAS;CACb,MAAM,mBAAmB;EACvB,KAAK,MAAM,SAAS,CAAC,GAAG,IAAI,GAAG,MAAM;CACvC;CAEA,SAAS,MAAM,KAAa,KAAa,WAA0C;EACjF,IAAI,OAAO,IAAI,GAAG,GAAG;EACrB,MAAM,UAAU,IAAI,iBAAiB,GAAG;EACxC,MAAM,QAAQ,WAAmB,QAAQ,YAAY,MAAM;EAC3D,IAAI;EAEJ,MAAM,0BAAU,IAAI,IAAqB;EAEzC,MAAM,0BAAU,IAAI,IAAyB;EAC7C,IAAI;EACJ,IAAI;EAEJ,SAAS,OAAO,IAAY;GAC1B,QAAQ,IAAI,IAAI,IAAI;GACpB,KAAK;IAAE,GAAG;IAAQ;IAAI,UAAU,KAAM;GAAS,CAAC;EAClD;EAEA,SAAS,UAAU;GACjB,IAAI,MAAM;GACV,MAAM,OAAO,QAAQ,aAAa,WAAW;GAC7C,IAAI;GACJ,IAAI;IACF,SAAS,OAAO,IAAI,KAAK,KAAK,SAAS;GACzC,QAAQ;IACN,QAAQ,MAAM;IACd,OAAO,KAAK;KAAE,GAAG;KAAS,MAAM;KAAM,QAAQ;KAAI,UAAU;IAAM,CAAC;GACrE;GACA,OAAO,aAAa;GACpB,OAAO,eAAe;IACpB,KAAK,MAAM,CAAC,IAAI,SAAS,SAAS,IAAI,CAAC,MAAM,OAAO,EAAE;GACxD;GACA,OAAO,aAAY,UAAS;IAC1B,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,OAAO,KAAK,MAAM,IAAI,CAAC;IAC7D,IAAI,UAAU,KAAA,GAAW,OAAO,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;IAAK,CAAC;IACvE,MAAM,KAAK,CAAC,GAAI,QAAQ,IAAI,KAAK,KAAK,CAAC,CAAE;IACzC,IAAI,GAAG,QAAQ,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;KAAM;IAAG,CAAC;GAC5D;GACA,OAAO,gBAAgB,CAAC;GACxB,OAAO,WAAU,UAAS;IACxB,IAAI,SAAS,QAAQ;IACrB,OAAO,KAAA;IACP,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,KAAK;KAAE,GAAG;KAAS,MAAM,MAAM;KAAM,QAAQ,MAAM;KAAQ,UAAU,MAAM;IAAS,CAAC;GACvF;EACF;EAEA,SAAS,KAAK,IAAY,MAAe;GACvC,MAAM,EAAE,WAAW;GACnB,IAAI,QAAQ;IACV,MAAM,UAAU,KAAK,IAAI;IACzB,MAAM,aAAa,QAAQ,OAAO,WAAW,OAAO;IACpD,IAAI,eAAe,KAAA,GAAW;KAC5B,IAAI,CAAC,QAAQ,IAAI,UAAU,GAAG,QAAQ,IAAI,4BAAY,IAAI,IAAI,CAAC;KAC/D,QAAQ,IAAI,UAAU,CAAC,CAAE,IAAI,EAAE;IACjC;IACA,MAAM,eAAe,QAAQ,OAAO,aAAa,OAAO;IACxD,IAAI,iBAAiB,KAAA,GAAW;KAC9B,MAAM,MAAM,QAAQ,IAAI,YAAY;KACpC,KAAK,OAAO,EAAE;KACd,IAAI,KAAK,MAAM;KACf,QAAQ,OAAO,YAAY;IAC7B;GACF;GACA,IAAI,MAAM,eAAe,MAAM,KAAK,KAAK,IAAwC;EACnF;EAEA,SAAS,OAAO,QAAgB;GAC9B,IAAI,OAAO,MAAM,WAAW;IAC1B,aAAa,WAAW;IACxB,QAAQ,IAAI,OAAO,IAAI,KAAK;IAC5B,QAAQ;IACR,IAAI,MAAM,eAAe,MAAM,OAAO,OAAO,EAAE;GACjD,OAAO,IAAI,OAAO,MAAM,QAClB;QAAA,QAAQ,IAAI,OAAO,EAAE,GAAG,KAAK,OAAO,IAAI,OAAO,IAAI;GAAA,OAClD,IAAI,OAAO,MAAM,cAAc;IACpC,QAAQ,OAAO,OAAO,EAAE;IACxB,KAAK,MAAM,OAAO,QAAQ,OAAO,GAAG,IAAI,OAAO,OAAO,EAAE;IACxD,IAAI,CAAC,QAAQ,MAAM;KACjB,aAAa,WAAW;KACxB,cAAc,iBAAiB;MAC7B,IAAI,QAAQ,QAAQ,CAAC,MAAM;MAE3B,MAAM,SAAS;MACf,OAAO,KAAA;MACP,OAAO,MAAM,GAAI;KACnB,GAAG,MAAM;IACX;GACF;EACF;EAEA,OAAO,IAAI,KAAK;GACd;GACA,OAAO;IACL,aAAa,WAAW;IACxB,QAAQ,MAAM;IACd,IAAI,MAAM;KACR,KAAK,UAAU;KACf,KAAK,MAAM,GAAI;IACjB;IACA,UAAU;GACZ;EACF,CAAC;EACD,UAAe,MAAM,QAAQ,WAAW;GACtC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG;GACtB,QAAQ,aAAY,UAAS,OAAO,MAAM,IAAc;GAExD,KAAK,EAAE,GAAG,SAAS,CAAC;GAEpB,OAAO,IAAI,SAAc,YAAY,UAAU,OAAQ;EACzD,CAAC;CACH;CAEA,MAAM,WAAW,QAAQ;CAEzB,MAAM,kBAAkB,YAAiC;EACvD,OAAgB,aAAa;EAC7B,OAAgB,OAAO;EACvB,OAAgB,UAAU;EAC1B,OAAgB,SAAS;EACzB,aAAsB;EACtB,OAAgB;EAChB,UAAmB;EACnB,SAAkB;EAElB;EACA,aAAsB;EACtB,SAA8B;EAC9B,YAAoC;EACpC,UAAgC;EAChC,UAAgC;EAChC,aAAyB;EACzB,WAAW;EAEX,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;EAC/E,SAAkC;EAClC;EAGA,eAAe;GACb,IAAI,KAAK,UAAU,SAAS;GAC5B,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,KAAK,KAAK,MAAM,IAAI,KAAK;EAC3B;EAEA;EAEA,OAAO,UAAU;GACf,KAAK,MAAM,EAAE,UAAU,OAAO,OAAO,GAAG,KAAK;GAC7C,OAAO,MAAM;EACf;EAEA,YAAY,KAAmB,WAA+B;GAC5D,MAAM;GACN,IAAI,OAAO,WAAW,aACpB,MAAM,IAAI,MAAM,0DAA0D;GAE5E,KAAK,MAAM,QAAQ;IAAC;IAAQ;IAAW;IAAS;GAAO,GACrD,KAAK,iBAAiB,OAAM,UACzB,KAAK,KAAK,OAAO,EAAsC,KAAK,MAAM,KAAK,CAC1E;GAEF,KAAK,MAAM,OAAO,GAAG;GACrB,IAAI,OAAO,qBAAqB,eAAe,CAAC,WAAW,WAAW,OAAO;IAC3E,MAAM,QAAS,KAAK,SAAS,KAAK,YAAY,WAAW,WAAW,KAAK,SAAS;IAElF,MAAM,aAAa;IACnB,MAAM,eAAe,KAAK,MAAM,MAAM,QAAQ;IAC9C,MAAM,aAAY,UAAS,KAAK,SAAS,MAAM,IAAI;IACnD,MAAM,gBAAgB,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;IAC3D,MAAM,WAAU,UAAS,KAAK,KAAK,MAAM,MAAM,MAAM,QAAQ,MAAM,QAAQ;IAC3E;GACF;GAKA,MAAM,MAAM,wBAHI,QAAQ,UACpB,WAAW,mBAAmB,QAAQ,QAAQ,KAAK,EAAE,EAAE,KACvD,KAC0C,KAAK,IAAI,QAAQ,KAAK,UAAU,aAAa,IAAI;GAC/F,MAAM,KAAK,KAAK,KAAK,SAAS;GAC9B,MAAM,UAAW,KAAK,WAAW,IAAI,iBAAiB,GAAG;GACzD,QAAQ,aAAY,UAAS,KAAK,QAAQ,MAAM,IAAc;GAC9D,KAAK,MAAM;IAAE,GAAG;IAAW,IAAI,KAAK;GAAI,CAAC;GACzC,KAAK,IAAI,KAAK,MAAM;GACpB,IAAI,CAAC,QAAQ;IACX,SAAS;IACT,iBAAiB,YAAY,UAAU;GACzC;EACF;EAEA,IAAI,aAAa;GACf,OAAO,KAAK;EACd;EAEA,IAAI,iBAAiB;GACnB,OAAO,KAAK,QAAQ,kBAAkB;EACxC;EAEA,KAAK,MAAwC;GAC3C,IAAI,KAAK,WAAW,YAClB,MAAM,IAAI,aAAa,0CAA0C,mBAAmB;GAEtF,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,KAAK,QAAQ,KAAK,OAAO,KAAK,IAAI;QACjC,KAAK,MAAM;IAAE,GAAG;IAAQ,IAAI,KAAK;IAAK;GAAK,CAAC;EACnD;EAEA,MAAM,OAAO,KAAM,SAAS,IAAI;GAC9B,IAAI,KAAK,UAAU,SAAS;GAE5B,IAAI,KAAK,QAAQ,KAAK,OAAO,MAAM,MAAM,MAAM;GAC/C,KAAK,SAAS;GACd,IAAI,KAAK,QAAQ;GAEjB,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,iBAAiB,KAAK,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC;EACnD;EAEA,MAAM,QAAgB;GACpB,KAAK,UAAU,YAAY,MAAM;EACnC;EAEA,QAAQ,QAAgB;GACtB,IAAI,OAAO,MAAM,QACX;QAAA,OAAO,OAAO,KAAK,OAAO,KAAK,WAAW,YAAY,KAAK,MAAM,OAAO,QAAQ;GAAA,OAC/E,IAAI,OAAO,MAAM,WAClB;QAAA,CAAC,OAAO,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,KAAK,SAAS,OAAO,IAAI;GAAA,OACpE,IAAI,OAAO,MAAM,SAAS;IAC/B,IAAI,KAAK,WAAW,YAAY,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,OAAO,QAAQ;SAChF;KAEH,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;KACrC,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,KAAK;IAC7C;GACF,OAAO,IAAI,OAAO,MAAM,UAAU;IAEhC,IAAI,KAAK,WAAW,YAAY,KAAK,MAAM;KAAE,GAAG;KAAW,IAAI,KAAK;IAAI,CAAC;SACpE,KAAK,KAAK,MAAM,IAAI,KAAK;GAChC;EACF;EAEA,MAAM,UAAkB;GACtB,KAAK,SAAS;GACd,KAAK,WAAW;GAChB,KAAK,cAAc,IAAI,MAAM,MAAM,CAAC;EACtC;EAEA,SAAS,MAAe;GACtB,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,gBAAgB,eAAe,KAAK,eAAe,QAAQ,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC;GACrF,KAAK,cAAc,IAAI,aAAa,WAAW,EAAE,KAAK,CAAC,CAAC;EAC1D;EAEA,KAAK,MAAc,QAAgB,UAAmB;GACpD,IAAI,KAAK,WAAW,QAAQ;GAC5B,KAAK,SAAS;GACd,KAAK,UAAU,MAAM;GACrB,KAAK,OAAO,KAAK,MAAM;GACvB,KAAK,cAAc,WAAW,MAAM,QAAQ,QAAQ,CAAC;EACvD;CACF;CAEA,OAAO;AACT"}
|
package/dist/tabs.d.cts
CHANGED
|
@@ -29,6 +29,13 @@ export interface TabsWebSocketOptions {
|
|
|
29
29
|
* @default 1000
|
|
30
30
|
*/
|
|
31
31
|
linger?: number;
|
|
32
|
+
/**
|
|
33
|
+
* Who is signed in, such as the user's id. Tabs share a connection only with tabs that return
|
|
34
|
+
* the same value, so when another user signs in, `close()` and then `connect()` open a
|
|
35
|
+
* connection of their own instead of joining the one the previous user authenticated. Read
|
|
36
|
+
* for every new socket.
|
|
37
|
+
*/
|
|
38
|
+
session?: () => string | null | undefined;
|
|
32
39
|
}
|
|
33
40
|
/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */
|
|
34
41
|
export interface TabsWebSocket {
|
package/dist/tabs.d.ts
CHANGED
|
@@ -29,6 +29,13 @@ export interface TabsWebSocketOptions {
|
|
|
29
29
|
* @default 1000
|
|
30
30
|
*/
|
|
31
31
|
linger?: number;
|
|
32
|
+
/**
|
|
33
|
+
* Who is signed in, such as the user's id. Tabs share a connection only with tabs that return
|
|
34
|
+
* the same value, so when another user signs in, `close()` and then `connect()` open a
|
|
35
|
+
* connection of their own instead of joining the one the previous user authenticated. Read
|
|
36
|
+
* for every new socket.
|
|
37
|
+
*/
|
|
38
|
+
session?: () => string | null | undefined;
|
|
32
39
|
}
|
|
33
40
|
/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */
|
|
34
41
|
export interface TabsWebSocket {
|
package/dist/tabs.js
CHANGED
|
@@ -246,7 +246,7 @@ function createTabsWebSocket(options = {}) {
|
|
|
246
246
|
inner.onclose = (event) => this.#end(event.code, event.reason, event.wasClean);
|
|
247
247
|
return;
|
|
248
248
|
}
|
|
249
|
-
const key = `react-websocket-tabs:${this.url}\u0000${JSON.stringify(protocols ?? null)}`;
|
|
249
|
+
const key = `react-websocket-tabs:${options.session ? `session=${encodeURIComponent(options.session() ?? "")}:` : ""}${this.url}\u0000${JSON.stringify(protocols ?? null)}`;
|
|
250
250
|
agent(key, this.url, protocols);
|
|
251
251
|
const channel = this.#channel = new BroadcastChannel(key);
|
|
252
252
|
channel.onmessage = (event) => this.#signal(event.data);
|
package/dist/tabs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tabs.js","names":[],"sources":["../src/tabs.ts"],"sourcesContent":["// An entry with no imports: it only implements the `WebSocket` interface.\n\n/**\n * Recognize topic subscriptions, so tabs sharing a socket don't unsubscribe each other. With\n * `json`, only messages that parse are passed to these, and one that throws counts as\n * `undefined`, so heartbeat pings and other plain strings go through.\n */\nexport interface TabsTopics {\n /** The topic an outgoing message subscribes to, or `undefined`. */\n subscribe: (message: any) => string | null | undefined;\n /** The topic an outgoing message unsubscribes from, or `undefined`. */\n unsubscribe: (message: any) => string | null | undefined;\n /**\n * The topic of an incoming message, to deliver it only to the tabs that hold that topic.\n * Without it, every tab gets every message.\n */\n topic?: (message: any) => string | null | undefined;\n}\n\n/** Options for {@link createTabsWebSocket}. */\nexport interface TabsWebSocketOptions {\n /** The `WebSocket` the leading tab opens. Defaults to the global one. */\n WebSocket?: typeof WebSocket;\n /** Messages are JSON: the `topics` functions get them parsed. */\n json?: boolean;\n /** Share topic subscriptions between tabs. See {@link TabsTopics}. */\n topics?: TabsTopics;\n /**\n * How long the leading tab keeps the shared socket open after the last tab using it lets go,\n * in ms, so a reload doesn't close and reopen it.\n * @default 1000\n */\n linger?: number;\n}\n\n/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */\nexport interface TabsWebSocket {\n new (url: string | URL, protocols?: string | string[]): WebSocket;\n readonly prototype: WebSocket;\n readonly CONNECTING: 0;\n readonly OPEN: 1;\n readonly CLOSING: 2;\n readonly CLOSED: 3;\n /**\n * Stop leading and listening in this tab: close the shared sockets it holds and let another\n * tab take over. For tests and hot module reloading; a closed tab does this by itself.\n */\n dispose(): void;\n}\n\nconst CONNECTING = 0;\nconst OPEN = 1;\nconst CLOSING = 2;\nconst CLOSED = 3;\n\n/** What tabs say to each other over the channel. */\ntype Signal =\n | { t: 'connect'; id: string }\n | { t: 'send'; id: string; data: unknown }\n | { t: 'disconnect'; id: string }\n | { t: 'open'; id: string; protocol: string }\n | { t: 'message'; data: unknown; to?: string[] }\n | { t: 'close'; code: number; reason: string; wasClean: boolean }\n | { t: 'leader' };\n\nfunction closeEvent(code: number, reason: string, wasClean: boolean): Event {\n const init = { code, reason, wasClean };\n // Node 22 has no CloseEvent.\n return typeof CloseEvent === 'function'\n ? new CloseEvent('close', init)\n : Object.assign(new Event('close'), init);\n}\n\nlet ids = 0;\n\n// What `read()` returns for a message that isn't JSON.\nconst UNREAD = Symbol();\n\n/**\n * Share one WebSocket between all the tabs of an app. Pass the returned class as the\n * `WebSocket` option: every tab keeps its own client, with its own reconnects, queue, topics and\n * hooks, but only one tab, the leader, opens a connection to the server. The others reach it\n * through a `BroadcastChannel`. Users with ten tabs open cost the server one connection, not ten.\n *\n * - The leader is elected with the Web Locks API. When its tab closes, another tab takes over,\n * and every tab's client reconnects through it.\n * - Each tab's sends go out on the shared socket. Every message from the server reaches every\n * tab, or, with `topics`, only the tabs that hold its topic.\n * - With `topics`, an unsubscribe goes to the server only when no other tab still holds the topic.\n *\n * Where `BroadcastChannel` or the Web Locks API is missing, each tab opens its own socket, as\n * without this.\n *\n * @example\n * ```ts\n * import { createTabsWebSocket } from 'react-websocket/tabs';\n *\n * export const live = createWebSocket(url, {\n * json: true,\n * WebSocket: createTabsWebSocket({\n * json: true,\n * topics: {\n * subscribe: message => (message.type === 'subscribe' ? message.topic : undefined),\n * unsubscribe: message => (message.type === 'unsubscribe' ? message.topic : undefined),\n * topic: message => message.topic\n * }\n * })\n * });\n * ```\n */\nexport function createTabsWebSocket(options: TabsWebSocketOptions = {}): TabsWebSocket {\n const linger = options.linger ?? 1000;\n // One per URL in this tab: it waits to lead, and leads while it holds the lock.\n const agents = new Map<string, { channel: BroadcastChannel; stop: () => void }>();\n\n const read = (data: unknown) => {\n if (!options.json || typeof data !== 'string') return data;\n try {\n return JSON.parse(data);\n } catch {\n return UNREAD;\n }\n };\n\n /** A topic `recognize` finds in `data`, if it parses and `recognize` doesn't throw. */\n const topicOf = (\n recognize: ((message: any) => string | null | undefined) | undefined,\n message: unknown\n ) => {\n if (!recognize || message === UNREAD) return undefined;\n try {\n return recognize(message) ?? undefined;\n } catch {\n return undefined;\n }\n };\n\n // The sockets this tab has on shared ones. A tab that goes away tells the leading tab,\n // which would otherwise keep their topics and the shared socket for them.\n const live = new Set<() => void>();\n let hiding = false;\n const onPageHide = () => {\n for (const leave of [...live]) leave();\n };\n\n function agent(key: string, url: string, protocols: string | string[] | undefined) {\n if (agents.has(key)) return;\n const channel = new BroadcastChannel(key);\n const post = (signal: Signal) => channel.postMessage(signal);\n let real: WebSocket | undefined;\n // The tabs' sockets on the shared one, and whether each has been told it's open.\n const clients = new Map<string, boolean>();\n // Who holds each topic, so an unsubscribe waits for the last one.\n const holders = new Map<string, Set<string>>();\n let lingerTimer: ReturnType<typeof setTimeout> | undefined;\n let release: (() => void) | undefined;\n\n function opened(id: string) {\n clients.set(id, true);\n post({ t: 'open', id, protocol: real!.protocol });\n }\n\n function connect() {\n if (real) return;\n const Impl = options.WebSocket ?? globalThis.WebSocket;\n let socket: WebSocket;\n try {\n socket = real = new Impl(url, protocols);\n } catch {\n clients.clear();\n return post({ t: 'close', code: 1006, reason: '', wasClean: false });\n }\n socket.binaryType = 'arraybuffer';\n socket.onopen = () => {\n for (const [id, told] of clients) if (!told) opened(id);\n };\n socket.onmessage = event => {\n const topic = topicOf(options.topics?.topic, read(event.data));\n if (topic === undefined) return post({ t: 'message', data: event.data });\n const to = [...(holders.get(topic) ?? [])];\n if (to.length) post({ t: 'message', data: event.data, to });\n };\n socket.onerror = () => {};\n socket.onclose = event => {\n if (real !== socket) return;\n real = undefined;\n clients.clear();\n holders.clear();\n post({ t: 'close', code: event.code, reason: event.reason, wasClean: event.wasClean });\n };\n }\n\n function send(id: string, data: unknown) {\n const { topics } = options;\n if (topics) {\n const message = read(data);\n const subscribed = topicOf(topics.subscribe, message);\n if (subscribed !== undefined) {\n if (!holders.has(subscribed)) holders.set(subscribed, new Set());\n holders.get(subscribed)!.add(id);\n }\n const unsubscribed = topicOf(topics.unsubscribe, message);\n if (unsubscribed !== undefined) {\n const set = holders.get(unsubscribed);\n set?.delete(id);\n if (set?.size) return; // another tab still holds it\n holders.delete(unsubscribed);\n }\n }\n if (real?.readyState === OPEN) real.send(data as Parameters<WebSocket['send']>[0]);\n }\n\n function handle(signal: Signal) {\n if (signal.t === 'connect') {\n clearTimeout(lingerTimer);\n clients.set(signal.id, false);\n connect();\n if (real?.readyState === OPEN) opened(signal.id);\n } else if (signal.t === 'send') {\n if (clients.get(signal.id)) send(signal.id, signal.data);\n } else if (signal.t === 'disconnect') {\n clients.delete(signal.id);\n for (const set of holders.values()) set.delete(signal.id);\n if (!clients.size) {\n clearTimeout(lingerTimer);\n lingerTimer = setTimeout(() => {\n if (clients.size || !real) return;\n // Forget it first: a tab connecting while it closes gets a new one.\n const socket = real;\n real = undefined;\n socket.close(1000);\n }, linger);\n }\n }\n }\n\n agents.set(key, {\n channel,\n stop() {\n clearTimeout(lingerTimer);\n channel.close();\n if (real) {\n real.onclose = null;\n real.close(1000);\n }\n release?.();\n }\n });\n void navigator.locks.request(key, () => {\n if (!agents.has(key)) return;\n channel.onmessage = event => handle(event.data as Signal);\n // Sockets that were using the tab that led before start over with this one.\n post({ t: 'leader' });\n // Lead until this tab goes away, or `dispose()`.\n return new Promise<void>(resolve => (release = resolve));\n });\n }\n\n const Fallback = options.WebSocket;\n\n class TabSocket extends EventTarget implements WebSocket {\n static readonly CONNECTING = CONNECTING;\n static readonly OPEN = OPEN;\n static readonly CLOSING = CLOSING;\n static readonly CLOSED = CLOSED;\n readonly CONNECTING = CONNECTING;\n readonly OPEN = OPEN;\n readonly CLOSING = CLOSING;\n readonly CLOSED = CLOSED;\n\n readonly url: string;\n readonly extensions = '';\n onopen: WebSocket['onopen'] = null;\n onmessage: WebSocket['onmessage'] = null;\n onerror: WebSocket['onerror'] = null;\n onclose: WebSocket['onclose'] = null;\n binaryType: BinaryType = 'blob';\n protocol = '';\n\n #id = `${Date.now().toString(36)}-${++ids}-${Math.random().toString(36).slice(2)}`;\n #state: WebSocket['readyState'] = CONNECTING;\n #channel: BroadcastChannel | undefined;\n // The page is going away, or into the back/forward cache: let go of the shared socket, and\n // close, so a page that comes back connects again.\n #leave = () => {\n if (this.#state >= CLOSING) return; // `close()` told the leader already\n this.#post({ t: 'disconnect', id: this.#id });\n this.#end(1001, '', false);\n };\n // Without `BroadcastChannel` or locks: a socket of this tab's own.\n #inner: WebSocket | undefined;\n\n static dispose() {\n for (const { stop } of agents.values()) stop();\n agents.clear();\n }\n\n constructor(url: string | URL, protocols?: string | string[]) {\n super();\n if (typeof window === 'undefined') {\n throw new Error('react-websocket/tabs: no WebSocket here (server render?)');\n }\n for (const type of ['open', 'message', 'error', 'close'] as const) {\n this.addEventListener(type, event =>\n (this[`on${type}`] as ((event: Event) => void) | null)?.call(this, event)\n );\n }\n this.url = String(url);\n if (typeof BroadcastChannel === 'undefined' || !globalThis.navigator?.locks) {\n const inner = (this.#inner = new (Fallback ?? globalThis.WebSocket)(url, protocols));\n // As from the leading tab: `#message` turns it into what `binaryType` asks for.\n inner.binaryType = 'arraybuffer';\n inner.onopen = () => this.#open(inner.protocol);\n inner.onmessage = event => this.#message(event.data);\n inner.onerror = () => this.dispatchEvent(new Event('error'));\n inner.onclose = event => this.#end(event.code, event.reason, event.wasClean);\n return;\n }\n const key = `react-websocket-tabs:${this.url}\\u0000${JSON.stringify(protocols ?? null)}`;\n agent(key, this.url, protocols);\n const channel = (this.#channel = new BroadcastChannel(key));\n channel.onmessage = event => this.#signal(event.data as Signal);\n this.#post({ t: 'connect', id: this.#id });\n live.add(this.#leave);\n if (!hiding) {\n hiding = true;\n addEventListener('pagehide', onPageHide);\n }\n }\n\n get readyState() {\n return this.#state;\n }\n\n get bufferedAmount() {\n return this.#inner?.bufferedAmount ?? 0;\n }\n\n send(data: Parameters<WebSocket['send']>[0]) {\n if (this.#state === CONNECTING) {\n throw new DOMException('WebSocket is still in CONNECTING state', 'InvalidStateError');\n }\n if (this.#state !== OPEN) return;\n if (this.#inner) this.#inner.send(data);\n else this.#post({ t: 'send', id: this.#id, data });\n }\n\n close(code = 1000, reason = '') {\n if (this.#state >= CLOSING) return;\n // First, so that a code the socket rejects throws before anything has changed.\n if (this.#inner) this.#inner.close(code, reason);\n this.#state = CLOSING;\n if (this.#inner) return;\n // Only this tab's socket closes; the shared one stays for the others.\n this.#post({ t: 'disconnect', id: this.#id });\n setTimeout(() => this.#end(code, reason, true), 0);\n }\n\n #post(signal: Signal) {\n this.#channel?.postMessage(signal);\n }\n\n #signal(signal: Signal) {\n if (signal.t === 'open') {\n if (signal.id === this.#id && this.#state === CONNECTING) this.#open(signal.protocol);\n } else if (signal.t === 'message') {\n if (!signal.to || signal.to.includes(this.#id)) this.#message(signal.data);\n } else if (signal.t === 'close') {\n if (this.#state !== CONNECTING) this.#end(signal.code, signal.reason, signal.wasClean);\n else {\n // The shared socket failed before this one opened.\n this.dispatchEvent(new Event('error'));\n this.#end(signal.code, signal.reason, false);\n }\n } else if (signal.t === 'leader') {\n // A new leading tab: start over with it, or ask it to connect us.\n if (this.#state === CONNECTING) this.#post({ t: 'connect', id: this.#id });\n else this.#end(1006, '', false);\n }\n }\n\n #open(protocol: string) {\n this.#state = OPEN;\n this.protocol = protocol;\n this.dispatchEvent(new Event('open'));\n }\n\n #message(data: unknown) {\n if (this.#state !== OPEN) return;\n if (data instanceof ArrayBuffer && this.binaryType === 'blob') data = new Blob([data]);\n this.dispatchEvent(new MessageEvent('message', { data }));\n }\n\n #end(code: number, reason: string, wasClean: boolean) {\n if (this.#state === CLOSED) return;\n this.#state = CLOSED;\n this.#channel?.close();\n live.delete(this.#leave);\n this.dispatchEvent(closeEvent(code, reason, wasClean));\n }\n }\n\n return TabSocket as unknown as TabsWebSocket;\n}\n"],"mappings":";AAkDA,MAAM,aAAa;AACnB,MAAM,OAAO;AACb,MAAM,UAAU;AAChB,MAAM,SAAS;AAYf,SAAS,WAAW,MAAc,QAAgB,UAA0B;CAC1E,MAAM,OAAO;EAAE;EAAM;EAAQ;CAAS;CAEtC,OAAO,OAAO,eAAe,aACzB,IAAI,WAAW,SAAS,IAAI,IAC5B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG,IAAI;AAC5C;AAEA,IAAI,MAAM;AAGV,MAAM,SAAS,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtB,SAAgB,oBAAoB,UAAgC,CAAC,GAAkB;CACrF,MAAM,SAAS,QAAQ,UAAU;CAEjC,MAAM,yBAAS,IAAI,IAA6D;CAEhF,MAAM,QAAQ,SAAkB;EAC9B,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,UAAU,OAAO;EACtD,IAAI;GACF,OAAO,KAAK,MAAM,IAAI;EACxB,QAAQ;GACN,OAAO;EACT;CACF;;CAGA,MAAM,WACJ,WACA,YACG;EACH,IAAI,CAAC,aAAa,YAAY,QAAQ,OAAO,KAAA;EAC7C,IAAI;GACF,OAAO,UAAU,OAAO,KAAK,KAAA;EAC/B,QAAQ;GACN;EACF;CACF;CAIA,MAAM,uBAAO,IAAI,IAAgB;CACjC,IAAI,SAAS;CACb,MAAM,mBAAmB;EACvB,KAAK,MAAM,SAAS,CAAC,GAAG,IAAI,GAAG,MAAM;CACvC;CAEA,SAAS,MAAM,KAAa,KAAa,WAA0C;EACjF,IAAI,OAAO,IAAI,GAAG,GAAG;EACrB,MAAM,UAAU,IAAI,iBAAiB,GAAG;EACxC,MAAM,QAAQ,WAAmB,QAAQ,YAAY,MAAM;EAC3D,IAAI;EAEJ,MAAM,0BAAU,IAAI,IAAqB;EAEzC,MAAM,0BAAU,IAAI,IAAyB;EAC7C,IAAI;EACJ,IAAI;EAEJ,SAAS,OAAO,IAAY;GAC1B,QAAQ,IAAI,IAAI,IAAI;GACpB,KAAK;IAAE,GAAG;IAAQ;IAAI,UAAU,KAAM;GAAS,CAAC;EAClD;EAEA,SAAS,UAAU;GACjB,IAAI,MAAM;GACV,MAAM,OAAO,QAAQ,aAAa,WAAW;GAC7C,IAAI;GACJ,IAAI;IACF,SAAS,OAAO,IAAI,KAAK,KAAK,SAAS;GACzC,QAAQ;IACN,QAAQ,MAAM;IACd,OAAO,KAAK;KAAE,GAAG;KAAS,MAAM;KAAM,QAAQ;KAAI,UAAU;IAAM,CAAC;GACrE;GACA,OAAO,aAAa;GACpB,OAAO,eAAe;IACpB,KAAK,MAAM,CAAC,IAAI,SAAS,SAAS,IAAI,CAAC,MAAM,OAAO,EAAE;GACxD;GACA,OAAO,aAAY,UAAS;IAC1B,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,OAAO,KAAK,MAAM,IAAI,CAAC;IAC7D,IAAI,UAAU,KAAA,GAAW,OAAO,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;IAAK,CAAC;IACvE,MAAM,KAAK,CAAC,GAAI,QAAQ,IAAI,KAAK,KAAK,CAAC,CAAE;IACzC,IAAI,GAAG,QAAQ,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;KAAM;IAAG,CAAC;GAC5D;GACA,OAAO,gBAAgB,CAAC;GACxB,OAAO,WAAU,UAAS;IACxB,IAAI,SAAS,QAAQ;IACrB,OAAO,KAAA;IACP,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,KAAK;KAAE,GAAG;KAAS,MAAM,MAAM;KAAM,QAAQ,MAAM;KAAQ,UAAU,MAAM;IAAS,CAAC;GACvF;EACF;EAEA,SAAS,KAAK,IAAY,MAAe;GACvC,MAAM,EAAE,WAAW;GACnB,IAAI,QAAQ;IACV,MAAM,UAAU,KAAK,IAAI;IACzB,MAAM,aAAa,QAAQ,OAAO,WAAW,OAAO;IACpD,IAAI,eAAe,KAAA,GAAW;KAC5B,IAAI,CAAC,QAAQ,IAAI,UAAU,GAAG,QAAQ,IAAI,4BAAY,IAAI,IAAI,CAAC;KAC/D,QAAQ,IAAI,UAAU,CAAC,CAAE,IAAI,EAAE;IACjC;IACA,MAAM,eAAe,QAAQ,OAAO,aAAa,OAAO;IACxD,IAAI,iBAAiB,KAAA,GAAW;KAC9B,MAAM,MAAM,QAAQ,IAAI,YAAY;KACpC,KAAK,OAAO,EAAE;KACd,IAAI,KAAK,MAAM;KACf,QAAQ,OAAO,YAAY;IAC7B;GACF;GACA,IAAI,MAAM,eAAe,MAAM,KAAK,KAAK,IAAwC;EACnF;EAEA,SAAS,OAAO,QAAgB;GAC9B,IAAI,OAAO,MAAM,WAAW;IAC1B,aAAa,WAAW;IACxB,QAAQ,IAAI,OAAO,IAAI,KAAK;IAC5B,QAAQ;IACR,IAAI,MAAM,eAAe,MAAM,OAAO,OAAO,EAAE;GACjD,OAAO,IAAI,OAAO,MAAM,QAClB;QAAA,QAAQ,IAAI,OAAO,EAAE,GAAG,KAAK,OAAO,IAAI,OAAO,IAAI;GAAA,OAClD,IAAI,OAAO,MAAM,cAAc;IACpC,QAAQ,OAAO,OAAO,EAAE;IACxB,KAAK,MAAM,OAAO,QAAQ,OAAO,GAAG,IAAI,OAAO,OAAO,EAAE;IACxD,IAAI,CAAC,QAAQ,MAAM;KACjB,aAAa,WAAW;KACxB,cAAc,iBAAiB;MAC7B,IAAI,QAAQ,QAAQ,CAAC,MAAM;MAE3B,MAAM,SAAS;MACf,OAAO,KAAA;MACP,OAAO,MAAM,GAAI;KACnB,GAAG,MAAM;IACX;GACF;EACF;EAEA,OAAO,IAAI,KAAK;GACd;GACA,OAAO;IACL,aAAa,WAAW;IACxB,QAAQ,MAAM;IACd,IAAI,MAAM;KACR,KAAK,UAAU;KACf,KAAK,MAAM,GAAI;IACjB;IACA,UAAU;GACZ;EACF,CAAC;EACD,UAAe,MAAM,QAAQ,WAAW;GACtC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG;GACtB,QAAQ,aAAY,UAAS,OAAO,MAAM,IAAc;GAExD,KAAK,EAAE,GAAG,SAAS,CAAC;GAEpB,OAAO,IAAI,SAAc,YAAY,UAAU,OAAQ;EACzD,CAAC;CACH;CAEA,MAAM,WAAW,QAAQ;CAEzB,MAAM,kBAAkB,YAAiC;EACvD,OAAgB,aAAa;EAC7B,OAAgB,OAAO;EACvB,OAAgB,UAAU;EAC1B,OAAgB,SAAS;EACzB,aAAsB;EACtB,OAAgB;EAChB,UAAmB;EACnB,SAAkB;EAElB;EACA,aAAsB;EACtB,SAA8B;EAC9B,YAAoC;EACpC,UAAgC;EAChC,UAAgC;EAChC,aAAyB;EACzB,WAAW;EAEX,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;EAC/E,SAAkC;EAClC;EAGA,eAAe;GACb,IAAI,KAAK,UAAU,SAAS;GAC5B,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,KAAK,KAAK,MAAM,IAAI,KAAK;EAC3B;EAEA;EAEA,OAAO,UAAU;GACf,KAAK,MAAM,EAAE,UAAU,OAAO,OAAO,GAAG,KAAK;GAC7C,OAAO,MAAM;EACf;EAEA,YAAY,KAAmB,WAA+B;GAC5D,MAAM;GACN,IAAI,OAAO,WAAW,aACpB,MAAM,IAAI,MAAM,0DAA0D;GAE5E,KAAK,MAAM,QAAQ;IAAC;IAAQ;IAAW;IAAS;GAAO,GACrD,KAAK,iBAAiB,OAAM,UACzB,KAAK,KAAK,OAAO,EAAsC,KAAK,MAAM,KAAK,CAC1E;GAEF,KAAK,MAAM,OAAO,GAAG;GACrB,IAAI,OAAO,qBAAqB,eAAe,CAAC,WAAW,WAAW,OAAO;IAC3E,MAAM,QAAS,KAAK,SAAS,KAAK,YAAY,WAAW,WAAW,KAAK,SAAS;IAElF,MAAM,aAAa;IACnB,MAAM,eAAe,KAAK,MAAM,MAAM,QAAQ;IAC9C,MAAM,aAAY,UAAS,KAAK,SAAS,MAAM,IAAI;IACnD,MAAM,gBAAgB,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;IAC3D,MAAM,WAAU,UAAS,KAAK,KAAK,MAAM,MAAM,MAAM,QAAQ,MAAM,QAAQ;IAC3E;GACF;GACA,MAAM,MAAM,wBAAwB,KAAK,IAAI,QAAQ,KAAK,UAAU,aAAa,IAAI;GACrF,MAAM,KAAK,KAAK,KAAK,SAAS;GAC9B,MAAM,UAAW,KAAK,WAAW,IAAI,iBAAiB,GAAG;GACzD,QAAQ,aAAY,UAAS,KAAK,QAAQ,MAAM,IAAc;GAC9D,KAAK,MAAM;IAAE,GAAG;IAAW,IAAI,KAAK;GAAI,CAAC;GACzC,KAAK,IAAI,KAAK,MAAM;GACpB,IAAI,CAAC,QAAQ;IACX,SAAS;IACT,iBAAiB,YAAY,UAAU;GACzC;EACF;EAEA,IAAI,aAAa;GACf,OAAO,KAAK;EACd;EAEA,IAAI,iBAAiB;GACnB,OAAO,KAAK,QAAQ,kBAAkB;EACxC;EAEA,KAAK,MAAwC;GAC3C,IAAI,KAAK,WAAW,YAClB,MAAM,IAAI,aAAa,0CAA0C,mBAAmB;GAEtF,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,KAAK,QAAQ,KAAK,OAAO,KAAK,IAAI;QACjC,KAAK,MAAM;IAAE,GAAG;IAAQ,IAAI,KAAK;IAAK;GAAK,CAAC;EACnD;EAEA,MAAM,OAAO,KAAM,SAAS,IAAI;GAC9B,IAAI,KAAK,UAAU,SAAS;GAE5B,IAAI,KAAK,QAAQ,KAAK,OAAO,MAAM,MAAM,MAAM;GAC/C,KAAK,SAAS;GACd,IAAI,KAAK,QAAQ;GAEjB,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,iBAAiB,KAAK,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC;EACnD;EAEA,MAAM,QAAgB;GACpB,KAAK,UAAU,YAAY,MAAM;EACnC;EAEA,QAAQ,QAAgB;GACtB,IAAI,OAAO,MAAM,QACX;QAAA,OAAO,OAAO,KAAK,OAAO,KAAK,WAAW,YAAY,KAAK,MAAM,OAAO,QAAQ;GAAA,OAC/E,IAAI,OAAO,MAAM,WAClB;QAAA,CAAC,OAAO,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,KAAK,SAAS,OAAO,IAAI;GAAA,OACpE,IAAI,OAAO,MAAM,SAAS;IAC/B,IAAI,KAAK,WAAW,YAAY,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,OAAO,QAAQ;SAChF;KAEH,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;KACrC,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,KAAK;IAC7C;GACF,OAAO,IAAI,OAAO,MAAM,UAAU;IAEhC,IAAI,KAAK,WAAW,YAAY,KAAK,MAAM;KAAE,GAAG;KAAW,IAAI,KAAK;IAAI,CAAC;SACpE,KAAK,KAAK,MAAM,IAAI,KAAK;GAChC;EACF;EAEA,MAAM,UAAkB;GACtB,KAAK,SAAS;GACd,KAAK,WAAW;GAChB,KAAK,cAAc,IAAI,MAAM,MAAM,CAAC;EACtC;EAEA,SAAS,MAAe;GACtB,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,gBAAgB,eAAe,KAAK,eAAe,QAAQ,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC;GACrF,KAAK,cAAc,IAAI,aAAa,WAAW,EAAE,KAAK,CAAC,CAAC;EAC1D;EAEA,KAAK,MAAc,QAAgB,UAAmB;GACpD,IAAI,KAAK,WAAW,QAAQ;GAC5B,KAAK,SAAS;GACd,KAAK,UAAU,MAAM;GACrB,KAAK,OAAO,KAAK,MAAM;GACvB,KAAK,cAAc,WAAW,MAAM,QAAQ,QAAQ,CAAC;EACvD;CACF;CAEA,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"tabs.js","names":[],"sources":["../src/tabs.ts"],"sourcesContent":["// An entry with no imports: it only implements the `WebSocket` interface.\n\n/**\n * Recognize topic subscriptions, so tabs sharing a socket don't unsubscribe each other. With\n * `json`, only messages that parse are passed to these, and one that throws counts as\n * `undefined`, so heartbeat pings and other plain strings go through.\n */\nexport interface TabsTopics {\n /** The topic an outgoing message subscribes to, or `undefined`. */\n subscribe: (message: any) => string | null | undefined;\n /** The topic an outgoing message unsubscribes from, or `undefined`. */\n unsubscribe: (message: any) => string | null | undefined;\n /**\n * The topic of an incoming message, to deliver it only to the tabs that hold that topic.\n * Without it, every tab gets every message.\n */\n topic?: (message: any) => string | null | undefined;\n}\n\n/** Options for {@link createTabsWebSocket}. */\nexport interface TabsWebSocketOptions {\n /** The `WebSocket` the leading tab opens. Defaults to the global one. */\n WebSocket?: typeof WebSocket;\n /** Messages are JSON: the `topics` functions get them parsed. */\n json?: boolean;\n /** Share topic subscriptions between tabs. See {@link TabsTopics}. */\n topics?: TabsTopics;\n /**\n * How long the leading tab keeps the shared socket open after the last tab using it lets go,\n * in ms, so a reload doesn't close and reopen it.\n * @default 1000\n */\n linger?: number;\n /**\n * Who is signed in, such as the user's id. Tabs share a connection only with tabs that return\n * the same value, so when another user signs in, `close()` and then `connect()` open a\n * connection of their own instead of joining the one the previous user authenticated. Read\n * for every new socket.\n */\n session?: () => string | null | undefined;\n}\n\n/** The class from {@link createTabsWebSocket}: a `WebSocket`, plus a way to stop sharing. */\nexport interface TabsWebSocket {\n new (url: string | URL, protocols?: string | string[]): WebSocket;\n readonly prototype: WebSocket;\n readonly CONNECTING: 0;\n readonly OPEN: 1;\n readonly CLOSING: 2;\n readonly CLOSED: 3;\n /**\n * Stop leading and listening in this tab: close the shared sockets it holds and let another\n * tab take over. For tests and hot module reloading; a closed tab does this by itself.\n */\n dispose(): void;\n}\n\nconst CONNECTING = 0;\nconst OPEN = 1;\nconst CLOSING = 2;\nconst CLOSED = 3;\n\n/** What tabs say to each other over the channel. */\ntype Signal =\n | { t: 'connect'; id: string }\n | { t: 'send'; id: string; data: unknown }\n | { t: 'disconnect'; id: string }\n | { t: 'open'; id: string; protocol: string }\n | { t: 'message'; data: unknown; to?: string[] }\n | { t: 'close'; code: number; reason: string; wasClean: boolean }\n | { t: 'leader' };\n\nfunction closeEvent(code: number, reason: string, wasClean: boolean): Event {\n const init = { code, reason, wasClean };\n // Node 22 has no CloseEvent.\n return typeof CloseEvent === 'function'\n ? new CloseEvent('close', init)\n : Object.assign(new Event('close'), init);\n}\n\nlet ids = 0;\n\n// What `read()` returns for a message that isn't JSON.\nconst UNREAD = Symbol();\n\n/**\n * Share one WebSocket between all the tabs of an app. Pass the returned class as the\n * `WebSocket` option: every tab keeps its own client, with its own reconnects, queue, topics and\n * hooks, but only one tab, the leader, opens a connection to the server. The others reach it\n * through a `BroadcastChannel`. Users with ten tabs open cost the server one connection, not ten.\n *\n * - The leader is elected with the Web Locks API. When its tab closes, another tab takes over,\n * and every tab's client reconnects through it.\n * - Each tab's sends go out on the shared socket. Every message from the server reaches every\n * tab, or, with `topics`, only the tabs that hold its topic.\n * - With `topics`, an unsubscribe goes to the server only when no other tab still holds the topic.\n *\n * Where `BroadcastChannel` or the Web Locks API is missing, each tab opens its own socket, as\n * without this.\n *\n * @example\n * ```ts\n * import { createTabsWebSocket } from 'react-websocket/tabs';\n *\n * export const live = createWebSocket(url, {\n * json: true,\n * WebSocket: createTabsWebSocket({\n * json: true,\n * topics: {\n * subscribe: message => (message.type === 'subscribe' ? message.topic : undefined),\n * unsubscribe: message => (message.type === 'unsubscribe' ? message.topic : undefined),\n * topic: message => message.topic\n * }\n * })\n * });\n * ```\n */\nexport function createTabsWebSocket(options: TabsWebSocketOptions = {}): TabsWebSocket {\n const linger = options.linger ?? 1000;\n // One per URL in this tab: it waits to lead, and leads while it holds the lock.\n const agents = new Map<string, { channel: BroadcastChannel; stop: () => void }>();\n\n const read = (data: unknown) => {\n if (!options.json || typeof data !== 'string') return data;\n try {\n return JSON.parse(data);\n } catch {\n return UNREAD;\n }\n };\n\n /** A topic `recognize` finds in `data`, if it parses and `recognize` doesn't throw. */\n const topicOf = (\n recognize: ((message: any) => string | null | undefined) | undefined,\n message: unknown\n ) => {\n if (!recognize || message === UNREAD) return undefined;\n try {\n return recognize(message) ?? undefined;\n } catch {\n return undefined;\n }\n };\n\n // The sockets this tab has on shared ones. A tab that goes away tells the leading tab,\n // which would otherwise keep their topics and the shared socket for them.\n const live = new Set<() => void>();\n let hiding = false;\n const onPageHide = () => {\n for (const leave of [...live]) leave();\n };\n\n function agent(key: string, url: string, protocols: string | string[] | undefined) {\n if (agents.has(key)) return;\n const channel = new BroadcastChannel(key);\n const post = (signal: Signal) => channel.postMessage(signal);\n let real: WebSocket | undefined;\n // The tabs' sockets on the shared one, and whether each has been told it's open.\n const clients = new Map<string, boolean>();\n // Who holds each topic, so an unsubscribe waits for the last one.\n const holders = new Map<string, Set<string>>();\n let lingerTimer: ReturnType<typeof setTimeout> | undefined;\n let release: (() => void) | undefined;\n\n function opened(id: string) {\n clients.set(id, true);\n post({ t: 'open', id, protocol: real!.protocol });\n }\n\n function connect() {\n if (real) return;\n const Impl = options.WebSocket ?? globalThis.WebSocket;\n let socket: WebSocket;\n try {\n socket = real = new Impl(url, protocols);\n } catch {\n clients.clear();\n return post({ t: 'close', code: 1006, reason: '', wasClean: false });\n }\n socket.binaryType = 'arraybuffer';\n socket.onopen = () => {\n for (const [id, told] of clients) if (!told) opened(id);\n };\n socket.onmessage = event => {\n const topic = topicOf(options.topics?.topic, read(event.data));\n if (topic === undefined) return post({ t: 'message', data: event.data });\n const to = [...(holders.get(topic) ?? [])];\n if (to.length) post({ t: 'message', data: event.data, to });\n };\n socket.onerror = () => {};\n socket.onclose = event => {\n if (real !== socket) return;\n real = undefined;\n clients.clear();\n holders.clear();\n post({ t: 'close', code: event.code, reason: event.reason, wasClean: event.wasClean });\n };\n }\n\n function send(id: string, data: unknown) {\n const { topics } = options;\n if (topics) {\n const message = read(data);\n const subscribed = topicOf(topics.subscribe, message);\n if (subscribed !== undefined) {\n if (!holders.has(subscribed)) holders.set(subscribed, new Set());\n holders.get(subscribed)!.add(id);\n }\n const unsubscribed = topicOf(topics.unsubscribe, message);\n if (unsubscribed !== undefined) {\n const set = holders.get(unsubscribed);\n set?.delete(id);\n if (set?.size) return; // another tab still holds it\n holders.delete(unsubscribed);\n }\n }\n if (real?.readyState === OPEN) real.send(data as Parameters<WebSocket['send']>[0]);\n }\n\n function handle(signal: Signal) {\n if (signal.t === 'connect') {\n clearTimeout(lingerTimer);\n clients.set(signal.id, false);\n connect();\n if (real?.readyState === OPEN) opened(signal.id);\n } else if (signal.t === 'send') {\n if (clients.get(signal.id)) send(signal.id, signal.data);\n } else if (signal.t === 'disconnect') {\n clients.delete(signal.id);\n for (const set of holders.values()) set.delete(signal.id);\n if (!clients.size) {\n clearTimeout(lingerTimer);\n lingerTimer = setTimeout(() => {\n if (clients.size || !real) return;\n // Forget it first: a tab connecting while it closes gets a new one.\n const socket = real;\n real = undefined;\n socket.close(1000);\n }, linger);\n }\n }\n }\n\n agents.set(key, {\n channel,\n stop() {\n clearTimeout(lingerTimer);\n channel.close();\n if (real) {\n real.onclose = null;\n real.close(1000);\n }\n release?.();\n }\n });\n void navigator.locks.request(key, () => {\n if (!agents.has(key)) return;\n channel.onmessage = event => handle(event.data as Signal);\n // Sockets that were using the tab that led before start over with this one.\n post({ t: 'leader' });\n // Lead until this tab goes away, or `dispose()`.\n return new Promise<void>(resolve => (release = resolve));\n });\n }\n\n const Fallback = options.WebSocket;\n\n class TabSocket extends EventTarget implements WebSocket {\n static readonly CONNECTING = CONNECTING;\n static readonly OPEN = OPEN;\n static readonly CLOSING = CLOSING;\n static readonly CLOSED = CLOSED;\n readonly CONNECTING = CONNECTING;\n readonly OPEN = OPEN;\n readonly CLOSING = CLOSING;\n readonly CLOSED = CLOSED;\n\n readonly url: string;\n readonly extensions = '';\n onopen: WebSocket['onopen'] = null;\n onmessage: WebSocket['onmessage'] = null;\n onerror: WebSocket['onerror'] = null;\n onclose: WebSocket['onclose'] = null;\n binaryType: BinaryType = 'blob';\n protocol = '';\n\n #id = `${Date.now().toString(36)}-${++ids}-${Math.random().toString(36).slice(2)}`;\n #state: WebSocket['readyState'] = CONNECTING;\n #channel: BroadcastChannel | undefined;\n // The page is going away, or into the back/forward cache: let go of the shared socket, and\n // close, so a page that comes back connects again.\n #leave = () => {\n if (this.#state >= CLOSING) return; // `close()` told the leader already\n this.#post({ t: 'disconnect', id: this.#id });\n this.#end(1001, '', false);\n };\n // Without `BroadcastChannel` or locks: a socket of this tab's own.\n #inner: WebSocket | undefined;\n\n static dispose() {\n for (const { stop } of agents.values()) stop();\n agents.clear();\n }\n\n constructor(url: string | URL, protocols?: string | string[]) {\n super();\n if (typeof window === 'undefined') {\n throw new Error('react-websocket/tabs: no WebSocket here (server render?)');\n }\n for (const type of ['open', 'message', 'error', 'close'] as const) {\n this.addEventListener(type, event =>\n (this[`on${type}`] as ((event: Event) => void) | null)?.call(this, event)\n );\n }\n this.url = String(url);\n if (typeof BroadcastChannel === 'undefined' || !globalThis.navigator?.locks) {\n const inner = (this.#inner = new (Fallback ?? globalThis.WebSocket)(url, protocols));\n // As from the leading tab: `#message` turns it into what `binaryType` asks for.\n inner.binaryType = 'arraybuffer';\n inner.onopen = () => this.#open(inner.protocol);\n inner.onmessage = event => this.#message(event.data);\n inner.onerror = () => this.dispatchEvent(new Event('error'));\n inner.onclose = event => this.#end(event.code, event.reason, event.wasClean);\n return;\n }\n // The session goes first: Node routes channel messages by the name up to a NUL.\n const session = options.session\n ? `session=${encodeURIComponent(options.session() ?? '')}:`\n : '';\n const key = `react-websocket-tabs:${session}${this.url}\\u0000${JSON.stringify(protocols ?? null)}`;\n agent(key, this.url, protocols);\n const channel = (this.#channel = new BroadcastChannel(key));\n channel.onmessage = event => this.#signal(event.data as Signal);\n this.#post({ t: 'connect', id: this.#id });\n live.add(this.#leave);\n if (!hiding) {\n hiding = true;\n addEventListener('pagehide', onPageHide);\n }\n }\n\n get readyState() {\n return this.#state;\n }\n\n get bufferedAmount() {\n return this.#inner?.bufferedAmount ?? 0;\n }\n\n send(data: Parameters<WebSocket['send']>[0]) {\n if (this.#state === CONNECTING) {\n throw new DOMException('WebSocket is still in CONNECTING state', 'InvalidStateError');\n }\n if (this.#state !== OPEN) return;\n if (this.#inner) this.#inner.send(data);\n else this.#post({ t: 'send', id: this.#id, data });\n }\n\n close(code = 1000, reason = '') {\n if (this.#state >= CLOSING) return;\n // First, so that a code the socket rejects throws before anything has changed.\n if (this.#inner) this.#inner.close(code, reason);\n this.#state = CLOSING;\n if (this.#inner) return;\n // Only this tab's socket closes; the shared one stays for the others.\n this.#post({ t: 'disconnect', id: this.#id });\n setTimeout(() => this.#end(code, reason, true), 0);\n }\n\n #post(signal: Signal) {\n this.#channel?.postMessage(signal);\n }\n\n #signal(signal: Signal) {\n if (signal.t === 'open') {\n if (signal.id === this.#id && this.#state === CONNECTING) this.#open(signal.protocol);\n } else if (signal.t === 'message') {\n if (!signal.to || signal.to.includes(this.#id)) this.#message(signal.data);\n } else if (signal.t === 'close') {\n if (this.#state !== CONNECTING) this.#end(signal.code, signal.reason, signal.wasClean);\n else {\n // The shared socket failed before this one opened.\n this.dispatchEvent(new Event('error'));\n this.#end(signal.code, signal.reason, false);\n }\n } else if (signal.t === 'leader') {\n // A new leading tab: start over with it, or ask it to connect us.\n if (this.#state === CONNECTING) this.#post({ t: 'connect', id: this.#id });\n else this.#end(1006, '', false);\n }\n }\n\n #open(protocol: string) {\n this.#state = OPEN;\n this.protocol = protocol;\n this.dispatchEvent(new Event('open'));\n }\n\n #message(data: unknown) {\n if (this.#state !== OPEN) return;\n if (data instanceof ArrayBuffer && this.binaryType === 'blob') data = new Blob([data]);\n this.dispatchEvent(new MessageEvent('message', { data }));\n }\n\n #end(code: number, reason: string, wasClean: boolean) {\n if (this.#state === CLOSED) return;\n this.#state = CLOSED;\n this.#channel?.close();\n live.delete(this.#leave);\n this.dispatchEvent(closeEvent(code, reason, wasClean));\n }\n }\n\n return TabSocket as unknown as TabsWebSocket;\n}\n"],"mappings":";AAyDA,MAAM,aAAa;AACnB,MAAM,OAAO;AACb,MAAM,UAAU;AAChB,MAAM,SAAS;AAYf,SAAS,WAAW,MAAc,QAAgB,UAA0B;CAC1E,MAAM,OAAO;EAAE;EAAM;EAAQ;CAAS;CAEtC,OAAO,OAAO,eAAe,aACzB,IAAI,WAAW,SAAS,IAAI,IAC5B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG,IAAI;AAC5C;AAEA,IAAI,MAAM;AAGV,MAAM,SAAS,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtB,SAAgB,oBAAoB,UAAgC,CAAC,GAAkB;CACrF,MAAM,SAAS,QAAQ,UAAU;CAEjC,MAAM,yBAAS,IAAI,IAA6D;CAEhF,MAAM,QAAQ,SAAkB;EAC9B,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,UAAU,OAAO;EACtD,IAAI;GACF,OAAO,KAAK,MAAM,IAAI;EACxB,QAAQ;GACN,OAAO;EACT;CACF;;CAGA,MAAM,WACJ,WACA,YACG;EACH,IAAI,CAAC,aAAa,YAAY,QAAQ,OAAO,KAAA;EAC7C,IAAI;GACF,OAAO,UAAU,OAAO,KAAK,KAAA;EAC/B,QAAQ;GACN;EACF;CACF;CAIA,MAAM,uBAAO,IAAI,IAAgB;CACjC,IAAI,SAAS;CACb,MAAM,mBAAmB;EACvB,KAAK,MAAM,SAAS,CAAC,GAAG,IAAI,GAAG,MAAM;CACvC;CAEA,SAAS,MAAM,KAAa,KAAa,WAA0C;EACjF,IAAI,OAAO,IAAI,GAAG,GAAG;EACrB,MAAM,UAAU,IAAI,iBAAiB,GAAG;EACxC,MAAM,QAAQ,WAAmB,QAAQ,YAAY,MAAM;EAC3D,IAAI;EAEJ,MAAM,0BAAU,IAAI,IAAqB;EAEzC,MAAM,0BAAU,IAAI,IAAyB;EAC7C,IAAI;EACJ,IAAI;EAEJ,SAAS,OAAO,IAAY;GAC1B,QAAQ,IAAI,IAAI,IAAI;GACpB,KAAK;IAAE,GAAG;IAAQ;IAAI,UAAU,KAAM;GAAS,CAAC;EAClD;EAEA,SAAS,UAAU;GACjB,IAAI,MAAM;GACV,MAAM,OAAO,QAAQ,aAAa,WAAW;GAC7C,IAAI;GACJ,IAAI;IACF,SAAS,OAAO,IAAI,KAAK,KAAK,SAAS;GACzC,QAAQ;IACN,QAAQ,MAAM;IACd,OAAO,KAAK;KAAE,GAAG;KAAS,MAAM;KAAM,QAAQ;KAAI,UAAU;IAAM,CAAC;GACrE;GACA,OAAO,aAAa;GACpB,OAAO,eAAe;IACpB,KAAK,MAAM,CAAC,IAAI,SAAS,SAAS,IAAI,CAAC,MAAM,OAAO,EAAE;GACxD;GACA,OAAO,aAAY,UAAS;IAC1B,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,OAAO,KAAK,MAAM,IAAI,CAAC;IAC7D,IAAI,UAAU,KAAA,GAAW,OAAO,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;IAAK,CAAC;IACvE,MAAM,KAAK,CAAC,GAAI,QAAQ,IAAI,KAAK,KAAK,CAAC,CAAE;IACzC,IAAI,GAAG,QAAQ,KAAK;KAAE,GAAG;KAAW,MAAM,MAAM;KAAM;IAAG,CAAC;GAC5D;GACA,OAAO,gBAAgB,CAAC;GACxB,OAAO,WAAU,UAAS;IACxB,IAAI,SAAS,QAAQ;IACrB,OAAO,KAAA;IACP,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,KAAK;KAAE,GAAG;KAAS,MAAM,MAAM;KAAM,QAAQ,MAAM;KAAQ,UAAU,MAAM;IAAS,CAAC;GACvF;EACF;EAEA,SAAS,KAAK,IAAY,MAAe;GACvC,MAAM,EAAE,WAAW;GACnB,IAAI,QAAQ;IACV,MAAM,UAAU,KAAK,IAAI;IACzB,MAAM,aAAa,QAAQ,OAAO,WAAW,OAAO;IACpD,IAAI,eAAe,KAAA,GAAW;KAC5B,IAAI,CAAC,QAAQ,IAAI,UAAU,GAAG,QAAQ,IAAI,4BAAY,IAAI,IAAI,CAAC;KAC/D,QAAQ,IAAI,UAAU,CAAC,CAAE,IAAI,EAAE;IACjC;IACA,MAAM,eAAe,QAAQ,OAAO,aAAa,OAAO;IACxD,IAAI,iBAAiB,KAAA,GAAW;KAC9B,MAAM,MAAM,QAAQ,IAAI,YAAY;KACpC,KAAK,OAAO,EAAE;KACd,IAAI,KAAK,MAAM;KACf,QAAQ,OAAO,YAAY;IAC7B;GACF;GACA,IAAI,MAAM,eAAe,MAAM,KAAK,KAAK,IAAwC;EACnF;EAEA,SAAS,OAAO,QAAgB;GAC9B,IAAI,OAAO,MAAM,WAAW;IAC1B,aAAa,WAAW;IACxB,QAAQ,IAAI,OAAO,IAAI,KAAK;IAC5B,QAAQ;IACR,IAAI,MAAM,eAAe,MAAM,OAAO,OAAO,EAAE;GACjD,OAAO,IAAI,OAAO,MAAM,QAClB;QAAA,QAAQ,IAAI,OAAO,EAAE,GAAG,KAAK,OAAO,IAAI,OAAO,IAAI;GAAA,OAClD,IAAI,OAAO,MAAM,cAAc;IACpC,QAAQ,OAAO,OAAO,EAAE;IACxB,KAAK,MAAM,OAAO,QAAQ,OAAO,GAAG,IAAI,OAAO,OAAO,EAAE;IACxD,IAAI,CAAC,QAAQ,MAAM;KACjB,aAAa,WAAW;KACxB,cAAc,iBAAiB;MAC7B,IAAI,QAAQ,QAAQ,CAAC,MAAM;MAE3B,MAAM,SAAS;MACf,OAAO,KAAA;MACP,OAAO,MAAM,GAAI;KACnB,GAAG,MAAM;IACX;GACF;EACF;EAEA,OAAO,IAAI,KAAK;GACd;GACA,OAAO;IACL,aAAa,WAAW;IACxB,QAAQ,MAAM;IACd,IAAI,MAAM;KACR,KAAK,UAAU;KACf,KAAK,MAAM,GAAI;IACjB;IACA,UAAU;GACZ;EACF,CAAC;EACD,UAAe,MAAM,QAAQ,WAAW;GACtC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG;GACtB,QAAQ,aAAY,UAAS,OAAO,MAAM,IAAc;GAExD,KAAK,EAAE,GAAG,SAAS,CAAC;GAEpB,OAAO,IAAI,SAAc,YAAY,UAAU,OAAQ;EACzD,CAAC;CACH;CAEA,MAAM,WAAW,QAAQ;CAEzB,MAAM,kBAAkB,YAAiC;EACvD,OAAgB,aAAa;EAC7B,OAAgB,OAAO;EACvB,OAAgB,UAAU;EAC1B,OAAgB,SAAS;EACzB,aAAsB;EACtB,OAAgB;EAChB,UAAmB;EACnB,SAAkB;EAElB;EACA,aAAsB;EACtB,SAA8B;EAC9B,YAAoC;EACpC,UAAgC;EAChC,UAAgC;EAChC,aAAyB;EACzB,WAAW;EAEX,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;EAC/E,SAAkC;EAClC;EAGA,eAAe;GACb,IAAI,KAAK,UAAU,SAAS;GAC5B,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,KAAK,KAAK,MAAM,IAAI,KAAK;EAC3B;EAEA;EAEA,OAAO,UAAU;GACf,KAAK,MAAM,EAAE,UAAU,OAAO,OAAO,GAAG,KAAK;GAC7C,OAAO,MAAM;EACf;EAEA,YAAY,KAAmB,WAA+B;GAC5D,MAAM;GACN,IAAI,OAAO,WAAW,aACpB,MAAM,IAAI,MAAM,0DAA0D;GAE5E,KAAK,MAAM,QAAQ;IAAC;IAAQ;IAAW;IAAS;GAAO,GACrD,KAAK,iBAAiB,OAAM,UACzB,KAAK,KAAK,OAAO,EAAsC,KAAK,MAAM,KAAK,CAC1E;GAEF,KAAK,MAAM,OAAO,GAAG;GACrB,IAAI,OAAO,qBAAqB,eAAe,CAAC,WAAW,WAAW,OAAO;IAC3E,MAAM,QAAS,KAAK,SAAS,KAAK,YAAY,WAAW,WAAW,KAAK,SAAS;IAElF,MAAM,aAAa;IACnB,MAAM,eAAe,KAAK,MAAM,MAAM,QAAQ;IAC9C,MAAM,aAAY,UAAS,KAAK,SAAS,MAAM,IAAI;IACnD,MAAM,gBAAgB,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;IAC3D,MAAM,WAAU,UAAS,KAAK,KAAK,MAAM,MAAM,MAAM,QAAQ,MAAM,QAAQ;IAC3E;GACF;GAKA,MAAM,MAAM,wBAHI,QAAQ,UACpB,WAAW,mBAAmB,QAAQ,QAAQ,KAAK,EAAE,EAAE,KACvD,KAC0C,KAAK,IAAI,QAAQ,KAAK,UAAU,aAAa,IAAI;GAC/F,MAAM,KAAK,KAAK,KAAK,SAAS;GAC9B,MAAM,UAAW,KAAK,WAAW,IAAI,iBAAiB,GAAG;GACzD,QAAQ,aAAY,UAAS,KAAK,QAAQ,MAAM,IAAc;GAC9D,KAAK,MAAM;IAAE,GAAG;IAAW,IAAI,KAAK;GAAI,CAAC;GACzC,KAAK,IAAI,KAAK,MAAM;GACpB,IAAI,CAAC,QAAQ;IACX,SAAS;IACT,iBAAiB,YAAY,UAAU;GACzC;EACF;EAEA,IAAI,aAAa;GACf,OAAO,KAAK;EACd;EAEA,IAAI,iBAAiB;GACnB,OAAO,KAAK,QAAQ,kBAAkB;EACxC;EAEA,KAAK,MAAwC;GAC3C,IAAI,KAAK,WAAW,YAClB,MAAM,IAAI,aAAa,0CAA0C,mBAAmB;GAEtF,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,KAAK,QAAQ,KAAK,OAAO,KAAK,IAAI;QACjC,KAAK,MAAM;IAAE,GAAG;IAAQ,IAAI,KAAK;IAAK;GAAK,CAAC;EACnD;EAEA,MAAM,OAAO,KAAM,SAAS,IAAI;GAC9B,IAAI,KAAK,UAAU,SAAS;GAE5B,IAAI,KAAK,QAAQ,KAAK,OAAO,MAAM,MAAM,MAAM;GAC/C,KAAK,SAAS;GACd,IAAI,KAAK,QAAQ;GAEjB,KAAK,MAAM;IAAE,GAAG;IAAc,IAAI,KAAK;GAAI,CAAC;GAC5C,iBAAiB,KAAK,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC;EACnD;EAEA,MAAM,QAAgB;GACpB,KAAK,UAAU,YAAY,MAAM;EACnC;EAEA,QAAQ,QAAgB;GACtB,IAAI,OAAO,MAAM,QACX;QAAA,OAAO,OAAO,KAAK,OAAO,KAAK,WAAW,YAAY,KAAK,MAAM,OAAO,QAAQ;GAAA,OAC/E,IAAI,OAAO,MAAM,WAClB;QAAA,CAAC,OAAO,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,KAAK,SAAS,OAAO,IAAI;GAAA,OACpE,IAAI,OAAO,MAAM,SAAS;IAC/B,IAAI,KAAK,WAAW,YAAY,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,OAAO,QAAQ;SAChF;KAEH,KAAK,cAAc,IAAI,MAAM,OAAO,CAAC;KACrC,KAAK,KAAK,OAAO,MAAM,OAAO,QAAQ,KAAK;IAC7C;GACF,OAAO,IAAI,OAAO,MAAM,UAAU;IAEhC,IAAI,KAAK,WAAW,YAAY,KAAK,MAAM;KAAE,GAAG;KAAW,IAAI,KAAK;IAAI,CAAC;SACpE,KAAK,KAAK,MAAM,IAAI,KAAK;GAChC;EACF;EAEA,MAAM,UAAkB;GACtB,KAAK,SAAS;GACd,KAAK,WAAW;GAChB,KAAK,cAAc,IAAI,MAAM,MAAM,CAAC;EACtC;EAEA,SAAS,MAAe;GACtB,IAAI,KAAK,WAAW,MAAM;GAC1B,IAAI,gBAAgB,eAAe,KAAK,eAAe,QAAQ,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC;GACrF,KAAK,cAAc,IAAI,aAAa,WAAW,EAAE,KAAK,CAAC,CAAC;EAC1D;EAEA,KAAK,MAAc,QAAgB,UAAmB;GACpD,IAAI,KAAK,WAAW,QAAQ;GAC5B,KAAK,SAAS;GACd,KAAK,UAAU,MAAM;GACrB,KAAK,OAAO,KAAK,MAAM;GACvB,KAAK,cAAc,WAAW,MAAM,QAAQ,QAAQ,CAAC;EACvD;CACF;CAEA,OAAO;AACT"}
|
package/dist/timeline.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { t as WebSocketClient } from "./types-
|
|
1
|
+
import { t as WebSocketClient } from "./types-paLT8yQF.cjs";
|
|
2
2
|
//#region src/latency.d.ts
|
|
3
3
|
/** Latest latency measurements. A new object is created on every change. */
|
|
4
4
|
interface Latency {
|
|
@@ -164,4 +164,5 @@ export interface WebSocketTimeline<S, I> {
|
|
|
164
164
|
*/
|
|
165
165
|
export declare function createWebSocketTimeline<In, const Out, S, I = never>(client: WebSocketClient<In, Out>, options: WebSocketTimelineOptions<S, I, NoInfer<In>, NoInfer<Out>>): WebSocketTimeline<S, I>;
|
|
166
166
|
//#endregion
|
|
167
|
+
export {};
|
|
167
168
|
//# sourceMappingURL=timeline.d.cts.map
|
|
@@ -28,7 +28,10 @@ type Status = 'idle' | 'connecting' | 'open' | 'reconnecting' | 'closed';
|
|
|
28
28
|
interface Snapshot<In> {
|
|
29
29
|
/** Connection state. */
|
|
30
30
|
readonly status: Status;
|
|
31
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Most recent message (after `parse`/`json` and `schema`), kept across reconnects and
|
|
33
|
+
* cleared by `close()`.
|
|
34
|
+
*/
|
|
32
35
|
readonly lastMessage: In | undefined;
|
|
33
36
|
/**
|
|
34
37
|
* Consecutive failed attempts since the last stable connection. A connection that closes
|
|
@@ -220,9 +223,10 @@ interface WebSocketClient<In = unknown, Out = unknown> {
|
|
|
220
223
|
*/
|
|
221
224
|
connect(): void;
|
|
222
225
|
/**
|
|
223
|
-
* Close the connection and stop reconnecting. The status becomes `closed
|
|
224
|
-
*
|
|
225
|
-
* to start again. Closed while no hook
|
|
226
|
+
* Close the connection and stop reconnecting. The status becomes `closed`, and the send
|
|
227
|
+
* queue, a `migrate()` target and `lastMessage` are cleared, so call it on logout. Mounted
|
|
228
|
+
* hooks stay mounted; call `connect()` or `reconnect()` to start again. Closed while no hook
|
|
229
|
+
* holds it, the next hook to mount starts it again.
|
|
226
230
|
*
|
|
227
231
|
* Like `WebSocket.close()`, it throws for a code or reason the socket rejects (browsers take
|
|
228
232
|
* `1000` or `3000`–`4999`, and a reason up to 123 bytes), and then nothing has changed.
|
|
@@ -231,7 +235,8 @@ interface WebSocketClient<In = unknown, Out = unknown> {
|
|
|
231
235
|
close(code?: number, reason?: string): void;
|
|
232
236
|
/**
|
|
233
237
|
* Drop the current socket (if any) and connect again immediately, resetting the
|
|
234
|
-
* backoff. Also restarts a `closed` client.
|
|
238
|
+
* backoff. Also restarts a `closed` client. The send queue and a `migrate()` target are
|
|
239
|
+
* kept: when another user signs in, call `close()` and then `connect()` instead.
|
|
235
240
|
*/
|
|
236
241
|
reconnect(): void;
|
|
237
242
|
/**
|
|
@@ -265,4 +270,4 @@ interface WebSocketClient<In = unknown, Out = unknown> {
|
|
|
265
270
|
}
|
|
266
271
|
//#endregion
|
|
267
272
|
export { WebSocketClient as t };
|
|
268
|
-
//# sourceMappingURL=types-
|
|
273
|
+
//# sourceMappingURL=types-paLT8yQF.d.cts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "react-websocket",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.22.0",
|
|
4
4
|
"description": "The real-time toolkit for React: a WebSocket hook with shared connections, auto-reconnect and typed messages, plus topics, state, requests, presence and AI agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
"@types/react": "^19.3.0",
|
|
180
180
|
"@types/react-dom": "^19.3.0",
|
|
181
181
|
"@vitejs/plugin-react": "^6.1.2",
|
|
182
|
-
"@vitest/coverage-v8": "5.0.
|
|
182
|
+
"@vitest/coverage-v8": "5.0.5",
|
|
183
183
|
"fake-indexeddb": "^6.2.5",
|
|
184
184
|
"jsdom": "^30.1.2",
|
|
185
185
|
"publint": "^0.3.25",
|
|
@@ -187,9 +187,9 @@
|
|
|
187
187
|
"react-dom": "^19.3.0",
|
|
188
188
|
"size-limit": "^14.2.0",
|
|
189
189
|
"typescript": "^7.0.2",
|
|
190
|
-
"vite": "npm:@voidzero-dev/vite-plus-core@1.
|
|
191
|
-
"vite-plus": "1.
|
|
192
|
-
"vitest": "5.0.
|
|
190
|
+
"vite": "npm:@voidzero-dev/vite-plus-core@1.3.0",
|
|
191
|
+
"vite-plus": "1.3.0",
|
|
192
|
+
"vitest": "5.0.5"
|
|
193
193
|
},
|
|
194
194
|
"size-limit": [
|
|
195
195
|
{
|
|
@@ -269,7 +269,7 @@
|
|
|
269
269
|
"ignore": [
|
|
270
270
|
"react"
|
|
271
271
|
],
|
|
272
|
-
"limit": "
|
|
272
|
+
"limit": "2 kB",
|
|
273
273
|
"gzip": true
|
|
274
274
|
},
|
|
275
275
|
{
|
|
@@ -327,7 +327,7 @@
|
|
|
327
327
|
"name": "react-websocket/tabs (createTabsWebSocket)",
|
|
328
328
|
"path": "dist/tabs.js",
|
|
329
329
|
"import": "{ createTabsWebSocket }",
|
|
330
|
-
"limit": "1.
|
|
330
|
+
"limit": "1.9 kB",
|
|
331
331
|
"gzip": true
|
|
332
332
|
},
|
|
333
333
|
{
|
|
@@ -341,19 +341,19 @@
|
|
|
341
341
|
"name": "react-websocket/ag-ui (createAgUiAgent)",
|
|
342
342
|
"path": "dist/ag-ui.js",
|
|
343
343
|
"import": "{ createAgUiAgent }",
|
|
344
|
-
"limit": "3.
|
|
344
|
+
"limit": "3.95 kB",
|
|
345
345
|
"gzip": true
|
|
346
346
|
},
|
|
347
347
|
{
|
|
348
348
|
"name": "react-websocket/outbox (createWebSocketOutbox)",
|
|
349
349
|
"path": "dist/outbox.js",
|
|
350
350
|
"import": "{ createWebSocketOutbox }",
|
|
351
|
-
"limit": "1.
|
|
351
|
+
"limit": "1.4 kB",
|
|
352
352
|
"gzip": true
|
|
353
353
|
}
|
|
354
354
|
],
|
|
355
355
|
"overrides": {
|
|
356
|
-
"vite": "npm:@voidzero-dev/vite-plus-core@1.
|
|
357
|
-
"vitest": "5.0.
|
|
356
|
+
"vite": "npm:@voidzero-dev/vite-plus-core@1.3.0",
|
|
357
|
+
"vitest": "5.0.5"
|
|
358
358
|
}
|
|
359
359
|
}
|