@tanstack/router-core 0.0.1-beta.24 → 0.0.1-beta.26

package/package.json

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

package/src/frameworks.ts

@@ -4,6 +4,7 @@ export interface FrameworkGenerics {
   // pre-defined as constraints:
   //
   // Component: any
+  // ErrorComponent: any
 }
 
 export type GetFrameworkGeneric<U> = U extends keyof FrameworkGenerics

package/src/link.ts

@@ -5,7 +5,7 @@ import {
   RouteInfoByPath,
 } from './routeInfo'
 import { Location, LocationState } from './router'
-import { Expand, NoInfer, PickAsRequired, PickRequired, Updater } from './utils'
+import { Expand, NoInfer, PickRequired, Updater } from './utils'
 
 export type LinkInfo =
   | {
@@ -58,7 +58,7 @@ export type Split<S, TIncludeTrailingSlash = true> = S extends unknown
   : never
 
 export type ParsePathParams<T extends string> = Split<T>[number] extends infer U
-  ? U extends `:${infer V}`
+  ? U extends `$${infer V}`
     ? V
     : never
   : never

package/src/path.ts

@@ -97,7 +97,7 @@ export function parsePathname(pathname?: string): Segment[] {
         }
       }
 
-      if (part.charAt(0) === ':') {
+      if (part.charAt(0) === '$') {
         return {
           type: 'param',
           value: part,
@@ -215,7 +215,7 @@ export function matchByPath(
           if (baseSegment?.value === '/') {
             return false
           }
-          if (!baseSegment.value.startsWith(':')) {
+          if (baseSegment.value.charAt(0) !== '$') {
             params[routeSegment.value.substring(1)] = baseSegment.value
           }
         }

package/src/routeConfig.ts

@@ -1,3 +1,4 @@
+import invariant from 'tiny-invariant'
 import { GetFrameworkGeneric } from './frameworks'
 import { ParsePathParams } from './link'
 import { joinPaths, trimPath, trimPathRight } from './path'
@@ -56,7 +57,7 @@ export type LoaderFn<
   TAllParams extends AnyPathParams = {},
 > = (
   loaderContext: LoaderContext<TFullSearchSchema, TAllParams>,
-) => Promise<TRouteLoaderData>
+) => TRouteLoaderData | Promise<TRouteLoaderData>
 
 export interface LoaderContext<
   TFullSearchSchema extends AnySearchSchema = {},
@@ -81,6 +82,7 @@ export type RouteOptions<
   TPath extends string = string,
   TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -114,7 +116,7 @@ export type RouteOptions<
   // 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<'Component'> // , NoInfer<TParentLoaderData>>
+  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
@@ -176,6 +178,7 @@ export interface RouteConfig<
   TFullPath extends string = string,
   TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData,
   TRouteLoaderData extends AnyLoaderData = AnyLoaderData,
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = AnyLoaderData,
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -183,10 +186,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,6 +199,7 @@ export interface RouteConfig<
     TPath,
     TParentRouteLoaderData,
     TRouteLoaderData,
+    TParentLoaderData,
     TLoaderData,
     TActionPayload,
     TActionResponse,
@@ -224,6 +225,7 @@ export interface RouteConfig<
       TFullPath,
       TParentRouteLoaderData,
       TRouteLoaderData,
+      TParentLoaderData,
       TLoaderData,
       TActionPayload,
       TActionResponse,
@@ -236,52 +238,67 @@ export interface RouteConfig<
       TNewChildren
     >
   >
-  createChildren: IsAny<
+  createRoute: CreateRouteConfigFn<
+    false,
     TId,
-    any,
-    <TNewChildren extends any>(
-      cb: (
-        createChildRoute: CreateRouteConfigFn<
-          false,
-          TId,
-          TFullPath,
-          TRouteLoaderData,
-          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,
-    TRouteLoaderData,
-    TLoaderData,
-    TFullSearchSchema,
-    TAllParams
-  >
-}
+      Expand<TParentParams & TAllParams>
+    >,
+    'path'
+  >,
+) => void
 
 type CreateRouteConfigFn<
   TIsRoot extends boolean = false,
@@ -321,7 +338,8 @@ type CreateRouteConfigFn<
           TPath,
           TParentRouteLoaderData,
           TRouteLoaderData,
-          Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+          TParentLoaderData,
+          Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
           TActionPayload,
           TActionResponse,
           TParentSearchSchema,
@@ -338,7 +356,8 @@ type CreateRouteConfigFn<
         TPath,
         TParentRouteLoaderData,
         TRouteLoaderData,
-        Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+        TParentLoaderData,
+        Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
         TActionPayload,
         TActionResponse,
         TParentSearchSchema,
@@ -359,7 +378,8 @@ type CreateRouteConfigFn<
   string extends TPath ? '' : RoutePath<RoutePrefix<TParentPath, TPath>>,
   TParentRouteLoaderData,
   TRouteLoaderData,
-  Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+  TParentLoaderData,
+  Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>,
   TActionPayload,
   TActionResponse,
   TParentSearchSchema,
@@ -403,6 +423,7 @@ export interface AnyRouteConfig
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -423,6 +444,7 @@ export interface AnyRouteConfigWithChildren<TChildren>
     any,
     any,
     any,
+    any,
     TChildren
   > {}
 
@@ -486,19 +508,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

@@ -60,13 +60,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 TParentLoaderData,
+  infer TParentRouteLoaderData,
   infer TRouteLoaderData,
+  infer TParentLoaderData,
   infer TLoaderData,
   infer TActionPayload,
   infer TActionResponse,
@@ -85,8 +87,9 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
         TRouteId,
         TPath,
         TFullPath,
-        TParentLoaderData,
+        TParentRouteLoaderData,
         TRouteLoaderData,
+        TParentLoaderData,
         TLoaderData,
         TActionPayload,
         TActionResponse,
@@ -116,6 +119,7 @@ export interface RoutesInfoInner<
     any,
     any,
     any,
+    any,
     any
   > = RouteInfo,
   TRouteInfoById = { '/': TRouteInfo } & {
@@ -154,6 +158,7 @@ export interface AnyRouteInfo
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -164,6 +169,7 @@ export interface RouteInfo<
   TFullPath extends string = string,
   TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
+  TParentLoaderData extends AnyLoaderData = {},
   TLoaderData extends AnyLoaderData = {},
   TActionPayload = unknown,
   TActionResponse = unknown,
@@ -171,10 +177,7 @@ 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
@@ -183,6 +186,7 @@ export interface RouteInfo<
   fullPath: TFullPath
   parentRouteLoaderData: TParentRouteLoaderData
   routeLoaderData: TRouteLoaderData
+  parentLoaderData: TParentLoaderData
   loaderData: TLoaderData
   actionPayload: TActionPayload
   actionResponse: TActionResponse
@@ -196,6 +200,7 @@ export interface RouteInfo<
     TPath,
     TParentRouteLoaderData,
     TRouteLoaderData,
+    TParentLoaderData,
     TLoaderData,
     TActionPayload,
     TActionResponse,

package/src/routeMatch.ts

@@ -30,9 +30,9 @@ export interface RouteMatch<
   isFetching: boolean
   invalidAt: number
   __: {
-    component?: GetFrameworkGeneric<'Component'> // , TRouteInfo['loaderData']>
-    errorComponent?: GetFrameworkGeneric<'Component'> // , TRouteInfo['loaderData']>
-    pendingComponent?: GetFrameworkGeneric<'Component'> // , TRouteInfo['loaderData']>
+    component?: GetFrameworkGeneric<'Component'>
+    errorComponent?: GetFrameworkGeneric<'ErrorComponent'>
+    pendingComponent?: GetFrameworkGeneric<'Component'>
     loadPromise?: Promise<void>
     componentsPromise?: Promise<void>
     dataPromise?: Promise<TRouteInfo['routeLoaderData']>

package/src/router.ts

@@ -91,7 +91,7 @@ export interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
   defaultPreloadGcMaxAge?: number
   defaultPreloadDelay?: number
   defaultComponent?: GetFrameworkGeneric<'Component'>
-  defaultErrorComponent?: GetFrameworkGeneric<'Component'>
+  defaultErrorComponent?: GetFrameworkGeneric<'ErrorComponent'>
   defaultPendingComponent?: GetFrameworkGeneric<'Component'>
   defaultLoaderMaxAge?: number
   defaultLoaderGcMaxAge?: number

package/src/utils.ts

@@ -40,9 +40,9 @@ export type DeepAwaited<T> = T extends Promise<infer A>
   : T
 
 export type PathParamMask<TRoutePath extends string> =
-  TRoutePath extends `${infer L}/:${infer C}/${infer R}`
+  TRoutePath extends `${infer L}/$${infer C}/${infer R}`
     ? PathParamMask<`${L}/${string}/${R}`>
-    : TRoutePath extends `${infer L}/:${infer C}`
+    : TRoutePath extends `${infer L}/$${infer C}`
     ? PathParamMask<`${L}/${string}`>
     : TRoutePath