@willwade/aac-processors 0.0.10 → 0.0.12

package/dist/cli/index.js

@@ -17,6 +17,13 @@ function detectFormat(filePath) {
         filePath.endsWith('.ascconfig')) {
         return 'ascconfig';
     }
+    // Map multi-file formats to their base processor
+    if (filePath.endsWith('.obfset')) {
+        return 'obf'; // Use ObfProcessor for .obfset files
+    }
+    if (filePath.endsWith('.gridset')) {
+        return 'gridset';
+    }
     // Otherwise use file extension
     return path_1.default.extname(filePath).slice(1);
 }

package/dist/core/analyze.js

@@ -22,6 +22,7 @@ function getProcessor(format, options) {
         case 'opml':
             return new opmlProcessor_1.OpmlProcessor(options);
         case 'obf':
+        case 'obfset': // Obfset files use ObfProcessor
             return new obfProcessor_1.ObfProcessor(options);
         case 'touchchat':
         case 'ce': // TouchChat file extension

package/dist/core/baseProcessor.d.ts

@@ -7,6 +7,9 @@ export interface ProcessorOptions {
     gridsetPassword?: string;
     customButtonFilter?: (button: AACButton) => boolean;
     preserveAllButtons?: boolean;
+    grid3SymbolDir?: string;
+    grid3Path?: string;
+    grid3Locale?: string;
 }
 export interface ExtractedString {
     string: string;

package/dist/core/treeStructure.d.ts

@@ -83,6 +83,8 @@ export interface AACSemanticAction {
         type: 'SPEAK' | 'NAVIGATE' | 'ACTION';
         message?: string;
         targetPageId?: string;
+        temporary_home?: boolean | string | null;
+        add_to_sentence?: boolean;
     };
 }
 export declare class AACButton implements IAACButton {
@@ -115,7 +117,9 @@ export declare class AACButton implements IAACButton {
     parameters?: {
         [key: string]: any;
     };
-    constructor({ id, label, message, targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, x, y, columnSpan, rowSpan, scanBlocks, visibility, directActivate, parameters, type, action, }: {
+    semantic_id?: string;
+    clone_id?: string;
+    constructor({ id, label, message, targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, visibility, directActivate, parameters, semantic_id, clone_id, type, action, }: {
         id: string;
         label?: string;
         message?: string;
@@ -132,6 +136,8 @@ export declare class AACButton implements IAACButton {
         contentSubType?: string;
         image?: string;
         resolvedImageEntry?: string;
+        symbolLibrary?: string;
+        symbolPath?: string;
         x?: number;
         y?: number;
         columnSpan?: number;
@@ -142,6 +148,8 @@ export declare class AACButton implements IAACButton {
         parameters?: {
             [key: string]: any;
         };
+        semantic_id?: string;
+        clone_id?: string;
         type?: 'SPEAK' | 'NAVIGATE' | 'ACTION';
         action?: {
             type: 'SPEAK' | 'NAVIGATE' | 'ACTION';
@@ -167,7 +175,9 @@ export declare class AACPage implements IAACPage {
     descriptionHtml?: string;
     images?: any[];
     sounds?: any[];
-    constructor({ id, name, grid, buttons, parentId, style, locale, descriptionHtml, images, sounds, }: {
+    semantic_ids?: string[];
+    clone_ids?: string[];
+    constructor({ id, name, grid, buttons, parentId, style, locale, descriptionHtml, images, sounds, semantic_ids, clone_ids, }: {
         id: string;
         name?: string;
         grid?: Array<Array<AACButton | null>> | {
@@ -181,6 +191,8 @@ export declare class AACPage implements IAACPage {
         descriptionHtml?: string;
         images?: any[];
         sounds?: any[];
+        semantic_ids?: string[];
+        clone_ids?: string[];
     });
     addButton(button: AACButton): void;
 }

package/dist/core/treeStructure.js

@@ -43,7 +43,7 @@ var AACSemanticIntent;
     AACSemanticIntent["PLATFORM_SPECIFIC"] = "PLATFORM_SPECIFIC";
 })(AACSemanticIntent || (exports.AACSemanticIntent = AACSemanticIntent = {}));
 class AACButton {
-    constructor({ id, label = '', message = '', targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, x, y, columnSpan, rowSpan, scanBlocks, visibility, directActivate, parameters, 
+    constructor({ id, label = '', message = '', targetPageId, semanticAction, audioRecording, style, contentType, contentSubType, image, resolvedImageEntry, symbolLibrary, symbolPath, x, y, columnSpan, rowSpan, scanBlocks, visibility, directActivate, parameters, semantic_id, clone_id, 
     // Legacy input support
     type, action, }) {
         this.id = id;
@@ -57,6 +57,8 @@ class AACButton {
         this.contentSubType = contentSubType;
         this.image = image;
         this.resolvedImageEntry = resolvedImageEntry;
+        this.symbolLibrary = symbolLibrary;
+        this.symbolPath = symbolPath;
         this.x = x;
         this.y = y;
         this.columnSpan = columnSpan;
@@ -65,6 +67,8 @@ class AACButton {
         this.visibility = visibility;
         this.directActivate = directActivate;
         this.parameters = parameters;
+        this.semantic_id = semantic_id;
+        this.clone_id = clone_id;
         // Legacy mapping: if no semanticAction provided, derive from legacy `action` first
         if (!this.semanticAction && action) {
             if (action.type === 'NAVIGATE' && (action.targetPageId || this.targetPageId)) {
@@ -152,7 +156,7 @@ class AACButton {
 }
 exports.AACButton = AACButton;
 class AACPage {
-    constructor({ id, name = '', grid = [], buttons = [], parentId = null, style, locale, descriptionHtml, images, sounds, }) {
+    constructor({ id, name = '', grid = [], buttons = [], parentId = null, style, locale, descriptionHtml, images, sounds, semantic_ids, clone_ids, }) {
         this.id = id;
         this.name = name;
         if (Array.isArray(grid)) {
@@ -173,6 +177,8 @@ class AACPage {
         this.descriptionHtml = descriptionHtml;
         this.images = images;
         this.sounds = sounds;
+        this.semantic_ids = semantic_ids;
+        this.clone_ids = clone_ids;
     }
     addButton(button) {
         this.buttons.push(button);

package/dist/index.d.ts

@@ -2,8 +2,9 @@ export * from './core/treeStructure';
 export * from './core/baseProcessor';
 export * from './core/stringCasing';
 export * from './processors';
-export { collectUnifiedHistory, listGrid3Users as listHistoryGrid3Users, listSnapUsers as listHistorySnapUsers, } from './analytics/history';
 export * from './validation';
+export * as Analytics from './optional/analytics';
+export { collectUnifiedHistory, listGrid3Users as listHistoryGrid3Users, listSnapUsers as listHistorySnapUsers, } from './optional/analytics/history';
 import { BaseProcessor } from './core/baseProcessor';
 /**
  * Factory function to get the appropriate processor for a file extension

package/dist/index.js

@@ -10,11 +10,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.listHistorySnapUsers = exports.listHistoryGrid3Users = exports.collectUnifiedHistory = void 0;
+exports.listHistorySnapUsers = exports.listHistoryGrid3Users = exports.collectUnifiedHistory = exports.Analytics = void 0;
 exports.getProcessor = getProcessor;
 exports.getSupportedExtensions = getSupportedExtensions;
 exports.isExtensionSupported = isExtensionSupported;
@@ -23,11 +35,12 @@ __exportStar(require("./core/treeStructure"), exports);
 __exportStar(require("./core/baseProcessor"), exports);
 __exportStar(require("./core/stringCasing"), exports);
 __exportStar(require("./processors"), exports);
-var history_1 = require("./analytics/history");
+__exportStar(require("./validation"), exports);
+exports.Analytics = __importStar(require("./optional/analytics"));
+var history_1 = require("./optional/analytics/history");
 Object.defineProperty(exports, "collectUnifiedHistory", { enumerable: true, get: function () { return history_1.collectUnifiedHistory; } });
 Object.defineProperty(exports, "listHistoryGrid3Users", { enumerable: true, get: function () { return history_1.listGrid3Users; } });
 Object.defineProperty(exports, "listHistorySnapUsers", { enumerable: true, get: function () { return history_1.listSnapUsers; } });
-__exportStar(require("./validation"), exports);
 const dotProcessor_1 = require("./processors/dotProcessor");
 const excelProcessor_1 = require("./processors/excelProcessor");
 const opmlProcessor_1 = require("./processors/opmlProcessor");
@@ -37,6 +50,7 @@ const snapProcessor_1 = require("./processors/snapProcessor");
 const touchchatProcessor_1 = require("./processors/touchchatProcessor");
 const applePanelsProcessor_1 = require("./processors/applePanelsProcessor");
 const astericsGridProcessor_1 = require("./processors/astericsGridProcessor");
+const obfsetProcessor_1 = require("./processors/obfsetProcessor");
 /**
  * Factory function to get the appropriate processor for a file extension
  * @param filePathOrExtension - File path or extension (e.g., '.dot', '/path/to/file.obf')
@@ -58,6 +72,8 @@ function getProcessor(filePathOrExtension) {
         case '.obf':
         case '.obz':
             return new obfProcessor_1.ObfProcessor();
+        case '.obfset':
+            return new obfsetProcessor_1.ObfsetProcessor();
         case '.gridset':
         case '.gridsetx':
             return new gridsetProcessor_1.GridsetProcessor();
@@ -85,6 +101,7 @@ function getSupportedExtensions() {
         '.opml',
         '.obf',
         '.obz',
+        '.obfset',
         '.gridset',
         '.gridsetx',
         '.spb',

package/dist/{analytics → optional/analytics}/history.d.ts

@@ -1,6 +1,6 @@
-import { dotNetTicksToDate } from '../utils/dotnetTicks';
-import { Grid3UserPath } from '../processors/gridset/helpers';
-import { SnapUserInfo } from '../processors/snap/helpers';
+import { dotNetTicksToDate } from '../../utils/dotnetTicks';
+import { Grid3UserPath } from '../../processors/gridset/helpers';
+import { SnapUserInfo } from '../../processors/snap/helpers';
 export type HistorySource = 'Grid' | 'Snap';
 export interface HistoryOccurrence {
     timestamp: Date;

package/dist/{analytics → optional/analytics}/history.js

@@ -9,10 +9,10 @@ exports.readSnapUsageForUser = readSnapUsageForUser;
 exports.listSnapUsers = listSnapUsers;
 exports.listGrid3Users = listGrid3Users;
 exports.collectUnifiedHistory = collectUnifiedHistory;
-const dotnetTicks_1 = require("../utils/dotnetTicks");
+const dotnetTicks_1 = require("../../utils/dotnetTicks");
 Object.defineProperty(exports, "dotNetTicksToDate", { enumerable: true, get: function () { return dotnetTicks_1.dotNetTicksToDate; } });
-const helpers_1 = require("../processors/gridset/helpers");
-const helpers_2 = require("../processors/snap/helpers");
+const helpers_1 = require("../../processors/gridset/helpers");
+const helpers_2 = require("../../processors/snap/helpers");
 /**
  * Read Grid 3 phrase history from a history.sqlite database and tag entries with their source.
  */

package/dist/optional/analytics/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * AAC Analytics Module (Optional)
+ *
+ * This module provides metrics calculation and analysis for AAC board sets.
+ * The core types, utilities, and effort functions are always available.
+ *
+ * This module is similar to symbolTools - the functionality is here but
+ * you only use it if you need it. No special installation required.
+ *
+ * @module
+ */
+export * from './metrics/types';
+export * from './metrics/effort';
+export * from './utils/idGenerator';
+export * from './history';
+export { MetricsCalculator } from './metrics/core';
+export { VocabularyAnalyzer } from './metrics/vocabulary';
+export { SentenceAnalyzer } from './metrics/sentence';
+export { ComparisonAnalyzer } from './metrics/comparison';
+export { ReferenceLoader } from './reference';
+/**
+ * Get the default reference data path
+ */
+export declare function getReferenceDataPath(): string;
+/**
+ * Check if reference data files exist
+ */
+export declare function hasReferenceData(): boolean;

package/dist/optional/analytics/index.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * AAC Analytics Module (Optional)
+ *
+ * This module provides metrics calculation and analysis for AAC board sets.
+ * The core types, utilities, and effort functions are always available.
+ *
+ * This module is similar to symbolTools - the functionality is here but
+ * you only use it if you need it. No special installation required.
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceLoader = exports.ComparisonAnalyzer = exports.SentenceAnalyzer = exports.VocabularyAnalyzer = exports.MetricsCalculator = void 0;
+exports.getReferenceDataPath = getReferenceDataPath;
+exports.hasReferenceData = hasReferenceData;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+// Always-available exports
+__exportStar(require("./metrics/types"), exports);
+__exportStar(require("./metrics/effort"), exports);
+__exportStar(require("./utils/idGenerator"), exports);
+// Export history functionality
+__exportStar(require("./history"), exports);
+// Export core metrics calculator
+var core_1 = require("./metrics/core");
+Object.defineProperty(exports, "MetricsCalculator", { enumerable: true, get: function () { return core_1.MetricsCalculator; } });
+// Export vocabulary and comparison analyzers
+var vocabulary_1 = require("./metrics/vocabulary");
+Object.defineProperty(exports, "VocabularyAnalyzer", { enumerable: true, get: function () { return vocabulary_1.VocabularyAnalyzer; } });
+var sentence_1 = require("./metrics/sentence");
+Object.defineProperty(exports, "SentenceAnalyzer", { enumerable: true, get: function () { return sentence_1.SentenceAnalyzer; } });
+var comparison_1 = require("./metrics/comparison");
+Object.defineProperty(exports, "ComparisonAnalyzer", { enumerable: true, get: function () { return comparison_1.ComparisonAnalyzer; } });
+var reference_1 = require("./reference");
+Object.defineProperty(exports, "ReferenceLoader", { enumerable: true, get: function () { return reference_1.ReferenceLoader; } });
+/**
+ * Get the default reference data path
+ */
+function getReferenceDataPath() {
+    return path_1.default.join(__dirname, 'reference', 'data');
+}
+/**
+ * Check if reference data files exist
+ */
+function hasReferenceData() {
+    const dataPath = getReferenceDataPath();
+    const requiredFiles = [
+        'core_lists.en.json',
+        'common_words.en.json',
+        'sentences.en.json',
+        'synonyms.en.json',
+        'fringe.en.json',
+    ];
+    return requiredFiles.every((file) => fs_1.default.existsSync(path_1.default.join(dataPath, file)));
+}

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

@@ -0,0 +1,36 @@
+/**
+ * Comparative Analysis
+ *
+ * Compares two AAC board sets to identify missing/extra words,
+ * analyze vocabulary differences, and generate CARE component scores.
+ */
+import { MetricsResult, ComparisonResult } from './types';
+export declare class ComparisonAnalyzer {
+    private vocabAnalyzer;
+    private sentenceAnalyzer;
+    private referenceLoader;
+    constructor();
+    /**
+     * Compare two board sets
+     */
+    compare(targetResult: MetricsResult, compareResult: MetricsResult, options?: {
+        includeSentences?: boolean;
+        locale?: string;
+    }): ComparisonResult;
+    /**
+     * Calculate CARE component scores
+     */
+    private calculateCareComponents;
+    /**
+     * Analyze fringe vocabulary
+     */
+    private analyzeFringe;
+    /**
+     * Analyze common fringe vocabulary
+     */
+    private analyzeCommonFringe;
+    /**
+     * Calculate overall effort score for a metrics result
+     */
+    private calculateEffortScore;
+}