scheduler-node-models 1.0.79 → 1.0.83

package/scheduler/employees/employeename.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Employee Name interface and class will be used to store and manipulate an employee's
+ * name.
+ */
+/**
+ * This interface is used to describe an employee's name.
+ */
+export interface IEmployeeName {
+    firstname: string;
+    middlename?: string;
+    lastname: string;
+    suffix?: string;
+}
+/**
+ * This class defined an employee name.  The data members are:
+ * first, middlename and lastname names, plus an optional name suffix (ie. Jr, II, ...)
+ */
+export declare class EmployeeName implements IEmployeeName {
+    firstname: string;
+    middlename?: string;
+    lastname: string;
+    suffix?: string;
+    constructor(name?: IEmployeeName);
+    /**
+     * This function will provide a complete full name consisting of first and lastname or
+     * first middlename and lastname names.  the optional suffix is included.
+     * @returns The string value for the employee's full name (first middlename lastname suffix)
+     */
+    getFullName(): string;
+    /**
+     * This function will provide a shortened full name, minus the middlename and suffix.
+     * @returns A string value with the employee's shortened name (first lastname).
+     */
+    getFirstLast(): string;
+    /**
+     * This function will provide a shortened full name in the form of lastname, first
+     * @returns A string value for the employee's name (lastname, first)
+     */
+    getLastFirst(): string;
+    /**
+     * This function is used in sorting between this name and another.  It is based on
+     * the lastname, first, middlename and suffix (in order).
+     * @param other The name object to be used in comparison
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before, 1 for after or 0 for equal.
+     */
+    compareTo(other?: EmployeeName): number;
+}

package/scheduler/employees/employeename.js

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * Employee Name interface and class will be used to store and manipulate an employee's
+ * name.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmployeeName = void 0;
+/**
+ * This class defined an employee name.  The data members are:
+ * first, middlename and lastname names, plus an optional name suffix (ie. Jr, II, ...)
+ */
+class EmployeeName {
+    firstname;
+    middlename;
+    lastname;
+    suffix;
+    constructor(name) {
+        this.firstname = (name) ? name.firstname : '';
+        this.middlename = (name && name.middlename) ? name.middlename : undefined;
+        this.lastname = (name) ? name.lastname : '';
+        this.suffix = (name) ? name.suffix : undefined;
+    }
+    /**
+     * This function will provide a complete full name consisting of first and lastname or
+     * first middlename and lastname names.  the optional suffix is included.
+     * @returns The string value for the employee's full name (first middlename lastname suffix)
+     */
+    getFullName() {
+        let result = '';
+        if (!this.middlename) {
+            result = this.firstname + ' ' + this.lastname;
+        }
+        else {
+            result = this.firstname + ' ' + this.middlename.substring(0, 1) + '. '
+                + this.lastname;
+        }
+        if (this.suffix) {
+            result += ` ${this.suffix}`;
+        }
+        return result;
+    }
+    /**
+     * This function will provide a shortened full name, minus the middlename and suffix.
+     * @returns A string value with the employee's shortened name (first lastname).
+     */
+    getFirstLast() {
+        return this.firstname + ' ' + this.lastname;
+    }
+    /**
+     * This function will provide a shortened full name in the form of lastname, first
+     * @returns A string value for the employee's name (lastname, first)
+     */
+    getLastFirst() {
+        return this.lastname + ', ' + this.firstname;
+    }
+    /**
+     * This function is used in sorting between this name and another.  It is based on
+     * the lastname, first, middlename and suffix (in order).
+     * @param other The name object to be used in comparison
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before, 1 for after or 0 for equal.
+     */
+    compareTo(other) {
+        if (other) {
+            if (this.lastname.toLowerCase() === other.lastname.toLowerCase()) {
+                if (this.firstname.toLowerCase() === other.firstname.toLowerCase()) {
+                    if (this.middlename && other.middlename) {
+                        if (this.middlename.toLowerCase() === other.middlename.toLowerCase()) {
+                            if (this.suffix && other.suffix) {
+                                return (this.suffix.toLowerCase() < other.suffix.toLowerCase()) ? -1 : 1;
+                            }
+                            else if (this.suffix) {
+                                return 1;
+                            }
+                            else if (other.suffix) {
+                                return -1;
+                            }
+                            return 0;
+                        }
+                        return (this.middlename.toLowerCase() < other.middlename.toLowerCase()) ? -1 : 1;
+                    }
+                    else if (this.middlename) {
+                        return 1;
+                    }
+                    else if (other.middlename) {
+                        return -1;
+                    }
+                    return 0;
+                }
+                return (this.firstname.toLowerCase() < other.firstname.toLowerCase()) ? -1 : 1;
+            }
+            return (this.lastname.toLowerCase() < other.lastname.toLowerCase()) ? -1 : 1;
+        }
+        return -1;
+    }
+}
+exports.EmployeeName = EmployeeName;

