@tomei/sso 0.40.4 → 0.41.1

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/api-key/api-key.ts

@@ -328,4 +328,104 @@ export class APIKey extends ObjectBase {
       throw error;
     }
   }
+
+  public async revoke(
+    apiKey: string,
+    loginUser: LoginUser,
+    dbTransaction: any,
+    reason?: string,
+  ) {
+    try {
+      // Part 1: Prepare Required Params
+      // Ensure apiKey, loginUser, and dbTransaction are provided.
+      // Retrieve the existing API key record from the database using the provided apiKey.
+      const apiKeyRecord = await APIKey._Repo.findOne({
+        where: { ApiKey: apiKey },
+        transaction: dbTransaction,
+      });
+      if (!apiKeyRecord) {
+        throw new ClassError(
+          'APIKey',
+          'APIKeyErrMsgO3',
+          'API key not found.',
+          'revoke',
+        );
+      }
+      const EntityValueBefore = {
+        ...apiKeyRecord.get({ plain: true }),
+      };
+
+      // Part 2: Revoke API Key
+      // Mark the API key as revoked:
+      // Set the Status to "Revoked".
+      apiKeyRecord.Status = APIKeyStatusEnum.REVOKED;
+      // Set the RevokedAt timestamp to the current date and time.\
+      apiKeyRecord.RevokedAt = new Date();
+      // Set the RevokedById to loginUser.UserId.
+      apiKeyRecord.RevokedById = loginUser.UserId;
+      // Optionally, set the revocation reason:
+      // If the reason parameter is provided, store it in the RevokedReason attribute.
+      if (reason) {
+        apiKeyRecord.RevokedReason = reason;
+      }
+
+      // Part 3: Save API Key to Database
+      // Call APIKey._Repo.update() by passing:
+      // The updated APIKey instance
+      // dbTransaction.
+      await APIKey._Repo.update(
+        {
+          ...apiKeyRecord.get({ plain: true }),
+        },
+        {
+          where: { APIKeyId: apiKeyRecord.APIKeyId },
+          transaction: dbTransaction,
+        },
+      );
+
+      // Part 4: Record Update API Key Activity
+      // Initialise EntityValueBefore variable and set to empty object.
+      // Initialise EntityValueAfter variable and set to this APIKey instance.
+      const EntityValueAfter = {
+        ...apiKeyRecord.get({ plain: true }),
+      };
+      // Instantiate new activity from Activity class, call createId() method, then set:
+      // Action: ActionEnum.Create
+      // Description: "Revoke API key."
+      // EntityType: "APIKey"
+      // EntityId: <this.APIKeyId>
+      // EntityValueBefore: EntityValueBefore
+      // EntityValueAfter: EntityValueAfter
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Revoke API key.';
+      activity.EntityType = 'APIKey';
+      activity.EntityId = apiKeyRecord.APIKeyId.toString();
+      activity.EntityValueBefore = JSON.stringify(EntityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(EntityValueAfter);
+      // Call new activity create method by passing:
+      // dbTransaction
+      // userId: loginUser.ObjectId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      // Part 5: Returns
+      // Translate the updated APIKey entity into an object and return the following fields:
+      // ApiKey
+      // Status: "Revoked"
+      // RevokedAt
+      // RevokedById
+      // RevokedByName
+      // RevokedReason
+      return {
+        ApiKey: apiKeyRecord.ApiKey,
+        Status: apiKeyRecord.Status,
+        RevokedAt: apiKeyRecord.RevokedAt,
+        RevokedById: apiKeyRecord.RevokedById,
+        RevokedReason: apiKeyRecord.RevokedReason,
+      };
+    } catch (error) {
+      throw error;
+    }
+  }
 }

package/src/components/group/group.ts

@@ -1780,4 +1780,124 @@ export class Group extends TreeNodeBase<Group> {
       throw error;
     }
   }
