@classytic/arc 2.11.1 → 2.11.2

package/README.md

@@ -1,17 +1,31 @@
 # @classytic/arc
 
-Database-agnostic resource framework for Fastify. Define resources, get CRUD routes, permissions, presets, caching, events, OpenAPI, and MCP tools — without boilerplate.
+Database-agnostic resource framework for Fastify. One `defineResource()` call → REST + auth + permissions + events + caching + OpenAPI + MCP tools — without boilerplate.
 
-**v2.10** | Fastify 5+ | Node.js 22+ | ESM only
-
-## Install
+**v2.11** · Fastify 5+ · Node.js 22+ · ESM only
 
 ```bash
 npm install @classytic/arc fastify
-npm install @classytic/mongokit mongoose   # MongoDB adapter
+npm install @classytic/mongokit mongoose          # MongoDB (most common)
+# OR @classytic/sqlitekit drizzle-orm better-sqlite3 (sqlite)
+# OR bring your own: implement RepositoryLike from @classytic/repo-core
 ```
 
-## Quick Start
+---
+
+## Why arc
+
+| | |
+|---|---|
+| **One call, full REST** | `defineResource({ name, adapter, presets, permissions })` → `GET /`, `GET /:id`, `POST /`, `PATCH /:id`, `DELETE /:id` + custom routes + actions |
+| **DB-agnostic** | Mongoose, Prisma, Drizzle, or any `RepositoryLike` impl. Swap backends without rewriting routes. |
+| **Multi-tenant by default** | Tenant-field auto-injected, scope-aware queries, per-org cache keys, elevation events. |
+| **Tree-shakable subpaths** | `@classytic/arc/auth`, `/events`, `/cache`, `/mcp`, `/integrations/jobs` — pay only for what you import. |
+| **MCP tools, free** | Resources auto-generate Model Context Protocol tools for AI agents. Same permissions, same field rules. |
+
+---
+
+## Quick start
 
 ```typescript
 import mongoose from 'mongoose';
@@ -22,7 +36,7 @@ await mongoose.connect(process.env.DB_URI);
 const app = await createApp({
   preset: 'production',
   resourcePrefix: '/api/v1',
-  resources: await loadResources(import.meta.url),  // auto-discovers *.resource.ts
+  resources: await loadResources(import.meta.url),  // auto-discover *.resource.ts
   auth: { type: 'jwt', jwt: { secret: process.env.JWT_SECRET } },
   cors: { origin: process.env.ALLOWED_ORIGINS?.split(',') },
 });
@@ -30,182 +44,89 @@ const app = await createApp({
 await app.listen({ port: 8040, host: '0.0.0.0' });
 ```
 
-Three ways to register resources:
+Resources can be a static array, an async factory (engine-bound), or auto-discovered from disk:
 
 ```typescript
-// Auto-discover from directory (recommended)
-resources: await loadResources(import.meta.url),  // dev/prod parity
+// Auto-discover (recommended for >5 resources)
+resources: await loadResources(import.meta.url),
 
-// Explicit array
+// Explicit list
 resources: [productResource, orderResource],
 
-// Via plugins callback (full Fastify control)
-plugins: async (f) => { await f.register(productResource.toPlugin()); },
-```
-
-`loadResources()` discovers `default` exports, `export const resource`, OR any named export with `toPlugin()` (e.g. `export const userResource`). Per-resource opt-out of `resourcePrefix` via `skipGlobalPrefix: true` for webhooks/admin routes.
-
-> **Import compatibility:** Works with relative imports and Node.js `#` subpath imports. Does **not** support tsconfig path aliases (`@/*`, `~/`) — use explicit `resources: [...]` instead.
-
-## Boot Sequence
-
-```typescript
-const app = await createApp({
-  resourcePrefix: '/api/v1',
-  plugins: async (f) => { await connectDB(); },          // 1. infra (DB, docs)
-  bootstrap: [inventoryInit, accountingInit],             // 2. domain init
-  resources: await loadResources(import.meta.url),        // 3. routes
-  afterResources: async (f) => { subscribeEvents(f); },   // 4. post-wiring
-  onReady: async (f) => { logger.info('ready'); },
-});
+// Async factory — runs after `bootstrap[]`, before route wiring
+resources: async () => {
+  const [catalog, flow] = await Promise.all([ensureCatalogEngine(), ensureFlowEngine()]);
+  return loadResources(import.meta.url, { context: { catalog, flow } });
+},
 ```
 
-## Audit (per-resource opt-in)
-
-Clean DX without growing exclude lists:
-
-```typescript
-import { Repository, methodRegistryPlugin, batchOperationsPlugin } from '@classytic/mongokit';
-
-// app.ts — pass any RepositoryLike (mongokit / prismakit / custom)
-await fastify.register(auditPlugin, {
-  autoAudit: { perResource: true },
-  // batchOperationsPlugin enables deleteMany, required for purgeOlderThan()
-  repository: new Repository(AuditModel, [methodRegistryPlugin(), batchOperationsPlugin()]),
-  // or omit `repository` for in-memory dev
-});
-
-// order.resource.ts — opt in
-defineResource({ name: 'order', audit: true });
-
-// payment.resource.ts — only audit deletes
-defineResource({ name: 'payment', audit: { operations: ['delete'] } });
+`loadResources({ context })` (2.11.1+) threads engine handles into resources whose default export is `(ctx) => defineResource(...)`. No parallel factory files, no `exclude: [...]` bookkeeping.
 
-// Manual logging from MCP tools or custom routes
-app.post('/orders/:id/refund', async (req) => {
-  await app.audit.custom('order', req.params.id, 'refund', { reason }, { user });
-});
-```
+---
 
