node-switchbot 1.3.0 → 1.4.0

package/lib/parameter-checker.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 class ParameterChecker {
   constructor() {
@@ -12,55 +12,55 @@ class ParameterChecker {
     //   code: 'TYPE_INVALID',
     //   message: 'The `age` must be an integer.'
     //   name: 'age',
-    // } 
+    // }
     // ---------------------------------
     return this._error;
   }
 
   isSpecified(value) {
-    return (value === void 0) ? false : true;
+    return value === void 0 ? false : true;
   }
 
   /* ------------------------------------------------------------------
-  * check(obj, rule, required)
-  * - Check if the specified object contains valid values
-  *
-  * [Arguments]
-  * - obj      | Object  | Required | Object including parameters you want to check
-  * - rules    | Object  | Required | Object including rules for the parameters
-  * - required | Boolean | Optional | Flag whther the `obj` is required or not.
-  *            |         |          | The default is `false`
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  *
-  * [Usage]
-  * let valid = parameterChecker.check(params, {
-  *   level: {
-  *     required: false,
-  *     type: 'integer',
-  *     max: 100
-  *   },
-  *   greeting: {
-  *     required: true, // But an empty string is allowed.
-  *     type: 'string',
-  *     max: 20 // the number of characters must be up to 20.
-  *   }
-  * });
-  * if(!valid) {
-  *   let e = parameterChecker.error.message;
-  *   throw new Error(message);
-  * }
-  * ---------------------------------------------------------------- */
+   * check(obj, rule, required)
+   * - Check if the specified object contains valid values
+   *
+   * [Arguments]
+   * - obj      | Object  | Required | Object including parameters you want to check
+   * - rules    | Object  | Required | Object including rules for the parameters
+   * - required | Boolean | Optional | Flag whther the `obj` is required or not.
+   *            |         |          | The default is `false`
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   *
+   * [Usage]
+   * let valid = parameterChecker.check(params, {
+   *   level: {
+   *     required: false,
+   *     type: 'integer',
+   *     max: 100
+   *   },
+   *   greeting: {
+   *     required: true, // But an empty string is allowed.
+   *     type: 'string',
+   *     max: 20 // the number of characters must be up to 20.
+   *   }
+   * });
+   * if(!valid) {
+   *   let e = parameterChecker.error.message;
+   *   throw new Error(message);
+   * }
+   * ---------------------------------------------------------------- */
   check(obj, rules, required = false) {
     this._error = null;
     if (required) {
       if (!this.isSpecified(obj)) {
         this._error = {
-          code: 'MISSING_REQUIRED',
-          message: 'The first argument is missing.'
+          code: "MISSING_REQUIRED",
+          message: "The first argument is missing.",
         };
         return false;
       }
@@ -72,8 +72,8 @@ class ParameterChecker {
 
     if (!this.isObject(obj)) {
       this._error = {
-        code: 'MISSING_REQUIRED',
-        message: 'The first argument is missing.'
+        code: "MISSING_REQUIRED",
+        message: "The first argument is missing.",
       };
       return false;
     }
@@ -93,8 +93,8 @@ class ParameterChecker {
         if (rule.required) {
           result = false;
           this._error = {
-            code: 'MISSING_REQUIRED',
-            message: 'The `' + name + '` is required.'
+            code: "MISSING_REQUIRED",
+            message: "The `" + name + "` is required.",
           };
           break;
         } else {
@@ -102,23 +102,27 @@ class ParameterChecker {
         }
       }
 
-      if (rule.type === 'float') {
+      if (rule.type === "float") {
         result = this.isFloat(v, rule, name);
-      } else if (rule.type === 'integer') {
+      } else if (rule.type === "integer") {
         result = this.isInteger(v, rule, name);
-      } else if (rule.type === 'boolean') {
+      } else if (rule.type === "boolean") {
         result = this.isBoolean(v, rule, name);
-      } else if (rule.type === 'array') {
+      } else if (rule.type === "array") {
         result = this.isArray(v, rule, name);
-      } else if (rule.type === 'object') {
+      } else if (rule.type === "object") {
         result = this.isObject(v, rule, name);
-      } else if (rule.type === 'string') {
+      } else if (rule.type === "string") {
         result = this.isString(v, rule, name);
       } else {
         result = false;
         this._error = {
-          code: 'TYPE_UNKNOWN',
-          message: 'The rule specified for the `' + name + '` includes an unknown type: ' + rule.type,
+          code: "TYPE_UNKNOWN",
+          message:
+            "The rule specified for the `" +
+            name +
+            "` includes an unknown type: " +
+            rule.type,
         };
       }
 
@@ -132,55 +136,65 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isFloat(value, rule, name)
-  * - Check if the value is a float
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.
-  *   - min      | Float   | Optional | Minimum number
-  *   - max      | Float   | Optional | Maximum number
-  *   - enum     | Array   | Optional | list of possible values
-  * - name       | String  | Optional | Parameter name
-  *
-  * If non-number value is specified to the `min` or `max`,
-  * they will be ignored. 
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isFloat(value, rule = {}, name = 'value') {
+   * isFloat(value, rule, name)
+   * - Check if the value is a float
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.
+   *   - min      | Float   | Optional | Minimum number
+   *   - max      | Float   | Optional | Maximum number
+   *   - enum     | Array   | Optional | list of possible values
+   * - name       | String  | Optional | Parameter name
+   *
+   * If non-number value is specified to the `min` or `max`,
+   * they will be ignored.
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isFloat(value, rule = {}, name = "value") {
     this._error = null;
 
     if (!rule.required && !this.isSpecified(value)) {
       return true;
     }
 
-    if (typeof (value) !== 'number') {
+    if (typeof value !== "number") {
       this._error = {
-        code: 'TYPE_INVALID',
-        message: 'The `' + name + '` must be a number (integer or float).'
+        code: "TYPE_INVALID",
+        message: "The `" + name + "` must be a number (integer or float).",
       };
       return false;
     }
 
-    if (typeof (rule.min) === 'number') {
+    if (typeof rule.min === "number") {
       if (value < rule.min) {
         this._error = {
-          code: 'VALUE_UNDERFLOW',
-          message: 'The `' + name + '` must be grater than or equal to ' + rule.min + '.'
+          code: "VALUE_UNDERFLOW",
+          message:
+            "The `" +
+            name +
+            "` must be grater than or equal to " +
+            rule.min +
+            ".",
         };
         return false;
       }
     }
-    if (typeof (rule.max) === 'number') {
+    if (typeof rule.max === "number") {
       if (value > rule.max) {
         this._error = {
-          code: 'VALUE_OVERFLOW',
-          message: 'The `' + name + '` must be less than or equal to ' + rule.max + '.'
+          code: "VALUE_OVERFLOW",
+          message:
+            "The `" +
+            name +
+            "` must be less than or equal to " +
+            rule.max +
+            ".",
         };
         return false;
       }
@@ -188,8 +202,13 @@ class ParameterChecker {
     if (Array.isArray(rule.enum) && rule.enum.length > 0) {
       if (rule.enum.indexOf(value) === -1) {
         this._error = {
-          code: 'ENUM_UNMATCH',
-          message: 'The `' + name + '` must be any one of ' + JSON.stringify(rule.enum) + '.'
+          code: "ENUM_UNMATCH",
+          message:
+            "The `" +
+            name +
+            "` must be any one of " +
+            JSON.stringify(rule.enum) +
+            ".",
         };
         return false;
       }
@@ -199,27 +218,27 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isInteger(value, rule)
-  * - Check if the value is an integer
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.|
-  *   - min      | Float   | Optional | Minimum number
-  *   - max      | Float   | Optional | Maximum number
-  *   - enum     | Array   | Optional | list of possible values
-  * - name       | String  | Optional | Parameter name
-  *
-  * If non-number value is specified to the `min` or `max`,
-  * they will be ignored. 
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isInteger(value, rule = {}, name = 'value') {
+   * isInteger(value, rule)
+   * - Check if the value is an integer
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.|
+   *   - min      | Float   | Optional | Minimum number
+   *   - max      | Float   | Optional | Maximum number
+   *   - enum     | Array   | Optional | list of possible values
+   * - name       | String  | Optional | Parameter name
+   *
+   * If non-number value is specified to the `min` or `max`,
+   * they will be ignored.
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isInteger(value, rule = {}, name = "value") {
     this._error = null;
 
     if (!rule.required && !this.isSpecified(value)) {
@@ -231,8 +250,8 @@ class ParameterChecker {
         return true;
       } else {
         this._error = {
-          code: 'TYPE_INVALID',
-          message: 'The `' + name + '` must be an integer.'
+          code: "TYPE_INVALID",
+          message: "The `" + name + "` must be an integer.",
         };
         return false;
       }
@@ -242,31 +261,31 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isBoolean(value, rule, name)
-  * - Check if the value is a boolean.
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.
-  * - name       | String  | Optional | Parameter name
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isBoolean(value, rule = {}, name = 'value') {
+   * isBoolean(value, rule, name)
+   * - Check if the value is a boolean.
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.
+   * - name       | String  | Optional | Parameter name
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isBoolean(value, rule = {}, name = "value") {
     this._error = null;
 
     if (!rule.required && !this.isSpecified(value)) {
       return true;
     }
 
-    if (typeof (value) !== 'boolean') {
+    if (typeof value !== "boolean") {
       this._error = {
-        code: 'TYPE_INVALID',
-        message: 'The `' + name + '` must be boolean.'
+        code: "TYPE_INVALID",
+        message: "The `" + name + "` must be boolean.",
       };
       return false;
     }
@@ -274,30 +293,30 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isObject(value)
-  * - Check if the value is an object
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.
-  * - name       | String  | Optional | Parameter name
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isObject(value, rule = {}, name = 'value') {
+   * isObject(value)
+   * - Check if the value is an object
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.
+   * - name       | String  | Optional | Parameter name
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isObject(value, rule = {}, name = "value") {
     this._error = null;
     if (!rule.required && !this.isSpecified(value)) {
       return true;
     }
 
-    if (typeof (value) !== 'object' || value === null || Array.isArray(value)) {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
       this._error = {
-        code: 'TYPE_INVALID',
-        message: 'The `' + name + '` must be an object.'
+        code: "TYPE_INVALID",
+        message: "The `" + name + "` must be an object.",
       };
       return false;
     }
@@ -305,26 +324,26 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isArray(value, rule, name)
-  * - Check if the value is an `Array` object
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.
-  *   - min      | Integer | Optional | Minimum number of elements in the array
-  *   - max      | Integer | Optional | Maximum number of elements in the array
-  * - name       | String  | Optional | Parameter name
-  *
-  * If non-number value is specified to the `min` or `max`,
-  * they will be ignored. 
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isArray(value, rule = {}, name = 'value') {
+   * isArray(value, rule, name)
+   * - Check if the value is an `Array` object
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.
+   *   - min      | Integer | Optional | Minimum number of elements in the array
+   *   - max      | Integer | Optional | Maximum number of elements in the array
+   * - name       | String  | Optional | Parameter name
+   *
+   * If non-number value is specified to the `min` or `max`,
+   * they will be ignored.
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isArray(value, rule = {}, name = "value") {
     this._error = null;
 
     if (!rule.required && !this.isSpecified(value)) {
@@ -333,26 +352,36 @@ class ParameterChecker {
 
     if (!Array.isArray(value)) {
       this._error = {
-        code: 'TYPE_INVALID',
-        message: 'The value must be an array.'
+        code: "TYPE_INVALID",
+        message: "The value must be an array.",
       };
       return false;
     }
 
-    if (typeof (rule.min) === 'number') {
+    if (typeof rule.min === "number") {
       if (value.length < rule.min) {
         this._error = {
-          code: 'LENGTH_UNDERFLOW',
-          message: 'The number of characters in the `' + name + '` must be grater than or equal to ' + rule.min + '.'
+          code: "LENGTH_UNDERFLOW",
+          message:
+            "The number of characters in the `" +
+            name +
+            "` must be grater than or equal to " +
+            rule.min +
+            ".",
         };
         return false;
       }
     }
-    if (typeof (rule.max) === 'number') {
+    if (typeof rule.max === "number") {
       if (value.length > rule.max) {
         this._error = {
-          code: 'LENGTH_OVERFLOW',
-          message: 'The number of characters in the `' + name + '` must be less than or equal to ' + rule.max + '.'
+          code: "LENGTH_OVERFLOW",
+          message:
+            "The number of characters in the `" +
+            name +
+            "` must be less than or equal to " +
+            rule.max +
+            ".",
         };
         return false;
       }
@@ -362,78 +391,102 @@ class ParameterChecker {
   }
 
   /* ------------------------------------------------------------------
-  * isString(value, rule, name)
-  * - Check if the value is an `Array` object
-  *
-  * [Arguments]
-  * - value      | Any     | Required | The value you want to check
-  * - rule       | Object  | Optional |
-  *   - required | Boolean | Optional | Required or not. Default is `false`.
-  *   - min      | Integer | Optional | Minimum number of characters in the string
-  *   - max      | Integer | Optional | Maximum number of characters in the string
-  *   - minBytes | Integer | Optional | Minimum bytes of the string (UTF-8)
-  *   - maxBytes | Integer | Optional | Maximum bytes of the string (UTF-8)
-  *   - pattern  | RegExp  | Optional | Pattern of the string
-  *   - enum     | Array   | Optional | list of possible values
-  * - name       | String  | Optional | Parameter name
-  *
-  * If non-number value is specified to the `min` or `max`,
-  * they will be ignored. 
-  *
-  * [Return value]
-  * - If the value is valid, this method will return `true`.
-  * - If the value is invalid, this method will return `false` and
-  *   an `Error` object will be set to `this._error`.
-  * ---------------------------------------------------------------- */
-  isString(value, rule = {}, name = 'value') {
+   * isString(value, rule, name)
+   * - Check if the value is an `Array` object
+   *
+   * [Arguments]
+   * - value      | Any     | Required | The value you want to check
+   * - rule       | Object  | Optional |
+   *   - required | Boolean | Optional | Required or not. Default is `false`.
+   *   - min      | Integer | Optional | Minimum number of characters in the string
+   *   - max      | Integer | Optional | Maximum number of characters in the string
+   *   - minBytes | Integer | Optional | Minimum bytes of the string (UTF-8)
+   *   - maxBytes | Integer | Optional | Maximum bytes of the string (UTF-8)
+   *   - pattern  | RegExp  | Optional | Pattern of the string
+   *   - enum     | Array   | Optional | list of possible values
+   * - name       | String  | Optional | Parameter name
+   *
+   * If non-number value is specified to the `min` or `max`,
+   * they will be ignored.
+   *
+   * [Return value]
+   * - If the value is valid, this method will return `true`.
+   * - If the value is invalid, this method will return `false` and
+   *   an `Error` object will be set to `this._error`.
+   * ---------------------------------------------------------------- */
+  isString(value, rule = {}, name = "value") {
     this._error = null;
 
     if (!rule.required && !this.isSpecified(value)) {
       return true;
     }
 
-    if (typeof (value) !== 'string') {
+    if (typeof value !== "string") {
       this._error = {
-        code: 'TYPE_INVALID',
-        message: 'The value must be a string.'
+        code: "TYPE_INVALID",
+        message: "The value must be a string.",
       };
       return false;
     }
 
-    if (typeof (rule.min) === 'number') {
+    if (typeof rule.min === "number") {
       if (value.length < rule.min) {
         this._error = {
-          code: 'LENGTH_UNDERFLOW',
-          message: 'The number of characters in the `' + name + '` must be grater than or equal to ' + rule.min + '.'
+          code: "LENGTH_UNDERFLOW",
+          message:
+            "The number of characters in the `" +
+            name +
+            "` must be grater than or equal to " +
+            rule.min +
+            ".",
         };
         return false;
       }
     }
-    if (typeof (rule.max) === 'number') {
+    if (typeof rule.max === "number") {
       if (value.length > rule.max) {
         this._error = {
-          code: 'LENGTH_OVERFLOW',
-          message: 'The number of characters in the `' + name + '` must be less than or equal to ' + rule.max + '.'
+          code: "LENGTH_OVERFLOW",
+          message:
+            "The number of characters in the `" +
+            name +
+            "` must be less than or equal to " +
+            rule.max +
+            ".",
         };
         return false;
       }
     }
-    if (typeof (rule.minBytes) === 'number') {
-      let blen = Buffer.from(value, 'utf8').length;
+    if (typeof rule.minBytes === "number") {
+      let blen = Buffer.from(value, "utf8").length;
       if (blen < rule.minBytes) {
         this._error = {
-          code: 'LENGTH_UNDERFLOW',
-          message: 'The byte length of the `' + name + '` (' + blen + ' bytes) must be grater than or equal to ' + rule.minBytes + ' bytes.'
+          code: "LENGTH_UNDERFLOW",
+          message:
+            "The byte length of the `" +
+            name +
+            "` (" +
+            blen +
+            " bytes) must be grater than or equal to " +
+            rule.minBytes +
+            " bytes.",
         };
         return false;
       }
     }
-    if (typeof (rule.maxBytes) === 'number') {
-      let blen = Buffer.from(value, 'utf8').length;
+    if (typeof rule.maxBytes === "number") {
+      let blen = Buffer.from(value, "utf8").length;
       if (blen > rule.maxBytes) {
         this._error = {
-          code: 'LENGTH_OVERFLOW',
-          message: 'The byte length of the `' + name + '` (' + blen + ' bytes) must be less than or equal to ' + rule.maxBytes + ' bytes.'
+          code: "LENGTH_OVERFLOW",
+          message:
+            "The byte length of the `" +
+            name +
+            "` (" +
+            blen +
+            " bytes) must be less than or equal to " +
+            rule.maxBytes +
+            " bytes.",
         };
         return false;
       }
@@ -441,8 +494,8 @@ class ParameterChecker {
     if (rule.pattern instanceof RegExp) {
       if (!rule.pattern.test(v)) {
         this._error = {
-          code: 'PATTERN_UNMATCH',
-          message: 'The `' + name + '` does not conform with the pattern.'
+          code: "PATTERN_UNMATCH",
+          message: "The `" + name + "` does not conform with the pattern.",
         };
         return false;
       }
@@ -450,8 +503,13 @@ class ParameterChecker {
     if (Array.isArray(rule.enum) && rule.enum.length > 0) {
       if (rule.enum.indexOf(value) === -1) {
         this._error = {
-          code: 'ENUM_UNMATCH',
-          message: 'The `' + name + '` must be any one of ' + JSON.stringify(rule.enum) + '.'
+          code: "ENUM_UNMATCH",
+          message:
+            "The `" +
+            name +
+            "` must be any one of " +
+            JSON.stringify(rule.enum) +
+            ".",
         };
         return false;
       }