ac-sanitizer 3.10.5 → 3.10.7

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+<a name="3.10.7"></a>
+
+## [3.10.7](https://github.com/mmpro/ac-sanitizer/compare/v3.10.6..v3.10.7) (2023-01-28 19:37:40)
+
+
+### Bug Fix
+
+* **App:** Package updates | MP | [ea995e12e8fb33f161346643e842415265d8701c](https://github.com/mmpro/ac-sanitizer/commit/ea995e12e8fb33f161346643e842415265d8701c)    
+Package updates  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Documentation
+
+* **App:** Updated README | MP | [38ed9526f3c60b79802e573ff6ac3c7dec41c95f](https://github.com/mmpro/ac-sanitizer/commit/38ed9526f3c60b79802e573ff6ac3c7dec41c95f)    
+Minor update  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="3.10.6"></a>
+
+## [3.10.6](https://github.com/mmpro/ac-sanitizer/compare/v3.10.5..v3.10.6) (2022-07-23 06:54:26)
+
+
+### Bug Fix
+
+* **App:** Allow convert with number | MP | [3e3d951a275b4c3e90654071cc2dcafb303742f2](https://github.com/mmpro/ac-sanitizer/commit/3e3d951a275b4c3e90654071cc2dcafb303742f2)    
+In order to be more lenient you can add property convert to numbers (e.g. integer). This way incoming float value will be converted to integer instead of returning an error.  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
 <a name="3.10.5"></a>
 
 ## [3.10.5](https://github.com/mmpro/ac-sanitizer/compare/v3.10.4..v3.10.5) (2022-06-25 09:02:28)

package/README.md

@@ -47,12 +47,13 @@ Parameter | Type | Remarks
 field | string | Name of the field
 type | string | Type of the field to sanitize, see below for available values
 required | [boolean OR string] | Set to true if required or set a path[^1] to a param (if that param is set, this value is required)
-enum | [array|string] | Optional list of allowed values. You can a string placeholder for certain standard lists (see below)
+enum | [array OR string] | Optional list of allowed values. You can a string placeholder for certain standard lists (see below)
 adminLevel | [integer] | Optional adminLevel required for this field
 omitFields | [boolean] | If adminLevel is set and you do not have the proper adminLevel the sanitizer will just omit the field (and not return an error) if omitFields is true
-convert | [boolean|string] | Some types can be automatically converted (e.g. base64 to string)
+convert | [boolean OR string] | Some types can be automatically converted (e.g. base64 to string)
 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.
 
 [^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.
 
@@ -65,6 +66,15 @@ iso-639-1 | ISO 639-1 entries | e.g. de, en, fr, es...
 iso-639-2 | ISO 639-2 entries | e.g. deu, eng, fra ...
 countrylist | list of country names | e.g. Laos, Brazil, Norway...
 
+### Convert
+Some types allow automatic conversion:
+Type | Example | Remarks
+--- | --- | --- |
+integer | 60.1 -> 60 | Convert incoming number to integer - this way you can make your check more lenient
+string | Hello Developer -> Hello (with maxLength = 5) | Reduce string to max length
+base64 | SGVsbG8= -> Hello | Convert base64 encoded string to UTF-8 string
+iso-639 | { iso-639-2: 'tlh', translations: [] } -> tlh (with convert=iso-639-2) | Returns only the select property for the ISO-639 object
+
 
 ## Available types
 

package/index.js

@@ -200,6 +200,13 @@ 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)
+            _.set(paramsToCheck, fieldName, value)
+          }
+
           if (field.type === 'float' && value !== parseFloat(value)) {
             error = { message: fieldName + '_not_' + field.type, additionalInfo: { value } }
           }

package/package.json

@@ -4,22 +4,22 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "3.10.5",
+  "version": "3.10.7",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
     "ac-countrylist": "^1.0.7",
     "ac-file-extensions": "^2.0.5",
     "ac-ip": "^2.0.0",
-    "chai": "^4.3.6",
-    "date-and-time": "^2.4.0",
+    "chai": "^4.3.7",
+    "date-and-time": "^2.4.2",
     "hashids": "^2.2.10",
     "lodash": "^4.17.21",
     "validator": "^13.7.0"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.3.0",
-    "eslint": "^8.18.0",
-    "mocha": "^10.0.0",
+    "ac-semantic-release": "^0.3.4",
+    "eslint": "^8.32.0",
+    "mocha": "^10.2.0",
     "nyc": "^15.1.0"
   },
   "scripts": {

package/test/tests/number.js

@@ -74,7 +74,7 @@ module.exports = {
                   integer: _.get(test, 'value')
                 },
                 fields: [
-                  { field: 'integer', type: _.get(test, 'type'), subtype: _.get(test, 'subtype'), required: _.get(test, 'required'), range: _.get(test, 'range') }
+                  { field: 'integer', type: _.get(test, 'type'), subtype: _.get(test, 'subtype'), required: _.get(test, 'required'), convert: _.get(test, 'convert'), range: _.get(test, 'range') }
                 ]
               }
 
@@ -100,7 +100,9 @@ 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 }
+        { name: 'Check float', type: 'float', range: [-90, 90], value: 53.15, expected: 53.15 },
+        { name: 'Integer as float - 60.1 - should fail', type: 'integer', value: 60.1, error: 'number_typeIncorrect' },      
+        { name: 'Integer as float with convert - 60.1 - should work', type: 'integer', convert: true, value: 60.1, expected: 60 },      
       ]
       
       _.forEach(tests, (test) => {
@@ -110,7 +112,7 @@ module.exports = {
               number: _.get(test, 'value')
             },
             fields: [
-              { field: 'number', type: _.get(test, 'type'), subtype: _.get(test, 'subtype'), required: _.get(test, 'required'), range: _.get(test, 'range') }
+              { field: 'number', type: _.get(test, 'type'), subtype: _.get(test, 'subtype'), required: _.get(test, 'required'), convert: _.get(test, 'convert'), range: _.get(test, 'range') }
             ]
           }