@willwade/aac-processors 0.0.5 → 0.0.7

package/README.md

@@ -658,13 +658,8 @@ npm test
 
 - The repository keeps `package.json` at `0.0.0-development`; release tags control the published version.
 - Create a GitHub release with a semantic tag (e.g. `v2.1.0`). Publishing only runs for non-prerelease tags.
-- Add an `NPM_TOKEN` repository secret with publish rights. The release workflow uses it to authenticate and calls `npm publish`.
 - The workflow (`.github/workflows/publish.yml`) automatically installs dependencies, rewrites the package version from the tag, and runs the standard publish pipeline.
 
-**Private distribution options**
-- Unscoped packages on npm must be public. To keep this package private, re-scope it (e.g. `@your-org/aac-processors`) and configure `publishConfig.access: "restricted"`—this requires an npm org with paid seats.
-- Alternatively, publish to GitHub Packages by adjusting the workflow’s registry URL and using a `GITHUB_TOKEN` with the `packages: write` permission.
-
 ---
 
 ## 📄 License
@@ -715,15 +710,6 @@ Inspired by the Python AACProcessors project
 - [ ] **Add Symbol Tools coverage** (currently 0%) - Implement tests for PCS and ARASAAC symbol lookups to reach >70% coverage
 - [ ] **Fix property-based test failures** - Resolve TypeScript interface compatibility issues in edge case generators
 
-### Recently Completed ✅
-
-- [x] **Core utilities test coverage** - Complete implementation for analyze.ts and fileProcessor.ts (0% → 100% coverage, 45 comprehensive tests, src/core/ directory 30% → 83% coverage)
-- [x] **CLI test infrastructure** - Fixed DotProcessor parsing and test expectations (0 → 25 passing tests, 100% CLI functionality)
-- [x] **Critical linting fixes** - Resolved unsafe argument types and CLI type safety issues (177 → 123 errors, 32% improvement)
-- [x] **Audio test syntax fixes** - Fixed non-null assertion errors in audio tests (21 → 5 failing tests, 76% improvement)
-- [x] **Comprehensive styling support** - Complete implementation across all AAC formats with cross-format preservation (Added: AACStyle interface, enhanced all processors, 7 new test cases, complete documentation)
-- [x] **TouchChatProcessor save/load functionality** - Fixed button persistence and ID mapping (coverage improved from 57.62% to 86.44%)
-- [x] **Build integration** - Ensure `npm run build` is executed before CLI tests (Fixed: All test scripts now automatically build before running)
 
 ### Medium Priority
 
@@ -749,29 +735,6 @@ Inspired by the Python AACProcessors project
 - [ ] **CI/CD improvements** - Add automated releases and npm publishing
 - [ ] **Documentation improvements** - Add more real-world examples and tutorials
 
