@willwade/aac-processors 0.1.5 → 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/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
@@ -35,15 +35,14 @@ The demo will open automatically at: http://localhost:3000
 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."
 
-If you need a no-build browser check, use the browser test page served by:
-`node examples/browser-test-server.js`
+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
@@ -57,7 +56,7 @@ If you need a no-build browser check, use the browser test page served by:
 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
 
@@ -67,6 +66,8 @@ If you need a no-build browser check, use the browser test page served by:
 | OPML     | .opml           | OpmlProcessor           |
 | OBF/OBZ  | .obf, .obz      | ObfProcessor            |
 | Gridset  | .gridset        | GridsetProcessor        |
+| Snap     | .sps, .spb      | SnapProcessor           |
+| TouchChat| .ce             | TouchChatProcessor      |
 | Apple    | .plist          | ApplePanelsProcessor    |
 | Asterics | .grd            | AstericsGridProcessor   |
 
@@ -102,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">

package/examples/vitedemo/package-lock.json

@@ -11,6 +11,7 @@
         "@willwade/aac-processors": "file:../..",
         "events": "^3.3.0",
         "jszip": "^3.10.1",
+        "sql.js": "^1.13.0",
         "stream-browserify": "^3.0.0",
         "timers-browserify": "^2.0.12",
         "util": "^0.12.5"
@@ -34,6 +35,7 @@
         "fast-xml-parser": "^5.2.0",
         "jszip": "^3.10.1",
         "plist": "^3.1.0",
+        "sql.js": "^1.13.0",
         "xml2js": "^0.6.2",
         "yauzl": "^3.2.0"
       },
@@ -47,6 +49,7 @@
         "@types/jest": "^29.5.12",
         "@types/node": "^20.11.24",
         "@types/plist": "^3.0.5",
+        "@types/sql.js": "^1.4.9",
         "@typescript-eslint/eslint-plugin": "^7.1.0",
         "@typescript-eslint/parser": "^7.1.0",
         "eslint": "^8.56.0",
@@ -1547,6 +1550,12 @@
         "node": ">=0.10.0"
       }
     },
+    "node_modules/sql.js": {
+      "version": "1.13.0",
+      "resolved": "https://registry.npmjs.org/sql.js/-/sql.js-1.13.0.tgz",
+      "integrity": "sha512-RJbVP1HRDlUUXahJ7VMTcu9Rm1Nzw+EBpoPr94vnbD4LwR715F3CcxE2G2k45PewcaZ57pjetYa+LoSJLAASgA==",
+      "license": "MIT"
+    },
     "node_modules/stream-browserify": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/stream-browserify/-/stream-browserify-3.0.0.tgz",

package/examples/vitedemo/package.json

@@ -16,6 +16,7 @@
     "@willwade/aac-processors": "file:../..",
     "events": "^3.3.0",
     "jszip": "^3.10.1",
+    "sql.js": "^1.13.0",
     "stream-browserify": "^3.0.0",
     "timers-browserify": "^2.0.12",
     "util": "^0.12.5"

package/examples/vitedemo/src/main.ts

