@tomei/sso 0.51.9 → 0.52.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.51.9",
-  "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.52.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/group/group.ts

@@ -754,6 +754,71 @@ export class Group extends TreeNodeBase<Group> {
     }
   }
 
+  public static async getSystemAccessRoles(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    SystemCode: string,
+    Page: number,
+    Rows: number,
+    Search: {
+      GroupCode?: string;
+      Status?: string;
+    },
+  ) {
+    // Part 1: Privilege Checking
+    const systemCode = ApplicationConfig.getComponentConfigValue('system-code');
+    const isPrivileged = await loginUser.checkPrivileges(
+      systemCode,
+      'SYSTEM_ACCESS_VIEW',
+    );
+
+    if (!isPrivileged) {
+      throw new ClassError(
+        'Group',
+        'GroupErrMsg06',
+        'You do not have the privilege to view system access',
+      );
+    }
+
+    try {
+      // Part 2: Retrieve System Access and returns
+      const queryObj: any = { SystemCode: SystemCode };
+
+      if (Search) {
+        Object.entries(Search).forEach(([key, value]) => {
+          queryObj[key] = value;
+        });
+      }
+
+      let options: any = {
+        where: queryObj,
+        distinct: true,
+        transaction: dbTransaction,
+      };
+
+      if (Page && Rows) {
+        options = {
+          ...options,
+          limit: Rows,
+          offset: Rows * (Page - 1),
+          order: [['CreatedAt', 'DESC']],
+          include: {
+            model: GroupModel,
+            where: {
+              Type: 'Role',
+            },
+          },
+        };
+      }
+
+      const systemAccess =
+        await Group._GroupSystemAccessRepo.findAndCountAll(options);
+      return systemAccess;
+    } catch (error) {
+      return error;
+    }
+  }
+
   private static async getInheritedSystemAccess(
     dbTransaction: any,
     group: Group,
@@ -1097,6 +1162,175 @@ export class Group extends TreeNodeBase<Group> {
     }
   }
 
+  public static async getSystemPrivilegeRoles(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    SystemCode: string,
+    search?: {
+      GroupCode?: string[];
+      Status?: string;
+    },
+  ) {
+    try {
+      //Part 1: Privilege Checking
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_PRIVILEGE_VIEW',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Group',
+          'GroupErrMsg11',
+          'You do not have the privilege to view group privileges',
+        );
+      }
+
+      //Part 2: Retrieve Roles Based on Privilege
+      //Retrieve Roles based on privilege on a system
+      let systemWhere: any = {};
+
+      if (search) {
+        if (search.GroupCode.length) {
+        }
+      }
+
+      if (SystemCode) {
+        systemWhere = {
+          SystemCode: {
+            [Op.substring]: SystemCode,
+          },
+        };
+      }
+
+      const groupCodesPrivileges: {
+        SystemPrivilegeId: string;
+        GroupCodes: { Code: string; Name: string }[];
+      }[] = [];
+
+      const allGroupCodePrivileges = await Group._GroupPrivilegeRepo.findAll({
+        include: [
+          {
+            model: SystemPrivilegeModel,
+            where: systemWhere,
+          },
+          {
+            model: GroupModel,
+            where: {
+              Type: 'Role',
+            },
+          },
+        ],
+        transaction: dbTransaction,
+      });
+
+      // Use a Map to group by SystemPrivilegeId
+      const privilegesMap = new Map<string, { Code: string; Name: string }[]>();
+
+      for (const groupCodePrivilege of allGroupCodePrivileges) {
+        const { SystemPrivilegeId, GroupCode, Group } = groupCodePrivilege; // `Group` contains Name from GroupModel
+
+        if (!privilegesMap.has(SystemPrivilegeId)) {
+          // Initialize with an empty array if not already present
+          privilegesMap.set(SystemPrivilegeId, []);
+        }
+
+        // Add the GroupCode and Name to the array if it exists and is not already present
+        if (GroupCode && Group?.Name) {
+          const groupCodes = privilegesMap.get(SystemPrivilegeId);
+          const newGroupEntry = { Code: GroupCode, Name: Group.Name };
+
+          // Ensure no duplicates
+          if (
+            groupCodes &&
+            !groupCodes.some(
+              (g) => g.Code === GroupCode && g.Name === Group.Name,
+            )
+          ) {
+            groupCodes.push(newGroupEntry);
+          }
+        }
+      }
+
+      // Convert the Map to the desired array format
+      privilegesMap.forEach((groupCodes, SystemPrivilegeId) => {
+        groupCodesPrivileges.push({
+          SystemPrivilegeId,
+          GroupCodes: groupCodes,
+        });
+      });
+
+      const allPrivileges = await SystemPrivilegeModel.findAll({
+        where: systemWhere,
+        transaction: dbTransaction,
+      });
+
+      const groupPrivilegeRoles: {
+        SystemPrivilegeId: string;
+        PrivilegeCode: string;
+        Description: string;
+        GroupCodes: { Code: string; Name: string }[];
+      }[] = [];
+
+      // Iterate through allPrivileges to check for matches in groupCodesPrivileges
+      for (const privilege of allPrivileges) {
+        const matchingGroupPrivilege = groupCodesPrivileges.find(
+          (groupPrivilege) =>
+            groupPrivilege.SystemPrivilegeId === privilege.SystemPrivilegeId,
+        );
+
+        if (matchingGroupPrivilege) {
+          // If match is found, push to groupPrivilegeRoles with GroupCodes
+          groupPrivilegeRoles.push({
+            SystemPrivilegeId: privilege.SystemPrivilegeId,
+            PrivilegeCode: privilege.PrivilegeCode,
+            Description: privilege.Description,
+            GroupCodes: matchingGroupPrivilege.GroupCodes,
+          });
+        } else {
+          // If no match is found, push with an empty array of GroupCodes
+          groupPrivilegeRoles.push({
+            SystemPrivilegeId: privilege.SystemPrivilegeId,
+            PrivilegeCode: privilege.PrivilegeCode,
+            Description: privilege.Description,
+            GroupCodes: [],
+          });
+        }
+      }
+
+      const filteredGroupPrivilegeRoles = groupPrivilegeRoles
+        .map((role) => {
+          if (search.GroupCode?.length) {
+            // Filter GroupCodes to only include matching Codes
+            const matchingGroupCodes = role.GroupCodes.filter((groupCode) =>
+              search.GroupCode.includes(groupCode.Code),
+            );
+
+            // If there are no matching GroupCodes, exclude this role
+            if (matchingGroupCodes.length === 0) {
+              return null;
+            }
+
+            // Return the role with filtered GroupCodes
+            return {
+              ...role,
+              GroupCodes: matchingGroupCodes,
+            };
+          }
+
+          // If search.GroupCode is not provided, include all data
+          return role;
+        })
+        .filter(Boolean); // Remove any null values
+
+      return filteredGroupPrivilegeRoles;
+    } catch (error) {
+      throw error;
+    }
+  }
+
   public static async getInheritedSystemPrivileges(
     dbTransaction: any,
     GroupCode: string,

package/src/index.ts

@@ -5,3 +5,4 @@ export * from './redis-client';
 export * from './session';
 export * from './enum';
 export * as ssoDb from './database';
+export * from './types';