@willwade/aac-processors 0.2.1 → 0.2.3

package/README.md

@@ -31,7 +31,9 @@ Browser-safe entry that avoids Node-only dependencies. It expects `Buffer`,
 `Uint8Array`, or `ArrayBuffer` inputs rather than file paths.
 
 SQLite-backed formats (Snap `.sps/.spb` and TouchChat `.ce`) require a WASM
-SQLite engine. Configure `sql.js` in your bundler before loading those formats:
+SQLite engine. To support these, configure `sql.js` in your bundler
+and either include `<script src="sql-wasm.js"></script>` in your HTML, or
+`window.initSqlJs = require('sql.js');` in your app.
 
 ```ts
 import { configureSqlJs, SnapProcessor } from '@willwade/aac-processors/browser';

package/dist/browser/processors/obfProcessor.js

@@ -587,15 +587,29 @@ class ObfProcessor extends BaseProcessor {
             await writeTextToPath(outputPath, JSON.stringify(obfBoard, null, 2));
         }
         else {
+            const getPageFilename = (id) => (id.endsWith('.obf') ? id : `${id}.obf`);
             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`;
+                const name = getPageFilename(page.id);
                 return {
                     name,
                     data: new TextEncoder().encode(obfContent),
                 };
             });
+            const manifest = {
+                format: OBF_FORMAT_VERSION,
+                root: tree.metadata.defaultHomePageId,
+                paths: {
+                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [id, getPageFilename(page.id)])),
+                    images: {}, //TODO Add support for saving images as files
+                    sounds: {}, //TODO Add support for saving sounds as files
+                },
+            };
+            files.push({
+                name: 'manifest.json',
+                data: new TextEncoder().encode(JSON.stringify(manifest)),
+            });
             const fileExists = await pathExists(outputPath);
             this.zipFile = await this.options.zipAdapter(fileExists ? outputPath : undefined, this.options.fileAdapter);
             const zipData = await this.zipFile.writeFiles(files);

package/dist/browser/utils/sqlite.js

@@ -4,12 +4,16 @@ let sqlJsPromise = null;
 export function configureSqlJs(config) {
     sqlJsConfig = { ...(sqlJsConfig ?? {}), ...config };
 }
-async function getSqlJs() {
+async function getSqlJsBrowser() {
     if (!sqlJsPromise) {
-        sqlJsPromise = import('sql.js').then((module) => {
-            const initSqlJs = module.default || module;
-            return initSqlJs(sqlJsConfig ?? {});
-        });
+        const isBrowser = typeof globalThis !== 'undefined' && globalThis.window !== undefined;
+        if (!isBrowser)
+            throw new Error('Must be run in a browser');
+        const window = globalThis.window;
+        if (!('initSqlJs' in window))
+            throw new Error('Need to add sql-wasm.js script element to DOM');
+        const initSqlJs = window.initSqlJs;
+        sqlJsPromise = initSqlJs(sqlJsConfig ?? {});
     }
     return sqlJsPromise;
 }
@@ -81,7 +85,7 @@ export async function openSqliteDatabase(input, options = {}) {
     }
     const data = await readBinaryFromInput(input);
     if (!isNodeRuntime()) {
-        const SQL = await getSqlJs();
+        const SQL = await getSqlJsBrowser();
         const db = new SQL.Database(data);
         return { db: createSqlJsAdapter(db) };
     }

package/dist/processors/obfProcessor.js

@@ -590,15 +590,29 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
             await writeTextToPath(outputPath, JSON.stringify(obfBoard, null, 2));
         }
         else {
+            const getPageFilename = (id) => (id.endsWith('.obf') ? id : `${id}.obf`);
             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`;
+                const name = getPageFilename(page.id);
                 return {
                     name,
                     data: new TextEncoder().encode(obfContent),
                 };
             });
+            const manifest = {
+                format: OBF_FORMAT_VERSION,
+                root: tree.metadata.defaultHomePageId,
+                paths: {
+                    boards: Object.fromEntries(Object.entries(tree.pages).map(([id, page]) => [id, getPageFilename(page.id)])),
+                    images: {}, //TODO Add support for saving images as files
+                    sounds: {}, //TODO Add support for saving sounds as files
+                },
+            };
+            files.push({
+                name: 'manifest.json',
+                data: new TextEncoder().encode(JSON.stringify(manifest)),
+            });
             const fileExists = await pathExists(outputPath);
             this.zipFile = await this.options.zipAdapter(fileExists ? outputPath : undefined, this.options.fileAdapter);
             const zipData = await this.zipFile.writeFiles(files);

package/dist/utils/sqlite.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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configureSqlJs = configureSqlJs;
 exports.requireBetterSqlite3 = requireBetterSqlite3;
@@ -32,12 +9,16 @@ let sqlJsPromise = null;
 function configureSqlJs(config) {
     sqlJsConfig = { ...(sqlJsConfig ?? {}), ...config };
 }
-async function getSqlJs() {
+async function getSqlJsBrowser() {
     if (!sqlJsPromise) {
-        sqlJsPromise = Promise.resolve().then(() => __importStar(require('sql.js'))).then((module) => {
-            const initSqlJs = module.default || module;
-            return initSqlJs(sqlJsConfig ?? {});
-        });
+        const isBrowser = typeof globalThis !== 'undefined' && globalThis.window !== undefined;
+        if (!isBrowser)
+            throw new Error('Must be run in a browser');
+        const window = globalThis.window;
+        if (!('initSqlJs' in window))
+            throw new Error('Need to add sql-wasm.js script element to DOM');
+        const initSqlJs = window.initSqlJs;
+        sqlJsPromise = initSqlJs(sqlJsConfig ?? {});
     }
     return sqlJsPromise;
 }
@@ -109,7 +90,7 @@ async function openSqliteDatabase(input, options = {}) {
     }
     const data = await readBinaryFromInput(input);
     if (!(0, io_1.isNodeRuntime)()) {
-        const SQL = await getSqlJs();
+        const SQL = await getSqlJsBrowser();
         const db = new SQL.Database(data);
         return { db: createSqlJsAdapter(db) };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "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",
@@ -181,7 +181,7 @@
     "fast-xml-parser": "^5.2.0",
     "jszip": "^3.10.1",
     "plist": "^3.1.0",
-    "sql.js": "^1.13.0",
+    "sql.js": "^1.14.1",
     "xml2js": "^0.6.2",
     "yauzl": "^3.2.0"
   },