@tanstack/router-core 0.0.1-beta.14 → 0.0.1-beta.16

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/router-core",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.14",
+  "version": "0.0.1-beta.16",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",

package/src/link.ts

@@ -4,7 +4,7 @@ import {
   DefaultAllRouteInfo,
   RouteInfoByPath,
 } from './routeInfo'
-import { Location } from './router'
+import { Location, LocationState } from './router'
 import { Expand, NoInfer, PickAsRequired, PickRequired, Updater } from './utils'
 
 export type LinkInfo =
@@ -126,6 +126,8 @@ export type ToOptions<
   to?: ToPathOption<TAllRouteInfo, TFrom, TTo>
   // The new has string or a function to update it
   hash?: Updater<string>
+  // State to pass to the history stack
+  state?: LocationState
   // The source route path. This is automatically set when using route-level APIs, but for type-safe relative routing on the router itself, this is required
   from?: TFrom
   // // When using relative route paths, this option forces resolution from the current path, instead of the route API's path or `from` path

package/src/routeConfig.ts

@@ -50,20 +50,27 @@ export type ParentParams<TParentParams> = AnyPathParams extends TParentParams
     }
 
 export type LoaderFn<
-  TRouteLoaderData extends AnyLoaderData,
+  TParentRouteLoaderData extends AnyLoaderData = {},
+  TRouteLoaderData extends AnyLoaderData = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TAllParams extends AnyPathParams = {},
 > = (
-  loaderContext: LoaderContext<TFullSearchSchema, TAllParams>,
+  loaderContext: LoaderContext<
+    TParentRouteLoaderData,
+    TFullSearchSchema,
+    TAllParams
+  >,
 ) => Promise<TRouteLoaderData>
 
 export interface LoaderContext<
