@protobase/server 0.7.0 → 0.8.1

package/dist/changes/capture-sql.js

@@ -0,0 +1,108 @@
+//#region src/changes/capture-sql.ts
+const quoteIdent = (name) => `"${name.replaceAll("\"", "\"\"")}"`;
+const quoteLiteral = (text) => `'${text.replaceAll("'", "''")}'`;
+const qualified = ({ schema, name }) => schema ? `${quoteIdent(schema)}.${quoteIdent(name)}` : quoteIdent(name);
+/** A Postgres array literal of text, every element quoted, so the same columns always give the same text. */
+const textArray = (items) => `{${items.map((item) => `"${item.replaceAll("\\", "\\\\").replaceAll("\"", "\\\"")}"`).join(",")}}`;
+const identifier = (name) => {
+	const encoder = new TextEncoder();
+	let kept = "";
+	for (const char of name) {
+		if (encoder.encode(kept + char).length > 63) break;
+		kept += char;
+	}
+	return kept;
+};
+/** The table as SQL names it, qualified when the resource names a schema. */
+const tableSql = (model) => qualified(model.table);
+/**
+* The outbox: one row per changed row, written in the writer's transaction. `transaction` is the writer's transaction
+* id; `dispatch_after` holds back a change that the process which wrote it is delivering itself.
+*/
+const outboxSql = (schema) => `create table if not exists ${quoteIdent(schema)}."outbox" (
+  "id" bigint generated always as identity primary key,
+  "transaction" bigint not null,
+  "resource" text not null,
+  "op" text not null,
+  "old" jsonb,
+  "new" jsonb,
+  "changed" text[],
+  "actor" jsonb,
+  "dispatch_after" timestamptz not null default now(),
+  "created_at" timestamptz not null default now()
+)`;
+/**
+* The body of `capture()`: its arguments are the resource, the columns to keep and the sensitive columns, whose names
+* it lists when they change but whose values it never keeps. It skips a transaction that set `<schema>.capture` to
+* `off`, and an update that changed none of those columns.
+*/
+const captureBody = (schema) => `
+declare
+  kept text[] := TG_ARGV[1]::text[];
+  hidden text[] := TG_ARGV[2]::text[];
+  old_row jsonb;
+  new_row jsonb;
+  changed text[];
+begin
+  if current_setting('${schema}.capture', true) = 'off' then
+    return null;
+  end if;
+  if TG_OP <> 'INSERT' then
+    old_row := to_jsonb(OLD);
+  end if;
+  if TG_OP <> 'DELETE' then
+    new_row := to_jsonb(NEW);
+  end if;
+  if TG_OP = 'UPDATE' then
+    select array_agg(c.name order by c.position) into changed
+    from unnest(kept || hidden) with ordinality as c(name, position)
+    where old_row -> c.name is distinct from new_row -> c.name;
+    if changed is null then
+      return null;
+    end if;
+  end if;
+  insert into ${quoteIdent(schema)}."outbox" ("transaction", "resource", "op", "old", "new", "changed", "actor")
+  values (
+    pg_current_xact_id()::text::bigint,
+    TG_ARGV[0],
+    TG_OP,
+    (select jsonb_object_agg(o.key, o.value) from jsonb_each(old_row) as o where o.key = any(kept)),
+    (select jsonb_object_agg(n.key, n.value) from jsonb_each(new_row) as n where n.key = any(kept)),
+    changed,
+    nullif(current_setting('${schema}.actor', true), '')::jsonb
+  );
+  return null;
+end
+`;
+/**
+* `capture()` runs as its owner, with a fixed search path: a writer needs no rights on the schema, so another
+* service writing as its own role keeps working once a resource has events.
+*/
+const captureFunctionSql = (schema) => `create or replace function ${quoteIdent(schema)}."capture"() returns trigger language plpgsql security definer set search_path = pg_catalog, pg_temp as $capture$${captureBody(schema)}$capture$`;
+/** The two triggers of a resource with events: inserts and deletes, and updates that change the row. */
+const resourceTriggers = (model) => {
+	const fields = Object.values(model.fields);
+	const args = [
+		model.name,
+		textArray(fields.filter((field) => !field.sensitive).map((field) => field.column)),
+		textArray(fields.filter((field) => field.sensitive).map((field) => field.column))
+	];
+	return [{
+		name: identifier(`${model.table.name}_changes`),
+		type: 13,
+		args
+	}, {
+		name: identifier(`${model.table.name}_changes_update`),
+		type: 17,
+		args
+	}];
+};
+const dropTriggerSql = (name, table) => `drop trigger if exists ${quoteIdent(name)} on ${table}`;
+const createTriggerSql = (schema, trigger, table) => {
+	const timing = trigger.type & 16 ? "after update" : "after insert or delete";
+	const when = trigger.type & 16 ? " when (old.* is distinct from new.*)" : "";
+	const args = trigger.args.map(quoteLiteral).join(", ");
+	return `create trigger ${quoteIdent(trigger.name)} ${timing} on ${table} for each row${when} execute function ${quoteIdent(schema)}."capture"(${args})`;
+};
+//#endregion
+export { captureBody, captureFunctionSql, createTriggerSql, dropTriggerSql, outboxSql, quoteIdent, resourceTriggers, tableSql };

