@ricado/api-client 2.2.0 → 2.3.2

package/src/Models/Site/PermanentObjectModel.js

@@ -31,7 +31,7 @@ class PermanentObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The RTU this Permanent Object belongs to
@@ -39,7 +39,7 @@ class PermanentObjectModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.rtuId = undefined;
+        this.rtuId = null;
         
         /**
          * The Permanent Object Key Index
@@ -47,7 +47,7 @@ class PermanentObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.keyIndex = undefined;
+        this.keyIndex = "";
         
         /**
          * The Permanent Object Type
@@ -55,7 +55,7 @@ class PermanentObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.type = undefined;
+        this.type = "";
         
         /**
          * The Permanent Object Definition
@@ -63,7 +63,7 @@ class PermanentObjectModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.definition = undefined;
+        this.definition = {}
         
         /**
          * Whether the Permanent Object has been deleted
@@ -71,7 +71,7 @@ class PermanentObjectModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Permanent Object was last updated
@@ -79,7 +79,7 @@ class PermanentObjectModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Permanent Object

package/src/Models/Site/PointModel.js

@@ -31,7 +31,7 @@ class PointModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.id = undefined;
+        this.id = 0;
         
         /**
          * The RTU this Point belongs to
@@ -39,7 +39,7 @@ class PointModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.rtuId = undefined;
+        this.rtuId = null;
         
         /**
          * The Plugin ID
@@ -47,7 +47,7 @@ class PointModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.pluginId = undefined;
+        this.pluginId = null;
         
         /**
          * The Point Name
@@ -55,7 +55,7 @@ class PointModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Point Type
@@ -63,7 +63,7 @@ class PointModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.type = undefined;
+        this.type = "";
         
         /**
          * The Point's Value Type
@@ -71,7 +71,7 @@ class PointModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.valueType = undefined;
+        this.valueType = "";
         
         /**
          * The Permissions
@@ -79,7 +79,7 @@ class PointModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.permissions = undefined;
+        this.permissions = "";
         
         /**
          * Whether the Point is Enabled
@@ -87,7 +87,7 @@ class PointModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.enabled = undefined;
+        this.enabled = false;
         
         /**
          * The Point Settings
@@ -95,7 +95,7 @@ class PointModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.settings = undefined;
+        this.settings = {}
         
         /**
          * Whether the Point has been deleted
@@ -103,7 +103,7 @@ class PointModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Point was last updated
@@ -111,7 +111,7 @@ class PointModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Point

package/src/Models/Site/TemporaryObjectModel.js

@@ -31,7 +31,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Temporary Object Key Index
@@ -39,7 +39,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.keyIndex = undefined;
+        this.keyIndex = "";
         
         /**
          * The Temporary Object Type
@@ -47,7 +47,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.type = undefined;
+        this.type = "";
         
         /**
          * The Temporary Object Definition
@@ -55,7 +55,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.definition = undefined;
+        this.definition = {}
         
         /**
          * Whether the Temporary Object has been deleted
@@ -63,7 +63,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Temporary Object was last updated
@@ -71,7 +71,7 @@ class TemporaryObjectModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Temporary Object

package/src/Models/SiteModel.js

@@ -30,7 +30,7 @@ class SiteModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.id = undefined;
+        this.id = 0;
         
         /**
          * The Site Name
@@ -38,7 +38,7 @@ class SiteModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Company this Site belongs to
@@ -46,7 +46,7 @@ class SiteModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * Whether the Site is Enabled
@@ -54,7 +54,7 @@ class SiteModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.enabled = undefined;
+        this.enabled = false;
         
         /**
          * Whether the Site has been deleted
@@ -62,7 +62,7 @@ class SiteModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Site was last updated
@@ -70,7 +70,7 @@ class SiteModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

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.2.0';
+export const version = '2.3.2';

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}
  */