@protobase/schema 0.13.0 → 0.13.4

package/dist/app-address.d.ts

@@ -13,6 +13,8 @@ export declare const addressWords: {
   readonly display: "display";
   /** Where a list's filters sit: `bar` (the default) or `panel`. */
   readonly filterLayout: "layout";
+  /** Where a list's map display looks: `latitude,longitude,zoom`. */
+  readonly map: "map";
   /** The second path segment that opens a resource's create form instead of a record. */
   readonly create: "new";
 };

package/dist/app-address.js

@@ -13,6 +13,8 @@ const addressWords = {
 	display: "display",
 	/** Where a list's filters sit: `bar` (the default) or `panel`. */
 	filterLayout: "layout",
+	/** Where a list's map display looks: `latitude,longitude,zoom`. */
+	map: "map",
 	/** The second path segment that opens a resource's create form instead of a record. */
 	create: "new"
 };
@@ -22,12 +24,25 @@ const listWords = [
 	"orderBy",
 	"filterLayout"
 ];
+const mapText = (view) => `${view.latitude.toFixed(5)},${view.longitude.toFixed(5)},${view.zoom.toFixed(2)}`;
+const inRange = (value, limit, low = -limit) => Number.isFinite(value) && value >= low && value <= limit;
+const readMap = (text) => {
+	const parts = text?.split(",");
+	if (parts?.length !== 3 || parts.some((part) => part.trim() === "")) return void 0;
+	const [latitude, longitude, zoom] = parts.map(Number);
+	return inRange(latitude, 90) && inRange(longitude, 180) && inRange(zoom, 22, 0) ? {
+		latitude,
+		longitude,
+		zoom
+	} : void 0;
+};
 const listQuery = (address) => {
 	const query = new URLSearchParams();
 	for (const name of listWords) {
 		const value = address[name];
 		if (value !== void 0 && value !== "") query.set(addressWords[name], value);
 	}
+	if (address.map) query.set(addressWords.map, mapText(address.map));
 	const text = query.toString();
 	return text ? `?${text}` : "";
 };
@@ -85,13 +100,15 @@ const readAppPath = (pathAndQuery, pages) => {
 	const filter = params.get(addressWords.filter) || void 0;
 	const orderBy = params.get(addressWords.orderBy) || void 0;
 	const layout = filterLayout(params.get(addressWords.filterLayout));
+	const map = readMap(params.get(addressWords.map));
 	return {
 		kind: "list",
 		resource: first,
 		...display && { display },
 		...filter && { filter },
 		...orderBy && { orderBy },
-		...layout && { filterLayout: layout }
+		...layout && { filterLayout: layout },
+		...map && { map }
 	};
 };
 //#endregion

package/dist/field.d.ts

@@ -1,6 +1,6 @@
+import { FileOptions } from "./files/file-options.js";
 import { FieldType } from "./model.js";
 import { FieldAccess } from "./access/types.js";
-import { FileOptions } from "./files/file-options.js";
 import { z } from "zod";
 //#region src/field.d.ts
 export type Constraint = 'min' | 'max' | 'regex';

package/dist/file-field.d.ts

@@ -1,5 +1,5 @@
+import { FileProcessor, ImageVariant, ImageVariantOptions } from "./files/file-options.js";
 import { FieldAccess } from "./access/types.js";
-import { FileProcessor } from "./files/file-options.js";
 import { Field, FieldMeta } from "./field.js";
 //#region src/file-field.d.ts
 /** `f.file()`: a text column holding a file's URI, uploaded through `:upload`. */
