@willwade/aac-processors 0.0.8 → 0.0.10

package/examples/demo.js

@@ -0,0 +1,143 @@
+// AACProcessors Demo: Showcase all engines and features
+const path = require('path');
+
+// Import processors
+const { DotProcessor, OpmlProcessor, SnapProcessor, GridsetProcessor, TouchChatProcessor, ApplePanelsProcessor, ObfProcessor } = require('../dist/processors');
+
+// Optional: pretty printer
+let prettyPrint;
+try {
+  prettyPrint = require('../dist/viewer/prettyPrint');
+} catch {}
+
+// Optional: symbol tools
+let symbolTools;
+try {
+  symbolTools = require('../dist/optional/symbolTools');
+} catch {}
+
+// --- DotProcessor ---
+console.log('\n=== DOT Example ===');
+try {
+  const dotFile = path.join(__dirname, 'example.dot');
+  const dotProcessor = new DotProcessor();
+  const dotTree = dotProcessor.loadIntoTree(dotFile);
+  console.log('DOT tree:', dotTree);
+  console.log('DOT texts:', dotProcessor.extractTexts ? dotProcessor.extractTexts(dotFile) : '(no extractTexts)');
+  if (prettyPrint) prettyPrint.printTree(dotTree, { showNavigation: true });
+} catch (e) {
+  console.warn('DOT demo error:', e.message);
+}
+
+// --- OPMLProcessor ---
+console.log('\n=== OPML Example ===');
+try {
+  const opmlFile = path.join(__dirname, 'example.opml');
+  const opmlProcessor = new OpmlProcessor();
+  const opmlTree = opmlProcessor.loadIntoTree(opmlFile);
+  console.log('OPML tree:', opmlTree);
+  console.log('OPML texts:', opmlProcessor.extractTexts ? opmlProcessor.extractTexts(opmlFile) : '(no extractTexts)');
+  if (prettyPrint) prettyPrint.printTree(opmlTree, { showNavigation: true });
+} catch (e) {
+  console.warn('OPML demo error:', e.message);
+}
+
+
+
+// --- SnapProcessor (SPB) ---
+console.log('\n=== Snap Example (.spb) ===');
+try {
+  const spbFile = path.join(__dirname, 'example.spb');
+  const snapProcessor = new SnapProcessor();
+  const snapTree = snapProcessor.loadIntoTree(spbFile);
+  console.log('Snap tree (.spb):', snapTree);
+  console.log('Snap texts (.spb):', snapProcessor.extractTexts(spbFile));
+  if (prettyPrint) prettyPrint.printTree(snapTree, { showNavigation: true });
+} catch (e) {
+  console.warn('Snap demo error (.spb):', e.message);
+}
+
+// // --- SnapProcessor (SPS) ---
+// console.log('\n=== Snap Example (.sps) ===');
+// try {
+//   const spsFile = path.join(__dirname, 'example.sps');
+//   const snapProcessor = new SnapProcessor();
+//   const snapTree = snapProcessor.loadIntoTree(spsFile);
+//   console.log('Snap tree (.sps):', snapTree);
+//   console.log('Snap texts (.sps):', snapProcessor.extractTexts(spsFile));
+//   if (prettyPrint) prettyPrint.printTree(snapTree, { showNavigation: true });
+// } catch (e) {
+//   console.warn('Snap demo error (.sps):', e.message);
+// }
+
+// --- GridsetProcessor ---
+console.log('\n=== Gridset Example ===');
+try {
+  const gridsetFile = path.join(__dirname, 'example.gridset');
+  const gridsetProcessor = new GridsetProcessor();
+  const gridTree = gridsetProcessor.loadIntoTree(gridsetFile);
+  console.log('Gridset tree:', gridTree);
+  console.log('Gridset texts:', gridsetProcessor.extractTexts(gridsetFile));
+  if (prettyPrint) prettyPrint.printTree(gridTree, { showNavigation: true });
+} catch (e) {
+  console.warn('Gridset demo error:', e.message);
+}
+
+// --- TouchChatProcessor ---
+console.log('\n=== TouchChat Example ===');
+try {
+  const touchchatFile = path.join(__dirname, 'example.ce');
+  const touchchatProcessor = new TouchChatProcessor();
+  const tcTree = touchchatProcessor.loadIntoTree(touchchatFile);
+  console.log('TouchChat tree:', tcTree);
+  console.log('TouchChat texts:', touchchatProcessor.extractTexts(touchchatFile));
+  if (prettyPrint) prettyPrint.printTree(tcTree, { showNavigation: true });
+} catch (e) {
+  console.warn('TouchChat demo error:', e.message);
+}
+
+// --- OBF/OBZ Processor ---
+console.log('\n=== OBF/OBZ Example ===');
+try {
+  // Use ObfProcessor from dist, matching others
+const obfProcessor = new ObfProcessor();
+  const obzFile = path.join(__dirname, 'example.obz');
+  // If loadIntoTree is async, use then/catch. If not, call directly.
+  let obTree;
+  try {
+    obTree = obfProcessor.loadIntoTree(obzFile);
+    console.log('OBZ tree:', obTree);
+    // Try extractTexts if available
+    if (obfProcessor.extractTexts) {
+      try {
+        const texts = obfProcessor.extractTexts(obzFile);
+        console.log('OBZ texts:', texts);
+      } catch (e) {
+        console.warn('OBZ extractTexts error:', e.message);
+      }
+    }
+    if (prettyPrint) prettyPrint.printTree(obTree, { showNavigation: true });
+    console.log('\nDemo complete.');
+  } catch (e) {
+    console.warn('OBZ demo error:', e.message);
+    console.log('\nDemo complete.');
+  }
+  // Return here so the rest of the demo waits for async
+  return;
+} catch (e) {
+  console.warn('OBZ demo error:', e.message);
+}
+
+// --- ApplePanelsProcessor (if implemented) ---
+// console.log('\n=== Apple Panels Example ===');
+// try {
+//   const applePanelsFile = path.join(__dirname, 'example.ascconfig');
+//   const applePanelsProcessor = new ApplePanelsProcessor();
+//   const apTree = applePanelsProcessor.loadIntoTree(applePanelsFile);
+//   console.log('Apple Panels tree:', apTree);
+//   if (prettyPrint) prettyPrint.printTree(apTree, { showNavigation: true });
+// } catch (e) {
+//   console.warn('Apple Panels demo error:', e.message);
+// }
+
+console.log('\nDemo complete.');

