@holo-js/flux 0.3.15 → 0.3.17

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/index.d.ts CHANGED
@@ -1,7 +1,5 @@
1
1
  import { GeneratedBroadcastManifest, BroadcastJsonObject } from '@holo-js/broadcast';
2
2
 
3
- type FluxConnectionStatus = 'idle' | 'connecting' | 'connected' | 'disconnected';
4
- type FluxChannelKind = 'public' | 'private' | 'presence';
5
3
  type ManifestEventName<TManifest extends GeneratedBroadcastManifest> = TManifest['events'][number]['name'] & string;
6
4
  type ManifestChannelPattern<TManifest extends GeneratedBroadcastManifest> = TManifest['channels'][number]['pattern'] & string;
7
5
  type ManifestChannelEntryByPattern<TManifest extends GeneratedBroadcastManifest, TPattern extends string> = Extract<TManifest['channels'][number], {
@@ -20,6 +18,19 @@ type ManifestEventNamesForPattern<TManifest extends GeneratedBroadcastManifest,
20
18
  }[];
21
19
  } ? TPattern extends TEventPattern & string ? TName & string : never : never : never;
22
20
  type ManifestSubscriptionEventName<TManifest extends GeneratedBroadcastManifest, TChannel extends string> = string extends ManifestEventName<TManifest> ? string : TChannel extends ManifestChannelPattern<TManifest> ? ManifestEventNamesForPattern<TManifest, TChannel> : ManifestEventName<TManifest>;
