@tomei/sso 0.44.1 → 0.45.0

package/migrations/20240528063108-create-api-key-table.js

@@ -3,73 +3,80 @@
 /** @type {import('sequelize-cli').Migration} */
 module.exports = {
   async up(queryInterface, Sequelize) {
-    await queryInterface.createTable(
-      'sso_APIKey',
-      {
-        APIKeyId: {
-          primaryKey: true,
-          type: Sequelize.INTEGER,
-          allowNull: false,
-          autoIncrement: true,
-        },
-        APIKey: {
-          type: Sequelize.STRING(128),
-          allowNull: false,
-          unique: true,
-        },
-        Name: {
-          type: Sequelize.STRING(255),
-          allowNull: false,
-        },
-        Description: {
-          type: Sequelize.TEXT,
-          allowNull: true,
-        },
-        Status: {
-          type: Sequelize.STRING(50),
-          defaultValue: 'Active',
-          allowNull: false,
-        },
-        ExpirationDate: {
-          allowNull: false,
-          type: Sequelize.DATE,
-        },
-        CreatedAt: {
-          allowNull: false,
-          defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
-          type: Sequelize.DATE,
-        },
-        CreatedById: {
-          type: Sequelize.INTEGER,
-          allowNull: true,
-          references: {
-            model: 'sso_User',
-            key: 'UserId',
-          },
-          onDelete: 'CASCADE',
-          onUpdate: 'CASCADE',
-        },
-        RevokedAt: {
-          allowNull: true,
-          type: Sequelize.DATE,
+    await queryInterface.createTable('sso_APIKey', {
+      APIKeyId: {
+        primaryKey: true,
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        autoIncrement: true,
+      },
+      APIKey: {
+        type: Sequelize.STRING(128),
+        allowNull: false,
+        unique: true,
+      },
+      Name: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      SystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+        references: {
+          model: 'sso_System',
+          key: 'SystemCode',
         },
-        RevokedById: {
-          type: Sequelize.INTEGER,
-          allowNull: true,
-          references: {
-            model: 'sso_User',
-            key: 'UserId',
-          },
-          onDelete: 'CASCADE',
-          onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+      Description: {
+        type: Sequelize.TEXT,
+        allowNull: true,
+      },
+      Status: {
+        type: Sequelize.STRING(50),
+        defaultValue: 'Active',
+        allowNull: false,
+      },
+      ExpirationDate: {
+        allowNull: false,
+        type: Sequelize.DATE,
+      },
+      CreatedAt: {
+        allowNull: false,
+        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
+        type: Sequelize.DATE,
+      },
+      CreatedById: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: {
+          model: 'sso_User',
+          key: 'UserId',
         },
-        RevokedReason: {
-          type: Sequelize.TEXT,
-          defaultValue: 'Active',
-          allowNull: true,
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+      RevokedAt: {
+        allowNull: true,
+        type: Sequelize.DATE,
+      },
+      RevokedById: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: {
+          model: 'sso_User',
+          key: 'UserId',
         },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+      RevokedReason: {
+        type: Sequelize.TEXT,
+        defaultValue: 'Active',
+        allowNull: true,
       },
-    );
+    });
   },
 
   async down(queryInterface, Sequelize) {

package/package.json

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

package/src/components/api-key/api-key.ts

@@ -7,6 +7,7 @@ import { ApplicationConfig } from '@tomei/config';
 import { randomBytes } from 'crypto';
 import { ActionEnum, Activity } from '@tomei/activity-history';
 import { Op } from 'sequelize';
+import { System } from '../system/system';
 
 export class APIKey extends ObjectBase {
   ObjectId: string;
@@ -16,6 +17,7 @@ export class APIKey extends ObjectBase {
 
   ApiKey: string;
   Name: string;
+  SystemCode: string;
   Description: string;
   Status: APIKeyStatusEnum;
   ExpirationDate: Date;
@@ -57,6 +59,7 @@ export class APIKey extends ObjectBase {
       this.APIKeyId = apiKeyAttr.APIKeyId;
       this.ApiKey = apiKeyAttr.ApiKey;
       this.Name = apiKeyAttr.Name;
+      this.SystemCode = apiKeyAttr.SystemCode;
       this.Description = apiKeyAttr.Description;
       this.Status = apiKeyAttr.Status;
       this.ExpirationDate = apiKeyAttr.ExpirationDate;
@@ -114,6 +117,12 @@ export class APIKey extends ObjectBase {
         );
       }
 
+      // Part 3: System Existence Check
+      // Call System.init(dbTransaction, this.SystemCode) to verify the System exists.
+      // If the group does not exist, throw a NotFoundError.
+
+      await System.init(dbTransaction, this.SystemCode);
+
       // Part 3: Generate API Key
       // Populate the following attributes:
       // CreatedById: Set to loginUser.UserId.
@@ -133,6 +142,7 @@ export class APIKey extends ObjectBase {
       const EntityValueAfter: any = {
         ApiKey: this.ApiKey,
         Name: this.Name,
+        SystemCode: this.SystemCode,
         Status: this.Status,
         Description: this.Description,
         ExpirationDate: this.ExpirationDate,
@@ -188,6 +198,7 @@ export class APIKey extends ObjectBase {
         Name: this.Name,
         Status: this.Status,
         Description: this.Description,
+        SystemCode: this.SystemCode,
         ExpirationDate: this.ExpirationDate,
         CreatedAt: this.CreatedAt,
         CreatedById: this.CreatedById,
@@ -205,6 +216,7 @@ export class APIKey extends ObjectBase {
     loginUser: LoginUser,
     dbTransaction: any,
     whereOptions: {
+      SystemCode?: string;
       Status?: APIKeyStatusEnum;
       ExpirationDate?: {
         FromDate: Date;
@@ -246,6 +258,9 @@ export class APIKey extends ObjectBase {
       // CreatedById: Filter by the user who created the API key.
       const where = {};
       if (whereOptions) {
+        if (whereOptions.SystemCode) {
+          where['SystemCode'] = whereOptions.SystemCode;
+        }
         if (whereOptions.Status) {
           where['Status'] = whereOptions.Status;
         }
@@ -311,6 +326,7 @@ export class APIKey extends ObjectBase {
             ApiKeyId: row.APIKeyId,
             ApiKey: row.ApiKey,
             Name: row.Name,
+            SystemCode: row.SystemCode,
             Description: row.Description,
             Status: row.Status,
             ExpirationDate: row.ExpirationDate,

package/src/components/group/group.ts

@@ -5,7 +5,7 @@ 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 { Op, Transaction } from 'sequelize';
 import { ActionEnum, Activity } from '@tomei/activity-history';
 import { GroupSystemAccessRepository } from '../group-system-access/group-system-access.repository';
 import SystemModel from '../../models/system.entity';
@@ -18,6 +18,10 @@ import GroupPrivilegeModel from '../../models/group-privilege.entity';
 import { GroupObjectPrivilegeRepository } from '../group-object-privilege/group-object-privilege.repository';
 import { GroupObjectPrivilege } from '../group-object-privilege/group-object-privilege';
 import { GroupPrivilege } from '../group-privilege/group-privilege';
+import { User } from '../login-user/user';
+import GroupReportingUserModel from '../../models/group-reporting-user.entity';
+import GroupModel from '../../models/group.entity';
+import UserModel from '../../models/user.entity';
 
 export class Group extends TreeNodeBase<Group> {
   ObjectId: string;
@@ -1900,4 +1904,62 @@ export class Group extends TreeNodeBase<Group> {
       return tree;
     }
   }
+
+  public static async getGroupsWithReportingUser(
+    loginUser: User, //The user performing the action.
+    dbTransaction: Transaction, //Active database transaction.
+    whereOptions: any, //The filter criteria for selecting groups.
+  ) {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: Retrieve from app config.
+      // PrivilegeCode: 'GROUP_VIEW'.
+      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 Group Query
+      // Call Group._Repo.findAll() to fetch groups from the sso_Group table by passing:
+      // where: whereOptions
+      // include:
+      // Model: sso_GroupReportingUsers
+      // where: { Status: 'Active' }
+      // include:
+      // Model: sso_User
+      // attributes: ['UserId', 'FullName']
+      // attributes: ['GroupCode', 'UserId', 'Rank']
+      const options = {
+        where: whereOptions,
+        include: [
+          {
+            model: GroupReportingUserModel,
+            where: { Status: 'Active' },
+            include: [
+              {
+                model: UserModel,
+                attributes: ['UserId', 'FullName'],
+              },
+            ],
+          },
+        ],
+        transaction: dbTransaction,
+      };
+      const groups = await Group._Repo.findAll(options);
+      // Part 3: Retrieve and Return
+      // Return the list of groups with nested reporting users.
+      return groups;
+    } catch (error) {
+      throw error;
+    }
+  }
 }

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

@@ -2,6 +2,7 @@ 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 UserModel from '../../models/user.entity';
 import { Group } from '../group/group';
 import { ApplicationConfig } from '@tomei/config';
 import { ActionEnum, Activity } from '@tomei/activity-history';
@@ -256,6 +257,12 @@ export class GroupReportingUser extends ObjectBase {
         where: {
           GroupCode: groupCode,
         },
+        include: [
+          {
+            model: UserModel,
+            as: 'User',
+          },
+        ],
         order: [
           ['Rank', 'ASC'], // or 'DESC' for descending order
         ],
@@ -264,15 +271,8 @@ export class GroupReportingUser extends ObjectBase {
 
       // 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;
+
+      return result;
     } catch (error) {
       // Part 5: Handle Errors
       // Catch and handle any errors during the execution. If an error occurs, ensure the transaction is rolled back.

package/src/interfaces/api-key-attr.interface.ts

@@ -4,6 +4,7 @@ export interface IAPIKeyAttr {
   APIKeyId: number;
   ApiKey: string;
   Name: string;
+  SystemCode: string;
   Description: string;
   Status: APIKeyStatusEnum;
   ExpirationDate: Date;

package/src/models/api-key-entity.ts

@@ -10,6 +10,7 @@ import {
 } from 'sequelize-typescript';
 import User from './user.entity';
 import { APIKeyStatusEnum } from '../enum/api-key.enum';
+import SystemModel from './system.entity';
 
 @Table({
   tableName: 'sso_ApiKey',
@@ -37,6 +38,13 @@ export default class APIKeyModel extends Model {
   })
   Name: string;
 
+  @ForeignKey(() => SystemModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  SystemCode: string;
+
   @Column({
     type: DataType.TEXT,
     allowNull: true,
@@ -87,4 +95,7 @@ export default class APIKeyModel extends Model {
 
   @BelongsTo(() => User, 'RevokedById')
   UpdatedByUser: User;
+
+  @BelongsTo(() => SystemModel, 'SystemCode')
+  System: SystemModel;
 }