@tanstack/router-core 0.0.1-beta.194 → 0.0.1-beta.195

package/build/types/route.d.ts

@@ -11,34 +11,34 @@ export interface RouteMeta {
 }
 export interface RouteContext {
 }
-export interface RegisterRouteComponent<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterRouteComponent<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export interface RegisterErrorRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterErrorRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export interface RegisterPendingRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterPendingRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export interface RegisterRouteProps<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterRouteProps<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export interface RegisterErrorRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterErrorRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export interface RegisterPendingRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> {
+export interface RegisterPendingRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> {
 }
-export type RegisteredRouteComponent<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteComponent<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredRouteComponent<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteComponent<TLoader, TFullSearchSchema, TAllParams, TAllContext> extends {
     RouteComponent: infer T;
 } ? T : () => unknown;
-export type RegisteredErrorRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterErrorRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredErrorRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterErrorRouteComponent<TFullSearchSchema, TAllParams, TAllContext> extends {
     ErrorRouteComponent: infer T;
 } ? T : () => unknown;
-export type RegisteredPendingRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterPendingRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredPendingRouteComponent<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterPendingRouteComponent<TFullSearchSchema, TAllParams, TAllContext> extends {
     PendingRouteComponent: infer T;
 } ? T : () => unknown;
-export type RegisteredRouteProps<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredRouteProps<TLoader = unknown, TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TLoader, TFullSearchSchema, TAllParams, TAllContext> extends {
     RouteProps: infer T;
 } ? T : {};
-export type RegisteredErrorRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredErrorRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TAllContext> extends {
     ErrorRouteProps: infer T;
 } ? T : {};
-export type RegisteredPendingRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends Record<string, any> = AnyContext, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext> extends {
+export type RegisteredPendingRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = RegisterRouteProps<TFullSearchSchema, TAllParams, TAllContext> extends {
     PendingRouteProps: infer T;
 } ? T : {};
 export type PreloadableObj = {
@@ -55,8 +55,8 @@ export type MetaOptions = keyof PickRequired<RouteMeta> extends never ? {
 } : {
     meta: RouteMeta;
 };
-export type AnyRouteProps = RegisteredRouteProps<any, any, any, any, any>;
-export type RouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TLoaderContext extends Record<string, any> = AnyContext, TLoader = unknown, 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, TLoaderContext, TLoader, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext> & UpdatableRouteOptions<TLoader, TSearchSchema, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+export type AnyRouteProps = RegisteredRouteProps<any, any, any, any>;
+export type RouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TLoaderContext extends Record<string, any> = AnyContext, TLoader = unknown, 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, TLoaderContext, TLoader, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext> & UpdatableRouteOptions<TLoader, 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, TLoaderContext extends Record<string, any> = AnyContext, TLoader = unknown, 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;
@@ -85,12 +85,12 @@ type BeforeLoadFn<TParentRoute extends AnyRoute, TAllParams, TLoaderContext, TRo
     params: TAllParams;
     context: Expand<TParentRoute['types']['context'] & TLoaderContext>;
 }) => Promise<TRouteContext> | TRouteContext | void;
-export type UpdatableRouteOptions<TLoader, TSearchSchema extends Record<string, any>, TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TRouteContext extends Record<string, any>, TAllContext extends Record<string, any>> = MetaOptions & {
+export type UpdatableRouteOptions<TLoader, TFullSearchSchema extends Record<string, any>, TAllParams extends AnyPathParams, TAllContext extends Record<string, any>> = MetaOptions & {
     caseSensitive?: boolean;
     wrapInSuspense?: boolean;
-    component?: RegisteredRouteComponent<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
-    errorComponent?: RegisteredErrorRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
-    pendingComponent?: RegisteredPendingRouteComponent<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+    component?: RegisteredRouteComponent<TLoader, TFullSearchSchema, TAllParams, TAllContext>;
+    errorComponent?: RegisteredErrorRouteComponent<TFullSearchSchema, TAllParams, TAllContext>;
+    pendingComponent?: RegisteredPendingRouteComponent<TFullSearchSchema, TAllParams, TAllContext>;
     preSearchFilters?: SearchFilter<TFullSearchSchema>[];
     postSearchFilters?: SearchFilter<TFullSearchSchema>[];
     preloadMaxAge?: number;
@@ -123,7 +123,7 @@ export interface LoaderContext<TAllParams = {}, TLoaderContext = {}, TAllContext
     abortController: AbortController;
     preload: boolean;
     params: TAllParams;
-    context: DeepMergeAll<[TAllContext, TLoaderContext, TRouteContext]>;
+    context: Expand<DeepMergeAll<[TAllContext, TLoaderContext, TRouteContext]>>;
 }
 export type SearchFilter<T, U = T> = (prev: T) => U;
 export type ResolveId<TParentRoute, TCustomId extends string, TPath extends string> = TParentRoute extends {
@@ -198,13 +198,13 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
     originalIndex?: number;
     router?: AnyRouter;
     rank: number;
-    constructor(options: RouteOptions<TParentRoute, TCustomId, TPath, TLoaderContext, TLoader, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext> & UpdatableRouteOptions<TLoader, TSearchSchema, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>);
+    constructor(options: RouteOptions<TParentRoute, TCustomId, TPath, TLoaderContext, TLoader, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext> & UpdatableRouteOptions<TLoader, TFullSearchSchema, TAllParams, TAllContext>);
     init: (opts: {
         originalIndex: number;
         router: AnyRouter;
     }) => void;
     addChildren: <TNewChildren extends AnyRoute[]>(children: TNewChildren) => Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TLoaderContext, TLoader, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext, TRouterContext, TNewChildren, TRouteTree>;
-    update: (options: UpdatableRouteOptions<TLoader, TSearchSchema, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>) => this;
+    update: (options: UpdatableRouteOptions<TLoader, TFullSearchSchema, TAllParams, TAllContext>) => this;
     static __onInit: (route: any) => void;
 }
 export type AnyRootRoute = RootRoute<any, any, any, any>;

package/build/types/routeInfo.d.ts

@@ -18,5 +18,5 @@ export type RouteByPath<TRouteTree extends AnyRoute, TPath> = Extract<ParseRoute
     fullPath: TPath;
 }>;
 export type RoutePaths<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree>['fullPath'] | '/';
-export type FullSearchSchema<TRouteTree extends AnyRoute> = Partial<Expand<UnionToIntersection<ParseRoute<TRouteTree>['types']['fullSearchSchema']> & {}>>;
+export type FullSearchSchema<TRouteTree extends AnyRoute> = Partial<Expand<UnionToIntersection<ParseRoute<TRouteTree>['types']['fullSearchSchema']>>>;
 export type AllParams<TRouteTree extends AnyRoute> = Expand<UnionToIntersection<ParseRoute<TRouteTree>['types']['allParams']>>;

package/build/types/router.d.ts

@@ -75,9 +75,9 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends
     defaultPreload?: false | 'intent';
     defaultPreloadDelay?: number;
     reloadOnWindowFocus?: boolean;
-    defaultComponent?: RegisteredRouteComponent<unknown, AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
-    defaultErrorComponent?: RegisteredErrorRouteComponent<AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
-    defaultPendingComponent?: RegisteredPendingRouteComponent<AnySearchSchema, AnyPathParams, AnyContext, AnyContext>;
+    defaultComponent?: RegisteredRouteComponent<unknown, AnySearchSchema, AnyPathParams, AnyContext>;
+    defaultErrorComponent?: RegisteredErrorRouteComponent<AnySearchSchema, AnyPathParams, AnyContext>;
+    defaultPendingComponent?: RegisteredPendingRouteComponent<AnySearchSchema, AnyPathParams, AnyContext>;
     defaultMaxAge?: number;
     defaultGcMaxAge?: number;
     defaultPreloadMaxAge?: number;

package/build/umd/index.development.js

@@ -107,13 +107,13 @@
         push: (path, state) => {
           assignKey(state);
           queueTask(() => {
-            opts.pushState(path, state);
+            opts.pushState(path, state, onUpdate);
           });
         },
         replace: (path, state) => {
           assignKey(state);
           queueTask(() => {
-            opts.replaceState(path, state);
+            opts.replaceState(path, state, onUpdate);
           });
         },
         go: index => {
@@ -145,7 +145,8 @@
               stopBlocking();
             }
           };
