validno 0.2.6 → 0.3.1

package/dist/engine/ValidateEngine.js

@@ -0,0 +1,44 @@
+import ValidnoResult from "./ValidnoResult.js";
+import validate from "./methods/validate.js";
+import validateType from "./methods/validateType.js";
+import validateRules from "./methods/validateRules.js";
+import handleMissingKey from "./methods/handleMissingKey.js";
+import handleNestedKey from "./methods/handleNestedKey.js";
+import handleKey from "./methods/handleKey.js";
+import handleMissingKeyValidation from "./methods/handleMissingKeyValidation.js";
+import finishValidation from "./methods/finishValidation.js";
+class ValidateEngine {
+    constructor(definition) {
+        this.definition = definition;
+        this.result = new ValidnoResult();
+    }
+    validate(data, validationKeys) {
+        return validate.call(this, data, validationKeys);
+    }
+    handleKey(input) {
+        return handleKey.call(this, input);
+    }
+    handleNestedKey(input) {
+        return handleNestedKey.call(this, input);
+    }
+    handleMissingKey(schema, input) {
+        return handleMissingKey(schema, input);
+    }
+    handleMissingNestedKey(nestedKey, results) {
+        results.setMissing(nestedKey);
+        return results;
+    }
+    handleMissingKeyValidation(params) {
+        return handleMissingKeyValidation.call(this, params);
+    }
+    validateType(input) {
+        return validateType(input);
+    }
+    validateRules(input) {
+        return validateRules.call(this, input);
+    }
+    finishValidation(checks) {
+        return finishValidation(checks);
+    }
+}
+export default ValidateEngine;

package/dist/engine/ValidnoResult.js

@@ -0,0 +1,102 @@
+import _errors from "../utils/errors.js";
+class ValidnoResult {
+    constructor(results) {
+        this.ok = (results === null || results === void 0 ? void 0 : results.ok) !== undefined ? results.ok : null;
+        this.missed = (results === null || results === void 0 ? void 0 : results.missed) || [];
+        this.failed = (results === null || results === void 0 ? void 0 : results.failed) || [];
+        this.passed = (results === null || results === void 0 ? void 0 : results.passed) || [];
+        this.errors = (results === null || results === void 0 ? void 0 : results.errors) || [];
+        this.byKeys = (results === null || results === void 0 ? void 0 : results.byKeys) || {};
+        this.errorsByKeys = (results === null || results === void 0 ? void 0 : results.errorsByKeys) || {};
+    }
+    setNoData(key) {
+        this.ok = false;
+        this.errors = [`Missing value for '${key}'`];
+    }
+    setKeyStatus(key, result) {
+        this.byKeys[key] = result;
+    }
+    fixParentByChilds(parentKey, childChecks = []) {
+        const isEveryOk = childChecks.every(check => check === true);
+        this.setKeyStatus(parentKey, isEveryOk);
+        if (isEveryOk) {
+            this.setPassed(parentKey);
+        }
+        else {
+            this.setFailed(parentKey);
+        }
+    }
+    setMissing(key, errMsg) {
+        const error = errMsg || _errors.getMissingError(key);
+        this.missed.push(key);
+        this.setFailed(key, error);
+        this.setKeyStatus(key, false);
+    }
+    setPassed(key) {
+        this.passed.push(key);
+        this.setKeyStatus(key, true);
+    }
+    setFailed(key, msg) {
+        if (!(key in this.errorsByKeys)) {
+            this.errorsByKeys[key] = [];
+        }
+        this.failed.push(key);
+        this.setKeyStatus(key, false);
+        if (!msg)
+            return;
+        this.errors.push(msg);
+        this.errorsByKeys[key].push(msg);
+    }
+    joinErrors(separator = '; ') {
+        return _errors.joinErrors(this.errors, separator);
+    }
+    merge(resultsNew) {
+        this.failed = [...this.failed, ...resultsNew.failed];
+        this.errors = [...this.errors, ...resultsNew.errors];
+        this.missed = [...this.missed, ...resultsNew.missed];
+        this.passed = [...this.passed, ...resultsNew.passed];
+        this.byKeys = Object.assign(Object.assign({}, this.byKeys), resultsNew.byKeys);
+        for (const key in resultsNew.errorsByKeys) {
+            if (!(key in this.errorsByKeys)) {
+                this.errorsByKeys[key] = [];
+            }
+            this.errorsByKeys[key] = [
+                ...this.errorsByKeys[key],
+                ...resultsNew.errorsByKeys[key]
+            ];
+        }
+        return this;
+    }
+    clearEmptyErrorsByKeys() {
+        for (const key in this.errorsByKeys) {
+            if (!this.errorsByKeys[key].length) {
+                delete this.errorsByKeys[key];
+            }
+        }
+    }
+    finish() {
+        if (this.failed.length || this.errors.length) {
+            this.ok = false;
+        }
+        else {
+            this.ok = true;
+        }
+        this.clearEmptyErrorsByKeys();
+        return this;
+    }
+    data() {
+        return {
+            ok: this.ok,
+            missed: this.missed,
+            failed: this.failed,
+            passed: this.passed,
+            errors: this.errors,
+            byKeys: this.byKeys,
+            errorsByKeys: this.errorsByKeys,
+        };
+    }
+    isValid() {
+        return this.ok === true;
+    }
+}
+export default ValidnoResult;

