@protobase/schema 0.15.5 → 0.16.0

package/dist/index.d.ts

@@ -20,6 +20,7 @@ import { BottomBarNames, bottomBarErrors } from "./bottom-bar-errors.js";
 import { layout } from "./layout.js";
 import { KeyType, keyTypes } from "./keys.js";
 import { addressWords, appPath, readAppPath } from "./app-address.js";
+import { SignInAddress, SignInStep, readSignInAddress, signInParams, signInPath, signInRoute, signInSteps } from "./sign-in-address.js";
 import { FilterLimits, FilterParse, parseFilter } from "./filter/parse.js";
 import { CheckResult, checkFilter } from "./filter/check.js";
 import { EvaluateOptions, evaluateFilter } from "./filter/evaluate.js";
@@ -36,4 +37,4 @@ import { AccessSource, ResolveOptions, ResolvedAccess, RowFilterOperation, acces
 import { restrictModel } from "./access/restrict.js";
 import "./access/index.js";
 import { AssistantAction, AssistantActionRequest, AssistantCardPart, AssistantDiff, AssistantEvent, AssistantMessage, AssistantMessageRequest, AssistantPart, AssistantState, AssistantStep, AssistantStepState, AssistantTablePart, AssistantTextPart, AssistantTone, AssistantWidgetPart } from "./assistant/protocol.js";
-export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AnyField, 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 CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type Constraint, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, 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 FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type Grant, type HeldCapability, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, 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 RecordKey, type RecordOf, type Ref, type Refs, type RelatedModel, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SignInPromptModel, type SignInViewModel, type SortSpec, type Span, type StatusTone, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, resolveAccess, resource, restrictModel, rule, userMenu, view, where };
+export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AnyField, 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 CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type Constraint, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, 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 FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type Grant, type HeldCapability, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, 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 RecordKey, type RecordOf, type Ref, type Refs, type RelatedModel, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/index.js

@@ -18,8 +18,9 @@ import { bottomBarErrors } from "./bottom-bar-errors.js";
 import { layout } from "./layout.js";
 import { keyTypes } from "./keys.js";
 import { addressWords, appPath, readAppPath } from "./app-address.js";
+import { readSignInAddress, signInParams, signInPath, signInRoute, signInSteps } from "./sign-in-address.js";
 import { rule } from "./access/rule.js";
 import { defineRoles } from "./access/roles.js";
 import { pickView } from "./access/pick-view.js";
 import { restrictModel } from "./access/restrict.js";
