@tanstack/router-ssr-query-core 1.121.0-alpha.28

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+<img src="https://static.scarf.sh/a.png?x-pxid=d988eb79-b0fc-4a2b-8514-6a1ab932d188" />
+
+# TanStack Router Core
+
+See [https://tanstack.com/router](https://tanstack.com/router) for documentation.

package/dist/cjs/index.cjs

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const queryCore = require("@tanstack/query-core");
+const routerCore = require("@tanstack/router-core");
+function setupCoreRouterSsrQueryIntegration({
+  router,
+  queryClient,
+  handleRedirects = true
+}) {
+  const ogHydrate = router.options.hydrate;
+  const ogDehydrate = router.options.dehydrate;
+  if (router.isServer) {
+    const sentQueries = /* @__PURE__ */ new Set();
+    const queryStream = createPushableStream();
+    router.options.dehydrate = async () => {
+      router.serverSsr.onRenderFinished(() => queryStream.close());
+      const ogDehydrated = await ogDehydrate?.();
+      const dehydratedRouter = {
+        ...ogDehydrated,
+        // prepare the stream for queries coming up during rendering
+        queryStream: queryStream.stream
+      };
+      const dehydratedQueryClient = queryCore.dehydrate(queryClient);
+      if (dehydratedQueryClient.queries.length > 0) {
+        dehydratedQueryClient.queries.forEach((query) => {
+          sentQueries.add(query.queryHash);
+        });
+        dehydratedRouter.dehydratedQueryClient = dehydratedQueryClient;
+      }
+      return dehydratedRouter;
+    };
+    const ogClientOptions = queryClient.getDefaultOptions();
+    queryClient.setDefaultOptions({
+      ...ogClientOptions,
+      dehydrate: {
+        shouldDehydrateQuery: () => true,
+        ...ogClientOptions.dehydrate
+      }
+    });
+    queryClient.getQueryCache().subscribe((event) => {
+      if (!router.serverSsr?.isDehydrated()) {
+        return;
+      }
+      if (sentQueries.has(event.query.queryHash)) {
+        return;
+      }
+      if (queryStream.isClosed()) {
+        console.warn(
+          `tried to stream query ${event.query.queryHash} after stream was already closed`
+        );
+        return;
+      }
+      if (!event.query.promise) {
+        return;
+      }
+      sentQueries.add(event.query.queryHash);
+      queryStream.enqueue(
+        queryCore.dehydrate(queryClient, {
+          shouldDehydrateQuery: (query) => {
+            if (query.queryHash === event.query.queryHash) {
+              return ogClientOptions.dehydrate?.shouldDehydrateQuery?.(query) ?? true;
+            }
+            return false;
+          }
+        })
+      );
+    });
+  } else {
+    router.options.hydrate = async (dehydrated) => {
+      await ogHydrate?.(dehydrated);
+      if (dehydrated.dehydratedQueryClient) {
+        queryCore.hydrate(queryClient, dehydrated.dehydratedQueryClient);
+      }
+      const reader = dehydrated.queryStream.getReader();
+      reader.read().then(async function handle({ done, value }) {
+        queryCore.hydrate(queryClient, value);
+        if (done) {
+          return;
+        }
+        const result = await reader.read();
+        return handle(result);
+      }).catch((err) => {
+        console.error("Error reading query stream:", err);
+      });
+    };
+    if (handleRedirects) {
+      const ogMutationCacheConfig = queryClient.getMutationCache().config;
+      queryClient.getMutationCache().config = {
+        ...ogMutationCacheConfig,
+        onError: (error, _variables, _context, _mutation) => {
+          if (routerCore.isRedirect(error)) {
+            error.options._fromLocation = router.state.location;
+            return router.navigate(router.resolveRedirect(error).options);
+          }
+          return ogMutationCacheConfig.onError?.(
+            error,
+            _variables,
+            _context,
+            _mutation
+          );
+        }
+      };
+      const ogQueryCacheConfig = queryClient.getQueryCache().config;
+      queryClient.getQueryCache().config = {
+        ...ogQueryCacheConfig,
+        onError: (error, _query) => {
+          if (routerCore.isRedirect(error)) {
+            error.options._fromLocation = router.state.location;
+            return router.navigate(router.resolveRedirect(error).options);
+          }
+          return ogQueryCacheConfig.onError?.(error, _query);
+        }
+      };
+    }
+  }
+}
+function createPushableStream() {
+  let controllerRef;
+  const stream = new ReadableStream({
+    start(controller) {
+      controllerRef = controller;
+    }
+  });
+  let _isClosed = false;
+  return {
+    stream,
+    enqueue: (chunk) => controllerRef.enqueue(chunk),
+    close: () => {
+      controllerRef.close();
+      _isClosed = true;
+    },
+    isClosed: () => _isClosed,
+    error: (err) => controllerRef.error(err)
+  };
+}
+exports.setupCoreRouterSsrQueryIntegration = setupCoreRouterSsrQueryIntegration;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["import {\n  dehydrate as queryDehydrate,\n  hydrate as queryHydrate,\n} from '@tanstack/query-core'\nimport { isRedirect } from '@tanstack/router-core'\nimport type { AnyRouter } from '@tanstack/router-core'\nimport type {\n  QueryClient,\n  DehydratedState as QueryDehydratedState,\n} from '@tanstack/query-core'\n\nexport type RouterSsrQueryOptions<TRouter extends AnyRouter> = {\n  router: TRouter\n  queryClient: QueryClient\n\n  /**\n   * If `true`, the QueryClient will handle errors thrown by `redirect()` inside of mutations and queries.\n   *\n   * @default true\n   * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction)\n   */\n  handleRedirects?: boolean\n}\n\ntype DehydratedRouterQueryState = {\n  dehydratedQueryClient?: QueryDehydratedState\n  queryStream: ReadableStream<QueryDehydratedState>\n}\n\nexport function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({\n  router,\n  queryClient,\n  handleRedirects = true,\n}: RouterSsrQueryOptions<TRouter>) {\n  const ogHydrate = router.options.hydrate\n  const ogDehydrate = router.options.dehydrate\n\n  if (router.isServer) {\n    const sentQueries = new Set<string>()\n    const queryStream = createPushableStream()\n\n    router.options.dehydrate =\n      async (): Promise<DehydratedRouterQueryState> => {\n        router.serverSsr!.onRenderFinished(() => queryStream.close())\n        const ogDehydrated = await ogDehydrate?.()\n\n        const dehydratedRouter = {\n          ...ogDehydrated,\n          // prepare the stream for queries coming up during rendering\n          queryStream: queryStream.stream,\n        }\n\n        const dehydratedQueryClient = queryDehydrate(queryClient)\n        if (dehydratedQueryClient.queries.length > 0) {\n          dehydratedQueryClient.queries.forEach((query) => {\n            sentQueries.add(query.queryHash)\n          })\n          dehydratedRouter.dehydratedQueryClient = dehydratedQueryClient\n        }\n\n        return dehydratedRouter\n      }\n\n    const ogClientOptions = queryClient.getDefaultOptions()\n    queryClient.setDefaultOptions({\n      ...ogClientOptions,\n      dehydrate: {\n        shouldDehydrateQuery: () => true,\n        ...ogClientOptions.dehydrate,\n      },\n    })\n\n    queryClient.getQueryCache().subscribe((event) => {\n      // before rendering starts, we do not stream individual queries\n      // instead we dehydrate the entire query client in router's dehydrate()\n      // if attachRouterServerSsrUtils() has not been called yet, `router.serverSsr` will be undefined and we also do not stream\n      if (!router.serverSsr?.isDehydrated()) {\n        return\n      }\n      if (sentQueries.has(event.query.queryHash)) {\n        return\n      }\n      if (queryStream.isClosed()) {\n        console.warn(\n          `tried to stream query ${event.query.queryHash} after stream was already closed`,\n        )\n        return\n      }\n      // promise not yet set on the query, so we cannot stream it yet\n      if (!event.query.promise) {\n        return\n      }\n      sentQueries.add(event.query.queryHash)\n      queryStream.enqueue(\n        queryDehydrate(queryClient, {\n          shouldDehydrateQuery: (query) => {\n            if (query.queryHash === event.query.queryHash) {\n              return (\n                ogClientOptions.dehydrate?.shouldDehydrateQuery?.(query) ?? true\n              )\n            }\n            return false\n          },\n        }),\n      )\n    })\n    // on the client\n  } else {\n    router.options.hydrate = async (dehydrated: DehydratedRouterQueryState) => {\n      await ogHydrate?.(dehydrated)\n      // hydrate the query client with the dehydrated data (if it was dehydrated on the server)\n      if (dehydrated.dehydratedQueryClient) {\n        queryHydrate(queryClient, dehydrated.dehydratedQueryClient)\n      }\n\n      // read the query stream and hydrate the queries as they come in\n      const reader = dehydrated.queryStream.getReader()\n      reader\n        .read()\n        .then(async function handle({ done, value }) {\n          queryHydrate(queryClient, value)\n          if (done) {\n            return\n          }\n          const result = await reader.read()\n          return handle(result)\n        })\n        .catch((err) => {\n          console.error('Error reading query stream:', err)\n        })\n    }\n    if (handleRedirects) {\n      const ogMutationCacheConfig = queryClient.getMutationCache().config\n      queryClient.getMutationCache().config = {\n        ...ogMutationCacheConfig,\n        onError: (error, _variables, _context, _mutation) => {\n          if (isRedirect(error)) {\n            error.options._fromLocation = router.state.location\n            return router.navigate(router.resolveRedirect(error).options)\n          }\n\n          return ogMutationCacheConfig.onError?.(\n            error,\n            _variables,\n            _context,\n            _mutation,\n          )\n        },\n      }\n\n      const ogQueryCacheConfig = queryClient.getQueryCache().config\n      queryClient.getQueryCache().config = {\n        ...ogQueryCacheConfig,\n        onError: (error, _query) => {\n          if (isRedirect(error)) {\n            error.options._fromLocation = router.state.location\n            return router.navigate(router.resolveRedirect(error).options)\n          }\n\n          return ogQueryCacheConfig.onError?.(error, _query)\n        },\n      }\n    }\n  }\n}\n\ntype PushableStream = {\n  stream: ReadableStream\n  enqueue: (chunk: unknown) => void\n  close: () => void\n  isClosed: () => boolean\n  error: (err: unknown) => void\n}\n\nfunction createPushableStream(): PushableStream {\n  let controllerRef: ReadableStreamDefaultController\n  const stream = new ReadableStream({\n    start(controller) {\n      controllerRef = controller\n    },\n  })\n  let _isClosed = false\n\n  return {\n    stream,\n    enqueue: (chunk) => controllerRef.enqueue(chunk),\n    close: () => {\n      controllerRef.close()\n      _isClosed = true\n    },\n    isClosed: () => _isClosed,\n    error: (err: unknown) => controllerRef.error(err),\n  }\n}\n"],"names":["queryDehydrate","queryHydrate","isRedirect"],"mappings":";;;;AA6BO,SAAS,mCAA8D;AAAA,EAC5E;AAAA,EACA;AAAA,EACA,kBAAkB;AACpB,GAAmC;AACjC,QAAM,YAAY,OAAO,QAAQ;AACjC,QAAM,cAAc,OAAO,QAAQ;AAEnC,MAAI,OAAO,UAAU;AACnB,UAAM,kCAAkB,IAAA;AACxB,UAAM,cAAc,qBAAA;AAEpB,WAAO,QAAQ,YACb,YAAiD;AAC/C,aAAO,UAAW,iBAAiB,MAAM,YAAY,OAAO;AAC5D,YAAM,eAAe,MAAM,cAAA;AAE3B,YAAM,mBAAmB;AAAA,QACvB,GAAG;AAAA;AAAA,QAEH,aAAa,YAAY;AAAA,MAAA;AAG3B,YAAM,wBAAwBA,UAAAA,UAAe,WAAW;AACxD,UAAI,sBAAsB,QAAQ,SAAS,GAAG;AAC5C,8BAAsB,QAAQ,QAAQ,CAAC,UAAU;AAC/C,sBAAY,IAAI,MAAM,SAAS;AAAA,QACjC,CAAC;AACD,yBAAiB,wBAAwB;AAAA,MAC3C;AAEA,aAAO;AAAA,IACT;AAEF,UAAM,kBAAkB,YAAY,kBAAA;AACpC,gBAAY,kBAAkB;AAAA,MAC5B,GAAG;AAAA,MACH,WAAW;AAAA,QACT,sBAAsB,MAAM;AAAA,QAC5B,GAAG,gBAAgB;AAAA,MAAA;AAAA,IACrB,CACD;AAED,gBAAY,cAAA,EAAgB,UAAU,CAAC,UAAU;AAI/C,UAAI,CAAC,OAAO,WAAW,gBAAgB;AACrC;AAAA,MACF;AACA,UAAI,YAAY,IAAI,MAAM,MAAM,SAAS,GAAG;AAC1C;AAAA,MACF;AACA,UAAI,YAAY,YAAY;AAC1B,gBAAQ;AAAA,UACN,yBAAyB,MAAM,MAAM,SAAS;AAAA,QAAA;AAEhD;AAAA,MACF;AAEA,UAAI,CAAC,MAAM,MAAM,SAAS;AACxB;AAAA,MACF;AACA,kBAAY,IAAI,MAAM,MAAM,SAAS;AACrC,kBAAY;AAAA,QACVA,UAAAA,UAAe,aAAa;AAAA,UAC1B,sBAAsB,CAAC,UAAU;AAC/B,gBAAI,MAAM,cAAc,MAAM,MAAM,WAAW;AAC7C,qBACE,gBAAgB,WAAW,uBAAuB,KAAK,KAAK;AAAA,YAEhE;AACA,mBAAO;AAAA,UACT;AAAA,QAAA,CACD;AAAA,MAAA;AAAA,IAEL,CAAC;AAAA,EAEH,OAAO;AACL,WAAO,QAAQ,UAAU,OAAO,eAA2C;AACzE,YAAM,YAAY,UAAU;AAE5B,UAAI,WAAW,uBAAuB;AACpCC,0BAAa,aAAa,WAAW,qBAAqB;AAAA,MAC5D;AAGA,YAAM,SAAS,WAAW,YAAY,UAAA;AACtC,aACG,KAAA,EACA,KAAK,eAAe,OAAO,EAAE,MAAM,SAAS;AAC3CA,kBAAAA,QAAa,aAAa,KAAK;AAC/B,YAAI,MAAM;AACR;AAAA,QACF;AACA,cAAM,SAAS,MAAM,OAAO,KAAA;AAC5B,eAAO,OAAO,MAAM;AAAA,MACtB,CAAC,EACA,MAAM,CAAC,QAAQ;AACd,gBAAQ,MAAM,+BAA+B,GAAG;AAAA,MAClD,CAAC;AAAA,IACL;AACA,QAAI,iBAAiB;AACnB,YAAM,wBAAwB,YAAY,iBAAA,EAAmB;AAC7D,kBAAY,iBAAA,EAAmB,SAAS;AAAA,QACtC,GAAG;AAAA,QACH,SAAS,CAAC,OAAO,YAAY,UAAU,cAAc;AACnD,cAAIC,WAAAA,WAAW,KAAK,GAAG;AACrB,kBAAM,QAAQ,gBAAgB,OAAO,MAAM;AAC3C,mBAAO,OAAO,SAAS,OAAO,gBAAgB,KAAK,EAAE,OAAO;AAAA,UAC9D;AAEA,iBAAO,sBAAsB;AAAA,YAC3B;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA;AAAA,QAEJ;AAAA,MAAA;AAGF,YAAM,qBAAqB,YAAY,cAAA,EAAgB;AACvD,kBAAY,cAAA,EAAgB,SAAS;AAAA,QACnC,GAAG;AAAA,QACH,SAAS,CAAC,OAAO,WAAW;AAC1B,cAAIA,WAAAA,WAAW,KAAK,GAAG;AACrB,kBAAM,QAAQ,gBAAgB,OAAO,MAAM;AAC3C,mBAAO,OAAO,SAAS,OAAO,gBAAgB,KAAK,EAAE,OAAO;AAAA,UAC9D;AAEA,iBAAO,mBAAmB,UAAU,OAAO,MAAM;AAAA,QACnD;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AACF;AAUA,SAAS,uBAAuC;AAC9C,MAAI;AACJ,QAAM,SAAS,IAAI,eAAe;AAAA,IAChC,MAAM,YAAY;AAChB,sBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACD,MAAI,YAAY;AAEhB,SAAO;AAAA,IACL;AAAA,IACA,SAAS,CAAC,UAAU,cAAc,QAAQ,KAAK;AAAA,IAC/C,OAAO,MAAM;AACX,oBAAc,MAAA;AACd,kBAAY;AAAA,IACd;AAAA,IACA,UAAU,MAAM;AAAA,IAChB,OAAO,CAAC,QAAiB,cAAc,MAAM,GAAG;AAAA,EAAA;AAEpD;;"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,14 @@
+import { AnyRouter } from '@tanstack/router-core';
+import { QueryClient } from '@tanstack/query-core';
+export type RouterSsrQueryOptions<TRouter extends AnyRouter> = {
+    router: TRouter;
+    queryClient: QueryClient;
+    /**
+     * If `true`, the QueryClient will handle errors thrown by `redirect()` inside of mutations and queries.
+     *
+     * @default true
+     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction)
+     */
+    handleRedirects?: boolean;
+};
+export declare function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({ router, queryClient, handleRedirects, }: RouterSsrQueryOptions<TRouter>): void;

package/dist/esm/index.d.ts

@@ -0,0 +1,14 @@
+import { AnyRouter } from '@tanstack/router-core';
+import { QueryClient } from '@tanstack/query-core';
+export type RouterSsrQueryOptions<TRouter extends AnyRouter> = {
+    router: TRouter;
+    queryClient: QueryClient;
+    /**
+     * If `true`, the QueryClient will handle errors thrown by `redirect()` inside of mutations and queries.
+     *
+     * @default true
+     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction)
+     */
+    handleRedirects?: boolean;
+};
+export declare function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({ router, queryClient, handleRedirects, }: RouterSsrQueryOptions<TRouter>): void;

package/dist/esm/index.js

@@ -0,0 +1,137 @@
+import { dehydrate, hydrate } from "@tanstack/query-core";
+import { isRedirect } from "@tanstack/router-core";
+function setupCoreRouterSsrQueryIntegration({
+  router,
+  queryClient,
+  handleRedirects = true
+}) {
+  const ogHydrate = router.options.hydrate;
+  const ogDehydrate = router.options.dehydrate;
+  if (router.isServer) {
+    const sentQueries = /* @__PURE__ */ new Set();
+    const queryStream = createPushableStream();
+    router.options.dehydrate = async () => {
+      router.serverSsr.onRenderFinished(() => queryStream.close());
+      const ogDehydrated = await ogDehydrate?.();
+      const dehydratedRouter = {
+        ...ogDehydrated,
+        // prepare the stream for queries coming up during rendering
+        queryStream: queryStream.stream
+      };
+      const dehydratedQueryClient = dehydrate(queryClient);
+      if (dehydratedQueryClient.queries.length > 0) {
+        dehydratedQueryClient.queries.forEach((query) => {
+          sentQueries.add(query.queryHash);
+        });
+        dehydratedRouter.dehydratedQueryClient = dehydratedQueryClient;
+      }
+      return dehydratedRouter;
+    };
+    const ogClientOptions = queryClient.getDefaultOptions();
+    queryClient.setDefaultOptions({
+      ...ogClientOptions,
+      dehydrate: {
+        shouldDehydrateQuery: () => true,
+        ...ogClientOptions.dehydrate
+      }
+    });
+    queryClient.getQueryCache().subscribe((event) => {
+      if (!router.serverSsr?.isDehydrated()) {
+        return;
+      }
+      if (sentQueries.has(event.query.queryHash)) {
+        return;
+      }
+      if (queryStream.isClosed()) {
+        console.warn(
+          `tried to stream query ${event.query.queryHash} after stream was already closed`
+        );
+        return;
+      }
+      if (!event.query.promise) {
+        return;
+      }
+      sentQueries.add(event.query.queryHash);
+      queryStream.enqueue(
+        dehydrate(queryClient, {
+          shouldDehydrateQuery: (query) => {
+            if (query.queryHash === event.query.queryHash) {
+              return ogClientOptions.dehydrate?.shouldDehydrateQuery?.(query) ?? true;
+            }
+            return false;
+          }
+        })
+      );
+    });
+  } else {
+    router.options.hydrate = async (dehydrated) => {
+      await ogHydrate?.(dehydrated);
+      if (dehydrated.dehydratedQueryClient) {
+        hydrate(queryClient, dehydrated.dehydratedQueryClient);
+      }
+      const reader = dehydrated.queryStream.getReader();
+      reader.read().then(async function handle({ done, value }) {
+        hydrate(queryClient, value);
+        if (done) {
+          return;
+        }
+        const result = await reader.read();
+        return handle(result);
+      }).catch((err) => {
+        console.error("Error reading query stream:", err);
+      });
+    };
+    if (handleRedirects) {
+      const ogMutationCacheConfig = queryClient.getMutationCache().config;
+      queryClient.getMutationCache().config = {
+        ...ogMutationCacheConfig,
+        onError: (error, _variables, _context, _mutation) => {
+          if (isRedirect(error)) {
+            error.options._fromLocation = router.state.location;
+            return router.navigate(router.resolveRedirect(error).options);
+          }
+          return ogMutationCacheConfig.onError?.(
+            error,
+            _variables,
+            _context,
+            _mutation
+          );
+        }
+      };
+      const ogQueryCacheConfig = queryClient.getQueryCache().config;
+      queryClient.getQueryCache().config = {
+        ...ogQueryCacheConfig,
+        onError: (error, _query) => {
+          if (isRedirect(error)) {
+            error.options._fromLocation = router.state.location;
+            return router.navigate(router.resolveRedirect(error).options);
+          }
+          return ogQueryCacheConfig.onError?.(error, _query);
+        }
+      };
+    }
+  }
+}
+function createPushableStream() {
+  let controllerRef;
+  const stream = new ReadableStream({
+    start(controller) {
+      controllerRef = controller;
+    }
+  });
+  let _isClosed = false;
+  return {
+    stream,
+    enqueue: (chunk) => controllerRef.enqueue(chunk),
+    close: () => {
+      controllerRef.close();
+      _isClosed = true;
+    },
+    isClosed: () => _isClosed,
+    error: (err) => controllerRef.error(err)
+  };
+}
+export {
+  setupCoreRouterSsrQueryIntegration
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import {\n  dehydrate as queryDehydrate,\n  hydrate as queryHydrate,\n} from '@tanstack/query-core'\nimport { isRedirect } from '@tanstack/router-core'\nimport type { AnyRouter } from '@tanstack/router-core'\nimport type {\n  QueryClient,\n  DehydratedState as QueryDehydratedState,\n} from '@tanstack/query-core'\n\nexport type RouterSsrQueryOptions<TRouter extends AnyRouter> = {\n  router: TRouter\n  queryClient: QueryClient\n\n  /**\n   * If `true`, the QueryClient will handle errors thrown by `redirect()` inside of mutations and queries.\n   *\n   * @default true\n   * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction)\n   */\n  handleRedirects?: boolean\n}\n\ntype DehydratedRouterQueryState = {\n  dehydratedQueryClient?: QueryDehydratedState\n  queryStream: ReadableStream<QueryDehydratedState>\n}\n\nexport function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({\n  router,\n  queryClient,\n  handleRedirects = true,\n}: RouterSsrQueryOptions<TRouter>) {\n  const ogHydrate = router.options.hydrate\n  const ogDehydrate = router.options.dehydrate\n\n  if (router.isServer) {\n    const sentQueries = new Set<string>()\n    const queryStream = createPushableStream()\n\n    router.options.dehydrate =\n      async (): Promise<DehydratedRouterQueryState> => {\n        router.serverSsr!.onRenderFinished(() => queryStream.close())\n        const ogDehydrated = await ogDehydrate?.()\n\n        const dehydratedRouter = {\n          ...ogDehydrated,\n          // prepare the stream for queries coming up during rendering\n          queryStream: queryStream.stream,\n        }\n\n        const dehydratedQueryClient = queryDehydrate(queryClient)\n        if (dehydratedQueryClient.queries.length > 0) {\n          dehydratedQueryClient.queries.forEach((query) => {\n            sentQueries.add(query.queryHash)\n          })\n          dehydratedRouter.dehydratedQueryClient = dehydratedQueryClient\n        }\n\n        return dehydratedRouter\n      }\n\n    const ogClientOptions = queryClient.getDefaultOptions()\n    queryClient.setDefaultOptions({\n      ...ogClientOptions,\n      dehydrate: {\n        shouldDehydrateQuery: () => true,\n        ...ogClientOptions.dehydrate,\n      },\n    })\n\n    queryClient.getQueryCache().subscribe((event) => {\n      // before rendering starts, we do not stream individual queries\n      // instead we dehydrate the entire query client in router's dehydrate()\n      // if attachRouterServerSsrUtils() has not been called yet, `router.serverSsr` will be undefined and we also do not stream\n      if (!router.serverSsr?.isDehydrated()) {\n        return\n      }\n      if (sentQueries.has(event.query.queryHash)) {\n        return\n      }\n      if (queryStream.isClosed()) {\n        console.warn(\n          `tried to stream query ${event.query.queryHash} after stream was already closed`,\n        )\n        return\n      }\n      // promise not yet set on the query, so we cannot stream it yet\n      if (!event.query.promise) {\n        return\n      }\n      sentQueries.add(event.query.queryHash)\n      queryStream.enqueue(\n        queryDehydrate(queryClient, {\n          shouldDehydrateQuery: (query) => {\n            if (query.queryHash === event.query.queryHash) {\n              return (\n                ogClientOptions.dehydrate?.shouldDehydrateQuery?.(query) ?? true\n              )\n            }\n            return false\n          },\n        }),\n      )\n    })\n    // on the client\n  } else {\n    router.options.hydrate = async (dehydrated: DehydratedRouterQueryState) => {\n      await ogHydrate?.(dehydrated)\n      // hydrate the query client with the dehydrated data (if it was dehydrated on the server)\n      if (dehydrated.dehydratedQueryClient) {\n        queryHydrate(queryClient, dehydrated.dehydratedQueryClient)\n      }\n\n      // read the query stream and hydrate the queries as they come in\n      const reader = dehydrated.queryStream.getReader()\n      reader\n        .read()\n        .then(async function handle({ done, value }) {\n          queryHydrate(queryClient, value)\n          if (done) {\n            return\n          }\n          const result = await reader.read()\n          return handle(result)\n        })\n        .catch((err) => {\n          console.error('Error reading query stream:', err)\n        })\n    }\n    if (handleRedirects) {\n      const ogMutationCacheConfig = queryClient.getMutationCache().config\n      queryClient.getMutationCache().config = {\n        ...ogMutationCacheConfig,\n        onError: (error, _variables, _context, _mutation) => {\n          if (isRedirect(error)) {\n            error.options._fromLocation = router.state.location\n            return router.navigate(router.resolveRedirect(error).options)\n          }\n\n          return ogMutationCacheConfig.onError?.(\n            error,\n            _variables,\n            _context,\n            _mutation,\n          )\n        },\n      }\n\n      const ogQueryCacheConfig = queryClient.getQueryCache().config\n      queryClient.getQueryCache().config = {\n        ...ogQueryCacheConfig,\n        onError: (error, _query) => {\n          if (isRedirect(error)) {\n            error.options._fromLocation = router.state.location\n            return router.navigate(router.resolveRedirect(error).options)\n          }\n\n          return ogQueryCacheConfig.onError?.(error, _query)\n        },\n      }\n    }\n  }\n}\n\ntype PushableStream = {\n  stream: ReadableStream\n  enqueue: (chunk: unknown) => void\n  close: () => void\n  isClosed: () => boolean\n  error: (err: unknown) => void\n}\n\nfunction createPushableStream(): PushableStream {\n  let controllerRef: ReadableStreamDefaultController\n  const stream = new ReadableStream({\n    start(controller) {\n      controllerRef = controller\n    },\n  })\n  let _isClosed = false\n\n  return {\n    stream,\n    enqueue: (chunk) => controllerRef.enqueue(chunk),\n    close: () => {\n      controllerRef.close()\n      _isClosed = true\n    },\n    isClosed: () => _isClosed,\n    error: (err: unknown) => controllerRef.error(err),\n  }\n}\n"],"names":["queryDehydrate","queryHydrate"],"mappings":";;AA6BO,SAAS,mCAA8D;AAAA,EAC5E;AAAA,EACA;AAAA,EACA,kBAAkB;AACpB,GAAmC;AACjC,QAAM,YAAY,OAAO,QAAQ;AACjC,QAAM,cAAc,OAAO,QAAQ;AAEnC,MAAI,OAAO,UAAU;AACnB,UAAM,kCAAkB,IAAA;AACxB,UAAM,cAAc,qBAAA;AAEpB,WAAO,QAAQ,YACb,YAAiD;AAC/C,aAAO,UAAW,iBAAiB,MAAM,YAAY,OAAO;AAC5D,YAAM,eAAe,MAAM,cAAA;AAE3B,YAAM,mBAAmB;AAAA,QACvB,GAAG;AAAA;AAAA,QAEH,aAAa,YAAY;AAAA,MAAA;AAG3B,YAAM,wBAAwBA,UAAe,WAAW;AACxD,UAAI,sBAAsB,QAAQ,SAAS,GAAG;AAC5C,8BAAsB,QAAQ,QAAQ,CAAC,UAAU;AAC/C,sBAAY,IAAI,MAAM,SAAS;AAAA,QACjC,CAAC;AACD,yBAAiB,wBAAwB;AAAA,MAC3C;AAEA,aAAO;AAAA,IACT;AAEF,UAAM,kBAAkB,YAAY,kBAAA;AACpC,gBAAY,kBAAkB;AAAA,MAC5B,GAAG;AAAA,MACH,WAAW;AAAA,QACT,sBAAsB,MAAM;AAAA,QAC5B,GAAG,gBAAgB;AAAA,MAAA;AAAA,IACrB,CACD;AAED,gBAAY,cAAA,EAAgB,UAAU,CAAC,UAAU;AAI/C,UAAI,CAAC,OAAO,WAAW,gBAAgB;AACrC;AAAA,MACF;AACA,UAAI,YAAY,IAAI,MAAM,MAAM,SAAS,GAAG;AAC1C;AAAA,MACF;AACA,UAAI,YAAY,YAAY;AAC1B,gBAAQ;AAAA,UACN,yBAAyB,MAAM,MAAM,SAAS;AAAA,QAAA;AAEhD;AAAA,MACF;AAEA,UAAI,CAAC,MAAM,MAAM,SAAS;AACxB;AAAA,MACF;AACA,kBAAY,IAAI,MAAM,MAAM,SAAS;AACrC,kBAAY;AAAA,QACVA,UAAe,aAAa;AAAA,UAC1B,sBAAsB,CAAC,UAAU;AAC/B,gBAAI,MAAM,cAAc,MAAM,MAAM,WAAW;AAC7C,qBACE,gBAAgB,WAAW,uBAAuB,KAAK,KAAK;AAAA,YAEhE;AACA,mBAAO;AAAA,UACT;AAAA,QAAA,CACD;AAAA,MAAA;AAAA,IAEL,CAAC;AAAA,EAEH,OAAO;AACL,WAAO,QAAQ,UAAU,OAAO,eAA2C;AACzE,YAAM,YAAY,UAAU;AAE5B,UAAI,WAAW,uBAAuB;AACpCC,gBAAa,aAAa,WAAW,qBAAqB;AAAA,MAC5D;AAGA,YAAM,SAAS,WAAW,YAAY,UAAA;AACtC,aACG,KAAA,EACA,KAAK,eAAe,OAAO,EAAE,MAAM,SAAS;AAC3CA,gBAAa,aAAa,KAAK;AAC/B,YAAI,MAAM;AACR;AAAA,QACF;AACA,cAAM,SAAS,MAAM,OAAO,KAAA;AAC5B,eAAO,OAAO,MAAM;AAAA,MACtB,CAAC,EACA,MAAM,CAAC,QAAQ;AACd,gBAAQ,MAAM,+BAA+B,GAAG;AAAA,MAClD,CAAC;AAAA,IACL;AACA,QAAI,iBAAiB;AACnB,YAAM,wBAAwB,YAAY,iBAAA,EAAmB;AAC7D,kBAAY,iBAAA,EAAmB,SAAS;AAAA,QACtC,GAAG;AAAA,QACH,SAAS,CAAC,OAAO,YAAY,UAAU,cAAc;AACnD,cAAI,WAAW,KAAK,GAAG;AACrB,kBAAM,QAAQ,gBAAgB,OAAO,MAAM;AAC3C,mBAAO,OAAO,SAAS,OAAO,gBAAgB,KAAK,EAAE,OAAO;AAAA,UAC9D;AAEA,iBAAO,sBAAsB;AAAA,YAC3B;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA;AAAA,QAEJ;AAAA,MAAA;AAGF,YAAM,qBAAqB,YAAY,cAAA,EAAgB;AACvD,kBAAY,cAAA,EAAgB,SAAS;AAAA,QACnC,GAAG;AAAA,QACH,SAAS,CAAC,OAAO,WAAW;AAC1B,cAAI,WAAW,KAAK,GAAG;AACrB,kBAAM,QAAQ,gBAAgB,OAAO,MAAM;AAC3C,mBAAO,OAAO,SAAS,OAAO,gBAAgB,KAAK,EAAE,OAAO;AAAA,UAC9D;AAEA,iBAAO,mBAAmB,UAAU,OAAO,MAAM;AAAA,QACnD;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AACF;AAUA,SAAS,uBAAuC;AAC9C,MAAI;AACJ,QAAM,SAAS,IAAI,eAAe;AAAA,IAChC,MAAM,YAAY;AAChB,sBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACD,MAAI,YAAY;AAEhB,SAAO;AAAA,IACL;AAAA,IACA,SAAS,CAAC,UAAU,cAAc,QAAQ,KAAK;AAAA,IAC/C,OAAO,MAAM;AACX,oBAAc,MAAA;AACd,kBAAY;AAAA,IACd;AAAA,IACA,UAAU,MAAM;AAAA,IAChB,OAAO,CAAC,QAAiB,cAAc,MAAM,GAAG;AAAA,EAAA;AAEpD;"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@tanstack/router-ssr-query-core",
+  "version": "1.121.0-alpha.28",
+  "description": "Modern and scalable routing for React applications",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/router.git",
+    "directory": "packages/router-ssr-query-core"
+  },
+  "homepage": "https://tanstack.com/router",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "react",
+    "location",
+    "router",
+    "routing",
+    "async",
+    "async router",
+    "typescript"
+  ],
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "devDependencies": {
+    "@tanstack/router-core": ">=1.127.0",
+    "@tanstack/query-core": ">=5.66.0"
+  },
+  "peerDependencies": {
+    "@tanstack/router-core": ">=1.127.0",
+    "@tanstack/query-core": ">=5.66.0"
+  },
+  "scripts": {}
+}

package/src/index.ts

@@ -0,0 +1,194 @@
+import {
+  dehydrate as queryDehydrate,
+  hydrate as queryHydrate,
+} from '@tanstack/query-core'
+import { isRedirect } from '@tanstack/router-core'
+import type { AnyRouter } from '@tanstack/router-core'
+import type {
+  QueryClient,
+  DehydratedState as QueryDehydratedState,
+} from '@tanstack/query-core'
+
+export type RouterSsrQueryOptions<TRouter extends AnyRouter> = {
+  router: TRouter
+  queryClient: QueryClient
+
+  /**
+   * If `true`, the QueryClient will handle errors thrown by `redirect()` inside of mutations and queries.
+   *
+   * @default true
+   * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction)
+   */
+  handleRedirects?: boolean
+}
+
+type DehydratedRouterQueryState = {
+  dehydratedQueryClient?: QueryDehydratedState
+  queryStream: ReadableStream<QueryDehydratedState>
+}
+
+export function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({
+  router,
+  queryClient,
+  handleRedirects = true,
+}: RouterSsrQueryOptions<TRouter>) {
+  const ogHydrate = router.options.hydrate
+  const ogDehydrate = router.options.dehydrate
+
+  if (router.isServer) {
+    const sentQueries = new Set<string>()
+    const queryStream = createPushableStream()
+
+    router.options.dehydrate =
+      async (): Promise<DehydratedRouterQueryState> => {
+        router.serverSsr!.onRenderFinished(() => queryStream.close())
+        const ogDehydrated = await ogDehydrate?.()
+
+        const dehydratedRouter = {
+          ...ogDehydrated,
+          // prepare the stream for queries coming up during rendering
+          queryStream: queryStream.stream,
+        }
+
+        const dehydratedQueryClient = queryDehydrate(queryClient)
+        if (dehydratedQueryClient.queries.length > 0) {
+          dehydratedQueryClient.queries.forEach((query) => {
+            sentQueries.add(query.queryHash)
+          })
+          dehydratedRouter.dehydratedQueryClient = dehydratedQueryClient
+        }
+
+        return dehydratedRouter
+      }
+
+    const ogClientOptions = queryClient.getDefaultOptions()
+    queryClient.setDefaultOptions({
+      ...ogClientOptions,
+      dehydrate: {
+        shouldDehydrateQuery: () => true,
+        ...ogClientOptions.dehydrate,
+      },
+    })
+
+    queryClient.getQueryCache().subscribe((event) => {
+      // before rendering starts, we do not stream individual queries
+      // instead we dehydrate the entire query client in router's dehydrate()
+      // if attachRouterServerSsrUtils() has not been called yet, `router.serverSsr` will be undefined and we also do not stream
+      if (!router.serverSsr?.isDehydrated()) {
+        return
+      }
+      if (sentQueries.has(event.query.queryHash)) {
+        return
+      }
+      if (queryStream.isClosed()) {
+        console.warn(
+          `tried to stream query ${event.query.queryHash} after stream was already closed`,
+        )
+        return
+      }
+      // promise not yet set on the query, so we cannot stream it yet
+      if (!event.query.promise) {
+        return
+      }
+      sentQueries.add(event.query.queryHash)
+      queryStream.enqueue(
+        queryDehydrate(queryClient, {
+          shouldDehydrateQuery: (query) => {
+            if (query.queryHash === event.query.queryHash) {
+              return (
+                ogClientOptions.dehydrate?.shouldDehydrateQuery?.(query) ?? true
+              )
+            }
+            return false
+          },
+        }),
+      )
+    })
+    // on the client
+  } else {
+    router.options.hydrate = async (dehydrated: DehydratedRouterQueryState) => {
+      await ogHydrate?.(dehydrated)
+      // hydrate the query client with the dehydrated data (if it was dehydrated on the server)
+      if (dehydrated.dehydratedQueryClient) {
+        queryHydrate(queryClient, dehydrated.dehydratedQueryClient)
+      }
+
+      // read the query stream and hydrate the queries as they come in
+      const reader = dehydrated.queryStream.getReader()
+      reader
+        .read()
+        .then(async function handle({ done, value }) {
+          queryHydrate(queryClient, value)
+          if (done) {
+            return
+          }
+          const result = await reader.read()
+          return handle(result)
+        })
+        .catch((err) => {
+          console.error('Error reading query stream:', err)
+        })
+    }
+    if (handleRedirects) {
+      const ogMutationCacheConfig = queryClient.getMutationCache().config
+      queryClient.getMutationCache().config = {
+        ...ogMutationCacheConfig,
+        onError: (error, _variables, _context, _mutation) => {
+          if (isRedirect(error)) {
+            error.options._fromLocation = router.state.location
+            return router.navigate(router.resolveRedirect(error).options)
+          }
+
+          return ogMutationCacheConfig.onError?.(
+            error,
+            _variables,
+            _context,
+            _mutation,
+          )
+        },
+      }
+
+      const ogQueryCacheConfig = queryClient.getQueryCache().config
+      queryClient.getQueryCache().config = {
+        ...ogQueryCacheConfig,
+        onError: (error, _query) => {
+          if (isRedirect(error)) {
+            error.options._fromLocation = router.state.location
+            return router.navigate(router.resolveRedirect(error).options)
+          }
+
+          return ogQueryCacheConfig.onError?.(error, _query)
+        },
+      }
+    }
+  }
+}
+
+type PushableStream = {
+  stream: ReadableStream
+  enqueue: (chunk: unknown) => void
+  close: () => void
+  isClosed: () => boolean
+  error: (err: unknown) => void
+}
+
+function createPushableStream(): PushableStream {
+  let controllerRef: ReadableStreamDefaultController
+  const stream = new ReadableStream({
+    start(controller) {
+      controllerRef = controller
+    },
+  })
+  let _isClosed = false
+
+  return {
+    stream,
+    enqueue: (chunk) => controllerRef.enqueue(chunk),
+    close: () => {
+      controllerRef.close()
+      _isClosed = true
+    },
+    isClosed: () => _isClosed,
+    error: (err: unknown) => controllerRef.error(err),
+  }
+}