@tanstack/react-router 1.121.0-alpha.22 → 1.121.0-alpha.28

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 (214) hide show
  1. package/dist/cjs/Asset.cjs +83 -16
  2. package/dist/cjs/Asset.cjs.map +1 -1
  3. package/dist/cjs/Asset.d.cts +2 -1
  4. package/dist/cjs/CatchBoundary.cjs.map +1 -1
  5. package/dist/cjs/ClientOnly.cjs.map +1 -1
  6. package/dist/cjs/ClientOnly.d.cts +1 -1
  7. package/dist/cjs/HeadContent.cjs +19 -17
  8. package/dist/cjs/HeadContent.cjs.map +1 -1
  9. package/dist/cjs/Match.cjs +61 -57
  10. package/dist/cjs/Match.cjs.map +1 -1
  11. package/dist/cjs/Matches.cjs +14 -16
  12. package/dist/cjs/Matches.cjs.map +1 -1
  13. package/dist/cjs/Matches.d.cts +2 -2
  14. package/dist/cjs/RouterProvider.cjs.map +1 -1
  15. package/dist/cjs/SafeFragment.cjs.map +1 -1
  16. package/dist/cjs/ScriptOnce.cjs +3 -10
  17. package/dist/cjs/ScriptOnce.cjs.map +1 -1
  18. package/dist/cjs/ScriptOnce.d.cts +1 -1
  19. package/dist/cjs/Scripts.cjs +7 -11
  20. package/dist/cjs/Scripts.cjs.map +1 -1
  21. package/dist/cjs/ScrollRestoration.cjs +3 -4
  22. package/dist/cjs/ScrollRestoration.cjs.map +1 -1
  23. package/dist/cjs/Transitioner.cjs +16 -15
  24. package/dist/cjs/Transitioner.cjs.map +1 -1
  25. package/dist/cjs/awaited.cjs.map +1 -1
  26. package/dist/cjs/fileRoute.cjs +8 -8
  27. package/dist/cjs/fileRoute.cjs.map +1 -1
  28. package/dist/cjs/index.cjs +0 -12
  29. package/dist/cjs/index.cjs.map +1 -1
  30. package/dist/cjs/index.d.cts +4 -8
  31. package/dist/cjs/lazyRouteComponent.cjs +3 -16
  32. package/dist/cjs/lazyRouteComponent.cjs.map +1 -1
  33. package/dist/cjs/lazyRouteComponent.d.cts +1 -1
  34. package/dist/cjs/link.cjs +106 -74
  35. package/dist/cjs/link.cjs.map +1 -1
  36. package/dist/cjs/link.d.cts +1 -5
  37. package/dist/cjs/matchContext.cjs.map +1 -1
  38. package/dist/cjs/not-found.cjs +2 -4
  39. package/dist/cjs/not-found.cjs.map +1 -1
  40. package/dist/cjs/renderRouteNotFound.cjs.map +1 -1
  41. package/dist/cjs/route.cjs +21 -21
  42. package/dist/cjs/route.cjs.map +1 -1
  43. package/dist/cjs/route.d.cts +14 -6
  44. package/dist/cjs/router.cjs.map +1 -1
  45. package/dist/cjs/routerContext.cjs.map +1 -1
  46. package/dist/cjs/scroll-restoration.cjs +9 -3
  47. package/dist/cjs/scroll-restoration.cjs.map +1 -1
  48. package/dist/cjs/ssr/RouterClient.cjs +25 -0
  49. package/dist/cjs/ssr/RouterClient.cjs.map +1 -0
  50. package/dist/cjs/ssr/RouterClient.d.cts +4 -0
  51. package/dist/cjs/ssr/RouterServer.cjs +9 -0
  52. package/dist/cjs/ssr/RouterServer.cjs.map +1 -0
  53. package/dist/cjs/ssr/RouterServer.d.cts +4 -0
  54. package/dist/cjs/ssr/client.cjs +12 -0
  55. package/dist/cjs/ssr/client.cjs.map +1 -0
  56. package/dist/cjs/ssr/client.d.cts +2 -0
  57. package/dist/cjs/ssr/defaultRenderHandler.cjs +15 -0
  58. package/dist/cjs/ssr/defaultRenderHandler.cjs.map +1 -0
  59. package/dist/cjs/ssr/defaultRenderHandler.d.cts +1 -0
  60. package/dist/cjs/ssr/defaultStreamHandler.cjs +16 -0
  61. package/dist/cjs/ssr/defaultStreamHandler.cjs.map +1 -0
  62. package/dist/cjs/ssr/defaultStreamHandler.d.cts +1 -0
  63. package/dist/cjs/ssr/renderRouterToStream.cjs +63 -0
  64. package/dist/cjs/ssr/renderRouterToStream.cjs.map +1 -0
  65. package/dist/cjs/ssr/renderRouterToStream.d.cts +8 -0
  66. package/dist/cjs/ssr/renderRouterToString.cjs +28 -0
  67. package/dist/cjs/ssr/renderRouterToString.cjs.map +1 -0
  68. package/dist/cjs/ssr/renderRouterToString.d.cts +7 -0
  69. package/dist/cjs/ssr/server.cjs +20 -0
  70. package/dist/cjs/ssr/server.cjs.map +1 -0
  71. package/dist/cjs/ssr/server.d.cts +6 -0
  72. package/dist/cjs/useBlocker.cjs.map +1 -1
  73. package/dist/cjs/useCanGoBack.cjs.map +1 -1
  74. package/dist/cjs/useLoaderData.cjs.map +1 -1
  75. package/dist/cjs/useLoaderDeps.cjs.map +1 -1
  76. package/dist/cjs/useLocation.cjs +1 -1
  77. package/dist/cjs/useLocation.cjs.map +1 -1
  78. package/dist/cjs/useMatch.cjs.map +1 -1
  79. package/dist/cjs/useNavigate.cjs +2 -2
  80. package/dist/cjs/useNavigate.cjs.map +1 -1
  81. package/dist/cjs/useParams.cjs.map +1 -1
  82. package/dist/cjs/useRouter.cjs +1 -1
  83. package/dist/cjs/useRouter.cjs.map +1 -1
  84. package/dist/cjs/useRouterState.cjs +3 -3
  85. package/dist/cjs/useRouterState.cjs.map +1 -1
  86. package/dist/cjs/useSearch.cjs.map +1 -1
  87. package/dist/cjs/utils.cjs +4 -10
  88. package/dist/cjs/utils.cjs.map +1 -1
  89. package/dist/cjs/utils.d.cts +1 -1
  90. package/dist/esm/Asset.d.ts +2 -1
  91. package/dist/esm/Asset.js +66 -16
  92. package/dist/esm/Asset.js.map +1 -1
  93. package/dist/esm/CatchBoundary.js.map +1 -1
  94. package/dist/esm/ClientOnly.d.ts +1 -1
  95. package/dist/esm/ClientOnly.js.map +1 -1
  96. package/dist/esm/HeadContent.js +19 -17
  97. package/dist/esm/HeadContent.js.map +1 -1
  98. package/dist/esm/Match.js +63 -59
  99. package/dist/esm/Match.js.map +1 -1
  100. package/dist/esm/Matches.d.ts +2 -2
  101. package/dist/esm/Matches.js +14 -16
  102. package/dist/esm/Matches.js.map +1 -1
  103. package/dist/esm/RouterProvider.js.map +1 -1
  104. package/dist/esm/SafeFragment.js.map +1 -1
  105. package/dist/esm/ScriptOnce.d.ts +1 -1
  106. package/dist/esm/ScriptOnce.js +3 -10
  107. package/dist/esm/ScriptOnce.js.map +1 -1
  108. package/dist/esm/Scripts.js +7 -11
  109. package/dist/esm/Scripts.js.map +1 -1
  110. package/dist/esm/ScrollRestoration.js +3 -4
  111. package/dist/esm/ScrollRestoration.js.map +1 -1
  112. package/dist/esm/Transitioner.js +16 -15
  113. package/dist/esm/Transitioner.js.map +1 -1
  114. package/dist/esm/awaited.js.map +1 -1
  115. package/dist/esm/fileRoute.js +8 -8
  116. package/dist/esm/fileRoute.js.map +1 -1
  117. package/dist/esm/index.d.ts +4 -8
  118. package/dist/esm/index.js +2 -8
  119. package/dist/esm/index.js.map +1 -1
  120. package/dist/esm/lazyRouteComponent.d.ts +1 -1
  121. package/dist/esm/lazyRouteComponent.js +2 -15
  122. package/dist/esm/lazyRouteComponent.js.map +1 -1
  123. package/dist/esm/link.d.ts +1 -5
  124. package/dist/esm/link.js +107 -75
  125. package/dist/esm/link.js.map +1 -1
  126. package/dist/esm/matchContext.js.map +1 -1
  127. package/dist/esm/not-found.js +2 -4
  128. package/dist/esm/not-found.js.map +1 -1
  129. package/dist/esm/renderRouteNotFound.js.map +1 -1
  130. package/dist/esm/route.d.ts +14 -6
  131. package/dist/esm/route.js +21 -21
  132. package/dist/esm/route.js.map +1 -1
  133. package/dist/esm/router.js.map +1 -1
  134. package/dist/esm/routerContext.js.map +1 -1
  135. package/dist/esm/scroll-restoration.js +9 -3
  136. package/dist/esm/scroll-restoration.js.map +1 -1
  137. package/dist/esm/ssr/RouterClient.d.ts +4 -0
  138. package/dist/esm/ssr/RouterClient.js +25 -0
  139. package/dist/esm/ssr/RouterClient.js.map +1 -0
  140. package/dist/esm/ssr/RouterServer.d.ts +4 -0
  141. package/dist/esm/ssr/RouterServer.js +9 -0
  142. package/dist/esm/ssr/RouterServer.js.map +1 -0
  143. package/dist/esm/ssr/client.d.ts +2 -0
  144. package/dist/esm/ssr/client.js +6 -0
  145. package/dist/esm/ssr/client.js.map +1 -0
  146. package/dist/esm/ssr/defaultRenderHandler.d.ts +1 -0
  147. package/dist/esm/ssr/defaultRenderHandler.js +15 -0
  148. package/dist/esm/ssr/defaultRenderHandler.js.map +1 -0
  149. package/dist/esm/ssr/defaultStreamHandler.d.ts +1 -0
  150. package/dist/esm/ssr/defaultStreamHandler.js +16 -0
  151. package/dist/esm/ssr/defaultStreamHandler.js.map +1 -0
  152. package/dist/esm/ssr/renderRouterToStream.d.ts +8 -0
  153. package/dist/esm/ssr/renderRouterToStream.js +63 -0
  154. package/dist/esm/ssr/renderRouterToStream.js.map +1 -0
  155. package/dist/esm/ssr/renderRouterToString.d.ts +7 -0
  156. package/dist/esm/ssr/renderRouterToString.js +28 -0
  157. package/dist/esm/ssr/renderRouterToString.js.map +1 -0
  158. package/dist/esm/ssr/server.d.ts +6 -0
  159. package/dist/esm/ssr/server.js +14 -0
  160. package/dist/esm/ssr/server.js.map +1 -0
  161. package/dist/esm/useBlocker.js.map +1 -1
  162. package/dist/esm/useCanGoBack.js.map +1 -1
  163. package/dist/esm/useLoaderData.js.map +1 -1
  164. package/dist/esm/useLoaderDeps.js.map +1 -1
  165. package/dist/esm/useLocation.js +1 -1
  166. package/dist/esm/useLocation.js.map +1 -1
  167. package/dist/esm/useMatch.js.map +1 -1
  168. package/dist/esm/useNavigate.js +2 -2
  169. package/dist/esm/useNavigate.js.map +1 -1
  170. package/dist/esm/useParams.js.map +1 -1
  171. package/dist/esm/useRouter.js +1 -1
  172. package/dist/esm/useRouter.js.map +1 -1
  173. package/dist/esm/useRouterState.js +3 -3
  174. package/dist/esm/useRouterState.js.map +1 -1
  175. package/dist/esm/useSearch.js.map +1 -1
  176. package/dist/esm/utils.d.ts +1 -1
  177. package/dist/esm/utils.js +4 -10
  178. package/dist/esm/utils.js.map +1 -1
  179. package/dist/llms/index.d.ts +3 -0
  180. package/dist/llms/index.js +35 -0
  181. package/dist/llms/rules/api.d.ts +2 -0
  182. package/dist/llms/rules/api.js +4326 -0
  183. package/dist/llms/rules/guide.d.ts +2 -0
  184. package/dist/llms/rules/guide.js +7096 -0
  185. package/dist/llms/rules/routing.d.ts +2 -0
  186. package/dist/llms/rules/routing.js +1981 -0
  187. package/dist/llms/rules/setup-and-architecture.d.ts +2 -0
  188. package/dist/llms/rules/setup-and-architecture.js +945 -0
  189. package/package.json +32 -6
  190. package/src/Asset.tsx +95 -16
  191. package/src/ClientOnly.tsx +1 -1
  192. package/src/HeadContent.tsx +16 -0
  193. package/src/Match.tsx +86 -63
  194. package/src/Matches.tsx +24 -17
  195. package/src/ScriptOnce.tsx +2 -14
  196. package/src/Transitioner.tsx +13 -14
  197. package/src/index.tsx +3 -21
  198. package/src/lazyRouteComponent.tsx +6 -31
  199. package/src/link.tsx +130 -99
  200. package/src/not-found.tsx +1 -1
  201. package/src/route.tsx +18 -9
  202. package/src/scroll-restoration.tsx +10 -3
  203. package/src/ssr/RouterClient.tsx +22 -0
  204. package/src/ssr/RouterServer.tsx +9 -0
  205. package/src/ssr/client.ts +2 -0
  206. package/src/ssr/defaultRenderHandler.tsx +12 -0
  207. package/src/ssr/defaultStreamHandler.tsx +13 -0
  208. package/src/ssr/renderRouterToStream.tsx +79 -0
  209. package/src/ssr/renderRouterToString.tsx +31 -0
  210. package/src/ssr/server.ts +6 -0
  211. package/src/utils.ts +6 -14
  212. package/dist/cjs/serializer.d.cts +0 -6
  213. package/dist/esm/serializer.d.ts +0 -6
  214. package/src/serializer.ts +0 -7
