@rangojs/router 0.0.0-experimental.10 → 0.0.0-experimental.100

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 (329) hide show
  1. package/AGENTS.md +9 -0
  2. package/README.md +1037 -4
  3. package/dist/bin/rango.js +1619 -157
  4. package/dist/vite/index.js +5762 -2301
  5. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  6. package/package.json +71 -63
  7. package/skills/breadcrumbs/SKILL.md +252 -0
  8. package/skills/cache-guide/SKILL.md +294 -0
  9. package/skills/caching/SKILL.md +93 -23
  10. package/skills/composability/SKILL.md +172 -0
  11. package/skills/debug-manifest/SKILL.md +12 -8
  12. package/skills/document-cache/SKILL.md +18 -16
  13. package/skills/fonts/SKILL.md +6 -4
  14. package/skills/handler-use/SKILL.md +364 -0
  15. package/skills/hooks/SKILL.md +367 -71
  16. package/skills/host-router/SKILL.md +218 -0
  17. package/skills/i18n/SKILL.md +276 -0
  18. package/skills/intercept/SKILL.md +176 -8
  19. package/skills/layout/SKILL.md +124 -3
  20. package/skills/links/SKILL.md +304 -25
  21. package/skills/loader/SKILL.md +474 -47
  22. package/skills/middleware/SKILL.md +207 -37
  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 +15 -11
  26. package/skills/parallel/SKILL.md +272 -1
  27. package/skills/prerender/SKILL.md +467 -65
  28. package/skills/rango/SKILL.md +89 -21
  29. package/skills/response-routes/SKILL.md +152 -91
  30. package/skills/route/SKILL.md +305 -14
  31. package/skills/router-setup/SKILL.md +210 -32
  32. package/skills/server-actions/SKILL.md +739 -0
  33. package/skills/streams-and-websockets/SKILL.md +283 -0
  34. package/skills/theme/SKILL.md +9 -8
  35. package/skills/typesafety/SKILL.md +333 -86
  36. package/skills/use-cache/SKILL.md +324 -0
  37. package/skills/view-transitions/SKILL.md +212 -0
  38. package/src/__internal.ts +102 -4
  39. package/src/bin/rango.ts +312 -15
  40. package/src/browser/action-coordinator.ts +97 -0
  41. package/src/browser/action-response-classifier.ts +99 -0
  42. package/src/browser/app-shell.ts +52 -0
  43. package/src/browser/app-version.ts +14 -0
  44. package/src/browser/event-controller.ts +136 -68
  45. package/src/browser/history-state.ts +80 -0
  46. package/src/browser/intercept-utils.ts +52 -0
  47. package/src/browser/link-interceptor.ts +24 -4
  48. package/src/browser/logging.ts +55 -0
  49. package/src/browser/merge-segment-loaders.ts +20 -12
  50. package/src/browser/navigation-bridge.ts +374 -561
  51. package/src/browser/navigation-client.ts +228 -70
  52. package/src/browser/navigation-store.ts +97 -55
  53. package/src/browser/navigation-transaction.ts +297 -0
  54. package/src/browser/network-error-handler.ts +61 -0
  55. package/src/browser/partial-update.ts +376 -315
  56. package/src/browser/prefetch/cache.ts +314 -0
  57. package/src/browser/prefetch/fetch.ts +282 -0
  58. package/src/browser/prefetch/observer.ts +65 -0
  59. package/src/browser/prefetch/policy.ts +48 -0
  60. package/src/browser/prefetch/queue.ts +191 -0
  61. package/src/browser/prefetch/resource-ready.ts +77 -0
  62. package/src/browser/rango-state.ts +152 -0
  63. package/src/browser/react/Link.tsx +255 -71
  64. package/src/browser/react/NavigationProvider.tsx +152 -24
  65. package/src/browser/react/context.ts +11 -0
  66. package/src/browser/react/filter-segment-order.ts +55 -0
  67. package/src/browser/react/index.ts +15 -12
  68. package/src/browser/react/location-state-shared.ts +95 -53
  69. package/src/browser/react/location-state.ts +60 -15
  70. package/src/browser/react/mount-context.ts +6 -1
  71. package/src/browser/react/nonce-context.ts +23 -0
  72. package/src/browser/react/shallow-equal.ts +27 -0
  73. package/src/browser/react/use-action.ts +29 -51
  74. package/src/browser/react/use-client-cache.ts +5 -3
  75. package/src/browser/react/use-handle.ts +30 -120
  76. package/src/browser/react/use-link-status.ts +6 -5
  77. package/src/browser/react/use-navigation.ts +44 -65
  78. package/src/browser/react/use-params.ts +78 -0
  79. package/src/browser/react/use-pathname.ts +47 -0
  80. package/src/browser/react/use-reverse.ts +99 -0
  81. package/src/browser/react/use-router.ts +83 -0
  82. package/src/browser/react/use-search-params.ts +56 -0
  83. package/src/browser/react/use-segments.ts +85 -99
  84. package/src/browser/response-adapter.ts +73 -0
  85. package/src/browser/rsc-router.tsx +246 -64
  86. package/src/browser/scroll-restoration.ts +127 -52
  87. package/src/browser/segment-reconciler.ts +243 -0
  88. package/src/browser/segment-structure-assert.ts +16 -0
  89. package/src/browser/server-action-bridge.ts +510 -603
  90. package/src/browser/shallow.ts +6 -1
  91. package/src/browser/types.ts +158 -48
  92. package/src/browser/validate-redirect-origin.ts +29 -0
  93. package/src/build/generate-manifest.ts +84 -23
  94. package/src/build/generate-route-types.ts +39 -828
  95. package/src/build/index.ts +4 -5
  96. package/src/build/route-trie.ts +85 -32
  97. package/src/build/route-types/ast-helpers.ts +25 -0
  98. package/src/build/route-types/ast-route-extraction.ts +98 -0
  99. package/src/build/route-types/codegen.ts +102 -0
  100. package/src/build/route-types/include-resolution.ts +418 -0
  101. package/src/build/route-types/param-extraction.ts +48 -0
  102. package/src/build/route-types/per-module-writer.ts +128 -0
  103. package/src/build/route-types/router-processing.ts +618 -0
  104. package/src/build/route-types/scan-filter.ts +85 -0
  105. package/src/build/runtime-discovery.ts +231 -0
  106. package/src/cache/background-task.ts +34 -0
  107. package/src/cache/cache-key-utils.ts +44 -0
  108. package/src/cache/cache-policy.ts +125 -0
  109. package/src/cache/cache-runtime.ts +342 -0
  110. package/src/cache/cache-scope.ts +167 -307
  111. package/src/cache/cf/cf-cache-store.ts +573 -21
  112. package/src/cache/cf/index.ts +13 -3
  113. package/src/cache/document-cache.ts +116 -77
  114. package/src/cache/handle-capture.ts +81 -0
  115. package/src/cache/handle-snapshot.ts +41 -0
  116. package/src/cache/index.ts +1 -15
  117. package/src/cache/memory-segment-store.ts +191 -13
  118. package/src/cache/profile-registry.ts +73 -0
  119. package/src/cache/read-through-swr.ts +134 -0
  120. package/src/cache/segment-codec.ts +256 -0
  121. package/src/cache/taint.ts +153 -0
  122. package/src/cache/types.ts +72 -122
  123. package/src/client.rsc.tsx +6 -1
  124. package/src/client.tsx +118 -302
  125. package/src/component-utils.ts +4 -4
  126. package/src/components/DefaultDocument.tsx +5 -1
  127. package/src/context-var.ts +156 -0
  128. package/src/debug.ts +19 -9
  129. package/src/errors.ts +77 -7
  130. package/src/handle.ts +55 -10
  131. package/src/handles/MetaTags.tsx +73 -20
  132. package/src/handles/breadcrumbs.ts +66 -0
  133. package/src/handles/index.ts +1 -0
  134. package/src/handles/meta.ts +30 -13
  135. package/src/host/cookie-handler.ts +21 -15
  136. package/src/host/errors.ts +8 -8
  137. package/src/host/index.ts +4 -7
  138. package/src/host/pattern-matcher.ts +27 -27
  139. package/src/host/router.ts +61 -39
  140. package/src/host/testing.ts +8 -8
  141. package/src/host/types.ts +15 -7
  142. package/src/host/utils.ts +1 -1
  143. package/src/href-client.ts +65 -45
  144. package/src/index.rsc.ts +138 -21
  145. package/src/index.ts +206 -51
  146. package/src/internal-debug.ts +11 -0
  147. package/src/loader.rsc.ts +25 -143
  148. package/src/loader.ts +27 -10
  149. package/src/network-error-thrower.tsx +3 -1
  150. package/src/outlet-context.ts +1 -1
  151. package/src/outlet-provider.tsx +45 -0
  152. package/src/prerender/param-hash.ts +4 -2
  153. package/src/prerender/store.ts +159 -13
  154. package/src/prerender.ts +397 -29
  155. package/src/response-utils.ts +28 -0
  156. package/src/reverse.ts +231 -121
  157. package/src/root-error-boundary.tsx +41 -29
  158. package/src/route-content-wrapper.tsx +7 -4
  159. package/src/route-definition/dsl-helpers.ts +1134 -0
  160. package/src/route-definition/helper-factories.ts +200 -0
  161. package/src/route-definition/helpers-types.ts +483 -0
  162. package/src/route-definition/index.ts +55 -0
  163. package/src/route-definition/redirect.ts +101 -0
  164. package/src/route-definition/resolve-handler-use.ts +155 -0
  165. package/src/route-definition.ts +1 -1431
  166. package/src/route-map-builder.ts +162 -123
  167. package/src/route-name.ts +53 -0
  168. package/src/route-types.ts +66 -9
  169. package/src/router/content-negotiation.ts +215 -0
  170. package/src/router/debug-manifest.ts +72 -0
  171. package/src/router/error-handling.ts +9 -9
  172. package/src/router/find-match.ts +160 -0
  173. package/src/router/handler-context.ts +418 -86
  174. package/src/router/intercept-resolution.ts +35 -20
  175. package/src/router/lazy-includes.ts +237 -0
  176. package/src/router/loader-resolution.ts +359 -128
  177. package/src/router/logging.ts +251 -0
  178. package/src/router/manifest.ts +98 -32
  179. package/src/router/match-api.ts +196 -261
  180. package/src/router/match-context.ts +4 -2
  181. package/src/router/match-handlers.ts +441 -0
  182. package/src/router/match-middleware/background-revalidation.ts +108 -93
  183. package/src/router/match-middleware/cache-lookup.ts +415 -86
  184. package/src/router/match-middleware/cache-store.ts +91 -29
  185. package/src/router/match-middleware/intercept-resolution.ts +48 -21
  186. package/src/router/match-middleware/segment-resolution.ts +73 -9
  187. package/src/router/match-pipelines.ts +10 -45
  188. package/src/router/match-result.ts +154 -35
  189. package/src/router/metrics.ts +240 -15
  190. package/src/router/middleware-cookies.ts +55 -0
  191. package/src/router/middleware-types.ts +209 -0
  192. package/src/router/middleware.ts +373 -371
  193. package/src/router/navigation-snapshot.ts +182 -0
  194. package/src/router/pattern-matching.ts +292 -52
  195. package/src/router/prerender-match.ts +502 -0
  196. package/src/router/preview-match.ts +98 -0
  197. package/src/router/request-classification.ts +310 -0
  198. package/src/router/revalidation.ts +152 -39
  199. package/src/router/route-snapshot.ts +245 -0
  200. package/src/router/router-context.ts +41 -21
  201. package/src/router/router-interfaces.ts +484 -0
  202. package/src/router/router-options.ts +618 -0
  203. package/src/router/router-registry.ts +24 -0
  204. package/src/router/segment-resolution/fresh.ts +756 -0
  205. package/src/router/segment-resolution/helpers.ts +268 -0
  206. package/src/router/segment-resolution/loader-cache.ts +199 -0
  207. package/src/router/segment-resolution/revalidation.ts +1407 -0
  208. package/src/router/segment-resolution/static-store.ts +67 -0
  209. package/src/router/segment-resolution.ts +21 -1315
  210. package/src/router/segment-wrappers.ts +291 -0
  211. package/src/router/substitute-pattern-params.ts +56 -0
  212. package/src/router/telemetry-otel.ts +299 -0
  213. package/src/router/telemetry.ts +300 -0
  214. package/src/router/timeout.ts +148 -0
  215. package/src/router/trie-matching.ts +111 -39
  216. package/src/router/types.ts +17 -9
  217. package/src/router/url-params.ts +49 -0
  218. package/src/router.ts +642 -2011
  219. package/src/rsc/handler-context.ts +45 -0
  220. package/src/rsc/handler.ts +864 -1114
  221. package/src/rsc/helpers.ts +181 -19
  222. package/src/rsc/index.ts +0 -20
  223. package/src/rsc/loader-fetch.ts +229 -0
  224. package/src/rsc/manifest-init.ts +90 -0
  225. package/src/rsc/nonce.ts +14 -0
  226. package/src/rsc/origin-guard.ts +141 -0
  227. package/src/rsc/progressive-enhancement.ts +395 -0
  228. package/src/rsc/response-error.ts +37 -0
  229. package/src/rsc/response-route-handler.ts +360 -0
  230. package/src/rsc/rsc-rendering.ts +256 -0
  231. package/src/rsc/runtime-warnings.ts +42 -0
  232. package/src/rsc/server-action.ts +360 -0
  233. package/src/rsc/ssr-setup.ts +128 -0
  234. package/src/rsc/types.ts +52 -11
  235. package/src/search-params.ts +230 -0
  236. package/src/segment-content-promise.ts +67 -0
  237. package/src/segment-loader-promise.ts +122 -0
  238. package/src/segment-system.tsx +187 -38
  239. package/src/server/context.ts +333 -59
  240. package/src/server/cookie-store.ts +190 -0
  241. package/src/server/fetchable-loader-store.ts +37 -0
  242. package/src/server/handle-store.ts +113 -15
  243. package/src/server/loader-registry.ts +24 -64
  244. package/src/server/request-context.ts +603 -109
  245. package/src/server.ts +35 -155
  246. package/src/ssr/index.tsx +107 -30
  247. package/src/static-handler.ts +126 -0
  248. package/src/theme/ThemeProvider.tsx +21 -15
  249. package/src/theme/ThemeScript.tsx +5 -5
  250. package/src/theme/constants.ts +5 -2
  251. package/src/theme/index.ts +4 -14
  252. package/src/theme/theme-context.ts +4 -30
  253. package/src/theme/theme-script.ts +21 -18
  254. package/src/types/boundaries.ts +158 -0
  255. package/src/types/cache-types.ts +198 -0
  256. package/src/types/error-types.ts +192 -0
  257. package/src/types/global-namespace.ts +100 -0
  258. package/src/types/handler-context.ts +764 -0
  259. package/src/types/index.ts +88 -0
  260. package/src/types/loader-types.ts +209 -0
  261. package/src/types/request-scope.ts +126 -0
  262. package/src/types/route-config.ts +170 -0
  263. package/src/types/route-entry.ts +120 -0
  264. package/src/types/segments.ts +167 -0
  265. package/src/types.ts +1 -1757
  266. package/src/urls/include-helper.ts +207 -0
  267. package/src/urls/index.ts +53 -0
  268. package/src/urls/path-helper-types.ts +372 -0
  269. package/src/urls/path-helper.ts +364 -0
  270. package/src/urls/pattern-types.ts +107 -0
  271. package/src/urls/response-types.ts +108 -0
  272. package/src/urls/type-extraction.ts +372 -0
  273. package/src/urls/urls-function.ts +98 -0
  274. package/src/urls.ts +1 -1282
  275. package/src/use-loader.tsx +161 -81
  276. package/src/vite/debug.ts +184 -0
  277. package/src/vite/discovery/bundle-postprocess.ts +181 -0
  278. package/src/vite/discovery/discover-routers.ts +376 -0
  279. package/src/vite/discovery/gate-state.ts +171 -0
  280. package/src/vite/discovery/prerender-collection.ts +486 -0
  281. package/src/vite/discovery/route-types-writer.ts +258 -0
  282. package/src/vite/discovery/self-gen-tracking.ts +73 -0
  283. package/src/vite/discovery/state.ts +117 -0
  284. package/src/vite/discovery/virtual-module-codegen.ts +203 -0
  285. package/src/vite/index.ts +15 -2063
  286. package/src/vite/plugin-types.ts +103 -0
  287. package/src/vite/plugins/cjs-to-esm.ts +98 -0
  288. package/src/vite/plugins/client-ref-dedup.ts +131 -0
  289. package/src/vite/plugins/client-ref-hashing.ts +117 -0
  290. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  291. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  292. package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
  293. package/src/vite/{expose-action-id.ts → plugins/expose-action-id.ts} +107 -64
  294. package/src/vite/plugins/expose-id-utils.ts +299 -0
  295. package/src/vite/plugins/expose-ids/export-analysis.ts +296 -0
  296. package/src/vite/plugins/expose-ids/handler-transform.ts +209 -0
  297. package/src/vite/plugins/expose-ids/loader-transform.ts +74 -0
  298. package/src/vite/plugins/expose-ids/router-transform.ts +127 -0
  299. package/src/vite/plugins/expose-ids/types.ts +45 -0
  300. package/src/vite/plugins/expose-internal-ids.ts +816 -0
  301. package/src/vite/plugins/performance-tracks.ts +96 -0
  302. package/src/vite/plugins/refresh-cmd.ts +127 -0
  303. package/src/vite/plugins/use-cache-transform.ts +336 -0
  304. package/src/vite/plugins/version-injector.ts +109 -0
  305. package/src/vite/plugins/version-plugin.ts +266 -0
  306. package/src/vite/{virtual-entries.ts → plugins/virtual-entries.ts} +23 -14
  307. package/src/vite/plugins/virtual-stub-plugin.ts +29 -0
  308. package/src/vite/rango.ts +497 -0
  309. package/src/vite/router-discovery.ts +1423 -0
  310. package/src/vite/utils/ast-handler-extract.ts +517 -0
  311. package/src/vite/utils/banner.ts +36 -0
  312. package/src/vite/utils/bundle-analysis.ts +137 -0
  313. package/src/vite/utils/manifest-utils.ts +70 -0
  314. package/src/vite/utils/package-resolution.ts +161 -0
  315. package/src/vite/utils/prerender-utils.ts +222 -0
  316. package/src/vite/utils/shared-utils.ts +170 -0
  317. package/CLAUDE.md +0 -43
  318. package/src/browser/lru-cache.ts +0 -69
  319. package/src/browser/request-controller.ts +0 -164
  320. package/src/cache/memory-store.ts +0 -253
  321. package/src/href-context.ts +0 -33
  322. package/src/router.gen.ts +0 -6
  323. package/src/urls.gen.ts +0 -8
  324. package/src/vite/expose-handle-id.ts +0 -209
  325. package/src/vite/expose-loader-id.ts +0 -426
  326. package/src/vite/expose-location-state-id.ts +0 -177
  327. package/src/vite/expose-prerender-handler-id.ts +0 -429
  328. package/src/vite/package-resolution.ts +0 -125
  329. /package/src/vite/{version.d.ts → plugins/version.d.ts} +0 -0
