@tomei/sso 0.43.2 → 0.44.0

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-reporting-user/group-reporting-user.repository.ts

@@ -8,4 +8,16 @@ export class GroupReportingUserRepository
   constructor() {
     super(GroupReportingUserModel);
   }
+
+  async destroy(
+    groupReportingUserId: number,
+    dbTransaction: any,
+  ): Promise<void> {
+    await GroupReportingUserModel.destroy({
+      where: {
+        GroupReportingUserId: groupReportingUserId,
+      },
+      transaction: dbTransaction,
+    });
+  }
 }

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

@@ -5,6 +5,7 @@ import { User } from '../login-user/user';
 import { Group } from '../group/group';
 import { ApplicationConfig } from '@tomei/config';
 import { ActionEnum, Activity } from '@tomei/activity-history';
+import { Transaction } from 'sequelize';
 
 export class GroupReportingUser extends ObjectBase {
   ObjectId: string;
@@ -280,4 +281,81 @@ export class GroupReportingUser extends ObjectBase {
       throw error;
     }
   }
+
+  public static async removeGroupReportingUser(
+    loginUser: User, //The user performing the operation, used for privilege checking and logging.
+    dbTransaction: Transaction, // The database transaction object to ensure the operation's atomicity.
+    groupReportingUserId: number, //The ID of the GroupReportingUser to be removed.
+  ): Promise<void> {
+    // This method removes a GroupReportingUser record from the database.
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      // PrivilegeCode: "GROUP_REPORTING_USER_REMOVE".
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_REMOVE',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg06',
+          'Insufficient privileges to remove a user from the group',
+        );
+      }
+
+      // Part 2: Find User
+      // Call GroupReportingUser.init(dbTransaction, groupReportingUserId) to check if the user exists.
+      const groupReportingUser = await GroupReportingUser.init(
+        dbTransaction,
+        groupReportingUserId.toString(),
+      );
+
+      // Part 3: Remove User
+      // Call GroupReportingUser._Repo.destroy({ where: { GroupReportingUserId: groupReportingUserId }, transaction: dbTransaction }) to remove the user from the database.
+      await GroupReportingUser._Repo.destroy(
+        groupReportingUserId,
+        dbTransaction,
+      );
+
+      // Part 4: Record Create Activity
+      // Initialise EntityValueBefore variable and set it to the GroupReportingUser instance before destruction.
+      const entityValueBefore = {
+        GroupReportingUserId: groupReportingUser.GroupReportingUserId,
+        GroupCode: groupReportingUser.GroupCode,
+        UserId: groupReportingUser.UserId,
+        Rank: groupReportingUser.Rank,
+        Status: groupReportingUser.Status,
+        CreatedById: groupReportingUser.CreatedById,
+        CreatedAt: groupReportingUser.CreatedAt,
+        UpdatedById: groupReportingUser.UpdatedById,
+        UpdatedAt: groupReportingUser.UpdatedAt,
+      };
+      // Instantiate a new activity from the Activity class, and set:
+      const activity = new Activity();
+      // ActivityId: activity.createId()
+      // Action: ActionEnum.Delete
+      // Description: Remove Group Reporting User
+      // EntityType: GroupReportingUser
+      // EntityId: groupReportingUserId
+      // EntityValueBefore: Stringified representation of the GroupReportingUser instance before destroy
+      // EntityValueAfter: Stringified empty object ({})
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.DELETE;
+      activity.Description = 'Remove Group Reporting User';
+      activity.EntityType = 'GroupReportingUser';
+      activity.EntityId = groupReportingUserId.toString();
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify({});
+      // Call the activity.create() method by passing:
+      // dbTransaction
+      // userId: loginUser.UserId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+    } catch (error) {
+      throw error;
+    }
+  }
 }

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,23 +1,23 @@
-{
-  "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,
-  },
+{
+  "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,
+  },
 }