@tomei/sso 0.31.5 → 0.32.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. package/.commitlintrc.json +22 -22
  2. package/.eslintrc +16 -16
  3. package/.eslintrc.js +35 -35
  4. package/.gitlab-ci.yml +16 -16
  5. package/.husky/commit-msg +15 -15
  6. package/.husky/pre-commit +7 -7
  7. package/.prettierrc +4 -4
  8. package/Jenkinsfile +57 -57
  9. package/README.md +23 -23
  10. package/__tests__/unit/components/group/group.spec.ts +79 -79
  11. package/__tests__/unit/components/group-object-privilege/group-object-privilege.spec.ts +88 -88
  12. package/__tests__/unit/components/group-privilege/group-privilege.spec.ts +68 -68
  13. package/__tests__/unit/components/group-reporting-user/group-reporting-user.spec.ts +66 -66
  14. package/__tests__/unit/components/group-system-access/group-system-access.spec.ts +83 -83
  15. package/__tests__/unit/components/login-user/l.spec.ts +746 -746
  16. package/__tests__/unit/components/login-user/login.spec.ts +1064 -1064
  17. package/__tests__/unit/components/password-hash/password-hash.service.spec.ts +31 -31
  18. package/__tests__/unit/components/system/system.spec.ts +254 -254
  19. package/__tests__/unit/components/system-privilege/system-privilege.spec.ts +83 -83
  20. package/__tests__/unit/components/user-group/user-group.spec.ts +86 -86
  21. package/__tests__/unit/components/user-object-privilege/user-object-privilege.spec.ts +78 -78
  22. package/__tests__/unit/components/user-privilege/user-privilege.spec.ts +72 -72
  23. package/__tests__/unit/components/user-system-access/user-system-access.spec.ts +89 -89
  24. package/__tests__/unit/redis-client/redis.service.spec.ts +23 -23
  25. package/__tests__/unit/session/session.service.spec.ts +47 -47
  26. package/__tests__/unit/system-privilege/system-privilage.spec.ts +91 -91
  27. package/coverage/clover.xml +1452 -1452
  28. package/coverage/coverage-final.json +47 -47
  29. package/coverage/lcov-report/base.css +224 -224
  30. package/coverage/lcov-report/block-navigation.js +87 -87
  31. package/coverage/lcov-report/components/group/group.repository.ts.html +117 -117
  32. package/coverage/lcov-report/components/group/group.ts.html +327 -327
  33. package/coverage/lcov-report/components/group/index.html +130 -130
  34. package/coverage/lcov-report/components/group-object-privilege/group-object-privilege.repository.ts.html +117 -117
  35. package/coverage/lcov-report/components/group-object-privilege/group-object-privilege.ts.html +321 -321
  36. package/coverage/lcov-report/components/group-object-privilege/index.html +130 -130
  37. package/coverage/lcov-report/components/group-privilege/group-privilege.repository.ts.html +117 -117
  38. package/coverage/lcov-report/components/group-privilege/group-privilege.ts.html +303 -303
  39. package/coverage/lcov-report/components/group-privilege/index.html +130 -130
  40. package/coverage/lcov-report/components/group-reporting-user/group-reporting-user.repository.ts.html +117 -117
  41. package/coverage/lcov-report/components/group-reporting-user/group-reporting-user.ts.html +327 -327
  42. package/coverage/lcov-report/components/group-reporting-user/index.html +130 -130
  43. package/coverage/lcov-report/components/group-system-access/group-system-access.repository.ts.html +117 -117
  44. package/coverage/lcov-report/components/group-system-access/group-system-access.ts.html +309 -309
  45. package/coverage/lcov-report/components/group-system-access/index.html +130 -130
  46. package/coverage/lcov-report/components/login-history/index.html +115 -115
  47. package/coverage/lcov-report/components/login-history/login-history.repository.ts.html +117 -117
  48. package/coverage/lcov-report/components/login-user/index.html +130 -130
  49. package/coverage/lcov-report/components/login-user/login-user.ts.html +5007 -5007
  50. package/coverage/lcov-report/components/login-user/user.repository.ts.html +117 -117
  51. package/coverage/lcov-report/components/password-hash/index.html +115 -115
  52. package/coverage/lcov-report/components/password-hash/password-hash.service.ts.html +126 -126
  53. package/coverage/lcov-report/components/system/index.html +130 -130
  54. package/coverage/lcov-report/components/system/system.repository.ts.html +117 -117
  55. package/coverage/lcov-report/components/system/system.ts.html +909 -909
  56. package/coverage/lcov-report/components/system-privilege/index.html +130 -130
  57. package/coverage/lcov-report/components/system-privilege/system-privilege.repository.ts.html +120 -120
  58. package/coverage/lcov-report/components/system-privilege/system-privilege.ts.html +390 -390
  59. package/coverage/lcov-report/components/user-group/index.html +130 -130
  60. package/coverage/lcov-report/components/user-group/user-group.repository.ts.html +117 -117
  61. package/coverage/lcov-report/components/user-group/user-group.ts.html +354 -354
  62. package/coverage/lcov-report/components/user-object-privilege/index.html +130 -130
  63. package/coverage/lcov-report/components/user-object-privilege/user-object-privilege.repository.ts.html +117 -117
  64. package/coverage/lcov-report/components/user-object-privilege/user-object-privilege.ts.html +312 -312
  65. package/coverage/lcov-report/components/user-privilege/index.html +130 -130
  66. package/coverage/lcov-report/components/user-privilege/user-privilege.repository.ts.html +117 -117
  67. package/coverage/lcov-report/components/user-privilege/user-privilege.ts.html +306 -306
  68. package/coverage/lcov-report/components/user-system-access/index.html +130 -130
  69. package/coverage/lcov-report/components/user-system-access/user-system-access.repository.ts.html +117 -117
  70. package/coverage/lcov-report/components/user-system-access/user-system-access.ts.html +312 -312
  71. package/coverage/lcov-report/enum/group-type.enum.ts.html +108 -108
  72. package/coverage/lcov-report/enum/index.html +160 -160
  73. package/coverage/lcov-report/enum/index.ts.html +93 -93
  74. package/coverage/lcov-report/enum/user-status.enum.ts.html +105 -105
  75. package/coverage/lcov-report/enum/yn.enum.ts.html +96 -96
  76. package/coverage/lcov-report/index.html +370 -370
  77. package/coverage/lcov-report/models/group-object-privilege.entity.ts.html +333 -333
  78. package/coverage/lcov-report/models/group-privilege.entity.ts.html +315 -315
  79. package/coverage/lcov-report/models/group-reporting-user.entity.ts.html +339 -339
  80. package/coverage/lcov-report/models/group-system-access.entity.ts.html +324 -324
  81. package/coverage/lcov-report/models/group.entity.ts.html +435 -435
  82. package/coverage/lcov-report/models/index.html +310 -310
  83. package/coverage/lcov-report/models/login-history.entity.ts.html +252 -252
  84. package/coverage/lcov-report/models/staff.entity.ts.html +411 -411
  85. package/coverage/lcov-report/models/system-privilege.entity.ts.html +354 -354
  86. package/coverage/lcov-report/models/system.entity.ts.html +423 -423
  87. package/coverage/lcov-report/models/user-group.entity.ts.html +354 -354
  88. package/coverage/lcov-report/models/user-object-privilege.entity.ts.html +330 -330
  89. package/coverage/lcov-report/models/user-privilege.entity.ts.html +315 -315
  90. package/coverage/lcov-report/models/user-system-access.entity.ts.html +315 -315
  91. package/coverage/lcov-report/models/user.entity.ts.html +522 -522
  92. package/coverage/lcov-report/prettify.css +1 -1
  93. package/coverage/lcov-report/prettify.js +2 -2
  94. package/coverage/lcov-report/redis-client/index.html +115 -115
  95. package/coverage/lcov-report/redis-client/redis.service.ts.html +240 -240
  96. package/coverage/lcov-report/session/index.html +115 -115
  97. package/coverage/lcov-report/session/session.service.ts.html +246 -246
  98. package/coverage/lcov-report/sorter.js +196 -196
  99. package/coverage/lcov.info +2490 -2490
  100. package/coverage/test-report.xml +128 -128
  101. package/create-sso-user.sql +39 -39
  102. package/dist/__tests__/unit/components/group-privilege/group-privilege.test.d.ts +1 -0
  103. package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js +71 -0
  104. package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js.map +1 -0
  105. package/dist/__tests__/unit/components/login-user/login-user.spec.js +5 -0
  106. package/dist/__tests__/unit/components/login-user/login-user.spec.js.map +1 -1
  107. package/dist/src/components/group/group.d.ts +5 -0
  108. package/dist/src/components/group/group.js +38 -0
  109. package/dist/src/components/group/group.js.map +1 -1
  110. package/dist/src/components/group-system-access/group-system-access.repository.d.ts +1 -0
  111. package/dist/src/components/group-system-access/group-system-access.repository.js +26 -0
  112. package/dist/src/components/group-system-access/group-system-access.repository.js.map +1 -1
  113. package/dist/src/components/login-user/login-user.d.ts +1 -1
  114. package/dist/src/components/system/system.d.ts +1 -0
  115. package/dist/src/components/system/system.js +71 -0
  116. package/dist/src/components/system/system.js.map +1 -1
  117. package/dist/tsconfig.tsbuildinfo +1 -1
  118. package/jest.config.js +14 -14
  119. package/migrations/20240314080602-create-user-table.js +108 -108
  120. package/migrations/20240314080603-create-user-group-table.js +85 -85
  121. package/migrations/20240314080604-create-user-user-group-table.js +55 -55
  122. package/migrations/20240314080605-create-login-history-table.js +53 -53
  123. package/migrations/20240527064925-create-system-table.js +78 -78
  124. package/migrations/20240527064926-create-system-privilege-table.js +67 -67
  125. package/migrations/20240527065342-create-group-table.js +89 -89
  126. package/migrations/20240527065633-create-group-reporting-user-table.js +76 -76
  127. package/migrations/20240528011551-create-group-system-access-table.js +72 -72
  128. package/migrations/20240528023018-user-system-access-table.js +75 -75
  129. package/migrations/20240528032229-user-privilege-table.js +75 -75
  130. package/migrations/20240528063003-create-group-privilege-table.js +75 -75
  131. package/migrations/20240528063051-create-group-object-privilege-table.js +84 -84
  132. package/migrations/20240528063107-create-user-object-privilege-table.js +83 -83
  133. package/package.json +89 -88
  134. package/sampledotenv +7 -7
  135. package/sonar-project.properties +22 -22
  136. package/src/components/group/group.ts +68 -1
  137. package/src/components/group-system-access/group-system-access.repository.ts +18 -0
  138. package/src/components/system/system.ts +113 -0
  139. package/tsconfig.build.json +5 -5
  140. package/tsconfig.json +22 -22