package/examples/obf/aboutme.json

@@ -0,0 +1,376 @@
+{
+  "id": "aboutme",
+  "format": "open-board-0.1",
+  "name": "CommuniKate About Me",
+  "license": {
+    "type": "CC-By",
+    "copyright_notice_url": "http://creativecommons.org/licenses/by/3.0/",
+    "author_name": "Kate McCallum",
+    "author_url": "https://twitter.com/KateMcCallumuk"
+  },
+  "buttons": [
+    {
+      "label": "Top Page",
+      "load_board": {
+        "id": "page1",
+        "path": "boards/page1.obf"
+      },
+      "id": 0,
+      "border_color": "#444",
+      "background_color": "#ffff32",
+      "image_id": 0
+    },
+    {
+      "label": "Name",
+      "id": 1,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 1
+    },
+    {
+      "label": "I live in...",
+      "id": 2,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 2
+    },
+    {
+      "label": "Birthday...",
+      "id": 3,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 3
+    },
+    {
+      "label": "age...",
+      "id": 4,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 4
+    },
+    {
+      "label": "I live with...",
+      "id": 5,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 5
+    },
+    {
+      "label": "pet.. ",
+      "id": 6,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 6
+    },
+    {
+      "label": "School college...",
+      "id": 7,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 7
+    },
+    {
+      "label": "email..",
+      "id": 8,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 8
+    },
+    {
+      "label": "work...",
+      "id": 9,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 9
+    },
+    {
+      "label": "communication aid..",
+      "id": 10,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 10
+    },
+    {
+      "label": "music..",
+      "id": 11,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 11
+    },
+    {
+      "label": "film..",
+      "id": 12,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 12
+    },
+    {
+      "label": "hobby..",
+      "id": 13,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 13
+    },
+    {
+      "label": "tv...",
+      "id": 14,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 14
+    },
+    {
+      "label": "disability...",
+      "id": 15,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 15
+    },
+    {
+      "label": "mobile...",
+      "id": 16,
+      "border_color": "#444",
+      "background_color": "#c0c0c0",
+      "image_id": 16
+    },
+    {
+      "label": "About You",
+      "load_board": {
+        "id": "aboutyou",
+        "path": "boards/aboutyou.obf"
+      },
+      "id": 17,
+      "border_color": "rgb(255, 255, 0)",
+      "background_color": "rgba(120, 113, 255, 0.5)",
+      "image_id": 17
+    }
+  ],
+  "images": [
+    {
+      "id": 0,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/communication aid 2.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 1,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/sclera/name.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc/2.0/",
+        "source_url": null,
+        "author_name": "Sclera",
+        "author_url": null
+      }
+    },
+    {
+      "id": 2,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/chicken live.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 3,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/birthday cake.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 4,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/sclera/Age 16+.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc/2.0/",
+        "source_url": null,
+        "author_name": "Sclera",
+        "author_url": null
+      }
+    },
+    {
+      "id": 5,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/chicken live.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 6,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/pet brush.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 7,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/school.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 8,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/email attachment.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 9,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/work , to.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 10,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/communication aid 2.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 11,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/music class.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 12,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/sclera/film roll film.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc/2.0/",
+        "source_url": null,
+        "author_name": "Sclera",
+        "author_url": null
+      }
+    },
+    {
+      "id": 13,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/arasaac/hobby-horses.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc-sa/3.0/",
+        "source_url": null,
+        "author_name": "Sergio Palao",
+        "author_url": null
+      }
+    },
+    {
+      "id": 14,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/change tv channel , to.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 15,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/arasaac/movement disability.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc-sa/3.0/",
+        "source_url": null,
+        "author_name": "Sergio Palao",
+        "author_url": null
+      }
+    },
+    {
+      "id": 16,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/mulberry/mobile phone silent.svg",
+      "content_type": "image/svg",
+      "license": {
+        "type": "CC BY-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-sa/2.0/uk",
+        "source_url": null,
+        "author_name": "Paxtoncrafts Charitable Trust ",
+        "author_url": null
+      }
+    },
+    {
+      "id": 17,
+      "url": "https://s3.amazonaws.com/opensymbols/libraries/arasaac/to forget about something.png",
+      "content_type": "image/png",
+      "license": {
+        "type": "CC BY-NC-SA",
+        "copyright_notice_url": "http://creativecommons.org/licenses/by-nc-sa/3.0/",
+        "source_url": null,
+        "author_name": "Sergio Palao",
+        "author_url": null
+      }
+    }
+  ],
+  "sounds": [],
+  "grid": {
+    "rows": 4,
+    "columns": 5,
+    "order": [
+      [0, 1, 2, 3, 4],
+      [5, 6, 7, 8, 9],
+      [10, 11, 12, 13, 14],
+      [15, 16, 17, null, null]
+    ]
+  }
+}

