domma-cms 1.2.0 → 1.4.0

package/server/services/widgets.js

@@ -267,3 +267,59 @@ export function _resetWidgetsForTests() {
     owners.clear();
     _registered.length = 0;
 }
+
+// ---------------------------------------------------------------------------
+// Boards - a person's several named layouts, shown as tabs
+// ---------------------------------------------------------------------------
+
+export const MAX_BOARDS = 12;
+export const BOARD_NAME_MAX = 40;
+const BOARD_ID_RE = /^[a-z0-9][a-z0-9-]{0,39}$/;
+
+const boardName = (v, fallback) => String(v ?? '').replace(/[\u0000-\u001f<>]/g, '').replace(/\s+/g, ' ').trim().slice(0, BOARD_NAME_MAX) || fallback;
+
+/**
+ * A person's boards, cleaned. Accepts the stored v2 shape
+ * ({version: 2, active, boards: [{id, name, widgets}]}) and the v1 shape a
+ * board-less layout file has ({widgets}), which becomes one board, "Main".
+ * There is always at least one board, and `active` always names one of them.
+ *
+ * @param {*} input
+ * @returns {{version: number, active: string, boards: Array<{id: string, name: string, widgets: object[]}>}}
+ */
+export function normaliseBoards(input) {
+    const src = input && typeof input === 'object' ? input : {};
+    const list = Array.isArray(src.boards) ? src.boards : (Array.isArray(src.widgets) || Array.isArray(src) ? [{id: 'main', name: 'Main', widgets: src.widgets || src}] : []);
+    const seen = new Set();
+    const boards = [];
+    for (const b of list) {
+        const id = String(b?.id || '').trim();
+        if (!BOARD_ID_RE.test(id) || seen.has(id)) continue;
+        seen.add(id);
+        boards.push({id, name: boardName(b.name, `Board ${boards.length + 1}`), widgets: normaliseLayout(b.widgets).widgets});
+        if (boards.length >= MAX_BOARDS) break;
+    }
+    if (!boards.length) boards.push({id: 'main', name: 'Main', widgets: []});
+    const active = boards.some(b => b.id === src.active) ? src.active : boards[0].id;
+    return {version: 2, active, boards};
+}
+
+/** What is wrong with a submitted set of boards ([] when it is fine). */
+export function boardsProblems(input) {
+    if (!input || typeof input !== 'object' || !Array.isArray(input.boards)) return ['boards must be an array'];
+    if (!input.boards.length) return ['keep at least one board'];
+    if (input.boards.length > MAX_BOARDS) return [`at most ${MAX_BOARDS} boards`];
+    const out = [];
+    const ids = new Set();
+    input.boards.forEach((b, i) => {
+        if (!BOARD_ID_RE.test(String(b?.id || ''))) out.push(`boards[${i}].id is not a board id`);
+        else if (ids.has(b.id)) out.push(`boards[${i}].id "${b.id}" is used twice`);
+        ids.add(b?.id);
+        if (b?.name != null && String(b.name).length > BOARD_NAME_MAX) out.push(`boards[${i}].name can be at most ${BOARD_NAME_MAX} characters`);
+        out.push(...layoutProblems({widgets: b?.widgets ?? []}).map(p => `boards[${i}]: ${p}`));
+    });
+    return out;
+}
+
+/** The active board of a set. */
+export const activeBoard = (set) => set.boards.find(b => b.id === set.active) || set.boards[0];