@protobase/server 0.19.16 → 0.21.0

package/dist/routes/record.js

@@ -8,12 +8,14 @@ import { deletedRows, selectedFields } from "../params.js";
 import { returnPreference } from "./preferences.js";
 import { resolveTarget } from "./target.js";
 import { revealField } from "../reveal-service.js";
+import { readHistory } from "../history/read-history.js";
 import { Hono } from "hono";
 //#region src/routes/record.ts
 const recordRoutes = (deps) => {
 	const app = new Hono();
 	app.get("/:resource/:key", async (c) => {
 		const { entry } = resolveTarget(deps, c.req.param("resource"));
+		if (c.req.param("key").endsWith(":history")) return c.json(await readHistory(deps, entry, c.get("session"), keyFromPath(c, entry, ":history"), c.req.query()));
 		const deleted = deletedRows(entry.model, c.req.query("show_deleted") === "true");
 		const found = await readRecord(deps, entry, c.get("session"), keyFromPath(c, entry), deleted);
 		const columns = selectedFields({

package/dist/view-access.js

@@ -4,7 +4,7 @@ import { cardFavoriteErrors } from "./view-card-favorite.js";
 import { searchesOfFor } from "./view-saved-search.js";
 import { relatedColumnErrors } from "./view-related-column.js";
 import { resolveFieldPath } from "@protobase/layout";
-import { addressErrors, hrefPlaceholders, navRecentErrors, pruneByShape, shapes, tableDisplay } from "@protobase/schema/internal";
+import { addressErrors, chartFields, hrefPlaceholders, navRecentErrors, pruneByShape, shapes, tableDisplay } from "@protobase/schema/internal";
 //#region src/view-access.ts
 const pruneRelated = (item, resource, models) => {
 	const { columns, ...rest } = item;
@@ -172,7 +172,13 @@ const layoutShape = (resource, model, models) => shapes.oneOf({
 		sidebar: shapes.data,
 		when: shapes.data
 	}, { requires: ["latitude", "longitude"] }),
-	gallery: shapes.map((item) => pruneGallery(item, resource, model, models))
+	gallery: shapes.map((item) => pruneGallery(item, resource, model, models)),
+	history: shapes.object({
+		kind: shapes.data,
+		title: shapes.data,
+		limit: shapes.data,
+		when: shapes.data
+	})
 });
 const linkShape = (model, models) => shapes.map((run) => {
 	return ("to" in run ? addressErrors(run.to, {
@@ -218,11 +224,7 @@ const viewShape = (resource, model, models, prompted) => shapes.object({
 	list: listShape(resource, model, models, prompted),
 	filters: shapes.list(widgetShape),
 	layout: shapes.list(layoutShape(resource, model, models)),
-	chart: shapes.object({
-		field: shapes.field,
-		range: shapes.data,
-		granularity: shapes.data
-	}, { requires: ["field"] }),
+	chart: shapes.map((chart) => chartFields(chart).every((name) => Object.hasOwn(model.fields, name)) ? chart : void 0),
 	recordMode: shapes.data,
 	helpWhen: shapes.data,
 	saveFeedback: shapes.data,

package/dist/view-chart.js

@@ -0,0 +1,33 @@
+import { isGroupChart } from "@protobase/schema/internal";
+//#region src/view-chart.ts
+const numericTypes = [
+	"integer",
+	"bigint",
+	"decimal"
+];
+const ungroupable = [
+	"date",
+	"timestamp",
+	"json",
+	"file"
+];
+/**
+* What is wrong with a list's chart per value of a field: a field to group by that has no values to share out, or one
+* to add up that is no number. The filterable and sensitive checks of every chart are with the other fields'.
+*/
+const chartErrors = (chart, model) => {
+	if (!isGroupChart(chart)) return [];
+	const fieldOf = (name) => Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	const group = fieldOf(chart.groupBy);
+	const measured = chart.sum ?? chart.average;
+	const measure = measured === void 0 ? void 0 : fieldOf(measured);
+	return [
+		...!group ? [`groupBy: unknown field "${chart.groupBy}" on ${model.name}`] : [],
+		...group && ungroupable.includes(group.type) ? [`groupBy: "${chart.groupBy}" is a ${group.type} field; chart a date with { field, range, granularity }, and group by a field of values`] : [],
+		...measured !== void 0 && !measure ? [`unknown field "${measured}" on ${model.name} to add up`] : [],
+		...measure && !numericTypes.includes(measure.type) ? [`"${measured}" is ${measure.type}, and only a number can be added up`] : [],
+		...chart.type === "donut" && chart.average !== void 0 ? ["a donut shares out a total, and averages add up to none: count or sum instead"] : []
+	];
+};
+//#endregion
+export { chartErrors };

package/dist/webhooks/webhooks.js

@@ -1,11 +1,12 @@
-import { dispatchJobName } from "../changes/capture-sql.js";
+import { dispatchJobName, isCaptured } from "../changes/capture-sql.js";
+import { defineJob } from "../jobs/define-job.js";
 import { coalesce } from "../changes/coalesce.js";
 import { EventCodeError } from "../changes/event-code-error.js";
 import { eventMatcher } from "../changes/match-events.js";
 import { deleteOutbox, readOutbox } from "../changes/outbox.js";
 import { resourceChange } from "../changes/resource-change.js";
 import { callerRecords } from "../functions/records.js";
-import { defineJob } from "../jobs/define-job.js";
+import { writeHistory } from "../history/write-history.js";
 import { FatalJobError } from "../jobs/run-job.js";
 import { maxTries, nextRetryDelay } from "./retry-schedule.js";
 import { subscriberEvents } from "./subscriber-view.js";
@@ -40,7 +41,8 @@ const deliveryGroup = ({ subscription, change }) => `${subscription.name}:${chan
 *
 * - `changes.dispatch`, which `capture()` enqueues once per writing transaction, in one ordered group so one runs at a
 *   time: it turns the committed outbox rows into events, makes the first try of every unordered delivery itself,
-*   queues the failures and the ordered deliveries, and deletes the rows in that same transaction. A process that dies
+*   queues the failures and the ordered deliveries, keeps the changes of resources with history, and deletes the rows
+*   in that same transaction. A process that dies
 *   before that commits leaves the rows, and the job's retry delivers them again, under the same `webhook-id`.
 * - `webhooks.dispatch-change`, one change whose app code threw in dispatch: an event's `match` or filter, a
 *   subscription's `when`, or an access rule of its roles. Kept as failed, so dispatch moves on to later changes; a
@@ -52,14 +54,14 @@ const deliveryGroup = ({ subscription, change }) => `${subscription.name}:${chan
 *
 * With `table`, also `webhooks.send-test`, which Send test event queues, and with its log `webhooks.prune-log`, daily.
 *
-* No jobs without a resource with events; the subscriptions must name declared events.
+* No jobs without a resource with events or history; the subscriptions must name declared events.
 */
 const createWebhooks = ({ deps, subscriptions, functions, schema, log, table }) => {
 	const entries = deps.registry.entries;
 	const models = entries.map((entry) => entry.model);
 	const problems = subscriptionProblems(subscriptions, models, Object.keys(functions));
 	if (problems.length > 0) throw new Error(problems.join("; "));
-	if (!models.some((model) => model.events)) return { jobs: [] };
+	if (!models.some(isCaptured)) return { jobs: [] };
 	const matchers = new Map(entries.map((entry) => [entry.name, eventMatcher(entry.model, entry.source.eventMatches?.() ?? {})]));
 	const keyColumns = (resource) => {
 		const model = deps.registry.find(resource)?.model;
@@ -230,6 +232,7 @@ const createWebhooks = ({ deps, subscriptions, functions, schema, log, table })
 			}
 			await queueOrdered(trx, deliveries);
 			for (const { change } of failures) await dispatchChange.enqueue(trx, { change });
+			await writeHistory(trx, schema, changes.filter((change) => deps.registry.find(change.resource)?.model.history));
 			await deleteOutbox(trx, schema, rows.map((row) => row.id));
 		});
 		for (const [index, { subscription, event }] of now.entries()) report(subscription.name, event, 1, results[index]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.19.16",
+  "version": "0.21.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.19.16",
-    "@protobase/query": "0.19.16",
-    "@protobase/schema": "0.19.16",
+    "@protobase/layout": "0.21.0",
+    "@protobase/query": "0.21.0",
+    "@protobase/schema": "0.21.0",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",