package/dist/changes/coalesce.d.ts

@@ -0,0 +1,38 @@
+import { Row } from "../types.js";
+import { EventActor } from "@protobase/schema";
+//#region src/changes/coalesce.d.ts
+/** A row of the outbox: one row's insert, update or delete, its columns as `changes.capture()` kept them. */
+export type CapturedRow = {
+  /** The outbox id: commit order for the changes of one record. */
+  id: string;
+  transaction: string;
+  /** The resource whose table changed, which its trigger names. */
+  resource: string;
+  op: 'INSERT' | 'UPDATE' | 'DELETE';
+  old: Row | null;
+  new: Row | null;
+  /** The columns an update changed, sensitive ones included; `null` for inserts and deletes. */
+  changed: string[] | null;
+  actor: EventActor | null;
+};
+/**
+ * One record's changes in one transaction, as one: its columns at the start (`before`, none when it was inserted) and
+ * at commit (`after`, none when it was deleted), and for an update the columns that differ, sensitive ones included.
+ */
+export type CoalescedChange = {
+  transaction: string;
+  resource: string;
+  before: Row | null;
+  after: Row | null;
+  changed: string[];
+  actor: EventActor | null;
+  /** The id of its last outbox row. */
+  sequence: string;
+};
+/**
+ * The outbox rows of one or more transactions, in id order, as one change per (transaction, record). An insert then a
+ * delete is nothing, and so is an update that ends where it started; a delete then an insert of the same key is an
+ * update. `keyColumns` names a resource's primary key columns, which identify its records.
+ */
+export declare const coalesce: (rows: readonly CapturedRow[], keyColumns: (resource: string) => readonly string[]) => CoalescedChange[];
+//#endregion

package/dist/changes/coalesce.js

@@ -0,0 +1,69 @@
+//#region src/changes/coalesce.ts
+const sameValue = (a, b) => a === b || JSON.stringify(a) === JSON.stringify(b);
+const recordKey = (row, columns, keyColumns) => JSON.stringify([
+	row.transaction,
+	row.resource,
+	...keyColumns.map((column) => columns?.[column] ?? null)
+]);
+const changedColumns = (before, after, listed) => [.../* @__PURE__ */ new Set([
+	...listed,
+	...Object.keys(before),
+	...Object.keys(after)
+])].filter((column) => {
+	return !(column in before || column in after) || !sameValue(before[column], after[column]);
+});
+const merged = ({ first, last, actor, listed }) => {
+	const base = {
+		transaction: first.transaction,
+		resource: first.resource,
+		actor,
+		sequence: last.id
+	};
+	const before = first.op === "INSERT" ? null : first.old;
+	const after = last.op === "DELETE" ? null : last.new;
+	if (!before && !after) return [];
+	if (!before || !after) return [{
+		...base,
+		before,
+		after,
+		changed: []
+	}];
+	const changed = changedColumns(before, after, listed);
+	return changed.length > 0 ? [{
+		...base,
+		before,
+		after,
+		changed
+	}] : [];
+};
+/**
+* The outbox rows of one or more transactions, in id order, as one change per (transaction, record). An insert then a
+* delete is nothing, and so is an update that ends where it started; a delete then an insert of the same key is an
+* update. `keyColumns` names a resource's primary key columns, which identify its records.
+*/
+const coalesce = (rows, keyColumns) => {
+	const current = /* @__PURE__ */ new Map();
+	const groups = [];
+	for (const row of rows) {
+		const columns = keyColumns(row.resource);
+		const key = recordKey(row, row.op === "INSERT" ? row.new : row.old, columns);
+		let group = current.get(key);
+		if (!group) {
+			group = {
+				first: row,
+				last: row,
+				actor: row.actor,
+				listed: /* @__PURE__ */ new Set()
+			};
+			groups.push(group);
+		}
+		group.last = row;
+		group.actor = row.actor ?? group.actor;
+		for (const column of row.changed ?? []) group.listed.add(column);
+		current.delete(key);
+		current.set(row.op === "DELETE" ? key : recordKey(row, row.new, columns), group);
+	}
+	return groups.flatMap(merged);
+};
+//#endregion
+export { coalesce };

