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

package/build/types/index.d.ts

@@ -66,7 +66,7 @@ interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo
     invalidate: () => void;
     hasLoaders: () => boolean;
 }
-declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
+declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
     parentMatch?: RouteMatch<any, any>;
     matchId: string;
     params: TRouteInfo['allParams'];
@@ -115,6 +115,14 @@ declare function warning(cond: any, message: string): cond is true;
 declare function functionalUpdate<TResult>(updater: Updater<TResult>, previous: TResult): TResult;
 declare function pick<T, K extends keyof T>(parent: T, keys: K[]): Pick<T, K>;
 
+interface RegisterRouter {
+}
+type RegisteredRouter = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo, infer TRouterContext>;
+} ? Router<TRouteConfig, TAllRouteInfo, TRouterContext> : Router;
+type RegisteredAllRouteInfo = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo, infer TRouterContext>;
+} ? TAllRouteInfo : AnyAllRouteInfo;
 interface LocationState {
 }
 interface Location<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
@@ -135,7 +143,7 @@ interface FromLocation {
 type SearchSerializer = (searchObj: Record<string, any>) => string;
 type SearchParser = (searchStr: string) => Record<string, any>;
 type FilterRoutesFn = <TRoute extends Route<any, RouteInfo>>(routeConfigs: TRoute[]) => TRoute[];
-interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
+interface RouterOptions<TRouteConfig extends AnyRouteConfig, TRouterContext> {
     history?: BrowserHistory | MemoryHistory | HashHistory;
     stringifySearch?: SearchSerializer;
     parseSearch?: SearchParser;
@@ -153,11 +161,12 @@ interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
     routeConfig?: TRouteConfig;
     basepath?: string;
     useServerData?: boolean;
-    createRouter?: (router: Router<any, any>) => void;
+    createRouter?: (router: Router<any, any, any>) => void;
     createRoute?: (opts: {
         route: AnyRoute;
-        router: Router<any, any>;
+        router: Router<any, any, any>;
     }) => void;
+    context?: TRouterContext;
     loadComponent?: (component: GetFrameworkGeneric<'Component'>) => Promise<GetFrameworkGeneric<'Component'>>;
 }
 interface Action<TPayload = unknown, TResponse = unknown> {
@@ -215,7 +224,7 @@ interface PendingState {
     location: Location;
     matches: RouteMatch[];
 }
-type Listener = (router: Router<any, any>) => void;
+type Listener = (router: Router<any, any, any>) => void;
 type ListenerFn = () => void;
 interface BuildNextOptions {
     to?: string | number | null;
@@ -244,22 +253,26 @@ interface MatchRouteOptions {
     pending: boolean;
     caseSensitive?: boolean;
 }
-interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated'> {
+interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated' | 'location'> {
     matches: DehydratedRouteMatch[];
 }
+interface DehydratedRouter<TRouterContext = unknown> {
+    location: Router['location'];
+    state: DehydratedRouterState;
+    context: TRouterContext;
+}
 interface DehydratedRouteMatch extends Pick<RouteMatch<any, any>, 'matchId' | 'status' | 'routeLoaderData' | 'loaderData' | 'isInvalid' | 'invalidAt'> {
 }
 interface RouterContext {
 }
-interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
+interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown> {
     types: {
         RouteConfig: TRouteConfig;
         AllRouteInfo: TAllRouteInfo;
     };
     history: BrowserHistory | MemoryHistory | HashHistory;
-    options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
+    options: PickAsRequired<RouterOptions<TRouteConfig, TRouterContext>, 'stringifySearch' | 'parseSearch' | 'context'>;
     basepath: string;
-    context: RouterContext;
     listeners: Listener[];
     location: Location<TAllRouteInfo['fullSearchSchema']>;
     navigateTimeout?: Timeout;
@@ -267,7 +280,7 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     state: RouterState<TAllRouteInfo['fullSearchSchema']>;
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
-    navigationPromise: Promise<void>;
+    navigationPromise?: Promise<void>;
     startedLoadingAt: number;
     resolveNavigation: () => void;
     subscribe: (listener: Listener) => () => void;
@@ -275,7 +288,7 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     notify: () => void;
     mount: () => () => void;
     onFocus: () => void;
-    update: <TRouteConfig extends RouteConfig = RouteConfig>(opts?: RouterOptions<TRouteConfig>) => Router<TRouteConfig>;
+    update: <TRouteConfig extends RouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(opts?: RouterOptions<TRouteConfig, TRouterContext>) => Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
     buildNext: (opts: BuildNextOptions) => Location;
     cancelMatches: () => void;
     load: (next?: Location) => Promise<void>;
@@ -306,8 +319,8 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     navigate: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo>) => Promise<void>;
     matchRoute: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(matchLocation: ToOptions<TAllRouteInfo, TFrom, TTo>, opts?: MatchRouteOptions) => boolean;
     buildLink: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: LinkOptions<TAllRouteInfo, TFrom, TTo>) => LinkInfo;
-    dehydrateState: () => DehydratedRouterState;
-    hydrateState: (state: DehydratedRouterState) => void;
+    dehydrate: () => DehydratedRouter<TRouterContext>;
+    hydrate: (dehydratedRouter: DehydratedRouter<TRouterContext>) => void;
     __: {
         buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
         parseLocation: (location: History['location'], previousLocation?: Location) => Location;
@@ -318,11 +331,11 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
         }) => Promise<void>;
     };
 }
-declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>>(userOptions?: RouterOptions<TRouteConfig>): Router<TRouteConfig, TAllRouteInfo>;
+declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(userOptions?: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
 
-interface AnyRoute extends Route<any, any> {
+interface AnyRoute extends Route<any, any, any> {
 }
-interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
+interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo, TRouterContext = unknown> {
     routeInfo: TRouteInfo;
     routeId: TRouteInfo['id'];
     routeRouteId: TRouteInfo['routeId'];
@@ -331,14 +344,14 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     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>, 'from'>) => LinkInfo;
     matchRoute: <TTo extends string = '.', TResolved extends string = ResolveRelativePath<TRouteInfo['id'], TTo>>(matchLocation: CheckRelativePath<TAllRouteInfo, TRouteInfo['fullPath'], NoInfer<TTo>> & Omit<ToOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>, 'from'>, opts?: MatchRouteOptions) => RouteInfoByPath<TAllRouteInfo, TResolved>['allParams'];
     navigate: <TTo extends string = '.'>(options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>, 'from'>) => Promise<void>;
     action: unknown extends TRouteInfo['actionResponse'] ? Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']> | undefined : Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']>;
     loader: unknown extends TRouteInfo['routeLoaderData'] ? Action<LoaderContext<TRouteInfo['fullSearchSchema'], TRouteInfo['allParams']>, TRouteInfo['routeLoaderData']> | undefined : Loader<TRouteInfo['fullSearchSchema'], TRouteInfo['allParams'], TRouteInfo['routeLoaderData']>;
 }
-declare function createRoute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(routeConfig: RouteConfig, options: TRouteInfo['options'], parent: undefined | Route<TAllRouteInfo, any>, router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>): Route<TAllRouteInfo, TRouteInfo>;
+declare 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, TRouterContext>): Route<TAllRouteInfo, TRouteInfo, TRouterContext>;
 
 interface AnyAllRouteInfo {
     routeConfig: AnyRouteConfig;
@@ -455,7 +468,8 @@ type RouteOptions<TRouteId extends string = string, TPath extends string = strin
     loaderGcMaxAge?: number;
     action?: ActionFn<TActionPayload, TActionResponse>;
     beforeLoad?: (opts: {
-        context: RouterContext;
+        router: Router<any, any, unknown>;
+        match: RouteMatch;
     }) => Promise<void> | void;
     onLoaded?: (matchContext: {
         params: TAllParams;
@@ -617,4 +631,4 @@ declare const defaultStringifySearch: (search: Record<string, any>) => string;
 declare function parseSearchWith(parser: (str: string) => any): (searchStr: string) => AnySearchSchema;
 declare function stringifySearchWith(stringify: (search: any) => string): (search: Record<string, any>) => string;
 
-export { Action, ActionFn, ActionState, AllRouteInfo, AnyAllRouteInfo, AnyLoaderData, AnyPathParams, AnyRoute, AnyRouteConfig, AnyRouteConfigWithChildren, AnyRouteInfo, AnySearchSchema, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, DeepAwaited, DefaultAllRouteInfo, DefinedPathParamWarning, Expand, FilterRoutesFn, FrameworkGenerics, FromLocation, GetFrameworkGeneric, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, Loader, LoaderContext, LoaderFn, LoaderState, Location, LocationState, MatchCacheEntry, MatchLocation, MatchRouteOptions, NavigateOptionsAbsolute, NoInfer, ParentParams, ParsePathParams, ParseRouteConfig, PathParamMask, PendingState, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteMatch, RouteMeta, RouteOptions, Router, RouterContext, RouterOptions, RouterState, RoutesById, RoutesInfoInner, SearchFilter, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, Timeout, ToIdOption, ToOptions, ToPathOption, UnionToIntersection, UnloaderFn, Updater, ValidFromPath, ValueKeys, Values, cleanPath, createRoute, createRouteConfig, createRouteMatch, createRouter, decode, defaultParseSearch, defaultStringifySearch, encode, functionalUpdate, interpolatePath, joinPaths, last, matchByPath, matchPathname, parsePathname, parseSearchWith, pick, replaceEqualDeep, resolvePath, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, warning };
+export { Action, ActionFn, ActionState, AllRouteInfo, AnyAllRouteInfo, AnyLoaderData, AnyPathParams, AnyRoute, AnyRouteConfig, AnyRouteConfigWithChildren, AnyRouteInfo, AnySearchSchema, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, DeepAwaited, DefaultAllRouteInfo, DefinedPathParamWarning, DehydratedRouter, DehydratedRouterState, Expand, FilterRoutesFn, FrameworkGenerics, FromLocation, GetFrameworkGeneric, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, Loader, LoaderContext, LoaderFn, LoaderState, Location, LocationState, MatchCacheEntry, MatchLocation, MatchRouteOptions, NavigateOptionsAbsolute, NoInfer, ParentParams, ParsePathParams, ParseRouteConfig, PathParamMask, PendingState, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, RegisterRouter, RegisteredAllRouteInfo, RegisteredRouter, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteMatch, RouteMeta, RouteOptions, Router, RouterContext, RouterOptions, RouterState, RoutesById, RoutesInfoInner, SearchFilter, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, Timeout, ToIdOption, ToOptions, ToPathOption, UnionToIntersection, UnloaderFn, Updater, ValidFromPath, ValueKeys, Values, cleanPath, createRoute, createRouteConfig, createRouteMatch, createRouter, decode, defaultParseSearch, defaultStringifySearch, encode, functionalUpdate, interpolatePath, joinPaths, last, matchByPath, matchPathname, parsePathname, parseSearchWith, pick, replaceEqualDeep, resolvePath, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, warning };