-        }
+        },
+        flush: () => opts.flush?.()
       };
     }
     function assignKey(state) {
@@ -158,25 +159,100 @@
       // }
     }
 
+    /**
+     * Creates a history object that can be used to interact with the browser's
+     * navigation. This is a lightweight API wrapping the browser's native methods.
+     * It is designed to work with TanStack Router, but could be used as a standalone API as well.
+     * IMPORTANT: This API implements history throttling via a microtask to prevent
+     * excessive calls to the history API. In some browsers, calling history.pushState or
+     * history.replaceState in quick succession can cause the browser to ignore subsequent
+     * calls. This API smooths out those differences and ensures that your application
+     * state will *eventually* match the browser state. In most cases, this is not a problem,
+     * but if you need to ensure that the browser state is up to date, you can use the
+     * `history.flush` method to immediately flush all pending state changes to the browser URL.
+     * @param opts
+     * @param opts.getHref A function that returns the current href (path + search + hash)
+     * @param opts.createHref A function that takes a path and returns a href (path + search + hash)
+     * @returns A history instance
+     */
     function createBrowserHistory(opts) {
       const getHref = opts?.getHref ?? (() => `${window.location.pathname}${window.location.search}${window.location.hash}`);
       const createHref = opts?.createHref ?? (path => path);
-      const getLocation = () => parseLocation(getHref(), window.history.state);
+      let currentLocation = parseLocation(getHref(), window.history.state);
+      const getLocation = () => currentLocation;
+      let next;
+
+      // Because we are proactively updating the location
+      // in memory before actually updating the browser history,
+      // we need to track when we are doing this so we don't
+      // notify subscribers twice on the last update.
+      let tracking = true;
+
+      // We need to track the current scheduled update to prevent
+      // multiple updates from being scheduled at the same time.
+      let scheduled;
+
+      // This function is a wrapper to prevent any of the callback's
+      // side effects from causing a subscriber notification
+      const untrack = fn => {
+        tracking = false;
+        fn();
+        tracking = true;
+      };
+
+      // This function flushes the next update to the browser history
+      const flush = () => {
+        // Do not notify subscribers about this push/replace call
+        untrack(() => {
+          if (!next) return;
+          window.history[next.isPush ? 'pushState' : 'replaceState'](next.state, '', next.href);
+          // Reset the nextIsPush flag and clear the scheduled update
+          next = undefined;
+          scheduled = undefined;
+        });
+      };
+
+      // This function queues up a call to update the browser history
+      const queueHistoryAction = (type, path, state, onUpdate) => {
+        const href = createHref(path);
+
+        // Update the location in memory
+        currentLocation = parseLocation(href, state);
+
+        // Keep track of the next location we need to flush to the URL
+        next = {
+          href,
+          state,
+          isPush: next?.isPush || type === 'push'
+        };
+        // Notify subscribers
+        onUpdate();
+        if (!scheduled) {
+          // Schedule an update to the browser history
+          scheduled = Promise.resolve().then(() => flush());
+        }
+      };
       return createHistory({
         getLocation,
         subscriber: onUpdate => {
-          window.addEventListener(pushStateEvent, onUpdate);
-          window.addEventListener(popStateEvent, onUpdate);
+          window.addEventListener(pushStateEvent, () => {
+            currentLocation = parseLocation(getHref(), window.history.state);
+            onUpdate();
+          });
+          window.addEventListener(popStateEvent, () => {
+            currentLocation = parseLocation(getHref(), window.history.state);
+            onUpdate();
+          });
           var pushState = window.history.pushState;
           window.history.pushState = function () {
             let res = pushState.apply(history, arguments);
-            onUpdate();
+            if (tracking) onUpdate();
             return res;
           };
           var replaceState = window.history.replaceState;
           window.history.replaceState = function () {
             let res = replaceState.apply(history, arguments);
-            onUpdate();
+            if (tracking) onUpdate();
             return res;
           };
           return () => {
@@ -186,16 +262,13 @@
             window.removeEventListener(popStateEvent, onUpdate);
           };
         },
-        pushState: (path, state) => {
-          window.history.pushState(state, '', createHref(path));
-        },
-        replaceState: (path, state) => {
-          window.history.replaceState(state, '', createHref(path));
-        },
+        pushState: (path, state, onUpdate) => queueHistoryAction('push', path, state, onUpdate),
+        replaceState: (path, state, onUpdate) => queueHistoryAction('replace', path, state, onUpdate),
         back: () => window.history.back(),
         forward: () => window.history.forward(),
         go: n => window.history.go(n),
-        createHref: path => createHref(path)
+        createHref: path => createHref(path),
+        flush
       });
     }
     function createHashHistory() {
@@ -252,6 +325,8 @@
       return (Math.random() + 1).toString(36).substring(7);
     }
 
+    // export type Expand<T> = T
+
     // type Compute<T> = { [K in keyof T]: T[K] } | never
 
     // type AllKeys<T> = T extends any ? keyof T : never