@fieldia/core 0.23.0 → 0.24.0

package/src/lib/format/phone.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneOptionsSchema = exports.PagePhoneSchema = void 0;
+exports.phoneOptionIssues = phoneOptionIssues;
+const z = require("zod");
+/**
+ * Phone numbers read and kept as one number the world over (`"widget": "phone"` on a char field): typed at home
+ * ("010 1234 5678") or abroad ("+20 10 1234 5678"), checked against its country's lengths and starts, kept as E.164
+ * ("+201012345678"), and shown at rest as the page chooses, with a call and a WhatsApp link beside it.
+ *
+ * A page says so for all its phone fields (`phone`), or a field for itself (its node's `options`); a page that says
+ * neither keeps its phone fields as text boxes, as before. `country` is the one a number typed without its + is read
+ * in, by its ISO code — never assumed: left out, a number is written with its + and country code, or its country
+ * picked beside it. `shown` writes a number at rest abroad's way ("+20 10 1234 5678", the default) or at home's
+ * ("010 1234 5678") — a number of another country always abroad's.
+ *
+ *   "phone": { "country": "EG", "shown": "national" }
+ *   { "field": "mobile", "widget": "phone", "options": { "country": "AE" } }
+ */
+const COUNTRY = /^[A-Z]{2}$/;
+const country = z.string().regex(COUNTRY, 'a country is its ISO code in capitals, such as "EG"');
+const shown = z.enum(['international', 'national'], { error: 'shown is "international" (+20 10 1234 5678) or "national" (010 1234 5678)' });
+/** A page's phone numbers: the country a number typed without its + is read in, and how a number is shown at rest. */
+exports.PagePhoneSchema = z
+    .strictObject({
+    country: country.optional(),
+    shown: shown.optional(),
+})
+    .meta({ id: 'PagePhone' });
+/** A phone field's own: the page's settings, for this field. Its other options stay as they are. */
+exports.PhoneOptionsSchema = z
+    .object({
+    country: country.optional(),
+    shown: shown.optional(),
+})
+    .meta({ id: 'PhoneOptions' });
+/** The issues of a phone field's settings, each at its path under `options`. */
+function phoneOptionIssues(node) {
+    if (node.widget !== 'phone')
+        return [];
+    return (exports.PhoneOptionsSchema.safeParse(node.options ?? {}).error?.issues ?? []).map((issue) => ({ message: issue.message, path: ['options', ...issue.path] }));
+}
+//# sourceMappingURL=phone.js.map

package/src/lib/format/phone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/format/phone.ts"],"names":[],"mappings":";;;AA0CA,8CAGC;AA7CD,yBAAyB;AAEzB;;;;;;;;;;;;;GAaG;AAEH,MAAM,OAAO,GAAG,YAAY,CAAC;AAC7B,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,qDAAqD,CAAC,CAAC;AACjG,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,2EAA2E,EAAE,CAAC,CAAC;AAE5I,sHAAsH;AACzG,QAAA,eAAe,GAAG,CAAC;KAC7B,YAAY,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;CACxB,CAAC;KACD,IAAI,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;AAI7B,oGAAoG;AACvF,QAAA,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;CACxB,CAAC;KACD,IAAI,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;AAIhC,gFAAgF;AAChF,SAAgB,iBAAiB,CAAC,IAA4D;IAC5F,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO;QAAE,OAAO,EAAE,CAAC;IACvC,OAAO,CAAC,0BAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,IAAI,CAAwB,EAAE,CAAC,CAAC,CAAC;AACtL,CAAC"}

package/src/lib/format/phone.mjs

@@ -0,0 +1,39 @@
+import * as z from 'zod';
+/**
+ * Phone numbers read and kept as one number the world over (`"widget": "phone"` on a char field): typed at home
+ * ("010 1234 5678") or abroad ("+20 10 1234 5678"), checked against its country's lengths and starts, kept as E.164
+ * ("+201012345678"), and shown at rest as the page chooses, with a call and a WhatsApp link beside it.
+ *
+ * A page says so for all its phone fields (`phone`), or a field for itself (its node's `options`); a page that says
+ * neither keeps its phone fields as text boxes, as before. `country` is the one a number typed without its + is read
+ * in, by its ISO code — never assumed: left out, a number is written with its + and country code, or its country
+ * picked beside it. `shown` writes a number at rest abroad's way ("+20 10 1234 5678", the default) or at home's
+ * ("010 1234 5678") — a number of another country always abroad's.
+ *
+ *   "phone": { "country": "EG", "shown": "national" }
+ *   { "field": "mobile", "widget": "phone", "options": { "country": "AE" } }
+ */
+const COUNTRY = /^[A-Z]{2}$/;
+const country = z.string().regex(COUNTRY, 'a country is its ISO code in capitals, such as "EG"');
+const shown = z.enum(['international', 'national'], { error: 'shown is "international" (+20 10 1234 5678) or "national" (010 1234 5678)' });
+/** A page's phone numbers: the country a number typed without its + is read in, and how a number is shown at rest. */
+export const PagePhoneSchema = z
+    .strictObject({
+    country: country.optional(),
+    shown: shown.optional(),
+})
+    .meta({ id: 'PagePhone' });
+/** A phone field's own: the page's settings, for this field. Its other options stay as they are. */
+export const PhoneOptionsSchema = z
+    .object({
+    country: country.optional(),
+    shown: shown.optional(),
+})
+    .meta({ id: 'PhoneOptions' });
+/** The issues of a phone field's settings, each at its path under `options`. */
+export function phoneOptionIssues(node) {
+    if (node.widget !== 'phone')
+        return [];
+    return (PhoneOptionsSchema.safeParse(node.options ?? {}).error?.issues ?? []).map((issue) => ({ message: issue.message, path: ['options', ...issue.path] }));
+}
+//# sourceMappingURL=phone.mjs.map

package/src/lib/format/phone.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone.mjs","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/format/phone.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;;;;;;;;;;;;GAaG;AAEH,MAAM,OAAO,GAAG,YAAY,CAAC;AAC7B,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,qDAAqD,CAAC,CAAC;AACjG,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,2EAA2E,EAAE,CAAC,CAAC;AAE5I,sHAAsH;AACtH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,YAAY,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;CACxB,CAAC;KACD,IAAI,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;AAI7B,oGAAoG;AACpG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;CACxB,CAAC;KACD,IAAI,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;AAIhC,gFAAgF;AAChF,MAAM,UAAU,iBAAiB,CAAC,IAA4D;IAC5F,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO;QAAE,OAAO,EAAE,CAAC;IACvC,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,IAAI,CAAwB,EAAE,CAAC,CAAC,CAAC;AACtL,CAAC"}

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

