@decaf-ts/decorator-validation 1.0.7

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

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(r,a,t,e){void 0===e&&(e=t);var i=Object.getOwnPropertyDescriptor(a,t);i&&("get"in i?a.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return a[t]}}),Object.defineProperty(r,e,i)}:function(r,a,t,e){r[e=void 0===e?t:e]=a[t]}),__exportStar=this&&this.__exportStar||function(r,a){for(var t in r)"default"===t||Object.prototype.hasOwnProperty.call(a,t)||__createBinding(a,r,t)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Validators=void 0;const DateValidator_1=require("./DateValidator/index.cjs"),TypeValidator_1=require("./TypeValidator/index.cjs"),PasswordValidator_1=require("./PasswordValidator/index.cjs"),StepValidator_1=require("./StepValidator/index.cjs"),URLValidator_1=require("./URLValidator/index.cjs"),PatternValidator_1=require("./PatternValidator/index.cjs"),MinValidator_1=require("./MinValidator/index.cjs"),MinLengthValidator_1=require("./MinLengthValidator/index.cjs"),MaxValidator_1=require("./MaxValidator/index.cjs"),MaxLengthValidator_1=require("./MaxLengthValidator/index.cjs"),RequiredValidator_1=require("./RequiredValidator/index.cjs"),EmailValidator_1=require("./EmailValidator/index.cjs"),ListValidator_1=require("./ListValidator/index.cjs");__exportStar(require("./constants/index.cjs"),exports),__exportStar(require("./Validator/index.cjs"),exports),__exportStar(require("./types/index.cjs"),exports),__exportStar(require("./ValidatorRegistry/index.cjs"),exports),__exportStar(require("./EmailValidator/index.cjs"),exports),__exportStar(require("./RequiredValidator/index.cjs"),exports),__exportStar(require("./MaxLengthValidator/index.cjs"),exports),__exportStar(require("./MaxValidator/index.cjs"),exports),__exportStar(require("./MinLengthValidator/index.cjs"),exports),__exportStar(require("./MinValidator/index.cjs"),exports),__exportStar(require("./PatternValidator/index.cjs"),exports),__exportStar(require("./URLValidator/index.cjs"),exports),__exportStar(require("./StepValidator/index.cjs"),exports),__exportStar(require("./DateValidator/index.cjs"),exports),__exportStar(require("./TypeValidator/index.cjs"),exports),__exportStar(require("./PasswordValidator/index.cjs"),exports),exports.Validators={EmailValidator:EmailValidator_1.EmailValidator,RequiredValidator:RequiredValidator_1.RequiredValidator,MaxLengthValidator:MaxLengthValidator_1.MaxLengthValidator,MaxValidator:MaxValidator_1.MaxValidator,MinLengthValidator:MinLengthValidator_1.MinLengthValidator,MinValidator:MinValidator_1.MinValidator,PatternValidator:PatternValidator_1.PatternValidator,URLValidator:URLValidator_1.URLValidator,StepValidator:StepValidator_1.StepValidator,DateValidator:DateValidator_1.DateValidator,TypeValidator:TypeValidator_1.TypeValidator,PasswordValidator:PasswordValidator_1.PasswordValidator,ListValidator:ListValidator_1.ListValidator};

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/lib/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;
+}

package/lib/validation/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.set=exports.list=exports.password=exports.date=exports.parseDate=exports.formatDate=exports.twoDigitPad=exports.isValidDate=exports.bindDateToString=exports.type=exports.url=exports.email=exports.pattern=exports.maxlength=exports.minlength=exports.step=exports.max=exports.min=exports.required=exports.getValidationKey=void 0,require("reflect-metadata");const Validators_1=require("./Validators/index.cjs"),Validators_2=require("./Validators/index.cjs"),utils_1=require("../utils/index.cjs"),ListValidator_1=require("./Validators/ListValidator/index.cjs"),Validation_1=require("./Validation/index.cjs");function getValidationKey(a){return Validators_1.ValidationKeys.REFLECT+a}function required(e=Validators_1.DEFAULT_ERROR_MESSAGES.REQUIRED,i=Validators_2.RequiredValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.REQUIRED),{message:e},a,t),Validation_1.Validation.register({validator:i,validationKey:Validators_1.ValidationKeys.REQUIRED,save:!0})}}function min(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.MIN,r=Validators_2.MinValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.MIN),{value:e,message:i,types:[Number.name,Date.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.MIN,save:!0})}}function max(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.MAX,r=Validators_2.MaxValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.MAX),{value:e,message:i,types:[Number.name,Date.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.MAX,save:!0})}}function step(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.STEP,r=Validators_2.StepValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.STEP),{value:e,message:i,types:[Number.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.STEP,save:!0})}}function minlength(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.MIN_LENGTH,r=Validators_2.MinLengthValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.MIN_LENGTH),{value:e,message:i,types:[String.name,Array.name,Set.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.MIN_LENGTH,save:!0})}}function maxlength(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.MAX_LENGTH,r=Validators_2.MaxLengthValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.MAX_LENGTH),{value:e,message:i,types:[String.name,Array.name,Set.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.MAX_LENGTH,save:!0})}}function pattern(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.PATTERN,r=Validators_2.PatternValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.PATTERN),{value:"string"==typeof e?e:e.toString(),message:i,types:[String.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.PATTERN,save:!0})}}function email(e=Validators_1.DEFAULT_ERROR_MESSAGES.EMAIL,i=Validators_2.EmailValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.EMAIL),{message:e,types:[String.name]},a,t),Validation_1.Validation.register({validator:i,validationKey:Validators_1.ValidationKeys.EMAIL,save:!0})}}function url(e=Validators_1.DEFAULT_ERROR_MESSAGES.URL,i=Validators_2.URLValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.URL),{message:e,types:[String.name]},a,t),Validation_1.Validation.register({validator:i,validationKey:Validators_1.ValidationKeys.URL,save:!0})}}function type(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.TYPE,r=Validators_2.TypeValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.TYPE),{customTypes:e,message:i},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.TYPE,save:!0})}}function bindDateToString(a,t){var e;if(a)return e=()=>formatDate(a,t),Object.defineProperty(a,"toISOString",{enumerable:!1,configurable:!1,value:e}),Object.defineProperty(a,"toString",{enumerable:!1,configurable:!1,value:e}),a}function isValidDate(a){return a&&"[object Date]"===Object.prototype.toString.call(a)&&!isNaN(a)}function twoDigitPad(a){return a<10?"0"+a:a.toString()}function formatDate(a,t="yyyy/MM/dd"){var e=a.getDate(),i=a.getMonth(),r=a.getFullYear(),o=a.getHours(),s=a.getMinutes(),l=a.getSeconds(),n=a.getMilliseconds(),d=o%12,V=twoDigitPad(d),_=twoDigitPad(o),p=twoDigitPad(s),g=twoDigitPad(l),y=o<12?"AM":"PM",a=Validators_1.DAYS_OF_WEEK_NAMES[a.getDay()],E=a.substr(0,3),u=twoDigitPad(e),S=i+1,c=twoDigitPad(S),i=Validators_1.MONTH_NAMES[i],m=i.substr(0,3),r=r+"",f=r.substr(2,2);return t=-1<(t=t.replace("hh",V).replace("h",d.toString()).replace("HH",_).replace("H",o.toString()).replace("mm",p).replace("m",s.toString()).replace("ss",g).replace("s",l.toString()).replace("S",n.toString()).replace("dd",u).replace("d",e.toString()).replace("EEEE",a).replace("EEE",E).replace("yyyy",r).replace("yy",f).replace("aaa",y)).indexOf("MMM")?t.replace("MMMM",i).replace("MMM",m):t.replace("MM",c).replace("M",S.toString())}function parseDate(t,e){let a=void 0;if(e){if(e instanceof Date)try{a=(0,utils_1.dateFromFormat)(formatDate(e,t),t)}catch(a){throw new Error((0,utils_1.stringFormat)("Could not convert date {0} to format: {1}",e.toString(),t))}else if("string"==typeof e)a=(0,utils_1.dateFromFormat)(e,t);else if("number"==typeof e){var i=new Date(e);a=(0,utils_1.dateFromFormat)(formatDate(i,t),t)}else{if(!isValidDate(e))throw new Error("Invalid value provided "+e);try{var r=new Date(e);a=(0,utils_1.dateFromFormat)(formatDate(r,t),t)}catch(a){throw new Error((0,utils_1.stringFormat)("Could not convert date {0} to format: {1}",e,t))}}return bindDateToString(a,t)}}function date(r="dd/MM/yyyy",t=Validators_1.DEFAULT_ERROR_MESSAGES.DATE,o=Validators_2.DateValidator){return(a,e)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.DATE),{format:r,message:t,types:[Date.name]},a,e),Validation_1.Validation.register({validator:o,validationKey:Validators_1.ValidationKeys.DATE,save:!0});const i=new WeakMap;Object.defineProperty(a,e,{configurable:!1,set(a){var t=Object.getOwnPropertyDescriptor(this,e);t&&!t.configurable||Object.defineProperty(this,e,{enumerable:!0,configurable:!1,get:()=>i.get(this),set:a=>{var t;try{t=parseDate(r,a),i.set(this,t)}catch(a){console.error((0,utils_1.stringFormat)("Failed to parse date: {0}",a.message||a))}}}),this[e]=a},get(){console.log("here")}})}}function password(e=Validators_1.PasswordPatterns.CHAR8_ONE_OF_EACH,i=Validators_1.DEFAULT_ERROR_MESSAGES.PASSWORD,r=Validators_2.PasswordValidator){return(a,t)=>{Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.PASSWORD),{pattern:e,message:i,types:[String.name]},a,t),Validation_1.Validation.register({validator:r,validationKey:Validators_1.ValidationKeys.PASSWORD,save:!0})}}function list(e,i="Array",r=Validators_1.DEFAULT_ERROR_MESSAGES.LIST,o=ListValidator_1.ListValidator){return(a,t)=>{type(i)(a,t),Reflect.defineMetadata(getValidationKey(Validators_1.ValidationKeys.LIST),{class:e.name,type:i,message:r},a,t),Validation_1.Validation.register({validator:o,validationKey:Validators_1.ValidationKeys.LIST,save:!0})}}function set(e,i=Validators_1.DEFAULT_ERROR_MESSAGES.LIST,r){return(a,t)=>{list(e,"Set",i,r)(a,t)}}exports.getValidationKey=getValidationKey,exports.required=required,exports.min=min,exports.max=max,exports.step=step,exports.minlength=minlength,exports.maxlength=maxlength,exports.pattern=pattern,exports.email=email,exports.url=url,exports.type=type,exports.bindDateToString=bindDateToString,exports.isValidDate=isValidDate,exports.twoDigitPad=twoDigitPad,exports.formatDate=formatDate,exports.parseDate=parseDate,exports.date=date,exports.password=password,exports.list=list,exports.set=set;

