@tanstack/router-core 0.0.1-beta.167 → 0.0.1-beta.169

package/build/types/index.d.ts

@@ -188,9 +188,9 @@ interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<
     parseSearch?: SearchParser;
     defaultPreload?: false | 'intent';
     defaultPreloadDelay?: number;
-    defaultComponent?: RegisteredRouteComponent<RegisteredRouteProps<unknown, AnySearchSchema, AnyPathParams, AnyContext, AnyContext>>;
-    defaultErrorComponent?: RegisteredRouteErrorComponent<RegisteredErrorRouteProps<AnySearchSchema, AnyPathParams, AnyContext, AnyContext>>;
-    defaultPendingComponent?: RegisteredRouteComponent<RegisteredRouteProps<unknown, AnySearchSchema, AnyPathParams, AnyContext, AnyContext>>;
+    defaultComponent?: RegisteredRouteComponent<unknown, AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
+    defaultErrorComponent?: RegisteredErrorRouteComponent<AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
+    defaultPendingComponent?: RegisteredPendingRouteComponent<AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
     defaultMaxAge?: number;
     defaultGcMaxAge?: number;
     defaultPreloadMaxAge?: number;
@@ -292,6 +292,7 @@ declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated extends
     __store: Store<RouterState<TRouteTree>>;
     state: RouterState<TRouteTree>;
     dehydratedData?: TDehydrated;
+    resetNextScroll: boolean;
     constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated>);
     subscribers: Set<RouterListener<RouterEvent>>;
     subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
@@ -325,9 +326,9 @@ declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated extends
     }) => Promise<void>;
     reload: () => Promise<void>;
     resolvePath: (from: string, path: string) => string;
-    navigate: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "">({ from, to, search, hash, replace, params, }: NavigateOptions<TRouteTree, TFrom, TTo>) => Promise<void>;
+    navigate: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "">({ from, to, search, hash, replace, params, resetScroll, }: NavigateOptions<TRouteTree, TFrom, TTo>) => Promise<void>;
     matchRoute: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "", TResolved extends string = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<TRouteTree, TFrom, TTo, ResolveRelativePath<TFrom, NoInfer<TTo>>>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
-    buildLink: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "">({ from, to, search, params, hash, target, replace, activeOptions, preload, preloadDelay: userPreloadDelay, disabled, state, }: LinkOptions<TRouteTree, TFrom, TTo>) => LinkInfo;
+    buildLink: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "">({ from, to, search, params, hash, target, replace, activeOptions, preload, preloadDelay: userPreloadDelay, disabled, state, resetScroll, }: LinkOptions<TRouteTree, TFrom, TTo>) => LinkInfo;
     dehydrate: () => DehydratedRouter;
     hydrate: (__do_not_use_server_ctx?: HydrationCtx) => Promise<void>;
     injectedHtml: (string | (() => Promise<string> | string))[];
@@ -370,9 +371,11 @@ interface RouteMeta {
 }
 interface RouteContext {
 }
-interface RegisterRouteComponent<TProps> {
+interface RegisterRouteComponent<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
 }
-interface RegisterRouteErrorComponent<TProps> {
+interface RegisterErrorRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+}
+interface RegisterPendingRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
 }
 interface RegisterRouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
 }
@@ -380,21 +383,24 @@ interface RegisterErrorRouteProps<TFullSearchSchema extends AnySearchSchema = An
 }
 interface RegisterPendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
 }
-type RegisteredRouteComponent<TProps> = RegisterRouteComponent<TProps> extends {
+type RegisteredRouteComponent<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterRouteComponent<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
     RouteComponent: infer T;
-} ? T : (props: TProps) => unknown;
-type RegisteredRouteErrorComponent<TProps> = RegisterRouteErrorComponent<TProps> extends {
-    RouteErrorComponent: infer T;
-} ? T : (props: TProps) => unknown;
+} ? T : () => unknown;
+type RegisteredErrorRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterErrorRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+    ErrorRouteComponent: infer T;
+} ? T : () => unknown;
+type RegisteredPendingRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterPendingRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+    PendingRouteComponent: infer T;
+} ? T : () => unknown;
 type RegisteredRouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterRouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
     RouteProps: infer T;
-} ? T : (props: {}) => unknown;
+} ? T : {};
 type RegisteredErrorRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
     ErrorRouteProps: infer T;
-} ? T : (props: {}) => unknown;
+} ? T : {};
 type RegisteredPendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
     PendingRouteProps: infer T;
