@palbase/backend 2.0.2 → 3.0.0

package/docs/llms-full.txt

@@ -1,6 +1,6 @@
 # Palbase Backend SDK (`@palbase/backend`)
 
-> File-based TypeScript backend SDK. Endpoints use `req` (PBRequest) + imported service singletons (`Database`, `Cache`, …). Workers/jobs/hooks/webhooks use a `ctx` object. Not Express, not Supabase Edge Functions.
+> File-based TypeScript backend SDK. All handler types import service singletons (`Database`, `Cache`, …). Trigger arg differs by type: endpoints use `req`, workers `(payload, meta)`, jobs `(meta)`, hooks/webhooks `(event, meta)`. Middleware is the one exception (`ctx`). Not Express, not Supabase Edge Functions.
 
 
 
@@ -15,25 +15,41 @@ 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.
 
-## The two mental models (important)
+## Mental model (important)
 
-| You are writing… | Handler receives | Services come from |
-|------------------|------------------|--------------------|
-| **Endpoints** (`endpoints/**`) | a single `req` ([PBRequest](./endpoints.md)) | imported singletons: `import { Database } from "@palbase/backend"` |
-| **Workers, Jobs, Hooks, Webhooks** | a `ctx` object | `ctx.db`, `ctx.log`, `ctx.cache`, `ctx.queue` |
+Every handler type imports service singletons the same way:
 
-Endpoints use `req` + imported singletons. Everything else uses `ctx`. Do not
-mix them: there is no `ctx` inside an endpoint handler, and no imported
-`Database` singleton call inside a worker (use `ctx.db`).
+```ts
+import { Database, Log, Cache, Queue } from "@palbase/backend";
+```
+
+The **only difference** is the trigger argument:
+
+| You are writing… | Handler signature | Trigger arg |
+|------------------|-------------------|-------------|
+| **Endpoints** (`controllers/` + `handlers/`) | `(req)` | `req` — [PBRequest](./endpoints.md) |
+| **Workers** (`workers/**`) | `(payload, meta)` | typed payload + `WorkerMeta` |
+| **Jobs** (`jobs/**`) | `(meta)` | `JobMeta` |
+| **Hooks** (`hooks/**`) | `(event, meta)` | typed event + `HookMeta` |
+| **Webhooks** (`webhooks/**`) | `(event, meta)` | typed event + `WebhookMeta` |
+| **Middleware** (`middleware/**`) | `(ctx, next)` | `MiddlewareContext` — the **one exception** |
+
+`meta` carries non-service data: `env` (branch env vars), `projectId`,
+`environmentId`, and for workers/webhooks `requestId`. Services always come from
+the imported singletons — not from `ctx` or any argument.
 
 ## Project shape
 
 ```
 my-backend/
 ├── package.json            # depends on @palbase/backend
-├── endpoints/              # HTTP endpoints (file-based routing)
-│   └── hello/get.ts        # → GET /hello
+├── 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
 ├── db/schema.ts            # table definitions (optional, enables typed DB)
+├── db/migrations/          # explicit SQL migrations for type changes (optional)
 ├── workers/                # background job handlers (optional)
 ├── jobs/                   # cron-scheduled jobs (optional)
 ├── hooks/                  # auth/storage/document event hooks (optional)
@@ -41,6 +57,10 @@ 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).
+
 ## Documentation
 
 | Topic | File |
@@ -50,6 +70,7 @@ my-backend/
 | Endpoints & `req` | [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) |
 | Errors | [errors.md](./errors.md) |
 | Workers & Jobs | [background.md](./background.md) |
@@ -77,7 +98,6 @@ Your project depends on the SDK and uses the Palbase CLI for the dev loop:
   "private": true,
   "scripts": {
     "dev": "palbase serve",
-    "deploy": "palbase push",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": { "@palbase/backend": "latest" },
@@ -87,19 +107,24 @@ Your project depends on the SDK and uses the Palbase CLI for the dev loop:
 
 ## Local dev loop
 
-- `palbase serve` — run your backend locally with hot reload.
-- `palbase push` — deploy the current directory to your project's backend runtime.
-- `palbase push --branch <name>` — deploy to a branch instead of `main`.
+- `palbase serve` — run your backend locally with hot reload. It runs your
+  `controllers/` locally but proxies `Database`/`ctx.*` to the **deployed**
+  branch, so the branch must already be deployed (serve tells you to push first
+  if it isn't). See [migrations.md](./migrations.md) for the schema/migration
+  side of this.
+- **Deploy is GitHub-native** — there is no `palbase push`. Commit and
+  `git push` to your project's repo; the push triggers a deploy of the backend
+  runtime. Push a **branch** to deploy that branch instead of `main`.
 
 ## Your first endpoint
 
-Create `endpoints/hello/get.ts`:
+A handler is one endpoint unit; a controller maps method+path to it. Create
+`handlers/hello.ts`:
 
 ```ts
