@bleedingdev/modern-js-plugin-tanstack 3.9.0-ultramodern.10 → 3.9.0-ultramodern.12

package/src/cli/tanstackTypes/source.ts

@@ -1,25 +1,22 @@
 // @effect-diagnostics asyncFunction:off strictBooleanExpressions:off
 
-import type {
-  AppNormalizedConfig,
-  AppTools,
-  AppToolsContext,
-} from '@modern-js/app-tools';
-import { canonicaliseLocalisedRoutes } from '@modern-js/i18n-runtime-extensions';
+import type { AppToolsContext } from '@modern-js/app-tools';
 import { makeLegalIdentifier } from '@modern-js/runtime/cli';
 import type { NestedRouteForCli, PageRoute } from '@modern-js/types';
 import { upath as path } from '@modern-js/utils';
 
+import {
+  describeRouteTree,
+  type RouteDescriptor,
+} from '../../shared/routeDescriptor';
+
 import {
   createRouteStaticDataSnippet,
-  isIndexRoute,
-  isPathlessLayout,
   normalizeRelativeImport,
   pickModernLoaderModule,
   pickRouteSearchContractModules,
   quote,
   resolveFileNoExt,
-  toTanstackPath,
 } from './shared';
 
 type RouteForCli = NestedRouteForCli | PageRoute;
@@ -46,22 +43,15 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
     appContext,
     entryName,
     generatedDirName = 'modern-tanstack',
-    routes: rawRoutes,
+    routes,
   } = opts;
-  const routes: RouteForCli[] = canonicaliseLocalisedRoutes(rawRoutes);
   const outDir = path.join(
     appContext.srcDirectory,
     generatedDirName,
     entryName,
   );
 
-  const rootModern = routes.find(r => {
-    const extras = r as RouteExtras;
-    return r && extras.type === 'nested' && extras.isRoot;
-  }) as NestedRouteForCli | undefined;
-
-  const rootExtras = rootModern as RouteExtras | undefined;
-  const topLevel = rootModern ? rootExtras?.children || [] : routes;
+  const { root: rootModern, children: topLevel } = describeRouteTree(routes);
 
   const imports: string[] = [];
   const statements: string[] = [];
@@ -92,15 +82,11 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
         // value carries the internal `@_modern_js_src` alias, which the app's
         // tsconfig does not map — the generated file must use relative
         // imports.
-        const resolvedNoExt = await resolveRouteModuleNoExt(componentPath);
-        if (!resolvedNoExt) {
+        const relImport = await resolveRouteImport(componentPath);
+        if (!relImport) {
           return null;
         }
 
-        const relImport = normalizeRelativeImport(
-          path.relative(outDir, resolvedNoExt),
-        );
-
         const componentName = `component_${componentIndex++}`;
         imports.push(`import ${componentName} from ${quote(relImport)};`);
         return componentName;
@@ -111,7 +97,7 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
     return pendingImportName;
   };
 
-  const resolveRouteModuleNoExt = async (aliasedNoExtPath: string) => {
+  const resolveRouteImport = async (aliasedNoExtPath: string) => {
     const prefix = `${appContext.internalSrcAlias}/`;
     let absNoExt: string;
     if (aliasedNoExtPath.startsWith(prefix)) {
@@ -124,7 +110,10 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
       absNoExt = path.join(appContext.srcDirectory, aliasedNoExtPath);
     }
 
-    return resolveFileNoExt(absNoExt);
+    const resolvedNoExt = await resolveFileNoExt(absNoExt);
+    return resolvedNoExt
+      ? normalizeRelativeImport(path.relative(outDir, resolvedNoExt))
+      : null;
   };
 
   const getImportNamesForLoader = async (
@@ -143,15 +132,11 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
       };
     }
 