-} ? T : (props: {}) => unknown;
+} ? T : {};
 type PreloadableObj = {
     preload?: () => Promise<void>;
 };
@@ -447,9 +453,9 @@ type UpdatableRouteOptions<TLoader, TSearchSchema extends AnySearchSchema, TFull
     key?: null | false | GetKeyFn<TFullSearchSchema, TAllParams>;
     caseSensitive?: boolean;
     wrapInSuspense?: boolean;
-    component?: RegisteredRouteComponent<RegisteredRouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
-    errorComponent?: RegisteredRouteErrorComponent<RegisteredErrorRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
-    pendingComponent?: RegisteredRouteComponent<RegisteredPendingRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
+    component?: RegisteredRouteComponent<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+    errorComponent?: RegisteredErrorRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+    pendingComponent?: RegisteredPendingRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
     preSearchFilters?: SearchFilter<TFullSearchSchema>[];
     postSearchFilters?: SearchFilter<TFullSearchSchema>[];
     preloadMaxAge?: number;
@@ -616,9 +622,9 @@ declare class FileRoute<TFilePath extends keyof FileRoutesByPath, TParentRoute e
         key?: false | GetKeyFn<TFullSearchSchema, TAllParams> | null | undefined;
         caseSensitive?: boolean | undefined;
         wrapInSuspense?: boolean | undefined;
-        component?: ((props: (props: {}) => unknown) => unknown) | undefined;
-        errorComponent?: ((props: (props: {}) => unknown) => unknown) | undefined;
-        pendingComponent?: ((props: (props: {}) => unknown) => unknown) | undefined;
+        component?: (() => unknown) | undefined;
+        errorComponent?: (() => unknown) | undefined;
+        pendingComponent?: (() => unknown) | undefined;
         preSearchFilters?: SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
         postSearchFilters?: SearchFilter<TFullSearchSchema, TFullSearchSchema>[] | undefined;
         preloadMaxAge?: number | undefined;
@@ -676,6 +682,7 @@ type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends string, T
 } ? never : './' : never) | (TFrom extends `/` ? never : '../') | AllPaths;
 type NavigateOptions<TRouteTree extends AnyRoute = AnyRoute, TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = ''> = ToOptions<TRouteTree, TFrom, TTo> & {
     replace?: boolean;
+    resetScroll?: boolean;
 };
 type ToOptions<TRouteTree extends AnyRoute = AnyRoute, TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
     to?: ToPathOption<TRouteTree, TFrom, TTo>;
