-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathtreeStructure.ts
More file actions
602 lines (555 loc) · 16.2 KB
/
Copy pathtreeStructure.ts
File metadata and controls
602 lines (555 loc) · 16.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
// Note: To avoid circular dependency issues with Vite, we use type-only imports
import type {
AACStyle,
AACTreeMetadata,
SnapMetadata,
GridSetMetadata,
AstericsGridMetadata,
TouchChatMetadata,
CellScanningOrder,
ScanningSelectionMethod,
AACWordListItem,
AACPageMutation,
ProcessorCapabilities,
} from '../types/aac';
// Re-export for consumers
export type {
AACStyle,
AACTreeMetadata,
SnapMetadata,
GridSetMetadata,
AstericsGridMetadata,
TouchChatMetadata,
CellScanningOrder,
ScanningSelectionMethod,
AACWordListItem,
AACPageMutation,
ProcessorCapabilities,
};
// Semantic action categories for cross-platform compatibility
export enum AACSemanticCategory {
COMMUNICATION = 'communication', // Speech, text output
NAVIGATION = 'navigation', // Page/grid navigation
TEXT_EDITING = 'text_editing', // Text manipulation
SYSTEM_CONTROL = 'system_control', // Device/app control
MEDIA = 'media', // Audio/video playback
ACCESSIBILITY = 'accessibility', // Switch scanning, etc.
CUSTOM = 'custom', // Platform-specific extensions
}
// Semantic intents within each category
export enum AACSemanticIntent {
// Communication
SPEAK_TEXT = 'SPEAK_TEXT',
SPEAK_IMMEDIATE = 'SPEAK_IMMEDIATE',
STOP_SPEECH = 'STOP_SPEECH',
INSERT_TEXT = 'INSERT_TEXT',
// Navigation
NAVIGATE_TO = 'NAVIGATE_TO',
GO_BACK = 'GO_BACK',
GO_HOME = 'GO_HOME',
// Text Editing
DELETE_WORD = 'DELETE_WORD',
DELETE_CHARACTER = 'DELETE_CHARACTER',
CLEAR_TEXT = 'CLEAR_TEXT',
COPY_TEXT = 'COPY_TEXT',
PASTE_TEXT = 'PASTE_TEXT',
// System Control
SEND_KEYS = 'SEND_KEYS',
MOUSE_CLICK = 'MOUSE_CLICK',
// Media
PLAY_SOUND = 'PLAY_SOUND',
PLAY_VIDEO = 'PLAY_VIDEO',
// Accessibility
SCAN_NEXT = 'SCAN_NEXT',
SCAN_SELECT = 'SCAN_SELECT',
// Custom
PLATFORM_SPECIFIC = 'PLATFORM_SPECIFIC',
}
/**
* Scanning types for accessibility
*/
export enum AACScanType {
LINEAR = 'linear', // Left-to-right, top-to-bottom
ROW_COLUMN = 'row-column', // Scan rows, then columns
COLUMN_ROW = 'column-row', // Scan columns, then rows
BLOCK_ROW_COLUMN = 'block-row-column', // Scan blocks, then rows, then columns
BLOCK_COLUMN_ROW = 'block-column-row', // Scan blocks, then columns, then rows
}
/**
* Configuration for a scan block
*/
export interface AACScanBlock {
id: number;
name?: string;
order?: number; // Sequence in scanning
scanType?: AACScanType; // Override scanning within this block
}
// New semantic action interface for cross-platform compatibility
export interface AACSemanticAction {
// Make category optional for backward-compat with older tests constructing minimal actions
category?: AACSemanticCategory;
intent: AACSemanticIntent | string;
// Core parameters that most platforms understand
text?: string; // Text content
targetId?: string; // Navigation target
audioData?: Buffer; // Audio content
// Rich content for advanced platforms
richText?: {
text: string;
symbols?: Array<{ text: string; image?: string }>;
grammar?: {
partOfSpeech?: string;
person?: string;
number?: string;
verbState?: string;
};
};
// Generic parameters bag for compatibility with older tests
parameters?: { [key: string]: any };
// Platform-specific extensions
platformData?: {
grid3?: {
commandId: string;
parameters: { [key: string]: any };
};
astericsGrid?: {
modelName: string;
properties: { [key: string]: any };
};
touchChat?: {
actionCode: number;
actionData: string;
resourceId?: number;
};
snap?: {
navigatePageId?: number;
elementReferenceId?: number;
};
applePanels?: {
actionType: string;
parameters: { [key: string]: any };
};
};
// Fallback for unknown platforms
fallback?: {
type: 'SPEAK' | 'NAVIGATE' | 'ACTION';
message?: string;
targetPageId?: string;
temporary_home?: boolean | string | null;
add_to_sentence?: boolean;
};
}
export class AACButton {
id: string;
label: string;
message: string;
// Semantic action system
semanticAction?: AACSemanticAction;
targetPageId?: string;
style?: AACStyle;
audioRecording?: {
id?: number;
data?: Buffer;
identifier?: string;
metadata?: string;
};
// Extended properties for advanced platforms
contentType?: 'Normal' | 'AutoContent' | 'Workspace' | 'LiveCell';
contentSubType?: string;
image?: string;
resolvedImageEntry?: string; // normalized zip path to resolved image, if present
symbolLibrary?: string;
symbolPath?: string;
x?: number;
y?: number;
columnSpan?: number;
rowSpan?: number;
/**
* @deprecated Use scanBlock instead (singular, not array)
*/
scanBlocks?: number[];
/**
* Scan block number (1-8) for block scanning
*/
scanBlock?: number;
visibility?: 'Visible' | 'Hidden' | 'Disabled' | 'PointerAndTouchOnly' | 'Empty';
directActivate?: boolean;
audioDescription?: string;
parameters?: { [key: string]: any };
// Predictions: Array of predicted word forms for smart grammar
predictions?: string[];
// Part-of-speech tag from gridset (e.g., 'Verb', 'Noun', 'Pronoun', 'Unknown')
pos?: string;
wordForms?: Array<{
lang?: string;
tags: string[];
value: string;
pronunciation?: string;
base?: string;
}>;
semantic_id?: string; // Unique ID for buttons with same semantic meaning across boards
clone_id?: string; // Unique ID for buttons with same label+location across boards
constructor({
id,
label = '',
message = '',
targetPageId,
semanticAction,
audioRecording,
style,
contentType,
contentSubType,
image,
resolvedImageEntry,
symbolLibrary,
symbolPath,
x,
y,
columnSpan,
rowSpan,
scanBlocks,
scanBlock,
visibility,
directActivate,
parameters,
predictions,
pos,
wordForms,
semantic_id,
clone_id,
// Legacy input support
type,
action,
}: {
id: string;
label?: string;
message?: string;
targetPageId?: string;
semanticAction?: AACSemanticAction;
audioRecording?: {
id?: number;
data?: Buffer;
identifier?: string;
metadata?: string;
};
style?: AACStyle;
contentType?: 'Normal' | 'AutoContent' | 'Workspace' | 'LiveCell';
contentSubType?: string;
image?: string;
resolvedImageEntry?: string;
symbolLibrary?: string;
symbolPath?: string;
x?: number;
y?: number;
columnSpan?: number;
rowSpan?: number;
scanBlocks?: number[];
scanBlock?: number;
visibility?: 'Visible' | 'Hidden' | 'Disabled' | 'PointerAndTouchOnly' | 'Empty';
directActivate?: boolean;
parameters?: { [key: string]: any };
predictions?: string[];
pos?: string;
wordForms?: Array<{
lang?: string;
tags: string[];
value: string;
pronunciation?: string;
base?: string;
}>;
semantic_id?: string;
clone_id?: string;
// Legacy constructor properties for backward compatibility
type?: 'SPEAK' | 'NAVIGATE' | 'ACTION';
action?: {
type: 'SPEAK' | 'NAVIGATE' | 'ACTION';
targetPageId?: string;
message?: string;
} | null;
}) {
this.id = id;
this.label = label;
this.message = message;
this.targetPageId = targetPageId;
this.semanticAction = semanticAction;
this.audioRecording = audioRecording;
this.style = style;
this.contentType = contentType;
this.contentSubType = contentSubType;
this.image = image;
this.resolvedImageEntry = resolvedImageEntry;
this.symbolLibrary = symbolLibrary;
this.symbolPath = symbolPath;
this.x = x;
this.y = y;
this.columnSpan = columnSpan;
this.rowSpan = rowSpan;
this.scanBlocks = scanBlocks;
this.scanBlock = scanBlock;
this.visibility = visibility;
this.directActivate = directActivate;
this.parameters = parameters;
this.predictions = predictions;
this.pos = pos;
this.wordForms = wordForms;
this.semantic_id = semantic_id;
this.clone_id = clone_id;
// Legacy mapping: if no semanticAction provided, derive from legacy `action` first
if (!this.semanticAction && action) {
if (action.type === 'NAVIGATE' && (action.targetPageId || this.targetPageId)) {
if (!this.targetPageId) this.targetPageId = action.targetPageId;
this.semanticAction = {
category: AACSemanticCategory.NAVIGATION,
intent: AACSemanticIntent.NAVIGATE_TO,
targetId: this.targetPageId,
fallback: { type: 'NAVIGATE', targetPageId: this.targetPageId },
};
} else if (action.type === 'SPEAK') {
const text = action.message || this.message || this.label || '';
if (!this.message) this.message = text;
this.semanticAction = {
category: AACSemanticCategory.COMMUNICATION,
intent: AACSemanticIntent.SPEAK_TEXT,
text,
fallback: { type: 'SPEAK', message: text },
};
} else {
this.semanticAction = {
category: AACSemanticCategory.SYSTEM_CONTROL,
intent: AACSemanticIntent.PLATFORM_SPECIFIC,
fallback: { type: 'ACTION' },
};
}
}
// Legacy mapping: if still no semanticAction and `type` provided
if (!this.semanticAction && type) {
if (type === 'NAVIGATE' && this.targetPageId) {
this.semanticAction = {
category: AACSemanticCategory.NAVIGATION,
intent: AACSemanticIntent.NAVIGATE_TO,
targetId: this.targetPageId,
fallback: { type: 'NAVIGATE', targetPageId: this.targetPageId },
};
} else if (type === 'SPEAK') {
const text = this.message || this.label || '';
this.semanticAction = {
category: AACSemanticCategory.COMMUNICATION,
intent: AACSemanticIntent.SPEAK_TEXT,
text,
fallback: { type: 'SPEAK', message: text },
};
} else {
this.semanticAction = {
category: AACSemanticCategory.SYSTEM_CONTROL,
intent: AACSemanticIntent.PLATFORM_SPECIFIC,
fallback: { type: 'ACTION' },
};
}
}
}
// Legacy compatibility properties
get type(): 'SPEAK' | 'NAVIGATE' | 'ACTION' | undefined {
if (this.semanticAction) {
const i = String(this.semanticAction.intent);
if (i === 'NAVIGATE_TO') return 'NAVIGATE';
if (i === 'SPEAK_TEXT' || i === 'SPEAK_IMMEDIATE') return 'SPEAK';
return 'ACTION';
}
if (this.targetPageId) return 'NAVIGATE';
if (this.message) return 'SPEAK';
return 'SPEAK';
}
get action(): {
type: 'SPEAK' | 'NAVIGATE' | 'ACTION';
targetPageId?: string;
message?: string;
} | null {
const t = this.type;
if (!t) return null;
if (t === 'SPEAK' && !this.message && !this.label && !this.semanticAction) {
return null;
}
return { type: t, targetPageId: this.targetPageId, message: this.message };
}
}
export class AACPage {
id: string;
name: string;
grid: Array<Array<AACButton | null>>;
buttons: AACButton[];
parentId: string | null;
style?: AACStyle;
locale?: string;
descriptionHtml?: string;
images?: any[];
sounds?: any[];
// Metrics support: Track semantic/clone IDs used on this page
semantic_ids?: string[];
clone_ids?: string[];
// Scanning configuration for this page
scanningConfig?: import('../types/aac').ScanningConfig;
// Scanning support
scanType?: AACScanType;
scanBlocksConfig?: AACScanBlock[];
// Mutation tracking
private _pendingMutations: AACPageMutation[] = [];
constructor({
id,
name = '',
grid = [],
buttons = [],
parentId = null,
style,
locale,
descriptionHtml,
images,
sounds,
semantic_ids,
clone_ids,
scanningConfig,
scanBlocksConfig,
scanType,
}: {
id: string;
name?: string;
grid?: Array<Array<AACButton | null>> | { columns: number; rows: number };
buttons?: AACButton[];
parentId?: string | null;
style?: AACStyle;
locale?: string;
descriptionHtml?: string;
images?: any[];
sounds?: any[];
semantic_ids?: string[];
clone_ids?: string[];
scanningConfig?: import('../types/aac').ScanningConfig;
scanBlocksConfig?: AACScanBlock[];
scanType?: AACScanType;
}) {
this.id = id;
this.name = name;
if (Array.isArray(grid)) {
this.grid = grid;
} else if (grid && typeof grid === 'object' && 'columns' in grid && 'rows' in grid) {
const cols = (grid as any).columns as number;
const rows = (grid as any).rows as number;
this.grid = Array.from({ length: rows }, () => Array.from({ length: cols }, () => null));
} else {
this.grid = [];
}
this.buttons = buttons;
this.parentId = parentId;
this.style = style;
this.locale = locale;
this.descriptionHtml = descriptionHtml;
this.images = images;
this.sounds = sounds;
this.semantic_ids = semantic_ids;
this.clone_ids = clone_ids;
this.scanningConfig = scanningConfig;
this.scanBlocksConfig = scanBlocksConfig;
this.scanType = scanType;
}
addButton(button: AACButton): void {
this.buttons.push(button);
// Record the mutation
this._pendingMutations.push({ type: 'addButton', button });
}
/**
* Get the list of pending mutations for this page (read-only)
*/
get pendingMutations(): readonly AACPageMutation[] {
return Object.freeze([...this._pendingMutations]);
}
/**
* Remove a button by ID
* @param buttonId - The ID of the button to remove
*/
removeButton(buttonId: string): void {
this._pendingMutations.push({ type: 'removeButton', buttonId });
}
/**
* Update a button by merging a patch
* @param buttonId - The ID of the button to update
* @param patch - Partial button object with fields to update
*/
updateButton(buttonId: string, patch: Partial<AACButton>): void {
this._pendingMutations.push({ type: 'updateButton', buttonId, patch });
}
/**
* Add an item to the page's WordList (for formats with dynamic content cells)
* @param item - WordList item to add
*/
addWordListItem(item: AACWordListItem): void {
this._pendingMutations.push({ type: 'addWordListItem', item });
}
/**
* Remove items from the page's WordList
* @param textOrPredicate - Text to match or predicate function to filter items
*/
removeWordListItem(textOrPredicate: string | ((item: AACWordListItem) => boolean)): void {
this._pendingMutations.push({ type: 'removeWordListItem', match: textOrPredicate });
}
/**
* Clear all items from the page's WordList
*/
clearWordList(): void {
this._pendingMutations.push({ type: 'clearWordList' });
}
}
export class AACTree {
pages: { [key: string]: AACPage };
metadata: AACTreeMetadata;
public get rootId(): string | null {
return this.metadata.defaultHomePageId || null;
}
public set rootId(id: string | null) {
this.metadata.defaultHomePageId = id || undefined;
}
public get toolbarId(): string | null {
return this.metadata.toolbarId || null;
}
public set toolbarId(id: string | null) {
this.metadata.toolbarId = id || undefined;
}
public get dashboardId(): string | null {
return this.metadata.dashboardId || null;
}
public set dashboardId(id: string | null) {
this.metadata.dashboardId = id || undefined;
}
constructor() {
this.pages = {};
this.metadata = {};
}
addPage(page: AACPage): void {
this.pages[page.id] = page;
if (!this.rootId) this.rootId = page.id;
}
getPage(id: string): AACPage | undefined {
return this.pages[id];
}
traverse(callback: (page: AACPage) => void): void {
const queue: string[] = Object.keys(this.pages);
const visited = new Set<string>();
while (queue.length > 0) {
const id = queue.shift();
if (!id || visited.has(id)) continue;
visited.add(id);
const page = this.pages[id];
if (page) {
callback(page);
// Add child pages to queue
page.buttons
.filter((b) => {
const i = String(b.semanticAction?.intent);
return i === 'NAVIGATE_TO' || !!b.semanticAction?.targetId || !!b.targetPageId;
})
.forEach((b) => {
const target = b.semanticAction?.targetId || b.targetPageId;
if (target) queue.push(target);
});
}
}
}
}