@tomei/sso 0.46.10 → 0.48.0

package/package.json

@@ -1,89 +1,89 @@
-{
-  "name": "@tomei/sso",
-  "version": "0.46.10",
-  "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": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@tsconfig/node18": "^2.0.1",
-    "@types/bcrypt": "^5.0.0",
-    "@types/jest": "^29.5.2",
-    "@types/node": "^18.17.5",
-    "@types/redis": "^4.0.11",
-    "@types/validator": "^13.11.1",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "dotenv": "^16.1.4",
-    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "jest-mock-extended": "^3.0.4",
-    "jest-sonar-reporter": "^2.0.0",
-    "lint-staged": "^13.2.2",
-    "prettier": "^2.7.1",
-    "prisma": "^4.14.0",
-    "redis-mock": "^0.56.3",
-    "sequelize-cli": "^6.6.2",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "tsc-watch": "^5.0.3",
-    "tsconfig-paths": "^4.0.0",
-    "tslint": "^6.1.3",
-    "typescript": "^4.7.4"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "@tomei/activity-history": "^0.2.19",
-    "@tomei/config": "^0.3.12",
-    "@tomei/general": "^0.15.2",
-    "@tomei/mailer": "^0.5.15",
-    "argon2": "^0.30.3",
-    "cls-hooked": "^4.2.2",
-    "cuid": "^3.0.0",
-    "nodemailer": "^6.9.3",
-    "redis": "^4.6.7",
-    "reflect-metadata": "^0.1.13",
-    "sequelize": "^6.37.3",
-    "sequelize-typescript": "^2.1.6",
-    "speakeasy": "^2.0.0",
-    "uuid": "^10.0.0"
-  },
-  "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.48.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": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
+    "@tsconfig/node18": "^2.0.1",
+    "@types/bcrypt": "^5.0.0",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^18.17.5",
+    "@types/redis": "^4.0.11",
+    "@types/validator": "^13.11.1",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "dotenv": "^16.1.4",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.4",
+    "jest-sonar-reporter": "^2.0.0",
+    "lint-staged": "^13.2.2",
+    "prettier": "^2.7.1",
+    "prisma": "^4.14.0",
+    "redis-mock": "^0.56.3",
+    "sequelize-cli": "^6.6.2",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "tsc-watch": "^5.0.3",
+    "tsconfig-paths": "^4.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.7.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tomei/activity-history": "^0.2.19",
+    "@tomei/config": "^0.3.12",
+    "@tomei/general": "^0.15.2",
+    "@tomei/mailer": "^0.5.15",
+    "argon2": "^0.30.3",
+    "cls-hooked": "^4.2.2",
+    "cuid": "^3.0.0",
+    "nodemailer": "^6.9.3",
+    "redis": "^4.6.7",
+    "reflect-metadata": "^0.1.13",
+    "sequelize": "^6.37.3",
+    "sequelize-typescript": "^2.1.6",
+    "speakeasy": "^2.0.0",
+    "uuid": "^10.0.0"
+  },
+  "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

@@ -1728,7 +1728,7 @@ export class User extends UserBase {
     }
 
     // 4. Generate the 2FA secret code by calling speakeasy.generateSecret with parameter
-    const secretCode = speakeasy.generateSecret({ name: 'Tomei 2FA' });
+    const secretCode = speakeasy.generateSecret({ name: 'Tomei SSO' });
 
     // parse MFA Config
     let userMFAConfig = null;

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

@@ -8,6 +8,7 @@ import { ActionEnum, Activity } from '@tomei/activity-history';
 import GroupSystemAccessModel from '../../models/group-system-access.entity';
 import GroupModel from '../../models/group.entity';
 import SystemModel from '../../models/system.entity';
+import { Transaction } from 'sequelize';
 
 export class UserGroup extends ObjectBase {
   ObjectType = 'UserGroup';
@@ -456,4 +457,137 @@ export class UserGroup extends ObjectBase {
       throw error;
     }
   }