-    const resolvedNoExt = await resolveRouteModuleNoExt(aliasedNoExtPath);
-    if (!resolvedNoExt) {
+    const relImport = await resolveRouteImport(aliasedNoExtPath);
+    if (!relImport) {
       return null;
     }
 
-    const relImport = normalizeRelativeImport(
-      path.relative(outDir, resolvedNoExt),
-    );
-
     const importName = `loader_${loaderIndex++}`;
     const actionName = hasAction
       ? importName.replace(/^loader_/, 'action_')
@@ -182,14 +167,10 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
       return existing;
     }
 
-    const resolvedNoExt = await resolveRouteModuleNoExt(aliasedNoExtPath);
-    if (!resolvedNoExt) {
+    const relImport = await resolveRouteImport(aliasedNoExtPath);
+    if (!relImport) {
       return null;
     }
-
-    const relImport = normalizeRelativeImport(
-      path.relative(outDir, resolvedNoExt),
-    );
     const importName =
       exportName === 'validateSearch'
         ? `validateSearch_${validateSearchIndex++}`
@@ -217,15 +198,8 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
     return reserveRouteVarName(`route_${base}`);
   };
 
-  const buildRoute = async (opts: {
-    parentVar: string;
-    route: NestedRouteForCli | PageRoute;
-  }): Promise<string> => {
-    const { parentVar, route } = opts;
-
-    const varName = createRouteVarName(route);
+  const createRouteOptions = async (route: RouteForCli, hasSplat: boolean) => {
     const routeExtras = route as RouteExtras;
-
     const loaderInfo = pickModernLoaderModule(route);
     const routeAction = routeExtras.action;
     const loaderImports = loaderInfo
@@ -251,10 +225,7 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
         )
       : null;
 
-    const rawPath = routeExtras.path;
-    const hasSplat = typeof rawPath === 'string' && rawPath.includes('*');
-
-    const routeOpts: string[] = [`getParentRoute: () => ${parentVar},`];
+    const routeOpts: string[] = [];
 
     const componentName = await getImportNameForComponent(
       routeExtras._component,
@@ -263,14 +234,6 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
       routeOpts.push(`component: ${componentName},`);
     }
 
-    if (isPathlessLayout(route)) {
-      const id = routeExtras.id;
-      routeOpts.push(`id: ${quote(id || 'pathless')},`);
-    } else {
-      const p = isIndexRoute(route) ? '/' : toTanstackPath(rawPath || '');
-      routeOpts.push(`path: ${quote(p)},`);
-    }
-
     if (loaderName) {
       routeOpts.push(
         `loader: modernLoaderToTanstack({ hasSplat: ${hasSplat} }, ${loaderName}),`,
@@ -292,7 +255,22 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
       routeOpts.push(staticDataSnippet);
     }
 
-    const children = routeExtras.children;
+    return routeOpts;
+  };
+
+  const buildRoute = async (
+    descriptor: RouteDescriptor<RouteForCli>,
+    parentVar: string,
+  ): Promise<string> => {
+    const { source: route, location, hasSplat, children } = descriptor;
+    const varName = createRouteVarName(route);
+    const routeOpts = [
+      `getParentRoute: () => ${parentVar},`,
+      ...Object.entries(location).map(
+        ([key, value]) => `${key}: ${quote(value)},`,
+      ),
+      ...(await createRouteOptions(route, hasSplat)),
+    ];
     const hasChildren = Boolean(children && children.length > 0);
     const routeCtorVarName = hasChildren
       ? reserveRouteVarName(`${varName}__base`)
@@ -305,9 +283,7 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
     if (children && children.length > 0) {
       const childVars: string[] = [];
       for (const child of children) {
-        childVars.push(
-          await buildRoute({ parentVar: routeCtorVarName, route: child }),
-        );
+        childVars.push(await buildRoute(child, routeCtorVarName));
       }
       statements.push(
         `const ${varName} = ${routeCtorVarName}.addChildren([${childVars.join(', ')}]);`,
@@ -317,60 +293,14 @@ export async function generateTanstackRouterTypesSourceForEntry(opts: {
     return varName;
   };
 
-  const rootLoaderInfo = rootModern ? pickModernLoaderModule(rootModern) : null;
-  const rootAction = rootExtras?.action;
-  const rootLoaderImports = rootLoaderInfo?.loaderPath
-    ? await getImportNamesForLoader(
-        rootLoaderInfo.loaderPath,
-        rootLoaderInfo.inline,
-        Boolean(
-          rootLoaderInfo.inline && rootAction === rootLoaderInfo.loaderPath,
-        ),
-      )
-    : null;
-  const rootLoaderName = rootLoaderImports?.loaderName || null;
-  const rootActionName = rootLoaderImports?.actionName || null;
-  const rootSearchContractInfo = rootModern
-    ? pickRouteSearchContractModules(rootModern)
-    : null;
-  const rootValidateSearchName = rootSearchContractInfo?.validateSearchPath
-    ? await getImportNameForSearchContract(
-        rootSearchContractInfo.validateSearchPath,
-        'validateSearch',
-      )
-    : null;
-  const rootLoaderDepsName = rootSearchContractInfo?.loaderDepsPath
-    ? await getImportNameForSearchContract(
-        rootSearchContractInfo.loaderDepsPath,
-        'loaderDeps',
-      )
-    : null;
-
   const topLevelVars: string[] = [];
   for (const route of topLevel) {
-    topLevelVars.push(await buildRoute({ parentVar: 'rootRoute', route }));
+    topLevelVars.push(await buildRoute(route, 'rootRoute'));
   }
 
-  const rootOpts: string[] = [];
-
-  const rootComponentName = await getImportNameForComponent(
-    rootExtras?._component,
-  );
-  if (rootComponentName) {
-    rootOpts.push(`component: ${rootComponentName},`);
-  }
-
-  if (rootLoaderName) {
-    rootOpts.push(
-      `loader: modernLoaderToTanstack({ hasSplat: false }, ${rootLoaderName}),`,
-    );
-  }
-  if (rootValidateSearchName) {
-    rootOpts.push(`validateSearch: ${rootValidateSearchName},`);
-  }
-  if (rootLoaderDepsName) {
-    rootOpts.push(`loaderDeps: ${rootLoaderDepsName},`);
-  }
+  const rootOpts = rootModern
+    ? await createRouteOptions(rootModern, false)
+    : [];
 
   const routerGenTs = `// This file is auto-generated by Modern.js. Do not edit manually.
 
@@ -388,13 +318,7 @@ ${imports.join('\n')}
 
 export const rootRoute = createRootRouteWithContext<ModernRouterContext>()({
   ${rootOpts.join('\n  ')}
-  ${
-    createRouteStaticDataSnippet({
-      modernRouteId: rootExtras?.id,
-      loaderName: rootLoaderName,
-      actionName: rootActionName,
-    }) || ''
-  }
+
 });
 
 ${statements.join('\n\n')}

package/src/runtime/lifecycle.ts

@@ -19,7 +19,6 @@ export type RouterLifecycleContext = NativeRouterLifecycleContext & {
 export {
   applyRouterRuntimeState,
   applyRouterServerPrepareResult,
-  createRouterRuntimeState,
   createRouterServerSnapshot,
   getRouterRuntimeState,
   getRouterServerSnapshot,

package/src/runtime/loaderBridge.ts

@@ -98,15 +98,15 @@ type LoaderLikeContext = {
   params?: Record<string, string>;
 };
 
-function getLoaderSignal(ctx: LoaderLikeContext | undefined): AbortSignal {
-  const abortSignal = ctx?.abortController?.signal;
-  if (abortSignal instanceof AbortSignal) {
-    return abortSignal;
-  }
-  if (ctx?.signal instanceof AbortSignal) {
-    return ctx.signal;
-  }
-  return new AbortController().signal;
+export function getLoaderSignal(
+  ctx: LoaderLikeContext | undefined,
+): AbortSignal {
+  const matchSignal = ctx?.abortController?.signal ?? ctx?.signal;
+  const requestSignal = ctx?.context?.request?.signal;
+  const signals = [matchSignal, requestSignal].filter(
+    (signal): signal is AbortSignal => signal instanceof AbortSignal,
+  );
+  return AbortSignal.any(signals);
 }
 
 export function getLoaderHref(ctx: LoaderLikeContext | undefined): string {

package/src/runtime/navigation.ts

@@ -0,0 +1,78 @@
+import type {
+  RouterNavigationCapability,
+  RouterNavigationSnapshot,
+} from '@modern-js/runtime-extensions/router-state';
+import type { AnyRouter } from '@tanstack/react-router';
+import { Link } from './prefetchLink';
+
+/** Native TanStack navigation, exposed through the provider contract. */
+export function createTanstackNavigation(
+  router: AnyRouter,
+): RouterNavigationCapability {
+  let location: AnyRouter['state']['location'] | undefined;
+  let matches: AnyRouter['state']['matches'] | undefined;
+  let snapshot: RouterNavigationSnapshot;
+  return {
+    Link: Link as RouterNavigationCapability['Link'],
+    getSnapshot() {
+      const state = router.state;
+      if (
+        location !== state.location ||
+        matches === undefined ||
+        matches.length !== state.matches.length ||
+        matches.some(
+          (match, index) => match.params !== state.matches[index]?.params,
+        )
+      ) {
+        location = state.location;
+        matches = state.matches;
+        snapshot = {
+          location: {
+            pathname: location.pathname,
+            search: location.searchStr,
+            hash:
+              location.hash !== '' ? `#${location.hash.replace(/^#/, '')}` : '',
+          },
+          params: Object.assign({}, ...matches.map(match => match.params)),
+        };
+      }
+      return snapshot;
+    },
+    subscribe(listener) {
+      const stops = (
+        ['onBeforeNavigate', 'onBeforeLoad', 'onLoad', 'onResolved'] as const
+      ).map(event => router.subscribe(event, listener));
+      return () => {
+        for (const stop of stops) stop();
+      };
+    },
+    navigate(href, options) {
+      return router.navigate({
+        to: href,
+        replace: options?.replace,
+        ...(options?.state === undefined
+          ? {}
+          : { state: options.state as never }),
+      });
+    },
+    createLinkProps(target) {
+      const preload =
+        target.preload !== undefined
+          ? target.preload
+          : target.prefetch === 'none'
+            ? false
+            : target.prefetch;
+      return {
+        to: target.pathname,
+        ...(target.search !== undefined ? { search: target.search } : {}),
+        ...(target.hash !== undefined && target.hash !== ''
+          ? { hash: target.hash }
+          : {}),
+        ...(target.hashScrollIntoView === undefined
+          ? {}
+          : { hashScrollIntoView: target.hashScrollIntoView }),
+        ...(preload === undefined ? {} : { preload }),
+      };
+    },
+  };
+}

