API Reference

Complete reference for @outerjs/server — the Outer constructor, every builder method and its config, the schema() builder, and the built server.

new Outer(params)

import { Outer } from "@outerjs/server";
import { pglite } from "@outerjs/server/pglite";

const outer = new Outer({
  name: "My App",
  baseUrl: "https://api.example.com",
  db: pglite(),
  cors: { origins: ["https://app.example.com"], credentials: true },
});

CorsConfig

pglite(config?)

Embedded, zero-infra Postgres from @outerjs/server/pglite. Returns a { dialect, kind: "postgres" } pair to pass as db.

Builder methods

Documented order: .schema() → .middleware() → .procedure() → .build(). .auth(), .openapi(), .admin(), .route(), and .resource() can appear anywhere before .build() (.resource() needs a prior .schema() that defines the table).

.schema(schemaResult)

Registers a schema version built with schema(). Every .schema() call becomes one migration step, and the latest version types context.db. Takes a single SchemaResult argument — no options.

.auth(config)

Enables Better Auth and mounts ALL /api/auth/**. Narrows context.auth to non-null.

AuthConfig is Better Auth's full BetterAuthOptions minus database (Outer wires the database itself from your db dialect), with these Outer-specific notes:

.middleware(mw)

Adds an oRPC middleware to the base context. Whatever the middleware returns via next({ context }) is merged into context for all subsequently defined procedures (and their types).

.procedure(name, cb)

Registers an RPC procedure. Dot notation nests namespaces: "user.me" is served at POST /rpc/user/me. The callback receives the oRPC base builder — chain .input(), .output(), .handler() on it. Names must be unique; the _admin namespace is reserved.

.route(method, path, handler)

Mounts a raw H3 route (webhooks, custom REST endpoints) alongside RPC routes. handler(event, context) receives the H3 event and the same context (with db, auth, ...) as procedures. Registered before /rpc/**, so it wins on overlapping paths.

.resource(name, options?)

Auto-generates typed CRUD procedures (list, get, create, update, delete) for a table defined in the latest .schema(). Throws at build time if the table doesn't exist.

ResourceOptions:

ResourcePermissions — each of list, get, create, update, delete accepts:

.openapi(config?)

Mounts GET /openapi.json and a plain-JSON REST surface under /rest/** matching the spec. Requires the optional peers @orpc/openapi and @orpc/zod.

.admin(config?)

Enables the admin API — meta/schema introspection, migration status, and table CRUD — under the reserved _admin namespace (/rpc/_admin/**). Every admin procedure requires a signed-in session with an admin role, so .auth() must also be called or .build() throws.

AdminConfig:

.build()

Finalizes the chain and returns a BuiltOuter. Throws if any resource permission or .admin() requires auth but .auth() was never called.

BuiltOuter

schema() builder

import { schema, timestamps } from "@outerjs/server";

export const v1_0_0 = schema("1.0.0")
  .auth()
  .table("post", (t) => ({
    id: t.serial().primaryKey(),
    title: t.text(),
    body: t.text().nullable(),
    authorId: t.text().references("user", "id"),
    meta: t.jsonb().nullable(),
    ...timestamps(t),
  }))
  .relation("user", (rel) => rel.hasMany("post", { from: "id", to: "authorId" }))
  .build();

schema(version)

Starts a schema version. version is a free-form string (e.g. "1.0.0") shown in the OpenAPI spec and admin API.

.auth()

Registers the Better Auth core tables (user, session, account, verification) with the admin plugin's fields (user.role/banned/banReason/banExpires, session.impersonatedBy) plus their relations. Extend an auth table by re-declaring extra columns via .table("user", ...) after this call — columns merge, yours win on name collisions. Never remove or rename the core auth columns.

.table(name, define)

Defines (or extends — re-declaring merges, later wins) a table. define receives the column builder t:

Column modifiers (chainable, each returns the column):

timestamps(t)

Helper returning createdAt / updatedAt timestamp columns with CURRENT_TIMESTAMP defaults — spread into a .table() column object.

.relation(fromTable, define)

Declares a relation used by context.db.query (Sola) and resource include. define receives a chain with:

.build()

Freezes and returns the SchemaResult to pass into .schema().

Type helpers