+
+  public async update(
+    loginUser: LoginUser,
+    dbTransaction: Transaction,
+    UpdatedProperties: {
+      InheritGroupPrivilegeYN?: string;
+      InheritGroupSystemAccessYN?: string;
+    },
+  ): Promise<UserGroup> {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() to ensure the user has permission to retrieve system access information.
+      // SystemCode: Retrieve from app config.
+      // PrivilegeCode: 'USER_GROUP_UPDATE'.
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'USER_GROUP_UPDATE',
+      );
+      // If the privilege check fails, throw an error with a 403 Forbidden status.
+      if (!isPrivileged) {
+        throw new ClassError(
+          'UserGroup',
+          'UserGroupErrMsg0X',
+          'User does not have privilege to update user group.',
+          'update',
+          403,
+        );
+      }
+      // Part 2: Validation
+      // Check to make sure that at least one of the UpdatedProperties  is exist if not throw error.
+      if (
+        !UpdatedProperties.InheritGroupPrivilegeYN &&
+        !UpdatedProperties.InheritGroupSystemAccessYN
+      ) {
+        throw new ClassError(
+          'UserGroup',
+          'UserGroupErrMsg04',
+          'At least one of the properties to update is required.',
+          'update',
+          400,
+        );
+      }
+      // Part 3: Update User Group
+      // Call the UserGroup._Repo.update() method to perform the update operation, passing:
+      // InheritGroupPrivilegeYN (if exist): updatedProperties.InheritGroupPrivilegeYN
+      // InheritGroupSystemAccessYN (if exist): updatedProperties.InheritGroupSystemAccessYN
+      // UpdatedById: loginUser.UserId (to indicate who updated the record).
+      // UpdatedAt: Set to the current date and time.
+      // dbTransaction: The database transaction instance.
+      const entityValueBefore = {
+        UserGroupId: this.UserGroupId,
+        UserId: this.UserId,
+        GroupCode: this.GroupCode,
+        Status: this.Status,
+        CreatedById: this._CreatedById,
+        CreatedAt: this._CreatedAt,
+        UpdatedById: this._UpdatedById,
+        UpdatedAt: this._UpdatedAt,
+        InheritGroupPrivilegeYN: this.InheritGroupPrivilegeYN,
+        InheritGroupSystemAccessYN: this.InheritGroupSystemAccessYN,
+      };
+
+      this._UpdatedById = loginUser.UserId;
+      this._UpdatedAt = new Date();
+      if (UpdatedProperties.InheritGroupPrivilegeYN) {
+        this.InheritGroupPrivilegeYN =
+          UpdatedProperties.InheritGroupPrivilegeYN;
+      }
+      if (UpdatedProperties.InheritGroupSystemAccessYN) {
+        this.InheritGroupSystemAccessYN =
+          UpdatedProperties.InheritGroupSystemAccessYN;
+      }
+
+      await UserGroup._Repository.update(
+        {
+          InheritGroupPrivilegeYN: this.InheritGroupPrivilegeYN,
+          InheritGroupSystemAccessYN: this.InheritGroupSystemAccessYN,
+          UpdatedById: this._UpdatedById,
+          UpdatedAt: this._UpdatedAt,
+        },
+        {
+          where: {
+            UserGroupId: this.UserGroupId,
+          },
+          transaction: dbTransaction,
+        },
+      );
+
+      // Part 2: Record Activity History
+      // Initialize a variable entityValueBefore to store the current state of the record before the update.
+      const entityValueAfter = {
+        UserGroupId: this.UserGroupId,
+        UserId: this.UserId,
+        GroupCode: this.GroupCode,
+        Status: this.Status,
+        CreatedById: this._CreatedById,
+        CreatedAt: this._CreatedAt,
+        UpdatedById: this._UpdatedById,
+        UpdatedAt: this._UpdatedAt,
+        InheritGroupPrivilegeYN: this.InheritGroupPrivilegeYN,
+        InheritGroupSystemAccessYN: this.InheritGroupSystemAccessYN,
+      };
+      // Create an instance of the Activity class and set the following properties:
+      // ActivityId: Call activity.createId().
+      // Action: Set to ActionEnum.Update.
+      // Description: Set to Update User Group.
+      // EntityType: Set to UserGroup.
+      // EntityId: Use the ID of the updated record.
+      // EntityValueBefore: Stringify entityValueBefore to capture the state before the update.
+      // EntityValueAfter: Stringify the updated  record to capture the new state after the update.
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Update User Group';
+      activity.EntityType = 'UserGroup';
+      activity.EntityId = this.UserGroupId.toString();
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
+
+      // Call the activity create a method with the following parameters:
+      // dbTransaction
+      // userId: loginUser.UserId
+      // Part 3: Return Updated Record
+
+      await activity.create(loginUser.ObjectId, dbTransaction);
+      // Retrieve the updated user group record from the database or return the updated instance as needed.
+      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,
+  },
 }