@willwade/aac-processors 0.0.21 → 0.0.23

package/dist/validation/opmlValidator.js

@@ -0,0 +1,107 @@
+"use strict";
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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.OpmlValidator = void 0;
+/* eslint-disable @typescript-eslint/require-await */
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const fast_xml_parser_1 = require("fast-xml-parser");
+const baseValidator_1 = require("./baseValidator");
+/**
+ * Validator for OPML files
+ */
+class OpmlValidator extends baseValidator_1.BaseValidator {
+    static async validateFile(filePath) {
+        const validator = new OpmlValidator();
+        const content = fs.readFileSync(filePath);
+        const stats = fs.statSync(filePath);
+        return validator.validate(content, path.basename(filePath), stats.size);
+    }
+    static async identifyFormat(content, filename) {
+        const name = filename.toLowerCase();
+        if (name.endsWith('.opml')) {
+            return true;
+        }
+        try {
+            const str = Buffer.isBuffer(content) ? content.toString('utf-8') : String(content);
+            const validation = fast_xml_parser_1.XMLValidator.validate(str);
+            if (validation !== true) {
+                return false;
+            }
+            const parser = new fast_xml_parser_1.XMLParser({ ignoreAttributes: false });
+            const parsed = parser.parse(str);
+            return Boolean(parsed?.opml?.body?.outline);
+        }
+        catch {
+            return false;
+        }
+    }
+    async validate(content, filename, filesize) {
+        this.reset();
+        const parser = new fast_xml_parser_1.XMLParser({ ignoreAttributes: false });
+        await this.add_check('filename', 'file extension', async () => {
+            if (!filename.toLowerCase().endsWith('.opml')) {
+                this.warn('filename should end with .opml');
+            }
+        });
+        let text = '';
+        await this.add_check('content', 'non-empty content', async () => {
+            text = Buffer.isBuffer(content) ? content.toString('utf-8') : String(content);
+            if (!text.trim()) {
+                this.err('OPML file is empty', true);
+            }
+        });
+        await this.add_check('xml', 'valid XML', async () => {
+            const validation = fast_xml_parser_1.XMLValidator.validate(text);
+            if (validation !== true) {
+                const msg = String(validation?.err?.msg || 'Invalid OPML XML');
+                this.err(msg, true);
+            }
+        });
+        let parsed = null;
+        await this.add_check('structure', 'outline structure', async () => {
+            parsed = parser.parse(text);
+            if (!parsed?.opml?.body?.outline) {
+                this.err('missing body.outline', true);
+            }
+        });
+        if (parsed?.opml?.body?.outline) {
+            const outlines = Array.isArray(parsed.opml.body.outline)
+                ? parsed.opml.body.outline
+                : [parsed.opml.body.outline];
+            await this.add_check('outline_nodes', 'outline nodes', async () => {
+                const hasText = outlines.some((node) => {
+                    const textValue = node?.['@_text'] || node?._attributes?.text || node?.text || node?.['@_title'];
+                    return typeof textValue === 'string' && textValue.trim().length > 0;
+                });
+                if (!hasText) {
+                    this.err('outline nodes missing text attributes');
+                }
+            });
+        }
+        return this.buildResult(filename, filesize, 'opml');
+    }
+}
+exports.OpmlValidator = OpmlValidator;

package/dist/validation/validationTypes.d.ts

@@ -62,3 +62,25 @@ export interface ValidationRule {
     check: (data: any) => Promise<boolean> | boolean;
     errorMessage?: string;
 }
+/**
+ * Error wrapper that carries a structured ValidationResult so callers
+ * can surface actionable details instead of generic exceptions.
+ */
+export declare class ValidationFailureError extends Error {
+    validationResult: ValidationResult;
+    originalError?: unknown;
+    constructor(message: string, validationResult: ValidationResult, originalError?: unknown);
+}
+/**
+ * Build a minimal ValidationResult for situations where we cannot run
+ * the full validator (e.g., early parse failure) but still want
+ * structured feedback for the caller.
+ */
+export declare function buildValidationResultFromMessage(params: {
+    filename: string;
+    filesize: number;
+    format: string;
+    message: string;
+    type?: string;
+    description?: string;
+}): ValidationResult;

package/dist/validation/validationTypes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationError = void 0;
+exports.ValidationFailureError = exports.ValidationError = void 0;
+exports.buildValidationResultFromMessage = buildValidationResultFromMessage;
 /**
  * Custom error class for validation errors
  * Can be marked as a blocker to stop validation immediately
@@ -13,3 +14,39 @@ class ValidationError extends Error {
     }
 }
 exports.ValidationError = ValidationError;
+/**
+ * Error wrapper that carries a structured ValidationResult so callers
+ * can surface actionable details instead of generic exceptions.
+ */
+class ValidationFailureError extends Error {
+    constructor(message, validationResult, originalError) {
+        super(message);
+        this.name = 'ValidationFailureError';
+        this.validationResult = validationResult;
+        this.originalError = originalError;
+    }
+}
+exports.ValidationFailureError = ValidationFailureError;
+/**
+ * Build a minimal ValidationResult for situations where we cannot run
+ * the full validator (e.g., early parse failure) but still want
+ * structured feedback for the caller.
+ */
+function buildValidationResultFromMessage(params) {
+    return {
+        filename: params.filename,
+        filesize: params.filesize,
+        format: params.format,
+        valid: false,
+        errors: 1,
+        warnings: 0,
+        results: [
+            {
+                type: params.type || 'parse',
+                description: params.description || 'parse',
+                valid: false,
+                error: params.message,
+            },
+        ],
+    };
+}

