@rangojs/router 0.0.0-experimental.9c9afef3 → 0.0.0-experimental.a014d2b7

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 (402) hide show
  1. package/AGENTS.md +8 -0
  2. package/README.md +245 -49
  3. package/dist/bin/rango.js +440 -133
  4. package/dist/testing/vitest.js +82 -0
  5. package/dist/vite/index.js +3373 -1176
  6. package/dist/vite/index.js.bak +5448 -0
  7. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  8. package/package.json +68 -14
  9. package/skills/api-client/SKILL.md +211 -0
  10. package/skills/breadcrumbs/SKILL.md +64 -2
  11. package/skills/bundle-analysis/SKILL.md +159 -0
  12. package/skills/cache-guide/SKILL.md +224 -32
  13. package/skills/caching/SKILL.md +279 -17
  14. package/skills/composability/SKILL.md +27 -3
  15. package/skills/css/SKILL.md +76 -0
  16. package/skills/debug-manifest/SKILL.md +4 -2
  17. package/skills/document-cache/SKILL.md +78 -55
  18. package/skills/handler-use/SKILL.md +364 -0
  19. package/skills/hooks/SKILL.md +250 -30
  20. package/skills/host-router/SKILL.md +83 -23
  21. package/skills/i18n/SKILL.md +276 -0
  22. package/skills/intercept/SKILL.md +87 -18
  23. package/skills/layout/SKILL.md +35 -9
  24. package/skills/links/SKILL.md +249 -17
  25. package/skills/loader/SKILL.md +235 -9
  26. package/skills/middleware/SKILL.md +52 -13
  27. package/skills/migrate-nextjs/SKILL.md +584 -0
  28. package/skills/migrate-react-router/SKILL.md +771 -0
  29. package/skills/mime-routes/SKILL.md +28 -1
  30. package/skills/observability/SKILL.md +172 -0
  31. package/skills/parallel/SKILL.md +77 -7
  32. package/skills/prerender/SKILL.md +172 -125
  33. package/skills/rango/SKILL.md +251 -22
  34. package/skills/react-compiler/SKILL.md +168 -0
  35. package/skills/response-routes/SKILL.md +123 -48
  36. package/skills/route/SKILL.md +70 -5
  37. package/skills/router-setup/SKILL.md +65 -8
  38. package/skills/scripts/SKILL.md +179 -0
  39. package/skills/server-actions/SKILL.md +775 -0
  40. package/skills/streams-and-websockets/SKILL.md +283 -0
  41. package/skills/tailwind/SKILL.md +27 -3
  42. package/skills/testing/SKILL.md +130 -0
  43. package/skills/testing/bindings.md +103 -0
  44. package/skills/testing/cache-prerender.md +127 -0
  45. package/skills/testing/client-components.md +124 -0
  46. package/skills/testing/e2e-parity.md +125 -0
  47. package/skills/testing/flight.md +91 -0
  48. package/skills/testing/handles.md +129 -0
  49. package/skills/testing/loader.md +128 -0
  50. package/skills/testing/middleware.md +99 -0
  51. package/skills/testing/render-handler.md +122 -0
  52. package/skills/testing/response-routes.md +95 -0
  53. package/skills/testing/reverse-and-types.md +84 -0
  54. package/skills/testing/server-actions.md +107 -0
  55. package/skills/testing/server-tree.md +128 -0
  56. package/skills/testing/setup.md +123 -0
  57. package/skills/typesafety/SKILL.md +322 -29
  58. package/skills/use-cache/SKILL.md +57 -14
  59. package/skills/view-transitions/SKILL.md +337 -0
  60. package/src/__augment-tests__/augment.ts +81 -0
  61. package/src/__augment-tests__/augmented.check.ts +116 -0
  62. package/src/__internal.ts +1 -66
  63. package/src/browser/action-coordinator.ts +53 -36
  64. package/src/browser/action-fence.ts +47 -0
  65. package/src/browser/app-shell.ts +39 -0
  66. package/src/browser/app-version.ts +14 -0
  67. package/src/browser/connection-warmup.ts +134 -0
  68. package/src/browser/cookie-name.ts +140 -0
  69. package/src/browser/event-controller.ts +192 -150
  70. package/src/browser/history-state.ts +21 -0
  71. package/src/browser/index.ts +3 -3
  72. package/src/browser/invalidate-client-cache.ts +52 -0
  73. package/src/browser/navigation-bridge.ts +131 -30
  74. package/src/browser/navigation-client.ts +186 -100
  75. package/src/browser/navigation-store-handle.ts +38 -0
  76. package/src/browser/navigation-store.ts +157 -74
  77. package/src/browser/navigation-transaction.ts +9 -59
  78. package/src/browser/network-error-handler.ts +34 -7
  79. package/src/browser/partial-update.ts +165 -112
  80. package/src/browser/prefetch/cache.ts +205 -62
  81. package/src/browser/prefetch/fetch.ts +347 -39
  82. package/src/browser/prefetch/queue.ts +42 -8
  83. package/src/browser/rango-state.ts +158 -76
  84. package/src/browser/react/Link.tsx +102 -15
  85. package/src/browser/react/NavigationProvider.tsx +295 -119
  86. package/src/browser/react/ScrollRestoration.tsx +10 -6
  87. package/src/browser/react/context.ts +7 -2
  88. package/src/browser/react/deferred-handle-resolution.ts +75 -0
  89. package/src/browser/react/filter-segment-order.ts +66 -7
  90. package/src/browser/react/index.ts +0 -48
  91. package/src/browser/react/location-state-shared.ts +178 -8
  92. package/src/browser/react/location-state.ts +39 -14
  93. package/src/browser/react/use-action.ts +6 -15
  94. package/src/browser/react/use-handle.ts +23 -69
  95. package/src/browser/react/use-href.tsx +8 -1
  96. package/src/browser/react/use-link-status.ts +33 -8
  97. package/src/browser/react/use-navigation.ts +32 -7
  98. package/src/browser/react/use-params.ts +20 -10
  99. package/src/browser/react/use-reverse.ts +106 -0
  100. package/src/browser/react/use-router.ts +46 -11
  101. package/src/browser/react/use-search-params.ts +0 -5
  102. package/src/browser/react/use-segments.ts +11 -21
  103. package/src/browser/response-adapter.ts +99 -8
  104. package/src/browser/rsc-router.tsx +114 -24
  105. package/src/browser/scroll-restoration.ts +37 -22
  106. package/src/browser/segment-reconciler.ts +36 -14
  107. package/src/browser/segment-structure-assert.ts +2 -2
  108. package/src/browser/server-action-bridge.ts +222 -72
  109. package/src/browser/types.ts +102 -12
  110. package/src/browser/validate-redirect-origin.ts +43 -16
  111. package/src/build/collect-fallback-refs.ts +107 -0
  112. package/src/build/generate-manifest.ts +65 -40
  113. package/src/build/generate-route-types.ts +5 -1
  114. package/src/build/index.ts +8 -2
  115. package/src/build/prefix-tree-utils.ts +123 -0
  116. package/src/build/route-trie.ts +165 -36
  117. package/src/build/route-types/ast-route-extraction.ts +15 -8
  118. package/src/build/route-types/codegen.ts +16 -5
  119. package/src/build/route-types/include-resolution.ts +125 -24
  120. package/src/build/route-types/param-extraction.ts +6 -3
  121. package/src/build/route-types/per-module-writer.ts +22 -6
  122. package/src/build/route-types/router-processing.ts +260 -94
  123. package/src/build/route-types/scan-filter.ts +9 -2
  124. package/src/build/route-types/source-scan.ts +216 -0
  125. package/src/build/runtime-discovery.ts +9 -20
  126. package/src/cache/cache-error.ts +104 -0
  127. package/src/cache/cache-key-utils.ts +29 -13
  128. package/src/cache/cache-policy.ts +108 -34
  129. package/src/cache/cache-runtime.ts +224 -41
  130. package/src/cache/cache-scope.ts +188 -82
  131. package/src/cache/cache-tag.ts +103 -0
  132. package/src/cache/cf/cf-base64.ts +33 -0
  133. package/src/cache/cf/cf-cache-constants.ts +127 -0
  134. package/src/cache/cf/cf-cache-store.ts +1989 -378
  135. package/src/cache/cf/cf-cache-types.ts +349 -0
  136. package/src/cache/cf/cf-kv-utils.ts +46 -0
  137. package/src/cache/cf/cf-tag-marker-memo.ts +105 -0
  138. package/src/cache/cf/index.ts +6 -16
  139. package/src/cache/document-cache.ts +89 -21
  140. package/src/cache/handle-snapshot.ts +70 -0
  141. package/src/cache/index.ts +10 -20
  142. package/src/cache/memory-segment-store.ts +136 -37
  143. package/src/cache/profile-registry.ts +46 -31
  144. package/src/cache/read-through-swr.ts +56 -12
  145. package/src/cache/segment-codec.ts +9 -17
  146. package/src/cache/tag-invalidation.ts +230 -0
  147. package/src/cache/types.ts +37 -100
  148. package/src/client.rsc.tsx +44 -21
  149. package/src/client.tsx +119 -290
  150. package/src/cloudflare/index.ts +11 -0
  151. package/src/cloudflare/tracing.ts +109 -0
  152. package/src/component-utils.ts +19 -0
  153. package/src/components/DefaultDocument.tsx +8 -2
  154. package/src/context-var.ts +18 -6
  155. package/src/decode-loader-results.ts +52 -0
  156. package/src/defer.ts +196 -0
  157. package/src/deps/ssr.ts +0 -1
  158. package/src/encode-kv.ts +49 -0
  159. package/src/errors.ts +30 -4
  160. package/src/escape-script.ts +52 -0
  161. package/src/handle.ts +70 -22
  162. package/src/handles/MetaTags.tsx +62 -19
  163. package/src/handles/Scripts.tsx +183 -0
  164. package/src/handles/breadcrumbs.ts +37 -8
  165. package/src/handles/is-thenable.ts +19 -0
  166. package/src/handles/meta.ts +51 -40
  167. package/src/handles/script.ts +244 -0
  168. package/src/host/cookie-handler.ts +9 -60
  169. package/src/host/errors.ts +0 -24
  170. package/src/host/index.ts +8 -2
  171. package/src/host/pattern-matcher.ts +23 -52
  172. package/src/host/router.ts +107 -99
  173. package/src/host/testing.ts +40 -27
  174. package/src/host/types.ts +37 -4
  175. package/src/host/utils.ts +1 -1
  176. package/src/href-client.ts +137 -22
  177. package/src/index.rsc.ts +99 -13
  178. package/src/index.ts +139 -19
  179. package/src/internal-debug.ts +11 -10
  180. package/src/loader-store.ts +500 -0
  181. package/src/loader.rsc.ts +20 -13
  182. package/src/loader.ts +12 -11
  183. package/src/missing-id-error.ts +68 -0
  184. package/src/outlet-context.ts +1 -1
  185. package/src/outlet-provider.tsx +1 -5
  186. package/src/prerender/param-hash.ts +16 -16
  187. package/src/prerender/store.ts +37 -41
  188. package/src/prerender.ts +198 -82
  189. package/src/redirect-origin.ts +100 -0
  190. package/src/regex-escape.ts +8 -0
  191. package/src/render-error-thrower.tsx +20 -0
  192. package/src/response-utils.ts +62 -0
  193. package/src/reverse.ts +65 -15
  194. package/src/root-error-boundary.tsx +1 -19
  195. package/src/route-content-wrapper.tsx +19 -77
  196. package/src/route-definition/dsl-helpers.ts +461 -304
  197. package/src/route-definition/helper-factories.ts +28 -140
  198. package/src/route-definition/helpers-types.ts +143 -69
  199. package/src/route-definition/index.ts +4 -2
  200. package/src/route-definition/redirect.ts +51 -10
  201. package/src/route-definition/resolve-handler-use.ts +160 -0
  202. package/src/route-definition/use-item-types.ts +29 -0
  203. package/src/route-map-builder.ts +0 -16
  204. package/src/route-types.ts +37 -46
  205. package/src/router/basename.ts +14 -0
  206. package/src/router/content-negotiation.ts +164 -17
  207. package/src/router/error-handling.ts +45 -18
  208. package/src/router/find-match.ts +44 -23
  209. package/src/router/handler-context.ts +52 -31
  210. package/src/router/instrument.ts +350 -0
  211. package/src/router/intercept-resolution.ts +48 -24
  212. package/src/router/lazy-includes.ts +15 -52
  213. package/src/router/loader-resolution.ts +268 -56
  214. package/src/router/logging.ts +0 -6
  215. package/src/router/manifest.ts +40 -42
  216. package/src/router/match-api.ts +124 -204
  217. package/src/router/match-context.ts +0 -22
  218. package/src/router/match-handlers.ts +58 -58
  219. package/src/router/match-middleware/background-revalidation.ts +40 -24
  220. package/src/router/match-middleware/cache-lookup.ts +170 -276
  221. package/src/router/match-middleware/cache-store.ts +64 -52
  222. package/src/router/match-middleware/intercept-resolution.ts +0 -22
  223. package/src/router/match-middleware/segment-resolution.ts +45 -14
  224. package/src/router/match-pipelines.ts +1 -42
  225. package/src/router/match-result.ts +87 -39
  226. package/src/router/metrics.ts +0 -34
  227. package/src/router/middleware-types.ts +7 -140
  228. package/src/router/middleware.ts +266 -169
  229. package/src/router/navigation-snapshot.ts +131 -0
  230. package/src/router/params-util.ts +23 -0
  231. package/src/router/pattern-matching.ts +132 -90
  232. package/src/router/prefetch-cache-ttl.ts +51 -0
  233. package/src/router/prerender-match.ts +195 -56
  234. package/src/router/preview-match.ts +32 -102
  235. package/src/router/request-classification.ts +276 -0
  236. package/src/router/revalidation.ts +123 -73
  237. package/src/router/route-snapshot.ts +244 -0
  238. package/src/router/router-context.ts +3 -28
  239. package/src/router/router-interfaces.ts +115 -35
  240. package/src/router/router-options.ts +172 -15
  241. package/src/router/router-registry.ts +2 -5
  242. package/src/router/segment-resolution/fresh.ts +162 -84
  243. package/src/router/segment-resolution/helpers.ts +86 -6
  244. package/src/router/segment-resolution/loader-cache.ts +76 -39
  245. package/src/router/segment-resolution/revalidation.ts +351 -321
  246. package/src/router/segment-resolution/static-store.ts +19 -5
  247. package/src/router/segment-resolution/streamed-handler-telemetry.ts +52 -0
  248. package/src/router/segment-resolution/view-transition-default.ts +56 -0
  249. package/src/router/segment-resolution.ts +5 -1
  250. package/src/router/segment-wrappers.ts +6 -5
  251. package/src/router/state-cookie-name.ts +33 -0
  252. package/src/router/substitute-pattern-params.ts +56 -0
  253. package/src/router/telemetry-otel.ts +161 -199
  254. package/src/router/telemetry.ts +96 -19
  255. package/src/router/timeout.ts +0 -20
  256. package/src/router/tracing.ts +206 -0
  257. package/src/router/trie-matching.ts +163 -59
  258. package/src/router/types.ts +9 -63
  259. package/src/router/url-params.ts +44 -0
  260. package/src/router.ts +157 -54
  261. package/src/rsc/handler-context.ts +3 -2
  262. package/src/rsc/handler.ts +655 -529
  263. package/src/rsc/helpers.ts +168 -46
  264. package/src/rsc/index.ts +2 -5
  265. package/src/rsc/json-route-result.ts +38 -0
  266. package/src/rsc/loader-fetch.ts +122 -31
  267. package/src/rsc/manifest-init.ts +33 -42
  268. package/src/rsc/origin-guard.ts +39 -25
  269. package/src/rsc/progressive-enhancement.ts +131 -14
  270. package/src/rsc/redirect-guard.ts +99 -0
  271. package/src/rsc/response-cache-serve.ts +238 -0
  272. package/src/rsc/response-error.ts +79 -12
  273. package/src/rsc/response-route-handler.ts +99 -189
  274. package/src/rsc/rsc-rendering.ts +109 -74
  275. package/src/rsc/runtime-warnings.ts +23 -10
  276. package/src/rsc/server-action.ts +287 -115
  277. package/src/rsc/ssr-setup.ts +18 -2
  278. package/src/rsc/transition-gate.ts +89 -0
  279. package/src/rsc/types.ts +29 -9
  280. package/src/runtime-env.ts +18 -0
  281. package/src/search-params.ts +35 -30
  282. package/src/segment-content-promise.ts +67 -0
  283. package/src/segment-loader-promise.ts +149 -0
  284. package/src/segment-system.tsx +236 -202
  285. package/src/serialize.ts +243 -0
  286. package/src/server/context.ts +224 -52
  287. package/src/server/cookie-parse.ts +32 -0
  288. package/src/server/cookie-store.ts +80 -5
  289. package/src/server/handle-store.ts +40 -38
  290. package/src/server/loader-registry.ts +38 -46
  291. package/src/server/request-context.ts +401 -173
  292. package/src/ssr/index.tsx +24 -16
  293. package/src/static-handler.ts +27 -18
  294. package/src/testing/cache-status.ts +162 -0
  295. package/src/testing/collect-handle.ts +40 -0
  296. package/src/testing/dispatch.ts +701 -0
  297. package/src/testing/dom.entry.ts +22 -0
  298. package/src/testing/e2e/fixture.ts +188 -0
  299. package/src/testing/e2e/index.ts +128 -0
  300. package/src/testing/e2e/matchers.ts +35 -0
  301. package/src/testing/e2e/page-helpers.ts +272 -0
  302. package/src/testing/e2e/parity.ts +387 -0
  303. package/src/testing/e2e/server.ts +195 -0
  304. package/src/testing/flight-matchers.ts +97 -0
  305. package/src/testing/flight-normalize.ts +11 -0
  306. package/src/testing/flight-runtime.d.ts +57 -0
  307. package/src/testing/flight-tree.ts +682 -0
  308. package/src/testing/flight.entry.ts +52 -0
  309. package/src/testing/flight.ts +257 -0
  310. package/src/testing/generated-routes.ts +183 -0
  311. package/src/testing/index.ts +105 -0
  312. package/src/testing/internal/context.ts +371 -0
  313. package/src/testing/internal/flight-client-globals.ts +30 -0
  314. package/src/testing/internal/seed-vars.ts +54 -0
  315. package/src/testing/render-handler.ts +357 -0
  316. package/src/testing/render-route.tsx +581 -0
  317. package/src/testing/run-loader.ts +385 -0
  318. package/src/testing/run-middleware.ts +205 -0
  319. package/src/testing/run-transition-when.ts +164 -0
  320. package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
  321. package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
  322. package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
  323. package/src/testing/vitest-stubs/version.ts +5 -0
  324. package/src/testing/vitest.ts +305 -0
  325. package/src/theme/ThemeProvider.tsx +20 -58
  326. package/src/theme/ThemeScript.tsx +7 -9
  327. package/src/theme/constants.ts +52 -13
  328. package/src/theme/index.ts +0 -7
  329. package/src/theme/theme-context.ts +1 -5
  330. package/src/theme/theme-script.ts +22 -21
  331. package/src/theme/use-theme.ts +0 -3
  332. package/src/types/boundaries.ts +0 -35
  333. package/src/types/cache-types.ts +17 -8
  334. package/src/types/error-types.ts +30 -90
  335. package/src/types/global-namespace.ts +54 -41
  336. package/src/types/handler-context.ts +125 -71
  337. package/src/types/index.ts +3 -10
  338. package/src/types/loader-types.ts +40 -11
  339. package/src/types/request-scope.ts +112 -0
  340. package/src/types/route-config.ts +6 -50
  341. package/src/types/route-entry.ts +12 -7
  342. package/src/types/segments.ts +136 -15
  343. package/src/urls/include-helper.ts +33 -70
  344. package/src/urls/index.ts +1 -11
  345. package/src/urls/path-helper-types.ts +68 -18
  346. package/src/urls/path-helper.ts +57 -111
  347. package/src/urls/pattern-types.ts +48 -19
  348. package/src/urls/response-types.ts +25 -22
  349. package/src/urls/type-extraction.ts +58 -139
  350. package/src/urls/urls-function.ts +1 -19
  351. package/src/use-loader.tsx +346 -89
  352. package/src/vite/debug.ts +185 -0
  353. package/src/vite/discovery/bundle-postprocess.ts +36 -38
  354. package/src/vite/discovery/discover-routers.ts +130 -85
  355. package/src/vite/discovery/discovery-errors.ts +194 -0
  356. package/src/vite/discovery/gate-state.ts +171 -0
  357. package/src/vite/discovery/prerender-collection.ts +214 -132
  358. package/src/vite/discovery/route-types-writer.ts +40 -84
  359. package/src/vite/discovery/self-gen-tracking.ts +27 -1
  360. package/src/vite/discovery/state.ts +57 -4
  361. package/src/vite/discovery/virtual-module-codegen.ts +14 -34
  362. package/src/vite/index.ts +6 -0
  363. package/src/vite/inject-client-debug.ts +36 -0
  364. package/src/vite/plugin-types.ts +178 -5
  365. package/src/vite/plugins/cjs-to-esm.ts +16 -19
  366. package/src/vite/plugins/client-ref-dedup.ts +16 -11
  367. package/src/vite/plugins/client-ref-hashing.ts +28 -15
  368. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  369. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  370. package/src/vite/plugins/cloudflare-protocol-stub.ts +194 -0
  371. package/src/vite/plugins/expose-action-id.ts +48 -95
  372. package/src/vite/plugins/expose-id-utils.ts +96 -51
  373. package/src/vite/plugins/expose-ids/export-analysis.ts +101 -34
  374. package/src/vite/plugins/expose-ids/handler-transform.ts +15 -64
  375. package/src/vite/plugins/expose-ids/loader-transform.ts +14 -24
  376. package/src/vite/plugins/expose-ids/router-transform.ts +118 -29
  377. package/src/vite/plugins/expose-internal-ids.ts +553 -317
  378. package/src/vite/plugins/performance-tracks.ts +64 -170
  379. package/src/vite/plugins/refresh-cmd.ts +89 -27
  380. package/src/vite/plugins/use-cache-transform.ts +73 -83
  381. package/src/vite/plugins/version-injector.ts +40 -29
  382. package/src/vite/plugins/version-plugin.ts +37 -40
  383. package/src/vite/plugins/virtual-entries.ts +39 -25
  384. package/src/vite/rango.ts +118 -114
  385. package/src/vite/router-discovery.ts +941 -142
  386. package/src/vite/utils/ast-handler-extract.ts +26 -35
  387. package/src/vite/utils/banner.ts +1 -1
  388. package/src/vite/utils/bundle-analysis.ts +10 -15
  389. package/src/vite/utils/client-chunks.ts +184 -0
  390. package/src/vite/utils/directive-prologue.ts +40 -0
  391. package/src/vite/utils/forward-user-plugins.ts +171 -0
  392. package/src/vite/utils/manifest-utils.ts +4 -59
  393. package/src/vite/utils/package-resolution.ts +20 -52
  394. package/src/vite/utils/prerender-utils.ts +81 -34
  395. package/src/vite/utils/shared-utils.ts +92 -42
  396. package/src/browser/action-response-classifier.ts +0 -99
  397. package/src/browser/debug-channel.ts +0 -93
  398. package/src/browser/react/use-client-cache.ts +0 -58
  399. package/src/browser/shallow.ts +0 -40
  400. package/src/handles/index.ts +0 -7
  401. package/src/network-error-thrower.tsx +0 -23
  402. package/src/router/middleware-cookies.ts +0 -55
