@tanstack/query-core 5.102.7 → 5.103.0

package/build/legacy/environmentManager.cjs

@@ -7,7 +7,21 @@ let isServerFn = () => require_utils.isServer;
 */
 const isServer = () => isServerFn();
 /**
-* Manages environment detection used by TanStack Query internals.
+* Manages how TanStack Query detects whether the current runtime should be treated as
+* server-side, which disables scheduling refetch timers and changes the default `retry` count
+* and `gcTime`. By default, the detection treats a missing `window` (or the presence of a
+* `Deno` global) as server.
+*
+* Override this for runtimes where that default detection would give the wrong answer — for
+* example, a Service Worker, where `window` is undefined even though the environment should
+* behave like a client.
+*
+* @example
+* ```ts
+* import { environmentManager } from '@tanstack/query-core'
+*
+* environmentManager.setIsServer(() => false)
+* ```
 */
 const environmentManager = {
 	isServer,

package/build/legacy/environmentManager.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"environmentManager.cjs","names":["defaultIsServer"],"sources":["../../src/environmentManager.ts"],"sourcesContent":["import { isServer as defaultIsServer } from './utils'\n\nexport type IsServerValue = () => boolean\n\nlet isServerFn: IsServerValue = () => defaultIsServer\n\n/**\n * Returns whether the current runtime should be treated as a server environment.\n */\nexport const isServer = (): boolean => isServerFn()\n\n/**\n * Manages environment detection used by TanStack Query internals.\n */\nexport const environmentManager = {\n  isServer,\n  /**\n   * Overrides the server check globally.\n   */\n  setIsServer(isServerValue: IsServerValue): void {\n    isServerFn = isServerValue\n  },\n}\n"],"mappings":";;;AAIA,IAAI,mBAAkCA,cAAAA;;;;AAKtC,MAAa,iBAA0B,WAAW;;;;AAKlD,MAAa,qBAAqB;CAChC;;;;CAIA,YAAY,eAAoC;EAC9C,aAAa;CACf;AACF"}
+{"version":3,"file":"environmentManager.cjs","names":["defaultIsServer"],"sources":["../../src/environmentManager.ts"],"sourcesContent":["import { isServer as defaultIsServer } from './utils'\n\nexport type IsServerValue = () => boolean\n\nlet isServerFn: IsServerValue = () => defaultIsServer\n\n/**\n * Returns whether the current runtime should be treated as a server environment.\n */\nexport const isServer = (): boolean => isServerFn()\n\n/**\n * Manages how TanStack Query detects whether the current runtime should be treated as\n * server-side, which disables scheduling refetch timers and changes the default `retry` count\n * and `gcTime`. By default, the detection treats a missing `window` (or the presence of a\n * `Deno` global) as server.\n *\n * Override this for runtimes where that default detection would give the wrong answer — for\n * example, a Service Worker, where `window` is undefined even though the environment should\n * behave like a client.\n *\n * @example\n * ```ts\n * import { environmentManager } from '@tanstack/query-core'\n *\n * environmentManager.setIsServer(() => false)\n * ```\n */\nexport const environmentManager = {\n  isServer,\n  /**\n   * Overrides the server check globally.\n   */\n  setIsServer(isServerValue: IsServerValue): void {\n    isServerFn = isServerValue\n  },\n}\n"],"mappings":";;;AAIA,IAAI,mBAAkCA,cAAAA;;;;AAKtC,MAAa,iBAA0B,WAAW;;;;;;;;;;;;;;;;;;AAmBlD,MAAa,qBAAqB;CAChC;;;;CAIA,YAAY,eAAoC;EAC9C,aAAa;CACf;AACF"}

package/build/legacy/environmentManager.d.cts

@@ -5,7 +5,21 @@ type IsServerValue = () => boolean;
  */
 declare const isServer: () => boolean;
 /**
- * Manages environment detection used by TanStack Query internals.
+ * Manages how TanStack Query detects whether the current runtime should be treated as
+ * server-side, which disables scheduling refetch timers and changes the default `retry` count
+ * and `gcTime`. By default, the detection treats a missing `window` (or the presence of a
+ * `Deno` global) as server.
+ *
+ * Override this for runtimes where that default detection would give the wrong answer — for
+ * example, a Service Worker, where `window` is undefined even though the environment should
+ * behave like a client.
+ *
+ * @example
+ * ```ts
+ * import { environmentManager } from '@tanstack/query-core'
+ *
+ * environmentManager.setIsServer(() => false)
+ * ```
  */
 declare const environmentManager: {
   isServer: () => boolean;

package/build/legacy/environmentManager.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"environmentManager.d.cts","names":[],"sources":["../../src/environmentManager.ts"],"mappings":";KAEY;;;;cAOC;;;;cAKA;EALe;;;;EAUC,YAAA,eAAA"}
+{"version":3,"file":"environmentManager.d.cts","names":[],"sources":["../../src/environmentManager.ts"],"mappings":";KAEY;;;;cAOC;;;;;;;;;;;;;;;;;;cAmBA;EAnBe;;;;EAwBC,YAAA,eAAA"}

package/build/legacy/environmentManager.d.ts

