react-router 7.16.0 → 8.0.0-pre.0

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 (369) hide show
  1. package/CHANGELOG.md +0 -1
  2. package/dist/development/dom-export.d.ts +6 -172
  3. package/dist/development/dom-export.js +12 -1007
  4. package/dist/development/index-react-server-client.d.ts +7 -4
  5. package/dist/development/index-react-server-client.js +8 -52
  6. package/dist/development/index-react-server.d.ts +1645 -1635
  7. package/dist/development/index-react-server.js +2880 -3642
  8. package/dist/development/index.d.ts +43 -1475
  9. package/dist/development/index.js +37 -2621
  10. package/dist/development/lib/actions.js +62 -0
  11. package/dist/development/lib/components.d.ts +1022 -0
  12. package/dist/development/lib/components.js +835 -0
  13. package/dist/development/lib/context.d.ts +83 -0
  14. package/dist/development/lib/context.js +41 -0
  15. package/dist/development/lib/dom/dom.d.ts +119 -0
  16. package/dist/development/lib/dom/dom.js +143 -0
  17. package/dist/development/lib/dom/lib.d.ts +2042 -0
  18. package/dist/development/lib/dom/lib.js +1259 -0
  19. package/dist/development/lib/dom/server.d.ts +138 -0
  20. package/dist/development/lib/dom/server.js +301 -0
  21. package/dist/development/lib/dom/ssr/components.d.ts +196 -0
  22. package/dist/development/lib/dom/ssr/components.js +579 -0
  23. package/dist/development/lib/dom/ssr/data.js +29 -0
  24. package/dist/development/lib/dom/ssr/entry.d.ts +59 -0
  25. package/dist/development/lib/dom/ssr/errorBoundaries.d.ts +27 -0
  26. package/dist/development/lib/dom/ssr/errorBoundaries.js +83 -0
  27. package/dist/development/lib/dom/ssr/errors.d.ts +7 -0
  28. package/dist/development/lib/dom/ssr/errors.js +36 -0
  29. package/dist/development/lib/dom/ssr/fallback.js +28 -0
  30. package/dist/development/lib/dom/ssr/fog-of-war.d.ts +12 -0
  31. package/dist/development/lib/dom/ssr/fog-of-war.js +170 -0
  32. package/dist/development/lib/dom/ssr/hydration.d.ts +32 -0
  33. package/dist/development/lib/dom/ssr/hydration.js +29 -0
  34. package/dist/development/lib/dom/ssr/invariant.js +16 -0
  35. package/dist/development/lib/dom/ssr/links.js +170 -0
  36. package/dist/development/lib/dom/ssr/markup.js +24 -0
  37. package/dist/development/lib/dom/ssr/routeModules.d.ts +206 -0
  38. package/dist/development/lib/dom/ssr/routeModules.js +31 -0
  39. package/dist/development/lib/dom/ssr/routes-test-stub.d.ts +62 -0
  40. package/dist/development/lib/dom/ssr/routes-test-stub.js +108 -0
  41. package/dist/development/lib/dom/ssr/routes.d.ts +33 -0
  42. package/dist/development/lib/dom/ssr/routes.js +303 -0
  43. package/dist/development/lib/dom/ssr/server.d.ts +45 -0
  44. package/dist/development/lib/dom/ssr/server.js +68 -0
  45. package/dist/development/lib/dom/ssr/single-fetch.d.ts +14 -0
  46. package/dist/development/lib/dom/ssr/single-fetch.js +346 -0
  47. package/dist/development/lib/dom-export/dom-router-provider.d.ts +9 -0
  48. package/dist/development/lib/dom-export/dom-router-provider.js +22 -0
  49. package/dist/development/lib/dom-export/hydrated-router.d.ts +125 -0
  50. package/dist/development/lib/dom-export/hydrated-router.js +153 -0
  51. package/dist/development/lib/errors.js +29 -0
  52. package/dist/development/lib/hooks.d.ts +947 -0
  53. package/dist/development/lib/hooks.js +1386 -0
  54. package/dist/development/lib/href.d.ts +20 -0
  55. package/dist/development/lib/href.js +50 -0
  56. package/dist/development/lib/router/history.d.ts +258 -0
  57. package/dist/development/lib/router/history.js +371 -0
  58. package/dist/development/lib/router/instrumentation.d.ts +86 -0
  59. package/dist/development/lib/router/instrumentation.js +213 -0
  60. package/dist/development/lib/router/links.d.ts +113 -0
  61. package/dist/development/lib/router/router.d.ts +663 -0
  62. package/dist/development/lib/router/router.js +2981 -0
  63. package/dist/development/lib/router/utils.d.ts +942 -0
  64. package/dist/development/lib/router/utils.js +791 -0
  65. package/dist/development/lib/rsc/browser.d.ts +137 -0
  66. package/dist/development/lib/rsc/browser.js +599 -0
  67. package/dist/development/lib/rsc/errorBoundaries.d.ts +11 -0
  68. package/dist/development/lib/rsc/errorBoundaries.js +90 -0
  69. package/dist/development/lib/rsc/html-stream/browser.d.ts +48 -0
  70. package/dist/development/lib/rsc/html-stream/browser.js +74 -0
  71. package/dist/development/lib/rsc/html-stream/server.js +78 -0
  72. package/dist/development/lib/rsc/route-modules.js +27 -0
  73. package/dist/development/lib/rsc/server.rsc.d.ts +219 -0
  74. package/dist/development/lib/rsc/server.ssr.d.ts +129 -0
  75. package/dist/development/lib/rsc/server.ssr.js +388 -0
  76. package/dist/development/lib/server-runtime/build.d.ts +66 -0
  77. package/dist/development/lib/server-runtime/cookies.d.ts +66 -0
  78. package/dist/development/lib/server-runtime/cookies.js +139 -0
  79. package/dist/development/lib/server-runtime/crypto.js +43 -0
  80. package/dist/development/lib/server-runtime/data.d.ts +13 -0
  81. package/dist/development/lib/server-runtime/data.js +25 -0
  82. package/dist/development/lib/server-runtime/dev.d.ts +9 -0
  83. package/dist/development/lib/server-runtime/dev.js +26 -0
  84. package/dist/development/lib/server-runtime/entry.js +20 -0
  85. package/dist/development/lib/server-runtime/errors.js +95 -0
  86. package/dist/development/lib/server-runtime/headers.js +73 -0
  87. package/dist/development/lib/server-runtime/invariant.js +19 -0
  88. package/dist/development/lib/server-runtime/mode.d.ts +12 -0
  89. package/dist/development/lib/server-runtime/mode.js +25 -0
  90. package/dist/development/lib/server-runtime/routeMatching.js +28 -0
  91. package/dist/development/lib/server-runtime/routes.d.ts +13 -0
  92. package/dist/development/lib/server-runtime/routes.js +74 -0
  93. package/dist/development/lib/server-runtime/server.d.ts +10 -0
  94. package/dist/development/lib/server-runtime/server.js +351 -0
  95. package/dist/development/lib/server-runtime/serverHandoff.js +17 -0
  96. package/dist/development/lib/server-runtime/sessions/cookieStorage.d.ts +25 -0
  97. package/dist/development/lib/server-runtime/sessions/cookieStorage.js +45 -0
  98. package/dist/development/lib/server-runtime/sessions/memoryStorage.d.ts +23 -0
  99. package/dist/development/lib/server-runtime/sessions/memoryStorage.js +52 -0
  100. package/dist/development/lib/server-runtime/sessions.d.ts +145 -0
  101. package/dist/development/lib/server-runtime/sessions.js +98 -0
  102. package/dist/development/lib/server-runtime/single-fetch.d.ts +7 -0
  103. package/dist/development/lib/server-runtime/single-fetch.js +215 -0
  104. package/dist/development/lib/server-runtime/urls.js +31 -0
  105. package/dist/development/lib/server-runtime/warnings.js +20 -0
  106. package/dist/development/lib/types/future.d.ts +9 -0
  107. package/dist/development/lib/types/internal.d.ts +26 -177
  108. package/dist/development/lib/types/internal.js +3 -2
  109. package/dist/{production/register-CNAx3TXj.d.ts → development/lib/types/register.d.ts} +9 -15
  110. package/dist/development/lib/types/route-data.d.ts +113 -0
  111. package/dist/development/lib/types/route-module-annotations.d.ts +149 -0
  112. package/dist/development/lib/types/route-module.d.ts +19 -0
  113. package/dist/development/lib/types/serializes-to.d.ts +13 -0
  114. package/dist/development/lib/types/utils.d.ts +11 -0
  115. package/dist/development/vendor/turbo-stream-v2/flatten.js +159 -0
  116. package/dist/development/vendor/turbo-stream-v2/turbo-stream.js +178 -0
  117. package/dist/development/vendor/turbo-stream-v2/unflatten.js +198 -0
  118. package/dist/development/vendor/turbo-stream-v2/utils.js +47 -0
  119. package/dist/production/dom-export.d.ts +6 -172
  120. package/dist/production/dom-export.js +12 -1007
  121. package/dist/production/index-react-server-client.d.ts +7 -4
  122. package/dist/production/index-react-server-client.js +8 -52
  123. package/dist/production/index-react-server.d.ts +1645 -1635
  124. package/dist/production/index-react-server.js +2871 -3642
  125. package/dist/production/index.d.ts +43 -1475
  126. package/dist/production/index.js +37 -2621
  127. package/dist/production/lib/actions.js +62 -0
  128. package/dist/production/lib/components.d.ts +1022 -0
  129. package/dist/production/lib/components.js +835 -0
  130. package/dist/production/lib/context.d.ts +83 -0
  131. package/dist/production/lib/context.js +41 -0
  132. package/dist/production/lib/dom/dom.d.ts +119 -0
  133. package/dist/production/lib/dom/dom.js +143 -0
  134. package/dist/production/lib/dom/lib.d.ts +2042 -0
  135. package/dist/production/lib/dom/lib.js +1259 -0
  136. package/dist/production/lib/dom/server.d.ts +138 -0
  137. package/dist/production/lib/dom/server.js +301 -0
  138. package/dist/production/lib/dom/ssr/components.d.ts +196 -0
  139. package/dist/production/lib/dom/ssr/components.js +579 -0
  140. package/dist/production/lib/dom/ssr/data.js +29 -0
  141. package/dist/production/lib/dom/ssr/entry.d.ts +59 -0
  142. package/dist/production/lib/dom/ssr/errorBoundaries.d.ts +27 -0
  143. package/dist/production/lib/dom/ssr/errorBoundaries.js +83 -0
  144. package/dist/production/lib/dom/ssr/errors.d.ts +7 -0
  145. package/dist/production/lib/dom/ssr/errors.js +36 -0
  146. package/dist/production/lib/dom/ssr/fallback.js +21 -0
  147. package/dist/production/lib/dom/ssr/fog-of-war.d.ts +12 -0
  148. package/dist/production/lib/dom/ssr/fog-of-war.js +170 -0
  149. package/dist/production/lib/dom/ssr/hydration.d.ts +32 -0
  150. package/dist/production/lib/dom/ssr/hydration.js +29 -0
  151. package/dist/production/lib/dom/ssr/invariant.js +16 -0
  152. package/dist/production/lib/dom/ssr/links.js +170 -0
  153. package/dist/production/lib/dom/ssr/markup.js +24 -0
  154. package/dist/production/lib/dom/ssr/routeModules.d.ts +206 -0
  155. package/dist/production/lib/dom/ssr/routeModules.js +31 -0
  156. package/dist/production/lib/dom/ssr/routes-test-stub.d.ts +62 -0
  157. package/dist/production/lib/dom/ssr/routes-test-stub.js +108 -0
  158. package/dist/production/lib/dom/ssr/routes.d.ts +33 -0
  159. package/dist/production/lib/dom/ssr/routes.js +303 -0
  160. package/dist/production/lib/dom/ssr/server.d.ts +45 -0
  161. package/dist/production/lib/dom/ssr/server.js +68 -0
  162. package/dist/production/lib/dom/ssr/single-fetch.d.ts +14 -0
  163. package/dist/production/lib/dom/ssr/single-fetch.js +346 -0
  164. package/dist/production/lib/dom-export/dom-router-provider.d.ts +9 -0
  165. package/dist/production/lib/dom-export/dom-router-provider.js +22 -0
  166. package/dist/production/lib/dom-export/hydrated-router.d.ts +125 -0
  167. package/dist/production/lib/dom-export/hydrated-router.js +153 -0
  168. package/dist/production/lib/errors.js +29 -0
  169. package/dist/production/lib/hooks.d.ts +947 -0
  170. package/dist/production/lib/hooks.js +1371 -0
  171. package/dist/production/lib/href.d.ts +20 -0
  172. package/dist/production/lib/href.js +50 -0
  173. package/dist/production/lib/router/history.d.ts +258 -0
  174. package/dist/production/lib/router/history.js +371 -0
  175. package/dist/production/lib/router/instrumentation.d.ts +86 -0
  176. package/dist/production/lib/router/instrumentation.js +213 -0
  177. package/dist/production/lib/router/links.d.ts +113 -0
  178. package/dist/production/lib/router/router.d.ts +663 -0
  179. package/dist/production/lib/router/router.js +2981 -0
  180. package/dist/production/lib/router/utils.d.ts +942 -0
  181. package/dist/production/lib/router/utils.js +782 -0
  182. package/dist/production/lib/rsc/browser.d.ts +137 -0
  183. package/dist/production/lib/rsc/browser.js +599 -0
  184. package/dist/production/lib/rsc/errorBoundaries.d.ts +11 -0
  185. package/dist/production/lib/rsc/errorBoundaries.js +90 -0
  186. package/dist/production/lib/rsc/html-stream/browser.d.ts +48 -0
  187. package/dist/production/lib/rsc/html-stream/browser.js +74 -0
  188. package/dist/production/lib/rsc/html-stream/server.js +78 -0
  189. package/dist/production/lib/rsc/route-modules.js +27 -0
  190. package/dist/production/lib/rsc/server.rsc.d.ts +219 -0
  191. package/dist/production/lib/rsc/server.ssr.d.ts +129 -0
  192. package/dist/production/lib/rsc/server.ssr.js +388 -0
  193. package/dist/production/lib/server-runtime/build.d.ts +66 -0
  194. package/dist/production/lib/server-runtime/cookies.d.ts +66 -0
  195. package/dist/production/lib/server-runtime/cookies.js +139 -0
  196. package/dist/production/lib/server-runtime/crypto.js +43 -0
  197. package/dist/production/lib/server-runtime/data.d.ts +13 -0
  198. package/dist/production/lib/server-runtime/data.js +25 -0
  199. package/dist/production/lib/server-runtime/dev.d.ts +9 -0
  200. package/dist/production/lib/server-runtime/dev.js +26 -0
  201. package/dist/production/lib/server-runtime/entry.js +20 -0
  202. package/dist/production/lib/server-runtime/errors.js +95 -0
  203. package/dist/production/lib/server-runtime/headers.js +73 -0
  204. package/dist/production/lib/server-runtime/invariant.js +19 -0
  205. package/dist/production/lib/server-runtime/mode.d.ts +12 -0
  206. package/dist/production/lib/server-runtime/mode.js +25 -0
  207. package/dist/production/lib/server-runtime/routeMatching.js +28 -0
  208. package/dist/production/lib/server-runtime/routes.d.ts +13 -0
  209. package/dist/production/lib/server-runtime/routes.js +74 -0
  210. package/dist/production/lib/server-runtime/server.d.ts +10 -0
  211. package/dist/production/lib/server-runtime/server.js +351 -0
  212. package/dist/production/lib/server-runtime/serverHandoff.js +17 -0
  213. package/dist/production/lib/server-runtime/sessions/cookieStorage.d.ts +25 -0
  214. package/dist/production/lib/server-runtime/sessions/cookieStorage.js +45 -0
  215. package/dist/production/lib/server-runtime/sessions/memoryStorage.d.ts +23 -0
  216. package/dist/production/lib/server-runtime/sessions/memoryStorage.js +52 -0
  217. package/dist/production/lib/server-runtime/sessions.d.ts +145 -0
  218. package/dist/production/lib/server-runtime/sessions.js +98 -0
  219. package/dist/production/lib/server-runtime/single-fetch.d.ts +7 -0
  220. package/dist/production/lib/server-runtime/single-fetch.js +215 -0
  221. package/dist/production/lib/server-runtime/urls.js +31 -0
  222. package/dist/production/lib/server-runtime/warnings.js +20 -0
  223. package/dist/production/lib/types/future.d.ts +9 -0
  224. package/dist/production/lib/types/internal.d.ts +26 -177
  225. package/dist/production/lib/types/internal.js +3 -2
  226. package/dist/{development/register-CNAx3TXj.d.ts → production/lib/types/register.d.ts} +9 -15
  227. package/dist/production/lib/types/route-data.d.ts +113 -0
  228. package/dist/production/lib/types/route-module-annotations.d.ts +149 -0
  229. package/dist/production/lib/types/route-module.d.ts +19 -0
  230. package/dist/production/lib/types/serializes-to.d.ts +13 -0
  231. package/dist/production/lib/types/utils.d.ts +11 -0
  232. package/dist/production/vendor/turbo-stream-v2/flatten.js +159 -0
  233. package/dist/production/vendor/turbo-stream-v2/turbo-stream.js +178 -0
  234. package/dist/production/vendor/turbo-stream-v2/unflatten.js +198 -0
  235. package/dist/production/vendor/turbo-stream-v2/utils.js +47 -0
  236. package/docs/explanation/backend-for-frontend.md +50 -0
  237. package/docs/explanation/code-splitting.md +77 -0
  238. package/docs/explanation/concurrency.md +135 -0
  239. package/docs/explanation/form-vs-fetcher.md +292 -0
  240. package/docs/explanation/hot-module-replacement.md +137 -0
  241. package/docs/explanation/hydration.md +14 -0
  242. package/docs/explanation/index-query-param.md +86 -0
  243. package/docs/explanation/index.md +4 -0
  244. package/docs/explanation/lazy-route-discovery.md +78 -0
  245. package/docs/explanation/location.md +6 -0
  246. package/docs/explanation/progressive-enhancement.md +150 -0
  247. package/docs/explanation/race-conditions.md +88 -0
  248. package/docs/explanation/react-transitions.md +160 -0
  249. package/docs/explanation/route-matching.md +7 -0
  250. package/docs/explanation/server-client-execution.md +4 -0
  251. package/docs/explanation/sessions-and-cookies.md +465 -0
  252. package/docs/explanation/special-files.md +16 -0
  253. package/docs/explanation/state-management.md +524 -0
  254. package/docs/explanation/styling.md +87 -0
  255. package/docs/explanation/type-safety.md +82 -0
  256. package/docs/how-to/accessibility.md +44 -0
  257. package/docs/how-to/client-data.md +199 -0
  258. package/docs/how-to/data-strategy.md +317 -0
  259. package/docs/how-to/error-boundary.md +231 -0
  260. package/docs/how-to/error-reporting.md +134 -0
  261. package/docs/how-to/fetchers.md +307 -0
  262. package/docs/how-to/file-route-conventions.md +410 -0
  263. package/docs/how-to/file-uploads.md +217 -0
  264. package/docs/how-to/form-validation.md +120 -0
  265. package/docs/how-to/headers.md +164 -0
  266. package/docs/how-to/index.md +4 -0
  267. package/docs/how-to/instrumentation.md +556 -0
  268. package/docs/how-to/meta.md +40 -0
  269. package/docs/how-to/middleware.md +728 -0
  270. package/docs/how-to/navigation-blocking.md +233 -0
  271. package/docs/how-to/optimize-revalidation.md +12 -0
  272. package/docs/how-to/pre-rendering.md +225 -0
  273. package/docs/how-to/presets.md +103 -0
  274. package/docs/how-to/react-server-components.md +899 -0
  275. package/docs/how-to/resource-routes.md +126 -0
  276. package/docs/how-to/route-module-type-safety.md +100 -0
  277. package/docs/how-to/search-params.md +4 -0
  278. package/docs/how-to/security.md +30 -0
  279. package/docs/how-to/server-bundles.md +66 -0
  280. package/docs/how-to/spa.md +120 -0
  281. package/docs/how-to/status.md +63 -0
  282. package/docs/how-to/suspense.md +132 -0
  283. package/docs/how-to/using-handle.md +117 -0
  284. package/docs/how-to/view-transitions.md +237 -0
  285. package/docs/how-to/webhook.md +50 -0
  286. package/docs/index.md +39 -0
  287. package/docs/start/data/actions.md +138 -0
  288. package/docs/start/data/custom.md +198 -0
  289. package/docs/start/data/data-loading.md +44 -0
  290. package/docs/start/data/index.md +4 -0
  291. package/docs/start/data/installation.md +52 -0
  292. package/docs/start/data/navigating.md +12 -0
  293. package/docs/start/data/pending-ui.md +12 -0
  294. package/docs/start/data/route-object.md +248 -0
  295. package/docs/start/data/routing.md +281 -0
  296. package/docs/start/data/testing.md +8 -0
  297. package/docs/start/declarative/index.md +4 -0
  298. package/docs/start/declarative/installation.md +43 -0
  299. package/docs/start/declarative/navigating.md +133 -0
  300. package/docs/start/declarative/routing.md +237 -0
  301. package/docs/start/declarative/url-values.md +65 -0
  302. package/docs/start/framework/actions.md +175 -0
  303. package/docs/start/framework/data-loading.md +201 -0
  304. package/docs/start/framework/deploying.md +96 -0
  305. package/docs/start/framework/index.md +4 -0
  306. package/docs/start/framework/installation.md +42 -0
  307. package/docs/start/framework/navigating.md +182 -0
  308. package/docs/start/framework/pending-ui.md +142 -0
  309. package/docs/start/framework/rendering.md +59 -0
  310. package/docs/start/framework/route-module.md +527 -0
  311. package/docs/start/framework/routing.md +362 -0
  312. package/docs/start/framework/testing.md +133 -0
  313. package/docs/start/index.md +4 -0
  314. package/docs/start/modes.md +201 -0
  315. package/docs/upgrading/component-routes.md +363 -0
  316. package/docs/upgrading/future.md +31 -0
  317. package/docs/upgrading/index.md +4 -0
  318. package/docs/upgrading/remix.md +403 -0
  319. package/docs/upgrading/router-provider.md +442 -0
  320. package/docs/upgrading/v6.md +379 -0
  321. package/package.json +44 -87
  322. package/dist/development/browser-D3uq9sI1.d.ts +0 -318
  323. package/dist/development/browser-nIQ4Nsyi.d.mts +0 -318
  324. package/dist/development/chunk-IBI7OMNB.js +0 -1363
  325. package/dist/development/chunk-QUQL4437.mjs +0 -11529
  326. package/dist/development/chunk-S54KXAEJ.mjs +0 -2585
  327. package/dist/development/chunk-SRID2YZ2.js +0 -10229
  328. package/dist/development/chunk-XEJDWL2B.js +0 -188
  329. package/dist/development/context-m8rizgnE.d.mts +0 -1771
  330. package/dist/development/data-D4xhSy90.d.ts +0 -1732
  331. package/dist/development/data-U8FS-wNn.d.mts +0 -1732
  332. package/dist/development/dom-export.d.mts +0 -172
  333. package/dist/development/dom-export.mjs +0 -1008
  334. package/dist/development/index-react-server-client-BLiUx67a.d.ts +0 -3655
  335. package/dist/development/index-react-server-client-CdKROblb.d.mts +0 -2600
  336. package/dist/development/index-react-server-client.d.mts +0 -4
  337. package/dist/development/index-react-server-client.mjs +0 -59
  338. package/dist/development/index-react-server.d.mts +0 -2703
  339. package/dist/development/index-react-server.mjs +0 -3780
  340. package/dist/development/index.d.mts +0 -1478
  341. package/dist/development/index.mjs +0 -277
  342. package/dist/development/instrumentation-1q4YhLGP.d.ts +0 -715
  343. package/dist/development/lib/types/internal.d.mts +0 -184
  344. package/dist/development/lib/types/internal.mjs +0 -10
  345. package/dist/development/register-CqK96Zfk.d.mts +0 -30
  346. package/dist/production/browser-D3uq9sI1.d.ts +0 -318
  347. package/dist/production/browser-nIQ4Nsyi.d.mts +0 -318
  348. package/dist/production/chunk-EAQNHM3N.js +0 -188
  349. package/dist/production/chunk-NALGHHKE.mjs +0 -2585
  350. package/dist/production/chunk-Q65P7S7Y.mjs +0 -11529
  351. package/dist/production/chunk-SKEDDLRM.js +0 -1363
  352. package/dist/production/chunk-Y7DNFQZP.js +0 -10229
  353. package/dist/production/context-m8rizgnE.d.mts +0 -1771
  354. package/dist/production/data-D4xhSy90.d.ts +0 -1732
  355. package/dist/production/data-U8FS-wNn.d.mts +0 -1732
  356. package/dist/production/dom-export.d.mts +0 -172
  357. package/dist/production/dom-export.mjs +0 -1008
  358. package/dist/production/index-react-server-client-BLiUx67a.d.ts +0 -3655
  359. package/dist/production/index-react-server-client-CdKROblb.d.mts +0 -2600
  360. package/dist/production/index-react-server-client.d.mts +0 -4
  361. package/dist/production/index-react-server-client.mjs +0 -59
  362. package/dist/production/index-react-server.d.mts +0 -2703
  363. package/dist/production/index-react-server.mjs +0 -3780
  364. package/dist/production/index.d.mts +0 -1478
  365. package/dist/production/index.mjs +0 -277
  366. package/dist/production/instrumentation-1q4YhLGP.d.ts +0 -715
  367. package/dist/production/lib/types/internal.d.mts +0 -184
  368. package/dist/production/lib/types/internal.mjs +0 -10
  369. package/dist/production/register-CqK96Zfk.d.mts +0 -30
