@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
package/src/loader.rsc.ts CHANGED
@@ -5,9 +5,9 @@
5
5
  * Only used in react-server context via export conditions.
6
6
  *
7
7
  * For non-fetchable loaders: returns a loader definition with fn included
8
- * For fetchable loaders: stores fn in registry and returns a serializable loader with action
8
+ * For fetchable loaders: stores fn in registry and returns a serializable loader
9
9
  *
10
- * The $$id is injected by the Vite exposeLoaderId plugin as a hidden parameter.
10
+ * The $$id is injected by the Vite exposeInternalIds plugin as a hidden parameter.
11
11
  * Users don't need to pass any name - IDs are auto-generated from file path.
12
12
  */
13
13
 
@@ -17,90 +17,54 @@ import type {
17
17
  LoaderFn,
18
18
  } from "./types.js";
19
19
  import type { MiddlewareFn } from "./router/middleware.js";
20
- import { getRequestContext } from "./server/request-context.js";
20
+ import {
21
+ registerFetchableLoader,
22
+ getFetchableLoader,
23
+ } from "./server/fetchable-loader-store.js";
21
24
 
22
- // Internal registry for fetchable loaders (server-side only)
23
- // Maps loader $$id to its function and middleware
24
- //
25
- // WHY TWO REGISTRIES?
26
- // This registry (fetchableLoaderRegistry) is populated immediately when createLoader() runs.
27
- // The other registry in loader-registry.ts (loaderRegistry) is a cache used by the RSC handler
28
- // for GET-based fetching. The RSC handler calls getFetchableLoader() from here to populate
29
- // its cache. This separation allows:
30
- // 1. Server actions to look up loaders directly without going through lazy loading
31
- // 2. The RSC handler to use lazy loading for production builds
32
- // 3. Both to share the same source of truth (this registry)
33
- const fetchableLoaderRegistry = new Map<
34
- string,
35
- { fn: LoaderFn<any, any, any>; middleware: MiddlewareFn[] }
36
- >();
37
-
38
- /**
39
- * Register a fetchable loader's function internally
40
- * Called during module initialization with the $$id
41
- */
42
- function registerFetchableLoader(
43
- id: string,
44
- fn: LoaderFn<any, any, any>,
45
- middleware: MiddlewareFn[]
46
- ): void {
47
- fetchableLoaderRegistry.set(id, { fn, middleware });
48
- }
49
-
50
- /**
51
- * Get a fetchable loader's function from the internal registry by $$id
52
- *
53
- * This is used internally by:
54
- * - Server actions (loaderAction) to execute loader functions
55
- * - loader-registry.ts to populate the main registry for GET-based fetching
56
- *
57
- * Loaders are registered here when createLoader() is called with fetchable: true.
58
- * The $$id is injected by the Vite exposeLoaderId plugin.
59
- *
60
- * @param id - The loader's $$id (auto-generated from file path + export name)
61
- * @returns The loader function and middleware, or undefined if not found
62
- *
63
- * @internal This is primarily for internal use by the router infrastructure
64
- */
65
- export function getFetchableLoader(
66
- id: string
67
- ): { fn: LoaderFn<any, any, any>; middleware: MiddlewareFn[] } | undefined {
68
- return fetchableLoaderRegistry.get(id);
69
- }
25
+ export { getFetchableLoader };
70
26
 
71
27
  // Overload 1: With function only (not fetchable)