package/dist/validation.d.ts

@@ -4,10 +4,16 @@
  * All validation functionality for AAC processors.
  * Provides consistent validation across all supported formats.
  */
-export { ValidationError, ValidationCheck, ValidationResult, ValidationOptions, ValidationRule, } from './validation/validationTypes';
+export { ValidationError, ValidationCheck, ValidationResult, ValidationOptions, ValidationRule, ValidationFailureError, buildValidationResultFromMessage, } from './validation/validationTypes';
 export { BaseValidator } from './validation/baseValidator';
 export { ObfValidator } from './validation/obfValidator';
 export { GridsetValidator } from './validation/gridsetValidator';
 export { SnapValidator } from './validation/snapValidator';
 export { TouchChatValidator } from './validation/touchChatValidator';
-export { getValidatorForFormat, getValidatorForFile } from './validation/index';
+export { AstericsGridValidator } from './validation/astericsValidator';
+export { ExcelValidator } from './validation/excelValidator';
+export { OpmlValidator } from './validation/opmlValidator';
+export { DotValidator } from './validation/dotValidator';
+export { ApplePanelsValidator } from './validation/applePanelsValidator';
+export { ObfsetValidator } from './validation/obfsetValidator';
+export { getValidatorForFormat, getValidatorForFile, validateFileOrBuffer, } from './validation/index';

package/dist/validation.js

@@ -6,10 +6,12 @@
  * Provides consistent validation across all supported formats.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getValidatorForFile = exports.getValidatorForFormat = exports.TouchChatValidator = exports.SnapValidator = exports.GridsetValidator = exports.ObfValidator = exports.BaseValidator = exports.ValidationError = void 0;
+exports.validateFileOrBuffer = exports.getValidatorForFile = exports.getValidatorForFormat = exports.ObfsetValidator = exports.ApplePanelsValidator = exports.DotValidator = exports.OpmlValidator = exports.ExcelValidator = exports.AstericsGridValidator = exports.TouchChatValidator = exports.SnapValidator = exports.GridsetValidator = exports.ObfValidator = exports.BaseValidator = exports.buildValidationResultFromMessage = exports.ValidationFailureError = exports.ValidationError = void 0;
 // Validation types and interfaces
 var validationTypes_1 = require("./validation/validationTypes");
 Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return validationTypes_1.ValidationError; } });
+Object.defineProperty(exports, "ValidationFailureError", { enumerable: true, get: function () { return validationTypes_1.ValidationFailureError; } });
+Object.defineProperty(exports, "buildValidationResultFromMessage", { enumerable: true, get: function () { return validationTypes_1.buildValidationResultFromMessage; } });
 // Base validator
 var baseValidator_1 = require("./validation/baseValidator");
 Object.defineProperty(exports, "BaseValidator", { enumerable: true, get: function () { return baseValidator_1.BaseValidator; } });
@@ -22,7 +24,20 @@ var snapValidator_1 = require("./validation/snapValidator");
 Object.defineProperty(exports, "SnapValidator", { enumerable: true, get: function () { return snapValidator_1.SnapValidator; } });
 var touchChatValidator_1 = require("./validation/touchChatValidator");
 Object.defineProperty(exports, "TouchChatValidator", { enumerable: true, get: function () { return touchChatValidator_1.TouchChatValidator; } });
+var astericsValidator_1 = require("./validation/astericsValidator");
+Object.defineProperty(exports, "AstericsGridValidator", { enumerable: true, get: function () { return astericsValidator_1.AstericsGridValidator; } });
+var excelValidator_1 = require("./validation/excelValidator");
+Object.defineProperty(exports, "ExcelValidator", { enumerable: true, get: function () { return excelValidator_1.ExcelValidator; } });
+var opmlValidator_1 = require("./validation/opmlValidator");
+Object.defineProperty(exports, "OpmlValidator", { enumerable: true, get: function () { return opmlValidator_1.OpmlValidator; } });
+var dotValidator_1 = require("./validation/dotValidator");
+Object.defineProperty(exports, "DotValidator", { enumerable: true, get: function () { return dotValidator_1.DotValidator; } });
+var applePanelsValidator_1 = require("./validation/applePanelsValidator");
+Object.defineProperty(exports, "ApplePanelsValidator", { enumerable: true, get: function () { return applePanelsValidator_1.ApplePanelsValidator; } });
+var obfsetValidator_1 = require("./validation/obfsetValidator");
+Object.defineProperty(exports, "ObfsetValidator", { enumerable: true, get: function () { return obfsetValidator_1.ObfsetValidator; } });
 // Validator factory functions
 var index_1 = require("./validation/index");
 Object.defineProperty(exports, "getValidatorForFormat", { enumerable: true, get: function () { return index_1.getValidatorForFormat; } });
 Object.defineProperty(exports, "getValidatorForFile", { enumerable: true, get: function () { return index_1.getValidatorForFile; } });
+Object.defineProperty(exports, "validateFileOrBuffer", { enumerable: true, get: function () { return index_1.validateFileOrBuffer; } });

package/package.json

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