@tanstack/react-router 0.0.1-beta.207 → 0.0.1-beta.209

package/build/types/RouteMatch.d.ts

@@ -14,7 +14,7 @@ export interface RouteMatch<TRouteTree extends AnyRoute = AnyRoute, TRouteId ext
     updatedAt: number;
     loadPromise?: Promise<void>;
     __resolveLoadPromise?: () => void;
-    meta: RouteById<TRouteTree, TRouteId>['types']['allMeta'];
+    context: RouteById<TRouteTree, TRouteId>['types']['allContext'];
     routeSearch: RouteById<TRouteTree, TRouteId>['types']['searchSchema'];
     search: FullSearchSchema<TRouteTree> & RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'];
     fetchedAt: number;

package/build/types/fileRoute.d.ts

@@ -1,4 +1,4 @@
-import { AnyRoute, ResolveFullPath, RouteMeta, AnyContext, RouteOptions, UpdatableRouteOptions, Route, AnyPathParams, RootRouteId, TrimPathLeft, RouteConstraints } from './route';
+import { AnyRoute, ResolveFullPath, RouteContext, AnyContext, RouteOptions, UpdatableRouteOptions, Route, AnyPathParams, RootRouteId, TrimPathLeft, RouteConstraints } from './route';
 import { Assign, Expand, IsAny } from './utils';
 export interface FileRoutesByPath {
 }
@@ -12,6 +12,21 @@ export type FileRoutePath<TParentRoute extends AnyRoute, TFilePath extends strin
 export declare class FileRoute<TFilePath extends keyof FileRoutesByPath, TParentRoute extends AnyRoute = FileRoutesByPath[TFilePath]['parentRoute'], TId extends RouteConstraints['TId'] = TFilePath, TPath extends RouteConstraints['TPath'] = FileRoutePath<TParentRoute, TFilePath>, TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, RemoveUnderScores<TPath>>> {
     path: TFilePath;
     constructor(path: TFilePath);
-    createRoute: <TSearchSchema extends import("./route").AnySearchSchema = {}, TFullSearchSchema extends import("./route").AnySearchSchema = Expand<Assign<import("./route").InferFullSearchSchema<TParentRoute>, TSearchSchema>>, TParams extends Record<string, any> = (TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> extends infer T ? T extends TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> ? T extends `$${infer L}` ? L : never : never : never) extends never ? AnyPathParams : Record<TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> extends infer T ? T extends TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> ? T extends `$${infer L}` ? L : never : never : never, string>, TAllParams extends Record<string, any> = IsAny<TParentRoute["types"]["allParams"], TParams, TParentRoute["types"]["allParams"] & TParams>, TRouteMeta extends RouteMeta = RouteMeta, TContext extends Expand<Assign<IsAny<TParentRoute["types"]["allMeta"], {}, TParentRoute["types"]["allMeta"]>, TRouteMeta>> = Expand<Assign<IsAny<TParentRoute["types"]["allMeta"], {}, TParentRoute["types"]["allMeta"]>, TRouteMeta>>, TRouterMeta extends AnyContext = AnyContext, TChildren extends unknown = unknown, TRouteTree extends AnyRoute = AnyRoute>(options: Omit<RouteOptions<TParentRoute, string, string, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TContext>, "id" | "path" | "getParentRoute"> & UpdatableRouteOptions<TFullSearchSchema, TAllParams, TContext>) => Route<TParentRoute, TPath, TFullPath, TFilePath, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TContext, TRouterMeta, TChildren, TRouteTree>;
+    createRoute: <TSearchSchema extends import("./route").AnySearchSchema = {}, TFullSearchSchema extends import("./route").AnySearchSchema = Expand<Assign<import("./route").InferFullSearchSchema<TParentRoute>, TSearchSchema>>, TParams extends Record<string, any> = (TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> extends infer T ? T extends TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> ? T extends `$${infer L}` ? L : never : never : never) extends never ? AnyPathParams : Record<TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> extends infer T ? T extends TrimLeft<TrimRight<import("./link").Split<TPath, true>[number], "_">, "_"> ? T extends `$${infer L}` ? L : never : never : never, string>, TAllParams extends Record<string, any> = IsAny<TParentRoute["types"]["allParams"], TParams, TParentRoute["types"]["allParams"] & TParams>, TRouteContext extends RouteContext = RouteContext, TContext extends Expand<Assign<IsAny<TParentRoute["types"]["allContext"], {}, TParentRoute["types"]["allContext"]>, TRouteContext>> = Expand<Assign<IsAny<TParentRoute["types"]["allContext"], {}, TParentRoute["types"]["allContext"]>, TRouteContext>>, TRouterContext extends AnyContext = AnyContext, TChildren extends unknown = unknown, TRouteTree extends AnyRoute = AnyRoute>(options: Omit<RouteOptions<TParentRoute, string, string, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext>, "id" | "path" | "getParentRoute"> & {
+        meta?: import("./route").RouteMeta | undefined;
+    } & {
+        caseSensitive?: boolean | undefined;
+        wrapInSuspense?: boolean | undefined;
+        component?: import("./react").RouteComponent<TFullSearchSchema, TAllParams, TContext> | undefined;
+        errorComponent?: import("./react").ErrorRouteComponent<TFullSearchSchema, TAllParams, {}> | undefined;
+        pendingComponent?: import("./react").PendingRouteComponent<TFullSearchSchema, TAllParams, TContext> | undefined;
+        preSearchFilters?: import("./route").SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
+        postSearchFilters?: import("./route").SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
+        onError?: ((err: any) => void) | undefined;
+        onEnter?: ((match: import("./RouteMatch").AnyRouteMatch) => void) | undefined;
+        onTransition?: ((match: import("./RouteMatch").AnyRouteMatch) => void) | undefined;
+        onLeave?: ((match: import("./RouteMatch").AnyRouteMatch) => void) | undefined;
+        reloadOnWindowFocus?: boolean | undefined;
+    }) => Route<TParentRoute, TPath, TFullPath, TFilePath, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext, TRouterContext, TChildren, TRouteTree>;
 }
 export {};

