@willwade/aac-processors 0.0.11 → 0.0.13

package/dist/optional/analytics/metrics/obl.js

@@ -0,0 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OblAnonymizer = exports.OblUtil = void 0;
+const treeStructure_1 = require("../../../core/treeStructure");
+/**
+ * .obl (Open Board Logging) Utility
+ *
+ * Provides parsing and generation support for the .obl format.
+ */
+class OblUtil {
+    /**
+     * Parse an OBL JSON string.
+     * Handles the optional /* notice * / at the start of the file.
+     */
+    static parse(json) {
+        // Remove potential comment at the start
+        let cleanJson = json.trim();
+        if (cleanJson.startsWith('/*')) {
+            const endComment = cleanJson.indexOf('*/');
+            if (endComment !== -1) {
+                cleanJson = cleanJson.substring(endComment + 2).trim();
+            }
+        }
+        return JSON.parse(cleanJson);
+    }
+    /**
+     * Stringify an OBL file object.
+     * Optionally adds the recommended notice comment.
+     */
+    static stringify(obl, includeNotice = true) {
+        const json = JSON.stringify(obl, null, 2);
+        if (includeNotice) {
+            return `/* NOTICE: The following information represents an individual's communication and should be treated respectfully and securely. */\n${json}`;
+        }
+        return json;
+    }
+    /**
+     * Convert an OBL file to internal HistoryEntry format.
+     */
+    static toHistoryEntries(obl) {
+        const entries = [];
+        const source = obl.source || 'OBL';
+        // OBL is session-based and event-based.
+        // HistoryEntry is content-based with occurrences.
+        // We'll group events by content (label/text) to match HistoryEntry structure.
+        const contentMap = new Map();
+        for (const session of obl.sessions) {
+            for (const event of session.events) {
+                let content = '';
+                const evtAny = event;
+                const occurrence = {
+                    timestamp: new Date(event.timestamp),
+                    modeling: event.modeling,
+                    pageId: evtAny.board_id || null,
+                    latitude: event.geo?.[0] || null,
+                    longitude: event.geo?.[1] || null,
+                    type: event.type,
+                    // Store all other OBL fields in the occurrence
+                    buttonId: evtAny.button_id || null,
+                    boardId: evtAny.board_id || null,
+                    spoken: evtAny.spoken,
+                    vocalization: evtAny.vocalization,
+                    imageUrl: evtAny.image_url,
+                    actions: evtAny.actions,
+                };
+                if (event.type === 'button') {
+                    const btn = event;
+                    content = btn.vocalization || btn.label;
+                }
+                else if (event.type === 'utterance') {
+                    const utt = event;
+                    content = utt.text;
+                }
+                else if (event.type === 'action') {
+                    const act = event;
+                    content = act.action;
+                }
+                else if (event.type === 'note') {
+                    const note = event;
+                    content = note.text;
+                }
+                else {
+                    const evtAny = event;
+                    content = evtAny.label || evtAny.text || evtAny.action || 'unknown';
+                }
+                const occurrences = contentMap.get(content) || [];
+                occurrences.push(occurrence);
+                contentMap.set(content, occurrences);
+            }
+        }
+        contentMap.forEach((occurrences, content) => {
+            entries.push({
+                id: `obl:${content}`,
+                source: source,
+                content: content,
+                occurrences: occurrences.sort((a, b) => a.timestamp.getTime() - b.timestamp.getTime()),
+            });
+        });
+        return entries;
+    }
+    /**
+     * Convert HistoryEntries to an OBL file object.
+     */
+    static fromHistoryEntries(entries, userId, source) {
+        const events = [];
+        for (const entry of entries) {
+            for (const occ of entry.occurrences) {
+                const timestamp = occ.timestamp.toISOString();
+                const intent = occ.intent;
+                let oblType = occ.type || 'button';
+                let actionStr = undefined;
+                // Smart mapping based on AACSemanticIntent
+                if (intent === treeStructure_1.AACSemanticIntent.CLEAR_TEXT) {
+                    oblType = 'action';
+                    actionStr = ':clear';
+                }
+                else if (intent === treeStructure_1.AACSemanticIntent.GO_HOME) {
+                    oblType = 'action';
+                    actionStr = ':home';
+                }
+                else if (intent === treeStructure_1.AACSemanticIntent.NAVIGATE_TO) {
+                    oblType = 'action';
+                    actionStr = ':open_board';
+                }
+                else if (intent === treeStructure_1.AACSemanticIntent.GO_BACK) {
+                    oblType = 'action';
+                    actionStr = ':back';
+                }
+                else if (intent === treeStructure_1.AACSemanticIntent.DELETE_CHARACTER) {
+                    oblType = 'action';
+                    actionStr = ':backspace';
+                }
+                else if (intent === treeStructure_1.AACSemanticIntent.SPEAK_IMMEDIATE ||
+                    intent === treeStructure_1.AACSemanticIntent.SPEAK_TEXT) {
+                    // Speak could be a button or an utterance or an action
+                    if (oblType !== 'utterance' && oblType !== 'button') {
+                        oblType = 'action';
+                        actionStr = ':speak';
+                    }
+                }
+                const common = {
+                    id: Math.random().toString(36).substring(2, 11),
+                    timestamp,
+                    modeling: occ.modeling,
+                    type: oblType,
+                };
+                if (occ.latitude !== null &&
+                    occ.latitude !== undefined &&
+                    occ.longitude !== null &&
+                    occ.longitude !== undefined) {
+                    common.geo = [occ.latitude, occ.longitude];
+                }
+                if (oblType === 'utterance') {
+                    events.push({
+                        ...common,
+                        text: entry.content,
+                    });
+                }
+                else if (oblType === 'action') {
+                    events.push({
+                        ...common,
+                        action: actionStr || entry.content,
+                        destination_board_id: occ.boardId || undefined,
+                        text: intent === treeStructure_1.AACSemanticIntent.SPEAK_TEXT ? entry.content : undefined,
+                    });
+                }
+                else if (oblType === 'note') {
+                    events.push({
+                        ...common,
+                        text: entry.content,
+                    });
+                }
+                else {
+                    // Default to button
+                    events.push({
+                        ...common,
+                        type: 'button',
+                        label: occ.vocalization ? entry.content : entry.content,
+                        spoken: occ.spoken ??
+                            occ.category === treeStructure_1.AACSemanticCategory.COMMUNICATION,
+                        button_id: occ.buttonId || undefined,
+                        board_id: occ.boardId || occ.pageId || undefined,
+                        vocalization: occ.vocalization || undefined,
+                        image_url: occ.imageUrl || undefined,
+                        actions: occ.actions || undefined,
+                    });
+                }
+            }
+        }
+        // Sort events by timestamp
+        events.sort((a, b) => a.timestamp.localeCompare(b.timestamp));
+        const started = events.length > 0 ? events[0].timestamp : new Date().toISOString();
+        const ended = events.length > 0 ? events[events.length - 1].timestamp : new Date().toISOString();
+        const session = {
+            id: 'session-1',
+            type: 'log',
+            started,
+            ended,
+            events,
+        };
+        return {
+            format: 'open-board-log-0.1',
+            user_id: userId,
+            source: source || 'aac-processors',
+            sessions: [session],
+        };
+    }
+}
+exports.OblUtil = OblUtil;
+/**
+ * .obl Anonymization Utility
+ */
+class OblAnonymizer {
+    /**
+     * Apply anonymization to an OBL file.
+     */
+    static anonymize(obl, types) {
+        const newObl = JSON.parse(JSON.stringify(obl));
+        newObl.anonymized = true;
+        for (const session of newObl.sessions) {
+            session.anonymizations = session.anonymizations || [];
+            if (types.includes('timestamp_shift')) {
+                this.applyTimestampShift(session);
+                if (!session.anonymizations.includes('timestamp_shift'))
+                    session.anonymizations.push('timestamp_shift');
+            }
+            if (types.includes('geolocation_masking')) {
+                this.applyGeolocationMasking(session);
+                if (!session.anonymizations.includes('geolocation_masking'))
+                    session.anonymizations.push('geolocation_masking');
+            }
+            if (types.includes('url_stripping')) {
+                this.applyUrlStripping(session);
+                if (!session.anonymizations.includes('url_stripping'))
+                    session.anonymizations.push('url_stripping');
+            }
+            if (types.includes('name_masking')) {
+                this.applyNameMasking(newObl, session);
+                if (!session.anonymizations.includes('name_masking'))
+                    session.anonymizations.push('name_masking');
+            }
+        }
+        return newObl;
+    }
+    static applyTimestampShift(session) {
+        if (session.events.length === 0)
+            return;
+        const firstEventTime = session.events.length > 0 ? new Date(session.events[0].timestamp).getTime() : Infinity;
+        const sessionStartTime = session.started ? new Date(session.started).getTime() : Infinity;
+        const firstTimestamp = Math.min(firstEventTime, sessionStartTime);
+        if (firstTimestamp === Infinity)
+            return;
+        const targetStart = new Date('2000-01-01T00:00:00.000Z').getTime();
+        const offset = targetStart - firstTimestamp;
+        session.started = new Date(new Date(session.started).getTime() + offset).toISOString();
+        session.ended = new Date(new Date(session.ended).getTime() + offset).toISOString();
+        for (const event of session.events) {
+            event.timestamp = new Date(new Date(event.timestamp).getTime() + offset).toISOString();
+        }
+    }
+    static applyGeolocationMasking(session) {
+        for (const event of session.events) {
+            delete event.geo;
+            delete event.location_id;
+        }
+    }
+    static applyUrlStripping(session) {
+        for (const event of session.events) {
+            if (event.type === 'button') {
+                delete event.image_url;
+            }
+            if (event.type === 'note') {
+                delete event.author_url;
+                delete event.author_email;
+            }
+        }
+    }
+    static applyNameMasking(obl, session) {
+        delete obl.user_name;
+        for (const event of session.events) {
+            if (event.type === 'note') {
+                delete event.author_name;
+            }
+        }
+    }
+}
+exports.OblAnonymizer = OblAnonymizer;

