validno 0.1.7 → 0.1.9

package/dist/Schema.js

@@ -3,7 +3,9 @@ export const defaultSchemaKeys = [
     "required",
     "type",
     "eachType",
-    "rules"
+    "rules",
+    "title",
+    "customMessage"
 ];
 export class Schema {
     constructor(inputSchema) {

package/dist/checkRules.js

@@ -121,6 +121,7 @@ function checkRules(key, value, requirements, inputObj) {
         return result;
     }
     const rules = requirements.rules;
+    const title = requirements.title || key;
     const allResults = [];
     const allRulesKeys = Object.keys(rules);
     let i = 0;
@@ -133,6 +134,17 @@ function checkRules(key, value, requirements, inputObj) {
         const func = rulesFunctions[ruleName];
         const args = rules[ruleName];
         const 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++;
     }

package/dist/checkType.js

@@ -1,3 +1,4 @@
+import { ErrorKeywords } from "./constants/details.js";
 import _validations from "./utils/validations.js";
 const getErrorDetails = (key, expectedType, receivedValue) => {
     let receivedType = '';
@@ -32,7 +33,7 @@ const checkTypeMultiple = (key, value, requirements, keyName = key) => {
         const check = checkType(key, value, requirementsRe);
         if (check[0].passed === true) {
             result.passed = true;
-            result.details = 'Passed';
+            result.details = 'OK';
             return result;
         }
         i++;
@@ -41,8 +42,10 @@ const checkTypeMultiple = (key, value, requirements, keyName = key) => {
 };
 const checkType = (key, value, requirements, keyName = key) => {
     const isNotNull = value !== null;
+    const keyTitle = 'title' in requirements ? requirements.title : keyName;
+    const hasCustomMessage = requirements.customMessage && typeof requirements.customMessage === 'function';
     if (value === undefined && requirements.required) {
-        return [{ key: keyName, passed: false, details: `Key ${keyName} is missing` }];
+        return [{ key: keyName, passed: false, details: `Значение "${keyName}" отсутствует` }];
     }
     let result = [];
     if (Array.isArray(requirements.type)) {
@@ -52,16 +55,28 @@ const checkType = (key, value, requirements, keyName = key) => {
         result.push({
             key: keyName,
             passed: true,
-            details: 'Passed'
+            details: 'OK'
         });
         return result;
     }
+    const customErrDetails = hasCustomMessage ?
+        requirements.customMessage({
+            keyword: ErrorKeywords.Type,
+            value: value,
+            key: keyName,
+            title: keyTitle,
+            reqs: requirements,
+            schema: null
+        }) :
+        null;
+    const baseErrDetails = getErrorDetails(keyName, requirements.type, value);
+    const getDetails = (isOK) => isOK ? 'OK' : customErrDetails || baseErrDetails;
     switch (requirements.type) {
         case 'any':
             result.push({
                 key: keyName,
                 passed: true,
-                details: 'Passed'
+                details: 'OK'
             });
             break;
         case Number:
@@ -69,7 +84,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isNumber,
-                details: isNumber ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: getDetails(isNumber)
             });
             break;
         case String:
@@ -77,17 +92,17 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isString,
-                details: isString ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: getDetails(isString)
             });
             break;
         case Date:
             const isDate = isNotNull && value.constructor === Date;
             const isValid = isDate && !isNaN(value.getTime());
-            const errorMsg = isValid ? getErrorDetails(keyName, requirements.type, value) : 'Дата невалидна';
+            const errorMsg = isValid ? getDetails(isDate) : 'Дата невалидна';
             result.push({
                 key: keyName,
                 passed: isDate && isValid,
-                details: isDate && isValid ? 'Passed' : errorMsg
+                details: isDate && isValid ? 'OK' : errorMsg
             });
             break;
         case Boolean:
@@ -95,7 +110,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isBoolean,
-                details: isBoolean ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: isBoolean ? 'OK' : getDetails(isBoolean)
             });
             break;
         case Array:
@@ -104,7 +119,7 @@ const checkType = (key, value, requirements, keyName = key) => {
                 result.push({
                     key: keyName,
                     passed: false,
-                    details: getErrorDetails(keyName, requirements.type, value)
+                    details: getDetails(isArray)
                 });
                 break;
             }
@@ -123,7 +138,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isOk,
-                details: isOk ? 'Passed' : !isEachChecked.passed ? isEachChecked.details : getErrorDetails(keyName, requirements.type, value)
+                details: isOk ? 'OK' : !isEachChecked.passed ? isEachChecked.details : getDetails(isOk)
             });
             break;
         case Object:
