@tanstack/react-router 0.0.1-beta.222 → 0.0.1-beta.224

package/build/types/Matches.d.ts

@@ -1,10 +1,33 @@
 import * as React from 'react';
-import { RouteMatch } from './RouterProvider';
 import { ResolveRelativePath, ToOptions } from './link';
 import { AnyRoute, ReactNode } from './route';
-import { RouteById, RouteByPath, RouteIds, RoutePaths } from './routeInfo';
+import { FullSearchSchema, ParseRoute, RouteById, RouteByPath, RouteIds, RoutePaths } from './routeInfo';
 import { RegisteredRouter } from './router';
 import { NoInfer, StrictOrFrom } from './utils';
+export interface RouteMatch<TRouteTree extends AnyRoute = AnyRoute, TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id']> {
+    id: string;
+    routeId: TRouteId;
+    pathname: string;
+    params: RouteById<TRouteTree, TRouteId>['types']['allParams'];
+    status: 'pending' | 'success' | 'error';
+    isFetching: boolean;
+    invalid: boolean;
+    error: unknown;
+    paramsError: unknown;
+    searchError: unknown;
+    updatedAt: number;
+    loadPromise?: Promise<void>;
+    loaderData?: RouteById<TRouteTree, TRouteId>['types']['loaderData'];
+    __resolveLoadPromise?: () => void;
+    context: RouteById<TRouteTree, TRouteId>['types']['allContext'];
+    routeSearch: RouteById<TRouteTree, TRouteId>['types']['searchSchema'];
+    search: FullSearchSchema<TRouteTree> & RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'];
+    fetchedAt: number;
+    shouldReloadDeps: any;
+    abortController: AbortController;
+    cause: 'enter' | 'stay';
+}
+export type AnyRouteMatch = RouteMatch<any>;
 export declare function Matches(): JSX.Element;
 export declare function Match({ matches }: {
     matches: RouteMatch[];

package/build/types/RouterProvider.d.ts

@@ -1,12 +1,12 @@
-import { RouterHistory } from '@tanstack/history';
 import * as React from 'react';
 import { LinkInfo, LinkOptions, NavigateOptions, ResolveRelativePath, ToOptions } from './link';
 import { ParsedLocation } from './location';
 import { AnyRoute } from './route';
-import { FullSearchSchema, ParseRoute, RouteById, RouteIds, RoutePaths, RoutesById } from './routeInfo';
+import { RouteById, RoutePaths } from './routeInfo';
 import { BuildNextOptions, DehydratedRouteMatch, RegisteredRouter, Router, RouterOptions, RouterState } from './router';
 import { NoInfer } from './utils';
 import { MatchRouteOptions } from './Matches';
+import { RouteMatch } from './Matches';
 export interface CommitLocationOptions {
     replace?: boolean;
     resetScroll?: boolean;
@@ -28,25 +28,7 @@ export type LoadFn = (opts?: {
 }) => Promise<void>;
 export type BuildLocationFn<TRouteTree extends AnyRoute> = (opts: BuildNextOptions) => ParsedLocation;
 export type InjectedHtmlEntry = string | (() => Promise<string> | string);
-export type RouterContext<TRouteTree extends AnyRoute> = {
-    buildLink: BuildLinkFn<TRouteTree>;
-    state: RouterState<TRouteTree>;
-    navigate: NavigateFn<TRouteTree>;
-    matchRoute: MatchRouteFn<TRouteTree>;
-    routeTree: TRouteTree;
-    routesById: RoutesById<TRouteTree>;
-    options: RouterOptions<TRouteTree>;
-    history: RouterHistory;
-    load: LoadFn;
-    buildLocation: BuildLocationFn<TRouteTree>;
-    subscribe: Router<TRouteTree>['subscribe'];
-    resetNextScrollRef: React.MutableRefObject<boolean>;
-    injectedHtmlRef: React.MutableRefObject<InjectedHtmlEntry[]>;
-    injectHtml: (entry: InjectedHtmlEntry) => void;
-    dehydrateData: <T>(key: any, getData: T | (() => Promise<T> | T)) => () => void;
-    hydrateData: <T>(key: any) => T | undefined;
-};
-export declare const routerContext: React.Context<RouterContext<any>>;
+export declare const routerContext: React.Context<Router<any, Record<string, any>>>;
 export declare class SearchParamError extends Error {
 }
 export declare class PathParamError extends Error {
@@ -61,27 +43,4 @@ export type RouterProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTre
     router: Router<TRouteTree>;
     context?: Partial<RouterOptions<TRouteTree, TDehydrated>['context']>;
 };
-export declare function useRouter<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(): RouterContext<TRouteTree>;
-export interface RouteMatch<TRouteTree extends AnyRoute = AnyRoute, TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id']> {
-    id: string;
-    routeId: TRouteId;
-    pathname: string;
-    params: RouteById<TRouteTree, TRouteId>['types']['allParams'];
-    status: 'pending' | 'success' | 'error';
-    isFetching: boolean;
-    invalid: boolean;
-    error: unknown;
-    paramsError: unknown;
-    searchError: unknown;
-    updatedAt: number;
-    loadPromise?: Promise<void>;
-    loaderData?: RouteById<TRouteTree, TRouteId>['types']['loaderData'];
-    __resolveLoadPromise?: () => void;
-    context: RouteById<TRouteTree, TRouteId>['types']['allContext'];
-    routeSearch: RouteById<TRouteTree, TRouteId>['types']['searchSchema'];
-    search: FullSearchSchema<TRouteTree> & RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'];
-    fetchedAt: number;
-    shouldReloadDeps: any;
-    abortController: AbortController;
-}
-export type AnyRouteMatch = RouteMatch<any>;
+export declare function useRouter<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(): Router<TRouteTree>;

package/build/types/fileRoute.d.ts

@@ -12,7 +12,7 @@ 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>, 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, TLoaderData extends unknown = unknown, TChildren extends unknown = unknown, TRouteTree extends AnyRoute = AnyRoute>(options: Omit<RouteOptions<TParentRoute, string, string, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext, TLoaderData>, "path" | "id" | "getParentRoute"> & {
+    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, TLoaderData extends unknown = unknown, TChildren extends unknown = unknown, TRouteTree extends AnyRoute = AnyRoute>(options?: (Omit<RouteOptions<TParentRoute, string, string, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext, TLoaderData>, "path" | "id" | "getParentRoute"> & {
         meta?: import("./route").RouteMeta | undefined;
     } & {
         caseSensitive?: boolean | undefined;
@@ -23,10 +23,10 @@ export declare class FileRoute<TFilePath extends keyof FileRoutesByPath, TParent
         preSearchFilters?: import("./route").SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
         postSearchFilters?: import("./route").SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
         onError?: ((err: any) => void) | undefined;
-        onEnter?: ((match: import("./RouterProvider").AnyRouteMatch) => void) | undefined;
-        onTransition?: ((match: import("./RouterProvider").AnyRouteMatch) => void) | undefined;
-        onLeave?: ((match: import("./RouterProvider").AnyRouteMatch) => void) | undefined;
+        onEnter?: ((match: import("./Matches").AnyRouteMatch) => void) | undefined;
+        onTransition?: ((match: import("./Matches").AnyRouteMatch) => void) | undefined;
+        onLeave?: ((match: import("./Matches").AnyRouteMatch) => void) | undefined;
         reloadOnWindowFocus?: boolean | undefined;
-    }) => Route<TParentRoute, TPath, TFullPath, TFilePath, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext, TRouterContext, TLoaderData, TChildren, TRouteTree>;
+    }) | undefined) => Route<TParentRoute, TPath, TFullPath, TFilePath, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TContext, TRouterContext, TLoaderData, TChildren, TRouteTree>;
 }
 export {};

package/build/types/route.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { AnyRouteMatch } from './RouterProvider';
+import { AnyRouteMatch } from './Matches';
 import { NavigateOptions, ParsePathParams, ToSubOptions } from './link';
 import { ParsedLocation } from './location';
 import { RoutePaths } from './routeInfo';
@@ -57,6 +57,7 @@ type BeforeLoadFn<TFullSearchSchema extends Record<string, any>, TParentRoute ex
     location: ParsedLocation;
     navigate: NavigateFn<AnyRoute>;
     buildLocation: BuildLocationFn<AnyRoute>;
+    cause: 'enter' | 'stay';
 }) => Promise<TRouteContext> | TRouteContext | void;
 export type UpdatableRouteOptions<TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends AnyContext, TLoaderData extends any = unknown> = MetaOptions & {
     caseSensitive?: boolean;
@@ -267,4 +268,5 @@ export type RouteComponent<TFullSearchSchema extends Record<string, any>, TAllPa
 export type ErrorRouteComponent<TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends Record<string, any>> = AsyncRouteComponent<ErrorRouteProps<TFullSearchSchema, TAllParams, TAllContext>>;
 export type PendingRouteComponent<TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends Record<string, any>> = AsyncRouteComponent<PendingRouteProps<TFullSearchSchema, TAllParams, TAllContext>>;
 export type AnyRouteComponent = RouteComponent<any, any, any, any>;
+export type ComponentPropsFromRoute<TRoute> = TRoute extends (() => infer T extends AnyRoute) ? ComponentPropsFromRoute<T> : TRoute extends Route<infer TParentRoute, infer TPath, infer TFullPath, infer TCustomId, infer TId, infer TSearchSchema, infer TFullSearchSchema, infer TParams, infer TAllParams, infer TRouteContext, infer TAllContext, infer TRouterContext, infer TLoaderData, infer TChildren> ? RouteProps<TFullSearchSchema, TAllParams, TAllContext, TLoaderData> : {};
 export {};

package/build/types/router.d.ts

@@ -1,18 +1,19 @@
 /// <reference types="react" />
+/// <reference types="node" />
 import { RouterHistory } from '@tanstack/history';
 import { AnySearchSchema, AnyRoute, AnyContext, AnyPathParams, RouteMask } from './route';
-import { FullSearchSchema } from './routeInfo';
+import { FullSearchSchema, RoutesById, RoutesByPath } from './routeInfo';
 import { PickAsRequired, Updater, NonNullableUpdater } from './utils';
 import { ErrorRouteComponent, PendingRouteComponent, RouteComponent } from './route';
-import { RouteMatch } from './RouterProvider';
+import { AnyRouteMatch, RouteMatch } from './Matches';
 import { ParsedLocation } from './location';
 import { LocationState } from './location';
 import { SearchSerializer, SearchParser } from './searchParams';
-import { RouterContext } from './RouterProvider';
+import { BuildLinkFn, BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, LoadFn, MatchRouteFn, NavigateFn } from './RouterProvider';
 declare global {
     interface Window {
         __TSR_DEHYDRATED__?: HydrationCtx;
-        __TSR_ROUTER_CONTEXT__?: React.Context<RouterContext<any>>;
+        __TSR_ROUTER_CONTEXT__?: React.Context<Router<any>>;
     }
 }
 export interface Register {
@@ -113,11 +114,55 @@ 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>> {
+    tempLocationKey: string | undefined;
+    resetNextScroll: boolean;
+    navigateTimeout: NodeJS.Timeout | null;
+    latestLoadPromise: Promise<void>;
+    subscribers: Set<RouterListener<RouterEvent>>;
+    pendingMatches: AnyRouteMatch[];
+    injectedHtml: InjectedHtmlEntry[];
+    dehydratedData?: TDehydrated;
+    state: RouterState<TRouteTree>;
     options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    history: RouterHistory;
+    latestLocation: ParsedLocation;
+    basepath: string;
     routeTree: TRouteTree;
+    routesById: RoutesById<TRouteTree>;
+    routesByPath: RoutesByPath<TRouteTree>;
+    flatRoutes: AnyRoute[];
     constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated>);
-    subscribers: Set<RouterListener<RouterEvent>>;
+    startReactTransition: (fn: () => void) => void;
+    setState: (fn: (s: RouterState<TRouteTree>) => RouterState<TRouteTree>) => void;
+    updateOptions: (newOptions: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>) => void;
+    buildRouteTree: () => void;
     subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
     emit: (routerEvent: RouterEvent) => void;
+    checkLatest: (promise: Promise<void>) => undefined | Promise<void>;
+    parseLocation: (previousLocation?: ParsedLocation) => ParsedLocation<FullSearchSchema<TRouteTree>>;
+    resolvePathWithBase: (from: string, path: string) => string;
+    get looseRoutesById(): Record<string, AnyRoute>;
+    matchRoutes: <TRouteTree_1 extends AnyRoute>(pathname: string, locationSearch: AnySearchSchema, opts?: {
+        throwOnError?: boolean;
+        debug?: boolean;
+    }) => RouteMatch<TRouteTree_1, import("./routeInfo").ParseRoute<TRouteTree_1>["id"]>[];
+    cancelMatch: (id: string) => void;
+    cancelMatches: () => void;
+    buildLocation: BuildLocationFn<TRouteTree>;
+    commitLocation: ({ startTransition, ...next }: ParsedLocation & CommitLocationOptions) => Promise<void>;
+    buildAndCommitLocation: ({ replace, resetScroll, startTransition, ...rest }?: BuildNextOptions & CommitLocationOptions) => Promise<void>;
+    navigate: NavigateFn<TRouteTree>;
+    loadMatches: ({ checkLatest, matches, preload, }: {
+        checkLatest: () => Promise<void> | undefined;
+        matches: AnyRouteMatch[];
+        preload?: boolean | undefined;
+    }) => Promise<RouteMatch[]>;
+    load: LoadFn;
+    preloadRoute: (navigateOpts?: BuildNextOptions) => Promise<readonly [RouteMatch<AnyRoute, any>, RouteMatch<AnyRoute, any>[]]>;
+    buildLink: BuildLinkFn<TRouteTree>;
+    matchRoute: MatchRouteFn<TRouteTree>;
+    injectHtml: (html: string | (() => Promise<string> | string)) => Promise<void>;
+    dehydrateData: <T>(key: any, getData: T | (() => T | Promise<T>)) => () => T | undefined;
+    hydrateData: <T extends unknown = unknown>(key: any) => T | undefined;
 }
 export declare function lazyFn<T extends Record<string, (...args: any[]) => any>, TKey extends keyof T = 'default'>(fn: () => Promise<T>, key?: TKey): (...args: Parameters<T[TKey]>) => Promise<ReturnType<T[TKey]>>;