@willwade/aac-processors 0.1.19 → 0.1.20

package/dist/browser/processors/obfProcessor.js

@@ -120,13 +120,9 @@ class ObfProcessor extends BaseProcessor {
                 return 'image/png';
         }
     }
-    async processBoard(boardData, _boardPath) {
+    async processBoard(boardData, _boardPath, isZipEntry) {
         const sourceButtons = boardData.buttons || [];
         // Calculate page ID first (used to make button IDs unique)
-        const isZipEntry = _boardPath &&
-            _boardPath.endsWith('.obf') &&
-            !_boardPath.includes('/') &&
-            !_boardPath.includes('\\');
         const pageId = isZipEntry
             ? _boardPath // Zip entry - use filename to match navigation paths
             : boardData?.id
@@ -328,7 +324,7 @@ class ObfProcessor extends BaseProcessor {
                 const boardData = tryParseObfJson(content);
                 if (boardData) {
                     console.log('[OBF] Detected .obf file, parsed as JSON');
-                    const page = await this.processBoard(boardData, filePathOrBuffer);
+                    const page = await this.processBoard(boardData, filePathOrBuffer, false);
                     tree.addPage(page);
                     // Set metadata from root board
                     tree.metadata.format = 'obf';
@@ -367,7 +363,7 @@ class ObfProcessor extends BaseProcessor {
             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]');
+            const page = await this.processBoard(asJson, '[bufferOrString]', false);
             tree.addPage(page);
             // Set metadata from root board
             tree.metadata.format = 'obf';
@@ -396,17 +392,42 @@ class ObfProcessor extends BaseProcessor {
         // 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');
-        // Collect all .obf entries
-        const obfEntries = this.zipFile
-            .listFiles()
-            .filter((name) => name.toLowerCase().endsWith('.obf'));
+        // List manifest and OBF files
+        const filesInZip = this.zipFile.listFiles();
+        const manifestFile = filesInZip.filter((name) => name.toLowerCase() === 'manifest.json');
+        let obfEntries = filesInZip.filter((name) => name.toLowerCase().endsWith('.obf'));
+        // Attempt to read manifest
+        if (manifestFile && manifestFile.length === 1) {
+            try {
+                const content = await this.zipFile.readFile(manifestFile[0]);
+                const data = decodeText(content);
+                const str = typeof data === 'string' ? data : readTextFromInput(data);
+                if (!str.trim())
+                    throw new Error('Manifest object missing');
+                const manifestObject = JSON.parse(str);
+                if (!manifestObject)
+                    throw new Error('Manifest object is empty');
+                // Replace OBF file list
+                if (manifestObject.paths && manifestObject.paths.boards) {
+                    obfEntries = Object.values(manifestObject.paths.boards);
+                }
+                // Move root board to top of list
+                if (manifestObject.root) {
+                    obfEntries = obfEntries.filter((item) => item !== manifestObject.root);
+                    obfEntries.unshift(manifestObject.root);
+                }
+            }
+            catch (err) {
+                console.warn('[OBF] Error processing mainfest', err);
+            }
+        }
         // Process each .obf entry
         for (const entryName of obfEntries) {
             try {
                 const content = await this.zipFile.readFile(entryName);
                 const boardData = tryParseObfJson(decodeText(content));
                 if (boardData) {
-                    const page = await this.processBoard(boardData, entryName);
+                    const page = await this.processBoard(boardData, entryName, true);
                     tree.addPage(page);
                     // Set metadata if not already set (use first board as reference)
                     if (!tree.metadata.format) {

package/dist/browser/processors/snapProcessor.js

@@ -2,8 +2,9 @@ import { BaseProcessor, } from '../core/baseProcessor';
 import { AACTree, AACPage, AACButton, AACSemanticCategory, AACSemanticIntent, } from '../core/treeStructure';
 import { generateCloneId } from '../utilities/analytics/utils/idGenerator';
 import { SnapValidator } from '../validation/snapValidator';
-import { getFs, getNodeRequire, getPath, isNodeRuntime } from '../utils/io';
+import { getFs, getNodeRequire, getPath, isNodeRuntime, getOs } from '../utils/io';
 import { openSqliteDatabase, requireBetterSqlite3 } from '../utils/sqlite';
+import { openZipFromInput } from '../utils/zip';
 /**
  * Convert a Buffer or Uint8Array to base64 string (browser and Node compatible)
  * Node.js Buffers support toString('base64'), but Uint8Arrays in browser do not.
@@ -67,8 +68,37 @@ class SnapProcessor extends BaseProcessor {
         await Promise.resolve();
         const tree = new AACTree();
         let dbResult = null;
+        let cleanupTempZip = null;
         try {
-            dbResult = await openSqliteDatabase(filePathOrBuffer, { readonly: true });
+            // Handle .sub.zip files (Snap pageset backups containing .sps files)
+            let inputFile = filePathOrBuffer;
+            if (typeof filePathOrBuffer === 'string') {
+                const fileName = getPath().basename(filePathOrBuffer).toLowerCase();
+                if (fileName.endsWith('.sub.zip') || filePathOrBuffer.endsWith('.sub')) {
+                    const fs = getFs();
+                    const path = getPath();
+                    const os = getOs();
+                    // Extract .sub.zip to find the embedded .sps file
+                    const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'snap-sub-'));
+                    const { zip } = await openZipFromInput(filePathOrBuffer);
+                    // Find the .sps file in the archive
+                    const files = zip.listFiles();
+                    const spsFile = files.find((f) => f.endsWith('.sps'));
+                    if (!spsFile) {
+                        fs.rmSync(tempDir, { recursive: true, force: true });
+                        throw new Error('No .sps file found in .sub.zip archive');
+                    }
+                    // Extract the .sps file
+                    const spsData = await zip.readFile(spsFile);
+                    const extractedSpsPath = path.join(tempDir, path.basename(spsFile));
+                    fs.writeFileSync(extractedSpsPath, Buffer.from(spsData));
+                    inputFile = extractedSpsPath;
+                    cleanupTempZip = () => {
+                        fs.rmSync(tempDir, { recursive: true, force: true });
+                    };
+                }
+            }
+            dbResult = await openSqliteDatabase(inputFile, { readonly: true });
             const db = dbResult.db;
             const getTableColumns = (tableName) => {
                 try {
@@ -658,6 +688,15 @@ class SnapProcessor extends BaseProcessor {
             else if (dbResult?.db) {
                 dbResult.db.close();
             }
+            // Clean up temporary extracted .sps file from .sub.zip
+            if (cleanupTempZip) {
+                try {
+                    cleanupTempZip();
+                }
+                catch (e) {
+                    console.warn('[SnapProcessor] Failed to clean up temporary .sps file:', e);
+                }
+            }
         }
     }
     async processTexts(filePathOrBuffer, translations, outputPath) {

package/dist/core/fileProcessor.js

@@ -18,6 +18,11 @@ class FileProcessor {
     static detectFormat(filePathOrBuffer) {
         if (typeof filePathOrBuffer === 'string') {
             const ext = path_1.default.extname(filePathOrBuffer).toLowerCase();
+            const fileName = path_1.default.basename(filePathOrBuffer).toLowerCase();
+            // Handle double extensions like .sub.zip
+            if (fileName.endsWith('.sub.zip') || ext === '.sub') {
+                return 'snap';
+            }
             switch (ext) {
                 case '.gridset':
                 case '.gridsetx':

package/dist/processors/obfProcessor.js

@@ -146,13 +146,9 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
                 return 'image/png';
         }
     }
-    async processBoard(boardData, _boardPath) {
+    async processBoard(boardData, _boardPath, isZipEntry) {
         const sourceButtons = boardData.buttons || [];
         // Calculate page ID first (used to make button IDs unique)
-        const isZipEntry = _boardPath &&
-            _boardPath.endsWith('.obf') &&
-            !_boardPath.includes('/') &&
-            !_boardPath.includes('\\');
         const pageId = isZipEntry
             ? _boardPath // Zip entry - use filename to match navigation paths
             : boardData?.id
@@ -354,7 +350,7 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
                 const boardData = tryParseObfJson(content);
                 if (boardData) {
                     console.log('[OBF] Detected .obf file, parsed as JSON');
-                    const page = await this.processBoard(boardData, filePathOrBuffer);
+                    const page = await this.processBoard(boardData, filePathOrBuffer, false);
                     tree.addPage(page);
                     // Set metadata from root board
                     tree.metadata.format = 'obf';
@@ -393,7 +389,7 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
             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]');
+            const page = await this.processBoard(asJson, '[bufferOrString]', false);
             tree.addPage(page);
             // Set metadata from root board
             tree.metadata.format = 'obf';
@@ -422,17 +418,42 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
         // 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');
-        // Collect all .obf entries
-        const obfEntries = this.zipFile
-            .listFiles()
-            .filter((name) => name.toLowerCase().endsWith('.obf'));
+        // List manifest and OBF files
+        const filesInZip = this.zipFile.listFiles();
+        const manifestFile = filesInZip.filter((name) => name.toLowerCase() === 'manifest.json');
+        let obfEntries = filesInZip.filter((name) => name.toLowerCase().endsWith('.obf'));
+        // Attempt to read manifest
+        if (manifestFile && manifestFile.length === 1) {
+            try {
+                const content = await this.zipFile.readFile(manifestFile[0]);
+                const data = (0, io_1.decodeText)(content);
+                const str = typeof data === 'string' ? data : (0, io_1.readTextFromInput)(data);
+                if (!str.trim())
+                    throw new Error('Manifest object missing');
+                const manifestObject = JSON.parse(str);
+                if (!manifestObject)
+                    throw new Error('Manifest object is empty');
+                // Replace OBF file list
+                if (manifestObject.paths && manifestObject.paths.boards) {
+                    obfEntries = Object.values(manifestObject.paths.boards);
+                }
+                // Move root board to top of list
+                if (manifestObject.root) {
+                    obfEntries = obfEntries.filter((item) => item !== manifestObject.root);
+                    obfEntries.unshift(manifestObject.root);
+                }
+            }
+            catch (err) {
+                console.warn('[OBF] Error processing mainfest', err);
+            }
+        }
         // Process each .obf entry
         for (const entryName of obfEntries) {
             try {
                 const content = await this.zipFile.readFile(entryName);
                 const boardData = tryParseObfJson((0, io_1.decodeText)(content));
                 if (boardData) {
-                    const page = await this.processBoard(boardData, entryName);
+                    const page = await this.processBoard(boardData, entryName, true);
                     tree.addPage(page);
                     // Set metadata if not already set (use first board as reference)
                     if (!tree.metadata.format) {

package/dist/processors/snapProcessor.js

@@ -7,6 +7,7 @@ const idGenerator_1 = require("../utilities/analytics/utils/idGenerator");
 const snapValidator_1 = require("../validation/snapValidator");
 const io_1 = require("../utils/io");
 const sqlite_1 = require("../utils/sqlite");
+const zip_1 = require("../utils/zip");
 /**
  * Convert a Buffer or Uint8Array to base64 string (browser and Node compatible)
  * Node.js Buffers support toString('base64'), but Uint8Arrays in browser do not.
@@ -70,8 +71,37 @@ class SnapProcessor extends baseProcessor_1.BaseProcessor {
         await Promise.resolve();
         const tree = new treeStructure_1.AACTree();
         let dbResult = null;
+        let cleanupTempZip = null;
         try {
-            dbResult = await (0, sqlite_1.openSqliteDatabase)(filePathOrBuffer, { readonly: true });
+            // Handle .sub.zip files (Snap pageset backups containing .sps files)
+            let inputFile = filePathOrBuffer;
+            if (typeof filePathOrBuffer === 'string') {
+                const fileName = (0, io_1.getPath)().basename(filePathOrBuffer).toLowerCase();
+                if (fileName.endsWith('.sub.zip') || filePathOrBuffer.endsWith('.sub')) {
+                    const fs = (0, io_1.getFs)();
+                    const path = (0, io_1.getPath)();
+                    const os = (0, io_1.getOs)();
+                    // Extract .sub.zip to find the embedded .sps file
+                    const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'snap-sub-'));
+                    const { zip } = await (0, zip_1.openZipFromInput)(filePathOrBuffer);
+                    // Find the .sps file in the archive
+                    const files = zip.listFiles();
+                    const spsFile = files.find((f) => f.endsWith('.sps'));
+                    if (!spsFile) {
+                        fs.rmSync(tempDir, { recursive: true, force: true });
+                        throw new Error('No .sps file found in .sub.zip archive');
+                    }
+                    // Extract the .sps file
+                    const spsData = await zip.readFile(spsFile);
+                    const extractedSpsPath = path.join(tempDir, path.basename(spsFile));
+                    fs.writeFileSync(extractedSpsPath, Buffer.from(spsData));
+                    inputFile = extractedSpsPath;
+                    cleanupTempZip = () => {
+                        fs.rmSync(tempDir, { recursive: true, force: true });
+                    };
+                }
+            }
+            dbResult = await (0, sqlite_1.openSqliteDatabase)(inputFile, { readonly: true });
             const db = dbResult.db;
             const getTableColumns = (tableName) => {
                 try {
@@ -661,6 +691,15 @@ class SnapProcessor extends baseProcessor_1.BaseProcessor {
             else if (dbResult?.db) {
                 dbResult.db.close();
             }
+            // Clean up temporary extracted .sps file from .sub.zip
+            if (cleanupTempZip) {
+                try {
+                    cleanupTempZip();
+                }
+                catch (e) {
+                    console.warn('[SnapProcessor] Failed to clean up temporary .sps file:', e);
+                }
+            }
         }
     }
     async processTexts(filePathOrBuffer, translations, outputPath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.1.19",
+  "version": "0.1.20",
   "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",