@decaf-ts/decorator-validation 1.5.8 → 1.5.10

package/lib/validation/Validators/PatternValidator.js

@@ -1,73 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PatternValidator = exports.regexpParser = void 0;
-const Validator_1 = require("./Validator");
-const constants_1 = require("./constants");
-const decorators_1 = require("./decorators");
-exports.regexpParser = new RegExp("^/(.+)/([gimus]*)$");
-/**
- * @summary Pattern Validator
- *
- * @param {string} [key] defaults to {@link ValidationKeys#PATTERN}
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
- *
- * @class PatternValidator
- * @extends Validator
- *
- * @category Validators
- */
-let PatternValidator = class PatternValidator extends Validator_1.Validator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.PATTERN) {
-        super(message, "string");
-    }
-    /**
-     * @summary parses and validates a pattern
-     *
-     * @param {string} pattern
-     * @private
-     */
-    getPattern(pattern) {
-        if (!exports.regexpParser.test(pattern))
-            return new RegExp(pattern);
-        const match = pattern.match(exports.regexpParser);
-        return new RegExp(match[1], match[2]);
-    }
-    /**
-     * @summary Validates a Model
-     *
-     * @param {string} value
-     * @param {PatternValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, options) {
-        if (!value)
-            return;
-        let { pattern } = options;
-        if (!pattern)
-            throw new Error("Missing Pattern");
-        pattern = typeof pattern === "string" ? this.getPattern(pattern) : pattern;
-        pattern.lastIndex = 0; // resets pattern position for repeat validation requests
-        return !pattern.test(value)
-            ? this.getMessage(options.message || this.message)
-            : undefined;
-    }
-};
-exports.PatternValidator = PatternValidator;
-exports.PatternValidator = PatternValidator = __decorate([
-    (0, decorators_1.validator)(constants_1.ValidationKeys.PATTERN),
-    __metadata("design:paramtypes", [String])
-], PatternValidator);

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

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

package/lib/validation/Validators/RequiredValidator.js

@@ -1,60 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredValidator = void 0;
-const Validator_1 = require("./Validator");
-const constants_1 = require("./constants");
-const decorators_1 = require("./decorators");
-/**
- * @summary Required Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
- *
- * @class RequiredValidator
- * @extends Validator
- *
- * @category Validators
- */
-let RequiredValidator = class RequiredValidator extends Validator_1.Validator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.REQUIRED) {
-        super(message);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {ValidatorOptions} [options={}]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, options = {}) {
-        switch (typeof value) {
-            case "boolean":
-            case "number":
-                return typeof value === "undefined"
-                    ? this.getMessage(options.message || this.message)
-                    : undefined;
-            default:
-                return !value
-                    ? this.getMessage(options.message || this.message)
-                    : undefined;
-        }
-    }
-};
-exports.RequiredValidator = RequiredValidator;
-exports.RequiredValidator = RequiredValidator = __decorate([
-    (0, decorators_1.validator)(constants_1.ValidationKeys.REQUIRED),
-    __metadata("design:paramtypes", [String])
-], RequiredValidator);

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

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

package/lib/validation/Validators/StepValidator.js

@@ -1,55 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StepValidator = void 0;
-const Validator_1 = require("./Validator");
-const constants_1 = require("./constants");
-const decorators_1 = require("./decorators");
-/**
- * @summary Step Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
- *
- * @class StepValidator
- * @extends Validator
- *
- * @category Validators
- */
-let StepValidator = class StepValidator extends Validator_1.Validator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.STEP) {
-        super(message, "number", "string");
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {number} step
-     * @param {StepValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, options) {
-        if (typeof value === "undefined")
-            return;
-        return Number(value) % Number(options.step) !== 0
-            ? this.getMessage(options.message || this.message, options.step)
-            : undefined;
-    }
-};
-exports.StepValidator = StepValidator;
-exports.StepValidator = StepValidator = __decorate([
-    (0, decorators_1.validator)(constants_1.ValidationKeys.STEP),
-    __metadata("design:paramtypes", [String])
-], StepValidator);

package/lib/validation/Validators/TypeValidator.js

