@nifrajs/web 5.5.1 → 5.7.0

package/dist/internal/ppr/frames.d.ts

@@ -0,0 +1,71 @@
+/**
+ * A hole name: it becomes a DOM id, an attribute value, a hashed script and part of a renderer's id
+ * prefix, so it stays this narrow. No `--` and no trailing `-`: Svelte refuses an id prefix with `--`.
+ */
+export declare const HOLE_NAME: RegExp;
+/** What one hole sends: its server HTML, plus props when it hydrates, or the record of the server
+ * component it shows, without that HTML. An error carries the error slot's HTML only, never the
+ * thrown message. */
+export type HoleOutcome = {
+    readonly html: string;
+    readonly props?: unknown;
+    readonly component?: unknown;
+    readonly error?: undefined;
+} | {
+    readonly html: string;
+    readonly error: true;
+};
+/** A frame's JSON, as the runtime reads it to fill a host. */
+export type HoleFrameBody = {
+    readonly v: 1;
+    readonly html: string;
+    readonly props?: unknown;
+    readonly component?: unknown;
+    readonly error?: undefined;
+} | {
+    readonly v: 1;
+    readonly html: string;
+    readonly error: true;
+};
+export declare const assertHoleName: (name: string) => void;
+/** Refuse hole HTML that could run script or escape its host, with the policy server
+ * components already enforce. Throws; the caller sends that hole's error frame instead. */
+export declare const validateHoleHtml: (html: string) => void;
+/**
+ * The bytes that fill hole `name`: an inert JSON frame and the constant invoker. No `</script>` or
+ * comment opener in the HTML or props survives into the element. Throws a `RangeError` when the
+ * encoded frame exceeds `maxBytes`.
+ */
+export declare function encodeHoleFrame(name: string, outcome: HoleOutcome, maxBytes: number): string;
+/**
+ * The JSON of a frame {@link encodeHoleFrame} wrote: what a data request sends to refill a host. The
+ * opening tag holds no `>` before its end, and the escaped JSON no `</script>`.
+ */
+export declare function frameBodyOf(frame: string): HoleFrameBody;
+/**
+ * The per-response facts the runtime needs to send a cancel beacon. Inert JSON: never cached. `shared`
+ * names the holes whose frames serve every visitor, which the canary check scans with the shell.
+ */
+export declare const encodeRequestScript: (cancelUrl: string, token: string, holes: readonly string[], shared?: readonly string[]) => string;
+/**
+ * {@link encodeRequestScript} before and after the token, so a route's script is serialized once and
+ * each response adds only its token. Holds for a base64url token, which serializing leaves as it is.
+ * An escaped JSON string never holds `"token":"` (each of its quotes follows a backslash), so the
+ * key found is the token's.
+ */
+export declare function requestScriptAround(cancelUrl: string, holes: readonly string[], shared?: readonly string[]): readonly [string, string];
+/**
+ * Where {@link injectHoleFallbacks} puts each fallback, in document order. One pass over the shell
+ * finds every host: a search per hole, and another for its duplicate, read a large shell many times.
+ */
+export declare function holeFallbackInserts(shell: string, fallbacks: ReadonlyMap<string, string>): Array<{
+    readonly at: number;
+    readonly html: string;
+}>;
+/**
+ * Put each hole's fallback HTML into its empty host in a rendered shell, once per shell build. Every
+ * declared hole must have exactly one host and that host must be empty: the adapter renders
+ * it opaque, so anything inside would be framework output the fill would destroy.
+ */
+export declare function injectHoleFallbacks(shell: string, fallbacks: ReadonlyMap<string, string>): string;
+//# sourceMappingURL=frames.d.ts.map

package/dist/internal/ppr/frames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frames.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/frames.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,MAAqD,CAAA;AAE7E;;qBAEqB;AACrB,MAAM,MAAM,WAAW,GACnB;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC3B,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAA;AAEnD,8DAA8D;AAC9D,MAAM,MAAM,aAAa,GACrB;IACE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAA;IACb,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC3B,GACD;IAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAA;AAElE,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,IAM7C,CAAA;AAED;2FAC2F;AAC3F,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,KAAG,IAAmC,CAAA;AAWnF;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAmB5F;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAIxD;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAC9B,WAAW,MAAM,EACjB,OAAO,MAAM,EACb,OAAO,SAAS,MAAM,EAAE,EACxB,SAAQ,SAAS,MAAM,EAAO,WAEyJ,CAAA;AAIzL;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,MAAM,GAAE,SAAS,MAAM,EAAO,GAC7B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAI3B;AAID;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GACrC,KAAK,CAAC;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAwBvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CASjG"}

package/dist/internal/ppr/frames.js