-## defineResource
-
-Single API for a full REST resource with routes, permissions, and behaviors:
+## Define a resource
 
 ```typescript
-import { defineResource, createMongooseAdapter, allowPublic, roles } from '@classytic/arc';
+import { defineResource, createMongooseAdapter } from '@classytic/arc';
+import { allowPublic, requireRoles, requireAuth } from '@classytic/arc/permissions';
+import { buildCrudSchemasFromModel } from '@classytic/mongokit';
+import ProductModel from './product.model.js';
+import productRepository from './product.repository.js';
 
-const productResource = defineResource({
+export default defineResource({
   name: 'product',
-  adapter: createMongooseAdapter({ model: ProductModel, repository: productRepo }),
-  presets: ['softDelete', 'slugLookup', { name: 'multiTenant', tenantField: 'orgId' }],
+  adapter: createMongooseAdapter({
+    model: ProductModel,
+    repository: productRepository,
+    schemaGenerator: buildCrudSchemasFromModel,    // auto-derives CRUD schemas
+  }),
+  presets: ['softDelete', 'slugLookup', { name: 'multiTenant', tenantField: 'organizationId' }],
   permissions: {
     list: allowPublic(),
     get: allowPublic(),
-    create: roles('admin', 'editor'),  // checks platform + org roles
-    update: roles('admin', 'editor'),
-    delete: roles('admin'),
+    create: requireRoles(['admin']),
+    update: requireRoles(['admin']),
+    delete: requireRoles(['admin']),
   },
-  cache: { staleTime: 30, gcTime: 300, tags: ['catalog'] }, // QueryCache (opt-in)
+  schemaOptions: {
+    fieldRules: {
+      name: { minLength: 2, maxLength: 200 },
+      sku: { pattern: '^[A-Z]{3}-\\d{3}$' },
+      status: { enum: ['draft', 'active', 'archived'] },
+      priceMode: { nullable: true },                          // accept null for round-trips
+      organizationId: { systemManaged: true, preserveForElevated: true },
+    },
+    query: {
+      allowedPopulate: ['category', 'createdBy'],             // populate whitelist
+      filterableFields: { status: { type: 'string' } },
+    },
+  },
+  cache: { staleTime: 30, gcTime: 300, tags: ['catalog'] },
   routes: [
     { method: 'GET', path: '/featured', handler: 'getFeatured', permissions: allowPublic() },
   ],
+  actions: {
+    approve: { handler: approveOrder, permissions: requireRoles(['admin']) },
+  },
 });
-
-// Auto-generates: GET /, GET /:id, POST /, PATCH /:id, DELETE /:id
-// Plus preset routes: GET /deleted, POST /:id/restore, GET /slug/:slug
-```
-
-**Custom primary key?** Use `idField` for resources keyed by UUIDs, slugs, or business identifiers:
-
-```typescript
-defineResource({
-  name: 'job',
-  adapter: createMongooseAdapter(JobModel, jobRepository),
-  idField: 'jobId',  // routes + BaseController lookups + OpenAPI + MCP tools all use this
-});
-// GET /jobs/job-5219f346-a4d  → 200 (no ObjectId pattern enforcement)
-```
-
-## Authentication
-
-Auth uses a discriminated union — pick a `type`:
-
-```typescript
-// Arc JWT
-auth: { type: 'jwt', jwt: { secret: process.env.JWT_SECRET, expiresIn: '15m' } }
-
-// Better Auth (recommended for SaaS with orgs)
-import { createBetterAuthAdapter } from '@classytic/arc/auth';
-auth: { type: 'betterAuth', betterAuth: createBetterAuthAdapter({ auth, orgContext: true }) }
-
-// Custom plugin
-auth: { type: 'custom', plugin: myAuthPlugin }
-
-// Custom function
-auth: { type: 'authenticator', authenticate: async (req, reply) => { ... } }
-
-// Disabled
-auth: false
-```
-
-**Decorates:** `app.authenticate`, `app.optionalAuthenticate`, `app.authorize`
-
-### Better Auth + Mongoose populate bridge
-
-When you back Better Auth with `@better-auth/mongo-adapter`, BA writes through the native `mongodb` driver and never registers anything with Mongoose. Any arc resource that does `Schema({ userId: { ref: 'user' } })` and calls `.populate('userId')` then throws `MissingSchemaError`.
-
-Optional helper at a dedicated subpath registers `strict: false` stub Mongoose models for BA's collections so populate works. Lives behind `@classytic/arc/auth/mongoose` so users on Prisma/Drizzle/Kysely never get Mongoose pulled into their bundle.
-
-```typescript
-import mongoose from 'mongoose';
-import { registerBetterAuthMongooseModels } from '@classytic/arc/auth/mongoose';
-
-// Default is core only — every plugin set is opt-in.
-registerBetterAuthMongooseModels(mongoose, {
-  plugins: ['organization', 'organization-teams'],
-  // For separate @better-auth/* packages:
-  extraCollections: ['passkey', 'ssoProvider'],
-});
-
-// Now arc resources can populate BA-owned references:
-const Post = mongoose.model('Post', new mongoose.Schema({
-  title: String,
-  authorId: { type: String, ref: 'user' },
-}));
-await Post.findOne().populate('authorId');
 ```
 
