@rangojs/router 0.0.0-experimental.8a4d0430 → 0.0.0-experimental.8bcfea43
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.
- package/AGENTS.md +4 -0
- package/README.md +126 -38
- package/dist/bin/rango.js +138 -50
- package/dist/vite/index.js +1171 -461
- package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
- package/package.json +19 -16
- package/skills/breadcrumbs/SKILL.md +3 -1
- package/skills/cache-guide/SKILL.md +32 -0
- package/skills/caching/SKILL.md +45 -4
- package/skills/handler-use/SKILL.md +362 -0
- package/skills/hooks/SKILL.md +28 -20
- package/skills/intercept/SKILL.md +20 -0
- package/skills/layout/SKILL.md +22 -0
- package/skills/links/SKILL.md +91 -17
- package/skills/loader/SKILL.md +88 -45
- package/skills/middleware/SKILL.md +34 -3
- package/skills/migrate-nextjs/SKILL.md +560 -0
- package/skills/migrate-react-router/SKILL.md +765 -0
- package/skills/parallel/SKILL.md +185 -0
- package/skills/prerender/SKILL.md +110 -68
- package/skills/rango/SKILL.md +24 -22
- package/skills/response-routes/SKILL.md +8 -0
- package/skills/route/SKILL.md +55 -0
- package/skills/router-setup/SKILL.md +87 -2
- package/skills/streams-and-websockets/SKILL.md +283 -0
- package/skills/typesafety/SKILL.md +13 -1
- package/src/__internal.ts +1 -1
- package/src/browser/app-shell.ts +52 -0
- package/src/browser/app-version.ts +14 -0
- package/src/browser/event-controller.ts +5 -0
- package/src/browser/navigation-bridge.ts +90 -16
- package/src/browser/navigation-client.ts +167 -59
- package/src/browser/navigation-store.ts +68 -9
- package/src/browser/navigation-transaction.ts +11 -9
- package/src/browser/partial-update.ts +113 -17
- package/src/browser/prefetch/cache.ts +184 -16
- package/src/browser/prefetch/fetch.ts +180 -33
- package/src/browser/prefetch/policy.ts +6 -0
- package/src/browser/prefetch/queue.ts +123 -20
- package/src/browser/prefetch/resource-ready.ts +77 -0
- package/src/browser/rango-state.ts +53 -13
- package/src/browser/react/Link.tsx +81 -9
- package/src/browser/react/NavigationProvider.tsx +89 -14
- package/src/browser/react/context.ts +7 -2
- package/src/browser/react/use-handle.ts +9 -58
- package/src/browser/react/use-navigation.ts +22 -2
- package/src/browser/react/use-params.ts +11 -1
- package/src/browser/react/use-router.ts +29 -9
- package/src/browser/rsc-router.tsx +168 -65
- package/src/browser/scroll-restoration.ts +41 -42
- package/src/browser/segment-reconciler.ts +36 -9
- package/src/browser/server-action-bridge.ts +8 -6
- package/src/browser/types.ts +49 -5
- package/src/build/generate-manifest.ts +6 -6
- package/src/build/generate-route-types.ts +3 -0
- package/src/build/route-trie.ts +50 -24
- package/src/build/route-types/include-resolution.ts +8 -1
- package/src/build/route-types/router-processing.ts +223 -74
- package/src/build/route-types/scan-filter.ts +8 -1
- package/src/cache/cache-runtime.ts +15 -11
- package/src/cache/cache-scope.ts +48 -7
- package/src/cache/cf/cf-cache-store.ts +455 -15
- package/src/cache/cf/index.ts +5 -1
- package/src/cache/document-cache.ts +17 -7
- package/src/cache/index.ts +1 -0
- package/src/cache/taint.ts +55 -0
- package/src/client.tsx +84 -230
- package/src/context-var.ts +72 -2
- package/src/debug.ts +2 -2
- package/src/handle.ts +40 -0
- package/src/index.rsc.ts +6 -1
- package/src/index.ts +49 -6
- package/src/outlet-context.ts +1 -1
- package/src/prerender/store.ts +5 -4
- package/src/prerender.ts +138 -77
- package/src/response-utils.ts +28 -0
- package/src/reverse.ts +27 -2
- package/src/route-definition/dsl-helpers.ts +240 -40
- package/src/route-definition/helpers-types.ts +67 -19
- package/src/route-definition/index.ts +3 -0
- package/src/route-definition/redirect.ts +11 -3
- package/src/route-definition/resolve-handler-use.ts +155 -0
- package/src/route-map-builder.ts +7 -1
- package/src/route-types.ts +18 -0
- package/src/router/content-negotiation.ts +100 -1
- package/src/router/find-match.ts +4 -2
- package/src/router/handler-context.ts +101 -25
- package/src/router/intercept-resolution.ts +11 -4
- package/src/router/lazy-includes.ts +10 -7
- package/src/router/loader-resolution.ts +159 -21
- package/src/router/logging.ts +5 -2
- package/src/router/manifest.ts +31 -16
- package/src/router/match-api.ts +127 -192
- package/src/router/match-middleware/background-revalidation.ts +30 -2
- package/src/router/match-middleware/cache-lookup.ts +94 -17
- package/src/router/match-middleware/cache-store.ts +53 -10
- package/src/router/match-middleware/intercept-resolution.ts +9 -7
- package/src/router/match-middleware/segment-resolution.ts +61 -5
- package/src/router/match-result.ts +104 -10
- package/src/router/metrics.ts +6 -1
- package/src/router/middleware-types.ts +8 -30
- package/src/router/middleware.ts +36 -10
- package/src/router/navigation-snapshot.ts +182 -0
- package/src/router/pattern-matching.ts +60 -9
- package/src/router/prerender-match.ts +110 -10
- package/src/router/preview-match.ts +30 -102
- package/src/router/request-classification.ts +310 -0
- package/src/router/route-snapshot.ts +245 -0
- package/src/router/router-context.ts +6 -1
- package/src/router/router-interfaces.ts +36 -4
- package/src/router/router-options.ts +37 -11
- package/src/router/segment-resolution/fresh.ts +198 -20
- package/src/router/segment-resolution/helpers.ts +29 -24
- package/src/router/segment-resolution/loader-cache.ts +1 -0
- package/src/router/segment-resolution/revalidation.ts +438 -300
- package/src/router/segment-wrappers.ts +2 -0
- package/src/router/trie-matching.ts +10 -4
- package/src/router/types.ts +1 -0
- package/src/router/url-params.ts +49 -0
- package/src/router.ts +60 -8
- package/src/rsc/handler.ts +478 -374
- package/src/rsc/helpers.ts +69 -41
- package/src/rsc/loader-fetch.ts +23 -3
- package/src/rsc/manifest-init.ts +5 -1
- package/src/rsc/progressive-enhancement.ts +16 -2
- package/src/rsc/response-route-handler.ts +14 -1
- package/src/rsc/rsc-rendering.ts +19 -1
- package/src/rsc/server-action.ts +10 -0
- package/src/rsc/ssr-setup.ts +2 -2
- package/src/rsc/types.ts +9 -1
- package/src/segment-content-promise.ts +67 -0
- package/src/segment-loader-promise.ts +122 -0
- package/src/segment-system.tsx +109 -23
- package/src/server/context.ts +166 -17
- package/src/server/handle-store.ts +19 -0
- package/src/server/loader-registry.ts +9 -8
- package/src/server/request-context.ts +194 -60
- package/src/ssr/index.tsx +4 -0
- package/src/static-handler.ts +18 -6
- package/src/types/cache-types.ts +4 -4
- package/src/types/handler-context.ts +137 -65
- package/src/types/loader-types.ts +41 -15
- package/src/types/request-scope.ts +126 -0
- package/src/types/route-entry.ts +19 -1
- package/src/types/segments.ts +2 -0
- package/src/urls/include-helper.ts +24 -14
- package/src/urls/path-helper-types.ts +39 -6
- package/src/urls/path-helper.ts +48 -13
- package/src/urls/pattern-types.ts +12 -0
- package/src/urls/response-types.ts +18 -16
- package/src/use-loader.tsx +77 -5
- package/src/vite/debug.ts +55 -0
- package/src/vite/discovery/bundle-postprocess.ts +30 -33
- package/src/vite/discovery/discover-routers.ts +5 -1
- package/src/vite/discovery/prerender-collection.ts +128 -74
- package/src/vite/discovery/state.ts +13 -6
- package/src/vite/index.ts +4 -0
- package/src/vite/plugin-types.ts +51 -79
- package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
- package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
- package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
- package/src/vite/plugins/expose-action-id.ts +1 -3
- package/src/vite/plugins/expose-id-utils.ts +12 -0
- package/src/vite/plugins/expose-ids/handler-transform.ts +30 -0
- package/src/vite/plugins/expose-internal-ids.ts +257 -40
- package/src/vite/plugins/performance-tracks.ts +86 -0
- package/src/vite/plugins/refresh-cmd.ts +88 -26
- package/src/vite/plugins/version-plugin.ts +13 -1
- package/src/vite/rango.ts +204 -217
- package/src/vite/router-discovery.ts +335 -64
- package/src/vite/utils/banner.ts +4 -4
- package/src/vite/utils/package-resolution.ts +41 -1
- package/src/vite/utils/prerender-utils.ts +37 -5
- package/src/vite/utils/shared-utils.ts +3 -2
|
@@ -19,6 +19,8 @@ import type {
|
|
|
19
19
|
ResolvedRouteMap,
|
|
20
20
|
} from "./route-config.js";
|
|
21
21
|
import type { LoaderDefinition } from "./loader-types.js";
|
|
22
|
+
import type { UseItems, HandlerUseItem } from "../route-types.js";
|
|
23
|
+
import type { RequestScope } from "./request-scope.js";
|
|
22
24
|
|
|
23
25
|
// Re-export MiddlewareFn for internal/advanced use
|
|
24
26
|
export type { MiddlewareFn } from "../router/middleware.js";
|
|
@@ -135,7 +137,7 @@ export type Handler<
|
|
|
135
137
|
| Record<string, any> = {},
|
|
136
138
|
TRouteMap extends {} = DefaultHandlerRouteMap,
|
|
137
139
|
TEnv = DefaultEnv,
|
|
138
|
-
> = (
|
|
140
|
+
> = ((
|
|
139
141
|
ctx: HandlerContext<
|
|
140
142
|
T extends `.${infer Local}`
|
|
141
143
|
? Local extends keyof TRouteMap
|
|
@@ -160,7 +162,10 @@ export type Handler<
|
|
|
160
162
|
: ExtractSearchFromEntry<DefaultHandlerRouteMap, T>,
|
|
161
163
|
TRouteMap extends DefaultHandlerRouteMap ? never : TRouteMap
|
|
162
164
|
>,
|
|
163
|
-
) => ReactNode | Promise<ReactNode> | Response | Promise<Response
|
|
165
|
+
) => ReactNode | Promise<ReactNode> | Response | Promise<Response>) & {
|
|
166
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
167
|
+
use?: () => UseItems<HandlerUseItem>;
|
|
168
|
+
};
|
|
164
169
|
|
|
165
170
|
/**
|
|
166
171
|
* Context passed to handlers (Hono-inspired type-safe context)
|
|
@@ -170,7 +175,7 @@ export type Handler<
|
|
|
170
175
|
* - Cleaned route URL (`url`, `searchParams`, `pathname` — no `_rsc*` params)
|
|
171
176
|
* - Original request (`request` — raw transport URL, headers, method, body)
|
|
172
177
|
* - Platform bindings (env.DB, env.KV, env.SECRETS)
|
|
173
|
-
* - Middleware variables (
|
|
178
|
+
* - Middleware variables (`get("user")`, `get("permissions")`)
|
|
174
179
|
* - Getter/setter for variables (get('user'), set('user', ...))
|
|
175
180
|
*
|
|
176
181
|
* @example
|
|
@@ -178,8 +183,7 @@ export type Handler<
|
|
|
178
183
|
* const handler = (ctx: HandlerContext<{ slug: string }, AppEnv>) => {
|
|
179
184
|
* ctx.params.slug // Route param (string)
|
|
180
185
|
* ctx.env.DB // Binding (D1Database)
|
|
181
|
-
* ctx.
|
|
182
|
-
* ctx.get('user') // Alternative getter
|
|
186
|
+
* ctx.get('user') // Variable (User | undefined)
|
|
183
187
|
* ctx.set('user', {...}) // Setter
|
|
184
188
|
* ctx.url // Clean URL (no _rsc* params)
|
|
185
189
|
* ctx.searchParams // Clean params (no _rsc* params)
|
|
@@ -192,7 +196,7 @@ export type HandlerContext<
|
|
|
192
196
|
TEnv = DefaultEnv,
|
|
193
197
|
TSearch extends SearchSchema = {},
|
|
194
198
|
TRouteMap = never,
|
|
195
|
-
> = {
|
|
199
|
+
> = RequestScope<TEnv> & {
|
|
196
200
|
/**
|
|
197
201
|
* Route parameters extracted from the URL pattern.
|
|
198
202
|
* Type-safe when using Handler<"/path/:param"> or Handler<{ param: string }>.
|
|
@@ -207,51 +211,19 @@ export type HandlerContext<
|
|
|
207
211
|
*/
|
|
208
212
|
build: boolean;
|
|
209
213
|
/**
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
* for cases where you need original headers, method, or body.
|
|
214
|
-
*/
|
|
215
|
-
request: Request;
|
|
216
|
-
/**
|
|
217
|
-
* Query parameters from the URL (system params like `_rsc*` are filtered).
|
|
218
|
-
* Always a standard URLSearchParams instance.
|
|
214
|
+
* True when running in Vite dev mode, false during production build or
|
|
215
|
+
* live request rendering. Use this to branch on runtime mode without
|
|
216
|
+
* changing build semantics (e.g., skip expensive operations in dev).
|
|
219
217
|
*/
|
|
220
|
-
|
|
218
|
+
dev: boolean;
|
|
221
219
|
/**
|
|
222
220
|
* Typed search parameters parsed from URL query string via the route's
|
|
223
221
|
* search schema. Empty object when no schema is defined.
|
|
224
222
|
*/
|
|
225
223
|
search: {} extends TSearch ? {} : ResolveSearchSchema<TSearch>;
|
|
226
|
-
/**
|
|
227
|
-
* The pathname portion of the request URL.
|
|
228
|
-
*/
|
|
229
|
-
pathname: string;
|
|
230
|
-
/**
|
|
231
|
-
* The full URL object (with internal `_rsc*` params stripped).
|
|
232
|
-
* Use this for application logic — routing, link generation, display.
|
|
233
|
-
*/
|
|
234
|
-
url: URL;
|
|
235
|
-
/**
|
|
236
|
-
* The original request URL with all parameters intact, including
|
|
237
|
-
* internal `_rsc*` transport params. Use `ctx.url` for application
|
|
238
|
-
* logic — this is only needed for advanced cases like debugging
|
|
239
|
-
* or custom cache keying.
|
|
240
|
-
*/
|
|
241
|
-
originalUrl: URL;
|
|
242
|
-
/**
|
|
243
|
-
* Platform bindings (DB, KV, secrets, etc.).
|
|
244
|
-
* Access resources like `ctx.env.DB`, `ctx.env.KV`.
|
|
245
|
-
*/
|
|
246
|
-
env: TEnv;
|
|
247
|
-
/**
|
|
248
|
-
* Middleware-injected variables.
|
|
249
|
-
* Access values like `ctx.var.user`, `ctx.var.permissions`.
|
|
250
|
-
*/
|
|
251
|
-
var: DefaultVars;
|
|
252
224
|
/**
|
|
253
225
|
* Type-safe getter for middleware variables.
|
|
254
|
-
*
|
|
226
|
+
* Preferred way to read middleware-injected variables.
|
|
255
227
|
*
|
|
256
228
|
* @example
|
|
257
229
|
* ```typescript
|
|
@@ -272,8 +244,16 @@ export type HandlerContext<
|
|
|
272
244
|
* ```
|
|
273
245
|
*/
|
|
274
246
|
set: {
|
|
275
|
-
<T>(
|
|
276
|
-
|
|
247
|
+
<T>(
|
|
248
|
+
contextVar: ContextVar<T>,
|
|
249
|
+
value: T,
|
|
250
|
+
options?: { cache?: boolean },
|
|
251
|
+
): void;
|
|
252
|
+
} & (<K extends keyof DefaultVars>(
|
|
253
|
+
key: K,
|
|
254
|
+
value: DefaultVars[K],
|
|
255
|
+
options?: { cache?: boolean },
|
|
256
|
+
) => void);
|
|
277
257
|
/**
|
|
278
258
|
* Response headers. Headers set here are merged into the final response.
|
|
279
259
|
*
|
|
@@ -289,8 +269,15 @@ export type HandlerContext<
|
|
|
289
269
|
/**
|
|
290
270
|
* Access loader data or push handle data.
|
|
291
271
|
*
|
|
272
|
+
* Available in route handlers, layout handlers, middleware, server actions,
|
|
273
|
+
* and server components rendered within the request context.
|
|
274
|
+
*
|
|
292
275
|
* For loaders: Returns a promise that resolves to the loader data.
|
|
293
276
|
* Loaders are executed in parallel and memoized per request.
|
|
277
|
+
* Prefer DSL `loader()` + client `useLoader()` over `ctx.use(Loader)` —
|
|
278
|
+
* DSL loaders are always fresh and cache-safe. Use `ctx.use(Loader)` only
|
|
279
|
+
* when you need loader data in the handler itself (e.g., to set context
|
|
280
|
+
* variables or make routing decisions).
|
|
294
281
|
*
|
|
295
282
|
* For handles: Returns a push function to add data for this segment.
|
|
296
283
|
* Handle data accumulates across all matched route segments.
|
|
@@ -298,10 +285,11 @@ export type HandlerContext<
|
|
|
298
285
|
*
|
|
299
286
|
* @example
|
|
300
287
|
* ```typescript
|
|
301
|
-
* // Loader
|
|
302
|
-
* route("
|
|
303
|
-
* const
|
|
304
|
-
*
|
|
288
|
+
* // Loader escape hatch — use when handler needs the data directly
|
|
289
|
+
* route("product", async (ctx) => {
|
|
290
|
+
* const { product } = await ctx.use(ProductLoader);
|
|
291
|
+
* ctx.set(Product, product); // make available to children
|
|
292
|
+
* return <ProductPage />;
|
|
305
293
|
* });
|
|
306
294
|
*
|
|
307
295
|
* // Handle usage - direct value
|
|
@@ -432,6 +420,8 @@ export type InternalHandlerContext<
|
|
|
432
420
|
> = HandlerContext<TParams, TEnv, TSearch> & {
|
|
433
421
|
/** @internal Stub response for collecting headers/cookies. */
|
|
434
422
|
res: Response;
|
|
423
|
+
/** @internal Shared variable backing store for ctx.get()/ctx.set(). */
|
|
424
|
+
_variables: Record<string, any>;
|
|
435
425
|
/** Prerender-only control flow helper, attached when the runtime context supports it. */
|
|
436
426
|
passthrough?: () => unknown;
|
|
437
427
|
/** Current segment ID for handle data attribution. */
|
|
@@ -519,30 +509,112 @@ export type RevalidateParams<TParams = GenericParams, TEnv = any> = Parameters<
|
|
|
519
509
|
* })
|
|
520
510
|
* ```
|
|
521
511
|
*/
|
|
512
|
+
/**
|
|
513
|
+
* Revalidation function called during client-side navigation to decide whether
|
|
514
|
+
* a segment (layout, route, parallel slot, or loader) should be re-rendered.
|
|
515
|
+
*
|
|
516
|
+
* Return `true` to re-render, `false` to skip (keep client's current version),
|
|
517
|
+
* or `{ defaultShouldRevalidate: boolean }` to override the default for
|
|
518
|
+
* downstream segments.
|
|
519
|
+
*
|
|
520
|
+
* @example
|
|
521
|
+
* ```ts
|
|
522
|
+
* // Re-render only when a cart action happened or browser signals staleness
|
|
523
|
+
* revalidate(({ actionId, stale }) =>
|
|
524
|
+
* actionId?.includes("cart") || stale || false
|
|
525
|
+
* )
|
|
526
|
+
*
|
|
527
|
+
* // Always re-render when params change (default behavior made explicit)
|
|
528
|
+
* revalidate(({ defaultShouldRevalidate }) => defaultShouldRevalidate)
|
|
529
|
+
* ```
|
|
530
|
+
*/
|
|
522
531
|
export type ShouldRevalidateFn<TParams = GenericParams, TEnv = any> = (args: {
|
|
532
|
+
/** Route params from the page being navigated away from. */
|
|
523
533
|
currentParams: TParams;
|
|
534
|
+
/** Full URL of the page being navigated away from. */
|
|
524
535
|
currentUrl: URL;
|
|
536
|
+
/** Route params for the navigation target. */
|
|
525
537
|
nextParams: TParams;
|
|
538
|
+
/** Full URL of the navigation target. */
|
|
526
539
|
nextUrl: URL;
|
|
540
|
+
/**
|
|
541
|
+
* The router's default revalidation decision for this segment.
|
|
542
|
+
* `true` when params changed or the segment is new to the client.
|
|
543
|
+
* Return this when you want default behavior plus your own conditions.
|
|
544
|
+
*/
|
|
527
545
|
defaultShouldRevalidate: boolean;
|
|
546
|
+
/** Full handler context — access to `ctx.use()`, `ctx.env`, `ctx.params`, etc. */
|
|
528
547
|
context: HandlerContext<TParams, TEnv>;
|
|
529
|
-
|
|
548
|
+
|
|
549
|
+
// ── Segment metadata (which segment is being evaluated) ──────────────
|
|
550
|
+
|
|
551
|
+
/** The type of segment being revalidated. */
|
|
530
552
|
segmentType: "layout" | "route" | "parallel";
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
553
|
+
/** Layout name (e.g., `"root"`, `"shop"`, `"auth"`). Only set for layout segments. */
|
|
554
|
+
layoutName?: string;
|
|
555
|
+
/** Slot name (e.g., `"@sidebar"`, `"@modal"`). Only set for parallel segments. */
|
|
556
|
+
slotName?: string;
|
|
557
|
+
|
|
558
|
+
// ── Action context (populated when revalidation is triggered by a server action) ──
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Identifier of the server action that triggered revalidation.
|
|
562
|
+
* `undefined` during normal navigation (no action involved).
|
|
563
|
+
*
|
|
564
|
+
* Format: `"src/<path>#<exportName>"` — the file path is the source path
|
|
565
|
+
* relative to the project root, followed by `#` and the exported function name.
|
|
566
|
+
*
|
|
567
|
+
* This is stable and can be used for path-based matching to revalidate
|
|
568
|
+
* when any action in a module or directory fires:
|
|
569
|
+
*
|
|
570
|
+
* @example
|
|
571
|
+
* ```ts
|
|
572
|
+
* // Match a specific action
|
|
573
|
+
* revalidate(({ actionId }) => actionId === "src/actions/cart.ts#addToCart")
|
|
574
|
+
*
|
|
575
|
+
* // Match any action in the cart module
|
|
576
|
+
* revalidate(({ actionId }) => actionId?.includes("cart") ?? false)
|
|
577
|
+
*
|
|
578
|
+
* // Match any action under src/apps/store/actions/
|
|
579
|
+
* revalidate(({ actionId }) => actionId?.startsWith("src/apps/store/actions/") ?? false)
|
|
580
|
+
* ```
|
|
581
|
+
*/
|
|
582
|
+
actionId?: string;
|
|
583
|
+
/** URL where the action was executed (the page the user was on when they triggered the action). */
|
|
584
|
+
actionUrl?: URL;
|
|
585
|
+
/** Return value from the action execution. Can be used to conditionally revalidate based on the action's outcome. */
|
|
586
|
+
actionResult?: any;
|
|
587
|
+
/** FormData from the action request body. Only set for form-based actions (not inline `"use server"` actions). */
|
|
588
|
+
formData?: FormData;
|
|
589
|
+
/** HTTP method: `"GET"` for navigation, `"POST"` for server actions. */
|
|
590
|
+
method?: string;
|
|
591
|
+
|
|
592
|
+
// ── Route identity ───────────────────────────────────────────────────
|
|
593
|
+
|
|
594
|
+
/** Route name of the navigation target. Alias for `toRouteName`. */
|
|
595
|
+
routeName?: DefaultRouteName;
|
|
596
|
+
/**
|
|
597
|
+
* Route name being navigated away from.
|
|
598
|
+
* `undefined` for unnamed internal routes (those without a `name` option).
|
|
599
|
+
*/
|
|
600
|
+
fromRouteName?: DefaultRouteName;
|
|
601
|
+
/**
|
|
602
|
+
* Route name being navigated to.
|
|
603
|
+
* `undefined` for unnamed internal routes (those without a `name` option).
|
|
604
|
+
*/
|
|
605
|
+
toRouteName?: DefaultRouteName;
|
|
606
|
+
|
|
607
|
+
// ── Staleness signal ─────────────────────────────────────────────────
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* `true` when the browser signals that data may be stale — typically because
|
|
611
|
+
* a server action was executed in this or another tab (`_rsc_stale` header).
|
|
612
|
+
*
|
|
613
|
+
* This is NOT segment cache staleness (loaders are never segment-cached).
|
|
614
|
+
* Use this to decide whether loader data should be re-fetched after an
|
|
615
|
+
* action that may have mutated backend state.
|
|
616
|
+
*/
|
|
617
|
+
stale?: boolean;
|
|
546
618
|
}) => boolean | { defaultShouldRevalidate: boolean };
|
|
547
619
|
|
|
548
620
|
// MiddlewareFn is imported from "../router/middleware.js" and re-exported
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import type { ContextVar } from "../context-var.js";
|
|
2
|
+
import type { Handle } from "../handle.js";
|
|
2
3
|
import type { MiddlewareFn } from "../router/middleware.js";
|
|
3
4
|
import type { ScopedReverseFunction } from "../reverse.js";
|
|
4
5
|
import type { SearchSchema, ResolveSearchSchema } from "../search-params.js";
|
|
6
|
+
import type { UseItems, LoaderUseItem } from "../route-types.js";
|
|
5
7
|
import type {
|
|
6
8
|
DefaultEnv,
|
|
7
9
|
DefaultReverseRouteMap,
|
|
8
10
|
DefaultVars,
|
|
9
11
|
} from "./global-namespace.js";
|
|
12
|
+
import type { RequestScope } from "./request-scope.js";
|
|
10
13
|
|
|
11
14
|
/**
|
|
12
15
|
* Context passed to loader functions during execution
|
|
@@ -38,7 +41,7 @@ export type LoaderContext<
|
|
|
38
41
|
TEnv = DefaultEnv,
|
|
39
42
|
TBody = unknown,
|
|
40
43
|
TSearch extends SearchSchema = {},
|
|
41
|
-
> = {
|
|
44
|
+
> = RequestScope<TEnv> & {
|
|
42
45
|
params: TParams;
|
|
43
46
|
/**
|
|
44
47
|
* Route params extracted from the URL pattern match (server-side only).
|
|
@@ -47,22 +50,43 @@ export type LoaderContext<
|
|
|
47
50
|
* resource scoping.
|
|
48
51
|
*/
|
|
49
52
|
routeParams: Record<string, string>;
|
|
50
|
-
request: Request;
|
|
51
|
-
searchParams: URLSearchParams;
|
|
52
53
|
search: {} extends TSearch ? {} : ResolveSearchSchema<TSearch>;
|
|
53
|
-
pathname: string;
|
|
54
|
-
url: URL;
|
|
55
|
-
env: TEnv;
|
|
56
|
-
var: DefaultVars;
|
|
57
54
|
get: {
|
|
58
55
|
<T>(contextVar: ContextVar<T>): T | undefined;
|
|
59
56
|
} & (<K extends keyof DefaultVars>(key: K) => DefaultVars[K]);
|
|
60
57
|
/**
|
|
61
|
-
* Access another loader's data
|
|
58
|
+
* Access another loader's data, or read handle data after rendered().
|
|
59
|
+
*
|
|
60
|
+
* For loaders: returns a promise (loaders run in parallel).
|
|
61
|
+
* For handles: returns collected data (only after `await ctx.rendered()`).
|
|
62
|
+
*/
|
|
63
|
+
use: {
|
|
64
|
+
<T, TLoaderParams = any>(
|
|
65
|
+
loader: LoaderDefinition<T, TLoaderParams>,
|
|
66
|
+
): Promise<T>;
|
|
67
|
+
<TData, TAccumulated = TData[]>(
|
|
68
|
+
handle: Handle<TData, TAccumulated>,
|
|
69
|
+
): TAccumulated;
|
|
70
|
+
};
|
|
71
|
+
/**
|
|
72
|
+
* **Experimental.** Wait for all non-loader segments to settle.
|
|
73
|
+
*
|
|
74
|
+
* After the returned promise resolves, handle data is available via
|
|
75
|
+
* `ctx.use(handle)`. Only supported in DSL loaders on non-streaming
|
|
76
|
+
* trees (no `loading()`). Throws if called from a handler-invoked
|
|
77
|
+
* loader or when the tree uses streaming.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```typescript
|
|
81
|
+
* const PricesLoader = createLoader(async (ctx) => {
|
|
82
|
+
* "use server";
|
|
83
|
+
* await ctx.rendered();
|
|
84
|
+
* const products = ctx.use(Products); // reads handle data
|
|
85
|
+
* return pricing.getLive(products.map(p => p.id));
|
|
86
|
+
* });
|
|
87
|
+
* ```
|
|
62
88
|
*/
|
|
63
|
-
|
|
64
|
-
loader: LoaderDefinition<T, TLoaderParams>,
|
|
65
|
-
) => Promise<T>;
|
|
89
|
+
rendered: () => Promise<void>;
|
|
66
90
|
/**
|
|
67
91
|
* HTTP method (GET, POST, PUT, PATCH, DELETE)
|
|
68
92
|
* Available when loader is called via load({ method: "POST", ... })
|
|
@@ -166,11 +190,11 @@ export type LoadOptions =
|
|
|
166
190
|
* return await db.products.findBySlug(slug);
|
|
167
191
|
* });
|
|
168
192
|
*
|
|
169
|
-
* //
|
|
170
|
-
* const
|
|
193
|
+
* // Client usage (preferred — cache-safe, always fresh)
|
|
194
|
+
* const { data } = useLoader(CartLoader);
|
|
171
195
|
*
|
|
172
|
-
* //
|
|
173
|
-
* const cart =
|
|
196
|
+
* // Server escape hatch (handler needs data directly)
|
|
197
|
+
* const cart = await ctx.use(CartLoader);
|
|
174
198
|
* ```
|
|
175
199
|
*/
|
|
176
200
|
export type LoaderDefinition<
|
|
@@ -180,4 +204,6 @@ export type LoaderDefinition<
|
|
|
180
204
|
__brand: "loader";
|
|
181
205
|
$$id: string; // Injected by Vite plugin (exposeInternalIds) - unique identifier
|
|
182
206
|
fn?: LoaderFn<T, TParams, any>; // Optional - server-side only, stored in registry for RSC
|
|
207
|
+
/** Composable default DSL items merged when the loader is mounted. */
|
|
208
|
+
use?: () => UseItems<LoaderUseItem>;
|
|
183
209
|
};
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RequestScope: the fields every user-facing context shares.
|
|
3
|
+
*
|
|
4
|
+
* A handler, middleware, loader, response handler, and the ALS-bound
|
|
5
|
+
* RequestContext are all different phases of the same request, and they
|
|
6
|
+
* all carry the same set of request-scoped capabilities: the raw Request,
|
|
7
|
+
* the parsed URL pair (`url` is cleaned of internal `_rsc*` params,
|
|
8
|
+
* `originalUrl` retains them), pathname/searchParams, platform bindings
|
|
9
|
+
* (`env`), and two escape hatches for work that outlives the response
|
|
10
|
+
* (`waitUntil`) or needs the raw Cloudflare runtime object
|
|
11
|
+
* (`executionContext`).
|
|
12
|
+
*
|
|
13
|
+
* Each public context type intersects `RequestScope<TEnv>` with its own
|
|
14
|
+
* phase-specific fields (e.g. `params`/`reverse` on HandlerContext,
|
|
15
|
+
* `headers`/`header()` on MiddlewareContext). That keeps platform surface
|
|
16
|
+
* in one place and lets the next runtime escape hatch we need land in
|
|
17
|
+
* one file instead of four.
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
import type { DefaultEnv } from "./global-namespace.js";
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Minimal subset of Cloudflare Workers' ExecutionContext that the router
|
|
24
|
+
* uses. Defined locally so the package does not depend on
|
|
25
|
+
* `@cloudflare/workers-types`. Consumers that want the full type can cast.
|
|
26
|
+
*
|
|
27
|
+
* On non-Cloudflare runtimes (Node, dev server, tests), this is undefined
|
|
28
|
+
* — portable apps should prefer `ctx.waitUntil(...)`, which degrades
|
|
29
|
+
* gracefully. `ctx.executionContext` is the escape hatch for libraries
|
|
30
|
+
* (MCP, Durable Object routing, etc.) that type their arguments as the
|
|
31
|
+
* raw ExecutionContext.
|
|
32
|
+
*/
|
|
33
|
+
export interface ExecutionContext {
|
|
34
|
+
waitUntil(promise: Promise<any>): void;
|
|
35
|
+
passThroughOnException(): void;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Fallback `waitUntil` body used when no Cloudflare `ExecutionContext`
|
|
40
|
+
* is available (Node, dev, tests). Runs the work fire-and-forget and
|
|
41
|
+
* logs errors so they don't silently swallow.
|
|
42
|
+
*
|
|
43
|
+
* Exported so every `waitUntil` call site degrades identically instead
|
|
44
|
+
* of inventing its own fallback policy.
|
|
45
|
+
*/
|
|
46
|
+
export function fireAndForgetWaitUntil(fn: () => Promise<void>): void {
|
|
47
|
+
fn().catch((err) =>
|
|
48
|
+
console.error("[waitUntil] Background task failed:", err),
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Fields present on every user-facing request context.
|
|
54
|
+
*
|
|
55
|
+
* @template TEnv - Platform bindings type (Cloudflare env, etc.).
|
|
56
|
+
*/
|
|
57
|
+
export interface RequestScope<TEnv = DefaultEnv> {
|
|
58
|
+
/**
|
|
59
|
+
* The original incoming Request object (transport URL intact).
|
|
60
|
+
* Use `url` / `searchParams` for application logic — those have
|
|
61
|
+
* internal `_rsc*` params stripped. `request` preserves the raw URL
|
|
62
|
+
* when you need original headers, method, or body.
|
|
63
|
+
*/
|
|
64
|
+
request: Request;
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* The request URL with internal `_rsc*` transport params stripped.
|
|
68
|
+
* Use this for routing, link generation, and display.
|
|
69
|
+
*/
|
|
70
|
+
url: URL;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* The original request URL with all parameters intact, including
|
|
74
|
+
* internal `_rsc*` transport params. Use `url` for application logic
|
|
75
|
+
* — this is only needed for advanced cases like debugging or custom
|
|
76
|
+
* cache keying.
|
|
77
|
+
*/
|
|
78
|
+
originalUrl: URL;
|
|
79
|
+
|
|
80
|
+
/** URL pathname (same as `url.pathname`). */
|
|
81
|
+
pathname: string;
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Query parameters from the URL (system params like `_rsc*` are
|
|
85
|
+
* filtered). Always a standard `URLSearchParams` instance.
|
|
86
|
+
*/
|
|
87
|
+
searchParams: URLSearchParams;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Platform bindings (DB, KV, secrets, etc.). On Cloudflare Workers
|
|
91
|
+
* these are the `env` object passed to the Worker's `fetch()` handler.
|
|
92
|
+
*/
|
|
93
|
+
env: TEnv;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Schedule work to run after the response is sent.
|
|
97
|
+
* On Cloudflare Workers, delegates to `executionContext.waitUntil()`.
|
|
98
|
+
* On Node / dev / tests, runs as fire-and-forget with error logging.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```typescript
|
|
102
|
+
* ctx.waitUntil(async () => {
|
|
103
|
+
* await cacheStore.set(key, data, ttl);
|
|
104
|
+
* });
|
|
105
|
+
* ```
|
|
106
|
+
*/
|
|
107
|
+
waitUntil(fn: () => Promise<void>): void;
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Raw Cloudflare Workers `ExecutionContext`, when running on a
|
|
111
|
+
* Cloudflare-compatible runtime. Undefined elsewhere.
|
|
112
|
+
*
|
|
113
|
+
* Escape hatch for libraries that type their arguments as
|
|
114
|
+
* `ExecutionContext` (MCP `fetch`, `routeAgentRequest`, etc.).
|
|
115
|
+
* For the common "do work after the response" case, prefer
|
|
116
|
+
* `ctx.waitUntil(...)` — it is platform-neutral.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```typescript
|
|
120
|
+
* path.any("/mcp", (ctx) =>
|
|
121
|
+
* emailMcp.fetch(ctx.request, ctx.env, ctx.executionContext!),
|
|
122
|
+
* );
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
executionContext?: ExecutionContext;
|
|
126
|
+
}
|
package/src/types/route-entry.ts
CHANGED
|
@@ -8,10 +8,21 @@ export interface LazyIncludeContext {
|
|
|
8
8
|
urlPrefix: string;
|
|
9
9
|
namePrefix: string | undefined;
|
|
10
10
|
parent: unknown; // EntryData - avoid circular import
|
|
11
|
+
/** Counter snapshot from pattern extraction for consistent shortCode indices */
|
|
12
|
+
counters?: Record<string, number>;
|
|
11
13
|
cacheProfiles?: Record<
|
|
12
14
|
string,
|
|
13
15
|
import("../cache/profile-registry.js").CacheProfile
|
|
14
16
|
>;
|
|
17
|
+
/** Root scope flag for dot-local reverse resolution */
|
|
18
|
+
rootScoped?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Positional include scope token composed from the parent scope plus this
|
|
21
|
+
* include's sibling index (`${parentScope}I${idx}`). Applied to direct-
|
|
22
|
+
* descendant shortCodes during lazy evaluation so routes inside the
|
|
23
|
+
* include cannot collide with siblings declared outside it.
|
|
24
|
+
*/
|
|
25
|
+
includeScope?: string;
|
|
15
26
|
}
|
|
16
27
|
|
|
17
28
|
/**
|
|
@@ -55,6 +66,13 @@ export interface RouteEntry<TEnv = any> {
|
|
|
55
66
|
| Promise<() => Array<AllUseItems>>;
|
|
56
67
|
mountIndex: number;
|
|
57
68
|
|
|
69
|
+
/**
|
|
70
|
+
* Router ID that owns this entry. Used to namespace the manifest cache
|
|
71
|
+
* so multi-router setups (host routing) don't share cached EntryData
|
|
72
|
+
* across routers with overlapping mountIndex + routeKey combinations.
|
|
73
|
+
*/
|
|
74
|
+
routerId?: string;
|
|
75
|
+
|
|
58
76
|
/**
|
|
59
77
|
* Route keys in this entry that have pre-render handlers.
|
|
60
78
|
* Used by the non-trie match path to set the `pr` flag.
|
|
@@ -62,7 +80,7 @@ export interface RouteEntry<TEnv = any> {
|
|
|
62
80
|
prerenderRouteKeys?: Set<string>;
|
|
63
81
|
|
|
64
82
|
/**
|
|
65
|
-
* Route keys in this entry that
|
|
83
|
+
* Route keys in this entry that are wrapped with `Passthrough()`.
|
|
66
84
|
* Used by the non-trie match path to set the `pt` flag.
|
|
67
85
|
*/
|
|
68
86
|
passthroughRouteKeys?: Set<string>;
|
package/src/types/segments.ts
CHANGED
|
@@ -50,7 +50,9 @@ export interface ResolvedSegment {
|
|
|
50
50
|
parallelName?: string; // For parallels: the parallel group name (used to match with revalidations)
|
|
51
51
|
// Loader-specific fields
|
|
52
52
|
loaderId?: string; // For loaders: the loader $$id identifier
|
|
53
|
+
_inherited?: boolean; // For inherited loaders: dedup marker for buildMatchResult
|
|
53
54
|
loaderData?: any; // For loaders: the resolved data from loader execution
|
|
55
|
+
parallelLoading?: ReactNode; // For parallel-owned loaders: the parallel's loading fallback
|
|
54
56
|
// Intercept loader fields (for streaming loader data in parallel segments)
|
|
55
57
|
loaderDataPromise?: Promise<any[]> | any[]; // Loader data promise or resolved array
|
|
56
58
|
loaderIds?: string[]; // IDs ($$id) of loaders for this segment
|
|
@@ -4,7 +4,6 @@ import {
|
|
|
4
4
|
runWithPrefixes,
|
|
5
5
|
getUrlPrefix,
|
|
6
6
|
getNamePrefix,
|
|
7
|
-
getRootScoped,
|
|
8
7
|
} from "../server/context";
|
|
9
8
|
import {
|
|
10
9
|
INTERNAL_INCLUDE_SCOPE_PREFIX,
|
|
@@ -149,22 +148,32 @@ export function createIncludeHelper<TEnv>(): IncludeFn<TEnv> {
|
|
|
149
148
|
});
|
|
150
149
|
}
|
|
151
150
|
|
|
152
|
-
//
|
|
153
|
-
//
|
|
154
|
-
//
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
//
|
|
158
|
-
//
|
|
159
|
-
//
|
|
160
|
-
// and
|
|
161
|
-
|
|
151
|
+
// Allocate an include-scope token for this include() call. The token is
|
|
152
|
+
// appended to the parent's shortCode prefix whenever the include's
|
|
153
|
+
// direct-descendant shortCodes are generated (see getShortCode in
|
|
154
|
+
// context.ts), partitioning the parent's counter namespace so routes
|
|
155
|
+
// inside an include cannot collide with siblings declared outside it.
|
|
156
|
+
//
|
|
157
|
+
// Scopes compose: a nested include inside an outer include with scope
|
|
158
|
+
// "I0" allocates against the `${parent.shortCode}I0_include` counter
|
|
159
|
+
// and produces scope "I0I0", "I0I1", etc.
|
|
160
|
+
const parentScope = ctx.includeScope ?? "";
|
|
161
|
+
let includeScope = parentScope;
|
|
162
162
|
if (capturedParent?.shortCode) {
|
|
163
|
-
const
|
|
164
|
-
ctx.counters[
|
|
165
|
-
ctx.counters[
|
|
163
|
+
const includeCounterKey = `${capturedParent.shortCode}${parentScope}_include`;
|
|
164
|
+
ctx.counters[includeCounterKey] ??= 0;
|
|
165
|
+
const includeIdx = ctx.counters[includeCounterKey];
|
|
166
|
+
ctx.counters[includeCounterKey] = includeIdx + 1;
|
|
167
|
+
includeScope = `${parentScope}I${includeIdx}`;
|
|
166
168
|
}
|
|
167
169
|
|
|
170
|
+
// Snapshot parent's counters AFTER allocating the include scope so lazy
|
|
171
|
+
// manifest generation starts with the same counter state this include
|
|
172
|
+
// observed — its descendants still get fresh per-scope counters because
|
|
173
|
+
// they key off `${parent.shortCode}${includeScope}_*` (not shared with
|
|
174
|
+
// siblings outside the include).
|
|
175
|
+
const capturedCounters = { ...ctx.counters };
|
|
176
|
+
|
|
168
177
|
// Compute rootScoped at capture time, mirroring the logic in runWithPrefixes.
|
|
169
178
|
// This ensures lazy evaluation restores the correct scope state.
|
|
170
179
|
const parentRootScoped = ctx.rootScoped;
|
|
@@ -191,6 +200,7 @@ export function createIncludeHelper<TEnv>(): IncludeFn<TEnv> {
|
|
|
191
200
|
counters: capturedCounters,
|
|
192
201
|
cacheProfiles: ctx.cacheProfiles,
|
|
193
202
|
rootScoped: capturedRootScoped,
|
|
203
|
+
includeScope,
|
|
194
204
|
},
|
|
195
205
|
} as IncludeItem;
|
|
196
206
|
};
|