package/dist/engine/index.js

@@ -0,0 +1,2 @@
+import ValidateEngine from "./ValidateEngine.js";
+export default ValidateEngine;

package/dist/engine/methods/finishValidation.js

@@ -0,0 +1,15 @@
+function finishValidation(checks) {
+    const { results, nestedKey, missedCheck, typeChecked, rulesChecked } = checks;
+    if (missedCheck.length)
+        results.setMissing(nestedKey);
+    const isPassed = !typeChecked.length && !rulesChecked.length && !missedCheck.length;
+    if (!isPassed) {
+        results.setFailed(nestedKey);
+        results.errorsByKeys[nestedKey] = [...results.errors];
+    }
+    else {
+        results.setPassed(nestedKey);
+    }
+    return results.finish();
+}
+export default finishValidation;

package/dist/engine/methods/handleKey.js

@@ -0,0 +1,41 @@
+import _helpers from "../../utils/helpers.js";
+import ValidnoResult from "../ValidnoResult.js";
+function validateKeyValue(params) {
+    const { results, key, nestedKey, data, reqs, hasMissing } = params;
+    const missedCheck = [];
+    const typeChecked = [];
+    const rulesChecked = [];
+    if (hasMissing) {
+        return this.handleMissingKeyValidation({ results, key, nestedKey, data, reqs, missedCheck });
+    }
+    this.validateType({ results, key, value: data[key], reqs, nestedKey, typeChecked });
+    this.validateRules({ results, nestedKey, value: data[key], reqs, data, rulesChecked });
+    return this.finishValidation({ results, nestedKey, missedCheck, typeChecked, rulesChecked });
+}
+function validateKey(input) {
+    let { results, key, nestedKey, data, reqs } = input;
+    if (data === undefined) {
+        const noDataResult = new ValidnoResult();
+        noDataResult.setNoData(nestedKey);
+    }
+    if (!results)
+        results = new ValidnoResult();
+    if (!nestedKey)
+        nestedKey = key;
+    const hasMissing = _helpers.hasMissing(input);
+    if (_helpers.checkNestedIsMissing(reqs, data)) {
+        return this.handleMissingNestedKey(nestedKey, results);
+    }
+    if (_helpers.checkIsNested(reqs)) {
+        return this.handleNestedKey({ results, key, data, reqs, nestedKey });
+    }
+    return validateKeyValue.call(this, {
+        results,
+        key,
+        nestedKey,
+        data,
+        reqs,
+        hasMissing,
+    });
+}
+export default validateKey;

package/dist/engine/methods/handleMissingKey.js

@@ -0,0 +1,19 @@
+import { ValidationIds } from "../../constants/details.js";
+import _errors from "../../utils/errors.js";
+function handleMissingKey(schema, input) {
+    const { key, nestedKey, data, reqs } = input;
+    const messageKey = nestedKey || key;
+    const messageTitle = reqs.title || messageKey;
+    if (!reqs.customMessage)
+        return _errors.getMissingError(messageKey);
+    const errorMessage = reqs.customMessage({
+        keyword: ValidationIds.Missing,
+        value: data[key],
+        key: messageKey,
+        title: messageTitle,
+        reqs,
+        schema,
+    });
+    return errorMessage;
+}
+export default handleMissingKey;

