@rangojs/router 0.32.0 → 0.33.0

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 (180) hide show
  1. package/README.md +3 -2
  2. package/dist/bin/browser-7KIJ5HSV.js +15 -0
  3. package/dist/bin/chunk-3B7CKBRO.js +463 -0
  4. package/dist/bin/chunk-524VACCG.js +71 -0
  5. package/dist/bin/chunk-LD7UBHT4.js +196 -0
  6. package/dist/bin/chunk-TO6CRWLN.js +1429 -0
  7. package/dist/bin/chunk-TTXC2U3G.js +2477 -0
  8. package/dist/bin/client-urls-projection-DQLWPDAT.js +28 -0
  9. package/dist/bin/forward-user-plugins-URBZKJP4.js +62 -0
  10. package/dist/bin/rango.js +42 -10173
  11. package/dist/bin/runtime-EPUDEHO4.js +596 -0
  12. package/dist/bin/runtime-discovery-CZ2QHT4Q.js +352 -0
  13. package/dist/bin/state-ACD2MGKJ.js +16 -0
  14. package/dist/bin/temp-rsc-server-QRR6HD6T.js +3190 -0
  15. package/dist/types/bin/rango.d.ts +1 -0
  16. package/dist/types/browser/action-fence.d.ts +20 -0
  17. package/dist/types/browser/cookie-name.d.ts +51 -10
  18. package/dist/types/browser/invalidate-client-cache.d.ts +8 -6
  19. package/dist/types/browser/navigation-bridge.d.ts +36 -1
  20. package/dist/types/browser/navigation-client.d.ts +19 -0
  21. package/dist/types/browser/navigation-store-handle.d.ts +37 -4
  22. package/dist/types/browser/navigation-store.d.ts +2 -2
  23. package/dist/types/browser/navigation-transaction.d.ts +0 -1
  24. package/dist/types/browser/partial-update.d.ts +13 -0
  25. package/dist/types/browser/prefetch/cache.d.ts +96 -8
  26. package/dist/types/browser/prefetch/fetch.d.ts +26 -2
  27. package/dist/types/browser/prefetch/queue.d.ts +3 -2
  28. package/dist/types/browser/rango-state.d.ts +34 -5
  29. package/dist/types/browser/react/Link.d.ts +15 -6
  30. package/dist/types/browser/types.d.ts +25 -0
  31. package/dist/types/build/generate-route-types.d.ts +1 -1
  32. package/dist/types/build/route-types/include-resolution.d.ts +9 -1
  33. package/dist/types/build/route-types/router-processing.d.ts +3 -1
  34. package/dist/types/cache/cache-key-utils.d.ts +12 -8
  35. package/dist/types/cache/cache-scope.d.ts +4 -2
  36. package/dist/types/cache/cf/cf-cache-types.d.ts +9 -5
  37. package/dist/types/cache/document-cache-policy.d.ts +9 -1
  38. package/dist/types/cache/memory-segment-store.d.ts +3 -2
  39. package/dist/types/cache/segment-codec.d.ts +2 -2
  40. package/dist/types/cache/shell-snapshot.d.ts +1 -1
  41. package/dist/types/cache/types.d.ts +12 -7
  42. package/dist/types/cache/vercel/vercel-cache-store.d.ts +2 -1
  43. package/dist/types/client-urls/types.d.ts +7 -5
  44. package/dist/types/prefetch-markers.d.ts +9 -0
  45. package/dist/types/prefetch-source-scope.d.ts +66 -0
  46. package/dist/types/route-definition/helpers-types.d.ts +8 -5
  47. package/dist/types/router/intercept-resolution.d.ts +25 -11
  48. package/dist/types/router/match-context.d.ts +1 -0
  49. package/dist/types/router/match-handlers.d.ts +1 -1
  50. package/dist/types/router/prefetch-cache-ttl.d.ts +11 -3
  51. package/dist/types/router/router-context.d.ts +1 -1
  52. package/dist/types/router/router-options.d.ts +6 -3
  53. package/dist/types/router/segment-resolution/loader-cache.d.ts +8 -0
  54. package/dist/types/router/segment-resolution/prefetch-deferral.d.ts +23 -7
  55. package/dist/types/router/segment-resolution/revalidation.d.ts +19 -0
  56. package/dist/types/router/source-reads.d.ts +53 -0
  57. package/dist/types/router/types.d.ts +1 -1
  58. package/dist/types/rsc/helpers.d.ts +5 -2
  59. package/dist/types/rsc/prefetch-render-error.d.ts +7 -2
  60. package/dist/types/rsc/request-stages.d.ts +2 -0
  61. package/dist/types/rsc/shell-serve.d.ts +6 -1
  62. package/dist/types/server/context.d.ts +23 -6
  63. package/dist/types/server/cookie-store.d.ts +15 -1
  64. package/dist/types/server/document-location-state.d.ts +5 -2
  65. package/dist/types/server/handle-store.d.ts +2 -0
  66. package/dist/types/server/request-context.d.ts +43 -7
  67. package/dist/types/testing/e2e/server.d.ts +16 -1
  68. package/dist/types/testing/render-route.d.ts +66 -2
  69. package/dist/types/testing/serve-shell-request.d.ts +6 -3
  70. package/dist/types/types/handler-context.d.ts +7 -5
  71. package/dist/types/types/loader-types.d.ts +7 -4
  72. package/dist/types/types/segments.d.ts +15 -4
  73. package/dist/types/urls/path-helper-types.d.ts +7 -5
  74. package/dist/types/vite/temp-rsc-server.d.ts +2 -2
  75. package/dist/vite/index.js +449 -189
  76. package/package.json +2 -2
  77. package/skills/app-structure/SKILL.md +74 -0
  78. package/skills/app-structure/e-commerce.md +10 -9
  79. package/skills/app-structure/large-app.md +15 -2
  80. package/skills/caching/SKILL.md +10 -5
  81. package/skills/client-urls/SKILL.md +18 -11
  82. package/skills/comparison/references/framework-comparison.md +13 -8
  83. package/skills/document-cache/SKILL.md +8 -0
  84. package/skills/hooks/navigation.md +8 -8
  85. package/skills/hooks/state.md +24 -8
  86. package/skills/intercept/SKILL.md +33 -12
  87. package/skills/layout/SKILL.md +11 -0
  88. package/skills/links/SKILL.md +101 -4
  89. package/skills/loader/SKILL.md +49 -22
  90. package/skills/migrate-nextjs/SKILL.md +8 -2
  91. package/skills/migrate-react-router/data-and-actions.md +5 -0
  92. package/skills/ppr/SKILL.md +26 -5
  93. package/skills/prerender/SKILL.md +4 -1
  94. package/skills/route/SKILL.md +6 -6
  95. package/skills/router-setup/SKILL.md +2 -1
  96. package/skills/server-actions/SKILL.md +41 -8
  97. package/skills/testing/client-components.md +29 -13
  98. package/skills/testing/serve-shell-request.md +7 -7
  99. package/skills/testing/server-actions.md +8 -0
  100. package/skills/ux-architecture/SKILL.md +67 -18
  101. package/src/bin/rango.ts +39 -13
  102. package/src/browser/action-fence.ts +72 -0
  103. package/src/browser/cookie-name.ts +82 -14
  104. package/src/browser/invalidate-client-cache.ts +9 -7
  105. package/src/browser/navigation-bridge.ts +164 -32
  106. package/src/browser/navigation-client.ts +95 -20
  107. package/src/browser/navigation-store-handle.ts +67 -5
  108. package/src/browser/navigation-store.ts +86 -17
  109. package/src/browser/navigation-transaction.ts +0 -6
  110. package/src/browser/partial-update.ts +31 -12
  111. package/src/browser/prefetch/cache.ts +188 -11
  112. package/src/browser/prefetch/fetch.ts +211 -51
  113. package/src/browser/prefetch/queue.ts +3 -2
  114. package/src/browser/rango-state.ts +50 -8
  115. package/src/browser/react/Link.tsx +20 -9
  116. package/src/browser/react/use-navigation.ts +1 -1
  117. package/src/browser/rsc-router.tsx +8 -1
  118. package/src/browser/server-action-bridge.ts +3 -3
  119. package/src/browser/types.ts +25 -0
  120. package/src/build/generate-route-types.ts +1 -0
  121. package/src/build/route-types/include-resolution.ts +40 -3
  122. package/src/build/route-types/router-processing.ts +170 -25
  123. package/src/build/route-types/scan-filter.ts +1 -0
  124. package/src/cache/cache-key-utils.ts +12 -8
  125. package/src/cache/cache-runtime.ts +5 -1
  126. package/src/cache/cache-scope.ts +28 -7
  127. package/src/cache/cf/cf-cache-types.ts +9 -5
  128. package/src/cache/document-cache-policy.ts +27 -0
  129. package/src/cache/document-cache.ts +5 -0
  130. package/src/cache/memory-segment-store.ts +3 -2
  131. package/src/cache/segment-codec.ts +2 -2
  132. package/src/cache/shell-snapshot.ts +1 -1
  133. package/src/cache/types.ts +12 -7
  134. package/src/cache/vercel/vercel-cache-store.ts +2 -1
  135. package/src/client-urls/types.ts +7 -5
  136. package/src/prefetch-markers.ts +10 -0
  137. package/src/prefetch-source-scope.ts +137 -0
  138. package/src/route-definition/helpers-types.ts +8 -5
  139. package/src/router/intercept-resolution.ts +94 -50
  140. package/src/router/loader-resolution.ts +8 -6
  141. package/src/router/match-api.ts +33 -29
  142. package/src/router/match-context.ts +5 -0
  143. package/src/router/match-handlers.ts +2 -1
  144. package/src/router/match-middleware/cache-lookup.ts +21 -13
  145. package/src/router/match-result.ts +39 -87
  146. package/src/router/navigation-snapshot.ts +18 -3
  147. package/src/router/prefetch-cache-ttl.ts +15 -3
  148. package/src/router/revalidation.ts +53 -23
  149. package/src/router/router-context.ts +2 -1
  150. package/src/router/router-options.ts +6 -3
  151. package/src/router/segment-resolution/loader-cache.ts +21 -3
  152. package/src/router/segment-resolution/prefetch-deferral.ts +38 -31
  153. package/src/router/segment-resolution/revalidation.ts +40 -12
  154. package/src/router/source-reads.ts +122 -0
  155. package/src/router/types.ts +2 -1
  156. package/src/router.ts +11 -12
  157. package/src/rsc/helpers.ts +8 -3
  158. package/src/rsc/prefetch-render-error.ts +7 -2
  159. package/src/rsc/progressive-enhancement.ts +3 -2
  160. package/src/rsc/request-stages.ts +59 -0
  161. package/src/rsc/rsc-rendering.ts +49 -33
  162. package/src/rsc/server-action.ts +2 -1
  163. package/src/rsc/shell-capture.ts +4 -5
  164. package/src/rsc/shell-serve.ts +12 -1
  165. package/src/segment-system.tsx +1 -1
  166. package/src/server/context.ts +37 -6
  167. package/src/server/cookie-store.ts +22 -1
  168. package/src/server/document-location-state.ts +23 -2
  169. package/src/server/handle-store.ts +2 -0
  170. package/src/server/request-context.ts +113 -28
  171. package/src/testing/dispatch.ts +3 -0
  172. package/src/testing/e2e/fixture.ts +4 -12
  173. package/src/testing/e2e/server.ts +91 -4
  174. package/src/testing/render-route.tsx +269 -4
  175. package/src/testing/serve-shell-request.ts +6 -3
  176. package/src/types/handler-context.ts +7 -5
  177. package/src/types/loader-types.ts +7 -4
  178. package/src/types/segments.ts +15 -4
  179. package/src/urls/path-helper-types.ts +7 -5
  180. package/src/vite/temp-rsc-server.ts +2 -2
