@decaf-ts/decorator-validation 1.4.21 → 1.5.2

package/lib/esm/utils/serialization.js

@@ -1,88 +0,0 @@
-import { Model } from "../model/Model";
-import { ModelKeys } from "./constants";
-/**
- * @summary Concrete implementation of a {@link Serializer} in JSON format
- * @description JS's native JSON.stringify (used here) is not deterministic
- * and therefore should not be used for hashing purposes
- *
- * To keep dependencies low, we will not implement this, but we recommend
- * implementing a similar {@link JSONSerializer} using 'deterministic-json' libraries
- *
- * @class JSONSerializer
- * @implements Serializer
- *
- * @category Serialization
- */
-export class JSONSerializer {
-    /**
-     * @summary prepares the model for serialization
-     * @description returns a shallow copy of the object, containing an enumerable {@link ModelKeys#ANCHOR} property
-     * so the object can be recognized upon deserialization
-     *
-     * @param {T} model
-     * @protected
-     */
-    preSerialize(model) {
-        // TODO: nested preserialization (so increase performance when deserializing)
-        const toSerialize = Object.assign({}, model);
-        const metadata = Model.getMetadata(model);
-        toSerialize[ModelKeys.ANCHOR] = metadata || model.constructor.name;
-        return toSerialize;
-    }
-    /**
-     * @summary Rebuilds a model from a serialization
-     * @param {string} str
-     *
-     * @throws {Error} If it fails to parse the string, or to build the model
-     */
-    deserialize(str) {
-        const deserialization = JSON.parse(str);
-        const className = deserialization[ModelKeys.ANCHOR];
-        if (!className)
-            throw new Error("Could not find class reference in serialized model");
-        const model = Model.build(deserialization, className);
-        return model;
-    }
-    /**
-     * @summary Serializes a model
-     * @param {T} model
-     *
-     * @throws {Error} if fails to serialize
-     */
-    serialize(model) {
-        return JSON.stringify(this.preSerialize(model));
-    }
-}
-export const DefaultSerializationMethod = "json";
-export class Serialization {
-    static { this.current = DefaultSerializationMethod; }
-    static { this.cache = {
-        json: new JSONSerializer(),
-    }; }
-    constructor() { }
-    static get(key) {
-        if (key in this.cache)
-            return this.cache[key];
-        throw new Error(`No serialization method registered under ${key}`);
-    }
-    static register(key, func, setDefault = false) {
-        if (key in this.cache)
-            throw new Error(`Serialization method ${key} already registered`);
-        this.cache[key] = new func();
-        if (setDefault)
-            this.current = key;
-    }
-    static serialize(obj, method, ...args) {
-        if (!method)
-            return this.get(this.current).serialize(obj, ...args);
-        return this.get(method).serialize(obj, ...args);
-    }
-    static deserialize(obj, method, ...args) {
-        if (!method)
-            return this.get(this.current).deserialize(obj, ...args);
-        return this.get(method).deserialize(obj, ...args);
-    }
-    static setDefault(method) {
-        this.current = this.get(method);
-    }
-}

package/lib/esm/utils/strings.d.ts

@@ -1,25 +0,0 @@
-/**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- *
- * @param {string} string
- * @param {Array<string | number>} [args] replacements made by order of appearance (replacement0 wil replace {0} and so on)
- * @return {string} formatted string
- *
- * @function stringFormat
- * @memberOf module:decorator-validation.Utils.Format
- * @category Format
- */
-export declare function stringFormat(string: string, ...args: (string | number)[]): string;
-/**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- * @description alias for {@link stringFormat}
- *
- * @param {string} string
- * @param {string} args replacements made by order of appearance (replacement0 wil replace {0} and so on)
- * @return {string} formatted string
- *
- * @function sf
- * @memberOf module:decorator-validation.Utils.Format
- * @category Format
- */
-export declare const sf: typeof stringFormat;

package/lib/esm/utils/strings.js

@@ -1,31 +0,0 @@
-/**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- *
- * @param {string} string
- * @param {Array<string | number>} [args] replacements made by order of appearance (replacement0 wil replace {0} and so on)
- * @return {string} formatted string
- *
- * @function stringFormat
- * @memberOf module:decorator-validation.Utils.Format
- * @category Format
- */
-export function stringFormat(string, ...args) {
-    return string.replace(/{(\d+)}/g, function (match, number) {
-        return typeof args[number] !== "undefined"
-            ? args[number].toString()
-            : "undefined";
-    });
-}
-/**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- * @description alias for {@link stringFormat}
- *
- * @param {string} string
- * @param {string} args replacements made by order of appearance (replacement0 wil replace {0} and so on)
- * @return {string} formatted string
- *
- * @function sf
- * @memberOf module:decorator-validation.Utils.Format
- * @category Format
- */
-export const sf = stringFormat;

