@ricado/api-client 1.2.5 → 1.4.1

package/lib/index.d.ts

@@ -486,9 +486,7 @@ declare module '@ricado/api-client/Points' {
             /**
                 * The Read Points Callback
                 */
-            export type readPointsCallback = (siteId: number, pointValues: {
-                    [x: number]: PointValueItem;
-            }) => void;
+            export type readPointsCallback = (siteId: number, pointValues: PointValueItem[]) => void;
             /**
                 * A Point Value Item used in a Read Points Callback
                 */
@@ -4462,6 +4460,14 @@ declare module '@ricado/api-client/Controllers/Site/PointController' {
                         * The End Timestamp of the Point History Results. Defaults to Now
                         */
                     timestampEnd?: Date;
+                    /**
+                        * The Maximum Number of Values that should be returned for each Point ID. Defaults to an Unlimited Number of Values
+                        */
+                    maximumValues?: number;
+                    /**
+                        * A Resolution (Interval) in Seconds for the History Results - NOTE: Use of the maximumValues Query Parameter may enforce a higher minimum resolution. Defaults to 30 Seconds
+                        */
+                    resolution?: number;
             };
             /**
                 * The Optional Query Parameters for the getAllEvents Function

package/lib/index.js

@@ -3,44 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isDefined = isDefined;
-exports.getToken = getToken;
-exports.setToken = setToken;
-exports.hasToken = hasToken;
-exports.isInitialized = isInitialized;
-exports.isDebugMode = isDebugMode;
-exports.enableDebugMode = enableDebugMode;
-exports.disableDebugMode = disableDebugMode;
-exports.getBaseURL = getBaseURL;
-exports.setBaseURL = setBaseURL;
-exports.getWebSocketServer = getWebSocketServer;
-exports.setWebSocketServer = setWebSocketServer;
-exports.getWebSocketPort = getWebSocketPort;
-exports.setWebSocketPort = setWebSocketPort;
-exports.initialize = initialize;
-exports.userAccountLogin = userAccountLogin;
-exports.apiAccountLogin = apiAccountLogin;
-exports.pinCodeUnlock = pinCodeUnlock;
-exports.passwordUnlock = passwordUnlock;
-exports.lock = lock;
-exports.logout = logout;
-exports.ping = ping;
-Object.defineProperty(exports, "RequestHelper", {
+exports.BaseURL = void 0;
+Object.defineProperty(exports, "Controllers", {
   enumerable: true,
   get: function get() {
-    return _RequestHelper.default;
+    return _index.default;
   }
 });
-Object.defineProperty(exports, "WebSocketHelper", {
+Object.defineProperty(exports, "Errors", {
   enumerable: true,
   get: function get() {
-    return _WebSocketHelper.default;
+    return _index2.default;
   }
 });
-Object.defineProperty(exports, "Points", {
+exports.JWT = void 0;
+Object.defineProperty(exports, "Models", {
   enumerable: true,
   get: function get() {
-    return _Points.default;
+    return _index3.default;
   }
 });
 Object.defineProperty(exports, "NoAuthPaths", {
@@ -49,25 +29,48 @@ Object.defineProperty(exports, "NoAuthPaths", {
     return _NoAuthPaths.default;
   }
 });
-Object.defineProperty(exports, "Controllers", {
+Object.defineProperty(exports, "Points", {
   enumerable: true,
   get: function get() {
-    return _index.default;
+    return _Points.default;
   }
 });
-Object.defineProperty(exports, "Errors", {
+Object.defineProperty(exports, "RequestHelper", {
   enumerable: true,
   get: function get() {
-    return _index2.default;
+    return _RequestHelper.default;
   }
 });
-Object.defineProperty(exports, "Models", {
+exports.Version = void 0;
+Object.defineProperty(exports, "WebSocketHelper", {
   enumerable: true,
   get: function get() {
-    return _index3.default;
+    return _WebSocketHelper.default;
   }
 });
-exports.Version = exports.WebSocketPort = exports.WebSocketServer = exports.BaseURL = exports.JWT = void 0;
+exports.WebSocketServer = exports.WebSocketPort = void 0;
+exports.apiAccountLogin = apiAccountLogin;
+exports.disableDebugMode = disableDebugMode;
+exports.enableDebugMode = enableDebugMode;
+exports.getBaseURL = getBaseURL;
+exports.getToken = getToken;
+exports.getWebSocketPort = getWebSocketPort;
+exports.getWebSocketServer = getWebSocketServer;
+exports.hasToken = hasToken;
+exports.initialize = initialize;
+exports.isDebugMode = isDebugMode;
+exports.isDefined = isDefined;
+exports.isInitialized = isInitialized;
+exports.lock = lock;
+exports.logout = logout;
+exports.passwordUnlock = passwordUnlock;
+exports.pinCodeUnlock = pinCodeUnlock;
+exports.ping = ping;
+exports.setBaseURL = setBaseURL;
+exports.setToken = setToken;
+exports.setWebSocketPort = setWebSocketPort;
+exports.setWebSocketServer = setWebSocketServer;
+exports.userAccountLogin = userAccountLogin;
 
 var _RequestHelper = _interopRequireDefault(require("./RequestHelper"));
 
@@ -85,7 +88,7 @@ var _index2 = _interopRequireDefault(require("./Errors/index"));
 
 var _index3 = _interopRequireDefault(require("./Models/index"));
 
-var _isJwtValid = require("is-jwt-valid");
+var _jsBase = require("js-base64");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -137,7 +140,7 @@ function getToken() {
 
 
 function setToken(jwt) {
-  if ((0, _isJwtValid.parseJwtToken)(jwt)) {
+  if (isJwtValid(jwt)) {
     exports.JWT = JWT = jwt;
   } else {
     throw new Error("The JSON Web Token provided was not valid");
@@ -153,7 +156,7 @@ function setToken(jwt) {
 
 
 function hasToken() {
-  return isDefined(JWT) && (0, _isJwtValid.parseJwtToken)(JWT);
+  return isDefined(JWT) && isJwtValid(JWT);
 }
 /**
  * Initialized Status
@@ -511,6 +514,32 @@ function ping() {
     });
   });
 }
+/**
+ * 
+ * @param {string} jwt The JWT Token
+ * @return {boolean}
+ */
+
+
+function isJwtValid(jwt) {
+  if (jwt === null || typeof jwt !== 'string') {
+    return false;
+  }
+
+  var jwtSegments = jwt.split('.');
+
+  if (jwtSegments.length !== 3) {
+    return false;
+  }
+
+  try {
+    JSON.parse((0, _jsBase.decode)(jwtSegments[0]));
+    JSON.parse((0, _jsBase.decode)(jwtSegments[1]));
+    return true;
+  } catch (_unused) {
+    return false;
+  }
+}
 /**
  * The Library Version
  * 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "1.2.5",
+    "version": "1.4.1",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"
@@ -41,7 +41,7 @@
         "analyze-webpack": "npm run generate-version-file && npm run babel && cross-env NODE_ENV=production webpack --profile --json > stats.json && webpack-bundle-analyzer ./stats.json"
     },
     "dependencies": {
-        "is-jwt-valid": "^1.0.2",
+        "js-base64": "^3.7.2",
         "node-fetch": "^2.6.1",
         "socket.io-client": "^2.4.0"
     },

package/src/Controllers/Site/PointController.js

@@ -476,6 +476,8 @@ export default PointController;
  * @typedef {Object} PointController.GetAllHistoryQueryParameters
  * @property {Date} [timestampBegin] The Beginning Timestamp of the Point History Results. Defaults to 24 Hours ago
  * @property {Date} [timestampEnd] The End Timestamp of the Point History Results. Defaults to Now
+ * @property {number} [maximumValues] The Maximum Number of Values that should be returned for each Point ID. Defaults to an Unlimited Number of Values
+ * @property {number} [resolution] A Resolution (Interval) in Seconds for the History Results - NOTE: Use of the maximumValues Query Parameter may enforce a higher minimum resolution. Defaults to 30 Seconds
  * @memberof Controllers.Site
  */
 

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '1.2.5';
+export const version = '1.4.1';

package/src/Points.js

@@ -371,6 +371,11 @@ class Points
      */
     static getDefinition(siteId, pointId)
     {
+        if(Points.isInitialized() != true)
+        {
+            return undefined;
+        }
+        
         if(siteId in Points._definitions && pointId in Points._definitions[siteId])
         {
             return Points._definitions[siteId][pointId];
@@ -390,6 +395,11 @@ class Points
      */
     static getValue(siteId, pointId)
     {
+        if(Points.isInitialized() != true)
+        {
+            return undefined;
+        }
+        
         if(siteId in Points._values && pointId in Points._values[siteId])
         {
             return Points._values[siteId][pointId];
@@ -562,7 +572,7 @@ class Points
  * 
  * @callback Points.readPointsCallback
  * @param {number} siteId - The Site ID
- * @param {Object<number, Points.PointValueItem>} pointValues - An Object of Point Values
+ * @param {Points.PointValueItem[]} pointValues - An Object of Point Values
  * @return {void}
  */
 

package/src/index.js

@@ -10,7 +10,7 @@ import NoAuthPaths from './NoAuthPaths';
 import Controllers from './Controllers/index';
 import Errors from './Errors/index';
 import Models from './Models/index';
-import { parseJwtToken as jwtValid } from 'is-jwt-valid';
+import { decode as base64Decode } from 'js-base64';
 
 /**
  * Determines if a Variable has been Defined
@@ -55,7 +55,7 @@ export function getToken()
  */
 export function setToken(jwt)
 {
-    if(jwtValid(jwt))
+    if(isJwtValid(jwt))
     {
         JWT = jwt;
     }
@@ -74,7 +74,7 @@ export function setToken(jwt)
  */
 export function hasToken()
 {
-    return isDefined(JWT) && jwtValid(JWT);
+    return isDefined(JWT) && isJwtValid(JWT);
 }
 
 /**
@@ -405,6 +405,38 @@ export function ping() {
     });
 }
 
+/**
+ * 
+ * @param {string} jwt The JWT Token
+ * @return {boolean}
+ */
+function isJwtValid(jwt)
+{
+    if(jwt === null || typeof jwt !== 'string')
+    {
+        return false;
+    }
+
+    let jwtSegments = jwt.split('.');
+
+    if(jwtSegments.length !== 3)
+    {
+        return false;
+    }
+
+    try
+    {
+        JSON.parse(base64Decode(jwtSegments[0]));
+        JSON.parse(base64Decode(jwtSegments[1]));
+        
+        return true;
+    }
+    catch
+    {
+        return false;
+    }
+}
+
 /**
  * The Library Version
  *