@fieldia/designer 0.0.0-stage → 0.12.0

package/src/lib/find-anything.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openFind = openFind;
+exports.settingItems = settingItems;
+const icons_1 = require("./icons");
+let count = 0;
+function openFind(el, root, items, words) {
+    const doc = root.ownerDocument;
+    const w = words.bar;
+    const opener = doc.activeElement;
+    const id = `fd-find-${++count}`;
+    const input = el('input', {
+        class: 'fd-find-input',
+        role: 'combobox',
+        'aria-label': w.findAnything,
+        'aria-expanded': 'true',
+        'aria-controls': `${id}-list`,
+        'aria-autocomplete': 'list',
+        autocomplete: 'off',
+        spellcheck: 'false',
+        placeholder: w.findPlaceholder,
+    });
+    const list = el('div', { class: 'fd-find-list', role: 'listbox', id: `${id}-list`, 'aria-label': w.found });
+    const none = el('p', { class: 'fd-find-none', hidden: '' }, w.nothingFound);
+    const box = el('div', { class: 'fd-find', role: 'dialog', 'aria-modal': 'true', 'aria-label': w.findAnything }, input, list, none);
+    const backdrop = el('div', { class: 'fd-dialog-backdrop fd-find-backdrop' }, box);
+    let found = items;
+    let at = 0;
+    function draw() {
+        const words = input.value.toLowerCase().split(/\s+/).filter(Boolean);
+        found = items.filter((item) => words.every((word) => item.label.toLowerCase().includes(word)));
+        at = Math.min(at, Math.max(0, found.length - 1));
+        const iconed = found.some((item) => item.icon);
+        list.replaceChildren(...found.map((item, i) => {
+            const option = el('div', { class: 'fd-find-option', role: 'option', id: `${id}-${i}`, 'aria-selected': String(i === at) }, ...(item.icon ? [(0, icons_1.designerIcon)(doc, item.icon)] : iconed ? [el('span', { class: 'fd-find-icon-room', 'aria-hidden': 'true' })] : []), el('span', { class: 'fd-find-label' }, item.label), ...(item.hint ? [el('span', { class: 'fd-find-hint' }, item.hint)] : []));
+            option.addEventListener('pointerdown', (event) => event.preventDefault());
+            option.addEventListener('click', () => run(item));
+            return option;
+        }));
+        none.hidden = found.length > 0;
+        if (found.length)
+            input.setAttribute('aria-activedescendant', `${id}-${at}`);
+        else
+            input.removeAttribute('aria-activedescendant');
+        list.querySelector('[aria-selected="true"]')?.scrollIntoView?.({ block: 'nearest' });
+    }
+    function close(refocus = true) {
+        backdrop.remove();
+        if (refocus)
+            opener?.focus?.();
+    }
+    function run(item) {
+        // Closed first, focus back where it was: what it runs may put the cursor somewhere else,
+        // and a dialog it opens gives focus back there when it closes.
+        close();
+        item.run();
+    }
+    input.addEventListener('input', () => {
+        at = 0;
+        draw();
+    });
+    input.addEventListener('keydown', (event) => {
+        if (event.key === 'ArrowDown' || event.key === 'ArrowUp') {
+            event.preventDefault();
+            if (!found.length)
+                return;
+            at = (at + (event.key === 'ArrowDown' ? 1 : -1) + found.length) % found.length;
+            draw();
+        }
+        else if (event.key === 'Enter') {
+            event.preventDefault();
+            if (found[at])
+                run(found[at]);
+        }
+        else if (event.key === 'Escape') {
+            event.preventDefault();
+            event.stopPropagation();
+            close();
+        }
+        else if (event.key === 'Tab')
+            event.preventDefault();
+    });
+    backdrop.addEventListener('pointerdown', (event) => event.target === backdrop && close());
+    draw();
+    root.append(backdrop);
+    // Focused now, not a frame later: what is typed straight after ⌘K lands in the box.
+    input.focus();
+    return { close };
+}
+/**
+ * The panel's settings as things to find: each by its name, and each of its
+ * choices as "Labels: beside" — by the choices' own group where a setting
+ * has several, as Columns has one for each size of screen.
+ */
+function settingItems(entries, open, words, kind = words.bar.setting) {
+    return entries.flatMap((entry) => {
+        const hint = words.bar.settingHint(kind, entry.tab);
+        const groups = new Set(entry.choices.map((c) => c.group));
+        return [
+            { label: entry.name, hint, run: () => open(entry) },
+            ...entry.choices.map((choice) => ({
+                label: words.bar.settingChoice(groups.size > 1 && choice.group ? choice.group : entry.name, choice.words),
+                hint,
+                run: () => open(entry, choice.value),
+            })),
+        ];
+    });
+}
+//# sourceMappingURL=find-anything.js.map

