@webiny/validation 0.0.0-mt-1

package/validation.js

@@ -0,0 +1,194 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _trim2 = _interopRequireDefault(require("lodash/trim"));
+
+var _isEmpty2 = _interopRequireDefault(require("lodash/isEmpty"));
+
+var _isString2 = _interopRequireDefault(require("lodash/isString"));
+
+var _validationError = _interopRequireDefault(require("./validationError"));
+
+const entries = validators => {
+  return Object.entries(validators);
+};
+
+const invalidRules = "Validators must be specified as a string (eg. required,minLength:10,email).";
+const createdValidators = {
+  async: {},
+  sync: {}
+};
+/**
+ * Main class of Validation library.
+ * Exported as a singleton instance, it offers methods for sync/async data validation and overwriting or adding new validators.
+ *
+ * @class Validation
+ * @example
+ * import { validation } from '@webiny/validation';
+ *
+ * // `validation` is a preconfigured instance of Validation class.
+ * // From here you can either add new validators or use it as-is.
+ */
+
+class Validation {
+  /**
+   * Contains a list of all set validators.
+   * @private
+   */
+  constructor() {
+    (0, _defineProperty2.default)(this, "__validators", void 0);
+    this.__validators = {};
+  }
+  /**
+   * Add new validator.
+   * @param name Validator name.
+   * @param callable Validator function which throws a ValidationError if validation fails.
+   * @returns {Validation}
+   */
+
+
+  setValidator(name, callable) {
+    this.__validators[name] = callable;
+    return this;
+  }
+  /**
+   * Get validator function by name.
+   * @param name Validator name.
+   * @returns {Validator} A validator function.
+   */
+
+
+  getValidator(name) {
+    if (!this.__validators[name]) {
+      throw new _validationError.default("Validator `" + name + "` does not exist!", name);
+    }
+
+    return this.__validators[name];
+  }
+  /**
+   * Asynchronously validates value.
+   * @param value Value to validate.
+   * @param validators A list of comma-separated validators (eg. required,number,gt:20).
+   * @param [options] Validation options.
+   * @returns {Promise<boolean | ValidationError>}
+   */
+
+
+  async validate(value, validators, options = {}) {
+    if ((0, _isString2.default)(validators) && (0, _isEmpty2.default)(validators)) {
+      return true;
+    }
+
+    if (!(0, _isString2.default)(validators)) {
+      throw new Error(invalidRules);
+    }
+
+    const parsedValidateProperty = this.__parseValidateProperty(validators);
+
+    for (const [name, params] of entries(parsedValidateProperty)) {
+      const validator = this.getValidator(name);
+
+      try {
+        await validator(value, params);
+      } catch (e) {
+        const validationError = new _validationError.default(e.message, name, value);
+
+        if (options.throw === false) {
+          return validationError;
+        }
+
+        throw validationError;
+      }
+    }
+
+    return true;
+  }
+  /**
+   * Synchronously validates value.
+   * @param value Value to validate.
+   * @param validators A list of comma-separated validators (eg. required,number,gt:20).
+   * @param [options] Validation options.
+   * @returns {Promise<boolean | ValidationError>}
+   */
+
+
+  validateSync(value, validators, options = {}) {
+    if ((0, _isString2.default)(validators) && (0, _isEmpty2.default)(validators)) {
+      return true;
+    }
+
+    if (!(0, _isString2.default)(validators)) {
+      throw new Error(invalidRules);
+    }
+
+    const parsedValidateProperty = this.__parseValidateProperty(validators);
+
+    for (const [name, params] of entries(parsedValidateProperty)) {
+      const validator = this.getValidator(name);
+
+      try {
+        validator(value, params);
+      } catch (e) {
+        const validationError = new _validationError.default(e.message, name, value);
+
+        if (options.throw === false) {
+          return validationError;
+        }
+
+        throw validationError;
+      }
+    }
+
+    return true;
+  }
+
+  create(validators) {
+    if (createdValidators.async[validators]) {
+      return createdValidators.async[validators];
+    }
+
+    createdValidators.async[validators] = value => this.validate(value, validators);
+
+    return createdValidators.async[validators];
+  }
+
+  createSync(validators) {
+    if (createdValidators.sync[validators]) {
+      return createdValidators.sync[validators];
+    }
+
+    createdValidators.sync[validators] = value => this.validateSync(value, validators);
+
+    return createdValidators.sync[validators];
+  }
+  /**
+   * Parses a string of validators with parameters.
+   * @param validators A list of comma-separated validators (eg. required,number,gt:20).
+   * @returns {ParsedValidators}
+   * @private
+   */
+
+
+  __parseValidateProperty(validators) {
+    const validate = validators.split(",");
+    const parsedValidators = {};
+    validate.forEach(v => {
+      const params = (0, _trim2.default)(v).split(":");
+      const vName = params.shift();
+      parsedValidators[vName] = params;
+    });
+    return parsedValidators;
+  }
+
+}
+
+var _default = Validation;
+exports.default = _default;

