@protobase/server 0.28.1 → 0.28.2

package/dist/aggregate-groups.js

@@ -13,9 +13,12 @@ const aggregateParams = z.object({
 	filter: z.string().optional(),
 	sum: name.optional(),
 	average: name.optional(),
+	maximum: name.optional(),
 	limit: z.coerce.number().int().optional(),
 	label: name.optional(),
 	range: z.enum([
+		"1h",
+		"24h",
 		"7d",
 		"30d",
 		"90d",
@@ -25,6 +28,9 @@ const aggregateParams = z.object({
 	from: z.string().optional(),
 	to: z.string().optional(),
 	granularity: z.enum([
+		"minute",
+		"5_minutes",
+		"15_minutes",
 		"hour",
 		"day",
 		"week",
@@ -41,14 +47,16 @@ const invalid = (parameter, message) => badRequest("invalid-parameter", `Invalid
 	message
 }] });
 const measureOf = (params) => {
-	if (params.sum !== void 0 && params.average !== void 0) throw invalid("average", "Give sum or average, not both");
-	if (params.sum !== void 0) return {
-		kind: "sum",
-		field: params.sum
-	};
-	if (params.average !== void 0) return {
-		kind: "average",
-		field: params.average
+	const given = [
+		"sum",
+		"average",
+		"maximum"
+	].filter((kind) => params[kind] !== void 0);
+	if (given.length > 1) throw invalid(given[1], "Give one of sum, average and maximum");
+	const [kind] = given;
+	return kind === void 0 ? void 0 : {
+		kind,
+		field: params[kind]
 	};
 };
 const optionErrors = (params, dated) => {
@@ -75,7 +83,7 @@ const isDated = (model, field) => {
 };
 /**
 * Records per value of a field, or per hour, day, week, month or year of a date field with the empty ones included,
-* each with how many there are and, with `sum` or `average`, that of a numeric field. Read as a list is: the caller's
+* each with how many there are and, with `sum`, `average` or `maximum`, that of a numeric field. Read as a list is: the caller's
 * filter on the model as they see it, inside their tenant and row filter; the scan guard judges the grouped field.
 */
 const aggregate = async (deps, entry, session, input) => {

package/dist/aggregate-service.js

@@ -22,6 +22,8 @@ const seriesParams = z.object({
 	field,
 	filter,
 	range: z.enum([
+		"1h",
+		"24h",
 		"7d",
 		"30d",
 		"90d",
@@ -31,6 +33,9 @@ const seriesParams = z.object({
 	from: z.string().optional(),
 	to: z.string().optional(),
 	granularity: z.enum([
+		"minute",
+		"5_minutes",
+		"15_minutes",
 		"hour",
 		"day",
 		"week",
@@ -43,11 +48,14 @@ const histogramParams = z.object({
 	filter,
 	buckets: z.coerce.number().int().default(20)
 });
-const rangeDays = {
-	"7d": 7,
-	"30d": 30,
-	"90d": 90,
-	"1y": 365
+const hourMs = 36e5;
+const rangeMs = {
+	"1h": hourMs,
+	"24h": 24 * hourMs,
+	"7d": 168 * hourMs,
+	"30d": 720 * hourMs,
+	"90d": 2160 * hourMs,
+	"1y": 8760 * hourMs
 };
 const scoped = async (deps, entry, session, source) => {
 	const access = await requestAccess(deps, entry, session);
@@ -119,7 +127,7 @@ const seriesRange = async (deps, access, field, params, timeZone, scope) => {
 	};
 	const range = params.range ?? "30d";
 	if (range !== "all") return {
-		from: rangeStart(type, now - rangeDays[range] * 864e5, timeZone),
+		from: rangeStart(type, now - rangeMs[range], timeZone),
 		to: bound(model, field, to)
 	};
 	const lowest = await earliest(deps, access, field, scope);

package/dist/check-views.js

@@ -4,6 +4,7 @@ import { cardFavoriteErrors, favoriteOwnerErrors } from "./view-card-favorite.js
 import { saveSearchErrors, searchesOfErrors } from "./view-saved-search.js";
 import { chartErrors } from "./view-chart.js";
 import { mapDisplayErrors, mapErrors } from "./view-map.js";
+import { recordChartErrors } from "./view-record-chart.js";
 import { relatedColumnErrors } from "./view-related-column.js";
 import { editableErrors } from "./view-editable.js";
 import { actionWhenErrors, actionWhenFields } from "./view-action-when.js";
@@ -147,7 +148,7 @@ const listOfErrors = (model, name, models) => {
 * edits a list column in its cell that is not a field with an editor of one line the API may write,
 * has a section, related section or sidebar whose `when` condition names what the app does not have, a related section or related list column, a cards display's or gallery's photos or a cards display's favorite button, a `listOf`, a "Save search" button or a
 * `searchesOf` that do not fit the resources, cards
-* displays of one list that name different photos, a chart per value that cannot group or add up its fields, a map that cannot show the
+* displays of one list that name different photos, a chart per value that cannot group or add up its fields, a chart of related records that does not fit them, a map that cannot show the
 * record's position or a map display that cannot find the records in its view, a board whose columns are no filterable enum, a calendar or timeline whose dates are no filterable date or timestamp fields, a link to an address the app does not have, an action whose `when` reads what the record does not have, an AI action that cannot write its field, action inputs that do not fit, or a create page that is not one of `pages`.
 */
 const checkViews = (registry, views, pages = [], fieldTypes = {}) => {
@@ -167,7 +168,7 @@ const checkViews = (registry, views, pages = [], fieldTypes = {}) => {
 		const maps = [...layoutItems(view.layout).flatMap((item) => item.kind === "map" ? mapErrors(item, model).map((error) => `map "${item.title}": ${error}`) : []), ...(view.list?.displays ?? []).flatMap((display) => display.kind === "map" ? mapDisplayErrors(display, model).map((error) => `display "${display.name}": ${error}`) : [])];
 		const boards = (view.list?.displays ?? []).flatMap((display) => display.kind === "board" ? boardErrors(display, model).map((error) => `display "${display.name}": ${error}`) : []);
 		const calendars = (view.list?.displays ?? []).flatMap((display) => display.kind === "calendar" || display.kind === "timeline" ? datesErrors(display, model).map((error) => `display "${display.name}": ${error}`) : []);
-		const chart = view.chart ? chartErrors(view.chart, model).map((error) => `chart: ${error}`) : [];
+		const chart = [...view.chart ? chartErrors(view.chart, model).map((error) => `chart: ${error}`) : [], ...layoutItems(view.layout).flatMap((item) => item.kind === "chart" ? recordChartErrors(item, view.resource, models).map((error) => `chart "${item.title}": ${error}`) : [])];
 		const history = model.history ? [] : layoutItems(view.layout).flatMap((item) => item.kind === "history" ? [`history "${item.title}" needs .history() on resource "${view.resource}"`] : []);
 		const comments = model.comments ? [] : layoutItems(view.layout).flatMap((item) => item.kind === "comments" ? [`comments "${item.title}" needs .comments() on resource "${view.resource}"`] : []);
 		return [

package/dist/openapi/resource-paths.js

@@ -590,17 +590,21 @@ const resourcePaths = (access) => {
 			operationId: `aggregate_${entry.name}`,
 			tags: tag,
 			summary: `Totals per group of ${entry.name} records`,
-			description: "Groups the records the filter finds, its own terms on `group_by` included, by the value of a field, or by the hour, day, week, month or year of a date or timestamp field with the empty ones included. Each group has its count and, with `sum` or `average`, that of a numeric field, `null` when no record of the group has a value. Value groups come largest first. An index must serve the grouped field. A date group can be split: see `split_by`.",
+			description: "Groups the records the filter finds, its own terms on `group_by` included, by the value of a field, or by the minute, 5 or 15 minutes, hour, day, week, month or year of a date or timestamp field with the empty ones included. Each group has its count and, with `sum`, `average` or `maximum`, that of a numeric field, `null` when no record of the group has a value. Value groups come largest first. An index must serve the grouped field. A date group can be split: see `split_by`.",
 			parameters: [
 				query("group_by", "A filterable field", { type: "string" }, true),
 				param("filter"),
 				query("sum", "A numeric field to add up per group"),
 				query("average", "A numeric field to average per group, instead of `sum`"),
+				query("maximum", "A numeric field whose largest value per group it returns, instead of `sum`"),
 				query("limit", "Most value groups to return, default 100, at most 1000", { type: "integer" }),
 				query("label", "For a relation to a single-key resource: the field of that resource whose value each group carries as `label`"),
 				query("granularity", "For a date group_by: the bucket, default day", {
 					type: "string",
 					enum: [
+						"minute",
+						"5_minutes",
+						"15_minutes",
 						"hour",
 						"day",
 						"week",
@@ -611,6 +615,8 @@ const resourcePaths = (access) => {
 				query("range", "For a date group_by: the relative range ending now (default 30d); `all` starts at the earliest row", {
 					type: "string",
 					enum: [
+						"1h",
+						"24h",
 						"7d",
 						"30d",
 						"90d",
@@ -659,6 +665,7 @@ const resourcePaths = (access) => {
 										count: { type: "integer" },
 										sum: { type: ["number", "null"] },
 										average: { type: ["number", "null"] },
+										maximum: { type: ["number", "null"] },
 										splits: {
 											type: "array",
 											description: "Only with `split_by`: the kept values that have rows in the group, in rank order",
@@ -668,7 +675,8 @@ const resourcePaths = (access) => {
 													value: {},
 													count: { type: "integer" },
 													sum: { type: ["number", "null"] },
-													average: { type: ["number", "null"] }
+													average: { type: ["number", "null"] },
+													maximum: { type: ["number", "null"] }
 												}
 											}
 										}
@@ -692,6 +700,8 @@ const resourcePaths = (access) => {
 				query("range", "Relative range ending now (default 30d); `all` starts at the earliest row", {
 					type: "string",
 					enum: [
+						"1h",
+						"24h",
 						"7d",
 						"30d",
 						"90d",
@@ -704,6 +714,9 @@ const resourcePaths = (access) => {
 				query("granularity", "Default day", {
 					type: "string",
 					enum: [
+						"minute",
+						"5_minutes",
+						"15_minutes",
 						"hour",
 						"day",
 						"week",

package/dist/view-access.js

@@ -2,6 +2,7 @@ import { openErrors, relatedErrors } from "./view-related.js";
 import { cardPhotosErrors } from "./view-card-photos.js";
 import { cardFavoriteErrors } from "./view-card-favorite.js";
 import { searchesOfFor } from "./view-saved-search.js";
+import { recordChartErrors } from "./view-record-chart.js";
 import { relatedColumnErrors } from "./view-related-column.js";
 import { actionWhenFields } from "./view-action-when.js";
 import { conditionReadable, resolveFieldPath } from "@protobase/layout";
@@ -25,6 +26,16 @@ const pruneRelated = (item, resource, models) => {
 	} : narrowed;
 	return relatedErrors(opened, resource, models).length === 0 ? opened : void 0;
 };
+const pruneRecordChart = (item, resource, models) => {
+	const target = models[item.resource];
+	const series = target ? item.series.filter((name) => Object.hasOwn(target.fields, name)) : [];
+	if (series.length === 0) return void 0;
+	const narrowed = {
+		...item,
+		series
+	};
+	return recordChartErrors(narrowed, resource, models).length === 0 ? narrowed : void 0;
+};
 const recordWhenShape = (resource, models) => shapes.map((when) => isRecordCondition(when) && !conditionReadable(when, resource, models) ? void 0 : when);
 const pruneGallery = (item, resource, model, models) => {
 	const image = item.image !== void 0 && Object.hasOwn(model.fields, item.image) ? item.image : void 0;
@@ -218,6 +229,7 @@ const layoutShape = (resource, model, models) => {
 			sidebar: shapes.data,
 			when: shapes.data
 		}, { requires: ["latitude", "longitude"] }),
+		chart: shapes.map((item) => pruneRecordChart(item, resource, models)),
 		gallery: shapes.map((item) => pruneGallery(item, resource, model, models)),
 		history: shapes.object({
 			kind: shapes.data,
@@ -336,7 +348,7 @@ const viewShape = (resource, model, models, prompted, createPages) => {
 /**
 * The view with every reference to a field the caller cannot read removed: list columns, sort, search and displays,
 * field hints, filter widgets, record sections, maps, galleries and custom components' props, the chart, title and search result, the
-* actions that set or read one, and the sidebar's `recent` group. Nothing in it may name a hidden field. Related sections, related list columns
+* actions that set or read one, and the sidebar's `recent` group. Nothing in it may name a hidden field. Related sections, charts of related records, related list columns
 * and links are checked against `models`, the caller's view of every resource, and so are `searchesOf`, cards' favorite
 * buttons and the "Save search" button; the buttons stay for a visitor when their resource is one of `prompted`, those
 * that ask the visitor to sign in. A create link may give values of any name to a resource of `createPages`, whose view

package/dist/view-record-chart.js

@@ -0,0 +1,42 @@
+import { matchErrors } from "./view-related.js";
+//#region src/view-record-chart.ts
+const numericTypes = [
+	"integer",
+	"bigint",
+	"decimal"
+];
+const ranges = [
+	"1h",
+	"24h",
+	"7d"
+];
+const atErrors = (model, name) => {
+	const field = Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	if (!field) return [`at: unknown field "${name}" on ${model.name}`];
+	if (field.type !== "timestamp") return [`at: "${name}" on ${model.name} is ${field.type}, not a timestamp`];
+	return field.filterable ? [] : [`at: "${name}" on ${model.name} is not filterable`];
+};
+const seriesErrors = (model, name) => {
+	const field = Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	if (!field) return [`series: unknown field "${name}" on ${model.name}`];
+	if (!numericTypes.includes(field.type)) return [`series: "${name}" on ${model.name} is ${field.type}, not a number`];
+	return field.sensitive ? [`series: "${name}" on ${model.name} is sensitive`] : [];
+};
+/**
+* What is wrong with a chart of related records on the record page of `resource`, against these models; empty when it
+* can be shown. Against the full models it checks the config; against a caller's models, whether that caller can use it.
+*/
+const recordChartErrors = (item, resource, models) => {
+	const owner = models[resource];
+	const target = models[item.resource];
+	if (!owner || !target) return [`unknown resource "${owner ? item.resource : resource}"`];
+	if (owner.primaryKey.length !== 1) return [`${resource} has a composite key, so a chart cannot match its records`];
+	return [
+		...matchErrors(target, item.field, resource),
+		...atErrors(target, item.at),
+		...item.series.length === 0 ? ["series: name at least one field"] : item.series.flatMap((name) => seriesErrors(target, name)),
+		...item.range === void 0 || ranges.includes(item.range) ? [] : [`range must be one of ${ranges.join(", ")}, not "${String(item.range)}"`]
+	];
+};
+//#endregion
+export { recordChartErrors };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.28.1",
+  "version": "0.28.2",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -32,9 +32,9 @@
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
     "@better-auth/sso": "^1.7.7",
-    "@protobase/layout": "0.28.1",
-    "@protobase/query": "0.28.1",
-    "@protobase/schema": "0.28.1",
+    "@protobase/layout": "0.28.2",
+    "@protobase/query": "0.28.2",
+    "@protobase/schema": "0.28.2",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",