@protobase/schema 0.11.1 → 0.12.0

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, 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, 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";
@@ -42,4 +42,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 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 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 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, 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, 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 BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type Capability, type CapabilityAction, 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 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, 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, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };

package/dist/model.d.ts

@@ -116,10 +116,20 @@ export type FieldViewModel = {
   decimals?: number;
   /** What an enum value reads as wherever it is shown; a value without one reads as itself in words (`enumLabel`). */
   valueLabels?: Record<string, string>;
+  /**
+   * 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;
+};
+/** A field type by the name a plugin registers it under, and the plain data it is given. */
+export type FieldWidgetModel = {
+  name: string;
+  props?: Record<string, JsonValue>;
 };
 /**
- * A way to show a list besides its table: a card per record, 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.
+ * 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.
  */
 export type ListDisplayModel = {
   kind: 'cards';
@@ -130,6 +140,7 @@ export type ListDisplayModel = {
   subtitle?: string;
   badge?: string;
   meta?: string[];
+  card?: string;
 } | {
   kind: 'custom';
   name: string;

package/dist/view-displays.d.ts

@@ -18,14 +18,18 @@ export declare const tableDisplay = "table";
 export declare const displays: {
   /**
    * A card per record: `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. Named `cards` unless `name` says otherwise.
+   * 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.
    */
   cards: (fields: {
     title?: Ref;
     subtitle?: Ref;
     badge?: Ref;
     meta?: Ref[];
-  }, o?: Naming) => ListDisplayModel;
+  }, o?: Naming & {
+    card?: ComponentRef<never>;
+  }) => ListDisplayModel;
   /**
    * The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and
    * reads the rows with `useListDisplay()`; `fields` are the fields it shows, fetched with relation names.

package/dist/view-displays.js

@@ -14,7 +14,9 @@ const customComponent = (component, where) => {
 const displays = {
 	/**
 	* A card per record: `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. Named `cards` unless `name` says otherwise.
+	* 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.
 	*/
 	cards: (fields, o = {}) => ({
 		kind: "cards",
@@ -23,7 +25,8 @@ const displays = {
 		...fields.title && { title: fields.title.name },
 		...fields.subtitle && { subtitle: fields.subtitle.name },
 		...fields.badge && { badge: fields.badge.name },
-		...fields.meta && { meta: fields.meta.map((ref) => ref.name) }
+		...fields.meta && { meta: fields.meta.map((ref) => ref.name) },
+		...o.card && { card: customComponent(o.card, "d.cards card") }
 	}),
 	/**
 	* The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and

package/dist/view-field.d.ts

@@ -1,4 +1,4 @@
-import { FieldFormat, FieldViewModel } from "./model.js";
+import { 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;
@@ -11,6 +11,12 @@ export declare class FieldView<N extends string = string, V = unknown> {
   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>;
+  /**
+   * 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
+   * this field's storage type, the field shows as it would without it.
+   */
+  widget(name: string, props?: Record<string, JsonValue>): FieldView<N, V>;
   private with;
 }
 //#endregion

package/dist/view-field.js

@@ -28,6 +28,17 @@ var FieldView = class FieldView {
 			...labels
 		} });
 	}
+	/**
+	* 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
+	* this field's storage type, the field shows as it would without it.
+	*/
+	widget(name, props) {
+		return this.with({ widget: {
+			name,
+			...props && { props }
+		} });
+	}
 	with(patch) {
 		return new FieldView(this.name, {
 			...this.props,

package/package.json

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