package/lib/validation/decorators.d.ts

@@ -0,0 +1,263 @@
+import "reflect-metadata";
+import { Validator } from "./Validators";
+import { Constructor, ModelConstructor } from "../model";
+/**
+ * @summary Builds the key to store as Metadata under Reflections
+ * @description concatenates {@link ValidationKeys#REFLECT} with the provided key
+ *
+ * @param {string} key
+ *
+ * @function getModelKey
+ * @memberOf module:decorator-validation.Utils
+ * @category Utilities
+ */
+export declare function getValidationKey(key: string): string;
+/**
+ * @summary Marks the property as required.
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#REQUIRED}
+ *
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link RequiredValidator}
+ *
+ * @function required
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function required(message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a minimum value for the property
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#MIN}
+ *
+ * @param {number | Date} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link MinValidator}
+ *
+ * @function min
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function min(value: number | Date | string, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a maximum value for the property
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#MAX}
+ *
+ * @param {number | Date} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link MaxValidator}
+ *
+ * @function max
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function max(value: number | Date | string, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a step value for the property
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#STEP}
+ *
+ * @param {number} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link StepValidator}
+ *
+ * @function step
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function step(value: number, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a minimum length for the property
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#MIN_LENGTH}
+ *
+ * @param {string} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN_LENGTH}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link MinLengthValidator}
+ *
+ * @function minlength
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function minlength(value: number, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a maximum length for the property
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#MAX_LENGTH}
+ *
+ * @param {string} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link MaxLengthValidator}
+ *
+ * @function maxlength
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function maxlength(value: number, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines a RegExp pattern the property must respect
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#PATTERN}
+ *
+ * @param {string} value
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link PatternValidator}
+ *
+ * @function pattern
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function pattern(value: RegExp | string, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines the property as an email
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#EMAIL}
+ *
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link EmailValidator}
+ *
+ * @function email
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function email(message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Defines the property as an URL
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#URL}
+ *
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#URL}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link URLValidator}
+ *
+ * @function url
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function url(message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Enforces type verification
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#TYPE}
+ *
+ * @param {string[] | string} types accepted types
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#TYPE}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link TypeValidator}
+ *
+ * @function type
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function type(types: string[] | string, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary Binds a date format to a string
+ * @param {Date} [date]
+ * @param {string} [format]
+ * @memberOf module:decorator-validation.Utils.Format
+ * @category Utilities
+ */
+export declare function bindDateToString(date: Date | undefined, format: string): Date | undefined;
+/**
+ * @summary Helper function to be used instead of instanceOf Date
+ * @param date
+ * @memberOf module:decorator-validation.Utils.Dates
+ * @category Validation
+ */
+export declare function isValidDate(date: any): boolean;
+/**
+ * @summary Util function to pad numbers
+ * @param {number} num
+ *
+ * @return {string}
+ *
+ * @function twoDigitPad
+ * @memberOf module:decorator-validation.Utils.Format
+ * @category Format
+ */
+export declare function twoDigitPad(num: number): string;
+/**
+ * @summary Date Format Handling
+ * @description Code from {@link https://stackoverflow.com/questions/3552461/how-to-format-a-javascript-date}
+ *
+ * <pre>
+ *      Using similar formatting as Moment.js, Class DateTimeFormatter (Java), and Class SimpleDateFormat (Java),
+ *      I implemented a comprehensive solution formatDate(date, patternStr) where the code is easy to read and modify.
+ *      You can display date, time, AM/PM, etc.
+ *
+ *      Date and Time Patterns
+ *      yy = 2-digit year; yyyy = full year
+ *      M = digit month; MM = 2-digit month; MMM = short month name; MMMM = full month name
+ *      EEEE = full weekday name; EEE = short weekday name
+ *      d = digit day; dd = 2-digit day
+ *      h = hours am/pm; hh = 2-digit hours am/pm; H = hours; HH = 2-digit hours
+ *      m = minutes; mm = 2-digit minutes; aaa = AM/PM
+ *      s = seconds; ss = 2-digit seconds
+ *      S = miliseconds
+ * </pre>
+ *
+ * @param {Date} date
+ * @param {string} [patternStr] defaults to 'yyyy/MM/dd'
+ * @return {string} the formatted date
+ *
+ * @function formatDate
+ * @memberOf module:decorator-validation.Utils.Dates
+ * @category Format
+ */
+export declare function formatDate(date: Date, patternStr?: string): string;
+/**
+ * @summary Parses a date from a specified format
+ * @param {string} format
+ * @param {string | Date | number} [v]
+ * @memberOf module:decorator-validation.Utils.Dates
+ * @category Format
+ */
+export declare function parseDate(format: string, v?: string | Date | number): Date | undefined;
+/**
+ * @summary Date Handler Decorator
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#DATE}
+ *
+ * Will enforce serialization according to the selected format
+ *
+ * @param {string} format accepted format according to {@link formatDate}
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
+ * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link DateValidator}
+ *
+ * @function date
+ *
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function date(format?: string, message?: string, validator?: Constructor<Validator>): (target: Record<string, any>, propertyKey: string) => any;
+/**
+ * @summary Password Handler Decorator
+ * @description Validators to validate a decorated property must use key {@link ValidationKeys#PASSWORD}
+ *
+ * @param {RegExp} [pattern] defaults to {@link PasswordPatterns#CHAR8_ONE_OF_EACH}
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PASSWORD}
+ * @param {Constructor<Validator>} [validator] Defaults to {@link PasswordValidator}
+ *
+ * @function password
+ *
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function password(pattern?: RegExp, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => void;
+/**
+ * @summary List Decorator
+ * @description Also sets the {@link type} to the provided collection
+ *
+ * @param {ModelConstructor} clazz
+ * @param {string} [collection] The collection being used. defaults to Array
+ * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
+ * @param {Constructor<Validator>} [validator] defaults to {@link ListValidator}
+ *
+ * @function list
+ *
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function list(clazz: ModelConstructor<any>, collection?: "Array" | "Set", message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => any;
+/**
+ * @summary Set Decorator
+ * @description Wrapper for {@link list} with the 'Set' Collection
+ *
+ * @param {ModelConstructor} clazz
+ * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
+ * @param {Constructor<Validator>} [validator]
+ *
+ * @function set
+ *
+ * @memberOf module:decorator-validation.Decorators.Validation
+ * @category Decorators
+ */
+export declare function set(clazz: ModelConstructor<any>, message?: string, validator?: Constructor<Validator>): (target: any, propertyKey: string) => any;

