@protobase/schema 0.23.4 → 0.23.6

package/dist/computed/computed-problems.js

@@ -0,0 +1,51 @@
+import { formulaFields, formulaNullable, parseFormula } from "./formula.js";
+//#region src/computed/computed-problems.ts
+const numberTypes = [
+	"integer",
+	"bigint",
+	"decimal"
+];
+const writtenProblems = (model, field) => [
+	...field.sensitive ? ["cannot be sensitive"] : [],
+	...field.ai ? ["cannot be an AI field"] : [],
+	...field.file ? ["cannot be a file"] : [],
+	...field.default ? ["cannot have a default, as the database computes it"] : [],
+	...[
+		...model.primaryKey,
+		model.tenant,
+		model.owner,
+		model.softDelete
+	].includes(field.name) ? ["cannot be a key, tenant, owner or soft delete field"] : []
+];
+const rollupProblems = (model, field) => {
+	const { fn } = field.rollup;
+	return [
+		...field.formula !== void 0 ? ["cannot be a formula too"] : [],
+		...numberTypes.includes(field.type) ? [] : [`is ${field.type}, not an integer, bigint or decimal`],
+		...fn === "count" && field.type === "decimal" ? ["counts, so it is an integer or bigint"] : [],
+		...fn === "avg" && field.type !== "decimal" ? ["takes an average, so it is a decimal"] : [],
+		...(fn === "avg" || fn === "min" || fn === "max") && !field.nullable ? [`must be optional(), as its ${fn} is empty without records`] : [],
+		...writtenProblems(model, field)
+	].map((problem) => `rollup field "${field.name}" ${problem}`);
+};
+const formulaProblems = (model, field) => {
+	const node = parseFormula(field.formula);
+	const read = (name) => Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	return [
+		...numberTypes.includes(field.type) ? [] : [`is ${field.type}, not an integer, bigint or decimal`],
+		...formulaFields(node).flatMap((name) => {
+			const other = read(name);
+			if (!other) return [`reads "${name}", which is not a field`];
+			if (name === field.name) return [`reads "${name}", itself`];
+			if (other.formula !== void 0) return [`reads "${name}", which is a formula too`];
+			if (other.sensitive) return [`reads "${name}", which is sensitive`];
+			return numberTypes.includes(other.type) ? [] : [`reads "${name}", which is ${other.type}, not a number`];
+		}),
+		...!field.nullable && formulaNullable(node, (name) => read(name)?.nullable ?? false) ? ["must be optional(), or coalesce() the optional fields it reads"] : [],
+		...writtenProblems(model, field)
+	].map((problem) => `formula field "${field.name}" ${problem}`);
+};
+/** What is wrong with a resource's rollup and formula fields, as far as the resource alone tells. */
+const computedProblems = (model) => Object.values(model.fields).flatMap((field) => [...field.rollup ? rollupProblems(model, field) : [], ...field.formula !== void 0 ? formulaProblems(model, field) : []]);
+//#endregion
+export { computedProblems };

package/dist/computed/formula.d.ts

@@ -0,0 +1,30 @@
+//#region src/computed/formula.d.ts
+/**
+ * A formula as {@link parseFormula} reads it: numbers, the record's fields, `+ - * /`, a leading minus, parentheses,
+ * `coalesce(a, b, ...)` and `round(x)` or `round(x, digits)`.
+ */
+export type FormulaNode = {
+  kind: 'number';
+  value: string;
+} | {
+  kind: 'field';
+  name: string;
+} | {
+  kind: 'negate';
+  operand: FormulaNode;
+} | {
+  kind: 'binary';
+  op: '+' | '-' | '*' | '/';
+  left: FormulaNode;
+  right: FormulaNode;
+} | {
+  kind: 'coalesce';
+  args: FormulaNode[];
+} | {
+  kind: 'round';
+  value: FormulaNode;
+  digits?: number;
+};
+/** Reads a formula, or throws naming what it cannot read. */
+export declare const parseFormula: (source: string) => FormulaNode;
+//#endregion