package/src/lib/find-anything.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-anything.js","sourceRoot":"","sources":["../../../../../libs/designer/src/lib/find-anything.ts"],"names":[],"mappings":";;AAsBA,4BAkFC;AAgBD,oCAaC;AApID,mCAAuC;AAmBvC,IAAI,KAAK,GAAG,CAAC,CAAC;AAEd,SAAgB,QAAQ,CAAC,EAAkB,EAAE,IAAiB,EAAE,KAAiB,EAAE,KAAoB;IACrG,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;IAC/B,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC;IACpB,MAAM,MAAM,GAAG,GAAG,CAAC,aAAmC,CAAC;IACvD,MAAM,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,EAAE;QACxB,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,eAAe,EAAE,MAAM;QACvB,eAAe,EAAE,GAAG,EAAE,OAAO;QAC7B,mBAAmB,EAAE,MAAM;QAC3B,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,OAAO;QACnB,WAAW,EAAE,CAAC,CAAC,eAAe;KAC/B,CAAqB,CAAC;IACvB,MAAM,IAAI,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5G,MAAM,IAAI,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;IAC5E,MAAM,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACnI,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,qCAAqC,EAAE,EAAE,GAAG,CAAC,CAAC;IAElF,IAAI,KAAK,GAAe,KAAK,CAAC;IAC9B,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,SAAS,IAAI;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/F,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,CAClB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,EAAE,CACf,KAAK,EACL,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAChG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,oBAAY,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EACnI,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAClD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACzE,CAAC;YACF,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YAClD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CACH,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,CAAC,MAAM;YAAE,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;;YACxE,KAAK,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACvF,CAAC;IACD,SAAS,KAAK,CAAC,OAAO,GAAG,IAAI;QAC3B,QAAQ,CAAC,MAAM,EAAE,CAAC;QAClB,IAAI,OAAO;YAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;IACjC,CAAC;IACD,SAAS,GAAG,CAAC,IAAc;QACzB,yFAAyF;QACzF,+DAA+D;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IACD,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QACnC,EAAE,GAAG,CAAC,CAAC;QACP,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACzD,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,OAAO;YAC1B,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YAC/E,IAAI,EAAE,CAAC;QACT,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC;YACjC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,KAAK,CAAC,EAAE,CAAC;gBAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YAClC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,KAAK,EAAE,CAAC;QACV,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK;YAAE,KAAK,CAAC,cAAc,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;IAC1F,IAAI,EAAE,CAAC;IACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtB,oFAAoF;IACpF,KAAK,CAAC,KAAK,EAAE,CAAC;IACd,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC;AAWD;;;;GAIG;AACH,SAAgB,YAAY,CAAyB,OAAqB,EAAE,IAAyC,EAAE,KAAoB,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO;IACnK,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,OAAO;YACL,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACnD,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAChC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;gBACzG,IAAI;gBACJ,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;aACrC,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/find-anything.mjs

