perfect-payload 1.0.5 → 1.0.7

package/README.md

@@ -11,7 +11,7 @@ This module provides a robust framework for validating data objects based on def
 5. [Default Values](#default-values)
 6. [Examples and Usage](#default-values)
 
-## 1. Quick Signht
+## 1. Quick Sights
 
 usage:
 
@@ -24,8 +24,8 @@ input:
 
 1. **data :**  your payload object (required *)
 2. **dataValidationRule:** validation rule object (required *)
-3. **validPayloadResponse:** response you want if all attribute validation passed (Optional)
-4. **inValidPayloadResponse:** response you want any validation fails (Optional)
+3. **validPayloadResponse:** response object you want it back on all validation passed (Optional)
+4. **inValidPayloadResponse:** response object you want it back on any validation fails (Optional)
 
 **Default Valid Payload Response:**
 
@@ -36,18 +36,18 @@ input:
 }
 ```
 
-
-**Default In-Valid Payload Response:**
+**Default Invalid Payload Response:**
 
 ```javascript
 {  
    statusCode:400,  
    valid:false,  
    message:"One or more attribute values are invalid",  
-   errors:["array of each attribute error messages"]  
+   errors:["minSalary must be less than maxSalary"]  
 }
 ```
 
+**Note:** If inValidPayloadResponse is passed, then it will be returned along with errors property(avoid proper attribute in your inValidPayloadResponse object)
 
 ## 2. Available Validation Attributes
 
@@ -57,7 +57,7 @@ These attributes define the rules that can be applied to each field in the data
 - **allowNull**: Allows `null` values.
 - **allowEmptyObject**: Allows empty objects `{}`.
 - **allowEmptyArray**: Allows empty arrays `[]`.
-- **elementType**: Defines the type of elements in an array (refer to [Available Types](#available-types) section).
+- **elementConstraints**: Defines the constraints of elements in an array (refer to [Available Types](#available-types) section).
 - **regex**: Applies custom regular expression validation.
 - **type**: Specifies the type of the field (refer to [Available Types](#available-types) section).
 - **minLength**: Minimum length for string values.
@@ -82,7 +82,7 @@ These types can be used in the `type` attribute to specify the expected data typ
 - **uuid**: Valid UUIDs (supports all versions).
 - **uuidv1/uuidv3/uuidv4/uuidv5**: Version-specific UUID validation.
 - **objectId**: Valid MongoDB ObjectIds.
-- **array**: Validates arrays, with support for element type validation using `elementType`.
+- **array**: Validates arrays, with support for element type validation using `elementConstraints`.
 - **object**: Validates objects, including nested objects using `objectAttr`.
 
 ## 4. Custom Error Message Attributes
@@ -93,7 +93,7 @@ You can define custom error messages for various validation failures using these
 - **allowNullError**: Custom message when a `null` value is not allowed.
 - **emptyObjectError**: Custom message when an empty object `{}` is not allowed.
 - **emptyArrayError**: Custom message when an empty array `[]` is not allowed.
-- **elementTypeError**: Custom message when array elements do not match the specified type.
+- **elementConstraintsError**: Custom message when array elements do not match the passed constraints.
 - **regexError**: Custom message when a value does not match the specified regex pattern.
 - **typeError**: Custom message when a value does not match the specified type.
 - **minLengthError**: Custom message when a string value is shorter than the minimum length.
@@ -111,7 +111,7 @@ If not explicitly specified, the following default values are applied:
 - **allowNull**: `true` (allows `null` values).
 - **allowEmptyObject**: `true` (allows empty objects `{}`).
 - **allowEmptyArray**: `true` (allows empty arrays `[]`).
-- **elementType**: Ignored.
+- **elementConstraints**: Ignored.
 - **regex**: Ignored.
 - **type**: Ignored.
 - **minLength**: Ignored.
@@ -123,7 +123,6 @@ If not explicitly specified, the following default values are applied:
 - **objectAttr**: Ignored.
 - **dependency**: Ignored.
 
-
 ## 6. Examples And Usage
 
 ### 1. Sample Validation Rule
@@ -137,6 +136,7 @@ sample-1
     allowNull: false,
     type: "string",
     minLength: 3,
+    minLengthError:"First name must have minimum 3 characters."
   },
   lastName: {
     mandatory: false,
@@ -162,12 +162,10 @@ sample-1
 };
 ```
 
-
-
 sample-2
 
 ```javascript
-{
+
   id: {
     mandatory: true,
     allowNull: true,
@@ -218,10 +216,14 @@ sample-2
     range: "0-100",
   },
   allMarks: {
-    type: "array",
-    elementType: "string",
-    allowEmptyArray: false,
-  },
+      type: "array",
+      allowEmptyArray: false,
+      elementConstraints: {
+        type: "number",
+        allowNull: false,
+        range: "0-100",
+      },
+  }
   totalScore: {
     type: "number",
     dependency: {
@@ -303,13 +305,10 @@ sample-2
 }
 ```
 
-
-
 ### 2. Usage
 
 #### 1. creating your route with middleware and validation rule:
 
-
 ```javascript
 //Here validatePayload is your middleware function where you're invoking perfect payload
 router.post(
@@ -334,7 +333,6 @@ export const validatePayload = ({ rule }) => {
 };
 ```
 
-
 #### Usage in venila js code
 
 ```javascript
@@ -344,7 +342,6 @@ console.log(result?.statusCode)
 console.log(result?.isValid)
 ```
 
-
 ---
 
 This documentation provides a comprehensive guide to using the data validation module effectively. Ensure to define your validation rules clearly to maintain data quality and consistency in your applications.

package/index.js

@@ -1,72 +1,3 @@
-//-----------AVAILABLE VALIATION ATTRIBUTES-----------
-// mandatory             : required data
-// allowNull             : allow null
-// allowEmptyObject      : allow {}
-// allowEmptyArray       : allow []
-// elementType           : define array elements type(values: AVAILABLE TYPE Section)
-// regex                 : custom regex validation
-// type                  : refer AVAILABLE TYPE Section
-// minLength             : for string length
-// maxLength             : for string length
-// preventDecimal        : decimal/fraction value nor allowed
-// min                   : for minimum number value
-// max                   : for maximum number value
-// range                 : for number, between 2 range
-// objectAttr            : for nested object validation
-// dependency            : for dependent field validation(ex: min and max salary,etc. customizable)
-//
-//
-//--------AVAILABLE TYPE-----------
-// number                               :
-// string                               :
-// boolean                              :
-// email                                :
-// url                                  :
-// enum                                 : array of values(heterogeneous values supported)
-// uuid/uuidv1/uuidv3/uuidv4/uuidv5     : "uuid" for all version and version specific type for specific version
-// objectId                             :
-// array                                : can validate element tyoe with elementType attribute(PENDING)
-// object                               : supports nested object validation as well with objectAttr attribute
-//
-//
-// ---------Custom Error Message Attributes-----------
-// mandatoryError       : string
-// allowNullError       : string
-// emptyObjectError     : string
-// emptyArrayError      : string
-// elementTypeError     : string
-// regexError           : string
-// typeError            : string
-// minLengthError       : string
-// maxLengthError       : string
-// preventDecimalError  : string
-// minError             : string
-// maxError             : string
-// rangeError           : string
-//
-//
-//--------DEFAULT VALUES IF NOT SPECIFIED-----------
-// mandatory             : false
-// allowNull             : true
-// allowEmptyObject      : true
-// allowEmptyArray       : true
-// elementType           : ignored
-// regex                 : ignored
-// type                  : ignored
-// minLength             : ignored
-// maxLength             : ignored
-// preventDecimal        : false(allows both decimal and integer)
-// min                   : ignored
-// max                   : ignored
-// range                 : ignored
-// objectAttr            : ignored
-// dependency            : ignored
-//
-//
-//
-//
-//
-
 export function perfectPayloadV1(
   data = {},
   dataValidationRule = {},
@@ -105,11 +36,7 @@ export function perfectPayloadV1(
           break;
         case "allowNull":
           //allowNull value check
-          if (
-            addNextError &&
-            ruleName === "allowNull" &&
-            attributeValue == null
-          ) {
+          if (addNextError && attributeValue == null) {
             if (!dataValidationRule?.[attributeName]?.[ruleName]) {
               addNextError = false;
               rowErrors.push(
@@ -121,7 +48,7 @@ export function perfectPayloadV1(
           break;
         case "allowEmptyObject":
           //allowEmptyObject check
-          if (addNextError && ruleName === "allowEmptyObject") {
+          if (addNextError) {
             if (
               !attributeRules?.["allowEmptyObject"] &&
               Object.keys(attributeValue).length == 0
@@ -137,7 +64,7 @@ export function perfectPayloadV1(
           break;
         case "allowEmptyArray":
           //allowEmptyArray check
-          if (addNextError && ruleName === "allowEmptyArray") {
+          if (addNextError) {
             if (
               !attributeRules?.["allowEmptyArray"] &&
               isArray(attributeValue) &&
@@ -152,15 +79,25 @@ export function perfectPayloadV1(
           }
 
           break;
-        case "elementType":
+        case "elementConstraints":
           //check array ele type
-          if (addNextError && ruleName === "elementType") {
+          if (addNextError) {
             if (isArray(attributeValue) && attributeValue?.length > 0) {
-              const hasInvalid = false;
-              if (hasInvalid) {
+              let elementError = false;
+              for (const element of attributeValue) {
+                const { statusCode = 200, errors } = perfectPayloadV1(
+                  { [attributeName]: element },
+                  { [attributeName]: attributeRules[ruleName] }
+                );
+                if (statusCode == 400) {
+                  elementError = errors?.[0];
+                  // addNextError = false;
+                  break;
+                }
+              }
+              if (elementError) {
                 rowErrors.push(
-                  attributeRules?.["elementTypeError"] ||
-                    `invalid type values in ${attributePath}`
+                  attributeRules?.["elementConstraintsError"] || elementError
                 );
                 addNextError = false;
               }
@@ -170,7 +107,7 @@ export function perfectPayloadV1(
           break;
         case "regex":
           //custom regex check
-          if (addNextError && ruleName === "regex") {
+          if (addNextError) {
             if (!isPassedRegex(attributeRules[ruleName], attributeValue)) {
               rowErrors.push(
                 attributeRules?.["regexError"] ||
@@ -182,7 +119,7 @@ export function perfectPayloadV1(
           break;
         case "type":
           //value type check
-          if (addNextError && ruleName === "type") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else {
@@ -358,7 +295,7 @@ export function perfectPayloadV1(
           break;
         case "minLength":
           //minimum string length check
-          if (addNextError && ruleName === "minLength") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (typeof attributeValue == "string") {
@@ -369,15 +306,16 @@ export function perfectPayloadV1(
                 );
               addNextError = false;
             } else {
-              throw new Error(
-                `perfect-payload:- minLength is applied only on string type values, found ${typeof attributeValue} type`
+              rowErrors.push(
+                `${attributePath} value should be a string type(minLength specified)`
               );
+              addNextError = false;
             }
           }
           break;
         case "maxLength":
           //max string length check
-          if (addNextError && ruleName === "maxLength") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (typeof attributeValue == "string") {
@@ -388,15 +326,16 @@ export function perfectPayloadV1(
                 );
               addNextError = false;
             } else {
-              throw new Error(
-                `perfect-payload:- maxLength is applied only on string type values, found ${typeof attributeValue} type`
+              rowErrors.push(
+                `${attributePath} value should be a string type(maxLength specified)`
               );
+              addNextError = false;
             }
           }
           break;
         case "preventDecimal":
           //preventFraction
-          if (addNextError && ruleName === "preventDecimal") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (!isNumber(attributeValue)) {
@@ -415,7 +354,7 @@ export function perfectPayloadV1(
           break;
         case "min":
           //minimum value  check
-          if (addNextError && ruleName === "min") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (!isNumber(attributeValue)) {
@@ -438,7 +377,7 @@ export function perfectPayloadV1(
           break;
         case "max":
           //maximum value  check
-          if (addNextError && ruleName === "max") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (!isNumber(attributeValue)) {
@@ -461,7 +400,7 @@ export function perfectPayloadV1(
           break;
         case "range":
           //value range  check
-          if (addNextError && ruleName === "range") {
+          if (addNextError) {
             if (attributeValue == null && nullAllowed) {
               addNextError = true;
             } else if (!isNumber(attributeValue)) {
@@ -487,7 +426,7 @@ export function perfectPayloadV1(
           break;
         case "objectAttr":
           //nested object attributes check
-          if (addNextError && ruleName === "objectAttr") {
+          if (addNextError) {
             const allObjectAttr = Object.keys(attributeRules?.[ruleName]);
             const objectAttrRules = {};
             for (const attr of allObjectAttr) {
@@ -509,7 +448,7 @@ export function perfectPayloadV1(
           break;
         case "dependency":
           //dependency check
-          if (addNextError && ruleName === "dependency") {
+          if (addNextError) {
             const allDependencyAttr = Object.keys(attributeRules?.[ruleName]);
             for (const attr of allDependencyAttr) {
               if (

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "perfect-payload",
-  "version": "1.0.5",
-  "type": "module",
-  "description": "JSON Data Validation",
-  "main": "index.js",
-  "scripts": {
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/kiranpoojary/perfect-payload.git"
-  },
-  "keywords": [
-    "validation",
-    "payload",
-    "api",
-    "data",
-    "request-body",
-    "response",
-    "express",
-    "validate"
-  ],
-  "author": "Kiran Poojary",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/kiranpoojary/perfect-payload/issues"
-  },
-  "homepage": "https://github.com/kiranpoojary/perfect-payload#readme",
-  "devDependencies": {
-    "@babel/core": "^7.25.2",
-    "@babel/preset-env": "^7.25.4",
-    "babel-jest": "^29.7.0",
-    "jest": "^29.7.0"
-  }
-}
+{
+  "name": "perfect-payload",
+  "version": "1.0.7",
+  "type": "module",
+  "description": "rich json validator",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kiranpoojary/perfect-payload.git"
+  },
+  "keywords": [
+    "validation",
+    "payload",
+    "api",
+    "data",
+    "request-body",
+    "response",
+    "express",
+    "validate"
+  ],
+  "author": "Kiran Poojary",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/kiranpoojary/perfect-payload/issues"
+  },
+  "homepage": "https://github.com/kiranpoojary/perfect-payload#readme",
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@babel/preset-env": "^7.25.4",
+    "babel-jest": "^29.7.0",
+    "jest": "^29.7.0"
+  }
+}