@@ -0,0 +1,119 @@
+import { validateComponentHTML } from "../../server-components/html.js";
+import { serializeData } from "../render-document.js";
+import { holeInvoker } from "./runtime.js";
+/**
+ * A hole name: it becomes a DOM id, an attribute value, a hashed script and part of a renderer's id
+ * prefix, so it stays this narrow. No `--` and no trailing `-`: Svelte refuses an id prefix with `--`.
+ */
+export const HOLE_NAME = /^(?=[a-z0-9-]{1,32}$)[a-z](?:-?[a-z0-9])*$/;
+export const assertHoleName = (name) => {
+    if (!HOLE_NAME.test(name)) {
+        throw new TypeError(`[nifra/web] ppr: hole name "${name}" must match ${HOLE_NAME.source} (it becomes a DOM id and a hashed script)`);
+    }
+};
+/** Refuse hole HTML that could run script or escape its host, with the policy server
+ * components already enforce. Throws; the caller sends that hole's error frame instead. */
+export const validateHoleHtml = (html) => validateComponentHTML(html);
+/**
+ * JSON safe inside a `<script>` element. Script data ends only at `</script`, and only `<!--` can
+ * move the tokenizer into its escaped states, so escaping `</` and `<!--` is enough; both escapes are
+ * plain JSON. Escaping every `<` and `>` instead, as `serializeData` does, made a 100 KB hole's frame
+ * 53% larger than its HTML; this makes it about 10% larger.
+ */
+const scriptJson = (value) => JSON.stringify(value).replaceAll("</", "<\\/").replaceAll("<!--", "<\\u0021--");
+/**
+ * The bytes that fill hole `name`: an inert JSON frame and the constant invoker. No `</script>` or
+ * comment opener in the HTML or props survives into the element. Throws a `RangeError` when the
+ * encoded frame exceeds `maxBytes`.
+ */
+export function encodeHoleFrame(name, outcome, maxBytes) {
+    const body = outcome.error === true
+        ? { v: 1, error: true, html: outcome.html }
+        : outcome.component !== undefined
+            ? { v: 1, html: outcome.html, component: outcome.component }
+            : outcome.props === undefined
+                ? { v: 1, html: outcome.html }
+                : { v: 1, html: outcome.html, props: outcome.props };
+    const frame = `<script type="application/json" id="nifra-ppr:${name}">${scriptJson(body)}</script><script>${holeInvoker(name)}</script>`;
+    // UTF-8 needs at least one and at most three bytes per UTF-16 unit, so only a frame between the two
+    // bounds is encoded to measure it.
+    if (frame.length > maxBytes ||
+        (frame.length * 3 > maxBytes && new TextEncoder().encode(frame).length > maxBytes)) {
+        throw new RangeError(`[nifra/web] ppr: hole "${name}" frame exceeds ${maxBytes} bytes`);
+    }
+    return frame;
+}
+/**
+ * The JSON of a frame {@link encodeHoleFrame} wrote: what a data request sends to refill a host. The
+ * opening tag holds no `>` before its end, and the escaped JSON no `</script>`.
+ */
+export function frameBodyOf(frame) {
+    const start = frame.indexOf(">") + 1;
+    // biome-ignore lint/plugin/requireSafetyCommentForTypeAssertion: encodeHoleFrame wrote this JSON from a HoleFrameBody.
+    return JSON.parse(frame.slice(start, frame.indexOf("</script>", start)));
+}
+/**
+ * The per-response facts the runtime needs to send a cancel beacon. Inert JSON: never cached. `shared`
+ * names the holes whose frames serve every visitor, which the canary check scans with the shell.
+ */
+export const encodeRequestScript = (cancelUrl, token, holes, shared = []) => `<script type="application/json" id="nifra-ppr-req">${serializeData(shared.length === 0 ? { cancel: cancelUrl, token, holes } : { cancel: cancelUrl, token, holes, shared })}</script>`;
+const TOKEN_KEY = '"token":"';
+/**
+ * {@link encodeRequestScript} before and after the token, so a route's script is serialized once and
+ * each response adds only its token. Holds for a base64url token, which serializing leaves as it is.
+ * An escaped JSON string never holds `"token":"` (each of its quotes follows a backslash), so the
+ * key found is the token's.
+ */
+export function requestScriptAround(cancelUrl, holes, shared = []) {
+    const script = encodeRequestScript(cancelUrl, "", holes, shared);
+    const at = script.indexOf(TOKEN_KEY) + TOKEN_KEY.length;
+    return [script.slice(0, at), script.slice(at)];
+}
+const HOST = 'data-nifra-hole="';
+/**
+ * Where {@link injectHoleFallbacks} puts each fallback, in document order. One pass over the shell
+ * finds every host: a search per hole, and another for its duplicate, read a large shell many times.
+ */
+export function holeFallbackInserts(shell, fallbacks) {
+    // A declared hole's host, as the index after its name's closing quote; -1 once it has two.
+    const hosts = new Map();
+    for (let at = shell.indexOf(HOST); at !== -1; at = shell.indexOf(HOST, at + HOST.length)) {
+        const end = shell.indexOf('"', at + HOST.length);
+        if (end === -1)
+            break;
+        const name = shell.slice(at + HOST.length, end);
+        if (fallbacks.has(name))
+            hosts.set(name, hosts.has(name) ? -1 : end + 1);
+    }
+    const inserts = [];
+    for (const [name, html] of fallbacks) {
+        const after = hosts.get(name);
+        if (after === undefined)
+            throw new TypeError(`[nifra/web] ppr: hole "${name}" has no host in the shell`);
+        if (after === -1) {
+            throw new TypeError(`[nifra/web] ppr: hole "${name}" has more than one host in the shell`);
+        }
+        const close = shell.indexOf(">", after);
+        if (close === -1 || !shell.startsWith("</", close + 1)) {
+            throw new TypeError(`[nifra/web] ppr: hole "${name}"'s host must render empty`);
+        }
+        inserts.push({ at: close + 1, html });
+    }
+    return inserts.sort((a, b) => a.at - b.at);
+}
+/**
+ * Put each hole's fallback HTML into its empty host in a rendered shell, once per shell build. Every
+ * declared hole must have exactly one host and that host must be empty: the adapter renders
+ * it opaque, so anything inside would be framework output the fill would destroy.
+ */
+export function injectHoleFallbacks(shell, fallbacks) {
+    const inserts = holeFallbackInserts(shell, fallbacks);
+    let out = "";
+    let from = 0;
+    for (const insert of inserts) {
+        out += shell.slice(from, insert.at) + insert.html;
+        from = insert.at;
+    }
+    return out + shell.slice(from);
+}
+//# sourceMappingURL=frames.js.map

