@decaf-ts/decorator-validation 1.4.21 → 1.5.1

package/lib/esm/validation/Validators/TypeValidator.js

@@ -28,8 +28,7 @@ let TypeValidator = class TypeValidator extends Validator {
     /**
      * @summary Validates a model
      * @param {string} value
-     * @param {string | string[] | {name: string}} types
-     * @param {string} [message]
+     * @param {TypeValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -37,9 +36,10 @@ let TypeValidator = class TypeValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, types, message) {
+    hasErrors(value, options) {
         if (value === undefined)
-            return; // Dont try and enforce type if undefined
+            return; // Don't try and enforce type if undefined
+        const { types, message } = options;
         if (!Reflection.evaluateDesignTypes(value, types))
             return this.getMessage(message || this.message, typeof types === "string"
                 ? types

package/lib/esm/validation/Validators/URLValidator.d.ts

@@ -1,4 +1,10 @@
-import { PatternValidator } from "./PatternValidator";
+import { PatternValidator, PatternValidatorOptions } from "./PatternValidator";
+import { ValidatorOptions } from "./Validator";
+export interface URLValidatorOptions extends ValidatorOptions {
+    types: string | string[] | {
+        name: string;
+    };
+}
 /**
  * @summary URL Validator
  * @description Pattern from {@link https://gist.github.com/dperini/729294}
@@ -14,7 +20,7 @@ export declare class URLValidator extends PatternValidator {
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} [options={}]
      *
      * @return {string | undefined}
      *
@@ -22,5 +28,5 @@ export declare class URLValidator extends PatternValidator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: string, pattern?: RegExp, message?: string): string | undefined;
+    hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
 }

package/lib/esm/validation/Validators/URLValidator.js

@@ -27,7 +27,7 @@ let URLValidator = class URLValidator extends PatternValidator {
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} [options={}]
      *
      * @return {string | undefined}
      *
@@ -35,8 +35,8 @@ let URLValidator = class URLValidator extends PatternValidator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, pattern, message) {
-        return super.hasErrors(value, pattern || DEFAULT_PATTERNS.URL, message);
+    hasErrors(value, options = {}) {
+        return super.hasErrors(value, { ...options, pattern: options.pattern || DEFAULT_PATTERNS.URL });
     }
 };
 URLValidator = __decorate([

package/lib/esm/validation/Validators/Validator.d.ts

@@ -1,3 +1,6 @@
+export type ValidatorOptions = {
+    message?: string;
+};
 /**
  * @summary Base Implementation for Validators
  * @description Provides the underlying functionality for {@link Validator}s
@@ -10,7 +13,7 @@
  * @abstract
  * @category Validators
  */
-export declare abstract class Validator {
+export declare abstract class Validator<V extends ValidatorOptions = ValidatorOptions> {
     readonly message: string;
     readonly acceptedTypes?: string[];
     protected constructor(message?: string, ...acceptedTypes: string[]);
@@ -30,11 +33,11 @@ export declare abstract class Validator {
     /**
      * @summary Validates an attribute
      * @param {any} value
-     * @param {any[]} args
+     * @param {ValidatorOptions} [options] Validate options for customizing the model validation behavior
      *
      * @abstract
      *
      * @see Model#hasErrors
      */
-    abstract hasErrors(value: any, ...args: any[]): string | undefined;
+    abstract hasErrors(value: any, options?: V): string | undefined;
 }

package/lib/esm/validation/decorators.js

@@ -32,7 +32,7 @@ export function required(message = DEFAULT_ERROR_MESSAGES.REQUIRED) {
  */
 export function min(value, message = DEFAULT_ERROR_MESSAGES.MIN) {
     return propMetadata(Validation.key(ValidationKeys.MIN), {
-        value: value,
+        min: value,
         message: message,
         types: [Number.name, Date.name],
     });
@@ -50,7 +50,7 @@ export function min(value, message = DEFAULT_ERROR_MESSAGES.MIN) {
  */
 export function max(value, message = DEFAULT_ERROR_MESSAGES.MAX) {
     return propMetadata(Validation.key(ValidationKeys.MAX), {
-        value: value,
+        max: value,
         message: message,
         types: [Number.name, Date.name],
     });
@@ -68,7 +68,7 @@ export function max(value, message = DEFAULT_ERROR_MESSAGES.MAX) {
  */
 export function step(value, message = DEFAULT_ERROR_MESSAGES.STEP) {
     return propMetadata(Validation.key(ValidationKeys.STEP), {
-        value: value,
+        step: value,
         message: message,
         types: [Number.name],
     });
@@ -86,7 +86,7 @@ export function step(value, message = DEFAULT_ERROR_MESSAGES.STEP) {
  */
 export function minlength(value, message = DEFAULT_ERROR_MESSAGES.MIN_LENGTH) {
     return propMetadata(Validation.key(ValidationKeys.MIN_LENGTH), {
-        value: value,
+        minLength: value,
         message: message,
         types: [String.name, Array.name, Set.name],
     });
@@ -104,7 +104,7 @@ export function minlength(value, message = DEFAULT_ERROR_MESSAGES.MIN_LENGTH) {
  */
 export function maxlength(value, message = DEFAULT_ERROR_MESSAGES.MAX_LENGTH) {
     return propMetadata(Validation.key(ValidationKeys.MAX_LENGTH), {
-        value: value,
+        maxLength: value,
         message: message,
         types: [String.name, Array.name, Set.name],
     });
@@ -122,7 +122,7 @@ export function maxlength(value, message = DEFAULT_ERROR_MESSAGES.MAX_LENGTH) {
  */
 export function pattern(value, message = DEFAULT_ERROR_MESSAGES.PATTERN) {
     return propMetadata(Validation.key(ValidationKeys.PATTERN), {
-        value: typeof value === "string" ? value : value.toString(),
+        pattern: typeof value === "string" ? value : value.toString(),
         message: message,
         types: [String.name],
     });
@@ -265,7 +265,7 @@ export function password(pattern = DEFAULT_PATTERNS.PASSWORD.CHAR8_ONE_OF_EACH,
  */
 export function list(clazz, collection = "Array", message = DEFAULT_ERROR_MESSAGES.LIST) {
     return propMetadata(Validation.key(ValidationKeys.LIST), {
-        class: Array.isArray(clazz) ? clazz.map((c) => c.name) : [clazz.name],
+        clazz: Array.isArray(clazz) ? clazz.map((c) => c.name) : [clazz.name],
         type: collection,
         message: message,
     });

package/lib/index.cjs

@@ -56,4 +56,4 @@ exports.VERSION = void 0;
 __exportStar(require("./utils/index.cjs"), exports);
 __exportStar(require("./validation/index.cjs"), exports);
 __exportStar(require("./model/index.cjs"), exports);
-exports.VERSION = "1.4.20";
+exports.VERSION = "1.5.0";

package/lib/index.d.ts

@@ -39,4 +39,4 @@
 export * from "./utils";
 export * from "./validation";
 export * from "./model";
-export declare const VERSION = "1.4.20";
+export declare const VERSION = "1.5.0";

package/lib/model/Model.cjs

@@ -78,7 +78,6 @@ class Model {
      * @summary Deserializes a Model
      * @param {string} str
      *
-     * @param args
      * @throws {Error} If it fails to parse the string, or if it fails to build the model
      */
     static deserialize(str) {
@@ -153,7 +152,7 @@ class Model {
                                 if (allDecorators.length) {
                                     const listDec = allDecorators.find((d) => d.key === constants_2.ValidationKeys.LIST);
                                     if (listDec) {
-                                        const clazzName = listDec.props.class.find((t) => !constants_3.jsTypes.includes(t.toLowerCase()));
+                                        const clazzName = listDec.props.clazz.find((t) => !constants_3.jsTypes.includes(t.toLowerCase()));
                                         if (c === "Array")
                                             self[prop] = self[prop].map((el) => {
                                                 return ["object", "function"].includes(typeof el) &&
@@ -274,8 +273,8 @@ class Model {
     static equals(obj1, obj2, ...exceptions) {
         return (0, reflection_1.isEqual)(obj1, obj2, ...exceptions);
     }
-    static hasErrors(model, ...exceptions) {
-        return (0, validation_1.validate)(model, ...exceptions);
+    static hasErrors(model, ...propsToIgnore) {
+        return (0, validation_1.validate)(model, ...propsToIgnore);
     }
     static serialize(model) {
         const metadata = Reflect.getMetadata(Model.key(constants_1.ModelKeys.SERIALIZATION), model.constructor);

package/lib/model/Model.d.ts

@@ -55,7 +55,6 @@ export declare abstract class Model implements Validatable, Serializable, Hashab
      * @summary Deserializes a Model
      * @param {string} str
      *
-     * @param args
      * @throws {Error} If it fails to parse the string, or if it fails to build the model
      */
     static deserialize(str: string): any;
@@ -127,7 +126,7 @@ export declare abstract class Model implements Validatable, Serializable, Hashab
     static getMetadata<V extends Model>(model: V): any;
     static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
     static equals<V extends Model>(obj1: V, obj2: V, ...exceptions: any[]): boolean;
-    static hasErrors<V extends Model>(model: V, ...exceptions: any[]): ModelErrorDefinition | undefined;
+    static hasErrors<V extends Model>(model: V, ...propsToIgnore: string[]): ModelErrorDefinition | undefined;
     static serialize<V extends Model>(model: V): any;
     static hash<V extends Model>(model: V): any;
     /**

package/lib/model/validation.cjs

@@ -46,9 +46,10 @@ function validate(obj, ...propsToIgnore) {
             if (!validator) {
                 throw new Error(`Missing validator for ${decorator.key}`);
             }
-            const err = validator.hasErrors(obj[prop.toString()], ...(decorator.key === constants_1.ModelKeys.TYPE
+            const decoratorProps = decorator.key === constants_1.ModelKeys.TYPE
                 ? [decorator.props]
-                : Object.values(decorator.props)));
+                : (decorator.props || {});
+            const err = validator.hasErrors(obj[prop.toString()], decoratorProps);
             if (err) {
                 errs = errs || {};
                 errs[decorator.key] = err;

package/lib/validation/Validators/DateValidator.cjs

@@ -31,8 +31,7 @@ let DateValidator = class DateValidator extends Validator_1.Validator {
      * @summary Validates a model
      *
      * @param {Date | string} value
-     * @param {string} format
-     * @param {string} [message]
+     * @param {DateValidatorOptions} [options]
      *
      * @return {string | undefined}
      *
@@ -40,13 +39,15 @@ let DateValidator = class DateValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, format, message) {
+    hasErrors(value, options = {}) {
         if (value === undefined)
             return;
         if (typeof value === "string")
             value = new Date(value);
-        if (Number.isNaN(value.getDate()))
+        if (Number.isNaN(value.getDate())) {
+            const { message = "" } = options;
             return this.getMessage(message || this.message);
+        }
     }
 };
 exports.DateValidator = DateValidator;

package/lib/validation/Validators/DateValidator.d.ts

@@ -1,4 +1,7 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface DateValidatorOptions extends ValidatorOptions {
+    format?: string;
+}
 /**
  * @summary Date Validator
  *
@@ -9,14 +12,13 @@ import { Validator } from "./Validator";
  *
  * @category Validators
  */
-export declare class DateValidator extends Validator {
+export declare class DateValidator extends Validator<DateValidatorOptions> {
     constructor(message?: string);
     /**
      * @summary Validates a model
      *
      * @param {Date | string} value
-     * @param {string} format
-     * @param {string} [message]
+     * @param {DateValidatorOptions} [options]
      *
      * @return {string | undefined}
      *
@@ -24,5 +26,5 @@ export declare class DateValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: Date | string, format: string, message?: string): string | undefined;
+    hasErrors(value: Date | string, options?: DateValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/EmailValidator.cjs

@@ -31,8 +31,7 @@ let EmailValidator = class EmailValidator extends PatternValidator_1.PatternVali
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {RegExp} [pattern]
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} [options]
      *
      * @return {string | undefined}
      *
@@ -40,8 +39,11 @@ let EmailValidator = class EmailValidator extends PatternValidator_1.PatternVali
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, pattern, message) {
-        return super.hasErrors(value, pattern || constants_1.DEFAULT_PATTERNS.EMAIL, message);
+    hasErrors(value, options = {}) {
+        return super.hasErrors(value, {
+            ...options,
+            pattern: options?.pattern || constants_1.DEFAULT_PATTERNS.EMAIL,
+        });
     }
 };
 exports.EmailValidator = EmailValidator;

package/lib/validation/Validators/EmailValidator.d.ts

@@ -1,4 +1,4 @@
-import { PatternValidator } from "./PatternValidator";
+import { PatternValidator, PatternValidatorOptions } from "./PatternValidator";
 /**
  * @summary Email Validator
  *
@@ -15,8 +15,7 @@ export declare class EmailValidator extends PatternValidator {
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {RegExp} [pattern]
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} [options]
      *
      * @return {string | undefined}
      *
@@ -24,5 +23,5 @@ export declare class EmailValidator extends PatternValidator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: string, pattern?: RegExp, message?: string): string | undefined;
+    hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/ListValidator.cjs

@@ -31,8 +31,7 @@ let ListValidator = class ListValidator extends Validator_1.Validator {
      * @summary Validates a model
      *
      * @param {any[] | Set<any>} value
-     * @param {string} clazz
-     * @param {string} [message]
+     * @param {ListValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -40,10 +39,10 @@ let ListValidator = class ListValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, clazz, message) {
+    hasErrors(value, options) {
         if (!value || (Array.isArray(value) ? !value.length : !value.size))
             return;
-        clazz = Array.isArray(clazz) ? clazz : [clazz];
+        const clazz = Array.isArray(options.clazz) ? options.clazz : [options.clazz];
         let val, isValid = true;
         for (let i = 0; i < (Array.isArray(value) ? value.length : value.size); i++) {
             val = value[i];
@@ -59,7 +58,7 @@ let ListValidator = class ListValidator extends Validator_1.Validator {
         }
         return isValid
             ? undefined
-            : this.getMessage(message || this.message, clazz);
+            : this.getMessage(options.message || this.message, clazz);
     }
 };
 exports.ListValidator = ListValidator;

package/lib/validation/Validators/ListValidator.d.ts

@@ -1,4 +1,7 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface ListValidatorOptions extends ValidatorOptions {
+    clazz: string[];
+}
 /**
  * @summary List Validator
  *
@@ -9,14 +12,13 @@ import { Validator } from "./Validator";
  *
  * @category Validators
  */
-export declare class ListValidator extends Validator {
+export declare class ListValidator extends Validator<ListValidatorOptions> {
     constructor(message?: string);
     /**
      * @summary Validates a model
      *
      * @param {any[] | Set<any>} value
-     * @param {string} clazz
-     * @param {string} [message]
+     * @param {ListValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -24,5 +26,5 @@ export declare class ListValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: any[] | Set<any>, clazz: string[], message?: string): string | undefined;
+    hasErrors(value: any[] | Set<any>, options: ListValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/MaxLengthValidator.cjs

@@ -32,8 +32,7 @@ let MaxLengthValidator = class MaxLengthValidator extends Validator_1.Validator
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {number} maxlength
-     * @param {string} [message]
+     * @param {MaxLengthValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -41,11 +40,11 @@ let MaxLengthValidator = class MaxLengthValidator extends Validator_1.Validator
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, maxlength, message) {
+    hasErrors(value, options) {
         if (typeof value === "undefined")
             return;
-        return value.length > maxlength
-            ? this.getMessage(message || this.message, maxlength)
+        return value.length > options.maxLength
+            ? this.getMessage(options.message || this.message, options.maxLength)
             : undefined;
     }
 };

package/lib/validation/Validators/MaxLengthValidator.d.ts

@@ -1,4 +1,7 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface MaxLengthValidatorOptions extends ValidatorOptions {
+    maxLength: number;
+}
 /**
  * @summary Maximum Length Validator
  * @description Validates strings and Arrays on their maximum length
@@ -10,14 +13,13 @@ import { Validator } from "./Validator";
  *
  * @category Validators
  */
-export declare class MaxLengthValidator extends Validator {
+export declare class MaxLengthValidator extends Validator<MaxLengthValidatorOptions> {
     constructor(message?: string);
     /**
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {number} maxlength
-     * @param {string} [message]
+     * @param {MaxLengthValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -25,5 +27,5 @@ export declare class MaxLengthValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: string | any[], maxlength: number, message?: string): string | undefined;
+    hasErrors(value: string | any[], options: MaxLengthValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/MaxValidator.cjs

@@ -31,8 +31,7 @@ let MaxValidator = class MaxValidator extends Validator_1.Validator {
      * @summary Validates a Model
      *
      * @param {string} value
-     * @param {number | Date | string} max
-     * @param {string} [message]
+     * @param {MaxValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -40,16 +39,17 @@ let MaxValidator = class MaxValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, max, message) {
+    hasErrors(value, options) {
         if (typeof value === "undefined")
             return;
+        let { max } = options;
         if (value instanceof Date && !(max instanceof Date)) {
             max = new Date(max);
             if (Number.isNaN(max.getDate()))
                 throw new Error("Invalid Max param defined");
         }
         return value > max
-            ? this.getMessage(message || this.message, max)
+            ? this.getMessage(options.message || this.message, max)
             : undefined;
     }
 };