@rangojs/router 0.0.0-experimental.d7eeaa75 → 0.0.0-experimental.d98a8e9d

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 (278) hide show
  1. package/README.md +120 -25
  2. package/dist/bin/rango.js +147 -57
  3. package/dist/testing/vitest.js +82 -0
  4. package/dist/vite/index.js +2154 -861
  5. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  6. package/package.json +57 -11
  7. package/skills/api-client/SKILL.md +211 -0
  8. package/skills/breadcrumbs/SKILL.md +3 -1
  9. package/skills/bundle-analysis/SKILL.md +159 -0
  10. package/skills/cache-guide/SKILL.md +220 -30
  11. package/skills/caching/SKILL.md +116 -8
  12. package/skills/composability/SKILL.md +27 -2
  13. package/skills/document-cache/SKILL.md +78 -55
  14. package/skills/handler-use/SKILL.md +364 -0
  15. package/skills/hooks/SKILL.md +229 -20
  16. package/skills/host-router/SKILL.md +45 -20
  17. package/skills/i18n/SKILL.md +276 -0
  18. package/skills/intercept/SKILL.md +46 -4
  19. package/skills/layout/SKILL.md +28 -7
  20. package/skills/links/SKILL.md +247 -17
  21. package/skills/loader/SKILL.md +219 -9
  22. package/skills/middleware/SKILL.md +47 -12
  23. package/skills/migrate-nextjs/SKILL.md +562 -0
  24. package/skills/migrate-react-router/SKILL.md +769 -0
  25. package/skills/mime-routes/SKILL.md +27 -0
  26. package/skills/observability/SKILL.md +137 -0
  27. package/skills/parallel/SKILL.md +71 -6
  28. package/skills/prerender/SKILL.md +14 -33
  29. package/skills/rango/SKILL.md +243 -22
  30. package/skills/react-compiler/SKILL.md +168 -0
  31. package/skills/response-routes/SKILL.md +122 -47
  32. package/skills/route/SKILL.md +57 -4
  33. package/skills/router-setup/SKILL.md +3 -3
  34. package/skills/server-actions/SKILL.md +751 -0
  35. package/skills/streams-and-websockets/SKILL.md +283 -0
  36. package/skills/testing/SKILL.md +128 -0
  37. package/skills/testing/bindings.md +89 -0
  38. package/skills/testing/cache-prerender.md +98 -0
  39. package/skills/testing/client-components.md +121 -0
  40. package/skills/testing/e2e-parity.md +124 -0
  41. package/skills/testing/flight.md +89 -0
  42. package/skills/testing/handles.md +127 -0
  43. package/skills/testing/loader.md +108 -0
  44. package/skills/testing/middleware.md +97 -0
  45. package/skills/testing/render-handler.md +102 -0
  46. package/skills/testing/response-routes.md +94 -0
  47. package/skills/testing/reverse-and-types.md +83 -0
  48. package/skills/testing/server-actions.md +89 -0
  49. package/skills/testing/server-tree.md +128 -0
  50. package/skills/testing/setup.md +120 -0
  51. package/skills/typesafety/SKILL.md +319 -27
  52. package/skills/use-cache/SKILL.md +34 -5
  53. package/skills/view-transitions/SKILL.md +294 -0
  54. package/src/__augment-tests__/augment.ts +81 -0
  55. package/src/__augment-tests__/augmented.check.ts +116 -0
  56. package/src/browser/action-coordinator.ts +53 -36
  57. package/src/browser/app-shell.ts +52 -0
  58. package/src/browser/event-controller.ts +86 -70
  59. package/src/browser/history-state.ts +21 -0
  60. package/src/browser/index.ts +3 -3
  61. package/src/browser/navigation-bridge.ts +84 -11
  62. package/src/browser/navigation-client.ts +104 -68
  63. package/src/browser/navigation-store.ts +32 -9
  64. package/src/browser/navigation-transaction.ts +10 -28
  65. package/src/browser/partial-update.ts +64 -26
  66. package/src/browser/prefetch/cache.ts +183 -44
  67. package/src/browser/prefetch/fetch.ts +228 -37
  68. package/src/browser/prefetch/queue.ts +36 -5
  69. package/src/browser/rango-state.ts +53 -13
  70. package/src/browser/react/Link.tsx +30 -2
  71. package/src/browser/react/NavigationProvider.tsx +72 -31
  72. package/src/browser/react/filter-segment-order.ts +51 -7
  73. package/src/browser/react/index.ts +3 -0
  74. package/src/browser/react/location-state-shared.ts +175 -4
  75. package/src/browser/react/location-state.ts +39 -13
  76. package/src/browser/react/use-handle.ts +17 -9
  77. package/src/browser/react/use-navigation.ts +22 -2
  78. package/src/browser/react/use-params.ts +20 -8
  79. package/src/browser/react/use-reverse.ts +106 -0
  80. package/src/browser/react/use-router.ts +22 -2
  81. package/src/browser/react/use-segments.ts +11 -8
  82. package/src/browser/response-adapter.ts +32 -1
  83. package/src/browser/rsc-router.tsx +69 -22
  84. package/src/browser/scroll-restoration.ts +22 -14
  85. package/src/browser/segment-reconciler.ts +36 -14
  86. package/src/browser/segment-structure-assert.ts +2 -2
  87. package/src/browser/server-action-bridge.ts +23 -30
  88. package/src/browser/types.ts +21 -0
  89. package/src/build/collect-fallback-refs.ts +107 -0
  90. package/src/build/generate-manifest.ts +60 -35
  91. package/src/build/generate-route-types.ts +2 -0
  92. package/src/build/index.ts +8 -1
  93. package/src/build/prefix-tree-utils.ts +123 -0
  94. package/src/build/route-trie.ts +95 -25
  95. package/src/build/route-types/codegen.ts +4 -4
  96. package/src/build/route-types/include-resolution.ts +1 -1
  97. package/src/build/route-types/per-module-writer.ts +7 -4
  98. package/src/build/route-types/router-processing.ts +55 -14
  99. package/src/build/route-types/scan-filter.ts +1 -1
  100. package/src/build/route-types/source-scan.ts +118 -0
  101. package/src/build/runtime-discovery.ts +9 -20
  102. package/src/cache/cache-scope.ts +28 -42
  103. package/src/cache/cf/cf-cache-store.ts +54 -13
  104. package/src/client.rsc.tsx +3 -0
  105. package/src/client.tsx +96 -205
  106. package/src/context-var.ts +5 -5
  107. package/src/decode-loader-results.ts +36 -0
  108. package/src/errors.ts +30 -4
  109. package/src/handle.ts +32 -14
  110. package/src/host/index.ts +2 -2
  111. package/src/host/router.ts +129 -57
  112. package/src/host/types.ts +31 -2
  113. package/src/host/utils.ts +1 -1
  114. package/src/href-client.ts +140 -21
  115. package/src/index.rsc.ts +10 -6
  116. package/src/index.ts +54 -17
  117. package/src/loader-store.ts +500 -0
  118. package/src/loader.rsc.ts +25 -7
  119. package/src/loader.ts +16 -9
  120. package/src/missing-id-error.ts +68 -0
  121. package/src/outlet-context.ts +1 -1
  122. package/src/prerender.ts +27 -6
  123. package/src/response-utils.ts +37 -0
  124. package/src/reverse.ts +65 -36
  125. package/src/route-content-wrapper.tsx +6 -28
  126. package/src/route-definition/dsl-helpers.ts +384 -257
  127. package/src/route-definition/helper-factories.ts +29 -139
  128. package/src/route-definition/helpers-types.ts +100 -28
  129. package/src/route-definition/resolve-handler-use.ts +6 -0
  130. package/src/route-definition/use-item-types.ts +32 -0
  131. package/src/route-types.ts +26 -41
  132. package/src/router/basename.ts +14 -0
  133. package/src/router/content-negotiation.ts +15 -2
  134. package/src/router/error-handling.ts +1 -1
  135. package/src/router/find-match.ts +54 -6
  136. package/src/router/handler-context.ts +21 -38
  137. package/src/router/intercept-resolution.ts +4 -18
  138. package/src/router/lazy-includes.ts +41 -22
  139. package/src/router/loader-resolution.ts +82 -36
  140. package/src/router/manifest.ts +41 -19
  141. package/src/router/match-api.ts +4 -3
  142. package/src/router/match-handlers.ts +63 -20
  143. package/src/router/match-middleware/cache-lookup.ts +44 -91
  144. package/src/router/match-middleware/cache-store.ts +3 -2
  145. package/src/router/match-result.ts +53 -32
  146. package/src/router/metrics.ts +1 -1
  147. package/src/router/middleware-types.ts +15 -26
  148. package/src/router/middleware.ts +99 -84
  149. package/src/router/pattern-matching.ts +116 -19
  150. package/src/router/prerender-match.ts +1 -1
  151. package/src/router/preview-match.ts +3 -1
  152. package/src/router/request-classification.ts +4 -28
  153. package/src/router/revalidation.ts +58 -2
  154. package/src/router/router-interfaces.ts +45 -28
  155. package/src/router/router-options.ts +40 -1
  156. package/src/router/router-registry.ts +2 -5
  157. package/src/router/segment-resolution/fresh.ts +27 -6
  158. package/src/router/segment-resolution/revalidation.ts +147 -106
  159. package/src/router/segment-resolution/view-transition-default.ts +36 -0
  160. package/src/router/substitute-pattern-params.ts +56 -0
  161. package/src/router/telemetry.ts +99 -0
  162. package/src/router/trie-matching.ts +40 -16
  163. package/src/router/types.ts +8 -0
  164. package/src/router/url-params.ts +49 -0
  165. package/src/router.ts +52 -30
  166. package/src/rsc/handler-context.ts +2 -2
  167. package/src/rsc/handler.ts +28 -69
  168. package/src/rsc/helpers.ts +91 -43
  169. package/src/rsc/index.ts +1 -1
  170. package/src/rsc/manifest-init.ts +28 -41
  171. package/src/rsc/origin-guard.ts +28 -10
  172. package/src/rsc/progressive-enhancement.ts +4 -0
  173. package/src/rsc/response-error.ts +79 -12
  174. package/src/rsc/response-route-handler.ts +57 -61
  175. package/src/rsc/rsc-rendering.ts +35 -51
  176. package/src/rsc/runtime-warnings.ts +9 -10
  177. package/src/rsc/server-action.ts +17 -37
  178. package/src/rsc/ssr-setup.ts +16 -0
  179. package/src/rsc/types.ts +8 -2
  180. package/src/runtime-env.ts +18 -0
  181. package/src/search-params.ts +4 -4
  182. package/src/segment-content-promise.ts +67 -0
  183. package/src/segment-loader-promise.ts +122 -0
  184. package/src/segment-system.tsx +132 -116
  185. package/src/serialize.ts +243 -0
  186. package/src/server/context.ts +175 -53
  187. package/src/server/cookie-store.ts +28 -4
  188. package/src/server/request-context.ts +67 -51
  189. package/src/ssr/index.tsx +5 -1
  190. package/src/static-handler.ts +25 -3
  191. package/src/testing/cache-status.ts +166 -0
  192. package/src/testing/collect-handle.ts +63 -0
  193. package/src/testing/dispatch.ts +581 -0
  194. package/src/testing/dom.entry.ts +22 -0
  195. package/src/testing/e2e/fixture.ts +188 -0
  196. package/src/testing/e2e/index.ts +149 -0
  197. package/src/testing/e2e/matchers.ts +51 -0
  198. package/src/testing/e2e/page-helpers.ts +272 -0
  199. package/src/testing/e2e/parity.ts +326 -0
  200. package/src/testing/e2e/server.ts +195 -0
  201. package/src/testing/flight-matchers.ts +110 -0
  202. package/src/testing/flight-normalize.ts +38 -0
  203. package/src/testing/flight-runtime.d.ts +57 -0
  204. package/src/testing/flight-tree.ts +682 -0
  205. package/src/testing/flight.entry.ts +51 -0
  206. package/src/testing/flight.ts +234 -0
  207. package/src/testing/generated-routes.ts +223 -0
  208. package/src/testing/index.ts +106 -0
  209. package/src/testing/internal/context.ts +304 -0
  210. package/src/testing/internal/flight-client-globals.ts +30 -0
  211. package/src/testing/internal/seed-vars.ts +42 -0
  212. package/src/testing/render-handler.ts +323 -0
  213. package/src/testing/render-route.tsx +590 -0
  214. package/src/testing/run-loader.ts +363 -0
  215. package/src/testing/run-middleware.ts +205 -0
  216. package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
  217. package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
  218. package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
  219. package/src/testing/vitest-stubs/version.ts +5 -0
  220. package/src/testing/vitest.ts +285 -0
  221. package/src/types/global-namespace.ts +39 -26
  222. package/src/types/handler-context.ts +68 -50
  223. package/src/types/index.ts +1 -0
  224. package/src/types/loader-types.ts +11 -9
  225. package/src/types/request-scope.ts +126 -0
  226. package/src/types/route-entry.ts +11 -0
  227. package/src/types/segments.ts +35 -2
  228. package/src/urls/include-helper.ts +34 -67
  229. package/src/urls/index.ts +1 -5
  230. package/src/urls/path-helper-types.ts +41 -7
  231. package/src/urls/path-helper.ts +17 -52
  232. package/src/urls/pattern-types.ts +36 -19
  233. package/src/urls/response-types.ts +22 -29
  234. package/src/urls/type-extraction.ts +58 -139
  235. package/src/urls/urls-function.ts +1 -5
  236. package/src/use-loader.tsx +413 -42
  237. package/src/vite/debug.ts +185 -0
  238. package/src/vite/discovery/bundle-postprocess.ts +6 -6
  239. package/src/vite/discovery/discover-routers.ts +106 -75
  240. package/src/vite/discovery/discovery-errors.ts +194 -0
  241. package/src/vite/discovery/gate-state.ts +171 -0
  242. package/src/vite/discovery/prerender-collection.ts +67 -26
  243. package/src/vite/discovery/route-types-writer.ts +40 -84
  244. package/src/vite/discovery/self-gen-tracking.ts +27 -1
  245. package/src/vite/discovery/state.ts +33 -0
  246. package/src/vite/discovery/virtual-module-codegen.ts +13 -23
  247. package/src/vite/index.ts +2 -0
  248. package/src/vite/plugin-types.ts +67 -0
  249. package/src/vite/plugins/cjs-to-esm.ts +8 -7
  250. package/src/vite/plugins/client-ref-dedup.ts +16 -0
  251. package/src/vite/plugins/client-ref-hashing.ts +28 -5
  252. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  253. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  254. package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
  255. package/src/vite/plugins/expose-action-id.ts +54 -30
  256. package/src/vite/plugins/expose-id-utils.ts +12 -8
  257. package/src/vite/plugins/expose-ids/export-analysis.ts +100 -20
  258. package/src/vite/plugins/expose-ids/handler-transform.ts +8 -61
  259. package/src/vite/plugins/expose-ids/loader-transform.ts +3 -5
  260. package/src/vite/plugins/expose-ids/router-transform.ts +20 -3
  261. package/src/vite/plugins/expose-internal-ids.ts +496 -486
  262. package/src/vite/plugins/performance-tracks.ts +29 -25
  263. package/src/vite/plugins/use-cache-transform.ts +65 -50
  264. package/src/vite/plugins/version-injector.ts +39 -23
  265. package/src/vite/plugins/version-plugin.ts +59 -2
  266. package/src/vite/plugins/virtual-entries.ts +2 -2
  267. package/src/vite/rango.ts +116 -29
  268. package/src/vite/router-discovery.ts +750 -100
  269. package/src/vite/utils/ast-handler-extract.ts +15 -15
  270. package/src/vite/utils/banner.ts +1 -1
  271. package/src/vite/utils/bundle-analysis.ts +4 -2
  272. package/src/vite/utils/client-chunks.ts +190 -0
  273. package/src/vite/utils/forward-user-plugins.ts +193 -0
  274. package/src/vite/utils/manifest-utils.ts +8 -59
  275. package/src/vite/utils/package-resolution.ts +41 -1
  276. package/src/vite/utils/prerender-utils.ts +21 -6
  277. package/src/vite/utils/shared-utils.ts +107 -26
  278. package/src/browser/action-response-classifier.ts +0 -99
