@fieldia/core 0.15.0 → 0.16.0

package/src/lib/format/layout.d.mts

@@ -382,6 +382,71 @@ export interface FormNode {
     /** Every field inside is read-only while this holds. */
     readonly?: Modifier;
 }
+/** A line along the roads between a map's layers: from one place to another, or through a layer's lines in their order. */
+export interface MapRoute {
+    /** The layer it starts at: a place, or the reader's own. */
+    from: string;
+    /** The layer it ends at. */
+    to?: string;
+    /** A layer of lines it goes through, in their order: a delivery round's stops. */
+    through?: string;
+    /** How it is travelled: by car unless said. */
+    mode?: 'car' | 'bike' | 'foot';
+    /** The part already travelled fades as `from` moves along it, and the time and distance left are kept up to date. */
+    progress?: boolean;
+    /** Fields of the record its numbers go into: the seconds and metres left, and its line as GeoJSON. */
+    write?: {
+        seconds?: string;
+        metres?: string;
+        line?: string;
+    };
+}
+/**
+ * One layer of a form's map: the record's own place (`point`, or `latitude`
+ * and `longitude`), a place for each of its lines (`lines`, the place in the
+ * line's fields), a route between layers, or the reader's own place.
+ */
+export interface MapLayer {
+    id: string;
+    /** What it is, in words: its pins are named by it ("Courier, 4 min"). */
+    label?: string;
+    point?: string;
+    latitude?: string;
+    longitude?: string;
+    /** A field of lines (one2many): a pin for each line. */
+    lines?: string;
+    pin?: Pin;
+    card?: MapCard;
+    /**
+     * A place that moves as its fields change: its pin glides there. Without
+     * news for `staleAfter` seconds it says when it was last seen; `follow`
+     * keeps it in view until the person moves the map.
+     */
+    live?: {
+        staleAfter?: number;
+        follow?: boolean;
+    };
+    route?: MapRoute;
+    /** The reader's own place, from the browser once they allow it. */
+    myLocation?: boolean;
+    invisible?: Modifier;
+}
+/** A map on a form: the record's places, its lines' places, the routes between them, and the reader's own place, as layers. */
+export interface MapNode {
+    type: 'map';
+    id: string;
+    /** Its name, over it and for a screen reader. */
+    label?: string;
+    layers: MapLayer[];
+    /** Height in pixels: 360 unless said. */
+    height?: number;
+    /** Grid columns it spans inside a section. */
+    colspan?: number;
+    invisible?: Modifier;
+    roles?: Roles;
+    /** Hidden at these widths of the form, such as a phone's: `["narrow"]`. */
+    hideOn?: ScreenWidth[];
+}
 /** A named place the app fills with its own content, such as an activity feed. */
 export interface SlotNode {
     type: 'slot';
@@ -782,7 +847,7 @@ export interface ListMap {
     limit?: number;
 }
 /** Anything that can sit inside a section, tab, step or sheet. */
-export type LayoutNode = FieldNode | ButtonNode | TextNode | SlotNode | SectionNode | TabsNode | DividerNode | SpacerNode | ImageNode | FormNode;
+export type LayoutNode = FieldNode | ButtonNode | TextNode | SlotNode | SectionNode | TabsNode | DividerNode | SpacerNode | ImageNode | FormNode | MapNode;
 /** What a page's `layout` can be: the four page layouts. */
 export type RootLayout = SheetNode | SectionsNode | TabsNode | WizardNode | ListNode;
 export declare const ModifierSchema: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
@@ -1220,6 +1285,198 @@ export declare const ImageNodeSchema: z.ZodObject<{
         wide: "wide";
     }>>>;
 }, z.core.$strict>;
