@willwade/aac-processors 0.1.20 → 0.1.21

package/dist/browser/processors/gridset/symbols.js

@@ -12,7 +12,8 @@
  *
  * This module provides symbol resolution and metadata extraction.
  */
-import { getFs, getNodeRequire, getPath } from '../../utils/io';
+import { defaultFileAdapter } from '../../utils/io';
+import { getZipAdapter } from '../../utils/zip';
 /**
  * Default Grid 3 installation paths by platform
  */
@@ -55,38 +56,6 @@ export const SYMBOL_LIBRARIES = {
  * Default locale to use
  */
 export const DEFAULT_LOCALE = 'en-GB';
-function getNodeFs() {
-    try {
-        return getFs();
-    }
-    catch {
-        throw new Error('Symbol library access is not available in this environment.');
-    }
-}
-function getNodePath() {
-    try {
-        return getPath();
-    }
-    catch {
-        throw new Error('Path utilities are not available in this environment.');
-    }
-}
-let cachedAdmZip = null;
-function getAdmZip() {
-    if (cachedAdmZip)
-        return cachedAdmZip;
-    try {
-        const nodeRequire = getNodeRequire();
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const module = nodeRequire('adm-zip');
-        const resolved = module.default || module;
-        cachedAdmZip = resolved;
-        return resolved;
-    }
-    catch {
-        throw new Error('Symbol library access requires AdmZip in this environment.');
-    }
-}
 /**
  * Parse a symbol reference string
  * @param reference - Symbol reference like "[widgit]/food/apple.png"
@@ -124,12 +93,12 @@ export function isSymbolReference(reference) {
  * Get the default Grid 3 installation path for the current platform
  * @returns Default Grid 3 path or empty string if not found
  */
-export function getDefaultGrid3Path() {
+export function getDefaultGrid3Path(fileAdapter) {
+    const { pathExists } = fileAdapter ?? defaultFileAdapter;
     const platform = (typeof process !== 'undefined' && process.platform ? process.platform : 'unknown');
     const defaultPath = DEFAULT_GRID3_PATHS[platform] || '';
     try {
-        const fs = getNodeFs();
-        if (defaultPath && fs.existsSync(defaultPath)) {
+        if (defaultPath && pathExists(defaultPath)) {
             return defaultPath;
         }
         // Try to find Grid 3 in common locations
@@ -141,7 +110,7 @@ export function getDefaultGrid3Path() {
             '/opt/smartbox/grid3',
         ];
         for (const testPath of commonPaths) {
-            if (fs.existsSync(testPath)) {
+            if (pathExists(testPath)) {
                 return testPath;
             }
         }
@@ -157,9 +126,9 @@ export function getDefaultGrid3Path() {
  * @param grid3Path - Grid 3 installation path
  * @returns Path to Symbol Libraries directory (e.g., "C:\...\Grid 3\Resources\Symbols")
  */
-export function getSymbolLibrariesDir(grid3Path) {
-    const path = getNodePath();
-    return path.join(grid3Path, SYMBOLS_SUBDIR);
+export function getSymbolLibrariesDir(grid3Path, fileAdapter = defaultFileAdapter) {
+    const { join } = fileAdapter;
+    return join(grid3Path, SYMBOLS_SUBDIR);
 }
 /**
  * Get the symbol search indexes directory path for a given locale
@@ -168,38 +137,37 @@ export function getSymbolLibrariesDir(grid3Path) {
  * @param locale - Locale code (e.g., 'en-GB')
  * @returns Path to symbol search indexes directory (e.g., "C:\...\Grid 3\Locale\en-GB\symbolsearch")
  */
-export function getSymbolSearchIndexesDir(grid3Path, locale = DEFAULT_LOCALE) {
-    const path = getNodePath();
-    return path.join(grid3Path, SYMBOLSEARCH_SUBDIR, locale, 'symbolsearch');
+export function getSymbolSearchIndexesDir(grid3Path, locale = DEFAULT_LOCALE, fileAdapter = defaultFileAdapter) {
+    const { join } = fileAdapter;
+    return join(grid3Path, SYMBOLSEARCH_SUBDIR, locale, 'symbolsearch');
 }
 /**
  * Get all available symbol libraries in the Grid 3 installation
  * @param options - Resolution options
  * @returns Array of symbol library information
  */
-export function getAvailableSymbolLibraries(options = {}) {
+export function getAvailableSymbolLibraries(options = {}, fileAdapter) {
+    const { pathExists, getFileSize, listDir, join, basename } = fileAdapter ?? defaultFileAdapter;
     const grid3Path = options.grid3Path || options.symbolDir || getDefaultGrid3Path();
     if (!grid3Path) {
         return [];
     }
-    const symbolsDir = getSymbolLibrariesDir(grid3Path);
-    const fs = getNodeFs();
-    if (!fs.existsSync(symbolsDir)) {
+    const symbolsDir = getSymbolLibrariesDir(grid3Path, fileAdapter);
+    if (!pathExists(symbolsDir)) {
         return [];
     }
     const libraries = [];
-    const files = fs.readdirSync(symbolsDir);
+    const files = listDir(symbolsDir);
     for (const file of files) {
         if (file.endsWith('.symbols')) {
-            const path = getNodePath();
-            const fullPath = path.join(symbolsDir, file);
-            const stats = fs.statSync(fullPath);
-            const libraryName = path.basename(file, '.symbols');
+            const fullPath = join(symbolsDir, file);
+            const size = getFileSize(fullPath);
+            const libraryName = basename(file, '.symbols');
             libraries.push({
                 name: libraryName,
                 pixFile: fullPath, // Reuse this field for the .symbols file path
                 exists: true,
-                size: stats.size,
+                size,
                 locale: 'global', // .symbols files are not locale-specific
             });
         }
@@ -212,12 +180,13 @@ export function getAvailableSymbolLibraries(options = {}) {
  * @param options - Resolution options
  * @returns Symbol library info or undefined if not found
  */
-export function getSymbolLibraryInfo(libraryName, options = {}) {
+export function getSymbolLibraryInfo(libraryName, options = {}, fileAdapter) {
+    const { pathExists, getFileSize, join } = fileAdapter ?? defaultFileAdapter;
     const grid3Path = options.grid3Path || options.symbolDir || getDefaultGrid3Path();
     if (!grid3Path) {
         return undefined;
     }
-    const symbolsDir = getSymbolLibrariesDir(grid3Path);
+    const symbolsDir = getSymbolLibrariesDir(grid3Path, fileAdapter);
     const normalizedLibName = libraryName.toLowerCase();
     // Try different case variations
     const variations = [
@@ -226,16 +195,14 @@ export function getSymbolLibraryInfo(libraryName, options = {}) {
         libraryName + '.symbols',
     ];
     for (const file of variations) {
-        const path = getNodePath();
-        const fullPath = path.join(symbolsDir, file);
-        const fs = getNodeFs();
-        if (fs.existsSync(fullPath)) {
-            const stats = fs.statSync(fullPath);
+        const fullPath = join(symbolsDir, file);
+        if (pathExists(fullPath)) {
+            const size = getFileSize(fullPath);
             return {
                 name: libraryName,
                 pixFile: fullPath,
                 exists: true,
-                size: stats.size,
+                size,
                 locale: 'global',
             };
         }
@@ -248,7 +215,7 @@ export function getSymbolLibraryInfo(libraryName, options = {}) {
  * @param options - Resolution options
  * @returns Resolution result with image data if found
  */
-export function resolveSymbolReference(reference, options = {}) {
+export async function resolveSymbolReference(reference, options = {}, fileAdapter = defaultFileAdapter, zipAdapter) {
     const parsed = parseSymbolReference(reference);
     if (!parsed.isValid) {
         return {
@@ -275,16 +242,16 @@ export function resolveSymbolReference(reference, options = {}) {
     }
     try {
         // .symbols files are ZIP archives
-        const AdmZip = getAdmZip();
-        const zip = new AdmZip(libraryInfo.pixFile);
+        const zipFile = libraryInfo.pixFile;
+        const zip = zipAdapter ? await zipAdapter(zipFile) : await getZipAdapter(zipFile, fileAdapter);
         // The path in the symbol reference becomes the path within the symbols/ folder
         // e.g., [tawasl]/above bw.png becomes symbols/above bw.png
         const symbolPath = `symbols/${parsed.path}`;
-        const entry = zip.getEntry(symbolPath);
+        const entry = await zip.readFile(symbolPath);
         if (!entry) {
             // Try without the symbols/ prefix (in case reference already includes it)
             const altPath = parsed.path.startsWith('symbols/') ? parsed.path : `symbols/${parsed.path}`;
-            const altEntry = zip.getEntry(altPath);
+            const altEntry = await zip.readFile(altPath);
             if (!altEntry) {
                 return {
                     reference: parsed,
@@ -295,7 +262,7 @@ export function resolveSymbolReference(reference, options = {}) {
                 };
             }
             // Found with alternate path
-            const data = altEntry.getData();
+            const data = Buffer.from(altEntry);
             return {
                 reference: parsed,
                 found: true,
@@ -305,7 +272,7 @@ export function resolveSymbolReference(reference, options = {}) {
             };
         }
         // Found the symbol!
-        const data = entry.getData();
+        const data = Buffer.from(entry);
         return {
             reference: parsed,
             found: true,

package/dist/browser/processors/gridsetProcessor.js

@@ -13,8 +13,7 @@ import { parseSymbolReference } from './gridset/symbols';
 import { isSymbolLibraryReference } from './gridset/resolver';
 import { generateCloneId } from '../utilities/analytics/utils/idGenerator';
 import { translateWithSymbols, extractSymbolsFromButton } from './gridset/symbolAlignment';
-import { readBinaryFromInput, decodeText, writeBinaryToPath, getNodeRequire, isNodeRuntime, } from '../utils/io';
-import { openZipFromInput } from '../utils/zip';
+import { decodeText } from '../utils/io';
 class GridsetProcessor extends BaseProcessor {
     constructor(options) {
         super(options);
@@ -395,19 +394,18 @@ class GridsetProcessor extends BaseProcessor {
         return texts;
     }
     async loadIntoTree(filePathOrBuffer) {
+        const { readBinaryFromInput } = this.options.fileAdapter;
         const tree = new AACTree();
         let zipResult;
         try {
             const zipInput = readBinaryFromInput(filePathOrBuffer);
-            zipResult = this.options.zipAdapter
-                ? await this.options.zipAdapter(zipInput)
-                : await openZipFromInput(zipInput);
+            zipResult = await this.options.zipAdapter(zipInput);
         }
         catch (error) {
             throw new Error(`Invalid ZIP file format: ${error.message}`);
         }
         const password = this.getGridsetPassword(filePathOrBuffer);
-        const entries = getZipEntriesFromAdapter(zipResult.zip, password);
+        const entries = getZipEntriesFromAdapter(zipResult, password);
         const options = {
             ignoreAttributes: false,
             ignoreDeclaration: true,
@@ -1683,6 +1681,7 @@ class GridsetProcessor extends BaseProcessor {
         return tree;
     }
     async processTexts(filePathOrBuffer, translations, outputPath) {
+        const { readBinaryFromInput } = this.options.fileAdapter;
         // Load the tree, apply translations, and save to new file
         const tree = await this.loadIntoTree(filePathOrBuffer);
         // Apply translations to all text content
@@ -1785,6 +1784,7 @@ class GridsetProcessor extends BaseProcessor {
      * @returns Buffer of the translated gridset
      */
     async processLLMTranslations(filePathOrBuffer, llmTranslations, outputPath, options) {
+        const { readBinaryFromInput } = this.options.fileAdapter;
         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));
@@ -1826,36 +1826,12 @@ class GridsetProcessor extends BaseProcessor {
         return readBinaryFromInput(outputPath);
     }
     async saveFromTree(tree, outputPath) {
-        const useNodeZip = isNodeRuntime();
-        let addText;
-        let addBinary;
-        let finalizeZip;
-        if (useNodeZip) {
-            const AdmZip = getNodeRequire()('adm-zip');
-            const zip = new AdmZip();
-            addText = (entryPath, content) => {
-                zip.addFile(entryPath, Buffer.from(content, 'utf8'));
-            };
-            addBinary = (entryPath, content) => {
-                zip.addFile(entryPath, Buffer.from(content));
-            };
-            finalizeZip = () => Promise.resolve(zip.toBuffer());
-        }
-        else {
-            const module = await import('jszip');
-            const JSZip = module.default || module;
-            const zip = new JSZip();
-            addText = (entryPath, content) => {
-                zip.file(entryPath, content, { binary: false });
-            };
-            addBinary = (entryPath, content) => {
-                zip.file(entryPath, content);
-            };
-            finalizeZip = async () => zip.generateAsync({ type: 'uint8array' });
-        }
+        const files = [];
+        const { writeBinaryToPath } = this.options.fileAdapter;
+        const zip = await this.options.zipAdapter();
         if (Object.keys(tree.pages).length === 0) {
             // Create empty zip for empty tree
-            const zipBuffer = await finalizeZip();
+            const zipBuffer = await zip.writeFiles([]);
             writeBinaryToPath(outputPath, zipBuffer);
             return;
         }
@@ -1928,7 +1904,10 @@ class GridsetProcessor extends BaseProcessor {
             suppressEmptyNode: true,
         });
         const settingsXmlContent = settingsBuilder.build(settingsData);
-        addText('Settings0/settings.xml', settingsXmlContent);
+        files.push({
+            name: 'Settings0/settings.xml',
+            data: settingsXmlContent,
+        });
         // Create Settings0/Styles/style.xml if there are styles
         if (uniqueStyles.size > 0) {
             const stylesArray = Array.from(uniqueStyles.values()).map(({ id, style }) => {
@@ -1961,7 +1940,10 @@ class GridsetProcessor extends BaseProcessor {
                 indentBy: '  ',
             });
             const styleXmlContent = styleBuilder.build(styleData);
-            addText('Settings0/Styles/styles.xml', styleXmlContent);
+            files.push({
+                name: 'Settings0/Styles/styles.xml',
+                data: styleXmlContent,
+            });
         }
         // Collect grid file paths for FileMap.xml
         const gridFilePaths = [];
@@ -2102,14 +2084,20 @@ class GridsetProcessor extends BaseProcessor {
             // Add to zip in Grids folder with proper Grid3 naming
             const gridPath = `Grids/${page.name || page.id}/grid.xml`;
             gridFilePaths.push(gridPath);
-            addText(gridPath, xmlContent);
+            files.push({
+                name: gridPath,
+                data: xmlContent,
+            });
         });
         // 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}`;
-                addBinary(imagePath, imgData.imageData);
+                files.push({
+                    name: imagePath,
+                    data: imgData.imageData,
+                });
             }
         });
         // Create FileMap.xml to map all grid files with their dynamic image files
@@ -2148,9 +2136,12 @@ class GridsetProcessor extends BaseProcessor {
             indentBy: '  ',
         });
         const fileMapXmlContent = fileMapBuilder.build(fileMapData);
-        addText('FileMap.xml', fileMapXmlContent);
+        files.push({
+            name: 'FileMap.xml',
+            data: fileMapXmlContent,
+        });
         // Write the zip file
-        const zipBuffer = await finalizeZip();
+        const zipBuffer = await zip.writeFiles(files);
         writeBinaryToPath(outputPath, zipBuffer);
     }
     // Helper method to calculate column definitions based on page layout
@@ -2248,7 +2239,7 @@ class GridsetProcessor extends BaseProcessor {
      * @returns Promise with validation result
      */
     async validate(filePath) {
-        return GridsetValidator.validateFile(filePath);
+        return GridsetValidator.validateFile(filePath, this.options.fileAdapter);
     }
 }
 export { GridsetProcessor };

package/dist/browser/processors/obfProcessor.js

@@ -2,8 +2,8 @@ import { BaseProcessor, } from '../core/baseProcessor';
 import { AACTree, AACPage, AACButton, AACSemanticCategory, AACSemanticIntent, } from '../core/treeStructure';
 import { generateCloneId } from '../utilities/analytics/utils/idGenerator';
 import { extractAllButtonsForTranslation, validateTranslationResults, } from '../utilities/translation/translationProcessor';
-import { readBinaryFromInput, readTextFromInput, writeTextToPath, encodeBase64, decodeText, getNodeRequire, isNodeRuntime, } from '../utils/io';
-import { openZipFromInput } from '../utils/zip';
+import { encodeBase64, decodeText } from '../utils/io';
+import { getZipAdapter } from '../utils/zip';
 const OBF_FORMAT_VERSION = 'open-board-0.1';
 /**
  * Map OBF hidden value to AAC standard visibility
@@ -283,6 +283,7 @@ class ObfProcessor extends BaseProcessor {
         return texts;
     }
     async loadIntoTree(filePathOrBuffer) {
+        const { readBinaryFromInput, readTextFromInput } = this.options.fileAdapter;
         // Detailed logging for debugging input
         const bufferLength = typeof filePathOrBuffer === 'string'
             ? null
@@ -380,10 +381,7 @@ class ObfProcessor extends BaseProcessor {
             return tree;
         }
         try {
-            const zipResult = this.options.zipAdapter
-                ? await this.options.zipAdapter(filePathOrBuffer)
-                : await openZipFromInput(filePathOrBuffer);
-            this.zipFile = zipResult.zip;
+            this.zipFile = await this.options.zipAdapter(filePathOrBuffer);
         }
         catch (err) {
             console.error('[OBF] Error loading ZIP:', err);
@@ -539,6 +537,7 @@ class ObfProcessor extends BaseProcessor {
         };
     }
     async processTexts(filePathOrBuffer, translations, outputPath) {
+        const { readBinaryFromInput } = this.options.fileAdapter;
         // Load the tree, apply translations, and save to new file
         const tree = await this.loadIntoTree(filePathOrBuffer);
         // Apply translations to all text content
@@ -571,6 +570,7 @@ class ObfProcessor extends BaseProcessor {
         return readBinaryFromInput(outputPath);
     }
     async saveFromTree(tree, outputPath) {
+        const { writeTextToPath, writeBinaryToPath } = 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];
@@ -581,32 +581,18 @@ class ObfProcessor extends BaseProcessor {
             writeTextToPath(outputPath, JSON.stringify(obfBoard, null, 2));
         }
         else {
-            // Save as OBZ (zip with multiple OBF files)
-            if (isNodeRuntime()) {
-                const AdmZip = getNodeRequire()('adm-zip');
-                const zip = new AdmZip();
-                Object.values(tree.pages).forEach((page) => {
-                    const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata);
-                    const obfContent = JSON.stringify(obfBoard, null, 2);
-                    zip.addFile(`${page.id}.obf`, Buffer.from(obfContent, 'utf8'));
-                });
-                const zipBuffer = zip.toBuffer();
-                const { writeBinaryToPath } = await import('../utils/io');
-                writeBinaryToPath(outputPath, zipBuffer);
-            }
-            else {
-                const module = await import('jszip');
-                const JSZip = module.default || module;
-                const zip = new JSZip();
-                Object.values(tree.pages).forEach((page) => {
-                    const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata);
-                    const obfContent = JSON.stringify(obfBoard, null, 2);
-                    zip.file(`${page.id}.obf`, obfContent);
-                });
-                const zipBuffer = await zip.generateAsync({ type: 'uint8array' });
-                const { writeBinaryToPath } = await import('../utils/io');
-                writeBinaryToPath(outputPath, zipBuffer);
-            }
+            const files = Object.values(tree.pages).map((page) => {
+                const obfBoard = this.createObfBoardFromPage(page, 'Board', tree.metadata);
+                const obfContent = JSON.stringify(obfBoard, null, 2);
+                const name = page.id.endsWith('.obf') ? page.id : `${page.id}.obf`;
+                return {
+                    name,
+                    data: new TextEncoder().encode(obfContent),
+                };
+            });
+            const zip = await getZipAdapter(undefined, this.options.fileAdapter);
+            const zipData = await zip.writeFiles(files);
+            writeBinaryToPath(outputPath, zipData);
         }
     }
     /**
@@ -630,7 +616,7 @@ class ObfProcessor extends BaseProcessor {
      */
     async validate(filePath) {
         const ObfValidator = this.getObfValidator();
-        return ObfValidator.validateFile(filePath);
+        return ObfValidator.validateFile(filePath, this.options.fileAdapter);
     }
     /**
      * Extract symbol information from an OBF/OBZ file for LLM-based translation.
@@ -672,6 +658,7 @@ class ObfProcessor extends BaseProcessor {
      * @returns Buffer of the translated OBF/OBZ file
      */
     async processLLMTranslations(filePathOrBuffer, llmTranslations, outputPath, options) {
+        const { readBinaryFromInput } = this.options.fileAdapter;
         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));

package/dist/browser/processors/opmlProcessor.js

@@ -1,9 +1,8 @@
 import { BaseProcessor, } from '../core/baseProcessor';
 import { AACTree, AACPage, AACButton, AACSemanticIntent } from '../core/treeStructure';
-// Removed unused import: FileProcessor
 import { XMLParser, XMLValidator, XMLBuilder } from 'fast-xml-parser';
 import { ValidationFailureError, buildValidationResultFromMessage, } from '../validation/validationTypes';
-import { getBasename, readBinaryFromInput, readTextFromInput, writeBinaryToPath, writeTextToPath, encodeText, } from '../utils/io';
+import { getBasename, encodeText } from '../utils/io';
 class OpmlProcessor extends BaseProcessor {
     constructor(options) {
         super(options);
@@ -50,6 +49,7 @@ class OpmlProcessor extends BaseProcessor {
         return { page, childPages };
     }
     async extractTexts(filePathOrBuffer) {
+        const { readTextFromInput } = this.options.fileAdapter;
         await Promise.resolve();
         const content = readTextFromInput(filePathOrBuffer);
         const parser = new XMLParser({ ignoreAttributes: false });
@@ -82,6 +82,7 @@ class OpmlProcessor extends BaseProcessor {
         return texts;
     }
     async loadIntoTree(filePathOrBuffer) {
+        const { readBinaryFromInput, readTextFromInput } = this.options.fileAdapter;
         await Promise.resolve();
         const filename = typeof filePathOrBuffer === 'string' ? getBasename(filePathOrBuffer) : 'upload.opml';
         const buffer = readBinaryFromInput(filePathOrBuffer);
@@ -168,6 +169,7 @@ class OpmlProcessor extends BaseProcessor {
         }
     }
     async processTexts(filePathOrBuffer, translations, outputPath) {
+        const { writeBinaryToPath, readTextFromInput } = this.options.fileAdapter;
         await Promise.resolve();
         const content = readTextFromInput(filePathOrBuffer);
         let translatedContent = content;
@@ -184,6 +186,7 @@ class OpmlProcessor extends BaseProcessor {
         return resultBuffer;
     }
     async saveFromTree(tree, outputPath) {
+        const { writeTextToPath } = this.options.fileAdapter;
         await Promise.resolve();
         // Helper to recursively build outline nodes with cycle detection
         function buildOutline(page, visited = new Set()) {