21
+ type ManifestAdapterEventName<TManifest extends GeneratedBroadcastManifest, TChannel extends string> = string extends ManifestEventName<TManifest> ? string : TChannel extends ManifestChannelPattern<TManifest> ? ManifestEventNamesForPattern<TManifest, TChannel> : never;
22
+ type ManifestAdapterPresenceMember<TMember, TManifest extends GeneratedBroadcastManifest, TChannel extends string> = unknown extends TMember ? string extends ManifestChannelPattern<TManifest> ? BroadcastJsonObject : ManifestPresenceMember<TManifest, TChannel> : TMember;
23
+ type FluxManifestTypes<TManifest extends GeneratedBroadcastManifest, TChannel extends string = string, TMember = unknown> = {
24
+ readonly channelPattern: ManifestChannelPattern<TManifest>;
25
+ readonly subscriptionEvent: ManifestSubscriptionEventName<TManifest, TChannel>;
26
+ readonly adapterEvent: ManifestAdapterEventName<TManifest, TChannel>;
27
+ readonly presenceMember: ManifestPresenceMember<TManifest, TChannel>;
28
+ readonly adapterPresenceMember: ManifestAdapterPresenceMember<TMember, TManifest, TChannel>;
29
+ readonly whisperName: ManifestWhisperName<TManifest, TChannel>;
30
+ };
31
+
32
+ type FluxConnectionStatus = 'idle' | 'connecting' | 'connected' | 'disconnected';
33
+ type FluxChannelKind = 'public' | 'private' | 'presence';
23
34
  interface FluxClientOptions<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest> {
24
35
  readonly manifest?: TManifest;
25
36
  readonly connection?: string;
@@ -36,9 +47,9 @@ interface FluxPresenceState<TMember = unknown> {
36
47
  readonly members: readonly TMember[];
37
48
  }
38
49
  interface FluxPresenceListenerControls<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest, TChannel extends string = string> {
39
- here(callback: (members: readonly ManifestPresenceMember<TManifest, TChannel>[]) => void): FluxPresenceSubscription<TManifest, TChannel>;
40
- joining(callback: (member: ManifestPresenceMember<TManifest, TChannel>) => void): FluxPresenceSubscription<TManifest, TChannel>;
41
- leaving(callback: (member: ManifestPresenceMember<TManifest, TChannel>) => void): FluxPresenceSubscription<TManifest, TChannel>;
50
+ here(callback: (members: readonly FluxManifestTypes<TManifest, TChannel>['presenceMember'][]) => void): FluxPresenceSubscription<TManifest, TChannel>;
51
+ joining(callback: (member: FluxManifestTypes<TManifest, TChannel>['presenceMember']) => void): FluxPresenceSubscription<TManifest, TChannel>;
52
+ leaving(callback: (member: FluxManifestTypes<TManifest, TChannel>['presenceMember']) => void): FluxPresenceSubscription<TManifest, TChannel>;
42
53
  }
43
54
  interface FluxConnectionControls {
44
55
  connect(): Promise<void>;
@@ -67,19 +78,19 @@ interface FluxConnector {
67
78
  interface FluxSubscription<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest, TChannel extends string = string> extends FluxListenerControls {
68
79
  readonly name: TChannel;
69
80
  readonly type: FluxChannelKind;
70
- listen<TEvent extends ManifestSubscriptionEventName<TManifest, TChannel>>(event?: TEvent | readonly TEvent[], callback?: (payload: BroadcastJsonObject) => void): FluxSubscription<TManifest, TChannel>;
81
+ listen<TEvent extends FluxManifestTypes<TManifest, TChannel>['subscriptionEvent']>(event?: TEvent | readonly TEvent[], callback?: (payload: BroadcastJsonObject) => void): FluxSubscription<TManifest, TChannel>;
71
82
  notification(callback: (payload: BroadcastJsonObject) => void): FluxSubscription<TManifest, TChannel>;
72
- listenForWhisper<TWhisper extends ManifestWhisperName<TManifest, TChannel>>(name: TWhisper, callback: (payload: BroadcastJsonObject) => void): FluxSubscription<TManifest, TChannel>;
73
- whisper<TWhisper extends ManifestWhisperName<TManifest, TChannel>>(name: TWhisper, payload: BroadcastJsonObject): Promise<void>;
83
+ listenForWhisper<TWhisper extends FluxManifestTypes<TManifest, TChannel>['whisperName']>(name: TWhisper, callback: (payload: BroadcastJsonObject) => void): FluxSubscription<TManifest, TChannel>;
84
+ whisper<TWhisper extends FluxManifestTypes<TManifest, TChannel>['whisperName']>(name: TWhisper, payload: BroadcastJsonObject): Promise<void>;
74
85
  }
75
- interface FluxPresenceSubscription<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest, TChannel extends string = string> extends FluxSubscription<TManifest, TChannel>, FluxPresenceState<ManifestPresenceMember<TManifest, TChannel>>, FluxPresenceListenerControls<TManifest, TChannel> {
86
+ interface FluxPresenceSubscription<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest, TChannel extends string = string> extends FluxSubscription<TManifest, TChannel>, FluxPresenceState<FluxManifestTypes<TManifest, TChannel>['presenceMember']>, FluxPresenceListenerControls<TManifest, TChannel> {
76
87
  }
77
88
  interface FluxClient<TManifest extends GeneratedBroadcastManifest = GeneratedBroadcastManifest> extends FluxConnectionControls {
78
89
  readonly options: Readonly<FluxClientOptions<TManifest>>;
79
90
  readonly status: FluxConnectionStatus;
80
- channel<TChannel extends ManifestChannelPattern<TManifest> | (string & {})>(name: TChannel): FluxSubscription<TManifest, TChannel>;
81
- private<TChannel extends ManifestChannelPattern<TManifest> | (string & {})>(name: TChannel): FluxSubscription<TManifest, TChannel>;
82
- presence<TChannel extends ManifestChannelPattern<TManifest> | (string & {})>(name: TChannel): FluxPresenceSubscription<TManifest, TChannel>;
91
+ channel<TChannel extends FluxManifestTypes<TManifest>['channelPattern'] | (string & {})>(name: TChannel): FluxSubscription<TManifest, TChannel>;
92
+ private<TChannel extends FluxManifestTypes<TManifest>['channelPattern'] | (string & {})>(name: TChannel): FluxSubscription<TManifest, TChannel>;
93
+ presence<TChannel extends FluxManifestTypes<TManifest>['channelPattern'] | (string & {})>(name: TChannel): FluxPresenceSubscription<TManifest, TChannel>;
83
94
  }
84
95
  type PusherConnectorOptions = {
85
96
  readonly transport?: 'mock';
@@ -103,6 +114,8 @@ type ConnectorDebugCarrier = {
103
114
  readonly __debug?: PusherConnectorDebug;
104
115
  };
105
116
  type SubscriptionRegistry = Map<string, Set<() => void>>;
117
+ declare function appendPresenceMember<TMember>(members: readonly TMember[], member: TMember): readonly TMember[];
118
+ declare function removePresenceMember<TMember>(members: readonly TMember[], member: TMember): readonly TMember[];
106
119
  declare function createUnavailableConnector(): FluxConnector;
107
120
  declare function createPusherConnector(options?: PusherConnectorOptions): FluxConnector & ConnectorDebugCarrier;
108
121
  declare function createHoloWebSocketConnector(options?: HoloWebSocketConnectorOptions): FluxConnector;
@@ -117,6 +130,8 @@ declare function getFluxClient(): FluxClient;
117
130
  declare function resetFluxClient(): void;
118
131
  declare const flux: FluxClient<GeneratedBroadcastManifest>;
119
132
  declare const fluxInternals: {
133
+ appendPresenceMember: typeof appendPresenceMember;
134
+ removePresenceMember: typeof removePresenceMember;
120
135
  createHoloWebSocketConnector: typeof createHoloWebSocketConnector;
121
136
  createUnavailableConnector: typeof createUnavailableConnector;
122
137
  createPusherConnector: typeof createPusherConnector;
@@ -124,4 +139,4 @@ declare const fluxInternals: {
124
139
  createSubscription: typeof createSubscription;
125
140
  };
126
141
 
127
- export { type FluxChannelKind, type FluxClient, type FluxClientOptions, type FluxConnectionControls, type FluxConnectionStatus, type FluxConnector, type FluxConnectorChannel, type FluxListenerControls, type FluxPresenceListenerControls, type FluxPresenceState, type FluxPresenceSubscription, type FluxSubscription, configureFluxClient, createFluxClient, flux as default, flux, fluxInternals, getFluxClient, resetFluxClient };
142
+ export { type FluxChannelKind, type FluxClient, type FluxClientOptions, type FluxConnectionControls, type FluxConnectionStatus, type FluxConnector, type FluxConnectorChannel, type FluxListenerControls, type FluxManifestTypes, type FluxPresenceListenerControls, type FluxPresenceState, type FluxPresenceSubscription, type FluxSubscription, configureFluxClient, createFluxClient, flux as default, flux, fluxInternals, getFluxClient, resetFluxClient };
package/dist/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  // src/index.ts
2
- var WEB_SOCKET_OPEN = 1;
2
+ import { broadcastBrowserInternals } from "@holo-js/broadcast/client-config";
3
3
  function normalizeRequiredString(value, label) {
4
4
  const normalized = value.trim();
5
5
  if (!normalized) {
@@ -13,6 +13,17 @@ function toReadonlyArray(value) {
13
13
  function presenceMemberKey(member) {
14
14
  return JSON.stringify(member) ?? String(member);
15
15
  }
16
+ function appendPresenceMember(members, member) {
17
+ return Object.freeze([...members, member]);
18
+ }
19
+ function removePresenceMember(members, member) {
20
+ const key = presenceMemberKey(member);
21
+ const index = members.findIndex((candidate) => Object.is(candidate, member) || presenceMemberKey(candidate) === key);
22
+ if (index === -1) {
23
+ return members;
24
+ }
25
+ return Object.freeze(members.filter((_, candidateIndex) => candidateIndex !== index));
26
+ }
16
27
  function presenceMemberDiff(previousMembers, nextMembers) {
17
28
  const previousCounts = /* @__PURE__ */ new Map();
18
29
  const nextCounts = /* @__PURE__ */ new Map();
@@ -275,19 +286,8 @@ function hasExplicitHoloWebSocketConnectorOptions(options) {
275
286
  }
276
287
  async function resolveHoloWebSocketConnectorOptions(options, globals) {
277
288
  try {
278
- const response = await globals.fetch(options.configEndpoint ?? "/broadcasting/config", {
279
- headers: {
280
- accept: "application/json"
281
- },
282
- credentials: "same-origin"
283
- });
284
- if (!response.ok) {
285
- return options;
286
- }
287
- return mergeHoloWebSocketConnectorOptions(
288
- normalizeHoloWebSocketConnectorConfig(await response.json()),
289
- options
290
- );
289
+ const config = await broadcastBrowserInternals.discoverConfig(globals.fetch, options.configEndpoint ?? "/broadcasting/config");
290
+ return mergeHoloWebSocketConnectorOptions(normalizeHoloWebSocketConnectorConfig(config), options);
291
291
  } catch {
292
292
  return options;
293
293
  }
@@ -330,8 +330,7 @@ function createHoloWebSocketConnector(options = {}) {
330
330
  const channels = /* @__PURE__ */ new Map();
331
331
  const statusListeners = /* @__PURE__ */ new Set();
332
332
  let status = "idle";
333
- let socket;
334
- let connecting;
333
+ let connection;
335
334
  let resolvedOptions;
336
335
  let socketId;
337
336
  const setStatus = (next) => {
@@ -342,8 +341,8 @@ function createHoloWebSocketConnector(options = {}) {
342
341
  notifyStatusListeners(statusListeners, status);
343
342
  };
344
343
  const sendMessage = (message) => {
345
- if (socket?.readyState === WEB_SOCKET_OPEN) {
346
- socket.send(JSON.stringify(message));
344
+ if (connection?.socket) {
345
+ connection.socket.send(JSON.stringify(message));
347
346
  }
348
347
  };
349
348
  const authorizeSubscription = async (state) => {
@@ -441,7 +440,7 @@ function createHoloWebSocketConnector(options = {}) {
441
440
  }
442
441
  if (eventName === "pusher_internal:member_added") {
443
442
  const member = parseWireData(payload.member);
444
- state.members = Object.freeze([...state.members, member]);
443
+ state.members = appendPresenceMember(state.members, member);
445
444
  for (const callback of state.memberListeners) {
446
445
  callback(state.members);
447
446
  }
@@ -473,49 +472,43 @@ function createHoloWebSocketConnector(options = {}) {
473
472
  if (!WebSocketConstructor || !canDiscoverHoloWebSocketConnectorOptions(globals) && !hasExplicitHoloWebSocketConnectorOptions(options)) {
474
473
  return;
475
474
  }
476
- if (socket?.readyState === WEB_SOCKET_OPEN) {
475
+ if (connection?.socket) {
477
476
  flushSubscriptions();
478
477
  return;
479
478
  }
480
- if (connecting) {
481
- await connecting;
482
- return;
483
- }
484
- resolvedOptions = canDiscoverHoloWebSocketConnectorOptions(globals) ? await resolveHoloWebSocketConnectorOptions(options, globals) : options;
485
- const scheme = resolveWebSocketScheme(resolvedOptions.scheme, globals);
486
- const host = resolveBrowserHost(resolvedOptions.host, globals);
487
- const port = resolvedOptions.port ?? 8080;
488
- const path = resolvedOptions.path?.trim() || "/app";
489
- const key = resolvedOptions.key?.trim() || "app-key";
490
- const normalizedPath = `/${path.replace(/^\/+|\/+$/g, "")}`;
491
- const url = `${scheme}://${host}:${port}${normalizedPath}/${encodeURIComponent(key)}`;
492
- setStatus("connecting");
493
- connecting = new Promise((resolve, reject) => {
494
- const nextSocket = new WebSocketConstructor(url);
495
- socket = nextSocket;
496
- nextSocket.addEventListener("open", () => {
479
+ connection ??= broadcastBrowserInternals.createConnection({
480
+ WebSocket: WebSocketConstructor,
481
+ failureMessage: "[@holo-js/flux] WebSocket connection failed.",
482
+ resolveUrl() {
483
+ const format = (config) => ({
484
+ url: broadcastBrowserInternals.formatUrl({
485
+ scheme: resolveWebSocketScheme(config.scheme, globals),
486
+ host: resolveBrowserHost(config.host, globals),
487
+ port: config.port ?? 8080,
488
+ path: config.path?.trim() || "/app",
489
+ key: config.key?.trim() || "app-key"
490
+ }),
491
+ activate() {
492
+ resolvedOptions = config;
493
+ }
494
+ });
495
+ return canDiscoverHoloWebSocketConnectorOptions(globals) ? resolveHoloWebSocketConnectorOptions(options, globals).then(format) : format(options);
496
+ },
497
+ onOpen() {
497
498
  setStatus("connected");
498
499
  flushSubscriptions();
499
- resolve();
500
- });
501
- nextSocket.addEventListener("message", handleMessage);
502
- nextSocket.addEventListener("close", () => {
503
- socket = void 0;
504
- connecting = void 0;
500
+ },
501
+ onMessage: handleMessage,
502
+ onDisconnect() {
503
+ socketId = void 0;
505
504
  for (const state of channels.values()) {
506
505
  state.subscribed = false;
507
506
  }
508
507
  setStatus("disconnected");
509
- });
510
- nextSocket.addEventListener("error", () => {
511
- connecting = void 0;
512
- setStatus("disconnected");
513
- reject(new Error("[@holo-js/flux] WebSocket connection failed."));
514
- });
515
- }).finally(() => {
516
- connecting = void 0;
508
+ }
517
509
  });
518
- await connecting;
510
+ setStatus("connecting");
511
+ await connection.connect();
519
512
  };
520
513
  const ensureChannel = (name, kind) => {
521
514
  const key = `${kind}:${name}`;
@@ -541,9 +534,8 @@ function createHoloWebSocketConnector(options = {}) {
541
534
  await ensureConnected();
542
535
  },
543
536
  async disconnect() {
544
- socket?.close();
545
- socket = void 0;
546
- connecting = void 0;
537
+ connection?.disconnect();
538
+ socketId = void 0;
547
539
  channels.clear();
548
540
  setStatus("disconnected");
549
541
  },
@@ -874,6 +866,8 @@ var flux = new Proxy({}, {
874
866
  }
875
867
  });
876
868
  var fluxInternals = {
869
+ appendPresenceMember,
870
+ removePresenceMember,
877
871
  createHoloWebSocketConnector,
878
872
  createUnavailableConnector,
879
873
  createPusherConnector,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@holo-js/flux",
3
- "version": "0.3.15",
3
+ "version": "0.3.17",
4
4
  "description": "Holo-JS Framework - framework-agnostic realtime client skeleton for broadcast and presence",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -23,7 +23,7 @@
23
23
  "test": "vitest --run"
24
24
  },
25
25
  "dependencies": {
26
- "@holo-js/broadcast": "^0.3.15"
26
+ "@holo-js/broadcast": "^0.3.17"
27
27
  },
28
28
  "devDependencies": {
29
29
  "@types/node": "^22.10.2",
@@ -32,6 +32,6 @@
32
32
  "vitest": "^4.1.5"
33
33
  },
34
34
  "engines": {
35
- "node": ">=22.12.0"
35
+ "node": "^22.12.0 || ^24.0.0 || ^26.0.0"
36
36
  }
37
37
  }