@@ -66,12 +66,15 @@ if (typeof (window as any).Buffer === 'undefined') {
 }
 
 import {
+  configureSqlJs,
   getProcessor,
   getSupportedExtensions,
   DotProcessor,
   OpmlProcessor,
   ObfProcessor,
   GridsetProcessor,
+  SnapProcessor,
+  TouchChatProcessor,
   ApplePanelsProcessor,
   AstericsGridProcessor,
   AACTree,
@@ -79,6 +82,12 @@ import {
   AACButton
 } from 'aac-processors';
 
+import sqlWasmUrl from 'sql.js/dist/sql-wasm.wasm?url';
+
+configureSqlJs({
+  locateFile: () => sqlWasmUrl
+});
+
 // UI Elements
 const dropArea = document.getElementById('dropArea') as HTMLElement;
 const fileInput = document.getElementById('fileInput') as HTMLInputElement;
@@ -717,11 +726,15 @@ runTestsBtn.addEventListener('click', async () => {
         const opmlProc = getProcessor('.opml');
         const obfProc = getProcessor('.obf');
         const gridsetProc = getProcessor('.gridset');
+        const snapProc = getProcessor('.sps');
+        const touchChatProc = getProcessor('.ce');
         return (
           dotProc instanceof DotProcessor &&
           opmlProc instanceof OpmlProcessor &&
           obfProc instanceof ObfProcessor &&
-          gridsetProc instanceof GridsetProcessor
+          gridsetProc instanceof GridsetProcessor &&
+          snapProc instanceof SnapProcessor &&
+          touchChatProc instanceof TouchChatProcessor
         );
       }
     },
@@ -729,7 +742,18 @@ runTestsBtn.addEventListener('click', async () => {
       name: 'getSupportedExtensions() returns all extensions',
       fn: async () => {
         const extensions = getSupportedExtensions();
-        const expected = ['.dot', '.opml', '.obf', '.obz', '.gridset', '.plist', '.grd'];
+        const expected = [
+          '.dot',
+          '.opml',
+          '.obf',
+          '.obz',
+          '.gridset',
+          '.spb',
+          '.sps',
+          '.ce',
+          '.plist',
+          '.grd'
+        ];
         return expected.every((ext) => extensions.includes(ext));
       }
     },
@@ -777,6 +801,28 @@ runTestsBtn.addEventListener('click', async () => {
         }
       }
     },
+    {
+      name: 'SnapProcessor instantiation',
+      fn: async () => {
+        try {
+          new SnapProcessor();
+          return true;
+        } catch {
+          return false;
+        }
+      }
+    },
+    {
+      name: 'TouchChatProcessor instantiation',
+      fn: async () => {
+        try {
+          new TouchChatProcessor();
+          return true;
+        } catch {
+          return false;
+        }
+      }
+    },
     {
       name: 'ApplePanelsProcessor instantiation',
       fn: async () => {

package/examples/vitedemo/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "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",
@@ -151,6 +151,7 @@
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.24",
     "@types/plist": "^3.0.5",
+    "@types/sql.js": "^1.4.9",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
     "eslint": "^8.56.0",
@@ -174,6 +175,7 @@
     "fast-xml-parser": "^5.2.0",
     "jszip": "^3.10.1",
     "plist": "^3.1.0",
+    "sql.js": "^1.13.0",
     "xml2js": "^0.6.2",
     "yauzl": "^3.2.0"
   },

package/examples/browser-test-server.js

@@ -1,81 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Simple HTTP server for testing AACProcessors in a browser
- *
- * Usage:
- *   node examples/browser-test-server.js
- *
- * Then open: http://localhost:8080/examples/browser-test.html
- */
-
-const http = require('http');
-const fs = require('fs');
-const path = require('path');
-
-const PORT = 8080;
-const MIME_TYPES = {
-    '.html': 'text/html',
-    '.js': 'text/javascript',
-    '.css': 'text/css',
-    '.json': 'application/json',
-    '.png': 'image/png',
-    '.jpg': 'image/jpg',
-    '.gif': 'image/gif',
-    '.svg': 'image/svg+xml',
-    '.ico': 'image/x-icon',
-};
-
-const server = http.createServer((req, res) => {
-    // Enable CORS
-    res.setHeader('Access-Control-Allow-Origin', '*');
-    res.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');
-    res.setHeader('Access-Control-Allow-Headers', 'Content-Type');
-
-    if (req.method === 'OPTIONS') {
-        res.writeHead(200);
-        res.end();
-        return;
-    }
-
-    // Parse URL
-    let filePath = '.' + req.url;
-    if (filePath === './') {
-        filePath = './examples/browser-test.html';
-    }
-
-    // Get file extension
-    const extname = String(path.extname(filePath)).toLowerCase();
-    const contentType = MIME_TYPES[extname] || 'application/octet-stream';
-
-    // Read and serve file
-    fs.readFile(filePath, (error, content) => {
-        if (error) {
-            if (error.code === 'ENOENT') {
-                res.writeHead(404, { 'Content-Type': 'text/html' });
-                res.end('<h1>404 Not Found</h1>', 'utf-8');
-            } else {
-                res.writeHead(500);
-                res.end(`Server Error: ${error.code}`, 'utf-8');
-            }
-        } else {
-            res.writeHead(200, { 'Content-Type': contentType });
-            res.end(content, 'utf-8');
-        }
-    });
-});
-
-server.listen(PORT, () => {
-    console.log(`
-╔════════════════════════════════════════════════════════════╗
-║   AACProcessors Browser Test Server                       ║
-╠════════════════════════════════════════════════════════════╣
-║                                                            ║
-║   Server running at:                                       ║
-║   🌐 http://localhost:${PORT}/examples/browser-test.html           ║
-║                                                            ║
-║   Press Ctrl+C to stop                                     ║
-║                                                            ║
-╚════════════════════════════════════════════════════════════╝
-    `);
-});