lambder 4.2.1 → 4.2.3

package/Readme.md

@@ -4,10 +4,10 @@ Lambder is a highly opinionated dynamic serverless framework designed to facilit
 
 **New in 4.2:**
 
-- **Rate-limit budgets are explicit**: every policy declares `budget: "perApi"` (each referencing API gets its own counter, so the numbers are a per-API ceiling) or `budget: "perPolicy"` (one counter shared by every API referencing the policy). There is no default, so a declaration always says what its numbers span; the policy is the group, and two separate shared budgets are two policies.
+- **Rate-limit budgets**: a policy's `budget` is `"perApi"` (default: each referencing API gets its own counter, so the numbers are a per-API ceiling and three APIs on a 60/min policy allow one IP 180/min in total) or `"perPolicy"` (one counter shared by every API referencing the policy). The policy is the group, and two separate shared budgets are two policies.
 - **Per-API tuning**: the `rateLimit` option gained a map form like guards, `rateLimit: { lookupPerIp: { perMin: 20 } }`, which merges window overrides over a perApi policy's own (a tighter burst keeps the policy's daily cap). Overriding the windows of a perPolicy policy is a startup error; `errorMessage` is overridable on either.
 - **Retry-After**: a 429 carries the exceeded window's reset as a `Retry-After` header (CORS exposes it by default via the new `exposeHeaders` option), `LambderCaller` failure outcomes surface it as `retryAfterSeconds`, `LambderDdbRateLimiter.isRateLimited()` answers `false | { window, limit, resetAt }`, and `LambderApiError`/`refuse()` accept `headers`.
-- **One refusal shape**: every refusal the framework itself authors (rate limit 429, idempotency 409 and 400, unknown API) is a `LambderRefusalMessage` (`{ type, content }`), and a policy's `errorMessage` is typed as one, so an `errorMessageHandler` reading `.content` works everywhere.
+- **One refusal shape, with codes**: `LambderRefusalMessage` gained an optional machine-readable `code` (`refuse(content, { code })`), so clients branch and translate on an identifier instead of string-matching prose. Every refusal the framework itself authors (rate limit 429, idempotency 409 and 400, unknown API) is a `LambderRefusalMessage` stamped with a `LAMBDER_REFUSAL_CODES` constant under the reserved `lambder/` prefix; a rate-limit policy's own `errorMessage` (typed as a refusal message) inherits `lambder/rate-limited` unless it sets a code.
 - **One validation path**: preflight slices (guard `apiInput`/`guardInput`, rate-limit `apiInput` keys) answer through `setApiInputValidationErrorHandler` exactly like the API's own schema.
 
 **New in v4:**
