@fieldia/core 0.22.0 → 0.24.0

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

@@ -3,6 +3,7 @@ import { type PageEvents } from './actions.mjs';
 import { type Fields } from './field.mjs';
 import { type HelpShown, type RootLayout } from './layout.mjs';
 import { type PartsLook } from './part-look.mjs';
+import { type PagePhone } from './phone.mjs';
 import { type Theme } from './themes.mjs';
 export { THEMES, type Theme } from './themes.mjs';
 import { type Skin } from './themes.mjs';
@@ -80,6 +81,24 @@ export interface PageLook {
      */
     dateOrder?: DateOrder;
 }
+/**
+ * A public page's check that a person, not a bot, sends it (a page of responses only). Nothing is refused for it:
+ * each send tells the app what it saw (`SubmitRequest.bot`), and the app decides.
+ */
+export interface BotCheck {
+    /**
+     * A box no person sees, reaches with Tab or hears read out, which a bot filling every box fills: told as
+     * `honeypot`. On unless false.
+     */
+    honeypot?: boolean;
+    /** The fewest seconds a person takes from the page shown to its send: sooner is told as `tooFast`. 3 unless said; 0 tells none. */
+    minSeconds?: number;
+    /**
+     * The slot the app draws its captcha in (Turnstile, reCAPTCHA, hCaptcha), by its name, as a slot part of the page
+     * names it: the app's widget gives its token to the form (`form.botCheck({ captcha })`), and the send carries it.
+     */
+    captcha?: string;
+}
 export interface Page {
     /**
      * The format the page is written in, so a reader can tell one it cannot read yet (a newer Fieldia's) from one it can
@@ -111,6 +130,23 @@ export interface Page {
     };
     /** What the form does at its moments — opened, a field changed, before and after saving, a step shown: steps, as data. */
     on?: PageEvents;
+    /** A page of responses open to anyone: a check that a person sends it, told to the app with the answers. */
+    botCheck?: BotCheck;
+    /**
+     * Its phone fields (`"widget": "phone"`) read and kept as one number the world over: typed at home or with their +,
+     * checked by their country, kept as E.164 ("+201012345678"), shown at rest as `shown` says, with a call and a
+     * WhatsApp link. `country` is the one a number typed without its + is read in — never assumed when left out. A field
+     * says otherwise in its `options`. Without it (and without those options), a phone field is a text box, as before.
+     */
+    phone?: PagePhone;
+    /**
+     * The time zone the page's dates and times are in, by its IANA name: a branch's, a clinic's ("Africa/Cairo"). A date
+     * and time is then shown and typed on that zone's clock — its short name beside it where the browser's zone is
+     * another ("14:30 EEST") — and kept as the instant it is. Today is that zone's day: a date's default "today", its
+     * earliest and latest counted from today, `today()`, a booking's days. A date and time field may name its own
+     * (`timeZone`). Left out, the browser's own zone, as before.
+     */
+    timeZone?: string;
 }
 export declare const PageDataSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     kind: z.ZodLiteral<"record">;
