@protobase/server 0.0.0-stage → 0.1.0

package/dist/write-shared.js

@@ -0,0 +1,52 @@
+import { forbidden, notFound, preconditionFailed, preconditionRequired } from "./problem.js";
+import { tenantScope } from "./tenant.js";
+import { andFilters, recordDecision } from "./request-access.js";
+import { ifMatchSatisfied } from "./etag.js";
+import { pickFields } from "./rows.js";
+import { fetchRecord } from "./records.js";
+//#region src/write-shared.ts
+const missing = (entry) => notFound(`No ${entry.name} with this key`);
+const checkPrecondition = (current, ifMatch, required) => {
+	if (ifMatch === null) {
+		if (required) throw preconditionRequired("Send the ETag of the record you read in an If-Match header (or * for any version)");
+		return;
+	}
+	if (!ifMatchSatisfied(ifMatch, current.etag)) throw preconditionFailed("The record changed since it was read; fetch it again");
+};
+const denied = (entry, operation) => forbidden("access-denied", `You may not ${operation} this ${entry.name} record`);
+const decide = async (access, operation, record, input) => {
+	if (!access.resolved.recordChecks.includes(operation)) return void 0;
+	const decision = await recordDecision(access, operation, record, input);
+	if (decision === false) throw denied(access.entry, operation);
+	return decision === true ? void 0 : decision;
+};
+const keyOf = (access, record) => access.full.primaryKey.map((name) => record[name]);
+const firstKeyField = (access) => access.full.fields[access.full.primaryKey[0]];
+const assertWritten = async (trx, access, written, operation, ...filters) => {
+	const filter = andFilters(filters);
+	if (!filter) return;
+	if (!await fetchRecord(trx, access.entry, keyOf(access, written.record), tenantScope(access.entry, access.session)?.tenantValue, {
+		filter,
+		fields: [firstKeyField(access)]
+	})) throw denied(access.entry, `leave in that state (${operation})`);
+};
+/** The caller sees the readable fields only; hooks get the whole record. */
+const shown = (access, written) => ({
+	record: pickFields(written.record, Object.keys(access.model.fields)),
+	etag: written.etag
+});
+/** Runs the pipeline hooks for one write, inside the transaction. */
+const notifier = (deps, access) => async (trx, kind, before, after) => {
+	const { session } = access;
+	const event = {
+		operation: kind,
+		resource: access.full,
+		user: session.user,
+		...session.tenant !== void 0 && { tenant: session.tenant },
+		...before && { before },
+		...after && { after }
+	};
+	for (const hook of deps.hooks) await hook(event, trx);
+};
+//#endregion
+export { assertWritten, checkPrecondition, decide, denied, firstKeyField, keyOf, missing, notifier, shown };

package/dist/write-update.js

@@ -0,0 +1,45 @@
+import { tenantScope } from "./tenant.js";
+import { targetFilter } from "./request-access.js";
+import { fetchRecord, updateRecord } from "./records.js";
+import { assertWritten, checkPrecondition, decide, denied, firstKeyField, missing, notifier } from "./write-shared.js";
+import { validateBody } from "./validate-body.js";
+//#region src/write-update.ts
+/**
+* Everything an update needs before it writes: the row (locked, inside the caller's tenant and row filters), the ETag
+* precondition, validation against the fields the caller may write, and the record-level rule with its filter.
+*/
+const planUpdate = async (trx, access, key, body, ifMatch, required = true) => {
+	const { entry, full } = access;
+	const tenant = tenantScope(entry, access.session)?.tenantValue;
+	const target = targetFilter(access, "update");
+	const current = await fetchRecord(trx, entry, key, tenant, {
+		deleted: "hide",
+		lock: true,
+		...target && { filter: target },
+		etagFields: Object.keys(access.model.fields)
+	});
+	if (!current) throw missing(entry);
+	checkPrecondition(current, ifMatch, required);
+	const values = validateBody(access, "update", body, current.record);
+	const filter = Object.keys(values).length === 0 ? void 0 : await decide(access, "update", current.record, values);
+	if (filter && !await fetchRecord(trx, entry, key, tenant, {
+		filter,
+		fields: [firstKeyField(access)]
+	})) throw denied(entry, "update");
+	return {
+		current,
+		values,
+		...filter && { filter }
+	};
+};
+/** Writes a planned update, checks the row as written against the filters, and runs the hooks. */
+const applyUpdate = async (trx, deps, access, key, plan) => {
+	const { entry } = access;
+	const tenant = tenantScope(entry, access.session)?.tenantValue;
+	const updated = await updateRecord(trx, entry, key, tenant, plan.values, { etagFields: Object.keys(access.model.fields) });
+	await assertWritten(trx, access, updated, "update", access.resolved.rowFilter.update, plan.filter);
+	await notifier(deps, access)(trx, "update", plan.current.record, updated.record);
+	return updated;
+};
+//#endregion
+export { applyUpdate, planUpdate };

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@protobase/server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PrototeamHQ/protobase.git",
+    "directory": "packages/server"
+  },
+  "homepage": "https://docs.protobase.net",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@scalar/hono-api-reference": "^0.12.10",
+    "better-auth": "^1.7.7",
+    "hono": "^4.13.13",
+    "jose": "^6.2.12",
+    "kysely": "^0.29.6",
+    "nodemailer": "^10.0.16",
+    "zod": "^4.6.5",
+    "@protobase/layout": "0.1.0",
+    "@protobase/schema": "0.1.0",
+    "@protobase/query": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.