@rangojs/router 0.0.0-experimental.fa8a383a → 0.0.0-experimental.fad716ff

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 (118) hide show
  1. package/README.md +76 -18
  2. package/dist/bin/rango.js +130 -47
  3. package/dist/vite/index.js +526 -168
  4. package/dist/vite/index.js.bak +5448 -0
  5. package/package.json +2 -2
  6. package/skills/cache-guide/SKILL.md +32 -0
  7. package/skills/caching/SKILL.md +8 -0
  8. package/skills/links/SKILL.md +3 -1
  9. package/skills/loader/SKILL.md +53 -43
  10. package/skills/middleware/SKILL.md +2 -0
  11. package/skills/parallel/SKILL.md +67 -0
  12. package/skills/prerender/SKILL.md +110 -68
  13. package/skills/route/SKILL.md +31 -0
  14. package/skills/router-setup/SKILL.md +87 -2
  15. package/skills/typesafety/SKILL.md +10 -0
  16. package/src/__internal.ts +1 -1
  17. package/src/browser/app-version.ts +14 -0
  18. package/src/browser/navigation-bridge.ts +16 -3
  19. package/src/browser/navigation-client.ts +64 -40
  20. package/src/browser/navigation-store.ts +43 -8
  21. package/src/browser/partial-update.ts +37 -4
  22. package/src/browser/prefetch/fetch.ts +8 -2
  23. package/src/browser/prefetch/queue.ts +61 -29
  24. package/src/browser/prefetch/resource-ready.ts +77 -0
  25. package/src/browser/react/Link.tsx +44 -8
  26. package/src/browser/react/NavigationProvider.tsx +13 -4
  27. package/src/browser/react/context.ts +7 -2
  28. package/src/browser/react/use-handle.ts +9 -58
  29. package/src/browser/react/use-router.ts +21 -8
  30. package/src/browser/rsc-router.tsx +26 -3
  31. package/src/browser/scroll-restoration.ts +10 -8
  32. package/src/browser/server-action-bridge.ts +8 -6
  33. package/src/browser/types.ts +27 -5
  34. package/src/build/generate-manifest.ts +6 -6
  35. package/src/build/generate-route-types.ts +3 -0
  36. package/src/build/route-types/include-resolution.ts +8 -1
  37. package/src/build/route-types/router-processing.ts +211 -72
  38. package/src/build/route-types/scan-filter.ts +8 -1
  39. package/src/cache/cache-runtime.ts +15 -11
  40. package/src/cache/cache-scope.ts +46 -5
  41. package/src/cache/taint.ts +55 -0
  42. package/src/client.tsx +2 -56
  43. package/src/context-var.ts +72 -2
  44. package/src/handle.ts +40 -0
  45. package/src/index.rsc.ts +3 -1
  46. package/src/index.ts +12 -0
  47. package/src/prerender/store.ts +5 -4
  48. package/src/prerender.ts +138 -77
  49. package/src/reverse.ts +22 -1
  50. package/src/route-definition/dsl-helpers.ts +42 -19
  51. package/src/route-definition/helpers-types.ts +10 -6
  52. package/src/route-definition/index.ts +3 -0
  53. package/src/route-definition/redirect.ts +9 -1
  54. package/src/route-definition/resolve-handler-use.ts +149 -0
  55. package/src/route-types.ts +11 -0
  56. package/src/router/content-negotiation.ts +100 -1
  57. package/src/router/handler-context.ts +79 -23
  58. package/src/router/intercept-resolution.ts +9 -4
  59. package/src/router/loader-resolution.ts +156 -21
  60. package/src/router/match-api.ts +124 -189
  61. package/src/router/match-middleware/background-revalidation.ts +12 -1
  62. package/src/router/match-middleware/cache-lookup.ts +72 -13
  63. package/src/router/match-middleware/cache-store.ts +21 -4
  64. package/src/router/match-middleware/segment-resolution.ts +53 -0
  65. package/src/router/match-result.ts +11 -5
  66. package/src/router/metrics.ts +6 -1
  67. package/src/router/middleware-types.ts +6 -8
  68. package/src/router/middleware.ts +2 -5
  69. package/src/router/navigation-snapshot.ts +182 -0
  70. package/src/router/prerender-match.ts +110 -10
  71. package/src/router/preview-match.ts +30 -102
  72. package/src/router/request-classification.ts +310 -0
  73. package/src/router/route-snapshot.ts +245 -0
  74. package/src/router/router-context.ts +1 -0
  75. package/src/router/router-interfaces.ts +36 -4
  76. package/src/router/router-options.ts +37 -11
  77. package/src/router/segment-resolution/fresh.ts +101 -18
  78. package/src/router/segment-resolution/helpers.ts +29 -24
  79. package/src/router/segment-resolution/revalidation.ts +122 -26
  80. package/src/router/types.ts +1 -0
  81. package/src/router.ts +54 -5
  82. package/src/rsc/handler.ts +464 -377
  83. package/src/rsc/loader-fetch.ts +23 -3
  84. package/src/rsc/manifest-init.ts +5 -1
  85. package/src/rsc/progressive-enhancement.ts +14 -2
  86. package/src/rsc/rsc-rendering.ts +10 -1
  87. package/src/rsc/server-action.ts +8 -0
  88. package/src/rsc/ssr-setup.ts +2 -2
  89. package/src/rsc/types.ts +9 -1
  90. package/src/server/context.ts +50 -1
  91. package/src/server/handle-store.ts +19 -0
  92. package/src/server/loader-registry.ts +9 -8
  93. package/src/server/request-context.ts +175 -15
  94. package/src/ssr/index.tsx +3 -0
  95. package/src/static-handler.ts +18 -6
  96. package/src/types/cache-types.ts +4 -4
  97. package/src/types/handler-context.ts +137 -33
  98. package/src/types/loader-types.ts +36 -9
  99. package/src/types/route-entry.ts +1 -1
  100. package/src/urls/path-helper-types.ts +9 -2
  101. package/src/urls/path-helper.ts +47 -12
  102. package/src/urls/pattern-types.ts +12 -0
  103. package/src/urls/response-types.ts +16 -6
  104. package/src/use-loader.tsx +73 -4
  105. package/src/vite/discovery/bundle-postprocess.ts +30 -33
  106. package/src/vite/discovery/discover-routers.ts +5 -1
  107. package/src/vite/discovery/prerender-collection.ts +14 -1
  108. package/src/vite/discovery/state.ts +13 -4
  109. package/src/vite/index.ts +4 -0
  110. package/src/vite/plugin-types.ts +60 -5
  111. package/src/vite/plugins/expose-ids/handler-transform.ts +30 -0
  112. package/src/vite/plugins/expose-internal-ids.ts +118 -39
  113. package/src/vite/plugins/performance-tracks.ts +88 -0
  114. package/src/vite/plugins/refresh-cmd.ts +88 -26
  115. package/src/vite/rango.ts +19 -2
  116. package/src/vite/router-discovery.ts +178 -37
  117. package/src/vite/utils/prerender-utils.ts +18 -0
  118. package/src/vite/utils/shared-utils.ts +3 -2
