@palbase/backend 3.0.0 → 5.0.0

package/docs/README.md

@@ -4,10 +4,202 @@ Write your backend as TypeScript files. Palbase discovers them by path, runs
 them inside the managed backend runtime, and exposes them as a typed HTTP API.
 
 This is **not** Express, Fastify, or a Supabase Edge Function. There is no
-`app.get(...)`, no manual route registration, no `import express`. You export
-definitions; the runtime wires them up.
+`app.get(...)`, no manual route registration, no `import express`. You author
+**class controllers** with method + parameter decorators (NestJS-style); the
+runtime wires them up.
 
-## Mental model (important)
+## AGENTS / AI codegen guide (read this first)
+
+If you are an AI generating a Palbase backend, this is the contract. Get these
+seven rules right and the deploy succeeds; get them wrong and it fails the
+deploy gate or the TypeScript compile.
+
+### Folder layout
+
+```
+controllers/<name>.controller.ts   # @Controller class + @Get/@Post/… route methods (the API surface)
+models/<controller>/<endpoint>.ts   # zod schemas — one folder per controller, one file per endpoint (+ shared.ts)
+services/<name>.service.ts          # plain class + singleton — the real logic (controllers stay thin)
+db/schema.ts                        # config-as-code Postgres schema (tables, columns, RLS) — auto-migrated on deploy
+```
+
+The four folders above are the daily surface. These also exist (own docs, linked
+below): `resources/` (external connections — [resources.md](./resources.md)),
+`seeds/` (seed data), `jobs/` + `workers/` (background — [background.md](./background.md)),
+`webhooks/` + `hooks/` (events — [events.md](./events.md)), `middleware/`.
+
+### The 7 rules (checklist)
+
+1. **`export default <ControllerClass>` is REQUIRED.** Every `controllers/*.controller.ts`
+   must default-export its `@Controller` class, or the deploy FAILS with a
+   "not a @Controller / non-controller export" error. Either `export default class X {}`
+   or a trailing `export default X;` — both work.
+2. **Methods that call a service are `async` and return `Promise<T>`.** Services
+   `await Database`, so they return promises; a sync return type on an async body
+   is a tsc error. Annotate `: Promise<TodoSchema>`, not `: TodoSchema`, whenever
+   the body awaits.
+3. **`@User()` (value) vs `UserT` (type) are two different imports.**
+   `import { User } from "@palbase/backend"` (the decorator) +
+   `import type { UserT } from "@palbase/backend"` (the user type). Write
+   `@User() user: UserT`. They are NOT the same symbol.
+4. **The method's RETURN TYPE names the response schema.** Write
+   `: Promise<TodoSchema>` (or `: Promise<z.infer<typeof TodoSchema>>`) — codegen
+   + the runtime read that named type to bind the 200 response zod schema. There
+   is no `@Returns` decorator. A body route with no named return type is a build
+   error; a method with no response body annotates `: Promise<void>` / `: void`.
+5. **Schemas live in `models/<controller>/<endpoint>.ts`,** exported as a zod
+   VALUE and a same-named `z.infer` TYPE. The controller imports them and writes
+   `@Body(CreateTodoBody) body: CreateTodoBody` (value in the decorator, same name
+   as the type annotation).
+6. **Errors are global throw classes.** `throw new Conflict("…")` / `NotFound` /
+   `BadRequest` / `Unauthorized` / `Forbidden` / `TooManyRequests` /
+   `PalError(status, code, msg)` — from a controller OR a service, with no `req`.
+   There is no per-route errors map and no `req.errors`.
+7. **Auth is secure-by-default.** Every route needs a signed-in user unless it
+   opts out: `@Controller("/x", { auth: false })` (whole controller) or
+   `@Get("", { auth: false })` (one route). Cascade: route > controller >
+   default(required). On a public route inject `@OptionalUser() user: UserT | null`.
+
+> **Never** emit `defineController`, `defineHandler`, `defineEndpoint`, `route.get(...)`,
+> `req.input`, `req.params`, or `req.errors` — those are the removed legacy model
+> and will not compile against `@palbase/backend` 4.
+
+### Complete CRUD example (copy-pasteable, compiles)
+
+```ts
+// models/todos/shared.ts — the response shape, reused across endpoints.
+import { z } from "@palbase/backend";
+export const TodoSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  completed: z.boolean(),
+});
+export type TodoSchema = z.infer<typeof TodoSchema>;
+```
+
+```ts
+// models/todos/create.ts — the POST body.
+import { z } from "@palbase/backend";
+export const CreateTodoBody = z.object({ title: z.string().min(1) });
+export type CreateTodoBody = z.infer<typeof CreateTodoBody>;
+```
+
+```ts
+// services/todo.service.ts — plain class + singleton. The real work.
+import { Database, NotFound } from "@palbase/backend";
+import type { TodoSchema } from "../models/todos/shared.js";
+
+export class TodoService {
+  list(userId: string): Promise<TodoSchema[]> {
+    return Database.tables.todos.findMany({ user_id: userId });
+  }
+  create(userId: string, title: string): Promise<TodoSchema> {
+    return Database.tables.todos.insert({ user_id: userId, title });
+  }
+  async get(userId: string, id: string): Promise<TodoSchema> {
+    const t = await Database.tables.todos.findById(id);
+    if (!t || t.user_id !== userId) throw new NotFound("No todo with that id");
+    return t;
+  }
+  async remove(userId: string, id: string): Promise<void> {
+    const t = await Database.tables.todos.findById(id);
+    if (!t || t.user_id !== userId) throw new NotFound("No todo with that id");
+    await Database.tables.todos.delete(id);
+  }
+}
+export const todoService = new TodoService();
+```
+
+```ts
+// controllers/todos.controller.ts — class controller. Thin: delegates to the service.
+import { Controller, Get, Post, Delete, Body, Param, User } from "@palbase/backend";
+import type { UserT } from "@palbase/backend";       // the user TYPE (@User is the value)
+import { todoService } from "../services/todo.service.js";
+import { TodoSchema } from "../models/todos/shared.js";
+import { CreateTodoBody } from "../models/todos/create.js";
+
+@Controller("/todos")                                  // secure-by-default; { auth: false } opts the whole controller out
+export class TodosController {
+  private todos = todoService;
+
+  @Get("")                                             // GET /todos → operationId getTodos
+  async list(@User() user: UserT): Promise<TodoSchema[]> {  // return type → 200 response schema
+    return this.todos.list(user.id);
+  }
+
+  @Post("")                                            // POST /todos → postTodos
+  async create(@Body(CreateTodoBody) body: CreateTodoBody, @User() user: UserT): Promise<TodoSchema> {
+    return this.todos.create(user.id, body.title);
+  }
+
+  @Get("/{id}")                                        // GET /todos/{id} → getTodosById
+  async get(@Param("id") id: string, @User() user: UserT): Promise<TodoSchema> {
+    return this.todos.get(user.id, id);
+  }
+
+  @Delete("/{id}")                                     // DELETE /todos/{id} → deleteTodosById; no body → : Promise<void>
+  async remove(@Param("id") id: string, @User() user: UserT): Promise<void> {
+    await this.todos.remove(user.id, id);
+  }
+}
+
+export default TodosController;                         // REQUIRED — the runtime loads the default export
+```
+
+```ts
+// db/schema.ts — config-as-code; the deploy auto-migrates additive changes.
+import { defineSchema, uuid, text, boolean, timestamp, policy } from "@palbase/backend";
+export default defineSchema({
+  tables: {
+    todos: {
+      columns: {
+        id:         uuid().primaryKey().defaultRandom(),
+        user_id:    text().notNull(),                  // palauth user id (TEXT, e.g. "usr_…")
+        title:      text().notNull(),
+        completed:  boolean().default(false),
+        created_at: timestamp().defaultNow(),
+      },
+      rls: true,                                       // every Database.* query runs as the request user
+      policies: [
+        policy("pb_owner_all")
+          .for("all")
+          .to("authenticated")
+          .using("user_id = (select auth.uid())")
+          .withCheck("user_id = (select auth.uid())"),
+      ],
+    },
+  },
+});
+```
+
+### operationId — what the generated clients call
+
+The operationId is derived FLAT from the verb + full path (NOT the method name):
+`GET /todos` → `getTodos`, `POST /todos` → `postTodos`, `GET /todos/{id}` →
+`getTodosById`. The generated iOS/TS clients expose these as `pb.getTodos()`,
+`pb.postTodos(...)`, `pb.getTodosById(id:)`. Rename the method freely; the
+operationId is unaffected. Change the verb and the operationId changes — no file
+rename needed.
+
+### CLI workflow
+
+- `palbase serve` — run `controllers/` locally with hot reload (proxies
+  `Database`/services to the deployed branch; runs `gen-types` on startup).
+- `palbase gen-types` — regenerate `palbase-env.d.ts` from `db/schema.ts` so
+  `Database.tables.*` is typed (no import, no generic). Standalone version of what
+  `serve` runs.
+- **Deploy is GitHub-native** — `git push` triggers the deploy (there is no
+  `palbase push`). Push a branch to deploy that branch.
+- `palbase secret set NAME=value` / `palbase secret list` — branch-scoped
+  secrets (encrypted at rest), read in code via `process.env.NAME`.
+- `palbase secret pull` / `palbase secret push` — sync the branch's env vars with
+  a local `.env.local` (gitignored). `pull` writes decrypted values for local dev
+  (merging local-only keys); `push` uploads changed keys (new keys default to
+  SECRET and need `--secret`/`--plain` classification, existing secrets are left
+  untouched unless `--force-secrets`).
+- `tsconfig.json` needs `"experimentalDecorators": true` (the scaffold sets it).
+
+## Mental model
 
 Every handler type imports service singletons the same way:
 