@@ -1,1478 +0,0 @@
1
- import { Z as RouteModules, z as DataStrategyFunction, p as MiddlewareEnabled, c as RouterContextProvider, q as AppLoadContext, T as To, L as Location, P as Params, U as UIMatch, v as Action, _ as SerializeFrom, $ as PathPattern, a0 as PathMatch, a1 as ParamParseKey, K as Path, r as RouteObject, G as GetLoaderData, l as GetActionData, O as InitialEntry, W as IndexRouteObject, d as LoaderFunction, A as ActionFunction, M as MetaFunction, b as LinksFunction, Q as NonIndexRouteObject, a2 as Equal, B as PatchRoutesOnNavigationFunction, E as DataRouteObject, a as ClientLoaderFunction } from './data-U8FS-wNn.mjs';
2
- export { a3 as ActionFunctionArgs, a4 as BaseRouteObject, C as ClientActionFunction, as as ClientActionFunctionArgs, at as ClientLoaderFunctionArgs, w as DataRouteMatch, a5 as DataStrategyFunctionArgs, a6 as DataStrategyMatch, D as DataStrategyResult, a8 as ErrorResponse, n as FormEncType, a9 as FormMethod, ay as Future, m as HTMLFormMethod, au as HeadersArgs, H as HeadersFunction, ax as HtmlLinkDescriptor, V as LazyRouteFunction, e as LinkDescriptor, o as LoaderFunctionArgs, av as MetaArgs, g as MetaDescriptor, aa as MiddlewareFunction, aw as PageLinkDescriptor, ab as PatchRoutesOnNavigationFunctionArgs, ac as PathParam, ad as RedirectFunction, X as RouteMatch, ae as RouterContext, S as ShouldRevalidateFunction, af as ShouldRevalidateFunctionArgs, a7 as UNSAFE_DataWithResponseInit, aE as UNSAFE_ErrorResponseImpl, aB as UNSAFE_createBrowserHistory, aC as UNSAFE_createHashHistory, aA as UNSAFE_createMemoryHistory, aD as UNSAFE_invariant, ag as createContext, ah as createPath, aj as data, ak as generatePath, al as isRouteErrorResponse, am as matchPath, an as matchRoutes, ai as parsePath, ao as redirect, ap as redirectDocument, aq as replace, ar as resolvePath, az as unstable_SerializesTo } from './data-U8FS-wNn.mjs';
3
- import { c as Router, N as NavigateOptions, d as NavigationStates, B as BlockerFunction, e as Blocker, f as RelativeRoutingType, H as HydrationState, g as RouterState } from './context-m8rizgnE.mjs';
4
- export { K as Await, w as AwaitProps, C as ClientInstrumentation, b as ClientOnErrorFunction, F as Fetcher, G as GetScrollPositionFunction, h as GetScrollRestorationKeyFunction, u as IDLE_BLOCKER, t as IDLE_FETCHER, s as IDLE_NAVIGATION, x as IndexRouteProps, I as InstrumentRequestHandlerFunction, q as InstrumentRouteFunction, p as InstrumentRouterFunction, r as InstrumentationHandlerResult, L as LayoutRouteProps, Q as MemoryRouter, M as MemoryRouterOpts, y as MemoryRouterProps, T as Navigate, z as NavigateProps, j as Navigation, v as Navigator, U as Outlet, O as OutletProps, P as PathRouteProps, n as RevalidationState, V as Route, D as RouteProps, W as Router, m as RouterFetchOptions, R as RouterInit, l as RouterNavigateOptions, E as RouterProps, X as RouterProvider, a as RouterProviderProps, k as RouterSubscriber, Y as Routes, J as RoutesProps, o as ServerInstrumentation, S as StaticHandler, i as StaticHandlerContext, A as UNSAFE_AwaitContextProvider, a2 as UNSAFE_DataRouterContext, a3 as UNSAFE_DataRouterStateContext, a4 as UNSAFE_FetchersContext, a5 as UNSAFE_LocationContext, a6 as UNSAFE_NavigationContext, a7 as UNSAFE_RouteContext, a8 as UNSAFE_ViewTransitionContext, ab as UNSAFE_WithComponentProps, af as UNSAFE_WithErrorBoundaryProps, ad as UNSAFE_WithHydrateFallbackProps, a1 as UNSAFE_createRouter, a9 as UNSAFE_hydrationRouteProperties, aa as UNSAFE_mapRouteProperties, ac as UNSAFE_withComponentProps, ag as UNSAFE_withErrorBoundaryProps, ae as UNSAFE_withHydrateFallbackProps, Z as createMemoryRouter, _ as createRoutesFromChildren, $ as createRoutesFromElements, a0 as renderMatches } from './context-m8rizgnE.mjs';
5
- import * as React from 'react';
6
- import React__default, { ReactElement } from 'react';
7
- import { a as RouteModules$1, P as Pages } from './register-CqK96Zfk.mjs';
8
- export { b as Register } from './register-CqK96Zfk.mjs';
9
- import { A as AssetsManifest, S as ServerBuild, E as EntryContext, F as FutureConfig } from './index-react-server-client-CdKROblb.mjs';
10
- export { l as BrowserRouter, B as BrowserRouterProps, D as DOMRouterOpts, a1 as DiscoverBehavior, c as FetcherFormProps, h as FetcherSubmitFunction, G as FetcherSubmitOptions, i as FetcherWithComponents, q as Form, d as FormProps, a2 as HandleDataRequestFunction, a3 as HandleDocumentRequestFunction, a4 as HandleErrorFunction, m as HashRouter, H as HashRouterProps, a as HistoryRouterProps, n as Link, L as LinkProps, X as Links, _ as LinksProps, W as Meta, p as NavLink, N as NavLinkProps, b as NavLinkRenderProps, P as ParamKeyValuePair, a0 as PrefetchBehavior, Z as PrefetchPageLinks, Y as Scripts, $ as ScriptsProps, r as ScrollRestoration, e as ScrollRestorationProps, a5 as ServerEntryModule, f as SetURLSearchParams, T as StaticRouter, M as StaticRouterProps, V as StaticRouterProvider, O as StaticRouterProviderProps, g as SubmitFunction, I as SubmitOptions, J as SubmitTarget, a6 as UNSAFE_FrameworkContext, a7 as UNSAFE_createClientRoutes, a8 as UNSAFE_createClientRoutesWithHMRRevalidationOptOut, a9 as UNSAFE_shouldHydrateRouteLoader, aa as UNSAFE_useScrollRestoration, U as URLSearchParamsInit, j as createBrowserRouter, k as createHashRouter, K as createSearchParams, Q as createStaticHandler, R as createStaticRouter, o as unstable_HistoryRouter, z as unstable_usePrompt, y as useBeforeUnload, w as useFetcher, x as useFetchers, v as useFormAction, u as useLinkClickHandler, s as useSearchParams, t as useSubmit, C as useViewTransitionState } from './index-react-server-client-CdKROblb.mjs';
11
- import { ParseOptions, SerializeOptions } from 'cookie';
12
- export { ParseOptions as CookieParseOptions, SerializeOptions as CookieSerializeOptions } from 'cookie';
13
- import { e as RSCPayload, g as getRequest, m as matchRSCServerRequest } from './browser-nIQ4Nsyi.mjs';
14
- export { B as unstable_BrowserCreateFromReadableStreamFunction, D as unstable_DecodeActionFunction, a as unstable_DecodeFormStateFunction, b as unstable_DecodeReplyFunction, E as unstable_EncodeReplyFunction, L as unstable_LoadServerActionFunction, h as unstable_RSCHydratedRouterProps, d as unstable_RSCManifestPayload, i as unstable_RSCMatch, f as unstable_RSCRenderPayload, n as unstable_RSCRouteConfig, l as unstable_RSCRouteConfigEntry, j as unstable_RSCRouteManifest, k as unstable_RSCRouteMatch } from './browser-nIQ4Nsyi.mjs';
15
-
16
- declare const SingleFetchRedirectSymbol: unique symbol;
17
- declare function getTurboStreamSingleFetchDataStrategy(getRouter: () => Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, basename: string | undefined, trailingSlashAware: boolean): DataStrategyFunction;
18
- declare function decodeViaTurboStream(body: ReadableStream<Uint8Array>, global: Window | typeof globalThis): Promise<{
19
- done: Promise<undefined>;
20
- value: unknown;
21
- }>;
22
-
23
- /**
24
- * The mode to use when running the server.
25
- */
26
- declare enum ServerMode {
27
- Development = "development",
28
- Production = "production",
29
- Test = "test"
30
- }
31
-
32
- type RequestHandler = (request: Request, loadContext?: MiddlewareEnabled extends true ? RouterContextProvider : AppLoadContext) => Promise<Response>;
33
- type CreateRequestHandlerFunction = (build: ServerBuild | (() => ServerBuild | Promise<ServerBuild>), mode?: string) => RequestHandler;
34
- declare const createRequestHandler: CreateRequestHandlerFunction;
35
-
36
- /**
37
- * Resolves a URL against the current {@link Location}.
38
- *
39
- * @example
40
- * import { useHref } from "react-router";
41
- *
42
- * function SomeComponent() {
43
- * let href = useHref("some/where");
44
- * // "/resolved/some/where"
45
- * }
46
- *
47
- * @public
48
- * @category Hooks
49
- * @param to The path to resolve
50
- * @param options Options
51
- * @param options.relative Defaults to `"route"` so routing is relative to the
52
- * route tree.
53
- * Set to `"path"` to make relative routing operate against path segments.
54
- * @returns The resolved href string
55
- */
56
- declare function useHref(to: To, { relative }?: {
57
- relative?: RelativeRoutingType;
58
- }): string;
59
- /**
60
- * Returns `true` if this component is a descendant of a {@link Router}, useful
61
- * to ensure a component is used within a {@link Router}.
62
- *
63
- * @public
64
- * @category Hooks
65
- * @mode framework
66
- * @mode data
67
- * @returns Whether the component is within a {@link Router} context
68
- */
69
- declare function useInRouterContext(): boolean;
70
- /**
71
- * Returns the current {@link Location}. This can be useful if you'd like to
72
- * perform some side effect whenever it changes.
73
- *
74
- * @example
75
- * import * as React from 'react'
76
- * import { useLocation } from 'react-router'
77
- *
78
- * function SomeComponent() {
79
- * let location = useLocation()
80
- *
81
- * React.useEffect(() => {
82
- * // Google Analytics
83
- * ga('send', 'pageview')
84
- * }, [location]);
85
- *
86
- * return (
87
- * // ...
88
- * );
89
- * }
90
- *
91
- * @public
92
- * @category Hooks
93
- * @returns The current {@link Location} object
94
- */
95
- declare function useLocation(): Location;
96
- /**
97
- * Returns the current {@link Navigation} action which describes how the router
98
- * came to the current {@link Location}, either by a pop, push, or replace on
99
- * the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack.
100
- *
101
- * @public
102
- * @category Hooks
103
- * @returns The current {@link NavigationType} (`"POP"`, `"PUSH"`, or `"REPLACE"`)
104
- */
105
- declare function useNavigationType(): Action;
106
- /**
107
- * Returns a {@link PathMatch} object if the given pattern matches the current URL.
108
- * This is useful for components that need to know "active" state, e.g.
109
- * {@link NavLink | `<NavLink>`}.
110
- *
111
- * @public
112
- * @category Hooks
113
- * @param pattern The pattern to match against the current {@link Location}
114
- * @returns The path match object if the pattern matches, `null` otherwise
115
- */
116
- declare function useMatch<Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamParseKey<Path>> | null;
117
- /**
118
- * The interface for the `navigate` function returned from {@link useNavigate}.
119
- */
120
- interface NavigateFunction {
121
- (to: To, options?: NavigateOptions): void | Promise<void>;
122
- (delta: number): void | Promise<void>;
123
- }
124
- /**
125
- * Returns a function that lets you navigate programmatically in the browser in
126
- * response to user interactions or effects.
127
- *
128
- * It's often better to use {@link redirect} in [`action`](../../start/framework/route-module#action)/[`loader`](../../start/framework/route-module#loader)
129
- * functions than this hook.
130
- *
131
- * The returned function signature is `navigate(to, options?)`/`navigate(delta)` where:
132
- *
133
- * * `to` can be a string path, a {@link To} object, or a number (delta)
134
- * * `options` contains options for modifying the navigation
135
- * * These options work in all modes (Framework, Data, and Declarative):
136
- * * `relative`: `"route"` or `"path"` to control relative routing logic
137
- * * `replace`: Replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack
138
- * * `state`: Optional [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) to include with the new {@link Location}
139
- * * These options only work in Framework and Data modes:
140
- * * `flushSync`: Wrap the DOM updates in [`ReactDom.flushSync`](https://react.dev/reference/react-dom/flushSync)
141
- * * `preventScrollReset`: Do not scroll back to the top of the page after navigation
142
- * * `viewTransition`: Enable [`document.startViewTransition`](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for this navigation
143
- *
144
- * @example
145
- * import { useNavigate } from "react-router";
146
- *
147
- * function SomeComponent() {
148
- * let navigate = useNavigate();
149
- * return (
150
- * <button onClick={() => navigate(-1)}>
151
- * Go Back
152
- * </button>
153
- * );
154
- * }
155
- *
156
- * @additionalExamples
157
- * ### Navigate to another path
158
- *
159
- * ```tsx
160
- * navigate("/some/route");
161
- * navigate("/some/route?search=param");
162
- * ```
163
- *
164
- * ### Navigate with a {@link To} object
165
- *
166
- * All properties are optional.
167
- *
168
- * ```tsx
169
- * navigate({
170
- * pathname: "/some/route",
171
- * search: "?search=param",
172
- * hash: "#hash",
173
- * state: { some: "state" },
174
- * });
175
- * ```
176
- *
177
- * If you use `state`, that will be available on the {@link Location} object on
178
- * the next page. Access it with `useLocation().state` (see {@link useLocation}).
179
- *
180
- * ### Navigate back or forward in the history stack
181
- *
182
- * ```tsx
183
- * // back
184
- * // often used to close modals
185
- * navigate(-1);
186
- *
187
- * // forward
188
- * // often used in a multistep wizard workflows
189
- * navigate(1);
190
- * ```
191
- *
192
- * Be cautious with `navigate(number)`. If your application can load up to a
193
- * route that has a button that tries to navigate forward/back, there may not be
194
- * a [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
195
- * entry to go back or forward to, or it can go somewhere you don't expect
196
- * (like a different domain).
197
- *
198
- * Only use this if you're sure they will have an entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
199
- * stack to navigate to.
200
- *
201
- * ### Replace the current entry in the history stack
202
- *
203
- * This will remove the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
204
- * stack, replacing it with a new one, similar to a server side redirect.
205
- *
206
- * ```tsx
207
- * navigate("/some/route", { replace: true });
208
- * ```
209
- *
210
- * ### Prevent Scroll Reset
211
- *
212
- * [MODES: framework, data]
213
- *
214
- * <br/>
215
- * <br/>
216
- *
217
- * To prevent {@link ScrollRestoration | `<ScrollRestoration>`} from resetting
218
- * the scroll position, use the `preventScrollReset` option.
219
- *
220
- * ```tsx
221
- * navigate("?some-tab=1", { preventScrollReset: true });
222
- * ```
223
- *
224
- * For example, if you have a tab interface connected to search params in the
225
- * middle of a page, and you don't want it to scroll to the top when a tab is
226
- * clicked.
227
- *
228
- * ### Return Type Augmentation
229
- *
230
- * Internally, `useNavigate` uses a separate implementation when you are in
231
- * Declarative mode versus Data/Framework mode - the primary difference being
232
- * that the latter is able to return a stable reference that does not change
233
- * identity across navigations. The implementation in Data/Framework mode also
234
- * returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
235
- * that resolves when the navigation is completed. This means the return type of
236
- * `useNavigate` is `void | Promise<void>`. This is accurate, but can lead to
237
- * some red squigglies based on the union in the return value:
238
- *
239
- * - If you're using `typescript-eslint`, you may see errors from
240
- * [`@typescript-eslint/no-floating-promises`](https://typescript-eslint.io/rules/no-floating-promises)
241
- * - In Framework/Data mode, `React.use(navigate())` will show a false-positive
242
- * `Argument of type 'void | Promise<void>' is not assignable to parameter of
243
- * type 'Usable<void>'` error
244
- *
245
- * The easiest way to work around these issues is to augment the type based on the
246
- * router you're using:
247
- *
248
- * ```ts
249
- * // If using <BrowserRouter>
250
- * declare module "react-router" {
251
- * interface NavigateFunction {
252
- * (to: To, options?: NavigateOptions): void;
253
- * (delta: number): void;
254
- * }
255
- * }
256
- *
257
- * // If using <RouterProvider> or Framework mode
258
- * declare module "react-router" {
259
- * interface NavigateFunction {
260
- * (to: To, options?: NavigateOptions): Promise<void>;
261
- * (delta: number): Promise<void>;
262
- * }
263
- * }
264
- * ```
265
- *
266
- * @public
267
- * @category Hooks
268
- * @returns A navigate function for programmatic navigation
269
- */
270
- declare function useNavigate(): NavigateFunction;
271
- /**
272
- * Returns the parent route {@link Outlet | `<Outlet context>`}.
273
- *
274
- * Often parent routes manage state or other values you want shared with child
275
- * routes. You can create your own [context provider](https://react.dev/learn/passing-data-deeply-with-context)
276
- * if you like, but this is such a common situation that it's built-into
277
- * {@link Outlet | `<Outlet>`}.
278
- *
279
- * ```tsx
280
- * // Parent route
281
- * function Parent() {
282
- * const [count, setCount] = React.useState(0);
283
- * return <Outlet context={[count, setCount]} />;
284
- * }
285
- * ```
286
- *
287
- * ```tsx
288
- * // Child route
289
- * import { useOutletContext } from "react-router";
290
- *
291
- * function Child() {
292
- * const [count, setCount] = useOutletContext();
293
- * const increment = () => setCount((c) => c + 1);
294
- * return <button onClick={increment}>{count}</button>;
295
- * }
296
- * ```
297
- *
298
- * If you're using TypeScript, we recommend the parent component provide a
299
- * custom hook for accessing the context value. This makes it easier for
300
- * consumers to get nice typings, control consumers, and know who's consuming
301
- * the context value.
302
- *
303
- * Here's a more realistic example:
304
- *
305
- * ```tsx filename=src/routes/dashboard.tsx lines=[14,20]
306
- * import { useState } from "react";
307
- * import { Outlet, useOutletContext } from "react-router";
308
- *
309
- * import type { User } from "./types";
310
- *
311
- * type ContextType = { user: User | null };
312
- *
313
- * export default function Dashboard() {
314
- * const [user, setUser] = useState<User | null>(null);
315
- *
316
- * return (
317
- * <div>
318
- * <h1>Dashboard</h1>
319
- * <Outlet context={{ user } satisfies ContextType} />
320
- * </div>
321
- * );
322
- * }
323
- *
324
- * export function useUser() {
325
- * return useOutletContext<ContextType>();
326
- * }
327
- * ```
328
- *
329
- * ```tsx filename=src/routes/dashboard/messages.tsx lines=[1,4]
330
- * import { useUser } from "../dashboard";
331
- *
332
- * export default function DashboardMessages() {
333
- * const { user } = useUser();
334
- * return (
335
- * <div>
336
- * <h2>Messages</h2>
337
- * <p>Hello, {user.name}!</p>
338
- * </div>
339
- * );
340
- * }
341
- * ```
342
- *
343
- * @public
344
- * @category Hooks
345
- * @returns The context value passed to the parent {@link Outlet} component
346
- */
347
- declare function useOutletContext<Context = unknown>(): Context;
348
- /**
349
- * Returns the element for the child route at this level of the route
350
- * hierarchy. Used internally by {@link Outlet | `<Outlet>`} to render child
351
- * routes.
352
- *
353
- * @public
354
- * @category Hooks
355
- * @param context The context to pass to the outlet
356
- * @returns The child route element or `null` if no child routes match
357
- */
358
- declare function useOutlet(context?: unknown): React.ReactElement | null;
359
- /**
360
- * Returns an object of key/value-pairs of the dynamic params from the current
361
- * URL that were matched by the routes. Child routes inherit all params from
362
- * their parent routes.
363
- *
364
- * Assuming a route pattern like `/posts/:postId` is matched by `/posts/123`
365
- * then `params.postId` will be `"123"`.
366
- *
367
- * @example
368
- * import { useParams } from "react-router";
369
- *
370
- * function SomeComponent() {
371
- * let params = useParams();
372
- * params.postId;
373
- * }
374
- *
375
- * @additionalExamples
376
- * ### Basic Usage
377
- *
378
- * ```tsx
379
- * import { useParams } from "react-router";
380
- *
381
- * // given a route like:
382
- * <Route path="/posts/:postId" element={<Post />} />;
383
- *
384
- * // or a data route like:
385
- * createBrowserRouter([
386
- * {
387
- * path: "/posts/:postId",
388
- * component: Post,
389
- * },
390
- * ]);
391
- *
392
- * // or in routes.ts
393
- * route("/posts/:postId", "routes/post.tsx");
394
- * ```
395
- *
396
- * Access the params in a component:
397
- *
398
- * ```tsx
399
- * import { useParams } from "react-router";
400
- *
401
- * export default function Post() {
402
- * let params = useParams();
403
- * return <h1>Post: {params.postId}</h1>;
404
- * }
405
- * ```
406
- *
407
- * ### Multiple Params
408
- *
409
- * Patterns can have multiple params:
410
- *
411
- * ```tsx
412
- * "/posts/:postId/comments/:commentId";
413
- * ```
414
- *
415
- * All will be available in the params object:
416
- *
417
- * ```tsx
418
- * import { useParams } from "react-router";
419
- *
420
- * export default function Post() {
421
- * let params = useParams();
422
- * return (
423
- * <h1>
424
- * Post: {params.postId}, Comment: {params.commentId}
425
- * </h1>
426
- * );
427
- * }
428
- * ```
429
- *
430
- * ### Catchall Params
431
- *
432
- * Catchall params are defined with `*`:
433
- *
434
- * ```tsx
435
- * "/files/*";
436
- * ```
437
- *
438
- * The matched value will be available in the params object as follows:
439
- *
440
- * ```tsx
441
- * import { useParams } from "react-router";
442
- *
443
- * export default function File() {
444
- * let params = useParams();
445
- * let catchall = params["*"];
446
- * // ...
447
- * }
448
- * ```
449
- *
450
- * You can destructure the catchall param:
451
- *
452
- * ```tsx
453
- * export default function File() {
454
- * let { "*": catchall } = useParams();
455
- * console.log(catchall);
456
- * }
457
- * ```
458
- *
459
- * @public
460
- * @category Hooks
461
- * @returns An object containing the dynamic route parameters
462
- */
463
- declare function useParams<ParamsOrKey extends string | Record<string, string | undefined> = string>(): Readonly<[
464
- ParamsOrKey
465
- ] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>;
466
- /**
467
- * Resolves the pathname of the given `to` value against the current
468
- * {@link Location}. Similar to {@link useHref}, but returns a
469
- * {@link Path} instead of a string.
470
- *
471
- * @example
472
- * import { useResolvedPath } from "react-router";
473
- *
474
- * function SomeComponent() {
475
- * // if the user is at /dashboard/profile
476
- * let path = useResolvedPath("../accounts");
477
- * path.pathname; // "/dashboard/accounts"
478
- * path.search; // ""
479
- * path.hash; // ""
480
- * }
481
- *
482
- * @public
483
- * @category Hooks
484
- * @param to The path to resolve
485
- * @param options Options
486
- * @param options.relative Defaults to `"route"` so routing is relative to the route tree.
487
- * Set to `"path"` to make relative routing operate against path segments.
488
- * @returns The resolved {@link Path} object with `pathname`, `search`, and `hash`
489
- */
490
- declare function useResolvedPath(to: To, { relative }?: {
491
- relative?: RelativeRoutingType;
492
- }): Path;
493
- /**
494
- * Hook version of {@link Routes | `<Routes>`} that uses objects instead of
495
- * components. These objects have the same properties as the component props.
496
- * The return value of `useRoutes` is either a valid React element you can use
497
- * to render the route tree, or `null` if nothing matched.
498
- *
499
- * @example
500
- * import { useRoutes } from "react-router";
501
- *
502
- * function App() {
503
- * let element = useRoutes([
504
- * {
505
- * path: "/",
506
- * element: <Dashboard />,
507
- * children: [
508
- * {
509
- * path: "messages",
510
- * element: <DashboardMessages />,
511
- * },
512
- * { path: "tasks", element: <DashboardTasks /> },
513
- * ],
514
- * },
515
- * { path: "team", element: <AboutPage /> },
516
- * ]);
517
- *
518
- * return element;
519
- * }
520
- *
521
- * @public
522
- * @category Hooks
523
- * @param routes An array of {@link RouteObject}s that define the route hierarchy
524
- * @param locationArg An optional {@link Location} object or pathname string to
525
- * use instead of the current {@link Location}
526
- * @returns A React element to render the matched route, or `null` if no routes matched
527
- */
528
- declare function useRoutes(routes: RouteObject[], locationArg?: Partial<Location> | string): React.ReactElement | null;
529
- type UseNavigationResult = UseNavigationResultStates[keyof UseNavigationResultStates];
530
- type UseNavigationResultStates = {
531
- Idle: Omit<NavigationStates["Idle"], "matches" | "historyAction">;
532
- Loading: Omit<NavigationStates["Loading"], "matches" | "historyAction">;
533
- Submitting: Omit<NavigationStates["Submitting"], "matches" | "historyAction">;
534
- };
535
- /**
536
- * Returns the current {@link Navigation}, defaulting to an "idle" navigation
537
- * when no navigation is in progress. You can use this to render pending UI
538
- * (like a global spinner) or read [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
539
- * from a form navigation.
540
- *
541
- * @example
542
- * import { useNavigation } from "react-router";
543
- *
544
- * function SomeComponent() {
545
- * let navigation = useNavigation();
546
- * navigation.state;
547
- * navigation.formData;
548
- * // etc.
549
- * }
550
- *
551
- * @public
552
- * @category Hooks
553
- * @mode framework
554
- * @mode data
555
- * @returns The current {@link Navigation} object
556
- */
557
- declare function useNavigation(): UseNavigationResult;
558
- /**
559
- * Revalidate the data on the page for reasons outside of normal data mutations
560
- * like [`Window` focus](https://developer.mozilla.org/en-US/docs/Web/API/Window/focus_event)
561
- * or polling on an interval.
562
- *
563
- * Note that page data is already revalidated automatically after actions.
564
- * If you find yourself using this for normal CRUD operations on your data in
565
- * response to user interactions, you're probably not taking advantage of the
566
- * other APIs like {@link useFetcher}, {@link Form}, {@link useSubmit} that do
567
- * this automatically.
568
- *
569
- * @example
570
- * import { useRevalidator } from "react-router";
571
- *
572
- * function WindowFocusRevalidator() {
573
- * const revalidator = useRevalidator();
574
- *
575
- * useFakeWindowFocus(() => {
576
- * revalidator.revalidate();
577
- * });
578
- *
579
- * return (
580
- * <div hidden={revalidator.state === "idle"}>
581
- * Revalidating...
582
- * </div>
583
- * );
584
- * }
585
- *
586
- * @public
587
- * @category Hooks
588
- * @mode framework
589
- * @mode data
590
- * @returns An object with a `revalidate` function and the current revalidation
591
- * `state`
592
- */
593
- declare function useRevalidator(): {
594
- revalidate: () => Promise<void>;
595
- state: Router["state"]["revalidation"];
596
- };
597
- /**
598
- * Returns the active route matches, useful for accessing `loaderData` for
599
- * parent/child routes or the route [`handle`](../../start/framework/route-module#handle)
600
- * property
601
- *
602
- * @public
603
- * @category Hooks
604
- * @mode framework
605
- * @mode data
606
- * @returns An array of {@link UIMatch | UI matches} for the current route hierarchy
607
- */
608
- declare function useMatches(): UIMatch[];
609
- /**
610
- * Returns the data from the closest route
611
- * [`loader`](../../start/framework/route-module#loader) or
612
- * [`clientLoader`](../../start/framework/route-module#clientloader).
613
- *
614
- * @example
615
- * import { useLoaderData } from "react-router";
616
- *
617
- * export async function loader() {
618
- * return await fakeDb.invoices.findAll();
619
- * }
620
- *
621
- * export default function Invoices() {
622
- * let invoices = useLoaderData<typeof loader>();
623
- * // ...
624
- * }
625
- *
626
- * @public
627
- * @category Hooks
628
- * @mode framework
629
- * @mode data
630
- * @returns The data returned from the route's [`loader`](../../start/framework/route-module#loader) or [`clientLoader`](../../start/framework/route-module#clientloader) function
631
- */
632
- declare function useLoaderData<T = any>(): SerializeFrom<T>;
633
- /**
634
- * Returns the [`loader`](../../start/framework/route-module#loader) data for a
635
- * given route by route ID.
636
- *
637
- * Route IDs are created automatically. They are simply the path of the route file
638
- * relative to the app folder without the extension.
639
- *
640
- * | Route Filename | Route ID |
641
- * | ---------------------------- | ---------------------- |
642
- * | `app/root.tsx` | `"root"` |
643
- * | `app/routes/teams.tsx` | `"routes/teams"` |
644
- * | `app/whatever/teams.$id.tsx` | `"whatever/teams.$id"` |
645
- *
646
- * @example
647
- * import { useRouteLoaderData } from "react-router";
648
- *
649
- * function SomeComponent() {
650
- * const { user } = useRouteLoaderData("root");
651
- * }
652
- *
653
- * // You can also specify your own route ID's manually in your routes.ts file:
654
- * route("/", "containers/app.tsx", { id: "app" })
655
- * useRouteLoaderData("app");
656
- *
657
- * @public
658
- * @category Hooks
659
- * @mode framework
660
- * @mode data
661
- * @param routeId The ID of the route to return loader data from
662
- * @returns The data returned from the specified route's [`loader`](../../start/framework/route-module#loader)
663
- * function, or `undefined` if not found
664
- */
665
- declare function useRouteLoaderData<T = any>(routeId: string): SerializeFrom<T> | undefined;
666
- /**
667
- * Returns the [`action`](../../start/framework/route-module#action) data from
668
- * the most recent `POST` navigation form submission or `undefined` if there
669
- * hasn't been one.
670
- *
671
- * @example
672
- * import { Form, useActionData } from "react-router";
673
- *
674
- * export async function action({ request }) {
675
- * const body = await request.formData();
676
- * const name = body.get("visitorsName");
677
- * return { message: `Hello, ${name}` };
678
- * }
679
- *
680
- * export default function Invoices() {
681
- * const data = useActionData();
682
- * return (
683
- * <Form method="post">
684
- * <input type="text" name="visitorsName" />
685
- * {data ? data.message : "Waiting..."}
686
- * </Form>
687
- * );
688
- * }
689
- *
690
- * @public
691
- * @category Hooks
692
- * @mode framework
693
- * @mode data
694
- * @returns The data returned from the route's [`action`](../../start/framework/route-module#action)
695
- * function, or `undefined` if no [`action`](../../start/framework/route-module#action)
696
- * has been called
697
- */
698
- declare function useActionData<T = any>(): SerializeFrom<T> | undefined;
699
- /**
700
- * Accesses the error thrown during an
701
- * [`action`](../../start/framework/route-module#action),
702
- * [`loader`](../../start/framework/route-module#loader),
703
- * or component render to be used in a route module
704
- * [`ErrorBoundary`](../../start/framework/route-module#errorboundary).
705
- *
706
- * @example
707
- * export function ErrorBoundary() {
708
- * const error = useRouteError();
709
- * return <div>{error.message}</div>;
710
- * }
711
- *
712
- * @public
713
- * @category Hooks
714
- * @mode framework
715
- * @mode data
716
- * @returns The error that was thrown during route [loading](../../start/framework/route-module#loader),
717
- * [`action`](../../start/framework/route-module#action) execution, or rendering
718
- */
719
- declare function useRouteError(): unknown;
720
- /**
721
- * Returns the resolved promise value from the closest {@link Await | `<Await>`}.
722
- *
723
- * @example
724
- * function SomeDescendant() {
725
- * const value = useAsyncValue();
726
- * // ...
727
- * }
728
- *
729
- * // somewhere in your app
730
- * <Await resolve={somePromise}>
731
- * <SomeDescendant />
732
- * </Await>;
733
- *
734
- * @public
735
- * @category Hooks
736
- * @mode framework
737
- * @mode data
738
- * @returns The resolved value from the nearest {@link Await} component
739
- */
740
- declare function useAsyncValue(): unknown;
741
- /**
742
- * Returns the rejection value from the closest {@link Await | `<Await>`}.
743
- *
744
- * @example
745
- * import { Await, useAsyncError } from "react-router";
746
- *
747
- * function ErrorElement() {
748
- * const error = useAsyncError();
749
- * return (
750
- * <p>Uh Oh, something went wrong! {error.message}</p>
751
- * );
752
- * }
753
- *
754
- * // somewhere in your app
755
- * <Await
756
- * resolve={promiseThatRejects}
757
- * errorElement={<ErrorElement />}
758
- * />;
759
- *
760
- * @public
761
- * @category Hooks
762
- * @mode framework
763
- * @mode data
764
- * @returns The error that was thrown in the nearest {@link Await} component
765
- */
766
- declare function useAsyncError(): unknown;
767
- /**
768
- * Allow the application to block navigations within the SPA and present the
769
- * user a confirmation dialog to confirm the navigation. Mostly used to avoid
770
- * using half-filled form data. This does not handle hard-reloads or
771
- * cross-origin navigations.
772
- *
773
- * The {@link Blocker} object returned by the hook has the following properties:
774
- *
775
- * - **`state`**
776
- * - `unblocked` - the blocker is idle and has not prevented any navigation
777
- * - `blocked` - the blocker has prevented a navigation
778
- * - `proceeding` - the blocker is proceeding through from a blocked navigation
779
- * - **`location`**
780
- * - When in a `blocked` state, this represents the {@link Location} to which
781
- * we blocked a navigation. When in a `proceeding` state, this is the
782
- * location being navigated to after a `blocker.proceed()` call.
783
- * - **`proceed()`**
784
- * - When in a `blocked` state, you may call `blocker.proceed()` to proceed to
785
- * the blocked location.
786
- * - **`reset()`**
787
- * - When in a `blocked` state, you may call `blocker.reset()` to return the
788
- * blocker to an `unblocked` state and leave the user at the current
789
- * location.
790
- *
791
- * @example
792
- * // Boolean version
793
- * let blocker = useBlocker(value !== "");
794
- *
795
- * // Function version
796
- * let blocker = useBlocker(
797
- * ({ currentLocation, nextLocation, historyAction }) =>
798
- * value !== "" &&
799
- * currentLocation.pathname !== nextLocation.pathname
800
- * );
801
- *
802
- * @additionalExamples
803
- * ```tsx
804
- * import { useCallback, useState } from "react";
805
- * import { BlockerFunction, useBlocker } from "react-router";
806
- *
807
- * export function ImportantForm() {
808
- * const [value, setValue] = useState("");
809
- *
810
- * const shouldBlock = useCallback<BlockerFunction>(
811
- * () => value !== "",
812
- * [value]
813
- * );
814
- * const blocker = useBlocker(shouldBlock);
815
- *
816
- * return (
817
- * <form
818
- * onSubmit={(e) => {
819
- * e.preventDefault();
820
- * setValue("");
821
- * if (blocker.state === "blocked") {
822
- * blocker.proceed();
823
- * }
824
- * }}
825
- * >
826
- * <input
827
- * name="data"
828
- * value={value}
829
- * onChange={(e) => setValue(e.target.value)}
830
- * />
831
- *
832
- * <button type="submit">Save</button>
833
- *
834
- * {blocker.state === "blocked" ? (
835
- * <>
836
- * <p style={{ color: "red" }}>
837
- * Blocked the last navigation to
838
- * </p>
839
- * <button
840
- * type="button"
841
- * onClick={() => blocker.proceed()}
842
- * >
843
- * Let me through
844
- * </button>
845
- * <button
846
- * type="button"
847
- * onClick={() => blocker.reset()}
848
- * >
849
- * Keep me here
850
- * </button>
851
- * </>
852
- * ) : blocker.state === "proceeding" ? (
853
- * <p style={{ color: "orange" }}>
854
- * Proceeding through blocked navigation
855
- * </p>
856
- * ) : (
857
- * <p style={{ color: "green" }}>
858
- * Blocker is currently unblocked
859
- * </p>
860
- * )}
861
- * </form>
862
- * );
863
- * }
864
- * ```
865
- *
866
- * @public
867
- * @category Hooks
868
- * @mode framework
869
- * @mode data
870
- * @param shouldBlock Either a boolean or a function returning a boolean which
871
- * indicates whether the navigation should be blocked. The function format
872
- * receives a single object parameter containing the `currentLocation`,
873
- * `nextLocation`, and `historyAction` of the potential navigation.
874
- * @returns A {@link Blocker} object with state and reset functionality
875
- */
876
- declare function useBlocker(shouldBlock: boolean | BlockerFunction): Blocker;
877
- type UseRouteArgs = [] | [routeId: keyof RouteModules$1];
878
- type UseRouteResult<Args extends UseRouteArgs> = Args extends [] ? UseRoute<unknown> : Args extends ["root"] ? UseRoute<"root"> : Args extends [infer RouteId extends keyof RouteModules$1] ? UseRoute<RouteId> | undefined : never;
879
- type UseRoute<RouteId extends keyof RouteModules$1 | unknown> = {
880
- handle: RouteId extends keyof RouteModules$1 ? RouteModules$1[RouteId] extends {
881
- handle: infer handle;
882
- } ? handle : unknown : unknown;
883
- loaderData: RouteId extends keyof RouteModules$1 ? GetLoaderData<RouteModules$1[RouteId]> | undefined : unknown;
884
- actionData: RouteId extends keyof RouteModules$1 ? GetActionData<RouteModules$1[RouteId]> | undefined : unknown;
885
- };
886
- declare function useRoute<Args extends UseRouteArgs>(...args: Args): UseRouteResult<Args>;
887
- /**
888
- * A single route match returned from {@link unstable_useRouterState}. Mirrors
889
- * {@link UIMatch} minus the data-related fields (`data`, `loaderData`).
890
- */
891
- type unstable_RouterStateMatch<Handle = unknown> = Omit<UIMatch<unknown, Handle>, "data" | "loaderData">;
892
- /**
893
- * The shape of the `active` variant returned from
894
- * {@link unstable_useRouterState}.
895
- */
896
- type unstable_RouterStateActiveVariant = {
897
- location: Location;
898
- searchParams: URLSearchParams;
899
- params: Params;
900
- matches: unstable_RouterStateMatch[];
901
- type: Action;
902
- };
903
- /**
904
- * The shape of the `pending` variant returned from
905
- * {@link unstable_useRouterState}. Extends
906
- * {@link unstable_RouterStateActiveVariant} with the navigation `state` and
907
- * submission fields mirroring {@link useNavigation} — submission fields are
908
- * populated when the in-flight navigation was triggered by a form submission,
909
- * otherwise `undefined`.
910
- */
911
- type unstable_RouterStatePendingVariant = unstable_RouterStatePendingVariants[keyof unstable_RouterStatePendingVariants];
912
- type unstable_RouterStatePendingVariants = {
913
- Loading: unstable_RouterStateActiveVariant & Omit<NavigationStates["Loading"], "matches" | "historyAction">;
914
- Submitting: unstable_RouterStateActiveVariant & Omit<NavigationStates["Submitting"], "matches" | "historyAction">;
915
- };
916
- /**
917
- * The return shape of {@link unstable_useRouterState}.
918
- *
919
- * `active` reflects the currently-committed location. `pending` reflects the
920
- * in-flight navigation (if any).
921
- */
922
- type unstable_RouterState = {
923
- active: unstable_RouterStateActiveVariant;
924
- pending: unstable_RouterStatePendingVariant | null;
925
- };
926
- /**
927
- * A unified hook for reading router state: current (`active`) and in-flight
928
- * (`pending`) locations, search params, params, matches, and navigation type.
929
- *
930
- * This hook consolidates the information you used to get from {@link useLocation},
931
- * {@link useSearchParams}, {@link useParams}, {@link useMatches}, {@link useNavigation},
932
- * and {@link useNavigationType} into a single hook.
933
- *
934
- *
935
- * @example
936
- * import { unstable_useRouterState as useRouterState } from "react-router";
937
- *
938
- * let { active, pending } = unstable_useRouterState();
939
- *
940
- * // Active is always populated with the current location
941
- * active.location; // replaces `useLocation()`
942
- * active.searchParams; // replaces `useSearchParams()[0]`
943
- * active.params; // replaces `useParams()`
944
- * active.matches; // replaces `useMatches()`
945
- * active.type; // replaces `useNavigationType()`
946
- *
947
- * // Pending is only populated during a navigation
948
- * pending.location; // replaces `useNavigation().location`
949
- * pending.searchParams; // equivalent to `new URLSearchParams(useNavigation().search)`
950
- * pending.params; // Not directly accessible today
951
- * pending.matches; // Not directly accessible today
952
- * pending.type; // Not directly accessible today
953
- * pending.state; // replaces `useNavigation().state`
954
- * pending.formMethod; // replaces useNavigation().formMethod
955
- * pending.formAction; // replaces useNavigation().formAction
956
- * pending.formEncType; // replaces useNavigation().formEncType
957
- * pending.formData; // replaces useNavigation().formData
958
- * pending.json; // replaces useNavigation().json
959
- * pending.text; // replaces useNavigation().text
960
- *
961
- * @name unstable_useRouterState
962
- * @public
963
- * @category Hooks
964
- * @mode framework
965
- * @mode data
966
- * @returns The current router state with `active` and `pending` variants
967
- */
968
- declare function useRouterState(): unstable_RouterState;
969
-
970
- /**
971
- * @category Types
972
- */
973
- interface ServerRouterProps {
974
- /**
975
- * The entry context containing the manifest, route modules, and other data
976
- * needed for rendering.
977
- */
978
- context: EntryContext;
979
- /**
980
- * The URL of the request being handled.
981
- */
982
- url: string | URL;
983
- /**
984
- * An optional `nonce` for [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP)
985
- * compliance, used to allow inline scripts to run safely.
986
- */
987
- nonce?: string;
988
- }
989
- /**
990
- * The server entry point for a React Router app in Framework Mode. This
991
- * component is used to generate the HTML in the response from the server. See
992
- * [`entry.server.tsx`](../framework-conventions/entry.server.tsx).
993
- *
994
- * @public
995
- * @category Framework Routers
996
- * @mode framework
997
- * @param props Props
998
- * @param {ServerRouterProps.context} props.context n/a
999
- * @param {ServerRouterProps.nonce} props.nonce n/a
1000
- * @param {ServerRouterProps.url} props.url n/a
1001
- * @returns A React element that represents the server-rendered application.
1002
- */
1003
- declare function ServerRouter({ context, url, nonce, }: ServerRouterProps): ReactElement;
1004
-
1005
- interface StubRouteExtensions {
1006
- Component?: React.ComponentType<any>;
1007
- HydrateFallback?: React.ComponentType<any>;
1008
- ErrorBoundary?: React.ComponentType<any>;
1009
- loader?: LoaderFunction;
1010
- action?: ActionFunction;
1011
- children?: StubRouteObject[];
1012
- meta?: MetaFunction;
1013
- links?: LinksFunction;
1014
- }
1015
- interface StubIndexRouteObject extends Omit<IndexRouteObject, "Component" | "HydrateFallback" | "ErrorBoundary" | "loader" | "action" | "element" | "errorElement" | "children">, StubRouteExtensions {
1016
- }
1017
- interface StubNonIndexRouteObject extends Omit<NonIndexRouteObject, "Component" | "HydrateFallback" | "ErrorBoundary" | "loader" | "action" | "element" | "errorElement" | "children">, StubRouteExtensions {
1018
- }
1019
- type StubRouteObject = StubIndexRouteObject | StubNonIndexRouteObject;
1020
- interface RoutesTestStubProps {
1021
- /**
1022
- * The initial entries in the history stack. This allows you to start a test with
1023
- * multiple locations already in the history stack (for testing a back navigation, etc.)
1024
- * The test will default to the last entry in initialEntries if no initialIndex is provided.
1025
- * e.g. initialEntries={["/home", "/about", "/contact"]}
1026
- */
1027
- initialEntries?: InitialEntry[];
1028
- /**
1029
- * The initial index in the history stack to render. This allows you to start a test at a specific entry.
1030
- * It defaults to the last entry in initialEntries.
1031
- * e.g.
1032
- * initialEntries: ["/", "/events/123"]
1033
- * initialIndex: 1 // start at "/events/123"
1034
- */
1035
- initialIndex?: number;
1036
- /**
1037
- * Used to set the route's initial loader and action data.
1038
- * e.g. hydrationData={{
1039
- * loaderData: { "/contact": { locale: "en-US" } },
1040
- * actionData: { "/login": { errors: { email: "invalid email" } }}
1041
- * }}
1042
- */
1043
- hydrationData?: HydrationState;
1044
- /**
1045
- * Future flags mimicking the settings in react-router.config.ts
1046
- */
1047
- future?: Partial<FutureConfig>;
1048
- }
1049
- /**
1050
- * @category Utils
1051
- */
1052
- declare function createRoutesStub(routes: StubRouteObject[], _context?: AppLoadContext | RouterContextProvider): ({ initialEntries, initialIndex, hydrationData, future, }: RoutesTestStubProps) => React.JSX.Element;
1053
-
1054
- interface CookieSignatureOptions {
1055
- /**
1056
- * An array of secrets that may be used to sign/unsign the value of a cookie.
1057
- *
1058
- * The array makes it easy to rotate secrets. New secrets should be added to
1059
- * the beginning of the array. `cookie.serialize()` will always use the first
1060
- * value in the array, but `cookie.parse()` may use any of them so that
1061
- * cookies that were signed with older secrets still work.
1062
- */
1063
- secrets?: string[];
1064
- }
1065
- type CookieOptions = ParseOptions & SerializeOptions & CookieSignatureOptions;
1066
- /**
1067
- * A HTTP cookie.
1068
- *
1069
- * A Cookie is a logical container for metadata about a HTTP cookie; its name
1070
- * and options. But it doesn't contain a value. Instead, it has `parse()` and
1071
- * `serialize()` methods that allow a single instance to be reused for
1072
- * parsing/encoding multiple different values.
1073
- *
1074
- * @see https://remix.run/utils/cookies#cookie-api
1075
- */
1076
- interface Cookie {
1077
- /**
1078
- * The name of the cookie, used in the `Cookie` and `Set-Cookie` headers.
1079
- */
1080
- readonly name: string;
1081
- /**
1082
- * True if this cookie uses one or more secrets for verification.
1083
- */
1084
- readonly isSigned: boolean;
1085
- /**
1086
- * The Date this cookie expires.
1087
- *
1088
- * Note: This is calculated at access time using `maxAge` when no `expires`
1089
- * option is provided to `createCookie()`.
1090
- */
1091
- readonly expires?: Date;
1092
- /**
1093
- * Parses a raw `Cookie` header and returns the value of this cookie or
1094
- * `null` if it's not present.
1095
- */
1096
- parse(cookieHeader: string | null, options?: ParseOptions): Promise<any>;
1097
- /**
1098
- * Serializes the given value to a string and returns the `Set-Cookie`
1099
- * header.
1100
- */
1101
- serialize(value: any, options?: SerializeOptions): Promise<string>;
1102
- }
1103
- /**
1104
- * Creates a logical container for managing a browser cookie from the server.
1105
- */
1106
- declare const createCookie: (name: string, cookieOptions?: CookieOptions) => Cookie;
1107
- type IsCookieFunction = (object: any) => object is Cookie;
1108
- /**
1109
- * Returns true if an object is a Remix cookie container.
1110
- *
1111
- * @see https://remix.run/utils/cookies#iscookie
1112
- */
1113
- declare const isCookie: IsCookieFunction;
1114
-
1115
- /**
1116
- * An object of name/value pairs to be used in the session.
1117
- */
1118
- interface SessionData {
1119
- [name: string]: any;
1120
- }
1121
- /**
1122
- * Session persists data across HTTP requests.
1123
- *
1124
- * @see https://reactrouter.com/explanation/sessions-and-cookies#sessions
1125
- */
1126
- interface Session<Data = SessionData, FlashData = Data> {
1127
- /**
1128
- * A unique identifier for this session.
1129
- *
1130
- * Note: This will be the empty string for newly created sessions and
1131
- * sessions that are not backed by a database (i.e. cookie-based sessions).
1132
- */
1133
- readonly id: string;
1134
- /**
1135
- * The raw data contained in this session.
1136
- *
1137
- * This is useful mostly for SessionStorage internally to access the raw
1138
- * session data to persist.
1139
- */
1140
- readonly data: FlashSessionData<Data, FlashData>;
1141
- /**
1142
- * Returns `true` if the session has a value for the given `name`, `false`
1143
- * otherwise.
1144
- */
1145
- has(name: (keyof Data | keyof FlashData) & string): boolean;
1146
- /**
1147
- * Returns the value for the given `name` in this session.
1148
- */
1149
- get<Key extends (keyof Data | keyof FlashData) & string>(name: Key): (Key extends keyof Data ? Data[Key] : undefined) | (Key extends keyof FlashData ? FlashData[Key] : undefined) | undefined;
1150
- /**
1151
- * Sets a value in the session for the given `name`.
1152
- */
1153
- set<Key extends keyof Data & string>(name: Key, value: Data[Key]): void;
1154
- /**
1155
- * Sets a value in the session that is only valid until the next `get()`.
1156
- * This can be useful for temporary values, like error messages.
1157
- */
1158
- flash<Key extends keyof FlashData & string>(name: Key, value: FlashData[Key]): void;
1159
- /**
1160
- * Removes a value from the session.
1161
- */
1162
- unset(name: keyof Data & string): void;
1163
- }
1164
- type FlashSessionData<Data, FlashData> = Partial<Data & {
1165
- [Key in keyof FlashData as FlashDataKey<Key & string>]: FlashData[Key];
1166
- }>;
1167
- type FlashDataKey<Key extends string> = `__flash_${Key}__`;
1168
- type CreateSessionFunction = <Data = SessionData, FlashData = Data>(initialData?: Data, id?: string) => Session<Data, FlashData>;
1169
- /**
1170
- * Creates a new Session object.
1171
- *
1172
- * Note: This function is typically not invoked directly by application code.
1173
- * Instead, use a `SessionStorage` object's `getSession` method.
1174
- */
1175
- declare const createSession: CreateSessionFunction;
1176
- type IsSessionFunction = (object: any) => object is Session;
1177
- /**
1178
- * Returns true if an object is a React Router session.
1179
- *
1180
- * @see https://reactrouter.com/api/utils/isSession
1181
- */
1182
- declare const isSession: IsSessionFunction;
1183
- /**
1184
- * SessionStorage stores session data between HTTP requests and knows how to
1185
- * parse and create cookies.
1186
- *
1187
- * A SessionStorage creates Session objects using a `Cookie` header as input.
1188
- * Then, later it generates the `Set-Cookie` header to be used in the response.
1189
- */
1190
- interface SessionStorage<Data = SessionData, FlashData = Data> {
1191
- /**
1192
- * Parses a Cookie header from a HTTP request and returns the associated
1193
- * Session. If there is no session associated with the cookie, this will
1194
- * return a new Session with no data.
1195
- */
1196
- getSession: (cookieHeader?: string | null, options?: ParseOptions) => Promise<Session<Data, FlashData>>;
1197
- /**
1198
- * Stores all data in the Session and returns the Set-Cookie header to be
1199
- * used in the HTTP response.
1200
- */
1201
- commitSession: (session: Session<Data, FlashData>, options?: SerializeOptions) => Promise<string>;
1202
- /**
1203
- * Deletes all data associated with the Session and returns the Set-Cookie
1204
- * header to be used in the HTTP response.
1205
- */
1206
- destroySession: (session: Session<Data, FlashData>, options?: SerializeOptions) => Promise<string>;
1207
- }
1208
- /**
1209
- * SessionIdStorageStrategy is designed to allow anyone to easily build their
1210
- * own SessionStorage using `createSessionStorage(strategy)`.
1211
- *
1212
- * This strategy describes a common scenario where the session id is stored in
1213
- * a cookie but the actual session data is stored elsewhere, usually in a
1214
- * database or on disk. A set of create, read, update, and delete operations
1215
- * are provided for managing the session data.
1216
- */
1217
- interface SessionIdStorageStrategy<Data = SessionData, FlashData = Data> {
1218
- /**
1219
- * The Cookie used to store the session id, or options used to automatically
1220
- * create one.
1221
- */
1222
- cookie?: Cookie | (CookieOptions & {
1223
- name?: string;
1224
- });
1225
- /**
1226
- * Creates a new record with the given data and returns the session id.
1227
- */
1228
- createData: (data: FlashSessionData<Data, FlashData>, expires?: Date) => Promise<string>;
1229
- /**
1230
- * Returns data for a given session id, or `null` if there isn't any.
1231
- */
1232
- readData: (id: string) => Promise<FlashSessionData<Data, FlashData> | null>;
1233
- /**
1234
- * Updates data for the given session id.
1235
- */
1236
- updateData: (id: string, data: FlashSessionData<Data, FlashData>, expires?: Date) => Promise<void>;
1237
- /**
1238
- * Deletes data for a given session id from the data store.
1239
- */
1240
- deleteData: (id: string) => Promise<void>;
1241
- }
1242
- /**
1243
- * Creates a SessionStorage object using a SessionIdStorageStrategy.
1244
- *
1245
- * Note: This is a low-level API that should only be used if none of the
1246
- * existing session storage options meet your requirements.
1247
- */
1248
- declare function createSessionStorage<Data = SessionData, FlashData = Data>({ cookie: cookieArg, createData, readData, updateData, deleteData, }: SessionIdStorageStrategy<Data, FlashData>): SessionStorage<Data, FlashData>;
1249
-
1250
- interface CookieSessionStorageOptions {
1251
- /**
1252
- * The Cookie used to store the session data on the client, or options used
1253
- * to automatically create one.
1254
- */
1255
- cookie?: SessionIdStorageStrategy["cookie"];
1256
- }
1257
- /**
1258
- * Creates and returns a SessionStorage object that stores all session data
1259
- * directly in the session cookie itself.
1260
- *
1261
- * This has the advantage that no database or other backend services are
1262
- * needed, and can help to simplify some load-balanced scenarios. However, it
1263
- * also has the limitation that serialized session data may not exceed the
1264
- * browser's maximum cookie size. Trade-offs!
1265
- */
1266
- declare function createCookieSessionStorage<Data = SessionData, FlashData = Data>({ cookie: cookieArg }?: CookieSessionStorageOptions): SessionStorage<Data, FlashData>;
1267
-
1268
- interface MemorySessionStorageOptions {
1269
- /**
1270
- * The Cookie used to store the session id on the client, or options used
1271
- * to automatically create one.
1272
- */
1273
- cookie?: SessionIdStorageStrategy["cookie"];
1274
- }
1275
- /**
1276
- * Creates and returns a simple in-memory SessionStorage object, mostly useful
1277
- * for testing and as a reference implementation.
1278
- *
1279
- * Note: This storage does not scale beyond a single process, so it is not
1280
- * suitable for most production scenarios.
1281
- */
1282
- declare function createMemorySessionStorage<Data = SessionData, FlashData = Data>({ cookie }?: MemorySessionStorageOptions): SessionStorage<Data, FlashData>;
1283
-
1284
- type DevServerHooks = {
1285
- getCriticalCss?: (pathname: string) => Promise<string | undefined>;
1286
- processRequestError?: (error: unknown) => void;
1287
- };
1288
- declare function setDevServerHooks(devServerHooks: DevServerHooks): void;
1289
-
1290
- type Args = {
1291
- [K in keyof Pages]: ToArgs<Pages[K]["params"]>;
1292
- };
1293
- type ToArgs<Params extends Record<string, string | undefined>> = Equal<Params, {}> extends true ? [] : Partial<Params> extends Params ? [Params] | [] : [
1294
- Params
1295
- ];
1296
- /**
1297
- Returns a resolved URL path for the specified route.
1298
-
1299
- ```tsx
1300
- const h = href("/:lang?/about", { lang: "en" })
1301
- // -> `/en/about`
1302
-
1303
- <Link to={href("/products/:id", { id: "abc123" })} />
1304
- ```
1305
- */
1306
- declare function href<Path extends keyof Args>(path: Path, ...args: Args[Path]): string;
1307
-
1308
- type DecodedPayload = Promise<RSCPayload> & {
1309
- _deepestRenderedBoundaryId?: string | null;
1310
- formState: Promise<any>;
1311
- };
1312
- type SSRCreateFromReadableStreamFunction = (body: ReadableStream<Uint8Array>) => Promise<unknown>;
1313
- /**
1314
- * Routes the incoming [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
1315
- * to the [RSC](https://react.dev/reference/rsc/server-components) server and
1316
- * appropriately proxies the server response for data / resource requests, or
1317
- * renders to HTML for a document request.
1318
- *
1319
- * @example
1320
- * import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
1321
- * import * as ReactDomServer from "react-dom/server.edge";
1322
- * import {
1323
- * unstable_RSCStaticRouter as RSCStaticRouter,
1324
- * unstable_routeRSCServerRequest as routeRSCServerRequest,
1325
- * } from "react-router";
1326
- *
1327
- * routeRSCServerRequest({
1328
- * request,
1329
- * serverResponse,
1330
- * createFromReadableStream,
1331
- * async renderHTML(getPayload) {
1332
- * const payload = getPayload();
1333
- *
1334
- * return await renderHTMLToReadableStream(
1335
- * <RSCStaticRouter getPayload={getPayload} />,
1336
- * {
1337
- * bootstrapScriptContent,
1338
- * formState: await payload.formState,
1339
- * }
1340
- * );
1341
- * },
1342
- * });
1343
- *
1344
- * @name unstable_routeRSCServerRequest
1345
- * @public
1346
- * @category RSC
1347
- * @mode data
1348
- * @param opts Options
1349
- * @param opts.createFromReadableStream Your `react-server-dom-xyz/client`'s
1350
- * `createFromReadableStream` function, used to decode payloads from the server.
1351
- * @param opts.serverResponse A Response or partial response generated by the [RSC](https://react.dev/reference/rsc/server-components) handler containing a serialized {@link unstable_RSCPayload}.
1352
- * @param opts.hydrate Whether to hydrate the server response with the RSC payload.
1353
- * Defaults to `true`.
1354
- * @param opts.renderHTML A function that renders the {@link unstable_RSCPayload} to
1355
- * HTML, usually using a {@link unstable_RSCStaticRouter | `<RSCStaticRouter>`}.
1356
- * @param opts.request The request to route.
1357
- * @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
1358
- * that either contains the [RSC](https://react.dev/reference/rsc/server-components)
1359
- * payload for data requests, or renders the HTML for document requests.
1360
- */
1361
- declare function routeRSCServerRequest({ request, serverResponse, createFromReadableStream, renderHTML, hydrate, }: {
1362
- request: Request;
1363
- serverResponse: Response;
1364
- createFromReadableStream: SSRCreateFromReadableStreamFunction;
1365
- renderHTML: (getPayload: () => DecodedPayload, options: {
1366
- onError(error: unknown): string | undefined;
1367
- onHeaders(headers: Headers): void;
1368
- }) => ReadableStream<Uint8Array> | Promise<ReadableStream<Uint8Array>>;
1369
- hydrate?: boolean;
1370
- }): Promise<Response>;
1371
- /**
1372
- * Props for the {@link unstable_RSCStaticRouter} component.
1373
- *
1374
- * @name unstable_RSCStaticRouterProps
1375
- * @category Types
1376
- */
1377
- interface RSCStaticRouterProps {
1378
- /**
1379
- * A function that starts decoding of the {@link unstable_RSCPayload}. Usually passed
1380
- * through from {@link unstable_routeRSCServerRequest}'s `renderHTML`.
1381
- */
1382
- getPayload: () => DecodedPayload;
1383
- }
1384
- /**
1385
- * Pre-renders an {@link unstable_RSCPayload} to HTML. Usually used in
1386
- * {@link unstable_routeRSCServerRequest}'s `renderHTML` callback.
1387
- *
1388
- * @example
1389
- * import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
1390
- * import * as ReactDomServer from "react-dom/server.edge";
1391
- * import {
1392
- * unstable_RSCStaticRouter as RSCStaticRouter,
1393
- * unstable_routeRSCServerRequest as routeRSCServerRequest,
1394
- * } from "react-router";
1395
- *
1396
- * routeRSCServerRequest({
1397
- * request,
1398
- * serverResponse,
1399
- * createFromReadableStream,
1400
- * async renderHTML(getPayload) {
1401
- * const payload = getPayload();
1402
- *
1403
- * return await renderHTMLToReadableStream(
1404
- * <RSCStaticRouter getPayload={getPayload} />,
1405
- * {
1406
- * bootstrapScriptContent,
1407
- * formState: await payload.formState,
1408
- * }
1409
- * );
1410
- * },
1411
- * });
1412
- *
1413
- * @name unstable_RSCStaticRouter
1414
- * @public
1415
- * @category RSC
1416
- * @mode data
1417
- * @param props Props
1418
- * @param {unstable_RSCStaticRouterProps.getPayload} props.getPayload n/a
1419
- * @returns A React component that renders the {@link unstable_RSCPayload} as HTML.
1420
- */
1421
- declare function RSCStaticRouter({ getPayload }: RSCStaticRouterProps): React.JSX.Element | null;
1422
-
1423
- declare function RSCDefaultRootErrorBoundary({ hasRootLayout, }: {
1424
- hasRootLayout: boolean;
1425
- }): React__default.JSX.Element;
1426
-
1427
- declare function deserializeErrors(errors: RouterState["errors"]): RouterState["errors"];
1428
-
1429
- type RemixErrorBoundaryProps = React.PropsWithChildren<{
1430
- location: Location;
1431
- isOutsideRemixApp?: boolean;
1432
- error?: Error;
1433
- }>;
1434
- type RemixErrorBoundaryState = {
1435
- error: null | Error;
1436
- location: Location;
1437
- };
1438
- declare class RemixErrorBoundary extends React.Component<RemixErrorBoundaryProps, RemixErrorBoundaryState> {
1439
- constructor(props: RemixErrorBoundaryProps);
1440
- static getDerivedStateFromError(error: Error): {
1441
- error: Error;
1442
- };
1443
- static getDerivedStateFromProps(props: RemixErrorBoundaryProps, state: RemixErrorBoundaryState): {
1444
- error: Error | null;
1445
- location: Location<any>;
1446
- };
1447
- render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
1448
- }
1449
-
1450
- declare function getPatchRoutesOnNavigationFunction(getRouter: () => Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean, basename: string | undefined): PatchRoutesOnNavigationFunction | undefined;
1451
- declare function useFogOFWarDiscovery(router: Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean): void;
1452
-
1453
- declare function getHydrationData({ state, routes, getRouteInfo, location, basename, isSpaMode, }: {
1454
- state: {
1455
- loaderData?: Router["state"]["loaderData"];
1456
- actionData?: Router["state"]["actionData"];
1457
- errors?: Router["state"]["errors"];
1458
- };
1459
- routes: DataRouteObject[];
1460
- getRouteInfo: (routeId: string) => {
1461
- clientLoader: ClientLoaderFunction | undefined;
1462
- hasLoader: boolean;
1463
- hasHydrateFallback: boolean;
1464
- };
1465
- location: Path;
1466
- basename: string | undefined;
1467
- isSpaMode: boolean;
1468
- }): HydrationState;
1469
-
1470
- /**
1471
- * @module index
1472
- * @mergeModuleWith react-router
1473
- */
1474
-
1475
- declare const unstable_getRequest: typeof getRequest;
1476
- declare const unstable_matchRSCServerRequest: typeof matchRSCServerRequest;
1477
-
1478
- export { ActionFunction, AppLoadContext, Blocker, BlockerFunction, ClientLoaderFunction, type Cookie, type CookieOptions, type CookieSignatureOptions, type CreateRequestHandlerFunction, DataRouteObject, Router as DataRouter, DataStrategyFunction, EntryContext, type FlashSessionData, HydrationState, IndexRouteObject, InitialEntry, type IsCookieFunction, type IsSessionFunction, LinksFunction, LoaderFunction, Location, MetaFunction, type NavigateFunction, NavigateOptions, NavigationStates, Action as NavigationType, NonIndexRouteObject, ParamParseKey, Params, PatchRoutesOnNavigationFunction, Path, PathMatch, PathPattern, RelativeRoutingType, type RequestHandler, RouteObject, RouterContextProvider, RouterState, type RoutesTestStubProps, ServerBuild, ServerRouter, type ServerRouterProps, type Session, type SessionData, type SessionIdStorageStrategy, type SessionStorage, To, UIMatch, AssetsManifest as UNSAFE_AssetsManifest, MiddlewareEnabled as UNSAFE_MiddlewareEnabled, RSCDefaultRootErrorBoundary as UNSAFE_RSCDefaultRootErrorBoundary, RemixErrorBoundary as UNSAFE_RemixErrorBoundary, RouteModules as UNSAFE_RouteModules, ServerMode as UNSAFE_ServerMode, SingleFetchRedirectSymbol as UNSAFE_SingleFetchRedirectSymbol, decodeViaTurboStream as UNSAFE_decodeViaTurboStream, deserializeErrors as UNSAFE_deserializeErrors, getHydrationData as UNSAFE_getHydrationData, getPatchRoutesOnNavigationFunction as UNSAFE_getPatchRoutesOnNavigationFunction, getTurboStreamSingleFetchDataStrategy as UNSAFE_getTurboStreamSingleFetchDataStrategy, useFogOFWarDiscovery as UNSAFE_useFogOFWarDiscovery, createCookie, createCookieSessionStorage, createMemorySessionStorage, createRequestHandler, createRoutesStub, createSession, createSessionStorage, href, isCookie, isSession, RSCPayload as unstable_RSCPayload, RSCStaticRouter as unstable_RSCStaticRouter, type RSCStaticRouterProps as unstable_RSCStaticRouterProps, type unstable_RouterState, type unstable_RouterStateActiveVariant, type unstable_RouterStatePendingVariant, type SSRCreateFromReadableStreamFunction as unstable_SSRCreateFromReadableStreamFunction, unstable_getRequest, unstable_matchRSCServerRequest, routeRSCServerRequest as unstable_routeRSCServerRequest, setDevServerHooks as unstable_setDevServerHooks, useRoute as unstable_useRoute, useRouterState as unstable_useRouterState, useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes };