@nifrajs/web 5.5.1 → 5.7.0

package/dist/internal/ppr/route-rules.js

@@ -0,0 +1,53 @@
+import { isHole, serverHoleComponent } from "./contract.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 function variationsOf(declared, search) {
+    const lists = declared?.search;
+    if (lists === undefined || search === "")
+        return {};
+    const query = new URLSearchParams(search);
+    const chosen = {};
+    for (const [name, allowed] of Object.entries(lists)) {
+        const values = query.getAll(name);
+        const value = values[0];
+        if (values.length === 1 && value !== undefined && allowed.includes(value))
+            chosen[name] = value;
+    }
+    return chosen;
+}
+/** The PPR eligibility rules a route's own files cannot check: its layouts and boundary modes. */
+export function assertPprRoute(route, layouts, boundaries, limits) {
+    // `compileShells` refuses the same chain at startup; this catches a record made from other files.
+    layouts.forEach((layout, index) => {
+        if (layout.loader !== undefined && layout.gate !== true) {
+            throw new Error(`[nifra/web] ppr: route "${route.id}" has a shellLoader, but its layout "${route.layoutIds[index]}" has a loader that is not a gate. A layout loader reads the request, so its output cannot be in a shared shell`);
+        }
+    });
+    let holes = 0;
+    for (const boundary of boundaries) {
+        if (typeof boundary.mode === "object") {
+            throw new Error(`[nifra/web] ppr: route "${route.id}" has a shellLoader and an intercepting boundary "${boundary.name}", which partial prerendering does not support yet`);
+        }
+        if (!isHole(boundary))
+            continue;
+        holes++;
+        if (typeof boundary.load !== "function") {
+            throw new Error(`[nifra/web] ppr: boundary "${boundary.name}" of route "${route.id}" has no boundaryLoaders entry; a hole is filled from its own loader`);
+        }
+        if (serverHoleComponent(boundary.render) !== undefined &&
+            (boundary.mode !== "dynamic" || boundary.interactive === true)) {
+            throw new Error(`[nifra/web] ppr: boundary "${boundary.name}" of route "${route.id}" shows a server component, so it must be a dynamic hole that is not interactive: the component runs for each visitor, and its client islands hydrate`);
+        }
+        const { timeout } = boundary;
+        const max = limits.maxHoleTimeoutMs;
+        if (timeout !== undefined && !(Number.isInteger(timeout) && timeout >= 1 && timeout <= max)) {
+            throw new RangeError(`[nifra/web] ppr: boundary "${boundary.name}" of route "${route.id}" has timeout ${String(timeout)}; it must be a whole number of milliseconds from 1 to ${max}`);
+        }
+    }
+    if (holes === 0 || holes > limits.maxHolesPerRoute) {
+        throw new RangeError(`[nifra/web] ppr: route "${route.id}" has a shellLoader and ${holes} dynamic or shared boundaries; it needs 1 to ${limits.maxHolesPerRoute}. A page with no per-visitor or fast-changing part needs no shell: prerender it or give it \`revalidate\``);
+    }
+}
+//# sourceMappingURL=route-rules.js.map

