@tamu-dor/famis-db 3.0.0-beta.2 → 3.0.0-beta.4

package/dist/.vite/manifest.json

@@ -1,6 +1,7 @@
 {
   "src/index.ts": {
     "file": "main.cjs",
+    "name": "index",
     "src": "src/index.ts",
     "isEntry": true
   }

package/dist/index.d.mts

@@ -51,32 +51,32 @@ export declare interface AccountPayload {
 }
 
 export declare interface Contact {
-    fax: string | null;
-    city: string | null;
-    name: string;
-    email: string | null;
-    phone: string | null;
-    state: string | null;
-    country: string | null;
-    address1: string | null;
-    address2: string | null;
-    mailstop: string | null;
-    department: string | null;
-    postalCode: string | null;
-    institution: string | null;
+    fax?: string | null;
+    city?: string | null;
+    name?: string;
+    email?: string | null;
+    phone?: string | null;
+    state?: string | null;
+    country?: string | null;
+    address1?: string | null;
+    address2?: string | null;
+    mailstop?: string | null;
+    department?: string | null;
+    postalCode?: string | null;
+    institution?: string | null;
 }
 
 export declare interface Core {
-    id: number;
+    id?: number;
     account?: string;
     effective?: string;
-    facility: string;
+    facility?: string;
     contact: string;
     contactEmail: string;
     systemId: number;
     enabled: boolean;
     deleted: string | null;
-    coreEmail: string;
+    coreEmail?: string | null;
     corePhone: string | null;
     coreAddress: string | null;
     from_email: string | null;
@@ -91,7 +91,7 @@ export declare interface Core {
 
 export declare interface CoreAccount {
     id?: number;
-    account: string;
+    account?: string;
     coreId: number;
     coreAccountId?: number;
     coreAccountActive?: boolean | null;
@@ -100,9 +100,9 @@ export declare interface CoreAccount {
 }
 
 export declare interface CoreAccountEmail {
-    uid: string;
-    core_id: number;
-    account_number: string;
+    uid?: string;
+    core_id?: number;
+    account_number?: string;
     email: string;
     created?: Date | null;
     deleted?: Date | null;
@@ -115,7 +115,7 @@ export declare interface CorePayload {
 
 export declare interface CoreUser {
     id?: number;
-    userId: string;
+    userId?: string;
     coreId: number;
     coreUserId?: number;
     email?: boolean | null;
@@ -281,8 +281,15 @@ export declare interface Edge {
 declare class FAMISDb {
     private db;
     private people;
-    constructor(config: any, people: any);
-    init(config: any, people: any): void;
+    constructor(config: any, people: any, debug: boolean);
+    /**
+     * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
+     *
+     * @param {any} config - The configuration object that includes details about how to connect to a PostgreSQL database. This should include properties such as `host`, `user`, `password`, etc.
+     * @param {any} people - The data related to the 'people' entity. It could be an array of person objects or any other format depending on your application requirements.
+     * @param {boolean} debug - A flag indicating whether to enable debugging for Knex queries. Defaults to `false`. If set to `true`, it will log all SQL queries that are executed against the database in the console.
+     */
+    init(config: any, people?: any, debug?: boolean): void;
     /**
      *
      * Extract customer account and po number
@@ -472,11 +479,11 @@ declare class FAMISDb {
      *
      * Updates an invoice
      * @param {string} uid
-     * @param {object} invoice
-     * @returns {Promise<object>} invoice object
+     * @param {Invoice} invoice
+     * @returns {Promise<Invoice>} invoice object
      * @memberof FAMISDb
      */
-    updateInvoice(uid: string, invoice: any): Promise<any>;
+    updateInvoice(uid: string, invoice: Invoice): Promise<InvoicePayload>;
     /**
      *
      * Toggles an invoice as paid
@@ -918,6 +925,13 @@ declare class FAMISDb {
       * @property {date} created - created date
       * @property {date} deleted - deleted date
       */
+     /**
+      * Create an invoice comment file.
+      * @param {InvoiceCommentFile} file - JSON object representing the comment file
+      * @returns {Promise<InvoiceCommentFile>} - Promise that resolves to the comment file object
+      * @memberof FAMISDb
+      */
+     saveCommentFile(file: InvoiceCommentFile): Promise<InvoiceCommentFile | null>;
      /**
       * Get invoice comment files.
       * @param {string} commentUid - Comment UID
@@ -1019,11 +1033,11 @@ declare class FAMISDb {
     }
 
     export declare interface Invoice {
-        uid: string;
-        number: string;
-        lab: string;
-        totalAmount: string;
-        date: string;
+        uid?: string | null;
+        number?: string | null;
+        lab?: string | null;
+        totalAmount?: string;
+        date?: string;
         data: TransactionData;
         invoiced: boolean;
         type: string;
@@ -1034,21 +1048,21 @@ declare class FAMISDb {
         postedDate: string | null;
         emailed: boolean;
         replace_data?: object | null;
-        fingerprint: string;
-        core: Core;
-        customerAccountInfo: CustomerAccountInfo;
-        isIdt: boolean;
-        poNumber: string | null;
-        pi: PI;
-        highRiskInfo: HighRiskInfo;
-        comments: InvoiceComment[];
+        fingerprint?: string | null;
+        core?: Core | null;
+        customerAccountInfo?: CustomerAccountInfo | null;
+        isIdt?: boolean | null;
+        poNumber?: string | null;
+        pi?: PI | null;
+        highRiskInfo?: HighRiskInfo | null;
+        comments?: InvoiceComment[] | null;
     }
 
     export declare interface InvoiceComment {
         id?: number;
-        uid: string;
+        uid?: string;
         invoice_id: string;
-        user_id: string;
+        user_id?: string | null;
         comment: string | null;
         type: string | null;
         created: string | null;
@@ -1056,7 +1070,7 @@ declare class FAMISDb {
     }
 
     export declare type InvoiceCommentFile = {
-        id: number;
+        id?: number;
         uid: string;
         invoice_id: string;
         comment_id: string;
@@ -1126,9 +1140,9 @@ declare class FAMISDb {
         fein: string;
         agency: string;
         checkAddress: string;
-        credit: boolean;
-        creditUrl: string;
-        creditFee: string;
+        credit?: boolean | null;
+        creditUrl?: string | null;
+        creditFee?: string | null;
         part: string;
         abbrev: string;
         aggiebuy: string;

package/dist/index.d.ts

@@ -51,32 +51,32 @@ export declare interface AccountPayload {
 }
 
 export declare interface Contact {
-    fax: string | null;
-    city: string | null;
-    name: string;
-    email: string | null;
-    phone: string | null;
-    state: string | null;
-    country: string | null;
-    address1: string | null;
-    address2: string | null;
-    mailstop: string | null;
-    department: string | null;
-    postalCode: string | null;
-    institution: string | null;
+    fax?: string | null;
+    city?: string | null;
+    name?: string;
+    email?: string | null;
+    phone?: string | null;
+    state?: string | null;
+    country?: string | null;
+    address1?: string | null;
+    address2?: string | null;
+    mailstop?: string | null;
+    department?: string | null;
+    postalCode?: string | null;
+    institution?: string | null;
 }
 
 export declare interface Core {
-    id: number;
+    id?: number;
     account?: string;
     effective?: string;
-    facility: string;
+    facility?: string;
     contact: string;
     contactEmail: string;
     systemId: number;
     enabled: boolean;
     deleted: string | null;
-    coreEmail: string;
+    coreEmail?: string | null;
     corePhone: string | null;
     coreAddress: string | null;
     from_email: string | null;
@@ -91,7 +91,7 @@ export declare interface Core {
 
 export declare interface CoreAccount {
     id?: number;
-    account: string;
+    account?: string;
     coreId: number;
     coreAccountId?: number;
     coreAccountActive?: boolean | null;
@@ -100,9 +100,9 @@ export declare interface CoreAccount {
 }
 
 export declare interface CoreAccountEmail {
-    uid: string;
-    core_id: number;
-    account_number: string;
+    uid?: string;
+    core_id?: number;
+    account_number?: string;
     email: string;
     created?: Date | null;
     deleted?: Date | null;
@@ -115,7 +115,7 @@ export declare interface CorePayload {
 
 export declare interface CoreUser {
     id?: number;
-    userId: string;
+    userId?: string;
     coreId: number;
     coreUserId?: number;
     email?: boolean | null;
@@ -281,8 +281,15 @@ export declare interface Edge {
 declare class FAMISDb {
     private db;
     private people;
-    constructor(config: any, people: any);
-    init(config: any, people: any): void;
+    constructor(config: any, people: any, debug: boolean);
+    /**
+     * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
+     *
+     * @param {any} config - The configuration object that includes details about how to connect to a PostgreSQL database. This should include properties such as `host`, `user`, `password`, etc.
+     * @param {any} people - The data related to the 'people' entity. It could be an array of person objects or any other format depending on your application requirements.
+     * @param {boolean} debug - A flag indicating whether to enable debugging for Knex queries. Defaults to `false`. If set to `true`, it will log all SQL queries that are executed against the database in the console.
+     */
+    init(config: any, people?: any, debug?: boolean): void;
     /**
      *
      * Extract customer account and po number
@@ -472,11 +479,11 @@ declare class FAMISDb {
      *
      * Updates an invoice
      * @param {string} uid
-     * @param {object} invoice
-     * @returns {Promise<object>} invoice object
+     * @param {Invoice} invoice
+     * @returns {Promise<Invoice>} invoice object
      * @memberof FAMISDb
      */
-    updateInvoice(uid: string, invoice: any): Promise<any>;
+    updateInvoice(uid: string, invoice: Invoice): Promise<InvoicePayload>;
     /**
      *
      * Toggles an invoice as paid
@@ -918,6 +925,13 @@ declare class FAMISDb {
       * @property {date} created - created date
       * @property {date} deleted - deleted date
       */
+     /**
+      * Create an invoice comment file.
+      * @param {InvoiceCommentFile} file - JSON object representing the comment file
+      * @returns {Promise<InvoiceCommentFile>} - Promise that resolves to the comment file object
+      * @memberof FAMISDb
+      */
+     saveCommentFile(file: InvoiceCommentFile): Promise<InvoiceCommentFile | null>;
      /**
       * Get invoice comment files.
       * @param {string} commentUid - Comment UID
@@ -1019,11 +1033,11 @@ declare class FAMISDb {
     }
 
     export declare interface Invoice {
-        uid: string;
-        number: string;
-        lab: string;
-        totalAmount: string;
-        date: string;
+        uid?: string | null;
+        number?: string | null;
+        lab?: string | null;
+        totalAmount?: string;
+        date?: string;
         data: TransactionData;
         invoiced: boolean;
         type: string;
@@ -1034,21 +1048,21 @@ declare class FAMISDb {
         postedDate: string | null;
         emailed: boolean;
         replace_data?: object | null;
-        fingerprint: string;
-        core: Core;
-        customerAccountInfo: CustomerAccountInfo;
-        isIdt: boolean;
-        poNumber: string | null;
-        pi: PI;
-        highRiskInfo: HighRiskInfo;
-        comments: InvoiceComment[];
+        fingerprint?: string | null;
+        core?: Core | null;
+        customerAccountInfo?: CustomerAccountInfo | null;
+        isIdt?: boolean | null;
+        poNumber?: string | null;
+        pi?: PI | null;
+        highRiskInfo?: HighRiskInfo | null;
+        comments?: InvoiceComment[] | null;
     }
 
     export declare interface InvoiceComment {
         id?: number;
-        uid: string;
+        uid?: string;
         invoice_id: string;
-        user_id: string;
+        user_id?: string | null;
         comment: string | null;
         type: string | null;
         created: string | null;
@@ -1056,7 +1070,7 @@ declare class FAMISDb {
     }
 
     export declare type InvoiceCommentFile = {
-        id: number;
+        id?: number;
         uid: string;
         invoice_id: string;
         comment_id: string;
@@ -1126,9 +1140,9 @@ declare class FAMISDb {
         fein: string;
         agency: string;
         checkAddress: string;
-        credit: boolean;
-        creditUrl: string;
-        creditFee: string;
+        credit?: boolean | null;
+        creditUrl?: string | null;
+        creditFee?: string | null;
         part: string;
         abbrev: string;
         aggiebuy: string;

package/dist/main.cjs

@@ -190,16 +190,23 @@ class FAMISDb {
   db;
   //@ts-ignore
   people;
-  constructor(config, people) {
+  constructor(config, people, debug) {
     if (config) {
-      this.init(config, people);
+      this.init(config, people, debug || false);
     }
   }
-  init(config, people) {
+  /**
+   * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
+   * 
+   * @param {any} config - The configuration object that includes details about how to connect to a PostgreSQL database. This should include properties such as `host`, `user`, `password`, etc.
+   * @param {any} people - The data related to the 'people' entity. It could be an array of person objects or any other format depending on your application requirements. 
+   * @param {boolean} debug - A flag indicating whether to enable debugging for Knex queries. Defaults to `false`. If set to `true`, it will log all SQL queries that are executed against the database in the console.
+   */
+  init(config, people = null, debug = false) {
     this.db = knex({
       client: "pg",
       connection: config,
-      debug: true,
+      debug,
       pool: {
         min: 0,
         max: 10,
@@ -684,13 +691,13 @@ class FAMISDb {
    *
    * Updates an invoice
    * @param {string} uid
-   * @param {object} invoice
-   * @returns {Promise<object>} invoice object
+   * @param {Invoice} invoice
+   * @returns {Promise<Invoice>} invoice object
    * @memberof FAMISDb
    */
   async updateInvoice(uid, invoice) {
     let records;
-    invoice.details.forEach((d) => {
+    invoice.data.details.forEach((d) => {
       if (!d.other) {
         d.other = "0.00";
       }
@@ -702,20 +709,27 @@ class FAMISDb {
       }
     });
     try {
+      const {
+        comments,
+        isIdt,
+        poNumber,
+        totalAmount,
+        data,
+        customerAccount,
+        sellingAccount,
+        fingerprint,
+        ...rest
+      } = invoice;
       const record = {
-        number: invoice.number,
-        lab: invoice.lab,
-        totalAmount: parseFloat(invoice.totalAmount),
-        data: JSON.stringify(invoice),
-        date: invoice.date,
-        customerAccount: this.getAccountNumber(invoice.details[0].famis).accountNumber,
-        sellingAccount: getCoreAccountNumber(invoice.details[0].famis),
-        fingerprint: invoice.fingerprint ? invoice.fingerprint : null
+        ...rest,
+        totalAmount: parseFloat(totalAmount.replace("$", "")),
+        data: JSON.stringify(data),
+        customerAccount: this.getAccountNumber(data.details[0].famis).accountNumber,
+        sellingAccount: getCoreAccountNumber(data.details[0].famis),
+        fingerprint: fingerprint ? fingerprint : null
       };
-      if (invoice.replace_data) {
-        record.replace_data = invoice.replace_data;
-      }
       records = await this.db("invoices").returning(returningColumns).update(record).where("uid", uid);
+      records = await this.getInvoiceByUid(uid);
     } catch (e) {
       throw e;
     }
@@ -1843,8 +1857,7 @@ class FAMISDb {
     let retVal = null;
     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);
+      if ("id" in user) retVal = await this.db("users").returning(columns).update(user).where("id", user.id);
     } catch (e) {
       throw e;
     }
@@ -1932,8 +1945,7 @@ class FAMISDb {
             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));
+              if (objectCodes.has(objCode.expense)) val.push(...objectCodes.get(objCode.expense));
               objectCodes.set(objCode.expense, val);
             }
           }
@@ -2037,6 +2049,35 @@ class FAMISDb {
    * @property {date} created - created date
    * @property {date} deleted - deleted date
    */
+  /**
+   * Create an invoice comment file.
+   * @param {InvoiceCommentFile} file - JSON object representing the comment file
+   * @returns {Promise<InvoiceCommentFile>} - Promise that resolves to the comment file object
+   * @memberof FAMISDb
+   */
+  async saveCommentFile(file) {
+    const returningColumns2 = [
+      "id",
+      "uid",
+      "invoice_id",
+      "comment_id",
+      "original_filename",
+      "filename",
+      "created",
+      "deleted"
+    ];
+    let response;
+    try {
+      response = await this.db("invoice_comment_files").returning(returningColumns2).insert(file);
+      if (response && Array.isArray(response) && response.length) {
+        response = response[0];
+      }
+    } catch (e) {
+      console.log(e);
+      throw e;
+    }
+    return response;
+  }
   /**
    * Get invoice comment files.
    * @param {string} commentUid - Comment UID
@@ -2064,8 +2105,7 @@ class FAMISDb {
     let response = null;
     try {
       const records = await this.db("invoice_comment_files").where({ uid: fileUid });
-      if (records.length)
-        response = records[0];
+      if (records.length) response = records[0];
     } catch (e) {
       console.log(e);
       throw e;