@@ -775,4 +782,4 @@ type DeferredPromise<T> = Promise<T> & {
 declare function defer<T>(_promise: Promise<T>): DeferredPromise<T>;
 declare function isDehydratedDeferred(obj: any): boolean;
 
-export { ActiveOptions, AllParams, AnyContext, AnyPathParams, AnyRedirect, AnyRootRoute, AnyRoute, AnyRouteMatch, AnyRouteProps, AnyRouter, AnySearchSchema, BaseRouteOptions, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, CleanPath, ComponentFromRoute, ComponentPropsFromRoute, DeepAwaited, DeferredPromise, DeferredPromiseState, DefinedPathParamWarning, DehydratedRouteMatch, DehydratedRouter, DehydratedRouterState, Expand, FileRoute, FileRoutePath, FileRoutesByPath, FromLocation, FullSearchSchema, GetKeyFn, HydrationCtx, InferFullSearchSchema, IsAny, IsAnyBoolean, IsKnown, Join, Last, LinkInfo, LinkOptions, ListenerFn, LoaderContext, LoaderFn, LocationState, MatchLocation, MatchRouteOptions, MergeParamsFromParent, MergeUnion, MetaOptions, NavigateOptions, NoInfer, ParamsFallback, ParentParams, ParseParamsFn, ParseParamsObj, ParseParamsOption, ParsePathParams, ParseRoute, ParseRouteChildren, ParsedLocation, ParsedPath, PathParamError, PathParamMask, PathParamOptions, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, PreloadableObj, Redirect, Register, RegisterErrorRouteProps, RegisterPendingRouteProps, RegisterRouteComponent, RegisterRouteErrorComponent, RegisterRouteProps, RegisteredErrorRouteProps, RegisteredPendingRouteProps, RegisteredRouteComponent, RegisteredRouteErrorComponent, RegisteredRouteProps, RegisteredRouter, RelativeToPathAutoComplete, RemoveUnderScores, ResolveFilePath, ResolveFullPath, ResolveFullSearchSchema, ResolveId, ResolveRelativePath, RootRoute, RootRouteId, Route, RouteById, RouteByPath, RouteConstraints, RouteContext, RouteIds, RouteLoaderFromRoute, RouteMatch, RouteMeta, RouteOptions, RoutePathOptions, RoutePathOptionsIntersection, RoutePaths, Router, RouterConstructorOptions, RouterContext, RouterContextOptions, RouterEvent, RouterEvents, RouterHistory, RouterListener, RouterLocation, RouterOptions, RouterState, RoutesById, RoutesByPath, ScrollRestorationOptions, SearchFilter, SearchParamError, SearchParamOptions, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, StreamedPromise, Timeout, ToIdOption, ToOptions, ToPathOption, Trim, TrimLeft, TrimPath, TrimPathLeft, TrimPathRight, TrimRight, UnionToIntersection, UnloaderFn, UpdatableRouteOptions, Updater, UseLoaderResult, ValueKeys, Values, cleanPath, componentTypes, createBrowserHistory, createHashHistory, createMemoryHistory, decode, defaultParseSearch, defaultStringifySearch, defer, encode, functionalUpdate, interpolatePath, isDehydratedDeferred, isPlainObject, isRedirect, joinPaths, last, lazyFn, matchByPath, matchPathname, parsePathname, parseSearchWith, partialDeepEqual, pick, redirect, replaceEqualDeep, resolvePath, restoreScrollPositions, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, watchScrollPositions };
+export { ActiveOptions, AllParams, AnyContext, AnyPathParams, AnyRedirect, AnyRootRoute, AnyRoute, AnyRouteMatch, AnyRouteProps, AnyRouter, AnySearchSchema, BaseRouteOptions, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, CleanPath, ComponentFromRoute, ComponentPropsFromRoute, DeepAwaited, DeferredPromise, DeferredPromiseState, DefinedPathParamWarning, DehydratedRouteMatch, DehydratedRouter, DehydratedRouterState, Expand, FileRoute, FileRoutePath, FileRoutesByPath, FromLocation, FullSearchSchema, GetKeyFn, HydrationCtx, InferFullSearchSchema, IsAny, IsAnyBoolean, IsKnown, Join, Last, LinkInfo, LinkOptions, ListenerFn, LoaderContext, LoaderFn, LocationState, MatchLocation, MatchRouteOptions, MergeParamsFromParent, MergeUnion, MetaOptions, NavigateOptions, NoInfer, ParamsFallback, ParentParams, ParseParamsFn, ParseParamsObj, ParseParamsOption, ParsePathParams, ParseRoute, ParseRouteChildren, ParsedLocation, ParsedPath, PathParamError, PathParamMask, PathParamOptions, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, PreloadableObj, Redirect, Register, RegisterErrorRouteComponent, RegisterErrorRouteProps, RegisterPendingRouteComponent, RegisterPendingRouteProps, RegisterRouteComponent, RegisterRouteProps, RegisteredErrorRouteComponent, RegisteredErrorRouteProps, RegisteredPendingRouteComponent, RegisteredPendingRouteProps, RegisteredRouteComponent, RegisteredRouteProps, RegisteredRouter, RelativeToPathAutoComplete, RemoveUnderScores, ResolveFilePath, ResolveFullPath, ResolveFullSearchSchema, ResolveId, ResolveRelativePath, RootRoute, RootRouteId, Route, RouteById, RouteByPath, RouteConstraints, RouteContext, RouteIds, RouteLoaderFromRoute, RouteMatch, RouteMeta, RouteOptions, RoutePathOptions, RoutePathOptionsIntersection, RoutePaths, Router, RouterConstructorOptions, RouterContext, RouterContextOptions, RouterEvent, RouterEvents, RouterHistory, RouterListener, RouterLocation, RouterOptions, RouterState, RoutesById, RoutesByPath, ScrollRestorationOptions, SearchFilter, SearchParamError, SearchParamOptions, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, StreamedPromise, Timeout, ToIdOption, ToOptions, ToPathOption, Trim, TrimLeft, TrimPath, TrimPathLeft, TrimPathRight, TrimRight, UnionToIntersection, UnloaderFn, UpdatableRouteOptions, Updater, UseLoaderResult, ValueKeys, Values, cleanPath, componentTypes, createBrowserHistory, createHashHistory, createMemoryHistory, decode, defaultParseSearch, defaultStringifySearch, defer, encode, functionalUpdate, interpolatePath, isDehydratedDeferred, isPlainObject, isRedirect, joinPaths, last, lazyFn, matchByPath, matchPathname, parsePathname, parseSearchWith, partialDeepEqual, pick, redirect, replaceEqualDeep, resolvePath, restoreScrollPositions, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, watchScrollPositions };

package/build/umd/index.development.js

@@ -806,6 +806,7 @@
     const componentTypes = ['component', 'errorComponent', 'pendingComponent'];
     class Router {
       #unsubHistory;
+      resetNextScroll = false;
       constructor(options) {
         this.options = {
           defaultPreloadDelay: 50,
@@ -1153,8 +1154,8 @@
             params: routeParams,
             pathname: joinPaths([this.basepath, interpolatedPath]),
             updatedAt: Date.now(),
-            invalidAt: 9999999999999,
-            preloadInvalidAt: 9999999999999,
+            invalidAt: Infinity,
+            preloadInvalidAt: Infinity,
             routeSearch: {},
             search: {},
             status: hasLoaders ? 'pending' : 'success',
@@ -1237,7 +1238,6 @@
         return matches;
       };
       loadMatches = async (resolvedMatches, opts) => {
-        this.cleanMatches();
         if (!opts?.preload) {
           resolvedMatches.forEach(match => {
             // Update each match with its latest route data
@@ -1250,10 +1250,12 @@
               error: match.error,
               paramsError: match.paramsError,
               searchError: match.searchError,
-              params: match.params
+              params: match.params,
+              preloadInvalidAt: 0
             }));
           });
         }
+        this.cleanMatches();
         let firstBadMatchIndex;
 
         // Check each match middleware to see if the route can be accessed
@@ -1389,6 +1391,7 @@
           })());
         });
         await Promise.all(matchPromises);
