@wiotp/sdk 0.8.4 → 0.8.6

package/dist/api/RegistryClient.js

@@ -0,0 +1,225 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ *****************************************************************************
+ 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
+ *****************************************************************************
+ *
+ */
+var RegistryClient = exports["default"] = /*#__PURE__*/function () {
+  function RegistryClient(apiClient) {
+    _classCallCheck(this, RegistryClient);
+    this.apiClient = apiClient;
+  }
+  return _createClass(RegistryClient, [{
+    key: "listAllDevicesOfType",
+    value: function listAllDevicesOfType(type) {
+      this.apiClient.log.debug("[ApiClient] listAllDevicesOfType(" + type + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices'], null);
+    }
+  }, {
+    key: "deleteDeviceType",
+    value: function deleteDeviceType(type) {
+      this.apiClient.log.debug("[ApiClient] deleteDeviceType(" + type + ")");
+      return this.apiClient.callApi('DELETE', 204, false, ['device', 'types', type], null);
+    }
+  }, {
+    key: "getDeviceType",
+    value: function getDeviceType(type) {
+      this.apiClient.log.debug("[ApiClient] getDeviceType(" + type + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type], null);
+    }
+  }, {
+    key: "getAllDeviceTypes",
+    value: function getAllDeviceTypes() {
+      this.apiClient.log.debug("[ApiClient] getAllDeviceTypes()");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types'], null);
+    }
+  }, {
+    key: "updateDeviceType",
+    value: function updateDeviceType(type, description, deviceInfo, metadata) {
+      this.apiClient.log.debug("[ApiClient] updateDeviceType(" + type + ", " + description + ", " + deviceInfo + ", " + metadata + ")");
+      var body = {
+        deviceInfo: deviceInfo,
+        description: description,
+        metadata: metadata
+      };
+      return this.apiClient.callApi('PUT', 200, true, ['device', 'types', type], JSON.stringify(body));
+    }
+  }, {
+    key: "registerDeviceType",
+    value: function registerDeviceType(typeId, description, deviceInfo, metadata, classId) {
+      this.apiClient.log.debug("[ApiClient] registerDeviceType(" + typeId + ", " + description + ", " + deviceInfo + ", " + metadata + ", " + classId + ")");
+      // TODO: field validation
+      classId = classId || "Device";
+      var body = {
+        id: typeId,
+        classId: classId,
+        deviceInfo: deviceInfo,
+        description: description,
+        metadata: metadata
+      };
+      return this.apiClient.callApi('POST', 201, true, ['device', 'types'], JSON.stringify(body));
+    }
+  }, {
+    key: "registerDevice",
+    value: function registerDevice(type, deviceId, authToken, deviceInfo, location, metadata) {
+      this.apiClient.log.debug("[ApiClient] registerDevice(" + type + ", " + deviceId + ", " + deviceInfo + ", " + location + ", " + metadata + ")");
+      // TODO: field validation
+      var body = {
+        deviceId: deviceId,
+        authToken: authToken,
+        deviceInfo: deviceInfo,
+        location: location,
+        metadata: metadata
+      };
+      return this.apiClient.callApi('POST', 201, true, ['device', 'types', type, 'devices'], JSON.stringify(body));
+    }
+  }, {
+    key: "unregisterDevice",
+    value: function unregisterDevice(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] unregisterDevice(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('DELETE', 204, false, ['device', 'types', type, 'devices', deviceId], null);
+    }
+  }, {
+    key: "updateDevice",
+    value: function updateDevice(type, deviceId, deviceInfo, status, metadata, extensions) {
+      this.apiClient.log.debug("[ApiClient] updateDevice(" + type + ", " + deviceId + ", " + deviceInfo + ", " + status + ", " + metadata + ")");
+      var body = {
+        deviceInfo: deviceInfo,
+        status: status,
+        metadata: metadata,
+        extensions: extensions
+      };
+      return this.apiClient.callApi('PUT', 200, true, ['device', 'types', type, 'devices', deviceId], JSON.stringify(body));
+    }
+  }, {
+    key: "getDevice",
+    value: function getDevice(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getDevice(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId], null);
+    }
+
+    /**
+    * Register multiple new devices, each request can contain a maximum of 512KB.
+    * The response body will contain the generated authentication tokens for all devices.
+    * The caller of the method must make sure to record these tokens when processing
+    * the response. The IBM Watson IoT Platform will not be able to retrieve lost authentication tokens
+    *
+    * @param arryOfDevicesToBeAdded Array of JSON devices to be added. Refer to
+    * <a href="https://docs.internetofthings.ibmcloud.com/swagger/v0002.html#!/Bulk_Operations/post_bulk_devices_add">link</a>
+    * for more information about the schema to be used
+    */
+  }, {
+    key: "registerMultipleDevices",
+    value: function registerMultipleDevices(arryOfDevicesToBeAdded) {
+      this.apiClient.log.debug("[ApiClient] arryOfDevicesToBeAdded() - BULK");
+      return this.apiClient.callApi('POST', 201, true, ["bulk", "devices", "add"], JSON.stringify(arryOfDevicesToBeAdded));
+    }
+
+    /**
+    * Delete multiple devices, each request can contain a maximum of 512Kb
+    *
+    * @param arryOfDevicesToBeDeleted Array of JSON devices to be deleted. Refer to
+    * <a href="https://docs.internetofthings.ibmcloud.com/swagger/v0002.html#!/Bulk_Operations/post_bulk_devices_remove">link</a>
+    * for more information about the schema to be used.
+    */
+  }, {
+    key: "deleteMultipleDevices",
+    value: function deleteMultipleDevices(arryOfDevicesToBeDeleted) {
+      this.apiClient.log.debug("[ApiClient] deleteMultipleDevices() - BULK");
+      return this.apiClient.callApi('POST', 201, true, ["bulk", "devices", "remove"], JSON.stringify(arryOfDevicesToBeDeleted));
+    }
+  }, {
+    key: "getDeviceLocation",
+    value: function getDeviceLocation(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getDeviceLocation(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId, 'location'], null);
+    }
+  }, {
+    key: "updateDeviceLocation",
+    value: function updateDeviceLocation(type, deviceId, location) {
+      this.apiClient.log.debug("[ApiClient] updateDeviceLocation(" + type + ", " + deviceId + ", " + location + ")");
+      return this.apiClient.callApi('PUT', 200, true, ['device', 'types', type, 'devices', deviceId, 'location'], JSON.stringify(location));
+    }
+  }, {
+    key: "getDeviceManagementInformation",
+    value: function getDeviceManagementInformation(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getDeviceManagementInformation(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId, 'mgmt'], null);
+    }
+  }, {
+    key: "getAllDiagnosticLogs",
+    value: function getAllDiagnosticLogs(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getAllDiagnosticLogs(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId, 'diag', 'logs'], null);
+    }
+  }, {
+    key: "clearAllDiagnosticLogs",
+    value: function clearAllDiagnosticLogs(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] clearAllDiagnosticLogs(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('DELETE', 204, false, ['device', 'types', type, 'devices', deviceId, 'diag', 'logs'], null);
+    }
+  }, {
+    key: "addDeviceDiagLogs",
+    value: function addDeviceDiagLogs(type, deviceId, log) {
+      this.apiClient.log.debug("[ApiClient] addDeviceDiagLogs(" + type + ", " + deviceId + ", " + log + ")");
+      return this.apiClient.callApi('POST', 201, false, ['device', 'types', type, 'devices', deviceId, 'diag', 'logs'], JSON.stringify(log));
+    }
+  }, {
+    key: "getDiagnosticLog",
+    value: function getDiagnosticLog(type, deviceId, logId) {
+      this.apiClient.log.debug("[ApiClient] getAllDiagnosticLogs(" + type + ", " + deviceId + ", " + logId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId, 'diag', 'logs', logId], null);
+    }
+  }, {
+    key: "deleteDiagnosticLog",
+    value: function deleteDiagnosticLog(type, deviceId, logId) {
+      this.apiClient.log.debug("[ApiClient] deleteDiagnosticLog(" + type + ", " + deviceId + ", " + logId + ")");
+      return this.apiClient.callApi('DELETE', 204, false, ['device', 'types', type, 'devices', deviceId, 'diag', 'logs', logId], null);
+    }
+  }, {
+    key: "getDeviceErrorCodes",
+    value: function getDeviceErrorCodes(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getDeviceErrorCodes(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('GET', 200, true, ['device', 'types', type, 'devices', deviceId, 'diag', 'errorCodes'], null);
+    }
+  }, {
+    key: "clearDeviceErrorCodes",
+    value: function clearDeviceErrorCodes(type, deviceId) {
+      this.apiClient.log.debug("[ApiClient] clearDeviceErrorCodes(" + type + ", " + deviceId + ")");
+      return this.apiClient.callApi('DELETE', 204, false, ['device', 'types', type, 'devices', deviceId, 'diag', 'errorCodes'], null);
+    }
+  }, {
+    key: "addErrorCode",
+    value: function addErrorCode(type, deviceId, log) {
+      this.apiClient.log.debug("[ApiClient] addErrorCode(" + type + ", " + deviceId + ", " + log + ")");
+      return this.apiClient.callApi('POST', 201, false, ['device', 'types', type, 'devices', deviceId, 'diag', 'errorCodes'], JSON.stringify(log));
+    }
+  }, {
+    key: "getDeviceConnectionLogs",
+    value: function getDeviceConnectionLogs(typeId, deviceId) {
+      this.apiClient.log.debug("[ApiClient] getDeviceConnectionLogs(" + typeId + ", " + deviceId + ")");
+      var params = {
+        typeId: typeId,
+        deviceId: deviceId
+      };
+      return this.apiClient.callApi('GET', 200, true, ['logs', 'connection'], null, params);
+    }
+  }]);
+}();
+;

