@tanstack/router-core 0.0.1-beta.3 → 0.0.1-beta.31

package/src/routeConfig.ts

@@ -1,16 +1,11 @@
+import invariant from 'tiny-invariant'
 import { GetFrameworkGeneric } from './frameworks'
 import { ParsePathParams } from './link'
 import { joinPaths, trimPath, trimPathRight } from './path'
 import { RouteInfo } from './routeInfo'
 import { RouteMatch } from './routeMatch'
-import {
-  DeepAwaited,
-  Expand,
-  IsAny,
-  NoInfer,
-  PickUnsafe,
-  Values,
-} from './utils'
+import { RegisteredRouter, Router } from './router'
+import { Expand, IsAny, NoInfer, PickUnsafe } from './utils'
 
 export const rootRouteId = '__root__' as const
 export type RootRouteId = typeof rootRouteId
@@ -50,12 +45,12 @@ export type ParentParams<TParentParams> = AnyPathParams extends TParentParams
     }
 
 export type LoaderFn<
-  TRouteLoaderData extends AnyLoaderData,
+  TRouteLoaderData extends AnyLoaderData = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TAllParams extends AnyPathParams = {},
 > = (
   loaderContext: LoaderContext<TFullSearchSchema, TAllParams>,
-) => Promise<TRouteLoaderData>
+) => TRouteLoaderData | Promise<TRouteLoaderData>
 
 export interface LoaderContext<
   TFullSearchSchema extends AnySearchSchema = {},
@@ -64,6 +59,7 @@ export interface LoaderContext<
   params: TAllParams
   search: TFullSearchSchema
   signal?: AbortSignal