@@ -19,7 +211,7 @@ The **only difference** is the trigger argument:
 
 | You are writing… | Handler signature | Trigger arg |
 |------------------|-------------------|-------------|
-| **Endpoints** (`controllers/` + `handlers/`) | `(req)` | `req` — [PBRequest](./endpoints.md) |
+| **Endpoints** (`controllers/` class controllers) | method `(…params)` | parameter decorators `@Body`/`@Query`/`@Param`/`@User`/… — [endpoints.md](./endpoints.md) |
 | **Workers** (`workers/**`) | `(payload, meta)` | typed payload + `WorkerMeta` |
 | **Jobs** (`jobs/**`) | `(meta)` | `JobMeta` |
 | **Hooks** (`hooks/**`) | `(event, meta)` | typed event + `HookMeta` |
@@ -35,13 +227,16 @@ the imported singletons — not from `ctx` or any argument.
 ```
 my-backend/
 ├── package.json            # depends on @palbase/backend
-├── controllers/            # route maps: method+path → handler (mounts the API)
-│   └── hello.controller.ts # defineController("/hello", { … })
-├── handlers/               # one endpoint unit each (schema + thin logic)
-│   └── hello.ts            # defineHandler({ auth, input, output, handler })
-├── services/               # plain classes/singletons your handlers call
+├── tsconfig.json           # experimentalDecorators: true (required for the decorators)
+├── controllers/            # @Controller classes: @Get/@Post methods (mount the API)
+│   └── hello.controller.ts # @Controller("/hello") + @Get example
+├── models/<ctrl>/<ep>.ts   # zod schemas, folder per controller, file per endpoint
+│   └── hello/greet.ts      # GreetQuery + HelloResponse (zod value + z.infer type)
+├── services/               # plain classes/singletons your controllers call
 ├── db/schema.ts            # table definitions (optional, enables typed DB)
 ├── db/migrations/          # explicit SQL migrations for type changes (optional)
+├── resources/              # external connections, set up once at boot (optional)
+├── seeds/                  # seed data (optional)
 ├── workers/                # background job handlers (optional)
 ├── jobs/                   # cron-scheduled jobs (optional)
 ├── hooks/                  # auth/storage/document event hooks (optional)
@@ -49,24 +244,27 @@ my-backend/
 └── middleware/             # cross-cutting request middleware (optional)
 ```
 
