@tomei/sso 0.52.2 → 0.53.0

package/migrations/20241104104802-create-building-table.js

@@ -1,95 +1,95 @@
-'use strict';
-
-/** @type {import('sequelize-cli').Migration} */
-module.exports = {
-  up: async (queryInterface, Sequelize) => {
-    await queryInterface.createTable('sso_Building', {
-      GroupCode: {
-        type: Sequelize.STRING(10),
-        primaryKey: true,
-        allowNull: false,
-        references: {
-          model: 'sso_Group',
-          key: 'GroupCode',
-        },
-        onUpdate: 'CASCADE',
-        onDelete: 'CASCADE',
-      },
-      BuildingType: {
-        type: Sequelize.ENUM(
-          'Outlet',
-          'Office',
-          'Fulfillment Center',
-          'Warehouse',
-        ),
-        allowNull: true,
-      },
-      Email: {
-        type: Sequelize.STRING(200),
-        allowNull: true,
-      },
-      Mobile: {
-        type: Sequelize.STRING(20),
-        allowNull: true,
-      },
-      Phone: {
-        type: Sequelize.STRING(20),
-        allowNull: false,
-      },
-      Brand: {
-        type: Sequelize.STRING(10),
-        allowNull: true,
-      },
-      OpeningDate: {
-        type: Sequelize.DATE,
-        allowNull: true,
-      },
-      CeasedDate: {
-        type: Sequelize.DATE,
-        allowNull: true,
-      },
-      OpeningHours: {
-        type: Sequelize.STRING(200),
-        allowNull: true,
-      },
-      CreatedById: {
-        type: Sequelize.INTEGER,
-        allowNull: true,
-        references: {
-          model: 'sso_User',
-          key: 'UserId',
-        },
-        onDelete: 'CASCADE',
-        onUpdate: 'CASCADE',
-      },
-      CreatedAt: {
-        allowNull: false,
-        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
-        type: Sequelize.DATE,
-      },
-      UpdatedById: {
-        type: Sequelize.INTEGER,
-        allowNull: true,
-        references: {
-          model: 'sso_User',
-          key: 'UserId',
-        },
-        onDelete: 'CASCADE',
-        onUpdate: 'CASCADE',
-      },
-      UpdatedAt: {
-        allowNull: false,
-        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
-        type: Sequelize.DATE,
-      },
-    });
-  },
-
-  down: async (queryInterface) => {
-    // Drop the trigger before dropping the table
-    await queryInterface.sequelize.query(
-      `DROP TRIGGER IF EXISTS update_GroupCode_ObjectId`,
-    );
-    await queryInterface.dropTable('sso_Building');
-  },
-};
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    await queryInterface.createTable('sso_Building', {
+      GroupCode: {
+        type: Sequelize.STRING(10),
+        primaryKey: true,
+        allowNull: false,
+        references: {
+          model: 'sso_Group',
+          key: 'GroupCode',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
+      BuildingType: {
+        type: Sequelize.ENUM(
+          'Outlet',
+          'Office',
+          'Fulfillment Center',
+          'Warehouse',
+        ),
+        allowNull: true,
+      },
+      Email: {
+        type: Sequelize.STRING(200),
+        allowNull: true,
+      },
+      Mobile: {
+        type: Sequelize.STRING(20),
+        allowNull: true,
+      },
+      Phone: {
+        type: Sequelize.STRING(20),
+        allowNull: false,
+      },
+      Brand: {
+        type: Sequelize.STRING(10),
+        allowNull: true,
+      },
+      OpeningDate: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      CeasedDate: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      OpeningHours: {
+        type: Sequelize.STRING(200),
+        allowNull: true,
+      },
+      CreatedById: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: {
+          model: 'sso_User',
+          key: 'UserId',
+        },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+      CreatedAt: {
+        allowNull: false,
+        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
+        type: Sequelize.DATE,
+      },
+      UpdatedById: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: {
+          model: 'sso_User',
+          key: 'UserId',
+        },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE',
+      },
+      UpdatedAt: {
+        allowNull: false,
+        defaultValue: Sequelize.literal('CURRENT_TIMESTAMP(3)'),
+        type: Sequelize.DATE,
+      },
+    });
+  },
+
+  down: async (queryInterface) => {
+    // Drop the trigger before dropping the table
+    await queryInterface.sequelize.query(
+      `DROP TRIGGER IF EXISTS update_GroupCode_ObjectId`,
+    );
+    await queryInterface.dropTable('sso_Building');
+  },
+};

package/package.json