@@ -0,0 +1,258 @@
1
+ /**
2
+ * Route Types Writer
3
+ *
4
+ * Generates and writes TypeScript route type files (named-routes.gen.ts)
5
+ * from discovered router manifests and static source parsing.
6
+ */
7
+
8
+ import { dirname, basename, join, resolve } from "node:path";
9
+ import { readFileSync, writeFileSync, existsSync, unlinkSync } from "node:fs";
10
+ import {
11
+ generateRouteTypesSource,
12
+ writeCombinedRouteTypes,
13
+ findRouterFiles,
14
+ buildCombinedRouteMapForRouterFile,
15
+ } from "../../build/generate-route-types.js";
16
+ import type { DiscoveryState } from "./state.js";
17
+ import { markSelfGenWrite } from "./self-gen-tracking.js";
18
+ import { isAutoGeneratedRouteName } from "../../route-name.js";
19
+
20
+ /**
21
+ * Filter out auto-generated route names from a manifest.
22
+ * Unnamed routes get "$path_"-prefixed names at runtime (see path-helper.ts).
23
+ * These should not appear in the typed gen file. User-defined names
24
+ * containing "$" (e.g. "$admin") are valid and preserved.
25
+ */
26
+ function filterUserNamedRoutes(
27
+ manifest: Record<string, string>,
28
+ ): Record<string, string> {
29
+ const filtered: Record<string, string> = {};
30
+ for (const [name, pattern] of Object.entries(manifest)) {
31
+ if (!isAutoGeneratedRouteName(name)) {
32
+ filtered[name] = pattern;
33
+ }
34
+ }
35
+ return filtered;
36
+ }
37
+
38
+ /**
39
+ * Write combined route types for all router files.
40
+ * Only writes when content has changed to avoid triggering HMR loops.
41
+ */
42
+ export function writeCombinedRouteTypesWithTracking(
43
+ state: DiscoveryState,
44
+ opts?: { preserveIfLarger?: boolean },
45
+ ): void {
46
+ const routerFiles =
47
+ state.cachedRouterFiles ??
48
+ findRouterFiles(state.projectRoot, state.scanFilter);
49
+ state.cachedRouterFiles = routerFiles;
50
+
51
+ // Snapshot pre-write content to detect which files actually change.
52
+ const preContent = new Map<string, string>();
53
+ for (const routerFilePath of routerFiles) {
54
+ const routerDir = dirname(routerFilePath);
55
+ const routerBasename = basename(routerFilePath).replace(
56
+ /\.(tsx?|jsx?)$/,
57
+ "",
58
+ );
59
+ const outPath = join(routerDir, `${routerBasename}.named-routes.gen.ts`);
60
+ try {
61
+ preContent.set(outPath, readFileSync(outPath, "utf-8"));
62
+ } catch {
63
+ // File doesn't exist yet — any write is a real change.
64
+ }
65
+ }
66
+
67
+ writeCombinedRouteTypes(state.projectRoot, routerFiles, opts);
68
+
69
+ // Mark only files that were actually written so the watcher can
70
+ // distinguish self-triggered change events from manual edits.
71
+ // Marking unchanged files creates stale entries that interfere with
72
+ // multi-server setups (e.g. shared webServer + isolated HMR server).
73
+ for (const routerFilePath of routerFiles) {
74
+ const routerDir = dirname(routerFilePath);
75
+ const routerBasename = basename(routerFilePath).replace(
76
+ /\.(tsx?|jsx?)$/,
77
+ "",
78
+ );
79
+ const outPath = join(routerDir, `${routerBasename}.named-routes.gen.ts`);
80
+ if (!existsSync(outPath)) continue;
81
+ try {
82
+ const content = readFileSync(outPath, "utf-8");
83
+ if (content !== preContent.get(outPath)) {
84
+ markSelfGenWrite(state, outPath, content);
85
+ }
86
+ } catch {
87
+ // Ignore transient fs errors while files are being rewritten.
88
+ }
89
+ }
90
+ }
91
+
92
+ /**
93
+ * Write per-router route types files from runtime discovery data.
94
+ */
95
+ export function writeRouteTypesFiles(state: DiscoveryState): void {
96
+ if (state.perRouterManifests.length === 0) return;
97
+
98
+ // Delete old combined named-routes.gen.ts if it exists
99
+ try {
100
+ const entryDir = dirname(
101
+ resolve(state.projectRoot, state.resolvedEntryPath!),
102
+ );
103
+ const oldCombinedPath = join(entryDir, "named-routes.gen.ts");
104
+ if (existsSync(oldCombinedPath)) {
105
+ unlinkSync(oldCombinedPath);
106
+ console.log(
107
+ `[rsc-router] Removed stale combined route types: ${oldCombinedPath}`,
108
+ );
109
+ }
110
+ } catch {}
111
+
112
+ for (const {
113
+ id,
114
+ routeManifest,
115
+ routeSearchSchemas,
116
+ sourceFile,
117
+ } of state.perRouterManifests) {
118
+ if (!sourceFile) continue;
119
+
120
+ // Validate sourceFile points to a real project file, not node_modules or
121
+ // a Vite internal path. A bad sourceFile leads to route types written to
122
+ // the wrong location, causing non-deterministic type resolution.
123
+ if (sourceFile.includes("node_modules")) {
124
+ throw new Error(
125
+ `[rsc-router] Router "${id}" has sourceFile inside node_modules: ${sourceFile}\n` +
126
+ `This means createRouter() stack trace parsing matched a Vite internal frame.\n` +
127
+ `Set an explicit \`id\` on createRouter() or check the call site.`,
128
+ );
129
+ }
130
+
131
+ const routerDir = dirname(sourceFile);
132
+ const routerBasename = basename(sourceFile).replace(/\.(tsx?|jsx?)$/, "");
133
+ const outPath = join(routerDir, `${routerBasename}.named-routes.gen.ts`);
134
+
135
+ // Filter out auto-generated route names (e.g. "$path____debug_reverse-test")
136
+ // to match the static parser's output and prevent HMR oscillation.
137
+ const userRoutes = filterUserNamedRoutes(routeManifest);
138
+ let effectiveSearchSchemas = routeSearchSchemas;
139
+
140
+ // Runtime manifest may omit search schema metadata in some module-runner
141
+ // flows. Fall back to static source parsing from the router file.
142
+ if (
143
+ (!effectiveSearchSchemas ||
144
+ Object.keys(effectiveSearchSchemas).length === 0) &&
145
+ sourceFile
146
+ ) {
147
+ const staticParsed = buildCombinedRouteMapForRouterFile(sourceFile);
148
+ if (Object.keys(staticParsed.searchSchemas).length > 0) {
149
+ const filtered: Record<string, Record<string, string>> = {};
150
+ for (const name of Object.keys(userRoutes)) {
151
+ const schema = staticParsed.searchSchemas[name];
152
+ if (schema) filtered[name] = schema;
153
+ }
154
+ if (Object.keys(filtered).length > 0) {
155
+ effectiveSearchSchemas = filtered;
156
+ }
157
+ }
158
+ }
159
+
160
+ const source = generateRouteTypesSource(
161
+ userRoutes,
162
+ effectiveSearchSchemas && Object.keys(effectiveSearchSchemas).length > 0
163
+ ? effectiveSearchSchemas
164
+ : undefined,
165
+ );
166
+ const existing = existsSync(outPath)
167
+ ? readFileSync(outPath, "utf-8")
168
+ : null;
169
+ if (existing !== source) {
170
+ markSelfGenWrite(state, outPath, source);
171
+ writeFileSync(outPath, source);
172
+ console.log(`[rsc-router] Generated route types -> ${outPath}`);
173
+ }
174
+ }
175
+ }
176
+
177
+ /**
178
+ * Supplement gen files with route groups from runtime manifests that the
179
+ * static parser cannot resolve (factory calls like createDocsPatterns()).
180
+ * Only adds groups whose dot-prefix (e.g. "docs.") is entirely absent
181
+ * from the static output. Groups partially visible to the static parser
182
+ * are left alone so renames/removals propagate immediately without
183
+ * requiring a server restart.
184
+ *
185
+ * The runtime manifest (cachedManifest / perRouterManifestMap) is updated
186
+ * automatically: the virtual:rsc-router/routes-manifest module imports the
187
+ * gen file, so when we write new content here, Vite's HMR invalidates the
188
+ * virtual module and re-evaluates it on the next request.
189
+ */
190
+ export function supplementGenFilesWithRuntimeRoutes(
191
+ state: DiscoveryState,
192
+ ): void {
193
+ // Cache static parsing results to avoid redundant I/O + parsing per router.
194
+ const parseCache = new Map<
195
+ string,
196
+ ReturnType<typeof buildCombinedRouteMapForRouterFile>
197
+ >();
198
+ const getParsed = (file: string) => {
199
+ let cached = parseCache.get(file);
200
+ if (!cached) {
201
+ cached = buildCombinedRouteMapForRouterFile(file);
202
+ parseCache.set(file, cached);
203
+ }
204
+ return cached;
205
+ };
206
+
207
+ for (const {
208
+ routeManifest,
209
+ routeSearchSchemas,
210
+ sourceFile,
211
+ factoryOnlyPrefixes,
212
+ } of state.perRouterManifests) {
213
+ if (!sourceFile) continue;
214
+ if (!factoryOnlyPrefixes || factoryOnlyPrefixes.size === 0) continue;
215
+
216
+ const staticParsed = getParsed(sourceFile);
217
+
218
+ // Merge: static routes (authoritative) + factory-only groups from runtime.
219
+ const mergedRoutes: Record<string, string> = { ...staticParsed.routes };
220
+ const mergedSearchSchemas: Record<string, Record<string, string>> = {
221
+ ...staticParsed.searchSchemas,
222
+ };
223
+
224
+ for (const [name, pattern] of Object.entries(routeManifest)) {
225
+ // Skip internal runtime-only names from unnamed routes/includes.
226
+ if (isAutoGeneratedRouteName(name)) continue;
227
+ const dotIdx = name.indexOf(".");
228
+ if (dotIdx <= 0) continue;
229
+ const prefix = name.substring(0, dotIdx + 1);
230
+ if (factoryOnlyPrefixes.has(prefix)) {
231
+ mergedRoutes[name] = pattern;
232
+ // Also merge search schemas from factory-generated routes
233
+ if (routeSearchSchemas?.[name]) {
234
+ mergedSearchSchemas[name] = routeSearchSchemas[name];
235
+ }
236
+ }
237
+ }
238
+
239
+ const routerDir = dirname(sourceFile);
240
+ const routerBasename = basename(sourceFile).replace(/\.(tsx?|jsx?)$/, "");
241
+ const outPath = join(routerDir, `${routerBasename}.named-routes.gen.ts`);
242
+ const source = generateRouteTypesSource(
243
+ mergedRoutes,
244
+ Object.keys(mergedSearchSchemas).length > 0
245
+ ? mergedSearchSchemas
246
+ : undefined,
247
+ );
248
+ const existing = existsSync(outPath)
249
+ ? readFileSync(outPath, "utf-8")
250
+ : null;
251
+ if (existing !== source) {
252
+ markSelfGenWrite(state, outPath, source);
253
+ writeFileSync(outPath, source);
254
+ }
255
+ }
256
+ // No manual manifest update needed: the virtual module imports the gen
257
+ // file, so Vite's HMR automatically re-evaluates it with fresh data.
258
+ }
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Self-Generated File Tracking
3
+ *
4
+ * Tracks gen files recently written by the discovery plugin so the
5
+ * file watcher can distinguish self-triggered change events from
6
+ * manual edits.
7
+ */
8
+
9
+ import { createHash } from "node:crypto";
10
+ import { readFileSync } from "node:fs";
11
+ import type { DiscoveryState } from "./state.js";
12
+
13
+ export function markSelfGenWrite(
14
+ state: DiscoveryState,
15
+ filePath: string,
16
+ content: string,
17
+ ): void {
18
+ const hash = createHash("sha256").update(content).digest("hex");
19
+ state.selfWrittenGenFiles.set(filePath, { at: Date.now(), hash });
20
+ }
21
+
22
+ export function consumeSelfGenWrite(
23
+ state: DiscoveryState,
24
+ filePath: string,
25
+ ): boolean {
26
+ return checkSelfGenWrite(state, filePath, true);
27
+ }
28
+
29
+ /**
30
+ * Non-consuming variant. Used by the `handleHotUpdate` plugin hook to
31
+ * suppress vite's HMR cascade for our own gen-file writes WITHOUT
32
+ * consuming the entry — `consumeSelfGenWrite` (called later from the
33
+ * chokidar `change` handler in `handleRouteFileChange`) still needs to
34
+ * see and consume the same entry to short-circuit our regen path.
35
+ *
36
+ * Both hooks fire for the same file change event:
37
+ * - `handleHotUpdate` runs first (vite's HMR pipeline).
38
+ * - chokidar `change` callback runs after (filesystem watcher).
39
+ */
40
+ export function peekSelfGenWrite(
41
+ state: DiscoveryState,
42
+ filePath: string,
43
+ ): boolean {
44
+ return checkSelfGenWrite(state, filePath, false);
45
+ }
46
+
47
+ function checkSelfGenWrite(
48
+ state: DiscoveryState,
49
+ filePath: string,
50
+ consume: boolean,
51
+ ): boolean {
52
+ const info = state.selfWrittenGenFiles.get(filePath);
53
+ if (!info) return false;
54
+ if (Date.now() - info.at > state.SELF_WRITE_WINDOW_MS) {
55
+ state.selfWrittenGenFiles.delete(filePath);
56
+ return false;
57
+ }
58
+ try {
59
+ const current = readFileSync(filePath, "utf-8");
60
+ const currentHash = createHash("sha256").update(current).digest("hex");
61
+ if (currentHash === info.hash) {
62
+ if (consume) state.selfWrittenGenFiles.delete(filePath);
63
+ return true;
64
+ }
65
+ // Hash mismatch: file was changed externally. Keep the entry so a
66
+ // subsequent watcher event from our own write can still be consumed
67
+ // (e.g. when multiple Vite servers watch the same directory).
68
+ return false;
69
+ } catch {
70
+ state.selfWrittenGenFiles.delete(filePath);
71
+ return false;
72
+ }
73
+ }
@@ -0,0 +1,117 @@
1
+ /**
2
+ * Discovery State
3
+ *
4
+ * Shared mutable state for the router discovery plugin.
5
+ * Created once by createRouterDiscoveryPlugin() and passed
6
+ * to all extracted helper functions.
7
+ */
8
+
9
+ import type { ScanFilter } from "../../build/generate-route-types.js";
10
+
11
+ export const VIRTUAL_ROUTES_MANIFEST_ID = "virtual:rsc-router/routes-manifest";
12
+
13
+ export interface PluginOptions {
14
+ enableBuildPrerender?: boolean;
15
+ staticRouteTypesGeneration?: boolean;
16
+ // Mutable ref for deferred auto-discovery (node preset).
17
+ // The auto-discover config() hook populates this before configResolved.
18
+ routerPathRef?: { path?: string };
19
+ /** Build-time env option from rango() config. */
20
+ buildEnv?: import("../plugin-types.js").BuildEnvOption;
21
+ /** Deployment preset (needed for buildEnv "auto" resolution). */
22
+ preset?: "node" | "cloudflare";
23
+ }
24
+
25
+ export interface PrecomputedEntry {
26
+ staticPrefix: string;
27
+ routes: Record<string, string>;
28
+ }
29
+
30
+ export interface ChunkInfo {
31
+ fileName: string;
32
+ exports: Array<{ name: string; handlerId: string; passthrough: boolean }>;
33
+ }
34
+
35
+ export interface PerRouterManifestEntry {
36
+ id: string;
37
+ routeManifest: Record<string, string>;
38
+ routeSearchSchemas?: Record<string, Record<string, string>>;
39
+ sourceFile?: string;
40
+ factoryOnlyPrefixes?: Set<string>;
41
+ }
42
+
43
+ export interface DiscoveryState {
44
+ resolvedEntryPath: string | undefined;
45
+ projectRoot: string;
46
+ isBuildMode: boolean;
47
+ userResolveAlias: any;
48
+ scanFilter: ScanFilter | undefined;
49
+ cachedRouterFiles: string[] | undefined;
50
+ opts: PluginOptions | undefined;
51
+
52
+ mergedRouteManifest: Record<string, string> | null;
53
+ perRouterManifests: PerRouterManifestEntry[];
54
+ mergedPrecomputedEntries: PrecomputedEntry[] | null;
55
+ mergedRouteTrie: any;
56
+
57
+ perRouterTrieMap: Map<string, any>;
58
+ perRouterPrecomputedMap: Map<string, PrecomputedEntry[]>;
59
+ perRouterManifestDataMap: Map<string, Record<string, string>>;
60
+
61
+ prerenderManifestEntries: Record<string, string> | null;
62
+ staticManifestEntries: Record<string, string> | null;
63
+ handlerChunkInfoMap: Map<string, ChunkInfo>;
64
+ staticHandlerChunkInfoMap: Map<string, ChunkInfo>;
65
+ rscEntryFileName: string | null;
66
+ resolvedPrerenderModules: Map<string, string[]> | undefined;
67
+ resolvedStaticModules: Map<string, string[]> | undefined;
68
+
69
+ discoveryDone: Promise<void> | null;
70
+ devServerOrigin: string | null;
71
+ devServer: any;
72
+ selfWrittenGenFiles: Map<string, { at: number; hash: string }>;
73
+ SELF_WRITE_WINDOW_MS: number;
74
+
75
+ /** Resolved build-time env bindings (set during buildStart/configureServer). */
76
+ resolvedBuildEnv?: Record<string, unknown>;
77
+ /** Cleanup function for build-time env resources (e.g., miniflare). */
78
+ buildEnvDispose?: (() => Promise<void> | void) | null;
79
+ }
80
+
81
+ export function createDiscoveryState(
82
+ entryPath: string | undefined,
83
+ opts: PluginOptions | undefined,
84
+ ): DiscoveryState {
85
+ return {
86
+ resolvedEntryPath: entryPath,
87
+ projectRoot: "",
88
+ isBuildMode: false,
89
+ userResolveAlias: undefined,
90
+ scanFilter: undefined,
91
+ cachedRouterFiles: undefined,
92
+ opts,
93
+
94
+ mergedRouteManifest: null,
95
+ perRouterManifests: [],
96
+ mergedPrecomputedEntries: null,
97
+ mergedRouteTrie: null,
98
+
99
+ perRouterTrieMap: new Map(),
100
+ perRouterPrecomputedMap: new Map(),
101
+ perRouterManifestDataMap: new Map(),
102
+
103
+ prerenderManifestEntries: null,
104
+ staticManifestEntries: null,
105
+ handlerChunkInfoMap: new Map(),
106
+ staticHandlerChunkInfoMap: new Map(),
107
+ rscEntryFileName: null,
108
+ resolvedPrerenderModules: undefined,
109
+ resolvedStaticModules: undefined,
110
+
111
+ discoveryDone: null,
112
+ devServerOrigin: null,
113
+ devServer: null,
114
+ selfWrittenGenFiles: new Map(),
115
+ SELF_WRITE_WINDOW_MS: 5_000,
116
+ };
117
+ }
@@ -0,0 +1,203 @@
1
+ /**
2
+ * Virtual Module Code Generation
3
+ *
4
+ * Generates the code for virtual:rsc-router/routes-manifest and
5
+ * per-router virtual modules used by the load() hook.
6
+ */
7
+
8
+ import { dirname, basename, join } from "node:path";
9
+ import { jsonParseExpression } from "../utils/manifest-utils.js";
10
+ import { VIRTUAL_ROUTES_MANIFEST_ID } from "./state.js";
11
+ import type { DiscoveryState } from "./state.js";
12
+
13
+ /**
14
+ * Generate the code for the main virtual:rsc-router/routes-manifest module.
15
+ */
16
+ export function generateRoutesManifestModule(state: DiscoveryState): string {
17
+ const hasManifest =
18
+ state.mergedRouteManifest &&
19
+ Object.keys(state.mergedRouteManifest).length > 0;
20
+
21
+ if (hasManifest) {
22
+ // Build gen file import statements for each router with a sourceFile.
23
+ // This creates a dependency in Vite's module graph: when the gen file
24
+ // changes (e.g. after HMR route edits), Vite invalidates this virtual
25
+ // module and re-evaluates it on the next request, calling
26
+ // setCachedManifest() with fresh data. No manual sync needed.
27
+ const genFileImports: string[] = [];
28
+ const genFileVars: string[] = [];
29
+ const routersWithoutGenFile: Array<{
30
+ id: string;
31
+ manifest: Record<string, string>;
32
+ }> = [];
33
+ let varIdx = 0;
34
+
35
+ for (const entry of state.perRouterManifests) {
36
+ if (entry.sourceFile) {
37
+ const routerDir = dirname(entry.sourceFile);
38
+ const routerBasename = basename(entry.sourceFile).replace(
39
+ /\.(tsx?|jsx?)$/,
40
+ "",
41
+ );
42
+ const genPath = join(
43
+ routerDir,
44
+ `${routerBasename}.named-routes.gen.js`,
45
+ ).replaceAll("\\", "/");
46
+ const varName = `_r${varIdx++}`;
47
+ genFileImports.push(
48
+ `import { NamedRoutes as ${varName} } from ${JSON.stringify(genPath)};`,
49
+ );
50
+ genFileVars.push(varName);
51
+ } else {
52
+ // Routers without sourceFile: inline their manifest data directly
53
+ routersWithoutGenFile.push({
54
+ id: entry.id,
55
+ manifest: entry.routeManifest,
56
+ });
57
+ }
58
+ }
59
+
60
+ const lines = [
61
+ `import { setCachedManifest, setPrecomputedEntries, setRouteTrie, setRouterManifest, registerRouterManifestLoader, clearAllRouterData } from "@rangojs/router/server";`,
62
+ ...genFileImports,
63
+ // Clear stale per-router cached data (manifest, trie, precomputed entries)
64
+ // before re-populating. In Cloudflare dev mode, program reloads re-evaluate
65
+ // this virtual module but the route-map-builder singleton retains old data
66
+ // because it's not in the HMR invalidation chain. Without this clear, the
67
+ // handler finds stale trie data and never rebuilds from updated urlpatterns.
68
+ `clearAllRouterData();`,
69
+ ];
70
+
71
+ // Flatten NamedRoutes entries: search schema objects -> plain string paths
72
+ if (genFileVars.length > 0) {
73
+ lines.push(
74
+ `function __flat(r) { const o = {}; for (const [k, v] of Object.entries(r)) o[k] = typeof v === "string" ? v : v.path; return o; }`,
75
+ );
76
+ }
77
+
78
+ // Build the merged manifest from gen file imports + inlined data
79
+ if (genFileVars.length === 1 && routersWithoutGenFile.length === 0) {
80
+ lines.push(`setCachedManifest(__flat(${genFileVars[0]}));`);
81
+ } else {
82
+ const parts: string[] = [];
83
+ for (const v of genFileVars) parts.push(`...__flat(${v})`);
84
+ for (const { manifest } of routersWithoutGenFile)
85
+ parts.push(`...${jsonParseExpression(manifest)}`);
86
+ lines.push(`setCachedManifest({ ${parts.join(", ")} });`);
87
+ }
88
+
89
+ // Set per-router manifests
90
+ let genVarIdx = 0;
91
+ for (const entry of state.perRouterManifests) {
92
+ if (entry.sourceFile) {
93
+ const varName = genFileVars[genVarIdx++];
94
+ lines.push(
95
+ `setRouterManifest(${JSON.stringify(entry.id)}, __flat(${varName}));`,
96
+ );
97
+ } else {
98
+ lines.push(
99
+ `setRouterManifest(${JSON.stringify(entry.id)}, ${jsonParseExpression(entry.routeManifest)});`,
100
+ );
101
+ }
102
+ }
103
+
104
+ // In dev mode, skip trie and precomputed entries injection. These are
105
+ // computed once during initial discovery and become stale after route
106
+ // changes. A stale trie would incorrectly match removed routes. The
107
+ // handler falls back to Phase 2 regex matching against the live
108
+ // router.urlpatterns, which is always correct after a program reload.
109
+ // In build mode, the trie is always fresh (built from the final route
110
+ // tree) so it's safe to inject.
111
+ if (state.isBuildMode) {
112
+ if (
113
+ state.mergedPrecomputedEntries &&
114
+ state.mergedPrecomputedEntries.length > 0
115
+ ) {
116
+ lines.push(
117
+ `setPrecomputedEntries(${jsonParseExpression(state.mergedPrecomputedEntries)});`,
118
+ );
119
+ }
120
+ if (state.mergedRouteTrie) {
121
+ lines.push(
122
+ `setRouteTrie(${jsonParseExpression(state.mergedRouteTrie)});`,
123
+ );
124
+ }
125
+ }
126
+
127
+ // Register lazy loaders for per-router manifest modules.
128
+ // Each import() uses a static string literal so Rollup creates separate chunks.
129
+ for (const routerId of state.perRouterManifestDataMap.keys()) {
130
+ lines.push(
131
+ `registerRouterManifestLoader(${JSON.stringify(routerId)}, () => import(${JSON.stringify(VIRTUAL_ROUTES_MANIFEST_ID + "/" + routerId)}));`,
132
+ );
133
+ }
134
+ if (!state.isBuildMode && state.devServerOrigin) {
135
+ lines.push(
136
+ `globalThis.__PRERENDER_DEV_URL = ${JSON.stringify(state.devServerOrigin)};`,
137
+ );
138
+ }
139
+ return lines.join("\n");
140
+ }
141
+
142
+ // No manifest: either discovery hasn't completed or no runner (Cloudflare dev).
143
+ // Still inject __PRERENDER_DEV_URL so the prerender store can fetch on-demand.
144
+ // Re-resolve origin now since the server is listening by module load time.
145
+ if (!state.isBuildMode) {
146
+ const origin =
147
+ state.devServerOrigin ||
148
+ state.devServer?.resolvedUrls?.local?.[0]?.replace(/\/$/, "") ||
149
+ (state.devServer &&
150
+ `http://localhost:${state.devServer.config.server.port || 5173}`);
151
+ if (origin) {
152
+ state.devServerOrigin = origin;
153
+ return `globalThis.__PRERENDER_DEV_URL = ${JSON.stringify(origin)};`;
154
+ }
155
+ }
156
+ return `// Route manifest will be populated at runtime`;
157
+ }
158
+
159
+ /**
160
+ * Generate the code for a per-router virtual module.
161
+ */
162
+ export function generatePerRouterModule(
163
+ state: DiscoveryState,
164
+ routerId: string,
165
+ ): string {
166
+ // Find the per-router entry to get the gen file path
167
+ const routerEntry = state.perRouterManifests.find((e) => e.id === routerId);
168
+ const trie = state.perRouterTrieMap.get(routerId);
169
+ const entries = state.perRouterPrecomputedMap.get(routerId);
170
+ const lines: string[] = [];
171
+
172
+ if (routerEntry?.sourceFile) {
173
+ // Import manifest from the gen file so HMR auto-propagates
174
+ const routerDir = dirname(routerEntry.sourceFile);
175
+ const routerBasename = basename(routerEntry.sourceFile).replace(
176
+ /\.(tsx?|jsx?)$/,
177
+ "",
178
+ );
179
+ const genPath = join(
180
+ routerDir,
181
+ `${routerBasename}.named-routes.gen.js`,
182
+ ).replaceAll("\\", "/");
183
+ lines.push(`import { NamedRoutes as _r } from ${JSON.stringify(genPath)};`);
184
+ lines.push(
185
+ `function __flat(r) { const o = {}; for (const [k, v] of Object.entries(r)) o[k] = typeof v === "string" ? v : v.path; return o; }`,
186
+ );
187
+ lines.push(`export const manifest = __flat(_r);`);
188
+ } else {
189
+ const manifest = state.perRouterManifestDataMap.get(routerId);
190
+ if (manifest) {
191
+ lines.push(`export const manifest = ${jsonParseExpression(manifest)};`);
192
+ }
193
+ }
194
+ if (trie) {
195
+ lines.push(`export const trie = ${jsonParseExpression(trie)};`);
196
+ }
197
+ if (entries && entries.length > 0) {
198
+ lines.push(
199
+ `export const precomputedEntries = ${jsonParseExpression(entries)};`,
200
+ );
201
+ }
202
+ return lines.join("\n") || "// empty router manifest";
203
+ }