pipework 0.7.13 → 0.7.18

package/REFERENCE.md

@@ -1,35 +1,36 @@
 # Pipework API Reference
 
 > Auto-generated from source JSDoc. Do not edit manually.
-> Generated: 2026-05-07
+> Generated: 2026-05-11
 
 ## Contents
 
 - [Core](#core)
-- [audit — Audit Logging](#audit-audit-logging)
+- [jobs — Background Jobs](#jobs-background-jobs)
+- [pipeline — Multi-Step Pipelines](#pipeline-multi-step-pipelines)
+- [state — State Machines](#state-state-machines)
 - [auth — Authentication](#auth-authentication)
-- [behavior — Resource Decorators](#behavior-resource-decorators)
-- [cache — Caching](#cache-caching)
+- [rbac — Access Control](#rbac-access-control)
+- [tenant — Multi-Tenancy](#tenant-multi-tenancy)
 - [config — Configuration](#config-configuration)
-- [pipe — Database](#pipe-database)
 - [errors — Error Classes](#errors-error-classes)
-- [fitting — Dependency Injection](#fitting-dependency-injection)
-- [fixture — REST Resources](#fixture-rest-resources)
-- [flow — Context (AsyncLocalStorage)](#flow-context-asynclocalstorage)
-- [http — Server](#http-server)
-- [jobs — Background Jobs](#jobs-background-jobs)
 - [lifecycle — Startup & Shutdown](#lifecycle-startup-shutdown)
 - [log — Structured Logging](#log-structured-logging)
-- [openapi — API Documentation](#openapi-api-documentation)
-- [pipeline — Multi-Step Pipelines](#pipeline-multi-step-pipelines)
-- [rbac — Access Control](#rbac-access-control)
-- [schema — Validation & Schema](#schema-validation-schema)
-- [state](#state)
 - [surface — Entry Points](#surface-entry-points)
+- [pipe — Database](#pipe-database)
+- [jsonb — JSONB Column Helpers](#jsonb-jsonb-column-helpers)
+- [schema — Validation & Schema](#schema-validation-schema)
 - [temporal — Bitemporal Data](#temporal-bitemporal-data)
-- [tenant — Multi-Tenancy](#tenant-multi-tenancy)
 - [vector — Vector & Full-Text Search](#vector-vector-full-text-search)
+- [audit — Audit Logging](#audit-audit-logging)
+- [cache — Caching](#cache-caching)
 - [webhook — Inbound & Outbound Webhooks](#webhook-inbound-outbound-webhooks)
+- [behavior — Resource Decorators](#behavior-resource-decorators)
+- [fitting — Dependency Injection](#fitting-dependency-injection)
+- [fixture — REST Resources](#fixture-rest-resources)
+- [flow — Context (AsyncLocalStorage)](#flow-context-asynclocalstorage)
+- [http — Server](#http-server)
+- [openapi — API Documentation](#openapi-api-documentation)
 
 ## Core
 
@@ -51,6 +52,12 @@ function createManifold<const TEnv extends EnvDefs = EnvDefs>( raw: Omit<Bluepri
 interface Manifold<TEnv extends EnvDefs = EnvDefs>
 ```
 
+**`SeedOptions`**
+
+```typescript
+interface SeedOptions
+```
+
 **`PoolState`** — Manages database connection pools keyed by database name.
 
 ```typescript
@@ -69,13 +76,57 @@ interface IsolationState
 interface ConnectionTracker
 ```
 
-## audit — Audit Logging
+## jobs — Background Jobs
 
-Audit logging namespace — structured audit trail for data changes.
+Background job queue namespace — Postgres-backed with SKIP LOCKED, LISTEN/NOTIFY, cron scheduling.
 
-### `audit.create`
+### `jobs.createQueue`
 
-Creates an Audit instance that writes audit records to a Postgres table.
+Creates a job queue with claim/complete/fail lifecycle, heartbeat, and dead letter requeue.
+
+### `jobs.execute`
+
+Executes a fitting handler as a background job with its own Flow context.
+
+### `jobs.parseCron`
+
+Parses a 5-field cron expression into a CronSchedule (minute, hour, dom, month, dow).
+
+### `jobs.nextTick`
+
+Computes the next fire time for a CronSchedule after a given date, with optional timezone.
+
+## pipeline — Multi-Step Pipelines
+
+Multi-step pipeline namespace — define, execute, pause, and resume ordered step sequences.
+
+### `pipeline.define`
+
+Defines a pipeline from a config of named steps with handlers. Returns a Pipeline with execute/resume/getStatus.
+
+### `pipeline.PipelineStepError`
+
+Thrown when an individual pipeline step fails.
+
+### `pipeline.PipelineResumeError`
+
+Thrown when resuming a pipeline from an invalid state.
+
+## state — State Machines
+
+State machine namespace — define valid transitions with guards and side effects.
+
+### `state.define`
+
+Defines a state machine from states, transitions, guards, and effects. Returns a StateMachine with transition/canTransition.
+
+### `state.InvalidTransitionError`
+
+Thrown when a transition is not allowed from the current state.
+
+### `state.InvalidStateMachineError`
+
+Thrown when the state machine definition is internally inconsistent.
 
 ## auth — Authentication
 
@@ -237,81 +288,81 @@ type ResolveLoginResult = AuthenticatedResult | OrgSelectResult
 interface MultiOrgSessions
 ```
 
-## behavior — Resource Decorators
+## rbac — Access Control
 
-Resource behavior decorators — compose versioning, audit trails, and cache invalidation onto CRUD operations.
+Role-based access control namespace — permission checking, enforcement, scope hierarchy.
 
-### `behavior.compose`
+### `rbac.create`
 
-Applies multiple behaviors to a ResourceOperations set in order.
+Creates an Rbac instance from config (roles, permissions, hierarchy).
 
-### `behavior.versioned`
+### `rbac.check`
 
-Adds optimistic concurrency control via a version column — rejects stale updates.
+Checks if a permission set includes the required resource/action/scope. Pure function, no DB.
 
-### `behavior.audited`
+### `rbac.enforce`
 
-Wraps operations to emit audit records on create/update/delete.
+Checks permission and throws ForbiddenError if denied. Loads permissions from DB with caching.
 
-### `behavior.invalidate`
+### `rbac.satisfies`
 
-Wraps operations to invalidate a cache on mutations. Returns ops with an attached .cache handle.
+Checks if a granted scope satisfies a required scope given a hierarchy (e.g. org > team > self).
 
-## cache — Caching
+### `rbac.PermissionCache`
 
-In-memory caching namespace — TTL-based with stats, preload, and tenant-aware variants.
+LRU cache for resolved permissions — avoids repeated DB lookups within a request.
 
-### `cache.create`
+## tenant — Multi-Tenancy
 
-Creates a single-key cache with TTL, a loader function, and invalidation.
+Multi-tenant isolation namespace — RLS policies, tenant extraction, Postgres-side verification.
 
-### `cache.createTenant`
+### `tenant.validate`
 
-Creates a per-tenant cache — each tenant gets its own TTL and loader keyed by tenant ID.
+Validates a tenant ID format (non-empty string, safe characters).
 
-## config — Configuration
+### `tenant.rls`
 
-Configuration namespace — loads and resolves Blueprint configs, discovers pipework.config.ts.
+Enables RLS on a table and creates the tenant isolation policy in Postgres.
 
-### `config.load`
+### `tenant.policy`
 
-Parses and resolves a raw Blueprint into a ResolvedConfig with environment detection.
+Returns the SQL string for a tenant isolation RLS policy — use in migrations.
 
-### `config.discover`
+### `tenant.verify`
 
-Walks up from cwd to find pipework.config.ts, imports it, and returns the Manifold.
+Cross-checks ALS tenant against Postgres set_config('pipework.tenant_id') — defense-in-depth.
 
-### `config.configSchema`
+### `tenant.propagate`
 
-The zod schema for Blueprint validation — useful for custom config tooling.
+Sets pipework.tenant_id on the Postgres connection via set_config().
 
-### `config.ConfigError`
+### `tenant.extract`
 
-Thrown for configuration problems — includes a suggestion for how to fix.
+Extracts tenant ID from auth context using the configured extraction strategy.
 
-## pipe — Database
+### `tenant.isTenantScoped`
 
-Database accessor — returns a Drizzle DB instance scoped to the current request/job/test context. Requires active AsyncLocalStorage context.
+Returns true if a table has been marked as tenant-scoped (via .tenant() field metadata).
 
-### `pipe.unscoped`
+## config — Configuration
 
-Bypasses tenant scoping for admin/cross-tenant queries. Still requires ALS context.
+Configuration namespace — loads and resolves Blueprint configs, discovers pipework.config.ts.
 
-### `pipe.filter`
+### `config.load`
 
-Query operators and aggregates — eq, gt, lt, and, or, count, sum, etc.
+Parses and resolves a raw Blueprint into a ResolvedConfig with environment detection.
 
-### `pipe.sql`
+### `config.discover`
 
-SQL template tag for raw SQL expressions — pipe.sql\`NOW()\`.
+Walks up from cwd to find pipework.config.ts, imports it, and returns the Manifold.
 
-### `pipe.migrate`
+### `config.configSchema`
 
-Runs migrations for all configured databases.
+The zod schema for Blueprint validation — useful for custom config tooling.
 
-### `pipe.migrateOne`
+### `config.ConfigError`
 
-Runs migrations for a single named database.
+Thrown for configuration problems — includes a suggestion for how to fix.
 
 ## errors — Error Classes
 
@@ -341,438 +392,418 @@ Base error class with code, statusCode, and suggestion fields.
 
 409 — resource state conflict (duplicate, version mismatch).
 
-## fitting — Dependency Injection
+## lifecycle — Startup & Shutdown
 
-## fixture — REST Resources
+Application lifecycle namespace — startup orchestration with hooks and timeouts.
 
-REST resource builder namespace — declarative CRUD with cursor pagination and batch operations.
+### `lifecycle.orchestrate`
 
-### `fixture.register`
+Runs pre-start hooks (DB readiness checks, migrations, etc.) with a configurable timeout.
 
-Registers a Resource's routes on a Fastify instance.
+## log — Structured Logging
 
-### `fixture.build`
+Structured logger (Pino) — auto-binds requestId, tenantId, userId, sessionId from ALS context on every log call.
 
-Builds a Resource from a name, operations map, and builder state — used internally by fitting().fixture().
+### `log.create`
 
-### `fixture.encodeCursor`
+Creates a new PipeworkLogger instance with custom config (level, redaction, transport).
 
-Encodes pagination cursor values into an opaque base64 string.
+### `log.get`
 
-### `fixture.decodeCursor`
+Returns the context-aware logger proxy (same as the log export itself).
 
-Decodes an opaque pagination cursor back into its values.
+### `log.getBase`
 
-### `fixture.buildPage`
+Returns the raw Pino logger without ALS context binding.
 
-Builds a PageResult from rows, limit, and cursor extractor — handles hasMore detection.
+### `log.configure`
 
-### `fixture.validateBatch`
+Sets global logging config (level, redaction paths, custom context fields).
 
-Validates a batch request body (preview/execute mode, targets, actions).
+### `log.REDACT_PATHS`
 
-### `fixture.MethodNotAllowedError`
+Default redaction paths — password, secret, token, authorization, cookie, etc.
 
-Thrown when a resource doesn't support the requested HTTP method.
+## surface — Entry Points
 
-## flow — Context (AsyncLocalStorage)
+Surface namespace — declarative entry points that define how the app runs (HTTP server, background worker, one-shot script).
 
-AsyncLocalStorage context namespace — manages request/job/test contexts that carry auth, tenant, transactions.
+### `surface.http`
 
-### `flow.run`
+Creates an HTTP surface — a Fastify server with routes, middleware, and production validation. Returns an HttpSurfaceBuilder with a .test() method for inject()-based integration tests.
 
-Executes a function within a Flow context (AsyncLocalStorage). All pipe() calls inside will use this context.
+### `surface.worker`
 
-### `flow.require`
+Creates a worker surface — a long-running process that claims and executes jobs from queues.
 
-Returns the current Flow or throws — use in code that must run inside a managed context.
+### `surface.script`
 
-### `flow.get`
+Creates a script surface — a one-shot process that runs and exits (migrations, seeds, CLI tools).
 
-Returns the current Flow or undefined — use for optional context detection.
+## pipe — Database
 
-### `flow.createRequest`
+Database accessor — returns a Drizzle DB instance scoped to the current request/job/test context. Requires active AsyncLocalStorage context.
 
-Creates a Flow for an HTTP request with auth, tenant, and request metadata.
+### `pipe.filter`
 
-### `flow.createJob`
+Query operators and aggregates — eq, gt, lt, and, or, count, sum, etc.
 
-Creates a Flow for a background job with optional auth and tenant.
+### `pipe.migrate`
 
-### `flow.createTest`
+Runs migrations for all configured databases.
 
-Creates a Flow for test isolation with optional auth and tenant overrides.
+### `pipe.migrateOne`
 
-### `flow.verifyBinding`
+Runs migrations for a single named database.
 
-Defense-in-depth: verifies a transaction's nonce/tenant matches the current context.
+### `pipe.excluded`
 
-### `flow.bindTransaction`
+Returns excluded-column references for onConflictDoUpdate set clauses.
 
-Binds a Drizzle transaction to the current context with nonce fingerprinting.
+### `pipe.field`
 
-## http — Server
+Field builders for domain definitions — uuid(), text(), integer(), etc.
 
-HTTP server namespace — Fastify wrapper with automatic request IDs, CORS, rate limiting, and transaction-per-request.
+### `pipe.define`
 
-### `http.createServer`
+Registers a domain definition with table, validators, and factory projections.
 
-Creates a PipeworkServer (Fastify wrapper) with production validation, auto request IDs, and transaction management.
+### `pipe.definitions`
 
-### Types
+Returns the global registry of all domain definitions.
 
-**`CorsConfig`** — CORS configuration — origin, methods, headers, credentials, maxAge.
+## jsonb — JSONB Column Helpers
 
-```typescript
-interface CorsConfig
-```
+JSONB query operators — typed helpers for PostgreSQL JSONB containment and key checks.
 
-**`SecurityConfig`** — Security header configuration — passed to @fastify/helmet.
+### `jsonb.contains`
 
-```typescript
-interface SecurityConfig
-```
+The @> containment operator — tests whether a JSONB column contains the given value.
 
-**`RateLimitConfig`** — Rate limiting configuration — max requests, time window, key generator.
+### `jsonb.containedBy`
 
-```typescript
-interface RateLimitConfig
-```
+The <@ contained-by operator — tests whether a JSONB column is contained by the given value.
 
-**`InjectOptions`** — Options for server.inject() — method, url, headers, payload for testing without HTTP.
+### `jsonb.hasKey`
 
-```typescript
-interface InjectOptions
-```
+The ? key-existence operator — tests whether a JSONB column has the given top-level key.
 
-**`InjectResponse`** — Response from server.inject() — statusCode, headers, body, json() helper.
+## schema — Validation & Schema
 
-```typescript
-interface InjectResponse
-```
+Schema definition and validation namespace — wraps zod for validation, drizzle for table/column/index definitions.
 
-**`ServerConfig`** — Configuration for http.createServer() — CORS, security headers, rate limiting, transaction timeout.
+### `schema.check`
 
-```typescript
-interface ServerConfig
-```
+Validation sub-namespace — type constructors, combinators, formats, coerce, parse, tryParse, toJsonSchema, branded.
 
-**`HandlerResponse`** — Standard handler response shape — statusCode, headers, body.
+### `schema.col`
 
-```typescript
-interface HandlerResponse
-```
+Column type builders for table definitions — text, uuid, integer, timestamp, jsonb, boolean, varchar, etc.
 
-**`ErrorResponse`** — Standard error response shape — { error: { code, message }, statusCode }.
+### `schema.idx`
 
-```typescript
-interface ErrorResponse
-```
+Index and constraint builders — index, uniqueIndex, primaryKey, foreignKey, unique, check.
 
-**`PipeworkServer`** — Fastify server wrapper with route registration, handler auto-wiring, and inject() for testing.
+### Types
+
+**`Schema`** — Any validation schema — the base type accepted by .input(), .query(), .params() in the fitting builder.
 
 ```typescript
-interface PipeworkServer
-```
-
-**`HttpRequest`** — Fastify request with pipework extensions — req.id (UUID), typed headers.
-
-```typescript
-interface HttpRequest
+type Schema<T = unknown> = z.ZodType<T>
 ```
 
-**`HttpResponse`** — Fastify reply with pipework extensions.
+**`Infer`** — Extracts the TypeScript type from a Schema — Infer<typeof mySchema> gives you the validated type.
 
 ```typescript
-interface HttpResponse
+type Infer<T extends Schema> = z.infer<T>
 ```
 
-## jobs — Background Jobs
-
-Background job queue namespace — Postgres-backed with SKIP LOCKED, LISTEN/NOTIFY, cron scheduling.
-
-### `jobs.createQueue`
-
-Creates a job queue with claim/complete/fail lifecycle, heartbeat, and dead letter requeue.
-
-### `jobs.execute`
-
-Executes a fitting handler as a background job with its own Flow context.
-
-### `jobs.parseCron`
-
-Parses a 5-field cron expression into a CronSchedule (minute, hour, dom, month, dow).
-
-### `jobs.nextTick`
-
-Computes the next fire time for a CronSchedule after a given date, with optional timezone.
+## temporal — Bitemporal Data
 
-## lifecycle — Startup & Shutdown
+Temporal (bitemporal) data namespace — version history with effective date ranges.
 
-Application lifecycle namespace — startup orchestration with hooks and timeouts.
+### `temporal.columns`
 
-### `lifecycle.orchestrate`
+Returns the standard temporal column definitions (effectiveFrom, effectiveTo, version, createdBy) for table schemas.
 
-Runs pre-start hooks (DB readiness checks, migrations, etc.) with a configurable timeout.
+### `temporal.revise`
 
-## log — Structured Logging
+Creates a new version of a temporal record, closing the previous version's effectiveTo.
 
-Structured logger (Pino) — auto-binds requestId, tenantId, userId, sessionId from ALS context on every log call.
+### `temporal.close`
 
-### `log.create`
+Closes a temporal record by setting effectiveTo to now. Returns number of rows affected.
 
-Creates a new PipeworkLogger instance with custom config (level, redaction, transport).
+### `temporal.current`
 
-### `log.get`
+Fetches the currently-effective version of a temporal record (effectiveTo IS NULL).
 
-Returns the context-aware logger proxy (same as the log export itself).
+### `temporal.atTime`
 
-### `log.getBase`
+Returns a SQL condition for records effective at a specific point in time.
 
-Returns the raw Pino logger without ALS context binding.
+### `temporal.between`
 
-### `log.configure`
+Returns a SQL condition for records overlapping a date range.
 
-Sets global logging config (level, redaction paths, custom context fields).
+### `temporal.TemporalIntegrityError`
 
-### `log.REDACT_PATHS`
+Thrown when a temporal operation would violate version continuity.
 
-Default redaction paths — password, secret, token, authorization, cookie, etc.
+### `temporal.asOf`
 
-## openapi — API Documentation
+Query records effective at a specific date, using a domain definition with .effectiveDated() trait.
 
-OpenAPI spec generation namespace.
+### `temporal.allVersions`
 
-### `openapi.generate`
+Query all versions of temporal records (no date filter).
 
-Generates an OpenAPI 3.1 document from route registrations — schemas derived from fitting() input/output.
+### `temporal.effectiveUpdate`
 
-## pipeline — Multi-Step Pipelines
+Close the current version and create a new one with updated data.
 
-Multi-step pipeline namespace — define, execute, pause, and resume ordered step sequences.
+## vector — Vector & Full-Text Search
 
-### `pipeline.define`
+Vector and full-text search namespace — pgvector column types, similarity queries, and FTS operators.
 
-Defines a pipeline from a config of named steps with handlers. Returns a Pipeline with execute/resume/getStatus.
+### `vector.column`
 
-### `pipeline.PipelineStepError`
+Defines a vector(N) column for embeddings.
 
-Thrown when an individual pipeline step fails.
+### `vector.tsvector`
 
-### `pipeline.PipelineResumeError`
+Defines a tsvector column for full-text search.
 
-Thrown when resuming a pipeline from an invalid state.
+### `vector.cosine`
 
-## rbac — Access Control
+Cosine distance between a column and a query vector (lower = more similar).
 
-Role-based access control namespace — permission checking, enforcement, scope hierarchy.
+### `vector.cosineSimilarity`
 
-### `rbac.create`
+Cosine similarity (higher = more similar) — 1 - cosineDistance.
 
-Creates an Rbac instance from config (roles, permissions, hierarchy).
+### `vector.l2`
 
-### `rbac.check`
+L2 (Euclidean) distance between a column and a query vector.
 
-Checks if a permission set includes the required resource/action/scope. Pure function, no DB.
+### `vector.innerProduct`
 
-### `rbac.enforce`
+Inner product between a column and a query vector.
 
-Checks permission and throws ForbiddenError if denied. Loads permissions from DB with caching.
+### `vector.toTsvector`
 
-### `rbac.satisfies`
+Converts text to a tsvector for full-text indexing.
 
-Checks if a granted scope satisfies a required scope given a hierarchy (e.g. org > team > self).
+### `vector.toTsquery`
 
-### `rbac.PermissionCache`
+Converts a search query string to a tsquery using to_tsquery (supports operators like &, |, !).
 
-LRU cache for resolved permissions — avoids repeated DB lookups within a request.
+### `vector.plainToTsquery`
 
-## schema — Validation & Schema
+Converts natural language text to a tsquery using plainto_tsquery (no operator syntax required).
 
-Schema definition and validation namespace — wraps zod for validation, drizzle for table/column/index definitions.
+### `vector.matches`
 
-### `schema.check`
+The @@ match operator — tests whether a tsvector column matches a tsquery.
 
-Validation sub-namespace — type constructors, combinators, formats, coerce, parse, tryParse, toJsonSchema, branded.
+### `vector.headline`
 
-### `schema.col`
+Generates a ts_headline search snippet with highlighted matches.
 
-Column type builders for table definitions — text, uuid, integer, timestamp, jsonb, boolean, varchar, etc.
+### `vector.rank`
 
-### `schema.idx`
+Computes ts_rank for full-text search result ordering. Accepts a pre-built tsquery SQL or a raw query string.
 
-Index and constraint builders — index, uniqueIndex, primaryKey, foreignKey, unique, check.
+### `vector.validate`
 
-### Types
+Verifies the pgvector extension is installed and accessible.
 
-**`Schema`** — Any validation schema — the base type accepted by .input(), .query(), .params() in the fitting builder.
+## audit — Audit Logging
 
-```typescript
-type Schema<T = unknown> = z.ZodType<T>
-```
+Audit logging namespace — structured audit trail for data changes.
 
-**`Infer`** — Extracts the TypeScript type from a Schema — Infer<typeof mySchema> gives you the validated type.
+### `audit.create`
 
-```typescript
-type Infer<T extends Schema> = z.infer<T>
-```
+Creates an Audit instance that writes audit records to a Postgres table.
 
-## state
+## cache — Caching
 
-State machine namespace — define valid transitions with guards and side effects.
+In-memory caching namespace — TTL-based with stats, preload, and tenant-aware variants.
 
-### `state.define`
+### `cache.create`
 
-Defines a state machine from states, transitions, guards, and effects. Returns a StateMachine with transition/canTransition.
+Creates a single-key cache with TTL, a loader function, and invalidation.
 
-### `state.InvalidTransitionError`
+### `cache.createTenant`
 
-Thrown when a transition is not allowed from the current state.
+Creates a per-tenant cache — each tenant gets its own TTL and loader keyed by tenant ID.
 
-### `state.InvalidStateMachineError`
+## webhook — Inbound & Outbound Webhooks
 
-Thrown when the state machine definition is internally inconsistent.
+Webhook namespace — inbound verification, outbound delivery with retries, HMAC signing.
 
-## surface — Entry Points
+### `webhook.defineInbound`
 
-Surface namespace — declarative entry points that define how the app runs (HTTP server, background worker, one-shot script).
+Defines an inbound webhook handler with signature verification and optional idempotency.
 
-### `surface.http`
+### `webhook.createOutbound`
 
-Creates an HTTP surface — a Fastify server with routes, middleware, and production validation.
+Creates an outbound webhook system — endpoint registration, payload signing, delivery with retries.
 
-### `surface.worker`
+### `webhook.sign`
 
-Creates a worker surface — a long-running process that claims and executes jobs from queues.
+Signs a payload with HMAC for outbound delivery — returns body, signature, timestamp, messageId.
 
-### `surface.script`
+## behavior — Resource Decorators
 
-Creates a script surface — a one-shot process that runs and exits (migrations, seeds, CLI tools).
+Resource behavior decorators — compose versioning, audit trails, and cache invalidation onto CRUD operations.
 
-## temporal — Bitemporal Data
+### `behavior.compose`
 
-Temporal (bitemporal) data namespace — version history with effective date ranges.
+Applies multiple behaviors to a ResourceOperations set in order.
 
-### `temporal.columns`
+### `behavior.versioned`
 
-Returns the standard temporal column definitions (effectiveFrom, effectiveTo, version, createdBy) for table schemas.
+Adds optimistic concurrency control via a version column — rejects stale updates.
 
-### `temporal.revise`
+### `behavior.audited`
 
-Creates a new version of a temporal record, closing the previous version's effectiveTo.
+Wraps operations to emit audit records on create/update/delete.
 
-### `temporal.close`
+### `behavior.invalidate`
 
-Closes a temporal record by setting effectiveTo to now. Returns number of rows affected.
+Wraps operations to invalidate a cache on mutations. Returns ops with an attached .cache handle.
 
-### `temporal.current`
+## fitting — Dependency Injection
 
-Fetches the currently-effective version of a temporal record (effectiveTo IS NULL).
+## fixture — REST Resources
 
-### `temporal.atTime`
+REST resource builder namespace — declarative CRUD with cursor pagination and batch operations.
 
-Returns a SQL condition for records effective at a specific point in time.
+### `fixture.toHandlers`
 
-### `temporal.between`
+Converts a Resource into fitted Handler[] that go through the standard handler pipeline.
 
-Returns a SQL condition for records overlapping a date range.
+### `fixture.build`
 
-### `temporal.TemporalIntegrityError`
+Builds a Resource from a name, operations map, and builder state — used internally by fitting().fixture().
 
-Thrown when a temporal operation would violate version continuity.
+### `fixture.encodeCursor`
 
-## tenant — Multi-Tenancy
+Encodes pagination cursor values into an opaque base64 string.
 
-Multi-tenant isolation namespace — RLS policies, tenant extraction, Postgres-side verification.
+### `fixture.decodeCursor`
 
-### `tenant.validate`
+Decodes an opaque pagination cursor back into its values.
 
-Validates a tenant ID format (non-empty string, safe characters).
+### `fixture.buildPage`
 
-### `tenant.rls`
+Builds a PageResult from rows, limit, and cursor extractor — handles hasMore detection.
 
-Enables RLS on a table and creates the tenant isolation policy in Postgres.
+### `fixture.validateBatch`
 
-### `tenant.policy`
+Validates a batch request body (preview/execute mode, targets, actions).
 
-Returns the SQL string for a tenant isolation RLS policy — use in migrations.
+### `fixture.MethodNotAllowedError`
 
-### `tenant.verify`
+Thrown when a resource doesn't support the requested HTTP method.
 
-Cross-checks ALS tenant against Postgres set_config('pipework.tenant_id') — defense-in-depth.
+## flow — Context (AsyncLocalStorage)
 
-### `tenant.propagate`
+AsyncLocalStorage context namespace — manages request/job/test contexts that carry auth, tenant, transactions.
 
-Sets pipework.tenant_id on the Postgres connection via set_config().
+### `flow.run`
 
-### `tenant.extract`
+Executes a function within a Flow context (AsyncLocalStorage). All pipe() calls inside will use this context.
 
-Extracts tenant ID from auth context using the configured extraction strategy.
+### `flow.require`
 
-### `tenant.scoped`
+Returns the current Flow or throws — use in code that must run inside a managed context.
 
-Marks a table as tenant-scoped — pipe() will auto-filter by tenant_id.
+### `flow.get`
 
-### `tenant.isTenantScoped`
+Returns the current Flow or undefined — use for optional context detection.
 
-Returns true if a table has been marked as tenant-scoped.
+### `flow.createTest`
 
-## vector — Vector & Full-Text Search
+Creates a Flow for test isolation with optional auth and tenant overrides.
 
-Vector and full-text search namespace — pgvector column types and similarity/ranking queries.
+## http — Server
 
-### `vector.column`
+HTTP server namespace — managed by manifold.start(), not directly accessible.
 
-Defines a vector(N) column for embeddings.
+### Types
 
-### `vector.tsvector`
+**`CorsConfig`** — CORS configuration — origin, methods, headers, credentials, maxAge.
 
-Defines a tsvector column for full-text search.
+```typescript
+interface CorsConfig
+```
 
-### `vector.cosine`
+**`SecurityConfig`** — Security header configuration — passed to @fastify/helmet.
 
-Cosine distance between a column and a query vector (lower = more similar).
+```typescript
+interface SecurityConfig
+```
 
-### `vector.cosineSimilarity`
+**`RateLimitConfig`** — Rate limiting configuration — max requests, time window, key generator.
 
-Cosine similarity (higher = more similar) — 1 - cosineDistance.
+```typescript
+interface RateLimitConfig
+```
 
-### `vector.l2`
+**`InjectOptions`** — Options for server.inject() — method, url, headers, payload for testing without HTTP.
 
-L2 (Euclidean) distance between a column and a query vector.
+```typescript
+interface InjectOptions
+```
 
-### `vector.innerProduct`
+**`InjectResponse`** — Response from server.inject() — statusCode, headers, body, json() helper.
 
-Inner product between a column and a query vector.
+```typescript
+interface InjectResponse
+```
 
-### `vector.toTsvector`
+**`ServerConfig`** — Configuration for http.createServer() — CORS, security headers, rate limiting, transaction timeout.
 
-Converts text to a tsvector for full-text indexing.
+```typescript
+interface ServerConfig
+```
 
-### `vector.toTsquery`
+**`HandlerResponse`** — Standard handler response shape — statusCode, headers, body.
 
-Converts a search query string to a tsquery.
+```typescript
+interface HandlerResponse
+```
 
-### `vector.rank`
+**`ErrorResponse`** — Standard error response shape — { error: { code, message }, statusCode }.
 
-Computes ts_rank for full-text search result ordering.
+```typescript
+interface ErrorResponse
+```
 
-### `vector.validate`
+**`PipeworkServer`** — Fastify server wrapper with route registration, handler auto-wiring, and inject() for testing.
 
-Verifies the pgvector extension is installed and accessible.
+```typescript
+interface PipeworkServer
+```
 
-## webhook — Inbound & Outbound Webhooks
+**`HttpRequest`** — Fastify request with pipework extensions — req.id (UUID), typed headers.
 
-Webhook namespace — inbound verification, outbound delivery with retries, HMAC signing.
+```typescript
+interface HttpRequest
+```
 
-### `webhook.defineInbound`
+**`HttpResponse`** — Fastify reply with pipework extensions.
 
-Defines an inbound webhook handler with signature verification and optional idempotency.
+```typescript
+interface HttpResponse
+```
 
-### `webhook.createOutbound`
+## openapi — API Documentation
 
-Creates an outbound webhook system — endpoint registration, payload signing, delivery with retries.
+OpenAPI spec generation namespace.
 
-### `webhook.sign`
+### `openapi.generate`
 
-Signs a payload with HMAC for outbound delivery — returns body, signature, timestamp, messageId.
+Generates an OpenAPI 3.1 document from route registrations — schemas derived from fitting() input/output.