@@ -68,7 +68,10 @@ createRouter({
68
68
 
69
69
  - `"use cache"` (no name) resolves to `default`.
70
70
  - `"use cache: short"` resolves to the `short` profile.
71
- - Unknown profile names throw at build/boot time.
71
+ - Unknown profile names throw at runtime, on the first invocation of the cached
72
+ function (the Vite transform does not validate names at build/boot). The error
73
+ is actionable -- it names the missing profile and shows the `createRouter({
74
+ cacheProfiles: { ... } })` entry to add.
72
75
 
73
76
  ## Cache Key
74
77
 
@@ -77,18 +80,33 @@ use-cache:{functionId}:{serializedArgs}
77
80
  ```
78
81
 
79
82
  - `functionId` -- stable ID from Vite transform (module path + export name).
80
- - `serializedArgs` -- non-tainted arguments serialized via RSC `encodeReply()`.
83
+ - `serializedArgs` -- key-generating arguments serialized via RSC `encodeReply()`.
84
+
85
+ When there are no key-generating arguments, the key has no trailing colon -- it is
86
+ just `use-cache:{functionId}`.
81
87
 
82
88
  Different functions always produce different cache keys, even for the same route.
83
89
  This is important for intercepted routes -- the path handler and intercept handler
84
90
  each have their own `functionId` and therefore their own cache entries.
85
91
 
92
+ ### Route context is folded into the key
93
+
94
+ The tainted `ctx` object is excluded from arg serialization (see below), but
95
+ route-identifying fields read off it are extracted into `serializedArgs`:
96
+ `url.host`, route name (`_routeName`), `pathname`, `params`, response type
97
+ (`_responseType`), and the user-facing sorted search params (internal `_rsc*`/`__`
98
+ params excluded). The same cached function called with `ctx` on different routes,
99
+ param combinations, hosts, response types, or query variants therefore produces
100
+ distinct cache entries -- not one shared entry.
101
+
86
102
  ## Tainted Arguments (ctx, env, req)
87
103
 
88
104
  Request-scoped objects are branded with `Symbol.for('rango:nocache')` at creation.
89
105
  When detected:
90
106
 
91
107
  1. **Excluded from cache key** -- request-scoped, not meaningful for keying.
108
+ (The route-identifying fields read off `ctx` are still folded in -- see
109
+ "Route context is folded into the key" above.)
92
110
  2. **Handle data captured on miss** -- side effects via `ctx.use(Handle)` are recorded.
93
111
  3. **Handle data replayed on hit** -- restored into the current request's HandleStore.
94
112
 
@@ -122,12 +140,16 @@ const data = await getCachedData(locale); // locale is now in the cache key
122
140
  These ctx methods **throw** inside a `"use cache"` function because their effects
123
141
  are lost on cache hit (the function body is skipped):
124
142
 
125
- - `ctx.set()` / `ctx.get()` for passing values to children
143
+ - `ctx.set()` for passing values to children
126
144
  - `ctx.header()`
127
145
  - `ctx.setTheme()`
128
146
  - `ctx.setLocationState()`
129
147
  - `ctx.onResponse()`
130
148
 
149
+ `ctx.get()` is **not** exec-guarded inside `"use cache"` -- it is a read, so it is
150
+ safe. (It only throws when reading a non-cacheable variable inside the separate
151
+ route-level `cache()` DSL boundary.)
152
+
131
153
  The error message recommends two alternatives:
132
154
 
133
155
  1. Extract the data fetch into a separate cached function and call ctx methods outside it.
@@ -304,8 +326,15 @@ export async function getProducts() {
304
326
  ## Backing Store
305
327
 
306
328
  Writes to the same `SegmentCacheStore` as `cache()` DSL, `Static()`, and `Prerender()`.
307
- One store, one configuration, one invalidation API. Tag-based invalidation
308
- (`revalidateTag`) works across all mechanisms.
329
+ One store, one configuration.
330
+
331
+ Cache entries (and `cacheProfiles`) accept an optional `tags` field, but the
332
+ built-in stores (`MemorySegmentCacheStore`, `CFCacheStore`) do not yet index or
333
+ invalidate by tag -- tags are passed through to the store and otherwise ignored.
334
+ Tag-based invalidation (`revalidateTag`) is a forward-looking API that requires a
335
+ custom store with secondary indices. Today entries expire by TTL/SWR. The separate
336
+ `revalidate()` export is the client-update axis (which segments re-render on a
337
+ navigation or action), not a cache bust.
309
338
 
310
339
  ## Interaction with Other Caching
311
340
 
@@ -0,0 +1,294 @@
1
+ ---
2
+ name: view-transitions
3
+ description: Configure React View Transitions on layouts, routes, and parallel slots in @rangojs/router
4
+ argument-hint: [layout|route|parallel|intercept]
5
+ ---
6
+
7
+ # View Transitions
8
+
9
+ `transition()` opts a route (or group of routes) into transition-driven navigation. It does two things, and you choose how far to go:
10
+
11
+ 1. **`startTransition` (the foundation).** The navigation commit is driven through React's `startTransition`. That holds the previous content across a same-route navigation (stale-while-revalidate — no loading-skeleton flash) and is the **precondition** for any view-transition animation. Works on **all** React versions.
12
+ 2. **`<ViewTransition>` (the animation, layered on top).** On experimental React, rango also wraps the segment content in React's `<ViewTransition>` so the swap cross-fades/morphs. This is the only part that needs experimental React; pass `viewTransition: false` to keep #1 without it (and place your own `<ViewTransition>` where you want it).
13
+
14
+ > The `<ViewTransition>` layer requires React experimental (the build that exports `<ViewTransition>` / `addTransitionType`). On stable React that layer is a no-op — but the `startTransition` driving (content hold) still applies.
15
+
16
+ ## Purpose: `startTransition` vs `<ViewTransition>`
17
+
18
+ These are two **independent** mechanisms. `startTransition` controls _fallbacks_ (hold the old content vs. flash the Suspense skeleton) and is what lets a view transition fire at all; the `<ViewTransition>` boundary is the _visual cross-fade_.
19
+
20
+ | | `startTransition` **OFF** | `startTransition` **ON** |
21
+ | -------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
22
+ | **`<ViewTransition>` OFF** | plain nav — remount on param change, skeleton flash, no animation | **hold** content (no skeleton flash); a consumer-placed `<ViewTransition>` still morphs; no router cross-fade |
23
+ | **`<ViewTransition>` ON** | **impossible** — React never activates `<ViewTransition>` outside a Transition | hold + router cross-fade |
24
+
25
+ The bottom-left cell is the key constraint: a view transition cannot exist without a `startTransition`. So once you reach for `transition()`, the only real choice is _startTransition_ vs _startTransition + ViewTransition_:
26
+
27
+ | What you want | Config | Effect |
28
+ | -------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
29
+ | nothing (default nav) | no `transition()` | remount + skeleton on param change |
30
+ | `startTransition` only | `transition({ viewTransition: false })` | hold content; place your own `<ViewTransition>` where you want it |
31
+ | `startTransition` + `<ViewTransition>` | `transition({})` / `transition({ enter, exit, … })` | hold + router cross-fade (experimental React; on stable it degrades to the `startTransition`-only row) |
32
+
33
+ `createRouter({ viewTransition: "auto" \| false })` sets the app-wide default for the third row; a per-segment `viewTransition` wins. See [Opting out of the router boundary](#opting-out-of-the-router-boundary-place-your-own-viewtransition) for the full opt-out story.
34
+
35
+ ## What `transition()` does (wrap location)
36
+
37
+ `transition(config)` attaches a [`TransitionConfig`](#transitionconfig) to the surrounding entry. Where the wrap actually lands in the rendered React tree depends on the segment type:
38
+
39
+ | Segment type | Wrap location |
40
+ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
+ | `layout()` | Around the layout's **default outlet content** (what the layout's `<Outlet />` renders), recursively pushed past nested layouts. Parallel slots (`<ParallelOutlet />`) are siblings of the wrap, not subtree members. |
42
+ | `path()` / `route()` | Around the **route's component itself** (the leaf content). |
43
+ | `parallel()` / `intercept()` slot | `transition()` is accepted by the DSL today, but slot-level rendering does not currently apply a `<ViewTransition>` wrapper. Mount intercept slots in layouts so layout transitions stay scoped to the default outlet. For modal-specific morphs today, use an element-level React `<ViewTransition>` inside the modal component. |
44
+
45
+ The layout case is the important one: stacking a layout transition does **not** wrap the layout chrome (header, sidebar, modal slot); it only morphs whatever flows through that layout's `<Outlet />`.
46
+
47
+ ## Basic Usage
48
+
49
+ A simple cross-fade between pages that share a layout:
50
+
51
+ ```tsx
52
+ import { urls } from "@rangojs/router";
53
+ import { Outlet } from "@rangojs/router/client";
54
+
55
+ function ShopShell({ children }: { children: React.ReactNode }) {
56
+ return (
57
+ <div className="shop">
58
+ <NavBar />
59
+ <main>
60
+ <Outlet /> {/* fade applies HERE */}
61
+ </main>
62
+ <Footer />
63
+ </div>
64
+ );
65
+ }
66
+
67
+ export const urlpatterns = urls(({ layout, path, transition }) => [
68
+ layout(<ShopShell />, () => [
69
+ transition({ default: "page-fade" }),
70
+ path("/", ShopIndex, { name: "index" }),
71
+ path("/about", AboutPage, { name: "about" }),
72
+ path("/contact", ContactPage, { name: "contact" }),
73
+ ]),
74
+ ]);
75
+ ```
76
+
77
+ ```css
78
+ ::view-transition-old(root) {
79
+ animation: fade-out 200ms ease both;
80
+ }
81
+ ::view-transition-new(root) {
82
+ animation: fade-in 200ms ease both;
83
+ }
84
+ .page-fade {
85
+ /* class hooks per phase */
86
+ }
87
+ ```
88
+
89
+ Navigating between `/`, `/about`, and `/contact` morphs the `<Outlet />` content with the `page-fade` class. The shell (NavBar, Footer) does not morph because the wrap sits inside the shell, not around it.
90
+
91
+ ## Direction-aware transitions
92
+
93
+ `ViewTransitionClass` accepts an object form keyed by transition type. Rango tags forward navigations as `"navigation"` and back/forward popstate as `"navigation-back"`:
94
+
95
+ ```tsx
96
+ layout(<ShopShell />, () => [
97
+ transition({
98
+ default: {
99
+ navigation: "slide-left",
100
+ "navigation-back": "slide-right",
101
+ },
102
+ }),
103
+ path("/", ShopIndex, { name: "index" }),
104
+ path("/about", AboutPage, { name: "about" }),
105
+ ]);
106
+ ```
107
+
108
+ ```css
109
+ .slide-left {
110
+ animation-name: slide-from-right;
111
+ }
112
+ .slide-right {
113
+ animation-name: slide-from-left;
114
+ }
115
+ ```
116
+
117
+ > Note: `"action"` is only tagged on partial-update action/refetch paths today; ordinary `server-action-bridge` commits (`useAction` / `useActionState` revalidations) are not currently tagged. Don't rely on an `action`-keyed class to fire on every form action.
118
+
119
+ ## Wrapper form: applying transition to a group of routes
120
+
121
+ `transition(config, () => [...])` creates a transparent layout that applies the config to its children — useful when you want a transition without authoring a real layout component:
122
+
123
+ ```tsx
124
+ urls(({ path, transition }) => [
125
+ // No layout component, but every route inside gets the fade.
126
+ transition({ default: "fade" }, () => [
127
+ path("/", HomePage, { name: "home" }),
128
+ path("/about", AboutPage, { name: "about" }),
129
+ ]),
130
+ // Outside the wrapper — no transition applied.
131
+ path("/admin", AdminPage, { name: "admin" }),
132
+ ]);
133
+ ```
134
+
135
+ ## Intercept (modal) interaction
136
+
137
+ This is where the rango-specific behavior pays off. A common shape:
138
+
139
+ ```tsx
140
+ import { urls } from "@rangojs/router";
141
+ import { Outlet, ParallelOutlet } from "@rangojs/router/client";
142
+
143
+ function GalleryShell() {
144
+ return (
145
+ <>
146
+ <NavBar />
147
+ <main>
148
+ <Outlet /> {/* page transition lands here */}
149
+ </main>
150
+ <ParallelOutlet name="@modal" />{" "}
151
+ {/* modal mounts here — sibling of the VT */}
152
+ </>
153
+ );
154
+ }
155
+
156
+ export const urlpatterns = urls(
157
+ ({ layout, path, intercept, transition, loader, loading }) => [
158
+ layout(<GalleryShell />, () => [
159
+ transition({ default: "fade" }),
160
+
161
+ path("/", GalleryFeed, { name: "feed" }),
162
+ path("/photos/:id", PhotoPage, { name: "photo" }),
163
+
164
+ intercept("@modal", "photo", <PhotoModal />, () => [
165
+ loader(PhotoLoader),
166
+ loading(<PhotoModalSkeleton />),
167
+ ]),
168
+ ]),
169
+ ],
170
+ );
171
+ ```
172
+
173
+ | Action | What fires |
174
+ | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
175
+ | Navigate `/` ↔ `/about` (within `GalleryShell`) | Layout transition fires; `<Outlet />` content cross-fades |
176
+ | Click `<Link to="/photos/42" />` from `/` | Soft navigation opens `<PhotoModal />` in `@modal`; **no** view transition fires on the underlying feed |
177
+ | Submit a form action inside `<PhotoModal />` | Revalidation commits without firing the layout VT; modal subtree identity is preserved (no remount, `useActionState` survives) |
178
+ | Close modal via `router.back()` | Underlying page is restored; **no** view transition fires |
179
+ | Direct URL load `/photos/42` | Renders the full `<PhotoPage />` with no modal; the layout transition applies on subsequent in-layout navs |
180
+
181
+ The "no VT on modal open" guarantee holds at any depth — if the layout that owns `@modal` is itself nested inside another transitioned layout, the outer transition is pushed past the inner layout into its default outlet content, so the modal slot ends up outside both VTs.
182
+
183
+ ## Per-route transition
184
+
185
+ Routes are leaves: their `transition()` wraps the route component itself.
186
+
187
+ ```tsx
188
+ urls(({ path, transition }) => [
189
+ path("/checkout", CheckoutPage, { name: "checkout" }, () => [
190
+ transition({ default: "fade-in" }),
191
+ ]),
192
+ ]);
193
+ ```
194
+
195
+ This is the right level for one-off route-specific morphs that should not propagate to siblings.
196
+
197
+ ## TransitionConfig
198
+
199
+ `transition()` accepts the props of React's `<ViewTransition>` (minus `children`/refs). Each phase prop accepts either a plain class string or an object keyed by transition type:
200
+
201
+ ```ts
202
+ import type { TransitionConfig } from "@rangojs/router";
203
+
204
+ interface TransitionConfig {
205
+ enter?: string | Record<string, string>;
206
+ exit?: string | Record<string, string>;
207
+ update?: string | Record<string, string>;
208
+ share?: string | Record<string, string>;
209
+ default?: string | Record<string, string>; // fallback for any phase
210
+ name?: string; // explicit view-transition-name
211
+ viewTransition?: "auto" | false; // boundary opt-out (see below)
212
+ }
213
+ ```
214
+
215
+ - `default` is the catch-all if a phase-specific prop is unset.
216
+ - The object form keys are React transition types tagged by rango: `"navigation"` (forward navigations), `"navigation-back"` (popstate cache restores), and `"action"` (partial-update action/refetch paths only — see the caveat in "Direction-aware transitions").
217
+ - `name` lets you participate in cross-page morphs by name (advanced; you usually don't need this on a layout/route-level wrap).
218
+ - `viewTransition` toggles whether rango places its own `<ViewTransition>` boundary. `"auto"` (default) wraps as described above; `false` opts out — see the next section.
219
+
220
+ ## Opting out of the router boundary (place your own `<ViewTransition>`)
221
+
222
+ By default a `transition()` segment gets a rango-placed `<ViewTransition>` boundary — a cross-fade of the whole outlet/route. If you'd rather animate specific elements yourself (place `<ViewTransition name="...">` in your components), set `viewTransition: false`. The router then contributes **no boundary of its own** but still:
223
+
224
+ - drives the navigation commit through `startTransition` (so React runs `document.startViewTransition`, and your own `<ViewTransition>` elements animate on navigation — driving is what they need, not a router boundary), and
225
+ - holds same-route content (stale-while-revalidate; no skeleton flash).
226
+
227
+ ```tsx
228
+ // Router drives the transition + holds content, but places NO cross-fade.
229
+ // Only your <ViewTransition name="hero"> morphs.
230
+ urls(({ path, transition }) => [
231
+ path("/product/:id", ProductPage, { name: "product" }, () => [
232
+ transition({ viewTransition: false }),
233
+ ]),
234
+ ]);
235
+
236
+ // ProductPage renders the boundary itself, exactly where it's wanted:
237
+ function ProductPage() {
238
+ return (
239
+ <ViewTransition name="hero">
240
+ <img src={cover} />
241
+ </ViewTransition>
242
+ );
243
+ }
244
+ ```
245
+
246
+ This is the rango analogue of the "router triggers, you place the names" model used by React Router / TanStack: rango guarantees navigations run inside a React transition; you own the boundaries.
247
+
248
+ **App-wide default.** Flip the default for every `transition()` segment at the router level. A per-segment `viewTransition` still overrides it.
249
+
250
+ ```ts
251
+ const router = createRouter<AppEnv>({ viewTransition: false });
252
+ // Now `transition({})` drives + holds but places no boundary anywhere.
253
+ // Re-enable a router boundary on one route with transition({ viewTransition: "auto" }).
254
+ ```
255
+
256
+ **Precedence (per-route vs router default).** A bare `transition({})` has no per-route `viewTransition`, so it inherits the router default (`"auto"` unless `createRouter({ viewTransition: false })`). An explicit per-route value always wins. The `viewTransition` flag only toggles the boundary — `startTransition` driving and content-hold are on in every row below (they key off `transition()` presence, not this flag):
257
+
258
+ | per-route (`transition(...)`) | router (`createRouter`) | resolved boundary | result |
259
+ | ---------------------------------------- | ----------------------- | ------------------------ | ----------- |
260
+ | `transition({})` (unset) | `"auto"` (default) | wrap | **ST + VT** |
261
+ | `transition({})` (unset) | `false` | no wrap | **ST only** |
262
+ | `transition({ viewTransition: "auto" })` | `"auto"` | wrap | ST + VT |
263
+ | `transition({ viewTransition: "auto" })` | `false` | wrap (per-route wins) | **ST + VT** |
264
+ | `transition({ viewTransition: false })` | `"auto"` | no wrap (per-route wins) | **ST only** |
265
+ | `transition({ viewTransition: false })` | `false` | no wrap | ST only |
266
+
267
+ On stable React the "VT" column is always a no-op (there is no `<ViewTransition>`), so every row collapses to its `startTransition`-only behavior there.
268
+
269
+ | Config | Router boundary | startTransition driving (no skeleton flash) | Your own `<ViewTransition name>` |
270
+ | ---------------------------------------------------- | ---------------- | ------------------------------------------- | ---------------------------------- |
271
+ | no `transition()` | — | no | does not fire on nav |
272
+ | `transition({})` / `{ viewTransition: "auto" }` | yes (cross-fade) | yes | fires, under the router cross-fade |
273
+ | `transition({ viewTransition: false })` | none | yes | fires alone |
274
+ | global `viewTransition: false`, route `transition()` | none | yes | fires alone |
275
+
276
+ > On **stable** React there is no `<ViewTransition>` at all, so `viewTransition: false` is visually a no-op there — but the startTransition driving and content-hold still apply, identical to `transition({})`.
277
+
278
+ ## Recommendations
279
+
280
+ **Put `<ParallelOutlet />` in layouts, not routes.** A route-level `transition` wraps the route component itself, so a `<ParallelOutlet />` rendered directly inside that route component remains inside the route VT subtree — modal opens on a route with a parallel outlet _will_ trigger the route's VT walker. The narrowing fix only applies at layout boundaries. If you combine intercept modals with route-level transitions, mount the slot one level up in a layout.
281
+
282
+ **Don't stack `transition()` on every layout level.** When ancestor and descendant layouts both configure transitions, both wraps end up nested around the deepest default outlet content. Two VTs fire on every nav within the inner layout. That's usually not what you want — pick the level where the morph belongs and apply it once.
283
+
284
+ **Need a modal-only morph?** Per-slot `transition()` is currently a no-op at render time, so use an element-level React `<ViewTransition>` inside the modal component (or a CSS animation) for the modal-entrance effect.
285
+
286
+ **Action revalidation inside a modal is safe.** Server-action submits inside an open modal don't fire the underlying layout VT. Modal subtree identity is preserved across revalidation — so `useActionState`, focus, and scroll all survive the round-trip.
287
+
288
+ ## Notes
289
+
290
+ - `transition()` is part of the route DSL. The allow-list table in [skills/handler-use](../handler-use/SKILL.md) permits it inside `layout()`, `path()`/`route()`, `parallel()` (per-slot or shared), and `intercept()`. At render time, only the layout and route wraps actually take effect today; `parallel()`/`intercept()` slot-level rendering does not currently apply the wrap.
291
+ - Wrap location for layouts: rango walks the rendered tree past `MountContextProvider`/`OutletProvider`/`LoaderBoundary` for layout segments and applies the wrap at the first non-layout target ([segment-system.tsx](../../src/segment-system.tsx) — `wrapDefaultOutletContent`). This is what keeps parallel slots out of the VT subtree.
292
+ - Tree consistency: the wrapper structure is identical across normal commits, intercept-active commits, and action revalidations — React never sees an element-type swap, so layout/modal subtrees are not remounted across these transitions.
293
+ - Element-level `<ViewTransition>` (importing it directly from React and using `name`/`share` to morph specific elements across pages) composes with rango's segment-level wraps as usual; rango doesn't intercept those.
294
+ - See also: [skills/intercept](../intercept/SKILL.md), [skills/parallel](../parallel/SKILL.md), [skills/layout](../layout/SKILL.md).
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Simulates a consumer augmenting the Rango global namespace, the way a real
3
+ * app does in router.tsx (Env/Vars) and via the generated router.named-routes.gen.ts
4
+ * (GeneratedRouteMap).
5
+ *
6
+ * This file is compiled ONLY by tsconfig.augment-check.json and is excluded from
7
+ * the main program, so the global augmentation here does not leak into the rest
8
+ * of the type tests, which assert the UNAUGMENTED fallbacks
9
+ * (see src/__tests__/augmentation-fallback-types.test.ts).
10
+ */
11
+
12
+ export interface TestBindings {
13
+ DB: { query: (sql: string) => string };
14
+ SECRET: string;
15
+ }
16
+
17
+ export interface TestVars {
18
+ user?: { id: string; role: "admin" | "user" };
19
+ requestId?: string;
20
+ }
21
+
22
+ /**
23
+ * A userland domain type that controls its own JSON wire shape via `toJSON()`.
24
+ * This is the augmentation hook: `Rango.JsonSerialize` honors `toJSON()`, so a
25
+ * consumer adjusts how their type serializes with no registry API.
26
+ */
27
+ export class Money {
28
+ constructor(public cents: number) {}
29
+ toJSON(): number {
30
+ return this.cents;
31
+ }
32
+ }
33
+
34
+ /**
35
+ * Mirrors `typeof router.routeMap`: the same routes as the generated map, plus a
36
+ * response route whose payload carries a userland class (`Money`, with
37
+ * `toJSON()`) and a `Date` — used to assert `Rango.PathResponse` reports the
38
+ * serialized JSON wire shape.
39
+ */
40
+ export interface TestRegisteredRoutes {
41
+ readonly home: "/";
42
+ readonly "blog.post": "/blog/:slug";
43
+ readonly search: {
44
+ readonly path: "/search";
45
+ readonly search: { readonly q: "string"; readonly page: "number?" };
46
+ };
47
+ readonly order: {
48
+ readonly path: "/orders/:id";
49
+ readonly response: { id: string; total: Money; placedAt: Date };
50
+ };
51
+ }
52
+
53
+ declare global {
54
+ namespace Rango {
55
+ interface Env extends TestBindings {}
56
+ interface Vars extends TestVars {}
57
+ interface RegisteredRoutes extends TestRegisteredRoutes {}
58
+ // Mirrors the shape emitted into router.named-routes.gen.ts: plain string
59
+ // patterns, plus { path, search } objects for routes with a search schema.
60
+ interface GeneratedRouteMap {
61
+ readonly home: "/";
62
+ readonly "blog.post": "/blog/:slug";
63
+ readonly search: {
64
+ readonly path: "/search";
65
+ readonly search: { readonly q: "string"; readonly page: "number?" };
66
+ };
67
+ }
68
+
69
+ // Userland serialization overrides: full-transform replacement that
70
+ // special-cases one type and delegates the rest to the built-in. Isolated to
71
+ // this augment-check program, so the main suite's built-in behavior (e.g.
72
+ // JsonSerialize<bigint> = never) is unaffected — demonstrating overrides are
73
+ // per-project augmentation.
74
+ interface JsonSerializeOverride<T> {
75
+ app: T extends bigint ? string : Rango.JsonSerializeBuiltin<T>;
76
+ }
77
+ interface FlightSerializeOverride<T> {
78
+ app: T extends Money ? number : Rango.FlightSerializeBuiltin<T>;
79
+ }
80
+ }
81
+ }
@@ -0,0 +1,116 @@
1
+ /**
2
+ * Compile-only assertions for the AUGMENTED Rango namespace.
3
+ *
4
+ * Pins the type-safety contract a consumer gets after augmenting Env, Vars, and
5
+ * GeneratedRouteMap. A regression in the fallback chains (global-namespace.ts)
6
+ * turns these into tsc errors. Run via tsconfig.augment-check.json.
7
+ */
8
+ import "./augment.js";
9
+ import type { Handler, RouteParams, RouteSearchParams } from "../index.js";
10
+ import type { DefaultRouteName } from "../types/global-namespace.js";
11
+ import { href } from "../href-client.js";
12
+ import type { Money, TestBindings } from "./augment.js";
13
+
14
+ type Expect<T extends true> = T;
15
+ type Equal<A, B> =
16
+ (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2
17
+ ? true
18
+ : false;
19
+
20
+ // Env: ctx.env resolves to the augmented bindings, not `unknown`/`any`.
21
+ const envHandler: Handler<"home"> = (ctx) => {
22
+ type _envIsBindings = Expect<Equal<typeof ctx.env, TestBindings>>;
23
+ ctx.env.DB.query("select 1");
24
+ // @ts-expect-error - unknown binding is rejected once Env is augmented
25
+ ctx.env.MISSING();
26
+ return null;
27
+ };
28
+ void envHandler;
29
+
30
+ // Vars: ctx.get is keyed by the augmented Vars.
31
+ const varsHandler: Handler<"home"> = (ctx) => {
32
+ const user = ctx.get("user");
33
+ type _userTyped = Expect<
34
+ Equal<typeof user, { id: string; role: "admin" | "user" } | undefined>
35
+ >;
36
+ // @ts-expect-error - unknown var key is rejected once Vars is augmented
37
+ ctx.get("nope");
38
+ return null;
39
+ };
40
+ void varsHandler;
41
+
42
+ // routeName narrows to the generated route names.
43
+ type _routeName = Expect<
44
+ Equal<DefaultRouteName, "home" | "blog.post" | "search">
45
+ >;
46
+
47
+ // RouteParams / RouteSearchParams resolve from the generated map with no
48
+ // explicit route map argument.
49
+ type _params = Expect<Equal<RouteParams<"blog.post">, { slug: string }>>;
50
+ type _search = Expect<
51
+ Equal<RouteSearchParams<"search">, { q: string | undefined; page?: number }>
52
+ >;
53
+
54
+ // href / Rango.Path read GeneratedRouteMap even without a manual RegisteredRoutes
55
+ // augmentation — this is the core of the "rango generate alone enables typed
56
+ // href()" guarantee. The paths below come from the generated map in augment.ts.
57
+ href("/");
58
+ href("/blog/anything");
59
+ href("/search");
60
+ // @ts-expect-error - path is not in the generated route map
61
+ href("/not-a-route");
62
+
63
+ // Rango.Path is the ambient input type for wrapper functions around href().
64
+ // No import needed — it reads the same generated map href() does.
65
+ function wrappedHref(path: Rango.Path): string {
66
+ return href(path);
67
+ }
68
+ const arrowHref = (path: Rango.Path): string => href(path);
69
+
70
+ wrappedHref("/blog/anything");
71
+ arrowHref("/search?q=hello");
72
+ // @ts-expect-error - wrapper preserves the same generated-map validation
73
+ wrappedHref("/not-a-route");
74
+
75
+ // Userland serialization augmentation: a consumer's custom class adjusts its JSON
76
+ // wire shape via toJSON(), and Rango.PathResponse reports the serialized payload
77
+ // (Money -> number, Date -> string) — both by pattern and by concrete path.
78
+ type _orderWireByPattern = Expect<
79
+ Equal<
80
+ Rango.PathResponse<"/orders/:id">,
81
+ { id: string; total: number; placedAt: string }
82
+ >
83
+ >;
84
+ type _orderWireByPath = Expect<
85
+ Equal<
86
+ Rango.PathResponse<"/orders/42">,
87
+ { id: string; total: number; placedAt: string }
88
+ >
89
+ >;
90
+
91
+ // Project serialization overrides: the consumer augments JsonSerializeOverride /
92
+ // FlightSerializeOverride (see augment.ts) with a full transform that delegates to
93
+ // the built-in, and the transforms honor it — winning over the built-in rules.
94
+ // bigint normally JSON-serializes to `never`; Money is a class React Flight would
95
+ // otherwise reject structurally. Delegation keeps every other type (incl. the
96
+ // /orders payload above) on the built-in behavior.
97
+ type _jsonOverride = Expect<Equal<Rango.JsonSerialize<bigint>, string>>;
98
+ type _jsonOverrideNested = Expect<
99
+ Equal<
100
+ Rango.JsonSerialize<{ id: bigint; name: string }>,
101
+ { id: string; name: string }
102
+ >
103
+ >;
104
+ type _flightOverride = Expect<Equal<Rango.FlightSerialize<Money>, number>>;
105
+
106
+ // Reference the top-level assertion aliases so they are unambiguously evaluated.
107
+ export type _Assertions = [
108
+ _routeName,
109
+ _params,
110
+ _search,
111
+ _orderWireByPattern,
112
+ _orderWireByPath,
113
+ _jsonOverride,
114
+ _jsonOverrideNested,
115
+ _flightOverride,
116
+ ];