@@ -0,0 +1,105 @@
+import { designerIcon } from './icons.mjs';
+let count = 0;
+export function openFind(el, root, items, words) {
+    const doc = root.ownerDocument;
+    const w = words.bar;
+    const opener = doc.activeElement;
+    const id = `fd-find-${++count}`;
+    const input = el('input', {
+        class: 'fd-find-input',
+        role: 'combobox',
+        'aria-label': w.findAnything,
+        'aria-expanded': 'true',
+        'aria-controls': `${id}-list`,
+        'aria-autocomplete': 'list',
+        autocomplete: 'off',
+        spellcheck: 'false',
+        placeholder: w.findPlaceholder,
+    });
+    const list = el('div', { class: 'fd-find-list', role: 'listbox', id: `${id}-list`, 'aria-label': w.found });
+    const none = el('p', { class: 'fd-find-none', hidden: '' }, w.nothingFound);
+    const box = el('div', { class: 'fd-find', role: 'dialog', 'aria-modal': 'true', 'aria-label': w.findAnything }, input, list, none);
+    const backdrop = el('div', { class: 'fd-dialog-backdrop fd-find-backdrop' }, box);
+    let found = items;
+    let at = 0;
+    function draw() {
+        const words = input.value.toLowerCase().split(/\s+/).filter(Boolean);
+        found = items.filter((item) => words.every((word) => item.label.toLowerCase().includes(word)));
+        at = Math.min(at, Math.max(0, found.length - 1));
+        const iconed = found.some((item) => item.icon);
+        list.replaceChildren(...found.map((item, i) => {
+            const option = el('div', { class: 'fd-find-option', role: 'option', id: `${id}-${i}`, 'aria-selected': String(i === at) }, ...(item.icon ? [designerIcon(doc, item.icon)] : iconed ? [el('span', { class: 'fd-find-icon-room', 'aria-hidden': 'true' })] : []), el('span', { class: 'fd-find-label' }, item.label), ...(item.hint ? [el('span', { class: 'fd-find-hint' }, item.hint)] : []));
+            option.addEventListener('pointerdown', (event) => event.preventDefault());
+            option.addEventListener('click', () => run(item));
+            return option;
+        }));
+        none.hidden = found.length > 0;
+        if (found.length)
+            input.setAttribute('aria-activedescendant', `${id}-${at}`);
+        else
+            input.removeAttribute('aria-activedescendant');
+        list.querySelector('[aria-selected="true"]')?.scrollIntoView?.({ block: 'nearest' });
+    }
+    function close(refocus = true) {
+        backdrop.remove();
+        if (refocus)
+            opener?.focus?.();
+    }
+    function run(item) {
+        // Closed first, focus back where it was: what it runs may put the cursor somewhere else,
+        // and a dialog it opens gives focus back there when it closes.
+        close();
+        item.run();
+    }
+    input.addEventListener('input', () => {
+        at = 0;
+        draw();
+    });
+    input.addEventListener('keydown', (event) => {
+        if (event.key === 'ArrowDown' || event.key === 'ArrowUp') {
+            event.preventDefault();
+            if (!found.length)
+                return;
+            at = (at + (event.key === 'ArrowDown' ? 1 : -1) + found.length) % found.length;
+            draw();
+        }
+        else if (event.key === 'Enter') {
+            event.preventDefault();
+            if (found[at])
+                run(found[at]);
+        }
+        else if (event.key === 'Escape') {
+            event.preventDefault();
+            event.stopPropagation();
+            close();
+        }
+        else if (event.key === 'Tab')
+            event.preventDefault();
+    });
+    backdrop.addEventListener('pointerdown', (event) => event.target === backdrop && close());
+    draw();
+    root.append(backdrop);
+    // Focused now, not a frame later: what is typed straight after ⌘K lands in the box.
+    input.focus();
+    return { close };
+}
+/**
+ * The panel's settings as things to find: each by its name, and each of its
+ * choices as "Labels: beside" — by the choices' own group where a setting
+ * has several, as Columns has one for each size of screen.
+ */
+export function settingItems(entries, open, words, kind = words.bar.setting) {
+    return entries.flatMap((entry) => {
+        const hint = words.bar.settingHint(kind, entry.tab);
+        const groups = new Set(entry.choices.map((c) => c.group));
+        return [
+            { label: entry.name, hint, run: () => open(entry) },
+            ...entry.choices.map((choice) => ({
+                label: words.bar.settingChoice(groups.size > 1 && choice.group ? choice.group : entry.name, choice.words),
+                hint,
+                run: () => open(entry, choice.value),
+            })),
+        ];
+    });
+}
+//# sourceMappingURL=find-anything.mjs.map

