@decaf-ts/decorator-validation 1.0.7

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

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

package/lib/esm/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/esm/validation/index.js

@@ -0,0 +1 @@
+export*from"./types";export*from"./Validators";import{ValidatorRegistry}from"./Validators";const ValidatorRegistryImp=ValidatorRegistry;export*as Decorators from"./decorators";export*from"./decorators";export*from"./Validation";export{ValidatorRegistryImp};

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

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&("get"in o?t.__esModule:!o.writable&&!o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){e[i=void 0===i?r:i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),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.0.7";

package/lib/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @module decorator-validation
+ */
+/**
+ * @summary Defines the Model object
+ * @namespace Model
+ * @memberOf module:decorator-validation
+ */
+/**
+ * @summary Holds all the supported decorators
+ * @namespace Decorators
+ * @memberOf module:decorator-validation
+ */
+/**
+ * @namespace Validation
+ * @memberOf module:decorator-validation.Decorators
+ */
+/**
+ * @namespace Model
+ * @memberOf module:decorator-validation.Decorators
+ */
+/**
+ * @namespace Construction
+ * @memberOf module:decorator-validation
+ */
+/**
+ * @namespace Validation
+ * @memberOf module:decorator-validation
+ */
+/**
+ * @namespace Validators
+ * @memberOf module:decorator-validation.Validation
+ */
+/**
+ * @namespace Utils
+ * @memberOf module:decorator-validation
+ */
+/**
+ * @namespace Dates
+ * @memberOf module:decorator-validation.Utils
+ */
+/**
+ * @namespace Equality
+ * @memberOf module:decorator-validation.Utils
+ */
+/**
+ * @namespace Hashing
+ * @memberOf module:decorator-validation.Utils
+ */
+/**
+ * @namespace Serialization
+ * @memberOf module:decorator-validation.Utils
+ */
+/**
+ * @namespace Format
+ * @memberOf module:decorator-validation.Utils
+ */
+export * from "./utils";
+export * from "./validation";
+export * from "./model";
+export declare const VERSION = "1.0.7";

package/lib/model/Model.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Model=exports.validate=void 0;const validation_1=require("../validation/index.cjs"),utils_1=require("../utils/index.cjs"),ModelErrorDefinition_1=require("./ModelErrorDefinition/index.cjs"),constants_1=require("./constants/index.cjs"),constants_2=require("../utils/constants/index.cjs"),construction_1=require("./construction/index.cjs"),Registry_1=require("./Registry/index.cjs"),Validation_1=require("../validation/Validation/index.cjs");function validate(n,...t){var e=[];for(const i in n)n.hasOwnProperty(i)&&-1===t.indexOf(i)&&e.push((0,utils_1.getPropertyDecorators)(validation_1.ValidationKeys.REFLECT,n,i));var r=e.reduce((t,r)=>{const{prop:i,decorators:s}=r;if(s&&s.length){const o=s[0];s.find(t=>t.key===validation_1.ValidationKeys.TYPE||!!t.props.types?.find(t=>t===o.props.name))&&s.shift();let e=s.reduce((t,e)=>{var r=Validation_1.Validation.get(e.key);return r&&(r=r.hasErrors(n[i.toString()],...e.key===constants_2.ModelKeys.TYPE?[e.props]:Object.values(e.props)))&&((t=t||{})[e.key]=r),t},void 0);(e=e||Object.keys(n).filter(t=>!e||!e[t]).reduce((t,r)=>{let i;const s=(0,utils_1.getPropertyDecorators)(validation_1.ValidationKeys.REFLECT,n,r).decorators;var e=s.filter(t=>-1!==[constants_2.ModelKeys.TYPE,validation_1.ValidationKeys.TYPE].indexOf(t.key));if(e&&e.length){e=e.pop(),e=e.props.name?[e.props.name]:Array.isArray(e.props.customTypes)?e.props.customTypes:[e.props.customTypes];const o=Object.values(constants_1.ReservedModels).map(t=>t.toLowerCase());e.forEach(t=>{if(-1===o.indexOf(t.toLowerCase()))switch(t){case"Array":case"Set":var e;s.length&&s.find(t=>t.key===validation_1.ValidationKeys.LIST)&&(e="Array"===t?n[r].find(t=>t.hasErrors()):n[r].values().find(t=>t.hasErrors()))&&(i=(0,utils_1.stringFormat)(validation_1.DEFAULT_ERROR_MESSAGES.LIST_INSIDE,e.toString()));break;default:try{n[r]&&(i=n[r].hasErrors())}catch(t){console.warn((0,utils_1.stringFormat)("Model should be validatable but its not"))}}}),i&&((t=t||{})[r]=i)}return t},void 0))&&((t=t||{})[r.prop.toString()]=e)}return t},void 0);return r?new ModelErrorDefinition_1.ModelErrorDefinition(r):void 0}exports.validate=validate;let modelBuilderFunction,actingModelRegistry,serializer,hashingFunction;class Model{constructor(t){}hasErrors(...t){return validate(this,...t)}equals(t,...e){return(0,utils_1.isEqual)(this,t,...e)}serialize(){return Model.serialize(this)}toString(){return this.constructor.name+": "+JSON.stringify(this,void 0,2)}toHash(){return Model.getHashingFunction()(this).toString()}static deserialize(t){return Model.getSerializer().deserialize(t)}static serialize(t){return Model.getSerializer().serialize(t)}static hash(t){return Model.getHashingFunction()(t)}static fromObject(t,e){return(0,construction_1.constructFromObject)(t,e)}static fromModel(t,e){return(0,construction_1.constructFromModel)(t,e)}static setBuilder(t){modelBuilderFunction=t}static getBuilder(){return modelBuilderFunction}static getRegistry(){return actingModelRegistry=actingModelRegistry||new Registry_1.ModelRegistryManager}static setRegistry(t){actingModelRegistry=t}static register(t,e){return Model.getRegistry().register(t,e)}static get(t){return Model.getRegistry().get(t)}static build(t={},e){return Model.getRegistry().build(t,e)}static setSerializer(t){serializer=t}static getSerializer(){return serializer=serializer||new utils_1.JSONSerializer}static setHashingFunction(t){hashingFunction=t}static getHashingFunction(){return hashingFunction=hashingFunction||utils_1.hashObj}}exports.Model=Model;

package/lib/model/Model.d.ts

@@ -0,0 +1,160 @@
+import { BuilderRegistry, HashingFunction, Serializer } from "../utils";
+import { ModelErrorDefinition } from "./ModelErrorDefinition";
+import { ModelArg, ModelConstructor, Serializable, Validatable } from "./types";
+import { ModelBuilderFunction } from "./construction";
+/**
+ * @summary Analyses the decorations of the properties and validates the obj according to them
+ *
+ * @typedef T extends Model
+ * @prop {T} obj Model object to validate
+ * @prop {string[]} [propsToIgnore] object properties to ignore in the validation
+ *
+ * @function validate
+ * @memberOf module:decorator-validation.Validation
+ * @category Validation
+ */
+export declare function validate<T extends Model>(obj: T, ...propsToIgnore: string[]): ModelErrorDefinition | undefined;
+/**
+ * @summary Abstract class representing a Validatable Model object
+ * @description Meant to be used as a base class for all Model classes
+ *
+ * Model objects must:
+ *  - Have all their properties defined as optional;
+ *  - Have all their properties initialized eg:
+ *
+ *  <pre>
+ *      class ClassName {
+ *          propertyName?: PropertyType = undefined;
+ *      }
+ *  </pre>
+ *
+ * @param {Model | {}} model base object from which to populate properties from
+ *
+ * @class Model
+ * @abstract
+ * @implements Validatable
+ * @implements Serializable
+ *
+ * @category Model
+ */
+export declare abstract class Model implements Validatable, Serializable {
+    [indexer: string]: any;
+    protected constructor(model?: ModelArg<Model>);
+    /**
+     * @summary Validates the object according to its decorated properties
+     *
+     * @param {any[]} [exceptions] properties in the object to be ignored for he validation. Marked as 'any' to allow for extension but expects strings
+     */
+    hasErrors(...exceptions: any[]): ModelErrorDefinition | undefined;
+    /**
+     * @summary Compare object equality recursively
+     * @param {any} obj object to compare to
+     * @param {string} [exceptions] property names to be excluded from the comparison
+     */
+    equals(obj: any, ...exceptions: string[]): boolean;
+    /**
+     * @summary Returns the serialized model according to the currently defined {@link Serializer}
+     */
+    serialize(): string;
+    /**
+     * @summary Override the implementation for js's 'toString()' which sucks...
+     * @override
+     */
+    toString(): string;
+    /**
+     * @summary Defines a default implementation for object hash. Relies on a very basic implementation based on Java's string hash;
+     */
+    toHash(): string;
+    /**
+     * @summary Deserializes a Model
+     * @param {string} str
+     *
+     * @throws {Error} If it fails to parse the string, or if it fails to build the model
+     */
+    static deserialize(str: string): any;
+    /**
+     * @summary Serializes a Model
+     * @param {Model} model
+     */
+    static serialize(model: any): string;
+    static hash(obj: any): string;
+    /**
+     * @summary Wrapper around {@link constructFromObject}
+     * @param {T} self
+     * @param {T | Record<string, any>} obj
+     */
+    static fromObject<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @summary Wrapper around {@link constructFromModel}
+     * @param {T} self
+     * @param {T | Record<string, any>} obj
+     */
+    static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @summary Sets the Global {@link ModelBuilderFunction}
+     * @param {ModelBuilderFunction} [builder]
+     */
+    static setBuilder(builder?: ModelBuilderFunction): void;
+    /**
+     * @summary Retrieves the current global {@link ModelBuilderFunction}
+     */
+    static getBuilder(): ModelBuilderFunction | undefined;
+    /**
+     * Returns the current {@link ModelRegistryManager}
+     *
+     * @return ModelRegistry, defaults to {@link ModelRegistryManager}
+     */
+    private static getRegistry;
+    /**
+     * Returns the current actingModelRegistry
+     *
+     * @param {BuilderRegistry} modelRegistry the new implementation of Registry
+     */
+    static setRegistry(modelRegistry: BuilderRegistry<any>): void;
+    /**
+     * @summary register new Models
+     * @param {any} constructor
+     * @param {string} [name] when not defined, the name of the constructor will be used
+     *
+     * @see ModelRegistry
+     */
+    static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
+    /**
+     * @summary Gets a registered Model {@link ModelConstructor}
+     * @param {string} name
+     *
+     * @see ModelRegistry
+     */
+    static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
+    /**
+     * @param {Record<string, any>} obj
+     * @param {string} [clazz] when provided, it will attempt to find the matching constructor
+     *
+     * @throws Error If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
+     *
+     * @see ModelRegistry
+     */
+    static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
+    /**
+     * @summary Sets the {@link Serializer}
+     *
+     * @param {Serializer} ser
+     */
+    static setSerializer(ser: Serializer<any>): void;
+    /**
+     * @summary Retrieves the current defined {@link Serializer}
+     *
+     */
+    private static getSerializer;
+    /**
+     * @summary Sets the {@link HashingFunction}
+     *
+     * @param {HashingFunction} hasher
+     */
+    static setHashingFunction(hasher: HashingFunction): void;
+    /**
+     * @summary Retrieves the current defined {@link HashingFunction}
+     *
+     */
+    private static getHashingFunction;
+}

package/lib/model/ModelErrorDefinition.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ModelErrorDefinition=void 0;class ModelErrorDefinition{constructor(e){for(const r in e)e.hasOwnProperty(r)&&e[r]&&Object.defineProperty(this,r,{enumerable:!0,configurable:!1,value:e[r],writable:!1})}toString(){const t=this;return Object.keys(t).filter(e=>t.hasOwnProperty(e)&&"function"!=typeof t[e]).reduce((e,o)=>{var r=Object.keys(t[o]).reduce((e,r)=>(e?e+=`
+`+t[o][r]:e=t[o][r],e),void 0);return r&&(r=o+" - "+r,e?e+=`
+`+r:e=r),e},"")}}exports.ModelErrorDefinition=ModelErrorDefinition;

package/lib/model/ModelErrorDefinition.d.ts

@@ -0,0 +1,22 @@
+import { Errors, ModelErrors } from "../validation";
+/**
+ * @summary Helper Class to hold the error results
+ * @description holds error results in an 'indexable' manner
+ * while still providing the same result on toString
+ *
+ * @param {ModelErrors} errors
+ *
+ * @class ModelErrorDefinition
+ *
+ * @category Model
+ */
+export declare class ModelErrorDefinition {
+    [indexer: string]: Record<string, Errors> | (() => Errors);
+    constructor(errors: ModelErrors);
+    /**
+     * @summary Outputs the class to a nice readable string
+     *
+     * @override
+     */
+    toString(): string;
+}

package/lib/model/Registry.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.bulkModelRegister=exports.ModelRegistryManager=void 0;const Model_1=require("./Model/index.cjs"),utils_1=require("../utils/index.cjs"),constants_1=require("../utils/constants/index.cjs");class ModelRegistryManager{constructor(e=constants_1.ModelKeys.ANCHOR,t=utils_1.isModel){this.cache={},this.testFunction=t,this.anchorKey=e}register(e,t){if("function"!=typeof e)throw new Error("Model registering failed. Missing Class name or constructor");t=t||e.name,this.cache[t]=e}get(e){try{return this.cache[e]}catch(e){}}build(e={},t){if(!t&&!this.testFunction(e))throw new Error("Provided obj is not a Model object");t=t||e[this.anchorKey].class;if(t in this.cache)return new this.cache[t](e);throw new Error((0,utils_1.stringFormat)("Provided class {0} is not a registered Model object",t))}}function bulkModelRegister(...e){e.forEach(e=>{var t=e.constructor||e;Model_1.Model.register(t,e.name)})}exports.ModelRegistryManager=ModelRegistryManager,exports.bulkModelRegister=bulkModelRegister;