package/dist/changes/events-options.d.ts

@@ -0,0 +1,10 @@
+//#region src/changes/events-options.d.ts
+/** Where captured changes live in the app's database (`events` in `protobase.config.ts`). */
+export type EventsOptions = {
+  /**
+   * The schema holding the outbox and the capture function, and the prefix of their transaction settings
+   * (`changes.actor`, `changes.capture`); default `changes`. Rename it when the database already has a schema by that name.
+   */
+  schema?: string;
+};
+//#endregion

package/dist/changes/events-options.js

@@ -0,0 +1,10 @@
+//#region src/changes/events-options.ts
+const schemaPattern = /^[a-z_][a-z0-9_]*$/;
+/** The schema of the options, checked: it also prefixes setting names, which take plain lowercase names only. */
+const changesSchema = (options = {}) => {
+	const schema = options.schema ?? "changes";
+	if (!schemaPattern.test(schema)) throw new Error(`Invalid events schema "${schema}": use lowercase letters, digits and "_"`);
+	return schema;
+};
+//#endregion
+export { changesSchema };

package/dist/changes/match-events.d.ts

@@ -0,0 +1,9 @@
+import { ResourceChange } from "./resource-change.js";
+import { EventMatch, ResourceModel } from "@protobase/schema";
+//#region src/changes/match-events.d.ts
+/**
+ * The names of the resource's events a change raises, in declaration order. The filters are checked once, here; `matches`
+ * are the events' code predicates by event name (`eventMatches()` of the resource).
+ */
+export declare const eventMatcher: (model: ResourceModel, matches?: Record<string, EventMatch<any>>) => (change: ResourceChange) => string[];
+//#endregion

package/dist/changes/match-events.js

@@ -0,0 +1,55 @@
+import { checkEventFilter, evaluateFilter } from "@protobase/schema";
+//#region src/changes/match-events.ts
+const filterOf = (model, source) => {
+	const { filter, problem } = checkEventFilter(model, source);
+	if (!filter) throw new Error(`Resource "${model.name}": event filter "${source}" ${problem}`);
+	return filter;
+};
+const holds = (filter, record) => record !== void 0 && evaluateFilter(filter, record) === true;
+const contextOf = (change) => ({
+	operation: change.operation,
+	...change.before && { before: change.before },
+	...change.after && { after: change.after },
+	changed: change.changed,
+	actor: change.actor,
+	source: change.source,
+	...change.tenant !== void 0 && { tenant: change.tenant },
+	transaction: change.transaction
+});
+const eventTest = (model, event, match) => {
+	const tests = [(change) => event.operations.includes(change.operation)];
+	if (event.when !== void 0) {
+		const when = filterOf(model, event.when);
+		tests.push((change) => holds(when, change.after));
+	}
+	if (event.from !== void 0) {
+		const from = filterOf(model, event.from);
+		tests.push((change) => holds(from, change.before));
+	}
+	if (event.becomes !== void 0) {
+		const condition = filterOf(model, event.becomes);
+		tests.push((change) => holds(condition, change.after) && !holds(condition, change.before));
+	}
+	if (event.changed) {
+		const fields = event.changed;
+		tests.push((change) => change.changed.some((name) => fields.includes(name)));
+	}
+	if (event.match) {
+		if (!match) throw new Error(`Resource "${model.name}": event "${event.name}" has no match function`);
+		tests.push((change) => match(contextOf(change)));
+	}
+	return (change) => tests.every((test) => test(change));
+};
+/**
+* The names of the resource's events a change raises, in declaration order. The filters are checked once, here; `matches`
+* are the events' code predicates by event name (`eventMatches()` of the resource).
+*/
+const eventMatcher = (model, matches = {}) => {
+	const tests = (model.events ?? []).map((event) => ({
+		name: event.name,
+		test: eventTest(model, event, matches[event.name])
+	}));
+	return (change) => tests.filter(({ test }) => test(change)).map(({ name }) => name);
+};
+//#endregion
+export { eventMatcher };