-HTTP endpoints are **not** file-path routed. You author a `handler` (one
-endpoint: `auth`/`input`/`output`/`errors` + logic, no route) and mount it in a
-`controller` (a route map). See [routing.md](./routing.md).
+HTTP endpoints are **not** file-path routed. You author a class controller
+(`@Controller("/base")` with `@Get`/`@Post`/… methods); putting it under
+`controllers/` mounts it. See [routing.md](./routing.md).
 
 ## Documentation
 
 | Topic | File |
 |-------|------|
 | Getting started | [getting-started.md](./getting-started.md) |
-| File-based routing | [routing.md](./routing.md) |
-| Endpoints & `req` | [endpoints.md](./endpoints.md) |
+| Routing (class controllers) | [routing.md](./routing.md) |
+| Endpoints (decorators) | [endpoints.md](./endpoints.md) |
 | Database & transactions | [database.md](./database.md) |
 | Schema & typed DB | [schema.md](./schema.md) |
 | Migrations (additive vs type-change + drift-gate) | [migrations.md](./migrations.md) |
 | Services (Cache, Queue, Storage, …) | [services.md](./services.md) |
+| Resources (external connections) | [resources.md](./resources.md) |
 | Errors | [errors.md](./errors.md) |
 | Workers & Jobs | [background.md](./background.md) |
 | Hooks & Webhooks | [events.md](./events.md) |
 
 For AI coding tools: a single concatenated corpus is generated at
 [`llms-full.txt`](./llms-full.txt) (and an index at [`llms.txt`](./llms.txt)).
