@tanstack/react-query-next-experimental 5.104.0 → 5.104.2

package/build/modern/HydrationStreamProvider.cjs

@@ -8,17 +8,25 @@ let react = require("react");
 react = require_rolldown_runtime.__toESM(react, 1);
 let react_jsx_runtime = require("react/jsx-runtime");
 //#region src/HydrationStreamProvider.tsx
+/**
+* Creates a provider that streams entries (e.g. dehydrated query state) from the server to the
+* client while the page streams in, and the context it shares the stream through.
+* @returns The `Provider` component and its `context`.
+*/
 function createHydrationStreamProvider() {
-	const context = react.createContext(null);
+	const StreamContext = react.createContext(null);
 	/**
-	
-	* 1. (Happens on server): `useServerInsertedHTML()` is called **on the server** whenever a `Suspense`-boundary completes
-	*    - This means that we might have some new entries in the cache that needs to be flushed
-	*    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`
+	* 1. (Happens on server): the callback registered with `useServerInsertedHTML()` is called **on the server** whenever
+	*    Next.js inserts HTML into the streamed response.
+	*    - This means that we might have some new entries in the cache that needs to be flushed.
+	*    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`.
 	* 2. (Happens in browser) In `useEffect()`:
-	*   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries
-	*   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received
-	**/
+	*   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries.
+	*   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received.
+	* @param props - The `children` to render, the `onEntries`/`onFlush` callbacks, and the optional
+	* `transformer` and `nonce`.
+	* @returns The `children`, wrapped in the stream context provider.
+	*/
 	function UseClientHydrationStreamProvider(props) {
 		const id = `__RQ${react.useId()}`;
 		const idJSON = require_htmlescape.htmlEscapeJsonString(JSON.stringify(id));
@@ -30,7 +38,7 @@ function createHydrationStreamProvider() {
 			if (!_tanstack_react_query.environmentManager.isServer()) return { push() {} };
 			return [];
 		});
-		const count = react.useRef(0);
+		const countRef = react.useRef(0);
 		(0, next_navigation.useServerInsertedHTML)(() => {
 			stream.push(...props.onFlush?.() ?? []);
 			if (!stream.length) return null;
@@ -40,7 +48,7 @@ function createHydrationStreamProvider() {
 			return /* @__PURE__ */ (0, react_jsx_runtime.jsx)("script", {
 				nonce: props.nonce,
 				dangerouslySetInnerHTML: { __html: html.join("") }
-			}, count.current++);
+			}, countRef.current++);
 		});
 		if (!_tanstack_react_query.environmentManager.isServer()) {
 			const win = window;
@@ -56,7 +64,7 @@ function createHydrationStreamProvider() {
 				};
 			}
 		}