package/dist/internal/ppr/frames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frames.js","sourceRoot":"","sources":["../../../src/internal/ppr/frames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAW,4CAA4C,CAAA;AAyB7E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAQ,EAAE;IACnD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CACjB,+BAA+B,IAAI,gBAAgB,SAAS,CAAC,MAAM,4CAA4C,CAChH,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED;2FAC2F;AAC3F,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAQ,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;AAEnF;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,KAAc,EAAU,EAAE,CAC5C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;AAEjF;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,OAAoB,EAAE,QAAgB;IAClF,MAAM,IAAI,GACR,OAAO,CAAC,KAAK,KAAK,IAAI;QACpB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;QAC3C,CAAC,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS;YAC/B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE;YAC5D,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS;gBAC3B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;gBAC9B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAA;IAC5D,MAAM,KAAK,GAAG,iDAAiD,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,oBAAoB,WAAW,CAAC,IAAI,CAAC,WAAW,CAAA;IACxI,oGAAoG;IACpG,mCAAmC;IACnC,IACE,KAAK,CAAC,MAAM,GAAG,QAAQ;QACvB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,QAAQ,IAAI,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,EAClF,CAAC;QACD,MAAM,IAAI,UAAU,CAAC,0BAA0B,IAAI,mBAAmB,QAAQ,QAAQ,CAAC,CAAA;IACzF,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACpC,uHAAuH;IACvH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAkB,CAAA;AAC3F,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,SAAiB,EACjB,KAAa,EACb,KAAwB,EACxB,SAA4B,EAAE,EAC9B,EAAE,CACF,sDAAsD,aAAa,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,WAAW,CAAA;AAEzL,MAAM,SAAS,GAAG,WAAW,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAAiB,EACjB,KAAwB,EACxB,SAA4B,EAAE;IAE9B,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,MAAM,CAAA;IACvD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;AAChD,CAAC;AAED,MAAM,IAAI,GAAG,mBAAmB,CAAA;AAEhC;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAa,EACb,SAAsC;IAEtC,2FAA2F;IAC3F,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAA;IACvC,KAAK,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACzF,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,GAAG,KAAK,CAAC,CAAC;YAAE,MAAK;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAC/C,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;IAC1E,CAAC;IACD,MAAM,OAAO,GAAwC,EAAE,CAAA;IACvD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,SAAS,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAC7B,IAAI,KAAK,KAAK,SAAS;YACrB,MAAM,IAAI,SAAS,CAAC,0BAA0B,IAAI,4BAA4B,CAAC,CAAA;QACjF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,SAAS,CAAC,0BAA0B,IAAI,uCAAuC,CAAC,CAAA;QAC5F,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACvC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,SAAS,CAAC,0BAA0B,IAAI,4BAA4B,CAAC,CAAA;QACjF,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IACvC,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa,EAAE,SAAsC;IACvF,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IACrD,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAA;QACjD,IAAI,GAAG,MAAM,CAAC,EAAE,CAAA;IAClB,CAAC;IACD,OAAO,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC"}

package/dist/internal/ppr/integration.d.ts

@@ -0,0 +1,19 @@
+import type { CacheStore } from "../../isr.js";
+import type { ShellCheckRecord } from "./compile-shell.js";
+import { type PprEnvironment, type PprIntegration } from "./contract.js";
+import type { ResolvedPprOptions } from "./options.js";
+/** Where shells are shared beyond the process, as `partialPrerendering` checked them. */
+export interface PprSharing {
+    readonly store: CacheStore | undefined;
+    readonly storeSecret: string | undefined;
+    readonly deployment: string | undefined;
+}
+/**
+ * The deployment every shell key names. The client entry changes with each client build; each route's
+ * checked shell hash changes with its shell code, which the client entry does not see; the
+ * platform's own name, when given, covers the rest.
+ */
+export declare function shellDeployment(clientEntry: string, shellChecks: ShellCheckRecord | "unchecked-development", named: string | undefined): string;
+/** One app's partial prerendering, made when `createWebApp` reaches its `experimental.ppr`. */
+export declare function createPprIntegration(options: ResolvedPprOptions, shellChecks: ShellCheckRecord | "unchecked-development", origin: string | undefined, environment: PprEnvironment, sharing?: PprSharing): PprIntegration;
+//# sourceMappingURL=integration.d.ts.map

package/dist/internal/ppr/integration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/integration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,cAAc,EAMpB,MAAM,eAAe,CAAA;AACtB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAetD,yFAAyF;AACzF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,gBAAgB,GAAG,uBAAuB,EACvD,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,MAAM,CAUR;AAED,+FAA+F;AAC/F,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,kBAAkB,EAC3B,WAAW,EAAE,gBAAgB,GAAG,uBAAuB,EACvD,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,WAAW,EAAE,cAAc,EAC3B,OAAO,GAAE,UAAgF,GACxF,cAAc,CAyEhB"}

package/dist/internal/ppr/integration.js