@@ -5,7 +5,21 @@ type IsServerValue = () => boolean;
  */
 declare const isServer: () => boolean;
 /**
- * Manages environment detection used by TanStack Query internals.
+ * Manages how TanStack Query detects whether the current runtime should be treated as
+ * server-side, which disables scheduling refetch timers and changes the default `retry` count
+ * and `gcTime`. By default, the detection treats a missing `window` (or the presence of a
+ * `Deno` global) as server.
+ *
+ * Override this for runtimes where that default detection would give the wrong answer — for
+ * example, a Service Worker, where `window` is undefined even though the environment should
+ * behave like a client.
+ *
+ * @example
+ * ```ts
+ * import { environmentManager } from '@tanstack/query-core'
+ *
+ * environmentManager.setIsServer(() => false)
+ * ```
  */
 declare const environmentManager: {
   isServer: () => boolean;

package/build/legacy/environmentManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environmentManager.d.ts","names":[],"sources":["../../src/environmentManager.ts"],"mappings":";KAEY;;;;cAOC;;;;cAKA;EALe;;;;EAUC,YAAA,eAAA"}
+{"version":3,"file":"environmentManager.d.ts","names":[],"sources":["../../src/environmentManager.ts"],"mappings":";KAEY;;;;cAOC;;;;;;;;;;;;;;;;;;cAmBA;EAnBe;;;;EAwBC,YAAA,eAAA"}

package/build/legacy/environmentManager.js

@@ -6,7 +6,21 @@ let isServerFn = () => isServer$1;
 */
 const isServer = () => isServerFn();
 /**
-* Manages environment detection used by TanStack Query internals.
+* Manages how TanStack Query detects whether the current runtime should be treated as
+* server-side, which disables scheduling refetch timers and changes the default `retry` count
+* and `gcTime`. By default, the detection treats a missing `window` (or the presence of a
+* `Deno` global) as server.
+*
+* Override this for runtimes where that default detection would give the wrong answer — for
+* example, a Service Worker, where `window` is undefined even though the environment should
+* behave like a client.
+*
+* @example
+* ```ts
+* import { environmentManager } from '@tanstack/query-core'
+*
+* environmentManager.setIsServer(() => false)
+* ```
 */
 const environmentManager = {
 	isServer,

package/build/legacy/environmentManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"environmentManager.js","names":["defaultIsServer"],"sources":["../../src/environmentManager.ts"],"sourcesContent":["import { isServer as defaultIsServer } from './utils'\n\nexport type IsServerValue = () => boolean\n\nlet isServerFn: IsServerValue = () => defaultIsServer\n\n/**\n * Returns whether the current runtime should be treated as a server environment.\n */\nexport const isServer = (): boolean => isServerFn()\n\n/**\n * Manages environment detection used by TanStack Query internals.\n */\nexport const environmentManager = {\n  isServer,\n  /**\n   * Overrides the server check globally.\n   */\n  setIsServer(isServerValue: IsServerValue): void {\n    isServerFn = isServerValue\n  },\n}\n"],"mappings":";;AAIA,IAAI,mBAAkCA;;;;AAKtC,MAAa,iBAA0B,WAAW;;;;AAKlD,MAAa,qBAAqB;CAChC;;;;CAIA,YAAY,eAAoC;EAC9C,aAAa;CACf;AACF"}
+{"version":3,"file":"environmentManager.js","names":["defaultIsServer"],"sources":["../../src/environmentManager.ts"],"sourcesContent":["import { isServer as defaultIsServer } from './utils'\n\nexport type IsServerValue = () => boolean\n\nlet isServerFn: IsServerValue = () => defaultIsServer\n\n/**\n * Returns whether the current runtime should be treated as a server environment.\n */\nexport const isServer = (): boolean => isServerFn()\n\n/**\n * Manages how TanStack Query detects whether the current runtime should be treated as\n * server-side, which disables scheduling refetch timers and changes the default `retry` count\n * and `gcTime`. By default, the detection treats a missing `window` (or the presence of a\n * `Deno` global) as server.\n *\n * Override this for runtimes where that default detection would give the wrong answer — for\n * example, a Service Worker, where `window` is undefined even though the environment should\n * behave like a client.\n *\n * @example\n * ```ts\n * import { environmentManager } from '@tanstack/query-core'\n *\n * environmentManager.setIsServer(() => false)\n * ```\n */\nexport const environmentManager = {\n  isServer,\n  /**\n   * Overrides the server check globally.\n   */\n  setIsServer(isServerValue: IsServerValue): void {\n    isServerFn = isServerValue\n  },\n}\n"],"mappings":";;AAIA,IAAI,mBAAkCA;;;;AAKtC,MAAa,iBAA0B,WAAW;;;;;;;;;;;;;;;;;;AAmBlD,MAAa,qBAAqB;CAChC;;;;CAIA,YAAY,eAAoC;EAC9C,aAAa;CACf;AACF"}

package/build/legacy/focusManager.cjs

@@ -5,6 +5,11 @@ const require_subscribable = require("./subscribable.cjs");
 var _focused = /* @__PURE__ */ new WeakMap();
 var _cleanup = /* @__PURE__ */ new WeakMap();
 var _setup = /* @__PURE__ */ new WeakMap();
+/**
+* The `FocusManager` manages the focus state within TanStack Query.
+*
+* It can be used to change the default event listeners or to manually change the focus state.
+*/
 var FocusManager = class extends require_subscribable.Subscribable {
 	constructor() {
 		super();
@@ -31,6 +36,31 @@ var FocusManager = class extends require_subscribable.Subscribable {
 			require_classPrivateFieldSet2._classPrivateFieldSet2(_cleanup, this, void 0);
 		}
 	}
+	/**
+	* `setEventListener` can be used to set a custom event listener that will
+	* be used to determine the focus state. The provided `setup` function
+	* receives a `setFocused` callback: call it with a `boolean` to manually
+	* set the focus state, or with no arguments to re-evaluate the current
+	* focus state and notify subscribers.
+	*
+	* @example
+	* ```ts
+	* import { focusManager } from '@tanstack/query-core'
+	*
+	* focusManager.setEventListener((handleFocus) => {
+	*   const listener = () => handleFocus()
+	*   // Listen to visibilitychange
+	*   if (typeof window !== 'undefined' && window.addEventListener) {
+	*     window.addEventListener('visibilitychange', listener, false)
+	*   }
+	*
+	*   return () => {
+	*     // Be sure to unsubscribe if a new handler is set
+	*     window.removeEventListener('visibilitychange', listener)
+	*   }
+	* })
+	* ```
+	*/
 	setEventListener(setup) {
 		var _classPrivateFieldGet3;
 		require_classPrivateFieldSet2._classPrivateFieldSet2(_setup, this, setup);
@@ -40,24 +70,51 @@ var FocusManager = class extends require_subscribable.Subscribable {
 			else this.onFocus();
 		}));
 	}
