@willwade/aac-processors 0.1.4 → 0.1.6

package/dist/utils/sqlite.js

@@ -0,0 +1,137 @@
+"use strict";
+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.configureSqlJs = configureSqlJs;
+exports.requireBetterSqlite3 = requireBetterSqlite3;
+exports.openSqliteDatabase = openSqliteDatabase;
+const io_1 = require("./io");
+let sqlJsConfig = null;
+let sqlJsPromise = null;
+function configureSqlJs(config) {
+    sqlJsConfig = { ...(sqlJsConfig ?? {}), ...config };
+}
+async function getSqlJs() {
+    if (!sqlJsPromise) {
+        sqlJsPromise = Promise.resolve().then(() => __importStar(require('sql.js'))).then((module) => {
+            const initSqlJs = module.default || module;
+            return initSqlJs(sqlJsConfig ?? {});
+        });
+    }
+    return sqlJsPromise;
+}
+function createSqlJsAdapter(db) {
+    return {
+        prepare(sql) {
+            return {
+                all(...params) {
+                    const stmt = db.prepare(sql);
+                    if (params.length > 0) {
+                        stmt.bind(params);
+                    }
+                    const rows = [];
+                    while (stmt.step()) {
+                        rows.push(stmt.getAsObject());
+                    }
+                    stmt.free();
+                    return rows;
+                },
+                get(...params) {
+                    const stmt = db.prepare(sql);
+                    if (params.length > 0) {
+                        stmt.bind(params);
+                    }
+                    const row = stmt.step() ? stmt.getAsObject() : undefined;
+                    stmt.free();
+                    return row;
+                },
+                run(...params) {
+                    const stmt = db.prepare(sql);
+                    if (params.length > 0) {
+                        stmt.bind(params);
+                    }
+                    stmt.step();
+                    stmt.free();
+                    return undefined;
+                },
+            };
+        },
+        exec(sql) {
+            db.exec(sql);
+        },
+        close() {
+            db.close();
+        },
+    };
+}
+function getBetterSqlite3() {
+    try {
+        const nodeRequire = (0, io_1.getNodeRequire)();
+        return nodeRequire('better-sqlite3');
+    }
+    catch {
+        throw new Error('better-sqlite3 is not available in this environment.');
+    }
+}
+function requireBetterSqlite3() {
+    return getBetterSqlite3();
+}
+async function openSqliteDatabase(input, options = {}) {
+    if (typeof input === 'string') {
+        if (!(0, io_1.isNodeRuntime)()) {
+            throw new Error('SQLite file paths are not supported in browser environments.');
+        }
+        const Database = getBetterSqlite3();
+        const db = new Database(input, { readonly: options.readonly ?? true });
+        return { db };
+    }
+    const data = (0, io_1.readBinaryFromInput)(input);
+    if (!(0, io_1.isNodeRuntime)()) {
+        const SQL = await getSqlJs();
+        const db = new SQL.Database(data);
+        return { db: createSqlJsAdapter(db) };
+    }
+    const fs = (0, io_1.getFs)();
+    const path = (0, io_1.getPath)();
+    const os = (0, io_1.getOs)();
+    const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'aac-sqlite-'));
+    const dbPath = path.join(tempDir, 'input.sqlite');
+    fs.writeFileSync(dbPath, data);
+    const Database = getBetterSqlite3();
+    const db = new Database(dbPath, { readonly: options.readonly ?? true });
+    const cleanup = () => {
+        try {
+            db.close();
+        }
+        finally {
+            try {
+                fs.rmSync(tempDir, { recursive: true, force: true });
+            }
+            catch (error) {
+                console.warn('Failed to clean up temporary SQLite files:', error);
+            }
+        }
+    };
+    return { db, cleanup };
+}

package/dist/utils/zip.d.ts

@@ -0,0 +1,7 @@
+export interface ZipAdapter {
+    listFiles(): string[];
+    readFile(name: string): Promise<Uint8Array>;
+}
+export declare function openZipFromInput(input: string | Uint8Array | ArrayBuffer | Buffer): Promise<{
+    zip: ZipAdapter;
+}>;

package/dist/utils/zip.js

