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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +120 -25
  2. package/dist/bin/rango.js +147 -57
  3. package/dist/testing/vitest.js +82 -0
  4. package/dist/vite/index.js +2154 -861
  5. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  6. package/package.json +57 -11
  7. package/skills/api-client/SKILL.md +211 -0
  8. package/skills/breadcrumbs/SKILL.md +3 -1
  9. package/skills/bundle-analysis/SKILL.md +159 -0
  10. package/skills/cache-guide/SKILL.md +220 -30
  11. package/skills/caching/SKILL.md +116 -8
  12. package/skills/composability/SKILL.md +27 -2
  13. package/skills/document-cache/SKILL.md +78 -55
  14. package/skills/handler-use/SKILL.md +364 -0
  15. package/skills/hooks/SKILL.md +229 -20
  16. package/skills/host-router/SKILL.md +45 -20
  17. package/skills/i18n/SKILL.md +276 -0
  18. package/skills/intercept/SKILL.md +46 -4
  19. package/skills/layout/SKILL.md +28 -7
  20. package/skills/links/SKILL.md +247 -17
  21. package/skills/loader/SKILL.md +219 -9
  22. package/skills/middleware/SKILL.md +47 -12
  23. package/skills/migrate-nextjs/SKILL.md +562 -0
  24. package/skills/migrate-react-router/SKILL.md +769 -0
  25. package/skills/mime-routes/SKILL.md +27 -0
  26. package/skills/observability/SKILL.md +137 -0
  27. package/skills/parallel/SKILL.md +71 -6
  28. package/skills/prerender/SKILL.md +14 -33
  29. package/skills/rango/SKILL.md +243 -22
  30. package/skills/react-compiler/SKILL.md +168 -0
  31. package/skills/response-routes/SKILL.md +122 -47
  32. package/skills/route/SKILL.md +57 -4
  33. package/skills/router-setup/SKILL.md +3 -3
  34. package/skills/server-actions/SKILL.md +751 -0
  35. package/skills/streams-and-websockets/SKILL.md +283 -0
  36. package/skills/testing/SKILL.md +128 -0
  37. package/skills/testing/bindings.md +89 -0
  38. package/skills/testing/cache-prerender.md +98 -0
  39. package/skills/testing/client-components.md +121 -0
  40. package/skills/testing/e2e-parity.md +124 -0
  41. package/skills/testing/flight.md +89 -0
  42. package/skills/testing/handles.md +127 -0
  43. package/skills/testing/loader.md +108 -0
  44. package/skills/testing/middleware.md +97 -0
  45. package/skills/testing/render-handler.md +102 -0
  46. package/skills/testing/response-routes.md +94 -0
  47. package/skills/testing/reverse-and-types.md +83 -0
  48. package/skills/testing/server-actions.md +89 -0
  49. package/skills/testing/server-tree.md +128 -0
  50. package/skills/testing/setup.md +120 -0
  51. package/skills/typesafety/SKILL.md +319 -27
  52. package/skills/use-cache/SKILL.md +34 -5
  53. package/skills/view-transitions/SKILL.md +294 -0
  54. package/src/__augment-tests__/augment.ts +81 -0
  55. package/src/__augment-tests__/augmented.check.ts +116 -0
  56. package/src/browser/action-coordinator.ts +53 -36
  57. package/src/browser/app-shell.ts +52 -0
  58. package/src/browser/event-controller.ts +86 -70
  59. package/src/browser/history-state.ts +21 -0
  60. package/src/browser/index.ts +3 -3
  61. package/src/browser/navigation-bridge.ts +84 -11
  62. package/src/browser/navigation-client.ts +104 -68
  63. package/src/browser/navigation-store.ts +32 -9
  64. package/src/browser/navigation-transaction.ts +10 -28
  65. package/src/browser/partial-update.ts +64 -26
  66. package/src/browser/prefetch/cache.ts +183 -44
  67. package/src/browser/prefetch/fetch.ts +228 -37
  68. package/src/browser/prefetch/queue.ts +36 -5
  69. package/src/browser/rango-state.ts +53 -13
  70. package/src/browser/react/Link.tsx +30 -2
  71. package/src/browser/react/NavigationProvider.tsx +72 -31
  72. package/src/browser/react/filter-segment-order.ts +51 -7
  73. package/src/browser/react/index.ts +3 -0
  74. package/src/browser/react/location-state-shared.ts +175 -4
  75. package/src/browser/react/location-state.ts +39 -13
  76. package/src/browser/react/use-handle.ts +17 -9
  77. package/src/browser/react/use-navigation.ts +22 -2
  78. package/src/browser/react/use-params.ts +20 -8
  79. package/src/browser/react/use-reverse.ts +106 -0
  80. package/src/browser/react/use-router.ts +22 -2
  81. package/src/browser/react/use-segments.ts +11 -8
  82. package/src/browser/response-adapter.ts +32 -1
  83. package/src/browser/rsc-router.tsx +69 -22
  84. package/src/browser/scroll-restoration.ts +22 -14
  85. package/src/browser/segment-reconciler.ts +36 -14
  86. package/src/browser/segment-structure-assert.ts +2 -2
  87. package/src/browser/server-action-bridge.ts +23 -30
  88. package/src/browser/types.ts +21 -0
  89. package/src/build/collect-fallback-refs.ts +107 -0
  90. package/src/build/generate-manifest.ts +60 -35
  91. package/src/build/generate-route-types.ts +2 -0
  92. package/src/build/index.ts +8 -1
  93. package/src/build/prefix-tree-utils.ts +123 -0
  94. package/src/build/route-trie.ts +95 -25
  95. package/src/build/route-types/codegen.ts +4 -4
  96. package/src/build/route-types/include-resolution.ts +1 -1
  97. package/src/build/route-types/per-module-writer.ts +7 -4
  98. package/src/build/route-types/router-processing.ts +55 -14
  99. package/src/build/route-types/scan-filter.ts +1 -1
  100. package/src/build/route-types/source-scan.ts +118 -0
  101. package/src/build/runtime-discovery.ts +9 -20
  102. package/src/cache/cache-scope.ts +28 -42
  103. package/src/cache/cf/cf-cache-store.ts +54 -13
  104. package/src/client.rsc.tsx +3 -0
  105. package/src/client.tsx +96 -205
  106. package/src/context-var.ts +5 -5
  107. package/src/decode-loader-results.ts +36 -0
  108. package/src/errors.ts +30 -4
  109. package/src/handle.ts +32 -14
  110. package/src/host/index.ts +2 -2
  111. package/src/host/router.ts +129 -57
  112. package/src/host/types.ts +31 -2
  113. package/src/host/utils.ts +1 -1
  114. package/src/href-client.ts +140 -21
  115. package/src/index.rsc.ts +10 -6
  116. package/src/index.ts +54 -17
  117. package/src/loader-store.ts +500 -0
  118. package/src/loader.rsc.ts +25 -7
  119. package/src/loader.ts +16 -9
  120. package/src/missing-id-error.ts +68 -0
  121. package/src/outlet-context.ts +1 -1
  122. package/src/prerender.ts +27 -6
  123. package/src/response-utils.ts +37 -0
  124. package/src/reverse.ts +65 -36
  125. package/src/route-content-wrapper.tsx +6 -28
  126. package/src/route-definition/dsl-helpers.ts +384 -257
  127. package/src/route-definition/helper-factories.ts +29 -139
  128. package/src/route-definition/helpers-types.ts +100 -28
  129. package/src/route-definition/resolve-handler-use.ts +6 -0
  130. package/src/route-definition/use-item-types.ts +32 -0
  131. package/src/route-types.ts +26 -41
  132. package/src/router/basename.ts +14 -0
  133. package/src/router/content-negotiation.ts +15 -2
  134. package/src/router/error-handling.ts +1 -1
  135. package/src/router/find-match.ts +54 -6
  136. package/src/router/handler-context.ts +21 -38
  137. package/src/router/intercept-resolution.ts +4 -18
  138. package/src/router/lazy-includes.ts +41 -22
  139. package/src/router/loader-resolution.ts +82 -36
  140. package/src/router/manifest.ts +41 -19
  141. package/src/router/match-api.ts +4 -3
  142. package/src/router/match-handlers.ts +63 -20
  143. package/src/router/match-middleware/cache-lookup.ts +44 -91
  144. package/src/router/match-middleware/cache-store.ts +3 -2
  145. package/src/router/match-result.ts +53 -32
  146. package/src/router/metrics.ts +1 -1
  147. package/src/router/middleware-types.ts +15 -26
  148. package/src/router/middleware.ts +99 -84
  149. package/src/router/pattern-matching.ts +116 -19
  150. package/src/router/prerender-match.ts +1 -1
  151. package/src/router/preview-match.ts +3 -1
  152. package/src/router/request-classification.ts +4 -28
  153. package/src/router/revalidation.ts +58 -2
  154. package/src/router/router-interfaces.ts +45 -28
  155. package/src/router/router-options.ts +40 -1
  156. package/src/router/router-registry.ts +2 -5
  157. package/src/router/segment-resolution/fresh.ts +27 -6
  158. package/src/router/segment-resolution/revalidation.ts +147 -106
  159. package/src/router/segment-resolution/view-transition-default.ts +36 -0
  160. package/src/router/substitute-pattern-params.ts +56 -0
  161. package/src/router/telemetry.ts +99 -0
  162. package/src/router/trie-matching.ts +40 -16
  163. package/src/router/types.ts +8 -0
  164. package/src/router/url-params.ts +49 -0
  165. package/src/router.ts +52 -30
  166. package/src/rsc/handler-context.ts +2 -2
  167. package/src/rsc/handler.ts +28 -69
  168. package/src/rsc/helpers.ts +91 -43
  169. package/src/rsc/index.ts +1 -1
  170. package/src/rsc/manifest-init.ts +28 -41
  171. package/src/rsc/origin-guard.ts +28 -10
  172. package/src/rsc/progressive-enhancement.ts +4 -0
  173. package/src/rsc/response-error.ts +79 -12
  174. package/src/rsc/response-route-handler.ts +57 -61
  175. package/src/rsc/rsc-rendering.ts +35 -51
  176. package/src/rsc/runtime-warnings.ts +9 -10
  177. package/src/rsc/server-action.ts +17 -37
  178. package/src/rsc/ssr-setup.ts +16 -0
  179. package/src/rsc/types.ts +8 -2
  180. package/src/runtime-env.ts +18 -0
  181. package/src/search-params.ts +4 -4
  182. package/src/segment-content-promise.ts +67 -0
  183. package/src/segment-loader-promise.ts +122 -0
  184. package/src/segment-system.tsx +132 -116
  185. package/src/serialize.ts +243 -0
  186. package/src/server/context.ts +175 -53
  187. package/src/server/cookie-store.ts +28 -4
  188. package/src/server/request-context.ts +67 -51
  189. package/src/ssr/index.tsx +5 -1
  190. package/src/static-handler.ts +25 -3
  191. package/src/testing/cache-status.ts +166 -0
  192. package/src/testing/collect-handle.ts +63 -0
  193. package/src/testing/dispatch.ts +581 -0
  194. package/src/testing/dom.entry.ts +22 -0
  195. package/src/testing/e2e/fixture.ts +188 -0
  196. package/src/testing/e2e/index.ts +149 -0
  197. package/src/testing/e2e/matchers.ts +51 -0
  198. package/src/testing/e2e/page-helpers.ts +272 -0
  199. package/src/testing/e2e/parity.ts +326 -0
  200. package/src/testing/e2e/server.ts +195 -0
  201. package/src/testing/flight-matchers.ts +110 -0
  202. package/src/testing/flight-normalize.ts +38 -0
  203. package/src/testing/flight-runtime.d.ts +57 -0
  204. package/src/testing/flight-tree.ts +682 -0
  205. package/src/testing/flight.entry.ts +51 -0
  206. package/src/testing/flight.ts +234 -0
  207. package/src/testing/generated-routes.ts +223 -0
  208. package/src/testing/index.ts +106 -0
  209. package/src/testing/internal/context.ts +304 -0
  210. package/src/testing/internal/flight-client-globals.ts +30 -0
  211. package/src/testing/internal/seed-vars.ts +42 -0
  212. package/src/testing/render-handler.ts +323 -0
  213. package/src/testing/render-route.tsx +590 -0
  214. package/src/testing/run-loader.ts +363 -0
  215. package/src/testing/run-middleware.ts +205 -0
  216. package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
  217. package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
  218. package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
  219. package/src/testing/vitest-stubs/version.ts +5 -0
  220. package/src/testing/vitest.ts +285 -0
  221. package/src/types/global-namespace.ts +39 -26
  222. package/src/types/handler-context.ts +68 -50
  223. package/src/types/index.ts +1 -0
  224. package/src/types/loader-types.ts +11 -9
  225. package/src/types/request-scope.ts +126 -0
  226. package/src/types/route-entry.ts +11 -0
  227. package/src/types/segments.ts +35 -2
  228. package/src/urls/include-helper.ts +34 -67
  229. package/src/urls/index.ts +1 -5
  230. package/src/urls/path-helper-types.ts +41 -7
  231. package/src/urls/path-helper.ts +17 -52
  232. package/src/urls/pattern-types.ts +36 -19
  233. package/src/urls/response-types.ts +22 -29
  234. package/src/urls/type-extraction.ts +58 -139
  235. package/src/urls/urls-function.ts +1 -5
  236. package/src/use-loader.tsx +413 -42
  237. package/src/vite/debug.ts +185 -0
  238. package/src/vite/discovery/bundle-postprocess.ts +6 -6
  239. package/src/vite/discovery/discover-routers.ts +106 -75
  240. package/src/vite/discovery/discovery-errors.ts +194 -0
  241. package/src/vite/discovery/gate-state.ts +171 -0
  242. package/src/vite/discovery/prerender-collection.ts +67 -26
  243. package/src/vite/discovery/route-types-writer.ts +40 -84
  244. package/src/vite/discovery/self-gen-tracking.ts +27 -1
  245. package/src/vite/discovery/state.ts +33 -0
  246. package/src/vite/discovery/virtual-module-codegen.ts +13 -23
  247. package/src/vite/index.ts +2 -0
  248. package/src/vite/plugin-types.ts +67 -0
  249. package/src/vite/plugins/cjs-to-esm.ts +8 -7
  250. package/src/vite/plugins/client-ref-dedup.ts +16 -0
  251. package/src/vite/plugins/client-ref-hashing.ts +28 -5
  252. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  253. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  254. package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
  255. package/src/vite/plugins/expose-action-id.ts +54 -30
  256. package/src/vite/plugins/expose-id-utils.ts +12 -8
  257. package/src/vite/plugins/expose-ids/export-analysis.ts +100 -20
  258. package/src/vite/plugins/expose-ids/handler-transform.ts +8 -61
  259. package/src/vite/plugins/expose-ids/loader-transform.ts +3 -5
  260. package/src/vite/plugins/expose-ids/router-transform.ts +20 -3
  261. package/src/vite/plugins/expose-internal-ids.ts +496 -486
  262. package/src/vite/plugins/performance-tracks.ts +29 -25
  263. package/src/vite/plugins/use-cache-transform.ts +65 -50
  264. package/src/vite/plugins/version-injector.ts +39 -23
  265. package/src/vite/plugins/version-plugin.ts +59 -2
  266. package/src/vite/plugins/virtual-entries.ts +2 -2
  267. package/src/vite/rango.ts +116 -29
  268. package/src/vite/router-discovery.ts +750 -100
  269. package/src/vite/utils/ast-handler-extract.ts +15 -15
  270. package/src/vite/utils/banner.ts +1 -1
  271. package/src/vite/utils/bundle-analysis.ts +4 -2
  272. package/src/vite/utils/client-chunks.ts +190 -0
  273. package/src/vite/utils/forward-user-plugins.ts +193 -0
  274. package/src/vite/utils/manifest-utils.ts +8 -59
  275. package/src/vite/utils/package-resolution.ts +41 -1
  276. package/src/vite/utils/prerender-utils.ts +21 -6
  277. package/src/vite/utils/shared-utils.ts +107 -26
  278. package/src/browser/action-response-classifier.ts +0 -99