package/dist/engine/methods/handleMissingKeyValidation.js

@@ -0,0 +1,9 @@
+function handleMissingKeyValidation(params) {
+    const schema = this.definition;
+    const { results, key, nestedKey, data, reqs, missedCheck } = params;
+    const errMsg = this.handleMissingKey(schema, { key, nestedKey, data, reqs });
+    missedCheck.push(false);
+    results.setMissing(nestedKey, errMsg);
+    return results;
+}
+export default handleMissingKeyValidation;

package/dist/engine/methods/handleNestedKey.js

@@ -0,0 +1,19 @@
+function handleNestedKey(input) {
+    const { results, key, nestedKey, data, reqs } = input;
+    const nestedKeys = Object.keys(reqs);
+    const nestedResults = [];
+    for (const itemKey of nestedKeys) {
+        const deepParams = {
+            key: itemKey,
+            data: data[key],
+            reqs: reqs[itemKey],
+            nestedKey: `${nestedKey}.${itemKey}`
+        };
+        const deepResults = this.handleKey(deepParams);
+        nestedResults.push(deepResults.ok);
+        results.merge(deepResults);
+    }
+    results.fixParentByChilds(nestedKey, nestedResults);
+    return results;
+}
+export default handleNestedKey;

package/dist/engine/methods/validate.js

@@ -0,0 +1,14 @@
+import _helpers from "../../utils/helpers.js";
+function validate(data, validationKeys) {
+    const hasKeysToCheck = _helpers.areKeysLimited(validationKeys);
+    const schemaKeys = Object.entries(this.definition);
+    for (const [key, reqs] of schemaKeys) {
+        const toBeValidated = _helpers.needValidation(key, hasKeysToCheck, validationKeys);
+        if (!toBeValidated)
+            continue;
+        const keyResult = this.handleKey({ key, data, reqs });
+        this.result.merge(keyResult);
+    }
+    return this.result.finish();
+}
+export default validate;

package/dist/engine/methods/validateRules.js

