@rangojs/router 0.27.0 → 0.29.0

package/dist/types/vite/discovery/build-discovery-phase.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Build discovery phase: the discovery plugin's buildStart, buildApp (post)
+ * and buildEnd hooks.
+ *
+ * buildStart discovers routers through a temp RSC server and writes the
+ * generated route types. When PPR shell candidates exist, it defers closing
+ * that server, and releasing the buildEnv, as a PAIR: the buildApp post hook
+ * releases them after the shell capture (success), buildEnd after an
+ * environment build failure (abort).
+ */
+import type { Rolldown, ViteBuilder } from "vite";
+import type { DiscoveryState } from "./state.js";
+/**
+ * buildStart. Build mode: create a temporary Vite dev server to access the
+ * RSC environment's module runner, then discover routers and generate
+ * manifests. The manifest data is stored for the virtual module's load hook.
+ */
+export declare function buildDiscoveryPhase(s: DiscoveryState, context: Rolldown.PluginContext): Promise<void>;
+/**
+ * buildApp (post). Post-build phases, after EVERY environment bundle is
+ * written.
+ *
+ * 1. Cache versions (router-versions-phase.ts): hashes the server output as
+ *    postprocessBundle left it and writes the per-router table into the
+ *    built version module. First, because phase 2 stamps its entries with
+ *    these versions and reads the same RSC out dir.
+ * 2. PPR shell capture (producer B, #699): the shell prelude embeds built
+ *    client asset URLs (bootstrap entry), which do not exist at buildStart.
+ *    The kept temp server and the buildEnv were deferred AS A PAIR in
+ *    buildStart's finally; this finally is the pair's success-path owner
+ *    (buildEndPhase owns the aborted-build path) — the phase itself is a pure
+ *    producer and tears down only the globals it installs.
+ */
+export declare function postBuildPhase(s: DiscoveryState, builder: ViteBuilder): Promise<void>;
+/**
+ * buildEnd. An environment build failure aborts the builder before the
+ * buildApp post hook — never leak the kept temp server (open handles hang
+ * the CLI) or the deferred buildEnv (a live miniflare proxy).
+ */
+export declare function buildEndPhase(s: DiscoveryState, error: Error | undefined): Promise<void>;

package/dist/types/vite/discovery/build-env.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Build-time env (rango({ buildEnv })): resolution of the option and the
+ * lifetime of the resolved bindings on DiscoveryState. Acquired by dev
+ * discovery (dev-server-phase.ts) and build discovery
+ * (build-discovery-phase.ts).
+ */
+import type { BuildEnvOption, BuildEnvFactoryContext, BuildEnvResult } from "../plugin-types.js";
+import type { DiscoveryState } from "./state.js";
+/**
+ * Resolve the buildEnv option into a concrete { env, dispose? } result.
+ * Handles all four input shapes: false, "auto", factory, plain object.
+ */
+export declare function resolveBuildEnv(option: BuildEnvOption | undefined, factoryCtx: BuildEnvFactoryContext): Promise<BuildEnvResult | null>;
+/**
+ * Acquire build-time env bindings and store on discovery state.
+ * Returns true if env was acquired, false if buildEnv is disabled.
+ */
+export declare function acquireBuildEnv(s: DiscoveryState, command: "serve" | "build", mode: string): Promise<boolean>;
+/**
+ * Release build-time env resources and clear state.
+ */
+export declare function releaseBuildEnv(s: DiscoveryState): Promise<void>;

package/dist/types/vite/discovery/bundle-scan-phase.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Bundle scan phase: the discovery plugin's generateBundle hook.
+ *
+ * Records the inputs of the per-router cache versions (build-versions.ts) for
+ * every environment and, during the RSC build, the RSC entry filename and the
+ * chunks holding Prerender/Static handler exports. closeBundle
+ * (bundle-postprocess.ts) uses them for handler code eviction and prerender
+ * data injection.
+ */
+import type { Rolldown } from "vite";
+import type { DiscoveryState } from "./state.js";
+export declare function bundleScanPhase(s: DiscoveryState, context: Rolldown.PluginContext, bundle: any): void;

package/dist/types/vite/discovery/dev-prerender-cache.d.ts