package/dist/changes/resource-change.d.ts

@@ -0,0 +1,27 @@
+import { Row, TenantValue } from "../types.js";
+import { CoalescedChange } from "./coalesce.js";
+import { EventActor, EventOperation, ResourceModel } from "@protobase/schema";
+//#region src/changes/resource-change.d.ts
+/** One record's change in one transaction, by field name: what events are matched against and payloads are built from. */
+export type ResourceChange = {
+  resource: string;
+  /** The record's key as its URL has it. */
+  key: string;
+  operation: EventOperation;
+  /** The record before and after the change, without sensitive fields. */
+  before?: Row;
+  after?: Row;
+  /** The fields an update changed, sensitive ones included. */
+  changed: string[];
+  actor: EventActor | null;
+  source: 'api' | 'database';
+  tenant?: TenantValue;
+  transaction: string;
+  /** Grows with every change of a record, so receivers can drop stale events. */
+  sequence: string;
+};
+/** A captured row by field name, fields without a captured column left out. */
+export declare const recordOf: (model: ResourceModel, columns: Row) => Row;
+/** A coalesced change of the resource's table, by field name, with deletes and undeletes told apart from updates. */
+export declare const resourceChange: (model: ResourceModel, change: CoalescedChange) => ResourceChange;
+//#endregion

package/dist/changes/resource-change.js

@@ -0,0 +1,43 @@
+import { encodeKey } from "@protobase/schema";
+//#region src/changes/resource-change.ts
+const fieldValue = (type, value) => {
+	if (value === null || value === void 0) return value;
+	if (type === "bigint" || type === "decimal") return String(value);
+	if (type === "integer") return Number(value);
+	return value;
+};
+/** A captured row by field name, fields without a captured column left out. */
+const recordOf = (model, columns) => Object.fromEntries(Object.values(model.fields).filter((field) => Object.hasOwn(columns, field.column)).map((field) => [field.name, fieldValue(field.type, columns[field.column])]));
+const operationOf = (model, before, after) => {
+	if (!before) return "create";
+	if (!after) return "delete";
+	if (!model.softDelete) return "update";
+	const wasDeleted = before[model.softDelete] != null;
+	const isDeleted = after[model.softDelete] != null;
+	if (!wasDeleted && isDeleted) return "delete";
+	if (wasDeleted && !isDeleted) return "undelete";
+	return "update";
+};
+const fieldsOf = (model, columns) => Object.values(model.fields).filter((field) => columns.includes(field.column)).map((field) => field.name);
+/** A coalesced change of the resource's table, by field name, with deletes and undeletes told apart from updates. */
+const resourceChange = (model, change) => {
+	const before = change.before ? recordOf(model, change.before) : void 0;
+	const after = change.after ? recordOf(model, change.after) : void 0;
+	const record = after ?? before;
+	const tenant = model.tenant === void 0 ? void 0 : record[model.tenant];
+	return {
+		resource: model.name,
+		key: encodeKey(model.primaryKey.map((name) => record[name])),
+		operation: operationOf(model, before, after),
+		...before && { before },
+		...after && { after },
+		changed: fieldsOf(model, change.changed),
+		actor: change.actor,
+		source: change.actor ? "api" : "database",
+		...tenant != null && { tenant },
+		transaction: change.transaction,
+		sequence: change.sequence
+	};
+};
+//#endregion
+export { recordOf, resourceChange };

package/dist/create-admin.d.ts

@@ -1,6 +1,9 @@
 import { AdminAuth } from "./better-auth/create-auth.js";
