@rangojs/router 0.5.1 → 0.6.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 (609) hide show
  1. package/README.md +5 -1
  2. package/dist/bin/rango.js +343 -125
  3. package/dist/types/browser/event-controller.d.ts +6 -0
  4. package/dist/types/browser/react/use-router.d.ts +10 -3
  5. package/dist/types/browser/react/use-search-params.d.ts +57 -10
  6. package/dist/types/browser/types.d.ts +22 -0
  7. package/dist/types/build/merge-full-manifests.d.ts +3 -0
  8. package/dist/types/build/route-trie.d.ts +4 -73
  9. package/dist/types/build/route-types/per-module-writer.d.ts +6 -4
  10. package/dist/types/build/route-types/router-processing.d.ts +2 -3
  11. package/dist/types/cache/cache-exec-scope.d.ts +31 -0
  12. package/dist/types/cache/cf/cf-cache-constants.d.ts +8 -1
  13. package/dist/types/cache/cf/cf-cache-store.d.ts +15 -1
  14. package/dist/types/cache/cf/cf-cache-types.d.ts +1 -1
  15. package/dist/types/cache/cf/cf-kv-utils.d.ts +21 -0
  16. package/dist/types/cache/taint.d.ts +12 -6
  17. package/dist/types/client-urls/client-root.d.ts +38 -0
  18. package/dist/types/client-urls/client-urls.d.ts +5 -0
  19. package/dist/types/client-urls/navigation.d.ts +38 -0
  20. package/dist/types/client-urls/revalidation-protocol.d.ts +25 -0
  21. package/dist/types/client-urls/server-projection.d.ts +62 -0
  22. package/dist/types/client-urls/types.d.ts +144 -0
  23. package/dist/types/client.d.ts +12 -4
  24. package/dist/types/client.rsc.d.ts +4 -1
  25. package/dist/types/decode-loader-results.d.ts +37 -0
  26. package/dist/types/errors.d.ts +1 -0
  27. package/dist/types/handles/is-thenable.d.ts +2 -4
  28. package/dist/types/index.d.ts +1 -1
  29. package/dist/types/loader-redirect.d.ts +27 -0
  30. package/dist/types/outlet-context.d.ts +12 -0
  31. package/dist/types/outlet-provider.d.ts +3 -1
  32. package/dist/types/redirect-origin.d.ts +4 -0
  33. package/dist/types/route-content-wrapper.d.ts +42 -1
  34. package/dist/types/route-definition/helpers-types.d.ts +13 -2
  35. package/dist/types/router/error-handling.d.ts +35 -1
  36. package/dist/types/router/intercept-resolution.d.ts +12 -0
  37. package/dist/types/router/loader-resolution.d.ts +24 -2
  38. package/dist/types/router/revalidation.d.ts +7 -0
  39. package/dist/{types.backup/build/route-trie.d.ts → types/router/route-trie-builder.d.ts} +4 -16
  40. package/dist/types/router/router-interfaces.d.ts +20 -0
  41. package/dist/types/router/segment-resolution/helpers.d.ts +1 -1
  42. package/dist/types/router/trie-matching.d.ts +1 -1
  43. package/dist/types/rsc/helpers.d.ts +3 -0
  44. package/dist/types/rsc/manifest-init.d.ts +5 -5
  45. package/dist/types/rsc/render-pipeline.d.ts +9 -0
  46. package/dist/types/rsc/routine-plan.d.ts +124 -0
  47. package/dist/types/rsc/shell-capture-constants.d.ts +17 -0
  48. package/dist/types/rsc/shell-capture.d.ts +9 -0
  49. package/dist/types/rsc/shell-serve.d.ts +11 -0
  50. package/dist/types/rsc/types.d.ts +30 -0
  51. package/dist/types/segment-system.d.ts +2 -0
  52. package/dist/types/server/context.d.ts +10 -0
  53. package/dist/types/server/handle-store.d.ts +34 -3
  54. package/dist/types/server/request-context.d.ts +14 -1
  55. package/dist/types/server.d.ts +1 -0
  56. package/dist/types/ssr/index.d.ts +22 -0
  57. package/dist/types/ssr/ssr-root.d.ts +10 -0
  58. package/dist/types/testing/dom.entry.d.ts +1 -1
  59. package/dist/types/testing/render-route.d.ts +16 -6
  60. package/dist/types/testing/run-loader.d.ts +9 -0
  61. package/dist/types/types/boundaries.d.ts +22 -0
  62. package/dist/types/types/index.d.ts +1 -1
  63. package/dist/types/types/loader-types.d.ts +57 -5
  64. package/dist/types/types/segments.d.ts +7 -0
  65. package/dist/types/urls/path-helper-types.d.ts +10 -4
  66. package/dist/types/vite/discovery/client-urls-projection.d.ts +53 -0
  67. package/dist/types/vite/discovery/discover-routers.d.ts +1 -1
  68. package/dist/types/vite/discovery/state.d.ts +8 -1
  69. package/dist/types/vite/encryption-key.d.ts +2 -0
  70. package/dist/types/vite/plugins/expose-internal-ids.d.ts +10 -0
  71. package/dist/types/vite/plugins/server-ref-hashing.d.ts +24 -0
  72. package/dist/types/vite/plugins/server-reference-pattern.d.ts +1 -0
  73. package/dist/types/vite/utils/shared-utils.d.ts +12 -0
  74. package/dist/vite/index.js +5101 -2056
  75. package/package.json +3 -3
  76. package/skills/breadcrumbs/SKILL.md +39 -9
  77. package/skills/caching/SKILL.md +1 -1
  78. package/skills/catalog.json +7 -1
  79. package/skills/client-urls/SKILL.md +338 -0
  80. package/skills/comparison/references/framework-comparison.md +23 -9
  81. package/skills/hooks/SKILL.md +2 -2
  82. package/skills/hooks/data.md +11 -2
  83. package/skills/hooks/handle-and-actions.md +7 -0
  84. package/skills/hooks/outlets.md +26 -5
  85. package/skills/hooks/urls.md +40 -3
  86. package/skills/loader/SKILL.md +132 -20
  87. package/skills/migrate-nextjs/SKILL.md +70 -10
  88. package/skills/migrate-react-router/SKILL.md +49 -13
  89. package/skills/migrate-react-router/component-migration.md +18 -13
  90. package/skills/migrate-react-router/data-and-actions.md +14 -3
  91. package/skills/migrate-react-router/route-mapping.md +15 -2
  92. package/skills/mime-routes/SKILL.md +3 -1
  93. package/skills/parallel/SKILL.md +32 -1
  94. package/skills/ppr/SKILL.md +16 -6
  95. package/skills/prerender/SKILL.md +8 -4
  96. package/skills/rango/SKILL.md +21 -17
  97. package/skills/react-compiler/SKILL.md +3 -3
  98. package/skills/response-routes/SKILL.md +4 -2
  99. package/skills/route/SKILL.md +5 -2
  100. package/skills/router-setup/SKILL.md +16 -2
  101. package/skills/scripts/SKILL.md +16 -6
  102. package/skills/shell-manifest/SKILL.md +16 -7
  103. package/skills/testing/SKILL.md +2 -2
  104. package/skills/testing/client-components.md +6 -0
  105. package/skills/testing/handles.md +30 -8
  106. package/skills/testing/loader.md +51 -49
  107. package/skills/testing/middleware.md +1 -1
  108. package/skills/theme/SKILL.md +8 -5
  109. package/skills/typesafety/generated-files-and-cli.md +16 -9
  110. package/skills/typesafety/route-types.md +5 -1
  111. package/skills/use-cache/SKILL.md +47 -0
  112. package/src/bin/rango.ts +7 -3
  113. package/src/browser/event-controller.ts +40 -15
  114. package/src/browser/navigation-bridge.ts +6 -0
  115. package/src/browser/navigation-client.ts +5 -0
  116. package/src/browser/partial-update.ts +77 -10
  117. package/src/browser/react/NavigationProvider.tsx +7 -0
  118. package/src/browser/react/use-router.ts +40 -11
  119. package/src/browser/react/use-search-params.ts +140 -17
  120. package/src/browser/rsc-router.tsx +59 -0
  121. package/src/browser/server-action-bridge.ts +26 -0
  122. package/src/browser/types.ts +22 -0
  123. package/src/build/merge-full-manifests.ts +161 -0
  124. package/src/build/route-trie.ts +9 -332
  125. package/src/build/route-types/include-resolution.ts +66 -11
  126. package/src/build/route-types/per-module-writer.ts +11 -6
  127. package/src/build/route-types/router-processing.ts +184 -153
  128. package/src/build/runtime-discovery.ts +23 -12
  129. package/src/cache/cache-exec-scope.ts +47 -0
  130. package/src/cache/cache-runtime.ts +113 -40
  131. package/src/cache/cf/cf-cache-constants.ts +8 -1
  132. package/src/cache/cf/cf-cache-store.ts +41 -64
  133. package/src/cache/cf/cf-cache-types.ts +1 -1
  134. package/src/cache/cf/cf-kv-utils.ts +38 -0
  135. package/src/cache/segment-codec.ts +21 -5
  136. package/src/cache/taint.ts +28 -9
  137. package/src/client-urls/client-root.tsx +168 -0
  138. package/src/client-urls/client-urls.ts +698 -0
  139. package/src/client-urls/navigation.ts +237 -0
  140. package/src/client-urls/revalidation-protocol.ts +56 -0
  141. package/src/client-urls/server-projection.ts +579 -0
  142. package/src/client-urls/types.ts +195 -0
  143. package/src/client.rsc.tsx +12 -0
  144. package/src/client.tsx +49 -6
  145. package/src/decode-loader-results.ts +113 -0
  146. package/src/errors.ts +14 -0
  147. package/src/handles/deferred-resolution.ts +14 -7
  148. package/src/handles/is-thenable.ts +2 -4
  149. package/src/index.ts +1 -0
  150. package/src/loader-redirect.tsx +64 -0
  151. package/src/outlet-context.ts +12 -0
  152. package/src/outlet-provider.tsx +15 -1
  153. package/src/redirect-origin.ts +29 -0
  154. package/src/route-content-wrapper.tsx +96 -3
  155. package/src/route-definition/dsl-helpers.ts +28 -3
  156. package/src/route-definition/helpers-types.ts +13 -0
  157. package/src/route-definition/redirect.ts +17 -18
  158. package/src/router/error-handling.ts +65 -11
  159. package/src/router/intercept-resolution.ts +29 -0
  160. package/src/router/loader-resolution.ts +261 -28
  161. package/src/router/match-middleware/cache-lookup.ts +24 -15
  162. package/src/router/match-result.ts +7 -0
  163. package/src/router/revalidation.ts +24 -11
  164. package/src/router/route-trie-builder.ts +334 -0
  165. package/src/router/router-interfaces.ts +38 -0
  166. package/src/router/segment-resolution/fresh.ts +47 -0
  167. package/src/router/segment-resolution/helpers.ts +9 -11
  168. package/src/router/segment-resolution/loader-cache.ts +14 -24
  169. package/src/router/segment-resolution/revalidation.ts +20 -1
  170. package/src/router/trie-matching.ts +3 -3
  171. package/src/router.ts +46 -1
  172. package/src/rsc/full-payload.ts +6 -0
  173. package/src/rsc/handler.ts +36 -12
  174. package/src/rsc/helpers.ts +13 -0
  175. package/src/rsc/loader-fetch.ts +2 -2
  176. package/src/rsc/manifest-init.ts +28 -9
  177. package/src/rsc/progressive-enhancement.ts +247 -70
  178. package/src/rsc/render-pipeline.ts +68 -24
  179. package/src/rsc/routine-plan.ts +359 -0
  180. package/src/rsc/rsc-rendering.ts +569 -302
  181. package/src/rsc/server-action.ts +180 -71
  182. package/src/rsc/shell-capture-constants.ts +18 -0
  183. package/src/rsc/shell-capture.ts +104 -21
  184. package/src/rsc/shell-serve.ts +15 -2
  185. package/src/rsc/ssr-setup.ts +10 -1
  186. package/src/rsc/types.ts +31 -2
  187. package/src/segment-system.tsx +83 -26
  188. package/src/server/context.ts +10 -0
  189. package/src/server/cookie-store.ts +19 -19
  190. package/src/server/handle-store.ts +185 -48
  191. package/src/server/request-context.ts +36 -6
  192. package/src/server.ts +7 -0
  193. package/src/ssr/index.tsx +37 -2
  194. package/src/ssr/ssr-root.tsx +30 -2
  195. package/src/testing/dom.entry.ts +1 -1
  196. package/src/testing/render-route.tsx +22 -8
  197. package/src/testing/run-loader.ts +51 -13
  198. package/src/types/boundaries.ts +19 -0
  199. package/src/types/index.ts +1 -0
  200. package/src/types/loader-types.ts +60 -5
  201. package/src/types/segments.ts +7 -0
  202. package/src/urls/include-helper.ts +22 -4
  203. package/src/urls/path-helper-types.ts +14 -1
  204. package/src/use-loader.tsx +67 -6
  205. package/src/vite/discovery/client-urls-projection.ts +322 -0
  206. package/src/vite/discovery/discover-routers.ts +43 -17
  207. package/src/vite/discovery/state.ts +11 -1
  208. package/src/vite/discovery/virtual-module-codegen.ts +20 -0
  209. package/src/vite/encryption-key.ts +29 -0
  210. package/src/vite/plugins/expose-action-id.ts +2 -2
  211. package/src/vite/plugins/expose-internal-ids.ts +46 -0
  212. package/src/vite/plugins/server-ref-hashing.ts +74 -0
  213. package/src/vite/plugins/server-reference-pattern.ts +10 -0
  214. package/src/vite/plugins/virtual-entries.ts +12 -3
  215. package/src/vite/rango.ts +9 -0
  216. package/src/vite/router-discovery.ts +184 -14
  217. package/src/vite/utils/shared-utils.ts +12 -7
  218. package/dist/types.backup/__internal.d.ts +0 -127
  219. package/dist/types.backup/bin/rango.d.ts +0 -1
  220. package/dist/types.backup/browser/action-coordinator.d.ts +0 -57
  221. package/dist/types.backup/browser/action-fence.d.ts +0 -33
  222. package/dist/types.backup/browser/app-shell.d.ts +0 -34
  223. package/dist/types.backup/browser/app-version.d.ts +0 -6
  224. package/dist/types.backup/browser/connection-warmup.d.ts +0 -31
  225. package/dist/types.backup/browser/cookie-name.d.ts +0 -66
  226. package/dist/types.backup/browser/event-controller.d.ts +0 -221
  227. package/dist/types.backup/browser/history-state.d.ts +0 -26
  228. package/dist/types.backup/browser/index.d.ts +0 -1
  229. package/dist/types.backup/browser/intercept-utils.d.ts +0 -30
  230. package/dist/types.backup/browser/invalidate-client-cache.d.ts +0 -17
  231. package/dist/types.backup/browser/link-interceptor.d.ts +0 -43
  232. package/dist/types.backup/browser/logging.d.ts +0 -33
  233. package/dist/types.backup/browser/merge-segment-loaders.d.ts +0 -38
  234. package/dist/types.backup/browser/navigation-bridge.d.ts +0 -27
  235. package/dist/types.backup/browser/navigation-client.d.ts +0 -17
  236. package/dist/types.backup/browser/navigation-store-handle.d.ts +0 -25
  237. package/dist/types.backup/browser/navigation-store.d.ts +0 -95
  238. package/dist/types.backup/browser/navigation-transaction.d.ts +0 -75
  239. package/dist/types.backup/browser/network-error-handler.d.ts +0 -35
  240. package/dist/types.backup/browser/partial-update.d.ts +0 -61
  241. package/dist/types.backup/browser/prefetch/cache.d.ts +0 -183
  242. package/dist/types.backup/browser/prefetch/fetch.d.ts +0 -52
  243. package/dist/types.backup/browser/prefetch/observer.d.ts +0 -27
  244. package/dist/types.backup/browser/prefetch/policy.d.ts +0 -13
  245. package/dist/types.backup/browser/prefetch/queue.d.ts +0 -48
  246. package/dist/types.backup/browser/prefetch/resource-ready.d.ts +0 -28
  247. package/dist/types.backup/browser/rango-state.d.ts +0 -52
  248. package/dist/types.backup/browser/react/Link.d.ts +0 -140
  249. package/dist/types.backup/browser/react/NavigationProvider.d.ts +0 -88
  250. package/dist/types.backup/browser/react/ScrollRestoration.d.ts +0 -78
  251. package/dist/types.backup/browser/react/context.d.ts +0 -54
  252. package/dist/types.backup/browser/react/filter-segment-order.d.ts +0 -35
  253. package/dist/types.backup/browser/react/index.d.ts +0 -1
  254. package/dist/types.backup/browser/react/location-state-shared.d.ts +0 -162
  255. package/dist/types.backup/browser/react/location-state.d.ts +0 -29
  256. package/dist/types.backup/browser/react/mount-context.d.ts +0 -23
  257. package/dist/types.backup/browser/react/nonce-context.d.ts +0 -14
  258. package/dist/types.backup/browser/react/shallow-equal.d.ts +0 -5
  259. package/dist/types.backup/browser/react/use-action.d.ts +0 -61
  260. package/dist/types.backup/browser/react/use-handle.d.ts +0 -21
  261. package/dist/types.backup/browser/react/use-href.d.ts +0 -32
  262. package/dist/types.backup/browser/react/use-link-status.d.ts +0 -36
  263. package/dist/types.backup/browser/react/use-mount.d.ts +0 -24
  264. package/dist/types.backup/browser/react/use-navigation.d.ts +0 -15
  265. package/dist/types.backup/browser/react/use-params.d.ts +0 -21
  266. package/dist/types.backup/browser/react/use-pathname.d.ts +0 -13
  267. package/dist/types.backup/browser/react/use-reverse.d.ts +0 -40
  268. package/dist/types.backup/browser/react/use-router.d.ts +0 -23
  269. package/dist/types.backup/browser/react/use-search-params.d.ts +0 -19
  270. package/dist/types.backup/browser/react/use-segments.d.ts +0 -29
  271. package/dist/types.backup/browser/response-adapter.d.ts +0 -58
  272. package/dist/types.backup/browser/rsc-router.d.ts +0 -141
  273. package/dist/types.backup/browser/scroll-restoration.d.ts +0 -103
  274. package/dist/types.backup/browser/segment-reconciler.d.ts +0 -74
  275. package/dist/types.backup/browser/segment-structure-assert.d.ts +0 -16
  276. package/dist/types.backup/browser/server-action-bridge.d.ts +0 -29
  277. package/dist/types.backup/browser/types.d.ts +0 -530
  278. package/dist/types.backup/browser/validate-redirect-origin.d.ts +0 -28
  279. package/dist/types.backup/build/collect-fallback-refs.d.ts +0 -5
  280. package/dist/types.backup/build/generate-manifest.d.ts +0 -100
  281. package/dist/types.backup/build/generate-route-types.d.ts +0 -8
  282. package/dist/types.backup/build/index.d.ts +0 -21
  283. package/dist/types.backup/build/prefix-tree-utils.d.ts +0 -56
  284. package/dist/types.backup/build/route-types/ast-helpers.d.ts +0 -3
  285. package/dist/types.backup/build/route-types/ast-route-extraction.d.ts +0 -13
  286. package/dist/types.backup/build/route-types/codegen.d.ts +0 -16
  287. package/dist/types.backup/build/route-types/include-resolution.d.ts +0 -74
  288. package/dist/types.backup/build/route-types/param-extraction.d.ts +0 -13
  289. package/dist/types.backup/build/route-types/per-module-writer.d.ts +0 -18
  290. package/dist/types.backup/build/route-types/router-processing.d.ts +0 -82
  291. package/dist/types.backup/build/route-types/scan-filter.d.ts +0 -17
  292. package/dist/types.backup/build/route-types/source-scan.d.ts +0 -13
  293. package/dist/types.backup/build/runtime-discovery.d.ts +0 -24
  294. package/dist/types.backup/cache/background-task.d.ts +0 -21
  295. package/dist/types.backup/cache/cache-error.d.ts +0 -71
  296. package/dist/types.backup/cache/cache-key-utils.d.ts +0 -35
  297. package/dist/types.backup/cache/cache-policy.d.ts +0 -59
  298. package/dist/types.backup/cache/cache-runtime.d.ts +0 -51
  299. package/dist/types.backup/cache/cache-scope.d.ts +0 -134
  300. package/dist/types.backup/cache/cache-tag.d.ts +0 -79
  301. package/dist/types.backup/cache/cf/cf-base64.d.ts +0 -4
  302. package/dist/types.backup/cache/cf/cf-cache-constants.d.ts +0 -105
  303. package/dist/types.backup/cache/cf/cf-cache-store.d.ts +0 -481
  304. package/dist/types.backup/cache/cf/cf-cache-types.d.ts +0 -300
  305. package/dist/types.backup/cache/cf/cf-kv-utils.d.ts +0 -22
  306. package/dist/types.backup/cache/cf/cf-tag-marker-memo.d.ts +0 -15
  307. package/dist/types.backup/cache/cf/index.d.ts +0 -3
  308. package/dist/types.backup/cache/document-cache.d.ts +0 -69
  309. package/dist/types.backup/cache/handle-capture.d.ts +0 -23
  310. package/dist/types.backup/cache/handle-snapshot.d.ts +0 -39
  311. package/dist/types.backup/cache/index.d.ts +0 -7
  312. package/dist/types.backup/cache/memory-segment-store.d.ts +0 -163
  313. package/dist/types.backup/cache/profile-registry.d.ts +0 -40
  314. package/dist/types.backup/cache/read-through-swr.d.ts +0 -60
  315. package/dist/types.backup/cache/segment-codec.d.ts +0 -78
  316. package/dist/types.backup/cache/shell-snapshot.d.ts +0 -162
  317. package/dist/types.backup/cache/tag-invalidation.d.ts +0 -74
  318. package/dist/types.backup/cache/taint.d.ts +0 -71
  319. package/dist/types.backup/cache/types.d.ts +0 -407
  320. package/dist/types.backup/cache/vercel/index.d.ts +0 -1
  321. package/dist/types.backup/cache/vercel/vercel-cache-store.d.ts +0 -267
  322. package/dist/types.backup/client.d.ts +0 -184
  323. package/dist/types.backup/client.rsc.d.ts +0 -39
  324. package/dist/types.backup/cloudflare/index.d.ts +0 -7
  325. package/dist/types.backup/cloudflare/tracing.d.ts +0 -53
  326. package/dist/types.backup/component-utils.d.ts +0 -46
  327. package/dist/types.backup/components/DefaultDocument.d.ts +0 -13
  328. package/dist/types.backup/context-var.d.ts +0 -84
  329. package/dist/types.backup/debug.d.ts +0 -57
  330. package/dist/types.backup/decode-loader-results.d.ts +0 -5
  331. package/dist/types.backup/default-error-boundary.d.ts +0 -10
  332. package/dist/types.backup/defer.d.ts +0 -89
  333. package/dist/types.backup/deps/browser.d.ts +0 -1
  334. package/dist/types.backup/deps/html-stream-client.d.ts +0 -1
  335. package/dist/types.backup/deps/html-stream-server.d.ts +0 -1
  336. package/dist/types.backup/deps/rsc.d.ts +0 -1
  337. package/dist/types.backup/deps/ssr.d.ts +0 -1
  338. package/dist/types.backup/encode-kv.d.ts +0 -35
  339. package/dist/types.backup/errors.d.ts +0 -226
  340. package/dist/types.backup/escape-script.d.ts +0 -44
  341. package/dist/types.backup/handle.d.ts +0 -93
  342. package/dist/types.backup/handles/MetaTags.d.ts +0 -17
  343. package/dist/types.backup/handles/Scripts.d.ts +0 -38
  344. package/dist/types.backup/handles/breadcrumbs.d.ts +0 -43
  345. package/dist/types.backup/handles/deferred-resolution.d.ts +0 -53
  346. package/dist/types.backup/handles/is-thenable.d.ts +0 -12
  347. package/dist/types.backup/handles/meta.d.ts +0 -43
  348. package/dist/types.backup/handles/script.d.ts +0 -139
  349. package/dist/types.backup/host/cookie-handler.d.ts +0 -8
  350. package/dist/types.backup/host/errors.d.ts +0 -40
  351. package/dist/types.backup/host/index.d.ts +0 -33
  352. package/dist/types.backup/host/pattern-matcher.d.ts +0 -30
  353. package/dist/types.backup/host/router.d.ts +0 -12
  354. package/dist/types.backup/host/testing.d.ts +0 -41
  355. package/dist/types.backup/host/types.d.ts +0 -148
  356. package/dist/types.backup/host/utils.d.ts +0 -20
  357. package/dist/types.backup/href-client.d.ts +0 -214
  358. package/dist/types.backup/index.d.ts +0 -112
  359. package/dist/types.backup/index.rsc.d.ts +0 -51
  360. package/dist/types.backup/internal-debug.d.ts +0 -1
  361. package/dist/types.backup/loader-store.d.ts +0 -193
  362. package/dist/types.backup/loader.d.ts +0 -18
  363. package/dist/types.backup/loader.rsc.d.ts +0 -18
  364. package/dist/types.backup/missing-id-error.d.ts +0 -1
  365. package/dist/types.backup/outlet-context.d.ts +0 -12
  366. package/dist/types.backup/outlet-provider.d.ts +0 -12
  367. package/dist/types.backup/prerender/build-shell-capture.d.ts +0 -104
  368. package/dist/types.backup/prerender/param-hash.d.ts +0 -6
  369. package/dist/types.backup/prerender/shell-manifest-key.d.ts +0 -18
  370. package/dist/types.backup/prerender/store.d.ts +0 -62
  371. package/dist/types.backup/prerender.d.ts +0 -292
  372. package/dist/types.backup/redirect-origin.d.ts +0 -55
  373. package/dist/types.backup/regex-escape.d.ts +0 -6
  374. package/dist/types.backup/render-error-thrower.d.ts +0 -13
  375. package/dist/types.backup/response-utils.d.ts +0 -35
  376. package/dist/types.backup/reverse.d.ts +0 -206
  377. package/dist/types.backup/root-error-boundary.d.ts +0 -32
  378. package/dist/types.backup/route-content-wrapper.d.ts +0 -40
  379. package/dist/types.backup/route-definition/dsl-helpers.d.ts +0 -130
  380. package/dist/types.backup/route-definition/helper-factories.d.ts +0 -22
  381. package/dist/types.backup/route-definition/helpers-types.d.ts +0 -392
  382. package/dist/types.backup/route-definition/index.d.ts +0 -7
  383. package/dist/types.backup/route-definition/redirect.d.ts +0 -48
  384. package/dist/types.backup/route-definition/resolve-handler-use.d.ts +0 -19
  385. package/dist/types.backup/route-definition/use-item-types.d.ts +0 -1
  386. package/dist/types.backup/route-definition.d.ts +0 -1
  387. package/dist/types.backup/route-map-builder.d.ts +0 -127
  388. package/dist/types.backup/route-name.d.ts +0 -27
  389. package/dist/types.backup/route-types.d.ts +0 -172
  390. package/dist/types.backup/router/basename.d.ts +0 -10
  391. package/dist/types.backup/router/content-negotiation.d.ts +0 -91
  392. package/dist/types.backup/router/debug-manifest.d.ts +0 -7
  393. package/dist/types.backup/router/error-handling.d.ts +0 -76
  394. package/dist/types.backup/router/find-match.d.ts +0 -19
  395. package/dist/types.backup/router/handler-context.d.ts +0 -41
  396. package/dist/types.backup/router/instrument.d.ts +0 -161
  397. package/dist/types.backup/router/intercept-resolution.d.ts +0 -79
  398. package/dist/types.backup/router/lazy-includes.d.ts +0 -26
  399. package/dist/types.backup/router/loader-resolution.d.ts +0 -63
  400. package/dist/types.backup/router/logging.d.ts +0 -41
  401. package/dist/types.backup/router/manifest.d.ts +0 -8
  402. package/dist/types.backup/router/match-api.d.ts +0 -19
  403. package/dist/types.backup/router/match-context.d.ts +0 -184
  404. package/dist/types.backup/router/match-handlers.d.ts +0 -49
  405. package/dist/types.backup/router/match-middleware/background-revalidation.d.ts +0 -113
  406. package/dist/types.backup/router/match-middleware/cache-lookup.d.ts +0 -113
  407. package/dist/types.backup/router/match-middleware/cache-store.d.ts +0 -112
  408. package/dist/types.backup/router/match-middleware/index.d.ts +0 -80
  409. package/dist/types.backup/router/match-middleware/intercept-resolution.d.ts +0 -116
  410. package/dist/types.backup/router/match-middleware/segment-resolution.d.ts +0 -94
  411. package/dist/types.backup/router/match-pipelines.d.ts +0 -103
  412. package/dist/types.backup/router/match-result.d.ts +0 -114
  413. package/dist/types.backup/router/metrics.d.ts +0 -6
  414. package/dist/types.backup/router/middleware-types.d.ts +0 -74
  415. package/dist/types.backup/router/middleware.d.ts +0 -116
  416. package/dist/types.backup/router/navigation-snapshot.d.ts +0 -22
  417. package/dist/types.backup/router/params-util.d.ts +0 -8
  418. package/dist/types.backup/router/parse-pattern.d.ts +0 -38
  419. package/dist/types.backup/router/pattern-matching.d.ts +0 -169
  420. package/dist/types.backup/router/prefetch-cache-ttl.d.ts +0 -27
  421. package/dist/types.backup/router/prefetch-limits.d.ts +0 -20
  422. package/dist/types.backup/router/prerender-match.d.ts +0 -50
  423. package/dist/types.backup/router/preview-match.d.ts +0 -22
  424. package/dist/types.backup/router/request-classification.d.ts +0 -104
  425. package/dist/types.backup/router/revalidation.d.ts +0 -57
  426. package/dist/types.backup/router/route-snapshot.d.ts +0 -112
  427. package/dist/types.backup/router/router-context.d.ts +0 -137
  428. package/dist/types.backup/router/router-interfaces.d.ts +0 -432
  429. package/dist/types.backup/router/router-options.d.ts +0 -738
  430. package/dist/types.backup/router/router-registry.d.ts +0 -15
  431. package/dist/types.backup/router/segment-resolution/fresh.d.ts +0 -55
  432. package/dist/types.backup/router/segment-resolution/helpers.d.ts +0 -93
  433. package/dist/types.backup/router/segment-resolution/loader-cache.d.ts +0 -33
  434. package/dist/types.backup/router/segment-resolution/loader-mask.d.ts +0 -44
  435. package/dist/types.backup/router/segment-resolution/loader-snapshot.d.ts +0 -90
  436. package/dist/types.backup/router/segment-resolution/mask-nested.d.ts +0 -53
  437. package/dist/types.backup/router/segment-resolution/revalidation.d.ts +0 -85
  438. package/dist/types.backup/router/segment-resolution/static-store.d.ts +0 -17
  439. package/dist/types.backup/router/segment-resolution/streamed-handler-telemetry.d.ts +0 -16
  440. package/dist/types.backup/router/segment-resolution/view-transition-default.d.ts +0 -28
  441. package/dist/types.backup/router/segment-resolution.d.ts +0 -3
  442. package/dist/types.backup/router/segment-wrappers.d.ts +0 -53
  443. package/dist/types.backup/router/state-cookie-name.d.ts +0 -1
  444. package/dist/types.backup/router/substitute-pattern-params.d.ts +0 -23
  445. package/dist/types.backup/router/telemetry-otel.d.ts +0 -113
  446. package/dist/types.backup/router/telemetry.d.ts +0 -215
  447. package/dist/types.backup/router/timeout.d.ts +0 -68
  448. package/dist/types.backup/router/tracing.d.ts +0 -125
  449. package/dist/types.backup/router/trie-matching.d.ts +0 -32
  450. package/dist/types.backup/router/types.d.ts +0 -98
  451. package/dist/types.backup/router/url-params.d.ts +0 -26
  452. package/dist/types.backup/router.d.ts +0 -7
  453. package/dist/types.backup/rsc/capture-queue.d.ts +0 -6
  454. package/dist/types.backup/rsc/full-payload.d.ts +0 -22
  455. package/dist/types.backup/rsc/handler-context.d.ts +0 -31
  456. package/dist/types.backup/rsc/handler.d.ts +0 -9
  457. package/dist/types.backup/rsc/helpers.d.ts +0 -213
  458. package/dist/types.backup/rsc/index.d.ts +0 -17
  459. package/dist/types.backup/rsc/json-route-result.d.ts +0 -20
  460. package/dist/types.backup/rsc/loader-fetch.d.ts +0 -14
  461. package/dist/types.backup/rsc/manifest-init.d.ts +0 -18
  462. package/dist/types.backup/rsc/nonce.d.ts +0 -28
  463. package/dist/types.backup/rsc/origin-guard.d.ts +0 -50
  464. package/dist/types.backup/rsc/progressive-enhancement.d.ts +0 -19
  465. package/dist/types.backup/rsc/redirect-guard.d.ts +0 -35
  466. package/dist/types.backup/rsc/response-cache-serve.d.ts +0 -46
  467. package/dist/types.backup/rsc/response-error.d.ts +0 -19
  468. package/dist/types.backup/rsc/response-route-handler.d.ts +0 -29
  469. package/dist/types.backup/rsc/rsc-rendering.d.ts +0 -23
  470. package/dist/types.backup/rsc/runtime-warnings.d.ts +0 -22
  471. package/dist/types.backup/rsc/server-action.d.ts +0 -68
  472. package/dist/types.backup/rsc/shell-build-manifest.d.ts +0 -84
  473. package/dist/types.backup/rsc/shell-capture-constants.d.ts +0 -27
  474. package/dist/types.backup/rsc/shell-capture.d.ts +0 -374
  475. package/dist/types.backup/rsc/shell-serve.d.ts +0 -136
  476. package/dist/types.backup/rsc/ssr-setup.d.ts +0 -48
  477. package/dist/types.backup/rsc/transition-gate.d.ts +0 -27
  478. package/dist/types.backup/rsc/types.d.ts +0 -290
  479. package/dist/types.backup/runtime-env.d.ts +0 -1
  480. package/dist/types.backup/search-params.d.ts +0 -125
  481. package/dist/types.backup/segment-content-promise.d.ts +0 -13
  482. package/dist/types.backup/segment-fragments.d.ts +0 -56
  483. package/dist/types.backup/segment-loader-promise.d.ts +0 -22
  484. package/dist/types.backup/segment-system.d.ts +0 -84
  485. package/dist/types.backup/serialize.d.ts +0 -164
  486. package/dist/types.backup/server/context.d.ts +0 -494
  487. package/dist/types.backup/server/cookie-parse.d.ts +0 -10
  488. package/dist/types.backup/server/cookie-store.d.ts +0 -107
  489. package/dist/types.backup/server/fetchable-loader-store.d.ts +0 -20
  490. package/dist/types.backup/server/handle-store.d.ts +0 -100
  491. package/dist/types.backup/server/loader-registry.d.ts +0 -32
  492. package/dist/types.backup/server/request-context.d.ts +0 -596
  493. package/dist/types.backup/server/root-layout.d.ts +0 -3
  494. package/dist/types.backup/server.d.ts +0 -15
  495. package/dist/types.backup/ssr/index.d.ts +0 -233
  496. package/dist/types.backup/ssr/inject-rsc-eager.d.ts +0 -3
  497. package/dist/types.backup/ssr/preinit-client-references.d.ts +0 -71
  498. package/dist/types.backup/ssr/ssr-root.d.ts +0 -69
  499. package/dist/types.backup/static-handler.d.ts +0 -57
  500. package/dist/types.backup/testing/cache-status.d.ts +0 -63
  501. package/dist/types.backup/testing/collect-handle.d.ts +0 -20
  502. package/dist/types.backup/testing/dispatch.d.ts +0 -123
  503. package/dist/types.backup/testing/dom.entry.d.ts +0 -15
  504. package/dist/types.backup/testing/e2e/fixture.d.ts +0 -37
  505. package/dist/types.backup/testing/e2e/index.d.ts +0 -30
  506. package/dist/types.backup/testing/e2e/matchers.d.ts +0 -17
  507. package/dist/types.backup/testing/e2e/page-helpers.d.ts +0 -62
  508. package/dist/types.backup/testing/e2e/parity.d.ts +0 -111
  509. package/dist/types.backup/testing/e2e/server.d.ts +0 -35
  510. package/dist/types.backup/testing/flight-matchers.d.ts +0 -55
  511. package/dist/types.backup/testing/flight-normalize.d.ts +0 -1
  512. package/dist/types.backup/testing/flight-tree.d.ts +0 -192
  513. package/dist/types.backup/testing/flight.d.ts +0 -115
  514. package/dist/types.backup/testing/flight.entry.d.ts +0 -27
  515. package/dist/types.backup/testing/generated-routes.d.ts +0 -66
  516. package/dist/types.backup/testing/index.d.ts +0 -52
  517. package/dist/types.backup/testing/internal/context.d.ts +0 -225
  518. package/dist/types.backup/testing/internal/flight-client-globals.d.ts +0 -1
  519. package/dist/types.backup/testing/internal/seed-vars.d.ts +0 -30
  520. package/dist/types.backup/testing/render-handler.d.ts +0 -160
  521. package/dist/types.backup/testing/render-route.d.ts +0 -246
  522. package/dist/types.backup/testing/run-loader.d.ts +0 -186
  523. package/dist/types.backup/testing/run-middleware.d.ts +0 -132
  524. package/dist/types.backup/testing/run-transition-when.d.ts +0 -77
  525. package/dist/types.backup/testing/vitest-stubs/cloudflare-email.d.ts +0 -6
  526. package/dist/types.backup/testing/vitest-stubs/cloudflare-workers.d.ts +0 -13
  527. package/dist/types.backup/testing/vitest-stubs/plugin-rsc.d.ts +0 -7
  528. package/dist/types.backup/testing/vitest-stubs/version.d.ts +0 -1
  529. package/dist/types.backup/testing/vitest.d.ts +0 -205
  530. package/dist/types.backup/theme/ThemeProvider.d.ts +0 -13
  531. package/dist/types.backup/theme/ThemeScript.d.ts +0 -45
  532. package/dist/types.backup/theme/constants.d.ts +0 -39
  533. package/dist/types.backup/theme/index.d.ts +0 -29
  534. package/dist/types.backup/theme/theme-context.d.ts +0 -21
  535. package/dist/types.backup/theme/theme-script.d.ts +0 -26
  536. package/dist/types.backup/theme/types.d.ts +0 -162
  537. package/dist/types.backup/theme/use-theme.d.ts +0 -8
  538. package/dist/types.backup/types/boundaries.d.ts +0 -93
  539. package/dist/types.backup/types/cache-types.d.ts +0 -191
  540. package/dist/types.backup/types/error-types.d.ts +0 -114
  541. package/dist/types.backup/types/global-namespace.d.ts +0 -90
  542. package/dist/types.backup/types/handler-context.d.ts +0 -658
  543. package/dist/types.backup/types/index.d.ts +0 -11
  544. package/dist/types.backup/types/loader-types.d.ts +0 -182
  545. package/dist/types.backup/types/request-scope.d.ts +0 -93
  546. package/dist/types.backup/types/route-config.d.ts +0 -105
  547. package/dist/types.backup/types/route-entry.d.ts +0 -95
  548. package/dist/types.backup/types/segments.d.ts +0 -234
  549. package/dist/types.backup/types.d.ts +0 -1
  550. package/dist/types.backup/urls/include-helper.d.ts +0 -17
  551. package/dist/types.backup/urls/include-provider.d.ts +0 -27
  552. package/dist/types.backup/urls/index.d.ts +0 -6
  553. package/dist/types.backup/urls/path-helper-types.d.ts +0 -197
  554. package/dist/types.backup/urls/path-helper.d.ts +0 -12
  555. package/dist/types.backup/urls/pattern-types.d.ts +0 -166
  556. package/dist/types.backup/urls/response-types.d.ts +0 -67
  557. package/dist/types.backup/urls/type-extraction.d.ts +0 -157
  558. package/dist/types.backup/urls/urls-function.d.ts +0 -24
  559. package/dist/types.backup/urls.d.ts +0 -1
  560. package/dist/types.backup/use-loader.d.ts +0 -150
  561. package/dist/types.backup/vercel/index.d.ts +0 -10
  562. package/dist/types.backup/vercel/tracing.d.ts +0 -70
  563. package/dist/types.backup/vite/debug.d.ts +0 -80
  564. package/dist/types.backup/vite/discovery/bundle-postprocess.d.ts +0 -12
  565. package/dist/types.backup/vite/discovery/dev-prerender-cache.d.ts +0 -65
  566. package/dist/types.backup/vite/discovery/discover-routers.d.ts +0 -17
  567. package/dist/types.backup/vite/discovery/discovery-errors.d.ts +0 -113
  568. package/dist/types.backup/vite/discovery/gate-state.d.ts +0 -79
  569. package/dist/types.backup/vite/discovery/prerender-collection.d.ts +0 -24
  570. package/dist/types.backup/vite/discovery/route-types-writer.d.ts +0 -32
  571. package/dist/types.backup/vite/discovery/self-gen-tracking.d.ts +0 -22
  572. package/dist/types.backup/vite/discovery/shell-prerender-phase.d.ts +0 -40
  573. package/dist/types.backup/vite/discovery/state.d.ts +0 -162
  574. package/dist/types.backup/vite/discovery/virtual-module-codegen.d.ts +0 -15
  575. package/dist/types.backup/vite/index.d.ts +0 -11
  576. package/dist/types.backup/vite/inject-client-debug.d.ts +0 -56
  577. package/dist/types.backup/vite/plugin-types.d.ts +0 -298
  578. package/dist/types.backup/vite/plugins/cjs-to-esm.d.ts +0 -6
  579. package/dist/types.backup/vite/plugins/client-ref-dedup.d.ts +0 -40
  580. package/dist/types.backup/vite/plugins/client-ref-hashing.d.ts +0 -35
  581. package/dist/types.backup/vite/plugins/cloudflare-protocol-stub.d.ts +0 -64
  582. package/dist/types.backup/vite/plugins/expose-action-id.d.ts +0 -18
  583. package/dist/types.backup/vite/plugins/expose-id-utils.d.ts +0 -37
  584. package/dist/types.backup/vite/plugins/expose-ids/export-analysis.d.ts +0 -19
  585. package/dist/types.backup/vite/plugins/expose-ids/handler-transform.d.ts +0 -10
  586. package/dist/types.backup/vite/plugins/expose-ids/loader-transform.d.ts +0 -8
  587. package/dist/types.backup/vite/plugins/expose-ids/router-transform.d.ts +0 -13
  588. package/dist/types.backup/vite/plugins/expose-ids/types.d.ts +0 -29
  589. package/dist/types.backup/vite/plugins/expose-internal-ids.d.ts +0 -6
  590. package/dist/types.backup/vite/plugins/performance-tracks.d.ts +0 -25
  591. package/dist/types.backup/vite/plugins/refresh-cmd.d.ts +0 -20
  592. package/dist/types.backup/vite/plugins/use-cache-transform.d.ts +0 -20
  593. package/dist/types.backup/vite/plugins/vercel-output.d.ts +0 -85
  594. package/dist/types.backup/vite/plugins/version-injector.d.ts +0 -21
  595. package/dist/types.backup/vite/plugins/version-plugin.d.ts +0 -19
  596. package/dist/types.backup/vite/plugins/virtual-entries.d.ts +0 -36
  597. package/dist/types.backup/vite/plugins/virtual-stub-plugin.d.ts +0 -7
  598. package/dist/types.backup/vite/rango.d.ts +0 -29
  599. package/dist/types.backup/vite/router-discovery.d.ts +0 -23
  600. package/dist/types.backup/vite/utils/ast-handler-extract.d.ts +0 -64
  601. package/dist/types.backup/vite/utils/banner.d.ts +0 -2
  602. package/dist/types.backup/vite/utils/bundle-analysis.d.ts +0 -28
  603. package/dist/types.backup/vite/utils/client-chunks.d.ts +0 -55
  604. package/dist/types.backup/vite/utils/directive-prologue.d.ts +0 -16
  605. package/dist/types.backup/vite/utils/forward-user-plugins.d.ts +0 -37
  606. package/dist/types.backup/vite/utils/manifest-utils.d.ts +0 -7
  607. package/dist/types.backup/vite/utils/package-resolution.d.ts +0 -6
  608. package/dist/types.backup/vite/utils/prerender-utils.d.ts +0 -32
  609. package/dist/types.backup/vite/utils/shared-utils.d.ts +0 -55