package/dist/computed/formula.js

@@ -0,0 +1,162 @@
+//#region src/computed/formula.ts
+const tokenPattern = /\s*(?:(\d+(?:\.\d+)?)|([A-Za-z_][A-Za-z0-9_]*)|([-+*/(),]))/y;
+const tokenize = (source) => {
+	const tokens = [];
+	tokenPattern.lastIndex = 0;
+	while (tokenPattern.lastIndex < source.length) {
+		const at = tokenPattern.lastIndex;
+		const match = tokenPattern.exec(source);
+		if (!match) {
+			const rest = source.slice(at);
+			if (rest.trim() === "") break;
+			const skipped = rest.length - rest.trimStart().length;
+			throw new Error(`Formula "${source}": unexpected "${rest[skipped]}" at ${at + skipped + 1}`);
+		}
+		const [whole, number, name, symbol] = match;
+		const text = number ?? name ?? symbol;
+		tokens.push({
+			kind: number !== void 0 ? "number" : name !== void 0 ? "name" : "symbol",
+			text,
+			at: at + whole.length - text.length
+		});
+	}
+	return tokens;
+};
+/** Reads a formula, or throws naming what it cannot read. */
+const parseFormula = (source) => {
+	const tokens = tokenize(source);
+	let position = 0;
+	const fail = (what) => {
+		const token = tokens[position];
+		throw new Error(`Formula "${source}": ${what}${token ? ` at ${token.at + 1}, found "${token.text}"` : " at the end"}`);
+	};
+	const peek = (text) => tokens[position]?.kind === "symbol" && tokens[position].text === text;
+	const expect = (text) => {
+		if (!peek(text)) fail(`expected "${text}"`);
+		position += 1;
+	};
+	const args = () => {
+		expect("(");
+		const list = [sum()];
+		while (peek(",")) {
+			position += 1;
+			list.push(sum());
+		}
+		expect(")");
+		return list;
+	};
+	const call = (name) => {
+		if (name === "coalesce") {
+			const list = args();
+			if (list.length < 2) fail("coalesce() takes at least two values");
+			return {
+				kind: "coalesce",
+				args: list
+			};
+		}
+		const list = args();
+		const [value, digits] = list;
+		if (list.length > 2) fail("round() takes a value and at most a number of digits");
+		if (digits === void 0) return {
+			kind: "round",
+			value
+		};
+		if (digits.kind !== "number" || digits.value.includes(".")) fail("round()'s digits must be a whole number");
+		return {
+			kind: "round",
+			value,
+			digits: Number(digits.value)
+		};
+	};
+	const operand = () => {
+		const token = tokens[position];
+		if (!token) return fail("expected a number, a field or \"(\"");
+		if (token.kind === "number") {
+			position += 1;
+			return {
+				kind: "number",
+				value: token.text
+			};
+		}
+		if (token.kind === "name") {
+			position += 1;
+			if (!peek("(")) return {
+				kind: "field",
+				name: token.text
+			};
+			if (token.text !== "coalesce" && token.text !== "round") {
+				position -= 1;
+				return fail(`unknown function "${token.text}", only coalesce() and round()`);
+			}
+			return call(token.text);
+		}
+		if (token.text === "-") {
+			position += 1;
+			return {
+				kind: "negate",
+				operand: operand()
+			};
+		}
+		if (token.text === "(") {
+			position += 1;
+			const inner = sum();
+			expect(")");
+			return inner;
+		}
+		return fail("expected a number, a field or \"(\"");
+	};
+	const product = () => {
+		let node = operand();
+		while (peek("*") || peek("/")) {
+			const op = tokens[position].text;
+			position += 1;
+			node = {
+				kind: "binary",
+				op,
+				left: node,
+				right: operand()
+			};
+		}
+		return node;
+	};
+	const sum = () => {
+		let node = product();
+		while (peek("+") || peek("-")) {
+			const op = tokens[position].text;
+			position += 1;
+			node = {
+				kind: "binary",
+				op,
+				left: node,
+				right: product()
+			};
+		}
+		return node;
+	};
+	const node = sum();
+	if (position < tokens.length) fail("expected an operator");
+	return node;
+};
+/** The fields a formula reads, each once, in the order it names them. */
+const formulaFields = (node) => {
+	const names = (part) => {
+		if (part.kind === "field") return [part.name];
+		if (part.kind === "number") return [];
+		if (part.kind === "negate") return names(part.operand);
+		if (part.kind === "binary") return [...names(part.left), ...names(part.right)];
+		if (part.kind === "coalesce") return part.args.flatMap(names);
+		return names(part.value);
+	};
+	return [...new Set(names(node))];
+};
+/** Whether a formula can be empty: when a field it needs is, unless `coalesce()` has a value that is not. */
+const formulaNullable = (node, nullable) => {
+	if (node.kind === "field") return nullable(node.name);
+	if (node.kind === "number") return false;
+	if (node.kind === "negate") return formulaNullable(node.operand, nullable);
+	if (node.kind === "binary") return formulaNullable(node.left, nullable) || formulaNullable(node.right, nullable);
+	if (node.kind === "coalesce") return node.args.every((arg) => formulaNullable(arg, nullable));
+	return formulaNullable(node.value, nullable);
+};
+//#endregion
+export { formulaFields, formulaNullable, parseFormula };