-Supports `usePlural` (matches `mongodbAdapter({ usePlural: true })`) and `modelOverrides` (for custom `user: { modelName: 'profile' }` configs). Idempotent and de-dupes overlapping plugin sets.
-
-### Token Revocation
-
-Arc provides the `isRevoked` primitive — you implement the store (Redis, DB, Better Auth):
-
-```typescript
-auth: {
-  type: 'jwt',
-  jwt: { secret: process.env.JWT_SECRET },
-  isRevoked: async (decoded) => {
-    // Redis set, DB lookup, or any async check
-    return await redis.sismember('revoked-tokens', decoded.jti ?? decoded.id);
-  },
-}
-```
+Auto-generates: `GET /products`, `GET /products/:id`, `POST /products`, `PATCH /products/:id`, `DELETE /products/:id` + softDelete adds `GET /products/deleted`, `POST /products/:id/restore` + slugLookup adds `GET /products/by-slug/:slug` + custom routes + `POST /products/:id/action`.
 
-Fail-closed: if the revocation check throws, the token is rejected.
+---
 
 ## Permissions
 
-Function-based, composable:
+Function-based — RBAC, ABAC, ReBAC, or any combination.
 
 ```typescript
 import {
   allowPublic, requireAuth, requireRoles, requireOwnership,
   requireOrgMembership, requireOrgRole, requireServiceScope,
-  requireScopeContext,
-  allOf, anyOf, denyAll,
+  requireScopeContext, requireOrgInScope,
+  allOf, anyOf, when, denyAll,
   createDynamicPermissionMatrix,
-} from '@classytic/arc';
+} from '@classytic/arc/permissions';
 
 permissions: {
   list: allowPublic(),
@@ -213,567 +134,122 @@ permissions: {
   create: requireRoles(['admin', 'editor']),
   update: anyOf(requireOwnership('userId'), requireRoles(['admin'])),
   delete: allOf(requireAuth(), requireRoles(['admin'])),
-
-  // Mixed human + machine routes — accept org admins OR API keys
-  bulkImport: anyOf(
-    requireOrgRole('admin'),                    // human path
-    requireServiceScope('jobs:bulk-write'),     // machine path (OAuth-style)
-  ),
-
-  // Multi-level tenancy — branch/project/region scoped routes
-  branchAdmin: allOf(requireOrgRole('admin'), requireScopeContext('branchId')),
-  euOnly:      requireScopeContext('region', 'eu'),
-  projectEdit: requireScopeContext({ projectId: 'p-1', region: 'eu' }),
-
-  // Parent-child org hierarchy (holding → subsidiary → branch, MSP, white-label)
-  // Reads scope.ancestorOrgIds (loaded by your auth function from your own org table)
-  childOrgAccess: requireOrgInScope((ctx) => ctx.request.params.orgId),
 }
 ```
 
-`requireRoles()` checks platform roles (`user.role`) AND org roles
-(`scope.orgRoles`) by default — same call works for arc JWT, Better Auth user
-roles, and Better Auth org plugin. `requireOrgMembership()` accepts `member`,
-`service` (API key), and `elevated` scopes; `multiTenantPreset` filters by
-org for all three. For machine identities, `requireServiceScope('jobs:write')`
-mirrors OAuth 2.0 scope strings. For app-defined dimensions beyond org/team
-(branch, project, region, workspace), `requireScopeContext('branchId')`
-reads from `scope.context` populated by your auth function. For parent-child
-org hierarchies (holding → subsidiary, MSP → tenants, white-label),
-`requireOrgInScope((ctx) => ctx.request.params.orgId)` accepts the current
-org or any ancestor in `scope.ancestorOrgIds`.
-
-**Multi-level tenant filtering** — the `multiTenantPreset` scales from
-single-org isolation to lockstep filtering across any number of dimensions:
+Custom checks return `{ granted, reason?, filters?, scope? }` — `filters` propagate into the repo query (row-level ABAC), `scope` stamps attributes downstream.
 
