@tanstack/router-core 0.0.1-beta.21 → 0.0.1-beta.24

package/build/types/index.d.ts

@@ -89,6 +89,7 @@ type PickRequired<T> = {
 type Expand<T> = T extends object ? T extends infer O ? {
     [K in keyof O]: O[K];
 } : never : T;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => any ? I : never;
 type Values<O> = O[ValueKeys<O>];
 type ValueKeys<O> = Extract<keyof O, PropertyKey>;
 type DeepAwaited<T> = T extends Promise<infer A> ? DeepAwaited<A> : T extends Record<infer A, Promise<infer B>> ? {
@@ -199,9 +200,9 @@ interface LoaderState<TFullSearchSchema extends AnySearchSchema = {}, TAllParams
     loadedAt: number;
     loaderContext: LoaderContext<TFullSearchSchema, TAllParams>;
 }
-interface RouterState {
+interface RouterState<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
     status: 'idle' | 'loading';
-    location: Location;
+    location: Location<TSearchObj, TState>;
     matches: RouteMatch[];
     lastUpdated: number;
     actions: Record<string, Action>;
@@ -248,6 +249,8 @@ interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location'
 }
 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>> {
     types: {
         RouteConfig: TRouteConfig;
@@ -256,11 +259,12 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     history: BrowserHistory | MemoryHistory | HashHistory;
     options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
     basepath: string;
+    context: RouterContext;
     listeners: Listener[];
-    location: Location;
+    location: Location<TAllRouteInfo['fullSearchSchema']>;
     navigateTimeout?: Timeout;
     nextAction?: 'push' | 'replace';
-    state: RouterState;
+    state: RouterState<TAllRouteInfo['fullSearchSchema']>;
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
     navigationPromise: Promise<void>;
@@ -319,6 +323,7 @@ declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig,
 interface AnyRoute extends Route<any, any> {
 }
 interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
+    routeInfo: TRouteInfo;
     routeId: TRouteInfo['id'];
     routeRouteId: TRouteInfo['routeId'];
     routePath: TRouteInfo['path'];
@@ -329,7 +334,7 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>;
     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['id'], TTo>, 'from'>) => Promise<void>;
+    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']>;
 }
@@ -342,6 +347,7 @@ interface AnyAllRouteInfo {
     routeInfoByFullPath: Record<string, AnyRouteInfo>;
     routeIds: any;
     routePaths: any;
+    fullSearchSchema: Record<string, any>;
 }
 interface DefaultAllRouteInfo {
     routeConfig: RouteConfig;
@@ -350,6 +356,7 @@ interface DefaultAllRouteInfo {
     routeInfoByFullPath: Record<string, RouteInfo>;
     routeIds: string;
     routePaths: string;
+    fullSearchSchema: AnySearchSchema;
 }
 interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig> extends RoutesInfoInner<TRouteConfig, ParseRouteConfig<TRouteConfig>> {
 }
@@ -376,6 +383,7 @@ interface RoutesInfoInner<TRouteConfig extends AnyRouteConfig, TRouteInfo extend
     routeInfoByFullPath: TRouteInfoByFullPath;
     routeIds: keyof TRouteInfoById;
     routePaths: keyof TRouteInfoByFullPath;
+    fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>;
 }
 interface AnyRouteInfo extends RouteInfo<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any> {
 }
@@ -445,7 +453,10 @@ type RouteOptions<TRouteId extends string = string, TPath extends string = strin
     loaderMaxAge?: number;
     loaderGcMaxAge?: number;
     action?: ActionFn<TActionPayload, TActionResponse>;
-    onMatch?: (matchContext: {
+    beforeLoad?: (opts: {
+        context: RouterContext;
+    }) => Promise<void> | void;
+    onLoaded?: (matchContext: {
         params: TAllParams;
         search: TFullSearchSchema;
     }) => void | undefined | ((match: {
@@ -607,4 +618,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, RouterOptions, RouterState, RoutesById, RoutesInfoInner, SearchFilter, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, Timeout, ToIdOption, ToOptions, ToPathOption, 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, 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 };

package/build/umd/index.development.js

@@ -832,12 +832,6 @@
       throw new Error(value);
   }
 
-  // type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
-  //   k: infer I,
-  // ) => any
-  //   ? I
-  //   : never
-
   /**
    * This function returns `a` if `b` is deeply equal.
    * If not, it will replace any deeply equal children of `b` with those of `a`.
@@ -1059,10 +1053,7 @@
 
     if (matchLocation.to && !pathParams) {
       return;
-    } // if (matchLocation.search && !searchMatched) {
-    //   return
-    // }
-
+    }
 
     return pathParams != null ? pathParams : {};
   }
@@ -1299,6 +1290,7 @@
     })();
 
     let route = {
+      routeInfo: undefined,
       routeId: id,
       routeRouteId: routeId,
       routePath,
@@ -1672,6 +1664,7 @@
       options: originalOptions,
       listeners: [],
       // Resolved after construction
+      context: {},
       basepath: '',
       routeTree: undefined,
       routesById: {},
@@ -1816,7 +1809,19 @@
 
         const matches = router.matchRoutes(router.location.pathname, {
           strictParseParams: true
-        });
+        }); // Check if each match middleware to see if the route can be accessed
+
+        try {
+          await Promise.all(matches.map(match => match.options.beforeLoad == null ? void 0 : match.options.beforeLoad({
+            context: router.context
+          })));
+        } catch (err) {
+          if (err != null && err.then) {
+            await new Promise(() => {});
+          }
+
+          throw err;
+        }
 
         if (typeof document !== 'undefined') {
           router.state = _extends({}, router.state, {
@@ -1886,7 +1891,7 @@
           });
         });
         entering.forEach(d => {
-          d.__.onExit = d.options.onMatch == null ? void 0 : d.options.onMatch({
+          d.__.onExit = d.options.onLoaded == null ? void 0 : d.options.onLoaded({
             params: d.params,
             search: d.search
           });