package/scheduler/employees/index.d.ts

@@ -0,0 +1,14 @@
+export * from './companyinfo';
+export * from './employee';
+export * from './employeename';
+export * from './workday';
+export * from './labor';
+export * from './assignment';
+export * from './variation';
+export * from './leave';
+export * from './leaverequest';
+export * from './balance';
+export * from './work';
+export * from './contact';
+export * from './specialty';
+export * from './web';

package/scheduler/employees/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./companyinfo"), exports);
+__exportStar(require("./employee"), exports);
+__exportStar(require("./employeename"), exports);
+__exportStar(require("./workday"), exports);
+__exportStar(require("./labor"), exports);
+__exportStar(require("./assignment"), exports);
+__exportStar(require("./variation"), exports);
+__exportStar(require("./leave"), exports);
+__exportStar(require("./leaverequest"), exports);
+__exportStar(require("./balance"), exports);
+__exportStar(require("./work"), exports);
+__exportStar(require("./contact"), exports);
+__exportStar(require("./specialty"), exports);
+__exportStar(require("./web"), exports);

package/scheduler/employees/labor.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Employee Labor Code is specifically designed to hold the codes used by companies'
+ * payroll system to record time spent on a particular function.  This will normally
+ * consist of a base charge number and an extension code.
+ */
+/**
+ * This interface will be used to assign an employee a labor code.
+ */
+export interface IEmployeeLaborCode {
+    chargeNumber: string;
+    extension: string;
+}
+/**
+ * This class defined an employee's labor code.  The data members are:
+ * chargeNumber (string value for a general work area).
+ * extension (string value to entend the charge number to specific work assignments)
+ */
+export declare class EmployeeLaborCode implements IEmployeeLaborCode {
+    chargeNumber: string;
+    extension: string;
+    constructor(elc?: IEmployeeLaborCode);
+    /**
+     * This function will provide a numeric value for whether or not this employee labor
+     * code is before or after another object.  The charge number and extension are used
+     * for comparison
+     * @param other The employee labor code object used for comparision
+     * @returns A numeric value to indicate whether this object is before or after another
+     * employee labor code.  -1 is before and 1 is after.
+     */
+    compareTo(other?: EmployeeLaborCode): number;
+}

package/scheduler/employees/labor.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * Employee Labor Code is specifically designed to hold the codes used by companies'
+ * payroll system to record time spent on a particular function.  This will normally
+ * consist of a base charge number and an extension code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmployeeLaborCode = void 0;
+/**
+ * This class defined an employee's labor code.  The data members are:
+ * chargeNumber (string value for a general work area).
+ * extension (string value to entend the charge number to specific work assignments)
+ */
+class EmployeeLaborCode {
+    chargeNumber;
+    extension;
+    constructor(elc) {
+        this.chargeNumber = (elc) ? elc.chargeNumber : '';
+        this.extension = (elc) ? elc.extension : '';
+    }
+    /**
+     * This function will provide a numeric value for whether or not this employee labor
+     * code is before or after another object.  The charge number and extension are used
+     * for comparison
+     * @param other The employee labor code object used for comparision
+     * @returns A numeric value to indicate whether this object is before or after another
+     * employee labor code.  -1 is before and 1 is after.
+     */
+    compareTo(other) {
+        if (other) {
+            if (this.chargeNumber === other.chargeNumber) {
+                return (this.extension < other.extension) ? -1 : 1;
+            }
+            return (this.chargeNumber < other.chargeNumber) ? -1 : 1;
+        }
+        return -1;
+    }
+}
+exports.EmployeeLaborCode = EmployeeLaborCode;