package/dist/optional/analytics/metrics/sentence.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Sentence Construction Analysis
+ *
+ * Calculates the effort required to construct test sentences
+ * from the AAC board set, including spelling fallback for missing words.
+ */
+import { MetricsResult } from './types';
+export interface SentenceAnalysis {
+    sentence: string;
+    words: string[];
+    effort: number;
+    total_effort: number;
+    typing: boolean;
+    missing_words: string[];
+    word_efforts: Array<{
+        word: string;
+        effort: number;
+        typed: boolean;
+    }>;
+}
+export declare class SentenceAnalyzer {
+    /**
+     * Analyze effort to construct a set of test sentences
+     */
+    analyzeSentences(metrics: MetricsResult, sentences: string[][]): SentenceAnalysis[];
+    /**
+     * Analyze effort to construct a single sentence
+     */
+    analyzeSentence(metrics: MetricsResult, words: string[]): SentenceAnalysis;
+    /**
+     * Reconstruct sentence from word array
+     */
+    private reconstructSentence;
+    /**
+     * Calculate statistics across all sentences
+     */
+    calculateStatistics(analyses: SentenceAnalysis[]): {
+        total_sentences: number;
+        sentences_requiring_typing: number;
+        sentences_without_typing: number;
+        average_effort: number;
+        min_effort: number;
+        max_effort: number;
+        median_effort: number;
+        total_words: number;
+        words_requiring_typing: number;
+        typing_percent: number;
+    };
+}

