@ricado/api-client 2.5.13 → 2.5.15

package/lib/Controllers/RTUController.js

@@ -11,6 +11,8 @@ var _RTUModel = _interopRequireDefault(require("../Models/RTUModel"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
@@ -96,6 +98,104 @@ var RTUController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * Retrieve the Status of an RTU [GET /rtus/{id}/status]
+     * 
+     * @static
+     * @public
+     * @param {number} id The RTU ID
+     * @return {Promise<RTUController.RTUStatusItem>}
+     */
+
+  }, {
+    key: "getOneStatus",
+    value: function getOneStatus(id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/rtus/".concat(id, "/status")).then(function (result) {
+          var resolveValue = function () {
+            var resultObject = {};
+
+            if (_typeof(result) === 'object' && 'id' in result) {
+              resultObject.id = function () {
+                if (typeof result.id !== 'number') {
+                  return Number.isInteger(Number(result.id)) ? Number(result.id) : Math.floor(Number(result.id));
+                }
+
+                return Number.isInteger(result.id) ? result.id : Math.floor(result.id);
+              }();
+            } else {
+              resultObject.id = 0;
+            }
+
+            if (_typeof(result) === 'object' && 'latency' in result) {
+              resultObject.latency = function () {
+                if (result.latency === null) {
+                  return null;
+                }
+
+                if (typeof result.latency !== 'number') {
+                  return Number(result.latency);
+                }
+
+                return result.latency;
+              }();
+            } else {
+              resultObject.latency = null;
+            }
+
+            if (_typeof(result) === 'object' && 'latencyTimestamp' in result) {
+              resultObject.latencyTimestamp = function () {
+                if (result.latencyTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.latencyTimestamp !== 'string') {
+                  return new Date(String(result.latencyTimestamp));
+                }
+
+                return new Date(result.latencyTimestamp);
+              }();
+            } else {
+              resultObject.latencyTimestamp = null;
+            }
+
+            if (_typeof(result) === 'object' && 'lastSeenTimestamp' in result) {
+              resultObject.lastSeenTimestamp = function () {
+                if (result.lastSeenTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.lastSeenTimestamp !== 'string') {
+                  return new Date(String(result.lastSeenTimestamp));
+                }
+
+                return new Date(result.lastSeenTimestamp);
+              }();
+            } else {
+              resultObject.lastSeenTimestamp = null;
+            }
+
+            if (_typeof(result) === 'object' && 'onlineStatus' in result) {
+              resultObject.onlineStatus = function () {
+                if (typeof result.onlineStatus !== 'boolean') {
+                  return Boolean(result.onlineStatus);
+                }
+
+                return result.onlineStatus;
+              }();
+            } else {
+              resultObject.onlineStatus = false;
+            }
+
+            return resultObject;
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * List all RTUs [GET /rtus]
      * 
@@ -147,6 +247,115 @@ var RTUController = /*#__PURE__*/function () {
             return _RTUModel.default.fromJSON(result);
           }();
 
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve the Statuses of all RTUs [GET /rtus/statuses]
+     * 
+     * An Array of Statuses for all RTUs
+     * 
+     * @static
+     * @public
+     * @param {RTUController.GetAllStatusesQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<Array<RTUController.RTUStatusItem>>}
+     */
+
+  }, {
+    key: "getAllStatuses",
+    value: function getAllStatuses() {
+      var queryParameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/rtus/statuses", queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                var resultItemObject = {};
+
+                if (_typeof(resultItem) === 'object' && 'id' in resultItem) {
+                  resultItemObject.id = function () {
+                    if (typeof resultItem.id !== 'number') {
+                      return Number.isInteger(Number(resultItem.id)) ? Number(resultItem.id) : Math.floor(Number(resultItem.id));
+                    }
+
+                    return Number.isInteger(resultItem.id) ? resultItem.id : Math.floor(resultItem.id);
+                  }();
+                } else {
+                  resultItemObject.id = 0;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'latency' in resultItem) {
+                  resultItemObject.latency = function () {
+                    if (resultItem.latency === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.latency !== 'number') {
+                      return Number(resultItem.latency);
+                    }
+
+                    return resultItem.latency;
+                  }();
+                } else {
+                  resultItemObject.latency = null;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'latencyTimestamp' in resultItem) {
+                  resultItemObject.latencyTimestamp = function () {
+                    if (resultItem.latencyTimestamp === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.latencyTimestamp !== 'string') {
+                      return new Date(String(resultItem.latencyTimestamp));
+                    }
+
+                    return new Date(resultItem.latencyTimestamp);
+                  }();
+                } else {
+                  resultItemObject.latencyTimestamp = null;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'lastSeenTimestamp' in resultItem) {
+                  resultItemObject.lastSeenTimestamp = function () {
+                    if (resultItem.lastSeenTimestamp === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.lastSeenTimestamp !== 'string') {
+                      return new Date(String(resultItem.lastSeenTimestamp));
+                    }
+
+                    return new Date(resultItem.lastSeenTimestamp);
+                  }();
+                } else {
+                  resultItemObject.lastSeenTimestamp = null;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'onlineStatus' in resultItem) {
+                  resultItemObject.onlineStatus = function () {
+                    if (typeof resultItem.onlineStatus !== 'boolean') {
+                      return Boolean(resultItem.onlineStatus);
+                    }
+
+                    return resultItem.onlineStatus;
+                  }();
+                } else {
+                  resultItemObject.onlineStatus = false;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
           resolve(resolveValue);
         }).catch(function (error) {
           return reject(error);
@@ -169,6 +378,14 @@ var _default = RTUController;
  * @memberof Controllers
  */
 
+/**
+ * The Optional Query Parameters for the getAllStatuses Function
+ * 
+ * @typedef {Object} RTUController.GetAllStatusesQueryParameters
+ * @property {number[]} [rtuIds] A List of RTU IDs to Filter by
+ * @memberof Controllers
+ */
+
 /**
  * The Create Data for a RTU
  * 
@@ -188,4 +405,16 @@ var _default = RTUController;
  * @memberof Controllers
  */
 
+/**
+ * A **RTUStatusItem** Type
+ * 
+ * @typedef {Object} RTUController.RTUStatusItem
+ * @property {number} id ID of the RTU
+ * @property {?number} latency Round-Trip Latency of the RTU represented in milliseconds
+ * @property {?Date} latencyTimestamp When the Latency was last Updated
+ * @property {?Date} lastSeenTimestamp When the Last Message was Received from the RTU
+ * @property {boolean} onlineStatus Whether the RTU is considered as Online
+ * @memberof Controllers
+ */
+
 exports.default = _default;

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-var version = '2.5.13';
+var version = '2.5.15';
 exports.version = version;

package/lib/WebSocketHelper.js

@@ -76,9 +76,8 @@ var WebSocketHelper = /*#__PURE__*/function () {
         query: {
           token: _index.JWT
         }
-      }); // @ts-expect-error
-
-      var onEvent = WebSocketHelper._socket.onevent; // @ts-expect-error
+      });
+      var onEvent = WebSocketHelper._socket.onevent;
 
       WebSocketHelper._socket.onevent = function (packet) {
         var args = packet.data || [];