@tomei/sso 0.30.1 → 0.31.0

package/package.json

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

package/src/components/group/group.ts

@@ -1,7 +1,12 @@
-import { ClassError, HashTable, ObjectBase } from '@tomei/general';
+import { ClassError, ObjectBase } from '@tomei/general';
 import { GroupRepository } from './group.repository';
 import { IGroupAttr } from '../../interfaces/group.interface';
 import { GroupTypeEnum } from 'enum';
+import { LoginUser } from '../login-user/login-user';
+import { IGroupSearchAttr } from '../../interfaces/group-search-attr.interface';
+import { ApplicationConfig } from '@tomei/config';
+import { Op } from 'sequelize';
+import { ActionEnum, Activity } from '@tomei/activity-history';
 
 export class Group extends ObjectBase {
   ObjectId: string;
@@ -9,7 +14,6 @@ export class Group extends ObjectBase {
   TableName: 'sso_Group';
   ObjectType = 'Group';
 
-  GroupCode: string;
   Name: string;
   Description: string;
   Type: GroupTypeEnum;
@@ -23,6 +27,14 @@ export class Group extends ObjectBase {
   private _UpdatedAt: Date;
   private static _Repo = new GroupRepository();
 
+  get GroupCode(): string {
+    return this.ObjectId;
+  }
+
+  set GroupCode(value: string) {
+    this.ObjectId = value;
+  }
+
   get CreatedById(): number {
     return this._CreatedById;
   }
@@ -78,4 +90,194 @@ export class Group extends ObjectBase {
       );
     }
   }
+
+  public static async findAll(
+    page: number,
+    row: number,
+    dbTransaction: any,
+    loginUser: LoginUser,
+    search?: IGroupSearchAttr,
+  ) {
+    //This method will list all group based on the query params.
+    //Part 1: Privilege Checking
+    const systemCode = ApplicationConfig.getComponentConfigValue('system-code');
+    const isPrivileged = await loginUser.checkPrivileges(
+      systemCode,
+      'GROUP_LIST',
+    );
+
+    if (!isPrivileged) {
+      throw new ClassError(
+        'Group',
+        'GroupErrMsg04',
+        'User is not privileged to list group',
+      );
+    }
+
+    //Part 2: Retrieve listing
+    const queryObj: any = {};
+
+    let options: any = {
+      transaction: dbTransaction,
+    };
+
+    if (page && row) {
+      options = {
+        ...options,
+        limit: row,
+        offset: row * (page - 1),
+        order: [['CreatedAt', 'DESC']],
+      };
+    }
+
+    if (search) {
+      Object.entries(search).forEach(([key, value]) => {
+        queryObj[key] = {
+          [Op.substring]: value,
+        };
+      });
+
+      options = {
+        ...options,
+        where: queryObj,
+      };
+      return await Group._Repo.findAllWithPagination(options);
+    }
+  }
+
+  public static async create(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    group: Group,
+  ) {
+    try {
+      //Part 1: Privilege Checking
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_CREATE',
+      );
+      if (!isPrivileged) {
+        throw new Error('You do not have permission to create group');
+      }
+
+      //Part 2: Validation
+      if (!group.GroupCode) {
+        throw new ClassError(
+          'Group',
+          'GroupErrMsg02',
+          'Group Code is required',
+        );
+      }
+
+      if (!group.Name) {
+        throw new ClassError(
+          'Group',
+          'GroupErrMsg02',
+          'Group Name is required',
+        );
+      }
+
+      if (!group.Type) {
+        throw new ClassError(
+          'Group',
+          'GroupErrMsg02',
+          'Group Type is required',
+        );
+      }
+
+      //Check if group code is unique
+      const existingGroupCode = await Group._Repo.findByPk(group.GroupCode, {
+        transaction: dbTransaction,
+      });
+
+      if (existingGroupCode) {
+        throw new ClassError(
+          'Group',
+          'GroupErrMsg03',
+          'Duplicate GroupCode found.',
+        );
+      }
+
+      //Validate parent group code if passed. Call Group._Repo.findByPk
+      if (group.ParentGroupCode) {
+        const parentGroup = await Group._Repo.findByPk(group.ParentGroupCode, {
+          transaction: dbTransaction,
+        });
+
+        if (!parentGroup) {
+          throw new ClassError(
+            'Group',
+            'GroupErrMsg04',
+            'ParentGroupCode is not found.',
+          );
+        }
+
+        //If Params.group.GroupCode = Params.group?.ParentGroupCode, throw new ClassError
+        if (group.GroupCode === group.ParentGroupCode) {
+          throw new ClassError(
+            'Group',
+            'GroupErrMsg05',
+            'GroupCode and ParentGroupCode cannot be the same.',
+          );
+        }
+      }
+
+      //Part 3: Create Group
+      //Initialise new Group instance and populate
+      const newGroup = new Group(group);
+      newGroup.ObjectId = group.GroupCode;
+      newGroup.Name = group.Name;
+      newGroup.Type = group.Type;
+      newGroup.Description = group.Description;
+      newGroup.ParentGroupCode = group.ParentGroupCode;
+      newGroup.InheritParentPrivilegeYN = group.InheritParentPrivilegeYN;
+      newGroup.InheritParentSystemAccessYN = group.InheritParentSystemAccessYN;
+      newGroup.Status = 'Active';
+      newGroup._CreatedById = loginUser.UserId;
+      newGroup._UpdatedById = loginUser.UserId;
+
+      //Call Group._Repo create method
+      const entityGroupAfter = {
+        GroupCode: newGroup.ObjectId,
+        Name: newGroup.Name,
+        Type: newGroup.Type,
+        Description: newGroup.Description,
+        ParentGroupCode: newGroup.ParentGroupCode,
+        InheritParentPrivilegeYN: newGroup.InheritParentPrivilegeYN,
+        InheritParentSystemAccessYN: newGroup.InheritParentSystemAccessYN,
+        Status: newGroup.Status,
+        CreatedById: newGroup._CreatedById,
+        UpdatedById: newGroup._UpdatedById,
+        CreatedAt: newGroup._CreatedAt,
+        UpdatedAt: newGroup._UpdatedAt,
+      };
+
+      await Group._Repo.create(entityGroupAfter, {
+        transaction: dbTransaction,
+      });
+
+      //Part 4: Record Create Group Activity and return newGroup
+
+      const entityValueBefore = {};
+
+      //Instantiate new activity
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.ADD;
+      activity.Description = 'Create Group';
+      activity.EntityType = 'Group';
+      activity.EntityId = newGroup.ObjectId;
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(entityGroupAfter);
+
+      //Call Activity.create method
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      return newGroup;
+    } catch (error) {
+      throw error;
+    }
+  }
 }

package/src/components/index.ts

@@ -11,5 +11,6 @@ export * from './group-system-access';
 export * from './user-object-privilege';
 export * from './group-privilege';
 export * from './group-object-privilege';
+export * from './system-privilege';
 
 //test ci

package/src/components/system-privilege/index.ts

@@ -0,0 +1,4 @@
+import { SystemPrivilegeRepository } from './system-privilege.repository';
+import { SystemPrivilege } from './system-privilege';
+
+export { SystemPrivilegeRepository, SystemPrivilege };

package/src/interfaces/group-search-attr.interface.ts

@@ -0,0 +1,8 @@
+import { GroupTypeEnum } from '../enum/group-type.enum';
+
+export interface IGroupSearchAttr {
+  GroupCode?: string;
+  Name?: string;
+  Type?: string;
+  Status?: GroupTypeEnum;
+}

package/src/interfaces/index.ts

@@ -9,3 +9,4 @@ export * from './user-object-privilege.interface';
 export * from './group-object-privilege.interface';
 export * from './group-privilege.interface';
 export * from './system-search-attr.interface';
+export * from './group-search-attr.interface';