+
+  public static async getHierarchy(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    Status?: string,
+    Type?: GroupTypeEnum,
+    ParentGroupCode?: string,
+  ) {
+    // This method retrieves all group records from the sso_Group table in a hierarchical tree structure based on
+    // the ParentGroupCode. The hierarchy respects any filtering options passed, such as status or group type, and
+    // checks privileges of the requesting user.
+
+    // Part 1: Privilege Checking
+    // Call loginUser.checkPrivileges() by passing:
+    // - SystemCode: Retrieved from the system configuration.
+    // - PrivilegeCode: 'GROUP_VIEW'.
+    // Ensure the user has privileges to view group information.
+    const systemCode = ApplicationConfig.getComponentConfigValue('system-code');
+    const isPrivileged = await loginUser.checkPrivileges(
+      systemCode,
+      'GROUP_VIEW',
+    );
+
+    if (!isPrivileged) {
+      throw new ClassError(
+        'Group',
+        'GroupErrMsg04',
+        'User is not privileged to view group',
+      );
+    }
+
+    // Part 2: Prepare Filters
+    // Set the default filter for Status to "Active", unless specified.
+    // Use optional filters such as Type and ParentGroupCode if provided.
+    const queryObj: any = {};
+
+    let options: any = {
+      transaction: dbTransaction,
+    };
+
+    const search = {
+      Status: Status ? Status : 'Active',
+      Type: Type,
+      ParentGroupCode: ParentGroupCode,
+    };
+
+    if (search) {
+      Object.entries(search).forEach(([key, value]) => {
+        if (value) {
+          queryObj[key] = {
+            [Op.substring]: value,
+          };
+        }
+      });
+
+      options = {
+        ...options,
+        where: queryObj,
+      };
+
+      // Part 3: Retrieve Group Data
+      // Use Sequelize's findAll() method with the provided filters (status, type, and parentGroupCode) to query the sso_Group table.
+      // Recursively build the group tree based on ParentGroupCode relationships.
+
+      const result = await Group._Repo.findAll(options);
+      const data = result.map((group) => new Group(group.get({ plain: true })));
+
+      const generateTree = async (groups) => {
+        // Create a map for easy lookup by code
+
+        const data = groups.map((group) => {
+          return {
+            GroupCode: group.ObjectId,
+            Name: group.Name,
+            Description: group.Description,
+            Type: group.Type,
+            ParentGroupCode: group.ParentGroupCode,
+            InheritParentPrivilegeYN: group.InheritParentPrivilegeYN,
+            InheritParentSystemAccessYN: group.InheritParentSystemAccessYN,
+            Path: group._Path,
+            Status: group.Status,
+            CreatedById: group._CreatedById,
+            CreatedAt: group._CreatedAt,
+            UpdatedById: group._UpdatedById,
+            UpdatedAt: group._UpdatedAt,
+            childrens: [],
+          };
+        });
+        const groupMap = {};
+        data.forEach((group) => {
+          group.childrens = [];
+          groupMap[group.GroupCode] = group;
+        });
+
+        // Initialize the root nodes (those without a parentCode)
+        const tree = [];
+
+        data.forEach((group) => {
+          if (group.ParentGroupCode) {
+            // Add this group as a child of its parent
+            const parent = groupMap[group.ParentGroupCode];
+            if (parent) {
+              parent.childrens.push(group);
+            }
+          } else {
+            // If no parentCode, it's a root node
+            tree.push(group);
+          }
+        });
+
+        return tree;
+      };
+
+      const tree = await generateTree(data);
+
+      // Part 4: Return Results
+      // Return the tree structure with child groups (under the childrens key) included only if a group has child groups.
+      return tree;
+    }
+  }
 }

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,
+  },
 }

package/dist/__tests__/unit/components/group-privilege/group-privilege.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js

