@tomei/sso 0.15.4 → 0.15.6

package/migrations/20240314080603-create-user-table.js

@@ -0,0 +1,108 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('sso_User', {
+      UserId: {
+        primaryKey: true,
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        autoIncrement: true,
+      },
+      Email: {
+        type: Sequelize.STRING,
+        allowNull: false,
+        unique: true,
+      },
+      Password: {
+        type: Sequelize.STRING,
+        allowNull: false,
+      },
+      Status: {
+        type: Sequelize.STRING,
+        allowNull: false,
+      },
+      DefaultPasswordChangedYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: true,
+      },
+      FirstLoginAt: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      LastLoginAt: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      MFAEnabled: {
+        type: Sequelize.TINYINT,
+        allowNull: true,
+      },
+      MFAConfig: {
+        type: Sequelize.TEXT,
+        allowNull: true,
+      },
+      RecoveryEmail: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      FailedLoginAttemptCount: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+      },
+      LastFailedLoginAt: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      LastPasswordChangedAt: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      NeedToChangePasswordYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: true,
+      },
+      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',
+      },
+      UpdatedAt: {
+        allowNull: false,
+        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3) ON UPDATE CURRENT_TIMESTAMP(3)'),
+        type: Sequelize.DATE,
+      },
+      UpdatedById: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: {
+          model: 'sso_User',
+          key: 'UserId',
+        },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    /**
+     * Add reverting commands here.
+     *
+     * Example:
+     * await queryInterface.dropTable('users');
+     */
+  }
+};

package/migrations/{04-create-user-user-group-table.js → 20240314080604-create-user-user-group-table.js}

