@bleedingdev/modern-js-plugin-tanstack 3.9.0-ultramodern.9 → 3.9.3-ultramodern.1

package/src/cli/routeMetadata.ts

@@ -0,0 +1,121 @@
+// @effect-diagnostics asyncFunction:off nodeBuiltinImport:off
+import { readdir } from 'node:fs/promises';
+import path from 'node:path';
+
+export const ROUTE_META_FILE_NAME = 'route.meta.ts';
+export const ROUTE_METADATA_MANIFEST_FILE_NAME =
+  'ultramodern-route-metadata.ts';
+
+export const ROUTE_METADATA_MANIFEST_HEADER = `// @generated by @modern-js/plugin-tanstack from ${ROUTE_META_FILE_NAME} files. Run routes-generate; do not edit.`;
+
+// The manifest is emitted formatted (oxfmt/Prettier style: print width 120,
+// single quotes, trailing commas) and is generated output, so formatters
+// ignore it like router.gen.ts; no formatter pass is needed to keep it stable.
+const PRINT_WIDTH = 120;
+
+const MANIFEST_BODY = `export const ultramodernLocalisedUrls = Object.fromEntries(
+  ultramodernRouteMetadata
+    .filter((route: { canonicalPath: string }) => route.canonicalPath !== '/')
+    .map((route) => [route.canonicalPath, route.localisedPaths]),
+);
+export const ultramodernPublicRoutes = ultramodernRouteMetadata
+  .filter((route) => route.public && route.indexable)
+  .map((route) => ({
+    canonicalPath: route.canonicalPath,
+    descriptionKey: route.descriptionKey,
+    id: route.id,
+    localisedPaths: route.localisedPaths,
+    namespace: route.namespace,
+    ownerAppId: route.ownerAppId,
+    titleKey: route.titleKey,
+    ...('jsonLd' in route ? { jsonLd: route.jsonLd } : {}),
+  }));
+export const ultramodernRouteConfig = {
+  authoring: 'colocated-route-meta',
+  generatedManifest: true,
+  localisedUrls: ultramodernLocalisedUrls,
+  namespace: ultramodernRouteNamespace,
+  publicRoutes: ultramodernPublicRoutes,
+  routes: ultramodernRouteMetadata,
+  source: 'route-owned',
+} as const;
+`;
+
+const compareCodeUnits = (left: string, right: string) =>
+  left < right ? -1 : left > right ? 1 : 0;
+
+const quoteSpecifier = (specifier: string) =>
+  specifier.includes("'") ? JSON.stringify(specifier) : `'${specifier}'`;
+
+/**
+ * Renders the route metadata manifest for the `route.meta.ts` files of one
+ * routes directory. Each path is relative to that directory (either separator).
+ * Every `route.meta.ts` must export `routeMeta`; the manifest imports it
+ * statically, so the metadata is never evaluated while generating. Returns
+ * `null` when there are no route metadata files. Output depends only on the
+ * set of paths, never on their order or on the file system.
+ */
+export function renderRouteMetadataManifest(
+  routeMetaFiles: readonly string[],
+): string | null {
+  const specifiers = routeMetaFiles
+    .map(file => `./${file.replaceAll('\\', '/').replace(/\.ts$/u, '')}`)
+    .sort(compareCodeUnits);
+  if (specifiers.length === 0) {
+    return null;
+  }
+  const bindings = specifiers.map((_, index) => `route${index}`);
+  const imports = specifiers.map(
+    (specifier, index) =>
+      `import { routeMeta as ${bindings[index]} } from ${quoteSpecifier(specifier)};`,
+  );
+  const inlineRoutes = `export const ultramodernRouteMetadata = [${bindings.join(', ')}] as const;`;
+  const routes =
+    inlineRoutes.length <= PRINT_WIDTH
+      ? inlineRoutes
+      : `export const ultramodernRouteMetadata = [\n${bindings
+          .map(binding => `  ${binding},\n`)
+          .join('')}] as const;`;
+
+  return `${ROUTE_METADATA_MANIFEST_HEADER}
+${imports.join('\n')}
+
+export const ultramodernRouteNamespace = route0.namespace;
+${routes}
+${MANIFEST_BODY}`;
+}
+
+/**
+ * Lists the `route.meta.ts` files below `routesDirectory`, relative to it.
+ * Symbolic links are not followed: linked metadata belongs to the tree it
+ * lives in. A missing directory has no route metadata.
+ */
+export async function findRouteMetaFiles(
+  routesDirectory: string,
+): Promise<string[]> {
+  const files: string[] = [];
+  const visit = async (relativeDirectory: string): Promise<void> => {
+    const entries = await readdir(
+      path.join(routesDirectory, relativeDirectory),
+      { withFileTypes: true },
+    );
+    for (const entry of entries) {
+      const relativePath = path.join(relativeDirectory, entry.name);
+      if (entry.isDirectory()) {
+        await visit(relativePath);
+      } else if (entry.isFile() && entry.name === ROUTE_META_FILE_NAME) {
+        files.push(relativePath);
+      }
+    }
+  };
+  try {
+    await visit('');
+  } catch (error) {
+    const { code, path: missingPath } = error as NodeJS.ErrnoException;
+    if (code === 'ENOENT' && missingPath === routesDirectory) {
+      return [];
+    }
+    throw error;
+  }
+  return files;
+}