-```typescript
-import { multiTenantPreset } from '@classytic/arc/presets';
-
-// Single-field (default, backwards compatible)
-multiTenantPreset({ tenantField: 'organizationId' })
-
-// Multi-field — org + branch + project, all enforced in lockstep
-multiTenantPreset({
-  tenantFields: [
-    { field: 'organizationId', type: 'org' },                // → getOrgId(scope)
-    { field: 'teamId',         type: 'team' },               // → getTeamId(scope)
-    { field: 'branchId',       contextKey: 'branchId' },     // → scope.context.branchId
-    { field: 'projectId',      contextKey: 'projectId' },
-  ],
-})
-```
-
-Fail-closed semantics: if any required dimension is missing from the caller's
-scope, list/get/update/delete return 403 with the specific missing field name,
-and create is rejected. Elevated scopes apply whatever resolves and skip the
-rest (cross-context admin bypass). Your auth function populates
-`scope.context` from JWT claims, BA session fields, or request headers — arc
-takes no position on which dimension names you use.
-
-**Field-level permissions:**
-
-```typescript
-import { fields } from '@classytic/arc';
-
-fields: {
-  password: fields.hidden(),
-  salary: fields.visibleTo(['admin', 'hr']),
-  role: fields.writableBy(['admin']),
-  email: fields.redactFor(['viewer'], '***'),
-}
-```
-
-**Dynamic ACL (DB-managed):**
-
-```typescript
-const acl = createDynamicPermissionMatrix({
-  resolveRolePermissions: async (ctx) => aclService.getRoleMatrix(orgId),
-  cacheStore: new RedisCacheStore({ client: redis, prefix: 'acl:' }),
-});
+---
 
-permissions: {
-  list: acl.canAction('product', 'read'),
-  create: acl.canAction('product', 'create'),
-}
-```
-
-## Presets
-
-Composable resource behaviors:
-
-| Preset | Effect | Config |
-|--------|--------|--------|
-| `softDelete` | `GET /deleted`, `POST /:id/restore`, `deletedAt` field | `{ deletedField }` |
-| `slugLookup` | `GET /slug/:slug` | `{ slugField }` |
-| `tree` | `GET /tree`, `GET /:parent/children` | `{ parentField }` |
-| `ownedByUser` | Auto-checks `createdBy` on update/delete | `{ ownerField }` |
-| `multiTenant` | Auto-filters all queries by tenant | `{ tenantField }` |
-| `audited` | Sets `createdBy`/`updatedBy` from user | — |
-
-```typescript
-presets: ['softDelete', { name: 'multiTenant', tenantField: 'organizationId' }]
-```
-
-## QueryCache
-
-TanStack Query-inspired server cache with stale-while-revalidate and auto-invalidation:
-
-```typescript
-// Enable globally
-const app = await createApp({
-  arcPlugins: { queryCache: true },  // Memory store by default
-});
-
-// Per-resource config
-defineResource({
-  name: 'product',
-  cache: {
-    staleTime: 30,    // seconds fresh
-    gcTime: 300,      // seconds stale data kept (SWR window)
-    tags: ['catalog'],
-    invalidateOn: { 'category.*': ['catalog'] }, // cross-resource
-  },
-});
-```
-
-**How it works:**
-- `GET` requests: cached with `x-cache: HIT | STALE | MISS` header
-- `POST/PATCH/DELETE`: auto-bumps resource version, invalidating all cached queries
-- Cross-resource: category mutation bumps `catalog` tag, invalidates product cache
-- Multi-tenant safe: cache keys scoped by userId + orgId
-
-**Runtime modes:**
-
-| Mode | Store | Config |
-|------|-------|--------|
-| `memory` (default) | `MemoryCacheStore` (50 MiB budget) | Zero config |
-| `distributed` | `RedisCacheStore` | `stores: { queryCache: new RedisCacheStore({ client: redis }) }` |
-
-## BaseController
-
-Override only what you need:
-
-```typescript
-import { BaseController } from '@classytic/arc';
-import type { IRequestContext, IControllerResponse } from '@classytic/arc';
-
-class ProductController extends BaseController<Product> {
-  constructor() { super(productRepo); }
-
-  async getFeatured(req: IRequestContext): Promise<IControllerResponse> {
-    const products = await this.repository.getAll({ filters: { isFeatured: true } });
-    return { success: true, data: products };
-  }
-}
-```
-
-## Events
-
-Domain event pub/sub with pluggable transports. The factory auto-registers `eventPlugin` — no manual setup needed:
-
-```typescript
-// createApp() registers eventPlugin automatically (default: MemoryEventTransport)
-// Transport is sourced from stores.events if provided
-const app = await createApp({
-  stores: { events: new RedisEventTransport(redis) },  // optional, defaults to memory
-  arcPlugins: {
-    events: {                     // event plugin config (default: true)
-      logEvents: true,
-      retry: { maxRetries: 3, backoffMs: 1000 },
-    },
-  },
-});
-
-await app.events.publish('order.created', { orderId: '123' });
-await app.events.subscribe('order.*', async (event) => { ... });
-```
-
-CRUD events (`product.created`, `product.updated`, `product.deleted`) emit automatically.
-
-### Causation Chains & DLQ (v2.9)
-
-```typescript
-import { createEvent, createChildEvent, type DeadLetteredEvent } from '@classytic/arc/events';
-
-const placed = createEvent('order.placed', { orderId: 'o1' }, {
-  correlationId: req.id, userId: user.id,
-});
-await app.events.publish(placed.type, placed.payload, placed.meta);
-
-// Downstream handler emits a child — correlation inherited, causation linked:
-const reserved = createChildEvent(placed, 'inventory.reserved', { sku: 'a' });
-// reserved.meta.correlationId === placed.meta.correlationId (stays stable across chain)
-// reserved.meta.causationId   === placed.meta.id            (direct parent)
-
-// Transports with native DLQ (Kafka, SQS) implement optional deadLetter():
-class KafkaTransport implements EventTransport {
-  async deadLetter(dlq: DeadLetteredEvent) { /* route to .DLQ topic */ }
-}
-```
-
-`EventMeta` also accepts `schemaVersion` (evolve event payloads) and `partitionKey` (ordered delivery hint for Kafka/Kinesis).
-
-### defineEvent — Typed Events with Schema Validation
-
-Declare events with schemas for runtime validation and introspection:
-
-```typescript
-import { defineEvent, createEventRegistry } from '@classytic/arc/events';
-
-// Define typed events
-const OrderCreated = defineEvent({
-  name: 'order.created',
-  version: 1,
-  description: 'Emitted when an order is placed',
-  schema: {
-    type: 'object',
-    properties: {
-      orderId: { type: 'string' },
-      total: { type: 'number' },
-      currency: { type: 'string' },
-    },
-    required: ['orderId', 'total'],
-  },
-});
-
-// Type-safe event creation
-const event = OrderCreated.create({ orderId: 'o-1', total: 100 }, { userId: 'user-1' });
-await app.events.publish(event.type, event.payload, event.meta);
-```
-
-**Event Registry** — catalog + auto-validation on publish:
-
-```typescript
-const registry = createEventRegistry();
-registry.register(OrderCreated);
-registry.register(OrderShipped);
-
-// Wire into eventPlugin — validates payloads on publish
-const app = await createApp({
-  arcPlugins: {
-    events: { registry, validateMode: 'warn' },
-    // 'warn' (default): log warning, still publish
-    // 'reject': throw error, do NOT publish
-    // 'off': registry is introspection-only
-  },
-});
-
-// Introspect at runtime
-app.events.registry?.catalog();
-// → [{ name: 'order.created', version: 1, schema: {...} }, ...]
-```
-
-Export the registry alongside resources for `arc describe` to auto-detect:
-
-```typescript
-// src/events.ts
-export const eventRegistry = createEventRegistry();
-eventRegistry.register(OrderCreated);
-eventRegistry.register(OrderShipped);
-```
-
-### Event Transports
+## Authentication
 
