@decaf-ts/decorator-validation 1.5.5 → 1.5.7

package/lib/validation/Validators/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validators = void 0;
+const DateValidator_1 = require("./DateValidator");
+const TypeValidator_1 = require("./TypeValidator");
+const PasswordValidator_1 = require("./PasswordValidator");
+const StepValidator_1 = require("./StepValidator");
+const URLValidator_1 = require("./URLValidator");
+const PatternValidator_1 = require("./PatternValidator");
+const MinValidator_1 = require("./MinValidator");
+const MinLengthValidator_1 = require("./MinLengthValidator");
+const MaxValidator_1 = require("./MaxValidator");
+const MaxLengthValidator_1 = require("./MaxLengthValidator");
+const RequiredValidator_1 = require("./RequiredValidator");
+const EmailValidator_1 = require("./EmailValidator");
+const ListValidator_1 = require("./ListValidator");
+__exportStar(require("./constants"), exports);
+__exportStar(require("./DateValidator"), exports);
+__exportStar(require("./decorators"), exports);
+__exportStar(require("./EmailValidator"), exports);
+__exportStar(require("./ListValidator"), exports);
+__exportStar(require("./MaxLengthValidator"), exports);
+__exportStar(require("./MaxValidator"), exports);
+__exportStar(require("./MinLengthValidator"), exports);
+__exportStar(require("./MinValidator"), exports);
+__exportStar(require("./PasswordValidator"), exports);
+__exportStar(require("./PatternValidator"), exports);
+__exportStar(require("./RequiredValidator"), exports);
+__exportStar(require("./StepValidator"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./TypeValidator"), exports);
+__exportStar(require("./URLValidator"), exports);
+__exportStar(require("./Validator"), exports);
+__exportStar(require("./ValidatorRegistry"), exports);
+/**
+ * @summary constant holding all {@link Validator}s
+ * @constant Validators
+ * @memberOf module:decorator-validation.Validation.Validators
+ * @category Validation
+ */
+exports.Validators = {
+    DateValidator: DateValidator_1.DateValidator,
+    EmailValidator: EmailValidator_1.EmailValidator,
+    ListValidator: ListValidator_1.ListValidator,
+    MaxLengthValidator: MaxLengthValidator_1.MaxLengthValidator,
+    MaxValidator: MaxValidator_1.MaxValidator,
+    MinLengthValidator: MinLengthValidator_1.MinLengthValidator,
+    MinValidator: MinValidator_1.MinValidator,
+    PasswordValidator: PasswordValidator_1.PasswordValidator,
+    PatternValidator: PatternValidator_1.PatternValidator,
+    RequiredValidator: RequiredValidator_1.RequiredValidator,
+    StepValidator: StepValidator_1.StepValidator,
+    TypeValidator: TypeValidator_1.TypeValidator,
+    URLValidator: URLValidator_1.URLValidator,
+};

package/lib/validation/Validators/types.js

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

package/lib/validation/decorators.js

@@ -0,0 +1,304 @@
+"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.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Validators"), exports);
+__exportStar(require("./decorators"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./Validation"), exports);

package/lib/validation/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/decorator-validation",
-  "version": "1.5.5",
+  "version": "1.5.7",
   "description": "simple decorator based validation engine",
   "type": "module",
   "exports": {

package/lib/index.cjs

@@ -1,61 +0,0 @@
-"use strict";
-/**
- * @module decorator-validation
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = void 0;
-/**
- * @summary Model definition functionality
- * @description defines the base class and related functionality
- *
- * @namespace Model
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Holds all the supported decorators
- * @namespace Decorators
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Validation related functionality
- * @description Defines the Model validation apis and base classes for validators
- *
- * @namespace Validation
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Dates
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Hashing
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Serialization
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Format
- * @memberOf module:decorator-validation
- */
-__exportStar(require("./utils/index.cjs"), exports);
-__exportStar(require("./validation/index.cjs"), exports);
-__exportStar(require("./model/index.cjs"), exports);
-exports.VERSION = "1.5.4";
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7O0dBRUc7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBRUg7Ozs7OztHQU1HO0FBRUg7Ozs7R0FJRztBQUVIOzs7Ozs7R0FNRztBQUVIOzs7R0FHRztBQUVIOzs7R0FHRztBQUVIOzs7R0FHRztBQUVIOzs7R0FHRztBQUVILDBDQUF3QjtBQUN4QiwrQ0FBNkI7QUFDN0IsMENBQXdCO0FBRVgsUUFBQSxPQUFPLEdBQUcsT0FBTyxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAbW9kdWxlIGRlY29yYXRvci12YWxpZGF0aW9uXG4gKi9cblxuLyoqXG4gKiBAc3VtbWFyeSBNb2RlbCBkZWZpbml0aW9uIGZ1bmN0aW9uYWxpdHlcbiAqIEBkZXNjcmlwdGlvbiBkZWZpbmVzIHRoZSBiYXNlIGNsYXNzIGFuZCByZWxhdGVkIGZ1bmN0aW9uYWxpdHlcbiAqXG4gKiBAbmFtZXNwYWNlIE1vZGVsXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKi9cblxuLyoqXG4gKiBAc3VtbWFyeSBIb2xkcyBhbGwgdGhlIHN1cHBvcnRlZCBkZWNvcmF0b3JzXG4gKiBAbmFtZXNwYWNlIERlY29yYXRvcnNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqL1xuXG4vKipcbiAqIEBzdW1tYXJ5IFZhbGlkYXRpb24gcmVsYXRlZCBmdW5jdGlvbmFsaXR5XG4gKiBAZGVzY3JpcHRpb24gRGVmaW5lcyB0aGUgTW9kZWwgdmFsaWRhdGlvbiBhcGlzIGFuZCBiYXNlIGNsYXNzZXMgZm9yIHZhbGlkYXRvcnNcbiAqXG4gKiBAbmFtZXNwYWNlIFZhbGlkYXRpb25cbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqL1xuXG4vKipcbiAqIEBuYW1lc3BhY2UgRGF0ZXNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqL1xuXG4vKipcbiAqIEBuYW1lc3BhY2UgSGFzaGluZ1xuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICovXG5cbi8qKlxuICogQG5hbWVzcGFjZSBTZXJpYWxpemF0aW9uXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKi9cblxuLyoqXG4gKiBAbmFtZXNwYWNlIEZvcm1hdFxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICovXG5cbmV4cG9ydCAqIGZyb20gXCIuL3V0aWxzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi92YWxpZGF0aW9uXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9tb2RlbFwiO1xuXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiMS41LjRcIjtcbiJdfQ==