@@ -8,7 +8,7 @@ module.exports = {
             type: Sequelize.INTEGER,
             allowNull: false,
             references: {
-                model: 'sso_users',
+                model: 'sso_User',
                 key: 'id',
             },
             onDelete: 'CASCADE',

package/migrations/{05-create-login-history-table.js → 20240314080605-create-login-history-table.js}

@@ -14,7 +14,7 @@ module.exports = {
             type: Sequelize.INTEGER,
             allowNull: false,
             references: {
-                model: 'sso_users',
+                model: 'sso_User',
                 key: 'id',
             },
             onDelete: 'CASCADE',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/sso",
-  "version": "0.15.4",
+  "version": "0.15.6",
   "description": "Tomei SSO Package",
   "main": "dist/index.js",
   "scripts": {
@@ -46,6 +46,7 @@
     "prettier": "^2.7.1",
     "prisma": "^4.14.0",
     "redis-mock": "^0.56.3",
+    "sequelize-cli": "^6.6.2",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tsc-watch": "^5.0.3",

package/src/components/login-user/interfaces/user-info.interface.ts

@@ -1,9 +1,29 @@
+import { YN } from '../../../enum';
+
 export interface IUserInfo {
   FullName: string;
   IDNo: string;
   Email: string;
   ContactNo: string;
-  ObjectId: string;
+  UserId: number;
   Password: string;
   staffs?: any;
 }
+
+export interface IUserAttr extends IUserInfo {
+  Status: string;
+  DefaultPasswordChangedYN: YN;
+  FirstLoginAt: Date;
+  LastLoginAt: Date;
+  MFAEnabled: number;
+  MFAConfig: string;
+  RecoveryEmail: string;
+  FailedLoginAttemptCount: number;
+  LastFailedLoginAt: Date;
+  LastPasswordChangedAt: Date;
+  NeedToChangePasswordYN: YN;
+  CreatedById: number;
+  CreatedAt: Date;
+  UpdatedById: number;
+  UpdatedAt: Date;
+}

package/src/components/login-user/login-user.ts

@@ -1,6 +1,6 @@
-import { IAddress, LoginUserBase } from '@tomei/general';
+import { LoginUserBase } from '@tomei/general';
 import { ISessionService } from '../../session/interfaces/session-service.interface';
-import { IUserInfo } from './interfaces/user-info.interface';
+import { IUserAttr } from './interfaces/user-info.interface';
 import { UserRepository } from './user.repository';
 import { SystemRepository } from '../system/system.repository';
 import { SystemAccessRepository } from '../system-access/system-access.repository';
@@ -16,18 +16,29 @@ import LoginHistory from '../../models/login-history.entity';
 import GroupSystemPrivilege from '../../models/group-system-privilege.entity';
 import GroupRolePrivilege from '../../models/group-role-privilege.entity';
 import UserGroup from '../../models/user-group.entity';
+import { YN } from '../../enum/yn.enum';
 
 export class LoginUser extends LoginUserBase {
-  FullName: string;
-  IDNo: string;
-  IDType: string;
-  Email: string;
-  ContactNo: string;
-  Password: string;
-  DefaultAddress: IAddress;
   ObjectId: string;
+  Email: string;
+  private _Password: string;
+  private _Status: string;
+  private _DefaultPasswordChangedYN: YN;
+  private _FirstLoginAt: Date;
+  private _LastLoginAt: Date;
+  private _MFAEnabled: number;
+  private _MFAConfig: string;
+  private _RecoveryEmail: string;
+  private _FailedLoginAttemptCount: number;
+  private _LastFailedLoginAt: Date;
+  private _LastPasswordChangedAt: Date;
+  private _NeedToChangePasswordYN: YN;
+  private _CreatedById: number;
+  private _CreatedAt: Date;
+  private _UpdatedById: number;
+  private _UpdatedAt: Date;
   ObjectName = 'User';
-  TableName = 'sso_users';
+  TableName = 'sso_Users';
   ObjectType = 'User';
   staffs: any;
 
@@ -42,6 +53,142 @@ export class LoginUser extends LoginUserBase {
   private static _UserGroupRepository = new UserGroupRepository();
   private _dbTransaction: any;
 
+  get UserId(): number {
+    return parseInt(this.ObjectId);
+  }
+
+  private set UserId(value: number) {
+    this.ObjectId = value.toString();
+  }
+
+  get Password(): string {
+    return this._Password;
+  }
+
+  private set Password(value: string) {
+    this._Password = value;
+  }
+
+  get Status(): string {
+    return this._Status;
+  }
+
+  private set Status(value: string) {
+    this._Status = value;
+  }
+
+  get DefaultPasswordChangedYN(): YN {
+    return this._DefaultPasswordChangedYN;
+  }
+
+  private set DefaultPasswordChangedYN(value: YN) {
+    this._DefaultPasswordChangedYN = value;
+  }
+
+  get FirstLoginAt(): Date {
+    return this._FirstLoginAt;
+  }
+
+  private set FirstLoginAt(value: Date) {
+    this._FirstLoginAt = value;
+  }
+
+  get LastLoginAt(): Date {
+    return this._LastLoginAt;
+  }
+
+  private set LastLoginAt(value: Date) {
+    this._LastLoginAt = value;
+  }
+
+  get MFAEnabled(): number {
+    return this._MFAEnabled;
+  }
+
+  private set MFAEnabled(value: number) {
+    this._MFAEnabled = value;
+  }
+
+  get MFAConfig(): string {
+    return this._MFAConfig;
+  }
+
+  private set MFAConfig(value: string) {
+    this._MFAConfig = value;
+  }
+
+  get RecoveryEmail(): string {
+    return this._RecoveryEmail;
+  }
+
+  private set RecoveryEmail(value: string) {
+    this._RecoveryEmail = value;
+  }
+
+  get FailedLoginAttemptCount(): number {
+    return this._FailedLoginAttemptCount;
+  }
+
+  private set FailedLoginAttemptCount(value: number) {
+    this._FailedLoginAttemptCount = value;
+  }
+
+  get LastFailedLoginAt(): Date {
+    return this._LastFailedLoginAt;
+  }
+
+  private set LastFailedLoginAt(value: Date) {
+    this._LastFailedLoginAt = value;
+  }
+
+  get LastPasswordChangedAt(): Date {
+    return this._LastPasswordChangedAt;
+  }
+
+  private set LastPasswordChangedAt(value: Date) {
+    this._LastPasswordChangedAt = value;
+  }
+
+  get NeedToChangePasswordYN(): YN {
+    return this._NeedToChangePasswordYN;
+  }
+
+  private set NeedToChangePasswordYN(value: YN) {
+    this._NeedToChangePasswordYN = value;
+  }
+
+  get CreatedById(): number {
+    return this._CreatedById;
+  }
+
+  private set CreatedById(value: number) {
+    this._CreatedById = value;
+  }
+
+  get CreatedAt(): Date {
+    return this._CreatedAt;
+  }
+
+  private set CreatedAt(value: Date) {
+    this._CreatedAt = value;
+  }
+
+  get UpdatedById(): number {
+    return this._UpdatedById;
+  }
+
+  private set UpdatedById(value: number) {
+    this._UpdatedById = value;
+  }
+
+  get UpdatedAt(): Date {
+    return this._UpdatedAt;
+  }
+
+  private set UpdatedAt(value: Date) {
+    this._UpdatedAt = value;
+  }
+
   async getDetails(): Promise<{
     FullName: string;
     IDNo: string;
@@ -61,7 +208,7 @@ export class LoginUser extends LoginUserBase {
   private constructor(
     sessionService: ISessionService,
     dbTransaction?: any,
-    userInfo?: IUserInfo,
+    userInfo?: IUserAttr,
   ) {
     super();
     this._SessionService = sessionService;
@@ -71,7 +218,7 @@ export class LoginUser extends LoginUserBase {
     }
     // set all the class properties
     if (userInfo) {
-      this.ObjectId = userInfo.ObjectId;
+      this.UserId = userInfo.UserId;
       this.FullName = userInfo.FullName;
       this.IDNo = userInfo.IDNo;
       this.Email = userInfo.Email;
@@ -83,7 +230,7 @@ export class LoginUser extends LoginUserBase {
 
   static async init(
     sessionService: ISessionService,
-    userId?: string,
+    userId?: number,
     dbTransaction = null,
   ): Promise<LoginUser> {
     if (userId) {
@@ -92,7 +239,7 @@ export class LoginUser extends LoginUserBase {
       }
       const user = await LoginUser._Repository.findOne({
         where: {
-          id: Number(userId),
+          UserId: userId,
         },
         include: [
           {
@@ -106,17 +253,32 @@ export class LoginUser extends LoginUserBase {
       }
 
       if (user) {
-        const userInfo: IUserInfo = {
-          ObjectId: user.id.toString(),
+        const userAttr: IUserAttr = {
+          UserId: user.UserId,
           FullName: user.Staff.FullName,
           IDNo: user.Staff.IdNo,
           ContactNo: user.Staff.Mobile,
           Email: user.Email,
           Password: user.Password,
+          Status: user.Status,
+          DefaultPasswordChangedYN: user.DefaultPasswordChangedYN,
+          FirstLoginAt: user.FirstLoginAt,
+          LastLoginAt: user.LastLoginAt,
+          MFAEnabled: user.MFAEnabled,
+          MFAConfig: user.MFAConfig,
+          RecoveryEmail: user.RecoveryEmail,
+          FailedLoginAttemptCount: user.FailedLoginAttemptCount,
+          LastFailedLoginAt: user.LastFailedLoginAt,
+          LastPasswordChangedAt: user.LastPasswordChangedAt,
+          NeedToChangePasswordYN: user.NeedToChangePasswordYN,
+          CreatedById: user.CreatedById,
+          CreatedAt: user.CreatedAt,
+          UpdatedById: user.UpdatedById,
+          UpdatedAt: user.UpdatedAt,
           staffs: user.Staff,
         };
 
-        return new LoginUser(sessionService, dbTransaction, userInfo);
+        return new LoginUser(sessionService, dbTransaction, userAttr);
       } else {
         throw new Error('User not found');
       }
@@ -144,23 +306,53 @@ export class LoginUser extends LoginUserBase {
           ],
         });
 
-        const userInfo: IUserInfo = {
-          ObjectId: user.id.toString(),
+        const userAttr: IUserAttr = {
+          UserId: user.UserId,
           FullName: user.Staff.FullName,
           IDNo: user.Staff.IdNo,
           ContactNo: user.Staff.Mobile,
-          Email: user.Staff.Email,
+          Email: user.Email,
           Password: user.Password,
+          Status: user.Status,
+          DefaultPasswordChangedYN: user.DefaultPasswordChangedYN,
+          FirstLoginAt: user.FirstLoginAt,
+          LastLoginAt: user.LastLoginAt,
+          MFAEnabled: user.MFAEnabled,
+          MFAConfig: user.MFAConfig,
+          RecoveryEmail: user.RecoveryEmail,
+          FailedLoginAttemptCount: user.FailedLoginAttemptCount,
+          LastFailedLoginAt: user.LastFailedLoginAt,
+          LastPasswordChangedAt: user.LastPasswordChangedAt,
+          NeedToChangePasswordYN: user.NeedToChangePasswordYN,
+          CreatedById: user.CreatedById,
+          CreatedAt: user.CreatedAt,
+          UpdatedById: user.UpdatedById,
+          UpdatedAt: user.UpdatedAt,
           staffs: user.Staff,
         };
 
-        this.ObjectId = userInfo.ObjectId;
-        this.FullName = userInfo.FullName;
-        this.IDNo = userInfo.IDNo;
-        this.Email = userInfo.Email;
-        this.ContactNo = userInfo.ContactNo;
-        this.Password = userInfo.Password;
-        this.staffs = userInfo.staffs;
+        this.UserId = userAttr.UserId;
+        this.FullName = userAttr.FullName;
+        this.IDNo = userAttr.IDNo;
+        this.Email = userAttr.Email;
+        this.ContactNo = userAttr.ContactNo;
+        this.Password = userAttr.Password;
+        this.Status = userAttr.Status;
+        this.DefaultPasswordChangedYN = userAttr.DefaultPasswordChangedYN;
+        this.FirstLoginAt = userAttr.FirstLoginAt;
+        this.LastLoginAt = userAttr.LastLoginAt;
+        this.MFAEnabled = userAttr.MFAEnabled;
+        this.MFAConfig = userAttr.MFAConfig;
+        this.RecoveryEmail = userAttr.RecoveryEmail;
+        this.FailedLoginAttemptCount = userAttr.FailedLoginAttemptCount;
+        this.LastFailedLoginAt = userAttr.LastFailedLoginAt;
+        this.LastPasswordChangedAt = userAttr.LastPasswordChangedAt;
+        this.NeedToChangePasswordYN = userAttr.NeedToChangePasswordYN;
+        this.CreatedById = userAttr.CreatedById;
+        this.CreatedAt = userAttr.CreatedAt;
+        this.UpdatedById = userAttr.UpdatedById;
+        this.UpdatedAt = userAttr.UpdatedAt;
+        this.staffs = userAttr.staffs;
       }
 
       if (this.ObjectId && this.Email !== email) {
@@ -189,9 +381,9 @@ export class LoginUser extends LoginUserBase {
       }
 
       //validate system access
-      await this.checkSystemAccess(this.ObjectId, system.id);
+      await this.checkSystemAccess(this.UserId, system.id);
       // alert user if new login
-      // await this.alertNewLogin(this.ObjectId, system.id.toString(), ipAddress);
+      await this.alertNewLogin(this.ObjectId, system.id.toString(), ipAddress);
 
       // fetch user session if exists
       const userSession = await this._SessionService.retrieveUserSession(
@@ -225,20 +417,20 @@ export class LoginUser extends LoginUserBase {
 
       // record new login history
       await LoginUser._LoginHistoryRepository.create({
-        UserId: this.ObjectId,
+        UserId: this.UserId,
         SystemId: system.id,
         OriginIp: ipAddress,
         CreatedAt: new Date(),
       });
 
-      return `${this.ObjectId}:${sessionId}`;
+      return `${this.UserId}:${sessionId}`;
     } catch (error) {
       throw error;
     }
   }
 
   private async checkSystemAccess(
-    userId: string,
+    userId: number,
     systemId: number,
   ): Promise<void> {
     try {
@@ -423,7 +615,7 @@ export class LoginUser extends LoginUserBase {
     try {
       return await LoginUser._UserUserGroupRepository.findAll({
         where: {
-          UserId: this.ObjectId,
+          UserId: this.UserId,
           SystemId: systemCode,
         },
         include: {
@@ -453,7 +645,7 @@ export class LoginUser extends LoginUserBase {
     try {
       const userRole = await LoginUser._Repository.findOne({
         where: {
-          id: this.ObjectId,
+          UserId: this.ObjectId,
         },
         include: {
           model: SystemPrivilege,

package/src/enum/index.ts

@@ -0,0 +1 @@
+export * from './yn.enum';

package/src/enum/yn.enum.ts

@@ -0,0 +1,4 @@
+export enum YN {
+  Yes = 'Y',
+  No = 'N',
+}

package/src/models/user.entity.ts

@@ -23,61 +23,108 @@ import SystemRole from './system-role.entity';
 import UserSystemRole from './user-system-role.entity';
 import SystemPrivilege from './system-privilege.entity';
 import UserSystemPrivileges from './user-system-privileges.entity';
+import { YN } from '../enum/yn.enum';
 
 @Table({
-  tableName: 'sso_users',
+  tableName: 'sso_User',
   timestamps: true,
-  createdAt: 'created_at',
-  updatedAt: 'updated_at',
+  createdAt: 'CreatedAt',
+  updatedAt: 'UpdatedAt',
 })
 export default class User extends Model {
   @Column({
     primaryKey: true,
+    allowNull: false,
     type: DataType.INTEGER,
   })
-  id: number;
+  UserId: number;
 
   @Column({
+    allowNull: false,
     type: DataType.STRING,
-    field: 'email',
   })
   Email: string;
 
   @Column({
+    allowNull: false,
     type: DataType.STRING,
-    field: 'password',
   })
   Password: string;
 
   @Column({
+    allowNull: false,
     type: DataType.STRING,
-    field: 'status',
   })
   Status: string;
 
   @Column({
-    type: DataType.BOOLEAN,
-    field: 'default_password_changed',
+    allowNull: false,
+    type: DataType.CHAR(1),
   })
-  DefaultPasswordChanged: boolean;
+  DefaultPasswordChangedYN: YN;
 
   @Column({
     type: DataType.DATE,
-    field: 'first_login_at',
   })
-  FirstLoginAt: boolean;
+  FirstLoginAt: Date;
 
-  @ForeignKey(() => UserGroup)
   @Column({
-    allowNull: true,
-    type: DataType.STRING(10),
-    field: 'GroupCode',
+    type: DataType.DATE,
+  })
+  LastLoginAt: Date;
+
+  @Column({
+    type: DataType.TINYINT,
+  })
+  MFAEnabled: number;
+
+  @Column({
+    type: DataType.TEXT,
+  })
+  MFAConfig: string;
+
+  @Column({
+    type: DataType.STRING,
   })
-  GroupCode: boolean;
+  RecoveryEmail: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.INTEGER,
+  })
+  FailedLoginAttemptCount: number;
+
+  @Column({
+    type: DataType.DATE,
+  })
+  LastFailedLoginAt: Date;
+
+  @Column({
+    type: DataType.DATE,
+  })
+  LastPasswordChangedAt: Date;
+
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  NeedToChangePasswordYN: YN;
+
+  @ForeignKey(() => User)
+  @Column({
+    type: DataType.INTEGER,
+  })
+  CreatedById: number;
 
   @CreatedAt
   CreatedAt: Date;
 
+  @ForeignKey(() => User)
+  @Column({
+    type: DataType.INTEGER,
+  })
+  UpdatedById: number;
+
   @UpdatedAt
   UpdatedAt: Date;
 
@@ -105,6 +152,9 @@ export default class User extends Model {
   @BelongsToMany(() => SystemPrivilege, () => UserSystemPrivileges)
   SystemPrivileges: SystemPrivilege[];
 
-  @BelongsTo(() => UserGroup)
-  UserGroup: UserGroup;
+  @BelongsTo(() => User, 'CreatedById')
+  CreatedBy: User;
+
+  @BelongsTo(() => User, 'UpdatedById')
+  UpdatedBy: User;
 }