+/**
+ * What a pin on a map shows, from its record's fields: a pin, an icon (a
+ * fixed one or one a field names), a round photo, words alone, or a dot; its
+ * words; its colour by condition; its turn, for a car facing its way; or the
+ * app's own widget, which draws it from the record.
+ */
+export declare const PinSchema: z.ZodObject<{
+    look: z.ZodOptional<z.ZodEnum<{
+        label: "label";
+        pin: "pin";
+        icon: "icon";
+        photo: "photo";
+        dot: "dot";
+    }>>;
+    icon: z.ZodOptional<z.ZodString>;
+    iconField: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    tones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        tone: z.ZodEnum<{
+            success: "success";
+            info: "info";
+            warning: "warning";
+            danger: "danger";
+            muted: "muted";
+        }>;
+        when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
+    }, z.core.$strict>>>;
+    turn: z.ZodOptional<z.ZodString>;
+    widget: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** The card a pin opens: its record's title, a picture, a few of its fields, and a way to open it. */
+export declare const MapCardSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    open: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** A line along the roads between a map's layers: from one place to another, through a layer's lines in their order. */
+export declare const MapRouteSchema: z.ZodObject<{
+    from: z.ZodString;
+    to: z.ZodOptional<z.ZodString>;
+    through: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        car: "car";
+        bike: "bike";
+        foot: "foot";
+    }>>;
+    progress: z.ZodOptional<z.ZodBoolean>;
+    write: z.ZodOptional<z.ZodObject<{
+        seconds: z.ZodOptional<z.ZodString>;
+        metres: z.ZodOptional<z.ZodString>;
+        line: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** One layer of a form's map: the record's own place, a place for each of its lines, a route, or the reader's own place. */
+export declare const MapLayerSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    point: z.ZodOptional<z.ZodString>;
+    latitude: z.ZodOptional<z.ZodString>;
+    longitude: z.ZodOptional<z.ZodString>;
+    lines: z.ZodOptional<z.ZodString>;
+    pin: z.ZodOptional<z.ZodObject<{
+        look: z.ZodOptional<z.ZodEnum<{
+            label: "label";
+            pin: "pin";
+            icon: "icon";
+            photo: "photo";
+            dot: "dot";
+        }>>;
+        icon: z.ZodOptional<z.ZodString>;
+        iconField: z.ZodOptional<z.ZodString>;
+        image: z.ZodOptional<z.ZodString>;
+        label: z.ZodOptional<z.ZodString>;
+        tones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            tone: z.ZodEnum<{
+                success: "success";
+                info: "info";
+                warning: "warning";
+                danger: "danger";
+                muted: "muted";
+            }>;
+            when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
+        }, z.core.$strict>>>;
+        turn: z.ZodOptional<z.ZodString>;
+        widget: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    card: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        image: z.ZodOptional<z.ZodString>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        open: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    live: z.ZodOptional<z.ZodObject<{
+        staleAfter: z.ZodOptional<z.ZodInt>;
+        follow: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    route: z.ZodOptional<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodOptional<z.ZodString>;
+        through: z.ZodOptional<z.ZodString>;
+        mode: z.ZodOptional<z.ZodEnum<{
+            car: "car";
+            bike: "bike";
+            foot: "foot";
+        }>>;
+        progress: z.ZodOptional<z.ZodBoolean>;
+        write: z.ZodOptional<z.ZodObject<{
+            seconds: z.ZodOptional<z.ZodString>;
+            metres: z.ZodOptional<z.ZodString>;
+            line: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    myLocation: z.ZodOptional<z.ZodBoolean>;
+    invisible: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+}, z.core.$strict>;
+export declare const MapNodeSchema: z.ZodObject<{
+    type: z.ZodLiteral<"map">;
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    layers: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        point: z.ZodOptional<z.ZodString>;
+        latitude: z.ZodOptional<z.ZodString>;
+        longitude: z.ZodOptional<z.ZodString>;
+        lines: z.ZodOptional<z.ZodString>;
+        pin: z.ZodOptional<z.ZodObject<{
+            look: z.ZodOptional<z.ZodEnum<{
+                label: "label";
+                pin: "pin";
+                icon: "icon";
+                photo: "photo";
+                dot: "dot";
+            }>>;
+            icon: z.ZodOptional<z.ZodString>;
+            iconField: z.ZodOptional<z.ZodString>;
+            image: z.ZodOptional<z.ZodString>;
+            label: z.ZodOptional<z.ZodString>;
+            tones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                tone: z.ZodEnum<{
+                    success: "success";
+                    info: "info";
+                    warning: "warning";
+                    danger: "danger";
+                    muted: "muted";
+                }>;
+                when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
+            }, z.core.$strict>>>;
+            turn: z.ZodOptional<z.ZodString>;
+            widget: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        card: z.ZodOptional<z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            image: z.ZodOptional<z.ZodString>;
+            fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            open: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        live: z.ZodOptional<z.ZodObject<{
+            staleAfter: z.ZodOptional<z.ZodInt>;
+            follow: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        route: z.ZodOptional<z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodOptional<z.ZodString>;
+            through: z.ZodOptional<z.ZodString>;
+            mode: z.ZodOptional<z.ZodEnum<{
+                car: "car";
+                bike: "bike";
+                foot: "foot";
+            }>>;
+            progress: z.ZodOptional<z.ZodBoolean>;
+            write: z.ZodOptional<z.ZodObject<{
+                seconds: z.ZodOptional<z.ZodString>;
+                metres: z.ZodOptional<z.ZodString>;
+                line: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        myLocation: z.ZodOptional<z.ZodBoolean>;
+        invisible: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+    }, z.core.$strict>>;
+    height: z.ZodOptional<z.ZodInt>;
+    colspan: z.ZodOptional<z.ZodInt>;
+    invisible: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    hideOn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        narrow: "narrow";
+        medium: "medium";
+        wide: "wide";
+    }>>>;
+}, z.core.$strict>;
 export declare const SlotNodeSchema: z.ZodObject<{
     type: z.ZodLiteral<"slot">;
     id: z.ZodString;
@@ -1770,6 +2027,80 @@ export declare const LayoutNodeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         wide: "wide";
     }>>>;
     readonly: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"map">;
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    layers: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        point: z.ZodOptional<z.ZodString>;
+        latitude: z.ZodOptional<z.ZodString>;
+        longitude: z.ZodOptional<z.ZodString>;
+        lines: z.ZodOptional<z.ZodString>;
+        pin: z.ZodOptional<z.ZodObject<{
+            look: z.ZodOptional<z.ZodEnum<{
+                label: "label";
+                pin: "pin";
+                icon: "icon";
+                photo: "photo";
+                dot: "dot";
+            }>>;
+            icon: z.ZodOptional<z.ZodString>;
+            iconField: z.ZodOptional<z.ZodString>;
+            image: z.ZodOptional<z.ZodString>;
+            label: z.ZodOptional<z.ZodString>;
+            tones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                tone: z.ZodEnum<{
+                    success: "success";
+                    info: "info";
+                    warning: "warning";
+                    danger: "danger";
+                    muted: "muted";
+                }>;
+                when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
+            }, z.core.$strict>>>;
+            turn: z.ZodOptional<z.ZodString>;
+            widget: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        card: z.ZodOptional<z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            image: z.ZodOptional<z.ZodString>;
+            fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            open: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        live: z.ZodOptional<z.ZodObject<{
+            staleAfter: z.ZodOptional<z.ZodInt>;
+            follow: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        route: z.ZodOptional<z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodOptional<z.ZodString>;
+            through: z.ZodOptional<z.ZodString>;
+            mode: z.ZodOptional<z.ZodEnum<{
+                car: "car";
+                bike: "bike";
+                foot: "foot";
+            }>>;
+            progress: z.ZodOptional<z.ZodBoolean>;
+            write: z.ZodOptional<z.ZodObject<{
+                seconds: z.ZodOptional<z.ZodString>;
+                metres: z.ZodOptional<z.ZodString>;
+                line: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        myLocation: z.ZodOptional<z.ZodBoolean>;
+        invisible: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+    }, z.core.$strict>>;
+    height: z.ZodOptional<z.ZodInt>;
+    colspan: z.ZodOptional<z.ZodInt>;
+    invisible: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    hideOn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        narrow: "narrow";
+        medium: "medium";
+        wide: "wide";
+    }>>>;
 }, z.core.$strict>], "type">;
 export declare const StepNodeSchema: z.ZodObject<{
     type: z.ZodLiteral<"step">;
@@ -3896,44 +4227,6 @@ export declare const SheetNodeSchema: z.ZodObject<{
         }>>>;
     }, z.core.$strict>>>;
 }, z.core.$strict>;
