ac-sanitizer 5.1.2 → 5.2.0

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+ 
+# [5.2.0](https://github.com/mmpro/ac-sanitizer/compare/v5.1.3..v5.2.0) (2025-09-20 14:05:48)
+
+
+### Feature
+
+* **App:** Add new option optional  | MP | [1363c1fce0495baba599acd52409893d6484fa13](https://github.com/mmpro/ac-sanitizer/commit/1363c1fce0495baba599acd52409893d6484fa13)    
+With field property optional, fields are removed from payload if they are nil  
+Related issues:
+### Chores
+
+* **App:** Updated packages | MP | [b01e620c2d20b17155cfb29408dca292806a4969](https://github.com/mmpro/ac-sanitizer/commit/b01e620c2d20b17155cfb29408dca292806a4969)    
+Updated packages  
+Related issues:
+
+## [5.1.3](https://github.com/mmpro/ac-sanitizer/compare/v5.1.2..v5.1.3) (2025-09-19 05:27:36)
+
+
+### Bug Fix
+
+* **Misc:** Package updates | MP | [e1bb82a004239df4207d8c11e7fd84e82d07172f](https://github.com/mmpro/ac-sanitizer/commit/e1bb82a004239df4207d8c11e7fd84e82d07172f)    
+Package updates  
+Related issues:
 
 ## [5.1.2](https://github.com/mmpro/ac-sanitizer/compare/v5.1.1..v5.1.2) (2025-09-19 05:13:36)
 

package/README.md

@@ -60,6 +60,7 @@ convert | [boolean OR string] | Some types can be automatically converted (e.g.
 valueType | [string] | Use it to sanitize values of an array by defining the allowed type here
 strict | [boolean] | For objects only - if true and payload contains a property not defined, an error will be returned.
 nullAllowed | [boolean] | If true, sending NULL is allowed.
+optional | [boolean] | If true and the value is nil, the property is removed/omitted from payload. Helpful to cleanup response payloads.
 
 [^1]: The path must be set with the parent propery as root, e.g. the actual field is settings.video.width, in property video the condition is then just "width" not the full path.
 

package/index.js

@@ -180,6 +180,12 @@ const sanitizer = function() {
       if (error) {
         // do not process other conditions
       }
+      else if (_.get(field, 'optional') && _.isNil(value)) {
+        // optional field can be removed from (response) payload if value is nil
+        fields  = _.filter(fields, item => {
+          if (item.field !== fieldName) return item
+        })
+      }
       else if (field.nullAllowed && _.isNull(_.get(paramsToCheck, fieldName))) {
         // do nothing null is allowed and sent!
       }

package/package.json

@@ -4,14 +4,14 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "5.1.2",
+  "version": "5.2.0",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
-    "ac-countrylist": "^1.0.14",
+    "ac-countrylist": "^1.0.15",
     "ac-file-extensions": "^2.0.13",
-    "ac-ip": "^4.1.5",
+    "ac-ip": "^4.1.6",
     "chai": "^4.5.0",
-    "date-and-time": "^3.6.0",
+    "date-and-time": "^4.0.5",
     "hashids": "^2.3.0",
     "lodash": "^4.17.21",
     "validator": "^13.15.15"
@@ -19,7 +19,7 @@
   "devDependencies": {
     "ac-semantic-release": "^0.4.8",
     "c8": "^10.1.3",
-    "eslint": "^9.35.0",
+    "eslint": "^9.36.0",
     "mocha": "^11.7.2"
   },
   "scripts": {

package/test/tests/helper.js

@@ -31,6 +31,10 @@ const runValidationTests = (tests, fieldName, { equalityCheck = 'equal', adminLe
           expect(_.get(r, 'error.additionalInfo'))[equalityCheck](_.get(test, 'additionalInfo'))
         }
       } 
+      else if (_.get(test, 'optional') && _.isNil(_.get(test, 'value'))) {
+        // if field is optional and value is nil, the field is removed from params
+        expect(_.get(r, `params.${fieldName}`)).to.be.undefined
+      }
       else {
         expect(_.get(r, `params.${fieldName}`))[equalityCheck](_.get(test, 'expected'))
       }

package/test/tests/string.js

@@ -20,7 +20,10 @@ module.exports = {
       { name: 'Valid - uppercase vs lowercase', type: 'string', ignoreCase: true, value: 'ABC', enum: ['abc'], expected: 'ABC' },
       { name: 'Invalid - value too short', type: 'string', minLength: 5, value: 'ABC', error: 'string_stringTooShort_minLength5' },
       { name: 'Valid - value is longer than 5 chars', type: 'string', minLength: 5, value: 'ABCDEF', expected: 'ABCDEF' },
-      { name: 'Valid - value is a URL encoded, space separated string', type: 'string', convert: 'splitSpaceSeparated', value: 'one%20two%20three', expected: ['one', 'two', 'three'] }
+      { name: 'Valid - value is a URL encoded, space separated string', type: 'string', convert: 'splitSpaceSeparated', value: 'one%20two%20three', expected: ['one', 'two', 'three'] },
+      { name: 'Valid - values is null and null allowed', type: 'string', nullAllowed: true, value: null, expected: null },
+      { name: 'Valid - values is null and null allowed and field is optional', type: 'string', nullAllowed: true, optional: true, value: null },
+      
     ]
 
     runValidationTests(baseTests, 'string', { equalityCheck: 'eql' })