ac-sanitizer 4.1.0 → 4.1.3

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+
+## [4.1.3](https://github.com/mmpro/ac-sanitizer/compare/v4.1.2..v4.1.3) (2025-03-18 08:54:37)
+
+
+### Bug Fix
+
+* **App:** Package updates | MP | [44220372ad7190e78cc750d8bc08b6388b15ab6a](https://github.com/mmpro/ac-sanitizer/commit/44220372ad7190e78cc750d8bc08b6388b15ab6a)    
+Package updates  
+Related issues:
+
+## [4.1.2](https://github.com/mmpro/ac-sanitizer/compare/v4.1.1..v4.1.2) (2025-01-25 13:17:56)
+
+
+### Bug Fix
+
+* **App:** Minor adjustments | MP | [3c24752c112d8e92e66f2fd6c262005c616edc3c](https://github.com/mmpro/ac-sanitizer/commit/3c24752c112d8e92e66f2fd6c262005c616edc3c)    
+Make sure to remove undefined properties  
+Related issues:
+### Tests
+
+* **App:** Refactored tests | MP | [fcaf656fbeccfd8228038e64b4e520514faf31a8](https://github.com/mmpro/ac-sanitizer/commit/fcaf656fbeccfd8228038e64b4e520514faf31a8)    
+Use a generic test helper to reduce duplications  
+Related issues:
+### Chores
+
+* **App:** Improved ESLint | MP | [79b6879917027c07e9df6d6a44b51c199780a289](https://github.com/mmpro/ac-sanitizer/commit/79b6879917027c07e9df6d6a44b51c199780a289)    
+Improved ESLint  
+Related issues:
+
+## [4.1.1](https://github.com/mmpro/ac-sanitizer/compare/v4.1.0..v4.1.1) (2025-01-25 10:27:26)
+
+
+### Bug Fix
+
+* **App:** Improved ignoreCase function | MP | [eff1e68bb1b5e32fa448e4c58645a4f06c0b0d15](https://github.com/mmpro/ac-sanitizer/commit/eff1e68bb1b5e32fa448e4c58645a4f06c0b0d15)    
+Improved ignoreCase function  
+Related issues:
+### Tests
+
+* **App:** Added test | MP | [7674a680a189868b6d20a2307a5f73b66b62b2f6](https://github.com/mmpro/ac-sanitizer/commit/7674a680a189868b6d20a2307a5f73b66b62b2f6)    
+Added test for arrays with ignoreCase  
+Related issues:
  
 # [4.1.0](https://github.com/mmpro/ac-sanitizer/compare/v4.0.16..v4.1.0) (2025-01-25 10:01:18)
 

package/Makefile

@@ -2,10 +2,10 @@ MOCHA_OPTS= --slow 0 -A
 REPORTER = spec
 
 lint-fix:
-	./node_modules/.bin/eslint --fix index.js test/test.js
+	./node_modules/.bin/eslint --fix index.js test/test.js test/tests/**.js
 
 lint-check:
-	./node_modules/.bin/eslint index.js test/test.js
+	./node_modules/.bin/eslint index.js test/test.js test/tests/**.js
 
 commit:
 	@node ./node_modules/ac-semantic-release/lib/commit.js

package/eslint.config.js

@@ -22,7 +22,8 @@ module.exports = [
       'no-useless-escape': 'off',
       'standard/no-callback-literal': 'off',
       'new-cap': 'off',
-      'no-console': ['error', { allow: ['error'] }]
+      'no-console': ['error', { allow: ['error'] }],
+      "no-multiple-empty-lines": ["error", { "max": 1 }]
     },
     ignores: ['temp.js', 'config/*']
   }

package/index.js

@@ -56,7 +56,7 @@ const sanitizer = function() {
    */
 
   const checkAndSanitizeValues = (params) => {
-    const paramsToCheck = params.params
+    let paramsToCheck = _.omitBy(params.params, _.isUndefined)
     if (!_.isObject(paramsToCheck)) return { error: { message: 'params_required' } }
     let fields = params.fields
     if (!_.isArray(fields) || !_.size(fields)) return { error: { message: 'fields_required' } }
@@ -107,7 +107,7 @@ const sanitizer = function() {
         else {
           if (_.get(field, 'required')) {
             fieldIsRequired = true
-            if (!_.has(paramsToCheck, fieldName)) {
+            if (!_.has(paramsToCheck, fieldName) || _.isUndefined(_.get(paramsToCheck, fieldName))) {
               error = { message: 'field_' + fieldName + '_required' }
             }
           }
@@ -212,7 +212,6 @@ const sanitizer = function() {
           if (field.type === 'number') console.error('SANITIZER - number should not be used, be more precise')
           if (field.type === 'number') field.type = 'integer'
 
-
           if (field.type !== 'float' && _.get(field, 'convert')) {
             // make sure the value is integer
             value = parseInt(value)
@@ -497,27 +496,24 @@ 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)
+        
+        const compareIgnoreCase = (a, b) => {
+          return a.toLowerCase() === b.toLowerCase()
         }
+        const compareFn = field.ignoreCase ? compareIgnoreCase : _.isEqual 
 
         if (_.isArray(value)) {
-          if (_.size(value) && !_.size(_.intersectionWith(value, allowedValues, _.isEqual))) {
+          if (_.size(value) && !_.size(_.intersectionWith(value, allowedValues, compareFn))) {
             error = { message: fieldName + '_notAnAllowedValue', additionalInfo: { value } }
           }
           // remove non-matching entries, but do not fail/return error
-          value = _.intersectionWith(value, allowedValues, _.isEqual)
+          value = _.intersectionWith(value, allowedValues, compareFn)
           _.set(paramsToCheck, fieldName, value)
         }
-        else if (_.indexOf(allowedValues, value) < 0) {
+        else if (_.findIndex(allowedValues, val => compareFn(val, value)) < 0) {
           error = { message: fieldName + '_notAnAllowedValue', additionalInfo: { value } }
         }
 
-        if (orgValue) value = orgValue
       } 
 
       if (error && field.customErrorMessage) _.set(error, 'message', field.customErrorMessage)
@@ -548,8 +544,6 @@ const sanitizer = function() {
     else params = _.get(check, 'params')
     */
 
-
-
   /**
    * Return a random value for a given type
    */

package/package.json

@@ -4,12 +4,12 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "4.1.0",
+  "version": "4.1.3",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
     "ac-countrylist": "^1.0.12",
     "ac-file-extensions": "^2.0.10",
-    "ac-ip": "^4.1.2",
+    "ac-ip": "^4.1.3",
     "chai": "^4.5.0",
     "date-and-time": "^3.6.0",
     "hashids": "^2.3.0",
@@ -19,7 +19,7 @@
   "devDependencies": {
     "ac-semantic-release": "^0.4.5",
     "c8": "^10.1.3",
-    "eslint": "^9.19.0",
+    "eslint": "^9.22.0",
     "mocha": "^11.1.0"
   },
   "scripts": {

package/test/tests/any.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -18,32 +17,6 @@ module.exports = {
       { name: 'Any - with null and nullAllowed', type: 'any', value: null, nullAllowed: true, expected: null },
     ]
 
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            any: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'any', type: _.get(test, 'type'), nullAllowed: _.get(test, 'nullAllowed') }
-          ]
-        }
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.eql(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.any')).to.eql(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'any', { equalityCheck: 'eql' })
   }
 }

package/test/tests/array.js

@@ -1,4 +1,4 @@
-const _ = require('lodash')
+const { runValidationTests } = require('./helper')
 const sanitizer = require('../../index')
 
 module.exports = {
@@ -8,7 +8,7 @@ module.exports = {
     const randomValueString = sanitizer.randomValue({ type: 'array' })
 
     const baseTests = [
-      { name: 'Valid array of numbers', type: 'array', value: randomValueInt, expected: randomValueInt},
+      { name: 'Valid array of numbers', type: 'array', value: randomValueInt, expected: randomValueInt },
       { name: 'Valid array of strings', type: 'array', value: randomValueString, expected: randomValueString },
       { name: 'Invalid array', type: 'array', value: 'a', error: 'array_notAnArray' },
       { name: 'Array with enum match', type: 'array', value: ['video'], enum: ['audio', 'video'], expected: ['video'] },
@@ -36,43 +36,11 @@ module.exports = {
         properties: [{ field: 'p1', type: 'string' }], 
         value: [{ p1: 'isAString', p2: 'shouldBeRemoved' }, { p1: 'isAString2', p2: 'shouldBeRemoved2' }],
         expected: [{ p1: 'isAString' },  { p1: 'isAString2' }]
-      }
+      },
+      { name: 'Array of strings with enum - uppercase vs lowercase', type: 'array', valueType: 'string', value: ['ABC'], enum: ['abc'], error: 'array_notAnAllowedValue' },
+      { name: 'Array of strings with enum - uppercase vs lowercase - with ignoreCase', type: 'array', valueType: 'string', ignoreCase: true, value: ['ABC', 'DEF'], enum: ['abc'], expected: ['ABC'] },
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            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'), properties: _.get(test, "properties")}
-          ]
-        }
-        if (test.enum) {
-          _.set(fieldsToCheck, 'fields[0].enum', test.enum)
-        }
-        if (test.wildcardAllowed) {
-          _.set(fieldsToCheck, 'fields[0].wildcardAllowed', test.wildcardAllowed)
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.array')).to.eql(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'array', { equalityCheck: 'eql' })
   }
 }

package/test/tests/base64.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -21,33 +20,6 @@ module.exports = {
       { name: 'Base64 string with enum - fail', type: 'base64', value: 'bXlzdHJpbmc=', convert: true, error: 'base64_notAnAllowedValue', enum: ['otherstring'] }
     ]
 
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            base64: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'base64', type: _.get(test, 'type'), convert: _.get(test, 'convert'), enum: _.get(test, 'enum') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.base64')).to.eql(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'base64', { equalityCheck: 'eql' })
   }
 }

package/test/tests/bool.js

@@ -1,4 +1,4 @@
-const _ = require('lodash')
+const { runValidationTests } = require('./helper')
 const sanitizer = require('../../index')
 
 module.exports = {
@@ -14,34 +14,6 @@ module.exports = {
       { name: 'Invalid - value is integer', type: 'boolean', value: 123, error: 'bool_notBoolean' },
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            bool: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'bool', type: _.get(test, 'type'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.bool')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'bool')
   }
 }

package/test/tests/boolOrInteger.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -11,29 +10,6 @@ module.exports = {
       { name: 'Invalid - neither bool nor integer', type: 'integer | boolean', value: 'abc', error: 'boolOrInteger_neitherBooleanNorInteger' },
     ]
 
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            boolOrInteger: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'boolOrInteger', type: _.get(test, 'type'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.boolOrInteger')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-    })
+    runValidationTests(baseTests, 'boolOrInteger')
   }
 }

package/test/tests/cidr.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -15,33 +14,6 @@ module.exports = {
       { name: 'Invalid CIDR array', type: 'cidr', valueType: 'cidr', value: [{ cidr: '::ffff:127.0.0.1' }], error: 'cidr_notAValidCIDR' },
     ]
     
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            cidr: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'cidr', type: _.get(test, 'type'), version: _.get(test, 'version'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.cidr')).to.eql(_.get(test, 'expected'))
-        }
-        return done()
-      })
-    })
-
-
-
+    runValidationTests(baseTests, 'cidr', { equalityCheck: 'eql' })
   }
 }

package/test/tests/country.js

@@ -1,4 +1,4 @@
-const _ = require('lodash')
+const { runValidationTests } = require('./helper')
 const sanitizer = require('../../index')
 
 module.exports = {
@@ -11,34 +11,6 @@ module.exports = {
       { name: 'Invalid countryCode', type: 'countryCode', value: 'germany', error: 'countryCode_notAValidCountryCode' },
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            countryCode: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'countryCode', type: _.get(test, 'type'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.countryCode')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'countryCode')
   }
 }

package/test/tests/date.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -15,36 +14,8 @@ module.exports = {
       { name: 'Invalid date', type: 'date', value: '2020-13-30', error: 'date_notaDate' },
       { name: 'Valid DateTime ISO8601', type: 'date', value: '2020-10-17T16:34:50+02:00', expected: '2020-10-17T16:34:50+02:00' },
       { name: 'Invalid date with custom date format', type: 'date', dateFormat: 'mmm-xyt', value: '2020-13-30', error: 'date_notaDate' },
-  
-      
     ]
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            date: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'date', type: _.get(test, 'type'), required: _.get(test, 'required'), dateFormat: _.get(test, 'dateFormat') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.date')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
 
+    runValidationTests(baseTests, 'date')
   }
 }

