@protobase/server 0.4.1 → 0.6.0

package/dist/project-config.js

@@ -0,0 +1,111 @@
+import { isPageDefinition } from "@protobase/layout";
+//#region src/project-config.ts
+/** Typed identity, for `export default defineConfig({ extends: [...], config, auth, ... })` in `protobase.config.ts`. */
+const defineConfig = (config) => config;
+const lastSet = (objects) => Object.fromEntries(objects.flatMap((object) => Object.entries(object)).filter(([, value]) => value !== void 0));
+const flatten = (config, label) => [...(config.extends ?? []).flatMap((parent, index) => flatten(parent, parent.name ?? `${label} extends[${index}]`)), {
+	config,
+	label
+}];
+const checkUnique = (kind, entries) => {
+	const seen = /* @__PURE__ */ new Map();
+	for (const { name, value, label } of entries) {
+		const first = seen.get(name);
+		if (first && first.value !== value) throw new Error(`${kind} "${name}" is defined twice, ${first.label === label ? `in ${label}` : `by ${first.label} and by ${label}`}; rename one of them`);
+		if (!first) seen.set(name, {
+			value,
+			label
+		});
+	}
+};
+const mergedModule = (named) => {
+	const withModule = named.filter(({ config }) => config.config);
+	if (withModule.length === 0) return void 0;
+	const exports = withModule.flatMap(({ config, label }) => Object.entries(config.config).map(([key, value]) => ({
+		key,
+		value,
+		label
+	})));
+	const values = exports.map((entry) => ({
+		...entry,
+		value: entry.value
+	}));
+	checkUnique("The resource", values.filter(({ value }) => typeof value?.recordSchema === "function" && typeof value.toModel === "function").map(({ value, label }) => ({
+		name: String(value.toModel().name),
+		value,
+		label
+	})));
+	checkUnique("The page", exports.filter(({ value }) => isPageDefinition(value)).map(({ value, label }) => ({
+		name: value.name,
+		value,
+		label
+	})));
+	const menus = values.filter(({ value }) => typeof value?.toUserMenuModel === "function");
+	if (new Set(menus.map(({ value }) => value)).size > 1) throw new Error(`Only one config may export a user menu; ${menus.map(({ label }) => label).join(" and ")} each do`);
+	const module = {};
+	const own = withModule.at(-1).label;
+	for (const { key, value, label } of exports) {
+		if (Object.values(module).includes(value)) continue;
+		module[label === own ? key : `${label}:${key}`] = value;
+	}
+	return module;
+};
+const mergedAssistant = (named) => {
+	const options = named.map(({ config, label }) => ({
+		assistant: config.options?.assistant,
+		label
+	})).filter(({ assistant }) => assistant !== void 0);
+	if (options.length === 0) return void 0;
+	if (options.at(-1).assistant === false) return false;
+	const after = options.slice(options.findLastIndex(({ assistant }) => assistant === false) + 1);
+	const tools = after.flatMap(({ assistant, label }) => (assistant.tools ?? []).map((tool) => ({
+		tool,
+		label
+	})));
+	checkUnique("The assistant tool", tools.map(({ tool, label }) => ({
+		name: tool.name,
+		value: tool,
+		label
+	})));
+	return {
+		...lastSet(after.map(({ assistant }) => assistant)),
+		...tools.length > 0 && { tools: tools.map(({ tool }) => tool) }
+	};
+};
+const mergedOptions = (named) => {
+	const all = named.flatMap(({ config }) => config.options ? [config.options] : []);
+	if (all.length === 0) return void 0;
+	const writeHooks = all.flatMap((options) => options.writeHooks ?? []);
+	const assistant = mergedAssistant(named);
+	return {
+		...lastSet(all),
+		...writeHooks.length > 0 && { writeHooks },
+		...assistant !== void 0 && { assistant }
+	};
+};
+/**
+* One config from several, each after the ones it `extends`, the last being the app's own. Named things are all kept:
+* resources, views and pages of the config modules, assistant tools; one name defined by two configs is an error naming
+* both. Write hooks run in the same order. Every other value is the last config's that sets it, so the app's own wins.
+*/
+const mergeConfig = (...configs) => {
+	const named = configs.flatMap((config, index) => flatten(config, config.name ?? `config ${index + 1}`));
+	const { db, authenticate, auth } = lastSet(named.map(({ config }) => ({
+		db: config.db,
+		authenticate: config.authenticate,
+		auth: config.auth
+	})));
+	const module = mergedModule(named);
+	const options = mergedOptions(named);
+	const name = configs.at(-1)?.name;
+	return {
+		...name && { name },
+		...module && { config: module },
+		...db && { db },
+		...authenticate && { authenticate },
+		...auth && { auth },
+		...options && { options }
+	};
+};
+//#endregion
+export { defineConfig, mergeConfig };

