@tamu-dor/famis-db 2.0.2 → 2.0.4

package/index.d.ts

@@ -0,0 +1,619 @@
+export = FAMISDb;
+declare class FAMISDb {
+    constructor(config: any, people: any);
+    init(config: any, people: any): void;
+    db: any;
+    people: any;
+    /**
+     *
+     * Extract customer account and po number
+     * @param {object} famis
+     * @param {object} replace_data
+     * @returns {object} account number object
+     * @memberof FAMISDb
+     */
+    getAccountNumber(famis: object, replace_data: object): object;
+    /**
+     *
+     * Process an invoice to have all necessary relationships
+     * @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
+     */
+    processInvoice(invoice: object, historical?: boolean): Promise<object>;
+    /**
+     *
+     * Get invoice by uid
+     * @param {string} uid
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByUid(uid: string): Promise<object>;
+    /**
+     *
+     * Get invoice by originating system assigned number
+     * @param {string} number
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByNumber(number: string): Promise<object>;
+    /**
+     *
+     * Get invoice by fingerprint
+     * @param {string} fingerPrint
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByFingerPrint(fingerPrint: string): Promise<object>;
+    /**
+     *
+     * Get all invoices associated with a specified account number
+     * @param {string} accountNumber
+     * @returns {Promise<array>} invoice objects
+     * @memberof FAMISDb
+     */
+    getInvoicesByAccount(accountNumber: string): Promise<any[]>;
+    /**
+     *
+     * Get all invoice ordered by and sorted by paramaters passed
+     * @param {string} [orderBy='date']
+     * @param {string} [dir='desc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} [page=null]
+     * @param {integer} [limit=null]
+     * @returns {Promise<array>} invoice objects
+     * @memberof FAMISDb
+     */
+    getAllInvoices(orderBy?: string, dir?: string, deleted?: boolean, page?: integer, limit?: integer): Promise<any[]>;
+    /**
+     *
+     * Retreives invoices from the latest date
+     * @returns {Promise<array>} invoice objects
+     * @memberof FAMISDb
+     */
+    getLatestInvoices(): Promise<any[]>;
+    /**
+     *
+     * Returns all held invoices
+     * @returns {Promise<array>} held invoice objects
+     * @memberof FAMISDb
+     */
+    getHeldInvoices(orderBy?: string, dir?: string, page?: any, limit?: any): Promise<any[]>;
+    /**
+     *
+     * Returns all awaiting email invoices
+     * @returns {Promise<array>} awaiting email invoice objects
+     * @memberof FAMISDb
+     */
+    getInvoicesAwaitingEmail(): Promise<any[]>;
+    /**
+     *
+     * Search invoices by originating system generated invoice number
+     * @param {string} number
+     * @returns {Promise<array>} invoice objects
+     * @memberof FAMISDb
+     */
+    searchInvoicesByNumber(number: string): Promise<any[]>;
+    /**
+     *
+     * Search invoices by FAMIS invoice number
+     * @param {string} famis
+     * @returns {Promise<array>} invoice objects
+     * @memberof FAMISDb
+     */
+    searchInvoicesByFamis(famis: string): Promise<any[]>;
+    /**
+     *
+     * Adds an invoice
+     * @param {object} invoice
+     * @param {string} type
+     * @param {string} famisInvoiceNumber
+     * @returns {Promise<object>} invoice
+     * @memberof FAMISDb
+     */
+    addInvoice(invoice: object, type: string, famisInvoiceNumber: string): Promise<object>;
+    /**
+     *
+     * Updates an invoice
+     * @param {string} uid
+     * @param {object} invoice
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    updateInvoice(uid: string, invoice: object): Promise<object>;
+    /**
+     *
+     * Toggles an invoice as paid
+     * @param {string} uid
+     * @param {boolean} invoiced
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    markInvoiced(uid: string, invoiced: boolean): Promise<object>;
+    /**
+     *
+     * Toggles an invoice as emailed
+     * @param {string} uid
+     * @param {boolean} emailed
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    markEmailed(uid: string, emailed: boolean): Promise<object>;
+    /**
+     *
+     * Sets an invoice's deletion date
+     * @param {string} uid
+     * @param {date} deleted
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setDeleted(uid: string, deleted: date): Promise<object>;
+    /**
+     *
+     * Sets an invoice's posted date
+     * @param {string} uid
+     * @param {date} postedDate
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setInvoicePostedDate(uid: string, postedDate: date): Promise<object>;
+    /**
+     *
+     * Sets an invoice's fingerprint
+     * @param {string} uid
+     * @param {string} fingerprint
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setInvoiceFingerPrint(uid: string, fingerprint: string): Promise<object>;
+    /**
+     *
+     * Get PI accounts by account number
+     * @param {string} number
+     * @param {string} campus
+     * @param {boolean} [historical=false]
+     * @returns {Promise<object>} account object
+     * @memberof FAMISDb
+     */
+    getByAccountNumber(number: string, campus: string, historical?: boolean): Promise<object>;
+    /**
+     *
+     * Search PI accounts by partial account number
+     * @param {string} number
+     * @returns {Promise<array>} account object(s)
+     * @memberof FAMISDb
+     */
+    searchByAccountNumber(number: string): Promise<any[]>;
+    /**
+     *
+     * Get PI Accounts by UIN
+     * @param {string} uin
+     * @returns {Promise<array>} account object array
+     * @memberof FAMISDb
+     */
+    getAccountsByUin(uin: string): Promise<any[]>;
+    /**
+     *
+     * Get PI accounts by responsible UIN
+     * @param {string} uin
+     * @returns {Promise<array>} account object array
+     * @memberof FAMISDb
+     */
+    getAccountsByResponsibleUin(uin: string): Promise<any[]>;
+    /**
+     *
+     * Get next FAMIS invoice number in sequence for specified invoice type
+     * @param {string} invoice
+     * @returns {Promise<string>} next invoice number in sequence
+     * @memberof FAMISDb
+     */
+    getNextFAMISInvoiceNumber(type: any): Promise<string>;
+    /**
+     *
+     * Get matching expense code for specified revenue code
+     * @param {string} revenue
+     * @returns {Promise<string>} expense code
+     * @memberof FAMISDb
+     */
+    getExpenseCodeByRevenue(revenue: string): Promise<string>;
+    /**
+     *
+     * Get revenue code object
+     * @param {string} revenue
+     * @returns {Promise<object>} revenue code object
+     * @memberof FAMISDb
+     */
+    getRevenueCode(revenue: string): Promise<object>;
+    /**
+     *
+     * Get expense code object
+     * @param {string} code
+     * @returns {Promise<object>} expense code object
+     * @memberof FAMISDb
+     */
+    getExpenseCode(code: string): Promise<object>;
+    /**
+     *
+     * Check if expense code is within the allowable range for specified account and the specified fiscal year (defaults to current)
+     * @param {string} account
+     * @param {string} code
+     * @param {integer} fiscal
+     * @returns {Promise<boolean>} truthy value
+     * @memberof FAMISDb
+     */
+    allowableExpenseCode(accountNumber: any, code: string, fiscal: integer): Promise<boolean>;
+    /**
+     *
+     * Get allowable expense code ranges for specified account
+     * @param {string} account
+     * @returns {Promise<boolean>} expense code range object(s)
+     * @memberof FAMISDb
+     */
+    getAllowableExpenseCodes(accountNumber: any, fiscal: any): Promise<boolean>;
+    /**
+    *
+    * Get core by id
+    * @param {string} id
+    * @returns {Promise<object>} core object
+    * @memberof FAMISDb
+    */
+    getCoreById(id: string): Promise<object>;
+    /**
+     *
+     * Get core by account number
+     * @param {string} account
+     * @returns {Promise<object>} core object
+     * @memberof FAMISDb
+     */
+    getCoreByAccount(account: string): Promise<object>;
+    /**
+     *
+     * Get core current revenue account number
+     * @param {string} coreId
+     * @returns {Promise<object>} core object
+     * @memberof FAMISDb
+     */
+    getCoreCurrentAccount(coreId: string): Promise<object>;
+    /**
+     *
+     * Get system part by ID
+     * @param {number} id
+     * @returns {Promise<object>} system part object
+     * @memberof FAMISDb
+     */
+    getSystemById(id: number): Promise<object>;
+    /**
+     *
+     * Get system part by two digit part number
+     * @param {string} number
+     * @returns {Promise<object>} system part object
+     * @memberof FAMISDb
+     */
+    getSystemByPartNumber(number: string): Promise<object>;
+    /**
+     *
+     * Get all enabled cores
+     * @param {string} date
+     * @returns {Promise<array>} core objects
+     * @memberof FAMISDb
+     */
+    getEnabledCores(date: string): Promise<any[]>;
+    /**
+     *
+     * Get all cores
+     * @returns {Promise<array>} core objects
+     * @memberof FAMISDb
+     */
+    getAllCores(): Promise<any[]>;
+    /**
+     *
+     * Get a core's users by core ID
+     * @param {number} coreId
+     * @returns {Promise<array>} user objects
+     * @memberof FAMISDb
+     */
+    getCoreUsers(coreId: number): Promise<any[]>;
+    /**
+     *
+     * Get a user's cores they manage
+     * @param {string} userId
+     * @returns {Promise<array>} core objects
+     * @memberof FAMISDb
+     */
+    getUserCores(userId: string): Promise<any[]>;
+    /**
+     *
+     * Get a system part's users by system ID
+     * @param {number} systemId
+     * @returns {Promise<array>} user objects
+     * @memberof FAMISDb
+     */
+    getSystemUsers(systemId: number): Promise<any[]>;
+    /**
+     *
+     * Get a user's system parts they manage
+     * @param {*} userId
+     * @returns {Promise<object>} system objects
+     * @memberof FAMISDb
+     */
+    getUserSystemParts(userId: any): Promise<object>;
+    /**
+     *
+     * Get all system parts
+     * @returns {Promise<object>} system objects
+     * @memberof FAMISDb
+     */
+    getAllSystemParts(): Promise<object>;
+    /**
+     *
+     * Get all admin users
+     * @returns {Promise<array>} array of user objects
+     * @memberof FAMISDb
+     */
+    getAdminUsers(): Promise<any[]>;
+    /**
+     *
+     * Get user
+     * @param {string} userId
+     * @returns {Promise<object>} user object
+     * @memberof FAMISDb
+     */
+    getUser(userId: string): Promise<object>;
+    /**
+     *
+     * Update user
+     * @param {object} user
+     * @returns {Promise<object>} user object
+     * @memberof FAMISDb
+     */
+    updateUser(user: object): Promise<object>;
+    /**
+     *
+     * Get customer by customer account number
+     * @param {string} accountNumber
+     * @param {string} campusCode
+     * @returns {Promise<object>} customer account object
+     * @memberof FAMISDb
+     */
+    getCustomerNumber(accountNumber: string, campusCode: string): Promise<object>;
+    /**
+     *
+     * Get current fiscal year
+     * @returns {<integer>} fiscal year
+     * @memberof FAMISDb
+     */
+    getCurrentFiscalYear(): <integer>() => any;
+    /**
+     *
+     * Return fingerprint of invoice
+     * @param {object} invoice json object
+     * @returns {<string>} fingerprint
+     * @memberof FAMISDb
+     */
+    getInvoiceFingerPrint(invoice: object): <string>() => any;
+    /**
+     *
+     * Return formatted account number
+     * @param {string} accountNumber unformatted 13 digit famis account number
+     * @returns {<string>} formatted 13 digits famis account number
+     * @memberof FAMISDb
+     */
+    formatAccountNumber(accountNumber: string): <string_1>() => any;
+    /**
+   * @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
+     */
+    isSrsHighRisk(invoice: object): Promise<{
+        /**
+         * - indicates if invoice triggers SRS high risk policy
+         */
+        isHighRisk: boolean;
+        /**
+         * - object of transactions that flag
+         */
+        flaggedTransactions: object;
+    }>;
+    /**
+     * @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
+     */
+    saveComment(comment: {
+        /**
+         * - db generated id
+         */
+        id: integer;
+        /**
+         * - uid
+         */
+        uid: string;
+        /**
+         * - invoice id
+         */
+        invoice_id: string;
+        /**
+         * - user uid
+         */
+        user_id: string;
+        /**
+         * - text of comment
+         */
+        comment: string;
+        /**
+         * - type of comment
+         */
+        type: string;
+        /**
+         * - created date
+         */
+        created: date;
+        /**
+         * - deleted date
+         */
+        deleted: date;
+    }): Promise<{
+        /**
+         * - db generated id
+         */
+        id: integer;
+        /**
+         * - uid
+         */
+        uid: string;
+        /**
+         * - invoice id
+         */
+        invoice_id: string;
+        /**
+         * - user uid
+         */
+        user_id: string;
+        /**
+         * - text of comment
+         */
+        comment: string;
+        /**
+         * - type of comment
+         */
+        type: string;
+        /**
+         * - created date
+         */
+        created: date;
+        /**
+         * - deleted date
+         */
+        deleted: date;
+    }>;
+    /**
+     *
+     * Get invoice comments
+     * @param {string} invoiceUid invoice uid
+     * @returns {Promise(<Comment[]>} array of comment objects
+     * @memberof FAMISDb
+     */
+    getInvoiceComments(invoiceUid: string): Promise<any>;
+    /**
+     * @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
+     */
+    saveCommentFile(commentFile: {
+        /**
+         * - db generated id
+         */
+        id: integer;
+        /**
+         * - uid
+         */
+        uid: string;
+        /**
+         * - invoice uid
+         */
+        invoice_id: string;
+        /**
+         * - comment uid
+         */
+        comment_id: string;
+        /**
+         * - original file name
+         */
+        original_filename: string;
+        /**
+         * - generate unique filename on filesystem
+         */
+        filename: string;
+        /**
+         * - created date
+         */
+        created: date;
+        /**
+         * - deleted date
+         */
+        deleted: date;
+    }): Promise<{
+        /**
+         * - db generated id
+         */
+        id: integer;
+        /**
+         * - uid
+         */
+        uid: string;
+        /**
+         * - invoice uid
+         */
+        invoice_id: string;
+        /**
+         * - comment uid
+         */
+        comment_id: string;
+        /**
+         * - original file name
+         */
+        original_filename: string;
+        /**
+         * - generate unique filename on filesystem
+         */
+        filename: string;
+        /**
+         * - created date
+         */
+        created: date;
+        /**
+         * - deleted date
+         */
+        deleted: date;
+    }>;
+    /**
+     *
+     * Get invoice comment files
+     * @param {string} commentUid comment uid
+     * @returns {Promise(<CommentFile[]>} array of comment file objects
+     * @memberof FAMISDb
+     */
+    getCommentFiles(commentUid: string): Promise<any>;
+    /**
+     *
+     * Get invoice comment file
+     * @param {string} fileUid file uid
+     * @returns {Promise(<CommentFile>} array of comment file objects
+     * @memberof FAMISDb
+     */
+    getCommentFile(fileUid: string): Promise<any>;
+}

