@tanstack/react-router 0.0.1-beta.38 → 0.0.1-beta.39

package/build/types/index.d.ts

@@ -9,28 +9,31 @@
  * @license MIT
  */
 import * as React from 'react';
-import { AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, DefaultAllRouteInfo, AnyRouteInfo, RouteInfo, ResolveRelativePath, NoInfer, CheckId, ToIdOption, ValidFromPath, LinkOptions, ToOptions, MatchRouteOptions, RouteInfoByPath, RegisteredAllRouteInfo, RegisteredRouter, RouterOptions, Router, Route } from '@tanstack/router-core';
+import { RegisteredAllRouteInfo, LinkOptions, ToOptions, MatchRouteOptions, RouteInfoByPath, ResolveRelativePath, NoInfer, ValidFromPath, RegisteredRouter, AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterOptions, Router, DefaultAllRouteInfo, RouterStore, RouteMatch, Route, Expand, Action } from '@tanstack/router-core';
 export * from '@tanstack/router-core';
+export * from '@solidjs/reactivity';
 
-type SyncRouteComponent<TProps = {}> = (props: TProps) => JSX.Element | React.ReactNode;
+type ReactNode = any;
+type SyncRouteComponent<TProps = {}> = (props: TProps) => ReactNode;
 type RouteComponent<TProps = {}> = SyncRouteComponent<TProps> & {
-    preload?: () => Promise<SyncRouteComponent<TProps>>;
+    preload?: () => Promise<void>;
 };
 declare function lazy(importer: () => Promise<{
     default: SyncRouteComponent;
 }>): RouteComponent;
-type LinkPropsOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo>, TTo extends string> = LinkOptions<TAllRouteInfo, TFrom, TTo> & {
+type LinkPropsOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = LinkOptions<RegisteredAllRouteInfo, TFrom, TTo> & {
     activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
     inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
 };
-type MakeMatchRouteOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo>, TTo extends string> = ToOptions<TAllRouteInfo, TFrom, TTo> & MatchRouteOptions & {
-    children?: React.ReactNode | ((params: RouteInfoByPath<TAllRouteInfo, ResolveRelativePath<TFrom, NoInfer<TTo>>>['allParams']) => React.ReactNode);
+type MakeUseMatchRouteOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = ToOptions<RegisteredAllRouteInfo, TFrom, TTo> & MatchRouteOptions;
+type MakeMatchRouteOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = ToOptions<RegisteredAllRouteInfo, TFrom, TTo> & MatchRouteOptions & {
+    children?: ReactNode | ((params: RouteInfoByPath<RegisteredAllRouteInfo, ResolveRelativePath<TFrom, NoInfer<TTo>>>['allParams']) => ReactNode);
 };
-type MakeLinkPropsOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo>, TTo extends string> = LinkPropsOptions<TAllRouteInfo, TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>;
-type MakeLinkOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo>, TTo extends string> = LinkPropsOptions<TAllRouteInfo, TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
-    children?: React.ReactNode | ((state: {
+type MakeLinkPropsOptions<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>;
+type MakeLinkOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
+    children?: ReactNode | ((state: {
         isActive: boolean;
-    }) => React.ReactNode);
+    }) => ReactNode);
 };
 declare module '@tanstack/router-core' {
     interface FrameworkGenerics {
@@ -44,31 +47,17 @@ declare module '@tanstack/router-core' {
     }
     interface RouterOptions<TRouteConfig, TRouterContext> {
     }
-    interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
-        useState: () => RouterState;
-        useRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(routeId: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
-        useMatch: <TId extends keyof TAllRouteInfo['routeInfoById'], TStrict extends boolean = true>(routeId: TId, opts?: {
-            strict?: TStrict;
-        }) => TStrict extends true ? RouteMatch<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]> : RouteMatch<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]> | undefined;
-        linkProps: <TTo extends string = '.'>(props: MakeLinkPropsOptions<TAllRouteInfo, '/', TTo>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
-        Link: <TTo extends string = '.'>(props: MakeLinkOptions<TAllRouteInfo, '/', TTo>) => JSX.Element;
-        MatchRoute: <TTo extends string = '.'>(props: MakeMatchRouteOptions<TAllRouteInfo, '/', TTo>) => JSX.Element;
-    }
-    interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
-        useRoute: <TTo extends string = '.', TResolved extends string = ResolveRelativePath<TRouteInfo['id'], NoInfer<TTo>>>(routeId: CheckId<TAllRouteInfo, TResolved, ToIdOption<TAllRouteInfo, TRouteInfo['id'], TTo>>, opts?: {
-            strict?: boolean;
-        }) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TResolved]>;
-        linkProps: <TTo extends string = '.'>(props: MakeLinkPropsOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
-        Link: <TTo extends string = '.'>(props: MakeLinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>) => JSX.Element;
-        MatchRoute: <TTo extends string = '.'>(props: MakeMatchRouteOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>) => JSX.Element;
-    }
 }
 type PromptProps = {
     message: string;
     when?: boolean | any;
-    children?: React.ReactNode;
+    children?: ReactNode;
 };