package/src/lib/find-anything.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-anything.mjs","sourceRoot":"","sources":["../../../../../libs/designer/src/lib/find-anything.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAmBvC,IAAI,KAAK,GAAG,CAAC,CAAC;AAEd,MAAM,UAAU,QAAQ,CAAC,EAAkB,EAAE,IAAiB,EAAE,KAAiB,EAAE,KAAoB;IACrG,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;IAC/B,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC;IACpB,MAAM,MAAM,GAAG,GAAG,CAAC,aAAmC,CAAC;IACvD,MAAM,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,EAAE;QACxB,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,eAAe,EAAE,MAAM;QACvB,eAAe,EAAE,GAAG,EAAE,OAAO;QAC7B,mBAAmB,EAAE,MAAM;QAC3B,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,OAAO;QACnB,WAAW,EAAE,CAAC,CAAC,eAAe;KAC/B,CAAqB,CAAC;IACvB,MAAM,IAAI,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5G,MAAM,IAAI,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;IAC5E,MAAM,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACnI,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,qCAAqC,EAAE,EAAE,GAAG,CAAC,CAAC;IAElF,IAAI,KAAK,GAAe,KAAK,CAAC;IAC9B,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,SAAS,IAAI;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/F,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,CAClB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,EAAE,CACf,KAAK,EACL,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAChG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EACnI,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAClD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACzE,CAAC;YACF,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YAClD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CACH,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,CAAC,MAAM;YAAE,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;;YACxE,KAAK,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACvF,CAAC;IACD,SAAS,KAAK,CAAC,OAAO,GAAG,IAAI;QAC3B,QAAQ,CAAC,MAAM,EAAE,CAAC;QAClB,IAAI,OAAO;YAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;IACjC,CAAC;IACD,SAAS,GAAG,CAAC,IAAc;QACzB,yFAAyF;QACzF,+DAA+D;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IACD,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QACnC,EAAE,GAAG,CAAC,CAAC;QACP,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACzD,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,OAAO;YAC1B,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YAC/E,IAAI,EAAE,CAAC;QACT,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC;YACjC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,KAAK,CAAC,EAAE,CAAC;gBAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YAClC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,KAAK,EAAE,CAAC;QACV,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK;YAAE,KAAK,CAAC,cAAc,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;IAC1F,IAAI,EAAE,CAAC;IACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtB,oFAAoF;IACpF,KAAK,CAAC,KAAK,EAAE,CAAC;IACd,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC;AAWD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAyB,OAAqB,EAAE,IAAyC,EAAE,KAAoB,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO;IACnK,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,OAAO;YACL,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACnD,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAChC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;gBACzG,IAAI;gBACJ,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;aACrC,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/group-fold.d.mts

@@ -0,0 +1,11 @@
+import type { Page, SectionNode } from '@fieldia/core';
+/**
+ * A group that folds by its title, as the format's `collapsible` and
+ * `collapsed` say it: not at all, starting open, or starting folded. A group
+ * with no title has nothing to fold by, so it is refused one, and a group
+ * that folds keeps its title.
+ */
+export type Fold = 'no' | 'open' | 'folded';
+/** How a group folds now. */
+export declare const foldOf: (section: SectionNode) => Fold;
+export declare function setFold(page: Page, id: string, fold: Fold): void;

package/src/lib/group-fold.d.ts

@@ -0,0 +1,11 @@
+import type { Page, SectionNode } from '@fieldia/core';
+/**
+ * A group that folds by its title, as the format's `collapsible` and
+ * `collapsed` say it: not at all, starting open, or starting folded. A group
+ * with no title has nothing to fold by, so it is refused one, and a group
+ * that folds keeps its title.
+ */
+export type Fold = 'no' | 'open' | 'folded';
+/** How a group folds now. */
+export declare const foldOf: (section: SectionNode) => Fold;
+export declare function setFold(page: Page, id: string, fold: Fold): void;

package/src/lib/group-fold.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.foldOf = void 0;
+exports.setFold = setFold;
+const layout_tree_1 = require("./layout-tree");
+const refusal_1 = require("./refusal");
+/** How a group folds now. */
+const foldOf = (section) => (!section.collapsible ? 'no' : section.collapsed ? 'folded' : 'open');
+exports.foldOf = foldOf;
+function setFold(page, id, fold) {
+    const section = (0, layout_tree_1.nodeOf)(page, id);
+    if (!(0, layout_tree_1.isSection)(section))
+        throw new refusal_1.Refusal((w) => w.layout.onlyGroupFolds);
+    delete section.collapsed;
+    if (fold === 'no') {
+        delete section.collapsible;
+        return;
+    }
+    if (!section.title?.trim())
+        throw new refusal_1.Refusal((w) => w.layout.foldsByTitle);
+    section.collapsible = true;
+    if (fold === 'folded')
+        section.collapsed = true;
+}
+//# sourceMappingURL=group-fold.js.map