@@ -0,0 +1,106 @@
+import { readBoundedBytes, TransportCodecError } from "@nifrajs/core/transport-codec";
+import { PPR_CANCEL_PATH, PprShellCold, PprShellUnavailable, PprShellUnchecked, variationQuery, wantsBlockingRender, } from "./contract.js";
+import { assertPprRoute, variationsOf } from "./route-rules.js";
+import { createPprServer } from "./server.js";
+import { digest, sharedShellStore } from "./shell-store.js";
+// The stream sets its own type, caching and CSP; a middleware or gate header joins the rest.
+const OWN_HEADERS = new Set([
+    "content-type",
+    "cache-control",
+    "content-security-policy",
+    "content-length",
+]);
+const MAX_CANCEL_BYTES = 64;
+/**
+ * The deployment every shell key names. The client entry changes with each client build; each route's
+ * checked shell hash changes with its shell code, which the client entry does not see; the
+ * platform's own name, when given, covers the rest.
+ */
+export function shellDeployment(clientEntry, shellChecks, named) {
+    if (shellChecks === "unchecked-development" && named === undefined)
+        return clientEntry;
+    const routes = shellChecks === "unchecked-development"
+        ? ""
+        : Object.keys(shellChecks.routes)
+            .sort()
+            .map((id) => `${id}=${shellChecks.routes[id]}`)
+            .join(",");
+    return `${clientEntry}~${digest(`${routes}|${named ?? ""}`)}`;
+}
+/** One app's partial prerendering, made when `createWebApp` reaches its `experimental.ppr`. */
+export function createPprIntegration(options, shellChecks, origin, environment, sharing = { store: undefined, storeSecret: undefined, deployment: undefined }) {
+    const { perRequestNonce, ...app } = environment;
+    if (perRequestNonce) {
+        throw new TypeError("[nifra/web] experimental.ppr needs `csp: createCspPolicy(...)`, not `nonce`: a per-request nonce would make every shell unique");
+    }
+    const deployment = shellDeployment(app.deployment, shellChecks, sharing.deployment);
+    const server = createPprServer({
+        ...app,
+        deployment,
+        clientEntry: app.deployment,
+        options,
+        cancelUrl: PPR_CANCEL_PATH,
+        shellChecks,
+        shared: sharing.store === undefined || sharing.storeSecret === undefined
+            ? undefined
+            : sharedShellStore(sharing.store, sharing.storeSecret, deployment),
+    });
+    const uncheckedWarned = new Set();
+    return {
+        server,
+        // biome-ignore lint/plugin/noConditionalEmptyObjectSpread: an app with no configured origin has none, which shell meta reads as absent.
+        ...(origin === undefined ? {} : { origin }),
+        cancelPath: PPR_CANCEL_PATH,
+        // A beacon carries one 22-character token; anything longer is not one. The token is unguessable,
+        // so the answer is the same whether it named a live response or not.
+        async cancel(request) {
+            const length = Number(request.headers.get("content-length") ?? "NaN");
+            if (!(length > 0 && length <= MAX_CANCEL_BYTES))
+                return new Response(null, { status: 400 });
+            let token;
+            try {
+                // The header is a claim; the cap holds on the bytes that arrive.
+                token = await readBoundedBytes(new Response(request.body, { headers: request.headers }), {
+                    maxBytes: MAX_CANCEL_BYTES,
+                });
+            }
+            catch (error) {
+                if (error instanceof TransportCodecError)
+                    return new Response(null, { status: 400 });
+                throw error;
+            }
+            server.cancel(new TextDecoder().decode(token));
+            return new Response(null, { status: 204 });
+        },
+        async stream(request, written) {
+            if (wantsBlockingRender(options, request.request))
+                return "settled";
+            let response;
+            try {
+                response = await server.respond(request);
+            }
+            catch (error) {
+                if (!(error instanceof PprShellUnavailable))
+                    throw error;
+                if (error instanceof PprShellCold)
+                    return "deferred";
+                if (error instanceof PprShellUnchecked && !uncheckedWarned.has(request.routeId)) {
+                    uncheckedWarned.add(request.routeId);
+                    console.warn(error.message);
+                }
+                return "settled";
+            }
+            for (const [name, value] of Object.entries(written() ?? {}))
+                if (!OWN_HEADERS.has(name))
+                    response.headers.set(name, value);
+            return response;
+        },
+        shellData: (request, signal) => server
+            .shellData(request)
+            .catch((error) => error instanceof PprShellUnavailable ? request.loadShell(signal) : Promise.reject(error)),
+        variationQuery,
+        assertRoute: (route, layouts, boundaries) => assertPprRoute(route, layouts, boundaries, options),
+        variationsOf,
+    };
+}
+//# sourceMappingURL=integration.js.map

