@protobase/schema 0.12.13 → 0.12.15

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-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 { 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, 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 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 };
+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 CardPhotosModel, 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

@@ -155,6 +155,7 @@ export type ListDisplayModel = {
   meta?: string[];
   flags?: string[];
   card?: string;
+  photos?: CardPhotosModel;
 } | {
   kind: 'custom';
   name: string;
@@ -164,6 +165,16 @@ export type ListDisplayModel = {
   fields: string[];
   props?: Record<string, JsonValue>;
 };
+/**
+ * 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.
+ */
+export type CardPhotosModel = {
+  resource: string;
+  field: string;
+  image: string;
+  sort?: string;
+};
 export type ListModel = {
   columns: string[];
   sort?: SortSpec;
@@ -190,6 +201,10 @@ export type FilterWidgetModel = {
 } | {
   kind: 'toggle';
   field: string;
+} | {
+  kind: 'flags';
+  fields: string[];
+  label: string;
 };
 /**
  * Records of another resource on the record page: those whose `field` holds this record's key or, with `through`,

package/dist/view-displays.d.ts

@@ -1,4 +1,4 @@
-import { ListDisplayModel } from "./model.js";
+import { 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. */
@@ -21,8 +21,9 @@ export declare const displays: {
    * view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
    * 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.
+   * 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.
    */
   cards: (fields: {
     image?: Ref;
@@ -33,6 +34,7 @@ export declare const displays: {
     flags?: Ref[];
   }, o?: Naming & {
     card?: ComponentRef<never>;
+    photos?: CardPhotosModel;
   }) => ListDisplayModel;
   /**
    * The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and

package/dist/view-displays.js

@@ -17,8 +17,9 @@ const displays = {
 	* view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
 	* 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.
+	* 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.
 	*/
 	cards: (fields, o = {}) => ({
 		kind: "cards",
@@ -30,7 +31,8 @@ const displays = {
 		...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") }
+		...o.card && { card: customComponent(o.card, "d.cards card") },
+		...o.photos && { photos: { ...o.photos } }
 	}),
 	/**
 	* The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and

package/dist/view-widgets.d.ts

@@ -12,5 +12,12 @@ export declare const widgets: {
     presets?: DatePreset[];
   }) => FilterWidgetModel;
   toggle: (ref: Ref) => FilterWidgetModel;
+  /**
+   * A menu of boolean fields under one `label`, such as "for sale" and "for rent": a record shows when any chosen field
+   * is true, so one that is both shows under each.
+   */
+  flags: (refs: Ref<string, boolean | null>[], o: {
+    label: string;
+  }) => FilterWidgetModel;
 };
 //#endregion

package/dist/view-widgets.js

@@ -18,6 +18,15 @@ const widgets = {
 	toggle: (ref) => ({
 		kind: "toggle",
 		field: ref.name
+	}),
+	/**
+	* A menu of boolean fields under one `label`, such as "for sale" and "for rent": a record shows when any chosen field
+	* is true, so one that is both shows under each.
+	*/
+	flags: (refs, o) => ({
+		kind: "flags",
+		fields: refs.map((ref) => ref.name),
+		label: o.label
 	})
 };
 //#endregion

package/package.json

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