package/src/runtime/plugin.node.tsx

@@ -23,11 +23,13 @@ import { createModernBasepathRewrite } from './basepathRewrite';
 import { routerProviderRegistryHooks } from './hooks';
 import { wrapTanstackSsrHydrationBoundary } from './hydrationBoundary';
 import {
+  applyRouterRuntimeState,
   applyRouterServerPrepareResult,
-  createRouterServerSnapshot,
   getRouterRuntimeState,
+  getRouterServerSnapshot,
   type RouterLifecycleContext,
 } from './lifecycle';
+import { createTanstackNavigation } from './navigation';
 import {
   createTanstackRouteObjects,
   getTanstackRouteConfig,
@@ -168,116 +170,136 @@ export const tanstackRouterPlugin = (
           setTanstackRscRouter(serverRouter);
         }
 
-        await attachServerSsrUtils(serverRouter);
-
-        const end = time();
-
+        let disposed = false;
+        let prepared = false;
+        const onAbort = () => controller.abort(rawRequest.signal.reason);
+        const cleanup = () => {
+          if (disposed) return;
+          disposed = true;
+          rawRequest.signal.removeEventListener('abort', onAbort);
+          controller.abort();
+          serverRouter.serverSsr?.cleanup?.();
+        };
+        // Acquire the disposer before attachment: every subsequent failure,
+        // including partial attachment, has an owner. Successful preparation
+        // leaves disposal to the response lifetime in the SSR pipeline.
+        applyRouterRuntimeState(context, {
+          framework: 'tanstack',
+          basename: _basename,
+          instance: serverRouter,
+          cleanup,
+        });
+        rawRequest.signal.addEventListener('abort', onAbort, { once: true });
         try {
-          await tanstackRouter.load({ sync: true });
-        } finally {
-          const cost = end();
-          context.ssrContext?.onTiming?.(LOADER_REPORTER_NAME, cost);
-        }
+          rawRequest.signal.throwIfAborted();
+          await attachServerSsrUtils(serverRouter);
+          rawRequest.signal.throwIfAborted();
+
+          const end = time();
 
-        const serverLoadResult = serverRouter._serverResult;
-        if (!serverLoadResult) {
           try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-          throw new Error(
-            'TanStack Router completed an SSR load without a server result.',
-          );
-        }
+            await tanstackRouter.load({ sync: true });
+          } finally {
+            const cost = end();
+            context.ssrContext?.onTiming?.(LOADER_REPORTER_NAME, cost);
+          }
 