@@ -0,0 +1,187 @@
+import _validations from "../../utils/validations.js";
+import { ValidationDetails } from "../../constants/details.js";
+export const rulesParams = {
+    lengthMin: {
+        allowedTypes: [String]
+    }
+};
+const ensureRuleHasCorrectType = (value, allowedTypes) => {
+    const isInAllowedList = allowedTypes.some(TYPE => {
+        const getType = (el) => Object.prototype.toString.call(el);
+        return getType(new TYPE()) == getType(value);
+    });
+    return isInAllowedList;
+};
+const rulesFunctions = {
+    custom: (key, val, func, extra) => {
+        const customResult = func(val, extra);
+        if (typeof customResult === 'object' && 'result' in customResult) {
+            return {
+                result: customResult.result,
+                details: customResult.details || ValidationDetails.CustomRuleFailed,
+            };
+        }
+        if (typeof customResult === 'boolean') {
+            return {
+                result: customResult,
+                details: customResult ? "" : ValidationDetails.CustomRuleFailed
+            };
+        }
+        throw new Error(`Custom rule function must return an object with 'result' and 'details' properties or a boolean value. Received: ${typeof customResult}`);
+        return;
+    },
+    isEmail: (key, val) => {
+        return {
+            result: _validations.isEmail(val),
+            details: `Value must be a valid email address`
+        };
+    },
+    is: (key, val, equalTo) => {
+        return {
+            result: _validations.is(val, equalTo),
+            details: `Value must be equal to "${equalTo}"`
+        };
+    },
+    isNot: (key, val, notEqualTo) => {
+        return {
+            result: _validations.isNot(val, notEqualTo),
+            details: `Value must not be equal to "${notEqualTo}"`
+        };
+    },
+    min: (key, val, min) => {
+        return {
+            result: _validations.isNumberGte(val, min),
+            details: `Value must be greater than or equal to ${min}`
+        };
+    },
+    max: (key, val, max) => {
+        return {
+            result: _validations.isNumberLte(val, max),
+            details: `Value must be less than or equal to ${max}`
+        };
+    },
+    minMax: (key, val, minMax) => {
+        const [min, max] = minMax;
+        return {
+            result: _validations.isNumberGte(val, min) && _validations.isNumberLte(val, max),
+            details: `Value must be between ${min} and ${max}`
+        };
+    },
+    length: (key, val, length) => {
+        return {
+            result: _validations.lengthIs(val, length),
+            details: `Value must be equal to ${length}`
+        };
+    },
+    lengthNot: (key, val, lengthNot) => {
+        return {
+            result: _validations.lengthNot(val, lengthNot),
+            details: `Value must not be equal to ${lengthNot}`
+        };
+    },
+    lengthMinMax: (key, val, minMax) => {
+        const [min, max] = minMax;
+        return {
+            result: _validations.lengthMin(val, min) && _validations.lengthMax(val, max),
+            details: `Value must be between ${min} and ${max} characters`
+        };
+    },
+    lengthMin: (key, val, min) => {
+        ensureRuleHasCorrectType(val, rulesParams['lengthMin'].allowedTypes);
+        return {
+            result: _validations.lengthMin(val, min),
+            details: `Value must be at least ${min} characters`
+        };
+    },
+    lengthMax: (key, val, max) => {
+        return {
+            result: _validations.lengthMax(val, max),
+            details: `Value must not be exceed ${max} characters`
+        };
+    },
+    regex: (key, val, regex) => {
+        return {
+            result: _validations.regexTested(val, regex),
+            details: `Value must match the format ${regex}`
+        };
+    },
+    enum: (key, value, allowedList) => {
+        const output = {
+            result: true,
+            details: ''
+        };
+        if (!Array.isArray(value)) {
+            const isCorrect = allowedList.includes(value);
+            output.result = isCorrect,
+                output.details = isCorrect ? '' : `Value "${value}" is not allowed`;
+        }
+        else {
+            const incorrectValues = [];
+            value.forEach((v) => !allowedList.includes(v) ? incorrectValues.push(v) : {});
+            const isCorrect = incorrectValues.length === 0;
+            output.result = isCorrect,
+                output.details = isCorrect ? '' : `Values are not allowed: "${incorrectValues.join(', ')}"`;
+        }
+        return output;
+    }
+};
+function checkRules(key, value, requirements, inputObj) {
+    const result = {
+        ok: true,
+        details: []
+    };
+    if (requirements.required !== true && value === undefined)
+        return result;
+    if (!requirements || !requirements.rules || !Object.keys(requirements.rules).length) {
+        return result;
+    }
+    const rules = requirements.rules;
+    const title = requirements.title || key;
+    const allResults = [];
+    const allRulesKeys = Object.keys(rules);
+    let i = 0;
+    while (i < allRulesKeys.length) {
+        const ruleName = allRulesKeys[i];
+        if (ruleName in rulesFunctions === false) {
+            i++;
+            continue;
+        }
+        const func = rulesFunctions[ruleName];
+        const args = rules[ruleName];
+        let result = func(key, value, args, { schema: this.schema, input: inputObj });
+        if (requirements.customMessage && typeof requirements.customMessage === 'function') {
+            result.details = requirements.customMessage({
+                keyword: ruleName,
+                value: value,
+                key: key,
+                title: title,
+                reqs: requirements,
+                schema: this.schema,
+                rules: rules,
+            });
+        }
+        allResults.push(result);
+        i++;
+    }
+    const failedResults = allResults.filter(el => el.result === false);
+    if (failedResults.length) {
+        result.ok = false;
+        result.details = failedResults.map(el => el.details);
+    }
+    return result;
+}
+;
+function validateRules(input) {
+    const { results, nestedKey, value, reqs, data, rulesChecked } = input;
+    const ruleCheck = checkRules.call(this, nestedKey, value, reqs, data);
+    if (!ruleCheck.ok) {
+        rulesChecked.push(false);
+        ruleCheck.details.forEach((el) => {
+            if (!(nestedKey in results.errorsByKeys))
+                results.errorsByKeys[nestedKey] = [];
+            results.errors.push(el);
+            results.errorsByKeys[nestedKey] = ['1'];
+        });
+    }
+}
+export default validateRules;