-import { ResourceSource } from "./resource-source.js";
+import { EventsOptions } from "./changes/events-options.js";
+import { FilesOptions } from "./files/options.js";
 import { AdminEnv, Authenticator, PageSource, ViewSource } from "./types.js";
+import { ResourceSource } from "./resource-source.js";
+import { FunctionSource } from "./functions/define-function.js";
 import { AdminOptions } from "./admin-options.js";
 import { Hono } from "hono";
 import { UserMenuSource } from "@protobase/schema";
@@ -17,8 +20,14 @@ export type CreateAdminInput = {
   authenticate: Authenticator;
   /** A Better Auth instance (see `createAuth`): its handler is mounted at `/api/auth`. */
   auth?: AdminAuth;
+  /** API functions of the app's own, each served at `<systemPath>/functions/<name>` (see `defineFunction`). */
+  functions?: Record<string, FunctionSource>;
+  /** Where file fields keep their bytes (see `FilesOptions`). */
+  files?: FilesOptions;
+  /** Where the changes that resources' events are raised from are captured (see `EventsOptions`). */
+  events?: EventsOptions;
   options?: AdminOptions;
 };
 /** The admin REST API as a Hono app. It uses only Web APIs, so it runs on Node, Workers and anywhere else Hono does. */
-export declare const createAdmin: ({ resources, views, pages, userMenu, db, authenticate, auth, options }: CreateAdminInput) => Hono<AdminEnv, import("hono/types").BlankSchema, "/">;
+export declare const createAdmin: ({ resources, views, pages, userMenu, db, authenticate, auth, functions, files: filesOptions, events, options }: CreateAdminInput) => Hono<AdminEnv, import("hono/types").BlankSchema, "/">;
 //#endregion

package/dist/create-admin.js

@@ -4,9 +4,16 @@ import { assistantRecords } from "./assistant/records.js";
 import { builtInAssistant } from "./assistant/built-in-assistant.js";
 import { consoleAuditQueue } from "./audit/console-queue.js";
 import { authBasePath } from "./better-auth/create-auth.js";
+import { organizationRoutes } from "./better-auth/organizations/admin-routes.js";
 import { statusRoute } from "./better-auth/status-route.js";
+import { changesSchema } from "./changes/events-options.js";
 import { checkShell } from "./check-shell.js";
 import { checkViews } from "./check-views.js";
+import { createFilesRuntime } from "./files/runtime.js";
+import { fileRoutes } from "./files/routes.js";
+import { toApiFunction } from "./functions/define-function.js";
+import { callerRecords } from "./functions/records.js";
+import { functionRoutes } from "./functions/routes.js";
 import { runtimeUrl } from "./runtime/runtime-settings.js";
 import { createMeta } from "./meta.js";
 import { buildRegistry } from "./registry.js";
@@ -20,9 +27,10 @@ import { Hono } from "hono";
 import { checkPages } from "@protobase/layout";
 //#region src/create-admin.ts
 /** The admin REST API as a Hono app. It uses only Web APIs, so it runs on Node, Workers and anywhere else Hono does. */
-const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenticate, auth, options = {} }) => {
+const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenticate, auth, functions = {}, files: filesOptions, events, options = {} }) => {
 	const basePath = options.basePath ?? "/api/v1";
 	const registry = buildRegistry(resources);
+	const apiFunctions = Object.fromEntries(Object.entries(functions).map(([name, source]) => [name, toApiFunction(name, source)]));
 	const viewModels = views.map((view) => view.toModel());
 	const userMenuModel = userMenu?.toUserMenuModel();
 	const pageModels = pages.map((entry) => entry.toModel());
@@ -35,6 +43,12 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 	const systemPath = basePath.slice(0, basePath.lastIndexOf("/"));
 	const assistant = assistantSettings(options.assistant, globalThis.process?.env ?? {});
 	const runtime = runtimeUrl(options.runtime, globalThis.process?.env ?? {});
+	const files = createFilesRuntime({
+		...filesOptions && { options: filesOptions },
+		env: globalThis.process?.env ?? {},
+		models: registry.entries.map((entry) => entry.model),
+		systemPath
+	});
 	const deps = {
 		db,
 		registry,
@@ -53,7 +67,9 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 		},
 		rowPermissions: (resource) => typeof options.rowPermissions === "object" ? !options.rowPermissions.except.includes(resource) : options.rowPermissions !== false,
 		...assistant && { assistant: assistant.kind === "external" ? assistant.url : `${systemPath}/assistant` },
-		...runtime && { runtime }
+		...runtime && { runtime },
+		...files && { files },
+		...registry.entries.some((entry) => entry.model.events) && { actorSetting: `${changesSchema(events)}.actor` }
 	};
 	const meta = createMeta(deps);
 	const onError = createErrorHandler(options.onUnhandledError);
