@rsc-kit/core 0.1.0

package/dist/prerender.d.ts

@@ -0,0 +1,138 @@
+import type { ManifestRoute, RouteManifest } from './manifest.js';
+export interface PrerenderEngine {
+    manifest?(): RouteManifest;
+    getStaticParams?(component: string): Promise<Record<string, string>[] | null>;
+    handleRscPprShell(component: string, props?: Record<string, unknown>, layouts?: {
+        component: string;
+        props: Record<string, unknown>;
+    }[], loadings?: string[], parallelSlots?: Record<string, string>, pageKey?: string, 
+    /** How long to render before taking what has flushed. Defaults to the full budget. */
+    budgetMs?: number): Promise<{
+        shellHtml: string;
+        timedOut: boolean;
+        usedDynamicApis: boolean;
+        error?: string;
+    }>;
+    handleRsc(component: string, props?: Record<string, unknown>, callbackSocket?: string | null, layouts?: {
+        component: string;
+        props: Record<string, unknown>;
+    }[], loadings?: string[], parallelSlots?: Record<string, string>, from?: number, pageKey?: string, bootstrap?: boolean): Promise<{
+        body: string;
+        rscPayload: string;
+        clientComponents: string[];
+    }>;
+    handleRscPayload(component: string, props?: Record<string, unknown>, layouts?: {
+        component: string;
+        props: Record<string, unknown>;
+    }[], loadings?: string[], parallelSlots?: Record<string, string>, from?: number, pageKey?: string): Promise<{
+        rscPayload: string;
+    }>;
+}
+export interface PrerenderOptions {
+    engine: PrerenderEngine;
+    /**
+     * Where the output goes, as a sink rather than a directory.
+     *
+     * `writeTo` in `@rsc-kit/core/files` is the one for a disk, which is what a
+     * build normally wants. A function because the read side is one — a host
+     * that supplies a reader should be able to supply the matching writer —
+     * and because a test can hand it a Map instead of a temp directory.
+     */
+    write: (name: string, contents: string) => Promise<void> | void;
+    /** The route table. Defaults to the one the bundle carries. */
+    manifest?: RouteManifest;
+    /**
+     * Props for a page at build time.
+     *
+     * There is no request here, which is the point: anything a page needs that
+     * only a request can supply is exactly what makes it un-freezable. Defaults
+     * to the url params alone.
+     */
+    props?: (route: ManifestRoute, params: Record<string, string>) => Record<string, unknown>;
+    /**
+     * How many routes to render at once. Defaults to 6; 1 renders sequentially.
+     *
+     * Worth lowering when the pages talk to something that will not enjoy six
+     * concurrent callers — a local database, a rate-limited API.
+     */
+    concurrency?: number;
+    /** Identifies the build in what gets written, so a stale page can be spotted. */
+    version?: string;
+    /** Called as each url is decided, for build output. */
+    onResult?: (result: PrerenderResult) => void;
+}
+/**
+ * The build's refusal to store a route it cannot answer ahead of time.
+ *
+ * Thrown rather than reported, because the alternative is a category: a bucket
+ * of routes that quietly render per request, which is where the slow ones go
+ * to be forgotten. Every route is either stored or has said it will not be.
+ */
+export declare class NotPrerenderable extends Error {
+    readonly routes: PrerenderResult[];
+    constructor(routes: PrerenderResult[]);
+}
+export interface PrerenderResult {
+    url: string;
+    component: string;
+    /**
+     * frozen — the whole page is on disk.
+     * shell — the chrome is on disk and the rest is rendered per request.
+     * blocked — nothing could be stored. Fails the build.
+     * error — the render itself failed, or the build refused what it produced.
+     *
+     * There is no outcome for "rendered per request". A route that cannot be
+     * stored has its boundary in the wrong place, and the fix is to move it —
+     * not to declare the problem away, which is how the slow ones get forgotten.
+     */
+    type: 'frozen' | 'shell' | 'blocked' | 'error';
+    reason: string | null;
+    /**
+     * Something worth knowing that is not a failure.
+     *
+     * The one that matters: a page whose only boundary is the root loading.tsx.
+     * It is stored, so the build has nothing to refuse — but the fallback that
+     * caught it belongs to the whole app rather than to this page, and every
+     * page in the app shows the same thing while this one's data arrives.
+     */
+    warning?: string;
+}
+/**
+ * The file name a route's shell is stored under, with params standing in for
+ * themselves: /posts/[slug] → posts/_slug_.
+ *
+ * A shell contains nothing that varies by param — everything that does is
+ * behind a boundary the client fills — so one shell serves every url the
+ * route matches, including the ones the app never listed.
+ */
+export declare function patternKey(route: ManifestRoute): string;
+/** Close a document the render was aborted in the middle of. */
+export declare function closeDocument(html: string): string;
+/**
+ * The file name a url is stored under: / → index, /a/b → a/b.
+ *
+ * Refuses a key that could leave the directory it is written into. The input is
+ * whatever generateStaticParams() returned — typically slugs from a database or
+ * a CMS — so a record named `../../../../etc/cron.d/x` is an arbitrary file
+ * write on the build machine with content the same record influences.
+ *
+ * Checked here rather than in the writer, because the writer is supplied by the
+ * host: `writeTo` on disk does the obvious thing, but a KV or edge binding has
+ * no notion of a parent directory and no reason to look for one.
+ */
+export declare function pathKey(url: string): string;
+/**
+ * Substitute params into a route's segments to get a concrete url.
+ *
+ * A param is one segment, so a value carrying a slash is not a deeper url — it
+ * is a value that was never a single segment. A catch-all is the exception and
+ * is spelled as one in the route.
+ */
+export declare function urlFor(route: ManifestRoute, params: Record<string, string>): string;
+export declare function urlsToBuild(manifest: RouteManifest, engine: PrerenderEngine): Promise<{
+    route: ManifestRoute;
+    params: Record<string, string>;
+    url: string;
+}[]>;
+export declare function prerender(options: PrerenderOptions): Promise<PrerenderResult[]>;
+//# sourceMappingURL=prerender.d.ts.map

