@protobase/schema 0.12.10 → 0.12.11

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ActionModel, ActionRun, AppAddress, BottomBarItemModel, BottomBarModel, 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, 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, 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, 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";
@@ -44,4 +44,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 AddressCheck, 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 BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type CustomSectionModel, 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 FieldRefValue, type FieldRule, type FieldType, type FieldViewModel, type FieldWidgetModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type JsonValue, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PluginHost, type PluginRequirement, type PropShapes, type RecordKey, type RefShape, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type RoleEntry, type RoleLimit, 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, type ViewProps, accessWarnings, addressErrors, addressPlaceholders, addressWords, anonymousRole, appHrefError, appPath, applyAssistantEvent, bottomBar, bottomBarErrors, bottomBarFor, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, displayFields, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldRef, fieldRefsIn, fieldsUsedBy, fillAddress, hrefPlaceholders, inRange, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, pluginProblem, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, redactSecrets, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };
+export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AddressCheck, 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 ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type CustomSectionModel, 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 FieldRefValue, type FieldRule, type FieldType, type FieldViewModel, type FieldWidgetModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type JsonValue, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PluginHost, type PluginRequirement, type PropShapes, type RecordKey, type RefShape, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type RoleEntry, type RoleLimit, 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, type ViewProps, accessWarnings, addressErrors, addressPlaceholders, addressWords, anonymousRole, appHrefError, appPath, applyAssistantEvent, bottomBar, bottomBarErrors, bottomBarFor, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, displayFields, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldRef, fieldRefsIn, fieldsUsedBy, fillAddress, hrefPlaceholders, inRange, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, pluginProblem, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, redactSecrets, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };

package/dist/model.d.ts

@@ -115,15 +115,24 @@ export type FieldViewModel = {
   help?: string;
   format?: FieldFormat;
   prefix?: string;
+  /** Text after a number wherever it is shown, such as a unit: `m²` shows `120 m²`. */
+  suffix?: string;
   decimals?: number;
+  /** An icon before the value on a card's meta row, 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>;
+  /** A hex colour per enum value that fills its badge, such as `{ a: '#00a651' }`; a value without one keeps its tone. */
+  valueColors?: Record<string, string>;
+  /** `arrow` draws the field's badges as arrows pointing right, as on a rating scale such as the EU energy label. */
+  badgeShape?: BadgeShape;
   /**
    * The field type a plugin registers (`definePlugin({ fields })`) that shows and edits this field, with its props;
    * without that plugin, or for a storage type it does not show, the field shows as it would without it.
    */
   widget?: FieldWidgetModel;
 };