package/src/ssr/defaultStreamHandler.tsx ADDED
@@ -0,0 +1,13 @@
1
+ import { defineHandlerCallback } from '@tanstack/router-core/ssr/server'
2
+ import { RouterServer } from './RouterServer'
3
+ import { renderRouterToStream } from './renderRouterToStream'
4
+
5
+ export const defaultStreamHandler = defineHandlerCallback(
6
+ ({ request, router, responseHeaders }) =>
7
+ renderRouterToStream({
8
+ request,
9
+ router,
10
+ responseHeaders,
11
+ children: <RouterServer router={router} />,
12
+ }),
13
+ )
package/src/ssr/renderRouterToStream.tsx ADDED
@@ -0,0 +1,79 @@
1
+ import { PassThrough } from 'node:stream'
2
+ import ReactDOMServer from 'react-dom/server'
3
+ import { isbot } from 'isbot'
4
+ import {
5
+ transformPipeableStreamWithRouter,
6
+ transformReadableStreamWithRouter,
7
+ } from '@tanstack/router-core/ssr/server'
8
+ import type { AnyRouter } from '@tanstack/router-core'
9
+ import type { ReadableStream } from 'node:stream/web'
10
+ import type { ReactNode } from 'react'
11
+
12
+ export const renderRouterToStream = async ({
13
+ request,
14
+ router,
15
+ responseHeaders,
16
+ children,
17
+ }: {
18
+ request: Request
19
+ router: AnyRouter
20
+ responseHeaders: Headers
21
+ children: ReactNode
22
+ }) => {
23
+ if (typeof ReactDOMServer.renderToReadableStream === 'function') {
24
+ const stream = await ReactDOMServer.renderToReadableStream(children, {
25
+ signal: request.signal,
26
+ })
27
+
28
+ if (isbot(request.headers.get('User-Agent'))) {
29
+ await stream.allReady
30
+ }
31
+
32
+ const responseStream = transformReadableStreamWithRouter(
33
+ router,
34
+ stream as unknown as ReadableStream,
35
+ )
36
+ return new Response(responseStream as any, {
37
+ status: router.state.statusCode,
38
+ headers: responseHeaders,
39
+ })
40
+ }
41
+
42
+ if (typeof ReactDOMServer.renderToPipeableStream === 'function') {
43
+ const reactAppPassthrough = new PassThrough()
44
+
45
+ try {
46
+ const pipeable = ReactDOMServer.renderToPipeableStream(children, {
47
+ ...(isbot(request.headers.get('User-Agent'))
48
+ ? {
49
+ onAllReady() {
50
+ pipeable.pipe(reactAppPassthrough)
51
+ },
52
+ }
53
+ : {
54
+ onShellReady() {
55
+ pipeable.pipe(reactAppPassthrough)
56
+ },
57
+ }),
58
+ onError: (error, info) => {
59
+ console.error('Error in renderToPipeableStream:', error, info)
60
+ },
61
+ })
62
+ } catch (e) {
63
+ console.error('Error in renderToPipeableStream:', e)
64
+ }
65
+
66
+ const responseStream = transformPipeableStreamWithRouter(
67
+ router,
68
+ reactAppPassthrough,
69
+ )
70
+ return new Response(responseStream as any, {
71
+ status: router.state.statusCode,
72
+ headers: responseHeaders,
73
+ })
74
+ }
75
+
76
+ throw new Error(
77
+ 'No renderToReadableStream or renderToPipeableStream found in react-dom/server. Ensure you are using a version of react-dom that supports streaming.',
78
+ )
79
+ }
package/src/ssr/renderRouterToString.tsx ADDED
@@ -0,0 +1,31 @@
1
+ import ReactDOMServer from 'react-dom/server'
2
+ import type { ReactNode } from 'react'
3
+ import type { AnyRouter } from '@tanstack/router-core'
4
+
5
+ export const renderRouterToString = async ({
6
+ router,
7
+ responseHeaders,
8
+ children,
9
+ }: {
10
+ router: AnyRouter
11
+ responseHeaders: Headers
12
+ children: ReactNode
13
+ }) => {
14
+ try {
15
+ let html = ReactDOMServer.renderToString(children)
16
+ const injectedHtml = await Promise.all(router.serverSsr!.injectedHtml).then(
17
+ (htmls) => htmls.join(''),
18
+ )
19
+ html = html.replace(`</body>`, `${injectedHtml}</body>`)
20
+ return new Response(`<!DOCTYPE html>${html}`, {
21
+ status: router.state.statusCode,
22
+ headers: responseHeaders,
23
+ })
24
+ } catch (error) {
25
+ console.error('Render to string error:', error)
26
+ return new Response('Internal Server Error', {
27
+ status: 500,
28
+ headers: responseHeaders,
29
+ })
30
+ }
31
+ }
package/src/ssr/server.ts ADDED
@@ -0,0 +1,6 @@
1
+ export { RouterServer } from './RouterServer'
2
+ export { defaultRenderHandler } from './defaultRenderHandler'
3
+ export { defaultStreamHandler } from './defaultStreamHandler'
4
+ export { renderRouterToStream } from './renderRouterToStream'
5
+ export { renderRouterToString } from './renderRouterToString'
6
+ export * from '@tanstack/router-core/ssr/server'
package/src/utils.ts CHANGED
@@ -69,34 +69,26 @@ export function useIntersectionObserver<T extends Element>(
69
69
  callback: (entry: IntersectionObserverEntry | undefined) => void,
70
70
  intersectionObserverOptions: IntersectionObserverInit = {},
71
71
  options: { disabled?: boolean } = {},
72
- ): IntersectionObserver | null {
73
- const isIntersectionObserverAvailable = React.useRef(
74
- typeof IntersectionObserver === 'function',
75
- )
76
-
77
- const observerRef = React.useRef<IntersectionObserver | null>(null)
78
-
72
+ ) {
79
73
  React.useEffect(() => {
80
74
  if (
81
75
  !ref.current ||
82
- !isIntersectionObserverAvailable.current ||
83
- options.disabled
76
+ options.disabled ||
77
+ typeof IntersectionObserver !== 'function'
84
78
  ) {
85
79
  return
86
80
  }
87
81
 
88
- observerRef.current = new IntersectionObserver(([entry]) => {
82
+ const observer = new IntersectionObserver(([entry]) => {
89
83
  callback(entry)
90
84
  }, intersectionObserverOptions)
91
85
 
92
- observerRef.current.observe(ref.current)
86
+ observer.observe(ref.current)
93
87
 
94
88
  return () => {
95
- observerRef.current?.disconnect()
89
+ observer.disconnect()
96
90
  }
97
91
  }, [callback, intersectionObserverOptions, options.disabled, ref])
98
-
99
- return observerRef.current
100
92
  }
101
93
 
102
94
  /**
package/dist/cjs/serializer.d.cts DELETED
@@ -1,6 +0,0 @@
1
- import type * as React from 'react';
2
- declare module '@tanstack/router-core' {
3
- interface SerializerExtensions {
4
- ReadableStream: React.JSX.Element;
5
- }
6
- }
package/dist/esm/serializer.d.ts DELETED
@@ -1,6 +0,0 @@
1
- import type * as React from 'react';
2
- declare module '@tanstack/router-core' {
3
- interface SerializerExtensions {
4
- ReadableStream: React.JSX.Element;
5
- }
6
- }
package/src/serializer.ts DELETED
@@ -1,7 +0,0 @@
1
- import type * as React from 'react'
2
-
3
- declare module '@tanstack/router-core' {
4
- export interface SerializerExtensions {
5
- ReadableStream: React.JSX.Element
6
- }
7
- }