@nifrajs/web 3.3.0 → 4.0.0

package/dist/internal/page-execution.d.ts

@@ -0,0 +1,69 @@
+import { type ResponseResult } from "@nifrajs/core/server";
+import { type StaticBoundaryCache } from "../boundary.js";
+import type { CspPolicy } from "../csp.js";
+import { type CssLoadingMode } from "../css-contract.js";
+import type { Manifest, RouteEntry } from "../manifest.js";
+import type { NonceResolver } from "../nonce.js";
+import type { RenderAdapter } from "../render-seam.js";
+import { type RenderedPage } from "./render-document.js";
+import { type CoreResponseControls } from "./response-controls.js";
+export type { NonceResolver } from "../nonce.js";
+/** Structural context supplied by the core server to one page route handler. */
+export interface PageRouteContext<Env = unknown> {
+    readonly params: Record<string, string>;
+    readonly req: Request;
+    readonly env: Env;
+    /** The serving app's response controls; a loader's `ctx.set` queues its cookies through them. */
+    readonly set: CoreResponseControls;
+    /** The visitor's IP as the serving app derived it; forwarded to a request-bound `ctx.api`. */
+    readonly clientIp?: string | undefined;
+    readonly waitUntil?: (promise: Promise<unknown>) => void;
+}
+export interface PageExecutionOptions<Env = unknown> {
+    readonly adapter: RenderAdapter;
+    readonly manifest: Manifest;
+    readonly clientEntry: string;
+    readonly title?: string;
+    readonly api?: unknown;
+    readonly draftSecret?: string;
+    readonly routePreload?: Readonly<Record<string, readonly string[]>>;
+    readonly styles?: readonly string[];
+    readonly routeStyles?: Readonly<Record<string, readonly string[]>>;
+    readonly cssLoading?: CssLoadingMode;
+    readonly prerenderedPaths?: readonly string[];
+    /** Where pages fetch {@link prerenderedPaths} from when the list is too large to inline. */
+    readonly prerenderedListUrl?: string;
+    readonly staticFallbacks?: Readonly<Record<string, "ssr" | "404">>;
+    readonly staticBoundaryCache?: StaticBoundaryCache;
+    /** Per-request CSP nonce for framework-owned executable document scripts. */
+    readonly nonce?: NonceResolver<Env>;
+    /** A hash-based CSP policy: every document is rendered under it, carrying `nonce` only when needed. */
+    readonly csp?: CspPolicy;
+    /** Set once a cache wrapper attaches; until then a route's freshness and tags stay off the response. */
+    readonly cacheChannel?: {
+        readonly enabled: boolean;
+    };
+    readonly onLoaderError?: (error: unknown, ctx: {
+        readonly request: Request;
+        readonly params: Readonly<Record<string, string>>;
+        readonly route: string;
+    }) => void;
+}
+type PageResponse = Response | ResponseResult | RenderedPage;
+export interface PageRequestExecutor<Env = unknown> {
+    get(route: RouteEntry): (ctx: PageRouteContext<Env>) => Promise<PageResponse>;
+    post(route: RouteEntry): (ctx: PageRouteContext<Env>) => Promise<PageResponse>;
+    /** Answer a URL no route matched: the nearest nested `_404` for it, else the root one. */
+    fallback(ctx: PageRouteContext<Env>): Promise<PageResponse>;
+}
+/**
+ * Own the page request program behind one private seam.
+ *
+ * `createWebApp` remains responsible for app construction, mount ordering, and route registration.
+ * This module owns the page-specific contract: context, layout execution, control-flow precedence,
+ * data/document assembly, and error/status rendering. GET and POST retain their distinct ordering
+ * (ordinary layout data may run after an action; a gate must run before it) while sharing the same
+ * outcome and render decisions.
+ */
+export declare function createPageRequestExecutor<Env = unknown>(options: PageExecutionOptions<Env>): PageRequestExecutor<Env>;
+//# sourceMappingURL=page-execution.d.ts.map

package/dist/internal/page-execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-execution.d.ts","sourceRoot":"","sources":["../../src/internal/page-execution.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,KAAK,cAAc,EAA0B,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAKL,KAAK,mBAAmB,EAEzB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,KAAK,cAAc,EAA4C,MAAM,oBAAoB,CAAA;AAIlG,OAAO,KAAK,EAGV,QAAQ,EAIR,UAAU,EAGX,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAc,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAYlE,OAAO,EASL,KAAK,YAAY,EASlB,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAEL,KAAK,oBAAoB,EAS1B,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,gFAAgF;AAChF,MAAM,WAAW,gBAAgB,CAAC,GAAG,GAAG,OAAO;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACvC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,iGAAiG;IACjG,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAA;IAClC,8FAA8F;IAC9F,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;CACzD;AAqFD,MAAM,WAAW,oBAAoB,CAAC,GAAG,GAAG,OAAO;IACjD,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAA;IACnE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAA;IAClE,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,CAAA;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC7C,4FAA4F;IAC5F,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,KAAK,CAAC,CAAC,CAAA;IAClE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;IAClD,6EAA6E;IAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAA;IACnC,uGAAuG;IACvG,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,CAAA;IACxB,wGAAwG;IACxG,QAAQ,CAAC,YAAY,CAAC,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;IACrD,QAAQ,CAAC,aAAa,CAAC,EAAE,CACvB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE;QACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;QACzB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KACvB,KACE,IAAI,CAAA;CACV;AAED,KAAK,YAAY,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAA;AAE5D,MAAM,WAAW,mBAAmB,CAAC,GAAG,GAAG,OAAO;IAChD,GAAG,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,CAAA;IAC7E,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,CAAA;IAC9E,0FAA0F;IAC1F,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;CAC5D;AA4BD;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,GAAG,OAAO,EACrD,OAAO,EAAE,oBAAoB,CAAC,GAAG,CAAC,GACjC,mBAAmB,CAAC,GAAG,CAAC,CA+lC1B"}