-### Known Issues
-
-- ⚠️ **Audio Persistence**: 5 functional tests failing due to audio recording not persisting through SnapProcessor save/load cycle
-- ⚠️ **Grid3 Layout**: Grid sizes not reliable and X,Y positions incorrect, particularly affecting Grid3 processor functionality
-- ⚠️ **Database Constraints**: UNIQUE constraint violations with real-world data files (Page.Id and buttons.id conflicts)
-- ⚠️ **Linting**: 123 ESLint issues remaining (mostly in test files, reduced from 177)
-- ⚠️ **SnapProcessor**: Lowest coverage at 48.32%, missing comprehensive audio handling tests
-- ⚠️ **Memory usage**: Large files (>50MB) may cause memory pressure
-- ⚠️ **Concurrent access**: Some processors not fully thread-safe for simultaneous writes
-
-### 🧪 Current Test Status & Immediate Follow-Up
-
-As of the latest run (`npm test`), **47 suites pass / 6 fail (10 individual tests)**. Remaining blockers are:
-
-1. **Edge-case loaders** – corrupted JSON/XML fixtures still expect explicit exceptions. Decide whether to restore the old throwing behaviour (Asterics/OPML/DOT) or update the tests to accept the softer error reporting.
-2. **Gridset exports & styling** – round-trip continues to lose a button and the styling suite cannot find `style.xml`. GridsetProcessor needs to preserve button arrays and emit the styling assets Grid 3 expects.
-3. **DOT navigation semantics** – the deterministic DOT test still falls back to `SPEAK`. Improve semantic reconstruction when loading navigation edges so navigation buttons survive round-trips.
-4. **Advanced workflow scenario** – the multi-format pipeline still loses Spanish translations (likely during the Gridset ⇄ Snap steps); trace text propagation and patch the conversion chain.
-5. **Styling suite** – Grid 3 export still lacks `style.xml`; ensure the styling assets are generated alongside the gridset payload.
-6. **Memory comparison suite** – memory delta expectations are still unmet (TouchChat GC + DOT vs others). Either recalibrate the harness or tune the processors before re-enabling the assertions.
-
-Clearing these items will put the test matrix back in the green and unblock the release.
-
 ## More enhancements
 
 - Much more effort put into fixing the layout issues. Grid sizes are not reliably and X, Y positions too. Particularly in the Grid3

package/dist/cli/index.js

@@ -142,7 +142,7 @@ commander_1.program
     .option('--no-exclude-navigation', "Don't exclude navigation buttons (Home, Back)")
     .option('--no-exclude-system', "Don't exclude system buttons (Delete, Clear, etc.)")
     .option('--exclude-buttons <list>', 'Comma-separated list of button labels/terms to exclude')