+	/**
+	* `setFocused` can be used to manually set the focus state. Set `undefined`
+	* to fall back to the default focus check.
+	*
+	* @example
+	* ```ts
+	* import { focusManager } from '@tanstack/query-core'
+	*
+	* // Set focused
+	* focusManager.setFocused(true)
+	*
+	* // Set unfocused
+	* focusManager.setFocused(false)
+	*
+	* // Fallback to the default focus check
+	* focusManager.setFocused(undefined)
+	* ```
+	*/
 	setFocused(focused) {
 		if (require_classPrivateFieldSet2._classPrivateFieldGet2(_focused, this) !== focused) {
 			require_classPrivateFieldSet2._classPrivateFieldSet2(_focused, this, focused);
 			this.onFocus();
 		}
 	}
+	/**
+	* `onFocus` notifies all subscribed listeners with the current focus state.
+	*/
 	onFocus() {
 		const isFocused = this.isFocused();
 		this.listeners.forEach((listener) => {
 			listener(isFocused);
 		});
 	}
+	/**
+	* `isFocused` can be used to get the current focus state.
+	*/
 	isFocused() {
 		var _globalThis$document;
 		if (typeof require_classPrivateFieldSet2._classPrivateFieldGet2(_focused, this) === "boolean") return require_classPrivateFieldSet2._classPrivateFieldGet2(_focused, this);
 		return ((_globalThis$document = globalThis.document) === null || _globalThis$document === void 0 ? void 0 : _globalThis$document.visibilityState) !== "hidden";
 	}
 };
+/**
+* Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.
+*/
 const focusManager = new FocusManager();
 //#endregion
 exports.FocusManager = FocusManager;