@@ -0,0 +1,80 @@
+"use strict";
+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.openZipFromInput = openZipFromInput;
+const io_1 = require("./io");
+async function openZipFromInput(input) {
+    if (typeof input === 'string') {
+        if (!(0, io_1.isNodeRuntime)()) {
+            throw new Error('Zip file paths are not supported in browser environments.');
+        }
+        const AdmZip = (0, io_1.getNodeRequire)()('adm-zip');
+        const admZip = new AdmZip(input);
+        return {
+            zip: {
+                listFiles: () => admZip.getEntries().map((entry) => entry.entryName),
+                readFile: (name) => {
+                    const entry = admZip.getEntry(name);
+                    if (!entry) {
+                        throw new Error(`Zip entry not found: ${name}`);
+                    }
+                    return Promise.resolve(entry.getData());
+                },
+            },
+        };
+    }
+    const data = (0, io_1.readBinaryFromInput)(input);
+    if ((0, io_1.isNodeRuntime)()) {
+        const AdmZip = (0, io_1.getNodeRequire)()('adm-zip');
+        const admZip = new AdmZip(Buffer.from(data));
+        return {
+            zip: {
+                listFiles: () => admZip.getEntries().map((entry) => entry.entryName),
+                readFile: (name) => {
+                    const entry = admZip.getEntry(name);
+                    if (!entry) {
+                        throw new Error(`Zip entry not found: ${name}`);
+                    }
+                    return Promise.resolve(entry.getData());
+                },
+            },
+        };
+    }
+    const module = await Promise.resolve().then(() => __importStar(require('jszip')));
+    const init = module.default || module;
+    const zip = await init.loadAsync(data);
+    return {
+        zip: {
+            listFiles: () => Object.keys(zip.files),
+            readFile: async (name) => {
+                const file = zip.file(name);
+                if (!file) {
+                    throw new Error(`Zip entry not found: ${name}`);
+                }
+                return file.async('uint8array');
+            },
+        },
+    };
+}

package/dist/validation/gridsetValidator.js

@@ -1,27 +1,4 @@
 "use strict";
-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;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -30,10 +7,25 @@ exports.GridsetValidator = void 0;
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-const xml2js = __importStar(require("xml2js"));
 const jszip_1 = __importDefault(require("jszip"));
 const baseValidator_1 = require("./baseValidator");
 const io_1 = require("../utils/io");
+let cachedXml2js = null;
+function getXml2js() {
+    if (cachedXml2js)
+        return cachedXml2js;
+    try {
+        const nodeRequire = (0, io_1.getNodeRequire)();
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const module = nodeRequire('xml2js');
+        const resolved = module.default || module;
+        cachedXml2js = resolved;
+        return resolved;
+    }
+    catch {
+        throw new Error('Validator requires Xml2js in this environment.');
+    }
+}
 /**
  * Validator for Grid3/Smartbox Gridset files (.gridset, .gridsetx)
  */