package/scheduler/employees/leave.d.ts

@@ -0,0 +1,58 @@
+/**
+ * The leave record is used for approved and actual leave (non-work) time.
+ */
+/**
+ * This interface is used to describe a leave day, either approved or actual leave.
+ */
+export interface ILeave {
+    id: number;
+    leavedate: Date;
+    code: string;
+    hours: number;
+    status: string;
+    requestid: string;
+    used: boolean;
+    tagday?: string;
+}
+/**
+ * This class describes a leave day.  Its data member are:
+ * id (numeric value for the key to the leaves listed)
+ * leavedate (the date object for the date the leave is on)
+ * code (the string value for the leave code to be used)
+ * hours (the numeric value (float) for the number of hours used or projected to be used)
+ * status (the string value for the status of the leave, either approved or actual)
+ * requestid (the string value representing the id of the request used to get this leave
+ * approved)
+ * used (a boolean value used by the application as whether or not the leave was used
+ * already)
+ * tagday (a string value for a tag to a holiday type leave to ensure it fills a
+ * particular holiday in the company's holiday list)
+ */
+export declare class Leave implements ILeave {
+    id: number;
+    leavedate: Date;
+    code: string;
+    hours: number;
+    status: string;
+    requestid: string;
+    used: boolean;
+    tagday?: string;
+    constructor(other?: ILeave);
+    /**
+     * This function is used in sorting between this leave and another.  It is based on
+     * the leave date, hours used/proposed, and code used.
+     * @param other The leave object to be used in comparison
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before or 1 for after.
+     */
+    compareTo(other?: Leave): number;
+    /**
+     * This function will provide a boolean value for whether or not this leave is on the
+     * requested date.  The leave date and provided date are compared using UTC value of
+     * year, month, and day
+     * @param date The date object used for comparision
+     * @returns The boolean value stating whether the UTC value for year, month and day are
+     * equal.
+     */
+    useLeave(date: Date): boolean;
+}

package/scheduler/employees/leave.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * The leave record is used for approved and actual leave (non-work) time.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Leave = void 0;
+/**
+ * This class describes a leave day.  Its data member are:
+ * id (numeric value for the key to the leaves listed)
+ * leavedate (the date object for the date the leave is on)
+ * code (the string value for the leave code to be used)
+ * hours (the numeric value (float) for the number of hours used or projected to be used)
+ * status (the string value for the status of the leave, either approved or actual)
+ * requestid (the string value representing the id of the request used to get this leave
+ * approved)
+ * used (a boolean value used by the application as whether or not the leave was used
+ * already)
+ * tagday (a string value for a tag to a holiday type leave to ensure it fills a
+ * particular holiday in the company's holiday list)
+ */
+class Leave {
+    id;
+    leavedate;
+    code;
+    hours;
+    status;
+    requestid;
+    used;
+    tagday;
+    constructor(other) {
+        this.id = (other) ? other.id : 0;
+        this.leavedate = (other) ? new Date(other.leavedate) : new Date(0);
+        this.code = (other) ? other.code : 'V';
+        this.hours = (other) ? other.hours : 0.0;
+        this.status = (other) ? other.status : 'REQUESTED';
+        this.requestid = (other) ? other.requestid : '';
+        this.used = (other) ? other.used : false;
+        this.tagday = (other && other.tagday) ? other.tagday : undefined;
+    }
+    /**
+     * This function is used in sorting between this leave and another.  It is based on
+     * the leave date, hours used/proposed, and code used.
+     * @param other The leave object to be used in comparison
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before or 1 for after.
+     */
+    compareTo(other) {
+        if (other) {
+            if (this.leavedate.getTime() === other.leavedate.getTime()) {
+                if (this.hours === other.hours) {
+                    return (this.code < other.code) ? -1 : 1;
+                }
+                return (this.hours > other.hours) ? -1 : 1;
+            }
+            return (this.leavedate.getTime() < other.leavedate.getTime()) ? -1 : 1;
+        }
+        return -1;
+    }
+    /**
+     * This function will provide a boolean value for whether or not this leave is on the
+     * requested date.  The leave date and provided date are compared using UTC value of
+     * year, month, and day
+     * @param date The date object used for comparision
+     * @returns The boolean value stating whether the UTC value for year, month and day are
+     * equal.
+     */
+    useLeave(date) {
+        return (this.leavedate.getUTCFullYear() === date.getUTCFullYear()
+            && this.leavedate.getUTCMonth() === date.getUTCMonth()
+            && this.leavedate.getUTCDate() === date.getUTCDate());
+    }
+}
+exports.Leave = Leave;

