@protobase/schema 0.12.20 → 0.12.22

package/dist/model.d.ts

@@ -140,8 +140,10 @@ 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. 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.
+ * a map of the records at their `latitude` and `longitude`, each opening the card of the cards display named `cards`
+ * (`map`), or a project component (`custom`) drawing the rows the list page loads. A card's `amount` is the first of its fields with
+ * a value, `footer` its fields with a value joined by bullets, and `flags` 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';
@@ -151,11 +153,21 @@ export type ListDisplayModel = {
   image?: string;
   title?: string;
   subtitle?: string;
+  amount?: string[];
   badge?: string;
   meta?: string[];
+  footer?: string[];
   flags?: string[];
   card?: string;
   photos?: CardPhotosModel;
+} | {
+  kind: 'map';
+  name: string;
+  label?: string;
+  icon?: string;
+  latitude: string;
+  longitude: string;
+  cards?: string;
 } | {
   kind: 'custom';
   name: string;

package/dist/view-displays.d.ts

@@ -18,8 +18,9 @@ export declare const tableDisplay = "table";
 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. `flags` are boolean fields shown as small badges of their labels when true, such as a garden or parking.
+   * view's title) over `subtitle`, `badge` drawn as a badge with its value labels, `amount` the first of its fields with a
+   * value in bold, such as a purchase price or a rent, and a few small `meta` fields such as dates. `footer` is a line at
+   * the card's bottom of its fields with a value, joined by bullets. `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. 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
@@ -29,13 +30,27 @@ export declare const displays: {
     image?: Ref;
     title?: Ref;
     subtitle?: Ref;
+    amount?: Ref[];
     badge?: Ref;
     meta?: Ref[];
+    footer?: Ref[];
     flags?: Ref[];
   }, o?: Naming & {
     card?: ComponentRef<never>;
     photos?: CardPhotosModel;
   }) => ListDisplayModel;
+  /**
+   * A map of the records at their `latitude` and `longitude`, in decimal degrees, drawn with the app's map style. A
+   * marker stands for the records that lie close together at the zoom; choosing it shows their card at the map's bottom,
+   * with arrows through them. The card is the one of the cards display named `cards`, the list's first cards display
+   * when it names none, or the record's title alone without one. Named `map` unless `name` says otherwise.
+   */
+  map: (fields: {
+    latitude: Ref;
+    longitude: Ref;
+  }, o?: Naming & {
+    cards?: string;
+  }) => 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.
@@ -47,6 +62,6 @@ export declare const displays: {
     props?: ViewProps<P>;
   }) => ListDisplayModel;
 };
-/** Every field a display names: what it shows, and the field references in a custom display's props. */
+/** Every field a display names: what it shows, a map's position, and the field references in a custom display's props. */
 export declare const displayFields: (display: ListDisplayModel) => string[];
 //#endregion

package/dist/view-displays.js

@@ -14,8 +14,9 @@ const customComponent = (component, where) => {
 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. `flags` are boolean fields shown as small badges of their labels when true, such as a garden or parking.
+	* view's title) over `subtitle`, `badge` drawn as a badge with its value labels, `amount` the first of its fields with a
+	* value in bold, such as a purchase price or a rent, and a few small `meta` fields such as dates. `footer` is a line at
+	* the card's bottom of its fields with a value, joined by bullets. `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. 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
@@ -28,13 +29,29 @@ const displays = {
 		...fields.image && { image: fields.image.name },
 		...fields.title && { title: fields.title.name },
 		...fields.subtitle && { subtitle: fields.subtitle.name },
+		...fields.amount && { amount: fields.amount.map((ref) => ref.name) },
 		...fields.badge && { badge: fields.badge.name },
 		...fields.meta && { meta: fields.meta.map((ref) => ref.name) },
+		...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 } }
 	}),
 	/**
+	* A map of the records at their `latitude` and `longitude`, in decimal degrees, drawn with the app's map style. A
+	* marker stands for the records that lie close together at the zoom; choosing it shows their card at the map's bottom,
+	* with arrows through them. The card is the one of the cards display named `cards`, the list's first cards display
+	* when it names none, or the record's title alone without one. Named `map` unless `name` says otherwise.
+	*/
+	map: (fields, o = {}) => ({
+		kind: "map",
+		name: o.name ?? "map",
+		...naming(o),
+		latitude: fields.latitude.name,
+		longitude: fields.longitude.name,
+		...o.cards !== void 0 && { cards: o.cards }
+	}),
+	/**
 	* 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.
 	*/
@@ -56,17 +73,24 @@ const displayErrors = (list) => {
 		...names.filter((name) => !displayName.test(name)).map((name) => `display name "${name}" must start with a lowercase letter and hold only letters, digits and dashes`),
 		...names.filter((name) => name === tableDisplay).map(() => `"${tableDisplay}" is the list's own display; give the display another name`),
 		...names.filter((name, index) => names.indexOf(name) !== index).map((name) => `display "${name}" is defined twice`),
+		...(list.displays ?? []).flatMap((display) => display.kind === "map" && display.cards !== void 0 && !list.displays.some((other) => other.kind === "cards" && other.name === display.cards) ? [`display "${display.name}" names cards "${display.cards}", which is not a cards display of the list`] : []),
 		...list.default === void 0 || list.default === "table" || names.includes(list.default) ? [] : [`default "${list.default}" is not one of the displays (${[tableDisplay, ...names].join(", ")})`]
 	];
 };
-/** Every field a display names: what it shows, and the field references in a custom display's props. */
-const displayFields = (display) => display.kind === "cards" ? [
-	display.image,
-	display.title,
-	display.subtitle,
-	display.badge,
-	...display.meta ?? [],
-	...display.flags ?? []
-].filter((name) => name !== void 0) : [...display.fields, ...fieldRefsIn(display.props)];
+/** Every field a display names: what it shows, a map's position, and the field references in a custom display's props. */
+const displayFields = (display) => {
+	if (display.kind === "map") return [display.latitude, display.longitude];
+	if (display.kind === "custom") return [...display.fields, ...fieldRefsIn(display.props)];
+	return [
+		display.image,
+		display.title,
+		display.subtitle,
+		...display.amount ?? [],
+		display.badge,
+		...display.meta ?? [],
+		...display.footer ?? [],
+		...display.flags ?? []
+	].filter((name) => name !== void 0);
+};
 //#endregion
 export { customComponent, displayErrors, displayFields, displays, tableDisplay };

package/package.json

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