@willwade/aac-processors 0.0.11 → 0.0.13

package/dist/types/aac.d.ts

@@ -1,4 +1,54 @@
 import { AACSemanticAction } from '../core/treeStructure';
+/**
+ * Scanning selection methods for switch access
+ * Determines how the scanning advances through items
+ */
+export declare enum ScanningSelectionMethod {
+    /** Automatically advance through items at timed intervals */
+    AutoScan = "AutoScan",
+    /** Automatic scanning with overscan (two-stage scanning) */
+    AutoScanWithOverscan = "AutoScanWithOverscan",
+    /** Hold switch to advance, release to select */
+    HoldToAdvance = "HoldToAdvance",
+    /** Hold to advance with overscan */
+    HoldToAdvanceWithOverscan = "HoldToAdvanceWithOverscan",
+    /** Tap switch to advance, tap again to select */
+    TapToAdvance = "TapToAdvance"
+}
+/**
+ * Cell scanning order patterns
+ * Determines the sequence in which cells are highlighted
+ */
+export declare enum CellScanningOrder {
+    /** Simple linear scan across rows (left-to-right, top-to-bottom) */
+    SimpleScan = "SimpleScan",
+    /** Simple linear scan down columns (top-to-bottom, left-to-right) */
+    SimpleScanColumnsFirst = "SimpleScanColumnsFirst",
+    /** Row-group scanning: highlight rows first, then cells within selected row */
+    RowColumnScan = "RowColumnScan",
+    /** Column-group scanning: highlight columns first, then cells within selected column */
+    ColumnRowScan = "ColumnRowScan"
+}
+/**
+ * Scanning configuration for a page or pageset
+ * Controls how switch scanning operates
+ */
+export interface ScanningConfig {
+    /** Method for advancing through items */
+    selectionMethod?: ScanningSelectionMethod;
+    /** Order in which cells are scanned */
+    cellScanningOrder?: CellScanningOrder;
+    /** Whether block scanning is enabled (group cells by scanBlock number) */
+    blockScanEnabled?: boolean;
+    /** Whether to include the workspace/message bar in scanning */
+    scanWorkspace?: boolean;
+    /** Time in milliseconds to highlight each item */
+    forwardScanSpeed?: number;
+    /** Time in milliseconds to wait before auto-accepting selection */
+    dwellTime?: number;
+    /** How the selection is accepted */
+    acceptScanMethod?: 'Switch' | 'Timeout' | 'Hold';
+}
 export interface AACStyle {
     backgroundColor?: string;
     fontColor?: string;
@@ -35,13 +85,26 @@ export interface AACButton {
     y?: number;
     columnSpan?: number;
     rowSpan?: number;
+    /**
+     * Scan block number (1-8) for block scanning
+     * Buttons with the same scanBlock number are highlighted together
+     * @deprecated Use scanBlock instead (singular, not array)
+     */
     scanBlocks?: number[];
+    /**
+     * Scan block number (1-8) for block scanning
+     * Buttons with the same scanBlock number are highlighted together
+     * Reduces scanning effort by grouping buttons
+     */
+    scanBlock?: number;
     visibility?: 'Visible' | 'Hidden' | 'Disabled' | 'PointerAndTouchOnly' | 'Empty';
     directActivate?: boolean;
     audioDescription?: string;
     parameters?: {
         [key: string]: any;
     };
+    semantic_id?: string;
+    clone_id?: string;
 }
 export interface AACPage {
     id: string;
@@ -54,6 +117,10 @@ export interface AACPage {
     descriptionHtml?: string;
     images?: any[];
     sounds?: any[];
+    semantic_ids?: string[];
+    clone_ids?: string[];
+    scanningConfig?: ScanningConfig;
+    scanBlocksConfig?: any[];
 }
 export interface AACTree {
     pages: {

package/dist/types/aac.js

@@ -1,2 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CellScanningOrder = exports.ScanningSelectionMethod = void 0;
+/**
+ * Scanning selection methods for switch access
+ * Determines how the scanning advances through items
+ */
+var ScanningSelectionMethod;
+(function (ScanningSelectionMethod) {
+    /** Automatically advance through items at timed intervals */
+    ScanningSelectionMethod["AutoScan"] = "AutoScan";
+    /** Automatic scanning with overscan (two-stage scanning) */
+    ScanningSelectionMethod["AutoScanWithOverscan"] = "AutoScanWithOverscan";
+    /** Hold switch to advance, release to select */
+    ScanningSelectionMethod["HoldToAdvance"] = "HoldToAdvance";
+    /** Hold to advance with overscan */
+    ScanningSelectionMethod["HoldToAdvanceWithOverscan"] = "HoldToAdvanceWithOverscan";
+    /** Tap switch to advance, tap again to select */
+    ScanningSelectionMethod["TapToAdvance"] = "TapToAdvance";
+})(ScanningSelectionMethod || (exports.ScanningSelectionMethod = ScanningSelectionMethod = {}));
+/**
+ * Cell scanning order patterns
+ * Determines the sequence in which cells are highlighted
+ */
+var CellScanningOrder;
+(function (CellScanningOrder) {
+    /** Simple linear scan across rows (left-to-right, top-to-bottom) */
+    CellScanningOrder["SimpleScan"] = "SimpleScan";
+    /** Simple linear scan down columns (top-to-bottom, left-to-right) */
+    CellScanningOrder["SimpleScanColumnsFirst"] = "SimpleScanColumnsFirst";
+    /** Row-group scanning: highlight rows first, then cells within selected row */
+    CellScanningOrder["RowColumnScan"] = "RowColumnScan";
+    /** Column-group scanning: highlight columns first, then cells within selected column */
+    CellScanningOrder["ColumnRowScan"] = "ColumnRowScan";
+})(CellScanningOrder || (exports.CellScanningOrder = CellScanningOrder = {}));

package/dist/validation/gridsetValidator.js

@@ -243,6 +243,16 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
                 this.warn(`cell ${cellIdx} on page ${pageIdx} should have a label or image`);
             }
         });
+        // Validate scan block number (Grid 3 attribute)
+        await this.add_check(`page[${pageIdx}]_cell[${cellIdx}]_scanblock`, `cell scan block`, async () => {
+            const scanBlock = cell.$.scanBlock || cell.$.ScanBlock;
+            if (scanBlock !== undefined) {
+                const blockNum = parseInt(scanBlock, 10);
+                if (isNaN(blockNum) || blockNum < 1 || blockNum > 8) {
+                    this.err(`cell ${cellIdx} on page ${pageIdx} has invalid scanBlock value: ${scanBlock} (must be 1-8)`, false);
+                }
+            }
+        });
         // Check for color attributes
         const backgroundColor = cell.$.backgroundColor || cell.$.BackgroundColor;
         const _color = cell.$.color || cell.$.Color;

package/package.json

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