package/build/legacy/focusManager.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"focusManager.cjs","names":["Subscribable"],"sources":["../../src/focusManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (focused: boolean) => void\n\ntype SetupFn = (\n  setFocused: (focused?: boolean) => void,\n) => (() => void) | undefined\n\nexport class FocusManager extends Subscribable<Listener> {\n  #focused?: boolean\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onFocus) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const listener = () => onFocus()\n        // Listen to visibilitychange\n        window.addEventListener('visibilitychange', listener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('visibilitychange', listener)\n        }\n      }\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup((focused) => {\n      if (typeof focused === 'boolean') {\n        this.setFocused(focused)\n      } else {\n        this.onFocus()\n      }\n    })\n  }\n\n  setFocused(focused?: boolean): void {\n    const changed = this.#focused !== focused\n    if (changed) {\n      this.#focused = focused\n      this.onFocus()\n    }\n  }\n\n  onFocus(): void {\n    const isFocused = this.isFocused()\n    this.listeners.forEach((listener) => {\n      listener(isFocused)\n    })\n  }\n\n  isFocused(): boolean {\n    if (typeof this.#focused === 'boolean') {\n      return this.#focused\n    }\n\n    // document global can be unavailable in react native\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n    return globalThis.document?.visibilityState !== 'hidden'\n  }\n}\n\nexport const focusManager = new FocusManager()\n"],"mappings":";;;;;;;AAQA,IAAa,eAAb,cAAkCA,qBAAAA,aAAuB;CAMvD,cAAc;EACZ,MAAM;;;;EACN,8BAAA,uBAAA,QAAA,OAAe,YAAY;GAGzB,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,iBAAiB,QAAQ;IAE/B,OAAO,iBAAiB,oBAAoB,UAAU,KAAK;IAE3D,aAAa;KAEX,OAAO,oBAAoB,oBAAoB,QAAQ;IACzD;GACF;EAEF,CAAA;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAA,8BAAA,uBAAA,UAAC,IAAA,GACH,KAAK,iBAAA,8BAAA,uBAAA,QAAiB,IAAA,CAAW;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;;GACxB,CAAA,2BAAA,8BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,6BAAA,KAAA,KAAA,yBAAA,KAAA,IAAgB;GAChB,8BAAA,uBAAA,UAAA,MAAgB,KAAA,CAAA;EAClB;CACF;CAEA,iBAAiB,OAAsB;;EACrC,8BAAA,uBAAA,QAAA,MAAc,KAAA;EACd,CAAA,yBAAA,8BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,2BAAA,KAAA,KAAA,uBAAA,KAAA,IAAgB;EAChB,8BAAA,uBAAA,UAAA,MAAgB,OAAO,YAAY;GACjC,IAAI,OAAO,YAAY,WACrB,KAAK,WAAW,OAAO;QAEvB,KAAK,QAAQ;EAEjB,CAAC,CAAA;CACH;CAEA,WAAW,SAAyB;EAElC,IAAA,8BAAA,uBAAA,UADgB,IAAA,MAAkB,SACrB;GACX,8BAAA,uBAAA,UAAA,MAAgB,OAAA;GAChB,KAAK,QAAQ;EACf;CACF;CAEA,UAAgB;EACd,MAAM,YAAY,KAAK,UAAU;EACjC,KAAK,UAAU,SAAS,aAAa;GACnC,SAAS,SAAS;EACpB,CAAC;CACH;CAEA,YAAqB;;EACnB,IAAI,OAAA,8BAAA,uBAAA,UAAO,IAAA,MAAkB,WAC3B,OAAA,8BAAA,uBAAA,UAAO,IAAA;EAKT,SAAA,uBAAO,WAAW,cAAA,QAAA,yBAAA,KAAA,IAAA,KAAA,IAAA,qBAAU,qBAAoB;CAClD;AACF;AAEA,MAAa,eAAe,IAAI,aAAa"}
+{"version":3,"file":"focusManager.cjs","names":["Subscribable"],"sources":["../../src/focusManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (focused: boolean) => void\n\ntype SetupFn = (\n  setFocused: (focused?: boolean) => void,\n) => (() => void) | undefined\n\n/**\n * The `FocusManager` manages the focus state within TanStack Query.\n *\n * It can be used to change the default event listeners or to manually change the focus state.\n */\nexport class FocusManager extends Subscribable<Listener> {\n  #focused?: boolean\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onFocus) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const listener = () => onFocus()\n        // Listen to visibilitychange\n        window.addEventListener('visibilitychange', listener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('visibilitychange', listener)\n        }\n      }\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  /**\n   * `setEventListener` can be used to set a custom event listener that will\n   * be used to determine the focus state. The provided `setup` function\n   * receives a `setFocused` callback: call it with a `boolean` to manually\n   * set the focus state, or with no arguments to re-evaluate the current\n   * focus state and notify subscribers.\n   *\n   * @example\n   * ```ts\n   * import { focusManager } from '@tanstack/query-core'\n   *\n   * focusManager.setEventListener((handleFocus) => {\n   *   const listener = () => handleFocus()\n   *   // Listen to visibilitychange\n   *   if (typeof window !== 'undefined' && window.addEventListener) {\n   *     window.addEventListener('visibilitychange', listener, false)\n   *   }\n   *\n   *   return () => {\n   *     // Be sure to unsubscribe if a new handler is set\n   *     window.removeEventListener('visibilitychange', listener)\n   *   }\n   * })\n   * ```\n   */\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup((focused) => {\n      if (typeof focused === 'boolean') {\n        this.setFocused(focused)\n      } else {\n        this.onFocus()\n      }\n    })\n  }\n\n  /**\n   * `setFocused` can be used to manually set the focus state. Set `undefined`\n   * to fall back to the default focus check.\n   *\n   * @example\n   * ```ts\n   * import { focusManager } from '@tanstack/query-core'\n   *\n   * // Set focused\n   * focusManager.setFocused(true)\n   *\n   * // Set unfocused\n   * focusManager.setFocused(false)\n   *\n   * // Fallback to the default focus check\n   * focusManager.setFocused(undefined)\n   * ```\n   */\n  setFocused(focused?: boolean): void {\n    const changed = this.#focused !== focused\n    if (changed) {\n      this.#focused = focused\n      this.onFocus()\n    }\n  }\n\n  /**\n   * `onFocus` notifies all subscribed listeners with the current focus state.\n   */\n  onFocus(): void {\n    const isFocused = this.isFocused()\n    this.listeners.forEach((listener) => {\n      listener(isFocused)\n    })\n  }\n\n  /**\n   * `isFocused` can be used to get the current focus state.\n   */\n  isFocused(): boolean {\n    if (typeof this.#focused === 'boolean') {\n      return this.#focused\n    }\n\n    // document global can be unavailable in react native\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n    return globalThis.document?.visibilityState !== 'hidden'\n  }\n}\n\n/**\n * Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.\n */\nexport const focusManager = new FocusManager()\n"],"mappings":";;;;;;;;;;;;AAaA,IAAa,eAAb,cAAkCA,qBAAAA,aAAuB;CAMvD,cAAc;EACZ,MAAM;;;;EACN,8BAAA,uBAAA,QAAA,OAAe,YAAY;GAGzB,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,iBAAiB,QAAQ;IAE/B,OAAO,iBAAiB,oBAAoB,UAAU,KAAK;IAE3D,aAAa;KAEX,OAAO,oBAAoB,oBAAoB,QAAQ;IACzD;GACF;EAEF,CAAA;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAA,8BAAA,uBAAA,UAAC,IAAA,GACH,KAAK,iBAAA,8BAAA,uBAAA,QAAiB,IAAA,CAAW;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;;GACxB,CAAA,2BAAA,8BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,6BAAA,KAAA,KAAA,yBAAA,KAAA,IAAgB;GAChB,8BAAA,uBAAA,UAAA,MAAgB,KAAA,CAAA;EAClB;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BA,iBAAiB,OAAsB;;EACrC,8BAAA,uBAAA,QAAA,MAAc,KAAA;EACd,CAAA,yBAAA,8BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,2BAAA,KAAA,KAAA,uBAAA,KAAA,IAAgB;EAChB,8BAAA,uBAAA,UAAA,MAAgB,OAAO,YAAY;GACjC,IAAI,OAAO,YAAY,WACrB,KAAK,WAAW,OAAO;QAEvB,KAAK,QAAQ;EAEjB,CAAC,CAAA;CACH;;;;;;;;;;;;;;;;;;;CAoBA,WAAW,SAAyB;EAElC,IAAA,8BAAA,uBAAA,UADgB,IAAA,MAAkB,SACrB;GACX,8BAAA,uBAAA,UAAA,MAAgB,OAAA;GAChB,KAAK,QAAQ;EACf;CACF;;;;CAKA,UAAgB;EACd,MAAM,YAAY,KAAK,UAAU;EACjC,KAAK,UAAU,SAAS,aAAa;GACnC,SAAS,SAAS;EACpB,CAAC;CACH;;;;CAKA,YAAqB;;EACnB,IAAI,OAAA,8BAAA,uBAAA,UAAO,IAAA,MAAkB,WAC3B,OAAA,8BAAA,uBAAA,UAAO,IAAA;EAKT,SAAA,uBAAO,WAAW,cAAA,QAAA,yBAAA,KAAA,IAAA,KAAA,IAAA,qBAAU,qBAAoB;CAClD;AACF;;;;AAKA,MAAa,eAAe,IAAI,aAAa"}

