@tomei/sso 0.41.0 → 0.42.0

package/package.json

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

package/src/components/group/group.ts

@@ -1780,4 +1780,124 @@ export class Group extends TreeNodeBase<Group> {
       throw error;
     }
   }
+
+  public static async getHierarchy(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    Status?: string,
+    Type?: GroupTypeEnum,
+    ParentGroupCode?: string,
+  ) {
+    // This method retrieves all group records from the sso_Group table in a hierarchical tree structure based on
+    // the ParentGroupCode. The hierarchy respects any filtering options passed, such as status or group type, and
+    // checks privileges of the requesting user.
+
+    // Part 1: Privilege Checking
+    // Call loginUser.checkPrivileges() by passing:
+    // - SystemCode: Retrieved from the system configuration.
+    // - PrivilegeCode: 'GROUP_VIEW'.
+    // Ensure the user has privileges to view group information.
+    const systemCode = ApplicationConfig.getComponentConfigValue('system-code');
+    const isPrivileged = await loginUser.checkPrivileges(
+      systemCode,
+      'GROUP_VIEW',
+    );
+
+    if (!isPrivileged) {
+      throw new ClassError(
+        'Group',
+        'GroupErrMsg04',
+        'User is not privileged to view group',
+      );
+    }
+
+    // Part 2: Prepare Filters
+    // Set the default filter for Status to "Active", unless specified.
+    // Use optional filters such as Type and ParentGroupCode if provided.
+    const queryObj: any = {};
+
+    let options: any = {
+      transaction: dbTransaction,
+    };
+
+    const search = {
+      Status: Status ? Status : 'Active',
+      Type: Type,
+      ParentGroupCode: ParentGroupCode,
+    };
+
+    if (search) {
+      Object.entries(search).forEach(([key, value]) => {
+        if (value) {
+          queryObj[key] = {
+            [Op.substring]: value,
+          };
+        }
+      });
+
+      options = {
+        ...options,
+        where: queryObj,
+      };
+
+      // Part 3: Retrieve Group Data
+      // Use Sequelize's findAll() method with the provided filters (status, type, and parentGroupCode) to query the sso_Group table.
+      // Recursively build the group tree based on ParentGroupCode relationships.
+
+      const result = await Group._Repo.findAll(options);
+      const data = result.map((group) => new Group(group.get({ plain: true })));
+
+      const generateTree = async (groups) => {
+        // Create a map for easy lookup by code
+
+        const data = groups.map((group) => {
+          return {
+            GroupCode: group.ObjectId,
+            Name: group.Name,
+            Description: group.Description,
+            Type: group.Type,
+            ParentGroupCode: group.ParentGroupCode,
+            InheritParentPrivilegeYN: group.InheritParentPrivilegeYN,
+            InheritParentSystemAccessYN: group.InheritParentSystemAccessYN,
+            Path: group._Path,
+            Status: group.Status,
+            CreatedById: group._CreatedById,
+            CreatedAt: group._CreatedAt,
+            UpdatedById: group._UpdatedById,
+            UpdatedAt: group._UpdatedAt,
+            childrens: [],
+          };
+        });
+        const groupMap = {};
+        data.forEach((group) => {
+          group.childrens = [];
+          groupMap[group.GroupCode] = group;
+        });
+
+        // Initialize the root nodes (those without a parentCode)
+        const tree = [];
+
+        data.forEach((group) => {
+          if (group.ParentGroupCode) {
+            // Add this group as a child of its parent
+            const parent = groupMap[group.ParentGroupCode];
+            if (parent) {
+              parent.childrens.push(group);
+            }
+          } else {
+            // If no parentCode, it's a root node
+            tree.push(group);
+          }
+        });
+
+        return tree;
+      };
+
+      const tree = await generateTree(data);
+
+      // Part 4: Return Results
+      // Return the tree structure with child groups (under the childrens key) included only if a group has child groups.
+      return tree;
+    }
+  }
 }

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

@@ -1,6 +1,10 @@
-import { ClassError, HashTable, ObjectBase } from '@tomei/general';
+import { ClassError, ObjectBase } from '@tomei/general';
 import { GroupReportingUserRepository } from './group-reporting-user.repository';
 import { IGroupReportingUserAttr } from '../../interfaces/group-reporting-user.interface';
+import { User } from '../login-user/user';
+import { Group } from '../group/group';
+import { ApplicationConfig } from '@tomei/config';
+import { ActionEnum, Activity } from '@tomei/activity-history';
 
 export class GroupReportingUser extends ObjectBase {
   ObjectId: string;
@@ -78,4 +82,113 @@ export class GroupReportingUser extends ObjectBase {
       );
     }
   }
+
+  async createGroupReportingUser(
+    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 newly created record.
+    try {
+      //Creates a new 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.
+      const group = await Group.init(dbTransaction, groupCode);
+      // Ensure userId exists in the sso_User table by calling the User.init() method.
+      const user = await User.init(dbTransaction, userId);
+      // Privilege Checking
+      // Call the loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      //   PrivilegeCode: "GROUP_REPORTING_USER_CREATE".
+
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_CREATE',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg02',
+          'User does not have the privilege to create Group Reporting User',
+        );
+      }
+
+      // 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,
+        },
+        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',
+          'createGroupReportingUser',
+        );
+      }
+      // Create 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 = loginUser.UserId;
+      this._CreatedAt = new Date();
+
+      const entityValueAfter: any = {
+        GroupCode: groupCode,
+        UserId: userId,
+        Rank: rank,
+        Status: status,
+        CreatedById: loginUser.UserId,
+        CreatedAt: this._CreatedAt,
+      };
+
+      const newGroupReportingUser = await GroupReportingUser._Repo.create(
+        entityValueAfter,
+        {
+          transaction: dbTransaction,
+        },
+      );
+
+      entityValueAfter.GroupReportingUserId =
+        newGroupReportingUser.GroupReportingUserId;
+
+      // Record Create Activity
+      // Instantiate a new activity from the Activity class, and set:\
+      // ActivityId: activity.createId()
+      // Action: ActionEnum.Create
+      // Description: Create 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.Action = ActionEnum.CREATE;
+      activity.Description = 'Create Group Reporting User';
+      activity.EntityType = 'GroupReportingUser';
+      activity.EntityId = newGroupReportingUser.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 Created GroupReportingUser
+      // Return the newly created GroupReportingUser instance, including all the relevant details like GroupReportingUserId, groupCode, userId, rank, status, and timestamps for CreatedAt.
+      return this;
+    } catch (error) {
+      throw error;
+    }
+  }
 }