ac-sanitizer 3.9.17 → 3.10.1

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+<a name="3.10.1"></a>
+
+## [3.10.1](https://github.com/mmpro/ac-sanitizer/compare/v3.10.0..v3.10.1) (2022-04-24 19:38:16)
+
+
+### Bug Fix
+
+* **App:** Fix for checking float | MP | [bd68b7c8bd76d15d22d9d2dea8ce78e07be7d3c9](https://github.com/mmpro/ac-sanitizer/commit/bd68b7c8bd76d15d22d9d2dea8ce78e07be7d3c9)    
+Check if type float is really a float  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+### Tests
+
+* **App:** Fixed tests | MP | [96e8d6067c219a241840e253ac9e11c36b258df0](https://github.com/mmpro/ac-sanitizer/commit/96e8d6067c219a241840e253ac9e11c36b258df0)    
+Make sure to check for errors from function  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+<a name="3.10.0"></a>
+ 
+# [3.10.0](https://github.com/mmpro/ac-sanitizer/compare/v3.9.18..v3.10.0) (2022-04-24 18:45:04)
+
+
+### Feature
+
+* **App:** Add type any | MP | [ff0858e978b7f7195f68ad5c9c346723107075fb](https://github.com/mmpro/ac-sanitizer/commit/ff0858e978b7f7195f68ad5c9c346723107075fb)    
+Type any will try to determine the actual type but gives you flexibility while sanitizing.  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+<a name="3.9.18"></a>
+
+## [3.9.18](https://github.com/mmpro/ac-sanitizer/compare/v3.9.17..v3.9.18) (2022-04-24 18:09:53)
+
+
+### Bug Fix
+
+* **App:** Minor fix for special fields | MP | [dc5a393127a74ebe948c8c5c953969688463422b](https://github.com/mmpro/ac-sanitizer/commit/dc5a393127a74ebe948c8c5c953969688463422b)    
+Only check if they are in payload.  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
 <a name="3.9.17"></a>
 
 ## [3.9.17](https://github.com/mmpro/ac-sanitizer/compare/v3.9.16..v3.9.17) (2022-04-24 14:58:01)

package/README.md

@@ -69,6 +69,7 @@ countrylist | list of country names | e.g. Laos, Brazil, Norway...
 
 Type | Options | Remarks
 --- | --- | --- |
+any | | Any can be string, integer, boolean, object or array - it will be automatically detected.
 base64 | | Checks if a string is base64 encoded, optional with field option "convert" (to string)
 boolean | | 
 cidr | | Check CIDR, see example

package/index.js

@@ -114,8 +114,30 @@ const sanitizer = function() {
         }
       }
 
-      if (!error) {
+      if (!error && _.has(paramsToCheck, fieldName)) {
         /// SPECIAL FIELDS
+        // field type any, can be any field
+        if (field.type === 'any') {
+          if (_.isString(value)) {
+            field.type = 'string'
+          }
+          else if (_.isPlainObject(value)) {
+            field.type = 'object'
+          }
+          else if (_.isArray(value)) {
+            field.type = 'array'
+          }
+          else if (_.isBoolean(value)) {
+            field.type = 'boolean'
+          }
+          else if (_.isFinite(parseInt(value))) {
+            field.type = 'integer'
+          }
+          else {
+            error = { message: fieldName + '_any_couldNotResolveType' }
+          }
+        }
+
         // special field - can be string or integer -> determine type and then use type settings
         if (field.type === 'integer | string') {
           if (!_.isString(value) && !_.isFinite(parseInt(value))) {
@@ -170,27 +192,36 @@ const sanitizer = function() {
       }
       else if (_.indexOf(['number', 'integer', 'long', 'short', 'float'], field.type) > -1) {
         if (typeof value != 'number' || isNaN(value)) error = { message: fieldName + '_' + getTypeMapping('integer', 'errorMessage') }
+        else {
+          //  Number types - usually we allow only non-negative values (unsigned). If you want negative values, set type.subtype 'signed'
+          if (field.type === 'number') console.error('SANITIZER - number should not be used, be more precise')
+          if (field.type === 'number') field.type = 'integer'
 
-        //  Number types - usually we allow only non-negative values (unsigned). If you want negative values, set type.subtype 'signed'
-        if (field.type === 'number') console.error('SANITIZER - number should not be used, be more precise')
-        if (field.type === 'number') field.type = 'integer'
-
-        const subtype = _.get(field, 'subtype')
-        let ranges = {
-          integer: [(subtype === 'signed' ? -Math.pow(2, 31) : 0), Math.pow(2, 31)], 
-          long: [(subtype === 'signed' ? -(Math.pow(2,53) - 1) : 0), Math.pow(2, 53)-1],
-          short: [(subtype === 'signed' ? -Math.pow(2, 15) : 0), Math.pow(2, 15)],
-          float: [(subtype === 'signed' ? -Math.pow(2, 31) : 0), Math.pow(2, 31)]
-        }
-        let range = _.get(field, 'range', _.get(ranges, field.type, ranges.integer))
+          if (field.type === 'float' && value !== parseFloat(value)) {
+            error = { message: fieldName + '_not_' + field.type, additionalInfo: { value } }
+          }
+          else if (field.type !== 'float' && value !== parseInt(value)) {
+            error = { message: fieldName + '_typeIncorrect', additionalInfo: { value, int: parseInt(value) } }
+          }
+          else {
+            const subtype = _.get(field, 'subtype')
+            let ranges = {
+              integer: [(subtype === 'signed' ? -Math.pow(2, 31) : 0), Math.pow(2, 31)], 
+              long: [(subtype === 'signed' ? -(Math.pow(2,53) - 1) : 0), Math.pow(2, 53)-1],
+              short: [(subtype === 'signed' ? -Math.pow(2, 15) : 0), Math.pow(2, 15)],
+              float: [(subtype === 'signed' ? -Math.pow(2, 31) : 0), Math.pow(2, 31)]
+            }
+            let range = _.get(field, 'range', _.get(ranges, field.type, ranges.integer))
 
-        if (field.type === 'float') value = parseFloat(value)
-        else value = parseInt(value)
+            if (field.type === 'float') value = parseFloat(value)
+            else value = parseInt(value)
 
-        let lowest = _.first(range)
-        let highest = _.size(range) === 2 && _.last(range)
-        if (value < lowest || (highest && value > highest)) {
-          error = { message: fieldName + '_outOfRange', additionalInfo: { range, value } }
+            let lowest = _.first(range)
+            let highest = _.size(range) === 2 && _.last(range)
+            if (value < lowest || (highest && value > highest)) {
+              error = { message: fieldName + '_outOfRange', additionalInfo: { range, value } }
+            }
+          }
         }
       }
       else if (field.type === 'string') {

package/package.json

@@ -4,7 +4,7 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "3.9.17",
+  "version": "3.10.1",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
     "ac-countrylist": "^1.0.6",

package/test/suites/default.js

@@ -12,6 +12,11 @@ module.exports = {
       tests.error.test()
     })
 
+    describe('ANY', function() {
+      this.timeout(timeOut)
+      tests.any.test()
+    })
+    
     describe('STRING', function() {
       this.timeout(timeOut)
       tests.string.test()

package/test/tests/any.js

@@ -0,0 +1,48 @@
+const _ = require('lodash')
+const expect = require('expect')
+const sanitizer = require('../../index')
+
+module.exports = {
+
+  test:  () => {
+
+    const baseTests = [
+      { name: 'Any - with string', type: 'any', value: 'admiralcloud', expected: 'admiralcloud' },
+      { name: 'Any - with integer', type: 'any', value: 123, expected: 123 },
+      { name: 'Any - with boolean', type: 'any', value: true, expected: true },
+      { name: 'Any - with boolean - false', type: 'any', value: false, expected: false },
+      { name: 'Any - with object', type: 'any', value: { a: 123 }, expected: { a: 123 } },
+      { name: 'Any - with array', type: 'any', value: [1,2,3], expected: [1,2,3] },
+      { name: 'Any - with array of objects', type: 'any', value: [{ a: 123 }], expected: [{ a: 123 }] },
+      { name: 'Any - with float - cannot auto-detect', type: 'any', value: 123.235, error: 'any_typeIncorrect', additionalInfo: { value: 123.235, int: 123 } },
+    ]
+
+    _.forEach(baseTests, (test) => {
+      it(test.name, (done) => {
+        let fieldsToCheck = {
+          params: {
+            any: _.get(test, 'value')
+          },
+          fields: [
+            { field: 'any', type: _.get(test, 'type') }
+          ]
+        }
+        let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
+        if (_.get(r, 'error')) {
+          expect(_.get(r, 'error.message')).toEqual(test.error)
+          if (_.get(test, 'additionalInfo')) {
+            expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))
+          }
+        }
+        else {
+          expect(_.get(r, 'params.any')).toEqual(_.get(test, 'expected'))
+        }
+        return done()
+      })
+
+    })
+
+
+
+  }
+}

package/test/tests/array.js

@@ -50,7 +50,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/base64.js

@@ -28,7 +28,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/bool.js

@@ -28,7 +28,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/boolOrInteger.js

@@ -24,7 +24,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/cidr.js

@@ -29,7 +29,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/country.js

@@ -25,7 +25,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/date.js

@@ -31,7 +31,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/email.js

@@ -26,7 +26,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/error.js

@@ -17,16 +17,17 @@ module.exports = {
       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'), omitFields: _.get(test, 'omitFields') }
+            { field: 'errorField', type: _.get(test, 'type'), required: _.get(test, 'required'), adminLevel: _.get(test, 'adminLevel') }
           ]
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/fileExtension.js

@@ -25,7 +25,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/fqdn.js

@@ -23,7 +23,7 @@ module.exports = {
           ]
         }
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/gps.js

@@ -28,7 +28,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/hashIds.js

@@ -28,7 +28,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/hexColor.js

@@ -25,7 +25,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/index.js

@@ -1,4 +1,5 @@
 module.exports = {
+  any: require('./any'),
   array: require('./array'),
   base64: require('./base64'),
   bool: require('./bool'),

package/test/tests/ip.js

@@ -26,7 +26,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/number.js

@@ -101,6 +101,7 @@ module.exports = {
         { name: 'Unsigned float -1 - should fail and display additionalInfo', type: 'float', value: -1, error: 'number_outOfRange', additionalInfo: { range: [0,2147483648], value: -1 } },
         { name: 'Array of numbers with one entry', type: 'integer', value: [123], error: 'number_notAFiniteNumber' },
         { name: 'Array of numbers with multiple entries', type: 'integer', value: [123, 456], error: 'number_notAFiniteNumber' },
+        { name: 'Check float', type: 'float', range: [-90, 90], value: 53.15, expected: 53.15 }
       ]
       
       _.forEach(tests, (test) => {
@@ -115,7 +116,7 @@ module.exports = {
           }
   
           let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-          if (_.get(test, 'error')) {
+          if (_.get(r, 'error')) {
             expect(_.get(r, 'error.message')).toEqual(test.error)
             if (_.get(test, 'additionalInfo')) {
               expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/object.js

@@ -181,7 +181,7 @@ module.exports = {
           ],
         };
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck);
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/ratio.js

@@ -26,7 +26,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/rgb.js

@@ -28,7 +28,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/string.js

@@ -32,7 +32,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/stringOrInteger.js

@@ -11,6 +11,7 @@ module.exports = {
       { name: 'Valid empty string', type: 'integer | string', value: '', expected: '', minLength: 0 },
       { name: 'Valid integer', type: 'integer | string', value: 123, expected:  123 },
       { name: 'Invalid - neither string nor integer', type: 'integer | string', value: ['abc'], error: 'stringOrInteger_neitherStringNorInteger' },
+      { name: 'Valid - no data - ignore', type: 'integer | string' },
     ]
 
 
@@ -19,13 +20,13 @@ module.exports = {
         let fieldsToCheck = {
           params: {},
           fields: [
-            { field: 'stringOrInteger', type: _.get(test, 'type'), required: _.get(test, 'required') }
+            { field: 'stringOrInteger', type: _.get(test, 'type'), required: _.get(test, 'required'), minLength: _.get(test, 'minLength') }
           ]
         }
         if (_.has(test, 'value')) fieldsToCheck.params.stringOrInteger = test.value
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/url.js

@@ -24,7 +24,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))

package/test/tests/uuid.js

@@ -25,7 +25,7 @@ module.exports = {
         }
 
         let r = sanitizer.checkAndSanitizeValues(fieldsToCheck)
-        if (_.get(test, 'error')) {
+        if (_.get(r, 'error')) {
           expect(_.get(r, 'error.message')).toEqual(test.error)
           if (_.get(test, 'additionalInfo')) {
             expect(_.get(r, 'error.additionalInfo')).toEqual(_.get(test, 'additionalInfo'))