@fieldia/core 0.28.0 → 0.30.0

package/src/lib/record/form.mjs

@@ -21,6 +21,8 @@ import { recordSentence } from './record-words.mjs';
 import { askKey, cellOf, listedColumns, notOffered } from './line-choices.mjs';
 import { loadedRecordOf, saveProblemOf, } from './data-source.mjs';
 import { formLimitsPart, hasLimits } from './taking.mjs';
+import { formLanguagesPart, hasLanguages } from './languages.mjs';
+import { formApprovalsPart } from './approving.mjs';
 import { draftRead, resumeStep } from './drafts.mjs';
 import { waitingOn, workedOutFrom } from './waits.mjs';
 import { createUploads, fileBytesIn, uploadGoing, withoutFileBytes } from './uploads.mjs';
@@ -361,6 +363,7 @@ function innerForm(options, within, place, outer) {
         // Worked out once the form has its state, as the limits part comes (`limitsCode`).
         limits: null,
         resume: null,
+        approval: null,
     };
     started = true;
     /**
@@ -957,6 +960,10 @@ function innerForm(options, within, place, outer) {
     }
     if (hasOptionRules(page))
         void track(optionsCode());
+    // A text in several languages is checked by the languages part: asked for at once, a save waiting for it.
+    const languagesCode = () => formLanguagesPart.load().then(() => undefined, () => undefined);
+    if (hasLanguages(page))
+        void track(languagesCode());
     /** A table line's choice's options as they are offered on that line: its list's once loaded, or its own, by their conditions once they came. */
     function lineOffered(lines, line, column, record) {
         if (optionKit)
@@ -1124,6 +1131,9 @@ function innerForm(options, within, place, outer) {
         const answer = answerOf(node);
         if (answer !== undefined && signedNow().has(answer))
             readonly = true;
+        // A record waiting for approval: locked but for the fields the page leaves open (the approvals part).
+        if (answer !== undefined && approvalKit?.locks(answer))
+            readonly = true;
         return {
             invisible,
             readonly: readonly || (def !== undefined && lockedField(def)),
@@ -1762,6 +1772,15 @@ function innerForm(options, within, place, outer) {
     }
     /** A choice of a full option, picked by the person, refused under its field: the field keeps what it held. */
     const refusedFull = (name, value) => !!limitsKit?.refusedFull(name, value);
+    // ---- a record's approvals (the approvals part: form-approvals.ts) ---------------------------------------------------
+    /** The approvals made for this form from the approvals part, once it came: none before, nor on a page without them. */
+    let approvalKit = null;
+    /** Whether the form asks for approvals: a page with `approval` (a record's own, as its check says), its source telling them. */
+    const keepsApprovals = !outer && !!page.approval && !!options.dataSource?.approvals;
+    /** The approvals, made from their part once it came; null without them, or where it could not come. */
+    const approvalsCode = () => keepsApprovals ? formApprovalsPart.load().then((part) => (approvalKit ??= part.formApprovals({ form, dataSource: options.dataSource, messages, set, reload: () => load(true) })), () => null) : Promise.resolve(null);
+    /** Ask the record shown's approvals, once their part came; nothing on a page without them. */
+    const askApprovals = () => approvalsCode().then((kit) => kit?.ask());
     function scheduleAutosave() {
         const autosave = options.autosave;
         // A record the person may not change is never saved unasked: it would only be refused.
@@ -1908,6 +1927,12 @@ function innerForm(options, within, place, outer) {
             if (asked !== generation)
                 return elsewhere();
         }
+        // A text in several languages, checked in each once its part has come.
+        if (!formLanguagesPart.loaded && hasLanguages(page)) {
+            await languagesCode();
+            if (asked !== generation)
+                return elsewhere();
+        }
         // Values the app's functions are asked for are waited for — those that failed asked again — so what is saved is worked out.
         if (asking.size || Object.values(state.asked).some((found) => found.failed !== undefined)) {
             set({ status: 'saving', error: null, saveProblem: null });
@@ -2031,6 +2056,9 @@ function innerForm(options, within, place, outer) {
                 scheduleDraft();
                 scheduleAutosave();
             }
+            // A save may have sent it for approval, or moved it on: its approvals asked again.
+            if (keepsApprovals)
+                void track(askApprovals());
             // The record as this save left it: a change made while it was on its way is no value of it.
             emit('save', { recordId: state.recordId, values: baseline });
             void track(moment('on.afterSave', page.on?.afterSave, chain, false));
@@ -2237,7 +2265,7 @@ function innerForm(options, within, place, outer) {
             throw new Error(`"${name}" cannot make records: its data source has no create, or it is not a link`);
         return track(source.create({ model, name: typed.trim(), ...(Object.keys(values).length ? { values } : {}) }));
     }
-    async function runSearch(def, name, ctx, query, limit, { model, ids, exact } = {}) {
+    async function runSearch(def, name, ctx, query, limit, { model, ids, exact, field } = {}) {
         // Formatted text names people and records in place (@mention, #4127): searched by the model they are of.
         const byModel = def.type === 'reference' || def.type === 'json' || def.type === 'html';
         if (def.type !== 'many2one' && def.type !== 'many2many' && !byModel) {
@@ -2250,9 +2278,11 @@ function innerForm(options, within, place, outer) {
             return [];
         // Every valueFrom, in groups too, becomes the value it names before the search goes out.
         const own = byModel || !def.filter ? undefined : resolveFilter(def.filter, ctx);
-        const filter = ids ? [...(own ?? []), { field: 'id', op: 'in', value: ids }] : own;
+        const kept = ids ? [...(own ?? []), { field: 'id', op: 'in', value: ids }] : own;
+        // A code read by a scanner: the records whose field holds it, whatever their names.
+        const filter = field ? [...(kept ?? []), { field, op: '=', value: query }] : kept;
         const relation = byModel ? model : def.relation;
-        return track(source.search({ model: relation, query, ...(filter ? { filter } : {}), limit, ...(exact ? { exact: true } : {}) }));
+        return track(source.search({ model: relation, query: field ? '' : query, ...(filter ? { filter } : {}), limit, ...(exact ? { exact: true } : {}) }));
     }
     function lineField(field) {
         const def = fieldDef(field);
@@ -2293,6 +2323,9 @@ function innerForm(options, within, place, outer) {
             loadedOnce = true;
             if (asksLimits())
                 void track(askLimits());
+            // Its approvals: where it stands, what was decided, what this person may decide — its fields locked while it waits.
+            if (keepsApprovals)
+                void track(askApprovals());
             if (again)
                 return;
             offerDraft();
@@ -2325,7 +2358,7 @@ function innerForm(options, within, place, outer) {
         found = null;
         serverKey = null;
         draftEpoch++;
-        const fresh = { dirty: [], errors: {}, warning: null, warningField: null, error: null, draft: null, step: steps[0] ?? null, skipped: [], saveProblem: null, version: null, can: null, conflict: null, setAside: null, unsent: [], unread: {}, takenOut: {}, resume: null };
+        const fresh = { dirty: [], errors: {}, warning: null, warningField: null, error: null, draft: null, step: steps[0] ?? null, skipped: [], saveProblem: null, version: null, can: null, conflict: null, setAside: null, unsent: [], unread: {}, takenOut: {}, resume: null, approval: null };
         if (id != null) {
             set({ ...fresh, recordId: id, status: 'idle' });
             await load();
@@ -2744,7 +2777,7 @@ function innerForm(options, within, place, outer) {
             // Nothing of the record changed; what shows of it may have.
             set({});
         },
-        fieldReadonly: (name) => lockedField(fieldDef(name)) || state.can?.edit === false || state.can?.readonlyFields?.includes(name) === true || signedNow().has(name),
+        fieldReadonly: (name) => lockedField(fieldDef(name)) || state.can?.edit === false || state.can?.readonlyFields?.includes(name) === true || signedNow().has(name) || !!approvalKit?.locks(name),
         loadChoices: (field) => loadChoices(field),
         loadDefinitions,
         addDefinition,
@@ -3242,6 +3275,14 @@ function innerForm(options, within, place, outer) {
             return saved;
         },
         refreshLimits: () => askLimits(),
+        refreshApprovals: askApprovals,
+        async decide(level, decision, reason) {
+            const kit = await approvalsCode();
+            if (!kit)
+                throw new Error('No approvals on this page');
+            return track(kit.decide(level, decision, reason));
+        },
+        approvalLock: (name) => approvalKit?.lockWords(name) ?? null,
         async reloadTheirs() {
             // A save on its way first: its answer is not dropped by the load.
             const asked = shownNow();
@@ -3426,6 +3467,9 @@ function innerForm(options, within, place, outer) {
     // choice's places as the source tells them: a record's own once it is loaded, its own choices not counted against it.
     if (keepsLimits())
         void track(limitsCode());
+    // A record's approvals: their part asked for as the form is made, ready by the time its record is loaded.
+    if (keepsApprovals)
+        void track(approvalsCode());
     // A new form has its values now — a draft continued from its key once it is laid — and opens once whoever made it
     // has had the chance to listen.
     if (state.recordId == null) {
@@ -3596,7 +3640,14 @@ function indexLayout(root, functions) {
             ...(does.length ? { does } : {}),
             source,
         });
-        // A button's menu: each item a button of the record, hidden with it.
+        // A menu's built-in Archive shows while the record is active, Unarchive while it is not.
+        const builtin = source.builtin;
+        if (builtin === 'archive' || builtin === 'unarchive') {
+            const own = index.get(source.id);
+            const mine = own.invisible;
+            own.invisible = { ...mine, evaluate: (context, env) => (context['active'] === false) !== (builtin === 'unarchive') || mine.evaluate(context, env) };
+        }
+        // A button's menu, and a menu inside a menu: each item a button of the record, hidden with it.
         if (kind === 'button')
             for (const item of source.menu ?? [])
                 add(item, source.id, 'button', { invisible: item.invisible });
@@ -3705,16 +3756,10 @@ function indexLayout(root, functions) {
         walk(head?.band?.children ?? [], root.id);
         if (root.sidePanel)
             add(root.sidePanel, root.id, 'other', { invisible: root.sidePanel.invisible });
-        // The gear menu's items are buttons of the record; Archive shows while it is active, Unarchive while it is not.
-        for (const item of root.toolbar?.menu ?? []) {
+        // The gear menu's items are buttons of the record — those of a menu inside it too, hidden with the item that opens
+        // it (add's own); Archive shows while it is active, Unarchive while it is not.
+        for (const item of root.toolbar?.menu ?? [])
             add(item, root.id, 'button', { invisible: item.invisible });
-            if (item.builtin === 'archive' || item.builtin === 'unarchive') {
-                const own = index.get(item.id);
-                const mine = own.invisible;
-                const archived = item.builtin === 'unarchive';
-                own.invisible = { ...mine, evaluate: (context, env) => (context['active'] === false) !== archived || mine.evaluate(context, env) };
-            }
-        }
         if (root.attachmentPreview)
             add({ id: '#preview', ...root.attachmentPreview }, root.id, 'other', { invisible: root.attachmentPreview.invisible });
     }