-| Transport | Import | Use Case |
-|-----------|--------|----------|
-| `MemoryEventTransport` | `@classytic/arc/events` | Development, testing, single-instance |
-| `RedisEventTransport` | `@classytic/arc/events/redis` | Multi-instance pub/sub (fan-out) |
-| `RedisStreamTransport` | `@classytic/arc/events/redis-stream` | Ordered events with consumer groups |
+Discriminated union on `type`:
 
 ```typescript
-// Redis Pub/Sub
-import { RedisEventTransport } from '@classytic/arc/events/redis';
-const transport = new RedisEventTransport(redis, { channel: 'arc-events' });
+// JWT (with optional revocation + custom token extractor)
+auth: { type: 'jwt', jwt: { secret, expiresIn: '15m' } }
 
-// Redis Streams (ordered, durable)
-import { RedisStreamTransport } from '@classytic/arc/events/redis-stream';
-const transport = new RedisStreamTransport(redis, { stream: 'arc-events' });
-```
-
-**Behavioral contract:**
-- **Memory**: Handlers execute sequentially (ordered, awaited)
-- **Redis Pub/Sub**: Handlers fire-and-forget (unordered, fan-out)
-- **Redis Streams**: Ordered delivery with consumer group acknowledgment
-
-### Retry & Dead Letter Queue
-
-```typescript
-import { withRetry, createDeadLetterPublisher } from '@classytic/arc/events';
-
-// Per-handler retry with exponential backoff
-await app.events.subscribe('order.created', withRetry(
-  async (event) => { await sendConfirmationEmail(event.payload); },
-  {
-    maxRetries: 3,
-    backoffMs: 1000,
-    onDead: createDeadLetterPublisher(app.events), // publishes to $deadLetter channel
-  },
-));
-
-// Or configure auto-retry for ALL handlers via plugin
-const app = await createApp({
-  arcPlugins: {
-    events: {
-      retry: { maxRetries: 3, backoffMs: 1000 },
-      deadLetterQueue: { store: async (event, errors) => { /* custom DLQ */ } },
-    },
-  },
-});
-```
+// Better Auth (recommended for SaaS with orgs)
+import { createBetterAuthAdapter } from '@classytic/arc/auth';
+auth: { type: 'betterAuth', betterAuth: createBetterAuthAdapter({ auth: getAuth(), orgContext: true }) }
 
-## Factory — createApp()
+// Custom Fastify plugin
+auth: { type: 'custom', plugin: myAuthPlugin }
 
-```typescript
-const app = await createApp({
-  preset: 'production',           // production | development | testing | edge
-  runtime: 'memory',             // memory (default) | distributed (requires Redis)
-  auth: { type: 'jwt', jwt: { secret } },
-  cors: { origin: ['https://myapp.com'] },
-  helmet: true,                   // false to disable
-  rateLimit: { max: 100 },        // false to disable
-  arcPlugins: {
-    events: true,                 // event plugin (default: true, false to disable)
-    emitEvents: true,             // CRUD event emission (default: true)
-    queryCache: true,             // server cache (default: false)
-    sse: true,                    // server-sent events (default: false)
-    caching: true,                // ETag + Cache-Control (default: false)
-  },
-  stores: {                       // required when runtime: 'distributed'
-    events: new RedisEventTransport({ client: redis }),
-    cache: new RedisCacheStore({ client: redis }),
-    queryCache: new RedisCacheStore({ client: redis, prefix: 'arc:qc:' }),
-  },
-});
+// Disabled (e.g. internal services)
+auth: false
 ```
 
