@willwade/aac-processors 0.2.13 → 0.2.15

package/dist/browser/core/treeStructure.js

@@ -201,6 +201,21 @@ export class AACPage {
         // Record the mutation
         this._pendingMutations.push({ type: 'addButton', button });
     }
+    /**
+     * Internal load-path button push: adds a button to the page WITHOUT recording a mutation.
+     * Used by processors during loadIntoTree so the loaded baseline isn't treated as user changes.
+     * Not part of the public API — consumers should always use addButton.
+     */
+    _loadButton(button) {
+        this.buttons.push(button);
+    }
+    /**
+     * Discard all recorded mutations on this page.
+     * Useful as an escape hatch after loadIntoTree if the consumer wants a clean baseline.
+     */
+    clearMutations() {
+        this._pendingMutations = [];
+    }
     /**
      * Get the list of pending mutations for this page (read-only)
      */

package/dist/browser/processors/applePanelsProcessor.js

@@ -219,7 +219,8 @@ class ApplePanelsProcessor extends BaseProcessor {
                             fontWeight: btn.DisplayImageWeight === 'bold' ? 'bold' : 'normal',
                         },
                     });
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     if (btn.Rect) {
                         const rect = this.parseRect(btn.Rect);
                         if (rect) {

package/dist/browser/processors/astericsGridProcessor.js

@@ -714,7 +714,8 @@ class AstericsGridProcessor extends BaseProcessor {
                 }
                 grid.gridElements.forEach((element) => {
                     const button = this.createButtonFromElement(element, colorConfig, activeColorSchemeDefinition);
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     const buttonX = element.x || 0;
                     const buttonY = element.y || 0;
                     const buttonWidth = element.width || 1;

package/dist/browser/processors/dotProcessor.js

@@ -117,7 +117,8 @@ class DotProcessor extends BaseProcessor {
                 });
                 tree.addPage(page);
                 // Add a self button so single-node graphs yield one button
-                page.addButton(new AACButton({
+                // Load path: do not record as a user mutation
+                page._loadButton(new AACButton({
                     id: `${node.id}_self`,
                     label: node.label,
                     message: node.label,
@@ -138,7 +139,8 @@ class DotProcessor extends BaseProcessor {
                         message: '',
                         targetPageId: edge.to,
                     });
-                    fromPage.addButton(button);
+                    // Load path: do not record as a user mutation
+                    fromPage._loadButton(button);
                 }
             }
             return tree;

package/dist/browser/processors/gridsetProcessor.js

@@ -1571,8 +1571,8 @@ class GridsetProcessor extends BaseProcessor {
                                 ...(imageData ? { imageData, image_id: resolvedImageEntry } : {}),
                             },
                         });
-                        // Add button to page
-                        page.addButton(button);
+                        // Add button to page (load path: do not record as a user mutation)
+                        page._loadButton(button);
                         // Place button in grid layout (handle colspan/rowspan)
                         for (let r = cellY; r < cellY + rowSpan && r < maxRows; r++) {
                             for (let c = cellX; c < cellX + colSpan && c < maxCols; c++) {

package/dist/browser/processors/opmlProcessor.js

@@ -42,7 +42,8 @@ class OpmlProcessor extends BaseProcessor {
                         message: '',
                         targetPageId: childText.replace(/[^a-zA-Z0-9]/g, '_'),
                     });
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     const { page: childPage, childPages: grandChildren } = this.processOutline(child, page.id);
                     if (childPage && childPage.id)
                         childPages.push(childPage, ...grandChildren);

package/dist/browser/processors/snapProcessor.js

@@ -39,7 +39,7 @@ class SnapProcessor extends BaseProcessor {
         super(options);
         this.capabilities = {
             wordList: 'none',
-            preservesAssetsOnSave: false,
+            preservesAssetsOnSave: true,
             newCellCreation: 'allowed',
         };
         this.symbolResolver = null;
@@ -579,7 +579,8 @@ class SnapProcessor extends BaseProcessor {
                     // Add to the intended parent page
                     const parentPage = tree.getPage(parentUniqueId);
                     if (parentPage) {
-                        parentPage.addButton(button);
+                        // Load path: do not record as a user mutation
+                        parentPage._loadButton(button);
                         // Add button to grid layout if position data is available
                         const gridPositionStr = String(btnRow.GridPosition || '');
                         if (gridPositionStr && gridPositionStr.includes(',')) {
@@ -809,6 +810,324 @@ class SnapProcessor extends BaseProcessor {
         await this.saveFromTree(tree, outputPath);
         return await readBinaryFromInput(outputPath);
     }
+    /**
+     * Save a modified tree while preserving the original SQLite schema and data.
+     *
+     * Strategy: copy the original .sps verbatim, then open the copy and replay
+     * `page.pendingMutations` as targeted SQL UPDATE/INSERT statements. Everything
+     * not in the mutation log (PageLayout, ScanGroup, image blobs, ContentTypeData,
+     * ButtonPageLink, etc.) is preserved byte-for-byte from the original.
+     *
+     * This is the asset-preserving counterpart to `saveFromTree` (which builds a
+     * stripped-down DB from scratch and is unsuitable for round-tripping real
+     * TD Snap page sets).
+     *
+     * Supported mutations:
+     * - updateButton(id, patch)  → UPDATE Button SET Label/Message WHERE Id = ?
+     * - removeButton(id)         → UPDATE ElementPlacement SET Visible = 0 for all
+     *                              placements pointing at the button's ElementReference
+     * - addButton(button)        → INSERT into ElementReference + Button + one
+     *                              ElementPlacement per existing PageLayout for
+     *                              the target page (so the button shows in every
+     *                              layout the user has). Image/audio not yet handled.
+     *
+     * WordList mutations are no-ops on Snap (capabilities.wordList === 'none').
+     */
+    async saveModifiedTree(originalPath, tree, outputPath) {
+        const { pathExists, mkDir, removePath, dirname, readBinaryFromInput, writeBinaryToPath } = this.options.fileAdapter;
+        if (!isNodeRuntime()) {
+            throw new Error('saveModifiedTree is only supported in Node.js for Snap files.');
+        }
+        const outputDir = dirname(outputPath);
+        if (!(await pathExists(outputDir))) {
+            await mkDir(outputDir, { recursive: true });
+        }
+        if (await pathExists(outputPath)) {
+            await removePath(outputPath);
+        }
+        // 1. Copy the original verbatim — preserves all 23+ tables, blobs, settings.
+        const originalBytes = await readBinaryFromInput(originalPath);
+        await writeBinaryToPath(outputPath, originalBytes);
+        // Short-circuit: if no page has any mutations, we're done.
+        const hasAnyMutations = Object.values(tree.pages).some((page) => page.pendingMutations.length > 0);
+        if (!hasAnyMutations) {
+            return;
+        }
+        // 2. Open the copy.
+        const Database = requireBetterSqlite3();
+        const db = new Database(outputPath, { readonly: false });
+        try {
+            // 3. Schema introspection — different Snap versions have different optional columns.
+            const tableColumns = (table) => {
+                try {
+                    const rows = db.prepare(`PRAGMA table_info(${table})`).all();
+                    return new Set(rows.map((r) => r.name));
+                }
+                catch {
+                    return new Set();
+                }
+            };
+            const buttonCols = tableColumns('Button');
+            const placementCols = tableColumns('ElementPlacement');
+            const hasPlacementVisible = placementCols.has('Visible');
+            const hasPlacementPageLayoutId = placementCols.has('PageLayoutId');
+            // 4. UniqueId → numeric Page.Id map.
+            const pageRows = db.prepare('SELECT Id, UniqueId FROM Page').all();
+            const uniqueIdToPageId = new Map();
+            for (const row of pageRows) {
+                if (row.UniqueId)
+                    uniqueIdToPageId.set(String(row.UniqueId), row.Id);
+                // Allow lookup by stringified numeric Id too, since loadIntoTree falls back to it.
+                uniqueIdToPageId.set(String(row.Id), row.Id);
+            }
+            const layoutsByPage = new Map();
+            try {
+                const layoutRows = db
+                    .prepare('SELECT Id, PageId, PageLayoutSetting FROM PageLayout')
+                    .all();
+                // Pre-load occupied placements per layout so we can avoid (x,y) collisions.
+                const placementsByLayout = new Map();
+                const placementRows = db
+                    .prepare('SELECT PageLayoutId, GridPosition FROM ElementPlacement WHERE GridPosition IS NOT NULL AND PageLayoutId IS NOT NULL')
+                    .all();
+                for (const r of placementRows) {
+                    let set = placementsByLayout.get(r.PageLayoutId);
+                    if (!set) {
+                        set = new Set();
+                        placementsByLayout.set(r.PageLayoutId, set);
+                    }
+                    set.add(r.GridPosition);
+                }
+                for (const row of layoutRows) {
+                    const parts = String(row.PageLayoutSetting ?? '').split(',');
+                    const cols = parseInt(parts[0], 10) || 4;
+                    const rows = parseInt(parts[1], 10) || 4;
+                    const info = {
+                        id: row.Id,
+                        cols,
+                        rows,
+                        occupied: placementsByLayout.get(row.Id) ?? new Set(),
+                    };
+                    const list = layoutsByPage.get(row.PageId);
+                    if (list)
+                        list.push(info);
+                    else
+                        layoutsByPage.set(row.PageId, [info]);
+                }
+            }
+            catch {
+                // PageLayout table may not exist on older schemas — placements get NULL PageLayoutId.
+            }
+            // Find first empty cell on a layout, starting from a preferred (x,y).
+            // Returns null if the layout is fully occupied.
+            const findFreeCell = (info, prefX, prefY) => {
+                const inBounds = (x, y) => x >= 0 && x < info.cols && y >= 0 && y < info.rows;
+                if (inBounds(prefX, prefY)) {
+                    const key = `${prefX},${prefY}`;
+                    if (!info.occupied.has(key)) {
+                        info.occupied.add(key);
+                        return key;
+                    }
+                }
+                for (let y = 0; y < info.rows; y++) {
+                    for (let x = 0; x < info.cols; x++) {
+                        const key = `${x},${y}`;
+                        if (!info.occupied.has(key)) {
+                            info.occupied.add(key);
+                            return key;
+                        }
+                    }
+                }
+                return null;
+            };
+            // Generate a UUID for new Button.UniqueId. Required: Node has crypto.randomUUID since 14.17.
+            const nodeCrypto = getNodeRequire()?.('crypto');
+            const uuid = () => nodeCrypto?.randomUUID
+                ? nodeCrypto.randomUUID()
+                : // Fallback (very unlikely path, but shouldn't break older Nodes)
+                    'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+                        const r = (Math.random() * 16) | 0;
+                        const v = c === 'x' ? r : (r & 0x3) | 0x8;
+                        return v.toString(16);
+                    });
+            // 5. Next-available IDs for inserts.
+            const nextId = (table) => {
+                const row = db.prepare(`SELECT COALESCE(MAX(Id), 0) AS maxId FROM ${table}`).get();
+                return (row.maxId || 0) + 1;
+            };
+            let nextButtonId = nextId('Button');
+            let nextElementRefId = nextId('ElementReference');
+            let nextPlacementId = nextId('ElementPlacement');
+            // CommandSequence is optional but TD Snap crashes on some pages (e.g. dashboards
+            // like "Google Home Speaker") when a button has no CommandSequence row. Every
+            // button in the original DB has one. We track this only if the table exists.
+            const hasCommandSequence = tableColumns('CommandSequence').size > 0;
+            let nextCommandSequenceId = hasCommandSequence ? nextId('CommandSequence') : 0;
+            // 6. Replay mutations inside one transaction for atomicity + speed.
+            const replay = db.transaction(() => {
+                for (const page of Object.values(tree.pages)) {
+                    if (page.pendingMutations.length === 0)
+                        continue;
+                    const numericPageId = uniqueIdToPageId.get(String(page.id));
+                    if (numericPageId === undefined) {
+                        // eslint-disable-next-line no-console
+                        console.warn(`[Snap] saveModifiedTree: page "${page.name}" (${page.id}) not found in original DB; skipping ${page.pendingMutations.length} mutation(s)`);
+                        continue;
+                    }
+                    for (const mutation of page.pendingMutations) {
+                        switch (mutation.type) {
+                            case 'updateButton': {
+                                const sets = [];
+                                const args = [];
+                                if (mutation.patch.label !== undefined && buttonCols.has('Label')) {
+                                    sets.push('Label = ?');
+                                    args.push(mutation.patch.label);
+                                }
+                                if (mutation.patch.message !== undefined && buttonCols.has('Message')) {
+                                    sets.push('Message = ?');
+                                    args.push(mutation.patch.message);
+                                }
+                                if (sets.length === 0)
+                                    break;
+                                args.push(Number(mutation.buttonId));
+                                db.prepare(`UPDATE Button SET ${sets.join(', ')} WHERE Id = ?`).run(...args);
+                                break;
+                            }
+                            case 'removeButton': {
+                                // Hide all placements that reference the button's ElementReference.
+                                const buttonRow = db
+                                    .prepare('SELECT ElementReferenceId FROM Button WHERE Id = ?')
+                                    .get(Number(mutation.buttonId));
+                                if (!buttonRow || buttonRow.ElementReferenceId == null)
+                                    break;
+                                if (hasPlacementVisible) {
+                                    db.prepare('UPDATE ElementPlacement SET Visible = 0 WHERE ElementReferenceId = ?').run(buttonRow.ElementReferenceId);
+                                }
+                                else {
+                                    // Older schemas without Visible: delete the placements outright.
+                                    db.prepare('DELETE FROM ElementPlacement WHERE ElementReferenceId = ?').run(buttonRow.ElementReferenceId);
+                                }
+                                break;
+                            }
+                            case 'addButton': {
+                                const button = mutation.button;
+                                const elementRefId = nextElementRefId++;
+                                const buttonId = nextButtonId++;
+                                // ElementReference: TD Snap requires ElementType, ForegroundColor,
+                                // BackgroundColor, and AudioCueRecordingId to be non-NULL on render
+                                // — NULL values crash dashboard pages (e.g. "Google Home Speaker").
+                                // Defaults below match the modal values across real Snap files
+                                // (>99% of existing rows in Core First Scanning use them).
+                                const erColumns = tableColumns('ElementReference');
+                                const erCandidates = [
+                                    { col: 'Id', value: elementRefId },
+                                    { col: 'PageId', value: numericPageId },
+                                    { col: 'ElementType', value: 0 }, // 0 = button; only nonzero in 1/20608 rows
+                                    { col: 'ForegroundColor', value: -14934754 }, // dark text default (99.8% of rows)
+                                    { col: 'BackgroundColor', value: -132102 }, // light cell default (85.7% of rows)
+                                    { col: 'AudioCueRecordingId', value: 0 }, // 0 = no audio cue (99.99% of rows)
+                                ];
+                                const erFieldsPresent = erCandidates.filter((f) => erColumns.has(f.col));
+                                db.prepare(`INSERT INTO ElementReference (${erFieldsPresent
+                                    .map((f) => f.col)
+                                    .join(', ')}) VALUES (${erFieldsPresent.map(() => '?').join(', ')})`).run(...erFieldsPresent.map((f) => f.value));
+                                // Button: provide non-NULL defaults for columns TD Snap reads.
+                                // ContentType = 6 (normal speak button), CommandFlags = 8 (standard),
+                                // LabelOwnership / ImageOwnership = 3 (owned by this page set),
+                                // ActiveContentType = 0, BorderThickness = 0, UniqueId = fresh GUID,
+                                // image / sound / symbol IDs = 0 (= "no asset").
+                                const candidateFields = [
+                                    { col: 'Id', value: buttonId },
+                                    { col: 'Label', value: button.label || '' },
+                                    { col: 'Message', value: button.message || button.label || '' },
+                                    { col: 'ElementReferenceId', value: elementRefId },
+                                    { col: 'ContentType', value: 6 },
+                                    { col: 'CommandFlags', value: 8 },
+                                    { col: 'LabelOwnership', value: 3 },
+                                    { col: 'ImageOwnership', value: 3 },
+                                    { col: 'ActiveContentType', value: 0 },
+                                    { col: 'BorderThickness', value: 0 },
+                                    { col: 'UniqueId', value: uuid() },
+                                    { col: 'LibrarySymbolId', value: 0 },
+                                    { col: 'PageSetImageId', value: 0 },
+                                    { col: 'MessageRecordingId', value: 0 },
+                                    // UseMessageRecording: omit. 99.99% of existing rows have NULL,
+                                    // and forcing 0 makes Sarah/Mum the only outliers in the DB.
+                                    { col: 'SymbolColorDataId', value: 0 },
+                                ];
+                                const presentFields = candidateFields.filter((f) => buttonCols.has(f.col));
+                                const sql = `INSERT INTO Button (${presentFields
+                                    .map((f) => f.col)
+                                    .join(', ')}) VALUES (${presentFields.map(() => '?').join(', ')})`;
+                                db.prepare(sql).run(...presentFields.map((f) => f.value));
+                                // Insert a default CommandSequence row that explicitly speaks the
+                                // button's Label ($type:3 = MessageAction, value 0 = speak Label).
+                                // This is the most common pattern in real Snap files (9514 / 19402
+                                // buttons in Core First Scanning). Without an explicit action,
+                                // dashboard pages (e.g. "Google Home Speaker") crash on render —
+                                // empty $values is only used for hidden/help-text buttons.
+                                if (hasCommandSequence) {
+                                    db.prepare('INSERT INTO CommandSequence (Id, SerializedCommands, ButtonId) VALUES (?, ?, ?)').run(nextCommandSequenceId++, '{"$type":"1","$values":[{"$type":"3","MessageAction":0}]}', buttonId);
+                                }
+                                const layouts = layoutsByPage.get(numericPageId) ?? [];
+                                const prefX = button.x ?? 0;
+                                const prefY = button.y ?? 0;
+                                if (layouts.length === 0) {
+                                    const placementId = nextPlacementId++;
+                                    if (hasPlacementPageLayoutId) {
+                                        db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId, Visible) VALUES (?, ?, ?, '1,1', NULL, 1)").run(placementId, elementRefId, `${prefX},${prefY}`);
+                                    }
+                                    else {
+                                        db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, Visible) VALUES (?, ?, ?, '1,1', 1)").run(placementId, elementRefId, `${prefX},${prefY}`);
+                                    }
+                                }
+                                else {
+                                    // INVARIANT: every Button must have exactly one ElementPlacement
+                                    // per PageLayout on its page. Snap renders buttons × layouts and
+                                    // crashes if a (button, layout) pair is missing.
+                                    //
+                                    // Hidden placements (Visible=0) MUST use a position that doesn't
+                                    // collide with an existing visible placement on that layout.
+                                    // The existing convention puts hidden placements at out-of-grid
+                                    // coordinates (e.g. position (2,4) on a 4×3 layout where row 4
+                                    // doesn't exist). We do the same: synthesise (cols, 0) which is
+                                    // guaranteed out of bounds since valid X is 0..cols-1.
+                                    for (const info of layouts) {
+                                        const cell = findFreeCell(info, prefX, prefY);
+                                        const visible = cell !== null ? 1 : 0;
+                                        const gridPosition = cell ?? `${info.cols},0`;
+                                        const placementId = nextPlacementId++;
+                                        if (hasPlacementPageLayoutId && hasPlacementVisible) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId, Visible) VALUES (?, ?, ?, '1,1', ?, ?)").run(placementId, elementRefId, gridPosition, info.id, visible);
+                                        }
+                                        else if (hasPlacementPageLayoutId) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId) VALUES (?, ?, ?, '1,1', ?)").run(placementId, elementRefId, gridPosition, info.id);
+                                        }
+                                        else if (hasPlacementVisible) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, Visible) VALUES (?, ?, ?, '1,1', ?)").run(placementId, elementRefId, gridPosition, visible);
+                                        }
+                                        else {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan) VALUES (?, ?, ?, '1,1')").run(placementId, elementRefId, gridPosition);
+                                        }
+                                    }
+                                }
+                                break;
+                            }
+                            case 'addWordListItem':
+                            case 'removeWordListItem':
+                            case 'clearWordList':
+                                // Snap has no WordList concept — these are no-ops by capability contract.
+                                break;
+                        }
+                    }
+                }
+            });
+            replay();
+        }
+        finally {
+            db.close();
+        }
+    }
     async saveFromTree(tree, outputPath) {
         const { pathExists, mkDir, removePath, dirname } = this.options.fileAdapter;
         if (!isNodeRuntime()) {

package/dist/browser/processors/touchchatProcessor.js

@@ -266,8 +266,8 @@ class TouchChatProcessor extends BaseProcessor {
                             // Set button's x and y coordinates
                             button.x = absoluteX;
                             button.y = absoluteY;
-                            // Add button to page
-                            page.addButton(button);
+                            // Add button to page (load path: do not record as a user mutation)
+                            page._loadButton(button);
                             // Place button in grid (handle span)
                             for (let r = absoluteY; r < absoluteY + safeSpanY && r < 10; r++) {
                                 for (let c = absoluteX; c < absoluteX + safeSpanX && c < 10; c++) {
@@ -368,7 +368,7 @@ class TouchChatProcessor extends BaseProcessor {
                     // Find the page that references this resource
                     const page = Object.values(tree.pages).find((p) => p.id === (numericToRid.get(btnRow.id) || String(btnRow.id)));
                     if (page)
-                        page.addButton(button);
+                        page._loadButton(button); // load path: do not record as a user mutation
                 });
             }
             catch (_e) {

package/dist/core/treeStructure.d.ts

@@ -249,6 +249,17 @@ export declare class AACPage {
         scanType?: AACScanType;
     });
     addButton(button: AACButton): void;
+    /**
+     * Internal load-path button push: adds a button to the page WITHOUT recording a mutation.
+     * Used by processors during loadIntoTree so the loaded baseline isn't treated as user changes.
+     * Not part of the public API — consumers should always use addButton.
+     */
+    _loadButton(button: AACButton): void;
+    /**
+     * Discard all recorded mutations on this page.
+     * Useful as an escape hatch after loadIntoTree if the consumer wants a clean baseline.
+     */
+    clearMutations(): void;
     /**
      * Get the list of pending mutations for this page (read-only)
      */

package/dist/core/treeStructure.js

@@ -205,6 +205,21 @@ class AACPage {
         // Record the mutation
         this._pendingMutations.push({ type: 'addButton', button });
     }
+    /**
+     * Internal load-path button push: adds a button to the page WITHOUT recording a mutation.
+     * Used by processors during loadIntoTree so the loaded baseline isn't treated as user changes.
+     * Not part of the public API — consumers should always use addButton.
+     */
+    _loadButton(button) {
+        this.buttons.push(button);
+    }
+    /**
+     * Discard all recorded mutations on this page.
+     * Useful as an escape hatch after loadIntoTree if the consumer wants a clean baseline.
+     */
+    clearMutations() {
+        this._pendingMutations = [];
+    }
     /**
      * Get the list of pending mutations for this page (read-only)
      */

package/dist/processors/applePanelsProcessor.js

@@ -225,7 +225,8 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
                             fontWeight: btn.DisplayImageWeight === 'bold' ? 'bold' : 'normal',
                         },
                     });
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     if (btn.Rect) {
                         const rect = this.parseRect(btn.Rect);
                         if (rect) {

package/dist/processors/astericsGridProcessor.js

@@ -722,7 +722,8 @@ class AstericsGridProcessor extends baseProcessor_1.BaseProcessor {
                 }
                 grid.gridElements.forEach((element) => {
                     const button = this.createButtonFromElement(element, colorConfig, activeColorSchemeDefinition);
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     const buttonX = element.x || 0;
                     const buttonY = element.y || 0;
                     const buttonWidth = element.width || 1;

package/dist/processors/dotProcessor.js

@@ -120,7 +120,8 @@ class DotProcessor extends baseProcessor_1.BaseProcessor {
                 });
                 tree.addPage(page);
                 // Add a self button so single-node graphs yield one button
-                page.addButton(new treeStructure_1.AACButton({
+                // Load path: do not record as a user mutation
+                page._loadButton(new treeStructure_1.AACButton({
                     id: `${node.id}_self`,
                     label: node.label,
                     message: node.label,
@@ -141,7 +142,8 @@ class DotProcessor extends baseProcessor_1.BaseProcessor {
                         message: '',
                         targetPageId: edge.to,
                     });
-                    fromPage.addButton(button);
+                    // Load path: do not record as a user mutation
+                    fromPage._loadButton(button);
                 }
             }
             return tree;

package/dist/processors/gridsetProcessor.js

@@ -1597,8 +1597,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                                 ...(imageData ? { imageData, image_id: resolvedImageEntry } : {}),
                             },
                         });
-                        // Add button to page
-                        page.addButton(button);
+                        // Add button to page (load path: do not record as a user mutation)
+                        page._loadButton(button);
                         // Place button in grid layout (handle colspan/rowspan)
                         for (let r = cellY; r < cellY + rowSpan && r < maxRows; r++) {
                             for (let c = cellX; c < cellX + colSpan && c < maxCols; c++) {

package/dist/processors/opmlProcessor.js

@@ -45,7 +45,8 @@ class OpmlProcessor extends baseProcessor_1.BaseProcessor {
                         message: '',
                         targetPageId: childText.replace(/[^a-zA-Z0-9]/g, '_'),
                     });
-                    page.addButton(button);
+                    // Load path: do not record as a user mutation
+                    page._loadButton(button);
                     const { page: childPage, childPages: grandChildren } = this.processOutline(child, page.id);
                     if (childPage && childPage.id)
                         childPages.push(childPage, ...grandChildren);

package/dist/processors/snapProcessor.d.ts

@@ -18,6 +18,30 @@ declare class SnapProcessor extends BaseProcessor {
     extractTexts(filePathOrBuffer: ProcessorInput): Promise<string[]>;
     loadIntoTree(filePathOrBuffer: ProcessorInput): Promise<AACTree>;
     processTexts(filePathOrBuffer: ProcessorInput, translations: Map<string, string>, outputPath: string): Promise<Uint8Array>;
+    /**
+     * Save a modified tree while preserving the original SQLite schema and data.
+     *
+     * Strategy: copy the original .sps verbatim, then open the copy and replay
+     * `page.pendingMutations` as targeted SQL UPDATE/INSERT statements. Everything
+     * not in the mutation log (PageLayout, ScanGroup, image blobs, ContentTypeData,
+     * ButtonPageLink, etc.) is preserved byte-for-byte from the original.
+     *
+     * This is the asset-preserving counterpart to `saveFromTree` (which builds a
+     * stripped-down DB from scratch and is unsuitable for round-tripping real
+     * TD Snap page sets).
+     *
+     * Supported mutations:
+     * - updateButton(id, patch)  → UPDATE Button SET Label/Message WHERE Id = ?
+     * - removeButton(id)         → UPDATE ElementPlacement SET Visible = 0 for all
+     *                              placements pointing at the button's ElementReference
+     * - addButton(button)        → INSERT into ElementReference + Button + one
+     *                              ElementPlacement per existing PageLayout for
+     *                              the target page (so the button shows in every
+     *                              layout the user has). Image/audio not yet handled.
+     *
+     * WordList mutations are no-ops on Snap (capabilities.wordList === 'none').
+     */
+    saveModifiedTree(originalPath: string, tree: AACTree, outputPath: string): Promise<void>;
     saveFromTree(tree: AACTree, outputPath: string): Promise<void>;
     /**
      * Add audio recording to a button in the database

package/dist/processors/snapProcessor.js

@@ -42,7 +42,7 @@ class SnapProcessor extends baseProcessor_1.BaseProcessor {
         super(options);
         this.capabilities = {
             wordList: 'none',
-            preservesAssetsOnSave: false,
+            preservesAssetsOnSave: true,
             newCellCreation: 'allowed',
         };
         this.symbolResolver = null;
@@ -582,7 +582,8 @@ class SnapProcessor extends baseProcessor_1.BaseProcessor {
                     // Add to the intended parent page
                     const parentPage = tree.getPage(parentUniqueId);
                     if (parentPage) {
-                        parentPage.addButton(button);
+                        // Load path: do not record as a user mutation
+                        parentPage._loadButton(button);
                         // Add button to grid layout if position data is available
                         const gridPositionStr = String(btnRow.GridPosition || '');
                         if (gridPositionStr && gridPositionStr.includes(',')) {
@@ -812,6 +813,324 @@ class SnapProcessor extends baseProcessor_1.BaseProcessor {
         await this.saveFromTree(tree, outputPath);
         return await readBinaryFromInput(outputPath);
     }
+    /**
+     * Save a modified tree while preserving the original SQLite schema and data.
+     *
+     * Strategy: copy the original .sps verbatim, then open the copy and replay
+     * `page.pendingMutations` as targeted SQL UPDATE/INSERT statements. Everything
+     * not in the mutation log (PageLayout, ScanGroup, image blobs, ContentTypeData,
+     * ButtonPageLink, etc.) is preserved byte-for-byte from the original.
+     *
+     * This is the asset-preserving counterpart to `saveFromTree` (which builds a
+     * stripped-down DB from scratch and is unsuitable for round-tripping real
+     * TD Snap page sets).
+     *
+     * Supported mutations:
+     * - updateButton(id, patch)  → UPDATE Button SET Label/Message WHERE Id = ?
+     * - removeButton(id)         → UPDATE ElementPlacement SET Visible = 0 for all
+     *                              placements pointing at the button's ElementReference
+     * - addButton(button)        → INSERT into ElementReference + Button + one
+     *                              ElementPlacement per existing PageLayout for
+     *                              the target page (so the button shows in every
+     *                              layout the user has). Image/audio not yet handled.
+     *
+     * WordList mutations are no-ops on Snap (capabilities.wordList === 'none').
+     */
+    async saveModifiedTree(originalPath, tree, outputPath) {
+        const { pathExists, mkDir, removePath, dirname, readBinaryFromInput, writeBinaryToPath } = this.options.fileAdapter;
+        if (!(0, io_1.isNodeRuntime)()) {
+            throw new Error('saveModifiedTree is only supported in Node.js for Snap files.');
+        }
+        const outputDir = dirname(outputPath);
+        if (!(await pathExists(outputDir))) {
+            await mkDir(outputDir, { recursive: true });
+        }
+        if (await pathExists(outputPath)) {
+            await removePath(outputPath);
+        }
+        // 1. Copy the original verbatim — preserves all 23+ tables, blobs, settings.
+        const originalBytes = await readBinaryFromInput(originalPath);
+        await writeBinaryToPath(outputPath, originalBytes);
+        // Short-circuit: if no page has any mutations, we're done.
+        const hasAnyMutations = Object.values(tree.pages).some((page) => page.pendingMutations.length > 0);
+        if (!hasAnyMutations) {
+            return;
+        }
+        // 2. Open the copy.
+        const Database = (0, sqlite_1.requireBetterSqlite3)();
+        const db = new Database(outputPath, { readonly: false });
+        try {
+            // 3. Schema introspection — different Snap versions have different optional columns.
+            const tableColumns = (table) => {
+                try {
+                    const rows = db.prepare(`PRAGMA table_info(${table})`).all();
+                    return new Set(rows.map((r) => r.name));
+                }
+                catch {
+                    return new Set();
+                }
+            };
+            const buttonCols = tableColumns('Button');
+            const placementCols = tableColumns('ElementPlacement');
+            const hasPlacementVisible = placementCols.has('Visible');
+            const hasPlacementPageLayoutId = placementCols.has('PageLayoutId');
+            // 4. UniqueId → numeric Page.Id map.
+            const pageRows = db.prepare('SELECT Id, UniqueId FROM Page').all();
+            const uniqueIdToPageId = new Map();
+            for (const row of pageRows) {
+                if (row.UniqueId)
+                    uniqueIdToPageId.set(String(row.UniqueId), row.Id);
+                // Allow lookup by stringified numeric Id too, since loadIntoTree falls back to it.
+                uniqueIdToPageId.set(String(row.Id), row.Id);
+            }
+            const layoutsByPage = new Map();
+            try {
+                const layoutRows = db
+                    .prepare('SELECT Id, PageId, PageLayoutSetting FROM PageLayout')
+                    .all();
+                // Pre-load occupied placements per layout so we can avoid (x,y) collisions.
+                const placementsByLayout = new Map();
+                const placementRows = db
+                    .prepare('SELECT PageLayoutId, GridPosition FROM ElementPlacement WHERE GridPosition IS NOT NULL AND PageLayoutId IS NOT NULL')
+                    .all();
+                for (const r of placementRows) {
+                    let set = placementsByLayout.get(r.PageLayoutId);
+                    if (!set) {
+                        set = new Set();
+                        placementsByLayout.set(r.PageLayoutId, set);
+                    }
+                    set.add(r.GridPosition);
+                }
+                for (const row of layoutRows) {
+                    const parts = String(row.PageLayoutSetting ?? '').split(',');
+                    const cols = parseInt(parts[0], 10) || 4;
+                    const rows = parseInt(parts[1], 10) || 4;
+                    const info = {
+                        id: row.Id,
+                        cols,
+                        rows,
+                        occupied: placementsByLayout.get(row.Id) ?? new Set(),
+                    };
+                    const list = layoutsByPage.get(row.PageId);
+                    if (list)
+                        list.push(info);
+                    else
+                        layoutsByPage.set(row.PageId, [info]);
+                }
+            }
+            catch {
+                // PageLayout table may not exist on older schemas — placements get NULL PageLayoutId.
+            }
+            // Find first empty cell on a layout, starting from a preferred (x,y).
+            // Returns null if the layout is fully occupied.
+            const findFreeCell = (info, prefX, prefY) => {
+                const inBounds = (x, y) => x >= 0 && x < info.cols && y >= 0 && y < info.rows;
+                if (inBounds(prefX, prefY)) {
+                    const key = `${prefX},${prefY}`;
+                    if (!info.occupied.has(key)) {
+                        info.occupied.add(key);
+                        return key;
+                    }
+                }
+                for (let y = 0; y < info.rows; y++) {
+                    for (let x = 0; x < info.cols; x++) {
+                        const key = `${x},${y}`;
+                        if (!info.occupied.has(key)) {
+                            info.occupied.add(key);
+                            return key;
+                        }
+                    }
+                }
+                return null;
+            };
+            // Generate a UUID for new Button.UniqueId. Required: Node has crypto.randomUUID since 14.17.
+            const nodeCrypto = (0, io_1.getNodeRequire)()?.('crypto');
+            const uuid = () => nodeCrypto?.randomUUID
+                ? nodeCrypto.randomUUID()
+                : // Fallback (very unlikely path, but shouldn't break older Nodes)
+                    'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+                        const r = (Math.random() * 16) | 0;
+                        const v = c === 'x' ? r : (r & 0x3) | 0x8;
+                        return v.toString(16);
+                    });
+            // 5. Next-available IDs for inserts.
+            const nextId = (table) => {
+                const row = db.prepare(`SELECT COALESCE(MAX(Id), 0) AS maxId FROM ${table}`).get();
+                return (row.maxId || 0) + 1;
+            };
+            let nextButtonId = nextId('Button');
+            let nextElementRefId = nextId('ElementReference');
+            let nextPlacementId = nextId('ElementPlacement');
+            // CommandSequence is optional but TD Snap crashes on some pages (e.g. dashboards
+            // like "Google Home Speaker") when a button has no CommandSequence row. Every
+            // button in the original DB has one. We track this only if the table exists.
+            const hasCommandSequence = tableColumns('CommandSequence').size > 0;
+            let nextCommandSequenceId = hasCommandSequence ? nextId('CommandSequence') : 0;
+            // 6. Replay mutations inside one transaction for atomicity + speed.
+            const replay = db.transaction(() => {
+                for (const page of Object.values(tree.pages)) {
+                    if (page.pendingMutations.length === 0)
+                        continue;
+                    const numericPageId = uniqueIdToPageId.get(String(page.id));
+                    if (numericPageId === undefined) {
+                        // eslint-disable-next-line no-console
+                        console.warn(`[Snap] saveModifiedTree: page "${page.name}" (${page.id}) not found in original DB; skipping ${page.pendingMutations.length} mutation(s)`);
+                        continue;
+                    }
+                    for (const mutation of page.pendingMutations) {
+                        switch (mutation.type) {
+                            case 'updateButton': {
+                                const sets = [];
+                                const args = [];
+                                if (mutation.patch.label !== undefined && buttonCols.has('Label')) {
+                                    sets.push('Label = ?');
+                                    args.push(mutation.patch.label);
+                                }
+                                if (mutation.patch.message !== undefined && buttonCols.has('Message')) {
+                                    sets.push('Message = ?');
+                                    args.push(mutation.patch.message);
+                                }
+                                if (sets.length === 0)
+                                    break;
+                                args.push(Number(mutation.buttonId));
+                                db.prepare(`UPDATE Button SET ${sets.join(', ')} WHERE Id = ?`).run(...args);
+                                break;
+                            }
+                            case 'removeButton': {
+                                // Hide all placements that reference the button's ElementReference.
+                                const buttonRow = db
+                                    .prepare('SELECT ElementReferenceId FROM Button WHERE Id = ?')
+                                    .get(Number(mutation.buttonId));
+                                if (!buttonRow || buttonRow.ElementReferenceId == null)
+                                    break;
+                                if (hasPlacementVisible) {
+                                    db.prepare('UPDATE ElementPlacement SET Visible = 0 WHERE ElementReferenceId = ?').run(buttonRow.ElementReferenceId);
+                                }
+                                else {
+                                    // Older schemas without Visible: delete the placements outright.
+                                    db.prepare('DELETE FROM ElementPlacement WHERE ElementReferenceId = ?').run(buttonRow.ElementReferenceId);
+                                }
+                                break;
+                            }
+                            case 'addButton': {
+                                const button = mutation.button;
+                                const elementRefId = nextElementRefId++;
+                                const buttonId = nextButtonId++;
+                                // ElementReference: TD Snap requires ElementType, ForegroundColor,
+                                // BackgroundColor, and AudioCueRecordingId to be non-NULL on render
+                                // — NULL values crash dashboard pages (e.g. "Google Home Speaker").
+                                // Defaults below match the modal values across real Snap files
+                                // (>99% of existing rows in Core First Scanning use them).
+                                const erColumns = tableColumns('ElementReference');
+                                const erCandidates = [
+                                    { col: 'Id', value: elementRefId },
+                                    { col: 'PageId', value: numericPageId },
+                                    { col: 'ElementType', value: 0 }, // 0 = button; only nonzero in 1/20608 rows
+                                    { col: 'ForegroundColor', value: -14934754 }, // dark text default (99.8% of rows)
+                                    { col: 'BackgroundColor', value: -132102 }, // light cell default (85.7% of rows)
+                                    { col: 'AudioCueRecordingId', value: 0 }, // 0 = no audio cue (99.99% of rows)
+                                ];
+                                const erFieldsPresent = erCandidates.filter((f) => erColumns.has(f.col));
+                                db.prepare(`INSERT INTO ElementReference (${erFieldsPresent
+                                    .map((f) => f.col)
+                                    .join(', ')}) VALUES (${erFieldsPresent.map(() => '?').join(', ')})`).run(...erFieldsPresent.map((f) => f.value));
+                                // Button: provide non-NULL defaults for columns TD Snap reads.
+                                // ContentType = 6 (normal speak button), CommandFlags = 8 (standard),
+                                // LabelOwnership / ImageOwnership = 3 (owned by this page set),
+                                // ActiveContentType = 0, BorderThickness = 0, UniqueId = fresh GUID,
+                                // image / sound / symbol IDs = 0 (= "no asset").
+                                const candidateFields = [
+                                    { col: 'Id', value: buttonId },
+                                    { col: 'Label', value: button.label || '' },
+                                    { col: 'Message', value: button.message || button.label || '' },
+                                    { col: 'ElementReferenceId', value: elementRefId },
+                                    { col: 'ContentType', value: 6 },
+                                    { col: 'CommandFlags', value: 8 },
+                                    { col: 'LabelOwnership', value: 3 },
+                                    { col: 'ImageOwnership', value: 3 },
+                                    { col: 'ActiveContentType', value: 0 },
+                                    { col: 'BorderThickness', value: 0 },
+                                    { col: 'UniqueId', value: uuid() },
+                                    { col: 'LibrarySymbolId', value: 0 },
+                                    { col: 'PageSetImageId', value: 0 },
+                                    { col: 'MessageRecordingId', value: 0 },
+                                    // UseMessageRecording: omit. 99.99% of existing rows have NULL,
+                                    // and forcing 0 makes Sarah/Mum the only outliers in the DB.
+                                    { col: 'SymbolColorDataId', value: 0 },
+                                ];
+                                const presentFields = candidateFields.filter((f) => buttonCols.has(f.col));
+                                const sql = `INSERT INTO Button (${presentFields
+                                    .map((f) => f.col)
+                                    .join(', ')}) VALUES (${presentFields.map(() => '?').join(', ')})`;
+                                db.prepare(sql).run(...presentFields.map((f) => f.value));
+                                // Insert a default CommandSequence row that explicitly speaks the
+                                // button's Label ($type:3 = MessageAction, value 0 = speak Label).
+                                // This is the most common pattern in real Snap files (9514 / 19402
+                                // buttons in Core First Scanning). Without an explicit action,
+                                // dashboard pages (e.g. "Google Home Speaker") crash on render —
+                                // empty $values is only used for hidden/help-text buttons.
+                                if (hasCommandSequence) {
+                                    db.prepare('INSERT INTO CommandSequence (Id, SerializedCommands, ButtonId) VALUES (?, ?, ?)').run(nextCommandSequenceId++, '{"$type":"1","$values":[{"$type":"3","MessageAction":0}]}', buttonId);
+                                }
+                                const layouts = layoutsByPage.get(numericPageId) ?? [];
+                                const prefX = button.x ?? 0;
+                                const prefY = button.y ?? 0;
+                                if (layouts.length === 0) {
+                                    const placementId = nextPlacementId++;
+                                    if (hasPlacementPageLayoutId) {
+                                        db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId, Visible) VALUES (?, ?, ?, '1,1', NULL, 1)").run(placementId, elementRefId, `${prefX},${prefY}`);
+                                    }
+                                    else {
+                                        db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, Visible) VALUES (?, ?, ?, '1,1', 1)").run(placementId, elementRefId, `${prefX},${prefY}`);
+                                    }
+                                }
+                                else {
+                                    // INVARIANT: every Button must have exactly one ElementPlacement
+                                    // per PageLayout on its page. Snap renders buttons × layouts and
+                                    // crashes if a (button, layout) pair is missing.
+                                    //
+                                    // Hidden placements (Visible=0) MUST use a position that doesn't
+                                    // collide with an existing visible placement on that layout.
+                                    // The existing convention puts hidden placements at out-of-grid
+                                    // coordinates (e.g. position (2,4) on a 4×3 layout where row 4
+                                    // doesn't exist). We do the same: synthesise (cols, 0) which is
+                                    // guaranteed out of bounds since valid X is 0..cols-1.
+                                    for (const info of layouts) {
+                                        const cell = findFreeCell(info, prefX, prefY);
+                                        const visible = cell !== null ? 1 : 0;
+                                        const gridPosition = cell ?? `${info.cols},0`;
+                                        const placementId = nextPlacementId++;
+                                        if (hasPlacementPageLayoutId && hasPlacementVisible) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId, Visible) VALUES (?, ?, ?, '1,1', ?, ?)").run(placementId, elementRefId, gridPosition, info.id, visible);
+                                        }
+                                        else if (hasPlacementPageLayoutId) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, PageLayoutId) VALUES (?, ?, ?, '1,1', ?)").run(placementId, elementRefId, gridPosition, info.id);
+                                        }
+                                        else if (hasPlacementVisible) {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan, Visible) VALUES (?, ?, ?, '1,1', ?)").run(placementId, elementRefId, gridPosition, visible);
+                                        }
+                                        else {
+                                            db.prepare("INSERT INTO ElementPlacement (Id, ElementReferenceId, GridPosition, GridSpan) VALUES (?, ?, ?, '1,1')").run(placementId, elementRefId, gridPosition);
+                                        }
+                                    }
+                                }
+                                break;
+                            }
+                            case 'addWordListItem':
+                            case 'removeWordListItem':
+                            case 'clearWordList':
+                                // Snap has no WordList concept — these are no-ops by capability contract.
+                                break;
+                        }
+                    }
+                }
+            });
+            replay();
+        }
+        finally {
+            db.close();
+        }
+    }
     async saveFromTree(tree, outputPath) {
         const { pathExists, mkDir, removePath, dirname } = this.options.fileAdapter;
         if (!(0, io_1.isNodeRuntime)()) {

package/dist/processors/touchchatProcessor.js

@@ -269,8 +269,8 @@ class TouchChatProcessor extends baseProcessor_1.BaseProcessor {
                             // Set button's x and y coordinates
                             button.x = absoluteX;
                             button.y = absoluteY;
-                            // Add button to page
-                            page.addButton(button);
+                            // Add button to page (load path: do not record as a user mutation)
+                            page._loadButton(button);
                             // Place button in grid (handle span)
                             for (let r = absoluteY; r < absoluteY + safeSpanY && r < 10; r++) {
                                 for (let c = absoluteX; c < absoluteX + safeSpanX && c < 10; c++) {
@@ -371,7 +371,7 @@ class TouchChatProcessor extends baseProcessor_1.BaseProcessor {
                     // Find the page that references this resource
                     const page = Object.values(tree.pages).find((p) => p.id === (numericToRid.get(btnRow.id) || String(btnRow.id)));
                     if (page)
-                        page.addButton(button);
+                        page._loadButton(button); // load path: do not record as a user mutation
                 });
             }
             catch (_e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "description": "A comprehensive TypeScript library for processing AAC (Augmentative and Alternative Communication) file formats with translation support",
   "main": "dist/index.js",
   "browser": "dist/browser/index.browser.js",