package/src/lib/group-fold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"group-fold.js","sourceRoot":"","sources":["../../../../../libs/designer/src/lib/group-fold.ts"],"names":[],"mappings":";;;AAgBA,0BAWC;AA1BD,+CAAkD;AAClD,uCAAoC;AAWpC,6BAA6B;AACtB,MAAM,MAAM,GAAG,CAAC,OAAoB,EAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAA/G,QAAA,MAAM,UAAyG;AAE5H,SAAgB,OAAO,CAAC,IAAU,EAAE,EAAU,EAAE,IAAU;IACxD,MAAM,OAAO,GAAG,IAAA,oBAAM,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACjC,IAAI,CAAC,IAAA,uBAAS,EAAC,OAAO,CAAC;QAAE,MAAM,IAAI,iBAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC3E,OAAO,OAAO,CAAC,SAAS,CAAC;IACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,WAAW,CAAC;QAC3B,OAAO;IACT,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE;QAAE,MAAM,IAAI,iBAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5E,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAC3B,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;AAClD,CAAC"}

package/src/lib/group-fold.mjs

@@ -0,0 +1,20 @@
+import { isSection, nodeOf } from './layout-tree.mjs';
+import { Refusal } from './refusal.mjs';
+/** How a group folds now. */
+export const foldOf = (section) => (!section.collapsible ? 'no' : section.collapsed ? 'folded' : 'open');
+export function setFold(page, id, fold) {
+    const section = nodeOf(page, id);
+    if (!isSection(section))
+        throw new Refusal((w) => w.layout.onlyGroupFolds);
+    delete section.collapsed;
+    if (fold === 'no') {
+        delete section.collapsible;
+        return;
+    }
+    if (!section.title?.trim())
+        throw new Refusal((w) => w.layout.foldsByTitle);
+    section.collapsible = true;
+    if (fold === 'folded')
+        section.collapsed = true;
+}
+//# sourceMappingURL=group-fold.mjs.map

package/src/lib/group-fold.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"group-fold.mjs","sourceRoot":"","sources":["../../../../../libs/designer/src/lib/group-fold.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAWpC,6BAA6B;AAC7B,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAoB,EAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5H,MAAM,UAAU,OAAO,CAAC,IAAU,EAAE,EAAU,EAAE,IAAU;IACxD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACjC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC3E,OAAO,OAAO,CAAC,SAAS,CAAC;IACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,WAAW,CAAC;QAC3B,OAAO;IACT,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE;QAAE,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5E,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAC3B,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;AAClD,CAAC"}

package/src/lib/header-commands.d.mts