package/lib/esm/validation/Validation.d.ts

@@ -1,51 +0,0 @@
-import { Validator } from "./Validators/Validator";
-import { IValidatorRegistry, ValidatorDefinition } from "./Validators/types";
-/**
- * @summary Static class acting as a namespace for the Validation
- *
- * @class Validation
- * @static
- *
- * @category Validation
- */
-export declare class Validation {
-    private static actingValidatorRegistry?;
-    private constructor();
-    /**
-     * @summary Defines the acting ValidatorRegistry
-     *
-     * @param {IValidatorRegistry} validatorRegistry the new implementation of the validator Registry
-     * @param {function(Validator): Validator} [migrationHandler] the method to map the validator if required;
-     */
-    static setRegistry(validatorRegistry: IValidatorRegistry<Validator>, migrationHandler?: (validator: Validator) => Validator): void;
-    /**
-     * @summary Returns the current ValidatorRegistry
-     *
-     * @return IValidatorRegistry, defaults to {@link ValidatorRegistry}
-     */
-    private static getRegistry;
-    /**
-     * @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
-     */
-    static get<T extends Validator>(validatorKey: string): T | undefined;
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @param {T[] | ValidatorDefinition[]} validator
-     */
-    static register<T extends Validator>(...validator: (ValidatorDefinition | T)[]): void;
-    /**
-     * @summary Builds the key to store as Metadata under Reflections
-     * @description concatenates {@link ValidationKeys#REFLECT} with the provided key
-     *
-     * @param {string} key
-     */
-    static key(key: string): string;
-    /**
-     * @summary Returns all registered validation keys
-     */
-    static keys(): string[];
-}

package/lib/esm/validation/Validation.js

@@ -1,71 +0,0 @@
-import { ValidatorRegistry } from "./Validators/ValidatorRegistry";
-import { ValidationKeys } from "./Validators/constants";
-/**
- * @summary Static class acting as a namespace for the Validation
- *
- * @class Validation
- * @static
- *
- * @category Validation
- */
-export class Validation {
-    static { this.actingValidatorRegistry = undefined; }
-    constructor() { }
-    /**
-     * @summary Defines the acting ValidatorRegistry
-     *
-     * @param {IValidatorRegistry} validatorRegistry the new implementation of the validator Registry
-     * @param {function(Validator): Validator} [migrationHandler] the method to map the validator if required;
-     */
-    static setRegistry(validatorRegistry, migrationHandler) {
-        if (migrationHandler && Validation.actingValidatorRegistry)
-            Validation.actingValidatorRegistry.getKeys().forEach((k) => {
-                const validator = validatorRegistry.get(k);
-                if (validator)
-                    validatorRegistry.register(migrationHandler(validator));
-            });
-        Validation.actingValidatorRegistry = validatorRegistry;
-    }
-    /**
-     * @summary Returns the current ValidatorRegistry
-     *
-     * @return IValidatorRegistry, defaults to {@link ValidatorRegistry}
-     */
-    static getRegistry() {
-        if (!Validation.actingValidatorRegistry)
-            Validation.actingValidatorRegistry = new ValidatorRegistry();
-        return Validation.actingValidatorRegistry;
-    }
-    /**
-     * @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
-     */
-    static get(validatorKey) {
-        return Validation.getRegistry().get(validatorKey);
-    }
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @param {T[] | ValidatorDefinition[]} validator
-     */
-    static register(...validator) {
-        return Validation.getRegistry().register(...validator);
-    }
-    /**
-     * @summary Builds the key to store as Metadata under Reflections
-     * @description concatenates {@link ValidationKeys#REFLECT} with the provided key
-     *
-     * @param {string} key
-     */
-    static key(key) {
-        return ValidationKeys.REFLECT + key;
-    }
-    /**
-     * @summary Returns all registered validation keys
-     */
-    static keys() {
-        return this.getRegistry().getKeys();
-    }
-}

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

@@ -1,28 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary Date Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
- *
- * @class DateValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class DateValidator extends Validator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {Date | string} value
-     * @param {string} format
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: Date | string, format: string, message?: string): string | undefined;
-}

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

@@ -1,53 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { Validator } from "./Validator";
-import { ValidationKeys, DEFAULT_ERROR_MESSAGES } from "./constants";
-import { validator } from "./decorators";
-/**
- * @summary Date Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
- *
- * @class DateValidator
- * @extends Validator
- *
- * @category Validators
- */
-let DateValidator = class DateValidator extends Validator {
-    constructor(message = DEFAULT_ERROR_MESSAGES.DATE) {
-        super(message, Number.name, Date.name, String.name);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {Date | string} value
-     * @param {string} format
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, format, message) {
-        if (value === undefined)
-            return;
-        if (typeof value === "string")
-            value = new Date(value);
-        if (Number.isNaN(value.getDate()))
-            return this.getMessage(message || this.message);
-    }
-};
-DateValidator = __decorate([
-    validator(ValidationKeys.DATE),
-    __metadata("design:paramtypes", [String])
-], DateValidator);
-export { DateValidator };

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

