@tomei/sso 0.51.8 → 0.51.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/sso",
-  "version": "0.51.8",
+  "version": "0.51.9",
   "description": "Tomei SSO Package",
   "main": "dist/index.js",
   "scripts": {

package/src/components/group-reporting-user/group-reporting-user.ts

@@ -1,3 +1,4 @@
+import { Op, Transaction } from 'sequelize';
 import { ClassError, ObjectBase } from '@tomei/general';
 import { GroupReportingUserRepository } from './group-reporting-user.repository';
 import { IGroupReportingUserAttr } from '../../interfaces/group-reporting-user.interface';
@@ -6,7 +7,6 @@ import UserModel from '../../models/user.entity';
 import { Group } from '../group/group';
 import { ApplicationConfig } from '@tomei/config';
 import { ActionEnum, Activity } from '@tomei/activity-history';
-import { Transaction } from 'sequelize';
 
 export class GroupReportingUser extends ObjectBase {
   ObjectId: string;
@@ -216,6 +216,151 @@ export class GroupReportingUser extends ObjectBase {
     }
   }
 
+  async updateGroupReportingUser(
+    loginUser: User, //The user performing the operation(typically the logged -in user).
+    dbTransaction: any, //Database transaction object to ensure the operation is atomic.
+    groupCode: string, //The code of the group to which the user is being assigned.
+    userId: number, //The ID of the user to be added to the group.
+    rank: number, //The rank to be assigned to the user in the group.
+    status: 'Active' | 'Inactive', //The initial status of the user in the group.
+  ): Promise<GroupReportingUser> {
+    // Returns a GroupReportingUser instance representing the updated record.
+    try {
+      //Update a group reporting user entry in the sso_GroupReportingUser table.
+
+      // Validate Input Parameters
+      // Ensure groupCode exists in the sso_Group table by calling the Group.init() method.
+      await Group.init(dbTransaction, groupCode);
+      // Ensure userId exists in the sso_User table by calling the User.init() method.
+      await User.init(dbTransaction, userId);
+      // Privilege Checking
+      // Call the loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      //   PrivilegeCode: "GROUP_REPORTING_USER_UPDATE".
+
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_CREATE',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg02',
+          'Insufficient privileges to update a user to the group',
+        );
+      }
+
+      //Get the current groupReportingUser
+      const currentGroupReportingUser = await GroupReportingUser._Repo.findOne({
+        where: {
+          GroupCode: groupCode,
+          GroupReportingUserId: this.GroupReportingUserId,
+        },
+        transaction: dbTransaction,
+      });
+
+      // Check for Duplicate User in Group
+      // Query the sso_GroupReportingUser table to see if the userId already exists in the specified groupCode.
+      const groupReportingUser = await GroupReportingUser._Repo.findOne({
+        where: {
+          GroupCode: groupCode,
+          UserId: userId,
+          GroupReportingUserId: {
+            [Op.ne]: this.GroupReportingUserId,
+          },
+        },
+        transaction: dbTransaction,
+      });
+      // If the user already exists in the group, throw an error indicating the user is already part of the group.
+      if (groupReportingUser) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg03',
+          'User already exists in the group',
+          'updateGroupReportingUser',
+        );
+      }
+      //Query the sso_GroupReportingUser table to see if the rank already exists in the specified groupCode.
+      //If the rank already exists in the group, throw an error indicating the rank is already in of the group.
+      const groupReportingUserRank = await GroupReportingUser._Repo.findOne({
+        where: {
+          GroupCode: groupCode,
+          Rank: rank,
+          GroupReportingUserId: {
+            [Op.ne]: this.GroupReportingUserId,
+          },
+        },
+        transaction: dbTransaction,
+      });
+      if (groupReportingUserRank) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg04',
+          'Rank already exists in the group',
+          'updateGroupReportingUser',
+        );
+      }
+
+      // UPDATE GroupReportingUser Entry
+      // If validation and privilege checks pass, insert a new record in the sso_GroupReportingUser table with the provided groupCode, userId, rank, status, and loginUser.UserId.Automatically capture the current timestamp for CreatedAt.
+      this.GroupCode = groupCode;
+      this.UserId = userId;
+      this.Rank = rank;
+      this.Status = status;
+      this._CreatedById = currentGroupReportingUser.CreatedById;
+      this._CreatedAt = currentGroupReportingUser.CreatedAt;
+      this._UpdatedAt = new Date();
+      this._UpdatedById = loginUser.UserId;
+
+      const entityValueAfter: any = {
+        GroupCode: groupCode,
+        UserId: userId,
+        Rank: rank,
+        Status: status,
+        CreatedById: currentGroupReportingUser.CreatedById,
+        CreatedAt: this._CreatedAt,
+        UpdatedById: loginUser.UserId,
+        UpdatedAt: this._UpdatedAt,
+      };
+
+      await GroupReportingUser._Repo.update(entityValueAfter, {
+        where: {
+          GroupReportingUserId: this.GroupReportingUserId,
+        },
+        transaction: dbTransaction,
+      });
+
+      // Record Update Activity
+      // Instantiate a new activity from the Activity class, and set:\
+      // ActivityId: activity.createId()
+      // Action: ActionEnum.Update
+      // Description: Update Group Reporting User
+      // EntityType: GroupReportingUser
+      // EntityId: newGroupReportingUser.GroupReportingUserId
+      // EntityValueBefore: Stringified empty object({})
+      // EntityValueAfter: EntityValueAfter(stringified representation of the newly created entity)
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Update Group Reporting User';
+      activity.EntityType = 'GroupReportingUser';
+      activity.EntityId = this.GroupReportingUserId.toString();
+      activity.EntityValueBefore = JSON.stringify({});
+      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
+      // Call the activity create() method by passing:
+      // dbTransaction
+      // userId: loginUser.UserId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+      // Return the Updated GroupReportingUser
+      // Return the updated GroupReportingUser instance, including all the relevant details like GroupReportingUserId, groupCode, userId, rank, status, and timestamps for CreatedAt.
+      return this;
+    } catch (error) {
+      throw error;
+    }
+  }
+
   public static async findAllGroupReportingUsers(
     loginUser: User, //The authenticated user requesting the information.
     dbTransaction: any, //The database transaction to be used for this operation.