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

package/dist/{manifest.json → .vite/manifest.json}

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

package/dist/index.d.mts

@@ -68,8 +68,8 @@ export declare interface Contact {
 
 export declare interface Core {
     id: number;
-    account: string;
-    effective: string;
+    account?: string;
+    effective?: string;
     facility: string;
     contact: string;
     contactEmail: string;
@@ -81,7 +81,7 @@ export declare interface Core {
     coreAddress: string | null;
     from_email: string | null;
     invoice_email: string | null;
-    systemPart: SystemPart;
+    systemPart?: SystemPart;
     system_part?: string;
     system_name?: string;
     system_abbrev?: string;
@@ -90,11 +90,13 @@ export declare interface Core {
 }
 
 export declare interface CoreAccount {
-    id: number;
+    id?: number;
     account: string;
     coreId: number;
-    effective: Date;
-    active: boolean | null;
+    coreAccountId?: number;
+    coreAccountActive?: boolean | null;
+    effective?: Date | null;
+    active?: boolean | null;
 }
 
 export declare interface CoreAccountEmail {
@@ -115,6 +117,7 @@ export declare interface CoreUser {
     id?: number;
     userId: string;
     coreId: number;
+    coreUserId?: number;
     email?: boolean | null;
 }
 
@@ -673,7 +676,7 @@ declare class FAMISDb {
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    updateCore(core: Core): Promise<Core>;
+    updateCore(core: Core): Promise<Core | undefined>;
     /**
      *
      * Add core
@@ -698,6 +701,14 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     addCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Delete core account
+     * @param {coreAccountId} string core account id
+     * @returns {Promise<CoreAccount>} core account object
+     * @memberof FAMISDb
+     */
+    deleteCoreAccount(coreAccountId: string): Promise<CoreAccount>;
     /**
      *
      * Get system part by ID
@@ -749,15 +760,21 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     updateCoreUser(user: CoreUser): Promise<CoreUser>;
+    /**
+     * This function adds a new CoreUser to the database. If the user already exists, it updates the existing record.
+     * @param {CoreUser} coreUser - The CoreUser object containing details about the user.
+     * @param {User} [user] - An optional User object that could contain additional details.
+     * @return {Promise<CoreUser>} A Promise that resolves to the newly added or updated CoreUser, if successfully added and returned from the database; otherwise it rejects with an error.
+     */
+    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
     /**
      *
-     * Add core user
-     * @param {CoreUser} coreUser core user object
-     * @param {User} user user object
+     * Delete core user
+     * @param {coreUserId} string core user object
      * @returns {Promise<CoreUser>} core user object
      * @memberof FAMISDb
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    deleteCoreUser(coreUserId: string): Promise<CoreUser>;
     /**
      *
      * Get a user's cores they manage
@@ -948,21 +965,28 @@ declare class FAMISDb {
       */
      getCoreAccountAdditionalEmailsByAccount(accountNumber: string): Promise<CoreAccountEmail[] | []>;
      /**
-      * Add an additional delivery email to an expense account for a core
-      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * Get additional delivery emails to expense accounts for a core by core id
+      * and account number
       * @param {number} coreId - Core ID
-      * @param {string} email - email address
+      * @param {string} account - account number
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByCoreIdAccount(coreId: number, account: string): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Add an additional delivery email to an expense account for a core
+      * @param {CoreAccountEmail} record - core account email delivery record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     addCoreAccountAdditionalEmails(accountNumber: string, coreId: number, email: string): Promise<CoreAccountEmail | null>;
+     addCoreAccountAdditionalEmail(record: CoreAccountEmail): Promise<CoreAccountEmail | null>;
      /**
       * Remove an additional delivery email to an expense account for a core
       * @param {string} uid - uid for core account email record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     removeCoreAccountAdditionalEmails(uid: string): Promise<CoreAccountEmail | null>;
+     removeCoreAccountAdditionalEmail(uid: string): Promise<CoreAccountEmail | null>;
     }
     export default FAMISDb;
 
@@ -1133,6 +1157,7 @@ declare class FAMISDb {
         usersSystemId?: number | null;
         systemId?: number | null;
         coreId?: number | null;
+        coreUserId?: number | null;
         cores?: CorePayload | null;
         systems?: SystemPart[] | [] | null;
         deleted?: Date | null;

package/dist/index.d.ts

@@ -68,8 +68,8 @@ export declare interface Contact {
 
 export declare interface Core {
     id: number;
-    account: string;
-    effective: string;
+    account?: string;
+    effective?: string;
     facility: string;
     contact: string;
     contactEmail: string;
@@ -81,7 +81,7 @@ export declare interface Core {
     coreAddress: string | null;
     from_email: string | null;
     invoice_email: string | null;
-    systemPart: SystemPart;
+    systemPart?: SystemPart;
     system_part?: string;
     system_name?: string;
     system_abbrev?: string;
@@ -90,11 +90,13 @@ export declare interface Core {
 }
 
 export declare interface CoreAccount {
-    id: number;
+    id?: number;
     account: string;
     coreId: number;
-    effective: Date;
-    active: boolean | null;
+    coreAccountId?: number;
+    coreAccountActive?: boolean | null;
+    effective?: Date | null;
+    active?: boolean | null;
 }
 
 export declare interface CoreAccountEmail {
@@ -115,6 +117,7 @@ export declare interface CoreUser {
     id?: number;
     userId: string;
     coreId: number;
+    coreUserId?: number;
     email?: boolean | null;
 }
 
@@ -673,7 +676,7 @@ declare class FAMISDb {
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    updateCore(core: Core): Promise<Core>;
+    updateCore(core: Core): Promise<Core | undefined>;
     /**
      *
      * Add core
@@ -698,6 +701,14 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     addCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Delete core account
+     * @param {coreAccountId} string core account id
+     * @returns {Promise<CoreAccount>} core account object
+     * @memberof FAMISDb
+     */
+    deleteCoreAccount(coreAccountId: string): Promise<CoreAccount>;
     /**
      *
      * Get system part by ID
@@ -749,15 +760,21 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     updateCoreUser(user: CoreUser): Promise<CoreUser>;
+    /**
+     * This function adds a new CoreUser to the database. If the user already exists, it updates the existing record.
+     * @param {CoreUser} coreUser - The CoreUser object containing details about the user.
+     * @param {User} [user] - An optional User object that could contain additional details.
+     * @return {Promise<CoreUser>} A Promise that resolves to the newly added or updated CoreUser, if successfully added and returned from the database; otherwise it rejects with an error.
+     */
+    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
     /**
      *
-     * Add core user
-     * @param {CoreUser} coreUser core user object
-     * @param {User} user user object
+     * Delete core user
+     * @param {coreUserId} string core user object
      * @returns {Promise<CoreUser>} core user object
      * @memberof FAMISDb
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    deleteCoreUser(coreUserId: string): Promise<CoreUser>;
     /**
      *
      * Get a user's cores they manage
@@ -948,21 +965,28 @@ declare class FAMISDb {
       */
      getCoreAccountAdditionalEmailsByAccount(accountNumber: string): Promise<CoreAccountEmail[] | []>;
      /**
-      * Add an additional delivery email to an expense account for a core
-      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * Get additional delivery emails to expense accounts for a core by core id
+      * and account number
       * @param {number} coreId - Core ID
-      * @param {string} email - email address
+      * @param {string} account - account number
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByCoreIdAccount(coreId: number, account: string): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Add an additional delivery email to an expense account for a core
+      * @param {CoreAccountEmail} record - core account email delivery record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     addCoreAccountAdditionalEmails(accountNumber: string, coreId: number, email: string): Promise<CoreAccountEmail | null>;
+     addCoreAccountAdditionalEmail(record: CoreAccountEmail): Promise<CoreAccountEmail | null>;
      /**
       * Remove an additional delivery email to an expense account for a core
       * @param {string} uid - uid for core account email record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     removeCoreAccountAdditionalEmails(uid: string): Promise<CoreAccountEmail | null>;
+     removeCoreAccountAdditionalEmail(uid: string): Promise<CoreAccountEmail | null>;
     }
     export default FAMISDb;
 
@@ -1133,6 +1157,7 @@ declare class FAMISDb {
         usersSystemId?: number | null;
         systemId?: number | null;
         coreId?: number | null;
+        coreUserId?: number | null;
         cores?: CorePayload | null;
         systems?: SystemPart[] | [] | null;
         deleted?: Date | null;

package/dist/main.cjs

@@ -1218,9 +1218,9 @@ class FAMISDb {
     ];
     try {
       rows = await this.db.with("coreaccounts", (qb) => {
-        qb.select("accounts.*", "core_accounts.active", "core_accounts.coreId", "core_accounts.effective").from("core_accounts").join("accounts", "core_accounts.account", "accounts.account_number");
+        qb.select("accounts.*", "core_accounts.active as coreAccountActive", "core_accounts.coreId", "core_accounts.effective", "core_accounts.id as coreAccountId").from("core_accounts").join("accounts", "core_accounts.account", "accounts.account_number");
       }).with("coreusers", (qb) => {
-        qb.select("users.*", "user_cores.email", "user_cores.coreId").from("user_cores").join("users", "user_cores.userId", "users.id");
+        qb.select("users.*", "user_cores.email", "user_cores.coreId", "user_cores.id as coreUserId").from("user_cores").join("users", "user_cores.userId", "users.id");
       }).from("cores").leftJoin("system", "system.id", "cores.systemId").where(this.db.raw(query)).orderBy(sortColumn, sortDirection).leftJoin(
         this.db.from("user_cores").join("coreusers", { "user_cores.userId": "coreusers.id", "user_cores.coreId": "coreusers.coreId" }).select(
           "user_cores.coreId",
@@ -1305,9 +1305,9 @@ class FAMISDb {
         */
       ];
       records = await this.db.with("coreaccounts", (qb) => {
-        qb.select("accounts.*", "core_accounts.coreId", "core_accounts.effective").from("core_accounts").join("accounts", "core_accounts.account", "accounts.account_number");
+        qb.select("accounts.*", "core_accounts.coreId", "core_accounts.active as coreAccountActive", "core_accounts.effective", "core_accounts.id as coreAccountId").from("core_accounts").join("accounts", "core_accounts.account", "accounts.account_number");
       }).with("coreusers", (qb) => {
-        qb.select("users.*", "user_cores.email", "user_cores.coreId").from("user_cores").join("users", "user_cores.userId", "users.id");
+        qb.select("users.*", "user_cores.email", "user_cores.coreId", "user_cores.id as coreUserId").from("user_cores").join("users", "user_cores.userId", "users.id");
       }).from("cores").leftJoin("system", "system.id", "cores.systemId").where(type, operator, search).leftJoin(
         this.db.from("user_cores").join("coreusers", { "user_cores.userId": "coreusers.id", "user_cores.coreId": "coreusers.coreId" }).select(
           "user_cores.coreId",
@@ -1406,12 +1406,12 @@ class FAMISDb {
    */
   async updateCore(core) {
     let retVal;
-    const columns = ["id", "account", "effective", "facility", "contact", "contactEmail", "systemId", "enabled", "deleted", "coreEmail", "corePhone", "coreAddress", "from_email", "invoice_email"];
+    const columns = ["id", "facility", "contact", "contactEmail", "systemId", "enabled", "deleted", "coreEmail", "corePhone", "coreAddress", "from_email", "invoice_email"];
+    const { id, ...record } = core;
     try {
-      if ("id" in core) {
-        retVal = await this.db("cores").returning(columns).update(core).where("id", core.id);
-        const systemPart = this.getSystemById(retVal.systemId);
-        retVal.systemPart = systemPart;
+      if (id) {
+        await this.db("cores").returning(columns).update(record).where("id", id);
+        retVal = await this.getCore("cores.id", "=", id.toString());
       }
     } catch (e) {
       throw e;
@@ -1447,9 +1447,10 @@ class FAMISDb {
   async updateCoreAccount(account) {
     let retVal;
     const columns = ["id", "account", "effective", "coreId", "active"];
+    const { id, ...record } = account;
     try {
       if ("id" in account) {
-        retVal = await this.db("core_accounts").returning(columns).update(account).where("id", account.id);
+        retVal = await this.db("core_accounts").returning(columns).update(record).where("id", id);
       }
     } catch (e) {
       throw e;
@@ -1473,6 +1474,22 @@ class FAMISDb {
     }
     return retVal;
   }
+  /**
+   *
+   * Delete core account
+   * @param {coreAccountId} string core account id
+   * @returns {Promise<CoreAccount>} core account object
+   * @memberof FAMISDb
+   */
+  async deleteCoreAccount(coreAccountId) {
+    let retVal;
+    try {
+      retVal = await this.db("core_accounts").where("id", coreAccountId).delete();
+    } catch (e) {
+      throw e;
+    }
+    return retVal;
+  }
   /**
    *
    * Get system part by ID
@@ -1523,23 +1540,33 @@ class FAMISDb {
     let records;
     let retVal = [];
     try {
-      records = await this.db("cores").select(
-        "cores.id",
-        "core_accounts.account",
-        "core_accounts.effective",
-        "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("core_accounts", "cores.id", "=", "core_accounts.coreId").where("enabled", "1").andWhere("core_accounts.active", "True").groupBy("cores.id").orderBy("cores.id", "desc");
+      records = await this.db.with("coreaccounts", (qb) => {
+        qb.select("accounts.*", "core_accounts.active as coreAccountActive", "core_accounts.coreId", "core_accounts.effective", "core_accounts.id as coreAccountId").from("core_accounts").join("accounts", "core_accounts.account", "accounts.account_number");
+      }).with("coreusers", (qb) => {
+        qb.select("users.*", "user_cores.email", "user_cores.coreId", "user_cores.id as coreUserId").from("user_cores").join("users", "user_cores.userId", "users.id");
+      }).from("cores").leftJoin(
+        this.db.from("user_cores").join("coreusers", { "user_cores.userId": "coreusers.id", "user_cores.coreId": "coreusers.coreId" }).select(
+          "user_cores.coreId",
+          this.db.raw(
+            "case when count(coreusers) = 0 then '[]' else jsonb_agg(coreusers.*) end as users"
+          )
+        ).groupBy(["user_cores.coreId"]).as("user_cores"),
+        "user_cores.coreId",
+        "cores.id"
+      ).leftJoin(
+        this.db.from("core_accounts").join("coreaccounts", { "core_accounts.account": "coreaccounts.account_number", "core_accounts.coreId": "coreaccounts.coreId" }).select(
+          "core_accounts.coreId",
+          this.db.raw(
+            "case when count(coreaccounts) = 0 then '[]' else jsonb_agg(coreaccounts.*) end as accounts"
+          )
+        ).groupBy(["core_accounts.coreId"]).as("core_accounts"),
+        "core_accounts.coreId",
+        "cores.id"
+      ).select(
+        "cores.*",
+        "user_cores.users",
+        "core_accounts.accounts"
+      ).where("enabled", "1").orderBy("cores.id", "desc");
       if (records.length) {
         retVal = records;
       }
@@ -1608,9 +1635,10 @@ class FAMISDb {
   async updateCoreUser(user) {
     let retVal;
     const columns = ["id", "userId", "coreId", "email"];
+    const { id, ...record } = user;
     try {
       if ("id" in user) {
-        retVal = await this.db("user_cores").returning(columns).update(user).where("id", user.id);
+        retVal = await this.db("user_cores").returning(columns).update(record).where("id", id);
       }
     } catch (e) {
       throw e;
@@ -1618,12 +1646,10 @@ class FAMISDb {
     return retVal;
   }
   /**
-   *
-   * Add core user
-   * @param {CoreUser} coreUser core user object
-   * @param {User} user user object
-   * @returns {Promise<CoreUser>} core user object
-   * @memberof FAMISDb
+   * This function adds a new CoreUser to the database. If the user already exists, it updates the existing record.
+   * @param {CoreUser} coreUser - The CoreUser object containing details about the user.
+   * @param {User} [user] - An optional User object that could contain additional details.
+   * @return {Promise<CoreUser>} A Promise that resolves to the newly added or updated CoreUser, if successfully added and returned from the database; otherwise it rejects with an error.
    */
   async addCoreUser(coreUser, user) {
     let retVal;
@@ -1644,6 +1670,22 @@ class FAMISDb {
     }
     return retVal;
   }
+  /**
+   *
+   * Delete core user
+   * @param {coreUserId} string core user object
+   * @returns {Promise<CoreUser>} core user object
+   * @memberof FAMISDb
+   */
+  async deleteCoreUser(coreUserId) {
+    let retVal;
+    try {
+      retVal = await this.db("user_cores").where("id", coreUserId).delete();
+    } catch (e) {
+      throw e;
+    }
+    return retVal;
+  }
   /**
    *
    * Get a user's cores they manage
@@ -2093,23 +2135,38 @@ class FAMISDb {
     return response;
   }
   /**
-   * Add an additional delivery email to an expense account for a core
-   * @param {string} accountNumber - 13 digit famis account or customernumber
+   * Get additional delivery emails to expense accounts for a core by core id
+   * and account number
    * @param {number} coreId - Core ID
-   * @param {string} email - email address
+   * @param {string} account - account number
+   * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+   * @memberof FAMISDb
+   */
+  async getCoreAccountAdditionalEmailsByCoreIdAccount(coreId, account) {
+    let response = [];
+    try {
+      const records = await this.db("core_account_emails").where({
+        core_id: coreId,
+        account_number: account
+      }).whereNull("deleted");
+      response = records;
+    } catch (e) {
+      console.log(e);
+      throw e;
+    }
+    return response;
+  }
+  /**
+   * Add an additional delivery email to an expense account for a core
+   * @param {CoreAccountEmail} record - core account email delivery record
    * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
    * @memberof FAMISDb
    */
-  async addCoreAccountAdditionalEmails(accountNumber, coreId, email) {
+  async addCoreAccountAdditionalEmail(record) {
     let response = null;
     const columns = ["uid", "core_id", "account_number", "email", "created", "deleted"];
     try {
-      const records = await this.db("core_account_emails").returning(columns).insert({
-        core_id: coreId,
-        account_number: accountNumber,
-        email,
-        created: this.db.raw("NOW")
-      });
+      const records = await this.db("core_account_emails").returning(columns).insert(record);
       response = records.length ? records[0] : records;
     } catch (e) {
       console.log(e);
@@ -2123,12 +2180,12 @@ class FAMISDb {
    * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
    * @memberof FAMISDb
    */
-  async removeCoreAccountAdditionalEmails(uid) {
+  async removeCoreAccountAdditionalEmail(uid) {
     let response = null;
     const columns = ["uid", "core_id", "account_number", "email", "created", "deleted"];
     try {
       const records = await this.db("core_account_emails").returning(columns).update({
-        deleted: this.db.raw("NOW")
+        deleted: this.db.raw("CURRENT_TIMESTAMP")
       }).where({ uid });
       response = records.length ? records[0] : records;
     } catch (e) {