@rangojs/router 0.0.0-experimental.61 → 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.
Files changed (41) hide show
  1. package/README.md +61 -8
  2. package/dist/bin/rango.js +2 -1
  3. package/dist/vite/index.js +144 -62
  4. package/dist/vite/index.js.bak +5448 -0
  5. package/package.json +14 -15
  6. package/skills/prerender/SKILL.md +110 -68
  7. package/src/__internal.ts +1 -1
  8. package/src/build/generate-manifest.ts +3 -6
  9. package/src/build/route-types/scan-filter.ts +8 -1
  10. package/src/index.rsc.ts +3 -1
  11. package/src/index.ts +8 -0
  12. package/src/prerender/store.ts +5 -4
  13. package/src/prerender.ts +138 -77
  14. package/src/reverse.ts +2 -0
  15. package/src/route-definition/dsl-helpers.ts +37 -18
  16. package/src/route-definition/index.ts +3 -0
  17. package/src/route-definition/resolve-handler-use.ts +149 -0
  18. package/src/route-types.ts +11 -0
  19. package/src/router/handler-context.ts +22 -5
  20. package/src/router/match-api.ts +2 -8
  21. package/src/router/match-middleware/cache-lookup.ts +2 -6
  22. package/src/router/prerender-match.ts +104 -8
  23. package/src/router/router-interfaces.ts +4 -0
  24. package/src/router/segment-resolution/fresh.ts +7 -2
  25. package/src/router/segment-resolution/revalidation.ts +10 -5
  26. package/src/router.ts +9 -1
  27. package/src/server/context.ts +5 -1
  28. package/src/static-handler.ts +18 -6
  29. package/src/types/handler-context.ts +12 -2
  30. package/src/types/route-entry.ts +1 -1
  31. package/src/urls/path-helper-types.ts +5 -1
  32. package/src/urls/path-helper.ts +47 -12
  33. package/src/urls/response-types.ts +16 -6
  34. package/src/vite/discovery/bundle-postprocess.ts +30 -33
  35. package/src/vite/discovery/prerender-collection.ts +14 -1
  36. package/src/vite/discovery/state.ts +13 -4
  37. package/src/vite/index.ts +4 -0
  38. package/src/vite/plugin-types.ts +60 -5
  39. package/src/vite/rango.ts +2 -1
  40. package/src/vite/router-discovery.ts +153 -34
  41. package/src/vite/utils/prerender-utils.ts +2 -0
