@tanstack/react-router 0.0.1-beta.5 → 0.0.1-beta.50

package/build/types/index.d.ts

@@ -9,66 +9,110 @@
  * @license MIT
  */
 import * as React from 'react';
-import { AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, ToOptions, MatchRouteOptions, RouteInfoByPath, ResolveRelativePath, NoInfer, DefaultAllRouteInfo, AnyRouteInfo, RouteInfo, CheckId, ToIdOption, ValidFromPath, LinkOptions, RouterOptions, Router } from '@tanstack/router-core';
+import { Store, RegisteredAllRouteInfo, LinkOptions, ToOptions, MatchRouteOptions, RouteInfoByPath, ResolveRelativePath, NoInfer, ValidFromPath, RegisteredRouter, AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, Router, RouterOptions, DefaultAllRouteInfo, RouterStore, RouteMatch, Route, Expand, Action, ActionStore, ActionSubmission } from '@tanstack/router-core';
 export * from '@tanstack/router-core';
 
+declare function useStore<TState, TSelected = TState>(store: Store<TState>, selector?: (state: TState) => TSelected, compareShallow?: boolean): TSelected;
+
+type ReactNode = any;
+type SyncRouteComponent<TProps = {}> = (props: TProps) => ReactNode;
+type RouteComponent<TProps = {}> = SyncRouteComponent<TProps> & {
+    preload?: () => Promise<void>;
+};
+declare function lazy(importer: () => Promise<{
+    default: SyncRouteComponent;
+}>): RouteComponent;
+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 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<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;
+    }) => ReactNode);
+};
 declare module '@tanstack/router-core' {
     interface FrameworkGenerics {
-        Element: React.ReactNode;
-        SyncOrAsyncElement: React.ReactNode | (() => Promise<any>);
+        Component: RouteComponent;
+        ErrorComponent: RouteComponent<{
+            error: unknown;
+            info: {
+                componentStack: string;
+            };
+        }>;
     }
-    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']>(routeId: TId) => RouteMatch<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
-        linkProps: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, '/', TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
-        Link: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, '/', TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
-            children?: React.ReactNode | ((state: {
-                isActive: boolean;
-            }) => React.ReactNode);
-        }) => JSX.Element;
-        MatchRoute: <TTo extends string = '.'>(props: ToOptions<TAllRouteInfo, '/', TTo> & MatchRouteOptions & {
-            children?: React.ReactNode | ((params: RouteInfoByPath<TAllRouteInfo, ResolveRelativePath<'/', NoInfer<TTo>>>['allParams']) => React.ReactNode);
-        }) => 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>>) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TResolved]>;
-        linkProps: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
-        Link: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
-            children?: React.ReactNode | ((state: {
-                isActive: boolean;
-            }) => React.ReactNode);
-        }) => JSX.Element;
-        MatchRoute: <TTo extends string = '.'>(props: ToOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & MatchRouteOptions & {
-            children?: React.ReactNode | ((params: RouteInfoByPath<TAllRouteInfo, ResolveRelativePath<TRouteInfo['fullPath'], NoInfer<TTo>>>['allParams']) => React.ReactNode);
-        }) => JSX.Element;
+    interface RouterOptions<TRouteConfig, TRouterContext> {
     }
 }
-declare type LinkPropsOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = LinkOptions<TAllRouteInfo, TFrom, TTo> & {
-    activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
-    inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
-};
-declare type PromptProps = {
+type PromptProps = {
     message: string;
     when?: boolean | any;
-    children?: React.ReactNode;
+    children?: ReactNode;
 };
-declare type MatchesProviderProps = {
-    value: RouteMatch[];
-    children: React.ReactNode;
+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> & React.RefAttributes<HTMLAnchorElement>): ReactNode;
+}
+declare const Link: LinkFn;
+type MatchesContextValue = RouteMatch[];
+declare const matchesContext: React.Context<MatchesContextValue>;
+declare const routerContext: React.Context<{
+    router: RegisteredRouter;
+}>;
+type MatchesProviderProps = {
+    value: MatchesContextValue;
+    children: ReactNode;
 };
-declare function MatchesProvider(props: MatchesProviderProps): JSX.Element;
-declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig>(opts: RouterOptions<TRouteConfig>): Router<TRouteConfig>;
-declare type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = RouterOptions<TRouteConfig> & {
-    router: Router<TRouteConfig, TAllRouteInfo>;
-    children?: React.ReactNode;
+declare class ReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown> extends Router<TRouteConfig, TAllRouteInfo, TRouterContext> {
+    constructor(opts: RouterOptions<TRouteConfig, 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>({ children, router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo>): JSX.Element;
+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, shallow?: boolean): T;
+declare function useMatches(): RouteMatch[];
+declare function useMatch<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true, TRouteMatch = RouteMatch<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TFrom]>>(opts?: {
+    from: TFrom;
+    strict?: TStrict;
+    track?: (match: TRouteMatch) => any;
+    shallow?: boolean;
+}): 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']>(opts?: {
+    from: TFrom;
+    strict?: TStrict;
+    track?: (loaderData: TLoaderData) => any;
+}): TStrict extends true ? TLoaderData : TLoaderData | 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;
+    track?: (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;
+    track?: (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 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 useAction<TKey extends string = string, TPayload = unknown, TResponse = unknown, TError = Error>(action: Action<TKey, TPayload, TResponse, TError>, opts?: {
+    track?: (actionStore: ActionStore<TPayload, TResponse, TError>) => any;
+}): Action & {
+    latestSubmission: ActionSubmission<TPayload, TResponse, TError>;
+    pendingSubmissions: ActionSubmission<TPayload, TResponse, TError>[];
+};
 
-export { DefaultErrorBoundary, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouterProps, RouterProvider, createReactRouter, usePrompt };
+export { DefaultErrorBoundary, Link, LinkFn, LinkPropsOptions, MakeLinkOptions, MakeLinkPropsOptions, MakeMatchRouteOptions, MakeUseMatchRouteOptions, MatchRoute, MatchesProviderProps, Outlet, PromptProps, ReactRouter, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, lazy, matchesContext, routerContext, useAction, useLinkProps, useLoaderData, useMatch, useMatchRoute, useMatches, useNavigate, useParams, useRoute, useRouter, useRouterStore, useSearch, useStore };