@@ -0,0 +1,105 @@
+import type { Alert, Badge, ButtonNode, Field, MenuItem, Page, Ribbon, StatButton, Tone } from '@fieldia/core';
+/**
+ * A record's header, as the designer edits it: the status steps, the
+ * header's buttons, the counters that open related records, and the badges
+ * by the title. Each part has an id like any element, so it can be picked on
+ * the canvas, moved among its kind, and shown only for some records.
+ */
+export type HeaderPartKind = 'button' | 'stat' | 'badge' | 'ribbon' | 'alert' | 'menu';
+/** A part of a sheet's header or card: a button, a counter, a badge, a ribbon, an alert, or an item of the gear menu over it. */
+export type HeaderPart = ButtonNode | StatButton | Badge | Ribbon | Alert | MenuItem;
+/** A part's words: an alert's message, any other's label; a built-in item of the gear menu with none of its own, none. */
+export declare const wordsOf: (part: HeaderPart) => string;
+/** What a new item of the gear menu is: one of the record's own, the app's action, or a report under Print. */
+export type MenuItemKind = NonNullable<MenuItem['builtin']> | 'action' | 'print';
+export interface HeaderPartPatch {
+    label?: string;
+    /** The action's name, for a button or a counter. The app decides what it does. */
+    action?: string;
+    /** A button's look. */
+    style?: ButtonNode['style'];
+    /** A button's question before it acts; empty asks nothing. */
+    confirm?: string;
+    /** A button's key, as typed: "v", "Shift+G"; empty for none. */
+    hotkey?: string;
+    /** A badge's, a ribbon's or an alert's colour. */
+    tone?: Tone;
+    /** A ribbon's or an alert's words from a field, while it holds any; empty for none. */
+    wordsField?: string;
+    /** A ribbon's words on pointing at it; empty for none. */
+    tooltip?: string;
+    /** An alert with a × that hides it. */
+    dismissible?: boolean;
+    /** The value a counter shows, from a field; empty shows none. */
+    field?: string;
+    /** A counter's words after its value; empty for none. */
+    unit?: string;
+    /** A counter's words after its value from a field, its words from a field, its second value: a field's name, empty for none. */
+    unitField?: string;
+    labelField?: string;
+    secondField?: string;
+    /** Words for a counter's second value, which then shows under the first; empty for none. */
+    secondLabel?: string;
+    /** A counter's help: its tooltip, read out as its description; empty for none. */
+    help?: string;
+    icon?: string;
+    /** An item of the gear menu: one of the record's own it is (empty for none), and whether it goes under Print. */
+    builtin?: MenuItem['builtin'] | '';
+    group?: 'actions' | 'print';
+}
+/** How the status steps behave: clicked, where they sit, the time spent per step, folded stages, a click that saves. */
+export interface StatusbarOptions {
+    clickable?: boolean;
+    position?: 'header' | 'title';
+    /** A json field holding the time per step; empty for none. */
+    durationsField?: string;
+    /** Stages folded by their record under More: a link's steps only. */
+    fold?: boolean;
+    /** A click saves the record at once: steps that can be clicked only. */
+    saves?: boolean;
+}
+export interface HeaderCommands {
+    /** Status steps from a field that holds one of a list, or `null` for none. */
+    setStatusbar(field: string | null, options?: StatusbarOptions): boolean;
+    /** A button, a counter or a badge, at the end of its kind. Returns its id, picked. */
+    addHeaderPart(kind: HeaderPartKind, label: string): string | false;
+    updateHeaderPart(id: string, patch: HeaderPartPatch): boolean;
+    moveHeaderPart(id: string, delta: number): boolean;
+    removeHeaderPart(id: string): boolean;
+    /** A button inside an alert, after its words: a link that runs an action. Returns its id. */
+    addAlertButton(alert: string, label: string): string | false;
+    /** An alert's button's words, or the action it runs. */
+    updateAlertButton(alert: string, button: string, patch: {
+        label?: string;
+        action?: string;
+    }): boolean;
+    removeAlertButton(alert: string, button: string): boolean;
+    /**
+     * An item at the end of the gear menu over the record: one of the record's
+     * own (Archive, Unarchive, Duplicate, Delete) in the page's words, or the
+     * app's action, or a report under Print, with these words. Returns its id, picked.
+     */
+    addMenuItem(kind: MenuItemKind, label?: string): string | false;
+    /** Whether the pager and the breadcrumbs the app gives show over the record: true takes the page's "no" away. */
+    setRecordToolbar(patch: {
+        pager?: boolean;
+        breadcrumbs?: boolean;
+    }): boolean;
+    /** The record's attachment beside the sheet: null for none, '' for the app's attachments, or a file field's name. */
+    setAttachmentPreview(field: string | null): boolean;
+    /** Where the side panel stays beside the sheet: on a wide form, or always. */
+    setSidePanelBeside(where: 'wide' | 'always'): boolean;
+}
+/** A part of a sheet's header by its id: what kind, which list, and where in it. A page's one `ribbon` is found as the first of the ribbons. */
+export declare function findHeaderPart(page: Page, id: string): {
+    kind: HeaderPartKind;
+    list: HeaderPart[];
+    index: number;
+    part: HeaderPart;
+} | null;
+export interface HeaderContext {
+    apply(edit: (draft: Page) => void, merge?: string | null): boolean;
+    select(id: string): void;
+    model: Record<string, Field>;
+}
+export declare function headerCommands(context: HeaderContext): HeaderCommands;

package/src/lib/header-commands.d.ts

