From d9cf9331b83fcbd2abfee75d839d862f9bb18e6b Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sat, 16 May 2026 21:10:08 +0200 Subject: [PATCH 001/471] fix(router-core): hydrate before initial client route match (#7416) --- .changeset/bright-rivers-hydrate.md | 5 ++ packages/router-core/src/ssr/ssr-client.ts | 7 ++- packages/router-core/tests/hydrate.test.ts | 68 ++++++++++++++++++++++ 3 files changed, 77 insertions(+), 3 deletions(-) create mode 100644 .changeset/bright-rivers-hydrate.md diff --git a/.changeset/bright-rivers-hydrate.md b/.changeset/bright-rivers-hydrate.md new file mode 100644 index 0000000000..c3171f98a3 --- /dev/null +++ b/.changeset/bright-rivers-hydrate.md @@ -0,0 +1,5 @@ +--- +'@tanstack/router-core': patch +--- + +Run custom router hydration before the initial client route match so hydrated router configuration, such as request-specific URL rewrites, can be installed before SSR hydration compares matches. diff --git a/packages/router-core/src/ssr/ssr-client.ts b/packages/router-core/src/ssr/ssr-client.ts index 6b5623eae8..2aa5358ac0 100644 --- a/packages/router-core/src/ssr/ssr-client.ts +++ b/packages/router-core/src/ssr/ssr-client.ts @@ -94,6 +94,10 @@ export async function hydrate(router: AnyRouter): Promise { nonce, } + // Allow the user to handle custom hydration data before matching routes. + // This lets hydration install router config that affects matching, e.g. rewrites. + await router.options.hydrate?.(dehydratedData) + // Hydrate the router state const matches = router.matchRoutes(router.stores.location.get()) @@ -164,9 +168,6 @@ export async function hydrate(router: AnyRouter): Promise { router.stores.setMatches(matches) - // Allow the user to handle custom hydration data - await router.options.hydrate?.(dehydratedData) - // now that all necessary data is hydrated: // 1) fully reconstruct the route context // 2) execute `head()` and `scripts()` for each match diff --git a/packages/router-core/tests/hydrate.test.ts b/packages/router-core/tests/hydrate.test.ts index e9bb82018a..d21445ada6 100644 --- a/packages/router-core/tests/hydrate.test.ts +++ b/packages/router-core/tests/hydrate.test.ts @@ -4,6 +4,7 @@ import { BaseRootRoute, BaseRoute, notFound } from '../src' import { hydrate } from '../src/ssr/client' import { createTestRouter } from './routerTestUtils' import { dehydrateSsrMatchId } from '../src/ssr/ssr-match-id' +import type { LocationRewrite } from '../src' import type { TsrSsrGlobal } from '../src/ssr/types' import type { AnyRouteMatch } from '../src' @@ -395,6 +396,73 @@ describe('hydrate', () => { expect((mockRouter.state.matches[0] as AnyRouteMatch).id).toBe('/') }) + it('should run custom hydration before matching routes', async () => { + const history = createMemoryHistory({ initialEntries: ['/public'] }) + + const rootRoute = new BaseRootRoute({}) + const internalRoute = new BaseRoute({ + getParentRoute: () => rootRoute, + path: '/internal', + component: () => 'Internal', + }) + + const rewrite: LocationRewrite = { + input: ({ url }) => { + if (url.pathname === '/public') { + url.pathname = '/internal' + } + return url + }, + } + + mockRouter = createTestRouter({ + routeTree: rootRoute.addChildren([internalRoute]), + history, + isServer: true, + hydrate: (dehydrated: { rewrite?: boolean }) => { + if (dehydrated.rewrite) { + mockRouter.update({ rewrite }) + } + }, + }) + + mockWindow.$_TSR = { + router: { + manifest: { routes: {} }, + dehydratedData: { rewrite: true }, + lastMatchId: '/internal/internal', + matches: [ + { + i: '__root__/', + s: 'success', + ssr: true, + u: Date.now(), + }, + { + i: '/internal/internal', + s: 'success', + ssr: true, + u: Date.now(), + }, + ], + }, + h: vi.fn(), + e: vi.fn(), + c: vi.fn(), + p: vi.fn(), + buffer: [], + initialized: false, + } + + await hydrate(mockRouter) + + expect(mockRouter.state.location.pathname).toBe('/internal') + expect(mockRouter.state.location.publicHref).toBe('/public') + expect( + mockRouter.state.matches.map((match: AnyRouteMatch) => match.routeId), + ).toEqual(['__root__', '/internal']) + }) + it('should handle errors during route context hydration', async () => { const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {}) mockHead.mockImplementation(() => { From d1dc4ae7c06db0b9035850968f791f1e403c43f2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 21:17:56 +0200 Subject: [PATCH 002/471] ci: Version Packages (#7417) --- .changeset/bright-rivers-hydrate.md | 5 - .../package.json | 4 +- .../react/authenticated-routes/package.json | 4 +- .../basic-default-search-params/package.json | 2 +- .../react/basic-devtools-panel/package.json | 2 +- examples/react/basic-file-based/package.json | 4 +- .../basic-non-nested-devtools/package.json | 2 +- .../basic-react-query-file-based/package.json | 4 +- examples/react/basic-react-query/package.json | 2 +- .../react/basic-ssr-file-based/package.json | 4 +- .../package.json | 4 +- .../basic-virtual-file-based/package.json | 4 +- .../package.json | 4 +- examples/react/basic/package.json | 2 +- examples/react/deferred-data/package.json | 2 +- examples/react/i18n-paraglide/package.json | 4 +- .../kitchen-sink-file-based/package.json | 4 +- .../package.json | 4 +- .../kitchen-sink-react-query/package.json | 2 +- examples/react/kitchen-sink/package.json | 2 +- examples/react/large-file-based/package.json | 4 +- examples/react/location-masking/package.json | 2 +- .../react/navigation-blocking/package.json | 2 +- .../package.json | 4 +- .../react/quickstart-file-based/package.json | 4 +- .../quickstart-rspack-file-based/package.json | 4 +- .../package.json | 4 +- examples/react/quickstart/package.json | 2 +- .../router-monorepo-react-query/package.json | 4 +- .../packages/router/package.json | 4 +- .../router-monorepo-simple-lazy/package.json | 4 +- .../packages/router/package.json | 4 +- .../react/router-monorepo-simple/package.json | 4 +- .../packages/router/package.json | 4 +- .../react/scroll-restoration/package.json | 2 +- .../search-validator-adapters/package.json | 4 +- examples/react/start-bare/package.json | 4 +- examples/react/start-basic-auth/package.json | 4 +- .../react/start-basic-authjs/package.json | 4 +- .../react/start-basic-cloudflare/package.json | 4 +- .../start-basic-react-query/package.json | 4 +- .../react/start-basic-static/package.json | 6 +- examples/react/start-basic/package.json | 4 +- examples/react/start-bun/package.json | 6 +- examples/react/start-clerk-basic/package.json | 4 +- .../react/start-convex-trellaux/package.json | 4 +- examples/react/start-counter/package.json | 4 +- .../react/start-i18n-paraglide/package.json | 4 +- examples/react/start-large/package.json | 4 +- examples/react/start-material-ui/package.json | 4 +- examples/react/start-rscs/package.json | 4 +- .../package.json | 4 +- .../react/start-supabase-basic/package.json | 4 +- examples/react/start-tailwind-v4/package.json | 4 +- examples/react/start-trellaux/package.json | 4 +- examples/react/start-workos/package.json | 4 +- examples/react/view-transitions/package.json | 4 +- .../react/with-framer-motion/package.json | 2 +- .../react/with-trpc-react-query/package.json | 4 +- examples/react/with-trpc/package.json | 4 +- .../package.json | 4 +- .../solid/authenticated-routes/package.json | 4 +- .../basic-default-search-params/package.json | 2 +- .../solid/basic-devtools-panel/package.json | 2 +- examples/solid/basic-file-based/package.json | 4 +- .../basic-non-nested-devtools/package.json | 2 +- .../basic-solid-query-file-based/package.json | 4 +- examples/solid/basic-solid-query/package.json | 4 +- .../solid/basic-ssr-file-based/package.json | 4 +- .../package.json | 4 +- .../basic-virtual-file-based/package.json | 4 +- .../package.json | 4 +- examples/solid/basic/package.json | 2 +- examples/solid/deferred-data/package.json | 2 +- examples/solid/i18n-paraglide/package.json | 4 +- .../kitchen-sink-file-based/package.json | 4 +- .../package.json | 4 +- .../kitchen-sink-solid-query/package.json | 2 +- examples/solid/kitchen-sink/package.json | 2 +- examples/solid/large-file-based/package.json | 4 +- examples/solid/location-masking/package.json | 2 +- .../solid/navigation-blocking/package.json | 2 +- .../package.json | 4 +- .../solid/quickstart-file-based/package.json | 4 +- .../quickstart-rspack-file-based/package.json | 4 +- .../package.json | 4 +- examples/solid/quickstart/package.json | 2 +- .../router-monorepo-simple-lazy/package.json | 4 +- .../packages/router/package.json | 4 +- .../solid/router-monorepo-simple/package.json | 4 +- .../packages/router/package.json | 4 +- .../router-monorepo-solid-query/package.json | 4 +- .../packages/router/package.json | 4 +- .../solid/scroll-restoration/package.json | 2 +- .../search-validator-adapters/package.json | 4 +- examples/solid/start-basic-auth/package.json | 4 +- .../solid/start-basic-authjs/package.json | 4 +- .../solid/start-basic-cloudflare/package.json | 4 +- .../solid/start-basic-netlify/package.json | 4 +- examples/solid/start-basic-nitro/package.json | 4 +- .../start-basic-solid-query/package.json | 4 +- .../solid/start-basic-static/package.json | 6 +- examples/solid/start-basic/package.json | 4 +- examples/solid/start-bun/package.json | 6 +- .../start-convex-better-auth/package.json | 4 +- examples/solid/start-counter/package.json | 4 +- .../solid/start-i18n-paraglide/package.json | 4 +- examples/solid/start-large/package.json | 4 +- .../package.json | 4 +- .../solid/start-supabase-basic/package.json | 4 +- examples/solid/start-tailwind-v4/package.json | 4 +- examples/solid/view-transitions/package.json | 4 +- .../solid/with-framer-motion/package.json | 2 +- examples/solid/with-trpc/package.json | 4 +- .../vue/basic-file-based-jsx/package.json | 4 +- .../vue/basic-file-based-sfc/package.json | 4 +- examples/vue/basic/package.json | 2 +- packages/react-router/CHANGELOG.md | 7 ++ packages/react-router/package.json | 2 +- packages/react-start-client/CHANGELOG.md | 9 ++ packages/react-start-client/package.json | 2 +- packages/react-start-rsc/CHANGELOG.md | 13 +++ packages/react-start-rsc/package.json | 2 +- packages/react-start-server/CHANGELOG.md | 10 ++ packages/react-start-server/package.json | 2 +- packages/react-start/CHANGELOG.md | 13 +++ packages/react-start/package.json | 2 +- packages/router-cli/CHANGELOG.md | 7 ++ packages/router-cli/package.json | 2 +- packages/router-core/CHANGELOG.md | 6 ++ packages/router-core/package.json | 2 +- packages/router-generator/CHANGELOG.md | 7 ++ packages/router-generator/package.json | 2 +- packages/router-plugin/CHANGELOG.md | 9 ++ packages/router-plugin/package.json | 2 +- packages/router-vite-plugin/CHANGELOG.md | 7 ++ packages/router-vite-plugin/package.json | 2 +- packages/solid-router/CHANGELOG.md | 7 ++ packages/solid-router/package.json | 2 +- packages/solid-start-client/CHANGELOG.md | 9 ++ packages/solid-start-client/package.json | 2 +- packages/solid-start-server/CHANGELOG.md | 10 ++ packages/solid-start-server/package.json | 2 +- packages/solid-start/CHANGELOG.md | 12 +++ packages/solid-start/package.json | 2 +- packages/start-client-core/CHANGELOG.md | 8 ++ packages/start-client-core/package.json | 2 +- packages/start-plugin-core/CHANGELOG.md | 11 ++ packages/start-plugin-core/package.json | 2 +- packages/start-server-core/CHANGELOG.md | 9 ++ packages/start-server-core/package.json | 2 +- .../CHANGELOG.md | 9 ++ .../package.json | 2 +- packages/start-storage-context/CHANGELOG.md | 7 ++ packages/start-storage-context/package.json | 2 +- packages/vue-router/CHANGELOG.md | 7 ++ packages/vue-router/package.json | 2 +- packages/vue-start-client/CHANGELOG.md | 9 ++ packages/vue-start-client/package.json | 2 +- packages/vue-start-server/CHANGELOG.md | 10 ++ packages/vue-start-server/package.json | 2 +- packages/vue-start/CHANGELOG.md | 12 +++ packages/vue-start/package.json | 2 +- pnpm-lock.yaml | 102 +++++++++--------- 164 files changed, 492 insertions(+), 289 deletions(-) delete mode 100644 .changeset/bright-rivers-hydrate.md diff --git a/.changeset/bright-rivers-hydrate.md b/.changeset/bright-rivers-hydrate.md deleted file mode 100644 index c3171f98a3..0000000000 --- a/.changeset/bright-rivers-hydrate.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@tanstack/router-core': patch ---- - -Run custom router hydration before the initial client route match so hydrated router configuration, such as request-specific URL rewrites, can be installed before SSR hydration compares matches. diff --git a/examples/react/authenticated-routes-firebase/package.json b/examples/react/authenticated-routes-firebase/package.json index 60ee55281f..068f8a342f 100644 --- a/examples/react/authenticated-routes-firebase/package.json +++ b/examples/react/authenticated-routes-firebase/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "firebase": "^11.4.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/authenticated-routes/package.json b/examples/react/authenticated-routes/package.json index 79a3c3df1a..c3ea913031 100644 --- a/examples/react/authenticated-routes/package.json +++ b/examples/react/authenticated-routes/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-default-search-params/package.json b/examples/react/basic-default-search-params/package.json index e83cacd8ac..330873370a 100644 --- a/examples/react/basic-default-search-params/package.json +++ b/examples/react/basic-default-search-params/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-devtools-panel/package.json b/examples/react/basic-devtools-panel/package.json index 20a6c10f7d..33f3b32a78 100644 --- a/examples/react/basic-devtools-panel/package.json +++ b/examples/react/basic-devtools-panel/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query-devtools": "^5.67.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-file-based/package.json b/examples/react/basic-file-based/package.json index cd54a270e3..dbd4738cc5 100644 --- a/examples/react/basic-file-based/package.json +++ b/examples/react/basic-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-non-nested-devtools/package.json b/examples/react/basic-non-nested-devtools/package.json index 62bae071cd..df1b0526b7 100644 --- a/examples/react/basic-non-nested-devtools/package.json +++ b/examples/react/basic-non-nested-devtools/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-react-query-file-based/package.json b/examples/react/basic-react-query-file-based/package.json index 942d89908d..a7e2abd57c 100644 --- a/examples/react/basic-react-query-file-based/package.json +++ b/examples/react/basic-react-query-file-based/package.json @@ -12,9 +12,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-react-query/package.json b/examples/react/basic-react-query/package.json index faba457384..30ee6bccc4 100644 --- a/examples/react/basic-react-query/package.json +++ b/examples/react/basic-react-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-ssr-file-based/package.json b/examples/react/basic-ssr-file-based/package.json index abd4e7665b..9a7fdf2c17 100644 --- a/examples/react/basic-ssr-file-based/package.json +++ b/examples/react/basic-ssr-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-ssr-streaming-file-based/package.json b/examples/react/basic-ssr-streaming-file-based/package.json index 2a4e298059..8b731872f6 100644 --- a/examples/react/basic-ssr-streaming-file-based/package.json +++ b/examples/react/basic-ssr-streaming-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-virtual-file-based/package.json b/examples/react/basic-virtual-file-based/package.json index dbe8c6a948..6a3cb76132 100644 --- a/examples/react/basic-virtual-file-based/package.json +++ b/examples/react/basic-virtual-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-virtual-inside-file-based/package.json b/examples/react/basic-virtual-inside-file-based/package.json index 70123992ea..11711ab6d4 100644 --- a/examples/react/basic-virtual-inside-file-based/package.json +++ b/examples/react/basic-virtual-inside-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json index 967c12abec..2a5ae68e0a 100644 --- a/examples/react/basic/package.json +++ b/examples/react/basic/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/deferred-data/package.json b/examples/react/deferred-data/package.json index d96ee59e26..29faf6ddad 100644 --- a/examples/react/deferred-data/package.json +++ b/examples/react/deferred-data/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/i18n-paraglide/package.json b/examples/react/i18n-paraglide/package.json index 5c8b3aed8a..f9660b5a51 100644 --- a/examples/react/i18n-paraglide/package.json +++ b/examples/react/i18n-paraglide/package.json @@ -11,8 +11,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/kitchen-sink-file-based/package.json b/examples/react/kitchen-sink-file-based/package.json index aef1006e6d..2cb913d75b 100644 --- a/examples/react/kitchen-sink-file-based/package.json +++ b/examples/react/kitchen-sink-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/kitchen-sink-react-query-file-based/package.json b/examples/react/kitchen-sink-react-query-file-based/package.json index d4231a3249..442ac70096 100644 --- a/examples/react/kitchen-sink-react-query-file-based/package.json +++ b/examples/react/kitchen-sink-react-query-file-based/package.json @@ -12,9 +12,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/kitchen-sink-react-query/package.json b/examples/react/kitchen-sink-react-query/package.json index 4abcbd35d5..31eac760a0 100644 --- a/examples/react/kitchen-sink-react-query/package.json +++ b/examples/react/kitchen-sink-react-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "immer": "^10.1.1", "react": "^19.0.0", diff --git a/examples/react/kitchen-sink/package.json b/examples/react/kitchen-sink/package.json index b8452735ac..b2b53203c7 100644 --- a/examples/react/kitchen-sink/package.json +++ b/examples/react/kitchen-sink/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "immer": "^10.1.1", "react": "^19.0.0", diff --git a/examples/react/large-file-based/package.json b/examples/react/large-file-based/package.json index 80b13aa75d..95343422aa 100644 --- a/examples/react/large-file-based/package.json +++ b/examples/react/large-file-based/package.json @@ -13,9 +13,9 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/location-masking/package.json b/examples/react/location-masking/package.json index 7b0e2b2189..958ba20958 100644 --- a/examples/react/location-masking/package.json +++ b/examples/react/location-masking/package.json @@ -12,7 +12,7 @@ "@radix-ui/react-dialog": "^1.1.6", "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/navigation-blocking/package.json b/examples/react/navigation-blocking/package.json index 49d7a6bc90..5afe9be7b5 100644 --- a/examples/react/navigation-blocking/package.json +++ b/examples/react/navigation-blocking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/quickstart-esbuild-file-based/package.json b/examples/react/quickstart-esbuild-file-based/package.json index e8b193ce69..934c0547ca 100644 --- a/examples/react/quickstart-esbuild-file-based/package.json +++ b/examples/react/quickstart-esbuild-file-based/package.json @@ -9,9 +9,9 @@ "start": "dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-file-based/package.json b/examples/react/quickstart-file-based/package.json index 13e69cafab..3aa38e266c 100644 --- a/examples/react/quickstart-file-based/package.json +++ b/examples/react/quickstart-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-rspack-file-based/package.json b/examples/react/quickstart-rspack-file-based/package.json index 01e744669e..b8b5b9b969 100644 --- a/examples/react/quickstart-rspack-file-based/package.json +++ b/examples/react/quickstart-rspack-file-based/package.json @@ -9,7 +9,7 @@ }, "dependencies": { "@tailwindcss/postcss": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "postcss": "^8.5.1", "react": "^19.0.0", @@ -19,7 +19,7 @@ "devDependencies": { "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-react": "^2.0.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "typescript": "^6.0.2" diff --git a/examples/react/quickstart-webpack-file-based/package.json b/examples/react/quickstart-webpack-file-based/package.json index 14261bf46d..d76879f768 100644 --- a/examples/react/quickstart-webpack-file-based/package.json +++ b/examples/react/quickstart-webpack-file-based/package.json @@ -7,14 +7,14 @@ "build": "webpack build && tsc --noEmit" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0" }, "devDependencies": { "@swc/core": "^1.10.15", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "html-webpack-plugin": "^5.6.3", diff --git a/examples/react/quickstart/package.json b/examples/react/quickstart/package.json index f857597cf6..2e69525fdc 100644 --- a/examples/react/quickstart/package.json +++ b/examples/react/quickstart/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/router-monorepo-react-query/package.json b/examples/react/router-monorepo-react-query/package.json index 2299f3e040..9f83d4d02b 100644 --- a/examples/react/router-monorepo-react-query/package.json +++ b/examples/react/router-monorepo-react-query/package.json @@ -12,9 +12,9 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-react-query/packages/router/package.json b/examples/react/router-monorepo-react-query/packages/router/package.json index 4f1f24990f..46bbfa52ef 100644 --- a/examples/react/router-monorepo-react-query/packages/router/package.json +++ b/examples/react/router-monorepo-react-query/packages/router/package.json @@ -10,8 +10,8 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "@router-mono-react-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/react/router-monorepo-simple-lazy/package.json b/examples/react/router-monorepo-simple-lazy/package.json index 32680de14a..ae3800ff18 100644 --- a/examples/react/router-monorepo-simple-lazy/package.json +++ b/examples/react/router-monorepo-simple-lazy/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple-lazy/packages/router/package.json b/examples/react/router-monorepo-simple-lazy/packages/router/package.json index 7132fe20f6..2af6668850 100644 --- a/examples/react/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/react/router-monorepo-simple-lazy/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/router-monorepo-simple/package.json b/examples/react/router-monorepo-simple/package.json index c67122b0af..54f824889a 100644 --- a/examples/react/router-monorepo-simple/package.json +++ b/examples/react/router-monorepo-simple/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple/packages/router/package.json b/examples/react/router-monorepo-simple/packages/router/package.json index 0e404a097e..f2c47f982e 100644 --- a/examples/react/router-monorepo-simple/packages/router/package.json +++ b/examples/react/router-monorepo-simple/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/react-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/scroll-restoration/package.json b/examples/react/scroll-restoration/package.json index b8803208b1..11b1803e03 100644 --- a/examples/react/scroll-restoration/package.json +++ b/examples/react/scroll-restoration/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-virtual": "^3.13.0", "react": "^19.0.0", diff --git a/examples/react/search-validator-adapters/package.json b/examples/react/search-validator-adapters/package.json index be13142119..a9b2130400 100644 --- a/examples/react/search-validator-adapters/package.json +++ b/examples/react/search-validator-adapters/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/arktype-adapter": "^1.167.0", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/react/start-bare/package.json b/examples/react/start-bare/package.json index 026e8f29c7..9f88e2274a 100644 --- a/examples/react/start-bare/package.json +++ b/examples/react/start-bare/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-basic-auth/package.json b/examples/react/start-basic-auth/package.json index f7e8db638a..b0218741cb 100644 --- a/examples/react/start-basic-auth/package.json +++ b/examples/react/start-basic-auth/package.json @@ -14,9 +14,9 @@ "@libsql/client": "^0.15.15", "@prisma/adapter-libsql": "^7.0.0", "@prisma/client": "^7.0.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-authjs/package.json b/examples/react/start-basic-authjs/package.json index c1142df36f..f4701e3271 100644 --- a/examples/react/start-basic-authjs/package.json +++ b/examples/react/start-basic-authjs/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@auth/core": "^0.41.1", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "start-authjs": "^1.0.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-basic-cloudflare/package.json b/examples/react/start-basic-cloudflare/package.json index 97fe760dee..592ba54b9d 100644 --- a/examples/react/start-basic-cloudflare/package.json +++ b/examples/react/start-basic-cloudflare/package.json @@ -12,9 +12,9 @@ "postinstall": "npm run cf-typegen" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-basic-react-query/package.json b/examples/react/start-basic-react-query/package.json index 7ed9d76b07..345ba8b8c0 100644 --- a/examples/react/start-basic-react-query/package.json +++ b/examples/react/start-basic-react-query/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-static/package.json b/examples/react/start-basic-static/package.json index c86b413627..1349bdb011 100644 --- a/examples/react/start-basic-static/package.json +++ b/examples/react/start-basic-static/package.json @@ -10,10 +10,10 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", - "@tanstack/start-static-server-functions": "^1.167.2", + "@tanstack/react-start": "^1.168.4", + "@tanstack/start-static-server-functions": "^1.167.3", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-basic/package.json b/examples/react/start-basic/package.json index b8f3816694..69052b04c7 100644 --- a/examples/react/start-basic/package.json +++ b/examples/react/start-basic/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-bun/package.json b/examples/react/start-bun/package.json index 375a6b456c..a9ac508791 100644 --- a/examples/react/start-bun/package.json +++ b/examples/react/start-bun/package.json @@ -15,11 +15,11 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-devtools": "^0.7.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.3", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/react-start": "^1.168.4", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/start-clerk-basic/package.json b/examples/react/start-clerk-basic/package.json index ba26a66490..a7d72f0dda 100644 --- a/examples/react/start-clerk-basic/package.json +++ b/examples/react/start-clerk-basic/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@clerk/tanstack-react-start": "^0.27.14", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-convex-trellaux/package.json b/examples/react/start-convex-trellaux/package.json index e2ced747cc..442680ea65 100644 --- a/examples/react/start-convex-trellaux/package.json +++ b/examples/react/start-convex-trellaux/package.json @@ -15,10 +15,10 @@ "@convex-dev/react-query": "0.0.0-alpha.8", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "concurrently": "^8.2.2", "convex": "^1.19.0", "ky": "^1.7.4", diff --git a/examples/react/start-counter/package.json b/examples/react/start-counter/package.json index effa5f92ee..4018f94faa 100644 --- a/examples/react/start-counter/package.json +++ b/examples/react/start-counter/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-i18n-paraglide/package.json b/examples/react/start-i18n-paraglide/package.json index 2cef0a32b7..12179e6056 100644 --- a/examples/react/start-i18n-paraglide/package.json +++ b/examples/react/start-i18n-paraglide/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tanstack/react-devtools": "^0.7.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.1.1", "react-dom": "^19.1.1" }, diff --git a/examples/react/start-large/package.json b/examples/react/start-large/package.json index eae7eac274..62400fbf89 100644 --- a/examples/react/start-large/package.json +++ b/examples/react/start-large/package.json @@ -13,9 +13,9 @@ }, "dependencies": { "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-material-ui/package.json b/examples/react/start-material-ui/package.json index 74067c2636..3dadbbf45f 100644 --- a/examples/react/start-material-ui/package.json +++ b/examples/react/start-material-ui/package.json @@ -15,8 +15,8 @@ "@emotion/styled": "11.14.0", "@fontsource-variable/roboto": "5.2.5", "@mui/material": "6.4.7", - "@tanstack/react-router": "^1.170.2", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-router": "^1.170.3", + "@tanstack/react-start": "^1.168.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-rscs/package.json b/examples/react/start-rscs/package.json index d2b2da2592..322d71f3b4 100644 --- a/examples/react/start-rscs/package.json +++ b/examples/react/start-rscs/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "dexie": "^4.0.10", "react": "^19.2.0", "react-dom": "^19.2.0", diff --git a/examples/react/start-streaming-data-from-server-functions/package.json b/examples/react/start-streaming-data-from-server-functions/package.json index 0abc879c12..dbc79a5892 100644 --- a/examples/react/start-streaming-data-from-server-functions/package.json +++ b/examples/react/start-streaming-data-from-server-functions/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-supabase-basic/package.json b/examples/react/start-supabase-basic/package.json index 4c09e48f61..416753bc38 100644 --- a/examples/react/start-supabase-basic/package.json +++ b/examples/react/start-supabase-basic/package.json @@ -15,9 +15,9 @@ "dependencies": { "@supabase/ssr": "^0.5.2", "@supabase/supabase-js": "^2.48.1", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/start-tailwind-v4/package.json b/examples/react/start-tailwind-v4/package.json index 2dfb8b2589..4de46a76b9 100644 --- a/examples/react/start-tailwind-v4/package.json +++ b/examples/react/start-tailwind-v4/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-trellaux/package.json b/examples/react/start-trellaux/package.json index 94a45d0d4d..a9168e8c67 100644 --- a/examples/react/start-trellaux/package.json +++ b/examples/react/start-trellaux/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "ky": "^1.7.4", "msw": "^2.7.0", "react": "^19.0.0", diff --git a/examples/react/start-workos/package.json b/examples/react/start-workos/package.json index e81a81621c..0de1f05205 100644 --- a/examples/react/start-workos/package.json +++ b/examples/react/start-workos/package.json @@ -14,9 +14,9 @@ "license": "MIT", "dependencies": { "@radix-ui/themes": "^3.3.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.3", + "@tanstack/react-start": "^1.168.4", "@workos/authkit-tanstack-react-start": "^0.5.0", "react": "^19.0.0", "react-dom": "^19.0.0" diff --git a/examples/react/view-transitions/package.json b/examples/react/view-transitions/package.json index 4d351aca89..59bfaa85b5 100644 --- a/examples/react/view-transitions/package.json +++ b/examples/react/view-transitions/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/with-framer-motion/package.json b/examples/react/with-framer-motion/package.json index b842cd786e..b359a95112 100644 --- a/examples/react/with-framer-motion/package.json +++ b/examples/react/with-framer-motion/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "framer-motion": "^11.18.2", "react": "^19.0.0", diff --git a/examples/react/with-trpc-react-query/package.json b/examples/react/with-trpc-react-query/package.json index 214635a652..941a6394eb 100644 --- a/examples/react/with-trpc-react-query/package.json +++ b/examples/react/with-trpc-react-query/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "@trpc/tanstack-react-query": "^11.4.3", diff --git a/examples/react/with-trpc/package.json b/examples/react/with-trpc/package.json index 6e63b01c04..97a1a3a5fc 100644 --- a/examples/react/with-trpc/package.json +++ b/examples/react/with-trpc/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.2", + "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/solid/authenticated-routes-firebase/package.json b/examples/solid/authenticated-routes-firebase/package.json index 46a03c5ffe..aae835f673 100644 --- a/examples/solid/authenticated-routes-firebase/package.json +++ b/examples/solid/authenticated-routes-firebase/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "firebase": "^11.4.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/authenticated-routes/package.json b/examples/solid/authenticated-routes/package.json index 7dd3c78b91..e0d81c0992 100644 --- a/examples/solid/authenticated-routes/package.json +++ b/examples/solid/authenticated-routes/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/basic-default-search-params/package.json b/examples/solid/basic-default-search-params/package.json index 6bb4be2b80..be24973e6f 100644 --- a/examples/solid/basic-default-search-params/package.json +++ b/examples/solid/basic-default-search-params/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic-devtools-panel/package.json b/examples/solid/basic-devtools-panel/package.json index f1c1e7093a..8deac68782 100644 --- a/examples/solid/basic-devtools-panel/package.json +++ b/examples/solid/basic-devtools-panel/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/basic-file-based/package.json b/examples/solid/basic-file-based/package.json index eb2c1d2c25..4aaa636626 100644 --- a/examples/solid/basic-file-based/package.json +++ b/examples/solid/basic-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-non-nested-devtools/package.json b/examples/solid/basic-non-nested-devtools/package.json index deb9a6e396..fc02b78d1b 100644 --- a/examples/solid/basic-non-nested-devtools/package.json +++ b/examples/solid/basic-non-nested-devtools/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/basic-solid-query-file-based/package.json b/examples/solid/basic-solid-query-file-based/package.json index 7b8119c24b..57519b5b7a 100644 --- a/examples/solid/basic-solid-query-file-based/package.json +++ b/examples/solid/basic-solid-query-file-based/package.json @@ -13,7 +13,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -21,7 +21,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-solid-query/package.json b/examples/solid/basic-solid-query/package.json index 0fc4eec3a3..4640d953be 100644 --- a/examples/solid/basic-solid-query/package.json +++ b/examples/solid/basic-solid-query/package.json @@ -12,14 +12,14 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-ssr-file-based/package.json b/examples/solid/basic-ssr-file-based/package.json index 9cef0afc4b..593f7b74ef 100644 --- a/examples/solid/basic-ssr-file-based/package.json +++ b/examples/solid/basic-ssr-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/solid/basic-ssr-streaming-file-based/package.json b/examples/solid/basic-ssr-streaming-file-based/package.json index cfdf4745a7..6194520a40 100644 --- a/examples/solid/basic-ssr-streaming-file-based/package.json +++ b/examples/solid/basic-ssr-streaming-file-based/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "compression": "^1.8.0", "express": "^4.21.2", @@ -24,7 +24,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@types/express": "^4.17.23", "typescript": "^6.0.2", "vite": "^8.0.0", diff --git a/examples/solid/basic-virtual-file-based/package.json b/examples/solid/basic-virtual-file-based/package.json index 99e850c27f..475fdc4b48 100644 --- a/examples/solid/basic-virtual-file-based/package.json +++ b/examples/solid/basic-virtual-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic-virtual-inside-file-based/package.json b/examples/solid/basic-virtual-inside-file-based/package.json index a02486e8e4..c0bc2c3b28 100644 --- a/examples/solid/basic-virtual-inside-file-based/package.json +++ b/examples/solid/basic-virtual-inside-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic/package.json b/examples/solid/basic/package.json index f1b39e262b..8f85fb4f39 100644 --- a/examples/solid/basic/package.json +++ b/examples/solid/basic/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/deferred-data/package.json b/examples/solid/deferred-data/package.json index 1685c1102a..26085772ed 100644 --- a/examples/solid/deferred-data/package.json +++ b/examples/solid/deferred-data/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/i18n-paraglide/package.json b/examples/solid/i18n-paraglide/package.json index e6a4cb0648..649a38426f 100644 --- a/examples/solid/i18n-paraglide/package.json +++ b/examples/solid/i18n-paraglide/package.json @@ -11,8 +11,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/kitchen-sink-file-based/package.json b/examples/solid/kitchen-sink-file-based/package.json index 4d459621f6..5440e05833 100644 --- a/examples/solid/kitchen-sink-file-based/package.json +++ b/examples/solid/kitchen-sink-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", @@ -19,7 +19,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/kitchen-sink-solid-query-file-based/package.json b/examples/solid/kitchen-sink-solid-query-file-based/package.json index d477466b99..1521a021cc 100644 --- a/examples/solid/kitchen-sink-solid-query-file-based/package.json +++ b/examples/solid/kitchen-sink-solid-query-file-based/package.json @@ -10,10 +10,10 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", diff --git a/examples/solid/kitchen-sink-solid-query/package.json b/examples/solid/kitchen-sink-solid-query/package.json index 20cf127c65..8646f62275 100644 --- a/examples/solid/kitchen-sink-solid-query/package.json +++ b/examples/solid/kitchen-sink-solid-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", diff --git a/examples/solid/kitchen-sink/package.json b/examples/solid/kitchen-sink/package.json index b391eb8255..50df16bc04 100644 --- a/examples/solid/kitchen-sink/package.json +++ b/examples/solid/kitchen-sink/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "solid-js": "^1.9.10", diff --git a/examples/solid/large-file-based/package.json b/examples/solid/large-file-based/package.json index d10faebaf0..607626d016 100644 --- a/examples/solid/large-file-based/package.json +++ b/examples/solid/large-file-based/package.json @@ -13,9 +13,9 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/location-masking/package.json b/examples/solid/location-masking/package.json index d953be5d5d..c9ebde2269 100644 --- a/examples/solid/location-masking/package.json +++ b/examples/solid/location-masking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/navigation-blocking/package.json b/examples/solid/navigation-blocking/package.json index 2c500db0b7..c30d80ec00 100644 --- a/examples/solid/navigation-blocking/package.json +++ b/examples/solid/navigation-blocking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/quickstart-esbuild-file-based/package.json b/examples/solid/quickstart-esbuild-file-based/package.json index 8b965a4b86..2a808b92cd 100644 --- a/examples/solid/quickstart-esbuild-file-based/package.json +++ b/examples/solid/quickstart-esbuild-file-based/package.json @@ -9,8 +9,8 @@ "start": "dev" }, "dependencies": { - "@tanstack/router-plugin": "^1.168.3", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/router-plugin": "^1.168.4", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/quickstart-file-based/package.json b/examples/solid/quickstart-file-based/package.json index 0d1333590d..63d725a699 100644 --- a/examples/solid/quickstart-file-based/package.json +++ b/examples/solid/quickstart-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/quickstart-rspack-file-based/package.json b/examples/solid/quickstart-rspack-file-based/package.json index a3667f7125..0446de0264 100644 --- a/examples/solid/quickstart-rspack-file-based/package.json +++ b/examples/solid/quickstart-rspack-file-based/package.json @@ -9,7 +9,7 @@ }, "dependencies": { "@tailwindcss/postcss": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "postcss": "^8.5.1", "solid-js": "^1.9.10", @@ -19,7 +19,7 @@ "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-babel": "^1.1.2", "@rsbuild/plugin-solid": "^1.1.1", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "typescript": "^6.0.2" } } diff --git a/examples/solid/quickstart-webpack-file-based/package.json b/examples/solid/quickstart-webpack-file-based/package.json index 73faeaae29..1856d14e85 100644 --- a/examples/solid/quickstart-webpack-file-based/package.json +++ b/examples/solid/quickstart-webpack-file-based/package.json @@ -7,7 +7,7 @@ "build": "webpack build && tsc --noEmit" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" @@ -15,7 +15,7 @@ "devDependencies": { "@babel/core": "^7.28.5", "@babel/preset-typescript": "^7.27.1", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "babel-loader": "^10.0.0", "babel-preset-solid": "^1.9.10", "css-loader": "^7.1.2", diff --git a/examples/solid/quickstart/package.json b/examples/solid/quickstart/package.json index 5fcb28c28b..0e783bd1f2 100644 --- a/examples/solid/quickstart/package.json +++ b/examples/solid/quickstart/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" diff --git a/examples/solid/router-monorepo-simple-lazy/package.json b/examples/solid/router-monorepo-simple-lazy/package.json index e3cbcbf1da..cb6d4b57c7 100644 --- a/examples/solid/router-monorepo-simple-lazy/package.json +++ b/examples/solid/router-monorepo-simple-lazy/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json index 0cfb0c673a..0925bbb46a 100644 --- a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/solid-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-simple/package.json b/examples/solid/router-monorepo-simple/package.json index defe09b517..a773ea7e59 100644 --- a/examples/solid/router-monorepo-simple/package.json +++ b/examples/solid/router-monorepo-simple/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple/packages/router/package.json b/examples/solid/router-monorepo-simple/packages/router/package.json index cc73e73ce9..8dbfbefb13 100644 --- a/examples/solid/router-monorepo-simple/packages/router/package.json +++ b/examples/solid/router-monorepo-simple/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/solid-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-solid-query/package.json b/examples/solid/router-monorepo-solid-query/package.json index fc151118da..e52659bf32 100644 --- a/examples/solid/router-monorepo-solid-query/package.json +++ b/examples/solid/router-monorepo-solid-query/package.json @@ -12,9 +12,9 @@ "dependencies": { "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-solid-query/packages/router/package.json b/examples/solid/router-monorepo-solid-query/packages/router/package.json index efd042cac1..1aeec389a8 100644 --- a/examples/solid/router-monorepo-solid-query/packages/router/package.json +++ b/examples/solid/router-monorepo-solid-query/packages/router/package.json @@ -10,8 +10,8 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.4", "@router-solid-mono-solid-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/solid/scroll-restoration/package.json b/examples/solid/scroll-restoration/package.json index 7db0c43c3b..4660d6062b 100644 --- a/examples/solid/scroll-restoration/package.json +++ b/examples/solid/scroll-restoration/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-virtual": "^3.13.0", "solid-js": "^1.9.10", diff --git a/examples/solid/search-validator-adapters/package.json b/examples/solid/search-validator-adapters/package.json index 5eece7dd93..24ae7b52ee 100644 --- a/examples/solid/search-validator-adapters/package.json +++ b/examples/solid/search-validator-adapters/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/arktype-adapter": "^1.167.0", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/solid/start-basic-auth/package.json b/examples/solid/start-basic-auth/package.json index dcbe8a2079..7965405fbc 100644 --- a/examples/solid/start-basic-auth/package.json +++ b/examples/solid/start-basic-auth/package.json @@ -14,9 +14,9 @@ "@libsql/client": "^0.15.15", "@prisma/adapter-libsql": "^7.0.0", "@prisma/client": "^7.0.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-authjs/package.json b/examples/solid/start-basic-authjs/package.json index 05c3360292..20e09c9275 100644 --- a/examples/solid/start-basic-authjs/package.json +++ b/examples/solid/start-basic-authjs/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@auth/core": "^0.41.1", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "start-authjs": "^1.0.0", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-cloudflare/package.json b/examples/solid/start-basic-cloudflare/package.json index fcbfc96a70..1cfbea7dc4 100644 --- a/examples/solid/start-basic-cloudflare/package.json +++ b/examples/solid/start-basic-cloudflare/package.json @@ -12,9 +12,9 @@ "postinstall": "npm run cf-typegen" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-netlify/package.json b/examples/solid/start-basic-netlify/package.json index 84e78f692b..469c552190 100644 --- a/examples/solid/start-basic-netlify/package.json +++ b/examples/solid/start-basic-netlify/package.json @@ -9,9 +9,9 @@ "preview": "vite preview" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-nitro/package.json b/examples/solid/start-basic-nitro/package.json index c1c78cb8ff..a1792e8a1e 100644 --- a/examples/solid/start-basic-nitro/package.json +++ b/examples/solid/start-basic-nitro/package.json @@ -9,9 +9,9 @@ "preview": "vite preview" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-solid-query/package.json b/examples/solid/start-basic-solid-query/package.json index 7069b73991..0c63ea4a25 100644 --- a/examples/solid/start-basic-solid-query/package.json +++ b/examples/solid/start-basic-solid-query/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-static/package.json b/examples/solid/start-basic-static/package.json index cd28f85e75..fe5ad697e2 100644 --- a/examples/solid/start-basic-static/package.json +++ b/examples/solid/start-basic-static/package.json @@ -10,10 +10,10 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", - "@tanstack/start-static-server-functions": "^1.167.2", + "@tanstack/solid-start": "^1.168.4", + "@tanstack/start-static-server-functions": "^1.167.3", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic/package.json b/examples/solid/start-basic/package.json index 26a0adb35e..bc29157e3d 100644 --- a/examples/solid/start-basic/package.json +++ b/examples/solid/start-basic/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-bun/package.json b/examples/solid/start-bun/package.json index 1939f38e01..5ae1f11259 100644 --- a/examples/solid/start-bun/package.json +++ b/examples/solid/start-bun/package.json @@ -15,11 +15,11 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-devtools": "^0.7.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/start-convex-better-auth/package.json b/examples/solid/start-convex-better-auth/package.json index 2321be2e05..b75ac5e8a7 100644 --- a/examples/solid/start-convex-better-auth/package.json +++ b/examples/solid/start-convex-better-auth/package.json @@ -13,9 +13,9 @@ "dependencies": { "@convex-dev/better-auth": "^0.9.7", "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "better-auth": "^1.3.27", "clsx": "^2.1.1", "convex": "^1.28.2", diff --git a/examples/solid/start-counter/package.json b/examples/solid/start-counter/package.json index c8424a3c17..a4c98b6b1c 100644 --- a/examples/solid/start-counter/package.json +++ b/examples/solid/start-counter/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-i18n-paraglide/package.json b/examples/solid/start-i18n-paraglide/package.json index e163beee56..2370bbce10 100644 --- a/examples/solid/start-i18n-paraglide/package.json +++ b/examples/solid/start-i18n-paraglide/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tanstack/solid-devtools": "^0.7.0", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-large/package.json b/examples/solid/start-large/package.json index eb5acef798..bf0725ae2b 100644 --- a/examples/solid/start-large/package.json +++ b/examples/solid/start-large/package.json @@ -13,9 +13,9 @@ }, "dependencies": { "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-streaming-data-from-server-functions/package.json b/examples/solid/start-streaming-data-from-server-functions/package.json index 68d665b7cb..d814fa504a 100644 --- a/examples/solid/start-streaming-data-from-server-functions/package.json +++ b/examples/solid/start-streaming-data-from-server-functions/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10", "zod": "^3.24.2" }, diff --git a/examples/solid/start-supabase-basic/package.json b/examples/solid/start-supabase-basic/package.json index e638244488..c310fcecfc 100644 --- a/examples/solid/start-supabase-basic/package.json +++ b/examples/solid/start-supabase-basic/package.json @@ -14,9 +14,9 @@ "dependencies": { "@supabase/ssr": "^0.5.2", "@supabase/supabase-js": "^2.48.1", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.9", "redaxios": "^0.5.1" }, diff --git a/examples/solid/start-tailwind-v4/package.json b/examples/solid/start-tailwind-v4/package.json index ef74ed43b7..c84c862781 100644 --- a/examples/solid/start-tailwind-v4/package.json +++ b/examples/solid/start-tailwind-v4/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.3", + "@tanstack/solid-start": "^1.168.4", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0", "zod": "^3.24.2" diff --git a/examples/solid/view-transitions/package.json b/examples/solid/view-transitions/package.json index 7cc146e60f..6106d46dc2 100644 --- a/examples/solid/view-transitions/package.json +++ b/examples/solid/view-transitions/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/with-framer-motion/package.json b/examples/solid/with-framer-motion/package.json index 13b4444906..d432c2ebb6 100644 --- a/examples/solid/with-framer-motion/package.json +++ b/examples/solid/with-framer-motion/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/with-trpc/package.json b/examples/solid/with-trpc/package.json index 39683f1215..192a7d637f 100644 --- a/examples/solid/with-trpc/package.json +++ b/examples/solid/with-trpc/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.2", + "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.3", + "@tanstack/router-plugin": "^1.168.4", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/vue/basic-file-based-jsx/package.json b/examples/vue/basic-file-based-jsx/package.json index 4ba557caee..e7555c4e56 100644 --- a/examples/vue/basic-file-based-jsx/package.json +++ b/examples/vue/basic-file-based-jsx/package.json @@ -10,8 +10,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.3", - "@tanstack/vue-router": "^1.170.2", + "@tanstack/router-plugin": "^1.168.4", + "@tanstack/vue-router": "^1.170.3", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "redaxios": "^0.5.1", diff --git a/examples/vue/basic-file-based-sfc/package.json b/examples/vue/basic-file-based-sfc/package.json index ed3c13fb52..3a7553a785 100644 --- a/examples/vue/basic-file-based-sfc/package.json +++ b/examples/vue/basic-file-based-sfc/package.json @@ -10,8 +10,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.3", - "@tanstack/vue-router": "^1.170.2", + "@tanstack/router-plugin": "^1.168.4", + "@tanstack/vue-router": "^1.170.3", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "redaxios": "^0.5.1", diff --git a/examples/vue/basic/package.json b/examples/vue/basic/package.json index 457a5e0799..fc8df0e7e1 100644 --- a/examples/vue/basic/package.json +++ b/examples/vue/basic/package.json @@ -9,7 +9,7 @@ "start": "vite" }, "dependencies": { - "@tanstack/vue-router": "^1.170.2", + "@tanstack/vue-router": "^1.170.3", "@tanstack/vue-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "vue": "^3.5.13", diff --git a/packages/react-router/CHANGELOG.md b/packages/react-router/CHANGELOG.md index c9575ab8a2..c402caad88 100644 --- a/packages/react-router/CHANGELOG.md +++ b/packages/react-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/react-router +## 1.170.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + ## 1.170.2 ### Patch Changes diff --git a/packages/react-router/package.json b/packages/react-router/package.json index cca581d6cf..f2ecb396ff 100644 --- a/packages/react-router/package.json +++ b/packages/react-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-router", - "version": "1.170.2", + "version": "1.170.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-client/CHANGELOG.md b/packages/react-start-client/CHANGELOG.md index 960185ec37..1ef52d2724 100644 --- a/packages/react-start-client/CHANGELOG.md +++ b/packages/react-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/react-start-client +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/react-router@1.170.3 + - @tanstack/start-client-core@1.169.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/react-start-client/package.json b/packages/react-start-client/package.json index 234fd7c385..85362ffce0 100644 --- a/packages/react-start-client/package.json +++ b/packages/react-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-client", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-rsc/CHANGELOG.md b/packages/react-start-rsc/CHANGELOG.md index 9d6f531003..06ea030b20 100644 --- a/packages/react-start-rsc/CHANGELOG.md +++ b/packages/react-start-rsc/CHANGELOG.md @@ -1,5 +1,18 @@ # @tanstack/react-start-rsc +## 0.1.4 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/react-router@1.170.3 + - @tanstack/react-start-server@1.167.3 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-plugin-core@1.170.4 + - @tanstack/start-server-core@1.168.3 + - @tanstack/start-storage-context@1.167.3 + ## 0.1.3 ### Patch Changes diff --git a/packages/react-start-rsc/package.json b/packages/react-start-rsc/package.json index 87ab9a1c51..e8d2ea2330 100644 --- a/packages/react-start-rsc/package.json +++ b/packages/react-start-rsc/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-rsc", - "version": "0.1.3", + "version": "0.1.4", "description": "React Server Components support for TanStack Start", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-server/CHANGELOG.md b/packages/react-start-server/CHANGELOG.md index bc37e5169a..13407d8042 100644 --- a/packages/react-start-server/CHANGELOG.md +++ b/packages/react-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/react-start-server +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/react-router@1.170.3 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-server-core@1.168.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/react-start-server/package.json b/packages/react-start-server/package.json index 6527ddbb90..4b776ce84f 100644 --- a/packages/react-start-server/package.json +++ b/packages/react-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-server", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start/CHANGELOG.md b/packages/react-start/CHANGELOG.md index 57ac042fc9..99a507f8b9 100644 --- a/packages/react-start/CHANGELOG.md +++ b/packages/react-start/CHANGELOG.md @@ -1,5 +1,18 @@ # @tanstack/react-start +## 1.168.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/react-router@1.170.3 + - @tanstack/react-start-client@1.167.3 + - @tanstack/react-start-rsc@0.1.4 + - @tanstack/react-start-server@1.167.3 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-plugin-core@1.170.4 + - @tanstack/start-server-core@1.168.3 + ## 1.168.3 ### Patch Changes diff --git a/packages/react-start/package.json b/packages/react-start/package.json index 53854906de..9c71cf7d07 100644 --- a/packages/react-start/package.json +++ b/packages/react-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start", - "version": "1.168.3", + "version": "1.168.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-cli/CHANGELOG.md b/packages/router-cli/CHANGELOG.md index 817b1508db..32c5166063 100644 --- a/packages/router-cli/CHANGELOG.md +++ b/packages/router-cli/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-cli +## 1.167.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/router-generator@1.167.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/router-cli/package.json b/packages/router-cli/package.json index d39e8bd1f1..81e27c88cb 100644 --- a/packages/router-cli/package.json +++ b/packages/router-cli/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-cli", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-core/CHANGELOG.md b/packages/router-core/CHANGELOG.md index 0a0981aa60..6ccfbcd375 100644 --- a/packages/router-core/CHANGELOG.md +++ b/packages/router-core/CHANGELOG.md @@ -1,5 +1,11 @@ # @tanstack/router-core +## 1.171.1 + +### Patch Changes + +- Run custom router hydration before the initial client route match so hydrated router configuration, such as request-specific URL rewrites, can be installed before SSR hydration compares matches. ([#7416](https://github.com/TanStack/router/pull/7416)) + ## 1.171.0 ### Minor Changes diff --git a/packages/router-core/package.json b/packages/router-core/package.json index b03a943f81..10c21bf674 100644 --- a/packages/router-core/package.json +++ b/packages/router-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-core", - "version": "1.171.0", + "version": "1.171.1", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-generator/CHANGELOG.md b/packages/router-generator/CHANGELOG.md index 29299f95bb..8b10112aa2 100644 --- a/packages/router-generator/CHANGELOG.md +++ b/packages/router-generator/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-generator +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + ## 1.167.3 ### Patch Changes diff --git a/packages/router-generator/package.json b/packages/router-generator/package.json index 566ee52c30..aa56873077 100644 --- a/packages/router-generator/package.json +++ b/packages/router-generator/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-generator", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-plugin/CHANGELOG.md b/packages/router-plugin/CHANGELOG.md index 42379418ac..b99c325d57 100644 --- a/packages/router-plugin/CHANGELOG.md +++ b/packages/router-plugin/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/router-plugin +## 1.168.4 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/react-router@1.170.3 + - @tanstack/router-generator@1.167.4 + ## 1.168.3 ### Patch Changes diff --git a/packages/router-plugin/package.json b/packages/router-plugin/package.json index 97b403224d..97dbd3c548 100644 --- a/packages/router-plugin/package.json +++ b/packages/router-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-plugin", - "version": "1.168.3", + "version": "1.168.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-vite-plugin/CHANGELOG.md b/packages/router-vite-plugin/CHANGELOG.md index da6e366ace..b1d2d75286 100644 --- a/packages/router-vite-plugin/CHANGELOG.md +++ b/packages/router-vite-plugin/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-vite-plugin +## 1.167.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/router-plugin@1.168.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/router-vite-plugin/package.json b/packages/router-vite-plugin/package.json index 27a0b930f6..0de6daef7f 100644 --- a/packages/router-vite-plugin/package.json +++ b/packages/router-vite-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-vite-plugin", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-router/CHANGELOG.md b/packages/solid-router/CHANGELOG.md index c5df9949fe..619424a6d2 100644 --- a/packages/solid-router/CHANGELOG.md +++ b/packages/solid-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/solid-router +## 1.170.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + ## 1.170.2 ### Patch Changes diff --git a/packages/solid-router/package.json b/packages/solid-router/package.json index 24ec23c6f2..378a0134d1 100644 --- a/packages/solid-router/package.json +++ b/packages/solid-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-router", - "version": "1.170.2", + "version": "1.170.3", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start-client/CHANGELOG.md b/packages/solid-start-client/CHANGELOG.md index 2022e55d6a..f2d7c12550 100644 --- a/packages/solid-start-client/CHANGELOG.md +++ b/packages/solid-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/solid-start-client +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/solid-router@1.170.3 + - @tanstack/start-client-core@1.169.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/solid-start-client/package.json b/packages/solid-start-client/package.json index 4c97d15026..f3eb7b36d4 100644 --- a/packages/solid-start-client/package.json +++ b/packages/solid-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start-client", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start-server/CHANGELOG.md b/packages/solid-start-server/CHANGELOG.md index b6627c77c1..0c2b03d1f3 100644 --- a/packages/solid-start-server/CHANGELOG.md +++ b/packages/solid-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/solid-start-server +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/solid-router@1.170.3 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-server-core@1.168.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/solid-start-server/package.json b/packages/solid-start-server/package.json index 8566bce65f..4c50256d81 100644 --- a/packages/solid-start-server/package.json +++ b/packages/solid-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start-server", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start/CHANGELOG.md b/packages/solid-start/CHANGELOG.md index 2057732f32..40e3a7a937 100644 --- a/packages/solid-start/CHANGELOG.md +++ b/packages/solid-start/CHANGELOG.md @@ -1,5 +1,17 @@ # @tanstack/solid-start +## 1.168.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/solid-router@1.170.3 + - @tanstack/solid-start-client@1.167.3 + - @tanstack/solid-start-server@1.167.3 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-plugin-core@1.170.4 + - @tanstack/start-server-core@1.168.3 + ## 1.168.3 ### Patch Changes diff --git a/packages/solid-start/package.json b/packages/solid-start/package.json index 5a8758d0c7..0f8b502393 100644 --- a/packages/solid-start/package.json +++ b/packages/solid-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start", - "version": "1.168.3", + "version": "1.168.4", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-client-core/CHANGELOG.md b/packages/start-client-core/CHANGELOG.md index 40a01aa1ec..aaeaa020c7 100644 --- a/packages/start-client-core/CHANGELOG.md +++ b/packages/start-client-core/CHANGELOG.md @@ -1,5 +1,13 @@ # @tanstack/start-client-core +## 1.169.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/start-storage-context@1.167.3 + ## 1.169.2 ### Patch Changes diff --git a/packages/start-client-core/package.json b/packages/start-client-core/package.json index b10ccefda0..c593f6496a 100644 --- a/packages/start-client-core/package.json +++ b/packages/start-client-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-client-core", - "version": "1.169.2", + "version": "1.169.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-plugin-core/CHANGELOG.md b/packages/start-plugin-core/CHANGELOG.md index f76216cab7..c5809c6cc6 100644 --- a/packages/start-plugin-core/CHANGELOG.md +++ b/packages/start-plugin-core/CHANGELOG.md @@ -1,5 +1,16 @@ # @tanstack/start-plugin-core +## 1.170.4 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/router-generator@1.167.4 + - @tanstack/router-plugin@1.168.4 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-server-core@1.168.3 + ## 1.170.3 ### Patch Changes diff --git a/packages/start-plugin-core/package.json b/packages/start-plugin-core/package.json index ba0bdac88e..6335ec9103 100644 --- a/packages/start-plugin-core/package.json +++ b/packages/start-plugin-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-plugin-core", - "version": "1.170.3", + "version": "1.170.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-server-core/CHANGELOG.md b/packages/start-server-core/CHANGELOG.md index e55aaec886..a7c4ce0220 100644 --- a/packages/start-server-core/CHANGELOG.md +++ b/packages/start-server-core/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/start-server-core +## 1.168.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-storage-context@1.167.3 + ## 1.168.2 ### Patch Changes diff --git a/packages/start-server-core/package.json b/packages/start-server-core/package.json index 7eff3b9d02..355f01de36 100644 --- a/packages/start-server-core/package.json +++ b/packages/start-server-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-server-core", - "version": "1.168.2", + "version": "1.168.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-static-server-functions/CHANGELOG.md b/packages/start-static-server-functions/CHANGELOG.md index dd0ce96f95..0b9e11b808 100644 --- a/packages/start-static-server-functions/CHANGELOG.md +++ b/packages/start-static-server-functions/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/start-static-server-functions +## 1.167.3 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-client-core@1.169.3 + - @tanstack/react-start@1.168.4 + - @tanstack/solid-start@1.168.4 + ## 1.167.2 ### Patch Changes diff --git a/packages/start-static-server-functions/package.json b/packages/start-static-server-functions/package.json index 91666aa872..608302a1f4 100644 --- a/packages/start-static-server-functions/package.json +++ b/packages/start-static-server-functions/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-static-server-functions", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-storage-context/CHANGELOG.md b/packages/start-storage-context/CHANGELOG.md index fe2013db7a..8d3a8216c7 100644 --- a/packages/start-storage-context/CHANGELOG.md +++ b/packages/start-storage-context/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/start-storage-context +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + ## 1.167.2 ### Patch Changes diff --git a/packages/start-storage-context/package.json b/packages/start-storage-context/package.json index d9a4d1c2dc..bc98121ae8 100644 --- a/packages/start-storage-context/package.json +++ b/packages/start-storage-context/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-storage-context", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-router/CHANGELOG.md b/packages/vue-router/CHANGELOG.md index 42cd5df294..54925b20a7 100644 --- a/packages/vue-router/CHANGELOG.md +++ b/packages/vue-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/vue-router +## 1.170.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + ## 1.170.2 ### Patch Changes diff --git a/packages/vue-router/package.json b/packages/vue-router/package.json index f3d6573ec7..eb737a011b 100644 --- a/packages/vue-router/package.json +++ b/packages/vue-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-router", - "version": "1.170.2", + "version": "1.170.3", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start-client/CHANGELOG.md b/packages/vue-start-client/CHANGELOG.md index 4c8a216487..8d501931d7 100644 --- a/packages/vue-start-client/CHANGELOG.md +++ b/packages/vue-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/vue-start-client +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/start-client-core@1.169.3 + - @tanstack/vue-router@1.170.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/vue-start-client/package.json b/packages/vue-start-client/package.json index d8198f99fc..6968c2f1f2 100644 --- a/packages/vue-start-client/package.json +++ b/packages/vue-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start-client", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start-server/CHANGELOG.md b/packages/vue-start-server/CHANGELOG.md index 2732013858..e4d42599f4 100644 --- a/packages/vue-start-server/CHANGELOG.md +++ b/packages/vue-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/vue-start-server +## 1.167.3 + +### Patch Changes + +- Updated dependencies [[`d9cf933`](https://github.com/TanStack/router/commit/d9cf9331b83fcbd2abfee75d839d862f9bb18e6b)]: + - @tanstack/router-core@1.171.1 + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-server-core@1.168.3 + - @tanstack/vue-router@1.170.3 + ## 1.167.2 ### Patch Changes diff --git a/packages/vue-start-server/package.json b/packages/vue-start-server/package.json index 4c51f8bdd1..687db38892 100644 --- a/packages/vue-start-server/package.json +++ b/packages/vue-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start-server", - "version": "1.167.2", + "version": "1.167.3", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start/CHANGELOG.md b/packages/vue-start/CHANGELOG.md index 8c7e2b2b1a..d8c3adb836 100644 --- a/packages/vue-start/CHANGELOG.md +++ b/packages/vue-start/CHANGELOG.md @@ -1,5 +1,17 @@ # @tanstack/vue-start +## 1.168.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-client-core@1.169.3 + - @tanstack/start-plugin-core@1.170.4 + - @tanstack/start-server-core@1.168.3 + - @tanstack/vue-router@1.170.3 + - @tanstack/vue-start-client@1.167.3 + - @tanstack/vue-start-server@1.167.3 + ## 1.168.3 ### Patch Changes diff --git a/packages/vue-start/package.json b/packages/vue-start/package.json index 3902887479..e64e57d8ae 100644 --- a/packages/vue-start/package.json +++ b/packages/vue-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start", - "version": "1.168.3", + "version": "1.168.4", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 657cded1ec..f6ead91017 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -10016,7 +10016,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10053,7 +10053,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10093,7 +10093,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10133,7 +10133,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10167,7 +10167,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10198,7 +10198,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10235,7 +10235,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10278,7 +10278,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10318,7 +10318,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10355,7 +10355,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router compression: specifier: ^1.8.0 @@ -10395,7 +10395,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10450,7 +10450,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10490,7 +10490,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10527,7 +10527,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10564,7 +10564,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router solid-js: specifier: 1.9.12 @@ -10595,7 +10595,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10632,7 +10632,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10678,7 +10678,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10724,7 +10724,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10767,7 +10767,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10804,7 +10804,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10838,7 +10838,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10869,7 +10869,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10897,7 +10897,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10928,7 +10928,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10965,7 +10965,7 @@ importers: specifier: ^4.2.2 version: 4.2.2 '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10999,7 +10999,7 @@ importers: examples/solid/quickstart-webpack-file-based: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11060,7 +11060,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11094,7 +11094,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11134,7 +11134,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11168,7 +11168,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11208,7 +11208,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11254,7 +11254,7 @@ importers: examples/solid/start-basic: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11306,7 +11306,7 @@ importers: specifier: ^7.0.0 version: 7.0.0(prisma@7.0.0(@types/react@19.2.9)(react-dom@19.2.3(react@19.2.3))(react@19.2.3)(typescript@6.0.2))(typescript@6.0.2) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11355,7 +11355,7 @@ importers: specifier: ^0.41.1 version: 0.41.1 '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11395,7 +11395,7 @@ importers: examples/solid/start-basic-cloudflare: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11435,7 +11435,7 @@ importers: examples/solid/start-basic-netlify: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11472,7 +11472,7 @@ importers: examples/solid/start-basic-nitro: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11515,7 +11515,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11558,7 +11558,7 @@ importers: examples/solid/start-basic-static: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11610,7 +11610,7 @@ importers: specifier: ^0.7.0 version: 0.7.14(csstype@3.2.3)(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11674,7 +11674,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11729,7 +11729,7 @@ importers: examples/solid/start-counter: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11772,7 +11772,7 @@ importers: specifier: ^0.7.0 version: 0.7.14(csstype@3.2.3)(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11812,7 +11812,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11855,7 +11855,7 @@ importers: examples/solid/start-streaming-data-from-server-functions: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11892,7 +11892,7 @@ importers: specifier: ^2.48.1 version: 2.48.1 '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11929,7 +11929,7 @@ importers: examples/solid/start-tailwind-v4: dependencies: '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11975,7 +11975,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -12009,7 +12009,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -12049,7 +12049,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.2 + specifier: ^1.170.3 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ From 8146db7e54f5d508f1fb7d3927edd0a2f71dc930 Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sun, 17 May 2026 00:42:32 +0200 Subject: [PATCH 003/471] fix(router-plugin): detect typed root route context for HMR (#7420) --- .changeset/tidy-root-route-hmr.md | 5 + .../react-refresh-ignored-route-exports.ts | 2 +- .../src/core/router-code-splitter-plugin.ts | 14 +- .../src/core/router-hmr-plugin.ts | 10 +- packages/router-plugin/src/core/utils.ts | 6 + .../snapshots/react/arrow-function@true.tsx | 1 - .../createRootRoute-inline-component@true.tsx | 1 - .../snapshots/react/createRootRoute@false.tsx | 10 ++ .../snapshots/react/createRootRoute@true.tsx | 164 +++++++++++++++++ ...teRootRouteWithContext-type-args@false.tsx | 14 ++ ...ateRootRouteWithContext-type-args@true.tsx | 167 ++++++++++++++++++ .../explicit-undefined-component@true.tsx | 1 - .../react/function-declaration@true.tsx | 1 - .../snapshots/react/multi-component@true.tsx | 1 - .../react/string-literal-keys@true.tsx | 1 - .../test-files/react/createRootRoute.tsx | 10 ++ .../createRootRouteWithContext-type-args.tsx | 14 ++ packages/router-plugin/tests/utils.test.ts | 41 +++++ 18 files changed, 437 insertions(+), 26 deletions(-) create mode 100644 .changeset/tidy-root-route-hmr.md create mode 100644 packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@false.tsx create mode 100644 packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx create mode 100644 packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@false.tsx create mode 100644 packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx create mode 100644 packages/router-plugin/tests/add-hmr/test-files/react/createRootRoute.tsx create mode 100644 packages/router-plugin/tests/add-hmr/test-files/react/createRootRouteWithContext-type-args.tsx diff --git a/.changeset/tidy-root-route-hmr.md b/.changeset/tidy-root-route-hmr.md new file mode 100644 index 0000000000..2e972f5ea4 --- /dev/null +++ b/.changeset/tidy-root-route-hmr.md @@ -0,0 +1,5 @@ +--- +'@tanstack/router-plugin': patch +--- + +Fix Vite Fast Refresh detection for root routes created with `createRootRouteWithContext` type arguments. diff --git a/packages/router-plugin/src/core/code-splitter/plugins/react-refresh-ignored-route-exports.ts b/packages/router-plugin/src/core/code-splitter/plugins/react-refresh-ignored-route-exports.ts index fdb1d8ec35..cc2be62034 100644 --- a/packages/router-plugin/src/core/code-splitter/plugins/react-refresh-ignored-route-exports.ts +++ b/packages/router-plugin/src/core/code-splitter/plugins/react-refresh-ignored-route-exports.ts @@ -7,7 +7,7 @@ const buildReactRefreshIgnoredRouteExportsStatements = template.statements( ` const hot = import.meta.hot if (hot && typeof window !== 'undefined') { - ;(hot.data ??= {}) + hot.data ??= {} const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map() const previousGetIgnoredExports = window.__getReactRefreshIgnoredExports diff --git a/packages/router-plugin/src/core/router-code-splitter-plugin.ts b/packages/router-plugin/src/core/router-code-splitter-plugin.ts index e291b05fe9..8f6324bae1 100644 --- a/packages/router-plugin/src/core/router-code-splitter-plugin.ts +++ b/packages/router-plugin/src/core/router-code-splitter-plugin.ts @@ -21,7 +21,7 @@ import { tsrSplit, } from './constants' import { decodeIdentifier } from './code-splitter/path-ids' -import { debug, normalizePath } from './utils' +import { debug, normalizePath, routeFactoryCallCodeFilter } from './utils' import { createRouterPluginContext } from './router-plugin-context' import type { CodeSplitGroupings, SplitRouteIdentNodes } from './constants' import type { GetRoutesByFileMapResultValue } from '@tanstack/router-generator' @@ -240,11 +240,6 @@ export function createRouterCodeSplitterPlugin( return result } - const includedCode = [ - 'createFileRoute(', - 'createRootRoute(', - 'createRootRouteWithContext(', - ] return [ { name: 'tanstack-router:code-splitter:compile-reference-file', @@ -258,17 +253,14 @@ export function createRouterCodeSplitterPlugin( include: /\.(m|c)?(j|t)sx?$/, }, code: { - include: includedCode, + include: routeFactoryCallCodeFilter, }, }, handler(code, id) { const normalizedId = normalizePath(id) const generatorFileInfo = routerPluginContext.routesByFile.get(normalizedId) - if ( - generatorFileInfo && - includedCode.some((included) => code.includes(included)) - ) { + if (generatorFileInfo) { return handleCompilingReferenceFile( code, normalizedId, diff --git a/packages/router-plugin/src/core/router-hmr-plugin.ts b/packages/router-plugin/src/core/router-hmr-plugin.ts index 7b6086b440..75dfde11f8 100644 --- a/packages/router-plugin/src/core/router-hmr-plugin.ts +++ b/packages/router-plugin/src/core/router-hmr-plugin.ts @@ -2,7 +2,7 @@ import { generateFromAst, logDiff, parseAst } from '@tanstack/router-utils' import { compileCodeSplitReferenceRoute } from './code-splitter/compilers' import { getReferenceRouteCompilerPlugins } from './code-splitter/plugins/framework-plugins' import { createRouteHmrStatement } from './hmr' -import { debug, normalizePath } from './utils' +import { debug, normalizePath, routeFactoryCallCodeFilter } from './utils' import { getConfig } from './config' import { createRouterPluginContext } from './router-plugin-context' import type { UnpluginFactory } from 'unplugin' @@ -15,12 +15,6 @@ import type { RouterPluginContext } from './router-plugin-context' * handles HMR for code-split routes itself. */ -const includeCode = [ - 'createFileRoute(', - 'createRootRoute(', - 'createRootRouteWithContext(', -] - export function createRouterHmrPlugin( options: Partial Config)> | undefined = {}, routerPluginContext: RouterPluginContext, @@ -41,7 +35,7 @@ export function createRouterHmrPlugin( // this is necessary for webpack / rspack to avoid matching .html files id: /\.(m|c)?(j|t)sx?$/, code: { - include: includeCode, + include: routeFactoryCallCodeFilter, }, }, handler(code, id) { diff --git a/packages/router-plugin/src/core/utils.ts b/packages/router-plugin/src/core/utils.ts index 267582d6ec..61ab1ca278 100644 --- a/packages/router-plugin/src/core/utils.ts +++ b/packages/router-plugin/src/core/utils.ts @@ -16,6 +16,12 @@ export function normalizePath(path: string): string { return path.replace(/\\/g, '/') } +export const routeFactoryCallCodeFilter = [ + /\bcreateFileRoute\s*\(/, + /\bcreateRootRoute\s*\(/, + /\bcreateRootRouteWithContext\s*(?:<|\()/, +] + export function getObjectPropertyKeyName( prop: t.ObjectProperty, ): string | undefined { diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx index 1718d3d728..fd86f55a62 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx @@ -17,7 +17,6 @@ export const Route = createFileRoute('/posts')({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx index 5617db31bf..2e5a7196fc 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx @@ -6,7 +6,6 @@ export const Route = createRootRoute({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@false.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@false.tsx new file mode 100644 index 0000000000..e967791f8d --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@false.tsx @@ -0,0 +1,10 @@ +import * as React from 'react' +import { createRootRoute } from '@tanstack/react-router' + +export const Route = createRootRoute({ + component: RootComponent, +}) + +function RootComponent() { + return
Hello
+} diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx new file mode 100644 index 0000000000..4201a4a43e --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx @@ -0,0 +1,164 @@ +import * as React from 'react'; +import { createRootRoute } from '@tanstack/react-router'; +export const Route = createRootRoute({ + component: RootComponent +}); +function RootComponent() { + return
Hello
; +} +const hot = import.meta.hot; +if (hot && typeof window !== 'undefined') { + hot.data ??= {}; + const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { + const ignoredExportsById = new Map(); + const previousGetIgnoredExports = window.__getReactRefreshIgnoredExports; + window.__getReactRefreshIgnoredExports = ctx => { + const ignoredExports = previousGetIgnoredExports?.(ctx) ?? []; + const moduleIgnored = ignoredExportsById.get(ctx.id) ?? []; + return [...ignoredExports, ...moduleIgnored]; + }; + return { + ignoredExportsById + }; + })(); + tsrReactRefresh.ignoredExportsById.set("createRootRoute.tsx", ['Route']); +} +export function TSRFastRefreshAnchor() { + return null; +} +if (import.meta.hot) { + const hot = import.meta.hot; + const hotData = hot.data ??= {}; + hot.accept(newModule => { + if (Route && newModule && newModule.Route) { + const routeId = hotData['tsr-route-id'] ?? Route.id; + if (routeId) { + hotData['tsr-route-id'] = routeId; + } + (function handleRouteUpdate(routeId, newRoute) { + const router = window.__TSR_ROUTER__; + const oldRoute = router.routesById[routeId]; + if (!oldRoute) { + return; + } + ; + const removedKeys = new Set(); + Object.keys(oldRoute.options).forEach(key => { + if (!(key in newRoute.options)) { + removedKeys.add(key); + delete oldRoute.options[key]; + } + }); + const oldHasShellComponent = "shellComponent" in oldRoute.options; + const newHasShellComponent = "shellComponent" in newRoute.options; + const preserveComponentIdentity = oldHasShellComponent === newHasShellComponent; + const componentKeys = ["component", "shellComponent", "pendingComponent", "errorComponent", "notFoundComponent"]; + if (preserveComponentIdentity) { + componentKeys.forEach(key => { + if (key in oldRoute.options && key in newRoute.options) { + newRoute.options[key] = oldRoute.options[key]; + } + }); + } + ; + oldRoute.options = newRoute.options; + oldRoute.update(newRoute.options); + oldRoute._componentsPromise = undefined; + oldRoute._lazyPromise = undefined; + router.routesById[oldRoute.id] = oldRoute; + router.routesByPath[oldRoute.fullPath] = oldRoute; + router.processedTree.matchCache.clear(); + router.processedTree.flatCache?.clear(); + router.processedTree.singleCache.clear(); + router.resolvePathCache.clear(); + walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); + const filter = m => m.routeId === oldRoute.id; + const activeMatch = router.stores.matches.get().find(filter); + const pendingMatch = router.stores.pendingMatches.get().find(filter); + const cachedMatches = router.stores.cachedMatches.get().filter(filter); + if (activeMatch || pendingMatch || cachedMatches.length > 0) { + if (removedKeys.has("loader") || removedKeys.has("beforeLoad")) { + const matchIds = [activeMatch?.id, pendingMatch?.id, ...cachedMatches.map(match => match.id)].filter(Boolean); + router.batch(() => { + for (const matchId of matchIds) { + const store = router.stores.pendingMatchStores.get(matchId) || router.stores.matchStores.get(matchId) || router.stores.cachedMatchStores.get(matchId); + if (store) { + store.set(prev => { + const next = { + ...prev + }; + if (removedKeys.has("loader")) { + next.loaderData = undefined; + } + ; + if (removedKeys.has("beforeLoad")) { + next.__beforeLoadContext = undefined; + next.context = rebuildMatchContextWithoutBeforeLoad(next); + } + ; + return next; + }); + } + } + }); + } + ; + router.invalidate({ + filter, + sync: true + }); + } + ; + function walkReplaceSegmentTree(route, node) { + if (node.route?.id === route.id) node.route = route; + if (node.index) walkReplaceSegmentTree(route, node.index); + node.static?.forEach(child => walkReplaceSegmentTree(route, child)); + node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); + node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); + node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); + node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); + } + function getStoreMatch(matchId) { + return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); + } + function getMatchList(matchId) { + const pendingMatches = router.stores.pendingMatches.get(); + if (pendingMatches.some(match => match.id === matchId)) { + return pendingMatches; + } + ; + const activeMatches = router.stores.matches.get(); + if (activeMatches.some(match => match.id === matchId)) { + return activeMatches; + } + ; + const cachedMatches = router.stores.cachedMatches.get(); + if (cachedMatches.some(match => match.id === matchId)) { + return cachedMatches; + } + ; + return []; + } + function getParentMatch(match) { + const matchList = getMatchList(match.id); + const matchIndex = matchList.findIndex(item => item.id === match.id); + if (matchIndex <= 0) { + return undefined; + } + ; + const parentMatch = matchList[matchIndex - 1]; + return getStoreMatch(parentMatch.id) || parentMatch; + } + function rebuildMatchContextWithoutBeforeLoad(match) { + const parentMatch = getParentMatch(match); + const getParentContext = router.getParentContext; + const parentContext = getParentContext ? getParentContext.call(router, parentMatch) : parentMatch?.context ?? router.options.context; + return { + ...(parentContext ?? {}), + ...(match.__routeContext ?? {}) + }; + } + })(routeId, newModule.Route); + } + }); +} \ No newline at end of file diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@false.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@false.tsx new file mode 100644 index 0000000000..0feadacab5 --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@false.tsx @@ -0,0 +1,14 @@ +import * as React from 'react' +import { createRootRouteWithContext } from '@tanstack/react-router' + +interface MyRouterContext { + auth: boolean +} + +export const Route = createRootRouteWithContext()({ + component: RootComponent, +}) + +function RootComponent() { + return
Hello
+} diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx new file mode 100644 index 0000000000..aa97811921 --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx @@ -0,0 +1,167 @@ +import * as React from 'react'; +import { createRootRouteWithContext } from '@tanstack/react-router'; +interface MyRouterContext { + auth: boolean; +} +export const Route = createRootRouteWithContext()({ + component: RootComponent +}); +function RootComponent() { + return
Hello
; +} +const hot = import.meta.hot; +if (hot && typeof window !== 'undefined') { + hot.data ??= {}; + const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { + const ignoredExportsById = new Map(); + const previousGetIgnoredExports = window.__getReactRefreshIgnoredExports; + window.__getReactRefreshIgnoredExports = ctx => { + const ignoredExports = previousGetIgnoredExports?.(ctx) ?? []; + const moduleIgnored = ignoredExportsById.get(ctx.id) ?? []; + return [...ignoredExports, ...moduleIgnored]; + }; + return { + ignoredExportsById + }; + })(); + tsrReactRefresh.ignoredExportsById.set("createRootRouteWithContext-type-args.tsx", ['Route']); +} +export function TSRFastRefreshAnchor() { + return null; +} +if (import.meta.hot) { + const hot = import.meta.hot; + const hotData = hot.data ??= {}; + hot.accept(newModule => { + if (Route && newModule && newModule.Route) { + const routeId = hotData['tsr-route-id'] ?? Route.id; + if (routeId) { + hotData['tsr-route-id'] = routeId; + } + (function handleRouteUpdate(routeId, newRoute) { + const router = window.__TSR_ROUTER__; + const oldRoute = router.routesById[routeId]; + if (!oldRoute) { + return; + } + ; + const removedKeys = new Set(); + Object.keys(oldRoute.options).forEach(key => { + if (!(key in newRoute.options)) { + removedKeys.add(key); + delete oldRoute.options[key]; + } + }); + const oldHasShellComponent = "shellComponent" in oldRoute.options; + const newHasShellComponent = "shellComponent" in newRoute.options; + const preserveComponentIdentity = oldHasShellComponent === newHasShellComponent; + const componentKeys = ["component", "shellComponent", "pendingComponent", "errorComponent", "notFoundComponent"]; + if (preserveComponentIdentity) { + componentKeys.forEach(key => { + if (key in oldRoute.options && key in newRoute.options) { + newRoute.options[key] = oldRoute.options[key]; + } + }); + } + ; + oldRoute.options = newRoute.options; + oldRoute.update(newRoute.options); + oldRoute._componentsPromise = undefined; + oldRoute._lazyPromise = undefined; + router.routesById[oldRoute.id] = oldRoute; + router.routesByPath[oldRoute.fullPath] = oldRoute; + router.processedTree.matchCache.clear(); + router.processedTree.flatCache?.clear(); + router.processedTree.singleCache.clear(); + router.resolvePathCache.clear(); + walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); + const filter = m => m.routeId === oldRoute.id; + const activeMatch = router.stores.matches.get().find(filter); + const pendingMatch = router.stores.pendingMatches.get().find(filter); + const cachedMatches = router.stores.cachedMatches.get().filter(filter); + if (activeMatch || pendingMatch || cachedMatches.length > 0) { + if (removedKeys.has("loader") || removedKeys.has("beforeLoad")) { + const matchIds = [activeMatch?.id, pendingMatch?.id, ...cachedMatches.map(match => match.id)].filter(Boolean); + router.batch(() => { + for (const matchId of matchIds) { + const store = router.stores.pendingMatchStores.get(matchId) || router.stores.matchStores.get(matchId) || router.stores.cachedMatchStores.get(matchId); + if (store) { + store.set(prev => { + const next = { + ...prev + }; + if (removedKeys.has("loader")) { + next.loaderData = undefined; + } + ; + if (removedKeys.has("beforeLoad")) { + next.__beforeLoadContext = undefined; + next.context = rebuildMatchContextWithoutBeforeLoad(next); + } + ; + return next; + }); + } + } + }); + } + ; + router.invalidate({ + filter, + sync: true + }); + } + ; + function walkReplaceSegmentTree(route, node) { + if (node.route?.id === route.id) node.route = route; + if (node.index) walkReplaceSegmentTree(route, node.index); + node.static?.forEach(child => walkReplaceSegmentTree(route, child)); + node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); + node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); + node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); + node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); + } + function getStoreMatch(matchId) { + return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); + } + function getMatchList(matchId) { + const pendingMatches = router.stores.pendingMatches.get(); + if (pendingMatches.some(match => match.id === matchId)) { + return pendingMatches; + } + ; + const activeMatches = router.stores.matches.get(); + if (activeMatches.some(match => match.id === matchId)) { + return activeMatches; + } + ; + const cachedMatches = router.stores.cachedMatches.get(); + if (cachedMatches.some(match => match.id === matchId)) { + return cachedMatches; + } + ; + return []; + } + function getParentMatch(match) { + const matchList = getMatchList(match.id); + const matchIndex = matchList.findIndex(item => item.id === match.id); + if (matchIndex <= 0) { + return undefined; + } + ; + const parentMatch = matchList[matchIndex - 1]; + return getStoreMatch(parentMatch.id) || parentMatch; + } + function rebuildMatchContextWithoutBeforeLoad(match) { + const parentMatch = getParentMatch(match); + const getParentContext = router.getParentContext; + const parentContext = getParentContext ? getParentContext.call(router, parentMatch) : parentMatch?.context ?? router.options.context; + return { + ...(parentContext ?? {}), + ...(match.__routeContext ?? {}) + }; + } + })(routeId, newModule.Route); + } + }); +} \ No newline at end of file diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx index ed3a057652..45214b844f 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx @@ -5,7 +5,6 @@ export const Route = createFileRoute('/')({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx index 03db2a4a90..383610c28c 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx @@ -17,7 +17,6 @@ export const Route = createFileRoute('/posts')({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx index d93bd18fcc..5ea2a6fa40 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx @@ -27,7 +27,6 @@ export const Route = createFileRoute('/posts')({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx index 5d22a1c75e..99daa8bf30 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx @@ -27,7 +27,6 @@ export const Route = createFileRoute('/posts')({ }); const hot = import.meta.hot; if (hot && typeof window !== 'undefined') { - ; hot.data ??= {}; const tsrReactRefresh = window.__TSR_REACT_REFRESH__ ??= (() => { const ignoredExportsById = new Map(); diff --git a/packages/router-plugin/tests/add-hmr/test-files/react/createRootRoute.tsx b/packages/router-plugin/tests/add-hmr/test-files/react/createRootRoute.tsx new file mode 100644 index 0000000000..e967791f8d --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/test-files/react/createRootRoute.tsx @@ -0,0 +1,10 @@ +import * as React from 'react' +import { createRootRoute } from '@tanstack/react-router' + +export const Route = createRootRoute({ + component: RootComponent, +}) + +function RootComponent() { + return
Hello
+} diff --git a/packages/router-plugin/tests/add-hmr/test-files/react/createRootRouteWithContext-type-args.tsx b/packages/router-plugin/tests/add-hmr/test-files/react/createRootRouteWithContext-type-args.tsx new file mode 100644 index 0000000000..0feadacab5 --- /dev/null +++ b/packages/router-plugin/tests/add-hmr/test-files/react/createRootRouteWithContext-type-args.tsx @@ -0,0 +1,14 @@ +import * as React from 'react' +import { createRootRouteWithContext } from '@tanstack/react-router' + +interface MyRouterContext { + auth: boolean +} + +export const Route = createRootRouteWithContext()({ + component: RootComponent, +}) + +function RootComponent() { + return
Hello
+} diff --git a/packages/router-plugin/tests/utils.test.ts b/packages/router-plugin/tests/utils.test.ts index c19ab27e6a..6812b59bc3 100644 --- a/packages/router-plugin/tests/utils.test.ts +++ b/packages/router-plugin/tests/utils.test.ts @@ -6,9 +6,18 @@ import { getObjectPropertyKeyName, getUniqueProgramIdentifier, normalizePath, + routeFactoryCallCodeFilter, } from '../src/core/utils' import type { NodePath } from '@babel/core' +function matchesRouteFactoryCallCodeFilter(code: string) { + return routeFactoryCallCodeFilter.some((pattern) => { + const result = pattern.test(code) + pattern.lastIndex = 0 + return result + }) +} + function getProgramPath(code: string): NodePath { const ast = parseAst({ code }) let programPath: NodePath | undefined @@ -100,6 +109,38 @@ describe('getUniqueProgramIdentifier', () => { }) }) +describe('routeFactoryCallCodeFilter', () => { + it('matches route factory calls with TypeScript type arguments', () => { + expect( + matchesRouteFactoryCallCodeFilter( + 'createRootRouteWithContext()({})', + ), + ).toBe(true) + }) + + it('matches route factory calls without TypeScript type arguments', () => { + expect( + matchesRouteFactoryCallCodeFilter('createRootRouteWithContext()({})'), + ).toBe(true) + expect(matchesRouteFactoryCallCodeFilter('createRootRoute({})')).toBe(true) + expect( + matchesRouteFactoryCallCodeFilter("createFileRoute('/posts')({})"), + ).toBe(true) + }) + + it('matches route factory calls with whitespace before invocation', () => { + expect( + matchesRouteFactoryCallCodeFilter( + 'createRootRouteWithContext ()({})', + ), + ).toBe(true) + expect(matchesRouteFactoryCallCodeFilter('createRootRoute ({})')).toBe(true) + expect( + matchesRouteFactoryCallCodeFilter("createFileRoute ('/posts')({})"), + ).toBe(true) + }) +}) + describe('getObjectPropertyKeyName', () => { it('returns identifier keys', () => { const prop = t.objectProperty(t.identifier('component'), t.identifier('x')) From 32c5a8ec8d19afd34badb1cb0e42985b728be5b4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 17 May 2026 00:54:12 +0200 Subject: [PATCH 004/471] ci: Version Packages (#7421) --- .changeset/tidy-root-route-hmr.md | 5 ----- examples/react/authenticated-routes-firebase/package.json | 2 +- examples/react/authenticated-routes/package.json | 2 +- examples/react/basic-file-based/package.json | 2 +- examples/react/basic-react-query-file-based/package.json | 2 +- examples/react/basic-ssr-file-based/package.json | 2 +- .../react/basic-ssr-streaming-file-based/package.json | 2 +- examples/react/basic-virtual-file-based/package.json | 2 +- .../react/basic-virtual-inside-file-based/package.json | 2 +- examples/react/i18n-paraglide/package.json | 2 +- examples/react/kitchen-sink-file-based/package.json | 2 +- .../kitchen-sink-react-query-file-based/package.json | 2 +- examples/react/large-file-based/package.json | 2 +- examples/react/quickstart-esbuild-file-based/package.json | 2 +- examples/react/quickstart-file-based/package.json | 2 +- examples/react/quickstart-rspack-file-based/package.json | 2 +- examples/react/quickstart-webpack-file-based/package.json | 2 +- examples/react/router-monorepo-react-query/package.json | 2 +- .../packages/router/package.json | 2 +- examples/react/router-monorepo-simple-lazy/package.json | 2 +- .../packages/router/package.json | 2 +- examples/react/router-monorepo-simple/package.json | 2 +- .../router-monorepo-simple/packages/router/package.json | 2 +- examples/react/search-validator-adapters/package.json | 2 +- examples/react/start-bare/package.json | 2 +- examples/react/start-basic-auth/package.json | 2 +- examples/react/start-basic-authjs/package.json | 2 +- examples/react/start-basic-cloudflare/package.json | 2 +- examples/react/start-basic-react-query/package.json | 2 +- examples/react/start-basic-static/package.json | 2 +- examples/react/start-basic/package.json | 2 +- examples/react/start-bun/package.json | 4 ++-- examples/react/start-clerk-basic/package.json | 2 +- examples/react/start-convex-trellaux/package.json | 2 +- examples/react/start-counter/package.json | 2 +- examples/react/start-i18n-paraglide/package.json | 2 +- examples/react/start-large/package.json | 2 +- examples/react/start-material-ui/package.json | 2 +- examples/react/start-rscs/package.json | 2 +- .../package.json | 2 +- examples/react/start-supabase-basic/package.json | 2 +- examples/react/start-tailwind-v4/package.json | 2 +- examples/react/start-trellaux/package.json | 2 +- examples/react/start-workos/package.json | 2 +- examples/react/view-transitions/package.json | 2 +- examples/react/with-trpc-react-query/package.json | 2 +- examples/react/with-trpc/package.json | 2 +- examples/solid/authenticated-routes-firebase/package.json | 2 +- examples/solid/authenticated-routes/package.json | 2 +- examples/solid/basic-file-based/package.json | 2 +- examples/solid/basic-solid-query-file-based/package.json | 2 +- examples/solid/basic-solid-query/package.json | 2 +- examples/solid/basic-ssr-file-based/package.json | 2 +- .../solid/basic-ssr-streaming-file-based/package.json | 2 +- examples/solid/basic-virtual-file-based/package.json | 2 +- .../solid/basic-virtual-inside-file-based/package.json | 2 +- examples/solid/i18n-paraglide/package.json | 2 +- examples/solid/kitchen-sink-file-based/package.json | 2 +- .../kitchen-sink-solid-query-file-based/package.json | 2 +- examples/solid/large-file-based/package.json | 2 +- examples/solid/quickstart-esbuild-file-based/package.json | 2 +- examples/solid/quickstart-file-based/package.json | 2 +- examples/solid/quickstart-rspack-file-based/package.json | 2 +- examples/solid/quickstart-webpack-file-based/package.json | 2 +- examples/solid/router-monorepo-simple-lazy/package.json | 2 +- .../packages/router/package.json | 2 +- examples/solid/router-monorepo-simple/package.json | 2 +- .../router-monorepo-simple/packages/router/package.json | 2 +- examples/solid/router-monorepo-solid-query/package.json | 2 +- .../packages/router/package.json | 2 +- examples/solid/search-validator-adapters/package.json | 2 +- examples/solid/start-basic-auth/package.json | 2 +- examples/solid/start-basic-authjs/package.json | 2 +- examples/solid/start-basic-cloudflare/package.json | 2 +- examples/solid/start-basic-netlify/package.json | 2 +- examples/solid/start-basic-nitro/package.json | 2 +- examples/solid/start-basic-solid-query/package.json | 2 +- examples/solid/start-basic-static/package.json | 2 +- examples/solid/start-basic/package.json | 2 +- examples/solid/start-bun/package.json | 4 ++-- examples/solid/start-convex-better-auth/package.json | 2 +- examples/solid/start-counter/package.json | 2 +- examples/solid/start-i18n-paraglide/package.json | 2 +- examples/solid/start-large/package.json | 2 +- .../package.json | 2 +- examples/solid/start-supabase-basic/package.json | 2 +- examples/solid/start-tailwind-v4/package.json | 2 +- examples/solid/view-transitions/package.json | 2 +- examples/solid/with-trpc/package.json | 2 +- examples/vue/basic-file-based-jsx/package.json | 2 +- examples/vue/basic-file-based-sfc/package.json | 2 +- packages/react-start-rsc/CHANGELOG.md | 7 +++++++ packages/react-start-rsc/package.json | 2 +- packages/react-start/CHANGELOG.md | 8 ++++++++ packages/react-start/package.json | 2 +- packages/router-plugin/CHANGELOG.md | 6 ++++++ packages/router-plugin/package.json | 2 +- packages/router-vite-plugin/CHANGELOG.md | 7 +++++++ packages/router-vite-plugin/package.json | 2 +- packages/solid-start/CHANGELOG.md | 7 +++++++ packages/solid-start/package.json | 2 +- packages/start-plugin-core/CHANGELOG.md | 7 +++++++ packages/start-plugin-core/package.json | 2 +- packages/vue-start/CHANGELOG.md | 7 +++++++ packages/vue-start/package.json | 2 +- 105 files changed, 148 insertions(+), 104 deletions(-) delete mode 100644 .changeset/tidy-root-route-hmr.md diff --git a/.changeset/tidy-root-route-hmr.md b/.changeset/tidy-root-route-hmr.md deleted file mode 100644 index 2e972f5ea4..0000000000 --- a/.changeset/tidy-root-route-hmr.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@tanstack/router-plugin': patch ---- - -Fix Vite Fast Refresh detection for root routes created with `createRootRouteWithContext` type arguments. diff --git a/examples/react/authenticated-routes-firebase/package.json b/examples/react/authenticated-routes-firebase/package.json index 068f8a342f..37466a9924 100644 --- a/examples/react/authenticated-routes-firebase/package.json +++ b/examples/react/authenticated-routes-firebase/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "firebase": "^11.4.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/authenticated-routes/package.json b/examples/react/authenticated-routes/package.json index c3ea913031..639a216076 100644 --- a/examples/react/authenticated-routes/package.json +++ b/examples/react/authenticated-routes/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-file-based/package.json b/examples/react/basic-file-based/package.json index dbd4738cc5..d80dc72d3a 100644 --- a/examples/react/basic-file-based/package.json +++ b/examples/react/basic-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-react-query-file-based/package.json b/examples/react/basic-react-query-file-based/package.json index a7e2abd57c..b7e83ece95 100644 --- a/examples/react/basic-react-query-file-based/package.json +++ b/examples/react/basic-react-query-file-based/package.json @@ -14,7 +14,7 @@ "@tanstack/react-query-devtools": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-ssr-file-based/package.json b/examples/react/basic-ssr-file-based/package.json index 9a7fdf2c17..d1c73b608d 100644 --- a/examples/react/basic-ssr-file-based/package.json +++ b/examples/react/basic-ssr-file-based/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-ssr-streaming-file-based/package.json b/examples/react/basic-ssr-streaming-file-based/package.json index 8b731872f6..7e8a28015e 100644 --- a/examples/react/basic-ssr-streaming-file-based/package.json +++ b/examples/react/basic-ssr-streaming-file-based/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-virtual-file-based/package.json b/examples/react/basic-virtual-file-based/package.json index 6a3cb76132..431c0d06b5 100644 --- a/examples/react/basic-virtual-file-based/package.json +++ b/examples/react/basic-virtual-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-virtual-inside-file-based/package.json b/examples/react/basic-virtual-inside-file-based/package.json index 11711ab6d4..53bf010a1f 100644 --- a/examples/react/basic-virtual-inside-file-based/package.json +++ b/examples/react/basic-virtual-inside-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/i18n-paraglide/package.json b/examples/react/i18n-paraglide/package.json index f9660b5a51..ff9fb76c1b 100644 --- a/examples/react/i18n-paraglide/package.json +++ b/examples/react/i18n-paraglide/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/kitchen-sink-file-based/package.json b/examples/react/kitchen-sink-file-based/package.json index 2cb913d75b..2fe67acffc 100644 --- a/examples/react/kitchen-sink-file-based/package.json +++ b/examples/react/kitchen-sink-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/kitchen-sink-react-query-file-based/package.json b/examples/react/kitchen-sink-react-query-file-based/package.json index 442ac70096..584dca38fb 100644 --- a/examples/react/kitchen-sink-react-query-file-based/package.json +++ b/examples/react/kitchen-sink-react-query-file-based/package.json @@ -14,7 +14,7 @@ "@tanstack/react-query-devtools": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/large-file-based/package.json b/examples/react/large-file-based/package.json index 95343422aa..f9a0790b6f 100644 --- a/examples/react/large-file-based/package.json +++ b/examples/react/large-file-based/package.json @@ -15,7 +15,7 @@ "@tanstack/react-query": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-esbuild-file-based/package.json b/examples/react/quickstart-esbuild-file-based/package.json index 934c0547ca..a352be64ac 100644 --- a/examples/react/quickstart-esbuild-file-based/package.json +++ b/examples/react/quickstart-esbuild-file-based/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-file-based/package.json b/examples/react/quickstart-file-based/package.json index 3aa38e266c..8dab46a145 100644 --- a/examples/react/quickstart-file-based/package.json +++ b/examples/react/quickstart-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-rspack-file-based/package.json b/examples/react/quickstart-rspack-file-based/package.json index b8b5b9b969..d730fdf654 100644 --- a/examples/react/quickstart-rspack-file-based/package.json +++ b/examples/react/quickstart-rspack-file-based/package.json @@ -19,7 +19,7 @@ "devDependencies": { "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-react": "^2.0.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "typescript": "^6.0.2" diff --git a/examples/react/quickstart-webpack-file-based/package.json b/examples/react/quickstart-webpack-file-based/package.json index d76879f768..668fac3546 100644 --- a/examples/react/quickstart-webpack-file-based/package.json +++ b/examples/react/quickstart-webpack-file-based/package.json @@ -14,7 +14,7 @@ }, "devDependencies": { "@swc/core": "^1.10.15", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "html-webpack-plugin": "^5.6.3", diff --git a/examples/react/router-monorepo-react-query/package.json b/examples/react/router-monorepo-react-query/package.json index 9f83d4d02b..f6b016ae55 100644 --- a/examples/react/router-monorepo-react-query/package.json +++ b/examples/react/router-monorepo-react-query/package.json @@ -14,7 +14,7 @@ "@tanstack/react-query-devtools": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-react-query/packages/router/package.json b/examples/react/router-monorepo-react-query/packages/router/package.json index 46bbfa52ef..8c1735485e 100644 --- a/examples/react/router-monorepo-react-query/packages/router/package.json +++ b/examples/react/router-monorepo-react-query/packages/router/package.json @@ -11,7 +11,7 @@ "@tanstack/history": "^1.162.0", "@tanstack/react-query": "^5.90.0", "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@router-mono-react-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/react/router-monorepo-simple-lazy/package.json b/examples/react/router-monorepo-simple-lazy/package.json index ae3800ff18..b481e51d6c 100644 --- a/examples/react/router-monorepo-simple-lazy/package.json +++ b/examples/react/router-monorepo-simple-lazy/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple-lazy/packages/router/package.json b/examples/react/router-monorepo-simple-lazy/packages/router/package.json index 2af6668850..c47507062d 100644 --- a/examples/react/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/react/router-monorepo-simple-lazy/packages/router/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/router-monorepo-simple/package.json b/examples/react/router-monorepo-simple/package.json index 54f824889a..a5d85c03fe 100644 --- a/examples/react/router-monorepo-simple/package.json +++ b/examples/react/router-monorepo-simple/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple/packages/router/package.json b/examples/react/router-monorepo-simple/packages/router/package.json index f2c47f982e..3387d17e37 100644 --- a/examples/react/router-monorepo-simple/packages/router/package.json +++ b/examples/react/router-monorepo-simple/packages/router/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/search-validator-adapters/package.json b/examples/react/search-validator-adapters/package.json index a9b2130400..c5c660f33b 100644 --- a/examples/react/search-validator-adapters/package.json +++ b/examples/react/search-validator-adapters/package.json @@ -15,7 +15,7 @@ "@tanstack/react-query": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/react/start-bare/package.json b/examples/react/start-bare/package.json index 9f88e2274a..e0f59f2865 100644 --- a/examples/react/start-bare/package.json +++ b/examples/react/start-bare/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-basic-auth/package.json b/examples/react/start-basic-auth/package.json index b0218741cb..b27fa4d900 100644 --- a/examples/react/start-basic-auth/package.json +++ b/examples/react/start-basic-auth/package.json @@ -16,7 +16,7 @@ "@prisma/client": "^7.0.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-authjs/package.json b/examples/react/start-basic-authjs/package.json index f4701e3271..b8a7ef22d2 100644 --- a/examples/react/start-basic-authjs/package.json +++ b/examples/react/start-basic-authjs/package.json @@ -13,7 +13,7 @@ "@auth/core": "^0.41.1", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "start-authjs": "^1.0.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-basic-cloudflare/package.json b/examples/react/start-basic-cloudflare/package.json index 592ba54b9d..8de9133905 100644 --- a/examples/react/start-basic-cloudflare/package.json +++ b/examples/react/start-basic-cloudflare/package.json @@ -14,7 +14,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-basic-react-query/package.json b/examples/react/start-basic-react-query/package.json index 345ba8b8c0..68d6b31546 100644 --- a/examples/react/start-basic-react-query/package.json +++ b/examples/react/start-basic-react-query/package.json @@ -15,7 +15,7 @@ "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-static/package.json b/examples/react/start-basic-static/package.json index 1349bdb011..a391b93e82 100644 --- a/examples/react/start-basic-static/package.json +++ b/examples/react/start-basic-static/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "@tanstack/start-static-server-functions": "^1.167.3", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", diff --git a/examples/react/start-basic/package.json b/examples/react/start-basic/package.json index 69052b04c7..ac82e4a508 100644 --- a/examples/react/start-basic/package.json +++ b/examples/react/start-basic/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-bun/package.json b/examples/react/start-bun/package.json index a9ac508791..6d184e55c0 100644 --- a/examples/react/start-bun/package.json +++ b/examples/react/start-bun/package.json @@ -18,8 +18,8 @@ "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.4", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/react-start": "^1.168.5", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/start-clerk-basic/package.json b/examples/react/start-clerk-basic/package.json index a7d72f0dda..2a4bd18c3b 100644 --- a/examples/react/start-clerk-basic/package.json +++ b/examples/react/start-clerk-basic/package.json @@ -13,7 +13,7 @@ "@clerk/tanstack-react-start": "^0.27.14", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-convex-trellaux/package.json b/examples/react/start-convex-trellaux/package.json index 442680ea65..a8064094a8 100644 --- a/examples/react/start-convex-trellaux/package.json +++ b/examples/react/start-convex-trellaux/package.json @@ -18,7 +18,7 @@ "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "concurrently": "^8.2.2", "convex": "^1.19.0", "ky": "^1.7.4", diff --git a/examples/react/start-counter/package.json b/examples/react/start-counter/package.json index 4018f94faa..b29b763e3f 100644 --- a/examples/react/start-counter/package.json +++ b/examples/react/start-counter/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-i18n-paraglide/package.json b/examples/react/start-i18n-paraglide/package.json index 12179e6056..31252261b1 100644 --- a/examples/react/start-i18n-paraglide/package.json +++ b/examples/react/start-i18n-paraglide/package.json @@ -12,7 +12,7 @@ "@tanstack/react-devtools": "^0.7.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.1.1", "react-dom": "^19.1.1" }, diff --git a/examples/react/start-large/package.json b/examples/react/start-large/package.json index 62400fbf89..e2f77e9b2f 100644 --- a/examples/react/start-large/package.json +++ b/examples/react/start-large/package.json @@ -15,7 +15,7 @@ "@tanstack/react-query": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-material-ui/package.json b/examples/react/start-material-ui/package.json index 3dadbbf45f..bce2359db0 100644 --- a/examples/react/start-material-ui/package.json +++ b/examples/react/start-material-ui/package.json @@ -16,7 +16,7 @@ "@fontsource-variable/roboto": "5.2.5", "@mui/material": "6.4.7", "@tanstack/react-router": "^1.170.3", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-rscs/package.json b/examples/react/start-rscs/package.json index 322d71f3b4..41cc077579 100644 --- a/examples/react/start-rscs/package.json +++ b/examples/react/start-rscs/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "dexie": "^4.0.10", "react": "^19.2.0", "react-dom": "^19.2.0", diff --git a/examples/react/start-streaming-data-from-server-functions/package.json b/examples/react/start-streaming-data-from-server-functions/package.json index dbc79a5892..eeea630b39 100644 --- a/examples/react/start-streaming-data-from-server-functions/package.json +++ b/examples/react/start-streaming-data-from-server-functions/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-supabase-basic/package.json b/examples/react/start-supabase-basic/package.json index 416753bc38..6d73f2d508 100644 --- a/examples/react/start-supabase-basic/package.json +++ b/examples/react/start-supabase-basic/package.json @@ -17,7 +17,7 @@ "@supabase/supabase-js": "^2.48.1", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/start-tailwind-v4/package.json b/examples/react/start-tailwind-v4/package.json index 4de46a76b9..042ad0baa5 100644 --- a/examples/react/start-tailwind-v4/package.json +++ b/examples/react/start-tailwind-v4/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-trellaux/package.json b/examples/react/start-trellaux/package.json index a9168e8c67..48dd56d9f4 100644 --- a/examples/react/start-trellaux/package.json +++ b/examples/react/start-trellaux/package.json @@ -15,7 +15,7 @@ "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "ky": "^1.7.4", "msw": "^2.7.0", "react": "^19.0.0", diff --git a/examples/react/start-workos/package.json b/examples/react/start-workos/package.json index 0de1f05205..8c8e353373 100644 --- a/examples/react/start-workos/package.json +++ b/examples/react/start-workos/package.json @@ -16,7 +16,7 @@ "@radix-ui/themes": "^3.3.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.4", + "@tanstack/react-start": "^1.168.5", "@workos/authkit-tanstack-react-start": "^0.5.0", "react": "^19.0.0", "react-dom": "^19.0.0" diff --git a/examples/react/view-transitions/package.json b/examples/react/view-transitions/package.json index 59bfaa85b5..69eaeb9a59 100644 --- a/examples/react/view-transitions/package.json +++ b/examples/react/view-transitions/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/with-trpc-react-query/package.json b/examples/react/with-trpc-react-query/package.json index 941a6394eb..876eaf3b14 100644 --- a/examples/react/with-trpc-react-query/package.json +++ b/examples/react/with-trpc-react-query/package.json @@ -15,7 +15,7 @@ "@tanstack/react-query-devtools": "^5.90.0", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "@trpc/tanstack-react-query": "^11.4.3", diff --git a/examples/react/with-trpc/package.json b/examples/react/with-trpc/package.json index 97a1a3a5fc..9ca548c6c6 100644 --- a/examples/react/with-trpc/package.json +++ b/examples/react/with-trpc/package.json @@ -13,7 +13,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-router": "^1.170.3", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/solid/authenticated-routes-firebase/package.json b/examples/solid/authenticated-routes-firebase/package.json index aae835f673..a7bf5fb5a1 100644 --- a/examples/solid/authenticated-routes-firebase/package.json +++ b/examples/solid/authenticated-routes-firebase/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "firebase": "^11.4.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/authenticated-routes/package.json b/examples/solid/authenticated-routes/package.json index e0d81c0992..c538b531d1 100644 --- a/examples/solid/authenticated-routes/package.json +++ b/examples/solid/authenticated-routes/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/basic-file-based/package.json b/examples/solid/basic-file-based/package.json index 4aaa636626..cc8f39b62f 100644 --- a/examples/solid/basic-file-based/package.json +++ b/examples/solid/basic-file-based/package.json @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-solid-query-file-based/package.json b/examples/solid/basic-solid-query-file-based/package.json index 57519b5b7a..a0f02c784f 100644 --- a/examples/solid/basic-solid-query-file-based/package.json +++ b/examples/solid/basic-solid-query-file-based/package.json @@ -21,7 +21,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-solid-query/package.json b/examples/solid/basic-solid-query/package.json index 4640d953be..9ddadee512 100644 --- a/examples/solid/basic-solid-query/package.json +++ b/examples/solid/basic-solid-query/package.json @@ -19,7 +19,7 @@ "tailwindcss": "^4.2.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-ssr-file-based/package.json b/examples/solid/basic-ssr-file-based/package.json index 593f7b74ef..c4b2fad635 100644 --- a/examples/solid/basic-ssr-file-based/package.json +++ b/examples/solid/basic-ssr-file-based/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/solid/basic-ssr-streaming-file-based/package.json b/examples/solid/basic-ssr-streaming-file-based/package.json index 6194520a40..fdf0637eaa 100644 --- a/examples/solid/basic-ssr-streaming-file-based/package.json +++ b/examples/solid/basic-ssr-streaming-file-based/package.json @@ -24,7 +24,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@types/express": "^4.17.23", "typescript": "^6.0.2", "vite": "^8.0.0", diff --git a/examples/solid/basic-virtual-file-based/package.json b/examples/solid/basic-virtual-file-based/package.json index 475fdc4b48..566e2eb7e8 100644 --- a/examples/solid/basic-virtual-file-based/package.json +++ b/examples/solid/basic-virtual-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic-virtual-inside-file-based/package.json b/examples/solid/basic-virtual-inside-file-based/package.json index c0bc2c3b28..ae88ed2b0b 100644 --- a/examples/solid/basic-virtual-inside-file-based/package.json +++ b/examples/solid/basic-virtual-inside-file-based/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/i18n-paraglide/package.json b/examples/solid/i18n-paraglide/package.json index 649a38426f..e401fd675f 100644 --- a/examples/solid/i18n-paraglide/package.json +++ b/examples/solid/i18n-paraglide/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/kitchen-sink-file-based/package.json b/examples/solid/kitchen-sink-file-based/package.json index 5440e05833..13ea51d1a5 100644 --- a/examples/solid/kitchen-sink-file-based/package.json +++ b/examples/solid/kitchen-sink-file-based/package.json @@ -19,7 +19,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/kitchen-sink-solid-query-file-based/package.json b/examples/solid/kitchen-sink-solid-query-file-based/package.json index 1521a021cc..2a3001533a 100644 --- a/examples/solid/kitchen-sink-solid-query-file-based/package.json +++ b/examples/solid/kitchen-sink-solid-query-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", "@tanstack/solid-router": "^1.170.3", diff --git a/examples/solid/large-file-based/package.json b/examples/solid/large-file-based/package.json index 607626d016..8d4329cdff 100644 --- a/examples/solid/large-file-based/package.json +++ b/examples/solid/large-file-based/package.json @@ -15,7 +15,7 @@ "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/quickstart-esbuild-file-based/package.json b/examples/solid/quickstart-esbuild-file-based/package.json index 2a808b92cd..3b6c334053 100644 --- a/examples/solid/quickstart-esbuild-file-based/package.json +++ b/examples/solid/quickstart-esbuild-file-based/package.json @@ -9,7 +9,7 @@ "start": "dev" }, "dependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", diff --git a/examples/solid/quickstart-file-based/package.json b/examples/solid/quickstart-file-based/package.json index 63d725a699..4e819327e2 100644 --- a/examples/solid/quickstart-file-based/package.json +++ b/examples/solid/quickstart-file-based/package.json @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/quickstart-rspack-file-based/package.json b/examples/solid/quickstart-rspack-file-based/package.json index 0446de0264..77bb0a0874 100644 --- a/examples/solid/quickstart-rspack-file-based/package.json +++ b/examples/solid/quickstart-rspack-file-based/package.json @@ -19,7 +19,7 @@ "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-babel": "^1.1.2", "@rsbuild/plugin-solid": "^1.1.1", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "typescript": "^6.0.2" } } diff --git a/examples/solid/quickstart-webpack-file-based/package.json b/examples/solid/quickstart-webpack-file-based/package.json index 1856d14e85..61d2570f54 100644 --- a/examples/solid/quickstart-webpack-file-based/package.json +++ b/examples/solid/quickstart-webpack-file-based/package.json @@ -15,7 +15,7 @@ "devDependencies": { "@babel/core": "^7.28.5", "@babel/preset-typescript": "^7.27.1", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "babel-loader": "^10.0.0", "babel-preset-solid": "^1.9.10", "css-loader": "^7.1.2", diff --git a/examples/solid/router-monorepo-simple-lazy/package.json b/examples/solid/router-monorepo-simple-lazy/package.json index cb6d4b57c7..c95c7ccaaa 100644 --- a/examples/solid/router-monorepo-simple-lazy/package.json +++ b/examples/solid/router-monorepo-simple-lazy/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json index 0925bbb46a..8713a7ec6f 100644 --- a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-simple/package.json b/examples/solid/router-monorepo-simple/package.json index a773ea7e59..d6907db597 100644 --- a/examples/solid/router-monorepo-simple/package.json +++ b/examples/solid/router-monorepo-simple/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple/packages/router/package.json b/examples/solid/router-monorepo-simple/packages/router/package.json index 8dbfbefb13..1b77617ada 100644 --- a/examples/solid/router-monorepo-simple/packages/router/package.json +++ b/examples/solid/router-monorepo-simple/packages/router/package.json @@ -10,7 +10,7 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-solid-query/package.json b/examples/solid/router-monorepo-solid-query/package.json index e52659bf32..c35705f4ed 100644 --- a/examples/solid/router-monorepo-solid-query/package.json +++ b/examples/solid/router-monorepo-solid-query/package.json @@ -14,7 +14,7 @@ "@tanstack/solid-query-devtools": "^5.90.0", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-solid-query/packages/router/package.json b/examples/solid/router-monorepo-solid-query/packages/router/package.json index 1aeec389a8..f470f7e529 100644 --- a/examples/solid/router-monorepo-solid-query/packages/router/package.json +++ b/examples/solid/router-monorepo-solid-query/packages/router/package.json @@ -11,7 +11,7 @@ "@tanstack/history": "^1.162.0", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@router-solid-mono-solid-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/solid/search-validator-adapters/package.json b/examples/solid/search-validator-adapters/package.json index 24ae7b52ee..4db0d37a8d 100644 --- a/examples/solid/search-validator-adapters/package.json +++ b/examples/solid/search-validator-adapters/package.json @@ -15,7 +15,7 @@ "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/solid/start-basic-auth/package.json b/examples/solid/start-basic-auth/package.json index 7965405fbc..f52a2067f5 100644 --- a/examples/solid/start-basic-auth/package.json +++ b/examples/solid/start-basic-auth/package.json @@ -16,7 +16,7 @@ "@prisma/client": "^7.0.0", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-authjs/package.json b/examples/solid/start-basic-authjs/package.json index 20e09c9275..4362bc0d2c 100644 --- a/examples/solid/start-basic-authjs/package.json +++ b/examples/solid/start-basic-authjs/package.json @@ -13,7 +13,7 @@ "@auth/core": "^0.41.1", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "start-authjs": "^1.0.0", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-cloudflare/package.json b/examples/solid/start-basic-cloudflare/package.json index 1cfbea7dc4..6b8c934eb6 100644 --- a/examples/solid/start-basic-cloudflare/package.json +++ b/examples/solid/start-basic-cloudflare/package.json @@ -14,7 +14,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-netlify/package.json b/examples/solid/start-basic-netlify/package.json index 469c552190..3110e44dbe 100644 --- a/examples/solid/start-basic-netlify/package.json +++ b/examples/solid/start-basic-netlify/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-nitro/package.json b/examples/solid/start-basic-nitro/package.json index a1792e8a1e..13bc7f153f 100644 --- a/examples/solid/start-basic-nitro/package.json +++ b/examples/solid/start-basic-nitro/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-solid-query/package.json b/examples/solid/start-basic-solid-query/package.json index 0c63ea4a25..b6b755358e 100644 --- a/examples/solid/start-basic-solid-query/package.json +++ b/examples/solid/start-basic-solid-query/package.json @@ -15,7 +15,7 @@ "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-static/package.json b/examples/solid/start-basic-static/package.json index fe5ad697e2..bd01b6fc0a 100644 --- a/examples/solid/start-basic-static/package.json +++ b/examples/solid/start-basic-static/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "@tanstack/start-static-server-functions": "^1.167.3", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/start-basic/package.json b/examples/solid/start-basic/package.json index bc29157e3d..44ed0d9e93 100644 --- a/examples/solid/start-basic/package.json +++ b/examples/solid/start-basic/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-bun/package.json b/examples/solid/start-bun/package.json index 5ae1f11259..ce4c3b6fb0 100644 --- a/examples/solid/start-bun/package.json +++ b/examples/solid/start-bun/package.json @@ -18,8 +18,8 @@ "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/start-convex-better-auth/package.json b/examples/solid/start-convex-better-auth/package.json index b75ac5e8a7..b5fee853cf 100644 --- a/examples/solid/start-convex-better-auth/package.json +++ b/examples/solid/start-convex-better-auth/package.json @@ -15,7 +15,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "better-auth": "^1.3.27", "clsx": "^2.1.1", "convex": "^1.28.2", diff --git a/examples/solid/start-counter/package.json b/examples/solid/start-counter/package.json index a4c98b6b1c..3f417e7595 100644 --- a/examples/solid/start-counter/package.json +++ b/examples/solid/start-counter/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-i18n-paraglide/package.json b/examples/solid/start-i18n-paraglide/package.json index 2370bbce10..c43e1d4af8 100644 --- a/examples/solid/start-i18n-paraglide/package.json +++ b/examples/solid/start-i18n-paraglide/package.json @@ -12,7 +12,7 @@ "@tanstack/solid-devtools": "^0.7.0", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-large/package.json b/examples/solid/start-large/package.json index bf0725ae2b..ac0a5e6891 100644 --- a/examples/solid/start-large/package.json +++ b/examples/solid/start-large/package.json @@ -15,7 +15,7 @@ "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-streaming-data-from-server-functions/package.json b/examples/solid/start-streaming-data-from-server-functions/package.json index d814fa504a..01981838fe 100644 --- a/examples/solid/start-streaming-data-from-server-functions/package.json +++ b/examples/solid/start-streaming-data-from-server-functions/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10", "zod": "^3.24.2" }, diff --git a/examples/solid/start-supabase-basic/package.json b/examples/solid/start-supabase-basic/package.json index c310fcecfc..cfb02d0517 100644 --- a/examples/solid/start-supabase-basic/package.json +++ b/examples/solid/start-supabase-basic/package.json @@ -16,7 +16,7 @@ "@supabase/supabase-js": "^2.48.1", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.9", "redaxios": "^0.5.1" }, diff --git a/examples/solid/start-tailwind-v4/package.json b/examples/solid/start-tailwind-v4/package.json index c84c862781..aeb4361bc6 100644 --- a/examples/solid/start-tailwind-v4/package.json +++ b/examples/solid/start-tailwind-v4/package.json @@ -12,7 +12,7 @@ "dependencies": { "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.4", + "@tanstack/solid-start": "^1.168.5", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0", "zod": "^3.24.2" diff --git a/examples/solid/view-transitions/package.json b/examples/solid/view-transitions/package.json index 6106d46dc2..d7caa7237e 100644 --- a/examples/solid/view-transitions/package.json +++ b/examples/solid/view-transitions/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/with-trpc/package.json b/examples/solid/with-trpc/package.json index 192a7d637f..5ea82b9a8d 100644 --- a/examples/solid/with-trpc/package.json +++ b/examples/solid/with-trpc/package.json @@ -13,7 +13,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-router": "^1.170.3", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/vue/basic-file-based-jsx/package.json b/examples/vue/basic-file-based-jsx/package.json index e7555c4e56..7459664e44 100644 --- a/examples/vue/basic-file-based-jsx/package.json +++ b/examples/vue/basic-file-based-jsx/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/vue-router": "^1.170.3", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", diff --git a/examples/vue/basic-file-based-sfc/package.json b/examples/vue/basic-file-based-sfc/package.json index 3a7553a785..5508bb500c 100644 --- a/examples/vue/basic-file-based-sfc/package.json +++ b/examples/vue/basic-file-based-sfc/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.4", + "@tanstack/router-plugin": "^1.168.5", "@tanstack/vue-router": "^1.170.3", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", diff --git a/packages/react-start-rsc/CHANGELOG.md b/packages/react-start-rsc/CHANGELOG.md index 06ea030b20..a458f2722d 100644 --- a/packages/react-start-rsc/CHANGELOG.md +++ b/packages/react-start-rsc/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/react-start-rsc +## 0.1.5 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-plugin-core@1.170.5 + ## 0.1.4 ### Patch Changes diff --git a/packages/react-start-rsc/package.json b/packages/react-start-rsc/package.json index e8d2ea2330..fa8509f910 100644 --- a/packages/react-start-rsc/package.json +++ b/packages/react-start-rsc/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-rsc", - "version": "0.1.4", + "version": "0.1.5", "description": "React Server Components support for TanStack Start", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start/CHANGELOG.md b/packages/react-start/CHANGELOG.md index 99a507f8b9..4e5add189b 100644 --- a/packages/react-start/CHANGELOG.md +++ b/packages/react-start/CHANGELOG.md @@ -1,5 +1,13 @@ # @tanstack/react-start +## 1.168.5 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-plugin-core@1.170.5 + - @tanstack/react-start-rsc@0.1.5 + ## 1.168.4 ### Patch Changes diff --git a/packages/react-start/package.json b/packages/react-start/package.json index 9c71cf7d07..b4b9e24225 100644 --- a/packages/react-start/package.json +++ b/packages/react-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start", - "version": "1.168.4", + "version": "1.168.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-plugin/CHANGELOG.md b/packages/router-plugin/CHANGELOG.md index b99c325d57..a7332cce22 100644 --- a/packages/router-plugin/CHANGELOG.md +++ b/packages/router-plugin/CHANGELOG.md @@ -1,5 +1,11 @@ # @tanstack/router-plugin +## 1.168.5 + +### Patch Changes + +- Fix Vite Fast Refresh detection for root routes created with `createRootRouteWithContext` type arguments. ([#7420](https://github.com/TanStack/router/pull/7420)) + ## 1.168.4 ### Patch Changes diff --git a/packages/router-plugin/package.json b/packages/router-plugin/package.json index 97dbd3c548..12eaa573dd 100644 --- a/packages/router-plugin/package.json +++ b/packages/router-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-plugin", - "version": "1.168.4", + "version": "1.168.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-vite-plugin/CHANGELOG.md b/packages/router-vite-plugin/CHANGELOG.md index b1d2d75286..0fa46effbc 100644 --- a/packages/router-vite-plugin/CHANGELOG.md +++ b/packages/router-vite-plugin/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-vite-plugin +## 1.167.5 + +### Patch Changes + +- Updated dependencies [[`8146db7`](https://github.com/TanStack/router/commit/8146db7e54f5d508f1fb7d3927edd0a2f71dc930)]: + - @tanstack/router-plugin@1.168.5 + ## 1.167.4 ### Patch Changes diff --git a/packages/router-vite-plugin/package.json b/packages/router-vite-plugin/package.json index 0de6daef7f..532290a7ad 100644 --- a/packages/router-vite-plugin/package.json +++ b/packages/router-vite-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-vite-plugin", - "version": "1.167.4", + "version": "1.167.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start/CHANGELOG.md b/packages/solid-start/CHANGELOG.md index 40e3a7a937..968aaf8d91 100644 --- a/packages/solid-start/CHANGELOG.md +++ b/packages/solid-start/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/solid-start +## 1.168.5 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-plugin-core@1.170.5 + ## 1.168.4 ### Patch Changes diff --git a/packages/solid-start/package.json b/packages/solid-start/package.json index 0f8b502393..e903f5256f 100644 --- a/packages/solid-start/package.json +++ b/packages/solid-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start", - "version": "1.168.4", + "version": "1.168.5", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-plugin-core/CHANGELOG.md b/packages/start-plugin-core/CHANGELOG.md index c5809c6cc6..86dfaf3043 100644 --- a/packages/start-plugin-core/CHANGELOG.md +++ b/packages/start-plugin-core/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/start-plugin-core +## 1.170.5 + +### Patch Changes + +- Updated dependencies [[`8146db7`](https://github.com/TanStack/router/commit/8146db7e54f5d508f1fb7d3927edd0a2f71dc930)]: + - @tanstack/router-plugin@1.168.5 + ## 1.170.4 ### Patch Changes diff --git a/packages/start-plugin-core/package.json b/packages/start-plugin-core/package.json index 6335ec9103..8fe6467cfe 100644 --- a/packages/start-plugin-core/package.json +++ b/packages/start-plugin-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-plugin-core", - "version": "1.170.4", + "version": "1.170.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start/CHANGELOG.md b/packages/vue-start/CHANGELOG.md index d8c3adb836..c3d7197cea 100644 --- a/packages/vue-start/CHANGELOG.md +++ b/packages/vue-start/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/vue-start +## 1.168.5 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-plugin-core@1.170.5 + ## 1.168.4 ### Patch Changes diff --git a/packages/vue-start/package.json b/packages/vue-start/package.json index e64e57d8ae..aa63e7adf7 100644 --- a/packages/vue-start/package.json +++ b/packages/vue-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start", - "version": "1.168.4", + "version": "1.168.5", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", From b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67 Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sun, 17 May 2026 13:35:04 +0200 Subject: [PATCH 005/471] fix: fix route mismatch warnings and HMR route indexes (#7422) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> --- .changeset/brave-routes-refresh.md | 7 + packages/router-core/src/router.ts | 2 +- .../router-core/tests/build-location.test.ts | 38 +++- packages/router-generator/src/utils.ts | 53 ++++- .../nested-layouts/routeTree.snapshot.ts | 2 +- .../routeTree.snapshot.ts | 147 +++++++++++++ .../routes/__root.tsx | 5 + .../livestock/$farmId/medicine/_form.new.tsx | 5 + .../livestock/$farmId/medicine/_form.tsx | 5 + .../livestock/$farmId/medicine/index.tsx | 5 + .../livestock/$farmId/medicine/route.tsx | 5 + packages/router-generator/tests/utils.test.ts | 65 ++++++ .../src/core/hmr/handle-route-update.ts | 65 +++--- .../snapshots/react/arrow-function@true.tsx | 33 ++- .../react/arrow-function@webpack-hot.tsx | 33 ++- .../createRootRoute-inline-component@true.tsx | 33 ++- .../snapshots/react/createRootRoute@true.tsx | 33 ++- ...ateRootRouteWithContext-type-args@true.tsx | 33 ++- .../explicit-undefined-component@true.tsx | 33 ++- .../react/function-declaration@true.tsx | 33 ++- .../snapshots/react/multi-component@true.tsx | 33 ++- .../react/string-literal-keys@true.tsx | 33 ++- .../snapshots/solid/arrow-function@true.tsx | 33 ++- .../tests/handle-route-update.test.ts | 193 ++++++++++++++++++ 24 files changed, 704 insertions(+), 223 deletions(-) create mode 100644 .changeset/brave-routes-refresh.md create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routeTree.snapshot.ts create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routes/__root.tsx create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.new.tsx create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.tsx create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/index.tsx create mode 100644 packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/route.tsx create mode 100644 packages/router-plugin/tests/handle-route-update.test.ts diff --git a/.changeset/brave-routes-refresh.md b/.changeset/brave-routes-refresh.md new file mode 100644 index 0000000000..211ae2ce28 --- /dev/null +++ b/.changeset/brave-routes-refresh.md @@ -0,0 +1,7 @@ +--- +'@tanstack/router-core': patch +'@tanstack/router-generator': patch +'@tanstack/router-plugin': patch +--- + +Fix route mismatch warnings, HMR route index refresh, and generated route type preferences for duplicate pathless/index routes. diff --git a/packages/router-core/src/router.ts b/packages/router-core/src/router.ts index f89a18b7f7..3fbcd91387 100644 --- a/packages/router-core/src/router.ts +++ b/packages/router-core/src/router.ts @@ -1935,7 +1935,7 @@ export class RouterCore< const roundTrip = this.getMatchedRoutes(nextPathname) if (roundTrip.foundRoute?.id !== destRoute.id) { console.warn( - `Generated path "${nextPathname}" for route "${destRoute.id}" did not match the same route after params.stringify.`, + `Generated path "${nextPathname}" for route "${destRoute.id}" matched route "${roundTrip.foundRoute?.id}" instead. This can happen when multiple route templates resolve to the same URL. Use the route template that matches the intended route, or adjust params.stringify if it changed the target path.`, ) } } catch { diff --git a/packages/router-core/tests/build-location.test.ts b/packages/router-core/tests/build-location.test.ts index c8c12ce42e..8a83e34faf 100644 --- a/packages/router-core/tests/build-location.test.ts +++ b/packages/router-core/tests/build-location.test.ts @@ -1265,7 +1265,43 @@ describe('buildLocation - params edge cases', () => { expect(location.pathname).toBe('/no') expect(warn).toHaveBeenCalledWith( - 'Generated path "/no" for route "/$foo" did not match the same route after params.stringify.', + 'Generated path "/no" for route "/$foo" matched route "/no" instead. This can happen when multiple route templates resolve to the same URL. Use the route template that matches the intended route, or adjust params.stringify if it changed the target path.', + ) + } finally { + warn.mockRestore() + } + }) + + test('buildLocation should warn in development when a generated path matches an optional route template', async () => { + const rootRoute = new BaseRootRoute({}) + const timeRoute = new BaseRoute({ + getParentRoute: () => rootRoute, + path: '/time', + }) + const dayRoute = new BaseRoute({ + getParentRoute: () => timeRoute, + path: '{-$day}', + }) + + const routeTree = rootRoute.addChildren([timeRoute.addChildren([dayRoute])]) + + const router = createTestRouter({ + routeTree, + history: createMemoryHistory({ initialEntries: ['/'] }), + }) + + await router.load() + + const warn = vi.spyOn(console, 'warn').mockImplementation(() => {}) + + try { + const location = router.buildLocation({ + to: '/time', + }) + + expect(location.pathname).toBe('/time') + expect(warn).toHaveBeenCalledWith( + 'Generated path "/time" for route "/time" matched route "/time/{-$day}" instead. This can happen when multiple route templates resolve to the same URL. Use the route template that matches the intended route, or adjust params.stringify if it changed the target path.', ) } finally { warn.mockRestore() diff --git a/packages/router-generator/src/utils.ts b/packages/router-generator/src/utils.ts index 060cc80164..2354c5ed1c 100644 --- a/packages/router-generator/src/utils.ts +++ b/packages/router-generator/src/utils.ts @@ -918,6 +918,46 @@ const shouldPreferIndexRoute = ( return existing.cleanedPath === '/' && current.cleanedPath !== '/' } +const isIndexRouteNode = (routeNode: RouteNode): boolean => { + return routeNode.routePath?.endsWith('/') ?? false +} + +const isPathlessRouteNode = (routeNode: RouteNode): boolean => { + return routeNode._fsRouteType === 'pathless_layout' +} + +const shouldReplaceRouteNodeForTo = ( + current: RouteNode, + existing: RouteNode, +): boolean => { + const currentIsIndex = isIndexRouteNode(current) + const existingIsIndex = isIndexRouteNode(existing) + if (currentIsIndex !== existingIsIndex) { + return currentIsIndex + } + + const currentIsPathless = isPathlessRouteNode(current) + const existingIsPathless = isPathlessRouteNode(existing) + if (currentIsPathless !== existingIsPathless) { + return !currentIsPathless + } + + return true +} + +const shouldReplaceRouteNodeForFullPath = ( + current: RouteNode, + existing: RouteNode, +): boolean => { + const currentIsPathless = isPathlessRouteNode(current) + const existingIsPathless = isPathlessRouteNode(existing) + if (currentIsPathless !== existingIsPathless) { + return !currentIsPathless + } + + return true +} + /** * Creates a map from fullPath to routeNode */ @@ -936,6 +976,11 @@ export const createRouteNodesByFullPath = ( } } + const existing = map.get(fullPath) + if (existing && !shouldReplaceRouteNodeForFullPath(routeNode, existing)) { + continue + } + map.set(fullPath, routeNode) } @@ -953,11 +998,9 @@ export const createRouteNodesByTo = ( for (const routeNode of dedupeBranchesAndIndexRoutes(routeNodes)) { const to = inferTo(routeNode) - if (to === '/' && map.has('/')) { - const existing = map.get('/')! - if (shouldPreferIndexRoute(routeNode, existing)) { - continue - } + const existing = map.get(to) + if (existing && !shouldReplaceRouteNodeForTo(routeNode, existing)) { + continue } map.set(to, routeNode) diff --git a/packages/router-generator/tests/generator/nested-layouts/routeTree.snapshot.ts b/packages/router-generator/tests/generator/nested-layouts/routeTree.snapshot.ts index c38345a64b..d99745d928 100644 --- a/packages/router-generator/tests/generator/nested-layouts/routeTree.snapshot.ts +++ b/packages/router-generator/tests/generator/nested-layouts/routeTree.snapshot.ts @@ -147,7 +147,7 @@ const JestedLayoutB3LayoutC2BarRoute = export interface FileRoutesByFullPath { '/': typeof IndexRoute - '/jested': typeof JestedLayoutB3LayoutC2RouteWithChildren + '/jested': typeof JestedRouteRouteWithChildren '/foo': typeof LayoutA1FooRoute '/in-folder': typeof folderInFolderRoute '/bar': typeof LayoutA2BarRoute diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routeTree.snapshot.ts b/packages/router-generator/tests/generator/pathless-to-index-preference/routeTree.snapshot.ts new file mode 100644 index 0000000000..e9c9d6fac6 --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routeTree.snapshot.ts @@ -0,0 +1,147 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as LivestockFarmIdMedicineRouteRouteImport } from './routes/livestock/$farmId/medicine/route' +import { Route as LivestockFarmIdMedicineIndexRouteImport } from './routes/livestock/$farmId/medicine/index' +import { Route as LivestockFarmIdMedicineFormRouteImport } from './routes/livestock/$farmId/medicine/_form' +import { Route as LivestockFarmIdMedicineFormNewRouteImport } from './routes/livestock/$farmId/medicine/_form.new' + +const LivestockFarmIdMedicineRouteRoute = + LivestockFarmIdMedicineRouteRouteImport.update({ + id: '/livestock/$farmId/medicine', + path: '/livestock/$farmId/medicine', + getParentRoute: () => rootRouteImport, + } as any) +const LivestockFarmIdMedicineIndexRoute = + LivestockFarmIdMedicineIndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => LivestockFarmIdMedicineRouteRoute, + } as any) +const LivestockFarmIdMedicineFormRoute = + LivestockFarmIdMedicineFormRouteImport.update({ + id: '/_form', + getParentRoute: () => LivestockFarmIdMedicineRouteRoute, + } as any) +const LivestockFarmIdMedicineFormNewRoute = + LivestockFarmIdMedicineFormNewRouteImport.update({ + id: '/new', + path: '/new', + getParentRoute: () => LivestockFarmIdMedicineFormRoute, + } as any) + +export interface FileRoutesByFullPath { + '/livestock/$farmId/medicine': typeof LivestockFarmIdMedicineRouteRouteWithChildren + '/livestock/$farmId/medicine/': typeof LivestockFarmIdMedicineIndexRoute + '/livestock/$farmId/medicine/new': typeof LivestockFarmIdMedicineFormNewRoute +} +export interface FileRoutesByTo { + '/livestock/$farmId/medicine': typeof LivestockFarmIdMedicineIndexRoute + '/livestock/$farmId/medicine/new': typeof LivestockFarmIdMedicineFormNewRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/livestock/$farmId/medicine': typeof LivestockFarmIdMedicineRouteRouteWithChildren + '/livestock/$farmId/medicine/_form': typeof LivestockFarmIdMedicineFormRouteWithChildren + '/livestock/$farmId/medicine/': typeof LivestockFarmIdMedicineIndexRoute + '/livestock/$farmId/medicine/_form/new': typeof LivestockFarmIdMedicineFormNewRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: + | '/livestock/$farmId/medicine' + | '/livestock/$farmId/medicine/' + | '/livestock/$farmId/medicine/new' + fileRoutesByTo: FileRoutesByTo + to: '/livestock/$farmId/medicine' | '/livestock/$farmId/medicine/new' + id: + | '__root__' + | '/livestock/$farmId/medicine' + | '/livestock/$farmId/medicine/_form' + | '/livestock/$farmId/medicine/' + | '/livestock/$farmId/medicine/_form/new' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + LivestockFarmIdMedicineRouteRoute: typeof LivestockFarmIdMedicineRouteRouteWithChildren +} + +declare module '@tanstack/react-router' { + interface FileRoutesByPath { + '/livestock/$farmId/medicine': { + id: '/livestock/$farmId/medicine' + path: '/livestock/$farmId/medicine' + fullPath: '/livestock/$farmId/medicine' + preLoaderRoute: typeof LivestockFarmIdMedicineRouteRouteImport + parentRoute: typeof rootRouteImport + } + '/livestock/$farmId/medicine/': { + id: '/livestock/$farmId/medicine/' + path: '/' + fullPath: '/livestock/$farmId/medicine/' + preLoaderRoute: typeof LivestockFarmIdMedicineIndexRouteImport + parentRoute: typeof LivestockFarmIdMedicineRouteRoute + } + '/livestock/$farmId/medicine/_form': { + id: '/livestock/$farmId/medicine/_form' + path: '' + fullPath: '/livestock/$farmId/medicine' + preLoaderRoute: typeof LivestockFarmIdMedicineFormRouteImport + parentRoute: typeof LivestockFarmIdMedicineRouteRoute + } + '/livestock/$farmId/medicine/_form/new': { + id: '/livestock/$farmId/medicine/_form/new' + path: '/new' + fullPath: '/livestock/$farmId/medicine/new' + preLoaderRoute: typeof LivestockFarmIdMedicineFormNewRouteImport + parentRoute: typeof LivestockFarmIdMedicineFormRoute + } + } +} + +interface LivestockFarmIdMedicineFormRouteChildren { + LivestockFarmIdMedicineFormNewRoute: typeof LivestockFarmIdMedicineFormNewRoute +} + +const LivestockFarmIdMedicineFormRouteChildren: LivestockFarmIdMedicineFormRouteChildren = + { + LivestockFarmIdMedicineFormNewRoute: LivestockFarmIdMedicineFormNewRoute, + } + +const LivestockFarmIdMedicineFormRouteWithChildren = + LivestockFarmIdMedicineFormRoute._addFileChildren( + LivestockFarmIdMedicineFormRouteChildren, + ) + +interface LivestockFarmIdMedicineRouteRouteChildren { + LivestockFarmIdMedicineFormRoute: typeof LivestockFarmIdMedicineFormRouteWithChildren + LivestockFarmIdMedicineIndexRoute: typeof LivestockFarmIdMedicineIndexRoute +} + +const LivestockFarmIdMedicineRouteRouteChildren: LivestockFarmIdMedicineRouteRouteChildren = + { + LivestockFarmIdMedicineFormRoute: + LivestockFarmIdMedicineFormRouteWithChildren, + LivestockFarmIdMedicineIndexRoute: LivestockFarmIdMedicineIndexRoute, + } + +const LivestockFarmIdMedicineRouteRouteWithChildren = + LivestockFarmIdMedicineRouteRoute._addFileChildren( + LivestockFarmIdMedicineRouteRouteChildren, + ) + +const rootRouteChildren: RootRouteChildren = { + LivestockFarmIdMedicineRouteRoute: + LivestockFarmIdMedicineRouteRouteWithChildren, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routes/__root.tsx b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/__root.tsx new file mode 100644 index 0000000000..742d24a4ea --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/__root.tsx @@ -0,0 +1,5 @@ +import { Outlet, createRootRoute } from '@tanstack/react-router' + +export const Route = createRootRoute({ + component: () => , +}) diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.new.tsx b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.new.tsx new file mode 100644 index 0000000000..0a7a240962 --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.new.tsx @@ -0,0 +1,5 @@ +import { createFileRoute } from '@tanstack/react-router' + +export const Route = createFileRoute('/livestock/$farmId/medicine/_form/new')({ + component: () =>
New medicine
, +}) diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.tsx b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.tsx new file mode 100644 index 0000000000..2fe794b8b3 --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/_form.tsx @@ -0,0 +1,5 @@ +import { Outlet, createFileRoute } from '@tanstack/react-router' + +export const Route = createFileRoute('/livestock/$farmId/medicine/_form')({ + component: () => , +}) diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/index.tsx b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/index.tsx new file mode 100644 index 0000000000..13b4c3fb13 --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/index.tsx @@ -0,0 +1,5 @@ +import { createFileRoute } from '@tanstack/react-router' + +export const Route = createFileRoute('/livestock/$farmId/medicine/')({ + component: () =>
Medicine index
, +}) diff --git a/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/route.tsx b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/route.tsx new file mode 100644 index 0000000000..e1ef4d5afc --- /dev/null +++ b/packages/router-generator/tests/generator/pathless-to-index-preference/routes/livestock/$farmId/medicine/route.tsx @@ -0,0 +1,5 @@ +import { Outlet, createFileRoute } from '@tanstack/react-router' + +export const Route = createFileRoute('/livestock/$farmId/medicine')({ + component: () => , +}) diff --git a/packages/router-generator/tests/utils.test.ts b/packages/router-generator/tests/utils.test.ts index 2b78996caf..6e1a58a204 100644 --- a/packages/router-generator/tests/utils.test.ts +++ b/packages/router-generator/tests/utils.test.ts @@ -2,6 +2,8 @@ import { describe, expect, it, vi } from 'vitest' import { RoutePrefixMap, cleanPath, + createRouteNodesByFullPath, + createRouteNodesByTo, determineInitialRoutePath, hasEscapedLeadingUnderscore, hasEscapedTrailingUnderscore, @@ -58,6 +60,69 @@ describe('inferFullPath', () => { }) }) +describe('createRouteNodesByTo', () => { + const createRoute = ( + overrides: Partial & { routePath: string }, + ): RouteNode => ({ + filePath: 'test.tsx', + fullPath: overrides.routePath, + variableName: 'Test', + _fsRouteType: 'static', + cleanedPath: overrides.routePath.endsWith('/') + ? '/' + : overrides.routePath.split('/').at(-1), + ...overrides, + }) + + it('prefers index routes over pathless layouts for duplicate public to paths', () => { + const pathlessRoute = createRoute({ + routePath: '/livestock/$farmId/medicine/_form', + _fsRouteType: 'pathless_layout', + variableName: 'Pathless', + }) + const indexRoute = createRoute({ + routePath: '/livestock/$farmId/medicine/', + cleanedPath: '/', + variableName: 'Index', + }) + + const map = createRouteNodesByTo([pathlessRoute, indexRoute]) + + expect(map.get('/livestock/$farmId/medicine')).toBe(indexRoute) + }) +}) + +describe('createRouteNodesByFullPath', () => { + const createRoute = ( + overrides: Partial & { routePath: string }, + ): RouteNode => ({ + filePath: 'test.tsx', + fullPath: overrides.routePath, + variableName: 'Test', + _fsRouteType: 'static', + cleanedPath: overrides.routePath.endsWith('/') + ? '/' + : overrides.routePath.split('/').at(-1), + ...overrides, + }) + + it('prefers concrete routes over pathless layouts for duplicate full paths', () => { + const concreteRoute = createRoute({ + routePath: '/livestock/$farmId/medicine', + variableName: 'Concrete', + }) + const pathlessRoute = createRoute({ + routePath: '/livestock/$farmId/medicine/_form', + _fsRouteType: 'pathless_layout', + variableName: 'Pathless', + }) + + const map = createRouteNodesByFullPath([concreteRoute, pathlessRoute]) + + expect(map.get('/livestock/$farmId/medicine')).toBe(concreteRoute) + }) +}) + describe('determineInitialRoutePath', () => { it('removes dots and adds slashes', () => { expect(determineInitialRoutePath('test.test')).toStrictEqual({ diff --git a/packages/router-plugin/src/core/hmr/handle-route-update.ts b/packages/router-plugin/src/core/hmr/handle-route-update.ts index d05b510d65..7ca534c31c 100644 --- a/packages/router-plugin/src/core/hmr/handle-route-update.ts +++ b/packages/router-plugin/src/core/hmr/handle-route-update.ts @@ -18,7 +18,8 @@ type AnyRouteWithPrivateProps = AnyRoute & { type AnyRouterWithPrivateMaps = AnyRouter & { routesById: Record - routesByPath: Record + buildRouteTree: () => Parameters[0] + setRoutes: AnyRouter['setRoutes'] stores: AnyRouter['stores'] & { cachedMatchStores: Map< string, @@ -54,18 +55,19 @@ function handleRouteUpdate( return } - // Keys whose identity must remain stable to prevent React from - // unmounting/remounting the component tree. React Fast Refresh already - // handles hot-updating the function bodies of these components — our job - // is only to update non-component route options (loader, head, etc.). - // For code-split (splittable) routes, the lazyRouteComponent wrapper is - // already cached in the bundler hot data so its identity is stable. - // For unsplittable routes (e.g. root routes), the component is a plain - // function reference that gets recreated on every module re-execution, - // so we must explicitly preserve the old reference. + // Generated route-tree options are not present on the freshly imported route + // module, but they must stay on the live route before rebuilding indexes. + const generatedRouteOptionKeys = new Set(['id', 'path', 'getParentRoute']) + const generatedRouteOptions: Record = {} + generatedRouteOptionKeys.forEach((key) => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key] + } + }) + const removedKeys = new Set() Object.keys(oldRoute.options).forEach((key) => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key) delete oldRoute.options[key] } @@ -76,6 +78,15 @@ function handleRouteUpdate( const preserveComponentIdentity = oldHasShellComponent === newHasShellComponent + // Keys whose identity must remain stable to prevent React from + // unmounting/remounting the component tree. React Fast Refresh already + // handles hot-updating the function bodies of these components — our job + // is only to update non-component route options (loader, head, etc.). + // For code-split (splittable) routes, the lazyRouteComponent wrapper is + // already cached in the bundler hot data so its identity is stable. + // For unsplittable routes (e.g. root routes), the component is a plain + // function reference that gets recreated on every module re-execution, + // so we must explicitly preserve the old reference. // Preserve component identity so React doesn't remount. // React Fast Refresh patches the function bodies in-place. const componentKeys = '__TSR_COMPONENT_TYPES__' as unknown as Array @@ -87,19 +98,18 @@ function handleRouteUpdate( }) } - oldRoute.options = newRoute.options - oldRoute.update(newRoute.options) + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions, + } + + oldRoute.options = nextOptions + oldRoute.update(nextOptions) oldRoute._componentsPromise = undefined oldRoute._lazyPromise = undefined - router.routesById[oldRoute.id] = oldRoute - router.routesByPath[oldRoute.fullPath] = oldRoute - - router.processedTree.matchCache.clear() - router.processedTree.flatCache?.clear() - router.processedTree.singleCache.clear() + router.setRoutes(router.buildRouteTree()) router.resolvePathCache.clear() - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree) const filter = (m: AnyRouteMatch) => m.routeId === oldRoute.id const activeMatch = router.stores.matches.get().find(filter) @@ -149,21 +159,6 @@ function handleRouteUpdate( router.invalidate({ filter, sync: true }) } - function walkReplaceSegmentTree( - route: AnyRouteWithPrivateProps, - node: AnyRouter['processedTree']['segmentTree'], - ) { - if (node.route?.id === route.id) node.route = route - if (node.index) walkReplaceSegmentTree(route, node.index) - node.static?.forEach((child) => walkReplaceSegmentTree(route, child)) - node.staticInsensitive?.forEach((child) => - walkReplaceSegmentTree(route, child), - ) - node.dynamic?.forEach((child) => walkReplaceSegmentTree(route, child)) - node.optional?.forEach((child) => walkReplaceSegmentTree(route, child)) - node.wildcard?.forEach((child) => walkReplaceSegmentTree(route, child)) - } - function getStoreMatch(matchId: string) { return ( router.stores.pendingMatchStores.get(matchId)?.get() || diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx index fd86f55a62..87b7af6c67 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx @@ -51,9 +51,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -70,17 +77,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -118,15 +124,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@webpack-hot.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@webpack-hot.tsx index 4c11947142..6466a24285 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@webpack-hot.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@webpack-hot.tsx @@ -31,9 +31,16 @@ if (import.meta.webpackHot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -50,17 +57,16 @@ if (import.meta.webpackHot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -98,15 +104,6 @@ if (import.meta.webpackHot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx index 2e5a7196fc..146ad344b4 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute-inline-component@true.tsx @@ -40,9 +40,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -59,17 +66,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -107,15 +113,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx index 4201a4a43e..098bc0d7dc 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRoute@true.tsx @@ -42,9 +42,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -61,17 +68,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -109,15 +115,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx index aa97811921..877680a18b 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/createRootRouteWithContext-type-args@true.tsx @@ -45,9 +45,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -64,17 +71,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -112,15 +118,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx index 45214b844f..ba595db5bb 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/explicit-undefined-component@true.tsx @@ -39,9 +39,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -58,17 +65,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -106,15 +112,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx index 383610c28c..1506201d77 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx @@ -51,9 +51,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -70,17 +77,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -118,15 +124,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx index 5ea2a6fa40..46f08ed686 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/multi-component@true.tsx @@ -61,9 +61,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -80,17 +87,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -128,15 +134,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx index 99daa8bf30..ca91b0a8f2 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/react/string-literal-keys@true.tsx @@ -61,9 +61,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -80,17 +87,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -128,15 +134,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsx b/packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsx index ff5afe1806..ea83b4812f 100644 --- a/packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsx +++ b/packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsx @@ -22,9 +22,16 @@ if (import.meta.hot) { return; } ; + const generatedRouteOptionKeys = new Set(["id", "path", "getParentRoute"]); + const generatedRouteOptions = {}; + generatedRouteOptionKeys.forEach(key => { + if (key in oldRoute.options) { + generatedRouteOptions[key] = oldRoute.options[key]; + } + }); const removedKeys = new Set(); Object.keys(oldRoute.options).forEach(key => { - if (!(key in newRoute.options)) { + if (!generatedRouteOptionKeys.has(key) && !(key in newRoute.options)) { removedKeys.add(key); delete oldRoute.options[key]; } @@ -41,17 +48,16 @@ if (import.meta.hot) { }); } ; - oldRoute.options = newRoute.options; - oldRoute.update(newRoute.options); + const nextOptions = { + ...newRoute.options, + ...generatedRouteOptions + }; + oldRoute.options = nextOptions; + oldRoute.update(nextOptions); oldRoute._componentsPromise = undefined; oldRoute._lazyPromise = undefined; - router.routesById[oldRoute.id] = oldRoute; - router.routesByPath[oldRoute.fullPath] = oldRoute; - router.processedTree.matchCache.clear(); - router.processedTree.flatCache?.clear(); - router.processedTree.singleCache.clear(); + router.setRoutes(router.buildRouteTree()); router.resolvePathCache.clear(); - walkReplaceSegmentTree(oldRoute, router.processedTree.segmentTree); const filter = m => m.routeId === oldRoute.id; const activeMatch = router.stores.matches.get().find(filter); const pendingMatch = router.stores.pendingMatches.get().find(filter); @@ -89,15 +95,6 @@ if (import.meta.hot) { }); } ; - function walkReplaceSegmentTree(route, node) { - if (node.route?.id === route.id) node.route = route; - if (node.index) walkReplaceSegmentTree(route, node.index); - node.static?.forEach(child => walkReplaceSegmentTree(route, child)); - node.staticInsensitive?.forEach(child => walkReplaceSegmentTree(route, child)); - node.dynamic?.forEach(child => walkReplaceSegmentTree(route, child)); - node.optional?.forEach(child => walkReplaceSegmentTree(route, child)); - node.wildcard?.forEach(child => walkReplaceSegmentTree(route, child)); - } function getStoreMatch(matchId) { return router.stores.pendingMatchStores.get(matchId)?.get() || router.stores.matchStores.get(matchId)?.get() || router.stores.cachedMatchStores.get(matchId)?.get(); } diff --git a/packages/router-plugin/tests/handle-route-update.test.ts b/packages/router-plugin/tests/handle-route-update.test.ts new file mode 100644 index 0000000000..8f1b28cdb6 --- /dev/null +++ b/packages/router-plugin/tests/handle-route-update.test.ts @@ -0,0 +1,193 @@ +import { + BaseRootRoute, + BaseRoute, + RouterCore, + createNonReactiveMutableStore, + createNonReactiveReadonlyStore, + trimPathRight, +} from '@tanstack/router-core' +import { describe, expect, it } from 'vitest' +import { getHandleRouteUpdateCode } from '../src/core/hmr' +import type { AnyRoute, GetStoreConfig } from '@tanstack/router-core' + +const getStoreConfig: GetStoreConfig = () => ({ + createMutableStore: createNonReactiveMutableStore, + createReadonlyStore: createNonReactiveReadonlyStore, + batch: (fn) => fn(), +}) + +const getHandleRouteUpdate = () => { + return new Function(`return ${getHandleRouteUpdateCode([])}`)() as ( + routeId: string, + newRoute: AnyRoute, + ) => void +} + +function createTestHistory() { + const location = { + href: '/', + pathname: '/', + search: '', + hash: '', + state: { __TSR_index: 0 }, + } + + return { + location, + length: 1, + subscribers: new Set(), + subscribe: () => () => {}, + push: () => {}, + replace: () => {}, + go: () => {}, + back: () => {}, + forward: () => {}, + canGoBack: () => false, + createHref: (href: string) => href, + block: () => () => {}, + flush: () => {}, + destroy: () => {}, + notify: () => {}, + } +} + +function createTestRouter(routeTree: AnyRoute) { + return new RouterCore( + { + routeTree, + history: createTestHistory() as any, + isServer: true, + }, + getStoreConfig, + ) +} + +function withWindowRouter(router: RouterCore) { + const previousWindow = (globalThis as any).window + ;(globalThis as any).window = { __TSR_ROUTER__: router } + + return () => { + if (previousWindow) { + ;(globalThis as any).window = previousWindow + } else { + delete (globalThis as any).window + } + } +} + +function getProcessedTreeRouteForPath( + router: RouterCore, + path: string, +) { + return router.buildRouteTree().routesByPath[path]?.id +} + +describe('handleRouteUpdate', () => { + it('keeps routesByPath pointed at an index route when a pathless layout updates', () => { + const rootRoute = new BaseRootRoute({}) + const parentRoute = new BaseRoute({ + getParentRoute: () => rootRoute, + path: '/livestock/$farmId/medicine', + }) + const pathlessRoute = new BaseRoute({ + getParentRoute: () => parentRoute, + id: '_form', + }) + const newRoute = new BaseRoute({ + getParentRoute: () => pathlessRoute, + path: 'new', + }) + const indexRoute = new BaseRoute({ + getParentRoute: () => parentRoute, + path: '/', + }) + const routeTree = rootRoute.addChildren([ + parentRoute.addChildren([ + pathlessRoute.addChildren([newRoute]), + indexRoute, + ]), + ]) + const router = createTestRouter(routeTree) + const key = trimPathRight(indexRoute.fullPath) + + expect(router.routesByPath[key]?.id).toBe(indexRoute.id) + + const restoreWindow = withWindowRouter(router) + try { + getHandleRouteUpdate()(pathlessRoute.id, new BaseRoute({} as any)) + } finally { + restoreWindow() + } + + expect(router.routesByPath[key]?.id).toBe(indexRoute.id) + expect(router.routesByPath[key]?.id).toBe( + getProcessedTreeRouteForPath(router, key), + ) + }) + + it('keeps an index route winning the trimmed path key when its parent updates', () => { + const rootRoute = new BaseRootRoute({}) + const parentRoute = new BaseRoute({ + getParentRoute: () => rootRoute, + path: '/path', + }) + const indexRoute = new BaseRoute({ + getParentRoute: () => parentRoute, + path: '/', + }) + const routeTree = rootRoute.addChildren([ + parentRoute.addChildren([indexRoute]), + ]) + const router = createTestRouter(routeTree) + const key = trimPathRight(indexRoute.fullPath) + + expect(router.routesByPath[key]?.id).toBe(indexRoute.id) + + const restoreWindow = withWindowRouter(router) + try { + getHandleRouteUpdate()(parentRoute.id, new BaseRoute({} as any)) + } finally { + restoreWindow() + } + + expect(router.routesByPath[key]?.id).toBe(indexRoute.id) + expect(router.routesByPath[key]?.id).toBe( + getProcessedTreeRouteForPath(router, key), + ) + }) + + it('refreshes matching data when params.parse changes', () => { + const rootRoute = new BaseRootRoute({}) + const itemRoute = new BaseRoute({ + getParentRoute: () => rootRoute, + path: '/items/$itemId', + params: { + parse: ({ itemId }: { itemId: string }) => { + return /^\d+$/.test(itemId) ? { itemId } : false + }, + }, + }) + const routeTree = rootRoute.addChildren([itemRoute]) + const router = createTestRouter(routeTree) + + expect(router.getMatchedRoutes('/items/abc').foundRoute?.id).toBeUndefined() + + const restoreWindow = withWindowRouter(router) + try { + getHandleRouteUpdate()( + itemRoute.id, + new BaseRoute({ + params: { + parse: ({ itemId }: { itemId: string }) => ({ itemId }), + }, + } as any), + ) + } finally { + restoreWindow() + } + + expect(router.getMatchedRoutes('/items/abc').foundRoute?.id).toBe( + itemRoute.id, + ) + }) +}) From ee8a6753da78590e3f8659db6d96403604394f34 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 17 May 2026 13:43:38 +0200 Subject: [PATCH 006/471] ci: Version Packages (#7423) --- .changeset/brave-routes-refresh.md | 7 -- .../package.json | 4 +- .../react/authenticated-routes/package.json | 4 +- .../basic-default-search-params/package.json | 2 +- .../react/basic-devtools-panel/package.json | 2 +- examples/react/basic-file-based/package.json | 4 +- .../basic-non-nested-devtools/package.json | 2 +- .../basic-react-query-file-based/package.json | 4 +- examples/react/basic-react-query/package.json | 2 +- .../react/basic-ssr-file-based/package.json | 4 +- .../package.json | 4 +- .../basic-virtual-file-based/package.json | 4 +- .../package.json | 4 +- examples/react/basic/package.json | 2 +- examples/react/deferred-data/package.json | 2 +- examples/react/i18n-paraglide/package.json | 4 +- .../kitchen-sink-file-based/package.json | 4 +- .../package.json | 4 +- .../kitchen-sink-react-query/package.json | 2 +- examples/react/kitchen-sink/package.json | 2 +- examples/react/large-file-based/package.json | 4 +- examples/react/location-masking/package.json | 2 +- .../react/navigation-blocking/package.json | 2 +- .../package.json | 4 +- .../react/quickstart-file-based/package.json | 4 +- .../quickstart-rspack-file-based/package.json | 4 +- .../package.json | 4 +- examples/react/quickstart/package.json | 2 +- .../router-monorepo-react-query/package.json | 4 +- .../packages/router/package.json | 4 +- .../router-monorepo-simple-lazy/package.json | 4 +- .../packages/router/package.json | 4 +- .../react/router-monorepo-simple/package.json | 4 +- .../packages/router/package.json | 4 +- .../react/scroll-restoration/package.json | 2 +- .../search-validator-adapters/package.json | 4 +- examples/react/start-bare/package.json | 4 +- examples/react/start-basic-auth/package.json | 4 +- .../react/start-basic-authjs/package.json | 4 +- .../react/start-basic-cloudflare/package.json | 4 +- .../start-basic-react-query/package.json | 4 +- .../react/start-basic-static/package.json | 6 +- examples/react/start-basic/package.json | 4 +- examples/react/start-bun/package.json | 6 +- examples/react/start-clerk-basic/package.json | 4 +- .../react/start-convex-trellaux/package.json | 4 +- examples/react/start-counter/package.json | 4 +- .../react/start-i18n-paraglide/package.json | 4 +- examples/react/start-large/package.json | 4 +- examples/react/start-material-ui/package.json | 4 +- examples/react/start-rscs/package.json | 4 +- .../package.json | 4 +- .../react/start-supabase-basic/package.json | 4 +- examples/react/start-tailwind-v4/package.json | 4 +- examples/react/start-trellaux/package.json | 4 +- examples/react/start-workos/package.json | 4 +- examples/react/view-transitions/package.json | 4 +- .../react/with-framer-motion/package.json | 2 +- .../react/with-trpc-react-query/package.json | 4 +- examples/react/with-trpc/package.json | 4 +- .../package.json | 4 +- .../solid/authenticated-routes/package.json | 4 +- .../basic-default-search-params/package.json | 2 +- .../solid/basic-devtools-panel/package.json | 2 +- examples/solid/basic-file-based/package.json | 4 +- .../basic-non-nested-devtools/package.json | 2 +- .../basic-solid-query-file-based/package.json | 4 +- examples/solid/basic-solid-query/package.json | 4 +- .../solid/basic-ssr-file-based/package.json | 4 +- .../package.json | 4 +- .../basic-virtual-file-based/package.json | 4 +- .../package.json | 4 +- examples/solid/basic/package.json | 2 +- examples/solid/deferred-data/package.json | 2 +- examples/solid/i18n-paraglide/package.json | 4 +- .../kitchen-sink-file-based/package.json | 4 +- .../package.json | 4 +- .../kitchen-sink-solid-query/package.json | 2 +- examples/solid/kitchen-sink/package.json | 2 +- examples/solid/large-file-based/package.json | 4 +- examples/solid/location-masking/package.json | 2 +- .../solid/navigation-blocking/package.json | 2 +- .../package.json | 4 +- .../solid/quickstart-file-based/package.json | 4 +- .../quickstart-rspack-file-based/package.json | 4 +- .../package.json | 4 +- examples/solid/quickstart/package.json | 2 +- .../router-monorepo-simple-lazy/package.json | 4 +- .../packages/router/package.json | 4 +- .../solid/router-monorepo-simple/package.json | 4 +- .../packages/router/package.json | 4 +- .../router-monorepo-solid-query/package.json | 4 +- .../packages/router/package.json | 4 +- .../solid/scroll-restoration/package.json | 2 +- .../search-validator-adapters/package.json | 4 +- examples/solid/start-basic-auth/package.json | 4 +- .../solid/start-basic-authjs/package.json | 4 +- .../solid/start-basic-cloudflare/package.json | 4 +- .../solid/start-basic-netlify/package.json | 4 +- examples/solid/start-basic-nitro/package.json | 4 +- .../start-basic-solid-query/package.json | 4 +- .../solid/start-basic-static/package.json | 6 +- examples/solid/start-basic/package.json | 4 +- examples/solid/start-bun/package.json | 6 +- .../start-convex-better-auth/package.json | 4 +- examples/solid/start-counter/package.json | 4 +- .../solid/start-i18n-paraglide/package.json | 4 +- examples/solid/start-large/package.json | 4 +- .../package.json | 4 +- .../solid/start-supabase-basic/package.json | 4 +- examples/solid/start-tailwind-v4/package.json | 4 +- examples/solid/view-transitions/package.json | 4 +- .../solid/with-framer-motion/package.json | 2 +- examples/solid/with-trpc/package.json | 4 +- .../vue/basic-file-based-jsx/package.json | 4 +- .../vue/basic-file-based-sfc/package.json | 4 +- examples/vue/basic/package.json | 2 +- packages/react-router/CHANGELOG.md | 7 ++ packages/react-router/package.json | 2 +- packages/react-start-client/CHANGELOG.md | 9 ++ packages/react-start-client/package.json | 2 +- packages/react-start-rsc/CHANGELOG.md | 13 +++ packages/react-start-rsc/package.json | 2 +- packages/react-start-server/CHANGELOG.md | 10 ++ packages/react-start-server/package.json | 2 +- packages/react-start/CHANGELOG.md | 13 +++ packages/react-start/package.json | 2 +- packages/router-cli/CHANGELOG.md | 7 ++ packages/router-cli/package.json | 2 +- packages/router-core/CHANGELOG.md | 6 ++ packages/router-core/package.json | 2 +- packages/router-generator/CHANGELOG.md | 9 ++ packages/router-generator/package.json | 2 +- packages/router-plugin/CHANGELOG.md | 11 ++ packages/router-plugin/package.json | 2 +- packages/router-vite-plugin/CHANGELOG.md | 7 ++ packages/router-vite-plugin/package.json | 2 +- packages/solid-router/CHANGELOG.md | 7 ++ packages/solid-router/package.json | 2 +- packages/solid-start-client/CHANGELOG.md | 9 ++ packages/solid-start-client/package.json | 2 +- packages/solid-start-server/CHANGELOG.md | 10 ++ packages/solid-start-server/package.json | 2 +- packages/solid-start/CHANGELOG.md | 12 +++ packages/solid-start/package.json | 2 +- packages/start-client-core/CHANGELOG.md | 8 ++ packages/start-client-core/package.json | 2 +- packages/start-plugin-core/CHANGELOG.md | 11 ++ packages/start-plugin-core/package.json | 2 +- packages/start-server-core/CHANGELOG.md | 9 ++ packages/start-server-core/package.json | 2 +- .../CHANGELOG.md | 9 ++ .../package.json | 2 +- packages/start-storage-context/CHANGELOG.md | 7 ++ packages/start-storage-context/package.json | 2 +- packages/vue-router/CHANGELOG.md | 7 ++ packages/vue-router/package.json | 2 +- packages/vue-start-client/CHANGELOG.md | 9 ++ packages/vue-start-client/package.json | 2 +- packages/vue-start-server/CHANGELOG.md | 10 ++ packages/vue-start-server/package.json | 2 +- packages/vue-start/CHANGELOG.md | 12 +++ packages/vue-start/package.json | 2 +- pnpm-lock.yaml | 102 +++++++++--------- 164 files changed, 496 insertions(+), 291 deletions(-) delete mode 100644 .changeset/brave-routes-refresh.md diff --git a/.changeset/brave-routes-refresh.md b/.changeset/brave-routes-refresh.md deleted file mode 100644 index 211ae2ce28..0000000000 --- a/.changeset/brave-routes-refresh.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'@tanstack/router-core': patch -'@tanstack/router-generator': patch -'@tanstack/router-plugin': patch ---- - -Fix route mismatch warnings, HMR route index refresh, and generated route type preferences for duplicate pathless/index routes. diff --git a/examples/react/authenticated-routes-firebase/package.json b/examples/react/authenticated-routes-firebase/package.json index 37466a9924..e79c890a52 100644 --- a/examples/react/authenticated-routes-firebase/package.json +++ b/examples/react/authenticated-routes-firebase/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "firebase": "^11.4.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/authenticated-routes/package.json b/examples/react/authenticated-routes/package.json index 639a216076..b81949a335 100644 --- a/examples/react/authenticated-routes/package.json +++ b/examples/react/authenticated-routes/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-default-search-params/package.json b/examples/react/basic-default-search-params/package.json index 330873370a..b6750df6ae 100644 --- a/examples/react/basic-default-search-params/package.json +++ b/examples/react/basic-default-search-params/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-devtools-panel/package.json b/examples/react/basic-devtools-panel/package.json index 33f3b32a78..9d82715ba8 100644 --- a/examples/react/basic-devtools-panel/package.json +++ b/examples/react/basic-devtools-panel/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query-devtools": "^5.67.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-file-based/package.json b/examples/react/basic-file-based/package.json index d80dc72d3a..56b46dcef1 100644 --- a/examples/react/basic-file-based/package.json +++ b/examples/react/basic-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-non-nested-devtools/package.json b/examples/react/basic-non-nested-devtools/package.json index df1b0526b7..b5bd284beb 100644 --- a/examples/react/basic-non-nested-devtools/package.json +++ b/examples/react/basic-non-nested-devtools/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-react-query-file-based/package.json b/examples/react/basic-react-query-file-based/package.json index b7e83ece95..c26bb4f620 100644 --- a/examples/react/basic-react-query-file-based/package.json +++ b/examples/react/basic-react-query-file-based/package.json @@ -12,9 +12,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/basic-react-query/package.json b/examples/react/basic-react-query/package.json index 30ee6bccc4..07a6785e89 100644 --- a/examples/react/basic-react-query/package.json +++ b/examples/react/basic-react-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-ssr-file-based/package.json b/examples/react/basic-ssr-file-based/package.json index d1c73b608d..e4f66f0940 100644 --- a/examples/react/basic-ssr-file-based/package.json +++ b/examples/react/basic-ssr-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-ssr-streaming-file-based/package.json b/examples/react/basic-ssr-streaming-file-based/package.json index 7e8a28015e..6ab032bb3c 100644 --- a/examples/react/basic-ssr-streaming-file-based/package.json +++ b/examples/react/basic-ssr-streaming-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/react/basic-virtual-file-based/package.json b/examples/react/basic-virtual-file-based/package.json index 431c0d06b5..abe33288b4 100644 --- a/examples/react/basic-virtual-file-based/package.json +++ b/examples/react/basic-virtual-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic-virtual-inside-file-based/package.json b/examples/react/basic-virtual-inside-file-based/package.json index 53bf010a1f..2b811d3443 100644 --- a/examples/react/basic-virtual-inside-file-based/package.json +++ b/examples/react/basic-virtual-inside-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/virtual-file-routes": "^1.162.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json index 2a5ae68e0a..4427ad4f99 100644 --- a/examples/react/basic/package.json +++ b/examples/react/basic/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/deferred-data/package.json b/examples/react/deferred-data/package.json index 29faf6ddad..69b5e93f69 100644 --- a/examples/react/deferred-data/package.json +++ b/examples/react/deferred-data/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/i18n-paraglide/package.json b/examples/react/i18n-paraglide/package.json index ff9fb76c1b..95367428b7 100644 --- a/examples/react/i18n-paraglide/package.json +++ b/examples/react/i18n-paraglide/package.json @@ -11,8 +11,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/kitchen-sink-file-based/package.json b/examples/react/kitchen-sink-file-based/package.json index 2fe67acffc..c70a28010d 100644 --- a/examples/react/kitchen-sink-file-based/package.json +++ b/examples/react/kitchen-sink-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/kitchen-sink-react-query-file-based/package.json b/examples/react/kitchen-sink-react-query-file-based/package.json index 584dca38fb..698fb92c3c 100644 --- a/examples/react/kitchen-sink-react-query-file-based/package.json +++ b/examples/react/kitchen-sink-react-query-file-based/package.json @@ -12,9 +12,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "immer": "^10.1.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/kitchen-sink-react-query/package.json b/examples/react/kitchen-sink-react-query/package.json index 31eac760a0..d4e03716a8 100644 --- a/examples/react/kitchen-sink-react-query/package.json +++ b/examples/react/kitchen-sink-react-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "immer": "^10.1.1", "react": "^19.0.0", diff --git a/examples/react/kitchen-sink/package.json b/examples/react/kitchen-sink/package.json index b2b53203c7..6b498ff7be 100644 --- a/examples/react/kitchen-sink/package.json +++ b/examples/react/kitchen-sink/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "immer": "^10.1.1", "react": "^19.0.0", diff --git a/examples/react/large-file-based/package.json b/examples/react/large-file-based/package.json index f9a0790b6f..f23f482e02 100644 --- a/examples/react/large-file-based/package.json +++ b/examples/react/large-file-based/package.json @@ -13,9 +13,9 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/location-masking/package.json b/examples/react/location-masking/package.json index 958ba20958..f0389e6c5c 100644 --- a/examples/react/location-masking/package.json +++ b/examples/react/location-masking/package.json @@ -12,7 +12,7 @@ "@radix-ui/react-dialog": "^1.1.6", "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/navigation-blocking/package.json b/examples/react/navigation-blocking/package.json index 5afe9be7b5..e7a3a4a609 100644 --- a/examples/react/navigation-blocking/package.json +++ b/examples/react/navigation-blocking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/quickstart-esbuild-file-based/package.json b/examples/react/quickstart-esbuild-file-based/package.json index a352be64ac..0e9a51f837 100644 --- a/examples/react/quickstart-esbuild-file-based/package.json +++ b/examples/react/quickstart-esbuild-file-based/package.json @@ -9,9 +9,9 @@ "start": "dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-file-based/package.json b/examples/react/quickstart-file-based/package.json index 8dab46a145..597d4c299f 100644 --- a/examples/react/quickstart-file-based/package.json +++ b/examples/react/quickstart-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/quickstart-rspack-file-based/package.json b/examples/react/quickstart-rspack-file-based/package.json index d730fdf654..48f093e18c 100644 --- a/examples/react/quickstart-rspack-file-based/package.json +++ b/examples/react/quickstart-rspack-file-based/package.json @@ -9,7 +9,7 @@ }, "dependencies": { "@tailwindcss/postcss": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "postcss": "^8.5.1", "react": "^19.0.0", @@ -19,7 +19,7 @@ "devDependencies": { "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-react": "^2.0.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "typescript": "^6.0.2" diff --git a/examples/react/quickstart-webpack-file-based/package.json b/examples/react/quickstart-webpack-file-based/package.json index 668fac3546..9543abdd8c 100644 --- a/examples/react/quickstart-webpack-file-based/package.json +++ b/examples/react/quickstart-webpack-file-based/package.json @@ -7,14 +7,14 @@ "build": "webpack build && tsc --noEmit" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0" }, "devDependencies": { "@swc/core": "^1.10.15", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "html-webpack-plugin": "^5.6.3", diff --git a/examples/react/quickstart/package.json b/examples/react/quickstart/package.json index 2e69525fdc..554d72a562 100644 --- a/examples/react/quickstart/package.json +++ b/examples/react/quickstart/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/router-monorepo-react-query/package.json b/examples/react/router-monorepo-react-query/package.json index f6b016ae55..0cf68bc935 100644 --- a/examples/react/router-monorepo-react-query/package.json +++ b/examples/react/router-monorepo-react-query/package.json @@ -12,9 +12,9 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-react-query/packages/router/package.json b/examples/react/router-monorepo-react-query/packages/router/package.json index 8c1735485e..4edc1ba30e 100644 --- a/examples/react/router-monorepo-react-query/packages/router/package.json +++ b/examples/react/router-monorepo-react-query/packages/router/package.json @@ -10,8 +10,8 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "@router-mono-react-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/react/router-monorepo-simple-lazy/package.json b/examples/react/router-monorepo-simple-lazy/package.json index b481e51d6c..f4f8458a9f 100644 --- a/examples/react/router-monorepo-simple-lazy/package.json +++ b/examples/react/router-monorepo-simple-lazy/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple-lazy/packages/router/package.json b/examples/react/router-monorepo-simple-lazy/packages/router/package.json index c47507062d..237e831607 100644 --- a/examples/react/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/react/router-monorepo-simple-lazy/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/router-monorepo-simple/package.json b/examples/react/router-monorepo-simple/package.json index a5d85c03fe..5a40262390 100644 --- a/examples/react/router-monorepo-simple/package.json +++ b/examples/react/router-monorepo-simple/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/router-monorepo-simple/packages/router/package.json b/examples/react/router-monorepo-simple/packages/router/package.json index 3387d17e37..2d9193862e 100644 --- a/examples/react/router-monorepo-simple/packages/router/package.json +++ b/examples/react/router-monorepo-simple/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/react-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "redaxios": "^0.5.1", "zod": "^3.24.2", "react": "^19.0.0", diff --git a/examples/react/scroll-restoration/package.json b/examples/react/scroll-restoration/package.json index 11b1803e03..5c21c3bdb7 100644 --- a/examples/react/scroll-restoration/package.json +++ b/examples/react/scroll-restoration/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-virtual": "^3.13.0", "react": "^19.0.0", diff --git a/examples/react/search-validator-adapters/package.json b/examples/react/search-validator-adapters/package.json index c5c660f33b..8cf475af8f 100644 --- a/examples/react/search-validator-adapters/package.json +++ b/examples/react/search-validator-adapters/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/arktype-adapter": "^1.167.0", "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/react/start-bare/package.json b/examples/react/start-bare/package.json index e0f59f2865..3f93cc7cf4 100644 --- a/examples/react/start-bare/package.json +++ b/examples/react/start-bare/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-basic-auth/package.json b/examples/react/start-basic-auth/package.json index b27fa4d900..e4284ce85d 100644 --- a/examples/react/start-basic-auth/package.json +++ b/examples/react/start-basic-auth/package.json @@ -14,9 +14,9 @@ "@libsql/client": "^0.15.15", "@prisma/adapter-libsql": "^7.0.0", "@prisma/client": "^7.0.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-authjs/package.json b/examples/react/start-basic-authjs/package.json index b8a7ef22d2..2c2957ed04 100644 --- a/examples/react/start-basic-authjs/package.json +++ b/examples/react/start-basic-authjs/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@auth/core": "^0.41.1", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "start-authjs": "^1.0.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-basic-cloudflare/package.json b/examples/react/start-basic-cloudflare/package.json index 8de9133905..21e5d05e7b 100644 --- a/examples/react/start-basic-cloudflare/package.json +++ b/examples/react/start-basic-cloudflare/package.json @@ -12,9 +12,9 @@ "postinstall": "npm run cf-typegen" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-basic-react-query/package.json b/examples/react/start-basic-react-query/package.json index 68d6b31546..55246afa5d 100644 --- a/examples/react/start-basic-react-query/package.json +++ b/examples/react/start-basic-react-query/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-basic-static/package.json b/examples/react/start-basic-static/package.json index a391b93e82..d65330a24c 100644 --- a/examples/react/start-basic-static/package.json +++ b/examples/react/start-basic-static/package.json @@ -10,10 +10,10 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", - "@tanstack/start-static-server-functions": "^1.167.3", + "@tanstack/react-start": "^1.168.6", + "@tanstack/start-static-server-functions": "^1.167.4", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-basic/package.json b/examples/react/start-basic/package.json index ac82e4a508..d43a5ed8ef 100644 --- a/examples/react/start-basic/package.json +++ b/examples/react/start-basic/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-bun/package.json b/examples/react/start-bun/package.json index 6d184e55c0..09b31d2e0f 100644 --- a/examples/react/start-bun/package.json +++ b/examples/react/start-bun/package.json @@ -15,11 +15,11 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/react-devtools": "^0.7.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.5", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/react-start": "^1.168.6", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.1.1", "react-dom": "^19.1.1", "tailwindcss": "^4.2.2" diff --git a/examples/react/start-clerk-basic/package.json b/examples/react/start-clerk-basic/package.json index 2a4bd18c3b..e5b652f125 100644 --- a/examples/react/start-clerk-basic/package.json +++ b/examples/react/start-clerk-basic/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@clerk/tanstack-react-start": "^0.27.14", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "@vitejs/plugin-react": "^6.0.1", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-convex-trellaux/package.json b/examples/react/start-convex-trellaux/package.json index a8064094a8..226d48e8c7 100644 --- a/examples/react/start-convex-trellaux/package.json +++ b/examples/react/start-convex-trellaux/package.json @@ -15,10 +15,10 @@ "@convex-dev/react-query": "0.0.0-alpha.8", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "concurrently": "^8.2.2", "convex": "^1.19.0", "ky": "^1.7.4", diff --git a/examples/react/start-counter/package.json b/examples/react/start-counter/package.json index b29b763e3f..266cdceae9 100644 --- a/examples/react/start-counter/package.json +++ b/examples/react/start-counter/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0" }, diff --git a/examples/react/start-i18n-paraglide/package.json b/examples/react/start-i18n-paraglide/package.json index 31252261b1..52e1898417 100644 --- a/examples/react/start-i18n-paraglide/package.json +++ b/examples/react/start-i18n-paraglide/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tanstack/react-devtools": "^0.7.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.1.1", "react-dom": "^19.1.1" }, diff --git a/examples/react/start-large/package.json b/examples/react/start-large/package.json index e2f77e9b2f..fdb4ef9832 100644 --- a/examples/react/start-large/package.json +++ b/examples/react/start-large/package.json @@ -13,9 +13,9 @@ }, "dependencies": { "@tanstack/react-query": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/start-material-ui/package.json b/examples/react/start-material-ui/package.json index bce2359db0..4d39a827b4 100644 --- a/examples/react/start-material-ui/package.json +++ b/examples/react/start-material-ui/package.json @@ -15,8 +15,8 @@ "@emotion/styled": "11.14.0", "@fontsource-variable/roboto": "5.2.5", "@mui/material": "6.4.7", - "@tanstack/react-router": "^1.170.3", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-router": "^1.170.4", + "@tanstack/react-start": "^1.168.6", "@tanstack/react-router-devtools": "^1.167.0", "react": "^19.0.0", "react-dom": "^19.0.0", diff --git a/examples/react/start-rscs/package.json b/examples/react/start-rscs/package.json index 41cc077579..28f39b60b8 100644 --- a/examples/react/start-rscs/package.json +++ b/examples/react/start-rscs/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "dexie": "^4.0.10", "react": "^19.2.0", "react-dom": "^19.2.0", diff --git a/examples/react/start-streaming-data-from-server-functions/package.json b/examples/react/start-streaming-data-from-server-functions/package.json index eeea630b39..b2a032a252 100644 --- a/examples/react/start-streaming-data-from-server-functions/package.json +++ b/examples/react/start-streaming-data-from-server-functions/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "zod": "^3.24.2" diff --git a/examples/react/start-supabase-basic/package.json b/examples/react/start-supabase-basic/package.json index 6d73f2d508..5f39de6ef1 100644 --- a/examples/react/start-supabase-basic/package.json +++ b/examples/react/start-supabase-basic/package.json @@ -15,9 +15,9 @@ "dependencies": { "@supabase/ssr": "^0.5.2", "@supabase/supabase-js": "^2.48.1", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1" diff --git a/examples/react/start-tailwind-v4/package.json b/examples/react/start-tailwind-v4/package.json index 042ad0baa5..a5a2271086 100644 --- a/examples/react/start-tailwind-v4/package.json +++ b/examples/react/start-tailwind-v4/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "tailwind-merge": "^2.6.0", diff --git a/examples/react/start-trellaux/package.json b/examples/react/start-trellaux/package.json index 48dd56d9f4..fa34f28b2a 100644 --- a/examples/react/start-trellaux/package.json +++ b/examples/react/start-trellaux/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "@tanstack/react-router-ssr-query": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "ky": "^1.7.4", "msw": "^2.7.0", "react": "^19.0.0", diff --git a/examples/react/start-workos/package.json b/examples/react/start-workos/package.json index 8c8e353373..73650a0b11 100644 --- a/examples/react/start-workos/package.json +++ b/examples/react/start-workos/package.json @@ -14,9 +14,9 @@ "license": "MIT", "dependencies": { "@radix-ui/themes": "^3.3.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/react-start": "^1.168.5", + "@tanstack/react-start": "^1.168.6", "@workos/authkit-tanstack-react-start": "^0.5.0", "react": "^19.0.0", "react-dom": "^19.0.0" diff --git a/examples/react/view-transitions/package.json b/examples/react/view-transitions/package.json index 69eaeb9a59..f0ccf783e2 100644 --- a/examples/react/view-transitions/package.json +++ b/examples/react/view-transitions/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "react": "^19.0.0", "react-dom": "^19.0.0", "redaxios": "^0.5.1", diff --git a/examples/react/with-framer-motion/package.json b/examples/react/with-framer-motion/package.json index b359a95112..5edd5b218e 100644 --- a/examples/react/with-framer-motion/package.json +++ b/examples/react/with-framer-motion/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", "framer-motion": "^11.18.2", "react": "^19.0.0", diff --git a/examples/react/with-trpc-react-query/package.json b/examples/react/with-trpc-react-query/package.json index 876eaf3b14..838b78a04f 100644 --- a/examples/react/with-trpc-react-query/package.json +++ b/examples/react/with-trpc-react-query/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/react-query": "^5.90.0", "@tanstack/react-query-devtools": "^5.90.0", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "@trpc/tanstack-react-query": "^11.4.3", diff --git a/examples/react/with-trpc/package.json b/examples/react/with-trpc/package.json index 9ca548c6c6..7f830af2a2 100644 --- a/examples/react/with-trpc/package.json +++ b/examples/react/with-trpc/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/react-router": "^1.170.3", + "@tanstack/react-router": "^1.170.4", "@tanstack/react-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/solid/authenticated-routes-firebase/package.json b/examples/solid/authenticated-routes-firebase/package.json index a7bf5fb5a1..9e9ae45089 100644 --- a/examples/solid/authenticated-routes-firebase/package.json +++ b/examples/solid/authenticated-routes-firebase/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "firebase": "^11.4.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/authenticated-routes/package.json b/examples/solid/authenticated-routes/package.json index c538b531d1..346d58b8a4 100644 --- a/examples/solid/authenticated-routes/package.json +++ b/examples/solid/authenticated-routes/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/basic-default-search-params/package.json b/examples/solid/basic-default-search-params/package.json index be24973e6f..1a9d23b857 100644 --- a/examples/solid/basic-default-search-params/package.json +++ b/examples/solid/basic-default-search-params/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic-devtools-panel/package.json b/examples/solid/basic-devtools-panel/package.json index 8deac68782..08b858a17d 100644 --- a/examples/solid/basic-devtools-panel/package.json +++ b/examples/solid/basic-devtools-panel/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/basic-file-based/package.json b/examples/solid/basic-file-based/package.json index cc8f39b62f..9506966663 100644 --- a/examples/solid/basic-file-based/package.json +++ b/examples/solid/basic-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-non-nested-devtools/package.json b/examples/solid/basic-non-nested-devtools/package.json index fc02b78d1b..12f594148c 100644 --- a/examples/solid/basic-non-nested-devtools/package.json +++ b/examples/solid/basic-non-nested-devtools/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/basic-solid-query-file-based/package.json b/examples/solid/basic-solid-query-file-based/package.json index a0f02c784f..9264ba4c0b 100644 --- a/examples/solid/basic-solid-query-file-based/package.json +++ b/examples/solid/basic-solid-query-file-based/package.json @@ -13,7 +13,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -21,7 +21,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-solid-query/package.json b/examples/solid/basic-solid-query/package.json index 9ddadee512..59472e5e01 100644 --- a/examples/solid/basic-solid-query/package.json +++ b/examples/solid/basic-solid-query/package.json @@ -12,14 +12,14 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/basic-ssr-file-based/package.json b/examples/solid/basic-ssr-file-based/package.json index c4b2fad635..fc70cc62c7 100644 --- a/examples/solid/basic-ssr-file-based/package.json +++ b/examples/solid/basic-ssr-file-based/package.json @@ -11,8 +11,8 @@ "debug": "node --inspect-brk server" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "compression": "^1.8.0", "express": "^4.21.2", "get-port": "^7.1.0", diff --git a/examples/solid/basic-ssr-streaming-file-based/package.json b/examples/solid/basic-ssr-streaming-file-based/package.json index fdf0637eaa..2ccefca4f9 100644 --- a/examples/solid/basic-ssr-streaming-file-based/package.json +++ b/examples/solid/basic-ssr-streaming-file-based/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "compression": "^1.8.0", "express": "^4.21.2", @@ -24,7 +24,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@types/express": "^4.17.23", "typescript": "^6.0.2", "vite": "^8.0.0", diff --git a/examples/solid/basic-virtual-file-based/package.json b/examples/solid/basic-virtual-file-based/package.json index 566e2eb7e8..cbf09b3d19 100644 --- a/examples/solid/basic-virtual-file-based/package.json +++ b/examples/solid/basic-virtual-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic-virtual-inside-file-based/package.json b/examples/solid/basic-virtual-inside-file-based/package.json index ae88ed2b0b..61b8d46882 100644 --- a/examples/solid/basic-virtual-inside-file-based/package.json +++ b/examples/solid/basic-virtual-inside-file-based/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/virtual-file-routes": "^1.162.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/basic/package.json b/examples/solid/basic/package.json index 8f85fb4f39..67c4ead89c 100644 --- a/examples/solid/basic/package.json +++ b/examples/solid/basic/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/deferred-data/package.json b/examples/solid/deferred-data/package.json index 26085772ed..ed6fa4d65c 100644 --- a/examples/solid/deferred-data/package.json +++ b/examples/solid/deferred-data/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/i18n-paraglide/package.json b/examples/solid/i18n-paraglide/package.json index e401fd675f..f82290fc0c 100644 --- a/examples/solid/i18n-paraglide/package.json +++ b/examples/solid/i18n-paraglide/package.json @@ -11,8 +11,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/kitchen-sink-file-based/package.json b/examples/solid/kitchen-sink-file-based/package.json index 13ea51d1a5..dd54574b5c 100644 --- a/examples/solid/kitchen-sink-file-based/package.json +++ b/examples/solid/kitchen-sink-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", @@ -19,7 +19,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/kitchen-sink-solid-query-file-based/package.json b/examples/solid/kitchen-sink-solid-query-file-based/package.json index 2a3001533a..93af38ee67 100644 --- a/examples/solid/kitchen-sink-solid-query-file-based/package.json +++ b/examples/solid/kitchen-sink-solid-query-file-based/package.json @@ -10,10 +10,10 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", diff --git a/examples/solid/kitchen-sink-solid-query/package.json b/examples/solid/kitchen-sink-solid-query/package.json index 8646f62275..c8226c0cc3 100644 --- a/examples/solid/kitchen-sink-solid-query/package.json +++ b/examples/solid/kitchen-sink-solid-query/package.json @@ -12,7 +12,7 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "redaxios": "^0.5.1", diff --git a/examples/solid/kitchen-sink/package.json b/examples/solid/kitchen-sink/package.json index 50df16bc04..cc9f16cef2 100644 --- a/examples/solid/kitchen-sink/package.json +++ b/examples/solid/kitchen-sink/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "immer": "^10.1.1", "solid-js": "^1.9.10", diff --git a/examples/solid/large-file-based/package.json b/examples/solid/large-file-based/package.json index 8d4329cdff..12b24e6195 100644 --- a/examples/solid/large-file-based/package.json +++ b/examples/solid/large-file-based/package.json @@ -13,9 +13,9 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/location-masking/package.json b/examples/solid/location-masking/package.json index c9ebde2269..dab86f2a3c 100644 --- a/examples/solid/location-masking/package.json +++ b/examples/solid/location-masking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/navigation-blocking/package.json b/examples/solid/navigation-blocking/package.json index c30d80ec00..62e6718372 100644 --- a/examples/solid/navigation-blocking/package.json +++ b/examples/solid/navigation-blocking/package.json @@ -11,7 +11,7 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "redaxios": "^0.5.1", diff --git a/examples/solid/quickstart-esbuild-file-based/package.json b/examples/solid/quickstart-esbuild-file-based/package.json index 3b6c334053..137e0b268f 100644 --- a/examples/solid/quickstart-esbuild-file-based/package.json +++ b/examples/solid/quickstart-esbuild-file-based/package.json @@ -9,8 +9,8 @@ "start": "dev" }, "dependencies": { - "@tanstack/router-plugin": "^1.168.5", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.6", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/quickstart-file-based/package.json b/examples/solid/quickstart-file-based/package.json index 4e819327e2..3fe5e5daea 100644 --- a/examples/solid/quickstart-file-based/package.json +++ b/examples/solid/quickstart-file-based/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", @@ -18,7 +18,7 @@ "zod": "^3.24.2" }, "devDependencies": { - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2", "vite": "^8.0.0", "vite-plugin-solid": "^2.11.11" diff --git a/examples/solid/quickstart-rspack-file-based/package.json b/examples/solid/quickstart-rspack-file-based/package.json index 77bb0a0874..25b69dadeb 100644 --- a/examples/solid/quickstart-rspack-file-based/package.json +++ b/examples/solid/quickstart-rspack-file-based/package.json @@ -9,7 +9,7 @@ }, "dependencies": { "@tailwindcss/postcss": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "postcss": "^8.5.1", "solid-js": "^1.9.10", @@ -19,7 +19,7 @@ "@rsbuild/core": "^2.0.1", "@rsbuild/plugin-babel": "^1.1.2", "@rsbuild/plugin-solid": "^1.1.1", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "typescript": "^6.0.2" } } diff --git a/examples/solid/quickstart-webpack-file-based/package.json b/examples/solid/quickstart-webpack-file-based/package.json index 61d2570f54..b6779ff536 100644 --- a/examples/solid/quickstart-webpack-file-based/package.json +++ b/examples/solid/quickstart-webpack-file-based/package.json @@ -7,7 +7,7 @@ "build": "webpack build && tsc --noEmit" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" @@ -15,7 +15,7 @@ "devDependencies": { "@babel/core": "^7.28.5", "@babel/preset-typescript": "^7.27.1", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "babel-loader": "^10.0.0", "babel-preset-solid": "^1.9.10", "css-loader": "^7.1.2", diff --git a/examples/solid/quickstart/package.json b/examples/solid/quickstart/package.json index 0e783bd1f2..4b41906bd8 100644 --- a/examples/solid/quickstart/package.json +++ b/examples/solid/quickstart/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" diff --git a/examples/solid/router-monorepo-simple-lazy/package.json b/examples/solid/router-monorepo-simple-lazy/package.json index c95c7ccaaa..31ae751a90 100644 --- a/examples/solid/router-monorepo-simple-lazy/package.json +++ b/examples/solid/router-monorepo-simple-lazy/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json index 8713a7ec6f..3b636a4e47 100644 --- a/examples/solid/router-monorepo-simple-lazy/packages/router/package.json +++ b/examples/solid/router-monorepo-simple-lazy/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-simple/package.json b/examples/solid/router-monorepo-simple/package.json index d6907db597..af12838669 100644 --- a/examples/solid/router-monorepo-simple/package.json +++ b/examples/solid/router-monorepo-simple/package.json @@ -8,9 +8,9 @@ "dev": "pnpm router build && pnpm post-feature build && pnpm app dev" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-simple/packages/router/package.json b/examples/solid/router-monorepo-simple/packages/router/package.json index 1b77617ada..f32ecce316 100644 --- a/examples/solid/router-monorepo-simple/packages/router/package.json +++ b/examples/solid/router-monorepo-simple/packages/router/package.json @@ -9,8 +9,8 @@ "types": "./dist/index.d.ts", "dependencies": { "@tanstack/history": "^1.162.0", - "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "redaxios": "^0.5.1", "zod": "^3.24.2", "solid-js": "^1.9.10" diff --git a/examples/solid/router-monorepo-solid-query/package.json b/examples/solid/router-monorepo-solid-query/package.json index c35705f4ed..95a1b64189 100644 --- a/examples/solid/router-monorepo-solid-query/package.json +++ b/examples/solid/router-monorepo-solid-query/package.json @@ -12,9 +12,9 @@ "dependencies": { "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1" }, diff --git a/examples/solid/router-monorepo-solid-query/packages/router/package.json b/examples/solid/router-monorepo-solid-query/packages/router/package.json index f470f7e529..52df4cb070 100644 --- a/examples/solid/router-monorepo-solid-query/packages/router/package.json +++ b/examples/solid/router-monorepo-solid-query/packages/router/package.json @@ -10,8 +10,8 @@ "dependencies": { "@tanstack/history": "^1.162.0", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-router": "^1.170.4", + "@tanstack/router-plugin": "^1.168.6", "@router-solid-mono-solid-query/post-query": "workspace:*", "redaxios": "^0.5.1", "zod": "^3.24.2", diff --git a/examples/solid/scroll-restoration/package.json b/examples/solid/scroll-restoration/package.json index 4660d6062b..8aab1e0911 100644 --- a/examples/solid/scroll-restoration/package.json +++ b/examples/solid/scroll-restoration/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-virtual": "^3.13.0", "solid-js": "^1.9.10", diff --git a/examples/solid/search-validator-adapters/package.json b/examples/solid/search-validator-adapters/package.json index 4db0d37a8d..ae9c36d85d 100644 --- a/examples/solid/search-validator-adapters/package.json +++ b/examples/solid/search-validator-adapters/package.json @@ -13,9 +13,9 @@ "@tailwindcss/vite": "^4.2.2", "@tanstack/arktype-adapter": "^1.167.0", "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@tanstack/valibot-adapter": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "arktype": "^2.1.7", diff --git a/examples/solid/start-basic-auth/package.json b/examples/solid/start-basic-auth/package.json index f52a2067f5..53a7e5a85b 100644 --- a/examples/solid/start-basic-auth/package.json +++ b/examples/solid/start-basic-auth/package.json @@ -14,9 +14,9 @@ "@libsql/client": "^0.15.15", "@prisma/adapter-libsql": "^7.0.0", "@prisma/client": "^7.0.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-authjs/package.json b/examples/solid/start-basic-authjs/package.json index 4362bc0d2c..7f2bf6c491 100644 --- a/examples/solid/start-basic-authjs/package.json +++ b/examples/solid/start-basic-authjs/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@auth/core": "^0.41.1", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "start-authjs": "^1.0.0", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-cloudflare/package.json b/examples/solid/start-basic-cloudflare/package.json index 6b8c934eb6..747d49a2fe 100644 --- a/examples/solid/start-basic-cloudflare/package.json +++ b/examples/solid/start-basic-cloudflare/package.json @@ -12,9 +12,9 @@ "postinstall": "npm run cf-typegen" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-netlify/package.json b/examples/solid/start-basic-netlify/package.json index 3110e44dbe..67667f846c 100644 --- a/examples/solid/start-basic-netlify/package.json +++ b/examples/solid/start-basic-netlify/package.json @@ -9,9 +9,9 @@ "preview": "vite preview" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-nitro/package.json b/examples/solid/start-basic-nitro/package.json index 13bc7f153f..489c7cfe98 100644 --- a/examples/solid/start-basic-nitro/package.json +++ b/examples/solid/start-basic-nitro/package.json @@ -9,9 +9,9 @@ "preview": "vite preview" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-basic-solid-query/package.json b/examples/solid/start-basic-solid-query/package.json index b6b755358e..8be84e5119 100644 --- a/examples/solid/start-basic-solid-query/package.json +++ b/examples/solid/start-basic-solid-query/package.json @@ -12,10 +12,10 @@ "dependencies": { "@tanstack/solid-query": "^5.90.9", "@tanstack/solid-query-devtools": "^5.90.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic-static/package.json b/examples/solid/start-basic-static/package.json index bd01b6fc0a..4767ec354d 100644 --- a/examples/solid/start-basic-static/package.json +++ b/examples/solid/start-basic-static/package.json @@ -10,10 +10,10 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", - "@tanstack/start-static-server-functions": "^1.167.3", + "@tanstack/solid-start": "^1.168.6", + "@tanstack/start-static-server-functions": "^1.167.4", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-basic/package.json b/examples/solid/start-basic/package.json index 44ed0d9e93..d484695114 100644 --- a/examples/solid/start-basic/package.json +++ b/examples/solid/start-basic/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "redaxios": "^0.5.1", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0" diff --git a/examples/solid/start-bun/package.json b/examples/solid/start-bun/package.json index ce4c3b6fb0..7db406d5f1 100644 --- a/examples/solid/start-bun/package.json +++ b/examples/solid/start-bun/package.json @@ -15,11 +15,11 @@ "dependencies": { "@tailwindcss/vite": "^4.2.2", "@tanstack/solid-devtools": "^0.7.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "@tanstack/solid-router-ssr-query": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "tailwindcss": "^4.2.2" }, diff --git a/examples/solid/start-convex-better-auth/package.json b/examples/solid/start-convex-better-auth/package.json index b5fee853cf..fe18f36ff0 100644 --- a/examples/solid/start-convex-better-auth/package.json +++ b/examples/solid/start-convex-better-auth/package.json @@ -13,9 +13,9 @@ "dependencies": { "@convex-dev/better-auth": "^0.9.7", "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "better-auth": "^1.3.27", "clsx": "^2.1.1", "convex": "^1.28.2", diff --git a/examples/solid/start-counter/package.json b/examples/solid/start-counter/package.json index 3f417e7595..9434036f9f 100644 --- a/examples/solid/start-counter/package.json +++ b/examples/solid/start-counter/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-i18n-paraglide/package.json b/examples/solid/start-i18n-paraglide/package.json index c43e1d4af8..4cc2dad4b8 100644 --- a/examples/solid/start-i18n-paraglide/package.json +++ b/examples/solid/start-i18n-paraglide/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tanstack/solid-devtools": "^0.7.0", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10" }, "devDependencies": { diff --git a/examples/solid/start-large/package.json b/examples/solid/start-large/package.json index ac0a5e6891..645d322ad0 100644 --- a/examples/solid/start-large/package.json +++ b/examples/solid/start-large/package.json @@ -13,9 +13,9 @@ }, "dependencies": { "@tanstack/solid-query": "^5.90.9", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwind-merge": "^2.6.0", diff --git a/examples/solid/start-streaming-data-from-server-functions/package.json b/examples/solid/start-streaming-data-from-server-functions/package.json index 01981838fe..8cf065ac3c 100644 --- a/examples/solid/start-streaming-data-from-server-functions/package.json +++ b/examples/solid/start-streaming-data-from-server-functions/package.json @@ -10,9 +10,9 @@ "start": "pnpx srvx --prod -s ../client dist/server/server.js" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10", "zod": "^3.24.2" }, diff --git a/examples/solid/start-supabase-basic/package.json b/examples/solid/start-supabase-basic/package.json index cfb02d0517..65184985bf 100644 --- a/examples/solid/start-supabase-basic/package.json +++ b/examples/solid/start-supabase-basic/package.json @@ -14,9 +14,9 @@ "dependencies": { "@supabase/ssr": "^0.5.2", "@supabase/supabase-js": "^2.48.1", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.9", "redaxios": "^0.5.1" }, diff --git a/examples/solid/start-tailwind-v4/package.json b/examples/solid/start-tailwind-v4/package.json index aeb4361bc6..50a4bfef40 100644 --- a/examples/solid/start-tailwind-v4/package.json +++ b/examples/solid/start-tailwind-v4/package.json @@ -10,9 +10,9 @@ "start": "node .output/server/index.mjs" }, "dependencies": { - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/solid-start": "^1.168.5", + "@tanstack/solid-start": "^1.168.6", "solid-js": "^1.9.10", "tailwind-merge": "^2.6.0", "zod": "^3.24.2" diff --git a/examples/solid/view-transitions/package.json b/examples/solid/view-transitions/package.json index d7caa7237e..460b43c0d8 100644 --- a/examples/solid/view-transitions/package.json +++ b/examples/solid/view-transitions/package.json @@ -10,9 +10,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "solid-js": "^1.9.10", "redaxios": "^0.5.1", "tailwindcss": "^4.2.2", diff --git a/examples/solid/with-framer-motion/package.json b/examples/solid/with-framer-motion/package.json index d432c2ebb6..dbb42b03d4 100644 --- a/examples/solid/with-framer-motion/package.json +++ b/examples/solid/with-framer-motion/package.json @@ -10,7 +10,7 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "solid-js": "^1.9.10", diff --git a/examples/solid/with-trpc/package.json b/examples/solid/with-trpc/package.json index 5ea82b9a8d..b83a554541 100644 --- a/examples/solid/with-trpc/package.json +++ b/examples/solid/with-trpc/package.json @@ -11,9 +11,9 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/solid-router": "^1.170.3", + "@tanstack/solid-router": "^1.170.4", "@tanstack/solid-router-devtools": "^1.167.0", - "@tanstack/router-plugin": "^1.168.5", + "@tanstack/router-plugin": "^1.168.6", "@trpc/client": "^11.4.3", "@trpc/server": "^11.4.3", "express": "^4.21.2", diff --git a/examples/vue/basic-file-based-jsx/package.json b/examples/vue/basic-file-based-jsx/package.json index 7459664e44..27b1dce684 100644 --- a/examples/vue/basic-file-based-jsx/package.json +++ b/examples/vue/basic-file-based-jsx/package.json @@ -10,8 +10,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.5", - "@tanstack/vue-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.6", + "@tanstack/vue-router": "^1.170.4", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "redaxios": "^0.5.1", diff --git a/examples/vue/basic-file-based-sfc/package.json b/examples/vue/basic-file-based-sfc/package.json index 5508bb500c..786e63d79c 100644 --- a/examples/vue/basic-file-based-sfc/package.json +++ b/examples/vue/basic-file-based-sfc/package.json @@ -10,8 +10,8 @@ }, "dependencies": { "@tailwindcss/vite": "^4.2.2", - "@tanstack/router-plugin": "^1.168.5", - "@tanstack/vue-router": "^1.170.3", + "@tanstack/router-plugin": "^1.168.6", + "@tanstack/vue-router": "^1.170.4", "@tanstack/vue-router-devtools": "^1.167.0", "@tanstack/zod-adapter": "^1.167.0", "redaxios": "^0.5.1", diff --git a/examples/vue/basic/package.json b/examples/vue/basic/package.json index fc8df0e7e1..932cd66a8b 100644 --- a/examples/vue/basic/package.json +++ b/examples/vue/basic/package.json @@ -9,7 +9,7 @@ "start": "vite" }, "dependencies": { - "@tanstack/vue-router": "^1.170.3", + "@tanstack/vue-router": "^1.170.4", "@tanstack/vue-router-devtools": "^1.167.0", "redaxios": "^0.5.1", "vue": "^3.5.13", diff --git a/packages/react-router/CHANGELOG.md b/packages/react-router/CHANGELOG.md index c402caad88..7372b9cbd4 100644 --- a/packages/react-router/CHANGELOG.md +++ b/packages/react-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/react-router +## 1.170.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + ## 1.170.3 ### Patch Changes diff --git a/packages/react-router/package.json b/packages/react-router/package.json index f2ecb396ff..a062a7759b 100644 --- a/packages/react-router/package.json +++ b/packages/react-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-router", - "version": "1.170.3", + "version": "1.170.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-client/CHANGELOG.md b/packages/react-start-client/CHANGELOG.md index 1ef52d2724..316c62b29e 100644 --- a/packages/react-start-client/CHANGELOG.md +++ b/packages/react-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/react-start-client +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/react-router@1.170.4 + - @tanstack/start-client-core@1.169.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/react-start-client/package.json b/packages/react-start-client/package.json index 85362ffce0..0e2129bb01 100644 --- a/packages/react-start-client/package.json +++ b/packages/react-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-client", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-rsc/CHANGELOG.md b/packages/react-start-rsc/CHANGELOG.md index a458f2722d..1c4878fb35 100644 --- a/packages/react-start-rsc/CHANGELOG.md +++ b/packages/react-start-rsc/CHANGELOG.md @@ -1,5 +1,18 @@ # @tanstack/react-start-rsc +## 0.1.6 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/react-router@1.170.4 + - @tanstack/react-start-server@1.167.4 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-plugin-core@1.170.6 + - @tanstack/start-server-core@1.168.4 + - @tanstack/start-storage-context@1.167.4 + ## 0.1.5 ### Patch Changes diff --git a/packages/react-start-rsc/package.json b/packages/react-start-rsc/package.json index fa8509f910..aab95940e8 100644 --- a/packages/react-start-rsc/package.json +++ b/packages/react-start-rsc/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-rsc", - "version": "0.1.5", + "version": "0.1.6", "description": "React Server Components support for TanStack Start", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start-server/CHANGELOG.md b/packages/react-start-server/CHANGELOG.md index 13407d8042..aa76b3c1ce 100644 --- a/packages/react-start-server/CHANGELOG.md +++ b/packages/react-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/react-start-server +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/react-router@1.170.4 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-server-core@1.168.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/react-start-server/package.json b/packages/react-start-server/package.json index 4b776ce84f..fd1ef11b52 100644 --- a/packages/react-start-server/package.json +++ b/packages/react-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start-server", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/react-start/CHANGELOG.md b/packages/react-start/CHANGELOG.md index 4e5add189b..0259ded387 100644 --- a/packages/react-start/CHANGELOG.md +++ b/packages/react-start/CHANGELOG.md @@ -1,5 +1,18 @@ # @tanstack/react-start +## 1.168.6 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/react-router@1.170.4 + - @tanstack/react-start-client@1.167.4 + - @tanstack/react-start-rsc@0.1.6 + - @tanstack/react-start-server@1.167.4 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-plugin-core@1.170.6 + - @tanstack/start-server-core@1.168.4 + ## 1.168.5 ### Patch Changes diff --git a/packages/react-start/package.json b/packages/react-start/package.json index b4b9e24225..8f1ca3ba1a 100644 --- a/packages/react-start/package.json +++ b/packages/react-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/react-start", - "version": "1.168.5", + "version": "1.168.6", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-cli/CHANGELOG.md b/packages/router-cli/CHANGELOG.md index 32c5166063..be1e6d470a 100644 --- a/packages/router-cli/CHANGELOG.md +++ b/packages/router-cli/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-cli +## 1.167.5 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-generator@1.167.5 + ## 1.167.4 ### Patch Changes diff --git a/packages/router-cli/package.json b/packages/router-cli/package.json index 81e27c88cb..f2bb9df5b4 100644 --- a/packages/router-cli/package.json +++ b/packages/router-cli/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-cli", - "version": "1.167.4", + "version": "1.167.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-core/CHANGELOG.md b/packages/router-core/CHANGELOG.md index 6ccfbcd375..d0a514537f 100644 --- a/packages/router-core/CHANGELOG.md +++ b/packages/router-core/CHANGELOG.md @@ -1,5 +1,11 @@ # @tanstack/router-core +## 1.171.2 + +### Patch Changes + +- Fix route mismatch warnings, HMR route index refresh, and generated route type preferences for duplicate pathless/index routes. ([#7422](https://github.com/TanStack/router/pull/7422)) + ## 1.171.1 ### Patch Changes diff --git a/packages/router-core/package.json b/packages/router-core/package.json index 10c21bf674..1bc9863a87 100644 --- a/packages/router-core/package.json +++ b/packages/router-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-core", - "version": "1.171.1", + "version": "1.171.2", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-generator/CHANGELOG.md b/packages/router-generator/CHANGELOG.md index 8b10112aa2..160c7d4ec3 100644 --- a/packages/router-generator/CHANGELOG.md +++ b/packages/router-generator/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/router-generator +## 1.167.5 + +### Patch Changes + +- Fix route mismatch warnings, HMR route index refresh, and generated route type preferences for duplicate pathless/index routes. ([#7422](https://github.com/TanStack/router/pull/7422)) + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + ## 1.167.4 ### Patch Changes diff --git a/packages/router-generator/package.json b/packages/router-generator/package.json index aa56873077..22a3a1e0da 100644 --- a/packages/router-generator/package.json +++ b/packages/router-generator/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-generator", - "version": "1.167.4", + "version": "1.167.5", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-plugin/CHANGELOG.md b/packages/router-plugin/CHANGELOG.md index a7332cce22..2add549cfa 100644 --- a/packages/router-plugin/CHANGELOG.md +++ b/packages/router-plugin/CHANGELOG.md @@ -1,5 +1,16 @@ # @tanstack/router-plugin +## 1.168.6 + +### Patch Changes + +- Fix route mismatch warnings, HMR route index refresh, and generated route type preferences for duplicate pathless/index routes. ([#7422](https://github.com/TanStack/router/pull/7422)) + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/router-generator@1.167.5 + - @tanstack/react-router@1.170.4 + ## 1.168.5 ### Patch Changes diff --git a/packages/router-plugin/package.json b/packages/router-plugin/package.json index 12eaa573dd..62b68caa75 100644 --- a/packages/router-plugin/package.json +++ b/packages/router-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-plugin", - "version": "1.168.5", + "version": "1.168.6", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/router-vite-plugin/CHANGELOG.md b/packages/router-vite-plugin/CHANGELOG.md index 0fa46effbc..a8cf8e6f20 100644 --- a/packages/router-vite-plugin/CHANGELOG.md +++ b/packages/router-vite-plugin/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/router-vite-plugin +## 1.167.6 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-plugin@1.168.6 + ## 1.167.5 ### Patch Changes diff --git a/packages/router-vite-plugin/package.json b/packages/router-vite-plugin/package.json index 532290a7ad..a1ceaffb00 100644 --- a/packages/router-vite-plugin/package.json +++ b/packages/router-vite-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/router-vite-plugin", - "version": "1.167.5", + "version": "1.167.6", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-router/CHANGELOG.md b/packages/solid-router/CHANGELOG.md index 619424a6d2..a49a3b0d4c 100644 --- a/packages/solid-router/CHANGELOG.md +++ b/packages/solid-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/solid-router +## 1.170.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + ## 1.170.3 ### Patch Changes diff --git a/packages/solid-router/package.json b/packages/solid-router/package.json index 378a0134d1..2cf30bfb1b 100644 --- a/packages/solid-router/package.json +++ b/packages/solid-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-router", - "version": "1.170.3", + "version": "1.170.4", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start-client/CHANGELOG.md b/packages/solid-start-client/CHANGELOG.md index f2d7c12550..4aada0a5c8 100644 --- a/packages/solid-start-client/CHANGELOG.md +++ b/packages/solid-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/solid-start-client +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/solid-router@1.170.4 + - @tanstack/start-client-core@1.169.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/solid-start-client/package.json b/packages/solid-start-client/package.json index f3eb7b36d4..7bcb2876cd 100644 --- a/packages/solid-start-client/package.json +++ b/packages/solid-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start-client", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start-server/CHANGELOG.md b/packages/solid-start-server/CHANGELOG.md index 0c2b03d1f3..33be473353 100644 --- a/packages/solid-start-server/CHANGELOG.md +++ b/packages/solid-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/solid-start-server +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/solid-router@1.170.4 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-server-core@1.168.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/solid-start-server/package.json b/packages/solid-start-server/package.json index 4c50256d81..28c651c8c8 100644 --- a/packages/solid-start-server/package.json +++ b/packages/solid-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start-server", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/solid-start/CHANGELOG.md b/packages/solid-start/CHANGELOG.md index 968aaf8d91..98440a6cf2 100644 --- a/packages/solid-start/CHANGELOG.md +++ b/packages/solid-start/CHANGELOG.md @@ -1,5 +1,17 @@ # @tanstack/solid-start +## 1.168.6 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/solid-router@1.170.4 + - @tanstack/solid-start-client@1.167.4 + - @tanstack/solid-start-server@1.167.4 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-plugin-core@1.170.6 + - @tanstack/start-server-core@1.168.4 + ## 1.168.5 ### Patch Changes diff --git a/packages/solid-start/package.json b/packages/solid-start/package.json index e903f5256f..de2ecd1c22 100644 --- a/packages/solid-start/package.json +++ b/packages/solid-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/solid-start", - "version": "1.168.5", + "version": "1.168.6", "description": "Modern and scalable routing for Solid applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-client-core/CHANGELOG.md b/packages/start-client-core/CHANGELOG.md index aaeaa020c7..0eb85be315 100644 --- a/packages/start-client-core/CHANGELOG.md +++ b/packages/start-client-core/CHANGELOG.md @@ -1,5 +1,13 @@ # @tanstack/start-client-core +## 1.169.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/start-storage-context@1.167.4 + ## 1.169.3 ### Patch Changes diff --git a/packages/start-client-core/package.json b/packages/start-client-core/package.json index c593f6496a..811c106ee2 100644 --- a/packages/start-client-core/package.json +++ b/packages/start-client-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-client-core", - "version": "1.169.3", + "version": "1.169.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-plugin-core/CHANGELOG.md b/packages/start-plugin-core/CHANGELOG.md index 86dfaf3043..809e6893ea 100644 --- a/packages/start-plugin-core/CHANGELOG.md +++ b/packages/start-plugin-core/CHANGELOG.md @@ -1,5 +1,16 @@ # @tanstack/start-plugin-core +## 1.170.6 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/router-generator@1.167.5 + - @tanstack/router-plugin@1.168.6 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-server-core@1.168.4 + ## 1.170.5 ### Patch Changes diff --git a/packages/start-plugin-core/package.json b/packages/start-plugin-core/package.json index 8fe6467cfe..e07e89fb03 100644 --- a/packages/start-plugin-core/package.json +++ b/packages/start-plugin-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-plugin-core", - "version": "1.170.5", + "version": "1.170.6", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-server-core/CHANGELOG.md b/packages/start-server-core/CHANGELOG.md index a7c4ce0220..a7ffaf327e 100644 --- a/packages/start-server-core/CHANGELOG.md +++ b/packages/start-server-core/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/start-server-core +## 1.168.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-storage-context@1.167.4 + ## 1.168.3 ### Patch Changes diff --git a/packages/start-server-core/package.json b/packages/start-server-core/package.json index 355f01de36..f292700c40 100644 --- a/packages/start-server-core/package.json +++ b/packages/start-server-core/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-server-core", - "version": "1.168.3", + "version": "1.168.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-static-server-functions/CHANGELOG.md b/packages/start-static-server-functions/CHANGELOG.md index 0b9e11b808..dcd0bad393 100644 --- a/packages/start-static-server-functions/CHANGELOG.md +++ b/packages/start-static-server-functions/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/start-static-server-functions +## 1.167.4 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-client-core@1.169.4 + - @tanstack/react-start@1.168.6 + - @tanstack/solid-start@1.168.6 + ## 1.167.3 ### Patch Changes diff --git a/packages/start-static-server-functions/package.json b/packages/start-static-server-functions/package.json index 608302a1f4..1aadad3740 100644 --- a/packages/start-static-server-functions/package.json +++ b/packages/start-static-server-functions/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-static-server-functions", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/start-storage-context/CHANGELOG.md b/packages/start-storage-context/CHANGELOG.md index 8d3a8216c7..881ed8e207 100644 --- a/packages/start-storage-context/CHANGELOG.md +++ b/packages/start-storage-context/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/start-storage-context +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + ## 1.167.3 ### Patch Changes diff --git a/packages/start-storage-context/package.json b/packages/start-storage-context/package.json index bc98121ae8..0e7543908a 100644 --- a/packages/start-storage-context/package.json +++ b/packages/start-storage-context/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/start-storage-context", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for React applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-router/CHANGELOG.md b/packages/vue-router/CHANGELOG.md index 54925b20a7..4a5216057e 100644 --- a/packages/vue-router/CHANGELOG.md +++ b/packages/vue-router/CHANGELOG.md @@ -1,5 +1,12 @@ # @tanstack/vue-router +## 1.170.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + ## 1.170.3 ### Patch Changes diff --git a/packages/vue-router/package.json b/packages/vue-router/package.json index eb737a011b..92caaec54e 100644 --- a/packages/vue-router/package.json +++ b/packages/vue-router/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-router", - "version": "1.170.3", + "version": "1.170.4", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start-client/CHANGELOG.md b/packages/vue-start-client/CHANGELOG.md index 8d501931d7..715f8db0fe 100644 --- a/packages/vue-start-client/CHANGELOG.md +++ b/packages/vue-start-client/CHANGELOG.md @@ -1,5 +1,14 @@ # @tanstack/vue-start-client +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/start-client-core@1.169.4 + - @tanstack/vue-router@1.170.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/vue-start-client/package.json b/packages/vue-start-client/package.json index 6968c2f1f2..e6ffeeeb1c 100644 --- a/packages/vue-start-client/package.json +++ b/packages/vue-start-client/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start-client", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start-server/CHANGELOG.md b/packages/vue-start-server/CHANGELOG.md index e4d42599f4..7507d52652 100644 --- a/packages/vue-start-server/CHANGELOG.md +++ b/packages/vue-start-server/CHANGELOG.md @@ -1,5 +1,15 @@ # @tanstack/vue-start-server +## 1.167.4 + +### Patch Changes + +- Updated dependencies [[`b60eb36`](https://github.com/TanStack/router/commit/b60eb36e59e8a468ee0742cbcf7f47aca1ff1c67)]: + - @tanstack/router-core@1.171.2 + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-server-core@1.168.4 + - @tanstack/vue-router@1.170.4 + ## 1.167.3 ### Patch Changes diff --git a/packages/vue-start-server/package.json b/packages/vue-start-server/package.json index 687db38892..3e21494038 100644 --- a/packages/vue-start-server/package.json +++ b/packages/vue-start-server/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start-server", - "version": "1.167.3", + "version": "1.167.4", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/packages/vue-start/CHANGELOG.md b/packages/vue-start/CHANGELOG.md index c3d7197cea..95fd3a9cca 100644 --- a/packages/vue-start/CHANGELOG.md +++ b/packages/vue-start/CHANGELOG.md @@ -1,5 +1,17 @@ # @tanstack/vue-start +## 1.168.6 + +### Patch Changes + +- Updated dependencies []: + - @tanstack/start-client-core@1.169.4 + - @tanstack/start-plugin-core@1.170.6 + - @tanstack/start-server-core@1.168.4 + - @tanstack/vue-router@1.170.4 + - @tanstack/vue-start-client@1.167.4 + - @tanstack/vue-start-server@1.167.4 + ## 1.168.5 ### Patch Changes diff --git a/packages/vue-start/package.json b/packages/vue-start/package.json index aa63e7adf7..e9a6bffa03 100644 --- a/packages/vue-start/package.json +++ b/packages/vue-start/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack/vue-start", - "version": "1.168.5", + "version": "1.168.6", "description": "Modern and scalable routing for Vue applications", "author": "Tanner Linsley", "license": "MIT", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f6ead91017..0823c60b4a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -10016,7 +10016,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10053,7 +10053,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10093,7 +10093,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10133,7 +10133,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10167,7 +10167,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10198,7 +10198,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10235,7 +10235,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10278,7 +10278,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10318,7 +10318,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10355,7 +10355,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router compression: specifier: ^1.8.0 @@ -10395,7 +10395,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10450,7 +10450,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10490,7 +10490,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10527,7 +10527,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10564,7 +10564,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router solid-js: specifier: 1.9.12 @@ -10595,7 +10595,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10632,7 +10632,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10678,7 +10678,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10724,7 +10724,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10767,7 +10767,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10804,7 +10804,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10838,7 +10838,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10869,7 +10869,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10897,7 +10897,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10928,7 +10928,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10965,7 +10965,7 @@ importers: specifier: ^4.2.2 version: 4.2.2 '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -10999,7 +10999,7 @@ importers: examples/solid/quickstart-webpack-file-based: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11060,7 +11060,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11094,7 +11094,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11134,7 +11134,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11168,7 +11168,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11208,7 +11208,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11254,7 +11254,7 @@ importers: examples/solid/start-basic: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11306,7 +11306,7 @@ importers: specifier: ^7.0.0 version: 7.0.0(prisma@7.0.0(@types/react@19.2.9)(react-dom@19.2.3(react@19.2.3))(react@19.2.3)(typescript@6.0.2))(typescript@6.0.2) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11355,7 +11355,7 @@ importers: specifier: ^0.41.1 version: 0.41.1 '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11395,7 +11395,7 @@ importers: examples/solid/start-basic-cloudflare: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11435,7 +11435,7 @@ importers: examples/solid/start-basic-netlify: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11472,7 +11472,7 @@ importers: examples/solid/start-basic-nitro: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11515,7 +11515,7 @@ importers: specifier: ^5.90.0 version: 5.90.4(@tanstack/solid-query@5.99.0(solid-js@1.9.12))(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11558,7 +11558,7 @@ importers: examples/solid/start-basic-static: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11610,7 +11610,7 @@ importers: specifier: ^0.7.0 version: 0.7.14(csstype@3.2.3)(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11674,7 +11674,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11729,7 +11729,7 @@ importers: examples/solid/start-counter: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11772,7 +11772,7 @@ importers: specifier: ^0.7.0 version: 0.7.14(csstype@3.2.3)(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11812,7 +11812,7 @@ importers: specifier: ^5.99.0 version: 5.99.0(solid-js@1.9.12) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11855,7 +11855,7 @@ importers: examples/solid/start-streaming-data-from-server-functions: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11892,7 +11892,7 @@ importers: specifier: ^2.48.1 version: 2.48.1 '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11929,7 +11929,7 @@ importers: examples/solid/start-tailwind-v4: dependencies: '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -11975,7 +11975,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -12009,7 +12009,7 @@ importers: specifier: ^4.2.2 version: 4.2.2(vite@8.0.0(@emnapi/core@1.10.0)(@emnapi/runtime@1.10.0)(@types/node@25.0.9)(esbuild@0.27.4)(jiti@2.7.0)(sass@1.97.2)(terser@5.37.0)(tsx@4.20.3)(yaml@2.8.1)) '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ @@ -12049,7 +12049,7 @@ importers: specifier: workspace:* version: link:../../../packages/router-plugin '@tanstack/solid-router': - specifier: ^1.170.3 + specifier: ^1.170.4 version: link:../../../packages/solid-router '@tanstack/solid-router-devtools': specifier: workspace:^ From 86b5ca062e7af2cee8e4008e05034676833e8263 Mon Sep 17 00:00:00 2001 From: Flo Date: Sun, 17 May 2026 15:29:14 +0200 Subject: [PATCH 007/471] security: stricter pnpm config blockExoticSubdeps & trustPolicy (#7425) --- pnpm-workspace.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index b5d1a21961..25cba27b56 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,6 +1,8 @@ cleanupUnusedCatalogs: true linkWorkspacePackages: true preferWorkspacePackages: true +blockExoticSubdeps: true +trustPolicy: 'no-downgrade' packages: - 'packages/*' From 2506478fa81f8603eb69d7ce4b17d3280dececfb Mon Sep 17 00:00:00 2001 From: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com> Date: Mon, 18 May 2026 10:29:25 +1200 Subject: [PATCH 008/471] docs(start): use router package for module declaration to type the request context (#7427) --- docs/start/framework/react/guide/server-entry-point.md | 4 ++-- docs/start/framework/solid/guide/server-entry-point.md | 6 +++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/start/framework/react/guide/server-entry-point.md b/docs/start/framework/react/guide/server-entry-point.md index 90d6b2270c..5acc8ee550 100644 --- a/docs/start/framework/react/guide/server-entry-point.md +++ b/docs/start/framework/react/guide/server-entry-point.md @@ -64,7 +64,7 @@ export default createServerEntry({ When your server needs to pass additional, typed data into request handlers (for example, authenticated user info, a database connection, or per-request flags), register a request context type via TypeScript module augmentation. The registered context is delivered as the second argument to the server `fetch` handler and is available throughout the server-side middleware chain — including global middleware, request/function middleware, server routes, server functions, and the router itself. -To add types for your request context, augment the `Register` interface from `@tanstack/react-start` with a `server.requestContext` property. The runtime `context` you pass to `handler.fetch` will then match that type. Example: +To add types for your request context, augment the `Register` interface from `@tanstack/react-router` with a `server.requestContext` property. The runtime `context` you pass to `handler.fetch` will then match that type. Example: ```tsx import handler, { createServerEntry } from '@tanstack/react-start/server-entry' @@ -74,7 +74,7 @@ type MyRequestContext = { foo: number } -declare module '@tanstack/react-start' { +declare module '@tanstack/react-router' { interface Register { server: { requestContext: MyRequestContext diff --git a/docs/start/framework/solid/guide/server-entry-point.md b/docs/start/framework/solid/guide/server-entry-point.md index ef261fe9b6..80c226eaae 100644 --- a/docs/start/framework/solid/guide/server-entry-point.md +++ b/docs/start/framework/solid/guide/server-entry-point.md @@ -1,5 +1,9 @@ --- ref: docs/start/framework/react/guide/server-entry-point.md replace: - { '@tanstack/react-start': '@tanstack/solid-start', 'React': 'SolidJS' } + { + '@tanstack/react-start': '@tanstack/solid-start', + '@tanstack/react-router': '@tanstack/solid-router', + 'React': 'SolidJS', + } --- From 5fa9e555f3a2edb5e45586623e6bcbfa7f7c7a6b Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Tue, 19 May 2026 18:43:00 +0200 Subject: [PATCH 009/471] feat: deferred hydration (#7362) * feat: deferred hydration * fix * tests * solid tests * Changes before error encountered Agent-Logs-Url: https://github.com/TanStack/router/sessions/5263c469-75c2-4470-bd4c-86f9b43964f4 Co-authored-by: schiller-manuel <6340397+schiller-manuel@users.noreply.github.com> * chore: address hydration review follow-ups Agent-Logs-Url: https://github.com/TanStack/router/sessions/16e27113-ff01-4de8-aded-b9be9f6dd4ff Co-authored-by: schiller-manuel <6340397+schiller-manuel@users.noreply.github.com> * fix(start-client-core): correct import order in hydrateStart.ts Co-authored-by: schiller-manuel * chore: remove tracked nx self-healing artifacts Agent-Logs-Url: https://github.com/TanStack/router/sessions/95750760-1348-437c-8f73-cc45e899003a Co-authored-by: schiller-manuel <6340397+schiller-manuel@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: schiller-manuel <6340397+schiller-manuel@users.noreply.github.com> Co-authored-by: nx-cloud[bot] <71083854+nx-cloud[bot]@users.noreply.github.com> Co-authored-by: schiller-manuel --- .changeset/deferred-hydration-start.md | 16 + benchmarks/bundle-size/README.md | 1 + .../src/router.tsx | 9 + .../src/routes/__root.tsx | 24 + .../src/routes/index.tsx | 15 + .../vite.config.ts | 7 + .../src/router.tsx | 9 + .../src/routes/__root.tsx | 24 + .../src/routes/index.tsx | 15 + .../vite.config.ts | 7 + docs/start/config.json | 8 + .../react/guide/deferred-hydration.md | 701 +++++++++++ .../solid/guide/deferred-hydration.md | 12 + e2e/e2e-utils/src/hmrFileEditor.ts | 127 ++ e2e/e2e-utils/src/index.ts | 2 + e2e/react-start/deferred-hydration/.gitignore | 15 + .../deferred-hydration/package.json | 60 + .../deferred-hydration/playwright.config.ts | 52 + .../deferred-hydration/rsbuild.config.ts | 14 + .../deferred-hydration/src/routeTree.gen.ts | 177 +++ .../deferred-hydration/src/router.tsx | 9 + .../deferred-hydration/src/routes/__root.tsx | 180 +++ .../src/routes/components.tsx | 179 +++ .../deferred-hydration/src/routes/css.tsx | 57 + .../src/routes/css/deferred-only.module.css | 15 + .../src/routes/css/outer.module.css | 9 + .../src/routes/css/shared.module.css | 4 + .../src/routes/enhanced.tsx | 339 ++++++ .../src/routes/imported.tsx | 15 + .../deferred-hydration/src/routes/index.tsx | 23 + .../src/routes/scroll-restoration.tsx | 93 ++ .../src/shared/EnhancedNestedWidget.tsx | 33 + .../src/shared/ImportedHydrateWidget.tsx | 39 + .../tests/hydration.spec.ts | 1028 ++++++++++++++++ .../tests/setup/global.setup.ts | 38 + .../tests/setup/global.teardown.ts | 13 + .../deferred-hydration/tsconfig.json | 21 + .../deferred-hydration/vite.config.ts | 14 + e2e/react-start/hmr/tests/app.spec.ts | 92 +- .../rsc-deferred-hydration/.gitignore | 5 + .../rsc-deferred-hydration/package.json | 45 + .../playwright.config.ts | 35 + .../rsc-deferred-hydration/server.js | 47 + .../components/CssHydrateIsland.module.css | 42 + .../src/components/CssHydrateIsland.tsx | 45 + .../src/components/DeferredHydrateIsland.tsx | 67 ++ .../src/routeTree.gen.ts | 122 ++ .../rsc-deferred-hydration/src/router.tsx | 9 + .../src/routes/__root.tsx | 122 ++ .../src/routes/composite.tsx | 24 + .../rsc-deferred-hydration/src/routes/css.tsx | 14 + .../src/routes/index.tsx | 35 + .../src/routes/server-client.tsx | 14 + .../src/server/serverHydrateComponents.tsx | 35 + .../src/server/serverHydrateContent.tsx | 63 + .../tests/hydration.spec.ts | 82 ++ .../tests/setup/global.setup.ts | 28 + .../tests/setup/global.teardown.ts | 6 + .../rsc-deferred-hydration/tsconfig.json | 21 + .../rsc-deferred-hydration/vite.config.ts | 25 + e2e/solid-start/deferred-hydration/.gitignore | 15 + .../deferred-hydration/package.json | 56 + .../deferred-hydration/playwright.config.ts | 43 + .../deferred-hydration/rsbuild.config.ts | 21 + .../deferred-hydration/src/routeTree.gen.ts | 140 +++ .../deferred-hydration/src/router.tsx | 9 + .../deferred-hydration/src/routes/__root.tsx | 98 ++ .../src/routes/components.tsx | 171 +++ .../deferred-hydration/src/routes/css.tsx | 57 + .../src/routes/css/deferred-only.module.css | 15 + .../src/routes/css/outer.module.css | 9 + .../src/routes/css/shared.module.css | 4 + .../src/routes/enhanced.tsx | 316 +++++ .../src/routes/imported.tsx | 15 + .../deferred-hydration/src/routes/index.tsx | 23 + .../src/shared/EnhancedNestedWidget.tsx | 33 + .../src/shared/ImportedHydrateWidget.tsx | 34 + .../tests/hydration.spec.ts | 909 +++++++++++++++ .../deferred-hydration/tsconfig.json | 23 + .../deferred-hydration/vite.config.ts | 14 + packages/react-router/src/index.tsx | 1 + packages/react-start-client/package.json | 6 + .../react-start-client/src/GenericHydrate.tsx | 436 +++++++ packages/react-start-client/src/Hydrate.tsx | 107 ++ packages/react-start-client/src/hydration.ts | 22 + .../src/hydration/generic.ts | 43 + .../react-start-client/src/hydration/idle.ts | 22 + .../react-start-client/src/hydration/load.tsx | 49 + .../src/hydration/never.tsx | 97 ++ .../src/hydration/visible.tsx | 139 +++ packages/react-start-client/src/index.tsx | 16 + .../src/tests/Hydrate.test-d.tsx | 147 +++ .../src/tests/Hydrate.test.tsx | 676 +++++++++++ packages/react-start-client/vite.config.ts | 2 +- packages/react-start/package.json | 6 + packages/react-start/src/hydration.ts | 18 + packages/react-start/src/index.ts | 11 + packages/react-start/vite.config.ts | 1 + packages/router-core/src/index.ts | 1 + packages/router-core/src/ssr/ssr-server.ts | 20 +- .../src/core/code-splitter/compilers.ts | 462 +------- .../src/core/code-splitter/plugins.ts | 3 + packages/router-plugin/src/core/config.ts | 7 + .../src/core/router-code-splitter-plugin.ts | 16 +- packages/router-plugin/src/index.ts | 5 + .../router-plugin/tests/code-splitter.test.ts | 2 +- packages/router-utils/src/compiler-helpers.ts | 843 ++++++++++++++ packages/router-utils/src/index.ts | 21 + .../src}/path-ids.ts | 0 .../tests/compiler-helpers.test.ts | 249 ++++ .../tests/stripTypeExports.test.ts | 14 +- packages/solid-router/src/ClientOnly.tsx | 7 +- packages/solid-start-client/package.json | 6 + .../solid-start-client/src/GenericHydrate.tsx | 376 ++++++ packages/solid-start-client/src/Hydrate.tsx | 75 ++ packages/solid-start-client/src/hydration.ts | 20 + .../src/hydration/generic.ts | 41 + .../solid-start-client/src/hydration/idle.ts | 20 + .../solid-start-client/src/hydration/load.tsx | 13 + .../solid-start-client/src/hydration/never.ts | 11 + .../src/hydration/visible.tsx | 21 + packages/solid-start-client/src/index.tsx | 14 + .../src/tests/Hydrate.test-d.tsx | 147 +++ packages/solid-start-client/vite.config.ts | 2 +- packages/solid-start/package.json | 6 + packages/solid-start/src/hydration.ts | 18 + packages/solid-start/src/index.ts | 10 + packages/solid-start/vite.config.ts | 1 + packages/start-client-core/package.json | 21 + .../src/client/hydrateStart.ts | 50 +- packages/start-client-core/src/hydration.ts | 50 + .../src/hydration/condition.ts | 20 + .../src/hydration/constants.ts | 4 + .../start-client-core/src/hydration/idle.ts | 35 + .../src/hydration/interaction.ts | 342 ++++++ .../start-client-core/src/hydration/load.ts | 16 + .../start-client-core/src/hydration/media.ts | 25 + .../start-client-core/src/hydration/never.ts | 13 + .../src/hydration/renderer.ts | 21 + .../src/hydration/runtime.ts | 191 +++ .../start-client-core/src/hydration/types.ts | 90 ++ .../src/hydration/visible.ts | 90 ++ packages/start-client-core/vite.config.ts | 67 +- .../src/hydrate-when-transform.ts | 1004 ++++++++++++++++ .../src/hydration-constants.ts | 1 + .../src/rsbuild/normalized-client-build.ts | 36 + .../src/rsbuild/start-compiler-host.ts | 64 +- .../src/start-compiler/compiler.ts | 1030 +++++++++-------- .../src/start-compiler/config.ts | 9 + .../src/start-compiler/host.ts | 46 + .../start-manifest-plugin/manifestBuilder.ts | 73 ++ packages/start-plugin-core/src/types.ts | 32 + .../src/vite/start-compiler-plugin/plugin.ts | 196 +++- .../normalized-client-build.ts | 37 + .../start-plugin-core/tests/compiler.test.ts | 70 ++ .../tests/hydrate-when-transform.test.ts | 618 ++++++++++ .../error-files/hydrateWhenFunctionChild.tsx | 6 + .../error-files/hydrateWhenHookCall.tsx | 14 + .../error-files/hydrateWhenSuperCapture.tsx | 16 + .../error-files/hydrateWhenThisCapture.tsx | 14 + .../tests/hydrateWhen/hydrateWhen.test.ts | 241 ++++ .../snapshots/client/hydrateWhenBasic.tsx | 18 + .../snapshots/client/hydrateWhenMultiple.tsx | 19 + .../snapshots/client/hydrateWhenNested.tsx | 16 + .../snapshots/client/hydrateWhenNever.tsx | 9 + .../snapshots/client/hydrateWhenNoImport.tsx | 1 + .../client/hydrateWhenNotFromTanstack.tsx | 1 + .../client/hydrateWhenObjectFallback.tsx | 26 + .../client/hydrateWhenPrefetchState.tsx | 19 + .../snapshots/client/hydrateWhenRenamed.tsx | 11 + .../client/hydrateWhenSplitFalse.tsx | 1 + .../hydrateWhenSplitFalseFunctionChild.tsx | 1 + .../client/hydrateWhenWrongImportName.tsx | 1 + .../snapshots/server/hydrateWhenBasic.tsx | 17 + .../snapshots/server/hydrateWhenMultiple.tsx | 24 + .../snapshots/server/hydrateWhenNested.tsx | 25 + .../snapshots/server/hydrateWhenNever.tsx | 10 + .../snapshots/server/hydrateWhenNoImport.tsx | 1 + .../server/hydrateWhenNotFromTanstack.tsx | 1 + .../server/hydrateWhenObjectFallback.tsx | 25 + .../server/hydrateWhenPrefetchState.tsx | 19 + .../snapshots/server/hydrateWhenRenamed.tsx | 12 + .../server/hydrateWhenSplitFalse.tsx | 10 + .../hydrateWhenSplitFalseFunctionChild.tsx | 1 + .../server/hydrateWhenWrongImportName.tsx | 1 + .../hydrateWhenNested.tsx.H0.client.tsx | 15 + .../virtual/hydrateWhenNested.tsx.H0.tsx | 16 + .../virtual/hydrateWhenNested.tsx.H2.tsx | 6 + .../test-files/hydrateWhenBasic.tsx | 20 + .../test-files/hydrateWhenMultiple.tsx | 30 + .../test-files/hydrateWhenNested.tsx | 32 + .../test-files/hydrateWhenNever.tsx | 14 + .../test-files/hydrateWhenNoImport.tsx | 7 + .../test-files/hydrateWhenNotFromTanstack.tsx | 10 + .../test-files/hydrateWhenObjectFallback.tsx | 35 + .../test-files/hydrateWhenPrefetchState.tsx | 27 + .../test-files/hydrateWhenRenamed.tsx | 14 + .../test-files/hydrateWhenSplitFalse.tsx | 16 + .../hydrateWhenSplitFalseFunctionChild.tsx | 10 + .../test-files/hydrateWhenWrongImportName.tsx | 9 + .../manifestBuilder.test.ts | 268 +++++ .../tests/vite-start-compiler-plugin.test.ts | 117 ++ packages/start-plugin-core/tsconfig.json | 6 +- pnpm-lock.yaml | 345 +++++- scripts/benchmarks/bundle-size/measure.mjs | 14 + 205 files changed, 15317 insertions(+), 1122 deletions(-) create mode 100644 .changeset/deferred-hydration-start.md create mode 100644 benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/router.tsx create mode 100644 benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/__root.tsx create mode 100644 benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/index.tsx create mode 100644 benchmarks/bundle-size/scenarios/react-start-deferred-hydration/vite.config.ts create mode 100644 benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/router.tsx create mode 100644 benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/__root.tsx create mode 100644 benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/index.tsx create mode 100644 benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/vite.config.ts create mode 100644 docs/start/framework/react/guide/deferred-hydration.md create mode 100644 docs/start/framework/solid/guide/deferred-hydration.md create mode 100644 e2e/e2e-utils/src/hmrFileEditor.ts create mode 100644 e2e/react-start/deferred-hydration/.gitignore create mode 100644 e2e/react-start/deferred-hydration/package.json create mode 100644 e2e/react-start/deferred-hydration/playwright.config.ts create mode 100644 e2e/react-start/deferred-hydration/rsbuild.config.ts create mode 100644 e2e/react-start/deferred-hydration/src/routeTree.gen.ts create mode 100644 e2e/react-start/deferred-hydration/src/router.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/__root.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/components.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/css.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/css/deferred-only.module.css create mode 100644 e2e/react-start/deferred-hydration/src/routes/css/outer.module.css create mode 100644 e2e/react-start/deferred-hydration/src/routes/css/shared.module.css create mode 100644 e2e/react-start/deferred-hydration/src/routes/enhanced.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/imported.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/index.tsx create mode 100644 e2e/react-start/deferred-hydration/src/routes/scroll-restoration.tsx create mode 100644 e2e/react-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx create mode 100644 e2e/react-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx create mode 100644 e2e/react-start/deferred-hydration/tests/hydration.spec.ts create mode 100644 e2e/react-start/deferred-hydration/tests/setup/global.setup.ts create mode 100644 e2e/react-start/deferred-hydration/tests/setup/global.teardown.ts create mode 100644 e2e/react-start/deferred-hydration/tsconfig.json create mode 100644 e2e/react-start/deferred-hydration/vite.config.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/.gitignore create mode 100644 e2e/react-start/rsc-deferred-hydration/package.json create mode 100644 e2e/react-start/rsc-deferred-hydration/playwright.config.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/server.js create mode 100644 e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.module.css create mode 100644 e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/components/DeferredHydrateIsland.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routeTree.gen.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/src/router.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routes/__root.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routes/composite.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routes/css.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routes/index.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/routes/server-client.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateComponents.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateContent.tsx create mode 100644 e2e/react-start/rsc-deferred-hydration/tests/hydration.spec.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/tests/setup/global.setup.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/tests/setup/global.teardown.ts create mode 100644 e2e/react-start/rsc-deferred-hydration/tsconfig.json create mode 100644 e2e/react-start/rsc-deferred-hydration/vite.config.ts create mode 100644 e2e/solid-start/deferred-hydration/.gitignore create mode 100644 e2e/solid-start/deferred-hydration/package.json create mode 100644 e2e/solid-start/deferred-hydration/playwright.config.ts create mode 100644 e2e/solid-start/deferred-hydration/rsbuild.config.ts create mode 100644 e2e/solid-start/deferred-hydration/src/routeTree.gen.ts create mode 100644 e2e/solid-start/deferred-hydration/src/router.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/__root.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/components.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/css.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/css/deferred-only.module.css create mode 100644 e2e/solid-start/deferred-hydration/src/routes/css/outer.module.css create mode 100644 e2e/solid-start/deferred-hydration/src/routes/css/shared.module.css create mode 100644 e2e/solid-start/deferred-hydration/src/routes/enhanced.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/imported.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/routes/index.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx create mode 100644 e2e/solid-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx create mode 100644 e2e/solid-start/deferred-hydration/tests/hydration.spec.ts create mode 100644 e2e/solid-start/deferred-hydration/tsconfig.json create mode 100644 e2e/solid-start/deferred-hydration/vite.config.ts create mode 100644 packages/react-start-client/src/GenericHydrate.tsx create mode 100644 packages/react-start-client/src/Hydrate.tsx create mode 100644 packages/react-start-client/src/hydration.ts create mode 100644 packages/react-start-client/src/hydration/generic.ts create mode 100644 packages/react-start-client/src/hydration/idle.ts create mode 100644 packages/react-start-client/src/hydration/load.tsx create mode 100644 packages/react-start-client/src/hydration/never.tsx create mode 100644 packages/react-start-client/src/hydration/visible.tsx create mode 100644 packages/react-start-client/src/tests/Hydrate.test-d.tsx create mode 100644 packages/react-start-client/src/tests/Hydrate.test.tsx create mode 100644 packages/react-start/src/hydration.ts create mode 100644 packages/router-utils/src/compiler-helpers.ts rename packages/{router-plugin/src/core/code-splitter => router-utils/src}/path-ids.ts (100%) create mode 100644 packages/router-utils/tests/compiler-helpers.test.ts create mode 100644 packages/solid-start-client/src/GenericHydrate.tsx create mode 100644 packages/solid-start-client/src/Hydrate.tsx create mode 100644 packages/solid-start-client/src/hydration.ts create mode 100644 packages/solid-start-client/src/hydration/generic.ts create mode 100644 packages/solid-start-client/src/hydration/idle.ts create mode 100644 packages/solid-start-client/src/hydration/load.tsx create mode 100644 packages/solid-start-client/src/hydration/never.ts create mode 100644 packages/solid-start-client/src/hydration/visible.tsx create mode 100644 packages/solid-start-client/src/tests/Hydrate.test-d.tsx create mode 100644 packages/solid-start/src/hydration.ts create mode 100644 packages/start-client-core/src/hydration.ts create mode 100644 packages/start-client-core/src/hydration/condition.ts create mode 100644 packages/start-client-core/src/hydration/constants.ts create mode 100644 packages/start-client-core/src/hydration/idle.ts create mode 100644 packages/start-client-core/src/hydration/interaction.ts create mode 100644 packages/start-client-core/src/hydration/load.ts create mode 100644 packages/start-client-core/src/hydration/media.ts create mode 100644 packages/start-client-core/src/hydration/never.ts create mode 100644 packages/start-client-core/src/hydration/renderer.ts create mode 100644 packages/start-client-core/src/hydration/runtime.ts create mode 100644 packages/start-client-core/src/hydration/types.ts create mode 100644 packages/start-client-core/src/hydration/visible.ts create mode 100644 packages/start-plugin-core/src/hydrate-when-transform.ts create mode 100644 packages/start-plugin-core/src/hydration-constants.ts create mode 100644 packages/start-plugin-core/tests/hydrate-when-transform.test.ts create mode 100644 packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenFunctionChild.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenHookCall.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenSuperCapture.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenThisCapture.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/hydrateWhen.test.ts create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenBasic.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenMultiple.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNested.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNever.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNoImport.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNotFromTanstack.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenObjectFallback.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenPrefetchState.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenRenamed.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalse.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalseFunctionChild.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenWrongImportName.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenBasic.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenMultiple.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenNested.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenNever.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenNoImport.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenNotFromTanstack.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenObjectFallback.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenPrefetchState.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenRenamed.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenSplitFalse.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenSplitFalseFunctionChild.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenWrongImportName.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/virtual/hydrateWhenNested.tsx.H0.client.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/virtual/hydrateWhenNested.tsx.H0.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/snapshots/virtual/hydrateWhenNested.tsx.H2.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenBasic.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenMultiple.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenNested.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenNever.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenNoImport.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenNotFromTanstack.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenObjectFallback.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenPrefetchState.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenRenamed.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenSplitFalse.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenSplitFalseFunctionChild.tsx create mode 100644 packages/start-plugin-core/tests/hydrateWhen/test-files/hydrateWhenWrongImportName.tsx diff --git a/.changeset/deferred-hydration-start.md b/.changeset/deferred-hydration-start.md new file mode 100644 index 0000000000..90d7680399 --- /dev/null +++ b/.changeset/deferred-hydration-start.md @@ -0,0 +1,16 @@ +--- +'@tanstack/react-start-client': minor +'@tanstack/solid-start-client': minor +'@tanstack/start-client-core': minor +'@tanstack/start-plugin-core': minor +'@tanstack/start-server-core': minor +'@tanstack/router-core': patch +'@tanstack/router-plugin': patch +'@tanstack/router-utils': patch +--- + +Add deferred Hydrate boundary support for TanStack Start. + +Hydrate boundaries can now be code-split by the Start compiler, preload their generated client chunks, preserve server-rendered fallback HTML, and replay interaction-triggered events after hydration. The compiler integration now uses a Start-owned compiler plugin for Hydrate virtual modules across Vite and Rsbuild, with dev invalidation for generated virtual modules. + +Shared AST utilities used by the router code-splitter and Hydrate virtual modules were moved into `@tanstack/router-utils` so both pipelines can retain referenced top-level declarations, unwrap local exports, and let dead-code elimination remove unused route module code. diff --git a/benchmarks/bundle-size/README.md b/benchmarks/bundle-size/README.md index ba3095f0ae..f222b8088b 100644 --- a/benchmarks/bundle-size/README.md +++ b/benchmarks/bundle-size/README.md @@ -13,6 +13,7 @@ Each package has `minimal` and `full` scenarios: - `minimal`: Small route app with `__root` + index route that renders `hello world` - `full`: Same route shape plus a broad root-level harness that imports/uses the full hooks/components surface - Start `full` scenarios also exercise `createServerFn`, `createMiddleware`, and `useServerFn` +- Start `deferred-hydration` scenarios match the minimal route shape and wrap the index route content in `Hydrate` ## Design Notes diff --git a/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/router.tsx b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/router.tsx new file mode 100644 index 0000000000..9d87d8748b --- /dev/null +++ b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/router.tsx @@ -0,0 +1,9 @@ +import { createRouter } from '@tanstack/react-router' +import { routeTree } from './routeTree.gen' + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + }) +} diff --git a/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/__root.tsx b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/__root.tsx new file mode 100644 index 0000000000..ff1da4c304 --- /dev/null +++ b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/__root.tsx @@ -0,0 +1,24 @@ +import { + HeadContent, + Outlet, + Scripts, + createRootRoute, +} from '@tanstack/react-router' + +export const Route = createRootRoute({ + component: RootComponent, +}) + +function RootComponent() { + return ( + + + + + + + + + + ) +} diff --git a/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/index.tsx b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/index.tsx new file mode 100644 index 0000000000..a462508abd --- /dev/null +++ b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/src/routes/index.tsx @@ -0,0 +1,15 @@ +import { createFileRoute } from '@tanstack/react-router' +import { Hydrate } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' + +export const Route = createFileRoute('/')({ + component: IndexComponent, +}) + +function IndexComponent() { + return ( + +
hello world
+
+ ) +} diff --git a/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/vite.config.ts b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/vite.config.ts new file mode 100644 index 0000000000..d4e4cd980d --- /dev/null +++ b/benchmarks/bundle-size/scenarios/react-start-deferred-hydration/vite.config.ts @@ -0,0 +1,7 @@ +import { defineConfig } from 'vite' +import viteReact from '@vitejs/plugin-react' +import { tanstackStart } from '@tanstack/react-start/plugin/vite' + +export default defineConfig({ + plugins: [tanstackStart(), viteReact()], +}) diff --git a/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/router.tsx b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/router.tsx new file mode 100644 index 0000000000..aa7ead6752 --- /dev/null +++ b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/router.tsx @@ -0,0 +1,9 @@ +import { createRouter } from '@tanstack/solid-router' +import { routeTree } from './routeTree.gen' + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + }) +} diff --git a/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/__root.tsx b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/__root.tsx new file mode 100644 index 0000000000..e59de72236 --- /dev/null +++ b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/__root.tsx @@ -0,0 +1,24 @@ +import { + HeadContent, + Outlet, + Scripts, + createRootRoute, +} from '@tanstack/solid-router' + +export const Route = createRootRoute({ + component: RootComponent, +}) + +function RootComponent() { + return ( + + + + + + + + + + ) +} diff --git a/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/index.tsx b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/index.tsx new file mode 100644 index 0000000000..80362386b2 --- /dev/null +++ b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/src/routes/index.tsx @@ -0,0 +1,15 @@ +import { createFileRoute } from '@tanstack/solid-router' +import { Hydrate } from '@tanstack/solid-start' +import { visible } from '@tanstack/solid-start/hydration' + +export const Route = createFileRoute('/')({ + component: IndexComponent, +}) + +function IndexComponent() { + return ( + +
hello world
+
+ ) +} diff --git a/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/vite.config.ts b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/vite.config.ts new file mode 100644 index 0000000000..0bd21e64f4 --- /dev/null +++ b/benchmarks/bundle-size/scenarios/solid-start-deferred-hydration/vite.config.ts @@ -0,0 +1,7 @@ +import { defineConfig } from 'vite' +import solid from 'vite-plugin-solid' +import { tanstackStart } from '@tanstack/solid-start/plugin/vite' + +export default defineConfig({ + plugins: [tanstackStart(), solid({ ssr: true })], +}) diff --git a/docs/start/config.json b/docs/start/config.json index 8872178ce9..b5b0c8753f 100644 --- a/docs/start/config.json +++ b/docs/start/config.json @@ -117,6 +117,10 @@ "label": "Hydration Errors", "to": "framework/react/guide/hydration-errors" }, + { + "label": "Deferred Hydration", + "to": "framework/react/guide/deferred-hydration" + }, { "label": "Selective SSR", "to": "framework/react/guide/selective-ssr" @@ -246,6 +250,10 @@ "label": "Hydration Errors", "to": "framework/solid/guide/hydration-errors" }, + { + "label": "Deferred Hydration", + "to": "framework/solid/guide/deferred-hydration" + }, { "label": "Selective SSR", "to": "framework/solid/guide/selective-ssr" diff --git a/docs/start/framework/react/guide/deferred-hydration.md b/docs/start/framework/react/guide/deferred-hydration.md new file mode 100644 index 0000000000..a0420f0943 --- /dev/null +++ b/docs/start/framework/react/guide/deferred-hydration.md @@ -0,0 +1,701 @@ +--- +id: deferred-hydration +title: Deferred Hydration +--- + +> Deferred hydration is experimental + +On an initial page load, TanStack Start server-renders your page so the browser +can show useful HTML quickly. Hydration is the client-side work that turns that +initial HTML document into an interactive app. It loads and executes JavaScript, +runs components, attaches event handlers, and reconnects the existing DOM to +React. + +Deferred hydration applies to this initial document hydration work. After the +app is already running, subsequent client-side navigations render through the +client app; there is no initial server HTML for TanStack Start to preserve. + +By default, TanStack Start hydrates the full document. That is usually the +simplest and safest behavior, but large pages can spend meaningful startup time +loading JavaScript and hydrating parts of the page that the user may not need +right away. + +Deferred hydration lets you mark selected parts of a page as "not interactive +yet". The server HTML remains in the document, but TanStack Start waits to +hydrate that boundary until a strategy says it is time. By default, the compiler +also moves the boundary children into a separate JavaScript chunk so the browser +can delay loading that code too. + +Use deferred hydration when a part of the page should be visible, styled, and +indexable immediately, but does not need to be interactive immediately. + +## Add A Deferred Boundary + +Use `Hydrate` with a strategy from `@tanstack/react-start/hydration`: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' + +export function ProductPage() { + return ( + + + + ) +} +``` + +On the initial server response, `Reviews` is still rendered to HTML. During the +initial client hydration pass, that HTML is preserved but the `Reviews` React +tree does not hydrate yet. When the boundary comes within `400px` of the +viewport, TanStack Start loads the deferred child chunk and hydrates the +boundary. + +`Hydrate` only preserves server HTML that exists in the initial document. If the +same boundary first mounts later, for example after client-side navigation, +there is no server HTML to preserve, so it renders normally on the client. + +## Choose What To Defer + +The right boundary depends on your page, your product priorities, and real user +behavior. TanStack Start cannot know which parts of your page are safe to delay. + +Good candidates are usually SSR content that is not needed for immediate +interaction: + +- Below-the-fold reviews, comments, product details, related content, or long + marketing sections. +- Rich widgets such as maps, charts, carousels, video players, editors, or + embeds. +- Panels that are activated by intent, such as filters, preview panes, or + contextual tools. +- UI that only matters for a matching media query. +- Static server-rendered content that should not hydrate on the initial + document. + +Poor candidates are parts of the page users may need immediately: + +- Primary navigation, route chrome, search boxes, and account controls. +- Above-the-fold forms, add-to-cart buttons, checkout actions, or consent + controls. +- The interactive part of the LCP or hero area when users may click it + immediately. +- Accessibility-critical controls that must be keyboard-ready as soon as the + page appears. +- Components whose props, context, or shared state are expected to update + immediately after app startup. + +Measure each boundary. A useful boundary reduces startup JavaScript or hydration +work without making expected interactions feel late. + +## The Three Decisions + +Each `Hydrate` boundary has three performance decisions: + +| Decision | Option | What it controls | +| ----------- | ---------- | ------------------------------------------------------------------ | +| Hydration | `when` | When the preserved server HTML becomes interactive. | +| Code split | `split` | Whether the children move into a generated deferred child chunk. | +| Preparation | `prefetch` | Whether work starts before the `when` strategy hydrates the child. | + +### `when`: decide when the boundary hydrates + +`when` is required. Pass a strategy object for the common case: + +```tsx + + + +``` + +Pass a function when the decision needs browser-only information: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { interaction, visible } from '@tanstack/react-start/hydration' + +export function RecommendationsBoundary() { + return ( + + navigator.connection?.saveData + ? interaction({ events: 'click' }) + : visible() + } + > + + + ) +} +``` + +The function form is evaluated only on the client and must synchronously return +a strategy. Use `never()` when you intentionally want the initial server HTML to +stay static. + +### `split`: decide whether to create a separate child chunk + +By default, `Hydrate` splits the children into a generated child chunk: + +```tsx + + + +``` + +This delays both hydration work and child JavaScript loading. + +Set `split={false}` when the child code is small or already needed elsewhere, +and you only want to delay hydration work: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +export function SmallWidgetBoundary() { + return ( + + + + ) +} +``` + +### `prefetch`: decide whether to start loading before hydration + +`prefetch` starts loading before the boundary hydrates. It has two forms: + +| Form | Example | Use it for | +| ------------------- | ----------------------------------- | -------------------------------------------------------------- | +| Prefetch strategy | `prefetch={idle()}` | Preloading the generated child chunk before hydration. | +| Procedural prefetch | `prefetch={async (ctx) => { ... }}` | Preloading the child chunk plus data or other async resources. | + +Both forms start work early, but they do not change when the boundary becomes +interactive. That is still controlled by `when`. + +A prefetch strategy is the small, declarative form: + +```tsx +import { idle, interaction, visible } from '@tanstack/react-start/hydration' + + + + + + + + +``` + +Strategy-form `prefetch` downloads the generated child chunk before the boundary +hydrates. This can make the later hydration trigger feel faster, because the +browser may already have the chunk by the time `when` resolves. Generated child +chunks only exist when `split` is enabled, so TypeScript rejects strategy-form +`prefetch` when `split={false}`. + +Use procedural prefetch when you need custom work: + +```tsx +import { useQueryClient } from '@tanstack/react-query' +import { Hydrate } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' + +function DeferredReviews() { + const queryClient = useQueryClient() + + return ( + { + await preload() + await queryClient.prefetchQuery(reviewsQueryOptions) + }} + > + + + ) +} +``` + +Procedural prefetch also works with `split={false}`. In that case, `preload()` +is a resolved no-op, but the function can still prepare data or other +resources. + +## Common Recipes + +### Hydrate below-the-fold SSR content + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' + +export function ProductPage() { + return ( + <> + + + + + + + + ) +} +``` + +Use a positive `rootMargin` when the boundary should hydrate before it actually +enters the viewport. + +### Download the child chunk before it is needed + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { idle, visible } from '@tanstack/react-start/hydration' + +export function ReviewsBoundary() { + return ( + + + + ) +} +``` + +This keeps the boundary non-interactive until it is close to the viewport, but +starts loading the child chunk during idle time. + +### Keep a widget cold until user intent + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { interaction, visible } from '@tanstack/react-start/hydration' + +export function RecommendationsBoundary() { + return ( + + + + ) +} +``` + +This is useful for expensive controls that are visible or nearby, but only +matter when the user reaches for them. + +### Delay hydration without code splitting + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +export function BadgeBoundary() { + return ( + + + + ) +} +``` + +Use this when the JavaScript is already part of the startup bundle or when a +separate child chunk would not be worth it. + +### Keep initial SSR HTML static + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { never } from '@tanstack/react-start/hydration' + +export function MarketingPage() { + return ( + + + + ) +} +``` + +`never()` preserves the existing server HTML and does not hydrate the boundary +during initial document hydration. If the same boundary mounts later during +client-side navigation, it renders normally because there is no initial server +HTML to preserve. `never()` cannot be used as a prefetch strategy. + +### Reuse Hydrate props + +Use `HydrateOptions` for reusable objects that you spread into `Hydrate`: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import type { HydrateOptions } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' + +const belowFoldProps = { + when: () => visible({ rootMargin: '800px' }), +} satisfies HydrateOptions + +export function Page() { + return ( + { + await preload() + }} + > + + + ) +} +``` + +Inline `when` and `prefetch` functions are supported. You do not need to wrap +them in `useCallback`; TanStack Start keeps the latest callback internally and +does not re-register hydration listeners just because a function identity +changed. If the meaning of a boundary changes, use a normal React `key` to +create a new boundary. + +## Hydrate Props Reference + +`Hydrate` accepts these props: + +| Prop | Type | Notes | +| ------------ | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `when` | `HydrationStrategy \| () => HydrationStrategy` | Required. Controls when the boundary hydrates. Function form is client-only and synchronous. | +| `prefetch` | `HydrationPrefetchStrategy \| HydrationPrefetchFunction` | Optional. Strategy form preloads the split child chunk. Function form can preload chunks, data, or other resources, and can be used with `split={false}`. | +| `split` | `boolean` | Defaults to `true`. Set literal `false` to disable compiler extraction and only defer hydration work. | +| `fallback` | `ReactNode` | Client-only loading UI for boundaries that mount after the app has already hydrated and then suspend on the child chunk or child `Suspense`. | +| `onHydrated` | `() => void` | Fires once after the boundary has hydrated on the client. | + +## Strategy Reference + +Import strategies from `@tanstack/react-start/hydration`. + +| Strategy | Behavior | +| --------------- | ------------------------------------------------------------------------------------------ | +| `load()` | Hydrates as soon as the app hydrates. | +| `idle()` | Hydrates in `requestIdleCallback`, or after `timeout` when idle callbacks are unavailable. | +| `visible()` | Hydrates when the boundary marker enters the viewport. | +| `media()` | Hydrates when the media query matches. | +| `interaction()` | Hydrates on configured interaction intent events. | +| `condition()` | Hydrates once the condition is truthy. | +| `never()` | Never hydrates the initial server-rendered boundary. | + +Strategy options: + +| Strategy | Options | +| ------------- | --------------------------------------------------------------------------------------- | +| `idle` | `{ timeout?: number }`, defaults to `2000`. | +| `visible` | `{ rootMargin?: string; threshold?: number \| Array }`, default margin `600px`. | +| `media` | Query string, for example `media('(min-width: 800px)')`. | +| `interaction` | `{ events?: supported event or readonly array of supported events }`. | +| `condition` | Boolean or boolean-returning function. | + +Supported interaction events are `auxclick`, `click`, `contextmenu`, +`dblclick`, `focusin`, `keydown`, `keyup`, `mousedown`, `mouseenter`, +`mouseover`, `mouseup`, `pointerdown`, `pointerenter`, `pointerover`, and +`pointerup`. + +The default `interaction()` event list is `pointerenter`, `focusin`, +`pointerdown`, and `click`. Use `events` when a boundary should listen to a +different event or a smaller set: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { interaction } from '@tanstack/react-start/hydration' + + + + + + + + +``` + +After a `condition()` boundary hydrates, it stays hydrated even if the condition +later becomes false: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { condition } from '@tanstack/react-start/hydration' + +export function CartRecommendationsBoundary() { + return ( + + + + ) +} +``` + +## Prefetch Reference + +Procedural prefetch receives a context object: + +| Property | Meaning | +| ------------------- | --------------------------------------------------------------------------------------- | +| `preload()` | Loads the compiler-generated child chunk. It resolves immediately when `split={false}`. | +| `waitFor(strategy)` | Waits for a prefetch strategy, the hydration trigger, or abort. | +| `signal` | `AbortSignal` for cancelable async work such as `fetch`. | +| `element` | Boundary marker element for custom observers or DOM measurements. | + +`waitFor(strategy)` resolves with: + +| Result | Meaning | +| ------------ | ------------------------------------------------------------------- | +| `'prefetch'` | The supplied prefetch strategy resolved normally. | +| `'hydrate'` | The boundary's hydration trigger fired first. Do required work now. | +| `'abort'` | The boundary unmounted or the prefetch lifecycle was abandoned. | + +The promise returned from procedural prefetch is meaningful. Awaited work blocks +hydration if the `when` strategy resolves before the prefetch function +finishes: + +```tsx + { + await preload() + }} +> + + +``` + +Fire-and-forget work does not block hydration: + +```tsx + { + void preload() + }} +> + + +``` + +Use this distinction deliberately. Await when the resource is required for the +first hydrated render. Fire and forget when the resource is only a helpful +head start. + +## Fallbacks + +`fallback` is not the placeholder for the initial server-rendered HTML. On the +initial page load, TanStack Start keeps the existing server HTML in place until +the boundary hydrates: + +```tsx +}> + + +``` + +In that example, if `Reviews` was present in the initial HTML document, users +see the server-rendered reviews. They do not see `ReviewsSkeleton` while the +boundary is waiting for `visible()`. + +`fallback` is used when the boundary first appears after the app is already +running and there is no existing server HTML for that boundary. Common examples +include client-side navigation, conditionally showing a panel, or opening a tab +whose contents were not in the initial document. In those cases, the boundary +renders on the client, and `fallback` can show while the generated child chunk +or a child `Suspense` is still loading. + +With `never()`, initial server HTML remains static and `fallback` is not used. + +The compiler removes statically visible `fallback` props from the server bundle. +Prefer passing `fallback` directly, in an inline object spread, or through a +single-use `const` object spread so server builds can strip that UI. + +## Correctness And Updates + +Deferred hydration is a performance hint for React's initial hydration work. +React may hydrate a deferred boundary earlier than its strategy would normally +allow if state, props, context, or store updates outside the boundary require +React to reconcile inside it before the gate opens. This preserves correctness +and avoids showing stale server HTML after the surrounding app has changed. + +`never()` is the exception for initial document hydration. Treat it as +intentionally static SSR HTML. Do not rely on parent updates to make a `never()` +boundary interactive. If the same boundary mounts later during client-side +navigation, it renders normally. + +## Nested Boundaries + +Nested boundaries hydrate parent-first. A child boundary can only hydrate after +its ancestor boundaries have hydrated. That means non-interaction child +strategies such as `visible`, `media`, `idle`, or `condition` cannot run while +their parent boundary is still dehydrated. + +For example, a product page might defer the whole reviews section until it is +near the viewport, while keeping heavier review tools cold until the user +interacts with them: + +```tsx +import { Hydrate } from '@tanstack/react-start' +import { interaction, visible } from '@tanstack/react-start/hydration' + +export function ProductPage() { + return ( + <> + + + + +
+

Reviews

+ + + + + + + + + + +
+
+ + ) +} +``` + +In this example, scrolling near the reviews hydrates the parent first. Only +after that can the nested interaction boundaries hydrate from focus or click. + +Interaction intent can also resolve an unresolved ancestor chain when the +ancestor is itself waiting for interaction: + +```tsx + +
+ + + + + +
+
+``` + +If the first meaningful intent is a click inside `WriteReviewForm`, TanStack +Start hydrates the unresolved parent chain and then redispatches a same-type +event for the target boundary. Native listener payload details such as pointer +coordinates are not guaranteed to be preserved. A `never()` ancestor still wins +during initial hydration, so descendants under it remain non-interactive. + +## Preloading And CSS + +Transformed `Hydrate` JavaScript chunks are not modulepreloaded with the route. +Without `prefetch`, the child chunk loads when the split boundary is ready to +render. If that import suspends during client-side navigation or another +client-only mount, the boundary's `fallback` is shown. + +CSS used by split, deferred, and `never()` boundaries is linked in the SSR HTML +for the matched route. It is not deferred with the generated child JavaScript +chunk, because the server-rendered HTML may need those styles before any +JavaScript runs. This is route-level asset linking: if a route module contains a +deferred boundary that imports CSS, that stylesheet can be linked for the route +even when that boundary is hidden behind conditional rendering and does not +appear in a particular response. + +## Extraction Limits + +Compiler-backed `Hydrate` splitting works by moving the boundary's children into +a generated virtual module and rendering them through a lazy component. That +gives TanStack Start a separate child chunk to load later, but it also means the +compiler must be able to move the JSX safely. + +Keep the component you want to split directly inside `Hydrate`. If you hide it +behind opaque `children` props, the compiler cannot statically extract those +children into a generated child chunk at the usage site. + +The split boundary must use a statically imported `Hydrate` component from +`@tanstack/react-start`. Renaming that import is supported: + +```tsx +import { Hydrate as Deferred } from '@tanstack/react-start' + +export function ProductPage() { + return ( + + + + ) +} +``` + +Assigning `Hydrate` to another component variable is not analyzed for splitting: + +```tsx +import { Hydrate } from '@tanstack/react-start' + +const Deferred = Hydrate + + + + +``` + +Render the imported `Hydrate` tag directly, use an import rename, or set +`split={false}` when you need component indirection. + +Use the literal prop `split={false}` to opt out of extraction. Dynamic values +such as `split={shouldSplit}` cannot be used to opt out at compile time. + +These patterns cannot be split: + +| Pattern | Why it is rejected | What to do instead | +| ---------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| Function-as-children | The compiler cannot move a render function and preserve the expected call pattern. | Use `split={false}` or move the rendered UI into a child component. | +| Hook calls directly inside extracted JSX | Moving that JSX would move where the hook executes. | Move the hook call into a component inside the boundary, then render that component. | +| `this` captures | Extracted function components cannot safely preserve class instance context. | Wrap the UI in a function component or use `split={false}`. | +| `super` captures | Extracted function components cannot preserve superclass access. | Wrap the UI in a function component or use `split={false}`. | + +This fails because `useThing()` would be moved into the generated component: + +```tsx + +

{useThing()}

+
+``` + +Move the hook into a component instead: + +```tsx +function ThingText() { + const thing = useThing() + return

{thing}

+} + +export function ProductPage() { + return ( + + + + ) +} +``` + +Values captured from the surrounding component can be passed into the generated +child component, but keep the boundary simple. If extraction starts forcing +complicated data flow, prefer a named child component and put the logic there. + +`fallback` stripping is intentionally conservative. The server build can strip +directly passed fallback UI, inline object-spread fallback UI, and single-use +`const` object-spread fallback UI. If fallback props are hidden behind dynamic +spreads or shared objects, the compiler may keep them. + +You can extract reusable `when` and `prefetch` helpers today, but avoid hiding +split boundaries behind plain wrapper components if you need child code +splitting. A wrapper can defer hydration at runtime, but the compiler cannot +reliably move call-site children into a separate chunk through arbitrary +component indirection. diff --git a/docs/start/framework/solid/guide/deferred-hydration.md b/docs/start/framework/solid/guide/deferred-hydration.md new file mode 100644 index 0000000000..99ffc57a86 --- /dev/null +++ b/docs/start/framework/solid/guide/deferred-hydration.md @@ -0,0 +1,12 @@ +--- +ref: docs/start/framework/react/guide/deferred-hydration.md +replace: + '@tanstack/react-start': '@tanstack/solid-start' + 'React handlers': 'Solid handlers' + 'ReactNode': 'JSX.Element' + "Deferred hydration is a performance hint for React's initial hydration work. React may hydrate a deferred boundary earlier than its strategy would normally allow if state, props, context, or store updates outside the boundary require React to reconcile inside it before the gate opens. This preserves correctness and avoids showing stale server HTML after the surrounding app has changed.": "Deferred hydration is a performance hint for Solid's initial hydration work. Once a boundary gate opens, TanStack Start clears the preserved server DOM inside the marker and mounts the live Solid subtree in its place." + 'Hook calls directly inside extracted JSX': 'Render-time `use*` calls directly inside extracted JSX' + 'Moving that JSX would move where the hook executes.': 'Moving that JSX would move where the call executes.' + 'Move the hook call into a component inside the boundary, then render that component.': 'Move the call into a component inside the boundary, then render that component.' + 'Move the hook into a component instead:': 'Move the call into a component instead:' +--- diff --git a/e2e/e2e-utils/src/hmrFileEditor.ts b/e2e/e2e-utils/src/hmrFileEditor.ts new file mode 100644 index 0000000000..309940fbfe --- /dev/null +++ b/e2e/e2e-utils/src/hmrFileEditor.ts @@ -0,0 +1,127 @@ +import { readFile, writeFile } from 'node:fs/promises' +import path from 'node:path' + +export function replaceAll(source: string, from: string, to: string) { + return source.split(from).join(to) +} + +export type HmrFileEditorOptions = { + rootDir?: string + files: Record + normalizeSource?: (fileKey: TFileKey, source: string) => string +} + +export function createHmrFileEditor( + options: HmrFileEditorOptions, +) { + const files = Object.fromEntries( + Object.entries(options.files).map(([key, filePath]) => [ + key, + options.rootDir && !path.isAbsolute(filePath as string) + ? path.join(options.rootDir, filePath as string) + : (filePath as string), + ]), + ) as Record + const originalContents: Partial> = {} + const pendingRestoreKeys = new Set() + const normalizeSource = + options.normalizeSource ?? ((_fileKey: TFileKey, source: string) => source) + + async function captureOriginals() { + for (const [key, filePath] of Object.entries(files) as Array< + [TFileKey, string] + >) { + const current = await readFile(filePath, 'utf8') + const normalized = normalizeSource(key, current) + + if (normalized !== current) { + await writeFile(filePath, normalized) + pendingRestoreKeys.add(key) + } + + originalContents[key] = normalized + } + } + + const capturePromise = captureOriginals() + + async function restoreFiles(forceFileKeys: Iterable = []) { + const forceRestoreKeys = new Set(forceFileKeys) + const restoredFileKeys: Array = [] + + for (const [key, filePath] of Object.entries(files) as Array< + [TFileKey, string] + >) { + const content = originalContents[key] + if (content === undefined) continue + + const current = await readFile(filePath, 'utf8') + + if (current !== content || forceRestoreKeys.has(key)) { + await writeFile(filePath, content) + restoredFileKeys.push(key) + } + } + + return restoredFileKeys + } + + async function replaceText(fileKey: TFileKey, from: string, to: string) { + const filePath = files[fileKey] + const source = await readFile(filePath, 'utf8') + + if (!source.includes(from)) { + throw new Error(`Expected file to include ${JSON.stringify(from)}`) + } + + await writeFile(filePath, source.replace(from, to)) + } + + async function rewriteFile( + fileKey: TFileKey, + updater: (source: string) => string, + options: { allowNoop?: boolean } = {}, + ) { + const filePath = files[fileKey] + const source = await readFile(filePath, 'utf8') + const updated = updater(source) + + if (updated === source && !options.allowNoop) { + throw new Error(`Expected ${filePath} to change during rewrite`) + } + + await writeFile(filePath, updated) + } + + async function replaceTextAndWait( + fileKey: TFileKey, + from: string, + to: string, + assertion: () => Promise, + ) { + await replaceText(fileKey, from, to) + await assertion() + } + + async function rewriteFileAndWait( + fileKey: TFileKey, + updater: (source: string) => string, + assertion: () => Promise, + options: { allowNoop?: boolean } = {}, + ) { + await rewriteFile(fileKey, updater, options) + await assertion() + } + + return { + files, + pendingRestoreKeys, + capturePromise, + captureOriginals, + restoreFiles, + replaceText, + replaceTextAndWait, + rewriteFile, + rewriteFileAndWait, + } +} diff --git a/e2e/e2e-utils/src/index.ts b/e2e/e2e-utils/src/index.ts index ec6affdb56..17e58f82e5 100644 --- a/e2e/e2e-utils/src/index.ts +++ b/e2e/e2e-utils/src/index.ts @@ -4,5 +4,7 @@ export { toRuntimePath } from './to-runtime-path' export { resolveRuntimeSuffix } from './resolve-runtime-suffix' export { e2eStartDummyServer, e2eStopDummyServer } from './e2eSetupTeardown' export { preOptimizeDevServer, waitForServer } from './devServerWarmup' +export { createHmrFileEditor, replaceAll } from './hmrFileEditor' +export type { HmrFileEditorOptions } from './hmrFileEditor' export type { Post } from './posts' export { collectBrowserErrors, test } from './fixture' diff --git a/e2e/react-start/deferred-hydration/.gitignore b/e2e/react-start/deferred-hydration/.gitignore new file mode 100644 index 0000000000..1b3a07ede1 --- /dev/null +++ b/e2e/react-start/deferred-hydration/.gitignore @@ -0,0 +1,15 @@ +node_modules +package-lock.json +yarn.lock +.DS_Store +.cache +.env +.vercel +.output +/build/ +/api/ +/server/build +/test-results/ +/playwright-report/ +/blob-report/ +/playwright/.cache/ diff --git a/e2e/react-start/deferred-hydration/package.json b/e2e/react-start/deferred-hydration/package.json new file mode 100644 index 0000000000..db76b2fecf --- /dev/null +++ b/e2e/react-start/deferred-hydration/package.json @@ -0,0 +1,60 @@ +{ + "name": "tanstack-react-start-e2e-deferred-hydration", + "private": true, + "sideEffects": false, + "type": "module", + "scripts": { + "dev": "pnpm dev:vite --port 3000", + "dev:e2e": "pnpm dev:vite", + "dev:vite": "vite dev", + "dev:rsbuild": "rsbuild dev", + "build": "pnpm build:vite", + "build:vite": "vite build && tsc --noEmit", + "build:rsbuild": "rsbuild build && tsc --noEmit", + "preview": "vite preview", + "start": "pnpm start:vite", + "start:vite": "srvx --prod --dir=. -s dist-vite-ssr/client --entry dist-vite-ssr/server/server.js", + "start:rsbuild": "srvx --prod --dir=. -s dist-rsbuild-ssr/client --entry dist-rsbuild-ssr/server/index.js", + "test:e2e": "pnpm test:e2e:dev && pnpm test:e2e:prod", + "test:e2e:dev": "MODE=dev playwright test --project=chromium", + "test:e2e:prod": "MODE=prod playwright test --project=chromium" + }, + "dependencies": { + "@tanstack/react-router": "workspace:^", + "@tanstack/react-start": "workspace:^", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "vite": "^8.0.0" + }, + "devDependencies": { + "@rsbuild/core": "^2.0.1", + "@rsbuild/plugin-react": "^2.0.0", + "@tanstack/router-e2e-utils": "workspace:^", + "@types/node": "^22.10.2", + "@types/react": "^19.0.8", + "@types/react-dom": "^19.0.3", + "@vitejs/plugin-react": "^6.0.1", + "rolldown": "1.0.0-rc.18", + "srvx": "^0.11.9", + "typescript": "^6.0.2" + }, + "nx": { + "targets": { + "test:e2e": { + "parallelism": false + } + }, + "metadata": { + "playwrightModes": [ + { + "toolchain": "vite", + "mode": "ssr" + }, + { + "toolchain": "rsbuild", + "mode": "ssr" + } + ] + } + } +} diff --git a/e2e/react-start/deferred-hydration/playwright.config.ts b/e2e/react-start/deferred-hydration/playwright.config.ts new file mode 100644 index 0000000000..0125792d4b --- /dev/null +++ b/e2e/react-start/deferred-hydration/playwright.config.ts @@ -0,0 +1,52 @@ +import fs from 'node:fs' +import { defineConfig, devices } from '@playwright/test' +import { getTestServerPort } from '@tanstack/router-e2e-utils' +import packageJson from './package.json' with { type: 'json' } + +const toolchain = process.env.E2E_TOOLCHAIN ?? 'vite' +const distDir = process.env.E2E_DIST_DIR ?? `dist-${toolchain}-ssr` +const e2ePortKey = + process.env.E2E_PORT_KEY ?? `${packageJson.name}-${toolchain}` +const mode = process.env.MODE ?? 'prod' +const isDev = mode === 'dev' +const serverEntryFile = toolchain === 'rsbuild' ? 'index.js' : 'server.js' +const startCommand = `pnpm exec srvx --prod --dir=. -s ${distDir}/client --entry ${distDir}/server/${serverEntryFile}` +const devCommand = + toolchain === 'rsbuild' ? 'pnpm dev:rsbuild' : 'pnpm dev:vite' + +if (process.env.TEST_WORKER_INDEX === undefined) { + fs.rmSync(`port-${e2ePortKey}.txt`, { force: true }) +} + +const PORT = await getTestServerPort(e2ePortKey) +const baseURL = `http://localhost:${PORT}` + +export default defineConfig({ + testDir: './tests', + workers: 1, + reporter: [['line']], + globalSetup: './tests/setup/global.setup.ts', + globalTeardown: './tests/setup/global.teardown.ts', + use: { baseURL }, + webServer: { + command: isDev ? `${devCommand} --port ${PORT}` : startCommand, + url: baseURL, + reuseExistingServer: !process.env.CI, + stdout: 'pipe', + env: { + E2E_DIST_DIR: distDir, + NODE_ENV: isDev ? 'development' : 'production', + VITE_NODE_ENV: 'test', + PORT: String(PORT), + VITE_SERVER_PORT: String(PORT), + E2E_TOOLCHAIN: toolchain, + E2E_PORT_KEY: e2ePortKey, + }, + }, + projects: [ + { + name: 'chromium', + use: { ...devices['Desktop Chrome'] }, + }, + ], +}) diff --git a/e2e/react-start/deferred-hydration/rsbuild.config.ts b/e2e/react-start/deferred-hydration/rsbuild.config.ts new file mode 100644 index 0000000000..6279705adb --- /dev/null +++ b/e2e/react-start/deferred-hydration/rsbuild.config.ts @@ -0,0 +1,14 @@ +import { defineConfig } from '@rsbuild/core' +import { pluginReact } from '@rsbuild/plugin-react' +import { tanstackStart } from '@tanstack/react-start/plugin/rsbuild' + +const outDir = process.env.E2E_DIST_DIR ?? 'dist-rsbuild-ssr' + +export default defineConfig({ + plugins: [pluginReact({ splitChunks: false }), tanstackStart()], + output: { + distPath: { + root: outDir, + }, + }, +}) diff --git a/e2e/react-start/deferred-hydration/src/routeTree.gen.ts b/e2e/react-start/deferred-hydration/src/routeTree.gen.ts new file mode 100644 index 0000000000..a5b35a698f --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routeTree.gen.ts @@ -0,0 +1,177 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as ScrollRestorationRouteImport } from './routes/scroll-restoration' +import { Route as ImportedRouteImport } from './routes/imported' +import { Route as EnhancedRouteImport } from './routes/enhanced' +import { Route as CssRouteImport } from './routes/css' +import { Route as ComponentsRouteImport } from './routes/components' +import { Route as IndexRouteImport } from './routes/index' + +const ScrollRestorationRoute = ScrollRestorationRouteImport.update({ + id: '/scroll-restoration', + path: '/scroll-restoration', + getParentRoute: () => rootRouteImport, +} as any) +const ImportedRoute = ImportedRouteImport.update({ + id: '/imported', + path: '/imported', + getParentRoute: () => rootRouteImport, +} as any) +const EnhancedRoute = EnhancedRouteImport.update({ + id: '/enhanced', + path: '/enhanced', + getParentRoute: () => rootRouteImport, +} as any) +const CssRoute = CssRouteImport.update({ + id: '/css', + path: '/css', + getParentRoute: () => rootRouteImport, +} as any) +const ComponentsRoute = ComponentsRouteImport.update({ + id: '/components', + path: '/components', + getParentRoute: () => rootRouteImport, +} as any) +const IndexRoute = IndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => rootRouteImport, +} as any) + +export interface FileRoutesByFullPath { + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute + '/scroll-restoration': typeof ScrollRestorationRoute +} +export interface FileRoutesByTo { + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute + '/scroll-restoration': typeof ScrollRestorationRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute + '/scroll-restoration': typeof ScrollRestorationRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: + | '/' + | '/components' + | '/css' + | '/enhanced' + | '/imported' + | '/scroll-restoration' + fileRoutesByTo: FileRoutesByTo + to: + | '/' + | '/components' + | '/css' + | '/enhanced' + | '/imported' + | '/scroll-restoration' + id: + | '__root__' + | '/' + | '/components' + | '/css' + | '/enhanced' + | '/imported' + | '/scroll-restoration' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + IndexRoute: typeof IndexRoute + ComponentsRoute: typeof ComponentsRoute + CssRoute: typeof CssRoute + EnhancedRoute: typeof EnhancedRoute + ImportedRoute: typeof ImportedRoute + ScrollRestorationRoute: typeof ScrollRestorationRoute +} + +declare module '@tanstack/react-router' { + interface FileRoutesByPath { + '/scroll-restoration': { + id: '/scroll-restoration' + path: '/scroll-restoration' + fullPath: '/scroll-restoration' + preLoaderRoute: typeof ScrollRestorationRouteImport + parentRoute: typeof rootRouteImport + } + '/imported': { + id: '/imported' + path: '/imported' + fullPath: '/imported' + preLoaderRoute: typeof ImportedRouteImport + parentRoute: typeof rootRouteImport + } + '/enhanced': { + id: '/enhanced' + path: '/enhanced' + fullPath: '/enhanced' + preLoaderRoute: typeof EnhancedRouteImport + parentRoute: typeof rootRouteImport + } + '/css': { + id: '/css' + path: '/css' + fullPath: '/css' + preLoaderRoute: typeof CssRouteImport + parentRoute: typeof rootRouteImport + } + '/components': { + id: '/components' + path: '/components' + fullPath: '/components' + preLoaderRoute: typeof ComponentsRouteImport + parentRoute: typeof rootRouteImport + } + '/': { + id: '/' + path: '/' + fullPath: '/' + preLoaderRoute: typeof IndexRouteImport + parentRoute: typeof rootRouteImport + } + } +} + +const rootRouteChildren: RootRouteChildren = { + IndexRoute: IndexRoute, + ComponentsRoute: ComponentsRoute, + CssRoute: CssRoute, + EnhancedRoute: EnhancedRoute, + ImportedRoute: ImportedRoute, + ScrollRestorationRoute: ScrollRestorationRoute, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() + +import type { getRouter } from './router.tsx' +import type { createStart } from '@tanstack/react-start' +declare module '@tanstack/react-start' { + interface Register { + ssr: true + router: Awaited> + } +} diff --git a/e2e/react-start/deferred-hydration/src/router.tsx b/e2e/react-start/deferred-hydration/src/router.tsx new file mode 100644 index 0000000000..9d87d8748b --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/router.tsx @@ -0,0 +1,9 @@ +import { createRouter } from '@tanstack/react-router' +import { routeTree } from './routeTree.gen' + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + }) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/__root.tsx b/e2e/react-start/deferred-hydration/src/routes/__root.tsx new file mode 100644 index 0000000000..bfdc646fc5 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/__root.tsx @@ -0,0 +1,180 @@ +/// +import * as React from 'react' +import { + HeadContent, + Link, + Outlet, + Scripts, + createRootRoute, +} from '@tanstack/react-router' + +export const Route = createRootRoute({ + head: () => ({ + meta: [ + { charSet: 'utf-8' }, + { name: 'viewport', content: 'width=device-width, initial-scale=1' }, + { title: 'Deferred Hydration E2E' }, + ], + }), + shellComponent: RootDocument, + component: () => ( +
+ +
+ ), +}) + +function RootDocument({ children }: { children: React.ReactNode }) { + return ( + + + + + + + + {children} + + + + ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/components.tsx b/e2e/react-start/deferred-hydration/src/routes/components.tsx new file mode 100644 index 0000000000..95fa7531a4 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/components.tsx @@ -0,0 +1,179 @@ +import { createFileRoute } from '@tanstack/react-router' +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { + condition, + idle, + interaction, + load, + media, + never, + visible, +} from '@tanstack/react-start/hydration' + +export const Route = createFileRoute('/components')({ + component: ComponentHydrationPage, +}) + +function InteractiveBox(props: { id: string; label: string }) { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +type HydrationFallbackWindow = Window & { + __componentFallbackReady?: boolean + __componentFallbackPromise?: Promise +} + +function DelayedFallbackBox() { + if (typeof window !== 'undefined') { + const win = window as HydrationFallbackWindow + + if (!win.__componentFallbackReady) { + win.__componentFallbackPromise ??= new Promise((resolve) => { + win.setTimeout(() => { + win.__componentFallbackReady = true + resolve() + }, 1000) + }) + + throw win.__componentFallbackPromise + } + } + + return
fallback child
+} + +function ComponentHydrationPage() { + const [hydratedCallbacks, setHydratedCallbacks] = React.useState(0) + const [conditionReady, setConditionReady] = React.useState(false) + const [showClientFallbackBoundary, setShowClientFallbackBoundary] = + React.useState(false) + + return ( +
+

Component Deferred Hydration

+
+ Manual test guide + + Pink buttons are server HTML that has not hydrated yet. Green buttons + have hydrated and should increment when clicked. Follow the notes + below to trigger each strategy intentionally. + +
+

{hydratedCallbacks}

+

+ load and idle should become green + without interaction shortly after the page loads. +

+ + + + + + +
+ Scroll down to reveal the visible boundary +
+

+ visible hydrates only after this button enters the + viewport. +

+ + + +

+ media hydrates when (min-width: 1px) + matches. interaction hydrates on hover, focus, pointer + down, or click intent. +

+ + + + + + +

+ Custom interaction boundaries below hydrate only for their configured + events: double-click for the single-event example, and right-click or + double-click for the multi-event example. The prefetch example should + download code on hover but hydrate on click. +

+ setHydratedCallbacks((count) => count + 1)} + > + + + + + + + + + + + + + + + + + + + + + + + +

+ never stays as server HTML forever on the initial page, + so clicking should not increment it. +

+ + {showClientFallbackBoundary ? ( + client fallback + } + > + + + ) : null} +
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/css.tsx b/e2e/react-start/deferred-hydration/src/routes/css.tsx new file mode 100644 index 0000000000..2c01aa9e57 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/css.tsx @@ -0,0 +1,57 @@ +import { createFileRoute } from '@tanstack/react-router' +import { Hydrate } from '@tanstack/react-start' +import { media, never, visible } from '@tanstack/react-start/hydration' +import outerStyles from './css/outer.module.css' +import deferredStyles from './css/deferred-only.module.css' +import sharedStyles from './css/shared.module.css' + +export const Route = createFileRoute('/css')({ + component: CssHydrationPage, +}) + +function CssHydrationPage() { + return ( +
+
+

+ CSS Deferred Hydration +

+

+ CSS from deferred, never, shared, and nested Hydrate boundaries should + be available even before the client JavaScript hydrates those islands. +

+
+
+
+ Outer CSS +
+
+ Shared outer CSS +
+
+ +
+ Deferred CSS +
+
+ +
+ Never CSS +
+
+ + +
+ Nested CSS +
+
+
+
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/css/deferred-only.module.css b/e2e/react-start/deferred-hydration/src/routes/css/deferred-only.module.css new file mode 100644 index 0000000000..05eafda03c --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/css/deferred-only.module.css @@ -0,0 +1,15 @@ +.deferredBox { + background-color: rgb(23, 45, 67); + color: rgb(255, 255, 255); + padding: 12px; +} + +.neverBox { + color: rgb(45, 67, 89); + padding: 12px; +} + +.nestedBox { + border-left: 5px solid rgb(67, 89, 123); + padding-left: 12px; +} diff --git a/e2e/react-start/deferred-hydration/src/routes/css/outer.module.css b/e2e/react-start/deferred-hydration/src/routes/css/outer.module.css new file mode 100644 index 0000000000..98ca5e0934 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/css/outer.module.css @@ -0,0 +1,9 @@ +.heading { + color: rgb(11, 31, 53); +} + +.outerBox { + background-color: rgb(242, 250, 255); + color: rgb(12, 34, 56); + padding: 12px; +} diff --git a/e2e/react-start/deferred-hydration/src/routes/css/shared.module.css b/e2e/react-start/deferred-hydration/src/routes/css/shared.module.css new file mode 100644 index 0000000000..020da5d7ad --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/css/shared.module.css @@ -0,0 +1,4 @@ +.sharedBox { + border-top: 4px solid rgb(98, 76, 54); + margin-top: 8px; +} diff --git a/e2e/react-start/deferred-hydration/src/routes/enhanced.tsx b/e2e/react-start/deferred-hydration/src/routes/enhanced.tsx new file mode 100644 index 0000000000..628a5c4ae3 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/enhanced.tsx @@ -0,0 +1,339 @@ +import { createFileRoute } from '@tanstack/react-router' +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { interaction, media } from '@tanstack/react-start/hydration' +import { EnhancedNestedWidget } from '../shared/EnhancedNestedWidget' + +type EnhancedSearch = { + dynamic?: 'interaction' +} + +export const Route = createFileRoute('/enhanced')({ + validateSearch: (search: Record): EnhancedSearch => ({ + dynamic: search.dynamic === 'interaction' ? 'interaction' : undefined, + }), + component: EnhancedHydrationPage, +}) + +type DeferredGate = { + promise: Promise + resolve: () => void +} + +const clickIntent = interaction({ events: 'click' }) +const pointerOverIntent = interaction({ events: 'pointerover' }) +const doubleClickIntent = interaction({ events: 'dblclick' }) + +function createDeferredGate(): DeferredGate { + let resolve!: () => void + const promise = new Promise((next) => { + resolve = next + }) + return { promise, resolve } +} + +function useDeferredGate() { + const ref = React.useRef(undefined) + ref.current ??= createDeferredGate() + return ref.current +} + +function mergeStatus>( + setStatus: React.Dispatch>, + patch: Partial, +) { + setStatus((current) => ({ ...current, ...patch })) +} + +function InteractiveBox(props: { id: string; label: string }) { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +function DynamicWhenExamples() { + const search = Route.useSearch() + const searchDrivenHydration = React.useCallback( + () => (search.dynamic === 'interaction' ? clickIntent : doubleClickIntent), + [search.dynamic], + ) + + return ( + <> +

+ Dynamic callbacks are client-only. The first boundary always hydrates on + click; the second reads typed router search state before choosing its + interaction event. +

+ clickIntent}> + + + + + + + ) +} + +function SplitPrefetchExample() { + const gate = useDeferredGate() + const [status, setStatus] = React.useState({ + wait: 'idle', + preload: 'idle', + query: 'idle', + }) + + return ( + <> +

{status.wait}

+

{status.preload}

+

{status.query}

+ + { + mergeStatus(setStatus, { + query: element ? 'element' : 'missing-element', + wait: 'waiting', + }) + + const reason = await waitFor(pointerOverIntent) + mergeStatus(setStatus, { wait: reason }) + if (reason === 'abort' || signal.aborted) return + + await preload() + mergeStatus(setStatus, { preload: 'done' }) + await gate.promise + mergeStatus(setStatus, { query: 'done' }) + }} + > + + + + ) +} + +function FireAndForgetPrefetchExample() { + const gate = useDeferredGate() + const [status, setStatus] = React.useState({ + wait: 'idle', + work: 'idle', + query: 'idle', + }) + + return ( + <> +

{status.work}

+

{status.wait}

+

{status.query}

+ + { + mergeStatus(setStatus, { wait: 'waiting' }) + void waitFor(pointerOverIntent).then((reason) => { + mergeStatus(setStatus, { wait: reason }) + if (reason === 'abort') return + + mergeStatus(setStatus, { work: 'started' }) + void gate.promise.then(() => { + mergeStatus(setStatus, { query: 'done' }) + }) + }) + }} + > + + + + ) +} + +function HydrateFirstPrefetchExample() { + const [reason, setReason] = React.useState('idle') + + return ( + <> +

{reason}

+ { + setReason(await waitFor(doubleClickIntent)) + }} + > + + + + ) +} + +function RuntimeOnlyPrefetchExample() { + const gate = useDeferredGate() + const [status, setStatus] = React.useState({ + wait: 'idle', + ready: 'idle', + }) + + return ( + <> +

{status.wait}

+

{status.ready}

+ + { + mergeStatus(setStatus, { wait: 'waiting' }) + const reason = await waitFor(pointerOverIntent) + mergeStatus(setStatus, { wait: reason }) + if (reason === 'abort') return + + await gate.promise + await preload() + mergeStatus(setStatus, { ready: 'ready' }) + }} + > + + + + ) +} + +function WaitForAbortExample() { + const [showBoundary, setShowBoundary] = React.useState(true) + const [reason, setReason] = React.useState('idle') + + return ( + <> +

{reason}

+ + {showBoundary ? ( + { + setReason('waiting') + setReason(await waitFor(pointerOverIntent)) + }} + > + + + ) : null} + + ) +} + +function SignalAbortExample() { + const [showBoundary, setShowBoundary] = React.useState(true) + const [status, setStatus] = React.useState('idle') + + return ( + <> +

{status}

+ + {showBoundary ? ( + { + setStatus('listening') + await new Promise((resolve) => { + const onAbort = () => { + setStatus('aborted') + resolve() + } + + if (signal.aborted) { + onAbort() + return + } + + signal.addEventListener('abort', onAbort, { once: true }) + }) + }} + > + + + ) : null} + + ) +} + +function NestedDynamicExamples() { + return ( + <> + + clickIntent}> + + + + + + ) +} + +function EnhancedHydrationPage() { + return ( +
+

Enhanced Hydrate APIs

+ + + + + + + + +
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/imported.tsx b/e2e/react-start/deferred-hydration/src/routes/imported.tsx new file mode 100644 index 0000000000..bf0f8b74bd --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/imported.tsx @@ -0,0 +1,15 @@ +import { createFileRoute } from '@tanstack/react-router' +import { ImportedHydrateWidget } from '../shared/ImportedHydrateWidget' + +export const Route = createFileRoute('/imported')({ + component: ImportedHydrationPage, +}) + +function ImportedHydrationPage() { + return ( +
+

Imported Hydrate

+ +
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/index.tsx b/e2e/react-start/deferred-hydration/src/routes/index.tsx new file mode 100644 index 0000000000..0585f4bc87 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/index.tsx @@ -0,0 +1,23 @@ +import { Link, createFileRoute } from '@tanstack/react-router' + +export const Route = createFileRoute('/')({ + component: Home, +}) + +function Home() { + return ( +
+

Deferred Hydration

+

Component strategies

+ component strategies +

CSS

+ CSS deferred hydration +

Imported component

+ + imported Hydrate + +

Enhanced APIs

+ enhanced Hydrate APIs +
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/routes/scroll-restoration.tsx b/e2e/react-start/deferred-hydration/src/routes/scroll-restoration.tsx new file mode 100644 index 0000000000..7b52cf25fe --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/routes/scroll-restoration.tsx @@ -0,0 +1,93 @@ +import { ClientOnly, createFileRoute } from '@tanstack/react-router' +import { Hydrate } from '@tanstack/react-start' +import { visible } from '@tanstack/react-start/hydration' +import * as React from 'react' + +export const Route = createFileRoute('/scroll-restoration')({ + component: ScrollRestorationRoute, +}) + +function BottomWidget() { + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( +
+

Bottom widget

+

+ This visible deferred boundary is intentionally near the bottom of the + document. +

+

+ The hydrated widget is taller than the server skeleton so the test can + catch scroll restoration that happens before late hydration settles. +

+
+ ) +} + +function BottomWidgetSkeleton() { + return ( +
+

Bottom widget skeleton

+

+ The server-rendered placeholder reserves the same vertical space as the + hydrated widget. +

+
+ ) +} + +function ScrollRestorationRoute() { + return ( +
+

+ Scroll restoration deferred hydration +

+

+ This route keeps the reproduction small: a tall page, a visible Hydrate + boundary near the bottom, and normal router scroll restoration. +

+
+ Scroll to the bottom widget +
+ + }> + + + +
+ ) +} diff --git a/e2e/react-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx b/e2e/react-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx new file mode 100644 index 0000000000..fb2f094e51 --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx @@ -0,0 +1,33 @@ +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { interaction, media } from '@tanstack/react-start/hydration' + +function CrossFileNestedButton() { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +export function EnhancedNestedWidget() { + return ( + + + + + + ) +} diff --git a/e2e/react-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx b/e2e/react-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx new file mode 100644 index 0000000000..f2be89ec1c --- /dev/null +++ b/e2e/react-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx @@ -0,0 +1,39 @@ +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { interaction } from '@tanstack/react-start/hydration' + +function ImportedHydrateChild() { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +export function ImportedHydrateWidget() { + return ( + + imported hydrate fallback + + } + > + + + ) +} diff --git a/e2e/react-start/deferred-hydration/tests/hydration.spec.ts b/e2e/react-start/deferred-hydration/tests/hydration.spec.ts new file mode 100644 index 0000000000..0a2c332271 --- /dev/null +++ b/e2e/react-start/deferred-hydration/tests/hydration.spec.ts @@ -0,0 +1,1028 @@ +import { expect } from '@playwright/test' +import { createHmrFileEditor, test } from '@tanstack/router-e2e-utils' +import crypto from 'node:crypto' +import path from 'node:path' +import type { APIRequestContext, Page } from '@playwright/test' + +const isDev = process.env.MODE === 'dev' +const toolchain = process.env.E2E_TOOLCHAIN ?? 'vite' +const isVite = toolchain === 'vite' +const hmrExpect = expect.configure({ timeout: 20_000 }) +const componentsRouteFile = path.join( + process.cwd(), + 'src/routes/components.tsx', +) +const interactiveBoxLabelSource = + ' {props.label}: {count}' +const interactiveBoxHmrLabelSource = + ' hmr {props.label}: {count}' + +function normalizeComponentsRouteSource(source: string) { + return source + .split(interactiveBoxHmrLabelSource) + .join(interactiveBoxLabelSource) +} + +const componentsRouteEditor = createHmrFileEditor({ + files: { + componentsRoute: componentsRouteFile, + }, + normalizeSource: (_fileKey, source) => normalizeComponentsRouteSource(source), +}) + +function getVisibleHydrateVirtualPath() { + const normalizedSourcePath = path + .relative(process.cwd(), componentsRouteFile) + .replaceAll('\\', '/') + const sourceHash = crypto + .createHash('sha1') + .update(normalizedSourcePath) + .digest('hex') + .slice(0, 10) + const params = new URLSearchParams() + params.set('tss-hydrate', `0_${sourceHash}`) + + return `${componentsRouteFile}?${params.toString()}` +} + +async function waitForVisibleHydrateVirtualModule(page: Page, marker: string) { + const virtualPath = getVisibleHydrateVirtualPath() + + await expect + .poll( + async () => { + try { + const response = await page.request.get(virtualPath) + const text = await response.text() + + if (response.ok() && text.includes(marker)) { + return 'ready' + } + + return `${response.status()} ${text.slice(0, 240)}` + } catch (error) { + return String(error) + } + }, + { timeout: 20_000 }, + ) + .toBe('ready') +} + +async function clickAndExpectCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(countTestId)).toHaveText(count) +} + +async function clickIntentAndExpectReplayedCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await expect(page.getByTestId(countTestId)).toHaveText(count) +} + +async function clickToHydrateThenClickAndExpectIncrement( + page: Page, + buttonTestId: string, + countTestId: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + const previousCount = Number( + await page.getByTestId(countTestId).textContent(), + ) + await page.getByTestId(buttonTestId).click() + await expect + .poll(async () => Number(await page.getByTestId(countTestId).textContent())) + .toBe(previousCount + 1) +} + +async function hoverIntentAndExpectCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.mouse.move(0, 0) + await page.getByTestId(buttonTestId).hover() + await clickAndExpectCount(page, buttonTestId, countTestId, count) +} + +async function dispatchHydrationIntent( + page: Page, + buttonTestId: string, + eventName: string, +) { + await page.getByTestId(buttonTestId).evaluate((element, eventName) => { + const marker = element.closest('[data-ts-hydrate-id]') + + if (!marker) { + throw new Error('Expected Hydrate marker to exist') + } + + marker.dispatchEvent( + new Event(eventName, { bubbles: true, cancelable: true }), + ) + }, eventName) +} + +async function expectRouteToStayUnhydrated( + page: Page, + buttonTestId: string, + duration = 250, +) { + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await page.waitForTimeout(duration) + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'false', + ) +} + +async function scrollToBoundary(page: Page, buttonTestId: string) { + const button = page.getByTestId(buttonTestId) + for (let attempt = 0; attempt < 3; attempt++) { + await button.evaluate((element) => { + element.scrollIntoView({ block: 'center', inline: 'nearest' }) + }) + + await page.waitForTimeout(100) + const isVisible = await button.evaluate((element) => { + const rect = element.getBoundingClientRect() + return rect.bottom > 0 && rect.top < window.innerHeight + }) + + if (isVisible) return + } + + await expect(button).toBeInViewport() +} + +async function expectCssProperty( + page: Page, + testId: string, + property: string, + value: string, +) { + await expect + .poll(() => + page.getByTestId(testId).evaluate((element, propertyName) => { + return getComputedStyle(element).getPropertyValue(propertyName) + }, property), + ) + .toBe(value) +} + +function htmlContainsText(html: string, text: string) { + const pattern = text.split(' ').join('(?:\\s|)+') + expect(html).toMatch(new RegExp(pattern)) +} + +async function waitForComponentsServerHtmlText(page: Page, text: string) { + await expect + .poll( + async () => { + const response = await page.request.get('/components') + const html = await response.text() + + if (!response.ok()) { + return `${response.status()} ${html.slice(0, 240)}` + } + + try { + htmlContainsText(html, text) + return 'ready' + } catch { + return html.slice(0, 240) + } + }, + { timeout: 20_000 }, + ) + .toBe('ready') +} + +function getModulePreloadHrefs(html: string) { + return Array.from(html.matchAll(/]*>/g), (match) => match[0]) + .filter((tag) => /\brel="modulepreload"/.test(tag)) + .map((tag) => tag.match(/\bhref="([^"]+)"/)?.[1]) + .filter((href): href is string => !!href) +} + +async function modulePreloadContentsContain( + request: APIRequestContext, + hrefs: Array, + marker: string, +) { + for (const href of hrefs) { + const response = await request.get(href) + if (!response.ok()) continue + + const text = await response.text() + if (text.includes(marker)) return true + } + + return false +} + +async function resourceContentsContain( + page: Page, + request: APIRequestContext, + marker: string, + filter: (url: string) => boolean, +) { + const resourceUrls = await page.evaluate(() => + performance.getEntriesByType('resource').map((entry) => entry.name), + ) + + return modulePreloadContentsContain( + request, + resourceUrls.filter(filter), + marker, + ) +} + +async function documentModulePreloadHrefs(page: Page) { + return page.evaluate(() => + Array.from( + document.querySelectorAll('link[rel~="modulepreload"]'), + (link) => link.href, + ), + ) +} + +function isHydrateBoundaryResource(url: string) { + return ( + url.includes('/assets/components-') || url.includes('/static/js/async/') + ) +} + +function isClientJavaScriptResource(url: string) { + return ( + url.includes('/assets/') || + url.includes('/static/js/') || + url.includes('/static/js/async/') + ) +} + +async function expectClientRouterReady(page: Page) { + await expect + .poll(() => + page.evaluate(() => + Boolean( + ( + globalThis as typeof globalThis & { + __TSR_ROUTER__?: unknown + } + ).__TSR_ROUTER__, + ), + ), + ) + .toBe(true) +} + +async function gotoEnhanced(page: Page, search = '') { + await page.goto(`/enhanced${search}`) + await expectClientRouterReady(page) +} + +test.describe('Hydrate HMR', () => { + test.skip(!isDev, 'HMR regression coverage runs against the dev server only') + + test.beforeAll(async () => { + await componentsRouteEditor.capturePromise + }) + + test.afterEach(async () => { + await componentsRouteEditor.capturePromise + await componentsRouteEditor.restoreFiles() + }) + + test.afterAll(async () => { + await componentsRouteEditor.capturePromise + await componentsRouteEditor.restoreFiles() + }) + + test('updates deferred child chunks after the parent route is edited', async ({ + page, + }) => { + const pageErrors: Array = [] + page.on('pageerror', (error) => { + pageErrors.push(error.message) + }) + + await page.goto('/components') + await expectClientRouterReady(page) + await expectRouteToStayUnhydrated(page, 'component-visible-button') + + await componentsRouteEditor.replaceText( + 'componentsRoute', + interactiveBoxLabelSource, + interactiveBoxHmrLabelSource, + ) + + await waitForComponentsServerHtmlText(page, 'hmr visible') + if (isVite) { + await waitForVisibleHydrateVirtualModule(page, 'hmr ') + } + + await page.goto('/components') + await expectClientRouterReady(page) + await expectRouteToStayUnhydrated(page, 'component-visible-button') + await scrollToBoundary(page, 'component-visible-button') + await hmrExpect(page.getByTestId('component-visible-button')).toContainText( + 'hmr visible', + ) + await clickAndExpectCount( + page, + 'component-visible-button', + 'component-visible-count', + '1', + ) + expect(pageErrors).toEqual([]) + }) +}) + +test.describe('component-level Hydrate runtime strategies', () => { + test.skip( + isDev, + 'production hydration coverage runs against the preview server', + ) + + test('renders SSR HTML and hydrates each runtime when appropriately', async ({ + page, + request, + }) => { + await page.goto('/components') + + await expect(page.getByTestId('component-heading')).toHaveText( + 'Component Deferred Hydration', + ) + + await clickAndExpectCount( + page, + 'component-load-button', + 'component-load-count', + '1', + ) + await clickAndExpectCount( + page, + 'component-idle-button', + 'component-idle-count', + '1', + ) + await expect( + resourceContentsContain(page, request, 'component-visible', (url) => + isHydrateBoundaryResource(url), + ), + ).resolves.toBe(false) + await expectRouteToStayUnhydrated(page, 'component-visible-button') + await scrollToBoundary(page, 'component-visible-button') + await clickAndExpectCount( + page, + 'component-visible-button', + 'component-visible-count', + '1', + ) + await expect + .poll(() => + resourceContentsContain(page, request, 'component-visible', (url) => + isHydrateBoundaryResource(url), + ), + ) + .toBe(true) + await clickAndExpectCount( + page, + 'component-media-button', + 'component-media-count', + '1', + ) + await hoverIntentAndExpectCount( + page, + 'component-interaction-button', + 'component-interaction-count', + '1', + ) + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '0', + ) + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await page.getByTestId('component-custom-single-button').hover() + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await page.getByTestId('component-custom-single-button').click() + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await dispatchHydrationIntent( + page, + 'component-custom-single-button', + 'dblclick', + ) + await expect( + page.getByTestId('component-custom-single-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '1', + ) + await clickAndExpectCount( + page, + 'component-custom-single-button', + 'component-custom-single-count', + '1', + ) + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-custom-multi-button') + await dispatchHydrationIntent( + page, + 'component-custom-multi-button', + 'contextmenu', + ) + await clickAndExpectCount( + page, + 'component-custom-multi-button', + 'component-custom-multi-count', + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-condition-button') + await page.getByTestId('component-enable-condition').click() + await clickAndExpectCount( + page, + 'component-condition-button', + 'component-condition-count', + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-click-replay-button') + await page.getByTestId('component-click-replay-button').click() + await expect( + page.getByTestId('component-click-replay-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('component-click-replay-count')).toHaveText( + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-prefetch-button') + await expect( + resourceContentsContain(page, request, 'component-prefetch', (url) => + isHydrateBoundaryResource(url), + ), + ).resolves.toBe(false) + await page.mouse.move(0, 0) + await page.getByTestId('component-prefetch-button').hover() + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await expect + .poll(() => + resourceContentsContain(page, request, 'component-prefetch', (url) => + isHydrateBoundaryResource(url), + ), + ) + .toBe(true) + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await page.getByTestId('component-prefetch-button').click() + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await expect(page.getByTestId('component-prefetch-count')).toHaveText('1') + await hoverIntentAndExpectCount( + page, + 'component-nested-child-button', + 'component-nested-child-count', + '1', + ) + + await page.getByTestId('component-never-button').click() + await expect(page.getByTestId('component-never-count')).toHaveText('0') + }) + + test('replays click after another interaction boundary hydrates first', async ({ + page, + }) => { + await page.goto('/components') + await expectClientRouterReady(page) + + await scrollToBoundary(page, 'component-custom-multi-button') + await expectRouteToStayUnhydrated(page, 'component-custom-multi-button') + await page.getByTestId('component-custom-multi-button').click({ + button: 'right', + }) + await expect( + page.getByTestId('component-custom-multi-button'), + ).toHaveAttribute('data-hydrated', 'true') + + await scrollToBoundary(page, 'component-click-replay-button') + await expectRouteToStayUnhydrated(page, 'component-click-replay-button') + await page.getByTestId('component-click-replay-button').click() + await expect( + page.getByTestId('component-click-replay-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('component-click-replay-count')).toHaveText( + '1', + ) + }) + + test('shows fallback during a client-only mount while the child suspends', async ({ + page, + }) => { + await page.goto('/components') + await expect(page.getByTestId('component-load-button')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.getByTestId('component-show-client-fallback').click() + + await expect(page.getByTestId('component-client-fallback')).toHaveText( + 'client fallback', + ) + await expect(page.getByTestId('component-fallback-child')).toHaveText( + 'fallback child', + ) + await expect(page.getByTestId('component-client-fallback')).toHaveCount(0) + }) + + test('preserves scroll position after a force reload on a visible boundary', async ({ + page, + }) => { + await page.goto('/scroll-restoration') + await expectClientRouterReady(page) + await page + .getByTestId('scroll-restoration-skeleton') + .scrollIntoViewIfNeeded() + await expect(page.getByTestId('scroll-restoration-widget')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.evaluate(() => { + window.scrollTo(0, document.documentElement.scrollHeight) + }) + + const beforeReloadDistanceFromBottom = await page.evaluate( + () => + document.documentElement.scrollHeight - + window.innerHeight - + window.scrollY, + ) + expect(beforeReloadDistanceFromBottom).toBeLessThan(5) + + const client = await page.context().newCDPSession(page) + const reloaded = page.waitForEvent('load') + await client.send('Page.reload', { ignoreCache: true }) + await reloaded + + await expectClientRouterReady(page) + await expect(page.getByTestId('scroll-restoration-widget')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + + await expect + .poll(() => + page.evaluate( + () => + document.documentElement.scrollHeight - + window.innerHeight - + window.scrollY, + ), + ) + .toBeLessThan(20) + }) +}) + +test.describe('enhanced Hydrate API combinations', () => { + test.skip( + isDev, + 'production hydration coverage runs against the preview server', + ) + + test('server renders dynamic markers without evaluating client-only callbacks or prefetch functions', async ({ + request, + }) => { + const response = await request.get('/enhanced?dynamic=interaction') + const html = await response.text() + + expect(response.ok()).toBe(true) + htmlContainsText(html, 'Enhanced Hydrate APIs') + htmlContainsText(html, 'conditional dynamic') + expect(html).toContain('data-ts-hydrate-when="dynamic"') + expect(html).not.toContain('missing-element') + }) + + test('dynamic when functions hydrate and replay interaction events', async ({ + page, + }) => { + await gotoEnhanced(page, '?dynamic=interaction') + await expect(page.getByTestId('enhanced-heading')).toHaveText( + 'Enhanced Hydrate APIs', + ) + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-dynamic-interaction-button', + 'enhanced-dynamic-interaction-count', + '1', + ) + + await expectRouteToStayUnhydrated( + page, + 'enhanced-dynamic-conditional-button', + ) + await page.getByTestId('enhanced-dynamic-conditional-button').hover() + await expectRouteToStayUnhydrated( + page, + 'enhanced-dynamic-conditional-button', + ) + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-dynamic-conditional-button', + 'enhanced-dynamic-conditional-count', + '1', + ) + }) + + test('procedural prefetch can block hydration, preload the split chunk, and prepare query-like work', async ({ + page, + request, + }) => { + await gotoEnhanced(page) + await expect( + resourceContentsContain( + page, + request, + 'enhanced-procedural-split-child', + isClientJavaScriptResource, + ), + ).resolves.toBe(false) + + await expectRouteToStayUnhydrated(page, 'enhanced-procedural-split-button') + await expect(page.getByTestId('enhanced-split-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-procedural-split-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-split-query')).toHaveText('element') + await expect(page.getByTestId('enhanced-split-wait-reason')).toHaveText( + 'prefetch', + ) + await expect(page.getByTestId('enhanced-split-preload')).toHaveText('done') + await expect + .poll(() => + resourceContentsContain( + page, + request, + 'enhanced-procedural-split-child', + isClientJavaScriptResource, + ), + ) + .toBe(true) + + await page.getByTestId('enhanced-procedural-split-button').click() + await expect( + page.getByTestId('enhanced-procedural-split-button'), + ).toHaveAttribute('data-hydrated', 'false') + await expect( + page.getByTestId('enhanced-procedural-split-count'), + ).toHaveText('0') + await page.getByTestId('enhanced-release-split-prefetch').click() + await expect( + page.getByTestId('enhanced-procedural-split-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect( + page.getByTestId('enhanced-procedural-split-count'), + ).toHaveText('1') + await expect(page.getByTestId('enhanced-split-query')).toHaveText('done') + }) + + test('function prefetch supports fire-and-forget work and waitFor hydrate-first resolution', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expect(page.getByTestId('enhanced-fire-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-fire-and-forget-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-fire-wait-reason')).toHaveText( + 'prefetch', + ) + await expect(page.getByTestId('enhanced-fire-status')).toHaveText('started') + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-fire-and-forget-button', + 'enhanced-fire-and-forget-count', + '1', + ) + await expect(page.getByTestId('enhanced-fire-query')).toHaveText('idle') + await page.getByTestId('enhanced-release-fire-prefetch').click() + await expect(page.getByTestId('enhanced-fire-query')).toHaveText('done') + + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-hydrate-first-button', + 'enhanced-hydrate-first-count', + '1', + ) + await expect(page.getByTestId('enhanced-hydrate-first-reason')).toHaveText( + 'hydrate', + ) + }) + + test('split=false procedural prefetch blocks hydration without requiring a child preload chunk', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expectRouteToStayUnhydrated(page, 'enhanced-runtime-only-button') + await expect(page.getByTestId('enhanced-runtime-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-runtime-only-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-runtime-wait-reason')).toHaveText( + 'prefetch', + ) + await page.getByTestId('enhanced-runtime-only-button').click() + await expect( + page.getByTestId('enhanced-runtime-only-button'), + ).toHaveAttribute('data-hydrated', 'false') + await expect(page.getByTestId('enhanced-runtime-only-count')).toHaveText( + '0', + ) + await page.getByTestId('enhanced-release-runtime-prefetch').click() + await expect(page.getByTestId('enhanced-runtime-status')).toHaveText( + 'ready', + ) + await expect( + page.getByTestId('enhanced-runtime-only-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('enhanced-runtime-only-count')).toHaveText( + '1', + ) + }) + + test('procedural prefetch aborts waiters and signals when boundaries unmount', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expectRouteToStayUnhydrated(page, 'enhanced-wait-abort-button') + await expect(page.getByTestId('enhanced-wait-abort-reason')).toHaveText( + 'waiting', + ) + await page.getByTestId('enhanced-hide-wait-abort').click() + await expect(page.getByTestId('enhanced-wait-abort-reason')).toHaveText( + 'abort', + ) + + await expect(page.getByTestId('enhanced-abort-status')).toHaveText( + 'listening', + ) + await page.getByTestId('enhanced-hide-abort').click() + await expect(page.getByTestId('enhanced-abort-status')).toHaveText( + 'aborted', + ) + }) + + test('nested dynamic interaction boundaries delegate through outer boundaries', async ({ + page, + }) => { + await gotoEnhanced(page) + + await clickToHydrateThenClickAndExpectIncrement( + page, + 'enhanced-dynamic-nested-button', + 'enhanced-dynamic-nested-count', + ) + await clickToHydrateThenClickAndExpectIncrement( + page, + 'enhanced-cross-file-nested-button', + 'enhanced-cross-file-nested-count', + ) + }) +}) + +test.describe('Hydrate CSS delivery', () => { + test.skip( + isDev, + 'production hydration coverage runs against the preview server', + ) + + test('ships CSS for deferred, never, shared, and nested boundaries without JavaScript', async ({ + browser, + request, + }) => { + const response = await request.get('/css') + const html = await response.text() + + htmlContainsText(html, 'CSS Deferred Hydration') + htmlContainsText(html, 'Outer CSS') + htmlContainsText(html, 'Deferred CSS') + htmlContainsText(html, 'Never CSS') + htmlContainsText(html, 'Nested CSS') + + const context = await browser.newContext({ javaScriptEnabled: false }) + const page = await context.newPage() + + try { + await page.goto('/css') + + await expect(page.getByTestId('css-heading')).toHaveText( + 'CSS Deferred Hydration', + ) + await expect(page.getByTestId('css-deferred')).toHaveText('Deferred CSS') + await expect(page.getByTestId('css-never')).toHaveText('Never CSS') + await expect(page.getByTestId('css-nested')).toHaveText('Nested CSS') + + await expectCssProperty(page, 'css-outer', 'color', 'rgb(12, 34, 56)') + await expectCssProperty( + page, + 'css-deferred', + 'background-color', + 'rgb(23, 45, 67)', + ) + await expectCssProperty(page, 'css-never', 'color', 'rgb(45, 67, 89)') + await expectCssProperty( + page, + 'css-shared-outer', + 'border-top-color', + 'rgb(98, 76, 54)', + ) + await expectCssProperty( + page, + 'css-deferred', + 'border-top-color', + 'rgb(98, 76, 54)', + ) + await expectCssProperty( + page, + 'css-nested', + 'border-left-color', + 'rgb(67, 89, 123)', + ) + await expectCssProperty(page, 'css-nested', 'border-left-width', '5px') + } finally { + await context.close() + } + }) + + test('renders deferred content and omits never content after client-side navigation', async ({ + page, + }) => { + await page.goto('/') + await expectClientRouterReady(page) + await page.getByRole('link', { name: 'CSS', exact: true }).click() + await expect(page).toHaveURL(/\/css$/) + + await expect(page.getByTestId('css-heading')).toHaveText( + 'CSS Deferred Hydration', + ) + await expect(page.getByTestId('css-deferred')).toHaveText('Deferred CSS') + await expect(page.getByTestId('css-never')).toHaveCount(0) + await expect(page.getByTestId('css-nested')).toHaveCount(0) + + await expectCssProperty( + page, + 'css-deferred', + 'background-color', + 'rgb(23, 45, 67)', + ) + }) +}) + +test.describe('imported Hydrate boundaries', () => { + test.skip( + isDev, + 'production hydration coverage runs against the preview server', + ) + + test('does not emit filtered shared Hydrate child JS on the initial document', async ({ + request, + }) => { + const response = await request.get('/imported') + const html = await response.text() + + htmlContainsText(html, 'Imported Hydrate') + htmlContainsText(html, 'Imported Hydrate Child') + + await expect( + modulePreloadContentsContain( + request, + getModulePreloadHrefs(html), + 'imported-hydrate-child', + ), + ).resolves.toBe(false) + }) + + test('does not preload Hydrate child chunks before client navigation', async ({ + page, + request, + }) => { + await page.goto('/') + await expect(page.getByTestId('home-heading')).toHaveText( + 'Deferred Hydration', + ) + await expectClientRouterReady(page) + + const link = page.getByRole('link', { name: 'imported Hydrate' }) + await page.mouse.move(0, 0) + await link.hover() + await link.focus() + + await expect( + modulePreloadContentsContain( + request, + await documentModulePreloadHrefs(page), + 'imported-hydrate-child', + ), + ).resolves.toBe(false) + await expect( + resourceContentsContain(page, request, 'imported-hydrate-child', (url) => + isClientJavaScriptResource(url), + ), + ).resolves.toBe(false) + + await page.getByRole('link', { name: 'imported Hydrate' }).click() + await expect(page).toHaveURL(/\/imported$/) + await expect(page.getByTestId('imported-hydrate-fallback')).toHaveCount(0) + await expect(page.getByTestId('imported-hydrate-child')).toContainText( + 'Imported Hydrate Child', + ) + await clickAndExpectCount( + page, + 'imported-hydrate-child', + 'imported-hydrate-count', + '1', + ) + }) + + test('hydrates imported child boundaries from the initial document on interaction', async ({ + page, + request, + }) => { + await page.goto('/imported') + await expect(page.getByTestId('imported-heading')).toHaveText( + 'Imported Hydrate', + ) + await expectClientRouterReady(page) + await expect(page.getByTestId('imported-hydrate-fallback')).toHaveCount(0) + await expectRouteToStayUnhydrated(page, 'imported-hydrate-child') + await expect( + resourceContentsContain(page, request, 'imported-hydrate-child', (url) => + isClientJavaScriptResource(url), + ), + ).resolves.toBe(false) + + await page.getByTestId('imported-hydrate-child').click() + await expect(page.getByTestId('imported-hydrate-child')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await expect(page.getByTestId('imported-hydrate-count')).toHaveText('1') + await expect + .poll(() => + resourceContentsContain( + page, + request, + 'imported-hydrate-child', + isClientJavaScriptResource, + ), + ) + .toBe(true) + }) +}) diff --git a/e2e/react-start/deferred-hydration/tests/setup/global.setup.ts b/e2e/react-start/deferred-hydration/tests/setup/global.setup.ts new file mode 100644 index 0000000000..1117664a14 --- /dev/null +++ b/e2e/react-start/deferred-hydration/tests/setup/global.setup.ts @@ -0,0 +1,38 @@ +import { + e2eStartDummyServer, + getTestServerPort, + preOptimizeDevServer, + waitForServer, +} from '@tanstack/router-e2e-utils' +import packageJson from '../../package.json' with { type: 'json' } + +function getE2EPortKey() { + const toolchain = process.env.E2E_TOOLCHAIN ?? 'vite' + return process.env.E2E_PORT_KEY ?? `${packageJson.name}-${toolchain}` +} + +export default async function setup() { + if (process.env.MODE !== 'dev') return + + const e2ePortKey = getE2EPortKey() + + await e2eStartDummyServer(e2ePortKey) + + const port = await getTestServerPort(e2ePortKey) + const baseURL = `http://localhost:${port}` + + await waitForServer(baseURL) + await preOptimizeDevServer({ + baseURL, + readyTestId: 'home-heading', + warmup: async (page) => { + await page.goto(`${baseURL}/components`, { + waitUntil: 'domcontentloaded', + }) + await page.getByTestId('component-heading').waitFor({ + state: 'visible', + }) + await page.waitForLoadState('networkidle') + }, + }) +} diff --git a/e2e/react-start/deferred-hydration/tests/setup/global.teardown.ts b/e2e/react-start/deferred-hydration/tests/setup/global.teardown.ts new file mode 100644 index 0000000000..df79f50e82 --- /dev/null +++ b/e2e/react-start/deferred-hydration/tests/setup/global.teardown.ts @@ -0,0 +1,13 @@ +import { e2eStopDummyServer } from '@tanstack/router-e2e-utils' +import packageJson from '../../package.json' with { type: 'json' } + +function getE2EPortKey() { + const toolchain = process.env.E2E_TOOLCHAIN ?? 'vite' + return process.env.E2E_PORT_KEY ?? `${packageJson.name}-${toolchain}` +} + +export default async function teardown() { + if (process.env.MODE !== 'dev') return + + await e2eStopDummyServer(getE2EPortKey()) +} diff --git a/e2e/react-start/deferred-hydration/tsconfig.json b/e2e/react-start/deferred-hydration/tsconfig.json new file mode 100644 index 0000000000..cef9369516 --- /dev/null +++ b/e2e/react-start/deferred-hydration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "include": ["**/*.ts", "**/*.tsx"], + "compilerOptions": { + "strict": true, + "esModuleInterop": true, + "jsx": "react-jsx", + "module": "ESNext", + "moduleResolution": "Bundler", + "lib": ["DOM", "DOM.Iterable", "ES2022"], + "isolatedModules": true, + "resolveJsonModule": true, + "skipLibCheck": true, + "target": "ES2022", + "allowJs": true, + "forceConsistentCasingInFileNames": true, + "paths": { + "~/*": ["./src/*"] + }, + "noEmit": true + } +} diff --git a/e2e/react-start/deferred-hydration/vite.config.ts b/e2e/react-start/deferred-hydration/vite.config.ts new file mode 100644 index 0000000000..1289bc0be7 --- /dev/null +++ b/e2e/react-start/deferred-hydration/vite.config.ts @@ -0,0 +1,14 @@ +import { defineConfig } from 'vite' +import { tanstackStart } from '@tanstack/react-start/plugin/vite' +import viteReact from '@vitejs/plugin-react' + +const outDir = process.env.E2E_DIST_DIR ?? 'dist-vite-ssr' + +export default defineConfig({ + resolve: { tsconfigPaths: true }, + build: { + outDir, + }, + server: { port: 3000 }, + plugins: [tanstackStart(), viteReact()], +}) diff --git a/e2e/react-start/hmr/tests/app.spec.ts b/e2e/react-start/hmr/tests/app.spec.ts index b3ac8b6a1a..95914f6270 100644 --- a/e2e/react-start/hmr/tests/app.spec.ts +++ b/e2e/react-start/hmr/tests/app.spec.ts @@ -1,7 +1,10 @@ -import { readFile, writeFile } from 'node:fs/promises' -import path from 'node:path' import { expect } from '@playwright/test' -import { test } from '@tanstack/router-e2e-utils' +import { + createHmrFileEditor, + replaceAll, + test, +} from '@tanstack/router-e2e-utils' +import path from 'node:path' import type { Page } from '@playwright/test' @@ -115,14 +118,6 @@ const routeFileRestoreChecks: Partial< }, } -// Capture original file contents once so beforeEach can restore them -const originalContents: Partial> = {} -const routeKeysPendingRestoreCheck = new Set() - -function replaceAll(source: string, from: string, to: string) { - return source.split(from).join(to) -} - function normalizeRouteSource(routeFileKey: RouteFileKey, source: string) { let next = source @@ -254,59 +249,14 @@ function normalizeRouteSource(routeFileKey: RouteFileKey, source: string) { return next } -async function captureOriginals() { - for (const [key, filePath] of Object.entries(routeFiles) as Array< - [RouteFileKey, string] - >) { - const current = await readFile(filePath, 'utf8') - const normalized = normalizeRouteSource(key, current) - if (normalized !== current) { - await writeFile(filePath, normalized) - routeKeysPendingRestoreCheck.add(key) - } - originalContents[key] = normalized - } -} - -const capturePromise = captureOriginals() - -async function restoreRouteFiles( - forceRouteFileKeys: Iterable = [], -) { - const forceRestoreKeys = new Set(forceRouteFileKeys) - const restoredRouteKeys: Array = [] - - for (const [key, filePath] of Object.entries(routeFiles) as Array< - [RouteFileKey, string] - >) { - const content = originalContents[key] - if (content === undefined) continue - const current = await readFile(filePath, 'utf8') - // Re-emit pending restores in case the watcher coalesced the previous - // restore write and the dev server is still serving stale route options. - if (current !== content || forceRestoreKeys.has(key)) { - await writeFile(filePath, content) - restoredRouteKeys.push(key) - } - } - - return restoredRouteKeys -} - -async function replaceRouteText( - routeFileKey: RouteFileKey, - from: string, - to: string, -) { - const filePath = routeFiles[routeFileKey] - const source = await readFile(filePath, 'utf8') - - if (!source.includes(from)) { - throw new Error(`Expected route file to include ${JSON.stringify(from)}`) - } - - await writeFile(filePath, source.replace(from, to)) -} +const routeFileEditor = createHmrFileEditor({ + files: routeFiles, + normalizeSource: normalizeRouteSource, +}) +const capturePromise = routeFileEditor.capturePromise +const routeKeysPendingRestoreCheck = routeFileEditor.pendingRestoreKeys +const restoreRouteFiles = routeFileEditor.restoreFiles +const replaceRouteText = routeFileEditor.replaceText async function replaceRouteTextAndWait( page: Page, @@ -315,7 +265,7 @@ async function replaceRouteTextAndWait( to: string, assertion: () => Promise, ) { - await replaceRouteText(routeFileKey, from, to) + await routeFileEditor.replaceText(routeFileKey, from, to) await assertion() } @@ -326,17 +276,7 @@ async function rewriteRouteFile( assertion: () => Promise, options: { allowNoop?: boolean } = {}, ) { - const filePath = routeFiles[routeFileKey] - const source = await readFile(filePath, 'utf8') - const updated = updater(source) - - if (updated === source && !options.allowNoop) { - throw new Error(`Expected ${filePath} to change during rewrite`) - } - - // Even a no-op write is useful for tests that need to force the dev server - // to reconcile a stale in-memory module with the current file contents. - await writeFile(filePath, updated) + await routeFileEditor.rewriteFile(routeFileKey, updater, options) await assertion() } diff --git a/e2e/react-start/rsc-deferred-hydration/.gitignore b/e2e/react-start/rsc-deferred-hydration/.gitignore new file mode 100644 index 0000000000..cc99170fbb --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/.gitignore @@ -0,0 +1,5 @@ +dist +node_modules +port*.txt +test-results +playwright-report diff --git a/e2e/react-start/rsc-deferred-hydration/package.json b/e2e/react-start/rsc-deferred-hydration/package.json new file mode 100644 index 0000000000..7944b81552 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/package.json @@ -0,0 +1,45 @@ +{ + "name": "tanstack-react-start-e2e-rsc-deferred-hydration", + "private": true, + "sideEffects": false, + "type": "module", + "scripts": { + "dev": "vite dev --port 3000", + "dev:e2e": "vite dev", + "build": "vite build && tsc --noEmit", + "preview": "vite preview", + "start": "node server.js", + "test:e2e": "pnpm test:e2e:dev && pnpm test:e2e:prod", + "test:e2e:dev": "MODE=dev playwright test --project=chromium", + "test:e2e:prod": "MODE=prod playwright test --project=chromium" + }, + "nx": { + "metadata": { + "playwrightModes": [ + { + "toolchain": "vite", + "mode": "ssr", + "shards": 1 + } + ] + } + }, + "dependencies": { + "@tanstack/react-router": "workspace:^", + "@tanstack/react-start": "workspace:^", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "vite": "^8.0.0" + }, + "devDependencies": { + "@playwright/test": "^1.50.1", + "@tanstack/router-e2e-utils": "workspace:^", + "@types/node": "^22.10.2", + "@types/react": "^19.0.8", + "@types/react-dom": "^19.0.3", + "@vitejs/plugin-react": "^6.0.1", + "@vitejs/plugin-rsc": "^0.5.20", + "srvx": "^0.11.9", + "typescript": "^6.0.2" + } +} diff --git a/e2e/react-start/rsc-deferred-hydration/playwright.config.ts b/e2e/react-start/rsc-deferred-hydration/playwright.config.ts new file mode 100644 index 0000000000..10f41cd911 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/playwright.config.ts @@ -0,0 +1,35 @@ +import { defineConfig, devices } from '@playwright/test' +import { getTestServerPort } from '@tanstack/router-e2e-utils' +import packageJson from './package.json' with { type: 'json' } + +const PORT = await getTestServerPort(packageJson.name) +const baseURL = `http://localhost:${PORT}` +const mode = process.env.MODE ?? 'prod' +const isDev = mode === 'dev' + +export default defineConfig({ + testDir: './tests', + workers: 1, + reporter: [['line']], + globalSetup: './tests/setup/global.setup.ts', + globalTeardown: './tests/setup/global.teardown.ts', + use: { baseURL }, + webServer: { + command: isDev ? 'pnpm dev:e2e' : 'pnpm build && pnpm start', + url: baseURL, + reuseExistingServer: !process.env.CI, + stdout: 'pipe', + env: { + VITE_NODE_ENV: 'test', + NODE_ENV: isDev ? 'development' : 'production', + PORT: String(PORT), + VITE_SERVER_PORT: String(PORT), + }, + }, + projects: [ + { + name: 'chromium', + use: { ...devices['Desktop Chrome'] }, + }, + ], +}) diff --git a/e2e/react-start/rsc-deferred-hydration/server.js b/e2e/react-start/rsc-deferred-hydration/server.js new file mode 100644 index 0000000000..6365c568d4 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/server.js @@ -0,0 +1,47 @@ +import fs from 'node:fs' +import path from 'node:path' +import { spawn } from 'node:child_process' +import { pathToFileURL } from 'node:url' + +const distDir = process.env.E2E_DIST_DIR || 'dist' + +function resolveDistClientDir() { + return path.resolve(distDir, 'client') +} + +function resolveDistServerEntryPath() { + const serverJsPath = path.resolve(distDir, 'server', 'server.js') + if (fs.existsSync(serverJsPath)) return serverJsPath + + const indexJsPath = path.resolve(distDir, 'server', 'index.js') + if (fs.existsSync(indexJsPath)) return indexJsPath + + return serverJsPath +} + +export function start() { + const child = spawn( + 'srvx', + ['--prod', '-s', resolveDistClientDir(), resolveDistServerEntryPath()], + { + stdio: 'inherit', + shell: process.platform === 'win32', + }, + ) + + child.on('exit', (code, signal) => { + if (signal) { + process.kill(process.pid, signal) + return + } + + process.exit(code ?? 0) + }) +} + +if ( + process.argv[1] && + import.meta.url === pathToFileURL(process.argv[1]).href +) { + start() +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.module.css b/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.module.css new file mode 100644 index 0000000000..d80e17aebe --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.module.css @@ -0,0 +1,42 @@ +.cssIsland { + border-color: rgba(16, 185, 129, 0.38); + background: + linear-gradient( + 135deg, + rgba(236, 253, 245, 0.96), + rgba(255, 255, 255, 0.9) + ), + repeating-linear-gradient( + 45deg, + rgba(16, 185, 129, 0.12) 0 8px, + transparent 8px 16px + ); + color: rgb(6, 78, 59); +} + +.cssIsland h2 { + color: rgb(6, 95, 70); +} + +.cssMarker { + width: fit-content; + padding: 0.45rem 0.7rem; + border-radius: 999px; + font-weight: 900; + transition: + background 180ms ease, + color 180ms ease, + box-shadow 180ms ease; +} + +.cssMarkerPending { + background: rgb(252, 231, 243); + color: rgb(157, 23, 77); + box-shadow: 0 8px 26px rgba(219, 39, 119, 0.18); +} + +.cssMarkerHydrated { + background: rgb(209, 250, 229); + color: rgb(6, 95, 70); + box-shadow: 0 8px 26px rgba(5, 150, 105, 0.18); +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.tsx b/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.tsx new file mode 100644 index 0000000000..7f023bd10c --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/components/CssHydrateIsland.tsx @@ -0,0 +1,45 @@ +'use client' + +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { media } from '@tanstack/react-start/hydration' +import { DeferredHydrateIsland } from './DeferredHydrateIsland' +import styles from './CssHydrateIsland.module.css' + +function CssHydratePanel() { + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( +
+ CSS module Hydrate island +

CSS modules survive the RSC to client boundary

+

+ {hydrated + ? 'Hydrated module-styled client content' + : 'Pending module-styled client content'} +

+ +
+ ) +} + +export function CssHydrateIsland() { + return ( +
+ + + +
+ ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/components/DeferredHydrateIsland.tsx b/e2e/react-start/rsc-deferred-hydration/src/components/DeferredHydrateIsland.tsx new file mode 100644 index 0000000000..0a716fe39c --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/components/DeferredHydrateIsland.tsx @@ -0,0 +1,67 @@ +'use client' + +import * as React from 'react' +import { Hydrate } from '@tanstack/react-start' +import { interaction, media, visible } from '@tanstack/react-start/hydration' + +type Strategy = 'interaction' | 'visible' | 'media' + +const strategyCopy: Record = { + interaction: 'Hydrates after pointer or focus intent reaches this island.', + visible: 'Hydrates only after the island scrolls into the viewport.', + media: 'Hydrates immediately when the matching media query is true.', +} + +function getStrategy(strategy: Strategy) { + if (strategy === 'interaction') return interaction() + if (strategy === 'visible') return visible({ rootMargin: '0px' }) + return media('(min-width: 1px)') +} + +export function CounterButton(props: { id: string; label: string }) { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +export function DeferredHydrateIsland(props: { + id: string + title: string + strategy: Strategy + className?: string +}) { + return ( +
+ Client Hydrate island +

{props.title}

+

{strategyCopy[props.strategy]}

+ + + +
+ ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routeTree.gen.ts b/e2e/react-start/rsc-deferred-hydration/src/routeTree.gen.ts new file mode 100644 index 0000000000..246737b515 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routeTree.gen.ts @@ -0,0 +1,122 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as ServerClientRouteImport } from './routes/server-client' +import { Route as CssRouteImport } from './routes/css' +import { Route as CompositeRouteImport } from './routes/composite' +import { Route as IndexRouteImport } from './routes/index' + +const ServerClientRoute = ServerClientRouteImport.update({ + id: '/server-client', + path: '/server-client', + getParentRoute: () => rootRouteImport, +} as any) +const CssRoute = CssRouteImport.update({ + id: '/css', + path: '/css', + getParentRoute: () => rootRouteImport, +} as any) +const CompositeRoute = CompositeRouteImport.update({ + id: '/composite', + path: '/composite', + getParentRoute: () => rootRouteImport, +} as any) +const IndexRoute = IndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => rootRouteImport, +} as any) + +export interface FileRoutesByFullPath { + '/': typeof IndexRoute + '/composite': typeof CompositeRoute + '/css': typeof CssRoute + '/server-client': typeof ServerClientRoute +} +export interface FileRoutesByTo { + '/': typeof IndexRoute + '/composite': typeof CompositeRoute + '/css': typeof CssRoute + '/server-client': typeof ServerClientRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/': typeof IndexRoute + '/composite': typeof CompositeRoute + '/css': typeof CssRoute + '/server-client': typeof ServerClientRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: '/' | '/composite' | '/css' | '/server-client' + fileRoutesByTo: FileRoutesByTo + to: '/' | '/composite' | '/css' | '/server-client' + id: '__root__' | '/' | '/composite' | '/css' | '/server-client' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + IndexRoute: typeof IndexRoute + CompositeRoute: typeof CompositeRoute + CssRoute: typeof CssRoute + ServerClientRoute: typeof ServerClientRoute +} + +declare module '@tanstack/react-router' { + interface FileRoutesByPath { + '/server-client': { + id: '/server-client' + path: '/server-client' + fullPath: '/server-client' + preLoaderRoute: typeof ServerClientRouteImport + parentRoute: typeof rootRouteImport + } + '/css': { + id: '/css' + path: '/css' + fullPath: '/css' + preLoaderRoute: typeof CssRouteImport + parentRoute: typeof rootRouteImport + } + '/composite': { + id: '/composite' + path: '/composite' + fullPath: '/composite' + preLoaderRoute: typeof CompositeRouteImport + parentRoute: typeof rootRouteImport + } + '/': { + id: '/' + path: '/' + fullPath: '/' + preLoaderRoute: typeof IndexRouteImport + parentRoute: typeof rootRouteImport + } + } +} + +const rootRouteChildren: RootRouteChildren = { + IndexRoute: IndexRoute, + CompositeRoute: CompositeRoute, + CssRoute: CssRoute, + ServerClientRoute: ServerClientRoute, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() + +import type { getRouter } from './router.tsx' +import type { createStart } from '@tanstack/react-start' +declare module '@tanstack/react-start' { + interface Register { + ssr: true + router: Awaited> + } +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/router.tsx b/e2e/react-start/rsc-deferred-hydration/src/router.tsx new file mode 100644 index 0000000000..9d87d8748b --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/router.tsx @@ -0,0 +1,9 @@ +import { createRouter } from '@tanstack/react-router' +import { routeTree } from './routeTree.gen' + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + }) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routes/__root.tsx b/e2e/react-start/rsc-deferred-hydration/src/routes/__root.tsx new file mode 100644 index 0000000000..7ce2e7bdb1 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routes/__root.tsx @@ -0,0 +1,122 @@ +/// +import * as React from 'react' +import { + HeadContent, + Link, + Outlet, + Scripts, + createRootRoute, +} from '@tanstack/react-router' + +export const Route = createRootRoute({ + head: () => ({ + meta: [ + { charSet: 'utf-8' }, + { name: 'viewport', content: 'width=device-width, initial-scale=1' }, + { title: 'RSC Deferred Hydration E2E' }, + ], + }), + shellComponent: RootDocument, + component: () => ( +
+ +
+ ), +}) + +function RootDocument({ children }: { children: React.ReactNode }) { + return ( + + + + + + + + {children} + + + + ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routes/composite.tsx b/e2e/react-start/rsc-deferred-hydration/src/routes/composite.tsx new file mode 100644 index 0000000000..3241ee487d --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routes/composite.tsx @@ -0,0 +1,24 @@ +import { createFileRoute } from '@tanstack/react-router' +import { CompositeComponent } from '@tanstack/react-start/rsc' +import { getCompositeHydrate } from '~/server/serverHydrateComponents' +import { DeferredHydrateIsland } from '~/components/DeferredHydrateIsland' + +export const Route = createFileRoute('/composite')({ + loader: async () => ({ + Composite: await getCompositeHydrate(), + }), + component: CompositeRoute, +}) + +function CompositeRoute() { + const { Composite } = Route.useLoaderData() + return ( + + + + ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routes/css.tsx b/e2e/react-start/rsc-deferred-hydration/src/routes/css.tsx new file mode 100644 index 0000000000..ddb22f318a --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routes/css.tsx @@ -0,0 +1,14 @@ +import { createFileRoute } from '@tanstack/react-router' +import { getCssModuleHydrate } from '~/server/serverHydrateComponents' + +export const Route = createFileRoute('/css')({ + loader: async () => ({ + Server: await getCssModuleHydrate(), + }), + component: CssRoute, +}) + +function CssRoute() { + const { Server } = Route.useLoaderData() + return Server +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routes/index.tsx b/e2e/react-start/rsc-deferred-hydration/src/routes/index.tsx new file mode 100644 index 0000000000..ebe57e7028 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routes/index.tsx @@ -0,0 +1,35 @@ +import { createFileRoute, Link } from '@tanstack/react-router' + +export const Route = createFileRoute('/')({ + component: Home, +}) + +function Home() { + return ( +
+

RSC meets Deferred Hydration

+

+ These routes render React Server Components that cross into client + components using Hydrate. Each card explains when its + client island should hydrate and keeps server-rendered HTML visible + first. +

+
+ + Server component to client Hydrate + The RSC renders a separate "use client" component that + defers hydration until interaction. + + + Composite server shellA server component owns the + visual frame while a client child hydrates only after it becomes + visible. + + + CSS module client islandA server component renders a + client Hydrate boundary whose child uses CSS modules. + +
+
+ ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/routes/server-client.tsx b/e2e/react-start/rsc-deferred-hydration/src/routes/server-client.tsx new file mode 100644 index 0000000000..f39b635241 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/routes/server-client.tsx @@ -0,0 +1,14 @@ +import { createFileRoute } from '@tanstack/react-router' +import { getServerClientHydrate } from '~/server/serverHydrateComponents' + +export const Route = createFileRoute('/server-client')({ + loader: async () => ({ + Server: await getServerClientHydrate(), + }), + component: ServerClientRoute, +}) + +function ServerClientRoute() { + const { Server } = Route.useLoaderData() + return Server +} diff --git a/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateComponents.tsx b/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateComponents.tsx new file mode 100644 index 0000000000..d4e431061a --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateComponents.tsx @@ -0,0 +1,35 @@ +import * as React from 'react' +import { createServerFn } from '@tanstack/react-start' +import { + createCompositeComponent, + renderServerComponent, +} from '@tanstack/react-start/rsc' +import { + CompositeHydrateContent, + CssModuleHydrateContent, + ServerClientHydrateContent, +} from './serverHydrateContent' + +export const getServerClientHydrate = createServerFn({ method: 'GET' }).handler( + async () => { + const renderedAt = new Date().toISOString() + + return renderServerComponent( + , + ) + }, +) + +export const getCompositeHydrate = createServerFn({ method: 'GET' }).handler( + async () => { + return createCompositeComponent((props: { children?: React.ReactNode }) => ( + {props.children} + )) + }, +) + +export const getCssModuleHydrate = createServerFn({ method: 'GET' }).handler( + async () => { + return renderServerComponent() + }, +) diff --git a/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateContent.tsx b/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateContent.tsx new file mode 100644 index 0000000000..dc785a16ce --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/src/server/serverHydrateContent.tsx @@ -0,0 +1,63 @@ +import * as React from 'react' +import { DeferredHydrateIsland } from '../components/DeferredHydrateIsland' +import { CssHydrateIsland } from '../components/CssHydrateIsland' + +export function ServerClientHydrateContent({ + renderedAt, +}: { + renderedAt: string +}) { + return ( +
+ React Server Component +

Server component renders a deferred client island

+

+ Server rendered at . The button below is + present in HTML but stays unhydrated until interaction. +

+ +
+ ) +} + +export function CompositeHydrateContent({ + children, +}: { + children?: React.ReactNode +}) { + return ( +
+ Composite Server Component +

Server shell, client Hydrate slot

+

+ The server owns this descriptive shell. The client slot below remains + server HTML until an interaction reaches it. +

+
+ {children} +
+ ) +} + +export function CssModuleHydrateContent() { + return ( +
+ + Server Component plus CSS module client island + +

CSS module Hydrate boundary

+

+ This server component renders a separate client component that uses + Hydrate and CSS modules. +

+ +
+ ) +} diff --git a/e2e/react-start/rsc-deferred-hydration/tests/hydration.spec.ts b/e2e/react-start/rsc-deferred-hydration/tests/hydration.spec.ts new file mode 100644 index 0000000000..2d543c5406 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/tests/hydration.spec.ts @@ -0,0 +1,82 @@ +import { expect } from '@playwright/test' +import { test } from '@tanstack/router-e2e-utils' +import type { Page } from '@playwright/test' + +async function expectUnhydrated(page: Page, id: string) { + await expect(page.getByTestId(`${id}-button`)).toHaveAttribute( + 'data-hydrated', + 'false', + ) +} + +async function clickAndExpectCount(page: Page, id: string, count: string) { + await expect(page.getByTestId(`${id}-button`)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.getByTestId(`${id}-button`).click() + await expect(page.getByTestId(`${id}-count`)).toHaveText(count) +} + +async function waitForHydrateMarkerToMount(page: Page, id: string) { + await page.waitForFunction((testId) => { + const button = document.querySelector(`[data-testid="${testId}-button"]`) + const marker = button?.closest('[data-ts-hydrate-id]') + return Object.keys(marker ?? {}).some((key) => key.startsWith('__react')) + }, id) +} + +test.describe('RSC deferred hydration', () => { + test('server component renders a client Hydrate island that hydrates on interaction', async ({ + page, + }) => { + await page.goto('/server-client') + + await expect(page.getByTestId('server-client-rsc')).toContainText( + 'Server component renders a deferred client island', + ) + await expect(page.getByTestId('server-client-island')).toContainText( + 'Interaction strategy inside RSC output', + ) + await expectUnhydrated(page, 'server-client') + + await page.getByTestId('server-client-button').hover() + await clickAndExpectCount(page, 'server-client', '1') + }) + + test('composite server component can wrap an interaction Hydrate client island', async ({ + page, + }) => { + await page.goto('/composite') + + await expect(page.getByTestId('composite-rsc')).toContainText( + 'Server shell, client Hydrate slot', + ) + await expect( + page.getByTestId('composite-interaction-island'), + ).toContainText('Interaction strategy inside a composite server component') + await expectUnhydrated(page, 'composite-interaction') + + await waitForHydrateMarkerToMount(page, 'composite-interaction') + await page.getByTestId('composite-interaction-button').hover() + await clickAndExpectCount(page, 'composite-interaction', '1') + }) + + test('server component can render a CSS module Hydrate client island', async ({ + page, + }) => { + await page.goto('/css') + + await expect(page.getByTestId('css-rsc')).toContainText( + 'CSS module Hydrate boundary', + ) + await expect(page.getByTestId('css-module-marker')).toHaveCSS( + 'font-weight', + '900', + ) + await expectUnhydrated(page, 'css-nested') + await waitForHydrateMarkerToMount(page, 'css-nested') + await page.getByTestId('css-nested-button').hover() + await clickAndExpectCount(page, 'css-nested', '1') + }) +}) diff --git a/e2e/react-start/rsc-deferred-hydration/tests/setup/global.setup.ts b/e2e/react-start/rsc-deferred-hydration/tests/setup/global.setup.ts new file mode 100644 index 0000000000..3d1579ee87 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/tests/setup/global.setup.ts @@ -0,0 +1,28 @@ +import { + e2eStartDummyServer, + getTestServerPort, + preOptimizeDevServer, + waitForServer, +} from '@tanstack/router-e2e-utils' +import packageJson from '../../package.json' with { type: 'json' } + +export default async function setup() { + await e2eStartDummyServer(packageJson.name) + + if (process.env.MODE !== 'dev') return + + const port = await getTestServerPort(packageJson.name) + const baseURL = `http://localhost:${port}` + + await waitForServer(baseURL) + await preOptimizeDevServer({ + baseURL, + readyTestId: 'home-heading', + warmup: async (page) => { + for (const route of ['/server-client', '/composite', '/css']) { + await page.goto(`${baseURL}${route}`, { waitUntil: 'domcontentloaded' }) + await page.waitForLoadState('networkidle') + } + }, + }) +} diff --git a/e2e/react-start/rsc-deferred-hydration/tests/setup/global.teardown.ts b/e2e/react-start/rsc-deferred-hydration/tests/setup/global.teardown.ts new file mode 100644 index 0000000000..62fd79911c --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/tests/setup/global.teardown.ts @@ -0,0 +1,6 @@ +import { e2eStopDummyServer } from '@tanstack/router-e2e-utils' +import packageJson from '../../package.json' with { type: 'json' } + +export default async function teardown() { + await e2eStopDummyServer(packageJson.name) +} diff --git a/e2e/react-start/rsc-deferred-hydration/tsconfig.json b/e2e/react-start/rsc-deferred-hydration/tsconfig.json new file mode 100644 index 0000000000..cef9369516 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "include": ["**/*.ts", "**/*.tsx"], + "compilerOptions": { + "strict": true, + "esModuleInterop": true, + "jsx": "react-jsx", + "module": "ESNext", + "moduleResolution": "Bundler", + "lib": ["DOM", "DOM.Iterable", "ES2022"], + "isolatedModules": true, + "resolveJsonModule": true, + "skipLibCheck": true, + "target": "ES2022", + "allowJs": true, + "forceConsistentCasingInFileNames": true, + "paths": { + "~/*": ["./src/*"] + }, + "noEmit": true + } +} diff --git a/e2e/react-start/rsc-deferred-hydration/vite.config.ts b/e2e/react-start/rsc-deferred-hydration/vite.config.ts new file mode 100644 index 0000000000..1919761bc3 --- /dev/null +++ b/e2e/react-start/rsc-deferred-hydration/vite.config.ts @@ -0,0 +1,25 @@ +import { defineConfig } from 'vite' +import { tanstackStart } from '@tanstack/react-start/plugin/vite' +import viteReact from '@vitejs/plugin-react' +import rsc from '@vitejs/plugin-rsc' + +const outDir = process.env.E2E_DIST_DIR ?? 'dist' + +export default defineConfig({ + resolve: { tsconfigPaths: true }, + build: { + outDir, + }, + server: { + port: Number(process.env.VITE_SERVER_PORT ?? 3000), + }, + plugins: [ + tanstackStart({ + rsc: { + enabled: true, + }, + }), + rsc(), + viteReact(), + ], +}) diff --git a/e2e/solid-start/deferred-hydration/.gitignore b/e2e/solid-start/deferred-hydration/.gitignore new file mode 100644 index 0000000000..1b3a07ede1 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/.gitignore @@ -0,0 +1,15 @@ +node_modules +package-lock.json +yarn.lock +.DS_Store +.cache +.env +.vercel +.output +/build/ +/api/ +/server/build +/test-results/ +/playwright-report/ +/blob-report/ +/playwright/.cache/ diff --git a/e2e/solid-start/deferred-hydration/package.json b/e2e/solid-start/deferred-hydration/package.json new file mode 100644 index 0000000000..77f55458fe --- /dev/null +++ b/e2e/solid-start/deferred-hydration/package.json @@ -0,0 +1,56 @@ +{ + "name": "tanstack-solid-start-e2e-deferred-hydration", + "private": true, + "sideEffects": false, + "type": "module", + "scripts": { + "dev": "pnpm dev:vite --port 3000", + "dev:e2e": "pnpm dev:vite", + "dev:vite": "vite dev", + "dev:rsbuild": "rsbuild dev", + "build": "pnpm build:vite", + "build:vite": "vite build && tsc --noEmit", + "build:rsbuild": "rsbuild build && tsc --noEmit", + "preview": "vite preview", + "start": "pnpm start:vite", + "start:vite": "srvx --prod --dir=. -s dist-vite-ssr/client --entry dist-vite-ssr/server/server.js", + "start:rsbuild": "srvx --prod --dir=. -s dist-rsbuild-ssr/client --entry dist-rsbuild-ssr/server/index.js", + "test:e2e": "playwright test --project=chromium" + }, + "dependencies": { + "@tanstack/solid-router": "workspace:^", + "@tanstack/solid-start": "workspace:^", + "solid-js": "^1.9.10", + "vite": "^8.0.0" + }, + "devDependencies": { + "@rsbuild/core": "^2.0.1", + "@rsbuild/plugin-babel": "^1.1.2", + "@rsbuild/plugin-solid": "^1.1.1", + "@tanstack/router-e2e-utils": "workspace:^", + "@types/node": "^22.10.2", + "rolldown": "1.0.0-rc.18", + "srvx": "^0.11.9", + "typescript": "^6.0.2", + "vite-plugin-solid": "^2.11.11" + }, + "nx": { + "targets": { + "test:e2e": { + "parallelism": false + } + }, + "metadata": { + "playwrightModes": [ + { + "toolchain": "vite", + "mode": "ssr" + }, + { + "toolchain": "rsbuild", + "mode": "ssr" + } + ] + } + } +} diff --git a/e2e/solid-start/deferred-hydration/playwright.config.ts b/e2e/solid-start/deferred-hydration/playwright.config.ts new file mode 100644 index 0000000000..ea9e73a856 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/playwright.config.ts @@ -0,0 +1,43 @@ +import fs from 'node:fs' +import { defineConfig, devices } from '@playwright/test' +import { getTestServerPort } from '@tanstack/router-e2e-utils' +import packageJson from './package.json' with { type: 'json' } + +const toolchain = process.env.E2E_TOOLCHAIN ?? 'vite' +const distDir = process.env.E2E_DIST_DIR ?? `dist-${toolchain}-ssr` +const e2ePortKey = + process.env.E2E_PORT_KEY ?? `${packageJson.name}-${toolchain}` +const serverEntryFile = toolchain === 'rsbuild' ? 'index.js' : 'server.js' +const startCommand = `pnpm exec srvx --prod --dir=. -s ${distDir}/client --entry ${distDir}/server/${serverEntryFile}` + +if (process.env.TEST_WORKER_INDEX === undefined) { + fs.rmSync(`port-${e2ePortKey}.txt`, { force: true }) +} + +const PORT = await getTestServerPort(e2ePortKey) +const baseURL = `http://localhost:${PORT}` + +export default defineConfig({ + testDir: './tests', + workers: 1, + reporter: [['line']], + use: { baseURL }, + webServer: { + command: startCommand, + url: baseURL, + reuseExistingServer: !process.env.CI, + stdout: 'pipe', + env: { + E2E_DIST_DIR: distDir, + NODE_ENV: 'production', + PORT: String(PORT), + VITE_SERVER_PORT: String(PORT), + }, + }, + projects: [ + { + name: 'chromium', + use: { ...devices['Desktop Chrome'] }, + }, + ], +}) diff --git a/e2e/solid-start/deferred-hydration/rsbuild.config.ts b/e2e/solid-start/deferred-hydration/rsbuild.config.ts new file mode 100644 index 0000000000..7ab152bb58 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/rsbuild.config.ts @@ -0,0 +1,21 @@ +import { defineConfig } from '@rsbuild/core' +import { pluginBabel } from '@rsbuild/plugin-babel' +import { pluginSolid } from '@rsbuild/plugin-solid' +import { tanstackStart } from '@tanstack/solid-start/plugin/rsbuild' + +const outDir = process.env.E2E_DIST_DIR ?? 'dist-rsbuild-ssr' + +export default defineConfig({ + plugins: [ + pluginBabel({ + include: /\.(?:jsx|tsx)$/, + }), + pluginSolid(), + tanstackStart(), + ], + output: { + distPath: { + root: outDir, + }, + }, +}) diff --git a/e2e/solid-start/deferred-hydration/src/routeTree.gen.ts b/e2e/solid-start/deferred-hydration/src/routeTree.gen.ts new file mode 100644 index 0000000000..e75225b500 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routeTree.gen.ts @@ -0,0 +1,140 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as ImportedRouteImport } from './routes/imported' +import { Route as EnhancedRouteImport } from './routes/enhanced' +import { Route as CssRouteImport } from './routes/css' +import { Route as ComponentsRouteImport } from './routes/components' +import { Route as IndexRouteImport } from './routes/index' + +const ImportedRoute = ImportedRouteImport.update({ + id: '/imported', + path: '/imported', + getParentRoute: () => rootRouteImport, +} as any) +const EnhancedRoute = EnhancedRouteImport.update({ + id: '/enhanced', + path: '/enhanced', + getParentRoute: () => rootRouteImport, +} as any) +const CssRoute = CssRouteImport.update({ + id: '/css', + path: '/css', + getParentRoute: () => rootRouteImport, +} as any) +const ComponentsRoute = ComponentsRouteImport.update({ + id: '/components', + path: '/components', + getParentRoute: () => rootRouteImport, +} as any) +const IndexRoute = IndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => rootRouteImport, +} as any) + +export interface FileRoutesByFullPath { + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute +} +export interface FileRoutesByTo { + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/': typeof IndexRoute + '/components': typeof ComponentsRoute + '/css': typeof CssRoute + '/enhanced': typeof EnhancedRoute + '/imported': typeof ImportedRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: '/' | '/components' | '/css' | '/enhanced' | '/imported' + fileRoutesByTo: FileRoutesByTo + to: '/' | '/components' | '/css' | '/enhanced' | '/imported' + id: '__root__' | '/' | '/components' | '/css' | '/enhanced' | '/imported' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + IndexRoute: typeof IndexRoute + ComponentsRoute: typeof ComponentsRoute + CssRoute: typeof CssRoute + EnhancedRoute: typeof EnhancedRoute + ImportedRoute: typeof ImportedRoute +} + +declare module '@tanstack/solid-router' { + interface FileRoutesByPath { + '/imported': { + id: '/imported' + path: '/imported' + fullPath: '/imported' + preLoaderRoute: typeof ImportedRouteImport + parentRoute: typeof rootRouteImport + } + '/enhanced': { + id: '/enhanced' + path: '/enhanced' + fullPath: '/enhanced' + preLoaderRoute: typeof EnhancedRouteImport + parentRoute: typeof rootRouteImport + } + '/css': { + id: '/css' + path: '/css' + fullPath: '/css' + preLoaderRoute: typeof CssRouteImport + parentRoute: typeof rootRouteImport + } + '/components': { + id: '/components' + path: '/components' + fullPath: '/components' + preLoaderRoute: typeof ComponentsRouteImport + parentRoute: typeof rootRouteImport + } + '/': { + id: '/' + path: '/' + fullPath: '/' + preLoaderRoute: typeof IndexRouteImport + parentRoute: typeof rootRouteImport + } + } +} + +const rootRouteChildren: RootRouteChildren = { + IndexRoute: IndexRoute, + ComponentsRoute: ComponentsRoute, + CssRoute: CssRoute, + EnhancedRoute: EnhancedRoute, + ImportedRoute: ImportedRoute, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() + +import type { getRouter } from './router.tsx' +import type { createStart } from '@tanstack/solid-start' +declare module '@tanstack/solid-start' { + interface Register { + ssr: true + router: Awaited> + } +} diff --git a/e2e/solid-start/deferred-hydration/src/router.tsx b/e2e/solid-start/deferred-hydration/src/router.tsx new file mode 100644 index 0000000000..aa7ead6752 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/router.tsx @@ -0,0 +1,9 @@ +import { createRouter } from '@tanstack/solid-router' +import { routeTree } from './routeTree.gen' + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + }) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/__root.tsx b/e2e/solid-start/deferred-hydration/src/routes/__root.tsx new file mode 100644 index 0000000000..b8c8189c6b --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/__root.tsx @@ -0,0 +1,98 @@ +/// +import { + HeadContent, + Link, + Outlet, + Scripts, + createRootRoute, +} from '@tanstack/solid-router' +import { HydrationScript } from 'solid-js/web' + +export const Route = createRootRoute({ + head: () => ({ + meta: [ + { charSet: 'utf-8' }, + { name: 'viewport', content: 'width=device-width, initial-scale=1' }, + { title: 'Deferred Hydration E2E' }, + ], + }), + component: RootDocument, +}) + +function RootDocument() { + return ( + + + + + + + + +
+ +
+ + + + ) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/components.tsx b/e2e/solid-start/deferred-hydration/src/routes/components.tsx new file mode 100644 index 0000000000..9dd6387f09 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/components.tsx @@ -0,0 +1,171 @@ +import * as Solid from 'solid-js' + +import { createFileRoute } from '@tanstack/solid-router' +import { Hydrate } from '@tanstack/solid-start' +import { + condition, + idle, + interaction, + load, + media, + never, + visible, +} from '@tanstack/solid-start/hydration' + +export const Route = createFileRoute('/components')({ + component: ComponentHydrationPage, +}) + +function InteractiveBox(props: { id: string; label: string }) { + const [count, setCount] = Solid.createSignal(0) + const [hydrated, setHydrated] = Solid.createSignal(false) + + Solid.onMount(() => { + setHydrated(true) + }) + + return ( + + ) +} + +function DelayedFallbackBox() { + if (typeof window !== 'undefined') { + const [ready] = Solid.createResource(async () => { + await new Promise((resolve) => window.setTimeout(resolve, 1000)) + return true + }) + + return ( + +
fallback child
+
+ ) + } + + return
fallback child
+} + +function ComponentHydrationPage() { + const [hydratedCallbacks, setHydratedCallbacks] = Solid.createSignal(0) + const [conditionReady, setConditionReady] = Solid.createSignal(false) + const [showClientFallbackBoundary, setShowClientFallbackBoundary] = + Solid.createSignal(false) + + return ( +
+

Component Deferred Hydration

+
+ Manual test guide + + Pink buttons are server HTML that has not hydrated yet. Green buttons + have hydrated and should increment when clicked. Follow the notes + below to trigger each strategy intentionally. + +
+

{hydratedCallbacks()}

+

+ load and idle should become green + without interaction shortly after the page loads. +

+ + + + + + +
Scroll down to reveal the visible boundary
+

+ visible hydrates only after this button enters the + viewport. +

+ + + +

+ media hydrates when (min-width: 1px) + matches. interaction hydrates on hover, focus, pointer + down, or click intent. +

+ + + + + + +

+ Custom interaction boundaries below hydrate only for their configured + events: double-click for the single-event example, and right-click or + double-click for the multi-event example. The prefetch example should + download code on hover but hydrate on click. +

+ setHydratedCallbacks((count) => count + 1)} + > + + + + + + + + + + + + + + + + + + + + + + + +

+ never stays as server HTML forever on the initial page, + so clicking should not increment it. +

+ + + client fallback + } + > + + + +
+ ) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/css.tsx b/e2e/solid-start/deferred-hydration/src/routes/css.tsx new file mode 100644 index 0000000000..c1a80d492b --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/css.tsx @@ -0,0 +1,57 @@ +import { createFileRoute } from '@tanstack/solid-router' +import { Hydrate } from '@tanstack/solid-start' +import { media, never, visible } from '@tanstack/solid-start/hydration' +import outerStyles from './css/outer.module.css' +import deferredStyles from './css/deferred-only.module.css' +import sharedStyles from './css/shared.module.css' + +export const Route = createFileRoute('/css')({ + component: CssHydrationPage, +}) + +function CssHydrationPage() { + return ( +
+
+

+ CSS Deferred Hydration +

+

+ CSS from deferred, never, shared, and nested Hydrate boundaries should + be available even before the client JavaScript hydrates those islands. +

+
+
+
+ Outer CSS +
+
+ Shared outer CSS +
+
+ +
+ Deferred CSS +
+
+ +
+ Never CSS +
+
+ + +
+ Nested CSS +
+
+
+
+ ) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/css/deferred-only.module.css b/e2e/solid-start/deferred-hydration/src/routes/css/deferred-only.module.css new file mode 100644 index 0000000000..05eafda03c --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/css/deferred-only.module.css @@ -0,0 +1,15 @@ +.deferredBox { + background-color: rgb(23, 45, 67); + color: rgb(255, 255, 255); + padding: 12px; +} + +.neverBox { + color: rgb(45, 67, 89); + padding: 12px; +} + +.nestedBox { + border-left: 5px solid rgb(67, 89, 123); + padding-left: 12px; +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/css/outer.module.css b/e2e/solid-start/deferred-hydration/src/routes/css/outer.module.css new file mode 100644 index 0000000000..98ca5e0934 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/css/outer.module.css @@ -0,0 +1,9 @@ +.heading { + color: rgb(11, 31, 53); +} + +.outerBox { + background-color: rgb(242, 250, 255); + color: rgb(12, 34, 56); + padding: 12px; +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/css/shared.module.css b/e2e/solid-start/deferred-hydration/src/routes/css/shared.module.css new file mode 100644 index 0000000000..020da5d7ad --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/css/shared.module.css @@ -0,0 +1,4 @@ +.sharedBox { + border-top: 4px solid rgb(98, 76, 54); + margin-top: 8px; +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/enhanced.tsx b/e2e/solid-start/deferred-hydration/src/routes/enhanced.tsx new file mode 100644 index 0000000000..d699a644f1 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/enhanced.tsx @@ -0,0 +1,316 @@ +import { Show, createSignal, onMount, type JSX } from 'solid-js' +import { createFileRoute } from '@tanstack/solid-router' +import { Hydrate } from '@tanstack/solid-start' +import { interaction, media } from '@tanstack/solid-start/hydration' +import { EnhancedNestedWidget } from '../shared/EnhancedNestedWidget' + +type EnhancedSearch = { + dynamic?: 'interaction' +} + +export const Route = createFileRoute('/enhanced')({ + validateSearch: (search: Record): EnhancedSearch => ({ + dynamic: search.dynamic === 'interaction' ? 'interaction' : undefined, + }), + component: EnhancedHydrationPage, +}) + +type DeferredGate = { + promise: Promise + resolve: () => void +} + +const clickIntent = interaction({ events: 'click' }) +const pointerOverIntent = interaction({ events: 'pointerover' }) +const doubleClickIntent = interaction({ events: 'dblclick' }) + +function createDeferredGate(): DeferredGate { + let resolve!: () => void + const promise = new Promise((next) => { + resolve = next + }) + return { promise, resolve } +} + +function InteractiveBox(props: { id: string; label: string }): JSX.Element { + const [count, setCount] = createSignal(0) + const [hydrated, setHydrated] = createSignal(false) + + onMount(() => { + setHydrated(true) + }) + + return ( + + ) +} + +function DynamicWhenExamples(): JSX.Element { + const search = Route.useSearch() + const searchDrivenHydration = () => + search().dynamic === 'interaction' ? clickIntent : doubleClickIntent + + return ( + <> +

+ Dynamic callbacks are client-only. The first boundary always hydrates on + click; the second reads typed router search state before choosing its + interaction event. +

+ clickIntent}> + + + + + + + ) +} + +function SplitPrefetchExample(): JSX.Element { + const gate = createDeferredGate() + const [waitReason, setWaitReason] = createSignal('idle') + const [preloadStatus, setPreloadStatus] = createSignal('idle') + const [queryStatus, setQueryStatus] = createSignal('idle') + + return ( + <> +

{waitReason()}

+

{preloadStatus()}

+

{queryStatus()}

+ + { + setQueryStatus(element ? 'element' : 'missing-element') + setWaitReason('waiting') + + const reason = await waitFor(pointerOverIntent) + setWaitReason(reason) + if (reason === 'abort' || signal.aborted) return + + await preload() + setPreloadStatus('done') + await gate.promise + setQueryStatus('done') + }} + > + + + + ) +} + +function FireAndForgetPrefetchExample(): JSX.Element { + const gate = createDeferredGate() + const [waitReason, setWaitReason] = createSignal('idle') + const [workStatus, setWorkStatus] = createSignal('idle') + const [queryStatus, setQueryStatus] = createSignal('idle') + + return ( + <> +

{workStatus()}

+

{waitReason()}

+

{queryStatus()}

+ + { + setWaitReason('waiting') + void waitFor(pointerOverIntent).then((reason) => { + setWaitReason(reason) + if (reason === 'abort') return + + setWorkStatus('started') + void gate.promise.then(() => { + setQueryStatus('done') + }) + }) + }} + > + + + + ) +} + +function HydrateFirstPrefetchExample(): JSX.Element { + const [reason, setReason] = createSignal('idle') + + return ( + <> +

{reason()}

+ { + setReason(await waitFor(doubleClickIntent)) + }} + > + + + + ) +} + +function RuntimeOnlyPrefetchExample(): JSX.Element { + const gate = createDeferredGate() + const [waitReason, setWaitReason] = createSignal('idle') + const [runtimeStatus, setRuntimeStatus] = createSignal('idle') + + return ( + <> +

{waitReason()}

+

{runtimeStatus()}

+ + { + setWaitReason('waiting') + const reason = await waitFor(pointerOverIntent) + setWaitReason(reason) + if (reason === 'abort') return + + await gate.promise + await preload() + setRuntimeStatus('ready') + }} + > + + + + ) +} + +function WaitForAbortExample(): JSX.Element { + const [showBoundary, setShowBoundary] = createSignal(true) + const [reason, setReason] = createSignal('idle') + + return ( + <> +

{reason()}

+ + + { + setReason('waiting') + setReason(await waitFor(pointerOverIntent)) + }} + > + + + + + ) +} + +function SignalAbortExample(): JSX.Element { + const [showBoundary, setShowBoundary] = createSignal(true) + const [status, setStatus] = createSignal('idle') + + return ( + <> +

{status()}

+ + + { + setStatus('listening') + await new Promise((resolve) => { + const onAbort = () => { + setStatus('aborted') + resolve() + } + + if (signal.aborted) { + onAbort() + return + } + + signal.addEventListener('abort', onAbort, { once: true }) + }) + }} + > + + + + + ) +} + +function NestedDynamicExamples(): JSX.Element { + return ( + <> + + clickIntent}> + + + + + + ) +} + +function EnhancedHydrationPage(): JSX.Element { + return ( +
+

Enhanced Hydrate APIs

+ + + + + + + + +
+ ) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/imported.tsx b/e2e/solid-start/deferred-hydration/src/routes/imported.tsx new file mode 100644 index 0000000000..abfb827c91 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/imported.tsx @@ -0,0 +1,15 @@ +import { createFileRoute } from '@tanstack/solid-router' +import { ImportedHydrateWidget } from '../shared/ImportedHydrateWidget' + +export const Route = createFileRoute('/imported')({ + component: ImportedHydrationPage, +}) + +function ImportedHydrationPage() { + return ( +
+

Imported Hydrate

+ +
+ ) +} diff --git a/e2e/solid-start/deferred-hydration/src/routes/index.tsx b/e2e/solid-start/deferred-hydration/src/routes/index.tsx new file mode 100644 index 0000000000..61fbf7f6dc --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/routes/index.tsx @@ -0,0 +1,23 @@ +import { Link, createFileRoute } from '@tanstack/solid-router' + +export const Route = createFileRoute('/')({ + component: Home, +}) + +function Home() { + return ( +
+

Deferred Hydration

+

Component strategies

+ component strategies +

CSS

+ CSS deferred hydration +

Imported component

+ + imported Hydrate + +

Enhanced APIs

+ enhanced Hydrate APIs +
+ ) +} diff --git a/e2e/solid-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx b/e2e/solid-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx new file mode 100644 index 0000000000..e595e38da8 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/shared/EnhancedNestedWidget.tsx @@ -0,0 +1,33 @@ +import { createSignal, onMount } from 'solid-js' +import { Hydrate } from '@tanstack/solid-start' +import { interaction, media } from '@tanstack/solid-start/hydration' + +function CrossFileNestedButton() { + const [count, setCount] = createSignal(0) + const [hydrated, setHydrated] = createSignal(false) + + onMount(() => { + setHydrated(true) + }) + + return ( + + ) +} + +export function EnhancedNestedWidget() { + return ( + + + + + + ) +} diff --git a/e2e/solid-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx b/e2e/solid-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx new file mode 100644 index 0000000000..859b741755 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/src/shared/ImportedHydrateWidget.tsx @@ -0,0 +1,34 @@ +import { createSignal } from 'solid-js' + +import { Hydrate } from '@tanstack/solid-start' +import { media } from '@tanstack/solid-start/hydration' + +function ImportedHydrateChild() { + const [count, setCount] = createSignal(0) + + return ( + + ) +} + +export function ImportedHydrateWidget() { + return ( + + imported hydrate fallback + + } + > + + + ) +} diff --git a/e2e/solid-start/deferred-hydration/tests/hydration.spec.ts b/e2e/solid-start/deferred-hydration/tests/hydration.spec.ts new file mode 100644 index 0000000000..dff2357837 --- /dev/null +++ b/e2e/solid-start/deferred-hydration/tests/hydration.spec.ts @@ -0,0 +1,909 @@ +import { expect } from '@playwright/test' +import { test } from '@tanstack/router-e2e-utils' +import type { APIRequestContext, Page } from '@playwright/test' + +async function clickAndExpectCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(countTestId)).toHaveText(count) +} + +async function clickIntentAndExpectReplayedCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await expect(page.getByTestId(countTestId)).toHaveText(count) +} + +async function clickToHydrateThenClickAndExpectIncrement( + page: Page, + buttonTestId: string, + countTestId: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.getByTestId(buttonTestId).click() + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'true', + ) + const previousCount = Number( + await page.getByTestId(countTestId).textContent(), + ) + await page.getByTestId(buttonTestId).click() + await expect + .poll(async () => Number(await page.getByTestId(countTestId).textContent())) + .toBe(previousCount + 1) +} + +async function hoverIntentAndExpectCount( + page: Page, + buttonTestId: string, + countTestId: string, + count: string, +) { + await expectRouteToStayUnhydrated(page, buttonTestId) + await page.mouse.move(0, 0) + await page.getByTestId(buttonTestId).hover() + await clickAndExpectCount(page, buttonTestId, countTestId, count) +} + +async function dispatchHydrationIntent( + page: Page, + buttonTestId: string, + eventName: string, +) { + await page.getByTestId(buttonTestId).evaluate((element, eventName) => { + const marker = element.closest('[data-ts-hydrate-id]') + + if (!marker) { + throw new Error('Expected Hydrate marker to exist') + } + + marker.dispatchEvent( + new Event(eventName, { bubbles: true, cancelable: true }), + ) + }, eventName) +} + +async function trackBoundaryStability(page: Page, buttonTestId: string) { + await page.getByTestId(buttonTestId).evaluate((element, testId) => { + const marker = element.closest('[data-ts-hydrate-id]') + + if (!(marker instanceof HTMLElement)) { + throw new Error('Expected Hydrate marker to exist') + } + + const win = window as typeof window & { + __hydrateBoundaryVisualGapCount?: number + __hydrateBoundaryMaxScrollDelta?: number + __hydrateBoundaryStabilityDone?: boolean + } + const hasBoundaryButton = () => + Array.from(marker.querySelectorAll('[data-testid]')).some( + (child) => child.getAttribute('data-testid') === testId, + ) + const hasHydratedBoundaryButton = () => + Array.from(marker.querySelectorAll('[data-testid]')).some( + (child) => + child.getAttribute('data-testid') === testId && + child.getAttribute('data-hydrated') === 'true', + ) + const initialScrollY = window.scrollY + + win.__hydrateBoundaryVisualGapCount = 0 + win.__hydrateBoundaryMaxScrollDelta = 0 + win.__hydrateBoundaryStabilityDone = false + + let frameCount = 0 + let hydratedFrameCount = 0 + let observer: MutationObserver | undefined + const recordScroll = () => { + win.__hydrateBoundaryMaxScrollDelta = Math.max( + win.__hydrateBoundaryMaxScrollDelta ?? 0, + Math.abs(window.scrollY - initialScrollY), + ) + + if (hasHydratedBoundaryButton()) hydratedFrameCount++ + + frameCount++ + if (hydratedFrameCount >= 10 || frameCount >= 300) { + observer?.disconnect() + win.__hydrateBoundaryStabilityDone = true + return + } + + requestAnimationFrame(recordScroll) + } + + observer = new MutationObserver(() => { + if (!hasBoundaryButton()) { + win.__hydrateBoundaryVisualGapCount!++ + } + }) + observer.observe(marker, { childList: true }) + + requestAnimationFrame(recordScroll) + }, buttonTestId) +} + +async function expectBoundaryStable(page: Page) { + await expect + .poll(() => + page.evaluate( + () => + ( + window as typeof window & { + __hydrateBoundaryStabilityDone?: boolean + } + ).__hydrateBoundaryStabilityDone ?? false, + ), + ) + .toBe(true) + await expect + .poll(() => + page.evaluate( + () => + ( + window as typeof window & { + __hydrateBoundaryVisualGapCount?: number + } + ).__hydrateBoundaryVisualGapCount ?? 0, + ), + ) + .toBe(0) + await expect + .poll(() => + page.evaluate( + () => + ( + window as typeof window & { + __hydrateBoundaryMaxScrollDelta?: number + } + ).__hydrateBoundaryMaxScrollDelta ?? 0, + ), + ) + .toBeLessThanOrEqual(1) +} + +async function expectRouteToStayUnhydrated( + page: Page, + buttonTestId: string, + duration = 250, +) { + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await page.waitForTimeout(duration) + await expect(page.getByTestId(buttonTestId)).toHaveAttribute( + 'data-hydrated', + 'false', + ) +} + +async function scrollToBoundary(page: Page, buttonTestId: string) { + const button = page.getByTestId(buttonTestId) + for (let attempt = 0; attempt < 3; attempt++) { + await button.evaluate((element) => { + element.scrollIntoView({ block: 'center', inline: 'nearest' }) + }) + + await page.waitForTimeout(100) + const isVisible = await button.evaluate((element) => { + const rect = element.getBoundingClientRect() + return rect.bottom > 0 && rect.top < window.innerHeight + }) + + if (isVisible) return + } + + await expect(button).toBeInViewport() +} + +async function expectCssProperty( + page: Page, + testId: string, + property: string, + value: string, +) { + await expect + .poll(() => + page.getByTestId(testId).evaluate((element, propertyName) => { + return getComputedStyle(element).getPropertyValue(propertyName) + }, property), + ) + .toBe(value) +} + +function htmlContainsText(html: string, text: string) { + const pattern = text.split(' ').join('(?:\\s|)+') + expect(html).toMatch(new RegExp(pattern)) +} + +function getModulePreloadHrefs(html: string) { + return Array.from(html.matchAll(/]*>/g), (match) => match[0]) + .filter((tag) => /\brel="modulepreload"/.test(tag)) + .map((tag) => tag.match(/\bhref="([^"]+)"/)?.[1]) + .filter((href): href is string => !!href) +} + +async function modulePreloadContentsContain( + request: APIRequestContext, + hrefs: Array, + marker: string, +) { + for (const href of hrefs) { + const response = await request.get(href) + if (!response.ok()) continue + + const text = await response.text() + if (text.includes(marker)) return true + } + + return false +} + +async function resourceContentsContain( + page: Page, + request: APIRequestContext, + marker: string, + filter: (url: string) => boolean, +) { + const resourceUrls = await page.evaluate(() => + performance.getEntriesByType('resource').map((entry) => entry.name), + ) + + return modulePreloadContentsContain( + request, + resourceUrls.filter(filter), + marker, + ) +} + +async function documentModulePreloadHrefs(page: Page) { + return page.evaluate(() => + Array.from( + document.querySelectorAll('link[rel~="modulepreload"]'), + (link) => link.href, + ), + ) +} + +function isHydrateBoundaryResource(url: string) { + return ( + url.includes('/assets/components-') || url.includes('/static/js/async/') + ) +} + +function isClientJavaScriptResource(url: string) { + return ( + url.includes('/assets/') || + url.includes('/static/js/') || + url.includes('/static/js/async/') + ) +} + +async function expectClientRouterReady(page: Page) { + await expect + .poll(() => + page.evaluate(() => + Boolean( + ( + globalThis as typeof globalThis & { + __TSR_ROUTER__?: unknown + } + ).__TSR_ROUTER__, + ), + ), + ) + .toBe(true) +} + +async function gotoEnhanced(page: Page, search = '') { + await page.goto(`/enhanced${search}`) + await expectClientRouterReady(page) +} + +test.describe('component-level Hydrate runtime strategies', () => { + test('renders SSR HTML and hydrates each runtime when appropriately', async ({ + page, + request, + }) => { + await page.goto('/components') + + await expect(page.getByTestId('component-heading')).toHaveText( + 'Component Deferred Hydration', + ) + + await clickAndExpectCount( + page, + 'component-load-button', + 'component-load-count', + '1', + ) + await clickAndExpectCount( + page, + 'component-idle-button', + 'component-idle-count', + '1', + ) + await expect( + resourceContentsContain(page, request, 'component-visible', (url) => + isHydrateBoundaryResource(url), + ), + ).resolves.toBe(false) + await expectRouteToStayUnhydrated(page, 'component-visible-button') + await scrollToBoundary(page, 'component-visible-button') + await clickAndExpectCount( + page, + 'component-visible-button', + 'component-visible-count', + '1', + ) + await expect + .poll(() => + resourceContentsContain(page, request, 'component-visible', (url) => + isHydrateBoundaryResource(url), + ), + ) + .toBe(true) + await clickAndExpectCount( + page, + 'component-media-button', + 'component-media-count', + '1', + ) + await hoverIntentAndExpectCount( + page, + 'component-interaction-button', + 'component-interaction-count', + '1', + ) + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '0', + ) + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await page.getByTestId('component-custom-single-button').hover() + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await page.getByTestId('component-custom-single-button').click() + await expectRouteToStayUnhydrated(page, 'component-custom-single-button') + await dispatchHydrationIntent( + page, + 'component-custom-single-button', + 'dblclick', + ) + await expect( + page.getByTestId('component-custom-single-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '1', + ) + await clickAndExpectCount( + page, + 'component-custom-single-button', + 'component-custom-single-count', + '1', + ) + await expect(page.getByTestId('component-on-hydrated-count')).toHaveText( + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-custom-multi-button') + await dispatchHydrationIntent( + page, + 'component-custom-multi-button', + 'contextmenu', + ) + await clickAndExpectCount( + page, + 'component-custom-multi-button', + 'component-custom-multi-count', + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-condition-button') + await page.getByTestId('component-enable-condition').click() + await clickAndExpectCount( + page, + 'component-condition-button', + 'component-condition-count', + '1', + ) + await scrollToBoundary(page, 'component-click-replay-button') + await expectRouteToStayUnhydrated(page, 'component-click-replay-button') + await trackBoundaryStability(page, 'component-click-replay-button') + await page.getByTestId('component-click-replay-button').click() + await expect( + page.getByTestId('component-click-replay-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expectBoundaryStable(page) + await expect(page.getByTestId('component-click-replay-count')).toHaveText( + '1', + ) + await expectRouteToStayUnhydrated(page, 'component-prefetch-button') + await expect( + resourceContentsContain(page, request, 'component-prefetch', (url) => + isHydrateBoundaryResource(url), + ), + ).resolves.toBe(false) + await page.mouse.move(0, 0) + await page.getByTestId('component-prefetch-button').hover() + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await expect + .poll(() => + resourceContentsContain(page, request, 'component-prefetch', (url) => + isHydrateBoundaryResource(url), + ), + ) + .toBe(true) + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'false', + ) + await page.getByTestId('component-prefetch-button').click() + await expect(page.getByTestId('component-prefetch-button')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await expect(page.getByTestId('component-prefetch-count')).toHaveText('1') + await hoverIntentAndExpectCount( + page, + 'component-nested-child-button', + 'component-nested-child-count', + '1', + ) + + await page.getByTestId('component-never-button').click() + await expect(page.getByTestId('component-never-count')).toHaveText('0') + }) + + test('replays click after another interaction boundary hydrates first', async ({ + page, + }) => { + await page.goto('/components') + await expectClientRouterReady(page) + + await scrollToBoundary(page, 'component-custom-multi-button') + await expectRouteToStayUnhydrated(page, 'component-custom-multi-button') + await page.getByTestId('component-custom-multi-button').click({ + button: 'right', + }) + await expect( + page.getByTestId('component-custom-multi-button'), + ).toHaveAttribute('data-hydrated', 'true') + + await scrollToBoundary(page, 'component-click-replay-button') + await expectRouteToStayUnhydrated(page, 'component-click-replay-button') + await trackBoundaryStability(page, 'component-click-replay-button') + await page.getByTestId('component-click-replay-button').click() + await expect( + page.getByTestId('component-click-replay-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expectBoundaryStable(page) + await expect(page.getByTestId('component-click-replay-count')).toHaveText( + '1', + ) + }) + + test('keeps bottom scroll stable when a condition boundary hydrates', async ({ + page, + }) => { + await page.goto('/components') + await expectClientRouterReady(page) + await expectRouteToStayUnhydrated(page, 'component-condition-button') + + await page.evaluate(() => { + window.scrollTo(0, document.documentElement.scrollHeight) + }) + await page.waitForTimeout(100) + await expect( + page.getByTestId('component-enable-condition'), + ).toBeInViewport() + + await trackBoundaryStability(page, 'component-condition-button') + await page.getByTestId('component-enable-condition').click() + await expect( + page.getByTestId('component-condition-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expectBoundaryStable(page) + await clickAndExpectCount( + page, + 'component-condition-button', + 'component-condition-count', + '1', + ) + }) + + test('shows fallback during a client-only mount while the child suspends', async ({ + page, + }) => { + await page.goto('/components') + await expect(page.getByTestId('component-load-button')).toHaveAttribute( + 'data-hydrated', + 'true', + ) + await page.getByTestId('component-show-client-fallback').click() + + await expect(page.getByTestId('component-client-fallback')).toHaveText( + 'client fallback', + ) + await expect(page.getByTestId('component-fallback-child')).toHaveText( + 'fallback child', + ) + await expect(page.getByTestId('component-client-fallback')).toHaveCount(0) + }) +}) + +test.describe('enhanced Hydrate API combinations', () => { + test('server renders dynamic markers without evaluating client-only callbacks or prefetch functions', async ({ + request, + }) => { + const response = await request.get('/enhanced?dynamic=interaction') + const html = await response.text() + + expect(response.ok()).toBe(true) + htmlContainsText(html, 'Enhanced Hydrate APIs') + htmlContainsText(html, 'conditional dynamic') + expect(html).toContain('data-ts-hydrate-when="dynamic"') + expect(html).not.toContain('missing-element') + }) + + test('dynamic when functions hydrate and replay interaction events', async ({ + page, + }) => { + await gotoEnhanced(page, '?dynamic=interaction') + await expect(page.getByTestId('enhanced-heading')).toHaveText( + 'Enhanced Hydrate APIs', + ) + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-dynamic-interaction-button', + 'enhanced-dynamic-interaction-count', + '1', + ) + + await expectRouteToStayUnhydrated( + page, + 'enhanced-dynamic-conditional-button', + ) + await page.getByTestId('enhanced-dynamic-conditional-button').hover() + await expectRouteToStayUnhydrated( + page, + 'enhanced-dynamic-conditional-button', + ) + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-dynamic-conditional-button', + 'enhanced-dynamic-conditional-count', + '1', + ) + }) + + test('procedural prefetch can block hydration, preload the split chunk, and prepare query-like work', async ({ + page, + request, + }) => { + await gotoEnhanced(page) + await expect( + resourceContentsContain( + page, + request, + 'enhanced-procedural-split-child', + isClientJavaScriptResource, + ), + ).resolves.toBe(false) + + await expectRouteToStayUnhydrated(page, 'enhanced-procedural-split-button') + await expect(page.getByTestId('enhanced-split-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-procedural-split-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-split-query')).toHaveText('element') + await expect(page.getByTestId('enhanced-split-wait-reason')).toHaveText( + 'prefetch', + ) + await expect(page.getByTestId('enhanced-split-preload')).toHaveText('done') + await expect + .poll(() => + resourceContentsContain( + page, + request, + 'enhanced-procedural-split-child', + isClientJavaScriptResource, + ), + ) + .toBe(true) + + await page.getByTestId('enhanced-procedural-split-button').click() + await expect( + page.getByTestId('enhanced-procedural-split-button'), + ).toHaveAttribute('data-hydrated', 'false') + await expect( + page.getByTestId('enhanced-procedural-split-count'), + ).toHaveText('0') + await page.getByTestId('enhanced-release-split-prefetch').click() + await expect( + page.getByTestId('enhanced-procedural-split-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect( + page.getByTestId('enhanced-procedural-split-count'), + ).toHaveText('1') + await expect(page.getByTestId('enhanced-split-query')).toHaveText('done') + }) + + test('function prefetch supports fire-and-forget work and waitFor hydrate-first resolution', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expect(page.getByTestId('enhanced-fire-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-fire-and-forget-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-fire-wait-reason')).toHaveText( + 'prefetch', + ) + await expect(page.getByTestId('enhanced-fire-status')).toHaveText('started') + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-fire-and-forget-button', + 'enhanced-fire-and-forget-count', + '1', + ) + await expect(page.getByTestId('enhanced-fire-query')).toHaveText('idle') + await page.getByTestId('enhanced-release-fire-prefetch').click() + await expect(page.getByTestId('enhanced-fire-query')).toHaveText('done') + + await clickIntentAndExpectReplayedCount( + page, + 'enhanced-hydrate-first-button', + 'enhanced-hydrate-first-count', + '1', + ) + await expect(page.getByTestId('enhanced-hydrate-first-reason')).toHaveText( + 'hydrate', + ) + }) + + test('split=false procedural prefetch blocks hydration without requiring a child preload chunk', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expectRouteToStayUnhydrated(page, 'enhanced-runtime-only-button') + await expect(page.getByTestId('enhanced-runtime-wait-reason')).toHaveText( + 'waiting', + ) + await dispatchHydrationIntent( + page, + 'enhanced-runtime-only-button', + 'pointerover', + ) + await expect(page.getByTestId('enhanced-runtime-wait-reason')).toHaveText( + 'prefetch', + ) + await page.getByTestId('enhanced-runtime-only-button').click() + await expect( + page.getByTestId('enhanced-runtime-only-button'), + ).toHaveAttribute('data-hydrated', 'false') + await expect(page.getByTestId('enhanced-runtime-only-count')).toHaveText( + '0', + ) + await page.getByTestId('enhanced-release-runtime-prefetch').click() + await expect(page.getByTestId('enhanced-runtime-status')).toHaveText( + 'ready', + ) + await expect( + page.getByTestId('enhanced-runtime-only-button'), + ).toHaveAttribute('data-hydrated', 'true') + await expect(page.getByTestId('enhanced-runtime-only-count')).toHaveText( + '1', + ) + }) + + test('procedural prefetch aborts waiters and signals when boundaries unmount', async ({ + page, + }) => { + await gotoEnhanced(page) + + await expectRouteToStayUnhydrated(page, 'enhanced-wait-abort-button') + await expect(page.getByTestId('enhanced-wait-abort-reason')).toHaveText( + 'waiting', + ) + await page.getByTestId('enhanced-hide-wait-abort').click() + await expect(page.getByTestId('enhanced-wait-abort-reason')).toHaveText( + 'abort', + ) + + await expect(page.getByTestId('enhanced-abort-status')).toHaveText( + 'listening', + ) + await page.getByTestId('enhanced-hide-abort').click() + await expect(page.getByTestId('enhanced-abort-status')).toHaveText( + 'aborted', + ) + }) + + test('nested dynamic interaction boundaries delegate through outer boundaries', async ({ + page, + }) => { + await gotoEnhanced(page) + + await clickToHydrateThenClickAndExpectIncrement( + page, + 'enhanced-dynamic-nested-button', + 'enhanced-dynamic-nested-count', + ) + await clickToHydrateThenClickAndExpectIncrement( + page, + 'enhanced-cross-file-nested-button', + 'enhanced-cross-file-nested-count', + ) + }) +}) + +test.describe('Hydrate CSS delivery', () => { + test('ships CSS for deferred, never, shared, and nested boundaries without JavaScript', async ({ + browser, + request, + }) => { + const response = await request.get('/css') + const html = await response.text() + + htmlContainsText(html, 'CSS Deferred Hydration') + htmlContainsText(html, 'Outer CSS') + htmlContainsText(html, 'Deferred CSS') + htmlContainsText(html, 'Never CSS') + htmlContainsText(html, 'Nested CSS') + + const context = await browser.newContext({ javaScriptEnabled: false }) + const page = await context.newPage() + + try { + await page.goto('/css') + + await expect(page.getByTestId('css-heading')).toHaveText( + 'CSS Deferred Hydration', + ) + await expect(page.getByTestId('css-deferred')).toHaveText('Deferred CSS') + await expect(page.getByTestId('css-never')).toHaveText('Never CSS') + await expect(page.getByTestId('css-nested')).toHaveText('Nested CSS') + + await expectCssProperty(page, 'css-outer', 'color', 'rgb(12, 34, 56)') + await expectCssProperty( + page, + 'css-deferred', + 'background-color', + 'rgb(23, 45, 67)', + ) + await expectCssProperty(page, 'css-never', 'color', 'rgb(45, 67, 89)') + await expectCssProperty( + page, + 'css-shared-outer', + 'border-top-color', + 'rgb(98, 76, 54)', + ) + await expectCssProperty( + page, + 'css-deferred', + 'border-top-color', + 'rgb(98, 76, 54)', + ) + await expectCssProperty( + page, + 'css-nested', + 'border-left-color', + 'rgb(67, 89, 123)', + ) + await expectCssProperty(page, 'css-nested', 'border-left-width', '5px') + } finally { + await context.close() + } + }) + + test('renders deferred content and omits never content after client-side navigation', async ({ + page, + }) => { + await page.goto('/') + await expectClientRouterReady(page) + await page.getByRole('link', { name: 'CSS', exact: true }).click() + await expect(page).toHaveURL(/\/css$/) + + await expect(page.getByTestId('css-heading')).toHaveText( + 'CSS Deferred Hydration', + ) + await expect(page.getByTestId('css-deferred')).toHaveText('Deferred CSS') + await expect(page.getByTestId('css-never')).toHaveCount(0) + await expect(page.getByTestId('css-nested')).toHaveCount(0) + + await expectCssProperty( + page, + 'css-deferred', + 'background-color', + 'rgb(23, 45, 67)', + ) + }) +}) + +test.describe('imported Hydrate boundaries', () => { + test('does not emit filtered shared Hydrate child JS on the initial document', async ({ + request, + }) => { + const response = await request.get('/imported') + const html = await response.text() + + htmlContainsText(html, 'Imported Hydrate') + htmlContainsText(html, 'Imported Hydrate Child') + + await expect( + modulePreloadContentsContain( + request, + getModulePreloadHrefs(html), + 'imported-hydrate-child', + ), + ).resolves.toBe(false) + }) + + test('does not preload Hydrate child chunks before client navigation', async ({ + page, + request, + }) => { + await page.goto('/') + await expect(page.getByTestId('home-heading')).toHaveText( + 'Deferred Hydration', + ) + await expectClientRouterReady(page) + + const link = page.getByRole('link', { name: 'imported Hydrate' }) + await page.mouse.move(0, 0) + await link.hover() + await link.focus() + + await expect( + modulePreloadContentsContain( + request, + await documentModulePreloadHrefs(page), + 'imported-hydrate-child', + ), + ).resolves.toBe(false) + await expect( + resourceContentsContain(page, request, 'imported-hydrate-child', (url) => + isClientJavaScriptResource(url), + ), + ).resolves.toBe(false) + + await page.getByRole('link', { name: 'imported Hydrate' }).click() + await expect(page).toHaveURL(/\/imported$/) + await expect(page.getByTestId('imported-hydrate-fallback')).toHaveCount(0) + await expect(page.getByTestId('imported-hydrate-child')).toContainText( + 'Imported Hydrate Child', + ) + await page.getByTestId('imported-hydrate-child').click() + await expect(page.getByTestId('imported-hydrate-count')).toHaveText('1') + }) +}) diff --git a/e2e/solid-start/deferred-hydration/tsconfig.json b/e2e/solid-start/deferred-hydration/tsconfig.json new file mode 100644 index 0000000000..76cf3401fa --- /dev/null +++ b/e2e/solid-start/deferred-hydration/tsconfig.json @@ -0,0 +1,23 @@ +{ + "include": ["**/*.ts", "**/*.tsx"], + "compilerOptions": { + "strict": true, + "esModuleInterop": true, + "jsx": "preserve", + "jsxImportSource": "solid-js", + "module": "ESNext", + "moduleResolution": "Bundler", + "lib": ["DOM", "DOM.Iterable", "ES2022"], + "isolatedModules": true, + "resolveJsonModule": true, + "skipLibCheck": true, + "target": "ES2024", + "allowJs": true, + "forceConsistentCasingInFileNames": true, + "paths": { + "~/*": ["./src/*"] + }, + "noEmit": true, + "types": ["vite/client"] + } +} diff --git a/e2e/solid-start/deferred-hydration/vite.config.ts b/e2e/solid-start/deferred-hydration/vite.config.ts new file mode 100644 index 0000000000..70f388638a --- /dev/null +++ b/e2e/solid-start/deferred-hydration/vite.config.ts @@ -0,0 +1,14 @@ +import { defineConfig } from 'vite' +import { tanstackStart } from '@tanstack/solid-start/plugin/vite' +import viteSolid from 'vite-plugin-solid' + +const outDir = process.env.E2E_DIST_DIR ?? 'dist-vite-ssr' + +export default defineConfig({ + resolve: { tsconfigPaths: true }, + build: { + outDir, + }, + server: { port: 3000 }, + plugins: [tanstackStart(), viteSolid({ ssr: true })], +}) diff --git a/packages/react-router/src/index.tsx b/packages/react-router/src/index.tsx index 48de353b2e..6637c7542b 100644 --- a/packages/react-router/src/index.tsx +++ b/packages/react-router/src/index.tsx @@ -129,6 +129,7 @@ export type { AwaitOptions } from './awaited' export { CatchBoundary, ErrorComponent } from './CatchBoundary' export { ClientOnly, useHydrated } from './ClientOnly' +export { reactUse, useLayoutEffect } from './utils' export { FileRoute, diff --git a/packages/react-start-client/package.json b/packages/react-start-client/package.json index 0e2129bb01..83dee85c78 100644 --- a/packages/react-start-client/package.json +++ b/packages/react-start-client/package.json @@ -48,6 +48,12 @@ "default": "./dist/esm/index.js" } }, + "./hydration": { + "import": { + "types": "./dist/esm/hydration.d.ts", + "default": "./dist/esm/hydration.js" + } + }, "./package.json": "./package.json" }, "sideEffects": false, diff --git a/packages/react-start-client/src/GenericHydrate.tsx b/packages/react-start-client/src/GenericHydrate.tsx new file mode 100644 index 0000000000..e92042a0d7 --- /dev/null +++ b/packages/react-start-client/src/GenericHydrate.tsx @@ -0,0 +1,436 @@ +'use client' + +import * as React from 'react' + +import { reactUse, useHydrated, useLayoutEffect } from '@tanstack/react-router' +import { isServer } from '@tanstack/router-core/isServer' +import { + hydrateIdAttribute, + hydrateWhenAttribute, +} from '@tanstack/start-client-core/hydration/constants' +import { + createResolvedGate, + getFallbackHtml, + getOrCreateGate, + onGateResolve, + releaseGate, + runHydrationStrategyCleanup, + saveFallbackHtml, + waitForHydrationPrefetchStrategy, +} from '@tanstack/start-client-core/hydration/runtime' +import { listenForDelegatedHydrationIntent } from '@tanstack/start-client-core/hydration' +import type { + HydrationRuntimeContext, + HydrationStrategy, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' +import type { HydrationGateRecord } from '@tanstack/start-client-core/hydration/runtime' +import type { HydrateProps, InternalHydrateProps } from './Hydrate' + +type Gate = HydrationGateRecord & { promise: Promise } +type PrefetchController = { + abortController: AbortController + hydrationRequested: boolean + hydrationListeners: Set<() => void> + hydrationResolvePending: boolean + started: boolean + promise?: Promise + cleanup?: () => void +} + +const dynamicType = 'dynamic' +const dynamicHydrateStrategy = { + _t: dynamicType, + _d: () => true, +} satisfies HydrationStrategy + +function shouldDeferHydration(strategy: HydrationStrategy) { + return strategy._d ? strategy._d() : strategy._t !== 'load' +} + +function useLatest(value: T) { + const ref = React.useRef(value) + ref.current = value + return ref +} + +function useHydrationGate(props: InternalHydrateProps) { + const hydrated = useHydrated() + const reactId = React.useId() + const id = props.h ? `${props.h}${reactId}` : reactId + const when = props.when + const isDynamicHydrate = typeof when === 'function' + const dynamicHydrateStrategyRef = React.useRef( + undefined, + ) + if (isDynamicHydrate) { + dynamicHydrateStrategyRef.current ??= + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') + ? dynamicHydrateStrategy + : when() + } + const hydrateStrategy = isDynamicHydrate + ? dynamicHydrateStrategyRef.current! + : when + const markerHydrateType: HydrationWhen = isDynamicHydrate + ? dynamicType + : hydrateStrategy._t! + const [prefetchError, setPrefetchError] = React.useState() + const latestRef = useLatest({ + prefetch: props.prefetch, + preload: props.p, + }) + const gateRef = React.useRef(undefined) + const markerElementRef = React.useRef(null) + const shouldPreserveServerHTMLRef = React.useRef( + undefined, + ) + const shouldDeferInitialHydrationRef = React.useRef( + undefined, + ) + const didPrefetchRef = React.useRef(false) + const prefetchControllerRef = React.useRef( + undefined, + ) + + prefetchControllerRef.current ??= { + abortController: new AbortController(), + hydrationRequested: false, + hydrationListeners: new Set<() => void>(), + hydrationResolvePending: false, + started: false, + } + + shouldPreserveServerHTMLRef.current ??= + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || !hydrated + shouldDeferInitialHydrationRef.current ??= + !hydrated && shouldDeferHydration(hydrateStrategy) + + if (!gateRef.current) { + gateRef.current = + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') + ? createResolvedGate(id, hydrateStrategy._t!) + : getOrCreateGate(id, hydrateStrategy._t!) + } + + gateRef.current.when = hydrateStrategy._t! + + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + !(isServer ?? typeof window === 'undefined') && + hydrateStrategy._t !== 'never' && + (!shouldDeferInitialHydrationRef.current || + !shouldDeferHydration(hydrateStrategy)) + ) { + gateRef.current.resolve() + } + + const markerRef = React.useCallback( + (element: HTMLDivElement | null) => { + markerElementRef.current = element + if (element) { + if ( + hydrateStrategy._t === 'never' && + !shouldPreserveServerHTMLRef.current + ) { + element.replaceChildren() + } + saveFallbackHtml(id, element) + } + }, + [hydrateStrategy._t, id], + ) + + React.useEffect(() => { + const gate = gateRef.current! + return () => { + const controller = prefetchControllerRef.current + controller?.abortController.abort() + controller?.cleanup?.() + controller?.hydrationListeners.clear() + releaseGate(gate) + } + }, []) + + React.useEffect(() => { + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || + !latestRef.current.prefetch + ) { + return + } + + const controller = prefetchControllerRef.current! + if (controller.started) return + controller.started = true + + const onHydrate = (listener: () => void) => { + if (controller.hydrationRequested) { + listener() + return () => {} + } + + controller.hydrationListeners.add(listener) + return () => { + controller.hydrationListeners.delete(listener) + } + } + + const preload = () => latestRef.current.preload?.() ?? Promise.resolve() + const prefetchInput = latestRef.current.prefetch + + if (typeof prefetchInput === 'function') { + const promise = Promise.resolve() + .then(() => + prefetchInput({ + element: markerElementRef.current, + signal: controller.abortController.signal, + preload, + waitFor: (strategy) => + waitForHydrationPrefetchStrategy(strategy, { + element: markerElementRef.current, + signal: controller.abortController.signal, + onHydrate, + }), + }), + ) + .then(() => undefined) + + controller.promise = promise + promise.catch((error) => { + if (!controller.abortController.signal.aborted) { + setPrefetchError(error) + } + }) + return + } + + if (!latestRef.current.preload) return + + const prefetch = () => { + if (didPrefetchRef.current) return + didPrefetchRef.current = true + void preload() + } + + controller.cleanup = runHydrationStrategyCleanup( + prefetchInput._s?.({ + element: markerElementRef.current, + prefetch, + }), + ) + }, [hydrateStrategy, latestRef]) + + useLayoutEffect(() => { + const gate = gateRef.current! + if ( + !shouldDeferInitialHydrationRef.current || + hydrateStrategy._t === 'never' + ) { + return + } + + if (gate.resolved) { + return + } + + const cleanups: Array<() => void> = [] + let removeResolveListener = () => {} + let disposed = false + const resolveGate = gate.resolve + + const cleanup = () => { + if (disposed) return + disposed = true + if (gate.resolve === requestHydration) { + gate.resolve = resolveGate + } + removeResolveListener() + cleanups.forEach((fn) => fn()) + } + + const addCleanup = (fn: void | (() => void)) => { + if (!fn) return + if (disposed || gate.resolved) { + fn() + return + } + cleanups.push(fn) + } + + const requestHydration = () => { + const controller = prefetchControllerRef.current! + if (!controller.hydrationRequested) { + controller.hydrationRequested = true + controller.hydrationListeners.forEach((listener) => listener()) + controller.hydrationListeners.clear() + } + + if (!controller.promise) { + resolveGate() + return + } + if (controller.hydrationResolvePending) return + controller.hydrationResolvePending = true + + controller.promise.then( + () => resolveGate(), + (error) => { + if (!controller.abortController.signal.aborted) { + setPrefetchError(error) + } + }, + ) + } + + gate.resolve = requestHydration + removeResolveListener = onGateResolve(gate, cleanup) + + const context: HydrationRuntimeContext = { + element: markerElementRef.current, + gate, + } + addCleanup(runHydrationStrategyCleanup(hydrateStrategy._s?.(context))) + + if (hydrateStrategy._t !== 'interaction') { + addCleanup( + runHydrationStrategyCleanup( + markerElementRef.current + ? listenForDelegatedHydrationIntent( + markerElementRef.current, + context, + ) + : undefined, + ), + ) + } + + return cleanup + }, [hydrateStrategy, latestRef]) + + return { + gate: gateRef.current, + markerRef, + markerElementRef, + hydrateStrategy, + markerHydrateType, + prefetchError, + shouldPreserveServerHTML: shouldPreserveServerHTMLRef.current, + } +} + +function HydrationGate(props: { gate: Gate; children: React.ReactNode }) { + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + isServer ?? + typeof window === 'undefined' + ) { + return props.children as React.JSX.Element + } + + if (props.gate.resolved) { + return props.children as React.JSX.Element + } + + if (!reactUse) { + throw props.gate.promise + } + + reactUse(props.gate.promise) + + return props.children as React.JSX.Element +} + +function HydratedBoundary(props: { + id: string + onHydrated?: () => void + onStrategyHydrated?: (id: string) => void + children: React.ReactNode +}) { + const { id, onHydrated, onStrategyHydrated } = props + const didHydrateRef = React.useRef(false) + + React.useEffect(() => { + if (didHydrateRef.current) return + didHydrateRef.current = true + onHydrated?.() + onStrategyHydrated?.(id) + }, [id, onHydrated, onStrategyHydrated]) + + return props.children as React.JSX.Element +} + +export function GenericHydrate(props: HydrateProps): React.JSX.Element { + const internalProps = props as InternalHydrateProps + const { + gate, + hydrateStrategy, + markerHydrateType, + markerElementRef, + markerRef, + prefetchError, + shouldPreserveServerHTML, + } = useHydrationGate(internalProps) + if (prefetchError) throw prefetchError + + const fallback = shouldPreserveServerHTML + ? (() => { + const html = getFallbackHtml(gate.id) + return html ? ( +
+ ) : null + })() + : (props.fallback ?? null) + const markerAttributes = + markerHydrateType === dynamicType ? undefined : hydrateStrategy._a?.() + + const hydrateType = hydrateStrategy._t! + + if (hydrateType === 'never' && !shouldPreserveServerHTML) { + return ( +
+ {props.fallback ?? null} +
+ ) + } + + return ( +
+ + + { + markerElementRef.current?.removeAttribute(hydrateWhenAttribute) + hydrateStrategy._o?.(id) + }} + > + {props.children} + + + +
+ ) +} diff --git a/packages/react-start-client/src/Hydrate.tsx b/packages/react-start-client/src/Hydrate.tsx new file mode 100644 index 0000000000..019730f3be --- /dev/null +++ b/packages/react-start-client/src/Hydrate.tsx @@ -0,0 +1,107 @@ +'use client' + +import * as React from 'react' + +import { isServer } from '@tanstack/router-core/isServer' +import type { + HydrationStrategy as CoreHydrationStrategy, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' + +export type { + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' + +export type ReactHydrationStrategy< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = CoreHydrationStrategy & { + _h: (this: ReactHydrationStrategy, props: HydrateProps) => React.JSX.Element +} + +export type HydrationStrategy< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = ReactHydrationStrategy + +export type HydrateWhen = + | ReactHydrationStrategy + | (() => ReactHydrationStrategy) + +type HydrateCommonOptions = { + when: HydrateWhen + fallback?: React.ReactNode + onHydrated?: () => void +} + +export type HydrateOptions = + | (HydrateCommonOptions & { + prefetch?: never + split?: boolean + }) + | (HydrateCommonOptions & { + prefetch: HydrationPrefetchStrategy + split?: true + }) + | (HydrateCommonOptions & { + prefetch: HydrationPrefetchFunction + split?: boolean + }) + +export type HydrateProps = HydrateOptions & { + children: React.ReactNode +} + +export type InternalHydrateProps = HydrateProps & { + h?: string + p?: () => Promise +} + +const dynamicType = 'dynamic' +const hydrateIdAttribute = 'data-ts-hydrate-id' +const hydrateWhenAttribute = 'data-ts-hydrate-when' + +/* @__NO_SIDE_EFFECTS__ */ +function ServerDynamicHydrate(props: HydrateProps): React.JSX.Element { + const internalProps = props as InternalHydrateProps + const reactId = React.useId() + const id = internalProps.h ? `${internalProps.h}${reactId}` : reactId + + return ( +
+ + {props.children} + +
+ ) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function Hydrate(props: HydrateProps): React.JSX.Element { + if (typeof props.when === 'function') { + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + isServer ?? + typeof window === 'undefined' + ) { + return + } + + return props.when()._h(props) + } + + return props.when._h(props) +} diff --git a/packages/react-start-client/src/hydration.ts b/packages/react-start-client/src/hydration.ts new file mode 100644 index 0000000000..fad458175c --- /dev/null +++ b/packages/react-start-client/src/hydration.ts @@ -0,0 +1,22 @@ +'use client' + +export { condition, interaction, media } from './hydration/generic' +export { idle } from './hydration/idle' +export { load } from './hydration/load' +export { never } from './hydration/never' +export { visible } from './hydration/visible' +export type { + HydrationCondition, + HydrationInteractionEvent, + HydrationInteractionEvents, + IdleHydrationOptions, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchWhen, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationStrategyTypes, + HydrationWhen, + VisibleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +export type { HydrationStrategy, ReactHydrationStrategy } from './Hydrate' diff --git a/packages/react-start-client/src/hydration/generic.ts b/packages/react-start-client/src/hydration/generic.ts new file mode 100644 index 0000000000..5ee6d3c3d6 --- /dev/null +++ b/packages/react-start-client/src/hydration/generic.ts @@ -0,0 +1,43 @@ +'use client' + +import { + condition as coreCondition, + interaction as coreInteraction, + media as coreMedia, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { + HydrationCondition, + HydrationInteractionEvents, + HydrationPrefetchStrategy, +} from '@tanstack/start-client-core/hydration' +import type { ReactHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function media( + query: string, +): ReactHydrationStrategy<'media', true> & HydrationPrefetchStrategy<'media'> { + return /* @__PURE__ */ withHydrationRenderer(coreMedia(query), GenericHydrate) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function condition( + condition: HydrationCondition, +): ReactHydrationStrategy<'condition', false> { + return /* @__PURE__ */ withHydrationRenderer( + coreCondition(condition), + GenericHydrate, + ) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function interaction(options?: { + events?: HydrationInteractionEvents +}): ReactHydrationStrategy<'interaction', true> & + HydrationPrefetchStrategy<'interaction'> { + return /* @__PURE__ */ withHydrationRenderer( + coreInteraction(options), + GenericHydrate, + ) +} diff --git a/packages/react-start-client/src/hydration/idle.ts b/packages/react-start-client/src/hydration/idle.ts new file mode 100644 index 0000000000..58c7f265eb --- /dev/null +++ b/packages/react-start-client/src/hydration/idle.ts @@ -0,0 +1,22 @@ +'use client' + +import { + idle as coreIdle, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { + HydrationPrefetchStrategy, + IdleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +import type { ReactHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function idle( + options: IdleHydrationOptions = {}, +): ReactHydrationStrategy<'idle', true> & HydrationPrefetchStrategy<'idle'> { + return /* @__PURE__ */ withHydrationRenderer( + coreIdle(options), + GenericHydrate, + ) +} diff --git a/packages/react-start-client/src/hydration/load.tsx b/packages/react-start-client/src/hydration/load.tsx new file mode 100644 index 0000000000..006f4e6952 --- /dev/null +++ b/packages/react-start-client/src/hydration/load.tsx @@ -0,0 +1,49 @@ +'use client' + +import * as React from 'react' + +import { + load as coreLoad, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import type { HydrationPrefetchStrategy } from '@tanstack/start-client-core/hydration' +import type { HydrateProps, ReactHydrationStrategy } from '../Hydrate' + +function HydratedBoundary(props: { + onHydrated?: () => void + children: React.ReactNode +}) { + const { onHydrated, children } = props + const didHydrateRef = React.useRef(false) + + React.useEffect(() => { + if (didHydrateRef.current) return + didHydrateRef.current = true + onHydrated?.() + }, [onHydrated]) + + return children as React.JSX.Element +} + +export function LoadHydrate(props: HydrateProps): React.JSX.Element { + return ( +
+ + + {props.children} + + +
+ ) +} + +const loadStrategy = /* @__PURE__ */ withHydrationRenderer( + coreLoad(), + LoadHydrate, +) as ReactHydrationStrategy<'load', true> & HydrationPrefetchStrategy<'load'> + +/* @__NO_SIDE_EFFECTS__ */ +export function load(): ReactHydrationStrategy<'load', true> & + HydrationPrefetchStrategy<'load'> { + return loadStrategy +} diff --git a/packages/react-start-client/src/hydration/never.tsx b/packages/react-start-client/src/hydration/never.tsx new file mode 100644 index 0000000000..250a8ed1ae --- /dev/null +++ b/packages/react-start-client/src/hydration/never.tsx @@ -0,0 +1,97 @@ +'use client' + +import * as React from 'react' + +import { reactUse, useHydrated } from '@tanstack/react-router' +import { isServer } from '@tanstack/router-core/isServer' +import { + never as coreNever, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { + hydrateIdAttribute, + hydrateWhenAttribute, +} from '@tanstack/start-client-core/hydration/constants' +import { + getFallbackHtml, + saveFallbackHtml, +} from '@tanstack/start-client-core/hydration/runtime' +import type { + HydrateProps, + InternalHydrateProps, + ReactHydrationStrategy, +} from '../Hydrate' + +const neverType = 'never' +const neverPromise = new Promise(() => {}) + +function NeverGate(props: { children: React.ReactNode }) { + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + isServer ?? + typeof window === 'undefined' + ) { + return props.children as React.JSX.Element + } + + if (!reactUse) { + throw neverPromise + } + + reactUse(neverPromise) + + return props.children as React.JSX.Element +} + +export function NeverHydrate(props: HydrateProps): React.JSX.Element { + const internalProps = props as InternalHydrateProps + const hydrated = useHydrated() + const reactId = React.useId() + const id = internalProps.h ? `${internalProps.h}${reactId}` : reactId + const shouldPreserveServerHTMLRef = React.useRef( + undefined, + ) + shouldPreserveServerHTMLRef.current ??= + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || !hydrated + const markerRef = React.useCallback( + (element: HTMLDivElement | null) => { + if (!element) return + if (!shouldPreserveServerHTMLRef.current) { + element.replaceChildren() + } else { + saveFallbackHtml(id, element) + } + }, + [id], + ) + const markerProps = { + ref: markerRef, + [hydrateIdAttribute]: id, + [hydrateWhenAttribute]: neverType, + } + const fallback = (() => { + const html = getFallbackHtml(id) + return html ? ( +
+ ) : ( + (props.fallback ?? null) + ) + })() + + return ( +
+ + {props.children} + +
+ ) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function never(): ReactHydrationStrategy<'never', false> { + return /* @__PURE__ */ withHydrationRenderer(coreNever(), NeverHydrate) +} diff --git a/packages/react-start-client/src/hydration/visible.tsx b/packages/react-start-client/src/hydration/visible.tsx new file mode 100644 index 0000000000..e274285cb8 --- /dev/null +++ b/packages/react-start-client/src/hydration/visible.tsx @@ -0,0 +1,139 @@ +'use client' + +import * as React from 'react' + +import { reactUse } from '@tanstack/react-router' +import { isServer } from '@tanstack/router-core/isServer' +import type { + HydrationPrefetchStrategy, + VisibleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +import type { + HydrateProps, + InternalHydrateProps, + ReactHydrationStrategy, +} from '../Hydrate' + +type VisibleGate = { + p: Promise + r: boolean + s: () => void +} + +/* @__NO_SIDE_EFFECTS__ */ +function HydrationBoundary(props: { + g: VisibleGate + o?: () => void + children?: React.ReactNode +}) { + const { g, o } = props + + if (!g.r) { + if (!reactUse) { + throw g.p + } + + reactUse(g.p) + } + + React.useEffect(() => { + o?.() + }, [o]) + + return props.children as React.JSX.Element +} + +/* @__NO_SIDE_EFFECTS__ */ +export function VisibleHydrate( + this: ReactHydrationStrategy, + props: HydrateProps, +): React.JSX.Element { + const strategy = this as ReactHydrationStrategy<'visible', true> + const prefetchStrategy = props.prefetch + const preload = (props as InternalHydrateProps).p + const markerRef = React.useRef(null) + const [gate] = React.useState(() => { + let resolvePromise!: () => void + const nextGate: VisibleGate = { + p: new Promise((resolve) => { + resolvePromise = resolve + }), + r: false, + s: () => { + nextGate.r = true + resolvePromise() + }, + } + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + isServer ?? + typeof window === 'undefined' + ) { + nextGate.s() + } + + return nextGate + }) + + React.useEffect(() => { + if (!preload || typeof prefetchStrategy === 'function') { + return + } + + return prefetchStrategy?._s?.({ + element: markerRef.current, + prefetch: preload, + }) + }, [prefetchStrategy, preload]) + + React.useEffect(() => { + if (gate.r) return + + return strategy._s?.({ + element: markerRef.current, + gate: gate as never, + }) + }, [gate, strategy]) + + return ( +
+ + + {props.children} + + +
+ ) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function visible( + options?: VisibleHydrationOptions, +): ReactHydrationStrategy<'visible', true> & + HydrationPrefetchStrategy<'visible'> { + const rootMargin = options?.rootMargin ?? '600px' + const threshold = options?.threshold ?? 0 + + return { + _s: ({ element, gate, prefetch }) => { + const callback = prefetch || (gate as never as VisibleGate).s + + if (!element) { + callback() + return + } + + const observer = new IntersectionObserver( + (entries) => { + if (!entries[0]!.isIntersecting) return + observer.disconnect() + callback() + }, + { rootMargin, threshold }, + ) + observer.observe(element) + return () => observer.disconnect() + }, + _h: VisibleHydrate, + } +} diff --git a/packages/react-start-client/src/index.tsx b/packages/react-start-client/src/index.tsx index aa73990a57..669b1e0e3f 100644 --- a/packages/react-start-client/src/index.tsx +++ b/packages/react-start-client/src/index.tsx @@ -1,2 +1,18 @@ +'use client' + export { StartClient } from './StartClient' export { hydrateStart } from './hydrateStart' +export { Hydrate } from './Hydrate' +export type { + HydrateOptions, + HydrateProps, + HydrateWhen, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationStrategy, + HydrationWhen, +} from './Hydrate' diff --git a/packages/react-start-client/src/tests/Hydrate.test-d.tsx b/packages/react-start-client/src/tests/Hydrate.test-d.tsx new file mode 100644 index 0000000000..2e3726edfa --- /dev/null +++ b/packages/react-start-client/src/tests/Hydrate.test-d.tsx @@ -0,0 +1,147 @@ +import { expectTypeOf, test } from 'vitest' +import { visible } from '../hydration' +import { Hydrate } from '../Hydrate' +import type { + HydrateOptions, + HydrateProps, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationStrategy, +} from '../Hydrate' +import type { HydrationStrategy as CoreHydrationStrategy } from '@tanstack/start-client-core/hydration' +import type { ReactNode } from 'react' + +type CommonHydrateProps = { + fallback?: ReactNode + onHydrated?: () => void + children: ReactNode +} + +type SplitHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch?: never + split?: boolean +} + +type PrefetchHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch: HydrationPrefetchStrategy + split?: true +} + +type FunctionPrefetchHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch: HydrationPrefetchFunction + split?: boolean +} + +test('Hydrate component accepts the public HydrateProps type', () => { + expectTypeOf(Hydrate).toBeFunction() + expectTypeOf(Hydrate).parameter(0).branded.toEqualTypeOf() +}) + +test('HydrateOptions supports reusable spread props', () => { + const belowFoldProps = { + when: () => visible({ rootMargin: '800px' }), + } satisfies HydrateOptions + + expectTypeOf(belowFoldProps).toMatchTypeOf() + + const withFunctionPrefetch = { + when: visible(), + split: false, + prefetch: (ctx) => { + expectTypeOf(ctx.element).toEqualTypeOf() + expectTypeOf(ctx.signal).toEqualTypeOf() + expectTypeOf(ctx.preload).returns.toEqualTypeOf>() + expectTypeOf(ctx.waitFor).returns.toEqualTypeOf< + Promise<'prefetch' | 'hydrate' | 'abort'> + >() + }, + } satisfies HydrateOptions + + expectTypeOf(withFunctionPrefetch).toMatchTypeOf() +}) + +test('Hydrate props are exact for strategy and prefetch forms', () => { + expectTypeOf< + Extract + >().branded.toEqualTypeOf() + expectTypeOf< + Extract + >().branded.toEqualTypeOf() + expectTypeOf< + Extract + >().branded.toEqualTypeOf() +}) + +test('Hydrate requires a strategy', () => { + expectTypeOf<{ + when: HydrationStrategy + children: ReactNode + }>().toMatchTypeOf() + + expectTypeOf<{ + when: () => HydrationStrategy + children: ReactNode + }>().toMatchTypeOf() + + expectTypeOf<{ + children: ReactNode + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: () => true + children: ReactNode + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: false + children: ReactNode + }>().not.toMatchTypeOf() +}) + +test('Hydrate requires a framework-renderable strategy', () => { + expectTypeOf().not.toMatchTypeOf() + expectTypeOf>().toMatchTypeOf() + + expectTypeOf<{ + when: CoreHydrationStrategy + children: ReactNode + }>().not.toMatchTypeOf() +}) + +test('Hydrate enforces prefetch only with split boundaries', () => { + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + children: ReactNode + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + split: true + children: ReactNode + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + split: false + children: ReactNode + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchFunction + split: false + children: ReactNode + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchFunction + children: ReactNode + }>().toMatchTypeOf() +}) diff --git a/packages/react-start-client/src/tests/Hydrate.test.tsx b/packages/react-start-client/src/tests/Hydrate.test.tsx new file mode 100644 index 0000000000..0d0ce1faad --- /dev/null +++ b/packages/react-start-client/src/tests/Hydrate.test.tsx @@ -0,0 +1,676 @@ +import * as React from 'react' +import { renderToString } from 'react-dom/server' +import { hydrateRoot } from 'react-dom/client' +import { + act, + cleanup, + fireEvent, + render, + screen, + waitFor, +} from '@testing-library/react' +import { afterEach, describe, expect, it, vi } from 'vitest' +import { hydrateIdAttribute } from '@tanstack/start-client-core/hydration/constants' +import { Hydrate } from '../Hydrate' +import { condition, idle, interaction, load, never } from '../hydration' +import type { HydrateProps, HydrationPrefetchStrategy } from '../Hydrate' + +const InternalHydrate = Hydrate as React.ComponentType< + HydrateProps & { p?: () => Promise; h?: string } +> + +const hydrateIdSelector = `[${hydrateIdAttribute}]` + +function getMarker() { + const marker = document.querySelector(hydrateIdSelector) + + if (!marker) { + throw new Error('Expected Hydrate marker to exist') + } + + return marker +} + +function InteractiveChild() { + const [count, setCount] = React.useState(0) + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +function NamedInteractiveChild(props: { id: string }) { + const [hydrated, setHydrated] = React.useState(false) + + React.useEffect(() => { + setHydrated(true) + }, []) + + return ( + + ) +} + +function createSuspendingChild() { + let resolve!: () => void + let resolved = false + const promise = new Promise((resolvePromise) => { + resolve = () => { + resolved = true + resolvePromise() + } + }) + + function SuspendingChild() { + if (!resolved) { + throw promise + } + + return
child
+ } + + return { resolve, SuspendingChild } +} + +async function expectNoHydrationAfterDefaultIntentEvents() { + const marker = getMarker() + + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + + await act(async () => { + fireEvent.pointerEnter(marker) + fireEvent.focusIn(marker) + fireEvent.pointerDown(marker) + fireEvent.click(marker) + await new Promise((resolve) => setTimeout(resolve, 20)) + }) + + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) +} + +async function fireIntent(event: () => void) { + await act(async () => { + event() + await Promise.resolve() + }) +} + +async function renderAsync(ui: React.ReactElement) { + await act(async () => { + render(ui) + await Promise.resolve() + }) +} + +async function hydrateFromServer(ui: React.ReactElement) { + vi.stubGlobal('window', undefined) + const html = renderToString(ui) + vi.unstubAllGlobals() + + const container = document.createElement('div') + document.body.append(container) + container.innerHTML = html + + let root!: ReturnType + await act(async () => { + root = hydrateRoot(container, ui) + await Promise.resolve() + }) + + return { container, html, root } +} + +async function unmountHydratedRoot( + root: ReturnType, + container: Element, +) { + await act(async () => { + root.unmount() + }) + container.remove() +} + +afterEach(() => { + cleanup() + vi.unstubAllGlobals() +}) + +describe('Hydrate', () => { + it('uses a single custom interaction event instead of the default intent events', async () => { + const { container, html, root } = await hydrateFromServer( + fallback
} + > + + , + ) + + try { + expect(html).toContain('data-testid="child"') + expect(html).not.toContain('data-testid="fallback"') + expect(screen.queryByTestId('fallback')).toBeNull() + await expectNoHydrationAfterDefaultIntentEvents() + + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('dblclick', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('uses every event in a custom interaction event list', async () => { + const { container, root } = await hydrateFromServer( + fallback
} + > + + , + ) + + try { + expect(screen.queryByTestId('fallback')).toBeNull() + await expectNoHydrationAfterDefaultIntentEvents() + + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('contextmenu', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('omits never content when mounted after the app is already hydrated', async () => { + await renderAsync( + + + , + ) + + expect(screen.queryByTestId('child')).toBeNull() + }) + + it('shows fallback for a client-only mount while children suspend', async () => { + const { resolve, SuspendingChild } = createSuspendingChild() + + await renderAsync( + fallback} + > + + , + ) + + expect(screen.getByTestId('fallback').textContent).toBe('fallback') + expect(screen.queryByTestId('child')).toBeNull() + + await act(async () => { + resolve() + await Promise.resolve() + }) + + await screen.findByTestId('child') + expect(screen.queryByTestId('fallback')).toBeNull() + }) + + it('does not use fallback for an initial never boundary', async () => { + const { container, html, root } = await hydrateFromServer( + fallback} + > + + , + ) + + try { + expect(html).toContain('data-testid="child"') + expect(html).not.toContain('data-testid="fallback"') + expect(screen.queryByTestId('fallback')).toBeNull() + + fireEvent.click(screen.getByTestId('child')) + await new Promise((resolve) => setTimeout(resolve, 20)) + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + expect(screen.getByTestId('child').textContent).toBe('0') + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('keeps repeated split boundaries independently gated', async () => { + const { container, root } = await hydrateFromServer( + <> + + + + + + + , + ) + + try { + const markers = container.querySelectorAll(hydrateIdSelector) + + expect(markers).toHaveLength(2) + expect(markers[0]!.getAttribute(hydrateIdAttribute)).not.toBe( + markers[1]!.getAttribute(hydrateIdAttribute), + ) + expect( + screen.getByTestId('child-one').getAttribute('data-hydrated'), + ).toBe('false') + expect( + screen.getByTestId('child-two').getAttribute('data-hydrated'), + ).toBe('false') + + await fireIntent(() => + markers[0]!.dispatchEvent( + new MouseEvent('click', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect( + screen.getByTestId('child-one').getAttribute('data-hydrated'), + ).toBe('true'), + ) + expect( + screen.getByTestId('child-two').getAttribute('data-hydrated'), + ).toBe('false') + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('fires onHydrated once after the client hydration commit', async () => { + const onHydrated = vi.fn() + const app = ( + +
child
+
+ ) + + vi.stubGlobal('window', undefined) + const html = renderToString(app) + expect(html).toContain('child') + expect(onHydrated).not.toHaveBeenCalled() + vi.unstubAllGlobals() + + const container = document.createElement('div') + document.body.append(container) + container.innerHTML = html + + let root!: ReturnType + await act(async () => { + root = hydrateRoot(container, app) + }) + + await waitFor(() => expect(onHydrated).toHaveBeenCalledTimes(1)) + + fireEvent.click(screen.getByTestId('child')) + await new Promise((resolve) => setTimeout(resolve, 20)) + expect(onHydrated).toHaveBeenCalledTimes(1) + + await act(async () => { + root.unmount() + }) + container.remove() + }) + + it('prefetches split children without hydrating the boundary', async () => { + const preload = vi.fn(() => Promise.resolve()) + + const { container, root } = await hydrateFromServer( + + + , + ) + + try { + await waitFor(() => expect(preload).toHaveBeenCalledTimes(1)) + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('click', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + expect(preload).toHaveBeenCalledTimes(1) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('does not evaluate dynamic when callbacks on the server', async () => { + const when = vi.fn(() => interaction({ events: 'dblclick' })) + + vi.stubGlobal('window', undefined) + const html = renderToString( + + + , + ) + vi.unstubAllGlobals() + + expect(when).not.toHaveBeenCalled() + expect(html).toContain('data-ts-hydrate-when="dynamic"') + + const container = document.createElement('div') + document.body.append(container) + container.innerHTML = html + + let root!: ReturnType + try { + await act(async () => { + root = hydrateRoot( + container, + + + , + ) + await Promise.resolve() + }) + + expect(when).toHaveBeenCalled() + await expectNoHydrationAfterDefaultIntentEvents() + + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('dblclick', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('replays an interaction captured before the Hydrate component hydrates', async () => { + const when = () => interaction({ events: 'click' }) + + vi.stubGlobal('window', undefined) + const html = renderToString( + + + , + ) + vi.unstubAllGlobals() + + const container = document.createElement('div') + document.body.append(container) + container.innerHTML = html + + const button = container.querySelector('[data-testid="child"]') + if (!button) { + throw new Error('Expected server-rendered child button') + } + + button.dispatchEvent( + new MouseEvent('click', { bubbles: true, cancelable: true }), + ) + + let root!: ReturnType + try { + await act(async () => { + root = hydrateRoot( + container, + + + , + ) + await Promise.resolve() + }) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + await waitFor(() => + expect(screen.getByTestId('child').textContent).toBe('1'), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('blocks hydration on awaited procedural prefetch work', async () => { + const preload = vi.fn(() => Promise.resolve()) + let resolvePrefetch!: () => void + const prefetchBlocker = new Promise((resolve) => { + resolvePrefetch = resolve + }) + const waitReasons: Array = [] + const neverPrefetches = { + _t: 'idle', + _s: () => () => {}, + } as HydrationPrefetchStrategy<'idle'> + + const { container, root } = await hydrateFromServer( + { + waitReasons.push(await waitFor(neverPrefetches)) + await preload() + await prefetchBlocker + }} + p={preload} + > + + , + ) + + try { + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('click', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => expect(waitReasons).toEqual(['hydrate'])) + expect(preload).toHaveBeenCalledTimes(1) + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + + await act(async () => { + resolvePrefetch() + await prefetchBlocker + await Promise.resolve() + }) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('hydrates when a condition strategy changes after the initial render', async () => { + function ConditionHarness() { + const [ready, setReady] = React.useState(false) + + return ( + <> + + + + + + ) + } + + const { container, root } = await hydrateFromServer() + + try { + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + + await act(async () => { + fireEvent.click(screen.getByTestId('ready')) + await Promise.resolve() + }) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('does not block hydration on fire-and-forget procedural prefetch work', async () => { + let resolvePrefetch!: () => void + const prefetchBlocker = new Promise((resolve) => { + resolvePrefetch = resolve + }) + + const { container, root } = await hydrateFromServer( + { + void prefetchBlocker + }} + > + + , + ) + + try { + await fireIntent(() => + getMarker().dispatchEvent( + new MouseEvent('click', { bubbles: true, cancelable: true }), + ), + ) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + + await act(async () => { + resolvePrefetch() + await prefetchBlocker + }) + } finally { + await unmountHydratedRoot(root, container) + } + }) + + it('aborts procedural prefetch when the boundary unmounts', async () => { + const signals: Array = [] + + const { container, root } = await hydrateFromServer( + { + signals.push(signal) + return new Promise(() => {}) + }} + > + + , + ) + + expect(signals).toHaveLength(1) + expect(signals[0]!.aborted).toBe(false) + + await unmountHydratedRoot(root, container) + expect(signals[0]!.aborted).toBe(true) + }) + + it('delegates nested interaction boundaries at runtime', async () => { + const { container, root } = await hydrateFromServer( + + + + + , + ) + + try { + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'false', + ) + + await fireIntent(() => { + fireEvent.click(screen.getByTestId('child')) + }) + + await waitFor(() => + expect(screen.getByTestId('child').getAttribute('data-hydrated')).toBe( + 'true', + ), + ) + } finally { + await unmountHydratedRoot(root, container) + } + }) +}) diff --git a/packages/react-start-client/vite.config.ts b/packages/react-start-client/vite.config.ts index 32119eee3a..40e07174ac 100644 --- a/packages/react-start-client/vite.config.ts +++ b/packages/react-start-client/vite.config.ts @@ -20,7 +20,7 @@ export default mergeConfig( tanstackViteConfig({ tsconfigPath: './tsconfig.build.json', srcDir: './src', - entry: './src/index.tsx', + entry: ['./src/index.tsx', './src/hydration.ts'], cjs: false, }), ) diff --git a/packages/react-start/package.json b/packages/react-start/package.json index 8f1ca3ba1a..637d9e7546 100644 --- a/packages/react-start/package.json +++ b/packages/react-start/package.json @@ -48,6 +48,12 @@ "default": "./dist/esm/client.js" } }, + "./hydration": { + "import": { + "types": "./dist/esm/hydration.d.ts", + "default": "./dist/esm/hydration.js" + } + }, "./client-rpc": { "import": { "types": "./dist/esm/client-rpc.d.ts", diff --git a/packages/react-start/src/hydration.ts b/packages/react-start/src/hydration.ts new file mode 100644 index 0000000000..e86169e71d --- /dev/null +++ b/packages/react-start/src/hydration.ts @@ -0,0 +1,18 @@ +export { + condition, + idle, + interaction, + load, + media, + never, + visible, +} from '@tanstack/react-start-client/hydration' +export type { + HydrationCondition, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchStrategy, + HydrationStrategy, + HydrationWhen, + VisibleHydrationOptions, +} from '@tanstack/react-start-client/hydration' diff --git a/packages/react-start/src/index.ts b/packages/react-start/src/index.ts index 8b51b6c783..65b116ec2e 100644 --- a/packages/react-start/src/index.ts +++ b/packages/react-start/src/index.ts @@ -1,2 +1,13 @@ export { useServerFn } from './useServerFn' export * from '@tanstack/start-client-core' +export { createServerFn } from '@tanstack/start-client-core' +export { Hydrate } from '@tanstack/react-start-client' +export type { + HydrateOptions, + HydrateProps, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchStrategy, + HydrationStrategy, + HydrationWhen, +} from '@tanstack/react-start-client' diff --git a/packages/react-start/vite.config.ts b/packages/react-start/vite.config.ts index 0995b1f9b4..652e4ef842 100644 --- a/packages/react-start/vite.config.ts +++ b/packages/react-start/vite.config.ts @@ -27,6 +27,7 @@ export default mergeConfig( entry: [ './src/index.ts', './src/client.tsx', + './src/hydration.ts', './src/client-rpc.ts', './src/server.tsx', './src/server.rsc.ts', diff --git a/packages/router-core/src/index.ts b/packages/router-core/src/index.ts index ded15fff6d..e737fa50f8 100644 --- a/packages/router-core/src/index.ts +++ b/packages/router-core/src/index.ts @@ -185,6 +185,7 @@ export type { RouteContextFn, ContextOptions, RouteContextOptions, + SsrContextOptions, BeforeLoadContextOptions, RootRouteOptions, RootRouteOptionsExtensions, diff --git a/packages/router-core/src/ssr/ssr-server.ts b/packages/router-core/src/ssr/ssr-server.ts index 2bca7009d9..c1e467f2fb 100644 --- a/packages/router-core/src/ssr/ssr-server.ts +++ b/packages/router-core/src/ssr/ssr-server.ts @@ -292,23 +292,27 @@ export function attachRouterServerSsrUtils({ }) { router.ssr = { get manifest() { + if (!manifest) return manifest + const requestAssets = getRequestAssets?.() - const inlineCssAsset = getInlineCssAssetForMatches( - manifest, - router.stores.matches.get(), - ) - if (!requestAssets?.length && !inlineCssAsset) return manifest + const matches = router.stores.matches.get() + const inlineCssAsset = getInlineCssAssetForMatches(manifest, matches) + + if (!requestAssets?.length && !inlineCssAsset) { + return manifest + } + // Merge request-scoped assets into root route without mutating cached manifest return { ...manifest, routes: { - ...manifest?.routes, + ...manifest.routes, [rootRouteId]: { - ...manifest?.routes?.[rootRouteId], + ...manifest.routes[rootRouteId], assets: [ ...(requestAssets ?? []), ...(inlineCssAsset ? [inlineCssAsset] : []), - ...(manifest?.routes?.[rootRouteId]?.assets ?? []), + ...(manifest.routes[rootRouteId]?.assets ?? []), ], }, }, diff --git a/packages/router-plugin/src/core/code-splitter/compilers.ts b/packages/router-plugin/src/core/code-splitter/compilers.ts index d59b4fa9af..32eade99af 100644 --- a/packages/router-plugin/src/core/code-splitter/compilers.ts +++ b/packages/router-plugin/src/core/code-splitter/compilers.ts @@ -2,15 +2,27 @@ import * as t from '@babel/types' import * as babel from '@babel/core' import * as template from '@babel/template' import { + buildDeclarationMap, + buildDependencyGraph, + collectIdentifiersFromPattern, + collectLocalBindingsFromStatement, + collectModuleLevelRefsFromNode, + createIdentifier, deadCodeElimination, + expandDestructuredDeclarations, + expandSharedDestructuredDeclarators, + expandTransitively, findReferencedIdentifiers, generateFromAst, parseAst, + removeBindingsTransitivelyDependingOn, + retainModuleLevelDeclarations, + stripUnreferencedTopLevelExpressionStatements, + unwrapExportedDeclarations, } from '@tanstack/router-utils' import { tsrShared, tsrSplit } from '../constants' import { createRouteHmrStatement } from '../hmr' import { getObjectPropertyKeyName } from '../utils' -import { createIdentifier } from './path-ids' import { getFrameworkOptions } from './framework-options' import type { CompileCodeSplitReferenceRouteOptions, @@ -20,6 +32,25 @@ import type { GeneratorResult, ParseAstOptions } from '@tanstack/router-utils' import type { CodeSplitGroupings, SplitRouteIdentNodes } from '../constants' import type { SplitNodeMeta } from './types' +export { + buildDeclarationMap, + buildDependencyGraph, + collectIdentifiersFromNode, + collectLocalBindingsFromStatement, + collectModuleLevelRefsFromNode, + expandDestructuredDeclarations, + expandSharedDestructuredDeclarators, + expandTransitively, + removeBindingsTransitivelyDependingOn, +} from '@tanstack/router-utils' + +export function removeBindingsDependingOnRoute( + bindings: Set, + dependencyGraph: Map>, +) { + removeBindingsTransitivelyDependingOn(bindings, dependencyGraph, ['Route']) +} + const SPLIT_NODES_CONFIG = new Map([ [ 'loader', @@ -108,124 +139,6 @@ const allCreateRouteFns = [ ...unsplittableCreateRouteFns, ] -/** - * Recursively walk an AST node and collect referenced identifier-like names. - * Much cheaper than babel.traverse — no path/scope overhead. - * - * Notes: - * - Uses @babel/types `isReferenced` to avoid collecting non-references like - * object keys, member expression properties, or binding identifiers. - * - Also handles JSX identifiers for component references. - */ -export function collectIdentifiersFromNode(node: t.Node): Set { - const ids = new Set() - - ;(function walk( - n: t.Node | null | undefined, - parent?: t.Node, - grandparent?: t.Node, - parentKey?: string, - ) { - if (!n) return - - if (t.isIdentifier(n)) { - // When we don't have parent info (node passed in isolation), treat as referenced. - if (!parent || t.isReferenced(n, parent, grandparent)) { - ids.add(n.name) - } - return - } - - if (t.isJSXIdentifier(n)) { - // Skip attribute names:
- if (parent && t.isJSXAttribute(parent) && parentKey === 'name') { - return - } - - // Skip member properties: should count Foo, not Bar - if ( - parent && - t.isJSXMemberExpression(parent) && - parentKey === 'property' - ) { - return - } - - // Intrinsic elements (lowercase) are not identifiers - const first = n.name[0] - if (first && first === first.toLowerCase()) { - return - } - - ids.add(n.name) - return - } - - for (const key of t.VISITOR_KEYS[n.type] || []) { - const child = (n as any)[key] - if (Array.isArray(child)) { - for (const c of child) { - if (c && typeof c.type === 'string') { - walk(c, n, parent, key) - } - } - } else if (child && typeof child.type === 'string') { - walk(child, n, parent, key) - } - } - })(node) - - return ids -} - -/** - * Build a map from binding name → declaration AST node for all - * locally-declared module-level bindings. Built once, O(1) lookup. - */ -export function buildDeclarationMap(ast: t.File): Map { - const map = new Map() - for (const stmt of ast.program.body) { - const decl = - t.isExportNamedDeclaration(stmt) && stmt.declaration - ? stmt.declaration - : stmt - - if (t.isVariableDeclaration(decl)) { - for (const declarator of decl.declarations) { - for (const name of collectIdentifiersFromPattern(declarator.id)) { - map.set(name, declarator) - } - } - } else if (t.isFunctionDeclaration(decl) && decl.id) { - map.set(decl.id.name, decl) - } else if (t.isClassDeclaration(decl) && decl.id) { - map.set(decl.id.name, decl) - } - } - return map -} - -/** - * Build a dependency graph: for each local binding, the set of other local - * bindings its declaration references. Built once via simple node walking. - */ -export function buildDependencyGraph( - declMap: Map, - localBindings: Set, -): Map> { - const graph = new Map>() - for (const [name, declNode] of declMap) { - if (!localBindings.has(name)) continue - const allIds = collectIdentifiersFromNode(declNode) - const deps = new Set() - for (const id of allIds) { - if (id !== name && localBindings.has(id)) deps.add(id) - } - graph.set(name, deps) - } - return graph -} - /** * Computes module-level bindings that are shared between split and non-split * route properties. These bindings need to be extracted into a shared virtual @@ -381,199 +294,11 @@ export function computeSharedBindings(opts: { // Remove shared bindings that transitively depend on `Route`. // The Route singleton must stay in the reference file; extracting a // binding that references it would duplicate Route in the shared module. - removeBindingsDependingOnRoute(shared, fullDepGraph) + removeBindingsTransitivelyDependingOn(shared, fullDepGraph, ['Route']) return shared } -/** - * If bindings from the same destructured declarator are referenced by - * different groups, mark all bindings from that declarator as shared. - */ -export function expandSharedDestructuredDeclarators( - ast: t.File, - refsByGroup: Map>, - shared: Set, -) { - for (const stmt of ast.program.body) { - const decl = - t.isExportNamedDeclaration(stmt) && stmt.declaration - ? stmt.declaration - : stmt - - if (!t.isVariableDeclaration(decl)) continue - - for (const declarator of decl.declarations) { - if (!t.isObjectPattern(declarator.id) && !t.isArrayPattern(declarator.id)) - continue - - const names = collectIdentifiersFromPattern(declarator.id) - - const usedGroups = new Set() - for (const name of names) { - const groups = refsByGroup.get(name) - if (!groups) continue - for (const g of groups) usedGroups.add(g) - } - - if (usedGroups.size >= 2) { - for (const name of names) { - shared.add(name) - } - } - } - } -} - -/** - * Collect locally-declared module-level binding names from a statement. - * Pure node inspection, no traversal. - */ -export function collectLocalBindingsFromStatement( - node: t.Statement | t.ModuleDeclaration, - bindings: Set, -) { - const decl = - t.isExportNamedDeclaration(node) && node.declaration - ? node.declaration - : node - - if (t.isVariableDeclaration(decl)) { - for (const declarator of decl.declarations) { - for (const name of collectIdentifiersFromPattern(declarator.id)) { - bindings.add(name) - } - } - } else if (t.isFunctionDeclaration(decl) && decl.id) { - bindings.add(decl.id.name) - } else if (t.isClassDeclaration(decl) && decl.id) { - bindings.add(decl.id.name) - } -} - -/** - * Collect direct module-level binding names referenced from a given AST node. - * Uses a simple recursive walk instead of babel.traverse. - */ -export function collectModuleLevelRefsFromNode( - node: t.Node, - localModuleLevelBindings: Set, -): Set { - const allIds = collectIdentifiersFromNode(node) - const refs = new Set() - for (const name of allIds) { - if (localModuleLevelBindings.has(name)) refs.add(name) - } - return refs -} - -/** - * Expand the shared set transitively using a prebuilt dependency graph. - * No AST traversals — pure graph BFS. - */ -export function expandTransitively( - shared: Set, - depGraph: Map>, -) { - const queue = [...shared] - const visited = new Set() - - while (queue.length > 0) { - const name = queue.pop()! - if (visited.has(name)) continue - visited.add(name) - - const deps = depGraph.get(name) - if (!deps) continue - - for (const dep of deps) { - if (!shared.has(dep)) { - shared.add(dep) - queue.push(dep) - } - } - } -} - -/** - * Remove any bindings from `shared` that transitively depend on `Route`. - * The Route singleton must remain in the reference file; if a shared binding - * references it (directly or transitively), extracting that binding would - * duplicate Route in the shared module. - * - * Uses `depGraph` which must include `Route` as a node so the dependency - * chain is visible. - */ -export function removeBindingsDependingOnRoute( - shared: Set, - depGraph: Map>, -) { - const reverseGraph = new Map>() - for (const [name, deps] of depGraph) { - for (const dep of deps) { - let parents = reverseGraph.get(dep) - if (!parents) { - parents = new Set() - reverseGraph.set(dep, parents) - } - parents.add(name) - } - } - - // Walk backwards from Route to find all bindings that can reach it. - const visited = new Set() - const queue = ['Route'] - while (queue.length > 0) { - const cur = queue.pop()! - if (visited.has(cur)) continue - visited.add(cur) - - const parents = reverseGraph.get(cur) - if (!parents) continue - for (const parent of parents) { - if (!visited.has(parent)) queue.push(parent) - } - } - - for (const name of [...shared]) { - if (visited.has(name)) { - shared.delete(name) - } - } -} - -/** - * If any binding from a destructured declaration is shared, - * ensure all bindings from that same declaration are also shared. - * Pure node inspection of program.body, no traversal. - */ -export function expandDestructuredDeclarations( - ast: t.File, - shared: Set, -) { - for (const stmt of ast.program.body) { - const decl = - t.isExportNamedDeclaration(stmt) && stmt.declaration - ? stmt.declaration - : stmt - - if (!t.isVariableDeclaration(decl)) continue - - for (const declarator of decl.declarations) { - if (!t.isObjectPattern(declarator.id) && !t.isArrayPattern(declarator.id)) - continue - - const names = collectIdentifiersFromPattern(declarator.id) - const hasShared = names.some((n) => shared.has(n)) - if (hasShared) { - for (const n of names) { - shared.add(n) - } - } - } - } -} - /** * Find which shared bindings are user-exported in the original source. * These need to be re-exported from the shared module. @@ -740,6 +465,21 @@ export function compileCodeSplitReferenceRoute( if (t.isObjectExpression(routeOptions)) { const insertionPath = path.getStatementParent() ?? path + opts.compilerPlugins?.forEach((plugin) => { + const pluginResult = plugin.onRouteOptions?.({ + programPath, + callExpressionPath: path, + insertionPath, + routeOptions, + createRouteFn, + opts: opts as CompileCodeSplitReferenceRouteOptions, + }) + + if (pluginResult?.modified) { + modified = true + } + }) + if (opts.deleteNodes && opts.deleteNodes.size > 0) { routeOptions.properties = routeOptions.properties.filter( (prop) => { @@ -1525,22 +1265,7 @@ export function compileCodeSplitVirtualRoute( }) deadCodeElimination(ast, refIdents) - - // Strip top-level expression statements that reference no locally-bound names. - // DCE only removes unused declarations; bare side-effect statements like - // `console.log(...)` survive even when the virtual file has no exports. - { - const locallyBound = new Set() - for (const stmt of ast.program.body) { - collectLocalBindingsFromStatement(stmt, locallyBound) - } - ast.program.body = ast.program.body.filter((stmt) => { - if (!t.isExpressionStatement(stmt)) return true - const refs = collectIdentifiersFromNode(stmt) - // Keep if it references at least one locally-bound identifier - return [...refs].some((name) => locallyBound.has(name)) - }) - } + stripUnreferencedTopLevelExpressionStatements(ast) // If the body is empty after DCE, strip directive prologues too. // A file containing only `'use client'` with no real code is useless. @@ -1595,49 +1320,8 @@ export function compileCodeSplitSharedRoute( keepBindings.delete('Route') expandTransitively(keepBindings, depGraph) - // Remove all statements except: - // - Import declarations (needed for deps; DCE will clean unused ones) - // - Declarations of bindings in keepBindings - ast.program.body = ast.program.body.filter((stmt) => { - // Always keep imports — DCE will remove unused ones - if (t.isImportDeclaration(stmt)) return true - - const decl = - t.isExportNamedDeclaration(stmt) && stmt.declaration - ? stmt.declaration - : stmt - - if (t.isVariableDeclaration(decl)) { - // Keep declarators where at least one binding is in keepBindings - decl.declarations = decl.declarations.filter((declarator) => { - const names = collectIdentifiersFromPattern(declarator.id) - return names.some((n) => keepBindings.has(n)) - }) - if (decl.declarations.length === 0) return false - - // Strip the `export` wrapper — shared module controls its own exports - if (t.isExportNamedDeclaration(stmt) && stmt.declaration) { - return true // keep for now, we'll convert below - } - return true - } else if (t.isFunctionDeclaration(decl) && decl.id) { - return keepBindings.has(decl.id.name) - } else if (t.isClassDeclaration(decl) && decl.id) { - return keepBindings.has(decl.id.name) - } - - // Remove everything else (expression statements, other exports, etc.) - return false - }) - - // Convert `export const/function/class` to plain declarations - // (we'll add our own export statement at the end) - ast.program.body = ast.program.body.map((stmt) => { - if (t.isExportNamedDeclaration(stmt) && stmt.declaration) { - return stmt.declaration - } - return stmt - }) + retainModuleLevelDeclarations(ast, keepBindings) + unwrapExportedDeclarations(ast) // Export all shared bindings (sorted for deterministic output) const exportNames = [...opts.sharedBindings].sort((a, b) => @@ -1837,50 +1521,6 @@ function getImportSpecifierAndPathFromLocalName( return { specifier, path } } -/** - * Recursively collects all identifier names from a destructuring pattern - * (ObjectPattern, ArrayPattern, AssignmentPattern, RestElement). - */ -function collectIdentifiersFromPattern( - node: t.LVal | t.Node | null | undefined, -): Array { - if (!node) { - return [] - } - - if (t.isIdentifier(node)) { - return [node.name] - } - - if (t.isAssignmentPattern(node)) { - return collectIdentifiersFromPattern(node.left) - } - - if (t.isRestElement(node)) { - return collectIdentifiersFromPattern(node.argument) - } - - if (t.isObjectPattern(node)) { - return node.properties.flatMap((prop) => { - if (t.isObjectProperty(prop)) { - return collectIdentifiersFromPattern(prop.value as t.LVal) - } - if (t.isRestElement(prop)) { - return collectIdentifiersFromPattern(prop.argument) - } - return [] - }) - } - - if (t.isArrayPattern(node)) { - return node.elements.flatMap((element) => - collectIdentifiersFromPattern(element), - ) - } - - return [] -} - // Reusable function to get literal value or resolve variable to literal function resolveIdentifier(path: any, node: any): t.Node | undefined { if (t.isIdentifier(node)) { diff --git a/packages/router-plugin/src/core/code-splitter/plugins.ts b/packages/router-plugin/src/core/code-splitter/plugins.ts index 4b2363e361..ebf1f4aa30 100644 --- a/packages/router-plugin/src/core/code-splitter/plugins.ts +++ b/packages/router-plugin/src/core/code-splitter/plugins.ts @@ -43,6 +43,9 @@ export type ReferenceRouteCompilerPluginResult = { export type ReferenceRouteCompilerPlugin = { name: string getStableRouteOptionKeys?: () => Array + onRouteOptions?: ( + ctx: ReferenceRouteCompilerPluginContext, + ) => void | ReferenceRouteCompilerPluginResult onAddHmr?: ( ctx: ReferenceRouteCompilerPluginContext, ) => void | ReferenceRouteCompilerPluginResult diff --git a/packages/router-plugin/src/core/config.ts b/packages/router-plugin/src/core/config.ts index f764bfe8bb..d1d36bbe37 100644 --- a/packages/router-plugin/src/core/config.ts +++ b/packages/router-plugin/src/core/config.ts @@ -9,6 +9,7 @@ import type { RouteIds, } from '@tanstack/router-core' import type { CodeSplitGroupings } from './constants' +import type { ReferenceRouteCompilerPlugin } from './code-splitter/plugins' export const splitGroupingsSchema = z .array( @@ -70,6 +71,12 @@ export type CodeSplittingOptions = { * @default true */ addHmr?: boolean + + /** + * Internal compiler plugins used by framework integrations. + * @internal + */ + compilerPlugins?: Array } export type HmrStyle = 'vite' | 'webpack' diff --git a/packages/router-plugin/src/core/router-code-splitter-plugin.ts b/packages/router-plugin/src/core/router-code-splitter-plugin.ts index 8f6324bae1..96d3d1251f 100644 --- a/packages/router-plugin/src/core/router-code-splitter-plugin.ts +++ b/packages/router-plugin/src/core/router-code-splitter-plugin.ts @@ -4,7 +4,7 @@ */ import { fileURLToPath, pathToFileURL } from 'node:url' -import { logDiff } from '@tanstack/router-utils' +import { decodeIdentifier, logDiff } from '@tanstack/router-utils' import { getConfig, splitGroupingsSchema } from './config' import { compileCodeSplitReferenceRoute, @@ -20,7 +20,6 @@ import { tsrShared, tsrSplit, } from './constants' -import { decodeIdentifier } from './code-splitter/path-ids' import { debug, normalizePath, routeFactoryCallCodeFilter } from './utils' import { createRouterPluginContext } from './router-plugin-context' import type { CodeSplitGroupings, SplitRouteIdentNodes } from './constants' @@ -177,11 +176,14 @@ export function createRouterCodeSplitterPlugin( hmrStyle, hmrRouteId: generatorNodeInfo.routeId, sharedBindings: sharedBindings.size > 0 ? sharedBindings : undefined, - compilerPlugins: getReferenceRouteCompilerPlugins({ - targetFramework: userConfig.target, - addHmr, - hmrStyle, - }), + compilerPlugins: [ + ...(getReferenceRouteCompilerPlugins({ + targetFramework: userConfig.target, + addHmr, + hmrStyle, + }) ?? []), + ...(userConfig.codeSplittingOptions?.compilerPlugins ?? []), + ], }) if (compiledReferenceRoute === null) { diff --git a/packages/router-plugin/src/index.ts b/packages/router-plugin/src/index.ts index a56e097d3a..e390c046a2 100644 --- a/packages/router-plugin/src/index.ts +++ b/packages/router-plugin/src/index.ts @@ -11,6 +11,11 @@ export type { HmrOptions, } from './core/config' export type { RouterPluginContext } from './core/router-plugin-context' +export { getObjectPropertyKeyName } from './core/utils' +export type { + ReferenceRouteCompilerPlugin, + ReferenceRouteCompilerPluginContext, +} from './core/code-splitter/plugins' export { tsrSplit, splitRouteIdentNodes, diff --git a/packages/router-plugin/tests/code-splitter.test.ts b/packages/router-plugin/tests/code-splitter.test.ts index 5a68f9453f..ae64e2778b 100644 --- a/packages/router-plugin/tests/code-splitter.test.ts +++ b/packages/router-plugin/tests/code-splitter.test.ts @@ -18,7 +18,7 @@ import { expandTransitively, removeBindingsDependingOnRoute, } from '../src/core/code-splitter/compilers' -import { createIdentifier } from '../src/core/code-splitter/path-ids' +import { createIdentifier } from '@tanstack/router-utils' import { defaultCodeSplitGroupings } from '../src/core/constants' import { frameworks } from './constants' import type { CodeSplitGroupings } from '../src/core/constants' diff --git a/packages/router-utils/src/compiler-helpers.ts b/packages/router-utils/src/compiler-helpers.ts new file mode 100644 index 0000000000..78d6cd9b86 --- /dev/null +++ b/packages/router-utils/src/compiler-helpers.ts @@ -0,0 +1,843 @@ +import * as t from '@babel/types' + +type IdentifierScopeFrame = { + kind: 'program' | 'function' | 'block' + bindings: Set +} +type IdentifierScopeStack = Array + +export type ModuleInfoBinding = + | { + type: 'import' + source: string + importedName: string + } + | { + type: 'var' + init: t.Expression | null + } + +export interface ExtractedModuleInfo { + bindings: Map + exports: Map + reExportAllSources: Array +} + +function getModuleExportName(node: t.Identifier | t.StringLiteral) { + return t.isIdentifier(node) ? node.name : node.value +} + +function addVariableDeclarationModuleInfo( + declaration: t.VariableDeclaration, + bindings: Map, + exportMap?: Map, +) { + for (const declarator of declaration.declarations) { + for (const name of collectIdentifiersFromPattern(declarator.id)) { + bindings.set(name, { + type: 'var', + init: declarator.init ?? null, + }) + exportMap?.set(name, name) + } + } +} + +function addDeclarationModuleInfo( + declaration: t.Declaration, + bindings: Map, + exportMap?: Map, +) { + if (t.isVariableDeclaration(declaration)) { + addVariableDeclarationModuleInfo(declaration, bindings, exportMap) + return + } + + if ( + (t.isFunctionDeclaration(declaration) || + t.isClassDeclaration(declaration)) && + declaration.id + ) { + bindings.set(declaration.id.name, { + type: 'var', + init: null, + }) + exportMap?.set(declaration.id.name, declaration.id.name) + } +} + +function hasIdentifierBinding(scopes: IdentifierScopeStack, name: string) { + for (let i = scopes.length - 1; i >= 0; i--) { + if (scopes[i]!.bindings.has(name)) { + return true + } + } + return false +} + +function currentIdentifierScope(scopes: IdentifierScopeStack) { + return scopes[scopes.length - 1]! +} + +function nearestFunctionIdentifierScope(scopes: IdentifierScopeStack) { + for (let i = scopes.length - 1; i >= 0; i--) { + const scope = scopes[i]! + if (scope.kind === 'function' || scope.kind === 'program') { + return scope + } + } + return currentIdentifierScope(scopes) +} + +function addIdentifierPatternBindings( + pattern: t.LVal | t.Node | null | undefined, + scope: IdentifierScopeFrame, +) { + for (const name of collectIdentifiersFromPattern(pattern)) { + scope.bindings.add(name) + } +} + +function addIdentifierDeclarationBindings( + declaration: t.Node, + scopes: IdentifierScopeStack, +) { + if (t.isVariableDeclaration(declaration)) { + const scope = + declaration.kind === 'var' + ? nearestFunctionIdentifierScope(scopes) + : currentIdentifierScope(scopes) + for (const declarator of declaration.declarations) { + addIdentifierPatternBindings(declarator.id, scope) + } + return + } + + if ( + (t.isFunctionDeclaration(declaration) || + t.isClassDeclaration(declaration) || + t.isTSTypeAliasDeclaration(declaration) || + t.isTSInterfaceDeclaration(declaration) || + t.isTSEnumDeclaration(declaration)) && + declaration.id + ) { + currentIdentifierScope(scopes).bindings.add(declaration.id.name) + } +} + +function addIdentifierImportBindings( + node: t.ImportDeclaration, + scope: IdentifierScopeFrame, +) { + for (const specifier of node.specifiers) { + scope.bindings.add(specifier.local.name) + } +} + +function createNestedIdentifierScope( + kind: IdentifierScopeFrame['kind'], + scopes: IdentifierScopeStack, +): IdentifierScopeStack { + return [...scopes, { kind, bindings: new Set() }] +} + +function addIdentifierBlockBindings( + body: Array, + scopes: IdentifierScopeStack, +) { + for (const statement of body) { + if (t.isImportDeclaration(statement)) { + addIdentifierImportBindings(statement, currentIdentifierScope(scopes)) + } else if (t.isExportNamedDeclaration(statement) && statement.declaration) { + addIdentifierDeclarationBindings(statement.declaration, scopes) + } else { + addIdentifierDeclarationBindings(statement, scopes) + } + } +} + +function walkIdentifierChildren( + current: t.Node, + parent: t.Node | undefined, + scopes: IdentifierScopeStack, + ids: Set, +) { + for (const key of t.VISITOR_KEYS[current.type] ?? []) { + const child = (current as any)[key] + if (Array.isArray(child)) { + for (const item of child) { + if (item && typeof item.type === 'string') { + walkIdentifierNode(item, current, parent, key, scopes, ids) + } + } + } else if (child && typeof child.type === 'string') { + walkIdentifierNode(child, current, parent, key, scopes, ids) + } + } +} + +function walkIdentifierNode( + current: t.Node | null | undefined, + parent: t.Node | undefined, + grandparent: t.Node | undefined, + parentKey: string | undefined, + scopes: IdentifierScopeStack, + ids: Set, +) { + if (!current) return + + if (t.isIdentifier(current)) { + if ( + (!parent || t.isReferenced(current, parent, grandparent)) && + !hasIdentifierBinding(scopes, current.name) + ) { + ids.add(current.name) + } + return + } + + if (t.isJSXIdentifier(current)) { + if (parent && t.isJSXAttribute(parent) && parentKey === 'name') { + return + } + + if (parent && t.isJSXMemberExpression(parent) && parentKey === 'property') { + return + } + + const first = current.name[0] + if (first && first === first.toLowerCase()) { + return + } + + if (!hasIdentifierBinding(scopes, current.name)) { + ids.add(current.name) + } + return + } + + if (t.isProgram(current)) { + const nestedScopes = createNestedIdentifierScope('program', scopes) + addIdentifierBlockBindings(current.body, nestedScopes) + for (const child of current.body) { + walkIdentifierNode(child, current, parent, 'body', nestedScopes, ids) + } + return + } + + if (t.isBlockStatement(current)) { + const nestedScopes = createNestedIdentifierScope('block', scopes) + addIdentifierBlockBindings(current.body, nestedScopes) + for (const child of current.body) { + walkIdentifierNode(child, current, parent, 'body', nestedScopes, ids) + } + return + } + + if ( + t.isFunctionDeclaration(current) || + t.isFunctionExpression(current) || + t.isArrowFunctionExpression(current) || + t.isObjectMethod(current) || + t.isClassMethod(current) || + t.isClassPrivateMethod(current) + ) { + if (t.isFunctionDeclaration(current) && current.id) { + currentIdentifierScope(scopes).bindings.add(current.id.name) + } + + const nestedScopes = createNestedIdentifierScope('function', scopes) + if ( + (t.isFunctionDeclaration(current) || t.isFunctionExpression(current)) && + current.id + ) { + currentIdentifierScope(nestedScopes).bindings.add(current.id.name) + } + for (const param of current.params) { + addIdentifierPatternBindings(param, currentIdentifierScope(nestedScopes)) + } + + walkIdentifierChildren(current, parent, nestedScopes, ids) + return + } + + if (t.isCatchClause(current)) { + const nestedScopes = createNestedIdentifierScope('block', scopes) + addIdentifierPatternBindings( + current.param, + currentIdentifierScope(nestedScopes), + ) + walkIdentifierNode( + current.param, + current, + parent, + 'param', + nestedScopes, + ids, + ) + walkIdentifierNode(current.body, current, parent, 'body', nestedScopes, ids) + return + } + + if (t.isImportDeclaration(current)) { + addIdentifierImportBindings(current, currentIdentifierScope(scopes)) + return + } + + if (t.isClassDeclaration(current) || t.isClassExpression(current)) { + if (t.isClassDeclaration(current) && current.id) { + currentIdentifierScope(scopes).bindings.add(current.id.name) + } + + const nestedScopes = current.id + ? createNestedIdentifierScope('block', scopes) + : scopes + if (current.id) { + currentIdentifierScope(nestedScopes).bindings.add(current.id.name) + } + + walkIdentifierChildren(current, parent, nestedScopes, ids) + return + } + + if (t.isVariableDeclaration(current)) { + addIdentifierDeclarationBindings(current, scopes) + } else if (t.isVariableDeclarator(current)) { + const scope = + parent && t.isVariableDeclaration(parent) && parent.kind === 'var' + ? nearestFunctionIdentifierScope(scopes) + : currentIdentifierScope(scopes) + addIdentifierPatternBindings(current.id, scope) + } else if ( + t.isTSTypeAliasDeclaration(current) || + t.isTSInterfaceDeclaration(current) || + t.isTSEnumDeclaration(current) + ) { + currentIdentifierScope(scopes).bindings.add(current.id.name) + } + + walkIdentifierChildren(current, parent, scopes, ids) +} + +/** + * Recursively walk an AST node and collect referenced identifier-like names. + * This avoids Babel path/scope allocation for module-level dependency scans. + */ +export function collectIdentifiersFromNode(node: t.Node): Set { + const ids = new Set() + walkIdentifierNode( + node, + undefined, + undefined, + undefined, + [{ kind: 'program', bindings: new Set() }], + ids, + ) + return ids +} + +export function collectIdentifiersFromPattern( + node: t.LVal | t.Node | null | undefined, +): Array { + if (!node) { + return [] + } + + if (t.isIdentifier(node)) { + return [node.name] + } + + if (t.isAssignmentPattern(node)) { + return collectIdentifiersFromPattern(node.left) + } + + if (t.isRestElement(node)) { + return collectIdentifiersFromPattern(node.argument) + } + + if (t.isObjectPattern(node)) { + return node.properties.flatMap((prop) => { + if (t.isObjectProperty(prop)) { + return collectIdentifiersFromPattern(prop.value as t.LVal) + } + if (t.isRestElement(prop)) { + return collectIdentifiersFromPattern(prop.argument) + } + return [] + }) + } + + if (t.isArrayPattern(node)) { + return node.elements.flatMap((element) => + collectIdentifiersFromPattern(element), + ) + } + + return [] +} + +export function collectLocalBindingsFromStatement( + node: t.Statement | t.ModuleDeclaration, + bindings: Set, +) { + const declaration = + t.isExportNamedDeclaration(node) && node.declaration + ? node.declaration + : t.isExportDefaultDeclaration(node) + ? node.declaration + : node + + if (t.isVariableDeclaration(declaration)) { + for (const declarator of declaration.declarations) { + for (const name of collectIdentifiersFromPattern(declarator.id)) { + bindings.add(name) + } + } + } else if (t.isFunctionDeclaration(declaration) && declaration.id) { + bindings.add(declaration.id.name) + } else if (t.isClassDeclaration(declaration) && declaration.id) { + bindings.add(declaration.id.name) + } +} + +export function extractModuleInfoFromAst(ast: t.File): ExtractedModuleInfo { + const bindings = new Map() + const exportMap = new Map() + const reExportAllSources: Array = [] + + for (const node of ast.program.body) { + if (t.isImportDeclaration(node)) { + const source = node.source.value + for (const specifier of node.specifiers) { + if (t.isImportSpecifier(specifier)) { + bindings.set(specifier.local.name, { + type: 'import', + source, + importedName: getModuleExportName(specifier.imported), + }) + } else if (t.isImportDefaultSpecifier(specifier)) { + bindings.set(specifier.local.name, { + type: 'import', + source, + importedName: 'default', + }) + } else if (t.isImportNamespaceSpecifier(specifier)) { + bindings.set(specifier.local.name, { + type: 'import', + source, + importedName: '*', + }) + } + } + continue + } + + if (t.isVariableDeclaration(node)) { + addVariableDeclarationModuleInfo(node, bindings) + continue + } + + if (t.isFunctionDeclaration(node) || t.isClassDeclaration(node)) { + addDeclarationModuleInfo(node, bindings) + continue + } + + if (t.isExportNamedDeclaration(node)) { + if (node.declaration) { + addDeclarationModuleInfo(node.declaration, bindings, exportMap) + } + + for (const specifier of node.specifiers) { + if (t.isExportNamespaceSpecifier(specifier)) { + const exported = getModuleExportName(specifier.exported) + exportMap.set(exported, exported) + if (node.source) { + bindings.set(exported, { + type: 'import', + source: node.source.value, + importedName: '*', + }) + } + } else if (t.isExportSpecifier(specifier)) { + const local = getModuleExportName(specifier.local) + const exported = getModuleExportName(specifier.exported) + exportMap.set(exported, local) + + if (node.source) { + bindings.set(local, { + type: 'import', + source: node.source.value, + importedName: local, + }) + } + } + } + continue + } + + if (t.isExportDefaultDeclaration(node)) { + const declaration = node.declaration + if (t.isIdentifier(declaration)) { + exportMap.set('default', declaration.name) + } else if ( + (t.isFunctionDeclaration(declaration) || + t.isClassDeclaration(declaration)) && + declaration.id + ) { + bindings.set(declaration.id.name, { + type: 'var', + init: null, + }) + exportMap.set('default', declaration.id.name) + } else { + const synth = '__default_export__' + bindings.set(synth, { + type: 'var', + init: t.isExpression(declaration) ? declaration : null, + }) + exportMap.set('default', synth) + } + continue + } + + if (t.isExportAllDeclaration(node)) { + reExportAllSources.push(node.source.value) + } + } + + return { + bindings, + exports: exportMap, + reExportAllSources, + } +} + +export function buildDeclarationMap(ast: t.File): Map { + const map = new Map() + + for (const statement of ast.program.body) { + const declaration = + t.isExportNamedDeclaration(statement) && statement.declaration + ? statement.declaration + : t.isExportDefaultDeclaration(statement) + ? statement.declaration + : statement + + if (t.isVariableDeclaration(declaration)) { + for (const declarator of declaration.declarations) { + for (const name of collectIdentifiersFromPattern(declarator.id)) { + map.set(name, declarator) + } + } + } else if (t.isFunctionDeclaration(declaration) && declaration.id) { + map.set(declaration.id.name, declaration) + } else if (t.isClassDeclaration(declaration) && declaration.id) { + map.set(declaration.id.name, declaration) + } + } + + return map +} + +export function buildDependencyGraph( + declarationMap: Map, + localBindings: Set, +): Map> { + const graph = new Map>() + + for (const [name, declarationNode] of declarationMap) { + if (!localBindings.has(name)) continue + + const dependencies = new Set() + for (const id of collectIdentifiersFromNode(declarationNode)) { + if (id !== name && localBindings.has(id)) { + dependencies.add(id) + } + } + graph.set(name, dependencies) + } + + return graph +} + +export function collectModuleLevelRefsFromNode( + node: t.Node, + localModuleLevelBindings: Set, +): Set { + const refs = new Set() + + for (const name of collectIdentifiersFromNode(node)) { + if (localModuleLevelBindings.has(name)) { + refs.add(name) + } + } + + return refs +} + +export function expandTransitively( + bindings: Set, + dependencyGraph: Map>, +) { + const queue = [...bindings] + const visited = new Set() + + while (queue.length > 0) { + const name = queue.pop()! + if (visited.has(name)) continue + visited.add(name) + + const dependencies = dependencyGraph.get(name) + if (!dependencies) continue + + for (const dependency of dependencies) { + if (!bindings.has(dependency)) { + bindings.add(dependency) + queue.push(dependency) + } + } + } +} + +export function expandSharedDestructuredDeclarators( + ast: t.File, + refsByGroup: Map>, + sharedBindings: Set, +) { + for (const statement of ast.program.body) { + const declaration = + t.isExportNamedDeclaration(statement) && statement.declaration + ? statement.declaration + : statement + + if (!t.isVariableDeclaration(declaration)) continue + + for (const declarator of declaration.declarations) { + if ( + !t.isObjectPattern(declarator.id) && + !t.isArrayPattern(declarator.id) + ) { + continue + } + + const names = collectIdentifiersFromPattern(declarator.id) + const usedGroups = new Set() + + for (const name of names) { + const groups = refsByGroup.get(name) + if (!groups) continue + for (const group of groups) { + usedGroups.add(group) + } + } + + if (usedGroups.size >= 2) { + for (const name of names) { + sharedBindings.add(name) + } + } + } + } +} + +export function expandDestructuredDeclarations( + ast: t.File, + bindings: Set, +) { + for (const statement of ast.program.body) { + const declaration = + t.isExportNamedDeclaration(statement) && statement.declaration + ? statement.declaration + : statement + + if (!t.isVariableDeclaration(declaration)) continue + + for (const declarator of declaration.declarations) { + if ( + !t.isObjectPattern(declarator.id) && + !t.isArrayPattern(declarator.id) + ) { + continue + } + + const names = collectIdentifiersFromPattern(declarator.id) + if (names.some((name) => bindings.has(name))) { + for (const name of names) { + bindings.add(name) + } + } + } + } +} + +export function removeBindingsTransitivelyDependingOn( + bindings: Set, + dependencyGraph: Map>, + roots: Iterable, +) { + const reverseGraph = new Map>() + + for (const [name, dependencies] of dependencyGraph) { + for (const dependency of dependencies) { + let parents = reverseGraph.get(dependency) + if (!parents) { + parents = new Set() + reverseGraph.set(dependency, parents) + } + parents.add(name) + } + } + + const visited = new Set() + const queue = [...roots] + + while (queue.length > 0) { + const current = queue.pop()! + if (visited.has(current)) continue + visited.add(current) + + const parents = reverseGraph.get(current) + if (!parents) continue + + for (const parent of parents) { + if (!visited.has(parent)) { + queue.push(parent) + } + } + } + + for (const name of [...bindings]) { + if (visited.has(name)) { + bindings.delete(name) + } + } +} + +export function removeModuleLevelBindings( + ast: t.File, + namesToRemove: Set, +) { + ast.program.body = ast.program.body.filter((statement) => { + const declaration = + t.isExportNamedDeclaration(statement) && statement.declaration + ? statement.declaration + : statement + + if (t.isVariableDeclaration(declaration)) { + declaration.declarations = declaration.declarations.filter( + (declarator) => + !collectIdentifiersFromPattern(declarator.id).some((name) => + namesToRemove.has(name), + ), + ) + return declaration.declarations.length > 0 + } + + if (t.isFunctionDeclaration(declaration) && declaration.id) { + return !namesToRemove.has(declaration.id.name) + } + + if (t.isClassDeclaration(declaration) && declaration.id) { + return !namesToRemove.has(declaration.id.name) + } + + if (t.isExportDefaultDeclaration(statement)) { + const defaultDeclaration = statement.declaration + if ( + (t.isFunctionDeclaration(defaultDeclaration) || + t.isClassDeclaration(defaultDeclaration)) && + defaultDeclaration.id + ) { + return !namesToRemove.has(defaultDeclaration.id.name) + } + } + + return true + }) +} + +export function retainModuleLevelDeclarations( + ast: t.File, + bindingsToKeep: Set, +) { + ast.program.body = ast.program.body.filter((statement) => { + if (t.isImportDeclaration(statement)) return true + + const declaration = + t.isExportNamedDeclaration(statement) && statement.declaration + ? statement.declaration + : statement + + if (t.isVariableDeclaration(declaration)) { + declaration.declarations = declaration.declarations.filter((declarator) => + collectIdentifiersFromPattern(declarator.id).some((name) => + bindingsToKeep.has(name), + ), + ) + return declaration.declarations.length > 0 + } + + if (t.isFunctionDeclaration(declaration) && declaration.id) { + return bindingsToKeep.has(declaration.id.name) + } + + if (t.isClassDeclaration(declaration) && declaration.id) { + return bindingsToKeep.has(declaration.id.name) + } + + return false + }) +} + +export function unwrapExportedDeclarations(ast: t.File) { + const body: Array = [] + + for (const statement of ast.program.body) { + if (t.isExportNamedDeclaration(statement)) { + if (statement.declaration) { + body.push(statement.declaration) + } + continue + } + + if (t.isExportDefaultDeclaration(statement)) { + const declaration = statement.declaration + if ( + (t.isFunctionDeclaration(declaration) || + t.isClassDeclaration(declaration)) && + declaration.id + ) { + body.push(declaration) + } + continue + } + + if (t.isExportAllDeclaration(statement)) { + continue + } + + body.push(statement) + } + + ast.program.body = body +} + +export function stripUnreferencedTopLevelExpressionStatements(ast: t.File) { + const locallyBound = new Set() + + for (const statement of ast.program.body) { + collectLocalBindingsFromStatement(statement, locallyBound) + } + + ast.program.body = ast.program.body.filter((statement) => { + if (!t.isExpressionStatement(statement)) return true + + for (const name of collectIdentifiersFromNode(statement)) { + if (locallyBound.has(name)) { + return true + } + } + + return false + }) +} diff --git a/packages/router-utils/src/index.ts b/packages/router-utils/src/index.ts index 3b072ae419..ce0de90824 100644 --- a/packages/router-utils/src/index.ts +++ b/packages/router-utils/src/index.ts @@ -9,3 +9,24 @@ export type { ParseAstOptions, ParseAstResult, GeneratorResult } from './ast' export { logDiff } from './logger' export { copyFilesPlugin } from './copy-files-plugin' + +export { createIdentifier, decodeIdentifier } from './path-ids' + +export { + buildDeclarationMap, + buildDependencyGraph, + collectIdentifiersFromNode, + collectIdentifiersFromPattern, + collectLocalBindingsFromStatement, + collectModuleLevelRefsFromNode, + expandDestructuredDeclarations, + expandSharedDestructuredDeclarators, + expandTransitively, + extractModuleInfoFromAst, + removeBindingsTransitivelyDependingOn, + removeModuleLevelBindings, + retainModuleLevelDeclarations, + stripUnreferencedTopLevelExpressionStatements, + unwrapExportedDeclarations, +} from './compiler-helpers' +export type { ExtractedModuleInfo, ModuleInfoBinding } from './compiler-helpers' diff --git a/packages/router-plugin/src/core/code-splitter/path-ids.ts b/packages/router-utils/src/path-ids.ts similarity index 100% rename from packages/router-plugin/src/core/code-splitter/path-ids.ts rename to packages/router-utils/src/path-ids.ts diff --git a/packages/router-utils/tests/compiler-helpers.test.ts b/packages/router-utils/tests/compiler-helpers.test.ts new file mode 100644 index 0000000000..00b75d67e5 --- /dev/null +++ b/packages/router-utils/tests/compiler-helpers.test.ts @@ -0,0 +1,249 @@ +import * as t from '@babel/types' +import { describe, expect, test } from 'vitest' +import { + buildDeclarationMap, + collectIdentifiersFromNode, + collectLocalBindingsFromStatement, + extractModuleInfoFromAst, +} from '../src/compiler-helpers' +import { parseAst } from '../src/ast' + +function getVariableInit(code: string) { + const ast = parseAst({ code, filename: 'test.tsx' }) + const declaration = ast.program.body.find((node) => + t.isVariableDeclaration(node), + ) as t.VariableDeclaration + return declaration.declarations[0]!.init! +} + +function collectSortedIdentifiers(node: t.Node) { + return [...collectIdentifiersFromNode(node)].sort() +} + +function collectSortedStatementBindings(code: string) { + const ast = parseAst({ code, filename: 'test.tsx' }) + const bindings = new Set() + for (const statement of ast.program.body) { + collectLocalBindingsFromStatement(statement, bindings) + } + return [...bindings].sort() +} + +function collectSortedDeclarationMapEntries(code: string) { + const ast = parseAst({ code, filename: 'test.tsx' }) + return [...buildDeclarationMap(ast)] + .map(([name, node]): [string, string] => [name, node.type]) + .sort((left, right) => (left[0] < right[0] ? -1 : 1)) +} + +function collectModuleInfoSnapshot(code: string) { + const ast = parseAst({ code, filename: 'test.tsx' }) + const info = extractModuleInfoFromAst(ast) + return { + bindings: [...info.bindings] + .map(([name, binding]) => [ + name, + binding.type === 'import' + ? `${binding.source}:${binding.importedName}` + : (binding.init?.type ?? null), + ]) + .sort((left, right) => (left[0]! < right[0]! ? -1 : 1)), + exports: [...info.exports].sort((left, right) => + left[0] < right[0] ? -1 : 1, + ), + reExportAllSources: info.reExportAllSources, + } +} + +describe('collectIdentifiersFromNode', () => { + test('collects free identifiers without reporting nested local bindings', () => { + const init = getVariableInit(` +const value = outer + (() => { + const local = dep + + function nested(param = fallback) { + const Inner = () => + const LocalExpr = class NamedLocal { + method() { + return NamedLocal + local + param + } + } + + class LocalComponent {} + + return local + param + imported + Inner + LocalExpr + } + + return nested() +})() +`) + + expect(collectSortedIdentifiers(init)).toMatchInlineSnapshot(` + [ + "dep", + "fallback", + "imported", + "outer", + ] + `) + }) + + test('respects nested variable, parameter, catch, and import shadowing', () => { + const ast = parseAst({ + code: ` +import { external as localImport } from 'pkg' + +const value = (localParam = defaultValue) => { + const localShadow = factory(localImport) + + try { + throw thrown + } catch (thrown) { + const factory = () => localShadow + localParam + thrown + return factory() + } +} +`, + filename: 'test.ts', + }) + + expect(collectSortedIdentifiers(ast.program)).toMatchInlineSnapshot(` + [ + "defaultValue", + "factory", + "thrown", + ] + `) + }) +}) + +describe('collectLocalBindingsFromStatement', () => { + test('collects ids from named default function and class declarations', () => { + expect({ + class: collectSortedStatementBindings( + `export default class DefaultComponent {}`, + ), + function: collectSortedStatementBindings( + `export default function DefaultRoute() {}`, + ), + anonymous: collectSortedStatementBindings( + `export default function () {}`, + ), + }).toMatchInlineSnapshot(` + { + "anonymous": [], + "class": [ + "DefaultComponent", + ], + "function": [ + "DefaultRoute", + ], + } + `) + }) +}) + +describe('buildDeclarationMap', () => { + test('maps named default function and class declarations', () => { + expect({ + class: collectSortedDeclarationMapEntries( + `export default class DefaultComponent {}`, + ), + function: collectSortedDeclarationMapEntries( + `export default function DefaultRoute() {}`, + ), + anonymous: collectSortedDeclarationMapEntries(`export default class {}`), + }).toMatchInlineSnapshot(` + { + "anonymous": [], + "class": [ + [ + "DefaultComponent", + "ClassDeclaration", + ], + ], + "function": [ + [ + "DefaultRoute", + "FunctionDeclaration", + ], + ], + } + `) + }) +}) + +describe('extractModuleInfoFromAst', () => { + test('extracts imports, local exports, default exports, and re-export sources', () => { + expect( + collectModuleInfoSnapshot(` + import defaultImport, { named as localNamed } from 'pkg' + import * as ns from 'pkg-ns' + const local = localNamed + export const exported = local + export function loader() {} + export default class DefaultRoute {} + export { remote as renamed } from './remote' + export * from './all' + `), + ).toMatchInlineSnapshot(` + { + "bindings": [ + [ + "DefaultRoute", + null, + ], + [ + "defaultImport", + "pkg:default", + ], + [ + "exported", + "Identifier", + ], + [ + "loader", + null, + ], + [ + "local", + "Identifier", + ], + [ + "localNamed", + "pkg:named", + ], + [ + "ns", + "pkg-ns:*", + ], + [ + "remote", + "./remote:remote", + ], + ], + "exports": [ + [ + "default", + "DefaultRoute", + ], + [ + "exported", + "exported", + ], + [ + "loader", + "loader", + ], + [ + "renamed", + "remote", + ], + ], + "reExportAllSources": [ + "./all", + ], + } + `) + }) +}) diff --git a/packages/router-utils/tests/stripTypeExports.test.ts b/packages/router-utils/tests/stripTypeExports.test.ts index d0c6af3ad7..32d25f1cbe 100644 --- a/packages/router-utils/tests/stripTypeExports.test.ts +++ b/packages/router-utils/tests/stripTypeExports.test.ts @@ -123,7 +123,7 @@ type TypeOnly = string; export { value, type TypeOnly };` const result = transform(code) expect(result).toContain('export { value }') - expect(result).not.toContain('TypeOnly') + expect(result).toContain('type TypeOnly = string') }) test('removes entire export if all specifiers are type-only', () => { @@ -133,8 +133,8 @@ export { type Foo, type Bar }; export const value = 1;` const result = transform(code) expect(result).not.toContain('export { type Foo') - expect(result).not.toContain('Foo') - expect(result).not.toContain('Bar') + expect(result).toContain('type Foo = string') + expect(result).toContain('type Bar = number') expect(result).toContain('export const value = 1') }) }) @@ -233,9 +233,11 @@ export { helper, type HelperType };` expect(result).not.toContain('./types') expect(result).not.toContain('HelperType') - // Should remove type declarations - expect(result).not.toContain('type LocalType') - expect(result).not.toContain('interface LocalInterface') + // Should preserve local type declarations + expect(result).toContain('type LocalType = string') + expect(result).toContain('interface LocalInterface') + + // Should remove exported type declarations expect(result).not.toContain('type ExportedType') expect(result).not.toContain('interface ExportedInterface') diff --git a/packages/solid-router/src/ClientOnly.tsx b/packages/solid-router/src/ClientOnly.tsx index 6ed10d267b..a7c4b71819 100644 --- a/packages/solid-router/src/ClientOnly.tsx +++ b/packages/solid-router/src/ClientOnly.tsx @@ -56,10 +56,15 @@ export function ClientOnly(props: ClientOnlyProps) { * ``` * @returns True if the JS has been hydrated already, false otherwise. */ +let globalHydrated = false + export function useHydrated(): Solid.Accessor { - const [hydrated, setHydrated] = Solid.createSignal(false) + const [hydrated, setHydrated] = Solid.createSignal(globalHydrated) + Solid.onMount(() => { + globalHydrated = true setHydrated(true) }) + return hydrated } diff --git a/packages/solid-start-client/package.json b/packages/solid-start-client/package.json index 7bcb2876cd..b01b0a28af 100644 --- a/packages/solid-start-client/package.json +++ b/packages/solid-start-client/package.json @@ -48,6 +48,12 @@ "default": "./dist/esm/index.js" } }, + "./hydration": { + "import": { + "types": "./dist/esm/hydration.d.ts", + "default": "./dist/esm/hydration.js" + } + }, "./package.json": "./package.json" }, "sideEffects": false, diff --git a/packages/solid-start-client/src/GenericHydrate.tsx b/packages/solid-start-client/src/GenericHydrate.tsx new file mode 100644 index 0000000000..e23c057f34 --- /dev/null +++ b/packages/solid-start-client/src/GenericHydrate.tsx @@ -0,0 +1,376 @@ +import * as Solid from 'solid-js' +import { Dynamic } from 'solid-js/web' + +import { useHydrated } from '@tanstack/solid-router' +import { isServer } from '@tanstack/router-core/isServer' +import { + hydrateIdAttribute, + hydrateWhenAttribute, +} from '@tanstack/start-client-core/hydration/constants' +import { + createResolvedGate, + getFallbackHtml, + getOrCreateGate, + onGateResolve, + releaseGate, + runHydrationStrategyCleanup, + saveFallbackHtml, + waitForHydrationPrefetchStrategy, +} from '@tanstack/start-client-core/hydration/runtime' +import { listenForDelegatedHydrationIntent } from '@tanstack/start-client-core/hydration' +import type { + HydrationRuntimeContext, + HydrationStrategy, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' +import type { HydrationGateRecord } from '@tanstack/start-client-core/hydration/runtime' +import type { InternalHydrateProps } from './Hydrate' +import type { DynamicProps } from 'solid-js/web' + +type HydrationFallbackDynamicProps = DynamicProps<'div'> +type HydrationMarkerDynamicProps = DynamicProps<'div'> & { + [hydrateIdAttribute]: string + [hydrateWhenAttribute]: HydrationWhen + [key: `data-${string}`]: string | undefined +} +type PrefetchController = { + abortController: AbortController + hydrationRequested: boolean + hydrationListeners: Set<() => void> + hydrationResolvePending: boolean + started: boolean + promise?: Promise +} + +const hydrateIdSelector = `[${hydrateIdAttribute}]` +const dynamicType = 'dynamic' +const dynamicHydrateStrategy = { + _t: dynamicType, + _d: () => true, +} satisfies HydrationStrategy + +function shouldDeferHydration(strategy: HydrationStrategy) { + return strategy._d ? strategy._d() : strategy._t !== 'load' +} + +/* @__NO_SIDE_EFFECTS__ */ +function HydratedBoundary(props: { + id: string + onHydrated?: () => void + onStrategyHydrated?: (id: string) => void + children: Solid.JSX.Element +}) { + let didHydrate = false + + Solid.onMount(() => { + if (didHydrate) return + didHydrate = true + props.onHydrated?.() + props.onStrategyHydrated?.(props.id) + }) + + return props.children +} + +/* @__NO_SIDE_EFFECTS__ */ +export function GenericHydrate(props: InternalHydrateProps) { + const when = props.when + const dynamicHydrate = typeof when === 'function' + const initialHydrateStrategy: HydrationStrategy = dynamicHydrate + ? // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') + ? dynamicHydrateStrategy + : when() + : when + const markerHydrateType: HydrationWhen = dynamicHydrate + ? dynamicType + : initialHydrateStrategy._t! + const prefetchStrategy = () => props.prefetch + const hydrated = useHydrated() + const uniqueId = Solid.createUniqueId() + const id = props.h ? `${props.h}${uniqueId}` : uniqueId + const initialHydrateType = initialHydrateStrategy._t! + const shouldPreserveServerHTML = + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || !hydrated() + const shouldDeferInitialHydration = + !hydrated() && shouldDeferHydration(initialHydrateStrategy) + const gate: HydrationGateRecord = + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') + ? createResolvedGate(id, initialHydrateType) + : getOrCreateGate(id, initialHydrateType) + const [ready, setReady] = Solid.createSignal( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || + (!shouldDeferInitialHydration && initialHydrateType !== 'never'), + ) + const [prefetchError, setPrefetchError] = Solid.createSignal() + const controller: PrefetchController = { + abortController: new AbortController(), + hydrationRequested: false, + hydrationListeners: new Set<() => void>(), + hydrationResolvePending: false, + started: false, + } + let didPrefetch = false + let markerElement: HTMLDivElement | undefined + + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + !(isServer ?? typeof window === 'undefined') && + initialHydrateType !== 'never' && + (!shouldDeferInitialHydration || + !shouldDeferHydration(initialHydrateStrategy)) + ) { + gate.resolve() + } + + const onHydrate = (listener: () => void) => { + if (controller.hydrationRequested) { + listener() + return () => {} + } + + controller.hydrationListeners.add(listener) + return () => { + controller.hydrationListeners.delete(listener) + } + } + + const requestHydration = () => { + if (!controller.hydrationRequested) { + controller.hydrationRequested = true + controller.hydrationListeners.forEach((listener) => listener()) + controller.hydrationListeners.clear() + } + + if (!controller.promise) { + resolveGate() + return + } + if (controller.hydrationResolvePending) return + controller.hydrationResolvePending = true + + controller.promise.then( + () => resolveGate(), + (error) => { + if (!controller.abortController.signal.aborted) { + setPrefetchError(() => error) + } + }, + ) + } + const resolveGate = gate.resolve + + Solid.onMount(() => { + const currentHydrateStrategy = initialHydrateStrategy + const currentPrefetchStrategy = prefetchStrategy() + const currentHydrateType = currentHydrateStrategy._t! + gate.when = currentHydrateType + for (const element of document.querySelectorAll( + hydrateIdSelector, + )) { + if (element.getAttribute(hydrateIdAttribute) === id) { + markerElement = element + saveFallbackHtml(id, element) + break + } + } + + if ( + currentHydrateType === 'never' && + !shouldPreserveServerHTML && + markerElement + ) { + markerElement.replaceChildren() + } + + if (currentPrefetchStrategy && !controller.started) { + controller.started = true + const preload = () => props.p?.() ?? Promise.resolve() + + if (typeof currentPrefetchStrategy === 'function') { + const promise = Promise.resolve() + .then(() => + currentPrefetchStrategy({ + element: markerElement ?? null, + signal: controller.abortController.signal, + preload, + waitFor: (strategy) => + waitForHydrationPrefetchStrategy(strategy, { + element: markerElement ?? null, + signal: controller.abortController.signal, + onHydrate, + }), + }), + ) + .then(() => undefined) + + controller.promise = promise + promise.catch((error) => { + if (!controller.abortController.signal.aborted) { + setPrefetchError(() => error) + } + }) + } else if (props.p) { + const currentStrategy = currentPrefetchStrategy + const prefetch = () => { + if (didPrefetch) return + didPrefetch = true + void preload() + } + const cleanupPrefetch = runHydrationStrategyCleanup( + currentStrategy._s?.({ + element: markerElement ?? null, + prefetch, + }), + ) + if (cleanupPrefetch) Solid.onCleanup(cleanupPrefetch) + } + } + + if ( + currentHydrateType !== 'never' && + (!shouldDeferInitialHydration || + !shouldDeferHydration(currentHydrateStrategy)) + ) { + gate.resolve() + setReady(true) + } + + const cleanups: Array<() => void> = [] + let removeResolveListener = () => {} + let disposed = false + + const resolveBoundary = () => { + setReady(true) + } + + const cleanup = () => { + if (disposed) return + disposed = true + if (gate.resolve === requestHydration) { + gate.resolve = resolveGate + } + removeResolveListener() + cleanups.forEach((fn) => fn()) + } + + const addCleanup = (fn: void | (() => void)) => { + if (!fn) return + if (disposed || gate.resolved) { + fn() + return + } + cleanups.push(fn) + } + + Solid.onCleanup(() => { + controller.abortController.abort() + controller.hydrationListeners.clear() + cleanup() + releaseGate(gate) + }) + + removeResolveListener = onGateResolve(gate, () => { + cleanup() + resolveBoundary() + }) + + if ( + gate.resolved || + !shouldDeferInitialHydration || + currentHydrateType === 'never' + ) { + if (gate.resolved) resolveBoundary() + return + } + + gate.resolve = requestHydration + const context: HydrationRuntimeContext = { + element: markerElement ?? null, + gate, + } + addCleanup( + runHydrationStrategyCleanup(currentHydrateStrategy._s?.(context)), + ) + + if (currentHydrateStrategy._t !== 'interaction') { + addCleanup( + runHydrationStrategyCleanup( + markerElement + ? listenForDelegatedHydrationIntent(markerElement, context) + : undefined, + ), + ) + } + }) + + Solid.createRenderEffect(() => { + if ( + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + (isServer ?? typeof window === 'undefined') || + gate.resolved || + initialHydrateStrategy._t === 'never' || + shouldDeferHydration(initialHydrateStrategy) + ) { + return + } + + gate.resolve() + }) + + const markerAttributes = + markerHydrateType === dynamicType + ? undefined + : initialHydrateStrategy._a?.() + const markerProps: HydrationMarkerDynamicProps = { + component: 'div', + [hydrateIdAttribute]: id, + [hydrateWhenAttribute]: markerHydrateType, + ...markerAttributes, + } + const fallback = () => { + if (!shouldPreserveServerHTML) return props.fallback ?? null + + const html = getFallbackHtml(id) + if (!html) return null + + const fallbackProps: HydrationFallbackDynamicProps = { + component: 'div', + style: { display: 'contents' }, + innerHTML: html, + } + + return + } + + return ( + + {(() => { + const error = prefetchError() + if (error) throw error + return null + })()} + {initialHydrateType === 'never' && !shouldPreserveServerHTML ? ( + (props.fallback ?? null) + ) : ( + + + { + markerElement?.removeAttribute(hydrateWhenAttribute) + initialHydrateStrategy._o?.(id) + }} + > + {props.children} + + + + )} + + ) +} diff --git a/packages/solid-start-client/src/Hydrate.tsx b/packages/solid-start-client/src/Hydrate.tsx new file mode 100644 index 0000000000..1b52e643f2 --- /dev/null +++ b/packages/solid-start-client/src/Hydrate.tsx @@ -0,0 +1,75 @@ +import { GenericHydrate } from './GenericHydrate' +import type { + HydrationStrategy as CoreHydrationStrategy, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' +import type * as Solid from 'solid-js' + +export type { + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationWhen, +} from '@tanstack/start-client-core/hydration' + +export type SolidHydrationStrategy< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = CoreHydrationStrategy & { + _h: (props: HydrateProps) => Solid.JSX.Element +} + +export type HydrationStrategy< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = SolidHydrationStrategy + +export type HydrateWhen = + | SolidHydrationStrategy + | (() => SolidHydrationStrategy) + +type HydrateCommonOptions = { + when: HydrateWhen + fallback?: Solid.JSX.Element + onHydrated?: () => void +} + +export type HydrateOptions = + | (HydrateCommonOptions & { + prefetch?: never + split?: boolean + }) + | (HydrateCommonOptions & { + prefetch: HydrationPrefetchStrategy + split?: true + }) + | (HydrateCommonOptions & { + prefetch: HydrationPrefetchFunction + split?: boolean + }) + +export type HydrateProps = HydrateOptions & { + children: Solid.JSX.Element +} + +export type InternalHydrateProps = HydrateProps & { + h?: string + p?: () => Promise +} + +/* @__NO_SIDE_EFFECTS__ */ +export function Hydrate(props: HydrateProps) { + if ( + typeof props.when === 'function' || + typeof props.prefetch === 'function' + ) { + return + } + + return props.when._h(props) +} diff --git a/packages/solid-start-client/src/hydration.ts b/packages/solid-start-client/src/hydration.ts new file mode 100644 index 0000000000..bd875dcb0a --- /dev/null +++ b/packages/solid-start-client/src/hydration.ts @@ -0,0 +1,20 @@ +export { condition, interaction, media } from './hydration/generic' +export { idle } from './hydration/idle' +export { load } from './hydration/load' +export { never } from './hydration/never' +export { visible } from './hydration/visible' +export type { + HydrationCondition, + HydrationInteractionEvent, + HydrationInteractionEvents, + IdleHydrationOptions, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchWhen, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationStrategyTypes, + HydrationWhen, + VisibleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +export type { HydrationStrategy, SolidHydrationStrategy } from './Hydrate' diff --git a/packages/solid-start-client/src/hydration/generic.ts b/packages/solid-start-client/src/hydration/generic.ts new file mode 100644 index 0000000000..bfc1e8db9f --- /dev/null +++ b/packages/solid-start-client/src/hydration/generic.ts @@ -0,0 +1,41 @@ +import { + condition as coreCondition, + interaction as coreInteraction, + media as coreMedia, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { + HydrationCondition, + HydrationInteractionEvents, + HydrationPrefetchStrategy, +} from '@tanstack/start-client-core/hydration' +import type { SolidHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function media( + query: string, +): SolidHydrationStrategy<'media', true> & HydrationPrefetchStrategy<'media'> { + return /* @__PURE__ */ withHydrationRenderer(coreMedia(query), GenericHydrate) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function condition( + condition: HydrationCondition, +): SolidHydrationStrategy<'condition', false> { + return /* @__PURE__ */ withHydrationRenderer( + coreCondition(condition), + GenericHydrate, + ) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function interaction(options?: { + events?: HydrationInteractionEvents +}): SolidHydrationStrategy<'interaction', true> & + HydrationPrefetchStrategy<'interaction'> { + return /* @__PURE__ */ withHydrationRenderer( + coreInteraction(options), + GenericHydrate, + ) +} diff --git a/packages/solid-start-client/src/hydration/idle.ts b/packages/solid-start-client/src/hydration/idle.ts new file mode 100644 index 0000000000..89282b0a95 --- /dev/null +++ b/packages/solid-start-client/src/hydration/idle.ts @@ -0,0 +1,20 @@ +import { + idle as coreIdle, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { + HydrationPrefetchStrategy, + IdleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +import type { SolidHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function idle( + options: IdleHydrationOptions = {}, +): SolidHydrationStrategy<'idle', true> & HydrationPrefetchStrategy<'idle'> { + return /* @__PURE__ */ withHydrationRenderer( + coreIdle(options), + GenericHydrate, + ) +} diff --git a/packages/solid-start-client/src/hydration/load.tsx b/packages/solid-start-client/src/hydration/load.tsx new file mode 100644 index 0000000000..a2836231e8 --- /dev/null +++ b/packages/solid-start-client/src/hydration/load.tsx @@ -0,0 +1,13 @@ +import { + load as coreLoad, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { HydrationPrefetchStrategy } from '@tanstack/start-client-core/hydration' +import type { SolidHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function load(): SolidHydrationStrategy<'load', true> & + HydrationPrefetchStrategy<'load'> { + return /* @__PURE__ */ withHydrationRenderer(coreLoad(), GenericHydrate) +} diff --git a/packages/solid-start-client/src/hydration/never.ts b/packages/solid-start-client/src/hydration/never.ts new file mode 100644 index 0000000000..36513b95d4 --- /dev/null +++ b/packages/solid-start-client/src/hydration/never.ts @@ -0,0 +1,11 @@ +import { + never as coreNever, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { SolidHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function never(): SolidHydrationStrategy<'never', false> { + return /* @__PURE__ */ withHydrationRenderer(coreNever(), GenericHydrate) +} diff --git a/packages/solid-start-client/src/hydration/visible.tsx b/packages/solid-start-client/src/hydration/visible.tsx new file mode 100644 index 0000000000..c747c236ec --- /dev/null +++ b/packages/solid-start-client/src/hydration/visible.tsx @@ -0,0 +1,21 @@ +import { + visible as coreVisible, + withHydrationRenderer, +} from '@tanstack/start-client-core/hydration' +import { GenericHydrate } from '../GenericHydrate' +import type { + HydrationPrefetchStrategy, + VisibleHydrationOptions, +} from '@tanstack/start-client-core/hydration' +import type { SolidHydrationStrategy } from '../Hydrate' + +/* @__NO_SIDE_EFFECTS__ */ +export function visible( + options?: VisibleHydrationOptions, +): SolidHydrationStrategy<'visible', true> & + HydrationPrefetchStrategy<'visible'> { + return /* @__PURE__ */ withHydrationRenderer( + coreVisible(options), + GenericHydrate, + ) +} diff --git a/packages/solid-start-client/src/index.tsx b/packages/solid-start-client/src/index.tsx index aa73990a57..2128ebcb01 100644 --- a/packages/solid-start-client/src/index.tsx +++ b/packages/solid-start-client/src/index.tsx @@ -1,2 +1,16 @@ export { StartClient } from './StartClient' export { hydrateStart } from './hydrateStart' +export { Hydrate } from './Hydrate' +export type { + HydrateOptions, + HydrateProps, + HydrateWhen, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationStrategy, + HydrationWhen, +} from './Hydrate' diff --git a/packages/solid-start-client/src/tests/Hydrate.test-d.tsx b/packages/solid-start-client/src/tests/Hydrate.test-d.tsx new file mode 100644 index 0000000000..e5e13334f3 --- /dev/null +++ b/packages/solid-start-client/src/tests/Hydrate.test-d.tsx @@ -0,0 +1,147 @@ +import { expectTypeOf, test } from 'vitest' +import { visible } from '../hydration' +import { Hydrate } from '../Hydrate' +import type { + HydrateOptions, + HydrateProps, + HydrationPrefetchFunction, + HydrationPrefetchStrategy, + HydrationStrategy, +} from '../Hydrate' +import type { HydrationStrategy as CoreHydrationStrategy } from '@tanstack/start-client-core/hydration' +import type { JSX } from 'solid-js' + +type CommonHydrateProps = { + fallback?: JSX.Element + onHydrated?: () => void + children: JSX.Element +} + +type SplitHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch?: never + split?: boolean +} + +type PrefetchHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch: HydrationPrefetchStrategy + split?: true +} + +type FunctionPrefetchHydrateProps = CommonHydrateProps & { + when: HydrationStrategy | (() => HydrationStrategy) + prefetch: HydrationPrefetchFunction + split?: boolean +} + +test('Hydrate component accepts the public HydrateProps type', () => { + expectTypeOf(Hydrate).toBeFunction() + expectTypeOf(Hydrate).parameter(0).branded.toEqualTypeOf() +}) + +test('HydrateOptions supports reusable spread props', () => { + const belowFoldProps = { + when: () => visible({ rootMargin: '800px' }), + } satisfies HydrateOptions + + expectTypeOf(belowFoldProps).toMatchTypeOf() + + const withFunctionPrefetch = { + when: visible(), + split: false, + prefetch: (ctx) => { + expectTypeOf(ctx.element).toEqualTypeOf() + expectTypeOf(ctx.signal).toEqualTypeOf() + expectTypeOf(ctx.preload).returns.toEqualTypeOf>() + expectTypeOf(ctx.waitFor).returns.toEqualTypeOf< + Promise<'prefetch' | 'hydrate' | 'abort'> + >() + }, + } satisfies HydrateOptions + + expectTypeOf(withFunctionPrefetch).toMatchTypeOf() +}) + +test('Hydrate props are exact for strategy and prefetch forms', () => { + expectTypeOf< + Extract + >().branded.toEqualTypeOf() + expectTypeOf< + Extract + >().branded.toEqualTypeOf() + expectTypeOf< + Extract + >().branded.toEqualTypeOf() +}) + +test('Hydrate requires a strategy', () => { + expectTypeOf<{ + when: HydrationStrategy + children: JSX.Element + }>().toMatchTypeOf() + + expectTypeOf<{ + when: () => HydrationStrategy + children: JSX.Element + }>().toMatchTypeOf() + + expectTypeOf<{ + children: JSX.Element + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: () => true + children: JSX.Element + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: false + children: JSX.Element + }>().not.toMatchTypeOf() +}) + +test('Hydrate requires a framework-renderable strategy', () => { + expectTypeOf().not.toMatchTypeOf() + expectTypeOf>().toMatchTypeOf() + + expectTypeOf<{ + when: CoreHydrationStrategy + children: JSX.Element + }>().not.toMatchTypeOf() +}) + +test('Hydrate enforces prefetch only with split boundaries', () => { + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + children: JSX.Element + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + split: true + children: JSX.Element + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchStrategy + split: false + children: JSX.Element + }>().not.toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchFunction + split: false + children: JSX.Element + }>().toMatchTypeOf() + + expectTypeOf<{ + when: HydrationStrategy + prefetch: HydrationPrefetchFunction + children: JSX.Element + }>().toMatchTypeOf() +}) diff --git a/packages/solid-start-client/vite.config.ts b/packages/solid-start-client/vite.config.ts index be71bab518..dbfb60ea03 100644 --- a/packages/solid-start-client/vite.config.ts +++ b/packages/solid-start-client/vite.config.ts @@ -20,7 +20,7 @@ export default mergeConfig( tanstackViteConfig({ tsconfigPath: './tsconfig.build.json', srcDir: './src', - entry: './src/index.tsx', + entry: ['./src/index.tsx', './src/Hydrate.tsx', './src/hydration.ts'], cjs: false, }), ) diff --git a/packages/solid-start/package.json b/packages/solid-start/package.json index de2ecd1c22..e902fe7abb 100644 --- a/packages/solid-start/package.json +++ b/packages/solid-start/package.json @@ -44,6 +44,12 @@ "default": "./dist/esm/client.js" } }, + "./hydration": { + "import": { + "types": "./dist/esm/hydration.d.ts", + "default": "./dist/esm/hydration.js" + } + }, "./client-rpc": { "import": { "types": "./dist/esm/client-rpc.d.ts", diff --git a/packages/solid-start/src/hydration.ts b/packages/solid-start/src/hydration.ts new file mode 100644 index 0000000000..fc660e9dc5 --- /dev/null +++ b/packages/solid-start/src/hydration.ts @@ -0,0 +1,18 @@ +export { + condition, + idle, + interaction, + load, + media, + never, + visible, +} from '@tanstack/solid-start-client/hydration' +export type { + HydrationCondition, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchStrategy, + HydrationStrategy, + HydrationWhen, + VisibleHydrationOptions, +} from '@tanstack/solid-start-client/hydration' diff --git a/packages/solid-start/src/index.ts b/packages/solid-start/src/index.ts index 8b51b6c783..0cdac87c81 100644 --- a/packages/solid-start/src/index.ts +++ b/packages/solid-start/src/index.ts @@ -1,2 +1,12 @@ export { useServerFn } from './useServerFn' export * from '@tanstack/start-client-core' +export { Hydrate } from '@tanstack/solid-start-client' +export type { + HydrateOptions, + HydrateProps, + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationPrefetchStrategy, + HydrationStrategy, + HydrationWhen, +} from '@tanstack/solid-start-client' diff --git a/packages/solid-start/vite.config.ts b/packages/solid-start/vite.config.ts index 262208de09..2c1a42d0e4 100644 --- a/packages/solid-start/vite.config.ts +++ b/packages/solid-start/vite.config.ts @@ -27,6 +27,7 @@ export default mergeConfig( entry: [ './src/index.ts', './src/client.tsx', + './src/hydration.ts', './src/client-rpc.ts', './src/ssr-rpc.ts', './src/server-rpc.ts', diff --git a/packages/start-client-core/package.json b/packages/start-client-core/package.json index 811c106ee2..ca7e9bd076 100644 --- a/packages/start-client-core/package.json +++ b/packages/start-client-core/package.json @@ -60,16 +60,37 @@ "default": "./dist/esm/client-rpc/index.js" } }, + "./hydration": { + "import": { + "types": "./dist/esm/hydration.d.ts", + "default": "./dist/esm/hydration.js" + } + }, + "./hydration/constants": { + "import": { + "types": "./dist/esm/hydration/constants.d.ts", + "default": "./dist/esm/hydration/constants.js" + } + }, + "./hydration/runtime": { + "import": { + "types": "./dist/esm/hydration/runtime.d.ts", + "default": "./dist/esm/hydration/runtime.js" + } + }, "./package.json": "./package.json" }, "imports": { "#tanstack-start-entry": { + "types": "./src/start-entry.d.ts", "default": "./dist/esm/fake-entries/start.js" }, "#tanstack-router-entry": { + "types": "./src/start-entry.d.ts", "default": "./dist/esm/fake-entries/router.js" }, "#tanstack-start-plugin-adapters": { + "types": "./src/start-entry.d.ts", "default": "./dist/esm/fake-entries/plugin-adapters.js" } }, diff --git a/packages/start-client-core/src/client/hydrateStart.ts b/packages/start-client-core/src/client/hydrateStart.ts index 206b70505c..83b9c468af 100644 --- a/packages/start-client-core/src/client/hydrateStart.ts +++ b/packages/start-client-core/src/client/hydrateStart.ts @@ -1,5 +1,4 @@ import { hydrate } from '@tanstack/router-core/ssr/client' - import { startInstance } from '#tanstack-start-entry' import { hasPluginAdapters, @@ -10,7 +9,19 @@ import { ServerFunctionSerializationAdapter } from './ServerFunctionSerializatio import type { AnyRouter, AnySerializationAdapter } from '@tanstack/router-core' import type { AnyStartInstanceOptions } from '../createStart' -export async function hydrateStart(): Promise { +type HotContext = { + data?: Record + dispose?: (cb: (data: Record) => void) => void +} + +declare global { + interface ImportMeta { + hot?: HotContext + webpackHot?: HotContext + } +} + +async function hydrateStart(): Promise { const router = await getRouter() let serializationAdapters: Array @@ -47,3 +58,38 @@ export async function hydrateStart(): Promise { return router } + +function hydrateStartWithHmr(): Promise { + const hot = import.meta.hot ?? import.meta.webpackHot + + if (!hot) { + return hydrateStart() + } + + const key = 'tss-hydrate-start-promise' + const hotData = (hot.data ??= {}) + let hydrationPromise = hotData[key] as Promise | undefined + + if (!hydrationPromise) { + hydrationPromise = hydrateStart().catch((error) => { + if (hotData[key] === hydrationPromise) { + hotData[key] = undefined + } + + throw error + }) + + hotData[key] = hydrationPromise + } + + hot.dispose?.((data) => { + data[key] = hotData[key] + }) + + return hydrationPromise +} + +const exportedHydrateStart = + process.env.NODE_ENV !== 'production' ? hydrateStartWithHmr : hydrateStart + +export { exportedHydrateStart as hydrateStart } diff --git a/packages/start-client-core/src/hydration.ts b/packages/start-client-core/src/hydration.ts new file mode 100644 index 0000000000..934b73116f --- /dev/null +++ b/packages/start-client-core/src/hydration.ts @@ -0,0 +1,50 @@ +import { hydrateIdAttribute } from './hydration/constants' + +export { condition } from './hydration/condition' +export type { HydrationCondition } from './hydration/condition' +export { + hydrateIdAttribute, + hydrateInteractionEventsAttribute, + hydrateWhenAttribute, +} from './hydration/constants' +export const hydrateIdSelector = `[${hydrateIdAttribute}]` +export { idle } from './hydration/idle' +export type { IdleHydrationOptions } from './hydration/idle' +export { interaction } from './hydration/interaction' +export { load } from './hydration/load' +export { media } from './hydration/media' +export { never } from './hydration/never' +export { + clearResolvedGateIdsInMarker, + createResolvedGate, + getFallbackHtml, + getMarkerGate, + getOrCreateGate, + onGateResolve, + releaseGate, + resolveHydrationMarker, + runHydrationStrategyCleanup, + saveFallbackHtml, + waitForHydrationPrefetchStrategy, +} from './hydration/runtime' +export { withHydrationRenderer } from './hydration/renderer' +export { visible } from './hydration/visible' +export { listenForDelegatedHydrationIntent } from './hydration/interaction' +export type { VisibleHydrationOptions } from './hydration/visible' +export type { HydrationGateRecord } from './hydration/runtime' +export type { HydrationStrategyWithRenderer } from './hydration/renderer' +export type { + HydrationInteractionEvent, + HydrationInteractionEvents, + HydrationMarkerAttributes, + HydrationPrefetchContext, + HydrationPrefetchFunction, + HydrationPrefetchWhen, + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationRuntimeContext, + HydrationRuntimeGate, + HydrationStrategy, + HydrationStrategyTypes, + HydrationWhen, +} from './hydration/types' diff --git a/packages/start-client-core/src/hydration/condition.ts b/packages/start-client-core/src/hydration/condition.ts new file mode 100644 index 0000000000..6e640cc3ae --- /dev/null +++ b/packages/start-client-core/src/hydration/condition.ts @@ -0,0 +1,20 @@ +import type { HydrationStrategy } from './types' + +const conditionType = 'condition' + +export type HydrationCondition = boolean | (() => boolean) + +/* @__NO_SIDE_EFFECTS__ */ +export function condition( + condition: HydrationCondition, +): HydrationStrategy { + return { + _t: conditionType, + _d: () => !(typeof condition === 'function' ? condition() : condition), + _s: ({ gate }) => { + if (typeof condition === 'function' ? condition() : condition) { + gate!.resolve() + } + }, + } +} diff --git a/packages/start-client-core/src/hydration/constants.ts b/packages/start-client-core/src/hydration/constants.ts new file mode 100644 index 0000000000..4b7a29313d --- /dev/null +++ b/packages/start-client-core/src/hydration/constants.ts @@ -0,0 +1,4 @@ +export const hydrateIdAttribute = 'data-ts-hydrate-id' +export const hydrateWhenAttribute = 'data-ts-hydrate-when' +export const hydrateInteractionEventsAttribute = + 'data-ts-hydrate-interaction-events' diff --git a/packages/start-client-core/src/hydration/idle.ts b/packages/start-client-core/src/hydration/idle.ts new file mode 100644 index 0000000000..bf0dc71131 --- /dev/null +++ b/packages/start-client-core/src/hydration/idle.ts @@ -0,0 +1,35 @@ +import type { HydrationPrefetchStrategy } from './types' + +const idleType = 'idle' + +export type IdleHydrationOptions = { + timeout?: number +} + +export function idle( + options: IdleHydrationOptions = {}, +): HydrationPrefetchStrategy { + const timeout = options.timeout ?? 2000 + + return { + _t: idleType, + _s: ({ gate, prefetch }) => { + const schedule = globalThis as unknown as { + requestIdleCallback?: ( + callback: IdleRequestCallback, + options?: IdleRequestOptions, + ) => number + cancelIdleCallback?: (handle: number) => void + } + const callback = prefetch ?? gate!.resolve + + if (schedule.requestIdleCallback) { + const handle = schedule.requestIdleCallback(callback, { timeout }) + return () => schedule.cancelIdleCallback?.(handle) + } + + const timeoutId = globalThis.setTimeout(callback, timeout) + return () => globalThis.clearTimeout(timeoutId) + }, + } +} diff --git a/packages/start-client-core/src/hydration/interaction.ts b/packages/start-client-core/src/hydration/interaction.ts new file mode 100644 index 0000000000..d5d6886d36 --- /dev/null +++ b/packages/start-client-core/src/hydration/interaction.ts @@ -0,0 +1,342 @@ +import { + hydrateIdAttribute, + hydrateInteractionEventsAttribute, + hydrateWhenAttribute, +} from './constants' +import { + clearResolvedGateIdsInMarker, + getMarkerGate, + resolveHydrationMarker, +} from './runtime' +import type { + HydrationInteractionEvents, + HydrationPrefetchStrategy, + HydrationRuntimeContext, +} from './types' + +export type InteractionHydrationOptions = { + events?: HydrationInteractionEvents +} + +const hydrateIdSelector = `[${hydrateIdAttribute}]` + +type PendingReplayEvent = { + marker: Element + targetPath: Array + type: string + event: Event +} + +const defaultInteractionEvents = [ + 'pointerenter', + 'focusin', + 'pointerdown', + 'click', +] as const +const supportedInteractionEvents = [ + 'auxclick', + 'click', + 'contextmenu', + 'dblclick', + 'focusin', + 'keydown', + 'keyup', + 'mousedown', + 'mouseenter', + 'mouseover', + 'mouseup', + 'pointerdown', + 'pointerenter', + 'pointerover', + 'pointerup', +] as const +const interactionType = 'interaction' +const dynamicType = 'dynamic' +const interactionHydrateSelector = `[${hydrateWhenAttribute}="${interactionType}"]` +const delegatedHydrateSelector = `${interactionHydrateSelector},[${hydrateWhenAttribute}="${dynamicType}"]` +const replayEventsByGateId = /* @__PURE__ */ new Map< + string, + Array +>() + +function getIntentListenerEvents( + marker: Element, + events: ReadonlyArray, +) { + const listenerEvents = new Set(events) + + marker.querySelectorAll(delegatedHydrateSelector).forEach((childMarker) => { + if (childMarker.getAttribute(hydrateWhenAttribute) === dynamicType) { + supportedInteractionEvents.forEach((eventName) => { + listenerEvents.add(eventName) + }) + return + } + + const attr = childMarker.getAttribute(hydrateInteractionEventsAttribute) + for (const eventName of attr === null + ? defaultInteractionEvents + : attr.split(/\s+/).filter(Boolean)) { + listenerEvents.add(eventName) + } + }) + + return [...listenerEvents] +} + +function queueHydrationReplayEvent(marker: Element, event: Event) { + if (!event.bubbles) return + + const id = marker.getAttribute(hydrateIdAttribute) + const when = marker.getAttribute(hydrateWhenAttribute) + if (!id || !when || when === 'never') return + + const target = event.target + if (!target) return + + const gate = getMarkerGate(marker) + if (gate?.resolved) return + + event.preventDefault() + event.stopPropagation() + event.stopImmediatePropagation() + + let targetPath: Array = [] + if (target instanceof Node && marker.contains(target)) { + let node: Element | null = + target instanceof Element ? target : target.parentElement + + while (node && node !== marker) { + const parent = node.parentElement + if (!parent) { + targetPath = [] + break + } + targetPath.push(Array.prototype.indexOf.call(parent.children, node)) + node = parent + } + targetPath.reverse() + } + + const pendingEvents = replayEventsByGateId.get(id) ?? [] + pendingEvents.push({ + marker, + targetPath, + type: event.type, + event, + }) + replayEventsByGateId.set(id, pendingEvents) +} + +if (typeof document !== 'undefined') { + const onIntent = (event: Event) => { + const target = event.target + if (!(target instanceof Element)) return + + let marker: Element | null = target.closest(hydrateIdSelector) + const markers: Array = [] + let shouldHandle = false + + while (marker) { + markers.push(marker) + + const when = marker.getAttribute(hydrateWhenAttribute) + if (when === dynamicType) { + shouldHandle ||= event.type === 'click' + } else if (when === interactionType) { + const attr = marker.getAttribute(hydrateInteractionEventsAttribute) + const events: ReadonlyArray = + attr === null + ? defaultInteractionEvents + : attr.split(/\s+/).filter(Boolean) + shouldHandle ||= events.includes(event.type) + } + + marker = marker.parentElement?.closest(hydrateIdSelector) ?? null + } + + if (!shouldHandle) return + + markers.reverse() + if (markers.every((marker) => getMarkerGate(marker))) return + + markers.forEach((marker) => { + queueHydrationReplayEvent(marker, event) + resolveHydrationMarker(marker) + }) + } + + supportedInteractionEvents.forEach((eventName) => { + document.addEventListener(eventName, onIntent, true) + }) +} + +function listenForIntent( + element: Element, + events: ReadonlyArray, + context: HydrationRuntimeContext, +) { + const onIntent = (event: Event) => { + const target = event.target + let marker: Element | null + if (target instanceof Element) { + const closestMarker = target.closest(hydrateIdSelector) + marker = + closestMarker && element.contains(closestMarker) + ? closestMarker + : element + } else { + marker = element + } + + const markers: Array = [] + while (marker) { + if (marker.hasAttribute(hydrateIdAttribute)) { + markers.push(marker) + } + if (marker === element) break + marker = marker.parentElement + } + + if (!markers.includes(element)) { + markers.push(element) + } + + markers.reverse() + + if ( + context.delegated && + !markers.some( + (marker) => + marker.getAttribute(hydrateWhenAttribute) === interactionType || + marker.getAttribute(hydrateWhenAttribute) === dynamicType, + ) + ) { + return + } + + markers.forEach((marker) => { + queueHydrationReplayEvent(marker, event) + resolveHydrationMarker(marker) + }) + } + let disposed = false + + events.forEach((eventName) => { + element.addEventListener(eventName, onIntent, true) + }) + + return () => { + if (disposed) return + disposed = true + events.forEach((eventName) => { + element.removeEventListener(eventName, onIntent, true) + }) + } +} + +export function listenForDelegatedHydrationIntent( + element: Element, + context: HydrationRuntimeContext, +) { + const listenerEvents = getIntentListenerEvents(element, []) + if (!listenerEvents.length) return + + const cleanupIntent = listenForIntent(element, listenerEvents, { + ...context, + delegated: true, + }) + return () => { + cleanupIntent() + clearResolvedGateIdsInMarker(element) + } +} + +/* @__NO_SIDE_EFFECTS__ */ +export function interaction( + options: InteractionHydrationOptions = {}, +): HydrationPrefetchStrategy { + let events: ReadonlyArray = defaultInteractionEvents + if (options.events !== undefined) { + const eventList: ReadonlyArray = + typeof options.events === 'string' ? [options.events] : options.events + const normalizedEvents: Array = [] + const seen = new Set() + + for (const eventName of eventList) { + if (!eventName || seen.has(eventName)) continue + seen.add(eventName) + normalizedEvents.push(eventName) + } + + events = normalizedEvents + } + + const eventKey = events.join(' ') + + return { + _t: interactionType, + _s: (context) => { + const element = context.element + if (!element) return + const prefetch = context.prefetch + if (prefetch) { + if (!events.length) return + let disposed = false + + events.forEach((eventName) => { + element.addEventListener(eventName, prefetch, true) + }) + + return () => { + if (disposed) return + disposed = true + events.forEach((eventName) => { + element.removeEventListener(eventName, prefetch, true) + }) + } + } + + const listenerEvents = getIntentListenerEvents(element, events) + const cleanupIntent = listenerEvents.length + ? listenForIntent(element, listenerEvents, context) + : undefined + return () => { + cleanupIntent?.() + clearResolvedGateIdsInMarker(element) + } + }, + _o: (id) => { + globalThis.requestAnimationFrame(() => { + const pendingEvents = replayEventsByGateId.get(id) + if (!pendingEvents?.length) return + + replayEventsByGateId.delete(id) + + for (const pendingEvent of pendingEvents) { + let replayTarget: Element | null = pendingEvent.marker + for (const index of pendingEvent.targetPath) { + replayTarget = replayTarget.children[index] ?? null + if (!replayTarget) break + } + + const event = pendingEvent.event + replayTarget ??= pendingEvent.marker + replayTarget.dispatchEvent( + event instanceof MouseEvent + ? new MouseEvent(event.type, event) + : event instanceof FocusEvent + ? new FocusEvent(event.type, event) + : new Event(event.type, event), + ) + } + }) + }, + _a: () => + options.events === undefined + ? undefined + : { + [hydrateInteractionEventsAttribute]: eventKey, + }, + } +} diff --git a/packages/start-client-core/src/hydration/load.ts b/packages/start-client-core/src/hydration/load.ts new file mode 100644 index 0000000000..b78d6d6a42 --- /dev/null +++ b/packages/start-client-core/src/hydration/load.ts @@ -0,0 +1,16 @@ +import type { HydrationPrefetchStrategy } from './types' + +const loadType = 'load' + +const loadStrategy: HydrationPrefetchStrategy = { + _t: loadType, + _d: () => false, + _s: ({ gate, prefetch }) => { + ;(prefetch ?? gate!.resolve)() + }, +} + +/* @__NO_SIDE_EFFECTS__ */ +export function load(): HydrationPrefetchStrategy { + return loadStrategy +} diff --git a/packages/start-client-core/src/hydration/media.ts b/packages/start-client-core/src/hydration/media.ts new file mode 100644 index 0000000000..c2335b7e2f --- /dev/null +++ b/packages/start-client-core/src/hydration/media.ts @@ -0,0 +1,25 @@ +import type { HydrationPrefetchStrategy } from './types' + +const mediaType = 'media' + +/* @__NO_SIDE_EFFECTS__ */ +export function media( + query: string, +): HydrationPrefetchStrategy { + return { + _t: mediaType, + _s: ({ gate, prefetch }) => { + if (!query) return + + const callback = prefetch ?? gate!.resolve + const mediaQuery = window.matchMedia(query) + const onChange = () => { + if (mediaQuery.matches) callback() + } + mediaQuery.addEventListener('change', onChange) + onChange() + + return () => mediaQuery.removeEventListener('change', onChange) + }, + } +} diff --git a/packages/start-client-core/src/hydration/never.ts b/packages/start-client-core/src/hydration/never.ts new file mode 100644 index 0000000000..8ace129b5e --- /dev/null +++ b/packages/start-client-core/src/hydration/never.ts @@ -0,0 +1,13 @@ +import type { HydrationStrategy } from './types' + +const neverType = 'never' + +const neverStrategy: HydrationStrategy = { + _t: neverType, + _d: () => true, +} + +/* @__NO_SIDE_EFFECTS__ */ +export function never(): HydrationStrategy { + return neverStrategy +} diff --git a/packages/start-client-core/src/hydration/renderer.ts b/packages/start-client-core/src/hydration/renderer.ts new file mode 100644 index 0000000000..1a14ef9b46 --- /dev/null +++ b/packages/start-client-core/src/hydration/renderer.ts @@ -0,0 +1,21 @@ +import type { HydrationStrategy } from './types' + +export type HydrationStrategyWithRenderer< + TStrategy extends HydrationStrategy, + TRenderer, +> = TStrategy & { + _h: TRenderer +} + +/* @__NO_SIDE_EFFECTS__ */ +export function withHydrationRenderer< + TStrategy extends HydrationStrategy, + TRenderer, +>( + strategy: TStrategy, + renderer: TRenderer, +): HydrationStrategyWithRenderer { + return /* @__PURE__ */ Object.assign(strategy, { + _h: renderer, + }) +} diff --git a/packages/start-client-core/src/hydration/runtime.ts b/packages/start-client-core/src/hydration/runtime.ts new file mode 100644 index 0000000000..b1da55195d --- /dev/null +++ b/packages/start-client-core/src/hydration/runtime.ts @@ -0,0 +1,191 @@ +import { hydrateIdAttribute, hydrateWhenAttribute } from './constants' +import type { + HydrationPrefetchStrategy, + HydrationPrefetchWaitReason, + HydrationRuntimeGate, + HydrationWhen, +} from './types' + +const hydrateIdSelector = `[${hydrateIdAttribute}]` + +export type HydrationGateRecord = HydrationRuntimeGate & { + id: string + when: HydrationWhen + promise: Promise + consumers: number + resolveListeners: Set<() => void> +} + +const gateRegistry = /* @__PURE__ */ new Map() +const resolvedGateIds = /* @__PURE__ */ new Set() +const fallbackHtmlByGateId = /* @__PURE__ */ new Map() + +export function createResolvedGate( + id: string, + when: HydrationWhen, +): HydrationGateRecord { + return { + id, + when, + promise: Promise.resolve(), + resolve: () => {}, + resolved: true, + consumers: 0, + resolveListeners: new Set<() => void>(), + } +} + +export function getOrCreateGate( + id: string, + when: HydrationWhen, +): HydrationGateRecord { + const existing = gateRegistry.get(id) + if (existing?.when === when) { + existing.consumers++ + return existing + } + + let resolvePromise!: () => void + const promise = new Promise((resolve) => { + resolvePromise = resolve + }) + + const gate: HydrationGateRecord = { + id, + promise, + resolved: false, + consumers: 1, + when, + resolveListeners: new Set(), + resolve: () => { + if (gate.resolved) return + gate.resolved = true + resolvePromise() + gate.resolveListeners.forEach((listener) => listener()) + gate.resolveListeners.clear() + }, + } + + gateRegistry.set(id, gate) + if (when !== 'never' && resolvedGateIds.has(id)) { + resolvedGateIds.delete(id) + gate.resolve() + } + return gate +} + +export function releaseGate(gate: HydrationGateRecord) { + resolvedGateIds.delete(gate.id) + gate.consumers-- + if (gate.consumers > 0) return + if (gateRegistry.get(gate.id) === gate) { + gateRegistry.delete(gate.id) + fallbackHtmlByGateId.delete(gate.id) + gate.resolveListeners.clear() + } +} + +export function onGateResolve(gate: HydrationGateRecord, listener: () => void) { + if (gate.resolved) { + listener() + return () => {} + } + + gate.resolveListeners.add(listener) + return () => { + gate.resolveListeners.delete(listener) + } +} + +export function runHydrationStrategyCleanup(cleanup: void | (() => void)) { + if (typeof cleanup === 'function') return cleanup + return undefined +} + +export function waitForHydrationPrefetchStrategy( + strategy: HydrationPrefetchStrategy, + options: { + element: Element | null + signal: AbortSignal + onHydrate: (listener: () => void) => () => void + }, +): Promise { + if (options.signal.aborted) { + return Promise.resolve('abort') + } + + return new Promise((resolve) => { + const state = { disposed: false } + const cleanupStrategyRef: { current: void | (() => void) } = { + current: undefined, + } + let cleanupHydrate = () => {} + + const finish = (reason: HydrationPrefetchWaitReason) => { + if (state.disposed) return + state.disposed = true + options.signal.removeEventListener('abort', onAbort) + cleanupHydrate() + runHydrationStrategyCleanup(cleanupStrategyRef.current)?.() + resolve(reason) + } + + const onAbort = () => finish('abort') + + options.signal.addEventListener('abort', onAbort, { once: true }) + cleanupHydrate = options.onHydrate(() => finish('hydrate')) + const cleanupStrategy = strategy._s?.({ + element: options.element, + prefetch: () => finish('prefetch'), + }) + cleanupStrategyRef.current = cleanupStrategy + if (state.disposed) { + runHydrationStrategyCleanup(cleanupStrategy)?.() + } + }) +} + +export function getMarkerGate(marker: Element) { + const id = marker.getAttribute(hydrateIdAttribute) + return id ? gateRegistry.get(id) : undefined +} + +export function resolveHydrationMarker(marker: Element) { + const id = marker.getAttribute(hydrateIdAttribute) + const when = marker.getAttribute(hydrateWhenAttribute) + if (!id || !when || when === 'never') { + return + } + + const gate = gateRegistry.get(id) + if (gate) { + if (gate.when !== 'never') gate.resolve() + return + } + + resolvedGateIds.add(id) +} + +export function clearResolvedGateIdsInMarker(marker: Element) { + const ownId = marker.getAttribute(hydrateIdAttribute) + if (ownId) { + resolvedGateIds.delete(ownId) + } + + marker.querySelectorAll(hydrateIdSelector).forEach((childMarker) => { + const childId = childMarker.getAttribute(hydrateIdAttribute) + if (childId) { + resolvedGateIds.delete(childId) + } + }) +} + +export function saveFallbackHtml(id: string, element: Element) { + if (!fallbackHtmlByGateId.has(id)) { + fallbackHtmlByGateId.set(id, element.innerHTML) + } +} + +export function getFallbackHtml(id: string) { + return fallbackHtmlByGateId.get(id) +} diff --git a/packages/start-client-core/src/hydration/types.ts b/packages/start-client-core/src/hydration/types.ts new file mode 100644 index 0000000000..f4250067d6 --- /dev/null +++ b/packages/start-client-core/src/hydration/types.ts @@ -0,0 +1,90 @@ +export type HydrationWhen = + | 'load' + | 'idle' + | 'visible' + | 'media' + | 'interaction' + | 'condition' + | 'never' + | 'dynamic' + +export type HydrationInteractionEvent = + | 'auxclick' + | 'click' + | 'contextmenu' + | 'dblclick' + | 'focusin' + | 'keydown' + | 'keyup' + | 'mousedown' + | 'mouseenter' + | 'mouseover' + | 'mouseup' + | 'pointerdown' + | 'pointerenter' + | 'pointerover' + | 'pointerup' + +export type HydrationInteractionEvents = + | HydrationInteractionEvent + | ReadonlyArray + +export type HydrationMarkerAttributes = Record + +export type HydrationRuntimeGate = { + id?: string + when?: HydrationWhen + resolved: boolean + resolve: () => void +} + +export type HydrationRuntimeContext = { + element: Element | null + gate?: HydrationRuntimeGate + prefetch?: () => void + delegated?: boolean +} + +export type HydrationStrategyTypes< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = { + when: TWhen + canPrefetch: TCanPrefetch +} + +export type HydrationStrategy< + TWhen extends HydrationWhen = HydrationWhen, + TCanPrefetch extends boolean = boolean, +> = { + _t?: TWhen + readonly '~types'?: HydrationStrategyTypes + _d?: () => boolean + _s?: (context: HydrationRuntimeContext) => void | (() => void) + _o?: (id: string) => void + _a?: () => HydrationMarkerAttributes | undefined +} + +export type HydrationPrefetchWhen = Exclude< + HydrationWhen, + 'condition' | 'never' | 'dynamic' +> + +export type HydrationPrefetchStrategy< + TWhen extends HydrationPrefetchWhen = HydrationPrefetchWhen, +> = HydrationStrategy + +export type HydrationPrefetchWaitReason = 'prefetch' | 'hydrate' | 'abort' + +export type HydrationPrefetchContext = { + element: Element | null + signal: AbortSignal + preload: () => Promise + waitFor: ( + strategy: HydrationPrefetchStrategy, + ) => Promise +} + +export type HydrationPrefetchFunction = ( + context: HydrationPrefetchContext, +) => void | Promise diff --git a/packages/start-client-core/src/hydration/visible.ts b/packages/start-client-core/src/hydration/visible.ts new file mode 100644 index 0000000000..3c3391b1de --- /dev/null +++ b/packages/start-client-core/src/hydration/visible.ts @@ -0,0 +1,90 @@ +import type { HydrationPrefetchStrategy } from './types' + +const visibleType = 'visible' + +export type VisibleHydrationOptions = { + rootMargin?: string + threshold?: number | Array +} + +type VisibleObserverEntry = { + key: string + observer: IntersectionObserver + elements: Map void>> +} + +const observerRegistry = /* @__PURE__ */ new Map() + +function cleanupVisibleObserverEntry(observerEntry: VisibleObserverEntry) { + if (observerEntry.elements.size > 0) return + observerEntry.observer.disconnect() + observerRegistry.delete(observerEntry.key) +} + +/* @__NO_SIDE_EFFECTS__ */ +export function visible( + options: VisibleHydrationOptions = {}, +): HydrationPrefetchStrategy { + const rootMargin = options.rootMargin ?? '600px' + const threshold = options.threshold ?? 0 + + return { + _t: visibleType, + _s: ({ element, gate, prefetch }) => { + const callback = prefetch ?? gate!.resolve + + if (!element) { + callback() + return + } + + const key = `${rootMargin}|${ + Array.isArray(threshold) ? threshold.join(',') : String(threshold) + }` + let observerEntry = observerRegistry.get(key) + + if (!observerEntry) { + const entry: VisibleObserverEntry = { + key, + elements: new Map void>>(), + observer: new IntersectionObserver( + (entries) => { + for (const intersectingEntry of entries) { + if (!intersectingEntry.isIntersecting) continue + + const callbacks = entry.elements.get(intersectingEntry.target) + if (!callbacks) continue + + callbacks.forEach((callback) => callback()) + entry.elements.delete(intersectingEntry.target) + entry.observer.unobserve(intersectingEntry.target) + cleanupVisibleObserverEntry(entry) + } + }, + { rootMargin, threshold }, + ), + } + observerRegistry.set(key, entry) + observerEntry = entry + } + + let callbacks = observerEntry.elements.get(element) + if (!callbacks) { + callbacks = new Set() + observerEntry.elements.set(element, callbacks) + observerEntry.observer.observe(element) + } + callbacks.add(callback) + + return () => { + const currentCallbacks = observerEntry.elements.get(element) + currentCallbacks?.delete(callback) + if (currentCallbacks?.size === 0) { + observerEntry.elements.delete(element) + observerEntry.observer.unobserve(element) + } + cleanupVisibleObserverEntry(observerEntry) + } + }, + } +} diff --git a/packages/start-client-core/vite.config.ts b/packages/start-client-core/vite.config.ts index e893ba2c8d..c17997fc31 100644 --- a/packages/start-client-core/vite.config.ts +++ b/packages/start-client-core/vite.config.ts @@ -2,33 +2,42 @@ import { defineConfig, mergeConfig } from 'vitest/config' import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' -const config = defineConfig({ - test: { - typecheck: { enabled: true }, - name: packageJson.name, - watch: false, - environment: 'jsdom', - }, -}) - -export default mergeConfig( - config, - tanstackViteConfig({ - tsconfigPath: './tsconfig.build.json', - srcDir: './src', - entry: [ - './src/index.tsx', - './src/client/index.ts', - './src/client-rpc/index.ts', - './src/fake-entries/start.ts', - './src/fake-entries/router.ts', - './src/fake-entries/plugin-adapters.ts', - ], - cjs: false, - externalDeps: [ - '#tanstack-start-entry', - '#tanstack-router-entry', - '#tanstack-start-plugin-adapters', - ], - }), +export default defineConfig(({ command }) => + mergeConfig( + { + define: + command === 'build' + ? { + 'import.meta.hot': 'import.meta.hot', + } + : undefined, + test: { + typecheck: { enabled: true }, + name: packageJson.name, + watch: false, + environment: 'jsdom', + }, + }, + tanstackViteConfig({ + tsconfigPath: './tsconfig.build.json', + srcDir: './src', + entry: [ + './src/index.tsx', + './src/client/index.ts', + './src/client-rpc/index.ts', + './src/hydration/constants.ts', + './src/hydration.ts', + './src/hydration/runtime.ts', + './src/fake-entries/start.ts', + './src/fake-entries/router.ts', + './src/fake-entries/plugin-adapters.ts', + ], + cjs: false, + externalDeps: [ + '#tanstack-start-entry', + '#tanstack-router-entry', + '#tanstack-start-plugin-adapters', + ], + }), + ), ) diff --git a/packages/start-plugin-core/src/hydrate-when-transform.ts b/packages/start-plugin-core/src/hydrate-when-transform.ts new file mode 100644 index 0000000000..d88ddb60d0 --- /dev/null +++ b/packages/start-plugin-core/src/hydrate-when-transform.ts @@ -0,0 +1,1004 @@ +import { relative } from 'node:path' +import crypto from 'node:crypto' +import babel from '@babel/core' +import * as t from '@babel/types' +import { + buildDeclarationMap, + buildDependencyGraph, + collectIdentifiersFromNode, + collectIdentifiersFromPattern, + collectLocalBindingsFromStatement, + deadCodeElimination, + expandTransitively, + findReferencedIdentifiers, + generateFromAst, + parseAst, + removeModuleLevelBindings, + retainModuleLevelDeclarations, + stripUnreferencedTopLevelExpressionStatements, + unwrapExportedDeclarations, +} from '@tanstack/router-utils' +import { tssHydrate } from './hydration-constants' +import { cleanId, codeFrameError } from './start-compiler/utils' +import type { + CompileStartFrameworkOptions, + StartCompilerPlugin, + StartCompilerTransformResult, +} from './types' + +export class MissingHydrateSourceError extends Error { + constructor(id: string) { + super( + `Missing Hydrate source for virtual module ${id}. The parent module must be transformed before its Hydrate child chunk is loaded.`, + ) + } +} + +/** + * Detection pattern used by the transform code filter to pre-scan files for + * `` JSX before any AST parsing happens. + */ +const HYDRATE_DETECTION_PATTERN = /\bHydrate\b/ + +function createBoundaryId(root: string, sourceId: string) { + const normalized = relative(root, sourceId).replaceAll('\\', '/') + const sourceHash = crypto + .createHash('sha1') + .update(normalized) + .digest('hex') + .slice(0, 10) + + return (index: number) => { + return `${index.toString(36)}_${sourceHash}` + } +} + +function getJSXElementName(node: t.JSXElement) { + const name = node.openingElement.name + return t.isJSXIdentifier(name) ? name.name : undefined +} + +function getJSXAttribute(node: t.JSXOpeningElement, name: string) { + for (const item of node.attributes) { + if (t.isJSXAttribute(item) && t.isJSXIdentifier(item.name, { name })) { + return item + } + } + + return undefined +} + +function getBooleanProp(node: t.JSXOpeningElement, name: string) { + const attr = getJSXAttribute(node, name) + if (!attr) return undefined + if (!attr.value) return true + if (t.isStringLiteral(attr.value)) return attr.value.value !== 'false' + if (t.isJSXExpressionContainer(attr.value)) { + if (t.isBooleanLiteral(attr.value.expression)) { + return attr.value.expression.value + } + } + return undefined +} + +function parseHydrateVirtualId(id: string) { + const queryIndex = id.indexOf('?') + const sourceId = cleanId(queryIndex === -1 ? id : id.slice(0, queryIndex)) + if (queryIndex === -1) { + return { sourceId, splitId: null, boundaryIndex: -1 } + } + + const rawQuery = id.slice(queryIndex + 1) + const params = new URLSearchParams(rawQuery) + const splitId = params.get(tssHydrate) + let boundaryIndex = -1 + if (splitId) { + const separatorIndex = splitId.indexOf('_') + if (separatorIndex > 0) { + const parsedIndex = Number.parseInt(splitId.slice(0, separatorIndex), 36) + if (Number.isInteger(parsedIndex)) { + boundaryIndex = parsedIndex + } + } + } + + return { + sourceId, + splitId, + boundaryIndex, + } +} + +function isObjectPropertyName( + property: t.ObjectMethod | t.ObjectProperty, + name: string, +) { + if (t.isIdentifier(property.key) && !property.computed) { + return property.key.name === name + } + + return t.isStringLiteral(property.key) && property.key.value === name +} + +function isReferenceInsideAnyNode( + referencePath: babel.NodePath, + nodes: ReadonlySet, +) { + if (nodes.has(referencePath.node)) return true + return Boolean(referencePath.findParent((parent) => nodes.has(parent.node))) +} + +function stripBindingsOnlyReferencedBy( + path: babel.NodePath, + node: t.Node, + seen = new Set(), + preserve = new Set(), +) { + stripBindingsOnlyReferencedByNodes(path.scope, [node], seen, preserve) +} + +function stripBindingsOnlyReferencedByNodes( + scope: babel.NodePath['scope'], + nodes: ReadonlyArray, + seen = new Set(), + preserve = new Set(), +) { + const nodeSet = new Set(nodes) + const names = new Set() + nodes.forEach((node) => { + collectIdentifiersFromNode(node).forEach((name) => names.add(name)) + }) + + for (const name of names) { + if (seen.has(name)) continue + if (preserve.has(name)) continue + const binding = scope.getBinding(name) + if (!binding?.constant) continue + if ( + binding.path.findParent( + (parentPath) => + parentPath.isExportNamedDeclaration() || + parentPath.isExportDefaultDeclaration(), + ) + ) { + continue + } + if (binding.referencePaths.length === 0) continue + if ( + !binding.referencePaths.every((referencePath) => + isReferenceInsideAnyNode(referencePath, nodeSet), + ) + ) { + continue + } + + seen.add(name) + + const declarationPath = binding.path.isVariableDeclarator() + ? binding.path + : binding.path.findParent((parentPath) => + parentPath.isVariableDeclarator(), + ) + const patternHasExternalReferences = + declarationPath?.isVariableDeclarator() && + !t.isIdentifier(declarationPath.node.id) && + collectIdentifiersFromPattern(declarationPath.node.id).some( + (bindingName) => { + if (bindingName === binding.identifier.name) return false + + const siblingBinding = binding.scope.getBinding(bindingName) + return siblingBinding?.referencePaths.some( + (referencePath) => + !isReferenceInsideAnyNode(referencePath, nodeSet), + ) + }, + ) + + if (patternHasExternalReferences) { + continue + } + + const bindingNode = binding.path.node + if (t.isVariableDeclarator(bindingNode) && bindingNode.init) { + stripBindingsOnlyReferencedByNodes( + binding.scope, + [bindingNode.init], + seen, + preserve, + ) + } else if ( + t.isFunctionDeclaration(bindingNode) || + t.isClassDeclaration(bindingNode) + ) { + stripBindingsOnlyReferencedByNodes( + binding.scope, + [bindingNode], + seen, + preserve, + ) + } + + if (binding.path.isVariableDeclarator()) { + const declarationPath = binding.path.parentPath + if ( + declarationPath.isVariableDeclaration() && + declarationPath.node.declarations.length === 1 + ) { + declarationPath.remove() + continue + } + + binding.path.remove() + continue + } + + if ( + binding.path.isImportSpecifier() || + binding.path.isImportDefaultSpecifier() || + binding.path.isImportNamespaceSpecifier() + ) { + const importPath = binding.path.parentPath + if ( + importPath.isImportDeclaration() && + importPath.node.specifiers.length === 1 + ) { + importPath.remove() + continue + } + + binding.path.remove() + continue + } + + binding.path.remove() + } +} + +function getSingleUseObjectExpressionBinding( + path: babel.NodePath, + identifier: t.Identifier, +) { + const binding = path.scope.getBinding(identifier.name) + if (!binding?.constant) return undefined + if (binding.referencePaths.length !== 1) return undefined + if (binding.referencePaths[0]?.node !== identifier) return undefined + if (!binding.path.isVariableDeclarator()) return undefined + const init = binding.path.node.init + return t.isObjectExpression(init) ? init : undefined +} + +function objectExpressionMayHaveProperty( + node: t.ObjectExpression, + name: string, +) { + return node.properties.some((property) => { + if (t.isSpreadElement(property)) return true + if (!t.isObjectMethod(property) && !t.isObjectProperty(property)) { + return true + } + if (property.computed) return true + return isObjectPropertyName(property, name) + }) +} + +function stripObjectExpressionProperty( + path: babel.NodePath, + node: t.ObjectExpression, + name: string, +) { + let modified = false + + node.properties = node.properties.filter((property) => { + if ( + (t.isObjectMethod(property) || t.isObjectProperty(property)) && + isObjectPropertyName(property, name) + ) { + stripBindingsOnlyReferencedBy( + path, + t.isObjectProperty(property) ? property.value : property.body, + ) + modified = true + return false + } + + return true + }) + + return modified +} + +function throwBoundaryError( + code: string, + path: babel.NodePath, + message: string, +): never { + if (path.node.loc) { + throw codeFrameError(code, path.node.loc, message) + } + throw new Error(message) +} + +function inspectSplitBoundary(options: { + code: string + path: babel.NodePath + validate?: boolean + collectCaptured?: boolean + nestedHydrate?: { + localName: string + } +}) { + const { path } = options + const capturedNames = options.collectCaptured ? new Set() : undefined + const nestedHydrate = options.nestedHydrate + let nestedBoundaryCount = 0 + + if (options.validate) { + for (const child of path.node.children) { + if ( + t.isJSXExpressionContainer(child) && + (t.isFunctionExpression(child.expression) || + t.isArrowFunctionExpression(child.expression)) + ) { + throwBoundaryError( + options.code, + path, + 'Hydrate cannot code-split function-as-children. Use split={false} for this boundary.', + ) + } + } + } + + const rootVisitors = { + JSXOpeningElement(openingPath: babel.NodePath) { + if (openingPath.node === path.node.openingElement) { + openingPath.skip() + } + }, + JSXClosingElement(closingPath: babel.NodePath) { + closingPath.skip() + }, + } + + const validateVisitors = options.validate + ? { + CallExpression(callPath: babel.NodePath) { + if (!t.isIdentifier(callPath.node.callee)) return + if (!/^use[A-Z0-9]/.test(callPath.node.callee.name)) return + + throwBoundaryError( + options.code, + path, + 'Hydrate cannot code-split JSX that calls hooks during render. Move the hook call into a child component or use split={false}.', + ) + }, + ThisExpression(thisPath: babel.NodePath) { + void thisPath + throwBoundaryError( + options.code, + path, + 'Hydrate cannot code-split JSX that captures this.', + ) + }, + Super(superPath: babel.NodePath) { + void superPath + throwBoundaryError( + options.code, + path, + 'Hydrate cannot code-split JSX that captures super.', + ) + }, + } + : {} + + const nestedHydrateVisitors = nestedHydrate + ? { + JSXElement(nestedPath: babel.NodePath) { + if (getJSXElementName(nestedPath.node) !== nestedHydrate.localName) { + return + } + + const split = getBooleanProp(nestedPath.node.openingElement, 'split') + if (split === false) return + + nestedBoundaryCount++ + }, + } + : {} + + const captureVisitors = capturedNames + ? { + Identifier(identifierPath: babel.NodePath) { + const parent = identifierPath.parent + if ( + t.isJSXOpeningElement(parent) || + t.isJSXClosingElement(parent) || + (t.isObjectProperty(parent, { key: identifierPath.node }) && + !parent.computed && + !parent.shorthand) || + (t.isMemberExpression(parent, { + property: identifierPath.node, + }) && + !parent.computed) + ) { + return + } + + const binding = identifierPath.scope.getBinding( + identifierPath.node.name, + ) + if (!binding) return + if (t.isProgram(binding.scope.block)) return + if ( + path.node === binding.scope.block || + path.isAncestor(binding.path) + ) + return + + capturedNames.add(identifierPath.node.name) + }, + JSXIdentifier(identifierPath: babel.NodePath) { + if (identifierPath.parentKey !== 'name') return + const name = identifierPath.node.name + if (!/^[A-Z]/.test(name)) return + const binding = identifierPath.scope.getBinding(name) + if (!binding) return + if (t.isProgram(binding.scope.block)) return + + capturedNames.add(name) + }, + } + : {} + + path.traverse({ + ...rootVisitors, + ...validateVisitors, + ...nestedHydrateVisitors, + ...captureVisitors, + }) + + return { + captured: capturedNames ? [...capturedNames].sort() : [], + nestedBoundaryCount, + } +} + +function getHydrateImport( + ast: t.File, + framework: CompileStartFrameworkOptions, +) { + const hydrateImportSource = `@tanstack/${framework}-start` + + for (const node of ast.program.body) { + if (!t.isImportDeclaration(node)) continue + if (node.source.value !== hydrateImportSource) continue + + for (const specifier of node.specifiers) { + if ( + t.isImportSpecifier(specifier) && + t.isIdentifier(specifier.imported, { name: 'Hydrate' }) + ) { + return { + hydrateLocalName: specifier.local.name, + } + } + } + } + + return undefined +} + +function getMeaningfulChildren( + children: Array, +) { + return children.filter( + (child) => !(t.isJSXText(child) && child.value.trim() === ''), + ) +} + +function transformHydrateAst(options: { + ast: t.File + code: string + id: string + root: string + env: 'client' | 'server' + framework: CompileStartFrameworkOptions + indexOffset?: number +}) { + if (!options.code.includes('Hydrate')) return null + + const hydrateImport = getHydrateImport(options.ast, options.framework) + if (!hydrateImport) return null + const { hydrateLocalName: localName } = hydrateImport + const sourceId = cleanId(options.id) + const getBoundaryId = createBoundaryId(options.root, sourceId) + + let nextBoundaryIndex = options.indexOffset ?? 0 + const state = { + modified: false, + extractedChildNodes: [] as Array, + capturedNames: new Set(), + } + let lazyIdent: t.Identifier | undefined + + babel.traverse(options.ast, { + Program(programPath) { + programPath.traverse({ + JSXElement(path) { + if (getJSXElementName(path.node) !== localName) return + + if (options.env === 'server') { + path.node.openingElement.attributes = + path.node.openingElement.attributes.filter((item) => { + if ( + t.isJSXAttribute(item) && + t.isJSXIdentifier(item.name, { name: 'fallback' }) + ) { + if (item.value) { + stripBindingsOnlyReferencedBy(path, item.value) + } + state.modified = true + return false + } + + if ( + t.isJSXSpreadAttribute(item) && + t.isObjectExpression(item.argument) + ) { + if ( + stripObjectExpressionProperty( + path, + item.argument, + 'fallback', + ) + ) { + state.modified = true + } + return item.argument.properties.length > 0 + } + + if ( + t.isJSXSpreadAttribute(item) && + t.isIdentifier(item.argument) + ) { + const init = getSingleUseObjectExpressionBinding( + path, + item.argument, + ) + if ( + init && + stripObjectExpressionProperty(path, init, 'fallback') + ) { + state.modified = true + } + } + + return true + }) + } + + const split = getBooleanProp(path.node.openingElement, 'split') + if (split === false) return + + const boundaryInspection = inspectSplitBoundary({ + code: options.code, + path, + validate: true, + collectCaptured: options.env === 'client', + ...(options.env === 'client' + ? { + nestedHydrate: { + localName, + }, + } + : {}), + }) + + const index = nextBoundaryIndex + nextBoundaryIndex += 1 + boundaryInspection.nestedBoundaryCount + const id = getBoundaryId(index) + const exportName = `H${index}` + + const existingHydrateId = getJSXAttribute( + path.node.openingElement, + 'h', + ) + if (existingHydrateId) { + existingHydrateId.value = t.stringLiteral(id) + } else { + path.node.openingElement.attributes.push( + t.jsxAttribute(t.jsxIdentifier('h'), t.stringLiteral(id)), + ) + } + state.modified = true + + if (options.env === 'server') return + + const needsPreloadProp = path.node.openingElement.attributes.some( + (attribute) => { + if (t.isJSXAttribute(attribute)) { + return t.isJSXIdentifier(attribute.name, { name: 'prefetch' }) + } + + if (t.isJSXSpreadAttribute(attribute)) { + if (t.isObjectExpression(attribute.argument)) { + return objectExpressionMayHaveProperty( + attribute.argument, + 'prefetch', + ) + } + + if (t.isIdentifier(attribute.argument)) { + const init = getSingleUseObjectExpressionBinding( + path, + attribute.argument, + ) + return init + ? objectExpressionMayHaveProperty(init, 'prefetch') + : true + } + + return true + } + + return false + }, + ) + const childReferenceNodes = getMeaningfulChildren(path.node.children) + + state.extractedChildNodes.push(...childReferenceNodes) + boundaryInspection.captured.forEach((name) => { + state.capturedNames.add(name) + }) + + if (!lazyIdent) { + lazyIdent = + programPath.scope.generateUidIdentifier('lazyRouteComponent') + programPath.unshiftContainer('body', [ + t.importDeclaration( + [ + t.importSpecifier( + lazyIdent, + t.identifier('lazyRouteComponent'), + ), + ], + t.stringLiteral(`@tanstack/${options.framework}-router`), + ), + ]) + } + + const importIdParams = new URLSearchParams() + importIdParams.set(tssHydrate, id) + const componentIdent = + programPath.scope.generateUidIdentifier(exportName) + const declarations = [ + t.variableDeclarator( + componentIdent, + t.callExpression(lazyIdent, [ + t.arrowFunctionExpression( + [], + t.callExpression(t.import(), [ + t.stringLiteral(`${sourceId}?${importIdParams.toString()}`), + ]), + ), + t.stringLiteral(exportName), + ]), + ), + ] + + let preloadIdent: t.Identifier | undefined + if (needsPreloadProp) { + preloadIdent = programPath.scope.generateUidIdentifier( + `${exportName}_preload`, + ) + declarations.push( + t.variableDeclarator( + preloadIdent, + t.memberExpression(componentIdent, t.identifier('preload')), + ), + ) + } + + programPath.unshiftContainer('body', [ + t.variableDeclaration('const', declarations), + ]) + if (preloadIdent) { + path.node.openingElement.attributes.push( + t.jsxAttribute( + t.jsxIdentifier('p'), + t.jsxExpressionContainer(preloadIdent), + ), + ) + } + + path.node.children = [ + t.jsxText('\n'), + t.jsxExpressionContainer( + t.jsxElement( + t.jsxOpeningElement( + t.jsxIdentifier(componentIdent.name), + boundaryInspection.captured.map((name) => + t.jsxAttribute( + t.jsxIdentifier(name), + t.jsxExpressionContainer(t.identifier(name)), + ), + ), + true, + ), + null, + [], + true, + ), + ), + t.jsxText('\n'), + ] + path.skip() + }, + }) + + if (state.extractedChildNodes.length > 0) { + stripBindingsOnlyReferencedByNodes( + programPath.scope, + state.extractedChildNodes, + new Set(), + state.capturedNames, + ) + } + + programPath.skip() + }, + }) + + if (!state.modified) return null + + return true +} + +function loadHydrateVirtualModule(options: { + id: string + root: string + code: string + framework: CompileStartFrameworkOptions +}) { + const { sourceId, splitId, boundaryIndex } = parseHydrateVirtualId(options.id) + if (!splitId || boundaryIndex < 0) return null + const getBoundaryId = createBoundaryId(options.root, sourceId) + + const ast = parseAst({ code: options.code, sourceFilename: sourceId }) + const hydrateImport = getHydrateImport(ast, options.framework) + if (!hydrateImport) return null + const { hydrateLocalName: localName } = hydrateImport + + let target: t.JSXElement | undefined + let targetIndex = -1 + let targetCaptured: Array = [] + let index = 0 + + babel.traverse(ast, { + JSXElement(path) { + if (getJSXElementName(path.node) !== localName) return + const split = getBooleanProp(path.node.openingElement, 'split') + if (split === false) return + + if (index === boundaryIndex) { + const id = getBoundaryId(index) + if (id !== splitId) { + path.stop() + return + } + targetCaptured = inspectSplitBoundary({ + code: options.code, + path, + collectCaptured: true, + }).captured + target = t.cloneNode(path.node, true) + targetIndex = index + path.stop() + return + } + index++ + }, + }) + + if (!target || targetIndex < 0) return null + + const children = target.children + const exportName = `H${targetIndex}` + const refIdents = findReferencedIdentifiers(ast) + + removeModuleLevelBindings(ast, new Set(['Route'])) + const localBindings = new Set() + for (const node of ast.program.body) { + collectLocalBindingsFromStatement(node, localBindings) + } + + const keepBindings = new Set() + const meaningfulChildren = getMeaningfulChildren(children) + let returnExpression: t.Expression | t.JSXElement | t.JSXFragment = + t.nullLiteral() + + if (meaningfulChildren.length === 1) { + const child = meaningfulChildren[0]! + if (t.isJSXExpressionContainer(child)) { + returnExpression = t.isJSXEmptyExpression(child.expression) + ? t.nullLiteral() + : child.expression + } else if (t.isJSXElement(child) || t.isJSXFragment(child)) { + returnExpression = child + } else if (t.isJSXText(child)) { + returnExpression = t.stringLiteral(child.value) + } + } else if (meaningfulChildren.length > 1) { + returnExpression = t.jsxFragment( + t.jsxOpeningFragment(), + t.jsxClosingFragment(), + children, + ) + } + for (const name of collectIdentifiersFromNode(returnExpression)) { + if (localBindings.has(name)) { + keepBindings.add(name) + } + } + + if (keepBindings.size > 0) { + expandTransitively( + keepBindings, + buildDependencyGraph(buildDeclarationMap(ast), localBindings), + ) + } + + retainModuleLevelDeclarations(ast, keepBindings) + unwrapExportedDeclarations(ast) + + ast.program.body.push( + t.exportNamedDeclaration( + t.functionDeclaration( + t.identifier(exportName), + targetCaptured.length > 0 + ? [ + t.objectPattern( + targetCaptured.map((name) => + t.objectProperty( + t.identifier(name), + t.identifier(name), + false, + true, + ), + ), + ), + ] + : [], + t.blockStatement([t.returnStatement(returnExpression)]), + ), + ), + ) + + deadCodeElimination(ast, refIdents) + stripUnreferencedTopLevelExpressionStatements(ast) + + const result = generateFromAst(ast, { + sourceMaps: true, + sourceFileName: options.id, + filename: options.id, + }) + return result +} + +export function createHydrateCompilerPlugin(): StartCompilerPlugin { + type SourceEntry = { + code: string + framework: CompileStartFrameworkOptions + virtualModules: Map + } + + const sourcesByEnvironment = new Map>() + + const getEnvironmentSources = (envName: string) => { + let sources = sourcesByEnvironment.get(envName) + if (!sources) { + sources = new Map() + sourcesByEnvironment.set(envName, sources) + } + return sources + } + + const setSource = ( + envName: string, + id: string, + code: string, + framework: CompileStartFrameworkOptions, + ) => { + const sourceId = cleanId(id) + const sources = getEnvironmentSources(envName) + const existing = sources.get(sourceId) + if (existing?.code === code && existing.framework === framework) { + return existing + } + + const entry = { + code, + framework, + virtualModules: new Map(), + } + sources.set(sourceId, entry) + return entry + } + + const getSourceEntry = (envName: string, id: string) => + sourcesByEnvironment.get(envName)?.get(cleanId(id)) + + const deleteSource = (envName: string, id: string) => { + sourcesByEnvironment.get(envName)?.delete(cleanId(id)) + } + + return { + name: 'tanstack-start-core:hydrate', + detect: HYDRATE_DETECTION_PATTERN, + virtualModuleIdPattern: new RegExp(`[?&]${tssHydrate}=`), + transformAst(context) { + const virtualModule = parseHydrateVirtualId(context.id) + const indexOffset = + virtualModule.boundaryIndex < 0 + ? undefined + : virtualModule.boundaryIndex + 1 + const result = transformHydrateAst({ + ast: context.ast, + code: context.code, + id: context.id, + root: context.root, + env: context.env, + framework: context.framework, + indexOffset, + }) + + if (result && virtualModule.boundaryIndex < 0) { + setSource(context.envName, context.id, context.code, context.framework) + } + + return !!result + }, + loadVirtualModule(context) { + const virtualModule = parseHydrateVirtualId(context.id) + if (!virtualModule.splitId || virtualModule.boundaryIndex < 0) { + return null + } + + const existingSourceEntry = getSourceEntry( + context.envName, + virtualModule.sourceId, + ) + const sourceEntry = + context.code === undefined + ? existingSourceEntry + : setSource( + context.envName, + virtualModule.sourceId, + context.code, + existingSourceEntry?.framework ?? + (context.code.includes('@tanstack/solid-start') + ? 'solid' + : 'react'), + ) + + if (!sourceEntry) { + throw new MissingHydrateSourceError(context.id) + } + + if (sourceEntry.virtualModules.has(context.id)) { + return sourceEntry.virtualModules.get(context.id)! + } + + const result = loadHydrateVirtualModule({ + code: sourceEntry.code, + id: context.id, + root: context.root, + framework: sourceEntry.framework, + }) + sourceEntry.virtualModules.set(context.id, result) + return result + }, + invalidateModule(context) { + deleteSource(context.envName, context.id) + }, + } +} diff --git a/packages/start-plugin-core/src/hydration-constants.ts b/packages/start-plugin-core/src/hydration-constants.ts new file mode 100644 index 0000000000..b79c20ffd3 --- /dev/null +++ b/packages/start-plugin-core/src/hydration-constants.ts @@ -0,0 +1 @@ +export const tssHydrate = 'tss-hydrate' diff --git a/packages/start-plugin-core/src/rsbuild/normalized-client-build.ts b/packages/start-plugin-core/src/rsbuild/normalized-client-build.ts index b349b68040..60244fdca9 100644 --- a/packages/start-plugin-core/src/rsbuild/normalized-client-build.ts +++ b/packages/start-plugin-core/src/rsbuild/normalized-client-build.ts @@ -1,4 +1,5 @@ import { tsrSplit } from '@tanstack/router-plugin' +import { tssHydrate } from '../hydration-constants' import { getCssAssetSource } from '../start-manifest-plugin/inlineCss' import { RSBUILD_ENVIRONMENT_NAMES } from './planning' import type { RsbuildPluginAPI, Rspack } from '@rsbuild/core' @@ -57,6 +58,39 @@ function getRouteFilePathsFromModules( return routeFilePaths ?? [] } +function getHydrationIdsFromModules( + modules: Array, +): Array { + let hydrationIds: Array | undefined + let seen: Set | undefined + + for (const mod of modules) { + const identifier = mod.identifier() + const lastBangIndex = identifier.lastIndexOf('!') + const resourcePart = + lastBangIndex >= 0 ? identifier.slice(lastBangIndex + 1) : identifier + + const queryIndex = resourcePart.indexOf('?') + if (queryIndex < 0) continue + + const query = resourcePart.slice(queryIndex + 1) + if (!query.includes(tssHydrate)) continue + + const hydrationId = new URLSearchParams(query).get(tssHydrate) + if (!hydrationId || seen?.has(hydrationId)) continue + + if (!hydrationIds || !seen) { + hydrationIds = [] + seen = new Set() + } + + hydrationIds.push(hydrationId) + seen.add(hydrationId) + } + + return hydrationIds ?? [] +} + /** * Returns true for Rspack/webpack HMR runtime chunks that should never be * surfaced to the Start manifest. These files are emitted on every rebuild @@ -186,6 +220,7 @@ export function normalizeRspackClientBuild( for (const chunk of compilation.chunks) { const modules = compilation.chunkGraph.getChunkModules(chunk) const routeFilePaths = getRouteFilePathsFromModules(modules) + const hydrationIds = getHydrationIdsFromModules(modules) const cssFiles: Array = [] const seenCssFiles = new Set() @@ -242,6 +277,7 @@ export function normalizeRspackClientBuild( dynamicImports, css: [], routeFilePaths, + hydrationIds, } chunksByFileName.set(file, normalizedChunk) diff --git a/packages/start-plugin-core/src/rsbuild/start-compiler-host.ts b/packages/start-plugin-core/src/rsbuild/start-compiler-host.ts index 066d5b2867..d0ef77e34b 100644 --- a/packages/start-plugin-core/src/rsbuild/start-compiler-host.ts +++ b/packages/start-plugin-core/src/rsbuild/start-compiler-host.ts @@ -5,15 +5,19 @@ import { detectKindsInCode } from '../start-compiler/compiler' import { getTransformCodeFilterForEnv } from '../start-compiler/config' import { createStartCompiler, + loadCompilerVirtualModule, matchesCodeFilters, mergeServerFnsById, } from '../start-compiler/host' import { cleanId } from '../start-compiler/utils' +import { createHydrateCompilerPlugin } from '../hydrate-when-transform' import { RSBUILD_ENVIRONMENT_NAMES } from './planning' import type { RsbuildPluginAPI, Rspack } from '@rsbuild/core' import type { CompileStartFrameworkOptions, StartCompilerImportTransform, + StartCompilerPlugin, + StartCompilerTransformResult, } from '../types' import type { DevServerFnModuleSpecifierEncoder, @@ -27,7 +31,7 @@ type RsbuildTransformContext = Parameters< type RsbuildInputFileSystem = NonNullable /** - * Rsbuild dev server fn ref strategy: uses file:// URLs for absolute paths. + * Rsbuild dev server fn ref when: uses file:// URLs for absolute paths. * These are directly importable by Node's ESM VM runner without any bundler * path conventions (unlike Vite's /@id/ prefix). */ @@ -40,6 +44,7 @@ export interface StartCompilerHostOptions { providerEnvName: string generateFunctionId?: GenerateFunctionIdFnOptional compilerTransforms?: Array | undefined + compilerPlugins?: Array | undefined serverFnProviderModuleDirectives?: ReadonlyArray | undefined serverFnsById?: Record onServerFnsByIdChange?: () => void @@ -69,6 +74,10 @@ export function registerStartCompilerTransforms( mergeServerFnsById(serverFnsById, d) opts.onServerFnsByIdChange?.() } + const compilerPlugins = [ + createHydrateCompilerPlugin(), + ...(opts.compilerPlugins ?? []), + ] const isDev = api.context.action === 'dev' const mode = isDev ? 'dev' : 'build' @@ -83,9 +92,12 @@ export function registerStartCompilerTransforms( // Pre-compute code filter patterns per environment type const codeFilters: Record<'client' | 'server', Array> = { - client: getTransformCodeFilterForEnv('client'), + client: getTransformCodeFilterForEnv('client', { + compilerPlugins, + }), server: getTransformCodeFilterForEnv('server', { compilerTransforms: opts.compilerTransforms, + compilerPlugins, }), } @@ -109,17 +121,36 @@ export function registerStartCompilerTransforms( async (ctx: RsbuildTransformContext) => { return transformContextStorage.run(ctx, async () => { const code = ctx.code + let nextCode = code + let previousResult: { + code: string + map: StartCompilerTransformResult['map'] + } | null = null const id = ctx.resourcePath + (ctx.resourceQuery || '') + const root = getRoot() + + const virtualResult = loadCompilerVirtualModule(compilerPlugins, { + code, + id, + root, + env: env.type, + envName: env.name, + }) + if (virtualResult) { + nextCode = virtualResult.code + previousResult = { + code: virtualResult.code, + map: virtualResult.map ?? null, + } + } // Quick string-level check: does this file contain any patterns for this env? - if (!matchesCodeFilters(code, envCodeFilters)) { - return code + if (!matchesCodeFilters(nextCode, envCodeFilters)) { + return previousResult ?? nextCode } let compiler = compilers.get(env.name) if (!compiler) { - const root = getRoot() - compiler = createStartCompiler({ env: env.type, envName: env.name, @@ -129,6 +160,7 @@ export function registerStartCompilerTransforms( providerEnvName: opts.providerEnvName, generateFunctionId: opts.generateFunctionId, compilerTransforms, + compilerPlugins, serverFnProviderModuleDirectives, onServerFnsById, getKnownServerFns: () => serverFnsById, @@ -197,19 +229,23 @@ export function registerStartCompilerTransforms( compilers.set(env.name, compiler) } - const detectedKinds = detectKindsInCode(code, env.type, { + const detectedKinds = detectKindsInCode(nextCode, env.type, { compilerTransforms, }) - const result = await compiler.compile({ id, code, detectedKinds }) + const result = await compiler.compile({ + id, + code: nextCode, + detectedKinds, + }) - if (!result) { - return code + if (result) { + return { + code: result.code, + map: result.map ?? null, + } } - return { - code: result.code, - map: result.map ?? null, - } + return previousResult ?? nextCode }) }, ) diff --git a/packages/start-plugin-core/src/start-compiler/compiler.ts b/packages/start-plugin-core/src/start-compiler/compiler.ts index e742a75d41..458c467e4d 100644 --- a/packages/start-plugin-core/src/start-compiler/compiler.ts +++ b/packages/start-plugin-core/src/start-compiler/compiler.ts @@ -1,8 +1,8 @@ -/* eslint-disable import/no-commonjs */ import crypto from 'node:crypto' import * as t from '@babel/types' import { deadCodeElimination, + extractModuleInfoFromAst, findReferencedIdentifiers, generateFromAst, parseAst, @@ -21,28 +21,26 @@ import type { RewriteCandidate, ServerFn, } from './types' +import type { ModuleInfoBinding } from '@tanstack/router-utils' import type { CompileStartFrameworkOptions, StartCompilerEnvironment, StartCompilerImportTransform, + StartCompilerPlugin, + StartCompilerTransformResult, } from '../types' -type Binding = - | { - type: 'import' - source: string - importedName: string - resolvedKind?: Kind - } - | { - type: 'var' - init: t.Expression | null - resolvedKind?: Kind - } +type Binding = ModuleInfoBinding & { + resolvedKind?: Kind +} type ImportBinding = Extract type Kind = 'None' | `Root` | `Builder` | LookupKind +type ParsedAst = ReturnType +type StartCompilerAstPlugin = StartCompilerPlugin & { + transformAst: NonNullable +} export type BuiltInLookupKind = | 'ServerFn' @@ -86,11 +84,28 @@ export function isCompilerTransformEnabledForEnv( transform: StartCompilerImportTransform, env: StartCompilerEnvironment, ): boolean { - if (!transform.environment) return true - if (Array.isArray(transform.environment)) { - return transform.environment.includes(env) + return isStartCompilerEnvironmentEnabled(transform.environment, env) +} + +export function isStartCompilerPluginEnabledForEnv( + plugin: StartCompilerPlugin, + env: StartCompilerEnvironment, +): boolean { + return isStartCompilerEnvironmentEnabled(plugin.environment, env) +} + +function isStartCompilerEnvironmentEnabled( + environment: + | StartCompilerEnvironment + | Array + | undefined, + env: StartCompilerEnvironment, +): boolean { + if (!environment) return true + if (Array.isArray(environment)) { + return environment.includes(env) } - return transform.environment === env + return environment === env } const BuiltInLookupSetup: Record< @@ -219,13 +234,16 @@ export function detectKindsInCode( const validForEnv = getLookupKindsForEnv(env, opts) for (const kind of AllBuiltInLookupKinds) { - if (validForEnv.has(kind) && KindDetectionPatterns[kind].test(code)) { + const pattern = KindDetectionPatterns[kind] + pattern.lastIndex = 0 + if (validForEnv.has(kind) && pattern.test(code)) { detected.add(kind) } } for (const transform of opts?.compilerTransforms ?? []) { if (!isCompilerTransformEnabledForEnv(transform, env)) continue + transform.detect.lastIndex = 0 if (transform.detect.test(code)) { detected.add(getExternalLookupKind(transform)) } @@ -464,6 +482,7 @@ export class StartCompiler { StartCompilerImportTransform >() private externalLookupSetup = new Map() + private compilerPlugins: Array private externalDirectCallKindsBySource = new Map< string, Map @@ -517,6 +536,7 @@ export class StartCompiler { */ onServerFnsById?: (d: Record) => void compilerTransforms?: Array | undefined + compilerPlugins?: Array | undefined serverFnProviderModuleDirectives?: ReadonlyArray | undefined /** * Returns the currently known server functions from previous builds. @@ -527,6 +547,10 @@ export class StartCompiler { }, ) { this.validLookupKinds = options.lookupKinds + this.compilerPlugins = (options.compilerPlugins ?? []).filter((plugin) => + isStartCompilerPluginEnabledForEnv(plugin, options.env), + ) + for (const transform of options.compilerTransforms ?? []) { const kind = getExternalLookupKind(transform) if (!this.validLookupKinds.has(kind)) continue @@ -775,100 +799,13 @@ export class StartCompiler { ast: ReturnType, id: string, ): ModuleInfo { - const bindings = new Map() - const exports = new Map() - const reExportAllSources: Array = [] - - // we are only interested in top-level bindings, hence we don't traverse the AST - // instead we only iterate over the program body - for (const node of ast.program.body) { - if (t.isImportDeclaration(node)) { - const source = node.source.value - for (const s of node.specifiers) { - if (t.isImportSpecifier(s)) { - const importedName = t.isIdentifier(s.imported) - ? s.imported.name - : s.imported.value - bindings.set(s.local.name, { type: 'import', source, importedName }) - } else if (t.isImportDefaultSpecifier(s)) { - bindings.set(s.local.name, { - type: 'import', - source, - importedName: 'default', - }) - } else if (t.isImportNamespaceSpecifier(s)) { - bindings.set(s.local.name, { - type: 'import', - source, - importedName: '*', - }) - } - } - } else if (t.isVariableDeclaration(node)) { - for (const decl of node.declarations) { - if (t.isIdentifier(decl.id)) { - bindings.set(decl.id.name, { - type: 'var', - init: decl.init ?? null, - }) - } - } - } else if (t.isExportNamedDeclaration(node)) { - // export const foo = ... - if (node.declaration) { - if (t.isVariableDeclaration(node.declaration)) { - for (const d of node.declaration.declarations) { - if (t.isIdentifier(d.id)) { - exports.set(d.id.name, d.id.name) - bindings.set(d.id.name, { type: 'var', init: d.init ?? null }) - } - } - } - } - for (const sp of node.specifiers) { - if (t.isExportNamespaceSpecifier(sp)) { - exports.set(sp.exported.name, sp.exported.name) - } - // export { local as exported } - else if (t.isExportSpecifier(sp)) { - const local = sp.local.name - const exported = t.isIdentifier(sp.exported) - ? sp.exported.name - : sp.exported.value - exports.set(exported, local) - - // When re-exporting from another module (export { foo } from './module'), - // create an import binding so the server function can be resolved - if (node.source) { - bindings.set(local, { - type: 'import', - source: node.source.value, - importedName: local, - }) - } - } - } - } else if (t.isExportDefaultDeclaration(node)) { - const d = node.declaration - if (t.isIdentifier(d)) { - exports.set('default', d.name) - } else { - const synth = '__default_export__' - bindings.set(synth, { type: 'var', init: d as t.Expression }) - exports.set('default', synth) - } - } else if (t.isExportAllDeclaration(node)) { - // Handle `export * from './module'` syntax - // Track the source so we can look up exports from it when needed - reExportAllSources.push(node.source.value) - } - } + const extracted = extractModuleInfoFromAst(ast) const info: ModuleInfo = { id, - bindings, - exports, - reExportAllSources, + bindings: new Map(extracted.bindings), + exports: extracted.exports, + reExportAllSources: extracted.reExportAllSources, } this.moduleCache.set(id, info) return info @@ -889,13 +826,30 @@ export class StartCompiler { } public invalidateModule(id: string) { - const normalizedId = cleanId(id) - let hasCachedModule = false + return this.invalidateModules([id]).size > 0 + } + + public invalidateModules(ids: Iterable): Set { + const normalizedIds = new Set() + + for (const id of ids) { + normalizedIds.add(cleanId(id)) + + for (const plugin of this.compilerPlugins) { + plugin.invalidateModule?.({ id, envName: this.options.envName }) + } + } + + const deletedModuleIds = new Set() + if (normalizedIds.size === 0) { + return deletedModuleIds + } for (const moduleId of Array.from(this.moduleCache.keys())) { - if (cleanId(moduleId) === normalizedId) { + const normalizedModuleId = cleanId(moduleId) + if (normalizedIds.has(normalizedModuleId)) { this.moduleCache.delete(moduleId) - hasCachedModule = true + deletedModuleIds.add(normalizedModuleId) } } @@ -915,14 +869,20 @@ export class StartCompiler { this.resolveIdCache.clear() this.exportResolutionCache.clear() - return hasCachedModule + return deletedModuleIds } - public async getTransitiveImporters(id: string): Promise> { + public async getTransitiveImporters( + ids: string | Iterable, + ): Promise> { const discoveredImporters = new Set() - const pendingTargets = [cleanId(id)] + const pendingTargets = + typeof ids === 'string' + ? [cleanId(ids)] + : Array.from(ids, (id) => cleanId(id)) const visitedTargets = new Set() const resolveCache = new Map>() + const importersByTarget = new Map>() const resolveSource = (source: string, importer: string) => { const cacheKey = `${importer}::${source}` @@ -936,6 +896,40 @@ export class StartCompiler { return resolved } + await Promise.all( + Array.from(this.moduleCache.values()).map(async (moduleInfo) => { + if (this.knownRootImports.has(moduleInfo.id)) { + return + } + + const moduleId = cleanId(moduleInfo.id) + const importSources = new Set(moduleInfo.reExportAllSources) + + for (const binding of moduleInfo.bindings.values()) { + if (binding.type === 'import') { + importSources.add(binding.source) + } + } + + await Promise.all( + Array.from(importSources, async (source) => { + const resolved = await resolveSource(source, moduleInfo.id) + if (!resolved) return + + const targetId = cleanId(resolved) + if (targetId === moduleId) return + + let importers = importersByTarget.get(targetId) + if (!importers) { + importers = new Set() + importersByTarget.set(targetId, importers) + } + importers.add(moduleId) + }), + ) + }), + ) + while (pendingTargets.length > 0) { const targetId = pendingTargets.pop()! @@ -945,40 +939,8 @@ export class StartCompiler { visitedTargets.add(targetId) - const importerIds = await Promise.all( - Array.from(this.moduleCache.values()).map(async (moduleInfo) => { - if (this.knownRootImports.has(moduleInfo.id)) { - return null - } - - const moduleId = cleanId(moduleInfo.id) - - if (moduleId === targetId) { - return null - } - - const importSources = new Set(moduleInfo.reExportAllSources) - - for (const binding of moduleInfo.bindings.values()) { - if (binding.type === 'import') { - importSources.add(binding.source) - } - } - - for (const source of importSources) { - const resolved = await resolveSource(source, moduleInfo.id) - - if (resolved && cleanId(resolved) === targetId) { - return moduleId - } - } - - return null - }), - ) - - for (const importerId of importerIds) { - if (!importerId || discoveredImporters.has(importerId)) { + for (const importerId of importersByTarget.get(targetId) ?? []) { + if (discoveredImporters.has(importerId)) { continue } @@ -1011,408 +973,435 @@ export class StartCompiler { ? new Set([...detectedKinds].filter((k) => this.validLookupKinds.has(k))) : this.validLookupKinds - // Early exit if no kinds to process - if (fileKinds.size === 0) { - return null - } - - const hasExternalKinds = hasExternalLookupKinds(fileKinds) - const checkDirectCalls = - hasBuiltInDirectCallKinds(fileKinds) || - (fileKinds.has('ServerFn') && - !hasExternalKinds && - hasBuiltInDirectCallKinds(this.validLookupKinds)) - // Optimization: ServerFn is always a top-level declaration (must be assigned to a variable). - // If the file only has ServerFn, we can skip full AST traversal and only visit - // the specific top-level declarations that have candidates. - const canUseFastPath = areAllKindsTopLevelOnly(fileKinds) - + const astTransformPlugins = this.getAstTransformPluginsForCode(code) // Always parse and extract module info upfront. // This ensures the module is cached for import resolution even if no candidates are found. - const { ast } = this.ingestModule({ code, id, parserFilename }) + const ast = this.ingestModule({ code, id, parserFilename }).ast + let astHasChanges = false - // Single-pass traversal to: - // 1. Collect candidate paths (only candidates, not all CallExpressions) - // 2. Build a map for looking up paths of nested calls in method chains - const candidatePaths: Array = [] - // Map for nested chain lookup - only populated for CallExpressions that are - // part of a method chain (callee.object is a CallExpression) - const chainCallPaths = new Map< - t.CallExpression, - babel.NodePath - >() + builtInTransforms: { + // Early exit if no built-in or import transforms need this file. + if (fileKinds.size === 0) { + break builtInTransforms + } - // JSX candidates (e.g., ) - const jsxCandidatePaths: Array> = [] - const checkJSX = needsJSXDetection(fileKinds, this.externalLookupSetup) - // Get module info that was just cached by ingestModule - const moduleInfo = this.moduleCache.get(id)! - const externalDirectCallCandidates = this.getExternalDirectCallCandidates( - fileKinds, - moduleInfo, - ) - const checkExternalDirectCalls = hasExternalDirectCallCandidates( - externalDirectCallCandidates, - ) + const hasExternalKinds = hasExternalLookupKinds(fileKinds) + const checkDirectCalls = + hasBuiltInDirectCallKinds(fileKinds) || + (fileKinds.has('ServerFn') && + !hasExternalKinds && + hasBuiltInDirectCallKinds(this.validLookupKinds)) + // Optimization: ServerFn is always a top-level declaration (must be assigned to a variable). + // If the file only has ServerFn, we can skip full AST traversal and only visit + // the specific top-level declarations that have candidates. + const canUseFastPath = areAllKindsTopLevelOnly(fileKinds) - if (canUseFastPath) { - // Fast path: only visit top-level statements that have potential candidates + // Single-pass traversal to: + // 1. Collect candidate paths (only candidates, not all CallExpressions) + // 2. Build a map for looking up paths of nested calls in method chains + const candidatePaths: Array = [] + // Map for nested chain lookup - only populated for CallExpressions that are + // part of a method chain (callee.object is a CallExpression) + const chainCallPaths = new Map< + t.CallExpression, + babel.NodePath + >() - // Collect indices of top-level statements that contain candidates - const candidateIndices: Array = [] - for (let i = 0; i < ast.program.body.length; i++) { - const node = ast.program.body[i]! - let declarations: Array | undefined + // JSX candidates (e.g., ) + const jsxCandidatePaths: Array> = [] + const checkJSX = needsJSXDetection(fileKinds, this.externalLookupSetup) + // Get module info that was just cached by ingestModule + const moduleInfo = this.moduleCache.get(id)! + const externalDirectCallCandidates = this.getExternalDirectCallCandidates( + fileKinds, + moduleInfo, + ) + const checkExternalDirectCalls = hasExternalDirectCallCandidates( + externalDirectCallCandidates, + ) - if (t.isVariableDeclaration(node)) { - declarations = node.declarations - } else if (t.isExportNamedDeclaration(node) && node.declaration) { - if (t.isVariableDeclaration(node.declaration)) { - declarations = node.declaration.declarations + if (canUseFastPath) { + // Fast path: only visit top-level statements that have potential candidates + + // Collect indices of top-level statements that contain candidates + const candidateIndices: Array = [] + for (let i = 0; i < ast.program.body.length; i++) { + const node = ast.program.body[i]! + let declarations: Array | undefined + + if (t.isVariableDeclaration(node)) { + declarations = node.declarations + } else if (t.isExportNamedDeclaration(node) && node.declaration) { + if (t.isVariableDeclaration(node.declaration)) { + declarations = node.declaration.declarations + } } - } - if (declarations) { - for (const decl of declarations) { - if (decl.init && t.isCallExpression(decl.init)) { - if ( - isMethodChainCandidate(decl.init, fileKinds) || - (checkDirectCalls && - isTopLevelDirectCallCandidateNode(decl.init)) - ) { - candidateIndices.push(i) - break // Only need to mark this statement once + if (declarations) { + for (const decl of declarations) { + if (decl.init && t.isCallExpression(decl.init)) { + if ( + isMethodChainCandidate(decl.init, fileKinds) || + (checkDirectCalls && + isTopLevelDirectCallCandidateNode(decl.init)) + ) { + candidateIndices.push(i) + break // Only need to mark this statement once + } } } } } - } - // Early exit: no potential candidates found at top level - if (candidateIndices.length === 0) { - return null - } + // Early exit: no potential candidates found at top level + if (candidateIndices.length === 0) { + break builtInTransforms + } - // Targeted traversal: only visit the specific statements that have candidates - // This is much faster than traversing the entire AST - babel.traverse(ast, { - Program(programPath) { - const bodyPaths = programPath.get('body') - for (const idx of candidateIndices) { - const stmtPath = bodyPaths[idx] - if (!stmtPath) continue + // Targeted traversal: only visit the specific statements that have candidates + // This is much faster than traversing the entire AST + babel.traverse(ast, { + Program(programPath) { + const bodyPaths = programPath.get('body') + for (const idx of candidateIndices) { + const stmtPath = bodyPaths[idx] + if (!stmtPath) continue - // Traverse only this statement's subtree - stmtPath.traverse({ - CallExpression(path) { - const node = path.node - const parent = path.parent + // Traverse only this statement's subtree + stmtPath.traverse({ + CallExpression(path) { + const node = path.node + const parent = path.parent - // Check if this call is part of a larger chain (inner call) - if ( - t.isMemberExpression(parent) && - t.isCallExpression(path.parentPath.parent) - ) { - chainCallPaths.set(node, path) - return - } - - // Method chain pattern - if (isMethodChainCandidate(node, fileKinds)) { - candidatePaths.push({ path }) - return - } - - if (checkExternalDirectCalls) { - const kind = getExternalDirectCallCandidateKind( - path, - externalDirectCallCandidates, - ) - if (kind) { - candidatePaths.push({ path, kind }) + // Check if this call is part of a larger chain (inner call) + if ( + t.isMemberExpression(parent) && + t.isCallExpression(path.parentPath.parent) + ) { + chainCallPaths.set(node, path) return } - } - if (isTopLevelDirectCallCandidate(path)) { - candidatePaths.push({ path }) - } - }, - }) - } - // Stop traversal after processing Program - programPath.stop() - }, - }) - } else { - // Normal path: full traversal for non-fast-path kinds - babel.traverse(ast, { - CallExpression: (path) => { - const node = path.node - const parent = path.parent + // Method chain pattern + if (isMethodChainCandidate(node, fileKinds)) { + candidatePaths.push({ path }) + return + } - // Check if this call is part of a larger chain (inner call) - // If so, store it for method chain lookup but don't treat as candidate - if ( - t.isMemberExpression(parent) && - t.isCallExpression(path.parentPath.parent) - ) { - // This is an inner call in a chain - store for later lookup - chainCallPaths.set(node, path) - return - } + if (checkExternalDirectCalls) { + const kind = getExternalDirectCallCandidateKind( + path, + externalDirectCallCandidates, + ) + if (kind) { + candidatePaths.push({ path, kind }) + return + } + } - // Pattern 1: Method chain pattern (.handler(), .server(), .client(), etc.) - if (isMethodChainCandidate(node, fileKinds)) { - candidatePaths.push({ path }) - return - } + if (isTopLevelDirectCallCandidate(path)) { + candidatePaths.push({ path }) + } + }, + }) + } + // Stop traversal after processing Program + programPath.stop() + }, + }) + } else { + // Normal path: full traversal for non-fast-path kinds + babel.traverse(ast, { + CallExpression: (path) => { + const node = path.node + const parent = path.parent - // External direct-call transforms are import-bound. Direct imports - // already identify the transform kind, so skip async import tracing. - if (checkExternalDirectCalls) { - const kind = getExternalDirectCallCandidateKind( - path, - externalDirectCallCandidates, - ) - if (kind) { - candidatePaths.push({ path, kind }) + // Check if this call is part of a larger chain (inner call) + // If so, store it for method chain lookup but don't treat as candidate + if ( + t.isMemberExpression(parent) && + t.isCallExpression(path.parentPath.parent) + ) { + // This is an inner call in a chain - store for later lookup + chainCallPaths.set(node, path) return } - } - if (checkDirectCalls && isTopLevelDirectCallCandidate(path)) { - candidatePaths.push({ path }) - return - } - - // Pattern 2: Direct call pattern - if (checkDirectCalls) { - if ( - isNestedDirectCallCandidate( - node, - fileKinds, - this.externalLookupSetup, - ) - ) { + // Pattern 1: Method chain pattern (.handler(), .server(), .client(), etc.) + if (isMethodChainCandidate(node, fileKinds)) { candidatePaths.push({ path }) return } - } - }, - // Pattern 3: JSX element pattern (e.g., ) - // Collect JSX elements where the component is imported from a known package - // and resolves to a JSX kind (e.g., ClientOnly from @tanstack/react-router) - JSXElement: (path) => { - if (!checkJSX) return - const openingElement = path.node.openingElement - const nameNode = openingElement.name + // External direct-call transforms are import-bound. Direct imports + // already identify the transform kind, so skip async import tracing. + if (checkExternalDirectCalls) { + const kind = getExternalDirectCallCandidateKind( + path, + externalDirectCallCandidates, + ) + if (kind) { + candidatePaths.push({ path, kind }) + return + } + } - // Only handle simple identifier names (not namespaced or member expressions) - if (!t.isJSXIdentifier(nameNode)) return + if (checkDirectCalls && isTopLevelDirectCallCandidate(path)) { + candidatePaths.push({ path }) + return + } - const componentName = nameNode.name - const binding = moduleInfo.bindings.get(componentName) + // Pattern 2: Direct call pattern + if (checkDirectCalls) { + if ( + isNestedDirectCallCandidate( + node, + fileKinds, + this.externalLookupSetup, + ) + ) { + candidatePaths.push({ path }) + return + } + } + }, + // Pattern 3: JSX element pattern (e.g., ) + // Collect JSX elements where the component is imported from a known package + // and resolves to a JSX kind (e.g., ClientOnly from @tanstack/react-router) + JSXElement: (path) => { + if (!checkJSX) return - // Must be an import binding from a known package - if (!binding || binding.type !== 'import') return + const openingElement = path.node.openingElement + const nameNode = openingElement.name - // Verify the import source is a known TanStack router package - const knownExports = this.knownRootImports.get(binding.source) - if (!knownExports) return + // Only handle simple identifier names (not namespaced or member expressions) + if (!t.isJSXIdentifier(nameNode)) return - // Verify the imported name resolves to a JSX kind (e.g., ClientOnlyJSX) - const kind = knownExports.get(binding.importedName) - if (kind !== 'ClientOnlyJSX') return + const componentName = nameNode.name + const binding = moduleInfo.bindings.get(componentName) - jsxCandidatePaths.push(path) - }, - }) - } + // Must be an import binding from a known package + if (!binding || binding.type !== 'import') return - if (candidatePaths.length === 0 && jsxCandidatePaths.length === 0) { - return null - } + // Verify the import source is a known TanStack router package + const knownExports = this.knownRootImports.get(binding.source) + if (!knownExports) return - // Resolve only candidates whose import scan did not already prove the kind. - const resolvedCandidates: Array<{ - path: babel.NodePath - kind: Kind - }> = [] - const unresolvedCandidates: Array = [] + // Verify the imported name resolves to a JSX kind (e.g., ClientOnlyJSX) + const kind = knownExports.get(binding.importedName) + if (kind !== 'ClientOnlyJSX') return - for (const candidate of candidatePaths) { - if (candidate.kind) { - resolvedCandidates.push({ - path: candidate.path, - kind: candidate.kind, + jsxCandidatePaths.push(path) + }, }) - } else { - unresolvedCandidates.push(candidate) } - } - if (unresolvedCandidates.length > 0) { - resolvedCandidates.push( - ...(await Promise.all( - unresolvedCandidates.map(async (candidate) => ({ + if (candidatePaths.length === 0 && jsxCandidatePaths.length === 0) { + break builtInTransforms + } + + // Resolve only candidates whose import scan did not already prove the kind. + const resolvedCandidates: Array<{ + path: babel.NodePath + kind: Kind + }> = [] + const unresolvedCandidates: Array = [] + + for (const candidate of candidatePaths) { + if (candidate.kind) { + resolvedCandidates.push({ path: candidate.path, - kind: await this.resolveExprKind(candidate.path.node, id), - })), - )), - ) - } - - // Filter to valid candidates - const validCandidates = resolvedCandidates.filter(({ path, kind }) => { - if ( - !this.validLookupKinds.has(kind as Exclude) - ) { - return false + kind: candidate.kind, + }) + } else { + unresolvedCandidates.push(candidate) + } } - if ( - isLookupKind(kind) && - kind !== 'ClientOnlyJSX' && - !isMethodChainCandidate(path.node, fileKinds) - ) { - return isDirectCallCandidateForKind(kind, this.externalLookupSetup) + if (unresolvedCandidates.length > 0) { + resolvedCandidates.push( + ...(await Promise.all( + unresolvedCandidates.map(async (candidate) => ({ + path: candidate.path, + kind: await this.resolveExprKind(candidate.path.node, id), + })), + )), + ) } - return true - }) as Array<{ - path: babel.NodePath - kind: Exclude - }> - - if (validCandidates.length === 0 && jsxCandidatePaths.length === 0) { - return null - } - - // Process valid candidates to collect method chains - const pathsToRewrite: Array<{ - path: babel.NodePath - kind: Exclude - methodChain: MethodChainPaths - }> = [] - - for (const { path, kind } of validCandidates) { - const node = path.node - - // Collect method chain paths by walking DOWN from root through the chain - const methodChain: MethodChainPaths = { - middleware: null, - inputValidator: null, - handler: null, - server: null, - client: null, - } - - // Walk down the call chain using nodes, look up paths from map - let currentNode: t.CallExpression = node - let currentPath: babel.NodePath = path - - // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition - while (true) { - const callee = currentNode.callee - if (!t.isMemberExpression(callee)) { - break + // Filter to valid candidates + const validCandidates = resolvedCandidates.filter(({ path, kind }) => { + if ( + !this.validLookupKinds.has( + kind as Exclude, + ) + ) { + return false } - // Record method chain path if it's a known method - if (t.isIdentifier(callee.property)) { - const name = callee.property.name as keyof MethodChainPaths - if (name in methodChain) { - // Get first argument path - const args = currentPath.get('arguments') - const firstArgPath = - Array.isArray(args) && args.length > 0 ? (args[0] ?? null) : null - methodChain[name] = { - callPath: currentPath, - firstArgPath, + if ( + isLookupKind(kind) && + kind !== 'ClientOnlyJSX' && + !isMethodChainCandidate(path.node, fileKinds) + ) { + return isDirectCallCandidateForKind(kind, this.externalLookupSetup) + } + + return true + }) as Array<{ + path: babel.NodePath + kind: Exclude + }> + + if (validCandidates.length === 0 && jsxCandidatePaths.length === 0) { + break builtInTransforms + } + + // Process valid candidates to collect method chains + const pathsToRewrite: Array<{ + path: babel.NodePath + kind: Exclude + methodChain: MethodChainPaths + }> = [] + + for (const { path, kind } of validCandidates) { + const node = path.node + + // Collect method chain paths by walking DOWN from root through the chain + const methodChain: MethodChainPaths = { + middleware: null, + inputValidator: null, + handler: null, + server: null, + client: null, + } + + // Walk down the call chain using nodes, look up paths from map + let currentNode: t.CallExpression = node + let currentPath: babel.NodePath = path + + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + while (true) { + const callee = currentNode.callee + if (!t.isMemberExpression(callee)) { + break + } + + // Record method chain path if it's a known method + if (t.isIdentifier(callee.property)) { + const name = callee.property.name as keyof MethodChainPaths + if (name in methodChain) { + // Get first argument path + const args = currentPath.get('arguments') + const firstArgPath = + Array.isArray(args) && args.length > 0 + ? (args[0] ?? null) + : null + methodChain[name] = { + callPath: currentPath, + firstArgPath, + } } } + + // Move to the inner call (the object of the member expression) + if (!t.isCallExpression(callee.object)) { + break + } + currentNode = callee.object + // Look up path from chain map, or use candidate path if not found + const nextPath = chainCallPaths.get(currentNode) + if (!nextPath) { + break + } + currentPath = nextPath } - // Move to the inner call (the object of the member expression) - if (!t.isCallExpression(callee.object)) { - break - } - currentNode = callee.object - // Look up path from chain map, or use candidate path if not found - const nextPath = chainCallPaths.get(currentNode) - if (!nextPath) { - break - } - currentPath = nextPath + pathsToRewrite.push({ path, kind, methodChain }) } - pathsToRewrite.push({ path, kind, methodChain }) - } + const refIdents = findReferencedIdentifiers(ast) - const refIdents = findReferencedIdentifiers(ast) + const context: CompilationContext = { + ast, + id, + code, + env: this.options.env, + envName: this.options.envName, + mode: this.mode, + root: this.options.root, + framework: this.options.framework, + providerEnvName: this.options.providerEnvName, + types: t, + parseExpression: (expressionCode) => + babel.template.expression(expressionCode, { + placeholderPattern: false, + })() as t.Expression, - const context: CompilationContext = { - ast, - id, - code, - env: this.options.env, - envName: this.options.envName, - mode: this.mode, - root: this.options.root, - framework: this.options.framework, - providerEnvName: this.options.providerEnvName, - types: t, - parseExpression: (expressionCode) => - babel.template.expression(expressionCode, { - placeholderPattern: false, - })() as t.Expression, - - generateFunctionId: (opts) => this.generateFunctionId(opts), - getKnownServerFns: this.options.getKnownServerFns, - serverFnProviderModuleDirectives: - this.options.serverFnProviderModuleDirectives, - onServerFnsById: this.options.onServerFnsById, - } - - // Group candidates by kind for batch processing - const candidatesByKind = new Map< - Exclude, - Array - >() - - for (const { path: candidatePath, kind, methodChain } of pathsToRewrite) { - const candidate: RewriteCandidate = { path: candidatePath, methodChain } - const existing = candidatesByKind.get(kind) - if (existing) { - existing.push(candidate) - } else { - candidatesByKind.set(kind, [candidate]) + generateFunctionId: (opts) => this.generateFunctionId(opts), + getKnownServerFns: this.options.getKnownServerFns, + serverFnProviderModuleDirectives: + this.options.serverFnProviderModuleDirectives, + onServerFnsById: this.options.onServerFnsById, } + + // Group candidates by kind for batch processing + const candidatesByKind = new Map< + Exclude, + Array + >() + + for (const { path: candidatePath, kind, methodChain } of pathsToRewrite) { + const candidate: RewriteCandidate = { path: candidatePath, methodChain } + const existing = candidatesByKind.get(kind) + if (existing) { + existing.push(candidate) + } else { + candidatesByKind.set(kind, [candidate]) + } + } + + // External transforms run before built-ins by default so they can augment + // user handlers before server function extraction clones provider bodies. + this.runExternalTransforms('pre', candidatesByKind, context) + + for (const kind of BuiltInKindHandlerOrder) { + const candidates = candidatesByKind.get(kind) + if (!candidates) continue + const handler = BuiltInKindHandlers[kind] + handler(candidates, context, kind) + } + + this.runExternalTransforms('post', candidatesByKind, context) + + // Handle JSX candidates (e.g., ) + // Validation was already done during traversal - just call the handler + for (const jsxPath of jsxCandidatePaths) { + handleClientOnlyJSX(jsxPath, { env: 'server' }) + } + + deadCodeElimination(ast, refIdents) + astHasChanges = true } - // External transforms run before built-ins by default so they can augment - // user handlers before server function extraction clones provider bodies. - this.runExternalTransforms('pre', candidatesByKind, context) - - for (const kind of BuiltInKindHandlerOrder) { - const candidates = candidatesByKind.get(kind) - if (!candidates) continue - const handler = BuiltInKindHandlers[kind] - handler(candidates, context, kind) + if (astTransformPlugins.length > 0) { + astHasChanges = + this.runAstTransforms({ + ast, + code, + id, + transforms: astTransformPlugins, + }) || astHasChanges } - this.runExternalTransforms('post', candidatesByKind, context) - - // Handle JSX candidates (e.g., ) - // Validation was already done during traversal - just call the handler - for (const jsxPath of jsxCandidatePaths) { - handleClientOnlyJSX(jsxPath, { env: 'server' }) - } - - deadCodeElimination(ast, refIdents) + return astHasChanges ? this.generateResultFromAst(ast, code, id) : null + } + private generateResultFromAst( + ast: ParsedAst, + sourceCode: string, + id: string, + ): StartCompilerTransformResult { const result = generateFromAst(ast, { sourceMaps: true, sourceFileName: id, @@ -1420,17 +1409,66 @@ export class StartCompiler { }) // @babel/generator does not populate sourcesContent because it only has - // the AST, not the original text. Without this, Vite's composed - // sourcemap omits the original source, causing downstream consumers - // (e.g. import-protection snippet display) to fall back to the shorter - // compiled output and fail to resolve original line numbers. + // the AST, not the original text. Without this, Vite's composed sourcemap + // omits the original source, causing downstream consumers to fall back to + // the compiled output and fail to resolve original line numbers. if (result.map) { - result.map.sourcesContent = [code] + result.map.sourcesContent = [sourceCode] } return result } + private getAstTransformPluginsForCode( + code: string, + ): Array { + return this.compilerPlugins.filter( + (plugin): plugin is StartCompilerAstPlugin => { + if (!plugin.transformAst) return false + if (!plugin.detect) return true + plugin.detect.lastIndex = 0 + return plugin.detect.test(code) + }, + ) + } + + private runAstTransforms({ + ast, + code, + id, + transforms, + }: { + ast: ParsedAst + code: string + id: string + transforms: Array + }): boolean { + let modified = false + + for (const plugin of transforms) { + const context = { + ast, + code, + id, + env: this.options.env, + envName: this.options.envName, + mode: this.mode, + root: this.options.root, + framework: this.options.framework, + providerEnvName: this.options.providerEnvName, + types: t, + parseExpression: (expressionCode: string) => + babel.template.expression(expressionCode, { + placeholderPattern: false, + })() as t.Expression, + } + + modified = plugin.transformAst(context) || modified + } + + return modified + } + private runExternalTransforms( order: 'pre' | 'post', candidatesByKind: Map< @@ -1608,8 +1646,8 @@ export class StartCompiler { return 'None' } - for (const [source, exports] of this.knownRootImports) { - const kind = exports.get(binding.importedName) + for (const [source, rootExports] of this.knownRootImports) { + const kind = rootExports.get(binding.importedName) if (!kind) { continue } diff --git a/packages/start-plugin-core/src/start-compiler/config.ts b/packages/start-plugin-core/src/start-compiler/config.ts index e9d7d95e5e..387343bad9 100644 --- a/packages/start-plugin-core/src/start-compiler/config.ts +++ b/packages/start-plugin-core/src/start-compiler/config.ts @@ -3,17 +3,20 @@ import { getExternalLookupKind, getLookupKindsForEnv, isCompilerTransformEnabledForEnv, + isStartCompilerPluginEnabledForEnv, } from './compiler' import type { BuiltInLookupKind, LookupConfig } from './compiler' import type { CompileStartFrameworkOptions, StartCompilerImportTransform, + StartCompilerPlugin, } from '../types' export function getTransformCodeFilterForEnv( env: 'client' | 'server', opts?: { compilerTransforms?: Array | undefined + compilerPlugins?: Array | undefined }, ): Array { const validKinds = getLookupKindsForEnv(env, opts) @@ -33,6 +36,12 @@ export function getTransformCodeFilterForEnv( } } + for (const plugin of opts?.compilerPlugins ?? []) { + if (plugin.detect && isStartCompilerPluginEnabledForEnv(plugin, env)) { + patterns.push(plugin.detect) + } + } + return patterns } diff --git a/packages/start-plugin-core/src/start-compiler/host.ts b/packages/start-plugin-core/src/start-compiler/host.ts index e1da89d7f2..c225347dea 100644 --- a/packages/start-plugin-core/src/start-compiler/host.ts +++ b/packages/start-plugin-core/src/start-compiler/host.ts @@ -3,6 +3,9 @@ import { getLookupConfigurationsForEnv } from './config' import type { CompileStartFrameworkOptions, StartCompilerImportTransform, + StartCompilerPlugin, + StartCompilerTransformResult, + StartCompilerVirtualModuleContext, } from '../types' import type { DevServerFnModuleSpecifierEncoder, @@ -19,6 +22,7 @@ export interface CreateStartCompilerOptions { mode: 'dev' | 'build' generateFunctionId?: GenerateFunctionIdFnOptional compilerTransforms?: Array | undefined + compilerPlugins?: Array | undefined serverFnProviderModuleDirectives?: ReadonlyArray | undefined onServerFnsById?: (d: Record) => void getKnownServerFns: () => Record @@ -48,6 +52,7 @@ export function createStartCompiler( generateFunctionId: options.generateFunctionId, onServerFnsById: options.onServerFnsById, compilerTransforms: options.compilerTransforms, + compilerPlugins: options.compilerPlugins, serverFnProviderModuleDirectives: options.serverFnProviderModuleDirectives, getKnownServerFns: options.getKnownServerFns, devServerFnModuleSpecifierEncoder: options.encodeModuleSpecifierInDev, @@ -81,6 +86,7 @@ export function matchesCodeFilters( filters: ReadonlyArray, ): boolean { for (const pattern of filters) { + pattern.lastIndex = 0 if (pattern.test(code)) { return true } @@ -88,3 +94,43 @@ export function matchesCodeFilters( return false } + +export function createCompilerVirtualModuleIdPattern( + compilerPlugins: ReadonlyArray, +) { + const patterns = compilerPlugins + .map((plugin) => plugin.virtualModuleIdPattern) + .filter((pattern): pattern is RegExp => !!pattern) + + if (patterns.length === 0) { + return undefined + } + + return new RegExp( + patterns.map((pattern) => `(?:${pattern.source})`).join('|'), + ) +} + +export function loadCompilerVirtualModule( + compilerPlugins: ReadonlyArray, + context: StartCompilerVirtualModuleContext, +): StartCompilerTransformResult | null { + for (const compilerPlugin of compilerPlugins) { + const pattern = compilerPlugin.virtualModuleIdPattern + if (!pattern) { + continue + } + + pattern.lastIndex = 0 + if (!pattern.test(context.id)) { + continue + } + + const result = compilerPlugin.loadVirtualModule?.(context) + if (result) { + return result + } + } + + return null +} diff --git a/packages/start-plugin-core/src/start-manifest-plugin/manifestBuilder.ts b/packages/start-plugin-core/src/start-manifest-plugin/manifestBuilder.ts index a3c991c4c7..6f27f37d4d 100644 --- a/packages/start-plugin-core/src/start-manifest-plugin/manifestBuilder.ts +++ b/packages/start-plugin-core/src/start-manifest-plugin/manifestBuilder.ts @@ -484,10 +484,35 @@ export function buildRouteManifestRoutes(options: { getChunkCssAssets, getChunkPreloads: options.assetResolvers.getChunkPreloads, }) + + if (routeId !== rootRouteId) { + mergeReachableHydrationChunkData({ + route: targetRoute, + chunk, + chunksByFileName: options.chunksByFileName, + getChunkCssAssets, + }) + } } } const rootRoute = (routes[rootRouteId] = routes[rootRouteId] || {}) + const rootRouteTreeRoute = options.routeTreeRoutes[rootRouteId] + const rootRouteChunks = rootRouteTreeRoute?.filePath + ? options.routeChunksByFilePath.get(rootRouteTreeRoute.filePath) + : undefined + + if (rootRouteChunks) { + for (const chunk of rootRouteChunks) { + mergeReachableHydrationChunkData({ + route: rootRoute, + chunk, + chunksByFileName: options.chunksByFileName, + getChunkCssAssets, + }) + } + } + mergeRouteChunkData({ route: rootRoute, chunk: options.entryChunk, @@ -517,6 +542,54 @@ export function buildRouteManifestRoutes(options: { return routes } +function mergeReachableHydrationChunkData(options: { + route: RouteTreeRoute + chunk: NormalizedClientChunk + chunksByFileName: ReadonlyMap + getChunkCssAssets: (chunk: NormalizedClientChunk) => Array +}) { + const visitedStaticChunks = new Set() + const mergedHydrationChunks = new Set() + + const mergeHydrationChunk = (chunk: NormalizedClientChunk) => { + if (mergedHydrationChunks.has(chunk.fileName)) return + mergedHydrationChunks.add(chunk.fileName) + + options.route.assets = appendUniqueAssets( + options.route.assets, + options.getChunkCssAssets(chunk), + ) + + for (const dynamicImport of chunk.dynamicImports) { + const dynamicChunk = options.chunksByFileName.get(dynamicImport) + if (dynamicChunk?.hydrationIds.length) { + mergeHydrationChunk(dynamicChunk) + } + } + } + + const visitStaticChunk = (chunk: NormalizedClientChunk) => { + if (visitedStaticChunks.has(chunk.fileName)) return + visitedStaticChunks.add(chunk.fileName) + + for (const importedFileName of chunk.imports) { + const importedChunk = options.chunksByFileName.get(importedFileName) + if (importedChunk) { + visitStaticChunk(importedChunk) + } + } + + for (const dynamicImport of chunk.dynamicImports) { + const dynamicChunk = options.chunksByFileName.get(dynamicImport) + if (dynamicChunk?.hydrationIds.length) { + mergeHydrationChunk(dynamicChunk) + } + } + } + + visitStaticChunk(options.chunk) +} + export { getRouteFilePathsFromModuleIds, normalizeViteClientBuild, diff --git a/packages/start-plugin-core/src/types.ts b/packages/start-plugin-core/src/types.ts index bc76726875..f0acdbfe35 100644 --- a/packages/start-plugin-core/src/types.ts +++ b/packages/start-plugin-core/src/types.ts @@ -1,5 +1,6 @@ import type * as babel from '@babel/core' import type * as t from '@babel/types' +import type { GeneratorResult } from '@tanstack/router-utils' import type { TanStackStartOutputConfig } from './schema' export type CompileStartFrameworkOptions = 'react' | 'solid' | 'vue' @@ -62,6 +63,36 @@ export interface StartCompilerImportTransform { ) => void } +export interface StartCompilerTransformResult { + code: string + map?: GeneratorResult['map'] | null +} + +export interface StartCompilerVirtualModuleContext { + readonly id: string + readonly root: string + readonly env: StartCompilerEnvironment + readonly envName: string + readonly code?: string +} + +export interface StartCompilerPlugin { + name: string + environment?: + | StartCompilerEnvironment + | Array + | undefined + detect?: RegExp | undefined + virtualModuleIdPattern?: RegExp | undefined + transformAst?: ( + context: StartCompilerTransformContext, + ) => boolean | null | undefined + loadVirtualModule?: ( + context: StartCompilerVirtualModuleContext, + ) => StartCompilerTransformResult | null + invalidateModule?: (context: { id: string; envName: string }) => void +} + export interface NormalizedBasePaths { publicBase: string assetBase: { @@ -82,6 +113,7 @@ export interface NormalizedClientChunk { dynamicImports: Array css: Array routeFilePaths: Array + hydrationIds: Array } export interface NormalizedClientBuild { diff --git a/packages/start-plugin-core/src/vite/start-compiler-plugin/plugin.ts b/packages/start-plugin-core/src/vite/start-compiler-plugin/plugin.ts index 698ab5ae1a..7a2ddd9ff6 100644 --- a/packages/start-plugin-core/src/vite/start-compiler-plugin/plugin.ts +++ b/packages/start-plugin-core/src/vite/start-compiler-plugin/plugin.ts @@ -8,12 +8,18 @@ import { import { detectKindsInCode } from '../../start-compiler/compiler' import { getTransformCodeFilterForEnv } from '../../start-compiler/config' import { + createCompilerVirtualModuleIdPattern, createStartCompiler, + loadCompilerVirtualModule, mergeServerFnsById, } from '../../start-compiler/host' import { generateServerFnResolverModule } from '../../start-compiler/server-fn-resolver-module' import { cleanId } from '../../start-compiler/utils' import { createVirtualModule } from '../createVirtualModule' +import { + MissingHydrateSourceError, + createHydrateCompilerPlugin, +} from '../../hydrate-when-transform' import { resolveViteId } from '../../utils' import { createViteDevServerFnModuleSpecifierEncoder, @@ -23,12 +29,13 @@ import { mergeHotUpdateModules } from './hot-update' import type { CompileStartFrameworkOptions, StartCompilerImportTransform, + StartCompilerPlugin, } from '../../types' import type { GenerateFunctionIdFnOptional, ServerFn, } from '../../start-compiler/types' -import type { EnvironmentModuleNode, PluginOption } from 'vite' +import type { Environment, EnvironmentModuleNode, PluginOption } from 'vite' // Re-export from shared constants for backwards compatibility export { SERVER_FN_LOOKUP } @@ -46,6 +53,32 @@ type ModuleInvalidationEnvironment = { } } +type ViteModuleLoadOptions = { + devId?: string + load: (options: { id: string }) => Promise<{ code?: string | null } | null> + error: (message: string) => never +} + +async function loadViteModuleFromEnvironment( + environment: Environment, + id: string, + opts: ViteModuleLoadOptions, +): Promise { + if (environment.mode === 'build') { + const loaded = await opts.load({ id }) + return loaded?.code ?? '' + } + + if (environment.mode === 'dev') { + await environment.transformRequest(opts.devId ?? id) + return undefined + } + + opts.error( + `could not load module ${id}: unknown environment mode ${environment.mode}`, + ) +} + function invalidateMatchingFileModules( environment: ModuleInvalidationEnvironment, ids: Iterable, @@ -104,6 +137,25 @@ function invalidateServerFnLookupModules( ) } +function invalidateCompilerVirtualModules( + environment: ModuleInvalidationEnvironment, + ids: Iterable, + pattern: RegExp | undefined, +) { + if (!pattern) { + return [] + } + + return invalidateMatchingFileModules(environment, ids, (fileModule) => { + if (!fileModule.id) { + return false + } + + pattern.lastIndex = 0 + return pattern.test(fileModule.id) + }) +} + function getServerFnProviderIds(ids: Iterable) { const providerIds = new Set() @@ -170,6 +222,7 @@ export interface StartCompilerPluginOptions { */ generateFunctionId?: GenerateFunctionIdFnOptional compilerTransforms?: Array | undefined + compilerPlugins?: Array | undefined serverFnProviderModuleDirectives?: ReadonlyArray | undefined /** * The Vite environment name for the server function provider. @@ -181,6 +234,15 @@ export function startCompilerPlugin( opts: StartCompilerPluginOptions, ): PluginOption { const compilers = new Map>() + const compilerPlugins = [ + createHydrateCompilerPlugin(), + ...(opts.compilerPlugins ?? []), + ] + const compilerVirtualModuleIdPattern = + createCompilerVirtualModuleIdPattern(compilerPlugins) + const environmentByName = new Map( + opts.environments.map((environment) => [environment.name, environment]), + ) // Shared registry of server functions across all environments const serverFnsById: Record = {} @@ -218,6 +280,7 @@ export function startCompilerPlugin( // Derive transform code filter from KindDetectionPatterns (single source of truth) const transformCodeFilter = getTransformCodeFilterForEnv(environment.type, { compilerTransforms, + compilerPlugins, }) return { name: `tanstack-start-core::server-fn:${environment.name}`, @@ -262,6 +325,7 @@ export function startCompilerPlugin( providerEnvName: opts.providerEnvName, generateFunctionId: opts.generateFunctionId, compilerTransforms, + compilerPlugins, serverFnProviderModuleDirectives, onServerFnsById, getKnownServerFns: () => serverFnsById, @@ -270,23 +334,18 @@ export function startCompilerPlugin( ? createViteDevServerFnModuleSpecifierEncoder(root) : undefined, loadModule: async (id: string) => { - if (mode === 'build') { - const loaded = await this.load({ id }) - const code = loaded.code ?? '' - - compiler!.ingestModule({ code, id }) - return - } - - if (this.environment.mode !== 'dev') { - this.error( - `could not load module ${id}: unknown environment mode ${this.environment.mode}`, - ) - } - - await this.environment.transformRequest( - `${id}?${SERVER_FN_LOOKUP}`, + const code = await loadViteModuleFromEnvironment( + this.environment, + id, + { + load: (options) => this.load(options), + error: (message) => this.error(message), + devId: `${id}?${SERVER_FN_LOOKUP}`, + }, ) + if (code !== undefined) { + compiler!.ingestModule({ code, id }) + } }, resolveId: async (source: string, importer?: string) => { @@ -315,6 +374,7 @@ export function startCompilerPlugin( code, detectedKinds, }) + return result }, }, @@ -324,17 +384,22 @@ export function startCompilerPlugin( const idsToInvalidate = new Set() const transitiveCompilerImportersToInvalidate = new Set() const importerModulesToInvalidate = new Set() + const changedIds: Array = [] ctx.modules.forEach((m) => { if (m.id) { idsToInvalidate.add(m.id) - const deleted = compiler?.invalidateModule(m.id) + changedIds.push(m.id) + } + }) - if (deleted) { + const deletedIds = compiler?.invalidateModules(changedIds) ?? new Set() + + ctx.modules.forEach((m) => { + if (m.id) { + if (deletedIds.has(cleanId(m.id))) { transitiveCompilerImportersToInvalidate.add(cleanId(m.id)) - } - if (deleted) { m.importers.forEach((importer) => { if (importer.id) { idsToInvalidate.add(importer.id) @@ -349,54 +414,54 @@ export function startCompilerPlugin( }) const finishHotUpdate = async () => { - if (environment.type === 'server' && compiler) { - const pendingImporters = [ - ...transitiveCompilerImportersToInvalidate, - ] - const seenImporters = new Set(pendingImporters) + if ( + environment.type === 'server' && + compiler && + transitiveCompilerImportersToInvalidate.size > 0 + ) { + const seenImporters = new Set( + transitiveCompilerImportersToInvalidate, + ) + const nestedImporters = + await compiler.getTransitiveImporters(seenImporters) - while (pendingImporters.length > 0) { - const importerId = pendingImporters.pop()! - const nestedImporters = - await compiler.getTransitiveImporters(importerId) - - for (const nestedImporterId of nestedImporters) { - if (seenImporters.has(nestedImporterId)) { - continue - } - - seenImporters.add(nestedImporterId) - pendingImporters.push(nestedImporterId) - } + for (const nestedImporterId of nestedImporters) { + seenImporters.add(nestedImporterId) } for (const importerId of seenImporters) { idsToInvalidate.add(importerId) - compiler.invalidateModule(importerId) } + compiler.invalidateModules(seenImporters) } invalidateModuleNodes(this.environment, importerModulesToInvalidate) invalidateServerFnLookupModules(this.environment, idsToInvalidate) + const compilerVirtualModules = invalidateCompilerVirtualModules( + this.environment, + idsToInvalidate, + compilerVirtualModuleIdPattern, + ) if (environment.type !== 'server') { - return + return mergeHotUpdateModules(ctx.modules, compilerVirtualModules) } invalidateModuleNodes(this.environment, ctx.modules) const providerIdsToInvalidate = getServerFnProviderIds(idsToInvalidate) - for (const providerId of providerIdsToInvalidate) { - compiler?.invalidateModule(providerId) - } + compiler?.invalidateModules(providerIdsToInvalidate) const providerModules = invalidateServerFnProviderModules( this.environment, [...idsToInvalidate, ...providerIdsToInvalidate], ) - return mergeHotUpdateModules(ctx.modules, providerModules) + return mergeHotUpdateModules(ctx.modules, [ + ...compilerVirtualModules, + ...providerModules, + ]) } return finishHotUpdate() @@ -423,6 +488,45 @@ export function startCompilerPlugin( }, }, }, + { + name: 'tanstack-start-core:compiler-virtual-module', + enforce: 'pre', + load: { + filter: { + id: compilerVirtualModuleIdPattern ?? /$^/, + }, + async handler(id) { + const environment = environmentByName.get(this.environment.name) + if (!environment || !compilerVirtualModuleIdPattern) { + return null + } + + const loadVirtualModule = () => + loadCompilerVirtualModule(compilerPlugins, { + id, + root, + env: environment.type, + envName: this.environment.name, + }) + + try { + return loadVirtualModule() + } catch (error) { + if (!(error instanceof MissingHydrateSourceError)) { + throw error + } + } + + const sourceId = cleanId(id) + await loadViteModuleFromEnvironment(this.environment, sourceId, { + load: (options) => this.load(options), + error: (message) => this.error(message), + }) + + return loadVirtualModule() + }, + }, + }, // Validate server function ID in dev mode { name: 'tanstack-start-core:validate-server-fn-id', @@ -451,7 +555,7 @@ export function startCompilerPlugin( typeof decoded.file === 'string' && typeof decoded.export === 'string' ) { - // Use the Vite strategy to decode the module specifier + // Use the Vite when to decode the module specifier // back to the original source file path. const sourceFile = decodeViteDevServerModuleSpecifier( decoded.file, diff --git a/packages/start-plugin-core/src/vite/start-manifest-plugin/normalized-client-build.ts b/packages/start-plugin-core/src/vite/start-manifest-plugin/normalized-client-build.ts index 8ac7915ff0..c14609bc6a 100644 --- a/packages/start-plugin-core/src/vite/start-manifest-plugin/normalized-client-build.ts +++ b/packages/start-plugin-core/src/vite/start-manifest-plugin/normalized-client-build.ts @@ -1,4 +1,5 @@ import { tsrSplit } from '@tanstack/router-plugin' +import { tssHydrate } from '../../hydration-constants' import { getCssAssetSource } from '../../start-manifest-plugin/inlineCss' import type { Rollup } from 'vite' import type { NormalizedClientBuild, NormalizedClientChunk } from '../../types' @@ -13,6 +14,7 @@ export function normalizeViteClientChunk( dynamicImports: chunk.dynamicImports, css: Array.from(chunk.viteMetadata?.importedCss ?? []), routeFilePaths: getRouteFilePathsFromModuleIds(chunk.moduleIds), + hydrationIds: getHydrationIdsFromModuleIds(chunk.moduleIds), } } @@ -147,3 +149,38 @@ export function getRouteFilePathsFromModuleIds(moduleIds: Array) { return routeFilePaths ?? [] } + +export function getHydrationIdsFromModuleIds(moduleIds: Array) { + let hydrationIds: Array | undefined + let seen: Set | undefined + + for (const moduleId of moduleIds) { + const queryIndex = moduleId.indexOf('?') + + if (queryIndex < 0) { + continue + } + + const query = moduleId.slice(queryIndex + 1) + + if (!query.includes(tssHydrate)) { + continue + } + + const hydrationId = new URLSearchParams(query).get(tssHydrate) + + if (!hydrationId || seen?.has(hydrationId)) { + continue + } + + if (hydrationIds === undefined || seen === undefined) { + hydrationIds = [] + seen = new Set() + } + + hydrationIds.push(hydrationId) + seen.add(hydrationId) + } + + return hydrationIds ?? [] +} diff --git a/packages/start-plugin-core/tests/compiler.test.ts b/packages/start-plugin-core/tests/compiler.test.ts index e5c99fd257..94780d140b 100644 --- a/packages/start-plugin-core/tests/compiler.test.ts +++ b/packages/start-plugin-core/tests/compiler.test.ts @@ -185,6 +185,29 @@ describe('detectKindsInCode', () => { new Set(['ClientOnlyFn']), ) }) + + test('resets external transform regex state between detections', () => { + const compilerTransforms: Array = [ + { + name: 'global-detect', + environment: 'server', + imports: [{ libName: '@example/runtime', rootExport: 'renderThing' }], + detect: /\brenderThing\b/g, + transform: () => {}, + }, + ] + const code = ` + import { renderThing } from '@example/runtime' + renderThing() + ` + + expect(detectKindsInCode(code, 'server', { compilerTransforms })).toEqual( + new Set(['External:global-detect']), + ) + expect(detectKindsInCode(code, 'server', { compilerTransforms })).toEqual( + new Set(['External:global-detect']), + ) + }) }) describe('detects multiple kinds in same file', () => { @@ -611,6 +634,53 @@ test('ingestModule handles empty code gracefully', () => { }).not.toThrow() }) +test('compile caches modules without detected candidates for transitive importer traversal', async () => { + const compiler = new StartCompiler({ + env: 'client', + ...getDefaultTestOptions('client'), + lookupKinds: new Set(['ServerFn']), + lookupConfigurations: [], + getKnownServerFns: () => ({}), + loadModule: async () => {}, + resolveId: async (source, importer) => { + if (source === './leaf' && importer === '/src/plain.ts') { + return '/src/leaf.ts' + } + + if (source === './plain' && importer === '/src/parent.ts') { + return '/src/plain.ts' + } + + return null + }, + }) + + await compiler.compile({ + id: '/src/plain.ts', + code: ` + import { value } from './leaf' + export const plain = value + `, + detectedKinds: new Set(), + }) + + await compiler.compile({ + id: '/src/parent.ts', + code: ` + import { plain } from './plain' + export const parent = plain + `, + detectedKinds: new Set(), + }) + + expect(await compiler.getTransitiveImporters('/src/leaf.ts')).toEqual( + new Set(['/src/plain.ts', '/src/parent.ts']), + ) + expect(await compiler.getTransitiveImporters(['/src/leaf.ts'])).toEqual( + new Set(['/src/plain.ts', '/src/parent.ts']), + ) +}) + describe('calling result of createServerOnlyFn/createClientOnlyFn', () => { // This tests the fix for https://github.com/TanStack/router/issues/6643 // When a file has both createServerFn and createServerOnlyFn, and the result diff --git a/packages/start-plugin-core/tests/hydrate-when-transform.test.ts b/packages/start-plugin-core/tests/hydrate-when-transform.test.ts new file mode 100644 index 0000000000..13e1d909bd --- /dev/null +++ b/packages/start-plugin-core/tests/hydrate-when-transform.test.ts @@ -0,0 +1,618 @@ +import { mkdtempSync } from 'node:fs' +import { tmpdir } from 'node:os' +import { join } from 'node:path' +import * as t from '@babel/types' +import { generateFromAst, parseAst } from '@tanstack/router-utils' +import { describe, expect, test } from 'vitest' +import { createHydrateCompilerPlugin } from '../src/hydrate-when-transform' +import type { CompileStartFrameworkOptions } from '../src/types' + +const root = '/repo' +const id = '/repo/src/routes/about.tsx' + +type HydrateBoundary = { + id: string + exportName: string + index: number +} + +function getHydrateBoundariesFromCode(code: string): Array { + const boundaries: Array = [] + const hydrateImportPattern = + /import\("([^"]*[?&]tss-hydrate=[^"]*)"\),\s*"([^"]+)"/g + let match: RegExpExecArray | null + + while ((match = hydrateImportPattern.exec(code))) { + const importId = match[1]! + const queryIndex = importId.indexOf('?') + const params = new URLSearchParams(importId.slice(queryIndex + 1)) + const boundaryId = params.get('tss-hydrate') + const separatorIndex = boundaryId?.indexOf('_') ?? -1 + const index = + boundaryId && separatorIndex > 0 + ? Number.parseInt(boundaryId.slice(0, separatorIndex), 36) + : Number.NaN + + if (boundaryId && Number.isInteger(index)) { + boundaries.push({ + id: boundaryId, + exportName: match[2]!, + index, + }) + } + } + + return boundaries.sort((a, b) => a.index - b.index) +} + +function virtualHydrateId( + file: string, + boundary: Pick, +) { + const params = new URLSearchParams() + params.set('tss-hydrate', boundary.id) + return `${file}?${params.toString()}` +} + +function withSourceHash(id: string, sourceHash: string) { + const separatorIndex = id.indexOf('_') + return `${id.slice(0, separatorIndex + 1)}${sourceHash}` +} + +function compileHydrate(options: { + code: string + id: string + root: string + env: 'client' | 'server' + envName?: string + framework?: CompileStartFrameworkOptions + plugin?: ReturnType +}) { + const plugin = options.plugin ?? createHydrateCompilerPlugin() + const envName = options.envName ?? options.env + const ast = parseAst({ code: options.code, sourceFilename: options.id }) + const result = plugin.transformAst?.({ + ast, + code: options.code, + id: options.id, + root: options.root, + env: options.env, + envName, + mode: 'dev', + framework: options.framework ?? 'react', + providerEnvName: 'ssr', + types: t, + parseExpression: (expressionCode) => t.identifier(expressionCode), + }) + if (!result) return null + + const generated = generateFromAst(ast, { + sourceMaps: true, + sourceFileName: options.id, + filename: options.id, + }) + + return { + code: generated.code, + map: generated.map, + boundaries: getHydrateBoundariesFromCode(generated.code), + plugin, + } +} + +function loadVirtualHydrateModule(options: { + code: string + id: string + root: string + envName?: string +}) { + const plugin = createHydrateCompilerPlugin() + return plugin.loadVirtualModule?.({ + code: options.code, + id: options.id, + root: options.root, + env: 'client', + envName: options.envName ?? 'client', + }) +} + +describe('Hydrate compiler transform', () => { + test('splits Hydrate children behind a lazy import', () => { + const result = compileHydrate({ + code: ` + import { Hydrate } from '@tanstack/react-start' + import { visible } from '@tanstack/react-start/hydration' + + export function Page() { + return ( + + + + ) + } + + function Widget(props: { title: string }) { + return

{props.title}

+ } + `, + id, + root, + env: 'client', + }) + + expect(result?.code).toContain('lazyRouteComponent') + expect(result?.code).toContain('tss-hydrate=') + expect(result?.code).not.toContain('tss-hydrate-index') + expect(result?.code).not.toContain('createElement') + expect(result?.code).toContain('h=') + expect(result?.code).not.toContain('p=') + }) + + test('uses the Solid Router import source for Solid Hydrate boundaries', () => { + const result = compileHydrate({ + code: ` + import { Hydrate } from '@tanstack/solid-start' + import { visible } from '@tanstack/solid-start/hydration' + + export function Page() { + return ( + + + + ) + } + + function Widget(props: { title: string }) { + return

{props.title}

+ } + `, + id, + root, + env: 'client', + framework: 'solid', + }) + + expect(result?.code).toContain( + 'lazyRouteComponent } from "@tanstack/solid-router"', + ) + expect(result?.code).toContain('tss-hydrate=') + expect(result?.code).toContain('h=') + expect(result?.code).not.toContain('p=') + }) + + test('rejects function-as-children unless the boundary opts out of splitting', () => { + expect(() => + compileHydrate({ + code: ` + import { Hydrate } from '@tanstack/react-start' + import { idle } from '@tanstack/react-start/hydration' + + export function Page() { + return ( + + {() =>

child

} +
+ ) + } + `, + id, + root, + env: 'client', + }), + ).toThrow(/function-as-children/) + }) + + test('rejects hook calls that would be moved into an extracted component', () => { + expect(() => + compileHydrate({ + code: ` + import { Hydrate } from '@tanstack/react-start' + import { idle } from '@tanstack/react-start/hydration' + + function useThing() { + return 'thing' + } + + export function Page() { + return ( + +

{useThing()}

+
+ ) + } + `, + id, + root, + env: 'client', + }), + ).toThrow(/hooks/) + }) + + test('strips Hydrate fallback from the server transform', () => { + const result = compileHydrate({ + code: ` + import { Hydrate } from '@tanstack/react-start' + import { idle, visible } from '@tanstack/react-start/hydration' + + const spreadProps = { + when: visible(), + fallback:
bound
, + } + + export function Page() { + return ( + <> + fallback
} + > + + + inline} + > + + + spread, + }} + > + + + + + + + ) + } + + function Widget(props: { title: string }) { + return

{props.title}

+ } + `, + id, + root, + env: 'server', + }) + + expect(result?.code).not.toContain('fallback=') + expect(result?.code).not.toContain('fallback:') + expect(result?.code).not.toContain('server-fallback') + expect(result?.code).not.toContain('server-inline') + expect(result?.code).not.toContain('server-spread') + expect(result?.code).not.toContain('server-bound-spread') + expect(result?.code).toContain('h=') + expect(result?.code).toContain('') + expect(result?.code).toContain('') + expect(result?.code).toContain('') + expect(result?.code).toContain('') + }) + + test('supports nested Hydrate boundaries in extracted virtual modules', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const code = ` + import { Hydrate } from '@tanstack/react-start' + import { interaction, visible } from '@tanstack/react-start/hydration' + + const unused = 'remove me' + + export function Page() { + return ( + +
+ + + +
+
+ ) + } + ` + const firstPass = compileHydrate({ + code, + id: file, + root: dir, + env: 'client', + }) + expect(firstPass?.boundaries).toHaveLength(1) + + const virtualId = virtualHydrateId(file, firstPass!.boundaries[0]!) + const virtualModule = loadVirtualHydrateModule({ + code, + id: virtualId, + root: dir, + }) + expect(virtualModule?.code).not.toContain('remove me') + + const boundaryIndex = firstPass!.boundaries[0]!.index + const nestedPass = compileHydrate({ + code: virtualModule!.code, + id: virtualId, + root: dir, + env: 'client', + }) + + expect(boundaryIndex).toBe(0) + expect(nestedPass?.code).toContain('H1') + expect(nestedPass?.code).toContain('tss-hydrate=') + }) + + test('keeps sibling boundary ids stable after nested boundaries', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const code = ` + import { Hydrate } from '@tanstack/react-start' + import { idle, interaction, visible } from '@tanstack/react-start/hydration' + + export function Page() { + return ( + <> + +
+ + + +
+
+ +

Sibling

+
+ + ) + } + ` + const firstPass = compileHydrate({ + code, + id: file, + root: dir, + env: 'client', + }) + expect( + firstPass?.boundaries.map((boundary) => boundary.exportName), + ).toEqual(['H0', 'H2']) + + const siblingBoundary = firstPass!.boundaries[1]! + const virtualId = virtualHydrateId(file, siblingBoundary) + const boundaryIndex = siblingBoundary.index + const virtualModule = loadVirtualHydrateModule({ + code, + id: virtualId, + root: dir, + }) + const parentVirtualId = virtualHydrateId(file, firstPass!.boundaries[0]!) + const parentVirtualModule = loadVirtualHydrateModule({ + code, + id: parentVirtualId, + root: dir, + }) + const nestedPass = compileHydrate({ + code: parentVirtualModule!.code, + id: parentVirtualId, + root: dir, + env: 'client', + }) + const serverPass = compileHydrate({ + code, + id: file, + root: dir, + env: 'server', + }) + + expect(boundaryIndex).toBe(2) + expect(virtualModule?.code).toContain('Sibling') + expect(virtualModule?.code).not.toContain('Nested') + expect(nestedPass?.boundaries[0]?.exportName).toBe('H1') + expect(serverPass?.code).toContain(firstPass!.boundaries[0]!.id) + expect(serverPass?.code).toContain(nestedPass!.boundaries[0]!.id) + expect(serverPass?.code).toContain(siblingBoundary.id) + }) + + test('loads virtual modules from supplied bundler code instead of the filesystem', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const oldCode = ` + import { Hydrate } from '@tanstack/react-start' + import { visible } from '@tanstack/react-start/hydration' + + export function Page() { + return

Old

+ } + ` + const nextCode = oldCode.replace('Old', 'New') + const firstPass = compileHydrate({ + code: oldCode, + id: file, + root: dir, + env: 'client', + }) + const virtualModule = loadVirtualHydrateModule({ + code: nextCode, + id: virtualHydrateId(file, firstPass!.boundaries[0]!), + root: dir, + }) + + expect(virtualModule?.code).toContain('New') + expect(virtualModule?.code).not.toContain('Old') + }) + + test('captures identifiers used by shorthand objects and computed members', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const code = ` + import { Hydrate } from '@tanstack/react-start' + import { visible } from '@tanstack/react-start/hydration' + + export function Page() { + const key = 'name' + const items = { name: 'Ada' } + return ( + + + + ) + } + + function Widget(props: { data: { key: string; value: string } }) { + return

{props.data.value}

+ } + ` + const firstPass = compileHydrate({ + code, + id: file, + root: dir, + env: 'client', + }) + const virtualModule = loadVirtualHydrateModule({ + code, + id: virtualHydrateId(file, firstPass!.boundaries[0]!), + root: dir, + }) + + expect(virtualModule?.code).toContain('export function H0({') + expect(virtualModule?.code).toContain('items') + expect(virtualModule?.code).toContain('key') + expect(virtualModule?.code).toContain('items[key]') + }) + + test('unwraps exported declarations needed by extracted virtual modules', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const code = ` + import { createFileRoute } from '@tanstack/react-router' + import { Hydrate } from '@tanstack/react-start' + import { visible } from '@tanstack/react-start/hydration' + + export const Route = createFileRoute('/test')({ + component: Page, + }) + + export const label = 'Ada' + + export const Widget = () => { + return

{label}

+ } + + function Page() { + return + } + ` + const firstPass = compileHydrate({ + code, + id: file, + root: dir, + env: 'client', + }) + const virtualModule = loadVirtualHydrateModule({ + code, + id: virtualHydrateId(file, firstPass!.boundaries[0]!), + root: dir, + }) + + expect(virtualModule?.code).toContain('const Widget') + expect(virtualModule?.code).toContain('const label') + expect(virtualModule?.code).toContain('') + expect(virtualModule?.code).not.toContain('export const Widget') + expect(virtualModule?.code).not.toContain('createFileRoute') + expect(virtualModule?.code).not.toContain('const Route') + }) + + test('invalidates cached Hydrate source for virtual module loads', () => { + const dir = mkdtempSync(join(tmpdir(), 'hydrate-when-')) + const file = join(dir, 'route.tsx') + const oldCode = ` + import { Hydrate } from '@tanstack/react-start' + import { visible } from '@tanstack/react-start/hydration' + + export function Page() { + return

Old

+ } + ` + const nextCode = oldCode.replace('Old', 'New') + const envName = 'client' + const plugin = createHydrateCompilerPlugin() + const transformed = compileHydrate({ + code: oldCode, + id: file, + root: dir, + env: 'client', + envName, + plugin, + }) + const virtualId = virtualHydrateId(file, transformed!.boundaries[0]!) + + expect( + transformed!.plugin.loadVirtualModule?.({ + id: virtualId, + root: dir, + env: 'client', + envName, + })?.code, + ).toContain('Old') + + transformed!.plugin.invalidateModule?.({ id: file, envName }) + expect(() => + transformed!.plugin.loadVirtualModule?.({ + id: virtualId, + root: dir, + env: 'client', + envName, + }), + ).toThrow(/Missing Hydrate source/) + + const updated = compileHydrate({ + code: nextCode, + id: file, + root: dir, + env: 'client', + envName, + plugin, + }) + + expect( + updated!.plugin.loadVirtualModule?.({ + id: virtualId, + root: dir, + env: 'client', + envName, + })?.code, + ).toContain('New') + }) + + test('rejects virtual module ids whose source hash does not match', () => { + const code = ` + import { Hydrate } from '@tanstack/react-start' + import { idle, visible } from '@tanstack/react-start/hydration' + + export function Page() { + return ( + <> +

First

+

Second

+ + ) + } + ` + const firstPass = compileHydrate({ + code, + id, + root, + env: 'client', + }) + const mismatchedId = virtualHydrateId(id, { + id: withSourceHash(firstPass!.boundaries[0]!.id, 'mismatch'), + index: firstPass!.boundaries[0]!.index, + }) + + expect( + new URLSearchParams(mismatchedId.split('?')[1]).get('tss-hydrate'), + ).toMatch(/_mismatch$/) + expect( + loadVirtualHydrateModule({ code, id: mismatchedId, root }), + ).toBeNull() + }) +}) diff --git a/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenFunctionChild.tsx b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenFunctionChild.tsx new file mode 100644 index 0000000000..a2560a6197 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenFunctionChild.tsx @@ -0,0 +1,6 @@ +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +export function Page() { + return {() =>

child

}
+} diff --git a/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenHookCall.tsx b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenHookCall.tsx new file mode 100644 index 0000000000..1e89bb7303 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenHookCall.tsx @@ -0,0 +1,14 @@ +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +function useThing() { + return 'thing' +} + +export function Page() { + return ( + +

{useThing()}

+
+ ) +} diff --git a/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenSuperCapture.tsx b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenSuperCapture.tsx new file mode 100644 index 0000000000..63b91b0239 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenSuperCapture.tsx @@ -0,0 +1,16 @@ +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +class Base { + title = 'super' +} + +export class Page extends Base { + render() { + return ( + +

{super.title}

+
+ ) + } +} diff --git a/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenThisCapture.tsx b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenThisCapture.tsx new file mode 100644 index 0000000000..5f7b3df606 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/error-files/hydrateWhenThisCapture.tsx @@ -0,0 +1,14 @@ +import { Hydrate } from '@tanstack/react-start' +import { idle } from '@tanstack/react-start/hydration' + +export class Page { + title = 'this' + + render() { + return ( + +

{this.title}

+
+ ) + } +} diff --git a/packages/start-plugin-core/tests/hydrateWhen/hydrateWhen.test.ts b/packages/start-plugin-core/tests/hydrateWhen/hydrateWhen.test.ts new file mode 100644 index 0000000000..2d121539fe --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/hydrateWhen.test.ts @@ -0,0 +1,241 @@ +import { readFile, readdir } from 'node:fs/promises' +import path from 'node:path' +import * as t from '@babel/types' +import { generateFromAst, parseAst } from '@tanstack/router-utils' +import { describe, expect, test } from 'vitest' +import { createHydrateCompilerPlugin } from '../../src/hydrate-when-transform' + +const fixtureRoot = path.resolve(import.meta.dirname, './test-files') +const errorRoot = path.resolve(import.meta.dirname, './error-files') + +function fixtureId(filename: string) { + return path.join(fixtureRoot, filename) +} + +function normalizeSnapshotCode(code: string) { + return code.split(fixtureRoot).join('') +} + +async function readFixture(filename: string) { + return await readFile(fixtureId(filename), 'utf8') +} + +async function getFilenames(dirname: string) { + return (await readdir(dirname)) + .filter((filename) => filename.endsWith('.tsx')) + .sort() +} + +type HydrateBoundary = { + id: string + exportName: string + index: number +} + +function getHydrateBoundariesFromCode(code: string): Array { + const boundaries: Array = [] + const hydrateImportPattern = + /import\("([^"]*[?&]tss-hydrate=[^"]*)"\),\s*"([^"]+)"/g + let match: RegExpExecArray | null + + while ((match = hydrateImportPattern.exec(code))) { + const importId = match[1]! + const queryIndex = importId.indexOf('?') + const params = new URLSearchParams(importId.slice(queryIndex + 1)) + const boundaryId = params.get('tss-hydrate') + const separatorIndex = boundaryId?.indexOf('_') ?? -1 + const index = + boundaryId && separatorIndex > 0 + ? Number.parseInt(boundaryId.slice(0, separatorIndex), 36) + : Number.NaN + + if (boundaryId && Number.isInteger(index)) { + boundaries.push({ + id: boundaryId, + exportName: match[2]!, + index, + }) + } + } + + return boundaries.sort((a, b) => a.index - b.index) +} + +function compile(opts: { + env: 'client' | 'server' + code: string + id: string + root?: string +}) { + const options = { + ...opts, + root: opts.root ?? fixtureRoot, + } + const plugin = createHydrateCompilerPlugin() + const ast = parseAst({ code: options.code, sourceFilename: options.id }) + const result = plugin.transformAst?.({ + ast, + code: options.code, + id: options.id, + root: options.root, + env: options.env, + envName: options.env, + mode: 'dev', + framework: 'react', + providerEnvName: 'ssr', + types: t, + parseExpression: (expressionCode) => t.identifier(expressionCode), + }) + if (!result) return null + + const generated = generateFromAst(ast, { + sourceMaps: true, + sourceFileName: options.id, + filename: options.id, + }) + + return { + code: generated.code, + map: generated.map, + boundaries: getHydrateBoundariesFromCode(generated.code), + } +} + +function loadVirtualHydrateModule(options: { + code: string + id: string + root: string +}) { + return createHydrateCompilerPlugin().loadVirtualModule?.({ + code: options.code, + id: options.id, + root: options.root, + env: 'client', + envName: 'client', + }) +} + +function virtualHydrateId( + file: string, + boundary: Pick, +) { + const params = new URLSearchParams() + params.set('tss-hydrate', boundary.id) + return `${file}?${params.toString()}` +} + +describe('Hydrate compiler transform fixtures', async () => { + const filenames = await getFilenames(fixtureRoot) + + describe.each(filenames)('should handle "%s"', async (filename) => { + const code = await readFixture(filename) + const id = fixtureId(filename) + + test(`should compile ${filename} for client`, async () => { + const result = compile({ env: 'client', code, id }) + + await expect( + normalizeSnapshotCode(result?.code ?? 'no-transform'), + ).toMatchFileSnapshot(`./snapshots/client/${filename}`) + }) + + test(`should compile ${filename} for server`, async () => { + const result = compile({ env: 'server', code, id }) + + await expect( + normalizeSnapshotCode(result?.code ?? 'no-transform'), + ).toMatchFileSnapshot(`./snapshots/server/${filename}`) + }) + }) + + test('should extract virtual modules and keep nested ids stable', async () => { + const filename = 'hydrateWhenNested.tsx' + const code = await readFixture(filename) + const id = fixtureId(filename) + const firstPass = compile({ env: 'client', code, id }) + + expect( + firstPass?.boundaries.map((boundary) => boundary.exportName), + ).toEqual(['H0', 'H2']) + + for (const boundary of firstPass!.boundaries) { + const virtualId = virtualHydrateId(id, boundary) + const loaded = loadVirtualHydrateModule({ + code, + id: virtualId, + root: fixtureRoot, + }) + + await expect( + normalizeSnapshotCode(loaded?.code ?? 'no-virtual-module'), + ).toMatchFileSnapshot( + `./snapshots/virtual/${filename}.${boundary.exportName}.tsx`, + ) + } + + const parentBoundary = firstPass!.boundaries[0]! + const parentVirtualId = virtualHydrateId(id, parentBoundary) + const parentVirtualModule = loadVirtualHydrateModule({ + code, + id: parentVirtualId, + root: fixtureRoot, + }) + const nestedPass = compile({ + code: parentVirtualModule!.code, + id: parentVirtualId, + env: 'client', + }) + + await expect( + normalizeSnapshotCode(nestedPass?.code ?? 'no-transform'), + ).toMatchFileSnapshot(`./snapshots/virtual/${filename}.H0.client.tsx`) + }) +}) + +describe('Hydrate compiler extraction errors', async () => { + const errorCases = [ + { + filename: 'hydrateWhenFunctionChild.tsx', + message: /function-as-children/, + }, + { + filename: 'hydrateWhenHookCall.tsx', + message: /hooks/, + }, + { + filename: 'hydrateWhenThisCapture.tsx', + message: /captures this/, + }, + { + filename: 'hydrateWhenSuperCapture.tsx', + message: /captures super/, + }, + ] as const + + describe.each(errorCases)('$filename', async ({ filename, message }) => { + const code = await readFile(path.join(errorRoot, filename), 'utf8') + const id = path.join(errorRoot, filename) + + test('should reject unsafe client extraction', () => { + expect(() => + compile({ + code, + id, + root: errorRoot, + env: 'client', + }), + ).toThrow(message) + }) + + test('should reject unsafe server extraction', () => { + expect(() => + compile({ + code, + id, + root: errorRoot, + env: 'server', + }), + ).toThrow(message) + }) + }) +}) diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenBasic.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenBasic.tsx new file mode 100644 index 0000000000..c977cd70a2 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenBasic.tsx @@ -0,0 +1,18 @@ +const _H = _lazyRouteComponent(() => import("/hydrateWhenBasic.tsx?tss-hydrate=0_3cf0187f82"), "H0"), + _H0_preload = _H.preload; +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate } from '@tanstack/react-start'; +import { idle, visible } from '@tanstack/react-start/hydration'; +import { FallbackPane } from './widgets'; +export function Page() { + return
+ } h="0_3cf0187f82" p={_H0_preload}> + {<_H />} + +
; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenMultiple.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenMultiple.tsx new file mode 100644 index 0000000000..8a68575d69 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenMultiple.tsx @@ -0,0 +1,19 @@ +const _H3 = _lazyRouteComponent(() => import("/hydrateWhenMultiple.tsx?tss-hydrate=2_21aa371e0f"), "H2"); +const _H2 = _lazyRouteComponent(() => import("/hydrateWhenMultiple.tsx?tss-hydrate=1_21aa371e0f"), "H1"); +const _H = _lazyRouteComponent(() => import("/hydrateWhenMultiple.tsx?tss-hydrate=0_21aa371e0f"), "H0"); +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate } from '@tanstack/react-start'; +import { load, media, visible } from '@tanstack/react-start/hydration'; +export function Page() { + return <> + + {<_H />} + + + {<_H2 />} + + + {<_H3 />} + + ; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNested.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNested.tsx new file mode 100644 index 0000000000..97c3dba1a4 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNested.tsx @@ -0,0 +1,16 @@ +const _H2 = _lazyRouteComponent(() => import("/hydrateWhenNested.tsx?tss-hydrate=2_466696e41d"), "H2"); +const _H = _lazyRouteComponent(() => import("/hydrateWhenNested.tsx?tss-hydrate=0_466696e41d"), "H0"); +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate } from '@tanstack/react-start'; +import { idle, visible } from '@tanstack/react-start/hydration'; +const unused = 'remove me from virtual modules'; +export function Page() { + return <> + + {<_H />} + + + {<_H2 />} + + ; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNever.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNever.tsx new file mode 100644 index 0000000000..426e83fa73 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNever.tsx @@ -0,0 +1,9 @@ +const _H = _lazyRouteComponent(() => import("/hydrateWhenNever.tsx?tss-hydrate=0_b752509d76"), "H0"); +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate } from '@tanstack/react-start'; +import { never } from '@tanstack/react-start/hydration'; +export function Page() { + return + {<_H />} + ; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNoImport.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNoImport.tsx new file mode 100644 index 0000000000..b35c36ab1b --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNoImport.tsx @@ -0,0 +1 @@ +no-transform \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNotFromTanstack.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNotFromTanstack.tsx new file mode 100644 index 0000000000..b35c36ab1b --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenNotFromTanstack.tsx @@ -0,0 +1 @@ +no-transform \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenObjectFallback.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenObjectFallback.tsx new file mode 100644 index 0000000000..1bbe2337d6 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenObjectFallback.tsx @@ -0,0 +1,26 @@ +const _H3 = _lazyRouteComponent(() => import("/hydrateWhenObjectFallback.tsx?tss-hydrate=2_7f4dc3aa80"), "H2"); +const _H2 = _lazyRouteComponent(() => import("/hydrateWhenObjectFallback.tsx?tss-hydrate=1_7f4dc3aa80"), "H1"); +const _H = _lazyRouteComponent(() => import("/hydrateWhenObjectFallback.tsx?tss-hydrate=0_7f4dc3aa80"), "H0"); +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate } from '@tanstack/react-start'; +import { idle, visible } from '@tanstack/react-start/hydration'; +const spreadProps = { + when: visible(), + fallback:
Bound
+}; +export function Page() { + return <> + Direct} h="0_7f4dc3aa80"> + {<_H />} + + Inline + }} h="1_7f4dc3aa80"> + {<_H2 />} + + + {<_H3 />} + + ; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenPrefetchState.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenPrefetchState.tsx new file mode 100644 index 0000000000..9961cdc3c9 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenPrefetchState.tsx @@ -0,0 +1,19 @@ +const _H = _lazyRouteComponent(() => import("/hydrateWhenPrefetchState.tsx?tss-hydrate=0_24b5f958eb"), "H0"), + _H0_preload = _H.preload; +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { useState } from 'react'; +import { Hydrate } from '@tanstack/react-start'; +import { interaction } from '@tanstack/react-start/hydration'; +export function Page() { + const [status, setStatus] = useState('idle'); + const [, setUnusedStatus] = useState('idle'); + return
+

{status}

+ { + setStatus('prefetched'); + setUnusedStatus('prefetched'); + }} h="0_24b5f958eb" p={_H0_preload}> + {<_H />} + +
; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenRenamed.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenRenamed.tsx new file mode 100644 index 0000000000..9c24d8cbd3 --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenRenamed.tsx @@ -0,0 +1,11 @@ +const _H = _lazyRouteComponent(() => import("/hydrateWhenRenamed.tsx?tss-hydrate=0_f555ef3ac2"), "H0"); +import { lazyRouteComponent as _lazyRouteComponent } from "@tanstack/react-router"; +import { Hydrate as HW } from '@tanstack/react-start'; +import { interaction } from '@tanstack/react-start/hydration'; +export function Page() { + return + {<_H />} + ; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalse.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalse.tsx new file mode 100644 index 0000000000..b35c36ab1b --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalse.tsx @@ -0,0 +1 @@ +no-transform \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalseFunctionChild.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalseFunctionChild.tsx new file mode 100644 index 0000000000..b35c36ab1b --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenSplitFalseFunctionChild.tsx @@ -0,0 +1 @@ +no-transform \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenWrongImportName.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenWrongImportName.tsx new file mode 100644 index 0000000000..b35c36ab1b --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/client/hydrateWhenWrongImportName.tsx @@ -0,0 +1 @@ +no-transform \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenBasic.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenBasic.tsx new file mode 100644 index 0000000000..8bcf4099ca --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenBasic.tsx @@ -0,0 +1,17 @@ +import { Hydrate } from '@tanstack/react-start'; +import { idle, visible } from '@tanstack/react-start/hydration'; +import { Chart } from './widgets'; +import { formatValue } from './format'; +const chartTitle = formatValue('Revenue'); +export function Page() { + return
+ + + +
; +} \ No newline at end of file diff --git a/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenMultiple.tsx b/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenMultiple.tsx new file mode 100644 index 0000000000..6959b25b3e --- /dev/null +++ b/packages/start-plugin-core/tests/hydrateWhen/snapshots/server/hydrateWhenMultiple.tsx @@ -0,0 +1,24 @@ +import { Hydrate } from '@tanstack/react-start'; +import { load, media, visible } from '@tanstack/react-start/hydration'; +function Summary() { + return
Summary
; +} +function Comments() { + return
Comments
; +} +function Footer() { + return
Footer
; +} +export function Page() { + return <> + + + + + + + +