-declare function Link<TTo extends string = '.'>(props: MakeLinkOptions<RegisteredAllRouteInfo, '/', TTo>): JSX.Element;
+declare function useLinkProps<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'>(options: MakeLinkPropsOptions<TFrom, TTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
+interface LinkFn<TDefaultFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TDefaultTo extends string = '.'> {
+    <TFrom extends RegisteredAllRouteInfo['routePaths'] = TDefaultFrom, TTo extends string = TDefaultTo>(props: MakeLinkOptions<TFrom, TTo>): ReactNode;
+}
+declare const Link: LinkFn;
 type MatchesContextValue = RouteMatch[];
 declare const matchesContext: React.Context<MatchesContextValue>;
 declare const routerContext: React.Context<{
@@ -76,30 +65,49 @@ declare const routerContext: React.Context<{
 }>;
 type MatchesProviderProps = {
     value: MatchesContextValue;
-    children: React.ReactNode;
+    children: ReactNode;
 };
-declare function MatchesProvider(props: MatchesProviderProps): JSX.Element;
+declare const __useStoreValue: <TSeed, TReturn>(seed: () => TSeed, selector?: ((seed: TSeed) => TReturn) | undefined) => TReturn;
 declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(opts: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
 type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown> = RouterOptions<TRouteConfig, TRouterContext> & {
     router: Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
 };
 declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown>({ router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo, TRouterContext>): JSX.Element;
 declare function useRouter(): RegisteredRouter;
+declare function useRouterStore<T = RouterStore>(selector?: (state: Router['store']) => T): T;
 declare function useMatches(): RouteMatch[];
-declare function useMatch<TId extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true>(routeId: TId, opts?: {
+declare function useMatch<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true, TRouteMatch = RouteMatch<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TFrom]>>(opts?: {
+    from: TFrom;
+    strict?: TStrict;
+}): TStrict extends true ? TRouteMatch : TRouteMatch | undefined;
+declare function useRoute<TId extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/'>(routeId: TId): Route<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]>;
+declare function useLoaderData<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TStrict extends boolean = true, TLoaderData = RegisteredAllRouteInfo['routeInfoById'][TFrom]['loaderData'], TSelected = TLoaderData>(opts?: {
+    from: TFrom;
+    strict?: TStrict;
+    select?: (loaderData: TLoaderData) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+declare function useSearch<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true, TSearch = RegisteredAllRouteInfo['routeInfoById'][TFrom]['fullSearchSchema'], TSelected = TSearch>(opts?: {
+    from: TFrom;
     strict?: TStrict;
-}): TStrict extends true ? RouteMatch<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]> : RouteMatch<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]> | undefined;
-declare function useNearestMatch(): RouteMatch<RegisteredAllRouteInfo, RouteInfo>;
-declare function useRoute<TId extends keyof RegisteredAllRouteInfo['routeInfoById']>(routeId: TId): Route<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]>;
-declare function useSearch(): RegisteredAllRouteInfo['fullSearchSchema'];
-declare function useParams(): RegisteredAllRouteInfo['allParams'];
-declare function linkProps<TTo extends string = '.'>(props: MakeLinkPropsOptions<RegisteredAllRouteInfo, '/', TTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
-declare function MatchRoute<TTo extends string = '.'>(props: MakeMatchRouteOptions<RegisteredAllRouteInfo, '/', TTo>): JSX.Element;
+    select?: (search: TSearch) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+declare function useParams<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TDefaultSelected = Expand<RegisteredAllRouteInfo['allParams'] & RegisteredAllRouteInfo['routeInfoById'][TFrom]['allParams']>, TSelected = TDefaultSelected>(opts?: {
+    from: TFrom;
+    select?: (search: TDefaultSelected) => TSelected;
+}): TSelected;
+declare function useNavigate<TDefaultFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/'>(defaultOpts: {
+    from?: TDefaultFrom;
+}): <TFrom extends string = TDefaultFrom, TTo extends string = ".">(opts: MakeLinkOptions<TFrom, TTo>) => Promise<void>;
+declare function useAction<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TFromRoute extends RegisteredAllRouteInfo['routeInfoById'][TFrom] = RegisteredAllRouteInfo['routeInfoById'][TFrom]>(opts: {
+    from: TFrom;
+}): Action<TFromRoute['actionPayload'], TFromRoute['actionResponse']>;
+declare function useMatchRoute(): <TFrom extends ValidFromPath<AnyAllRouteInfo> = "/", TTo extends string = ".">(opts: MakeUseMatchRouteOptions<TFrom, TTo>) => false;
+declare function MatchRoute<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'>(props: MakeMatchRouteOptions<TFrom, TTo>): any;
 declare function Outlet(): JSX.Element | null;
 declare function DefaultErrorBoundary({ error }: {
     error: any;
 }): JSX.Element;
 declare function usePrompt(message: string, when: boolean | any): void;
-declare function Prompt({ message, when, children }: PromptProps): React.ReactNode;
+declare function Prompt({ message, when, children }: PromptProps): any;
 
-export { DefaultErrorBoundary, Link, LinkPropsOptions, MakeLinkOptions, MakeLinkPropsOptions, MakeMatchRouteOptions, MatchRoute, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, createReactRouter, lazy, linkProps, matchesContext, routerContext, useMatch, useMatches, useNearestMatch, useParams, usePrompt, useRoute, useRouter, useSearch };
+export { DefaultErrorBoundary, Link, LinkFn, LinkPropsOptions, MakeLinkOptions, MakeLinkPropsOptions, MakeMatchRouteOptions, MakeUseMatchRouteOptions, MatchRoute, MatchesProviderProps, Outlet, Prompt, PromptProps, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, __useStoreValue, createReactRouter, lazy, matchesContext, routerContext, useAction, useLinkProps, useLoaderData, useMatch, useMatchRoute, useMatches, useNavigate, useParams, usePrompt, useRoute, useRouter, useRouterStore, useSearch };