package/src/cli/rscRouteLayer.ts

@@ -0,0 +1,93 @@
+// @effect-diagnostics nodeBuiltinImport:off
+// Rsbuild invokes this compiler hook synchronously with native filesystem paths.
+import path from 'node:path';
+import type { AppNormalizedConfig } from '@modern-js/app-tools/cli-config';
+
+type BuilderPlugin = NonNullable<AppNormalizedConfig['builderPlugins']>[number];
+type ModifyRspackConfig = Extract<
+  NonNullable<AppNormalizedConfig['tools']['rspack']>,
+  (...args: never[]) => unknown
+>;
+
+export const TANSTACK_SERVER_ROUTES_FILE = 'tanstack-routes.server.js';
+
+type RouteLayerContext = {
+  entryNames: readonly string[];
+  internalDirectory: string;
+  rsc: AppNormalizedConfig['server']['rsc'];
+};
+
+function exactResource(...filenames: string[]) {
+  const escaped = filenames.map(filename =>
+    filename.replace(/[.*+?^${}()|[\]\\]/gu, '\\$&'),
+  );
+  return new RegExp(`^(?:${escaped.join('|')})(?:\\?.*)?$`, 'u');
+}
+
+/** The HTML router consumes executable components, while route data stays in Flight. */
+export function createTanstackRscRouteLayerPlugin(
+  getContext: () => RouteLayerContext,
+): BuilderPlugin {
+  return {
+    name: 'modern:tanstack:rsc-route-layer',
+    setup(api) {
+      api.modifyRspackConfig({
+        order: 'post',
+        handler(
+          config: Parameters<ModifyRspackConfig>[0],
+          { environment, rspack, target }: Parameters<ModifyRspackConfig>[1],
+        ) {
+          const { entryNames, internalDirectory, rsc } = getContext();
+          if (rsc === false || rsc === undefined || entryNames.length === 0) {
+            return;
+          }
+          const rscServerEnvironment =
+            typeof rsc === 'object'
+              ? (rsc.environments?.server ?? 'server')
+              : 'server';
+          if (
+            target !== 'node' &&
+            config.target !== 'node' &&
+            environment.name !== rscServerEnvironment
+          ) {
+            return;
+          }
+
+          config.module ??= {};
+          config.module.rules ??= [];
+          config.plugins ??= [];
+          for (const entryName of entryNames) {
+            const routes = path.resolve(
+              internalDirectory,
+              entryName,
+              'routes.js',
+            );
+            const serverRoutes = path.resolve(
+              internalDirectory,
+              entryName,
+              TANSTACK_SERVER_ROUTES_FILE,
+            );
+            // runtime-global-context.js imports the browser route table in both
+            // compilers. Select the complete, loader-isolated table for HTML.
+            config.plugins.push(
+              new rspack.NormalModuleReplacementPlugin(
+                exactResource(routes),
+                serverRoutes,
+              ),
+            );
+            // Match both names: native replacement can occur after Rspack has
+            // already selected rules and a layer for the original request.
+            // Avoid inheriting an RSC issuer's layer. Native use-server-entry
+            // processing returns client references in that layer, which ReactDOM
+            // must never invoke. Isolated __rsc_route_data__ retains its native
+            // explicit react-server-components rule and Flight serialization.
+            config.module.rules.push({
+              resource: exactResource(routes, serverRoutes),
+              layer: 'server-side-rendering',
+            });
+          }
+        },
+      });
+    },
+  };
+}

