@willwade/aac-processors 0.0.29 → 0.1.0

package/dist/processors/gridsetProcessor.js

@@ -1,19 +1,36 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridsetProcessor = void 0;
 const baseProcessor_1 = require("../core/baseProcessor");
 const treeStructure_1 = require("../core/treeStructure");
-const adm_zip_1 = __importDefault(require("adm-zip"));
-const fs_1 = __importDefault(require("fs"));
 const fast_xml_parser_1 = require("fast-xml-parser");
 const resolver_1 = require("./gridset/resolver");
 const translationProcessor_1 = require("../utilities/translation/translationProcessor");
 const password_1 = require("./gridset/password");
-const crypto_1 = __importDefault(require("crypto"));
-const zlib_1 = __importDefault(require("zlib"));
+const crypto_1 = require("./gridset/crypto");
 const gridsetValidator_1 = require("../validation/gridsetValidator");
 // New imports for enhanced Grid 3 support
 const pluginTypes_1 = require("./gridset/pluginTypes");
@@ -22,33 +39,35 @@ const symbols_1 = require("./gridset/symbols");
 const resolver_2 = require("./gridset/resolver");
 const idGenerator_1 = require("../utilities/analytics/utils/idGenerator");
 const symbolAlignment_1 = require("./gridset/symbolAlignment");