@@ -479,7 +479,7 @@ Responses are finalized once at the end of the request: automatic gzip (when the
 
 ### Typed API Refusals (refuse / LambderApiError)
 
-A refusal ("you are not allowed", "quota exceeded") is not a crash. `res.die.*` covers refusals where you hold the resolver, but shared helpers (permission checks, validators) usually don't. The one-liner for the common case is `refuse()`: callable from anywhere in an API call's stack, it throws a typed refusal carrying the standard `LambderRefusalMessage` shape (`{ type, title?, content }`) that the pipeline maps onto the envelope's `errorMessage`, so refusals never pollute crash logging and clients get a parseable response:
+A refusal ("you are not allowed", "quota exceeded") is not a crash. `res.die.*` covers refusals where you hold the resolver, but shared helpers (permission checks, validators) usually don't. The one-liner for the common case is `refuse()`: callable from anywhere in an API call's stack, it throws a typed refusal carrying the standard `LambderRefusalMessage` shape (`{ type, code?, title?, content }`) that the pipeline maps onto the envelope's `errorMessage`, so refusals never pollute crash logging and clients get a parseable response:
 
 ```typescript
 import { refuse } from "lambder";
@@ -487,9 +487,12 @@ import { refuse } from "lambder";
 if (!row) refuse("Record not found.");                                  // { type: "warning", content }
 if (!isAdmin) refuse("Admins only.", { notAuthorized: true });          // + envelope flag
 refuse("Too many attempts.", { type: "error", statusCode: 429 });       // custom rendering intent + status
+if (exists) refuse("Already reported.", { code: "ALREADY_REPORTED" }); // + machine-readable identity
 // TypeScript applies never-return narrowing: after `if (!row) refuse(...)`, row is defined.
 ```
 
+`code` is the refusal's identity for machines: clients branch and translate on it (a translated client never displays `content`, it looks the code up), and `content` stays the human-readable fallback for codes a client does not know yet. Keep your app's codes as one typed vocabulary in shared code. The framework stamps the refusals it authors itself with `LAMBDER_REFUSAL_CODES` (exported from `lambder` and `lambder/client`) under the reserved `lambder/` prefix, so app codes never collide: `rateLimited`, `duplicateInFlight`, `invalidIdempotencyKey`, `apiNotFound`. A rate-limit policy's own `errorMessage` inherits `lambder/rate-limited` unless it sets a code, so an `errorMessageHandler` can treat every rate limit alike and still special-case the ones you name.
+
 For full control of the errorMessage payload (apps with their own message vocabulary), throw `LambderApiError` directly; `refuse()` is sugar over it:
 
 ```typescript
@@ -521,16 +524,16 @@ const lambder = initLambder<SessionData>().create({
     apiPath: "/api",
     // 1. Rate limiting: your limiter instance + named policies. Each policy
     //    declares its windows, what one counter tracks ("per"), and what one
-    //    budget spans ("budget", required so the numbers are never ambiguous):
-    //    "perApi" gives every referencing API its own counter (three APIs on a
-    //    60/min policy allow one IP 180/min in total), "perPolicy" makes every
-    //    referencing API share ONE counter. The policy IS the group: separate
-    //    shared budgets for, say, user APIs and report APIs are two policies.
+    //    budget spans ("budget"): "perApi" (default) gives every referencing
+    //    API its own counter, so three APIs on a 60/min policy allow one IP
+    //    180/min in total; "perPolicy" makes every referencing API share ONE
+    //    counter. The policy IS the group: separate shared budgets for, say,
+    //    user APIs and report APIs are two policies.
     rateLimits: {
         limiter: new LambderDdbRateLimiter({ tableName: "app-rate-limiter", region: "us-east-1", failOpen: true }),
         policies: {
-            authPerIp:    { perMin: 5, perHour: 30, per: "ip", budget: "perApi" },
-            writePerUser: { perMin: 30, per: "session", budget: "perApi" },   // only referable from addSessionApi (also enforced at compile time)
+            authPerIp:    { perMin: 5, perHour: 30, per: "ip" },
+            writePerUser: { perMin: 30, per: "session" },   // only referable from addSessionApi (also enforced at compile time)
             codePerEmail: {
                 perMin: 3,
                 // ONE combined budget across every API that references this

package/dist/client.d.ts

@@ -8,8 +8,8 @@
  */
 export { default as LambderCaller } from "./client/LambderCaller.js";
 export type { LambderApiOutcome, LambderApiFailureReason, LambderCallOptions, LambderIdempotencyKeyScope, } from "./client/LambderCaller.js";
-export { LambderApiError, isLambderApiError, refuse } from "./shared/LambderApiError.js";
-export type { LambderApiErrorOptions, LambderRefusalMessage, LambderRefuseOptions } from "./shared/LambderApiError.js";
+export { LambderApiError, isLambderApiError, refuse, LAMBDER_REFUSAL_CODES } from "./shared/LambderApiError.js";
+export type { LambderApiErrorOptions, LambderRefusalMessage, LambderRefusalCode, LambderRefuseOptions } from "./shared/LambderApiError.js";
 export type { ApiContractShape, LambderApiResponse, LambderApiResponseConfig } from "./shared/LambderApiContract.js";
 export { html, xml, raw, jsonScript, escapeHtml, renderHtmlValue, LambderSafeHtml, type LambderHtmlValue } from "./shared/LambderHtml.js";
 export { createLambderI18n } from "./shared/LambderI18n.js";

package/dist/client.js

@@ -10,7 +10,7 @@
 export { default as LambderCaller } from "./client/LambderCaller.js";
 // Typed API refusals (isomorphic: shared code may throw them from anywhere;
 // in the browser they are plain Errors).
-export { LambderApiError, isLambderApiError, refuse } from "./shared/LambderApiError.js";
+export { LambderApiError, isLambderApiError, refuse, LAMBDER_REFUSAL_CODES } from "./shared/LambderApiError.js";
 // Type-safe templating (tagged templates with auto-escaping)
 export { html, xml, raw, jsonScript, escapeHtml, renderHtmlValue, LambderSafeHtml } from "./shared/LambderHtml.js";
 // Typed translations (standalone, isomorphic)

package/dist/core/Lambder.js

@@ -6,7 +6,7 @@ import { applyCorsHeaders } from "./LambderCors.js";
 import LambderSessionManager from "../session/LambderSessionManager.js";
 import LambderSessionController from "../session/LambderSessionController.js";
 import { LambderPublicFilesHandler } from "./LambderPublicFiles.js";
-import { isLambderApiError } from "../shared/LambderApiError.js";
+import { isLambderApiError, LAMBDER_REFUSAL_CODES } from "../shared/LambderApiError.js";
 import { LambderApiPolicyEngine } from "../policies/LambderApiPolicies.js";
 import { createContext, isV2HttpEvent } from "./LambderContext.js";
 /**
@@ -423,7 +423,7 @@ export default class Lambder {
         if (isAPI) {
             if (this.apiFallbackHandler)
                 return await this.apiFallbackHandler(ctx, resolver);
-            return resolver.api(null, { errorMessage: { type: "warning", content: "API not found." } });
+            return resolver.api(null, { errorMessage: { type: "warning", code: LAMBDER_REFUSAL_CODES.apiNotFound, content: "API not found." } });
         }
         if (this.publicFilesHandler) {
             const fileResponse = await this.publicFilesHandler.handle(ctx);

package/dist/index.d.ts

@@ -3,8 +3,8 @@ export default Lambder;
 export { initLambder } from './core/Lambder.js';
 export { default as LambderCaller } from "./client/LambderCaller.js";
 export type { LambderApiOutcome, LambderApiFailureReason, LambderCallOptions, LambderIdempotencyKeyScope } from "./client/LambderCaller.js";
-export { LambderApiError, isLambderApiError, refuse } from "./shared/LambderApiError.js";
-export type { LambderApiErrorOptions, LambderRefusalMessage, LambderRefuseOptions } from "./shared/LambderApiError.js";
+export { LambderApiError, isLambderApiError, refuse, LAMBDER_REFUSAL_CODES } from "./shared/LambderApiError.js";
+export type { LambderApiErrorOptions, LambderRefusalMessage, LambderRefusalCode, LambderRefuseOptions } from "./shared/LambderApiError.js";
 export { default as LambderResponseBuilder } from "./core/LambderResponseBuilder.js";
 export { default as LambderResolver } from "./core/LambderResolver.js";
 export { default as LambderSessionManager } from "./session/LambderSessionManager.js";

package/dist/index.js

@@ -3,7 +3,7 @@ export default Lambder;
 export { initLambder } from './core/Lambder.js';
 export { default as LambderCaller } from "./client/LambderCaller.js";
 // Typed API refusals (isomorphic: shared code may throw them from anywhere)
-export { LambderApiError, isLambderApiError, refuse } from "./shared/LambderApiError.js";
+export { LambderApiError, isLambderApiError, refuse, LAMBDER_REFUSAL_CODES } from "./shared/LambderApiError.js";
 export { default as LambderResponseBuilder } from "./core/LambderResponseBuilder.js";
 export { default as LambderResolver } from "./core/LambderResolver.js";
 export { default as LambderSessionManager } from "./session/LambderSessionManager.js";

package/dist/policies/LambderApiIdempotency.js

@@ -1,4 +1,4 @@
-import { LambderApiError } from "../shared/LambderApiError.js";
+import { LambderApiError, LAMBDER_REFUSAL_CODES } from "../shared/LambderApiError.js";
 import { LambderResponse, normalizeHeaders } from "../core/LambderResponse.js";
 /** A crashed original must not block retries forever: pending claims expire on their own. */
 const IDEMPOTENCY_PENDING_TTL_SECONDS = 300;
@@ -40,7 +40,7 @@ export class LambderApiIdempotencyEngine {
             const content = `Invalid idempotency key: must be a string of ${IDEMPOTENCY_MIN_KEY_LENGTH}-${IDEMPOTENCY_MAX_KEY_LENGTH} characters.`;
             throw new LambderApiError(content, {
                 statusCode: 400,
-                errorMessage: { type: "error", content },
+                errorMessage: { type: "error", code: LAMBDER_REFUSAL_CODES.invalidIdempotencyKey, content },
             });
         }
         return rawKey;
@@ -116,7 +116,7 @@ export class LambderApiIdempotencyEngine {
         if (begun.state === "pending") {
             throw new LambderApiError(`Duplicate request for "${apiName}": the original is still processing.`, {
                 statusCode: 409,
-                errorMessage: { type: "warning", content: "This request is already being processed." },
+                errorMessage: { type: "warning", code: LAMBDER_REFUSAL_CODES.duplicateInFlight, content: "This request is already being processed." },
             });
         }
         if (begun.state === "done") {

package/dist/policies/LambderApiRateLimits.d.ts

@@ -42,13 +42,12 @@ export declare function lambderRateLimitKey(key: {
 /** What one rate-limit counter tracks: the client IP, the session identity, or a custom payload-derived key. */
 export type LambderRateLimitPer = "ip" | "session" | LambderRateLimitKeyFn<any>;
 /**
- * What one budget spans. Required on every policy, so a declaration always
- * says what its numbers mean:
+ * What one budget spans:
  *
- * - "perApi": every API referencing the policy gets its own counter, so the
- *   windows are a per-API ceiling (three APIs referencing a 60/min policy
- *   allow one subject 180/min in total). An API may tune the windows in its
- *   declaration: `rateLimit: { name: { perMin: 20 } }`.
+ * - "perApi" (default): every API referencing the policy gets its own
+ *   counter, so the windows are a per-API ceiling (three APIs referencing a
+ *   60/min policy allow one subject 180/min in total). An API may tune the
+ *   windows in its declaration: `rateLimit: { name: { perMin: 20 } }`.
  * - "perPolicy": every API referencing the policy shares ONE counter, so the
  *   windows are one combined budget (e.g. one per-email allowance across
  *   send, register, and reset). The policy IS the group: to give user APIs
@@ -58,9 +57,9 @@ export type LambderRateLimitBudget = "perApi" | "perPolicy";
 /** A named rate-limit policy: fixed windows, the key one counter tracks, and what one budget spans. */
 export type LambderApiRateLimitPolicyConfig = LambderRateLimitPolicy & {
     per: LambderRateLimitPer;
-    /** Whether the windows are a per-API ceiling or one budget shared by every referencing API. See LambderRateLimitBudget. */
-    budget: LambderRateLimitBudget;
-    /** Envelope errorMessage for refused requests. Default: a warning saying too many requests. */
+    /** Whether the windows are a per-API ceiling (default) or one budget shared by every referencing API. See LambderRateLimitBudget. */
+    budget?: LambderRateLimitBudget;
+    /** Envelope errorMessage for refused requests; inherits code "lambder/rate-limited" unless it sets its own. Default: a warning saying too many requests. */
     errorMessage?: LambderRefusalMessage;
 };
 export type LambderApiRateLimitsConfig<TPolicies extends Record<string, LambderApiRateLimitPolicyConfig>> = {
@@ -94,8 +93,8 @@ export type LambderRateLimitOverride = LambderRateLimitPolicy & {
     errorMessage?: LambderRefusalMessage;
 };
 type LambderRateLimitOverrideFor<TPolicy> = TPolicy extends {
-    budget: "perApi";
-} ? LambderRateLimitOverride : Pick<LambderRateLimitOverride, "errorMessage">;
+    budget: "perPolicy";
+} ? Pick<LambderRateLimitOverride, "errorMessage"> : LambderRateLimitOverride;
 /**
  * The per-API `rateLimit` option: one policy name, an ordered list of names,
  * or an object map that can carry each policy's override (`true` applies the

package/dist/policies/LambderApiRateLimits.js

@@ -1,9 +1,9 @@
 import { RATE_LIMIT_WINDOWS } from "../stores/LambderDdbRateLimiter.js";
-import { LambderApiError } from "../shared/LambderApiError.js";
+import { LambderApiError, LAMBDER_REFUSAL_CODES } from "../shared/LambderApiError.js";
 import { parsePreflightSlice } from "./LambderApiGuards.js";
 const RATE_LIMIT_WINDOW_KEYS = RATE_LIMIT_WINDOWS.map((window) => window.key);
 /** Refusal a rate-limited request answers unless the policy or the API's override names its own. */
-const DEFAULT_RATE_LIMIT_REFUSAL = { type: "warning", content: "Too many requests. Please try again later." };
+const DEFAULT_RATE_LIMIT_REFUSAL = { type: "warning", code: LAMBDER_REFUSAL_CODES.rateLimited, content: "Too many requests. Please try again later." };
 export function lambderRateLimitKey(key) { return key; }
 /** Normalize the three rateLimit-option forms into ordered entries; an explicit `undefined` map value declares nothing. */
 const toRateLimitEntries = (value) => {
@@ -41,8 +41,8 @@ export class LambderApiRateLimitsEngine {
                 throw new Error(`Lambder: rate-limit policy "${name}" declares no window (${RATE_LIMIT_WINDOW_KEYS.join("/")}).`);
             }
             const budget = policy.budget;
-            if (budget !== "perApi" && budget !== "perPolicy") {
-                throw new Error(`Lambder: rate-limit policy "${name}" needs budget: "perApi" (each referencing API counts separately) or "perPolicy" (one counter shared by every referencing API).`);
+            if (budget !== undefined && budget !== "perApi" && budget !== "perPolicy") {
+                throw new Error(`Lambder: rate-limit policy "${name}" has budget "${String(budget)}"; use "perApi" (default: each referencing API counts separately) or "perPolicy" (one counter shared by every referencing API).`);
             }
         }
         this.limiter = config.limiter;
@@ -91,8 +91,11 @@ export class LambderApiRateLimitsEngine {
             const exceeded = await this.limiter.isRateLimited(trackerKey, limits);
             if (exceeded) {
                 const retryAfterSeconds = Math.max(1, exceeded.resetAt - Math.floor(Date.now() / 1000));
+                // A policy's (or override's) own message inherits the framework
+                // code unless it sets a more specific one of its own.
+                const message = override?.errorMessage ?? policy.errorMessage;
                 throw new LambderApiError(`Rate limited: "${apiName}" exceeded policy "${name}" (${exceeded.window}: ${exceeded.limit}).`, {
-                    errorMessage: override?.errorMessage ?? policy.errorMessage ?? DEFAULT_RATE_LIMIT_REFUSAL,
+                    errorMessage: message ? { code: LAMBDER_REFUSAL_CODES.rateLimited, ...message } : DEFAULT_RATE_LIMIT_REFUSAL,
                     statusCode: 429,
                     headers: { "Retry-After": String(retryAfterSeconds) },
                 });

package/dist/shared/LambderApiError.d.ts

@@ -57,17 +57,43 @@ export declare class LambderApiError extends Error {
 export declare const isLambderApiError: (err: unknown) => err is LambderApiError;
 /**
  * The standard shape refusals carry on the envelope's errorMessage field.
- * The caller's errorMessageHandler receives it as-is; apps with their own
- * errorMessage vocabulary can keep using LambderApiError directly instead.
+ * `code` is the refusal's machine-readable identity: clients branch and
+ * translate on it and never string-match `content`, which stays the
+ * human-readable fallback for codes a client does not know yet. Apps keep
+ * their own typed code vocabulary; the framework's own refusals carry a
+ * LambderRefusalCode. The caller's errorMessageHandler receives the object
+ * as-is; apps with their own errorMessage vocabulary can keep using
+ * LambderApiError directly instead.
  */
 export type LambderRefusalMessage = {
     type: "warning" | "error" | "info";
+    /** Machine-readable identity of the refusal (the app's own vocabulary, or a LambderRefusalCode). */
+    code?: string;
     title?: string;
     content: string;
 };
+/**
+ * Codes the framework stamps on the refusals it authors itself, under the
+ * reserved `lambder/` prefix so app codes never collide. Compare against
+ * these constants on the client (exported from `lambder/client` too) rather
+ * than retyping the strings.
+ */
+export declare const LAMBDER_REFUSAL_CODES: {
+    /** A rate-limit policy refused (429). A policy's own errorMessage inherits this unless it sets a code. */
+    readonly rateLimited: "lambder/rate-limited";
+    /** The original of an idempotent request is still processing (409). */
+    readonly duplicateInFlight: "lambder/duplicate-in-flight";
+    /** The idempotencyKey is malformed (400). */
+    readonly invalidIdempotencyKey: "lambder/invalid-idempotency-key";
+    /** No API is registered under the requested name. */
+    readonly apiNotFound: "lambder/api-not-found";
+};
+export type LambderRefusalCode = (typeof LAMBDER_REFUSAL_CODES)[keyof typeof LAMBDER_REFUSAL_CODES];
 export type LambderRefuseOptions = {
     /** Rendering intent for the client's errorMessageHandler. Default: "warning". */
     type?: LambderRefusalMessage["type"];
+    /** Machine-readable identity of the refusal, for clients to branch and translate on. */
+    code?: string;
     /** Optional heading shown above the content. */
     title?: string;
     /** Sets the envelope's notAuthorized flag (routed to the caller's notAuthorizedHandler). */

package/dist/shared/LambderApiError.js

@@ -38,6 +38,22 @@ export class LambderApiError extends Error {
 }
 /** Brand-based type guard (see LambderApiError.isLambderApiError). */
 export const isLambderApiError = (err) => err instanceof Error && err.isLambderApiError === true;
+/**
+ * Codes the framework stamps on the refusals it authors itself, under the
+ * reserved `lambder/` prefix so app codes never collide. Compare against
+ * these constants on the client (exported from `lambder/client` too) rather
+ * than retyping the strings.
+ */
+export const LAMBDER_REFUSAL_CODES = {
+    /** A rate-limit policy refused (429). A policy's own errorMessage inherits this unless it sets a code. */
+    rateLimited: "lambder/rate-limited",
+    /** The original of an idempotent request is still processing (409). */
+    duplicateInFlight: "lambder/duplicate-in-flight",
+    /** The idempotencyKey is malformed (400). */
+    invalidIdempotencyKey: "lambder/invalid-idempotency-key",
+    /** No API is registered under the requested name. */
+    apiNotFound: "lambder/api-not-found",
+};
 /**
  * Refuse the current API call: a routine business "no" (not found, invalid
  * input, not allowed) with a user-facing message. Throws a LambderApiError
@@ -54,6 +70,7 @@ export const refuse = (content, options = {}) => {
     throw new LambderApiError(content, {
         errorMessage: {
             type: options.type ?? "warning",
+            ...(options.code !== undefined ? { code: options.code } : {}),
             ...(options.title !== undefined ? { title: options.title } : {}),
             content,
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambder",
-  "version": "4.2.1",
+  "version": "4.2.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",