@@ -11,12 +11,18 @@ import {
11
11
  getContext,
12
12
  getNamePrefix,
13
13
  getUrlPrefix,
14
+ requireDslContext,
14
15
  type EntryData,
16
+ type EntryPropDatas,
17
+ type EntryPropSegments,
18
+ type HelperContext,
15
19
  type InterceptEntry,
20
+ type InterceptConfig,
16
21
  } from "../server/context";
17
22
  import { invariant } from "../errors";
23
+ import { validateUserRouteName } from "../route-name.js";
18
24
  import { isCachedFunction } from "../cache/taint.js";
19
- import { RSCRouterContext } from "../server/context";
25
+ import { RangoContext } from "../server/context";
20
26
  import { isStaticHandler } from "../static-handler.js";
21
27
  import RootLayout from "../server/root-layout";
22
28
  import type {
@@ -31,12 +37,13 @@ import type {
31
37
  ErrorBoundaryItem,
32
38
  NotFoundBoundaryItem,
33
39
  LayoutItem,
34
- WhenItem,
35
40
  CacheItem,
36
41
  TransitionItem,
37
42
  UseItems,
38
43
  } from "../route-types.js";
39
44
  import type { RouteHelpers } from "./helpers-types.js";
45
+ import { resolveHandlerUse, mergeHandlerUse } from "./resolve-handler-use.js";
46
+ import { ALL_USE_ITEM_TYPES } from "./use-item-types.js";
40
47
 
41
48
  /**
42
49
  * Check if an item contains routes (directly or inside nested structures like cache).
@@ -54,19 +61,111 @@ const hasRoutesInItem = (item: AllUseItems): boolean => {
54
61
  if (item.type === "layout" && item.uses) {
55
62
  return item.uses.some((child) => hasRoutesInItem(child));
56
63
  }
64
+ if (item.type === "middleware" && item.uses) {
65
+ return item.uses.some((child) => hasRoutesInItem(child));
66
+ }
57
67
  return false;
58
68
  };
59
69
 
70
+ /**
71
+ * Fresh empty collections shared by every from-scratch segment entry. Returns
72
+ * new arrays/objects per call so no two entries share mutable references.
73
+ * mountPath is intentionally NOT included here — each call site adds it from
74
+ * getUrlPrefix() where applicable: the route() and transition() helpers add
75
+ * none, while path() (which also builds a `type: "route"` entry) and the
76
+ * structural helpers (layout/cache/middleware/parallel) do.
77
+ */
78
+ const emptySegmentBase = (): EntryPropDatas &
79
+ EntryPropSegments & { loading: undefined } => ({
80
+ loading: undefined,
81
+ middleware: [],
82
+ revalidate: [],
83
+ errorBoundary: [],
84
+ notFoundBoundary: [],
85
+ layout: [],
86
+ parallel: {},
87
+ intercept: [],
88
+ loader: [],
89
+ });
90
+
91
+ /**
92
+ * Run a children/use callback as a nested scope, flatten the result, and assert
93
+ * every item is a valid use item. `kind` preserves the existing error wording
94
+ * ("use()" vs "children" callback).
95
+ */
96
+ function runAndValidateUseItems(
97
+ store: ReturnType<typeof getContext>,
98
+ namespace: string,
99
+ entry: EntryData,
100
+ cb: () => any,
101
+ label: string,
102
+ kind: "use" | "children",
103
+ ): AllUseItems[] {
104
+ const result = store.run(namespace, entry, cb)?.flat(3);
105
+ return validateUseItems(result, namespace, label, kind);
106
+ }
107
+
108
+ /** Assert an already-invoked, flattened callback result is a use-item array. */
109
+ function validateUseItems(
110
+ result: any,
111
+ namespace: string,
112
+ label: string,
113
+ kind: "use" | "children",
114
+ ): AllUseItems[] {
115
+ invariant(
116
+ Array.isArray(result) && result.every((item) => isValidUseItem(item)),
117
+ `${label}() ${kind === "use" ? "use()" : "children"} callback must return an array of use items [${namespace}]`,
118
+ );
119
+ return result as AllUseItems[];
120
+ }
121
+
122
+ /** True when a children/use result contains no routes (directly or nested). */
123
+ const isOrphan = (result: AllUseItems[]): boolean =>
124
+ !result.some((item) => item != null && hasRoutesInItem(item));
125
+
126
+ /**
127
+ * Register a routeless structural entry as an orphan sibling: clear its parent
128
+ * pointer so it leaves the middleware/parent-pointer chain (LOAD-BEARING — see
129
+ * docs/tree-structure.md) and push it onto the parent's layout[] so it renders
130
+ * as a wrapper. Used by cache()/middleware()/transition(); layout() runs extra
131
+ * validation and registers inline.
132
+ */
133
+ const attachOrphanSibling = (
134
+ parent: EntryData | null,
135
+ entry: EntryData,
136
+ ): void => {
137
+ entry.parent = null;
138
+ if (parent && "layout" in parent) parent.layout.push(entry);
139
+ };
140
+
141
+ /**
142
+ * Run `fn` with `ctx.parent` temporarily redirected to `temp` — a satellite
143
+ * entry that captures the attachments declared by a use() callback — restoring
144
+ * the original parent afterward, including on throw. loader()/intercept() each
145
+ * build their own tempParent shape (intercept keeps a loading get/set accessor
146
+ * and a captured-layouts array); this only centralizes the save/restore.
147
+ */
148
+ function withParent<T>(ctx: HelperContext, temp: EntryData, fn: () => T): T {
149
+ const original = ctx.parent;
150
+ ctx.parent = temp;
151
+ try {
152
+ return fn();
153
+ } finally {
154
+ ctx.parent = original;
155
+ }
156
+ }
157
+
60
158
  const revalidate: RouteHelpers<any, any>["revalidate"] = (fn) => {
61
- const ctx = getContext().getStore();
62
- if (!ctx) throw new Error("revalidate() must be called inside map()");
159
+ const { store, ctx } = requireDslContext(
160
+ "revalidate() must be called inside urls()",
161
+ );
63
162
 
64
163
  // Attach to last entry in stack
65
164
  const parent = ctx.parent;
66
165
  if (!parent || !("revalidate" in parent)) {
67
166
  invariant(false, "No parent entry available for revalidate()");
68
167
  }
69
- const name = `$${getContext().getNextIndex("revalidate")}`;
168
+ const name = `$${store.getNextIndex("revalidate")}`;
70
169
  parent.revalidate.push(fn);
71
170
  return { name, type: "revalidate" } as RevalidateItem;
72
171
  };
@@ -104,15 +203,16 @@ const revalidate: RouteHelpers<any, any>["revalidate"] = (fn) => {
104
203
  * ```
105
204
  */
106
205
  const errorBoundary: RouteHelpers<any, any>["errorBoundary"] = (fallback) => {
107
- const ctx = getContext().getStore();
108
- if (!ctx) throw new Error("errorBoundary() must be called inside map()");
206
+ const { store, ctx } = requireDslContext(
207
+ "errorBoundary() must be called inside urls()",
208
+ );
109
209
 
110
210
  // Attach to parent entry in stack
111
211
  const parent = ctx.parent;
112
212
  if (!parent || !("errorBoundary" in parent)) {
113
213
  invariant(false, "No parent entry available for errorBoundary()");
114
214
  }
115
- const name = `$${getContext().getNextIndex("errorBoundary")}`;
215
+ const name = `$${store.getNextIndex("errorBoundary")}`;
116
216
  parent.errorBoundary.push(fallback);
117
217
  return { name, type: "errorBoundary" } as ErrorBoundaryItem;
118
218
  };
@@ -151,46 +251,20 @@ const errorBoundary: RouteHelpers<any, any>["errorBoundary"] = (fallback) => {
151
251
  const notFoundBoundary: RouteHelpers<any, any>["notFoundBoundary"] = (
152
252
  fallback,
153
253
  ) => {
154
- const ctx = getContext().getStore();
155
- if (!ctx) throw new Error("notFoundBoundary() must be called inside map()");
254
+ const { store, ctx } = requireDslContext(
255
+ "notFoundBoundary() must be called inside urls()",
256
+ );
156
257
 
157
258
  // Attach to parent entry in stack
158
259
  const parent = ctx.parent;
159
260
  if (!parent || !("notFoundBoundary" in parent)) {
160
261
  invariant(false, "No parent entry available for notFoundBoundary()");
161
262
  }
162
- const name = `$${getContext().getNextIndex("notFoundBoundary")}`;
263
+ const name = `$${store.getNextIndex("notFoundBoundary")}`;
163
264
  parent.notFoundBoundary.push(fallback);
164
265
  return { name, type: "notFoundBoundary" } as NotFoundBoundaryItem;
165
266
  };
166
267
 
167
- /**
168
- * When helper - defines a condition for intercept activation
169
- *
170
- * Only valid inside intercept() use() callback. The when() function
171
- * is captured by the intercept and stored in its `when` array.
172
- * During soft navigation, all when() conditions must return true
173
- * for the intercept to activate.
174
- */
175
- const when: RouteHelpers<any, any>["when"] = (fn) => {
176
- const ctx = getContext().getStore();
177
- if (!ctx) throw new Error("when() must be called inside intercept()");
178
-
179
- // The when() function needs to be captured by the intercept's tempParent
180
- // which should have a `when` array. If not present, we're not inside intercept()
181
- const parent = ctx.parent as any;
182
- if (!parent || !("when" in parent)) {
183
- invariant(
184
- false,
185
- "when() can only be used inside intercept() use() callback",
186
- );
187
- }
188
-
189
- const name = `$${getContext().getNextIndex("when")}`;
190
- parent.when.push(fn);
191
- return { name, type: "when" } as WhenItem;
192
- };
193
-
194
268
  /**
195
269
  * Cache helper - defines caching configuration for segments
196
270
  *
@@ -201,21 +275,21 @@ const when: RouteHelpers<any, any>["when"] = (fn) => {
201
275
  * Supports these call signatures:
202
276
  * - cache() - no args, uses app-level defaults (for loader caching)
203
277
  * - cache(() => [...]) - wraps children with app-level defaults
204
- * - cache('profileName') - uses a named cache profile
205
- * - cache('profileName', () => [...]) - named profile with children
206
278
  * - cache({ ttl: 60 }, () => [...]) - with explicit options
279
+ *
280
+ * Named cache profiles are applied via the `"use cache: <profile>"` directive,
281
+ * not a `cache("profileName")` form in the route tree.
207
282
  */
208
283
  const cache: RouteHelpers<any, any>["cache"] = (
209
284
  optionsOrChildren?:
210
285
  | PartialCacheOptions
211
286
  | false
212
- | string
213
287
  | (() => UseItems<AllUseItems>),
214
288
  maybeChildren?: () => UseItems<AllUseItems>,
215
289
  ) => {
216
- const store = getContext();
217
- const ctx = store.getStore();
218
- if (!ctx) throw new Error("cache() must be called inside map()");
290
+ const { store, ctx } = requireDslContext(
291
+ "cache() must be called inside urls()",
292
+ );
219
293
 
220
294
  // Handle overloaded signature
221
295
  let options: PartialCacheOptions | false;
@@ -225,18 +299,6 @@ const cache: RouteHelpers<any, any>["cache"] = (
225
299
  // cache() - no args, use defaults
226
300
  options = {};
227
301
  children = undefined;
228
- } else if (typeof optionsOrChildren === "string") {
229
- // cache('profileName') or cache('profileName', () => [...])
230
- // Resolve from context-scoped profiles (set per-router via HelperContext).
231
- const ctxStore = RSCRouterContext.getStore();
232
- const profile = ctxStore?.cacheProfiles?.[optionsOrChildren];
233
- invariant(
234
- profile,
235
- `cache("${optionsOrChildren}"): unknown cache profile. ` +
236
- `Define it in createRouter({ cacheProfiles: { "${optionsOrChildren}": { ttl: ... } } }).`,
237
- );
238
- options = { ttl: profile.ttl, swr: profile.swr, tags: profile.tags };
239
- children = maybeChildren;
240
302
  } else if (typeof optionsOrChildren === "function") {
241
303
  // cache(() => [...]) - use empty options (will use defaults)
242
304
  options = {};
@@ -267,26 +329,18 @@ const cache: RouteHelpers<any, any>["cache"] = (
267
329
  // Create orphan cache entry (like orphan layout)
268
330
  // Subsequent siblings in the same array will attach to this entry
269
331
  const namespace = `${ctx.namespace}.${cacheIndex}`;
270
- const cacheUrlPrefix = getUrlPrefix();
332
+ const urlPrefix = getUrlPrefix();
271
333
 
272
334
  const entry = {
335
+ ...emptySegmentBase(),
273
336
  id: namespace,
274
337
  shortCode: store.getShortCode("cache"),
275
338
  type: "cache",
276
339
  parent: parent, // link to current parent for hierarchy
277
340
  cache: cacheConfig,
278
341
  handler: RootLayout,
279
- loading: undefined, // Allow loading() to attach loading state
280
- middleware: [],
281
- revalidate: [],
282
- errorBoundary: [],
283
- notFoundBoundary: [],
284
- layout: [],
285
- parallel: {},
286
- intercept: [],
287
- loader: [],
288
- ...(cacheUrlPrefix ? { mountPath: cacheUrlPrefix } : {}),
289
- } as EntryData;
342
+ ...(urlPrefix ? { mountPath: urlPrefix } : {}),
343
+ } satisfies EntryData;
290
344
 
291
345
  // Attach to parent's layout array (cache entries are structural like layouts)
292
346
  if (parent && "layout" in parent) {
@@ -300,13 +354,23 @@ const cache: RouteHelpers<any, any>["cache"] = (
300
354
  return { name: namespace, type: "cache" } as CacheItem;
301
355
  }
302
356
 
357
+ // Inside a loader() use() callback, only the direct form — cache()/cache(opts)
358
+ // — writes cache config to the loader entry. The wrapper form creates a
359
+ // structural cache boundary with its own children scope, which has no effect
360
+ // on the loader and would silently no-op.
361
+ invariant(
362
+ !(ctx.parent && (ctx.parent as any).type === "loader"),
363
+ "cache() wrapper form is not valid inside loader() use(). Use cache({...}) without children to configure the loader's cache.",
364
+ );
365
+
303
366
  // With children: create a cache entry (like layout with caching semantics)
304
367
  const namespace = `${ctx.namespace}.${cacheIndex}`;
305
368
  const cacheShortCode = store.getShortCode("cache");
306
369
 
307
- const cacheUrlPrefix2 = getUrlPrefix();
370
+ const urlPrefix = getUrlPrefix();
308
371
 
309
372
  const entry = {
373
+ ...emptySegmentBase(),
310
374
  id: namespace,
311
375
  shortCode: cacheShortCode,
312
376
  type: "cache",
@@ -314,48 +378,57 @@ const cache: RouteHelpers<any, any>["cache"] = (
314
378
  cache: cacheConfig,
315
379
  // Cache entries render like layouts (with Outlet as default handler)
316
380
  handler: RootLayout, // RootLayout just renders <Outlet />
317
- loading: undefined, // Allow loading() to attach loading state
318
- middleware: [],
319
- revalidate: [],
320
- errorBoundary: [],
321
- notFoundBoundary: [],
322
- layout: [],
323
- parallel: {},
324
- intercept: [],
325
- loader: [],
326
- ...(cacheUrlPrefix2 ? { mountPath: cacheUrlPrefix2 } : {}),
327
- } as EntryData;
381
+ ...(urlPrefix ? { mountPath: urlPrefix } : {}),
382
+ } satisfies EntryData;
328
383
 
329
384
  // Run children with cache entry as parent
330
- const result = store.run(namespace, entry, children)?.flat(3);
331
-
332
- invariant(
333
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
334
- `cache() children callback must return an array of use items [${namespace}]`,
385
+ const result = runAndValidateUseItems(
386
+ store,
387
+ namespace,
388
+ entry,
389
+ children,
390
+ "cache",
391
+ "children",
335
392
  );
336
393
 
337
- // Check if this cache has routes (including nested caches/layouts)
338
- const hasRoutes =
339
- result &&
340
- Array.isArray(result) &&
341
- result.some((item) => hasRoutesInItem(item));
342
-
343
- if (!hasRoutes) {
344
- const parent = ctx.parent;
345
- if (parent && "layout" in parent) {
346
- // Attach to parent's layout array (cache entries are structural like layouts)
347
- entry.parent = null;
348
- parent.layout.push(entry);
349
- }
350
- }
394
+ // Cache entries are structural like layouts: with no routes inside, register
395
+ // as an orphan sibling.
396
+ if (isOrphan(result)) attachOrphanSibling(ctx.parent, entry);
351
397
 
352
398
  return { name: namespace, type: "cache", uses: result } as CacheItem;
353
399
  };
354
400
 
355
- const middleware: RouteHelpers<any, any>["middleware"] = (...fn) => {
401
+ const middleware: RouteHelpers<any, any>["middleware"] = (...args: any[]) => {
402
+ // Four call forms:
403
+ // middleware(fn) — single fn, sibling
404
+ // middleware(fn, () => [...]) — single fn, wrapping
405
+ // middleware([fn1, fn2]) — array, sibling
406
+ // middleware([fn1, fn2], () => [...]) — array, wrapping
407
+ const isArray = Array.isArray(args[0]);
408
+
409
+ // Reject the removed variadic form before executing anything.
410
+ // middleware(fn1, fn2, fn3) — 3+ args, always wrong.
411
+ // middleware(fn1, fn2) where fn2 is a middleware fn (length >= 1), not a
412
+ // children callback (length === 0) — legacy two-fn form, reject early.
413
+ if (
414
+ args.length > 2 ||
415
+ (!isArray &&
416
+ args.length === 2 &&
417
+ typeof args[1] === "function" &&
418
+ args[1].length > 0)
419
+ ) {
420
+ throw new Error(
421
+ "middleware() no longer accepts variadic arguments. " +
422
+ "Use middleware([fn1, fn2, ...]) instead of middleware(fn1, fn2, ...).",
423
+ );
424
+ }
425
+
426
+ const fns: MiddlewareFn<any>[] = isArray ? args[0] : [args[0]];
427
+ const children: (() => any[]) | undefined =
428
+ typeof args[1] === "function" ? args[1] : undefined;
429
+
356
430
  // Prevent "use cache" functions from being used as middleware.
357
- // Checked before context validation — this is a static invariant.
358
- for (const f of fn) {
431
+ for (const f of fns) {
359
432
  if (isCachedFunction(f)) {
360
433
  throw new Error(
361
434
  `A "use cache" function cannot be used as middleware. ` +
@@ -366,23 +439,84 @@ const middleware: RouteHelpers<any, any>["middleware"] = (...fn) => {
366
439
  }
367
440
  }
368
441
 
369
- const ctx = getContext().getStore();
370
- if (!ctx) throw new Error("middleware() must be called inside map()");
442
+ const { store, ctx } = requireDslContext(
443
+ "middleware() must be called inside urls()",
444
+ );
371
445
 
372
- // Attach to last entry in stack
373
- const parent = ctx.parent;
374
- if (!parent || !("middleware" in parent)) {
375
- invariant(false, "No parent entry available for middleware()");
446
+ if (!children) {
447
+ // Sibling mode: attach to parent entry
448
+ const parent = ctx.parent;
449
+ if (!parent || !("middleware" in parent)) {
450
+ invariant(false, "No parent entry available for middleware()");
451
+ }
452
+ const name = `$${store.getNextIndex("middleware")}`;
453
+ parent.middleware.push(...fns);
454
+ return { name, type: "middleware" } as MiddlewareItem;
376
455
  }
377
- const name = `$${getContext().getNextIndex("middleware")}`;
378
- parent.middleware.push(...fn);
379
- return { name, type: "middleware" } as MiddlewareItem;
456
+
457
+ // Wrapping mode: create a transparent layout that carries the middleware
458
+ const mwIndex = store.getNextIndex("middleware");
459
+ const namespace = `${ctx.namespace}.${mwIndex}`;
460
+
461
+ const urlPrefix = getUrlPrefix();
462
+ const entry = {
463
+ ...emptySegmentBase(),
464
+ id: namespace,
465
+ shortCode: store.getShortCode("layout"),
466
+ type: "layout",
467
+ parent: ctx.parent,
468
+ handler: RootLayout,
469
+ middleware: [...fns],
470
+ ...(urlPrefix ? { mountPath: urlPrefix } : {}),
471
+ } satisfies EntryData;
472
+
473
+ // Run children callback. If the second arg was actually a middleware fn
474
+ // (old variadic form: middleware(mw1, mw2)), this will return a non-array
475
+ // and the invariant below gives a clear migration error.
476
+ const rawResult = store.run(namespace, entry, children);
477
+
478
+ invariant(
479
+ Array.isArray(rawResult),
480
+ "middleware(fn, children) expects the second argument to return an array of use items. " +
481
+ "To pass multiple middleware, use middleware([fn1, fn2]).",
482
+ );
483
+
484
+ const result = validateUseItems(
485
+ rawResult.flat(3),
486
+ namespace,
487
+ "middleware",
488
+ "children",
489
+ );
490
+
491
+ if (isOrphan(result)) attachOrphanSibling(ctx.parent, entry);
492
+
493
+ return {
494
+ name: namespace,
495
+ type: "middleware",
496
+ uses: result,
497
+ } as MiddlewareItem;
380
498
  };
381
499
 
500
+ // Slot names become part of segment ids: a parallel/intercept slot is encoded
501
+ // as `${shortCode}.${slotName}`, and loader segments append `D${index}.${loaderId}`.
502
+ // A "." in the slot name collides with that separator -- loaderParentId
503
+ // (segment-system.tsx) strips from the FIRST `D<index>.`, so a name like
504
+ // "@D3.foo" is mis-cut to "@" and the loader's data is silently dropped. Reject
505
+ // the dot at definition time so the failure is loud, not a corrupted tree at
506
+ // runtime. (A bare "D" without a trailing dot -- e.g. "@Detail" -- is fine.)
507
+ function assertValidSlotName(slotName: string): void {
508
+ invariant(
509
+ !slotName.includes("."),
510
+ `Slot name "${slotName}" must not contain ".". The dot is a reserved ` +
511
+ `segment-id separator; a name like "@D3.foo" corrupts loader segment-id ` +
512
+ `parsing and silently drops the loader's data. Rename the slot.`,
513
+ );
514
+ }
515
+
382
516
  const parallel: RouteHelpers<any, any>["parallel"] = (slots, use) => {
383
- const store = getContext();
384
- const ctx = store.getStore();
385
- if (!ctx) throw new Error("parallel() must be called inside map()");
517
+ const { store, ctx } = requireDslContext(
518
+ "parallel() must be called inside urls()",
519
+ );
386
520
 
387
521
  if (!ctx.parent || !ctx.parent?.parallel) {
388
522
  invariant(false, "No parent entry available for parallel()");
@@ -394,16 +528,29 @@ const parallel: RouteHelpers<any, any>["parallel"] = (slots, use) => {
394
528
  );
395
529
 
396
530
  const slotNames = Object.keys(slots as Record<string, any>) as `@${string}`[];
531
+ for (const slotName of slotNames) assertValidSlotName(slotName);
397
532
 
398
533
  const namespace = `${ctx.namespace}.$${store.getNextIndex("parallel")}`;
399
534
 
400
- // Unwrap any static handler definitions in parallel slots
535
+ // Unwrap slot values. A slot value can be:
536
+ // - a Handler / ReactNode (legacy form)
537
+ // - a Static() definition (build-time only)
538
+ // - a slot descriptor `{ handler, use? }` for slot-local overrides
539
+ // The descriptor's `use` runs after the broadcast `use` for that slot,
540
+ // so single-assignment items like `loading()` placed there win without
541
+ // affecting siblings.
401
542
  const unwrappedSlots: Record<string, any> = {};
543
+ const slotLocalUses: Record<string, (() => any[]) | undefined> = {};
402
544
  let hasStaticSlot = false;
403
545
  const staticSlotIds: Record<string, string> = {};
404
- for (const [slotName, slotHandler] of Object.entries(
546
+ for (const [slotName, rawSlot] of Object.entries(
405
547
  slots as Record<string, any>,
406
548
  )) {
549
+ let slotHandler: any = rawSlot;
550
+ if (isSlotDescriptor(rawSlot)) {
551
+ slotHandler = rawSlot.handler;
552
+ slotLocalUses[slotName] = rawSlot.use;
553
+ }
407
554
  if (isStaticHandler(slotHandler)) {
408
555
  hasStaticSlot = true;
409
556
  unwrappedSlots[slotName] = slotHandler.handler;
@@ -422,20 +569,12 @@ const parallel: RouteHelpers<any, any>["parallel"] = (slots, use) => {
422
569
  // Create full EntryData for parallel with its own loaders/revalidate/loading
423
570
  const parallelUrlPrefix = getUrlPrefix();
424
571
  const entry = {
572
+ ...emptySegmentBase(),
425
573
  id: namespace,
426
574
  shortCode: store.getShortCode("parallel"),
427
575
  type: "parallel",
428
576
  parent: null, // Parallels don't participate in parent chain traversal
429
577
  handler: unwrappedSlots,
430
- loading: undefined, // Allow loading() to attach loading state
431
- middleware: [],
432
- revalidate: [],
433
- errorBoundary: [],
434
- notFoundBoundary: [],
435
- layout: [],
436
- parallel: {},
437
- intercept: [],
438
- loader: [],
439
578
  ...(parallelUrlPrefix ? { mountPath: parallelUrlPrefix } : {}),
440
579
  ...(hasStaticSlot
441
580
  ? {
@@ -447,15 +586,6 @@ const parallel: RouteHelpers<any, any>["parallel"] = (slots, use) => {
447
586
  : {}),
448
587
  } satisfies EntryData;
449
588
 
450
- // Run use callback if provided to collect loaders, revalidate, loading
451
- if (use && typeof use === "function") {
452
- const result = store.run(namespace, entry, use)?.flat(3);
453
- invariant(
454
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
455
- `parallel() use() callback must return an array of use items [${namespace}]`,
456
- );
457
- }
458
-
459
589
  for (const slotName of slotNames) {
460
590
  const slotEntry = {
461
591
  ...entry,
@@ -478,11 +608,64 @@ const parallel: RouteHelpers<any, any>["parallel"] = (slots, use) => {
478
608
  staticHandlerIds: undefined,
479
609
  }),
480
610
  } satisfies EntryData;
611
+
612
+ // Per-slot merge order (narrowest-scope-wins for single-assignment items
613
+ // like loading()):
614
+ // 1. handler.use — defaults baked into the handler
615
+ // 2. shared `use` — broadcast at the parallel() call site
616
+ // 3. slot-local `use` — per-slot override via `{ handler, use }` descriptor
617
+ // Items that accumulate (loader, middleware, revalidate, …) compose
618
+ // across all three layers regardless of order.
619
+ const rawSlot = (slots as Record<string, any>)[slotName];
620
+ const slotHandlerForUse = isSlotDescriptor(rawSlot)
621
+ ? rawSlot.handler
622
+ : rawSlot;
623
+ const slotHandlerUse = resolveHandlerUse(slotHandlerForUse);
624
+ const slotLocalUse = slotLocalUses[slotName];
625
+ const explicitUse = combineExplicitUses(use, slotLocalUse);
626
+ const slotMergedUse = mergeHandlerUse(
627
+ slotHandlerUse,
628
+ explicitUse,
629
+ "parallel",
630
+ );
631
+ if (slotMergedUse) {
632
+ runAndValidateUseItems(
633
+ store,
634
+ namespace,
635
+ slotEntry,
636
+ slotMergedUse,
637
+ "parallel",
638
+ "use",
639
+ );
640
+ }
641
+
481
642
  ctx.parent.parallel[slotName] = slotEntry;
482
643
  }
483
644
  return { name: namespace, type: "parallel" } as ParallelItem;
484
645
  };
485
646
 
647
+ function isSlotDescriptor(
648
+ value: unknown,
649
+ ): value is { handler: unknown; use?: () => any[] } {
650
+ return (
651
+ typeof value === "object" &&
652
+ value !== null &&
653
+ !("__brand" in value) &&
654
+ "handler" in value &&
655
+ typeof (value as any).handler !== "undefined"
656
+ );
657
+ }
658
+
659
+ function combineExplicitUses(
660
+ sharedUse: (() => any[]) | undefined,
661
+ slotLocalUse: (() => any[]) | undefined,
662
+ ): (() => any[]) | undefined {
663
+ if (!sharedUse && !slotLocalUse) return undefined;
664
+ if (!slotLocalUse) return sharedUse;
665
+ if (!sharedUse) return slotLocalUse;
666
+ return () => [...sharedUse(), ...slotLocalUse()];
667
+ }
668
+
486
669
  /**
487
670
  * Intercept helper - defines an intercepting route for soft navigation
488
671
  */
@@ -490,11 +673,22 @@ const intercept = (
490
673
  slotName: `@${string}`,
491
674
  routeName: string,
492
675
  handler: any,
676
+ configOrUse?: InterceptConfig | (() => any[]),
493
677
  use?: () => any[],
494
678
  ) => {
495
- const store = getContext();
496
- const ctx = store.getStore();
497
- if (!ctx) throw new Error("intercept() must be called inside map()");
679
+ // arg4 discrimination: a function is the use() callback (no config); an object
680
+ // is the config carrying `when`. With config given, the use() callback is
681
+ // arg5. Keeps the no-config form intercept(slot, route, handler, () => [...])
682
+ // working unchanged.
683
+ const config: InterceptConfig | undefined =
684
+ typeof configOrUse === "function" || configOrUse == null
685
+ ? undefined
686
+ : configOrUse;
687
+ const useFn = typeof configOrUse === "function" ? configOrUse : use;
688
+
689
+ const { store, ctx } = requireDslContext(
690
+ "intercept() must be called inside urls()",
691
+ );
498
692
 
499
693
  if (!ctx.parent || !ctx.parent?.intercept) {
500
694
  invariant(false, "No parent entry available for intercept()");
@@ -505,6 +699,8 @@ const intercept = (
505
699
  "intercept() cannot be used inside parallel()",
506
700
  );
507
701
 
702
+ assertValidSlotName(slotName);
703
+
508
704
  const namespace = `${ctx.namespace}.$${store.getNextIndex("intercept")}.${slotName}`;
509
705
 
510
706
  // Dot-prefixed = local (add include prefix), unprefixed = global (use as-is)
@@ -527,25 +723,33 @@ const intercept = (
527
723
  when: [], // Selector conditions for conditional interception
528
724
  };
529
725
 
530
- // Run use callback if provided to collect loaders, revalidate, middleware, etc.
531
- if (use && typeof use === "function") {
532
- // Create a temporary parent context for the use() callback
533
- // so that middleware, loader, revalidate attach to the intercept entry
534
- const originalParent = ctx.parent;
726
+ // Conditional interception: `when` from the config object a single selector
727
+ // or an array (ALL must return true to activate). Replaces the former when()
728
+ // use-item captured inside the callback.
729
+ if (config?.when) {
730
+ const selectors = Array.isArray(config.when) ? config.when : [config.when];
731
+ entry.when.push(...selectors);
732
+ }
535
733
 
536
- // Capture layouts in a temporary array
734
+ // Merge handler.use defaults with explicit use
735
+ const handlerUseFn = resolveHandlerUse(handler);
736
+ const mergedUse = mergeHandlerUse(handlerUseFn, useFn, "intercept");
737
+
738
+ // Run merged use callback to collect loaders, revalidate, middleware, etc.
739
+ if (mergedUse) {
740
+ // Capture layout() calls into a temporary array
537
741
  const capturedLayouts: EntryData[] = [];
538
742
 
743
+ // Temporary parent so middleware/loader/revalidate/when attach to the
744
+ // intercept entry; the loading get/set accessor mirrors writes onto `entry`.
539
745
  const tempParent = {
540
- ...originalParent,
746
+ ...ctx.parent,
541
747
  middleware: entry.middleware,
542
748
  revalidate: entry.revalidate,
543
749
  errorBoundary: entry.errorBoundary,
544
750
  notFoundBoundary: entry.notFoundBoundary,
545
751
  loader: entry.loader,
546
752
  layout: capturedLayouts, // Capture layout() calls
547
- when: entry.when, // Capture when() conditions
548
- // Use getter/setter to capture loading on the entry
549
753
  get loading() {
550
754
  return entry.loading;
551
755
  },
@@ -553,12 +757,10 @@ const intercept = (
553
757
  entry.loading = value;
554
758
  },
555
759
  };
556
- ctx.parent = tempParent as EntryData;
557
-
558
- const result = use()?.flat(3);
559
760
 
560
- // Restore original parent
561
- ctx.parent = originalParent;
761
+ const result = withParent(ctx, tempParent as EntryData, () =>
762
+ mergedUse()?.flat(3),
763
+ );
562
764
 
563
765
  // Extract layout from captured layouts (use first one if multiple)
564
766
  // Layout inside intercept should always be ReactNode or Handler, not Record slots
@@ -568,10 +770,7 @@ const intercept = (
568
770
  | Handler<any, any, any>;
569
771
  }
570
772
 
571
- invariant(
572
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
573
- `intercept() use() callback must return an array of use items [${namespace}]`,
574
- );
773
+ validateUseItems(result, namespace, "intercept", "use");
575
774
  }
576
775
 
577
776
  ctx.parent.intercept.push(entry);
@@ -581,10 +780,10 @@ const intercept = (
581
780
  /**
582
781
  * Loader helper - attaches a loader to the current entry
583
782
  */
584
- const loaderFn: RouteHelpers<any, any>["loader"] = (loaderDef, use) => {
585
- const store = getContext();
586
- const ctx = store.getStore();
587
- if (!ctx) throw new Error("loader() must be called inside map()");
783
+ const loader: RouteHelpers<any, any>["loader"] = (loaderDef, use) => {
784
+ const { store, ctx } = requireDslContext(
785
+ "loader() must be called inside urls()",
786
+ );
588
787
 
589
788
  // Attach to last entry in stack
590
789
  if (!ctx.parent || !ctx.parent?.loader) {
@@ -599,25 +798,28 @@ const loaderFn: RouteHelpers<any, any>["loader"] = (loaderDef, use) => {
599
798
  revalidate: [] as ShouldRevalidateFn<any, any>[],
600
799
  };
601
800
 
602
- // If use() callback provided, run it to collect revalidation rules and cache config
603
- if (use && typeof use === "function") {
604
- // Temporarily set context for revalidate()/cache() calls to target this loader
605
- const originalParent = ctx.parent;
801
+ // Merge handler.use defaults (attached to the loader definition) with explicit use
802
+ const handlerUseFn = resolveHandlerUse(loaderDef);
803
+ const mergedUse = mergeHandlerUse(handlerUseFn, use, "loader");
804
+
805
+ // If any use callback is in effect, run it to collect revalidation rules and cache config
806
+ if (mergedUse) {
606
807
  // Create a temporary "parent" with type "loader" so cache() can detect it.
607
808
  // Save existing .cache to distinguish inherited config from newly set config.
608
- const parentCache = (originalParent as any).cache;
809
+ const parentCache = (ctx.parent as any).cache;
609
810
  const tempParent = {
610
- ...originalParent,
811
+ ...ctx.parent,
611
812
  type: "loader",
612
813
  revalidate: loaderEntry.revalidate,
613
814
  };
614
- ctx.parent = tempParent as EntryData;
615
815
 
616
- const result = use()?.flat(3);
816
+ const result = withParent(ctx, tempParent as EntryData, () =>
817
+ mergedUse()?.flat(3),
818
+ );
617
819
 
618
820
  // Copy cache config only if cache() was called during the use() callback.
619
- // The spread from originalParent may carry an inherited .cache from
620
- // a parent cache() boundary — only copy if it was newly set.
821
+ // The spread may carry an inherited .cache from a parent cache() boundary —
822
+ // only copy if it was newly set.
621
823
  if (
622
824
  (tempParent as any).cache &&
623
825
  (tempParent as any).cache !== parentCache
@@ -625,13 +827,7 @@ const loaderFn: RouteHelpers<any, any>["loader"] = (loaderDef, use) => {
625
827
  (loaderEntry as any).cache = (tempParent as any).cache;
626
828
  }
627
829
 
628
- // Restore original parent
629
- ctx.parent = originalParent;
630
-
631
- invariant(
632
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
633
- `loader() use() callback must return an array of use items [${name}]`,
634
- );
830
+ validateUseItems(result, name, "loader", "use");
635
831
  }
636
832
 
637
833
  ctx.parent.loader.push(loaderEntry);
@@ -642,21 +838,25 @@ const loaderFn: RouteHelpers<any, any>["loader"] = (loaderDef, use) => {
642
838
  * Loading helper - attaches a loading component to the current entry
643
839
  * Loading components are static (no context) and shown during navigation
644
840
  */
645
- const loadingFn: RouteHelpers<any, any>["loading"] = (component, options) => {
646
- const store = getContext();
647
- const ctx = store.getStore();
648
- if (!ctx) throw new Error("loading() must be called inside map()");
841
+ const loading: RouteHelpers<any, any>["loading"] = (component, options) => {
842
+ const { store, ctx } = requireDslContext(
843
+ "loading() must be called inside urls()",
844
+ );
649
845
 
650
846
  const parent = ctx.parent;
651
847
  if (!parent || !("loading" in parent)) {
652
848
  invariant(false, "No parent entry available for loading()");
653
849
  }
654
850
 
851
+ // Unwrap function form: loading(() => <Skeleton />) → loading(<Skeleton />)
852
+ const resolved =
853
+ typeof component === "function" ? (component as () => any)() : component;
854
+
655
855
  // If ssr: false and we're in SSR, set loading to false
656
856
  if (options?.ssr === false && ctx.isSSR) {
657
857
  parent.loading = false;
658
858
  } else {
659
- parent.loading = component;
859
+ parent.loading = resolved;
660
860
  }
661
861
 
662
862
  const name = `$${store.getNextIndex("loading")}`;
@@ -664,10 +864,13 @@ const loadingFn: RouteHelpers<any, any>["loading"] = (component, options) => {
664
864
  };
665
865
 
666
866
  /**
667
- * Transition helper - attaches a ViewTransition config to the current entry
668
- * or wraps a group of routes in a transparent layout with ViewTransition
867
+ * Transition helper - opts the entry (or a wrapped group of routes) into
868
+ * transition-driven navigation by attaching a TransitionConfig. This drives the
869
+ * commit through startTransition (content hold on all React versions) and, on
870
+ * experimental React, places a `<ViewTransition>` boundary unless
871
+ * `viewTransition: false`. See skills/view-transitions for the matrix.
669
872
  */
670
- const transitionFn = (
873
+ const transition = (
671
874
  configOrChildren?: TransitionConfig | (() => UseItems<AllUseItems>),
672
875
  maybeChildren?: () => UseItems<AllUseItems>,
673
876
  ): TransitionItem => {
@@ -681,11 +884,15 @@ const transitionFn = (
681
884
  const children: (() => UseItems<AllUseItems>) | undefined =
682
885
  typeof configOrChildren === "function" ? configOrChildren : maybeChildren;
683
886
 
684
- const store = getContext();
685
- const ctx = store.getStore();
686
- if (!ctx) throw new Error("transition() must be called inside map()");
887
+ const { store, ctx } = requireDslContext(
888
+ "transition() must be called inside urls()",
889
+ );
687
890
 
688
- const name = `$${store.getNextIndex("transition")}`;
891
+ // Allocate a single index for this transition() call (used in all paths),
892
+ // mirroring cache() — the child form uses it for the name, the wrapper form
893
+ // reuses it for the namespace, so no index is burned.
894
+ const transitionIndex = store.getNextIndex("transition");
895
+ const name = `$${transitionIndex}`;
689
896
 
690
897
  if (!children) {
691
898
  // Position 1: child of path() — attach to parent entry
@@ -698,70 +905,51 @@ const transitionFn = (
698
905
  }
699
906
 
700
907
  // Position 2: wrapper — create a transparent layout with transition config
701
- const namespace = `${ctx.namespace}.${store.getNextIndex("transition")}`;
908
+ const namespace = `${ctx.namespace}.${transitionIndex}`;
702
909
  const entry = {
910
+ ...emptySegmentBase(),
703
911
  id: namespace,
704
912
  shortCode: store.getShortCode("layout"),
705
913
  type: "layout",
706
914
  parent: ctx.parent,
707
915
  handler: RootLayout,
708
- loading: undefined,
709
916
  transition: config,
710
- middleware: [],
711
- revalidate: [],
712
- errorBoundary: [],
713
- notFoundBoundary: [],
714
- layout: [],
715
- parallel: {},
716
- intercept: [],
717
- loader: [],
718
- } as EntryData;
719
-
720
- const result = store.run(namespace, entry, children)?.flat(3);
917
+ } satisfies EntryData;
721
918
 
722
- invariant(
723
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
724
- `transition() children callback must return an array of use items [${namespace}]`,
919
+ const result = runAndValidateUseItems(
920
+ store,
921
+ namespace,
922
+ entry,
923
+ children,
924
+ "transition",
925
+ "children",
725
926
  );
726
927
 
727
- const hasRoutes =
728
- result &&
729
- Array.isArray(result) &&
730
- result.some((item) => hasRoutesInItem(item));
731
-
732
- if (!hasRoutes) {
733
- const parent = ctx.parent;
734
- if (parent && "layout" in parent) {
735
- entry.parent = null;
736
- parent.layout.push(entry);
737
- }
738
- }
928
+ if (isOrphan(result)) attachOrphanSibling(ctx.parent, entry);
739
929
 
740
930
  return { name: namespace, type: "transition" } as TransitionItem;
741
931
  };
742
932
 
743
- const routeFn: RouteHelpers<any, any>["route"] = (name, handler, use) => {
744
- const store = getContext();
745
- const ctx = store.getStore();
746
- if (!ctx) throw new Error("route() must be called inside map()");
933
+ const route: RouteHelpers<any, any>["route"] = (name, handler, use) => {
934
+ const { store, ctx } = requireDslContext(
935
+ "route() must be called inside urls()",
936
+ );
937
+
938
+ // Reject names colliding with reserved internal prefixes ($path_, $prefix_),
939
+ // the same guard path() and include() enforce. Without it such a name
940
+ // type-checks on an untyped router, then silently vanishes from generated
941
+ // route-types and public reverse() (isAutoGeneratedRouteName filters it out).
942
+ validateUserRouteName(name);
747
943
 
748
944
  const namespace = `${ctx.namespace}.${store.getNextIndex("route")}.${name}`;
749
945
 
750
946
  const entry = {
947
+ ...emptySegmentBase(),
751
948
  id: namespace,
752
949
  shortCode: store.getShortCode("route"),
753
950
  type: "route",
754
951
  parent: ctx.parent,
755
- handler,
756
- loading: undefined, // Allow loading() to attach loading state
757
- middleware: [],
758
- revalidate: [],
759
- errorBoundary: [],
760
- notFoundBoundary: [],
761
- layout: [],
762
- parallel: {},
763
- intercept: [],
764
- loader: [],
952
+ handler: handler as unknown as Handler<any, any, any>,
765
953
  } satisfies EntryData;
766
954
 
767
955
  /* We will throw if user is registring same route name twice */
@@ -771,12 +959,18 @@ const routeFn: RouteHelpers<any, any>["route"] = (name, handler, use) => {
771
959
  );
772
960
  /* Register route entry */
773
961
  ctx.manifest.set(name, entry);
962
+ /* Merge handler.use defaults with explicit use */
963
+ const handlerUseFn = resolveHandlerUse(handler);
964
+ const mergedUse = mergeHandlerUse(handlerUseFn, use, "route");
774
965
  /* Run use and attach handlers */
775
- if (use && typeof use === "function") {
776
- const result = store.run(namespace, entry, use)?.flat(3);
777
- invariant(
778
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
779
- `route() use() callback must return an array of use items [${namespace}]`,
966
+ if (mergedUse) {
967
+ const result = runAndValidateUseItems(
968
+ store,
969
+ namespace,
970
+ entry,
971
+ mergedUse,
972
+ "route",
973
+ "use",
780
974
  );
781
975
  return { name: namespace, type: "route", uses: result } as RouteItem;
782
976
  }
@@ -786,9 +980,9 @@ const routeFn: RouteHelpers<any, any>["route"] = (name, handler, use) => {
786
980
  };
787
981
 
788
982
  const layout: RouteHelpers<any, any>["layout"] = (handler, use) => {
789
- const store = getContext();
790
- const ctx = store.getStore();
791
- if (!ctx) throw new Error("layout() must be called inside map()");
983
+ const { store, ctx } = requireDslContext(
984
+ "layout() must be called inside urls()",
985
+ );
792
986
 
793
987
  invariant(
794
988
  !ctx.parent || ctx.parent.type !== "parallel",
@@ -806,20 +1000,12 @@ const layout: RouteHelpers<any, any>["layout"] = (handler, use) => {
806
1000
 
807
1001
  const urlPrefix = getUrlPrefix();
808
1002
  const entry = {
1003
+ ...emptySegmentBase(),
809
1004
  id: namespace,
810
1005
  shortCode,
811
1006
  type: "layout",
812
1007
  parent: ctx.parent,
813
1008
  handler: unwrappedHandler,
814
- loading: undefined, // Allow loading() to attach loading state
815
- middleware: [],
816
- revalidate: [],
817
- errorBoundary: [],
818
- notFoundBoundary: [],
819
- parallel: {},
820
- intercept: [],
821
- layout: [],
822
- loader: [],
823
1009
  ...(urlPrefix ? { mountPath: urlPrefix } : {}),
824
1010
  ...(isStatic
825
1011
  ? {
@@ -834,14 +1020,20 @@ const layout: RouteHelpers<any, any>["layout"] = (handler, use) => {
834
1020
  (handler as any).$$routePrefix = ctx.namePrefix;
835
1021
  }
836
1022
 
837
- // Run use callback if provided
838
- let result: AllUseItems[] | undefined;
839
- if (use && typeof use === "function") {
840
- result = store.run(namespace, entry, use)?.flat(3);
1023
+ // Merge handler.use defaults with explicit use
1024
+ const handlerUseFn = resolveHandlerUse(handler);
1025
+ const mergedUse = mergeHandlerUse(handlerUseFn, use, "layout");
841
1026
 
842
- invariant(
843
- Array.isArray(result) && result.every((item) => isValidUseItem(item)),
844
- `layout() use() callback must return an array of use items [${namespace}]`,
1027
+ // Run merged use callback if present
1028
+ let result: AllUseItems[] | undefined;
1029
+ if (mergedUse) {
1030
+ result = runAndValidateUseItems(
1031
+ store,
1032
+ namespace,
1033
+ entry,
1034
+ mergedUse,
1035
+ "layout",
1036
+ "use",
845
1037
  );
846
1038
  }
847
1039
 
@@ -883,9 +1075,7 @@ const layout: RouteHelpers<any, any>["layout"] = (handler, use) => {
883
1075
  `Orphan layouts can only be defined inside route or layout > check [${namespace}]`,
884
1076
  );
885
1077
 
886
- // Clear parent pointer for orphan layouts to prevent duplicate processing
887
- entry.parent = null;
888
- parent.layout.push(entry);
1078
+ attachOrphanSibling(parent, entry);
889
1079
  }
890
1080
  }
891
1081
 
@@ -898,33 +1088,15 @@ const layout: RouteHelpers<any, any>["layout"] = (handler, use) => {
898
1088
  } as LayoutItem;
899
1089
  };
900
1090
 
901
- const isValidUseItem = (item: any): item is AllUseItems | undefined | null => {
902
- return (
903
- typeof item === "undefined" ||
904
- item === null ||
905
- (item &&
906
- typeof item === "object" &&
907
- "type" in item &&
908
- [
909
- "layout",
910
- "route",
911
- "middleware",
912
- "revalidate",
913
- "parallel",
914
- "intercept",
915
- "loader",
916
- "loading",
917
- "errorBoundary",
918
- "notFoundBoundary",
919
- "when",
920
- "cache",
921
- "transition",
922
- "include", // For urls() include() helper
923
- ].includes(item.type))
924
- );
925
- };
1091
+ const isValidUseItem = (item: any): item is AllUseItems | undefined | null =>
1092
+ item == null ||
1093
+ (typeof item === "object" &&
1094
+ "type" in item &&
1095
+ ALL_USE_ITEM_TYPES.has(item.type));
926
1096
 
927
- // Global helper exports for direct import from @rangojs/router
1097
+ // DSL helpers exported for direct import from @rangojs/router and for
1098
+ // assembly into the RouteHelpers object in helper-factories.ts. The route-item
1099
+ // types are discriminated by their `type` literal, so the helpers carry no brand.
928
1100
  export {
929
1101
  layout,
930
1102
  cache,
@@ -932,28 +1104,13 @@ export {
932
1104
  revalidate,
933
1105
  parallel,
934
1106
  intercept,
935
- when,
936
1107
  errorBoundary,
937
1108
  notFoundBoundary,
938
- loaderFn as loader,
939
- loadingFn as loading,
940
- transitionFn as transition,
941
- };
942
-
943
- const isOrphanLayout = (item: AllUseItems): boolean => {
944
- return (
945
- item.type === "layout" &&
946
- !item.uses?.some((child) => hasRoutesInItem(child))
947
- );
948
- };
949
-
950
- // Internal exports used by helper-factories.ts
951
- export {
952
- routeFn,
953
- loaderFn,
954
- loadingFn,
955
- transitionFn,
956
- hasRoutesInItem,
1109
+ route,
1110
+ loader,
1111
+ loading,
1112
+ transition,
957
1113
  isValidUseItem,
958
- isOrphanLayout,
1114
+ emptySegmentBase,
1115
+ runAndValidateUseItems,
959
1116
  };