package/dist/computed/rollup.d.ts

@@ -0,0 +1,27 @@
+//#region src/computed/rollup.d.ts
+/** What a rollup computes over the other resource's records: how many there are, or the sum, average, least or greatest of a field. */
+export type RollupFn = 'count' | 'sum' | 'avg' | 'min' | 'max';
+/** Which records a rollup reads (`.rollup()`). */
+export type RollupSource = {
+  /** The resource whose records it reads. */
+  from: string;
+  /** The relation field of `from` that points at this resource: the records whose `via` is this record count. */
+  via: string;
+};
+/** A rollup that counts the records, or with `field` those where it is not empty. */
+export type RollupCount = RollupSource & {
+  /** Counts the records. */
+  fn: 'count';
+  /** The field of `from` that must not be empty for a record to count. */
+  field?: string;
+};
+/** A rollup of the values of a field of the records. */
+export type RollupValue = RollupSource & {
+  /** The sum, average, least or greatest value of `field`. */
+  fn: Exclude<RollupFn, 'count'>;
+  /** The number field of `from` it takes. */
+  field: string;
+};
+/** A rollup's source and what it computes (`.rollup()`). */
+export type Rollup = RollupCount | RollupValue;
+//#endregion

package/dist/field.d.ts

@@ -1,3 +1,4 @@
+import { Rollup } from "./computed/rollup.js";
 import { FileOptions } from "./files/file-options.js";
 import { FieldType } from "./model.js";
 import { FieldAccess } from "./access/types.js";
@@ -62,6 +63,10 @@ export type FieldMeta = {
     /** The prompt the job fills it from. */
     prompt: string;
   };
+  /** What the database keeps it from: the records of another resource (`.rollup()`). */
+  rollup?: Rollup;
+  /** The expression the database computes it from, over the record's other fields (`.formula()`). */
+  formula?: string;
 };
 /** A field type: its name, the constraints it takes and how it builds the schema that checks a value. */
 export type FieldTypeDef = {
@@ -127,6 +132,30 @@ export declare class Field<V> {
   ai(o: {
     prompt: string;
   }): Field<V>;
+  /**
+   * The database keeps the field: a column a trigger on `from`'s table sets to `fn` of the records whose `via` points at
+   * this record, in the transaction that writes them. `count` and `sum` are 0 without records; `avg`, `min` and `max`
+   * are empty, so their fields are `.optional()`. Empty values are left out, as in SQL. Read-only; `protobase migration`
+   * writes the column and its trigger. See [Rollups and formulas](website/src/content/docs/reference/data-config.mdx#rollups-and-formulas).
+   *
+   * @example
+   * ```ts
+   * total: f.decimal({ precision: 12, scale: 2 }).rollup({ from: 'order_lines', via: 'order_id', fn: 'sum', field: 'amount' }),
+   * ```
+   */
+  rollup(o: Rollup): Field<V>;
+  /**
+   * The database computes the field from the record's other number fields: a generated column. `expression` takes
+   * numbers, fields, `+ - * /`, parentheses, `coalesce(a, b, ...)` and `round(x, digits)`, computed exactly as decimals and
+   * stored as the field's type. Read-only; `protobase migration` writes the column. See
+   * [Rollups and formulas](website/src/content/docs/reference/data-config.mdx#rollups-and-formulas).
+   *
+   * @example
+   * ```ts
+   * amount: f.decimal({ precision: 12, scale: 2 }).formula('round(quantity * unit_price, 2)'),
+   * ```
+   */
+  formula(expression: string): Field<V>;
   /** A copy of the field with `patch` applied, which every option returns. */
   protected with(patch: Partial<FieldMeta>): Field<V>;
   private constrain;

package/dist/field.js

@@ -1,4 +1,5 @@
 import { promptError } from "./ai-prompt.js";
+import { parseFormula } from "./computed/formula.js";
 import { z } from "zod";
 //#region src/field.ts
 const fieldRegistry = z.registry();
@@ -95,6 +96,41 @@ var Field = class Field {
 		if (error) throw new Error(`.ai(): ${error}`);
 		return this.with({ ai: { prompt: o.prompt } });
 	}
+	/**
+	* The database keeps the field: a column a trigger on `from`'s table sets to `fn` of the records whose `via` points at
+	* this record, in the transaction that writes them. `count` and `sum` are 0 without records; `avg`, `min` and `max`
+	* are empty, so their fields are `.optional()`. Empty values are left out, as in SQL. Read-only; `protobase migration`
+	* writes the column and its trigger. See [Rollups and formulas](website/src/content/docs/reference/data-config.mdx#rollups-and-formulas).
+	*
+	* @example
+	* ```ts
+	* total: f.decimal({ precision: 12, scale: 2 }).rollup({ from: 'order_lines', via: 'order_id', fn: 'sum', field: 'amount' }),
+	* ```
+	*/
+	rollup(o) {
+		return this.with({
+			rollup: { ...o },
+			readOnly: true
+		});
+	}
+	/**
+	* The database computes the field from the record's other number fields: a generated column. `expression` takes
+	* numbers, fields, `+ - * /`, parentheses, `coalesce(a, b, ...)` and `round(x, digits)`, computed exactly as decimals and
+	* stored as the field's type. Read-only; `protobase migration` writes the column. See
+	* [Rollups and formulas](website/src/content/docs/reference/data-config.mdx#rollups-and-formulas).
+	*
+	* @example
+	* ```ts
+	* amount: f.decimal({ precision: 12, scale: 2 }).formula('round(quantity * unit_price, 2)'),
+	* ```
+	*/
+	formula(expression) {
+		parseFormula(expression);
+		return this.with({
+			formula: expression,
+			readOnly: true
+		});
+	}
 	/** A copy of the field with `patch` applied, which every option returns. */
 	with(patch) {
 		return new Field(this.def, {

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Rollup, RollupCount, RollupFn, RollupSource, RollupValue } from "./computed/rollup.js";
 import { FileOptions, FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, imageFormats } from "./files/file-options.js";
 import { ActionInputKind, ActionInputModel, ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CalendarView, CardFavoriteModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CommentsSectionModel, CompareOp, CreateModel, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, ExportModel, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, FormModel, GalleryModel, GroupChartModel, GroupItemModel, GroupModel, HelpWhen, HistorySectionModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NamedListModel, NavModel, NavRecentModel, NowValue, OrderByItem, PeriodChartModel, RecordMode, RecordWhen, RelatedColumnModel, RelatedModel, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
@@ -42,4 +43,4 @@ import { AccessSource, ResolveOptions, ResolvedAccess, RowFilterOperation, acces
 import { restrictModel } from "./access/restrict.js";
 import "./access/index.js";
 import { AssistantAction, AssistantActionRequest, AssistantCardPart, AssistantDiff, AssistantEvent, AssistantMessage, AssistantMessageRequest, AssistantPart, AssistantState, AssistantStep, AssistantStepState, AssistantTablePart, AssistantTextPart, AssistantTone, AssistantWidgetPart } from "./assistant/protocol.js";
-export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionInputKind, type ActionInputModel, type ActionModel, type ActionRun, type AnyField, type AppAddress, type AssistantAction, type AssistantActionRequest, type AssistantCardPart, type AssistantDiff, type AssistantEvent, type AssistantMessage, type AssistantMessageRequest, type AssistantPart, type AssistantState, type AssistantStep, type AssistantStepState, type AssistantTablePart, type AssistantTextPart, type AssistantTone, type AssistantWidgetPart, type BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type CalendarView, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartInput, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CommentsSectionModel, type CompareOp, type ComponentRef, type Constraint, type CreateModel, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, type DurationLiteral, type DurationUnit, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type ExportModel, type Field, type FieldAccess, type FieldFormat, type FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type FormAddress, type FormInput, type FormModel, type GalleryModel, type Grant, type GroupChartInput, type GroupChartModel, type GroupItemModel, type GroupModel, type HeldCapability, type HelpWhen, type HistorySectionModel, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListColumn, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PeriodChartInput, type PeriodChartModel, type RecordKey, type RecordMode, type RecordOf, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, type RelatedModel, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SectionModel, type SectionPresentation, type ShowWhen, type SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, type TabItemModel, type TabModel, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readFormAddress, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };
+export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionInputKind, type ActionInputModel, type ActionModel, type ActionRun, type AnyField, type AppAddress, type AssistantAction, type AssistantActionRequest, type AssistantCardPart, type AssistantDiff, type AssistantEvent, type AssistantMessage, type AssistantMessageRequest, type AssistantPart, type AssistantState, type AssistantStep, type AssistantStepState, type AssistantTablePart, type AssistantTextPart, type AssistantTone, type AssistantWidgetPart, type BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type CalendarView, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartInput, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CommentsSectionModel, type CompareOp, type ComponentRef, type Constraint, type CreateModel, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, type DurationLiteral, type DurationUnit, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type ExportModel, type Field, type FieldAccess, type FieldFormat, type FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type FormAddress, type FormInput, type FormModel, type GalleryModel, type Grant, type GroupChartInput, type GroupChartModel, type GroupItemModel, type GroupModel, type HeldCapability, type HelpWhen, type HistorySectionModel, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListColumn, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PeriodChartInput, type PeriodChartModel, type RecordKey, type RecordMode, type RecordOf, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, type RelatedModel, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type Rollup, type RollupCount, type RollupFn, type RollupSource, type RollupValue, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SectionModel, type SectionPresentation, type ShowWhen, type SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, type TabItemModel, type TabModel, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readFormAddress, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/internal.d.ts

@@ -15,9 +15,11 @@ import { redactSecrets } from "./redact-secrets.js";
 import { updateSetErrors, updateValues } from "./update-set.js";
 import { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError } from "./address-template.js";
 import { promptError, promptFields, renderPrompt } from "./ai-prompt.js";
+import { FormulaNode, parseFormula } from "./computed/formula.js";
 import { AddressCheck, addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
 import { layoutItems } from "./layout-items.js";
 import { viewOfList } from "./named-list.js";
-export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, calendarErrors, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, layoutItems, leavesApp, linkActionError, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+import { Locale, isLocale, locales, pickLocale } from "./locale.js";
+export { type AddressCheck, type FormulaNode, type Locale, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, calendarErrors, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -1,5 +1,6 @@
 import { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError } from "./address-template.js";
 import { promptError, promptFields, renderPrompt } from "./ai-prompt.js";
+import { parseFormula } from "./computed/formula.js";
 import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { checkEventFilter } from "./events/event-models.js";
@@ -20,4 +21,5 @@ import { redactSecrets } from "./redact-secrets.js";
 import { addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, calendarErrors, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, layoutItems, leavesApp, linkActionError, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+import { isLocale, locales, pickLocale } from "./locale.js";
+export { actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, calendarErrors, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/locale.d.ts

@@ -0,0 +1,11 @@
+//#region src/locale.d.ts
+/** The languages Protobase's built-in screens come in. */
+export declare const locales: readonly ["en", "nl"];
+export type Locale = (typeof locales)[number];
+export declare const isLocale: (value: unknown) => value is Locale;
+/**
+ * The first of `preferred`, language tags such as the browser's `nl-BE` or `en`, whose language the screens come in;
+ * English when none is.
+ */
+export declare const pickLocale: (preferred: readonly string[]) => Locale;
+//#endregion

package/dist/locale.js

@@ -0,0 +1,13 @@
+//#region src/locale.ts
+/** The languages Protobase's built-in screens come in. */
+const locales = ["en", "nl"];
+const isLocale = (value) => locales.includes(value);
+/**
+* The first of `preferred`, language tags such as the browser's `nl-BE` or `en`, whose language the screens come in;
+* English when none is.
+*/
+const pickLocale = (preferred) => {
+	return preferred.map((tag) => tag.split("-")[0].toLowerCase()).find(isLocale) ?? "en";
+};
+//#endregion
+export { isLocale, locales, pickLocale };

package/dist/model.d.ts

@@ -1,3 +1,4 @@
+import { Rollup } from "./computed/rollup.js";
 import { ImageVariant } from "./files/file-options.js";
 //#region src/model.d.ts
 /** A field's storage type, as `f.*` declares it; see [Field types](website/src/content/docs/reference/data-config.mdx#field-types). */
@@ -49,6 +50,17 @@ export type FieldModel = {
     /** The prompt, with `{field}` placeholders. */
     prompt: string;
   };
+  /** The database keeps it from the records of another resource (`.rollup()`). */
+  rollup?: Rollup;
+  /** The database computes it from the record's other fields (`.formula()`). */
+  formula?: string;
+  /** A rollup's or formula's decimal, for the column `protobase migration` adds. */
+  decimal?: {
+    /** Its number of digits. */
+    precision: number;
+    /** Its number of digits after the point. */
+    scale: number;
+  };
 };
 /** A file field's settings, as `/meta` gives them; see [Files](website/src/content/docs/reference/files.mdx). */
 export type FileFieldModel = {

package/dist/resource-model.js

@@ -1,5 +1,6 @@
 import { promptFields } from "./ai-prompt.js";
 import { buildEventModels } from "./events/event-models.js";
+import { computedProblems } from "./computed/computed-problems.js";
 import { snakeCase } from "./naming.js";
 //#region src/resource-model.ts
 const parseTable = (table) => {
@@ -42,7 +43,13 @@ const fieldModel = (name, field) => {
 			...meta.file.original && { original: { ...meta.file.original } },
 			...meta.file.external && { external: true }
 		} },
-		...meta.ai && { ai: { prompt: meta.ai.prompt } }
+		...meta.ai && { ai: { prompt: meta.ai.prompt } },
+		...meta.rollup && { rollup: { ...meta.rollup } },
+		...meta.formula !== void 0 && { formula: meta.formula },
+		...(meta.rollup || meta.formula !== void 0) && meta.precision !== void 0 && { decimal: {
+			precision: meta.precision,
+			scale: meta.scale
+		} }
 	};
 };
 const assembleModel = (state) => {
@@ -143,6 +150,7 @@ const buildResourceModel = (state) => {
 		...fileProblems(model),
 		...positionProblems(model),
 		...aiProblems(model),
+		...computedProblems(model),
 		...events?.problems ?? []
 	];
 	if (problems.length > 0) throw new Error(`Resource "${model.name}": ${problems.join("; ")}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.23.4",
+  "version": "0.23.6",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {