@decaf-ts/decorator-validation 1.0.7

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

@@ -0,0 +1 @@
+import{PatternValidator}from"./PatternValidator";import{DEFAULT_ERROR_MESSAGES,PasswordPatterns,ValidationKeys}from"./constants";class PasswordValidator extends PatternValidator{constructor(r=DEFAULT_ERROR_MESSAGES.PASSWORD,t=PasswordPatterns.CHAR8_ONE_OF_EACH){super(ValidationKeys.PASSWORD,r),this.pattern=t}hasErrors(r,t,a){return super.hasErrors(r,t||this.pattern,a||this.message)}}export{PasswordValidator};

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

@@ -0,0 +1,38 @@
+import { Validator } from "./Validator";
+import { Errors } from "../types";
+/**
+ * @summary Pattern Validator
+ *
+ * @param {string} [key] defaults to {@link ValidationKeys#PATTERN}
+ * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
+ *
+ * @class PatternValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class PatternValidator extends Validator {
+    private static readonly regexpParser;
+    constructor(key?: string, message?: string);
+    /**
+     * @summary parses and validates a pattern
+     *
+     * @param {string} pattern
+     * @private
+     */
+    private static getPattern;
+    /**
+     * @summary Validates a Model
+     *
+     * @param {string} value
+     * @param {RegExp | string} pattern
+     * @param {string} [message]
+     *
+     * @return Errors
+     *
+     * @override
+     *
+     * @see Validator#hasErrors
+     */
+    hasErrors(value: string, pattern: RegExp | string, message?: string): Errors;
+}

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

@@ -0,0 +1 @@
+import{Validator}from"./Validator";import{ValidationKeys,DEFAULT_ERROR_MESSAGES}from"./constants";class PatternValidator extends Validator{static{this.regexpParser=new RegExp("^/(.+)/([gimus]*)$")}constructor(t=ValidationKeys.PATTERN,r=DEFAULT_ERROR_MESSAGES.PATTERN){super(t,r,"string")}static getPattern(t){var r;return PatternValidator.regexpParser.test(t)?(r=t.match(PatternValidator.regexpParser),new RegExp(r[1],r[2])):new RegExp(t)}hasErrors(t,r,e){if(t)return(r="string"==typeof r?PatternValidator.getPattern(r):r).lastIndex=0,r.test(t)?void 0:this.getMessage(e||this.message)}}export{PatternValidator};

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

@@ -0,0 +1,28 @@
+import { Validator } from "./Validator";
+import { Errors } from "../types";
+/**
+ * @summary Required Validator
+ *
+ * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
+ *
+ * @class RequiredValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class RequiredValidator extends Validator {
+    constructor(message?: string);
+    /**
+     * @summary Validates a model
+     *
+     * @param {string} value
+     * @param {string} [message]
+     *
+     * @return Errors
+     *
+     * @override
+     *
+     * @see Validator#hasErrors
+     */
+    hasErrors(value: any, message?: string): Errors;
+}

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

@@ -0,0 +1 @@
+import{Validator}from"./Validator";import{ValidationKeys,DEFAULT_ERROR_MESSAGES}from"./constants";class RequiredValidator extends Validator{constructor(e=DEFAULT_ERROR_MESSAGES.REQUIRED){super(ValidationKeys.REQUIRED,e)}hasErrors(e,s){switch(typeof e){case"boolean":case"number":return void 0===e?this.getMessage(s||this.message):void 0;default:return e?void 0:this.getMessage(s||this.message)}}}export{RequiredValidator};

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

@@ -0,0 +1,29 @@
+import { Validator } from "./Validator";
+import { Errors } from "../types";
+/**
+ * @summary Step Validator
+ *
+ * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
+ *
+ * @class StepValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class StepValidator extends Validator {
+    constructor(message?: string);
+    /**
+     * @summary Validates a model
+     *
+     * @param {string} value
+     * @param {number} step
+     * @param {string} [message]
+     *
+     * @return Errors
+     *
+     * @override
+     *
+     * @see Validator#hasErrors
+     */
+    hasErrors(value: number | string, step: number | string, message?: string): Errors;
+}

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

@@ -0,0 +1 @@
+import{Validator}from"./Validator";import{ValidationKeys,DEFAULT_ERROR_MESSAGES}from"./constants";class StepValidator extends Validator{constructor(r=DEFAULT_ERROR_MESSAGES.STEP){super(ValidationKeys.STEP,r,"number","string")}hasErrors(r,t,a){return void 0!==r&&Number(r)%Number(t)!=0?this.getMessage(a||this.message,t):void 0}}export{StepValidator};

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

@@ -0,0 +1,28 @@
+import { Errors } from "../types";
+import { Validator } from "./Validator";
+/**
+ * @summary Required Validator
+ *
+ * @class RequiredValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class TypeValidator extends Validator {
+    constructor(message?: string);
+    /**
+     * @summary Validates a model
+     * @param {string} value
+     * @param {string | string[] | {name: string}} types
+     * @param {string} [message]
+     *
+     * @return Errors
+     *
+     * @override
+     *
+     * @see Validator#hasErrors
+     */
+    hasErrors(value: any, types: string | string[] | {
+        name: string;
+    }, message?: string): Errors;
+}

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

@@ -0,0 +1 @@
+import{Validator}from"./Validator";import{evaluateDesignTypes}from"../../utils";import{DEFAULT_ERROR_MESSAGES}from"./constants";import{ModelKeys}from"../../utils/constants";class TypeValidator extends Validator{constructor(t=DEFAULT_ERROR_MESSAGES.TYPE){super(ModelKeys.TYPE,t)}hasErrors(t,e,r){return void 0===t||evaluateDesignTypes(t,e)?void 0:this.getMessage(r||this.message,"string"==typeof e?e:Array.isArray(e)?e.join(", "):e.name,typeof t)}}export{TypeValidator};

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

@@ -0,0 +1,28 @@
+import { Errors } from "../types";
+import { PatternValidator } from "./PatternValidator";
+/**
+ * @summary URL Validator
+ * @description Pattern from {@link https://gist.github.com/dperini/729294}
+ *
+ * @class URLValidator
+ * @extends PatternValidator
+ *
+ * @category Validators
+ */
+export declare class URLValidator extends PatternValidator {
+    private static readonly urlPattern;
+    constructor(message?: string);
+    /**
+     * @summary Validates a model
+     *
+     * @param {string} value
+     * @param {string} [message]
+     *
+     * @return Errors
+     *
+     * @override
+     *
+     * @see Validator#hasErrors
+     */
+    hasErrors(value: string, message?: string): Errors;
+}

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