package/validationError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This class is used by validators to throw an error when value validation fails.
+ */
+declare class ValidationError extends Error {
+    message: string;
+    validator: string;
+    value: any;
+    constructor(message?: string, validator?: string, value?: any);
+}
+export default ValidationError;

package/validationError.js

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+/**
+ * This class is used by validators to throw an error when value validation fails.
+ */
+class ValidationError extends Error {
+  constructor(message = "", validator = null, value = null) {
+    super();
+    (0, _defineProperty2.default)(this, "message", void 0);
+    (0, _defineProperty2.default)(this, "validator", void 0);
+    (0, _defineProperty2.default)(this, "value", void 0);
+    this.message = message;
+    this.validator = validator;
+    this.value = value;
+  }
+
+}
+
+var _default = ValidationError;
+exports.default = _default;

package/validators/creditCard.d.ts

@@ -0,0 +1,15 @@
+declare const _default: (value: any) => void;
+/**
+ * @name creditCard
+ * @description Credit card validator. This validator will check if the given value is a credit card number.
+ * @param {any} value This is the value that will be validated.
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('notACreditCard', 'creditCard').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+export default _default;

package/validators/creditCard.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * @name creditCard
+ * @description Credit card validator. This validator will check if the given value is a credit card number.
+ * @param {any} value This is the value that will be validated.
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('notACreditCard', 'creditCard').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+var _default = value => {
+  if (!value) {
+    return;
+  }
+
+  value = value + "";
+
+  if (value.length < 12) {
+    throw new _validationError.default("Credit card number too short.");
+  }
+
+  if (/[^0-9-\s]+/.test(value)) {
+    throw new _validationError.default("Credit card number invalid.");
+  }
+
+  let nCheck = 0;
+  let nDigit = 0;
+  let bEven = false;
+  value = value.replace(/ /g, "");
+  value = value.replace(/\D/g, "");
+
+  for (let n = value.length - 1; n >= 0; n--) {
+    const cDigit = value.charAt(n);
+    nDigit = parseInt(cDigit);
+
+    if (bEven) {
+      nDigit *= 2;
+
+      if (nDigit > 9) {
+        nDigit -= 9;
+      }
+    }
+
+    nCheck += nDigit;
+    bEven = !bEven;
+  }
+
+  if (nCheck % 10 === 0) {
+    return;
+  }
+
+  throw new _validationError.default("Credit card number invalid.");
+};
+
+exports.default = _default;

package/validators/dateGte.d.ts

@@ -0,0 +1,5 @@
+declare const _default: (value: string, params: string[]) => void;
+/**
+ * Validates that given value is a greater or equal date to a gteValue
+ */
+export default _default;

package/validators/dateGte.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * Validates that given value is a greater or equal date to a gteValue
+ */
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  } // we need to join because validation params are being split by :
+
+
+  const gteValue = params.join(":");
+
+  if (!gteValue) {
+    return;
+  }
+
+  const date = new Date(value);
+  const gteDate = new Date(gteValue);
+
+  if (date >= gteDate) {
+    return;
+  }
+
+  throw new _validationError.default(`Value needs to be greater than or equal to "${gteDate.toISOString()}".`);
+};
+
+exports.default = _default;

package/validators/dateLte.d.ts

@@ -0,0 +1,5 @@
+declare const _default: (value: string, params: string[]) => void;
+/**
+ * Validates that given value is a lesser than or equal date to a lteValue
+ */
+export default _default;

package/validators/dateLte.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * Validates that given value is a lesser than or equal date to a lteValue
+ */
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  } // we need to join because validation params are being split by :
+
+
+  const lteValue = params.join(":");
+
+  if (!lteValue) {
+    return;
+  }
+
+  const date = new Date(value);
+  const lteDate = new Date(lteValue);
+
+  if (date <= lteDate) {
+    return;
+  }
+
+  throw new _validationError.default(`Value needs to be lesser than or equal to "${lteDate.toISOString()}".`);
+};
+
+exports.default = _default;

package/validators/email.d.ts

@@ -0,0 +1,15 @@
+declare const _default: (value: any) => void;
+/**
+ * @name email
+ * @description Email validator. This validator checks if the given value is a valid email address.
+ * @param {any} value This is the value that will be validated.
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('email@gmail.com', 'email').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+export default _default;

package/validators/email.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * @name email
+ * @description Email validator. This validator checks if the given value is a valid email address.
+ * @param {any} value This is the value that will be validated.
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('email@gmail.com', 'email').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+var _default = value => {
+  if (!value) {
+    return;
+  }
+
+  value = value + ""; // eslint-disable-next-line
+
+  const re = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+
+  if (!value || value.length && re.test(value)) {
+    return;
+  }
+
+  throw new _validationError.default("Value must be a valid e-mail address.");
+};
+
+exports.default = _default;

package/validators/eq.d.ts

@@ -0,0 +1,16 @@
+declare const _default: (value: any, params: Array<string>) => void;
+/**
+ * @name eq
+ * @description Equality validator. This validator checks if the given values are equal.
+ * @param {any} value This is the value that will be validated.
+ * @param {Array<string>} params This is the value to validate against. It is passed as a validator parameter: `eq:valueToCompareWith`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('email@gmail.com', 'eq:another@gmail.com').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+export default _default;

package/validators/eq.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * @name eq
+ * @description Equality validator. This validator checks if the given values are equal.
+ * @param {any} value This is the value that will be validated.
+ * @param {Array<string>} params This is the value to validate against. It is passed as a validator parameter: `eq:valueToCompareWith`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate('email@gmail.com', 'eq:another@gmail.com').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  }
+
+  value = value + ""; // Intentionally put '==' instead of '===' because passed parameter for this validator is always sent inside a string (eg. "eq:test").
+  // eslint-disable-next-line
+
+  if (value == params[0]) {
+    return;
+  }
+
+  throw new _validationError.default("Value must be equal to " + params[0] + ".");
+};
+
+exports.default = _default;

package/validators/gt.d.ts

@@ -0,0 +1,16 @@
+declare const _default: (value: any, params: Array<string>) => void;
+/**
+ * @name gt
+ * @description "Greater than" validator. This validator checks if the given values is greater than the `min` value.
+ * @param {any} value This is the value that will be validated.
+ * @param {Array<string>} params This is the value to validate against. It is passed as a validator parameter: `gt:valueToCompareAgainst`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate(10, 'gt:100').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+export default _default;

package/validators/gt.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * @name gt
+ * @description "Greater than" validator. This validator checks if the given values is greater than the `min` value.
+ * @param {any} value This is the value that will be validated.
+ * @param {Array<string>} params This is the value to validate against. It is passed as a validator parameter: `gt:valueToCompareAgainst`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate(10, 'gt:100').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  }
+
+  if (parseFloat(value) > parseFloat(params[0])) {
+    return;
+  }
+
+  throw new _validationError.default("Value needs to be greater than " + params[0] + ".");
+};
+
+exports.default = _default;

package/validators/gte.d.ts

@@ -0,0 +1,16 @@
+declare const _default: (value: any, params: Array<string>) => void;
+/**
+ * @name gte
+ * @description "Greater than or equals" validator. This validator checks if the given values is greater than or equal to the `min` value.
+ * @param {any} value This is the value that will be validated.
+ * @param {any} min This is the value to validate against. It is passed as a validator parameter: `gte:valueToCompareAgainst`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate(10, 'gte:100').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+export default _default;

package/validators/gte.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+/**
+ * @name gte
+ * @description "Greater than or equals" validator. This validator checks if the given values is greater than or equal to the `min` value.
+ * @param {any} value This is the value that will be validated.
+ * @param {any} min This is the value to validate against. It is passed as a validator parameter: `gte:valueToCompareAgainst`
+ * @throws {ValidationError}
+ * @example
+ * import { validation } from '@webiny/validation';
+ * validation.validate(10, 'gte:100').then(() => {
+ *  // Valid
+ * }).catch(e => {
+ *  // Invalid
+ * });
+ */
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  }
+
+  if (parseFloat(value) >= parseFloat(params[0])) {
+    return;
+  }
+
+  throw new _validationError.default("Value needs to be greater than or equal to " + params[0] + ".");
+};
+
+exports.default = _default;

package/validators/in.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (value: any, params: string[]) => void;
+export default _default;

package/validators/in.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validationError = _interopRequireDefault(require("./../validationError"));
+
+// In array validator. This validator checks if the given value is allowed to.
+var _default = (value, params) => {
+  if (!value) {
+    return;
+  }
+
+  value = value + "";
+
+  if (params.includes(value)) {
+    return;
+  }
+
+  throw new _validationError.default("Value must be one of the following: " + params.join(", ") + ".");
+};
+
+exports.default = _default;

package/validators/integer.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (value: any) => void;
+export default _default;