package/index.js

@@ -37,7 +37,13 @@ const pad = (str, max, right) => {
   return retVal;
 };
 
-const sanitizeAccountNumber = (account) => pad(account.replace(/\D/g,''), 13, true);
+const sanitizeAccountNumber = (account) => {
+  if (account.substring(0,2) === 'RC') {
+    return account.replace(/\W/g, '');
+  } else {
+    return pad(account.replace(/\D/g,''), 13, true);
+  }
+};
 
 const getCoreAccountNumber = (famis) => {
   const { sellingCampusCode, sellingAccountNumber, sellingSupportAccount } = famis;
@@ -1159,6 +1165,7 @@ class FAMISDb {
           'cores.id',
           'core_accounts.account',
           'core_accounts.effective',
+          'core_accounts.active',
           'cores.facility',
           'cores.contact',
           'cores.contactEmail',
@@ -1420,6 +1427,53 @@ class FAMISDb {
     return retVal;
   }
 
+  /**
+   *
+   * Get all active accounts
+   * @returns {Promise<array>} core objects
+   * @memberof FAMISDb
+   */
+  async getActiveAccounts() {
+    let records;
+    let retVal = [];
+    try {
+      const accounts = this.db('core_accounts')
+        .select(
+          'core_accounts.coreId',
+          'core_accounts.account',
+          'core_accounts.effective',
+        )
+        .where({active: true})
+        .as("core_accounts");
+      records = await this.db('cores')
+        .select(
+          'cores.id',
+          'core_accounts.account',
+          'core_accounts.active',
+          'cores.facility',
+          'cores.contact',
+          'cores.contactEmail',
+          'cores.systemId',
+          'cores.enabled',
+          'cores.deleted',
+          'cores.coreEmail',
+          'cores.corePhone',
+          'cores.coreAddress',
+          'cores.from_email',
+          'cores.invoice_email'
+        )
+        .join(accounts, 'cores.id', '=', 'core_accounts.coreId')
+        .where('enabled', '1')
+        .orderBy('cores.id', 'desc');
+      if (records.length) {
+        retVal = records;
+      } 
+    } catch (e) {
+      throw e;
+    }
+    return retVal;
+  }
+
   /**
    *
    * Get a system part's users by system ID
@@ -1859,4 +1913,4 @@ class FAMISDb {
   }
 }
 
-module.exports = FAMISDb;
+module.exports = FAMISDb;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamu-dor/famis-db",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "DB library for FAMIS database",
   "main": "index.js",
   "scripts": {
@@ -19,7 +19,7 @@
     "@paralleldrive/cuid2": "^2.2.2",
     "awaity": "^1.0.0",
     "knex": "^3.1.0",
-    "pg": "^8.11.3",
+    "pg": "^8.12.0",
     "rev-hash": "^3.0.0"
   }
-}
+}