@tanstack/router-core 0.0.1-beta.1 → 0.0.1-beta.11

package/build/types/index.d.ts

@@ -55,6 +55,73 @@ 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;
+declare function pick<T, K extends keyof T>(parent: T, keys: K[]): Pick<T, K>;
+
+interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
+    matchId: string;
+    pathname: string;
+    params: TRouteInfo['params'];
+    parentMatch?: RouteMatch;
+    childMatches: RouteMatch[];
+    routeSearch: TRouteInfo['searchSchema'];
+    search: TRouteInfo['fullSearchSchema'];
+    status: 'idle' | 'loading' | 'success' | 'error';
+    updatedAt?: number;
+    error?: unknown;
+    isInvalid: boolean;
+    getIsInvalid: () => boolean;
+    loaderData: TRouteInfo['loaderData'];
+    routeLoaderData: TRouteInfo['routeLoaderData'];
+    isFetching: boolean;
+    isPending: boolean;
+    invalidAt: number;
+    __: {
+        element?: GetFrameworkGeneric<'Element'>;
+        errorElement?: GetFrameworkGeneric<'Element'>;
+        catchElement?: GetFrameworkGeneric<'Element'>;
+        pendingElement?: GetFrameworkGeneric<'Element'>;
+        loadPromise?: Promise<void>;
+        loaderDataPromise?: Promise<void>;
+        elementsPromise?: Promise<void>;
+        dataPromise?: Promise<void>;
+        pendingTimeout?: Timeout;
+        pendingMinTimeout?: Timeout;
+        pendingMinPromise?: Promise<void>;
+        onExit?: void | ((matchContext: {
+            params: TRouteInfo['allParams'];
+            search: TRouteInfo['fullSearchSchema'];
+        }) => void);
+        abortController: AbortController;
+        latestId: string;
+        validate: () => void;
+        startPending: () => void;
+        cancelPending: () => void;
+        notify: () => void;
+        resolve: () => void;
+    };
+    cancel: () => void;
+    load: (loaderOpts?: {
+        withPending?: boolean;
+    } & ({
+        preload: true;
+        maxAge: number;
+        gcMaxAge: number;
+    } | {
+        preload?: false;
+        maxAge?: never;
+        gcMaxAge?: never;
+    })) => Promise<TRouteInfo['routeLoaderData']>;
+    fetch: (opts?: {
+        maxAge?: number;
+    }) => Promise<TRouteInfo['routeLoaderData']>;
+    invalidate: () => void;
+    hasLoaders: () => boolean;
+}
+declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
+    matchId: string;
+    params: TRouteInfo['allParams'];
+    pathname: string;
+}): RouteMatch<TAllRouteInfo, TRouteInfo>;
 
 interface LocationState {
 }
@@ -102,18 +169,22 @@ interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
         route: AnyRoute;
         router: Router<any, any>;
     }) => void;
-    createElement?: (element: GetFrameworkGeneric<'Element'> | (() => Promise<GetFrameworkGeneric<'Element'>>)) => Promise<GetFrameworkGeneric<'Element'>>;
+    createElement?: (element: GetFrameworkGeneric<'SyncOrAsyncElement'>) => Promise<GetFrameworkGeneric<'Element'>>;
 }
 interface Action<TPayload = unknown, TResponse = unknown> {
-    submit: (submission?: TPayload) => Promise<TResponse>;
+    submit: (submission?: TPayload, actionOpts?: {
+        invalidate?: boolean;
+        multi?: boolean;
+    }) => Promise<TResponse>;
     current?: ActionState<TPayload, TResponse>;
     latest?: ActionState<TPayload, TResponse>;
-    pending: ActionState<TPayload, TResponse>[];
+    submissions: ActionState<TPayload, TResponse>[];
 }
 interface ActionState<TPayload = unknown, TResponse = unknown> {
     submittedAt: number;
     status: 'idle' | 'pending' | 'success' | 'error';
     submission: TPayload;
+    isMulti: boolean;
     data?: TResponse;
     error?: unknown;
 }