-/**
- * What a pin on a map shows, from its record's fields: a pin, an icon (a
- * fixed one or one a field names), a round photo, words alone, or a dot; its
- * words; its colour by condition; its turn, for a car facing its way; or the
- * app's own widget, which draws it from the record.
- */
-export declare const PinSchema: z.ZodObject<{
-    look: z.ZodOptional<z.ZodEnum<{
-        label: "label";
-        pin: "pin";
-        icon: "icon";
-        photo: "photo";
-        dot: "dot";
-    }>>;
-    icon: z.ZodOptional<z.ZodString>;
-    iconField: z.ZodOptional<z.ZodString>;
-    image: z.ZodOptional<z.ZodString>;
-    label: z.ZodOptional<z.ZodString>;
-    tones: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        tone: z.ZodEnum<{
-            success: "success";
-            info: "info";
-            warning: "warning";
-            danger: "danger";
-            muted: "muted";
-        }>;
-        when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
-    }, z.core.$strict>>>;
-    turn: z.ZodOptional<z.ZodString>;
-    widget: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
-/** The card a pin opens: its record's title, a picture, a few of its fields, and a way to open it. */
-export declare const MapCardSchema: z.ZodObject<{
-    title: z.ZodOptional<z.ZodString>;
-    image: z.ZodOptional<z.ZodString>;
-    fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    open: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strict>;
 /** A list's records on a map, beside it or instead of it: where each is (a point, or a latitude and a longitude), its pin, its card. */
 export declare const ListMapSchema: z.ZodObject<{
     point: z.ZodOptional<z.ZodString>;