@tanstack/router-core 0.0.1-alpha.0

package/build/types/index.d.ts

@@ -0,0 +1,517 @@
+/**
+ * router-core
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+import { BrowserHistory, MemoryHistory, HashHistory, History } from 'history';
+export { createBrowserHistory, createHashHistory, createMemoryHistory } from 'history';
+
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
+declare type IsAny<T, Y, N> = 1 extends 0 & T ? Y : N;
+declare type IsAnyBoolean<T> = 1 extends 0 & T ? true : false;
+declare type IsKnown<T, Y, N> = unknown extends T ? N : Y;
+declare type PickAsRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+declare type PickAsPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+declare type PickUnsafe<T, K> = K extends keyof T ? Pick<T, K> : never;
+declare type PickExtra<T, K> = Expand<{
+    [TKey in keyof K as string extends TKey ? never : TKey extends keyof T ? never : TKey]: K[TKey];
+}>;
+declare type PickRequired<T> = {
+    [K in keyof T as undefined extends T[K] ? never : K]: T[K];
+};
+declare type StartsWith<A, B> = A extends `${B extends string ? B : never}${infer _}` ? true : false;
+declare type Expand<T> = T extends object ? T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never : T;
+interface FrameworkGenerics {
+}
+interface RouteConfig<TId extends string = string, TPath extends string = string, TFullPath extends string = string, TRouteLoaderData extends AnyLoaderData = AnyLoaderData, TLoaderData extends AnyLoaderData = AnyLoaderData, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}, TKnownChildren = unknown> {
+    id: TId;
+    path: NoInfer<TPath>;
+    fullPath: TFullPath;
+    options: RouteOptions<TPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
+    children?: TKnownChildren;
+    addChildren: IsAny<TId, any, <TNewChildren extends any>(cb: (createChildRoute: CreateRouteConfigFn<false, TId, TLoaderData, TFullSearchSchema, TAllParams>) => TNewChildren extends AnyRouteConfig[] ? TNewChildren : {
+        error: 'Invalid route detected';
+        route: TNewChildren;
+    }) => RouteConfig<TId, TPath, TFullPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams, TNewChildren>>;
+}
+declare type CreateRouteConfigFn<TIsRoot extends boolean = false, TParentId extends string = string, TParentAllLoaderData extends AnyLoaderData = {}, TParentSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}> = <TPath extends string, TRouteLoaderData extends AnyLoaderData, TActionPayload, TActionResponse, TSearchSchema extends AnySearchSchema = AnySearchSchema, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams> = AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams>, TKnownChildren extends RouteConfig[] = RouteConfig[]>(options?: TIsRoot extends true ? Omit<RouteOptions<TPath, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, 'path'> & {
+    path?: never;
+} : RouteOptions<TPath, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, children?: TKnownChildren, isRoot?: boolean, parentId?: string) => RouteConfig<RouteId<TParentId, TPath>, TPath, RouteIdToPath<RouteId<TParentId, TPath>>, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>, TKnownChildren>;
+declare const createRouteConfig: CreateRouteConfigFn<true>;
+interface AnyRouteConfig extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any> {
+}
+interface AnyRouteConfigWithChildren<TChildren> extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any, TChildren> {
+}
+interface AnyAllRouteInfo {
+    routeConfig: AnyRouteConfig;
+    routeInfo: AnyRouteInfo;
+    routeInfoById: Record<string, AnyRouteInfo>;
+    routeInfoByFullPath: Record<string, AnyRouteInfo>;
+    fullPath: string;
+}
+interface DefaultAllRouteInfo {
+    routeConfig: RouteConfig;
+    routeInfo: RouteInfo;
+    routeInfoById: Record<string, RouteInfo>;
+    routeInfoByFullPath: Record<string, RouteInfo>;
+    fullPath: string;
+}
+interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig> extends RoutesInfoInner<TRouteConfig, ParseRouteConfig<TRouteConfig>> {
+}
+interface RoutesInfoInner<TRouteConfig extends AnyRouteConfig, TRouteInfo extends RouteInfo<string, string, any, any, any, any, any, any, any, any, any, any> = RouteInfo> {
+    routeConfig: TRouteConfig;
+    routeInfo: TRouteInfo;
+    routeInfoById: {
+        [TInfo in TRouteInfo as TInfo['id']]: TInfo;
+    };
+    routeInfoByFullPath: {
+        [TInfo in TRouteInfo as TInfo['id'] extends RootRouteId ? never : RouteIdToPath<TInfo['id']>]: TInfo;
+    };
+    fullPath: RouteIdToPath<TRouteInfo['id']>;
+}
+interface AnyRoute extends Route<any, any> {
+}
+interface AnyRouteInfo extends RouteInfo<any, any, any, any, any, any, any, any, any, any, any, any, any> {
+}
+declare type RouteIdToPath<T extends string> = T extends RootRouteId ? '/' : TrimPathRight<`${T}`>;
+declare type ParseRouteConfig<TRouteConfig = AnyRouteConfig> = TRouteConfig extends AnyRouteConfig ? RouteConfigRoute<TRouteConfig> | ParseRouteChildren<TRouteConfig> : never;
+declare type ParseRouteChildren<TRouteConfig> = TRouteConfig extends AnyRouteConfigWithChildren<infer TChildren> ? unknown extends TChildren ? never : TChildren extends AnyRouteConfig[] ? Values<{
+    [TId in TChildren[number]['id']]: ParseRouteChild<TChildren[number], TId>;
+}> : never : never;
+declare type ParseRouteChild<TRouteConfig, TId> = TRouteConfig & {
+    id: TId;
+} extends AnyRouteConfig ? ParseRouteConfig<TRouteConfig> : never;
+declare type Values<O> = O[ValueKeys<O>];
+declare type ValueKeys<O> = Extract<keyof O, PropertyKey>;
+declare type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<infer TId, infer TPath, infer TFullPath, infer TRouteLoaderData, infer TLoaderData, infer TActionPayload, infer TActionResponse, infer TParentSearchSchema, infer TSearchSchema, infer TFullSearchSchema, infer TParentParams, infer TParams, infer TAllParams, any> ? string extends TId ? never : RouteInfo<TId, TPath, TFullPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams> : never;
+interface RouteInfo<TId extends string = string, TPath extends string = string, TFullPath extends {} = string, TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}> {
+    id: TId;
+    path: TPath;
+    fullPath: TFullPath;
+    routeLoaderData: TRouteLoaderData;
+    loaderData: TLoaderData;
+    actionPayload: TActionPayload;
+    actionResponse: TActionResponse;
+    searchSchema: TSearchSchema;
+    fullSearchSchema: TFullSearchSchema;
+    parentParams: TParentParams;
+    params: TParams;
+    allParams: TAllParams;
+    options: RouteOptions<TPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
+}
+declare type DeepAwaited<T> = T extends Promise<infer A> ? DeepAwaited<A> : T extends Record<infer A, Promise<infer B>> ? {
+    [K in A]: DeepAwaited<B>;
+} : T;
+declare const rootRouteId: "__root__";
+declare type RootRouteId = typeof rootRouteId;
+declare type RouteId<TPrefix extends string, TPath extends string> = string extends TPath ? RootRouteId : `${TPrefix}/${TPath}` extends '/' ? '/' : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TPath>}`>}`;
+declare type CleanPath<T extends string> = T extends `${infer L}//${infer R}` ? CleanPath<`${CleanPath<L>}/${CleanPath<R>}`> : T extends `${infer L}//` ? `${CleanPath<L>}/` : T extends `//${infer L}` ? `/${CleanPath<L>}` : T;
+declare type TrimPath<T extends string> = '' extends T ? '' : TrimPathRight<TrimPathLeft<T>>;
+declare type TrimPathLeft<T extends string> = T extends `${RootRouteId}/${infer U}` ? TrimPathLeft<U> : T extends `/${infer U}` ? TrimPathLeft<U> : T;
+declare type TrimPathRight<T extends string> = T extends '/' ? '/' : T extends `${infer U}/` ? TrimPathRight<U> : T;
+declare type ParsePathParams<T extends string> = Split<T>[number] extends infer U ? U extends `:${infer V}` ? V : never : never;
+declare type PathParamMask<TRoutePath extends string> = TRoutePath extends `${infer L}/:${infer C}/${infer R}` ? PathParamMask<`${L}/${string}/${R}`> : TRoutePath extends `${infer L}/:${infer C}` ? PathParamMask<`${L}/${string}`> : TRoutePath;
+declare type Split<S, TTrailing = true> = S extends unknown ? string extends S ? string[] : S extends string ? CleanPath<S> extends '' ? [] : TTrailing extends true ? CleanPath<S> extends `${infer T}/` ? [T, '/'] : CleanPath<S> extends `/${infer U}` ? ['/', U] : CleanPath<S> extends `${infer T}/${infer U}` ? [T, ...Split<U>] : [S] : CleanPath<S> extends `${infer T}/${infer U}` ? [T, ...Split<U>] : [S] : never : never;
+declare type Join<T> = T extends [] ? '' : T extends [infer L extends string] ? L : T extends [infer L extends string, ...infer Tail extends [...string[]]] ? CleanPath<`${L}/${Join<Tail>}`> : never;
+declare type AnySearchSchema = {};
+declare type AnyLoaderData = {};
+declare type AnyPathParams = {};
+interface RouteMeta {
+}
+interface LocationState {
+}
+declare type Timeout = ReturnType<typeof setTimeout>;
+declare type SearchSerializer = (searchObj: Record<string, any>) => string;
+declare type SearchParser = (searchStr: string) => Record<string, any>;
+declare type Updater<TPrevious, TResult = TPrevious> = TResult | ((prev?: TPrevious) => TResult);
+interface Location<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
+    href: string;
+    pathname: string;
+    search: TSearchObj;
+    searchStr: string;
+    state: TState;
+    hash: string;
+    key?: string;
+}
+interface FromLocation {
+    pathname: string;
+    search?: unknown;
+    key?: string;
+    hash?: string;
+}
+declare type PickExtract<T, U> = {
+    [K in keyof T as T[K] extends U ? K : never]: T[K];
+};
+declare type PickExclude<T, U> = {
+    [K in keyof T as T[K] extends U ? never : K]: T[K];
+};
+declare type SearchSchemaValidator<TReturn, TParentSchema> = (searchObj: Record<string, unknown>) => {} extends TParentSchema ? TReturn : keyof TReturn extends keyof TParentSchema ? {
+    error: 'Top level search params cannot be redefined by child routes!';
+    keys: keyof TReturn & keyof TParentSchema;
+} : TReturn;
+declare type DefinedPathParamWarning = 'Path params cannot be redefined by child routes!';
+declare type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
+    [Key in keyof TParentParams]?: DefinedPathParamWarning;
+};
+declare type RouteOptions<TPath extends string = string, TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = TSearchSchema, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}> = {
+    path: TPath;
+    caseSensitive?: boolean;
+    validateSearch?: SearchSchemaValidator<TSearchSchema, TParentSearchSchema>;
+    preSearchFilters?: SearchFilter<TFullSearchSchema>[];
+    postSearchFilters?: SearchFilter<TFullSearchSchema>[];
+    pendingMs?: number;
+    pendingMinMs?: number;
+} & ({
+    parseParams?: never;
+    stringifyParams?: never;
+} | {
+    parseParams: (rawParams: IsAny<TPath, any, Record<ParsePathParams<TPath>, string>>) => TParams;
+    stringifyParams: (params: TParams) => Record<ParsePathParams<TPath>, string>;
+}) & RouteLoaders<TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TFullSearchSchema, TAllParams> & {
+    import?: (opts: {
+        params: AnyPathParams;
+    }) => Promise<RouteLoaders<TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TFullSearchSchema, TAllParams>>;
+} & (PickUnsafe<TParentParams, ParsePathParams<TPath>> extends never ? {} : 'Cannot redefined path params in child routes!');
+interface RouteLoaders<TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> {
+    element?: GetFrameworkGeneric<'SyncOrAsyncElement', NoInfer<TLoaderData>>;
+    errorElement?: GetFrameworkGeneric<'SyncOrAsyncElement', NoInfer<TLoaderData>>;
+    catchElement?: GetFrameworkGeneric<'SyncOrAsyncElement', NoInfer<TLoaderData>>;
+    pendingElement?: GetFrameworkGeneric<'SyncOrAsyncElement', NoInfer<TLoaderData>>;
+    loader?: LoaderFn<TRouteLoaderData, TFullSearchSchema, TAllParams>;
+    action?: ActionFn<TActionPayload, TActionResponse>;
+    useErrorBoundary?: boolean;
+    onMatch?: (matchContext: {
+        params: TAllParams;
+        search: TFullSearchSchema;
+    }) => void | undefined | ((match: {
+        params: TAllParams;
+        search: TFullSearchSchema;
+    }) => void);
+    onTransition?: (match: {
+        params: TAllParams;
+        search: TFullSearchSchema;
+    }) => void;
+    meta?: RouteMeta;
+}
+declare type SearchFilter<T, U = T> = (prev: T) => U;
+interface MatchLocation {
+    to?: string | number | null;
+    fuzzy?: boolean;
+    caseSensitive?: boolean;
+    from?: string;
+    fromCurrent?: boolean;
+}
+declare type SearchPredicate<TSearch extends AnySearchSchema = {}> = (search: TSearch) => any;
+declare type LoaderFn<TRouteLoaderData extends AnyLoaderData, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> = (loaderContext: {
+    params: TAllParams;
+    search: TFullSearchSchema;
+    signal?: AbortSignal;
+}) => Promise<TRouteLoaderData>;
+declare type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (submission: TActionPayload) => TActionResponse | Promise<TActionResponse>;
+declare type UnloaderFn<TPath extends string> = (routeMatch: RouteMatch<any, RouteInfo<string, TPath>>) => void;
+interface RouterState {
+    status: 'idle' | 'loading';
+    location: Location;
+    matches: RouteMatch[];
+    lastUpdated: number;
+    loaderData: unknown;
+    action?: ActionState;
+    actions: Record<string, Action>;
+    pending?: PendingState;
+}
+interface PendingState {
+    location: Location;
+    matches: RouteMatch[];
+}
+declare type ListenerFn = () => void;
+interface Segment {
+    type: 'pathname' | 'param' | 'wildcard';
+    value: string;
+}
+declare type GetFrameworkGeneric<U, TData = unknown> = U extends keyof FrameworkGenerics ? FrameworkGenerics[U] : any;
+interface __Experimental__RouterSnapshot {
+    location: Location;
+    matches: SnapshotRouteMatch<unknown>[];
+}
+interface SnapshotRouteMatch<TData> {
+    matchId: string;
+    loaderData: TData;
+}
+interface BuildNextOptions {
+    to?: string | number | null;
+    params?: true | Updater<Record<string, any>>;
+    search?: true | Updater<unknown>;
+    hash?: true | Updater<string>;
+    key?: string;
+    from?: string;
+    fromCurrent?: boolean;
+    __preSearchFilters?: SearchFilter<any>[];
+    __postSearchFilters?: SearchFilter<any>[];
+}
+interface ActiveOptions {
+    exact?: boolean;
+    includeHash?: boolean;
+}
+declare type FilterRoutesFn = <TRoute extends Route<any, RouteInfo>>(routeConfigs: TRoute[]) => TRoute[];
+declare type Listener = () => void;
+interface MatchRouteOptions {
+    pending: boolean;
+    caseSensitive?: boolean;
+}
+declare type LinkInfo = {
+    type: 'external';
+    href: string;
+} | {
+    type: 'internal';
+    next: Location;
+    handleFocus: (e: any) => void;
+    handleClick: (e: any) => void;
+    handleEnter: (e: any) => void;
+    handleLeave: (e: any) => void;
+    isActive: boolean;
+    disabled?: boolean;
+};
+declare type PreloadCacheEntry = {
+    maxAge: number;
+    match: RouteMatch;
+};
+interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
+    history?: BrowserHistory | MemoryHistory | HashHistory;
+    stringifySearch?: SearchSerializer;
+    parseSearch?: SearchParser;
+    filterRoutes?: FilterRoutesFn;
+    defaultLinkPreload?: false | 'intent';
+    defaultLinkPreloadMaxAge?: number;
+    defaultLinkPreloadDelay?: number;
+    useErrorBoundary?: boolean;
+    defaultElement?: GetFrameworkGeneric<'Element'>;
+    defaultErrorElement?: GetFrameworkGeneric<'Element'>;
+    defaultCatchElement?: GetFrameworkGeneric<'Element'>;
+    defaultPendingElement?: GetFrameworkGeneric<'Element'>;
+    defaultPendingMs?: number;
+    defaultPendingMinMs?: number;
+    caseSensitive?: boolean;
+    __experimental__snapshot?: __Experimental__RouterSnapshot;
+    routeConfig?: TRouteConfig;
+    basepath?: string;
+    createRouter?: (router: Router<any, any>) => void;
+    createRoute?: (opts: {
+        route: AnyRoute;
+        router: Router<any, any>;
+    }) => void;
+}
+interface Action<TPayload = unknown, TResponse = unknown> {
+    submit: (submission?: TPayload) => Promise<TResponse>;
+    latest?: ActionState;
+    pending: ActionState<TPayload, TResponse>[];
+}
+interface ActionState<TPayload = unknown, TResponse = unknown> {
+    submittedAt: number;
+    status: 'idle' | 'pending' | 'success' | 'error';
+    submission: TPayload;
+    data?: TResponse;
+    error?: unknown;
+}
+declare type RoutesById<TAllRouteInfo extends AnyAllRouteInfo> = {
+    [K in keyof TAllRouteInfo['routeInfoById']]: Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][K]>;
+};
+declare type ValidFromPath<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = undefined | (string extends TAllRouteInfo['fullPath'] ? string : TAllRouteInfo['fullPath']);
+interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
+    options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
+    basepath: string;
+    allRouteInfo: TAllRouteInfo;
+    listeners: Listener[];
+    location: Location;
+    navigateTimeout?: Timeout;
+    nextAction?: 'push' | 'replace';
+    state: RouterState;
+    routeTree: Route<TAllRouteInfo, RouteInfo>;
+    routesById: RoutesById<TAllRouteInfo>;
+    navigationPromise: Promise<void>;
+    startedLoadingAt: number;
+    destroy: () => void;
+    resolveNavigation: () => void;
+    subscribe: (listener: Listener) => () => void;
+    notify: () => void;
+    mount: () => Promise<void>;
+    update: <TRouteConfig extends RouteConfig = RouteConfig>(opts?: RouterOptions<TRouteConfig>) => Router<TRouteConfig>;
+    buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
+    parseLocation: (location: History['location'], previousLocation?: Location) => Location;
+    buildLocation: (dest: BuildNextOptions) => Location;
+    commitLocation: (next: Location, replace?: boolean) => Promise<void>;
+    buildNext: (opts: BuildNextOptions) => Location;
+    cancelMatches: () => void;
+    loadLocation: (next?: Location) => Promise<void>;
+    preloadCache: Record<string, PreloadCacheEntry>;
+    cleanPreloadCache: () => void;
+    getRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(id: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
+    loadRoute: (navigateOpts: BuildNextOptions, loaderOpts: {
+        maxAge: number;
+    }) => Promise<RouteMatch[]>;
+    matchRoutes: (pathname: string, opts?: {
+        strictParseParams?: boolean;
+    }) => RouteMatch[];
+    loadMatches: (resolvedMatches: RouteMatch[], loaderOpts?: {
+        withPending?: boolean;
+    } & ({
+        preload: true;
+        maxAge: number;
+    } | {
+        preload?: false;
+        maxAge?: never;
+    })) => Promise<RouteMatch[]>;
+    invalidateRoute: (opts: MatchLocation) => void;
+    reload: () => Promise<void>;
+    resolvePath: (from: string, path: string) => string;
+    _navigate: (location: BuildNextOptions & {
+        replace?: boolean;
+    }) => Promise<void>;
+    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;
+    __experimental__createSnapshot: () => __Experimental__RouterSnapshot;
+}
+declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>>(userOptions?: RouterOptions<TRouteConfig>): Router<TRouteConfig, TAllRouteInfo>;
+interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
+    routeId: TRouteInfo['id'];
+    routePath: TRouteInfo['path'];
+    fullPath: TRouteInfo['fullPath'];
+    parentRoute?: AnyRoute;
+    childRoutes?: AnyRoute[];
+    options: RouteOptions;
+    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: 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>;
+    action: unknown extends TRouteInfo['actionResponse'] ? Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']> | undefined : Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']>;
+}
+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 type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends string, TTo extends string, SplitPaths extends string[] = Split<AllPaths, false>> = TTo extends `..${infer _}` ? SplitPaths extends [
+    ...Split<ResolveRelativePath<TFrom, TTo>, false>,
+    ...infer TToRest
+] ? `${CleanPath<Join<[
+    ...Split<TTo, false>,
+    ...(TToRest | (Split<ResolveRelativePath<TFrom, TTo>, false>['length'] extends 1 ? never : ['../']))
+]>>}` : never : TTo extends `./${infer RestTTo}` ? SplitPaths extends [
+    ...Split<TFrom, false>,
+    ...Split<RestTTo, false>,
+    ...infer RestPath
+] ? `${TTo}${Join<RestPath>}` : never : './' | '../' | AllPaths;
+declare type NavigateOptionsAbsolute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = ToOptions<TAllRouteInfo, TFrom, TTo> & {
+    replace?: boolean;
+};
+declare type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
+    to?: ToPathOption<TAllRouteInfo, TFrom, TTo>;
+    hash?: Updater<string>;
+    from?: TFrom;
+} & SearchParamOptions<TAllRouteInfo, TFrom, TResolvedTo> & PathParamOptions<TAllRouteInfo, TFrom, TResolvedTo>;
+declare type ToPathOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['fullPath'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+declare type ToIdOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routeInfo']['id'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+declare type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo> & {
+    target?: HTMLAnchorElement['target'];
+    activeOptions?: ActiveOptions;
+    preload?: false | 'intent';
+    preloadMaxAge?: number;
+    preloadDelay?: number;
+    disabled?: boolean;
+};
+declare type CheckRelativePath<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo> = TTo extends string ? TFrom extends string ? ResolveRelativePath<TFrom, TTo> extends TAllRouteInfo['fullPath'] ? {} : {
+    Error: `${TFrom} + ${TTo} resolves to ${ResolveRelativePath<TFrom, TTo>}, which is not a valid route path.`;
+    'Valid Route Paths': TAllRouteInfo['fullPath'];
+} : {} : {};
+declare type ResolveRelativePath<TFrom, TTo = '.', TRooted = false> = TFrom extends string ? TTo extends string ? TTo extends '.' ? TFrom : TTo extends `./` ? Join<[TFrom, '/']> : TTo extends `./${infer TRest}` ? ResolveRelativePath<TFrom, TRest> : TTo extends `/${infer TRest}` ? TTo : Split<TTo> extends ['..', ...infer ToRest] ? Split<TFrom> extends [...infer FromRest, infer FromTail] ? ResolveRelativePath<Join<FromRest>, Join<ToRest>> : never : Split<TTo> extends ['.', ...infer ToRest] ? ResolveRelativePath<TFrom, Join<ToRest>> : CleanPath<Join<['/', ...Split<TFrom>, ...Split<TTo>]>> : never : never;
+declare type RouteInfoById<TAllRouteInfo extends AnyAllRouteInfo, TId> = TId extends keyof TAllRouteInfo['routeInfoById'] ? IsAny<TAllRouteInfo['routeInfoById'][TId]['id'], RouteInfo, TAllRouteInfo['routeInfoById'][TId]> : never;
+declare type RouteInfoByPath<TAllRouteInfo extends AnyAllRouteInfo, TPath> = TPath extends keyof TAllRouteInfo['routeInfoByFullPath'] ? IsAny<TAllRouteInfo['routeInfoByFullPath'][TPath]['id'], RouteInfo, TAllRouteInfo['routeInfoByFullPath'][TPath]> : never;
+declare type SearchParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'], TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema']> = StartsWith<TFrom, TTo> extends true ? {
+    search?: SearchReducer<TFromSchema, TToSchema>;
+} : keyof PickRequired<TToSchema> extends never ? {
+    search?: SearchReducer<TFromSchema, TToSchema>;
+} : {
+    search: SearchReducer<TFromSchema, TToSchema>;
+};
+declare type SearchReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo);
+declare type PathParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromParams = RouteInfoByPath<TAllRouteInfo, TFrom>['allParams'], TToParams = RouteInfoByPath<TAllRouteInfo, TTo>['allParams']> = StartsWith<TFrom, TTo> extends true ? {
+    params?: ParamsReducer<TFromParams, TToParams>;
+} : AnyPathParams extends TToParams ? {
+    params?: ParamsReducer<TFromParams, Record<string, never>>;
+} : {
+    params: ParamsReducer<TFromParams, TToParams>;
+};
+declare type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo);
+interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
+    matchId: string;
+    pathname: string;
+    params: AnyPathParams;
+    parentMatch?: RouteMatch;
+    childMatches: RouteMatch[];
+    routeSearch: TRouteInfo['searchSchema'];
+    search: TRouteInfo['fullSearchSchema'];
+    status: 'idle' | 'loading' | 'success' | 'error';
+    updatedAt?: number;
+    error?: unknown;
+    isInvalid: boolean;
+    loaderData: TRouteInfo['loaderData'];
+    routeLoaderData: TRouteInfo['routeLoaderData'];
+    isFetching: boolean;
+    isPending: boolean;
+    __: {
+        element?: GetFrameworkGeneric<'Element', TRouteInfo['loaderData']>;
+        errorElement?: GetFrameworkGeneric<'Element', TRouteInfo['loaderData']>;
+        catchElement?: GetFrameworkGeneric<'Element', TRouteInfo['loaderData']>;
+        pendingElement?: GetFrameworkGeneric<'Element', TRouteInfo['loaderData']>;
+        loadPromise?: Promise<void>;
+        loaderPromise?: Promise<void>;
+        importPromise?: 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;
+        setParentMatch: (parentMatch: RouteMatch) => void;
+        addChildMatch: (childMatch: RouteMatch) => void;
+        validate: () => void;
+        startPending: () => void;
+        cancelPending: () => void;
+        notify: () => void;
+        resolve: () => void;
+    };
+    cancel: () => void;
+    load: () => Promise<void>;
+}
+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>;
+declare function matchPathname(currentPathname: string, matchLocation: Pick<MatchLocation, 'to' | 'fuzzy' | 'caseSensitive'>): AnyPathParams | undefined;
+declare function warning(cond: any, message: string): cond is true;
+declare function functionalUpdate<TResult>(updater?: Updater<TResult>, previous?: TResult): TResult | undefined;
+declare function matchByPath(from: string, matchLocation: Pick<MatchLocation, 'to' | 'caseSensitive' | 'fuzzy'>): Record<string, string> | undefined;
+declare function parsePathname(pathname?: string): Segment[];
+declare function resolvePath(basepath: string, base: string, to: string): string;
+/**
+ * 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 const defaultParseSearch: (searchStr: string) => AnySearchSchema;
+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;
+declare function last<T>(arr: T[]): T | undefined;
+
+export { Action, ActionFn, ActionState, AllRouteInfo, AnyAllRouteInfo, AnyLoaderData, AnyPathParams, AnyRoute, AnyRouteConfig, AnyRouteConfigWithChildren, AnyRouteInfo, AnySearchSchema, BuildNextOptions, CheckRelativePath, DefaultAllRouteInfo, DefinedPathParamWarning, FilterRoutesFn, FrameworkGenerics, FromLocation, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, LoaderFn, Location, LocationState, MatchLocation, MatchRouteOptions, NavigateOptionsAbsolute, NoInfer, ParentParams, ParsePathParams, PathParamMask, PendingState, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickUnsafe, PreloadCacheEntry, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteLoaders, RouteMatch, RouteMeta, RouteOptions, Router, RouterOptions, RouterState, RoutesInfoInner, SearchFilter, SearchParser, SearchPredicate, SearchSchemaValidator, SearchSerializer, Segment, SnapshotRouteMatch, ToIdOption, ToOptions, ToPathOption, UnloaderFn, Updater, ValidFromPath, ValueKeys, Values, __Experimental__RouterSnapshot, createRoute, createRouteConfig, createRouteMatch, createRouter, defaultParseSearch, defaultStringifySearch, functionalUpdate, last, matchByPath, matchPathname, parsePathname, parseSearchWith, replaceEqualDeep, resolvePath, rootRouteId, stringifySearchWith, warning };

package/build/types/qss.d.ts

@@ -0,0 +1,2 @@
+export declare function encode(obj: any, pfx?: string): string;
+export declare function decode(str: any): {};

package/build/types/react-router/src/index.d.ts

@@ -0,0 +1,59 @@
+import * as React from 'react';
+import { Router, RouterOptions, RouteMatch, RouteParams, NavigateOptions, MatchLocation, MatchRouteOptions, LinkOptions, RouteDef, RoutesInfo } from '@tanstack/router-core';
+export * from '@tanstack/router-core';
+declare module '@tanstack/router-core' {
+    interface FrameworkGenerics {
+        Element: React.ReactNode;
+        AsyncElement: (opts: {
+            params: Record<string, string>;
+        }) => Promise<React.ReactNode>;
+        SyncOrAsyncElement: React.ReactNode | FrameworkGenerics['AsyncElement'];
+        LinkProps: React.HTMLAttributes<unknown>;
+    }
+}
+export declare type PromptProps = {
+    message: string;
+    when?: boolean | any;
+    children?: React.ReactNode;
+};
+export declare type MatchesProviderProps = {
+    value: RouteMatch[];
+    children: React.ReactNode;
+};
+export declare function MatchesProvider(props: MatchesProviderProps): JSX.Element;
+export declare type RouterProps<TRouteDefs extends RouteDef = RouteDef> = RouterOptions<TRouteDefs> & {
+    router: Router<TRouteDefs>;
+    children?: React.ReactNode;
+};
+export declare class ReactRouter<TRouteDefs extends RouteDef = RouteDef, TRoutesInfo extends RoutesInfo<TRouteDefs> = RoutesInfo<TRouteDefs>> extends Router<TRouteDefs, TRoutesInfo> {
+    constructor(options: RouterOptions<TRouteDefs>);
+}
+export declare function RouterProvider<TRouteDefs extends RouteDef = RouteDef>({ children, router, ...rest }: RouterProps<TRouteDefs>): JSX.Element;
+export declare function useRouter(): Router;
+export declare function useMatches(): RouteMatch[];
+export declare function useParentMatches(): RouteMatch[];
+export declare function useMatch<T>(): RouteMatch;
+export declare function useLoaderData(): unknown;
+export declare function useAction<TPayload = unknown, TResponse = unknown, TError = unknown>(opts?: Pick<NavigateOptions, 'to' | 'from'>): import("@tanstack/router-core").Action<TPayload, TResponse>;
+export declare function useMatchRoute(): (matchLocation: MatchLocation, opts?: MatchRouteOptions | undefined) => RouteParams | undefined;
+export declare type MatchRouteProps = MatchLocation & MatchRouteOptions & {
+    children: React.ReactNode | ((routeParams?: RouteParams) => React.ReactNode);
+};
+export declare function MatchRoute({ children, pending, caseSensitive, ...rest }: MatchRouteProps): JSX.Element;
+export declare function useLoadRoute(): (navigateOpts: NavigateOptions, loaderOpts: {
+    maxAge: number;
+}) => Promise<RouteMatch<string, string, {}, {}, unknown, unknown, {}, {}, Record<never, string>>[]>;
+export declare function useInvalidateRoute(): (navigateOpts?: MatchLocation | undefined) => Promise<void>;
+export declare function useNavigate(): (options: NavigateOptions) => Promise<void>;
+export declare function Navigate(options: NavigateOptions): null;
+export declare function Outlet(): JSX.Element | null;
+export declare function useResolvePath(): (path: string) => string;
+export declare function useSearch(): {};
+export declare type LinkProps<TRoutesInfo extends RoutesInfo = RoutesInfo, TRouteId extends keyof TRoutesInfo['routesById'] = any> = LinkOptions & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href' | 'children' | keyof LinkOptions> & {
+    _ref?: React.Ref<HTMLAnchorElement>;
+    children?: React.ReactNode | ((state: {
+        isActive: boolean;
+    }) => React.ReactNode);
+};
+export declare function useLink(opts: LinkOptions): import("@tanstack/router-core").LinkInfo | null;
+export declare function Link<TRoutesInfo>(props: LinkProps): JSX.Element;

package/build/types/router-core/src/createRoutes.test.d.ts

@@ -0,0 +1 @@
+export {};