@tanstack/solid-router 1.112.11 → 1.112.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/dist/cjs/Match.cjs.map +1 -1
  2. package/dist/cjs/Matches.cjs.map +1 -1
  3. package/dist/cjs/Matches.d.cts +1 -8
  4. package/dist/cjs/RouterProvider.cjs.map +1 -1
  5. package/dist/cjs/RouterProvider.d.cts +4 -4
  6. package/dist/cjs/Transitioner.cjs +1 -1
  7. package/dist/cjs/Transitioner.cjs.map +1 -1
  8. package/dist/cjs/fileRoute.cjs.map +1 -1
  9. package/dist/cjs/fileRoute.d.cts +4 -7
  10. package/dist/cjs/index.d.cts +3 -5
  11. package/dist/cjs/link.cjs.map +1 -1
  12. package/dist/cjs/link.d.cts +1 -2
  13. package/dist/cjs/not-found.cjs.map +1 -1
  14. package/dist/cjs/not-found.d.cts +1 -2
  15. package/dist/cjs/redirects.cjs.map +1 -1
  16. package/dist/cjs/redirects.d.cts +1 -2
  17. package/dist/cjs/renderRouteNotFound.cjs.map +1 -1
  18. package/dist/cjs/renderRouteNotFound.d.cts +1 -2
  19. package/dist/cjs/route.cjs +15 -23
  20. package/dist/cjs/route.cjs.map +1 -1
  21. package/dist/cjs/route.d.cts +19 -50
  22. package/dist/cjs/router.cjs +18 -20
  23. package/dist/cjs/router.cjs.map +1 -1
  24. package/dist/cjs/router.d.cts +84 -454
  25. package/dist/cjs/routerContext.cjs.map +1 -1
  26. package/dist/cjs/routerContext.d.cts +2 -2
  27. package/dist/cjs/scroll-restoration.cjs.map +1 -1
  28. package/dist/cjs/scroll-restoration.d.cts +1 -2
  29. package/dist/cjs/typePrimitives.d.cts +1 -2
  30. package/dist/cjs/useBlocker.cjs.map +1 -1
  31. package/dist/cjs/useBlocker.d.cts +2 -3
  32. package/dist/cjs/useLoaderData.cjs.map +1 -1
  33. package/dist/cjs/useLoaderData.d.cts +1 -3
  34. package/dist/cjs/useLoaderDeps.cjs.map +1 -1
  35. package/dist/cjs/useLoaderDeps.d.cts +1 -3
  36. package/dist/cjs/useLocation.cjs.map +1 -1
  37. package/dist/cjs/useLocation.d.cts +1 -1
  38. package/dist/cjs/useMatch.cjs.map +1 -1
  39. package/dist/cjs/useMatch.d.cts +1 -3
  40. package/dist/cjs/useNavigate.cjs +1 -0
  41. package/dist/cjs/useNavigate.cjs.map +1 -1
  42. package/dist/cjs/useNavigate.d.cts +1 -2
  43. package/dist/cjs/useParams.cjs.map +1 -1
  44. package/dist/cjs/useParams.d.cts +1 -3
  45. package/dist/cjs/useRouteContext.cjs.map +1 -1
  46. package/dist/cjs/useRouteContext.d.cts +1 -2
  47. package/dist/cjs/useRouter.cjs.map +1 -1
  48. package/dist/cjs/useRouter.d.cts +1 -1
  49. package/dist/cjs/useRouterState.cjs.map +1 -1
  50. package/dist/cjs/useRouterState.d.cts +1 -1
  51. package/dist/cjs/useSearch.cjs.map +1 -1
  52. package/dist/cjs/useSearch.d.cts +1 -3
  53. package/dist/cjs/utils.cjs.map +1 -1
  54. package/dist/cjs/utils.d.cts +0 -9
  55. package/dist/esm/Match.js.map +1 -1
  56. package/dist/esm/Matches.d.ts +1 -8
  57. package/dist/esm/Matches.js.map +1 -1
  58. package/dist/esm/RouterProvider.d.ts +4 -4
  59. package/dist/esm/RouterProvider.js.map +1 -1
  60. package/dist/esm/Transitioner.js +1 -1
  61. package/dist/esm/Transitioner.js.map +1 -1
  62. package/dist/esm/fileRoute.d.ts +4 -7
  63. package/dist/esm/fileRoute.js.map +1 -1
  64. package/dist/esm/index.d.ts +3 -5
  65. package/dist/esm/link.d.ts +1 -2
  66. package/dist/esm/link.js.map +1 -1
  67. package/dist/esm/not-found.d.ts +1 -2
  68. package/dist/esm/not-found.js.map +1 -1
  69. package/dist/esm/redirects.d.ts +1 -2
  70. package/dist/esm/redirects.js.map +1 -1
  71. package/dist/esm/renderRouteNotFound.d.ts +1 -2
  72. package/dist/esm/renderRouteNotFound.js.map +1 -1
  73. package/dist/esm/route.d.ts +19 -50
  74. package/dist/esm/route.js +15 -23
  75. package/dist/esm/route.js.map +1 -1
  76. package/dist/esm/router.d.ts +84 -454
  77. package/dist/esm/router.js +18 -20
  78. package/dist/esm/router.js.map +1 -1
  79. package/dist/esm/routerContext.d.ts +2 -2
  80. package/dist/esm/routerContext.js.map +1 -1
  81. package/dist/esm/scroll-restoration.d.ts +1 -2
  82. package/dist/esm/scroll-restoration.js.map +1 -1
  83. package/dist/esm/typePrimitives.d.ts +1 -2
  84. package/dist/esm/useBlocker.d.ts +2 -3
  85. package/dist/esm/useBlocker.js.map +1 -1
  86. package/dist/esm/useLoaderData.d.ts +1 -3
  87. package/dist/esm/useLoaderData.js.map +1 -1
  88. package/dist/esm/useLoaderDeps.d.ts +1 -3
  89. package/dist/esm/useLoaderDeps.js.map +1 -1
  90. package/dist/esm/useLocation.d.ts +1 -1
  91. package/dist/esm/useLocation.js.map +1 -1
  92. package/dist/esm/useMatch.d.ts +1 -3
  93. package/dist/esm/useMatch.js.map +1 -1
  94. package/dist/esm/useNavigate.d.ts +1 -2
  95. package/dist/esm/useNavigate.js +1 -0
  96. package/dist/esm/useNavigate.js.map +1 -1
  97. package/dist/esm/useParams.d.ts +1 -3
  98. package/dist/esm/useParams.js.map +1 -1
  99. package/dist/esm/useRouteContext.d.ts +1 -2
  100. package/dist/esm/useRouteContext.js.map +1 -1
  101. package/dist/esm/useRouter.d.ts +1 -1
  102. package/dist/esm/useRouter.js.map +1 -1
  103. package/dist/esm/useRouterState.d.ts +1 -1
  104. package/dist/esm/useRouterState.js.map +1 -1
  105. package/dist/esm/useSearch.d.ts +1 -3
  106. package/dist/esm/useSearch.js.map +1 -1
  107. package/dist/esm/utils.d.ts +0 -9
  108. package/dist/esm/utils.js.map +1 -1
  109. package/dist/source/Matches.d.ts +1 -8
  110. package/dist/source/Matches.jsx.map +1 -1
  111. package/dist/source/RouterProvider.d.ts +4 -4
  112. package/dist/source/RouterProvider.jsx.map +1 -1
  113. package/dist/source/Transitioner.jsx +1 -1
  114. package/dist/source/Transitioner.jsx.map +1 -1
  115. package/dist/source/fileRoute.d.ts +4 -7
  116. package/dist/source/fileRoute.js.map +1 -1
  117. package/dist/source/index.d.ts +3 -5
  118. package/dist/source/index.jsx.map +1 -1
  119. package/dist/source/link.d.ts +1 -2
  120. package/dist/source/link.jsx.map +1 -1
  121. package/dist/source/not-found.d.ts +1 -2
  122. package/dist/source/not-found.jsx.map +1 -1
  123. package/dist/source/redirects.d.ts +1 -2
  124. package/dist/source/renderRouteNotFound.d.ts +1 -2
  125. package/dist/source/renderRouteNotFound.jsx.map +1 -1
  126. package/dist/source/route.d.ts +19 -50
  127. package/dist/source/route.js +15 -23
  128. package/dist/source/route.js.map +1 -1
  129. package/dist/source/router.d.ts +83 -454
  130. package/dist/source/router.js +23 -14
  131. package/dist/source/router.js.map +1 -1
  132. package/dist/source/routerContext.d.ts +2 -2
  133. package/dist/source/routerContext.jsx.map +1 -1
  134. package/dist/source/scroll-restoration.d.ts +1 -2
  135. package/dist/source/scroll-restoration.jsx.map +1 -1
  136. package/dist/source/typePrimitives.d.ts +1 -2
  137. package/dist/source/useBlocker.d.ts +2 -3
  138. package/dist/source/useBlocker.jsx.map +1 -1
  139. package/dist/source/useLoaderData.d.ts +1 -3
  140. package/dist/source/useLoaderData.jsx.map +1 -1
  141. package/dist/source/useLoaderDeps.d.ts +1 -3
  142. package/dist/source/useLoaderDeps.jsx.map +1 -1
  143. package/dist/source/useLocation.d.ts +1 -1
  144. package/dist/source/useLocation.jsx.map +1 -1
  145. package/dist/source/useMatch.d.ts +1 -3
  146. package/dist/source/useMatch.jsx.map +1 -1
  147. package/dist/source/useNavigate.d.ts +1 -2
  148. package/dist/source/useNavigate.jsx +1 -15
  149. package/dist/source/useNavigate.jsx.map +1 -1
  150. package/dist/source/useParams.d.ts +1 -3
  151. package/dist/source/useParams.jsx.map +1 -1
  152. package/dist/source/useRouteContext.d.ts +1 -2
  153. package/dist/source/useRouter.d.ts +1 -1
  154. package/dist/source/useRouterState.d.ts +1 -1
  155. package/dist/source/useRouterState.jsx.map +1 -1
  156. package/dist/source/useSearch.d.ts +1 -3
  157. package/dist/source/useSearch.jsx.map +1 -1
  158. package/dist/source/utils.d.ts +1 -10
  159. package/dist/source/utils.js.map +1 -1
  160. package/package.json +3 -3
  161. package/src/Match.tsx +1 -1
  162. package/src/Matches.tsx +4 -8
  163. package/src/RouterProvider.tsx +4 -7
  164. package/src/Transitioner.tsx +1 -1
  165. package/src/fileRoute.ts +9 -25
  166. package/src/index.tsx +22 -28
  167. package/src/link.tsx +2 -1
  168. package/src/not-found.tsx +1 -2
  169. package/src/redirects.ts +1 -1
  170. package/src/renderRouteNotFound.tsx +1 -2
  171. package/src/route.ts +93 -222
  172. package/src/router.ts +146 -591
  173. package/src/routerContext.tsx +3 -3
  174. package/src/scroll-restoration.tsx +6 -2
  175. package/src/typePrimitives.ts +2 -1
  176. package/src/useBlocker.tsx +7 -3
  177. package/src/useLoaderData.tsx +3 -2
  178. package/src/useLoaderDeps.tsx +3 -2
  179. package/src/useLocation.tsx +5 -1
  180. package/src/useMatch.tsx +3 -2
  181. package/src/useNavigate.tsx +3 -17
  182. package/src/useParams.tsx +3 -2
  183. package/src/useRouteContext.ts +2 -2
  184. package/src/useRouter.tsx +1 -1
  185. package/src/useRouterState.tsx +5 -1
  186. package/src/useSearch.tsx +3 -2
  187. package/src/utils.ts +0 -16
