@rangojs/router 0.0.0-experimental.62 → 0.0.0-experimental.63
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/README.md +61 -8
- package/dist/bin/rango.js +2 -1
- package/dist/vite/index.js +142 -62
- package/dist/vite/index.js.bak +5448 -0
- package/package.json +14 -15
- package/skills/prerender/SKILL.md +110 -68
- package/src/__internal.ts +1 -1
- package/src/build/generate-manifest.ts +3 -6
- package/src/build/route-types/scan-filter.ts +8 -1
- package/src/index.rsc.ts +3 -1
- package/src/index.ts +8 -0
- package/src/prerender/store.ts +5 -4
- package/src/prerender.ts +138 -77
- package/src/route-definition/dsl-helpers.ts +37 -18
- package/src/route-definition/index.ts +3 -0
- package/src/route-definition/resolve-handler-use.ts +149 -0
- package/src/route-types.ts +11 -0
- package/src/router/handler-context.ts +20 -5
- package/src/router/match-api.ts +2 -8
- package/src/router/match-middleware/cache-lookup.ts +2 -6
- package/src/router/prerender-match.ts +104 -8
- package/src/router/router-interfaces.ts +4 -0
- package/src/router/segment-resolution/fresh.ts +7 -2
- package/src/router/segment-resolution/revalidation.ts +10 -5
- package/src/router.ts +9 -1
- package/src/server/context.ts +5 -1
- package/src/static-handler.ts +18 -6
- package/src/types/handler-context.ts +12 -2
- package/src/types/route-entry.ts +1 -1
- package/src/urls/path-helper-types.ts +5 -1
- package/src/urls/path-helper.ts +47 -12
- package/src/urls/response-types.ts +16 -6
- package/src/vite/discovery/bundle-postprocess.ts +30 -33
- package/src/vite/discovery/prerender-collection.ts +14 -1
- package/src/vite/discovery/state.ts +13 -4
- package/src/vite/index.ts +4 -0
- package/src/vite/plugin-types.ts +60 -5
- package/src/vite/rango.ts +2 -1
- package/src/vite/router-discovery.ts +153 -34
package/src/router/match-api.ts
CHANGED
|
@@ -91,10 +91,7 @@ export async function createMatchContextForFull<TEnv>(
|
|
|
91
91
|
});
|
|
92
92
|
}
|
|
93
93
|
|
|
94
|
-
if (
|
|
95
|
-
manifestEntry.type === "route" &&
|
|
96
|
-
manifestEntry.prerenderDef?.options?.passthrough === true
|
|
97
|
-
) {
|
|
94
|
+
if (manifestEntry.type === "route" && manifestEntry.isPassthrough === true) {
|
|
98
95
|
matched.pt = true;
|
|
99
96
|
}
|
|
100
97
|
|
|
@@ -289,10 +286,7 @@ export async function createMatchContextForPartial<TEnv>(
|
|
|
289
286
|
});
|
|
290
287
|
}
|
|
291
288
|
|
|
292
|
-
if (
|
|
293
|
-
manifestEntry.type === "route" &&
|
|
294
|
-
manifestEntry.prerenderDef?.options?.passthrough === true
|
|
295
|
-
) {
|
|
289
|
+
if (manifestEntry.type === "route" && manifestEntry.isPassthrough === true) {
|
|
296
290
|
matched.pt = true;
|
|
297
291
|
}
|
|
298
292
|
|
|
@@ -324,9 +324,7 @@ export function withCacheLookup<TEnv>(
|
|
|
324
324
|
if (prerenderStoreInstance) {
|
|
325
325
|
const paramHash = _hashParams!(ctx.matched.params);
|
|
326
326
|
const isPassthroughPrerenderRoute = ctx.entries.some(
|
|
327
|
-
(entry) =>
|
|
328
|
-
entry.type === "route" &&
|
|
329
|
-
entry.prerenderDef?.options?.passthrough === true,
|
|
327
|
+
(entry) => entry.type === "route" && entry.isPassthrough === true,
|
|
330
328
|
);
|
|
331
329
|
|
|
332
330
|
if (ctx.isIntercept) {
|
|
@@ -396,9 +394,7 @@ export function withCacheLookup<TEnv>(
|
|
|
396
394
|
if (prerenderStoreInstance) {
|
|
397
395
|
const paramHash = _hashParams!(ctx.matched.params);
|
|
398
396
|
const isPassthroughPrerenderRoute = ctx.entries.some(
|
|
399
|
-
(entry) =>
|
|
400
|
-
entry.type === "route" &&
|
|
401
|
-
entry.prerenderDef?.options?.passthrough === true,
|
|
397
|
+
(entry) => entry.type === "route" && entry.isPassthrough === true,
|
|
402
398
|
);
|
|
403
399
|
|
|
404
400
|
if (ctx.isIntercept) {
|
|
@@ -54,6 +54,9 @@ export async function matchForPrerender<TEnv = any>(
|
|
|
54
54
|
deps: PrerenderMatchDeps<TEnv>,
|
|
55
55
|
buildVars?: Record<string, any>,
|
|
56
56
|
isPassthroughRoute?: boolean,
|
|
57
|
+
buildEnv?: TEnv,
|
|
58
|
+
/** Dev-only: check getParams() for passthrough routes to skip unknown params. */
|
|
59
|
+
devMode?: boolean,
|
|
57
60
|
): Promise<{
|
|
58
61
|
segments: SerializedSegmentData[];
|
|
59
62
|
handles: Record<string, SegmentHandleData>;
|
|
@@ -90,15 +93,100 @@ export async function matchForPrerender<TEnv = any>(
|
|
|
90
93
|
entries.push(entry);
|
|
91
94
|
}
|
|
92
95
|
|
|
96
|
+
// 3b. Dev-mode passthrough shortcut: if the route is a Passthrough route
|
|
97
|
+
// and has getParams(), check if the matched params are in the known list.
|
|
98
|
+
// In production, only known params are pre-rendered; unknown params fall
|
|
99
|
+
// through to the live handler. Mirror that behavior in dev mode to avoid
|
|
100
|
+
// rendering unknown params with build: true.
|
|
101
|
+
// Vars collected from getParams() probe — merged into render context below.
|
|
102
|
+
let devProbeBuildVars: Record<string, any> | undefined;
|
|
103
|
+
|
|
104
|
+
if (devMode && matchedPassthroughRoute) {
|
|
105
|
+
const routeEntry = entries.find(
|
|
106
|
+
(
|
|
107
|
+
e,
|
|
108
|
+
): e is EntryData & {
|
|
109
|
+
type: "route";
|
|
110
|
+
prerenderDef: { getParams: (ctx: any) => Promise<any[]> | any[] };
|
|
111
|
+
} =>
|
|
112
|
+
e.type === "route" &&
|
|
113
|
+
!!(e as any).isPassthrough &&
|
|
114
|
+
!!(e as any).prerenderDef?.getParams,
|
|
115
|
+
);
|
|
116
|
+
if (routeEntry) {
|
|
117
|
+
try {
|
|
118
|
+
const probeBuildVars: Record<string, any> = {};
|
|
119
|
+
const knownParamsList = await routeEntry.prerenderDef.getParams({
|
|
120
|
+
build: true as const,
|
|
121
|
+
dev: true,
|
|
122
|
+
set: ((keyOrVar: any, value: any) => {
|
|
123
|
+
contextSet(probeBuildVars, keyOrVar, value);
|
|
124
|
+
}) as any,
|
|
125
|
+
reverse: createReverseFunction(deps.mergedRouteMap),
|
|
126
|
+
get env() {
|
|
127
|
+
if (buildEnv !== undefined) return buildEnv;
|
|
128
|
+
throw new Error(
|
|
129
|
+
"[rsc-router] ctx.env is not available during dev-mode getParams(). " +
|
|
130
|
+
"Configure buildEnv in your rango() plugin options to enable build-time env access.",
|
|
131
|
+
);
|
|
132
|
+
},
|
|
133
|
+
});
|
|
134
|
+
// Compare only the keys returned by getParams — ignore mount params
|
|
135
|
+
// from include() prefixes that aren't part of the handler's params.
|
|
136
|
+
const isKnown = knownParamsList.some((known: Record<string, any>) => {
|
|
137
|
+
const knownKeys = Object.keys(known);
|
|
138
|
+
return knownKeys.every(
|
|
139
|
+
(k) => String(known[k]) === String(matchedParams[k]),
|
|
140
|
+
);
|
|
141
|
+
});
|
|
142
|
+
if (!isKnown) {
|
|
143
|
+
return {
|
|
144
|
+
segments: [],
|
|
145
|
+
handles: {},
|
|
146
|
+
routeName: matched.routeKey,
|
|
147
|
+
params: matchedParams,
|
|
148
|
+
passthrough: true as const,
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
// Preserve vars set by getParams() for the render context
|
|
152
|
+
if (
|
|
153
|
+
Object.keys(probeBuildVars).length > 0 ||
|
|
154
|
+
Object.getOwnPropertySymbols(probeBuildVars).length > 0
|
|
155
|
+
) {
|
|
156
|
+
devProbeBuildVars = probeBuildVars;
|
|
157
|
+
}
|
|
158
|
+
} catch (err: any) {
|
|
159
|
+
// Mirror production semantics (prerender-collection.ts):
|
|
160
|
+
// Skip errors are intentional — treat as passthrough.
|
|
161
|
+
// All other errors propagate so dev surfaces them.
|
|
162
|
+
if (err?.name === "Skip") {
|
|
163
|
+
return {
|
|
164
|
+
segments: [],
|
|
165
|
+
handles: {},
|
|
166
|
+
routeName: matched.routeKey,
|
|
167
|
+
params: matchedParams,
|
|
168
|
+
passthrough: true as const,
|
|
169
|
+
};
|
|
170
|
+
}
|
|
171
|
+
throw err;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
|
|
93
176
|
// 4. Create handle store for collecting handle data
|
|
94
177
|
const handleStore = createHandleStore();
|
|
95
178
|
|
|
96
179
|
// 5. Create a minimal request context with the handle store
|
|
97
|
-
// Shallow-copy getParams vars so each param set is independent
|
|
98
|
-
|
|
180
|
+
// Shallow-copy getParams vars so each param set is independent.
|
|
181
|
+
// In dev mode, merge vars from the getParams() probe if the caller
|
|
182
|
+
// didn't provide buildVars (production passes them from expandPrerenderRoutes).
|
|
183
|
+
const effectiveBuildVars = buildVars ?? devProbeBuildVars;
|
|
184
|
+
const variables: Record<string, any> = effectiveBuildVars
|
|
185
|
+
? { ...effectiveBuildVars }
|
|
186
|
+
: {};
|
|
99
187
|
const stubRes = new Response(null, { status: 200 });
|
|
100
188
|
const minimalRequestContext: RequestContext<TEnv> = {
|
|
101
|
-
env: {} as TEnv,
|
|
189
|
+
env: buildEnv ?? ({} as TEnv),
|
|
102
190
|
request: new Request("http://prerender" + pathname),
|
|
103
191
|
url: new URL("http://prerender" + pathname),
|
|
104
192
|
originalUrl: new URL("http://prerender" + pathname),
|
|
@@ -140,7 +228,7 @@ export async function matchForPrerender<TEnv = any>(
|
|
|
140
228
|
return runWithRequestContext(minimalRequestContext, async () => {
|
|
141
229
|
// 6. Create prerender context with synthetic URL.
|
|
142
230
|
// Prerender handlers get params, pathname, url, searchParams, search,
|
|
143
|
-
// reverse,
|
|
231
|
+
// reverse, use(handle), and optionally env (when buildEnv is configured).
|
|
144
232
|
const buildCtx = createPrerenderContext<TEnv>(
|
|
145
233
|
matchedParams,
|
|
146
234
|
pathname,
|
|
@@ -148,6 +236,8 @@ export async function matchForPrerender<TEnv = any>(
|
|
|
148
236
|
matched.routeKey,
|
|
149
237
|
variables,
|
|
150
238
|
matchedPassthroughRoute,
|
|
239
|
+
buildEnv,
|
|
240
|
+
devMode,
|
|
151
241
|
);
|
|
152
242
|
|
|
153
243
|
// 7. Wire use() for handles only (loaders throw)
|
|
@@ -320,6 +410,8 @@ export async function renderStaticSegment<TEnv = any>(
|
|
|
320
410
|
handlerId: string,
|
|
321
411
|
mergedRouteMap: Record<string, string>,
|
|
322
412
|
routeName?: string,
|
|
413
|
+
buildEnv?: TEnv,
|
|
414
|
+
devMode?: boolean,
|
|
323
415
|
): Promise<{ encoded: string; handles: Record<string, unknown[]> } | null> {
|
|
324
416
|
const syntheticUrl = new URL("http://prerender/");
|
|
325
417
|
const syntheticRequest = new Request(syntheticUrl);
|
|
@@ -330,7 +422,7 @@ export async function renderStaticSegment<TEnv = any>(
|
|
|
330
422
|
// Minimal request context so setupBuildUse can find the HandleStore
|
|
331
423
|
const stubRes = new Response(null, { status: 200 });
|
|
332
424
|
const minimalRequestContext: RequestContext<TEnv> = {
|
|
333
|
-
env: {} as TEnv,
|
|
425
|
+
env: buildEnv ?? ({} as TEnv),
|
|
334
426
|
request: syntheticRequest,
|
|
335
427
|
url: syntheticUrl,
|
|
336
428
|
originalUrl: syntheticUrl,
|
|
@@ -368,9 +460,13 @@ export async function renderStaticSegment<TEnv = any>(
|
|
|
368
460
|
};
|
|
369
461
|
|
|
370
462
|
return runWithRequestContext(minimalRequestContext, async () => {
|
|
371
|
-
// Static handlers get only reverse
|
|
372
|
-
|
|
373
|
-
|
|
463
|
+
// Static handlers get only reverse, use(handle), and optionally env.
|
|
464
|
+
const buildCtx = createStaticContext<TEnv>(
|
|
465
|
+
mergedRouteMap,
|
|
466
|
+
routeName,
|
|
467
|
+
buildEnv,
|
|
468
|
+
devMode,
|
|
469
|
+
);
|
|
374
470
|
|
|
375
471
|
// Set segment ID so handle pushes are keyed correctly
|
|
376
472
|
(buildCtx as InternalHandlerContext<any, TEnv>)._currentSegmentId =
|
|
@@ -374,6 +374,8 @@ export interface RSCRouterInternal<
|
|
|
374
374
|
params: Record<string, string>,
|
|
375
375
|
buildVars?: Record<string, any>,
|
|
376
376
|
isPassthroughRoute?: boolean,
|
|
377
|
+
buildEnv?: any,
|
|
378
|
+
devMode?: boolean,
|
|
377
379
|
): Promise<{
|
|
378
380
|
segments: SerializedSegmentData[];
|
|
379
381
|
handles: Record<string, SegmentHandleData>;
|
|
@@ -392,6 +394,8 @@ export interface RSCRouterInternal<
|
|
|
392
394
|
handler: Function,
|
|
393
395
|
handlerId: string,
|
|
394
396
|
routeName?: string,
|
|
397
|
+
buildEnv?: any,
|
|
398
|
+
devMode?: boolean,
|
|
395
399
|
): Promise<{ encoded: string; handles: Record<string, unknown[]> } | null>;
|
|
396
400
|
|
|
397
401
|
/**
|
|
@@ -284,9 +284,14 @@ export async function resolveSegment<TEnv>(
|
|
|
284
284
|
entry.shortCode,
|
|
285
285
|
);
|
|
286
286
|
if (component === undefined) {
|
|
287
|
+
// For Passthrough routes at runtime, use the live handler instead of
|
|
288
|
+
// the build handler. At build time (context.build === true), always
|
|
289
|
+
// use the build handler from entry.handler.
|
|
290
|
+
const handler =
|
|
291
|
+
!context.build && entry.liveHandler ? entry.liveHandler : entry.handler;
|
|
287
292
|
const doneRouteHandler = track(`handler:${entry.id}`, 2);
|
|
288
293
|
if (entry.loading) {
|
|
289
|
-
const result = handleHandlerResult(
|
|
294
|
+
const result = handleHandlerResult(handler(context));
|
|
290
295
|
if (result instanceof Promise) {
|
|
291
296
|
result.finally(doneRouteHandler).catch(() => {});
|
|
292
297
|
const tracked = deps.trackHandler(result, {
|
|
@@ -307,7 +312,7 @@ export async function resolveSegment<TEnv>(
|
|
|
307
312
|
component = result;
|
|
308
313
|
}
|
|
309
314
|
} else {
|
|
310
|
-
component = handleHandlerResult(await
|
|
315
|
+
component = handleHandlerResult(await handler(context));
|
|
311
316
|
doneRouteHandler();
|
|
312
317
|
}
|
|
313
318
|
}
|
|
@@ -688,13 +688,20 @@ export async function resolveEntryHandlerWithRevalidation<TEnv>(
|
|
|
688
688
|
return staticComponent;
|
|
689
689
|
}
|
|
690
690
|
const routeEntry = entry as Extract<EntryData, { type: "route" }>;
|
|
691
|
+
// For Passthrough routes at runtime, use the live handler instead of
|
|
692
|
+
// the build handler. At build time (context.build === true), always
|
|
693
|
+
// use the build handler from routeEntry.handler.
|
|
694
|
+
const handler =
|
|
695
|
+
!context.build && routeEntry.liveHandler
|
|
696
|
+
? routeEntry.liveHandler
|
|
697
|
+
: routeEntry.handler;
|
|
691
698
|
if (!routeEntry.loading) {
|
|
692
|
-
const result = handleHandlerResult(await
|
|
699
|
+
const result = handleHandlerResult(await handler(context));
|
|
693
700
|
doneHandler();
|
|
694
701
|
return result;
|
|
695
702
|
}
|
|
696
703
|
if (!actionContext) {
|
|
697
|
-
const result = handleHandlerResult(
|
|
704
|
+
const result = handleHandlerResult(handler(context));
|
|
698
705
|
if (result instanceof Promise) {
|
|
699
706
|
result.finally(doneHandler).catch(() => {});
|
|
700
707
|
const tracked = deps.trackHandler(result, {
|
|
@@ -717,9 +724,7 @@ export async function resolveEntryHandlerWithRevalidation<TEnv>(
|
|
|
717
724
|
debugLog("segment.action", "resolving action route with awaited value", {
|
|
718
725
|
entryId: entry.id,
|
|
719
726
|
});
|
|
720
|
-
const actionResult = handleHandlerResult(
|
|
721
|
-
await routeEntry.handler(context),
|
|
722
|
-
);
|
|
727
|
+
const actionResult = handleHandlerResult(await handler(context));
|
|
723
728
|
doneHandler();
|
|
724
729
|
return {
|
|
725
730
|
content: Promise.resolve(actionResult),
|
package/src/router.ts
CHANGED
|
@@ -625,6 +625,8 @@ export function createRouter<TEnv = any>(
|
|
|
625
625
|
params: Record<string, string>,
|
|
626
626
|
buildVars?: Record<string, any>,
|
|
627
627
|
isPassthroughRoute?: boolean,
|
|
628
|
+
buildEnv?: TEnv,
|
|
629
|
+
devMode?: boolean,
|
|
628
630
|
) {
|
|
629
631
|
return _matchForPrerender(
|
|
630
632
|
pathname,
|
|
@@ -632,6 +634,8 @@ export function createRouter<TEnv = any>(
|
|
|
632
634
|
prerenderDeps,
|
|
633
635
|
buildVars,
|
|
634
636
|
isPassthroughRoute,
|
|
637
|
+
buildEnv,
|
|
638
|
+
devMode,
|
|
635
639
|
);
|
|
636
640
|
}
|
|
637
641
|
|
|
@@ -639,12 +643,16 @@ export function createRouter<TEnv = any>(
|
|
|
639
643
|
handler: Function,
|
|
640
644
|
handlerId: string,
|
|
641
645
|
routeName?: string,
|
|
646
|
+
buildEnv?: TEnv,
|
|
647
|
+
devMode?: boolean,
|
|
642
648
|
) {
|
|
643
649
|
return _renderStaticSegment<TEnv>(
|
|
644
650
|
handler,
|
|
645
651
|
handlerId,
|
|
646
652
|
mergedRouteMap,
|
|
647
653
|
routeName,
|
|
654
|
+
buildEnv,
|
|
655
|
+
devMode,
|
|
648
656
|
);
|
|
649
657
|
}
|
|
650
658
|
|
|
@@ -748,7 +756,7 @@ export function createRouter<TEnv = any>(
|
|
|
748
756
|
if (entry.type === "route" && entry.isPrerender) {
|
|
749
757
|
if (!prerenderRouteKeys) prerenderRouteKeys = new Set();
|
|
750
758
|
prerenderRouteKeys.add(name);
|
|
751
|
-
if (entry.
|
|
759
|
+
if (entry.isPassthrough === true) {
|
|
752
760
|
if (!passthroughRouteKeys) passthroughRouteKeys = new Set();
|
|
753
761
|
passthroughRouteKeys.add(name);
|
|
754
762
|
}
|
package/src/server/context.ts
CHANGED
|
@@ -191,8 +191,12 @@ export type EntryData =
|
|
|
191
191
|
/** Original PrerenderHandlerDefinition (for build-time getParams access) */
|
|
192
192
|
prerenderDef?: {
|
|
193
193
|
getParams?: (ctx: any) => Promise<any[]> | any[];
|
|
194
|
-
options?: {
|
|
194
|
+
options?: { concurrency?: number };
|
|
195
195
|
};
|
|
196
|
+
/** Set when route is wrapped with Passthrough() — has a separate live handler */
|
|
197
|
+
isPassthrough?: true;
|
|
198
|
+
/** Live handler for runtime fallback (only set on Passthrough routes) */
|
|
199
|
+
liveHandler?: Handler<any, any, any>;
|
|
196
200
|
/** Set when handler is a Static definition (build-time only) */
|
|
197
201
|
isStaticPrerender?: true;
|
|
198
202
|
/** Static handler $$id for build-time store lookup */
|
package/src/static-handler.ts
CHANGED
|
@@ -32,11 +32,21 @@
|
|
|
32
32
|
*/
|
|
33
33
|
import type { ReactNode } from "react";
|
|
34
34
|
import type { Handler } from "./types.js";
|
|
35
|
-
import type {
|
|
35
|
+
import type { StaticBuildContext } from "./prerender.js";
|
|
36
|
+
import type { UseItems, HandlerUseItem } from "./route-types.js";
|
|
36
37
|
import { isCachedFunction } from "./cache/taint.js";
|
|
37
38
|
|
|
38
39
|
// -- Types ------------------------------------------------------------------
|
|
39
40
|
|
|
41
|
+
export interface StaticHandlerOptions {
|
|
42
|
+
/**
|
|
43
|
+
* Keep handler in server bundle for live fallback (default: false).
|
|
44
|
+
* false: handler replaced with stub, source-only APIs excluded from bundle.
|
|
45
|
+
* true: handler stays in bundle, renders live at request time.
|
|
46
|
+
*/
|
|
47
|
+
passthrough?: boolean;
|
|
48
|
+
}
|
|
49
|
+
|
|
40
50
|
export interface StaticHandlerDefinition<
|
|
41
51
|
TParams extends Record<string, any> = any,
|
|
42
52
|
> {
|
|
@@ -46,14 +56,16 @@ export interface StaticHandlerDefinition<
|
|
|
46
56
|
/** In dev mode, the actual handler function that layout/path/parallel can call. */
|
|
47
57
|
handler: Handler<TParams>;
|
|
48
58
|
/** Static handler options (passthrough support). */
|
|
49
|
-
options?:
|
|
59
|
+
options?: StaticHandlerOptions;
|
|
60
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
61
|
+
use?: () => UseItems<HandlerUseItem>;
|
|
50
62
|
}
|
|
51
63
|
|
|
52
64
|
// -- Function ---------------------------------------------------------------
|
|
53
65
|
|
|
54
66
|
export function Static<TParams extends Record<string, any> = {}>(
|
|
55
67
|
handler: (ctx: StaticBuildContext) => ReactNode | Promise<ReactNode>,
|
|
56
|
-
options?:
|
|
68
|
+
options?: StaticHandlerOptions,
|
|
57
69
|
__injectedId?: string,
|
|
58
70
|
): StaticHandlerDefinition<TParams>;
|
|
59
71
|
|
|
@@ -61,7 +73,7 @@ export function Static<TParams extends Record<string, any> = {}>(
|
|
|
61
73
|
|
|
62
74
|
export function Static<TParams extends Record<string, any>>(
|
|
63
75
|
handler: Function,
|
|
64
|
-
optionsOrId?:
|
|
76
|
+
optionsOrId?: StaticHandlerOptions | string,
|
|
65
77
|
maybeId?: string,
|
|
66
78
|
): StaticHandlerDefinition<TParams> {
|
|
67
79
|
if (isCachedFunction(handler)) {
|
|
@@ -72,13 +84,13 @@ export function Static<TParams extends Record<string, any>>(
|
|
|
72
84
|
);
|
|
73
85
|
}
|
|
74
86
|
|
|
75
|
-
let options:
|
|
87
|
+
let options: StaticHandlerOptions | undefined;
|
|
76
88
|
let id: string;
|
|
77
89
|
|
|
78
90
|
if (typeof optionsOrId === "string") {
|
|
79
91
|
id = optionsOrId;
|
|
80
92
|
} else {
|
|
81
|
-
options = optionsOrId as
|
|
93
|
+
options = optionsOrId as StaticHandlerOptions | undefined;
|
|
82
94
|
id = maybeId ?? "";
|
|
83
95
|
}
|
|
84
96
|
|
|
@@ -19,6 +19,7 @@ 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";
|
|
22
23
|
|
|
23
24
|
// Re-export MiddlewareFn for internal/advanced use
|
|
24
25
|
export type { MiddlewareFn } from "../router/middleware.js";
|
|
@@ -135,7 +136,7 @@ export type Handler<
|
|
|
135
136
|
| Record<string, any> = {},
|
|
136
137
|
TRouteMap extends {} = DefaultHandlerRouteMap,
|
|
137
138
|
TEnv = DefaultEnv,
|
|
138
|
-
> = (
|
|
139
|
+
> = ((
|
|
139
140
|
ctx: HandlerContext<
|
|
140
141
|
T extends `.${infer Local}`
|
|
141
142
|
? Local extends keyof TRouteMap
|
|
@@ -160,7 +161,10 @@ export type Handler<
|
|
|
160
161
|
: ExtractSearchFromEntry<DefaultHandlerRouteMap, T>,
|
|
161
162
|
TRouteMap extends DefaultHandlerRouteMap ? never : TRouteMap
|
|
162
163
|
>,
|
|
163
|
-
) => ReactNode | Promise<ReactNode> | Response | Promise<Response
|
|
164
|
+
) => ReactNode | Promise<ReactNode> | Response | Promise<Response>) & {
|
|
165
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
166
|
+
use?: () => UseItems<HandlerUseItem>;
|
|
167
|
+
};
|
|
164
168
|
|
|
165
169
|
/**
|
|
166
170
|
* Context passed to handlers (Hono-inspired type-safe context)
|
|
@@ -205,6 +209,12 @@ export type HandlerContext<
|
|
|
205
209
|
* Live request rendering, including passthrough fallback, uses `false`.
|
|
206
210
|
*/
|
|
207
211
|
build: boolean;
|
|
212
|
+
/**
|
|
213
|
+
* True when running in Vite dev mode, false during production build or
|
|
214
|
+
* live request rendering. Use this to branch on runtime mode without
|
|
215
|
+
* changing build semantics (e.g., skip expensive operations in dev).
|
|
216
|
+
*/
|
|
217
|
+
dev: boolean;
|
|
208
218
|
/**
|
|
209
219
|
* The original incoming Request object (transport URL intact).
|
|
210
220
|
* Use `ctx.url` / `ctx.searchParams` for application logic — those have
|
package/src/types/route-entry.ts
CHANGED
|
@@ -69,7 +69,7 @@ export interface RouteEntry<TEnv = any> {
|
|
|
69
69
|
prerenderRouteKeys?: Set<string>;
|
|
70
70
|
|
|
71
71
|
/**
|
|
72
|
-
* Route keys in this entry that
|
|
72
|
+
* Route keys in this entry that are wrapped with `Passthrough()`.
|
|
73
73
|
* Used by the non-trie match path to set the `pt` flag.
|
|
74
74
|
*/
|
|
75
75
|
passthroughRouteKeys?: Set<string>;
|
|
@@ -37,7 +37,10 @@ import type {
|
|
|
37
37
|
UseItems,
|
|
38
38
|
} from "../route-types.js";
|
|
39
39
|
import type { SearchSchema } from "../search-params.js";
|
|
40
|
-
import type {
|
|
40
|
+
import type {
|
|
41
|
+
PrerenderHandlerDefinition,
|
|
42
|
+
PassthroughHandlerDefinition,
|
|
43
|
+
} from "../prerender.js";
|
|
41
44
|
import type { StaticHandlerDefinition } from "../static-handler.js";
|
|
42
45
|
import type { InterceptWhenFn } from "../server/context";
|
|
43
46
|
import type {
|
|
@@ -70,6 +73,7 @@ export type PathFn<TEnv> = <
|
|
|
70
73
|
ctx: HandlerContext<TParams, TEnv, TSearch>,
|
|
71
74
|
) => ReactNode | Promise<ReactNode> | Response | Promise<Response>)
|
|
72
75
|
| PrerenderHandlerDefinition<TParams>
|
|
76
|
+
| PassthroughHandlerDefinition<TParams, TEnv>
|
|
73
77
|
| StaticHandlerDefinition<TParams>,
|
|
74
78
|
optionsOrUse?: PathOptions<TName, TSearch> | (() => UseItems<RouteUseItem>),
|
|
75
79
|
use?: () => UseItems<RouteUseItem>,
|
package/src/urls/path-helper.ts
CHANGED
|
@@ -12,10 +12,11 @@ import {
|
|
|
12
12
|
getNamePrefix,
|
|
13
13
|
getRootScoped,
|
|
14
14
|
} from "../server/context";
|
|
15
|
-
import { invariant } from "../errors";
|
|
15
|
+
import { invariant, DataNotFoundError } from "../errors";
|
|
16
16
|
import { validateUserRouteName } from "../route-name.js";
|
|
17
17
|
import {
|
|
18
18
|
isPrerenderHandler,
|
|
19
|
+
isPassthroughHandler,
|
|
19
20
|
type PrerenderHandlerDefinition,
|
|
20
21
|
} from "../prerender.js";
|
|
21
22
|
import {
|
|
@@ -34,6 +35,10 @@ import type {
|
|
|
34
35
|
JsonResponsePathFn,
|
|
35
36
|
TextResponsePathFn,
|
|
36
37
|
} from "./path-helper-types.js";
|
|
38
|
+
import {
|
|
39
|
+
resolveHandlerUse,
|
|
40
|
+
mergeHandlerUse,
|
|
41
|
+
} from "../route-definition/resolve-handler-use.js";
|
|
37
42
|
|
|
38
43
|
/**
|
|
39
44
|
* Check if a value is a valid use item
|
|
@@ -142,6 +147,12 @@ export function createPathHelper<TEnv>(): PathFn<TEnv> {
|
|
|
142
147
|
use = maybeUse;
|
|
143
148
|
}
|
|
144
149
|
|
|
150
|
+
// Merge handler.use() defaults with explicit use()
|
|
151
|
+
// Response routes (path.json, path.text, etc.) only allow middleware + cache
|
|
152
|
+
const handlerUseFn = resolveHandlerUse(handler);
|
|
153
|
+
const mountSite = resolveResponseType(options) ? "response" : "path";
|
|
154
|
+
const mergedUse = mergeHandlerUse(handlerUseFn, use, mountSite);
|
|
155
|
+
|
|
145
156
|
// Get prefixes from context (set by include())
|
|
146
157
|
const urlPrefix = getUrlPrefix();
|
|
147
158
|
const namePrefix = getNamePrefix();
|
|
@@ -176,14 +187,31 @@ export function createPathHelper<TEnv>(): PathFn<TEnv> {
|
|
|
176
187
|
}
|
|
177
188
|
|
|
178
189
|
// Ensure handler is always a function (wrap ReactNode or extract from prerender/static def)
|
|
190
|
+
// For prerender stubs (production builds where handler code is evicted),
|
|
191
|
+
// handler.handler is undefined — provide a notFound fallback so requests
|
|
192
|
+
// for non-prerendered params get 404 instead of "handler is not a function".
|
|
179
193
|
const wrappedHandler: Handler<any, any, TEnv> =
|
|
180
194
|
typeof handler === "function"
|
|
181
195
|
? (handler as Handler<any, any, TEnv>)
|
|
182
|
-
:
|
|
183
|
-
?
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
196
|
+
: isPassthroughHandler(handler)
|
|
197
|
+
? typeof handler.prerenderDef.handler === "function"
|
|
198
|
+
? (handler.prerenderDef.handler as Handler<any, any, TEnv>)
|
|
199
|
+
: () => {
|
|
200
|
+
throw new DataNotFoundError(
|
|
201
|
+
"No prerender data found for this route",
|
|
202
|
+
);
|
|
203
|
+
}
|
|
204
|
+
: isPrerenderHandler(handler)
|
|
205
|
+
? typeof handler.handler === "function"
|
|
206
|
+
? (handler.handler as Handler<any, any, TEnv>)
|
|
207
|
+
: () => {
|
|
208
|
+
throw new DataNotFoundError(
|
|
209
|
+
"No prerender data found for this route",
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
: isStaticHandler(handler)
|
|
213
|
+
? (handler.handler as Handler<any, any, TEnv>)
|
|
214
|
+
: () => handler;
|
|
187
215
|
|
|
188
216
|
const entry = {
|
|
189
217
|
id: namespace,
|
|
@@ -203,12 +231,19 @@ export function createPathHelper<TEnv>(): PathFn<TEnv> {
|
|
|
203
231
|
intercept: [],
|
|
204
232
|
loader: [],
|
|
205
233
|
...(urlPrefix ? { mountPath: urlPrefix } : {}),
|
|
206
|
-
...(
|
|
234
|
+
...(isPassthroughHandler(handler)
|
|
207
235
|
? {
|
|
208
236
|
isPrerender: true as const,
|
|
209
|
-
prerenderDef: handler as PrerenderHandlerDefinition,
|
|
237
|
+
prerenderDef: handler.prerenderDef as PrerenderHandlerDefinition,
|
|
238
|
+
isPassthrough: true as const,
|
|
239
|
+
liveHandler: handler.liveHandler as Handler<any, any, TEnv>,
|
|
210
240
|
}
|
|
211
|
-
:
|
|
241
|
+
: isPrerenderHandler(handler)
|
|
242
|
+
? {
|
|
243
|
+
isPrerender: true as const,
|
|
244
|
+
prerenderDef: handler as PrerenderHandlerDefinition,
|
|
245
|
+
}
|
|
246
|
+
: {}),
|
|
212
247
|
...(isStaticHandler(handler)
|
|
213
248
|
? {
|
|
214
249
|
isStaticPrerender: true as const,
|
|
@@ -264,9 +299,9 @@ export function createPathHelper<TEnv>(): PathFn<TEnv> {
|
|
|
264
299
|
registerSearchSchema(routeName, options.search);
|
|
265
300
|
}
|
|
266
301
|
|
|
267
|
-
// Run use callback if
|
|
268
|
-
if (
|
|
269
|
-
const result = store.run(namespace, entry,
|
|
302
|
+
// Run merged use callback (handler.use defaults + explicit use) if present
|
|
303
|
+
if (mergedUse) {
|
|
304
|
+
const result = store.run(namespace, entry, mergedUse)?.flat(3);
|
|
270
305
|
invariant(
|
|
271
306
|
Array.isArray(result) && result.every((item) => isValidUseItem(item)),
|
|
272
307
|
`path() use() callback must return an array of use items [${namespace}]`,
|
|
@@ -4,6 +4,7 @@ import type {
|
|
|
4
4
|
DefaultReverseRouteMap,
|
|
5
5
|
DefaultVars,
|
|
6
6
|
} from "../types/global-namespace.js";
|
|
7
|
+
import type { UseItems, ResponseRouteUseItem } from "../route-types.js";
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
10
|
* Reverse function for response handler contexts.
|
|
@@ -38,9 +39,12 @@ export const RESPONSE_TYPE: unique symbol = Symbol.for(
|
|
|
38
39
|
* Handler that must return Response (not ReactNode).
|
|
39
40
|
* Used by path.image(), path.stream(), path.any() (binary/streaming data).
|
|
40
41
|
*/
|
|
41
|
-
export type ResponseHandler<TParams = Record<string, string>, TEnv = any> = (
|
|
42
|
+
export type ResponseHandler<TParams = Record<string, string>, TEnv = any> = ((
|
|
42
43
|
ctx: ResponseHandlerContext<TParams, TEnv>,
|
|
43
|
-
) => Response | Promise<Response
|
|
44
|
+
) => Response | Promise<Response>) & {
|
|
45
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
46
|
+
use?: () => UseItems<ResponseRouteUseItem>;
|
|
47
|
+
};
|
|
44
48
|
|
|
45
49
|
/**
|
|
46
50
|
* JSON-serializable value type for auto-wrap support.
|
|
@@ -60,9 +64,12 @@ export type JsonValue =
|
|
|
60
64
|
export type JsonResponseHandler<
|
|
61
65
|
TParams = Record<string, string>,
|
|
62
66
|
TEnv = any,
|
|
63
|
-
> = (
|
|
67
|
+
> = ((
|
|
64
68
|
ctx: ResponseHandlerContext<TParams, TEnv>,
|
|
65
|
-
) => JsonValue | Response | Promise<JsonValue | Response
|
|
69
|
+
) => JsonValue | Response | Promise<JsonValue | Response>) & {
|
|
70
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
71
|
+
use?: () => UseItems<ResponseRouteUseItem>;
|
|
72
|
+
};
|
|
66
73
|
|
|
67
74
|
/**
|
|
68
75
|
* Handler for text-based response routes (text, html, xml).
|
|
@@ -71,9 +78,12 @@ export type JsonResponseHandler<
|
|
|
71
78
|
export type TextResponseHandler<
|
|
72
79
|
TParams = Record<string, string>,
|
|
73
80
|
TEnv = any,
|
|
74
|
-
> = (
|
|
81
|
+
> = ((
|
|
75
82
|
ctx: ResponseHandlerContext<TParams, TEnv>,
|
|
76
|
-
) => string | Response | Promise<string | Response
|
|
83
|
+
) => string | Response | Promise<string | Response>) & {
|
|
84
|
+
/** Composable default DSL items merged when the handler is mounted. */
|
|
85
|
+
use?: () => UseItems<ResponseRouteUseItem>;
|
|
86
|
+
};
|
|
77
87
|
|
|
78
88
|
/**
|
|
79
89
|
* Lighter handler context for response routes.
|