@tomei/sso 0.34.10 → 0.35.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) 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 +1164 -1164
  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.d.ts +0 -0
  106. package/dist/__tests__/unit/components/login-user/login-user.spec.js +6 -0
  107. package/dist/__tests__/unit/components/login-user/login-user.spec.js.map +1 -0
  108. package/dist/__tests__/unit/components/login-user/login.spec.js +0 -661
  109. package/dist/__tests__/unit/components/login-user/login.spec.js.map +1 -1
  110. package/dist/src/components/group/group.js +8 -2
  111. package/dist/src/components/group/group.js.map +1 -1
  112. package/dist/src/components/system/system.d.ts +1 -0
  113. package/dist/src/components/system/system.js +36 -0
  114. package/dist/src/components/system/system.js.map +1 -1
  115. package/dist/src/components/system-privilege/system-privilege.d.ts +1 -0
  116. package/dist/src/components/system-privilege/system-privilege.js +36 -0
  117. package/dist/src/components/system-privilege/system-privilege.js.map +1 -1
  118. package/dist/tsconfig.tsbuildinfo +1 -1
  119. package/jest.config.js +14 -14
  120. package/migrations/20240314080602-create-user-table.js +124 -124
  121. package/migrations/20240314080603-create-user-group-table.js +85 -85
  122. package/migrations/20240314080604-create-user-user-group-table.js +55 -55
  123. package/migrations/20240314080605-create-login-history-table.js +53 -53
  124. package/migrations/20240527064925-create-system-table.js +78 -78
  125. package/migrations/20240527064926-create-system-privilege-table.js +67 -67
  126. package/migrations/20240527065342-create-group-table.js +89 -89
  127. package/migrations/20240527065633-create-group-reporting-user-table.js +76 -76
  128. package/migrations/20240528011551-create-group-system-access-table.js +72 -72
  129. package/migrations/20240528023018-user-system-access-table.js +75 -75
  130. package/migrations/20240528032229-user-privilege-table.js +75 -75
  131. package/migrations/20240528063003-create-group-privilege-table.js +75 -75
  132. package/migrations/20240528063051-create-group-object-privilege-table.js +84 -84
  133. package/migrations/20240528063107-create-user-object-privilege-table.js +83 -83
  134. package/package.json +89 -89
  135. package/sampledotenv +7 -7
  136. package/sonar-project.properties +22 -22
  137. package/src/components/group/group.ts +9 -2
  138. package/src/components/system/system.ts +68 -1
  139. package/src/components/system-privilege/system-privilege.ts +80 -1
  140. package/tsconfig.build.json +5 -5
  141. package/tsconfig.json +22 -22
@@ -2,7 +2,7 @@ import { ClassError, HashTable, ObjectBase } from '@tomei/general';
2
2
  import { SystemRepository } from './system.repository';
3
3
  import { ISystemAttr } from '../../interfaces/system.interface';
4
4
  import { LoginUser } from '../login-user/login-user';
5
- import { ApplicationConfig } from '@tomei/config';
5
+ import { ApplicationConfig, ComponentConfig } 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';
@@ -385,4 +385,71 @@ export class System extends ObjectBase {
385
385
  throw error;
386
386
  }
387
387
  }
388
+
389
+ public static async loadSystem(dbTransaction): Promise<string> {
390
+ try {
391
+ // Part 1: Retrieve System Info
392
+ // Load sso component config.loadComponentConfig Call Config. by passing:
393
+ // filepath: '/component-config/sso-config.json'
394
+ ComponentConfig.loadComponentConfig('/component-config/sso-config.json');
395
+
396
+ const config: {
397
+ name: string;
398
+ code: string;
399
+ description: string;
400
+ userId: string;
401
+ } = ComponentConfig.getComponentConfigValue('@tomei/sso', 'system');
402
+
403
+ // Make sure all required fields are provided in the config file.
404
+ if (
405
+ !config.name ||
406
+ !config.code ||
407
+ !config.description ||
408
+ !config.userId
409
+ ) {
410
+ throw new Error('Missing required fields in the config file.');
411
+ }
412
+
413
+ // Retrieve existing System. Call System._Repo findByPk method by passing:
414
+ // SystemCode: system.code
415
+ // dbTransaction
416
+ const system = await System._Repo.findByPk(config.code, {
417
+ transaction: dbTransaction,
418
+ });
419
+
420
+ // If system already exists, skip all steps below and return "System loaded."
421
+ if (system) {
422
+ return 'System loaded.';
423
+ }
424
+
425
+ //if system not exists. Call System._Repo create method by passing:
426
+ // SystemCode: system.code,
427
+ // Name: system.name
428
+ // Description: system.description,
429
+ // Status: 'Active',
430
+ // CreatedById: system.userId
431
+ // CreatedAt: current date & time
432
+ // UpdatedById: system.userId
433
+ // UpdatedAt: current date & time
434
+ await System._Repo.create(
435
+ {
436
+ SystemCode: config.code,
437
+ Name: config.name,
438
+ Description: config.description,
439
+ Status: 'Active',
440
+ CreatedById: config.userId,
441
+ CreatedAt: new Date(),
442
+ UpdatedById: config.userId,
443
+ UpdatedAt: new Date(),
444
+ },
445
+ {
446
+ transaction: dbTransaction,
447
+ },
448
+ );
449
+ // Return "System loaded."
450
+ return 'System loaded.';
451
+ } catch (error) {
452
+ throw error;
453
+ }
454
+ }
388
455
  }
