Extension points

Since v0.19.0, the pieces Vaultbase is built from are registries. The built-in field types, OAuth2 providers, storage drivers, email transports and push providers are registered through them, and code that embeds Vaultbase can add its own. Everything is exported from src/extend.ts; each register* function returns a function that removes what it added.

Embedding only, for now

These APIs are for code that embeds Vaultbase (createServer) and calls them before starting the server. A plugin API for the standalone binary will build on them. To add server-side code to the binary today, use hooks as files.

Events

import { on } from "./src/extend.ts";

on("record.created", ({ collection, record, auth, source }) => {
  console.log(`${collection.name}/${record.id} created via ${source}`);
});

Event	Payload
record.created	collection, record, auth, source
record.updated	collection, record, existing, auth, source
record.deleted	collection, id, existing, auth, source
auth.signup	collection, record, method (password, invite, anonymous, oauth2)

source is api (records API, hook and route helpers, batch), auth (an account created by an auth flow) or cascade (a relation cleared because its target was deleted).

Listeners run in registration order. Record events are emitted after the write has committed, so nothing a listener does can fail the write; a listener that throws is logged and the others still run. Realtime, webhooks and after-hooks are listeners on the same bus.

Registries

Function	Adds
registerFieldType	A field type: SQLite column type, validation, normalize, encode/decode, OpenAPI schema. Built-in types can’t be replaced.
registerOAuthProvider	An OAuth2 / OIDC sign-in provider.
registerStorageDriver	A file storage backend. Select it with the storage.driver setting.
registerEmailTransport	An email transport. Select it with the email.transport setting.
registerPushProvider	A push notification provider.
registerHook, registerRoute, registerJob, registerWorker	Hooks, custom routes, cron jobs and queue workers defined in code. Admin UI hooks run first; an admin UI route on the same method and path wins.

A new collection field must use a registered type, and storage.driver / email.transport must name a registered driver or transport.

import { registerFieldType } from "./src/extend.ts";

registerFieldType({
  type: "money",
  sqlType: "INTEGER",
  validate: (v) => (Number.isInteger(v) ? null : "must be a whole number of cents"),
});

Listing what’s registered

GET /api/v1/admin/extensions (admin only) lists every registered field type, provider, driver, transport, hook, route, job and worker.

Code registered this way runs in the server process with full privileges, like hooks.