-import { defineEndpoint, z } from "@palbase/backend";
+import { defineHandler, z } from "@palbase/backend";
 
-export default defineEndpoint({
-  method: "GET",
+export default defineHandler({
   input: z.object({ name: z.string().optional() }),
   output: z.object({ message: z.string(), user: z.string().nullable() }),
   handler: async (req) => ({
@@ -109,64 +134,110 @@ export default defineEndpoint({
 });
 ```
 
+Then mount it in `controllers/hello.controller.ts`:
+
+```ts
+import { defineController, route } from "@palbase/backend";
+import hello from "../handlers/hello.js";
+
+export default defineController("/hello", {
+  hello: route.get("/", hello),
+});
+```
+
 This is served at `GET /hello`. The Zod `input` schema validates the request and
-flows into `req.input`; the `output` schema validates your return value.
+flows into `req.input`; the `output` schema validates your return value. See
+[routing.md](./routing.md) for the handler + controller model.
 
 
 
 <!-- ===== routing.md ===== -->
 
-# File-based routing
+# Routing
 
-The path of a file under `endpoints/` plus its filename determine the route.
-The filename is the HTTP method.
+Routes are declared in code. A **handler** is one endpoint unit (schema + thin
+logic) with NO route on it; a **controller** is a route map (method+path →
+handler). Putting a controller file under `controllers/` mounts it — there is no
+central router and no manual registration.
 
-| File | Route |
-|------|-------|
-| `endpoints/hello/get.ts` | `GET /hello` |
-| `endpoints/items/post.ts` | `POST /items` |
-| `endpoints/posts/[id]/get.ts` | `GET /posts/:id` |
-| `endpoints/posts/[id]/patch.ts` | `PATCH /posts/:id` |
-| `endpoints/rooms/[id]/sessions/post.ts` | `POST /rooms/:id/sessions` |
+```ts
+import { defineController, route } from "@palbase/backend";
+```
 
-Rules:
+## Handlers — one endpoint per file, no route
 
-- The method file name is one of `get`, `post`, `put`, `patch`, `delete` (`.ts`).
-- A `[segment]` directory becomes a `:segment` path param, read via `req.params.segment`.
-- Each method file `export default defineEndpoint({...})` — one endpoint per file.
-- There is no central router file and no manual registration. Adding a file adds a route.
+A handler declares everything that types `req` (`auth`/`input`/`output`/
+`errors`) and the logic; it has no method or path.
 
 ```ts
-// endpoints/posts/[id]/get.ts  → GET /posts/:id
-import { defineEndpoint, z, Database, HttpError } from "@palbase/backend";
+// handlers/places/import-nearby.ts
+import { defineHandler, z } from "@palbase/backend";
+import { placeService } from "../../services/place.service.js";
+
+export default defineHandler({
+  auth:   { required: true },
+  input:  z.object({ lat: z.number(), lng: z.number() }),
+  output: z.object({ imported: z.number() }),
+  errors: { quotaExceeded: { status: 429, code: "quota_exceeded" } },
+  handler: (req) => placeService.importNearby(req.input.lat, req.input.lng),
+});
+```
 
-export default defineEndpoint({
-  method: "GET",
-  output: z.object({ id: z.string(), title: z.string() }),
-  handler: async (req) => {
-    const post = await Database.findById("posts", req.params.id!);
-    if (!post) throw new HttpError(404, "post_not_found", "No such post");
-    return { id: post.id as string, title: post.title as string };
-  },
+## Controllers — the route map
+
+A controller maps method+path to handlers with `route.get|post|put|patch|delete`.
+The route-map KEY is authoring sugar only (it is NOT the operationId).
+
+```ts
+// controllers/places.controller.ts
+import { defineController, route } from "@palbase/backend";
+import importNearby  from "../handlers/places/import-nearby.js";
+import addFavorite   from "../handlers/places/add-favorite.js";
+import listFavorites from "../handlers/places/list-favorites.js";
+
+export default defineController("/places", {
+  importNearby:  route.post("/import",    importNearby),
+  addFavorite:   route.post("/favorites", addFavorite),
+  listFavorites: route.get ("/favorites", listFavorites),
 });
 ```
 
+| Map key (sugar) | Method | Full path | operationId (flat) |
+|---|---|---|---|
+| `importNearby`  | POST | `/places/import`    | `postPlacesImport` |
+| `addFavorite`   | POST | `/places/favorites` | `postPlacesFavorites` |
+| `listFavorites` | GET  | `/places/favorites` | `getPlacesFavorites` |
+
+Rules:
+
+- The full path of a route is `basePath + subpath` (`"/places" + "/import"`).
+- A `{segment}` in a path becomes a route param, read via `req.params.segment`.
+- Each route value MUST be a `route.*(...)` result — a bare handler is a
+  compile error, which keeps logic out of controllers.
+- The operationId is derived FLAT from method + full path (`postPlacesImport`),
+  not from the map key. Change a verb with `route.post` → `route.put` — no file
+  rename.
+
+See [endpoints.md](./endpoints.md) for the full `defineHandler` config (`req`,
+auth, input/output, errors, middleware) reference.
+
 
 
 <!-- ===== endpoints.md ===== -->
 
 # Endpoints
 
-An endpoint is `export default defineEndpoint({...})` in a method file. 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 **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)).
 
-## `defineEndpoint` config
+## `defineHandler` config
 
 ```ts
-defineEndpoint({
-  method: "POST",                    // required: GET | POST | PUT | PATCH | DELETE
-  auth: { required: true },          // optional; see Auth below. Omitted → public.
+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
@@ -176,6 +247,9 @@ defineEndpoint({
 });
 ```
 
+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`.
+
 ## `req` (PBRequest)
 
 | Field | Type | Notes |
@@ -191,40 +265,43 @@ defineEndpoint({
 | `req.requestId` / `req.traceId` / `req.spanId` | `string` | correlation ids |
 | `req.errors` | typed throwers | present when `errors` is declared (see errors.md) |
 
-`User` is `{ id: string; email: string; role: string; metadata: Record<string, unknown> }`.
+`User` is `{ id: string; email?: string; role: string; metadata: Record<string, unknown> }`.
 
 ## Auth
 
+**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 }`.
+
 ```ts
-auth: { required: true }                // require any authenticated user → req.user is non-null User
+// 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
-// auth omitted entirely                 // also public → req.user is User | null
+auth: { required: false }               // PUBLIC → req.user may be null (anon key only)
 ```
 
 Whether `req.user` is non-null is computed from the `auth` config at the type
-level:
+level (and matches the runtime exactly):
 
 | `auth` value | `req.user` type |
 |--------------|-----------------|
-| omitted | `User \| null` |
+| omitted | `User` (secure-by-default) |
 | `true` | `User` |
-| `false` | `User \| null` |
+| `false` | `User \| null` (public) |
 | `{ required: true }` | `User` |
-| `{ required: false }` | `User \| null` |
+| `{ required: false }` | `User \| null` (public) |
 | `{ role: "admin" }` (object, no `required`) | `User` |
 
-To enforce authentication, set `auth: { required: true }` (or `auth: true`). An
+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.
 
 ## Typed input/output
 
 ```ts
-import { defineEndpoint, z, Database } from "@palbase/backend";
+import { defineHandler, z, Database } from "@palbase/backend";
 
-export default defineEndpoint({
-  method: "POST",
+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() }),
@@ -238,6 +315,18 @@ export default defineEndpoint({
 });
 ```
 
+A controller then mounts it with a method + path:
+
+```ts
+// controllers/rooms.controller.ts
+import { defineController, route } from "@palbase/backend";
+import create from "../handlers/rooms/create.js";
+
+export default defineController("/rooms", {
+  create: route.post("/", create),
+});
+```
+
 ## Middleware
 
 A middleware wraps a request. Define one in `middleware/<name>.ts`:
@@ -257,15 +346,14 @@ 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 endpoint, import it and list it in the
-endpoint's `middleware` array:
+To attach middleware to a specific handler, import it and list it in the
+handler's `middleware` array:
 
 ```ts
-import { defineEndpoint, z } from "@palbase/backend";
+import { defineHandler, z } from "@palbase/backend";
 import logger from "../../middleware/logger.js";
 
-export default defineEndpoint({
-  method: "GET",
+export default defineHandler({
   middleware: [logger],
   output: z.object({ ok: z.boolean() }),
   handler: async (req) => ({ ok: true }),
@@ -278,17 +366,38 @@ export default defineEndpoint({
 
 # Database
 
-In **endpoints**, import the `Database` singleton:
+Import the `Database` singleton in every handler type — endpoints, workers,
+jobs, hooks, and webhooks all use the same import:
 
 ```ts
 import { Database } from "@palbase/backend";
 ```
 
-In **workers, jobs, hooks, and webhooks**, use `ctx.db` — the same surface,
-reached via the context object (see [background.md](./background.md) and
-[events.md](./events.md)).
+Only **middleware** still uses `ctx.db` (see [background.md](./background.md)
+and [events.md](./events.md) for worker/job/hook/webhook examples).
+
+## Typed by default — `Database.tables`
+
+When you declare `db/schema.ts`, `Database.tables.<name>` is typed everywhere
+with no import and no generic. `insert` demands the right columns; rows come
+back typed; nullable columns are `T | null`. This is the path you should use:
+
+```ts
+const todo = await Database.tables.todos.insert({ title: "buy milk" });
+todo.id;       // string ✓
+todo.done;     // boolean ✓
+const open = await Database.tables.todos.findMany({ done: false });
+await Database.tables.todos.update(todo.id, { done: true });
+await Database.tables.todos.delete(todo.id);
+// todo.nope ← compile error
+```
+
+See [schema.md](./schema.md) for the full typed-table surface.
 
-## Operations
+## Raw string-keyed operations
+
+For dynamic table names or read-only SQL, the string-keyed ops are still
+available:
 
 | Method | Returns |
 |--------|---------|
@@ -300,14 +409,6 @@ reached via the context object (see [background.md](./background.md) and
 | `Database.query(sql, params?)` | rows from a read-only SQL query (runs in a READ ONLY transaction) |
 | `Database.transaction(fn)` | runs `fn(tx)` in a transaction |
 
-```ts
-const row = await Database.insert("todos", { title: "buy milk", done: false });
-const one = await Database.findById("todos", row.id as string);
-const open = await Database.findMany("todos", { done: false });
-await Database.update("todos", row.id as string, { done: true });
-await Database.delete("todos", row.id as string);
-```
-
 `findMany`'s `query` is an equality filter: keys are ANDed together. For
 anything richer (ranges, ordering, joins) use `Database.query`.
 
@@ -328,14 +429,14 @@ transaction). Returning commits; throwing rolls back.
 
 ```ts
 await Database.transaction(async (tx) => {
-  const order = await tx.insert("orders", { amount: 1000, status: "pending" });
-  await tx.insert("order_items", { order_id: order.id, sku: "ABC" });
+  const order = await tx.tables.orders.insert({ amount: 1000, status: "pending" });
+  await tx.tables.order_items.insert({ order_id: order.id, sku: "ABC" });
   // throw here → both inserts roll back
 });
 ```
 
-For a typed `.tables.*` API instead of string table names, see
-[schema.md](./schema.md).
+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.
 
 
 
@@ -344,36 +445,43 @@ For a typed `.tables.*` API instead of string table names, see
 # Schema & typed database access
 
 Declare your tables in `db/schema.ts` with `defineSchema`. This drives
-migrations and, via `typedDatabase`, a fully-typed `.tables.*` API.
+[migrations](./migrations.md) (additive changes auto-apply on deploy; type
+changes need an explicit migration) and makes `Database.tables.*` typed
+everywhere — by default, with no import and no generic.
 
 ## Defining a schema
 
+The table NAME comes from the object key under `tables` — there is one
+canonical form.
+
 ```ts
 import {
-  defineSchema, table,
+  defineSchema,
   uuid, text, integer, boolean, timestamp, jsonb, enumType,
 } from "@palbase/backend";
 
 export default defineSchema({
-  rooms: table("rooms", {
-    id: uuid().primaryKey().defaultRandom(),
-    name: text().notNull(),
-    capacity: integer().nullable(),
-    is_active: boolean().default(true),
-    created_at: timestamp().defaultNow(),
-  }),
-  sessions: table("sessions", {
-    id: uuid().primaryKey().defaultRandom(),
-    room_id: uuid().notNull().references("rooms", "id").onDelete("cascade"),
-    user_id: uuid().notNull(),
-    data: jsonb().nullable(),
-    started_at: timestamp().defaultNow(),
-  }),
-  orders: table("orders", {
-    id: uuid().primaryKey().defaultRandom(),
-    status: enumType("order_status", ["pending", "paid", "shipped", "cancelled"]),
-    amount: integer().notNull(),
-  }),
+  tables: {
+    rooms: {
+      id: uuid().primaryKey().defaultRandom(),
+      name: text().notNull(),
+      capacity: integer().nullable(),
+      is_active: boolean().default(true),
+      created_at: timestamp().defaultNow(),
+    },
+    sessions: {
+      id: uuid().primaryKey().defaultRandom(),
+      room_id: uuid().notNull().references("rooms", "id").onDelete("cascade"),
+      user_id: uuid().notNull(),
+      data: jsonb().nullable(),
+      started_at: timestamp().defaultNow(),
+    },
+    orders: {
+      id: uuid().primaryKey().defaultRandom(),
+      status: enumType("order_status", ["pending", "paid", "shipped", "cancelled"]),
+      amount: integer().notNull(),
+    },
+  },
 });
 ```
 
@@ -394,35 +502,141 @@ Chainable modifiers: `.primaryKey()`, `.notNull()` (default), `.nullable()`,
 `.defaultNow()` (timestamp → `now()`), `.references(table, column)`,
 `.onDelete("cascade" | "set null" | "restrict" | "no action")`.
 
-## Typed DB access
+## Typed DB access — by default
 
-`typedDatabase(schema)` returns a typed facade. `insert` demands the right
-columns; rows come back typed; nullable columns are `T | null`.
+You do **not** wire anything per endpoint. Saving `db/schema.ts` regenerates
+`palbase-env.d.ts`, which types `Database.tables.<name>` everywhere — no import
+of the schema, no generic, no cast:
 
 ```ts
-import { defineEndpoint, z, typedDatabase } from "@palbase/backend";
-import schema from "../../db/schema.js";
+import { defineHandler, z, Database } from "@palbase/backend";
 
-const Db = typedDatabase(schema);
-
-export default defineEndpoint({
-  method: "POST",
+export default defineHandler({
   input: z.object({ name: z.string() }),
   output: z.object({ id: z.string(), name: z.string() }),
   handler: async (req) => {
-    const room = await Db.tables.rooms.insert({ name: req.input.name });
-    return { id: room.id, name: room.name };
+    const room = await Database.tables.rooms.insert({ name: req.input.name });
+    return { id: room.id, name: room.name }; // room.id: string ✓
+    // room.nope ← compile error
   },
 });
 ```
 
-Note the `.js` extension on `../../db/schema.js` even though the file is
-`db/schema.ts` — this is standard ESM module resolution; you still author the
-file as `.ts`.
+`Database.tables.<name>` exposes `insert`, `update(id, data)`, `delete(id)`,
+`findById(id)`, `findMany(query?)`, and `Database.transaction(fn)` yields a `tx`
+with the same typed tables. The raw string-keyed ops
+(`Database.insert("rooms", …)`, `Database.query(…)`) are still available for
+dynamic table names and read-only SQL.
+
+If you want a row type explicitly, import it from the generated env module:
+
+```ts
+import type { Tables } from "@palbase/backend/env";
+type Room = Tables["rooms"]["row"];
+```
+
+
+
+<!-- ===== migrations.md ===== -->
+
+# Migrations
+
+`db/schema.ts` is the single source of truth for your Postgres schema. On every
+deploy, Palbase diffs your declared schema against the live branch database and
+reconciles it — but *how* it reconciles depends on whether the change is safe to
+apply automatically.
+
+## Two kinds of change
+
+### 1. Additive — auto-applied, no migration file
+
+A new table, or a new **nullable** or **defaulted** column, is additive: the
+deploy applies it automatically (`CREATE TABLE` / `ADD COLUMN`) with no manual
+step and no backfill risk. Just edit `db/schema.ts` and deploy.
+
+```ts
+// before
+todos: {
+  id: uuid().primaryKey().defaultRandom(),
+  title: text().notNull(),
+}
+
+// after — additive: `notes` (nullable) + `priority` (defaulted) auto-apply on deploy
+todos: {
+  id: uuid().primaryKey().defaultRandom(),
+  title: text().notNull(),
+  notes: text().nullable(),
+  priority: text().nullable().default("normal"),
+}
+```
+
+> A new **NOT NULL column without a default** is NOT additive-safe on a table
+> that already has rows (there is nothing to put in the existing rows). Make it
+> `.nullable()`, give it a `.default(...)`, or apply it as an explicit migration
+> (add nullable → backfill → set NOT NULL).
+
+### 2. Destructive / type-changing — needs an explicit migration
+
+Renaming or dropping a column, changing a column's type, or adding a NOT NULL
+constraint can lose or corrupt existing data — so the deploy's **drift-gate
+blocks them** and the deploy fails until you provide an explicit migration.
+Write the SQL yourself in `db/migrations/`:
+
+```
+db/migrations/
+  001_user_id_to_text.up.sql
+  001_user_id_to_text.down.sql
+```
+
+```sql
+-- 001_user_id_to_text.up.sql
+ALTER TABLE todos ALTER COLUMN user_id TYPE text USING user_id::text;
+```
+
+```sql
+-- 001_user_id_to_text.down.sql
+ALTER TABLE todos ALTER COLUMN user_id TYPE uuid USING user_id::uuid;
+```
 
-`Db.tables.<name>` exposes `insert`, `update(id, data)`, `delete(id)`,
-`findById(id)`, `findMany(query?)`, and `Db.transaction(fn)` mirrors the
-untyped transaction with typed tables.
+Migrations are golang-migrate style: numbered `NNN_name.up.sql` / `.down.sql`
+pairs, applied in order and tracked so each runs exactly once (idempotent).
+`db/schema.ts` always describes the **end state**; the migration describes **how
+existing data gets there**. Keep the two in sync — after the migration lands,
+`schema.ts` should already reflect the new column type.
+
+## The drift-gate
+
+On deploy, Palbase compares `db/schema.ts` to the live database:
+
+- **Additive** diffs → auto-applied.
+- **Type-changing / destructive** diffs **with** a matching migration → the
+  migration runs.
+- **Type-changing / destructive** diffs **without** a migration → the deploy
+  **aborts** and your currently-running version keeps serving.
+
+This is deliberate: it stops an accidental column-type change from silently
+dropping production data. A blocked deploy is a prompt to write the migration,
+not a failure to work around.
+
+## Local dev: `palbase serve` uses the deployed database
+
+`palbase serve` runs your controllers locally but proxies `Database` and
+`ctx.*` to the **deployed** branch — it does **not** spin up a local Postgres or
+apply migrations locally. So when your local `db/schema.ts` or `db/migrations/`
+is ahead of what's deployed, serve prints a note: new tables/columns won't exist
+until you push. Deploy to apply them.
+
+## Workflow
+
+1. Edit `db/schema.ts`.
+2. **Additive** change? → `git push`. It auto-migrates on deploy.
+3. **Type change / rename / drop?** → add `db/migrations/NNN_*.up.sql` (+
+   `.down.sql`), then `git push`. The runner applies it; without it the
+   drift-gate blocks the deploy.
+4. `palbase serve` warns locally until the change is deployed.
+
+See [schema.md](./schema.md) for the column builders and typed
+`Database.tables.*` access.
 
 
 
@@ -430,9 +644,9 @@ untyped transaction with typed tables.
 
 # Services
 
-In **endpoints**, import service singletons from `@palbase/backend`. In
-**workers/jobs/hooks/webhooks**, the equivalents live on `ctx` (`ctx.cache`,
-`ctx.queue`, `ctx.log`, `ctx.db`).
+Import service singletons from `@palbase/backend` in every handler type —
+endpoints, workers, jobs, hooks, and webhooks all use the same imports. Only
+**middleware** uses a `ctx` argument (`ctx.db`, `ctx.log`, etc.).
 
 Available singletons: `Database`, `Documents`, `Storage`, `Cache`, `Queue`,
 `Log`, `Notifications`, `Flags`.
@@ -520,10 +734,9 @@ await Notifications.sms.send({ /* PalbaseSmsSendParams */ });
 ## Flags
 
 ```ts
-import { defineEndpoint, z, Flags } from "@palbase/backend";
+import { defineHandler, z, Flags } from "@palbase/backend";
 
-export default defineEndpoint({
-  method: "GET",
+export default defineHandler({
   auth: { required: true },           // req.user is non-null here
   output: z.object({ enabled: z.boolean() }),
   handler: async (req) => {
@@ -536,6 +749,105 @@ export default defineEndpoint({
 
 
 
+<!-- ===== resources.md ===== -->
+
+# Resources
+
+A `Resource` models one external connection — a pooled datastore, a stateless
+API client, or a per-user factory. You put it in `resources/`, export an
+instance, and **do not register it**: the framework discovers it, sets it up
+once at boot, and drains it on shutdown. On top of that lifecycle you expose
+your own clean facade.
+
+```ts
+import { Resource } from "@palbase/backend";
+```
+
+## Lifecycle (boot scope — not per request)
+
+A resource is created once at process boot — NOT per request. The framework:
+
+1. calls `init(env)` **once**, with only the secrets the resource declared;
+2. (optionally) calls `shutdown()` on SIGTERM, in reverse boot order.
+
+The instance lives for the whole process; your facade methods are called
+per-request. This makes "reconnect on every request" structurally impossible.
+
+## Pooled datastore — `init` + `shutdown`
+
+```ts
+import { Resource } from "@palbase/backend";
+import neo4j, { type Driver, type Session } from "neo4j-driver";
+
+export class Neo4jResource extends Resource {
+  static secrets = ["NEO4J_URL", "NEO4J_USER", "NEO4J_PASSWORD"] as const;
+  private driver!: Driver;
+  async init(env: { NEO4J_URL: string; NEO4J_USER: string; NEO4J_PASSWORD: string }) {
+    this.driver = neo4j.driver(env.NEO4J_URL, neo4j.auth.basic(env.NEO4J_USER, env.NEO4J_PASSWORD));
+  }
+  async shutdown() {
+    await this.driver.close();
+  }
+  session(): Session {
+    return this.driver.session();
+  }
+}
+
+export const graph = new Neo4jResource();
+```
+
+## Stateless API client — `init` only
+
+```ts
+import { Resource } from "@palbase/backend";
+import { Client } from "@googlemaps/google-maps-services-js";
+
+export class GoogleResource extends Resource {
+  static secrets = ["GOOGLE_MAPS_KEY"] as const;
+  private client = new Client();
+  private key = "";
+  init(env: { GOOGLE_MAPS_KEY: string }) {
+    this.key = env.GOOGLE_MAPS_KEY;
+  }
+  nearby(lat: number, lng: number) {
+    return this.client.placesNearby({ params: { location: { lat, lng }, radius: 1500, key: this.key } });
+  }
+}
+
+export const google = new GoogleResource();
+```
+
+A per-user (OAuth) resource adds a factory method on the base, e.g.
+`github.forUser(token)` — the same single model covers pooled, stateless, and
+per-user.
+
+## Secrets
+
+`static secrets` is the contract:
+
+- It **types** the `env` passed to `init` — only the declared names are
+  present, each a `string`. An undeclared key is a compile error.
+- A declared secret that is **missing at boot fails the deploy**, naming the
+  secret. Secrets are branch-scoped; set them with `palbase secret set NAME ...`
+  or in Studio. A resource is initialised once at boot, so rotating a secret
+  needs a redeploy/restart.
+
+`secrets` is optional — a resource that needs none simply omits it and gets an
+empty `env`.
+
+## Using a resource
+
+Import the singleton and call your facade — services and handlers reach
+resources the same way they reach `Database`:
+
+```ts
+import { google } from "../resources/google.js";
+
+const results = (await google.nearby(41.0, 29.0)).data.results;
+```
+
+
+
 <!-- ===== errors.md ===== -->
 
 # Errors
@@ -560,15 +872,14 @@ throw new HttpError(423, "todo_locked", "Locked", { retryAfter: 30 });
 
 ## 2. Declared errors (typed)
 
-Declare them on the endpoint; throw via `req.errors.<name>(...)`. Declared
+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
-import { defineEndpoint, z, Database } from "@palbase/backend";
+import { defineHandler, z, Database } from "@palbase/backend";
 
-export default defineEndpoint({
-  method: "POST",
+export default defineHandler({
   input: z.object({ id: z.string() }),
   output: z.object({ ok: z.boolean() }),
   errors: {
@@ -593,10 +904,10 @@ one without `data` takes no arguments. This is enforced by the types.
 
 # Workers & Jobs
 
-Workers and jobs use the **`ctx` model**: their handler receives a context
-object with `ctx.db`, `ctx.log`, `ctx.cache`, `ctx.queue`, `ctx.env`. They do
-**not** receive a `req`, and you do **not** import the `Database` singleton
-inside them — use `ctx.db`.
+Workers and jobs use the **singleton model** — the same imported service
+singletons as endpoints (`import { Database, Log } from "@palbase/backend"`).
+They do **not** receive a `req`. Instead, a small `meta` argument carries the
+non-service data (`env`, `user`, correlation ids).
 
 ## Workers (queue consumers)
 
@@ -605,7 +916,7 @@ A worker processes jobs pushed via `Queue.push(name, payload)`. File lives under
 
 ```ts
 // workers/process-order.ts
-import { defineWorker } from "@palbase/backend";
+import { defineWorker, Database, Log } from "@palbase/backend";
 
 interface OrderPayload { orderId: string; amount: number; }
 
@@ -614,13 +925,16 @@ export default defineWorker<OrderPayload>({
   retry: 5,                    // optional, default 3
   timeout: 60,                 // optional, seconds
   backoff: "exponential",      // "exponential" | "linear" | "fixed", default exponential
-  handler: async (ctx, payload) => {
-    ctx.log.info(`processing ${payload.orderId} for $${payload.amount}`);
-    await ctx.db.update("orders", payload.orderId, { status: "processed" });
+  handler: async (payload, meta) => {
+    Log.info(`processing ${payload.orderId} (env ${meta.environmentId})`);
+    await Database.update("orders", payload.orderId, { status: "processed" });
   },
 });
 ```
 
+`meta` shape: `{ env, user, requestId, projectId, environmentId }`. Branch env
+vars are in `meta.env`; services come from the imported singletons.
+
 Enqueue from an endpoint:
 
 ```ts
@@ -634,29 +948,34 @@ A job runs on a cron schedule. File lives under `jobs/`.
 
 ```ts
 // jobs/cleanup.ts
-import { defineJob } from "@palbase/backend";
+import { defineJob, Database, Log } from "@palbase/backend";
 
 export default defineJob({
   name: "cleanup-expired",
   schedule: "0 3 * * *",       // standard cron
   timeout: 120,                // optional, seconds
-  handler: async (ctx) => {
-    const expired = await ctx.db.findMany("sessions", { expired: true });
-    for (const s of expired) await ctx.db.delete("sessions", s.id as string);
-    ctx.log.info(`cleaned ${expired.length} sessions`);
+  handler: async (meta) => {
+    const expired = await Database.findMany("sessions", { expired: true });
+    for (const s of expired) await Database.delete("sessions", s.id as string);
+    Log.info(`cleaned ${expired.length} sessions in ${meta.projectId}`);
   },
 });
 ```
 
+`meta` shape: `{ env, projectId, environmentId }`. No `user` (jobs are
+system-initiated).
+
 
 
 <!-- ===== events.md ===== -->
 
 # Hooks & Webhooks
 
-Like workers/jobs, hooks and webhooks use the **`ctx` model** (`ctx.db`,
-`ctx.log`, `ctx.cache`, `ctx.queue`, `ctx.env`) — not `req`, and not imported
-singletons.
+Like workers/jobs, hooks and webhooks use the **singleton model** — the same
+imported service singletons as endpoints (`import { Database, Log } from
+"@palbase/backend"`). They do **not** receive a `req`. A second `meta` argument
+carries the non-service data (`env`, `projectId`, `environmentId`; webhooks also
+get `requestId`).
 
 ## Hooks (platform events)
 
@@ -665,21 +984,24 @@ are imported from `@palbase/backend`: `auth`, `storage`, `documents`.
 
 ```ts
 // hooks/auth.ts
-import { auth } from "@palbase/backend";
+import { auth, Database, Log } from "@palbase/backend";
 
-export const onUserCreated = auth.onUserCreated(async (ctx, event) => {
-  ctx.log.info(`new user: ${event.user.email}`);
-  await ctx.db.insert("profiles", {
+export const onUserCreated = auth.onUserCreated(async (event, meta) => {
+  Log.info(`new user: ${event.user.email}`);
+  await Database.insert("profiles", {
     user_id: event.user.id,
     email: event.user.email,
   });
 });
 
-export const onSignIn = auth.onSignIn(async (ctx, event) => {
-  ctx.log.info(`sign in: ${event.user.email} via ${event.provider}`);
+export const onSignIn = auth.onSignIn(async (event, meta) => {
+  Log.info(`sign in: ${event.user.email} via ${event.provider}`);
 });
 ```
 
+`meta` shape: `{ env, projectId, environmentId }`. Branch env vars are in
+`meta.env`; services come from the imported singletons.
+
 Available hook builders: `auth.onUserCreated`, `auth.onSignIn`, `auth.onSignOut`,
 `auth.onPasswordReset`, `storage.onFileUploaded`, `storage.onFileDeleted`,
 `documents.onDocumentCreated`, `documents.onDocumentUpdated`,
@@ -692,22 +1014,25 @@ Receive and verify webhooks from third-party providers. Files live under
 
 ```ts
 // webhooks/stripe.ts
-import { defineWebhook } from "@palbase/backend";
+import { defineWebhook, Database, Log } from "@palbase/backend";
 
 export default defineWebhook({
   provider: "stripe",
   secret: { env: "STRIPE_WEBHOOK_SECRET" },   // signing secret resolved from env
   events: {
-    "checkout.session.completed": async (ctx, event) => {
-      await ctx.db.insert("orders", { status: "paid", data: event });
+    "checkout.session.completed": async (event, meta) => {
+      await Database.insert("orders", { status: "paid", data: event });
     },
-    "payment_intent.payment_failed": async (ctx, event) => {
-      ctx.log.error("payment failed");
-      await ctx.db.insert("payment_failures", { data: event });
+    "payment_intent.payment_failed": async (event, meta) => {
+      Log.error("payment failed");
+      await Database.insert("payment_failures", { data: event });
     },
   },
 });
 ```
 
-The signing secret is read from the project's env/secrets (`{ env: "NAME" }`);
-the runtime verifies the signature before dispatching to your event handlers.
+The signing secret is resolved by the runtime from `secret: { env: "NAME" }`;
+your handlers access branch env vars via `meta.env`. The runtime verifies the
+signature before dispatching to your event handlers.
+
+`meta` shape: `{ env, requestId, projectId, environmentId }`.