package/lib/validation/index.cjs

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(r,e,t,o){void 0===o&&(o=t);var i=Object.getOwnPropertyDescriptor(e,t);i&&("get"in i?e.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return e[t]}}),Object.defineProperty(r,o,i)}:function(r,e,t,o){r[o=void 0===o?t:o]=e[t]}),__exportStar=this&&this.__exportStar||function(r,e){for(var t in r)"default"===t||Object.prototype.hasOwnProperty.call(e,t)||__createBinding(e,r,t)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Decorators=exports.ValidatorRegistryImp=void 0,__exportStar(require("./types/index.cjs"),exports),__exportStar(require("./Validators/index.cjs"),exports);const Validators_1=require("./Validators/index.cjs");exports.ValidatorRegistryImp=Validators_1.ValidatorRegistry,exports.Decorators=require("./decorators/index.cjs"),__exportStar(require("./decorators/index.cjs"),exports),__exportStar(require("./Validation/index.cjs"),exports);

package/lib/validation/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./types";
+export * from "./Validators";
+import { ValidatorRegistry } from "./Validators";
+/**
+ * @summary exports the Validator Registry
+ * @constant ValidatorRegistryImp
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare const ValidatorRegistryImp: typeof ValidatorRegistry;
+export * as Decorators from "./decorators";
+export * from "./decorators";
+export * from "./Validation";

package/lib/validation/types.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/lib/validation/types.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @summary Validator Error type
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type Errors = string | undefined;
+/**
+ * @summary Type for decorator metadata
+ * @memberOf module:decorator-validation.Reflection
+ * @category Reflection
+ */
+export type DecoratorMetadata = {
+    key: string;
+    props: Record<string, any>;
+};
+/**
+ * @summary Type for a validator property decorator definition
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type ValidationPropertyDecoratorDefinition = {
+    prop: string | symbol;
+    decorators: ValidationDecoratorDefinition[];
+};
+/**
+ * @summary Type for a validator decorator definition
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type ValidationDecoratorDefinition = DecoratorMetadata & {
+    props: ValidationElementDefinition;
+};
+/**
+ * @summary Type for a validator element metadata
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type ValidationElementDefinition = {
+    [indexer: string]: any;
+    value?: string | number;
+    message: string;
+    types?: string[];
+};
+/**
+ * @summary Type for a model errors
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export type ModelErrors = {
+    [indexer: string]: {
+        [indexer: string]: Errors;
+    };
+};

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@decaf-ts/decorator-validation",
+  "version": "1.0.7",
+  "description": "simple decorator based validation engine",
+  "type": "module",
+  "exports": {
+    "require": "./lib/index.cjs",
+    "import": "./lib/esm/index.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "do-install": "TOKEN=$(cat .token) npm install",
+    "flash-forward": "npx npm-check-updates -u && npm run do-install",
+    "reset": "rm -rf * && git checkout . && git pull && npm run do-install",
+    "build": "rimraf ./lib && rimraf ./dist && gulp dev",
+    "build:prod": "rimraf ./lib && rimraf ./dist && gulp prod",
+    "test": "jest --coverage --testPathPattern=\"/tests/unit\" --passWithNoTests --detectOpenHandles",
+    "test:integration": "jest --coverage --testPathPattern=\"/tests/(integration)\" --passWithNoTests --detectOpenHandles",
+    "test:all": "jest --coverage --testPathPattern=\"/tests/(unit|integration)\" --passWithNoTests --detectOpenHandles",
+    "lint": "eslint .",
+    "lint-fix": "eslint . && eslint --fix ./src/*",
+    "prepare-release": "npm run lint-fix && npm run build:prod && npm run test && npm run docs",
+    "release": "./bin/tag-release.sh",
+    "clean-publish": "npx clean-publish",
+    "coverage": "npm run test:all && jest-coverage-badges --input \"./workdocs/coverage/coverage-summary.json\" --output \"./workdocs/badges\"",
+    "docs": "npx rimraf ./docs && mkdir docs && npm run do-install -- install better-docs taffydb && gulp docs; npm remove better-docs taffydb"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decaf-ts/decorator-validation.git"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "keywords": [
+    "decorator",
+    "validation",
+    "model",
+    "orm",
+    "custom",
+    "extensible",
+    "lightweight",
+    "decaf-ts",
+    "javascript",
+    "typescript",
+    "ts"
+  ],
+  "author": "Tiago Venceslau",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/decaf-ts/decorator-validation/issues"
+  },
+  "homepage": "https://github.com/decaf-ts/decorator-validation#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "clean-publish": "^4.3.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "gulp": "^4.0.2",
+    "gulp-if": "^3.0.0",
+    "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.1.4",
+    "gulp-run-command": "^0.0.10",
+    "gulp-sourcemaps": "^3.0.0",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^29.7.0",
+    "jest-coverage-badges": "^1.1.2",
+    "jest-junit": "^16.0.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-mermaid": "^1.0.0",
+    "markdown-include": "^0.4.3",
+    "merge-stream": "^2.0.0",
+    "nodemon": "^3.1.0",
+    "npm-check-updates": "^16.14.15",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2",
+    "vinyl-named": "^1.1.0",
+    "webpack-stream": "^7.0.0"
+  },
+  "dependencies": {
+    "install": "^0.13.0",
+    "reflect-metadata": "^0.2.1"
+  }
+}