-    .action((input, output, options) => {
+    .action(async (input, output, options) => {
     try {
         if (!options.format) {
             console.error('Error: --format option is required for convert command');
@@ -157,7 +157,7 @@ commander_1.program
         const tree = inputProcessor.loadIntoTree(input);
         // Save using output format with same filtering options
         const outputProcessor = (0, analyze_1.getProcessor)(options.format, filteringOptions);
-        outputProcessor.saveFromTree(tree, output);
+        await outputProcessor.saveFromTree(tree, output);
         // Show filtering summary
         let filteringSummary = '';
         if (filteringOptions.preserveAllButtons) {

package/dist/core/treeStructure.d.ts

@@ -163,7 +163,11 @@ export declare class AACPage implements IAACPage {
     buttons: AACButton[];
     parentId: string | null;
     style?: AACStyle;
-    constructor({ id, name, grid, buttons, parentId, style, }: {
+    locale?: string;
+    descriptionHtml?: string;
+    images?: any[];
+    sounds?: any[];
+    constructor({ id, name, grid, buttons, parentId, style, locale, descriptionHtml, images, sounds, }: {
         id: string;
         name?: string;
         grid?: Array<Array<AACButton | null>> | {
@@ -173,6 +177,10 @@ export declare class AACPage implements IAACPage {
         buttons?: AACButton[];
         parentId?: string | null;
         style?: AACStyle;
+        locale?: string;
+        descriptionHtml?: string;
+        images?: any[];
+        sounds?: any[];
     });
     addButton(button: AACButton): void;
 }

package/dist/core/treeStructure.js

@@ -152,7 +152,7 @@ class AACButton {
 }
 exports.AACButton = AACButton;
 class AACPage {
-    constructor({ id, name = '', grid = [], buttons = [], parentId = null, style, }) {
+    constructor({ id, name = '', grid = [], buttons = [], parentId = null, style, locale, descriptionHtml, images, sounds, }) {
         this.id = id;
         this.name = name;
         if (Array.isArray(grid)) {
@@ -169,6 +169,10 @@ class AACPage {
         this.buttons = buttons;
         this.parentId = parentId;
         this.style = style;
+        this.locale = locale;
+        this.descriptionHtml = descriptionHtml;
+        this.images = images;
+        this.sounds = sounds;
     }
     addButton(button) {
         this.buttons.push(button);

package/dist/processors/applePanelsProcessor.js

@@ -10,6 +10,45 @@ const treeStructure_1 = require("../core/treeStructure");
 const plist_1 = __importDefault(require("plist"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+function isNormalizedPanel(panel) {
+    return typeof panel.id === 'string';
+}
+function normalizePanel(panel, fallbackId) {
+    const rawId = panel.ID || fallbackId;
+    const buttons = Array.isArray(panel.PanelObjects)
+        ? panel.PanelObjects.filter((obj) => obj.PanelObjectType === 'Button')
+        : [];
+    const normalizedButtons = buttons.map((btn) => {
+        const firstAction = Array.isArray(btn.Actions) && btn.Actions.length > 0 ? btn.Actions[0] : undefined;
+        const isCharSequence = firstAction &&
+            (firstAction.ActionType === 'ActionPressKeyCharSequence' ||
+                firstAction.ActionType === 'ActionSendKeys');
+        const charString = isCharSequence ? firstAction?.ActionParam?.CharString : undefined;
+        const targetPanel = firstAction && firstAction.ActionType === 'ActionOpenPanel'
+            ? firstAction.ActionParam?.PanelID?.replace(/^USER\./, '')
+            : undefined;
+        return {
+            label: btn.DisplayText || 'Button',
+            message: charString || btn.DisplayText || 'Button',
+            DisplayColor: btn.DisplayColor,
+            DisplayImageWeight: btn.DisplayImageWeight,
+            FontSize: btn.FontSize,
+            Rect: btn.Rect,
+            targetPanel,
+        };
+    });
+    return {
+        id: rawId.replace(/^USER\./, ''),
+        name: panel.Name || 'Panel',
+        buttons: normalizedButtons,
+    };
+}
+function normalizeActionParameters(input) {
+    if (typeof input === 'object' && input !== null) {
+        return { ...input };
+    }
+    return {};
+}
 class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
     constructor(options) {
         super(options);
@@ -81,41 +120,21 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
         // Handle both old format (panels array) and new Apple Panels format (Panels dict)
         let panelsData = [];
         if (Array.isArray(parsedData.panels)) {
-            // Old format
-            panelsData = parsedData.panels;
+            panelsData = parsedData.panels.map((panel, index) => {
+                if (isNormalizedPanel(panel)) {
+                    return panel;
+                }
+                const panelData = panel || {
+                    PanelObjects: [],
+                };
+                return normalizePanel(panelData, `panel_${index}`);
+            });
         }
         else if (parsedData.Panels) {
-            // Apple Panels format: convert Panels dict to array
             const panelsDict = parsedData.Panels;
             panelsData = Object.keys(panelsDict).map((panelId) => {
-                const panel = panelsDict[panelId];
-                return {
-                    id: (panel.ID || panelId).replace(/^USER\./, ''), // Strip USER. prefix to maintain original IDs
-                    name: panel.Name || 'Panel',
-                    buttons: (panel.PanelObjects || [])
-                        .filter((obj) => obj.PanelObjectType === 'Button')
-                        .map((btn) => {
-                        const firstAction = Array.isArray(btn.Actions) && btn.Actions.length > 0 ? btn.Actions[0] : undefined;
-                        const isCharSequence = firstAction &&
-                            (firstAction.ActionType === 'ActionPressKeyCharSequence' ||
-                                firstAction.ActionType === 'ActionSendKeys');
-                        const charString = isCharSequence
-                            ? (firstAction.ActionParam?.CharString ?? undefined)
-                            : undefined;
-                        const targetPanel = firstAction && firstAction.ActionType === 'ActionOpenPanel'
-                            ? firstAction.ActionParam?.PanelID?.replace(/^USER\./, '')
-                            : undefined;
-                        return {
-                            label: btn.DisplayText || 'Button',
-                            message: charString || btn.DisplayText || 'Button',
-                            DisplayColor: btn.DisplayColor,
-                            DisplayImageWeight: btn.DisplayImageWeight,
-                            FontSize: btn.FontSize,
-                            Rect: btn.Rect,
-                            targetPanel,
-                        };
-                    }),
-                };
+                const rawPanel = panelsDict[panelId] || { PanelObjects: [] };
+                return normalizePanel(rawPanel, panelId);
             });
         }
         const data = { panels: panelsData };
@@ -219,15 +238,24 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
         Object.values(tree.pages).forEach((page) => {
             // Translate page names
             if (page.name && translations.has(page.name)) {
-                page.name = translations.get(page.name);
+                const translatedName = translations.get(page.name);
+                if (translatedName !== undefined) {
+                    page.name = translatedName;
+                }
             }
             // Translate button labels and messages
             page.buttons.forEach((button) => {
                 if (button.label && translations.has(button.label)) {
-                    button.label = translations.get(button.label);
+                    const translatedLabel = translations.get(button.label);
+                    if (translatedLabel !== undefined) {
+                        button.label = translatedLabel;
+                    }
                 }
                 if (button.message && translations.has(button.message)) {
-                    button.message = translations.get(button.message);
+                    const translatedMessage = translations.get(button.message);
+                    if (translatedMessage !== undefined) {
+                        button.message = translatedMessage;
+                    }
                 }
                 if (button.semanticAction) {
                     const intentStr = String(button.semanticAction.intent);
@@ -304,10 +332,8 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
             const panelId = `USER.${page.id}`;
             // Detect actual grid dimensions from the source data
             let gridCols = 4; // Default fallback
-            let gridRows = Math.ceil(page.buttons.length / gridCols);
             if (page.grid && page.grid.length > 0) {
                 // Use actual grid dimensions from source
-                gridRows = page.grid.length;
                 gridCols = page.grid[0] ? page.grid[0].length : 4;
                 // Find the actual used area to avoid empty space
                 let maxUsedX = 0, maxUsedY = 0;
@@ -322,7 +348,6 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
                 // Use the actual used dimensions if they're reasonable
                 if (maxUsedX > 0 && maxUsedY > 0) {
                     gridCols = maxUsedX + 1;
-                    gridRows = maxUsedY + 1;
                 }
             }
             else {
@@ -340,7 +365,6 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
                 else {
                     gridCols = 8; // 8 columns for very large sets
                 }
-                gridRows = Math.ceil(buttonCount / gridCols);
             }
             const panelObjects = page.buttons.map((button, buttonIndex) => {
                 // Find button position in grid layout and convert to Rect format
@@ -379,7 +403,8 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
                     FontSize: button.style?.fontSize || 12,
                     ID: `Button.${button.id}`,
                     PanelObjectType: 'Button',
-                    Rect: rect,
+                    Rect: rect ?? '{{0, 0}, {100, 25}}',
+                    Actions: [],
                 };
                 if (button.style?.backgroundColor) {
                     buttonObj.DisplayColor = button.style.backgroundColor;
@@ -414,8 +439,9 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
                 UsesPinnedResizing: false,
             };
         });
+        const panelsValue = Object.fromEntries(Object.entries(panelsDict).map(([key, value]) => [key, value]));
         const panelDefinitions = {
-            Panels: panelsDict,
+            Panels: panelsValue,
             ToolbarOrdering: {
                 ToolbarIdentifiersAfterBasePanel: [],
                 ToolbarIdentifiersPriorToBasePanel: [],
@@ -439,7 +465,7 @@ class ApplePanelsProcessor extends baseProcessor_1.BaseProcessor {
         if (button.semanticAction?.platformData?.applePanels) {
             const applePanelsData = button.semanticAction.platformData.applePanels;
             return {
-                ActionParam: applePanelsData.parameters,
+                ActionParam: normalizeActionParameters(applePanelsData.parameters),
                 ActionRecordedOffset: 0.0,
                 ActionType: applePanelsData.actionType,
                 ID: `Action.${button.id}`,