@@ -17,6 +17,16 @@ export declare class FileField<V> extends Field<V> {
    * file: `{ image_width: imageSize('width') }`. Clearing the file clears them.
    */
   derive(processors: Record<string, FileProcessor>): FileField<V>;
+  /**
+   * Computes a ThumbHash of each image into a read-only text field (`photo_placeholder`), which the admin app shows
+   * while the image loads. Other files leave it null.
+   */
+  placeholder(field: string): FileField<V>;
+  /**
+   * Resized copies of each image, stored beside it under these names: `{ card: { width: 640, height: 480, fit: 'cover',
+   * format: 'webp' } }`. `{ original }` stores that image instead of the upload. Other files get none.
+   */
+  variants(variants: Record<string, ImageVariant>, options?: ImageVariantOptions): FileField<V>;
   optional(): FileField<V | null>;
   readOnly(): FileField<V>;
   column(name: string): FileField<V>;

package/dist/file-field.js

@@ -1,5 +1,5 @@
 import { Field } from "./field.js";
-import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
+import { checkedAccept, checkedProvider, checkedVariant, checkedVariants, parseSize } from "./files/file-options.js";
 //#region src/file-field.ts
 /** `f.file()`: a text column holding a file's URI, uploaded through `:upload`. */
 var FileField = class FileField extends Field {
@@ -29,6 +29,26 @@ var FileField = class FileField extends Field {
 			...processors
 		} });
 	}
+	/**
+	* Computes a ThumbHash of each image into a read-only text field (`photo_placeholder`), which the admin app shows
+	* while the image loads. Other files leave it null.
+	*/
+	placeholder(field) {
+		return this.withFile({ placeholder: field });
+	}
+	/**
+	* Resized copies of each image, stored beside it under these names: `{ card: { width: 640, height: 480, fit: 'cover',
+	* format: 'webp' } }`. `{ original }` stores that image instead of the upload. Other files get none.
+	*/
+	variants(variants, options = {}) {
+		return this.withFile({
+			variants: {
+				...this.meta.file.variants,
+				...checkedVariants(variants)
+			},
+			...options.original && { original: checkedVariant("The original", options.original) }
+		});
+	}
 	optional() {
 		return this.with({ nullable: true });
 	}

package/dist/files/file-options.d.ts

@@ -18,12 +18,35 @@ export type FileProcessor = {
   accepts?: readonly string[];
   run: (file: FileProcessorInput) => unknown;
 };
+/** The formats an image variant is written in. */
+export declare const imageFormats: readonly ["webp", "avif", "jpeg", "png"];
+export type ImageFormat = (typeof imageFormats)[number];
+/**
+ * A resized copy of an uploaded image: at most `width` by `height` pixels, never enlarged. `inside` (the default) keeps
+ * the whole image within that box, `cover` fills the box and crops what is outside it. `quality` is 1 to 100, the
+ * format's default when omitted.
+ */
+export type ImageVariant = {
+  width?: number;
+  height?: number;
+  fit?: 'inside' | 'cover';
+  format: ImageFormat;
+  quality?: number;
+};
+/** `.variants()`' second argument: `original` replaces the upload by that image, so the upload itself is not kept. */
+export type ImageVariantOptions = {
+  original?: ImageVariant;
+};
 /** A file field's settings, as the builder collects them. */
 export type FileOptions = {
   accept: string[];
   maxSize: number;
   provider: string;
   derive?: Record<string, FileProcessor>;
+  /** The read-only text field each image's ThumbHash goes to (`.placeholder()`). */
+  placeholder?: string;
+  variants?: Record<string, ImageVariant>;
+  original?: ImageVariant;
 };
 /** Bytes from a number or text such as `10 MB` (decimal units) or `5 MiB` (binary units). */
 export declare const parseSize: (size: number | string) => number;

package/dist/files/file-options.js

@@ -1,4 +1,11 @@
 //#region src/files/file-options.ts