@@ -8,4 +8,22 @@ export class GroupSystemAccessRepository
8
8
  constructor() {
9
9
  super(GroupSystemAccessModel);
10
10
  }
11
+
12
+ async findAndCountAll(options?: any) {
13
+ try {
14
+ let GroupSystemAccess: any;
15
+ if (options) {
16
+ GroupSystemAccess = await GroupSystemAccessModel.findAndCountAll(
17
+ options,
18
+ );
19
+ } else {
20
+ GroupSystemAccess = await GroupSystemAccessModel.findAndCountAll();
21
+ }
22
+ return GroupSystemAccess;
23
+ } catch (error) {
24
+ throw new Error(
25
+ `An Error occured when retriving GroupSystemAccess: ${error.message}`,
26
+ );
27
+ }
28
+ }
11
29
  }
@@ -6,6 +6,7 @@ import { ApplicationConfig } from '@tomei/config';
6
6
  import { ActionEnum, Activity } from '@tomei/activity-history';
7
7
  import { ISystemSearchAttr } from '../../interfaces/system-search-attr.interface';
8
8
  import { Op } from 'sequelize';
9
+ import { v4 as uuidv4 } from 'uuid';
9
10
 
10
11
  export class System extends ObjectBase {
11
12
  ObjectId: string;
@@ -272,4 +273,116 @@ export class System extends ObjectBase {
272
273
  throw error;
273
274
  }
274
275
  }