-**Arc plugins defaults:**
+Better Auth + Mongoose `populate()`: import `registerBetterAuthMongooseModels` from `@classytic/arc/auth/mongoose` to register `strict: false` stub models for BA collections. Subpath gate keeps Mongoose out of Prisma/Drizzle bundles.
 
-| Plugin | Default | Status |
-|--------|---------|--------|
-| `events` | `true` | opt-out — registers `eventPlugin` (provides `fastify.events`) |
-| `emitEvents` | `true` | opt-out — CRUD operations emit domain events |
-| `requestId` | `true` | opt-out |
-| `health` | `true` | opt-out |
-| `gracefulShutdown` | `true` | opt-out |
-| `caching` | `false` | opt-in — ETag + Cache-Control headers |
-| `queryCache` | `false` | opt-in — TanStack Query-inspired server cache |
-| `sse` | `false` | opt-in — Server-Sent Events streaming |
+---
 
-| Preset | Logging | Rate Limit | Security |
-|--------|---------|------------|----------|
-| production | info | 100/min | full |
-| development | debug | 1000/min | relaxed |
-| testing | silent | disabled | minimal |
-| edge | warn | disabled | none (API GW handles) |
+## Subpath imports
 
-## Real-Time
+Tree-shake by importing only the subpath you need:
 
-SSE and WebSocket with fail-closed auth (throws at registration if auth missing):
+| Subpath | Purpose |
+|---|---|
+| `@classytic/arc` | `defineResource`, `BaseController`, `createMongooseAdapter`, error classes |
+| `@classytic/arc/factory` | `createApp`, `loadResources`, presets |
+| `@classytic/arc/auth` | JWT + Better Auth adapters |
+| `@classytic/arc/auth/mongoose` | Better Auth Mongoose stub models (opt-in) |
+| `@classytic/arc/permissions` | All permission helpers |
+| `@classytic/arc/scope` | `RequestScope` accessors (`isMember`, `isElevated`, `getOrgId`, …) |
+| `@classytic/arc/cache` | `QueryCache`, transports, plugin |
+| `@classytic/arc/events` | Event plugin, transports, outbox |
+| `@classytic/arc/events/redis` · `/redis-stream` | Redis Pub/Sub + Streams transports (opt-in) |
+| `@classytic/arc/plugins` | Health, request-id, versioning, tracing, response-cache |
+| `@classytic/arc/integrations/jobs` | BullMQ job dispatcher |
+| `@classytic/arc/integrations/websocket` | WebSocket integration |
+| `@classytic/arc/mcp` | Model Context Protocol tools |
+| `@classytic/arc/testing` | `createTestApp`, `expectArc`, `TestAuthProvider`, `createTestFixtures` |
+| `@classytic/arc/types` | Type-only barrel (zero runtime cost) |
+
+---
+
+## Testing
 
 ```typescript
-// SSE — via factory
-const app = await createApp({
-  arcPlugins: { sse: { path: '/events', requireAuth: true, orgScoped: true } },
-});
+import { createTestApp, expectArc } from '@classytic/arc/testing';
+import productResource from './product.resource.js';
 
-// WebSocket — separate plugin
-import { websocketPlugin } from '@classytic/arc/integrations/websocket';
-await app.register(websocketPlugin, {
-  auth: true,                       // fail-closed: throws if authenticate not registered
-  resources: ['product', 'order'],
-  roomPolicy: (client, room) => ['product', 'order'].includes(room),
-  reauthInterval: 300000,           // re-validate token every 5 min (0 = disabled)
-  maxMessageBytes: 16384,           // 16KB message size cap
-  maxSubscriptionsPerClient: 100,   // prevent resource exhaustion
+const ctx = await createTestApp({
+  resources: [productResource],
+  authMode: 'jwt',
+  connectMongoose: true,           // in-memory Mongo + Mongoose connect
 });
+ctx.auth.register('admin', { user: { id: '1', roles: ['admin'] }, orgId: 'org-1' });
 
-// EventGateway — unified SSE + WebSocket with shared config
-import { eventGatewayPlugin } from '@classytic/arc/integrations/event-gateway';
-await app.register(eventGatewayPlugin, {
-  auth: true, orgScoped: true,
-  roomPolicy: (client, room) => allowedRooms.includes(room),
-  sse: { path: '/api/events', patterns: ['order.*'] },
-  ws: { path: '/ws', resources: ['product', 'order'] },
-});
-```
-
-## Pipeline — Guards, Transforms, Interceptors
-
-Functional composition for cross-cutting concerns:
-
-```typescript
-import { pipe, guard, transform, intercept } from '@classytic/arc/pipeline';
-
-const isActive = guard('isActive', (ctx) => ctx.query?.filters?.isActive !== false);
-const slugify = transform('slugify', (ctx) => ({ ...ctx, body: { ...ctx.body, slug: toSlug(ctx.body.name) } }));
-const timing = intercept('timing', async (ctx, next) => {
-  const start = Date.now();
-  const result = await next();
-  console.log(`${ctx.resource}.${ctx.operation}: ${Date.now() - start}ms`);
-  return result;
-});
-
-defineResource({
-  name: 'product',
-  pipe: pipe(isActive, slugify, timing),
-  // or per-operation: pipe: { create: pipe(slugify), list: pipe(timing) }
+const res = await ctx.app.inject({
+  method: 'POST',
+  url: '/products',
+  headers: ctx.auth.as('admin').headers,
+  payload: { name: 'Widget' },
 });
-```
-
-## Utilities
+expectArc(res).ok().hidesField('password');
 
