scheduler-node-models 1.1.37 → 1.1.44

package/scheduler/teams/company/holiday.d.ts

@@ -1,61 +0,0 @@
-export declare enum HolidayType {
-    holiday = "H",
-    floating = "F"
-}
-/**
- * This interface holds a listed company holiday and the data members involved.  The
- * id is either H for regular, date determined holiday and F for floating or date-less
- * holiday.  The sort value is the sort order within the company's H and F types holidays.
- */
-export interface IHoliday {
-    id: HolidayType;
-    name: string;
-    sort: number;
-    actualdates?: Date[];
-}
-/**
- * This class definition implements the holiday interface and add needed actions to
- * manipulate the holiday object.
- */
-export declare class Holiday implements IHoliday {
-    id: HolidayType;
-    name: string;
-    sort: number;
-    actualdates: Date[];
-    constructor(hol?: IHoliday);
-    /**
-     * This function will provide string for the combined id and sort code into a single
-     * string value.
-     * @returns A string value for the id and sort code.
-     */
-    toString(): string;
-    /**
-     * This function is used in sorting holidays by comparing their ids and sort values
-     * @param other The holiday object used in comparison
-     * @returns A numeric value for relative location compared to other (-1 before, 1 after).
-     */
-    compareTo(other?: Holiday): 1 | -1;
-    /**
-     * This function will retrieve any set date for the actual holiday, based on the year
-     * provided.
-     * @param year The numeric (integer) value for the 4-digit year
-     * @returns A date object or undefined for the set day of the year.
-     */
-    getActual(year: number): Date | undefined;
-    /**
-     * The function will add a new date to the actuals list, if not already present.
-     * @param date The date object to add.
-     */
-    addActual(date: Date): void;
-    /**
-     * The function will remove a date from the actuals list.
-     * @param date The date object to remove.
-     */
-    deleteActual(date: Date): void;
-    /**
-     * This function will check the holiday's actual dates for dates before a cutoff date
-     * and remove them from the object.
-     * @param date The date object used as a cutoff for the purged dates.
-     */
-    purge(date: Date): void;
-}

package/scheduler/teams/company/holiday.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Holiday = exports.HolidayType = void 0;
-var HolidayType;
-(function (HolidayType) {
-    HolidayType["holiday"] = "H";
-    HolidayType["floating"] = "F";
-})(HolidayType || (exports.HolidayType = HolidayType = {}));
-/**
- * This class definition implements the holiday interface and add needed actions to
- * manipulate the holiday object.
- */
-class Holiday {
-    id;
-    name;
-    sort;
-    actualdates;
-    constructor(hol) {
-        this.id = (hol) ? hol.id : HolidayType.holiday;
-        this.name = (hol) ? hol.name : '';
-        this.sort = (hol) ? hol.sort : 0;
-        this.actualdates = [];
-        if (hol && hol.actualdates && hol.actualdates.length > 0) {
-            hol.actualdates.forEach(dt => {
-                this.actualdates.push(new Date(dt));
-            });
-            this.actualdates.sort((a, b) => (a.getTime() < b.getTime()) ? -1 : 1);
-        }
-    }
-    /**
-     * This function will provide string for the combined id and sort code into a single
-     * string value.
-     * @returns A string value for the id and sort code.
-     */
-    toString() {
-        return `${this.id}${this.sort}`.toUpperCase();
-    }
-    /**
-     * This function is used in sorting holidays by comparing their ids and sort values
-     * @param other The holiday object used in comparison
-     * @returns A numeric value for relative location compared to other (-1 before, 1 after).
-     */
-    compareTo(other) {
-        if (other) {
-            if (this.id.toLowerCase() === other.id.toLowerCase()) {
-                return (this.sort < other.sort) ? -1 : 1;
-            }
-            return (this.id.toLowerCase() === 'h') ? -1 : 1;
-        }
-        return -1;
-    }
-    /**
-     * This function will retrieve any set date for the actual holiday, based on the year
-     * provided.
-     * @param year The numeric (integer) value for the 4-digit year
-     * @returns A date object or undefined for the set day of the year.
-     */
-    getActual(year) {
-        let answer = undefined;
-        const start = new Date(Date.UTC(year, 0, 1));
-        const end = new Date(Date.UTC(year + 1, 0, 1));
-        this.actualdates.forEach(dt => {
-            if (dt.getTime() >= start.getTime() && dt.getTime() < end.getTime()) {
-                answer = new Date(dt);
-            }
-        });
-        return answer;
-    }
-    /**
-     * The function will add a new date to the actuals list, if not already present.
-     * @param date The date object to add.
-     */
-    addActual(date) {
-        let found = false;
-        this.actualdates.forEach(ad => {
-            if (ad.getUTCFullYear() === date.getUTCFullYear()
-                && ad.getUTCMonth() === date.getUTCMonth()
-                && ad.getUTCDate() === date.getUTCDate()) {
-                found = true;
-            }
-        });
-        this.actualdates.push(new Date(date));
-    }
-    /**
-     * The function will remove a date from the actuals list.
-     * @param date The date object to remove.
-     */
-    deleteActual(date) {
-        let found = -1;
-        this.actualdates.forEach((ad, a) => {
-            if (ad.getUTCFullYear() === date.getUTCFullYear()
-                && ad.getUTCMonth() === date.getUTCMonth()
-                && ad.getUTCDate() === date.getUTCDate()) {
-                found = a;
-            }
-        });
-        if (found >= 0) {
-            this.actualdates.splice(found, 1);
-        }
-    }
-    /**
-     * This function will check the holiday's actual dates for dates before a cutoff date
-     * and remove them from the object.
-     * @param date The date object used as a cutoff for the purged dates.
-     */
-    purge(date) {
-        for (let i = this.actualdates.length - 1; i >= 0; i--) {
-            if (this.actualdates[i].getTime() < date.getTime()) {
-                // checking to see if the actual date is before the cutoff date given.
-                // if so, remove it from the list.
-                this.actualdates.splice(i, 1);
-            }
-        }
-    }
-}
-exports.Holiday = Holiday;