package/dist/optional/analytics/metrics/sentence.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Sentence Construction Analysis
+ *
+ * Calculates the effort required to construct test sentences
+ * from the AAC board set, including spelling fallback for missing words.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentenceAnalyzer = void 0;
+const effort_1 = require("./effort");
+class SentenceAnalyzer {
+    /**
+     * Analyze effort to construct a set of test sentences
+     */
+    analyzeSentences(metrics, sentences) {
+        return sentences.map((words) => this.analyzeSentence(metrics, words));
+    }
+    /**
+     * Analyze effort to construct a single sentence
+     */
+    analyzeSentence(metrics, words) {
+        const wordEfforts = [];
+        let totalEffort = 0;
+        let typing = false;
+        const missingWords = [];
+        // Create word lookup map
+        const wordMap = new Map();
+        metrics.buttons.forEach((btn) => {
+            const existing = wordMap.get(btn.label.toLowerCase());
+            if (!existing || btn.effort < existing.effort) {
+                wordMap.set(btn.label.toLowerCase(), { effort: btn.effort });
+            }
+        });
+        // Calculate effort for each word
+        words.forEach((word) => {
+            const lowerWord = word.toLowerCase();
+            const found = wordMap.get(lowerWord);
+            if (found) {
+                wordEfforts.push({ word, effort: found.effort, typed: false });
+                totalEffort += found.effort;
+            }
+            else {
+                // Word not found - use spelling effort
+                const spellEffort = (0, effort_1.spellingEffort)(word);
+                wordEfforts.push({ word, effort: spellEffort, typed: true });
+                totalEffort += spellEffort;
+                typing = true;
+                missingWords.push(word);
+            }
+        });
+        const averageEffort = totalEffort / words.length;
+        // Reconstruct sentence for display
+        const sentence = this.reconstructSentence(words);
+        return {
+            sentence,
+            words,
+            effort: averageEffort,
+            total_effort: totalEffort,
+            typing,
+            missing_words: missingWords,
+            word_efforts: wordEfforts,
+        };
+    }
+    /**
+     * Reconstruct sentence from word array
+     */
+    reconstructSentence(words) {
+        return words
+            .map((word, idx) => {
+            // Capitalize first word
+            if (idx === 0) {
+                return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+            }
+            return word.toLowerCase();
+        })
+            .join(' ');
+    }
+    /**
+     * Calculate statistics across all sentences
+     */
+    calculateStatistics(analyses) {
+        const totalSentences = analyses.length;
+        const sentencesRequiringTyping = analyses.filter((a) => a.typing).length;
+        const sentencesWithoutTyping = totalSentences - sentencesRequiringTyping;
+        const efforts = analyses.map((a) => a.effort);
+        const averageEffort = efforts.reduce((sum, e) => sum + e, 0) / efforts.length;
+        const minEffort = Math.min(...efforts);
+        const maxEffort = Math.max(...efforts);
+        // Calculate median
+        const sortedEfforts = [...efforts].sort((a, b) => a - b);
+        const medianEffort = sortedEfforts.length % 2 === 0
+            ? (sortedEfforts[sortedEfforts.length / 2 - 1] + sortedEfforts[sortedEfforts.length / 2]) /
+                2
+            : sortedEfforts[Math.floor(sortedEfforts.length / 2)];
+        const totalWords = analyses.reduce((sum, a) => sum + a.words.length, 0);
+        const wordsRequiringTyping = analyses.reduce((sum, a) => sum + a.missing_words.length, 0);
+        const typingPercent = (wordsRequiringTyping / totalWords) * 100;
+        return {
+            total_sentences: totalSentences,
+            sentences_requiring_typing: sentencesRequiringTyping,
+            sentences_without_typing: sentencesWithoutTyping,
+            average_effort: averageEffort,
+            min_effort: minEffort,
+            max_effort: maxEffort,
+            median_effort: medianEffort,
+            total_words: totalWords,
+            words_requiring_typing: wordsRequiringTyping,
+            typing_percent: typingPercent,
+        };
+    }
+}
+exports.SentenceAnalyzer = SentenceAnalyzer;

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