package/build/legacy/focusManager.d.cts

@@ -2,16 +2,73 @@ import { t as Subscribable } from "./subscribable-CbifVTKz.cjs";
 //#region src/focusManager.d.ts
 type Listener = (focused: boolean) => void;
 type SetupFn = (setFocused: (focused?: boolean) => void) => (() => void) | undefined;
+/**
+ * The `FocusManager` manages the focus state within TanStack Query.
+ *
+ * It can be used to change the default event listeners or to manually change the focus state.
+ */
 declare class FocusManager extends Subscribable<Listener> {
   #private;
   constructor();
   protected onSubscribe(): void;
   protected onUnsubscribe(): void;
+  /**
+   * `setEventListener` can be used to set a custom event listener that will
+   * be used to determine the focus state. The provided `setup` function
+   * receives a `setFocused` callback: call it with a `boolean` to manually
+   * set the focus state, or with no arguments to re-evaluate the current
+   * focus state and notify subscribers.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * focusManager.setEventListener((handleFocus) => {
+   *   const listener = () => handleFocus()
+   *   // Listen to visibilitychange
+   *   if (typeof window !== 'undefined' && window.addEventListener) {
+   *     window.addEventListener('visibilitychange', listener, false)
+   *   }
+   *
+   *   return () => {
+   *     // Be sure to unsubscribe if a new handler is set
+   *     window.removeEventListener('visibilitychange', listener)
+   *   }
+   * })
+   * ```
+   */
   setEventListener(setup: SetupFn): void;
+  /**
+   * `setFocused` can be used to manually set the focus state. Set `undefined`
+   * to fall back to the default focus check.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * // Set focused
+   * focusManager.setFocused(true)
+   *
+   * // Set unfocused
+   * focusManager.setFocused(false)
+   *
+   * // Fallback to the default focus check
+   * focusManager.setFocused(undefined)
+   * ```
+   */
   setFocused(focused?: boolean): void;
+  /**
+   * `onFocus` notifies all subscribed listeners with the current focus state.
+   */
   onFocus(): void;
+  /**
+   * `isFocused` can be used to get the current focus state.
+   */
   isFocused(): boolean;
 }
+/**
+ * Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.
+ */
 declare const focusManager: FocusManager;
 //#endregion
 export { FocusManager, focusManager };

package/build/legacy/focusManager.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"focusManager.d.cts","names":[],"sources":["../../src/focusManager.ts"],"mappings":";;KAEK,YAAY;KAEZ,WACH,aAAa;cAGF,qBAAqB,aAAa;;;YAyBnC;YAMA;EAOV,iBAAiB,OAAO;EAYxB,WAAW;EAQX;EAOA;;cAWW,cAAY"}
+{"version":3,"file":"focusManager.d.cts","names":[],"sources":["../../src/focusManager.ts"],"mappings":";;KAEK,YAAY;KAEZ,WACH,aAAa;;;;;;cAQF,qBAAqB,aAAa;;;YAyBnC;YAMA;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCV,iBAAiB,OAAO;;;;;;;;;;;;;;;;;;;EA8BxB,WAAW;;;;EAWX;;;;EAUA;;;;;cAcW,cAAY"}

