@protobase/schema 0.8.0 → 0.8.2

package/dist/access/restrict.d.ts

@@ -4,7 +4,8 @@ import { ResolvedAccess } from "./resolve.js";
 /**
  * The resource as one user may see it: only readable fields remain, and a field is `readOnly`
  * unless it is writable on create or update. `search` (and `searchMatch`) shrinks to readable fields, and `tenant`,
- * `softDelete` and `owner` are dropped when their field is hidden. Key columns always stay,
+ * `softDelete` and `owner` are dropped when their field is hidden. The event catalogue, whose conditions may use any
+ * field, is dropped. Key columns always stay,
  * because records are addressed by them.
  *
  * Use the restricted model for everything user-facing (checking filters, sorts, queries,

package/dist/access/restrict.js

@@ -2,7 +2,8 @@
 /**
 * The resource as one user may see it: only readable fields remain, and a field is `readOnly`
 * unless it is writable on create or update. `search` (and `searchMatch`) shrinks to readable fields, and `tenant`,
-* `softDelete` and `owner` are dropped when their field is hidden. Key columns always stay,
+* `softDelete` and `owner` are dropped when their field is hidden. The event catalogue, whose conditions may use any
+* field, is dropped. Key columns always stay,
 * because records are addressed by them.
 *
 * Use the restricted model for everything user-facing (checking filters, sorts, queries,
@@ -16,7 +17,7 @@ const restrictModel = (model, access) => {
 	const keep = (name) => name !== void 0 && visible.has(name) ? name : void 0;
 	const search = model.search?.filter((name) => visible.has(name));
 	const searchMatch = model.searchMatch && Object.entries(model.searchMatch).filter(([name]) => visible.has(name));
-	const { search: _search, searchMatch: _searchMatch, tenant: _tenant, softDelete: _softDelete, owner: _owner, ...rest } = model;
+	const { search: _search, searchMatch: _searchMatch, tenant: _tenant, softDelete: _softDelete, owner: _owner, events: _events, ...rest } = model;
 	const tenant = keep(model.tenant);
 	const softDelete = keep(model.softDelete);
 	const owner = keep(model.owner);

package/dist/events/event-helpers.d.ts

@@ -0,0 +1,70 @@
+import { EventOperation } from "../model.js";
+import { Ref } from "../refs.js";
+//#region src/events/event-helpers.d.ts
+/** Who made a write through the API; writes from anywhere else have none. */
+export type EventActor = {
+  id: string | number;
+  roles: string[];
+};
+/**
+ * One record's change in one transaction, as an event's `match` sees it. Records use field names and leave out
+ * sensitive fields, whose names `changed` still lists.
+ */
+export type EventContext<R = Record<string, unknown>> = {
+  operation: EventOperation;
+  before?: Partial<R>;
+  after?: Partial<R>;
+  changed: string[];
+  /** `null` for a write made outside the API (psql, another service, a database trigger). */
+  actor: EventActor | null;
+  source: 'api' | 'database';
+  tenant?: string | number;
+  /** The writing transaction's id. */
+  transaction: string;
+};
+export type EventMatch<R> = (context: EventContext<R>) => boolean;
+/** `when` and `from` are filters in the language of access rules and views, on the record after and before the change. */
+export type CreatedOptions<R> = {
+  when?: string;
+  match?: EventMatch<R>;
+};
+export type UpdatedOptions<R> = {
+  when?: string;
+  from?: string;
+  changed?: Ref[];
+  match?: EventMatch<R>;
+};
+export type DeletedOptions<R> = {
+  from?: string;
+  match?: EventMatch<R>;
+};
+export type UndeletedOptions<R> = {
+  when?: string;
+  from?: string;
+  match?: EventMatch<R>;
+};
+/** An event as declared; `buildEventModels` checks it against the resource. */
+export type EventSpec = {
+  name: string;
+  operations: EventOperation[];
+  when?: string;
+  from?: string;
+  becomes?: string;
+  changed?: string[];
+  match?: EventMatch<any>;
+  /** Kept only when the resource soft deletes: the `undeleted` of `e.crud()`. */
+  softDeleteOnly?: true;
+};
+/** The `e` of `.events((e, r) => [...])`. Options combine with AND. */
+export declare const eventHelpers: <R>() => {
+  created: (name?: string, options?: CreatedOptions<R>) => EventSpec;
+  updated: (name?: string, options?: UpdatedOptions<R>) => EventSpec;
+  deleted: (name?: string, options?: DeletedOptions<R>) => EventSpec;
+  undeleted: (name?: string, options?: UndeletedOptions<R>) => EventSpec;
+  /** Fires when `condition` turns true: on a create that meets it, or an update after which it holds and before which it did not. */
+  becomes: (name: string, condition: string) => EventSpec;
+  /** created, updated and deleted, plus undeleted when the resource soft deletes. */
+  crud: () => EventSpec[];
+};
+export type EventHelpers<R> = ReturnType<typeof eventHelpers<R>>;
+//#endregion