-		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(context.Provider, {
+		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(StreamContext.Provider, {
 			value: {
 				stream,
 				id
@@ -66,7 +74,7 @@ function createHydrationStreamProvider() {
 	}
 	return {
 		Provider: UseClientHydrationStreamProvider,
-		context
+		context: StreamContext
 	};
 }
 //#endregion

package/build/modern/HydrationStreamProvider.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"HydrationStreamProvider.cjs","names":["React","htmlEscapeJsonString","environmentManager"],"sources":["../../src/HydrationStreamProvider.tsx"],"sourcesContent":["'use client'\n\nimport { environmentManager } from '@tanstack/react-query'\nimport { useServerInsertedHTML } from 'next/navigation'\nimport * as React from 'react'\nimport { htmlEscapeJsonString } from './htmlescape'\n\nconst serializedSymbol = Symbol('serialized')\n\ninterface DataTransformer {\n  serialize: (object: any) => any\n  deserialize: (object: any) => any\n}\n\ntype Serialized<TData> = unknown & {\n  [serializedSymbol]: TData\n}\n\ninterface TypedDataTransformer<TData> {\n  serialize: (obj: TData) => Serialized<TData>\n  deserialize: (obj: Serialized<TData>) => TData\n}\n\ninterface HydrationStreamContext<TShape> {\n  id: string\n  stream: {\n    /**\n     * **Server method**\n     * Push a new entry to the stream\n     * Will be ignored on the client\n     */\n    push: (...shape: Array<TShape>) => void\n  }\n}\n\nexport interface HydrationStreamProviderProps<TShape> {\n  children: React.ReactNode\n  /**\n   * Optional transformer to serialize/deserialize the data\n   * Example devalue, superjson et al\n   */\n  transformer?: DataTransformer\n  /**\n   * **Client method**\n   * Called in the browser when new entries are received\n   */\n  onEntries: (entries: Array<TShape>) => void\n  /**\n   * **Server method**\n   * onFlush is called on the server when the cache is flushed\n   */\n  onFlush?: () => Array<TShape>\n  /**\n   * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n   */\n  nonce?: string\n}\n\nexport function createHydrationStreamProvider<TShape>() {\n  const context = React.createContext<HydrationStreamContext<TShape>>(\n    null as any,\n  )\n  /**\n\n   * 1. (Happens on server): `useServerInsertedHTML()` is called **on the server** whenever a `Suspense`-boundary completes\n   *    - This means that we might have some new entries in the cache that needs to be flushed\n   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`\n   * 2. (Happens in browser) In `useEffect()`:\n   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries\n   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received\n   **/\n  function UseClientHydrationStreamProvider(props: {\n    children: React.ReactNode\n    /**\n     * Optional transformer to serialize/deserialize the data\n     * Example devalue, superjson et al\n     */\n    transformer?: DataTransformer\n    /**\n     * **Client method**\n     * Called in the browser when new entries are received\n     */\n    onEntries: (entries: Array<TShape>) => void\n    /**\n     * **Server method**\n     * onFlush is called on the server when the cache is flushed\n     */\n    onFlush?: () => Array<TShape>\n    /**\n     * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n     */\n    nonce?: string\n  }) {\n    // unique id for the cache provider\n    const id = `__RQ${React.useId()}`\n    const idJSON = htmlEscapeJsonString(JSON.stringify(id))\n\n    const [transformer] = React.useState(\n      () =>\n        (props.transformer ?? {\n          // noop\n          serialize: (obj: any) => obj,\n          deserialize: (obj: any) => obj,\n        }) as unknown as TypedDataTransformer<TShape>,\n    )\n\n    // <server stuff>\n    const [stream] = React.useState<Array<TShape>>(() => {\n      if (!environmentManager.isServer()) {\n        return {\n          push() {\n            // no-op on the client\n          },\n        } as unknown as Array<TShape>\n      }\n      return []\n    })\n    const count = React.useRef(0)\n    useServerInsertedHTML(() => {\n      // This only happens on the server\n      stream.push(...(props.onFlush?.() ?? []))\n\n      if (!stream.length) {\n        return null\n      }\n      // console.log(`pushing ${stream.length} entries`)\n      const serializedCacheArgs = stream\n        .map((entry) => transformer.serialize(entry))\n        .map((entry) => JSON.stringify(entry))\n        .join(',')\n\n      // Flush stream\n      // eslint-disable-next-line react-hooks/immutability\n      stream.length = 0\n\n      const html: Array<string> = [\n        `window[${idJSON}] = window[${idJSON}] || [];`,\n        `window[${idJSON}].push(${htmlEscapeJsonString(serializedCacheArgs)});`,\n      ]\n      return (\n        <script\n          key={count.current++}\n          nonce={props.nonce}\n          dangerouslySetInnerHTML={{\n            __html: html.join(''),\n          }}\n        />\n      )\n    })\n    // </server stuff>\n\n    // <client stuff>\n    // Setup and run the onEntries handler on the client only, but do it during\n    // the initial render so children have access to the data immediately\n    // This is important to avoid the client suspending during the initial render\n    // if the data has not yet been hydrated.\n    if (!environmentManager.isServer()) {\n      const win = window as any\n      if (!win[id]?.initialized) {\n        // Client: consume cache:\n        const onEntries = (...serializedEntries: Array<Serialized<TShape>>) => {\n          const entries = serializedEntries.map((serialized) =>\n            transformer.deserialize(serialized),\n          )\n          props.onEntries(entries)\n        }\n\n        const winStream: Array<Serialized<TShape>> = win[id] ?? []\n\n        onEntries(...winStream)\n\n        // eslint-disable-next-line react-hooks/immutability\n        win[id] = {\n          initialized: true,\n          push: onEntries,\n        }\n      }\n    }\n    // </client stuff>\n\n    return (\n      <context.Provider value={{ stream, id }}>\n        {props.children}\n      </context.Provider>\n    )\n  }\n\n  return {\n    Provider: UseClientHydrationStreamProvider,\n    context,\n  }\n}\n"],"mappings":";;;;;;;;;;AA0DA,SAAgB,gCAAwC;CACtD,MAAM,UAAUA,MAAM,cACpB,IACF;;;;;;;;;;CAUA,SAAS,iCAAiC,OAqBvC;EAED,MAAM,KAAK,OAAOA,MAAM,MAAM;EAC9B,MAAM,SAASC,mBAAAA,qBAAqB,KAAK,UAAU,EAAE,CAAC;EAEtD,MAAM,CAAC,eAAeD,MAAM,eAEvB,MAAM,eAAe;GAEpB,YAAY,QAAa;GACzB,cAAc,QAAa;EAC7B,CACJ;EAGA,MAAM,CAAC,UAAUA,MAAM,eAA8B;GACnD,IAAI,CAACE,sBAAAA,mBAAmB,SAAS,GAC/B,OAAO,EACL,OAAO,CAEP,EACF;GAEF,OAAO,CAAC;EACV,CAAC;EACD,MAAM,QAAQF,MAAM,OAAO,CAAC;EAC5B,CAAA,GAAA,gBAAA,sBAAA,OAA4B;GAE1B,OAAO,KAAK,GAAI,MAAM,UAAU,KAAK,CAAC,CAAE;GAExC,IAAI,CAAC,OAAO,QACV,OAAO;GAGT,MAAM,sBAAsB,OACzB,KAAK,UAAU,YAAY,UAAU,KAAK,CAAC,CAAC,CAC5C,KAAK,UAAU,KAAK,UAAU,KAAK,CAAC,CAAC,CACrC,KAAK,GAAG;GAIX,OAAO,SAAS;GAEhB,MAAM,OAAsB,CAC1B,UAAU,OAAO,aAAa,OAAO,WACrC,UAAU,OAAO,SAASC,mBAAAA,qBAAqB,mBAAmB,EAAE,GACtE;GACA,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,UAAD;IAEE,OAAO,MAAM;IACb,yBAAyB,EACvB,QAAQ,KAAK,KAAK,EAAE,EACtB;GACD,GALM,MAAM,SAKZ;EAEL,CAAC;EAQD,IAAI,CAACC,sBAAAA,mBAAmB,SAAS,GAAG;GAClC,MAAM,MAAM;GACZ,IAAI,CAAC,IAAI,GAAG,EAAE,aAAa;IAEzB,MAAM,aAAa,GAAG,sBAAiD;KACrE,MAAM,UAAU,kBAAkB,KAAK,eACrC,YAAY,YAAY,UAAU,CACpC;KACA,MAAM,UAAU,OAAO;IACzB;IAIA,UAAU,GAFmC,IAAI,OAAO,CAAC,CAEnC;IAGtB,IAAI,MAAM;KACR,aAAa;KACb,MAAM;IACR;GACF;EACF;EAGA,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,QAAQ,UAAT;GAAkB,OAAO;IAAE;IAAQ;GAAG;GACnC,UAAA,MAAM;EACS,CAAA;CAEtB;CAEA,OAAO;EACL,UAAU;EACV;CACF;AACF"}
+{"version":3,"file":"HydrationStreamProvider.cjs","names":["React","htmlEscapeJsonString","environmentManager"],"sources":["../../src/HydrationStreamProvider.tsx"],"sourcesContent":["'use client'\n\nimport { environmentManager } from '@tanstack/react-query'\nimport { useServerInsertedHTML } from 'next/navigation'\nimport * as React from 'react'\nimport { htmlEscapeJsonString } from './htmlescape'\n\nconst serializedSymbol = Symbol('serialized')\n\ninterface DataTransformer {\n  serialize: (object: any) => any\n  deserialize: (object: any) => any\n}\n\ntype Serialized<TData> = unknown & {\n  [serializedSymbol]: TData\n}\n\ninterface TypedDataTransformer<TData> {\n  serialize: (obj: TData) => Serialized<TData>\n  deserialize: (obj: Serialized<TData>) => TData\n}\n\ninterface HydrationStreamContext<TShape> {\n  id: string\n  stream: {\n    /**\n     * **Server method**\n     * Push a new entry to the stream\n     * Will be ignored on the client\n     */\n    push: (...shape: Array<TShape>) => void\n  }\n}\n\n/**\n * The props of the `Provider` returned by `createHydrationStreamProvider`.\n */\nexport interface HydrationStreamProviderProps<TShape> {\n  /**\n   * The children to render inside the stream provider.\n   */\n  children: React.ReactNode\n  /**\n   * Optional transformer to serialize/deserialize the data\n   * Example devalue, superjson et al\n   */\n  transformer?: DataTransformer\n  /**\n   * **Client method**\n   * Called in the browser when new entries are received\n   */\n  onEntries: (entries: Array<TShape>) => void\n  /**\n   * **Server method**\n   * onFlush is called on the server when the cache is flushed\n   */\n  onFlush?: () => Array<TShape>\n  /**\n   * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n   */\n  nonce?: string\n}\n\n/**\n * Creates a provider that streams entries (e.g. dehydrated query state) from the server to the\n * client while the page streams in, and the context it shares the stream through.\n * @returns The `Provider` component and its `context`.\n */\nexport function createHydrationStreamProvider<TShape>() {\n  const StreamContext = React.createContext<HydrationStreamContext<TShape>>(\n    null as any,\n  )\n  /**\n   * 1. (Happens on server): the callback registered with `useServerInsertedHTML()` is called **on the server** whenever\n   *    Next.js inserts HTML into the streamed response.\n   *    - This means that we might have some new entries in the cache that needs to be flushed.\n   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`.\n   * 2. (Happens in browser) In `useEffect()`:\n   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries.\n   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received.\n   * @param props - The `children` to render, the `onEntries`/`onFlush` callbacks, and the optional\n   * `transformer` and `nonce`.\n   * @returns The `children`, wrapped in the stream context provider.\n   */\n  function UseClientHydrationStreamProvider(props: {\n    children: React.ReactNode\n    /**\n     * Optional transformer to serialize/deserialize the data\n     * Example devalue, superjson et al\n     */\n    transformer?: DataTransformer\n    /**\n     * **Client method**\n     * Called in the browser when new entries are received\n     */\n    onEntries: (entries: Array<TShape>) => void\n    /**\n     * **Server method**\n     * onFlush is called on the server when the cache is flushed\n     */\n    onFlush?: () => Array<TShape>\n    /**\n     * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n     */\n    nonce?: string\n  }) {\n    // unique id for the cache provider\n    const id = `__RQ${React.useId()}`\n    const idJSON = htmlEscapeJsonString(JSON.stringify(id))\n\n    const [transformer] = React.useState(\n      () =>\n        (props.transformer ?? {\n          // noop\n          serialize: (obj: any) => obj,\n          deserialize: (obj: any) => obj,\n        }) as unknown as TypedDataTransformer<TShape>,\n    )\n\n    // <server stuff>\n    const [stream] = React.useState<Array<TShape>>(() => {\n      if (!environmentManager.isServer()) {\n        return {\n          push() {\n            // no-op on the client\n          },\n        } as unknown as Array<TShape>\n      }\n      return []\n    })\n    const countRef = React.useRef(0)\n    useServerInsertedHTML(() => {\n      // This only happens on the server\n      stream.push(...(props.onFlush?.() ?? []))\n\n      if (!stream.length) {\n        return null\n      }\n      // console.log(`pushing ${stream.length} entries`)\n      const serializedCacheArgs = stream\n        .map((entry) => transformer.serialize(entry))\n        .map((entry) => JSON.stringify(entry))\n        .join(',')\n\n      // Flush stream\n      stream.length = 0\n\n      const html: Array<string> = [\n        `window[${idJSON}] = window[${idJSON}] || [];`,\n        `window[${idJSON}].push(${htmlEscapeJsonString(serializedCacheArgs)});`,\n      ]\n      return (\n        <script\n          key={countRef.current++}\n          nonce={props.nonce}\n          dangerouslySetInnerHTML={{\n            __html: html.join(''),\n          }}\n        />\n      )\n    })\n    // </server stuff>\n\n    // <client stuff>\n    // Setup and run the onEntries handler on the client only, but do it during\n    // the initial render so children have access to the data immediately\n    // This is important to avoid the client suspending during the initial render\n    // if the data has not yet been hydrated.\n    if (!environmentManager.isServer()) {\n      const win = window as any\n      if (!win[id]?.initialized) {\n        // Client: consume cache:\n        const onEntries = (...serializedEntries: Array<Serialized<TShape>>) => {\n          const entries = serializedEntries.map((serialized) =>\n            transformer.deserialize(serialized),\n          )\n          props.onEntries(entries)\n        }\n\n        const winStream: Array<Serialized<TShape>> = win[id] ?? []\n\n        onEntries(...winStream)\n\n        win[id] = {\n          initialized: true,\n          push: onEntries,\n        }\n      }\n    }\n    // </client stuff>\n\n    return (\n      <StreamContext.Provider value={{ stream, id }}>\n        {props.children}\n      </StreamContext.Provider>\n    )\n  }\n\n  return {\n    Provider: UseClientHydrationStreamProvider,\n    context: StreamContext,\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AAqEA,SAAgB,gCAAwC;CACtD,MAAM,gBAAgBA,MAAM,cAC1B,IACF;;;;;;;;;;;;;CAaA,SAAS,iCAAiC,OAqBvC;EAED,MAAM,KAAK,OAAOA,MAAM,MAAM;EAC9B,MAAM,SAASC,mBAAAA,qBAAqB,KAAK,UAAU,EAAE,CAAC;EAEtD,MAAM,CAAC,eAAeD,MAAM,eAEvB,MAAM,eAAe;GAEpB,YAAY,QAAa;GACzB,cAAc,QAAa;EAC7B,CACJ;EAGA,MAAM,CAAC,UAAUA,MAAM,eAA8B;GACnD,IAAI,CAACE,sBAAAA,mBAAmB,SAAS,GAC/B,OAAO,EACL,OAAO,CAEP,EACF;GAEF,OAAO,CAAC;EACV,CAAC;EACD,MAAM,WAAWF,MAAM,OAAO,CAAC;EAC/B,CAAA,GAAA,gBAAA,sBAAA,OAA4B;GAE1B,OAAO,KAAK,GAAI,MAAM,UAAU,KAAK,CAAC,CAAE;GAExC,IAAI,CAAC,OAAO,QACV,OAAO;GAGT,MAAM,sBAAsB,OACzB,KAAK,UAAU,YAAY,UAAU,KAAK,CAAC,CAAC,CAC5C,KAAK,UAAU,KAAK,UAAU,KAAK,CAAC,CAAC,CACrC,KAAK,GAAG;GAGX,OAAO,SAAS;GAEhB,MAAM,OAAsB,CAC1B,UAAU,OAAO,aAAa,OAAO,WACrC,UAAU,OAAO,SAASC,mBAAAA,qBAAqB,mBAAmB,EAAE,GACtE;GACA,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,UAAD;IAEE,OAAO,MAAM;IACb,yBAAyB,EACvB,QAAQ,KAAK,KAAK,EAAE,EACtB;GACD,GALM,SAAS,SAKf;EAEL,CAAC;EAQD,IAAI,CAACC,sBAAAA,mBAAmB,SAAS,GAAG;GAClC,MAAM,MAAM;GACZ,IAAI,CAAC,IAAI,GAAG,EAAE,aAAa;IAEzB,MAAM,aAAa,GAAG,sBAAiD;KACrE,MAAM,UAAU,kBAAkB,KAAK,eACrC,YAAY,YAAY,UAAU,CACpC;KACA,MAAM,UAAU,OAAO;IACzB;IAIA,UAAU,GAFmC,IAAI,OAAO,CAAC,CAEnC;IAEtB,IAAI,MAAM;KACR,aAAa;KACb,MAAM;IACR;GACF;EACF;EAGA,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,cAAc,UAAf;GAAwB,OAAO;IAAE;IAAQ;GAAG;GACzC,UAAA,MAAM;EACe,CAAA;CAE5B;CAEA,OAAO;EACL,UAAU;EACV,SAAS;CACX;AACF"}

package/build/modern/HydrationStreamProvider.d.cts

@@ -1,2 +1,2 @@
-import { n as createHydrationStreamProvider, t as HydrationStreamProviderProps } from "./HydrationStreamProvider-D_lqnUNo.cjs";
+import { n as createHydrationStreamProvider, t as HydrationStreamProviderProps } from "./HydrationStreamProvider-DrbxOdk5.cjs";
 export { HydrationStreamProviderProps, createHydrationStreamProvider };

package/build/modern/HydrationStreamProvider.d.ts

@@ -1,2 +1,2 @@
-import { n as createHydrationStreamProvider, t as HydrationStreamProviderProps } from "./HydrationStreamProvider-D_lqnUNo.js";
+import { n as createHydrationStreamProvider, t as HydrationStreamProviderProps } from "./HydrationStreamProvider-DrbxOdk5.js";
 export { HydrationStreamProviderProps, createHydrationStreamProvider };

package/build/modern/HydrationStreamProvider.js

@@ -5,17 +5,25 @@ import { useServerInsertedHTML } from "next/navigation";
 import * as React from "react";
 import { jsx } from "react/jsx-runtime";
 //#region src/HydrationStreamProvider.tsx
+/**
+* Creates a provider that streams entries (e.g. dehydrated query state) from the server to the
+* client while the page streams in, and the context it shares the stream through.
+* @returns The `Provider` component and its `context`.
+*/
 function createHydrationStreamProvider() {
-	const context = React.createContext(null);
+	const StreamContext = React.createContext(null);
 	/**
-	
-	* 1. (Happens on server): `useServerInsertedHTML()` is called **on the server** whenever a `Suspense`-boundary completes
-	*    - This means that we might have some new entries in the cache that needs to be flushed
-	*    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`
+	* 1. (Happens on server): the callback registered with `useServerInsertedHTML()` is called **on the server** whenever
+	*    Next.js inserts HTML into the streamed response.
+	*    - This means that we might have some new entries in the cache that needs to be flushed.
+	*    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`.
 	* 2. (Happens in browser) In `useEffect()`:
-	*   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries
-	*   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received
-	**/
+	*   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries.
+	*   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received.
+	* @param props - The `children` to render, the `onEntries`/`onFlush` callbacks, and the optional
+	* `transformer` and `nonce`.
+	* @returns The `children`, wrapped in the stream context provider.
+	*/
 	function UseClientHydrationStreamProvider(props) {
 		const id = `__RQ${React.useId()}`;
 		const idJSON = htmlEscapeJsonString(JSON.stringify(id));
@@ -27,7 +35,7 @@ function createHydrationStreamProvider() {
 			if (!environmentManager.isServer()) return { push() {} };
 			return [];
 		});
-		const count = React.useRef(0);
+		const countRef = React.useRef(0);
 		useServerInsertedHTML(() => {
 			stream.push(...props.onFlush?.() ?? []);
 			if (!stream.length) return null;
@@ -37,7 +45,7 @@ function createHydrationStreamProvider() {
 			return /* @__PURE__ */ jsx("script", {
 				nonce: props.nonce,
 				dangerouslySetInnerHTML: { __html: html.join("") }
-			}, count.current++);
+			}, countRef.current++);
 		});
 		if (!environmentManager.isServer()) {
 			const win = window;
@@ -53,7 +61,7 @@ function createHydrationStreamProvider() {
 				};
 			}
 		}
-		return /* @__PURE__ */ jsx(context.Provider, {
+		return /* @__PURE__ */ jsx(StreamContext.Provider, {
 			value: {
 				stream,
 				id
@@ -63,7 +71,7 @@ function createHydrationStreamProvider() {
 	}
 	return {
 		Provider: UseClientHydrationStreamProvider,
-		context
+		context: StreamContext
 	};
 }
 //#endregion

package/build/modern/HydrationStreamProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"HydrationStreamProvider.js","names":[],"sources":["../../src/HydrationStreamProvider.tsx"],"sourcesContent":["'use client'\n\nimport { environmentManager } from '@tanstack/react-query'\nimport { useServerInsertedHTML } from 'next/navigation'\nimport * as React from 'react'\nimport { htmlEscapeJsonString } from './htmlescape'\n\nconst serializedSymbol = Symbol('serialized')\n\ninterface DataTransformer {\n  serialize: (object: any) => any\n  deserialize: (object: any) => any\n}\n\ntype Serialized<TData> = unknown & {\n  [serializedSymbol]: TData\n}\n\ninterface TypedDataTransformer<TData> {\n  serialize: (obj: TData) => Serialized<TData>\n  deserialize: (obj: Serialized<TData>) => TData\n}\n\ninterface HydrationStreamContext<TShape> {\n  id: string\n  stream: {\n    /**\n     * **Server method**\n     * Push a new entry to the stream\n     * Will be ignored on the client\n     */\n    push: (...shape: Array<TShape>) => void\n  }\n}\n\nexport interface HydrationStreamProviderProps<TShape> {\n  children: React.ReactNode\n  /**\n   * Optional transformer to serialize/deserialize the data\n   * Example devalue, superjson et al\n   */\n  transformer?: DataTransformer\n  /**\n   * **Client method**\n   * Called in the browser when new entries are received\n   */\n  onEntries: (entries: Array<TShape>) => void\n  /**\n   * **Server method**\n   * onFlush is called on the server when the cache is flushed\n   */\n  onFlush?: () => Array<TShape>\n  /**\n   * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n   */\n  nonce?: string\n}\n\nexport function createHydrationStreamProvider<TShape>() {\n  const context = React.createContext<HydrationStreamContext<TShape>>(\n    null as any,\n  )\n  /**\n\n   * 1. (Happens on server): `useServerInsertedHTML()` is called **on the server** whenever a `Suspense`-boundary completes\n   *    - This means that we might have some new entries in the cache that needs to be flushed\n   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`\n   * 2. (Happens in browser) In `useEffect()`:\n   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries\n   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received\n   **/\n  function UseClientHydrationStreamProvider(props: {\n    children: React.ReactNode\n    /**\n     * Optional transformer to serialize/deserialize the data\n     * Example devalue, superjson et al\n     */\n    transformer?: DataTransformer\n    /**\n     * **Client method**\n     * Called in the browser when new entries are received\n     */\n    onEntries: (entries: Array<TShape>) => void\n    /**\n     * **Server method**\n     * onFlush is called on the server when the cache is flushed\n     */\n    onFlush?: () => Array<TShape>\n    /**\n     * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n     */\n    nonce?: string\n  }) {\n    // unique id for the cache provider\n    const id = `__RQ${React.useId()}`\n    const idJSON = htmlEscapeJsonString(JSON.stringify(id))\n\n    const [transformer] = React.useState(\n      () =>\n        (props.transformer ?? {\n          // noop\n          serialize: (obj: any) => obj,\n          deserialize: (obj: any) => obj,\n        }) as unknown as TypedDataTransformer<TShape>,\n    )\n\n    // <server stuff>\n    const [stream] = React.useState<Array<TShape>>(() => {\n      if (!environmentManager.isServer()) {\n        return {\n          push() {\n            // no-op on the client\n          },\n        } as unknown as Array<TShape>\n      }\n      return []\n    })\n    const count = React.useRef(0)\n    useServerInsertedHTML(() => {\n      // This only happens on the server\n      stream.push(...(props.onFlush?.() ?? []))\n\n      if (!stream.length) {\n        return null\n      }\n      // console.log(`pushing ${stream.length} entries`)\n      const serializedCacheArgs = stream\n        .map((entry) => transformer.serialize(entry))\n        .map((entry) => JSON.stringify(entry))\n        .join(',')\n\n      // Flush stream\n      // eslint-disable-next-line react-hooks/immutability\n      stream.length = 0\n\n      const html: Array<string> = [\n        `window[${idJSON}] = window[${idJSON}] || [];`,\n        `window[${idJSON}].push(${htmlEscapeJsonString(serializedCacheArgs)});`,\n      ]\n      return (\n        <script\n          key={count.current++}\n          nonce={props.nonce}\n          dangerouslySetInnerHTML={{\n            __html: html.join(''),\n          }}\n        />\n      )\n    })\n    // </server stuff>\n\n    // <client stuff>\n    // Setup and run the onEntries handler on the client only, but do it during\n    // the initial render so children have access to the data immediately\n    // This is important to avoid the client suspending during the initial render\n    // if the data has not yet been hydrated.\n    if (!environmentManager.isServer()) {\n      const win = window as any\n      if (!win[id]?.initialized) {\n        // Client: consume cache:\n        const onEntries = (...serializedEntries: Array<Serialized<TShape>>) => {\n          const entries = serializedEntries.map((serialized) =>\n            transformer.deserialize(serialized),\n          )\n          props.onEntries(entries)\n        }\n\n        const winStream: Array<Serialized<TShape>> = win[id] ?? []\n\n        onEntries(...winStream)\n\n        // eslint-disable-next-line react-hooks/immutability\n        win[id] = {\n          initialized: true,\n          push: onEntries,\n        }\n      }\n    }\n    // </client stuff>\n\n    return (\n      <context.Provider value={{ stream, id }}>\n        {props.children}\n      </context.Provider>\n    )\n  }\n\n  return {\n    Provider: UseClientHydrationStreamProvider,\n    context,\n  }\n}\n"],"mappings":";;;;;;;AA0DA,SAAgB,gCAAwC;CACtD,MAAM,UAAU,MAAM,cACpB,IACF;;;;;;;;;;CAUA,SAAS,iCAAiC,OAqBvC;EAED,MAAM,KAAK,OAAO,MAAM,MAAM;EAC9B,MAAM,SAAS,qBAAqB,KAAK,UAAU,EAAE,CAAC;EAEtD,MAAM,CAAC,eAAe,MAAM,eAEvB,MAAM,eAAe;GAEpB,YAAY,QAAa;GACzB,cAAc,QAAa;EAC7B,CACJ;EAGA,MAAM,CAAC,UAAU,MAAM,eAA8B;GACnD,IAAI,CAAC,mBAAmB,SAAS,GAC/B,OAAO,EACL,OAAO,CAEP,EACF;GAEF,OAAO,CAAC;EACV,CAAC;EACD,MAAM,QAAQ,MAAM,OAAO,CAAC;EAC5B,4BAA4B;GAE1B,OAAO,KAAK,GAAI,MAAM,UAAU,KAAK,CAAC,CAAE;GAExC,IAAI,CAAC,OAAO,QACV,OAAO;GAGT,MAAM,sBAAsB,OACzB,KAAK,UAAU,YAAY,UAAU,KAAK,CAAC,CAAC,CAC5C,KAAK,UAAU,KAAK,UAAU,KAAK,CAAC,CAAC,CACrC,KAAK,GAAG;GAIX,OAAO,SAAS;GAEhB,MAAM,OAAsB,CAC1B,UAAU,OAAO,aAAa,OAAO,WACrC,UAAU,OAAO,SAAS,qBAAqB,mBAAmB,EAAE,GACtE;GACA,OACE,oBAAC,UAAD;IAEE,OAAO,MAAM;IACb,yBAAyB,EACvB,QAAQ,KAAK,KAAK,EAAE,EACtB;GACD,GALM,MAAM,SAKZ;EAEL,CAAC;EAQD,IAAI,CAAC,mBAAmB,SAAS,GAAG;GAClC,MAAM,MAAM;GACZ,IAAI,CAAC,IAAI,GAAG,EAAE,aAAa;IAEzB,MAAM,aAAa,GAAG,sBAAiD;KACrE,MAAM,UAAU,kBAAkB,KAAK,eACrC,YAAY,YAAY,UAAU,CACpC;KACA,MAAM,UAAU,OAAO;IACzB;IAIA,UAAU,GAFmC,IAAI,OAAO,CAAC,CAEnC;IAGtB,IAAI,MAAM;KACR,aAAa;KACb,MAAM;IACR;GACF;EACF;EAGA,OACE,oBAAC,QAAQ,UAAT;GAAkB,OAAO;IAAE;IAAQ;GAAG;GACnC,UAAA,MAAM;EACS,CAAA;CAEtB;CAEA,OAAO;EACL,UAAU;EACV;CACF;AACF"}
+{"version":3,"file":"HydrationStreamProvider.js","names":[],"sources":["../../src/HydrationStreamProvider.tsx"],"sourcesContent":["'use client'\n\nimport { environmentManager } from '@tanstack/react-query'\nimport { useServerInsertedHTML } from 'next/navigation'\nimport * as React from 'react'\nimport { htmlEscapeJsonString } from './htmlescape'\n\nconst serializedSymbol = Symbol('serialized')\n\ninterface DataTransformer {\n  serialize: (object: any) => any\n  deserialize: (object: any) => any\n}\n\ntype Serialized<TData> = unknown & {\n  [serializedSymbol]: TData\n}\n\ninterface TypedDataTransformer<TData> {\n  serialize: (obj: TData) => Serialized<TData>\n  deserialize: (obj: Serialized<TData>) => TData\n}\n\ninterface HydrationStreamContext<TShape> {\n  id: string\n  stream: {\n    /**\n     * **Server method**\n     * Push a new entry to the stream\n     * Will be ignored on the client\n     */\n    push: (...shape: Array<TShape>) => void\n  }\n}\n\n/**\n * The props of the `Provider` returned by `createHydrationStreamProvider`.\n */\nexport interface HydrationStreamProviderProps<TShape> {\n  /**\n   * The children to render inside the stream provider.\n   */\n  children: React.ReactNode\n  /**\n   * Optional transformer to serialize/deserialize the data\n   * Example devalue, superjson et al\n   */\n  transformer?: DataTransformer\n  /**\n   * **Client method**\n   * Called in the browser when new entries are received\n   */\n  onEntries: (entries: Array<TShape>) => void\n  /**\n   * **Server method**\n   * onFlush is called on the server when the cache is flushed\n   */\n  onFlush?: () => Array<TShape>\n  /**\n   * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n   */\n  nonce?: string\n}\n\n/**\n * Creates a provider that streams entries (e.g. dehydrated query state) from the server to the\n * client while the page streams in, and the context it shares the stream through.\n * @returns The `Provider` component and its `context`.\n */\nexport function createHydrationStreamProvider<TShape>() {\n  const StreamContext = React.createContext<HydrationStreamContext<TShape>>(\n    null as any,\n  )\n  /**\n   * 1. (Happens on server): the callback registered with `useServerInsertedHTML()` is called **on the server** whenever\n   *    Next.js inserts HTML into the streamed response.\n   *    - This means that we might have some new entries in the cache that needs to be flushed.\n   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`.\n   * 2. (Happens in browser) In `useEffect()`:\n   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries.\n   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received.\n   * @param props - The `children` to render, the `onEntries`/`onFlush` callbacks, and the optional\n   * `transformer` and `nonce`.\n   * @returns The `children`, wrapped in the stream context provider.\n   */\n  function UseClientHydrationStreamProvider(props: {\n    children: React.ReactNode\n    /**\n     * Optional transformer to serialize/deserialize the data\n     * Example devalue, superjson et al\n     */\n    transformer?: DataTransformer\n    /**\n     * **Client method**\n     * Called in the browser when new entries are received\n     */\n    onEntries: (entries: Array<TShape>) => void\n    /**\n     * **Server method**\n     * onFlush is called on the server when the cache is flushed\n     */\n    onFlush?: () => Array<TShape>\n    /**\n     * A nonce that'll allow the inline script to be executed when Content Security Policy is enforced\n     */\n    nonce?: string\n  }) {\n    // unique id for the cache provider\n    const id = `__RQ${React.useId()}`\n    const idJSON = htmlEscapeJsonString(JSON.stringify(id))\n\n    const [transformer] = React.useState(\n      () =>\n        (props.transformer ?? {\n          // noop\n          serialize: (obj: any) => obj,\n          deserialize: (obj: any) => obj,\n        }) as unknown as TypedDataTransformer<TShape>,\n    )\n\n    // <server stuff>\n    const [stream] = React.useState<Array<TShape>>(() => {\n      if (!environmentManager.isServer()) {\n        return {\n          push() {\n            // no-op on the client\n          },\n        } as unknown as Array<TShape>\n      }\n      return []\n    })\n    const countRef = React.useRef(0)\n    useServerInsertedHTML(() => {\n      // This only happens on the server\n      stream.push(...(props.onFlush?.() ?? []))\n\n      if (!stream.length) {\n        return null\n      }\n      // console.log(`pushing ${stream.length} entries`)\n      const serializedCacheArgs = stream\n        .map((entry) => transformer.serialize(entry))\n        .map((entry) => JSON.stringify(entry))\n        .join(',')\n\n      // Flush stream\n      stream.length = 0\n\n      const html: Array<string> = [\n        `window[${idJSON}] = window[${idJSON}] || [];`,\n        `window[${idJSON}].push(${htmlEscapeJsonString(serializedCacheArgs)});`,\n      ]\n      return (\n        <script\n          key={countRef.current++}\n          nonce={props.nonce}\n          dangerouslySetInnerHTML={{\n            __html: html.join(''),\n          }}\n        />\n      )\n    })\n    // </server stuff>\n\n    // <client stuff>\n    // Setup and run the onEntries handler on the client only, but do it during\n    // the initial render so children have access to the data immediately\n    // This is important to avoid the client suspending during the initial render\n    // if the data has not yet been hydrated.\n    if (!environmentManager.isServer()) {\n      const win = window as any\n      if (!win[id]?.initialized) {\n        // Client: consume cache:\n        const onEntries = (...serializedEntries: Array<Serialized<TShape>>) => {\n          const entries = serializedEntries.map((serialized) =>\n            transformer.deserialize(serialized),\n          )\n          props.onEntries(entries)\n        }\n\n        const winStream: Array<Serialized<TShape>> = win[id] ?? []\n\n        onEntries(...winStream)\n\n        win[id] = {\n          initialized: true,\n          push: onEntries,\n        }\n      }\n    }\n    // </client stuff>\n\n    return (\n      <StreamContext.Provider value={{ stream, id }}>\n        {props.children}\n      </StreamContext.Provider>\n    )\n  }\n\n  return {\n    Provider: UseClientHydrationStreamProvider,\n    context: StreamContext,\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAqEA,SAAgB,gCAAwC;CACtD,MAAM,gBAAgB,MAAM,cAC1B,IACF;;;;;;;;;;;;;CAaA,SAAS,iCAAiC,OAqBvC;EAED,MAAM,KAAK,OAAO,MAAM,MAAM;EAC9B,MAAM,SAAS,qBAAqB,KAAK,UAAU,EAAE,CAAC;EAEtD,MAAM,CAAC,eAAe,MAAM,eAEvB,MAAM,eAAe;GAEpB,YAAY,QAAa;GACzB,cAAc,QAAa;EAC7B,CACJ;EAGA,MAAM,CAAC,UAAU,MAAM,eAA8B;GACnD,IAAI,CAAC,mBAAmB,SAAS,GAC/B,OAAO,EACL,OAAO,CAEP,EACF;GAEF,OAAO,CAAC;EACV,CAAC;EACD,MAAM,WAAW,MAAM,OAAO,CAAC;EAC/B,4BAA4B;GAE1B,OAAO,KAAK,GAAI,MAAM,UAAU,KAAK,CAAC,CAAE;GAExC,IAAI,CAAC,OAAO,QACV,OAAO;GAGT,MAAM,sBAAsB,OACzB,KAAK,UAAU,YAAY,UAAU,KAAK,CAAC,CAAC,CAC5C,KAAK,UAAU,KAAK,UAAU,KAAK,CAAC,CAAC,CACrC,KAAK,GAAG;GAGX,OAAO,SAAS;GAEhB,MAAM,OAAsB,CAC1B,UAAU,OAAO,aAAa,OAAO,WACrC,UAAU,OAAO,SAAS,qBAAqB,mBAAmB,EAAE,GACtE;GACA,OACE,oBAAC,UAAD;IAEE,OAAO,MAAM;IACb,yBAAyB,EACvB,QAAQ,KAAK,KAAK,EAAE,EACtB;GACD,GALM,SAAS,SAKf;EAEL,CAAC;EAQD,IAAI,CAAC,mBAAmB,SAAS,GAAG;GAClC,MAAM,MAAM;GACZ,IAAI,CAAC,IAAI,GAAG,EAAE,aAAa;IAEzB,MAAM,aAAa,GAAG,sBAAiD;KACrE,MAAM,UAAU,kBAAkB,KAAK,eACrC,YAAY,YAAY,UAAU,CACpC;KACA,MAAM,UAAU,OAAO;IACzB;IAIA,UAAU,GAFmC,IAAI,OAAO,CAAC,CAEnC;IAEtB,IAAI,MAAM;KACR,aAAa;KACb,MAAM;IACR;GACF;EACF;EAGA,OACE,oBAAC,cAAc,UAAf;GAAwB,OAAO;IAAE;IAAQ;GAAG;GACzC,UAAA,MAAM;EACe,CAAA;CAE5B;CAEA,OAAO;EACL,UAAU;EACV,SAAS;CACX;AACF"}

package/build/modern/ReactQueryStreamedHydration.cjs

@@ -10,8 +10,11 @@ let react_jsx_runtime = require("react/jsx-runtime");
 const stream = require_HydrationStreamProvider.createHydrationStreamProvider();
 /**
 * This component is responsible for:
-* - hydrating the query client on the server
-* - dehydrating the query client on the server
+* - dehydrating the query client on the server.
+* - hydrating the query client in the browser.
+* @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the
+* inline script, the hydrate and dehydrate `options`, and the data `transformer`.
+* @returns The `children`, wrapped in the hydration stream provider.
 */
 function ReactQueryStreamedHydration(props) {
 	const queryClient = (0, _tanstack_react_query.useQueryClient)(props.queryClient);

package/build/modern/ReactQueryStreamedHydration.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ReactQueryStreamedHydration.cjs","names":["createHydrationStreamProvider","useQueryClient","React","environmentManager","defaultShouldDehydrateQuery","dehydrate"],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"sourcesContent":["'use client'\n\nimport {\n  defaultShouldDehydrateQuery,\n  dehydrate,\n  environmentManager,\n  hydrate,\n  useQueryClient,\n} from '@tanstack/react-query'\nimport * as React from 'react'\nimport { createHydrationStreamProvider } from './HydrationStreamProvider'\nimport type { HydrationStreamProviderProps } from './HydrationStreamProvider'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  QueryClient,\n} from '@tanstack/react-query'\n\nconst stream = createHydrationStreamProvider<DehydratedState>()\n\n/**\n * This component is responsible for:\n * - hydrating the query client on the server\n * - dehydrating the query client on the server\n */\nexport function ReactQueryStreamedHydration(props: {\n  children: React.ReactNode\n  queryClient?: QueryClient\n  nonce?: string\n  options?: {\n    hydrate?: HydrateOptions\n    dehydrate?: DehydrateOptions\n  }\n  transformer?: HydrationStreamProviderProps<DehydratedState>['transformer']\n}) {\n  const queryClient = useQueryClient(props.queryClient)\n\n  /**\n   * We need to track which queries were added/updated during the render\n   */\n  const [trackedKeys] = React.useState(() => new Set<string>())\n\n  // <server only>\n  if (environmentManager.isServer()) {\n    // Do we need to care about unsubscribing? I don't think so to be honest\n    queryClient.getQueryCache().subscribe((event) => {\n      switch (event.type) {\n        case 'added':\n        case 'updated':\n          // console.log('tracking', event.query.queryHash, 'b/c of a', event.type)\n          trackedKeys.add(event.query.queryHash)\n      }\n    })\n  }\n  // </server only>\n\n  return (\n    <stream.Provider\n      // Happens on server:\n      onFlush={() => {\n        /**\n         * Dehydrated state of the client where we only include the queries that were added/updated since the last flush\n         */\n        const shouldDehydrate =\n          props.options?.dehydrate?.shouldDehydrateQuery ??\n          defaultShouldDehydrateQuery\n\n        const dehydratedState = dehydrate(queryClient, {\n          ...props.options?.dehydrate,\n          shouldDehydrateQuery(query) {\n            return trackedKeys.has(query.queryHash) && shouldDehydrate(query)\n          },\n        })\n        trackedKeys.clear()\n\n        if (!dehydratedState.queries.length) {\n          return []\n        }\n\n        return [dehydratedState]\n      }}\n      // Happens in browser:\n      onEntries={(entries) => {\n        for (const hydratedState of entries) {\n          hydrate(queryClient, hydratedState, props.options?.hydrate)\n        }\n      }}\n      // Handle BigInts etc using superjson\n      transformer={props.transformer}\n      nonce={props.nonce}\n    >\n      {props.children}\n    </stream.Provider>\n  )\n}\n"],"mappings":";;;;;;;;;AAmBA,MAAM,SAASA,gCAAAA,8BAA+C;;;;;;AAO9D,SAAgB,4BAA4B,OASzC;CACD,MAAM,eAAA,GAAcC,sBAAAA,eAAAA,CAAe,MAAM,WAAW;;;;CAKpD,MAAM,CAAC,eAAeC,MAAM,+BAAe,IAAI,IAAY,CAAC;CAG5D,IAAIC,sBAAAA,mBAAmB,SAAS,GAE9B,YAAY,cAAc,CAAC,CAAC,WAAW,UAAU;EAC/C,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK,WAEH,YAAY,IAAI,MAAM,MAAM,SAAS;EACzC;CACF,CAAC;CAIH,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,OAAO,UAAR;EAEE,eAAe;;;;GAIb,MAAM,kBACJ,MAAM,SAAS,WAAW,wBAC1BC,sBAAAA;GAEF,MAAM,mBAAA,GAAkBC,sBAAAA,UAAAA,CAAU,aAAa;IAC7C,GAAG,MAAM,SAAS;IAClB,qBAAqB,OAAO;KAC1B,OAAO,YAAY,IAAI,MAAM,SAAS,KAAK,gBAAgB,KAAK;IAClE;GACF,CAAC;GACD,YAAY,MAAM;GAElB,IAAI,CAAC,gBAAgB,QAAQ,QAC3B,OAAO,CAAC;GAGV,OAAO,CAAC,eAAe;EACzB;EAEA,YAAY,YAAY;GACtB,KAAK,MAAM,iBAAiB,SAC1B,CAAA,GAAA,sBAAA,QAAA,CAAQ,aAAa,eAAe,MAAM,SAAS,OAAO;EAE9D;EAEA,aAAa,MAAM;EACnB,OAAO,MAAM;EAEZ,UAAA,MAAM;CACQ,CAAA;AAErB"}
+{"version":3,"file":"ReactQueryStreamedHydration.cjs","names":["createHydrationStreamProvider","useQueryClient","React","environmentManager","defaultShouldDehydrateQuery","dehydrate"],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"sourcesContent":["'use client'\n\nimport {\n  defaultShouldDehydrateQuery,\n  dehydrate,\n  environmentManager,\n  hydrate,\n  useQueryClient,\n} from '@tanstack/react-query'\nimport * as React from 'react'\nimport { createHydrationStreamProvider } from './HydrationStreamProvider'\nimport type { HydrationStreamProviderProps } from './HydrationStreamProvider'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  QueryClient,\n} from '@tanstack/react-query'\n\nconst stream = createHydrationStreamProvider<DehydratedState>()\n\n/**\n * This component is responsible for:\n * - dehydrating the query client on the server.\n * - hydrating the query client in the browser.\n * @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the\n * inline script, the hydrate and dehydrate `options`, and the data `transformer`.\n * @returns The `children`, wrapped in the hydration stream provider.\n */\nexport function ReactQueryStreamedHydration(props: {\n  children: React.ReactNode\n  queryClient?: QueryClient\n  nonce?: string\n  options?: {\n    hydrate?: HydrateOptions\n    dehydrate?: DehydrateOptions\n  }\n  transformer?: HydrationStreamProviderProps<DehydratedState>['transformer']\n}) {\n  const queryClient = useQueryClient(props.queryClient)\n\n  /**\n   * We need to track which queries were added/updated during the render\n   */\n  const [trackedKeys] = React.useState(() => new Set<string>())\n\n  // <server only>\n  if (environmentManager.isServer()) {\n    // Do we need to care about unsubscribing? I don't think so to be honest\n    queryClient.getQueryCache().subscribe((event) => {\n      switch (event.type) {\n        case 'added':\n        case 'updated':\n          // console.log('tracking', event.query.queryHash, 'b/c of a', event.type)\n          trackedKeys.add(event.query.queryHash)\n      }\n    })\n  }\n  // </server only>\n\n  return (\n    <stream.Provider\n      // Happens on server:\n      onFlush={() => {\n        /**\n         * Dehydrated state of the client where we only include the queries that were added/updated since the last flush\n         */\n        const shouldDehydrate =\n          props.options?.dehydrate?.shouldDehydrateQuery ??\n          defaultShouldDehydrateQuery\n\n        const dehydratedState = dehydrate(queryClient, {\n          ...props.options?.dehydrate,\n          shouldDehydrateQuery(query) {\n            return trackedKeys.has(query.queryHash) && shouldDehydrate(query)\n          },\n        })\n        trackedKeys.clear()\n\n        if (!dehydratedState.queries.length) {\n          return []\n        }\n\n        return [dehydratedState]\n      }}\n      // Happens in browser:\n      onEntries={(entries) => {\n        for (const hydratedState of entries) {\n          hydrate(queryClient, hydratedState, props.options?.hydrate)\n        }\n      }}\n      // Handle BigInts etc using superjson\n      transformer={props.transformer}\n      nonce={props.nonce}\n    >\n      {props.children}\n    </stream.Provider>\n  )\n}\n"],"mappings":";;;;;;;;;AAmBA,MAAM,SAASA,gCAAAA,8BAA+C;;;;;;;;;AAU9D,SAAgB,4BAA4B,OASzC;CACD,MAAM,eAAA,GAAcC,sBAAAA,eAAAA,CAAe,MAAM,WAAW;;;;CAKpD,MAAM,CAAC,eAAeC,MAAM,+BAAe,IAAI,IAAY,CAAC;CAG5D,IAAIC,sBAAAA,mBAAmB,SAAS,GAE9B,YAAY,cAAc,CAAC,CAAC,WAAW,UAAU;EAC/C,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK,WAEH,YAAY,IAAI,MAAM,MAAM,SAAS;EACzC;CACF,CAAC;CAIH,OACE,iBAAA,GAAA,kBAAA,IAAA,CAAC,OAAO,UAAR;EAEE,eAAe;;;;GAIb,MAAM,kBACJ,MAAM,SAAS,WAAW,wBAC1BC,sBAAAA;GAEF,MAAM,mBAAA,GAAkBC,sBAAAA,UAAAA,CAAU,aAAa;IAC7C,GAAG,MAAM,SAAS;IAClB,qBAAqB,OAAO;KAC1B,OAAO,YAAY,IAAI,MAAM,SAAS,KAAK,gBAAgB,KAAK;IAClE;GACF,CAAC;GACD,YAAY,MAAM;GAElB,IAAI,CAAC,gBAAgB,QAAQ,QAC3B,OAAO,CAAC;GAGV,OAAO,CAAC,eAAe;EACzB;EAEA,YAAY,YAAY;GACtB,KAAK,MAAM,iBAAiB,SAC1B,CAAA,GAAA,sBAAA,QAAA,CAAQ,aAAa,eAAe,MAAM,SAAS,OAAO;EAE9D;EAEA,aAAa,MAAM;EACnB,OAAO,MAAM;EAEZ,UAAA,MAAM;CACQ,CAAA;AAErB"}

package/build/modern/ReactQueryStreamedHydration.d.cts

@@ -1,11 +1,14 @@
-import { t as HydrationStreamProviderProps } from "./HydrationStreamProvider-D_lqnUNo.cjs";
+import { t as HydrationStreamProviderProps } from "./HydrationStreamProvider-DrbxOdk5.cjs";
 import * as React from "react";
 import { DehydrateOptions, DehydratedState, HydrateOptions, QueryClient } from "@tanstack/react-query";
 //#region src/ReactQueryStreamedHydration.d.ts
 /**
  * This component is responsible for:
- * - hydrating the query client on the server
- * - dehydrating the query client on the server
+ * - dehydrating the query client on the server.
+ * - hydrating the query client in the browser.
+ * @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the
+ * inline script, the hydrate and dehydrate `options`, and the data `transformer`.
+ * @returns The `children`, wrapped in the hydration stream provider.
  */
 export declare function ReactQueryStreamedHydration(props: {
   children: React.ReactNode;

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

@@ -1 +1 @@
-{"version":3,"file":"ReactQueryStreamedHydration.d.cts","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"mappings":";;;;;;;;;wBA0BgB,4BAA4B;EAC1C,UAAU,MAAM;EAChB,cAAc;EACd;EACA;IACE,UAAU;IACV,YAAY;;EAEd,cAAc,6BAA6B;gCAC5C,IAAA"}
+{"version":3,"file":"ReactQueryStreamedHydration.d.cts","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"mappings":";;;;;;;;;;;;wBA6BgB,4BAA4B;EAC1C,UAAU,MAAM;EAChB,cAAc;EACd;EACA;IACE,UAAU;IACV,YAAY;;EAEd,cAAc,6BAA6B;gCAC5C,IAAA"}

package/build/modern/ReactQueryStreamedHydration.d.ts

@@ -1,11 +1,14 @@
-import { t as HydrationStreamProviderProps } from "./HydrationStreamProvider-D_lqnUNo.js";
+import { t as HydrationStreamProviderProps } from "./HydrationStreamProvider-DrbxOdk5.js";
 import { DehydrateOptions, DehydratedState, HydrateOptions, QueryClient } from "@tanstack/react-query";
 import * as React from "react";
 //#region src/ReactQueryStreamedHydration.d.ts
 /**
  * This component is responsible for:
- * - hydrating the query client on the server
- * - dehydrating the query client on the server
+ * - dehydrating the query client on the server.
+ * - hydrating the query client in the browser.
+ * @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the
+ * inline script, the hydrate and dehydrate `options`, and the data `transformer`.
+ * @returns The `children`, wrapped in the hydration stream provider.
  */
 export declare function ReactQueryStreamedHydration(props: {
   children: React.ReactNode;

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

@@ -1 +1 @@
-{"version":3,"file":"ReactQueryStreamedHydration.d.ts","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"mappings":";;;;;;;;;wBA0BgB,4BAA4B;EAC1C,UAAU,MAAM;EAChB,cAAc;EACd;EACA;IACE,UAAU;IACV,YAAY;;EAEd,cAAc,6BAA6B;gCAC5C,IAAA"}
+{"version":3,"file":"ReactQueryStreamedHydration.d.ts","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"mappings":";;;;;;;;;;;;wBA6BgB,4BAA4B;EAC1C,UAAU,MAAM;EAChB,cAAc;EACd;EACA;IACE,UAAU;IACV,YAAY;;EAEd,cAAc,6BAA6B;gCAC5C,IAAA"}

package/build/modern/ReactQueryStreamedHydration.js

@@ -7,8 +7,11 @@ import { jsx } from "react/jsx-runtime";
 const stream = createHydrationStreamProvider();
 /**
 * This component is responsible for:
-* - hydrating the query client on the server
-* - dehydrating the query client on the server
+* - dehydrating the query client on the server.
+* - hydrating the query client in the browser.
+* @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the
+* inline script, the hydrate and dehydrate `options`, and the data `transformer`.
+* @returns The `children`, wrapped in the hydration stream provider.
 */
 function ReactQueryStreamedHydration(props) {
 	const queryClient = useQueryClient(props.queryClient);

package/build/modern/ReactQueryStreamedHydration.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReactQueryStreamedHydration.js","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"sourcesContent":["'use client'\n\nimport {\n  defaultShouldDehydrateQuery,\n  dehydrate,\n  environmentManager,\n  hydrate,\n  useQueryClient,\n} from '@tanstack/react-query'\nimport * as React from 'react'\nimport { createHydrationStreamProvider } from './HydrationStreamProvider'\nimport type { HydrationStreamProviderProps } from './HydrationStreamProvider'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  QueryClient,\n} from '@tanstack/react-query'\n\nconst stream = createHydrationStreamProvider<DehydratedState>()\n\n/**\n * This component is responsible for:\n * - hydrating the query client on the server\n * - dehydrating the query client on the server\n */\nexport function ReactQueryStreamedHydration(props: {\n  children: React.ReactNode\n  queryClient?: QueryClient\n  nonce?: string\n  options?: {\n    hydrate?: HydrateOptions\n    dehydrate?: DehydrateOptions\n  }\n  transformer?: HydrationStreamProviderProps<DehydratedState>['transformer']\n}) {\n  const queryClient = useQueryClient(props.queryClient)\n\n  /**\n   * We need to track which queries were added/updated during the render\n   */\n  const [trackedKeys] = React.useState(() => new Set<string>())\n\n  // <server only>\n  if (environmentManager.isServer()) {\n    // Do we need to care about unsubscribing? I don't think so to be honest\n    queryClient.getQueryCache().subscribe((event) => {\n      switch (event.type) {\n        case 'added':\n        case 'updated':\n          // console.log('tracking', event.query.queryHash, 'b/c of a', event.type)\n          trackedKeys.add(event.query.queryHash)\n      }\n    })\n  }\n  // </server only>\n\n  return (\n    <stream.Provider\n      // Happens on server:\n      onFlush={() => {\n        /**\n         * Dehydrated state of the client where we only include the queries that were added/updated since the last flush\n         */\n        const shouldDehydrate =\n          props.options?.dehydrate?.shouldDehydrateQuery ??\n          defaultShouldDehydrateQuery\n\n        const dehydratedState = dehydrate(queryClient, {\n          ...props.options?.dehydrate,\n          shouldDehydrateQuery(query) {\n            return trackedKeys.has(query.queryHash) && shouldDehydrate(query)\n          },\n        })\n        trackedKeys.clear()\n\n        if (!dehydratedState.queries.length) {\n          return []\n        }\n\n        return [dehydratedState]\n      }}\n      // Happens in browser:\n      onEntries={(entries) => {\n        for (const hydratedState of entries) {\n          hydrate(queryClient, hydratedState, props.options?.hydrate)\n        }\n      }}\n      // Handle BigInts etc using superjson\n      transformer={props.transformer}\n      nonce={props.nonce}\n    >\n      {props.children}\n    </stream.Provider>\n  )\n}\n"],"mappings":";;;;;;AAmBA,MAAM,SAAS,8BAA+C;;;;;;AAO9D,SAAgB,4BAA4B,OASzC;CACD,MAAM,cAAc,eAAe,MAAM,WAAW;;;;CAKpD,MAAM,CAAC,eAAe,MAAM,+BAAe,IAAI,IAAY,CAAC;CAG5D,IAAI,mBAAmB,SAAS,GAE9B,YAAY,cAAc,CAAC,CAAC,WAAW,UAAU;EAC/C,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK,WAEH,YAAY,IAAI,MAAM,MAAM,SAAS;EACzC;CACF,CAAC;CAIH,OACE,oBAAC,OAAO,UAAR;EAEE,eAAe;;;;GAIb,MAAM,kBACJ,MAAM,SAAS,WAAW,wBAC1B;GAEF,MAAM,kBAAkB,UAAU,aAAa;IAC7C,GAAG,MAAM,SAAS;IAClB,qBAAqB,OAAO;KAC1B,OAAO,YAAY,IAAI,MAAM,SAAS,KAAK,gBAAgB,KAAK;IAClE;GACF,CAAC;GACD,YAAY,MAAM;GAElB,IAAI,CAAC,gBAAgB,QAAQ,QAC3B,OAAO,CAAC;GAGV,OAAO,CAAC,eAAe;EACzB;EAEA,YAAY,YAAY;GACtB,KAAK,MAAM,iBAAiB,SAC1B,QAAQ,aAAa,eAAe,MAAM,SAAS,OAAO;EAE9D;EAEA,aAAa,MAAM;EACnB,OAAO,MAAM;EAEZ,UAAA,MAAM;CACQ,CAAA;AAErB"}
+{"version":3,"file":"ReactQueryStreamedHydration.js","names":[],"sources":["../../src/ReactQueryStreamedHydration.tsx"],"sourcesContent":["'use client'\n\nimport {\n  defaultShouldDehydrateQuery,\n  dehydrate,\n  environmentManager,\n  hydrate,\n  useQueryClient,\n} from '@tanstack/react-query'\nimport * as React from 'react'\nimport { createHydrationStreamProvider } from './HydrationStreamProvider'\nimport type { HydrationStreamProviderProps } from './HydrationStreamProvider'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  QueryClient,\n} from '@tanstack/react-query'\n\nconst stream = createHydrationStreamProvider<DehydratedState>()\n\n/**\n * This component is responsible for:\n * - dehydrating the query client on the server.\n * - hydrating the query client in the browser.\n * @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the\n * inline script, the hydrate and dehydrate `options`, and the data `transformer`.\n * @returns The `children`, wrapped in the hydration stream provider.\n */\nexport function ReactQueryStreamedHydration(props: {\n  children: React.ReactNode\n  queryClient?: QueryClient\n  nonce?: string\n  options?: {\n    hydrate?: HydrateOptions\n    dehydrate?: DehydrateOptions\n  }\n  transformer?: HydrationStreamProviderProps<DehydratedState>['transformer']\n}) {\n  const queryClient = useQueryClient(props.queryClient)\n\n  /**\n   * We need to track which queries were added/updated during the render\n   */\n  const [trackedKeys] = React.useState(() => new Set<string>())\n\n  // <server only>\n  if (environmentManager.isServer()) {\n    // Do we need to care about unsubscribing? I don't think so to be honest\n    queryClient.getQueryCache().subscribe((event) => {\n      switch (event.type) {\n        case 'added':\n        case 'updated':\n          // console.log('tracking', event.query.queryHash, 'b/c of a', event.type)\n          trackedKeys.add(event.query.queryHash)\n      }\n    })\n  }\n  // </server only>\n\n  return (\n    <stream.Provider\n      // Happens on server:\n      onFlush={() => {\n        /**\n         * Dehydrated state of the client where we only include the queries that were added/updated since the last flush\n         */\n        const shouldDehydrate =\n          props.options?.dehydrate?.shouldDehydrateQuery ??\n          defaultShouldDehydrateQuery\n\n        const dehydratedState = dehydrate(queryClient, {\n          ...props.options?.dehydrate,\n          shouldDehydrateQuery(query) {\n            return trackedKeys.has(query.queryHash) && shouldDehydrate(query)\n          },\n        })\n        trackedKeys.clear()\n\n        if (!dehydratedState.queries.length) {\n          return []\n        }\n\n        return [dehydratedState]\n      }}\n      // Happens in browser:\n      onEntries={(entries) => {\n        for (const hydratedState of entries) {\n          hydrate(queryClient, hydratedState, props.options?.hydrate)\n        }\n      }}\n      // Handle BigInts etc using superjson\n      transformer={props.transformer}\n      nonce={props.nonce}\n    >\n      {props.children}\n    </stream.Provider>\n  )\n}\n"],"mappings":";;;;;;AAmBA,MAAM,SAAS,8BAA+C;;;;;;;;;AAU9D,SAAgB,4BAA4B,OASzC;CACD,MAAM,cAAc,eAAe,MAAM,WAAW;;;;CAKpD,MAAM,CAAC,eAAe,MAAM,+BAAe,IAAI,IAAY,CAAC;CAG5D,IAAI,mBAAmB,SAAS,GAE9B,YAAY,cAAc,CAAC,CAAC,WAAW,UAAU;EAC/C,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK,WAEH,YAAY,IAAI,MAAM,MAAM,SAAS;EACzC;CACF,CAAC;CAIH,OACE,oBAAC,OAAO,UAAR;EAEE,eAAe;;;;GAIb,MAAM,kBACJ,MAAM,SAAS,WAAW,wBAC1B;GAEF,MAAM,kBAAkB,UAAU,aAAa;IAC7C,GAAG,MAAM,SAAS;IAClB,qBAAqB,OAAO;KAC1B,OAAO,YAAY,IAAI,MAAM,SAAS,KAAK,gBAAgB,KAAK;IAClE;GACF,CAAC;GACD,YAAY,MAAM;GAElB,IAAI,CAAC,gBAAgB,QAAQ,QAC3B,OAAO,CAAC;GAGV,OAAO,CAAC,eAAe;EACzB;EAEA,YAAY,YAAY;GACtB,KAAK,MAAM,iBAAiB,SAC1B,QAAQ,aAAa,eAAe,MAAM,SAAS,OAAO;EAE9D;EAEA,aAAa,MAAM;EACnB,OAAO,MAAM;EAEZ,UAAA,MAAM;CACQ,CAAA;AAErB"}

package/build/modern/htmlescape.cjs

@@ -8,6 +8,11 @@ const ESCAPE_LOOKUP = {
 	"\u2029": "\\u2029"
 };
 const ESCAPE_REGEX = /[&><\u2028\u2029]/g;
+/**
+* Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.
+* @param str - The JSON string to escape.
+* @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\uXXXX` escapes.
+*/
 function htmlEscapeJsonString(str) {
 	return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]);
 }

package/build/modern/htmlescape.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"htmlescape.cjs","names":[],"sources":["../../src/htmlescape.ts"],"sourcesContent":["// --------------------------------------------------------------------------------\n//\n// copied from\n// https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/src/server/htmlescape.ts\n// License: https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/license.md\n//\n// --------------------------------------------------------------------------------\n\n// This utility is based on https://github.com/zertosh/htmlescape\n// License: https://github.com/zertosh/htmlescape/blob/0527ca7156a524d256101bb310a9f970f63078ad/LICENSE\n\nconst ESCAPE_LOOKUP: Record<string, string> = {\n  '&': '\\\\u0026',\n  '>': '\\\\u003e',\n  '<': '\\\\u003c',\n  '\\u2028': '\\\\u2028',\n  '\\u2029': '\\\\u2029',\n}\n\nexport const ESCAPE_REGEX = /[&><\\u2028\\u2029]/g\n\nexport function htmlEscapeJsonString(str: string): string {\n  return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]!)\n}\n"],"mappings":";;AAWA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;AAEA,MAAa,eAAe;AAE5B,SAAgB,qBAAqB,KAAqB;CACxD,OAAO,IAAI,QAAQ,eAAe,UAAU,cAAc,MAAO;AACnE"}
+{"version":3,"file":"htmlescape.cjs","names":[],"sources":["../../src/htmlescape.ts"],"sourcesContent":["// --------------------------------------------------------------------------------\n//\n// copied from\n// https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/src/server/htmlescape.ts\n// License: https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/license.md\n//\n// --------------------------------------------------------------------------------\n\n// This utility is based on https://github.com/zertosh/htmlescape\n// License: https://github.com/zertosh/htmlescape/blob/0527ca7156a524d256101bb310a9f970f63078ad/LICENSE\n\nconst ESCAPE_LOOKUP: Record<string, string> = {\n  '&': '\\\\u0026',\n  '>': '\\\\u003e',\n  '<': '\\\\u003c',\n  '\\u2028': '\\\\u2028',\n  '\\u2029': '\\\\u2029',\n}\n\nexport const ESCAPE_REGEX = /[&><\\u2028\\u2029]/g\n\n/**\n * Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.\n * @param str - The JSON string to escape.\n * @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\\uXXXX` escapes.\n */\nexport function htmlEscapeJsonString(str: string): string {\n  return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]!)\n}\n"],"mappings":";;AAWA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;AAEA,MAAa,eAAe;;;;;;AAO5B,SAAgB,qBAAqB,KAAqB;CACxD,OAAO,IAAI,QAAQ,eAAe,UAAU,cAAc,MAAO;AACnE"}

package/build/modern/htmlescape.d.cts

@@ -1,5 +1,10 @@
 //#region src/htmlescape.d.ts
 export declare const ESCAPE_REGEX: RegExp;
+/**
+ * Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.
+ * @param str - The JSON string to escape.
+ * @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\uXXXX` escapes.
+ */
 export declare function htmlEscapeJsonString(str: string): string;
 //#endregion
 //# sourceMappingURL=htmlescape.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"htmlescape.d.cts","names":[],"sources":["../../src/htmlescape.ts"],"mappings":";qBAmBa,cAAY;wBAET,qBAAqB"}
+{"version":3,"file":"htmlescape.d.cts","names":[],"sources":["../../src/htmlescape.ts"],"mappings":";qBAmBa,cAAY;;;;;;wBAOT,qBAAqB"}

package/build/modern/htmlescape.d.ts

@@ -1,5 +1,10 @@
 //#region src/htmlescape.d.ts
 export declare const ESCAPE_REGEX: RegExp;
+/**
+ * Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.
+ * @param str - The JSON string to escape.
+ * @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\uXXXX` escapes.
+ */
 export declare function htmlEscapeJsonString(str: string): string;
 //#endregion
 //# sourceMappingURL=htmlescape.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"htmlescape.d.ts","names":[],"sources":["../../src/htmlescape.ts"],"mappings":";qBAmBa,cAAY;wBAET,qBAAqB"}
+{"version":3,"file":"htmlescape.d.ts","names":[],"sources":["../../src/htmlescape.ts"],"mappings":";qBAmBa,cAAY;;;;;;wBAOT,qBAAqB"}

package/build/modern/htmlescape.js

@@ -7,6 +7,11 @@ const ESCAPE_LOOKUP = {
 	"\u2029": "\\u2029"
 };
 const ESCAPE_REGEX = /[&><\u2028\u2029]/g;
+/**
+* Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.
+* @param str - The JSON string to escape.
+* @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\uXXXX` escapes.
+*/
 function htmlEscapeJsonString(str) {
 	return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]);
 }

package/build/modern/htmlescape.js.map

@@ -1 +1 @@
-{"version":3,"file":"htmlescape.js","names":[],"sources":["../../src/htmlescape.ts"],"sourcesContent":["// --------------------------------------------------------------------------------\n//\n// copied from\n// https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/src/server/htmlescape.ts\n// License: https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/license.md\n//\n// --------------------------------------------------------------------------------\n\n// This utility is based on https://github.com/zertosh/htmlescape\n// License: https://github.com/zertosh/htmlescape/blob/0527ca7156a524d256101bb310a9f970f63078ad/LICENSE\n\nconst ESCAPE_LOOKUP: Record<string, string> = {\n  '&': '\\\\u0026',\n  '>': '\\\\u003e',\n  '<': '\\\\u003c',\n  '\\u2028': '\\\\u2028',\n  '\\u2029': '\\\\u2029',\n}\n\nexport const ESCAPE_REGEX = /[&><\\u2028\\u2029]/g\n\nexport function htmlEscapeJsonString(str: string): string {\n  return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]!)\n}\n"],"mappings":";AAWA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;AAEA,MAAa,eAAe;AAE5B,SAAgB,qBAAqB,KAAqB;CACxD,OAAO,IAAI,QAAQ,eAAe,UAAU,cAAc,MAAO;AACnE"}
+{"version":3,"file":"htmlescape.js","names":[],"sources":["../../src/htmlescape.ts"],"sourcesContent":["// --------------------------------------------------------------------------------\n//\n// copied from\n// https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/src/server/htmlescape.ts\n// License: https://github.com/vercel/next.js/blob/6bc07792a4462a4bf921a72ab30dc4ab2c4e1bda/packages/next/license.md\n//\n// --------------------------------------------------------------------------------\n\n// This utility is based on https://github.com/zertosh/htmlescape\n// License: https://github.com/zertosh/htmlescape/blob/0527ca7156a524d256101bb310a9f970f63078ad/LICENSE\n\nconst ESCAPE_LOOKUP: Record<string, string> = {\n  '&': '\\\\u0026',\n  '>': '\\\\u003e',\n  '<': '\\\\u003c',\n  '\\u2028': '\\\\u2028',\n  '\\u2029': '\\\\u2029',\n}\n\nexport const ESCAPE_REGEX = /[&><\\u2028\\u2029]/g\n\n/**\n * Escapes the characters of a JSON string that are unsafe to embed in an HTML `<script>` tag.\n * @param str - The JSON string to escape.\n * @returns The string with `&`, `<`, `>`, U+2028, and U+2029 replaced by `\\uXXXX` escapes.\n */\nexport function htmlEscapeJsonString(str: string): string {\n  return str.replace(ESCAPE_REGEX, (match) => ESCAPE_LOOKUP[match]!)\n}\n"],"mappings":";AAWA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;AAEA,MAAa,eAAe;;;;;;AAO5B,SAAgB,qBAAqB,KAAqB;CACxD,OAAO,IAAI,QAAQ,eAAe,UAAU,cAAc,MAAO;AACnE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query-next-experimental",
-  "version": "5.104.0",
+  "version": "5.104.2",
   "description": "Hydration utils for React Query in the NextJs app directory",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -39,29 +39,31 @@
     "!src/__tests__"
   ],
   "devDependencies": {
-    "@tanstack/react-query": "5.104.0",
+    "@eslint-react/eslint-plugin": "^5.23.3",
+    "@tanstack/react-query": "5.104.2",
     "@types/react": "^19.2.7",
     "@vitejs/plugin-react": "^6.1.1",
+    "eslint-plugin-react-hooks": "^7.1.1",
     "next": "^16.0.1",
-    "npm-run-all2": "^9.0.3",
-    "react": "^19.2.1"
+    "react": "^19.2.1",
+    "typescript": "6.0.3"
   },
   "peerDependencies": {
-    "@tanstack/react-query": "^5.104.0",
+    "@tanstack/react-query": "^5.104.2",
     "next": "^13 || ^14 || ^15 || ^16",
     "react": "^18 || ^19"
   },
   "scripts": {
     "clean": "premove ./build ./coverage ./dist-ts ./.cache/test-types",
     "compile": "tsc --project tsconfig.json",
-    "test:eslint": "eslint --concurrency=auto ./src",
+    "test:oxlint": "oxlint ./src",
     "test:types": "npm-run-all --serial test:types:*",
-    "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts56 --tsBuildInfoFile .cache/test-types/ts56.tsbuildinfo",
     "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts57 --tsBuildInfoFile .cache/test-types/ts57.tsbuildinfo",
     "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts58 --tsBuildInfoFile .cache/test-types/ts58.tsbuildinfo",
     "test:types:ts59": "node ../../node_modules/typescript59/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts59 --tsBuildInfoFile .cache/test-types/ts59.tsbuildinfo",
     "test:types:tscurrent": "tsc --project tsconfig.json --outDir .cache/test-types/tscurrent --tsBuildInfoFile .cache/test-types/tscurrent.tsbuildinfo",
-    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --project tsconfig.json --outDir .cache/test-types/ts70 --tsBuildInfoFile .cache/test-types/ts70.tsbuildinfo",
+    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts70 --tsBuildInfoFile .cache/test-types/ts70.tsbuildinfo",
+    "test:types:ts71": "node ../../node_modules/typescript71/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts71 --tsBuildInfoFile .cache/test-types/ts71.tsbuildinfo",
     "test:build": "publint --strict && attw --pack",
     "build": "tsdown --tsconfig tsconfig.prod.json"
   }

package/src/HydrationStreamProvider.tsx

@@ -33,7 +33,13 @@ interface HydrationStreamContext<TShape> {
   }
 }
 
+/**
+ * The props of the `Provider` returned by `createHydrationStreamProvider`.
+ */
 export interface HydrationStreamProviderProps<TShape> {
+  /**
+   * The children to render inside the stream provider.
+   */
   children: React.ReactNode
   /**
    * Optional transformer to serialize/deserialize the data
@@ -56,19 +62,27 @@ export interface HydrationStreamProviderProps<TShape> {
   nonce?: string
 }
 
+/**
+ * Creates a provider that streams entries (e.g. dehydrated query state) from the server to the
+ * client while the page streams in, and the context it shares the stream through.
+ * @returns The `Provider` component and its `context`.
+ */
 export function createHydrationStreamProvider<TShape>() {
-  const context = React.createContext<HydrationStreamContext<TShape>>(
+  const StreamContext = React.createContext<HydrationStreamContext<TShape>>(
     null as any,
   )
   /**
-
-   * 1. (Happens on server): `useServerInsertedHTML()` is called **on the server** whenever a `Suspense`-boundary completes
-   *    - This means that we might have some new entries in the cache that needs to be flushed
-   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`
+   * 1. (Happens on server): the callback registered with `useServerInsertedHTML()` is called **on the server** whenever
+   *    Next.js inserts HTML into the streamed response.
+   *    - This means that we might have some new entries in the cache that needs to be flushed.
+   *    - We pass these to the client by inserting a `<script>`-tag where we do `window[id].push(serializedVersionOfCache)`.
    * 2. (Happens in browser) In `useEffect()`:
-   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries
-   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received
-   **/
+   *   - We check if `window[id]` is set to an array and call `push()` on all the entries which will call `onEntries()` with the new entries.
+   *   - We replace `window[id]` with a `push()`-method that will be called whenever new entries are received.
+   * @param props - The `children` to render, the `onEntries`/`onFlush` callbacks, and the optional
+   * `transformer` and `nonce`.
+   * @returns The `children`, wrapped in the stream context provider.
+   */
   function UseClientHydrationStreamProvider(props: {
     children: React.ReactNode
     /**
@@ -115,7 +129,7 @@ export function createHydrationStreamProvider<TShape>() {
       }
       return []
     })
-    const count = React.useRef(0)
+    const countRef = React.useRef(0)
     useServerInsertedHTML(() => {
       // This only happens on the server
       stream.push(...(props.onFlush?.() ?? []))
@@ -130,7 +144,6 @@ export function createHydrationStreamProvider<TShape>() {
         .join(',')
 
       // Flush stream
-      // eslint-disable-next-line react-hooks/immutability
       stream.length = 0
 
       const html: Array<string> = [
@@ -139,7 +152,7 @@ export function createHydrationStreamProvider<TShape>() {
       ]
       return (
         <script
-          key={count.current++}
+          key={countRef.current++}
           nonce={props.nonce}
           dangerouslySetInnerHTML={{
             __html: html.join(''),
@@ -169,7 +182,6 @@ export function createHydrationStreamProvider<TShape>() {
 
         onEntries(...winStream)
 
-        // eslint-disable-next-line react-hooks/immutability
         win[id] = {
           initialized: true,
           push: onEntries,
@@ -179,14 +191,14 @@ export function createHydrationStreamProvider<TShape>() {
     // </client stuff>
 
     return (
-      <context.Provider value={{ stream, id }}>
+      <StreamContext.Provider value={{ stream, id }}>
         {props.children}
-      </context.Provider>
+      </StreamContext.Provider>
     )
   }
 
   return {
     Provider: UseClientHydrationStreamProvider,
-    context,
+    context: StreamContext,
   }
 }

package/src/ReactQueryStreamedHydration.tsx

@@ -21,8 +21,11 @@ const stream = createHydrationStreamProvider<DehydratedState>()
 
 /**
  * This component is responsible for:
- * - hydrating the query client on the server
- * - dehydrating the query client on the server
+ * - dehydrating the query client on the server.
+ * - hydrating the query client in the browser.
+ * @param props - The `children` to render, an optional custom `queryClient`, the `nonce` for the
+ * inline script, the hydrate and dehydrate `options`, and the data `transformer`.
+ * @returns The `children`, wrapped in the hydration stream provider.
  */
 export function ReactQueryStreamedHydration(props: {
   children: React.ReactNode