pipework 0.7.13 → 0.7.17

package/dist/REFERENCE.md

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