@protobase/schema 0.18.0 → 0.19.1

package/dist/app-address.d.ts

@@ -19,6 +19,8 @@ export declare const addressWords: {
   readonly savedSearch: "saved_search";
   /** The second path segment that opens a resource's create form instead of a record. */
   readonly create: "new";
+  /** A record's form, `edit=true`, on a view whose record page opens as a read view or locked. */
+  readonly edit: "edit";
 };
 /** The path of `address` below `basePath` (such as `/admin`), every name and key encoded the one way the app reads them. */
 export declare const appPath: (address: AppAddress, basePath?: string) => string;

package/dist/app-address.js

@@ -18,7 +18,9 @@ const addressWords = {
 	/** The saved search a list was opened from, by its key. */
 	savedSearch: "saved_search",
 	/** The second path segment that opens a resource's create form instead of a record. */
-	create: "new"
+	create: "new",
+	/** A record's form, `edit=true`, on a view whose record page opens as a read view or locked. */
+	edit: "edit"
 };
 const listWords = [
 	"display",
@@ -54,7 +56,7 @@ const appPath = (address, basePath = "") => {
 	switch (address.kind) {
 		case "page": return `${basePath}/${encodeURIComponent(address.page)}`;
 		case "create": return `${basePath}/${encodeURIComponent(address.resource)}/${addressWords.create}${valuesQuery(address.values)}`;
-		case "record": return `${basePath}/${encodeURIComponent(address.resource)}/${encodeURIComponent(encodeKey(address.key))}`;
+		case "record": return `${basePath}/${encodeURIComponent(address.resource)}/${encodeURIComponent(encodeKey(address.key))}${address.edit ? `?${addressWords.edit}=true` : ""}`;
 		case "list": return `${basePath}/${encodeURIComponent(address.resource)}${listQuery(address)}`;
 	}
 };
@@ -96,7 +98,8 @@ const readAppPath = (pathAndQuery, pages) => {
 	if (second !== void 0) return {
 		kind: "record",
 		resource: first,
-		key: second
+		key: second,
+		...url.searchParams.get(addressWords.edit) === "true" && { edit: true }
 	};
 	const params = url.searchParams;
 	const display = params.get(addressWords.display) || void 0;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { FileOptions, FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, imageFormats } from "./files/file-options.js";
-import { ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CardFavoriteModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
+import { ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CardFavoriteModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, GalleryModel, HelpWhen, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NavModel, NavRecentModel, NowValue, OrderByItem, RecordMode, RelatedModel, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
 import { AnyField, Constraint, Field, FieldMeta, FieldTypeDef } from "./field.js";
 import { RelationField } from "./relation-field.js";
@@ -37,4 +37,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 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 Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type Constraint, 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 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 Grant, type HeldCapability, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RecordOf, type Ref, type Refs, 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 SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, 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, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, 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 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 Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type Constraint, 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 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 GalleryModel, type Grant, type HeldCapability, type HelpWhen, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RecordMode, type RecordOf, type Ref, type Refs, 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 SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, 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, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/layout.d.ts

@@ -1,4 +1,4 @@
-import { LayoutItemModel, RelatedModel } from "./model.js";
+import { CardPhotosModel, HelpWhen, LayoutItemModel, RelatedModel } from "./model.js";
 import { Ref } from "./refs.js";
 import { ComponentRef, ViewProps } from "./view-displays.js";
 //#region src/layout.d.ts
@@ -16,9 +16,25 @@ import { ComponentRef, ViewProps } from "./view-displays.js";
  * ```
  */
 export declare const layout: {
-  /** A titled group of fields in the main column, editable where the user may write; `help` is a line under the title. */
+  /**
+   * A titled group of fields in the main column, editable where the user may write; `help` is a line under the title,
+   * shown only while the record is edited with `helpWhen: 'editing'` (the view's `.helpWhen(...)` when omitted).
+   */
   section: (title: string, fields: Ref[], o?: {
     help?: string;
+    helpWhen?: HelpWhen;
+  }) => LayoutItemModel;
+  /**
+   * The record's photos as tiles in the main column, one large and the next four smaller, the last saying how many more
+   * there are, each opening a lightbox that steps through them all: first `image`, a file field of the record, then the
+   * `image` of the records of `photos.resource` whose relation `photos.field` points at the record, in `photos.sort`
+   * order, as a cards display's `photos` names them. In the lightbox, a user who may read a photo's record opens its
+   * details. Throws without `image` or `photos`. See
+   * [Galleries](website/src/content/docs/reference/ui-config.mdx#galleries).
+   */
+  gallery: (title: string, o: {
+    image?: Ref;
+    photos?: CardPhotosModel;
   }) => LayoutItemModel;
   /** A read-only summary card of fields beside the main column. */
   sidebar: (fields: Ref[]) => LayoutItemModel;

package/dist/layout.js

@@ -15,13 +15,34 @@ import { customComponent } from "./view-displays.js";
 * ```
 */
 const layout = {
-	/** A titled group of fields in the main column, editable where the user may write; `help` is a line under the title. */
+	/**
+	* A titled group of fields in the main column, editable where the user may write; `help` is a line under the title,
+	* shown only while the record is edited with `helpWhen: 'editing'` (the view's `.helpWhen(...)` when omitted).
+	*/
 	section: (title, fields, o = {}) => ({
 		kind: "section",
 		title,
 		fields: fields.map((ref) => ref.name),
-		...o.help !== void 0 && { help: o.help }
+		...o.help !== void 0 && { help: o.help },
+		...o.helpWhen !== void 0 && { helpWhen: o.helpWhen }
 	}),
+	/**
+	* The record's photos as tiles in the main column, one large and the next four smaller, the last saying how many more
+	* there are, each opening a lightbox that steps through them all: first `image`, a file field of the record, then the
+	* `image` of the records of `photos.resource` whose relation `photos.field` points at the record, in `photos.sort`
+	* order, as a cards display's `photos` names them. In the lightbox, a user who may read a photo's record opens its
+	* details. Throws without `image` or `photos`. See
+	* [Galleries](website/src/content/docs/reference/ui-config.mdx#galleries).
+	*/
+	gallery: (title, o) => {
+		if (!o.image && !o.photos) throw new Error(`l.gallery "${title}" needs an image field, photos or both`);
+		return {
+			kind: "gallery",
+			title,
+			...o.image && { image: o.image.name },
+			...o.photos && { photos: { ...o.photos } }
+		};
+	},
 	/** A read-only summary card of fields beside the main column. */
 	sidebar: (fields) => ({
 		kind: "sidebar",

package/dist/model.d.ts

@@ -188,6 +188,11 @@ export type AppAddress = {
   resource: string;
   /** The record's key: its value, or its parts for a composite key. */
   key: KeyValue | readonly KeyValue[];
+  /**
+   * The record's form, on a view whose record page opens as a read view or locked (`.recordMode(...)`): the page that
+   * Edit opens. A view whose record page is always editable ignores it.
+   */
+  edit?: boolean;
 } | {
   /** The form for a new record. */
   kind: 'create';
@@ -212,6 +217,8 @@ export type FieldViewModel = {
   label?: string;
   /** A line under the field on the record page and in forms. */
   help?: string;
+  /** When `help` shows: always, or only while the record is edited; the view's `helpWhen` when omitted. */
+  helpWhen?: HelpWhen;
   /** How the value is shown. */
   format?: FieldFormat;
   /** A text that runs over several lines: forms edit it in a box that grows with it, and its line breaks show. */
@@ -236,6 +243,12 @@ export type FieldViewModel = {
    */
   widget?: FieldWidgetModel;
 };
+/**
+ * When a help line shows: `always`, the default, or only while the record is `editing`: on its form and the create
+ * form, not on the record page's read view or its locked form. See
+ * [The record page](website/src/content/docs/reference/ui-config.mdx#the-record-page).
+ */
+export type HelpWhen = 'always' | 'editing';
 /** How a field's badges are drawn: `arrow` points them right, as on a rating scale. */
 export type BadgeShape = 'arrow';
 /** A field type by the name a plugin registers it under, and the plain data it is given. */
@@ -563,12 +576,30 @@ export type LayoutItemModel = {
   fields: string[];
   /** A line under the title. */
   help?: string;
+  /** When `help` shows: always, or only while the record is edited; the view's `helpWhen` when omitted. */
+  helpWhen?: HelpWhen;
 } | {
   /** A read-only summary card beside the main column. */
   kind: 'sidebar';
   /** The fields it shows, in order. */
   fields: string[];
-} | RelatedModel | CustomSectionModel | MapSectionModel;
+} | RelatedModel | CustomSectionModel | MapSectionModel | GalleryModel;
+/**
+ * A record's photos as tiles in the main column under `title`, one large and the next few smaller, opening a lightbox
+ * that steps through them all: first the record's own file field `image`, then the `image` of the records of
+ * `photos.resource` whose relation `photos.field` points at it, in `photos.sort` order, as a cards display's `photos`
+ * names them. See [Galleries](website/src/content/docs/reference/ui-config.mdx#galleries).
+ */
+export type GalleryModel = {
+  /** A gallery of photos. */
+  kind: 'gallery';
+  /** The section's title. */
+  title: string;
+  /** The record's own file field, shown first. */
+  image?: string;
+  /** The records holding the further photos. */
+  photos?: CardPhotosModel;
+};
 /** How far back a list's chart reaches. */
 export type ChartRange = '7d' | '30d' | '90d' | '1y' | 'all';
 /** How long each bar of a list's chart is. */
@@ -582,6 +613,13 @@ export type ChartModel = {
   /** How long each bar is. */
   granularity: ChartGranularity;
 };
+/**
+ * How the record page opens to a user who may change the record: `edit`, the default, as its form, ready to change;
+ * `read` as a read view of label/value tables, with an Edit button to the form; `locked` as the same form, locked until
+ * Edit is pressed, where reading and editing look alike. A user who may not change it sees the read view with `read`,
+ * and the locked form otherwise.
+ */
+export type RecordMode = 'edit' | 'read' | 'locked';
 /** How the record page shows that a save went through: a `toast` (the default) or on the Save `button`. */
 export type SaveFeedback = 'toast' | 'button';
 /**
@@ -775,6 +813,10 @@ export type ViewModel = {
   layout: LayoutItemModel[];
   /** A chart of records over time above the list. */
   chart?: ChartModel;
+  /** How the record page opens: as its form, a read view or a locked form; as its form when omitted. */
+  recordMode?: RecordMode;
+  /** When the help lines of its fields and sections show, unless their own `helpWhen` says; always when omitted. */
+  helpWhen?: HelpWhen;
   /** How the record page shows that a save went through. */
   saveFeedback?: SaveFeedback;
   /** The named actions of its records. */

package/dist/view-field.d.ts

@@ -1,4 +1,4 @@
-import { BadgeShape, FieldFormat, FieldViewModel, JsonValue } from "./model.js";
+import { BadgeShape, FieldFormat, FieldViewModel, HelpWhen, JsonValue } from "./model.js";
 //#region src/view-field.d.ts
 /** How a view shows one field, as `.fields((r) => ...)` hands it out: each hint returns a new field view. */
 export declare class FieldView<N extends string = string, V = unknown> {
@@ -14,8 +14,13 @@ export declare class FieldView<N extends string = string, V = unknown> {
   props?: FieldViewModel);
   /** What the field is called, instead of its name in words. */
   label(label: string): FieldView<N, V>;
-  /** A line under the field on the record page and in forms. */
-  help(help: string): FieldView<N, V>;
+  /**
+   * A line under the field on the record page and in forms; `when: 'editing'` shows it only while the record is edited,
+   * not on its read view (the view's `.helpWhen(...)` when omitted).
+   */
+  help(help: string, o?: {
+    when?: HelpWhen;
+  }): FieldView<N, V>;
   /** How the value shows: `badge` for statuses, `code` in monospace, `percent` with a % sign. */
   format(format: FieldFormat): FieldView<N, V>;
   /**

package/dist/view-field.js

@@ -13,9 +13,15 @@ var FieldView = class FieldView {
 	label(label) {
 		return this.with({ label });
 	}
-	/** A line under the field on the record page and in forms. */
-	help(help) {
-		return this.with({ help });
+	/**
+	* A line under the field on the record page and in forms; `when: 'editing'` shows it only while the record is edited,
+	* not on its read view (the view's `.helpWhen(...)` when omitted).
+	*/
+	help(help, o = {}) {
+		return this.with({
+			help,
+			...o.when !== void 0 && { helpWhen: o.when }
+		});
 	}
 	/** How the value shows: `badge` for statuses, `code` in monospace, `percent` with a % sign. */
 	format(format) {

package/dist/view.d.ts

@@ -1,4 +1,4 @@
-import { ActionModel, ChartGranularity, ChartRange, FilterWidgetModel, LayoutItemModel, ListDisplayModel, NavModel, NavRecentModel, ResourceModel, SaveFeedback, SaveSearchModel, SignInPromptModel, ViewModel } from "./model.js";
+import { ActionModel, ChartGranularity, ChartRange, FilterWidgetModel, HelpWhen, LayoutItemModel, ListDisplayModel, NavModel, NavRecentModel, RecordMode, ResourceModel, SaveFeedback, SaveSearchModel, SignInPromptModel, ViewModel } from "./model.js";
 import { FieldRefs, Ref } from "./refs.js";
 import { actions } from "./view-actions.js";
 import { displays } from "./view-displays.js";
@@ -91,6 +91,18 @@ export declare class ViewBuilder<R extends {
     range: ChartRange;
     granularity: ChartGranularity;
   }): ViewBuilder<R>;
+  /**
+   * How the record page opens to a user who may change the record: `edit`, the default, as its form; `read` as a read
+   * view, its sections as tables of labels and values, with an Edit button to the form; `locked` as the form, locked
+   * until Edit is pressed. The form has its own address (`edit: true`), so it opens in a new tab and Back leaves it. See
+   * [The record page](website/src/content/docs/reference/ui-config.mdx#read-view-and-edit).
+   */
+  recordMode(recordMode: RecordMode): ViewBuilder<R>;
+  /**
+   * When the help lines of the view's fields and sections show: `always`, the default, or only while the record is
+   * `editing`, on its form; a field's `.help(text, { when })` or a section's `helpWhen` says otherwise for its own.
+   */
+  helpWhen(helpWhen: HelpWhen): ViewBuilder<R>;
   /** Where the record page shows that it saved: a toast (the default) or the Save button. */
   saveFeedback(saveFeedback: SaveFeedback): ViewBuilder<R>;
   /**
@@ -139,7 +151,7 @@ export declare class ViewBuilder<R extends {
     };
     limit?: number;
   }): ViewBuilder<R>;
-  /** With the resource's model, also verifies the title, search result and list display fields, `listOf`, `searchesOf` and the sidebar's `recent` group. */
+  /** With the resource's model, also verifies the title, search result and list display fields, a gallery's image, `listOf`, `searchesOf` and the sidebar's `recent` group. */
   toModel(resource?: ResourceModel): ViewModel;
   private refs;
   private next;

package/dist/view.js

@@ -111,6 +111,22 @@ var ViewBuilder = class ViewBuilder {
 			granularity
 		} });
 	}
+	/**
+	* How the record page opens to a user who may change the record: `edit`, the default, as its form; `read` as a read
+	* view, its sections as tables of labels and values, with an Edit button to the form; `locked` as the form, locked
+	* until Edit is pressed. The form has its own address (`edit: true`), so it opens in a new tab and Back leaves it. See
+	* [The record page](website/src/content/docs/reference/ui-config.mdx#read-view-and-edit).
+	*/
+	recordMode(recordMode) {
+		return this.next({ recordMode });
+	}
+	/**
+	* When the help lines of the view's fields and sections show: `always`, the default, or only while the record is
+	* `editing`, on its form; a field's `.help(text, { when })` or a section's `helpWhen` says otherwise for its own.
+	*/
+	helpWhen(helpWhen) {
+		return this.next({ helpWhen });
+	}
 	/** Where the record page shows that it saved: a toast (the default) or the Save button. */
 	saveFeedback(saveFeedback) {
 		return this.next({ saveFeedback });
@@ -174,7 +190,7 @@ var ViewBuilder = class ViewBuilder {
 		};
 		return this.next({ searchesOf: searches });
 	}
-	/** With the resource's model, also verifies the title, search result and list display fields, `listOf`, `searchesOf` and the sidebar's `recent` group. */
+	/** With the resource's model, also verifies the title, search result and list display fields, a gallery's image, `listOf`, `searchesOf` and the sidebar's `recent` group. */
 	toModel(resource) {
 		const { title, nav, searchResult, list, listOf } = this.state;
 		if (resource && title !== void 0 && !Object.hasOwn(resource.fields, title)) throw new Error(`View "${this.state.resource}": title field "${title}" does not exist on the resource`);
@@ -187,6 +203,11 @@ var ViewBuilder = class ViewBuilder {
 			const flag = display.kind === "cards" ? display.flags?.find((name) => resource.fields[name].type !== "boolean") : void 0;
 			if (flag !== void 0) throw new Error(`View "${this.state.resource}": display "${display.name}" shows "${flag}" as a flag, which is not a boolean field`);
 		}
+		for (const item of resource ? this.state.layout : []) {
+			if (item.kind !== "gallery" || item.image === void 0) continue;
+			if (!Object.hasOwn(resource.fields, item.image)) throw new Error(`View "${this.state.resource}": gallery "${item.title}" names field "${item.image}", which the resource does not have`);
+			if (resource.fields[item.image].type !== "file") throw new Error(`View "${this.state.resource}": gallery "${item.title}" shows "${item.image}" as its image, which is not a file field`);
+		}
 		if (resource && listOf !== void 0 && (!Object.hasOwn(resource.fields, listOf) || resource.fields[listOf].type !== "relation")) throw new Error(`View "${this.state.resource}": listOf names "${listOf}", which is not a relation field of the resource`);
 		const searchErrors = resource && this.state.searchesOf ? searchesOfErrors(this.state.searchesOf, resource) : [];
 		if (searchErrors.length > 0) throw new Error(`View "${this.state.resource}": searchesOf ${searchErrors.join("; ")}`);

package/package.json

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