-        if (serverLoadResult.type === 'redirect') {
-          const { redirect } = serverLoadResult;
+          rawRequest.signal.throwIfAborted();
+          const serverLoadResult = serverRouter._serverResult;
+          if (!serverLoadResult) {
+            throw new Error(
+              'TanStack Router completed an SSR load without a server result.',
+            );
+          }
 
-          try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-
-          return interrupt(
-            isRSCNavigation
-              ? handleTanstackRscRedirect(
-                  redirect.headers,
-                  _basename,
-                  redirect.status,
-                )
-              : redirect,
-          );
-        }
+          if (serverLoadResult.type === 'redirect') {
+            const { redirect } = serverLoadResult;
+
+            return interrupt(
+              isRSCNavigation
+                ? handleTanstackRscRedirect(
+                    redirect.headers,
+                    _basename,
+                    redirect.status,
+                  )
+                : redirect,
+            );
+          }
+
+          const routerErrors = collectRouterErrors(tanstackRouter);
+          if (routerErrors && loaderFailureMode === 'clientRender') {
+            (
+              context.ssrContext?.response as
+                | { status: (code: number) => void }
+                | undefined
+            )?.status(200);
+            throw Object.values(routerErrors)[0];
+          }
+
+          await preloadMatchedRouteComponents(serverRouter);
 