package/dist/internal/ppr/integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.js","sourceRoot":"","sources":["../../../src/internal/ppr/integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AAGrF,OAAO,EACL,eAAe,EAGf,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EACd,mBAAmB,GACpB,MAAM,eAAe,CAAA;AAEtB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3D,6FAA6F;AAC7F,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC;IAC/C,cAAc;IACd,eAAe;IACf,yBAAyB;IACzB,gBAAgB;CACjB,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAS3B;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,WAAmB,EACnB,WAAuD,EACvD,KAAyB;IAEzB,IAAI,WAAW,KAAK,uBAAuB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,WAAW,CAAA;IACtF,MAAM,MAAM,GACV,WAAW,KAAK,uBAAuB;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;aAC5B,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;aAC9C,IAAI,CAAC,GAAG,CAAC,CAAA;IAClB,OAAO,GAAG,WAAW,IAAI,MAAM,CAAC,GAAG,MAAM,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC,EAAE,CAAA;AAC/D,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,oBAAoB,CAClC,OAA2B,EAC3B,WAAuD,EACvD,MAA0B,EAC1B,WAA2B,EAC3B,UAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE;IAEzF,MAAM,EAAE,eAAe,EAAE,GAAG,GAAG,EAAE,GAAG,WAAW,CAAA;IAC/C,IAAI,eAAe,EAAE,CAAC;QACpB,MAAM,IAAI,SAAS,CACjB,gIAAgI,CACjI,CAAA;IACH,CAAC;IACD,MAAM,UAAU,GAAG,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;IACnF,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,GAAG,GAAG;QACN,UAAU;QACV,WAAW,EAAE,GAAG,CAAC,UAAU;QAC3B,OAAO;QACP,SAAS,EAAE,eAAe;QAC1B,WAAW;QACX,MAAM,EACJ,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAC9D,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC;KACvE,CAAC,CAAA;IACF,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAA;IACzC,OAAO;QACL,MAAM;QACN,wIAAwI;QACxI,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3C,UAAU,EAAE,eAAe;QAC3B,iGAAiG;QACjG,qEAAqE;QACrE,KAAK,CAAC,MAAM,CAAC,OAAO;YAClB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,KAAK,CAAC,CAAA;YACrE,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,gBAAgB,CAAC;gBAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;YAC3F,IAAI,KAAiB,CAAA;YACrB,IAAI,CAAC;gBACH,iEAAiE;gBACjE,KAAK,GAAG,MAAM,gBAAgB,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE;oBACvF,QAAQ,EAAE,gBAAgB;iBAC3B,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,mBAAmB;oBAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;gBACpF,MAAM,KAAK,CAAA;YACb,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAC9C,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO;YAC3B,IAAI,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;gBAAE,OAAO,SAAS,CAAA;YACnE,IAAI,QAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,CAAC,KAAK,YAAY,mBAAmB,CAAC;oBAAE,MAAM,KAAK,CAAA;gBACxD,IAAI,KAAK,YAAY,YAAY;oBAAE,OAAO,UAAU,CAAA;gBACpD,IAAI,KAAK,YAAY,iBAAiB,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChF,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;oBACpC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC7B,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;gBACzD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC/D,OAAO,QAAQ,CAAA;QACjB,CAAC;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAC7B,MAAM;aACH,SAAS,CAAC,OAAO,CAAC;aAClB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CACxB,KAAK,YAAY,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CACzF;QACL,cAAc;QACd,WAAW,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAC1C,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC;QACrD,YAAY;KACb,CAAA;AACH,CAAC"}

package/dist/internal/ppr/options.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Partial prerendering limits and defaults. Internal while the feature is experimental: every
+ * number the plan names lives here once, so a deployment overrides it in one object and the request
+ * path reads the resolved copy rather than a scattered constant.
+ */
+/** Overrides for {@link PPR_DEFAULTS}. Every field is optional; an omitted one keeps its default. */
+export interface PprOptions {
+    /** A hole's deadline when its boundary sets no `timeout`. */
+    readonly holeTimeoutMs?: number;
+    /** The largest `timeout` a boundary may set, and the cap on a route's total deadline. */
+    readonly maxHoleTimeoutMs?: number;
+    /** Added to the largest hole timeout to give the route's total deadline. */
+    readonly totalDeadlineSlackMs?: number;
+    /** Dynamic plus shared boundaries one PPR route may declare. */
+    readonly maxHolesPerRoute?: number;
+    /** Shell entries one route may keep in the memory store. */
+    readonly shellEntriesPerRoute?: number;
+    /**
+     * Bytes every shell entry in the memory store may hold together: its document, an estimate of the
+     * heap its loader data holds, and its key. An entry over the whole budget is served but not kept.
+     */
+    readonly shellStoreBytes?: number;
+    /** How long a `notFound()` shell is cached. */
+    readonly notFoundTtlSeconds?: number;
+    /** Shell builds one route may run at once; requests over it get the blocking render. */
+    readonly shellBuildConcurrency?: number;
+    /**
+     * Once the store is full, requests one shell key must see before its shell is built and may push
+     * an older one out. The ones before stream the page whole, each hole as it settles, so a path
+     * visited once cannot evict a popular one. While the store has room, every key builds at once.
+     */
+    readonly shellAfterRequests?: number;
+    /** A failing rebuild keeps serving the stale shell for `revalidate` times this... */
+    readonly staleOnErrorFactor?: number;
+    /** ...but never longer than this. */
+    readonly maxStaleOnErrorSeconds?: number;
+    /** Requests that get the blocking render instead of a stream: a user-agent pattern or a predicate. */
+    readonly blockingFor?: RegExp | ((request: Request) => boolean);
+    /** Abandoned invocations at which one boundary stops being admitted. */
+    readonly boundaryAbandonedTrip?: number;
+    /** Abandoned invocations per process at which boundaries holding any stop being admitted. */
+    readonly processAbandonedTrip?: number;
+    /** Abandoned invocations per process at which no hole is admitted. */
+    readonly admissionStop?: number;
+    /** How long after its abort a still-pending invocation counts as abandoned. */
+    readonly abandonGraceMs?: number;
+    /** PPR responses per process with hole loaders still running. */
+    readonly maxHoleWork?: number;
+    /** How long after the total deadline an undrained stream is kept before it is aborted. */
+    readonly writeGraceMs?: number;
+    /** Unsent bytes one response may queue. */
+    readonly maxUnsentBytesPerResponse?: number;
+    /** Unsent bytes every PPR response in the process may queue together. */
+    readonly maxUnsentBytes?: number;
+    /** Serialized size of one hole frame. */
+    readonly frameBytes?: number;
+    /** The shell is padded to at least this many bytes; Safari holds back smaller first chunks. */
+    readonly minShellBytes?: number;
+    /**
+     * When hole HTML is checked for script, handlers and other escapes before it is framed:
+     * `"always"`, or `"development"` only. The check costs about 20 us per KB of hole HTML; turn it off
+     * in production only when a strict CSP already blocks inline script.
+     */
+    readonly holeHtmlValidation?: "always" | "development";
+    /**
+     * Whether a page left with holes pending posts a cancel beacon, so their loaders stop before their
+     * deadline. Off by default on Cloudflare Workers, where the beacon reaches another isolate.
+     */
+    readonly cancelBeacon?: boolean;
+    /**
+     * How long a process serves a shell or shared hole it wrote to or read from the shared store before
+     * reading it there again, so a purge another process made reaches this one. 0 reads it every time.
+     */
+    readonly sharedRecheckMs?: number;
+}
+export type ResolvedPprOptions = {
+    readonly [K in keyof PprOptions]-?: Exclude<PprOptions[K], undefined>;
+};
+/**
+ * Crawlers that read the document without running streamed scripts, so they get the blocking render.
+ * The same set Next.js treats as HTML-limited bots. Googlebot itself is absent on purpose: it renders
+ * JavaScript. `[\w-]-Google` matches what `[\w-]+-Google` does without backtracking at every position.
+ */
+export declare const HTML_LIMITED_BOTS: RegExp;
+export declare const PPR_DEFAULTS: ResolvedPprOptions;
+/** The latest request a shell may wait for; the canary check requests a path this many times. */
+export declare const MAX_SHELL_AFTER_REQUESTS = 8;
+/**
+ * Merge `overrides` over {@link PPR_DEFAULTS} and check the result. Unknown keys, non-integers and
+ * limits that contradict each other throw at startup, never on a request.
+ */
+export declare function resolvePprOptions(overrides?: PprOptions): ResolvedPprOptions;
+/** A route's total deadline: its largest hole timeout plus the slack, capped. */
+export declare function totalDeadlineMs(options: ResolvedPprOptions, holeTimeouts: readonly number[]): number;
+export { wantsBlockingRender } from "./contract.js";
+//# sourceMappingURL=options.d.ts.map