package/build/legacy/focusManager.d.ts

@@ -2,16 +2,73 @@ import { t as Subscribable } from "./subscribable-CbifVTKz.js";
 //#region src/focusManager.d.ts
 type Listener = (focused: boolean) => void;
 type SetupFn = (setFocused: (focused?: boolean) => void) => (() => void) | undefined;
+/**
+ * The `FocusManager` manages the focus state within TanStack Query.
+ *
+ * It can be used to change the default event listeners or to manually change the focus state.
+ */
 declare class FocusManager extends Subscribable<Listener> {
   #private;
   constructor();
   protected onSubscribe(): void;
   protected onUnsubscribe(): void;
+  /**
+   * `setEventListener` can be used to set a custom event listener that will
+   * be used to determine the focus state. The provided `setup` function
+   * receives a `setFocused` callback: call it with a `boolean` to manually
+   * set the focus state, or with no arguments to re-evaluate the current
+   * focus state and notify subscribers.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * focusManager.setEventListener((handleFocus) => {
+   *   const listener = () => handleFocus()
+   *   // Listen to visibilitychange
+   *   if (typeof window !== 'undefined' && window.addEventListener) {
+   *     window.addEventListener('visibilitychange', listener, false)
+   *   }
+   *
+   *   return () => {
+   *     // Be sure to unsubscribe if a new handler is set
+   *     window.removeEventListener('visibilitychange', listener)
+   *   }
+   * })
+   * ```
+   */
   setEventListener(setup: SetupFn): void;
+  /**
+   * `setFocused` can be used to manually set the focus state. Set `undefined`
+   * to fall back to the default focus check.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * // Set focused
+   * focusManager.setFocused(true)
+   *
+   * // Set unfocused
+   * focusManager.setFocused(false)
+   *
+   * // Fallback to the default focus check
+   * focusManager.setFocused(undefined)
+   * ```
+   */
   setFocused(focused?: boolean): void;
+  /**
+   * `onFocus` notifies all subscribed listeners with the current focus state.
+   */
   onFocus(): void;
+  /**
+   * `isFocused` can be used to get the current focus state.
+   */
   isFocused(): boolean;
 }
+/**
+ * Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.
+ */
 declare const focusManager: FocusManager;
 //#endregion
 export { FocusManager, focusManager };

package/build/legacy/focusManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"focusManager.d.ts","names":[],"sources":["../../src/focusManager.ts"],"mappings":";;KAEK,YAAY;KAEZ,WACH,aAAa;cAGF,qBAAqB,aAAa;;;YAyBnC;YAMA;EAOV,iBAAiB,OAAO;EAYxB,WAAW;EAQX;EAOA;;cAWW,cAAY"}
+{"version":3,"file":"focusManager.d.ts","names":[],"sources":["../../src/focusManager.ts"],"mappings":";;KAEK,YAAY;KAEZ,WACH,aAAa;;;;;;cAQF,qBAAqB,aAAa;;;YAyBnC;YAMA;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCV,iBAAiB,OAAO;;;;;;;;;;;;;;;;;;;EA8BxB,WAAW;;;;EAWX;;;;EAUA;;;;;cAcW,cAAY"}

package/build/legacy/focusManager.js

@@ -4,6 +4,11 @@ import { Subscribable } from "./subscribable.js";
 var _focused = /* @__PURE__ */ new WeakMap();
 var _cleanup = /* @__PURE__ */ new WeakMap();
 var _setup = /* @__PURE__ */ new WeakMap();
+/**
+* The `FocusManager` manages the focus state within TanStack Query.
+*
+* It can be used to change the default event listeners or to manually change the focus state.
+*/
 var FocusManager = class extends Subscribable {
 	constructor() {
 		super();
@@ -30,6 +35,31 @@ var FocusManager = class extends Subscribable {
 			_classPrivateFieldSet2(_cleanup, this, void 0);
 		}
 	}
+	/**
+	* `setEventListener` can be used to set a custom event listener that will
+	* be used to determine the focus state. The provided `setup` function
+	* receives a `setFocused` callback: call it with a `boolean` to manually
+	* set the focus state, or with no arguments to re-evaluate the current
+	* focus state and notify subscribers.
+	*
+	* @example
+	* ```ts
+	* import { focusManager } from '@tanstack/query-core'
+	*
+	* focusManager.setEventListener((handleFocus) => {
+	*   const listener = () => handleFocus()
+	*   // Listen to visibilitychange
+	*   if (typeof window !== 'undefined' && window.addEventListener) {
+	*     window.addEventListener('visibilitychange', listener, false)
+	*   }
+	*
+	*   return () => {
+	*     // Be sure to unsubscribe if a new handler is set
+	*     window.removeEventListener('visibilitychange', listener)
+	*   }
+	* })
+	* ```
+	*/
 	setEventListener(setup) {
 		var _classPrivateFieldGet3;
 		_classPrivateFieldSet2(_setup, this, setup);
@@ -39,24 +69,51 @@ var FocusManager = class extends Subscribable {
 			else this.onFocus();
 		}));
 	}
