@tomei/sso 0.61.1 → 0.63.0

package/package.json

@@ -1,90 +1,90 @@
-{
-  "name": "@tomei/sso",
-  "version": "0.61.1",
-  "description": "Tomei SSO Package",
-  "main": "dist/index.js",
-  "scripts": {
-    "start:dev": "tsc -w",
-    "build": "tsc",
-    "prepare": "husky install",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "npx eslint . --fix",
-    "test": "jest --forceExit --detectOpenHandles --coverage"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@gitlab.com/tomei-package/sso.git"
-  },
-  "keywords": [
-    "tomei",
-    "sso"
-  ],
-  "author": "Tomei",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://gitlab.com/tomei-package/sso/issues"
-  },
-  "homepage": "https://gitlab.com/tomei-package/sso#readme",
-  "devDependencies": {
-    "@commitlint/cli": "^19.6.0",
-    "@commitlint/config-conventional": "^19.6.0",
-    "@eslint/js": "^9.15.0",
-    "@tsconfig/node18": "^18.2.4",
-    "@types/bcrypt": "^5.0.2",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.9.3",
-    "@types/redis": "^4.0.11",
-    "@types/validator": "^13.12.2",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
-    "cls-hooked": "^4.2.2",
-    "dotenv": "^16.4.5",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "globals": "^15.12.0",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-mock-extended": "^3.0.7",
-    "jest-sonar-reporter": "^2.0.0",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.3.3",
-    "redis-mock": "^0.56.3",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "tsc-watch": "^6.2.1",
-    "tsconfig-paths": "^4.2.0",
-    "tslint": "^6.1.3",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.15.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "@tomei/activity-history": "^0.4.1",
-    "@tomei/config": "^0.3.21",
-    "@tomei/general": "^0.21.3",
-    "@tomei/mailer": "^0.5.21",
-    "argon2": "^0.41.1",
-    "redis": "^4.7.0",
-    "reflect-metadata": "^0.2.2",
-    "sequelize": "^6.37.5",
-    "sequelize-cli": "^6.6.2",
-    "sequelize-typescript": "^2.1.6",
-    "speakeasy": "^2.0.0",
-    "uuid": "^11.0.3"
-  },
-  "lint-staged": {
-    "*/**/*.{js,ts,tsx}": [
-      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
-    ]
-  },
-  "jestSonar": {
-    "reportPath": "coverage",
-    "reportFile": "test-report.xml",
-    "indent": 2
-  }
-}
+{
+  "name": "@tomei/sso",
+  "version": "0.63.0",
+  "description": "Tomei SSO Package",
+  "main": "dist/index.js",
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "prepare": "husky install",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "npx eslint . --fix",
+    "test": "jest --forceExit --detectOpenHandles --coverage"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/tomei-package/sso.git"
+  },
+  "keywords": [
+    "tomei",
+    "sso"
+  ],
+  "author": "Tomei",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitlab.com/tomei-package/sso/issues"
+  },
+  "homepage": "https://gitlab.com/tomei-package/sso#readme",
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/js": "^9.15.0",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/bcrypt": "^5.0.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.9.3",
+    "@types/redis": "^4.0.11",
+    "@types/validator": "^13.12.2",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "cls-hooked": "^4.2.2",
+    "dotenv": "^16.4.5",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.12.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.7",
+    "jest-sonar-reporter": "^2.0.0",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
+    "redis-mock": "^0.56.3",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^6.2.1",
+    "tsconfig-paths": "^4.2.0",
+    "tslint": "^6.1.3",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.15.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tomei/activity-history": "^0.4.1",
+    "@tomei/config": "^0.3.21",
+    "@tomei/general": "^0.21.3",
+    "@tomei/mailer": "^0.5.21",
+    "argon2": "^0.41.1",
+    "redis": "^4.7.0",
+    "reflect-metadata": "^0.2.2",
+    "sequelize": "^6.37.5",
+    "sequelize-cli": "^6.6.2",
+    "sequelize-typescript": "^2.1.6",
+    "speakeasy": "^2.0.0",
+    "uuid": "^11.0.3"
+  },
+  "lint-staged": {
+    "*/**/*.{js,ts,tsx}": [
+      "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+      "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
+    ]
+  },
+  "jestSonar": {
+    "reportPath": "coverage",
+    "reportFile": "test-report.xml",
+    "indent": 2
+  }
+}