+</content>
+</invoke>

package/docs/database.md

@@ -71,3 +71,43 @@ await Database.transaction(async (tx) => {
 
 The `tx` carries the same typed `tx.tables.<name>` API as `Database.tables`
 (no nested transaction). See [schema.md](./schema.md) for the full surface.
+
+## Bypassing RLS — `Database.asService()`
+
+When a table has [Row-Level Security](./schema.md#row-level-security-rls)
+policies, every `Database.*` call runs as the request's verified user
+(`authenticated`), so the database filters out rows the user's policies don't
+allow. That is the secure default.
+
+Sometimes you need to read or write **across all users** — an admin endpoint, a
+background job that fans out notifications, a cleanup task. For that, call
+`Database.asService()`. It returns a sibling client that runs as the
+`service_role` (which has `BYPASSRLS`), exposing the exact same surface —
+`tables`, the raw string ops, and `transaction`:
+
+```ts
+import { Database } from "@palbase/backend";
+
+// RLS-enforced (default): only the caller's own rows.
+const mine = await Database.tables.todos.findMany({});
+
+// Service-role bypass: every user's rows. Explicit and greppable.
+const all  = await Database.asService().tables.todos.findMany({});
+const rows = await Database.asService().query("SELECT count(*) FROM todos");
+
+// A service-role transaction (the role is fixed for the whole tx):
+await Database.asService().transaction(async (tx) => {
+  await tx.tables.todos.update(id, { done: true });
+});
+```
+
+Guidelines:
+
+- **Be explicit.** Prefer the default `Database.*` and reach for `asService()`
+  only where you genuinely need cross-user access. It is intentionally easy to
+  grep for in review.
+- **No double-bypass / no nesting.** The sibling does not re-expose
+  `asService()`, and `tx` never exposes it — a transaction's role is fixed when
+  it begins. Use `Database.transaction(...)` for an authenticated tx and
+  `Database.asService().transaction(...)` for a service-role tx; you cannot mix
+  enforced and bypassed ops inside one interactive transaction.

package/docs/endpoints.md

@@ -1,105 +1,138 @@
 # Endpoints
 
-An endpoint is a **handler** — `export default defineHandler({...})` in a file
-under `handlers/`. A handler has NO method or path; a **controller** maps
-method+path to it (see [routing.md](./routing.md)). The handler receives **one
-argument**, `req` (a `PBRequest`). Services are NOT on `req` — import them as
-singletons (see [services.md](./services.md)).
+An endpoint is a **method on a class controller** — a class decorated with
+`@Controller(basePath)` whose methods are decorated with `@Get`/`@Post`/`@Put`/
+`@Patch`/`@Delete`. Controller files live under `controllers/` and are mounted
+automatically (see [routing.md](./routing.md)). Request input + context are
+injected into the method via **parameter decorators** (`@Body`/`@Query`/`@Param`/
+`@User`/…), each piece direct — no `req` god-object. Services are reached via the
+imported singletons (see [services.md](./services.md)).
 
-## `defineHandler` config
+## A controller
 
 ```ts
-defineHandler({
-  auth: { required: true },          // see Auth below. Omitted → AUTH REQUIRED (secure-by-default).
-  rateLimit: { max: 100, window: 60 }, // optional: max requests per window seconds
-  input: z.object({ ... }),          // optional Zod schema → validates & types req.input
-  output: z.object({ ... }),         // optional Zod schema → validates the return value
-  errors: { ... },                   // optional declared errors (see errors.md)
-  middleware: [ ... ],               // optional Middleware[] (see below)
-  handler: async (req) => { ... },   // required
-});
-```
-
-There is no `method` field — the HTTP verb (and path) live in the controller
-that mounts the handler via `route.get|post|put|patch|delete`.
+// controllers/rooms.controller.ts
+import { Controller, Get, Post, Body, Param, User, NotFound, Database } from "@palbase/backend";
+import type { UserT } from "@palbase/backend";
+import { CreateRoomBody } from "../models/rooms/create.js";
+import type { RoomSchema } from "../models/rooms/shared.js";  // the return TYPE names the 200 schema
+
+@Controller("/rooms")
+export default class RoomsController {
+  @Post("")
+  async create(@Body(CreateRoomBody) body: CreateRoomBody, @User() user: UserT): Promise<RoomSchema> {
+    const room = await Database.insert("rooms", { name: body.name, capacity: body.capacity ?? null });
+    return { id: room.id as string, name: room.name as string, capacity: (room.capacity as number) ?? null };
+  }
 
-## `req` (PBRequest)
+  @Get("/{id}")
+  async getOne(@Param("id") id: string): Promise<RoomSchema> {
+    const room = await Database.findById("rooms", id);
+    if (!room) throw new NotFound("Room does not exist", "room_not_found");
+    return { id: room.id as string, name: room.name as string, capacity: (room.capacity as number) ?? null };
+  }
+}
+```
 
-| Field | Type | Notes |
-|-------|------|-------|
-| `req.input` | inferred from `input` schema | request body for POST/PUT/PATCH; `{}` otherwise |
-| `req.params` | `Record<string,string>` | route params, e.g. `req.params.id` |
-| `req.query` | `Record<string,string>` | parsed query string |
-| `req.headers` | `Record<string,string>` | lowercase keys |
-| `req.user` | `User` when authenticated; `User \| null` when `auth` is omitted or `required: false` | see Auth below |
-| `req.client` | `ClientInfo` | calling SDK/app/platform/os version (all nullable) |
-| `req.file` | `FileContext \| null` | uploaded file, if any |
-| `req.method` | `string` | the HTTP method |
-| `req.requestId` / `req.traceId` / `req.spanId` | `string` | correlation ids |
-| `req.errors` | typed throwers | present when `errors` is declared (see errors.md) |
+**Two non-negotiables** (the most common codegen mistakes):
 
-`User` is `{ id: string; email?: string; role: string; metadata: Record<string, unknown> }`.
+1. **`export default <Controller>` is REQUIRED.** Above it is
+   `export default class RoomsController`; the trailing form `export class
+   RoomsController {…}` + `export default RoomsController;` is equivalent. Without
+   a default export the deploy aborts with a "not a @Controller / non-controller
+   export" error — the runtime loads the file's default export.
+2. **A method that awaits a service is `async` + `Promise<T>`.** `Database`
+   returns promises, so a body that `await`s it cannot have a sync return type
+   (`: RoomSchema` on an `async` body is a `tsc` error). Both methods above are
+   `async` and return `Promise<RoomSchema>`. (A pure method that returns a literal
+   with no `await` may stay synchronous.)
 
-## Auth
+## Method decorators
 
-**Secure by default:** a handler requires authentication UNLESS it explicitly
-opts out. Omitting `auth` means AUTH REQUIRED — a forgotten `auth` fails safe
-(401), never silently public. Mark a route PUBLIC with `auth: { required: false }`.
+`@Get`/`@Post`/`@Put`/`@Patch`/`@Delete` take `(subpath, options?)`:
 
 ```ts
-// auth omitted entirely                 // AUTH REQUIRED → req.user is non-null User
-auth: { required: true }                // same: require any authenticated user
-auth: { required: true, role: "admin" } // require a specific role
-auth: { required: false }               // PUBLIC → req.user may be null (anon key only)
+interface RouteOptions {
+  auth?: boolean | { required?: boolean; role?: string };  // overrides controller default
+  rateLimit?: { max: number; window: number };             // optional, per route
+}
 ```
 
-Whether `req.user` is non-null is computed from the `auth` config at the type
-level (and matches the runtime exactly):
+Input and output are NOT method-decorator options: input comes from the
+parameter decorators, output from the method's return type. The method decorator
+only carries route concerns (path, auth, rateLimit).
 
-| `auth` value | `req.user` type |
-|--------------|-----------------|
-| omitted | `User` (secure-by-default) |
-| `true` | `User` |
-| `false` | `User \| null` (public) |
-| `{ required: true }` | `User` |
-| `{ required: false }` | `User \| null` (public) |
-| `{ role: "admin" }` (object, no `required`) | `User` |
+## Parameter decorators
 
-To make a route PUBLIC, set `auth: { required: false }` (or `auth: false`). An
-object with a `role` but no `required` key is treated as authenticated. When
-`auth` is omitted, the endpoint is public and `req.user` may be null.
+| Decorator | Injects | Typed by | OpenAPI |
+|---|---|---|---|
+| `@Body(schema)` | request body | `: T` (`z.infer<schema>`, same name) | requestBody |
+| `@Query(schema)` | query params | `: T` | query parameters |
+| `@Param("id")` | one path param | `: string` | path parameter |
+| `@Headers(schema?)` | request headers | `Record<string,string>` (+ typed with schema) | header parameters |
+| `@User()` | authenticated user | `: UserT` | — (from token) |
+| `@OptionalUser()` | user, possibly anon | `: UserT \| null` | — |
+| `@Client()` | parsed client info | `: ClientInfo` | — |
+| `@RequestId()` / `@TraceId()` | correlation ids | `: string` | — |
+| `@Req()` | raw request (escape hatch) | `: PBRequest` | — |
 
-## Typed input/output
+`@Body`/`@Query`/`@Headers` take a zod schema (validation + codegen source); the
+developer writes the matching type annotation (same name). `UserT` is the
+authenticated-user type (`{ id: string; email?: string; role: string; metadata:
+Record<string, unknown> }`) — exported under the alias `UserT` because the value
+name `User` is the `@User()` decorator.
+
+## Output = return type
+
+The success response is the method's RETURN TYPE — there is no `@Returns`
+decorator. Annotate `: Promise<RoomSchema>` (or `: Promise<z.infer<typeof
+RoomSchema>>`); codegen + the runtime read that named type to bind the OpenAPI
+200 response zod schema. A body route with no named return type is a build
+error. A method that returns nothing annotates `: void` (or `: Promise<void>`).
+
+## Auth — controller default + route override cascade
+
+**Secure by default:** a route requires authentication UNLESS it explicitly opts
+out. Resolution order (most specific wins):
+
+1. Route-level `@Post("", { auth })` — wins if present.
+2. Controller-level `@Controller("/x", { auth })` — applies to routes without
+   their own `auth`.
+3. Default `true` (secure-by-default).
 
 ```ts
-import { defineHandler, z, Database } from "@palbase/backend";
-
-export default defineHandler({
-  auth: { required: true },
-  input: z.object({ name: z.string().min(1).max(100), capacity: z.number().int().positive().optional() }),
-  output: z.object({ id: z.string(), name: z.string(), capacity: z.number().nullable() }),
-  handler: async (req) => {
-    const room = await Database.insert("rooms", {
-      name: req.input.name,
-      capacity: req.input.capacity ?? null,
-    });
-    return { id: room.id as string, name: room.name as string, capacity: (room.capacity as number) ?? null };
-  },
-});
+@Controller("/public", { auth: false })          // all routes default public
+export default class PublicController {
+  @Get("/open") open(): Info { ... }              // inherits → public
+  @Get("/secret", { auth: true })                 // OVERRIDES → authed
+  secret(@User() u: UserT): Secret { ... }
+}
 ```
 
-A controller then mounts it with a method + path:
+| effective `auth` | `@User()` type to annotate |
+|------------------|----------------------------|
+| required (omitted / `true` / `{ required: true }` / role-only) | `@User() u: UserT` |
+| public (`false` / `{ required: false }`) | `@OptionalUser() u: UserT \| null` |
+
+The runtime always applies the resolved effective auth; the static type you
+annotate is best-effort (a parameter decorator cannot see the controller default
+at the type level).
+
+## Errors — global throw classes
+
+Throw an error class anywhere (controller OR service) — no `req`, no per-route
+map. The runtime catches it and emits the standard envelope:
 
 ```ts
-// controllers/rooms.controller.ts
-import { defineController, route } from "@palbase/backend";
-import create from "../handlers/rooms/create.js";
+import { Conflict, NotFound, BadRequest, Unauthorized, Forbidden, TooManyRequests, PalError } from "@palbase/backend";
 
-export default defineController("/rooms", {
-  create: route.post("/", create),
-});
+throw new Conflict("title taken");            // → 409
+throw new NotFound();                         // → 404 ("Not found")
+throw new PalError(418, "teapot", "custom");  // → custom status/code
 ```
 
+See [errors.md](./errors.md) for the full set + the wire envelope shape.
+
 ## Middleware
 
 A middleware wraps a request. Define one in `middleware/<name>.ts`:
@@ -116,19 +149,4 @@ export default defineMiddleware(async (ctx, next) => {
 ```
 
 The middleware handler receives `(ctx, next)` — call `await next()` to run the
-rest of the chain (other middleware, then the endpoint handler). Note this uses
-the `ctx` model, not `req`.
-
-To attach middleware to a specific handler, import it and list it in the
-handler's `middleware` array:
-
-```ts
-import { defineHandler, z } from "@palbase/backend";
-import logger from "../../middleware/logger.js";
-
-export default defineHandler({
-  middleware: [logger],
-  output: z.object({ ok: z.boolean() }),
-  handler: async (req) => ({ ok: true }),
-});
-```
+rest of the chain (other middleware, then the endpoint method).

package/docs/errors.md

@@ -1,47 +1,54 @@
 # Errors
 
-Two ways to fail a request. Both serialize to the standard Palbase error
-envelope:
+Throw an error class to fail a request. Every one serializes to the standard
+Palbase error envelope:
 
 ```json
 { "error": "todo_not_found", "error_description": "No such todo", "status": 404, "request_id": "req_…" }
 ```
 
-## 1. `HttpError` (ad-hoc)
+Throw anywhere — in a controller method OR in a `services/` class. No `req`, no
+per-route error map: the runtime catches any thrown error class and emits the
+envelope.
+
+## Named status classes
 
 ```ts
-import { HttpError } from "@palbase/backend";
-throw new HttpError(404, "todo_not_found", "No such todo");
-// optional structured payload (4th arg) rides along under `data`:
-throw new HttpError(423, "todo_locked", "Locked", { retryAfter: 30 });
+import { BadRequest, Unauthorized, Forbidden, NotFound, Conflict, TooManyRequests } from "@palbase/backend";
+
+throw new Conflict("title taken");      // → 409  ("conflict" code by default)
+throw new NotFound();                   // → 404  ("not_found", "Not found")
+throw new BadRequest("missing field");  // → 400
+throw new Unauthorized();               // → 401
+throw new Forbidden();                  // → 403
+throw new TooManyRequests();            // → 429
 ```
 
-`new HttpError(status, code, description, data?)`.
+Each class fixes its HTTP status. The constructor is
+`new <Class>(message?, code?, data?)`:
 
-## 2. Declared errors (typed)
+- `message` overrides the human-readable `error_description` (defaults to a label
+  derived from the class name).
+- `code` overrides the wire `error` code (defaults to the class's snake_case
+  code, e.g. `not_found`).
+- `data` rides along under the envelope's `data` field for structured context.
 
-Declare them on the handler; throw via `req.errors.<name>(...)`. Declared
-errors are described in the endpoint's OpenAPI and codegen'd into a typed enum
-for iOS callers.
+```ts
+throw new NotFound("Room does not exist", "room_not_found");
+throw new Conflict("locked", "title_locked", { retryAfter: 30 });
+```
+
+## `PalError` / `HttpError` (custom status)
+
+For a status/code not covered by a named class:
 
 ```ts
-import { defineHandler, z, Database } from "@palbase/backend";
-
-export default defineHandler({
-  input: z.object({ id: z.string() }),
-  output: z.object({ ok: z.boolean() }),
-  errors: {
-    notFound: { status: 404, code: "todo_not_found", description: "No such todo" },
-    locked: { status: 423, code: "todo_locked", data: z.object({ retryAfter: z.number() }) },
-  },
-  handler: async (req) => {
-    const todo = await Database.findById("todos", req.input.id);
-    if (!todo) throw req.errors.notFound();              // no data → no args
-    if (todo.locked) throw req.errors.locked({ retryAfter: 30 }); // data schema → required arg
-    return { ok: true };
-  },
-});
+import { PalError } from "@palbase/backend";
+throw new PalError(418, "teapot", "I'm a teapot");
+// optional structured payload (4th arg) rides along under `data`:
+throw new PalError(423, "todo_locked", "Locked", { retryAfter: 30 });
 ```
 
-A declared error with a `data` Zod schema requires that payload as an argument;
-one without `data` takes no arguments. This is enforced by the types.
+`PalError` (and its base `HttpError`) take `(status, code, description, data?)`.
+The named classes all extend `HttpError`, so `catch (e) { if (e instanceof
+HttpError) … }` matches any of them.