scheduler-node-models 1.2.1 → 1.2.3

package/users/user.d.ts

@@ -0,0 +1,150 @@
+import { ISecurityQuestion, SecurityQuestion } from './question';
+/**
+ * The user class and interface.
+ */
+/**
+ * This interface ensures all the required fields are present to represent the user and
+ * its class object.
+ */
+export interface IUser {
+    _id?: string;
+    id: string;
+    emailAddress: string;
+    password?: string;
+    passwordExpires: Date;
+    badAttempts: number;
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    workgroups: string[];
+    resettoken?: string;
+    resettokenexp?: Date;
+    additionalEmails?: string[];
+    questions?: ISecurityQuestion[];
+}
+/**
+ * This class represents a user and all the actions available to the user object.
+ * The main class members are:
+ * id (primary key),
+ * email address (used in authentication and email messages for reset),
+ * password (authentication), password expires (old use -
+ * to determine the when the password would expire, but new use is to track when
+ * created to allow for the warning to change after 90 days and requiring after 1 year),
+ * badAttempts (count of number of mismatch of password since last known good
+ * authentication),
+ * first, middle and last names (name - middle is optional),
+ * workgroups (string array to provide identificationn of permission within an
+ * application),
+ * resetToken and resettokenexp (a storage location or a reset token used in forgot
+ * password change, plus token expiration date/time the reset token expires)
+ */
+export declare class User implements IUser {
+    id: string;
+    emailAddress: string;
+    password?: string;
+    passwordExpires: Date;
+    badAttempts: number;
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    workgroups: string[];
+    resettoken?: string;
+    resettokenexp?: Date;
+    additionalEmails: string[];
+    questions: SecurityQuestion[];
+    constructor(user?: IUser);
+    /**
+     * This function is used to sort this class' objects into an ordered list.  The order
+     * is determined by last, first and middle names
+     * @param other Another user object used during comparison
+     * @returns a numeric value to show the object is before or after the other object.
+     * -1 is for before and 1 is for after.
+     */
+    compareTo(other?: User): number;
+    /**
+     * This function provides a copy of the user object to the web client.  We don't want to
+     * pass the password, reset token or expiration date/time.
+     * @returns A new User interface for passing
+     */
+    cloneForOutput(): IUser;
+    /**
+     * This function will reset the password, bad attemtps and expiration date.  The new
+     * password will be excrypted for storage.
+     * @param passwd The string value for the new password
+     */
+    setPassword(passwd: string): void;
+    /**
+     * This function will be used in authentication to verify if the password provided is
+     * equivelent to the stored one.
+     * @param pwd The string value to compare against the encrypted password.
+     * @throws An error if the account is locked or there is a mismatch with the password.
+     */
+    checkPassword(pwd: string): void;
+    /**
+     * This function will provide a random 16 character password.
+     * @returns A string value representing the new random password.
+     */
+    createRandomPassword(): string;
+    /**
+     * This function will unlock the user account to allow for access.
+     */
+    unlock(): void;
+    /**
+     * This function will provide the user's name in the form first middle and last.
+     * @returns A string value for the user's name.
+     */
+    getFullName(): string;
+    /**
+     * This function will provide the user's name in the form first last.
+     * @returns A string value for the user's name.
+     */
+    getFirstLast(): string;
+    /**
+     * This function will provide the user's name in the form last, first.
+     * @returns A string value for the user's name.
+     */
+    getLastFirst(): string;
+    /**
+     * This function will create a random string used as a token to reset the user's
+     * password when the user had forgotten it.  It will be emailed to the user's
+     * email addresses.  The token will be good for 1 hour, so an expiration date/time
+     * is also set.
+     * @returns A string value for the reset token.
+     */
+    createResetToken(): string;
+    /**
+     * This function will verify the provided string token in comparison to that recorded
+     * in the user's record.  The process also checks to ensure the token isn't expired.
+     * @param token A string value for the comparison token.
+     * @returns A boolean value to indicate if the token matches and not expired.
+     */
+    checkResetToken(token: string): boolean;
+    /**
+     * This function will add a new email address, if it isn't already in the list
+     * @param email The string value for the email to add.
+     */
+    addAdditionalEmail(email: string): void;
+    /**
+     * This function will remove an email address from the user's additional email
+     * address list.
+     * @param email The string value for the email to remove.
+     */
+    deleteAdditionalEmail(email: string): void;
+    /**
+     * This function will update a security question question or answer
+     * based on the identifier, field and value provided.
+     * @param id A numeric value for the identifier of the question.
+     * @param field A string value for the field (question or answer) to be
+     * updated.
+     * @param value A string value for the updated value for the field.
+     */
+    updateSecurityQuestion(id: number, field: string, value: string): void;
+    /**
+     * This function is used to check the response for a security question
+     * answer to the stored value.
+     * @param id A numeric value for the question to check against.
+     * @param value A string value for the answer to the question.
+     * @returns A boolean value for whether the answers match.
+     */
+    checkSecurityQuestion(id: number, value: string): boolean;
+}

