@tanstack/query-broadcast-client-experimental 5.101.4 → 5.102.0

package/build/modern/index.cjs

@@ -1,122 +1,98 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  broadcastQueryClient: () => broadcastQueryClient
-});
-module.exports = __toCommonJS(index_exports);
-var import_broadcast_channel = require("broadcast-channel");
-function broadcastQueryClient({
-  queryClient,
-  broadcastChannel = "tanstack-query",
-  options
-}) {
-  let transaction = false;
-  const tx = (cb) => {
-    transaction = true;
-    cb();
-    transaction = false;
-  };
-  const channel = new import_broadcast_channel.BroadcastChannel(broadcastChannel, {
-    webWorkerSupport: false,
-    ...options
-  });
-  const queryCache = queryClient.getQueryCache();
-  const unsubscribe = queryClient.getQueryCache().subscribe((queryEvent) => {
-    if (transaction) {
-      return;
-    }
-    const {
-      query: { queryHash, queryKey, state, observers }
-    } = queryEvent;
-    if (queryEvent.type === "updated" && queryEvent.action.type === "success") {
-      channel.postMessage({
-        type: "updated",
-        queryHash,
-        queryKey,
-        state
-      });
-    }
-    if (queryEvent.type === "removed" && observers.length > 0) {
-      channel.postMessage({
-        type: "removed",
-        queryHash,
-        queryKey
-      });
-    }
-    if (queryEvent.type === "added") {
-      channel.postMessage({
-        type: "added",
-        queryHash,
-        queryKey
-      });
-    }
-  });
-  channel.onmessage = (action) => {
-    if (!action?.type) {
-      return;
-    }
-    tx(() => {
-      const { type, queryHash, queryKey, state } = action;
-      const query = queryCache.get(queryHash);
-      if (type === "updated") {
-        if (query) {
-          query.setState(state);
-          return;
-        }
-        queryCache.build(
-          queryClient,
-          {
-            queryKey,
-            queryHash
-          },
-          state
-        );
-      } else if (type === "removed") {
-        if (query) {
-          queryCache.remove(query);
-        }
-      } else if (type === "added") {
-        if (query) {
-          query.setState(state);
-          return;
-        }
-        queryCache.build(
-          queryClient,
-          {
-            queryKey,
-            queryHash
-          },
-          state
-        );
-      }
-    });
-  };
-  return () => {
-    unsubscribe();
-    channel.close();
-  };
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let broadcast_channel = require("broadcast-channel");
+//#region src/index.ts
+function broadcastQueryClient({ queryClient, broadcastChannel = "tanstack-query", options, onBroadcastError }) {
+	let transaction = false;
+	const tx = (cb) => {
+		transaction = true;
+		try {
+			cb();
+		} finally {
+			transaction = false;
+		}
+	};
+	const channel = new broadcast_channel.BroadcastChannel(broadcastChannel, {
+		webWorkerSupport: false,
+		...options
+	});
+	const queryCache = queryClient.getQueryCache();
+	const safePost = (message) => {
+		channel.postMessage(message).catch((error) => {
+			const event = {
+				type: message.type,
+				queryHash: message.queryHash,
+				queryKey: message.queryKey
+			};
+			if (onBroadcastError) {
+				const warnCallbackError = (callbackError) => {
+					if (process.env.NODE_ENV !== "production") console.warn(`[broadcastQueryClient] onBroadcastError threw while handling "${event.type}" for query ${event.queryHash}.`, callbackError);
+				};
+				let result;
+				try {
+					result = onBroadcastError(error, event);
+				} catch (callbackError) {
+					warnCallbackError(callbackError);
+					return;
+				}
+				result?.catch(warnCallbackError);
+			} else if (process.env.NODE_ENV !== "production") console.warn(`[broadcastQueryClient] Failed to broadcast "${event.type}" event for query ${event.queryHash}. The query value could not be structured-cloned; cross-tab sync for this query was skipped.`, error);
+		});
+	};
+	const unsubscribe = queryCache.subscribe((queryEvent) => {
+		if (transaction) return;
+		const { query: { queryHash, queryKey, state, observers } } = queryEvent;
+		if (queryEvent.type === "updated" && queryEvent.action.type === "success") safePost({
+			type: "updated",
+			queryHash,
+			queryKey,
+			state
+		});
+		if (queryEvent.type === "removed" && observers.length > 0) safePost({
+			type: "removed",
+			queryHash,
+			queryKey
+		});
+		if (queryEvent.type === "added") safePost({
+			type: "added",
+			queryHash,
+			queryKey,
+			state
+		});
+	});
+	channel.onmessage = (action) => {
+		if (!action?.type) return;
+		tx(() => {
+			const { type, queryHash, queryKey, state } = action;
+			const query = queryCache.get(queryHash);
+			if (type === "updated") {
+				if (query) {
+					query.setState(state);
+					return;
+				}
+				queryCache.build(queryClient, {
+					queryKey,
+					queryHash
+				}, state);
+			} else if (type === "removed") {
+				if (query) queryCache.remove(query);
+			} else if (type === "added") {
+				if (query) {
+					query.setState(state);
+					return;
+				}
+				queryCache.build(queryClient, {
+					queryKey,
+					queryHash
+				}, state);
+			}
+		});
+	};
+	return () => {
+		unsubscribe();
+		channel.close();
+	};
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  broadcastQueryClient
-});
+//#endregion
+exports.broadcastQueryClient = broadcastQueryClient;
+
 //# sourceMappingURL=index.cjs.map

package/build/modern/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { BroadcastChannel } from 'broadcast-channel'\nimport type { BroadcastChannelOptions } from 'broadcast-channel'\nimport type { QueryClient } from '@tanstack/query-core'\n\ninterface BroadcastQueryClientOptions {\n  queryClient: QueryClient\n  broadcastChannel?: string\n  options?: BroadcastChannelOptions\n}\n\nexport function broadcastQueryClient({\n  queryClient,\n  broadcastChannel = 'tanstack-query',\n  options,\n}: BroadcastQueryClientOptions): () => void {\n  let transaction = false\n  const tx = (cb: () => void) => {\n    transaction = true\n    cb()\n    transaction = false\n  }\n\n  const channel = new BroadcastChannel(broadcastChannel, {\n    webWorkerSupport: false,\n    ...options,\n  })\n\n  const queryCache = queryClient.getQueryCache()\n\n  const unsubscribe = queryClient.getQueryCache().subscribe((queryEvent) => {\n    if (transaction) {\n      return\n    }\n\n    const {\n      query: { queryHash, queryKey, state, observers },\n    } = queryEvent\n\n    if (queryEvent.type === 'updated' && queryEvent.action.type === 'success') {\n      channel.postMessage({\n        type: 'updated',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n\n    if (queryEvent.type === 'removed' && observers.length > 0) {\n      channel.postMessage({\n        type: 'removed',\n        queryHash,\n        queryKey,\n      })\n    }\n\n    if (queryEvent.type === 'added') {\n      channel.postMessage({\n        type: 'added',\n        queryHash,\n        queryKey,\n      })\n    }\n  })\n\n  channel.onmessage = (action) => {\n    if (!action?.type) {\n      return\n    }\n\n    tx(() => {\n      const { type, queryHash, queryKey, state } = action\n\n      const query = queryCache.get(queryHash)\n\n      if (type === 'updated') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      } else if (type === 'removed') {\n        if (query) {\n          queryCache.remove(query)\n        }\n      } else if (type === 'added') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      }\n    })\n  }\n  return () => {\n    unsubscribe()\n    channel.close()\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+BAAiC;AAU1B,SAAS,qBAAqB;AAAA,EACnC;AAAA,EACA,mBAAmB;AAAA,EACnB;AACF,GAA4C;AAC1C,MAAI,cAAc;AAClB,QAAM,KAAK,CAAC,OAAmB;AAC7B,kBAAc;AACd,OAAG;AACH,kBAAc;AAAA,EAChB;AAEA,QAAM,UAAU,IAAI,0CAAiB,kBAAkB;AAAA,IACrD,kBAAkB;AAAA,IAClB,GAAG;AAAA,EACL,CAAC;AAED,QAAM,aAAa,YAAY,cAAc;AAE7C,QAAM,cAAc,YAAY,cAAc,EAAE,UAAU,CAAC,eAAe;AACxE,QAAI,aAAa;AACf;AAAA,IACF;AAEA,UAAM;AAAA,MACJ,OAAO,EAAE,WAAW,UAAU,OAAO,UAAU;AAAA,IACjD,IAAI;AAEJ,QAAI,WAAW,SAAS,aAAa,WAAW,OAAO,SAAS,WAAW;AACzE,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,WAAW,SAAS,aAAa,UAAU,SAAS,GAAG;AACzD,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,WAAW,SAAS,SAAS;AAC/B,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAED,UAAQ,YAAY,CAAC,WAAW;AAC9B,QAAI,CAAC,QAAQ,MAAM;AACjB;AAAA,IACF;AAEA,OAAG,MAAM;AACP,YAAM,EAAE,MAAM,WAAW,UAAU,MAAM,IAAI;AAE7C,YAAM,QAAQ,WAAW,IAAI,SAAS;AAEtC,UAAI,SAAS,WAAW;AACtB,YAAI,OAAO;AACT,gBAAM,SAAS,KAAK;AACpB;AAAA,QACF;AAEA,mBAAW;AAAA,UACT;AAAA,UACA;AAAA,YACE;AAAA,YACA;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF,WAAW,SAAS,WAAW;AAC7B,YAAI,OAAO;AACT,qBAAW,OAAO,KAAK;AAAA,QACzB;AAAA,MACF,WAAW,SAAS,SAAS;AAC3B,YAAI,OAAO;AACT,gBAAM,SAAS,KAAK;AACpB;AAAA,QACF;AACA,mBAAW;AAAA,UACT;AAAA,UACA;AAAA,YACE;AAAA,YACA;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO,MAAM;AACX,gBAAY;AACZ,YAAQ,MAAM;AAAA,EAChB;AACF;","names":[]}
+{"version":3,"file":"index.cjs","names":["BroadcastChannel"],"sources":["../../src/index.ts"],"sourcesContent":["import { BroadcastChannel } from 'broadcast-channel'\nimport type { BroadcastChannelOptions } from 'broadcast-channel'\nimport type { QueryClient, QueryKey } from '@tanstack/query-core'\n\n/**\n * Metadata describing a broadcast that failed to be delivered to other tabs.\n * Passed to {@link BroadcastQueryClientOptions.onBroadcastError} so callers\n * can correlate failures with the originating query.\n */\nexport interface BroadcastErrorEvent {\n  type: 'updated' | 'removed' | 'added'\n  queryHash: string\n  queryKey: QueryKey\n}\n\ntype BroadcastMessage =\n  | { type: 'updated'; queryHash: string; queryKey: QueryKey; state: unknown }\n  | { type: 'removed'; queryHash: string; queryKey: QueryKey }\n  | { type: 'added'; queryHash: string; queryKey: QueryKey; state: unknown }\n\ninterface BroadcastQueryClientOptions {\n  /** The QueryClient to sync. */\n  queryClient: QueryClient\n  /**\n   * Unique channel name used to communicate between tabs and windows.\n   * @default 'tanstack-query'\n   */\n  broadcastChannel?: string\n  /** Options forwarded to the underlying `BroadcastChannel`. */\n  options?: BroadcastChannelOptions\n  /**\n   * Called when a query event fails to broadcast to other tabs — most\n   * commonly because the query's `state.data`, `state.error`, or `queryKey`\n   * contains a value the structured-clone algorithm cannot serialize\n   * (e.g. `ReadableStream`, `File`, functions, Vue `reactive` proxies).\n   *\n   * Provide this to route failures to an error tracker. If omitted, a\n   * `console.warn` is emitted in development so failures are never silent.\n   *\n   * May return a `Promise`; any rejection is caught internally so it cannot\n   * cause a secondary unhandled rejection.\n   */\n  onBroadcastError?: (\n    error: unknown,\n    event: BroadcastErrorEvent,\n  ) => void | Promise<void>\n}\n\nexport function broadcastQueryClient({\n  queryClient,\n  broadcastChannel = 'tanstack-query',\n  options,\n  onBroadcastError,\n}: BroadcastQueryClientOptions): () => void {\n  let transaction = false\n  const tx = (cb: () => void) => {\n    transaction = true\n    try {\n      cb()\n    } finally {\n      // Guard against `cb` throwing (e.g. `query.setState`/`queryCache.build`\n      // triggering a listener that throws while applying an incoming\n      // cross-tab message). Without this, `transaction` would stay `true`\n      // forever, silently disabling this tab's own broadcasts to other tabs\n      // for the rest of the session.\n      transaction = false\n    }\n  }\n\n  const channel = new BroadcastChannel(broadcastChannel, {\n    webWorkerSupport: false,\n    ...options,\n  })\n\n  const queryCache = queryClient.getQueryCache()\n\n  const safePost = (message: BroadcastMessage): void => {\n    channel.postMessage(message).catch((error: unknown) => {\n      const event: BroadcastErrorEvent = {\n        type: message.type,\n        queryHash: message.queryHash,\n        queryKey: message.queryKey,\n      }\n\n      if (onBroadcastError) {\n        const warnCallbackError = (callbackError: unknown) => {\n          if (process.env.NODE_ENV !== 'production') {\n            console.warn(\n              `[broadcastQueryClient] onBroadcastError threw while handling \"${event.type}\" for query ${event.queryHash}.`,\n              callbackError,\n            )\n          }\n        }\n        let result: void | Promise<void>\n        try {\n          result = onBroadcastError(error, event)\n        } catch (callbackError) {\n          warnCallbackError(callbackError)\n          return\n        }\n        result?.catch(warnCallbackError)\n      } else if (process.env.NODE_ENV !== 'production') {\n        console.warn(\n          `[broadcastQueryClient] Failed to broadcast \"${event.type}\" event for query ${event.queryHash}. ` +\n            'The query value could not be structured-cloned; cross-tab sync for this query was skipped.',\n          error,\n        )\n      }\n    })\n  }\n\n  const unsubscribe = queryCache.subscribe((queryEvent) => {\n    if (transaction) {\n      return\n    }\n\n    const {\n      query: { queryHash, queryKey, state, observers },\n    } = queryEvent\n\n    if (queryEvent.type === 'updated' && queryEvent.action.type === 'success') {\n      safePost({\n        type: 'updated',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n\n    if (queryEvent.type === 'removed' && observers.length > 0) {\n      safePost({\n        type: 'removed',\n        queryHash,\n        queryKey,\n      })\n    }\n\n    if (queryEvent.type === 'added') {\n      safePost({\n        type: 'added',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n  })\n\n  channel.onmessage = (action) => {\n    if (!action?.type) {\n      return\n    }\n\n    tx(() => {\n      const { type, queryHash, queryKey, state } = action\n\n      const query = queryCache.get(queryHash)\n\n      if (type === 'updated') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      } else if (type === 'removed') {\n        if (query) {\n          queryCache.remove(query)\n        }\n      } else if (type === 'added') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      }\n    })\n  }\n  return () => {\n    unsubscribe()\n    channel.close()\n  }\n}\n"],"mappings":";;;AAgDA,SAAgB,qBAAqB,EACnC,aACA,mBAAmB,kBACnB,SACA,oBAC0C;CAC1C,IAAI,cAAc;CAClB,MAAM,MAAM,OAAmB;EAC7B,cAAc;EACd,IAAI;GACF,GAAG;EACL,UAAU;GAMR,cAAc;EAChB;CACF;CAEA,MAAM,UAAU,IAAIA,kBAAAA,iBAAiB,kBAAkB;EACrD,kBAAkB;EAClB,GAAG;CACL,CAAC;CAED,MAAM,aAAa,YAAY,cAAc;CAE7C,MAAM,YAAY,YAAoC;EACpD,QAAQ,YAAY,OAAO,CAAC,CAAC,OAAO,UAAmB;GACrD,MAAM,QAA6B;IACjC,MAAM,QAAQ;IACd,WAAW,QAAQ;IACnB,UAAU,QAAQ;GACpB;GAEA,IAAI,kBAAkB;IACpB,MAAM,qBAAqB,kBAA2B;KACpD,IAAI,QAAQ,IAAI,aAAa,cAC3B,QAAQ,KACN,iEAAiE,MAAM,KAAK,cAAc,MAAM,UAAU,IAC1G,aACF;IAEJ;IACA,IAAI;IACJ,IAAI;KACF,SAAS,iBAAiB,OAAO,KAAK;IACxC,SAAS,eAAe;KACtB,kBAAkB,aAAa;KAC/B;IACF;IACA,QAAQ,MAAM,iBAAiB;GACjC,OAAO,IAAI,QAAQ,IAAI,aAAa,cAClC,QAAQ,KACN,+CAA+C,MAAM,KAAK,oBAAoB,MAAM,UAAU,+FAE9F,KACF;EAEJ,CAAC;CACH;CAEA,MAAM,cAAc,WAAW,WAAW,eAAe;EACvD,IAAI,aACF;EAGF,MAAM,EACJ,OAAO,EAAE,WAAW,UAAU,OAAO,gBACnC;EAEJ,IAAI,WAAW,SAAS,aAAa,WAAW,OAAO,SAAS,WAC9D,SAAS;GACP,MAAM;GACN;GACA;GACA;EACF,CAAC;EAGH,IAAI,WAAW,SAAS,aAAa,UAAU,SAAS,GACtD,SAAS;GACP,MAAM;GACN;GACA;EACF,CAAC;EAGH,IAAI,WAAW,SAAS,SACtB,SAAS;GACP,MAAM;GACN;GACA;GACA;EACF,CAAC;CAEL,CAAC;CAED,QAAQ,aAAa,WAAW;EAC9B,IAAI,CAAC,QAAQ,MACX;EAGF,SAAS;GACP,MAAM,EAAE,MAAM,WAAW,UAAU,UAAU;GAE7C,MAAM,QAAQ,WAAW,IAAI,SAAS;GAEtC,IAAI,SAAS,WAAW;IACtB,IAAI,OAAO;KACT,MAAM,SAAS,KAAK;KACpB;IACF;IAEA,WAAW,MACT,aACA;KACE;KACA;IACF,GACA,KACF;GACF,OAAO,IAAI,SAAS,WACd;QAAA,OACF,WAAW,OAAO,KAAK;GAAA,OAEpB,IAAI,SAAS,SAAS;IAC3B,IAAI,OAAO;KACT,MAAM,SAAS,KAAK;KACpB;IACF;IACA,WAAW,MACT,aACA;KACE;KACA;IACF,GACA,KACF;GACF;EACF,CAAC;CACH;CACA,aAAa;EACX,YAAY;EACZ,QAAQ,MAAM;CAChB;AACF"}

package/build/modern/index.d.cts

@@ -1 +1,41 @@
-export { broadcastQueryClient } from './_tsup-dts-rollup.cjs';
+import { BroadcastChannelOptions } from "broadcast-channel";
+import { QueryClient, QueryKey } from "@tanstack/query-core";
+//#region src/index.d.ts
+/**
+ * Metadata describing a broadcast that failed to be delivered to other tabs.
+ * Passed to {@link BroadcastQueryClientOptions.onBroadcastError} so callers
+ * can correlate failures with the originating query.
+ */
+interface BroadcastErrorEvent {
+  type: 'updated' | 'removed' | 'added';
+  queryHash: string;
+  queryKey: QueryKey;
+}
+interface BroadcastQueryClientOptions {
+  /** The QueryClient to sync. */
+  queryClient: QueryClient;
+  /**
+   * Unique channel name used to communicate between tabs and windows.
+   * @default 'tanstack-query'
+   */
+  broadcastChannel?: string;
+  /** Options forwarded to the underlying `BroadcastChannel`. */
+  options?: BroadcastChannelOptions;
+  /**
+   * Called when a query event fails to broadcast to other tabs — most
+   * commonly because the query's `state.data`, `state.error`, or `queryKey`
+   * contains a value the structured-clone algorithm cannot serialize
+   * (e.g. `ReadableStream`, `File`, functions, Vue `reactive` proxies).
+   *
+   * Provide this to route failures to an error tracker. If omitted, a
+   * `console.warn` is emitted in development so failures are never silent.
+   *
+   * May return a `Promise`; any rejection is caught internally so it cannot
+   * cause a secondary unhandled rejection.
+   */
+  onBroadcastError?: (error: unknown, event: BroadcastErrorEvent) => void | Promise<void>;
+}
+declare function broadcastQueryClient({ queryClient, broadcastChannel, options, onBroadcastError }: BroadcastQueryClientOptions): () => void;
+//#endregion
+export { BroadcastErrorEvent, broadcastQueryClient };
+//# sourceMappingURL=index.d.cts.map

package/build/modern/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/index.ts"],"mappings":";;;;;;;;UASiB;EACf;EACA;EACA,UAAU;;UAQF;;EAER,aAAa;;;;;EAKb;;EAEA,UAAU;;;;;;;;;;;;;EAaV,oBACE,gBACA,OAAO,+BACG;;iBAGE,uBACd,aACA,kBACA,SACA,oBACC"}

package/build/modern/index.d.ts

@@ -1 +1,41 @@
-export { broadcastQueryClient } from './_tsup-dts-rollup.js';
+import { BroadcastChannelOptions } from "broadcast-channel";
+import { QueryClient, QueryKey } from "@tanstack/query-core";
+//#region src/index.d.ts
+/**
+ * Metadata describing a broadcast that failed to be delivered to other tabs.
+ * Passed to {@link BroadcastQueryClientOptions.onBroadcastError} so callers
+ * can correlate failures with the originating query.
+ */
+interface BroadcastErrorEvent {
+  type: 'updated' | 'removed' | 'added';
+  queryHash: string;
+  queryKey: QueryKey;
+}
+interface BroadcastQueryClientOptions {
+  /** The QueryClient to sync. */
+  queryClient: QueryClient;
+  /**
+   * Unique channel name used to communicate between tabs and windows.
+   * @default 'tanstack-query'
+   */
+  broadcastChannel?: string;
+  /** Options forwarded to the underlying `BroadcastChannel`. */
+  options?: BroadcastChannelOptions;
+  /**
+   * Called when a query event fails to broadcast to other tabs — most
+   * commonly because the query's `state.data`, `state.error`, or `queryKey`
+   * contains a value the structured-clone algorithm cannot serialize
+   * (e.g. `ReadableStream`, `File`, functions, Vue `reactive` proxies).
+   *
+   * Provide this to route failures to an error tracker. If omitted, a
+   * `console.warn` is emitted in development so failures are never silent.
+   *
+   * May return a `Promise`; any rejection is caught internally so it cannot
+   * cause a secondary unhandled rejection.
+   */
+  onBroadcastError?: (error: unknown, event: BroadcastErrorEvent) => void | Promise<void>;
+}
+declare function broadcastQueryClient({ queryClient, broadcastChannel, options, onBroadcastError }: BroadcastQueryClientOptions): () => void;
+//#endregion
+export { BroadcastErrorEvent, broadcastQueryClient };
+//# sourceMappingURL=index.d.ts.map

package/build/modern/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/index.ts"],"mappings":";;;;;;;;UASiB;EACf;EACA;EACA,UAAU;;UAQF;;EAER,aAAa;;;;;EAKb;;EAEA,UAAU;;;;;;;;;;;;;EAaV,oBACE,gBACA,OAAO,+BACG;;iBAGE,uBACd,aACA,kBACA,SACA,oBACC"}

package/build/modern/index.js

@@ -1,97 +1,97 @@
-// src/index.ts
 import { BroadcastChannel } from "broadcast-channel";
-function broadcastQueryClient({
-  queryClient,
-  broadcastChannel = "tanstack-query",
-  options
-}) {
-  let transaction = false;
-  const tx = (cb) => {
-    transaction = true;
-    cb();
-    transaction = false;
-  };
-  const channel = new BroadcastChannel(broadcastChannel, {
-    webWorkerSupport: false,
-    ...options
-  });
-  const queryCache = queryClient.getQueryCache();
-  const unsubscribe = queryClient.getQueryCache().subscribe((queryEvent) => {
-    if (transaction) {
-      return;
-    }
-    const {
-      query: { queryHash, queryKey, state, observers }
-    } = queryEvent;
-    if (queryEvent.type === "updated" && queryEvent.action.type === "success") {
-      channel.postMessage({
-        type: "updated",
-        queryHash,
-        queryKey,
-        state
-      });
-    }
-    if (queryEvent.type === "removed" && observers.length > 0) {
-      channel.postMessage({
-        type: "removed",
-        queryHash,
-        queryKey
-      });
-    }
-    if (queryEvent.type === "added") {
-      channel.postMessage({
-        type: "added",
-        queryHash,
-        queryKey
-      });
-    }
-  });
-  channel.onmessage = (action) => {
-    if (!action?.type) {
-      return;
-    }
-    tx(() => {
-      const { type, queryHash, queryKey, state } = action;
-      const query = queryCache.get(queryHash);
-      if (type === "updated") {
-        if (query) {
-          query.setState(state);
-          return;
-        }
-        queryCache.build(
-          queryClient,
-          {
-            queryKey,
-            queryHash
-          },
-          state
-        );
-      } else if (type === "removed") {
-        if (query) {
-          queryCache.remove(query);
-        }
-      } else if (type === "added") {
-        if (query) {
-          query.setState(state);
-          return;
-        }
-        queryCache.build(
-          queryClient,
-          {
-            queryKey,
-            queryHash
-          },
-          state
-        );
-      }
-    });
-  };
-  return () => {
-    unsubscribe();
-    channel.close();
-  };
+//#region src/index.ts
+function broadcastQueryClient({ queryClient, broadcastChannel = "tanstack-query", options, onBroadcastError }) {
+	let transaction = false;
+	const tx = (cb) => {
+		transaction = true;
+		try {
+			cb();
+		} finally {
+			transaction = false;
+		}
+	};
+	const channel = new BroadcastChannel(broadcastChannel, {
+		webWorkerSupport: false,
+		...options
+	});
+	const queryCache = queryClient.getQueryCache();
+	const safePost = (message) => {
+		channel.postMessage(message).catch((error) => {
+			const event = {
+				type: message.type,
+				queryHash: message.queryHash,
+				queryKey: message.queryKey
+			};
+			if (onBroadcastError) {
+				const warnCallbackError = (callbackError) => {
+					if (process.env.NODE_ENV !== "production") console.warn(`[broadcastQueryClient] onBroadcastError threw while handling "${event.type}" for query ${event.queryHash}.`, callbackError);
+				};
+				let result;
+				try {
+					result = onBroadcastError(error, event);
+				} catch (callbackError) {
+					warnCallbackError(callbackError);
+					return;
+				}
+				result?.catch(warnCallbackError);
+			} else if (process.env.NODE_ENV !== "production") console.warn(`[broadcastQueryClient] Failed to broadcast "${event.type}" event for query ${event.queryHash}. The query value could not be structured-cloned; cross-tab sync for this query was skipped.`, error);
+		});
+	};
+	const unsubscribe = queryCache.subscribe((queryEvent) => {
+		if (transaction) return;
+		const { query: { queryHash, queryKey, state, observers } } = queryEvent;
+		if (queryEvent.type === "updated" && queryEvent.action.type === "success") safePost({
+			type: "updated",
+			queryHash,
+			queryKey,
+			state
+		});
+		if (queryEvent.type === "removed" && observers.length > 0) safePost({
+			type: "removed",
+			queryHash,
+			queryKey
+		});
+		if (queryEvent.type === "added") safePost({
+			type: "added",
+			queryHash,
+			queryKey,
+			state
+		});
+	});
+	channel.onmessage = (action) => {
+		if (!action?.type) return;
+		tx(() => {
+			const { type, queryHash, queryKey, state } = action;
+			const query = queryCache.get(queryHash);
+			if (type === "updated") {
+				if (query) {
+					query.setState(state);
+					return;
+				}
+				queryCache.build(queryClient, {
+					queryKey,
+					queryHash
+				}, state);
+			} else if (type === "removed") {
+				if (query) queryCache.remove(query);
+			} else if (type === "added") {
+				if (query) {
+					query.setState(state);
+					return;
+				}
+				queryCache.build(queryClient, {
+					queryKey,
+					queryHash
+				}, state);
+			}
+		});
+	};
+	return () => {
+		unsubscribe();
+		channel.close();
+	};
 }
-export {
-  broadcastQueryClient
-};
+//#endregion
+export { broadcastQueryClient };
+
 //# sourceMappingURL=index.js.map

package/build/modern/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { BroadcastChannel } from 'broadcast-channel'\nimport type { BroadcastChannelOptions } from 'broadcast-channel'\nimport type { QueryClient } from '@tanstack/query-core'\n\ninterface BroadcastQueryClientOptions {\n  queryClient: QueryClient\n  broadcastChannel?: string\n  options?: BroadcastChannelOptions\n}\n\nexport function broadcastQueryClient({\n  queryClient,\n  broadcastChannel = 'tanstack-query',\n  options,\n}: BroadcastQueryClientOptions): () => void {\n  let transaction = false\n  const tx = (cb: () => void) => {\n    transaction = true\n    cb()\n    transaction = false\n  }\n\n  const channel = new BroadcastChannel(broadcastChannel, {\n    webWorkerSupport: false,\n    ...options,\n  })\n\n  const queryCache = queryClient.getQueryCache()\n\n  const unsubscribe = queryClient.getQueryCache().subscribe((queryEvent) => {\n    if (transaction) {\n      return\n    }\n\n    const {\n      query: { queryHash, queryKey, state, observers },\n    } = queryEvent\n\n    if (queryEvent.type === 'updated' && queryEvent.action.type === 'success') {\n      channel.postMessage({\n        type: 'updated',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n\n    if (queryEvent.type === 'removed' && observers.length > 0) {\n      channel.postMessage({\n        type: 'removed',\n        queryHash,\n        queryKey,\n      })\n    }\n\n    if (queryEvent.type === 'added') {\n      channel.postMessage({\n        type: 'added',\n        queryHash,\n        queryKey,\n      })\n    }\n  })\n\n  channel.onmessage = (action) => {\n    if (!action?.type) {\n      return\n    }\n\n    tx(() => {\n      const { type, queryHash, queryKey, state } = action\n\n      const query = queryCache.get(queryHash)\n\n      if (type === 'updated') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      } else if (type === 'removed') {\n        if (query) {\n          queryCache.remove(query)\n        }\n      } else if (type === 'added') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      }\n    })\n  }\n  return () => {\n    unsubscribe()\n    channel.close()\n  }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AAU1B,SAAS,qBAAqB;AAAA,EACnC;AAAA,EACA,mBAAmB;AAAA,EACnB;AACF,GAA4C;AAC1C,MAAI,cAAc;AAClB,QAAM,KAAK,CAAC,OAAmB;AAC7B,kBAAc;AACd,OAAG;AACH,kBAAc;AAAA,EAChB;AAEA,QAAM,UAAU,IAAI,iBAAiB,kBAAkB;AAAA,IACrD,kBAAkB;AAAA,IAClB,GAAG;AAAA,EACL,CAAC;AAED,QAAM,aAAa,YAAY,cAAc;AAE7C,QAAM,cAAc,YAAY,cAAc,EAAE,UAAU,CAAC,eAAe;AACxE,QAAI,aAAa;AACf;AAAA,IACF;AAEA,UAAM;AAAA,MACJ,OAAO,EAAE,WAAW,UAAU,OAAO,UAAU;AAAA,IACjD,IAAI;AAEJ,QAAI,WAAW,SAAS,aAAa,WAAW,OAAO,SAAS,WAAW;AACzE,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,WAAW,SAAS,aAAa,UAAU,SAAS,GAAG;AACzD,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,WAAW,SAAS,SAAS;AAC/B,cAAQ,YAAY;AAAA,QAClB,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAED,UAAQ,YAAY,CAAC,WAAW;AAC9B,QAAI,CAAC,QAAQ,MAAM;AACjB;AAAA,IACF;AAEA,OAAG,MAAM;AACP,YAAM,EAAE,MAAM,WAAW,UAAU,MAAM,IAAI;AAE7C,YAAM,QAAQ,WAAW,IAAI,SAAS;AAEtC,UAAI,SAAS,WAAW;AACtB,YAAI,OAAO;AACT,gBAAM,SAAS,KAAK;AACpB;AAAA,QACF;AAEA,mBAAW;AAAA,UACT;AAAA,UACA;AAAA,YACE;AAAA,YACA;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF,WAAW,SAAS,WAAW;AAC7B,YAAI,OAAO;AACT,qBAAW,OAAO,KAAK;AAAA,QACzB;AAAA,MACF,WAAW,SAAS,SAAS;AAC3B,YAAI,OAAO;AACT,gBAAM,SAAS,KAAK;AACpB;AAAA,QACF;AACA,mBAAW;AAAA,UACT;AAAA,UACA;AAAA,YACE;AAAA,YACA;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO,MAAM;AACX,gBAAY;AACZ,YAAQ,MAAM;AAAA,EAChB;AACF;","names":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["import { BroadcastChannel } from 'broadcast-channel'\nimport type { BroadcastChannelOptions } from 'broadcast-channel'\nimport type { QueryClient, QueryKey } from '@tanstack/query-core'\n\n/**\n * Metadata describing a broadcast that failed to be delivered to other tabs.\n * Passed to {@link BroadcastQueryClientOptions.onBroadcastError} so callers\n * can correlate failures with the originating query.\n */\nexport interface BroadcastErrorEvent {\n  type: 'updated' | 'removed' | 'added'\n  queryHash: string\n  queryKey: QueryKey\n}\n\ntype BroadcastMessage =\n  | { type: 'updated'; queryHash: string; queryKey: QueryKey; state: unknown }\n  | { type: 'removed'; queryHash: string; queryKey: QueryKey }\n  | { type: 'added'; queryHash: string; queryKey: QueryKey; state: unknown }\n\ninterface BroadcastQueryClientOptions {\n  /** The QueryClient to sync. */\n  queryClient: QueryClient\n  /**\n   * Unique channel name used to communicate between tabs and windows.\n   * @default 'tanstack-query'\n   */\n  broadcastChannel?: string\n  /** Options forwarded to the underlying `BroadcastChannel`. */\n  options?: BroadcastChannelOptions\n  /**\n   * Called when a query event fails to broadcast to other tabs — most\n   * commonly because the query's `state.data`, `state.error`, or `queryKey`\n   * contains a value the structured-clone algorithm cannot serialize\n   * (e.g. `ReadableStream`, `File`, functions, Vue `reactive` proxies).\n   *\n   * Provide this to route failures to an error tracker. If omitted, a\n   * `console.warn` is emitted in development so failures are never silent.\n   *\n   * May return a `Promise`; any rejection is caught internally so it cannot\n   * cause a secondary unhandled rejection.\n   */\n  onBroadcastError?: (\n    error: unknown,\n    event: BroadcastErrorEvent,\n  ) => void | Promise<void>\n}\n\nexport function broadcastQueryClient({\n  queryClient,\n  broadcastChannel = 'tanstack-query',\n  options,\n  onBroadcastError,\n}: BroadcastQueryClientOptions): () => void {\n  let transaction = false\n  const tx = (cb: () => void) => {\n    transaction = true\n    try {\n      cb()\n    } finally {\n      // Guard against `cb` throwing (e.g. `query.setState`/`queryCache.build`\n      // triggering a listener that throws while applying an incoming\n      // cross-tab message). Without this, `transaction` would stay `true`\n      // forever, silently disabling this tab's own broadcasts to other tabs\n      // for the rest of the session.\n      transaction = false\n    }\n  }\n\n  const channel = new BroadcastChannel(broadcastChannel, {\n    webWorkerSupport: false,\n    ...options,\n  })\n\n  const queryCache = queryClient.getQueryCache()\n\n  const safePost = (message: BroadcastMessage): void => {\n    channel.postMessage(message).catch((error: unknown) => {\n      const event: BroadcastErrorEvent = {\n        type: message.type,\n        queryHash: message.queryHash,\n        queryKey: message.queryKey,\n      }\n\n      if (onBroadcastError) {\n        const warnCallbackError = (callbackError: unknown) => {\n          if (process.env.NODE_ENV !== 'production') {\n            console.warn(\n              `[broadcastQueryClient] onBroadcastError threw while handling \"${event.type}\" for query ${event.queryHash}.`,\n              callbackError,\n            )\n          }\n        }\n        let result: void | Promise<void>\n        try {\n          result = onBroadcastError(error, event)\n        } catch (callbackError) {\n          warnCallbackError(callbackError)\n          return\n        }\n        result?.catch(warnCallbackError)\n      } else if (process.env.NODE_ENV !== 'production') {\n        console.warn(\n          `[broadcastQueryClient] Failed to broadcast \"${event.type}\" event for query ${event.queryHash}. ` +\n            'The query value could not be structured-cloned; cross-tab sync for this query was skipped.',\n          error,\n        )\n      }\n    })\n  }\n\n  const unsubscribe = queryCache.subscribe((queryEvent) => {\n    if (transaction) {\n      return\n    }\n\n    const {\n      query: { queryHash, queryKey, state, observers },\n    } = queryEvent\n\n    if (queryEvent.type === 'updated' && queryEvent.action.type === 'success') {\n      safePost({\n        type: 'updated',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n\n    if (queryEvent.type === 'removed' && observers.length > 0) {\n      safePost({\n        type: 'removed',\n        queryHash,\n        queryKey,\n      })\n    }\n\n    if (queryEvent.type === 'added') {\n      safePost({\n        type: 'added',\n        queryHash,\n        queryKey,\n        state,\n      })\n    }\n  })\n\n  channel.onmessage = (action) => {\n    if (!action?.type) {\n      return\n    }\n\n    tx(() => {\n      const { type, queryHash, queryKey, state } = action\n\n      const query = queryCache.get(queryHash)\n\n      if (type === 'updated') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      } else if (type === 'removed') {\n        if (query) {\n          queryCache.remove(query)\n        }\n      } else if (type === 'added') {\n        if (query) {\n          query.setState(state)\n          return\n        }\n        queryCache.build(\n          queryClient,\n          {\n            queryKey,\n            queryHash,\n          },\n          state,\n        )\n      }\n    })\n  }\n  return () => {\n    unsubscribe()\n    channel.close()\n  }\n}\n"],"mappings":";;AAgDA,SAAgB,qBAAqB,EACnC,aACA,mBAAmB,kBACnB,SACA,oBAC0C;CAC1C,IAAI,cAAc;CAClB,MAAM,MAAM,OAAmB;EAC7B,cAAc;EACd,IAAI;GACF,GAAG;EACL,UAAU;GAMR,cAAc;EAChB;CACF;CAEA,MAAM,UAAU,IAAI,iBAAiB,kBAAkB;EACrD,kBAAkB;EAClB,GAAG;CACL,CAAC;CAED,MAAM,aAAa,YAAY,cAAc;CAE7C,MAAM,YAAY,YAAoC;EACpD,QAAQ,YAAY,OAAO,CAAC,CAAC,OAAO,UAAmB;GACrD,MAAM,QAA6B;IACjC,MAAM,QAAQ;IACd,WAAW,QAAQ;IACnB,UAAU,QAAQ;GACpB;GAEA,IAAI,kBAAkB;IACpB,MAAM,qBAAqB,kBAA2B;KACpD,IAAI,QAAQ,IAAI,aAAa,cAC3B,QAAQ,KACN,iEAAiE,MAAM,KAAK,cAAc,MAAM,UAAU,IAC1G,aACF;IAEJ;IACA,IAAI;IACJ,IAAI;KACF,SAAS,iBAAiB,OAAO,KAAK;IACxC,SAAS,eAAe;KACtB,kBAAkB,aAAa;KAC/B;IACF;IACA,QAAQ,MAAM,iBAAiB;GACjC,OAAO,IAAI,QAAQ,IAAI,aAAa,cAClC,QAAQ,KACN,+CAA+C,MAAM,KAAK,oBAAoB,MAAM,UAAU,+FAE9F,KACF;EAEJ,CAAC;CACH;CAEA,MAAM,cAAc,WAAW,WAAW,eAAe;EACvD,IAAI,aACF;EAGF,MAAM,EACJ,OAAO,EAAE,WAAW,UAAU,OAAO,gBACnC;EAEJ,IAAI,WAAW,SAAS,aAAa,WAAW,OAAO,SAAS,WAC9D,SAAS;GACP,MAAM;GACN;GACA;GACA;EACF,CAAC;EAGH,IAAI,WAAW,SAAS,aAAa,UAAU,SAAS,GACtD,SAAS;GACP,MAAM;GACN;GACA;EACF,CAAC;EAGH,IAAI,WAAW,SAAS,SACtB,SAAS;GACP,MAAM;GACN;GACA;GACA;EACF,CAAC;CAEL,CAAC;CAED,QAAQ,aAAa,WAAW;EAC9B,IAAI,CAAC,QAAQ,MACX;EAGF,SAAS;GACP,MAAM,EAAE,MAAM,WAAW,UAAU,UAAU;GAE7C,MAAM,QAAQ,WAAW,IAAI,SAAS;GAEtC,IAAI,SAAS,WAAW;IACtB,IAAI,OAAO;KACT,MAAM,SAAS,KAAK;KACpB;IACF;IAEA,WAAW,MACT,aACA;KACE;KACA;IACF,GACA,KACF;GACF,OAAO,IAAI,SAAS,WACd;QAAA,OACF,WAAW,OAAO,KAAK;GAAA,OAEpB,IAAI,SAAS,SAAS;IAC3B,IAAI,OAAO;KACT,MAAM,SAAS,KAAK;KACpB;IACF;IACA,WAAW,MACT,aACA;KACE;KACA;IACF,GACA,KACF;GACF;EACF,CAAC;CACH;CACA,aAAa;EACX,YAAY;EACZ,QAAQ,MAAM;CAChB;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-broadcast-client-experimental",
-  "version": "5.101.4",
+  "version": "5.102.0",
   "description": "An experimental plugin to for broadcasting the state of your queryClient between browser tabs/windows",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -40,29 +40,28 @@
   ],
   "dependencies": {
     "broadcast-channel": "^7.0.0",
-    "@tanstack/query-core": "5.101.4"
+    "@tanstack/query-core": "5.102.0"
   },
   "devDependencies": {
     "@testing-library/react": "^16.1.0",
     "@vitejs/plugin-react": "^4.3.4",
-    "npm-run-all2": "^5.0.0"
+    "npm-run-all2": "^5.0.0",
+    "@tanstack/query-test-utils": "0.0.0"
   },
   "scripts": {
     "clean": "premove ./build ./coverage ./dist-ts",
     "compile": "tsc --build",
     "test:eslint": "eslint --concurrency=auto ./src",
     "test:types": "npm-run-all --serial test:types:*",
-    "test:types:ts54": "node ../../node_modules/typescript54/lib/tsc.js --build",
-    "test:types:ts55": "node ../../node_modules/typescript55/lib/tsc.js --build",
     "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --build",
     "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --build",
     "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js --build",
     "test:types:ts59": "node ../../node_modules/typescript59/lib/tsc.js --build",
     "test:types:tscurrent": "tsc --build",
-    "test:types:ts60": "node ../../node_modules/typescript60/lib/tsc.js --build",
+    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --build",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm run test:lib --watch",
     "test:build": "publint --strict && attw --pack",
-    "build": "tsup --tsconfig tsconfig.prod.json"
+    "build": "tsdown --tsconfig tsconfig.prod.json"
   }
 }