file-validation-engine/lib/RuleEngine.js

A dynamic rule-based validation engine for Excel and CSV files

"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 () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __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.RuleEngine = void 0;
const fs_1 = __importDefault(require("fs"));
const path_1 = __importDefault(require("path"));
const csv_parse_1 = require("csv-parse");
const XLSX = __importStar(require("xlsx"));
class RuleEngine {
    constructor(rules, options = {}) {
        this.seenValues = {};
        this.rules = rules;
        this.options = { chunkSize: 10000, ...options };
        this.initUniqueTracking();
    }
    initUniqueTracking() {
        this.seenValues = {};
        this.rules.forEach(rule => {
            if (rule.unique)
                this.seenValues[rule.column] = new Set();
        });
    }
    async validateFile(filePath, outputErrorFile) {
        // Reset seenValues for each file
        this.rules.forEach(rule => {
            if (rule.unique)
                this.seenValues[rule.column] = new Set();
        });
        let hasErrors = false;
        const ext = path_1.default.extname(filePath).toLowerCase();
        if (ext === '.csv') {
            hasErrors = await this.validateCSV(filePath, outputErrorFile);
        }
        else if (ext === '.xlsx' || ext === '.xls') {
            hasErrors = await this.validateExcel(filePath, outputErrorFile);
        }
        else {
            throw new Error('Unsupported file type');
        }
        return hasErrors;
    }
    async validateCSV(filePath, outputErrorFile) {
        return new Promise((resolve, reject) => {
            let hasErrors = false;
            const readStream = fs_1.default.createReadStream(filePath);
            const parser = (0, csv_parse_1.parse)({ columns: true });
            let rowNum = 1;
            let chunk = [];
            const writeErrors = (errors) => {
                if (errors.length > 0) {
                    hasErrors = true;
                    fs_1.default.appendFileSync(outputErrorFile, errors.join('\n') + '\n');
                }
            };
            parser.on('readable', () => {
                let record;
                while ((record = parser.read())) {
                    chunk.push(record);
                    if (chunk.length >= this.options.chunkSize) {
                        const errors = this.validateChunk(chunk, rowNum);
                        writeErrors(errors);
                        rowNum += chunk.length;
                        chunk = [];
                    }
                }
            });
            parser.on('end', () => {
                if (chunk.length > 0) {
                    const errors = this.validateChunk(chunk, rowNum);
                    writeErrors(errors);
                }
                resolve(hasErrors);
            });
            parser.on('error', reject);
            readStream.pipe(parser);
        });
    }
    async validateExcel(filePath, outputErrorFile) {
        let hasErrors = false;
        const workbook = XLSX.readFile(filePath);
        const sheetName = workbook.SheetNames[0];
        const sheet = workbook.Sheets[sheetName];
        const rows = XLSX.utils.sheet_to_json(sheet, { defval: '' });
        let rowNum = 1;
        for (let i = 0; i < rows.length; i += this.options.chunkSize) {
            const chunk = rows.slice(i, i + this.options.chunkSize);
            const errors = this.validateChunk(chunk, rowNum);
            if (errors.length > 0) {
                hasErrors = true;
                fs_1.default.appendFileSync(outputErrorFile, errors.join('\n') + '\n');
            }
            rowNum += chunk.length;
        }
        return hasErrors;
    }
    validateChunk(chunk, startRow) {
        const errors = [];
        chunk.forEach((row, idx) => {
            this.rules.forEach((rule) => {
                if (rule.condition && !rule.condition(row))
                    return;
                // Unique check
                if (rule.unique) {
                    const val = row[rule.column];
                    if (val !== undefined && val !== null && val !== '') {
                        if (this.seenValues[rule.column].has(val)) {
                            errors.push(`Row ${startRow + idx + 1}: [${rule.column}] must be unique (duplicate value: ${val})`);
                            return;
                        }
                        this.seenValues[rule.column].add(val);
                    }
                }
                if (!rule.validate(row[rule.column], row)) {
                    let rawValue = row[rule.column];
                    let safeValue = typeof rawValue === 'string'
                        ? rawValue.replace(/[\r\n\t]+/g, ' ').slice(0, 200)
                        : rawValue;
                    errors.push(`Row ${startRow + idx + 1}: [${rule.column}] ${rule.errorMessage} (value: ${safeValue})`);
                }
            });
        });
        return errors;
    }
}
exports.RuleEngine = RuleEngine;