@@ -0,0 +1 @@
+import{ValidationKeys,DEFAULT_ERROR_MESSAGES}from"./constants";import{PatternValidator}from"./PatternValidator";class URLValidator extends PatternValidator{static{this.urlPattern=/^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+(?:[a-z\u00a1-\uffff]{2,}\.?))(?::\d{2,5})?(?:[/?#]\S*)?$/i}constructor(a=DEFAULT_ERROR_MESSAGES.URL){super(ValidationKeys.URL,a)}hasErrors(a,t){return super.hasErrors(a,URLValidator.urlPattern,t)}}export{URLValidator};

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

@@ -0,0 +1,42 @@
+import { Errors } from "../types";
+/**
+ * @summary Base Implementation for Validators
+ * @description Provides the underlying functionality for {@link Validator}s
+ *
+ * @param {string} validationKey the key to register the validator under
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#DEFAULT}
+ * @param {string[]} [acceptedTypes] defines the value types this validator can validate
+ *
+ * @class Validator
+ * @abstract
+ * @category Validators
+ */
+export declare abstract class Validator {
+    readonly validationKey: string;
+    readonly message: string;
+    readonly acceptedTypes?: string[];
+    protected constructor(validationKey: string, message?: string, ...acceptedTypes: string[]);
+    /**
+     * @summary builds the error message
+     * @param {string} message
+     * @param {any[]} args
+     * @protected
+     */
+    protected getMessage(message: string, ...args: any[]): string;
+    /**
+     * @summary Validates type
+     * @param {any} unbound
+     * @private
+     */
+    private checkTypeAndHasErrors;
+    /**
+     * @summary Validates an attribute
+     * @param {any} value
+     * @param {any[]} args
+     *
+     * @abstract
+     *
+     * @see Model#hasErrors
+     */
+    abstract hasErrors(value: any, ...args: any[]): Errors;
+}

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

@@ -0,0 +1 @@
+import{checkTypes,stringFormat}from"../../utils";import{DEFAULT_ERROR_MESSAGES}from"./constants";class Validator{constructor(s,t=DEFAULT_ERROR_MESSAGES.DEFAULT,...e){this.validationKey=s,this.message=t,e.length&&(this.acceptedTypes=e),this.acceptedTypes&&(this.hasErrors=this.checkTypeAndHasErrors(this.hasErrors.bind(this)))}getMessage(s,...t){return stringFormat(s,...t)}checkTypeAndHasErrors(e){return function(s,...t){return void 0===s||!this.acceptedTypes||checkTypes(s,this.acceptedTypes)?e(s,...t):this.getMessage(DEFAULT_ERROR_MESSAGES.TYPE,this.acceptedTypes.join(", "),typeof s)}.bind(this)}}export{Validator};

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

@@ -0,0 +1,47 @@
+import { ValidatorDefinition } from "./types";
+import { IValidatorRegistry } from "./types";
+import type { Validator } from "./Validator";
+/**
+ * @summary Duck typing for Validators
+ * @function isValidator
+ * @param val
+ */
+export declare function isValidator(val: any): any;
+/**
+ * @summary Base Implementation of a Validator Registry
+ *
+ * @prop {Validator[]} [validators] the initial validators to register
+ *
+ * @class ValidatorRegistry
+ * @implements IValidatorRegistry<T>
+ *
+ * @category Validation
+ */
+export declare class ValidatorRegistry<T extends Validator> implements IValidatorRegistry<T> {
+    private cache;
+    private customKeyChache;
+    constructor(...validators: (ValidatorDefinition | Validator)[]);
+    /**
+     * @summary retrieves the custom keys
+     */
+    getCustomKeys(): {
+        [indexer: string]: string;
+    };
+    /**
+     * @summary retrieves the registered validators keys
+     */
+    getKeys(): string[];
+    /**
+     * @summary Retrieves a validator
+     *
+     * @param {string} validatorKey one of the {@link ValidationKeys}
+     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
+     */
+    get<T extends Validator>(validatorKey: string): T | undefined;
+    /**
+     * @summary Registers the provided validators onto the registry
+     *
+     * @param {T[] | ValidatorDefinition[]} validator
+     */
+    register<T extends Validator>(...validator: (ValidatorDefinition | T)[]): void;
+}

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

@@ -0,0 +1 @@
+function isValidator(t){return t.constructor&&t.hasErrors}class ValidatorRegistry{constructor(...t){this.cache={},this.customKeyChache={},this.register(...t)}getCustomKeys(){return Object.assign({},this.customKeyChache)}getKeys(){return Object.keys(this.cache)}get(t){var e;if(t in this.cache)return isValidator(e=this.cache[t])?e:(e=new(e.default||e),this.cache[t]=e)}register(...t){t.forEach(t=>{var e,a;isValidator(t)?t.validationKey in this.cache||(this.cache[t.validationKey]=t):({validationKey:t,validator:a,save:e}=t,t in this.cache||(this.cache[t]=a,e&&((a={})[t.toUpperCase()]=t,this.customKeyChache=Object.assign({},this.customKeyChache,a))))})}}export{isValidator,ValidatorRegistry};

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

@@ -0,0 +1,91 @@
+/**
+ * @summary The keys used for validation
+ *
+ * @property {string} REFLECT prefixes others
+ * @property {string} REQUIRED sets as required
+ * @property {string} MIN defines min value
+ * @property {string} MAX defines max value
+ * @property {string} STEP defines step
+ * @property {string} MIN_LENGTH defines min length
+ * @property {string} MAX_LENGTH defines max length
+ * @property {string} PATTERN defines pattern
+ * @property {string} EMAIL defines email
+ * @property {string} URL defines url
+ * @property {string} DATE defines date
+ * @property {string} TYPE defines type
+ * @property {string} PASSWORD defines password
+ * @property {string} LIST defines list
+ *
+ * @constant ValidationKeys
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const ValidationKeys: {
+    REFLECT: string;
+    REQUIRED: string;
+    MIN: string;
+    MAX: string;
+    STEP: string;
+    MIN_LENGTH: string;
+    MAX_LENGTH: string;
+    PATTERN: string;
+    EMAIL: string;
+    URL: string;
+    DATE: string;
+    TYPE: string;
+    PASSWORD: string;
+    LIST: string;
+};
+/**
+ * @summary list of month names
+ * @description Stores month names. Can be changed for localization purposes
+ *
+ * @constant MONTH_NAMES
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const MONTH_NAMES: string[];
+/**
+ * @summary list of names of days of the week
+ * @description Stores names for days of the week. Can be changed for localization purposes
+ *
+ * @constant DAYS_OF_WEEK_NAMES
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const DAYS_OF_WEEK_NAMES: string[];
+/**
+ * @summary Defines the default error messages
+ *
+ * @property {string} REQUIRED default error message
+ * @property {string} MIN default error message
+ * @property {string} MAX default error message
+ * @property {string} MIN_LENGTH default error message
+ * @property {string} MAX_LENGTH default error message
+ * @property {string} PATTERN default error message
+ * @property {string} EMAIL default error message
+ * @property {string} URL default error message
+ * @property {string} TYPE default error message
+ * @property {string} STEP default error message
+ * @property {string} DATE default error message
+ * @property {string} DEFAULT default error message
+ * @property {string} PASSWORD default error message
+ * @property {string} LIST default error message
+ * @property {string} LIST_INSIDE default error message
+ * @property {string} MODEL_NOT_FOUND default error message
+ *
+ * @constant DEFAULT_ERROR_MESSAGES
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const DEFAULT_ERROR_MESSAGES: Record<string, string>;
+/**
+ * @summary Defines a Password validation regexp
+ *
+ * @enum DEFAULT_ERROR_MESSAGES
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const PasswordPatterns: {
+    CHAR8_ONE_OF_EACH: RegExp;
+};

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

@@ -0,0 +1 @@
+const ValidationKeys={REFLECT:"model.validation.",REQUIRED:"required",MIN:"min",MAX:"max",STEP:"step",MIN_LENGTH:"minlength",MAX_LENGTH:"maxlength",PATTERN:"pattern",EMAIL:"email",URL:"url",DATE:"date",TYPE:"type",PASSWORD:"password",LIST:"list"},MONTH_NAMES=["January","February","March","April","May","June","July","August","September","October","November","December"],DAYS_OF_WEEK_NAMES=["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],DEFAULT_ERROR_MESSAGES={REQUIRED:"This field is required",MIN:"The minimum value is {0}",MAX:"The maximum value is {0}",MIN_LENGTH:"The minimum length is {0}",MAX_LENGTH:"The maximum length is {0}",PATTERN:"The value does not match the pattern",EMAIL:"The value is not a valid email",URL:"The value is not a valid URL",TYPE:"Invalid type. Expected {0}, received {1}",STEP:"Invalid value. Not a step of {0}",DATE:"Invalid value. not a valid Date",DEFAULT:"There is an Error",PASSWORD:"Must be at least 8 characters and contain one of number, lower and upper case letters, and special character (@$!%*?&_-.,)",LIST:"Invalid list of {0}",LIST_INSIDE:"Elements of list are invalid: {0}",MODEL_NOT_FOUND:"No model registered under {0}"},PasswordPatterns={CHAR8_ONE_OF_EACH:/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&_\-.,])[A-Za-z\d@$!%*?&_\-.,]{8,}$/g};export{ValidationKeys,MONTH_NAMES,DAYS_OF_WEEK_NAMES,DEFAULT_ERROR_MESSAGES,PasswordPatterns};

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

@@ -0,0 +1,50 @@
+import { DateValidator } from "./DateValidator";
+import { TypeValidator } from "./TypeValidator";
+import { PasswordValidator } from "./PasswordValidator";
+import { StepValidator } from "./StepValidator";
+import { URLValidator } from "./URLValidator";
+import { PatternValidator } from "./PatternValidator";
+import { MinValidator } from "./MinValidator";
+import { MinLengthValidator } from "./MinLengthValidator";
+import { MaxValidator } from "./MaxValidator";
+import { MaxLengthValidator } from "./MaxLengthValidator";
+import { RequiredValidator } from "./RequiredValidator";
+import { EmailValidator } from "./EmailValidator";
+import { ListValidator } from "./ListValidator";
+export * from "./constants";
+export * from "./Validator";
+export * from "./types";
+export * from "./ValidatorRegistry";
+export * from "./EmailValidator";
+export * from "./RequiredValidator";
+export * from "./MaxLengthValidator";
+export * from "./MaxValidator";
+export * from "./MinLengthValidator";
+export * from "./MinValidator";
+export * from "./PatternValidator";
+export * from "./URLValidator";
+export * from "./StepValidator";
+export * from "./DateValidator";
+export * from "./TypeValidator";
+export * from "./PasswordValidator";
+/**
+ * @summary constant holding all {@link Validator}s
+ * @constant Validators
+ * @memberOf module:decorator-validation.Validation.Validators
+ * @category Validation
+ */
+export declare const Validators: {
+    EmailValidator: typeof EmailValidator;
+    RequiredValidator: typeof RequiredValidator;
+    MaxLengthValidator: typeof MaxLengthValidator;
+    MaxValidator: typeof MaxValidator;
+    MinLengthValidator: typeof MinLengthValidator;
+    MinValidator: typeof MinValidator;
+    PatternValidator: typeof PatternValidator;
+    URLValidator: typeof URLValidator;
+    StepValidator: typeof StepValidator;
+    DateValidator: typeof DateValidator;
+    TypeValidator: typeof TypeValidator;
+    PasswordValidator: typeof PasswordValidator;
+    ListValidator: typeof ListValidator;
+};

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

@@ -0,0 +1 @@
+import{DateValidator}from"./DateValidator";import{TypeValidator}from"./TypeValidator";import{PasswordValidator}from"./PasswordValidator";import{StepValidator}from"./StepValidator";import{URLValidator}from"./URLValidator";import{PatternValidator}from"./PatternValidator";import{MinValidator}from"./MinValidator";import{MinLengthValidator}from"./MinLengthValidator";import{MaxValidator}from"./MaxValidator";import{MaxLengthValidator}from"./MaxLengthValidator";import{RequiredValidator}from"./RequiredValidator";import{EmailValidator}from"./EmailValidator";import{ListValidator}from"./ListValidator";export*from"./constants";export*from"./Validator";export*from"./types";export*from"./ValidatorRegistry";export*from"./EmailValidator";export*from"./RequiredValidator";export*from"./MaxLengthValidator";export*from"./MaxValidator";export*from"./MinLengthValidator";export*from"./MinValidator";export*from"./PatternValidator";export*from"./URLValidator";export*from"./StepValidator";export*from"./DateValidator";export*from"./TypeValidator";export*from"./PasswordValidator";const Validators={EmailValidator:EmailValidator,RequiredValidator:RequiredValidator,MaxLengthValidator:MaxLengthValidator,MaxValidator:MaxValidator,MinLengthValidator:MinLengthValidator,MinValidator:MinValidator,PatternValidator:PatternValidator,URLValidator:URLValidator,StepValidator:StepValidator,DateValidator:DateValidator,TypeValidator:TypeValidator,PasswordValidator:PasswordValidator,ListValidator:ListValidator};export{Validators};

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

@@ -0,0 +1,51 @@
+import { Validator } from "./Validator";
+import { IRegistry } from "../../utils";
+import { Constructor } from "../../model";
+/**
+ * @summary Util type for {@link Validator} configuration
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type ValidatorDefinition = {
+    validator: Constructor<Validator>;
+    validationKey: string;
+    save: boolean;
+};
+/**
+ * @summary Base API for a {@link Validator} registry
+ *
+ * @interface ValidatorRegistry
+ * @extends IRegistry
+ *
+ * @category Validation
+ */
+export interface IValidatorRegistry<T extends Validator> extends IRegistry<T> {
+    /**
+     * @summary retrieves the custom keys
+     * @method
+     */
+    getCustomKeys(): Record<string, string>;
+    /**
+     * @summary Retrieves the Registered validator keys
+     * @return {string[]} the registered validators keys
+     * @method
+     */
+    getKeys(): string[];
+    /**
+     * @summary Registers the provided validators onto the registry
+     *
+     * @typedef T extends Validator
+     * @param {T[] | ValidatorDefinition[]} validator
+     * @method
+     */
+    register<T extends Validator>(...validator: (T | ValidatorDefinition)[]): void;
+    /**
+     * @summary Retrieves the Validator constructor if registered
+     *
+     * @typedef T extends Validator
+     * @param {string} key one of the {@link ValidationKeys}
+     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
+     * @method
+     */
+    get<T extends Validator>(key: string): T | undefined;
+}