-export { accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, resolveAccess, resource, restrictModel, rule, userMenu, view, where };
+export { accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/model.d.ts

@@ -209,6 +209,8 @@ export type FieldViewModel = {
   help?: string;
   /** How the value is shown. */
   format?: FieldFormat;
+  /** A text that runs over several lines: forms edit it in a box that grows with it, and its line breaks show. */
+  multiline?: boolean;
   /** Text before a number wherever it is shown, such as `€`. */
   prefix?: string;
   /** Text after a number wherever it is shown, such as a unit: `m²` shows `120 m²`. */
@@ -292,6 +294,16 @@ export type ListDisplayModel = {
   longitude: string;
   /** The cards display whose card a chosen marker shows; the list's first cards display when omitted. */
   cards?: string;
+  /** The boolean field that is true when the record's position is approximate. */
+  approximate?: string;
+  /** The boolean field that is false when the record's position is approximate. */
+  exact?: string;
+  /** The number field holding the radius, in metres, of the circle around an approximate position. */
+  radius?: string;
+  /** The radius, in metres, of the circle around an approximate position whose record states no area or radius. */
+  defaultRadius?: number;
+  /** The field holding the GeoJSON geometry around an approximate position: a polygon, or a line such as a street. */
+  area?: string;
 } | {
   /** The rows drawn by a project component. */
   kind: 'custom';

package/dist/sign-in-address.d.ts

@@ -0,0 +1,33 @@
+//#region src/sign-in-address.d.ts
+/** The path of the sign-in route, below the app's base path. Its steps and the page to come back to are in its query. */
+export declare const signInRoute = "/-/sign-in";
+/** The names of the sign-in route's query parameters: the step it shows, and the page to come back to after it. */
+export declare const signInParams: {
+  /** The step the route shows, when it is not the first. */
+  readonly step: "step";
+  /** The page below the base path to come back to after signing in. */
+  readonly next: "next";
+};
+/**
+ * A step of signing in or making an account, each with an address of its own: Back from a step returns to the one
+ * before. `email-code` and `sign-up-code` enter the code emailed to an address the step before asked for, and
+ * `sign-up-details` asks for the name and password once that code was right.
+ */
+export declare const signInSteps: readonly ["sign-in", "forgot-password", "email-code", "sign-up", "sign-up-code", "sign-up-details"];
+/** A step of the sign-in route: one of `signInSteps`. */
+export type SignInStep = (typeof signInSteps)[number];
+/** Where the sign-in route is: its step, and the page below the base path to come back to, when it names one. */
+export type SignInAddress = {
+  /** The step the route shows. */
+  step: SignInStep;
+  /** The page below the base path to come back to, when it names one. */
+  next?: string;
+};
+/** The path below the base path of a step of the sign-in route, coming back to `next` after it, the start by default. */
+export declare const signInPath: ({ step, next }?: {
+  step?: SignInStep;
+  next?: string;
+}) => string;
+/** The sign-in route's step and the page to come back to, for the path below the base path; `undefined` elsewhere. */
+export declare const readSignInAddress: (path: string, params: URLSearchParams) => SignInAddress | undefined;
+//#endregion

package/dist/sign-in-address.js

@@ -0,0 +1,51 @@
+//#region src/sign-in-address.ts
+/** The path of the sign-in route, below the app's base path. Its steps and the page to come back to are in its query. */
+const signInRoute = "/-/sign-in";
+/** The names of the sign-in route's query parameters: the step it shows, and the page to come back to after it. */
+const signInParams = {
+	/** The step the route shows, when it is not the first. */
+	step: "step",
+	/** The page below the base path to come back to after signing in. */
+	next: "next"
+};
+/**
+* A step of signing in or making an account, each with an address of its own: Back from a step returns to the one
+* before. `email-code` and `sign-up-code` enter the code emailed to an address the step before asked for, and
+* `sign-up-details` asks for the name and password once that code was right.
+*/
+const signInSteps = [
+	"sign-in",
+	"forgot-password",
+	"email-code",
+	"sign-up",
+	"sign-up-code",
+	"sign-up-details"
+];
+const isStep = (value) => signInSteps.includes(value);
+const localPage = (next) => {
+	if (!next?.startsWith("/")) return void 0;
+	const url = new URL(next, "http://local");
+	if (url.origin !== "http://local" || url.pathname === "/-/sign-in") return void 0;
+	return `${url.pathname}${url.search}`;
+};
+/** The path below the base path of a step of the sign-in route, coming back to `next` after it, the start by default. */
+const signInPath = ({ step = "sign-in", next } = {}) => {
+	const params = new URLSearchParams();
+	if (step !== "sign-in") params.set(signInParams.step, step);
+	const page = localPage(next);
+	if (page && page !== "/") params.set(signInParams.next, page);
+	const query = params.toString();
+	return query ? `${signInRoute}?${query}` : signInRoute;
+};
+/** The sign-in route's step and the page to come back to, for the path below the base path; `undefined` elsewhere. */
+const readSignInAddress = (path, params) => {
+	if (path !== "/-/sign-in") return void 0;
+	const step = params.get(signInParams.step);
+	const next = localPage(params.get(signInParams.next));
+	return {
+		step: isStep(step) ? step : "sign-in",
+		...next && { next }
+	};
+};
+//#endregion
+export { readSignInAddress, signInParams, signInPath, signInRoute, signInSteps };

package/dist/view-displays.d.ts

@@ -53,13 +53,22 @@ export declare const displays: {
    * 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.
+   * when it names none, or the record's title alone without one. A record's position is approximate when its boolean
+   * `approximate` field is true, or its `exact` field false: its marker is drawn hollow and says so, and close enough in
+   * an area is drawn around it, the GeoJSON polygon or line its `area` field holds, else a circle of its `radius` field
+   * in metres, else one of `defaultRadius`. Named `map` unless `name` says otherwise. See
+   * [Approximate positions](website/src/content/docs/reference/ui-config.mdx#approximate-positions).
    */
   map: (fields: {
     latitude: Ref;
     longitude: Ref;
+    approximate?: Ref;
+    exact?: Ref;
+    radius?: Ref;
+    area?: Ref;
   }, o?: Naming & {
     cards?: string;
+    defaultRadius?: number;
   }) => ListDisplayModel;
   /**
    * The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and
@@ -72,6 +81,6 @@ export declare const displays: {
     props?: ViewProps<P>;
   }) => ListDisplayModel;
 };
-/** Every field a display names: what it shows, a map's position, and the field references in a custom display's props. */
+/** Every field a display names: what it shows, a map's position and the fields saying how exact it is, and the field references in a custom display's props. */
 export declare const displayFields: (display: ListDisplayModel) => string[];
 //#endregion

package/dist/view-displays.js

@@ -48,7 +48,11 @@ const displays = {
 	* 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.
+	* when it names none, or the record's title alone without one. A record's position is approximate when its boolean
+	* `approximate` field is true, or its `exact` field false: its marker is drawn hollow and says so, and close enough in
+	* an area is drawn around it, the GeoJSON polygon or line its `area` field holds, else a circle of its `radius` field
+	* in metres, else one of `defaultRadius`. Named `map` unless `name` says otherwise. See
+	* [Approximate positions](website/src/content/docs/reference/ui-config.mdx#approximate-positions).
 	*/
 	map: (fields, o = {}) => ({
 		kind: "map",
@@ -56,7 +60,12 @@ const displays = {
 		...naming(o),
 		latitude: fields.latitude.name,
 		longitude: fields.longitude.name,
-		...o.cards !== void 0 && { cards: o.cards }
+		...o.cards !== void 0 && { cards: o.cards },
+		...fields.approximate && { approximate: fields.approximate.name },
+		...fields.exact && { exact: fields.exact.name },
+		...fields.radius && { radius: fields.radius.name },
+		...o.defaultRadius !== void 0 && { defaultRadius: o.defaultRadius },
+		...fields.area && { area: fields.area.name }
 	}),
 	/**
 	* The list drawn by a component of the project, registered in `protobase.ui.tsx` under its name. It gets `props` and
@@ -81,12 +90,25 @@ const displayErrors = (list) => {
 		...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.displays ?? []).flatMap((display) => display.kind === "map" ? approximateErrors(display).map((error) => `display "${display.name}": ${error}`) : []),
 		...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, a map's position, and the field references in a custom display's props. */
+const approximateErrors = (display) => {
+	const { approximate, exact, radius, defaultRadius, area } = display;
+	if (approximate !== void 0 && exact !== void 0) return ["name approximate or exact, not both"];
+	return [...(radius !== void 0 || defaultRadius !== void 0 || area !== void 0) && approximate === void 0 && exact === void 0 ? ["an area around approximate positions needs the approximate or exact field"] : [], ...defaultRadius === void 0 || Number.isFinite(defaultRadius) && defaultRadius > 0 ? [] : [`defaultRadius ${defaultRadius} is not a number of metres above 0`]];
+};
+/** Every field a display names: what it shows, a map's position and the fields saying how exact it is, 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 === "map") return [
+		display.latitude,
+		display.longitude,
+		display.approximate,
+		display.exact,
+		display.radius,
+		display.area
+	].filter((name) => name !== void 0);
 	if (display.kind === "custom") return [...display.fields, ...fieldRefsIn(display.props)];
 	return [
 		display.image,

package/dist/view-field.d.ts

@@ -18,6 +18,11 @@ export declare class FieldView<N extends string = string, V = unknown> {
   help(help: string): FieldView<N, V>;
   /** How the value shows: `badge` for statuses, `code` in monospace, `percent` with a % sign. */
   format(format: FieldFormat): FieldView<N, V>;
+  /**
+   * A text of several lines, such as a description: forms edit it in a box that grows with the text, and the record
+   * page and cards keep its line breaks. Only a text field takes it.
+   */
+  multiline(): FieldView<N, V>;
   /** Text before a number wherever it is shown, such as a currency: `.prefix('€')`. */
   prefix(prefix: string): FieldView<N, V>;
   /** Text after a number wherever it is shown, such as a unit: `.suffix(' m²')`. */

package/dist/view-field.js

@@ -21,6 +21,13 @@ var FieldView = class FieldView {
 	format(format) {
 		return this.with({ format });
 	}
+	/**
+	* A text of several lines, such as a description: forms edit it in a box that grows with the text, and the record
+	* page and cards keep its line breaks. Only a text field takes it.
+	*/
+	multiline() {
+		return this.with({ multiline: true });
+	}
 	/** Text before a number wherever it is shown, such as a currency: `.prefix('€')`. */
 	prefix(prefix) {
 		return this.with({ prefix });

package/package.json

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