package/build/types/react.d.ts

@@ -10,7 +10,7 @@ export type RouteProps<TFullSearchSchema extends Record<string, any> = AnySearch
     useMatch: <TSelected = TAllContext>(opts?: {
         select?: (search: TAllContext) => TSelected;
     }) => TSelected;
-    useRouteMeta: <TSelected = TAllContext>(opts?: {
+    useRouteContext: <TSelected = TAllContext>(opts?: {
         select?: (search: TAllContext) => TSelected;
     }) => TSelected;
     useSearch: <TSelected = TFullSearchSchema>(opts?: {
@@ -66,7 +66,7 @@ export declare function Navigate<TRouteTree extends AnyRoute = RegisteredRouter[
 export declare const matchesContext: React.Context<RouteMatch<AnyRoute, any>[]>;
 export type RouterProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated>, 'context'> & {
     router: Router<TRouteTree>;
-    context?: Partial<RouterOptions<TRouteTree, TDehydrated>['meta']>;
+    context?: Partial<RouterOptions<TRouteTree, TDehydrated>['context']>;
 };
 export declare function useRouter<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(): RouterContext<TRouteTree>;
 export declare function useRouterState<TSelected = RouterState<RegisteredRouter['routeTree']>>(opts?: {
@@ -86,8 +86,8 @@ export declare function useMatch<TRouteTree extends AnyRoute = RegisteredRouter[
     select?: (match: TRouteMatchState) => TSelected;
 }): TStrict extends true ? TRouteMatchState : TRouteMatchState | undefined;
 export type RouteFromIdOrRoute<T, TRouteTree extends AnyRoute = RegisteredRouter['routeTree']> = T extends ParseRoute<TRouteTree> ? T : T extends RouteIds<TRouteTree> ? RoutesById<TRouteTree>[T] : T extends string ? RouteIds<TRouteTree> : never;
-export declare function useRouteMeta<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMeta = RouteById<TRouteTree, TFrom>['types']['allMeta'], TSelected = TRouteMeta>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TRouteMeta) => TSelected;
+export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TRouteContext) => TSelected;
 }): TStrict extends true ? TSelected : TSelected | undefined;
 export declare function useSearch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TSearch = RouteById<TRouteTree, TFrom>['types']['fullSearchSchema'], TSelected = TSearch>(opts: StrictOrFrom<TFrom> & {
     select?: (search: TSearch) => TSelected;
@@ -98,6 +98,7 @@ export declare function useParams<TRouteTree extends AnyRoute = RegisteredRouter
 export declare function useNavigate<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDefaultFrom extends RoutePaths<TRouteTree> = '/'>(defaultOpts?: {
     from?: TDefaultFrom;
 }): <TFrom extends RoutePaths<TRouteTree> = TDefaultFrom, TTo extends string = "", TMaskFrom extends RoutePaths<TRouteTree> = "/", TMaskTo extends string = "">(opts?: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> | undefined) => Promise<void>;
+export declare function typedNavigate<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDefaultFrom extends RoutePaths<TRouteTree> = '/'>(navigate: (opts: NavigateOptions<any>) => Promise<void>): <TFrom extends RoutePaths<TRouteTree> = TDefaultFrom, TTo extends string = "", TMaskFrom extends RoutePaths<TRouteTree> = "/", TMaskTo extends string = "">(opts?: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> | undefined) => Promise<void>;
 export declare function useMatchRoute<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(): <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "", TMaskFrom extends RoutePaths<TRouteTree> = "/", TMaskTo extends string = "", TResolved extends string = ResolveRelativePath<TFrom, NoInfer<TTo>>>(opts: MakeUseMatchRouteOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
 export declare function Matches(): JSX.Element;
 export declare function MatchRoute<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TMaskFrom extends RoutePaths<TRouteTree> = '/', TMaskTo extends string = ''>(props: MakeMatchRouteOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>): any;

package/build/types/route.d.ts

@@ -2,7 +2,7 @@ import { RoutePaths } from './routeInfo';
 import { AnyRouter } from './router';
 import { AnyRouteMatch } from './RouteMatch';
 import { Expand, IsAny, NoInfer, PickRequired, UnionToIntersection, Assign } from './utils';
-import { ParsePathParams, ToSubOptions } from './link';
+import { NavigateOptions, ParsePathParams, ToSubOptions } from './link';
 import { ErrorRouteComponent, PendingRouteComponent, RouteComponent } from './react';
 import { ParsedLocation } from './location';
 export declare const rootRouteId: "__root__";
@@ -10,6 +10,8 @@ export type RootRouteId = typeof rootRouteId;
 export type AnyPathParams = {};
 export type AnySearchSchema = {};
 export type AnyContext = {};
+export interface RouteContext {
+}
 export interface RouteMeta {
 }
 export type PreloadableObj = {
@@ -21,17 +23,22 @@ export type RoutePathOptions<TCustomId, TPath> = {
     id: TCustomId;
 };
 export type RoutePathOptionsIntersection<TCustomId, TPath> = UnionToIntersection<RoutePathOptions<TCustomId, TPath>>;
-export type RouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchSchema extends Record<string, any> = {}, TFullSearchSchema extends Record<string, any> = TSearchSchema, TParams extends AnyPathParams = AnyPathParams, TAllParams extends AnyPathParams = TParams, TRouteMeta extends RouteMeta = RouteMeta, TAllMeta extends Record<string, any> = AnyContext> = BaseRouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TAllMeta> & NoInfer<UpdatableRouteOptions<TFullSearchSchema, TAllParams, TAllMeta>>;
+export type MetaOptions = keyof PickRequired<RouteMeta> extends never ? {
+    meta?: RouteMeta;
+} : {
+    meta: RouteMeta;
+};
+export type RouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchSchema extends Record<string, any> = {}, TFullSearchSchema extends Record<string, any> = TSearchSchema, TParams extends AnyPathParams = AnyPathParams, TAllParams extends AnyPathParams = TParams, TRouteContext extends RouteContext = RouteContext, TAllContext extends Record<string, any> = AnyContext> = BaseRouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext> & NoInfer<UpdatableRouteOptions<TFullSearchSchema, TAllParams, TAllContext>>;
 export type ParamsFallback<TPath extends string, TParams> = unknown extends TParams ? Record<ParsePathParams<TPath>, string> : TParams;
-export type BaseRouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchSchema extends Record<string, any> = {}, TFullSearchSchema extends Record<string, any> = TSearchSchema, TParams extends AnyPathParams = {}, TAllParams = ParamsFallback<TPath, TParams>, TRouteMeta extends RouteMeta = RouteMeta, TAllContext extends Record<string, any> = AnyContext> = RoutePathOptions<TCustomId, TPath> & {
+export type BaseRouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchSchema extends Record<string, any> = {}, TFullSearchSchema extends Record<string, any> = TSearchSchema, TParams extends AnyPathParams = {}, TAllParams = ParamsFallback<TPath, TParams>, TRouteContext extends RouteContext = RouteContext, TAllContext extends Record<string, any> = AnyContext> = RoutePathOptions<TCustomId, TPath> & {
     getParentRoute: () => TParentRoute;
     validateSearch?: SearchSchemaValidator<TSearchSchema>;
-} & (keyof PickRequired<RouteMeta> extends never ? {
-    beforeLoad?: BeforeLoadFn<TFullSearchSchema, TParentRoute, TAllParams, TRouteMeta>;
+} & (keyof PickRequired<RouteContext> extends never ? {
+    beforeLoad?: BeforeLoadFn<TFullSearchSchema, TParentRoute, TAllParams, TRouteContext>;
 } : {
-    beforeLoad: BeforeLoadFn<TFullSearchSchema, TParentRoute, TAllParams, TRouteMeta>;
+    beforeLoad: BeforeLoadFn<TFullSearchSchema, TParentRoute, TAllParams, TRouteContext>;
 }) & {
-    load?: RouteLoadFn<TAllParams, TFullSearchSchema, NoInfer<TAllContext>, NoInfer<TRouteMeta>>;
+    load?: RouteLoadFn<TAllParams, TFullSearchSchema, NoInfer<TAllContext>, NoInfer<TRouteContext>>;
 } & ({
     parseParams?: (rawParams: IsAny<TPath, any, Record<ParsePathParams<TPath>, string>>) => TParams extends Record<ParsePathParams<TPath>, any> ? TParams : 'parseParams must return an object';
     stringifyParams?: (params: NoInfer<ParamsFallback<TPath, TParams>>) => Record<ParsePathParams<TPath>, string>;
@@ -39,15 +46,16 @@ export type BaseRouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId
     stringifyParams?: never;
     parseParams?: never;
 });
-type BeforeLoadFn<TFullSearchSchema extends Record<string, any>, TParentRoute extends AnyRoute, TAllParams, TRouteMeta> = (opts: {
+type BeforeLoadFn<TFullSearchSchema extends Record<string, any>, TParentRoute extends AnyRoute, TAllParams, TRouteContext> = (opts: {
     search: TFullSearchSchema;
     abortController: AbortController;
     preload: boolean;
     params: TAllParams;
-    meta: TParentRoute['types']['allMeta'];
+    context: TParentRoute['types']['allContext'];
     location: ParsedLocation;
-}) => Promise<TRouteMeta> | TRouteMeta | void;
-export type UpdatableRouteOptions<TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends AnyContext> = {
+    navigate: (opts: NavigateOptions<AnyRoute>) => Promise<void>;
+}) => Promise<TRouteContext> | TRouteContext | void;
+export type UpdatableRouteOptions<TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends AnyContext> = MetaOptions & {
     caseSensitive?: boolean;
     wrapInSuspense?: boolean;
     component?: RouteComponent<TFullSearchSchema, TAllParams, TAllContext>;
@@ -75,15 +83,17 @@ export type DefinedPathParamWarning = 'Path params cannot be redefined by child
 export type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
     [Key in keyof TParentParams]?: DefinedPathParamWarning;
 };
-export type RouteLoadFn<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteMeta extends Record<string, any> = AnyContext> = (match: LoadFnContext<TAllParams, TFullSearchSchema, TAllContext, TRouteMeta> & {
+export type RouteLoadFn<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteContext extends Record<string, any> = AnyContext> = (match: LoadFnContext<TAllParams, TFullSearchSchema, TAllContext, TRouteContext> & {
     parentMatchPromise?: Promise<void>;
 }) => any;
-export interface LoadFnContext<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteMeta extends Record<string, any> = AnyContext> {
+export interface LoadFnContext<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteContext extends Record<string, any> = AnyContext> {
     abortController: AbortController;
     preload: boolean;
     params: TAllParams;
     search: TFullSearchSchema;
-    meta: Expand<Assign<TAllContext, TRouteMeta>>;
+    context: Expand<Assign<TAllContext, TRouteContext>>;
+    location: ParsedLocation<TFullSearchSchema>;
+    navigate: (opts: NavigateOptions<AnyRoute>) => Promise<void>;
 }
 export type SearchFilter<T, U = T> = (prev: T) => U;
 export type ResolveId<TParentRoute, TCustomId extends string, TPath extends string> = TParentRoute extends {
@@ -116,16 +126,16 @@ export type RouteConstraints = {
     TParams: Record<string, any>;
     TAllParams: Record<string, any>;
     TParentContext: AnyContext;
-    TRouteMeta: RouteMeta;
+    TRouteContext: RouteContext;
     TAllContext: AnyContext;
-    TRouterMeta: AnyContext;
+    TRouterContext: AnyContext;
     TChildren: unknown;
     TRouteTree: AnyRoute;
 };
-export declare class Route<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TSearchSchema extends RouteConstraints['TSearchSchema'] = {}, TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<TParentRoute, TSearchSchema>, TParams extends RouteConstraints['TParams'] = Expand<Record<ParsePathParams<TPath>, string>>, TAllParams extends RouteConstraints['TAllParams'] = ResolveAllParams<TParentRoute, TParams>, TRouteMeta extends RouteConstraints['TRouteMeta'] = RouteMeta, TAllMeta extends Expand<Assign<IsAny<TParentRoute['types']['allMeta'], {}>, TRouteMeta>> = Expand<Assign<IsAny<TParentRoute['types']['allMeta'], {}>, TRouteMeta>>, TRouterMeta extends RouteConstraints['TRouterMeta'] = AnyContext, TChildren extends RouteConstraints['TChildren'] = unknown, TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute> {
+export declare class Route<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TSearchSchema extends RouteConstraints['TSearchSchema'] = {}, TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<TParentRoute, TSearchSchema>, TParams extends RouteConstraints['TParams'] = Expand<Record<ParsePathParams<TPath>, string>>, TAllParams extends RouteConstraints['TAllParams'] = ResolveAllParams<TParentRoute, TParams>, TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext, TAllContext extends Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>> = Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>>, TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext, TChildren extends RouteConstraints['TChildren'] = unknown, TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute> {
     isRoot: TParentRoute extends Route<any> ? true : false;
-    options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TAllMeta>;
-    test: Expand<Assign<IsAny<TParentRoute['types']['allMeta'], {}>, TRouteMeta>>;
+    options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext>;
+    test: Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>>;
     parentRoute: TParentRoute;
     id: TId;
     path: TPath;
@@ -135,7 +145,7 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
     originalIndex?: number;
     router?: AnyRouter;
     rank: number;
-    constructor(options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TAllMeta>);
+    constructor(options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext>);
     types: {
         parentRoute: TParentRoute;
         path: TPath;
@@ -147,23 +157,23 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
         fullSearchSchema: TFullSearchSchema;
         params: TParams;
         allParams: TAllParams;
-        routeMeta: TRouteMeta;
-        allMeta: TAllMeta;
+        routeContext: TRouteContext;
+        allContext: TAllContext;
         children: TChildren;
         routeTree: TRouteTree;
-        routerMeta: TRouterMeta;
+        routerContext: TRouterContext;
     };
     init: (opts: {
         originalIndex: number;
     }) => void;
-    addChildren: <TNewChildren extends AnyRoute[]>(children: TNewChildren) => Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteMeta, TAllMeta, TRouterMeta, TNewChildren, TRouteTree>;
-    update: (options: UpdatableRouteOptions<TFullSearchSchema, TAllParams, Expand<Assign<IsAny<TParentRoute['types']['allMeta'], {}>, TRouteMeta>>>) => this;
+    addChildren: <TNewChildren extends AnyRoute[]>(children: TNewChildren) => Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext, TRouterContext, TNewChildren, TRouteTree>;
+    update: (options: UpdatableRouteOptions<TFullSearchSchema, TAllParams, Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>>>) => this;
     static __onInit: (route: any) => void;
-    useMatch: <TSelected = TAllMeta>(opts?: {
-        select?: ((search: TAllMeta) => TSelected) | undefined;
+    useMatch: <TSelected = TAllContext>(opts?: {
+        select?: ((search: TAllContext) => TSelected) | undefined;
     } | undefined) => TSelected;
-    useRouteMeta: <TSelected = TAllMeta>(opts?: {
-        select?: ((search: TAllMeta) => TSelected) | undefined;
+    useRouteContext: <TSelected = TAllContext>(opts?: {
+        select?: ((search: TAllContext) => TSelected) | undefined;
     } | undefined) => TSelected;
     useSearch: <TSelected = TFullSearchSchema>(opts?: {
         select?: ((search: TFullSearchSchema) => TSelected) | undefined;
@@ -173,11 +183,8 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
     } | undefined) => TSelected;
 }
 export type AnyRootRoute = RootRoute<any, any, any>;
-export declare class RouterMeta<TRouterMeta extends {}> {
-    constructor();
-    createRootRoute: <TSearchSchema extends Record<string, any> = {}, TRouteMeta extends RouteMeta = RouteMeta>(options?: Omit<RouteOptions<AnyRoute, "__root__", "", TSearchSchema, TSearchSchema, {}, {}, TRouteMeta, Assign<TRouterMeta, TRouteMeta>>, "id" | "path" | "getParentRoute" | "stringifyParams" | "parseParams" | "caseSensitive"> | undefined) => RootRoute<TSearchSchema, TRouteMeta, TRouterMeta>;
-}
-export declare class RootRoute<TSearchSchema extends Record<string, any> = {}, TRouteMeta extends RouteMeta = RouteMeta, TRouterMeta extends {} = {}> extends Route<any, // TParentRoute
+export declare function rootRouteWithContext<TRouterContext extends {}>(): <TSearchSchema extends Record<string, any> = {}, TRouteContext extends RouteContext = RouteContext>(options?: Omit<RouteOptions<AnyRoute, "__root__", "", TSearchSchema, TSearchSchema, {}, {}, TRouteContext, Assign<TRouterContext, TRouteContext>>, "id" | "path" | "getParentRoute" | "stringifyParams" | "parseParams" | "caseSensitive"> | undefined) => RootRoute<TSearchSchema, TRouteContext, TRouterContext>;
+export declare class RootRoute<TSearchSchema extends Record<string, any> = {}, TRouteContext extends RouteContext = RouteContext, TRouterContext extends {} = {}> extends Route<any, // TParentRoute
 '/', // TPath
 '/', // TFullPath
 string, // TCustomId
@@ -186,9 +193,9 @@ TSearchSchema, // TSearchSchema
 TSearchSchema, // TFullSearchSchema
 {}, // TParams
 {}, // TAllParams
-TRouteMeta, // TRouteMeta
-Expand<Assign<TRouterMeta, TRouteMeta>>, // TAllContext
-TRouterMeta, // TRouterMeta
+TRouteContext, // TRouteContext
+Expand<Assign<TRouterContext, TRouteContext>>, // TAllContext
+TRouterContext, // TRouterContext
 any, // TChildren
 any> {
     constructor(options?: Omit<RouteOptions<AnyRoute, // TParentRoute
@@ -198,8 +205,8 @@ any> {
     TSearchSchema, // TFullSearchSchema
     {}, // TParams
     {}, // TAllParams
-    TRouteMeta, // TRouteMeta
-    Assign<TRouterMeta, TRouteMeta>>, 'path' | 'id' | 'getParentRoute' | 'caseSensitive' | 'parseParams' | 'stringifyParams'>);
+    TRouteContext, // TRouteContext
+    Assign<TRouterContext, TRouteContext>>, 'path' | 'id' | 'getParentRoute' | 'caseSensitive' | 'parseParams' | 'stringifyParams'>);
 }
 export type ResolveFullPath<TParentRoute extends AnyRoute, TPath extends string, TPrefixed = RoutePrefix<TParentRoute['fullPath'], TPath>> = TPrefixed extends RootRouteId ? '/' : TPrefixed;
 type RoutePrefix<TPrefix extends string, TPath extends string> = string extends TPath ? RootRouteId : TPath extends string ? TPrefix extends RootRouteId ? TPath extends '/' ? '/' : `/${TrimPath<TPath>}` : `${TPrefix}/${TPath}` extends '/' ? '/' : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TPath>}`>}` : never;

package/build/types/router.d.ts

@@ -25,10 +25,10 @@ export type HydrationCtx = {
     router: DehydratedRouter;
     payload: Record<string, any>;
 };
-export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends TRouteTree['types']['routerMeta'] ? {
-    meta?: TRouteTree['types']['routerMeta'];
+export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends TRouteTree['types']['routerContext'] ? {
+    context?: TRouteTree['types']['routerContext'];
 } : {
-    meta: TRouteTree['types']['routerMeta'];
+    context: TRouteTree['types']['routerContext'];
 };
 export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>> {
     history?: RouterHistory;
@@ -49,7 +49,7 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends
         route: AnyRoute;
         router: AnyRouter;
     }) => void;
-    meta?: TRouteTree['types']['routerMeta'];
+    context?: TRouteTree['types']['routerContext'];
     routeMasks?: RouteMask<TRouteTree>[];
     unmaskOnReload?: boolean;
 }
@@ -108,7 +108,7 @@ export type RouterListener<TRouterEvent extends RouterEvent> = {
     fn: ListenerFn<TRouterEvent>;
 };
 export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>> {
-    options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'meta'>;
+    options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
     routeTree: TRouteTree;
     constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated>);
     subscribers: Set<RouterListener<RouterEvent>>;

package/build/umd/index.development.js

@@ -813,7 +813,7 @@
     constructor(options) {
       this.options = {
         defaultPreloadDelay: 50,
-        meta: undefined,
+        context: undefined,
         ...options,
         stringifySearch: options?.stringifySearch ?? defaultStringifySearch,
         parseSearch: options?.parseSearch ?? defaultParseSearch
@@ -1017,9 +1017,9 @@
     const options = {
       ...router.options,
       ...rest,
-      meta: {
-        ...router.options.meta,
-        ...rest?.meta
+      context: {
+        ...router.options.context,
+        ...rest?.context
       }
     };
     const history = React__namespace.useState(() => options.history ?? createBrowserHistory())[0];
@@ -1228,16 +1228,16 @@
           paramsError: parseErrors[index],
           searchError: undefined,
           loadPromise: Promise.resolve(),
-          meta: undefined,
+          context: undefined,
           abortController: new AbortController(),
           fetchedAt: 0
         };
         return routeMatch;
       });
 
-      // Take each match and resolve its search params and meta
+      // Take each match and resolve its search params and context
       // This has to happen after the matches are created or found
-      // so that we can use the parent match's search params and meta
+      // so that we can use the parent match's search params and context
       matches.forEach((match, i) => {
         const parentMatch = matches[i - 1];
         const route = looseRoutesById[match.routeId];
@@ -1491,22 +1491,27 @@
             if (match.searchError) {
               handleError(match.searchError, 'VALIDATE_SEARCH');
             }
-            const parentMeta = parentMatch?.meta ?? options.meta ?? {};
-            const beforeLoadMeta = (await route.options.beforeLoad?.({
+            const parentContext = parentMatch?.context ?? options.context ?? {};
+            const beforeLoadContext = (await route.options.beforeLoad?.({
               search: match.search,
               abortController: match.abortController,
               params: match.params,
               preload: !!preload,
-              meta: parentMeta,
-              location: state.location // TODO: This might need to be latestLocationRef.current...?
+              context: parentContext,
+              location: state.location,
+              // TODO: This might need to be latestLocationRef.current...?
+              navigate: opts => navigate({
+                ...opts,
+                from: match.pathname
+              })
             })) ?? {};
-            const meta = {
-              ...parentMeta,
-              ...beforeLoadMeta
+            const context = {
+              ...parentContext,
+              ...beforeLoadContext
             };
             matches[index] = match = {
               ...match,
-              meta: replaceEqualDeep(match.meta, meta)
+              context: replaceEqualDeep(match.context, context)
             };
           } catch (err) {
             handleError(err, 'BEFORE_LOAD');
@@ -1552,7 +1557,12 @@
                 preload: !!preload,
                 parentMatchPromise,
                 abortController: match.abortController,
-                meta: match.meta
+                context: match.context,
+                location: state.location,
+                navigate: opts => navigate({
+                  ...opts,
+                  from: match.pathname
+                })
               });
               await Promise.all([componentsPromise, loaderPromise]);
               if (latestPromise = checkLatest()) return await latestPromise;
@@ -2102,10 +2112,10 @@
     });
     return matchSelection;
   }
-  function useRouteMeta(opts) {
+  function useRouteContext(opts) {
     return useMatch({
       ...opts,
-      select: match => opts?.select ? opts.select(match.meta) : match.meta
+      select: match => opts?.select ? opts.select(match.context) : match.context
     });
   }
   function useSearch(opts) {
@@ -2139,6 +2149,9 @@
       });
     }, []);
   }
+  function typedNavigate(navigate) {
+    return navigate;
+  }
   function useMatchRoute() {
     const {
       state,
@@ -2179,7 +2192,7 @@
       return /*#__PURE__*/React__namespace.createElement(ErrorComponent, {
         ...props,
         useMatch: route.useMatch,
-        useRouteMeta: route.useRouteMeta,
+        useRouteContext: route.useRouteContext,
         useSearch: route.useSearch,
         useParams: route.useParams
       });
@@ -2235,7 +2248,7 @@
       return /*#__PURE__*/React__namespace.createElement(routeErrorComponent, {
         ...props,
         useMatch: route.useMatch,
-        useRouteMeta: route.useRouteMeta,
+        useRouteContext: route.useRouteContext,
         useSearch: route.useSearch,
         useParams: route.useParams
       });
@@ -2245,7 +2258,7 @@
     }, /*#__PURE__*/React__namespace.createElement(ResolvedSuspenseBoundary, {
       fallback: /*#__PURE__*/React__namespace.createElement(PendingComponent, {
         useMatch: route.useMatch,
-        useRouteMeta: route.useRouteMeta,
+        useRouteContext: route.useRouteContext,
         useSearch: route.useSearch,
         useParams: route.useParams
       })
@@ -2278,7 +2291,7 @@
       if (comp) {
         return /*#__PURE__*/React__namespace.createElement(comp, {
           useMatch: route.useMatch,
-          useRouteMeta: route.useRouteMeta,
+          useRouteContext: route.useRouteContext,
           useSearch: route.useSearch,
           useParams: route.useParams
         });
@@ -2454,14 +2467,8 @@
 
   const rootRouteId = '__root__';
 
-  // export type MetaOptions = keyof PickRequired<RouteMeta> extends never
-  //   ? {
-  //       meta?: RouteMeta
-  //     }
-  //   : {
-  //       meta: RouteMeta
-  //     }
   // The parse type here allows a zod schema to be passed directly to the validator
+
   class Route {
     // Set up in this.init()
 
@@ -2525,11 +2532,11 @@
         from: this.id
       });
     };
-    useRouteMeta = opts => {
+    useRouteContext = opts => {
       return useMatch({
         ...opts,
         from: this.id,
-        select: d => opts?.select ? opts.select(d.meta) : d.meta
+        select: d => opts?.select ? opts.select(d.context) : d.context
       });
     };
     useSearch = opts => {
@@ -2545,9 +2552,8 @@
       });
     };
   }
-  class RouterMeta {
-    constructor() {}
-    createRootRoute = options => {
+  function rootRouteWithContext() {
+    return options => {
       return new RootRoute(options);
     };
   }
@@ -2585,7 +2591,6 @@
   exports.RootRoute = RootRoute;
   exports.Route = Route;
   exports.Router = Router;
-  exports.RouterMeta = RouterMeta;
   exports.RouterProvider = RouterProvider;
   exports.SearchParamError = SearchParamError;
   exports.cleanPath = cleanPath;
@@ -2621,12 +2626,14 @@
   exports.replaceEqualDeep = replaceEqualDeep;
   exports.resolvePath = resolvePath;
   exports.rootRouteId = rootRouteId;
+  exports.rootRouteWithContext = rootRouteWithContext;
   exports.routerContext = routerContext;
   exports.shallow = shallow;
   exports.stringifySearchWith = stringifySearchWith;
   exports.trimPath = trimPath;
   exports.trimPathLeft = trimPathLeft;
   exports.trimPathRight = trimPathRight;
+  exports.typedNavigate = typedNavigate;
   exports.useBlocker = useBlocker;
   exports.useLinkProps = useLinkProps;
   exports.useMatch = useMatch;
@@ -2634,7 +2641,7 @@
   exports.useMatches = useMatches;
   exports.useNavigate = useNavigate;
   exports.useParams = useParams;
-  exports.useRouteMeta = useRouteMeta;
+  exports.useRouteContext = useRouteContext;
   exports.useRouter = useRouter;
   exports.useRouterState = useRouterState;
   exports.useSearch = useSearch;