-        const routerErrors = collectRouterErrors(tanstackRouter);
-        if (routerErrors && loaderFailureMode === 'clientRender') {
           (
             context.ssrContext?.response as
               | { status: (code: number) => void }
               | undefined
-          )?.status(200);
-          try {
-            serverRouter.serverSsr?.cleanup?.();
-          } catch {}
-          throw Object.values(routerErrors)[0];
-        }
-
-        await preloadMatchedRouteComponents(serverRouter);
+          )?.status(serverLoadResult.status);
 
-        (
-          context.ssrContext?.response as
-            | { status: (code: number) => void }
-            | undefined
-        )?.status(serverLoadResult.status);
+          await serverRouter.serverSsr?.dehydrate?.();
 
-        await serverRouter.serverSsr?.dehydrate?.();
+          if (enableRsc) {
+            if (isRSCNavigation) {
+              // RSC navigations consume the server payload directly. Normal HTML SSR
+              // emits the buffered bootstrap script below and must not wait here
+              // because Modern's non-streaming hook has not rendered the app yet.
+              await waitForRouterSerialization(serverRouter);
+            }
 
-        if (enableRsc) {
-          if (isRSCNavigation) {
-            // RSC navigations consume the server payload directly. Normal HTML SSR
-            // emits the buffered bootstrap script below and must not wait here
-            // because Modern's non-streaming hook has not rendered the app yet.
-            await waitForRouterSerialization(serverRouter);
+            setTanstackRscServerPayload(
+              createTanstackRscServerPayload(serverRouter, {
+                omitClientLoaderData: isRSCNavigation,
+              }),
+            );
           }
 
-          setTanstackRscServerPayload(
-            createTanstackRscServerPayload(serverRouter, {
-              omitClientLoaderData: isRSCNavigation,
-            }),
-          );
-        }
-
-        const ssrScriptTags = serverRouter.serverSsr?.takeBufferedScripts?.();
-        const hydrationScripts = routerManagedTagsToHtml(ssrScriptTags);
-        const matchedRouteIds = getModernRouteIdsFromMatches(serverRouter);
-        const routerServerSnapshot: InternalRouterServerSnapshot =
-          createRouterServerSnapshot({
+          const ssrScriptTags = serverRouter.serverSsr?.takeBufferedScripts?.();
+          const hydrationScripts = routerManagedTagsToHtml(ssrScriptTags);
+          const matchedRouteIds = getModernRouteIdsFromMatches(serverRouter);
+          const routerServerSnapshot: InternalRouterServerSnapshot = {
             framework: 'tanstack',
             basename: _basename,
             statusCode: serverLoadResult.status,
             errors: routerErrors,
             matchedRouteIds,
             hydrationScripts,
-          });
-        const runtimeContext = applyRouterServerPrepareResult(
-          context as TInternalRuntimeContext,
-          {
-            snapshot: routerServerSnapshot,
-            cleanup: () => serverRouter.serverSsr?.cleanup?.(),
-            state: {
-              framework: 'tanstack',
-              basename: _basename,
-              instance: serverRouter,
-              hydrationScripts,
-              matchedRouteIds,
-              serverSnapshot: routerServerSnapshot,
+          };
+          const runtimeContext = applyRouterServerPrepareResult(
+            context as TInternalRuntimeContext,
+            {
+              snapshot: routerServerSnapshot,
+              cleanup,
+              state: {
+                framework: 'tanstack',
+                basename: _basename,
+                instance: serverRouter,
+                navigation: createTanstackNavigation(tanstackRouter),
+              },
             },
-          },
-        );
-        hooks.onAfterCreateRouter.call({
-          ...routerLifecycleContext,
-          router: serverRouter,
-          serverSnapshot: routerServerSnapshot,
-          runtimeContext,
-        });
+          );
+          rawRequest.signal.throwIfAborted();
+          hooks.onAfterCreateRouter.call({
+            ...routerLifecycleContext,
+            router: serverRouter,
+            serverSnapshot: getRouterServerSnapshot(runtimeContext),
+            runtimeContext,
+          });
+          prepared = true;
+        } finally {
+          if (!prepared) {
+            try {
+              cleanup();
+            } catch {}
+          }
+        }
       });
 
       api.wrapRoot(App => {

package/src/runtime/plugin.tsx

@@ -32,6 +32,7 @@ import {
   applyRouterRuntimeState,
   type RouterLifecycleContext,
 } from './lifecycle';
+import { createTanstackNavigation } from './navigation';
 import {
   createTanstackRouteObjects,
   getMergedRouterConfig,
@@ -259,10 +260,15 @@ export const tanstackRouterPlugin = (
           if (!router) {
             return App ? <App /> : null;
           }
+          const navigation = useMemo(
+            () => createTanstackNavigation(router),
+            [router],
+          );
           const runtimeState = applyRouterRuntimeState(runtimeContext, {
             framework: 'tanstack',
             basename: _basename,
             instance: router,
+            navigation,
           });
           const lifecycleContext: RouterLifecycleContext = {
             framework: 'tanstack',