package/dist/prerender.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerender.d.ts","sourceRoot":"","sources":["../src/prerender.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AA8BjE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,aAAa,CAAA;IAC1B,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,CAAA;IAC7E,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EAAE,EACjE,QAAQ,CAAC,EAAE,MAAM,EAAE,EACnB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,OAAO,CAAC,EAAE,MAAM;IAChB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,eAAe,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC9F,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,EAC9B,OAAO,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EAAE,EACjE,QAAQ,CAAC,EAAE,MAAM,EAAE,EACnB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;IAC5E,gBAAgB,CACd,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EAAE,EACjE,QAAQ,CAAC,EAAE,MAAM,EAAE,EACnB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,eAAe,CAAA;IACvB;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC/D,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzF;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAA;CAC7C;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,SAAgB,MAAM,EAAE,eAAe,EAAE,CAAA;IAEzC,YAAY,MAAM,EAAE,eAAe,EAAE,EAWpC;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;;;;;OASG;IACH,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAA;IAC9C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,CAIvD;AAED,gEAAgE;AAChE,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOlD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW3C;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAiBnF;AAoBD,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC;IAAE,KAAK,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,CA+BlF;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CA4TrF"}

package/dist/prerender.js

@@ -0,0 +1,387 @@
+// Rendering pages at build time, for a JavaScript host.
+//
+// The engine does the rendering; this decides what to render and what to do
+// with the result. Two decisions, and both are easy to get subtly wrong:
+//
+// Which urls exist — a route with no params is one url, a route with params is
+// however many `generateStaticParams` returns, and a route with params that
+// declares none cannot be prerendered at all.
+//
+// Whether a page can be frozen — asked by rendering it, never declared. The
+// shell probe replaces the host global with a promise that never resolves, so
+// a page that reaches for request data suspends and says so by doing it. A
+// page that simply takes too long says so by not finishing.
+//
+// The file layout matches the one Laravel writes, so both hosts serve the same
+// shapes and anything that reads them works for either.
+import { withRedirect } from './redirect.js';
+import { withCache } from './cache.js';
+import { requestWasRead, withRequest } from './request.js';
+/** What a prerenderer needs from the built bundle, beyond serving a request. */
+/**
+ * How long the root-fallback diagnostic waits before answering.
+ *
+ * Short on purpose: the question is whether anything painted, not what. See
+ * the call site.
+ */
+const ROOT_FALLBACK_BUDGET_MS = 200;
+/**
+ * How many routes render at once.
+ *
+ * Each is a full React render, so this trades memory and CPU for wall time.
+ * The gain flattens almost immediately — measured on a twelve-route example:
+ * 10.2 s sequential, 4.1 s at four, 4.0 s at six, 4.0 s at twelve, beyond
+ * which one route's own serial chain is the floor.
+ *
+ * Four rather than six because the difference between them is inside the
+ * noise, and the smaller number leaves room for whatever else is running.
+ * A build is rarely the only thing on a machine — it shares CI with other
+ * jobs, and it shares a laptop with the test suite that renders its own
+ * fixtures, where six was enough to turn a two-second budget into a timeout.
+ */
+const DEFAULT_PRERENDER_CONCURRENCY = 4;
+/**
+ * The build's refusal to store a route it cannot answer ahead of time.
+ *
+ * Thrown rather than reported, because the alternative is a category: a bucket
+ * of routes that quietly render per request, which is where the slow ones go
+ * to be forgotten. Every route is either stored or has said it will not be.
+ */
+export class NotPrerenderable extends Error {
+    routes;
+    constructor(routes) {
+        super('Some routes could not be prerendered:\n\n' +
+            routes.map((r) => `  ${r.url} — ${r.reason ?? 'failed to render'}`).join('\n') +
+            '\n\nEach one reads request data — params, headers, cookies, or the host —\n' +
+            'above every Suspense boundary, so nothing can paint without it.\n\n' +
+            'Put the part that waits inside <Suspense>, or add a loading.tsx beside\n' +
+            'the page, so there is something to store while the rest arrives.\n');
+        this.name = 'NotPrerenderable';
+        this.routes = routes;
+    }
+}
+/**
+ * The file name a route's shell is stored under, with params standing in for
+ * themselves: /posts/[slug] → posts/_slug_.
+ *
+ * A shell contains nothing that varies by param — everything that does is
+ * behind a boundary the client fills — so one shell serves every url the
+ * route matches, including the ones the app never listed.
+ */
+export function patternKey(route) {
+    const parts = route.segments.map((s) => (s.type === 'static' ? s.value : `_${s.value}_`));
+    return parts.join('/') || 'index';
+}
+/** Close a document the render was aborted in the middle of. */
+export function closeDocument(html) {
+    let out = html;
+    if (!/<\/body>/i.test(out) && /<body/i.test(out))
+        out += '</body>';
+    if (!/<\/html>/i.test(out) && /<html/i.test(out))
+        out += '</html>';
+    return out;
+}
+/**
+ * The file name a url is stored under: / → index, /a/b → a/b.
+ *
+ * Refuses a key that could leave the directory it is written into. The input is
+ * whatever generateStaticParams() returned — typically slugs from a database or
+ * a CMS — so a record named `../../../../etc/cron.d/x` is an arbitrary file
+ * write on the build machine with content the same record influences.
+ *
+ * Checked here rather than in the writer, because the writer is supplied by the
+ * host: `writeTo` on disk does the obvious thing, but a KV or edge binding has
+ * no notion of a parent directory and no reason to look for one.
+ */
+export function pathKey(url) {
+    const key = url.replace(/^\/+|\/+$/g, '') || 'index';
+    if (key.split('/').some((segment) => segment === '..' || segment === '.')) {
+        throw new Error('Refusing to store ' + JSON.stringify(url) + ': the path leaves the output directory. ' +
+            'A url segment came from generateStaticParams() or a route param and contains "..".');
+    }
+    return key;
+}
+/**
+ * Substitute params into a route's segments to get a concrete url.
+ *
+ * A param is one segment, so a value carrying a slash is not a deeper url — it
+ * is a value that was never a single segment. A catch-all is the exception and
+ * is spelled as one in the route.
+ */
+export function urlFor(route, params) {
+    const parts = route.segments.map((segment) => {
+        if (segment.type === 'static')
+            return segment.value;
+        const value = params[segment.value] ?? '';
+        if (segment.type !== 'catchAll' && /[/\\]/.test(value)) {
+            throw new Error('The ' + segment.value + ' param is ' + JSON.stringify(value) + ', which is not one url ' +
+                'segment. A value with a slash in it has to be a catch-all route, or be encoded.');
+        }
+        return value;
+    });
+    return '/' + parts.filter((p) => p !== '').join('/');
+}
+/**
+ * Every url this build should attempt, and the params each was built from.
+ *
+ * A parameterised route that declares no `generateStaticParams` yields
+ * nothing — not an error: rendering on demand is a legitimate answer, and the
+ * alternative is guessing at slugs the app never listed.
+ */
+/** Stand-in values for a route whose real urls were never listed. */
+function placeholders(route) {
+    const params = {};
+    for (const segment of route.segments) {
+        if (segment.type !== 'static')
+            params[segment.value] = '_';
+    }
+    return params;
+}
+export async function urlsToBuild(manifest, engine) {
+    const entries = [];
+    for (const route of manifest.routes) {
+        const parameterised = route.segments.some((s) => s.type !== 'static');
+        if (!parameterised) {
+            entries.push({ route, params: {}, url: urlFor(route, {}) });
+            continue;
+        }
+        // A route that lists no urls still gets one attempt, with placeholder
+        // params, so it can ship a shell. Nothing in a shell varies by param.
+        if (!route.staticParams) {
+            entries.push({ route, params: placeholders(route), url: urlFor(route, placeholders(route)) });
+            continue;
+        }
+        const sets = (await engine.getStaticParams?.(route.component)) ?? null;
+        // Null means the route declares none, so it is rendered on demand. An
+        // empty array means the app looked and there is nothing to build — both
+        // produce no files, and only one of them is a mistake to warn about.
+        if (!sets)
+            continue;
+        for (const params of sets) {
+            entries.push({ route, params, url: urlFor(route, params) });
+        }
+    }
+    return entries;
+}
+export async function prerender(options) {
+    const { engine, write, version } = options;
+    const manifest = options.manifest ?? engine.manifest?.();
+    if (!manifest) {
+        throw new Error('No route table. Pass `manifest`, or build with a plugin version that embeds one.');
+    }
+    const entries = await urlsToBuild(manifest, engine);
+    const results = new Array(entries.length);
+    // Rendered a few at a time rather than one after another.
+    //
+    // Most of a build is this loop, and most of this loop is waiting: a page
+    // whose shell is decided by a two-second budget spends two seconds doing
+    // nothing while the next page waits its turn. Nothing here is shared between
+    // routes — the probe's stand-in host is held in async context, so concurrent
+    // renders cannot see each other's — which is what makes overlapping them
+    // safe, and was not true until it was scoped.
+    //
+    // Bounded, because each one is a full React render: unbounded would turn a
+    // large site into as many concurrent renders as it has pages.
+    //
+    // Results are placed by index, so what a build reports does not depend on
+    // which page happened to finish first.
+    const concurrency = Math.max(1, options.concurrency ?? DEFAULT_PRERENDER_CONCURRENCY);
+    let next = 0;
+    const worker = async () => {
+        while (true) {
+            const index = next++;
+            if (index >= entries.length)
+                return;
+            const { route, params, url } = entries[index];
+            results[index] = await prerenderOne(route, params, url);
+            options.onResult?.(results[index]);
+        }
+    };
+    await Promise.all(Array.from({ length: Math.min(concurrency, entries.length) }, worker));
+    const refused = results.filter((r) => r.type === 'blocked');
+    if (refused.length > 0) {
+        throw new NotPrerenderable(refused);
+    }
+    return results;
+    async function prerenderOne(route, params, url) {
+        const props = options.props ? options.props(route, params) : params;
+        const layouts = route.layouts.map((component) => ({ component, props: {} }));
+        const unlistedNow = route.segments.some((seg) => seg.type !== 'static') && !route.staticParams;
+        const said = (type, reason) => ({
+            // A route standing in for many urls reports the pattern. Reporting the
+            // placeholder url instead prints `/posts/_`, which looks like a page.
+            url: unlistedNow ? '/' + patternKey(route) : url,
+            component: route.component,
+            type,
+            reason,
+        });
+        const unlisted = route.segments.some((seg) => seg.type !== 'static') && !route.staticParams;
+        // Classify by rendering, never by asking. The probe is cheap and cannot
+        // hang: anything still suspended when its budget expires is the answer.
+        //
+        // Wrapped so a redirect has somewhere to be recorded. Reading the scope
+        // rather than inspecting the thrown error is the only thing that works
+        // from out here: React catches what a component throws and re-raises its
+        // own, whose message is stripped in production — so a redirect above the
+        // boundaries arrives as a generic render failure, and one from inside a
+        // boundary never arrives at all.
+        // A build renders each url once, and each gets its own table: two routes
+        // must not share an answer just because they were built in the same run.
+        // No request, deliberately: a page that reads one is caught below rather
+        // than frozen holding whatever the build machine happened to send.
+        const { shell, redirected, readRequest } = await withRequest(null, () => withCache(() => withRedirect(async (taken) => {
+            try {
+                return {
+                    shell: await engine.handleRscPprShell(route.component, props, layouts, route.loadings, route.slots, 
+                    // Only when this shell serves one url. A parameterised route's
+                    // shell is shared, so baking a url into it would put the wrong one
+                    // on every page but the one that happened to be built.
+                    unlistedNow ? '' : url),
+                    redirected: taken(),
+                    readRequest: requestWasRead(),
+                };
+            }
+            catch (error) {
+                // A guard refusing throws out of the probe rather than being caught
+                // inside it: middleware run before the render, so there is no render yet
+                // to capture the failure. A refusal is a classification, not a build
+                // error — the route is one that cannot be frozen.
+                const refused = taken();
+                if (!refused)
+                    throw error;
+                return { shell: null, redirected: refused, readRequest: requestWasRead() };
+            }
+        })));
+        // A page that leaves rather than renders is not a build failure, and it is
+        // not something to freeze either: what would be stored is the redirect's
+        // own emptiness, served for ever to everyone. Rendered on demand instead,
+        // where the redirect can actually happen.
+        /**
+         * Did this page's own boundary catch the wait, or the app's?
+         *
+         * A root loading.tsx wraps every page, so a page that blocks — or throws,
+         * which is how a client hook says it has no server answer — is caught
+         * whatever it does. The route is stored either way and the build has
+         * nothing to refuse, which makes a page whose boundary is in the wrong
+         * place look exactly like one whose boundary is right.
+         *
+         * Asked by rendering again without the root fallback, and only for a route
+         * that has no closer one.
+         *
+         * Only for a route that came out as a shell. A frozen one rendered to
+         * completion with the root boundary present, and removing a boundary
+         * cannot stop a render that already finished — so the second probe
+         * finishes too, its markup is the whole document, and the emptiness test
+         * cannot fire. It was being paid for anyway: a second full render of every
+         * frozen page, which on a site whose pages are mostly frozen is most of
+         * the prerender.
+         */
+        async function withRootFallbackChecked(result) {
+            if (result.type !== 'shell')
+                return result;
+            if (route.loadings.length !== 1 || !engine.handleRscPprShell)
+                return result;
+            // A tenth of the shell budget, because this is a different question.
+            //
+            // Deciding what a page's shell IS means waiting out everything that can
+            // resolve. Asking whether anything paints at all without the root
+            // fallback is a boolean about the first flush — and a page that paints,
+            // paints immediately. Given the full budget it cost two seconds a route
+            // to learn what the first millisecond already said, which on this
+            // example was 40% of the entire prerender.
+            const withoutRoot = await withRequest(null, () => withCache(() => withRedirect(async () => engine.handleRscPprShell(route.component, props, layouts, [], route.slots, url, ROOT_FALLBACK_BUDGET_MS)))).catch(() => null);
+            if (withoutRoot && closeDocument(withoutRoot.shellHtml.trim()) === '') {
+                result.warning =
+                    'nothing painted without the root loading.tsx — the fallback the whole app shares ' +
+                        'is standing in for this page. Put a boundary where the waiting is.';
+            }
+            return result;
+        }
+        // A route that only redirects still has an answer to freeze — the answer
+        // is the redirect, not a page. Rendering it per request re-derives a
+        // constant, and on a static host there would be nothing to derive it with.
+        if (redirected) {
+            await write(`${pathKey(url)}.redirect.json`, JSON.stringify({ status: redirected.status, location: redirected.location }));
+            return said('frozen', `redirects to ${redirected.location}`);
+        }
+        if (!shell)
+            return said('error', 'refused before it rendered');
+        if (shell.error)
+            return said('error', shell.error);
+        // A timeout is the ordinary path for a page that streams, not a failure:
+        // the probe hands the page a host global that never resolves, React
+        // flushes everything that does not depend on it, and the abort happens
+        // once there is nothing left to flush. So the captured markup IS the
+        // shell — layouts, static content, and the fallbacks standing in for what
+        // has not arrived.
+        if (shell.timedOut) {
+            const body = closeDocument(shell.shellHtml.trim());
+            // Nothing was flushed before the page blocked, so there is no shell to
+            // ship — a page that blocks above every boundary can only be rendered on
+            // demand. `reaches for the host` is the specific reason when both are
+            // true; a page that merely ran long says the other thing.
+            if (body === '') {
+                return said('blocked', (readRequest
+                    ? 'reads the request'
+                    : shell.usedDynamicApis
+                        ? 'reaches for the host'
+                        : 'blocks') +
+                    ' before anything can paint, so there is no shell to store');
+            }
+            await writeShell(route, url, body);
+            return await withRootFallbackChecked(said('shell', null));
+        }
+        // Rendered whole, with params that were invented because the route listed
+        // none. Freezing that stores a page whose id is literally `_`, and a shell
+        // is no better: the value is in the markup rather than behind a boundary
+        // the client fills. A route reaches this only by rendering its params
+        // before it can paint, which is exactly the shape that cannot be shared
+        // across urls.
+        if (unlisted) {
+            return said('blocked', 'renders its params before it can paint, and lists no urls to build');
+        }
+        const shipsJs = route.clientJs !== false;
+        const rendered = await engine.handleRsc(route.component, props, null, layouts, 
+        // Not empty: a page whose layout declares a parallel slot renders without
+        // it otherwise, and nothing says so — the page comes out whole apart from
+        // the missing region.
+        route.loadings, route.slots, 0, url, shipsJs);
+        // A client component without a runtime is inert markup — a button that
+        // does nothing. Refused rather than shipped, and named, because they are
+        // usually inherited from a shared layout rather than written on the page.
+        if (!shipsJs && rendered.clientComponents.length > 0) {
+            return said('error', `ships no client runtime, but the tree renders ${rendered.clientComponents.join(', ')}. ` +
+                'These usually come from a shared layout rather than the page itself.');
+        }
+        const key = pathKey(url);
+        await write(`${key}.html`, rendered.body);
+        await write(`${key}.flight`, rendered.rscPayload);
+        // One variant per depth the client might already hold. Without them every
+        // navigation to a prerendered route is a whole document, which replaces the
+        // root and unmounts the pages retained behind it — so going back does not
+        // restore the form you were filling in. Most routes in a real app are
+        // prerendered, which makes this the common path rather than an edge case.
+        for (let depth = 1; depth <= route.layouts.length; depth++) {
+            const { rscPayload } = await engine.handleRscPayload(route.component, props, layouts, route.loadings, route.slots, depth, url);
+            await write(`${key}.seg${depth}.flight`, rscPayload);
+        }
+        await write(`${key}.meta.json`, JSON.stringify({ layouts: route.layouts, component: route.component, version: version ?? null }, null, 2));
+        return await withRootFallbackChecked(said('frozen', null));
+    }
+    /**
+     * Freeze a shell, under the url when it is one and under the route's pattern
+     * when it stands for many.
+     *
+     * A route whose urls were never listed still gets a shell: nothing in it
+     * varies by param, so the same markup is correct for every url the route
+     * matches. That is most of the value — the routes you can enumerate are the
+     * ones you could already freeze whole.
+     */
+    async function writeShell(route, url, body) {
+        const parameterised = route.segments.some((s) => s.type !== 'static');
+        const key = parameterised && !route.staticParams ? patternKey(route) : pathKey(url);
+        await write(`${key}.ppr.html`, body);
+        await write(`${key}.ppr-meta.json`, JSON.stringify({ layouts: route.layouts, component: route.component, parameterised, version: version ?? null }, null, 2));
+    }
+}
+//# sourceMappingURL=prerender.js.map