@@ -1,90 +1,90 @@
-{
-  "name": "@tomei/sso",
-  "version": "0.52.2",
-  "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.2.23",
-    "@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.53.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.2.23",
+    "@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-user/user.ts

@@ -33,6 +33,7 @@ import { RedisService } from '../../redis-client/redis.service';
 import { LoginUser } from './login-user';
 import { SessionService } from '../../session/session.service';
 import { createHash, randomBytes, randomUUID } from 'crypto';
+import { AuthContext } from 'types';
 
 export class User extends UserBase {
   ObjectId: string;
@@ -2450,23 +2451,25 @@ export class User extends UserBase {
   }
 
   public static async findById(
-    loginUser: LoginUser,
+    AuthContext: AuthContext,
     dbTransaction: any,
     UserId: string,
   ) {
     const systemCode = ApplicationConfig.getComponentConfigValue('system-code');
-    const isPrivileged = await loginUser.checkPrivileges(
-      systemCode,
-      'USER_VIEW',
-    );
-
-    //If user does not have privilege to update user, throw a ClassError
-    if (!isPrivileged) {
-      throw new ClassError(
-        'LoginUser',
-        'LoginUserErrMsg0X',
-        'You do not have the privilege to find user',
+    if ('loginUser' in AuthContext) {
+      const isPrivileged = await AuthContext.loginUser.checkPrivileges(
+        systemCode,
+        'USER_VIEW',
       );
+
+      //If user does not have privilege to update user, throw a ClassError
+      if (!isPrivileged) {
+        throw new ClassError(
+          'LoginUser',
+          'LoginUserErrMsg0X',
+          'You do not have the privilege to find user',
+        );
+      }
     }
 
     const user = await User._Repository.findOne({
@@ -2543,7 +2546,7 @@ export class User extends UserBase {
   }
 
   public static async findByEmail(
-    loginUser: LoginUser,
+    AuthContext: AuthContext,
     dbTransaction: any,
     Email: string,
   ): Promise<User> {
@@ -2555,18 +2558,20 @@ export class User extends UserBase {
       // PrivilegeCode: "USER_VIEW"
       const systemCode =
         ApplicationConfig.getComponentConfigValue('system-code');
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'USER_VIEW',
-      );
-
-      // If user does not have privilege to update user, throw a ClassError
-      if (!isPrivileged) {
-        throw new ClassError(
-          'LoginUser',
-          'LoginUserErrMsg0X',
-          'You do not have the privilege to find user',
+      if ('loginUser' in AuthContext) {
+        const isPrivileged = await AuthContext.loginUser.checkPrivileges(
+          systemCode,
+          'USER_VIEW',
         );
+
+        // If user does not have privilege to update user, throw a ClassError
+        if (!isPrivileged) {
+          throw new ClassError(
+            'LoginUser',
+            'LoginUserErrMsg0X',
+            'You do not have the privilege to find user',
+          );
+        }
       }
 
       // Part 2: Retrieve User & Returns

package/src/session/session.service.ts

@@ -4,12 +4,18 @@ import { IUserSession } from '../interfaces/user-session.interface';
 
 export class SessionService implements ISessionService {
   private static _RedisService: RedisService;
+  private environment: string = '';
 
   private constructor() {}
 
   static async init(redisClient?: any): Promise<SessionService> {
     const sessionService = new SessionService();
     SessionService._RedisService = await RedisService.init(redisClient);
+    if (process.env.NODE_ENV == 'test') {
+      sessionService.environment = 'test:';
+    } else if (process.env.NODE_ENV == 'staging') {
+      sessionService.environment = 'staging:';
+    }
     return sessionService;
   }
 
@@ -18,7 +24,7 @@ export class SessionService implements ISessionService {
     sessionData: IUserSession,
   ): Promise<void> {
     try {
-      const key = `tomei-sid:${userId}`;
+      const key = `${this.environment}tomei-sid:${userId}`;
       await SessionService._RedisService.set(
         key,
         sessionData,
@@ -31,7 +37,7 @@ export class SessionService implements ISessionService {
 
   async retrieveUserSession(userId: string): Promise<IUserSession> {
     try {
-      const key = `tomei-sid:${userId}`;
+      const key = `${this.environment}tomei-sid:${userId}`;
       const stringData = await SessionService._RedisService.get(key);
       if (!stringData)
         return {
@@ -58,7 +64,7 @@ export class SessionService implements ISessionService {
     expire: number,
   ): Promise<void> {
     try {
-      const key = `tomei-auth-code:${token}`;
+      const key = `${this.environment}tomei-auth-code:${token}`;
       await SessionService._RedisService.set(key, value, expire);
     } catch (error) {
       throw error;
@@ -67,7 +73,7 @@ export class SessionService implements ISessionService {
 
   async retrieveAuthorizationCode(token: string): Promise<string> {
     try {
-      const key = `tomei-auth-code:${token}`;
+      const key = `${this.environment}tomei-auth-code:${token}`;
       return await SessionService._RedisService.get(key);
     } catch (error) {
       throw error;
@@ -76,7 +82,7 @@ export class SessionService implements ISessionService {
 
   async deleteAuthorizationCode(token: string): Promise<void> {
     try {
-      const key = `tomei-auth-code:${token}`;
+      const key = `${this.environment}tomei-auth-code:${token}`;
       await SessionService._RedisService.del(key);
     } catch (error) {
       throw error;

package/src/types/auth-context.ts

@@ -1,3 +1,4 @@
+import { IAPIKeyAttr } from '../interfaces/api-key-attr.interface';
 import { LoginUser } from '../components/login-user/login-user';
 
 export type AuthContext =
@@ -5,5 +6,5 @@ export type AuthContext =
       loginUser: LoginUser;
     }
   | {
-      apiKey: string;
+      apiKey: IAPIKeyAttr;
     };

package/tsconfig.build.json

@@ -1,6 +1,6 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["**/*.ts"],
-  "exclude": ["node_modules", "__tests__", "dist", "**/*spec.ts"]
-}
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules", "__tests__", "dist", "**/*spec.ts"]
+}
   

package/tsconfig.json

@@ -1,24 +1,24 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "declaration": true,
-    "removeComments": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "allowSyntheticDefaultImports": true,
-    "moduleResolution": "node",
-    "target": "es6",
-    "sourceMap": true,
-    "outDir": "./dist",
-    "baseUrl": "./src",
-    "rootDir": "./",
-    "incremental": true,
-    "skipLibCheck": true,
-    "noImplicitAny": false,
-    "strictBindCallApply": false,
-    "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false,
-    "strictNullChecks": false,
-  },
-  "exclude": ["node_modules", "dist"]
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "node",
+    "target": "es6",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./src",
+    "rootDir": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false,
+    "strictNullChecks": false,
+  },
+  "exclude": ["node_modules", "dist"]
 }