@willwade/aac-processors 0.0.13 → 0.0.14

package/dist/utilities/translation/translationProcessor.js

@@ -0,0 +1,204 @@
+"use strict";
+/**
+ * LLM-Based Translation with Symbol Preservation
+ *
+ * This module provides utilities for translating AAC files while preserving
+ * symbol-to-word associations across different formats (gridset, OBF, Snap, etc.).
+ *
+ * The key insight: Different AAC formats have different internal structures,
+ * but they all share common concepts:
+ * - Buttons with labels and messages
+ * - Symbols attached to specific words
+ * - Need to preserve symbol positions during translation
+ *
+ * This module provides a format-agnostic way to:
+ * 1. Extract symbol information for LLM processing
+ * 2. Apply LLM translations with preserved symbols
+ *
+ * Usage:
+ * 1. Processor extracts buttons and calls extractSymbolsForLLM()
+ * 2. LLM translates and returns aligned symbols
+ * 3. Processor calls processLLMTranslations() to apply results
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeButtonForTranslation = normalizeButtonForTranslation;
+exports.extractSymbolsFromButton = extractSymbolsFromButton;
+exports.extractAllButtonsForTranslation = extractAllButtonsForTranslation;
+exports.createTranslationPrompt = createTranslationPrompt;
+exports.validateTranslationResults = validateTranslationResults;
+/**
+ * Extract symbols from a button for LLM-based translation.
+ *
+ * This is a format-agnostic helper that processors can use to normalize
+ * their button data into a common format for LLM processing.
+ *
+ * @param buttonId - Unique identifier for the button
+ * @param label - Button label text
+ * @param message - Button message/speak text
+ * @param symbols - Array of symbols from the button
+ * @param context - Optional page context
+ * @returns Normalized button data for translation
+ */
+function normalizeButtonForTranslation(buttonId, label, message, symbols, context) {
+    return {
+        buttonId,
+        label,
+        message,
+        textToTranslate: message || label, // Translate message if present, otherwise label
+        symbols,
+        ...context,
+    };
+}
+/**
+ * Extract symbols from various button formats.
+ *
+ * This helper handles different ways symbols might be stored in button data:
+ * - semanticAction.richText.symbols (gridset format)
+ * - symbolLibrary + symbolPath fields
+ * - image field with [library]path format
+ *
+ * @param button - Button object from any AAC format
+ * @returns Array of symbol info, or undefined if no symbols
+ */
+function extractSymbolsFromButton(button) {
+    const symbols = [];
+    // Method 1: Check for semanticAction.richText.symbols (gridset format)
+    if (button.semanticAction?.richText?.symbols) {
+        const richTextSymbols = button.semanticAction.richText.symbols;
+        if (Array.isArray(richTextSymbols) && richTextSymbols.length > 0) {
+            symbols.push(...richTextSymbols);
+            return symbols;
+        }
+    }
+    // Determine the text to attach symbol to
+    const text = button.label || button.message || '';
+    if (!text) {
+        return undefined;
+    }
+    // Method 2: Check for symbolLibrary + symbolPath fields
+    if (button.symbolLibrary && button.symbolPath) {
+        symbols.push({
+            text,
+            image: `[${button.symbolLibrary}]${button.symbolPath}`,
+            symbolLibrary: button.symbolLibrary,
+            symbolPath: button.symbolPath,
+        });
+        return symbols;
+    }
+    // Method 3: Check if image field contains a symbol reference
+    if (button.image && typeof button.image === 'string' && button.image.startsWith('[')) {
+        symbols.push({
+            text,
+            image: button.image,
+        });
+        return symbols;
+    }
+    // No symbols found
+    return undefined;
+}
+/**
+ * Extract all buttons from a file for LLM translation.
+ *
+ * This is a convenience method that processors can use to extract all
+ * translatable buttons with their symbols in a format-agnostic way.
+ *
+ * @param buttons - Array of button objects from any AAC format
+ * @param contextFn - Optional function to provide page context for each button
+ * @returns Array of normalized button data ready for LLM translation
+ */
+function extractAllButtonsForTranslation(buttons, contextFn) {
+    const results = [];
+    for (const button of buttons) {
+        if (!button)
+            continue;
+        const buttonId = (button.id || button.buttonId || `button_${results.length}`);
+        const label = (button.label || '');
+        const message = (button.message || '');
+        const symbols = extractSymbolsFromButton(button);
+        // Only include buttons that have text to translate
+        if (!label && !message)
+            continue;
+        const context = contextFn ? contextFn(button) : undefined;
+        results.push(normalizeButtonForTranslation(buttonId, label, message, symbols || [], context));
+    }
+    return results;
+}
+/**
+ * Create a prompt for LLM translation with symbol preservation.
+ *
+ * This generates a structured prompt that instructs the LLM to translate
+ * while preserving symbol-to-word associations.
+ *
+ * @param buttons - Buttons to translate
+ * @param targetLanguage - Target language for translation
+ * @returns Prompt string for LLM
+ */
+function createTranslationPrompt(buttons, targetLanguage) {
+    const buttonsData = JSON.stringify(buttons, null, 2);
+    return `You are a translation assistant for AAC (Augmentative and Alternative Communication) systems.
+
+Your task is to translate the following buttons to ${targetLanguage} while preserving symbol associations.
+
+Each button has:
+- label: The text shown on the button
+- message: The text spoken when the button is activated
+- textToTranslate: The actual text to translate (usually the message)
+- symbols: Visual symbols attached to specific words
+
+IMPORTANT: After translation, you MUST reattach symbols to the correct translated words based on MEANING, not position.
+
+Example:
+- Original: "I want apple" with apple symbol on "apple"
+- Spanish: "Yo quiero manzana" with apple symbol on "manzana" (NOT "Yo" or "quiero")
+- French: "Je veux une pomme" with apple symbol on "pomme"
+
+The symbols array should contain the translated word that each symbol should be attached to.
+
+Buttons to translate:
+${buttonsData}
+
+Return ONLY a JSON array with this exact structure:
+[
+  {
+    "buttonId": "...",
+    "translatedLabel": "...",
+    "translatedMessage": "...",
+    "symbols": [
+      {"text": "translated_word", "image": "[library]path"}
+    ]
+  }
+]
+
+Ensure all symbol image references are preserved exactly as provided.`;
+}
+/**
+ * Validate LLM translation results before applying.
+ *
+ * @param translations - LLM translation results
+ * @param originalButtonIds - Expected button IDs (optional, for validation)
+ * @param options - Validation options
+ * @throws Error if validation fails
+ */
+function validateTranslationResults(translations, originalButtonIds, options) {
+    if (!Array.isArray(translations)) {
+        throw new Error('Translation results must be an array');
+    }
+    const translatedIds = new Set(translations.map((t) => t.buttonId));
+    // Check that all original buttons have translations (unless partial is allowed)
+    if (originalButtonIds && !options?.allowPartial) {
+        for (const id of originalButtonIds) {
+            if (!translatedIds.has(id)) {
+                throw new Error(`Missing translation for button: ${id}`);
+            }
+        }
+    }
+    // Check each translation has required fields
+    for (const trans of translations) {
+        if (!trans.buttonId) {
+            throw new Error('Translation missing buttonId');
+        }
+        if (!trans.translatedMessage && !trans.translatedLabel) {
+            throw new Error(`Translation for ${trans.buttonId} has no translated text`);
+        }
+    }
+}

package/package.json

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