@@ -83,6 +99,12 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 	app.onError(onError);
 	if (auth) {
 		app.route(authBasePath, statusRoute(auth));
+		if (auth.organizations) app.route(authBasePath, organizationRoutes({
+			auth,
+			audit: deps.audit,
+			registry,
+			db
+		}));
 		app.on(["GET", "POST"], `${authBasePath}/*`, (c) => auth.handler(c.req.raw));
 	}
 	if (assistant?.kind === "built-in") {
@@ -99,7 +121,16 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 			report: options.onUnhandledError
 		}));
 	}
+	app.route("/", functionRoutes({
+		basePath: `${systemPath}/functions`,
+		functions: apiFunctions,
+		authenticate,
+		db,
+		records: (session) => callerRecords(deps, session),
+		onError
+	}));
 	app.route("/", batchRoute(deps, authenticate, meta));
+	app.route("/", fileRoutes(deps, authenticate));
 	app.route(basePath, api);
 	app.route(deps.systemPath || "/", system);
 	return app;

package/dist/deps.d.ts

@@ -1,4 +1,5 @@
 import "./types.js";
+import "./files/runtime.js";
 import "./registry.js";
 import "./scan-guard.js";
 import { PageModel } from "@protobase/layout";

package/dist/files/attach.js

@@ -0,0 +1,80 @@
+import { badRequest } from "../problem.js";
+import { baseOf, parseUri } from "./uri.js";
+import { tenantScope } from "../tenant.js";
+import { readTicket } from "./ticket.js";
+//#region src/files/attach.ts
+/** The ticket scope of a caller's upload for one field. */
+const ticketScope = (access, field) => ({
+	tenant: String(tenantScope(access.entry, access.session)?.tenantValue ?? ""),
+	resource: access.entry.name,
+	field,
+	user: String(access.session.user.id)
+});
+const fileFields = (access) => Object.values(access.full.fields).filter((field) => field.file);
+/**
+* File values of a validated create or update body, made ready to store: a ticket from `:upload` becomes its clean URI
+* plus the derived fields it carries, `null` clears the field and its derived fields, and the stored value itself is a
+* no-op. Anything else is refused, so a row can only point at a file its writer uploaded for that field.
+*/
+const attachFiles = async (access, values, current) => {
+	const names = Object.keys(values).filter((name) => access.full.fields[name]?.file);
+	const files = access.deps.files;
+	if (names.length === 0 || !files) return values;
+	const result = { ...values };
+	const errors = [];
+	const now = Math.floor(Date.now() / 1e3);
+	for (const name of names) {
+		const field = access.full.fields[name];
+		const derive = field.file.derive ?? [];
+		const value = values[name];
+		if (value === null) {
+			for (const target of derive) result[target] = null;
+			continue;
+		}
+		if (current && value === current[name]) {
+			delete result[name];
+			continue;
+		}
+		const ticket = await readTicket(files.signer, String(value), ticketScope(access, name), now);
+		if (!ticket.ok || ticket.ref.provider !== field.file.provider) {
+			const expired = !ticket.ok && ticket.reason === "expired";
+			errors.push({
+				field: name,
+				code: "invalid-value",
+				message: expired ? "The upload expired; upload the file again" : "Not a file uploaded for this field; upload it with :upload first"
+			});
+			continue;
+		}
+		result[name] = ticket.uri;
+		for (const target of derive) result[target] = Object.hasOwn(ticket.derived, target) ? ticket.derived[target] : null;
+	}
+	if (errors.length > 0) throw badRequest("invalid-record", `The request body is invalid: ${errors[0].field}: ${errors[0].message}`, { errors });
+	return result;
+};
+/**
+* Schedules the delete of every file a write took out of its row: a replaced or cleared value, or all of a hard-deleted
+* row's files, each due after its provider's retention. It runs inside the write transaction, before the commit: if
+* the write rolls back, the file is still referenced when the entry is due, and stays.
+*/
+const scheduleRemovedFiles = async (access, operation, before, after) => {
+	const files = access.deps.files;
+	if (!files || !before || operation === "create" || operation === "undelete") return;
+	if (operation === "delete" && access.full.softDelete) return;
+	const now = Date.now();
+	const removed = fileFields(access).flatMap((field) => {
+		const old = before[field.name];
+		if (typeof old !== "string") return [];
+		const next = after?.[field.name];
+		if (typeof next === "string" && baseOf(next) === baseOf(old)) return [];
+		const ref = parseUri(old);
+		if (!ref || !files.providers[ref.provider]) return [];
+		return [{
+			provider: ref.provider,
+			path: ref.path,
+			due: new Date(now + files.retention(ref.provider))
+		}];
+	});
+	if (removed.length > 0) await files.schedule.add(removed);
+};
+//#endregion
+export { attachFiles, scheduleRemovedFiles, ticketScope };