+/** The formats an image variant is written in. */
+const imageFormats = [
+	"webp",
+	"avif",
+	"jpeg",
+	"png"
+];
 const defaultMaxSize = 5e7;
 const units = {
 	b: 1,
@@ -43,5 +50,25 @@ const checkedProvider = (name) => {
 	if (reservedProviders.has(name)) throw new Error(`"${name}" cannot name a file provider: stored values would read as ${name}: links`);
 	return name;
 };
+const variantNamePattern = /^[a-z][a-z0-9_]{0,31}$/;
+const fits = ["inside", "cover"];
+const checkedBound = (label, value) => {
+	if (value !== void 0 && (!Number.isSafeInteger(value) || value < 1 || value > 16384)) throw new Error(`${label} must be a whole number of pixels from 1 to 16384, not ${value}`);
+};
+/** A variant as written, checked: a known format and fit, and bounds and a quality in range. */
+const checkedVariant = (label, variant) => {
+	if (!imageFormats.includes(variant.format)) throw new Error(`${label}: "${variant.format}" is not an image format; use ${imageFormats.join(", ")}`);
+	if (variant.fit !== void 0 && !fits.includes(variant.fit)) throw new Error(`${label}: fit is "inside" or "cover", not "${variant.fit}"`);
+	if (variant.fit === "cover" && (variant.width === void 0 || variant.height === void 0)) throw new Error(`${label}: fit "cover" needs both a width and a height`);
+	checkedBound(`${label}: width`, variant.width);
+	checkedBound(`${label}: height`, variant.height);
+	if (variant.quality !== void 0 && (!Number.isSafeInteger(variant.quality) || variant.quality < 1 || variant.quality > 100)) throw new Error(`${label}: quality must be a whole number from 1 to 100, not ${variant.quality}`);
+	return { ...variant };
+};
+/** Variants by name: snake_case names, since each one is part of its file's path. */
+const checkedVariants = (variants) => Object.fromEntries(Object.entries(variants).map(([name, variant]) => {
+	if (!variantNamePattern.test(name)) throw new Error(`"${name}" cannot name an image variant: lowercase letters, digits and underscores, starting with a letter`);
+	return [name, checkedVariant(`Image variant "${name}"`, variant)];
+}));
 //#endregion
-export { checkedAccept, checkedProvider, defaultMaxSize, parseSize };
+export { checkedAccept, checkedProvider, checkedVariant, checkedVariants, defaultMaxSize, imageFormats, parseSize };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-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, MapSectionModel, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
+import { FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, checkedAccept, checkedProvider, imageFormats, parseSize } from "./files/file-options.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, MapSectionModel, MapView, 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";
 import { FileField } from "./file-field.js";
 import { f } from "./fields.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 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 MapSectionModel, 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 ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type JsonValue, 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 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, imageFormats, 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/index.js

@@ -1,4 +1,4 @@
-import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
+import { checkedAccept, checkedProvider, imageFormats, parseSize } from "./files/file-options.js";
 import { f } from "./fields.js";
 import { parseFilter } from "./filter/parse.js";
 import { checkFilter } from "./filter/check.js";
@@ -34,4 +34,4 @@ import { pickView } from "./access/pick-view.js";
 import { restrictModel } from "./access/restrict.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { 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 { 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, imageFormats, 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

@@ -1,3 +1,4 @@
+import { ImageVariant } from "./files/file-options.js";
 //#region src/model.d.ts
 export type FieldType = 'text' | 'integer' | 'bigint' | 'decimal' | 'boolean' | 'date' | 'timestamp' | 'uuid' | 'enum' | 'json' | 'relation' | 'file' | 'currency' | 'country';
 export type FieldModel = {
@@ -22,14 +23,21 @@ export type FieldModel = {
   } | {
     db: true;
   };
-  /** A file field's allowed types (empty: any), largest upload in bytes, provider, and the fields `.derive()` writes. */
+  /** A file field's allowed types (empty: any), largest upload in bytes, provider, and what each upload writes. */
   file?: FileFieldModel;
 };
 export type FileFieldModel = {
   accept: string[];
   maxSize: number;
   provider: string;
+  /** The fields each upload writes: those of `.derive()` and the placeholder's. */
   derive?: string[];
+  /** The text field holding each image's ThumbHash, base64 (`.placeholder()`). */
+  placeholder?: string;
+  /** The resized copies stored beside each image, by name (`.variants()`). */
+  variants?: Record<string, ImageVariant>;
+  /** What is stored instead of an uploaded image, when the upload is not kept. */
+  original?: ImageVariant;
 };
 /** `digitsEnd`: only the end of the value's digits, spaces, `+` and dashes ignored (phone numbers). */
 export type SearchMatch = 'digitsEnd';
@@ -85,10 +93,17 @@ export type ListQuery = {
   limit: number;
 };
 export type FilterLayout = 'bar' | 'panel';
+/** Where a list's map display looks: the centre in decimal degrees, and MapLibre's zoom, from 0 to 22. */
+export type MapView = {
+  latitude: number;
+  longitude: number;
+  zoom: number;
+};
 /**
  * A place in the app: a resource's list, one of its records, its create form, or a composed page. A record's `key` is
  * its one value or its parts, as the record API takes them; `readAppPath` gives it back as the API's text form. A create
- * form's `values` fill in fields of the new record by name, as text (`{ listing_id: '42' }`).
+ * form's `values` fill in fields of the new record by name, as text (`{ listing_id: '42' }`). A list's `map` is where its
+ * map display looks.
  */
 export type AppAddress = {
   kind: 'list';
@@ -97,6 +112,7 @@ export type AppAddress = {
   orderBy?: string;
   display?: string;
   filterLayout?: FilterLayout;
+  map?: MapView;
 } | {
   kind: 'record';
   resource: string;

package/dist/resource-model.js

@@ -10,6 +10,7 @@ const parseTable = (table) => {
 	};
 	throw new Error(`Invalid table "${table}", expected "table" or "schema.table"`);
 };
+const writtenFields = (file) => [...Object.keys(file.derive ?? {}), ...file.placeholder === void 0 ? [] : [file.placeholder]];
 const fieldModel = (name, field) => {
 	const { meta } = field;
 	const column = meta.column ?? snakeCase(name);
@@ -34,7 +35,10 @@ const fieldModel = (name, field) => {
 			accept: [...meta.file.accept],
 			maxSize: meta.file.maxSize,
 			provider: meta.file.provider,
-			...meta.file.derive && Object.keys(meta.file.derive).length > 0 && { derive: Object.keys(meta.file.derive) }
+			...writtenFields(meta.file).length > 0 && { derive: writtenFields(meta.file) },
+			...meta.file.placeholder !== void 0 && { placeholder: meta.file.placeholder },
+			...meta.file.variants && Object.keys(meta.file.variants).length > 0 && { variants: structuredClone(meta.file.variants) },
+			...meta.file.original && { original: { ...meta.file.original } }
 		} }
 	};
 };
