@protobase/schema 0.14.0 → 0.14.2

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, 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, SearchMatch, SearchResultModel, 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, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, 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";
@@ -36,4 +36,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 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 SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, 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, resolveAccess, resource, restrictModel, rule, 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 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 SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SignInPromptModel, 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, resolveAccess, resource, restrictModel, rule, userMenu, view, where };

package/dist/internal.d.ts

@@ -1,5 +1,5 @@
 import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
-import { displayFields, tableDisplay } from "./view-displays.js";
+import { cardPhotoLimit, displayFields, tableDisplay } from "./view-displays.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
 import { bottomBarFor } from "./bottom-bar.js";
 import { decodeKey, encodeKey } from "./keys.js";
@@ -14,4 +14,4 @@ import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leave
 import { AddressCheck, addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };
+export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/internal.js

@@ -3,7 +3,7 @@ import { checkEventFilter } from "./events/event-models.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
-import { displayFields, tableDisplay } from "./view-displays.js";
+import { cardPhotoLimit, displayFields, tableDisplay } from "./view-displays.js";
 import { bottomBarFor } from "./bottom-bar.js";
 import { decodeKey, encodeKey } from "./keys.js";
 import { webhookResources } from "./webhooks/webhook-resources.js";
@@ -14,4 +14,4 @@ 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 { addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };
+export { addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/model.d.ts

@@ -273,6 +273,8 @@ export type ListDisplayModel = {
   card?: string;
   /** Where the card's further photos come from. */
   photos?: CardPhotosModel;
+  /** The button in the card's top right corner that saves the record to the user's own list, such as favorites. */
+  favorite?: CardFavoriteModel;
 } | {
   /** A map of the records at their position. */
   kind: 'map';
@@ -306,7 +308,8 @@ export type ListDisplayModel = {
 };
 /**
  * Where a card's further photos come from: the records of `resource` whose relation `field` points at the card's record,
- * in `sort` order, each shown by its file field `image`. The card loads them when its arrows are first used. See
+ * in `sort` order, each shown by its file field `image`. They come with the list's records, in the same request, so
+ * an index on `field` and the sorted fields serves them. See
  * [Card photos](website/src/content/docs/reference/ui-config.mdx#card-photos).
  */
 export type CardPhotosModel = {
@@ -319,6 +322,47 @@ export type CardPhotosModel = {
   /** An AIP-132 order of the photos. */
   sort?: string;
 };
+/**
+ * The button in a card's top right corner that saves its record for the signed-in user: a record of `resource` whose
+ * relation `field` points at the card's record, created on a press and deleted on the next. The resource has an owner,
+ * so each user lists and saves their own. A visitor who is not signed in gets the resource's sign-in prompt instead
+ * (`.signIn(...)` on its view). See [Favorites](website/src/content/docs/reference/ui-config.mdx#favorites).
+ */
+export type CardFavoriteModel = {
+  /** The resource holding the saved records, such as favorites. */
+  resource: string;
+  /** Its filterable relation that points at the card's record. */
+  field: string;
+  /** The button's accessible name, pressed while the record is saved; "Favorite" when omitted. */
+  label?: string;
+};
+/**
+ * What a visitor who is not signed in is told about a resource they could use once signed in (`.signIn(...)`): on its
+ * list page, in place of the list, and in the dialog of a card's favorite button that saves to it. See
+ * [Sign-in prompts](website/src/content/docs/reference/ui-config.mdx#sign-in-prompts).
+ */
+export type SignInPromptModel = {
+  /** The heading, such as "Keep the homes you like". */
+  title: string;
+  /** A line under it, saying what signing in gives. */
+  description: string;
+  /** What the visitor can do once signed in, one short line each. */
+  benefits?: string[];
+  /** The prompt's icon, a name `icon` hints take; a sign-in icon when omitted. */
+  icon?: string;
+  /** A page where a visitor makes an account, `https:`, `http:` or `mailto:`, offered beside "Sign in"; none when omitted. */
+  signUp?: {
+    /** The button's text, such as "Create an account". */
+    label: string;
+    /** The page's address. */
+    href: string;
+  };
+};
+/** A resource a visitor cannot open until they sign in, as `/meta` names it: what its view calls it and its prompt. */
+export type SignInViewModel = Pick<ViewModel, 'resource' | 'names' | 'nav'> & {
+  /** What the visitor is told. */
+  signIn: SignInPromptModel;
+};
 /** A view's list page (`.list(...)`). */
 export type ListModel = {
   /** The table's columns, in order. */
@@ -670,6 +714,10 @@ export type ViewModel = {
   saveFeedback?: SaveFeedback;
   /** The named actions of its records. */
   actions: ActionModel[];
+  /** The relation field whose records the list page shows instead of this resource's rows, in their own view's list. */
+  listOf?: string;
+  /** What a visitor who is not signed in is told in place of the list, and by a card's favorite button that saves here. */
+  signIn?: SignInPromptModel;
 };
 /** Where a part of a filter or order stands in its text, as character offsets. */
 export type Span = {

package/dist/view-displays.d.ts

@@ -1,4 +1,4 @@
-import { CardPhotosModel, ListDisplayModel } from "./model.js";
+import { CardFavoriteModel, CardPhotosModel, ListDisplayModel } from "./model.js";
 import { Ref } from "./refs.js";
 //#region src/view-displays.d.ts
 /** A custom component as `component(name)` from `@protobase/layout` declares it. */
@@ -16,6 +16,8 @@ type Naming = {
   label?: string;
   icon?: string;
 };
+/** The most photos a card steps through, its own image among them, each marked by a dot: a list includes this many of each record's photos. */
+export declare const cardPhotoLimit = 10;
 /** The name of the list's own display, which every list has. */
 export declare const tableDisplay = "table";
 export declare const displays: {
@@ -27,7 +29,10 @@ export declare const displays: {
    * With `card`, a component of the project or a plugin draws each card's content instead, from the row of those
    * fields (`{ row }`); without it, or when it throws, the card is the built-in one. With `photos`, the built-in card's
    * picture gets arrows through the `image` of the records of another resource that point at the card's record, after
-   * its own `image`; they load when an arrow is first pressed. Named `cards` unless `name` says otherwise.
+   * its own `image`, ten pictures at most; they come with the list's records, so its dots mark the one shown from the
+   * start. A list's cards displays name the same `photos`. With `favorite`, a heart in the card's top right corner saves
+   * the record to the signed-in user's own records of another resource, such as favorites, and takes it off again; a
+   * visitor who is not signed in is told why to sign in. Named `cards` unless `name` says otherwise.
    */
   cards: (fields: {
     image?: Ref;
@@ -41,6 +46,7 @@ export declare const displays: {
   }, o?: Naming & {
     card?: ComponentRef<never>;
     photos?: CardPhotosModel;
+    favorite?: CardFavoriteModel;
   }) => ListDisplayModel;
   /**
    * A map of the records at their `latitude` and `longitude`, filterable fields in decimal degrees, drawn with the app's

package/dist/view-displays.js

@@ -4,6 +4,8 @@ const naming = ({ label, icon }) => ({
 	...label !== void 0 && { label },
 	...icon !== void 0 && { icon }
 });
+/** The most photos a card steps through, its own image among them, each marked by a dot: a list includes this many of each record's photos. */
+const cardPhotoLimit = 10;
 /** The name of the list's own display, which every list has. */
 const tableDisplay = "table";
 /** The component of a custom display or section, which must be a project's, not a built-in block. */
@@ -20,7 +22,10 @@ const displays = {
 	* With `card`, a component of the project or a plugin draws each card's content instead, from the row of those
 	* fields (`{ row }`); without it, or when it throws, the card is the built-in one. With `photos`, the built-in card's
 	* picture gets arrows through the `image` of the records of another resource that point at the card's record, after
-	* its own `image`; they load when an arrow is first pressed. Named `cards` unless `name` says otherwise.
+	* its own `image`, ten pictures at most; they come with the list's records, so its dots mark the one shown from the
+	* start. A list's cards displays name the same `photos`. With `favorite`, a heart in the card's top right corner saves
+	* the record to the signed-in user's own records of another resource, such as favorites, and takes it off again; a
+	* visitor who is not signed in is told why to sign in. Named `cards` unless `name` says otherwise.
 	*/
 	cards: (fields, o = {}) => ({
 		kind: "cards",
@@ -35,7 +40,8 @@ const displays = {
 		...fields.footer && { footer: fields.footer.map((ref) => ref.name) },
 		...fields.flags && { flags: fields.flags.map((ref) => ref.name) },
 		...o.card && { card: customComponent(o.card, "d.cards card") },
-		...o.photos && { photos: { ...o.photos } }
+		...o.photos && { photos: { ...o.photos } },
+		...o.favorite && { favorite: { ...o.favorite } }
 	}),
 	/**
 	* A map of the records at their `latitude` and `longitude`, filterable fields in decimal degrees, drawn with the app's
@@ -94,4 +100,4 @@ const displayFields = (display) => {
 	].filter((name) => name !== void 0);
 };
 //#endregion
-export { customComponent, displayErrors, displayFields, displays, tableDisplay };
+export { cardPhotoLimit, customComponent, displayErrors, displayFields, displays, tableDisplay };

package/dist/view.d.ts

@@ -1,4 +1,4 @@
-import { ActionModel, ChartGranularity, ChartRange, FilterWidgetModel, LayoutItemModel, ListDisplayModel, NavModel, NavRecentModel, ResourceModel, SaveFeedback, ViewModel } from "./model.js";
+import { ActionModel, ChartGranularity, ChartRange, FilterWidgetModel, LayoutItemModel, ListDisplayModel, NavModel, NavRecentModel, ResourceModel, SaveFeedback, SignInPromptModel, ViewModel } from "./model.js";
 import { FieldRefs, Ref } from "./refs.js";
 import { actions } from "./view-actions.js";
 import { displays } from "./view-displays.js";
@@ -98,7 +98,21 @@ export declare class ViewBuilder<R extends {
    * `a.remove` and `a.link` need no code, `a.action` runs a handler the app registers.
    */
   actions(build: (a: typeof actions) => ActionModel[]): ViewBuilder<R>;
-  /** With the resource's model, also verifies the title, search result and list display fields and the sidebar's `recent` group. */
+  /**
+   * The list page shows the records this relation field points at instead of this resource's rows, in their own view's
+   * list with its displays, filters and search: the listings among a member's favorites, say. The record pages stay this
+   * resource's. Throws in `toModel` when the field is not a relation.
+   */
+  listOf(pick: (r: FieldRefs<FieldsOf<R>>) => Ref): ViewBuilder<R>;
+  /**
+   * What a visitor who is not signed in is told about this resource, which they could use once signed in: on its list
+   * page, in place of the list, and in the dialog of a card's favorite button that saves here. The page offers "Sign
+   * in", and a page to make an account when `signUp` names one. With it, the resource keeps its place in the bottom
+   * bar and the sidebar of visitors. Throws when `signUp.href` is not `https:`, `http:` or `mailto:`. See
+   * [Sign-in prompts](website/src/content/docs/reference/ui-config.mdx#sign-in-prompts).
+   */
+  signIn(prompt: SignInPromptModel): ViewBuilder<R>;
+  /** With the resource's model, also verifies the title, search result and list display fields, `listOf` and the sidebar's `recent` group. */
   toModel(resource?: ResourceModel): ViewModel;
   private refs;
   private next;

package/dist/view.js

@@ -1,4 +1,5 @@
 import { createRefs, ref } from "./refs.js";
+import { isMenuHref } from "./menu-href.js";
 import { navRecentErrors } from "./nav-recent.js";
 import { actions } from "./view-actions.js";
 import { displayErrors, displayFields, displays } from "./view-displays.js";
@@ -111,9 +112,28 @@ var ViewBuilder = class ViewBuilder {
 	actions(build) {
 		return this.next({ actions: build(actions) });
 	}
-	/** With the resource's model, also verifies the title, search result and list display fields and the sidebar's `recent` group. */
+	/**
+	* The list page shows the records this relation field points at instead of this resource's rows, in their own view's
+	* list with its displays, filters and search: the listings among a member's favorites, say. The record pages stay this
+	* resource's. Throws in `toModel` when the field is not a relation.
+	*/
+	listOf(pick) {
+		return this.next({ listOf: pick(this.refs()).name });
+	}
+	/**
+	* What a visitor who is not signed in is told about this resource, which they could use once signed in: on its list
+	* page, in place of the list, and in the dialog of a card's favorite button that saves here. The page offers "Sign
+	* in", and a page to make an account when `signUp` names one. With it, the resource keeps its place in the bottom
+	* bar and the sidebar of visitors. Throws when `signUp.href` is not `https:`, `http:` or `mailto:`. See
+	* [Sign-in prompts](website/src/content/docs/reference/ui-config.mdx#sign-in-prompts).
+	*/
+	signIn(prompt) {
+		if (prompt.signUp && !isMenuHref(prompt.signUp.href)) throw new Error(`View "${this.state.resource}": signIn signUp.href must start with https://, http:// or mailto:`);
+		return this.next({ signIn: structuredClone(prompt) });
+	}
+	/** With the resource's model, also verifies the title, search result and list display fields, `listOf` and the sidebar's `recent` group. */
 	toModel(resource) {
-		const { title, nav, searchResult, list } = this.state;
+		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`);
 		const missing = resource ? [...searchResult?.title ?? [], ...searchResult?.subtitle ? [searchResult.subtitle] : []].filter((name) => !Object.hasOwn(resource.fields, name)) : [];
 		if (missing.length > 0) throw new Error(`View "${this.state.resource}": search result field "${missing[0]}" does not exist on the resource`);
@@ -124,6 +144,7 @@ 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`);
 		}
+		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 recentErrors = resource && nav?.recent ? navRecentErrors(nav.recent, resource) : [];
 		if (recentErrors.length > 0) throw new Error(`View "${this.state.resource}": nav.recent ${recentErrors.join("; ")}`);
 		return structuredClone(this.state);

package/package.json

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