scheduler-node-models 1.2.1 → 1.2.3

package/scheduler/teams/team.d.ts

@@ -0,0 +1,95 @@
+import { ObjectId } from "mongodb";
+import { IWorkcode, Workcode } from "../labor";
+import { ISite, Site } from "../sites";
+import { Company, ICompany } from "./company";
+import { Contact, IContact } from "./contact";
+import { ISpecialty, Specialty } from "./specialty";
+export interface ITeam {
+    _id?: ObjectId;
+    id?: string;
+    name: string;
+    workcodes: IWorkcode[];
+    sites: ISite[];
+    companies?: ICompany[];
+    contacttypes?: IContact[];
+    specialties?: ISpecialty[];
+}
+export declare class Team implements ITeam {
+    id: string;
+    name: string;
+    workcodes: Workcode[];
+    sites: Site[];
+    companies: Company[];
+    contacttypes: Contact[];
+    specialties: Specialty[];
+    constructor(team?: ITeam);
+    /**
+     * Workcode section (CRUD)
+     */
+    /**
+     * This function will add a new work code to the team's work/leave code list.
+     * @param id The string value for the use code and identifier for the work or leave
+     * code.
+     * @param title The string value for the short explanation of the code.
+     * @param start The numeric value for the hour the work shift normally starts work.
+     * @param shift The string value for any paycode designator
+     * @param isLeave A boolean value to signify if the code is for leaves
+     * @param text A string 6-character hexadecimal value for the color of text for this
+     * code.
+     * @param back A string 6-character hexadecimal value for the color of the background
+     * for this code.
+     * @param search (optional) A string value to search time records to recognize the code.
+     */
+    addWorkcode(id: string, title: string, start: number, shift: string, isLeave: boolean, text: string, back: string, search?: string): void;
+    /**
+     * This function is used to update a single work/leave code, based on the identifier,
+     * a field designator and value for that field.
+     * @param id The string value for the identifier of the code to change
+     * @param field The string value to identify the field/data member to update
+     * @param value The string value for the new value.
+     */
+    updateWorkcode(id: string, field: string, value: string): void;
+    /**
+     * This function will delete
+     * @param id The string value for the identifier of the work/leave code to delete
+     */
+    deleteWorkcode(id: string): void;
+    /**
+     * Contact Types section
+     */
+    /**
+     * This function will add a new contact type, after checking to ensure the contact type
+     * name isn't already listed
+     * @param name The string value for the new contact type.
+     */
+    addContactType(name: string): void;
+    /**
+     * This function will be used to update a contact type within the list
+     * @param id The numeric identifer for the contact type.
+     * @param field The string value to identify the data member to update
+     * @param value The string value for the modification.
+     */
+    updateContactType(id: number, field: string, value: string): void;
+    /**
+     * This function will remove a designated contact type by identifier from the list.
+     * @param id The numeric identifier to the designated contact type.
+     */
+    deleteContactType(id: number): void;
+    /**
+     * This function will add a new specialty type, if the name isn't already in the list.
+     * @param name The string value for the new specialty name.
+     */
+    addSpecialtyType(name: string): void;
+    /**
+     * This function will update a specialty type within the list
+     * @param id The numeric value for the identifier for the contact type to update
+     * @param field The string value for the field/data member to update
+     * @param value The string value for the new value.
+     */
+    updateSpecialtyType(id: number, field: string, value: string): void;
+    /**
+     * This function will remove a specialty type from the list.
+     * @param id The numeric value for the identifier to remove.
+     */
+    deleteSpecialtyType(id: number): void;
+}

package/scheduler/teams/team.js

@@ -0,0 +1,351 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Team = void 0;
+const labor_1 = require("../labor");
+const sites_1 = require("../sites");
+const company_1 = require("./company");
+const contact_1 = require("./contact");
+const specialty_1 = require("./specialty");
+class Team {
+    id;
+    name;
+    workcodes;
+    sites;
+    companies;
+    contacttypes;
+    specialties;
+    constructor(team) {
+        this.id = (team && team.id) ? team.id : '';
+        if (this.id === '') {
+            this.id = (team && team._id) ? team._id.toString() : '';
+        }
+        this.name = (team) ? team.name : '';
+        this.workcodes = [];
+        if (team && team.workcodes.length > 0) {
+            team.workcodes.forEach(wc => {
+                this.workcodes.push(new labor_1.Workcode(wc));
+            });
+            this.workcodes.sort((a, b) => a.compareTo(b));
+        }
+        this.sites = [];
+        if (team && team.sites.length > 0) {
+            team.sites.forEach(site => {
+                this.sites.push(new sites_1.Site(site));
+            });
+            this.sites.sort((a, b) => a.compareTo(b));
+        }
+        this.companies = [];
+        if (team && team.companies && team.companies.length > 0) {
+            team.companies.forEach(co => {
+                this.companies.push(new company_1.Company(co));
+            });
+            this.companies.sort((a, b) => a.compareTo(b));
+        }
+        this.contacttypes = [];
+        if (team && team.contacttypes && team.contacttypes.length > 0) {
+            team.contacttypes.forEach(ct => {
+                this.contacttypes.push(new contact_1.Contact(ct));
+            });
+            this.contacttypes.sort((a, b) => a.compareTo(b));
+        }
+        this.specialties = [];
+        if (team && team.specialties && team.specialties.length > 0) {
+            team.specialties.forEach(sp => {
+                this.specialties.push(new specialty_1.Specialty(sp));
+            });
+            this.specialties.sort((a, b) => a.compareTo(b));
+        }
+    }
+    /**
+     * Workcode section (CRUD)
+     */
+    /**
+     * This function will add a new work code to the team's work/leave code list.
+     * @param id The string value for the use code and identifier for the work or leave
+     * code.
+     * @param title The string value for the short explanation of the code.
+     * @param start The numeric value for the hour the work shift normally starts work.
+     * @param shift The string value for any paycode designator
+     * @param isLeave A boolean value to signify if the code is for leaves
+     * @param text A string 6-character hexadecimal value for the color of text for this
+     * code.
+     * @param back A string 6-character hexadecimal value for the color of the background
+     * for this code.
+     * @param search (optional) A string value to search time records to recognize the code.
+     */
+    addWorkcode(id, title, start, shift, isLeave, text, back, search) {
+        if (id !== '') {
+            let found = false;
+            this.workcodes.forEach((wc, w) => {
+                if (wc.id.toLowerCase() === id.toLowerCase()) {
+                    found = true;
+                    const code = new labor_1.Workcode({
+                        id: id,
+                        title: title,
+                        start: start,
+                        shiftCode: shift,
+                        isLeave: isLeave,
+                        textcolor: text,
+                        backcolor: back,
+                        search: search
+                    });
+                    this.workcodes[w] = code;
+                }
+            });
+            if (!found) {
+                const code = new labor_1.Workcode({
+                    id: id,
+                    title: title,
+                    start: start,
+                    shiftCode: shift,
+                    isLeave: isLeave,
+                    textcolor: text,
+                    backcolor: back,
+                    search: search
+                });
+                this.workcodes.push(code);
+            }
+            this.workcodes.sort((a, b) => a.compareTo(b));
+        }
+    }
+    /**
+     * This function is used to update a single work/leave code, based on the identifier,
+     * a field designator and value for that field.
+     * @param id The string value for the identifier of the code to change
+     * @param field The string value to identify the field/data member to update
+     * @param value The string value for the new value.
+     */
+    updateWorkcode(id, field, value) {
+        this.workcodes.forEach((wc, w) => {
+            if (wc.id.toLowerCase() === id.toLowerCase()) {
+                switch (field.toLowerCase()) {
+                    case "id":
+                        wc.id = value;
+                        break;
+                    case "title":
+                        wc.title = value;
+                        break;
+                    case "start":
+                    case "starthour":
+                        wc.start = Number(value);
+                        break;
+                    case "shift":
+                    case "shiftcode":
+                        wc.shiftCode = value;
+                        break;
+                    case "isleave":
+                    case "leave":
+                        wc.isLeave = (value.toLowerCase() === 'true');
+                        break;
+                    case "textcolor":
+                    case "text":
+                        wc.textcolor = value.substring(0, 6);
+                        break;
+                    case "backcolor":
+                    case "back":
+                    case "background":
+                        wc.backcolor = value.substring(0, 6);
+                        break;
+                    case "search":
+                        if (value === '') {
+                            wc.search = undefined;
+                        }
+                        else {
+                            wc.search = value;
+                        }
+                }
+                this.workcodes[w] = wc;
+            }
+        });
+        this.workcodes.sort((a, b) => a.compareTo(b));
+    }
+    /**
+     * This function will delete
+     * @param id The string value for the identifier of the work/leave code to delete
+     */
+    deleteWorkcode(id) {
+        let found = -1;
+        this.workcodes.forEach((wc, w) => {
+            if (wc.id.toLowerCase() === id.toLowerCase()) {
+                found = w;
+            }
+        });
+        if (found >= 0) {
+            this.workcodes.splice(found, 1);
+            this.workcodes.sort((a, b) => a.compareTo(b));
+        }
+    }
+    /**
+     * Contact Types section
+     */
+    /**
+     * This function will add a new contact type, after checking to ensure the contact type
+     * name isn't already listed
+     * @param name The string value for the new contact type.
+     */
+    addContactType(name) {
+        let next = 0;
+        let sort = -1;
+        let found = false;
+        this.contacttypes.forEach(ct => {
+            if (ct.name.toLowerCase() === name.toLowerCase()) {
+                found = true;
+            }
+            if (ct.id > next) {
+                next = ct.id;
+            }
+            if (ct.sort > sort) {
+                sort = ct.sort;
+            }
+        });
+        if (!found) {
+            this.contacttypes.push(new contact_1.Contact({
+                id: next + 1,
+                name: name,
+                sort: sort + 1
+            }));
+            this.contacttypes.sort((a, b) => a.compareTo(b));
+        }
+    }
+    /**
+     * This function will be used to update a contact type within the list
+     * @param id The numeric identifer for the contact type.
+     * @param field The string value to identify the data member to update
+     * @param value The string value for the modification.
+     */
+    updateContactType(id, field, value) {
+        this.contacttypes.sort((a, b) => a.compareTo(b));
+        this.contacttypes.forEach((ct, c) => {
+            if (ct.id === id) {
+                switch (field.toLowerCase()) {
+                    case "name":
+                    case "title":
+                        ct.name = value;
+                        break;
+                    case "move":
+                    case "sort":
+                        if (value.toLowerCase().substring(0, 2) === 'up') {
+                            if (c > 0) {
+                                const other = this.contacttypes[c - 1];
+                                const old = other.sort;
+                                other.sort = ct.sort;
+                                ct.sort = old;
+                                this.contacttypes[c - 1] = other;
+                            }
+                        }
+                        else {
+                            if (c < this.contacttypes.length - 1) {
+                                const other = this.contacttypes[c + 1];
+                                const old = other.sort;
+                                other.sort = ct.sort;
+                                ct.sort = old;
+                                this.contacttypes[c + 1] = other;
+                            }
+                        }
+                        break;
+                }
+                this.contacttypes[c] = ct;
+            }
+        });
+    }
+    /**
+     * This function will remove a designated contact type by identifier from the list.
+     * @param id The numeric identifier to the designated contact type.
+     */
+    deleteContactType(id) {
+        let found = -1;
+        this.contacttypes.forEach((ct, c) => {
+            if (ct.id === id) {
+                found = c;
+            }
+        });
+        if (found >= 0) {
+            this.contacttypes.splice(found, 1);
+        }
+    }
+    /**
+     * This function will add a new specialty type, if the name isn't already in the list.
+     * @param name The string value for the new specialty name.
+     */
+    addSpecialtyType(name) {
+        let next = 0;
+        let sort = -1;
+        let found = false;
+        this.specialties.forEach(sp => {
+            if (sp.name.toLowerCase() === name.toLowerCase()) {
+                found = true;
+            }
+            if (sp.id > next) {
+                next = sp.id;
+            }
+            if (sp.sort > sort) {
+                sort = sp.sort;
+            }
+        });
+        if (!found) {
+            this.specialties.push(new specialty_1.Specialty({
+                id: next + 1,
+                name: name,
+                sort: sort + 1
+            }));
+            this.specialties.sort((a, b) => a.compareTo(b));
+        }
+    }
+    /**
+     * This function will update a specialty type within the list
+     * @param id The numeric value for the identifier for the contact type to update
+     * @param field The string value for the field/data member to update
+     * @param value The string value for the new value.
+     */
+    updateSpecialtyType(id, field, value) {
+        this.specialties.sort((a, b) => a.compareTo(b));
+        this.specialties.forEach((ct, c) => {
+            if (ct.id === id) {
+                switch (field.toLowerCase()) {
+                    case "name":
+                    case "title":
+                        ct.name = value;
+                        break;
+                    case "move":
+                    case "sort":
+                        if (value.toLowerCase().substring(0, 2) === 'up') {
+                            if (c > 0) {
+                                const other = this.specialties[c - 1];
+                                const old = other.sort;
+                                other.sort = ct.sort;
+                                ct.sort = old;
+                                this.specialties[c - 1] = other;
+                            }
+                        }
+                        else {
+                            if (c < this.specialties.length - 1) {
+                                const other = this.specialties[c + 1];
+                                const old = other.sort;
+                                other.sort = ct.sort;
+                                ct.sort = old;
+                                this.specialties[c + 1] = other;
+                            }
+                        }
+                        break;
+                }
+                this.specialties[c] = ct;
+            }
+        });
+    }
+    /**
+     * This function will remove a specialty type from the list.
+     * @param id The numeric value for the identifier to remove.
+     */
+    deleteSpecialtyType(id) {
+        let found = -1;
+        this.specialties.forEach((ct, c) => {
+            if (ct.id === id) {
+                found = c;
+            }
+        });
+        if (found >= 0) {
+            this.specialties.splice(found, 1);
+        }
+    }
+}
+exports.Team = Team;

