@tanstack/react-router 0.0.1-beta.2 → 0.0.1-beta.21

package/build/stats-html.html

@@ -4014,7 +4014,7 @@ var drawChart = (function (exports) {
   </script>
   <script>
     /*<!--*/
-    const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.production.js","children":[{"uid":"392f-59","name":"\u0000rollupPluginBabelHelpers.js"},{"name":"packages","children":[{"name":"router-core/build/esm/index.js","uid":"392f-61"},{"name":"react-router/src/index.tsx","uid":"392f-63"}]}]}],"isRoot":true},"nodeParts":{"392f-59":{"renderedLength":798,"gzipLength":366,"brotliLength":0,"mainUid":"392f-58"},"392f-61":{"renderedLength":74811,"gzipLength":15587,"brotliLength":0,"mainUid":"392f-60"},"392f-63":{"renderedLength":12726,"gzipLength":3316,"brotliLength":0,"mainUid":"392f-62"}},"nodeMetas":{"392f-58":{"id":"\u0000rollupPluginBabelHelpers.js","moduleParts":{"index.production.js":"392f-59"},"imported":[],"importedBy":[{"uid":"392f-62"}]},"392f-60":{"id":"/packages/router-core/build/esm/index.js","moduleParts":{"index.production.js":"392f-61"},"imported":[],"importedBy":[{"uid":"392f-62"}]},"392f-62":{"id":"/packages/react-router/src/index.tsx","moduleParts":{"index.production.js":"392f-63"},"imported":[{"uid":"392f-58"},{"uid":"392f-64"},{"uid":"392f-65"},{"uid":"392f-60"}],"importedBy":[],"isEntry":true},"392f-64":{"id":"react","moduleParts":{},"imported":[],"importedBy":[{"uid":"392f-62"}],"isExternal":true},"392f-65":{"id":"use-sync-external-store/shim","moduleParts":{},"imported":[],"importedBy":[{"uid":"392f-62"}],"isExternal":true}},"env":{"rollup":"2.77.2"},"options":{"gzip":true,"brotli":false,"sourcemap":false}};
+    const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.production.js","children":[{"uid":"d45b-59","name":"\u0000rollupPluginBabelHelpers.js"},{"name":"packages","children":[{"name":"router-core/build/esm/index.js","uid":"d45b-61"},{"name":"react-router/src/index.tsx","uid":"d45b-63"}]}]}],"isRoot":true},"nodeParts":{"d45b-59":{"renderedLength":798,"gzipLength":366,"brotliLength":0,"mainUid":"d45b-58"},"d45b-61":{"renderedLength":75162,"gzipLength":15777,"brotliLength":0,"mainUid":"d45b-60"},"d45b-63":{"renderedLength":12795,"gzipLength":3210,"brotliLength":0,"mainUid":"d45b-62"}},"nodeMetas":{"d45b-58":{"id":"\u0000rollupPluginBabelHelpers.js","moduleParts":{"index.production.js":"d45b-59"},"imported":[],"importedBy":[{"uid":"d45b-62"}]},"d45b-60":{"id":"/packages/router-core/build/esm/index.js","moduleParts":{"index.production.js":"d45b-61"},"imported":[],"importedBy":[{"uid":"d45b-62"}]},"d45b-62":{"id":"/packages/react-router/src/index.tsx","moduleParts":{"index.production.js":"d45b-63"},"imported":[{"uid":"d45b-58"},{"uid":"d45b-64"},{"uid":"d45b-65"},{"uid":"d45b-60"}],"importedBy":[],"isEntry":true},"d45b-64":{"id":"react","moduleParts":{},"imported":[],"importedBy":[{"uid":"d45b-62"}],"isExternal":true},"d45b-65":{"id":"use-sync-external-store/shim","moduleParts":{},"imported":[],"importedBy":[{"uid":"d45b-62"}],"isExternal":true}},"env":{"rollup":"2.77.2"},"options":{"gzip":true,"brotli":false,"sourcemap":false}};
 
     const run = () => {
       const width = window.innerWidth;

package/build/stats-react.json

@@ -7,7 +7,7 @@
         "name": "index.production.js",
         "children": [
           {
-            "uid": "392f-67",
+            "uid": "d45b-67",
             "name": "\u0000rollupPluginBabelHelpers.js"
           },
           {
@@ -15,11 +15,11 @@
             "children": [
               {
                 "name": "router-core/build/esm/index.js",
-                "uid": "392f-69"
+                "uid": "d45b-69"
               },
               {
                 "name": "react-router/src/index.tsx",
-                "uid": "392f-71"
+                "uid": "d45b-71"
               }
             ]
           }
@@ -29,90 +29,90 @@
     "isRoot": true
   },
   "nodeParts": {
-    "392f-67": {
+    "d45b-67": {
       "renderedLength": 798,
       "gzipLength": 366,
       "brotliLength": 0,
-      "mainUid": "392f-66"
+      "mainUid": "d45b-66"
     },
-    "392f-69": {
-      "renderedLength": 74811,
-      "gzipLength": 15587,
+    "d45b-69": {
+      "renderedLength": 75162,
+      "gzipLength": 15777,
       "brotliLength": 0,
-      "mainUid": "392f-68"
+      "mainUid": "d45b-68"
     },
-    "392f-71": {
-      "renderedLength": 12726,
-      "gzipLength": 3316,
+    "d45b-71": {
+      "renderedLength": 12795,
+      "gzipLength": 3210,
       "brotliLength": 0,
-      "mainUid": "392f-70"
+      "mainUid": "d45b-70"
     }
   },
   "nodeMetas": {
-    "392f-66": {
+    "d45b-66": {
       "id": "\u0000rollupPluginBabelHelpers.js",
       "moduleParts": {
-        "index.production.js": "392f-67"
+        "index.production.js": "d45b-67"
       },
       "imported": [],
       "importedBy": [
         {
-          "uid": "392f-70"
+          "uid": "d45b-70"
         }
       ]
     },
-    "392f-68": {
+    "d45b-68": {
       "id": "/packages/router-core/build/esm/index.js",
       "moduleParts": {
-        "index.production.js": "392f-69"
+        "index.production.js": "d45b-69"
       },
       "imported": [],
       "importedBy": [
         {
-          "uid": "392f-70"
+          "uid": "d45b-70"
         }
       ]
     },
-    "392f-70": {
+    "d45b-70": {
       "id": "/packages/react-router/src/index.tsx",
       "moduleParts": {
-        "index.production.js": "392f-71"
+        "index.production.js": "d45b-71"
       },
       "imported": [
         {
-          "uid": "392f-66"
+          "uid": "d45b-66"
         },
         {
-          "uid": "392f-72"
+          "uid": "d45b-72"
         },
         {
-          "uid": "392f-73"
+          "uid": "d45b-73"
         },
         {
-          "uid": "392f-68"
+          "uid": "d45b-68"
         }
       ],
       "importedBy": [],
       "isEntry": true
     },
-    "392f-72": {
+    "d45b-72": {
       "id": "react",
       "moduleParts": {},
       "imported": [],
       "importedBy": [
         {
-          "uid": "392f-70"
+          "uid": "d45b-70"
         }
       ],
       "isExternal": true
     },
-    "392f-73": {
+    "d45b-73": {
       "id": "use-sync-external-store/shim",
       "moduleParts": {},
       "imported": [],
       "importedBy": [
         {
-          "uid": "392f-70"
+          "uid": "d45b-70"
         }
       ],
       "isExternal": true

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, RouteInfo, DefaultAllRouteInfo, AnyRouteInfo, ResolveRelativePath, NoInfer, CheckId, ToIdOption, Router, ValidFromPath, ToOptions, MatchRouteOptions, RouteInfoByPath, RouterOptions, Route, LinkOptions } from '@tanstack/router-core';
 export * from '@tanstack/router-core';
 
+interface RegisterRouter {
+}
+type RegisteredRouter = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo>;
+} ? Router<TRouteConfig, TAllRouteInfo> : Router;
+type RegisteredAllRouteInfo = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo>;
+} ? TAllRouteInfo : AnyAllRouteInfo;
+type SyncRouteComponent = (props?: {}) => JSX.Element | React.ReactNode;
+type RouteComponent = SyncRouteComponent & {
+    preload?: () => Promise<SyncRouteComponent>;
+};
+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;
     }
     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;
+        useNearestMatch: () => RouteMatch<TAllRouteInfo, RouteInfo>;
+        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 = {
+declare function Link<TTo extends string = '.'>(props: MakeLinkOptions<RegisteredAllRouteInfo, '/', TTo>): JSX.Element;
+declare const matchesContext: React.Context<RouteMatch<DefaultAllRouteInfo, RouteInfo<string, string, string, string, {}, {}, {}, unknown, unknown, {}, {}, {}, {}, Record<never, string>, {}>>[]>;
+declare const routerContext: React.Context<{
+    router: RegisteredRouter;
+}>;
+type MatchesProviderProps = {
     value: RouteMatch[];
     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> & {
+type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = RouterOptions<TRouteConfig> & {
     router: Router<TRouteConfig, TAllRouteInfo>;
     children?: React.ReactNode;
 };
 declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo>({ children, router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo>): 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 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, RegisterRouter, RegisteredAllRouteInfo, RegisteredRouter, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, createReactRouter, lazy, linkProps, matchesContext, routerContext, useMatch, useMatches, useNearestMatch, usePrompt, useRoute, useRouter };