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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/router-core",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.30",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -23,7 +23,7 @@
     "url": "https://github.com/sponsors/tannerlinsley"
   },
   "module": "build/esm/index.js",
-  "main": "build/cjs/packages/router-core/src/index.js",
+  "main": "build/cjs/index.js",
   "browser": "build/umd/index.production.js",
   "types": "build/types/index.d.ts",
   "engines": {
@@ -33,6 +33,7 @@
     "build/**",
     "src"
   ],
+  "sideEffects": false,
   "peerDependencies": {
     "react": ">=16",
     "react-dom": ">=16"

package/src/frameworks.ts

@@ -3,8 +3,8 @@ export interface FrameworkGenerics {
   // and are extended by framework adapters, but cannot be
   // pre-defined as constraints:
   //
-  // Element: any
-  // SyncOrAsyncElement?: any
+  // Component: any
+  // ErrorComponent: any
 }
 
 export type GetFrameworkGeneric<U> = U extends keyof FrameworkGenerics

package/src/index.ts

@@ -7,7 +7,6 @@ export {
 export { default as invariant } from 'tiny-invariant'
 
 export * from './frameworks'
-export * from './index'
 export * from './link'
 export * from './path'
 export * from './qss'

package/src/link.ts

@@ -4,8 +4,8 @@ import {
   DefaultAllRouteInfo,
   RouteInfoByPath,
 } from './routeInfo'
-import { Location } from './router'
-import { Expand, NoInfer, PickAsRequired, PickRequired, Updater } from './utils'
+import { Location, LocationState } from './router'
+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
@@ -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
@@ -140,8 +142,9 @@ type SearchParamOptions<
   TTo,
   TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'],
   TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema'],
-> = StartsWith<TFrom, TTo> extends true // If the next route search extend or cover the from route, params will be optional
-  ? {
+> = StartsWith<TFrom, TTo> extends true
+  ? // If the next route search extend or cover the from route, params will be optional
+    {
       search?: SearchReducer<TFromSchema, TToSchema>
     }
   : // Optional search params? Allow it

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,
@@ -155,10 +155,6 @@ export function matchPathname(
     return
   }
 
-  // if (matchLocation.search && !searchMatched) {
-  //   return
-  // }
-
   return pathParams ?? {}
 }
 
@@ -219,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/qss.ts

@@ -30,6 +30,7 @@ function toValue(mix) {
   var str = decodeURIComponent(mix)
   if (str === 'false') return false
   if (str === 'true') return true
+  if (str.charAt(0) === '0') return str
   return +str * 0 === 0 ? +str : str
 }
 

package/src/route.ts

@@ -13,7 +13,6 @@ import {
   RouteInfo,
   RouteInfoByPath,
 } from './routeInfo'
-import { RouteMatch } from './routeMatch'
 import {
   Action,
   ActionState,
@@ -22,14 +21,16 @@ import {
   MatchRouteOptions,
   Router,
 } from './router'
-import { NoInfer, replaceEqualDeep } from './utils'
+import { NoInfer } from './utils'
 
-export interface AnyRoute extends Route<any, any> {}
+export interface AnyRoute extends Route<any, any, any> {}
 
 export interface Route<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
   TRouteInfo extends AnyRouteInfo = RouteInfo,
+  TRouterContext = unknown,
 > {
+  routeInfo: TRouteInfo
   routeId: TRouteInfo['id']
   routeRouteId: TRouteInfo['routeId']
   routePath: TRouteInfo['path']
@@ -37,7 +38,7 @@ export interface Route<
   parentRoute?: AnyRoute
   childRoutes?: AnyRoute[]
   options: RouteOptions
-  router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>
+  router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>
   buildLink: <TTo extends string = '.'>(
     options: Omit<
       LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>,
@@ -57,7 +58,10 @@ export interface Route<
     opts?: MatchRouteOptions,
   ) => RouteInfoByPath<TAllRouteInfo, TResolved>['allParams']
   navigate: <TTo extends string = '.'>(
-    options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['id'], TTo>, 'from'>,
+    options: Omit<
+      LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>,
+      'from'
+    >,
   ) => Promise<void>
   action: unknown extends TRouteInfo['actionResponse']
     ?
@@ -84,22 +88,23 @@ export interface Route<
 export function createRoute<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
   TRouteInfo extends AnyRouteInfo = RouteInfo,
+  TRouterContext = unknown,
 >(
   routeConfig: RouteConfig,
   options: TRouteInfo['options'],
   parent: undefined | Route<TAllRouteInfo, any>,
-  router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>,
-): Route<TAllRouteInfo, TRouteInfo> {
+  router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>,
+): Route<TAllRouteInfo, TRouteInfo, TRouterContext> {
   const { id, routeId, path: routePath, fullPath } = routeConfig
 
   const action =
     router.state.actions[id] ||
     (() => {
       router.state.actions[id] = {
-        pending: [],
+        submissions: [],
         submit: async <T, U>(
           submission: T,
-          actionOpts?: { invalidate?: boolean },
+          actionOpts?: { invalidate?: boolean; multi?: boolean },
         ) => {
           if (!route) {
             return
@@ -107,27 +112,27 @@ export function createRoute<
 
           const invalidate = actionOpts?.invalidate ?? true
 
+          if (!actionOpts?.multi) {
+            action.submissions = action.submissions.filter((d) => d.isMulti)
+          }
+
           const actionState: ActionState<T, U> = {
             submittedAt: Date.now(),
             status: 'pending',
             submission,
+            isMulti: !!actionOpts?.multi,
           }
 
           action.current = actionState
           action.latest = actionState
-          action.pending.push(actionState)
-
-          router.state = {
-            ...router.state,
-            currentAction: actionState,
-            latestAction: actionState,
-          }
+          action.submissions.push(actionState)
 
           router.notify()
 
           try {
             const res = await route.options.action?.(submission)
             actionState.data = res as U
+
             if (invalidate) {
               router.invalidateRoute({ to: '.', fromCurrent: true })
               await router.reload()
@@ -135,12 +140,11 @@ export function createRoute<
             actionState.status = 'success'
             return res
           } catch (err) {
+            console.log('tanner')
             console.error(err)
             actionState.error = err
             actionState.status = 'error'
           } finally {
-            action.pending = action.pending.filter((d) => d !== actionState)
-            router.removeActionQueue.push({ action, actionState })
             router.notify()
           }
         },
@@ -187,7 +191,8 @@ export function createRoute<
       return router.state.loaders[id]!
     })()
 
-  let route: Route<TAllRouteInfo, TRouteInfo> = {
+  let route: Route<TAllRouteInfo, TRouteInfo, TRouterContext> = {
+    routeInfo: undefined!,
     routeId: id,
     routeRouteId: routeId,
     routePath,
@@ -228,16 +233,3 @@ export function createRoute<
 
   return route
 }
-
-export function cascadeLoaderData(matches: RouteMatch<any, any>[]) {
-  matches.forEach((match, index) => {
-    const parent = matches[index - 1]
-
-    if (parent) {
-      match.loaderData = replaceEqualDeep(match.loaderData, {
-        ...parent.loaderData,
-        ...match.routeLoaderData,
-      })
-    }
-  })
-}

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. `,
+      )
+    },
   }
 }