@tomei/sso 0.47.0 → 0.48.0

package/src/components/user-system-access/user-system-access.ts

@@ -6,6 +6,8 @@ import { System } from '../system/system';
 import { ApplicationConfig } from '@tomei/config';
 import SystemModel from '../../models/system.entity';
 import UserModel from '../../models/user.entity';
+import { ActionEnum, Activity } from '@tomei/activity-history';
+import { Op } from 'sequelize';
 
 export class UserSystemAccess extends ObjectBase {
   ObjectType = 'UserSystemAccess';
@@ -85,6 +87,7 @@ export class UserSystemAccess extends ObjectBase {
     whereOption: {
       //An object containing filter criteria, specifically:
       UserId: number; //The ID of the user whose system access records are to be retrieved.
+      SystemCode?: string;
     },
     pagination: {
       //An object containing pagination parameters:
@@ -159,6 +162,7 @@ export class UserSystemAccess extends ObjectBase {
       return {
         records: userSystemAccesses.rows.map((userSystemAccess) => {
           return {
+            UserSystemAccessId: userSystemAccess.UserSystemAccessId,
             SystemName: userSystemAccess.System.Name,
             SystemCode: userSystemAccess.System.SystemCode,
             Status: userSystemAccess.Status,
@@ -178,4 +182,298 @@ export class UserSystemAccess extends ObjectBase {
       throw error;
     }
   }
+
+  public static async createAccess(
+    loginUser: User, //The currently logged-in user initiating the request.
+    dbTransaction: any, //The active database transaction to ensure consistency during the query.
+    UserId: string, //The user ID for whom system access is being created.
+    SystemCode: string, //The system code for which access is being granted.
+    Status: string, //The status of access ('Active' or 'Inactive').
+  ) {
+    try {
+      // Part 1: Privilege Checking:
+      // Call loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      // PrivilegeCode: 'USER_SYSTEM_ACCESS_CREATE'.
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const privilegeCode = 'USER_SYSTEM_ACCESS_CREATE';
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        privilegeCode,
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'UserSystemAccess',
+          'UserSystemAccessErrMsg01',
+          'You do not have permission to access this resource.',
+        );
+      }
+      // Part 2: Validation for Existing Access
+      // Use the UserSystemAccess.findAll() method to check if the user already has access to the specified system:
+      // Pass the following parameters:
+      // loginUser
+      // dbTransaction
+      // whereOption: set to UserId = UserId and SystemCode = SystemCode.
+      // If a record is found, throw an error indicating that access for this user and system already exists.
+
+      const isExist = await UserSystemAccess._Repository.findAll({
+        where: { [Op.and]: [{ UserId: UserId }, { SystemCode: SystemCode }] },
+        transaction: dbTransaction,
+      });
+
+      if (isExist?.length > 0) {
+        throw new ClassError(
+          'UserSystemAccess',
+          'UserSystemAccessErrMsg01',
+          'User already have access to this system',
+        );
+      }
+
+      // Part 3: Insert System Access Record
+      // After successful validation, create a new instance of UserSystemAccess with the following fields:
+      // - UserId: set to the UserId parameter.
+      // - SystemCode: set to the SystemCode parameter.
+      // - Status: set to the Status parameter.
+      // - CreatedById: set to loginUser.UserId.
+      // - CreatedAt: set to the current timestamp.
+      // - UpdatedById: set to loginUser.UserId.
+      // - UpdatedAt: set to the current timestamp (same as CreatedAt).
+      // Save the new UserSystemAccess instance in the database within the dbTransaction.
+
+      const newUserSystemAccess = new UserSystemAccess();
+      newUserSystemAccess.UserId = parseInt(UserId);
+      newUserSystemAccess.SystemCode = SystemCode;
+      newUserSystemAccess.Status = Status;
+      newUserSystemAccess._CreatedById = loginUser.UserId;
+      newUserSystemAccess._CreatedAt = new Date();
+      newUserSystemAccess._UpdatedById = loginUser.UserId;
+      newUserSystemAccess._UpdatedAt = new Date();
+
+      const payload = {
+        UserId: newUserSystemAccess.UserId,
+        SystemCode: newUserSystemAccess.SystemCode,
+        Status: newUserSystemAccess.Status,
+        CreatedById: newUserSystemAccess.CreatedById,
+        CreatedAt: newUserSystemAccess.CreatedAt,
+        UpdatedById: newUserSystemAccess.UpdatedById,
+        UpdatedAt: newUserSystemAccess.UpdatedAt,
+      };
+
+      const systemAccess = await UserSystemAccess._Repository.create(payload, {
+        transaction: dbTransaction,
+      });
+
+      // Part 4: Record Activity History
+      // Initialize an empty object ({}) as EntityValueBefore.
+      // Set EntityValueAfter to the stringified version of the newly created UserSystemAccess instance.
+      // Create a new activity log entry:
+      // ActivityId: auto-generated by calling activity.createId().
+      // Action: set to ActionEnum.Create.
+      // Description: set to "Create User System Access".
+      // EntityType: set to UserSystemAccess.
+      // EntityId: set to the newly created UserSystemAccess.UserSystemAccessId.
+      // EntityValueBefore: set to {} (empty).
+      // EntityValueAfter: set to the stringified version of the new access record.
+      // Call the activity.create() method, passing:
+      // dbTransaction
+      // userId: set to loginUser.UserId.
+
+      const entityValueBefore = {};
+
+      //Instantiate new activity
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.CREATE;
+      activity.Description = 'Create User System Access';
+      activity.EntityType = 'UserSystemAccess';
+      activity.EntityId = systemAccess.UserSystemAccessId?.toString();
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(payload);
+
+      //Call Activity.create method
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      // Part 5: Return Newly Created Record
+      // Return the newly created UserSystemAccess instance with all relevant fields, including UserSystemAccessId, SystemCode, Status, CreatedAt, and CreatedById.
+      newUserSystemAccess.UserSystemAccessId = systemAccess.UserSystemAccessId;
+      return newUserSystemAccess;
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public async update(
+    loginUser: User, //The user object representing the currently logged-in user.
+    dbTransaction: any, //The database transaction instance for managing the transaction scope.
+    Status: string, //The new access status (Active/Inactive) for the user system access.
+  ) {
+    try {
+      // Part 1: Update Access
+      // Call the UserSystemAccess._Repo.update() method to perform the update operation, passing:
+      // - Status: The new access status.
+      // - UpdatedById: loginUser.UserId (to indicate who updated the record).
+      // - UpdatedAt: Set to the current date and time.
+      // - dbTransaction: The database transaction instance.
+
+      const entityValueBefore = {
+        UserId: this.UserId,
+        SystemCode: this.SystemCode,
+        Status: this.Status,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+      await UserSystemAccess._Repository.update(
+        {
+          Status: Status,
+          UpdatedById: loginUser.UserId,
+          UpdatedAt: new Date(),
+        },
+        {
+          where: {
+            UserSystemAccessId: this.UserSystemAccessId,
+          },
+          transaction: dbTransaction,
+        },
+      );
+
+      const entityValueAfter = {
+        UserId: this.UserId,
+        SystemCode: this.SystemCode,
+        Status: Status,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: loginUser.UserId,
+        UpdatedAt: new Date(),
+      };
+
+      // Part 2: Record Activity History
+      // Initialize a variable entityValueBefore to store the current state of the user system access record before the update.
+      // Create an instance of the Activity class and set the following properties:
+      // - ActivityId: Call activity.createId().
+      // - Action: Set to ActionEnum.Update.
+      // - Description: Set to Update User System Access.
+      // - EntityType: Set to UserSystemAccess.
+      // - EntityId: Use the ID of the updated user system access record.
+      // - EntityValueBefore: Stringify entityValueBefore to capture the state before the update.
+      // - EntityValueAfter: Stringify the updated user system access record to capture the new state after the update.
+      // Call the activity create method with the following parameters:
+      // - dbTransaction
+      // - userId: loginUser.UserId
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Update User System Access';
+      activity.EntityType = 'UserSystemAccess';
+      activity.EntityId = this.UserSystemAccessId + '';
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      // Part 3: Return Updated Record
+      // Retrieve the updated user system access record from the database or return the updated instance as needed.
+
+      // Part 5: Return Newly Created Record
+      // Return the newly created UserSystemAccess instance with all relevant fields, including UserSystemAccessId, SystemCode, Status, CreatedAt, and CreatedById.
+      return entityValueAfter;
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public static async remove(
+    loginUser: User, //The currently logged-in user initiating the request.
+    dbTransaction: any, //The active database transaction to ensure consistency during the query.
+    UserSystemAccessId: number, //The unique identifier of the User System Access record to be deleted.
+  ) {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() method by passing:
+      // - SystemCode: Retrieve from app config.
+      // - PrivilegeCode: 'USER_SYSTEM_ACCESS_REMOVE'.
+      // If the user does not have the required privileges, throw an appropriate exception.
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const privilegeCode = 'USER_SYSTEM_ACCESS_REMOVE';
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        privilegeCode,
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'UserSystemAccess',
+          'UserSystemAccessErrMsg01',
+          'You do not have permission to access this resource.',
+        );
+      }
+
+      // Part 2: Retrieve Record
+      // Use the UserSystemAccessRepo.findById(UserSystemAccessId) method to retrieve the record.
+      // If the record does not exist, throw an exception indicating the record was not found.
+
+      const userSystemAccess = await UserSystemAccess._Repository.findOne({
+        where: {
+          UserSystemAccessId: UserSystemAccessId,
+        },
+        transaction: dbTransaction,
+      });
+
+      if (!userSystemAccess) {
+        throw new ClassError(
+          'UserSystemAccess',
+          'UserSystemAccessErrMsg02',
+          'User System Access not Found',
+        );
+      }
+
+      // Part 3: Delete Record
+      // Call the UserSystemAccess._Repo.delete() method, passing:
+      // - UserSystemAccessId
+      // dbTransaction to permanently delete the record from the database.
+      await UserSystemAccess._Repository.delete(
+        UserSystemAccessId,
+        dbTransaction,
+      );
+
+      const entityValueBefore = {
+        UserId: userSystemAccess.UserId,
+        SystemCode: userSystemAccess.SystemCode,
+        Status: userSystemAccess.Status,
+        CreatedById: userSystemAccess.CreatedById,
+        CreatedAt: userSystemAccess.CreatedAt,
+        UpdatedById: userSystemAccess.UpdatedById,
+        UpdatedAt: userSystemAccess.UpdatedAt,
+      };
+
+      // Part 4: Record Activity History
+      // Instantiate a new activity from the Activity class, and set:
+      // - ActivityId: activity.createId()
+      // - Action: ActionEnum.Delete
+      // - Description: Delete User System Access
+      // - EntityType: UserSystemAccess
+      // - EntityId: UserSystemAccessId
+      // - EntityValueBefore: Stringified representation of the record before deletion.
+      // - EntityValueAfter: null.
+      // Call the activity.create() method by passing:
+      // - dbTransaction
+      // - userId: loginUser.UserId.
+
+      //Instantiate new activity
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.DELETE;
+      activity.Description = 'Delete User System Access';
+      activity.EntityType = 'UserSystemAccess';
+      activity.EntityId = UserSystemAccessId?.toString();
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify({});
+
+      //Call Activity.create method
+      await activity.create(loginUser.ObjectId, dbTransaction);
+    } catch (error) {
+      throw error;
+    }
+  }
 }