package/dist/api/RulesClient.js

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _loglevel = _interopRequireDefault(require("loglevel"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ *****************************************************************************
+ 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
+ *****************************************************************************
+ *
+ */
+var RulesClient = exports["default"] = /*#__PURE__*/function () {
+  function RulesClient(apiClient) {
+    _classCallCheck(this, RulesClient);
+    this.log = _loglevel["default"];
+    this.apiClient = apiClient;
+
+    // Create an alias to the apiClient's callApi
+    this.callApi = this.apiClient.callApi.bind(this.apiClient);
+  }
+  return _createClass(RulesClient, [{
+    key: "getRulesForLogicalInterface",
+    value: function getRulesForLogicalInterface(logicalInterfaceId) {
+      if (this.draftMode) {
+        return this.getRulesForLogicalInterface(logicalInterfaceId);
+      } else {
+        return this.getActiveRulesForLogicalInterface(logicalInterfaceId);
+      }
+    }
+  }, {
+    key: "getDraftRulesForLogicalInterface",
+    value: function getDraftRulesForLogicalInterface(logicalInterfaceId) {
+      return this.callApi('GET', 200, true, ['draft', 'logicalinterfaces', logicalInterfaceId, 'rules']);
+    }
+  }, {
+    key: "getActiveRulesForLogicalInterface",
+    value: function getActiveRulesForLogicalInterface(logicalInterfaceId) {
+      return this.callApi('GET', 200, true, ['logicalinterfaces', logicalInterfaceId, 'rules']);
+    }
+  }, {
+    key: "createRule",
+    value: function createRule(logicalInterfaceId, name, condition) {
+      var description = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : undefined;
+      var notificationStrategy = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : RulesClient.RuleNotificationStrategy.EVERY_TIME();
+      var body = {
+        name: name,
+        condition: condition,
+        notificationStrategy: notificationStrategy
+      };
+      if (description) body['description'] = description;
+      var base = this.draftMode ? ['draft', 'logicalinterfaces', logicalInterfaceId, 'rules'] : ['logicalinterfaces', logicalInterfaceId, 'rules'];
+      return this.callApi('POST', 201, true, base, JSON.stringify(body));
+    }
+  }, {
+    key: "updateRule",
+    value: function updateRule(rule) {
+      var base = this.draftMode ? ['draft', 'logicalinterfaces', rule.logicalInterfaceId, 'rules', rule.id] : ['logicalinterfaces', rule.logicalInterfaceId, 'rules', rule.id];
+      return this.callApi('PUT', 200, true, base, JSON.stringify(rule));
+    }
+  }, {
+    key: "deleteRule",
+    value: function deleteRule(logicalInterfaceId, ruleId) {
+      var base = this.draftMode ? ['draft', 'logicalinterfaces', logicalInterfaceId, 'rules', ruleId] : ['logicalinterfaces', logicalInterfaceId, 'rules', ruleId];
+      return this.callApi('DELETE', 204, false, base);
+    }
+  }]);
+}();
+RulesClient.RuleNotificationStrategy = {
+  EVERY_TIME: function EVERY_TIME() {
+    return {
+      when: 'every-time'
+    };
+  },
+  BECOMES_TRUE: function BECOMES_TRUE() {
+    return {
+      when: 'becomes-true'
+    };
+  },
+  X_IN_Y: function X_IN_Y(count) {
+    return {
+      when: 'x-in-y',
+      count: count
+    };
+  },
+  PERSISTS: function PERSISTS(count, timePeriod) {
+    return {
+      when: 'persists',
+      count: count,
+      timePeriod: timePeriod
+    };
+  }
+};