@tamu-dor/famis-db 1.3.3 → 2.0.2

package/index.js

@@ -1,6 +1,6 @@
 const knex = require('knex');
-const cuid = require('cuid');
-const { map } = require('awaity');
+const { createId } = require('@paralleldrive/cuid2');
+const { each, map } = require('awaity');
 const revisionHash = require('rev-hash');
 
 const famisInvoiceNumbers = [
@@ -80,6 +80,15 @@ class FAMISDb {
     this.db = knex({
       client: 'pg',
       connection: config,
+      pool: {
+        min: 0,
+        max: 10,
+        createTimeoutMillis: 30000,
+        acquireTimeoutMillis: 30000,
+        idleTimeoutMillis: 30000,
+        reapIntervalMillis: 1000,
+        createRetryIntervalMillis: 100,
+      },
     });
     this.people = people;
   }
@@ -114,30 +123,53 @@ class FAMISDb {
   /**
    *
    * Process an invoice to have all necessary relationships
-   * @param {object} invoice
-   * @returns{Promise<object>} invoice object
+   * @param {object} invoice - the invoice object sent by iLab
+   * @param {boolean} [historical=false] - if true use historical accounts too
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
-  async processInvoice(invoice) {
+  async processInvoice(invoice, historical=false) {
     // console.log(invoice);
-    const account = getCoreAccountNumber(invoice.data.details[0].famis);
-    invoice.core = await this.getCoreByAccount(account);
-    if (invoice.core) {
-      invoice.core.systemPart = await this.getSystemById(invoice.core.systemId);
-    } else {
-      const e = Error(`Revenue account ${account} is not associated with a core.`)
-      throw(e);
-    }
-    const customerAccountNumber = this.getAccountNumber(invoice.data.details[0].famis, invoice.replace_data);
-    invoice.isIdt = customerAccountNumber && (customerAccountNumber.accountNumber.substring(0,2) === account.substring(0,2));
-    invoice.customerAccountInfo = await this.getByAccountNumber(customerAccountNumber.accountNumber);
-    invoice.poNumber = customerAccountNumber.poNumber;
-    invoice.customerAccount = customerAccountNumber.accountNumber;
-    if (invoice.customerAccountInfo && this.people) {
-      const pi = invoice.customerAccountInfo.uin ? await this.people.getByUin(invoice.customerAccountInfo.uin) : [];
-      if (pi.length) {
-        invoice.pi = JSON.parse(JSON.stringify(pi[0]));
+    try {
+      const account = getCoreAccountNumber(invoice.data.details[0].famis);
+      invoice.core = await this.getCoreByAccount(account);
+      if (invoice.core) {
+        invoice.core.systemPart = await this.getSystemById(invoice.core.systemId);
+      } else {
+        const e = Error(`Revenue account ${account} is not associated with a core.`)
+        throw(e);
       }
+      const campus = account.substring(0,2);
+      const revenuAccount = await this.getByAccountNumber(account, campus, historical);
+      const customerAccountNumber = this.getAccountNumber(invoice.data.details[0].famis, invoice.replace_data);
+      invoice.customerAccountInfo = await this.getByAccountNumber(customerAccountNumber.accountNumber, campus, historical);
+      if (invoice.customerAccountInfo) {
+        let idtAllowed = 'idt_allowed' in invoice.customerAccountInfo && invoice.customerAccountInfo.idt_allowed !== null ?
+          invoice.customerAccountInfo.idt_allowed :
+          'parent_account_idt_allowed' in invoice.customerAccountInfo && invoice.customerAccountInfo.parent_account_idt_allowed;
+        idtAllowed = idtAllowed &&
+          !( invoice.replace_data &&
+            typeof invoice.replace_data === 'object' &&
+            invoice.replace_data.forcedAr
+          );
+        const isIdt = customerAccountNumber && (customerAccountNumber.accountNumber.substring(0,2) === account.substring(0,2)) && idtAllowed;
+        invoice.isIdt = isIdt;
+      } else {
+        invoice.isIdt = false;
+      }
+      let poNumber = (customerAccountNumber.accountNumber.substring(0,2) !== '68') ? `${campus}-${revenuAccount.department}` : customerAccountNumber.poNumber;
+      invoice.poNumber = poNumber;
+      invoice.customerAccount = customerAccountNumber.accountNumber;
+      if (invoice.customerAccountInfo && this.people) {
+        const pi = invoice.customerAccountInfo.uin ? await this.people.getByUin(invoice.customerAccountInfo.uin) : [];
+        if (pi.length) {
+          invoice.pi = JSON.parse(JSON.stringify(pi[0]));
+        }
+      }
+      invoice.highRiskInfo = await this.isSrsHighRisk(invoice);
+      invoice.comments = await this.getInvoiceComments(invoice.uid);
+    } catch (e) {
+      throw e;
     }
     return invoice;
   }
@@ -147,7 +179,7 @@ class FAMISDb {
    *
    * Get invoice by uid
    * @param {string} uid
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async getInvoiceByUid(uid) {
@@ -170,7 +202,7 @@ class FAMISDb {
    *
    * Get invoice by originating system assigned number
    * @param {string} number
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async getInvoiceByNumber(number) {
@@ -178,10 +210,10 @@ class FAMISDb {
     let retVal;
 
     try {
-      records = await this.db('invoices').where('number', number);
+      records = await this.db('invoices').whereILike('number', `${number}%`);
       if (records.length) {
         retVal = this.processInvoice(records[0]);
-      } 
+      }
     } catch (e) {
       throw e;
     }
@@ -192,7 +224,7 @@ class FAMISDb {
    *
    * Get invoice by fingerprint
    * @param {string} fingerPrint
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async getInvoiceByFingerPrint(fingerPrint) {
@@ -214,7 +246,7 @@ class FAMISDb {
    *
    * Get all invoices associated with a specified account number
    * @param {string} accountNumber
-   * @returns{Promise<array>} invoice objects
+   * @returns {Promise<array>} invoice objects
    * @memberof FAMISDb
    */
   async getInvoicesByAccount(accountNumber) {
@@ -254,35 +286,51 @@ class FAMISDb {
    * @param {string} [orderBy='date']
    * @param {string} [dir='desc']
    * @param {boolean} [deleted=false]
-   * @returns{Promise<array>} invoice objects
+   * @param {integer} [page=null]
+   * @param {integer} [limit=null]
+   * @returns {Promise<array>} invoice objects
    * @memberof FAMISDb
    */
-  async getAllInvoices(orderBy='date', dir='desc', deleted=false) {
+  async getAllInvoices(orderBy='date', dir='desc', deleted=false, page=null, limit=null) {
     const self = this;
     let records;
+    let metadata;
     try {
       const sql = this.db('invoices')
+      const meta = this.db('invoices');
       if (!deleted) {
-        sql.whereNull('deleted')
+        sql.whereNull('deleted');
+        meta.whereNull('deleted');
+      }
+      //console.log(page, limit);
+      if (page && limit) {
+        sql.limit(limit).offset((page-1)*limit);
       }
       records = await sql.orderBy(orderBy, dir);
+      metadata = await meta.orderBy(orderBy, dir);
+      //console.log(records);
       records = await map(
         records,
         async (record) => {
-          const rec = self.processInvoice(record);
+          const rec = self.processInvoice(record, true);
           return rec;
         }
       );
     } catch (e) {
       throw e;
     }
-    return records;
+    return {
+      records,
+      metadata: {
+        total: metadata.length,
+      },
+    }
   }
 
   /**
    *
    * Retreives invoices from the latest date
-   * @returns{Promise<array>} invoice objects
+   * @returns {Promise<array>} invoice objects
    * @memberof FAMISDb
    */
   async getLatestInvoices() {
@@ -311,17 +359,27 @@ class FAMISDb {
   /**
    *
    * Returns all held invoices
-   * @returns{Promise<array>} held invoice objects 
+   * @returns {Promise<array>} held invoice objects 
    * @memberof FAMISDb
    */
-  async getHeldInvoices() {
+  async getHeldInvoices(orderBy='date', dir='desc', page=null, limit=null) {
     const self = this;
     let records;
-
+    let metadata;
+    const sql = this.db('invoices');
+    const meta = this.db('invoices');
     try {
-      records = await this.db('invoices')
+      if (page && limit) {
+        sql.limit(limit).offset((page-1)*limit);
+      }
+      records = await sql
         .whereNull('deleted')
-        .andWhere('invoiced', '0');
+        .andWhere('invoiced', '0')
+        .orderBy(orderBy, dir);
+      metadata = await meta
+        .whereNull('deleted')
+        .andWhere('invoiced', '0')
+        .orderBy(orderBy, dir);
       records = await map(
         records,
         async (record) => {
@@ -332,13 +390,18 @@ class FAMISDb {
     } catch (e) {
       throw e;
     }
-    return records;
+    return {
+      records,
+      metadata: {
+        total: metadata.length,
+      },
+    };
   }
 
   /**
    *
    * Returns all awaiting email invoices
-   * @returns{Promise<array>} awaiting email invoice objects 
+   * @returns {Promise<array>} awaiting email invoice objects 
    * @memberof FAMISDb
    */
   async getInvoicesAwaitingEmail() {
@@ -366,7 +429,7 @@ class FAMISDb {
    *
    * Search invoices by originating system generated invoice number
    * @param {string} number
-   * @returns{Promise<array>} invoice objects
+   * @returns {Promise<array>} invoice objects
    * @memberof FAMISDb
    */
   async searchInvoicesByNumber(number) {
@@ -397,7 +460,7 @@ class FAMISDb {
    *
    * Search invoices by FAMIS invoice number
    * @param {string} famis
-   * @returns{Promise<array>} invoice objects
+   * @returns {Promise<array>} invoice objects
    * @memberof FAMISDb
    */
   async searchInvoicesByFamis(famis) {
@@ -430,7 +493,7 @@ class FAMISDb {
    * @param {object} invoice
    * @param {string} type
    * @param {string} famisInvoiceNumber
-   * @returns{Promise<object>} invoice
+   * @returns {Promise<object>} invoice
    * @memberof FAMISDb
    */
   async addInvoice(invoice, type, famisInvoiceNumber) {
@@ -459,7 +522,7 @@ class FAMISDb {
           totalAmount: parseFloat(invoice.totalAmount),
           data: JSON.stringify(invoice),
           date: invoice.date,
-          uid: cuid(),
+          uid: createId(),
           fingerprint: invoice.fingerprint,
           type: type,
           famisInvoiceNumber: famisInvoiceNumber,
@@ -478,7 +541,7 @@ class FAMISDb {
    * Updates an invoice
    * @param {string} uid
    * @param {object} invoice
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async updateInvoice(uid, invoice) {
@@ -506,6 +569,7 @@ class FAMISDb {
           customerAccount: this.getAccountNumber(invoice.details[0].famis).accountNumber,
           sellingAccount: getCoreAccountNumber(invoice.details[0].famis),
           fingerprint: invoice.fingerprint ? invoice.fingerprint : null,
+          replace_data: invoice.replace_data,
         })
         .where('uid', uid);
     } catch (e) {
@@ -519,7 +583,7 @@ class FAMISDb {
    * Toggles an invoice as paid 
    * @param {string} uid
    * @param {boolean} invoiced
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async markInvoiced(uid, invoiced) {
@@ -543,7 +607,7 @@ class FAMISDb {
    * Toggles an invoice as emailed 
    * @param {string} uid
    * @param {boolean} emailed
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async markEmailed(uid, emailed) {
@@ -567,7 +631,7 @@ class FAMISDb {
    * Sets an invoice's deletion date
    * @param {string} uid
    * @param {date} deleted
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async setDeleted(uid, deleted) {
@@ -591,7 +655,7 @@ class FAMISDb {
    * Sets an invoice's posted date 
    * @param {string} uid
    * @param {date} postedDate
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async setInvoicePostedDate(uid, postedDate) {
@@ -615,7 +679,7 @@ class FAMISDb {
    * Sets an invoice's fingerprint
    * @param {string} uid
    * @param {string} fingerprint
-   * @returns{Promise<object>} invoice object
+   * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
   async setInvoiceFingerPrint(uid, fingerprint) {
@@ -638,35 +702,40 @@ class FAMISDb {
    *
    * Get PI accounts by account number
    * @param {string} number
-   * @returns{Promise<object>} account object
+   * @param {string} campus
+   * @param {boolean} [historical=false]
+   * @returns {Promise<object>} account object
    * @memberof FAMISDb
    */
-  async getByAccountNumber(number) {
+  async getByAccountNumber(number, campus, historical=false) {
     let records;
     let retVal;
+    let table = historical ? 'accounts_all' : 'accounts'
     const self = this;
 
-    if (!number) console.log('Null account number');
+    if (!number) {
+      throw Error('Null account number');
+    }
     try {
-      records = await this.db('accounts')
+      records = await this.db(`${table}`)
         .leftJoin('departments',
           function() {
             this
-              .on('accounts.department', '=', 'departments.dept')
+              .on(`${table}.department`, '=', 'departments.dept')
               .on('departments.part', '=', self.db.raw('?', [number.substring(0,2)]))
           }
         )
-        .leftJoin('accounts as parent_account',
+        .leftJoin(`${table} as parent_account`,
           function() {
             this
-              .on('accounts.campus_code', '=', 'parent_account.campus_code')
-              .on('accounts.account', '=', 'parent_account.account')
+              .on(`${table}.campus_code`, '=', 'parent_account.campus_code')
+              .on(`${table}.account`, '=', 'parent_account.account')
               .on('parent_account.support_account', '=', self.db.raw('?', ["00000"]))
-              .on('accounts.fiscal_year', '=', 'parent_account.fiscal_year')
+              .on(`${table}.fiscal_year`, '=', 'parent_account.fiscal_year')
           }
         )
         .select(
-          'accounts.*',
+          `${table}.*`,
           'departments.idt_email as billingEmailId',
           'parent_account.idt_allowed as parent_account_idt_allowed'
         )
@@ -674,12 +743,13 @@ class FAMISDb {
         .andWhere(function() {
           this.whereNull('departments.exp_date').orWhere('departments.exp_date', '>', self.db.raw('CURRENT_DATE'))
         })
-        .andWhere('accounts.account_number', number);
+        .andWhere(`${table}.account_number`, number);
       if (records.length) {
         retVal = records[0];
       } else {
         records = await this.db('customers')
-          .where('account_number', number);
+          .where('account_number', number)
+          .andWhere('campus_code', campus);
         if (records.length) {
           retVal = Object.assign(
             {},
@@ -690,7 +760,7 @@ class FAMISDb {
               billingEmailId: records[0].email,
             }
           );
-        } 
+        }
       }
     } catch (e) {
       throw e;
@@ -702,7 +772,7 @@ class FAMISDb {
    *
    * Search PI accounts by partial account number
    * @param {string} number
-   * @returns{Promise<array>} account object(s)
+   * @returns {Promise<array>} account object(s)
    * @memberof FAMISDb
    */
   async searchByAccountNumber(number) {
@@ -745,7 +815,7 @@ class FAMISDb {
    *
    * Get PI Accounts by UIN
    * @param {string} uin
-   * @returns{Promise<array>} account object array
+   * @returns {Promise<array>} account object array
    * @memberof FAMISDb
    */
   async getAccountsByUin(uin) {
@@ -778,7 +848,7 @@ class FAMISDb {
    *
    * Get PI accounts by responsible UIN
    * @param {string} uin
-   * @returns{Promise<array>} account object array
+   * @returns {Promise<array>} account object array
    * @memberof FAMISDb
    */
   async getAccountsByResponsibleUin(uin) {
@@ -811,7 +881,7 @@ class FAMISDb {
    *
    * Get next FAMIS invoice number in sequence for specified invoice type
    * @param {string} invoice
-   * @returns{Promise<string>} next invoice number in sequence
+   * @returns {Promise<string>} next invoice number in sequence
    * @memberof FAMISDb
    */
   async getNextFAMISInvoiceNumber(type) {
@@ -825,7 +895,7 @@ class FAMISDb {
     });
     try {
       retVal = `${prefix.prefix}${prefix.start}`;
-      records = await this.db('invoices').whereIn('type', prefix.aliases).orderBy('famisInvoiceNumber', 'desc').limit(5);
+      records = await this.db('invoices').whereIn('type', prefix.aliases).orderBy('famisInvoiceNumber', 'desc');
       if (records.length) {
         const number = parseInt(records[0].famisInvoiceNumber.substring(1), 10) + 1;
         retVal = `${prefix.prefix}${number}`;
@@ -857,18 +927,18 @@ class FAMISDb {
     return retVal;
   }
 
-   /**
+  /**
    *
-   * Get expense code object
-   * @param {string} code
-   * @returns {Promise<object>} expense code object
+   * Get revenue code object
+   * @param {string} revenue
+   * @returns {Promise<object>} revenue code object
    * @memberof FAMISDb
    */
-   async getExpenseCode(code) {
+  async getRevenueCode(revenue) {
     let records;
     let retVal;
     try {
-      records = await this.db('codes').where('expense', code).orderBy('id', 'desc');
+      records = await this.db('codes').where('revenue', revenue).orderBy('id', 'desc');
       if (records.length) {
         retVal = records[0];
       } 
@@ -878,19 +948,18 @@ class FAMISDb {
     return retVal;
   }
 
-
   /**
    *
-   * Get revenue code object
-   * @param {string} revenue
-   * @returns{Promise<object>} revenue code object
+   * Get expense code object
+   * @param {string} code
+   * @returns {Promise<object>} expense code object
    * @memberof FAMISDb
    */
-  async getRevenueCode(revenue) {
+   async getExpenseCode(code) {
     let records;
     let retVal;
     try {
-      records = await this.db('codes').where('revenue', revenue).orderBy('id', 'desc');
+      records = await this.db('codes').where('expense', code).orderBy('id', 'desc');
       if (records.length) {
         retVal = records[0];
       } 
@@ -906,7 +975,7 @@ class FAMISDb {
    * @param {string} account
    * @param {string} code
    * @param {integer} fiscal
-   * @returns{Promise<boolean>} truthy value
+   * @returns {Promise<boolean>} truthy value
    * @memberof FAMISDb
    */
   async allowableExpenseCode(accountNumber, code, fiscal) {
@@ -953,7 +1022,7 @@ class FAMISDb {
    *
    * Get allowable expense code ranges for specified account
    * @param {string} account
-   * @returns{Promise<boolean>} expense code range object(s)
+   * @returns {Promise<boolean>} expense code range object(s)
    * @memberof FAMISDb
    */
   async getAllowableExpenseCodes(accountNumber, fiscal) {
@@ -1013,7 +1082,7 @@ class FAMISDb {
    *
    * Get core by id
    * @param {string} id
-   * @returns{Promise<object>} core object
+   * @returns {Promise<object>} core object
    * @memberof FAMISDb
    */
   async getCoreById(id) {
@@ -1078,7 +1147,7 @@ class FAMISDb {
    *
    * Get core by account number
    * @param {string} account
-   * @returns{Promise<object>} core object
+   * @returns {Promise<object>} core object
    * @memberof FAMISDb
    */
   async getCoreByAccount(account) {
@@ -1118,7 +1187,7 @@ class FAMISDb {
    *
    * Get core current revenue account number
    * @param {string} coreId
-   * @returns{Promise<object>} core object
+   * @returns {Promise<object>} core object
    * @memberof FAMISDb
    */
   async getCoreCurrentAccount(coreId) {
@@ -1180,7 +1249,7 @@ class FAMISDb {
    *
    * Get system part by ID
    * @param {number} id
-   * @returns{Promise<object>} system part object
+   * @returns {Promise<object>} system part object
    * @memberof FAMISDb
    */
   async getSystemById(id) {
@@ -1201,7 +1270,7 @@ class FAMISDb {
    *
    * Get system part by two digit part number
    * @param {string} number
-   * @returns{Promise<object>} system part object
+   * @returns {Promise<object>} system part object
    * @memberof FAMISDb
    */
   async getSystemByPartNumber(number) {
@@ -1222,7 +1291,7 @@ class FAMISDb {
    *
    * Get all enabled cores
    * @param {string} date
-   * @returns{Promise<array>} core objects
+   * @returns {Promise<array>} core objects
    * @memberof FAMISDb
    */
   async getEnabledCores(date) {
@@ -1283,7 +1352,7 @@ class FAMISDb {
   /**
    *
    * Get all cores
-   * @returns{Promise<array>} core objects
+   * @returns {Promise<array>} core objects
    * @memberof FAMISDb
    */
   async getAllCores() {
@@ -1304,7 +1373,7 @@ class FAMISDb {
    *
    * Get a core's users by core ID
    * @param {number} coreId
-   * @returns{Promise<array>} user objects
+   * @returns {Promise<array>} user objects
    * @memberof FAMISDb
    */
   async getCoreUsers(coreId) {
@@ -1329,7 +1398,7 @@ class FAMISDb {
    *
    * Get a user's cores they manage
    * @param {string} userId
-   * @returns{Promise<array>} core objects
+   * @returns {Promise<array>} core objects
    * @memberof FAMISDb
    */
   async getUserCores(userId) {
@@ -1355,7 +1424,7 @@ class FAMISDb {
    *
    * Get a system part's users by system ID
    * @param {number} systemId
-   * @returns{Promise<array>} user objects
+   * @returns {Promise<array>} user objects
    * @memberof FAMISDb
    */
   async getSystemUsers(systemId) {
@@ -1380,7 +1449,7 @@ class FAMISDb {
    *
    * Get a user's system parts they manage
    * @param {*} userId
-   * @returns{Promise<object>} system objects
+   * @returns {Promise<object>} system objects
    * @memberof FAMISDb
    */
   async getUserSystemParts(userId) {
@@ -1406,7 +1475,7 @@ class FAMISDb {
   /**
    *
    * Get all system parts
-   * @returns{Promise<object>} system objects
+   * @returns {Promise<object>} system objects
    * @memberof FAMISDb
    */
   async getAllSystemParts() {
@@ -1420,11 +1489,27 @@ class FAMISDb {
     return retVal;
   }
 
+  /**
+   *
+   * Get all admin users
+   * @returns {Promise<array>} array of user objects
+   * @memberof FAMISDb
+   */
+   async getAdminUsers() {
+    let retVal;
+    try {
+      retVal = await this.db('users').where('admin', true);
+    } catch (e) {
+      throw e;
+    }
+    return retVal;
+  }
+
   /**
    *
    * Get user
    * @param {string} userId
-   * @returns{Promise<object>} user object
+   * @returns {Promise<object>} user object
    * @memberof FAMISDb
    */
   async getUser(userId) {
@@ -1443,12 +1528,33 @@ class FAMISDb {
     return retVal;
   }
 
+  /**
+   *
+   * Update user
+   * @param {object} user
+   * @returns {Promise<object>} user object
+   * @memberof FAMISDb
+   */
+   async updateUser(user) {
+    let retVal;
+    const columns = ['id', 'userId', 'admin', 'role', 'roleName', 'roleEmail', 'deleted'];
+    try {
+      if ('id' in user) retVal = await this.db('users')
+        .returning(columns)
+        .update(user)
+        .where('id', user.id);
+    } catch (e) {
+      throw e;
+    }
+    return retVal;
+  }
+
   /**
    *
    * Get customer by customer account number
    * @param {string} accountNumber
    * @param {string} campusCode
-   * @returns{Promise<object>} customer account object
+   * @returns {Promise<object>} customer account object
    * @memberof FAMISDb
    */
   async getCustomerNumber(accountNumber, campusCode) {
@@ -1461,7 +1567,7 @@ class FAMISDb {
         .where('uid', `${code}${accountNumber}`);
       if (records.length) {
         retVal = records[0];
-      } 
+      }
     } catch (e) {
       throw e;
     }
@@ -1471,7 +1577,7 @@ class FAMISDb {
   /**
    *
    * Get current fiscal year
-   * @returns{<integer>} fiscal year
+   * @returns {<integer>} fiscal year
    * @memberof FAMISDb
    */
   getCurrentFiscalYear() {
@@ -1489,7 +1595,7 @@ class FAMISDb {
    *
    * Return fingerprint of invoice
    * @param {object} invoice json object
-   * @returns{<string>} fingerprint
+   * @returns {<string>} fingerprint
    * @memberof FAMISDb
    */
   getInvoiceFingerPrint(invoice) {
@@ -1506,7 +1612,7 @@ class FAMISDb {
    *
    * Return formatted account number
    * @param {string} accountNumber unformatted 13 digit famis account number
-   * @returns{<string>} formatted 13 digits famis account number
+   * @returns {<string>} formatted 13 digits famis account number
    * @memberof FAMISDb
    */
   formatAccountNumber(accountNumber) {
@@ -1514,6 +1620,243 @@ class FAMISDb {
 
     return formatted;
   }
+
+  /**
+ * @typedef {Object} HighRisk
+ * @property {boolean} isHighRisk - indicates if invoice triggers SRS high risk policy
+ * @property {object} flaggedTransactions - object of transactions that flag
+ */
+
+  /**
+   *
+   * Is invoice flagged by SRS high risk policies
+   * @param {object} invoice json object
+   * @returns {Promise<HighRisk>} high risk object
+   * @memberof FAMISDb
+   */
+  async isSrsHighRisk(invoice) {
+    let srsHighRisk = false;
+    const objectCodes = new Map();
+    //console.log(invoice);
+    try {
+      await each(
+        invoice.data.details,
+        async (detail) => {
+          //console.log(detail);
+          if (detail.famis.customerAccountNumber && detail.famis.sellingCampusCode) {
+            const acct = await this.getByAccountNumber(detail.famis.customerAccountNumber, detail.famis.sellingCampusCode);
+            const acctNum = this.formatAccountNumber(detail.famis.customerAccountNumber);
+            const objCode = await this.getRevenueCode(detail.sellingObjectCode);
+            const isFederal = acct && acct.cfda_no && (acct.sponsor_type && acct.sponsor_type === 'F');
+            const srsApproved = invoice.replace_data && "srs_approved" in invoice.replace_data ? invoice.replace_data.srs_approved : false;
+            if (objCode && objCode.srs && acct && acct.srs && isFederal && !srsApproved && invoice.isIdt) {
+              srsHighRisk = true;
+              let val = [detail];
+              if (objectCodes.has(objCode.expense)) val.push(...objectCodes.get(objCode.expense));
+              objectCodes.set(objCode.expense, val);
+            }
+          }
+        }
+      );
+    } catch (e) {
+      //console.log(invoice);
+      console.log(e);
+    }
+    return {
+      isHighRisk: srsHighRisk,
+      flaggedTransactions: Object.fromEntries(objectCodes),
+    }
+  }
+
+  /**
+   * @typedef {Object} Comment
+   * @property {integer} id - db generated id
+   * @property {string} uid - uid
+   * @property {string} invoice_id - invoice id
+   * @property {string} user_id - user uid
+   * @property {string} comment - text of comment
+   * @property {string} type - type of comment
+   * @property {date} created - created date
+   * @property {date} deleted - deleted date
+   */
+
+  /**
+   *
+   * Create/update invoice comment
+   * @param {Comment} comment json object
+   * @returns {Promise<Comment>} comment object
+   * @memberof FAMISDb
+   */
+  async saveComment(comment) {
+    const returningColumns = [
+      'id',
+      'uid',
+      'invoice_id',
+      'user_id',
+      'comment',
+      'type',
+      'created',
+      'deleted',
+    ];
+    let response;
+    try {
+      const records = await this.db('invoice_comments').where({ uid: comment.uid });
+      if (records.length) {
+        response = await this.db('invoice_comments')
+          .returning(returningColumns)
+          .update(comment)
+          .where('uid', comment.uid);
+      } else {
+        response = await this.db('invoice_comments')
+          .returning(returningColumns)
+          .insert(comment);
+      }
+
+      if (response.length) {
+        response = response[0];
+      }
+    } catch (e) {
+      //console.log(JSON.stringify(comment, null, 2));
+      console.log(e);
+      throw (e);
+    }
+    return response;
+  }
+
+  /**
+   *
+   * Get invoice comments
+   * @param {string} invoiceUid invoice uid
+   * @returns {Promise(<Comment[]>} array of comment objects
+   * @memberof FAMISDb
+   */
+  async getInvoiceComments(invoiceUid) {
+    let self = this;
+    let response;
+    try {
+      const records = await this.db('invoice_comments')
+        .select(
+          'invoice_comments.*',
+        )
+        .where({ invoice_id: invoiceUid })
+        .orderBy('created', 'desc');
+      response = await map(
+        records,
+        async (r) => {
+          const retVal = r;
+          const files = await self.getCommentFiles(r.uid);
+          r.files = files;
+          if (self.people) {
+            const user = await self.people.getByUid(r.user_id);
+            if (user) {
+              retVal.user = user;
+            }
+          }
+          return retVal;
+        }
+      );
+    } catch (e) {
+      console.log(e);
+      throw (e);
+    }
+    return response;
+  }
+
+  /**
+   * @typedef {Object} CommentFile
+   * @property {integer} id - db generated id
+   * @property {string} uid - uid
+   * @property {string} invoice_id - invoice uid
+   * @property {string} comment_id - comment uid
+   * @property {string} original_filename - original file name
+   * @property {string} filename - generate unique filename on filesystem
+   * @property {date} created - created date
+   * @property {date} deleted - deleted date
+   */
+
+  /**
+   *
+   * Create/update invoice comment file
+   * @param {CommentFile} commentFile json object
+   * @returns {Promise<CommentFile>} comment object
+   * @memberof FAMISDb
+   */
+  async saveCommentFile(commentFile) {
+    const returningColumns = [
+      'id',
+      'uid',
+      'invoice_id',
+      'comment_id',
+      'original_filename',
+      'filename',
+      'created',
+      'deleted',
+    ];
+    let response;
+    try {
+      const records = await this.db('invoice_comment_files').where({ uid: commentFile.uid });
+      if (records.length) {
+        response = await this.db('invoice_comment_files')
+          .returning(returningColumns)
+          .update(commentFile)
+          .where('uid', commentFile.uid);
+      } else {
+        response = await this.db('invoice_comment_files')
+          .returning(returningColumns)
+          .insert(commentFile);
+      }
+
+      if (response.length) {
+        response = response[0];
+      }
+    } catch (e) {
+      //console.log(JSON.stringify(comment, null, 2));
+      console.log(e);
+      throw (e);
+    }
+    return response;
+  }
+
+  /**
+   *
+   * Get invoice comment files
+   * @param {string} commentUid comment uid
+   * @returns {Promise(<CommentFile[]>} array of comment file objects
+   * @memberof FAMISDb
+   */
+  async getCommentFiles(commentUid) {
+    let response;
+    try {
+      const records = await this.db('invoice_comment_files')
+        .where({ comment_id: commentUid })
+        .orderBy('created', 'desc');
+      response = records;
+    } catch (e) {
+      console.log(e);
+      throw (e);
+    }
+    return response;
+  }
+
+  /**
+   *
+   * Get invoice comment file
+   * @param {string} fileUid file uid
+   * @returns {Promise(<CommentFile>} array of comment file objects
+   * @memberof FAMISDb
+   */
+   async getCommentFile(fileUid) {
+    let response;
+    try {
+      const records = await this.db('invoice_comment_files')
+        .where({ uid: fileUid });
+      if (records.length) response = records[0];
+    } catch (e) {
+      console.log(e);
+      throw (e);
+    }
+    return response;
+  }
 }
 
-module.exports = FAMISDb;
+module.exports = FAMISDb;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamu-dor/famis-db",
-  "version": "1.3.3",
+  "version": "2.0.2",
   "description": "DB library for FAMIS database",
   "main": "index.js",
   "scripts": {
@@ -16,10 +16,10 @@
   "author": "Matt Voss",
   "license": "ISC",
   "dependencies": {
+    "@paralleldrive/cuid2": "^2.2.2",
     "awaity": "^1.0.0",
-    "cuid": "^2.1.8",
     "knex": "^3.1.0",
     "pg": "^8.11.3",
     "rev-hash": "^3.0.0"
   }
-}
+}