package/dist/events/event-helpers.js

@@ -0,0 +1,38 @@
+//#region src/events/event-helpers.ts
+const spec = (name, operation, { changed, ...options }) => ({
+	name,
+	operations: [operation],
+	...options,
+	...changed && { changed: changed.map((ref) => ref.name) }
+});
+/** The `e` of `.events((e, r) => [...])`. Options combine with AND. */
+const eventHelpers = () => {
+	const created = (name = "created", options = {}) => spec(name, "create", options);
+	const updated = (name = "updated", options = {}) => spec(name, "update", options);
+	const deleted = (name = "deleted", options = {}) => spec(name, "delete", options);
+	const undeleted = (name = "undeleted", options = {}) => spec(name, "undelete", options);
+	return {
+		created,
+		updated,
+		deleted,
+		undeleted,
+		/** Fires when `condition` turns true: on a create that meets it, or an update after which it holds and before which it did not. */
+		becomes: (name, condition) => ({
+			name,
+			operations: ["create", "update"],
+			becomes: condition
+		}),
+		/** created, updated and deleted, plus undeleted when the resource soft deletes. */
+		crud: () => [
+			created(),
+			updated(),
+			deleted(),
+			{
+				...undeleted(),
+				softDeleteOnly: true
+			}
+		]
+	};
+};
+//#endregion
+export { eventHelpers };

package/dist/events/event-models.d.ts

@@ -0,0 +1,9 @@
+import { CheckedFilter, ResourceModel } from "../model.js";
+import "./event-helpers.js";
+//#region src/events/event-models.d.ts
+/** The filter checked against the resource, or what is wrong with it. */
+export declare const checkEventFilter: (model: ResourceModel, source: string) => {
+  filter?: CheckedFilter;
+  problem?: string;
+};
+//#endregion

package/dist/events/event-models.js

@@ -0,0 +1,69 @@
+import { parseFilter } from "../filter/parse.js";
+import { checkFilter } from "../filter/check.js";
+import { fieldsUsedBy } from "../access/resolve.js";
+//#region src/events/event-models.ts
+const namePattern = /^[a-z][a-zA-Z0-9]*$/;
+const trusted = (model) => ({
+	...model,
+	fields: Object.fromEntries(Object.entries(model.fields).map(([name, field]) => [name, {
+		...field,
+		filterable: true
+	}]))
+});
+const needsDatabase = (filter) => {
+	if (filter.kind === "and" || filter.kind === "or") return filter.args.some(needsDatabase);
+	if (filter.kind === "not") return needsDatabase(filter.arg);
+	return filter.kind === "search" || filter.kind === "similar";
+};
+/** The filter checked against the resource, or what is wrong with it. */
+const checkEventFilter = (model, source) => {
+	const parsed = parseFilter(source);
+	if (!parsed.ok) return { problem: parsed.errors[0].message };
+	if (!parsed.ast) return { problem: "is empty" };
+	const checked = checkFilter(trusted(model), parsed.ast);
+	if (!checked.ok) return { problem: checked.errors[0].message };
+	const sensitive = fieldsUsedBy(checked.filter).filter((name) => model.fields[name]?.sensitive);
+	if (sensitive.length > 0) return { problem: `uses sensitive field "${sensitive[0]}", which events never hold; use \`changed\` instead` };
+	if (needsDatabase(checked.filter)) return { problem: "uses search() or similar(), which need the database" };
+	return { filter: checked.filter };
+};
+const specProblems = (model, spec) => [
+	...namePattern.test(spec.name) ? [] : ["is not a camelCase name"],
+	...spec.operations.includes("undelete") && !model.softDelete ? ["needs a soft delete field (`.softDelete()`)"] : [],
+	...[
+		"when",
+		"from",
+		"becomes"
+	].flatMap((option) => {
+		const source = spec[option];
+		if (source === void 0) return [];
+		const { problem } = checkEventFilter(model, source);
+		return problem ? [`${option} ${problem}`] : [];
+	}),
+	...spec.changed?.length === 0 ? ["changed lists no fields"] : []
+].map((problem) => `event "${spec.name}" ${problem}`);
+const eventModel = (resource, { name, operations, when, from, becomes, changed, match }) => ({
+	name: `${resource}.${name}`,
+	operations: [...operations],
+	...when !== void 0 && { when },
+	...from !== void 0 && { from },
+	...becomes !== void 0 && { becomes },
+	...changed && { changed: [...changed] },
+	...match && { match: true }
+});
+/** The specs that apply to the resource: `e.crud()`'s undeleted only when it soft deletes. */
+const activeSpecs = (model, specs) => specs.filter((spec) => !spec.softDeleteOnly || model.softDelete);
+/** The resource's event catalogue, and what is wrong with its declarations. */
+const buildEventModels = (model, specs) => {
+	const active = activeSpecs(model, specs);
+	const names = active.map((spec) => spec.name);
+	const twice = [...new Set(names.filter((name, index) => names.indexOf(name) !== index))];
+	return {
+		events: active.map((spec) => eventModel(model.name, spec)),
+		problems: [...twice.map((name) => `event "${name}" is declared twice`), ...active.flatMap((spec) => specProblems(model, spec))]
+	};
+};
+/** The code predicates of the resource's events, by full event name. */
+const eventMatches = (model, specs) => Object.fromEntries(activeSpecs(model, specs).flatMap((spec) => spec.match ? [[`${model.name}.${spec.name}`, spec.match]] : []));
+//#endregion
+export { activeSpecs, buildEventModels, checkEventFilter, eventMatches };

package/dist/index.d.ts

@@ -1,11 +1,13 @@
-import { ActionModel, ActionRun, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, DatePreset, DurationLiteral, DurationUnit, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterOf, FilterValue, FilterWidgetModel, KeyValue, LayoutItemModel, ListModel, ListQuery, Literal, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
+import { ActionModel, ActionRun, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterOf, FilterValue, FilterWidgetModel, KeyValue, LayoutItemModel, ListModel, ListQuery, Literal, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
 import { FileProcessor, FileProcessorInput, checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { Field } from "./field.js";
 import { FileField } from "./file-field.js";
 import { f } from "./fields.js";
+import { EventActor, EventContext, EventHelpers, EventMatch, EventSpec } from "./events/event-helpers.js";
 import { InferRecord, RecordKey } from "./resource-types.js";
 import { resource } from "./resource.js";
+import { checkEventFilter } from "./events/event-models.js";
 import { view } from "./view.js";
 import { enumLabel } from "./enum-label.js";
 import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
@@ -30,4 +32,4 @@ import "./access/index.js";
 import { AssistantAction, AssistantActionRequest, AssistantCardPart, AssistantDiff, AssistantEvent, AssistantMessage, AssistantMessageRequest, AssistantPart, AssistantState, AssistantStep, AssistantStepState, AssistantTablePart, AssistantTextPart, AssistantTone, AssistantWidgetPart } from "./assistant/protocol.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, 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 Capability, type CapabilityAction, type CapabilityScope, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type DatePreset, type DurationLiteral, type DurationUnit, type EvaluateOptions, type Field, type FieldAccess, type FieldFormat, type FieldModel, type FieldPath, type FieldRule, type FieldType, type FieldViewModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type KeyType, type KeyValue, type LayoutItemModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SearchMatch, type SearchResultModel, type SearchTerm, type SortSpec, type Span, type StatusTone, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type ViewModel, accessWarnings, applyAssistantEvent, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, where };
+export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, 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 Capability, type CapabilityAction, type CapabilityScope, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type DatePreset, type DurationLiteral, type DurationUnit, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type Field, type FieldAccess, type FieldFormat, type FieldModel, type FieldPath, type FieldRule, type FieldType, type FieldViewModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type KeyType, type KeyValue, type LayoutItemModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SearchMatch, type SearchResultModel, type SearchTerm, type SortSpec, type Span, type StatusTone, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type ViewModel, accessWarnings, applyAssistantEvent, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, where };

package/dist/index.js

@@ -1,12 +1,14 @@
 import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { f } from "./fields.js";
-import { resource } from "./resource.js";
 import { parseFilter } from "./filter/parse.js";
 import { checkFilter } from "./filter/check.js";
 import { evaluateFilter } from "./filter/evaluate.js";
 import { printFilter } from "./filter/print.js";
 import { checkOrderBy, parseOrderBy, printOrderBy } from "./filter/order-by.js";
 import { createWhere, where } from "./filter/where.js";
+import { accessWarnings, checkRecord, fieldsUsedBy, resolveAccess } from "./access/resolve.js";
+import { checkEventFilter } from "./events/event-models.js";
+import { resource } from "./resource.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { view } from "./view.js";
 import { enumLabel } from "./enum-label.js";
@@ -18,7 +20,6 @@ import { rule } from "./access/rule.js";
 import { defineRoles } from "./access/roles.js";
 import { pickView } from "./access/pick-view.js";
 import { restrictModel } from "./access/restrict.js";
-import { accessWarnings, checkRecord, fieldsUsedBy, resolveAccess } from "./access/resolve.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { accessWarnings, applyAssistantEvent, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, where };
+export { accessWarnings, applyAssistantEvent, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, where };

package/dist/model.d.ts

@@ -49,6 +49,26 @@ export type ResourceModel = {
   searchMatch?: Record<string, SearchMatch>;
   /** The field holding the owning user's id; `.own` capability scopes filter on it. */
   owner?: string;
+  /** The events its changes raise (`.events()`), the catalogue subscriptions pick from. */
+  events?: EventModel[];
+};
+/** What happened to a record: `delete` and `undelete` include setting and clearing a soft delete field. */
+export type EventOperation = 'create' | 'update' | 'delete' | 'undelete';
+/**
+ * An event a resource declares. It fires for a change whose operation is listed and that passes every condition:
+ * `when` on the record after the change, `from` on the record before it, `becomes` turning true (false or no record
+ * before, true after), one of the `changed` fields changing, and a code predicate when `match` is set.
+ */
+export type EventModel = {
+  /** `<resource>.<name>`, such as `orders.created`. */
+  name: string;
+  operations: EventOperation[];
+  when?: string;
+  from?: string;
+  becomes?: string;
+  changed?: string[];
+  /** A code predicate decides too; it stays in the config. */
+  match?: true;
 };
 export type SortSpec = Array<[field: string, direction: 'asc' | 'desc']>;
 export type KeyValue = string | number;

package/dist/resource-model.d.ts

@@ -1,5 +1,6 @@
 import { SearchMatch } from "./model.js";
 import { FieldsInput } from "./refs.js";
+import { EventSpec } from "./events/event-helpers.js";
 //#region src/resource-model.d.ts
 export type ResourceState = {
   name: string;
@@ -11,5 +12,6 @@ export type ResourceState = {
   search?: string[];
   searchMatch?: Record<string, SearchMatch>;
   owner?: string;
+  events?: EventSpec[];
 };
 //#endregion

package/dist/resource-model.js

@@ -1,3 +1,4 @@
+import { buildEventModels } from "./events/event-models.js";
 import { snakeCase } from "./naming.js";
 //#region src/resource-model.ts
 const parseTable = (table) => {
@@ -87,9 +88,17 @@ const fileProblems = (model) => Object.values(model.fields).filter((field) => fi
 ].map((problem) => `file field "${field.name}" ${problem}`));
 const buildResourceModel = (state) => {
 	const model = assembleModel(state);
-	const problems = [...sensitiveProblems(model), ...fileProblems(model)];
+	const events = state.events && buildEventModels(model, state.events);
+	const problems = [
+		...sensitiveProblems(model),
+		...fileProblems(model),
+		...events?.problems ?? []
+	];
 	if (problems.length > 0) throw new Error(`Resource "${model.name}": ${problems.join("; ")}`);
-	return model;
+	return events && events.events.length > 0 ? {
+		...model,
+		events: events.events
+	} : model;
 };
 const ignoredColumns = (fields = {}) => Object.entries(fields).filter(([, field]) => field === null).map(([key]) => snakeCase(key));
 //#endregion

package/dist/resource.d.ts

@@ -1,8 +1,10 @@
 import { ResourceModel, SearchMatch } from "./model.js";
 import { FieldAccess } from "./access/types.js";
 import { FieldRefs, FieldsInput, Ref } from "./refs.js";
+import { EventHelpers, EventMatch, EventSpec } from "./events/event-helpers.js";
 import { ResourceState } from "./resource-model.js";
 import { Access, Issue, KeyRefs, RecordOf } from "./resource-types.js";
+import "./index.js";
 import { z } from "zod";
 //#region src/resource.d.ts
 type SearchRef = Ref & {
@@ -32,6 +34,13 @@ export declare class ResourceBuilder<F extends FieldsInput = {}, K = never> {
   search(pick: (r: SearchRefs<F>) => SearchRef[]): ResourceBuilder<F, K>;
   /** The field holding the owning user's id, which `.own` capability scopes filter on. */
   owner(pick: (r: FieldRefs<F>) => Ref): ResourceBuilder<F, K>;
+  /**
+   * The events changes to its records raise, captured in the database for every write, from the API or elsewhere:
+   * `(e, r) => [...e.crud(), e.becomes('large', 'total > 1000')]`.
+   */
+  events(define: (e: EventHelpers<RecordOf<F>>, r: FieldRefs<F>) => EventSpec[]): ResourceBuilder<F, K>;
+  /** The code predicates (`match`) of its events, by event name. */
+  eventMatches(): Record<string, EventMatch<any>>;
   validate(validator: Validator<F>): ResourceBuilder<F, K>;
   access(rules: Access<F>): ResourceBuilder<F, K>;
   /** Role-based rules per field, for fields that declared `.access(...)`. */

package/dist/resource.js

@@ -1,3 +1,5 @@
+import { eventHelpers } from "./events/event-helpers.js";
+import { eventMatches } from "./events/event-models.js";
 import { buildResourceModel, ignoredColumns } from "./resource-model.js";
 import { createRefs } from "./refs.js";
 import { z } from "zod";
@@ -56,6 +58,17 @@ var ResourceBuilder = class ResourceBuilder {
 	owner(pick) {
 		return this.next({ owner: pick(this.refs()).name });
 	}
+	/**
+	* The events changes to its records raise, captured in the database for every write, from the API or elsewhere:
+	* `(e, r) => [...e.crud(), e.becomes('large', 'total > 1000')]`.
+	*/
+	events(define) {
+		return this.next({ events: define(eventHelpers(), this.refs()) });
+	}
+	/** The code predicates (`match`) of its events, by event name. */
+	eventMatches() {
+		return eventMatches(this.toModel(), this.state.events ?? []);
+	}
 	validate(validator) {
 		return new ResourceBuilder(this.state, [...this.validators, validator], this.accessRules);
 	}

package/package.json

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