package/scheduler/employees/leaverequest.d.ts

@@ -0,0 +1,105 @@
+import { ILeave, Leave } from "./leave";
+import { Employee } from "./employee";
+/**
+ * The leave request is the record an employee uses to request a leave period with their
+ * supervisor.  It includes comments and proposed leave days.
+ */
+/**
+ * The interface describes a comment to a leave request.
+ */
+export interface ILeaveRequestComment {
+    commentdate: Date;
+    comment: string;
+}
+/**
+ * The class description for a comment to a leave request.  The data members are:
+ * comment date (date object for the date the comment was written on.)
+ * comment (the string value for the actual comment to the request)
+ */
+export declare class LeaveRequestComment implements ILeaveRequestComment {
+    commentdate: Date;
+    comment: string;
+    constructor(cmt?: ILeaveRequestComment);
+    /**
+     * This function is used to sort the comments by date.
+     * @param other The comment object used in comparison.
+     * @returns
+  
+    /**
+     * This function is used to sort this object from another variation object
+     * @param other The other variation object for comparison
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before or 1 for after.
+     */
+    compareTo(other?: LeaveRequestComment): number;
+}
+/**
+ * This interface describes a leave request.
+ */
+export interface ILeaveRequest {
+    id: string;
+    employeeid: string;
+    requestdate: Date;
+    primarycode: string;
+    startdate: Date;
+    enddate: Date;
+    status: string;
+    approvedby: string;
+    approvalDate: Date;
+    requesteddays: ILeave[];
+    comments?: ILeaveRequestComment[];
+}
+/**
+ * This class describes a leave request object.  The data members are:
+ * id (string value representing a mongo db object identifier)
+ * employeeid (string value representing a mongo db object identifier for the employee)
+ * requestdate (the date object for the date the request was created)
+ * primarycode (string value for the leave code used the most in the request)
+ * startdate (the date object used to define the begining of the leave period)
+ * enddate (the date object used to define the end of the leave period)
+ * status (the string value for the step the request is in the approval process.  The
+ * available statuses are DRAFT, REQUESTED, APPROVED)
+ * approvedby (the string value representing the object id of the supervisor approving
+ * the request)
+ * approvaldate (the date object for the date the request was approved)
+ * requesteddays (the list of proposed leave days within the period)
+ * comments (the list of comments to this request)
+ */
+export declare class LeaveRequest implements ILeaveRequest {
+    id: string;
+    employeeid: string;
+    requestdate: Date;
+    primarycode: string;
+    startdate: Date;
+    enddate: Date;
+    status: string;
+    approvedby: string;
+    approvalDate: Date;
+    requesteddays: Leave[];
+    comments: LeaveRequestComment[];
+    constructor(req?: ILeaveRequest);
+    /**
+     * this function is used to sort this request from another.  They are sorted based on
+     * start, end and request dates.
+     * @param other The request object used for comparison.
+     * @returns A numeric value to indicate whether this object is before or after the other
+     * object.  -1 is before or 1 for after.
+     */
+    compareTo(other?: LeaveRequest): number;
+    useRequest(id: string): boolean;
+    /**
+     * This function is used to replace a value on a single proposed leave day.
+     * @param date The date object used to find which leave day to update
+     * @param field The string value for which field in the leave day to update.
+     * @param value The string value for the change.  If can me a string value of a number
+     * or boolean value.
+     */
+    updateLeaveDay(date: Date, field: string, value: string): void;
+    /**
+     * This function is used to set up leave days in the request object based on the
+     * period and whether or not the employee normally works the day.
+     * @param emp This a reference to the employee object where this request resides and
+     * is used to determine if the employee normally works on that day.
+     */
+    setLeaveDays(emp: Employee, reset?: boolean): void;
+}