package/users/index.d.ts

@@ -0,0 +1,2 @@
+export * from './user';
+export * from './web';

package/users/index.js

@@ -0,0 +1,18 @@
+"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("./user"), exports);
+__exportStar(require("./web"), exports);

package/users/question.d.ts

@@ -0,0 +1,47 @@
+/**
+ * This interface provides the framework for the security question.
+ * Namely, a security question and its encrypted answer.
+ */
+export interface ISecurityQuestion {
+    id: number;
+    question: string;
+    answer: string;
+}
+/**
+ * This class defines a security question object, which implements the
+ * security question interface of question and answer.  It also includes
+ * function to update the question and answer, plus provides a method
+ * of comparing the answer with one provided.
+ */
+export declare class SecurityQuestion implements ISecurityQuestion {
+    id: number;
+    question: string;
+    answer: string;
+    constructor(q?: ISecurityQuestion);
+    /**
+     * This function is used in sorting the security questions, by
+     * first comparing their identified, then the question.
+     * @param other (optional) the other security question to be compared to
+     * @returns A numeric value for whether the question is before (-1)
+     *    or after (1)
+     */
+    compareTo(other?: SecurityQuestion): number;
+    /**
+     * This function is used to update either the question or answer which
+     * is provided in the value.  If the field is answer, the value is
+     * saved encrypted of its lower case equivalent.
+     * @param field A string value to indicate which object field is to be updated
+     * @param value A string value for the update.
+     */
+    update(field: string, value: string): void;
+    /**
+     * This function will check a provided answer, during reset, with the
+     * answer in this object.  It will submit a lower case value for checking
+     * because the answer is orginally the lower case value of the provided
+     * answer.
+     * @param value A string value used during comparision.
+     * @returns A boolean value for whether or not the given value is equal to
+     * the saved value.
+     */
+    compare(value: string): boolean;
+}

