@ricado/api-client 2.1.0 → 2.3.0

package/src/Models/TokenModel.js

@@ -30,7 +30,7 @@ class TokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Account this Token belongs to
@@ -38,7 +38,7 @@ class TokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.accountId = undefined;
+        this.accountId = "";
         
         /**
          * The Account Type
@@ -46,7 +46,7 @@ class TokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.accountType = undefined;
+        this.accountType = "";
         
         /**
          * When the Token was issued
@@ -54,7 +54,7 @@ class TokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.issueTimestamp = undefined;
+        this.issueTimestamp = new Date();
         
         /**
          * When the Token will expire
@@ -62,7 +62,7 @@ class TokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.expireTimestamp = undefined;
+        this.expireTimestamp = new Date();
         
         /**
          * When the last API call using this Token was made
@@ -70,7 +70,7 @@ class TokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.activityTimestamp = undefined;
+        this.activityTimestamp = null;
         
         /**
          * When the Token was unlocked
@@ -78,7 +78,7 @@ class TokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.unlockTimestamp = undefined;
+        this.unlockTimestamp = null;
         
         /**
          * When the Token was locked
@@ -86,7 +86,7 @@ class TokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.lockTimestamp = undefined;
+        this.lockTimestamp = null;
         
         /**
          * Whether the Token has been deleted
@@ -94,7 +94,7 @@ class TokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Token was last updated
@@ -102,7 +102,7 @@ class TokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/UserAccountActionTokenModel.js

@@ -30,7 +30,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Account this Action Token belongs to
@@ -38,7 +38,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.accountId = undefined;
+        this.accountId = "";
         
         /**
          * The Company this Action Token belongs to
@@ -46,7 +46,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * The Action that can be Performed using this Action Token
@@ -54,7 +54,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.action = undefined;
+        this.action = "";
         
         /**
          * When the Action Token was issued
@@ -62,7 +62,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.issueTimestamp = undefined;
+        this.issueTimestamp = new Date();
         
         /**
          * When the Action Token will expire
@@ -70,7 +70,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.expireTimestamp = undefined;
+        this.expireTimestamp = new Date();
         
         /**
          * When the last API call using this Action Token was made
@@ -78,7 +78,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.activityTimestamp = undefined;
+        this.activityTimestamp = null;
         
         /**
          * When the Action was Completed
@@ -86,7 +86,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.completedTimestamp = undefined;
+        this.completedTimestamp = null;
         
         /**
          * When the Action Email was Sent
@@ -94,7 +94,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {?Date}
          * @public
          */
-        this.emailTimestamp = undefined;
+        this.emailTimestamp = null;
         
         /**
          * Whether the User Account Action Token has been deleted
@@ -102,7 +102,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the User Account Action Token was last updated
@@ -110,7 +110,7 @@ class UserAccountActionTokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/UserAccountModel.js

@@ -30,7 +30,7 @@ class UserAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The User's Email Address
@@ -38,7 +38,7 @@ class UserAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.email = undefined;
+        this.email = "";
         
         /**
          * The User's First Name
@@ -46,7 +46,7 @@ class UserAccountModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.firstName = undefined;
+        this.firstName = null;
         
         /**
          * The User's Last Name
@@ -54,7 +54,7 @@ class UserAccountModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.lastName = undefined;
+        this.lastName = null;
         
         /**
          * The Company this User belongs to
@@ -62,7 +62,7 @@ class UserAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * The Policies that apply to this User Account
@@ -70,7 +70,7 @@ class UserAccountModel extends BaseModel
          * @type {string[]}
          * @public
          */
-        this.policies = undefined;
+        this.policies = [];
         
         /**
          * Whether a Password has been Set for the User Account
@@ -78,7 +78,7 @@ class UserAccountModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.hasPassword = undefined;
+        this.hasPassword = false;
         
         /**
          * Whether a Pin Code has been Set for the User Account
@@ -86,7 +86,7 @@ class UserAccountModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.hasPinCode = undefined;
+        this.hasPinCode = false;
         
         /**
          * Whether the User Account has been deleted
@@ -94,7 +94,7 @@ class UserAccountModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the User Account was last updated
@@ -102,7 +102,7 @@ class UserAccountModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/PackageVersion.js

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

package/src/Points.js

@@ -24,7 +24,7 @@ class Points
      * An EventEmitter Instance
      * 
      * @private
-     * @type {EventEmitter}
+     * @type {EventEmitter|undefined}
      */
     static _emitter = undefined;
 
@@ -34,7 +34,7 @@ class Points
      * @private
      * @type {Object<number, {initializing: boolean, completed: boolean, pointIds: number[]}>}
      */
-    static _subscriptions = undefined;
+    static _subscriptions = {};
 
     /**
      * An Array of PointModel Definitions
@@ -42,7 +42,7 @@ class Points
      * @private
      * @type {Object<number, Object<number, PointModel>>}
      */
-    static _definitions = undefined;
+    static _definitions = {};
 
     /**
      * An Array of Point Values
@@ -50,7 +50,7 @@ class Points
      * @private
      * @type {Object<number, Object<number, Points.PointValueItem>>}
      */
-    static _values = undefined;
+    static _values = {};
 
     /**
      * Initialize
@@ -83,7 +83,13 @@ class Points
                 Points._values = {};
             }
 
-            WebSocketHelper.on('readpoints', (key, readPoints) => {
+            WebSocketHelper.on('readpoints',
+            /**
+             * @param {string} key
+             * @param {Array<{id: number, timestamp: string, value: any}>} readPoints
+             */
+            (key, readPoints) => {
+
                 if(isDefined(key) && key.includes('.') && readPoints.length > 0)
                 {
                     let keyId = key.split('.')[1];
@@ -102,7 +108,7 @@ class Points
                         siteId = this.getDefaultSiteId();
                     }
 
-                    if(isDefined(siteId) && siteId > 0)
+                    if(isDefined(siteId) && siteId !== undefined && siteId > 0)
                     {
                         if((siteId in Points._values) != true)
                         {
@@ -134,7 +140,10 @@ class Points
                             }
                         });
 
-                        Points._emitter.emit('readpoints', siteId, pointValueItems);
+                        if(Points._emitter !== undefined)
+                        {
+                            Points._emitter.emit('readpoints', siteId, pointValueItems);
+                        }
                     }
                 }
             });
@@ -312,7 +321,7 @@ class Points
      */
     static on(event, handler)
     {
-        if(isDefined(Points._emitter) != true)
+        if(isDefined(Points._emitter) != true || Points._emitter === undefined)
         {
             Points._emitter = new EventEmitter();
         }
@@ -330,7 +339,7 @@ class Points
      */
     static off(event, handler)
     {
-        if(isDefined(Points._emitter))
+        if(isDefined(Points._emitter) && Points._emitter !== undefined)
         {
             Points._emitter.off(event, handler);
         }
@@ -424,18 +433,21 @@ class Points
             if(siteId <= 0)
             {
                 reject(new Error("Invalid Site ID `" + siteId + "`"));
+                return;
             }
 
             if(pointId <= 0)
             {
                 reject(new Error("Invalid Point ID `" + pointId + "`"));
+                return;
             }
 
             let pointDefinition = Points.getDefinition(siteId, pointId);
 
-            if(isDefined(pointDefinition) != true || pointDefinition.id != pointId)
+            if(isDefined(pointDefinition) != true || pointDefinition === undefined || pointDefinition.id != pointId)
             {
                 reject(new Error("Unknown Point ID `" + pointId + "` for Site ID `" + siteId + "`"));
+                return;
             }
 
             WebSocketHelper.emit('createWritePoint', siteId, pointId, value, pointDefinition.valueType, false, (guid) => {
@@ -522,7 +534,7 @@ class Points
                         }
                     });
 
-                    if(changedPoints.length > 0)
+                    if(changedPoints.length > 0 && Points._emitter !== undefined)
                     {
                         Points._emitter.emit('readpoints', siteId, changedPoints);
                     }
@@ -563,7 +575,7 @@ class Points
  * The Events Callback
  * 
  * @callback Points.eventCallback
- * @param {...any[]} args - The Callback Arguments
+ * @param {...any} args - The Callback Arguments
  * @return {void}
  */
 

package/src/WebSocketHelper.js

@@ -13,7 +13,7 @@ class WebSocketHelper
      * An Event Emitter Instance
      * 
      * @private
-     * @type {EventEmitter}
+     * @type {EventEmitter|undefined}
      */
     static _emitter = undefined;
 
@@ -23,13 +23,13 @@ class WebSocketHelper
      * @private
      * @type {string[]}
      */
-    static _subscriptions = undefined;
+    static _subscriptions = [];
 
     /**
      * The Socket.IO WebSocket Instance
      * 
      * @private
-     * @type {SocketIOClient.Socket}
+     * @type {SocketIOClient.Socket|undefined}
      */
     static _socket = undefined;
 
@@ -74,6 +74,11 @@ class WebSocketHelper
             // Fired every time we attempt to reconnect.
             // `attempt` holds the count of attempts so far
 
+            if(WebSocketHelper._socket === undefined)
+            {
+                return;
+            }
+
             WebSocketHelper._socket.io.opts.transports = ['websocket'];
 
             WebSocketHelper._socket.io.opts.query = {
@@ -91,7 +96,10 @@ class WebSocketHelper
             if(isDefined(WebSocketHelper._subscriptions))
             {
                 WebSocketHelper._subscriptions.forEach((subscription) => {
-                    WebSocketHelper._socket.emit('subscribe', subscription);
+                    if(WebSocketHelper._socket !== undefined)
+                    {
+                        WebSocketHelper._socket.emit('subscribe', subscription);
+                    }
                 });
             }
         });
@@ -110,7 +118,10 @@ class WebSocketHelper
             if(reason == 'io server disconnect')
             {
                 setTimeout(() => {
-                    WebSocketHelper._socket.connect();
+                    if(WebSocketHelper._socket !== undefined)
+                    {
+                        WebSocketHelper._socket.connect();
+                    }
                 }, 5000);
             }
         });
@@ -137,6 +148,11 @@ class WebSocketHelper
         });
         
         WebSocketHelper._socket.on('*', (event, ...args) => {
+            if(WebSocketHelper._emitter === undefined)
+            {
+                return;
+            }
+
             WebSocketHelper._emitter.emit(event, ...args);
         });
     }
@@ -179,7 +195,7 @@ class WebSocketHelper
      * @public
      * @param {string} [key] - The Site ID or RTU ID Key (e.g. site.2 or rtu.1200)
      */
-    static subscribe(key = null)
+    static subscribe(key = undefined)
     {
         // TODO: Re-Write as Async (Use a Promise) and set up an "Ack" callback so we know the WebSocket Server has Subscribed us
         
@@ -188,7 +204,7 @@ class WebSocketHelper
             WebSocketHelper._subscriptions = [];
         }
 
-        if(isDefined(key) != true)
+        if(isDefined(key) != true || key === undefined)
         {
             key = 'all';
         }
@@ -198,7 +214,7 @@ class WebSocketHelper
             WebSocketHelper._subscriptions.push(key);
         }
         
-        if(isDefined(WebSocketHelper._socket))
+        if(isDefined(WebSocketHelper._socket) && WebSocketHelper._socket !== undefined)
         {
             WebSocketHelper._socket.emit('subscribe', key);
         }
@@ -211,7 +227,7 @@ class WebSocketHelper
      * @public
      * @param {string} [key] - The Site ID or RTU ID Key (e.g. site.2 or rtu.1200)
      */
-    static unsubscribe(key = null)
+    static unsubscribe(key = undefined)
     {
         // TODO: Re-Write as Async (Use a Promise) and set up an "Ack" callback so we know the WebSocket Server has Unsubscribed us
         
@@ -220,7 +236,7 @@ class WebSocketHelper
             WebSocketHelper._subscriptions = [];
         }
         
-        if(isDefined(key) != true)
+        if(isDefined(key) != true || key === undefined)
         {
             key = 'all';
         }
@@ -230,7 +246,7 @@ class WebSocketHelper
             WebSocketHelper._subscriptions.splice(WebSocketHelper._subscriptions.indexOf(key), 1);
         }
 
-        if(isDefined(WebSocketHelper._socket))
+        if(isDefined(WebSocketHelper._socket) && WebSocketHelper._socket !== undefined)
         {
             WebSocketHelper._socket.emit('unsubscribe', key);
         }
@@ -246,7 +262,7 @@ class WebSocketHelper
      */
     static on(event, handler)
     {
-        if(isDefined(WebSocketHelper._emitter) != true)
+        if(isDefined(WebSocketHelper._emitter) != true || WebSocketHelper._emitter === undefined)
         {
             WebSocketHelper._emitter = new EventEmitter();
         }
@@ -264,6 +280,11 @@ class WebSocketHelper
      */
     static emit(event, ...args)
     {
+        if(WebSocketHelper._socket === undefined)
+        {
+            return;
+        }
+
         WebSocketHelper._socket.emit(event, ...args);
     }
 }
@@ -272,7 +293,7 @@ class WebSocketHelper
  * The Events Callback
  * 
  * @callback WebSocketHelper.eventCallback
- * @param {...any[]} args - The Callback Arguments
+ * @param {...any} args - The Callback Arguments
  * @return {void}
  */
 

package/src/index.js

@@ -29,7 +29,7 @@ export function isDefined(variable)
  * The JSON Web Token for all Authenticated API Calls
  * 
  * @private
- * @type {string}
+ * @type {string|undefined}
  */
 export var JWT = undefined;
 
@@ -407,12 +407,12 @@ export function ping() {
 
 /**
  * 
- * @param {string} jwt The JWT Token
+ * @param {string|undefined} jwt The JWT Token
  * @return {boolean}
  */
 function isJwtValid(jwt)
 {
-    if(jwt === null || typeof jwt !== 'string')
+    if(jwt === null || jwt === undefined || typeof jwt !== 'string')
     {
         return false;
     }

package/types/tslint.json

@@ -11,6 +11,7 @@
         "no-useless-files": false,
         "strict-export-declare-modifiers": false,
         "array-type": false,
-        "interface-over-type-literal": false
+        "interface-over-type-literal": false,
+        "redundant-undefined": false
     }
 }