@tanstack/router-core 0.0.1-beta.35 → 0.0.1-beta.39

package/build/types/index.d.ts

@@ -8,9 +8,10 @@
  *
  * @license MIT
  */
-import { BrowserHistory, MemoryHistory, HashHistory, History } from 'history';
+import { BrowserHistory, MemoryHistory, HashHistory } from 'history';
 export { createBrowserHistory, createHashHistory, createMemoryHistory } from 'history';
 export { default as invariant } from 'tiny-invariant';
+import { SetStoreFunction } from '@solidjs/reactivity';
 
 interface FrameworkGenerics {
 }
@@ -47,12 +48,6 @@ type PickExtract<T, U> = {
 type PickExclude<T, U> = {
     [K in keyof T as T[K] extends U ? never : K]: T[K];
 };
-/**
- * This function returns `a` if `b` is deeply equal.
- * If not, it will replace any deeply equal children of `b` with those of `a`.
- * This can be used for structural sharing between JSON values for example.
- */
-declare function replaceEqualDeep(prev: any, next: any): any;
 declare function last<T>(arr: T[]): T | undefined;
 declare function warning(cond: any, message: string): cond is true;
 declare function functionalUpdate<TResult>(updater: Updater<TResult>, previous: TResult): TResult;
@@ -152,22 +147,20 @@ interface LoaderState<TFullSearchSchema extends AnySearchSchema = {}, TAllParams
     loadedAt: number;
     loaderContext: LoaderContext<TFullSearchSchema, TAllParams>;
 }
-interface RouterState<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
+interface RouterStore<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
     status: 'idle' | 'loading';
-    location: Location<TSearchObj, TState>;
-    matches: RouteMatch[];
+    latestLocation: Location<TSearchObj, TState>;
+    currentMatches: RouteMatch[];
+    currentLocation: Location<TSearchObj, TState>;
+    pendingMatches?: RouteMatch[];
+    pendingLocation?: Location<TSearchObj, TState>;
     lastUpdated: number;
     actions: Record<string, Action>;
     loaders: Record<string, Loader>;
-    pending?: PendingState;
     isFetching: boolean;
     isPreloading: boolean;
+    matchCache: Record<string, MatchCacheEntry>;
 }
-interface PendingState {
-    location: Location;
-    matches: RouteMatch[];
-}
-type Listener = (router: Router<any, any, any>) => void;
 type ListenerFn = () => void;
 interface BuildNextOptions {
     to?: string | number | null;
@@ -197,15 +190,17 @@ interface MatchRouteOptions {
     caseSensitive?: boolean;
     fuzzy?: boolean;
 }
-interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated' | 'location'> {
-    matches: DehydratedRouteMatch[];
+interface DehydratedRouterState extends Pick<RouterStore, 'status' | 'latestLocation' | 'currentLocation' | 'lastUpdated'> {
+    currentMatches: DehydratedRouteMatch[];
 }
 interface DehydratedRouter<TRouterContext = unknown> {
-    location: Router['__location'];
-    state: DehydratedRouterState;
+    store: DehydratedRouterState;
     context: TRouterContext;
 }
-interface DehydratedRouteMatch extends Pick<RouteMatch<any, any>, 'matchId' | 'status' | 'routeLoaderData' | 'loaderData' | 'isInvalid' | 'invalidAt'> {
+type MatchCache = Record<string, MatchCacheEntry>;
+interface DehydratedRouteMatch {
+    matchId: string;
+    store: Pick<RouteMatchStore<any, any>, 'status' | 'routeLoaderData' | 'isInvalid' | 'invalidAt'>;
 }
 interface RouterContext {
 }
@@ -216,27 +211,17 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     };
     history: BrowserHistory | MemoryHistory | HashHistory;
     options: PickAsRequired<RouterOptions<TRouteConfig, TRouterContext>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    store: RouterStore<TAllRouteInfo['fullSearchSchema']>;
+    setStore: SetStoreFunction<RouterStore<TAllRouteInfo['fullSearchSchema']>>;
     basepath: string;
-    listeners: Listener[];
-    __location: Location<TAllRouteInfo['fullSearchSchema']>;
-    navigateTimeout?: Timeout;
-    nextAction?: 'push' | 'replace';
-    state: RouterState<TAllRouteInfo['fullSearchSchema']>;
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
-    navigationPromise?: Promise<void>;
-    startedLoadingAt: number;
-    resolveNavigation: () => void;
-    subscribe: (listener: Listener) => () => void;
     reset: () => void;
-    notify: () => void;
     mount: () => () => void;
-    onFocus: () => void;
     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>;
-    matchCache: Record<string, MatchCacheEntry>;
     cleanMatchCache: () => void;
     getRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(id: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
     loadRoute: (navigateOpts: BuildNextOptions) => Promise<RouteMatch[]>;
@@ -260,57 +245,34 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     invalidateRoute: (opts: MatchLocation) => void;
     reload: () => Promise<void>;
     resolvePath: (from: string, path: string) => string;
-    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;
+    navigate: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: NavigateOptions<TAllRouteInfo, TFrom, TTo>) => Promise<void>;
+    matchRoute: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(matchLocation: ToOptions<TAllRouteInfo, TFrom, TTo>, opts?: MatchRouteOptions) => false | TAllRouteInfo['routeInfoById'][ResolveRelativePath<TFrom, NoInfer<TTo>>]['allParams'];
     buildLink: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: LinkOptions<TAllRouteInfo, TFrom, TTo>) => LinkInfo;
     dehydrate: () => DehydratedRouter<TRouterContext>;
     hydrate: (dehydratedRouter: DehydratedRouter<TRouterContext>) => void;
