ac-sanitizer 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="4.0.1"></a>
+
+## [4.0.1](https://github.com/mmpro/ac-sanitizer/compare/v4.0.0..v4.0.1) (2023-04-18 18:38:15)
+
+
+### Bug Fix
+
+* **App:** Sanitize array of objects | MP | [c00ea6869a250672b1af1f1c1520223686cc59b9](https://github.com/mmpro/ac-sanitizer/commit/c00ea6869a250672b1af1f1c1520223686cc59b9)    
+Make sure to sanitize (remove non-defined properties from) array of objects  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Tests
+
+* **App:** Added test for array of objects | MP | [7c3b698a09ef48398b95fdacc22542b14ef5cd30](https://github.com/mmpro/ac-sanitizer/commit/7c3b698a09ef48398b95fdacc22542b14ef5cd30)    
+Added test for array of objects  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [40d542dced814eebb74d384d999532f3e1c718ed](https://github.com/mmpro/ac-sanitizer/commit/40d542dced814eebb74d384d999532f3e1c718ed)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="4.0.0"></a>
 
 ## [4.0.0](https://github.com/mmpro/ac-sanitizer/compare/v3.10.7..v4.0.0) (2023-03-30 16:00:08)

package/index.js

@@ -265,7 +265,7 @@ const sanitizer = function() {
         else if (field.minSize && _.size(value) < field.minSize) error = { message: fieldName + '_minSizeBoundary', additionalInfo: { minSize: field.minSize } }
         else if (field.valueType) {
           // very value of the array must be of this type
-          _.every(value, v => {
+          _.every(value, (v, index, value) => {
             const fieldsToCheck = {
               params: {},
               fields: [{ field: fieldName, type: _.get(field, 'valueType'), properties: _.get(field, 'properties'), wildcardAllowed: _.get(field, 'wildcardAllowed') }]
@@ -276,6 +276,8 @@ const sanitizer = function() {
               error = { message: fieldName + '_atLeastOneValueFailed', additionalInfo: { error: _.get(check, 'error'), value: v, type: _.get(field, 'valueType') } }
               return false
             }
+            // set the sanitized value
+            value[index] = _.get(check, `params.${fieldName}`)
             return true
           })
         }

package/package.json

@@ -4,7 +4,7 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
     "ac-countrylist": "^1.0.7",
@@ -17,8 +17,8 @@
     "validator": "^13.9.0"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.3.5",
-    "eslint": "^8.37.0",
+    "ac-semantic-release": "^0.4.0",
+    "eslint": "^8.38.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0"
   },

package/test/tests/array.js

@@ -30,6 +30,13 @@ module.exports = {
       { name: 'Array of fileExtensions - contains invalid', type: 'array', valueType: 'fileExtension', value: ['jpg', 'textimage'], error: 'array_atLeastOneValueFailed' },
       { name: 'Array of objects - valid', type: 'array', value: [{ 'createdAt': 'asc' }], enum: [{ 'createdAt': 'asc' }], expected: [{ 'createdAt': 'asc' }] },
       { name: 'Array of objects - invalid', type: 'array', value: [{ 'createdAt': 'desc' }], enum: [{ 'createdAt': 'asc' }], error: 'array_notAnAllowedValue' },
+      { name: 'Array of objects - check that object payload is sanitized', 
+        type: 'array', 
+        valueType: 'object', 
+        properties: [{ field: 'p1', type: 'string' }], 
+        value: [{ p1: 'isAString', p2: 'shouldBeRemoved' }, { p1: 'isAString2', p2: 'shouldBeRemoved2' }],
+        expected: [{ p1: 'isAString' },  { p1: 'isAString2' }]
+      }
     ]
 
 
@@ -40,7 +47,7 @@ module.exports = {
             array: _.get(test, 'value')
           },
           fields: [
-            { field: 'array', type: _.get(test, 'type'), required: _.get(test, 'required'), valueType: _.get(test, 'valueType'), minSize: _.get(test, 'minSize'), maxSize: _.get(test, 'maxSize') }
+            { field: 'array', type: _.get(test, 'type'), required: _.get(test, 'required'), valueType: _.get(test, 'valueType'), minSize: _.get(test, 'minSize'), maxSize: _.get(test, 'maxSize'), properties: _.get(test, "properties")}
           ]
         }
         if (test.enum) {

package/test/tests/object.js

@@ -33,6 +33,26 @@ module.exports = {
           enum: "blue",
         },
       },
+      {
+        name: "Object with non-allowed properties - should be removed from payload by sanitizer",
+        type: "object",
+        properties: [
+          { field: "settings", type: "object", properties:[
+            { field: 'allowed', type: 'boolean' }
+          ] },
+        ],
+        value: {
+          settings: {
+            allowed: true,
+            notAllowed: true
+          }
+        },
+        expected: {
+          settings: {
+            allowed: true
+          }
+        }
+      },
       {
         name: "Object with non-allowed properties - do not ignore in strict mode",
         type: "object",