package/dist/internal/ppr/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/options.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qGAAqG;AACrG,MAAM,WAAW,UAAU;IACzB,6DAA6D;IAC7D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,yFAAyF;IACzF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC,4EAA4E;IAC5E,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,gEAAgE;IAChE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC,4DAA4D;IAC5D,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC,+CAA+C;IAC/C,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,wFAAwF;IACxF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,qFAAqF;IACrF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,qCAAqC;IACrC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IACxC,sGAAsG;IACtG,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,CAAA;IAC/D,wEAAwE;IACxE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC,6FAA6F;IAC7F,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,sEAAsE;IACtE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,+EAA+E;IAC/E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,0FAA0F;IAC1F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,2CAA2C;IAC3C,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAC3C,yEAAyE;IACzE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,yCAAyC;IACzC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B,+FAA+F;IAC/F,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAA;IACtD;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;CAClC;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;CACtE,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MACqR,CAAA;AAIrT,eAAO,MAAM,YAAY,EAAE,kBA0BzB,CAAA;AA2BF,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,IAAI,CAAA;AAEzC;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,GAAE,UAAe,GAAG,kBAAkB,CAyDhF;AAED,iFAAiF;AACjF,wBAAgB,eAAe,CAC7B,OAAO,EAAE,kBAAkB,EAC3B,YAAY,EAAE,SAAS,MAAM,EAAE,GAC9B,MAAM,CAIR;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA"}

package/dist/internal/ppr/options.js

