@willwade/aac-processors 0.3.0 → 0.3.2

package/dist/analytics.d.ts

@@ -5,3 +5,4 @@
  * This is separate from pageset metrics.
  */
 export * from './utilities/analytics/history';
+export * from './utilities/analytics/competence';

package/dist/analytics.js

@@ -21,3 +21,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./utilities/analytics/history"), exports);
+__exportStar(require("./utilities/analytics/competence"), exports);

package/dist/browser/processors/gotalkNow/nsKeyed.js

@@ -44,16 +44,23 @@ export function decodeNsColor(buffer) {
     if (!buffer)
         return undefined;
     const s = bufferToLatinString(buffer);
-    // Require decimal points to avoid matching bplist header bytes (e.g. "00").
-    // Accept 3 or 4 components (RGB or RGBA).
-    const rgbMatch = s.match(/(\d+\.\d+)\s+(\d+\.\d+)\s+(\d+\.\d+)(?:\s+(\d+\.\d+))?/);
-    if (rgbMatch) {
-        const [, r, g, b] = rgbMatch;
-        return rgbToHex(parseFloat(r), parseFloat(g), parseFloat(b));
+    // Match RGB[A] component strings like "1 0.949 0.561" or "0.5 0.5 0.5 1".
+    // Allow integer components (e.g. "1") but require at least one decimal to
+    // avoid matching bplist header bytes (e.g. "00 00 00").
+    const candidates = s.match(/\d+(?:\.\d+)?\s+\d+(?:\.\d+)?\s+\d+(?:\.\d+)?(?:\s+\d+(?:\.\d+)?)?/g);
+    if (candidates) {
+        // Find the first candidate that looks like RGB (has at least one decimal point).
+        const rgbStr = candidates.find((c) => c.includes('.'));
+        if (rgbStr) {
+            const parts = rgbStr.split(/\s+/).map(Number);
+            return rgbToHex(parts[0], parts[1], parts[2]);
+        }
     }
     return undefined;
 }
 const FONT_KEYWORDS = new Set([
+    'bplist',
+    'bplist00',
     'UIFont',
     'UIFontName',
     'UIFontPointSize',

package/dist/browser/processors/gotalkNowProcessor.js

@@ -35,6 +35,7 @@ function buildSemanticAction(rawButton, pageId, buttonIndex) {
     const actionData = rawButton.ActionData || {};
     const label = rawButton.ButtonText ?? '';
     const ttsText = actionData.TTSText;
+    const spoken = ttsText && ttsText.length > 0 ? ttsText : label;
     switch (buttonType) {
         case 'Jump': {
             const jumpTo = actionData.JumpTo;
@@ -45,7 +46,7 @@ function buildSemanticAction(rawButton, pageId, buttonIndex) {
                     intent: AACSemanticIntent.NAVIGATE_TO,
                     targetId: target,
                     platformData: {
-                        gotalkNow: { buttonType: 'Jump', jumpTo },
+                        gotalkNow: { buttonType: 'Jump', jumpTo, jumpBook: actionData.JumpBook },
                     },
                     fallback: { type: 'NAVIGATE', targetPageId: target },
                 },
@@ -53,25 +54,78 @@ function buildSemanticAction(rawButton, pageId, buttonIndex) {
                 targetPageId: target,
             };
         }
-        case 'Audio': {
-            // Audio buttons play a recorded .caf file named <pageId>-<buttonIndex>.caf
+        case 'Audio':
+        case 'Recorded': {
+            // Recorded audio: plays a .caf file named <pageId>-<buttonIndex>.caf.
+            // Recorded buttons may also have TrimStart/TrimEnd for audio trimming.
             const audioLocation = `${pageId}-${buttonIndex}.caf`;
             return {
                 semanticAction: {
                     category: AACSemanticCategory.MEDIA,
                     intent: AACSemanticIntent.PLAY_SOUND,
                     platformData: {
-                        gotalkNow: { buttonType: 'Audio', audioLocation },
+                        gotalkNow: {
+                            buttonType,
+                            audioLocation,
+                            trimStart: actionData.TrimStart,
+                            trimEnd: actionData.TrimEnd,
+                        },
                     },
                     fallback: { type: 'ACTION' },
                 },
-                message: label,
+                message: spoken,
+            };
+        }
+        case 'URL': {
+            return {
+                semanticAction: {
+                    category: AACSemanticCategory.SYSTEM_CONTROL,
+                    intent: AACSemanticIntent.WEB_NAVIGATE,
+                    text: actionData.URL,
+                    platformData: {
+                        gotalkNow: {
+                            buttonType: 'URL',
+                            url: actionData.URL,
+                            openInternally: actionData.OpenInternally,
+                        },
+                    },
+                    fallback: { type: 'ACTION' },
+                },
+                message: spoken,
+            };
+        }
+        case 'GoVisual': {
+            return {
+                semanticAction: {
+                    category: AACSemanticCategory.SYSTEM_CONTROL,
+                    intent: AACSemanticIntent.PLATFORM_SPECIFIC,
+                    platformData: {
+                        gotalkNow: {
+                            buttonType: 'GoVisual',
+                            goVisual: actionData.GoVisual,
+                            goVisualLink: actionData.GoVisualLink,
+                        },
+                    },
+                    fallback: { type: 'ACTION' },
+                },
+                message: spoken,
             };
         }
-        case 'Express':
-        case 'Bookmark':
-        case 'URL':
         case 'Video': {
+            return {
+                semanticAction: {
+                    category: AACSemanticCategory.MEDIA,
+                    intent: AACSemanticIntent.PLAY_VIDEO,
+                    platformData: {
+                        gotalkNow: { buttonType: 'Video' },
+                    },
+                    fallback: { type: 'ACTION' },
+                },
+                message: spoken,
+            };
+        }
+        case 'Express':
+        case 'Bookmark': {
             return {
                 semanticAction: {
                     category: AACSemanticCategory.SYSTEM_CONTROL,
@@ -81,20 +135,19 @@ function buildSemanticAction(rawButton, pageId, buttonIndex) {
                     },
                     fallback: { type: 'ACTION' },
                 },
-                message: ttsText && ttsText.length > 0 ? ttsText : label,
+                message: spoken,
             };
         }
         case 'TTS':
         default: {
-            // When TTSText is empty the visible ButtonText is spoken.
-            const spoken = ttsText && ttsText.length > 0 ? ttsText : label;
+            // Empty/placeholder cells (no ButtonType or no label) get a SPEAK with empty text.
             return {
                 semanticAction: {
                     category: AACSemanticCategory.COMMUNICATION,
                     intent: AACSemanticIntent.SPEAK_TEXT,
                     text: spoken,
                     platformData: {
-                        gotalkNow: { buttonType: 'TTS' },
+                        gotalkNow: { buttonType: buttonType === 'TTS' ? 'TTS' : 'Empty' },
                     },
                     fallback: { type: 'SPEAK', message: spoken },
                 },
@@ -302,17 +355,39 @@ class GotalkNowProcessor extends BaseProcessor {
                     if (first?.SourceImageName)
                         button.symbolPath = first.SourceImageName;
                 }
-                // Visibility: GoTalk buttons can be disabled.
-                if (rawButton.Enabled === false) {
+                // Visibility: GoTalk buttons can be disabled via either field.
+                if (rawButton.Enabled === false || rawButton.Disabled === true) {
                     button.visibility = 'Disabled';
                 }
-                // Preserve raw style data opaquely for round-trip styling.
+                // Auditory cue (played when scanning/highlighting).
+                if (rawButton.CueType && rawButton.CueType !== 'None') {
+                    const cueText = rawButton.CueData?.TTSText;
+                    if (cueText && cueText.length > 0) {
+                        button.audioDescription = cueText;
+                    }
+                }
+                // Recorded audio reference.
+                const btnType = rawButton.ButtonType;
+                if (btnType === 'Audio' || btnType === 'Recorded') {
+                    button.audioRecording = {
+                        identifier: `${pageId}-${btnIndex}.caf`,
+                    };
+                }
+                // AfterAction: motor-planning "speak and return" behaviour.
+                // AfterAction is an enum (0=stay, 2=..., 50=jump-back) and
+                // AfterActionData has the same shape as ActionData (e.g. {JumpTo: 0}).
+                const afterActionJumpTo = rawButton.AfterActionData?.JumpTo;
+                // Preserve raw style + extended data opaquely for round-trip styling.
                 button.parameters = {
                     ...(button.parameters || {}),
                     __gotalkNow: {
                         buttonType: rawButton.ButtonType,
                         textShadow: rawButton.TextShadow,
                         textCenter: rawButton.TextCenter,
+                        cueType: rawButton.CueType,
+                        afterAction: rawButton.AfterAction,
+                        afterActionJumpTo: afterActionJumpTo !== undefined ? String(afterActionJumpTo) : undefined,
+                        jumpBook: rawButton.ActionData?.JumpBook,
                     },
                 };
                 page._loadButton(button);

package/dist/browser/processors/gridsetProcessor.js

@@ -2960,8 +2960,8 @@ class GridsetProcessor extends BaseProcessor {
                                         cellContent.CaptionAndImage = captionAndImage;
                                     }
                                     const cellData = {
-                                        '@_X': position.x + 1, // Grid3 uses 1-based X coordinates
-                                        '@_Y': position.y + yOffset + 1, // Grid3 uses 1-based Y coordinates with workspace offset
+                                        '@_X': position.x, // Grid 3 coordinates are 0-based (matching loader)
+                                        '@_Y': position.y + yOffset,
                                         '@_ColumnSpan': position.columnSpan,
                                         '@_RowSpan': position.rowSpan,
                                         Content: cellContent,

package/dist/browser/processors/obfProcessor.js

@@ -144,14 +144,21 @@ class ObfProcessor extends BaseProcessor {
         const pageId = boardData?.id ? String(boardData.id) : _boardPath?.split(/[/\\]/).pop() || '';
         const images = boardData.images;
         const buttons = await Promise.all(sourceButtons.map(async (btn) => {
+            // Resolve load_board.path to a board ID (strip .obf suffix if present).
+            // The OBF spec says load_board.path is a file path, but internally we
+            // store the board ID as targetPageId.
+            const rawPath = btn.load_board?.path;
+            const boardRef = rawPath
+                ? rawPath.replace(/\.obf$/i, '').replace(/\.obz$/i, '')
+                : undefined;
             const semanticAction = btn.load_board
                 ? {
                     category: AACSemanticCategory.NAVIGATION,
                     intent: AACSemanticIntent.NAVIGATE_TO,
-                    targetId: btn.load_board.path,
+                    targetId: boardRef,
                     fallback: {
                         type: 'NAVIGATE',
-                        targetPageId: btn.load_board.path,
+                        targetPageId: boardRef,
                     },
                 }
                 : {
@@ -199,7 +206,7 @@ class ObfProcessor extends BaseProcessor {
                 resolvedImageEntry: resolvedImage,
                 parameters: Object.keys(buttonParameters).length > 0 ? buttonParameters : undefined,
                 semanticAction,
-                targetPageId: btn.load_board?.path,
+                targetPageId: boardRef,
                 semantic_id: btn.semantic_id, // Extract semantic_id if present
             });
         }));
@@ -618,7 +625,7 @@ class ObfProcessor extends BaseProcessor {
                     vocalization: button.message || button.label,
                     load_board: button.semanticAction?.intent === AACSemanticIntent.NAVIGATE_TO && button.targetPageId
                         ? {
-                            path: button.targetPageId,
+                            path: this.getPageFilename(button.targetPageId, metadata),
                         }
                         : undefined,
                     background_color: button.style?.backgroundColor,