@willwade/aac-processors 0.2.8 → 0.2.10

package/dist/browser/processors/obfProcessor.js

@@ -80,7 +80,7 @@ class ObfProcessor extends BaseProcessor {
             // Images are typically stored in an 'images' folder or root
             const possiblePaths = [
                 imageData.path, // Explicit path if provided
-                `images/${imageData.filename || imageId}`, // Standard images folder
+                `images/${imageData.path || imageId}`, // Standard images folder
                 imageData.id, // Just the ID
             ].filter(Boolean);
             for (const imagePath of possiblePaths) {
@@ -126,14 +126,18 @@ class ObfProcessor extends BaseProcessor {
                 return 'image/png';
         }
     }
-    async processBoard(boardData, _boardPath, isZipEntry) {
+    getPageFilename(id, metadata) {
+        if (metadata._obfPagePaths && id in metadata._obfPagePaths)
+            return metadata._obfPagePaths[id];
+        if (id.endsWith('.obf'))
+            return id;
+        return `${id}.obf`;
+    }
+    async processBoard(boardData, _boardPath) {
         const sourceButtons = boardData.buttons || [];
         // Calculate page ID first (used to make button IDs unique)
-        const pageId = isZipEntry
-            ? _boardPath // Zip entry - use filename to match navigation paths
-            : boardData?.id
-                ? String(boardData.id)
-                : _boardPath?.split(/[/\\]/).pop() || '';
+        const pageId = boardData?.id ? String(boardData.id) : _boardPath?.split(/[/\\]/).pop() || '';
+        const images = boardData.images;
         const buttons = await Promise.all(sourceButtons.map(async (btn) => {
             const semanticAction = btn.load_board
                 ? {
@@ -157,11 +161,16 @@ class ObfProcessor extends BaseProcessor {
             // Resolve image if image_id is present
             let resolvedImage;
             let imageBuffer;
-            if (btn.image_id && boardData.images) {
-                resolvedImage =
-                    (await this.extractImageAsDataUrl(btn.image_id, boardData.images)) || undefined;
-                imageBuffer =
-                    (await this.extractImageAsBuffer(btn.image_id, boardData.images)) || undefined;
+            if (btn.image_id && images) {
+                resolvedImage = (await this.extractImageAsDataUrl(btn.image_id, images)) || undefined;
+                imageBuffer = (await this.extractImageAsBuffer(btn.image_id, images)) || undefined;
+                // save image data
+                if (images) {
+                    const imageIndex = images?.findIndex((img) => img.id === btn.image_id);
+                    if (imageIndex !== -1) {
+                        images[imageIndex].data = resolvedImage;
+                    }
+                }
             }
             // Build parameters object for Grid3 export compatibility
             const buttonParameters = {};
@@ -198,7 +207,7 @@ class ObfProcessor extends BaseProcessor {
             parentId: null,
             locale: boardData.locale,
             descriptionHtml: boardData.description_html,
-            images: boardData.images,
+            images,
             sounds: boardData.sounds,
         });
         // Process grid layout if available
@@ -288,7 +297,7 @@ class ObfProcessor extends BaseProcessor {
         return texts;
     }
     async loadIntoTree(filePathOrBuffer) {
-        const { readBinaryFromInput, readTextFromInput } = this.options.fileAdapter;
+        const { readBinaryFromInput, readTextFromInput, listDir, join, isDirectory } = this.options.fileAdapter;
         // Detailed logging for debugging input
         const bufferLength = typeof filePathOrBuffer === 'string'
             ? null
@@ -330,7 +339,7 @@ class ObfProcessor extends BaseProcessor {
                 const boardData = await tryParseObfJson(content);
                 if (boardData) {
                     console.log('[OBF] Detected .obf file, parsed as JSON');
-                    const page = await this.processBoard(boardData, filePathOrBuffer, false);
+                    const page = await this.processBoard(boardData, filePathOrBuffer);
                     tree.addPage(page);
                     // Set metadata from root board
                     tree.metadata.format = 'obf';
@@ -354,22 +363,30 @@ class ObfProcessor extends BaseProcessor {
                 throw err;
             }
         }
-        // Detect likely zip signature first
-        async function isLikelyZip(input) {
-            if (typeof input === 'string') {
-                const lowered = input.toLowerCase();
-                return lowered.endsWith('.zip') || lowered.endsWith('.obz');
+        // Determine if input is ZIP, directory, or OBF JSON string/buffer
+        let fileType = 'obf';
+        if (typeof filePathOrBuffer !== 'string') {
+            const bytes = await readBinaryFromInput(filePathOrBuffer);
+            if (bytes.length >= 2 && bytes[0] === 0x50 && bytes[1] === 0x4b)
+                fileType = 'zip';
+        }
+        else {
+            if (await isDirectory(filePathOrBuffer)) {
+                fileType = 'dir';
+            }
+            else {
+                const lowered = filePathOrBuffer.toLowerCase();
+                if (lowered.endsWith('.zip') || lowered.endsWith('.obz'))
+                    fileType = 'zip';
             }
-            const bytes = await readBinaryFromInput(input);
-            return bytes.length >= 2 && bytes[0] === 0x50 && bytes[1] === 0x4b;
         }
         // Check if input is a buffer or string that parses as OBF JSON; throw if neither JSON nor ZIP
-        if (!(await isLikelyZip(filePathOrBuffer))) {
+        if (fileType === 'obf') {
             const asJson = await tryParseObfJson(filePathOrBuffer);
             if (!asJson)
                 throw new Error('Invalid OBF content: not JSON and not ZIP');
             console.log('[OBF] Detected buffer/string as OBF JSON');
-            const page = await this.processBoard(asJson, '[bufferOrString]', false);
+            const page = await this.processBoard(asJson, '[bufferOrString]');
             tree.addPage(page);
             // Set metadata from root board
             tree.metadata.format = 'obf';
@@ -385,18 +402,31 @@ class ObfProcessor extends BaseProcessor {
             tree.rootId = page.id;
             return tree;
         }
-        try {
-            this.zipFile = await this.options.zipAdapter(filePathOrBuffer);
-        }
-        catch (err) {
-            console.error('[OBF] Error loading ZIP:', err);
-            throw err;
+        this.zipFile = {
+            readFile: async (name) => {
+                return await readBinaryFromInput(join(filePathOrBuffer, name));
+            },
+            listFiles: () => {
+                throw new Error('Not implemented for directory input');
+            },
+            writeFiles: () => {
+                throw new Error('Not implemented for directory input');
+            },
+        };
+        if (fileType === 'zip') {
+            try {
+                this.zipFile = await this.options.zipAdapter(filePathOrBuffer);
+            }
+            catch (err) {
+                console.error('[OBF] Error loading ZIP:', err);
+                throw err;
+            }
         }
         // Store the ZIP file reference for image extraction
         this.imageCache.clear(); // Clear cache for new file
-        console.log('[OBF] Detected zip archive, extracting .obf files');
+        console.log('[OBF] Detected zip archive or directory, extracting .obf files');
         // List manifest and OBF files
-        const filesInZip = this.zipFile.listFiles();
+        const filesInZip = fileType === 'zip' ? this.zipFile.listFiles() : await listDir(filePathOrBuffer);
         const manifestFile = filesInZip.filter((name) => name.toLowerCase() === 'manifest.json');
         let obfEntries = filesInZip.filter((name) => name.toLowerCase().endsWith('.obf'));
         // Attempt to read manifest
@@ -430,7 +460,7 @@ class ObfProcessor extends BaseProcessor {
                 const content = await this.zipFile.readFile(entryName);
                 const boardData = await tryParseObfJson(decodeText(content));
                 if (boardData) {
-                    const page = await this.processBoard(boardData, entryName, true);
+                    const page = await this.processBoard(boardData, entryName);
                     tree.addPage(page);
                     // Set metadata if not already set (use first board as reference)
                     if (!tree.metadata.format) {
@@ -439,12 +469,16 @@ class ObfProcessor extends BaseProcessor {
                         tree.metadata.description = boardData.description_html;
                         tree.metadata.locale = boardData.locale;
                         tree.metadata.id = boardData.id;
+                        tree.metadata._obfPagePaths = { [page.id]: entryName };
                         if (boardData.url)
                             tree.metadata.url = boardData.url;
                         if (boardData.locale)
                             tree.metadata.languages = [boardData.locale];
                         tree.rootId = page.id;
                     }
+                    else {
+                        tree.metadata._obfPagePaths[page.id] = entryName;
+                    }
                 }
                 else {
                     console.warn('[OBF] Skipped entry (not valid OBF JSON):', entryName);
@@ -497,11 +531,18 @@ class ObfProcessor extends BaseProcessor {
         }
         return { rows: totalRows, columns: totalColumns, order, buttonPositions };
     }
-    createObfBoardFromPage(page, fallbackName, metadata) {
+    createObfBoardFromPage(page, fallbackName, metadata, embedData = false) {
         const { rows, columns, order, buttonPositions } = this.buildGridMetadata(page);
         const boardName = metadata?.name && page.id === metadata?.defaultHomePageId
             ? metadata.name
             : page.name || fallbackName;
+        let images = Array.isArray(page.images) ? page.images : [];
+        if (!embedData) {
+            images = images.map((image) => {
+                delete image.data;
+                return image;
+            });
+        }
         return {
             format: OBF_FORMAT_VERSION,
             id: page.id,
@@ -538,7 +579,7 @@ class ObfProcessor extends BaseProcessor {
                     hidden: button.visibility === 'Hidden' || false,
                 };
             }),
-            images: Array.isArray(page.images) ? page.images : [],
+            images,
             sounds: Array.isArray(page.sounds) ? page.sounds : [],
         };
     }
@@ -575,23 +616,22 @@ class ObfProcessor extends BaseProcessor {
         await this.saveFromTree(tree, outputPath);
         return await readBinaryFromInput(outputPath);
     }
-    async saveFromTree(tree, outputPath) {
-        const { writeTextToPath, writeBinaryToPath, pathExists } = this.options.fileAdapter;
+    async saveFromTree(tree, outputPath, embedData = false) {
+        const { writeTextToPath, writeBinaryToPath, pathExists, mkDir, join } = this.options.fileAdapter;
         if (outputPath.endsWith('.obf')) {
             // Save as single OBF JSON file
             const rootPage = tree.rootId ? tree.getPage(tree.rootId) : Object.values(tree.pages)[0];
             if (!rootPage) {
                 throw new Error('No pages to save');
             }
-            const obfBoard = this.createObfBoardFromPage(rootPage, 'Exported Board', tree.metadata);
+            const obfBoard = this.createObfBoardFromPage(rootPage, 'Exported Board', tree.metadata, embedData);
             await writeTextToPath(outputPath, JSON.stringify(obfBoard, null, 2));
         }
         else {
-            const getPageFilename = (id) => (id.endsWith('.obf') ? id : `${id}.obf`);
             const files = Object.values(tree.pages).map((page) => {
-                const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata);
+                const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata, embedData);
                 const obfContent = JSON.stringify(obfBoard, null, 2);
-                const name = getPageFilename(page.id);
+                const name = this.getPageFilename(page.id, tree.metadata);
                 return {
                     name,
                     data: new TextEncoder().encode(obfContent),
@@ -601,7 +641,10 @@ class ObfProcessor extends BaseProcessor {
                 format: OBF_FORMAT_VERSION,
                 root: tree.metadata.defaultHomePageId,
                 paths: {
-                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [id, getPageFilename(page.id)])),
+                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [
+                        id,
+                        this.getPageFilename(page.id, tree.metadata),
+                    ])),
                     images: {}, //TODO Add support for saving images as files
                     sounds: {}, //TODO Add support for saving sounds as files
                 },
@@ -610,10 +653,22 @@ class ObfProcessor extends BaseProcessor {
                 name: 'manifest.json',
                 data: new TextEncoder().encode(JSON.stringify(manifest)),
             });
-            const fileExists = await pathExists(outputPath);
-            this.zipFile = await this.options.zipAdapter(fileExists ? outputPath : undefined, this.options.fileAdapter);
-            const zipData = await this.zipFile.writeFiles(files);
-            await writeBinaryToPath(outputPath, zipData);
+            if (outputPath.endsWith('.obz') || outputPath.endsWith('.zip')) {
+                console.log('[OBF] Saving to ZIP file:', outputPath);
+                const fileExists = await pathExists(outputPath);
+                this.zipFile = await this.options.zipAdapter(fileExists ? outputPath : undefined, this.options.fileAdapter);
+                const zipData = await this.zipFile.writeFiles(files);
+                await writeBinaryToPath(outputPath, zipData);
+            }
+            else {
+                console.log('[OBF] Saving to directory:', outputPath);
+                if (!(await pathExists(outputPath)))
+                    await mkDir(outputPath);
+                for (const file of files) {
+                    const filePath = join(outputPath, file.name);
+                    await writeBinaryToPath(filePath, file.data);
+                }
+            }
         }
     }
     /**
@@ -640,13 +695,12 @@ class ObfProcessor extends BaseProcessor {
         const AdmZip = (await import('adm-zip')).default;
         const originalZip = new AdmZip(originalPath);
         const outputZip = new AdmZip();
-        const getPageFilename = (id) => (id.endsWith('.obf') ? id : `${id}.obf`);
         // Track which .obf files we're modifying
         const modifiedObfFiles = new Set();
         // Generate new .obf files for pages in the tree
         const newObfFiles = new Map();
         for (const page of Object.values(tree.pages)) {
-            const obfFilename = getPageFilename(page.id);
+            const obfFilename = this.getPageFilename(page.id, tree.metadata);
             modifiedObfFiles.add(obfFilename);
             const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata);
             const obfContent = JSON.stringify(obfBoard, null, 2);
@@ -659,7 +713,10 @@ class ObfProcessor extends BaseProcessor {
                 format: OBF_FORMAT_VERSION,
                 root: tree.metadata.defaultHomePageId,
                 paths: {
-                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [id, getPageFilename(page.id)])),
+                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [
+                        id,
+                        this.getPageFilename(page.id, tree.metadata),
+                    ])),
                     images: {},
                     sounds: {},
                 },

package/dist/browser/utilities/analytics/morphology/index.js

@@ -1,3 +1,2 @@
 export { MorphologyEngine } from './engine';
-export { Grid3VerbsParser } from './grid3VerbsParser';
 export { WordFormGenerator } from './wordFormGenerator';

package/dist/processors/gridsetProcessor.d.ts

@@ -54,12 +54,17 @@ declare class GridsetProcessor extends BaseProcessor {
     /**
      * Save a modified tree while preserving all original files (settings, images, assets)
      * This method only updates the grid.xml files for pages in the tree, keeping everything else intact.
+     * It preserves the original grid structure and only updates button labels and messages.
      *
      * @param originalPath - Path to the original gridset file
      * @param tree - Modified AACTree with pages to save
      * @param outputPath - Path where the modified gridset should be saved
      */
     saveModifiedTree(originalPath: string, tree: AACTree, outputPath: string): Promise<void>;
+    /**
+     * Create a basic grid XML for a page when original doesn't exist
+     */
+    private createBasicGridXml;
     private findButtonPosition;
     /**
      * Extract strings with metadata for aac-tools-platform compatibility