@@ -0,0 +1,125 @@
+/**
+ * Partial prerendering limits and defaults. Internal while the feature is experimental: every
+ * number the plan names lives here once, so a deployment overrides it in one object and the request
+ * path reads the resolved copy rather than a scattered constant.
+ */
+/**
+ * Crawlers that read the document without running streamed scripts, so they get the blocking render.
+ * The same set Next.js treats as HTML-limited bots. Googlebot itself is absent on purpose: it renders
+ * JavaScript. `[\w-]-Google` matches what `[\w-]+-Google` does without backtracking at every position.
+ */
+export const HTML_LIMITED_BOTS = /[\w-]-Google|Google-[\w-]|Chrome-Lighthouse|Slurp|DuckDuckBot|baiduspider|yandex|sogou|bitlybot|tumblr|vkShare|quora link preview|redditbot|ia_archiver|Bingbot|BingPreview|applebot|facebookexternalhit|facebookcatalog|Twitterbot|LinkedInBot|Slackbot|Discordbot|WhatsApp|SkypeUriPreview|Yeti|googleweblight/i;
+const MB = 1024 * 1024;
+export const PPR_DEFAULTS = Object.freeze({
+    holeTimeoutMs: 5_000,
+    maxHoleTimeoutMs: 30_000,
+    totalDeadlineSlackMs: 1_000,
+    maxHolesPerRoute: 32,
+    shellEntriesPerRoute: 10_000,
+    shellStoreBytes: 64 * MB,
+    notFoundTtlSeconds: 60,
+    shellBuildConcurrency: 4,
+    shellAfterRequests: 2,
+    staleOnErrorFactor: 10,
+    maxStaleOnErrorSeconds: 86_400,
+    blockingFor: HTML_LIMITED_BOTS,
+    boundaryAbandonedTrip: 64,
+    processAbandonedTrip: 1_024,
+    admissionStop: 4_096,
+    abandonGraceMs: 100,
+    maxHoleWork: 1_024,
+    writeGraceMs: 5_000,
+    maxUnsentBytesPerResponse: MB,
+    maxUnsentBytes: 64 * MB,
+    frameBytes: 256 * 1024,
+    minShellBytes: 1_024,
+    holeHtmlValidation: "always",
+    cancelBeacon: true,
+    sharedRecheckMs: 1_000,
+});
+/**
+ * On Cloudflare Workers an isolate's memory is shared by everything it runs, and a beacon almost
+ * always reaches another isolate than the one running the holes.
+ */
+const WORKERS_DEFAULTS = Object.freeze({
+    shellStoreBytes: 8 * MB,
+    cancelBeacon: false,
+});
+const onWorkers = () => globalThis.navigator?.userAgent === "Cloudflare-Workers";
+const optionError = (message) => new TypeError(`[nifra/web] ppr: ${message}`);
+function assertOrdered(options, smaller, larger) {
+    if (options[smaller] > options[larger]) {
+        throw optionError(`${smaller} (${options[smaller]}) must not exceed ${larger} (${options[larger]})`);
+    }
+}
+/** The latest request a shell may wait for; the canary check requests a path this many times. */
+export const MAX_SHELL_AFTER_REQUESTS = 8;
+/**
+ * Merge `overrides` over {@link PPR_DEFAULTS} and check the result. Unknown keys, non-integers and
+ * limits that contradict each other throw at startup, never on a request.
+ */
+export function resolvePprOptions(overrides = {}) {
+    for (const key of Object.keys(overrides)) {
+        if (!Object.hasOwn(PPR_DEFAULTS, key))
+            throw optionError(`unknown option "${key}"`);
+    }
+    const defined = Object.fromEntries(Object.entries(overrides).filter(([, value]) => value !== undefined));
+    const resolved = {
+        ...PPR_DEFAULTS,
+        ...(onWorkers() ? WORKERS_DEFAULTS : undefined),
+        ...defined,
+    };
+    for (const [key, value] of Object.entries(resolved)) {
+        if (key === "blockingFor" || key === "holeHtmlValidation" || key === "cancelBeacon")
+            continue;
+        if (typeof value !== "number" || !Number.isSafeInteger(value) || value < 0) {
+            throw optionError(`${key} must be a non-negative integer, got ${String(value)}`);
+        }
+    }
+    for (const key of [
+        "holeTimeoutMs",
+        "maxHolesPerRoute",
+        "shellBuildConcurrency",
+        "shellAfterRequests",
+        "boundaryAbandonedTrip",
+        "maxHoleWork",
+        "maxUnsentBytesPerResponse",
+        "frameBytes",
+    ]) {
+        if (resolved[key] === 0)
+            throw optionError(`${key} must be at least 1`);
+    }
+    if (resolved.shellAfterRequests > MAX_SHELL_AFTER_REQUESTS) {
+        throw optionError(`shellAfterRequests must be at most ${MAX_SHELL_AFTER_REQUESTS}, got ${resolved.shellAfterRequests}`);
+    }
+    const blockingFor = resolved.blockingFor;
+    if (!(blockingFor instanceof RegExp) && typeof blockingFor !== "function") {
+        throw optionError("blockingFor must be a RegExp or a function of the request");
+    }
+    if (resolved.holeHtmlValidation !== "always" && resolved.holeHtmlValidation !== "development") {
+        throw optionError(`holeHtmlValidation must be "always" or "development", got ${String(resolved.holeHtmlValidation)}`);
+    }
+    if (typeof resolved.cancelBeacon !== "boolean") {
+        throw optionError(`cancelBeacon must be a boolean, got ${String(resolved.cancelBeacon)}`);
+    }
+    // A global or sticky pattern keeps `lastIndex` between `test` calls, so one bot would alternate.
+    if (blockingFor instanceof RegExp && (blockingFor.global || blockingFor.sticky)) {
+        throw optionError("blockingFor must not use the g or y flag");
+    }
+    assertOrdered(resolved, "holeTimeoutMs", "maxHoleTimeoutMs");
+    assertOrdered(resolved, "boundaryAbandonedTrip", "processAbandonedTrip");
+    assertOrdered(resolved, "processAbandonedTrip", "admissionStop");
+    assertOrdered(resolved, "frameBytes", "maxUnsentBytesPerResponse");
+    assertOrdered(resolved, "maxUnsentBytesPerResponse", "maxUnsentBytes");
+    return Object.freeze(resolved);
+}
+/** A route's total deadline: its largest hole timeout plus the slack, capped. */
+export function totalDeadlineMs(options, holeTimeouts) {
+    let largest = 0;
+    for (const timeout of holeTimeouts)
+        if (timeout > largest)
+            largest = timeout;
+    return Math.min(largest + options.totalDeadlineSlackMs, options.maxHoleTimeoutMs);
+}
+export { wantsBlockingRender } from "./contract.js";
+//# sourceMappingURL=options.js.map