-```typescript
-// Circuit Breaker — fault tolerance for external service calls
-import { createCircuitBreaker } from '@classytic/arc/utils';
-const paymentBreaker = createCircuitBreaker(
-  async (amount) => stripe.charges.create({ amount }),
-  { name: 'stripe', failureThreshold: 5, resetTimeout: 30000, fallback: async () => cached },
-);
-
-// State Machine — workflow validation
-import { createStateMachine } from '@classytic/arc/utils';
-const orderState = createStateMachine('Order', {
-  approve: ['pending', 'draft'],
-  cancel: ['pending', 'approved'],
-  fulfill: { from: ['approved'], to: 'fulfilled', guard: ({ data }) => data.paid },
-});
-orderState.assert('approve', currentStatus); // throws if invalid transition
+await ctx.close();
 ```
 
-## Integrations
-
-All separate subpath imports — only loaded when used:
-
-```typescript
-// Job Queue (BullMQ)
-import { jobsPlugin, defineJob } from '@classytic/arc/integrations/jobs';
-
-// WebSocket (room-based, CRUD auto-broadcast)
-import { websocketPlugin } from '@classytic/arc/integrations/websocket';
-
-// EventGateway (unified SSE + WebSocket)
-import { eventGatewayPlugin } from '@classytic/arc/integrations/event-gateway';
-
-// Streamline Workflows
-import { streamlinePlugin } from '@classytic/arc/integrations/streamline';
-
-// Audit Trail
-import { auditPlugin } from '@classytic/arc/audit';
+Three entry points: `createTestApp` (custom scenarios), `createHttpTestHarness` (~16 auto-generated CRUD/permission/validation tests per resource), `runStorageContract` (adapter conformance).
 
-// Idempotency (exactly-once mutations)
-import { idempotencyPlugin } from '@classytic/arc/idempotency';
-
-// OpenTelemetry Tracing
-import { tracingPlugin } from '@classytic/arc/plugins/tracing';
-```
+---
 
 ## CLI
 
 ```bash
-npx @classytic/arc init my-api --mongokit --better-auth --ts   # Scaffold project
-npx @classytic/arc generate resource product                    # Generate resource files
-npx @classytic/arc describe ./dist/index.js                     # Resource metadata (JSON)
-npx @classytic/arc docs ./openapi.json --entry ./dist/index.js  # Export OpenAPI
-npx @classytic/arc introspect --entry ./dist/index.js           # Show resources
-npx @classytic/arc doctor                                        # Health check
+arc init my-api --mongokit --better-auth --ts    # scaffold a new project
+arc generate resource product                    # generate a resource
+arc generate resource product --mcp              # + MCP tools file
+arc docs ./openapi.json --entry ./dist/index.js  # emit OpenAPI
+arc introspect --entry ./dist/index.js           # introspect resources
+arc doctor                                       # diagnose env
 ```
 
-`arc describe` auto-detects exported `EventRegistry` and includes the event catalog in output:
+---
 
-```json
-{
-  "$schema": "arc-describe/v1",
-  "resources": [...],
-  "eventCatalog": [
-    { "name": "order.created", "version": 1, "hasSchema": true, "schemaFields": ["orderId", "total"], "requiredFields": ["orderId", "total"] }
-  ],
-  "stats": { "totalResources": 5, "totalRoutes": 28, "totalCatalogedEvents": 3 }
-}
-```
-
-## Bundle Size
-
-Arc is tree-shakable and split into 47 subpath exports. You pay only for what you import.
+## Highlights from recent releases
 
-| What you import | JS shipped to your bundle |
+| Version | Headline |
 |---|---|
-| `createApp` + `defineResource` + `BaseController` (minimal CRUD API) | **~130 KB** |
-| `+ @classytic/arc/events/redis` (distributed pub/sub) | +24 KB |
-| `+ @classytic/arc/integrations/jobs` (BullMQ) | +8 KB |
-| `+ @classytic/arc/mcp` (AI agent tools) | +24 KB |
+| **2.11.2** | `RouteSchemaOptions['query']` types `allowedPopulate` + `allowedLookups` |
+| **2.11.1** | `loadResources({ context })` + factory exports; `ActionDefinition.schema` widened to `unknown`; `silent` removed in favor of `arcLog` fallback |
+| **2.11.0** | `BaseController` mixin split, testing surface rewrite (`createTestApp`, `TestAuthProvider`, `expectArc`), action-router parity, async resources factory |
+| **2.10** | Permissions split, `RepositoryLike` plugs into outbox/audit/idempotency, plugin onSend race fix |
 