+	/**
+	* `setFocused` can be used to manually set the focus state. Set `undefined`
+	* to fall back to the default focus check.
+	*
+	* @example
+	* ```ts
+	* import { focusManager } from '@tanstack/query-core'
+	*
+	* // Set focused
+	* focusManager.setFocused(true)
+	*
+	* // Set unfocused
+	* focusManager.setFocused(false)
+	*
+	* // Fallback to the default focus check
+	* focusManager.setFocused(undefined)
+	* ```
+	*/
 	setFocused(focused) {
 		if (_classPrivateFieldGet2(_focused, this) !== focused) {
 			_classPrivateFieldSet2(_focused, this, focused);
 			this.onFocus();
 		}
 	}
+	/**
+	* `onFocus` notifies all subscribed listeners with the current focus state.
+	*/
 	onFocus() {
 		const isFocused = this.isFocused();
 		this.listeners.forEach((listener) => {
 			listener(isFocused);
 		});
 	}
+	/**
+	* `isFocused` can be used to get the current focus state.
+	*/
 	isFocused() {
 		var _globalThis$document;
 		if (typeof _classPrivateFieldGet2(_focused, this) === "boolean") return _classPrivateFieldGet2(_focused, this);
 		return ((_globalThis$document = globalThis.document) === null || _globalThis$document === void 0 ? void 0 : _globalThis$document.visibilityState) !== "hidden";
 	}
 };
+/**
+* Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.
+*/
 const focusManager = new FocusManager();
 //#endregion
 export { FocusManager, focusManager };