@@ -131,7 +146,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isObject,
-                details: isObject ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: isObject ? 'OK' : getDetails(isObject)
             });
             break;
         case RegExp:
@@ -139,7 +154,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isRegex,
-                details: isRegex ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: isRegex ? 'OK' : getDetails(isRegex)
             });
             break;
         case null:
@@ -147,7 +162,7 @@ const checkType = (key, value, requirements, keyName = key) => {
             result.push({
                 key: keyName,
                 passed: isNull,
-                details: isNull ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+                details: isNull ? 'OK' : getDetails(isNull)
             });
             break;
         default:

package/dist/constants/details.js

@@ -0,0 +1,6 @@
+export var ErrorKeywords;
+(function (ErrorKeywords) {
+    ErrorKeywords["Missing"] = "missing";
+    ErrorKeywords["Type"] = "type";
+    ErrorKeywords["Rule"] = "rule";
+})(ErrorKeywords || (ErrorKeywords = {}));

package/dist/validate.js

@@ -1,8 +1,9 @@
 import checkRules from "./checkRules.js";
 import checkType from "./checkType.js";
-import { defaultSchemaKeys } from "./Schema.js";
 import _errors from "./utils/errors.js";
 import _validations from "./utils/validations.js";
+import { defaultSchemaKeys } from "./Schema.js";
+import { ErrorKeywords } from "./constants/details.js";
 export const getResultDefaults = () => {
     return {
         ok: null,
@@ -11,7 +12,7 @@ export const getResultDefaults = () => {
         passed: [],
         errors: [],
         byKeys: {},
-        errorsByKeys: {}
+        errorsByKeys: {},
     };
 };
 const checkIsNested = (obj) => {
@@ -38,6 +39,7 @@ export const mergeResults = (resultsOld, resultsNew) => {
 export function handleReqKey(key, data, reqs, deepKey = key) {
     let results = getResultDefaults();
     const hasNested = checkIsNested(reqs);
+    const keyTitle = 'title' in reqs ? reqs.title : deepKey;
     const missedCheck = [];
     const typeChecked = [];
     const rulesChecked = [];
@@ -61,13 +63,22 @@ export function handleReqKey(key, data, reqs, deepKey = key) {
         return results;
     }
     if (reqs.required === true && key in data === false || data === undefined) {
-        const errMsg = _errors.getMissingError(deepKey);
+        let errMsg = _errors.getMissingError(deepKey);
+        if (reqs.customMessage && typeof reqs.customMessage === 'function') {
+            errMsg = reqs.customMessage({
+                keyword: ErrorKeywords.Missing,
+                value: data[key],
+                key: deepKey,
+                title: keyTitle,
+                reqs: reqs,
+                schema: this.schema
+            });
+        }
         missedCheck.push(false);
         results.missed.push(deepKey);
         results.failed.push(deepKey);
         results.errors.push(errMsg);
         results.byKeys[deepKey] = false;
-        results.errorsByKeys[deepKey] = [errMsg];
         return results;
     }
     const typeCheck = checkType(key, data[key], reqs, deepKey);
@@ -101,14 +112,15 @@ export function handleReqKey(key, data, reqs, deepKey = key) {
     results.byKeys[deepKey] = (missedCheck.length + typeChecked.length + rulesChecked.length) === 0;
     return results;
 }
-const isCheckNeeded = (key, hasLimits, onlyKeys) => {
+const checkIfValidationIsNeeded = (key, hasLimits, onlyKeys) => {
     return !hasLimits || (key === onlyKeys || Array.isArray(onlyKeys) && (onlyKeys === null || onlyKeys === void 0 ? void 0 : onlyKeys.includes(key)));
 };
 function validate(schema, data, onlyKeys) {
     let results = getResultDefaults();
     const areKeysLimited = (Array.isArray(onlyKeys) && onlyKeys.length > 0) || (typeof onlyKeys === 'string' && onlyKeys.length > 0);
     for (const [key, reqs] of Object.entries(schema.schema)) {
-        if (isCheckNeeded(key, areKeysLimited, onlyKeys)) {
+        const isValidationRequired = checkIfValidationIsNeeded(key, areKeysLimited, onlyKeys);
+        if (isValidationRequired) {
             const keyResult = handleReqKey.call(this, key, data, reqs);
             results = mergeResults(results, keyResult);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "validno",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/Schema.ts

@@ -5,6 +5,8 @@ export type TSchemaItem = {
     type: any,
     eachType?: any,
     rules?: {},
+    title?: string,
+    customMessage?: Function
 }
 
 export type TSchemaInput = {
@@ -15,14 +17,18 @@ export const enum ESchemaFields {
     Required = 'required',
     Type = 'type',
     EachType = 'eachType',
-    Rules = 'rules'
+    Rules = 'rules',
+    Title = 'title',
+    CustomMessage = 'customMessage'
 }
 
 export const defaultSchemaKeys = [
     ESchemaFields.Required,
     ESchemaFields.Type,
     ESchemaFields.EachType,
-    ESchemaFields.Rules
+    ESchemaFields.Rules,
+    ESchemaFields.Title,
+    ESchemaFields.CustomMessage
 ]
 
 export type TSchema = TSchemaInput

package/src/checkRules.ts

@@ -1,3 +1,4 @@
+import { ErrorKeywords } from "./constants/details.js";
 import { TSchema, TSchemaItem } from "./Schema.js";
 import _validations from "./utils/validations.js"
 
@@ -144,6 +145,7 @@ function checkRules (this: any, key: string, value: any, requirements: TSchemaIt
     }
 
     const rules: TRule = requirements.rules
+    const title = requirements.title || key
 
     const allResults = []
     const allRulesKeys = Object.keys(rules)
@@ -162,6 +164,19 @@ function checkRules (this: any, key: string, value: any, requirements: TSchemaIt
         const args = rules[ruleName]
 
         const 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++;

package/src/checkType.ts

@@ -1,3 +1,4 @@
+import { ErrorKeywords } from "./constants/details.js";
 import { TSchemaInput, TSchemaItem } from "./Schema.js";
 import _validations from "./utils/validations.js";
 
@@ -32,7 +33,7 @@ const checkTypeMultiple = (key: string, value: any, requirements: TSchemaItem |
 
     if (check[0].passed === true) {
       result.passed = true
-      result.details = 'Passed'
+      result.details = 'OK'
       return result
     }
 
@@ -46,9 +47,11 @@ type TCheckTypeResult = {key: string, passed: boolean, details: string}
 
 const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaInput, keyName = key): TCheckTypeResult[] => {
     const isNotNull = value !== null
+    const keyTitle = 'title' in requirements ? requirements.title : keyName
+    const hasCustomMessage = requirements.customMessage && typeof requirements.customMessage === 'function'
     
     if (value === undefined && requirements.required) {
-      return [{key: keyName, passed: false, details: `Key ${keyName} is missing`}]
+      return [{key: keyName, passed: false, details: `Значение "${keyName}" отсутствует`}]
     }
 
     let result: TCheckTypeResult[] = []
@@ -61,17 +64,34 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
       result.push({
         key: keyName,
         passed: true,
-        details: 'Passed'
+        details: 'OK'
       })
       return result
     }
+
+    
+    const customErrDetails = hasCustomMessage ?
+      //@ts-ignore
+      requirements.customMessage({
+        keyword: ErrorKeywords.Type,
+        value: value,
+        key: keyName,
+        title: keyTitle,
+        reqs: requirements,
+        schema: null
+      }) :
+      null;
+
+    const baseErrDetails = getErrorDetails(keyName, requirements.type, value)
   
+    const getDetails = (isOK: boolean) => isOK ? 'OK' : customErrDetails || baseErrDetails
+
     switch (requirements.type) {
       case 'any':
         result.push({
           key: keyName,
           passed: true,
-          details: 'Passed'
+          details: 'OK'
         })
         break;
       case Number:
@@ -80,7 +100,7 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isNumber,
-          details: isNumber ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: getDetails(isNumber)
         })
 
         break;
@@ -90,18 +110,18 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isString,
-          details: isString ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: getDetails(isString)
         })
         break;
       case Date:
         const isDate = isNotNull && value.constructor === Date
         const isValid = isDate && !isNaN(value.getTime())
-        const errorMsg = isValid ? getErrorDetails(keyName, requirements.type, value) : 'Дата невалидна'
+        const errorMsg = isValid ? getDetails(isDate) : 'Дата невалидна'
 
         result.push({
           key: keyName,
           passed: isDate && isValid,
-          details: isDate && isValid ? 'Passed' : errorMsg
+          details: isDate && isValid ? 'OK' : errorMsg
         })
         break;
       case Boolean:
@@ -110,7 +130,7 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isBoolean,
-          details: isBoolean ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: isBoolean ? 'OK' : getDetails(isBoolean)
         })
         break;
       case Array:
@@ -120,7 +140,7 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
           result.push({
               key: keyName,
               passed: false,
-              details: getErrorDetails(keyName, requirements.type, value)
+              details: getDetails(isArray)
           });
           
           break;
@@ -146,16 +166,17 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isOk,
-          details: isOk ? 'Passed' : !isEachChecked.passed ? isEachChecked.details : getErrorDetails(keyName, requirements.type, value)
+          details: isOk ? 'OK' : !isEachChecked.passed ? isEachChecked.details : getDetails(isOk)
         })
 
         break;
       case Object:
         const isObject = _validations.isObject(value) && value.constructor === Object
+
         result.push({
           key: keyName,
           passed: isObject,
-          details: isObject ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: isObject ? 'OK' : getDetails(isObject)
         })
 
         break;
@@ -164,7 +185,7 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isRegex,
-          details: isRegex ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: isRegex ? 'OK' : getDetails(isRegex)
         })
 
         break;
@@ -174,7 +195,7 @@ const checkType = (key: string, value: any, requirements: TSchemaItem | TSchemaI
         result.push({
           key: keyName,
           passed: isNull,
-          details: isNull ? 'Passed' : getErrorDetails(keyName, requirements.type, value)
+          details: isNull ? 'OK' : getDetails(isNull)
         })
 
         break;

package/src/constants/details.ts

@@ -0,0 +1,5 @@
+export enum ErrorKeywords {
+    Missing = 'missing',
+    Type = 'type',
+    Rule = 'rule'
+} 

package/src/validate.ts

@@ -1,8 +1,9 @@
 import checkRules from "./checkRules.js";
 import checkType from "./checkType.js";
-import { defaultSchemaKeys, Schema, TSchemaInput } from "./Schema.js";
 import _errors from "./utils/errors.js";
 import _validations from "./utils/validations.js";
+import { defaultSchemaKeys, Schema, TSchemaInput } from "./Schema.js";
+import { ErrorKeywords } from "./constants/details.js";
 
 export type TResult = {
     ok: null | boolean,
@@ -10,8 +11,8 @@ export type TResult = {
     failed: string[],
     passed: string[],
     errors: string[],
-    byKeys: {[key: string]: boolean}
-    errorsByKeys: {[key: string]: string[]}
+    byKeys: {[key: string]: boolean},
+    errorsByKeys: {[key: string]: string[]},
 };
 
 export const getResultDefaults = (): TResult => {
@@ -22,7 +23,7 @@ export const getResultDefaults = (): TResult => {
     passed: [],
     errors: [],
     byKeys: {},
-    errorsByKeys: {}
+    errorsByKeys: {},
   };
 }
 
@@ -54,6 +55,7 @@ export const mergeResults = (resultsOld: TResult, resultsNew: TResult) => {
 export function handleReqKey(this: any, key: string, data: any, reqs: TSchemaInput, deepKey = key) {
   let results = getResultDefaults()
   const hasNested = checkIsNested(reqs)
+  const keyTitle = 'title' in reqs ? reqs.title : deepKey
 
   const missedCheck: boolean[] = [];
   const typeChecked: boolean[] = [];
@@ -68,6 +70,7 @@ export function handleReqKey(this: any, key: string, data: any, reqs: TSchemaInp
     results.missed.push(deepKey)
     results.failed.push(deepKey)
     results.byKeys[deepKey] = false
+
     return results
   }
 
@@ -100,14 +103,26 @@ export function handleReqKey(this: any, key: string, data: any, reqs: TSchemaInp
   // Check missing keys
   // @ts-ignore
   if (reqs.required === true && key in data === false || data === undefined) {
-    const errMsg = _errors.getMissingError(deepKey)
+    let errMsg = _errors.getMissingError(deepKey)
+    
+    if (reqs.customMessage && typeof reqs.customMessage === 'function') {
+      // @ts-ignore
+      errMsg = reqs.customMessage({
+        keyword: ErrorKeywords.Missing,
+        value: data[key],
+        key: deepKey,
+        title: keyTitle,
+        reqs: reqs,
+        schema: this.schema
+      })
+    }
 
     missedCheck.push(false)
     results.missed.push(deepKey)
     results.failed.push(deepKey)
     results.errors.push(errMsg)
     results.byKeys[deepKey] = false
-    results.errorsByKeys[deepKey] = [errMsg]
+
     return results
   }
 
@@ -129,8 +144,8 @@ export function handleReqKey(this: any, key: string, data: any, reqs: TSchemaInp
     rulesChecked.push(false)
     ruleCheck.details.forEach((el) => {
       if (deepKey in results.errorsByKeys) results.errorsByKeys[deepKey] = []
-      results.errors.push(el)
 
+      results.errors.push(el)
       results.errorsByKeys[deepKey] = ['1']
     })
   }
@@ -155,7 +170,7 @@ export function handleReqKey(this: any, key: string, data: any, reqs: TSchemaInp
   return results
 }
 
-const isCheckNeeded = (key: string, hasLimits: boolean, onlyKeys?: string | string[]) => {
+const checkIfValidationIsNeeded = (key: string, hasLimits: boolean, onlyKeys?: string | string[]) => {
   return !hasLimits || (key === onlyKeys || Array.isArray(onlyKeys) && onlyKeys?.includes(key))
 }
 
@@ -164,7 +179,9 @@ function validate(schema: Schema, data: any, onlyKeys?: string | string[]): TRes
     const areKeysLimited = (Array.isArray(onlyKeys) && onlyKeys.length > 0) || (typeof onlyKeys === 'string' && onlyKeys.length > 0)
 
     for (const [key, reqs] of Object.entries(schema.schema)) {
-      if (isCheckNeeded(key, areKeysLimited, onlyKeys)) {
+      const isValidationRequired = checkIfValidationIsNeeded(key, areKeysLimited, onlyKeys)
+      
+      if (isValidationRequired) {
         // @ts-ignore
         const keyResult = handleReqKey.call(this, key, data, reqs)