@tomei/sso 0.31.6 → 0.32.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.commitlintrc.json +22 -22
- package/.eslintrc +16 -16
- package/.eslintrc.js +35 -35
- package/.gitlab-ci.yml +16 -16
- package/.husky/commit-msg +15 -15
- package/.husky/pre-commit +7 -7
- package/.prettierrc +4 -4
- package/Jenkinsfile +57 -57
- package/README.md +23 -23
- package/__tests__/unit/components/group/group.spec.ts +79 -79
- package/__tests__/unit/components/group-object-privilege/group-object-privilege.spec.ts +88 -88
- package/__tests__/unit/components/group-privilege/group-privilege.spec.ts +68 -68
- package/__tests__/unit/components/group-reporting-user/group-reporting-user.spec.ts +66 -66
- package/__tests__/unit/components/group-system-access/group-system-access.spec.ts +83 -83
- package/__tests__/unit/components/login-user/l.spec.ts +746 -746
- package/__tests__/unit/components/login-user/login.spec.ts +1064 -1064
- package/__tests__/unit/components/password-hash/password-hash.service.spec.ts +31 -31
- package/__tests__/unit/components/system/system.spec.ts +254 -254
- package/__tests__/unit/components/system-privilege/system-privilege.spec.ts +83 -83
- package/__tests__/unit/components/user-group/user-group.spec.ts +86 -86
- package/__tests__/unit/components/user-object-privilege/user-object-privilege.spec.ts +78 -78
- package/__tests__/unit/components/user-privilege/user-privilege.spec.ts +72 -72
- package/__tests__/unit/components/user-system-access/user-system-access.spec.ts +89 -89
- package/__tests__/unit/redis-client/redis.service.spec.ts +23 -23
- package/__tests__/unit/session/session.service.spec.ts +47 -47
- package/__tests__/unit/system-privilege/system-privilage.spec.ts +91 -91
- package/coverage/clover.xml +1452 -1452
- package/coverage/coverage-final.json +47 -47
- package/coverage/lcov-report/base.css +224 -224
- package/coverage/lcov-report/block-navigation.js +87 -87
- package/coverage/lcov-report/components/group/group.repository.ts.html +117 -117
- package/coverage/lcov-report/components/group/group.ts.html +327 -327
- package/coverage/lcov-report/components/group/index.html +130 -130
- package/coverage/lcov-report/components/group-object-privilege/group-object-privilege.repository.ts.html +117 -117
- package/coverage/lcov-report/components/group-object-privilege/group-object-privilege.ts.html +321 -321
- package/coverage/lcov-report/components/group-object-privilege/index.html +130 -130
- package/coverage/lcov-report/components/group-privilege/group-privilege.repository.ts.html +117 -117
- package/coverage/lcov-report/components/group-privilege/group-privilege.ts.html +303 -303
- package/coverage/lcov-report/components/group-privilege/index.html +130 -130
- package/coverage/lcov-report/components/group-reporting-user/group-reporting-user.repository.ts.html +117 -117
- package/coverage/lcov-report/components/group-reporting-user/group-reporting-user.ts.html +327 -327
- package/coverage/lcov-report/components/group-reporting-user/index.html +130 -130
- package/coverage/lcov-report/components/group-system-access/group-system-access.repository.ts.html +117 -117
- package/coverage/lcov-report/components/group-system-access/group-system-access.ts.html +309 -309
- package/coverage/lcov-report/components/group-system-access/index.html +130 -130
- package/coverage/lcov-report/components/login-history/index.html +115 -115
- package/coverage/lcov-report/components/login-history/login-history.repository.ts.html +117 -117
- package/coverage/lcov-report/components/login-user/index.html +130 -130
- package/coverage/lcov-report/components/login-user/login-user.ts.html +5007 -5007
- package/coverage/lcov-report/components/login-user/user.repository.ts.html +117 -117
- package/coverage/lcov-report/components/password-hash/index.html +115 -115
- package/coverage/lcov-report/components/password-hash/password-hash.service.ts.html +126 -126
- package/coverage/lcov-report/components/system/index.html +130 -130
- package/coverage/lcov-report/components/system/system.repository.ts.html +117 -117
- package/coverage/lcov-report/components/system/system.ts.html +909 -909
- package/coverage/lcov-report/components/system-privilege/index.html +130 -130
- package/coverage/lcov-report/components/system-privilege/system-privilege.repository.ts.html +120 -120
- package/coverage/lcov-report/components/system-privilege/system-privilege.ts.html +390 -390
- package/coverage/lcov-report/components/user-group/index.html +130 -130
- package/coverage/lcov-report/components/user-group/user-group.repository.ts.html +117 -117
- package/coverage/lcov-report/components/user-group/user-group.ts.html +354 -354
- package/coverage/lcov-report/components/user-object-privilege/index.html +130 -130
- package/coverage/lcov-report/components/user-object-privilege/user-object-privilege.repository.ts.html +117 -117
- package/coverage/lcov-report/components/user-object-privilege/user-object-privilege.ts.html +312 -312
- package/coverage/lcov-report/components/user-privilege/index.html +130 -130
- package/coverage/lcov-report/components/user-privilege/user-privilege.repository.ts.html +117 -117
- package/coverage/lcov-report/components/user-privilege/user-privilege.ts.html +306 -306
- package/coverage/lcov-report/components/user-system-access/index.html +130 -130
- package/coverage/lcov-report/components/user-system-access/user-system-access.repository.ts.html +117 -117
- package/coverage/lcov-report/components/user-system-access/user-system-access.ts.html +312 -312
- package/coverage/lcov-report/enum/group-type.enum.ts.html +108 -108
- package/coverage/lcov-report/enum/index.html +160 -160
- package/coverage/lcov-report/enum/index.ts.html +93 -93
- package/coverage/lcov-report/enum/user-status.enum.ts.html +105 -105
- package/coverage/lcov-report/enum/yn.enum.ts.html +96 -96
- package/coverage/lcov-report/index.html +370 -370
- package/coverage/lcov-report/models/group-object-privilege.entity.ts.html +333 -333
- package/coverage/lcov-report/models/group-privilege.entity.ts.html +315 -315
- package/coverage/lcov-report/models/group-reporting-user.entity.ts.html +339 -339
- package/coverage/lcov-report/models/group-system-access.entity.ts.html +324 -324
- package/coverage/lcov-report/models/group.entity.ts.html +435 -435
- package/coverage/lcov-report/models/index.html +310 -310
- package/coverage/lcov-report/models/login-history.entity.ts.html +252 -252
- package/coverage/lcov-report/models/staff.entity.ts.html +411 -411
- package/coverage/lcov-report/models/system-privilege.entity.ts.html +354 -354
- package/coverage/lcov-report/models/system.entity.ts.html +423 -423
- package/coverage/lcov-report/models/user-group.entity.ts.html +354 -354
- package/coverage/lcov-report/models/user-object-privilege.entity.ts.html +330 -330
- package/coverage/lcov-report/models/user-privilege.entity.ts.html +315 -315
- package/coverage/lcov-report/models/user-system-access.entity.ts.html +315 -315
- package/coverage/lcov-report/models/user.entity.ts.html +522 -522
- package/coverage/lcov-report/prettify.css +1 -1
- package/coverage/lcov-report/prettify.js +2 -2
- package/coverage/lcov-report/redis-client/index.html +115 -115
- package/coverage/lcov-report/redis-client/redis.service.ts.html +240 -240
- package/coverage/lcov-report/session/index.html +115 -115
- package/coverage/lcov-report/session/session.service.ts.html +246 -246
- package/coverage/lcov-report/sorter.js +196 -196
- package/coverage/lcov.info +2490 -2490
- package/coverage/test-report.xml +128 -128
- package/create-sso-user.sql +39 -39
- package/dist/__tests__/unit/components/group-privilege/group-privilege.test.d.ts +1 -0
- package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js +71 -0
- package/dist/__tests__/unit/components/group-privilege/group-privilege.test.js.map +1 -0
- package/dist/__tests__/unit/components/login-user/login-user.spec.d.ts +0 -0
- package/dist/__tests__/unit/components/login-user/login-user.spec.js +6 -0
- package/dist/__tests__/unit/components/login-user/login-user.spec.js.map +1 -0
- package/dist/src/components/login-user/login-user.d.ts +1 -1
- package/dist/src/components/system/system.d.ts +1 -0
- package/dist/src/components/system/system.js +71 -0
- package/dist/src/components/system/system.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/jest.config.js +14 -14
- package/migrations/20240314080602-create-user-table.js +108 -108
- package/migrations/20240314080603-create-user-group-table.js +85 -85
- package/migrations/20240314080604-create-user-user-group-table.js +55 -55
- package/migrations/20240314080605-create-login-history-table.js +53 -53
- package/migrations/20240527064925-create-system-table.js +78 -78
- package/migrations/20240527064926-create-system-privilege-table.js +67 -67
- package/migrations/20240527065342-create-group-table.js +89 -89
- package/migrations/20240527065633-create-group-reporting-user-table.js +76 -76
- package/migrations/20240528011551-create-group-system-access-table.js +72 -72
- package/migrations/20240528023018-user-system-access-table.js +75 -75
- package/migrations/20240528032229-user-privilege-table.js +75 -75
- package/migrations/20240528063003-create-group-privilege-table.js +75 -75
- package/migrations/20240528063051-create-group-object-privilege-table.js +84 -84
- package/migrations/20240528063107-create-user-object-privilege-table.js +83 -83
- package/package.json +89 -88
- package/sampledotenv +7 -7
- package/sonar-project.properties +22 -22
- package/src/components/system/system.ts +113 -0
- package/tsconfig.build.json +5 -5
- package/tsconfig.json +22 -22
@@ -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
|
}
|
package/tsconfig.build.json
CHANGED
@@ -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
|
}
|