@wiotp/sdk 0.4.2 → 0.6.2

package/dist/util.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isString = isString;
+exports.isNumber = isNumber;
+exports.isBoolean = isBoolean;
+exports.isDefined = isDefined;
+exports.generateUUID = generateUUID;
+exports.isNode = exports.isBrowser = void 0;
+
+/**
+ *****************************************************************************
+ Copyright (c) 2014, 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+function isString(value) {
+  return typeof value === 'string';
+}
+
+function isNumber(value) {
+  return typeof value === 'number';
+}
+
+function isBoolean(value) {
+  return typeof value === 'boolean';
+}
+
+function isDefined(value) {
+  return value !== undefined && value !== null;
+}
+
+var isBrowser = new Function("try {return this===window;}catch(e){ return false;}");
+exports.isBrowser = isBrowser;
+var isNode = new Function("try {return this===global;}catch(e){return false;}");
+exports.isNode = isNode;
+
+function generateUUID() {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+    var r = Math.random() * 16 | 0,
+        v = c == 'x' ? r : r & 0x3 | 0x8;
+    return v.toString(16);
+  });
+}

package/package.json

@@ -1,84 +1,92 @@
-{
-  "name": "@wiotp/sdk",
-  "version": "0.4.2",
-  "description": "SDK for developing device, gateway, and application clients for IBM Watson IoT Platform",
-  "main": "index.js",
-  "files": [
-    "src",
-    "index.js",
-    "package.json",
-    "README.md",
-    "LICENCE"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "axios": "^0.19.0",
-    "bluebird": "^3.5.4",
-    "btoa": "^1.2.1",
-    "concat-stream": "^2.0.0",
-    "events": "^3.0.0",
-    "form-data": "^2.3.3",
-    "format": "^0.2.2",
-    "loglevel": "^1.6.1",
-    "mqtt": "^2.18.8",
-    "tinycache": "^1.1.2",
-    "uuid": "^3.3.2",
-    "yaml": "^1.6.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "7.4.4",
-    "@babel/core": "7.4.4",
-    "@babel/preset-env": "7.4.4",
-    "@babel/register": "7.4.4",
-    "@cloudant/cloudant": "2.1.0",
-    "@istanbuljs/nyc-config-babel": "^2.1.1",
-    "babel-plugin-istanbul": "^5.1.4",
-    "chai": "4.2.0",
-    "chai-as-promised": "7.1.1",
-    "coveralls": "3.0.3",
-    "mocha": "6.1.4",
-    "mocha-steps": "^1.3.0",
-    "nyc": "14.1.1",
-    "rimraf": "2.6.3"
-  },
-  "scripts": {
-    "clean": "rimraf dist/*",
-    "build:commonjs": "babel src --out-dir dist --modules umd",
-    "build": "npm run clean && npm run build:commonjs",
-    "test": "mocha --require @babel/register --require mocha-steps",
-    "test-cov": "nyc --reporter=lcov --reporter=text-summary mocha --require mocha-steps",
-    "test:watch": "mocha --require @babel/register --require mocha-steps --watch"
-  },
-  "author": {
-    "name": "David Parker",
-    "email": "parkerda@uk.ibm.com"
-  },
-  "contributors": [
-    {
-      "name": "Bryan Boyd",
-      "email": "bboyd@us.ibm.com"
-    }
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ibm-watson-iot/iot-nodejs.git"
-  },
-  "license": "EPL-1.0",
-  "nyc": {
-    "require": [
-      "@babel/register"
-    ],
-    "all": true,
-    "include": [
-      "src/**/*.js"
-    ],
-    "reporter": [
-      "lcov",
-      "text"
-    ],
-    "sourceMap": false,
-    "instrument": false
-  }
-}
+{
+  "name": "@wiotp/sdk",
+  "version": "0.6.2",
+  "description": "SDK for developing device, gateway, and application clients for IBM Watson IoT Platform",
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "LICENCE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^0.19.0",
+    "bluebird": "^3.5.4",
+    "browserify": "^16.5.0",
+    "btoa": "^1.2.1",
+    "concat-stream": "^2.0.0",
+    "events": "^3.0.0",
+    "form-data": "^2.3.3",
+    "format": "^0.2.2",
+    "loglevel": "^1.6.1",
+    "mqtt": "^3.0.0",
+    "tinycache": "^1.1.2",
+    "uuid": "^3.3.2",
+    "yaml": "^1.7.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.7.7",
+    "@babel/core": "7.7.7",
+    "@babel/preset-env": "7.7.7",
+    "@babel/register": "7.7.7",
+    "@cloudant/cloudant": "^2.1.0",
+    "@istanbuljs/nyc-config-babel": "^3.0.0",
+    "babel-plugin-istanbul": "^6.0.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "coveralls": "3.0.9",
+    "mocha": "6.2.2",
+    "mocha-steps": "^1.3.0",
+    "nyc": "15.0.0",
+    "rimraf": "2.6.3",
+    "terser": "^4.4.3"
+  },
+  "scripts": {
+    "clean": "rimraf dist/*",
+    "build": "npm run clean && npm run build:commonjs && npm run build:bundle && npm run build:min",
+    "build:commonjs": "babel src --out-dir dist",
+    "build:bundle": "browserify dist/index.js --outfile dist/bundled/wiotp-bundle.js",
+    "build:min": "terser dist/bundled/wiotp-bundle.js -o dist/bundled/wiotp-bundle.min.js",
+    "test": "mocha --require @babel/register --require mocha-steps",
+    "test-cov": "nyc --reporter=lcov --reporter=text-summary mocha --require mocha-steps",
+    "test:watch": "mocha --require @babel/register --require mocha-steps --watch"
+  },
+  "author": {
+    "name": "David Parker",
+    "email": "parkerda@uk.ibm.com"
+  },
+  "contributors": [
+    {
+      "name": "Tom Klapiscak",
+      "email": "klapitom@uk.ibm.com"
+    },
+    {
+      "name": "Bryan Boyd",
+      "email": "bboyd@us.ibm.com"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ibm-watson-iot/iot-nodejs.git"
+  },
+  "license": "EPL-1.0",
+  "nyc": {
+    "require": [
+      "@babel/register"
+    ],
+    "all": true,
+    "include": [
+      "src/**/*.js"
+    ],
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "sourceMap": false,
+    "instrument": true
+  }
+}