+export type BadgeShape = 'arrow';
 /** A field type by the name a plugin registers it under, and the plain data it is given. */
 export type FieldWidgetModel = {
   name: string;
@@ -131,7 +140,8 @@ export type FieldWidgetModel = {
 };
 /**
  * A way to show a list besides its table: a card per record, its content the built-in one or a component's (`card`),
- * or a project component (`custom`) drawing the rows the list page loads. `name` is what the address names (`?display=cards`); `label` and `icon` are its switch's.
+ * or a project component (`custom`) drawing the rows the list page loads. A card's `flags` are boolean fields shown as
+ * small badges of their labels when true. `name` is what the address names (`?display=cards`); `label` and `icon` are its switch's.
  */
 export type ListDisplayModel = {
   kind: 'cards';
@@ -143,6 +153,7 @@ export type ListDisplayModel = {
   subtitle?: string;
   badge?: string;
   meta?: string[];
+  flags?: string[];
   card?: string;
 } | {
   kind: 'custom';

package/dist/view-displays.d.ts

@@ -19,9 +19,10 @@ export declare const displays: {
   /**
    * A card per record: `image`, a file field shown as a picture across the card's top, then `title` (default: the
    * view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
-   * dates. 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. Named `cards` unless `name` says otherwise.
+   * dates. `flags` are boolean fields shown as small badges of their labels when true, such as a garden or parking.
+   * 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. Named `cards` unless `name` says
+   * otherwise.
    */
   cards: (fields: {
     image?: Ref;
@@ -29,6 +30,7 @@ export declare const displays: {
     subtitle?: Ref;
     badge?: Ref;
     meta?: Ref[];
+    flags?: Ref[];
   }, o?: Naming & {
     card?: ComponentRef<never>;
   }) => ListDisplayModel;

package/dist/view-displays.js

@@ -15,9 +15,10 @@ const displays = {
 	/**
 	* A card per record: `image`, a file field shown as a picture across the card's top, then `title` (default: the
 	* view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
-	* dates. 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. Named `cards` unless `name` says otherwise.
+	* dates. `flags` are boolean fields shown as small badges of their labels when true, such as a garden or parking.
+	* 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. Named `cards` unless `name` says
+	* otherwise.
 	*/
 	cards: (fields, o = {}) => ({
 		kind: "cards",
@@ -28,6 +29,7 @@ const displays = {
 		...fields.subtitle && { subtitle: fields.subtitle.name },
 		...fields.badge && { badge: fields.badge.name },
 		...fields.meta && { meta: fields.meta.map((ref) => ref.name) },
+		...fields.flags && { flags: fields.flags.map((ref) => ref.name) },
 		...o.card && { card: customComponent(o.card, "d.cards card") }
 	}),
 	/**
@@ -61,7 +63,8 @@ const displayFields = (display) => display.kind === "cards" ? [
 	display.title,
 	display.subtitle,
 	display.badge,
-	...display.meta ?? []
+	...display.meta ?? [],
+	...display.flags ?? []
 ].filter((name) => name !== void 0) : [...display.fields, ...fieldRefsIn(display.props)];
 //#endregion
 export { customComponent, displayErrors, displayFields, displays, tableDisplay };

package/dist/view-field.d.ts

@@ -1,4 +1,4 @@
-import { FieldFormat, FieldViewModel, JsonValue } from "./model.js";
+import { BadgeShape, FieldFormat, FieldViewModel, JsonValue } from "./model.js";
 //#region src/view-field.d.ts
 export declare class FieldView<N extends string = string, V = unknown> {
   readonly name: N;
@@ -8,9 +8,17 @@ export declare class FieldView<N extends string = string, V = unknown> {
   help(help: string): FieldView<N, V>;
   format(format: FieldFormat): FieldView<N, V>;
   prefix(prefix: string): FieldView<N, V>;
+  /** Text after a number wherever it is shown, such as a unit: `.suffix(' m²')`. */
+  suffix(suffix: string): FieldView<N, V>;
   decimals(decimals: number): FieldView<N, V>;
   /** Labels for an enum's values, such as `{ co_signer: 'Co-signer' }`; values left out read as themselves in words. */
   valueLabels(labels: { readonly [P in Extract<V, string>]?: string; }): FieldView<N, V>;
+  /** A hex colour per enum value that fills its badge, such as `{ a: '#00a651' }`; values left out keep their tone. */
+  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`. */
+  icon(icon: string): FieldView<N, V>;
   /**
    * Shows and edits the field with the field type a plugin registers under `name` (`definePlugin({ fields })`), given
    * `props`, such as `r.score.widget('rating', { max: 5 })`. Without that plugin, or when the field type does not show

package/dist/view-field.js

@@ -1,4 +1,5 @@
 //#region src/view-field.ts
+const hexColor = /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/i;
 var FieldView = class FieldView {
 	name;
 	props;
@@ -18,6 +19,10 @@ var FieldView = class FieldView {
 	prefix(prefix) {
 		return this.with({ prefix });
 	}
+	/** Text after a number wherever it is shown, such as a unit: `.suffix(' m²')`. */
+	suffix(suffix) {
+		return this.with({ suffix });
+	}
 	decimals(decimals) {
 		return this.with({ decimals });
 	}
@@ -28,6 +33,24 @@ var FieldView = class FieldView {
 			...labels
 		} });
 	}
+	/** A hex colour per enum value that fills its badge, such as `{ a: '#00a651' }`; values left out keep their tone. */
+	valueColors(colors) {
+		const entries = Object.entries(colors);
+		const wrong = entries.find(([, color]) => !hexColor.test(color));
+		if (wrong) throw new Error(`Field "${this.name}": value colour "${wrong[1]}" of "${wrong[0]}" is not a hex colour such as #00a651`);
+		return this.with({ valueColors: {
+			...this.props.valueColors,
+			...Object.fromEntries(entries)
+		} });
+	}
+	/** `arrow` draws the field's badges as arrows pointing right, as on a rating scale such as the EU energy label. */
+	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`. */
+	icon(icon) {
+		return this.with({ icon });
+	}
 	/**
 	* Shows and edits the field with the field type a plugin registers under `name` (`definePlugin({ fields })`), given
 	* `props`, such as `r.score.widget('rating', { max: 5 })`. Without that plugin, or when the field type does not show

package/dist/view.js

@@ -98,6 +98,8 @@ var ViewBuilder = class ViewBuilder {
 			const unknown = displayFields(display).find((name) => !Object.hasOwn(resource.fields, name));
 			if (unknown !== void 0) throw new Error(`View "${this.state.resource}": display "${display.name}" names field "${unknown}", which the resource does not have`);
 			if (display.kind === "cards" && display.image !== void 0 && resource.fields[display.image].type !== "file") throw new Error(`View "${this.state.resource}": display "${display.name}" shows "${display.image}" as its image, which is not a file field`);
+			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`);
 		}
 		const recentErrors = resource && nav?.recent ? navRecentErrors(nav.recent, resource) : [];
 		if (recentErrors.length > 0) throw new Error(`View "${this.state.resource}": nav.recent ${recentErrors.join("; ")}`);

package/package.json

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