@@ -0,0 +1,157 @@
+/**
+ * Metrics Types and Interfaces
+ *
+ * Defines the data structures used for AAC metrics analysis
+ */
+/**
+ * Button-level metrics result
+ */
+export interface ButtonMetrics {
+    id: string;
+    label: string;
+    level: number;
+    effort: number;
+    count?: number;
+    semantic_id?: string;
+    clone_id?: string;
+    temporary_home_id?: string;
+    comp_level?: number;
+    comp_effort?: number;
+}
+/**
+ * Board/page level analysis result
+ */
+export interface BoardAnalysis {
+    boardId: string;
+    level: number;
+    entryX: number;
+    entryY: number;
+    priorEffort?: number;
+    temporaryHomeId?: string;
+}
+/**
+ * Metrics analysis result
+ */
+export interface MetricsResult {
+    analysis_version: string;
+    locale: string;
+    total_boards: number;
+    total_buttons: number;
+    total_words: number;
+    reference_counts: {
+        [id: string]: number;
+    };
+    grid: {
+        rows: number;
+        columns: number;
+    };
+    buttons: ButtonMetrics[];
+    levels: {
+        [level: number]: ButtonMetrics[];
+    };
+    alternates?: {
+        [boardId: string]: AlternateBoardMetrics;
+    };
+    obfset?: any;
+}
+/**
+ * Alternate board metrics (for temporary home navigation)
+ */
+export interface AlternateBoardMetrics {
+    buttons: ButtonMetrics[];
+    levels: {
+        [level: number]: ButtonMetrics[];
+    };
+}
+/**
+ * Comparison result between two board sets
+ */
+export interface ComparisonResult extends MetricsResult {
+    target_effort_score: number;
+    comp_boards: number;
+    comp_buttons: number;
+    comp_words: number;
+    comp_grid: {
+        rows: number;
+        columns: number;
+    };
+    comp_effort_score: number;
+    missing_words: string[];
+    extra_words: string[];
+    overlapping_words: string[];
+    missing: {
+        [listId: string]: {
+            name: string;
+            list: string[];
+        };
+    };
+    high_effort_words: string[];
+    low_effort_words: string[];
+    cores: {
+        [listId: string]: {
+            name: string;
+            list: string[];
+            average_effort: number;
+            comp_effort: number;
+        };
+    };
+    care_components: {
+        core: number;
+        comp_core: number;
+        sentences: number;
+        comp_sentences: number;
+        fringe: number;
+        comp_fringe: number;
+        common_fringe: number;
+        comp_common_fringe: number;
+    };
+    sentences: SentenceAnalysis[];
+    fringe_words: FringeWord[];
+    common_fringe_words: FringeWord[];
+}
+/**
+ * Sentence construction analysis
+ */
+export interface SentenceAnalysis {
+    sentence: string;
+    words: string[];
+    effort: number;
+    typing: boolean;
+    comp_effort: number;
+    comp_typing: boolean;
+}
+/**
+ * Fringe vocabulary word analysis
+ */
+export interface FringeWord {
+    word: string;
+    effort: number;
+    comp_effort: number;
+}
+/**
+ * Core vocabulary list definition
+ */
+export interface CoreList {
+    id: string;
+    name: string;
+    url?: string;
+    locale: string;
+    words: string[];
+}
+/**
+ * Common words reference data
+ */
+export interface CommonWordsData {
+    version: string;
+    files: string[];
+    words: string[];
+    efforts: {
+        [word: string]: number;
+    };
+}
+/**
+ * Synonym mappings
+ */
+export interface SynonymsData {
+    [word: string]: string[];
+}

