@decaf-ts/decorator-validation 1.5.8 → 1.5.10

package/lib/validation/decorators.js

@@ -1,304 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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.date = date;
-exports.password = password;
-exports.list = list;
-exports.set = set;
-require("reflect-metadata");
-const constants_1 = require("./Validators/constants");
-const strings_1 = require("../utils/strings");
-const dates_1 = require("../utils/dates");
-const decorators_1 = require("../utils/decorators");
-const Validation_1 = require("./Validation");
-/**
- * @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}
- *
- * @function required
- *
- * @category Decorators
- */
-function required(message = constants_1.DEFAULT_ERROR_MESSAGES.REQUIRED) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.REQUIRED), {
-        message: message,
-    });
-}
-/**
- * @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}
- *
- * @function min
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function min(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MIN), {
-        min: value,
-        message: message,
-        types: [Number.name, Date.name],
-    });
-}
-/**
- * @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}
- *
- * @function max
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function max(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MAX), {
-        max: value,
-        message: message,
-        types: [Number.name, Date.name],
-    });
-}
-/**
- * @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}
- *
- * @function step
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function step(value, message = constants_1.DEFAULT_ERROR_MESSAGES.STEP) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.STEP), {
-        step: value,
-        message: message,
-        types: [Number.name],
-    });
-}
-/**
- * @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}
- *
- * @function minlength
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function minlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MIN_LENGTH) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MIN_LENGTH), {
-        minLength: value,
-        message: message,
-        types: [String.name, Array.name, Set.name],
-    });
-}
-/**
- * @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}
- *
- * @function maxlength
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function maxlength(value, message = constants_1.DEFAULT_ERROR_MESSAGES.MAX_LENGTH) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.MAX_LENGTH), {
-        maxLength: value,
-        message: message,
-        types: [String.name, Array.name, Set.name],
-    });
-}
-/**
- * @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}
- *
- * @function pattern
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function pattern(value, message = constants_1.DEFAULT_ERROR_MESSAGES.PATTERN) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.PATTERN), {
-        pattern: typeof value === "string" ? value : value.toString(),
-        message: message,
-        types: [String.name],
-    });
-}
-/**
- * @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}
- *
- * @function email
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function email(message = constants_1.DEFAULT_ERROR_MESSAGES.EMAIL) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.EMAIL), {
-        pattern: constants_1.DEFAULT_PATTERNS.EMAIL,
-        message: message,
-        types: [String.name],
-    });
-}
-/**
- * @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}
- *
- * @function url
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function url(message = constants_1.DEFAULT_ERROR_MESSAGES.URL) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.URL), {
-        pattern: constants_1.DEFAULT_PATTERNS.URL,
-        message: message,
-        types: [String.name],
-    });
-}
-/**
- * @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}
- *
- * @function type
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-function type(types, message = constants_1.DEFAULT_ERROR_MESSAGES.TYPE) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.TYPE), {
-        customTypes: types,
-        message: message,
-    });
-}
-/**
- * @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
- */
-function date(format = "dd/MM/yyyy", message = constants_1.DEFAULT_ERROR_MESSAGES.DATE) {
-    return (target, propertyKey) => {
-        (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.DATE), {
-            format: format,
-            message: message,
-            types: [Date.name],
-        })(target, propertyKey);
-        const values = new WeakMap();
-        Object.defineProperty(target, propertyKey, {
-            configurable: false,
-            set(newValue) {
-                const descriptor = Object.getOwnPropertyDescriptor(this, propertyKey);
-                if (!descriptor || descriptor.configurable)
-                    Object.defineProperty(this, propertyKey, {
-                        enumerable: true,
-                        configurable: false,
-                        get: () => values.get(this),
-                        set: (newValue) => {
-                            let val;
-                            try {
-                                val = (0, dates_1.parseDate)(format, newValue);
-                                values.set(this, val);
-                            }
-                            catch (e) {
-                                console.error((0, strings_1.sf)("Failed to parse date: {0}", e.message || e));
-                            }
-                        },
-                    });
-                this[propertyKey] = newValue;
-            },
-            get() {
-                console.log("here");
-            },
-        });
-    };
-}
-/**
- * @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
- */
-function password(pattern = constants_1.DEFAULT_PATTERNS.PASSWORD.CHAR8_ONE_OF_EACH, message = constants_1.DEFAULT_ERROR_MESSAGES.PASSWORD) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.PASSWORD), {
-        pattern: pattern,
-        message: message,
-        types: [String.name],
-    });
-}
-/**
- * @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
- */
-function list(clazz, collection = "Array", message = constants_1.DEFAULT_ERROR_MESSAGES.LIST) {
-    return (0, decorators_1.propMetadata)(Validation_1.Validation.key(constants_1.ValidationKeys.LIST), {
-        clazz: Array.isArray(clazz) ? clazz.map((c) => c.name) : [clazz.name],
-        type: collection,
-        message: message,
-    });
-}
-/**
- * @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
- */
-function set(clazz, message = constants_1.DEFAULT_ERROR_MESSAGES.LIST) {
-    return list(clazz, "Set", message);
-}

package/lib/validation/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Validators";
-export * from "./decorators";
-export * from "./types";
-export * from "./Validation";

package/lib/validation/types.d.ts

@@ -1,46 +0,0 @@
-import { DecoratorMetadata } from "@decaf-ts/reflection";
-/**
- * @summary Type for validation decorator metadata
- * @memberOf module:decorator-validation.Reflection
- * @category Reflection
- */
-export type ValidationMetadata = {
-    [indexer: string]: any;
-    args?: any[];
-    message: string;
-    types?: string[];
-};
-/**
- * @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 = Record<string, Record<string, string | undefined>>;

package/lib/validation/types.js

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