package/dist/read-service.js

@@ -1,10 +1,10 @@
 import { notFound } from "./problem.js";
-import { tenantScope } from "./tenant.js";
-import { recordDecision, requestAccess, requireOperation, targetFilter, visibleFields, writableFields } from "./request-access.js";
-import { readTransaction } from "./transactions.js";
 import { pickFields } from "./rows.js";
 import { fetchRecord } from "./records.js";
+import { tenantScope } from "./tenant.js";
+import { recordDecision, requestAccess, requireOperation, targetFilter, visibleFields, writableFields } from "./request-access.js";
 import { rowPermissions } from "./row-permissions.js";
+import { readTransaction } from "./transactions.js";
 //#region src/read-service.ts
 /** `edit` for fields the caller may change on this record, `read` for the rest (sensitive ones included); hidden fields are not listed at all. */
 const fieldModes = (access, canUpdate) => Object.fromEntries(Object.keys(access.readable.fields).map((name) => [name, canUpdate && writableFields(access, "update").includes(name) ? "edit" : "read"]));

package/dist/registry.d.ts

@@ -0,0 +1,2 @@
+import "./resource-source.js";
+import { ResourceModel } from "@protobase/schema";

package/dist/routes/record.js

@@ -1,11 +1,11 @@
 import { notFound } from "../problem.js";
+import { keyFromPath } from "../key.js";
 import { pickFields } from "../rows.js";
+import { readRecord } from "../read-service.js";
 import { runWrite } from "../write-pipeline.js";
-import { keyFromPath } from "../key.js";
 import { deletedRows, selectedFields } from "../params.js";
 import { returnPreference } from "./preferences.js";
 import { resolveTarget } from "./target.js";
-import { readRecord } from "../read-service.js";
 import { revealField } from "../reveal-service.js";
 import { Hono } from "hono";
 //#region src/routes/record.ts

package/dist/row-permissions.js

@@ -1,7 +1,7 @@
-import { tenantScope } from "./tenant.js";
-import { recordDecision } from "./request-access.js";
 import { aliasedColumn, columnId, scopeConditions, tableId, whereClause } from "./sql-parts.js";
 import { fetchRecord } from "./records.js";
+import { tenantScope } from "./tenant.js";
+import { recordDecision } from "./request-access.js";
 import { compileFilter } from "@protobase/query";
 import { sql } from "kysely";
 //#region src/row-permissions.ts

package/dist/scan-guard.d.ts

@@ -0,0 +1,4 @@
+import "./types.js";
+import "./registry.js";
+import { ResourceModel } from "@protobase/schema";
+import { Db } from "@protobase/query";

package/dist/types.d.ts

@@ -1,8 +1,6 @@
-import { AssistantOptions } from "./assistant/assistant-settings.js";
-import { RuntimeOptions } from "./runtime/runtime-settings.js";
 import { Hono } from "hono";
 import { PageModel } from "@protobase/layout";
-import { ResolveOptions, ResourceModel, ViewModel } from "@protobase/schema";
+import { ResourceModel, ViewModel } from "@protobase/schema";
 import { Db } from "@protobase/query";
 //#region src/types.d.ts
 export type TenantValue = string | number;
