@tanstack/router-core 0.0.1-beta.2 → 0.0.1-beta.23

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/router-core",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.23",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -33,6 +33,7 @@
     "build/**",
     "src"
   ],
+  "sideEffects": false,
   "peerDependencies": {
     "react": ">=16",
     "react-dom": ">=16"

package/src/frameworks.ts

@@ -3,8 +3,7 @@ export interface FrameworkGenerics {
   // and are extended by framework adapters, but cannot be
   // pre-defined as constraints:
   //
-  // Element: any
-  // SyncOrAsyncElement?: any
+  // Component: 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,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/path.ts

@@ -155,10 +155,6 @@ export function matchPathname(
     return
   }
 
-  // if (matchLocation.search && !searchMatched) {
-  //   return
-  // }
-
   return pathParams ?? {}
 }
 

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,7 +21,7 @@ import {
   MatchRouteOptions,
   Router,
 } from './router'
-import { NoInfer, replaceEqualDeep } from './utils'
+import { NoInfer } from './utils'
 
 export interface AnyRoute extends Route<any, any> {}
 
@@ -96,10 +95,10 @@ export function createRoute<
     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 +106,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()
@@ -139,8 +138,6 @@ export function createRoute<
             actionState.error = err
             actionState.status = 'error'
           } finally {
-            action.pending = action.pending.filter((d) => d !== actionState)
-            router.removeActionQueue.push({ action, actionState })
             router.notify()
           }
         },
@@ -228,16 +225,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

@@ -3,6 +3,7 @@ import { ParsePathParams } from './link'
 import { joinPaths, trimPath, trimPathRight } from './path'
 import { RouteInfo } from './routeInfo'
 import { RouteMatch } from './routeMatch'
+import { RouterContext } from './router'
 import {
   DeepAwaited,
   Expand,
@@ -50,7 +51,7 @@ export type ParentParams<TParentParams> = AnyPathParams extends TParentParams
     }
 
 export type LoaderFn<
-  TRouteLoaderData extends AnyLoaderData,
+  TRouteLoaderData extends AnyLoaderData = {},
   TFullSearchSchema extends AnySearchSchema = {},
   TAllParams extends AnyPathParams = {},
 > = (
@@ -64,6 +65,7 @@ export interface LoaderContext<
   params: TAllParams
   search: TFullSearchSchema
   signal?: AbortSignal
+  // parentLoaderPromise?: Promise<TParentRouteLoaderData>
 }
 
 export type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (
@@ -77,6 +79,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,
@@ -108,18 +111,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<'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<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 +128,13 @@ 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: { context: RouterContext }) => 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,6 +174,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,
@@ -199,6 +197,7 @@ export interface RouteConfig<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
     TLoaderData,
     TActionPayload,
@@ -223,6 +222,7 @@ export interface RouteConfig<
       TRouteId,
       TPath,
       TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
       TLoaderData,
       TActionPayload,
@@ -245,6 +245,7 @@ export interface RouteConfig<
           false,
           TId,
           TFullPath,
+          TRouteLoaderData,
           TLoaderData,
           TFullSearchSchema,
           TAllParams
@@ -257,6 +258,7 @@ export interface RouteConfig<
       TRouteId,
       TPath,
       TFullPath,
+      TParentRouteLoaderData,
       TRouteLoaderData,
       TLoaderData,
       TActionPayload,
@@ -274,6 +276,7 @@ export interface RouteConfig<
     false,
     TId,
     TFullPath,
+    TRouteLoaderData,
     TLoaderData,
     TFullSearchSchema,
     TAllParams
@@ -284,7 +287,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 = {},
 > = <
@@ -315,8 +319,9 @@ type CreateRouteConfigFn<
         RouteOptions<
           TRouteId,
           TPath,
+          TParentRouteLoaderData,
           TRouteLoaderData,
-          Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+          Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
           TActionPayload,
           TActionResponse,
           TParentSearchSchema,
@@ -331,8 +336,9 @@ type CreateRouteConfigFn<
     : RouteOptions<
         TRouteId,
         TPath,
+        TParentRouteLoaderData,
         TRouteLoaderData,
-        Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
+        Expand<TParentLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>,
         TActionPayload,
         TActionResponse,
         TParentSearchSchema,
@@ -351,8 +357,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,
@@ -395,6 +402,7 @@ export interface AnyRouteConfig
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -414,6 +422,7 @@ export interface AnyRouteConfigWithChildren<TChildren>
     any,
     any,
     any,
+    any,
     TChildren
   > {}
 

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,7 @@ export interface AnyAllRouteInfo {
   routeInfoByFullPath: Record<string, AnyRouteInfo>
   routeIds: any
   routePaths: any
+  fullSearchSchema: Record<string, any>
 }
 
 export interface DefaultAllRouteInfo {
@@ -28,6 +29,7 @@ export interface DefaultAllRouteInfo {
   routeInfoByFullPath: Record<string, RouteInfo>
   routeIds: string
   routePaths: string
+  fullSearchSchema: AnySearchSchema
 }
 
 export interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig>
@@ -63,6 +65,7 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
   infer TRouteId,
   infer TPath,
   infer TFullPath,
+  infer TParentLoaderData,
   infer TRouteLoaderData,
   infer TLoaderData,
   infer TActionPayload,
@@ -82,6 +85,7 @@ export type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<
         TRouteId,
         TPath,
         TFullPath,
+        TParentLoaderData,
         TRouteLoaderData,
         TLoaderData,
         TActionPayload,
@@ -111,12 +115,13 @@ export interface RoutesInfoInner<
     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 +135,7 @@ export interface RoutesInfoInner<
   routeInfoByFullPath: TRouteInfoByFullPath
   routeIds: keyof TRouteInfoById
   routePaths: keyof TRouteInfoByFullPath
+  fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>
 }
 
 export interface AnyRouteInfo
@@ -147,6 +153,7 @@ export interface AnyRouteInfo
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -155,6 +162,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 +181,7 @@ export interface RouteInfo<
   routeId: TRouteId
   path: TPath
   fullPath: TFullPath
+  parentRouteLoaderData: TParentRouteLoaderData
   routeLoaderData: TRouteLoaderData
   loaderData: TLoaderData
   actionPayload: TActionPayload
@@ -185,6 +194,7 @@ export interface RouteInfo<
   options: RouteOptions<
     TRouteId,
     TPath,
+    TParentRouteLoaderData,
     TRouteLoaderData,
     TLoaderData,
     TActionPayload,