@tanstack/react-router 1.2.6 → 1.3.0

package/build/types/link.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { Trim } from './fileRoute';
 import { AnyRoute, ReactNode, RootSearchSchema } from './route';
-import { RouteByPath, RouteIds, RoutePaths } from './routeInfo';
+import { RouteByPath, RoutePaths } from './routeInfo';
 import { RegisteredRouter } from './router';
 import { LinkProps, UseLinkPropsOptions } from './useNavigate';
 import { Expand, NoInfer, NonNullableUpdater, PickRequired, Updater, WithoutEmpty } from './utils';
@@ -56,7 +56,6 @@ type MakePathParamOptions<T> = {
 export type SearchParamOptions<TRouteTree extends AnyRoute, TFrom, TTo extends string, TResolved> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'SEARCH'>;
 export type PathParamOptions<TRouteTree extends AnyRoute, TFrom, TTo extends string, TResolved> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'PATH'>;
 export type ToPathOption<TRouteTree extends AnyRoute = AnyRoute, TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string = ''> = TTo | RelativeToPathAutoComplete<RoutePaths<TRouteTree>, NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
-export type ToIdOption<TRouteTree extends AnyRoute = AnyRoute, TFrom extends RoutePaths<TRouteTree> | undefined = undefined, TTo extends string = ''> = TTo | RelativeToPathAutoComplete<RouteIds<TRouteTree>, NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
 export interface ActiveOptions {
     exact?: boolean;
     includeHash?: boolean;
@@ -69,19 +68,10 @@ export type LinkOptions<TRouteTree extends AnyRoute = RegisteredRouter['routeTre
     preloadDelay?: number;
     disabled?: boolean;
 };
-export type CheckRelativePath<TRouteTree extends AnyRoute, TFrom, TTo> = TTo extends string ? TFrom extends string ? ResolveRelativePath<TFrom, TTo> extends RoutePaths<TRouteTree> ? {} : {
-    Error: `${TFrom} + ${TTo} resolves to ${ResolveRelativePath<TFrom, TTo>}, which is not a valid route path.`;
-    'Valid Route Paths': RoutePaths<TRouteTree>;
-} : {} : {};
 export type CheckPath<TRouteTree extends AnyRoute, TPath, TPass> = Exclude<TPath, RoutePaths<TRouteTree>> extends never ? TPass : CheckPathError<TRouteTree, Exclude<TPath, RoutePaths<TRouteTree>>>;
 export type CheckPathError<TRouteTree extends AnyRoute, TInvalids> = {
     to: RoutePaths<TRouteTree>;
 };
-export type CheckId<TRouteTree extends AnyRoute, TPath, TPass> = Exclude<TPath, RouteIds<TRouteTree>> extends never ? TPass : CheckIdError<TRouteTree, Exclude<TPath, RouteIds<TRouteTree>>>;
-export type CheckIdError<TRouteTree extends AnyRoute, TInvalids> = {
-    Error: `${TInvalids extends string ? TInvalids : never} is not a valid route ID.`;
-    'Valid Route IDs': RouteIds<TRouteTree>;
-};
 export type ResolveRelativePath<TFrom, TTo = '.'> = 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] ? ToRest extends ['/'] ? Join<[...FromRest, '/']> : ResolveRelativePath<Join<FromRest>, Join<ToRest>> : never : Split<TTo> extends ['.', ...infer ToRest] ? ToRest extends ['/'] ? Join<[TFrom, '/']> : ResolveRelativePath<TFrom, Join<ToRest>> : CleanPath<Join<['/', ...Split<TFrom>, ...Split<TTo>]>> : never : never;
 export declare function useLinkProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string = '', TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = ''>(options: UseLinkPropsOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
 export interface LinkComponent<TProps extends Record<string, any> = {}> {

package/build/types/utils.d.ts

@@ -1,17 +1,10 @@
 import * as React from 'react';
 import { AnyRoute } from './route';
-import { ParseRoute, RouteIds, RoutesById, RouteById } from './routeInfo';
+import { RouteIds, RouteById } from './routeInfo';
 import { RegisteredRouter } from './router';
 export type NoInfer<T> = [T][T extends any ? 0 : never];
 export type IsAny<T, Y, N = T> = 1 extends 0 & T ? Y : N;
-export type IsAnyBoolean<T> = 1 extends 0 & T ? true : false;
-export type IsKnown<T, Y, N> = unknown extends T ? N : Y;
 export type PickAsRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-export type PickAsPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-export type PickUnsafe<T, K> = K extends keyof T ? Pick<T, K> : never;
-export type PickExtra<T, K> = {
-    [TKey in keyof K as string extends TKey ? never : TKey extends keyof T ? never : TKey]: K[TKey];
-};
 export type PickRequired<T> = {
     [K in keyof T as undefined extends T[K] ? never : K]: T[K];
 };
@@ -22,21 +15,9 @@ export type Expand<T> = T extends object ? T extends infer O ? {
 export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => any ? I : never;
 export type Assign<Left, Right> = Omit<Left, keyof Right> & Right;
 export type AssignAll<T extends any[]> = T extends [infer Left, ...infer Right] ? Right extends any[] ? Assign<Left, AssignAll<Right>> : Left : {};
-export type Values<O> = O[ValueKeys<O>];
-export type ValueKeys<O> = Extract<keyof O, PropertyKey>;
-export type DeepAwaited<T> = T extends Promise<infer A> ? DeepAwaited<A> : T extends Record<infer A, Promise<infer B>> ? {
-    [K in A]: DeepAwaited<B>;
-} : T;
-export 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;
 export type Timeout = ReturnType<typeof setTimeout>;
 export type Updater<TPrevious, TResult = TPrevious> = TResult | ((prev?: TPrevious) => TResult);
 export type NonNullableUpdater<TPrevious, TResult = TPrevious> = TResult | ((prev: TPrevious) => TResult);
-export type PickExtract<T, U> = {
-    [K in keyof T as T[K] extends U ? K : never]: T[K];
-};
-export type PickExclude<T, U> = {
-    [K in keyof T as T[K] extends U ? never : K]: T[K];
-};
 type LastInUnion<U> = UnionToIntersection<U extends unknown ? (x: U) => 0 : never> extends (x: infer L) => 0 ? L : never;
 export type UnionToTuple<U, Last = LastInUnion<U>> = [U] extends [never] ? [] : [...UnionToTuple<Exclude<U, Last>>, Last];
 export declare const isServer: boolean;
@@ -61,7 +42,6 @@ export type StrictOrFrom<TFrom> = {
     from?: never;
     strict: false;
 };
-export type RouteFromIdOrRoute<T, TRouteTree extends AnyRoute = RegisteredRouter['routeTree']> = T extends ParseRoute<TRouteTree> ? T : T extends RouteIds<TRouteTree> ? RoutesById<TRouteTree>[T] : T extends string ? RouteIds<TRouteTree> : never;
 export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
     select?: (search: TRouteContext) => TSelected;
 }): TStrict extends true ? TSelected : TSelected | undefined;

package/build/umd/index.development.js

@@ -1485,6 +1485,104 @@
 
   // The parse type here allows a zod schema to be passed directly to the validator
 
+  // TODO: This is part of a future APi to move away from classes and
+  // towards a more functional API. It's not ready yet.
+
+  // type RouteApiInstance<
+  //   TId extends RouteIds<RegisteredRouter['routeTree']>,
+  //   TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>,
+  //   TFullSearchSchema extends Record<
+  //     string,
+  //     any
+  //   > = TRoute['types']['fullSearchSchema'],
+  //   TAllParams extends AnyPathParams = TRoute['types']['allParams'],
+  //   TAllContext extends Record<string, any> = TRoute['types']['allContext'],
+  //   TLoaderDeps extends Record<string, any> = TRoute['types']['loaderDeps'],
+  //   TLoaderData extends any = TRoute['types']['loaderData'],
+  // > = {
+  //   id: TId
+  //   useMatch: <TSelected = TAllContext>(opts?: {
+  //     select?: (s: TAllContext) => TSelected
+  //   }) => TSelected
+
+  //   useRouteContext: <TSelected = TAllContext>(opts?: {
+  //     select?: (s: TAllContext) => TSelected
+  //   }) => TSelected
+
+  //   useSearch: <TSelected = TFullSearchSchema>(opts?: {
+  //     select?: (s: TFullSearchSchema) => TSelected
+  //   }) => TSelected
+
+  //   useParams: <TSelected = TAllParams>(opts?: {
+  //     select?: (s: TAllParams) => TSelected
+  //   }) => TSelected
+
+  //   useLoaderDeps: <TSelected = TLoaderDeps>(opts?: {
+  //     select?: (s: TLoaderDeps) => TSelected
+  //   }) => TSelected
+
+  //   useLoaderData: <TSelected = TLoaderData>(opts?: {
+  //     select?: (s: TLoaderData) => TSelected
+  //   }) => TSelected
+  // }
+
+  // export function RouteApi_v2<
+  //   TId extends RouteIds<RegisteredRouter['routeTree']>,
+  //   TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>,
+  //   TFullSearchSchema extends Record<
+  //     string,
+  //     any
+  //   > = TRoute['types']['fullSearchSchema'],
+  //   TAllParams extends AnyPathParams = TRoute['types']['allParams'],
+  //   TAllContext extends Record<string, any> = TRoute['types']['allContext'],
+  //   TLoaderDeps extends Record<string, any> = TRoute['types']['loaderDeps'],
+  //   TLoaderData extends any = TRoute['types']['loaderData'],
+  // >({
+  //   id,
+  // }: {
+  //   id: TId
+  // }): RouteApiInstance<
+  //   TId,
+  //   TRoute,
+  //   TFullSearchSchema,
+  //   TAllParams,
+  //   TAllContext,
+  //   TLoaderDeps,
+  //   TLoaderData
+  // > {
+  //   return {
+  //     id,
+
+  //     useMatch: (opts) => {
+  //       return useMatch({ ...opts, from: id })
+  //     },
+
+  //     useRouteContext: (opts) => {
+  //       return useMatch({
+  //         ...opts,
+  //         from: id,
+  //         select: (d: any) => (opts?.select ? opts.select(d.context) : d.context),
+  //       } as any)
+  //     },
+
+  //     useSearch: (opts) => {
+  //       return useSearch({ ...opts, from: id } as any)
+  //     },
+
+  //     useParams: (opts) => {
+  //       return useParams({ ...opts, from: id } as any)
+  //     },
+
+  //     useLoaderDeps: (opts) => {
+  //       return useLoaderDeps({ ...opts, from: id } as any) as any
+  //     },
+
+  //     useLoaderData: (opts) => {
+  //       return useLoaderData({ ...opts, from: id } as any) as any
+  //     },
+  //   }
+  // }
+
   class RouteApi {
     constructor({
       id