@bleedingdev/modern-js-plugin-tanstack 3.2.0-ultramodern.12 → 3.2.0-ultramodern.121

package/src/runtime/routeTree.ts

@@ -1,6 +1,7 @@
 // @effect-diagnostics asyncFunction:off strictBooleanExpressions:off
+
+import { DefaultNotFound } from '@modern-js/runtime/context';
 import type { RouteObject } from '@modern-js/runtime-utils/router';
-import type { NestedRoute, PageRoute } from '@modern-js/types';
 import type {
   AnyRoute,
   AnyRouter,
@@ -10,9 +11,16 @@ import {
   createRootRoute,
   createRoute,
   notFound,
-  redirect,
+  rootRouteId,
 } from '@tanstack/react-router';
-import { DefaultNotFound } from './DefaultNotFound';
+import { createElement, type ElementType } from 'react';
+import {
+  isRedirectResponse,
+  isResponse,
+  isTanstackRedirect,
+  throwTanstackRedirect,
+} from './loaderBridge';
+import { withModernRouteMatchContext } from './outlet';
 import {
   isTanstackRscPayloadNavigationEnabled,
   loadTanstackRscRouteData,
@@ -75,40 +83,18 @@ type ModernRouteObject = RouteObject & {
   isClientComponent?: boolean;
   lazyImport?: () => unknown;
   loader?: ModernLoader;
+  loaderDeps?: unknown;
   pendingComponent?: unknown;
   shouldRevalidate?: ModernShouldRevalidate;
-};
-
-type ModernGeneratedRoute = (NestedRoute | PageRoute) & {
-  _component?: string;
-  action?: unknown;
-  children?: ModernGeneratedRoute[];
-  component?: unknown;
-  config?: { handle?: Record<string, unknown> } | unknown;
-  clientData?: unknown;
-  data?: string;
-  error?: unknown;
-  errorComponent?: unknown;
-  filename?: string;
-  handle?: Record<string, unknown>;
-  hasAction?: boolean;
-  hasClientLoader?: boolean;
-  hasLoader?: boolean;
-  inValidSSRRoute?: boolean;
-  id?: string;
-  index?: boolean;
-  isClientComponent?: boolean;
-  isRoot?: boolean;
-  lazyImport?: () => unknown;
-  loader?: ModernLoader;
-  loading?: unknown;
-  pendingComponent?: unknown;
-  path?: string;
-  shouldRevalidate?: ModernShouldRevalidate;
+  validateSearch?: unknown;
 };
 
 type MutableTanstackRoute = AnyRoute & {
   addChildren: (children: AnyRoute[]) => void;
+  id?: string;
+  options: {
+    component?: unknown;
+  };
 };
 
 type TanstackRouteOptions = Record<string, unknown>;
@@ -118,6 +104,15 @@ type ModernDeferredDataLike = {
   __modern_deferred?: unknown;
   data?: unknown;
 };
+type ModernRouteModule = {
+  Component?: unknown;
+  default?: unknown;
+};
+type PreloadableComponent = {
+  (props: Record<string, unknown>): ReturnType<typeof createElement>;
+  load?: () => Promise<unknown>;
+  preload?: () => Promise<unknown>;
+};
 type RouteTreeOptions = {
   rscPayloadRouter?: boolean;
 };
@@ -134,6 +129,20 @@ function createTanstackRootRoute(
   return createRootRoute(options as never) as unknown as MutableTanstackRoute;
 }
 
+function wrapRouteComponentWithModernContext(
+  route: MutableTanstackRoute,
+  component: unknown,
+  routeId?: string,
+) {
+  const routeMatchId = routeId || route.id;
+  if (component && routeMatchId) {
+    route.options.component = withModernRouteMatchContext(
+      component,
+      routeMatchId,
+    ) as typeof route.options.component;
+  }
+}
+
 function toTanstackPath(pathname: string): string {
   // TanStack Router uses `$param` and `$` (splat) style params.
   // Modern's conventional routing currently generates React Router style params (e.g. `:id`, `*`).
@@ -163,28 +172,6 @@ function toTanstackPath(pathname: string): string {
     .join('/');
 }
 
-function isResponse(value: unknown): value is Response {
-  const record = value as { headers?: unknown; status?: unknown } | null;
-  return (
-    record != null &&
-    typeof record === 'object' &&
-    typeof record.status === 'number' &&
-    typeof record.headers === 'object'
-  );
-}
-
-function isTanstackRedirect(value: unknown): boolean {
-  return (
-    isResponse(value) &&
-    typeof (value as { options?: unknown }).options === 'object'
-  );
-}
-
-const redirectStatusCodes = new Set([301, 302, 303, 307, 308]);
-function isRedirectResponse(res: Response) {
-  return redirectStatusCodes.has(res.status);
-}
-
 function isModernDeferredData(
   value: unknown,
 ): value is ModernDeferredDataLike & { data: Record<string, unknown> } {
@@ -219,44 +206,74 @@ function normalizeModernLoaderResponse(result: unknown): unknown {
   return normalizeModernLoaderResult(result);
 }
 
-function isAbsoluteUrl(value: string) {
-  try {
-    void new URL(value);
-    return true;
-  } catch {
-    return false;
+function pickRouteModuleComponent(
+  routeModule: unknown,
+  seen: Set<unknown> = new Set(),
+): ElementType<Record<string, unknown>> | undefined {
+  if (
+    typeof routeModule === 'function' ||
+    (routeModule &&
+      typeof routeModule === 'object' &&
+      '$$typeof' in routeModule)
+  ) {
+    return routeModule as ElementType<Record<string, unknown>>;
   }
-}
 
-function throwTanstackRedirect(location: string) {
-  const target = location || '/';
-  // Prefer `to` for internal/relative redirects so basepath can be applied.
-  // Use `href` for absolute redirects (external).
-  if (isAbsoluteUrl(target)) {
-    throw redirect({ href: target });
+  if (!routeModule || typeof routeModule !== 'object') {
+    return undefined;
+  }
+  if (seen.has(routeModule)) {
+    return undefined;
   }
+  seen.add(routeModule);
 
-  throw redirect({ to: target });
+  const module = routeModule as ModernRouteModule;
+  for (const candidate of [module.default, module.Component]) {
+    const component = pickRouteModuleComponent(candidate, seen);
+    if (component) {
+      return component;
+    }
+  }
+
+  return undefined;
 }
 
-function mapParamsForModernLoader({
-  modernRoute,
-  params,
-}: {
-  modernRoute: NestedRoute | PageRoute;
-  params: RouteParams;
-}) {
-  // React Router uses `*` for splat params, TanStack Router uses `_splat`.
-  if (modernRoute.type === 'nested' && modernRoute.path?.includes('*')) {
-    const { _splat, ...rest } = params as RouteParams & {
-      _splat?: string;
-    };
-    if (typeof _splat !== 'undefined') {
-      return { ...rest, '*': _splat };
-    }
-    return rest;
+function createServerLazyImportComponent(
+  lazyImport: () => unknown,
+  fallbackComponent?: unknown,
+): PreloadableComponent | unknown {
+  if (typeof document !== 'undefined') {
+    return fallbackComponent;
   }
-  return params;
+
+  let resolvedComponent: ElementType<Record<string, unknown>> | undefined;
+  let pendingLoad: Promise<unknown> | undefined;
+
+  const load = async () => {
+    if (resolvedComponent) {
+      return resolvedComponent;
+    }
+
+    const routeModule = await lazyImport();
+    const component = pickRouteModuleComponent(routeModule);
+    if (component) {
+      resolvedComponent = component;
+    }
+    return resolvedComponent;
+  };
+
+  const Component: PreloadableComponent = props => {
+    if (resolvedComponent) {
+      return createElement(resolvedComponent, props);
+    }
+
+    pendingLoad ||= load();
+    throw pendingLoad;
+  };
+  Component.load = load;
+  Component.preload = load;
+
+  return Component;
 }
 
 function createModernRequest(input: string, signal: AbortSignal) {
@@ -316,91 +333,6 @@ function createModernShouldReload(
   };
 }
 
-function wrapModernLoader(
-  modernRoute: NestedRoute | PageRoute,
-  modernLoader: ModernLoader | undefined,
-  revalidationState?: RouteRevalidationState,
-  options: RouteTreeOptions = {},
-) {
-  const route = modernRoute as ModernGeneratedRoute;
-  return async (ctx: TanstackLoaderContext) => {
-    try {
-      if (revalidationState) {
-        rememberRouteLocation(revalidationState, ctx);
-      }
-
-      if (typeof route.lazyImport === 'function') {
-        try {
-          await route.lazyImport();
-        } catch {}
-      }
-
-      const signal: AbortSignal =
-        ctx?.abortController?.signal ||
-        ctx?.signal ||
-        new AbortController().signal;
-      const baseRequest: Request | undefined =
-        ctx?.context?.request instanceof Request
-          ? ctx.context.request
-          : undefined;
-
-      const href =
-        typeof ctx?.location === 'string'
-          ? ctx.location
-          : ctx?.location?.publicHref ||
-            ctx?.location?.href ||
-            ctx?.location?.url?.href ||
-            '';
-
-      const request = baseRequest
-        ? new Request(baseRequest, { signal })
-        : createModernRequest(href, signal);
-      const params = mapParamsForModernLoader({
-        modernRoute,
-        params: ctx.params || {},
-      });
-
-      const loadModernData = async () => {
-        const result = modernLoader
-          ? await modernLoader({
-              request,
-              params,
-              context: ctx?.context?.requestContext,
-            })
-          : null;
-
-        return normalizeModernLoaderResponse(result);
-      };
-
-      if (options.rscPayloadRouter && isTanstackRscPayloadNavigationEnabled()) {
-        return loadTanstackRscRouteData({
-          hasClientLoader:
-            route.hasClientLoader || typeof route.clientData !== 'undefined',
-          loadClientData: loadModernData,
-          request,
-          routeId: ctx.route?.id,
-        });
-      }
-
-      return loadModernData();
-    } catch (err) {
-      if (isResponse(err)) {
-        if (isTanstackRedirect(err)) {
-          throw err;
-        }
-        if (isRedirectResponse(err)) {
-          const location = err.headers.get('Location') || '/';
-          throwTanstackRedirect(location);
-        }
-        if (err.status === 404) {
-          throw notFound();
-        }
-      }
-      throw err;
-    }
-  };
-}
-
 function isRouteObjectPathlessLayout(route: RouteObject) {
   return !route.path && !route.index;
 }
@@ -468,9 +400,10 @@ function wrapRouteObjectLoader(
             ctx?.location?.url?.href ||
             '';
 
-      const request = baseRequest
-        ? new Request(baseRequest, { signal })
-        : createModernRequest(href, signal);
+      const request =
+        baseRequest !== undefined
+          ? new Request(baseRequest, { signal })
+          : createModernRequest(href, signal);
 
       const params = mapParamsForRouteObjectLoader({
         route,
@@ -519,6 +452,18 @@ function wrapRouteObjectLoader(
 
 function toRouteComponent(routeObject: RouteObject): unknown {
   const route = routeObject as ModernRouteObject;
+  const lazyImport =
+    typeof route.lazyImport === 'function' ? route.lazyImport : undefined;
+  const fallbackComponent = route.Component
+    ? route.Component
+    : route.element
+      ? () => route.element
+      : undefined;
+
+  if (lazyImport && fallbackComponent) {
+    return createServerLazyImportComponent(lazyImport, fallbackComponent);
+  }
+
   if (route.Component) {
     return route.Component;
   }
@@ -627,12 +572,14 @@ function createRouteFromRouteObject(opts: {
   const stableFallbackId =
     routeObject.id || modernRouteObject.file || routeObject.path || 'pathless';
 
+  const component = toRouteComponent(routeObject);
   const base: TanstackRouteOptions = {
     getParentRoute: () => parent,
-    component: toRouteComponent(routeObject),
+    component,
     pendingComponent: toPendingComponent(routeObject),
     errorComponent: toErrorComponent(routeObject),
-    wrapInSuspense: true,
+    validateSearch: modernRouteObject.validateSearch,
+    loaderDeps: modernRouteObject.loaderDeps,
     staticData: createRouteStaticData({
       modernRouteId: routeObject.id,
       modernRouteAction: modernRouteObject.action,
@@ -667,6 +614,7 @@ function createRouteFromRouteObject(opts: {
   }
 
   const route = createTanstackRoute(base);
+  wrapRouteComponentWithModernContext(route, component, routeObject.id);
 
   const children = routeObject.children;
   if (children && children.length > 0) {
@@ -683,175 +631,6 @@ function createRouteFromRouteObject(opts: {
   return route;
 }
 
-function createRouteFromModernRoute(opts: {
-  options?: RouteTreeOptions;
-  parent: AnyRoute;
-  modernRoute: NestedRoute | PageRoute;
-}): AnyRoute {
-  const { options = {}, parent, modernRoute } = opts;
-  const route = modernRoute as ModernGeneratedRoute;
-  const revalidationState: RouteRevalidationState = {};
-
-  const modernId = route.id;
-  const stableFallbackId =
-    modernId ||
-    route._component ||
-    route.filename ||
-    route.data ||
-    (typeof route.loader === 'function' ? route.id : undefined);
-
-  const pendingComponent = route.loading || route.pendingComponent;
-  const errorComponent = route.error || route.errorComponent;
-  const component = route.component;
-  const modernLoader = route.loader;
-  const modernAction = route.action;
-  const modernShouldRevalidate = route.shouldRevalidate;
-  const shouldReload = createModernShouldReload(
-    modernShouldRevalidate,
-    revalidationState,
-  );
-
-  // Pathless layout: no path segment, but must remain in the tree.
-  const isPathlessLayout =
-    route.type === 'nested' &&
-    typeof route.index !== 'boolean' &&
-    typeof route.path === 'undefined';
-
-  const isIndexRoute = route.type === 'nested' && Boolean(route.index);
-
-  const base: TanstackRouteOptions = {
-    getParentRoute: () => parent,
-    component: component || undefined,
-    pendingComponent: pendingComponent || undefined,
-    errorComponent: errorComponent || undefined,
-    wrapInSuspense: true,
-    staticData: createRouteStaticData({
-      modernRouteId: modernId,
-      modernRouteAction: modernAction,
-      modernRouteHandle: mergeModernRouteHandle(route),
-      modernRouteHasAction: route.hasAction || Boolean(modernAction),
-      modernRouteHasClientLoader:
-        route.hasClientLoader || typeof route.clientData !== 'undefined',
-      modernRouteHasLoader:
-        route.hasLoader || typeof modernLoader === 'function',
-      modernRouteIsClientComponent: route.isClientComponent,
-      modernRouteLoader: modernLoader,
-      modernRouteShouldRevalidate: modernShouldRevalidate,
-    }),
-    loader: wrapModernLoader(
-      modernRoute,
-      modernLoader,
-      revalidationState,
-      options,
-    ),
-  };
-  if (route.inValidSSRRoute) {
-    base.ssr = false;
-  }
-  if (shouldReload) {
-    base.shouldReload = shouldReload;
-  }
-
-  if (isPathlessLayout) {
-    // Use a stable custom id for pathless layouts to avoid hydration mismatch.
-    base.id = stableFallbackId || 'pathless';
-  } else {
-    const rawPath = route.path;
-    base.path = isIndexRoute ? '/' : toTanstackPath(rawPath || '');
-  }
-
-  const tanstackRoute = createTanstackRoute(base);
-
-  const children = route.children as Array<NestedRoute | PageRoute> | undefined;
-  if (children && children.length > 0) {
-    const childRoutes = children.map(child =>
-      createRouteFromModernRoute({
-        options,
-        parent: tanstackRoute,
-        modernRoute: child,
-      }),
-    );
-    tanstackRoute.addChildren(childRoutes);
-  }
-
-  return tanstackRoute;
-}
-
-export function createRouteTreeFromModernRoutes(
-  routes: Array<NestedRoute | PageRoute>,
-  options: RouteTreeOptions = {},
-): ModernTanstackRootRoute {
-  const rootModern = routes.find(
-    r =>
-      r &&
-      (r as ModernGeneratedRoute).type === 'nested' &&
-      (r as ModernGeneratedRoute).isRoot,
-  ) as ModernGeneratedRoute | undefined;
-
-  const rootComponent = rootModern?.component;
-  const pendingComponent = rootModern?.loading;
-  const errorComponent = rootModern?.error;
-  const rootLoader = rootModern?.loader;
-  const rootAction = rootModern?.action;
-  const rootModernId = rootModern?.id;
-  const rootShouldRevalidate = rootModern?.shouldRevalidate;
-  const rootRevalidationState: RouteRevalidationState = {};
-  const rootShouldReload = createModernShouldReload(
-    rootShouldRevalidate,
-    rootRevalidationState,
-  );
-
-  const rootRouteOptions: TanstackRootRouteOptions = {
-    component: rootComponent || undefined,
-    pendingComponent: pendingComponent || undefined,
-    errorComponent: errorComponent || undefined,
-    wrapInSuspense: true,
-    notFoundComponent: DefaultNotFound,
-    staticData: createRouteStaticData({
-      modernRouteId: rootModernId,
-      modernRouteAction: rootAction,
-      modernRouteHandle: rootModern
-        ? mergeModernRouteHandle(rootModern)
-        : undefined,
-      modernRouteHasAction: rootModern?.hasAction || Boolean(rootAction),
-      modernRouteHasClientLoader:
-        rootModern?.hasClientLoader ||
-        typeof rootModern?.clientData !== 'undefined',
-      modernRouteHasLoader:
-        rootModern?.hasLoader || typeof rootLoader === 'function',
-      modernRouteIsClientComponent: rootModern?.isClientComponent,
-      modernRouteLoader: rootLoader,
-      modernRouteShouldRevalidate: rootShouldRevalidate,
-    }),
-    loader: rootModern
-      ? wrapModernLoader(rootModern, rootLoader, rootRevalidationState, options)
-      : undefined,
-  };
-  if (rootShouldReload) {
-    rootRouteOptions.shouldReload = rootShouldReload;
-  }
-  if (rootModern?.inValidSSRRoute) {
-    rootRouteOptions.ssr = false;
-  }
-
-  const rootRoute = createTanstackRootRoute(rootRouteOptions);
-
-  const topLevel = rootModern
-    ? (rootModern.children as Array<NestedRoute | PageRoute>) || []
-    : routes;
-
-  const childRoutes = topLevel.map(child =>
-    createRouteFromModernRoute({
-      options,
-      parent: rootRoute,
-      modernRoute: child,
-    }),
-  );
-
-  rootRoute.addChildren(childRoutes);
-  return rootRoute as unknown as ModernTanstackRootRoute;
-}
-
 function getRootLikeRouteObject(routes: RouteObject[]) {
   return routes.find(route => route.path === '/' && !route.index);
 }
@@ -870,13 +649,17 @@ export function createRouteTreeFromRouteObjects(
     rootRevalidationState,
   );
 
+  const rootComponent = rootLikeRoute
+    ? toRouteComponent(rootLikeRoute)
+    : undefined;
   const rootRouteOptions: TanstackRootRouteOptions = {
-    component: rootLikeRoute ? toRouteComponent(rootLikeRoute) : undefined,
+    component: rootComponent,
     pendingComponent: rootLikeRoute
       ? toPendingComponent(rootLikeRoute)
       : undefined,
     errorComponent: rootLikeRoute ? toErrorComponent(rootLikeRoute) : undefined,
-    wrapInSuspense: true,
+    validateSearch: rootLikeRoute?.validateSearch,
+    loaderDeps: rootLikeRoute?.loaderDeps,
     notFoundComponent: DefaultNotFound,
     staticData: createRouteStaticData({
       modernRouteId: rootLikeRoute?.id,
@@ -907,6 +690,12 @@ export function createRouteTreeFromRouteObjects(
   }
 
   const rootRoute = createTanstackRootRoute(rootRouteOptions);
+  if (rootComponent) {
+    rootRoute.options.component = withModernRouteMatchContext(
+      rootComponent,
+      rootRouteId,
+    ) as typeof rootRoute.options.component;
+  }
 
   const topLevel = rootLikeRoute
     ? [
@@ -925,18 +714,38 @@ export function createRouteTreeFromRouteObjects(
 
 export function getModernRouteIdsFromMatches(router: AnyRouter): string[] {
   const matches = router.state.matches || [];
+  const routesById = (
+    router as AnyRouter & {
+      routesById?: Record<
+        string,
+        {
+          options?: {
+            staticData?: { modernRouteId?: unknown };
+          };
+        }
+      >;
+    }
+  ).routesById;
   const ids = matches
     .map(match => {
-      const route = (
-        match as {
-          route?: {
-            options?: {
-              staticData?: { modernRouteId?: unknown };
-            };
+      const normalizedMatch = match as {
+        route?: {
+          options?: {
+            staticData?: { modernRouteId?: unknown };
           };
-        }
-      ).route;
-      return route?.options?.staticData?.modernRouteId;
+        };
+        routeId?: unknown;
+      };
+      const routeId =
+        typeof normalizedMatch.routeId === 'string'
+          ? normalizedMatch.routeId
+          : undefined;
+      return (
+        normalizedMatch.route?.options?.staticData?.modernRouteId ??
+        (routeId
+          ? routesById?.[routeId]?.options?.staticData?.modernRouteId
+          : undefined)
+      );
     })
     .filter((id): id is string => typeof id === 'string');
   return Array.from(new Set(ids));

package/src/runtime/router.ts

@@ -0,0 +1,15 @@
+/**
+ * Entry-injected router module for entrypoints that are NOT TanStack
+ * file-route entrypoints (e.g. apps configuring
+ * `router: { framework: 'tanstack', createRoutes }` in modern.runtime.ts).
+ *
+ * The CLI plugin injects `{ name: 'router', path: '<pkg>/runtime/router' }`
+ * for those entries, so the generated entry code value-imports `routerPlugin`
+ * from here. That single import both installs the framework-resolving router
+ * plugin of @modern-js/runtime AND registers the TanStack router provider
+ * (the './register' side effect) — the registration can therefore never be
+ * tree-shaken away from the entry that needs it.
+ */
+import './register';
+
+export { routerPlugin } from '@modern-js/runtime/router/internal';