package/src/index.ts CHANGED
@@ -18,6 +18,7 @@ export {
18
18
  MiddlewareError,
19
19
  HandlerError,
20
20
  BuildError,
21
+ DslContextError,
21
22
  InvalidHandlerError,
22
23
  RouterError,
23
24
  Skip,
@@ -43,6 +44,7 @@ export type {
43
44
  // Revalidation types
44
45
  RevalidateParams,
45
46
  Revalidate,
47
+ ActionRef,
46
48
  RouteKeys,
47
49
  // Loader types
48
50
  LoaderDefinition,
@@ -102,8 +104,7 @@ export type {
102
104
  JsonResponsePathFn,
103
105
  TextResponsePathFn,
104
106
  RouteResponse,
105
- ResponseError,
106
- ResponseEnvelope,
107
+ ProblemDetails,
107
108
  } from "./urls.js";
108
109
 
109
110
  // Middleware context types
@@ -147,24 +148,52 @@ export { createVar, type ContextVar } from "./context-var.js";
147
148
  export { nonce } from "./rsc/nonce.js";
148
149
 
149
150
  /**
150
- * Error-throwing stub for server-only `Prerender` function.
151
+ * SSR/client stub for server-only `Prerender` function.
152
+ *
153
+ * Returns a lightweight stub object instead of throwing so that the
154
+ * production SSR build can safely bundle the RSC entry chunk — the SSR
155
+ * bundler resolves `@rangojs/router` to this (SSR) entry, so Prerender
156
+ * calls in RSC code must not crash at module-evaluation time.
151
157
  */
152
- export function Prerender(): never {
153
- throw serverOnlyStubError("Prerender");
158
+ export function Prerender(
159
+ _handler?: any,
160
+ _optionsOrId?: any,
161
+ __injectedId?: string,
162
+ ): any {
163
+ const id =
164
+ typeof _optionsOrId === "string" ? _optionsOrId : __injectedId || "";
165
+ return { __brand: "prerenderHandler" as const, $$id: id };
154
166
  }
155
167
 
156
168
  /**
157
- * Error-throwing stub for server-only `Passthrough` function.
169
+ * SSR/client stub for server-only `Passthrough` function.
158
170
  */
159
- export function Passthrough(): never {
160
- throw serverOnlyStubError("Passthrough");
171
+ export function Passthrough(
172
+ _handler?: any,
173
+ _optionsOrId?: any,
174
+ __injectedId?: string,
175
+ ): any {
176
+ const id =
177
+ typeof _optionsOrId === "string" ? _optionsOrId : __injectedId || "";
178
+ return { __brand: "passthroughHandler" as const, $$id: id };
161
179
  }
162
180
 
163
181
  /**
164
- * Error-throwing stub for server-only `Static` function.
182
+ * SSR/client stub for server-only `Static` function.
183
+ *
184
+ * Returns a lightweight stub object instead of throwing so that the
185
+ * production SSR build can safely bundle the RSC entry chunk — the SSR
186
+ * bundler resolves `@rangojs/router` to this (SSR) entry, so Static
187
+ * calls in RSC code must not crash at module-evaluation time.
165
188
  */
166
- export function Static(): never {
167
- throw serverOnlyStubError("Static");
189
+ export function Static(
190
+ _handler?: any,
191
+ _optionsOrId?: any,
192
+ __injectedId?: string,
193
+ ): any {
194
+ const id =
195
+ typeof _optionsOrId === "string" ? _optionsOrId : __injectedId || "";
196
+ return { __brand: "staticHandler" as const, $$id: id };
168
197
  }
169
198
 
170
199
  /**
@@ -236,6 +265,9 @@ export function transition(): never {
236
265
  // Request context type (safe for client)
237
266
  export type { PublicRequestContext as RequestContext } from "./server/request-context.js";
238
267
 
268
+ // Shared base for every user-facing request context.
269
+ export type { RequestScope, ExecutionContext } from "./types/request-scope.js";
270
+
239
271
  // Cookie store types (safe for client)
240
272
  export type {
241
273
  CookieStore,
@@ -271,12 +303,17 @@ export {
271
303
  type LocationStateOptions,
272
304
  } from "./browser/react/location-state-shared.js";
273
305
 
274
- // Path-based response type lookup from RegisteredRoutes
275
- export type { PathResponse } from "./href-client.js";
276
-
277
- // Telemetry sink
278
- export { createConsoleSink } from "./router/telemetry.js";
279
- export { createOTelSink } from "./router/telemetry-otel.js";
306
+ // Path and response types are ambient on the `Rango` namespace (`Rango.Path`,
307
+ // `Rango.PathResponse`, declared in href-client.ts) — no import needed.
308
+
309
+ // Telemetry types only — the createConsoleSink/createOTelSink values are
310
+ // server-only and live in index.rsc.ts (the `react-server` condition of the
311
+ // bare `@rangojs/router` import). Re-exporting them as values from this
312
+ // (default/client) entry would pull telemetry.ts and telemetry-otel.ts into
313
+ // the client module graph; both tree-shake to zero bytes but still appear in
314
+ // bundle analysis output and slow build-time module resolution. Consumers
315
+ // who need the values in non-RSC contexts can import from
316
+ // `@rangojs/router/server`.
280
317
  export type { OTelTracer, OTelSpan } from "./router/telemetry-otel.js";
281
318
  export type { TelemetrySink, TelemetryEvent } from "./router/telemetry.js";
282
319
 
@@ -0,0 +1,500 @@
1
+ /**
2
+ * LoaderStore — shared subscription model for `useLoader` / `useFetchLoader`.
3
+ *
4
+ * Each bucket key gets one entry that holds the latest committed snapshot plus a
5
+ * set of listeners. Snapshots are frozen and replaced atomically on mutation, so
6
+ * subscribers can compare snapshot identity and avoid unnecessary updates
7
+ * between real changes.
8
+ *
9
+ * The bucket key is `loader.$$id` by default, or `loader.$$id + key` when the
10
+ * hook is given an explicit client refresh `key`. Multiple buckets belonging to
11
+ * the same loader form a family (indexed by `loader.$$id`) so a navigation /
12
+ * route-context reset can clear them all at once via `clearFamily`.
13
+ *
14
+ * Mutations that come in for an old request id (e.g. a slow response that
15
+ * resolves after a newer load() was issued, or after a navigation cleared the
16
+ * entry) are silently dropped. `reserveRequestId` is the only way to claim the
17
+ * "latest" slot; `clear` bumps it too so pre-navigation in-flight loads cannot
18
+ * commit into the new route's context.
19
+ *
20
+ * Bucket lifecycle differs by registration:
21
+ * - Sticky buckets (a route-registered reader subscribed at least once) keep
22
+ * their entry after the last subscriber leaves so an in-flight load() can
23
+ * still commit on remount; they reset on navigation via `clearFamily`.
24
+ * - Ephemeral buckets (only ever subscribed by readers with no route context,
25
+ * i.e. keyed `useFetchLoader` of an unregistered loader) have no
26
+ * route-context reset trigger, so they are reference-counted: dropped once
27
+ * the last subscriber unsubscribes. The drop is deferred to a microtask and
28
+ * cancelled on resubscribe so a StrictMode / transition remount does not
29
+ * reclaim a bucket that is about to be reused, and is held until any
30
+ * in-flight load settles.
31
+ *
32
+ * The store is intentionally module-level: each browser tab is its own JS
33
+ * realm, so there is no cross-request pollution. Server renders never mutate
34
+ * the store — the hook falls back to `OutletContext.loaderData`.
35
+ */
36
+
37
+ export interface LoaderEntry<T = unknown> {
38
+ readonly value: T | undefined;
39
+ /**
40
+ * Whether a load has committed a value to this bucket. Distinguishes a
41
+ * committed `null`/`undefined` result from "never loaded", so a loader that
42
+ * resolves to a falsy value is not mistaken for an empty bucket and is not
43
+ * overridden by the server-seeded context value.
44
+ */
45
+ readonly hasValue: boolean;
46
+ readonly error: Error | null;
47
+ readonly isLoading: boolean;
48
+ /** Identifies the request that produced this snapshot. 0 means "no request". */
49
+ readonly requestId: number;
50
+ }
51
+
52
+ const EMPTY_SNAPSHOT: LoaderEntry = Object.freeze({
53
+ value: undefined,
54
+ hasValue: false,
55
+ error: null,
56
+ isLoading: false,
57
+ requestId: 0,
58
+ });
59
+
60
+ /**
61
+ * Options for `subscribe`.
62
+ */
63
+ export interface SubscribeOptions {
64
+ /**
65
+ * Family id (`loader.$$id`) this bucket belongs to. `clearFamily` uses it to
66
+ * reach every keyed bucket of the same loader. Defaults to the bucket key.
67
+ */
68
+ loaderId?: string;
69
+ /**
70
+ * When true, this subscription is from a reader with no route context (keyed
71
+ * `useFetchLoader` of an unregistered loader). Such buckets have no
72
+ * route-context reset trigger and are reference-counted instead. A bucket
73
+ * becomes sticky for the rest of its life as soon as any non-ephemeral
74
+ * subscriber attaches, and from then on resets via `clearFamily`.
75
+ */
76
+ ephemeral?: boolean;
77
+ /**
78
+ * Cross-loader refresh group name(s). Tags this bucket so `refreshGroups(name)`
79
+ * can refresh it alongside buckets of other loaders. A bucket may be tagged
80
+ * with several group names at once (pass an array); it is then refreshed when
81
+ * ANY of its groups is refreshed. Group membership follows subscriber presence:
82
+ * a bucket leaves a group when that group's last subscriber unsubscribes.
83
+ */
84
+ group?: string | string[];
85
+ /**
86
+ * Plain-GET refresh thunk used by `refreshGroups`. Provided alongside `group`.
87
+ * Refreshes this bucket in place (no params/body) and rejects on failure.
88
+ */
89
+ refetch?: () => Promise<void>;
90
+ }
91
+
92
+ interface InternalEntry {
93
+ snapshot: LoaderEntry;
94
+ listeners: Set<() => void>;
95
+ /** Monotonically increasing. Bumped by reserveRequestId() and clear(). */
96
+ latestRequestId: number;
97
+ /** Family id (loader.$$id) this bucket belongs to. */
98
+ loaderId: string;
99
+ /**
100
+ * True once any non-ephemeral subscriber has attached. Sticky buckets are
101
+ * never reference-count-dropped; they reset via clearFamily().
102
+ */
103
+ sticky: boolean;
104
+ /** A deferred refcount-drop microtask is scheduled and not yet cancelled. */
105
+ pendingClear: boolean;
106
+ /**
107
+ * The last subscriber left while a load() was in flight. Drop the bucket once
108
+ * that request settles, if it is still subscriberless.
109
+ */
110
+ clearWhenSettled: boolean;
111
+ /**
112
+ * Cross-loader refresh groups this bucket belongs to, mapped to the number of
113
+ * current subscribers that requested each group. A bucket can be in several
114
+ * groups at once (one read tagged with multiple names, or different subscribers
115
+ * tagging the same shared bucket with different names); refcounting keeps
116
+ * membership independent of subscribe/unsubscribe order.
117
+ */
118
+ groups: Map<string, number>;
119
+ /** Plain-GET refresh thunk for `refreshGroups`, set while in any group. */
120
+ refetch: (() => Promise<void>) | undefined;
121
+ }
122
+
123
+ /**
124
+ * Normalize a group tag option (`undefined | string | string[]`) to a deduped
125
+ * list of names. Deduping keeps a single subscriber from being counted more than
126
+ * once in one group when the caller passes a repeated name.
127
+ */
128
+ function normalizeGroups(group: string | string[] | undefined): string[] {
129
+ if (group === undefined) return [];
130
+ if (typeof group === "string") return [group];
131
+ return [...new Set(group)];
132
+ }
133
+
134
+ export class LoaderStore {
135
+ private readonly entries = new Map<string, InternalEntry>();
136
+ /** loader.$$id -> set of bucket keys, so clearFamily() can reach every bucket. */
137
+ private readonly families = new Map<string, Set<string>>();
138
+ /** refresh group name -> set of bucket keys, for refreshGroups(). */
139
+ private readonly groups = new Map<string, Set<string>>();
140
+
141
+ private getOrCreate(bucketKey: string): InternalEntry {
142
+ let e = this.entries.get(bucketKey);
143
+ if (!e) {
144
+ e = {
145
+ snapshot: EMPTY_SNAPSHOT,
146
+ listeners: new Set(),
147
+ latestRequestId: 0,
148
+ loaderId: bucketKey,
149
+ sticky: false,
150
+ pendingClear: false,
151
+ clearWhenSettled: false,
152
+ groups: new Map(),
153
+ refetch: undefined,
154
+ };
155
+ this.entries.set(bucketKey, e);
156
+ }
157
+ return e;
158
+ }
159
+
160
+ private registerFamily(loaderId: string, bucketKey: string): void {
161
+ let fam = this.families.get(loaderId);
162
+ if (!fam) {
163
+ fam = new Set();
164
+ this.families.set(loaderId, fam);
165
+ }
166
+ fam.add(bucketKey);
167
+ }
168
+
169
+ /**
170
+ * Subscribe to entry changes for `bucketKey`.
171
+ * Returns an unsubscribe function. A sticky bucket's entry is kept around even
172
+ * after the last subscriber leaves so that an in-flight `load()` can still
173
+ * commit if the consumer remounts. An ephemeral bucket is dropped once its
174
+ * last subscriber leaves (deferred, see maybeScheduleRefcountClear).
175
+ */
176
+ subscribe(
177
+ bucketKey: string,
178
+ cb: () => void,
179
+ options?: SubscribeOptions,
180
+ ): () => void {
181
+ const e = this.getOrCreate(bucketKey);
182
+ const loaderId = options?.loaderId ?? bucketKey;
183
+ e.loaderId = loaderId;
184
+ this.registerFamily(loaderId, bucketKey);
185
+ if (options?.ephemeral !== true) e.sticky = true;
186
+ // Normalize the group tag(s) to a deduped list so one subscriber is counted
187
+ // once per distinct group, and subscribe/unsubscribe stay symmetric (the
188
+ // same list drives both addToGroup and releaseGroup).
189
+ const groups = normalizeGroups(options?.group);
190
+ for (const group of groups) {
191
+ this.addToGroup(group, bucketKey, e, options?.refetch);
192
+ }
193
+ // A fresh subscriber means the bucket is wanted again: cancel any pending
194
+ // refcount-drop and the settle-then-drop intent.
195
+ e.pendingClear = false;
196
+ e.clearWhenSettled = false;
197
+ e.listeners.add(cb);
198
+ return () => {
199
+ e.listeners.delete(cb);
200
+ // Group membership is refcounted per subscriber so refreshGroups() never
201
+ // fetches for an unmounted reader, and a bucket shared by subscribers in
202
+ // different groups stays in each group until ALL of that group's
203
+ // subscribers have left (order-independent).
204
+ for (const group of groups) this.releaseGroup(group, bucketKey, e);
205
+ this.maybeScheduleRefcountClear(bucketKey, e);
206
+ };
207
+ }
208
+
209
+ private addToGroup(
210
+ group: string,
211
+ bucketKey: string,
212
+ e: InternalEntry,
213
+ refetch: (() => Promise<void>) | undefined,
214
+ ): void {
215
+ e.groups.set(group, (e.groups.get(group) ?? 0) + 1);
216
+ // One thunk per bucket — every subscriber of a bucket provides an
217
+ // equivalent plain-GET refresh, so keeping the latest is fine.
218
+ if (refetch) e.refetch = refetch;
219
+ let members = this.groups.get(group);
220
+ if (!members) {
221
+ members = new Set();
222
+ this.groups.set(group, members);
223
+ }
224
+ members.add(bucketKey);
225
+ }
226
+
227
+ private releaseGroup(
228
+ group: string,
229
+ bucketKey: string,
230
+ e: InternalEntry,
231
+ ): void {
232
+ const next = (e.groups.get(group) ?? 0) - 1;
233
+ if (next > 0) {
234
+ e.groups.set(group, next);
235
+ return;
236
+ }
237
+ e.groups.delete(group);
238
+ const members = this.groups.get(group);
239
+ if (members) {
240
+ members.delete(bucketKey);
241
+ if (members.size === 0) this.groups.delete(group);
242
+ }
243
+ }
244
+
245
+ /** Remove a bucket from every group it belongs to (used when it is dropped). */
246
+ private removeFromAllGroups(bucketKey: string, e: InternalEntry): void {
247
+ for (const group of e.groups.keys()) {
248
+ const members = this.groups.get(group);
249
+ if (members) {
250
+ members.delete(bucketKey);
251
+ if (members.size === 0) this.groups.delete(group);
252
+ }
253
+ }
254
+ e.groups.clear();
255
+ }
256
+
257
+ /**
258
+ * Refresh every currently-mounted bucket tagged with ANY of the given group
259
+ * names, with a plain GET (no params/body). Accepts a single name or an array
260
+ * of names. A bucket that belongs to more than one of the named groups is
261
+ * refreshed exactly once (members are unioned and deduped by bucket key), as
262
+ * are multiple reads of one bucket. Resolves when all refreshes settle; rejects
263
+ * with an `AggregateError` of the failures if any member fails — each failing
264
+ * member also records its error on its own snapshot.
265
+ */
266
+ async refreshGroups(groups: string | string[]): Promise<void> {
267
+ const names = typeof groups === "string" ? [groups] : groups;
268
+ // Union the member buckets across every named group, deduped by key, so a
269
+ // bucket tagged into two of the requested groups is fetched a single time.
270
+ const buckets = new Set<string>();
271
+ for (const name of names) {
272
+ const members = this.groups.get(name);
273
+ if (!members) continue;
274
+ for (const bucketKey of members) buckets.add(bucketKey);
275
+ }
276
+ if (buckets.size === 0) return;
277
+ const thunks: Array<() => Promise<void>> = [];
278
+ for (const bucketKey of buckets) {
279
+ const e = this.entries.get(bucketKey);
280
+ if (!e || e.listeners.size === 0 || !e.refetch) continue;
281
+ thunks.push(e.refetch);
282
+ }
283
+ if (thunks.length === 0) return;
284
+ const results = await Promise.allSettled(thunks.map((t) => t()));
285
+ const reasons = results
286
+ .filter((r): r is PromiseRejectedResult => r.status === "rejected")
287
+ .map((r) => r.reason);
288
+ if (reasons.length > 0) {
289
+ const label = names.map((n) => `"${n}"`).join(", ");
290
+ throw new AggregateError(
291
+ reasons,
292
+ `refreshGroups(${label}) had ${reasons.length} failure(s)`,
293
+ );
294
+ }
295
+ }
296
+
297
+ /**
298
+ * Schedule a deferred drop for an ad-hoc (never-sticky) bucket whose last
299
+ * subscriber just left. Deferred to a microtask so a StrictMode / transition
300
+ * remount that resubscribes in the same tick cancels it.
301
+ */
302
+ private maybeScheduleRefcountClear(
303
+ bucketKey: string,
304
+ e: InternalEntry,
305
+ ): void {
306
+ if (e.listeners.size > 0) return;
307
+ // Sticky buckets persist for remount; they reset via clearFamily().
308
+ if (e.sticky) return;
309
+ if (e.pendingClear) return;
310
+ e.pendingClear = true;
311
+ queueMicrotask(() => {
312
+ if (!e.pendingClear) return; // cancelled by a resubscribe
313
+ e.pendingClear = false;
314
+ if (e.listeners.size > 0) return; // resubscribed before the microtask ran
315
+ if (e.snapshot.isLoading) {
316
+ // Don't drop mid-flight; let the request commit, then drop.
317
+ e.clearWhenSettled = true;
318
+ return;
319
+ }
320
+ this.dropBucket(bucketKey);
321
+ });
322
+ }
323
+
324
+ /** Remove a bucket entry entirely and prune it from its family/group indexes. */
325
+ private dropBucket(bucketKey: string): void {
326
+ const e = this.entries.get(bucketKey);
327
+ if (!e) return;
328
+ this.removeFromAllGroups(bucketKey, e);
329
+ this.entries.delete(bucketKey);
330
+ const fam = this.families.get(e.loaderId);
331
+ if (fam) {
332
+ fam.delete(bucketKey);
333
+ if (fam.size === 0) this.families.delete(e.loaderId);
334
+ }
335
+ }
336
+
337
+ /** Drop an ephemeral bucket that settled with no subscribers left. */
338
+ private dropIfSettled(bucketKey: string, e: InternalEntry): void {
339
+ if (e.clearWhenSettled && e.listeners.size === 0) {
340
+ e.clearWhenSettled = false;
341
+ this.dropBucket(bucketKey);
342
+ }
343
+ }
344
+
345
+ /**
346
+ * Returns the current snapshot for `bucketKey`. Stable reference between
347
+ * mutations — subscribers rely on this to avoid spurious re-renders.
348
+ * Returns `EMPTY_SNAPSHOT` (a singleton) when the entry has never been
349
+ * mutated or has been cleared.
350
+ */
351
+ getSnapshot(bucketKey: string): LoaderEntry {
352
+ return this.entries.get(bucketKey)?.snapshot ?? EMPTY_SNAPSHOT;
353
+ }
354
+
355
+ /**
356
+ * Reserve a fresh request id for an upcoming `load()` call. The returned id
357
+ * is the new "latest"; any older in-flight requests will fail their gating
358
+ * check on `finishData` / `finishError` / `finishLoading` and be dropped.
359
+ *
360
+ * Callers should follow with `beginRequest(id, requestId)` to flip the
361
+ * loading flag on AND clear any leftover error from a previous attempt
362
+ * — the latter matters for `throwOnError: false` consumers, which would
363
+ * otherwise keep showing the stale error throughout the retry.
364
+ */
365
+ reserveRequestId(bucketKey: string): number {
366
+ const e = this.getOrCreate(bucketKey);
367
+ e.latestRequestId++;
368
+ return e.latestRequestId;
369
+ }
370
+
371
+ /**
372
+ * Mark the request as in-flight: `isLoading = true`, `error = null`.
373
+ * Combines the two operations so a retry doesn't render the previous
374
+ * error during the new request. Gated on `requestId === latestRequestId`
375
+ * for symmetry with the other mutators.
376
+ */
377
+ beginRequest(bucketKey: string, requestId: number): void {
378
+ const e = this.entries.get(bucketKey);
379
+ if (!e || requestId !== e.latestRequestId) return;
380
+ if (e.snapshot.isLoading && e.snapshot.error === null) return;
381
+ e.snapshot = Object.freeze({
382
+ value: e.snapshot.value,
383
+ hasValue: e.snapshot.hasValue,
384
+ error: null,
385
+ isLoading: true,
386
+ requestId,
387
+ });
388
+ this.notify(e);
389
+ }
390
+
391
+ /**
392
+ * Commit a successful result. No-op if `requestId` is not the latest
393
+ * (a newer `load()` was issued or `clear()` ran). Clearing `error` is
394
+ * intentional: a successful refetch should hide the previous failure.
395
+ */
396
+ finishData<T>(bucketKey: string, requestId: number, value: T): void {
397
+ const e = this.entries.get(bucketKey);
398
+ if (!e || requestId !== e.latestRequestId) return;
399
+ e.snapshot = Object.freeze({
400
+ value,
401
+ hasValue: true,
402
+ error: null,
403
+ isLoading: false,
404
+ requestId,
405
+ });
406
+ this.notify(e);
407
+ this.dropIfSettled(bucketKey, e);
408
+ }
409
+
410
+ /**
411
+ * Commit an error. Preserves the last good `value` so consumers can keep
412
+ * showing previous data while displaying the error if they choose. No-op
413
+ * if `requestId` is not the latest.
414
+ */
415
+ finishError(bucketKey: string, requestId: number, error: Error): void {
416
+ const e = this.entries.get(bucketKey);
417
+ if (!e || requestId !== e.latestRequestId) return;
418
+ e.snapshot = Object.freeze({
419
+ value: e.snapshot.value,
420
+ hasValue: e.snapshot.hasValue,
421
+ error,
422
+ isLoading: false,
423
+ requestId,
424
+ });
425
+ this.notify(e);
426
+ this.dropIfSettled(bucketKey, e);
427
+ }
428
+
429
+ /**
430
+ * Update loading flag. Gated on `requestId` to fix the race where an old
431
+ * load() finishes after a new one started — its `setLoading(false)` would
432
+ * otherwise hide the new request's spinner.
433
+ */
434
+ setLoading(bucketKey: string, requestId: number, isLoading: boolean): void {
435
+ const e = this.entries.get(bucketKey);
436
+ if (!e || requestId !== e.latestRequestId) return;
437
+ if (e.snapshot.isLoading === isLoading) return;
438
+ e.snapshot = Object.freeze({
439
+ ...e.snapshot,
440
+ isLoading,
441
+ });
442
+ this.notify(e);
443
+ }
444
+
445
+ /**
446
+ * Reset a single bucket entry. Bumps `latestRequestId` so any in-flight
447
+ * `load()` whose promise is still pending will fail its gate when it resolves
448
+ * and be dropped — prevents pre-navigation loads from clobbering the new
449
+ * route's context. The entry itself is kept (sticky-bucket semantics).
450
+ */
451
+ clear(bucketKey: string): void {
452
+ const e = this.entries.get(bucketKey);
453
+ if (!e) return;
454
+ e.latestRequestId++;
455
+ if (e.snapshot === EMPTY_SNAPSHOT) return;
456
+ e.snapshot = EMPTY_SNAPSHOT;
457
+ this.notify(e);
458
+ }
459
+
460
+ /**
461
+ * Reset every sticky bucket belonging to `loaderId`. Called on navigation /
462
+ * route-context change: all route-registered reads of the loader (keyed or
463
+ * not) drop back to seeding from fresh `loaderData`. Ephemeral buckets are
464
+ * intentionally left alone — they are governed by subscriber refcount, so a
465
+ * persistent keyed reader outside the outlet keeps its value across a
466
+ * navigation rather than blanking out.
467
+ */
468
+ clearFamily(loaderId: string): void {
469
+ const fam = this.families.get(loaderId);
470
+ if (!fam) return;
471
+ for (const bucketKey of fam) {
472
+ const e = this.entries.get(bucketKey);
473
+ if (!e || !e.sticky) continue;
474
+ this.clear(bucketKey);
475
+ }
476
+ }
477
+
478
+ private notify(e: InternalEntry): void {
479
+ for (const cb of e.listeners) cb();
480
+ }
481
+
482
+ /**
483
+ * Test-only escape hatch. Drops every entry. Production code should never
484
+ * call this; the store is process-scoped and lives for the tab's lifetime.
485
+ * @internal
486
+ */
487
+ reset(): void {
488
+ this.entries.clear();
489
+ this.families.clear();
490
+ this.groups.clear();
491
+ }
492
+ }
493
+
494
+ /**
495
+ * Module-level singleton. Each browser tab gets its own; SSR never mutates it.
496
+ * The hook falls through to `OutletContext.loaderData` during the server render.
497
+ */
498
+ export const loaderStore: LoaderStore = new LoaderStore();
499
+
500
+ export const EMPTY_LOADER_SNAPSHOT: LoaderEntry = EMPTY_SNAPSHOT;
package/src/loader.rsc.ts CHANGED
@@ -21,9 +21,15 @@ import {
21
21
  registerFetchableLoader,
22
22
  getFetchableLoader,
23
23
  } from "./server/fetchable-loader-store.js";
24
+ import { missingInjectedIdError } from "./missing-id-error.js";
25
+ import { isUnderTestRunner } from "./runtime-env.js";
24
26
 
25
27
  export { getFetchableLoader };
26
28
 
29
+ // Counter for runtime-fallback loader ids assigned only in a bare unit test
30
+ // (no Vite plugin to inject one). Process-stable; never reached in a real build.
31
+ let runtimeLoaderIdCounter = 0;
32
+
27
33
  // Overload 1: With function only (not fetchable)
28
34
  export function createLoader<T>(
29
35
  fn: LoaderFn<T, Record<string, string | undefined>, any>,
@@ -50,14 +56,26 @@ export function createLoader<T>(
50
56
  ): LoaderDefinition<Awaited<T>, Record<string, string | undefined>> {
51
57
  // The $$id will be set on the returned object by Vite plugin
52
58
  // For fetchable loaders, __injectedId is also passed as a parameter
53
- const loaderId = __injectedId || "";
59
+ let loaderId = __injectedId || "";
54
60
 
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
+ // No build-injected id. Under a test runner: fall back to a synthetic id so the
62
+ // fn registers below and the loader is exercisable via runLoader(loaderHandle)
63
+ // (it recovers the fn from the registry by $$id). Otherwise (dev or a real
64
+ // build) it means an UNSUPPORTED shape (e.g. a namespace import
65
+ // `rango.createLoader(...)`) the plugin skipped fail loud. The rich
66
+ // diagnostic stays behind the NODE_ENV check so production folds it away and
67
+ // ships the small throw. isUnderTestRunner() is runtime-safe. Mirrors createHandle.
68
+ if (!loaderId) {
69
+ if (isUnderTestRunner()) {
70
+ loaderId = `__rango_runtime_loader_${runtimeLoaderIdCounter++}`;
71
+ } else if (process.env.NODE_ENV !== "production") {
72
+ throw missingInjectedIdError("Loader", "createLoader");
73
+ } else {
74
+ throw new Error(
75
+ "[rango] Loader is missing $$id — the build plugin did not inject one. " +
76
+ "Export it as `export const X = createLoader(...)`.",
77
+ );
78
+ }
61
79
  }
62
80
 
63
81
  // If not fetchable, store fn in registry (for SSR ctx.use() resolution)