package/dist/internal/ppr/route-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-rules.js","sourceRoot":"","sources":["../../../src/internal/ppr/route-rules.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAG3D;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,QAAwC,EACxC,MAAc;IAEd,MAAM,KAAK,GAAG,QAAQ,EAAE,MAAM,CAAA;IAC9B,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,EAAE,CAAA;IACnD,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAA;IACzC,MAAM,MAAM,GAA2B,EAAE,CAAA;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACvB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IACjG,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,cAAc,CAC5B,KAAiB,EACjB,OAA4B,EAC5B,UAA2C,EAC3C,MAA0B;IAE1B,kGAAkG;IAClG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAChC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,CAAC,EAAE,wCAAwC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,iHAAiH,CACnN,CAAA;QACH,CAAC;IACH,CAAC,CAAC,CAAA;IACF,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,CAAC,EAAE,qDAAqD,QAAQ,CAAC,IAAI,oDAAoD,CAC1J,CAAA;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,SAAQ;QAC/B,KAAK,EAAE,CAAA;QACP,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,8BAA8B,QAAQ,CAAC,IAAI,eAAe,KAAK,CAAC,EAAE,sEAAsE,CACzI,CAAA;QACH,CAAC;QACD,IACE,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,SAAS;YAClD,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,WAAW,KAAK,IAAI,CAAC,EAC9D,CAAC;YACD,MAAM,IAAI,KAAK,CACb,8BAA8B,QAAQ,CAAC,IAAI,eAAe,KAAK,CAAC,EAAE,uJAAuJ,CAC1N,CAAA;QACH,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAA;QAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgB,CAAA;QACnC,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,GAAG,CAAC,EAAE,CAAC;YAC5F,MAAM,IAAI,UAAU,CAClB,8BAA8B,QAAQ,CAAC,IAAI,eAAe,KAAK,CAAC,EAAE,iBAAiB,MAAM,CAAC,OAAO,CAAC,yDAAyD,GAAG,EAAE,CACjK,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;QACnD,MAAM,IAAI,UAAU,CAClB,2BAA2B,KAAK,CAAC,EAAE,2BAA2B,KAAK,gDAAgD,MAAM,CAAC,gBAAgB,2GAA2G,CACtP,CAAA;IACH,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,29 @@
+/**
+ * The PPR client runtime: one inline script in the shell, constant per release, listed in the CSP by
+ * hash. It fills each hole host from that hole's inert JSON frame, keeps interactive holes' props for
+ * the adapter, with a server component's record and HTML for the islands inside it, and on leaving
+ * the route sends the response's cancel token. `put` is how an adapter refills a host from a data
+ * request's fill, through the same sink; it writes only into a host of the hole it names, so the
+ * global cannot carry a string into any other element under the policy.
+ *
+ * `__nifraPpr(name)` is the only entry point a frame calls, so every invoker is constant per hole name
+ * and hashable at build. Hole HTML goes in through `innerHTML`, where a `<script>` never runs, under a
+ * Trusted Types policy named `nifra-ppr` when the browser has the API. The server has validated that
+ * HTML before framing it; the policy only names the one sink.
+ */
+export declare const PPR_RUNTIME: string;
+/**
+ * What loads each module script of a shell, after a `<link rel="modulepreload">` naming it. WebKit
+ * evaluates a module script, `async` or not, only once the parser finishes, which on a streamed page
+ * is after the slowest hole, and a dynamic import of the same URL waits with it. A dynamic import
+ * from a classic script with no such element evaluates at once in every engine.
+ */
+export declare const PPR_BOOT = "__nifraPpr.boot()";
+/** The script a frame runs to fill hole `name`. Constant per name, so it is listed by hash. */
+export declare const holeInvoker: (name: string) => string;
+/**
+ * The `script-src` hash sources a PPR route needs: the runtime, the boot call and one invoker per hole. Computed once
+ * per route at startup, never per request.
+ */
+export declare function pprScriptHashes(holeNames: readonly string[]): Promise<readonly string[]>;
+//# sourceMappingURL=runtime.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/runtime.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,QAG6lD,CAAA;AAErnD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,sBAAsB,CAAA;AAE3C,+FAA+F;AAC/F,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,MAA+C,CAAA;AAE1F;;;GAGG;AACH,wBAAsB,eAAe,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,CAE9F"}

package/dist/internal/ppr/runtime.js

@@ -0,0 +1,35 @@
+import { hashSource } from "../../csp.js";
+import { REVIVE_DATES_SOURCE } from "../revive-dates.js";
+/**
+ * The PPR client runtime: one inline script in the shell, constant per release, listed in the CSP by
+ * hash. It fills each hole host from that hole's inert JSON frame, keeps interactive holes' props for
+ * the adapter, with a server component's record and HTML for the islands inside it, and on leaving
+ * the route sends the response's cancel token. `put` is how an adapter refills a host from a data
+ * request's fill, through the same sink; it writes only into a host of the hole it names, so the
+ * global cannot carry a string into any other element under the policy.
+ *
+ * `__nifraPpr(name)` is the only entry point a frame calls, so every invoker is constant per hole name
+ * and hashable at build. Hole HTML goes in through `innerHTML`, where a `<script>` never runs, under a
+ * Trusted Types policy named `nifra-ppr` when the browser has the API. The server has validated that
+ * HTML before framing it; the policy only names the one sink.
+ */
+export const PPR_RUNTIME = "(()=>{" +
+    REVIVE_DATES_SOURCE +
+    ';var w=window,d=document,h={},s={},dead=0,p;var pol=function(){if(!p){try{p=w.trustedTypes?w.trustedTypes.createPolicy("nifra-ppr",{createHTML:function(x){return x}}):null}catch(_){}p=p||{createHTML:function(x){return x}}}return p};var ap=function(t,n,v){t.innerHTML=pol().createHTML(typeof v.html==="string"?v.html:"");t.setAttribute("data-nifra-filled","");t.setAttribute("aria-busy","false");if(v.error)t.setAttribute("data-nifra-hole-error","");else t.removeAttribute("data-nifra-hole-error");var o={props:__nifraDates(v.props),error:!!v.error};if(v.component){o.component=v.component;o.html=v.html}h[n]=o;return o};var f=function(n){if(dead)return;var e=d.getElementById("nifra-ppr:"+n);if(!e)return;var v;try{v=JSON.parse(e.textContent)}catch(_){return}e.remove();var t=d.querySelector(\'[data-nifra-hole="\'+n+\'"]\');if(!t||t.hasAttribute("data-nifra-filled"))return;var o=ap(t,n,v);(s[n]||[]).slice().forEach(function(c){c(o)})};f.put=function(n,v,t){if(v&&typeof v==="object"&&t&&t.getAttribute&&t.getAttribute("data-nifra-hole")===n)ap(t,n,v)};f.get=function(n){return h[n]};f.subscribe=function(n,c){(s[n]||(s[n]=[])).push(c);return function(){s[n]=(s[n]||[]).filter(function(x){return x!==c})}};f.leave=function(){if(dead)return;dead=1;s={};var r=d.getElementById("nifra-ppr-req");if(!r)return;var q;try{q=JSON.parse(r.textContent)}catch(_){return}if(q.cancel&&q.holes.some(function(n){return!h[n]})&&navigator.sendBeacon)navigator.sendBeacon(q.cancel,q.token)};f.dead=function(){return!!dead};f.boot=function(){var c=d.currentScript,e=c&&c.previousElementSibling;if(e&&e.rel==="modulepreload"&&e.href)import(e.href)};w.__nifraPpr=f})()';
+/**
+ * What loads each module script of a shell, after a `<link rel="modulepreload">` naming it. WebKit
+ * evaluates a module script, `async` or not, only once the parser finishes, which on a streamed page
+ * is after the slowest hole, and a dynamic import of the same URL waits with it. A dynamic import
+ * from a classic script with no such element evaluates at once in every engine.
+ */
+export const PPR_BOOT = "__nifraPpr.boot()";
+/** The script a frame runs to fill hole `name`. Constant per name, so it is listed by hash. */
+export const holeInvoker = (name) => `__nifraPpr(${JSON.stringify(name)})`;
+/**
+ * The `script-src` hash sources a PPR route needs: the runtime, the boot call and one invoker per hole. Computed once
+ * per route at startup, never per request.
+ */
+export async function pprScriptHashes(holeNames) {
+    return Promise.all([PPR_RUNTIME, PPR_BOOT, ...holeNames.map(holeInvoker)].map(hashSource));
+}
+//# sourceMappingURL=runtime.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../../src/internal/ppr/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAExD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,WAAW,GACtB,QAAQ;IACR,mBAAmB;IACnB,mnDAAmnD,CAAA;AAErnD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,mBAAmB,CAAA;AAE3C,+FAA+F;AAC/F,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAA;AAE1F;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAA4B;IAChE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAC5F,CAAC"}

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