package/dist/engine/methods/validateType.js

@@ -0,0 +1,135 @@
+import { ValidationDetails, ValidationIds } from "../../constants/details.js";
+import _validations from "../../utils/validations.js";
+import _errors from "../../utils/errors.js";
+import _validateType from "../../utils/validateType.js";
+const validateUnionType = (key, value, requirements, keyName = key) => {
+    const typeList = Array.isArray(requirements.type)
+        ? requirements.type.map((el) => String((el === null || el === void 0 ? void 0 : el.name) || el))
+        : [];
+    const results = [];
+    for (let i = 0; i < typeList.length; i++) {
+        const requirementsRe = Object.assign(Object.assign({}, requirements), { type: requirements.type[i] });
+        const result = handleTypeValidation(key, value, requirementsRe);
+        results.push(result[0].passed);
+        if (results[i] === true)
+            return _validateType.getResult(keyName, true);
+    }
+    const isPassed = results.some((r) => r === true);
+    const result = _validateType.getResult(keyName, isPassed, isPassed ? undefined : _errors.getErrorDetails(keyName, typeList.join('/'), value));
+    return result;
+};
+const handleTypeValidation = (key, value, requirements, keyName = key) => {
+    var _a;
+    const reqs = Object.assign({ required: true }, requirements);
+    const isNotNull = value !== null;
+    const keyTitle = 'title' in reqs && reqs.title !== undefined ? reqs.title : keyName;
+    const hasCustomMessage = reqs.customMessage && typeof reqs.customMessage === 'function';
+    if (value === undefined && reqs.required) {
+        return [_validateType.getResult(keyName, false, _errors.getMissingError(keyName))];
+    }
+    if (Array.isArray(reqs.type)) {
+        return [validateUnionType(key, value, reqs)];
+    }
+    if (value === undefined && reqs.required === false) {
+        return [_validateType.getResult(keyName, true)];
+    }
+    const customErrDetails = hasCustomMessage ?
+        reqs.customMessage({
+            keyword: ValidationIds.Type,
+            value: value,
+            key: keyName,
+            title: keyTitle,
+            reqs: reqs,
+            schema: {}
+        }) :
+        null;
+    const baseErrDetails = _errors.getErrorDetails(keyName, reqs.type, value);
+    const getDetails = (isOK, errorText) => isOK ?
+        ValidationDetails.OK :
+        errorText || customErrDetails || baseErrDetails;
+    const typeBySchema = reqs.type;
+    const result = [];
+    switch (typeBySchema) {
+        case 'any': {
+            result.push(_validateType.getResult(keyName, true, getDetails(true)));
+            break;
+        }
+        case Number: {
+            const isNumber = isNotNull && value.constructor === Number;
+            result.push(_validateType.getResult(keyName, isNumber, getDetails(isNumber)));
+            break;
+        }
+        case String: {
+            const isString = isNotNull && value.constructor === String;
+            result.push(_validateType.getResult(keyName, isString, getDetails(isString)));
+            break;
+        }
+        case Date: {
+            const isDate = isNotNull && value.constructor === Date;
+            const isValid = isDate && !isNaN(value.getTime());
+            const isValidDate = isDate && isValid;
+            result.push(_validateType.getResult(keyName, isValidDate, getDetails(isValidDate, ValidationDetails.INVALID_DATE)));
+            break;
+        }
+        case Boolean: {
+            const isBoolean = isNotNull && value.constructor === Boolean;
+            result.push(_validateType.getResult(keyName, isBoolean, getDetails(isBoolean)));
+            break;
+        }
+        case Array: {
+            const isArray = isNotNull && value.constructor === Array;
+            if (!isArray) {
+                result.push(_validateType.getResult(keyName, false, getDetails(isArray)));
+                break;
+            }
+            let isEachChecked = { passed: true, details: "" };
+            if ('eachType' in reqs) {
+                for (const el of value) {
+                    const result = handleTypeValidation(`each of ${key}`, el, { type: reqs.eachType, required: true });
+                    if (!result[0].passed) {
+                        isEachChecked.passed = false;
+                        isEachChecked.details = result[0].details || '';
+                        break;
+                    }
+                }
+            }
+            const isOk = isArray && isEachChecked.passed;
+            const details = !isEachChecked.passed ? isEachChecked.details : getDetails(isOk);
+            result.push(_validateType.getResult(keyName, isOk, details));
+            break;
+        }
+        case Object: {
+            const isObject = _validations.isObject(value) && value.constructor === Object;
+            result.push(_validateType.getResult(keyName, isObject, getDetails(isObject)));
+            break;
+        }
+        case RegExp: {
+            const isRegex = _validations.isRegex(value);
+            result.push(_validateType.getResult(keyName, isRegex, getDetails(isRegex)));
+            break;
+        }
+        case null: {
+            const isNull = value === null;
+            result.push(_validateType.getResult(keyName, isNull, getDetails(isNull)));
+            break;
+        }
+        default: {
+            const isInstanceOf = typeof typeBySchema === 'function' && value instanceof typeBySchema;
+            const isConstructorSame = typeof typeBySchema === 'function' && ((_a = value.constructor) === null || _a === void 0 ? void 0 : _a.name) === (typeBySchema === null || typeBySchema === void 0 ? void 0 : typeBySchema.name);
+            const isOK = isInstanceOf && isConstructorSame;
+            result.push(_validateType.getResult(keyName, isOK, getDetails(isOK)));
+        }
+    }
+    return result;
+};
+function validateType(input) {
+    const { results, key, value, reqs, nestedKey, typeChecked } = input;
+    const typeCheck = handleTypeValidation(key, value, reqs, nestedKey);
+    typeCheck.forEach((res) => {
+        if (!res.passed) {
+            typeChecked.push(false);
+            results.errors.push(res.details || '');
+        }
+    });
+}
+export default validateType;

