@decaf-ts/decorator-validation 1.4.21 → 1.5.1

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

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

package/lib/validation/Validators/MinLengthValidator.cjs

@@ -31,8 +31,7 @@ let MinLengthValidator = class MinLengthValidator extends Validator_1.Validator
     /**
      *
      * @param {string | Array} value
-     * @param {number} minlength
-     * @param {string} [message]
+     * @param {MinLengthValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -41,11 +40,11 @@ let MinLengthValidator = class MinLengthValidator extends Validator_1.Validator
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, minlength, message) {
+    hasErrors(value, options) {
         if (typeof value === "undefined")
             return;
-        return value.length < minlength
-            ? this.getMessage(message || this.message, minlength)
+        return value.length < options.minLength
+            ? this.getMessage(options.message || this.message, options.minLength)
             : undefined;
     }
 };

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

@@ -1,4 +1,7 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface MinLengthValidatorOptions extends ValidatorOptions {
+    minLength: number;
+}
 /**
  * @summary Minimum Length Validator
  * @description Validates strings and Arrays on their minimum length
@@ -10,13 +13,12 @@ import { Validator } from "./Validator";
  *
  * @category Validators
  */
-export declare class MinLengthValidator extends Validator {
+export declare class MinLengthValidator extends Validator<MinLengthValidatorOptions> {
     constructor(message?: string);
     /**
      *
      * @param {string | Array} value
-     * @param {number} minlength
-     * @param {string} [message]
+     * @param {MinLengthValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -25,5 +27,5 @@ export declare class MinLengthValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: string | any[], minlength: number, message?: string): string | undefined;
+    hasErrors(value: string | any[], options: MinLengthValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/MinValidator.cjs

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

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

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

package/lib/validation/Validators/PasswordValidator.cjs

@@ -31,8 +31,7 @@ let PasswordValidator = class PasswordValidator extends PatternValidator_1.Patte
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {RegExp} [pattern]
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} [options={}]
      *
      * @return {string | undefined}
      *
@@ -40,8 +39,11 @@ let PasswordValidator = class PasswordValidator extends PatternValidator_1.Patte
      *
      * @see PatternValidator#hasErrors
      */
-    hasErrors(value, pattern, message) {
-        return super.hasErrors(value, pattern || constants_1.DEFAULT_ERROR_MESSAGES.PASSWORD, message || this.message);
+    hasErrors(value, options = {}) {
+        return super.hasErrors(value, {
+            ...options,
+            message: options.message || this.message,
+        });
     }
 };
 exports.PasswordValidator = PasswordValidator;

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

@@ -1,4 +1,4 @@
-import { PatternValidator } from "./PatternValidator";
+import { PatternValidator, PatternValidatorOptions } from "./PatternValidator";
 /**
  * @summary Handles Password Validation
  *
@@ -15,8 +15,7 @@ export declare class PasswordValidator 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 PasswordValidator extends PatternValidator {
      *
      * @see PatternValidator#hasErrors
      */
-    hasErrors(value: string, pattern?: RegExp, message?: string): string | undefined;
+    hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/PatternValidator.cjs

@@ -45,8 +45,7 @@ let PatternValidator = class PatternValidator extends Validator_1.Validator {
      * @summary Validates a Model
      *
      * @param {string} value
-     * @param {RegExp | string} pattern
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -54,15 +53,16 @@ let PatternValidator = class PatternValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, pattern, message) {
+    hasErrors(value, options) {
         if (!value)
             return;
+        let { pattern } = options;
         if (!pattern)
             throw new Error("Missing Pattern");
         pattern = typeof pattern === "string" ? this.getPattern(pattern) : pattern;
         pattern.lastIndex = 0; // resets pattern position for repeat validation requests
         return !pattern.test(value)
-            ? this.getMessage(message || this.message)
+            ? this.getMessage(options.message || this.message)
             : undefined;
     }
 };

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

@@ -1,4 +1,7 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface PatternValidatorOptions extends ValidatorOptions {
+    pattern?: RegExp | string;
+}
 export declare const regexpParser: RegExp;
 /**
  * @summary Pattern Validator
@@ -11,7 +14,7 @@ export declare const regexpParser: RegExp;
  *
  * @category Validators
  */
-export declare class PatternValidator extends Validator {
+export declare class PatternValidator extends Validator<PatternValidatorOptions> {
     constructor(message?: string);
     /**
      * @summary parses and validates a pattern
@@ -24,8 +27,7 @@ export declare class PatternValidator extends Validator {
      * @summary Validates a Model
      *
      * @param {string} value
-     * @param {RegExp | string} pattern
-     * @param {string} [message]
+     * @param {PatternValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -33,5 +35,5 @@ export declare class PatternValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: string, pattern?: RegExp | string, message?: string): string | undefined;
+    hasErrors(value: string, options: PatternValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/RequiredValidator.cjs

@@ -31,7 +31,7 @@ let RequiredValidator = class RequiredValidator extends Validator_1.Validator {
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {string} [message]
+     * @param {ValidatorOptions} [options={}]
      *
      * @return {string | undefined}
      *
@@ -39,15 +39,17 @@ let RequiredValidator = class RequiredValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, message) {
+    hasErrors(value, options = {}) {
         switch (typeof value) {
             case "boolean":
             case "number":
                 return typeof value === "undefined"
-                    ? this.getMessage(message || this.message)
+                    ? this.getMessage(options.message || this.message)
                     : undefined;
             default:
-                return !value ? this.getMessage(message || this.message) : undefined;
+                return !value
+                    ? this.getMessage(options.message || this.message)
+                    : undefined;
         }
     }
 };

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

@@ -1,4 +1,4 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
 /**
  * @summary Required Validator
  *
@@ -15,7 +15,7 @@ export declare class RequiredValidator extends Validator {
      * @summary Validates a model
      *
      * @param {string} value
-     * @param {string} [message]
+     * @param {ValidatorOptions} [options={}]
      *
      * @return {string | undefined}
      *
@@ -23,5 +23,5 @@ export declare class RequiredValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: any, message?: string): string | undefined;
+    hasErrors(value: any, options?: ValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/StepValidator.cjs

@@ -32,7 +32,7 @@ let StepValidator = class StepValidator extends Validator_1.Validator {
      *
      * @param {string} value
      * @param {number} step
-     * @param {string} [message]
+     * @param {StepValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -40,11 +40,11 @@ let StepValidator = class StepValidator extends Validator_1.Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value, step, message) {
+    hasErrors(value, options) {
         if (typeof value === "undefined")
             return;
-        return Number(value) % Number(step) !== 0
-            ? this.getMessage(message || this.message, step)
+        return Number(value) % Number(options.step) !== 0
+            ? this.getMessage(options.message || this.message, options.step)
             : undefined;
     }
 };

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

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

package/lib/validation/Validators/TypeValidator.cjs

@@ -31,8 +31,7 @@ let TypeValidator = class TypeValidator extends Validator_1.Validator {
     /**
      * @summary Validates a model
      * @param {string} value
-     * @param {string | string[] | {name: string}} types
-     * @param {string} [message]
+     * @param {TypeValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -40,9 +39,10 @@ let TypeValidator = class TypeValidator extends Validator_1.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_1.Reflection.evaluateDesignTypes(value, types))
             return this.getMessage(message || this.message, typeof types === "string"
                 ? types

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

@@ -1,4 +1,9 @@
-import { Validator } from "./Validator";
+import { Validator, ValidatorOptions } from "./Validator";
+export interface TypeValidatorOptions extends ValidatorOptions {
+    types: string | string[] | {
+        name: string;
+    };
+}
 /**
  * @summary Required Validator
  *
@@ -7,13 +12,12 @@ import { Validator } from "./Validator";
  *
  * @category Validators
  */
-export declare class TypeValidator extends Validator {
+export declare class TypeValidator extends Validator<TypeValidatorOptions> {
     constructor(message?: string);
     /**
      * @summary Validates a model
      * @param {string} value
-     * @param {string | string[] | {name: string}} types
-     * @param {string} [message]
+     * @param {TypeValidatorOptions} options
      *
      * @return {string | undefined}
      *
@@ -21,7 +25,5 @@ export declare class TypeValidator extends Validator {
      *
      * @see Validator#hasErrors
      */
-    hasErrors(value: any, types: string | string[] | {
-        name: string;
-    }, message?: string): string | undefined;
+    hasErrors(value: any, options: TypeValidatorOptions): string | undefined;
 }

package/lib/validation/Validators/URLValidator.cjs

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

package/lib/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/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/validation/decorators.cjs

@@ -48,7 +48,7 @@ function required(message = constants_1.DEFAULT_ERROR_MESSAGES.REQUIRED) {
  */
 function min(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MIN), {
-        value: value,
+        min: value,
         message: message,
         types: [Number.name, Date.name],
     });
@@ -66,7 +66,7 @@ function min(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN) {
  */
 function max(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MAX), {
-        value: value,
+        max: value,
         message: message,
         types: [Number.name, Date.name],
     });
@@ -84,7 +84,7 @@ function max(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX) {
  */
 function step(value, message = constants_1.DEFAULT_ERROR_MESSAGES.STEP) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.STEP), {
-        value: value,
+        step: value,
         message: message,
         types: [Number.name],
     });
@@ -102,7 +102,7 @@ function step(value, message = constants_1.DEFAULT_ERROR_MESSAGES.STEP) {
  */
 function minlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN_LENGTH) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MIN_LENGTH), {
-        value: value,
+        minLength: value,
         message: message,
         types: [String.name, Array.name, Set.name],
     });
@@ -120,7 +120,7 @@ function minlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN_LENGT
  */
 function maxlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX_LENGTH) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MAX_LENGTH), {
-        value: value,
+        maxLength: value,
         message: message,
         types: [String.name, Array.name, Set.name],
     });
@@ -138,7 +138,7 @@ function maxlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX_LENGT
  */
 function pattern(value, message = constants_1.DEFAULT_ERROR_MESSAGES.PATTERN) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.PATTERN), {
-        value: typeof value === "string" ? value : value.toString(),
+        pattern: typeof value === "string" ? value : value.toString(),
         message: message,
         types: [String.name],
     });
@@ -281,7 +281,7 @@ function password(pattern = constants_1.DEFAULT_PATTERNS.PASSWORD.CHAR8_ONE_OF_E
  */
 function list(clazz, collection = "Array", message = constants_1.DEFAULT_ERROR_MESSAGES.LIST) {
     return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/decorator-validation",
-  "version": "1.4.21",
+  "version": "1.5.1",
   "description": "simple decorator based validation engine",
   "type": "module",
   "exports": {

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

@@ -1,12 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary Marks the class as a validator for a certain key.
- * @description Registers the class in the {@link Validation} with the provided key
- *
- * @param {string} keys the validation key
- *
- * @function validator
- *
- * @category Decorators
- */
-export declare function validator<T extends Validator>(...keys: string[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;