@willwade/aac-processors 0.0.4 → 0.0.6

package/dist/processors/excelProcessor.js

@@ -32,7 +32,6 @@ const path_1 = __importDefault(require("path"));
 const ExcelJS = __importStar(require("exceljs"));
 const baseProcessor_1 = require("../core/baseProcessor");
 const treeStructure_1 = require("../core/treeStructure");
-const treeStructure_2 = require("../core/treeStructure");
 /**
  * Excel Processor for converting AAC grids to Excel format
  * Converts AAC tree structures to Excel workbooks with each page as a worksheet
@@ -44,47 +43,18 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param filePathOrBuffer - Path to Excel file or Buffer containing Excel data
      * @returns Array of all text content found in the Excel file
      */
-    extractTexts(filePathOrBuffer) {
-        const texts = [];
-        try {
-            const workbook = new ExcelJS.Workbook();
-            if (Buffer.isBuffer(filePathOrBuffer)) {
-                // For buffer input, we need to read it differently
-                // This is a placeholder - actual implementation would need to handle buffer reading
-                throw new Error('Buffer input not yet implemented for Excel files');
-            }
-            else {
-                // Read from file path
-                if (!fs_1.default.existsSync(filePathOrBuffer)) {
-                    return texts;
-                }
-                // Note: ExcelJS readFile is async, but we need sync for this interface
-                // This is a limitation that would need to be addressed in a real implementation
-                throw new Error('Synchronous Excel reading not yet implemented');
-            }
-        }
-        catch (error) {
-            console.warn(`Failed to extract texts from Excel file: ${error}`);
-            return texts;
-        }
+    extractTexts(_filePathOrBuffer) {
+        console.warn('ExcelProcessor.extractTexts is not implemented yet.');
+        return [];
     }
     /**
      * Load Excel file into AACTree structure
      * @param filePathOrBuffer - Path to Excel file or Buffer containing Excel data
      * @returns AACTree representation of the Excel file
      */
-    loadIntoTree(filePathOrBuffer) {
-        const tree = new treeStructure_1.AACTree();
-        try {
-            // For now, return empty tree as Excel -> AAC conversion is not the primary use case
-            // This would be implemented if bidirectional conversion is needed
-            console.warn('Excel to AAC conversion not implemented - returning empty tree');
-            return tree;
-        }
-        catch (error) {
-            console.warn(`Failed to load Excel file into tree: ${error}`);
-            return tree;
-        }
+    loadIntoTree(_filePathOrBuffer) {
+        console.warn('ExcelProcessor.loadIntoTree is not implemented yet.');
+        return new treeStructure_1.AACTree();
     }
     /**
      * Process texts in Excel file (apply translations)
@@ -93,18 +63,13 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param outputPath - Path where translated Excel file should be saved
      * @returns Buffer containing the translated Excel file
      */
-    processTexts(filePathOrBuffer, translations, outputPath) {
-        try {
-            // Load the Excel file, apply translations, and save
-            // This would involve reading the Excel file, finding text cells,
-            // applying translations, and saving to outputPath
-            throw new Error('Excel text processing not yet implemented');
-        }
-        catch (error) {
-            console.warn(`Failed to process Excel texts: ${error}`);
-            // Return empty buffer as fallback
-            return Buffer.alloc(0);
+    processTexts(_filePathOrBuffer, _translations, outputPath) {
+        console.warn('ExcelProcessor.processTexts is not implemented yet.');
+        const outputDir = path_1.default.dirname(outputPath);
+        if (!fs_1.default.existsSync(outputDir)) {
+            fs_1.default.mkdirSync(outputDir, { recursive: true });
         }
+        return Buffer.alloc(0);
     }
     /**
      * Convert an AAC page to an Excel worksheet
@@ -113,7 +78,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param tree - Full AAC tree for navigation context
      * @param usedNames - Set of already used worksheet names to avoid duplicates
      */
-    async convertPageToWorksheet(workbook, page, tree, usedNames = new Set()) {
+    convertPageToWorksheet(workbook, page, tree, usedNames = new Set()) {
         // Create worksheet with page name (sanitized for Excel and unique)
         const worksheetName = this.getUniqueWorksheetName(page.name || page.id, usedNames);
         const worksheet = workbook.addWorksheet(worksheetName);
@@ -122,16 +87,16 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
         // Add navigation row if enabled (optional feature)
         let startRow = 1;
         if (this.shouldAddNavigationRow()) {
-            await this.addNavigationRow(worksheet, page, tree);
+            this.addNavigationRow(worksheet, page, tree);
             startRow = 2; // Start content after navigation row
         }
         // Convert grid layout if available
         if (page.grid && page.grid.length > 0) {
-            await this.convertGridLayout(worksheet, page.grid, startRow);
+            this.convertGridLayout(worksheet, page.grid, startRow);
         }
         else {
             // Convert button list to grid layout
-            await this.convertButtonsToGrid(worksheet, page.buttons, rows, cols, startRow);
+            this.convertButtonsToGrid(worksheet, page.buttons, rows, cols, startRow);
         }
         // Apply worksheet formatting
         this.formatWorksheet(worksheet, rows, cols, startRow);
@@ -165,14 +130,14 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param grid - 2D array of AAC buttons
      * @param startRow - Starting row number
      */
-    async convertGridLayout(worksheet, grid, startRow) {
+    convertGridLayout(worksheet, grid, startRow) {
         for (let row = 0; row < grid.length; row++) {
             for (let col = 0; col < grid[row].length; col++) {
                 const button = grid[row][col];
                 if (button) {
                     const excelRow = startRow + row;
                     const excelCol = col + 1; // Excel columns are 1-based
-                    await this.setButtonCell(worksheet, button, excelRow, excelCol);
+                    this.setButtonCell(worksheet, button, excelRow, excelCol);
                 }
             }
         }
@@ -185,7 +150,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param cols - Number of columns in grid
      * @param startRow - Starting row number
      */
-    async convertButtonsToGrid(worksheet, buttons, rows, cols, startRow) {
+    convertButtonsToGrid(worksheet, buttons, rows, cols, startRow) {
         for (let i = 0; i < buttons.length; i++) {
             const button = buttons[i];
             const row = Math.floor(i / cols);
@@ -193,7 +158,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
             if (row < rows) {
                 const excelRow = startRow + row;
                 const excelCol = col + 1; // Excel columns are 1-based
-                await this.setButtonCell(worksheet, button, excelRow, excelCol);
+                this.setButtonCell(worksheet, button, excelRow, excelCol);
             }
         }
     }
@@ -204,7 +169,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param row - Excel row number
      * @param col - Excel column number
      */
-    async setButtonCell(worksheet, button, row, col) {
+    setButtonCell(worksheet, button, row, col) {
         const cell = worksheet.getCell(row, col);
         // Set cell value to button label
         cell.value = button.label || '';
@@ -217,7 +182,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
             this.applyCellStyling(cell, button.style);
         }
         // Add navigation link if this is a navigation button
-        if (button.semanticAction?.intent === treeStructure_2.AACSemanticIntent.NAVIGATE_TO && button.targetPageId) {
+        if (button.semanticAction?.intent === treeStructure_1.AACSemanticIntent.NAVIGATE_TO && button.targetPageId) {
             this.addNavigationLink(cell, button.targetPageId);
         }
         // Set cell size for better visibility
@@ -229,14 +194,16 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param style - AAC style object
      */
     applyCellStyling(cell, style) {
-        const fill = {};
+        let fill;
         const font = {};
-        const border = {};
+        let border;
         // Background color
         if (style.backgroundColor) {
-            fill.type = 'pattern';
-            fill.pattern = 'solid';
-            fill.fgColor = { argb: this.convertColorToArgb(style.backgroundColor) };
+            fill = {
+                type: 'pattern',
+                pattern: 'solid',
+                fgColor: { argb: this.convertColorToArgb(style.backgroundColor) },
+            };
         }
         // Font color
         if (style.fontColor) {
@@ -263,24 +230,27 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
             font.underline = true;
         }
         // Border
-        if (style.borderColor || style.borderWidth) {
-            const borderStyle = style.borderWidth > 1 ? 'thick' : 'thin';
+        if (style.borderColor || typeof style.borderWidth === 'number') {
+            const borderWidth = style.borderWidth ?? 1;
+            const borderStyle = borderWidth > 1 ? 'thick' : 'thin';
             const borderColor = style.borderColor
                 ? { argb: this.convertColorToArgb(style.borderColor) }
                 : { argb: 'FF000000' }; // Default black
-            border.top = { style: borderStyle, color: borderColor };
-            border.left = { style: borderStyle, color: borderColor };
-            border.bottom = { style: borderStyle, color: borderColor };
-            border.right = { style: borderStyle, color: borderColor };
+            border = {
+                top: { style: borderStyle, color: borderColor },
+                left: { style: borderStyle, color: borderColor },
+                bottom: { style: borderStyle, color: borderColor },
+                right: { style: borderStyle, color: borderColor },
+            };
         }
         // Apply styling to cell
-        if (Object.keys(fill).length > 0) {
+        if (fill) {
             cell.fill = fill;
         }
         if (Object.keys(font).length > 0) {
             cell.font = font;
         }
-        if (Object.keys(border).length > 0) {
+        if (border) {
             cell.border = border;
         }
         // Center align text
@@ -369,7 +339,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
      * @param page - Current AAC page
      * @param tree - Full AAC tree for navigation context
      */
-    async addNavigationRow(worksheet, page, tree) {
+    addNavigationRow(worksheet, page, tree) {
         const navButtons = ExcelProcessor.NAVIGATION_BUTTONS;
         for (let i = 0; i < navButtons.length; i++) {
             const cell = worksheet.getCell(1, i + 1);
@@ -440,9 +410,9 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
         // - Max 31 characters
         // - Cannot contain: \ / ? * [ ] :
         // - Cannot be empty
-        const cleaned = (name || '')
-            .replace(/[\\\/\?\*\[\]:]/g, '_')
-            .substring(0, 31);
+        let cleaned = (name || '').replace(/[\\/?*:]/g, '_');
+        cleaned = cleaned.replace(/\[/g, '_').replace(/\]/g, '_');
+        cleaned = cleaned.substring(0, 31);
         if (cleaned.length === 0) {
             return 'Sheet1';
         }
@@ -499,11 +469,12 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
             await this.saveFromTreeAsync(tree, outputPath);
         }
         catch (error) {
-            console.error('Failed to save Excel file:', error);
+            const message = error instanceof Error ? error.message : String(error);
+            console.error('Failed to save Excel file:', message);
             try {
                 const fallbackPath = outputPath.replace(/\.xlsx$/i, '_error.txt');
                 fs_1.default.mkdirSync(path_1.default.dirname(fallbackPath), { recursive: true });
-                fs_1.default.writeFileSync(fallbackPath, `Error saving Excel file: ${error?.message || String(error)}`);
+                fs_1.default.writeFileSync(fallbackPath, `Error saving Excel file: ${message}`);
             }
             catch (writeError) {
                 console.error('Failed to write Excel error file:', writeError);
@@ -532,7 +503,7 @@ class ExcelProcessor extends baseProcessor_1.BaseProcessor {
         // Convert each AAC page to an Excel worksheet
         for (const pageId in tree.pages) {
             const page = tree.pages[pageId];
-            await this.convertPageToWorksheet(workbook, page, tree, usedNames);
+            this.convertPageToWorksheet(workbook, page, tree, usedNames);
         }
         // Save the workbook
         await workbook.xlsx.writeFile(outputPath);

package/dist/processors/gridset/styleHelpers.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Grid3 Style Helpers
+ *
+ * Utilities for creating and managing Grid3 styles, including default styles,
+ * style XML generation, and style conversion utilities.
+ */
+/**
+ * Grid3 Style object structure
+ */
+export interface Grid3Style {
+    BackColour?: string;
+    TileColour?: string;
+    BorderColour?: string;
+    FontColour?: string;
+    FontName?: string;
+    FontSize?: string | number;
+}
+/**
+ * Default Grid3 styles for common use cases
+ * Colors are in 8-digit ARGB hex format (#AARRGGBBFF)
+ */
+export declare const DEFAULT_GRID3_STYLES: Record<string, Grid3Style>;
+/**
+ * Category-specific styles for navigation and organization
+ */
+export declare const CATEGORY_STYLES: Record<string, Grid3Style>;
+/**
+ * Ensure a color has an alpha channel (Grid3 format requires 8-digit ARGB)
+ * @param color - Color string (hex format)
+ * @returns Color with alpha channel in format #AARRGGBBFF
+ */
+export declare function ensureAlphaChannel(color: string | undefined): string;
+/**
+ * Create a Grid3 style XML string with default and category styles
+ * @param includeCategories - Whether to include category-specific styles (default: true)
+ * @returns XML string for Settings0/styles.xml
+ */
+export declare function createDefaultStylesXml(includeCategories?: boolean): string;
+/**
+ * Create a custom category style
+ * @param categoryName - Name of the category
+ * @param backgroundColor - Background color in hex format
+ * @param fontColor - Font color in hex format (default: white)
+ * @returns Grid3Style object
+ */
+export declare function createCategoryStyle(categoryName: string, backgroundColor: string, fontColor?: string): Grid3Style;

package/dist/processors/gridset/styleHelpers.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * Grid3 Style Helpers
+ *
+ * Utilities for creating and managing Grid3 styles, including default styles,
+ * style XML generation, and style conversion utilities.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CATEGORY_STYLES = exports.DEFAULT_GRID3_STYLES = void 0;
+exports.ensureAlphaChannel = ensureAlphaChannel;
+exports.createDefaultStylesXml = createDefaultStylesXml;
+exports.createCategoryStyle = createCategoryStyle;
+const fast_xml_parser_1 = require("fast-xml-parser");
+/**
+ * Default Grid3 styles for common use cases
+ * Colors are in 8-digit ARGB hex format (#AARRGGBBFF)
+ */
+exports.DEFAULT_GRID3_STYLES = {
+    Default: {
+        BackColour: '#E2EDF8FF',
+        TileColour: '#FFFFFFFF',
+        BorderColour: '#000000FF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    Workspace: {
+        BackColour: '#FFFFFFFF',
+        TileColour: '#FFFFFFFF',
+        BorderColour: '#CCCCCCFF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '14',
+    },
+    'Auto content': {
+        BackColour: '#E8F4F8FF',
+        TileColour: '#E8F4F8FF',
+        BorderColour: '#2C82C9FF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '14',
+    },
+    'Vocab cell': {
+        BackColour: '#E8F4F8FF',
+        TileColour: '#E8F4F8FF',
+        BorderColour: '#2C82C9FF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '14',
+    },
+    'Keyboard key': {
+        BackColour: '#F0F0F0FF',
+        TileColour: '#F0F0F0FF',
+        BorderColour: '#808080FF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '12',
+    },
+};
+/**
+ * Category-specific styles for navigation and organization
+ */
+exports.CATEGORY_STYLES = {
+    'Actions category style': {
+        BackColour: '#4472C4FF',
+        TileColour: '#4472C4FF',
+        BorderColour: '#2F5496FF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'People category style': {
+        BackColour: '#ED7D31FF',
+        TileColour: '#ED7D31FF',
+        BorderColour: '#C65911FF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'Places category style': {
+        BackColour: '#A5A5A5FF',
+        TileColour: '#A5A5A5FF',
+        BorderColour: '#595959FF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'Descriptive category style': {
+        BackColour: '#70AD47FF',
+        TileColour: '#70AD47FF',
+        BorderColour: '#4F7C2FFF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'Social category style': {
+        BackColour: '#FFC000FF',
+        TileColour: '#FFC000FF',
+        BorderColour: '#BF8F00FF',
+        FontColour: '#000000FF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'Questions category style': {
+        BackColour: '#5B9BD5FF',
+        TileColour: '#5B9BD5FF',
+        BorderColour: '#2E5C8AFF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+    'Little words category style': {
+        BackColour: '#C55A11FF',
+        TileColour: '#C55A11FF',
+        BorderColour: '#8B3F0AFF',
+        FontColour: '#FFFFFFFF',
+        FontName: 'Arial',
+        FontSize: '16',
+    },
+};
+/**
+ * Ensure a color has an alpha channel (Grid3 format requires 8-digit ARGB)
+ * @param color - Color string (hex format)
+ * @returns Color with alpha channel in format #AARRGGBBFF
+ */
+function ensureAlphaChannel(color) {
+    if (!color)
+        return '#FFFFFFFF';
+    // If already 8 digits (with alpha), return as is
+    if (color.match(/^#[0-9A-Fa-f]{8}$/))
+        return color;
+    // If 6 digits (no alpha), add FF for fully opaque
+    if (color.match(/^#[0-9A-Fa-f]{6}$/))
+        return color + 'FF';
+    // If 3 digits (shorthand), expand to 8
+    if (color.match(/^#[0-9A-Fa-f]{3}$/)) {
+        const r = color[1];
+        const g = color[2];
+        const b = color[3];
+        return `#${r}${r}${g}${g}${b}${b}FF`;
+    }
+    // Invalid or unknown format, return white
+    return '#FFFFFFFF';
+}
+/**
+ * Create a Grid3 style XML string with default and category styles
+ * @param includeCategories - Whether to include category-specific styles (default: true)
+ * @returns XML string for Settings0/styles.xml
+ */
+function createDefaultStylesXml(includeCategories = true) {
+    const builder = new fast_xml_parser_1.XMLBuilder({
+        ignoreAttributes: false,
+        format: true,
+        indentBy: '  ',
+    });
+    const styles = { ...exports.DEFAULT_GRID3_STYLES };
+    if (includeCategories) {
+        Object.assign(styles, exports.CATEGORY_STYLES);
+    }
+    const styleArray = Object.entries(styles).map(([key, style]) => ({
+        '@_Key': key,
+        BackColour: style.BackColour,
+        TileColour: style.TileColour,
+        BorderColour: style.BorderColour,
+        FontColour: style.FontColour,
+        FontName: style.FontName,
+        FontSize: style.FontSize?.toString(),
+    }));
+    const stylesData = {
+        StyleData: {
+            '@_xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
+            Styles: {
+                Style: styleArray,
+            },
+        },
+    };
+    return builder.build(stylesData);
+}
+/**
+ * Create a custom category style
+ * @param categoryName - Name of the category
+ * @param backgroundColor - Background color in hex format
+ * @param fontColor - Font color in hex format (default: white)
+ * @returns Grid3Style object
+ */
+function createCategoryStyle(categoryName, backgroundColor, fontColor = '#FFFFFFFF') {
+    return {
+        BackColour: ensureAlphaChannel(backgroundColor),
+        TileColour: ensureAlphaChannel(backgroundColor),
+        BorderColour: ensureAlphaChannel(darkenColor(backgroundColor, 30)),
+        FontColour: ensureAlphaChannel(fontColor),
+        FontName: 'Arial',
+        FontSize: '16',
+    };
+}
+/**
+ * Darken a hex color by a given amount
+ * @param hexColor - Hex color string
+ * @param amount - Amount to darken (0-255)
+ * @returns Darkened hex color
+ */
+function darkenColor(hexColor, amount) {
+    const normalized = ensureAlphaChannel(hexColor);
+    const hex = normalized.slice(1, 7); // Extract RGB part (skip # and alpha)
+    const num = parseInt(hex, 16);
+    const clamp = (value) => Math.max(0, Math.min(255, value));
+    const r = clamp(((num >> 16) & 0xff) - amount);
+    const g = clamp(((num >> 8) & 0xff) - amount);
+    const b = clamp((num & 0xff) - amount);
+    return `#${((1 << 24) + (r << 16) + (g << 8) + b).toString(16).slice(1)}`;
+}

package/dist/processors/gridset/wordlistHelpers.js

@@ -49,7 +49,7 @@ function createWordlist(input) {
     }
     else if (typeof input === 'object') {
         // Handle dictionary/object input
-        items = Object.entries(input).map(([key, value]) => {
+        items = Object.entries(input).map(([, value]) => {
             if (typeof value === 'string') {
                 return { text: value };
             }
@@ -222,7 +222,8 @@ function updateWordlist(gridsetBuffer, gridName, wordlist) {
                     found = true;
                 }
                 catch (error) {
-                    throw new Error(`Failed to update wordlist in grid "${gridName}": ${error}`);
+                    const message = error instanceof Error ? error.message : String(error);
+                    throw new Error(`Failed to update wordlist in grid "${gridName}": ${message}`);
                 }
             }
         }