@@ -34,8 +34,9 @@ export interface DevPrerenderPayloadBodies {
     /** `intercept != 1` response: the route's own segments + handles. */
     main: string;
     /**
-     * `intercept=1` response: main + intercept segments with the MERGED handle
-     * string. Falls back to `main` byte-for-byte when the route has no
+     * `intercept=1` response: the build's intercept variant
+     * (interceptVariantSegments, prerender/store.ts) with the producer's handle
+     * string for it. Falls back to `main` byte-for-byte when the route has no
      * intercept segments — mirroring the endpoint's historical behavior.
      */
     intercept: string;

package/dist/types/vite/discovery/dev-server-phase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Dev server phase: the discovery plugin's configureServer hook.
+ *
+ * Runs dev discovery (the Node RSC runner, or a temp Node server under
+ * Cloudflare, whose RSC env has no runner), serves the dev /__rsc_prerender
+ * and /__rsc_shell endpoints, and watches route files to regenerate the
+ * generated route types and re-run runtime discovery on HMR.
+ */
+import type { ViteDevServer } from "vite";
+import { type DiscoveryState } from "./state.js";
+/** The slice of a Vite environment module graph the route-file watcher reads. */
+interface ModulesByFileGraph {
+    getModulesByFile(file: string): ReadonlySet<unknown> | undefined;
+}
+/**
+ * Whether the dev route-file watcher ignores `file`: it sits in a directory
+ * every discovery scan skips (isInSkippedScanDir) and the RSC graph has not
+ * loaded it. See docs/manifests.md, "A reload no file of the app asked for".
+ */
+export declare function isFileOutsideApp(root: string, file: string, rscGraph: ModulesByFileGraph | undefined): boolean;
+/**
+ * configureServer. Dev mode: discover routers and populate manifest in
+ * memory. Skipped in build mode (buildDiscoveryPhase handles it).
+ */
+export declare function devServerPhase(s: DiscoveryState, server: ViteDevServer): void;
+export {};

package/dist/types/vite/discovery/discovery-errors.d.ts

@@ -95,7 +95,7 @@ export interface DiscoveryFailureReport {
  *   - a transient artifact of a Vite dependency re-optimization racing with boot
  *     discovery (a module read before the entry import resolves to the
  *     pre-optimize copy of the runner graph while createRouter() populated the
- *     post-optimize copy — see router-discovery.ts).
+ *     post-optimize copy — see dev-server-phase.ts).
  *
  * We can only tell them apart when the caller observed the dep optimizer's
  * `browserHash` change across the discovery attempt (`reoptimizeObserved`): a

package/dist/types/vite/discovery/state.d.ts

@@ -117,6 +117,9 @@ export interface DiscoveryState {
     resolvedEntryPath: string | undefined;
     projectRoot: string;
     isBuildMode: boolean;
+    /** Vite's resolved command and mode (configResolved), for resolveBuildEnv. */
+    viteCommand: "serve" | "build";
+    viteMode: string;
     userResolveAlias: any;
     /**
      * Data-only slice of the user's resolved config (resolve.* incl. native
@@ -199,6 +202,15 @@ export interface DiscoveryState {
     devDiscoveryEpoch?: number;
     devServerOrigin: string | null;
     devServer: any;
+    /**
+     * Dev: the pending transition({ when }) definition error, re-sent as the
+     * Vite error overlay until a discovery succeeds (dev-server-phase.ts).
+     */
+    transitionWhenOverlay: {
+        message: string;
+        stack: string;
+        plugin: string;
+    } | null;
     selfWrittenGenFiles: Map<string, {
         at: number;
         hash: string;

package/dist/types/vite/plugins/version-plugin.d.ts

@@ -10,7 +10,7 @@ import { type Plugin } from "vite";
  * Build: exports a placeholder for the per-router versions table. The module
  * holds nothing that varies between builds; the table is written into the
  * built chunk after the server output is hashed (the buildApp post hook in
- * router-discovery.ts). See docs/design/per-app-cache-version.md.
+ * discovery/build-discovery-phase.ts). See docs/design/per-app-cache-version.md.
  * @internal
  */
 export declare function createVersionPlugin(): Plugin;

package/dist/types/vite/plugins/virtual-entries.d.ts

@@ -47,7 +47,7 @@ export declare function getVirtualVersionContent(version: string): string;
 /**
  * Free identifier the production version module ships in place of the table.
  * The versions are hashes of the built server code, so they cannot be part of
- * it: the buildApp post hook (router-discovery.ts) replaces this token in the
+ * it: the buildApp post hook (discovery/build-discovery-phase.ts) replaces this token in the
  * written chunk once the hashes are final (runRouterVersionsPhase,
  * discovery/router-versions-phase.ts). An unreplaced token throws a ReferenceError
  * when the module evaluates, so a build that skipped the step cannot serve

package/dist/types/vite/router-discovery.d.ts

@@ -2,55 +2,16 @@
  * Router Discovery Plugin
  *
  * Vite plugin that discovers router instances at dev/build time via the RSC
- * environment. Delegates to extracted modules for discovery, route types
- * generation, virtual module codegen, and bundle post-processing.
+ * environment. Its hooks call the phase modules over one DiscoveryState:
+ * discovery/dev-server-phase.ts (configureServer),
+ * discovery/build-discovery-phase.ts (buildStart, buildApp post, buildEnd) and
+ * discovery/bundle-scan-phase.ts (generateBundle). Route types generation,
+ * virtual module codegen and bundle post-processing live in their own
+ * discovery/ modules.
  */
-import type { Plugin, ViteDevServer } from "vite";
-import { VIRTUAL_ROUTES_MANIFEST_ID, type DiscoveryState, type PluginOptions } from "./discovery/state.js";
+import type { Plugin } from "vite";
+import { VIRTUAL_ROUTES_MANIFEST_ID, type PluginOptions } from "./discovery/state.js";
 export { VIRTUAL_ROUTES_MANIFEST_ID };
-/** The slice of a Vite environment module graph the route-file watcher reads. */
-interface ModulesByFileGraph {
-    getModulesByFile(file: string): ReadonlySet<unknown> | undefined;
-}
-/**
- * Whether the dev route-file watcher ignores `file`: it sits in a directory
- * every discovery scan skips (isInSkippedScanDir) and the RSC graph has not
- * loaded it. See docs/manifests.md, "A reload no file of the app asked for".
- */
-export declare function isFileOutsideApp(root: string, file: string, rscGraph: ModulesByFileGraph | undefined): boolean;
-/**
- * Create a minimal Vite server for router discovery.
- *
- * Both dev-mode prerender and build-mode discovery need a temp RSC server
- * to import user router files via module runner. This factory centralizes
- * the shared config and the mode-specific differences:
- * - Dev: path-based IDs (no forceBuild), separate cacheDir
- * - Build: hashed IDs (forceBuild), hashClientRefs for production bundles
- *
- * Returns the ViteDevServer instance. Callers access .environments.rsc as needed.
- * @internal Exported for tests.
- */
-export declare function createTempRscServer(state: DiscoveryState, options?: {
-    forceBuild?: boolean;
-    cacheDir?: string;
-    /**
-     * Serve the REAL rango SSR entry (getVirtualEntrySSR) for
-     * "virtual:entry-ssr" instead of the discovery stub, so the dev
-     * /__rsc_shell endpoint can drive captureShellHTML in this server's SSR
-     * realm. Dev-correct by construction: the entry's bootstrap resolves to
-     * plugin-rsc's stable virtual browser-entry URL, which the MAIN dev
-     * server serves to the browser. Loaded lazily — discovery never imports
-     * the SSR entry, so the temp server stays as light as before until a
-     * shell capture actually runs.
-     */
-    realSsrEntry?: boolean;
-}): Promise<ViteDevServer>;
-import type { BuildEnvOption, BuildEnvFactoryContext, BuildEnvResult } from "./plugin-types.js";
-/**
- * Resolve the buildEnv option into a concrete { env, dispose? } result.
- * Handles all four input shapes: false, "auto", factory, plain object.
- */
-export declare function resolveBuildEnv(option: BuildEnvOption | undefined, factoryCtx: BuildEnvFactoryContext): Promise<BuildEnvResult | null>;
 /**
  * Plugin that discovers router instances at dev/build time via the RSC environment.
  *

package/dist/types/vite/temp-rsc-server.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The discovery temp RSC server: a minimal Vite server whose module runner
+ * imports the user's router files. Shared by dev discovery
+ * (discovery/dev-server-phase.ts) and build discovery
+ * (discovery/build-discovery-phase.ts).
+ *
+ * Sits in src/vite/, not src/vite/discovery/: the loader hook URL below
+ * resolves against this module's import.meta.url, and the published bundle
+ * (dist/vite/index.js) ships the hook at the same relative path.
+ */
+import type { ViteDevServer } from "vite";
+import type { DiscoveryState } from "./discovery/state.js";
+/**
+ * Create a minimal Vite server for router discovery.
+ *
+ * Both dev-mode prerender and build-mode discovery need a temp RSC server
+ * to import user router files via module runner. This factory centralizes
+ * the shared config and the mode-specific differences:
+ * - Dev: path-based IDs (no forceBuild), separate cacheDir
+ * - Build: hashed IDs (forceBuild), hashClientRefs for production bundles
+ *
+ * Returns the ViteDevServer instance. Callers access .environments.rsc as needed.
+ * @internal Exported for tests.
+ */
+export declare function createTempRscServer(state: DiscoveryState, options?: {
+    forceBuild?: boolean;
+    cacheDir?: string;
+    /**
+     * Serve the REAL rango SSR entry (getVirtualEntrySSR) for
+     * "virtual:entry-ssr" instead of the discovery stub, so the dev
+     * /__rsc_shell endpoint can drive captureShellHTML in this server's SSR
+     * realm. Dev-correct by construction: the entry's bootstrap resolves to
+     * plugin-rsc's stable virtual browser-entry URL, which the MAIN dev
+     * server serves to the browser. Loaded lazily — discovery never imports
+     * the SSR entry, so the temp server stays as light as before until a
+     * shell capture actually runs.
+     */
+    realSsrEntry?: boolean;
+}): Promise<ViteDevServer>;

package/dist/types/vite/utils/prerender-utils.d.ts

@@ -1,3 +1,4 @@
+import type { LiveIntercept } from "../../router/prerender-match.js";
 export declare function encodePathParam(value: unknown): string;
 /**
  * `ctx.reverse` of a build-time `getParams()`. Substitutes like the dev-mode
@@ -25,6 +26,14 @@ export declare function notifyOnError(registry: Map<string, any>, error: unknown
  * URL / handler name for the log line; `elapsed` is the per-entry duration string.
  */
 export declare function resolvePrerenderError(registry: Map<string, any>, error: any, onError: "fail" | "warn", label: string, elapsed: string, phase: "prerender" | "static", routeKey?: string, pathname?: string): void;
+/**
+ * Warn once per router, route and slot (`warned` holds the keys already
+ * warned) that an intercept over a Prerender() route renders live: the build
+ * did not bake it (matchForPrerender `liveIntercepts`), so its handler runs
+ * per request and one that needs BuildContext fails there. A route in an
+ * unnamed include() has an internal key; the warning names its URL instead.
+ */
+export declare function warnLiveIntercepts(warned: Set<string>, routerId: string, routeName: string, urlPath: string, liveIntercepts: readonly LiveIntercept[] | undefined): void;
 /** Build scratch space, relative to the project root. Never shipped. */
 export declare const RANGO_BUILD_DIR = "node_modules/.rangojs-router-build";
 export declare function resetStagedBuildAssets(projectRoot: string): void;

package/dist/types/wire-params.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The router's `_rsc_*` query parameter names, shared by the browser and the
+ * server graph (dependency free): the one module that spells them
+ * (tools/check-internals.mjs rule rsc-param-literal). The browser writes the
+ * partial-request set through browser/wire-protocol.ts writePartialParams.
+ */
+export declare const WIRE: {
+    /** A navigation or prefetch: `true`. */
+    readonly partial: "_rsc_partial";
+    /** The mounted segment ids, comma-joined. */
+    readonly segments: "_rsc_segments";
+    /** A JS server action's id, in place of `partial`. */
+    readonly action: "_rsc_action";
+    /** The client's build version (version-mismatch reload). */
+    readonly version: "_rsc_v";
+    /** The client's router id (app-switch reload). */
+    readonly routerId: "_rsc_rid";
+    /** The rewrite target of the page on screen (#1144). */
+    readonly rewriteTarget: "_rsc_rt";
+    /** A stale request: `true` (router/navigation-snapshot.ts). */
+    readonly stale: "_rsc_stale";
+    /**
+     * The id of an action's error boundary on screen that a stale request
+     * holds: read only beside `stale` (router/navigation-snapshot.ts).
+     */
+    readonly boundary: "_rsc_boundary";
+    /** A fill request (docs/design/prefetch-false.md): `1`. */
+    readonly fill: "_rsc_fill";
+    /** A loader fetch's loader id (rsc/loader-fetch.ts). */
+    readonly loader: "_rsc_loader";
+    /** A loader fetch's params, JSON: a query param, or a form field on a POST. */
+    readonly loaderParams: "_rsc_loader_params";
+    /** The forced-MISS marker of a degraded PPR shell reload (rsc/shell-serve.ts). */
+    readonly shellMiss: "_rsc_shell";
+    /** A connection warmup HEAD request (browser/connection-warmup.ts). */
+    readonly warmup: "_rsc_warmup";
+};
+/** The prefix every name in WIRE starts with. */
+export declare const WIRE_PREFIX = "_rsc_";