package/src/cli/tanstackTypes/canonicalRoutes.ts

@@ -1,7 +1,10 @@
 // @effect-diagnostics asyncFunction:off strictBooleanExpressions:off
 
 import type { NestedRouteForCli, PageRoute } from '@modern-js/types';
-import { MAIN_ENTRY_NAME } from '@modern-js/utils';
+import {
+  describeRouteTree,
+  type RouteDescriptor,
+} from '../../shared/routeDescriptor';
 
 import { toTanstackPath } from './shared';
 
@@ -16,6 +19,7 @@ const LOCALE_PARAM_SEGMENTS = new Set([
 
 type CanonicalAwareRoute = (NestedRouteForCli | PageRoute) & {
   modernCanonicalPath?: string;
+  modernLocalisedRoute?: { canonicalPath: string };
   index?: boolean;
   isRoot?: boolean;
   children?: CanonicalAwareRoute[];
@@ -101,12 +105,18 @@ export function collectCanonicalRoutesForEntry(
     }
   };
 
-  const visit = (route: CanonicalAwareRoute, parentPath: string) => {
+  const visit = (
+    descriptor: RouteDescriptor<CanonicalAwareRoute>,
+    parentPath: string,
+  ) => {
+    const { source: route, children } = descriptor;
     let currentPath = parentPath;
 
-    if (typeof route.modernCanonicalPath === 'string') {
+    const canonicalPath =
+      route.modernLocalisedRoute?.canonicalPath ?? route.modernCanonicalPath;
+    if (typeof canonicalPath === 'string') {
       hasI18nSurface = true;
-      currentPath = normalizeJoined(route.modernCanonicalPath);
+      currentPath = canonicalPath ? normalizeJoined(canonicalPath) : '';
     } else if (typeof route.path === 'string' && route.path.length > 0) {
       const segments = route.path
         .replace(/\[(.+?)\]/g, ':$1')
@@ -125,7 +135,6 @@ export function collectCanonicalRoutesForEntry(
         : parentPath;
     }
 
-    const children = route.children;
     if (children && children.length > 0) {
       for (const child of children) {
         visit(child, currentPath);
@@ -137,13 +146,9 @@ export function collectCanonicalRoutesForEntry(
     record(currentPath || '/');
   };
 
-  const rootModern = routes.find(
-    route => (route as CanonicalAwareRoute).isRoot,
-  ) as CanonicalAwareRoute | undefined;
-  const topLevel = rootModern ? (rootModern.children ?? []) : routes;
-
-  for (const route of topLevel) {
-    visit(route as CanonicalAwareRoute, '');
+  for (const route of describeRouteTree(routes as CanonicalAwareRoute[])
+    .children) {
+    visit(route, '');
   }
 
   if (!hasI18nSurface || canonicalParams.size === 0) {

package/src/cli/tanstackTypes/shared.ts

@@ -71,20 +71,6 @@ export function pickRouteSearchContractModules(
   };
 }
 
-export function isPathlessLayout(route: NestedRouteForCli | PageRoute) {
-  const extras = route as RouteExtras;
-  return (
-    extras.type === 'nested' &&
-    typeof extras.index !== 'boolean' &&
-    typeof extras.path === 'undefined'
-  );
-}
-
-export function isIndexRoute(route: NestedRouteForCli | PageRoute) {
-  const extras = route as RouteExtras;
-  return extras.type === 'nested' && Boolean(extras.index);
-}
-
 export function createRouteStaticDataSnippet(opts: {
   modernRouteId?: string;
   loaderName?: string | null;

package/src/cli/tanstackTypes/source.ts

@@ -1,25 +1,23 @@
 // @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 { AppTools } from '@modern-js/app-tools/cli-config';
+import type { CLIPluginAPI } from '@modern-js/plugin';
 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;
@@ -35,7 +33,10 @@ type RouteExtras = {
 };
 
 export async function generateTanstackRouterTypesSourceForEntry(opts: {
-  appContext: AppToolsContext;
+  appContext: Pick<
+    ReturnType<CLIPluginAPI<AppTools>['getAppContext']>,
+    'srcDirectory' | 'internalSrcAlias'
+  >;
   entryName: string;
   generatedDirName?: string;
   routes: RouteForCli[];
@@ -46,22 +47,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 +86,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 +101,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 +114,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 +136,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 +171,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 +202,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 +229,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 +238,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 +259,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 +287,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 +297,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 +322,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 {