@willwade/aac-processors 0.0.25 → 0.0.27

package/dist/core/treeStructure.d.ts

@@ -145,9 +145,10 @@ export declare class AACButton implements IAACButton {
     parameters?: {
         [key: string]: any;
     };
+    predictions?: string[];
     semantic_id?: string;
     clone_id?: string;
-    constructor({ id, label, message, targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, scanBlock, visibility, directActivate, parameters, semantic_id, clone_id, type, action, }: {
+    constructor({ id, label, message, targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, scanBlock, visibility, directActivate, parameters, predictions, semantic_id, clone_id, type, action, }: {
         id: string;
         label?: string;
         message?: string;
@@ -177,6 +178,7 @@ export declare class AACButton implements IAACButton {
         parameters?: {
             [key: string]: any;
         };
+        predictions?: string[];
         semantic_id?: string;
         clone_id?: string;
         type?: 'SPEAK' | 'NAVIGATE' | 'ACTION';

package/dist/core/treeStructure.js

@@ -57,7 +57,7 @@ var AACScanType;
     AACScanType["BLOCK_COLUMN_ROW"] = "block-column-row";
 })(AACScanType || (exports.AACScanType = AACScanType = {}));
 class AACButton {
-    constructor({ id, label = '', message = '', targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, scanBlock, visibility, directActivate, parameters, semantic_id, clone_id, 
+    constructor({ id, label = '', message = '', targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, scanBlock, visibility, directActivate, parameters, predictions, semantic_id, clone_id, 
     // Legacy input support
     type, action, }) {
         this.id = id;
@@ -82,6 +82,7 @@ class AACButton {
         this.visibility = visibility;
         this.directActivate = directActivate;
         this.parameters = parameters;
+        this.predictions = predictions;
         this.semantic_id = semantic_id;
         this.clone_id = clone_id;
         // Legacy mapping: if no semanticAction provided, derive from legacy `action` first

package/dist/processors/gridsetProcessor.js

@@ -1226,6 +1226,12 @@ class GridsetProcessor extends baseProcessor_1.BaseProcessor {
                                 ...cellStyle,
                                 ...inlineStyle, // Inline styles override referenced styles
                             },
+                            // Store predictions directly on button for easy access
+                            predictions: predictionWords?.length
+                                ? [...predictionWords]
+                                : gridPredictionWords.length > 0
+                                    ? [...gridPredictionWords]
+                                    : undefined,
                             parameters: {
                                 pluginMetadata: pluginMetadata, // Store full plugin metadata for future use
                                 grid3Commands: detectedCommands, // Store detected command metadata

package/dist/types/aac.d.ts

@@ -113,6 +113,7 @@ export interface AACButton {
     parameters?: {
         [key: string]: any;
     };
+    predictions?: string[];
     semantic_id?: string;
     clone_id?: string;
 }

package/dist/utilities/analytics/metrics/core.d.ts

@@ -39,6 +39,20 @@ export declare class MetricsCalculator {
      * Calculate what percentage of links to this board match semantic_id/clone_id
      */
     private calculateBoardLinkPercentages;
+    /**
+     * Calculate metrics for word forms (smart grammar predictions)
+     *
+     * Word forms are dynamically generated and not part of the tree structure.
+     * Their effort is calculated as:
+     * - Parent button's cumulative effort (to reach the button)
+     * - + Effort to select the word form from its position in predictions grid
+     *
+     * @param tree - The AAC tree
+     * @param buttons - Already calculated button metrics
+     * @param options - Metrics options
+     * @returns Array of word form button metrics
+     */
+    private calculateWordFormMetrics;
     /**
      * Calculate grid dimensions from the tree
      */

package/dist/utilities/analytics/metrics/core.js

@@ -83,6 +83,11 @@ class MetricsCalculator {
         });
         // Update buttons using dynamic spelling effort if applicable
         const buttons = Array.from(knownButtons.values()).sort((a, b) => a.effort - b.effort);
+        // Calculate metrics for word forms (smart grammar predictions)
+        const wordFormMetrics = this.calculateWordFormMetrics(tree, buttons, options);
+        buttons.push(...wordFormMetrics);
+        // Re-sort after adding word forms
+        buttons.sort((a, b) => a.effort - b.effort);
         // Calculate grid dimensions
         const grid = this.calculateGridDimensions(tree);
         // Identify prediction metrics
@@ -560,6 +565,75 @@ class MetricsCalculator {
         boardPcts['all'] = totalLinks;
         return boardPcts;
     }
+    /**
+     * Calculate metrics for word forms (smart grammar predictions)
+     *
+     * Word forms are dynamically generated and not part of the tree structure.
+     * Their effort is calculated as:
+     * - Parent button's cumulative effort (to reach the button)
+     * - + Effort to select the word form from its position in predictions grid
+     *
+     * @param tree - The AAC tree
+     * @param buttons - Already calculated button metrics
+     * @param options - Metrics options
+     * @returns Array of word form button metrics
+     */
+    calculateWordFormMetrics(tree, buttons, _options = {}) {
+        const wordFormMetrics = [];
+        // Track which buttons already exist to avoid duplicates
+        const existingLabels = new Map();
+        buttons.forEach((btn) => existingLabels.set(btn.label.toLowerCase(), btn));
+        // Iterate through all pages to find buttons with predictions
+        Object.values(tree.pages).forEach((page) => {
+            page.grid.forEach((row) => {
+                row.forEach((btn) => {
+                    if (!btn || !btn.predictions || btn.predictions.length === 0)
+                        return;
+                    // Find the parent button's metrics
+                    const parentMetrics = buttons.find((b) => b.id === btn.id);
+                    if (!parentMetrics)
+                        return;
+                    // Calculate effort for each word form
+                    btn.predictions.forEach((wordForm, index) => {
+                        const wordFormLower = wordForm.toLowerCase();
+                        // Skip if this word form already exists as a regular button
+                        if (existingLabels.has(wordFormLower)) {
+                            return;
+                        }
+                        // Calculate effort based on position in predictions array
+                        // Assume predictions are displayed in a grid layout (e.g., 2 columns)
+                        const predictionsGridCols = 2; // Typical predictions layout
+                        const predictionRowIndex = Math.floor(index / predictionsGridCols);
+                        const predictionColIndex = index % predictionsGridCols;
+                        // Calculate visual scan effort to reach this word form position
+                        // Using similar logic to button scanning effort
+                        const predictionPriorItems = predictionRowIndex * predictionsGridCols + predictionColIndex;
+                        const predictionSelectionEffort = (0, effort_1.visualScanEffort)(predictionPriorItems);
+                        // Word form effort = parent button's cumulative effort + selection effort
+                        const wordFormEffort = parentMetrics.effort + predictionSelectionEffort;
+                        // Mark as word form with a special ID pattern
+                        const wordFormBtn = {
+                            id: `${btn.id}_wordform_${index}`,
+                            label: wordForm,
+                            level: parentMetrics.level,
+                            effort: wordFormEffort,
+                            count: 1,
+                            semantic_id: parentMetrics.semantic_id,
+                            clone_id: parentMetrics.clone_id,
+                            temporary_home_id: parentMetrics.temporary_home_id,
+                            is_word_form: true, // Mark this as a word form metric
+                            parent_button_id: btn.id, // Track parent button
+                            parent_button_label: parentMetrics.label, // Track parent label
+                        };
+                        wordFormMetrics.push(wordFormBtn);
+                        existingLabels.set(wordFormLower, wordFormBtn);
+                    });
+                });
+            });
+        });
+        console.log(`📝 Calculated ${wordFormMetrics.length} word form metrics from predictions`);
+        return wordFormMetrics;
+    }
     /**
      * Calculate grid dimensions from the tree
      */

package/dist/utilities/analytics/metrics/types.d.ts

@@ -18,6 +18,9 @@ export interface ButtonMetrics {
     temporary_home_id?: string;
     comp_level?: number;
     comp_effort?: number;
+    is_word_form?: boolean;
+    parent_button_id?: string;
+    parent_button_label?: string;
 }
 /**
  * Board/page level analysis result

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.0.25",
+  "version": "0.0.27",
   "description": "A comprehensive TypeScript library for processing AAC (Augmentative and Alternative Communication) file formats with translation support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",