-class GridsetProcessor extends baseProcessor_1.BaseProcessor {
-    constructor(options) {
-        super(options);
-    }
-    /**
-     * Decrypt and inflate a Grid3 encrypted payload (DesktopContentEncrypter).
-     * Uses AES-256-CBC with key/IV derived from the password padded with spaces
-     * and then Deflate decompression.
-     */
-    decryptGridsetEntry(buffer, password) {
-        const pwd = (password || 'Chocolate').padEnd(32, ' ');
-        const key = Buffer.from(pwd.slice(0, 32), 'utf8');
-        const iv = Buffer.from(pwd.slice(0, 16), 'utf8');
+const io_1 = require("../utils/io");
+let JSZipModule;
+async function getJSZip() {
+    if (!JSZipModule) {
         try {
-            const decipher = crypto_1.default.createDecipheriv('aes-256-cbc', key, iv);
-            const decrypted = Buffer.concat([decipher.update(buffer), decipher.final()]);
+            // Try ES module import first (browser/Vite)
+            const module = await Promise.resolve().then(() => __importStar(require('jszip')));
+            JSZipModule = module.default || module;
+        }
+        catch (error) {
+            // Fall back to CommonJS require (Node.js)
             try {
-                return zlib_1.default.inflateSync(decrypted);
+                // eslint-disable-next-line @typescript-eslint/no-var-requires
+                const module = require('jszip');
+                JSZipModule = module.default || module;
             }
-            catch {
-                // If data isn't deflated, return raw decrypted bytes
-                return decrypted;
+            catch (err2) {
+                throw new Error('Zip handling requires JSZip in this environment.');
             }
         }
-        catch {
-            return buffer;
-        }
+    }
+    if (!JSZipModule) {
+        throw new Error('Zip handling requires JSZip in this environment.');
+    }
+    return JSZipModule;
+}
+class GridsetProcessor extends baseProcessor_1.BaseProcessor {
+    constructor(options) {
+        super(options);
     }
     // Determine password to use when opening encrypted gridset archives (.gridsetx)
     getGridsetPassword(source) {
@@ -394,8 +413,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
         }
         return undefined;
     }
-    extractTexts(filePathOrBuffer) {
-        const tree = this.loadIntoTree(filePathOrBuffer);
+    async extractTexts(filePathOrBuffer) {
+        const tree = await this.loadIntoTree(filePathOrBuffer);
         const texts = [];
         for (const pageId in tree.pages) {
             const page = tree.pages[pageId];
@@ -410,11 +429,13 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
         }
         return texts;
     }
-    loadIntoTree(filePathOrBuffer) {
+    async loadIntoTree(filePathOrBuffer) {
         const tree = new treeStructure_1.AACTree();
         let zip;
         try {
-            zip = new adm_zip_1.default(filePathOrBuffer);
+            const JSZip = await getJSZip();
+            const zipInput = (0, io_1.readBinaryFromInput)(filePathOrBuffer);
+            zip = await JSZip.loadAsync(zipInput);
         }
         catch (error) {
             throw new Error(`Invalid ZIP file format: ${error.message}`);
@@ -430,18 +451,22 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             isSmartBox: isEncryptedArchive, // SmartBox files are .gridsetx encrypted archives
             passwordProtected: !!password,
         };
-        const readEntryBuffer = (entry) => {
-            const raw = entry.getData();
-            if (!isEncryptedArchive)
+        const readEntryBuffer = async (entry) => {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-argument
+            const raw = await entry.getData();
+            if (!isEncryptedArchive) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-return
                 return raw;
-            return this.decryptGridsetEntry(raw, encryptedContentPassword);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-return
+            return (0, crypto_1.decryptGridsetEntry)(raw, encryptedContentPassword);
         };
         // Parse FileMap.xml if present to index dynamic files per grid
         const fileMapIndex = new Map();
         try {
             const fmEntry = entries.find((e) => e.entryName.endsWith('FileMap.xml'));
             if (fmEntry) {
-                const fmXml = readEntryBuffer(fmEntry).toString('utf8');
+                const fmXml = (0, io_1.decodeText)(await readEntryBuffer(fmEntry));
                 const fmData = parser.parse(fmXml);
                 const entries = fmData?.FileMap?.Entries?.Entry || fmData?.fileMap?.entries?.entry;
                 if (entries) {
@@ -476,7 +501,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
         const styleEntry = entries.find((entry) => entry.entryName.endsWith('styles.xml') || entry.entryName.endsWith('style.xml'));
         if (styleEntry) {
             try {
-                const styleXmlContent = readEntryBuffer(styleEntry).toString('utf8');
+                const styleXmlContent = (0, io_1.decodeText)(await readEntryBuffer(styleEntry));
                 const styleData = parser.parse(styleXmlContent);
                 // Parse styles and store them in the map
                 // Grid3 uses StyleData.Styles.Style with Key attribute
@@ -507,18 +532,23 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             }
         }
         // Debug: log all entry names
-        // console.log('Gridset zip entries:', entries.map(e => e.entryName));
+        console.log('[Gridset] Total zip entries:', entries.length);
+        const gridEntries = entries.filter((e) => e.entryName.startsWith('Grids/') && e.entryName.endsWith('grid.xml'));
+        console.log('[Gridset] Grid XML entries found:', gridEntries.length);
+        if (gridEntries.length > 0) {
+            console.log('[Gridset] First few grid entries:', gridEntries.slice(0, 3).map((e) => e.entryName));
+        }
         // First pass: collect all grid names and IDs for navigation resolution
         const gridNameToIdMap = new Map();
         const gridIdToNameMap = new Map();
-        entries.forEach((entry) => {
+        for (const entry of entries) {
             if (entry.entryName.startsWith('Grids/') && entry.entryName.endsWith('grid.xml')) {
                 try {
-                    const xmlContent = readEntryBuffer(entry).toString('utf8');
+                    const xmlContent = (0, io_1.decodeText)(await readEntryBuffer(entry));
                     const data = parser.parse(xmlContent);
                     const grid = data.Grid || data.grid;
                     if (!grid)
-                        return;
+                        continue;
                     const gridId = this.textOf(grid.GridGuid || grid.gridGuid || grid.id);
                     const gridName = this.textOf(grid.Name) || this.textOf(grid.name) || this.textOf(grid['@_Name']);
                     const folderMatch = entry.entryName.match(/^Grids\/([^/]+)\//);
@@ -541,32 +571,36 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                     // Skip errors in first pass
                 }
             }
-        });
+        }
         // Second pass: process each grid file in the gridset
-        entries.forEach((entry) => {
+        for (const entry of entries) {
             // Only process files named grid.xml under Grids/ (any subdir)
             if (entry.entryName.startsWith('Grids/') && entry.entryName.endsWith('grid.xml')) {
                 let xmlContent;
                 try {
-                    xmlContent = readEntryBuffer(entry).toString('utf8');
+                    const buffer = await readEntryBuffer(entry);
+                    xmlContent = (0, io_1.decodeText)(buffer);
+                    console.log(`[Gridset] Raw XML content (first 200 chars) for ${entry.entryName}:`, xmlContent.substring(0, 200));
                 }
                 catch (e) {
                     // Skip unreadable files
-                    return;
+                    continue;
                 }
                 let data;
                 try {
                     data = parser.parse(xmlContent);
+                    console.log(`[Gridset] Parsed ${entry.entryName}, root keys:`, Object.keys(data));
                 }
                 catch (error) {
                     // Skip malformed XML but log the specific error
                     console.warn(`Malformed XML in ${entry.entryName}: ${error.message}`);
-                    return;
+                    continue;
                 }
                 // Grid3 XML: <Grid> root
                 const grid = data.Grid || data.grid;
                 if (!grid) {
-                    return;
+                    console.warn(`[Gridset] No Grid/grid found in ${entry.entryName}`);
+                    continue;
                 }
                 // Defensive: GridGuid and Name required
                 const gridId = this.textOf(grid.GridGuid || grid.gridGuid || grid.id);
@@ -578,7 +612,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                         gridName = match[1];
                 }
                 if (!gridId || !gridName) {
-                    return;
+                    continue;
                 }
                 const page = new treeStructure_1.AACPage({
                     id: String(gridId),
@@ -1291,6 +1325,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                                     pluginMetadata.autoContentType === 'Prediction'
                                     ? predictionCellCounter
                                     : undefined,
+                                // Store page name for Grid3 image lookup
+                                gridPageName: gridName,
                             },
                         });
                         // Add button to page
@@ -1332,7 +1368,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                 }
                 tree.addPage(page);
             }
-        });
+        }
         // After all pages are loaded, set parentId for navigation targets
         for (const pageId in tree.pages) {
             const page = tree.pages[pageId];
@@ -1349,7 +1385,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
         try {
             const settingsEntry = entries.find((e) => e.entryName.endsWith('settings.xml'));
             if (settingsEntry) {
-                const settingsXml = readEntryBuffer(settingsEntry).toString('utf8');
+                const settingsXml = (0, io_1.decodeText)(await readEntryBuffer(settingsEntry));
                 const settingsData = parser.parse(settingsXml);
                 const gsName = settingsData?.GridSetSettings?.Name ||
                     settingsData?.gridSetSettings?.name ||
@@ -1443,9 +1479,9 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
         tree.metadata = metadata;
         return tree;
     }
-    processTexts(filePathOrBuffer, translations, outputPath) {
+    async processTexts(filePathOrBuffer, translations, outputPath) {
         // Load the tree, apply translations, and save to new file
-        const tree = this.loadIntoTree(filePathOrBuffer);
+        const tree = await this.loadIntoTree(filePathOrBuffer);
         // Apply translations to all text content
         Object.values(tree.pages).forEach((page) => {
             // Translate page names
@@ -1503,8 +1539,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             });
         });
         // Save the translated tree and return its content
-        this.saveFromTree(tree, outputPath);
-        return fs_1.default.readFileSync(outputPath);
+        await this.saveFromTree(tree, outputPath);
+        return (0, io_1.readBinaryFromInput)(outputPath);
     }
     /**
      * Extract symbol information from a gridset for LLM-based translation.
@@ -1515,8 +1551,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
      * @param filePathOrBuffer - Path to gridset file or buffer
      * @returns Array of symbol information for LLM processing
      */
-    extractSymbolsForLLM(filePathOrBuffer) {
-        const tree = this.loadIntoTree(filePathOrBuffer);
+    async extractSymbolsForLLM(filePathOrBuffer) {
+        const tree = await this.loadIntoTree(filePathOrBuffer);
         // Collect all buttons from all pages
         const allButtons = [];
         Object.values(tree.pages).forEach((page) => {
@@ -1545,8 +1581,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
      * @param options - Translation options (e.g., allowPartial for testing)
      * @returns Buffer of the translated gridset
      */
-    processLLMTranslations(filePathOrBuffer, llmTranslations, outputPath, options) {
-        const tree = this.loadIntoTree(filePathOrBuffer);
+    async processLLMTranslations(filePathOrBuffer, llmTranslations, outputPath, options) {
+        const tree = await this.loadIntoTree(filePathOrBuffer);
         // Validate translations using shared utility
         const buttonIds = Object.values(tree.pages).flatMap((page) => page.buttons.map((b) => b.id));
         (0, translationProcessor_1.validateTranslationResults)(llmTranslations, buttonIds, options);
@@ -1583,14 +1619,17 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             });
         });
         // Save and return
-        this.saveFromTree(tree, outputPath);
-        return fs_1.default.readFileSync(outputPath);
+        await this.saveFromTree(tree, outputPath);
+        return (0, io_1.readBinaryFromInput)(outputPath);
     }
-    saveFromTree(tree, outputPath) {
-        const zip = new adm_zip_1.default();
+    async saveFromTree(tree, outputPath) {
+        const JSZip = await getJSZip();
+        const zip = new JSZip();
         if (Object.keys(tree.pages).length === 0) {
             // Create empty zip for empty tree
-            zip.writeZip(outputPath);
+            const zipBuffer = await zip.generateAsync({ type: 'uint8array' });
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            require('fs').writeFileSync(outputPath, zipBuffer);
             return;
         }
         // Collect all unique styles from pages and buttons
@@ -1662,7 +1701,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             suppressEmptyNode: true,
         });
         const settingsXmlContent = settingsBuilder.build(settingsData);
-        zip.addFile('Settings0/settings.xml', Buffer.from(settingsXmlContent, 'utf8'));
+        zip.file('Settings0/settings.xml', settingsXmlContent, { binary: false });
         // Create Settings0/Styles/style.xml if there are styles
         if (uniqueStyles.size > 0) {
             const stylesArray = Array.from(uniqueStyles.values()).map(({ id, style }) => {
@@ -1695,7 +1734,7 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                 indentBy: '  ',
             });
             const styleXmlContent = styleBuilder.build(styleData);
-            zip.addFile('Settings0/Styles/styles.xml', Buffer.from(styleXmlContent, 'utf8'));
+            zip.file('Settings0/Styles/styles.xml', styleXmlContent, { binary: false });
         }
         // Collect grid file paths for FileMap.xml
         const gridFilePaths = [];
@@ -1778,8 +1817,8 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                                         }
                                     }
                                     const cellData = {
-                                        '@_X': position.x, // Grid3 uses 0-based X coordinates (defaults to 0 when omitted)
-                                        '@_Y': position.y + yOffset, // Grid3 uses 0-based Y coordinates with workspace offset
+                                        '@_X': position.x + 1, // Grid3 uses 1-based X coordinates
+                                        '@_Y': position.y + yOffset + 1, // Grid3 uses 1-based Y coordinates with workspace offset
                                         '@_ColumnSpan': position.columnSpan,
                                         '@_RowSpan': position.rowSpan,
                                         Content: {
@@ -1834,16 +1873,16 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             });
             const xmlContent = builder.build(gridData);
             // Add to zip in Grids folder with proper Grid3 naming
-            const gridPath = `Grids\\${page.name || page.id}\\grid.xml`;
+            const gridPath = `Grids/${page.name || page.id}/grid.xml`;
             gridFilePaths.push(gridPath);
-            zip.addFile(gridPath, Buffer.from(xmlContent, 'utf8'));
+            zip.file(gridPath, xmlContent, { binary: false });
         });
         // Write image files to ZIP
         buttonImages.forEach((imgData) => {
             if (imgData.imageData && imgData.imageData.length > 0) {
                 // Create image path in the grid's directory
-                const imagePath = `Grids\\${imgData.pageName}\\${imgData.x}-${imgData.y}-0-text-0.${imgData.ext}`;
-                zip.addFile(imagePath, imgData.imageData);
+                const imagePath = `Grids/${imgData.pageName}/${imgData.x}-${imgData.y}-0-text-0.${imgData.ext}`;
+                zip.file(imagePath, imgData.imageData);
             }
         });
         // Create FileMap.xml to map all grid files with their dynamic image files
@@ -1854,13 +1893,13 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                 Entries: {
                     Entry: gridFilePaths.map((gridPath) => {
                         // Find all image files for this grid
-                        const gridName = gridPath.match(/Grids\\([^\\]+)\\grid\.xml$/)?.[1] || '';
+                        const gridName = gridPath.match(/Grids\/([^/]+)\/grid\.xml$/)?.[1] || '';
                         const imageFiles = [];
                         // Collect image filenames for buttons on this page
-                        // IMPORTANT: FileMap.xml requires full paths like "Grids\PageName\1-5-0-text-0.png"
+                        // IMPORTANT: FileMap.xml requires full paths like "Grids/PageName/1-5-0-text-0.png"
                         buttonImages.forEach((imgData) => {
                             if (imgData.pageName === gridName && imgData.imageData.length > 0) {
-                                const imagePath = `Grids\\${gridName}\\${imgData.x}-${imgData.y}-0-text-0.${imgData.ext}`;
+                                const imagePath = `Grids/${gridName}/${imgData.x}-${imgData.y}-0-text-0.${imgData.ext}`;
                                 imageFiles.push(imagePath);
                             }
                         });
@@ -1882,9 +1921,11 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
             indentBy: '  ',
         });
         const fileMapXmlContent = fileMapBuilder.build(fileMapData);
-        zip.addFile('FileMap.xml', Buffer.from(fileMapXmlContent, 'utf8'));
+        zip.file('FileMap.xml', fileMapXmlContent, { binary: false });
         // Write the zip file
-        zip.writeZip(outputPath);
+        const zipBuffer = await zip.generateAsync({ type: 'uint8array' });
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        require('fs').writeFileSync(outputPath, zipBuffer);
     }
     // Helper method to calculate column definitions based on page layout
     calculateColumnDefinitions(page) {

package/dist/processors/obfProcessor.d.ts

@@ -2,6 +2,7 @@ import { BaseProcessor, ProcessorOptions, ExtractStringsResult, TranslatedString
 import { AACTree } from '../core/treeStructure';
 import { ValidationResult } from '../validation/validationTypes';
 import { type ButtonForTranslation, type LLMLTranslationResult } from '../utilities/translation/translationProcessor';
+import { ProcessorInput } from '../utils/io';
 declare class ObfProcessor extends BaseProcessor {
     private zipFile?;
     private imageCache;
@@ -16,12 +17,12 @@ declare class ObfProcessor extends BaseProcessor {
     private extractImageAsDataUrl;
     private getMimeTypeFromFilename;
     private processBoard;
-    extractTexts(filePathOrBuffer: string | Buffer): string[];
-    loadIntoTree(filePathOrBuffer: string | Buffer): AACTree;
+    extractTexts(filePathOrBuffer: ProcessorInput): Promise<string[]>;
+    loadIntoTree(filePathOrBuffer: ProcessorInput): Promise<AACTree>;
     private buildGridMetadata;
     private createObfBoardFromPage;
-    processTexts(filePathOrBuffer: string | Buffer, translations: Map<string, string>, outputPath: string): Buffer;
-    saveFromTree(tree: AACTree, outputPath: string): void;
+    processTexts(filePathOrBuffer: ProcessorInput, translations: Map<string, string>, outputPath: string): Promise<Uint8Array>;
+    saveFromTree(tree: AACTree, outputPath: string): Promise<void>;
     /**
      * Extract strings with metadata for aac-tools-platform compatibility
      * Uses the generic implementation from BaseProcessor
@@ -47,7 +48,7 @@ declare class ObfProcessor extends BaseProcessor {
      * @param filePathOrBuffer - Path to OBF/OBZ file or buffer
      * @returns Array of symbol information for LLM processing
      */
-    extractSymbolsForLLM(filePathOrBuffer: string | Buffer): ButtonForTranslation[];
+    extractSymbolsForLLM(filePathOrBuffer: ProcessorInput): Promise<ButtonForTranslation[]>;
     /**
      * Apply LLM translations with symbol information.
      * The LLM should provide translations with symbol attachments in the correct positions.
@@ -60,8 +61,9 @@ declare class ObfProcessor extends BaseProcessor {
      * @param options - Translation options (e.g., allowPartial for testing)
      * @returns Buffer of the translated OBF/OBZ file
      */
-    processLLMTranslations(filePathOrBuffer: string | Buffer, llmTranslations: LLMLTranslationResult[], outputPath: string, options?: {
+    processLLMTranslations(filePathOrBuffer: ProcessorInput, llmTranslations: LLMLTranslationResult[], outputPath: string, options?: {
         allowPartial?: boolean;
-    }): Buffer;
+    }): Promise<Uint8Array>;
+    private getObfValidator;
 }
 export { ObfProcessor };