@@ -1,5 +1,5 @@
1
1
  import * as Solid from 'solid-js'
2
- import type { AnyRouter, Router } from './router'
2
+ import type { AnyRouter } from '@tanstack/router-core'
3
3
 
4
4
  declare global {
5
5
  interface Window {
@@ -7,8 +7,8 @@ declare global {
7
7
  }
8
8
  }
9
9
 
10
- const routerContext = Solid.createContext<Router<any, any, any>>(
11
- null as unknown as Router<any, any, any>,
10
+ const routerContext = Solid.createContext<AnyRouter>(
11
+ null as unknown as AnyRouter,
12
12
  )
13
13
 
14
14
  export function getRouterContext() {
@@ -1,8 +1,12 @@
1
1
  import { functionalUpdate } from '@tanstack/router-core'
2
2
  import { useRouter } from './useRouter'
3
3
  import { ScriptOnce } from './ScriptOnce'
4
- import type { AnyRouter } from './router'
5
- import type { NonNullableUpdater, ParsedLocation } from '@tanstack/router-core'
4
+
5
+ import type {
6
+ AnyRouter,
7
+ NonNullableUpdater,
8
+ ParsedLocation,
9
+ } from '@tanstack/router-core'
6
10
 
7
11
  export type ScrollRestorationEntry = { scrollX: number; scrollY: number }
8
12
 
@@ -1,14 +1,15 @@
1
1
  import type { LinkComponentProps } from './link'
2
- import type { AnyRouter, RegisteredRouter } from './router'
3
2
  import type { UseParamsOptions } from './useParams'
4
3
  import type { UseSearchOptions } from './useSearch'
5
4
  import type {
5
+ AnyRouter,
6
6
  Constrain,
7
7
  ConstrainLiteral,
8
8
  FromPathOption,
9
9
  NavigateOptions,
10
10
  PathParamOptions,
11
11
  Redirect,
12
+ RegisteredRouter,
12
13
  RouteIds,
13
14
  SearchParamOptions,
14
15
  ToPathOption,
@@ -5,9 +5,13 @@ import type {
5
5
  HistoryAction,
6
6
  HistoryLocation,
7
7
  } from '@tanstack/history'
8
- import type { AnyRoute, SolidNode } from './route'
9
- import type { ParseRoute } from '@tanstack/router-core'
10
- import type { AnyRouter, RegisteredRouter } from './router'
8
+ import type { SolidNode } from './route'
9
+ import type {
10
+ AnyRoute,
11
+ AnyRouter,
12
+ ParseRoute,
13
+ RegisteredRouter,
14
+ } from '@tanstack/router-core'
11
15
 
12
16
  interface ShouldBlockFnLocation<
13
17
  out TRouteId,
@@ -1,9 +1,10 @@
1
1
  import { useMatch } from './useMatch'
2
2
  import type { Accessor } from 'solid-js'
3
- import type { AnyRouter, RegisteredRouter } from './router'
4
- import type { StrictOrFrom } from './utils'
5
3
  import type {
4
+ AnyRouter,
5
+ RegisteredRouter,
6
6
  ResolveUseLoaderData,
7
+ StrictOrFrom,
7
8
  UseLoaderDataResult,
8
9
  } from '@tanstack/router-core'
9
10
 
@@ -1,8 +1,9 @@
1
1
  import { useMatch } from './useMatch'
2
- import type { AnyRouter, RegisteredRouter } from './router'
3
- import type { StrictOrFrom } from './utils'
4
2
  import type {
3
+ AnyRouter,
4
+ RegisteredRouter,
5
5
  ResolveUseLoaderDeps,
6
+ StrictOrFrom,
6
7
  UseLoaderDepsResult,
7
8
  } from '@tanstack/router-core'
8
9
 
@@ -1,6 +1,10 @@
1
1
  import { useRouterState } from './useRouterState'
2
+ import type {
3
+ AnyRouter,
4
+ RegisteredRouter,
5
+ RouterState,
6
+ } from '@tanstack/router-core'
2
7
  import type { Accessor } from 'solid-js'
3
- import type { AnyRouter, RegisteredRouter, RouterState } from './router'
4
8
 
5
9
  export interface UseLocationBaseOptions<TRouter extends AnyRouter, TSelected> {
6
10
  select?: (state: RouterState<TRouter['routeTree']>['location']) => TSelected
package/src/useMatch.tsx CHANGED
@@ -2,11 +2,12 @@ import * as Solid from 'solid-js'
2
2
  import invariant from 'tiny-invariant'
3
3
  import { useRouterState } from './useRouterState'
4
4
  import { dummyMatchContext, matchContext } from './matchContext'
5
- import type { AnyRouter, RegisteredRouter } from './router'
6
- import type { StrictOrFrom } from './utils'
7
5
  import type {
6
+ AnyRouter,
8
7
  MakeRouteMatch,
9
8
  MakeRouteMatchUnion,
9
+ RegisteredRouter,
10
+ StrictOrFrom,
10
11
  ThrowOrOptional,
11
12
  } from '@tanstack/router-core'
12
13
 
@@ -1,11 +1,12 @@
1
1
  import * as Solid from 'solid-js'
2
2
  import { useRouter } from './useRouter'
3
3
  import type {
4
+ AnyRouter,
4
5
  FromPathOption,
5
6
  NavigateOptions,
7
+ RegisteredRouter,
6
8
  UseNavigateResult,
7
9
  } from '@tanstack/router-core'
8
- import type { AnyRouter, RegisteredRouter } from './router'
9
10
 
10
11
  export function useNavigate<
11
12
  TRouter extends AnyRouter = RegisteredRouter,
@@ -16,25 +17,10 @@ export function useNavigate<
16
17
  const { navigate } = useRouter()
17
18
 
18
19
  return ((options: NavigateOptions) => {
19
- return navigate({ ...options })
20
+ return navigate({ from: _defaultOpts?.from, ...options })
20
21
  }) as UseNavigateResult<TDefaultFrom>
21
22
  }
22
23
 
23
- // NOTE: I don't know of anyone using this. It's undocumented, so let's wait until someone needs it
24
- // export function typedNavigate<
25
- // TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
26
- // TDefaultFrom extends RoutePaths<TRouteTree> = '/',
27
- // >(navigate: (opts: NavigateOptions<any>) => Promise<void>) {
28
- // return navigate as <
29
- // TFrom extends RoutePaths<TRouteTree> = TDefaultFrom,
30
- // TTo extends string = '',
31
- // TMaskFrom extends RoutePaths<TRouteTree> = '/',
32
- // TMaskTo extends string = '',
33
- // >(
34
- // opts?: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>,
35
- // ) => Promise<void>
36
- // } //
37
-
38
24
  export function Navigate<
39
25
  TRouter extends AnyRouter = RegisteredRouter,
40
26
  const TFrom extends string = string,
package/src/useParams.tsx CHANGED
@@ -1,10 +1,11 @@
1
1
  import { useMatch } from './useMatch'
2
2
  import type { ThrowConstraint } from './useMatch'
3
3
  import type { Accessor } from 'solid-js'
4
- import type { AnyRouter, RegisteredRouter } from './router'
5
- import type { StrictOrFrom } from './utils'
6
4
  import type {
5
+ AnyRouter,
6
+ RegisteredRouter,
7
7
  ResolveUseParams,
8
+ StrictOrFrom,
8
9
  ThrowOrOptional,
9
10
  UseParamsResult,
10
11
  } from '@tanstack/router-core'
@@ -1,8 +1,8 @@
1
1
  import { useMatch } from './useMatch'
2
2
  import type { Accessor } from 'solid-js'
3
-
4
- import type { AnyRouter, RegisteredRouter } from './router'
5
3
  import type {
4
+ AnyRouter,
5
+ RegisteredRouter,
6
6
  UseRouteContextBaseOptions,
7
7
  UseRouteContextOptions,
8
8
  UseRouteContextResult,
package/src/useRouter.tsx CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as Solid from 'solid-js'
2
2
  import warning from 'tiny-warning'
3
3
  import { getRouterContext } from './routerContext'
4
- import type { AnyRouter, RegisteredRouter } from './router'
4
+ import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core'
5
5
 
6
6
  export function useRouter<TRouter extends AnyRouter = RegisteredRouter>(opts?: {
7
7
  warn?: boolean
@@ -1,6 +1,10 @@
1
1
  import { useStore } from '@tanstack/solid-store'
2
2
  import { useRouter } from './useRouter'
3
- import type { AnyRouter, RegisteredRouter, RouterState } from './router'
3
+ import type {
4
+ AnyRouter,
5
+ RegisteredRouter,
6
+ RouterState,
7
+ } from '@tanstack/router-core'
4
8
  import type { Accessor } from 'solid-js'
5
9
 
6
10
  export type UseRouterStateOptions<TRouter extends AnyRouter, TSelected> = {
package/src/useSearch.tsx CHANGED
@@ -1,10 +1,11 @@
1
1
  import { useMatch } from './useMatch'
2
2
  import type { ThrowConstraint } from './useMatch'
3
3
  import type { Accessor } from 'solid-js'
4
- import type { AnyRouter, RegisteredRouter } from './router'
5
- import type { StrictOrFrom } from './utils'
6
4
  import type {
5
+ AnyRouter,
6
+ RegisteredRouter,
7
7
  ResolveUseSearch,
8
+ StrictOrFrom,
8
9
  ThrowOrOptional,
9
10
  UseSearchResult,
10
11
  } from '@tanstack/router-core'
package/src/utils.ts CHANGED
@@ -1,20 +1,4 @@
1
1
  import * as Solid from 'solid-js'
2
- import type { AnyRouter } from './router'
3
- import type { ConstrainLiteral, RouteIds } from '@tanstack/router-core'
4
-
5
- export type StrictOrFrom<
6
- TRouter extends AnyRouter,
7
- TFrom,
8
- TStrict extends boolean = true,
9
- > = TStrict extends false
10
- ? {
11
- from?: never
12
- strict: TStrict
13
- }
14
- : {
15
- from: ConstrainLiteral<TFrom, RouteIds<TRouter['routeTree']>>
16
- strict?: TStrict
17
- }
18
2
 
19
3
  export const useLayoutEffect =
20
4
  typeof window !== 'undefined' ? Solid.createRenderEffect : Solid.createEffect