@rangojs/router 0.0.0-experimental.32 → 0.0.0-experimental.3232cd17

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 (376) hide show
  1. package/AGENTS.md +4 -0
  2. package/README.md +198 -44
  3. package/dist/bin/rango.js +287 -105
  4. package/dist/testing/vitest.js +82 -0
  5. package/dist/vite/index.js +3248 -1117
  6. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  7. package/package.json +73 -21
  8. package/skills/api-client/SKILL.md +211 -0
  9. package/skills/breadcrumbs/SKILL.md +107 -1
  10. package/skills/bundle-analysis/SKILL.md +159 -0
  11. package/skills/cache-guide/SKILL.md +245 -21
  12. package/skills/caching/SKILL.md +302 -6
  13. package/skills/composability/SKILL.md +27 -2
  14. package/skills/css/SKILL.md +76 -0
  15. package/skills/document-cache/SKILL.md +78 -55
  16. package/skills/handler-use/SKILL.md +364 -0
  17. package/skills/hooks/SKILL.md +270 -30
  18. package/skills/host-router/SKILL.md +82 -22
  19. package/skills/i18n/SKILL.md +276 -0
  20. package/skills/intercept/SKILL.md +49 -5
  21. package/skills/layout/SKILL.md +35 -9
  22. package/skills/links/SKILL.md +249 -17
  23. package/skills/loader/SKILL.md +294 -30
  24. package/skills/middleware/SKILL.md +52 -13
  25. package/skills/migrate-nextjs/SKILL.md +584 -0
  26. package/skills/migrate-react-router/SKILL.md +769 -0
  27. package/skills/mime-routes/SKILL.md +27 -0
  28. package/skills/observability/SKILL.md +137 -0
  29. package/skills/parallel/SKILL.md +203 -7
  30. package/skills/prerender/SKILL.md +123 -100
  31. package/skills/rango/SKILL.md +250 -22
  32. package/skills/react-compiler/SKILL.md +168 -0
  33. package/skills/response-routes/SKILL.md +122 -47
  34. package/skills/route/SKILL.md +97 -5
  35. package/skills/router-setup/SKILL.md +90 -5
  36. package/skills/server-actions/SKILL.md +775 -0
  37. package/skills/streams-and-websockets/SKILL.md +283 -0
  38. package/skills/tailwind/SKILL.md +27 -3
  39. package/skills/testing/SKILL.md +129 -0
  40. package/skills/testing/bindings.md +89 -0
  41. package/skills/testing/cache-prerender.md +124 -0
  42. package/skills/testing/client-components.md +122 -0
  43. package/skills/testing/e2e-parity.md +125 -0
  44. package/skills/testing/flight.md +92 -0
  45. package/skills/testing/handles.md +129 -0
  46. package/skills/testing/loader.md +128 -0
  47. package/skills/testing/middleware.md +99 -0
  48. package/skills/testing/render-handler.md +121 -0
  49. package/skills/testing/response-routes.md +95 -0
  50. package/skills/testing/reverse-and-types.md +84 -0
  51. package/skills/testing/server-actions.md +107 -0
  52. package/skills/testing/server-tree.md +128 -0
  53. package/skills/testing/setup.md +120 -0
  54. package/skills/typesafety/SKILL.md +329 -27
  55. package/skills/use-cache/SKILL.md +36 -5
  56. package/skills/view-transitions/SKILL.md +294 -0
  57. package/src/__augment-tests__/augment.ts +81 -0
  58. package/src/__augment-tests__/augmented.check.ts +116 -0
  59. package/src/__internal.ts +67 -40
  60. package/src/browser/action-coordinator.ts +53 -36
  61. package/src/browser/action-fence.ts +47 -0
  62. package/src/browser/app-shell.ts +39 -0
  63. package/src/browser/app-version.ts +14 -0
  64. package/src/browser/cookie-name.ts +140 -0
  65. package/src/browser/event-controller.ts +86 -147
  66. package/src/browser/history-state.ts +21 -0
  67. package/src/browser/index.ts +3 -3
  68. package/src/browser/invalidate-client-cache.ts +52 -0
  69. package/src/browser/link-interceptor.ts +4 -0
  70. package/src/browser/navigation-bridge.ts +148 -19
  71. package/src/browser/navigation-client.ts +187 -67
  72. package/src/browser/navigation-store-handle.ts +38 -0
  73. package/src/browser/navigation-store.ts +76 -67
  74. package/src/browser/navigation-transaction.ts +18 -66
  75. package/src/browser/partial-update.ts +123 -94
  76. package/src/browser/prefetch/cache.ts +214 -36
  77. package/src/browser/prefetch/fetch.ts +260 -38
  78. package/src/browser/prefetch/policy.ts +6 -0
  79. package/src/browser/prefetch/queue.ts +126 -20
  80. package/src/browser/prefetch/resource-ready.ts +77 -0
  81. package/src/browser/rango-state.ts +158 -76
  82. package/src/browser/react/Link.tsx +93 -11
  83. package/src/browser/react/NavigationProvider.tsx +115 -34
  84. package/src/browser/react/ScrollRestoration.tsx +10 -6
  85. package/src/browser/react/context.ts +7 -2
  86. package/src/browser/react/filter-segment-order.ts +49 -7
  87. package/src/browser/react/index.ts +0 -48
  88. package/src/browser/react/location-state-shared.ts +166 -8
  89. package/src/browser/react/location-state.ts +39 -14
  90. package/src/browser/react/use-action.ts +6 -15
  91. package/src/browser/react/use-handle.ts +23 -69
  92. package/src/browser/react/use-link-status.ts +0 -4
  93. package/src/browser/react/use-navigation.ts +22 -5
  94. package/src/browser/react/use-params.ts +20 -10
  95. package/src/browser/react/use-reverse.ts +106 -0
  96. package/src/browser/react/use-router.ts +46 -11
  97. package/src/browser/react/use-search-params.ts +0 -5
  98. package/src/browser/react/use-segments.ts +11 -21
  99. package/src/browser/response-adapter.ts +52 -1
  100. package/src/browser/rsc-router.tsx +215 -76
  101. package/src/browser/scroll-restoration.ts +46 -39
  102. package/src/browser/segment-reconciler.ts +36 -9
  103. package/src/browser/segment-structure-assert.ts +2 -2
  104. package/src/browser/server-action-bridge.ts +176 -50
  105. package/src/browser/types.ts +95 -11
  106. package/src/browser/validate-redirect-origin.ts +43 -16
  107. package/src/build/collect-fallback-refs.ts +107 -0
  108. package/src/build/generate-manifest.ts +65 -40
  109. package/src/build/generate-route-types.ts +5 -0
  110. package/src/build/index.ts +8 -2
  111. package/src/build/prefix-tree-utils.ts +123 -0
  112. package/src/build/route-trie.ts +137 -32
  113. package/src/build/route-types/codegen.ts +4 -4
  114. package/src/build/route-types/include-resolution.ts +9 -2
  115. package/src/build/route-types/param-extraction.ts +6 -3
  116. package/src/build/route-types/per-module-writer.ts +7 -4
  117. package/src/build/route-types/router-processing.ts +278 -96
  118. package/src/build/route-types/scan-filter.ts +9 -2
  119. package/src/build/route-types/source-scan.ts +118 -0
  120. package/src/build/runtime-discovery.ts +9 -20
  121. package/src/cache/cache-error.ts +104 -0
  122. package/src/cache/cache-policy.ts +68 -28
  123. package/src/cache/cache-runtime.ts +149 -43
  124. package/src/cache/cache-scope.ts +148 -81
  125. package/src/cache/cache-tag.ts +98 -0
  126. package/src/cache/cf/cf-cache-store.ts +2550 -93
  127. package/src/cache/cf/index.ts +11 -17
  128. package/src/cache/document-cache.ts +78 -27
  129. package/src/cache/handle-snapshot.ts +63 -0
  130. package/src/cache/index.ts +23 -20
  131. package/src/cache/memory-segment-store.ts +136 -37
  132. package/src/cache/profile-registry.ts +6 -30
  133. package/src/cache/read-through-swr.ts +41 -11
  134. package/src/cache/segment-codec.ts +0 -16
  135. package/src/cache/tag-invalidation.ts +230 -0
  136. package/src/cache/taint.ts +55 -0
  137. package/src/cache/types.ts +33 -100
  138. package/src/cache/vercel/index.ts +11 -0
  139. package/src/cache/vercel/vercel-cache-store.ts +799 -0
  140. package/src/client.rsc.tsx +6 -21
  141. package/src/client.tsx +108 -290
  142. package/src/component-utils.ts +19 -0
  143. package/src/context-var.ts +84 -2
  144. package/src/debug.ts +2 -2
  145. package/src/decode-loader-results.ts +36 -0
  146. package/src/defer.ts +196 -0
  147. package/src/deps/ssr.ts +0 -1
  148. package/src/errors.ts +30 -4
  149. package/src/handle.ts +70 -22
  150. package/src/handles/MetaTags.tsx +0 -14
  151. package/src/handles/breadcrumbs.ts +16 -5
  152. package/src/handles/meta.ts +0 -39
  153. package/src/host/cookie-handler.ts +0 -36
  154. package/src/host/errors.ts +0 -24
  155. package/src/host/index.ts +8 -2
  156. package/src/host/pattern-matcher.ts +7 -50
  157. package/src/host/router.ts +107 -99
  158. package/src/host/testing.ts +40 -27
  159. package/src/host/types.ts +37 -4
  160. package/src/host/utils.ts +1 -1
  161. package/src/href-client.ts +137 -22
  162. package/src/index.rsc.ts +52 -26
  163. package/src/index.ts +100 -38
  164. package/src/internal-debug.ts +2 -4
  165. package/src/loader-store.ts +500 -0
  166. package/src/loader.rsc.ts +20 -13
  167. package/src/loader.ts +12 -11
  168. package/src/missing-id-error.ts +68 -0
  169. package/src/network-error-thrower.tsx +1 -6
  170. package/src/outlet-context.ts +1 -1
  171. package/src/outlet-provider.tsx +1 -5
  172. package/src/prerender/param-hash.ts +10 -11
  173. package/src/prerender/store.ts +37 -41
  174. package/src/prerender.ts +198 -82
  175. package/src/redirect-origin.ts +100 -0
  176. package/src/response-utils.ts +37 -0
  177. package/src/reverse.ts +65 -15
  178. package/src/root-error-boundary.tsx +1 -19
  179. package/src/route-content-wrapper.tsx +7 -72
  180. package/src/route-definition/dsl-helpers.ts +437 -274
  181. package/src/route-definition/helper-factories.ts +29 -139
  182. package/src/route-definition/helpers-types.ts +113 -37
  183. package/src/route-definition/index.ts +3 -0
  184. package/src/route-definition/redirect.ts +52 -10
  185. package/src/route-definition/resolve-handler-use.ts +161 -0
  186. package/src/route-definition/use-item-types.ts +32 -0
  187. package/src/route-map-builder.ts +7 -17
  188. package/src/route-types.ts +37 -41
  189. package/src/router/basename.ts +14 -0
  190. package/src/router/content-negotiation.ts +108 -9
  191. package/src/router/error-handling.ts +13 -17
  192. package/src/router/find-match.ts +45 -22
  193. package/src/router/handler-context.ts +83 -41
  194. package/src/router/intercept-resolution.ts +25 -23
  195. package/src/router/lazy-includes.ts +19 -53
  196. package/src/router/loader-resolution.ts +213 -30
  197. package/src/router/logging.ts +5 -8
  198. package/src/router/manifest.ts +49 -45
  199. package/src/router/match-api.ts +120 -204
  200. package/src/router/match-context.ts +0 -22
  201. package/src/router/match-handlers.ts +58 -58
  202. package/src/router/match-middleware/background-revalidation.ts +27 -6
  203. package/src/router/match-middleware/cache-lookup.ts +205 -249
  204. package/src/router/match-middleware/cache-store.ts +45 -32
  205. package/src/router/match-middleware/intercept-resolution.ts +8 -28
  206. package/src/router/match-middleware/segment-resolution.ts +52 -18
  207. package/src/router/match-pipelines.ts +1 -42
  208. package/src/router/match-result.ts +104 -40
  209. package/src/router/metrics.ts +5 -34
  210. package/src/router/middleware-types.ts +13 -142
  211. package/src/router/middleware.ts +173 -143
  212. package/src/router/navigation-snapshot.ts +131 -0
  213. package/src/router/params-util.ts +23 -0
  214. package/src/router/pattern-matching.ts +109 -63
  215. package/src/router/prerender-match.ts +190 -54
  216. package/src/router/preview-match.ts +32 -102
  217. package/src/router/request-classification.ts +276 -0
  218. package/src/router/revalidation.ts +63 -55
  219. package/src/router/route-snapshot.ts +244 -0
  220. package/src/router/router-context.ts +6 -28
  221. package/src/router/router-interfaces.ts +100 -35
  222. package/src/router/router-options.ts +91 -11
  223. package/src/router/router-registry.ts +2 -5
  224. package/src/router/segment-resolution/fresh.ts +242 -75
  225. package/src/router/segment-resolution/helpers.ts +63 -24
  226. package/src/router/segment-resolution/loader-cache.ts +41 -37
  227. package/src/router/segment-resolution/revalidation.ts +456 -372
  228. package/src/router/segment-resolution/static-store.ts +19 -5
  229. package/src/router/segment-resolution/streamed-handler-telemetry.ts +52 -0
  230. package/src/router/segment-resolution/view-transition-default.ts +36 -0
  231. package/src/router/segment-resolution.ts +4 -1
  232. package/src/router/segment-wrappers.ts +2 -3
  233. package/src/router/state-cookie-name.ts +33 -0
  234. package/src/router/substitute-pattern-params.ts +56 -0
  235. package/src/router/telemetry-otel.ts +0 -20
  236. package/src/router/telemetry.ts +96 -19
  237. package/src/router/timeout.ts +0 -20
  238. package/src/router/trie-matching.ts +91 -46
  239. package/src/router/types.ts +10 -63
  240. package/src/router/url-params.ts +44 -0
  241. package/src/router.ts +134 -43
  242. package/src/rsc/handler-context.ts +3 -2
  243. package/src/rsc/handler.ts +492 -383
  244. package/src/rsc/helpers.ts +162 -46
  245. package/src/rsc/index.ts +1 -1
  246. package/src/rsc/json-route-result.ts +38 -0
  247. package/src/rsc/loader-fetch.ts +23 -3
  248. package/src/rsc/manifest-init.ts +33 -42
  249. package/src/rsc/origin-guard.ts +39 -25
  250. package/src/rsc/progressive-enhancement.ts +30 -3
  251. package/src/rsc/redirect-guard.ts +99 -0
  252. package/src/rsc/response-error.ts +79 -12
  253. package/src/rsc/response-route-handler.ts +90 -63
  254. package/src/rsc/rsc-rendering.ts +56 -54
  255. package/src/rsc/runtime-warnings.ts +23 -10
  256. package/src/rsc/server-action.ts +74 -67
  257. package/src/rsc/ssr-setup.ts +18 -2
  258. package/src/rsc/types.ts +25 -6
  259. package/src/runtime-env.ts +18 -0
  260. package/src/search-params.ts +4 -20
  261. package/src/segment-content-promise.ts +67 -0
  262. package/src/segment-loader-promise.ts +134 -0
  263. package/src/segment-system.tsx +272 -129
  264. package/src/serialize.ts +243 -0
  265. package/src/server/context.ts +309 -61
  266. package/src/server/cookie-store.ts +80 -5
  267. package/src/server/handle-store.ts +26 -24
  268. package/src/server/loader-registry.ts +10 -28
  269. package/src/server/request-context.ts +338 -126
  270. package/src/ssr/index.tsx +23 -15
  271. package/src/static-handler.ts +27 -18
  272. package/src/testing/cache-status.ts +162 -0
  273. package/src/testing/collect-handle.ts +40 -0
  274. package/src/testing/dispatch.ts +618 -0
  275. package/src/testing/dom.entry.ts +22 -0
  276. package/src/testing/e2e/fixture.ts +188 -0
  277. package/src/testing/e2e/index.ts +128 -0
  278. package/src/testing/e2e/matchers.ts +35 -0
  279. package/src/testing/e2e/page-helpers.ts +272 -0
  280. package/src/testing/e2e/parity.ts +387 -0
  281. package/src/testing/e2e/server.ts +195 -0
  282. package/src/testing/flight-matchers.ts +97 -0
  283. package/src/testing/flight-normalize.ts +11 -0
  284. package/src/testing/flight-runtime.d.ts +57 -0
  285. package/src/testing/flight-tree.ts +682 -0
  286. package/src/testing/flight.entry.ts +52 -0
  287. package/src/testing/flight.ts +232 -0
  288. package/src/testing/generated-routes.ts +183 -0
  289. package/src/testing/index.ts +99 -0
  290. package/src/testing/internal/context.ts +348 -0
  291. package/src/testing/internal/flight-client-globals.ts +30 -0
  292. package/src/testing/internal/seed-vars.ts +54 -0
  293. package/src/testing/render-handler.ts +330 -0
  294. package/src/testing/render-route.tsx +566 -0
  295. package/src/testing/run-loader.ts +378 -0
  296. package/src/testing/run-middleware.ts +205 -0
  297. package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
  298. package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
  299. package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
  300. package/src/testing/vitest-stubs/version.ts +5 -0
  301. package/src/testing/vitest.ts +305 -0
  302. package/src/theme/ThemeProvider.tsx +0 -52
  303. package/src/theme/ThemeScript.tsx +0 -6
  304. package/src/theme/constants.ts +0 -12
  305. package/src/theme/index.ts +0 -7
  306. package/src/theme/theme-context.ts +1 -5
  307. package/src/theme/theme-script.ts +0 -14
  308. package/src/theme/use-theme.ts +0 -3
  309. package/src/types/boundaries.ts +0 -35
  310. package/src/types/cache-types.ts +17 -8
  311. package/src/types/error-types.ts +30 -90
  312. package/src/types/global-namespace.ts +54 -41
  313. package/src/types/handler-context.ts +233 -81
  314. package/src/types/index.ts +1 -10
  315. package/src/types/loader-types.ts +44 -15
  316. package/src/types/request-scope.ts +107 -0
  317. package/src/types/route-config.ts +6 -50
  318. package/src/types/route-entry.ts +19 -7
  319. package/src/types/segments.ts +37 -14
  320. package/src/urls/include-helper.ts +33 -70
  321. package/src/urls/index.ts +1 -11
  322. package/src/urls/path-helper-types.ts +58 -11
  323. package/src/urls/path-helper.ts +57 -111
  324. package/src/urls/pattern-types.ts +48 -19
  325. package/src/urls/response-types.ts +25 -22
  326. package/src/urls/type-extraction.ts +58 -139
  327. package/src/urls/urls-function.ts +1 -18
  328. package/src/use-loader.tsx +346 -89
  329. package/src/vite/debug.ts +185 -0
  330. package/src/vite/discovery/bundle-postprocess.ts +36 -38
  331. package/src/vite/discovery/discover-routers.ts +130 -85
  332. package/src/vite/discovery/discovery-errors.ts +194 -0
  333. package/src/vite/discovery/gate-state.ts +171 -0
  334. package/src/vite/discovery/prerender-collection.ts +192 -99
  335. package/src/vite/discovery/route-types-writer.ts +40 -84
  336. package/src/vite/discovery/self-gen-tracking.ts +27 -1
  337. package/src/vite/discovery/state.ts +51 -6
  338. package/src/vite/discovery/virtual-module-codegen.ts +14 -34
  339. package/src/vite/index.ts +8 -0
  340. package/src/vite/plugin-types.ts +187 -69
  341. package/src/vite/plugins/cjs-to-esm.ts +8 -18
  342. package/src/vite/plugins/client-ref-dedup.ts +16 -11
  343. package/src/vite/plugins/client-ref-hashing.ts +28 -15
  344. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  345. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  346. package/src/vite/plugins/cloudflare-protocol-stub.ts +194 -0
  347. package/src/vite/plugins/expose-action-id.ts +49 -98
  348. package/src/vite/plugins/expose-id-utils.ts +11 -50
  349. package/src/vite/plugins/expose-ids/export-analysis.ts +76 -34
  350. package/src/vite/plugins/expose-ids/handler-transform.ts +10 -48
  351. package/src/vite/plugins/expose-ids/loader-transform.ts +3 -20
  352. package/src/vite/plugins/expose-ids/router-transform.ts +20 -16
  353. package/src/vite/plugins/expose-internal-ids.ts +554 -317
  354. package/src/vite/plugins/performance-tracks.ts +89 -0
  355. package/src/vite/plugins/refresh-cmd.ts +89 -27
  356. package/src/vite/plugins/use-cache-transform.ts +73 -83
  357. package/src/vite/plugins/vercel-output.ts +258 -0
  358. package/src/vite/plugins/version-injector.ts +21 -25
  359. package/src/vite/plugins/version-plugin.ts +41 -20
  360. package/src/vite/plugins/virtual-entries.ts +2 -17
  361. package/src/vite/rango.ts +257 -289
  362. package/src/vite/router-discovery.ts +930 -140
  363. package/src/vite/utils/ast-handler-extract.ts +15 -31
  364. package/src/vite/utils/banner.ts +4 -4
  365. package/src/vite/utils/bundle-analysis.ts +10 -15
  366. package/src/vite/utils/client-chunks.ts +184 -0
  367. package/src/vite/utils/forward-user-plugins.ts +171 -0
  368. package/src/vite/utils/manifest-utils.ts +4 -59
  369. package/src/vite/utils/package-resolution.ts +20 -52
  370. package/src/vite/utils/prerender-utils.ts +27 -29
  371. package/src/vite/utils/shared-utils.ts +92 -42
  372. package/src/browser/action-response-classifier.ts +0 -99
  373. package/src/browser/react/use-client-cache.ts +0 -58
  374. package/src/browser/shallow.ts +0 -40
  375. package/src/handles/index.ts +0 -7
  376. package/src/router/middleware-cookies.ts +0 -55
