lambder 2.0.18 → 3.0.0

package/dist/LambderResolver.js

@@ -1,52 +1,38 @@
 import LambderResponseBuilder from "./LambderResponseBuilder.js";
+/**
+ * Response builder passed to route/api handlers and hooks.
+ *
+ * `res.die.*` builds the response and THROWS it, immediately halting the
+ * request at any call depth (handlers, hooks, nested service functions).
+ * Lambder's render pipeline catches thrown LambderResponse instances and uses
+ * them as the response. Plain `throw res.html(...)` works the same way.
+ */
 export default class LambderResolver extends LambderResponseBuilder {
-    resolve;
-    reject;
     die;
-    constructor({ isCorsEnabled, publicPath, apiVersion, lambderUtils, ctx, resolve, reject }) {
-        super({ isCorsEnabled, publicPath, apiVersion, lambderUtils, ctx, });
-        this.resolve = resolve;
-        this.reject = reject;
+    constructor(...args) {
+        super(...args);
         this.die = {
-            raw: this.autoResolve(this.raw),
-            json: this.autoResolve(this.json),
-            xml: this.autoResolve(this.xml),
-            html: this.autoResolve(this.html),
-            redirect: this.autoResolve(this.redirect),
-            status404: this.autoResolve(this.status404),
-            cors: this.autoResolve(this.cors),
-            fileBase64: this.autoResolve(this.fileBase64),
-            file: this.autoResolvePromise(this.file),
-            ejsFile: this.autoResolvePromise(this.ejsFile),
-            ejsTemplate: this.autoResolvePromise(this.ejsTemplate),
-            api: this.autoResolve(this.api),
+            raw: (...a) => { throw this.raw(...a); },
+            json: (...a) => { throw this.json(...a); },
+            text: (...a) => { throw this.text(...a); },
+            xml: (...a) => { throw this.xml(...a); },
+            html: (...a) => { throw this.html(...a); },
+            status: (...a) => { throw this.status(...a); },
+            status404: (...a) => { throw this.status404(...a); },
+            redirect: (...a) => { throw this.redirect(...a); },
+            versionExpired: (...a) => { throw this.versionExpired(...a); },
+            fileBase64: (...a) => { throw this.fileBase64(...a); },
+            api: (...a) => { throw this.api(...a); },
+            apiBinary: (...a) => { throw this.apiBinary(...a); },
+            file: async (...a) => { throw await this.file(...a); },
+            templateFile: async (...a) => { throw await this.templateFile(...a); },
         };
     }
-    // Override api method with proper typing
-    api(payload, config, headers) {
-        return super.api(payload, config, headers);
+    // Override api method with proper output typing
+    api(payload, config, options) {
+        return super.api(payload, config, options);
     }
-    autoResolve(method) {
-        return (...args) => {
-            const result = method.apply(this, args);
-            this.resolve(result);
-            return result;
-        };
-    }
-    autoResolvePromise(method) {
-        return (...args) => {
-            return new Promise((resolve, reject) => {
-                method.apply(this, args)
-                    .then(result => {
-                    this.resolve(result);
-                    resolve(result);
-                })
-                    .catch(err => {
-                    this.reject(err);
-                    reject(err);
-                });
-            });
-        };
+    apiBinary(payload, config, options) {
+        return super.apiBinary(payload, config, options);
     }
 }
-;

package/dist/LambderResponse.d.ts

@@ -0,0 +1,71 @@
+import type { LambderRenderContext } from "./LambderContext.js";
+export type HttpStatusCode = 100 | 101 | 200 | 201 | 202 | 203 | 204 | 206 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 408 | 409 | 410 | 412 | 413 | 415 | 416 | 418 | 422 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504;
+export type LambderHeadersInput = Record<string, string | string[]>;
+/**
+ * Final Lambda response: v1 (REST API) uses multiValueHeaders, v2 (HTTP API /
+ * Function URLs) uses headers + cookies. Assignable to both official aws-lambda
+ * result types (compile-time asserted below), so exporting getHandler() as an
+ * APIGatewayProxyHandler / APIGatewayProxyHandlerV2 is type-safe.
+ */
+export type LambderHttpResponse = {
+    statusCode: number;
+    body: string;
+    isBase64Encoded: boolean;
+    /** API Gateway REST API (payload v1). */
+    multiValueHeaders?: Record<string, string[]>;
+    /** API Gateway HTTP API / Lambda Function URLs (payload v2). */
+    headers?: Record<string, string>;
+    cookies?: string[];
+};
+export type LambderHttpEventFormat = "v1" | "v2";
+export declare const normalizeHeaders: (headers?: LambderHeadersInput) => Record<string, string[]>;
+export type LambderResponseInit = {
+    statusCode: HttpStatusCode;
+    headers?: LambderHeadersInput;
+    body?: string | Buffer | null;
+    /** True when body is already a base64-encoded string (pre-encoded binary content). */
+    isBodyBase64?: boolean;
+    /** "auto": gzip when enabled + compressible + large enough. true: force (if client accepts). false: never. */
+    compress?: boolean | "auto";
+    /** "auto": ETag on GET/HEAD 200 when globally enabled. true: force. false: never. */
+    etag?: boolean | "auto";
+};
+/**
+ * Intermediate response object returned by all response builder methods and by
+ * route/api handlers. Bodies stay uncompressed and un-encoded so hooks can
+ * still transform them; a single finalize step at the end of render() applies
+ * compression, ETag/304 handling and base64 encoding.
+ *
+ * Throwing a LambderResponse anywhere inside a handler or hook short-circuits
+ * the request: the thrown response becomes the response.
+ */
+export declare class LambderResponse {
+    statusCode: HttpStatusCode;
+    headers: Record<string, string[]>;
+    body: string | Buffer | null;
+    isBodyBase64: boolean;
+    compress: boolean | "auto";
+    etag: boolean | "auto";
+    constructor(init: LambderResponseInit);
+    getHeader(key: string): string[] | undefined;
+    setHeader(key: string, value: string | string[]): this;
+    addHeader(key: string, value: string): this;
+}
+export declare const isCompressibleContentType: (contentType: string | undefined) => boolean;
+export declare const acceptsEncoding: (acceptEncoding: string | undefined | null, encoding: string) => boolean;
+export type LambderFinalizeOptions = {
+    compression: false | {
+        minBytes: number;
+    };
+    etag: boolean;
+    /** Guard against Lambda's ~6MB response cap with a clear error. */
+    maxResponseBytes: number;
+};
+export declare const DEFAULT_FINALIZE_OPTIONS: LambderFinalizeOptions;
+/**
+ * Convert an intermediate LambderResponse into the final Lambda response:
+ * gzip negotiation (Accept-Encoding), ETag + If-None-Match 304, base64
+ * encoding, HEAD body stripping, and Lambda payload size guard. Emits the v1
+ * (REST API) or v2 (HTTP API / Function URL) response shape.
+ */
+export declare const finalizeResponse: (ctx: Pick<LambderRenderContext, "method" | "headers"> | null, response: LambderResponse, options: LambderFinalizeOptions, format?: LambderHttpEventFormat) => Promise<LambderHttpResponse>;

package/dist/LambderResponse.js

@@ -0,0 +1,196 @@
+import { getZlib, getCrypto } from "./node-polyfills.js";
+export const normalizeHeaders = (headers) => Object.fromEntries(Object.entries(headers ?? {}).map(([k, v]) => [k, Array.isArray(v) ? [...v] : [v]]));
+/**
+ * Intermediate response object returned by all response builder methods and by
+ * route/api handlers. Bodies stay uncompressed and un-encoded so hooks can
+ * still transform them; a single finalize step at the end of render() applies
+ * compression, ETag/304 handling and base64 encoding.
+ *
+ * Throwing a LambderResponse anywhere inside a handler or hook short-circuits
+ * the request: the thrown response becomes the response.
+ */
+export class LambderResponse {
+    statusCode;
+    headers;
+    body;
+    isBodyBase64;
+    compress;
+    etag;
+    constructor(init) {
+        this.statusCode = init.statusCode;
+        this.headers = normalizeHeaders(init.headers);
+        this.body = init.body ?? null;
+        this.isBodyBase64 = init.isBodyBase64 ?? false;
+        this.compress = init.compress ?? "auto";
+        this.etag = init.etag ?? "auto";
+    }
+    getHeader(key) {
+        const lower = key.toLowerCase();
+        for (const [k, v] of Object.entries(this.headers)) {
+            if (k.toLowerCase() === lower)
+                return v;
+        }
+        return undefined;
+    }
+    setHeader(key, value) {
+        const lower = key.toLowerCase();
+        for (const k of Object.keys(this.headers)) {
+            if (k.toLowerCase() === lower)
+                delete this.headers[k];
+        }
+        this.headers[key] = Array.isArray(value) ? [...value] : [value];
+        return this;
+    }
+    addHeader(key, value) {
+        const lower = key.toLowerCase();
+        const existingKey = Object.keys(this.headers).find((k) => k.toLowerCase() === lower);
+        if (existingKey) {
+            this.headers[existingKey].push(value);
+        }
+        else {
+            this.headers[key] = [value];
+        }
+        return this;
+    }
+}
+export const isCompressibleContentType = (contentType) => {
+    if (!contentType)
+        return false;
+    const mime = (contentType.split(";")[0] ?? "").trim().toLowerCase();
+    if (mime.startsWith("text/"))
+        return true;
+    if (mime.endsWith("+json") || mime.endsWith("+xml"))
+        return true;
+    return [
+        "application/json",
+        "application/javascript",
+        "application/x-javascript",
+        "application/xml",
+        "application/wasm",
+        "image/svg+xml",
+        "application/lambder-json-stream",
+    ].includes(mime);
+};
+export const acceptsEncoding = (acceptEncoding, encoding) => {
+    if (!acceptEncoding)
+        return false;
+    return acceptEncoding.split(",").some((part) => {
+        const [token, ...params] = part.trim().split(";");
+        const name = (token ?? "").trim().toLowerCase();
+        if (name !== encoding && name !== "*")
+            return false;
+        const q = params.map((p) => p.trim()).find((p) => p.startsWith("q="));
+        return !q || Number(q.slice(2)) > 0;
+    });
+};
+export const DEFAULT_FINALIZE_OPTIONS = {
+    compression: { minBytes: 860 },
+    etag: true,
+    maxResponseBytes: 5_500_000,
+};
+const getRequestHeader = (ctx, name) => {
+    if (!ctx?.headers)
+        return undefined;
+    const lower = name.toLowerCase();
+    for (const [k, v] of Object.entries(ctx.headers)) {
+        if (k.toLowerCase() === lower)
+            return v ?? undefined;
+    }
+    return undefined;
+};
+/** Emit the format-specific Lambda response shape. */
+const emitResponse = (format, statusCode, headers, body, isBase64Encoded) => {
+    if (format === "v2") {
+        // Payload v2 has no multiValueHeaders: multi-values are comma-joined,
+        // except Set-Cookie which uses the dedicated cookies array.
+        const singleHeaders = {};
+        const cookies = [];
+        for (const [key, values] of Object.entries(headers)) {
+            if (key.toLowerCase() === "set-cookie")
+                cookies.push(...values);
+            else
+                singleHeaders[key] = values.join(", ");
+        }
+        return { statusCode, headers: singleHeaders, cookies, body, isBase64Encoded };
+    }
+    return { statusCode, multiValueHeaders: headers, body, isBase64Encoded };
+};
+/**
+ * Convert an intermediate LambderResponse into the final Lambda response:
+ * gzip negotiation (Accept-Encoding), ETag + If-None-Match 304, base64
+ * encoding, HEAD body stripping, and Lambda payload size guard. Emits the v1
+ * (REST API) or v2 (HTTP API / Function URL) response shape.
+ */
+export const finalizeResponse = async (ctx, response, options, format = "v1") => {
+    const method = (ctx?.method ?? "GET").toUpperCase();
+    if (response.body === null) {
+        return emitResponse(format, response.statusCode, response.headers, "", false);
+    }
+    let outBody;
+    let isBase64 = false;
+    if (response.isBodyBase64) {
+        // Pre-encoded binary content: passes through untouched (no compression).
+        outBody = String(response.body);
+        isBase64 = true;
+    }
+    else {
+        let bodyBuffer = Buffer.isBuffer(response.body)
+            ? response.body
+            : Buffer.from(String(response.body), "utf8");
+        const contentType = response.getHeader("Content-Type")?.[0];
+        const alreadyEncoded = !!response.getHeader("Content-Encoding");
+        const eligibleForCompression = !alreadyEncoded && (response.compress === true ||
+            (response.compress === "auto" &&
+                options.compression !== false &&
+                bodyBuffer.length >= options.compression.minBytes &&
+                isCompressibleContentType(contentType)));
+        if (eligibleForCompression) {
+            // Vary even when this client didn't accept an encoding, to keep caches correct.
+            response.addHeader("Vary", "Accept-Encoding");
+            if (acceptsEncoding(getRequestHeader(ctx, "accept-encoding"), "gzip")) {
+                const zlib = await getZlib();
+                if (zlib) {
+                    bodyBuffer = zlib.gzipSync(bodyBuffer);
+                    response.setHeader("Content-Encoding", "gzip");
+                }
+            }
+        }
+        if (Buffer.isBuffer(response.body) || response.getHeader("Content-Encoding")) {
+            outBody = bodyBuffer.toString("base64");
+            isBase64 = true;
+        }
+        else {
+            outBody = bodyBuffer.toString("utf8");
+        }
+    }
+    const etagEnabled = response.etag === true || (response.etag === "auto" &&
+        options.etag &&
+        response.statusCode === 200 &&
+        (method === "GET" || method === "HEAD"));
+    if (etagEnabled) {
+        const crypto = await getCrypto();
+        if (crypto) {
+            const etagValue = `"${crypto.createHash("sha256").update(outBody).digest("hex").slice(0, 32)}"`;
+            response.setHeader("ETag", etagValue);
+            const ifNoneMatch = getRequestHeader(ctx, "if-none-match");
+            if (ifNoneMatch && ifNoneMatch.split(",").map((s) => s.trim()).includes(etagValue)) {
+                const preservedHeaders = {};
+                for (const key of ["ETag", "Cache-Control", "Vary", "Expires", "Last-Modified"]) {
+                    const value = response.getHeader(key);
+                    if (value)
+                        preservedHeaders[key] = value;
+                }
+                return emitResponse(format, 304, preservedHeaders, "", false);
+            }
+        }
+    }
+    if (method === "HEAD") {
+        return emitResponse(format, response.statusCode, response.headers, "", false);
+    }
+    if (outBody.length > options.maxResponseBytes) {
+        throw new Error(`Lambder: final response body is ${outBody.length} bytes which exceeds the configured ` +
+            `maxResponseBytes (${options.maxResponseBytes}). Lambda caps proxy responses at ~6MB. ` +
+            `Consider pagination or enabling compression.`);
+    }
+    return emitResponse(format, response.statusCode, response.headers, outBody, isBase64);
+};

package/dist/LambderResponseBuilder.d.ts

@@ -1,11 +1,16 @@
-import LambderUtils from "./LambderUtils.js";
-import { LambderRenderContext } from "./LambderContext.js";
-export type HttpStatusCode = 200 | 201 | 202 | 204 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 403 | 404 | 405 | 409 | 410 | 413 | 415 | 422 | 429 | 500 | 501 | 502 | 503 | 504;
-export type LambderResolverResponse = {
-    statusCode: HttpStatusCode;
-    multiValueHeaders?: Record<string, string[]>;
-    body: string | null;
-    isBase64Encoded?: boolean;
+import type { LambderRenderContext } from "./LambderContext.js";
+import { LambderResponse, type HttpStatusCode, type LambderHeadersInput } from "./LambderResponse.js";
+import { LambderSafeHtml } from "./LambderHtml.js";
+import { type LambderTemplateData } from "./LambderTemplatingEngine.js";
+export type LambderResponseOptions = {
+    statusCode?: HttpStatusCode;
+    headers?: LambderHeadersInput;
+    /** Shorthand for the Cache-Control header. */
+    cacheControl?: string;
+    /** "auto" (default): gzip when compressible/large enough. true: force. false: never. */
+    compress?: boolean | "auto";
+    /** "auto" (default): ETag on GET/HEAD 200 when globally enabled. true: force. false: never. */
+    etag?: boolean | "auto";
 };
 export type LambderApiResponseConfig = {
     versionExpired?: boolean;
@@ -16,38 +21,58 @@ export type LambderApiResponseConfig = {
     logList?: any[];
 };
 export type LambderApiResponse<T> = LambderApiResponseConfig & {
+    apiVersion?: string | null;
     payload?: T | null;
 };
+export type LambderRawResponseInit = {
+    statusCode: HttpStatusCode;
+    headers?: LambderHeadersInput;
+    /** Legacy alias for headers (API Gateway naming). */
+    multiValueHeaders?: Record<string, string[]>;
+    body: string | Buffer | null;
+    /** True when body is already a base64-encoded string. */
+    isBase64Encoded?: boolean;
+    compress?: boolean | "auto";
+    etag?: boolean | "auto";
+};
 export default class LambderResponseBuilder<TResponse = any> {
-    private isCorsEnabled;
-    private publicPath;
-    private apiVersion;
-    private lambderUtils;
-    private ctx?;
-    constructor({ isCorsEnabled, publicPath, apiVersion, lambderUtils, ctx }: {
-        isCorsEnabled: boolean;
+    protected publicPath: string;
+    protected apiVersion: string | null;
+    protected ctx?: LambderRenderContext;
+    constructor({ publicPath, apiVersion, ctx }: {
         publicPath: string;
         apiVersion?: string | null;
-        lambderUtils: LambderUtils;
-        ctx?: LambderRenderContext<any>;
+        ctx?: LambderRenderContext;
     });
-    private readPublicFileSync;
-    private checkPublicFileExist;
+    private buildResponse;
+    private resolvePublicFilePath;
     addHeader(key: string, value: string): void;
     setHeader(key: string, value: string | string[]): void;
     logToApiResponse(input: any): void;
-    raw(param: LambderResolverResponse): LambderResolverResponse;
-    json(data: Record<string, any>, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    xml(data: string): LambderResolverResponse;
-    html(data: string, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    redirect(url: string, statusCode?: HttpStatusCode, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    status404(data: string, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    versionExpired(headers?: Record<string, string | string[]>): LambderResolverResponse;
-    cors(): LambderResolverResponse;
-    fileBase64(fileBase64: string, mimeType: string, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    file(filePath: string, headers?: Record<string, string | string[]>, fallbackFilePath?: string): Promise<LambderResolverResponse>;
-    ejsTemplate(template: string, pageData: Record<string, any>, headers?: Record<string, string | string[]>): Promise<LambderResolverResponse>;
-    ejsFile(filePath: string, pageData: Record<string, any>, headers?: Record<string, string | string[]>): Promise<LambderResolverResponse>;
-    api(payload: TResponse | null, { versionExpired, sessionExpired, notAuthorized, message, errorMessage, logList, }?: LambderApiResponseConfig, headers?: Record<string, string | string[]>): LambderResolverResponse;
-    apiBinary<T = any>(payload: T | null, { versionExpired, sessionExpired, notAuthorized, message, errorMessage, logList, }?: LambderApiResponseConfig, headers?: Record<string, string | string[]>): LambderResolverResponse;
+    raw(init: LambderRawResponseInit): LambderResponse;
+    json(data: Record<string, any>, options?: LambderResponseOptions): LambderResponse;
+    text(data: string, options?: LambderResponseOptions): LambderResponse;
+    xml(data: string | LambderSafeHtml, options?: LambderResponseOptions): LambderResponse;
+    html(data: string | LambderSafeHtml, options?: LambderResponseOptions): LambderResponse;
+    status(statusCode: HttpStatusCode, body?: string, options?: LambderResponseOptions): LambderResponse;
+    status404(data: string, options?: LambderResponseOptions): LambderResponse;
+    redirect(url: string, statusCode?: HttpStatusCode, options?: LambderResponseOptions): LambderResponse;
+    versionExpired(options?: LambderResponseOptions): LambderResponse;
+    fileBase64(fileBase64: string, mimeType: string, options?: LambderResponseOptions): LambderResponse;
+    file(filePath: string, options?: LambderResponseOptions & {
+        fallback?: string;
+    }): Promise<LambderResponse>;
+    /**
+     * Render an HTML file under publicPath through LambderTemplatingEngine
+     * (comment-based slots/conditionals) and return it as an HTML response.
+     * The compiled template is cached across warm invocations; a missing file
+     * throws (it is a server-side configuration error, not a client 404).
+     * Set htmlVirtualSlots to expose "title"/"head" slots on marker-less files.
+     */
+    templateFile(filePath: string, data?: LambderTemplateData, options?: LambderResponseOptions & {
+        htmlVirtualSlots?: boolean;
+    }): Promise<LambderResponse>;
+    api(payload: TResponse | null, { versionExpired, sessionExpired, notAuthorized, message, errorMessage, logList, }?: LambderApiResponseConfig, options?: LambderResponseOptions): LambderResponse;
+    /** Same as api() but forces gzip compression of the response body. */
+    apiBinary(payload: TResponse | null, config?: LambderApiResponseConfig, options?: LambderResponseOptions): LambderResponse;
 }