package/dist/types/common.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/errors.js

@@ -1,21 +1,30 @@
-const _errors = {};
-_errors.getMissingError = (key = 'na') => `Отсутствует значение '${key}'`;
-_errors.getErrorDetails = (key, expectedType, receivedValue) => {
-    var _a;
-    let receivedType = '';
-    if (receivedValue === undefined)
-        receivedType = 'undefined';
-    else if (receivedValue === null)
-        receivedType = 'null';
-    else
-        receivedType = ((_a = receivedValue.constructor) === null || _a === void 0 ? void 0 : _a.name) || typeof receivedValue || 'na';
-    const expectedOutput = (expectedType === null || expectedType === void 0 ? void 0 : expectedType.name) || expectedType;
-    const receivedOutput = receivedType || 'na';
-    if (String(expectedOutput) === String(receivedOutput))
-        return '';
-    return `Проверьте тип '${key}': ожидался ${expectedOutput}, получен ${receivedOutput}`;
-};
-_errors.joinErrors = (errorsArr, separator = '; ') => {
-    return (errorsArr === null || errorsArr === void 0 ? void 0 : errorsArr.join(`${separator}`)) || '';
-};
-export default _errors;
+class ErrorUtility {
+    getMissingError(key = 'na') {
+        return `Missing value for '${key}'`;
+    }
+    getErrorDetails(key, expectedType, receivedValue) {
+        const receivedType = this.getTypeString(receivedValue);
+        const expectedOutput = this.getExpectedTypeString(expectedType);
+        if (expectedOutput === receivedType) {
+            return '';
+        }
+        return `Check the type of '${key}': expected ${expectedOutput}, received ${receivedType}`;
+    }
+    joinErrors(errorsArr, separator = '; ') {
+        var _a;
+        return ((_a = errorsArr === null || errorsArr === void 0 ? void 0 : errorsArr.filter(error => error === null || error === void 0 ? void 0 : error.trim())) === null || _a === void 0 ? void 0 : _a.join(separator)) || '';
+    }
+    getTypeString(value) {
+        var _a;
+        if (value === undefined)
+            return 'undefined';
+        if (value === null)
+            return 'null';
+        return ((_a = value.constructor) === null || _a === void 0 ? void 0 : _a.name) || typeof value || 'unknown';
+    }
+    getExpectedTypeString(expectedType) {
+        return (expectedType === null || expectedType === void 0 ? void 0 : expectedType.name) || String(expectedType) || 'unknown';
+    }
+}
+const errors = new ErrorUtility();
+export default errors;