+  // parentLoaderPromise?: Promise<TParentRouteLoaderData>
 }
 
 export type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (
@@ -77,7 +73,9 @@ export type UnloaderFn<TPath extends string> = (
 export type RouteOptions<
   TRouteId extends string = string,
   TPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -108,18 +106,12 @@ export type RouteOptions<
   // Filter functions that can manipulate search params *after* they are passed to links and navigate
   // calls that match this route.
   postSearchFilters?: SearchFilter<TFullSearchSchema>[]
-  // The duration to wait during `loader` execution before showing the `pendingElement`
-  pendingMs?: number
-  // _If the `pendingElement` is shown_, the minimum duration for which it will be visible.
-  pendingMinMs?: number
-  // The content to be rendered when the route is matched. If no element is provided, defaults to `<Outlet />`
-  element?: GetFrameworkGeneric<'SyncOrAsyncElement'> // , NoInfer<TLoaderData>>
-  // The content to be rendered when `loader` encounters an error
-  errorElement?: GetFrameworkGeneric<'SyncOrAsyncElement'> // , NoInfer<TLoaderData>>
-  // The content to be rendered when rendering encounters an error
-  catchElement?: GetFrameworkGeneric<'SyncOrAsyncElement'> // , NoInfer<TLoaderData>>
-  // The content to be rendered when the duration of `loader` execution surpasses the `pendingMs` duration
-  pendingElement?: GetFrameworkGeneric<'SyncOrAsyncElement'> //, NoInfer<TLoaderData>>
+  // The content to be rendered when the route is matched. If no component is provided, defaults to `<Outlet />`
+  component?: GetFrameworkGeneric<'Component'> // , NoInfer<TParentLoaderData>>
+  // The content to be rendered when the route encounters an error
+  errorComponent?: GetFrameworkGeneric<'ErrorComponent'> // , NoInfer<TParentLoaderData>>
+  // If supported by your framework, the content to be rendered as the fallback content until the route is ready to render
+  pendingComponent?: GetFrameworkGeneric<'Component'> //, NoInfer<TParentLoaderData>>
   // An asynchronous function responsible for preparing or fetching data for the route before it is rendered
   loader?: LoaderFn<TRouteLoaderData, TFullSearchSchema, TAllParams>
   // The max age to consider loader data fresh (not-stale) for this route in milliseconds from the time of fetch
@@ -131,13 +123,16 @@ export type RouteOptions<
   // An asynchronous function made available to the route for performing asynchronous or mutative actions that
   // might invalidate the route's data.
   action?: ActionFn<TActionPayload, TActionResponse>
-  // Set this to true to rethrow errors up the component tree to either the nearest error boundary or
-  // route with error element, whichever comes first.
-  useErrorBoundary?: boolean
+  // This async function is called before a route is loaded. If an error is thrown, the navigation is cancelled.
+  // If you want to redirect instead, throw a call to the `router.navigate()` function
+  beforeLoad?: (opts: {
+    router: Router<any, any, unknown>
+    match: RouteMatch
+  }) => Promise<void> | void
   // This function is called
   // when moving from an inactive state to an active one. Likewise, when moving from
   // an active to an inactive state, the return function (if provided) is called.
-  onMatch?: (matchContext: {
+  onLoaded?: (matchContext: {
     params: TAllParams
     search: TFullSearchSchema
   }) =>
@@ -177,7 +172,9 @@ export interface RouteConfig<
   TRouteId extends string = string,
   TPath extends string = string,
   TFullPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData,
   TRouteLoaderData extends AnyLoaderData = AnyLoaderData,
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = AnyLoaderData,
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -185,10 +182,7 @@ export interface RouteConfig<
   TSearchSchema extends AnySearchSchema = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TParentParams extends AnyPathParams = {},
-  TParams extends Record<ParsePathParams<TPath>, unknown> = Record<
-    ParsePathParams<TPath>,
-    string
-  >,
+  TParams extends AnyPathParams = {},
   TAllParams extends AnyPathParams = {},
   TKnownChildren = unknown,
 > {
@@ -199,7 +193,9 @@ export interface RouteConfig<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
+    TParentLoaderData,
     TLoaderData,
     TActionPayload,
     TActionResponse,
@@ -223,7 +219,9 @@ export interface RouteConfig<
       TRouteId,
       TPath,
       TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
+      TParentLoaderData,
       TLoaderData,
       TActionPayload,
       TActionResponse,
@@ -236,55 +234,74 @@ export interface RouteConfig<
       TNewChildren
     >
   >
-  createChildren: IsAny<
+  createRoute: CreateRouteConfigFn<
+    false,
     TId,
-    any,
-    <TNewChildren extends any>(
-      cb: (
-        createChildRoute: CreateRouteConfigFn<
-          false,
-          TId,
-          TFullPath,
-          TLoaderData,
-          TFullSearchSchema,
-          TAllParams
-        >,
-      ) => TNewChildren extends AnyRouteConfig[]
-        ? TNewChildren
-        : { error: 'Invalid route detected'; route: TNewChildren },
-    ) => RouteConfig<
-      TId,
+    TFullPath,
+    TRouteLoaderData,
+    TLoaderData,
+    TFullSearchSchema,
+    TAllParams
+  >
+  generate: GenerateFn<
+    TRouteId,
+    TPath,
+    TParentRouteLoaderData,
+    TParentLoaderData,
+    TParentSearchSchema,
+    TParentParams
+  >
+}
+
+type GenerateFn<
+  TRouteId extends string = string,
+  TPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData,
+  TParentLoaderData extends AnyLoaderData = {},
+  TParentSearchSchema extends {} = {},
+  TParentParams extends AnyPathParams = {},
+> = <
+  TRouteLoaderData extends AnyLoaderData = AnyLoaderData,
+  TActionPayload = unknown,
+  TActionResponse = unknown,
+  TSearchSchema extends AnySearchSchema = {},
+  TParams extends Record<ParsePathParams<TPath>, unknown> = Record<
+    ParsePathParams<TPath>,
+    string
+  >,
+  TAllParams extends AnyPathParams extends TParams
+    ? Record<ParsePathParams<TPath>, string>
+    : NoInfer<TParams> = AnyPathParams extends TParams
+    ? Record<ParsePathParams<TPath>, string>
+    : NoInfer<TParams>,
+>(
+  options: Omit<
+    RouteOptions<
       TRouteId,
       TPath,
-      TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
-      TLoaderData,
+      TParentLoaderData,
+      Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
       TActionPayload,
       TActionResponse,
       TParentSearchSchema,
       TSearchSchema,
-      TFullSearchSchema,
+      Expand<TParentSearchSchema & TSearchSchema>,
       TParentParams,
       TParams,
-      TAllParams,
-      TNewChildren
-    >
-  >
-  createRoute: CreateRouteConfigFn<
-    false,
-    TId,
-    TFullPath,
-    TLoaderData,
-    TFullSearchSchema,
-    TAllParams
-  >
-}
+      Expand<TParentParams & TAllParams>
+    >,
+    'path'
+  >,
+) => void
 
 type CreateRouteConfigFn<
   TIsRoot extends boolean = false,
   TParentId extends string = string,
   TParentPath extends string = string,
-  TParentAllLoaderData extends AnyLoaderData = {},
+  TParentRouteLoaderData extends AnyLoaderData = {},
+  TParentLoaderData extends AnyLoaderData = {},
   TParentSearchSchema extends AnySearchSchema = {},
   TParentParams extends AnyPathParams = {},
 > = <
@@ -315,8 +332,10 @@ type CreateRouteConfigFn<
         RouteOptions<
           TRouteId,
           TPath,
+          TParentRouteLoaderData,
           TRouteLoaderData,
-          Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+          TParentLoaderData,
+          Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
           TActionPayload,
           TActionResponse,
           TParentSearchSchema,
@@ -331,8 +350,10 @@ type CreateRouteConfigFn<
     : RouteOptions<
         TRouteId,
         TPath,
+        TParentRouteLoaderData,
         TRouteLoaderData,
-        Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+        TParentLoaderData,
+        Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
         TActionPayload,
         TActionResponse,
         TParentSearchSchema,
@@ -351,8 +372,10 @@ type CreateRouteConfigFn<
   TResolvedId,
   TPath,
   string extends TPath ? '' : RoutePath<RoutePrefix<TParentPath, TPath>>,
+  TParentRouteLoaderData,
   TRouteLoaderData,
-  Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+  TParentLoaderData,
+  Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
   TActionPayload,
   TActionResponse,
   TParentSearchSchema,
@@ -395,6 +418,8 @@ export interface AnyRouteConfig
     any,
     any,
     any,
+    any,
+    any,
     any
   > {}
 
@@ -414,6 +439,8 @@ export interface AnyRouteConfigWithChildren<TChildren>
     any,
     any,
     any,
+    any,
+    any,
     TChildren
   > {}
 
@@ -477,19 +504,15 @@ export const createRouteConfig: CreateRouteConfigFn<true> = (
     fullPath: fullPath as any,
     options: options as any,
     children,
-    createChildren: (cb: any) =>
-      createRouteConfig(
-        options,
-        cb((childOptions: any) =>
-          createRouteConfig(childOptions, undefined, false, id, fullPath),
-        ),
-        false,
-        parentId,
-        parentPath,
-      ),
     addChildren: (children: any) =>
       createRouteConfig(options, children, false, parentId, parentPath),
     createRoute: (childOptions: any) =>
       createRouteConfig(childOptions, undefined, false, id, fullPath) as any,
+    generate: () => {
+      invariant(
+        false,
+        `routeConfig.generate() is used by TanStack Router's file-based routing code generation and should not actually be called during runtime. `,
+      )
+    },
   }
 }

package/src/routeInfo.ts

@@ -10,7 +10,7 @@ import {
   RouteConfig,
   RouteOptions,
 } from './routeConfig'
-import { IsAny, Values } from './utils'
+import { IsAny, UnionToIntersection, Values } from './utils'
 
 export interface AnyAllRouteInfo {
   routeConfig: AnyRouteConfig
@@ -19,6 +19,8 @@ export interface AnyAllRouteInfo {
   routeInfoByFullPath: Record<string, AnyRouteInfo>
   routeIds: any
   routePaths: any
+  fullSearchSchema: Record<string, any>
+  allParams: Record<string, any>
 }
 
 export interface DefaultAllRouteInfo {
@@ -28,6 +30,8 @@ export interface DefaultAllRouteInfo {
   routeInfoByFullPath: Record<string, RouteInfo>
   routeIds: string
   routePaths: string
+  fullSearchSchema: AnySearchSchema
+  allParams: AnyPathParams
 }
 
 export interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig>
@@ -58,12 +62,15 @@ type ParseRouteChild<TRouteConfig, TId> = TRouteConfig & {
   ? ParseRouteConfig<TRouteConfig>
   : never
 
+// Generics!
 export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
   infer TId,
   infer TRouteId,
   infer TPath,
   infer TFullPath,
+  infer TParentRouteLoaderData,
   infer TRouteLoaderData,
+  infer TParentLoaderData,
   infer TLoaderData,
   infer TActionPayload,
   infer TActionResponse,
@@ -82,7 +89,9 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
         TRouteId,
         TPath,
         TFullPath,
+        TParentRouteLoaderData,
         TRouteLoaderData,
+        TParentLoaderData,
         TLoaderData,
         TActionPayload,
         TActionResponse,
@@ -111,12 +120,14 @@ export interface RoutesInfoInner<
     any,
     any,
     any,
+    any,
+    any,
     any
   > = RouteInfo,
-  TRouteInfoById = {
+  TRouteInfoById = { '/': TRouteInfo } & {
     [TInfo in TRouteInfo as TInfo['id']]: TInfo
   },
-  TRouteInfoByFullPath = {
+  TRouteInfoByFullPath = { '/': TRouteInfo } & {
     [TInfo in TRouteInfo as TInfo['fullPath'] extends RootRouteId
       ? never
       : string extends TInfo['fullPath']
@@ -130,6 +141,8 @@ export interface RoutesInfoInner<
   routeInfoByFullPath: TRouteInfoByFullPath
   routeIds: keyof TRouteInfoById
   routePaths: keyof TRouteInfoByFullPath
+  fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>
+  allParams: Partial<UnionToIntersection<TRouteInfo['allParams']>>
 }
 
 export interface AnyRouteInfo
@@ -147,6 +160,8 @@ export interface AnyRouteInfo
     any,
     any,
     any,
+    any,
+    any,
     any
   > {}
 
@@ -154,8 +169,10 @@ export interface RouteInfo<
   TId extends string = string,
   TRouteId extends string = string,
   TPath extends string = string,
-  TFullPath extends string = string,
+  TFullPath extends string = '/',
+  TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -163,17 +180,16 @@ export interface RouteInfo<
   TSearchSchema extends AnySearchSchema = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TParentParams extends AnyPathParams = {},
-  TParams extends Record<ParsePathParams<TPath>, unknown> = Record<
-    ParsePathParams<TPath>,
-    string
-  >,
+  TParams extends AnyPathParams = {},
   TAllParams extends AnyPathParams = {},
 > {
   id: TId
   routeId: TRouteId
   path: TPath
   fullPath: TFullPath
+  parentRouteLoaderData: TParentRouteLoaderData
   routeLoaderData: TRouteLoaderData
+  parentLoaderData: TParentLoaderData
   loaderData: TLoaderData
   actionPayload: TActionPayload
   actionResponse: TActionResponse
@@ -185,7 +201,9 @@ export interface RouteInfo<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
+    TParentLoaderData,
     TLoaderData,
     TActionPayload,
     TActionResponse,