276
+
277
+ public static async renewApiKeyAndSecret(
278
+ loginUser: LoginUser,
279
+ dbTransaction: any,
280
+ systemCode: string,
281
+ ) {
282
+ try {
283
+ //Part 1: Privilege Checking
284
+ //Call loginUser.checkPrivilege() method to check if the user has the privilege to renew API Key and Secret.
285
+ const sc = ApplicationConfig.getComponentConfigValue('system-code');
286
+ const isPrivileged = await loginUser.checkPrivileges(sc, 'SYSTEM_UPDATE');
287
+
288
+ if (!isPrivileged) {
289
+ throw new ClassError(
290
+ 'System',
291
+ 'SystemErrMsg06',
292
+ 'You do not have permission to renew API Key and Secret.',
293
+ );
294
+ }
295
+
296
+ //Part 2: Validation
297
+ //Instantiate existing System
298
+ const system = await System.init(dbTransaction, systemCode);
299
+
300
+ //Check if system.AccessURL got value. If not, throw new ClassError
301
+ if (!system.AccessURL) {
302
+ throw new ClassError(
303
+ 'System',
304
+ 'SystemErrMsg07',
305
+ 'AccessURL is required for callback',
306
+ );
307
+ }
308
+
309
+ //Check if system.Status is "Active". If not, throw new ClassError
310
+ if (system.Status !== 'Active') {
311
+ throw new ClassError(
312
+ 'System',
313
+ 'SystemErrMsg08',
314
+ 'Cannot do this operation on inactive system.',
315
+ );
316
+ }
317
+
318
+ //Set EntityValueBefore to system instance.
319
+ const entityValueBefore = {
320
+ SystemCode: system.SystemCode,
321
+ Name: system.Name,
322
+ Description: system.Description,
323
+ AccessURL: system.AccessURL,
324
+ GooglePlayURL: system.GooglePlayURL,
325
+ AppleStoreURL: system.AppleStoreURL,
326
+ APIKey: system.APIKey,
327
+ APISecret: system.APISecret,
328
+ Status: system.Status,
329
+ };
330
+
331
+ //Part 3: Generate API key and secret
332
+ //Use https://www.npmjs.com/package/uuid package to generate both the api key and api secret.
333
+ const apiKey = uuidv4();
334
+ const apiSecret = uuidv4();
335
+
336
+ //Update the system instance with new API key and secret.
337
+ system.APIKey = apiKey;
338
+ system.APISecret = apiSecret;
339
+ system._UpdatedById = loginUser.UserId;
340
+ system._UpdatedAt = new Date();
341
+ //Call System._Repo update() method to update the system record.
342
+ await System._Repo.update(
343
+ {
344
+ APIKey: apiKey,
345
+ APISecret: apiSecret,
346
+ UpdatedById: system._UpdatedById,
347
+ UpdatedAt: system._UpdatedAt,
348
+ },
349
+ {
350
+ where: {
351
+ SystemCode: systemCode,
352
+ },
353
+ transaction: dbTransaction,
354
+ },
355
+ );
356
+
357
+ //Part 4: Record Renew API Key and Secret Activity
358
+ //Set EntityValueAfter to system instance.
359
+ const entityValueAfter = {
360
+ SystemCode: system.SystemCode,
361
+ Name: system.Name,
362
+ Description: system.Description,
363
+ AccessURL: system.AccessURL,
364
+ GooglePlayURL: system.GooglePlayURL,
365
+ AppleStoreURL: system.AppleStoreURL,
366
+ APIKey: system.APIKey,
367
+ APISecret: system.APISecret,
368
+ Status: system.Status,
369
+ };
370
+
371
+ //Instantiate new activity from Activity class, call createId() method, then set the properties.
372
+ const activity = new Activity();
373
+ activity.ActivityId = activity.createId();
374
+ activity.Action = ActionEnum.UPDATE;
375
+ activity.Description = 'Renew API key and secret for a system';
376
+ activity.EntityType = 'System';
377
+ activity.EntityId = system.SystemCode;
378
+ activity.EntityValueBefore = JSON.stringify(entityValueBefore);
379
+ activity.EntityValueAfter = JSON.stringify(entityValueAfter);
380
+
381
+ await activity.create(loginUser.ObjectId, dbTransaction);
382
+ //Return the updated system instance.
383
+ return system;
384
+ } catch (error) {
385
+ throw error;
386
+ }
387
+ }
275
388
  }