+  TParentRouteLoaderData extends AnyLoaderData = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TAllParams extends AnyPathParams = {},
 > {
   params: TAllParams
   search: TFullSearchSchema
   signal?: AbortSignal
+  parentLoaderPromise?: Promise<TParentRouteLoaderData>
 }
 
 export type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (
@@ -77,6 +84,7 @@ export type UnloaderFn<TPath extends string> = (
 export type RouteOptions<
   TRouteId extends string = string,
   TPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
@@ -109,13 +117,18 @@ export type RouteOptions<
   // calls that match this route.
   postSearchFilters?: SearchFilter<TFullSearchSchema>[]
   // The content to be rendered when the route is matched. If no component is provided, defaults to `<Outlet />`
-  component?: GetFrameworkGeneric<'Component'> // , NoInfer<TLoaderData>>
+  component?: GetFrameworkGeneric<'Component'> // , NoInfer<TParentLoaderData>>
   // The content to be rendered when the route encounters an error
-  errorComponent?: GetFrameworkGeneric<'Component'> // , NoInfer<TLoaderData>>
+  errorComponent?: GetFrameworkGeneric<'Component'> // , 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<TLoaderData>>
+  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>
+  loader?: LoaderFn<
+    TParentRouteLoaderData,
+    TRouteLoaderData,
+    TFullSearchSchema,
+    TAllParams
+  >
   // The max age to consider loader data fresh (not-stale) for this route in milliseconds from the time of fetch
   // Defaults to 0. Only stale loader data is refetched.
   loaderMaxAge?: number
@@ -171,6 +184,7 @@ export interface RouteConfig<
   TRouteId extends string = string,
   TPath extends string = string,
   TFullPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData,
   TRouteLoaderData extends AnyLoaderData = AnyLoaderData,
   TLoaderData extends AnyLoaderData = AnyLoaderData,
   TActionPayload = unknown,
@@ -193,6 +207,7 @@ export interface RouteConfig<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
     TLoaderData,
     TActionPayload,
@@ -217,6 +232,7 @@ export interface RouteConfig<
       TRouteId,
       TPath,
       TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
       TLoaderData,
       TActionPayload,
@@ -239,6 +255,7 @@ export interface RouteConfig<
           false,
           TId,
           TFullPath,
+          TRouteLoaderData,
           TLoaderData,
           TFullSearchSchema,
           TAllParams
@@ -251,6 +268,7 @@ export interface RouteConfig<
       TRouteId,
       TPath,
       TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
       TLoaderData,
       TActionPayload,
@@ -268,6 +286,7 @@ export interface RouteConfig<
     false,
     TId,
     TFullPath,
+    TRouteLoaderData,
     TLoaderData,
     TFullSearchSchema,
     TAllParams
@@ -278,7 +297,8 @@ 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 = {},
 > = <
@@ -309,8 +329,9 @@ type CreateRouteConfigFn<
         RouteOptions<
           TRouteId,
           TPath,
+          TParentRouteLoaderData,
           TRouteLoaderData,
-          Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+          Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
           TActionPayload,
           TActionResponse,
           TParentSearchSchema,
@@ -325,8 +346,9 @@ type CreateRouteConfigFn<
     : RouteOptions<
         TRouteId,
         TPath,
+        TParentRouteLoaderData,
         TRouteLoaderData,
-        Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+        Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
         TActionPayload,
         TActionResponse,
         TParentSearchSchema,
@@ -345,8 +367,9 @@ type CreateRouteConfigFn<
   TResolvedId,
   TPath,
   string extends TPath ? '' : RoutePath<RoutePrefix<TParentPath, TPath>>,
+  TParentRouteLoaderData,
   TRouteLoaderData,
-  Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+  Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
   TActionPayload,
   TActionResponse,
   TParentSearchSchema,
@@ -389,6 +412,7 @@ export interface AnyRouteConfig
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -408,6 +432,7 @@ export interface AnyRouteConfigWithChildren<TChildren>
     any,
     any,
     any,
+    any,
     TChildren
   > {}
 

package/src/routeInfo.ts

@@ -63,6 +63,7 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
   infer TRouteId,
   infer TPath,
   infer TFullPath,
+  infer TParentLoaderData,
   infer TRouteLoaderData,
   infer TLoaderData,
   infer TActionPayload,
@@ -82,6 +83,7 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
         TRouteId,
         TPath,
         TFullPath,
+        TParentLoaderData,
         TRouteLoaderData,
         TLoaderData,
         TActionPayload,
@@ -111,6 +113,7 @@ export interface RoutesInfoInner<
     any,
     any,
     any,
+    any,
     any
   > = RouteInfo,
   TRouteInfoById = {
@@ -147,6 +150,7 @@ export interface AnyRouteInfo
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -155,6 +159,7 @@ export interface RouteInfo<
   TRouteId extends string = string,
   TPath extends string = string,
   TFullPath extends string = string,
+  TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
@@ -173,6 +178,7 @@ export interface RouteInfo<
   routeId: TRouteId
   path: TPath
   fullPath: TFullPath
+  parentRouteLoaderData: TParentRouteLoaderData
   routeLoaderData: TRouteLoaderData
   loaderData: TLoaderData
   actionPayload: TActionPayload
@@ -185,6 +191,7 @@ export interface RouteInfo<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
     TLoaderData,
     TActionPayload,

package/src/routeMatch.ts

@@ -35,7 +35,7 @@ export interface RouteMatch<
     pendingComponent?: GetFrameworkGeneric<'Component'> // , TRouteInfo['loaderData']>
     loadPromise?: Promise<void>
     componentsPromise?: Promise<void>
-    dataPromise?: Promise<void>
+    dataPromise?: Promise<TRouteInfo['routeLoaderData']>
     onExit?:
       | void
       | ((matchContext: {
@@ -74,6 +74,7 @@ export function createRouteMatch<
   router: Router<any, any>,
   route: Route<TAllRouteInfo, TRouteInfo>,
   opts: {
+    parentMatch?: RouteMatch<any, any>
     matchId: string
     params: TRouteInfo['allParams']
     pathname: string
@@ -240,6 +241,7 @@ export function createRouteMatch<
           try {
             if (routeMatch.options.loader) {
               const data = await routeMatch.options.loader({
+                parentLoaderPromise: routeMatch.parentMatch?.__.dataPromise,
                 params: routeMatch.params,
                 search: routeMatch.routeSearch,
                 signal: routeMatch.__.abortController.signal,
@@ -263,6 +265,8 @@ export function createRouteMatch<
                 routeMatch.options.loaderMaxAge ??
                 router.options.defaultLoaderMaxAge ??
                 0)
+
+            return routeMatch.routeLoaderData
           } catch (err) {
             if (id !== routeMatch.__.latestId) {
               return routeMatch.__.loadPromise
@@ -271,16 +275,19 @@ export function createRouteMatch<
             if (process.env.NODE_ENV !== 'production') {
               console.error(err)
             }
+
             routeMatch.error = err
             routeMatch.status = 'error'
             routeMatch.updatedAt = Date.now()
+
+            throw err
           }
         })
 
         try {
           await Promise.all([
             routeMatch.__.componentsPromise,
-            routeMatch.__.dataPromise,
+            routeMatch.__.dataPromise.catch(() => {}),
           ])
           if (id !== routeMatch.__.latestId) {
             return routeMatch.__.loadPromise

package/src/router.ts

@@ -199,6 +199,7 @@ export interface BuildNextOptions {
   params?: true | Updater<Record<string, any>>
   search?: true | Updater<unknown>
   hash?: true | Updater<string>
+  state?: LocationState
   key?: string
   from?: string
   fromCurrent?: boolean
@@ -811,6 +812,7 @@ export function createRouter<
             existingMatches.find((d) => d.matchId === matchId) ||
             router.matchCache[matchId]?.match ||
             createRouteMatch(router, foundRoute, {
+              parentMatch,
               matchId,
               params,
               pathname: joinPaths([pathname, interpolatedPath]),
@@ -1257,6 +1259,7 @@ export function createRouter<
             },
             {
               id,
+              ...next.state,
             },
           )
         } else {