package/scheduler/teams/company/index.d.ts

@@ -1,3 +0,0 @@
-export * from './holiday';
-export * from './modperiod';
-export * from './company';

package/scheduler/teams/company/index.js

@@ -1,19 +0,0 @@
-"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("./holiday"), exports);
-__exportStar(require("./modperiod"), exports);
-__exportStar(require("./company"), exports);

package/scheduler/teams/company/modperiod.d.ts

@@ -1,21 +0,0 @@
-/**
- * This interface defines a company's modified work period for pay recording.  The
- * modified work period is to ensure employee's can't carry over modified time from one
- * fiscal period to another, so it has definitive start and ending dates.
- */
-export interface IModPeriod {
-    year: number;
-    start: Date;
-    end: Date;
-}
-/**
- * This class defines the implementation of the company's modified work period, plus an
- * action to sort the periods with.
- */
-export declare class ModPeriod implements IModPeriod {
-    year: number;
-    start: Date;
-    end: Date;
-    constructor(mod?: IModPeriod);
-    compareTo(other?: ModPeriod): number;
-}

package/scheduler/teams/company/modperiod.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModPeriod = void 0;
-/**
- * This class defines the implementation of the company's modified work period, plus an
- * action to sort the periods with.
- */
-class ModPeriod {
-    year;
-    start;
-    end;
-    constructor(mod) {
-        this.year = (mod) ? mod.year : 0;
-        this.start = (mod) ? new Date(mod.start) : new Date(0);
-        this.end = (mod) ? new Date(mod.end) : new Date(0);
-    }
-    compareTo(other) {
-        if (other) {
-            return (this.year < other.year) ? -1 : 1;
-        }
-        return -1;
-    }
-}
-exports.ModPeriod = ModPeriod;

package/scheduler/teams/contact.d.ts

@@ -1,18 +0,0 @@
-/**
- * This interface defines the data members for a contact type.
- */
-export interface IContact {
-    id: number;
-    name: string;
-    sort: number;
-}
-/**
- * this class defines the implementation of the contact type plus actions
- */
-export declare class Contact implements IContact {
-    id: number;
-    name: string;
-    sort: number;
-    constructor(co?: IContact);
-    compareTo(other?: Contact): number;
-}

package/scheduler/teams/contact.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Contact = void 0;
-/**
- * this class defines the implementation of the contact type plus actions
- */
-class Contact {
-    id;
-    name;
-    sort;
-    constructor(co) {
-        this.id = (co) ? co.id : 0;
-        this.name = (co) ? co.name : '';
-        this.sort = (co) ? co.sort : 0;
-    }
-    compareTo(other) {
-        if (other) {
-            return (this.sort < other.sort) ? -1 : 1;
-        }
-        return -1;
-    }
-}
-exports.Contact = Contact;

package/scheduler/teams/index.d.ts

@@ -1,3 +0,0 @@
-export * from './contact';
-export * from './specialty';
-export * from './team';

package/scheduler/teams/index.js

@@ -1,19 +0,0 @@
-"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("./contact"), exports);
-__exportStar(require("./specialty"), exports);
-__exportStar(require("./team"), exports);

package/scheduler/teams/specialty.d.ts

@@ -1,18 +0,0 @@
-/**
- * This interface defines the data members for a specialty
- */
-export interface ISpecialty {
-    id: number;
-    name: string;
-    sort: number;
-}
-/**
- * This class defines the implementation of the specialty infterface plus action.
- */
-export declare class Specialty implements ISpecialty {
-    id: number;
-    name: string;
-    sort: number;
-    constructor(sp?: ISpecialty);
-    compareTo(other?: Specialty): number;
-}

package/scheduler/teams/specialty.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Specialty = void 0;
-/**
- * This class defines the implementation of the specialty infterface plus action.
- */
-class Specialty {
-    id;
-    name;
-    sort;
-    constructor(sp) {
-        this.id = (sp) ? sp.id : 0;
-        this.sort = (sp) ? sp.sort : 0;
-        this.name = (sp) ? sp.name : '';
-    }
-    compareTo(other) {
-        if (other) {
-            return (this.sort < other.sort) ? -1 : 1;
-        }
-        return -1;
-    }
-}
-exports.Specialty = Specialty;

package/scheduler/teams/team.d.ts

@@ -1,95 +0,0 @@
-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;
-}