@@ -1,6 +1,6 @@
1
- {
2
- "extends": "./tsconfig.json",
3
- "include": ["**/*.ts"],
4
- "exclude": ["node_modules", "__tests__", "dist", "**/*spec.ts"]
5
- }
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "include": ["**/*.ts"],
4
+ "exclude": ["node_modules", "__tests__", "dist", "**/*spec.ts"]
5
+ }
6
6
 
package/tsconfig.json CHANGED
@@ -1,23 +1,23 @@
1
- {
2
- "compilerOptions": {
3
- "module": "commonjs",
4
- "declaration": true,
5
- "removeComments": true,
6
- "emitDecoratorMetadata": true,
7
- "experimentalDecorators": true,
8
- "allowSyntheticDefaultImports": true,
9
- "moduleResolution": "node",
10
- "target": "es6",
11
- "sourceMap": true,
12
- "outDir": "./dist",
13
- "baseUrl": "./src",
14
- "rootDir": "./",
15
- "incremental": true,
16
- "skipLibCheck": true,
17
- "noImplicitAny": false,
18
- "strictBindCallApply": false,
19
- "forceConsistentCasingInFileNames": false,
20
- "noFallthroughCasesInSwitch": false,
21
- "strictNullChecks": false,
22
- },
1
+ {
2
+ "compilerOptions": {
3
+ "module": "commonjs",
4
+ "declaration": true,
5
+ "removeComments": true,
6
+ "emitDecoratorMetadata": true,
7
+ "experimentalDecorators": true,
8
+ "allowSyntheticDefaultImports": true,
9
+ "moduleResolution": "node",
10
+ "target": "es6",
11
+ "sourceMap": true,
12
+ "outDir": "./dist",
13
+ "baseUrl": "./src",
14
+ "rootDir": "./",
15
+ "incremental": true,
16
+ "skipLibCheck": true,
17
+ "noImplicitAny": false,
18
+ "strictBindCallApply": false,
19
+ "forceConsistentCasingInFileNames": false,
20
+ "noFallthroughCasesInSwitch": false,
21
+ "strictNullChecks": false,
22
+ },
23
23
  }