package/users/user.js

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const bcrypt_ts_1 = require("bcrypt-ts");
+const question_1 = require("./question");
+/**
+ * This class represents a user and all the actions available to the user object.
+ * The main class members are:
+ * id (primary key),
+ * email address (used in authentication and email messages for reset),
+ * password (authentication), password expires (old use -
+ * to determine the when the password would expire, but new use is to track when
+ * created to allow for the warning to change after 90 days and requiring after 1 year),
+ * badAttempts (count of number of mismatch of password since last known good
+ * authentication),
+ * first, middle and last names (name - middle is optional),
+ * workgroups (string array to provide identificationn of permission within an
+ * application),
+ * resetToken and resettokenexp (a storage location or a reset token used in forgot
+ * password change, plus token expiration date/time the reset token expires)
+ */
+class User {
+    id;
+    emailAddress;
+    password;
+    passwordExpires;
+    badAttempts;
+    firstName;
+    middleName;
+    lastName;
+    workgroups;
+    resettoken;
+    resettokenexp;
+    additionalEmails;
+    questions;
+    constructor(user) {
+        this.id = (user && user.id) ? user.id : '';
+        if (this.id === '') {
+            this.id = (user && user._id) ? user._id.toString() : '';
+        }
+        this.emailAddress = (user) ? user.emailAddress : '';
+        this.password = (user) ? user.password : undefined;
+        this.passwordExpires = (user) ? new Date(user.passwordExpires) : new Date();
+        this.badAttempts = (user) ? user.badAttempts : 0;
+        this.firstName = (user) ? user.firstName : '';
+        this.middleName = (user) ? user.middleName : undefined;
+        this.lastName = (user) ? user.lastName : '';
+        this.workgroups = [];
+        if (user) {
+            user.workgroups.forEach(wg => {
+                this.workgroups.push(wg);
+            });
+            user.workgroups.sort((a, b) => (a < b) ? -1 : 1);
+        }
+        this.resettoken = (user && user.resettoken) ? user.resettoken : undefined;
+        this.resettokenexp = (user && user.resettokenexp)
+            ? new Date(user.resettokenexp) : undefined;
+        this.additionalEmails = [];
+        if (user && user.additionalEmails) {
+            user.additionalEmails.forEach(em => {
+                this.additionalEmails?.push(em);
+            });
+            this.additionalEmails.sort();
+        }
+        this.questions = [];
+        if (user && user.questions) {
+            user.questions.forEach(quest => {
+                this.questions.push(new question_1.SecurityQuestion(quest));
+            });
+            this.questions.sort((a, b) => a.compareTo(b));
+        }
+        else {
+            for (let i = 1; i < 4; i++) {
+                this.questions.push(new question_1.SecurityQuestion({
+                    id: i, question: '', answer: ''
+                }));
+            }
+        }
+    }
+    /**
+     * This function is used to sort this class' objects into an ordered list.  The order
+     * is determined by last, first and middle names
+     * @param other Another user object used during comparison
+     * @returns a numeric value to show the object is before or after the other object.
+     * -1 is for before and 1 is for after.
+     */
+    compareTo(other) {
+        if (other) {
+            if (other.lastName === this.lastName) {
+                if (other.firstName === this.firstName) {
+                    if (this.middleName && other.middleName) {
+                        return (this.middleName < other.middleName) ? -1 : 1;
+                    }
+                    else if (!this.middleName) {
+                        return -1;
+                    }
+                    else {
+                        return 1;
+                    }
+                }
+                return (this.firstName < other.firstName) ? -1 : 1;
+            }
+            return (this.lastName < other.lastName) ? -1 : 1;
+        }
+        return -1;
+    }
+    /**
+     * This function provides a copy of the user object to the web client.  We don't want to
+     * pass the password, reset token or expiration date/time.
+     * @returns A new User interface for passing
+     */
+    cloneForOutput() {
+        const output = new User(this);
+        output.password = undefined;
+        output.resettoken = undefined;
+        output.resettokenexp = undefined;
+        return output;
+    }
+    /**
+     * This function will reset the password, bad attemtps and expiration date.  The new
+     * password will be excrypted for storage.
+     * @param passwd The string value for the new password
+     */
+    setPassword(passwd) {
+        const salt = (0, bcrypt_ts_1.genSaltSync)(12);
+        const result = (0, bcrypt_ts_1.hashSync)(passwd, salt);
+        this.password = result;
+        this.passwordExpires = new Date();
+        this.badAttempts = 0;
+    }
+    /**
+     * This function will be used in authentication to verify if the password provided is
+     * equivelent to the stored one.
+     * @param pwd The string value to compare against the encrypted password.
+     * @throws An error if the account is locked or there is a mismatch with the password.
+     */
+    checkPassword(pwd) {
+        if (this.password && (0, bcrypt_ts_1.compareSync)(pwd, this.password)) {
+            if (this.badAttempts > 2) {
+                throw new Error("Account Locked");
+            }
+            this.badAttempts = 0;
+            return;
+        }
+        else {
+            this.badAttempts++;
+            throw new Error("Account Mismatch");
+        }
+    }
+    /**
+     * This function will provide a random 16 character password.
+     * @returns A string value representing the new random password.
+     */
+    createRandomPassword() {
+        let result = '';
+        const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
+            + '0123456789';
+        const charLength = characters.length;
+        for (let i = 0; i < 16; i++) {
+            result += characters.charAt(Math.floor(Math.random() * charLength));
+        }
+        this.setPassword(result);
+        this.badAttempts = -1;
+        return result;
+    }
+    /**
+     * This function will unlock the user account to allow for access.
+     */
+    unlock() {
+        this.badAttempts = 0;
+    }
+    /**
+     * This function will provide the user's name in the form first middle and last.
+     * @returns A string value for the user's name.
+     */
+    getFullName() {
+        if (!this.middleName) {
+            return this.firstName + ' ' + this.lastName;
+        }
+        return this.firstName + ' ' + this.middleName.substring(0, 1) + '. '
+            + this.lastName;
+    }
+    /**
+     * This function will provide the user's name in the form first last.
+     * @returns A string value for the user's name.
+     */
+    getFirstLast() {
+        return this.firstName + ' ' + this.lastName;
+    }
+    /**
+     * This function will provide the user's name in the form last, first.
+     * @returns A string value for the user's name.
+     */
+    getLastFirst() {
+        return this.lastName + ', ' + this.firstName;
+    }
+    /**
+     * This function will create a random string used as a token to reset the user's
+     * password when the user had forgotten it.  It will be emailed to the user's
+     * email addresses.  The token will be good for 1 hour, so an expiration date/time
+     * is also set.
+     * @returns A string value for the reset token.
+     */
+    createResetToken() {
+        let result = '';
+        const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
+            + '0123456789';
+        const charLength = characters.length;
+        for (let i = 0; i < 16; i++) {
+            result += characters.charAt(Math.floor(Math.random() * charLength));
+        }
+        let now = new Date();
+        this.resettokenexp = new Date(now.getTime() + 3600000);
+        this.resettoken = result;
+        return result;
+    }
+    /**
+     * This function will verify the provided string token in comparison to that recorded
+     * in the user's record.  The process also checks to ensure the token isn't expired.
+     * @param token A string value for the comparison token.
+     * @returns A boolean value to indicate if the token matches and not expired.
+     */
+    checkResetToken(token) {
+        const now = new Date();
+        if (this.resettoken && this.resettokenexp) {
+            if (this.resettoken === token
+                && now.getTime() < this.resettokenexp?.getTime()) {
+                return true;
+            }
+            else {
+                if (this.resettokenexp.getTime() < now.getTime()) {
+                    throw new Error("Reset Token Expired");
+                }
+                throw new Error("Reset Token Error");
+            }
+        }
+        return false;
+    }
+    /**
+     * This function will add a new email address, if it isn't already in the list
+     * @param email The string value for the email to add.
+     */
+    addAdditionalEmail(email) {
+        let found = false;
+        this.additionalEmails.forEach(em => {
+            if (em.toLowerCase() === email.toLowerCase()) {
+                found = true;
+            }
+        });
+        if (!found) {
+            this.additionalEmails.push(email);
+            this.additionalEmails.sort();
+        }
+    }
+    /**
+     * This function will remove an email address from the user's additional email
+     * address list.
+     * @param email The string value for the email to remove.
+     */
+    deleteAdditionalEmail(email) {
+        let found = -1;
+        this.additionalEmails.forEach((em, e) => {
+            if (em.toLowerCase() === email.toLowerCase()) {
+                found = e;
+            }
+        });
+        if (found >= 0) {
+            this.additionalEmails.splice(found, 1);
+        }
+    }
+    /**
+     * This function will update a security question question or answer
+     * based on the identifier, field and value provided.
+     * @param id A numeric value for the identifier of the question.
+     * @param field A string value for the field (question or answer) to be
+     * updated.
+     * @param value A string value for the updated value for the field.
+     */
+    updateSecurityQuestion(id, field, value) {
+        this.questions.forEach((quest, i) => {
+            if (quest.id === id) {
+                quest.update(field, value);
+                this.questions[i] = quest;
+            }
+        });
+    }
+    /**
+     * This function is used to check the response for a security question
+     * answer to the stored value.
+     * @param id A numeric value for the question to check against.
+     * @param value A string value for the answer to the question.
+     * @returns A boolean value for whether the answers match.
+     */
+    checkSecurityQuestion(id, value) {
+        let answer = false;
+        this.questions.forEach(quest => {
+            if (quest.id === id) {
+                answer = quest.compare(value);
+            }
+        });
+        return answer;
+    }
+}
+exports.User = User;

package/users/web.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This interface will be used to authenticate with the application through the api
+ * server.
+ */
+export interface AuthenticationRequest {
+    emailAddress: string;
+    password: string;
+    application?: string;
+}
+/**
+ * This interface will be used between the client and the api server to request a new
+ * user.  All fields are required.
+ */
+export interface AddUserRequest {
+    emailAddress: string;
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    password: string;
+    application: string;
+    permissions?: string[];
+}
+/**
+ * This interface will be used to update a user with a call from the client to the
+ * api server.  All fields would be required.
+ */
+export interface UpdateUserRequest {
+    id: string;
+    field: string;
+    value: string;
+    subid: number;
+}
+/**
+ * This interface is used in the first part of the forgot password process where the
+ * requestor passes his/her email address used as the user identifier for the account.
+ */
+export interface ForgotPasswordRequest {
+    emailAddress: string;
+}
+/**
+ * This interface is used in the second part of the forgot password process, to provide
+ * the user's account email address, password and the passed reset token sent via email
+ * to the user's accounts.
+ */
+export interface PasswordResetRequest {
+    emailAddress: string;
+    password: string;
+    resettoken: string;
+}

package/users/web.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });