@fieldia/core 0.24.0 → 0.26.0

package/src/lib/record/form.mjs

@@ -12,8 +12,10 @@ import { firstValues, readLooseMap, readValueMap } from './value-map.mjs';
 import { resolveFilter } from './filter.mjs';
 import { rolesAllow } from './roles.mjs';
 import { compileFieldTone, compileTable } from './cells.mjs';
-import { fill, MESSAGES } from './messages.mjs';
+import { fillMessage, MESSAGES } from './messages.mjs';
+import { recordSentence } from './record-words.mjs';
 import { loadedRecordOf, saveProblemOf, } from './data-source.mjs';
+import { waitingOn, workedOutFrom } from './waits.mjs';
 import { createUploads, fileBytesIn, uploadGoing, withoutFileBytes } from './uploads.mjs';
 import { hostScheduler } from './scheduler.mjs';
 import { createMoments, createRunner } from './run.mjs';
@@ -74,7 +76,10 @@ function innerForm(options, within, place, outer) {
     // Its time zone written into each date and time field naming none, for whatever reads one from its field alone.
     const page = zonedPage(options.page);
     const scheduler = options.scheduler ?? hostScheduler;
-    const messages = options.messages ?? MESSAGES.en;
+    // A field's label small inside a message's sentence where the page asks (`lowerLabels`).
+    const messages = page.lowerLabels ? { ...(options.messages ?? MESSAGES.en), lowerLabels: true } : (options.messages ?? MESSAGES.en);
+    /** One of the form's sentences in the words the page names its records by (`records`), else as the language says it plainly. */
+    const named = (noun, plain) => recordSentence(page.records, noun, plain, messages.locale);
     const index = indexLayout(page.layout);
     /** Each field node's answer rules, read once. */
     const nodeRules = new Map();
@@ -158,6 +163,8 @@ function innerForm(options, within, place, outer) {
     const editingNow = () => editing && !(started && state.can?.edit === false);
     const about = () => ({ recordId: started ? state.recordId : (options.recordId ?? null), user: options.user, editing: editingNow(), context: options.context, parent: parentContext });
     const computed = compileComputed(page, today, about);
+    /** Each value worked out from others — by the page, or by the app as the lines change — and what it waits for. */
+    const workedOut = workedOutFrom(page, !!options.dataSource?.onchange && page.data.kind === 'record', !!options.parent);
     const setWhen = compileSetWhen(page, today, about);
     /** The saved forms placed on the page, by the part's id: each one's answers sit under its name, as JSON. */
     const parts = new Map();
@@ -317,6 +324,13 @@ function innerForm(options, within, place, outer) {
      * for is still the one shown, as it was. A save's answer, a call's, an onchange's, a name looked up, a line's
      * dialog, a record step's — none is laid on another record, nor over the values the person's Discard let go.
      */
+    /** The data source with a member a record's page asks of it, and the page's model: refused where either is missing. */
+    function recordSource(member) {
+        const source = options.dataSource;
+        if (page.data.kind !== 'record' || !source?.[member])
+            throw new Error(`The data source has no ${member}()`);
+        return [source, page.data.model];
+    }
     function shownNow() {
         const at = generation;
         const reset = resets;
@@ -848,7 +862,7 @@ function innerForm(options, within, place, outer) {
             return undefined;
         const at = (v) => (def.type === 'datetime' ? Date.parse(v) : Date.parse(v.slice(0, 10)));
         if (at(value) < at(start))
-            return fill(messages.endBeforeStart, { end: def.label, start: page.fields[node.field].label });
+            return fillMessage(messages, messages.endBeforeStart, { end: def.label, start: page.fields[node.field].label });
         return undefined;
     }
     /** Errors for the visible fields under `root`, without publishing them. */
@@ -1237,13 +1251,13 @@ function innerForm(options, within, place, outer) {
     async function savingNow(chain) {
         // A record its source does not let this person change is refused here, in its words or the form's: no source is asked.
         if (page.data.kind === 'record' && state.can?.edit === false) {
-            const problem = { kind: 'rule', message: state.can.reason ?? messages.mayNotEdit };
+            const problem = { kind: 'rule', message: state.can.reason ?? named(messages.mayNotEditNoun, messages.mayNotEdit) };
             set({ status: 'error', error: problem.message, saveProblem: problem, conflict: null });
             return { reason: 'save', message: problem.message };
         }
         // Asked for the record shown now: another shown while it waits below, it saves nothing of that one, nor says anything there.
         const asked = generation;
-        const elsewhere = () => ({ reason: 'save', message: messages.recordReplaced });
+        const elsewhere = () => ({ reason: 'save', message: named(messages.recordReplacedNoun, messages.recordReplaced) });
         // What is still typed in a box is read first: it is what is saved, or why nothing is. A name still being looked
         // up is waited for, so the record it names is what is saved — or, named by none, why nothing is.
         const waiting = readTyped();
@@ -1443,6 +1457,16 @@ function innerForm(options, within, place, outer) {
             changed(name, by, { keep });
     }
     /** A line added: the person's, theirs; a step's, none of theirs, and the lines they changed stay theirs. */
+    /** What a line added now starts with: each line field's default, then what is worked out from its defaultFrom, then the record's lineDefaults. */
+    function newLineValues(field) {
+        const def = lineField(field);
+        const lineFields = def.fields;
+        const start = initialValues(lineFields, today());
+        Object.assign(start, firstValues(lineFields, lineScope(field, start)));
+        if (def.lineDefaults)
+            Object.assign(start, readValueMap(def.lineDefaults, lineFields, recordScope()));
+        return start;
+    }
     function addLine(field, values, by) {
         const def = lineField(field);
         const current = state.values[field] ?? [];
@@ -1450,13 +1474,7 @@ function innerForm(options, within, place, outer) {
         let key = `new-${++lineKeys}`;
         while (current.some((line) => line.key === key))
             key = `new-${++lineKeys}`;
-        // Each line field's default, then what is worked out from its defaultFrom, then the record's lineDefaults, then what the line is given.
-        const lineFields = def.fields;
-        const start = initialValues(lineFields, today());
-        Object.assign(start, firstValues(lineFields, lineScope(field, start)));
-        if (def.lineDefaults)
-            Object.assign(start, readValueMap(def.lineDefaults, lineFields, recordScope()));
-        const line = { key, values: { ...start, ...structuredCopy(values) } };
+        const line = { key, values: { ...newLineValues(field), ...structuredCopy(values) } };
         // A new line comes last, so it is numbered after the last.
         if (def.sequenceField && line.values[def.sequenceField] == null) {
             const numbers = current.map((l) => l.values[def.sequenceField]).filter((n) => typeof n === 'number');
@@ -1727,7 +1745,7 @@ function innerForm(options, within, place, outer) {
         return going;
     }
     async function askToLetGo() {
-        const message = messages.discardChanges;
+        const message = named(messages.discardChangesNoun, messages.discardChanges);
         const host = options.host;
         let yes = false;
         try {
@@ -1786,7 +1804,7 @@ function innerForm(options, within, place, outer) {
         const go = letGo({}, chain);
         return go === true ? null : go.then((yes) => (yes ? null : kept()));
     }
-    const kept = () => ({ reason: 'no', message: messages.discardChanges });
+    const kept = () => ({ reason: 'no', message: named(messages.discardChangesNoun, messages.discardChanges) });
     /**
      * A step's own move — the record loaded again, or another shown — once the check let what is shown go: kept, the
      * person kept their work; replaced, another record was shown before it ended (the run's steps are not for that one).
@@ -1823,7 +1841,7 @@ function innerForm(options, within, place, outer) {
     }
     /** Why a run stops whose record was replaced while it went on — quietly, when the form was closed. */
     function replaced() {
-        return disposed ? { reason: 'closed' } : { reason: 'cannot', message: messages.recordReplaced };
+        return disposed ? { reason: 'closed' } : { reason: 'cannot', message: named(messages.recordReplacedNoun, messages.recordReplaced) };
     }
     /** The record a record step asks the data source about. */
     const record = () => ({ model: page.data.model, id: state.recordId, fields });
@@ -1933,7 +1951,7 @@ function innerForm(options, within, place, outer) {
         },
         post,
         wordsOf: (field) => wordsOfValue(fieldDef(field), state.values[field]),
-        barred: (right) => (state.can?.[right] === false ? state.can.reason ?? messages[MAY_NOT[right]] : null),
+        barred: (right) => (state.can?.[right] === false ? state.can.reason ?? named(messages[`${MAY_NOT[right]}Noun`], messages[MAY_NOT[right]]) : null),
     });
     // A moment's run is on the record it was set off on: one set off again while its run goes, and run after it, is let
     // go when another record is shown by then (its steps were for that one).
@@ -1961,7 +1979,7 @@ function innerForm(options, within, place, outer) {
         const builtin = 'builtin' in source && !list.length ? source.builtin : undefined;
         if (builtin)
             list.push({ do: builtin });
-        const asked = builtin === 'archive' ? messages.archiveConfirm : builtin === 'delete' ? messages.deleteConfirm : undefined;
+        const asked = builtin === 'archive' ? named(messages.archiveConfirmNoun, messages.archiveConfirm) : builtin === 'delete' ? named(messages.deleteConfirmNoun, messages.deleteConfirm) : undefined;
         const confirm = 'confirm' in source && source.confirm !== undefined ? source.confirm : asked;
         // On the record it was pressed on: another shown while its question is asked, it does nothing to that one.
         scope.generation ??= generation;
@@ -2020,6 +2038,13 @@ function innerForm(options, within, place, outer) {
         leave: (how) => Promise.resolve(letGo(how)),
         leaveNow: (how = {}) => (outer ? outer.leaveNow(how) : atOnce(how)),
         recordShown: shownNow,
+        relatedFilter(id) {
+            const node = index.get(id)?.source;
+            if (node?.type !== 'related' || state.recordId == null)
+                return null;
+            const related = node;
+            return [{ field: related.field, op: '=', value: state.recordId }, ...(related.filter ? resolveFilter(related.filter, context()) : [])];
+        },
         post,
         setEditing(next) {
             if (next === editing)
@@ -2032,6 +2057,10 @@ function innerForm(options, within, place, outer) {
         loadChoices,
         loadDefinitions,
         addDefinition,
+        waitsFor(name) {
+            const from = workedOut.get(name);
+            return from ? waitingOn(page, from, state.values, state.unread) : null;
+        },
         problem(name) {
             fieldDef(name);
             // Only a field someone can see is asked anything, and required wherever it is shown so.
@@ -2110,6 +2139,7 @@ function innerForm(options, within, place, outer) {
         save: () => track(save()),
         canUpload: () => typeof options.dataSource?.upload === 'function',
         today,
+        recordReads: (id, values, fields) => recordContext(values, fields ?? page.fields, { recordId: id, user: options.user, editing: false, context: options.context }),
         canFindSlots: () => typeof options.dataSource?.slots === 'function',
         findSlots(field, ask) {
             const source = options.dataSource;
@@ -2130,6 +2160,28 @@ function innerForm(options, within, place, outer) {
                 values: structuredCopy(state.values),
             });
         },
+        canFindDuplicates: () => !!(page.data.kind === 'record' && page.duplicates?.fields?.length && options.dataSource?.duplicates),
+        async findDuplicates() {
+            const [source, model] = recordSource('duplicates');
+            const fields = (page.duplicates?.fields ?? []).filter((name) => page.fields[name] && !isEmpty(page.fields[name], state.values[name]));
+            const recordId = state.recordId;
+            // Nothing typed in any of them: nothing asked.
+            if (!fields.length)
+                return [];
+            const { matches } = await source.duplicates({ model, recordId, values: structuredCopy(state.values), fields });
+            // Never the record itself, whatever the source says; the likest first where it scores them.
+            const others = (matches ?? []).filter((match) => match && String(match.id) !== String(recordId));
+            return others.every((match) => typeof match.score === 'number') ? others.sort((a, b) => b.score - a.score) : others;
+        },
+        canMerge: () => !!(page.data.kind === 'record' && options.dataSource?.merge && options.dataSource.load),
+        async readRecord(id) {
+            const [source, model] = recordSource('load');
+            return loadedRecordOf(await source.load({ model, id, fields: page.fields })).values;
+        },
+        async merge(request) {
+            const [source, model] = recordSource('merge');
+            return source.merge({ model, keepId: request.keepId, mergeIds: [...request.mergeIds], values: structuredCopy(request.values), fields: page.fields });
+        },
         upload: (field, files, how = {}) => uploads.start(field, files, how),
         uploading: (field) => state.uploads.filter((upload) => upload.field === field && !upload.line),
         cancelUpload(id) {
@@ -2242,7 +2294,7 @@ function innerForm(options, within, place, outer) {
             const sub = def.fields[subfield];
             if (!sub)
                 throw new Error(`The lines of "${field}" have no field "${subfield}"`);
-            const line = (state.values[field] ?? []).find((l) => l.key === key);
+            const line = key === null ? { values: newLineValues(field), id: null } : (state.values[field] ?? []).find((l) => l.key === key);
             if (!line)
                 throw new Error(`"${field}" has no line "${key}"`);
             return runSearch(sub, subfield, lineContext(line.values, def.fields, context(), line.id ?? null), query, limit, options);
@@ -2806,6 +2858,12 @@ function indexLayout(root) {
             else if (node.type === 'form') {
                 add(node, parent, 'form', { invisible: node.invisible, readonly: node.readonly });
             }
+            else if (node.type === 'related') {
+                add(node, parent, 'other', { invisible: node.invisible });
+                // A row's buttons: their roles here, hidden with the list, their condition read by it on each row's record.
+                for (const button of node.rowButtons ?? [])
+                    add(button, node.id, 'button', {});
+            }
             else {
                 add(node, parent, 'other', { invisible: node.invisible });
             }
@@ -2832,6 +2890,9 @@ function indexLayout(root) {
         // A list holds no fields of its own record: only the buttons for what is selected.
         for (const button of root.actions ?? [])
             add(button, root.id, 'button', { invisible: button.invisible });
+        // A row's buttons: their roles here, their condition read by the list on each row's record, which the form does not hold.
+        for (const button of root.rowButtons ?? [])
+            add(button, root.id, 'button', {});
     }
     else {
         // The title and statusbar show fields too, so they are validated like