@@ -64,35 +62,6 @@ export type AuditQueue = {
   publish(event: AuditEvent): Promise<void>;
 };
 export type ScanGuardMode = 'reject' | 'warn' | 'off';
-export type AdminOptions = {
-  /** Default `/api/v1`. */
-  basePath?: string;
-  /** Applied to every request's transaction with SET LOCAL. Default 15000. */
-  statementTimeoutMs?: number;
-  /** List shapes that would sequentially scan a table of more than `seqScanRows` rows (default 10000). Default mode `reject`. */
-  scanGuard?: {
-    mode?: ScanGuardMode;
-    seqScanRows?: number;
-  };
-  /** Runs inside the write transaction after each create, update and delete. */
-  writeHooks?: PipelineHook[];
-  /** The project's roles (from `defineRoles`): an operation without an access rule needs the matching capability. */
-  roles?: ResolveOptions['roles'];
-  /** What an operation without a rule does; overrides the capability check. Without `roles` the default is allow. */
-  defaultAccess?: ResolveOptions['defaultAccess'];
-  /** Whether list items carry their `permissions` (update, delete): true by default, or `{ except: [...] }` for resources that opt out. */
-  rowPermissions?: boolean | {
-    except: string[];
-  };
-  /** Receives an event for every reveal of a sensitive field. Default: printed to the console, nothing kept. */
-  audit?: AuditQueue;
-  /** Called with every error the API turns into a 500, so the host can report it. */
-  onUnhandledError?: (error: unknown) => void;
-  /** The assistant in the admin app's dock: a backend elsewhere or the built-in one (see `AssistantOptions`); `false` turns it off. */
-  assistant?: AssistantOptions | false;
-  /** The runtime updates endpoint behind the top bar's update button (see `RuntimeOptions`); `false` turns it off. */
-  runtime?: RuntimeOptions | false;
-};
 export type ViewSource = {
   toModel(): ViewModel;
 };

package/dist/write-pipeline.js

@@ -1,10 +1,10 @@
 import { HttpProblem, badRequest } from "./problem.js";
+import { deleteRecord, fetchRecord, insertRecord, restoreRecord } from "./records.js";
 import { tenantScope } from "./tenant.js";
 import { requestAccess, requireOperation, targetFilter, writableFields } from "./request-access.js";
 import { writeTransaction } from "./transactions.js";
-import { deleteRecord, fetchRecord, insertRecord, restoreRecord } from "./records.js";
-import { assertWritten, checkPrecondition, decide, denied, firstKeyField, missing, notifier, shown } from "./write-shared.js";
 import { validateBody } from "./validate-body.js";
+import { assertWritten, checkPrecondition, decide, denied, firstKeyField, missing, notifier, shown } from "./write-shared.js";
 import { applyUpdate, planUpdate } from "./write-update.js";
 //#region src/write-pipeline.ts
 const withOwner = (access, values) => {

package/dist/write-shared.js

@@ -1,9 +1,9 @@
 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";
+import { tenantScope } from "./tenant.js";
+import { andFilters, recordDecision } from "./request-access.js";
 //#region src/write-shared.ts
 const missing = (entry) => notFound(`No ${entry.name} with this key`);
 const checkPrecondition = (current, ifMatch, required) => {

package/dist/write-update.js

@@ -1,8 +1,8 @@
+import { fetchRecord, updateRecord } from "./records.js";
 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";
+import { assertWritten, checkPrecondition, decide, denied, firstKeyField, missing, notifier } from "./write-shared.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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
-    "@protobase/layout": "0.4.1",
-    "@protobase/query": "0.4.1",
-    "@protobase/schema": "0.4.1",
+    "@protobase/layout": "0.6.0",
+    "@protobase/query": "0.6.0",
+    "@protobase/schema": "0.6.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@simplewebauthn/server": "^13.3.1",
     "better-auth": "^1.7.7",