@@ -1,28 +0,0 @@
-import { PatternValidator } from "./PatternValidator";
-/**
- * @summary Email Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
- *
- * @class EmailValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-export declare class EmailValidator extends PatternValidator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {RegExp} [pattern]
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: string, pattern?: RegExp, message?: string): string | undefined;
-}

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

@@ -1,48 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { ValidationKeys, DEFAULT_ERROR_MESSAGES, DEFAULT_PATTERNS, } from "./constants";
-import { PatternValidator } from "./PatternValidator";
-import { validator } from "./decorators";
-/**
- * @summary Email Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
- *
- * @class EmailValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-let EmailValidator = class EmailValidator extends PatternValidator {
-    constructor(message = DEFAULT_ERROR_MESSAGES.EMAIL) {
-        super(message);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {RegExp} [pattern]
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, pattern, message) {
-        return super.hasErrors(value, pattern || DEFAULT_PATTERNS.EMAIL, message);
-    }
-};
-EmailValidator = __decorate([
-    validator(ValidationKeys.EMAIL),
-    __metadata("design:paramtypes", [String])
-], EmailValidator);
-export { EmailValidator };

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

@@ -1,28 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary List Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
- *
- * @class ListValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class ListValidator extends Validator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {any[] | Set<any>} value
-     * @param {string} clazz
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: any[] | Set<any>, clazz: string[], message?: string): string | undefined;
-}

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

@@ -1,66 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { Validator } from "./Validator";
-import { DEFAULT_ERROR_MESSAGES, ValidationKeys } from "./constants";
-import { validator } from "./decorators";
-/**
- * @summary List Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
- *
- * @class ListValidator
- * @extends Validator
- *
- * @category Validators
- */
-let ListValidator = class ListValidator extends Validator {
-    constructor(message = DEFAULT_ERROR_MESSAGES.LIST) {
-        super(message, Array.name, Set.name);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {any[] | Set<any>} value
-     * @param {string} clazz
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, clazz, message) {
-        if (!value || (Array.isArray(value) ? !value.length : !value.size))
-            return;
-        clazz = Array.isArray(clazz) ? clazz : [clazz];
-        let val, isValid = true;
-        for (let i = 0; i < (Array.isArray(value) ? value.length : value.size); i++) {
-            val = value[i];
-            switch (typeof val) {
-                case "object":
-                case "function":
-                    isValid = clazz.includes(val.constructor?.name);
-                    break;
-                default:
-                    isValid = clazz.some((c) => typeof val === c.toLowerCase());
-                    break;
-            }
-        }
-        return isValid
-            ? undefined
-            : this.getMessage(message || this.message, clazz);
-    }
-};
-ListValidator = __decorate([
-    validator(ValidationKeys.LIST),
-    __metadata("design:paramtypes", [String])
-], ListValidator);
-export { ListValidator };

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

@@ -1,29 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary Maximum Length Validator
- * @description Validates strings and Arrays on their maximum length
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
- *
- * @class MinLengthValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class MaxLengthValidator extends Validator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {number} maxlength
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: string | any[], maxlength: number, message?: string): string | undefined;
-}

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

@@ -1,53 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { Validator } from "./Validator";
-import { ValidationKeys, DEFAULT_ERROR_MESSAGES } from "./constants";
-import { validator } from "./decorators";
-/**
- * @summary Maximum Length Validator
- * @description Validates strings and Arrays on their maximum length
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
- *
- * @class MinLengthValidator
- * @extends Validator
- *
- * @category Validators
- */
-let MaxLengthValidator = class MaxLengthValidator extends Validator {
-    constructor(message = DEFAULT_ERROR_MESSAGES.MAX_LENGTH) {
-        super(message, String.name, Array.name);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {number} maxlength
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, maxlength, message) {
-        if (typeof value === "undefined")
-            return;
-        return value.length > maxlength
-            ? this.getMessage(message || this.message, maxlength)
-            : undefined;
-    }
-};
-MaxLengthValidator = __decorate([
-    validator(ValidationKeys.MAX_LENGTH),
-    __metadata("design:paramtypes", [String])
-], MaxLengthValidator);
-export { MaxLengthValidator };

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

@@ -1,28 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary Max Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#MAX}
- *
- * @class MaxValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class MaxValidator extends Validator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a Model
-     *
-     * @param {string} value
-     * @param {number | Date | string} max
-     * @param {string} [message]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: number | Date | string, max: number | Date | string, message?: string): string | undefined;
-}