@@ -1,214 +0,0 @@
1
- /**
2
- * Client-safe type-safe href function
3
- *
4
- * This is a compile-time only href that validates paths against registered routes.
5
- * No runtime route map lookup - just an identity function with TypeScript validation.
6
- *
7
- * @example
8
- * ```typescript
9
- * import { href } from "rsc-router/client";
10
- *
11
- * href("/blog/my-post"); // ✓ matches /blog/:slug
12
- * href("/shop/product/widget"); // ✓ matches /shop/product/:slug
13
- * href("/invalid"); // ✗ TypeScript error
14
- * ```
15
- */
16
- import type { GetRegisteredRoutes } from "./types.js";
17
- import type { JsonSerialize } from "./serialize.js";
18
- /**
19
- * Parse constraint values into a union type for paths
20
- * "a|b|c" → "a" | "b" | "c"
21
- */
22
- type ParseConstraintPath<T extends string> = T extends `${infer First}|${infer Rest}` ? First | ParseConstraintPath<Rest> : T;
23
- /**
24
- * Convert a route pattern to a template literal type
25
- *
26
- * Supports:
27
- * - Static: /about → "/about"
28
- * - Dynamic: /blog/:slug → `/blog/${string}`
29
- * - Optional: /:locale?/blog → "/blog" | `/${string}/blog`
30
- * - Constrained: /:locale(en|gb)/blog → "/en/blog" | "/gb/blog"
31
- * - Optional + Constrained: /:locale(en|gb)?/blog → "/blog" | "/en/blog" | "/gb/blog"
32
- *
33
- * @example
34
- * PatternToPath<"/blog/:slug"> = `/blog/${string}`
35
- * PatternToPath<"/:locale?/blog"> = "/blog" | `/${string}/blog`
36
- * PatternToPath<"/:locale(en|gb)/blog"> = "/en/blog" | "/gb/blog"
37
- * PatternToPath<"/:locale(en|gb)?/blog"> = "/blog" | "/en/blog" | "/gb/blog"
38
- */
39
- export type PatternToPath<T extends string> = T extends `${infer Before}:${infer _Name}(${infer Constraint})?/${infer After}` ? PatternToPath<`${Before}${After}`> | `${Before}${ParseConstraintPath<Constraint>}/${PatternToPath<After>}` : T extends `${infer Before}:${infer _Name}(${infer Constraint})?` ? Before | `${Before}${ParseConstraintPath<Constraint>}` : T extends `${infer Before}:${infer _Name}(${infer Constraint})/${infer After}` ? `${Before}${ParseConstraintPath<Constraint>}/${PatternToPath<After>}` : T extends `${infer Before}:${infer _Name}(${infer Constraint})` ? `${Before}${ParseConstraintPath<Constraint>}` : T extends `${infer Before}:${infer _Param}?/${infer After}` ? PatternToPath<`${Before}${After}`> | `${Before}${string}/${PatternToPath<After>}` : T extends `${infer Before}:${infer _Param}?` ? Before | `${Before}${string}` : T extends `${infer Before}:${infer _Param}/${infer After}` ? `${Before}${string}/${PatternToPath<After>}` : T extends `${infer Before}:${infer _Param}` ? `${Before}${string}` : T;
40
- /**
41
- * Allow optional query string (?...) and/or hash fragment (#...) suffix
42
- *
43
- * @example
44
- * WithSuffix<"/about"> = "/about" | "/about?..." | "/about#..." | "/about?...#..."
45
- */
46
- type WithSuffix<T extends string> = T | `${T}?${string}` | `${T}#${string}` | `${T}?${string}#${string}`;
47
- /**
48
- * Helper type to get pattern from routes, handling string values and { path, response } objects
49
- */
50
- type RoutePattern<TRoutes, K extends keyof TRoutes> = TRoutes[K] extends string ? TRoutes[K] : TRoutes[K] extends {
51
- readonly path: infer P extends string;
52
- } ? P : string;
53
- /**
54
- * Strip a query (`?…`) and/or hash (`#…`) suffix before matching, so a concrete
55
- * URL like `/api/health?ts=1` still resolves to its route's response. Removes
56
- * from the earliest of `?`/`#`: a `#` before the first `?` (the query is part of
57
- * a fragment, e.g. `/health#top?x=1`) is handled, as is a `/:` that only appears
58
- * inside the query (e.g. `/health?next=/:id`).
59
- */
60
- type StripPathSuffix<T extends string> = T extends `${infer Base}?${string}` ? Base extends `${infer Frag}#${string}` ? Frag : Base : T extends `${infer Base}#${string}` ? Base : T;
61
- /** Extract a route entry's response payload (or `never` for RSC routes). */
62
- type ResponsePayloadOf<TRoutes, K extends keyof TRoutes> = TRoutes[K] extends {
63
- readonly response: infer R;
64
- } ? Exclude<R, Response> : never;
65
- /**
66
- * Look up the response payload for a route, keyed by either a route pattern
67
- * (`/api/products/:id`) or a concrete path (`/api/products/123`). The same type
68
- * serves a pattern lookup and a typed `fetch` wrapper that forwards a concrete
69
- * `Rango.Path`:
70
- *
71
- * PathResponse<"/api/products/:id"> → Product // by pattern
72
- * PathResponse<"/api/products/123"> → Product // by concrete path
73
- *
74
- * The query/hash suffix is stripped first; the stripped key is then treated as a
75
- * pattern when it contains a `/:param` segment and matched exactly (precise even
76
- * for nested dynamic routes), otherwise as a concrete path matched against each
77
- * route's `PatternToPath` template. Because those holes are `${string}`
78
- * (slash-greedy), a concrete path under a *nested* dynamic route can match several
79
- * patterns and union their responses — pattern lookups do not have this
80
- * looseness. RSC routes (no response) and unmatched keys resolve to `never`.
81
- */
82
- type ResponsePayloadFor<TPath extends string, TRoutes = GetRegisteredRoutes> = ResponsePayloadForKey<StripPathSuffix<TPath>, TRoutes>;
83
- type ResponsePayloadForKey<TKey extends string, TRoutes> = TKey extends `${string}/:${string}` ? {
84
- [K in keyof TRoutes]: RoutePattern<TRoutes, K> extends TKey ? ResponsePayloadOf<TRoutes, K> : never;
85
- }[keyof TRoutes] : {
86
- [K in keyof TRoutes]: TKey extends PatternToPath<RoutePattern<TRoutes, K>> ? ResponsePayloadOf<TRoutes, K> : never;
87
- }[keyof TRoutes];
88
- /**
89
- * Public response type for a route, keyed by pattern or concrete path. JSON
90
- * response routes send the handler's return value verbatim (bare), so the
91
- * payload is wrapped only in `JsonSerialize` to describe the JSON **wire** value
92
- * a consumer receives from `fetch().then(r => r.json())` — e.g. a handler
93
- * returning `{ createdAt: Date }` resolves here to `{ createdAt: string }`.
94
- */
95
- export type PathResponse<TPath extends string, TRoutes = GetRegisteredRoutes> = JsonSerialize<ResponsePayloadFor<TPath, TRoutes>>;
96
- /**
97
- * Strip trailing slash from a path (e.g., "/blog/" -> "/blog" | "/blog/")
98
- * Allows navigation to include() prefixes without requiring trailing slash
99
- */
100
- type OptionalTrailingSlash<T extends string> = T extends `${infer Base}/` ? Base extends "" ? T : Base | T : T;
101
- /**
102
- * Union of all valid paths from registered routes
103
- *
104
- * Generated from Rango.RegisteredRoutes via module augmentation.
105
- * Allows optional query strings and hash fragments.
106
- */
107
- export type ValidPaths<TRoutes = GetRegisteredRoutes> = keyof TRoutes extends never ? `/${string}` : WithSuffix<{
108
- [K in keyof TRoutes]: OptionalTrailingSlash<PatternToPath<RoutePattern<TRoutes, K>>>;
109
- }[keyof TRoutes]>;
110
- type GlobalPathResponse<TPattern extends string, TRoutes = GetRegisteredRoutes> = PathResponse<TPattern, TRoutes>;
111
- /**
112
- * Ambient path types on the `Rango` namespace.
113
- *
114
- * These live on the same global namespace consumers already augment for
115
- * `Rango.Env` / `Rango.Vars`, so they are reachable with no import wherever the
116
- * router's types are in scope. They are the public, recommended surface for
117
- * typing anything that wraps `href()`. `ValidPaths` / `PathResponse` stay as the
118
- * internal building blocks behind them.
119
- */
120
- declare global {
121
- namespace Rango {
122
- /**
123
- * Union of every valid route path accepted by `href()`.
124
- *
125
- * Type a wrapper's path parameter as `Rango.Path` so it shares `href()`'s
126
- * compile-time validation against the registered routes:
127
- *
128
- * ```ts
129
- * import { href } from "@rangojs/router/client";
130
- *
131
- * export const appHref = (path: Rango.Path) => href(path);
132
- * ```
133
- *
134
- * Resolves from `Rango.RegisteredRoutes` when augmented, otherwise the
135
- * auto-generated `Rango.GeneratedRouteMap`, otherwise a permissive
136
- * `/${string}` fallback.
137
- */
138
- type Path<TRoutes = GetRegisteredRoutes> = ValidPaths<TRoutes>;
139
- /**
140
- * Response payload for a route, looked up from the global route map by
141
- * either a route pattern (`/api/products/:id`) or a concrete path
142
- * (`/api/products/123`). Because it accepts a concrete `Rango.Path`, it
143
- * doubles as the return type of a typed `fetch` wrapper:
144
- *
145
- * ```ts
146
- * type Product = Rango.PathResponse<"/api/products/:id">; // by pattern
147
- * type Same = Rango.PathResponse<"/api/products/42">; // by concrete path
148
- *
149
- * const get = async <T extends Rango.Path>(
150
- * path: T,
151
- * ): Promise<Rango.PathResponse<T>> =>
152
- * fetch(href(path)).then((r) => r.json());
153
- * ```
154
- *
155
- * The payload is the JSON **wire** shape (via `Rango.JsonSerialize`), not the
156
- * handler's raw return — a handler returning `{ createdAt: Date }` resolves
157
- * here to `{ createdAt: string }` (bare, no envelope), matching what
158
- * `fetch().then(r => r.json())` actually yields.
159
- *
160
- * Only resolves once `Rango.RegisteredRoutes` carries response metadata (the
161
- * generated map has paths and search but no payloads). Pass an explicit route
162
- * map as the second argument to look up against a non-global map (rarely
163
- * needed in app code).
164
- */
165
- type PathResponse<TPath extends string, TRoutes = GetRegisteredRoutes> = GlobalPathResponse<TPath, TRoutes>;
166
- }
167
- }
168
- /**
169
- * Type-safe href function for client-side use
170
- *
171
- * Without mount: identity function, validates absolute paths at compile time.
172
- * With mount: prepends mount path, for use with useMount() inside include() scopes.
173
- *
174
- * @param path - A valid path matching one of the registered route patterns
175
- * @param mount - Optional mount prefix from useMount() for include-scoped paths
176
- * @returns The resolved path
177
- *
178
- * @example
179
- * ```typescript
180
- * // Absolute paths (type-safe)
181
- * href("/blog/hello"); // "/blog/hello"
182
- * href("/shop/product/widget"); // "/shop/product/widget"
183
- *
184
- * // With mount (inside an include)
185
- * const mount = useMount(); // "/articles"
186
- * href("/", mount); // "/articles/"
187
- * href("/my-post", mount); // "/articles/my-post"
188
- *
189
- * // Query strings and hashes pass through
190
- * href("/blog/hello?page=1");
191
- * href("/about#contact");
192
- * ```
193
- */
194
- export declare function href<T extends ValidPaths>(path: T, mount?: string): string;
195
- /**
196
- * Props shape returned by href.json() etc. for spreading on <Link>.
197
- * Sets data-external to trigger hard navigation (skips RSC fetch).
198
- */
199
- export interface ResponseHrefProps {
200
- to: string;
201
- "data-external": "";
202
- }
203
- type ResponseHrefFn = <T extends ValidPaths>(path: T, mount?: string) => ResponseHrefProps;
204
- export declare namespace href {
205
- const json: ResponseHrefFn;
206
- const text: ResponseHrefFn;
207
- const html: ResponseHrefFn;
208
- const xml: ResponseHrefFn;
209
- const md: ResponseHrefFn;
210
- const image: ResponseHrefFn;
211
- const stream: ResponseHrefFn;
212
- const any: ResponseHrefFn;
213
- }
214
- export {};
@@ -1,112 +0,0 @@
1
- /**
2
- * @rangojs/router
3
- *
4
- * Single user-facing entrypoint for all router APIs.
5
- *
6
- * The "react-server" export condition selects index.rsc.ts (real implementations)
7
- * vs this file (client stubs for server-only functions).
8
- *
9
- * For client-only exports (Outlet, useOutlet, hooks, components):
10
- * import from "@rangojs/router/client"
11
- */
12
- export { RouteNotFoundError, DataNotFoundError, notFound, MiddlewareError, HandlerError, BuildError, DslContextError, InvalidHandlerError, RouterError, Skip, isSkip, } from "./errors.js";
13
- export type { DocumentProps, DefaultEnv, RouteDefinition, RouteConfig, RouteDefinitionOptions, TrailingSlashMode, Handler, // Supports params object, path pattern, or route name
14
- HandlerContext, ExtractParams, GenericParams, Middleware, RevalidateParams, Revalidate, ActionRef, RouteKeys, LoaderDefinition, LoaderFn, LoaderContext, FetchableLoaderOptions, LoadOptions, ErrorInfo, ErrorBoundaryFallbackProps, ErrorBoundaryHandler, ClientErrorBoundaryFallbackProps, NotFoundInfo, NotFoundBoundaryFallbackProps, NotFoundBoundaryHandler, ErrorPhase, OnErrorContext, OnErrorCallback, } from "./types.js";
15
- export type { SearchSchema, SearchSchemaValue, ResolveSearchSchema, RouteSearchParams, RouteParams, } from "./search-params.js";
16
- export { createLoader } from "./loader.js";
17
- export type { RouteHelpers, RouteHandlers } from "./route-definition.js";
18
- export type { TransitionConfig, TransitionWhenFn, TransitionWhenContext, ViewTransitionClass, } from "./types.js";
19
- export type { RouteUseItem, LayoutUseItem, AllUseItems, UseItems, HandlerUseItem, } from "./route-types.js";
20
- export type { ResponseHandler, ResponseHandlerContext, JsonResponseHandler, TextResponseHandler, JsonValue, ResponsePathFn, JsonResponsePathFn, TextResponsePathFn, RouteResponse, ProblemDetails, PartialPrerenderProps, } from "./urls.js";
21
- export type { MiddlewareContext, CookieOptions } from "./router/middleware.js";
22
- /**
23
- * Error-throwing stub for server-only `urls` function.
24
- */
25
- export declare function urls(): never;
26
- /**
27
- * Error-throwing stub for server-only `createRouter` function.
28
- */
29
- export declare function createRouter(): never;
30
- /**
31
- * Error-throwing stub for server-only `redirect` function.
32
- */
33
- export declare function redirect(): never;
34
- export { createHandle, isHandle, type Handle } from "./handle.js";
35
- export { DEFAULT_DEFER_TIMEOUT_MS, type DeferOptions, type HandlePush, type HandlePushFn, } from "./defer.js";
36
- export { createVar, type ContextVar } from "./context-var.js";
37
- export { nonce } from "./rsc/nonce.js";
38
- /**
39
- * SSR/client stub for server-only `Prerender` function.
40
- *
41
- * Returns a lightweight stub object instead of throwing so that the
42
- * production SSR build can safely bundle the RSC entry chunk — the SSR
43
- * bundler resolves `@rangojs/router` to this (SSR) entry, so Prerender
44
- * calls in RSC code must not crash at module-evaluation time.
45
- */
46
- export declare function Prerender(_handler?: any, _optionsOrId?: any, __injectedId?: string): any;
47
- /**
48
- * SSR/client stub for server-only `Passthrough` function.
49
- */
50
- export declare function Passthrough(_handler?: any, _optionsOrId?: any, __injectedId?: string): any;
51
- /**
52
- * SSR/client stub for server-only `Static` function.
53
- *
54
- * Returns a lightweight stub object instead of throwing so that the
55
- * production SSR build can safely bundle the RSC entry chunk — the SSR
56
- * bundler resolves `@rangojs/router` to this (SSR) entry, so Static
57
- * calls in RSC code must not crash at module-evaluation time.
58
- */
59
- export declare function Static(_handler?: any, _optionsOrId?: any, __injectedId?: string): any;
60
- /**
61
- * Error-throwing stub for server-only `getRequestContext` function.
62
- */
63
- export declare function getRequestContext(): never;
64
- /**
65
- * Error-throwing stub for server-only `cookies` function.
66
- */
67
- export declare function cookies(): never;
68
- /**
69
- * Error-throwing stub for server-only `headers` function.
70
- */
71
- export declare function headers(): never;
72
- /**
73
- * Client implementation of `invalidateClientCache()`. Unlike the server-only
74
- * stubs above this is a REAL function under the `default` condition (it marks
75
- * the client's caches stale); the `react-server` condition (index.rsc.ts)
76
- * selects the server implementation that writes a rotated `Set-Cookie`.
77
- */
78
- export { invalidateClientCache, keepClientCache, } from "./browser/invalidate-client-cache.js";
79
- /**
80
- * Error-throwing stub for server-only `createReverse` function.
81
- */
82
- export declare function createReverse(): never;
83
- export declare function layout(): never;
84
- export declare function cache(): never;
85
- export declare function middleware(): never;
86
- export declare function revalidate(): never;
87
- export declare function cacheTag(): never;
88
- export declare function updateTag(): never;
89
- export declare function revalidateTag(): never;
90
- export declare function loader(): never;
91
- export declare function loading(): never;
92
- export declare function parallel(): never;
93
- export declare function intercept(): never;
94
- export declare function errorBoundary(): never;
95
- export declare function notFoundBoundary(): never;
96
- export declare function transition(): never;
97
- export type { PublicRequestContext as RequestContext } from "./server/request-context.js";
98
- export type { RequestScope, ExecutionContext } from "./types/request-scope.js";
99
- export type { CookieStore, Cookie, ReadonlyHeaders, } from "./server/cookie-store.js";
100
- export { Meta } from "./handles/meta.js";
101
- export { Script, type ScriptConfig, type ScriptAttributes, } from "./handles/script.js";
102
- export { Breadcrumbs } from "./handles/breadcrumbs.js";
103
- export type { MetaDescriptor, MetaDescriptorBase } from "./router/types.js";
104
- export type { BreadcrumbItem } from "./handles/breadcrumbs.js";
105
- export type { ScopedReverseFunction, ReverseFunction, ExtractLocalRoutes, ParamsFor, } from "./reverse.js";
106
- export { scopedReverse } from "./reverse.js";
107
- export { createLocationState, type LocationStateDefinition, type LocationStateEntry, type LocationStateOptions, } from "./browser/react/location-state-shared.js";
108
- export type { OTelTracer, OTelActiveSpanTracer, OTelSpan, OTelTracingOptions, } from "./router/telemetry-otel.js";
109
- export type { TelemetrySink, TelemetryEvent, RequestStartEvent, RequestEndEvent, RequestErrorEvent, LoaderStartEvent, LoaderEndEvent, LoaderErrorEvent, HandlerErrorEvent, CacheSegmentStatus, CacheSegmentSignal, CacheDecisionEvent, RevalidationDecisionEvent, RequestTimeoutEvent, OriginCheckRejectedEvent, } from "./router/telemetry.js";
110
- export type { RouterTracingConfig, TracePhase, TracePhaseToggles, TracingToggleOptions, } from "./router/tracing.js";
111
- export { RouterTimeoutError } from "./router/timeout.js";
112
- export type { RouterTimeouts, TimeoutPhase, TimeoutContext, } from "./router/timeout.js";
@@ -1,51 +0,0 @@
1
- /**
2
- * @rangojs/router (react-server environment)
3
- *
4
- * This file is used when importing "@rangojs/router" from RSC (server components).
5
- * It re-exports everything from the universal index.ts plus adds server-side
6
- * implementations that replace the client-side error stubs.
7
- *
8
- * The bundler uses the "react-server" export condition to select this file
9
- * in RSC context, while the regular index.ts is used in client components.
10
- */
11
- export { RouteNotFoundError, DataNotFoundError, notFound, MiddlewareError, HandlerError, BuildError, DslContextError, InvalidHandlerError, RouterError, Skip, isSkip, } from "./index.js";
12
- export type { DocumentProps, DefaultEnv, RouteDefinition, RouteConfig, RouteDefinitionOptions, TrailingSlashMode, Handler, HandlerContext, ExtractParams, GenericParams, Middleware, RevalidateParams, Revalidate, ActionRef, RouteKeys, LoaderDefinition, LoaderFn, LoaderContext, FetchableLoaderOptions, LoadOptions, ErrorInfo, ErrorBoundaryFallbackProps, ErrorBoundaryHandler, ClientErrorBoundaryFallbackProps, NotFoundInfo, NotFoundBoundaryFallbackProps, NotFoundBoundaryHandler, ErrorPhase, OnErrorContext, OnErrorCallback, TransitionConfig, TransitionWhenFn, TransitionWhenContext, ViewTransitionClass, } from "./types.js";
13
- export type { RangoOptions, SSRStreamMode, SSROptions, ResolveStreamingContext, } from "./router.js";
14
- export type { OriginCheckConfig, OriginCheckContext, OriginCheckPhase, } from "./rsc/origin-guard.js";
15
- export type { ShellCaptureDebug, ShellCaptureDebugEvent, } from "./rsc/shell-capture.js";
16
- export { createLoader, redirect, type RouteHelpers, type RouteHandlers, layout, cache, middleware, revalidate, loader, loading, parallel, intercept, errorBoundary, notFoundBoundary, transition, } from "./route-definition.js";
17
- export type { RouteUseItem, LayoutUseItem, AllUseItems, UseItems, HandlerUseItem, } from "./route-types.js";
18
- export { createHandle, isHandle, type Handle } from "./handle.js";
19
- export { DEFAULT_DEFER_TIMEOUT_MS, type DeferOptions, type HandlePush, type HandlePushFn, } from "./defer.js";
20
- export { createVar, type ContextVar } from "./context-var.js";
21
- export { nonce } from "./rsc/nonce.js";
22
- export { Prerender, Passthrough, type PrerenderHandlerDefinition, type PassthroughHandlerDefinition, type PrerenderOptions, type BuildContext, type StaticBuildContext, type GetParamsContext, type PrerenderPassthroughResult, } from "./prerender.js";
23
- export { Static, type StaticHandlerDefinition, type StaticHandlerOptions, } from "./static-handler.js";
24
- export { urls, type PathHelpers, type PathOptions, type PartialPrerenderProps, type UrlPatterns, type IncludeOptions, type IncludeItem, type RouteResponse, type ProblemDetails, type ResponseHandler, type ResponseHandlerContext, type JsonResponseHandler, type TextResponseHandler, type JsonValue, type ResponsePathFn, type JsonResponsePathFn, type TextResponsePathFn, } from "./urls.js";
25
- export { createRouter, type Rango, type RootLayoutProps, type RouterRequestInput, } from "./router.js";
26
- export type { HandlerCacheConfig } from "./rsc/types.js";
27
- export { Meta } from "./handles/meta.js";
28
- export { Script, type ScriptConfig, type ScriptAttributes, } from "./handles/script.js";
29
- export { Breadcrumbs, type BreadcrumbItem } from "./handles/breadcrumbs.js";
30
- export type { PublicRequestContext as RequestContext } from "./server/request-context.js";
31
- import type { PublicRequestContext } from "./server/request-context.js";
32
- import type { DefaultEnv } from "./types/global-namespace.js";
33
- export type { RequestScope, ExecutionContext } from "./types/request-scope.js";
34
- export declare const getRequestContext: <TEnv = DefaultEnv>() => PublicRequestContext<TEnv>;
35
- export { cookies, headers, invalidateClientCache, keepClientCache, type CookieStore, type Cookie, type ReadonlyHeaders, } from "./server/cookie-store.js";
36
- export { cacheTag } from "./cache/cache-tag.js";
37
- export { updateTag, revalidateTag } from "./cache/tag-invalidation.js";
38
- export type { MetaDescriptor, MetaDescriptorBase } from "./router/types.js";
39
- export type { MiddlewareContext, CookieOptions, MiddlewareFn, } from "./router/middleware.js";
40
- export type { ScopedReverseFunction, ReverseFunction, ExtractLocalRoutes, ParamsFor, } from "./reverse.js";
41
- export { scopedReverse, createReverse } from "./reverse.js";
42
- export type { SearchSchema, SearchSchemaValue, ResolveSearchSchema, RouteSearchParams, RouteParams, } from "./search-params.js";
43
- export { createLocationState, type LocationStateDefinition, type LocationStateEntry, type LocationStateOptions, } from "./browser/react/location-state-shared.js";
44
- export { createConsoleSink } from "./router/telemetry.js";
45
- export { createOTelSink } from "./router/telemetry-otel.js";
46
- export { createOTelTracing } from "./router/telemetry-otel.js";
47
- export type { OTelTracer, OTelActiveSpanTracer, OTelSpan, OTelTracingOptions, } from "./router/telemetry-otel.js";
48
- export type { TelemetrySink, TelemetryEvent, RequestStartEvent, RequestEndEvent, RequestErrorEvent, LoaderStartEvent, LoaderEndEvent, LoaderErrorEvent, HandlerErrorEvent, CacheSegmentStatus, CacheSegmentSignal, CacheDecisionEvent, RevalidationDecisionEvent, RequestTimeoutEvent, OriginCheckRejectedEvent, } from "./router/telemetry.js";
49
- export type { RouterTracingConfig, TracePhase, TracePhaseToggles, TracingToggleOptions, } from "./router/tracing.js";
50
- export { RouterTimeoutError } from "./router/timeout.js";
51
- export type { RouterTimeouts, TimeoutPhase, TimeoutContext, } from "./router/timeout.js";
@@ -1 +0,0 @@
1
- export declare const INTERNAL_RANGO_DEBUG: boolean;
@@ -1,193 +0,0 @@
1
- /**
2
- * LoaderStore — shared subscription model for `useLoader` / `useFetchLoader`.
3
- *
4
- * Each bucket key gets one entry that holds the latest committed snapshot plus a
5
- * set of listeners. Snapshots are frozen and replaced atomically on mutation, so
6
- * subscribers can compare snapshot identity and avoid unnecessary updates
7
- * between real changes.
8
- *
9
- * The bucket key is `loader.$$id` by default, or `loader.$$id + key` when the
10
- * hook is given an explicit client refresh `key`. Multiple buckets belonging to
11
- * the same loader form a family (indexed by `loader.$$id`) so a navigation /
12
- * route-context reset can clear them all at once via `clearFamily`.
13
- *
14
- * Mutations that come in for an old request id (e.g. a slow response that
15
- * resolves after a newer load() was issued, or after a navigation cleared the
16
- * entry) are silently dropped. `reserveRequestId` is the only way to claim the
17
- * "latest" slot; `clear` bumps it too so pre-navigation in-flight loads cannot
18
- * commit into the new route's context.
19
- *
20
- * Bucket lifecycle differs by registration:
21
- * - Sticky buckets (a route-registered reader subscribed at least once) keep
22
- * their entry after the last subscriber leaves so an in-flight load() can
23
- * still commit on remount; they reset on navigation via `clearFamily`.
24
- * - Ephemeral buckets (only ever subscribed by readers with no route context,
25
- * i.e. keyed `useFetchLoader` of an unregistered loader) have no
26
- * route-context reset trigger, so they are reference-counted: dropped once
27
- * the last subscriber unsubscribes. The drop is deferred to a microtask and
28
- * cancelled on resubscribe so a StrictMode / transition remount does not
29
- * reclaim a bucket that is about to be reused, and is held until any
30
- * in-flight load settles.
31
- *
32
- * The store is intentionally module-level: each browser tab is its own JS
33
- * realm, so there is no cross-request pollution. Server renders never mutate
34
- * the store — the hook falls back to `OutletContext.loaderData`.
35
- */
36
- export interface LoaderEntry<T = unknown> {
37
- readonly value: T | undefined;
38
- /**
39
- * Whether a load has committed a value to this bucket. Distinguishes a
40
- * committed `null`/`undefined` result from "never loaded", so a loader that
41
- * resolves to a falsy value is not mistaken for an empty bucket and is not
42
- * overridden by the server-seeded context value.
43
- */
44
- readonly hasValue: boolean;
45
- readonly error: Error | null;
46
- readonly isLoading: boolean;
47
- /** Identifies the request that produced this snapshot. 0 means "no request". */
48
- readonly requestId: number;
49
- }
50
- /**
51
- * Options for `subscribe`.
52
- */
53
- export interface SubscribeOptions {
54
- /**
55
- * Family id (`loader.$$id`) this bucket belongs to. `clearFamily` uses it to
56
- * reach every keyed bucket of the same loader. Defaults to the bucket key.
57
- */
58
- loaderId?: string;
59
- /**
60
- * When true, this subscription is from a reader with no route context (keyed
61
- * `useFetchLoader` of an unregistered loader). Such buckets have no
62
- * route-context reset trigger and are reference-counted instead. A bucket
63
- * becomes sticky for the rest of its life as soon as any non-ephemeral
64
- * subscriber attaches, and from then on resets via `clearFamily`.
65
- */
66
- ephemeral?: boolean;
67
- /**
68
- * Cross-loader refresh group name(s). Tags this bucket so `refreshGroups(name)`
69
- * can refresh it alongside buckets of other loaders. A bucket may be tagged
70
- * with several group names at once (pass an array); it is then refreshed when
71
- * ANY of its groups is refreshed. Group membership follows subscriber presence:
72
- * a bucket leaves a group when that group's last subscriber unsubscribes.
73
- */
74
- group?: string | string[];
75
- /**
76
- * Plain-GET refresh thunk used by `refreshGroups`. Provided alongside `group`.
77
- * Refreshes this bucket in place (no params/body) and rejects on failure.
78
- */
79
- refetch?: () => Promise<void>;
80
- }
81
- export declare class LoaderStore {
82
- private readonly entries;
83
- /** loader.$$id -> set of bucket keys, so clearFamily() can reach every bucket. */
84
- private readonly families;
85
- /** refresh group name -> set of bucket keys, for refreshGroups(). */
86
- private readonly groups;
87
- private getOrCreate;
88
- private registerFamily;
89
- /**
90
- * Subscribe to entry changes for `bucketKey`.
91
- * Returns an unsubscribe function. A sticky bucket's entry is kept around even
92
- * after the last subscriber leaves so that an in-flight `load()` can still
93
- * commit if the consumer remounts. An ephemeral bucket is dropped once its
94
- * last subscriber leaves (deferred, see maybeScheduleRefcountClear).
95
- */
96
- subscribe(bucketKey: string, cb: () => void, options?: SubscribeOptions): () => void;
97
- private addToGroup;
98
- private releaseGroup;
99
- /** Remove a bucket from every group it belongs to (used when it is dropped). */
100
- private removeFromAllGroups;
101
- /**
102
- * Refresh every currently-mounted bucket tagged with ANY of the given group
103
- * names, with a plain GET (no params/body). Accepts a single name or an array
104
- * of names. A bucket that belongs to more than one of the named groups is
105
- * refreshed exactly once (members are unioned and deduped by bucket key), as
106
- * are multiple reads of one bucket. Resolves when all refreshes settle; rejects
107
- * with an `AggregateError` of the failures if any member fails — each failing
108
- * member also records its error on its own snapshot.
109
- */
110
- refreshGroups(groups: string | string[]): Promise<void>;
111
- /**
112
- * Schedule a deferred drop for an ad-hoc (never-sticky) bucket whose last
113
- * subscriber just left. Deferred to a microtask so a StrictMode / transition
114
- * remount that resubscribes in the same tick cancels it.
115
- */
116
- private maybeScheduleRefcountClear;
117
- /** Remove a bucket entry entirely and prune it from its family/group indexes. */
118
- private dropBucket;
119
- /** Drop an ephemeral bucket that settled with no subscribers left. */
120
- private dropIfSettled;
121
- /**
122
- * Returns the current snapshot for `bucketKey`. Stable reference between
123
- * mutations — subscribers rely on this to avoid spurious re-renders.
124
- * Returns `EMPTY_SNAPSHOT` (a singleton) when the entry has never been
125
- * mutated or has been cleared.
126
- */
127
- getSnapshot(bucketKey: string): LoaderEntry;
128
- /**
129
- * Reserve a fresh request id for an upcoming `load()` call. The returned id
130
- * is the new "latest"; any older in-flight requests will fail their gating
131
- * check on `finishData` / `finishError` / `finishLoading` and be dropped.
132
- *
133
- * Callers should follow with `beginRequest(id, requestId)` to flip the
134
- * loading flag on AND clear any leftover error from a previous attempt
135
- * — the latter matters for `throwOnError: false` consumers, which would
136
- * otherwise keep showing the stale error throughout the retry.
137
- */
138
- reserveRequestId(bucketKey: string): number;
139
- /**
140
- * Mark the request as in-flight: `isLoading = true`, `error = null`.
141
- * Combines the two operations so a retry doesn't render the previous
142
- * error during the new request. Gated on `requestId === latestRequestId`
143
- * for symmetry with the other mutators.
144
- */
145
- beginRequest(bucketKey: string, requestId: number): void;
146
- /**
147
- * Commit a successful result. No-op if `requestId` is not the latest
148
- * (a newer `load()` was issued or `clear()` ran). Clearing `error` is
149
- * intentional: a successful refetch should hide the previous failure.
150
- */
151
- finishData<T>(bucketKey: string, requestId: number, value: T): void;
152
- /**
153
- * Commit an error. Preserves the last good `value` so consumers can keep
154
- * showing previous data while displaying the error if they choose. No-op
155
- * if `requestId` is not the latest.
156
- */
157
- finishError(bucketKey: string, requestId: number, error: Error): void;
158
- /**
159
- * Update loading flag. Gated on `requestId` to fix the race where an old
160
- * load() finishes after a new one started — its `setLoading(false)` would
161
- * otherwise hide the new request's spinner.
162
- */
163
- setLoading(bucketKey: string, requestId: number, isLoading: boolean): void;
164
- /**
165
- * Reset a single bucket entry. Bumps `latestRequestId` so any in-flight
166
- * `load()` whose promise is still pending will fail its gate when it resolves
167
- * and be dropped — prevents pre-navigation loads from clobbering the new
168
- * route's context. The entry itself is kept (sticky-bucket semantics).
169
- */
170
- clear(bucketKey: string): void;
171
- /**
172
- * Reset every sticky bucket belonging to `loaderId`. Called on navigation /
173
- * route-context change: all route-registered reads of the loader (keyed or
174
- * not) drop back to seeding from fresh `loaderData`. Ephemeral buckets are
175
- * intentionally left alone — they are governed by subscriber refcount, so a
176
- * persistent keyed reader outside the outlet keeps its value across a
177
- * navigation rather than blanking out.
178
- */
179
- clearFamily(loaderId: string): void;
180
- private notify;
181
- /**
182
- * Test-only escape hatch. Drops every entry. Production code should never
183
- * call this; the store is process-scoped and lives for the tab's lifetime.
184
- * @internal
185
- */
186
- reset(): void;
187
- }
188
- /**
189
- * Module-level singleton. Each browser tab gets its own; SSR never mutates it.
190
- * The hook falls through to `OutletContext.loaderData` during the server render.
191
- */
192
- export declare const loaderStore: LoaderStore;
193
- export declare const EMPTY_LOADER_SNAPSHOT: LoaderEntry;
@@ -1,18 +0,0 @@
1
- /**
2
- * @rangojs/router/loader (client version)
3
- *
4
- * Client-only stub for createLoader. Returns a minimal loader definition
5
- * ({ __brand, $$id }) that can be passed to hooks like useLoader.
6
- * The actual loader function is not included -- it only exists on the server.
7
- *
8
- * For export-only loader files, the Vite plugin replaces the entire file with
9
- * object literals (bypassing this function). Those stubs only contain
10
- * { __brand, $$id }.
11
- * This function only runs when loaders are in mixed files (not export-only).
12
- *
13
- * The $$id is injected by the Vite exposeInternalIds plugin.
14
- */
15
- import type { FetchableLoaderOptions, LoaderDefinition, LoaderFn } from "./types.js";
16
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
17
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>, fetchable: true): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
18
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>, options: FetchableLoaderOptions): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
@@ -1,18 +0,0 @@
1
- /**
2
- * rsc-router/loader (RSC/server version)
3
- *
4
- * Server-side createLoader implementation with full loader functionality.
5
- * Only used in react-server context via export conditions.
6
- *
7
- * For non-fetchable loaders: returns a loader definition with fn included
8
- * For fetchable loaders: stores fn in registry and returns a serializable loader
9
- *
10
- * The $$id is injected by the Vite exposeInternalIds plugin as a hidden parameter.
11
- * Users don't need to pass any name - IDs are auto-generated from file path.
12
- */
13
- import type { FetchableLoaderOptions, LoaderDefinition, LoaderFn } from "./types.js";
14
- import { getFetchableLoader } from "./server/fetchable-loader-store.js";
15
- export { getFetchableLoader };
16
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
17
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>, fetchable: true): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
18
- export declare function createLoader<T>(fn: LoaderFn<T, Record<string, string | undefined>, any>, options: FetchableLoaderOptions): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
@@ -1 +0,0 @@
1
- export declare function missingInjectedIdError(kind: "Loader" | "Handle", fnName: "createLoader" | "createHandle"): Error;
@@ -1,12 +0,0 @@
1
- import { type Context, type ReactNode } from "react";
2
- import type { ResolvedSegment } from "./types";
3
- export interface OutletContextValue {
4
- content: ReactNode;
5
- parallel?: ResolvedSegment[];
6
- segment?: ResolvedSegment;
7
- loaderData?: Record<string, any>;
8
- parent?: OutletContextValue | null;
9
- /** Loading component for Suspense fallback (from segment's loading() definition) */
10
- loading?: ReactNode;
11
- }
12
- export declare const OutletContext: Context<OutletContextValue | null>;
@@ -1,12 +0,0 @@
1
- import { type ReactNode } from "react";
2
- import type { ResolvedSegment } from "./types.js";
3
- /**
4
- * Outlet content provider — stores parent context for useLoader chain walking.
5
- */
6
- export declare function OutletProvider({ content, parallel, segment, loaderData, children, }: {
7
- content: ReactNode;
8
- parallel?: ResolvedSegment[];
9
- segment?: ResolvedSegment;
10
- loaderData?: Record<string, any>;
11
- children: ReactNode;
12
- }): ReactNode;