@@ -145,9 +216,6 @@ interface RouterState {
     location: Location;
     matches: RouteMatch[];
     lastUpdated: number;
-    loaderData: unknown;
-    currentAction?: ActionState;
-    latestAction?: ActionState;
     actions: Record<string, Action>;
     loaders: Record<string, Loader>;
     pending?: PendingState;
@@ -158,7 +226,7 @@ interface PendingState {
     location: Location;
     matches: RouteMatch[];
 }
-declare type Listener = () => void;
+declare type Listener = (router: Router<any, any>) => void;
 declare type ListenerFn = () => void;
 interface BuildNextOptions {
     to?: string | number | null;
@@ -186,6 +254,11 @@ interface MatchRouteOptions {
     pending: boolean;
     caseSensitive?: boolean;
 }
+interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated'> {
+    matches: DehydratedRouteMatch[];
+}
+interface DehydratedRouteMatch extends Pick<RouteMatch<any, any>, 'matchId' | 'status' | 'routeLoaderData' | 'loaderData' | 'isInvalid' | 'invalidAt'> {
+}
 interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
     history: BrowserHistory | MemoryHistory | HashHistory;
     options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
@@ -199,20 +272,17 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
     navigationPromise: Promise<void>;
-    removeActionQueue: {
-        action: Action;
-        actionState: ActionState;
-    }[];
     startedLoadingAt: number;
     resolveNavigation: () => void;
     subscribe: (listener: Listener) => () => void;
+    reset: () => void;
     notify: () => void;
     mount: () => () => void;
     onFocus: () => void;
     update: <TRouteConfig extends RouteConfig = RouteConfig>(opts?: RouterOptions<TRouteConfig>) => Router<TRouteConfig>;
     buildNext: (opts: BuildNextOptions) => Location;
     cancelMatches: () => void;
-    loadLocation: (next?: Location) => Promise<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]>;
@@ -241,6 +311,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;
     __: {
         buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
         parseLocation: (location: History['location'], previousLocation?: Location) => Location;
@@ -253,72 +325,6 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
 }
 declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>>(userOptions?: RouterOptions<TRouteConfig>): Router<TRouteConfig, TAllRouteInfo>;
 
-interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
-    matchId: string;
-    pathname: string;
-    params: TRouteInfo['params'];
-    parentMatch?: RouteMatch;
-    childMatches: RouteMatch[];
-    routeSearch: TRouteInfo['searchSchema'];
-    search: TRouteInfo['fullSearchSchema'];
-    status: 'idle' | 'loading' | 'success' | 'error';
-    updatedAt?: number;
-    error?: unknown;
-    isInvalid: boolean;
-    getIsInvalid: () => boolean;
-    loaderData: TRouteInfo['loaderData'];
-    routeLoaderData: TRouteInfo['routeLoaderData'];
-    isFetching: boolean;
-    isPending: boolean;
-    invalidAt: number;
-    __: {
-        element?: GetFrameworkGeneric<'Element'>;
-        errorElement?: GetFrameworkGeneric<'Element'>;
-        catchElement?: GetFrameworkGeneric<'Element'>;
-        pendingElement?: GetFrameworkGeneric<'Element'>;
-        loadPromise?: Promise<void>;
-        loaderPromise?: Promise<void>;
-        elementsPromise?: Promise<void>;
-        dataPromise?: Promise<void>;
-        pendingTimeout?: Timeout;
-        pendingMinTimeout?: Timeout;
-        pendingMinPromise?: Promise<void>;
-        onExit?: void | ((matchContext: {
-            params: TRouteInfo['allParams'];
-            search: TRouteInfo['fullSearchSchema'];
-        }) => void);
-        abortController: AbortController;
-        latestId: string;
-        validate: () => void;
-        startPending: () => void;
-        cancelPending: () => void;
-        notify: () => void;
-        resolve: () => void;
-    };
-    cancel: () => void;
-    load: (loaderOpts?: {
-        withPending?: boolean;
-    } & ({
-        preload: true;
-        maxAge: number;
-        gcMaxAge: number;
-    } | {
-        preload?: false;
-        maxAge?: never;
-        gcMaxAge?: never;
-    })) => Promise<TRouteInfo['routeLoaderData']>;
-    fetch: (opts?: {
-        maxAge?: number;
-    }) => Promise<TRouteInfo['routeLoaderData']>;
-    invalidate: () => void;
-    hasLoaders: () => boolean;
-}
-declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
-    matchId: string;
-    params: TRouteInfo['allParams'];
-    pathname: string;
-}): RouteMatch<TAllRouteInfo, TRouteInfo>;
-
 interface AnyRoute extends Route<any, any> {
 }
 interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
@@ -337,7 +343,6 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     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 cascadeLoaderData(matches: RouteMatch<any, any>[]): void;
 
 interface AnyAllRouteInfo {
     routeConfig: AnyRouteConfig;
@@ -609,4 +614,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, cascadeLoaderData, cleanPath, createRoute, createRouteConfig, createRouteMatch, createRouter, decode, defaultParseSearch, defaultStringifySearch, encode, functionalUpdate, interpolatePath, joinPaths, last, matchByPath, matchPathname, parsePathname, parseSearchWith, 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, 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 };