package/build/legacy/focusManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"focusManager.js","names":[],"sources":["../../src/focusManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (focused: boolean) => void\n\ntype SetupFn = (\n  setFocused: (focused?: boolean) => void,\n) => (() => void) | undefined\n\nexport class FocusManager extends Subscribable<Listener> {\n  #focused?: boolean\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onFocus) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const listener = () => onFocus()\n        // Listen to visibilitychange\n        window.addEventListener('visibilitychange', listener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('visibilitychange', listener)\n        }\n      }\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup((focused) => {\n      if (typeof focused === 'boolean') {\n        this.setFocused(focused)\n      } else {\n        this.onFocus()\n      }\n    })\n  }\n\n  setFocused(focused?: boolean): void {\n    const changed = this.#focused !== focused\n    if (changed) {\n      this.#focused = focused\n      this.onFocus()\n    }\n  }\n\n  onFocus(): void {\n    const isFocused = this.isFocused()\n    this.listeners.forEach((listener) => {\n      listener(isFocused)\n    })\n  }\n\n  isFocused(): boolean {\n    if (typeof this.#focused === 'boolean') {\n      return this.#focused\n    }\n\n    // document global can be unavailable in react native\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n    return globalThis.document?.visibilityState !== 'hidden'\n  }\n}\n\nexport const focusManager = new FocusManager()\n"],"mappings":";;;;;;AAQA,IAAa,eAAb,cAAkC,aAAuB;CAMvD,cAAc;EACZ,MAAM;;;;EACN,uBAAA,QAAA,OAAe,YAAY;GAGzB,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,iBAAiB,QAAQ;IAE/B,OAAO,iBAAiB,oBAAoB,UAAU,KAAK;IAE3D,aAAa;KAEX,OAAO,oBAAoB,oBAAoB,QAAQ;IACzD;GACF;EAEF,CAAA;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAA,uBAAA,UAAC,IAAA,GACH,KAAK,iBAAA,uBAAA,QAAiB,IAAA,CAAW;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;;GACxB,CAAA,2BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,6BAAA,KAAA,KAAA,yBAAA,KAAA,IAAgB;GAChB,uBAAA,UAAA,MAAgB,KAAA,CAAA;EAClB;CACF;CAEA,iBAAiB,OAAsB;;EACrC,uBAAA,QAAA,MAAc,KAAA;EACd,CAAA,yBAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,2BAAA,KAAA,KAAA,uBAAA,KAAA,IAAgB;EAChB,uBAAA,UAAA,MAAgB,OAAO,YAAY;GACjC,IAAI,OAAO,YAAY,WACrB,KAAK,WAAW,OAAO;QAEvB,KAAK,QAAQ;EAEjB,CAAC,CAAA;CACH;CAEA,WAAW,SAAyB;EAElC,IAAA,uBAAA,UADgB,IAAA,MAAkB,SACrB;GACX,uBAAA,UAAA,MAAgB,OAAA;GAChB,KAAK,QAAQ;EACf;CACF;CAEA,UAAgB;EACd,MAAM,YAAY,KAAK,UAAU;EACjC,KAAK,UAAU,SAAS,aAAa;GACnC,SAAS,SAAS;EACpB,CAAC;CACH;CAEA,YAAqB;;EACnB,IAAI,OAAA,uBAAA,UAAO,IAAA,MAAkB,WAC3B,OAAA,uBAAA,UAAO,IAAA;EAKT,SAAA,uBAAO,WAAW,cAAA,QAAA,yBAAA,KAAA,IAAA,KAAA,IAAA,qBAAU,qBAAoB;CAClD;AACF;AAEA,MAAa,eAAe,IAAI,aAAa"}
+{"version":3,"file":"focusManager.js","names":[],"sources":["../../src/focusManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (focused: boolean) => void\n\ntype SetupFn = (\n  setFocused: (focused?: boolean) => void,\n) => (() => void) | undefined\n\n/**\n * The `FocusManager` manages the focus state within TanStack Query.\n *\n * It can be used to change the default event listeners or to manually change the focus state.\n */\nexport class FocusManager extends Subscribable<Listener> {\n  #focused?: boolean\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onFocus) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const listener = () => onFocus()\n        // Listen to visibilitychange\n        window.addEventListener('visibilitychange', listener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('visibilitychange', listener)\n        }\n      }\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  /**\n   * `setEventListener` can be used to set a custom event listener that will\n   * be used to determine the focus state. The provided `setup` function\n   * receives a `setFocused` callback: call it with a `boolean` to manually\n   * set the focus state, or with no arguments to re-evaluate the current\n   * focus state and notify subscribers.\n   *\n   * @example\n   * ```ts\n   * import { focusManager } from '@tanstack/query-core'\n   *\n   * focusManager.setEventListener((handleFocus) => {\n   *   const listener = () => handleFocus()\n   *   // Listen to visibilitychange\n   *   if (typeof window !== 'undefined' && window.addEventListener) {\n   *     window.addEventListener('visibilitychange', listener, false)\n   *   }\n   *\n   *   return () => {\n   *     // Be sure to unsubscribe if a new handler is set\n   *     window.removeEventListener('visibilitychange', listener)\n   *   }\n   * })\n   * ```\n   */\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup((focused) => {\n      if (typeof focused === 'boolean') {\n        this.setFocused(focused)\n      } else {\n        this.onFocus()\n      }\n    })\n  }\n\n  /**\n   * `setFocused` can be used to manually set the focus state. Set `undefined`\n   * to fall back to the default focus check.\n   *\n   * @example\n   * ```ts\n   * import { focusManager } from '@tanstack/query-core'\n   *\n   * // Set focused\n   * focusManager.setFocused(true)\n   *\n   * // Set unfocused\n   * focusManager.setFocused(false)\n   *\n   * // Fallback to the default focus check\n   * focusManager.setFocused(undefined)\n   * ```\n   */\n  setFocused(focused?: boolean): void {\n    const changed = this.#focused !== focused\n    if (changed) {\n      this.#focused = focused\n      this.onFocus()\n    }\n  }\n\n  /**\n   * `onFocus` notifies all subscribed listeners with the current focus state.\n   */\n  onFocus(): void {\n    const isFocused = this.isFocused()\n    this.listeners.forEach((listener) => {\n      listener(isFocused)\n    })\n  }\n\n  /**\n   * `isFocused` can be used to get the current focus state.\n   */\n  isFocused(): boolean {\n    if (typeof this.#focused === 'boolean') {\n      return this.#focused\n    }\n\n    // document global can be unavailable in react native\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n    return globalThis.document?.visibilityState !== 'hidden'\n  }\n}\n\n/**\n * Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.\n */\nexport const focusManager = new FocusManager()\n"],"mappings":";;;;;;;;;;;AAaA,IAAa,eAAb,cAAkC,aAAuB;CAMvD,cAAc;EACZ,MAAM;;;;EACN,uBAAA,QAAA,OAAe,YAAY;GAGzB,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,iBAAiB,QAAQ;IAE/B,OAAO,iBAAiB,oBAAoB,UAAU,KAAK;IAE3D,aAAa;KAEX,OAAO,oBAAoB,oBAAoB,QAAQ;IACzD;GACF;EAEF,CAAA;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAA,uBAAA,UAAC,IAAA,GACH,KAAK,iBAAA,uBAAA,QAAiB,IAAA,CAAW;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;;GACxB,CAAA,2BAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,6BAAA,KAAA,KAAA,yBAAA,KAAA,IAAgB;GAChB,uBAAA,UAAA,MAAgB,KAAA,CAAA;EAClB;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BA,iBAAiB,OAAsB;;EACrC,uBAAA,QAAA,MAAc,KAAA;EACd,CAAA,yBAAA,uBAAA,UAAA,IAAA,OAAA,QAAA,2BAAA,KAAA,KAAA,uBAAA,KAAA,IAAgB;EAChB,uBAAA,UAAA,MAAgB,OAAO,YAAY;GACjC,IAAI,OAAO,YAAY,WACrB,KAAK,WAAW,OAAO;QAEvB,KAAK,QAAQ;EAEjB,CAAC,CAAA;CACH;;;;;;;;;;;;;;;;;;;CAoBA,WAAW,SAAyB;EAElC,IAAA,uBAAA,UADgB,IAAA,MAAkB,SACrB;GACX,uBAAA,UAAA,MAAgB,OAAA;GAChB,KAAK,QAAQ;EACf;CACF;;;;CAKA,UAAgB;EACd,MAAM,YAAY,KAAK,UAAU;EACjC,KAAK,UAAU,SAAS,aAAa;GACnC,SAAS,SAAS;EACpB,CAAC;CACH;;;;CAKA,YAAqB;;EACnB,IAAI,OAAA,uBAAA,UAAO,IAAA,MAAkB,WAC3B,OAAA,uBAAA,UAAO,IAAA;EAKT,SAAA,uBAAO,WAAW,cAAA,QAAA,yBAAA,KAAA,IAAA,KAAA,IAAA,qBAAU,qBAAoB;CAClD;AACF;;;;AAKA,MAAa,eAAe,IAAI,aAAa"}