@@ -63,6 +55,7 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
         // Try to parse as XML and check for gridset structure
         try {
             const contentStr = Buffer.isBuffer(content) ? content.toString('utf-8') : content;
+            const xml2js = getXml2js();
             const parser = new xml2js.Parser();
             const result = await parser.parseStringPromise(contentStr);
             return result && (result.gridset || result.Gridset);
@@ -115,6 +108,7 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
         let xmlObj = null;
         await this.add_check('xml_parse', 'valid XML', async () => {
             try {
+                const xml2js = getXml2js();
                 const parser = new xml2js.Parser();
                 const contentStr = content.toString('utf-8');
                 xmlObj = await parser.parseStringPromise(contentStr);
@@ -157,6 +151,7 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
             else {
                 try {
                     const gridsetXml = await gridsetEntry.async('string');
+                    const xml2js = getXml2js();
                     const parser = new xml2js.Parser();
                     const xmlObj = await parser.parseStringPromise(gridsetXml);
                     const gridset = xmlObj.gridset || xmlObj.Gridset;
@@ -181,6 +176,7 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
             else {
                 try {
                     const settingsXml = await settingsEntry.async('string');
+                    const xml2js = getXml2js();
                     const parser = new xml2js.Parser();
                     const xmlObj = await parser.parseStringPromise(settingsXml);
                     const settings = xmlObj.GridSetSettings || xmlObj.gridSetSettings || xmlObj.GridsetSettings;

package/dist/validation/obfValidator.js

@@ -1,27 +1,4 @@
 "use strict";
-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;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -34,8 +11,7 @@ exports.ObfValidator = void 0;
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 const jszip_1 = __importDefault(require("jszip"));
 const baseValidator_1 = require("./baseValidator");
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
+const io_1 = require("../utils/io");
 const OBF_FORMAT = 'open-board-0.1';
 const OBF_FORMAT_CURRENT_VERSION = 0.1;
 /**
@@ -50,9 +26,9 @@ class ObfValidator extends baseValidator_1.BaseValidator {
      */
     static async validateFile(filePath) {
         const validator = new ObfValidator();
-        const content = fs.readFileSync(filePath);
-        const stats = fs.statSync(filePath);
-        return validator.validate(content, path.basename(filePath), stats.size);
+        const content = (0, io_1.readBinaryFromInput)(filePath);
+        const stats = (0, io_1.getFs)().statSync(filePath);
+        return validator.validate(content, (0, io_1.getPath)().basename(filePath), stats.size);
     }
     /**
      * Check if content is OBF format

package/docs/BROWSER_USAGE.md

@@ -565,14 +565,7 @@ async function safeLoadFile(file) {
 
 ## Testing
 
-See [Browser Test Page](../examples/browser-test.html) for interactive testing.
-
-To run the test server:
-```bash
-node examples/browser-test-server.js
-```
-
-Then open: http://localhost:8080/examples/browser-test.html
+Use the Vite demo in `examples/vitedemo` for interactive browser testing.
 
 ## Troubleshooting
 
@@ -614,5 +607,4 @@ await processor.loadIntoTree(uint8Array);
 
 - [API Documentation](./API.md)
 - [Examples](../examples/)
-- [Browser Test Page](../examples/browser-test.html)
-- [Test Server](../examples/browser-test-server.js)
+- [Vite Browser Demo](../examples/vitedemo)

package/examples/README.md

@@ -49,79 +49,7 @@ These pagesets are used by:
 
 To run demo scripts that use these pagesets, see the [scripts/README.md](../scripts/README.md).
 
-## Browser Testing
+## Browser Demo (Vite)
 
-### ⚠️ Important Note
-
-AACProcessors is built with TypeScript and outputs CommonJS modules. To use it in a browser, you **must use a bundler** (Vite, Webpack, Rollup, etc.). The browser test page below only validates the library structure - it cannot run actual processors without a bundler.
-
-### Browser Test Page
-
-A dedicated browser test page is available for validating the library structure:
-
-**Start the test server:**
-```bash
-node examples/browser-test-server.js
-```
-
-**Open in your browser:**
-```
-http://localhost:8080/examples/browser-test.html
-```
-
-**What it tests:**
-- ✅ Browser build files exist and are accessible
-- ✅ Type definitions are present
-- ✅ Processor exports are available
-- ❌ **Does NOT run actual processors** (requires bundler)
-
-### What Gets Tested
-
-The browser test page (`browser-test.html`) verifies:
-
-1. **Module Loading** - Can the browser load the ES modules?
-2. **Factory Functions** - Do `getProcessor()` and `getSupportedExtensions()` work?
-3. **Processor Instantiation** - Can processors be created?
-4. **File Loading** - Can files be loaded from `<input type="file">`?
-5. **Buffer Handling** - Do ArrayBuffers/Uint8Arrays work correctly?
-6. **Tree Structure** - Can AACTree be created from files?
-7. **Text Extraction** - Can texts be extracted from files?
-
-### Supported File Types in Browser
-
-The browser test page supports all browser-compatible processors:
-
-- **DotProcessor** (.dot) - OpenSymbols Board files
-- **OpmlProcessor** (.opml) - OPML outline files
-- **ObfProcessor** (.obf/.obz) - Open Board Format files
-- **GridsetProcessor** (.gridset) - Grid 3 gridset files (not .gridsetx)
-- **ApplePanelsProcessor** (.plist) - Apple Panels files
-- **AstericsGridProcessor** (.grd) - Asterics Grid files
-
-### Manual Testing
-
-1. Open the browser console (F12 or Cmd+Option+I)
-2. Click "Select a file to test" to upload an AAC file
-3. Click "Test File" to process it
-4. Check the results panel for page count, button count, and extracted texts
-
-### Automated Tests
-
-Click "Run All Browser Tests" to run automated checks:
-- Factory function tests
-- Extension support tests
-- Processor instantiation tests
-- Buffer handling tests
-
-### Node-Only Processors
-
-The following processors are **not available** in the browser:
-- **SnapProcessor** (.spb/.sps) - Requires SQLite
-- **TouchChatProcessor** (.ce) - Requires SQLite
-- **ExcelProcessor** (.xlsx) - Uses fs at top level
-
-### Notes
-
-- Gridset `.gridsetx` files (encrypted) are not supported in browser
-- All processors work with Buffer, Uint8Array, and ArrayBuffer inputs
-- File paths are not supported in browser (use file inputs or fetch)
+For browser testing, use the Vite demo in `examples/vitedemo`. It bundles the
+library and exercises real processors in a browser environment.

package/examples/vitedemo/README.md

@@ -5,7 +5,7 @@ A real browser demo that uses Vite to bundle AACProcessors for browser use.
 ## Features
 
 - ✅ **Real file processing** - Upload and process actual AAC files
-- ✅ **All browser-compatible processors** - Tests Dot, OPML, OBF/OBZ, Gridset, ApplePanels, AstericsGrid
+- ✅ **All browser-compatible processors** - Tests Dot, OPML, OBF/OBZ, Gridset, Snap, TouchChat, ApplePanels, AstericsGrid
 - ✅ **Interactive UI** - Drag & drop files, view pages and buttons
 - ✅ **Text-to-speech** - Click SPEAK buttons to hear messages (browser speech API)
 - ✅ **Navigation** - Click NAVIGATE buttons to jump between pages
@@ -30,19 +30,19 @@ npm run dev
 
 The demo will open automatically at: http://localhost:3000
 
-### 3. Build for Production
+### 3. Build for Production (Not Supported Yet)
 
-```bash
-npm run build
-npm run preview
-```
+This demo is intended for `npm run dev` only. The production build currently fails because the
+demo source includes strict TypeScript issues, so it will not work "out of the box."
+
+This demo is the recommended browser test environment.
 
 ## How to Use
 
 1. **Upload a file**
    - Drag & drop an AAC file onto the upload area
    - Or click to open file picker
-   - Supported formats: .dot, .opml, .obf, .obz, .gridset, .plist, .grd
+   - Supported formats: .dot, .opml, .obf, .obz, .gridset, .sps, .spb, .ce, .plist, .grd
 
 2. **Process the file**
    - Click "Process File" button
@@ -56,7 +56,7 @@ npm run preview
 4. **Run compatibility tests**
    - Click "Run Compatibility Tests"
    - See test results in the left panel
-   - Tests all 6 browser-compatible processors
+   - Tests all browser-compatible processors
 
 ## Supported File Types
 
@@ -66,6 +66,8 @@ npm run preview
 | OPML     | .opml           | OpmlProcessor           |
 | OBF/OBZ  | .obf, .obz      | ObfProcessor            |
 | Gridset  | .gridset        | GridsetProcessor        |
+| Snap     | .sps, .spb      | SnapProcessor           |
+| TouchChat| .ce             | TouchChatProcessor      |
 | Apple    | .plist          | ApplePanelsProcessor    |
 | Asterics | .grd            | AstericsGridProcessor   |
 
@@ -101,10 +103,15 @@ export default defineConfig({
 
 This allows direct TypeScript import without pre-building.
 
-### Import Example
+### Import Example (with SQLite WASM)
 
 ```typescript
-import { getProcessor } from 'aac-processors';
+import { configureSqlJs, getProcessor } from 'aac-processors';
+import sqlWasmUrl from 'sql.js/dist/sql-wasm.wasm?url';
+
+configureSqlJs({
+  locateFile: () => sqlWasmUrl
+});
 
 // Get processor for file type
 const processor = getProcessor('.obf');

package/examples/vitedemo/index.html

@@ -423,11 +423,11 @@
                     <div class="upload-icon">📤</div>
                     <p><strong>Drop file here</strong> or click to upload</p>
                     <p style="font-size: 12px; color: #999; margin-top: 5px;">
-                        Supports: .dot, .opml, .obf, .obz, .gridset, .plist, .grd
+                        Supports: .dot, .opml, .obf, .obz, .gridset, .sps, .spb, .ce, .plist, .grd
                     </p>
                 </div>
 
-                <input type="file" id="fileInput" accept=".dot,.opml,.obf,.obz,.gridset,.plist,.grd">
+                <input type="file" id="fileInput" accept=".dot,.opml,.obf,.obz,.gridset,.sps,.spb,.ce,.plist,.grd">
 
                 <div id="fileInfo" style="display: none;">
                     <div class="processor-info">