@@ -120,8 +156,9 @@ export declare const PageDataSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
 }, z.core.$strict>], "kind">;
 export declare const PageSchema: z.ZodObject<{
     fieldia: z.ZodEnum<{
-        0.2: "0.2";
+        0.3: "0.3";
         0.1: "0.1";
+        0.2: "0.2";
     }>;
     id: z.ZodString;
     title: z.ZodOptional<z.ZodString>;
@@ -230,11 +267,11 @@ export declare const PageSchema: z.ZodObject<{
             home: z.ZodOptional<z.ZodString>;
             per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                 period: z.ZodEnum<{
+                    year: "year";
+                    month: "month";
                     day: "day";
                     night: "night";
                     week: "week";
-                    month: "month";
-                    year: "year";
                 }>;
                 when: z.ZodOptional<z.ZodString>;
             }, z.core.$strict>>>;
@@ -284,6 +321,7 @@ export declare const PageSchema: z.ZodObject<{
         }, z.core.$strict>>>;
         type: z.ZodLiteral<"date">;
     }, z.core.$strict>, z.ZodObject<{
+        timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
         min: z.ZodOptional<z.ZodString>;
         max: z.ZodOptional<z.ZodString>;
         days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -538,11 +576,11 @@ export declare const PageSchema: z.ZodObject<{
                 home: z.ZodOptional<z.ZodString>;
                 per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                     period: z.ZodEnum<{
+                        year: "year";
+                        month: "month";
                         day: "day";
                         night: "night";
                         week: "week";
-                        month: "month";
-                        year: "year";
                     }>;
                     when: z.ZodOptional<z.ZodString>;
                 }, z.core.$strict>>>;
@@ -592,6 +630,7 @@ export declare const PageSchema: z.ZodObject<{
             }, z.core.$strict>>>;
             type: z.ZodLiteral<"date">;
         }, z.core.$strict>, z.ZodObject<{
+            timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
             min: z.ZodOptional<z.ZodString>;
             max: z.ZodOptional<z.ZodString>;
             days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -795,11 +834,11 @@ export declare const PageSchema: z.ZodObject<{
                 home: z.ZodOptional<z.ZodString>;
                 per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                     period: z.ZodEnum<{
+                        year: "year";
+                        month: "month";
                         day: "day";
                         night: "night";
                         week: "week";
-                        month: "month";
-                        year: "year";
                     }>;
                     when: z.ZodOptional<z.ZodString>;
                 }, z.core.$strict>>>;
@@ -849,6 +888,7 @@ export declare const PageSchema: z.ZodObject<{
             }, z.core.$strict>>>;
             type: z.ZodLiteral<"date">;
         }, z.core.$strict>, z.ZodObject<{
+            timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
             min: z.ZodOptional<z.ZodString>;
             max: z.ZodOptional<z.ZodString>;
             days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -1100,11 +1140,11 @@ export declare const PageSchema: z.ZodObject<{
                     home: z.ZodOptional<z.ZodString>;
                     per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                         period: z.ZodEnum<{
+                            year: "year";
+                            month: "month";
                             day: "day";
                             night: "night";
                             week: "week";
-                            month: "month";
-                            year: "year";
                         }>;
                         when: z.ZodOptional<z.ZodString>;
                     }, z.core.$strict>>>;
@@ -1154,6 +1194,7 @@ export declare const PageSchema: z.ZodObject<{
                 }, z.core.$strict>>>;
                 type: z.ZodLiteral<"date">;
             }, z.core.$strict>, z.ZodObject<{
+                timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
                 min: z.ZodOptional<z.ZodString>;
                 max: z.ZodOptional<z.ZodString>;
                 days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -1434,11 +1475,11 @@ export declare const PageSchema: z.ZodObject<{
                     home: z.ZodOptional<z.ZodString>;
                     per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                         period: z.ZodEnum<{
+                            year: "year";
+                            month: "month";
                             day: "day";
                             night: "night";
                             week: "week";
-                            month: "month";
-                            year: "year";
                         }>;
                         when: z.ZodOptional<z.ZodString>;
                     }, z.core.$strict>>>;
@@ -1488,6 +1529,7 @@ export declare const PageSchema: z.ZodObject<{
                 }, z.core.$strict>>>;
                 type: z.ZodLiteral<"date">;
             }, z.core.$strict>, z.ZodObject<{
+                timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
                 min: z.ZodOptional<z.ZodString>;
                 max: z.ZodOptional<z.ZodString>;
                 days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -1739,11 +1781,11 @@ export declare const PageSchema: z.ZodObject<{
                         home: z.ZodOptional<z.ZodString>;
                         per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                             period: z.ZodEnum<{
+                                year: "year";
+                                month: "month";
                                 day: "day";
                                 night: "night";
                                 week: "week";
-                                month: "month";
-                                year: "year";
                             }>;
                             when: z.ZodOptional<z.ZodString>;
                         }, z.core.$strict>>>;
@@ -1793,6 +1835,7 @@ export declare const PageSchema: z.ZodObject<{
                     }, z.core.$strict>>>;
                     type: z.ZodLiteral<"date">;
                 }, z.core.$strict>, z.ZodObject<{
+                    timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
                     min: z.ZodOptional<z.ZodString>;
                     max: z.ZodOptional<z.ZodString>;
                     days: z.ZodOptional<z.ZodArray<z.ZodInt>>;
@@ -2152,6 +2195,16 @@ export declare const PageSchema: z.ZodObject<{
                     when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                     text: z.ZodString;
                 }, z.core.$strict>>>;
+                autocomplete: z.ZodOptional<z.ZodString>;
+                inputmode: z.ZodOptional<z.ZodEnum<{
+                    text: "text";
+                    numeric: "numeric";
+                    email: "email";
+                    url: "url";
+                    decimal: "decimal";
+                    tel: "tel";
+                    search: "search";
+                }>>;
                 help: z.ZodOptional<z.ZodString>;
                 colspan: z.ZodOptional<z.ZodInt>;
                 columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -2607,6 +2660,16 @@ export declare const PageSchema: z.ZodObject<{
                         when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                         text: z.ZodString;
                     }, z.core.$strict>>>;
+                    autocomplete: z.ZodOptional<z.ZodString>;
+                    inputmode: z.ZodOptional<z.ZodEnum<{
+                        text: "text";
+                        numeric: "numeric";
+                        email: "email";
+                        url: "url";
+                        decimal: "decimal";
+                        tel: "tel";
+                        search: "search";
+                    }>>;
                     help: z.ZodOptional<z.ZodString>;
                     colspan: z.ZodOptional<z.ZodInt>;
                     columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -3032,8 +3095,8 @@ export declare const PageSchema: z.ZodObject<{
                     alt: z.ZodString;
                     width: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
                         small: "small";
-                        medium: "medium";
                         large: "large";
+                        medium: "medium";
                         full: "full";
                     }>, z.ZodInt]>>;
                     align: z.ZodOptional<z.ZodEnum<{
@@ -3081,10 +3144,10 @@ export declare const PageSchema: z.ZodObject<{
                         pin: z.ZodOptional<z.ZodObject<{
                             look: z.ZodOptional<z.ZodEnum<{
                                 label: "label";
+                                photo: "photo";
                                 dot: "dot";
-                                pin: "pin";
                                 icon: "icon";
-                                photo: "photo";
+                                pin: "pin";
                             }>>;
                             icon: z.ZodOptional<z.ZodString>;
                             iconField: z.ZodOptional<z.ZodString>;
@@ -3115,11 +3178,11 @@ export declare const PageSchema: z.ZodObject<{
                                 home: z.ZodOptional<z.ZodString>;
                                 per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                                     period: z.ZodEnum<{
+                                        year: "year";
+                                        month: "month";
                                         day: "day";
                                         night: "night";
                                         week: "week";
-                                        month: "month";
-                                        year: "year";
                                     }>;
                                     when: z.ZodOptional<z.ZodString>;
                                 }, z.core.$strict>>>;
@@ -3386,6 +3449,16 @@ export declare const PageSchema: z.ZodObject<{
                     when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                     text: z.ZodString;
                 }, z.core.$strict>>>;
+                autocomplete: z.ZodOptional<z.ZodString>;
+                inputmode: z.ZodOptional<z.ZodEnum<{
+                    text: "text";
+                    numeric: "numeric";
+                    email: "email";
+                    url: "url";
+                    decimal: "decimal";
+                    tel: "tel";
+                    search: "search";
+                }>>;
                 help: z.ZodOptional<z.ZodString>;
                 colspan: z.ZodOptional<z.ZodInt>;
                 columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -3525,6 +3598,16 @@ export declare const PageSchema: z.ZodObject<{
                     when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                     text: z.ZodString;
                 }, z.core.$strict>>>;
+                autocomplete: z.ZodOptional<z.ZodString>;
+                inputmode: z.ZodOptional<z.ZodEnum<{
+                    text: "text";
+                    numeric: "numeric";
+                    email: "email";
+                    url: "url";
+                    decimal: "decimal";
+                    tel: "tel";
+                    search: "search";
+                }>>;
                 help: z.ZodOptional<z.ZodString>;
                 colspan: z.ZodOptional<z.ZodInt>;
                 columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -3664,6 +3747,16 @@ export declare const PageSchema: z.ZodObject<{
                     when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                     text: z.ZodString;
                 }, z.core.$strict>>>;
+                autocomplete: z.ZodOptional<z.ZodString>;
+                inputmode: z.ZodOptional<z.ZodEnum<{
+                    text: "text";
+                    numeric: "numeric";
+                    email: "email";
+                    url: "url";
+                    decimal: "decimal";
+                    tel: "tel";
+                    search: "search";
+                }>>;
                 help: z.ZodOptional<z.ZodString>;
                 colspan: z.ZodOptional<z.ZodInt>;
                 columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -3803,6 +3896,16 @@ export declare const PageSchema: z.ZodObject<{
                     when: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
                     text: z.ZodString;
                 }, z.core.$strict>>>;
+                autocomplete: z.ZodOptional<z.ZodString>;
+                inputmode: z.ZodOptional<z.ZodEnum<{
+                    text: "text";
+                    numeric: "numeric";
+                    email: "email";
+                    url: "url";
+                    decimal: "decimal";
+                    tel: "tel";
+                    search: "search";
+                }>>;
                 help: z.ZodOptional<z.ZodString>;
                 colspan: z.ZodOptional<z.ZodInt>;
                 columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -5043,7 +5146,7 @@ export declare const PageSchema: z.ZodObject<{
         filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             label: z.ZodString;
-            filter: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
                 field: z.ZodString;
                 op: z.ZodEnum<{
                     set: "set";
@@ -5072,7 +5175,22 @@ export declare const PageSchema: z.ZodObject<{
                 any: z.ZodArray<typeof import("./field.mjs").FilterItemSchema>;
             }, z.core.$strict>, z.ZodObject<{
                 all: z.ZodArray<typeof import("./field.mjs").FilterItemSchema>;
-            }, z.core.$strict>]>>;
+            }, z.core.$strict>]>>>;
+            period: z.ZodOptional<z.ZodObject<{
+                field: z.ZodString;
+                is: z.ZodEnum<{
+                    today: "today";
+                    yesterday: "yesterday";
+                    thisWeek: "thisWeek";
+                    lastWeek: "lastWeek";
+                    thisMonth: "thisMonth";
+                    lastMonth: "lastMonth";
+                    thisYear: "thisYear";
+                    last7Days: "last7Days";
+                    last30Days: "last30Days";
+                    overdue: "overdue";
+                }>;
+            }, z.core.$strict>>;
         }, z.core.$strict>>>;
         defaultFilters: z.ZodOptional<z.ZodArray<z.ZodString>>;
         groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -5247,10 +5365,10 @@ export declare const PageSchema: z.ZodObject<{
             pin: z.ZodOptional<z.ZodObject<{
                 look: z.ZodOptional<z.ZodEnum<{
                     label: "label";
+                    photo: "photo";
                     dot: "dot";
-                    pin: "pin";
                     icon: "icon";
-                    photo: "photo";
+                    pin: "pin";
                 }>>;
                 icon: z.ZodOptional<z.ZodString>;
                 iconField: z.ZodOptional<z.ZodString>;
@@ -5281,11 +5399,11 @@ export declare const PageSchema: z.ZodObject<{
                     home: z.ZodOptional<z.ZodString>;
                     per: z.ZodOptional<z.ZodArray<z.ZodObject<{
                         period: z.ZodEnum<{
+                            year: "year";
+                            month: "month";
                             day: "day";
                             night: "night";
                             week: "week";
-                            month: "month";
-                            year: "year";
                         }>;
                         when: z.ZodOptional<z.ZodString>;
                     }, z.core.$strict>>>;
@@ -5360,20 +5478,20 @@ export declare const PageSchema: z.ZodObject<{
             colour: z.ZodOptional<z.ZodString>;
             resource: z.ZodOptional<z.ZodString>;
             views: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                month: "month";
                 day: "day";
                 week: "week";
-                month: "month";
                 agenda: "agenda";
             }>>>;
             view: z.ZodOptional<z.ZodEnum<{
+                month: "month";
                 day: "day";
                 week: "week";
-                month: "month";
                 agenda: "agenda";
             }>>;
             opens: z.ZodOptional<z.ZodEnum<{
-                list: "list";
                 calendar: "calendar";
+                list: "list";
             }>>;
             firstDay: z.ZodOptional<z.ZodInt>;
             hours: z.ZodOptional<z.ZodObject<{
@@ -5399,6 +5517,13 @@ export declare const PageSchema: z.ZodObject<{
                 end: "end";
                 start: "start";
             }>>;
+            total: z.ZodOptional<z.ZodEnum<{
+                min: "min";
+                max: "max";
+                sum: "sum";
+                count: "count";
+                avg: "avg";
+            }>>;
             rule: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodType<`${number}px`, unknown, z.core.$ZodTypeInternals<`${number}px`, unknown>>]>>;
         }, z.core.$strict>>>;
         choose: z.ZodOptional<z.ZodBoolean>;
@@ -5410,6 +5535,8 @@ export declare const PageSchema: z.ZodObject<{
         filterFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
         filterLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         parentField: z.ZodOptional<z.ZodString>;
+        export: z.ZodOptional<z.ZodBoolean>;
+        bulkEdit: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
     }, z.core.$strict>], "type">;
     maxWidth: z.ZodOptional<z.ZodEnum<{
         narrow: "narrow";
@@ -5444,9 +5571,9 @@ export declare const PageSchema: z.ZodObject<{
             roomy: "roomy";
         }>>;
         corners: z.ZodOptional<z.ZodEnum<{
+            round: "round";
             square: "square";
             soft: "soft";
-            round: "round";
         }>>;
         labels: z.ZodOptional<z.ZodEnum<{
             above: "above";
@@ -5479,9 +5606,9 @@ export declare const PageSchema: z.ZodObject<{
             }, z.core.$strict>>;
         }, z.core.$strict>>;
         skin: z.ZodOptional<z.ZodEnum<{
-            quiet: "quiet";
             underline: "underline";
             outlined: "outlined";
+            quiet: "quiet";
         }>>;
         dateOrder: z.ZodOptional<z.ZodEnum<{
             dmy: "dmy";
@@ -6158,4 +6285,17 @@ export declare const PageSchema: z.ZodObject<{
             }>>;
         }, z.core.$strict>], "do">>>>;
     }, z.core.$strict>>;
+    botCheck: z.ZodOptional<z.ZodObject<{
+        honeypot: z.ZodOptional<z.ZodBoolean>;
+        minSeconds: z.ZodOptional<z.ZodNumber>;
+        captcha: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    phone: z.ZodOptional<z.ZodObject<{
+        country: z.ZodOptional<z.ZodString>;
+        shown: z.ZodOptional<z.ZodEnum<{
+            international: "international";
+            national: "national";
+        }>>;
+    }, z.core.$strict>>;
+    timeZone: z.ZodOptional<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
 }, z.core.$strict>;