+        this.cleanMatches();
       };
       reload = () => {
         return this.navigate({
@@ -1406,7 +1409,8 @@
         search,
         hash,
         replace,
-        params
+        params,
+        resetScroll
       }) => {
         // If this link simply reloads the current route,
         // make sure it has a new key so it will trigger a data refresh
@@ -1427,7 +1431,8 @@
           search,
           hash,
           replace,
-          params
+          params,
+          resetScroll
         });
       };
       matchRoute = (location, opts) => {
@@ -1467,7 +1472,8 @@
         preload,
         preloadDelay: userPreloadDelay,
         disabled,
-        state
+        state,
+        resetScroll
       }) => {
         // If this link simply reloads the current route,
         // make sure it has a new key so it will trigger a data refresh
@@ -1489,7 +1495,8 @@
           params,
           hash,
           replace,
-          state
+          state,
+          resetScroll
         };
         const next = this.buildNext(nextOpts);
         preload = preload ?? this.options.defaultPreload;
@@ -1807,6 +1814,8 @@
           id,
           ...next.state
         });
+        this.resetNextScroll = location.resetScroll ?? true;
+        console.log('resetScroll', this.resetNextScroll);
         return this.latestLoadPromise;
       };
       getRouteMatch = id => {
@@ -1832,7 +1841,7 @@
         const route = this.getRoute(match.routeId);
         const updatedAt = opts?.updatedAt ?? Date.now();
         const preloadInvalidAt = updatedAt + (opts?.maxAge ?? route.options.preloadMaxAge ?? this.options.defaultPreloadMaxAge ?? 5000);
-        const invalidAt = updatedAt + (opts?.maxAge ?? route.options.maxAge ?? this.options.defaultMaxAge ?? 9999999999999);
+        const invalidAt = updatedAt + (opts?.maxAge ?? route.options.maxAge ?? this.options.defaultMaxAge ?? Infinity);
         this.setRouteMatch(id, s => ({
           ...s,
           error: undefined,
@@ -1843,7 +1852,6 @@
           preloadInvalidAt,
           invalidAt
         }));
-        if (this.state.matches.find(d => d.id === id)) ;
       };
       invalidate = async opts => {
         if (opts?.matchId) {
@@ -2026,6 +2034,9 @@
     }
     function restoreScrollPositions(router, opts) {
       if (pathDidChange) {
+        if (!router.resetNextScroll) {
+          return;
+        }
         const getKey = opts?.getKey || defaultGetKey;
         pathDidChange = false;
         const restoreKey = getKey(router.state.location);