@@ -1,71 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const group_privilege_1 = require("../../../../src/components/group-privilege/group-privilege");
-const group_privilege_repository_1 = require("../../../../src/components/group-privilege/group-privilege.repository");
-const general_1 = require("@tomei/general");
-describe('GroupPrivilege', () => {
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-    it('should initialize with GroupPrivilegeAttr', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockGroupPrivilegeAttr = {
-            GroupPrivilegeId: 1,
-            GroupCode: 'group1',
-            PrivilegeCode: 'privilege1',
-            Status: 'active',
-            CreatedAt: new Date(),
-            UpdatedAt: new Date(),
-            CreatedById: 1,
-            UpdatedById: 1,
-        };
-        const findOneMock = jest
-            .spyOn(group_privilege_repository_1.GroupPrivilegeRepository.prototype, 'findOne')
-            .mockResolvedValueOnce({ get: jest.fn().mockReturnValue(mockGroupPrivilegeAttr) });
-        const groupPrivilege = yield group_privilege_1.GroupPrivilege.init(null, 1);
-        expect(findOneMock).toBeCalledWith({
-            where: { GroupPrivilegeId: 1 },
-            transaction: null,
-        });
-        expect(groupPrivilege).toBeInstanceOf(group_privilege_1.GroupPrivilege);
-        expect(groupPrivilege.GroupPrivilegeId).toEqual(mockGroupPrivilegeAttr.GroupPrivilegeId);
-        expect(groupPrivilege.GroupCode).toEqual(mockGroupPrivilegeAttr.GroupCode);
-        expect(groupPrivilege.PrivilegeCode).toEqual(mockGroupPrivilegeAttr.PrivilegeCode);
-        expect(groupPrivilege.Status).toEqual(mockGroupPrivilegeAttr.Status);
-        expect(groupPrivilege.CreatedAt).toEqual(mockGroupPrivilegeAttr.CreatedAt);
-        expect(groupPrivilege.UpdatedAt).toEqual(mockGroupPrivilegeAttr.UpdatedAt);
-        expect(groupPrivilege.CreatedById).toEqual(mockGroupPrivilegeAttr.CreatedById);
-        expect(groupPrivilege.UpdatedById).toEqual(mockGroupPrivilegeAttr.UpdatedById);
-    }));
-    it('should throw ClassError when GroupPrivilegeAttr is not found', () => __awaiter(void 0, void 0, void 0, function* () {
-        const findOneMock = jest
-            .spyOn(group_privilege_repository_1.GroupPrivilegeRepository.prototype, 'findOne')
-            .mockResolvedValueOnce(null);
-        yield expect(group_privilege_1.GroupPrivilege.init(null, 1)).rejects.toThrow(general_1.ClassError);
-        expect(findOneMock).toBeCalledWith({
-            where: { GroupPrivilegeId: 1 },
-            transaction: null,
-        });
-    }));
-    it('should initialize with default values', () => __awaiter(void 0, void 0, void 0, function* () {
-        const groupPrivilege = yield group_privilege_1.GroupPrivilege.init();
-        expect(groupPrivilege).toBeInstanceOf(group_privilege_1.GroupPrivilege);
-        expect(groupPrivilege.GroupPrivilegeId).toBeUndefined();
-        expect(groupPrivilege.GroupCode).toBeUndefined();
-        expect(groupPrivilege.PrivilegeCode).toBeUndefined();
-        expect(groupPrivilege.Status).toBeUndefined();
-        expect(groupPrivilege.CreatedAt).toBeUndefined();
-        expect(groupPrivilege.UpdatedAt).toBeUndefined();
-        expect(groupPrivilege.CreatedById).toBeUndefined();
-        expect(groupPrivilege.UpdatedById).toBeUndefined();
-    }));
-});
-//# sourceMappingURL=group-privilege.test.js.map

package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"group-privilege.test.js","sourceRoot":"","sources":["../../../../../__tests__/unit/components/group-privilege/group-privilege.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,gGAA4F;AAC5F,sHAAiH;AACjH,4CAA4C;AAE5C,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAS,EAAE;QACzD,MAAM,sBAAsB,GAAG;YAC7B,gBAAgB,EAAE,CAAC;YACnB,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;YAC3B,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,CAAC;SACf,CAAC;QAEF,MAAM,WAAW,GAAG,IAAI;aACrB,KAAK,CAAC,qDAAwB,CAAC,SAAS,EAAE,SAAS,CAAC;aACpD,qBAAqB,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAAS,CAAC,CAAC;QAE5F,MAAM,cAAc,GAAG,MAAM,gCAAc,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAE1D,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC;YACjC,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC,EAAE;YAC9B,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,gCAAc,CAAC,CAAC;QACtD,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;QACzF,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC3E,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACnF,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACrE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC3E,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC3E,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC/E,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;IACjF,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAS,EAAE;QAC5E,MAAM,WAAW,GAAG,IAAI;aACrB,KAAK,CAAC,qDAAwB,CAAC,SAAS,EAAE,SAAS,CAAC;aACpD,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAE/B,MAAM,MAAM,CAAC,gCAAc,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAU,CAAC,CAAC;QAEvE,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC;YACjC,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC,EAAE;YAC9B,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAS,EAAE;QACrD,MAAM,cAAc,GAAG,MAAM,gCAAc,CAAC,IAAI,EAAE,CAAC;QAEnD,MAAM,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,gCAAc,CAAC,CAAC;QACtD,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,aAAa,EAAE,CAAC;QACrD,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,aAAa,EAAE,CAAC;QACnD,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,aAAa,EAAE,CAAC;IACrD,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/unit/components/login-user/login-user.spec.js

@@ -1,6 +0,0 @@
-describe('LoginUser', () => {
-    it('should be true', () => {
-        expect(true).toBe(true);
-    });
-});
-//# sourceMappingURL=login-user.spec.js.map

package/dist/__tests__/unit/components/login-user/login-user.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"login-user.spec.js","sourceRoot":"","sources":["../../../../../__tests__/unit/components/login-user/login-user.spec.ts"],"names":[],"mappings":"AAuuBA,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}