@@ -1,63 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeValidator = void 0;
-const Validator_1 = require("./Validator");
-const constants_1 = require("./constants");
-const decorators_1 = require("./decorators");
-const Validation_1 = require("../Validation");
-const constants_2 = require("../../utils/constants");
-const reflection_1 = require("@decaf-ts/reflection");
-/**
- * @summary Required Validator
- *
- * @class RequiredValidator
- * @extends Validator
- *
- * @category Validators
- */
-let TypeValidator = class TypeValidator extends Validator_1.Validator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.TYPE) {
-        super(message);
-    }
-    /**
-     * @summary Validates a model
-     * @param {string} value
-     * @param {TypeValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, options) {
-        if (value === undefined)
-            return; // Don't try and enforce type if undefined
-        const { types, message } = options;
-        if (!reflection_1.Reflection.evaluateDesignTypes(value, types))
-            return this.getMessage(message || this.message, typeof types === "string"
-                ? types
-                : Array.isArray(types)
-                    ? types.join(", ")
-                    : types.name, typeof value);
-    }
-};
-exports.TypeValidator = TypeValidator;
-exports.TypeValidator = TypeValidator = __decorate([
-    (0, decorators_1.validator)(constants_1.ValidationKeys.TYPE),
-    __metadata("design:paramtypes", [String])
-], TypeValidator);
-Validation_1.Validation.register({
-    validator: TypeValidator,
-    validationKey: constants_2.ModelKeys.TYPE,
-    save: false,
-});

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

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

package/lib/validation/Validators/URLValidator.js

@@ -1,52 +0,0 @@
-"use strict";
-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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.URLValidator = void 0;
-const constants_1 = require("./constants");
-const PatternValidator_1 = require("./PatternValidator");
-const decorators_1 = require("./decorators");
-/**
- * @summary URL Validator
- * @description Pattern from {@link https://gist.github.com/dperini/729294}
- *
- * @class URLValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-let URLValidator = class URLValidator extends PatternValidator_1.PatternValidator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.URL) {
-        super(message);
-    }
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {PatternValidatorOptions} [options={}]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value, options = {}) {
-        return super.hasErrors(value, {
-            ...options,
-            pattern: options.pattern || constants_1.DEFAULT_PATTERNS.URL,
-        });
-    }
-};
-exports.URLValidator = URLValidator;
-exports.URLValidator = URLValidator = __decorate([
-    (0, decorators_1.validator)(constants_1.ValidationKeys.URL),
-    __metadata("design:paramtypes", [String])
-], URLValidator);

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

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

package/lib/validation/Validators/Validator.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Validator = void 0;
-const constants_1 = require("./constants");
-const strings_1 = require("../../utils/strings");
-const reflection_1 = require("@decaf-ts/reflection");
-/**
- * @summary Base Implementation for Validators
- * @description Provides the underlying functionality for {@link Validator}s
- *
- * @param {string} validationKey the key to register the validator under
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#DEFAULT}
- * @param {string[]} [acceptedTypes] defines the value types this validator can validate
- *
- * @class Validator
- * @abstract
- * @category Validators
- */
-class Validator {
-    constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.DEFAULT, ...acceptedTypes) {
-        this.message = message;
-        if (acceptedTypes.length)
-            this.acceptedTypes = acceptedTypes;
-        if (this.acceptedTypes)
-            this.hasErrors = this.checkTypeAndHasErrors(this.hasErrors.bind(this));
-    }
-    /**
-     * @summary builds the error message
-     * @param {string} message
-     * @param {any[]} args
-     * @protected
-     */
-    getMessage(message, ...args) {
-        return (0, strings_1.sf)(message, ...args);
-    }
-    /**
-     * @summary Validates type
-     * @param {any} unbound
-     * @private
-     */
-    checkTypeAndHasErrors(unbound) {
-        return function (value, ...args) {
-            if (value === undefined || !this.acceptedTypes)
-                return unbound(value, ...args);
-            if (!reflection_1.Reflection.checkTypes(value, this.acceptedTypes))
-                return this.getMessage(constants_1.DEFAULT_ERROR_MESSAGES.TYPE, this.acceptedTypes.join(", "), typeof value);
-            return unbound(value, ...args);
-        }.bind(this);
-    }
-}
-exports.Validator = Validator;

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

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

package/lib/validation/Validators/ValidatorRegistry.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidatorRegistry = void 0;
-exports.isValidator = isValidator;
-/**
- * @summary Duck typing for Validators
- * @function isValidator
- * @param val
- */
-function isValidator(val) {
-    return val.constructor && val["hasErrors"];
-}
-/**
- * @summary Base Implementation of a Validator Registry
- *
- * @prop {Validator[]} [validators] the initial validators to register
- *
- * @class ValidatorRegistry
- * @implements IValidatorRegistry<T>
- *
- * @category Validation
- */
-class ValidatorRegistry {
-    constructor(...validators) {
-        this.cache = {};
-        this.customKeyCache = {};
-        this.register(...validators);
-    }
-    /**
-     * @summary retrieves the custom keys
-     */
-    getCustomKeys() {
-        return Object.assign({}, this.customKeyCache);
-    }
-    /**
-     * @summary retrieves the registered validators keys
-     */
-    getKeys() {
-        return Object.keys(this.cache);
-    }
-    /**
-     * @summary Retrieves a validator
-     *
-     * @param {string} validatorKey one of the {@link ValidationKeys}
-     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
-     */
-    get(validatorKey) {
-        if (!(validatorKey in this.cache))
-            return undefined;
-        const classOrInstance = this.cache[validatorKey];
-        if (isValidator(classOrInstance))
-            return classOrInstance;
-        const constructor = classOrInstance.default || classOrInstance;
-        const instance = new constructor();
-        this.cache[validatorKey] = instance;
-        return instance;
-    }
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @param {T[] | ValidatorDefinition[]} validator
-     */
-    register(...validator) {
-        validator.forEach((v) => {
-            if (isValidator(v)) {
-                // const k =
-                if (v.validationKey in this.cache)
-                    return;
-                this.cache[v.validationKey] = v;
-            }
-            else {
-                const { validationKey, validator, save } = v;
-                if (validationKey in this.cache)
-                    return;
-                this.cache[validationKey] = validator;
-                if (!save)
-                    return;
-                const obj = {};
-                obj[validationKey.toUpperCase()] = validationKey;
-                this.customKeyCache = Object.assign({}, this.customKeyCache, obj);
-            }
-        });
-    }
-}
-exports.ValidatorRegistry = ValidatorRegistry;