ac-sanitizer 4.0.15 → 4.1.0

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+ 
+# [4.1.0](https://github.com/mmpro/ac-sanitizer/compare/v4.0.16..v4.1.0) (2025-01-25 10:01:18)
+
+
+### Feature
+
+* **App:** Add option to ingoreCase for string/enum | MP | [92c41c2a5b3e6634e8458acadee47fad1d5e5dc3](https://github.com/mmpro/ac-sanitizer/commit/92c41c2a5b3e6634e8458acadee47fad1d5e5dc3)    
+With ignoreCase=true enum checks are case insensitive (e.g. abc in [ABC] is valid)  
+Related issues:
+### Chores
+
+* **App:** Updated packages | MP | [763b5fce7a31e867424ffb9bddb4a1b721ac0d9b](https://github.com/mmpro/ac-sanitizer/commit/763b5fce7a31e867424ffb9bddb4a1b721ac0d9b)    
+Updated packages  
+Related issues:
+<a name="4.0.16"></a>
+
+## [4.0.16](https://github.com/mmpro/ac-sanitizer/compare/v4.0.15..v4.0.16) (2024-09-20 12:35:35)
+
+
+### Bug Fix
+
+* **App:** Fixed handling objects with property array as null. | MP | [4e6e8035a335cc57e48bcddc5faef81d9437f588](https://github.com/mmpro/ac-sanitizer/commit/4e6e8035a335cc57e48bcddc5faef81d9437f588)    
+Array within object sent as null was accepted even if nullAllowed was not set.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [7875c76c8cbb131ab8967b1687ddf59dfd6ed1be](https://github.com/mmpro/ac-sanitizer/commit/7875c76c8cbb131ab8967b1687ddf59dfd6ed1be)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="4.0.15"></a>
 
 ## [4.0.15](https://github.com/mmpro/ac-sanitizer/compare/v4.0.14..v4.0.15) (2024-07-06 19:12:15)

package/README.md

@@ -110,7 +110,7 @@ number | | Should no be used - use integer, long, short, floag
 ratio | | x:y
 rgb | | Check for valid RGB value (r,g,b) or (r%,g%, b%)
 short | | 0 - 2^15
-string | minLength (int), maxLength (int)| 
+string | minLength (int), maxLength (int), ignoreCase | With ignoreCase=true enum checks are case insensitive (e.g. abc in ['ABC'] is valid) 
 url| protocols, require_tld, require_protocol | Default values: protocols ['http', 'https'], required_tld true, require_protocol true
 
 # Examples

package/index.js

@@ -180,12 +180,21 @@ const sanitizer = function() {
       if (error) {
         // do not process other conditions
       }
-      else if (!fieldIsRequired && _.isNil(_.get(paramsToCheck, fieldName))) {
-        // do nothing -> the value is optional and not present
-      }
       else if (field.nullAllowed && _.isNull(_.get(paramsToCheck, fieldName))) {
         // do nothing null is allowed and sent!
       }
+      else if (!fieldIsRequired && _.isNil(_.get(paramsToCheck, fieldName))) {
+        // value is optional, but sent as nil/null without nullAllowed = true
+        if (_.get(field, 'strict')) {
+          error = { message: `${fieldName}_nullNotAllowed` }
+        }
+        else {
+          // remove property
+          fields = _.filter(fields, item => {
+            if (item.field !== fieldName) return item
+          })
+        }
+      }
       else if (_.get(field, 'adminLevel') && adminLevel < _.get(field, 'adminLevel')) {
         if (omitFields) {
           fields = _.filter(fields, item => {
@@ -488,6 +497,14 @@ const sanitizer = function() {
       }
 
       if (!error && allowedValues && value) {
+        let orgValue
+        if (field.ignoreCase && _.isString(value)) {
+          // convert value and allowesValues to lowercase
+          orgValue = _.clone(orgValue)
+          value = _.toLower(value)
+          allowedValues = _.map(allowedValues, _.toLower)
+        }
+
         if (_.isArray(value)) {
           if (_.size(value) && !_.size(_.intersectionWith(value, allowedValues, _.isEqual))) {
             error = { message: fieldName + '_notAnAllowedValue', additionalInfo: { value } }
@@ -499,6 +516,8 @@ const sanitizer = function() {
         else if (_.indexOf(allowedValues, value) < 0) {
           error = { message: fieldName + '_notAnAllowedValue', additionalInfo: { value } }
         }
+
+        if (orgValue) value = orgValue
       } 
 
       if (error && field.customErrorMessage) _.set(error, 'message', field.customErrorMessage)

package/package.json

@@ -4,26 +4,26 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "4.0.15",
+  "version": "4.1.0",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
     "ac-countrylist": "^1.0.12",
-    "ac-file-extensions": "^2.0.9",
-    "ac-ip": "^4.1.1",
-    "chai": "^4.4.1",
-    "date-and-time": "^3.3.0",
+    "ac-file-extensions": "^2.0.10",
+    "ac-ip": "^4.1.2",
+    "chai": "^4.5.0",
+    "date-and-time": "^3.6.0",
     "hashids": "^2.3.0",
     "lodash": "^4.17.21",
     "validator": "^13.12.0"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.4.2",
-    "c8": "^10.1.2",
-    "eslint": "^9.6.0",
-    "mocha": "^10.6.0"
+    "ac-semantic-release": "^0.4.5",
+    "c8": "^10.1.3",
+    "eslint": "^9.19.0",
+    "mocha": "^11.1.0"
   },
   "scripts": {
-    "test": "mocha --reporter spec",
+    "test": "mocha --reporter spec --bail",
     "coverage": "./node_modules/c8/bin/c8.js yarn test"
   },
   "engines": {

package/test/tests/object.js

@@ -107,6 +107,32 @@ module.exports = {
         },
         error: "object_nested_id_notAFiniteNumber",
       },
+      {
+        name: "Object with nested properties - array as null - strict mode - should fail",
+        type: "object",
+        properties: [
+          { field: "arr", type: "array", valueType: "integer", strict: true }
+        ],
+        value: {
+          arr: null
+        },
+        error: "object_arr_nullNotAllowed",
+      },
+      {
+        name: "Object with nested properties - array as null - lenient - should remove the property",
+        type: "object",
+        properties: [
+          { field: "arr", type: "array", valueType: "integer" },
+          { field: "boo", type: "boolean" }
+        ],
+        value: {
+          arr: null,
+          boo: true
+        },
+        expected: {
+          boo: true
+        }      
+      },
       {
         name: "Object with nested properties - missing nested property",
         type: "object",
@@ -115,7 +141,7 @@ module.exports = {
           { field: "enum", type: "string", enum: ["blue", "green"] },
           { field: "nested", type: "object", properties: [
             { field: 'id', type: 'integer', required: true } 
-          ]}
+          ] }
         ],
         value: {
           boo: true,

package/test/tests/string.js

@@ -16,6 +16,8 @@ module.exports = {
       { name: 'Valid from enum', type: 'string', value: 'play', enum: ['play', 'pause'], expected: 'play' },
       { name: 'Invalid from enum', type: 'string', value: 'stop', enum: ['play', 'pause'], error: 'string_notAnAllowedValue', additionalInfo: { value: 'stop' } },
       { name: 'Valid string from randomValue function', type: 'string', value: randomValue, expected: randomValue },
+      { name: 'Invalid - uppercase vs lowercase', type: 'string', value: 'ABC', enum: ['abc'], error: 'string_notAnAllowedValue' },
+      { name: 'Valid - uppercase vs lowercase', type: 'string', ignoreCase: true, value: 'ABC', enum: ['abc'], expected: 'ABC' },
     ]
 
 
@@ -26,7 +28,7 @@ module.exports = {
             string: _.get(test, 'value')
           },
           fields: [
-            { field: 'string', type: _.get(test, 'type'), required: _.get(test, 'required'), enum: _.get(test, 'enum'), minLength: _.get(test, 'minLength'), maxLength: _.get(test, 'maxLength'), convert: _.get(test, 'convert') }
+            { field: 'string', type: _.get(test, 'type'), ignoreCase: _.get(test, 'ignoreCase'), required: _.get(test, 'required'), enum: _.get(test, 'enum'), minLength: _.get(test, 'minLength'), maxLength: _.get(test, 'maxLength'), convert: _.get(test, 'convert') }
           ]
         }