@tomei/sso 0.43.1 → 0.44.0

package/package.json

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

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

@@ -8,4 +8,16 @@ export class GroupReportingUserRepository
   constructor() {
     super(GroupReportingUserModel);
   }
+
+  async destroy(
+    groupReportingUserId: number,
+    dbTransaction: any,
+  ): Promise<void> {
+    await GroupReportingUserModel.destroy({
+      where: {
+        GroupReportingUserId: groupReportingUserId,
+      },
+      transaction: dbTransaction,
+    });
+  }
 }

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

@@ -5,6 +5,7 @@ import { User } from '../login-user/user';
 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;
@@ -215,4 +216,146 @@ export class GroupReportingUser extends ObjectBase {
       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.
+    groupCode?: string, //The code of the group whose reporting users should be retrieved.
+  ) {
+    //This public static method retrieves all GroupReportingUser records for a given group from the sso_GroupReportingUser table.
+
+    try {
+      // Part 1: Privilege Check
+      // Call loginUser.checkPrivileges() method by passing:
+      // - SystemCode: Retrieve from the app config.
+      // - PrivilegeCode: GROUP_REPORTING_USER_VIEW.
+      // If the user does not have the required privilege, throw a ForbiddenError.
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_VIEW',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Group',
+          'GroupReportingUserErrMsg05',
+          'You do not have the privilege to view group reporting user',
+        );
+      }
+
+      // Part 2: Group Existence Check
+      // Call Group.init(dbTransaction, groupCode) to verify the group exists.
+      // If the group does not exist, throw a NotFoundError.
+      await Group.init(dbTransaction, groupCode);
+
+      // Part 3: Retrieve Group Reporting Users
+      // Call GroupReportingUser._Repo.findAll() to retrieve all users associated with the provided groupCode.
+      // The users should be sorted by Rank in ascending order (Rank 1, Rank 2, and so on).
+      // Ensure the query is performed within the dbTransaction.
+      const result = await GroupReportingUser._Repo.findAll({
+        where: {
+          GroupCode: groupCode,
+        },
+        order: [
+          ['Rank', 'ASC'], // or 'DESC' for descending order
+        ],
+        transaction: dbTransaction,
+      });
+
+      // Part 4: Return Results
+      // Return the array of GroupReportingUser records found.
+      const reportingUser: GroupReportingUser[] = [];
+      if (result.length > 0) {
+        for (let i = 0; i < result.length; i++) {
+          reportingUser.push(
+            new GroupReportingUser(result[i].get({ plain: true })),
+          );
+        }
+      }
+      return reportingUser;
+    } catch (error) {
+      // Part 5: Handle Errors
+      // Catch and handle any errors during the execution. If an error occurs, ensure the transaction is rolled back.
+      throw error;
+    }
+  }
+
+  public static async removeGroupReportingUser(
+    loginUser: User, //The user performing the operation, used for privilege checking and logging.
+    dbTransaction: Transaction, // The database transaction object to ensure the operation's atomicity.
+    groupReportingUserId: number, //The ID of the GroupReportingUser to be removed.
+  ): Promise<void> {
+    // This method removes a GroupReportingUser record from the database.
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      // PrivilegeCode: "GROUP_REPORTING_USER_REMOVE".
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_REMOVE',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg06',
+          'Insufficient privileges to remove a user from the group',
+        );
+      }
+
+      // Part 2: Find User
+      // Call GroupReportingUser.init(dbTransaction, groupReportingUserId) to check if the user exists.
+      const groupReportingUser = await GroupReportingUser.init(
+        dbTransaction,
+        groupReportingUserId.toString(),
+      );
+
+      // Part 3: Remove User
+      // Call GroupReportingUser._Repo.destroy({ where: { GroupReportingUserId: groupReportingUserId }, transaction: dbTransaction }) to remove the user from the database.
+      await GroupReportingUser._Repo.destroy(
+        groupReportingUserId,
+        dbTransaction,
+      );
+
+      // Part 4: Record Create Activity
+      // Initialise EntityValueBefore variable and set it to the GroupReportingUser instance before destruction.
+      const entityValueBefore = {
+        GroupReportingUserId: groupReportingUser.GroupReportingUserId,
+        GroupCode: groupReportingUser.GroupCode,
+        UserId: groupReportingUser.UserId,
+        Rank: groupReportingUser.Rank,
+        Status: groupReportingUser.Status,
+        CreatedById: groupReportingUser.CreatedById,
+        CreatedAt: groupReportingUser.CreatedAt,
+        UpdatedById: groupReportingUser.UpdatedById,
+        UpdatedAt: groupReportingUser.UpdatedAt,
+      };
+      // Instantiate a new activity from the Activity class, and set:
+      const activity = new Activity();
+      // ActivityId: activity.createId()
+      // Action: ActionEnum.Delete
+      // Description: Remove Group Reporting User
+      // EntityType: GroupReportingUser
+      // EntityId: groupReportingUserId
+      // EntityValueBefore: Stringified representation of the GroupReportingUser instance before destroy
+      // EntityValueAfter: Stringified empty object ({})
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.DELETE;
+      activity.Description = 'Remove Group Reporting User';
+      activity.EntityType = 'GroupReportingUser';
+      activity.EntityId = groupReportingUserId.toString();
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify({});
+      // Call the activity.create() method by passing:
+      // dbTransaction
+      // userId: loginUser.UserId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+    } catch (error) {
+      throw error;
+    }
+  }
 }