package/sampledotenv

@@ -1,8 +1,8 @@
-DATABASE_URL=
-SHADOW_DATABASE_URL=
-REDIS_URL=
-REDIS_PASSWORD=
-SMTP_HOST=
-SMTP_PORT=
-EMAIL_SENDER=
+DATABASE_URL=
+SHADOW_DATABASE_URL=
+REDIS_URL=
+REDIS_PASSWORD=
+SMTP_HOST=
+SMTP_PORT=
+EMAIL_SENDER=
 EMAIL_PASSWORD=

package/sonar-project.properties

@@ -1,23 +1,23 @@
-sonar.projectKey=all-tomei-projects_sso
-sonar.organization=all-tomei-projects
-sonar.exclusions=**/*.js,test-data,dist,coverage, node_modules, __tests__, **/*.spec.ts, __mocks__
-sonar.scm.provider=git
-
-sonar.sources=src
-sonar.test=__tests__
-sonar.test.inclusions=src/**/*.spec.ts
-
-sonar.javascript.lcov.reportPaths=./coverage/lcov.info
-sonar.testExecutionReportPaths=coverage/test-report.xml
-sonar.sourceEnconding=UTF-8
-
-# This is the name and version displayed in the SonarCloud UI.
-#sonar.projectName=sso
-#sonar.projectVersion=1.0
-
-
-# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
-#sonar.sources=.
-
-# Encoding of the source code. Default is default system encoding
+sonar.projectKey=all-tomei-projects_sso
+sonar.organization=all-tomei-projects
+sonar.exclusions=**/*.js,test-data,dist,coverage, node_modules, __tests__, **/*.spec.ts, __mocks__
+sonar.scm.provider=git
+
+sonar.sources=src
+sonar.test=__tests__
+sonar.test.inclusions=src/**/*.spec.ts
+
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info
+sonar.testExecutionReportPaths=coverage/test-report.xml
+sonar.sourceEnconding=UTF-8
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=sso
+#sonar.projectVersion=1.0
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
 #sonar.sourceEncoding=UTF-8

package/src/components/login-history/index.ts

@@ -1 +1,2 @@
-export * from './login-history.repository';
+export * from './login-history.repository';
+export * from './login-history';

package/src/components/login-history/login-history.repository.ts

@@ -1,11 +1,11 @@
-import LoginHistory from '../../models/login-history.entity';
-import { RepositoryBase, IRepositoryBase } from '@tomei/general';
-
-export class LoginHistoryRepository
-  extends RepositoryBase<LoginHistory>
-  implements IRepositoryBase<LoginHistory>
-{
-  constructor() {
-    super(LoginHistory);
-  }
-}
+import LoginHistoryModel from '../../models/login-history.entity';
+import { RepositoryBase, IRepositoryBase } from '@tomei/general';
+
+export class LoginHistoryRepository
+  extends RepositoryBase<LoginHistoryModel>
+  implements IRepositoryBase<LoginHistoryModel>
+{
+  constructor() {
+    super(LoginHistoryModel);
+  }
+}

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