@@ -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.
@@ -1,9 +1,70 @@
1
1
  "use client";
2
2
 
3
- import { useCallback, useContext, useEffect, useRef, useState } from "react";
3
+ import {
4
+ isValidElement,
5
+ useCallback,
6
+ useContext,
7
+ useEffect,
8
+ useMemo,
9
+ useRef,
10
+ useState,
11
+ type ReactNode,
12
+ } from "react";
4
13
  import { OutletContext, type OutletContextValue } from "./outlet-context.js";
5
14
  import type { LoaderDefinition, LoadOptions } from "./types.js";
6
15
 
16
+ /**
17
+ * Extract a specific loader's data from a content ReactNode.
18
+ *
19
+ * When a route registers loaders via loader(), the resolved data lives in
20
+ * the route's OutletProvider (rendered as <Outlet /> content). Parallel
21
+ * slots are siblings of <Outlet />, so they can't find it by walking
22
+ * the parent context chain. This helper traverses wrapper elements
23
+ * (MountContextProvider, ViewTransition, etc.) to reach the OutletProvider
24
+ * and extract the loader data directly.
25
+ */
26
+ const NOT_FOUND = Symbol("not-found");
27
+
28
+ function extractContentLoaderData(
29
+ node: ReactNode,
30
+ loaderId: string,
31
+ ): unknown | typeof NOT_FOUND {
32
+ if (!isValidElement(node)) return NOT_FOUND;
33
+ const props = node.props as Record<string, any> | undefined;
34
+ if (!props) return NOT_FOUND;
35
+
36
+ // Direct OutletProvider with loaderData
37
+ if (props.loaderData && loaderId in props.loaderData) {
38
+ return props.loaderData[loaderId];
39
+ }
40
+
41
+ // LoaderBoundary: loaderIds + loaderDataPromise (already resolved array).
42
+ // When the segment has loading(), loaderData is resolved inside
43
+ // LoaderBoundary via use(). If the promise was pre-awaited (forceAwait
44
+ // or isAction), the prop is a raw array we can index into.
45
+ if (
46
+ props.loaderIds &&
47
+ Array.isArray(props.loaderIds) &&
48
+ props.loaderDataPromise &&
49
+ !(props.loaderDataPromise instanceof Promise)
50
+ ) {
51
+ const idx = (props.loaderIds as string[]).indexOf(loaderId);
52
+ if (idx !== -1) {
53
+ const data = (props.loaderDataPromise as any[])[idx];
54
+ // loaderDataPromise entries may be { ok, data } result objects
55
+ if (data && typeof data === "object" && "ok" in data) {
56
+ return data.ok ? data.data : NOT_FOUND;
57
+ }
58
+ return data;
59
+ }
60
+ }
61
+
62
+ // Traverse into wrapper elements (MountContextProvider, ViewTransition,
63
+ // Suspense wrappers, etc.)
64
+ if (props.children) return extractContentLoaderData(props.children, loaderId);
65
+ return NOT_FOUND;
66
+ }
67
+
7
68
  /**
8
69
  * Payload returned by loader RSC requests
9
70
  */
