@protobase/schema 0.19.3 → 0.19.5

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, 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 { 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, SectionPresentation, 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 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 };
+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 SectionPresentation, 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 { CardPhotosModel, HelpWhen, LayoutItemModel, RelatedModel } from "./model.js";
+import { CardPhotosModel, HelpWhen, LayoutItemModel, RelatedModel, SectionPresentation } from "./model.js";
 import { Ref } from "./refs.js";
 import { ComponentRef, ViewProps } from "./view-displays.js";
 //#region src/layout.d.ts
@@ -19,10 +19,14 @@ 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,
    * shown only while the record is edited with `helpWhen: 'editing'` (the view's `.helpWhen(...)` when omitted).
+   * `presentation: 'facts'` shows the read view's fields as a row of key facts, as a listing on a real estate site does:
+   * each value under its field's `.icon(...)`, or under its label without one, leaving out the empty ones. See
+   * [Key facts](website/src/content/docs/reference/ui-config.mdx#key-facts).
    */
   section: (title: string, fields: Ref[], o?: {
     help?: string;
     helpWhen?: HelpWhen;
+    presentation?: SectionPresentation;
   }) => LayoutItemModel;
   /**
    * The record's photos as tiles in the main column, one large and the next four smaller, the last saying how many more

package/dist/layout.js

@@ -18,13 +18,17 @@ const layout = {
 	/**
 	* 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).
+	* `presentation: 'facts'` shows the read view's fields as a row of key facts, as a listing on a real estate site does:
+	* each value under its field's `.icon(...)`, or under its label without one, leaving out the empty ones. See
+	* [Key facts](website/src/content/docs/reference/ui-config.mdx#key-facts).
 	*/
 	section: (title, fields, o = {}) => ({
 		kind: "section",
 		title,
 		fields: fields.map((ref) => ref.name),
 		...o.help !== void 0 && { help: o.help },
-		...o.helpWhen !== void 0 && { helpWhen: o.helpWhen }
+		...o.helpWhen !== void 0 && { helpWhen: o.helpWhen },
+		...o.presentation !== void 0 && { presentation: o.presentation }
 	}),
 	/**
 	* The record's photos as tiles in the main column, one large and the next four smaller, the last saying how many more

package/dist/model.d.ts

@@ -229,7 +229,10 @@ export type FieldViewModel = {
   suffix?: string;
   /** How many decimals a number shows. */
   decimals?: number;
-  /** An icon before the value on a card's meta row, by the names actions take (`ruler`); an unknown name shows none. */
+  /**
+   * An icon before the value on a card's meta row and above it in a section of key facts, by the names actions take
+   * (`ruler`); an unknown name shows none.
+   */
   icon?: string;
   /** What an enum value reads as wherever it is shown; a value without one reads as itself in words (`enumLabel`). */
   valueLabels?: Record<string, string>;
@@ -566,6 +569,8 @@ export type MapSectionModel = {
   /** Drawn as a sidebar card instead of in the main column. */
   sidebar?: true;
 };
+/** How a section shows its fields on the read view: `facts` as a row of key facts; label/value rows when omitted. */
+export type SectionPresentation = 'facts';
 /** An item of the record page (`.layout((r) => ...)` with `l`); see [The record page](website/src/content/docs/reference/ui-config.mdx#the-record-page). */
 export type LayoutItemModel = {
   /** A titled group of fields in the main column, editable where the user may write. */
@@ -578,6 +583,11 @@ export type LayoutItemModel = {
   help?: string;
   /** When `help` shows: always, or only while the record is edited; the view's `helpWhen` when omitted. */
   helpWhen?: HelpWhen;
+  /**
+   * `facts` shows the read view's fields as a row of key facts, each value under its field's `icon`, instead of
+   * label/value rows; the form edits them as any section's.
+   */
+  presentation?: SectionPresentation;
 } | {
   /** A read-only summary card beside the main column. */
   kind: 'sidebar';
@@ -654,7 +664,10 @@ export type ActionModel = {
   name: string;
   /** The button's label. */
   label: string;
-  /** The button's icon: `bed`, `bell`, `bookmark`, `external-link`, `file-text`, `heart`, `ruler`, `send` or `wallet`; another name shows a lightning bolt. */
+  /**
+   * The button's icon: `bath`, `bed`, `bell`, `bookmark`, `calendar`, `door-open`, `external-link`, `file-text`, `heart`,
+   * `house`, `key`, `land-plot`, `leaf`, `ruler`, `send`, `tag` or `wallet`; another name shows a lightning bolt.
+   */
   icon?: string;
   /** The question the button asks before it runs the action. */
   confirm?: string;
@@ -826,6 +839,8 @@ export type ViewModel = {
   signIn?: SignInPromptModel;
   /** The list page's button that saves its filter as a search of the user's own. */
   saveSearch?: SaveSearchModel;
+  /** Whether the list page offers Import, which creates or updates records from an .xlsx or CSV file; it does when omitted. */
+  import?: boolean;
   /** The list page shows the user's saved searches of another resource, each with what it finds, instead of rows. */
   searchesOf?: SearchesOfModel;
 };

package/dist/view-field.d.ts

@@ -40,7 +40,10 @@ export declare class FieldView<N extends string = string, V = unknown> {
   valueColors(colors: { readonly [P in Extract<V, string>]?: string; }): FieldView<N, V>;
   /** `arrow` draws the field's badges as arrows pointing right, as on a rating scale such as the EU energy label. */
   badgeShape(badgeShape: BadgeShape): FieldView<N, V>;
-  /** An icon before the value on a card's meta row, by the names actions take, such as `ruler`. */
+  /**
+   * An icon before the value on a card's meta row and above it in a section of key facts, by the names actions take,
+   * such as `ruler`.
+   */
   icon(icon: string): FieldView<N, V>;
   /**
    * Shows and edits the field with the field type a plugin registers under `name` (`definePlugin({ fields })`), given

package/dist/view-field.js

@@ -67,7 +67,10 @@ var FieldView = class FieldView {
 	badgeShape(badgeShape) {
 		return this.with({ badgeShape });
 	}
-	/** An icon before the value on a card's meta row, by the names actions take, such as `ruler`. */
+	/**
+	* An icon before the value on a card's meta row and above it in a section of key facts, by the names actions take,
+	* such as `ruler`.
+	*/
 	icon(icon) {
 		return this.with({ icon });
 	}

package/dist/view.d.ts

@@ -105,6 +105,12 @@ export declare class ViewBuilder<R extends {
   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>;
+  /**
+   * Whether the list page offers Import, which creates or updates records from an .xlsx or CSV file the user picks
+   * (`true`, the default, to users who may create records); `.import(false)` turns it off. See
+   * [Importing records](website/src/content/docs/reference/ui-config.mdx#importing-records).
+   */
+  import(enabled: boolean): ViewBuilder<R>;
   /**
    * The named actions of the record page's action rail, which composed pages can put on buttons too: `a.update`,
    * `a.remove` and `a.link` need no code, `a.action` runs a handler the app registers.

package/dist/view.js

@@ -132,6 +132,14 @@ var ViewBuilder = class ViewBuilder {
 		return this.next({ saveFeedback });
 	}
 	/**
+	* Whether the list page offers Import, which creates or updates records from an .xlsx or CSV file the user picks
+	* (`true`, the default, to users who may create records); `.import(false)` turns it off. See
+	* [Importing records](website/src/content/docs/reference/ui-config.mdx#importing-records).
+	*/
+	import(enabled) {
+		return this.next({ import: enabled });
+	}
+	/**
 	* The named actions of the record page's action rail, which composed pages can put on buttons too: `a.update`,
 	* `a.remove` and `a.link` need no code, `a.action` runs a handler the app registers.
 	*/

package/package.json

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