@luckystack/api 0.10.2 → 0.11.0

package/docs/api-request-lifecycle.md

@@ -1,278 +1,5 @@
-# API Request Lifecycle
+# API request lifecycle
 
-## Overview
+Socket and HTTP entry points should enforce the same route-level authorization, limits, input-validation and response policies; a difference in transport must not open a bypass. The order matters where it protects information: resolve the route to find its policy, then reject unauthorized callers before exposing input-schema or HTTP-method details. Route names themselves are not secret; clients receive them in generated artifacts. See `../src/handleApiRequest.ts`, `../src/handleHttpApiRequest.ts`, `../src/transportParity.test.ts`.
 
-`@luckystack/api` exposes two transport adapters — `handleApiRequest` (socket.io) and `handleHttpApiRequest` (raw HTTP) — that share an identical 13-step pipeline. The pipeline takes a transport payload, resolves it to a registered route in the runtime maps emitted by `@luckystack/devkit`, runs authentication / rate-limit / input-validation gates, dispatches a fixed set of lifecycle hooks, executes the route's `main(...)` function under a `tryCatch` boundary, then normalizes the result into a localized envelope before emitting it on the wire.
-
-Both transports are pure functions over the runtime maps + session state. Neither one mutates module state or constructs the io server — the socket and HTTP listeners in `@luckystack/server` import these handlers and feed them messages. Consumers building a third transport (queue worker, gRPC bridge, Lambda adapter) should call the same handlers with a synthetic `Socket` or with the HTTP signature so they get the identical contract.
-
-The full ordering is authoritative. Deviating in a fork breaks every downstream consumer that relies on the hook payloads firing in a known order (audit handlers, rate-limit dashboards, response-mutating middleware).
-
-## Pipeline order (13 steps)
-
-Both transports execute the same sequence. The HTTP transport adds one extra step (method check).
-
-1. **Parse message / payload shape.** Socket transport calls `validateApiMessage` to confirm `responseIndex` is present and `name` / `data` are well-typed. HTTP transport inline-checks `name` (string) and `data` (object); rejects with `api.invalidName` / `api.invalidDataObject` if either is malformed.
-2. **`readSession(token)` → resolve `user`.** Reads the session via `@luckystack/core`'s session-provider registry (`readSession`). Preferred locale is also extracted here from `x-language` / `accept-language` headers using `extractLanguageFromHeader`. Error-tracker identity is propagated to registered trackers via `setCurrentErrorTrackerIdentity` (ALS-based per-request scope opened by `runWithErrorTrackerIdentityScope`) — NOT a direct `setSentryUser` call; that moved to hook subscribers in `@luckystack/error-tracking` (`preApiExecute` / `preApiValidate`).
-3. **`parseTransportRouteName({ value, prefix: 'api' })`.** Rejects names that are not of the form `api/<page>/<name>/v<N>`. Returns the normalized name used downstream as `resolvedName`. Bad shapes return `routing.invalidServiceRouteName` with the original `name` echoed back as `errorParams[0].value`.
-4. **Built-in `system/logout` shortcut (socket only).** When the parsed route normalizes to `system/logout`, the handler applies the global per-IP rate-limit bucket, then calls `performLogout({ token, socket, userId })` and short-circuits with a `{ status: 'success', httpStatus: 200, result: true }` envelope routed through `emitApiResult` (so `preApiRespond`, `transformApiResponse`, and `postApiRespond` still fire). **Hooks that are skipped for logout:** `checkApiAuth` (no auth gate), `preApiValidate`, `postApiValidate`, `preApiExecute`, `postApiExecute`. HTTP transport does not have this shortcut — logout over HTTP goes through the normal route execution.
-5. **`getRuntimeApiMaps()` + route lookup.** Reads the registered `apisObject` / `functionsObject`. Missing routes return `api.notFound` with `404`.
-6. **`checkApiAuth({ apiEntry, user, name })`.** Two-stage auth gate: first checks `auth.login` (returns `auth.required` + `401` if missing), then runs `validateRequest({ auth, user })` which evaluates `auth.additional[]` predicates. Failures return `auth.forbidden` (or the predicate's overridden `errorCode`) with the predicate's `httpStatus` or `403` fallback. See [`./auth-flow.md`](./auth-flow.md).
-7. **`applyApiRateLimits(...)`.** Two-bucket rate limit: per-route (uses the route's `rateLimit` export, or `rateLimiting.defaultApiLimit` fallback) keyed by `<token|ip>:<id>:api:<route>`, then a global per-IP bucket keyed by `ip:<ip>:api:all` (uses `rateLimiting.defaultIpLimit`). Either rejection emits `rateLimitExceeded` and returns `api.rateLimitExceeded` + `429`. See [`./rate-limiting.md`](./rate-limiting.md).
-8. **HTTP-only: method check.** `expectedMethod = apiEntry.httpMethod ?? inferHttpMethod(resolvedName)`. Mismatched methods return `api.methodNotAllowed` + `405` with `errorParams: [{ key: 'method', value: expectedMethod }]`. Method check runs after auth + rate limit, on purpose — unauthenticated callers should not learn whether a method-incorrect route exists.
-9. **`preApiValidate` hook → `validateInputByType(...)` → `postApiValidate` hook.** Hook fires before validation runs (handlers can mutate `data`, can NOT stop). `validateInputByType` checks the payload against the Zod-equivalent schema derived from the route's `inputType` text. On the socket transport only, the per-route `validation: 'relaxed'` or `validation: { input: 'skip' }` flag skips validation entirely (useful for third-party webhooks). Validation failures return the generic `api.invalidInputType` code — the validator's message is NOT echoed to the client (that would let unauthenticated callers enumerate the input schema); it travels to the `postApiValidate` hook (`validation.message`) and the dev logs instead. `postApiValidate` always fires with the resulting validation result, even on skip.
-10. **`preApiExecute` hook.** Last gate before execution. A handler may return a `HookStopSignal` (`{ stop: true, errorCode, httpStatus? }`) to abort. Stop signals are normalized into a localized error envelope using the signal's `errorCode` (or `403` if no `httpStatus`).
-11. **`executeApiHandler(...)`.** Wraps `apiEntry.main({ data, user, functions, stream })` in `tryCatch` (which captures any thrown error to the active `@luckystack/error-tracking` adapter). Records `durationMs`. Span open/close and user-identity propagation are handled by hook subscribers registered in `@luckystack/error-tracking` (via `preApiExecute` / `postApiExecute`) — NOT by a direct `startSpan` or `setSentryUser` call inside this handler.
-12. **`postApiExecute` hook.** Observation point. Receives `result`, `error`, and `durationMs`. Use for audit logging, metrics, or post-run side effects. Cannot mutate the response.
-13. **`buildApiResponseEnvelope` → `preApiRespond` → `transformApiResponse` → emit → `postApiRespond`.** The envelope normalizer maps the raw handler result to a wire envelope, inferring `httpStatus` via `defaultHttpStatusForResponse`. `preApiRespond` lets handlers mutate `payload.response` in place or return a stop signal that converts to a localized error envelope. `transformApiResponse` is the dedicated mutation hook (PII redaction, response signing, schema injection) that fires after `preApiRespond` but before emit. Emit happens via `socket.emit(buildApiResponseEventName(responseIndex), ...)` (socket) or as the HTTP response body (HTTP). `postApiRespond` is observation-only and fires after emit.
-
-## API Reference
-
-### `handleApiRequest({ msg, socket, token })`
-
-Socket.io transport adapter. Default export.
-
-**Signature**
-
-```ts
-import handleApiRequest from '@luckystack/api';
-import type { apiMessage } from '@luckystack/core';
-import type { Socket } from 'socket.io';
-
-export default async function handleApiRequest(args: {
-  msg: apiMessage;
-  socket: Socket;
-  token: string | null;
-}): Promise<void>;
-```
-
-**Parameters**
-
-| Field | Type | Notes |
-| --- | --- | --- |
-| `msg` | `apiMessage` | The raw transport envelope. Required fields: `name` (string, `api/<page>/<name>/v<N>`), `data` (object), `responseIndex` (number, used to build the response event name). |
-| `socket` | `Socket` | Live socket.io socket. Used for `socket.emit`, `socket.handshake.headers`, and `socket.handshake.address` (for the global IP rate-limit bucket). |
-| `token` | `string \| null` | Session token from the socket handshake (`extractTokenFromSocket`). Drives `getSession`, the per-route rate-limit bucket key, and the `system/logout` shortcut. |
-
-**Returns**
-
-`Promise<void>`. The response is delivered by `socket.emit(buildApiResponseEventName(responseIndex), envelope)`. The function resolves once `postApiRespond` has completed.
-
-**Behavior highlights**
-
-- Treats `responseIndex` as the response correlation token; clients listen on `buildApiResponseEventName(responseIndex)`.
-- Reads `x-language` / `accept-language` from `socket.handshake.headers` for locale extraction.
-- Honors a per-route `validation: 'relaxed'` / `{ input: 'skip' }` flag (HTTP transport does not — webhook-style endpoints typically live on HTTP and pre-date this flag).
-- Built-in route: `system/logout` exits with a success envelope after calling `logout(...)` from `@luckystack/login`.
-- Stream emission: routes that call `stream(payload)` from their `main(...)` cause `socket.emit(buildApiStreamEventName(responseIndex), payload)`. Stream payloads are typed as `Record<string, unknown>` at the transport layer; consumers narrow against the generated `ApiStream<P, N, V>` type.
-
-**Errors / framework-emitted error codes**
-
-| `errorCode` | When | HTTP status |
-| --- | --- | --- |
-| `api.invalidRequest` | `name` or `data` missing / wrong type. | 400 |
-| `routing.invalidServiceRouteName` | `name` is not `api/<page>/<name>/v<N>`. | 400 |
-| `api.notFound` | Route not registered in runtime maps. | 404 |
-| `auth.required` | `auth.login` is `true` and `user?.id` is missing. | 401 |
-| `auth.forbidden` | `auth.additional[]` predicate rejects. | 403 |
-| `auth.invalidCondition` | `auth.additional[]` references a session key that is not on the session shape. Setup error. | 500 |
-| `api.rateLimitExceeded` | Per-route or per-IP bucket rejects. `errorParams[0].value` is `resetIn` (seconds). | 429 |
-| `api.invalidInputType` | `validateInputByType` rejects the payload. Generic code only — the validator's message is routed to the `postApiValidate` hook + dev logs, never echoed to the client (schema-enumeration guard). | 400 |
-| `api.internalServerError` | `main(...)` threw. | 500 |
-| `api.emptyResponse` | `main(...)` returned `null` or `undefined`. | 500 |
-| `api.invalidResponseStatus` | Handler returned an object whose `status` is neither `'success'` nor `'error'`. | 500 |
-
-**Example**
-
-```ts
-import handleApiRequest from '@luckystack/api';
-import { extractTokenFromSocket } from '@luckystack/core';
-
-io.on('connection', (socket) => {
-  socket.on('apiRequest', (msg) => {
-    void handleApiRequest({
-      msg,
-      socket,
-      token: extractTokenFromSocket(socket),
-    });
-  });
-});
-```
-
-### `handleHttpApiRequest({ name, data, token, ... })`
-
-HTTP transport adapter. Same pipeline as the socket variant plus HTTP-method validation.
-
-**Signature**
-
-```ts
-import { handleHttpApiRequest } from '@luckystack/api';
-import type { HttpMethod } from '@luckystack/core';
-
-export type ApiHttpStreamEvent = Record<string, unknown>;
-
-export async function handleHttpApiRequest(params: {
-  name: string;
-  data: Record<string, unknown>;
-  token: string | null;
-  requesterIp?: string;
-  xLanguageHeader?: string | string[];
-  acceptLanguageHeader?: string | string[];
-  method?: HttpMethod;
-  stream?: (payload: ApiHttpStreamEvent) => void;
-}): Promise<ApiNetworkResponse>;
-```
-
-**Parameters**
-
-| Field | Type | Notes |
-| --- | --- | --- |
-| `name` | `string` | Route name. May be passed with or without the `api/` prefix; the handler normalizes both. |
-| `data` | `Record<string, unknown>` | Request payload. Must be an object (arrays, primitives rejected). |
-| `token` | `string \| null` | Session token from cookie or `Authorization: Bearer`. |
-| `requesterIp` | `string` (optional) | IP used by the global per-IP rate-limit bucket. Falls back to `'unknown'` when omitted; production callers should always pass it. |
-| `xLanguageHeader` | `string \| string[]` (optional) | Forwarded to `extractLanguageFromHeader`. Takes precedence over `acceptLanguageHeader`. |
-| `acceptLanguageHeader` | `string \| string[]` (optional) | Standard `Accept-Language` header. |
-| `method` | `'GET' \| 'POST' \| 'PUT' \| 'DELETE'` (default `'POST'`) | HTTP method on the wire. Compared against the route's declared `httpMethod` or the inferred method from `inferHttpMethod`. |
-| `stream` | `(payload) => void` (optional) | Callback invoked once per `stream(payload)` call from the route's `main`. The server's HTTP listener wraps this into SSE events (`event: stream`). Streaming endpoints emit a final `event: final` carrying the full envelope. |
-
-**Returns**
-
-`Promise<ApiNetworkResponse>` — exactly one of:
-
-```ts
-type ApiNetworkResponse =
-  | ({ status: 'success'; httpStatus: number } & Record<string, unknown>)
-  | {
-      status: 'error';
-      httpStatus: number;
-      message: string;
-      errorCode: string;
-      errorParams?: { key: string; value: string | number | boolean }[];
-    };
-```
-
-The `httpStatus` is guaranteed to be a number (the socket variant returns the envelope with `httpStatus` as a hint; the HTTP variant materializes it for the response writer to use).
-
-**Behavior highlights**
-
-- Same auth → rate-limit → validate → execute → respond order as the socket variant, with method check inserted between rate-limit and validate.
-- Method inference (`inferHttpMethod`): names starting with `get*` / `fetch*` / `list*` → `GET`, `delete*` / `remove*` → `DELETE`, `update*` / `edit*` / `patch*` → `PUT`, everything else → `POST`. Per-route `httpMethod` export overrides the inference.
-- Does NOT honor the per-route `validation: 'relaxed'` flag. Public webhooks that need looser validation must use the socket variant or model their inputs structurally.
-- Streaming over SSE: the `stream` callback is invoked synchronously each time the route's `main` calls `stream(payload)`. The server-side SSE writer (in `@luckystack/server`) emits each callback as `event: stream\ndata: <json>` and the final envelope as `event: final\ndata: <json>`.
-- The function dispatches `preApiRespond` and `postApiRespond` in `handleHttpApiRequest` itself (wrapping the inner runner), so the same response-mutation contract applies to both transports.
-
-**Errors / framework-emitted error codes**
-
-Same set as the socket variant, plus:
-
-| `errorCode` | When | HTTP status |
-| --- | --- | --- |
-| `api.invalidName` | `name` missing or not a string. | 400 |
-| `api.invalidDataObject` | `data` missing, null, or not an object. | 400 |
-| `api.methodNotAllowed` | Request method does not match the route's declared or inferred HTTP method. `errorParams[0].value` is the expected method. | 405 |
-
-**Example**
-
-```ts
-import { handleHttpApiRequest } from '@luckystack/api';
-
-httpServer.on('request', async (req, res) => {
-  if (!req.url?.startsWith('/api/')) return;
-
-  const token = extractTokenFromRequest(req);
-  const body = await readJson(req);
-  const name = req.url.slice('/api/'.length).replace(/\?.*$/, '');
-
-  const result = await handleHttpApiRequest({
-    name,
-    data: body,
-    token,
-    requesterIp: req.socket.remoteAddress ?? undefined,
-    xLanguageHeader: req.headers['x-language'],
-    acceptLanguageHeader: req.headers['accept-language'],
-    method: req.method as HttpMethod,
-  });
-
-  res.statusCode = result.httpStatus;
-  res.setHeader('content-type', 'application/json');
-  res.end(JSON.stringify(result));
-});
-```
-
-### Type: `ApiHttpStreamEvent`
-
-```ts
-export type ApiHttpStreamEvent = Record<string, unknown>;
-```
-
-Wire-level shape of payloads emitted from `stream(...)` over the HTTP transport. Routes narrow this against the generated `ApiStream<P, N, V>` type at the call site. Bridge code (SSE writers, custom queue adapters) should treat it as opaque key/value.
-
-## Internal pipeline helpers
-
-Not exported. Listed for traceability against the source.
-
-| Helper | File | Role |
-| --- | --- | --- |
-| `validateApiMessage` | `handleApiRequest.ts` | Rejects malformed socket envelopes. |
-| `checkApiAuth` | `handleApiRequest.ts` | Wraps `auth.login` gate + `validateRequest`. |
-| `applyApiRateLimits` | `handleApiRequest.ts` | Per-route + global per-IP bucket. Fires `rateLimitExceeded` on reject. |
-| `executeApiHandler` | `handleApiRequest.ts` | `tryCatch` + `startSpan` wrap around `apiEntry.main(...)`. |
-| `buildApiResponseEnvelope` | `handleApiRequest.ts` | Normalizes success / error result to wire envelope with inferred `httpStatus`. |
-| `emitApiResult` | `handleApiRequest.ts` | Runs `preApiRespond` / `transformApiResponse` / `postApiRespond` hooks and emits on the socket. |
-| `warnIfInputTypeMissing` | both | Dev-only one-shot warning when a route lacks a generated `inputType`. |
-| `runHandleHttpApiRequestInner` | `handleHttpApiRequest.ts` | The core inner pipeline for the HTTP transport. |
-| `isRuntimeApiResult` | `handleHttpApiRequest.ts` | Type guard rejecting handler returns whose `status` is not `'success'` / `'error'`. |
-
-## Hooks dispatched
-
-In pipeline order:
-
-| Hook | Stoppable | Payload (key fields) |
-| --- | --- | --- |
-| `preApiValidate` | yes | `routeName`, `data`, `user` |
-| `postApiValidate` | no | `routeName`, `data`, `user`, `validation: { status, message? }` |
-| `preApiExecute` | yes | `routeName`, `data`, `user` |
-| `postApiExecute` | no | `routeName`, `data`, `user`, `result`, `error`, `durationMs` |
-| `preApiRespond` | no (mutates `response`) | `routeName`, `user`, `response: ApiResponseEnvelope` |
-| `transformApiResponse` | no (mutates `response`) | `routeName`, `user`, `response` |
-| `postApiRespond` | no | `routeName`, `user`, `response` |
-| `rateLimitExceeded` | no | `scope: 'route' \| 'user' \| 'ip'`, `key`, `limit`, `windowMs`, `count`, `route?`, `userId?`, `ip?` |
-
-Handlers register via `registerHook(name, handler)` from `@luckystack/core`. Stop signals are `{ stop: true, errorCode, httpStatus? }`. For deeper hook contract details see `@luckystack/core/docs/hooks.md`.
-
-## Config keys
-
-Read at request time via `getProjectConfig()`. Never captured at module load.
-
-| Key | Type | Effect |
-| --- | --- | --- |
-| `logging.devLogs` | `boolean` | Gates verbose per-request `getLogger().debug/warn/error` output. |
-| `logging.stream` | `boolean` | Gates `emitStream` payload logging. |
-| `dev.warnOnMissingInputType` | `boolean` | Toggles the one-shot `warnIfInputTypeMissing` developer hint. |
-| `rateLimiting.defaultApiLimit` | `number \| false` | Per-route fallback when the route does not export `rateLimit`. `false` disables the per-route bucket. |
-| `rateLimiting.defaultIpLimit` | `number \| false` | Global per-IP bucket across all API routes. `false` disables. |
-| `rateLimiting.windowMs` | `number` | Window size for both buckets. |
-
-No environment variables are read directly by this package. Secrets and toggles travel through `@luckystack/core`'s config registry.
-
-## Edge cases
-
-- **Missing `responseIndex` (socket).** Returns silently after a dev-log warning. The client will never get a response — by design, since we have no channel to send it on.
-- **Malformed `msg` (socket).** Returns silently if `msg` is not an object. Logs to dev-log.
-- **Unknown route after `parseTransportRouteName` succeeds.** Returns `api.notFound` with the original (pre-normalization) name in `errorParams[0].value` so audit handlers can correlate.
-- **Empty handler return.** Treated as an error: `api.emptyResponse` + `500`. Handlers must return an `{ status: 'success' }` or `{ status: 'error' }` object.
-- **Invalid `status` from handler.** Treated as an error: `api.invalidResponseStatus` + `500`.
-- **`preApiRespond` stop signal.** The original envelope is discarded; a fresh error envelope is built from the signal's `errorCode` + `httpStatus`. The replacement envelope still flows through `transformApiResponse` and `postApiRespond`.
-- **Streaming + error.** If `main(...)` throws after one or more `stream(...)` calls, the stream events were already on the wire — the final envelope is the error response. SSE clients must handle the mixed sequence.
-
-## Related
-
-- README: [`../README.md`](../README.md)
-- Routing conventions: [`./routing-conventions.md`](./routing-conventions.md)
-- Auth flow: [`./auth-flow.md`](./auth-flow.md)
-- Rate limiting: [`./rate-limiting.md`](./rate-limiting.md)
-- Error handling: [`./error-handling.md`](./error-handling.md)
-- Generated types: [`./generated-types.md`](./generated-types.md)
-- Architecture deep-dive: [`/docs/ARCHITECTURE_API.md`](../../../docs/ARCHITECTURE_API.md)
-- Hook contract: `@luckystack/core/docs/hooks.md`
+Hooks may observe or change the response only at their designated seam. Do not leak thrown exceptions or raw schema diagnostics into protected responses. A streaming response may have already emitted chunks when a later operation fails; consumers must handle a final error as distinct from prior progress. See `../src/_shared/requestLifecycle.ts`, `../src/_shared/responseEnvelope.ts`, `./error-handling.md`.

package/docs/auth-flow.md

@@ -1,230 +1,5 @@
-# Auth Flow
+# API authentication
 
-## Overview
+API reads the session from core/login, then applies each route's authorization policy. Auth is not a property of transport: sockets and HTTP must both enforce it, and HTTP method declarations do not restrict socket calls. Route lookup must happen to discover auth policy; do not promise to conceal route names, which are also published in client maps. What must remain private is predicate detail, schema diagnostics and protected data. See `../src/handleApiRequest.ts`, `../src/handleHttpApiRequest.ts`, `../../core/src/validateRequest.ts`.
 
-`@luckystack/api` does not own authentication — it consumes `getSession` from `@luckystack/login` and `validateRequest` from `@luckystack/core`. The handler's job is to translate the per-route `AuthProps` declaration into the right gate (require login + optional predicate checks) and to attribute every framework error tracker call that follows to the right user.
-
-Auth runs **early** in the pipeline (step 2 + step 6 of the 13-step lifecycle), and it runs **before** rate limit, method check, and input validation. The ordering is deliberate: unauthenticated callers should not be able to enumerate routes via 404 vs 405 vs 400 timing, or learn input shapes via `inputValidation.message`. A failing auth gate always returns a generic `auth.required` (or `auth.forbidden`) before any of those signals leak.
-
-The auth gate has two stages: a login check (cheap, boolean — does the session have a user ID?), then a predicate check (`validateRequest` evaluates `auth.additional[]`). Each can fail with a distinct error code + HTTP status. The HTTP transport also runs a defensive `if (!user)` check after the login gate to catch the edge case where `auth.login === false` was declared but downstream code still expects a user.
-
-## Lifecycle stages owning auth
-
-| Step | What happens |
-| --- | --- |
-| 2 (early) | `readSession(token)` → resolve `user`. Read once per request; downstream code reads `user` as a closure variable. Error-tracker identity set via `setCurrentErrorTrackerIdentity` (ALS scope), not a direct `setSentryUser` call. |
-| 6 | `checkApiAuth({ apiEntry, user, name, emitApiError })` (or the inline HTTP block) runs the login + predicate gate. Rejection short-circuits the pipeline. |
-| 4 (socket only) | `system/logout` shortcut. When the route normalizes to `system/logout`, the handler applies the global per-IP rate-limit, calls `performLogout(...)` directly, and emits a success envelope via `emitApiResult` — bypassing the runtime-map lookup, the auth gate, input validation, and the `preApiExecute`/`postApiExecute` hooks. The respond-phase hooks (`preApiRespond`, `transformApiResponse`, `postApiRespond`) still fire. |
-
-## API Reference
-
-### `readSession(token)` (from `@luckystack/core`)
-
-Read at request time via `@luckystack/core`'s session-provider registry. Returns `Promise<SessionLayout | null>`. Reads from the active session adapter (Redis by default); applies sliding-expiration (dispatches `preSessionRefresh` / `postSessionRefresh` hooks).
-
-A `null` return means: no session token, an expired session, a deleted session, or a session-adapter outage. The handler treats all four identically — `user` is `null` for the rest of the request, and `auth.login: true` rejects with `auth.required`.
-
-### Error-tracker identity propagation
-
-Called immediately after `readSession`. The handler calls `setCurrentErrorTrackerIdentity({ id, email, username })` (or `null` for unauthenticated requests) on the per-request ALS scope opened by `runWithErrorTrackerIdentityScope`. This replaces the former direct `setSentryUser` call — identity now flows through the ALS box, which hook subscribers in `@luckystack/error-tracking` read at capture time. The effect is identical: every `captureException` / `captureMessage` during this request is attributed to the correct user, even under concurrent requests.
-
-### `checkApiAuth(...)` (internal helper, socket transport)
-
-**Signature**:
-
-```ts
-const checkApiAuth = (params: {
-  apiEntry: RuntimeApiEntry;
-  user: SessionLayout | null;
-  name: string;            // The pre-normalization route name; used for log context.
-  emitApiError: EmitApiError;
-}): boolean;
-```
-
-**Behavior**:
-
-1. If `apiEntry.auth.login === true` and `user?.id` is missing, emit `auth.required` + `401`. Return `false`.
-2. Otherwise, run `validateRequest({ auth: apiEntry.auth, user: user! })`.
-3. If the result is `{ status: 'error', errorCode, errorParams, httpStatus }`, emit it (defaulting to `auth.forbidden` + `403` when fields are missing). Return `false`.
-4. Otherwise, return `true`.
-
-The function logs auth failures at `warn` level when `logging.devLogs` is on.
-
-### Inline auth block in `handleHttpApiRequest`
-
-The HTTP transport inlines the same logic but adds a defensive `if (!user)` check between the login gate and the predicate gate:
-
-```ts
-if (auth.login && !user?.id) {
-  return buildNetworkError({ response: { status: 'error', errorCode: 'auth.required' }, fallbackHttpStatus: 401 });
-}
-
-if (!user) {
-  return buildNetworkError({ response: { status: 'error', errorCode: 'auth.forbidden' }, fallbackHttpStatus: 403 });
-}
-```
-
-This catches the configuration drift where a route declared `auth.login: false` but the predicate evaluator (`validateRequest`) still expects a non-null user (its parameter type is `BaseSessionLayout`, not `BaseSessionLayout | null`). In practice this only matters if you opt out of login but still declare `auth.additional[]` checks — in that case, `validateRequest` would dereference `null`. The guard short-circuits with `auth.forbidden` first.
-
-### `validateRequest({ auth, user })` (from `@luckystack/core`)
-
-The predicate evaluator.
-
-**Signature**:
-
-```ts
-function validateRequest(params: {
-  auth: AuthProps;
-  user: BaseSessionLayout;
-}): {
-  status: 'success' | 'error';
-  errorCode?: string;
-  errorParams?: { key: string; value: string | number | boolean }[];
-  httpStatus?: number;
-};
-```
-
-**Behavior**: walks `auth.additional[]` (if present). Each entry references a `key` on the session object and adds up to four AND'd constraints:
-
-| Constraint | Semantics |
-| --- | --- |
-| `nullish: true` | `user[key]` must be `null` or `undefined`. |
-| `nullish: false` | `user[key]` must NOT be `null` or `undefined`. |
-| `type: 'string' \| 'number' \| 'boolean'` | `typeof user[key]` must match. Skipped if `user[key]` is null/undefined. |
-| `value: <x>` | Strict equality `user[key] === x`. Use `'value' in condition` semantics: omit the key entirely if you don't want the check (setting `value: undefined` explicitly means "must be undefined"). |
-| `mustBeFalsy: true` | `isFalsy(user[key])`. |
-| `mustBeFalsy: false` | `!isFalsy(user[key])`. |
-
-Multiple constraints on a single entry are AND'd. Multiple entries in the array are also AND'd — every entry must pass.
-
-**Errors**:
-
-| Condition | Returns |
-| --- | --- |
-| `condition.key` does not exist on the session object | `{ errorCode: 'auth.invalidCondition', errorParams: [{ key: 'key', value: <missingKey> }], httpStatus: 500 }`. This is a setup error, not a runtime auth fail — a route asked for a session field the project's `SessionLayout` does not declare. |
-| Any constraint fails | `{ errorCode: 'auth.forbidden', errorParams: [{ key: 'key', value: <failingKey> }], httpStatus: 403 }`. |
-| All constraints pass | `{ status: 'success' }`. |
-
-### `logout({ token, socket, userId })` (from `@luckystack/login`)
-
-Only reachable via the `system/logout` socket shortcut. Calls `deleteSession(token)` (which dispatches `preSessionDelete` → adapter delete + active-user untrack → `postSessionDelete`), emits `socketEventNames.logout` to the socket, and leaves the socket room.
-
-The shortcut bypasses: runtime-map lookup, the per-route auth gate, per-route rate limits, input validation, and the execution hooks (`preApiExecute`, `postApiExecute`). The global per-IP rate-limit bucket IS applied. The respond-phase hooks (`preApiRespond`, `transformApiResponse`, `postApiRespond`) ARE dispatched via `emitApiResult`. Logout is a built-in, not a user-defined route.
-
-## `AuthProps` shape
-
-```ts
-interface AuthProps {
-  /** If true, user must have a valid session with an ID. */
-  login: boolean;
-
-  /** Additional validation rules for session properties. */
-  additional?: {
-    key: keyof BaseSessionLayout;   // The session field to inspect (e.g. 'admin').
-    value?: unknown;                // Strict equality.
-    type?: 'string' | 'number' | 'boolean';
-    nullish?: boolean;
-    mustBeFalsy?: boolean;
-  }[];
-}
-```
-
-Project code typically declares `AuthProps` like:
-
-```ts
-// src/admin/_api/banUser_v1.ts
-export const auth: AuthProps = {
-  login: true,
-  additional: [
-    { key: 'admin', value: true },
-  ],
-};
-```
-
-`additional[].key` is constrained by `keyof BaseSessionLayout` — the project's `SessionLayout` extends `BaseSessionLayout`, so any field the project adds (e.g. `admin: boolean`, `organizationId: string`) is type-checkable. Referencing a key the session does not declare is a TypeScript error at compile time and a `500` `auth.invalidCondition` at runtime.
-
-## Error codes
-
-| Code | When | HTTP status |
-| --- | --- | --- |
-| `auth.required` | `auth.login === true` and `user?.id` is missing. | 401 |
-| `auth.forbidden` | `auth.additional[]` predicate rejects, or the HTTP-transport defensive `if (!user)` fires. | 403 |
-| `auth.invalidCondition` | `auth.additional[].key` is not present on the session shape. Setup error. | 500 |
-| Custom `errorCode` from `validateRequest` | Custom predicate (none ship by default) overrides the fallback. | Custom `httpStatus`, default 403. |
-
-All four codes go through `normalizeErrorResponse` so the localized normalizer can render a translated message (see [`./error-handling.md`](./error-handling.md)).
-
-## Ordering: why auth runs before rate limit
-
-Auth is step 6 of 13. Rate limit is step 7. The comment in `handleApiRequest.ts` puts it bluntly:
-
-```ts
-//? Auth → rate-limit → validate → execute → respond.
-//? Auth runs before validate so unauthenticated probes can't enumerate
-//? routes or learn input shape from `inputValidation.message`.
-```
-
-In practice this means:
-
-- An anonymous caller hitting a `login: true` route gets `auth.required` for every request, regardless of the route's input shape, regardless of whether the route exists.
-- An anonymous caller hitting a route that does **not** exist gets the SAME `auth.required` (because the route lookup is step 5, before auth at step 6, but the runtime map check returns `api.notFound` early — see edge case below).
-
-Wait — re-reading the pipeline: step 5 (`getRuntimeApiMaps + route lookup`) DOES run before auth. That is intentional: route lookup is needed to read `apiEntry.auth`. An unknown route returns `api.notFound` to the anonymous caller. That is a known leak (route names are enumerable by an anonymous caller); deliberate, since route names are not secret (the client bundle ships them anyway). The defense is at the input-shape and `auth.forbidden` boundary, where predicate details and validation messages would otherwise leak.
-
-## Authorization extension points
-
-The auth gate's predicate engine is intentionally small. Two ways to add custom behavior:
-
-1. **Session-field predicates via `auth.additional[]`.** Add fields to your project's `SessionLayout` (via `BaseSessionLayout` module augmentation) and reference them by key. Examples: `admin`, `organizationId`, `plan`, `verified`. The session is populated by `@luckystack/login`'s adapter system — see `@luckystack/login` docs.
-
-2. **Hook-based auth via `preApiExecute`.** Register a hook that inspects `user` + `routeName` + `data` and returns a stop signal:
-
-   ```ts
-   registerHook('preApiExecute', async ({ routeName, user, data }) => {
-     if (routeName.startsWith('admin/') && !user?.admin) {
-       return { stop: true, errorCode: 'auth.forbidden', httpStatus: 403 };
-     }
-   });
-   ```
-
-   `preApiExecute` runs after the per-route `AuthProps` gate, so use it for cross-cutting rules (admin gate across many routes, organization scoping, feature flags) rather than per-route checks.
-
-For more complex authorization (RBAC, per-resource ACLs), keep the framework gate at the coarse-grained level (`login: true`, `admin: true`) and run fine-grained checks inside `main(...)`.
-
-## Hooks dispatched
-
-The auth gate itself does not dispatch hooks. Adjacent hooks that observe auth state:
-
-| Hook | When | Payload |
-| --- | --- | --- |
-| `preSessionRefresh` / `postSessionRefresh` | Inside `getSession`, on every authenticated request | `{ token, oldTtl, newTtl }`. `preSessionRefresh` can stop the TTL extend. |
-| `preApiExecute` | After the `AuthProps` gate, before `main(...)` | `{ routeName, data, user }`. Can stop with `{ errorCode, httpStatus }` for custom authorization. |
-
-See [`./api-request-lifecycle.md`](./api-request-lifecycle.md) for the full hook order.
-
-## Config keys
-
-This package does not read any auth-specific config. `@luckystack/login` owns session policy:
-
-- `session.expiryDays` (TTL for `getSession` sliding-extend).
-- `session.perUser`, `session.maxConcurrentPerUser`, `session.onConflict` (single-session enforcement on new login).
-- `auth.passwordPolicy.*` (credentials register / change paths).
-- `auth.forgotPassword` (framework vs custom vs disabled).
-
-Read those in `@luckystack/login/CLAUDE.md`.
-
-## Edge cases
-
-- **`user.id` is `0` or `''`.** The check is `!user?.id` — both falsy values reject with `auth.required`. Session adapters should never write a falsy ID; if you customize the user adapter, ensure IDs are truthy.
-- **`auth.login: false` + `auth.additional[]` declared.** The login gate passes (no ID required), but the predicate engine receives a possibly-null user. The socket transport asserts `user!` and relies on `validateRequest`'s nullish guards (constraints are skipped when `user[key]` is null/undefined). The HTTP transport adds the defensive `if (!user)` short-circuit. Don't rely on this combination — declare `login: true` if you need session field checks.
-- **Session deleted between `getSession` and `validateRequest`.** Not possible — `user` is captured once at step 2 and used as a closure. Subsequent revocations affect later requests, not this one.
-- **`system/logout` race with concurrent requests on the same socket.** `logout` runs synchronously inside the API handler; concurrent requests on the same socket may have already resolved `getSession` before the logout completes. Those requests see a still-valid session. The next request to enter step 2 sees the deleted session.
-- **OAuth callback or login HTTP routes.** Those live in `@luckystack/server`'s HTTP route table (`/auth/callback/<provider>`, `/auth/api/credentials`), not in `/api/*`. The auth gate documented here is for `/api/*` traffic only. Login endpoints have their own session-minting flow inside `@luckystack/login`.
-
-## Related
-
-- API request lifecycle: [`./api-request-lifecycle.md`](./api-request-lifecycle.md)
-- Error handling: [`./error-handling.md`](./error-handling.md)
-- Session management: `@luckystack/login/docs/session-management.md`
-- OAuth providers: `@luckystack/login/docs/oauth-providers.md`
-- Architecture: [`/docs/ARCHITECTURE_AUTH.md`](../../../docs/ARCHITECTURE_AUTH.md), [`/docs/ARCHITECTURE_SESSION.md`](../../../docs/ARCHITECTURE_SESSION.md)
+Resolve user identity from the session, not the request payload. Keep error-tracker identity request-scoped so concurrent requests do not contaminate one another (`../../core/src/errorTrackerIdentity.ts`). The built-in logout shortcut is not an ordinary API route; do not assume route hooks alone observe or authorize it. See `../src/handleApiRequest.ts` and `../../login/src/logout.ts`.