@willwade/aac-processors 0.2.0 → 0.2.2

package/README.md

@@ -63,9 +63,9 @@ const tree = await processor.loadIntoTree(gridsetUint8Array);
 - Asterics Grid
 - Excel export
 
-## Translation Workflow
+## Wrangle strings workflow
 
-All processors implement `processTexts()` for translation use cases.
+All processors implement `processTexts()` to get all strings eg
 
 ```ts
 import { DotProcessor } from '@willwade/aac-processors';
@@ -80,6 +80,7 @@ const translations = new Map([
 
 await processor.processTexts('board.dot', translations, 'board-es.dot');
 ```
+NB: Please use [https://aactools.co.uk](https://aactools.co.uk) for a far more comphrensive translation logic - where we do far far more than this...  
 
 ## Documentation
 

package/dist/browser/processors/obfProcessor.js

@@ -62,35 +62,42 @@ class ObfProcessor extends BaseProcessor {
         if (this.imageCache.has(imageId)) {
             return this.imageCache.get(imageId) ?? null;
         }
-        if (!this.zipFile || !images) {
+        if (!images)
             return null;
-        }
         // Find the image metadata
         const imageData = images.find((img) => img.id === imageId);
         if (!imageData) {
             return null;
         }
-        // Try to get the image file from the ZIP
-        // Images are typically stored in an 'images' folder or root
-        const possiblePaths = [
-            imageData.path, // Explicit path if provided
-            `images/${imageData.filename || imageId}`, // Standard images folder
-            imageData.id, // Just the ID
-        ].filter(Boolean);
-        for (const imagePath of possiblePaths) {
-            try {
-                const buffer = await this.zipFile.readFile(imagePath);
-                if (buffer) {
-                    const contentType = imageData.content_type ||
-                        this.getMimeTypeFromFilename(imagePath);
-                    const dataUrl = `data:${contentType};base64,${encodeBase64(buffer)}`;
-                    this.imageCache.set(imageId, dataUrl);
-                    return dataUrl;
+        // If image has data property, use that
+        if (imageData.data) {
+            const dataUrl = imageData.data;
+            this.imageCache.set(imageId, dataUrl);
+            return dataUrl;
+        }
+        if (this.zipFile) {
+            // Try to get the image file from the ZIP
+            // Images are typically stored in an 'images' folder or root
+            const possiblePaths = [
+                imageData.path, // Explicit path if provided
+                `images/${imageData.filename || imageId}`, // Standard images folder
+                imageData.id, // Just the ID
+            ].filter(Boolean);
+            for (const imagePath of possiblePaths) {
+                try {
+                    const buffer = await this.zipFile.readFile(imagePath);
+                    if (buffer) {
+                        const contentType = imageData.content_type ||
+                            this.getMimeTypeFromFilename(imagePath);
+                        const dataUrl = `data:${contentType};base64,${encodeBase64(buffer)}`;
+                        this.imageCache.set(imageId, dataUrl);
+                        return dataUrl;
+                    }
+                }
+                catch (err) {
+                    // Continue to next path
+                    continue;
                 }
-            }
-            catch (err) {
-                // Continue to next path
-                continue;
             }
         }
         // If image has a URL, use that as fallback
@@ -528,6 +535,7 @@ class ObfProcessor extends BaseProcessor {
                     border_color: button.style?.borderColor,
                     box_id: buttonPositions.get(String(button.id ?? '')),
                     image_id: imageId,
+                    hidden: button.visibility === 'Hidden' || false,
                 };
             }),
             images: Array.isArray(page.images) ? page.images : [],
@@ -579,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/processors/obfProcessor.js

@@ -65,35 +65,42 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
         if (this.imageCache.has(imageId)) {
             return this.imageCache.get(imageId) ?? null;
         }
-        if (!this.zipFile || !images) {
+        if (!images)
             return null;
-        }
         // Find the image metadata
         const imageData = images.find((img) => img.id === imageId);
         if (!imageData) {
             return null;
         }
-        // Try to get the image file from the ZIP
-        // Images are typically stored in an 'images' folder or root
-        const possiblePaths = [
-            imageData.path, // Explicit path if provided
-            `images/${imageData.filename || imageId}`, // Standard images folder
-            imageData.id, // Just the ID
-        ].filter(Boolean);
-        for (const imagePath of possiblePaths) {
-            try {
-                const buffer = await this.zipFile.readFile(imagePath);
-                if (buffer) {
-                    const contentType = imageData.content_type ||
-                        this.getMimeTypeFromFilename(imagePath);
-                    const dataUrl = `data:${contentType};base64,${(0, io_1.encodeBase64)(buffer)}`;
-                    this.imageCache.set(imageId, dataUrl);
-                    return dataUrl;
+        // If image has data property, use that
+        if (imageData.data) {
+            const dataUrl = imageData.data;
+            this.imageCache.set(imageId, dataUrl);
+            return dataUrl;
+        }
+        if (this.zipFile) {
+            // Try to get the image file from the ZIP
+            // Images are typically stored in an 'images' folder or root
+            const possiblePaths = [
+                imageData.path, // Explicit path if provided
+                `images/${imageData.filename || imageId}`, // Standard images folder
+                imageData.id, // Just the ID
+            ].filter(Boolean);
+            for (const imagePath of possiblePaths) {
+                try {
+                    const buffer = await this.zipFile.readFile(imagePath);
+                    if (buffer) {
+                        const contentType = imageData.content_type ||
+                            this.getMimeTypeFromFilename(imagePath);
+                        const dataUrl = `data:${contentType};base64,${(0, io_1.encodeBase64)(buffer)}`;
+                        this.imageCache.set(imageId, dataUrl);
+                        return dataUrl;
+                    }
+                }
+                catch (err) {
+                    // Continue to next path
+                    continue;
                 }
-            }
-            catch (err) {
-                // Continue to next path
-                continue;
             }
         }
         // If image has a URL, use that as fallback
@@ -531,6 +538,7 @@ class ObfProcessor extends baseProcessor_1.BaseProcessor {
                     border_color: button.style?.borderColor,
                     box_id: buttonPositions.get(String(button.id ?? '')),
                     image_id: imageId,
+                    hidden: button.visibility === 'Hidden' || false,
                 };
             }),
             images: Array.isArray(page.images) ? page.images : [],
@@ -582,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/docs/BROWSER_USAGE.md

@@ -212,46 +212,6 @@ The most common browser use case is loading files from an `<input type="file">`
 </script>
 ```
 
-### Processing Translations
-
-```html
-<script type="module">
-  import { getProcessor } from 'aac-processors';
-
-  async function translateFile(file, translations) {
-    const extension = '.' + file.name.split('.').pop();
-    const processor = getProcessor(extension);
-    const arrayBuffer = await file.arrayBuffer();
-
-    // Process texts with translations
-    const translatedBuffer = await processor.processTexts(
-      arrayBuffer,
-      translations,
-      null // Don't save to file, return buffer
-    );
-
-    // Create download link
-    const blob = new Blob([translatedBuffer], { type: 'application/octet-stream' });
-    const url = URL.createObjectURL(blob);
-    const a = document.createElement('a');
-    a.href = url;
-    a.download = 'translated-' + file.name;
-    a.click();
-    URL.revokeObjectURL(url);
-  }
-
-  // Usage
-  const translations = new Map([
-    ['Hello', 'Hola'],
-    ['Goodbye', 'Adiós'],
-    ['Yes', 'Sí'],
-    ['No', 'No']
-  ]);
-
-  translateFile(myFile, translations);
-</script>
-```
-
 ## Supported File Types
 
 ### Browser-Compatible Processors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "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",