-    __: {
-        buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
-        parseLocation: (location: History['location'], previousLocation?: Location) => Location;
-        buildLocation: (dest: BuildNextOptions) => Location;
-        commitLocation: (next: Location, replace?: boolean) => Promise<void>;
-        navigate: (location: BuildNextOptions & {
-            replace?: boolean;
-        }) => Promise<void>;
-    };
 }
 declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(userOptions?: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
 
-interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
-    matchId: string;
-    pathname: string;
-    params: TRouteInfo['allParams'];
+interface RouteMatchStore<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
     parentMatch?: RouteMatch;
-    childMatches: RouteMatch[];
     routeSearch: TRouteInfo['searchSchema'];
     search: Expand<TAllRouteInfo['fullSearchSchema'] & TRouteInfo['fullSearchSchema']>;
     status: 'idle' | 'loading' | 'success' | 'error';
     updatedAt?: number;
     error?: unknown;
+    invalid: boolean;
     isInvalid: boolean;
-    getIsInvalid: () => boolean;
     loaderData: TRouteInfo['loaderData'];
     routeLoaderData: TRouteInfo['routeLoaderData'];
     isFetching: boolean;
     invalidAt: number;
-    __: {
-        component?: GetFrameworkGeneric<'Component'>;
-        errorComponent?: GetFrameworkGeneric<'ErrorComponent'>;
-        pendingComponent?: GetFrameworkGeneric<'Component'>;
-        loadPromise?: Promise<void>;
-        componentsPromise?: Promise<void>;
-        dataPromise?: Promise<TRouteInfo['routeLoaderData']>;
-        onExit?: void | ((matchContext: {
-            params: TRouteInfo['allParams'];
-            search: TRouteInfo['fullSearchSchema'];
-        }) => void);
-        abortController: AbortController;
-        latestId: string;
-        validate: () => void;
-        notify: () => void;
-        resolve: () => void;
-    };
+}
+interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
+    store: RouteMatchStore<TAllRouteInfo, TRouteInfo>;
+    matchId: string;
+    pathname: string;
+    params: TRouteInfo['allParams'];
+    childMatches: RouteMatch[];
     cancel: () => void;
     load: (loaderOpts?: {
         preload: true;
@@ -326,6 +288,19 @@ interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo
     }) => Promise<TRouteInfo['routeLoaderData']>;
     invalidate: () => void;
     hasLoaders: () => boolean;
+    __: {
+        setParentMatch: (parentMatch?: RouteMatch) => void;
+        component?: GetFrameworkGeneric<'Component'>;
+        errorComponent?: GetFrameworkGeneric<'ErrorComponent'>;
+        pendingComponent?: GetFrameworkGeneric<'Component'>;
+        loadPromise?: Promise<void>;
+        onExit?: void | ((matchContext: {
+            params: TRouteInfo['allParams'];
+            search: TRouteInfo['fullSearchSchema'];
+        }) => void);
+        abortController: AbortController;
+        validate: () => void;
+    };
 }
 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>;