@@ -0,0 +1,124 @@
+import { ClassError, ObjectBase } from '@tomei/general';
+import { LoginHistoryRepository } from './login-history.repository';
+import { ILoginHistoryAttr } from '../../interfaces/login-history.interface';
+import { LoginUser } from '../login-user/login-user';
+import { ApplicationConfig } from '@tomei/config';
+import { ILoginHistorySearchAttr } from '../../interfaces/login-history-search-attr.interface';
+import { Op } from 'sequelize';
+import User from '../../models/user.entity';
+
+export class LoginHistory extends ObjectBase {
+  ObjectId: string;
+  ObjectName: string;
+  TableName = 'sso_LoginHistory';
+  ObjectType = 'Login History';
+
+  HistoryId: number;
+  UserId: number;
+  UserName: string;
+  OriginIP: string;
+  SystemCode: string;
+  LoginStatus: string;
+  private _CreatedAt: Date;
+  private static _Repo = new LoginHistoryRepository();
+
+  get CreatedAt(): Date {
+    return this._CreatedAt;
+  }
+
+  private constructor(loginHistoryAttr?: ILoginHistoryAttr) {
+    super();
+    if (loginHistoryAttr) {
+      this.HistoryId = loginHistoryAttr?.HistoryId;
+      this.UserId = loginHistoryAttr?.UserId;
+      this.UserName = loginHistoryAttr?.User?.UserName;
+      this.OriginIP = loginHistoryAttr?.OriginIp;
+      this.SystemCode = loginHistoryAttr?.SystemCode;
+      this.LoginStatus = loginHistoryAttr?.LoginStatus;
+      this._CreatedAt = loginHistoryAttr?.CreatedAt;
+    }
+  }
+
+  public static async findAll(
+    dbTransaction: any,
+    loginUser: LoginUser,
+    page?: number,
+    rows?: number,
+    search?: ILoginHistorySearchAttr,
+  ): Promise<{ count: number; loginHistory: LoginHistory[] }> {
+    try {
+      // Part 1: Make sure loginUser got "LOGIN_HISTORY_REPORT" privilege.
+      const sc = ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        sc,
+        'LOGIN_HISTORY_REPORT',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'System',
+          'SystemErrMsg06',
+          'You do not have permission to list login histories.',
+        );
+      }
+
+      //Part 2: Transform page and row into sequelize limit and offset & If search object exists, transform search object to Sequelize where object.
+      const queryObj: any = {};
+      const whereObj: any = {};
+
+      if (search) {
+        Object.entries(search).forEach(([key, value]) => {
+          if (value !== undefined && value !== null) {
+            if (key === 'DateFrom' || key === 'DateTo') {
+              // We'll handle DateFrom and DateTo after this loop
+              return;
+            }
+
+            if (key === 'UserId') {
+              queryObj[key] = value; // Directly assign UserId
+              return;
+            }
+
+            queryObj[key] = {
+              [Op.substring]: value,
+            };
+          }
+        });
+      }
+
+      if (page && rows) {
+        whereObj.offset = (page - 1) * rows;
+        whereObj.limit = rows;
+      }
+
+      if (search?.DateFrom || search?.DateTo) {
+        queryObj.createdAt = {
+          ...(search?.DateFrom && { [Op.gte]: search.DateFrom }),
+          ...(search?.DateTo && { [Op.lte]: search.DateTo }),
+        };
+      }
+
+      //Part 3: Call the class' repo class findAndCountAll() method queryObj and whereObj
+      const result = await LoginHistory._Repo.findAllWithPagination({
+        distinct: true,
+        where: queryObj,
+        ...whereObj,
+        order: [['CreatedAt', 'DESC']],
+        include: [
+          {
+            model: User,
+            required: false,
+            attributes: ['UserName'],
+          },
+        ],
+        transaction: dbTransaction,
+      });
+
+      //Part 4: Return the Count and LoginHistories.
+      const loginHistory = result.rows.map((data) => new LoginHistory(data));
+      return { count: result.count, loginHistory };
+    } catch (error) {
+      throw error;
+    }
+  }
+}

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

@@ -20,6 +20,7 @@ export interface IUserAttr extends IUserInfo {
   LastLoginAt: Date;
   MFAEnabled: number;
   MFAConfig: string;
+  MFABypassYN: string;
   RecoveryEmail: string;
   FailedLoginAttemptCount: number;
   LastFailedLoginAt: Date;

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

@@ -61,6 +61,7 @@ export class LoginUser extends User implements ILoginUser {
           LastLoginAt: user.LastLoginAt,
           MFAEnabled: user.MFAEnabled,
           MFAConfig: user.MFAConfig,
+          MFABypassYN: user.MFABypassYN,
           RecoveryEmail: user.RecoveryEmail,
           FailedLoginAttemptCount: user.FailedLoginAttemptCount,
           LastFailedLoginAt: user.LastFailedLoginAt,