package/test/tests/email.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -12,34 +11,6 @@ module.exports = {
       { name: 'Valid email', type: 'email', value: 'jane.doe+mediahub002@admiralcloud.com', expected: 'jane.doe+mediahub002@admiralcloud.com' },
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            email: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'email', type: _.get(test, 'type'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.email')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'email')
   }
 }

package/test/tests/error.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -11,36 +10,7 @@ module.exports = {
       { name: 'AdminLevel not sufficient, omit fields', omitFields: true, type: 'string', value: 'abc', adminLevel: 10, expected: undefined }
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          adminLevel: 4,
-          omitFields: _.get(test, 'omitFields'),
-          params: {
-            errorField: _.get(test, 'value'),
-          },
-          fields: [
-            { field: 'errorField', type: _.get(test, 'type'), required: _.get(test, 'required'), adminLevel: _.get(test, 'adminLevel') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.email')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'errorField', { adminLevel: 4 })
   }
 }
+

package/test/tests/fileExtension.js

@@ -1,5 +1,4 @@
-const _ = require('lodash')
-const sanitizer = require('../../index')
+const { runValidationTests } = require('./helper')
 
 module.exports = {
 
@@ -11,34 +10,6 @@ module.exports = {
       { name: 'Invalid fileExtension', type: 'fileExtension', value: 'xxx', error: 'fileExtension_notAValidFileExtension' },
     ]
 
-
-    _.forEach(baseTests, (test) => {
-      it(test.name, (done) => {
-        let fieldsToCheck = {
-          params: {
-            fileExtension: _.get(test, 'value')
-          },
-          fields: [
-            { field: 'fileExtension', type: _.get(test, 'type'), required: _.get(test, 'required') }
-          ]
-        }
-
-        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(r, 'error')) {
-          expect(_.get(r, 'error.message')).to.equal(test.error)
-          if (_.get(test, 'additionalInfo')) {
-            expect(_.get(r, 'error.additionalInfo')).to.equal(_.get(test, 'additionalInfo'))
-          }
-        }
-        else {
-          expect(_.get(r, 'params.fileExtension')).to.equal(_.get(test, 'expected'))
-        }
-        return done()
-      })
-
-    })
-
-
-
+    runValidationTests(baseTests, 'fileExtension')
   }
 }