@@ -0,0 +1,29 @@
+import { type CspPolicy } from "../../csp.js";
+import type { RenderAdapter } from "../../render-seam.js";
+import type { ShellCheckRecord } from "./compile-shell.js";
+import { type PprServer } from "./contract.js";
+import { type ResolvedPprOptions } from "./options.js";
+import type { SharedShellStore } from "./shell-store.js";
+export { type DynamicHole, type HoleRegistration, type HoleStatesMode, PPR_CANCEL_PATH, PPR_SERVER, type PprRequest, type PprServer, type PprServerStats, PprShellBusy, PprShellCold, PprShellUnavailable, PprShellUnchecked, type SharedHole, variationQuery, } from "./contract.js";
+export interface PprServerConfig {
+    readonly options: ResolvedPprOptions;
+    readonly adapter: RenderAdapter;
+    readonly csp?: CspPolicy;
+    /** Part of every shell key, so a shell built by one deployment is never served by another. */
+    readonly deployment: string;
+    /** The client entry `shellChecks` was recorded for; `deployment` when not given. */
+    readonly clientEntry?: string;
+    readonly cancelUrl: string;
+    /**
+     * The routes whose shell import check passed, for this deployment. A route not listed, or a record
+     * made for another deployment, gets no shared shell (fail closed). `"unchecked-development"` waives
+     * the check and is refused in production.
+     */
+    readonly shellChecks: ShellCheckRecord | "unchecked-development";
+    /** Milliseconds, for shell freshness. Tests pass their own clock. */
+    readonly now?: () => number;
+    /** Shells shared with other processes, behind this process's own; signed entries only. */
+    readonly shared?: SharedShellStore | undefined;
+}
+export declare function createPprServer(config: PprServerConfig): PprServer;
+//# sourceMappingURL=server.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/internal/ppr/server.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,SAAS,EAA0C,MAAM,cAAc,CAAA;AAErF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAKzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,EAGL,KAAK,SAAS,EAOf,MAAM,eAAe,CAAA;AAStB,OAAO,EAAE,KAAK,kBAAkB,EAAmB,MAAM,cAAc,CAAA;AAEvE,OAAO,KAAK,EAAE,gBAAgB,EAAe,MAAM,kBAAkB,CAAA;AAErE,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,eAAe,EACf,UAAU,EACV,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,KAAK,UAAU,EACf,cAAc,GACf,MAAM,eAAe,CAAA;AA0DtB,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAA;IACpC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,CAAA;IACxB,8FAA8F;IAC9F,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,oFAAoF;IACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,gBAAgB,GAAG,uBAAuB,CAAA;IAChE,qEAAqE;IACrE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAA;IAC3B,0FAA0F;IAC1F,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC/C;AAuWD,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CA2vClE"}