package/users/question.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityQuestion = void 0;
+const bcrypt_ts_1 = require("bcrypt-ts");
+/**
+ * This class defines a security question object, which implements the
+ * security question interface of question and answer.  It also includes
+ * function to update the question and answer, plus provides a method
+ * of comparing the answer with one provided.
+ */
+class SecurityQuestion {
+    id;
+    question;
+    answer;
+    constructor(q) {
+        this.id = (q) ? q.id : 0;
+        this.question = (q) ? q.question : '';
+        this.answer = (q) ? q.answer : '';
+    }
+    /**
+     * This function is used in sorting the security questions, by
+     * first comparing their identified, then the question.
+     * @param other (optional) the other security question to be compared to
+     * @returns A numeric value for whether the question is before (-1)
+     *    or after (1)
+     */
+    compareTo(other) {
+        if (other) {
+            if (this.id === other.id) {
+                return (this.question < other.question) ? -1 : 1;
+            }
+            return (this.id < other.id) ? -1 : 1;
+        }
+        return -1;
+    }
+    /**
+     * This function is used to update either the question or answer which
+     * is provided in the value.  If the field is answer, the value is
+     * saved encrypted of its lower case equivalent.
+     * @param field A string value to indicate which object field is to be updated
+     * @param value A string value for the update.
+     */
+    update(field, value) {
+        switch (field.toLowerCase()) {
+            case "question":
+                this.question = value;
+                break;
+            case "answer":
+                const salt = (0, bcrypt_ts_1.genSaltSync)(12);
+                const result = (0, bcrypt_ts_1.hashSync)(value.toLowerCase(), salt);
+                this.answer = result;
+                break;
+        }
+    }
+    /**
+     * This function will check a provided answer, during reset, with the
+     * answer in this object.  It will submit a lower case value for checking
+     * because the answer is orginally the lower case value of the provided
+     * answer.
+     * @param value A string value used during comparision.
+     * @returns A boolean value for whether or not the given value is equal to
+     * the saved value.
+     */
+    compare(value) {
+        return (0, bcrypt_ts_1.compareSync)(value.toLowerCase(), this.answer);
+    }
+}
+exports.SecurityQuestion = SecurityQuestion;