@tomei/sso 0.46.7 → 0.46.8

package/package.json

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

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

@@ -8,4 +8,18 @@ export class UserSystemAccessRepository
   constructor() {
     super(UserSystemAccessModel);
   }
+
+  async delete(UserSystemAccessId: number, dbTransaction?: any) {
+    try {
+      const options = {
+        where: {
+          UserSystemAccessId: UserSystemAccessId,
+        },
+        transaction: dbTransaction,
+      };
+      await UserSystemAccessModel.destroy(options);
+    } catch (error) {
+      throw new Error(`An Error occured when delete : ${error.message}`);
+    }
+  }
 }

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

@@ -162,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,
@@ -301,4 +302,178 @@ export class UserSystemAccess extends ObjectBase {
       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;
+    }
+  }
 }