koatty_validation 1.6.1 → 1.6.3

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-10-23 20:54:39
+* @Date: 2026-01-28 12:40:10
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -820,6 +820,209 @@ function plateNumber(value) {
     }
 }
 
+/**
+ * Improved error handling mechanism
+ * @author richen
+ */
+/**
+ * Error message internationalization
+ */
+const ERROR_MESSAGES = {
+    zh: {
+        // Chinese localization validation
+        IsCnName: '必须是有效的中文姓名',
+        IsIdNumber: '必须是有效的身份证号码',
+        IsZipCode: '必须是有效的邮政编码',
+        IsMobile: '必须是有效的手机号码',
+        IsPlateNumber: '必须是有效的车牌号码',
+        // Basic validation
+        IsNotEmpty: '不能为空',
+        IsDate: '必须是有效的日期',
+        IsEmail: '必须是有效的邮箱地址',
+        IsIP: '必须是有效的IP地址',
+        IsPhoneNumber: '必须是有效的电话号码',
+        IsUrl: '必须是有效的URL地址',
+        IsHash: '必须是有效的哈希值',
+        // Comparison validation
+        Equals: '必须等于 {comparison}',
+        NotEquals: '不能等于 {comparison}',
+        Contains: '必须包含 {seed}',
+        IsIn: '必须是以下值之一: {possibleValues}',
+        IsNotIn: '不能是以下值之一: {possibleValues}',
+        Gt: '必须大于 {min}',
+        Gte: '必须大于或等于 {min}',
+        Lt: '必须小于 {max}',
+        Lte: '必须小于或等于 {max}',
+        // Common errors
+        invalidParameter: '参数 {field} 无效',
+        validationFailed: '验证失败',
+    },
+    en: {
+        // Chinese localization validators
+        IsCnName: 'must be a valid Chinese name',
+        IsIdNumber: 'must be a valid ID number',
+        IsZipCode: 'must be a valid zip code',
+        IsMobile: 'must be a valid mobile number',
+        IsPlateNumber: 'must be a valid plate number',
+        // Basic validators
+        IsNotEmpty: 'should not be empty',
+        IsDate: 'must be a valid date',
+        IsEmail: 'must be a valid email',
+        IsIP: 'must be a valid IP address',
+        IsPhoneNumber: 'must be a valid phone number',
+        IsUrl: 'must be a valid URL',
+        IsHash: 'must be a valid hash',
+        // Comparison validators
+        Equals: 'must equal to {comparison}',
+        NotEquals: 'should not equal to {comparison}',
+        Contains: 'must contain {seed}',
+        IsIn: 'must be one of the following values: {possibleValues}',
+        IsNotIn: 'should not be one of the following values: {possibleValues}',
+        Gt: 'must be greater than {min}',
+        Gte: 'must be greater than or equal to {min}',
+        Lt: 'must be less than {max}',
+        Lte: 'must be less than or equal to {max}',
+        // Common errors
+        invalidParameter: 'invalid parameter {field}',
+        validationFailed: 'validation failed',
+    }
+};
+/**
+ * Enhanced validation error class
+ */
+class KoattyValidationError extends Error {
+    constructor(errors, message) {
+        const errorMessage = message || 'Validation failed';
+        super(errorMessage);
+        this.name = 'KoattyValidationError';
+        this.errors = errors;
+        this.statusCode = 400;
+        this.timestamp = new Date();
+        // Ensure correct prototype chain
+        Object.setPrototypeOf(this, KoattyValidationError.prototype);
+    }
+    /**
+     * Get the first error message
+     */
+    getFirstError() {
+        return this.errors[0];
+    }
+    /**
+     * Get errors for a specific field
+     */
+    getFieldErrors(field) {
+        return this.errors.filter(error => error.field === field);
+    }
+    /**
+     * Convert to JSON format
+     */
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            statusCode: this.statusCode,
+            timestamp: this.timestamp,
+            errors: this.errors
+        };
+    }
+}
+/**
+ * Error message formatter
+ */
+class ErrorMessageFormatter {
+    constructor(language = 'zh') {
+        this.language = 'zh';
+        this.language = language;
+    }
+    /**
+     * Set language
+     */
+    setLanguage(language) {
+        this.language = language;
+    }
+    /**
+     * Format error message
+     */
+    formatMessage(constraint, field, value, context) {
+        const messages = ERROR_MESSAGES[this.language];
+        let template = messages[constraint] || messages.invalidParameter;
+        // Replace placeholders
+        template = template.replace('{field}', field);
+        // Prioritize values from context, then use passed value
+        if (context) {
+            Object.entries(context).forEach(([key, val]) => {
+                template = template.replace(`{${key}}`, this.formatValue(val));
+            });
+        }
+        // If there's still a {value} placeholder and value was passed, replace it
+        if (value !== undefined && template.includes('{value}')) {
+            template = template.replace('{value}', this.formatValue(value));
+        }
+        return template;
+    }
+    /**
+     * Format value for message display
+     * @private
+     */
+    formatValue(value) {
+        if (value === null)
+            return 'null';
+        if (value === undefined)
+            return 'undefined';
+        if (typeof value === 'number')
+            return String(value);
+        if (typeof value === 'string')
+            return `"${value}"`;
+        if (Array.isArray(value))
+            return `[${value.map(v => this.formatValue(v)).join(', ')}]`;
+        if (typeof value === 'object') {
+            try {
+                return JSON.stringify(value);
+            }
+            catch {
+                // Handle circular references
+                return '[Circular Reference]';
+            }
+        }
+        return String(value);
+    }
+}
+/**
+ * Global error message formatter instance
+ */
+const errorFormatter = new ErrorMessageFormatter();
+/**
+ * Set global language
+ */
+function setValidationLanguage(language) {
+    errorFormatter.setLanguage(language);
+}
+/**
+ * Create validation error
+ */
+function createValidationError(field, value, constraint, customMessage, context) {
+    const message = customMessage || errorFormatter.formatMessage(constraint, field, value, context);
+    return {
+        field,
+        value,
+        constraint,
+        message,
+        context
+    };
+}
+/**
+ * Create validation errors in batch
+ */
+function createValidationErrors(errors, separator = '; ') {
+    const validationErrors = errors.map(error => createValidationError(error.field, error.value, error.constraint, error.message, error.context));
+    // Generate combined message from all errors
+    const combinedMessage = validationErrors
+        .map(err => err.message)
+        .filter(msg => msg && msg.trim())
+        .join(separator) || 'Validation failed';
+    return new KoattyValidationError(validationErrors, combinedMessage);
+}
+
 /*
  * @Description:
  * @Usage:
@@ -879,10 +1082,11 @@ class ValidateClass {
      * @param {*} Clazz
      * @param {*} data
      * @param {boolean} [convert=false] auto convert parameters type
+     * @param {ValidationOptions} [options] validation options (returnAllErrors, errorSeparator)
      * @returns {Promise<any>}
      * @memberof ValidateClass
      */
-    async valid(Clazz, data, convert = false) {
+    async valid(Clazz, data, convert = false, options) {
         let obj = {};
         if (data instanceof Clazz) {
             obj = data;
@@ -898,7 +1102,21 @@ class ValidateClass {
             errors = await classValidator.validate(obj, { skipMissingProperties: true });
         }
         if (errors.length > 0) {
-            throw new Error(Object.values(errors[0].constraints)[0]);
+            // Check if user wants all errors or just the first one
+            if (options === null || options === void 0 ? void 0 : options.returnAllErrors) {
+                // Throw KoattyValidationError with all error details
+                throw createValidationErrors(errors.map(e => ({
+                    field: e.property,
+                    value: e.value,
+                    constraint: Object.keys(e.constraints || {})[0] || 'unknown',
+                    message: Object.values(e.constraints || {})[0] || 'Validation failed',
+                    context: e.constraints
+                })), options.errorSeparator || '; ');
+            }
+            else {
+                // Default behavior (backward compatible): return only first error
+                throw new Error(Object.values(errors[0].constraints)[0]);
+            }
         }
         return obj;
     }
@@ -1170,8 +1388,9 @@ function createValidationDecorator(options) {
                     },
                     defaultMessage(validationArguments) {
                         const property = validationArguments.property;
-                        return defaultMessage
-                            ? defaultMessage.replace('$property', property)
+                        const customMessage = (validationOptions === null || validationOptions === void 0 ? void 0 : validationOptions.message) || defaultMessage;
+                        return customMessage
+                            ? customMessage.replace('$property', property)
                             : `Invalid value for ${property}`;
                     }
                 }
@@ -1210,204 +1429,6 @@ function createParameterizedDecorator(name, validator, defaultMessage) {
     });
 }
 