@@ -182,10 +182,13 @@ export type LoaderFn<T, TParams = Record<string, string | undefined>, TEnv = Def
182
182
  export type LoaderOptions = {
183
183
  ssr?: boolean;
184
184
  /**
185
- * `prefetch: false` keeps this loader out of prefetches. A `<Link>`
186
- * prefetch (a partial request with `X-Rango-Prefetch`) does not execute it;
187
- * the payload marks it deferred. A document request and a navigation with
188
- * no prefetch to adopt run it as usual.
185
+ * `prefetch: false` keeps this loader out of speculative prefetches. A
186
+ * viewport or render `<Link>` prefetch (a partial request with
187
+ * `X-Rango-Prefetch: 1`) does not execute it; the payload marks it
188
+ * deferred. A hover prefetch and `useRouter().prefetch()`
189
+ * (`X-Rango-Prefetch: intent`) count as intent to click and run it, so a
190
+ * click after a hover needs no follow-up request. A document request and a
191
+ * navigation with no prefetch to adopt run it as usual.
189
192
  *
190
193
  * A deferred loader never blocks the navigation that adopts the prefetch:
191
194
  * it behaves like a loader that is still streaming. Its own `<Suspense>`
@@ -147,7 +147,6 @@ export interface ResolvedSegment {
147
147
  layoutName?: string;
148
148
  parallelName?: string;
149
149
  loaderId?: string;
150
- _inherited?: boolean;
151
150
  loaderData?: any;
152
151
  /**
153
152
  * True when this loader was awaited before first flush
@@ -276,10 +275,22 @@ export interface MatchResult {
276
275
  interceptTargeted?: true;
277
276
  /**
278
277
  * Set on a partial match when a revalidate() predicate read the source page
279
- * and kept a held segment: the diff is that source's. The RSC handler
280
- * scopes its prefetch entry to it, like `interceptTargeted` (#1331).
278
+ * and kept a held segment: the diff is right for the pages with equal values
279
+ * of what it read. The RSC handler scopes its prefetch entry to that group,
280
+ * or to the source page when the predicate read `currentUrl` (#1331).
281
281
  */
282
- sourceHeld?: true;
282
+ sourceHeld?: import("../router/source-reads.js").SourceHeld;
283
+ /**
284
+ * Set on a partial match whose answer has nothing live in it: the cache
285
+ * lookup served it (a cache() record, a Prerender entry, a shell replay's
286
+ * record, not a stale cache() record or stale overlay entry), it sends a
287
+ * segment, every segment it
288
+ * sends is one that lookup decoded, and no loader ran. A stored segment
289
+ * cannot fail after the headers left, since every writer refuses a failed
290
+ * render; a live segment or a loader can. The RSC handler marks the request
291
+ * `_servedFromStorage` from it.
292
+ */
293
+ fromStorage?: true;
283
294
  /**
284
295
  * Redirect URL for trailing slash normalization.
285
296
  * When set, the RSC handler should return a 308 redirect to this URL
@@ -161,9 +161,10 @@ export type PathHelpers<TEnv> = {
161
161
  * freezes into the shell (nested promises stay live holes) — the pre-flush
162
162
  * promise applied to the prelude.
163
163
  *
164
- * Pass `{ prefetch: false }` to keep the loader out of prefetches: a
165
- * prefetch skips it and the click that adopts the prefetch fetches it in
166
- * one follow-up request (see {@link LoaderOptions}). Only on a segment the
164
+ * Pass `{ prefetch: false }` to keep the loader out of speculative
165
+ * prefetches (viewport, render): such a prefetch skips it and the click
166
+ * that adopts it fetches it in one follow-up request; a hover prefetch runs
167
+ * it (see {@link LoaderOptions}). Only on a segment the
167
168
  * client does not have yet: a loader the client already holds runs in the
168
169
  * prefetch when it revalidates.
169
170
  */
@@ -172,8 +173,9 @@ export type PathHelpers<TEnv> = {
172
173
  * Attach a loading component to the current route/layout.
173
174
  *
174
175
  * `{ ssr: false }` skips the fallback on document requests. `{ prefetch:
175
- * false }` keeps what the fallback covers out of prefetches, when this
176
- * entry's segment is new to the client: the entry's handler, its loaders,
176
+ * false }` keeps what the fallback covers out of viewport and render
177
+ * prefetches (a hover prefetch runs it), when this entry's segment is new
178
+ * to the client: the entry's handler, its loaders,
177
179
  * its orphan layouts and parallel slots and, for a layout, every deeper
178
180
  * entry. The click that adopts the prefetch shows the fallback and fetches
179
181
  * them in one follow-up request, which reads cache() and "use cache" as
@@ -7,8 +7,8 @@
7
7
  *
8
8
  * Sits in src/vite/, not src/vite/discovery/: the loader hook URL below
9
9
  * resolves against this module's import.meta.url, and the published bundles
10
- * (dist/vite/index.js, dist/bin/rango.js) ship the hook at the same relative
11
- * path.
10
+ * (dist/vite/index.js, and the CLI's code-split chunks in dist/bin/) ship the
11
+ * hook at the same relative path.
12
12
  */
13
13
  import type { ViteDevServer } from "vite";
14
14
  import type { DiscoveryState } from "./discovery/state.js";