@@ -84,8 +88,17 @@ const fileProblems = (model) => Object.values(model.fields).filter((field) => fi
 		if (!derived) return [`derives "${target}", which is not a field`];
 		if (target === field.name || derived.file) return [`derives "${target}", which is a file field`];
 		return derived.readOnly ? [] : [`derives "${target}", which must be readOnly()`];
-	})
+	}),
+	...placeholderProblems(model, field)
 ].map((problem) => `file field "${field.name}" ${problem}`));
+const placeholderProblems = (model, field) => {
+	const target = field.file.placeholder;
+	if (target === void 0) return [];
+	const derive = field.file.derive ?? [];
+	if (derive.indexOf(target) !== derive.lastIndexOf(target)) return [`has "${target}" as its placeholder and derives it as well`];
+	const placeholder = Object.hasOwn(model.fields, target) ? model.fields[target] : void 0;
+	return placeholder && !placeholder.file && placeholder.type !== "text" ? [`has "${target}" as its placeholder, which must be a text field`] : [];
+};
 const buildResourceModel = (state) => {
 	const model = assembleModel(state);
 	const events = state.events && buildEventModels(model, state.events);

package/dist/view-displays.d.ts

@@ -40,9 +40,10 @@ export declare const displays: {
     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
+   * A map of the records at their `latitude` and `longitude`, filterable fields in decimal degrees, drawn with the app's
+   * map style. It asks for the records in its view as it pans and zooms: from far out a count for each part of the map,
+   * which zooms in when chosen, closer in the records. 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: {

package/dist/view-displays.js

@@ -38,9 +38,10 @@ const displays = {
 		...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
+	* A map of the records at their `latitude` and `longitude`, filterable fields in decimal degrees, drawn with the app's
+	* map style. It asks for the records in its view as it pans and zooms: from far out a count for each part of the map,
+	* which zooms in when chosen, closer in the records. 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 = {}) => ({

package/package.json

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