-/**
- * Improved error handling mechanism
- * @author richen
- */
-/**
- * Error message internationalization
- */
-const ERROR_MESSAGES = {
-    zh: {
-        // Chinese localization validation
-        IsCnName: '必须是有效的中文姓名',
-        IsIdNumber: '必须是有效的身份证号码',
-        IsZipCode: '必须是有效的邮政编码',
-        IsMobile: '必须是有效的手机号码',
-        IsPlateNumber: '必须是有效的车牌号码',
-        // Basic validation
-        IsNotEmpty: '不能为空',
-        IsDate: '必须是有效的日期',
-        IsEmail: '必须是有效的邮箱地址',
-        IsIP: '必须是有效的IP地址',
-        IsPhoneNumber: '必须是有效的电话号码',
-        IsUrl: '必须是有效的URL地址',
-        IsHash: '必须是有效的哈希值',
-        // Comparison validation
-        Equals: '必须等于 {comparison}',
-        NotEquals: '不能等于 {comparison}',
-        Contains: '必须包含 {seed}',
-        IsIn: '必须是以下值之一: {possibleValues}',
-        IsNotIn: '不能是以下值之一: {possibleValues}',
-        Gt: '必须大于 {min}',
-        Gte: '必须大于或等于 {min}',
-        Lt: '必须小于 {max}',
-        Lte: '必须小于或等于 {max}',
-        // Common errors
-        invalidParameter: '参数 {field} 无效',
-        validationFailed: '验证失败',
-    },
-    en: {
-        // Chinese localization validators
-        IsCnName: 'must be a valid Chinese name',
-        IsIdNumber: 'must be a valid ID number',
-        IsZipCode: 'must be a valid zip code',
-        IsMobile: 'must be a valid mobile number',
-        IsPlateNumber: 'must be a valid plate number',
-        // Basic validators
-        IsNotEmpty: 'should not be empty',
-        IsDate: 'must be a valid date',
-        IsEmail: 'must be a valid email',
-        IsIP: 'must be a valid IP address',
-        IsPhoneNumber: 'must be a valid phone number',
-        IsUrl: 'must be a valid URL',
-        IsHash: 'must be a valid hash',
-        // Comparison validators
-        Equals: 'must equal to {comparison}',
-        NotEquals: 'should not equal to {comparison}',
-        Contains: 'must contain {seed}',
-        IsIn: 'must be one of the following values: {possibleValues}',
-        IsNotIn: 'should not be one of the following values: {possibleValues}',
-        Gt: 'must be greater than {min}',
-        Gte: 'must be greater than or equal to {min}',
-        Lt: 'must be less than {max}',
-        Lte: 'must be less than or equal to {max}',
-        // Common errors
-        invalidParameter: 'invalid parameter {field}',
-        validationFailed: 'validation failed',
-    }
-};
-/**
- * Enhanced validation error class
- */
-class KoattyValidationError extends Error {
-    constructor(errors, message) {
-        const errorMessage = message || 'Validation failed';
-        super(errorMessage);
-        this.name = 'KoattyValidationError';
-        this.errors = errors;
-        this.statusCode = 400;
-        this.timestamp = new Date();
-        // Ensure correct prototype chain
-        Object.setPrototypeOf(this, KoattyValidationError.prototype);
-    }
-    /**
-     * Get the first error message
-     */
-    getFirstError() {
-        return this.errors[0];
-    }
-    /**
-     * Get errors for a specific field
-     */
-    getFieldErrors(field) {
-        return this.errors.filter(error => error.field === field);
-    }
-    /**
-     * Convert to JSON format
-     */
-    toJSON() {
-        return {
-            name: this.name,
-            message: this.message,
-            statusCode: this.statusCode,
-            timestamp: this.timestamp,
-            errors: this.errors
-        };
-    }
-}
-/**
- * Error message formatter
- */
-class ErrorMessageFormatter {
-    constructor(language = 'zh') {
-        this.language = 'zh';
-        this.language = language;
-    }
-    /**
-     * Set language
-     */
-    setLanguage(language) {
-        this.language = language;
-    }
-    /**
-     * Format error message
-     */
-    formatMessage(constraint, field, value, context) {
-        const messages = ERROR_MESSAGES[this.language];
-        let template = messages[constraint] || messages.invalidParameter;
-        // Replace placeholders
-        template = template.replace('{field}', field);
-        // Prioritize values from context, then use passed value
-        if (context) {
-            Object.entries(context).forEach(([key, val]) => {
-                template = template.replace(`{${key}}`, this.formatValue(val));
-            });
-        }
-        // If there's still a {value} placeholder and value was passed, replace it
-        if (value !== undefined && template.includes('{value}')) {
-            template = template.replace('{value}', this.formatValue(value));
-        }
-        return template;
-    }
-    /**
-     * Format value for message display
-     * @private
-     */
-    formatValue(value) {
-        if (value === null)
-            return 'null';
-        if (value === undefined)
-            return 'undefined';
-        if (typeof value === 'number')
-            return String(value);
-        if (typeof value === 'string')
-            return `"${value}"`;
-        if (Array.isArray(value))
-            return `[${value.map(v => this.formatValue(v)).join(', ')}]`;
-        if (typeof value === 'object') {
-            try {
-                return JSON.stringify(value);
-            }
-            catch {
-                // Handle circular references
-                return '[Circular Reference]';
-            }
-        }
-        return String(value);
-    }
-}
-/**
- * Global error message formatter instance
- */
-const errorFormatter = new ErrorMessageFormatter();
-/**
- * Set global language
- */
-function setValidationLanguage(language) {
-    errorFormatter.setLanguage(language);
-}
-/**
- * Create validation error
- */
-function createValidationError(field, value, constraint, customMessage, context) {
-    const message = customMessage || errorFormatter.formatMessage(constraint, field, value, context);
-    return {
-        field,
-        value,
-        constraint,
-        message,
-        context
-    };
-}
-/**
- * Create validation errors in batch
- */
-function createValidationErrors(errors) {
-    const validationErrors = errors.map(error => createValidationError(error.field, error.value, error.constraint, error.message, error.context));
-    return new KoattyValidationError(validationErrors);
-}
-
 /**
  * Refactored decorator definitions - Using factory functions to eliminate duplication
  * @author richen
@@ -1434,7 +1455,10 @@ const Lt = createParameterizedDecorator('Lt', (value, max) => helper__namespace.
 const Lte = createParameterizedDecorator('Lte', (value, max) => helper__namespace.toNumber(value) <= max, 'must be less than or equal to $constraint1');
 // 复杂验证装饰器（需要特殊处理）
 function IsEmail(options, validationOptions) {
-    return createParameterizedDecorator('IsEmail', (value) => classValidator.isEmail(value, options), 'must be a valid email')(validationOptions);
+    // Handle case where options is actually ValidationOptions (message only)
+    const actualOptions = (options === null || options === void 0 ? void 0 : options.message) ? {} : options;
+    const actualValidationOptions = (options === null || options === void 0 ? void 0 : options.message) ? options : validationOptions;
+    return createParameterizedDecorator('IsEmail', (value) => classValidator.isEmail(value, actualOptions), 'must be a valid email')(actualValidationOptions);
 }
 function IsIP(version, validationOptions) {
     return createParameterizedDecorator('IsIP', (value) => classValidator.isIP(value, version), 'must be a valid IP address')(validationOptions);