@@ -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
- : isPrerenderHandler(handler)
183
- ? (handler.handler as Handler<any, any, TEnv>)
184
- : isStaticHandler(handler)
185
- ? (handler.handler as Handler<any, any, TEnv>)
186
- : () => handler;
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
- ...(isPrerenderHandler(handler)
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 provided
268
- if (use && typeof use === "function") {
269
- const result = store.run(namespace, entry, use)?.flat(3);
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.
@@ -31,25 +31,25 @@ export function postprocessBundle(state: DiscoveryState): void {
31
31
  state.rscEntryFileName ?? "index.js",
32
32
  );
33
33
 
34
- // 1. Evict handler code from __prerender-handlers and __static-handlers chunks.
35
- // handlerChunkInfo/staticHandlerChunkInfo are populated by generateBundle
34
+ // 1. Evict handler code from whichever chunks contain handler exports.
35
+ // handlerChunkInfoMap/staticHandlerChunkInfoMap are populated by generateBundle
36
36
  // after the production RSC build. In Vite 6 multi-environment builds, the
37
- // RSC build runs twice (analysis + production). Chunk info is only available
38
- // after the production pass, so we run eviction whenever it becomes available.
37
+ // RSC build runs twice (analysis + production). The maps are cleared at the
38
+ // start of each generateBundle pass so only production data is used here.
39
39
  const evictionTargets: Array<{
40
- info: typeof state.handlerChunkInfo;
40
+ infos: Iterable<import("./state.js").ChunkInfo>;
41
41
  fnName: string;
42
42
  brand: string;
43
43
  label: string;
44
44
  }> = [
45
45
  {
46
- info: state.handlerChunkInfo,
46
+ infos: state.handlerChunkInfoMap.values(),
47
47
  fnName: "Prerender",
48
48
  brand: "prerenderHandler",
49
49
  label: "handler code from RSC bundle",
50
50
  },
51
51
  {
52
- info: state.staticHandlerChunkInfo,
52
+ infos: state.staticHandlerChunkInfoMap.values(),
53
53
  fnName: "Static",
54
54
  brand: "staticHandler",
55
55
  label: "static handler code",
@@ -57,35 +57,32 @@ export function postprocessBundle(state: DiscoveryState): void {
57
57
  ];
58
58
 
59
59
  for (const target of evictionTargets) {
60
- if (!target.info) continue;
61
- const chunkPath = resolve(
62
- state.projectRoot,
63
- "dist/rsc",
64
- target.info.fileName,
65
- );
66
- try {
67
- const code = readFileSync(chunkPath, "utf-8");
68
- const result = evictHandlerCode(
69
- code,
70
- target.info.exports,
71
- target.fnName,
72
- target.brand,
73
- );
74
- if (result) {
75
- writeFileSync(chunkPath, result.code);
76
- const savedKB = (result.savedBytes / 1024).toFixed(1);
77
- console.log(
78
- `[rsc-router] Evicted ${target.label} (${savedKB} KB saved): ${target.info.fileName}`,
60
+ for (const info of target.infos) {
61
+ const chunkPath = resolve(state.projectRoot, "dist/rsc", info.fileName);
62
+ try {
63
+ const code = readFileSync(chunkPath, "utf-8");
64
+ const result = evictHandlerCode(
65
+ code,
66
+ info.exports,
67
+ target.fnName,
68
+ target.brand,
69
+ );
70
+ if (result) {
71
+ writeFileSync(chunkPath, result.code);
72
+ const savedKB = (result.savedBytes / 1024).toFixed(1);
73
+ console.log(
74
+ `[rsc-router] Evicted ${target.label} (${savedKB} KB saved): ${info.fileName}`,
75
+ );
76
+ }
77
+ } catch (replaceErr: any) {
78
+ console.warn(
79
+ `[rsc-router] Failed to evict ${target.label}: ${replaceErr.message}`,
79
80
  );
80
81
  }
81
- } catch (replaceErr: any) {
82
- console.warn(
83
- `[rsc-router] Failed to evict ${target.label}: ${replaceErr.message}`,
84
- );
85
82
  }
86
83
  }
87
- state.handlerChunkInfo = null;
88
- state.staticHandlerChunkInfo = null;
84
+ state.handlerChunkInfoMap.clear();
85
+ state.staticHandlerChunkInfoMap.clear();
89
86
 
90
87
  // 2. Write prerender data as separate importable asset modules
91
88
  // and inject a lazy manifest loader into the RSC entry.
@@ -138,7 +135,7 @@ export function postprocessBundle(state: DiscoveryState): void {
138
135
  // and inject a __STATIC_MANIFEST import into the RSC entry.
139
136
  if (hasStaticData && existsSync(rscEntryPath)) {
140
137
  const rscCode = readFileSync(rscEntryPath, "utf-8");
141
- if (!rscCode.includes("__STATIC_MANIFEST")) {
138
+ if (!rscCode.includes("__static-manifest.js")) {
142
139
  try {
143
140
  const manifestEntries: string[] = [];
144
141
  let totalBytes = copyStagedBuildAssets(
@@ -54,11 +54,12 @@ export async function expandPrerenderRoutes(
54
54
  for (const { manifest } of allManifests) {
55
55
  if (!manifest.prerenderRoutes) continue;
56
56
  const defs = manifest._prerenderDefs || {};
57
+ const passthroughSet = new Set(manifest.passthroughRoutes || []);
57
58
  for (const routeName of manifest.prerenderRoutes) {
58
59
  const pattern = manifest.routeManifest[routeName];
59
60
  if (!pattern) continue;
60
61
  const def = defs[routeName];
61
- const isPassthroughRoute = !!def?.options?.passthrough;
62
+ const isPassthroughRoute = passthroughSet.has(routeName);
62
63
  const hasDynamic = pattern.includes(":") || pattern.includes("*");
63
64
  if (!hasDynamic) {
64
65
  // Static route: use pattern directly (strip trailing slash for URL)
@@ -73,12 +74,21 @@ export async function expandPrerenderRoutes(
73
74
  if (def?.getParams) {
74
75
  try {
75
76
  const buildVars: Record<string, any> = {};
77
+ const buildEnv = state.resolvedBuildEnv;
76
78
  const getParamsCtx = {
77
79
  build: true as const,
80
+ dev: !state.isBuildMode,
78
81
  set: ((keyOrVar: any, value: any) => {
79
82
  contextSet(buildVars, keyOrVar, value);
80
83
  }) as any,
81
84
  reverse: getParamsReverse,
85
+ get env() {
86
+ if (buildEnv !== undefined) return buildEnv;
87
+ throw new Error(
88
+ "[rsc-router] ctx.env is not available during build-time getParams(). " +
89
+ "Configure buildEnv in your rango() plugin options to enable build-time env access.",
90
+ );
91
+ },
82
92
  };
83
93
  const paramsList = await def.getParams(getParamsCtx);
84
94
  const concurrency = def.options?.concurrency ?? 1;
@@ -175,6 +185,7 @@ export async function expandPrerenderRoutes(
175
185
  {},
176
186
  entry.buildVars,
177
187
  entry.isPassthroughRoute,
188
+ state.resolvedBuildEnv,
178
189
  );
179
190
  if (!result) continue;
180
191
 
@@ -326,6 +337,8 @@ export async function renderStaticHandlers(
326
337
  def.handler,
327
338
  def.$$id,
328
339
  (def as any).$$routePrefix,
340
+ state.resolvedBuildEnv,
341
+ !state.isBuildMode,
329
342
  );
330
343
  if (result) {
331
344
  const hasHandles = Object.keys(result.handles).length > 0;
@@ -16,6 +16,10 @@ export interface PluginOptions {
16
16
  // Mutable ref for deferred auto-discovery (node preset).
17
17
  // The auto-discover config() hook populates this before configResolved.
18
18
  routerPathRef?: { path?: string };
19
+ /** Build-time env option from rango() config. */
20
+ buildEnv?: import("../plugin-types.js").BuildEnvOption;
21
+ /** Deployment preset (needed for buildEnv "auto" resolution). */
22
+ preset?: "node" | "cloudflare";
19
23
  }
20
24
 
21
25
  export interface PrecomputedEntry {
@@ -56,8 +60,8 @@ export interface DiscoveryState {
56
60
 
57
61
  prerenderManifestEntries: Record<string, string> | null;
58
62
  staticManifestEntries: Record<string, string> | null;
59
- handlerChunkInfo: ChunkInfo | null;
60
- staticHandlerChunkInfo: ChunkInfo | null;
63
+ handlerChunkInfoMap: Map<string, ChunkInfo>;
64
+ staticHandlerChunkInfoMap: Map<string, ChunkInfo>;
61
65
  rscEntryFileName: string | null;
62
66
  resolvedPrerenderModules: Map<string, string[]> | undefined;
63
67
  resolvedStaticModules: Map<string, string[]> | undefined;
@@ -67,6 +71,11 @@ export interface DiscoveryState {
67
71
  devServer: any;
68
72
  selfWrittenGenFiles: Map<string, { at: number; hash: string }>;
69
73
  SELF_WRITE_WINDOW_MS: number;
74
+
75
+ /** Resolved build-time env bindings (set during buildStart/configureServer). */
76
+ resolvedBuildEnv?: Record<string, unknown>;
77
+ /** Cleanup function for build-time env resources (e.g., miniflare). */
78
+ buildEnvDispose?: (() => Promise<void> | void) | null;
70
79
  }
71
80
 
72
81
  export function createDiscoveryState(
@@ -93,8 +102,8 @@ export function createDiscoveryState(
93
102
 
94
103
  prerenderManifestEntries: null,
95
104
  staticManifestEntries: null,
96
- handlerChunkInfo: null,
97
- staticHandlerChunkInfo: null,
105
+ handlerChunkInfoMap: new Map(),
106
+ staticHandlerChunkInfoMap: new Map(),
98
107
  rscEntryFileName: null,
99
108
  resolvedPrerenderModules: undefined,
100
109
  resolvedStaticModules: undefined,
package/src/vite/index.ts CHANGED
@@ -13,4 +13,8 @@ export type {
13
13
  RangoNodeOptions,
14
14
  RangoCloudflareOptions,
15
15
  RangoOptions,
16
+ BuildEnvOption,
17
+ BuildEnvFactory,
18
+ BuildEnvFactoryContext,
19
+ BuildEnvResult,
16
20
  } from "./plugin-types.js";
@@ -1,3 +1,54 @@
1
+ // -- Build-time environment types -------------------------------------------
2
+
3
+ /**
4
+ * Context passed to a buildEnv factory function.
5
+ * Provides Vite config details for conditional env setup.
6
+ */
7
+ export interface BuildEnvFactoryContext {
8
+ /** Vite project root directory. */
9
+ root: string;
10
+ /** Vite mode (e.g. "development", "production"). */
11
+ mode: string;
12
+ /** Vite command ("serve" for dev, "build" for production). */
13
+ command: "serve" | "build";
14
+ /** Router deployment preset. */
15
+ preset: "node" | "cloudflare";
16
+ }
17
+
18
+ /**
19
+ * Factory function that creates build-time environment bindings.
20
+ * Called once at plugin startup. Return `dispose` to clean up resources.
21
+ */
22
+ export type BuildEnvFactory = (
23
+ ctx: BuildEnvFactoryContext,
24
+ ) => Promise<BuildEnvResult> | BuildEnvResult;
25
+
26
+ /**
27
+ * Result of resolving build-time environment bindings.
28
+ */
29
+ export interface BuildEnvResult {
30
+ /** Environment bindings available to Prerender/Static handlers via ctx.env. */
31
+ env: Record<string, unknown>;
32
+ /** Called after build completes to clean up resources (e.g., miniflare). */
33
+ dispose?: () => Promise<void> | void;
34
+ }
35
+
36
+ /**
37
+ * Build-time environment configuration for Prerender and Static handlers.
38
+ *
39
+ * - `false` (default): no build-time env, `ctx.env` throws.
40
+ * - `"auto"`: calls `wrangler.getPlatformProxy()` (cloudflare preset only).
41
+ * - Object: used directly as `ctx.env` during build.
42
+ * - Factory: called once at startup, must return `{ env, dispose? }`.
43
+ */
44
+ export type BuildEnvOption =
45
+ | false
46
+ | "auto"
47
+ | Record<string, unknown>
48
+ | BuildEnvFactory;
49
+
50
+ // -- Plugin options ---------------------------------------------------------
51
+
1
52
  /**
2
53
  * Base options shared by all presets
3
54
  */
@@ -9,12 +60,16 @@ interface RangoBaseOptions {
9
60
  banner?: boolean;
10
61
 
11
62
  /**
12
- * Generate named-routes.gen.ts by parsing url modules at startup.
13
- * Provides type-safe Handler<"name"> and href() without executing router code.
14
- * Set to `false` to disable (run `npx rango extract-names` manually instead).
15
- * @default true
63
+ * Environment bindings available to Prerender and Static handlers at build
64
+ * time via `ctx.env`. Applies to both production build and dev on-demand
65
+ * prerender (`/__rsc_prerender`).
66
+ *
67
+ * This is the build-time env supplied by the Vite plugin, not the live
68
+ * request env. It is shared across all prerender invocations for the build.
69
+ *
70
+ * @default false
16
71
  */
17
- staticRouteTypesGeneration?: boolean;
72
+ buildEnv?: BuildEnvOption;
18
73
  }
19
74
 
20
75
  /**
package/src/vite/rango.ts CHANGED
@@ -453,7 +453,8 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
453
453
  createRouterDiscoveryPlugin(discoveryEntryPath, {
454
454
  routerPathRef: discoveryRouterRef,
455
455
  enableBuildPrerender: prerenderEnabled,
456
- staticRouteTypesGeneration: resolvedOptions.staticRouteTypesGeneration,
456
+ buildEnv: options?.buildEnv,
457
+ preset,
457
458
  }),
458
459
  );
459
460