@@ -0,0 +1,584 @@
1
+ ---
2
+ name: migrate-nextjs
3
+ description: Migrate a Next.js App Router project to @rangojs/router. Use when the user asks to "migrate from Next.js", "convert Next.js to Rango", "replace Next.js", or has a Next.js app they want to port.
4
+ argument-hint: [path-to-nextjs-app]
5
+ ---
6
+
7
+ # Migrate from Next.js App Router to @rangojs/router
8
+
9
+ ## Why Rango
10
+
11
+ Common reasons to migrate:
12
+
13
+ - **Server components by default** — keep data fetching on the server without
14
+ framework-specific file conventions.
15
+ See: `/router-setup`, `/route`
16
+ - **Django-style route definition** — `urls()`, `path()`, and `layout()` make
17
+ the route tree explicit instead of spreading routing across many special files.
18
+ See: `/route`, `/layout`
19
+ - **Named routes** — reverse URLs by route name instead of hard-coding path
20
+ strings throughout the app.
21
+ See: `/links`, `/typesafety`
22
+ - **Clear execution model** — request scope, render scope, segment boundaries,
23
+ and shared `ctx` behavior are explicit in the routing model.
24
+ See: `/middleware`, `/loader`
25
+ - **Live data layer** — `createLoader()` and `loader()` keep data fresh
26
+ independently of cached UI. A route can serve cached segments while loaders
27
+ still resolve live on every request.
28
+ See: `/loader`, `/caching`, `/cache-guide`
29
+ - **Explicit caching model** — `cache()` DSL, `revalidate()`, `use cache`, and
30
+ custom cache stores make caching and revalidation behavior visible in code.
31
+ See: `/caching`, `/cache-guide`, `/use-cache`
32
+ - **Build-time rendering** — `Static()` and `Prerender()` provide explicit
33
+ build-time rendering instead of mixing rendering and caching behind conventions.
34
+ See: `/prerender`
35
+ - **Composable route tree** — layouts, includes, middleware, parallels, and
36
+ intercepts compose directly in the route definition.
37
+ See: `/composability`, `/parallel`, `/intercept`
38
+ - **Multi-router flexibility** — support multiple routers, domain routing, and
39
+ worker/edge-style deployment patterns.
40
+ See: `/host-router`
41
+
42
+ ## Migration Strategy
43
+
44
+ Work route-by-route, bottom-up. Start with leaf pages, then layouts, then middleware. Verify each route works before moving to the next.
45
+
46
+ ## 1. Project Setup
47
+
48
+ Replace Next.js tooling with Vite + Rango:
49
+
50
+ ```bash
51
+ npm remove next @next/env
52
+ npm install @rangojs/router @vitejs/plugin-react
53
+ npm install -D vite
54
+ ```
55
+
56
+ ```typescript
57
+ // vite.config.ts
58
+ import { defineConfig } from "vite";
59
+ import { rango } from "@rangojs/router/vite";
60
+
61
+ export default defineConfig({
62
+ plugins: [rango()],
63
+ });
64
+ ```
65
+
66
+ ```typescript
67
+ // src/router.tsx
68
+ import { createRouter } from "@rangojs/router";
69
+ import { Document } from "./document";
70
+ import { urlpatterns } from "./urls";
71
+
72
+ export default createRouter({
73
+ document: Document,
74
+ }).routes(urlpatterns);
75
+ ```
76
+
77
+ The Document component replaces `app/layout.tsx`'s `<html>` wrapper. See `/router-setup` for full config options.
78
+
79
+ ## 2. Route Mapping
80
+
81
+ ### File-based → URL pattern DSL
82
+
83
+ | Next.js file path | Rango equivalent |
84
+ | ------------------------------- | ---------------------------------------------------------- |
85
+ | `app/page.tsx` | `path("/", HomePage, { name: "home" })` |
86
+ | `app/about/page.tsx` | `path("/about", AboutPage, { name: "about" })` |
87
+ | `app/blog/[slug]/page.tsx` | `path("/blog/:slug", BlogPost, { name: "blogPost" })` |
88
+ | `app/shop/[...path]/page.tsx` | `path("/shop/:path+", CatchAll, { name: "shopCatchAll" })` |
89
+ | `app/docs/[[...slug]]/page.tsx` | `path("/docs/:slug*", Docs, { name: "docs" })` |
90
+
91
+ ### Layouts
92
+
93
+ ```typescript
94
+ // Next.js: app/dashboard/layout.tsx
95
+ export default function DashboardLayout({ children }) {
96
+ return <div className="dashboard">{children}</div>;
97
+ }
98
+
99
+ // Rango:
100
+ import { Outlet } from "@rangojs/router/client";
101
+
102
+ function DashboardLayout() {
103
+ return (
104
+ <div className="dashboard">
105
+ <Outlet />
106
+ </div>
107
+ );
108
+ }
109
+
110
+ // In urls.tsx:
111
+ layout(<DashboardLayout />, () => [
112
+ path("/dashboard", DashboardIndex, { name: "dashboard" }),
113
+ path("/dashboard/settings", Settings, { name: "settings" }),
114
+ ])
115
+ ```
116
+
117
+ Key difference: Rango layouts use `<Outlet />` instead of `{children}`. Layouts are server components by default.
118
+
119
+ ### Dynamic layouts (with data)
120
+
121
+ ```typescript
122
+ // Next.js: app/dashboard/layout.tsx
123
+ export default async function DashboardLayout({ children }) {
124
+ const user = await getUser();
125
+ return <Shell user={user}>{children}</Shell>;
126
+ }
127
+
128
+ // Rango: handler function layout
129
+ layout(async (ctx) => {
130
+ const user = ctx.get("user");
131
+ return (
132
+ <Shell user={user}>
133
+ <Outlet />
134
+ </Shell>
135
+ );
136
+ }, () => [
137
+ path("/dashboard", DashboardIndex, { name: "dashboard" }),
138
+ ])
139
+ ```
140
+
141
+ ### Route groups
142
+
143
+ Next.js `app/(marketing)/page.tsx` route groups have no URL segment. In Rango, just organize with `include()`:
144
+
145
+ ```typescript
146
+ // src/urls/marketing.tsx
147
+ export const marketingPatterns = urls(({ path }) => [
148
+ path("/", LandingPage, { name: "landing" }),
149
+ path("/pricing", PricingPage, { name: "pricing" }),
150
+ ]);
151
+
152
+ // src/urls.tsx
153
+ include("/", marketingPatterns, { name: "marketing" }),
154
+ ```
155
+
156
+ ### Parallel routes
157
+
158
+ In Next.js, `@sidebar` and `@main` are both named slots. In Rango, the main content
159
+ renders through `<Outlet />` (the path handler), and only extra slots use `parallel()` +
160
+ `<ParallelOutlet />`:
161
+
162
+ ```typescript
163
+ // Next.js: app/layout.tsx renders {sidebar} and {children}
164
+ // app/@sidebar/page.tsx provides the sidebar slot
165
+ // app/page.tsx provides the main content
166
+
167
+ // Rango: main content is the path handler, sidebar is a parallel slot
168
+ layout(
169
+ () => (
170
+ <div className="dashboard">
171
+ <ParallelOutlet name="@sidebar" />
172
+ <Outlet />
173
+ </div>
174
+ ),
175
+ () => [
176
+ parallel({
177
+ "@sidebar": <Sidebar />,
178
+ }),
179
+ path("/dashboard", DashboardPage, { name: "dashboard" }),
180
+ ],
181
+ )
182
+ ```
183
+
184
+ Only add `parallel()` slots for content that renders alongside the main route.
185
+ The main content always goes through `<Outlet />` via the `path()` handler.
186
+
187
+ ### Intercepting routes
188
+
189
+ ```typescript
190
+ // Next.js: app/(.)product/[id]/page.tsx
191
+ // (convention: (.) means same level, (..) parent level)
192
+
193
+ // Rango: explicit intercept in layout
194
+ layout(<ShopLayout />, () => [
195
+ path("/product/:id", ProductPage, { name: "product" }),
196
+ intercept("@modal", ".product", <ProductModal />, () => [
197
+ when(({ from }) => from.pathname.startsWith("/shop")),
198
+ ]),
199
+ ])
200
+ ```
201
+
202
+ ## 3. Data Fetching
203
+
204
+ ### Server component data fetching
205
+
206
+ Inline `fetch()` or direct DB calls in server components work as-is — no migration needed:
207
+
208
+ ```typescript
209
+ // Next.js:
210
+ async function ProductPage({ params }) {
211
+ const product = await fetch(`/api/products/${params.slug}`).then(r => r.json());
212
+ return <div>{product.name}</div>;
213
+ }
214
+
215
+ // Rango: same pattern, params come from ctx
216
+ const ProductPage: Handler<"product"> = async (ctx) => {
217
+ const product = await fetch(`/api/products/${ctx.params.slug}`).then(r => r.json());
218
+ return <div>{product.name}</div>;
219
+ };
220
+ ```
221
+
222
+ ### When to use createLoader
223
+
224
+ Loaders are Rango's live data layer. Use them when you need:
225
+
226
+ - **Client-side data refresh** — `useLoader()` in client components for reactive data
227
+ - **Per-loader caching** — opt in with `loader(MyLoader, () => [cache({ ttl: 60 })])`; loaders stay live by default
228
+ - **Revalidation control** — `revalidate()` targets specific segments and loaders after actions
229
+ - **Loading skeletons** — `loading()` shows a Suspense fallback while loaders resolve
230
+
231
+ ```typescript
232
+ import { createLoader } from "@rangojs/router";
233
+
234
+ export const ProductLoader = createLoader(async (ctx) => {
235
+ return await db.getProduct(ctx.params.slug);
236
+ });
237
+
238
+ // In urls:
239
+ path("/product/:slug", ProductPage, { name: "product" }, () => [
240
+ loader(ProductLoader),
241
+ loading(<ProductSkeleton />),
242
+ ])
243
+ ```
244
+
245
+ If the existing fetch pattern works and you don't need these features, leave it as-is. See `/loader` for full API.
246
+
247
+ ### generateStaticParams → Prerender + Passthrough
248
+
249
+ Plain `Prerender` only serves the listed params — unlisted params get no live
250
+ fallback in production (the handler is evicted). If the Next.js route serves
251
+ params outside the generated set at runtime, wrap with `Passthrough()`:
252
+
253
+ ```typescript
254
+ // Next.js:
255
+ export async function generateStaticParams() {
256
+ return [{ slug: "a" }, { slug: "b" }];
257
+ }
258
+
259
+ // Rango (build-only, no live fallback for unlisted params):
260
+ import { Prerender } from "@rangojs/router";
261
+
262
+ export const ProductDef = Prerender<{ slug: string }>(
263
+ async () => [{ slug: "a" }, { slug: "b" }],
264
+ async (ctx) => {
265
+ const product = await getProduct(ctx.params.slug);
266
+ return <ProductPage product={product} />;
267
+ },
268
+ );
269
+
270
+ // Rango (with live fallback — matches Next.js dynamicParams behavior):
271
+ import { Prerender, Passthrough } from "@rangojs/router";
272
+
273
+ const ProductDef = Prerender<{ slug: string }>(
274
+ async () => [{ slug: "a" }, { slug: "b" }],
275
+ async (ctx) => {
276
+ const product = await getProduct(ctx.params.slug);
277
+ if (!product) return ctx.passthrough();
278
+ return <ProductPage product={product} />;
279
+ },
280
+ );
281
+
282
+ export const Product = Passthrough(ProductDef, async (ctx) => {
283
+ const product = await getProduct(ctx.params.slug);
284
+ return <ProductPage product={product} />;
285
+ });
286
+ ```
287
+
288
+ Use `Passthrough()` whenever the Next.js route has `dynamicParams: true` (the
289
+ default) or serves an open-ended param space. See `/prerender` for full API.
290
+
291
+ ### Revalidation: two distinct axes
292
+
293
+ Next.js conflates two things under "revalidation." Rango separates them — and
294
+ tag-based cache invalidation now maps directly.
295
+
296
+ **1. Cache invalidation (bust cached values) — direct equivalent.** Tag entries
297
+ with `cache({ tags })` or, inside a `"use cache"` function, runtime
298
+ `cacheTag(...tags)`. Then invalidate by tag:
299
+
300
+ ```typescript
301
+ // Next.js Rango
302
+ // revalidateTag("products") → await updateTag("products") // in a server action: awaitable,
303
+ // // read-your-own-writes (next render is fresh)
304
+ // or revalidateTag("products") // in a route handler / webhook:
305
+ // // background, non-blocking (hard-purge)
306
+ ```
307
+
308
+ `updateTag` is awaitable and immediate; `revalidateTag` is fire-and-forget. Both
309
+ hard-purge (the next read re-renders fresh); the only difference is awaitability —
310
+ despite the Next.js name, `revalidateTag` here is NOT stale-while-revalidate.
311
+ Built-in stores (`MemorySegmentCacheStore`, `CFCacheStore`) index by tag. Next's
312
+ `revalidatePath` has no path-based equivalent — tag the relevant entries instead.
313
+
314
+ **2. Partial-render selection (which segments re-run after an action).** This is
315
+ NOT cache invalidation — it is `revalidate()`, controlling which segments
316
+ (layouts, paths, loaders, parallels) recompute during partial action
317
+ re-rendering:
318
+
319
+ ```typescript
320
+ import { updateBlog } from "./actions/blog";
321
+
322
+ // Re-run this layout when a blog action fires
323
+ layout(BlogLayout, () => [
324
+ revalidate((ctx) => ctx.isAction(updateBlog) || undefined),
325
+ path("/blog/:slug", BlogPost, { name: "blogPost" }),
326
+ ]);
327
+
328
+ // Re-run sidebar parallel when params change
329
+ parallel({ "@sidebar": BlogSidebar }, () => [
330
+ revalidate(
331
+ ({ currentParams, nextParams }) => currentParams.slug !== nextParams.slug,
332
+ ),
333
+ ]);
334
+ ```
335
+
336
+ **Server-side caching** — `cache()` DSL, loader-level `cache()`, and `"use cache"`
337
+ control what gets cached and for how long. This is separate from `revalidate()`:
338
+
339
+ ```typescript
340
+ cache({ ttl: 60, swr: 300 }, () => [
341
+ path("/blog/:slug", BlogPost, { name: "blogPost" }),
342
+ ]);
343
+ ```
344
+
345
+ The two axes compose: `updateTag()` / `revalidateTag()` bust cached values;
346
+ `revalidate()` selects which segments re-render and stream to the client after an
347
+ action.
348
+
349
+ When migrating:
350
+
351
+ - `revalidateTag(tag)` → `await updateTag(tag)` (in a server action) or
352
+ `revalidateTag(tag)` (in a route handler / webhook). Effectively 1:1.
353
+ - `revalidatePath(path)` → no path-based equivalent; tag the entries on that
354
+ route (`cache({ tags })` / `cacheTag(...)`) and invalidate by tag.
355
+ - To also force specific segments to re-render after the action (independent of
356
+ cache busting), attach a `revalidate()` rule at those segment boundaries.
357
+
358
+ ## 4. Middleware
359
+
360
+ Next.js `middleware.ts` wraps the entire request — including server actions.
361
+ The direct equivalent is `router.use()`, not the DSL `middleware()`:
362
+
363
+ ```typescript
364
+ // Next.js: middleware.ts (file-convention, wraps all requests)
365
+ import { NextResponse } from "next/server";
366
+
367
+ export function middleware(request) {
368
+ if (!request.cookies.get("session")) {
369
+ return NextResponse.redirect(new URL("/login", request.url));
370
+ }
371
+ }
372
+ export const config = { matcher: ["/dashboard/:path*"] };
373
+
374
+ // Rango: split into initialisation (global) + guard (scoped)
375
+ import { redirect, cookies } from "@rangojs/router";
376
+ import type { Middleware } from "@rangojs/router";
377
+
378
+ // Runs on every request — resolves the session for all routes
379
+ const authInit: Middleware = async (ctx, next) => {
380
+ const session = cookies().get("session")?.value;
381
+ if (session) {
382
+ const user = await verifySession(session);
383
+ ctx.set("user", user);
384
+ }
385
+ await next();
386
+ };
387
+
388
+ // Scoped guard — redirects unauthenticated users
389
+ const requireAuth: Middleware = async (ctx, next) => {
390
+ if (!ctx.get("user")) {
391
+ return redirect("/login");
392
+ }
393
+ await next();
394
+ };
395
+
396
+ const router = createRouter({})
397
+ .use(authInit) // all routes — sets ctx user
398
+ .use("/dashboard/*", requireAuth) // dashboard only — redirects
399
+ .routes(urlpatterns);
400
+ ```
401
+
402
+ **Rango has two middleware levels with different scopes:**
403
+
404
+ | | `router.use()` | `middleware()` in DSL |
405
+ | ------------------ | ------------------------------------ | ------------------------------- |
406
+ | Wraps | Entire request (actions + rendering) | Rendering only |
407
+ | Use for | Auth guards, logging, CORS | Context shaping, render headers |
408
+ | Next.js equivalent | `middleware.ts` | No direct equivalent |
409
+
410
+ Use `router.use()` for auth guards — it wraps the full request including actions.
411
+ DSL `middleware()` can also guard rendering (e.g. redirect unauthenticated users
412
+ away from a page), but it does not protect actions on that route. For full auth
413
+ coverage, prefer `router.use()`. See `/middleware`.
414
+
415
+ ## 5. Loading & Error States
416
+
417
+ ```typescript
418
+ // Next.js: app/dashboard/loading.tsx
419
+ export default function Loading() { return <Skeleton />; }
420
+
421
+ // Rango:
422
+ path("/dashboard", DashboardPage, { name: "dashboard" }, () => [
423
+ loading(<Skeleton />),
424
+ ])
425
+ ```
426
+
427
+ ```typescript
428
+ // Next.js: app/dashboard/error.tsx wraps all routes under /dashboard
429
+ "use client";
430
+ export default function Error({ error, reset }) { ... }
431
+
432
+ // Rango: errorBoundary wrapping a group of routes
433
+ layout(<DashboardLayout />, () => [
434
+ errorBoundary(({ error, reset }) => (
435
+ <div>
436
+ <h2>Something went wrong</h2>
437
+ <button onClick={reset}>Try again</button>
438
+ </div>
439
+ )),
440
+ path("/dashboard", DashboardIndex, { name: "dashboard" }),
441
+ path("/dashboard/settings", Settings, { name: "settings" }),
442
+ ])
443
+ ```
444
+
445
+ ```typescript
446
+ // Next.js: app/not-found.tsx
447
+ export default function NotFound() { ... }
448
+
449
+ // Rango (app-level — no route match, or notFound() without a boundary):
450
+ createRouter({
451
+ notFound: ({ pathname }) => <NotFoundPage pathname={pathname} />,
452
+ })
453
+
454
+ // Rango (route-level — notFoundBoundary wrapping a group of routes):
455
+ layout(<ShopLayout />, () => [
456
+ notFoundBoundary(({ notFound: info }) => (
457
+ <div>
458
+ <h2>Not Found</h2>
459
+ <p>{info.message}</p>
460
+ </div>
461
+ )),
462
+ path("/product/:slug", ProductPage, { name: "product" }),
463
+ path("/product/:slug/reviews", ReviewsPage, { name: "reviews" }),
464
+ ])
465
+ ```
466
+
467
+ Both `errorBoundary()` and `notFoundBoundary()` catch errors from all
468
+ children in their scope — handlers, loaders, and nested segments.
469
+
470
+ ## 6. Navigation
471
+
472
+ | Next.js | Rango |
473
+ | ------------------------------- | ------------------------------------------------- |
474
+ | `import Link from "next/link"` | `import { Link } from "@rangojs/router/client"` |
475
+ | `<Link href="/about">` | `<Link to="/about">` |
476
+ | `useRouter().push("/about")` | `useRouter().push("/about")` |
477
+ | `useRouter().replace("/about")` | `useRouter().replace("/about")` |
478
+ | `usePathname()` | `usePathname()` from `@rangojs/router/client` |
479
+ | `useSearchParams()` | `useSearchParams()` from `@rangojs/router/client` |
480
+ | `redirect("/login")` (server) | `redirect("/login")` from `@rangojs/router` |
481
+
482
+ ## 7. Server Actions
483
+
484
+ Server actions work the same way — `"use server"` directive, `useActionState`, form actions. No migration needed for action logic.
485
+
486
+ Key difference: in Rango, route middleware does NOT wrap action execution. Actions only see global middleware context. Use `getRequestContext()` in actions to access `ctx.set()`/`ctx.get()`.
487
+
488
+ Next.js's `revalidateTag()` maps directly: tag entries via `cache({ tags })` / `cacheTag(...)`, then invalidate. **In a server action use `await updateTag(tag)`** — it is read-your-own-writes, so the action's own re-render sees fresh data; `revalidateTag(tag)` is a background (non-blocking) hard-purge and is NOT read-your-own-writes, so reserve it for route handlers / webhooks (calling it from an action can leave that action's re-render stale). `revalidatePath()` has no path-based equivalent — tag the route's entries instead. Separately, to force specific matched segments (path/layout/parallel/intercept) and their loaders to re-render after an action, attach a `revalidate(({ actionId }) => ...)` rule to that segment or loader registration. See `/server-actions` for the full pattern (validation, error handling, file uploads), `/caching` for tag invalidation, and `/loader` for revalidation rule semantics.
489
+
490
+ ## 8. Metadata / Head
491
+
492
+ Rango uses the `Meta` handle + `<MetaTags />` client component:
493
+
494
+ ```typescript
495
+ // Next.js: export const metadata = { title: "Home" }
496
+ // Next.js: export function generateMetadata({ params }) { ... }
497
+
498
+ // Rango: Meta handle in handlers (server), MetaTags in document <head> (client)
499
+ import { Meta } from "@rangojs/router";
500
+
501
+ const HomePage: Handler<"home"> = (ctx) => {
502
+ const meta = ctx.use(Meta);
503
+ meta({ title: "Home" });
504
+ meta({ name: "description", content: "Welcome to the site" });
505
+ return <div>Home page</div>;
506
+ };
507
+ ```
508
+
509
+ Add `<MetaTags />` in the Document component's `<head>`:
510
+
511
+ ```typescript
512
+ import { MetaTags } from "@rangojs/router/client";
513
+
514
+ function Document({ children }: { children: ReactNode }) {
515
+ return (
516
+ <html>
517
+ <head>
518
+ <MetaTags />
519
+ </head>
520
+ <body>{children}</body>
521
+ </html>
522
+ );
523
+ }
524
+ ```
525
+
526
+ Later routes override earlier ones for the same meta key (deduplication).
527
+
528
+ ## 9. API Routes
529
+
530
+ ```typescript
531
+ // Next.js: app/api/users/route.ts
532
+ export async function GET(request) { ... }
533
+
534
+ // Rango: response routes
535
+ path.json("/api/users", async (ctx) => {
536
+ const users = await db.getUsers();
537
+ return users;
538
+ }, { name: "apiUsers" })
539
+
540
+ path.text("/api/health", () => "ok", { name: "apiHealth" })
541
+ ```
542
+
543
+ See `/response-routes` for full API.
544
+
545
+ ## 10. Theme / Dark Mode
546
+
547
+ If the Next.js app uses `next-themes` or a custom theme provider, replace it
548
+ with Rango's built-in theme system (FOUC prevention included):
549
+
550
+ ```typescript
551
+ const router = createRouter({
552
+ theme: true, // or { defaultTheme: "system", attribute: "class" }
553
+ });
554
+ ```
555
+
556
+ Client components use `useTheme()` to read and toggle:
557
+
558
+ ```typescript
559
+ "use client";
560
+ import { useTheme } from "@rangojs/router/theme";
561
+
562
+ function ThemeToggle() {
563
+ const { theme, setTheme } = useTheme();
564
+ return <button onClick={() => setTheme(theme === "dark" ? "light" : "dark")}>{theme}</button>;
565
+ }
566
+ ```
567
+
568
+ See `/theme` for full API including system detection and cookie persistence.
569
+
570
+ ## Migration Checklist
571
+
572
+ 1. [ ] Set up Vite config with `rango()` plugin
573
+ 2. [ ] Create Document component (replaces root `<html>` layout)
574
+ 3. [ ] Create `router.tsx` with `createRouter()`
575
+ 4. [ ] Convert file-based routes to `urls()` DSL in `urls.tsx`
576
+ 5. [ ] Migrate layouts to `layout()` with `<Outlet />`
577
+ 6. [ ] Convert data fetching to `createLoader()` + `ctx.use()`
578
+ 7. [ ] Migrate `middleware.ts` to `router.use()` (auth, guards, logging)
579
+ 8. [ ] Replace `next/link` with `Link` from `@rangojs/router/client`
580
+ 9. [ ] Convert loading/error files to `loading()` / `errorBoundary()`
581
+ 10. [ ] Migrate API routes to `path.json()` / `path.text()`
582
+ 11. [ ] Update metadata to use `Meta` handle + `<MetaTags />` in document head
583
+ 12. [ ] Replace `next-themes` with `theme: true` in createRouter (see `/theme`)
584
+ 13. [ ] Run `npx rango generate src/` to generate route types