package/src/BaseClient.js

@@ -1,215 +1,215 @@
-/**
- *****************************************************************************
- Copyright (c) 2014, 2019 IBM Corporation and other Contributors.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- *****************************************************************************
- *
- */
-import events from 'events';
-import mqtt from 'mqtt';
-import log from 'loglevel';
-
-import TinyCache from 'tinycache';
-
-const uuidv4 = require('uuid/v4');
-
-export default class BaseClient extends events.EventEmitter {
-  constructor(config){
-    super();
-    this.log = log;
-    this.log.setDefaultLevel(config.options.logLevel);
-
-    this.config = config;
-
-    this.reconnectLog = 0;
-    this.mqtt = null;
-
-    this.lostConnectionLog = new TinyCache();
-
-  }
-
-
-  isConnected() {
-    if (this.mqtt == null) {
-      return false;
-    }
-    return this.mqtt.connected;
-  }
-
-
-  connect(){
-    if(this.mqtt != null) {
-      this.log.info("[BaseClient:connect] Reconnecting to " + this.config.getMqttHost() + " as " + this.config.getClientId());
-      this.mqtt.reconnect();
-      return;
-    }
-
-    this.log.info("[BaseClient:connect] Connecting to " + this.config.getMqttHost() + " as " + this.config.getClientId());
-
-    this.mqtt = mqtt.connect(this.config.getMqttHost(), this.config.getMqttConfig());
-
-    /* Events coming from mqtt
-     * Event 'connect' - Emitted on successful (re)connection (i.e. connack rc=0).
-     * Event 'reconnect' - Emitted when a reconnect starts.
-     * Event 'close' - Emitted after a disconnection.
-     * Event 'offline' - Emitted when the client goes offline.
-     * Event 'error' - Emitted when the client cannot connect (i.e. connack rc != 0) or when a parsing error occurs.
-     * Event 'end' - Emitted when mqtt.Client#end() is called. If a callback was passed to mqtt.Client#end(), this event is emitted once the callback returns.
-     * Event 'message' - Emitted when the client receives a publish packet
-     * Event 'packetsend' - Emitted when the client sends any packet. This includes .published() packets as well as packets used by MQTT for managing subscriptions and connections
-     * Event 'packetreceive' - Emitted when the client receives any packet. This includes packets from subscribed topics as well as packets used by MQTT for managing subscriptions and connections
-     */
-
-    this.mqtt.on('connect', () => {
-      this.log.info("[BaseClient:onConnect] MQTT client is connected.");
-      this.emit('connect');
-
-      // less than 3 connect attempts you get put to a connect delay of 1 second
-      // after 3 connect attempts you get put to a connect delay of 2 seconds (3 seconds elapsed - 3 attempts @ 1 second intervals)
-      // after 6 connect attempts you get put to a connect delay of 5 seconds (3 + 6 seconds elapsed - 3 attempts @ 2 second intervals)
-      // after 9 connect attempts you get put to a connect delay of 20 seconds (3 + 6 + 15 seconds elapsed - 3 attempts @ 5 second intervals)
-      let connectionLostCount = this.lostConnectionLog.size;
-
-      // Default is 1 second reconnect period
-      let reconnectPeriod = 1000;
-      if (connectionLostCount >= 9) {
-        reconnectPeriod = 20000;
-
-        // Log this and raise the error EVERY time we reconnect under these conditions.
-        this.log.warn("[BaseClient:onOffline] This client is likely suffering from clientId stealing (where two connections try to use the same client Id).");
-        this.emit("error", "Exceeded 9 connection losses in a 5 minute period.  Check for clientId conflict with another connection.")
-      }
-      else if (connectionLostCount >= 6) {
-        reconnectPeriod = 5000;
-      }
-      else if (connectionLostCount >= 3) {
-        reconnectPeriod = 2000;
-      }
-
-      if (reconnectPeriod != this.mqtt.options.reconnectPeriod) {
-        this.log.info("[BaseClient:onOffline] Client has lost connection " + connectionLostCount + " times during the last 5 minutes, reconnect delay adjusted to " + reconnectPeriod + " ms");
-        this.mqtt.options.reconnectPeriod = reconnectPeriod;
-      }
-  
-    });
-
-    this.mqtt.on('reconnect', () => {
-      this.log.info("[BaseClient:onReconnect] MQTT client is reconnecting.");
-      // this.log.debug("[BaseClient:onReconnect] Resubscribe topics:");
-      // this.log.debug(this.mqtt._resubscribeTopics);
-      this.emit('reconnect');
-    });
-
-    this.mqtt.on('close', () => {
-      this.log.info("[BaseClient:onClose] MQTT client connection was closed.");
-      this.emit('close');
-    });
-
-    this.mqtt.on('offline', () => {
-      let newId = uuidv4();
-      this.log.info("[BaseClient:onOffline] MQTT client connection is offline. [" + newId + "]");
-      this.emit('offline');
-      // Record the disconnect event for 5 minutes
-      this.lostConnectionLog.put( newId, '1', 300000 );
-
-      let connectionLostCount = this.lostConnectionLog.size;
-      this.log.info("[BaseClient:onOffline] Connection losses in the last 5 minutes: " + connectionLostCount);
-
-    });
-
-    this.mqtt.on('error', (error) => {
-      this.log.error("[BaseClient:onError] " + error);
-      
-      let errorMsg = '' + error;
-      if (errorMsg.indexOf('Not authorized') > -1) {
-        this.log.error("[BaseClient:onError] One or more configuration parameters are wrong. Modify the configuration before trying to reconnect.");
-        this.mqtt.end(false, () => {
-          this.log.info("[BaseClient:onError] Closed the MQTT connection due to client misconfiguration");
-        });
-      }
-      this.emit('error', error);
-    });
-  }
-
-
-  disconnect(){
-    if(this.mqtt == null) {
-      this.log.info("[BaseClient:disconnect] Client was never connected");
-      return;
-    }
-
-    this.mqtt.end(false, () => {
-      this.log.info("[BaseClient:disconnect] Closed the MQTT connection due to disconnect() call");
-    });
-  }
-
-
-  _subscribe(topic, QoS, callback) {
-    if (this.mqtt == null) {
-      this.emit('error', "[BaseClient:_subscribe] MQTT Client is not initialized - call connect() first");
-      return;
-    }
-    if (!this.mqtt.connected) {
-      this.emit('error', "[BaseClient:_subscribe] MQTT Client is not connected - call connect() first");
-      return;
-    }
-
-    QoS = QoS || 0;
-    callback = callback || function (err, granted) {
-      if (err == null) {
-        for (var index in granted) {
-          let grant = granted[index];
-          this.log.debug("[BaseClient:_subscribe] Subscribed to " + grant.topic + " at QoS " + grant.qos);
-        }
-      } else {
-        this.log.error("[BaseClient:_subscribe] " + err);
-        this.emit("error", err);
-      }
-    }.bind(this);
-
-    this.log.debug("[BaseClient:_subscribe] Subscribing to topic " + topic + " with QoS " + QoS);
-    this.mqtt.subscribe(topic, { qos: parseInt(QoS) }, callback);
-  }
-
-
-  _unsubscribe(topic, callback) {
-    if (this.mqtt == null) {
-      this.emit('error', "[BaseClient:_unsubscribe] MQTT Client is not initialized - call connect() first");
-      return;
-    }
-    if (!this.mqtt.connected) {
-      this.emit('error', "[BaseClient:_unsubscribe] MQTT Client is not connected - call connect() first");
-      return;
-    }
-
-    callback = callback || function (err) {
-      if (err == null) {
-        this.log.debug("[BaseClient:_unsubscribe] Unsubscribed from: " + topic);
-      } else {
-        this.log.error("[BaseClient:_unsubscribe] " + err);
-        this.emit("error", err);
-      } 
-    }.bind(this);
-
-    this.log.debug("[BaseClient:_unsubscribe] Unsubscribe: " + topic);
-    this.mqtt.unsubscribe(topic, callback);
-  }
-
-
-  _publish(topic, msg, QoS, callback) {
-    QoS = QoS || 0;
-
-    if ((typeof msg === 'object' || typeof msg === 'boolean' || typeof msg === 'number') && !Buffer.isBuffer(msg)) {
-      // mqtt library does not support sending JSON/Boolean/Number data. So stringifying it.
-      // All JSON object, array will be encoded.
-      msg = JSON.stringify(msg);
-    }
-
-    this.log.debug("[BaseClient:_publish] Publish: " + topic + ", " + msg + ", QoS : " + QoS);
-    this.mqtt.publish(topic, msg, { qos: parseInt(QoS) }, callback);
-  }
-
-}
+/**
+ *****************************************************************************
+ Copyright (c) 2014, 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+import events from 'events';
+import mqtt from 'mqtt';
+import log from 'loglevel';
+
+import TinyCache from 'tinycache';
+
+const uuidv4 = require('uuid/v4');
+
+export default class BaseClient extends events.EventEmitter {
+  constructor(config){
+    super();
+    this.log = log;
+    this.log.setDefaultLevel(config.options.logLevel);
+
+    this.config = config;
+
+    this.reconnectLog = 0;
+    this.mqtt = null;
+
+    this.lostConnectionLog = new TinyCache();
+
+  }
+
+
+  isConnected() {
+    if (this.mqtt == null) {
+      return false;
+    }
+    return this.mqtt.connected;
+  }
+
+
+  connect(){
+    if(this.mqtt != null) {
+      this.log.info("[BaseClient:connect] Reconnecting to " + this.config.getMqttHost() + " as " + this.config.getClientId());
+      this.mqtt.reconnect();
+      return;
+    }
+
+    this.log.info("[BaseClient:connect] Connecting to " + this.config.getMqttHost() + " as " + this.config.getClientId());
+
+    this.mqtt = mqtt.connect(this.config.getMqttHost(), this.config.getMqttConfig());
+
+    /* Events coming from mqtt
+     * Event 'connect' - Emitted on successful (re)connection (i.e. connack rc=0).
+     * Event 'reconnect' - Emitted when a reconnect starts.
+     * Event 'close' - Emitted after a disconnection.
+     * Event 'offline' - Emitted when the client goes offline.
+     * Event 'error' - Emitted when the client cannot connect (i.e. connack rc != 0) or when a parsing error occurs.
+     * Event 'end' - Emitted when mqtt.Client#end() is called. If a callback was passed to mqtt.Client#end(), this event is emitted once the callback returns.
+     * Event 'message' - Emitted when the client receives a publish packet
+     * Event 'packetsend' - Emitted when the client sends any packet. This includes .published() packets as well as packets used by MQTT for managing subscriptions and connections
+     * Event 'packetreceive' - Emitted when the client receives any packet. This includes packets from subscribed topics as well as packets used by MQTT for managing subscriptions and connections
+     */
+
+    this.mqtt.on('connect', () => {
+      this.log.info("[BaseClient:onConnect] MQTT client is connected.");
+      this.emit('connect');
+
+      // less than 3 connect attempts you get put to a connect delay of 1 second
+      // after 3 connect attempts you get put to a connect delay of 2 seconds (3 seconds elapsed - 3 attempts @ 1 second intervals)
+      // after 6 connect attempts you get put to a connect delay of 5 seconds (3 + 6 seconds elapsed - 3 attempts @ 2 second intervals)
+      // after 9 connect attempts you get put to a connect delay of 20 seconds (3 + 6 + 15 seconds elapsed - 3 attempts @ 5 second intervals)
+      let connectionLostCount = this.lostConnectionLog.size;
+
+      // Default is 1 second reconnect period
+      let reconnectPeriod = 1000;
+      if (connectionLostCount >= 9) {
+        reconnectPeriod = 20000;
+
+        // Log this and raise the error EVERY time we reconnect under these conditions.
+        this.log.warn("[BaseClient:onOffline] This client is likely suffering from clientId stealing (where two connections try to use the same client Id).");
+        this.emit("error", "Exceeded 9 connection losses in a 5 minute period.  Check for clientId conflict with another connection.")
+      }
+      else if (connectionLostCount >= 6) {
+        reconnectPeriod = 5000;
+      }
+      else if (connectionLostCount >= 3) {
+        reconnectPeriod = 2000;
+      }
+
+      if (reconnectPeriod != this.mqtt.options.reconnectPeriod) {
+        this.log.info("[BaseClient:onOffline] Client has lost connection " + connectionLostCount + " times during the last 5 minutes, reconnect delay adjusted to " + reconnectPeriod + " ms");
+        this.mqtt.options.reconnectPeriod = reconnectPeriod;
+      }
+  
+    });
+
+    this.mqtt.on('reconnect', () => {
+      this.log.info("[BaseClient:onReconnect] MQTT client is reconnecting.");
+      // this.log.debug("[BaseClient:onReconnect] Resubscribe topics:");
+      // this.log.debug(this.mqtt._resubscribeTopics);
+      this.emit('reconnect');
+    });
+
+    this.mqtt.on('close', () => {
+      this.log.info("[BaseClient:onClose] MQTT client connection was closed.");
+      this.emit('close');
+    });
+
+    this.mqtt.on('offline', () => {
+      let newId = uuidv4();
+      this.log.info("[BaseClient:onOffline] MQTT client connection is offline. [" + newId + "]");
+      this.emit('offline');
+      // Record the disconnect event for 5 minutes
+      this.lostConnectionLog.put( newId, '1', 300000 );
+
+      let connectionLostCount = this.lostConnectionLog.size;
+      this.log.info("[BaseClient:onOffline] Connection losses in the last 5 minutes: " + connectionLostCount);
+
+    });
+
+    this.mqtt.on('error', (error) => {
+      this.log.error("[BaseClient:onError] " + error);
+      
+      let errorMsg = '' + error;
+      if (errorMsg.indexOf('Not authorized') > -1) {
+        this.log.error("[BaseClient:onError] One or more configuration parameters are wrong. Modify the configuration before trying to reconnect.");
+        this.mqtt.end(false, () => {
+          this.log.info("[BaseClient:onError] Closed the MQTT connection due to client misconfiguration");
+        });
+      }
+      this.emit('error', error);
+    });
+  }
+
+
+  disconnect(){
+    if(this.mqtt == null) {
+      this.log.info("[BaseClient:disconnect] Client was never connected");
+      return;
+    }
+
+    this.mqtt.end(false, () => {
+      this.log.info("[BaseClient:disconnect] Closed the MQTT connection due to disconnect() call");
+    });
+  }
+
+
+  _subscribe(topic, QoS, callback) {
+    if (this.mqtt == null) {
+      this.emit('error', "[BaseClient:_subscribe] MQTT Client is not initialized - call connect() first");
+      return;
+    }
+    if (!this.mqtt.connected) {
+      this.emit('error', "[BaseClient:_subscribe] MQTT Client is not connected - call connect() first");
+      return;
+    }
+
+    QoS = QoS || 0;
+    callback = callback || function (err, granted) {
+      if (err == null) {
+        for (var index in granted) {
+          let grant = granted[index];
+          this.log.debug("[BaseClient:_subscribe] Subscribed to " + grant.topic + " at QoS " + grant.qos);
+        }
+      } else {
+        this.log.error("[BaseClient:_subscribe] " + err);
+        this.emit("error", err);
+      }
+    }.bind(this);
+
+    this.log.debug("[BaseClient:_subscribe] Subscribing to topic " + topic + " with QoS " + QoS);
+    this.mqtt.subscribe(topic, { qos: parseInt(QoS) }, callback);
+  }
+
+
+  _unsubscribe(topic, callback) {
+    if (this.mqtt == null) {
+      this.emit('error', "[BaseClient:_unsubscribe] MQTT Client is not initialized - call connect() first");
+      return;
+    }
+    if (!this.mqtt.connected) {
+      this.emit('error', "[BaseClient:_unsubscribe] MQTT Client is not connected - call connect() first");
+      return;
+    }
+
+    callback = callback || function (err) {
+      if (err == null) {
+        this.log.debug("[BaseClient:_unsubscribe] Unsubscribed from: " + topic);
+      } else {
+        this.log.error("[BaseClient:_unsubscribe] " + err);
+        this.emit("error", err);
+      } 
+    }.bind(this);
+
+    this.log.debug("[BaseClient:_unsubscribe] Unsubscribe: " + topic);
+    this.mqtt.unsubscribe(topic, callback);
+  }
+
+
+  _publish(topic, msg, QoS, callback) {
+    QoS = QoS || 0;
+
+    if ((typeof msg === 'object' || typeof msg === 'boolean' || typeof msg === 'number') && !Buffer.isBuffer(msg)) {
+      // mqtt library does not support sending JSON/Boolean/Number data. So stringifying it.
+      // All JSON object, array will be encoded.
+      msg = JSON.stringify(msg);
+    }
+
+    this.log.debug("[BaseClient:_publish] Publish: " + topic + ", " + msg + ", QoS : " + QoS);
+    this.mqtt.publish(topic, msg, { qos: parseInt(QoS) }, callback);
+  }
+
+}