@ricado/api-client 1.4.1 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "1.4.1",
+    "version": "2.1.0",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"
@@ -42,7 +42,7 @@
     },
     "dependencies": {
         "js-base64": "^3.7.2",
-        "node-fetch": "^2.6.1",
+        "node-fetch": "^2.6.6",
         "socket.io-client": "^2.4.0"
     },
     "devDependencies": {
@@ -54,7 +54,7 @@
         "@types/socket.io-client": "^1.4.36",
         "cross-env": "^7.0.3",
         "dts-bundle": "^0.7.3",
-        "dtslint": "^4.1.1",
+        "dtslint": "^4.2.1",
         "genversion": "^3.0.1",
         "jsdoc": "^3.6.7",
         "jsdoc-memberof-namespace": "^2.2.0",

package/src/Controllers/Packhouse/Site/PackrunController.js

@@ -1589,6 +1589,342 @@ class PackrunController
         });
     }
 
+    /**
+     * Retrieve a Packrun Infeed Report [GET /packhouse/sites/{siteId}/packruns/{id}/infeedReport]
+     * 
+     * Retrieves an Infeed Report for a Packrun
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Packrun ID
+     * @return {Promise<PackrunController.PackrunInfeedReport>}
+     */
+    static getInfeedReport(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/packruns/${id}/infeedReport`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    let resultObject = {};
+                    
+                    if(typeof result === 'object' && 'id' in result)
+                    {
+                        resultObject.id = (function(){
+                            if(typeof result.id !== 'string')
+                            {
+                                return String(result.id);
+                            }
+                
+                            return result.id;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.id = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'name' in result)
+                    {
+                        resultObject.name = (function(){
+                            if(typeof result.name !== 'string')
+                            {
+                                return String(result.name);
+                            }
+                
+                            return result.name;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.name = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'createdTimestamp' in result)
+                    {
+                        resultObject.createdTimestamp = (function(){
+                            if(typeof result.createdTimestamp !== 'string')
+                            {
+                                return new Date(String(result.createdTimestamp));
+                            }
+                
+                            return new Date(result.createdTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.createdTimestamp = new Date();
+                    }
+                    
+                    if(typeof result === 'object' && 'startTimestamp' in result)
+                    {
+                        resultObject.startTimestamp = (function(){
+                            if(result.startTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.startTimestamp !== 'string')
+                            {
+                                return new Date(String(result.startTimestamp));
+                            }
+                
+                            return new Date(result.startTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.startTimestamp = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'finishTimestamp' in result)
+                    {
+                        resultObject.finishTimestamp = (function(){
+                            if(result.finishTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.finishTimestamp !== 'string')
+                            {
+                                return new Date(String(result.finishTimestamp));
+                            }
+                
+                            return new Date(result.finishTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.finishTimestamp = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'packingLineId' in result)
+                    {
+                        resultObject.packingLineId = (function(){
+                            if(typeof result.packingLineId !== 'string')
+                            {
+                                return String(result.packingLineId);
+                            }
+                
+                            return result.packingLineId;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.packingLineId = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'packingLineName' in result)
+                    {
+                        resultObject.packingLineName = (function(){
+                            if(result.packingLineName === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.packingLineName !== 'string')
+                            {
+                                return String(result.packingLineName);
+                            }
+                
+                            return result.packingLineName;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.packingLineName = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'growerName' in result)
+                    {
+                        resultObject.growerName = (function(){
+                            if(typeof result.growerName !== 'string')
+                            {
+                                return String(result.growerName);
+                            }
+                
+                            return result.growerName;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.growerName = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'growerCode' in result)
+                    {
+                        resultObject.growerCode = (function(){
+                            if(typeof result.growerCode !== 'string')
+                            {
+                                return String(result.growerCode);
+                            }
+                
+                            return result.growerCode;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.growerCode = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'maturityArea' in result)
+                    {
+                        resultObject.maturityArea = (function(){
+                            if(result.maturityArea === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.maturityArea !== 'string')
+                            {
+                                return String(result.maturityArea);
+                            }
+                
+                            return result.maturityArea;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.maturityArea = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'allocatedBins' in result)
+                    {
+                        resultObject.allocatedBins = (function(){
+                            if(typeof result.allocatedBins !== 'number')
+                            {
+                                return Number.isInteger(Number(result.allocatedBins)) ? Number(result.allocatedBins) : Math.floor(Number(result.allocatedBins));
+                            }
+                
+                            return Number.isInteger(result.allocatedBins) ? result.allocatedBins : Math.floor(result.allocatedBins);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.allocatedBins = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'tippedBins' in result)
+                    {
+                        resultObject.tippedBins = (function(){
+                            if(typeof result.tippedBins !== 'number')
+                            {
+                                return Number.isInteger(Number(result.tippedBins)) ? Number(result.tippedBins) : Math.floor(Number(result.tippedBins));
+                            }
+                
+                            return Number.isInteger(result.tippedBins) ? result.tippedBins : Math.floor(result.tippedBins);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.tippedBins = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'softSortRejectWeight' in result)
+                    {
+                        resultObject.softSortRejectWeight = (function(){
+                            if(typeof result.softSortRejectWeight !== 'number')
+                            {
+                                return Number(result.softSortRejectWeight);
+                            }
+                
+                            return result.softSortRejectWeight;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.softSortRejectWeight = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'softSortRejectPercentage' in result)
+                    {
+                        resultObject.softSortRejectPercentage = (function(){
+                            if(typeof result.softSortRejectPercentage !== 'number')
+                            {
+                                return Number(result.softSortRejectPercentage);
+                            }
+                
+                            return result.softSortRejectPercentage;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.softSortRejectPercentage = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'softSortEventsPerBin' in result)
+                    {
+                        resultObject.softSortEventsPerBin = (function(){
+                            if(typeof result.softSortEventsPerBin !== 'number')
+                            {
+                                return Number(result.softSortEventsPerBin);
+                            }
+                
+                            return result.softSortEventsPerBin;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.softSortEventsPerBin = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'totalSoftSortEventsCount' in result)
+                    {
+                        resultObject.totalSoftSortEventsCount = (function(){
+                            if(typeof result.totalSoftSortEventsCount !== 'number')
+                            {
+                                return Number.isInteger(Number(result.totalSoftSortEventsCount)) ? Number(result.totalSoftSortEventsCount) : Math.floor(Number(result.totalSoftSortEventsCount));
+                            }
+                
+                            return Number.isInteger(result.totalSoftSortEventsCount) ? result.totalSoftSortEventsCount : Math.floor(result.totalSoftSortEventsCount);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.totalSoftSortEventsCount = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'averageSoftSortEventsDuration' in result)
+                    {
+                        resultObject.averageSoftSortEventsDuration = (function(){
+                            if(typeof result.averageSoftSortEventsDuration !== 'number')
+                            {
+                                return Number(result.averageSoftSortEventsDuration);
+                            }
+                
+                            return result.averageSoftSortEventsDuration;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.averageSoftSortEventsDuration = 0;
+                    }
+                    
+                    if(typeof result === 'object' && 'totalSoftSortEventsDuration' in result)
+                    {
+                        resultObject.totalSoftSortEventsDuration = (function(){
+                            if(typeof result.totalSoftSortEventsDuration !== 'number')
+                            {
+                                return Number(result.totalSoftSortEventsDuration);
+                            }
+                
+                            return result.totalSoftSortEventsDuration;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.totalSoftSortEventsDuration = 0;
+                    }
+                
+                    return resultObject;
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * List all Packruns [GET /packhouse/sites/{siteId}/packruns]
      * 
@@ -1820,4 +2156,29 @@ export default PackrunController;
  * @property {number} class2AverageTrayWeight The Average Class 2 Tray Weight for this Packrun
  * @property {Object[]} class2FreshPackSummary An Array of Class 2 Fruit Summaries by Size from FreshPack for the Packrun
  * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **PackrunInfeedReport** Type
+ * 
+ * @typedef {Object} PackrunController.PackrunInfeedReport
+ * @property {string} id The Packrun ID
+ * @property {string} name The Packrun Name
+ * @property {Date} createdTimestamp When the Packrun was Created
+ * @property {?Date} startTimestamp When the Packrun was Started
+ * @property {?Date} finishTimestamp When the Packrun was Finished
+ * @property {string} packingLineId The Packing Line ID
+ * @property {?string} packingLineName The Packing Line Name
+ * @property {string} growerName The Grower Name
+ * @property {string} growerCode The Grower Code
+ * @property {?string} maturityArea The Maturity Area
+ * @property {number} allocatedBins The Number of Bins Allocated for the Packrun
+ * @property {number} tippedBins The Number of Bins Tipped for the Packrun
+ * @property {number} softSortRejectWeight The Total Reject Weight for the Soft-Sort category expressed in kilograms
+ * @property {number} softSortRejectPercentage The Percentage of Packrun Weight categorized as Soft-Sort
+ * @property {number} softSortEventsPerBin The Number of Soft-Sort Events per Bin
+ * @property {number} totalSoftSortEventsCount The Number of Soft-Sort Events that occurred for the Packrun
+ * @property {number} averageSoftSortEventsDuration The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
+ * @property {number} totalSoftSortEventsDuration The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+ * @memberof Controllers.Packhouse.Site
  */

package/src/Models/AccountPolicyModel.js

@@ -28,153 +28,57 @@ class AccountPolicyModel extends BaseModel
          * The Account Policy ID
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._id = undefined;
+        this.id = undefined;
         
         /**
          * The Policy Name
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._name = undefined;
+        this.name = undefined;
         
         /**
          * The Company this Policy belongs to
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._companyId = undefined;
+        this.companyId = undefined;
         
         /**
          * The Resources this Policy provides
          * 
          * @type {Array<{id: any, type: string, actions: string[], permission: string}>}
-         * @private
+         * @public
          */
-        this._resources = undefined;
+        this.resources = undefined;
         
         /**
          * The Rules this Policy provides
          * 
          * @type {Object[]}
-         * @private
+         * @public
          */
-        this._rules = undefined;
+        this.rules = undefined;
         
         /**
          * Whether the Account Policy has been deleted
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._deleted = undefined;
+        this.deleted = undefined;
         
         /**
          * When the Account Policy was last updated
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._updateTimestamp = undefined;
-    }
-
-    /**
-     * The Account Policy ID
-     * 
-     * @public
-     * @type {string}
-     */
-    get id()
-    {
-        return this._id;
-    }
-
-    /**
-     * The Policy Name
-     * 
-     * @public
-     * @type {string}
-     */
-    get name()
-    {
-        return this._name;
-    }
-
-    /**
-     * The Company this Policy belongs to
-     * 
-     * @public
-     * @type {string}
-     */
-    get companyId()
-    {
-        return this._companyId;
-    }
-
-    /**
-     * The Resources this Policy provides
-     * 
-     * @public
-     * @type {Array<{id: any, type: string, actions: string[], permission: string}>}
-     */
-    get resources()
-    {
-        return this._resources;
-    }
-
-    /**
-     * The Rules this Policy provides
-     * 
-     * @public
-     * @type {Object[]}
-     */
-    get rules()
-    {
-        return this._rules;
-    }
-
-    /**
-     * Whether the Account Policy has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get deleted()
-    {
-        return this._deleted;
-    }
-
-    /**
-     * When the Account Policy was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-    get updateTimestamp()
-    {
-        return this._updateTimestamp;
-    }
-
-    /**
-     * Convert this **AccountPolicyModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-    toJSON()
-    {
-        return {
-            id: this._id,
-            name: this._name,
-            companyId: this._companyId,
-            resources: this._resources,
-            rules: this._rules,
-            deleted: this._deleted,
-            updateTimestamp: this._updateTimestamp
-        };
+        this.updateTimestamp = undefined;
     }
 
     /**
@@ -207,7 +111,7 @@ class AccountPolicyModel extends BaseModel
         
         if('id' in jsonObject)
         {
-            model._id = (function(){
+            model.id = (function(){
                 if(typeof jsonObject['id'] !== 'string')
                 {
                     return String(jsonObject['id']);
@@ -219,7 +123,7 @@ class AccountPolicyModel extends BaseModel
         
         if('name' in jsonObject)
         {
-            model._name = (function(){
+            model.name = (function(){
                 if(typeof jsonObject['name'] !== 'string')
                 {
                     return String(jsonObject['name']);
@@ -231,7 +135,7 @@ class AccountPolicyModel extends BaseModel
         
         if('companyId' in jsonObject)
         {
-            model._companyId = (function(){
+            model.companyId = (function(){
                 if(typeof jsonObject['companyId'] !== 'string')
                 {
                     return String(jsonObject['companyId']);
@@ -243,7 +147,7 @@ class AccountPolicyModel extends BaseModel
         
         if('resources' in jsonObject)
         {
-            model._resources = (function(){
+            model.resources = (function(){
                 if(Array.isArray(jsonObject['resources']) !== true)
                 {
                     return [];
@@ -329,7 +233,7 @@ class AccountPolicyModel extends BaseModel
         
         if('rules' in jsonObject)
         {
-            model._rules = (function(){
+            model.rules = (function(){
                 if(Array.isArray(jsonObject['rules']) !== true)
                 {
                     return [];
@@ -350,7 +254,7 @@ class AccountPolicyModel extends BaseModel
         
         if('deleted' in jsonObject)
         {
-            model._deleted = (function(){
+            model.deleted = (function(){
                 if(typeof jsonObject['deleted'] !== 'boolean')
                 {
                     return Boolean(jsonObject['deleted']);
@@ -362,7 +266,7 @@ class AccountPolicyModel extends BaseModel
         
         if('updateTimestamp' in jsonObject)
         {
-            model._updateTimestamp = (function(){
+            model.updateTimestamp = (function(){
                 if(typeof jsonObject['updateTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['updateTimestamp']));