scheduler-node-models 1.2.28 → 1.2.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scheduler-node-models",
-  "version": "1.2.28",
+  "version": "1.2.30",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [

package/scheduler/employees/employee.d.ts

@@ -167,6 +167,23 @@ export declare class Employee implements IEmployee {
      * @param start The date object used to mark the start of the assignment
      */
     addAssignment(site: string, wkctr: string, start: Date): void;
+    /**
+     * This method will be used to update an assignment already in the employee's
+     * list.  It can throw errors for assignment not found and for missing data
+     * expected for the field to be update.
+     * @param id A numeric value for the assignment to update
+     * @param field A string value for the field to update
+     * @param value A string value for the update to the required field
+     * @param schedule (Optional) A numeric value for the assignment schedule to be updated
+     * @param workday (Optional) A numeric value for the assignment schedule workday to
+     * be updated.
+     */
+    updateAssignment(id: number, field: string, value: string, schedule?: number, workday?: number): void;
+    /**
+     * The function will remove a particular assignment from the assignment list
+     * @param id The numeric identifier for the assignment to remove.
+     */
+    removeAssignment(id: number): void;
     /**
      * This method is used to add a new variation to the employee.  It will determine the
      * new variation's identifier and add that along with site and start date to the new
@@ -176,10 +193,29 @@ export declare class Employee implements IEmployee {
      */
     addVariation(site: string, start: Date): void;
     /**
-     * The function will remove a particular assignment from the assignment list
-     * @param id The numeric identifier for the assignment to remove.
+     * This method will update the selected variation with an update a single
+     * field in the selected variation.  If the variation isn't found, an error
+     * will be transmitted to the requestor.
+     * @param varID A numeric value for the variation to change.
+     * @param field A string value for the data member to change.
+     * @param value A string value representing the data member's new value.
+     * @param workday (Optional) a numeric value for the workday to update if the update
+     * field is in a variation workday.
      */
-    removeAssignment(id: number): void;
+    updateVariation(varID: number, field: string, value: string, workday?: number): void;
+    /**
+     * This method will be used to convert a date string in the format of 2006-01-02 to
+     * a Date object with that date.
+     * @param date A string value in the correct format
+     * @returns
+     */
+    private getDateFromString;
+    /**
+     * This method will be used to remove a single variation from the employee's variation
+     * list.  An error will be thrown if the variation is not found.
+     * @param varID A numeric value for the identifier of the variation to delete.
+     */
+    removeVariation(varID: number): void;
     /**
      * This function will determine if a labor code (charge number and extension) is the
      * employee's primary code for the date given.

package/scheduler/employees/employee.js

@@ -566,28 +566,81 @@ class Employee {
         this.assignments.push(newAsgmt);
     }
     /**
-     * This method is used to add a new variation to the employee.  It will determine the
-     * new variation's identifier and add that along with site and start date to the new
-     * variation.  The variation's enddate will match the start date at this time.
-     * @param site A string value for the site identifier.
-     * @param start A data value for the start of this variation.
+     * This method will be used to update an assignment already in the employee's
+     * list.  It can throw errors for assignment not found and for missing data
+     * expected for the field to be update.
+     * @param id A numeric value for the assignment to update
+     * @param field A string value for the field to update
+     * @param value A string value for the update to the required field
+     * @param schedule (Optional) A numeric value for the assignment schedule to be updated
+     * @param workday (Optional) A numeric value for the assignment schedule workday to
+     * be updated.
      */
-    addVariation(site, start) {
-        // start by getting and determing the next variation id number.
-        let newID = -1;
-        this.variations.forEach(vari => {
-            if (vari.id > newID) {
-                newID = vari.id;
+    updateAssignment(id, field, value, schedule, workday) {
+        let found = false;
+        this.assignments.sort((a, b) => a.compareTo(b));
+        this.assignments.forEach((asgmt, i) => {
+            if (asgmt.id === id) {
+                found = true;
+                switch (field.toLowerCase()) {
+                    case "site":
+                        asgmt.site = value;
+                        break;
+                    case "workcenter":
+                        asgmt.workcenter = value;
+                        break;
+                    case "start":
+                    case "startdate":
+                        asgmt.startDate = this.getDateFromString(value);
+                        break;
+                    case "end":
+                    case "enddate":
+                        asgmt.endDate = this.getDateFromString(value);
+                        break;
+                    case "rotationdate":
+                        asgmt.rotationdate = this.getDateFromString(value);
+                        break;
+                    case "rotationdays":
+                        asgmt.rotationdays = Number(value);
+                        break;
+                    case "addschedule":
+                        asgmt.addSchedule(Number(value));
+                        break;
+                    case "removeschedule":
+                        if (schedule) {
+                            asgmt.removeSchedule(schedule);
+                        }
+                        else {
+                            throw new Error('Assignment schedule id not provided');
+                        }
+                        break;
+                    case "scheduledays":
+                        if (schedule) {
+                            asgmt.changeScheduleDays(schedule, Number(value));
+                        }
+                        else {
+                            throw new Error('Assignment schedule id not provided');
+                        }
+                        break;
+                    case "workday-code":
+                    case "workday-workcenter":
+                    case "workday-hours":
+                    case "workday-copy":
+                        const wparts = field.split('-');
+                        if (schedule && workday) {
+                            asgmt.updateWorkday(schedule, workday, wparts[1], value);
+                        }
+                        else {
+                            throw new Error('Assignment schedule and/or workday id not provided');
+                        }
+                        break;
+                }
+                this.assignments[i] = asgmt;
             }
         });
-        newID++;
-        const newVari = new variation_1.Variation();
-        newVari.id = newID;
-        newVari.site = site;
-        newVari.startdate = new Date(start);
-        newVari.enddate = new Date(start);
-        this.variations.push(newVari);
-        this.variations.sort((a, b) => a.compareTo(b));
+        if (!found) {
+            throw new Error('Assignment not found');
+        }
     }
     /**
      * The function will remove a particular assignment from the assignment list
@@ -620,6 +673,124 @@ class Employee {
             this.assignments.splice(pos, 1);
         }
     }
+    /**
+     * This method is used to add a new variation to the employee.  It will determine the
+     * new variation's identifier and add that along with site and start date to the new
+     * variation.  The variation's enddate will match the start date at this time.
+     * @param site A string value for the site identifier.
+     * @param start A data value for the start of this variation.
+     */
+    addVariation(site, start) {
+        // start by getting and determing the next variation id number.
+        let newID = -1;
+        this.variations.forEach(vari => {
+            if (vari.id > newID) {
+                newID = vari.id;
+            }
+        });
+        newID++;
+        const newVari = new variation_1.Variation();
+        newVari.id = newID;
+        newVari.site = site;
+        newVari.startdate = new Date(start);
+        newVari.enddate = new Date(start);
+        this.variations.push(newVari);
+        this.variations.sort((a, b) => a.compareTo(b));
+    }
+    /**
+     * This method will update the selected variation with an update a single
+     * field in the selected variation.  If the variation isn't found, an error
+     * will be transmitted to the requestor.
+     * @param varID A numeric value for the variation to change.
+     * @param field A string value for the data member to change.
+     * @param value A string value representing the data member's new value.
+     * @param workday (Optional) a numeric value for the workday to update if the update
+     * field is in a variation workday.
+     */
+    updateVariation(varID, field, value, workday) {
+        this.variations.sort((a, b) => a.compareTo(b));
+        let found = false;
+        this.variations.forEach((vari, v) => {
+            if (vari.id === varID) {
+                found = true;
+                switch (field.toLowerCase()) {
+                    case "site":
+                        vari.site = value;
+                        break;
+                    case "mids":
+                    case "ismids":
+                        vari.mids = Boolean(value);
+                        break;
+                    case "dates":
+                        vari.schedule.showdates = Boolean(value);
+                        break;
+                    case "start":
+                    case "startdate":
+                        vari.startdate = this.getDateFromString(value);
+                        break;
+                    case "end":
+                    case "enddate":
+                        vari.enddate = this.getDateFromString(value);
+                        break;
+                    case "changeschedule":
+                        vari.schedule.setScheduleDays(Number(value));
+                        break;
+                    case "workday-code":
+                    case "workday-workcenter":
+                    case "workday-hours":
+                    case "workday-copy":
+                        const wparts = field.split('-');
+                        if (workday) {
+                            vari.updateWorkday(workday, wparts[1], value);
+                        }
+                        break;
+                }
+                this.variations[v] = vari;
+            }
+        });
+        if (!found) {
+            throw new Error('Variation not found');
+        }
+    }
+    /**
+     * This method will be used to convert a date string in the format of 2006-01-02 to
+     * a Date object with that date.
+     * @param date A string value in the correct format
+     * @returns
+     */
+    getDateFromString(date) {
+        const reDateFormat = new RegExp('^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$');
+        if (reDateFormat.test(date)) {
+            const parts = date.split('-');
+            const year = parseInt(parts[0]);
+            const month = parseInt(parts[1]);
+            const day = parseInt(parts[2]);
+            const result = new Date(Date.UTC(year, month - 1, day));
+            return result;
+        }
+        else {
+            throw new Error('Date not in correct format (yyyy-mm-dd)');
+        }
+    }
+    /**
+     * This method will be used to remove a single variation from the employee's variation
+     * list.  An error will be thrown if the variation is not found.
+     * @param varID A numeric value for the identifier of the variation to delete.
+     */
+    removeVariation(varID) {
+        let found = -1;
+        this.variations.forEach((vari, v) => {
+            if (vari.id === varID) {
+                found = v;
+            }
+        });
+        if (found >= 0) {
+            this.variations.splice(found, 1);
+        }
+        else {
+            throw new Error('Variation not found');
+        }
+    }
     /**
      * This function will determine if a labor code (charge number and extension) is the
      * employee's primary code for the date given.