package/examples/obf/array.json

@@ -0,0 +1,6 @@
+[
+  {
+    "a": 1,
+    "b": 2
+  }
+]

package/examples/obf/hash.json

@@ -0,0 +1,4 @@
+{
+  "a": 1,
+  "b": 2
+}

package/examples/obf/simple.obf

@@ -0,0 +1,53 @@
+{
+  "format": "open-board-0.1",
+  "id": "inline_images",
+  "locale": "en",
+  "name": "Simple Images Board",
+  "description_html": "This is an .obf file with images included as data attributes within the file. It also includes some simple styling.",
+  "grid": {
+    "rows": 2,
+    "columns": 2,
+    "order": [
+      [1, null],
+      [null, 2]
+    ]
+  },
+  "buttons": [
+    {
+      "id": 1,
+      "label": "kids",
+      "vocalization": "children",
+      "ext_speaker_best": true,
+      "image_id": "12345",
+      "background_color": "rgb(255, 255, 255)",
+      "border_color": "rgba(150, 150, 150, 0.5)"
+    },
+    {
+      "id": 2,
+      "label": "cat",
+      "vocalization": "feline",
+      "image_id": 119,
+      "background_color": "rgba(0, 255, 0, 0.5)",
+      "border_color": "rgb(150, 150, 150)"
+    }
+  ],
+  "images": [
+
+    {
+      "id":"12345", 
+      "width":100, 
+      "height":100, 
+      "url":"https://d18vdu4p71yql0.cloudfront.net/libraries/noun-project/No-09d75d7313.svg", 
+      "data":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIGlkPSJMYXllcl8xIiB4PSIwcHgiIHk9IjBweCIgd2lkdGg9IjEwMHB4IiBoZWlnaHQ9IjEwMHB4IiB2aWV3Qm94PSIwIDAgMTAwIDEwMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgMTAwIDEwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8cGF0aCBzdHlsZT0iZmlsbDojMDEwMTAxOyIgZD0iTTUwLDBDMjIuMzg4LDAsMCwyMi4zODgsMCw1MHMyMi4zODgsNTAsNTAsNTBzNTAtMjIuMzg4LDUwLTUwUzc3LjYxMiwwLDUwLDB6IE01MCwxMi41ICBjOC4wOTQsMCwxNS41MzksMi42MzcsMjEuNjY4LDcuMDA3TDE5LjQ5NCw3MS42NTVDMTUuMTI1LDY1LjUyNywxMi41LDU4LjA4MSwxMi41LDUwQzEyLjUsMjkuMzIxLDI5LjMyMSwxMi41LDUwLDEyLjV6IE01MCw4Ny41ICBjLTguMDk0LDAtMTUuNTM5LTIuNjM3LTIxLjY2OC03LjAwN2w1Mi4xNzQtNTIuMTQ4Qzg0Ljg3NSwzNC40NzMsODcuNSw0MS45MTksODcuNSw1MEM4Ny41LDcwLjY3OSw3MC42NzksODcuNSw1MCw4Ny41eiIvPgo8L3N2Zz4K", 
+      "content_type":"image/svg+xml"
+    },
+    {
+      "id":119, 
+      "width":100, 
+      "height":100, 
+      "url":"https://d18vdu4p71yql0.cloudfront.net/libraries/noun-project/No-09d75d7313.svg", 
+      "content_type":"image/svg+xml"
+   }
+  ],
+  "sounds": []
+}