@@ -34,8 +34,14 @@ export declare class ReferenceCheck {
     /** The ids of the tabs and wizard steps a step can go to, and where each goTo and show names one. */
     private readonly places;
     private readonly goingTo;
+    /** The names of the slots the layout places. */
+    private readonly slots;
     constructor(page: Page, line?: LineOf | undefined);
     run(): PageIssue[];
+    /** A bot check: on a page of responses, its captcha drawn in a slot the page places. */
+    private checkBotCheck;
+    /** A time zone the browser knows, by its IANA name: a page's dates and times are never drawn on a clock it cannot read. */
+    private checkZone;
     /** Each step's goTo and show names a tab or a wizard step of this page. */
     private checkGoingTo;
     /** Where the page's own expressions read: its fields — on a line's form, the line's, with its record as parent. */
@@ -105,6 +111,8 @@ export declare class ReferenceCheck {
      * the rows chosen need a box to choose one.
      */
     private checkListCells;
+    /** A list's Edit: each field it names one value can set in many records, and rows to choose to set it on. */
+    private checkBulkEdit;
     /** A list's map: where each record is, and the fields its pin and its card show, each of a type that can. */
     private walkListMap;
     /**
@@ -126,6 +134,8 @@ export declare class ReferenceCheck {
     private walkSheet;
     /** An address with suggestions: a char field, its place kept as a place field keeps one, its parts in a json field. */
     private checkAddressSearch;
+    /** Booking slots: on a date and time, its end written in another, asked again as the fields it depends on change. */
+    private checkSlots;
     /** A picker's own settings, on the kind of field each is for: a path on a link, Fieldia's own list on a choice, a button adding tags, a colour for each state. */
     private checkPicker;
     private checkFieldNode;

package/src/lib/format/references.d.ts

@@ -34,8 +34,14 @@ export declare class ReferenceCheck {
     /** The ids of the tabs and wizard steps a step can go to, and where each goTo and show names one. */
     private readonly places;
     private readonly goingTo;
+    /** The names of the slots the layout places. */
+    private readonly slots;
     constructor(page: Page, line?: LineOf | undefined);
     run(): PageIssue[];
+    /** A bot check: on a page of responses, its captcha drawn in a slot the page places. */
+    private checkBotCheck;
+    /** A time zone the browser knows, by its IANA name: a page's dates and times are never drawn on a clock it cannot read. */
+    private checkZone;
     /** Each step's goTo and show names a tab or a wizard step of this page. */
     private checkGoingTo;
     /** Where the page's own expressions read: its fields — on a line's form, the line's, with its record as parent. */
@@ -105,6 +111,8 @@ export declare class ReferenceCheck {
      * the rows chosen need a box to choose one.
      */
     private checkListCells;
+    /** A list's Edit: each field it names one value can set in many records, and rows to choose to set it on. */
+    private checkBulkEdit;
     /** A list's map: where each record is, and the fields its pin and its card show, each of a type that can. */
     private walkListMap;
     /**
@@ -126,6 +134,8 @@ export declare class ReferenceCheck {
     private walkSheet;
     /** An address with suggestions: a char field, its place kept as a place field keeps one, its parts in a json field. */
     private checkAddressSearch;
+    /** Booking slots: on a date and time, its end written in another, asked again as the fields it depends on change. */
+    private checkSlots;
     /** A picker's own settings, on the kind of field each is for: a path on a link, Fieldia's own list on a choice, a button adding tags, a colour for each state. */
     private checkPicker;
     private checkFieldNode;

package/src/lib/format/references.js

@@ -10,7 +10,10 @@ const hotkeys_1 = require("./hotkeys");
 const head_checks_1 = require("./head-checks");
 const section_checks_1 = require("./section-checks");
 const pattern_1 = require("./pattern");
+const bulk_edit_1 = require("./bulk-edit");
+const zones_1 = require("../record/zones");
 const messages_1 = require("../record/messages");
+const autofill_group_1 = require("./autofill-group");
 const has = (record, key) => Object.prototype.hasOwnProperty.call(record, key);
 /** The kinds of field an expression can give a value to: the rest hold records, lines or files. */
 const EXPRESSIBLE = new Set(['char', 'text', 'html', 'integer', 'float', 'monetary', 'boolean', 'date', 'datetime', 'selection', 'json']);
@@ -41,11 +44,15 @@ class ReferenceCheck {
     /** The ids of the tabs and wizard steps a step can go to, and where each goTo and show names one. */
     places = new Set();
     goingTo = [];
+    /** The names of the slots the layout places. */
+    slots = new Set();
     constructor(page, line) {
         this.page = page;
         this.line = line;
     }
     run() {
+        if (this.page.timeZone !== undefined)
+            this.checkZone(this.page.timeZone, 'timeZone');
         this.checkFields(this.page.fields, 'fields', this.line?.name, this.line?.parent);
         this.walkRoot(this.page.layout, 'layout');
         (0, head_checks_1.checkHead)(this.page.layout, 'layout', {
@@ -61,9 +68,25 @@ class ReferenceCheck {
         });
         if (this.page.on)
             this.checkEvents(this.page.on, 'on');
+        if (this.page.botCheck !== undefined && !this.line)
+            this.checkBotCheck(this.page);
         this.checkGoingTo();
         return this.issues;
     }
+    /** A bot check: on a page of responses, its captcha drawn in a slot the page places. */
+    checkBotCheck(page) {
+        const check = page.botCheck;
+        if (page.data.kind !== 'responses')
+            return this.report('botCheck', 'a bot check is for a page of responses that anyone may send; a record’s page is behind the app’s own sign-in');
+        const captcha = check?.captcha;
+        if (typeof captcha === 'string' && !this.slots.has(captcha))
+            this.report('botCheck.captcha', `no slot "${captcha}" on this page to draw the captcha in: place { "type": "slot", "id": "${captcha}", "name": "${captcha}" } where it goes`);
+    }
+    /** A time zone the browser knows, by its IANA name: a page's dates and times are never drawn on a clock it cannot read. */
+    checkZone(zone, path) {
+        if (!(0, zones_1.isTimeZone)(zone))
+            this.report(path, `${JSON.stringify(zone)} is not a time zone this browser knows: name one as the IANA does, such as "Africa/Cairo"`);
+    }
     /** Each step's goTo and show names a tab or a wizard step of this page. */
     checkGoingTo() {
         for (const { target, path } of this.goingTo) {
@@ -395,6 +418,14 @@ class ReferenceCheck {
                 if (pattern instanceof Error)
                     this.report(`${path}.pattern`, (0, messages_1.fill)(messages_1.MESSAGES.en.patternBroken, { label: def.label, problem: pattern.message }));
             }
+            if (def.type === 'datetime' && def.timeZone !== undefined)
+                this.checkZone(def.timeZone, `${path}.timeZone`);
+            // A linked record's date and time, in a table of the records a many2many links to.
+            if (def.type === 'many2many' && def.fields) {
+                for (const [column, linked] of Object.entries(def.fields))
+                    if (linked.type === 'datetime' && linked.timeZone !== undefined)
+                        this.checkZone(linked.timeZone, `${path}.fields.${column}.timeZone`);
+            }
             if (def.type === 'selection')
                 def.optionsFrom?.dependsOn?.forEach((other, i) => this.need(other, `${path}.optionsFrom.dependsOn[${i}]`, fields));
             if (def.type === 'properties')
@@ -511,7 +542,11 @@ class ReferenceCheck {
         list.filters?.forEach((filter, i) => {
             this.claim(filter.id, `${path}.filters[${i}]`);
             named.add(filter.id);
-            filter.filter.forEach((item, j) => walk(item, `${path}.filters[${i}].filter[${j}]`));
+            filter.filter?.forEach((item, j) => walk(item, `${path}.filters[${i}].filter[${j}]`));
+            // A period is of a date, or a date and time.
+            const dated = filter.period ? this.need(filter.period.field, `${path}.filters[${i}].period.field`) : undefined;
+            if (dated && dated.type !== 'date' && dated.type !== 'datetime')
+                this.report(`${path}.filters[${i}].period.field`, `"${filter.period?.field}" is a ${dated.type}; a period is of a date, or a date and time`);
         });
         list.defaultFilters?.forEach((id, i) => {
             if (!named.has(id))
@@ -576,6 +611,11 @@ class ReferenceCheck {
                 this.report(at, `"${column}" is no column of this list: its cells are for its columns`);
                 continue;
             }
+            // A sum, an average, the lowest and the highest are a number column's; any column has a count.
+            const kind = this.page.fields[column]?.type;
+            if (cell.total && cell.total !== 'count' && kind && kind !== 'integer' && kind !== 'float' && kind !== 'monetary') {
+                this.report(`${at}.total`, `"${column}" is a ${kind}; its total "${cell.total}" is of numbers — an integer, a float or an amount — and any column's is "count"`);
+            }
             if (!cell.lead)
                 continue;
             const def = this.need(cell.lead.field, `${at}.lead.field`);
@@ -607,6 +647,32 @@ class ReferenceCheck {
         }
         if (list.choose === false && list.actions?.length)
             this.report(`${path}.actions`, 'a list’s buttons act on the rows chosen: with "choose": false there is no way to choose one');
+        this.checkBulkEdit(list, path);
+    }
+    /** A list's Edit: each field it names one value can set in many records, and rows to choose to set it on. */
+    checkBulkEdit(list, path) {
+        if (!list.bulkEdit)
+            return;
+        if (list.choose === false)
+            this.report(`${path}.bulkEdit`, 'Edit changes the rows chosen: with "choose": false there is no way to choose one');
+        if (list.bulkEdit === true) {
+            if (!list.columns.some((name) => (0, bulk_edit_1.bulkSettable)(this.page.fields[name])))
+                this.report(`${path}.bulkEdit`, 'Edit offers the columns one value can set, and none of these can: name the fields it offers');
+            return;
+        }
+        const named = list.bulkEdit;
+        named.forEach((name, i) => {
+            const at = `${path}.bulkEdit[${i}]`;
+            if (named.indexOf(name) !== i)
+                this.report(at, `"${name}" is offered twice`);
+            const def = this.need(name, at);
+            if (!def)
+                return;
+            if (!bulk_edit_1.BULK_KINDS.has(def.type))
+                this.report(at, `"${name}" is a ${def.type}; one value set in many records is words, a number, money, a yes or no, a date, a choice or a link`);
+            else if (def.readonly === true || def.compute)
+                this.report(at, `"${name}" is ${def.compute ? 'worked out from other fields' : 'read-only'}; Edit sets a field people can change`);
+        });
     }
     /** A list's map: where each record is, and the fields its pin and its card show, each of a type that can. */
     walkListMap(map, path) {
@@ -802,6 +868,9 @@ class ReferenceCheck {
                 return this.checkValuesIn(node.text, `${path}.text`);
             case 'map':
                 return this.walkMap(node, path);
+            case 'slot':
+                this.slots.add(node.name);
+                return;
             default:
                 return;
         }
@@ -959,6 +1028,23 @@ class ReferenceCheck {
         if (parts && parts !== 'json')
             this.report(`${path}.options.partsField`, `"${options['partsField']}" is a ${parts}; an address's parts are kept in a json field`);
     }
+    /** Booking slots: on a date and time, its end written in another, asked again as the fields it depends on change. */
+    checkSlots(node, def, path) {
+        const options = node.options ?? {};
+        if (def && def.type !== 'datetime')
+            this.report(`${path}.widget`, `slots is for a datetime field; "${node.field}" is a ${def.type}`);
+        const end = options['endField'];
+        if (typeof end === 'string' && has(this.page.fields, end)) {
+            const type = this.page.fields[end].type;
+            if (end === node.field)
+                this.report(`${path}.options.endField`, 'a booking ends in another field than the one it starts in');
+            else if (type !== 'datetime')
+                this.report(`${path}.options.endField`, `"${end}" is a ${type}; a booking's end is kept in a datetime field`);
+        }
+        const on = options['dependsOn'];
+        if (Array.isArray(on))
+            on.forEach((name, i) => typeof name === 'string' && this.need(name, `${path}.options.dependsOn[${i}]`));
+    }
     /** A picker's own settings, on the kind of field each is for: a path on a link, Fieldia's own list on a choice, a button adding tags, a colour for each state. */
     checkPicker(node, def, path) {
         const options = node.options ?? {};
@@ -1004,6 +1090,13 @@ class ReferenceCheck {
         node.tones?.forEach((tone, i) => this.checkModifiers(tone, `${path}.tones[${i}]`, ['when']));
         node.placeholderWhen?.forEach((item, i) => this.checkModifiers(item, `${path}.placeholderWhen[${i}]`, ['when']));
         this.checkModifiers(node, path, ['bold']);
+        // What the browser fills its box in with: a box names what it holds, an address in parts only whose it is. (That
+        // it is a purpose the standard lists is the format's check, `validatePage`, as other shapes are.)
+        if (typeof node.autocomplete === 'string') {
+            const problem = (0, autofill_group_1.autofillGroupProblem)(node.autocomplete, node.widget === 'address');
+            if (problem)
+                this.report(`${path}.autocomplete`, problem);
+        }
         if (def && node.totals) {
             if (def.type !== 'one2many') {
                 this.report(`${path}.totals`, `totals only apply to one2many fields; "${node.field}" is a ${def.type}`);
@@ -1026,6 +1119,8 @@ class ReferenceCheck {
         }
         if (node.widget === 'address-search')
             this.checkAddressSearch(node, def, path);
+        if (node.widget === 'slots')
+            this.checkSlots(node, def, path);
         if (def)
             this.checkPicker(node, def, path);
         // The order lines load in: fields of its lines.