package/dist/optional/analytics/metrics/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Metrics Types and Interfaces
+ *
+ * Defines the data structures used for AAC metrics analysis
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/optional/analytics/metrics/vocabulary.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Vocabulary Coverage Analysis
+ *
+ * Analyzes how well an AAC board set covers core vocabulary
+ * and identifies missing/extra words compared to reference lists.
+ */
+import { MetricsResult } from './types';
+import { ReferenceLoader } from '../reference/index';
+export interface VocabularyAnalysis {
+    core_coverage: {
+        [listId: string]: {
+            name: string;
+            total_words: number;
+            covered: number;
+            missing: number;
+            coverage_percent: number;
+            missing_words: string[];
+            average_effort: number;
+        };
+    };
+    total_unique_words: number;
+    words_with_effort: number;
+    words_requiring_spelling: number;
+    extra_words: string[];
+    high_effort_words: Array<{
+        word: string;
+        effort: number;
+    }>;
+    low_effort_words: Array<{
+        word: string;
+        effort: number;
+    }>;
+}
+export declare class VocabularyAnalyzer {
+    private referenceLoader;
+    constructor(referenceLoader?: ReferenceLoader);
+    /**
+     * Analyze vocabulary coverage against core lists
+     */
+    analyze(metrics: MetricsResult, options?: {
+        locale?: string;
+        highEffortThreshold?: number;
+        lowEffortThreshold?: number;
+    }): VocabularyAnalysis;
+    /**
+     * Analyze coverage for a single core list
+     */
+    private analyzeCoreList;
+    /**
+     * Calculate coverage percentage for a specific word list
+     */
+    calculateCoverage(wordList: string[], metrics: MetricsResult): {
+        covered: string[];
+        missing: string[];
+        coverage_percent: number;
+    };
+    /**
+     * Get effort for a word, or calculate spelling effort if missing
+     */
+    getWordEffort(word: string, metrics: MetricsResult): number;
+    /**
+     * Check if a word is in the board set
+     */
+    hasWord(word: string, metrics: MetricsResult): boolean;
+}