package/dist/internal/ppr/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/internal/ppr/options.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA6EH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAC5B,mTAAmT,CAAA;AAErT,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,CAAA;AAEtB,MAAM,CAAC,MAAM,YAAY,GAAuB,MAAM,CAAC,MAAM,CAAC;IAC5D,aAAa,EAAE,KAAK;IACpB,gBAAgB,EAAE,MAAM;IACxB,oBAAoB,EAAE,KAAK;IAC3B,gBAAgB,EAAE,EAAE;IACpB,oBAAoB,EAAE,MAAM;IAC5B,eAAe,EAAE,EAAE,GAAG,EAAE;IACxB,kBAAkB,EAAE,EAAE;IACtB,qBAAqB,EAAE,CAAC;IACxB,kBAAkB,EAAE,CAAC;IACrB,kBAAkB,EAAE,EAAE;IACtB,sBAAsB,EAAE,MAAM;IAC9B,WAAW,EAAE,iBAAiB;IAC9B,qBAAqB,EAAE,EAAE;IACzB,oBAAoB,EAAE,KAAK;IAC3B,aAAa,EAAE,KAAK;IACpB,cAAc,EAAE,GAAG;IACnB,WAAW,EAAE,KAAK;IAClB,YAAY,EAAE,KAAK;IACnB,yBAAyB,EAAE,EAAE;IAC7B,cAAc,EAAE,EAAE,GAAG,EAAE;IACvB,UAAU,EAAE,GAAG,GAAG,IAAI;IACtB,aAAa,EAAE,KAAK;IACpB,kBAAkB,EAAE,QAAQ;IAC5B,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,KAAK;CACvB,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,gBAAgB,GAAgC,MAAM,CAAC,MAAM,CAAC;IAClE,eAAe,EAAE,CAAC,GAAG,EAAE;IACvB,YAAY,EAAE,KAAK;CACpB,CAAC,CAAA;AAEF,MAAM,SAAS,GAAG,GAAY,EAAE,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,KAAK,oBAAoB,CAAA;AAMzF,MAAM,WAAW,GAAG,CAAC,OAAe,EAAa,EAAE,CAAC,IAAI,SAAS,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAA;AAEhG,SAAS,aAAa,CAAC,OAA2B,EAAE,OAAmB,EAAE,MAAkB;IACzF,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,MAAM,WAAW,CACf,GAAG,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,qBAAqB,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,CAClF,CAAA;IACH,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAA;AAEzC;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAwB,EAAE;IAC1D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC;YAAE,MAAM,WAAW,CAAC,mBAAmB,GAAG,GAAG,CAAC,CAAA;IACrF,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CACrE,CAAA;IACD,MAAM,QAAQ,GAAuB;QACnC,GAAG,YAAY;QACf,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/C,GAAG,OAAO;KACX,CAAA;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpD,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,KAAK,oBAAoB,IAAI,GAAG,KAAK,cAAc;YAAE,SAAQ;QAC7F,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC3E,MAAM,WAAW,CAAC,GAAG,GAAG,wCAAwC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAClF,CAAC;IACH,CAAC;IACD,KAAK,MAAM,GAAG,IAAI;QAChB,eAAe;QACf,kBAAkB;QAClB,uBAAuB;QACvB,oBAAoB;QACpB,uBAAuB;QACvB,aAAa;QACb,2BAA2B;QAC3B,YAAY;KACJ,EAAE,CAAC;QACX,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,WAAW,CAAC,GAAG,GAAG,qBAAqB,CAAC,CAAA;IACzE,CAAC;IACD,IAAI,QAAQ,CAAC,kBAAkB,GAAG,wBAAwB,EAAE,CAAC;QAC3D,MAAM,WAAW,CACf,sCAAsC,wBAAwB,SAAS,QAAQ,CAAC,kBAAkB,EAAE,CACrG,CAAA;IACH,CAAC;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAA;IACxC,IAAI,CAAC,CAAC,WAAW,YAAY,MAAM,CAAC,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE,CAAC;QAC1E,MAAM,WAAW,CAAC,2DAA2D,CAAC,CAAA;IAChF,CAAC;IACD,IAAI,QAAQ,CAAC,kBAAkB,KAAK,QAAQ,IAAI,QAAQ,CAAC,kBAAkB,KAAK,aAAa,EAAE,CAAC;QAC9F,MAAM,WAAW,CACf,6DAA6D,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CACnG,CAAA;IACH,CAAC;IACD,IAAI,OAAO,QAAQ,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/C,MAAM,WAAW,CAAC,uCAAuC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAC3F,CAAC;IACD,iGAAiG;IACjG,IAAI,WAAW,YAAY,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAChF,MAAM,WAAW,CAAC,0CAA0C,CAAC,CAAA;IAC/D,CAAC;IACD,aAAa,CAAC,QAAQ,EAAE,eAAe,EAAE,kBAAkB,CAAC,CAAA;IAC5D,aAAa,CAAC,QAAQ,EAAE,uBAAuB,EAAE,sBAAsB,CAAC,CAAA;IACxE,aAAa,CAAC,QAAQ,EAAE,sBAAsB,EAAE,eAAe,CAAC,CAAA;IAChE,aAAa,CAAC,QAAQ,EAAE,YAAY,EAAE,2BAA2B,CAAC,CAAA;IAClE,aAAa,CAAC,QAAQ,EAAE,2BAA2B,EAAE,gBAAgB,CAAC,CAAA;IACtE,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAC7B,OAA2B,EAC3B,YAA+B;IAE/B,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,KAAK,MAAM,OAAO,IAAI,YAAY;QAAE,IAAI,OAAO,GAAG,OAAO;YAAE,OAAO,GAAG,OAAO,CAAA;IAC5E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;AACnF,CAAC;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA"}

package/dist/internal/ppr/route-rules.d.ts

@@ -0,0 +1,12 @@
+import type { BoundaryRegistration } from "../../boundary.js";
+import type { RouteEntry, RouteModule } from "../../manifest.js";
+import type { LoadedLayoutModules } from "../render-document.js";
+import type { ResolvedPprOptions } from "./options.js";
+/**
+ * The declared variations `search` selects. A parameter given twice, or a value outside its set,
+ * selects nothing, so every spelling of one choice maps to one shell.
+ */
+export declare function variationsOf(declared: RouteModule["shellVariations"], search: string): Readonly<Record<string, string>>;
+/** The PPR eligibility rules a route's own files cannot check: its layouts and boundary modes. */
+export declare function assertPprRoute(route: RouteEntry, layouts: LoadedLayoutModules, boundaries: readonly BoundaryRegistration[], limits: ResolvedPprOptions): void;
+//# sourceMappingURL=route-rules.d.ts.map

package/dist/internal/ppr/route-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-rules.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/route-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAEhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEtD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,EACxC,MAAM,EAAE,MAAM,GACb,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAWlC;AAED,kGAAkG;AAClG,wBAAgB,cAAc,CAC5B,KAAK,EAAE,UAAU,EACjB,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,SAAS,oBAAoB,EAAE,EAC3C,MAAM,EAAE,kBAAkB,GACzB,IAAI,CA4CN"}