package/dist/files/cleanup-runner.d.ts

@@ -0,0 +1,8 @@
+import { ResourceModel } from "@protobase/schema";
+import { Db } from "@protobase/query";
+//#region src/files/cleanup-runner.d.ts
+export type CleanupReport = {
+  deleted: string[];
+  kept: string[];
+};
+//#endregion

package/dist/files/cleanup-runner.js

@@ -0,0 +1,58 @@
+import { sql } from "kysely";
+//#region src/files/cleanup-runner.ts
+/** Every declared file column, once per table and column even when two resources share them. */
+const fileColumns = (models) => {
+	const seen = /* @__PURE__ */ new Map();
+	for (const model of models) for (const field of Object.values(model.fields)) {
+		if (field.type !== "file") continue;
+		seen.set(JSON.stringify([
+			model.table.schema ?? "",
+			model.table.name,
+			field.column
+		]), {
+			table: model.table,
+			column: field.column
+		});
+	}
+	return [...seen.values()];
+};
+const chunk = (items, size) => Array.from({ length: Math.ceil(items.length / size) }, (_, i) => items.slice(i * size, (i + 1) * size));
+/** The identities (`provider:path`) among `uris` that some row still holds. */
+const referenced = async (db, columns, uris) => {
+	const found = /* @__PURE__ */ new Set();
+	for (const { table, column } of columns) {
+		const value = sql`split_part(${sql.id(column)}, '?', 1)`;
+		const name = table.schema ? sql.id(table.schema, table.name) : sql.id(table.name);
+		const rows = await sql`select distinct ${value} as uri from ${name} where ${value} = any(${uris})`.execute(db);
+		for (const row of rows.rows) found.add(row.uri);
+	}
+	return found;
+};
+/**
+* Handles every scheduled delete that is due: right before deleting, it checks that no declared file column holds the
+* file; one that is referenced again (a rolled-back write, a restore, a shared value) is kept and its entry dropped.
+* Uploads never attached are deleted here too, after their ticket expired. Running it twice at once is harmless.
+*/
+const runCleanup = async ({ db, columns, providers, schedule, now = /* @__PURE__ */ new Date() }) => {
+	const deleted = /* @__PURE__ */ new Set();
+	const kept = /* @__PURE__ */ new Set();
+	for (const entries of chunk(await schedule.due(now), 500)) {
+		const uris = [...new Set(entries.map((entry) => `${entry.provider}:${entry.path}`))];
+		const inUse = await referenced(db, columns, uris);
+		for (const entry of entries) {
+			const uri = `${entry.provider}:${entry.path}`;
+			if (inUse.has(uri)) kept.add(uri);
+			else if (!deleted.has(uri)) {
+				await providers[entry.provider].store.delete(entry.path);
+				deleted.add(uri);
+			}
+			await schedule.done(entry);
+		}
+	}
+	return {
+		deleted: [...deleted],
+		kept: [...kept]
+	};
+};
+//#endregion
+export { fileColumns, runCleanup };