72
28
  export function createLoader<T>(
73
- fn: LoaderFn<T, Record<string, string | undefined>, any>
29
+ fn: LoaderFn<T, Record<string, string | undefined>, any>,
74
30
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
75
31
 
76
32
  // Overload 2: Fetchable with `true` (no middleware)
77
33
  export function createLoader<T>(
78
34
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
79
- fetchable: true
35
+ fetchable: true,
80
36
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
81
37
 
82
38
  // Overload 3: Fetchable with middleware options
83
39
  export function createLoader<T>(
84
40
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
85
- options: FetchableLoaderOptions
41
+ options: FetchableLoaderOptions,
86
42
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
87
43
 
88
44
  // Implementation - the $$id parameter is injected by Vite plugin, not user-provided
89
45
  export function createLoader<T>(
90
46
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
91
47
  fetchable?: true | FetchableLoaderOptions,
92
- // Hidden parameter injected by Vite exposeLoaderId plugin
93
- __injectedId?: string
48
+ // Hidden parameter injected by Vite exposeInternalIds plugin
49
+ __injectedId?: string,
94
50
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>> {
95
51
  // The $$id will be set on the returned object by Vite plugin
96
52
  // For fetchable loaders, __injectedId is also passed as a parameter
97
53
  const loaderId = __injectedId || "";
98
54
 
99
- // If not fetchable, store fn in registry and return a plain object.
100
- // Server-side code looks up fn via getFetchableLoader($$id).
55
+ if (!loaderId && process.env.NODE_ENV === "development") {
56
+ throw new Error(
57
+ "[rsc-router] Loader is missing $$id. " +
58
+ "Make sure the exposeInternalIds Vite plugin is enabled and " +
59
+ "the loader is exported with: export const MyLoader = createLoader(...)",
60
+ );
61
+ }
62
+
63
+ // If not fetchable, store fn in registry (for SSR ctx.use() resolution)
64
+ // but mark fetchable=false so the _rsc_loader endpoint rejects it.
101
65
  if (fetchable === undefined) {
102
66
  if (fn && loaderId) {
103
- registerFetchableLoader(loaderId, fn, []);
67
+ registerFetchableLoader(loaderId, fn, [], false);
104
68
  }
105
69
  return {
106
70
  __brand: "loader",
@@ -113,95 +77,13 @@ export function createLoader<T>(
113
77
  fetchable === true ? [] : fetchable?.middleware || [];
114
78
 
115
79
  // Register the function in the internal registry by $$id (server-side only)
116
- // The server action will look it up by $$id when executed
80
+ // The loader fetch handler looks it up by $$id when load() is called from the client.
117
81
  if (fn && loaderId) {
118
- registerFetchableLoader(loaderId, fn, middleware);
119
- }
120
-
121
- // Create server action for form-based fetching
122
- // This action is serializable and can be passed to client components
123
- // The loaderId is captured in closure (it's a primitive string)
124
- //
125
- // IMPORTANT: The signature must be (prevState, formData) for useActionState compatibility.
126
- // When used with useActionState, React passes the previous state as the first argument.
127
- // The prevState is ignored here since loaders are stateless data fetchers.
128
- async function loaderAction(
129
- _prevState: Awaited<T> | null,
130
- formData: FormData
131
- ): Promise<Awaited<T>> {
132
- "use server";
133
-
134
- // Look up the loader from registry by $$id
135
- const registered = fetchableLoaderRegistry.get(loaderId);
136
- if (!registered) {
137
- throw new Error(`Loader "${loaderId}" not found in registry`);
138
- }
139
-
140
- // Get request context (env, request, url, variables) from the RSC handler
141
- // This is set by runWithRequestContext in rsc/index.ts when executing actions
142
- const requestCtx = getRequestContext();
143
-
144
- // Convert FormData to params object
145
- const params: Record<string, string> = {};
146
- formData.forEach((value, key) => {
147
- if (typeof value === "string") {
148
- params[key] = value;
149
- }
150
- });
151
-
152
- // Use real request/url from context, or fall back to synthetic for edge cases
153
- const actionUrl = requestCtx?.url ?? new URL("http://localhost/");
154
- const actionRequest = requestCtx?.request ?? new Request(actionUrl, { method: "POST" });
155
- const env = requestCtx?.env ?? {};
156
-
157
- // Merge variables from request context (app-level middleware) with loader-specific variables
158
- // requestCtx.var is the shared variables object from the handler
159
- const variables: Record<string, any> = { ...requestCtx?.var };
160
-
161
- // Execute middleware for auth checks, headers, cookies
162
- // Headers/cookies set on ctx.res will be merged into the final response
163
- if (registered.middleware.length > 0 && requestCtx?.res) {
164
- const { executeServerActionMiddleware } = await import(
165
- "./router/middleware.js"
166
- );
167
- await executeServerActionMiddleware(
168
- registered.middleware,
169
- actionRequest,
170
- env,
171
- params,
172
- variables,
173
- requestCtx.res
174
- );
175
- }
176
-
177
- // Build context using createHandlerContext for consistency with route handlers
178
- // Variables are now accessed from request context via getRequestContext()
179
- const { createHandlerContext } = await import("./router/handler-context.js");
180
- const baseCtx = createHandlerContext(
181
- params,
182
- actionRequest,
183
- actionUrl.searchParams,
184
- actionUrl.pathname,
185
- actionUrl,
186
- env
187
- );
188
-
189
- // Extend with server action specific properties
190
- const ctx: any = {
191
- ...baseCtx,
192
- method: "POST",
193
- formData,
194
- };
195
-
196
- // Execute and return result
197
- return registered.fn(ctx);
82
+ registerFetchableLoader(loaderId, fn, middleware, true);
198
83
  }
199
84
 
200
- // Return a plain object with action for form-based fetching.
201
- // loaderAction has "use server" so RSC Flight serializes it natively as a server action reference.
202
85
  return {
203
86
  __brand: "loader",
204
87
  $$id: loaderId,
205
- action: loaderAction,
206
88
  };
207
89
  }
package/src/loader.ts CHANGED
@@ -2,10 +2,15 @@
2
2
  * rsc-router/loader (client version)
3
3
  *
4
4
  * Client-only stub for createLoader. Returns a minimal loader definition
5
- * that can be passed to hooks like useLoader. The actual loader function
6
- * is not included - it only exists on the server.
5
+ * ({ __brand, $$id }) that can be passed to hooks like useLoader.
6
+ * The actual loader function is not included -- it only exists on the server.
7
7
  *
8
- * The $$id is injected by the Vite exposeLoaderId plugin.
8
+ * For export-only loader files, the Vite plugin replaces the entire file with
9
+ * object literals (bypassing this function). Those stubs only contain
10
+ * { __brand, $$id }.
11
+ * This function only runs when loaders are in mixed files (not export-only).
12
+ *
13
+ * The $$id is injected by the Vite exposeInternalIds plugin.
9
14
  */
10
15
 
11
16
  import type {
@@ -16,32 +21,44 @@ import type {
16
21
 
17
22
  // Overload 1: With function only (not fetchable)
18
23
  export function createLoader<T>(
19
- fn: LoaderFn<T, Record<string, string | undefined>, any>
24
+ fn: LoaderFn<T, Record<string, string | undefined>, any>,
20
25
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
21
26
 
22
27
  // Overload 2: Fetchable with `true` (no middleware)
23
28
  export function createLoader<T>(
24
29
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
25
- fetchable: true
30
+ fetchable: true,
26
31
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
27
32
 
28
33
  // Overload 3: Fetchable with middleware options
29
34
  export function createLoader<T>(
30
35
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
31
- options: FetchableLoaderOptions
36
+ options: FetchableLoaderOptions,
32
37
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
33
38
 
34
39
  // Implementation - client stub that just returns the loader definition
35
40
  // The $$id parameter is injected by Vite plugin, not user-provided
41
+ //
42
+ // NOTE: For export-only loader files, the Vite plugin replaces the entire
43
+ // file with object literals (bypassing this function). This function only
44
+ // runs when loaders are in mixed files (not export-only).
36
45
  export function createLoader<T>(
37
46
  _fn: LoaderFn<T, Record<string, string | undefined>, any>,
38
47
  _fetchable?: true | FetchableLoaderOptions,
39
- __injectedId?: string
48
+ __injectedId?: string,
40
49
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>> {
41
- // Client only needs the $$id for identification
42
- // The actual loader function is only used on the server
50
+ const loaderId = __injectedId || "";
51
+
52
+ if (!loaderId && process.env.NODE_ENV === "development") {
53
+ throw new Error(
54
+ "[rsc-router] Loader is missing $$id. " +
55
+ "Make sure the exposeInternalIds Vite plugin is enabled and " +
56
+ "the loader is exported with: export const MyLoader = createLoader(...)",
57
+ );
58
+ }
59
+
43
60
  return {
44
61
  __brand: "loader",
45
- $$id: __injectedId || "",
62
+ $$id: loaderId,
46
63
  };
47
64
  }
@@ -16,6 +16,8 @@ interface NetworkErrorThrowerProps {
16
16
  * 1. Errors must be thrown during React's render phase to be caught by error boundaries
17
17
  * 2. The error occurs in async code (fetch), so we need to propagate it to React's render
18
18
  */
19
- export function NetworkErrorThrower({ error }: NetworkErrorThrowerProps): ReactNode {
19
+ export function NetworkErrorThrower({
20
+ error,
21
+ }: NetworkErrorThrowerProps): ReactNode {
20
22
  throw error;
21
23
  }
@@ -1,4 +1,4 @@
1
- import { Context, createContext, type ReactNode } from "react";
1
+ import { type Context, createContext, type ReactNode } from "react";
2
2
  import type { ResolvedSegment } from "./types";
3
3
 
4
4
  export interface OutletContextValue {
@@ -0,0 +1,45 @@
1
+ "use client";
2
+
3
+ import { useContext, useMemo, type ReactNode } from "react";
4
+ import { OutletContext, type OutletContextValue } from "./outlet-context.js";
5
+ import type { ResolvedSegment } from "./types.js";
6
+
7
+ /**
8
+ * Provider for outlet content - used internally by renderSegments
9
+ *
10
+ * Stores a reference to parent context so useLoader can walk up the chain
11
+ * to find loader data from parent layouts. If this segment defines a loading
12
+ * component, Outlet will wrap content with Suspense using that as fallback.
13
+ */
14
+ export function OutletProvider({
15
+ content,
16
+ parallel,
17
+ segment,
18
+ loaderData,
19
+ children,
20
+ }: {
21
+ content: ReactNode;
22
+ parallel?: ResolvedSegment[];
23
+ segment?: ResolvedSegment;
24
+ loaderData?: Record<string, any>;
25
+ children: ReactNode;
26
+ }): ReactNode {
27
+ // Get parent context to enable walking up the chain for loader lookups
28
+ const parentContext = useContext(OutletContext);
29
+
30
+ const value = useMemo(
31
+ () => ({
32
+ content,
33
+ parallel,
34
+ segment,
35
+ loaderData,
36
+ parent: parentContext,
37
+ loading: segment?.loading,
38
+ }),
39
+ [content, parallel, segment, loaderData, parentContext],
40
+ );
41
+
42
+ return (
43
+ <OutletContext.Provider value={value}>{children}</OutletContext.Provider>
44
+ );
45
+ }
@@ -17,8 +17,10 @@ export function hashParams(params: Record<string, string>): string {
17
17
  const entries = Object.entries(params);
18
18
  if (entries.length === 0) return "_";
19
19
 
20
- const sorted = entries.sort(([a], [b]) => a.localeCompare(b));
21
- const str = sorted.map(([k, v]) => `${k}=${v}`).join("&");
20
+ const sorted = entries.sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0));
21
+ const str = sorted
22
+ .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
23
+ .join("&");
22
24
  return djb2Hex(str);
23
25
  }
24
26
 
@@ -1,12 +1,17 @@
1
1
  /**
2
2
  * Prerender Store
3
3
  *
4
- * Reads pre-rendered segment data injected into the worker bundle at build time.
5
- * The data is stored as globalThis.__PRERENDER_DATA, a JSON object keyed by
6
- * "<routeName>/<paramHash>".
4
+ * Reads pre-rendered segment data from the worker bundle at build time.
5
+ * The manifest module is lazily loaded via globalThis.__loadPrerenderManifestModule,
6
+ * a function injected into the RSC entry that returns the manifest module
7
+ * containing a key-to-specifier map and a `loadPrerenderAsset` function
8
+ * that anchors import() resolution relative to the manifest file.
7
9
  */
8
10
 
9
- import type { SerializedSegmentData, SegmentHandleData } from "../cache/types.js";
11
+ import type {
12
+ SerializedSegmentData,
13
+ SegmentHandleData,
14
+ } from "../cache/types.js";
10
15
 
11
16
  export interface PrerenderEntry {
12
17
  segments: SerializedSegmentData[];
@@ -14,27 +19,168 @@ export interface PrerenderEntry {
14
19
  }
15
20
 
16
21
  export interface PrerenderStore {
17
- get(routeName: string, paramHash: string): PrerenderEntry | null;
22
+ get(
23
+ routeName: string,
24
+ paramHash: string,
25
+ meta?: { pathname: string; isPassthroughRoute?: boolean },
26
+ ): PrerenderEntry | null | Promise<PrerenderEntry | null>;
27
+ }
28
+
29
+ export interface StaticEntry {
30
+ encoded: string;
31
+ handles: Record<string, unknown[]>;
32
+ }
33
+
34
+ export interface StaticStore {
35
+ get(handlerId: string): Promise<StaticEntry | null>;
36
+ }
37
+
38
+ interface PrerenderManifestModule {
39
+ default: Record<string, string>;
40
+ loadPrerenderAsset: (
41
+ specifier: string,
42
+ ) => Promise<{ default: PrerenderEntry }>;
18
43
  }
19
44
 
20
45
  declare global {
21
- // Injected by closeBundle post-processing
46
+ // Injected by closeBundle post-processing: lazy loader for the prerender
47
+ // manifest module. The module exports a key→specifier map and a
48
+ // loadPrerenderAsset function that anchors import() relative to the manifest.
49
+ // eslint-disable-next-line no-var
50
+ var __loadPrerenderManifestModule:
51
+ | (() => Promise<PrerenderManifestModule>)
52
+ | undefined;
53
+ // Injected by closeBundle post-processing: map of handlerId -> () => import("./assets/__st-*.js")
54
+ // Asset default export is either a string (no handles) or { encoded, handles } object.
22
55
  // eslint-disable-next-line no-var
23
- var __PRERENDER_DATA: Record<string, PrerenderEntry> | undefined;
56
+ var __STATIC_MANIFEST:
57
+ | Record<string, () => Promise<{ default: string | StaticEntry }>>
58
+ | undefined;
59
+ // Injected by virtual module in dev mode for on-demand prerender
60
+ // eslint-disable-next-line no-var
61
+ var __PRERENDER_DEV_URL: string | undefined;
24
62
  }
25
63
 
26
64
  /**
27
- * Create a prerender store backed by globalThis.__PRERENDER_DATA.
28
- * Returns null if no prerender data is available (dev mode or no prerendered routes).
65
+ * Create a dev-mode prerender store that fetches on-demand from the
66
+ * Vite dev server's /__rsc_prerender endpoint (runs in Node.js where
67
+ * node:fs works, unlike workerd).
68
+ */
69
+ export function createDevPrerenderStore(devUrl: string): PrerenderStore {
70
+ return {
71
+ async get(routeName, paramHash, meta) {
72
+ if (!meta?.pathname) return null;
73
+ const isIntercept = paramHash.endsWith("/i");
74
+ let url = `${devUrl}/__rsc_prerender?pathname=${encodeURIComponent(meta.pathname)}&routeName=${encodeURIComponent(routeName)}`;
75
+ if (isIntercept) url += "&intercept=1";
76
+ if (meta.isPassthroughRoute) url += "&passthrough=1";
77
+ try {
78
+ const res = await fetch(url);
79
+ if (!res.ok) return null;
80
+ return res.json();
81
+ } catch {
82
+ return null;
83
+ }
84
+ },
85
+ };
86
+ }
87
+
88
+ /**
89
+ * Create a prerender store.
90
+ * Dev mode: on-demand fetch from Vite dev server (node:fs works there).
91
+ * Production: backed by globalThis.__loadPrerenderManifestModule which lazily
92
+ * loads the manifest module on first access.
93
+ * Returns null if no prerender data is available.
29
94
  */
30
95
  export function createPrerenderStore(): PrerenderStore | null {
31
- const data = globalThis.__PRERENDER_DATA;
32
- if (!data || Object.keys(data).length === 0) return null;
96
+ if (globalThis.__PRERENDER_DEV_URL) {
97
+ return createDevPrerenderStore(globalThis.__PRERENDER_DEV_URL);
98
+ }
99
+ if (!globalThis.__loadPrerenderManifestModule) return null;
100
+
101
+ const cache = new Map<string, Promise<PrerenderEntry | null>>();
102
+ let manifestModulePromise: Promise<PrerenderManifestModule | null> | null =
103
+ null;
104
+
105
+ function loadManifestModule(): Promise<PrerenderManifestModule | null> {
106
+ if (!manifestModulePromise) {
107
+ manifestModulePromise = globalThis.__loadPrerenderManifestModule!().catch(
108
+ () => null,
109
+ );
110
+ }
111
+ return manifestModulePromise;
112
+ }
33
113
 
34
114
  return {
35
- get(routeName: string, paramHash: string): PrerenderEntry | null {
115
+ get(routeName: string, paramHash: string): Promise<PrerenderEntry | null> {
36
116
  const key = `${routeName}/${paramHash}`;
37
- return data[key] ?? null;
117
+ const cached = cache.get(key);
118
+ if (cached) return cached;
119
+
120
+ const promise = loadManifestModule().then((mod) => {
121
+ if (!mod) return null;
122
+ const specifier = mod.default[key];
123
+ if (!specifier) return null;
124
+ // Let asset load errors propagate — a missing/corrupted artifact
125
+ // for a key that exists in the manifest is a build/deploy error
126
+ // and should surface as a 500, not be silently swallowed as null
127
+ // (which the handler stub would misreport as a 404).
128
+ return mod.loadPrerenderAsset(specifier).then((asset) => asset.default);
129
+ });
130
+ cache.set(key, promise);
131
+ return promise;
132
+ },
133
+ };
134
+ }
135
+
136
+ /**
137
+ * Load the prerender manifest index for test introspection.
138
+ * Returns the key→specifier map or null if unavailable.
139
+ */
140
+ export async function loadPrerenderManifestIndex(): Promise<Record<
141
+ string,
142
+ string
143
+ > | null> {
144
+ if (!globalThis.__loadPrerenderManifestModule) return null;
145
+ try {
146
+ const mod = await globalThis.__loadPrerenderManifestModule();
147
+ return mod.default;
148
+ } catch {
149
+ return null;
150
+ }
151
+ }
152
+
153
+ /**
154
+ * Create a static segment store.
155
+ * Production only: backed by globalThis.__STATIC_MANIFEST injected at build time.
156
+ * Returns null if no static data is available (dev mode or no Static handlers).
157
+ */
158
+ export function createStaticStore(): StaticStore | null {
159
+ const manifest = globalThis.__STATIC_MANIFEST;
160
+ if (!manifest || Object.keys(manifest).length === 0) return null;
161
+
162
+ const cache = new Map<string, Promise<StaticEntry | null>>();
163
+
164
+ return {
165
+ get(handlerId: string): Promise<StaticEntry | null> {
166
+ const cached = cache.get(handlerId);
167
+ if (cached) return cached;
168
+
169
+ const importFn = manifest[handlerId];
170
+ if (!importFn) return Promise.resolve(null);
171
+
172
+ const promise = importFn()
173
+ .then((mod) => {
174
+ const val = mod.default;
175
+ // Normalize: string-only (no handles) or { encoded, handles }
176
+ if (typeof val === "string") {
177
+ return { encoded: val, handles: {} } as StaticEntry;
178
+ }
179
+ return val as StaticEntry;
180
+ })
181
+ .catch(() => null);
182
+ cache.set(handlerId, promise);
183
+ return promise;
38
184
  },
39
185
  };
40
186
  }