@tanstack/react-router 0.0.1-beta.3 → 0.0.1-beta.31

package/build/types/index.d.ts

@@ -9,61 +9,91 @@
  * @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 { AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, DefaultAllRouteInfo, AnyRouteInfo, RouteInfo, ResolveRelativePath, NoInfer, CheckId, ToIdOption, ValidFromPath, ToOptions, MatchRouteOptions, RouteInfoByPath, RegisteredAllRouteInfo, RegisteredRouter, RouterOptions, Router, Route, LinkOptions } from '@tanstack/router-core';
 export * from '@tanstack/router-core';
 
+type SyncRouteComponent<TProps = {}> = (props: TProps) => JSX.Element | React.ReactNode;
+type RouteComponent<TProps = {}> = SyncRouteComponent<TProps> & {
+    preload?: () => Promise<SyncRouteComponent<TProps>>;
+};
+declare function lazy(importer: () => Promise<{
+    default: SyncRouteComponent;
+}>): RouteComponent;
+type LinkPropsOptions<TAllRouteInfo extends AnyAllRouteInfo, 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>);
+};
+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 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: {
+        isActive: boolean;
+    }) => React.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 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']>(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;
+        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>>) => 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;
+        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;
     }
 }
-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;
 };
-declare type MatchesProviderProps = {
-    value: RouteMatch[];
+declare function Link<TTo extends string = '.'>(props: MakeLinkOptions<RegisteredAllRouteInfo, '/', TTo>): JSX.Element;
+type MatchesContextValue = RouteMatch[];
+declare const matchesContext: React.Context<MatchesContextValue>;
+declare const routerContext: React.Context<{
+    router: RegisteredRouter;
+}>;
+type MatchesProviderProps = {
+    value: MatchesContextValue;
     children: React.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 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>({ 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 useMatches(): RouteMatch[];
+declare function useMatch<TId extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true>(routeId: TId, opts?: {
+    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<TId extends keyof RegisteredAllRouteInfo['routeInfoById'] = keyof RegisteredAllRouteInfo['routeInfoById']>(_routeId?: TId): RegisteredAllRouteInfo['fullSearchSchema'];
+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;
 declare function Outlet(): JSX.Element | null;
 declare function DefaultErrorBoundary({ error }: {
     error: any;
@@ -71,4 +101,4 @@ declare function DefaultErrorBoundary({ error }: {
 declare function usePrompt(message: string, when: boolean | any): void;
 declare function Prompt({ message, when, children }: PromptProps): React.ReactNode;
 
-export { DefaultErrorBoundary, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouterProps, RouterProvider, createReactRouter, usePrompt };
+export { DefaultErrorBoundary, Link, MatchRoute, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, createReactRouter, lazy, linkProps, matchesContext, routerContext, useMatch, useMatches, useNearestMatch, usePrompt, useRoute, useRouter, useSearch };