package/dist/prerender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerender.js","sourceRoot":"","sources":["../src/prerender.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,4EAA4E;AAC5E,yEAAyE;AACzE,EAAE;AACF,+EAA+E;AAC/E,4EAA4E;AAC5E,8CAA8C;AAC9C,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,2EAA2E;AAC3E,4DAA4D;AAC5D,EAAE;AACF,+EAA+E;AAC/E,wDAAwD;AAGxD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1D,gFAAgF;AAChF;;;;;GAKG;AACH,MAAM,uBAAuB,GAAG,GAAG,CAAA;AAEnC;;;;;;;;;;;;;GAaG;AACH,MAAM,6BAA6B,GAAG,CAAC,CAAA;AAuEvC;;;;;;GAMG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzB,MAAM,CAAmB;IAEzC,YAAY,MAAyB;QACnC,KAAK,CACH,2CAA2C;YACzC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,MAAM,IAAI,kBAAkB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9E,6EAA6E;YAC7E,qEAAqE;YACrE,0EAA0E;YAC1E,oEAAoE,CACvE,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AA4BD;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,KAAoB;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;IAEzF,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,CAAA;AACnC,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,IAAI,GAAG,GAAG,IAAI,CAAA;IAEd,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,GAAG,IAAI,SAAS,CAAA;IAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,GAAG,IAAI,SAAS,CAAA;IAElE,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,OAAO,CAAA;IAEpD,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CACb,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,0CAA0C;YACrF,oFAAoF,CACvF,CAAA;IACH,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,KAAoB,EAAE,MAA8B;IACzE,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3C,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,OAAO,CAAC,KAAK,CAAA;QAEnD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CACb,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,yBAAyB;gBACvF,iFAAiF,CACpF,CAAA;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;IAEF,OAAO,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;GAMG;AACH,qEAAqE;AACrE,SAAS,YAAY,CAAC,KAAoB;IACxC,MAAM,MAAM,GAA2B,EAAE,CAAA;IAEzC,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAC5D,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAAuB,EACvB,MAAuB;IAEvB,MAAM,OAAO,GAA4E,EAAE,CAAA;IAE3F,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;QAErE,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;YAC3D,SAAQ;QACV,CAAC;QAED,sEAAsE;QACtE,sEAAsE;QACtE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;YAC7F,SAAQ;QACV,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,CAAA;QAEtE,sEAAsE;QACtE,wEAAwE;QACxE,qEAAqE;QACrE,IAAI,CAAC,IAAI;YAAE,SAAQ;QAEnB,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAyB;IACvD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;IAExD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAA;IACrG,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACnD,MAAM,OAAO,GAAsB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAE5D,0DAA0D;IAC1D,EAAE;IACF,yEAAyE;IACzE,yEAAyE;IACzE,6EAA6E;IAC7E,6EAA6E;IAC7E,yEAAyE;IACzE,8CAA8C;IAC9C,EAAE;IACF,2EAA2E;IAC3E,8DAA8D;IAC9D,EAAE;IACF,0EAA0E;IAC1E,uCAAuC;IACvC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,IAAI,6BAA6B,CAAC,CAAA;IACrF,IAAI,IAAI,GAAG,CAAC,CAAA;IAEZ,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;QACxB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,EAAE,CAAA;YAEpB,IAAI,KAAK,IAAI,OAAO,CAAC,MAAM;gBAAE,OAAM;YAEnC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;YAE7C,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;YACvD,OAAO,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;QACpC,CAAC;IACH,CAAC,CAAA;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExF,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;IAE3D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAED,OAAO,OAAO,CAAA;IAEd,KAAK,UAAU,YAAY,CACzB,KAAoB,EACpB,MAA8B,EAC9B,GAAW;QAEX,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QACnE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;QAC5E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAA;QAC9F,MAAM,IAAI,GAAG,CAAC,IAA6B,EAAE,MAAqB,EAAmB,EAAE,CAAC,CAAC;YACvF,uEAAuE;YACvE,sEAAsE;YACtE,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG;YAChD,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,IAAI;YACJ,MAAM;SACP,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAA;QAE3F,wEAAwE;QACxE,wEAAwE;QACxE,EAAE;QACF,wEAAwE;QACxE,uEAAuE;QACvE,yEAAyE;QACzE,yEAAyE;QACzE,wEAAwE;QACxE,iCAAiC;QACjC,yEAAyE;QACzE,yEAAyE;QACzE,yEAAyE;QACzE,mEAAmE;QACnE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,CACtE,SAAS,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,CAAC;gBACH,OAAO;oBACL,KAAK,EAAE,MAAM,MAAM,CAAC,iBAAiB,CACnC,KAAK,CAAC,SAAS,EACf,KAAK,EACL,OAAO,EACP,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,KAAK;oBACX,+DAA+D;oBAC/D,mEAAmE;oBACnE,uDAAuD;oBACvD,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CACvB;oBACD,UAAU,EAAE,KAAK,EAAE;oBACnB,WAAW,EAAE,cAAc,EAAE;iBAC9B,CAAA;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,oEAAoE;gBACpE,yEAAyE;gBACzE,qEAAqE;gBACrE,kDAAkD;gBAClD,MAAM,OAAO,GAAG,KAAK,EAAE,CAAA;gBAEvB,IAAI,CAAC,OAAO;oBAAE,MAAM,KAAK,CAAA;gBAEzB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,CAAA;YAC5E,CAAC;QACH,CAAC,CAAC,CAAC,CACF,CAAA;QAED,2EAA2E;QAC3E,yEAAyE;QACzE,0EAA0E;QAC1E,0CAA0C;QAC1C;;;;;;;;;;;;;;;;;;;WAmBG;QACH,KAAK,UAAU,uBAAuB,CAAC,MAAuB;YAC5D,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO;gBAAE,OAAO,MAAM,CAAA;YAC1C,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB;gBAAE,OAAO,MAAM,CAAA;YAE3E,qEAAqE;YACrE,EAAE;YACF,wEAAwE;YACxE,kEAAkE;YAClE,wEAAwE;YACxE,wEAAwE;YACxE,kEAAkE;YAClE,2CAA2C;YAC3C,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,CAC/C,SAAS,CAAC,GAAG,EAAE,CACb,YAAY,CAAC,KAAK,IAAI,EAAE,CACtB,MAAM,CAAC,iBAAiB,CACtB,KAAK,CAAC,SAAS,EACf,KAAK,EACL,OAAO,EACP,EAAE,EACF,KAAK,CAAC,KAAK,EACX,GAAG,EACH,uBAAuB,CACxB,CACF,CACF,CACF,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YAEnB,IAAI,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACtE,MAAM,CAAC,OAAO;oBACZ,mFAAmF;wBACnF,oEAAoE,CAAA;YACxE,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC;QAED,yEAAyE;QACzE,qEAAqE;QACrE,2EAA2E;QAC3E,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,KAAK,CACT,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAC/B,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAC7E,CAAA;YAED,OAAO,IAAI,CAAC,QAAQ,EAAE,gBAAgB,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC9D,CAAC;QAED,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;QAE9D,IAAI,KAAK,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;QAElD,yEAAyE;QACzE,oEAAoE;QACpE,uEAAuE;QACvE,qEAAqE;QACrE,0EAA0E;QAC1E,mBAAmB;QACnB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAA;YAElD,uEAAuE;YACvE,yEAAyE;YACzE,sEAAsE;YACtE,0DAA0D;YAC1D,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAChB,OAAO,IAAI,CACT,SAAS,EACT,CAAC,WAAW;oBACV,CAAC,CAAC,mBAAmB;oBACrB,CAAC,CAAC,KAAK,CAAC,eAAe;wBACrB,CAAC,CAAC,sBAAsB;wBACxB,CAAC,CAAC,QAAQ,CAAC;oBACb,2DAA2D,CAC9D,CAAA;YACH,CAAC;YAED,MAAM,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;YAElC,OAAO,MAAM,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAA;QAC3D,CAAC;QAED,0EAA0E;QAC1E,2EAA2E;QAC3E,yEAAyE;QACzE,sEAAsE;QACtE,wEAAwE;QACxE,eAAe;QACf,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,SAAS,EAAE,oEAAoE,CAAC,CAAA;QAC9F,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,KAAK,KAAK,CAAA;QAExC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,SAAS,CACrC,KAAK,CAAC,SAAS,EACf,KAAK,EACL,IAAI,EACJ,OAAO;QACP,0EAA0E;QAC1E,0EAA0E;QAC1E,sBAAsB;QACtB,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,KAAK,EACX,CAAC,EACD,GAAG,EACH,OAAO,CACR,CAAA;QAED,uEAAuE;QACvE,yEAAyE;QACzE,0EAA0E;QAC1E,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CACT,OAAO,EACP,iDAAiD,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBACvF,sEAAsE,CACzE,CAAA;QACH,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAExB,MAAM,KAAK,CAAC,GAAG,GAAG,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,KAAK,CAAC,GAAG,GAAG,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;QAEjD,0EAA0E;QAC1E,4EAA4E;QAC5E,0EAA0E;QAC1E,sEAAsE;QACtE,0EAA0E;QAC1E,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3D,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAClD,KAAK,CAAC,SAAS,EACf,KAAK,EACL,OAAO,EACP,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,KAAK,EACX,KAAK,EACL,GAAG,CACJ,CAAA;YAED,MAAM,KAAK,CAAC,GAAG,GAAG,OAAO,KAAK,SAAS,EAAE,UAAU,CAAC,CAAA;QACtD,CAAC;QAED,MAAM,KAAK,CACT,GAAG,GAAG,YAAY,EAClB,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAC1G,CAAA;QAED,OAAO,MAAM,uBAAuB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,UAAU,UAAU,CAAC,KAAoB,EAAE,GAAW,EAAE,IAAY;QACvE,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;QACrE,MAAM,GAAG,GAAG,aAAa,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAEnF,MAAM,KAAK,CAAC,GAAG,GAAG,WAAW,EAAE,IAAI,CAAC,CAAA;QACpC,MAAM,KAAK,CACT,GAAG,GAAG,gBAAgB,EACtB,IAAI,CAAC,SAAS,CACZ,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,EAC/F,IAAI,EACJ,CAAC,CACF,CACF,CAAA;IACH,CAAC;AAEH,CAAC"}