-For reference — Fastify core alone is ~300 KB, NestJS core + reflect-metadata is 400+ KB. Arc's minimal footprint is smaller than either, with more features included. `dist/` on disk is 1.7 MB but most of it is `.d.mts` type declarations (free at runtime), the CLI (88 KB, only loaded when running `npx @classytic/arc init`), and the testing helpers (52 KB, never shipped to production).
-
-**Use subpath imports** — they're the whole reason arc stays lean:
-
-```typescript
-// Good — each import resolves to exactly one subpath chunk
-import { createApp } from '@classytic/arc/factory';
-import { defineResource } from '@classytic/arc/core';
-import { jobsPlugin } from '@classytic/arc/integrations/jobs';   // only if you use queues
-import { mcpPlugin } from '@classytic/arc/mcp';                    // only if you expose MCP
-
-// Bad — pulls the whole barrel; tree-shaking helps but subpath is better
-import { createApp, defineResource, jobsPlugin, mcpPlugin } from '@classytic/arc';
-```
-
-Arc sets `"sideEffects": false` in [package.json](package.json), so modern bundlers (esbuild, Rollup, Webpack 5+, tsdown) correctly eliminate unused exports even from the barrel.
-
-## Subpath Imports
-
-| Import | Purpose |
-|--------|---------|
-| `@classytic/arc` | Core: `defineResource`, `BaseController`, permissions, errors |
-| `@classytic/arc/factory` | `createApp()`, presets |
-| `@classytic/arc/cache` | `MemoryCacheStore`, `RedisCacheStore`, `QueryCache` |
-| `@classytic/arc/auth` | Auth plugin, Better Auth adapter, session manager |
-| `@classytic/arc/events` | Event plugin, transports, `defineEvent`, `createEventRegistry` |
-| `@classytic/arc/events/redis` | Redis Pub/Sub event transport |
-| `@classytic/arc/events/redis-stream` | Redis Streams event transport |
-| `@classytic/arc/plugins` | Health, graceful shutdown, request ID, SSE, caching |
-| `@classytic/arc/plugins/tracing` | OpenTelemetry |
-| `@classytic/arc/permissions` | All permission functions, role hierarchy |
-| `@classytic/arc/scope` | Request scope helpers (`isMember`, `isElevated`, `getOrgId`) |
-| `@classytic/arc/org` | Organization module |
-| `@classytic/arc/hooks` | Lifecycle hooks |
-| `@classytic/arc/presets` | Preset functions + interfaces |
-| `@classytic/arc/audit` | Audit trail |
-| `@classytic/arc/idempotency` | Idempotency |
-| `@classytic/arc/schemas` | TypeBox helpers |
-| `@classytic/arc/utils` | Errors, circuit breaker, state machine, query parser |
-| `@classytic/arc/testing` | Test utilities, mocks, in-memory DB |
-| `@classytic/arc/migrations` | Schema migrations |
-| `@classytic/arc/integrations/jobs` | BullMQ job queue |
-| `@classytic/arc/integrations/websocket` | WebSocket |
-| `@classytic/arc/integrations/event-gateway` | Unified SSE + WebSocket gateway |
-| `@classytic/arc/integrations/streamline` | Workflow orchestration |
-| `@classytic/arc/mcp` | MCP tools for AI agents |
-| `@classytic/arc/docs` | OpenAPI generation |
-| `@classytic/arc/cli` | CLI commands (programmatic) |
-
-## Type imports
-
-Arc owns framework types (`IController`, `IRequestContext`, `ResourceConfig`, `RepositoryLike`, `PaginationResult`). The repository contract lives in `@classytic/repo-core` — import those types directly:
-
-```typescript
-// Arc framework types
-import type { IRequestContext, RepositoryLike, PaginationResult } from '@classytic/arc';
-
-// Repository contract (repo-core is the single source of truth)
-import type { StandardRepo, WriteOptions, QueryOptions } from '@classytic/repo-core/repository';
-import type { OffsetPaginationResult } from '@classytic/repo-core/pagination';
-```
+Full history: [`/changelog/v2.md`](changelog/v2.md).
 
-> Arc 2.10 dropped the legacy `CrudRepository`, `PaginatedResult`, and pass-through `WriteOptions`/`QueryOptions` re-exports. See [CHANGELOG.md](CHANGELOG.md#210) for the migration table.
+---
 
-## v2.10 Highlights
+## Documentation
 
-- **Clean-break on repo-core types** — `CrudRepository` / `PaginatedResult` / pass-through repo options removed from arc's public surface. Import `StandardRepo`, `OffsetPaginationResult`, etc. directly from `@classytic/repo-core`. See [CHANGELOG.md](CHANGELOG.md) for the rewrite table.
-- **Outbox bugfix** — `repositoryAsOutboxStore.fail()` now passes `updatePipeline: true` to `findOneAndUpdate`, so retry / DLQ transitions work on mongokit ≥3.10.
-- **Plugin requirements documented** — audit / outbox / idempotency require mongokit's `methodRegistryPlugin` + `batchOperationsPlugin` for `deleteMany`; README snippets + production-ops docs now show the correct chain.
-- **Removed** — `@classytic/arc/policies` (use `permissions/`), `@classytic/arc/rpc`, `@classytic/arc/dynamic` (use `factory/loadResources`).
+- **Skill** for AI agents: `npx skills add classytic/arc` — wires arc into Claude Code / agentic flows.
+- **Concept reference**: [wiki/index.md](wiki/index.md) — short, interlinked pages.
+- **Guides**: [docs/](docs/) — getting-started, framework-extension, production-ops, testing, ecosystem.
+- **Release notes**: [changelog/v2.md](changelog/v2.md).
 
-See [CHANGELOG.md](CHANGELOG.md) for the full v2.9 / v2.8 / v2.7 history.
+---
 
 ## License