@@ -0,0 +1,105 @@
+import type { Alert, Badge, ButtonNode, Field, MenuItem, Page, Ribbon, StatButton, Tone } from '@fieldia/core';
+/**
+ * A record's header, as the designer edits it: the status steps, the
+ * header's buttons, the counters that open related records, and the badges
+ * by the title. Each part has an id like any element, so it can be picked on
+ * the canvas, moved among its kind, and shown only for some records.
+ */
+export type HeaderPartKind = 'button' | 'stat' | 'badge' | 'ribbon' | 'alert' | 'menu';
+/** A part of a sheet's header or card: a button, a counter, a badge, a ribbon, an alert, or an item of the gear menu over it. */
+export type HeaderPart = ButtonNode | StatButton | Badge | Ribbon | Alert | MenuItem;
+/** A part's words: an alert's message, any other's label; a built-in item of the gear menu with none of its own, none. */
+export declare const wordsOf: (part: HeaderPart) => string;
+/** What a new item of the gear menu is: one of the record's own, the app's action, or a report under Print. */
+export type MenuItemKind = NonNullable<MenuItem['builtin']> | 'action' | 'print';
+export interface HeaderPartPatch {
+    label?: string;
+    /** The action's name, for a button or a counter. The app decides what it does. */
+    action?: string;
+    /** A button's look. */
+    style?: ButtonNode['style'];
+    /** A button's question before it acts; empty asks nothing. */
+    confirm?: string;
+    /** A button's key, as typed: "v", "Shift+G"; empty for none. */
+    hotkey?: string;
+    /** A badge's, a ribbon's or an alert's colour. */
+    tone?: Tone;
+    /** A ribbon's or an alert's words from a field, while it holds any; empty for none. */
+    wordsField?: string;
+    /** A ribbon's words on pointing at it; empty for none. */
+    tooltip?: string;
+    /** An alert with a × that hides it. */
+    dismissible?: boolean;
+    /** The value a counter shows, from a field; empty shows none. */
+    field?: string;
+    /** A counter's words after its value; empty for none. */
+    unit?: string;
+    /** A counter's words after its value from a field, its words from a field, its second value: a field's name, empty for none. */
+    unitField?: string;
+    labelField?: string;
+    secondField?: string;
+    /** Words for a counter's second value, which then shows under the first; empty for none. */
+    secondLabel?: string;
+    /** A counter's help: its tooltip, read out as its description; empty for none. */
+    help?: string;
+    icon?: string;
+    /** An item of the gear menu: one of the record's own it is (empty for none), and whether it goes under Print. */
+    builtin?: MenuItem['builtin'] | '';
+    group?: 'actions' | 'print';
+}
+/** How the status steps behave: clicked, where they sit, the time spent per step, folded stages, a click that saves. */
+export interface StatusbarOptions {
+    clickable?: boolean;
+    position?: 'header' | 'title';
+    /** A json field holding the time per step; empty for none. */
+    durationsField?: string;
+    /** Stages folded by their record under More: a link's steps only. */
+    fold?: boolean;
+    /** A click saves the record at once: steps that can be clicked only. */
+    saves?: boolean;
+}
+export interface HeaderCommands {
+    /** Status steps from a field that holds one of a list, or `null` for none. */
+    setStatusbar(field: string | null, options?: StatusbarOptions): boolean;
+    /** A button, a counter or a badge, at the end of its kind. Returns its id, picked. */
+    addHeaderPart(kind: HeaderPartKind, label: string): string | false;
+    updateHeaderPart(id: string, patch: HeaderPartPatch): boolean;
+    moveHeaderPart(id: string, delta: number): boolean;
+    removeHeaderPart(id: string): boolean;
+    /** A button inside an alert, after its words: a link that runs an action. Returns its id. */
+    addAlertButton(alert: string, label: string): string | false;
+    /** An alert's button's words, or the action it runs. */
+    updateAlertButton(alert: string, button: string, patch: {
+        label?: string;
+        action?: string;
+    }): boolean;
+    removeAlertButton(alert: string, button: string): boolean;
+    /**
+     * An item at the end of the gear menu over the record: one of the record's
+     * own (Archive, Unarchive, Duplicate, Delete) in the page's words, or the
+     * app's action, or a report under Print, with these words. Returns its id, picked.
+     */
+    addMenuItem(kind: MenuItemKind, label?: string): string | false;
+    /** Whether the pager and the breadcrumbs the app gives show over the record: true takes the page's "no" away. */
+    setRecordToolbar(patch: {
+        pager?: boolean;
+        breadcrumbs?: boolean;
+    }): boolean;
+    /** The record's attachment beside the sheet: null for none, '' for the app's attachments, or a file field's name. */
+    setAttachmentPreview(field: string | null): boolean;
+    /** Where the side panel stays beside the sheet: on a wide form, or always. */
+    setSidePanelBeside(where: 'wide' | 'always'): boolean;
+}
+/** A part of a sheet's header by its id: what kind, which list, and where in it. A page's one `ribbon` is found as the first of the ribbons. */
+export declare function findHeaderPart(page: Page, id: string): {
+    kind: HeaderPartKind;
+    list: HeaderPart[];
+    index: number;
+    part: HeaderPart;
+} | null;
+export interface HeaderContext {
+    apply(edit: (draft: Page) => void, merge?: string | null): boolean;
+    select(id: string): void;
+    model: Record<string, Field>;
+}
+export declare function headerCommands(context: HeaderContext): HeaderCommands;