package/dist/redirect.d.ts

@@ -0,0 +1,34 @@
+import type { Href } from './routes.js';
+import type { Redirection } from './redirectDigest.js';
+export { RedirectSignal, isRedirectSignal, redirectDigest, parseRedirectDigest } from './redirectDigest.js';
+export type { Redirection } from './redirectDigest.js';
+/**
+ * Leave this page for another one.
+ *
+ * Never returns: it throws, which stops the component that called it. Do not
+ * wrap a call in `try`/`catch` without rethrowing what you do not recognise —
+ * swallowing this turns a redirect into a blank region.
+ *
+ * `location` is typed to the routes the build found, so a redirect to a page
+ * that no longer exists stops compiling. Cast with `as Href` when the
+ * destination is computed — remembering where someone was going and sending
+ * them back to it is the usual case.
+ *
+ * Where it is called decides how it is delivered, and the difference matters
+ * for anything that must not be seen. A call above every Suspense boundary is
+ * answered with a status code before a byte is written. A call inside one is
+ * answered after the shell — which holds no data from inside the boundary,
+ * but does hold whatever the layouts above it rendered.
+ */
+export declare function redirect(location: Href, status?: number): never;
+/** The redirect asked for during the current render, if any. */
+export declare function currentRedirect(): Redirection | null;
+/**
+ * Run a render with somewhere for a redirect to be recorded, and report one.
+ *
+ * `taken()` is read twice by a streaming host: once when the shell resolves,
+ * to answer with a status code, and again when the stream ends, for a
+ * redirect that arrived too late for one.
+ */
+export declare function withRedirect<T>(run: (taken: () => Redirection | null) => Promise<T>): Promise<T>;
+//# sourceMappingURL=redirect.d.ts.map

package/dist/redirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../src/redirect.ts"],"names":[],"mappings":"AAiCA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAGvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEtD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC3G,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AA8BtD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,SAAM,GAAG,KAAK,CAwB5D;AAED,gEAAgE;AAChE,wBAAgB,eAAe,IAAI,WAAW,GAAG,IAAI,CAEpD;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAClC,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,WAAW,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GACnD,OAAO,CAAC,CAAC,CAAC,CAYZ"}