@tanstack/react-router 1.5.4 → 1.5.6

package/build/types/RouterProvider.d.ts

@@ -1,11 +1,9 @@
 import * as React from 'react';
-import { NavigateOptions, ResolveRelativePath, ToOptions } from './link';
+import { NavigateOptions, ToOptions } from './link';
 import { ParsedLocation } from './location';
 import { AnyRoute } from './route';
-import { RouteById, RoutePaths } from './routeInfo';
+import { RoutePaths } from './routeInfo';
 import { RegisteredRouter, Router, RouterOptions, RouterState } from './router';
-import { NoInfer } from './utils';
-import { MatchRouteOptions } from './Matches';
 import { RouteMatch } from './Matches';
 export interface CommitLocationOptions {
     replace?: boolean;
@@ -19,20 +17,11 @@ export interface MatchLocation {
     from?: string;
 }
 export type NavigateFn<TRouteTree extends AnyRoute> = <TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string = '', TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = ''>(opts: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<void>;
-export type MatchRouteFn<TRouteTree extends AnyRoute> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<TRouteTree, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>['types']['allParams'];
 export type BuildLocationFn<TRouteTree extends AnyRoute> = (opts: ToOptions<TRouteTree>) => ParsedLocation;
 export type InjectedHtmlEntry = string | (() => Promise<string> | string);
-export declare let routerContext: React.Context<Router<any, Record<string, any>>>;
 export declare function RouterProvider<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>>({ router, ...rest }: RouterProps<TRouteTree, TDehydrated>): React.JSX.Element;
 export declare function getRouteMatch<TRouteTree extends AnyRoute>(state: RouterState<TRouteTree>, id: string): undefined | RouteMatch<TRouteTree>;
-export declare function useRouterState<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TSelected = RouterState<TRouteTree>>(opts?: {
-    router?: Router<TRouteTree>;
-    select: (state: RouterState<RegisteredRouter['routeTree']>) => TSelected;
-}): TSelected;
 export type RouterProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated>, 'context'> & {
     router: Router<TRouteTree>;
     context?: Partial<RouterOptions<TRouteTree, TDehydrated>['context']>;
 };
-export declare function useRouter<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(opts?: {
-    warn?: boolean;
-}): Router<TRouteTree>;

package/build/types/index.d.ts

@@ -6,7 +6,6 @@ export * from './defer';
 export * from './CatchBoundary';
 export * from './fileRoute';
 export * from './history';
-export * from './index';
 export * from './lazyRouteComponent';
 export * from './link';
 export * from './location';
@@ -24,4 +23,8 @@ export * from './useBlocker';
 export * from './useNavigate';
 export * from './useParams';
 export * from './useSearch';
+export * from './routerContext';
+export * from './useRouteContext';
+export * from './useRouter';
+export * from './useRouterState';
 export * from './utils';

package/build/types/router.d.ts

@@ -2,14 +2,15 @@
 import { HistoryState, RouterHistory } from '@tanstack/history';
 import { Store } from '@tanstack/store';
 import { AnySearchSchema, AnyRoute, AnyContext, RouteMask } from './route';
-import { FullSearchSchema, RoutesById, RoutesByPath } from './routeInfo';
+import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo';
 import { PickAsRequired, Updater, NonNullableUpdater, Timeout } from './utils';
 import { RouteComponent } from './route';
-import { AnyRouteMatch, RouteMatch } from './Matches';
+import { AnyRouteMatch, MatchRouteOptions, RouteMatch } from './Matches';
 import { ParsedLocation } from './location';
 import { SearchSerializer, SearchParser } from './searchParams';
-import { BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, MatchRouteFn, NavigateFn } from './RouterProvider';
-import { ToOptions } from './link';
+import { BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, NavigateFn } from './RouterProvider';
+import { ResolveRelativePath, ToOptions } from './link';
+import { NoInfer } from '@tanstack/react-store';
 declare global {
     interface Window {
         __TSR_DEHYDRATED__?: HydrationCtx;
@@ -171,7 +172,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     load: () => Promise<void>;
     cleanCache: () => void;
     preloadRoute: (navigateOpts?: ToOptions<TRouteTree>) => Promise<RouteMatch<AnyRoute, any>[]>;
-    matchRoute: MatchRouteFn<TRouteTree>;
+    matchRoute: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "", TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<TRouteTree, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
     injectHtml: (html: string | (() => Promise<string> | string)) => Promise<void>;
     dehydrateData: <T>(key: any, getData: T | (() => T | Promise<T>)) => () => T | undefined;
     hydrateData: <T extends unknown = unknown>(key: any) => T | undefined;

package/build/types/routerContext.d.ts

@@ -0,0 +1,3 @@
+import * as React from 'react';
+import { Router } from './router';
+export declare let routerContext: React.Context<Router<any, Record<string, any>>>;

package/build/types/useRouteContext.d.ts

@@ -0,0 +1,7 @@
+import { AnyRoute } from './route';
+import { RouteIds, RouteById } from './routeInfo';
+import { RegisteredRouter } from './router';
+import { StrictOrFrom } from './utils';
+export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TRouteContext) => TSelected;
+}): TSelected;

package/build/types/useRouter.d.ts

@@ -0,0 +1,5 @@
+import { AnyRoute } from './route';
+import { RegisteredRouter, Router } from './router';
+export declare function useRouter<TRouteTree extends AnyRoute = RegisteredRouter['routeTree']>(opts?: {
+    warn?: boolean;
+}): Router<TRouteTree>;

package/build/types/useRouterState.d.ts

@@ -0,0 +1,6 @@
+import { AnyRoute } from './route';
+import { RegisteredRouter, Router, RouterState } from './router';
+export declare function useRouterState<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TSelected = RouterState<TRouteTree>>(opts?: {
+    router?: Router<TRouteTree>;
+    select: (state: RouterState<RegisteredRouter['routeTree']>) => TSelected;
+}): TSelected;

package/build/types/utils.d.ts

@@ -1,7 +1,4 @@
 import * as React from 'react';
-import { AnyRoute } from './route';
-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 PickAsRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
@@ -44,9 +41,6 @@ export type StrictOrFrom<TFrom> = {
     from?: never;
     strict: false;
 };
-export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TRouteContext) => TSelected;
-}): TSelected;
 export declare const useLayoutEffect: typeof React.useLayoutEffect;
 export declare function escapeJSON(jsonString: string): string;
 export {};