@@ -381,6 +356,7 @@ type RouteOptions<TRouteId extends string = string, TPath extends string = strin
         router: Router<any, any, unknown>;
         match: RouteMatch;
     }) => Promise<void> | void;
+    onLoadError?: (err: any) => void;
     onLoaded?: (matchContext: {
         params: TAllParams;
         search: TFullSearchSchema;
@@ -441,14 +417,12 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     parentRoute?: AnyRoute;
     childRoutes?: AnyRoute[];
     options: RouteOptions;
+    originalIndex: number;
     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, TRouterContext = unknown>(routeConfig: RouteConfig, options: TRouteInfo['options'], parent: undefined | Route<TAllRouteInfo, any>, router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>): Route<TAllRouteInfo, TRouteInfo, TRouterContext>;
+declare function createRoute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo, TRouterContext = unknown>(routeConfig: RouteConfig, options: TRouteInfo['options'], originalIndex: number, parent: undefined | Route<TAllRouteInfo, any>, router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>): Route<TAllRouteInfo, TRouteInfo, TRouterContext>;
 
 interface AnyAllRouteInfo {
     routeConfig: AnyRouteConfig;
@@ -551,11 +525,13 @@ type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends string, T
     ...Split<TFrom, false>,
     ...Split<RestTTo, false>,
     ...infer RestPath
-] ? `${TTo}${Join<RestPath>}` : never : './' | '../' | AllPaths;
-type NavigateOptionsAbsolute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = ToOptions<TAllRouteInfo, TFrom, TTo> & {
+] ? `${TTo}${Join<RestPath>}` : never : (TFrom extends `/` ? never : SplitPaths extends [...Split<TFrom, false>, ...infer RestPath] ? Join<RestPath> extends {
+    length: 0;
+} ? never : './' : never) | (TFrom extends `/` ? never : '../') | AllPaths;
+type NavigateOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends TAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = ToOptions<TAllRouteInfo, TFrom, TTo> & {
     replace?: boolean;
 };
-type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
+type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends TAllRouteInfo['routePaths'] = '/', TTo extends string = '.', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
     to?: ToPathOption<TAllRouteInfo, TFrom, TTo>;
     hash?: Updater<string>;
     state?: LocationState;
@@ -575,13 +551,13 @@ type PathParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromSc
     params: ParamsReducer<TFromFullParams, TToFullParams>;
 };
 type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo);
-type ToPathOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routePaths'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
-type ToIdOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routeIds'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+type ToPathOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends TAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routePaths'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+type ToIdOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends TAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routeIds'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
 interface ActiveOptions {
     exact?: boolean;
     includeHash?: boolean;
 }
-type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo> & {
+type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends TAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = NavigateOptions<TAllRouteInfo, TFrom, TTo> & {
     target?: HTMLAnchorElement['target'];
     activeOptions?: ActiveOptions;
     preload?: false | 'intent';
@@ -630,4 +606,11 @@ 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, 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 };
+/**
+ * This function returns `a` if `b` is deeply equal.
+ * If not, it will replace any deeply equal children of `b` with those of `a`.
+ * This can be used for structural sharing between JSON values for example.
+ */
+declare function sharedClone<T>(prev: any, next: T, touchAll?: boolean): T;
+
+export { Action, ActionFn, ActionState, ActiveOptions, 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, MatchCache, MatchCacheEntry, MatchLocation, MatchRouteOptions, NavigateOptions, NoInfer, ParentParams, ParsePathParams, ParseRouteConfig, PathParamMask, PathParamOptions, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, RegisterRouter, RegisteredAllRouteInfo, RegisteredRouter, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteMatch, RouteMatchStore, RouteMeta, RouteOptions, Router, RouterContext, RouterOptions, RouterStore, RoutesById, RoutesInfoInner, SearchFilter, SearchParamOptions, 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, resolvePath, rootRouteId, sharedClone, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, warning };