@@ -71,19 +132,27 @@ function useLoaderInternal<T>(
71
132
  const context = useContext(OutletContext);
72
133
 
73
134
  // Get data from context (SSR/navigation)
74
- const getContextData = useCallback((): T | undefined => {
135
+ const contextData = useMemo((): T | undefined => {
75
136
  let current: OutletContextValue | null | undefined = context;
76
137
  while (current) {
77
138
  if (current.loaderData && loader.$$id in current.loaderData) {
78
139
  return current.loaderData[loader.$$id] as T;
79
140
  }
141
+ // Check content element — the route's OutletProvider is rendered as
142
+ // <Outlet /> content (a child), so its loaderData isn't in the parent
143
+ // chain. Parallel slots need to reach into it to find route-level loaders.
144
+ const contentData = extractContentLoaderData(
145
+ current.content,
146
+ loader.$$id,
147
+ );
148
+ if (contentData !== NOT_FOUND) {
149
+ return contentData as T;
150
+ }
80
151
  current = current.parent;
81
152
  }
82
153
  return undefined;
83
154
  }, [context, loader.$$id]);
84
155
 
85
- const contextData = getContextData();
86
-
87
156
  // Local state for fetched data (from load() calls)
88
157
  const [fetchedData, setFetchedData] = useState<T | undefined>(undefined);
89
158
  const [isLoading, setIsLoading] = useState(false);
@@ -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(
@@ -135,7 +135,11 @@ export async function discoverRouters(
135
135
  continue;
136
136
  }
137
137
 
138
- const manifest = generateManifestFull(router.urlpatterns, routerMountIndex);
138
+ const manifest = generateManifestFull(
139
+ router.urlpatterns,
140
+ routerMountIndex,
141
+ router.__basename ? { urlPrefix: router.__basename } : undefined,
142
+ );
139
143
  routerMountIndex++;
140
144
  allManifests.push({ id, manifest });
141
145
  const routeCount = Object.keys(manifest.routeManifest).length;
@@ -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
  /**
@@ -138,6 +138,36 @@ export function generateExprStubs(
138
138
  };
139
139
  }
140
140
 
141
+ /**
142
+ * Replace handler call expressions with lightweight stub objects on an
143
+ * existing MagicString. Unlike generateExprStubs (which creates its own
144
+ * MagicString and returns the full result), this integrates into the
145
+ * unified transform pipeline so all transforms share one sourcemap.
146
+ */
147
+ export function stubHandlerExprs(
148
+ cfg: HandlerTransformConfig,
149
+ bindings: CreateExportBinding[],
150
+ s: MagicString,
151
+ filePath: string,
152
+ isBuild: boolean,
153
+ ): boolean {
154
+ let hasChanges = false;
155
+ for (const binding of bindings) {
156
+ const exportName = binding.exportNames[0];
157
+ const handlerId = isBuild
158
+ ? hashId(filePath, exportName)
159
+ : `${filePath}#${exportName}`;
160
+
161
+ s.overwrite(
162
+ binding.callExprStart,
163
+ binding.callCloseParenPos + 1,
164
+ `{ __brand: "${cfg.brand}", $$id: "${handlerId}" }`,
165
+ );
166
+ hasChanges = true;
167
+ }
168
+ return hasChanges;
169
+ }
170
+
141
171
  /**
142
172
  * Inject $$id into export const handler calls in RSC environments.
143
173
  */