@@ -3,7 +3,7 @@ import { SystemRepository } from '../system/system.repository';
3
3
  import { SystemPrivilegeRepository } from './system-privilege.repository';
4
4
  import { ISystemPrivilegeAttr } from '../../interfaces/system-privilege.interface';
5
5
  import { LoginUser } from '../login-user/login-user';
6
- import { ApplicationConfig } from '@tomei/config';
6
+ import { ApplicationConfig, ComponentConfig } from '@tomei/config';
7
7
  import { System } from '../system/system';
8
8
  import { ActionEnum, Activity } from '@tomei/activity-history';
9
9
  import { ISystemPrivilegeSearch } from '../../interfaces/system-privilege-search.interface';
@@ -289,4 +289,83 @@ export class SystemPrivilege extends ObjectBase {
289
289
  throw error;
290
290
  }
291
291
  }
292
+
293
+ public static async loadAllPrivileges(
294
+ dbTransaction: any,
295
+ systemCode: string,
296
+ ): Promise<string> {
297
+ try {
298
+ //Instantiate existing System by passing:
299
+ // dbTransaction
300
+ // SystemCode: Params.SystemCode
301
+ await System.init(dbTransaction, systemCode);
302
+
303
+ // Part 2: Load Privileges
304
+ // Load sso component config.loadComponentConfig Call Config. by passing:
305
+ // filepath: '/component-config/sso-config.json'
306
+
307
+ ComponentConfig.loadComponentConfig('/component-config/sso-config.json');
308
+
309
+ // Retrieve privileges array by call Config.getComponentConfigValue by passing:
310
+ // componentName: '@tomei/sso'
311
+ // configKey: 'privileges'
312
+ const privilegesConfig: {
313
+ privilegeCode: string;
314
+ description: string;
315
+ }[] = ComponentConfig.getComponentConfigValue('@tomei/sso', 'privileges');
316
+ // Retrieve system user id. Call Config.getComponentConfigValue by passing:
317
+ // componentName: '@tomei/sso'
318
+ // configKey: 'system'
319
+ const systemConfig: {
320
+ name: string;
321
+ code: string;
322
+ description: string;
323
+ userId: string;
324
+ } = ComponentConfig.getComponentConfigValue('@tomei/sso', 'system');
325
+
326
+ //Set systemUserId to system.userId.
327
+ const systemUserId = systemConfig.userId;
328
+ //Retrieve existing SystemPrivilege. Call SystemPrivilege._Repo findAll method by passing:
329
+ // where:
330
+ // SystemCode: Params.SystemCode
331
+ const existingSystemPrivileges = await this._Repository.findAll({
332
+ where: {
333
+ SystemCode: systemCode,
334
+ },
335
+ transaction: dbTransaction,
336
+ });
337
+
338
+ //Filter out existing privileges with the privileges array above to identify which privileges to be created and map it tobeCreatePrivileges.
339
+ const tobeCreatePrivileges = privilegesConfig.filter(
340
+ (privilegeConfig) =>
341
+ !existingSystemPrivileges.find(
342
+ (existingPrivilege) =>
343
+ existingPrivilege.PrivilegeCode === privilegeConfig.privilegeCode,
344
+ ),
345
+ );
346
+
347
+ //Call SystemPrivilege._Repo create method for each newPrivileges.
348
+ for (const privilegeConfig of tobeCreatePrivileges) {
349
+ await this._Repository.create(
350
+ {
351
+ PrivilegeCode: privilegeConfig.privilegeCode,
352
+ SystemCode: systemCode,
353
+ Description: privilegeConfig.description,
354
+ Status: 'Active',
355
+ CreatedById: parseInt(systemUserId),
356
+ UpdatedById: parseInt(systemUserId),
357
+ CreatedAt: new Date(),
358
+ UpdatedAt: new Date(),
359
+ },
360
+ {
361
+ transaction: dbTransaction,
362
+ },
363
+ );
364
+ }
365
+
366
+ return 'Privileges Loaded';
367
+ } catch (error) {
368
+ throw error;
369
+ }
370
+ }
292
371
  }
@@ -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
  }