@octanejs/tanstack-router 0.2.6 → 0.2.8

package/src/route.ts

@@ -12,6 +12,7 @@ import type {
 	AnyContext,
 	AnyRoute,
 	AnyRouter,
+	Constrain,
 	ConstrainLiteral,
 	ErrorComponentProps,
 	NotFoundError,
@@ -233,6 +234,96 @@ export class Route<
 	declare useLoaderData: UseLoaderDataRoute<TId>;
 	declare useNavigate: () => UseNavigateResult<TFullPath>;
 	declare Link: LinkComponentRoute<TFullPath>;
+	// These core combinators return this same binding instance. Only their
+	// children/file metadata changes; the ordinary bound methods stay available.
+	declare addChildren: <const TNewChildren>(
+		children: Constrain<TNewChildren, ReadonlyArray<AnyRoute> | Record<string, AnyRoute>>,
+	) => Route<
+		TRegister,
+		TParentRoute,
+		TPath,
+		TFullPath,
+		TCustomId,
+		TId,
+		TSearchValidator,
+		TParams,
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TNewChildren,
+		TFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare _addFileChildren: <const TNewChildren>(
+		children: TNewChildren,
+	) => Route<
+		TRegister,
+		TParentRoute,
+		TPath,
+		TFullPath,
+		TCustomId,
+		TId,
+		TSearchValidator,
+		TParams,
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TNewChildren,
+		TFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare _addFileTypes: <TNewFileRouteTypes>() => Route<
+		TRegister,
+		TParentRoute,
+		TPath,
+		TFullPath,
+		TCustomId,
+		TId,
+		TSearchValidator,
+		TParams,
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TChildren,
+		TNewFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare lazy: (
+		...args: Parameters<
+			RouteCore<
+				TRegister,
+				TParentRoute,
+				TPath,
+				TFullPath,
+				TCustomId,
+				TId,
+				TSearchValidator,
+				TParams,
+				TRouterContext,
+				TRouteContextFn,
+				TBeforeLoadFn,
+				TLoaderDeps,
+				TLoaderFn,
+				TChildren,
+				TFileRouteTypes,
+				TSSR,
+				TServerMiddlewares,
+				THandlers
+			>['lazy']
+		>
+	) => this;
 
 	/** @deprecated Use the `createRoute` function instead. */
 	constructor(
@@ -313,6 +404,96 @@ export class RootRoute<
 	declare useLoaderData: UseLoaderDataRoute<RootRouteId>;
 	declare useNavigate: () => UseNavigateResult<'/'>;
 	declare Link: LinkComponentRoute<'/'>;
+	// These core combinators return this same binding instance. Only their
+	// children/file metadata changes; the ordinary bound methods stay available.
+	declare addChildren: <const TNewChildren>(
+		children: Constrain<TNewChildren, ReadonlyArray<AnyRoute> | Record<string, AnyRoute>>,
+	) => Route<
+		TRegister,
+		any,
+		'/',
+		'/',
+		string,
+		RootRouteId,
+		TSearchValidator,
+		{},
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TNewChildren,
+		TFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare _addFileChildren: <const TNewChildren>(
+		children: TNewChildren,
+	) => Route<
+		TRegister,
+		any,
+		'/',
+		'/',
+		string,
+		RootRouteId,
+		TSearchValidator,
+		{},
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TNewChildren,
+		TFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare _addFileTypes: <TNewFileRouteTypes>() => Route<
+		TRegister,
+		any,
+		'/',
+		'/',
+		string,
+		RootRouteId,
+		TSearchValidator,
+		{},
+		TRouterContext,
+		TRouteContextFn,
+		TBeforeLoadFn,
+		TLoaderDeps,
+		TLoaderFn,
+		TChildren,
+		TNewFileRouteTypes,
+		TSSR,
+		TServerMiddlewares,
+		THandlers
+	>;
+	declare lazy: (
+		...args: Parameters<
+			RouteCore<
+				TRegister,
+				any,
+				'/',
+				'/',
+				string,
+				RootRouteId,
+				TSearchValidator,
+				{},
+				TRouterContext,
+				TRouteContextFn,
+				TBeforeLoadFn,
+				TLoaderDeps,
+				TLoaderFn,
+				TChildren,
+				TFileRouteTypes,
+				TSSR,
+				TServerMiddlewares,
+				THandlers
+			>['lazy']
+		>
+	) => this;
 
 	/** @deprecated Use `createRootRoute()` instead. */
 	constructor(

package/src/routerStateBinding.ts

@@ -0,0 +1,41 @@
+// The reactive base every router hook reads through: subscribe to the router's
+// canonical snapshot store (`router.stores.__store`) and select a slice.
+import { useStore } from './useStore';
+import type { useRouter as StandardUseRouter } from './context';
+import { splitSlot, subSlot } from './internal';
+import type { AnyRouter, RegisteredRouter, RouterState } from '@tanstack/router-core';
+import type { StructuralSharingOption, ValidateSelected } from './structuralSharing';
+
+export type UseRouterStateOptions<TRouter extends AnyRouter, TSelected, TStructuralSharing> = {
+	router?: TRouter;
+	select?: (
+		state: RouterState<TRouter['routeTree']>,
+	) => ValidateSelected<TRouter, TSelected, TStructuralSharing>;
+} & StructuralSharingOption<TRouter, TSelected, TStructuralSharing>;
+
+export type UseRouterStateResult<TRouter extends AnyRouter, TSelected> = unknown extends TSelected
+	? RouterState<TRouter['routeTree']>
+	: TSelected;
+
+export function createUseRouterState(useRouter: typeof StandardUseRouter) {
+	function useRouterState<
+		TRouter extends AnyRouter = RegisteredRouter,
+		TSelected = unknown,
+		TStructuralSharing extends boolean = boolean,
+	>(
+		opts?: UseRouterStateOptions<TRouter, TSelected, TStructuralSharing>,
+	): UseRouterStateResult<TRouter, TSelected>;
+	function useRouterState(...args: any[]): any {
+		const [user, slot] = splitSlot(args);
+		const opts = (user[0] ?? {}) as { select?: (s: any) => any; router?: any };
+		const router = useRouter(opts.router ? { router: opts.router } : undefined);
+		return useStore(
+			router.stores.__store,
+			opts.select ?? ((s: any) => s),
+			undefined,
+			subSlot(slot, 'rs'),
+		);
+	}
+
+	return useRouterState;
+}

package/src/useRouterState.ts

@@ -1,37 +1,5 @@
-// The reactive base every router hook reads through: subscribe to the router's
-// canonical snapshot store (`router.stores.__store`) and select a slice.
-import { useStore } from './useStore';
 import { useRouter } from './context';
-import { splitSlot, subSlot } from './internal';
-import type { AnyRouter, RegisteredRouter, RouterState } from '@tanstack/router-core';
-import type { StructuralSharingOption, ValidateSelected } from './structuralSharing';
+import { createUseRouterState } from './routerStateBinding';
 
-export type UseRouterStateOptions<TRouter extends AnyRouter, TSelected, TStructuralSharing> = {
-	router?: TRouter;
-	select?: (
-		state: RouterState<TRouter['routeTree']>,
-	) => ValidateSelected<TRouter, TSelected, TStructuralSharing>;
-} & StructuralSharingOption<TRouter, TSelected, TStructuralSharing>;
-
-export type UseRouterStateResult<TRouter extends AnyRouter, TSelected> = unknown extends TSelected
-	? RouterState<TRouter['routeTree']>
-	: TSelected;
-
-export function useRouterState<
-	TRouter extends AnyRouter = RegisteredRouter,
-	TSelected = unknown,
-	TStructuralSharing extends boolean = boolean,
->(
-	opts?: UseRouterStateOptions<TRouter, TSelected, TStructuralSharing>,
-): UseRouterStateResult<TRouter, TSelected>;
-export function useRouterState(...args: any[]): any {
-	const [user, slot] = splitSlot(args);
-	const opts = (user[0] ?? {}) as { select?: (s: any) => any; router?: any };
-	const router = useRouter(opts.router ? { router: opts.router } : undefined);
-	return useStore(
-		router.stores.__store,
-		opts.select ?? ((s: any) => s),
-		undefined,
-		subSlot(slot, 'rs'),
-	);
-}
+export type { UseRouterStateOptions, UseRouterStateResult } from './routerStateBinding';
+export const useRouterState = createUseRouterState(useRouter);