@tomei/sso 0.41.1 → 0.42.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.ts

@@ -1,6 +1,10 @@
-import { ClassError, HashTable, ObjectBase } from '@tomei/general';
+import { ClassError, ObjectBase } from '@tomei/general';
 import { GroupReportingUserRepository } from './group-reporting-user.repository';
 import { IGroupReportingUserAttr } from '../../interfaces/group-reporting-user.interface';
+import { User } from '../login-user/user';
+import { Group } from '../group/group';
+import { ApplicationConfig } from '@tomei/config';
+import { ActionEnum, Activity } from '@tomei/activity-history';
 
 export class GroupReportingUser extends ObjectBase {
   ObjectId: string;
@@ -78,4 +82,113 @@ export class GroupReportingUser extends ObjectBase {
       );
     }
   }
+
+  async createGroupReportingUser(
+    loginUser: User, //The user performing the operation(typically the logged -in user).
+    dbTransaction: any, //Database transaction object to ensure the operation is atomic.
+    groupCode: string, //The code of the group to which the user is being assigned.
+    userId: number, //The ID of the user to be added to the group.
+    rank: number, //The rank to be assigned to the user in the group.
+    status: 'Active' | 'Inactive', //The initial status of the user in the group.
+  ): Promise<GroupReportingUser> { // Returns a GroupReportingUser instance representing the newly created record.
+    try {
+      //Creates a new group reporting user entry in the sso_GroupReportingUser table.
+
+      // Validate Input Parameters
+      // Ensure groupCode exists in the sso_Group table by calling the Group.init() method.
+      const group = await Group.init(dbTransaction, groupCode);
+      // Ensure userId exists in the sso_User table by calling the User.init() method.
+      const user = await User.init(dbTransaction, userId);
+      // Privilege Checking
+      // Call the loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieve from app config.
+      //   PrivilegeCode: "GROUP_REPORTING_USER_CREATE".
+
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'GROUP_REPORTING_USER_CREATE',
+      );
+      if (!isPrivileged) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg02',
+          'User does not have the privilege to create Group Reporting User',
+        );
+      }
+
+      // Check for Duplicate User in Group
+      // Query the sso_GroupReportingUser table to see if the userId already exists in the specified groupCode.
+      const groupReportingUser = await GroupReportingUser._Repo.findOne({
+        where: {
+          GroupCode: groupCode,
+          UserId: userId,
+        },
+        transaction: dbTransaction,
+      });
+      // If the user already exists in the group, throw an error indicating the user is already part of the group.
+      if (groupReportingUser) {
+        throw new ClassError(
+          'GroupReportingUser',
+          'GroupReportingUserErrMsg03',
+          'User already exists in the group',
+          'createGroupReportingUser',
+        );
+      }
+      // Create GroupReportingUser Entry
+      // If validation and privilege checks pass, insert a new record in the sso_GroupReportingUser table with the provided groupCode, userId, rank, status, and loginUser.UserId.Automatically capture the current timestamp for CreatedAt.
+      this.GroupCode = groupCode;
+      this.UserId = userId;
+      this.Rank = rank;
+      this.Status = status;
+      this._CreatedById = loginUser.UserId;
+      this._CreatedAt = new Date();
+
+      const entityValueAfter: any = {
+        GroupCode: groupCode,
+        UserId: userId,
+        Rank: rank,
+        Status: status,
+        CreatedById: loginUser.UserId,
+        CreatedAt: this._CreatedAt,
+      };
+
+      const newGroupReportingUser = await GroupReportingUser._Repo.create(
+        entityValueAfter,
+        {
+          transaction: dbTransaction,
+        },
+      );
+
+      entityValueAfter.GroupReportingUserId =
+        newGroupReportingUser.GroupReportingUserId;
+
+      // Record Create Activity
+      // Instantiate a new activity from the Activity class, and set:\
+      // ActivityId: activity.createId()
+      // Action: ActionEnum.Create
+      // Description: Create Group Reporting User
+      // EntityType: GroupReportingUser
+      // EntityId: newGroupReportingUser.GroupReportingUserId
+      // EntityValueBefore: Stringified empty object({})
+      // EntityValueAfter: EntityValueAfter(stringified representation of the newly created entity)
+      const activity = new Activity();
+      activity.Action = ActionEnum.CREATE;
+      activity.Description = 'Create Group Reporting User';
+      activity.EntityType = 'GroupReportingUser';
+      activity.EntityId = newGroupReportingUser.GroupReportingUserId.toString();
+      activity.EntityValueBefore = JSON.stringify({});
+      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
+      // Call the activity create() method by passing:
+      // dbTransaction
+      // userId: loginUser.UserId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+      // Return the Created GroupReportingUser
+      // Return the newly created GroupReportingUser instance, including all the relevant details like GroupReportingUserId, groupCode, userId, rank, status, and timestamps for CreatedAt.
+      return this;
+    } 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,
+  },
 }