@willwade/aac-processors 0.1.20 → 0.1.21

package/dist/validation/gridsetValidator.js

@@ -22,15 +22,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridsetValidator = void 0;
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-const jszip_1 = __importDefault(require("jszip"));
 const xml2js = __importStar(require("xml2js"));
 const baseValidator_1 = require("./baseValidator");
 const io_1 = require("../utils/io");
@@ -44,12 +40,12 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
     /**
      * Validate a Gridset file from disk
      */
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new GridsetValidator();
-        const fs = (0, io_1.getFs)();
-        const content = fs.readFileSync(filePath);
-        const stats = fs.statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     /**
      * Check if content is Gridset format
@@ -138,24 +134,17 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
      * Validate a ZIP archive (.gridset)
      */
     async validateZipArchive(content, filename, _filesize) {
-        let zip;
-        try {
-            zip = await jszip_1.default.loadAsync((0, io_1.toUint8Array)(content));
-        }
-        catch (e) {
-            this.err(`Failed to open ZIP archive: ${e.message}`, true);
-            return;
-        }
-        const entries = Object.values(zip.files).filter((entry) => !entry.dir);
+        const zip = await this._options.zipAdapter(content);
+        const entries = zip.listFiles();
         // Check for gridset.xml (required)
         await this.add_check('gridset_xml_presence', 'gridset.xml presence', async () => {
-            const gridsetEntry = entries.find((e) => e.name.toLowerCase() === 'gridset.xml');
+            const gridsetEntry = entries.find((e) => e.toLowerCase() === 'gridset.xml');
             if (!gridsetEntry) {
                 this.err('Missing gridset.xml in archive', true);
             }
             else {
                 try {
-                    const gridsetXml = await gridsetEntry.async('string');
+                    const gridsetXml = await zip.readFile(gridsetEntry);
                     const parser = new xml2js.Parser();
                     const xmlObj = await parser.parseStringPromise(gridsetXml);
                     const gridset = xmlObj.gridset || xmlObj.Gridset;
@@ -173,13 +162,13 @@ class GridsetValidator extends baseValidator_1.BaseValidator {
         });
         // Check for settings.xml (highly recommended/required for metadata)
         await this.add_check('settings_xml_presence', 'settings.xml presence', async () => {
-            const settingsEntry = entries.find((e) => e.name.toLowerCase() === 'settings.xml');
+            const settingsEntry = entries.find((e) => e.toLowerCase() === 'settings.xml');
             if (!settingsEntry) {
                 this.warn('Missing settings.xml in archive (required for full metadata)');
             }
             else {
                 try {
-                    const settingsXml = await settingsEntry.async('string');
+                    const settingsXml = await zip.readFile(settingsEntry);
                     const parser = new xml2js.Parser();
                     const xmlObj = await parser.parseStringPromise(settingsXml);
                     const settings = xmlObj.GridSetSettings || xmlObj.gridSetSettings || xmlObj.GridsetSettings;

package/dist/validation/index.d.ts

@@ -16,7 +16,7 @@ export { ApplePanelsValidator } from './applePanelsValidator';
 export { ObfsetValidator } from './obfsetValidator';
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
-import { type ProcessorInput } from '../utils/io';
+import { FileAdapter, type ProcessorInput } from '../utils/io';
 export declare function getValidatorForFormat(format: string): BaseValidator | null;
 export declare function getValidatorForFile(filename: string): BaseValidator | null;
 /**
@@ -24,4 +24,4 @@ export declare function getValidatorForFile(filename: string): BaseValidator | n
  * When a file path is provided, any validator-specific validateFile() helper
  * will be used if available to access nested resources.
  */
-export declare function validateFileOrBuffer(filePathOrBuffer: ProcessorInput, filenameHint?: string): Promise<ValidationResult>;
+export declare function validateFileOrBuffer(filePathOrBuffer: ProcessorInput, fileAdapter?: FileAdapter, filenameHint?: string): Promise<ValidationResult>;

package/dist/validation/index.js

@@ -125,10 +125,11 @@ function getValidatorForFile(filename) {
  * When a file path is provided, any validator-specific validateFile() helper
  * will be used if available to access nested resources.
  */
-async function validateFileOrBuffer(filePathOrBuffer, filenameHint) {
+async function validateFileOrBuffer(filePathOrBuffer, fileAdapter, filenameHint) {
     const isPath = typeof filePathOrBuffer === 'string';
     const name = filenameHint || (isPath ? (0, io_1.getBasename)(filePathOrBuffer) : 'upload');
     const validator = getValidatorForFile(name) || getValidatorForFormat(name);
+    const adapter = fileAdapter ?? io_1.defaultFileAdapter;
     if (!validator) {
         throw new Error(`No validator registered for ${name}`);
     }
@@ -140,9 +141,9 @@ async function validateFileOrBuffer(filePathOrBuffer, filenameHint) {
         if (typeof ctor.validateFile === 'function') {
             return ctor.validateFile(filePathOrBuffer);
         }
-        const buf = (0, io_1.readBinaryFromInput)(filePathOrBuffer);
-        const stats = (0, io_1.getFs)().statSync(filePathOrBuffer);
-        return validator.validate(buf, (0, io_1.getBasename)(filePathOrBuffer), stats.size);
+        const buf = adapter.readBinaryFromInput(filePathOrBuffer);
+        const size = adapter.getFileSize(filePathOrBuffer);
+        return validator.validate(buf, (0, io_1.getBasename)(filePathOrBuffer), size);
     }
     const buffer = (0, io_1.toUint8Array)(filePathOrBuffer);
     return validator.validate(buffer, name, buffer.byteLength);

package/dist/validation/obfValidator.d.ts

@@ -1,5 +1,6 @@
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
+import { FileAdapter } from '../utils/io';
 /**
  * Validator for Open Board Format (OBF/OBZ) files
  */
@@ -8,7 +9,7 @@ export declare class ObfValidator extends BaseValidator {
     /**
      * Validate an OBF file from disk
      */
-    static validateFile(filePath: string): Promise<ValidationResult>;
+    static validateFile(filePath: string, fileAdapter?: FileAdapter): Promise<ValidationResult>;
     /**
      * Check if content is OBF format
      */

package/dist/validation/obfValidator.js

@@ -24,11 +24,12 @@ class ObfValidator extends baseValidator_1.BaseValidator {
     /**
      * Validate an OBF file from disk
      */
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new ObfValidator();
-        const content = (0, io_1.readBinaryFromInput)(filePath);
-        const stats = (0, io_1.getFs)().statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     /**
      * Check if content is OBF format

package/dist/validation/obfsetValidator.d.ts

@@ -1,10 +1,11 @@
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
+import { FileAdapter } from '../utils/io';
 /**
  * Validator for OBF set bundles (.obfset) - JSON arrays of boards
  */
 export declare class ObfsetValidator extends BaseValidator {
-    static validateFile(filePath: string): Promise<ValidationResult>;
+    static validateFile(filePath: string, fileAdapter?: FileAdapter): Promise<ValidationResult>;
     static identifyFormat(content: any, filename: string): Promise<boolean>;
     validate(content: Buffer | Uint8Array, filename: string, filesize: number): Promise<ValidationResult>;
 }

package/dist/validation/obfsetValidator.js

@@ -8,11 +8,12 @@ const io_1 = require("../utils/io");
  * Validator for OBF set bundles (.obfset) - JSON arrays of boards
  */
 class ObfsetValidator extends baseValidator_1.BaseValidator {
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new ObfsetValidator();
-        const content = (0, io_1.readBinaryFromInput)(filePath);
-        const stats = (0, io_1.getFs)().statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     static async identifyFormat(content, filename) {
         const name = filename.toLowerCase();

package/dist/validation/opmlValidator.d.ts

@@ -1,10 +1,11 @@
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
+import { FileAdapter } from '../utils/io';
 /**
  * Validator for OPML files
  */
 export declare class OpmlValidator extends BaseValidator {
-    static validateFile(filePath: string): Promise<ValidationResult>;
+    static validateFile(filePath: string, fileAdapter?: FileAdapter): Promise<ValidationResult>;
     static identifyFormat(content: any, filename: string): Promise<boolean>;
     validate(content: Buffer | Uint8Array, filename: string, filesize: number): Promise<ValidationResult>;
 }

package/dist/validation/opmlValidator.js

@@ -9,11 +9,12 @@ const io_1 = require("../utils/io");
  * Validator for OPML files
  */
 class OpmlValidator extends baseValidator_1.BaseValidator {
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new OpmlValidator();
-        const content = (0, io_1.readBinaryFromInput)(filePath);
-        const stats = (0, io_1.getFs)().statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     static async identifyFormat(content, filename) {
         const name = filename.toLowerCase();

package/dist/validation/snapValidator.d.ts

@@ -1,5 +1,6 @@
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
+import { FileAdapter } from '../utils/io';
 /**
  * Validator for Snap files (.spb, .sps)
  * Snap files are zipped packages containing XML configuration
@@ -9,7 +10,7 @@ export declare class SnapValidator extends BaseValidator {
     /**
      * Validate a Snap file from disk
      */
-    static validateFile(filePath: string): Promise<ValidationResult>;
+    static validateFile(filePath: string, fileAdapter?: FileAdapter): Promise<ValidationResult>;
     /**
      * Check if content is Snap format
      */

package/dist/validation/snapValidator.js

@@ -45,11 +45,12 @@ class SnapValidator extends baseValidator_1.BaseValidator {
     /**
      * Validate a Snap file from disk
      */
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new SnapValidator();
-        const content = (0, io_1.readBinaryFromInput)(filePath);
-        const stats = (0, io_1.getFs)().statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     /**
      * Check if content is Snap format
@@ -187,7 +188,10 @@ class SnapValidator extends baseValidator_1.BaseValidator {
         await this.add_check('sqlite', 'valid SQLite database', async () => {
             let cleanup;
             try {
-                const result = await (0, sqlite_1.openSqliteDatabase)(content, { readonly: true });
+                const result = await (0, sqlite_1.openSqliteDatabase)(content, {
+                    readonly: true,
+                    fileAdapter: this._options.fileAdapter,
+                });
                 const db = result.db;
                 cleanup = result.cleanup;
                 const tableRows = db

package/dist/validation/touchChatValidator.d.ts

@@ -1,7 +1,7 @@
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
-import { type ProcessorInput } from '../utils/io';
-import { type ZipAdapter } from '../utils/zip';
+import { FileAdapter, type ProcessorInput } from '../utils/io';
+import { ZipAdapter } from '../utils/zip';
 /**
  * Validator for TouchChat files (.ce)
  * TouchChat files are ZIP archives that contain a .c4v SQLite database.
@@ -12,13 +12,11 @@ export declare class TouchChatValidator extends BaseValidator {
     /**
      * Validate a TouchChat file from disk
      */
-    static validateFile(filePath: string): Promise<ValidationResult>;
+    static validateFile(filePath: string, fileAdapter?: FileAdapter): Promise<ValidationResult>;
     /**
      * Check if content is TouchChat format
      */
-    static identifyFormat(content: any, filename: string, zipAdapter?: (input: ProcessorInput) => Promise<{
-        zip: ZipAdapter;
-    }>): Promise<boolean>;
+    static identifyFormat(content: any, filename: string, fileAdapter?: FileAdapter, zipAdapter?: (input: ProcessorInput) => Promise<ZipAdapter>): Promise<boolean>;
     /**
      * Main validation method
      */

package/dist/validation/touchChatValidator.js

@@ -30,8 +30,8 @@ exports.TouchChatValidator = void 0;
 const xml2js = __importStar(require("xml2js"));
 const baseValidator_1 = require("./baseValidator");
 const io_1 = require("../utils/io");
-const zip_1 = require("../utils/zip");
 const sqlite_1 = require("../utils/sqlite");
+const zip_1 = require("../utils/zip");
 /**
  * Validator for TouchChat files (.ce)
  * TouchChat files are ZIP archives that contain a .c4v SQLite database.
@@ -44,23 +44,26 @@ class TouchChatValidator extends baseValidator_1.BaseValidator {
     /**
      * Validate a TouchChat file from disk
      */
-    static async validateFile(filePath) {
+    static async validateFile(filePath, fileAdapter) {
+        const { readBinaryFromInput, getFileSize } = fileAdapter ?? io_1.defaultFileAdapter;
         const validator = new TouchChatValidator();
-        const content = (0, io_1.readBinaryFromInput)(filePath);
-        const stats = (0, io_1.getFs)().statSync(filePath);
-        return validator.validate(content, (0, io_1.getBasename)(filePath), stats.size);
+        const content = readBinaryFromInput(filePath);
+        const size = getFileSize(filePath);
+        return validator.validate(content, (0, io_1.getBasename)(filePath), size);
     }
     /**
      * Check if content is TouchChat format
      */
-    static async identifyFormat(content, filename, zipAdapter) {
+    static async identifyFormat(content, filename, fileAdapter = io_1.defaultFileAdapter, zipAdapter) {
         const name = filename.toLowerCase();
         if (name.endsWith('.ce')) {
             return true;
         }
         // Try to parse as ZIP and check for .c4v database
         try {
-            const { zip } = zipAdapter ? await zipAdapter(content) : await (0, zip_1.openZipFromInput)(content);
+            const zip = zipAdapter
+                ? await zipAdapter(content)
+                : await (0, zip_1.getZipAdapter)(content, fileAdapter);
             const entries = zip.listFiles();
             if (entries.some((entry) => entry.toLowerCase().endsWith('.c4v'))) {
                 return true;
@@ -92,7 +95,9 @@ class TouchChatValidator extends baseValidator_1.BaseValidator {
             }
         });
         const looksLikeXml = this.isXmlBuffer(content);
-        const zipped = looksLikeXml ? false : await this.tryValidateZipSqlite(content);
+        const zipped = looksLikeXml
+            ? false
+            : await this.tryValidateZipSqlite(content, this._options.fileAdapter, this._options.zipAdapter);
         if (!zipped) {
             let xmlObj = null;
             await this.add_check('xml_parse', 'valid XML', async () => {
@@ -272,11 +277,13 @@ class TouchChatValidator extends baseValidator_1.BaseValidator {
         }
         return bytes[start] === 0x3c; // '<'
     }
-    async tryValidateZipSqlite(content) {
+    async tryValidateZipSqlite(content, fileAdapter = io_1.defaultFileAdapter, zipAdapter) {
         let usedZip = false;
         await this.add_check('zip', 'TouchChat ZIP package', async () => {
             try {
-                const { zip } = await (0, zip_1.openZipFromInput)(content);
+                const zip = zipAdapter
+                    ? await zipAdapter(content)
+                    : await (0, zip_1.getZipAdapter)(content, fileAdapter);
                 const entries = zip.listFiles();
                 const vocabEntry = entries.find((name) => name.toLowerCase().endsWith('.c4v'));
                 if (!vocabEntry) {
@@ -301,7 +308,10 @@ class TouchChatValidator extends baseValidator_1.BaseValidator {
         await this.add_check('sqlite', 'valid TouchChat SQLite database', async () => {
             let cleanup;
             try {
-                const result = await (0, sqlite_1.openSqliteDatabase)(content, { readonly: true });
+                const result = await (0, sqlite_1.openSqliteDatabase)(content, {
+                    readonly: true,
+                    fileAdapter: this._options.fileAdapter,
+                });
                 const db = result.db;
                 cleanup = result.cleanup;
                 const tableRows = db

package/dist/validation/validationTypes.d.ts

@@ -1,3 +1,5 @@
+import { FileAdapter, ProcessorInput } from '../utils/io';
+import { ZipAdapter } from '../utils/zip';
 /**
  * Custom error class for validation errors
  * Can be marked as a blocker to stop validation immediately
@@ -45,14 +47,19 @@ export interface ValidationResult {
 /**
  * Options for validation behavior
  */
-export interface ValidationOptions {
+export interface ValidationConfig {
     /** Whether to include warnings in validation (default: true) */
     includeWarnings?: boolean;
     /** Whether to stop on first blocker error (default: true) */
     stopOnBlocker?: boolean;
     /** Custom validation rules to apply */
     customRules?: ValidationRule[];
+    /** Adapter for handling file IO (optional) */
+    fileAdapter: FileAdapter;
+    /** Adapter for handling ZIP files (optional) */
+    zipAdapter: (input: ProcessorInput) => Promise<ZipAdapter>;
 }
+export type ValidationOptions = Partial<ValidationConfig>;
 /**
  * Custom validation rule that can be added
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willwade/aac-processors",
-  "version": "0.1.20",
+  "version": "0.1.21",
   "description": "A comprehensive TypeScript library for processing AAC (Augmentative and Alternative Communication) file formats with translation support",
   "main": "dist/index.js",
   "browser": "dist/browser/index.browser.js",

package/dist/core/fileProcessor.d.ts

@@ -1,7 +0,0 @@
-type FileFormat = 'gridset' | 'coughdrop' | 'touchchat' | 'snap' | 'dot' | 'opml' | 'excel' | 'unknown';
-declare class FileProcessor {
-    static readFile(filePath: string): Buffer;
-    static writeFile(filePath: string, data: Buffer | string): void;
-    static detectFormat(filePathOrBuffer: string | Buffer): FileFormat;
-}
-export default FileProcessor;

package/dist/core/fileProcessor.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-class FileProcessor {
-    // Read a file and return its contents as a Buffer
-    static readFile(filePath) {
-        return fs_1.default.readFileSync(filePath);
-    }
-    // Write data (Buffer or string) to a file
-    static writeFile(filePath, data) {
-        fs_1.default.writeFileSync(filePath, data);
-    }
-    // Detect file format based on extension or magic bytes
-    static detectFormat(filePathOrBuffer) {
-        if (typeof filePathOrBuffer === 'string') {
-            const ext = path_1.default.extname(filePathOrBuffer).toLowerCase();
-            const fileName = path_1.default.basename(filePathOrBuffer).toLowerCase();
-            // Handle double extensions like .sub.zip
-            if (fileName.endsWith('.sub.zip') || ext === '.sub') {
-                return 'snap';
-            }
-            switch (ext) {
-                case '.gridset':
-                case '.gridsetx':
-                    return 'gridset';
-                case '.obf':
-                case '.obz':
-                    return 'coughdrop';
-                case '.ce':
-                case '.wfl':
-                case '.touchchat':
-                    return 'touchchat';
-                case '.sps':
-                case '.spb':
-                    return 'snap';
-                case '.dot':
-                    return 'dot';
-                case '.opml':
-                    return 'opml';
-                case '.xlsx':
-                    return 'excel';
-                default:
-                    return 'unknown';
-            }
-        }
-        else if (Buffer.isBuffer(filePathOrBuffer)) {
-            // Optionally: inspect magic bytes here
-            return 'unknown';
-        }
-        return 'unknown';
-    }
-}
-exports.default = FileProcessor;