@willwade/aac-processors 0.0.6 → 0.0.8

package/dist/processors/gridset/colorUtils.js

@@ -0,0 +1,331 @@
+"use strict";
+/**
+ * Grid3 Color Utilities
+ *
+ * Comprehensive color handling for Grid3 format, including:
+ * - CSS color name lookup (147 named colors)
+ * - Color format conversion (hex, RGB, RGBA, named colors)
+ * - Color manipulation (darkening, normalization)
+ * - Grid3-specific color formatting (8-digit ARGB hex)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNamedColor = getNamedColor;
+exports.rgbaToHex = rgbaToHex;
+exports.channelToHex = channelToHex;
+exports.clampColorChannel = clampColorChannel;
+exports.clampAlpha = clampAlpha;
+exports.toHexColor = toHexColor;
+exports.darkenColor = darkenColor;
+exports.normalizeColor = normalizeColor;
+exports.ensureAlphaChannel = ensureAlphaChannel;
+/**
+ * CSS color names to RGB values
+ * Supports 147 standard CSS color names
+ */
+const CSS_COLORS = {
+    aliceblue: [240, 248, 255],
+    antiquewhite: [250, 235, 215],
+    aqua: [0, 255, 255],
+    aquamarine: [127, 255, 212],
+    azure: [240, 255, 255],
+    beige: [245, 245, 220],
+    bisque: [255, 228, 196],
+    black: [0, 0, 0],
+    blanchedalmond: [255, 235, 205],
+    blue: [0, 0, 255],
+    blueviolet: [138, 43, 226],
+    brown: [165, 42, 42],
+    burlywood: [222, 184, 135],
+    cadetblue: [95, 158, 160],
+    chartreuse: [127, 255, 0],
+    chocolate: [210, 105, 30],
+    coral: [255, 127, 80],
+    cornflowerblue: [100, 149, 237],
+    cornsilk: [255, 248, 220],
+    crimson: [220, 20, 60],
+    cyan: [0, 255, 255],
+    darkblue: [0, 0, 139],
+    darkcyan: [0, 139, 139],
+    darkgoldenrod: [184, 134, 11],
+    darkgray: [169, 169, 169],
+    darkgreen: [0, 100, 0],
+    darkgrey: [169, 169, 169],
+    darkkhaki: [189, 183, 107],
+    darkmagenta: [139, 0, 139],
+    darkolivegreen: [85, 107, 47],
+    darkorange: [255, 140, 0],
+    darkorchid: [153, 50, 204],
+    darkred: [139, 0, 0],
+    darksalmon: [233, 150, 122],
+    darkseagreen: [143, 188, 143],
+    darkslateblue: [72, 61, 139],
+    darkslategray: [47, 79, 79],
+    darkslategrey: [47, 79, 79],
+    darkturquoise: [0, 206, 209],
+    darkviolet: [148, 0, 211],
+    deeppink: [255, 20, 147],
+    deepskyblue: [0, 191, 255],
+    dimgray: [105, 105, 105],
+    dimgrey: [105, 105, 105],
+    dodgerblue: [30, 144, 255],
+    firebrick: [178, 34, 34],
+    floralwhite: [255, 250, 240],
+    forestgreen: [34, 139, 34],
+    fuchsia: [255, 0, 255],
+    gainsboro: [220, 220, 220],
+    ghostwhite: [248, 248, 255],
+    gold: [255, 215, 0],
+    goldenrod: [218, 165, 32],
+    gray: [128, 128, 128],
+    grey: [128, 128, 128],
+    green: [0, 128, 0],
+    greenyellow: [173, 255, 47],
+    honeydew: [240, 255, 240],
+    hotpink: [255, 105, 180],
+    indianred: [205, 92, 92],
+    indigo: [75, 0, 130],
+    ivory: [255, 255, 240],
+    khaki: [240, 230, 140],
+    lavender: [230, 230, 250],
+    lavenderblush: [255, 240, 245],
+    lawngreen: [124, 252, 0],
+    lemonchiffon: [255, 250, 205],
+    lightblue: [173, 216, 230],
+    lightcoral: [240, 128, 128],
+    lightcyan: [224, 255, 255],
+    lightgoldenrodyellow: [250, 250, 210],
+    lightgray: [211, 211, 211],
+    lightgreen: [144, 238, 144],
+    lightgrey: [211, 211, 211],
+    lightpink: [255, 182, 193],
+    lightsalmon: [255, 160, 122],
+    lightseagreen: [32, 178, 170],
+    lightskyblue: [135, 206, 250],
+    lightslategray: [119, 136, 153],
+    lightslategrey: [119, 136, 153],
+    lightsteelblue: [176, 196, 222],
+    lightyellow: [255, 255, 224],
+    lime: [0, 255, 0],
+    limegreen: [50, 205, 50],
+    linen: [250, 240, 230],
+    magenta: [255, 0, 255],
+    maroon: [128, 0, 0],
+    mediumaquamarine: [102, 205, 170],
+    mediumblue: [0, 0, 205],
+    mediumorchid: [186, 85, 211],
+    mediumpurple: [147, 112, 219],
+    mediumseagreen: [60, 179, 113],
+    mediumslateblue: [123, 104, 238],
+    mediumspringgreen: [0, 250, 154],
+    mediumturquoise: [72, 209, 204],
+    mediumvioletred: [199, 21, 133],
+    midnightblue: [25, 25, 112],
+    mintcream: [245, 255, 250],
+    mistyrose: [255, 228, 225],
+    moccasin: [255, 228, 181],
+    navajowhite: [255, 222, 173],
+    navy: [0, 0, 128],
+    oldlace: [253, 245, 230],
+    olive: [128, 128, 0],
+    olivedrab: [107, 142, 35],
+    orange: [255, 165, 0],
+    orangered: [255, 69, 0],
+    orchid: [218, 112, 214],
+    palegoldenrod: [238, 232, 170],
+    palegreen: [152, 251, 152],
+    paleturquoise: [175, 238, 238],
+    palevioletred: [219, 112, 147],
+    papayawhip: [255, 239, 213],
+    peachpuff: [255, 218, 185],
+    peru: [205, 133, 63],
+    pink: [255, 192, 203],
+    plum: [221, 160, 221],
+    powderblue: [176, 224, 230],
+    purple: [128, 0, 128],
+    rebeccapurple: [102, 51, 153],
+    red: [255, 0, 0],
+    rosybrown: [188, 143, 143],
+    royalblue: [65, 105, 225],
+    saddlebrown: [139, 69, 19],
+    salmon: [250, 128, 114],
+    sandybrown: [244, 164, 96],
+    seagreen: [46, 139, 87],
+    seashell: [255, 245, 238],
+    sienna: [160, 82, 45],
+    silver: [192, 192, 192],
+    skyblue: [135, 206, 235],
+    slateblue: [106, 90, 205],
+    slategray: [112, 128, 144],
+    slategrey: [112, 128, 144],
+    snow: [255, 250, 250],
+    springgreen: [0, 255, 127],
+    steelblue: [70, 130, 180],
+    tan: [210, 180, 140],
+    teal: [0, 128, 128],
+    thistle: [216, 191, 216],
+    tomato: [255, 99, 71],
+    turquoise: [64, 224, 208],
+    violet: [238, 130, 238],
+    wheat: [245, 222, 179],
+    white: [255, 255, 255],
+    whitesmoke: [245, 245, 245],
+    yellow: [255, 255, 0],
+    yellowgreen: [154, 205, 50],
+};
+/**
+ * Get RGB values for a CSS color name
+ * @param name - CSS color name (case-insensitive)
+ * @returns RGB tuple [r, g, b] or undefined if not found
+ */
+function getNamedColor(name) {
+    const color = CSS_COLORS[name.toLowerCase()];
+    return color;
+}
+/**
+ * Convert RGBA values to hex format
+ * @param r - Red channel (0-255)
+ * @param g - Green channel (0-255)
+ * @param b - Blue channel (0-255)
+ * @param a - Alpha channel (0-1)
+ * @returns Hex color string in format #RRGGBBAA
+ */
+function rgbaToHex(r, g, b, a) {
+    const red = channelToHex(r);
+    const green = channelToHex(g);
+    const blue = channelToHex(b);
+    const alpha = channelToHex(Math.round(a * 255));
+    return `#${red}${green}${blue}${alpha}`;
+}
+/**
+ * Convert a single color channel value to hex
+ * @param value - Channel value (0-255)
+ * @returns Two-digit hex string
+ */
+function channelToHex(value) {
+    const clamped = Math.max(0, Math.min(255, Math.round(value)));
+    return clamped.toString(16).padStart(2, '0').toUpperCase();
+}
+/**
+ * Clamp RGB channel value to valid range
+ * @param value - Channel value
+ * @returns Clamped value (0-255)
+ */
+function clampColorChannel(value) {
+    if (Number.isNaN(value)) {
+        return 0;
+    }
+    return Math.max(0, Math.min(255, value));
+}
+/**
+ * Clamp alpha value to valid range
+ * @param value - Alpha value
+ * @returns Clamped value (0-1)
+ */
+function clampAlpha(value) {
+    if (Number.isNaN(value)) {
+        return 1;
+    }
+    return Math.max(0, Math.min(1, value));
+}
+/**
+ * Convert any color format to hex
+ * Supports: hex (#RGB, #RRGGBB, #RRGGBBAA), RGB/RGBA, and CSS color names
+ * @param value - Color string in any supported format
+ * @returns Hex color string (#RRGGBBAA) or undefined if invalid
+ */
+function toHexColor(value) {
+    // Try hex format
+    const hexMatch = value.match(/^#([0-9a-f]{3}|[0-9a-f]{4}|[0-9a-f]{6}|[0-9a-f]{8})$/i);
+    if (hexMatch) {
+        const hex = hexMatch[1];
+        if (hex.length === 3 || hex.length === 4) {
+            return `#${hex
+                .split('')
+                .map((char) => char + char)
+                .join('')}`;
+        }
+        return `#${hex}`;
+    }
+    // Try RGB/RGBA format
+    const rgbMatch = value.match(/^rgba?\((.+)\)$/i);
+    if (rgbMatch) {
+        const parts = rgbMatch[1]
+            .split(',')
+            .map((part) => part.trim())
+            .filter(Boolean);
+        if (parts.length === 3 || parts.length === 4) {
+            const [r, g, b, a] = parts;
+            const red = clampColorChannel(parseFloat(r));
+            const green = clampColorChannel(parseFloat(g));
+            const blue = clampColorChannel(parseFloat(b));
+            const alpha = parts.length === 4 ? clampAlpha(parseFloat(a)) : 1;
+            return rgbaToHex(red, green, blue, alpha);
+        }
+    }
+    // Try CSS color name
+    const rgb = getNamedColor(value);
+    if (rgb) {
+        return rgbaToHex(rgb[0], rgb[1], rgb[2], 1);
+    }
+    return undefined;
+}
+/**
+ * Darken a hex color by a specified amount
+ * @param hex - Hex color string
+ * @param amount - Amount to darken (0-255)
+ * @returns Darkened hex color
+ */
+function darkenColor(hex, amount) {
+    const normalized = ensureAlphaChannel(hex).substring(1); // strip #
+    const rgb = normalized.substring(0, 6);
+    const alpha = normalized.substring(6) || 'FF';
+    const r = parseInt(rgb.substring(0, 2), 16);
+    const g = parseInt(rgb.substring(2, 4), 16);
+    const b = parseInt(rgb.substring(4, 6), 16);
+    const clamp = (val) => Math.max(0, Math.min(255, val));
+    const newR = clamp(r - amount);
+    const newG = clamp(g - amount);
+    const newB = clamp(b - amount);
+    return `#${channelToHex(newR)}${channelToHex(newG)}${channelToHex(newB)}${alpha.toUpperCase()}`;
+}
+/**
+ * Normalize any color format to Grid3's 8-digit hex format
+ * @param input - Color string in any supported format
+ * @param fallback - Fallback color if input is invalid (default: white)
+ * @returns Normalized color in format #AARRGGBBFF
+ */
+function normalizeColor(input, fallback = '#FFFFFFFF') {
+    const trimmed = input.trim();
+    if (!trimmed) {
+        return fallback;
+    }
+    const hex = toHexColor(trimmed);
+    if (hex) {
+        return ensureAlphaChannel(hex).toUpperCase();
+    }
+    return fallback;
+}
+/**
+ * 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';
+}

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

@@ -1,4 +1,129 @@
 import { AACTree } from '../../core/treeStructure';
+/**
+ * Build a map of button IDs to resolved image entry paths for a specific page.
+ * Helpful when rewriting zip entry names or validating images referenced in a grid.
+ */
 export declare function getPageTokenImageMap(tree: AACTree, pageId: string): Map<string, string>;
+/**
+ * Collect all image entries referenced across every page in a tree.
+ * Returns normalized zip entry paths that should be preserved when pruning images.
+ */
 export declare function getAllowedImageEntries(tree: AACTree): Set<string>;
+/**
+ * Read an image entry from a gridset zip by path.
+ * @param gridsetBuffer Gridset archive contents
+ * @param entryPath Entry name inside the zip
+ * @returns Image data buffer or null if not found
+ */
 export declare function openImage(gridsetBuffer: Buffer, entryPath: string): Buffer | null;
+/**
+ * Generate a random GUID for Grid3 elements
+ * Grid3 uses GUIDs for grid identification
+ * @returns A UUID v4-like string in the format xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx
+ */
+export declare function generateGrid3Guid(): string;
+/**
+ * Create Grid3 settings XML with start grid and common settings
+ * @param startGrid - Name of the grid to start on
+ * @param options - Optional settings (scan, hover, language, etc.)
+ * @returns XML string for Settings.xml
+ */
+export declare function createSettingsXml(startGrid: string, options?: {
+    scanEnabled?: boolean;
+    scanTimeoutMs?: number;
+    hoverEnabled?: boolean;
+    hoverTimeoutMs?: number;
+    mouseclickEnabled?: boolean;
+    language?: string;
+}): string;
+/**
+ * Create Grid3 FileMap.xml content
+ * @param grids - Array of grid configurations with name and path
+ * @returns XML string for FileMap.xml
+ */
+export declare function createFileMapXml(grids: Array<{
+    name: string;
+    path: string;
+    dynamicFiles?: string[];
+}>): string;
+/**
+ * Grid3 user data path information
+ */
+export interface Grid3UserPath {
+    userName: string;
+    langCode: string;
+    basePath: string;
+    historyDbPath: string;
+}
+export interface Grid3VocabularyPath {
+    userName: string;
+    gridsetPath: string;
+}
+export interface Grid3HistoryEntry {
+    id: string;
+    content: string;
+    occurrences: Array<{
+        timestamp: Date;
+        latitude?: number | null;
+        longitude?: number | null;
+    }>;
+    rawXml?: string;
+}
+/**
+ * Get the Windows Common Documents folder path from registry
+ * Falls back to default path if registry access fails
+ * @returns Path to Common Documents folder
+ */
+export declare function getCommonDocumentsPath(): string;
+/**
+ * Find all Grid3 user data paths
+ * Searches for users and language codes in the Grid3 directory structure
+ * C:\Users\Public\Documents\Smartbox\Grid 3\Users\{UserName}\{langCode}\Phrases\history.sqlite
+ * @returns Array of Grid3 user path information
+ */
+export declare function findGrid3UserPaths(): Grid3UserPath[];
+/**
+ * Find all Grid3 history database paths
+ * Convenience method that returns just the database file paths
+ * @returns Array of paths to history.sqlite files
+ */
+export declare function findGrid3HistoryDatabases(): string[];
+/**
+ * Get Grid 3 users (alias of findGrid3UserPaths for clarity)
+ */
+export declare function findGrid3Users(): Grid3UserPath[];
+/**
+ * Find Grid 3 gridset/vocabulary files for each user
+ * @param userName Optional user filter; matches case-insensitively
+ * @returns Array of user/gridset path pairs
+ */
+export declare function findGrid3Vocabularies(userName?: string): Grid3VocabularyPath[];
+/**
+ * Find a specific user's Grid 3 history database
+ * @param userName User name to search for (case-insensitive)
+ * @param langCode Optional language code filter (case-insensitive)
+ * @returns Path to history.sqlite or null if not found
+ */
+export declare function findGrid3UserHistory(userName: string, langCode?: string): string | null;
+/**
+ * Check whether Grid 3 appears to be installed (Windows only)
+ */
+export declare function isGrid3Installed(): boolean;
+/**
+ * Read history events from a Grid 3 history.sqlite database.
+ * @param historyDbPath Absolute path to the history database
+ * @returns Parsed history entries grouped by phrase
+ */
+export declare function readGrid3History(historyDbPath: string): Grid3HistoryEntry[];
+/**
+ * Convenience wrapper to load history for a specific Grid 3 user/lang combination.
+ * @param userName Grid 3 user name (case-insensitive)
+ * @param langCode Optional language code to narrow selection (case-insensitive)
+ * @returns History entries for that user/language, or empty array if none
+ */
+export declare function readGrid3HistoryForUser(userName: string, langCode?: string): Grid3HistoryEntry[];
+/**
+ * Load all available Grid 3 histories on the machine.
+ * @returns Combined history entries from every discovered history.sqlite
+ */
+export declare function readAllGrid3History(): Grid3HistoryEntry[];