@gus-eip/loggers 4.0.0 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,82 +1,82 @@
1
- # @gus-eip/loggers
2
-
3
- ## Overview
4
-
5
- `@gus-eip/loggers` is a package designed to provide logging functionality for your Node.js applications. It offers integration with various logging services, including CloudWatchLogger.
6
-
7
- ## Installation
8
-
9
- You can install the package via npm:
10
-
11
- ```bash
12
- npm install @gus-eip/loggers
13
- ```
14
-
15
- ## Usage
16
-
17
- To use the logger module in your application, follow these steps:
18
-
19
- 1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
20
-
21
- ```javascript
22
- import { LoggerModule } from '@gus-eip/loggers';
23
- ```
24
-
25
- 2. Configure `LoggerModule` in your module by calling the `forRoot` method.
26
-
27
- ```javascript
28
- LoggerModule.forRoot({
29
- region: process.env.REGION,
30
- logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
31
- options: 'CloudWatchLogger',
32
- }),
33
- ```
34
-
35
- Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
36
-
37
- ## Configuration Options
38
-
39
- - `region`: The AWS region where your CloudWatch logs are located.
40
- - `logGroupName`: The name of the log group where logs will be sent.
41
- - `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
42
-
43
- ## Example
44
-
45
- ```javascript
46
- import { Module } from '@nestjs/common';
47
- import { LoggerModule } from '@gus-eip/loggers';
48
-
49
- @Module({
50
- imports: [
51
- LoggerModule.forRoot({
52
- region: process.env.REGION,
53
- logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
54
- options: 'CloudWatchLogger',
55
- }),
56
- ],
57
- })
58
- export class AppModule {}
59
- ```
60
-
61
- ```
62
- This repository requires AWS SSM Parameter Store access to retrieve the SQS URL dynamically. Ensure that the application has permission to read LOGGER_SQS_URL.
63
-
64
- ```
65
-
66
- ## License
67
-
68
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
69
-
70
- ---
71
-
72
- ## OAP-EIP LOGGER
73
-
74
- Whenever a new use case is added in the enum.ts file, make sure to also:
75
-
76
- 1. Add a user-friendly label for it in usecase-mapping.ts.
77
-
78
- 2. Add a new entry in source-destination-mapping.ts with the correct usecase, brand, source, and destination.
79
-
80
- 3. After publishing the updated package, update the dependency in the gus-eip-analytics repository to reflect the latest version.
81
-
1
+ # @gus-eip/loggers
2
+
3
+ ## Overview
4
+
5
+ `@gus-eip/loggers` is a package designed to provide logging functionality for your Node.js applications. It offers integration with various logging services, including CloudWatchLogger.
6
+
7
+ ## Installation
8
+
9
+ You can install the package via npm:
10
+
11
+ ```bash
12
+ npm install @gus-eip/loggers
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ To use the logger module in your application, follow these steps:
18
+
19
+ 1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
20
+
21
+ ```javascript
22
+ import { LoggerModule } from '@gus-eip/loggers';
23
+ ```
24
+
25
+ 2. Configure `LoggerModule` in your module by calling the `forRoot` method.
26
+
27
+ ```javascript
28
+ LoggerModule.forRoot({
29
+ region: process.env.REGION,
30
+ logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
31
+ options: 'CloudWatchLogger',
32
+ }),
33
+ ```
34
+
35
+ Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
36
+
37
+ ## Configuration Options
38
+
39
+ - `region`: The AWS region where your CloudWatch logs are located.
40
+ - `logGroupName`: The name of the log group where logs will be sent.
41
+ - `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
42
+
43
+ ## Example
44
+
45
+ ```javascript
46
+ import { Module } from '@nestjs/common';
47
+ import { LoggerModule } from '@gus-eip/loggers';
48
+
49
+ @Module({
50
+ imports: [
51
+ LoggerModule.forRoot({
52
+ region: process.env.REGION,
53
+ logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
54
+ options: 'CloudWatchLogger',
55
+ }),
56
+ ],
57
+ })
58
+ export class AppModule {}
59
+ ```
60
+
61
+ ```
62
+ This repository requires AWS SSM Parameter Store access to retrieve the SQS URL dynamically. Ensure that the application has permission to read LOGGER_SQS_URL.
63
+
64
+ ```
65
+
66
+ ## License
67
+
68
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
69
+
70
+ ---
71
+
72
+ ## OAP-EIP LOGGER
73
+
74
+ Whenever a new use case is added in the enum.ts file, make sure to also:
75
+
76
+ 1. Add a user-friendly label for it in usecase-mapping.ts.
77
+
78
+ 2. Add a new entry in source-destination-mapping.ts with the correct usecase, brand, source, and destination.
79
+
80
+ 3. After publishing the updated package, update the dependency in the gus-eip-analytics repository to reflect the latest version.
81
+
82
82
  Feel free to customize this README according to your specific package features, usage guidelines, and licensing terms.
package/dist/enum.d.ts CHANGED
@@ -363,6 +363,12 @@ export declare class LoggerEnum {
363
363
  OCR_PROCESS_STARTED: string;
364
364
  OCR_PROCESS_COMPLETED: string;
365
365
  OCR_PROCESS_ERROR: string;
366
+ OPPORTUNITY_BY_APPLICID_INITIATED: string;
367
+ OPPORTUNITY_BY_APPLICID_COMPLETED: string;
368
+ OPPORTUNITY_BY_APPLICID_FAILED: string;
369
+ CASE_MANAGEMENT: string;
370
+ GET_SF_RECORD_BY_OBJECT: string;
371
+ UPDATE_CASE_RECORD: string;
366
372
  };
367
373
  UseCase: {
368
374
  PROGRAM_INFO: string;
@@ -454,6 +460,16 @@ export declare class LoggerEnum {
454
460
  GUS_WITHDRAW_APPLICATION: string;
455
461
  STUDENT_OAP_LEAD_OWNER_ASSIGNMENT: string;
456
462
  UEG_DEPOSIT_CONFIRMED: string;
463
+ ULAW_ACCEPTED_STAGE: string;
464
+ ULAW_ADMISSION_STAGE: string;
465
+ ULAW_CLOSED_LOST_STAGE: string;
466
+ ULAW_ENROLMENT_STAGE: string;
467
+ ULAW_NEED_CLARIFICATION: string;
468
+ ULAW_NEW_LEAD: string;
469
+ ULAW_OFFER_STAGE: string;
470
+ ULAW_PAYMENT_STAGE: string;
471
+ ULAW_NEW_APPLICATION: string;
472
+ CHATBOT_CHAT_CLOSED: string;
457
473
  };
458
474
  Component: {
459
475
  OAP_FRONTEND: string;
@@ -507,5 +523,11 @@ export declare class LoggerEnum {
507
523
  GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_HANDLER: string;
508
524
  GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_QUEUE: string;
509
525
  OCR: string;
526
+ ULAW_GUS_SALESFORCE_INTEGRATION_QUEUE: string;
527
+ ULAW_GUS_SALESFORCE_INTEGRATION_HANDLER: string;
528
+ GUS_SALESFORCE_ULAW_INTEGRATION_QUEUE: string;
529
+ GUS_SALESFORCE_ULAW_INTEGRATION_HANDLER: string;
530
+ APPHERO_CHATBOT_CASE_HANDLER: string;
531
+ APPHERO_CHATBOT_CASE_REQUEST_QUEUE: string;
510
532
  };
511
533
  }
package/dist/enum.js CHANGED
@@ -373,7 +373,13 @@ let LoggerEnum = class LoggerEnum {
373
373
  GET_OCR_RESULTS: 'GET_OCR_RESULTS',
374
374
  OCR_PROCESS_STARTED: 'OCR_PROCESS_STARTED',
375
375
  OCR_PROCESS_COMPLETED: 'OCR_PROCESS_COMPLETED',
376
- OCR_PROCESS_ERROR: 'OCR_PROCESS_ERROR'
376
+ OCR_PROCESS_ERROR: 'OCR_PROCESS_ERROR',
377
+ OPPORTUNITY_BY_APPLICID_INITIATED: 'OPPORTUNITY_BY_APPLICID_INITIATED',
378
+ OPPORTUNITY_BY_APPLICID_COMPLETED: 'OPPORTUNITY_BY_APPLICID_COMPLETED',
379
+ OPPORTUNITY_BY_APPLICID_FAILED: 'OPPORTUNITY_BY_APPLICID_FAILED',
380
+ CASE_MANAGEMENT: 'CASE_MANAGEMENT',
381
+ GET_SF_RECORD_BY_OBJECT: 'GET_SF_RECORD_BY_OBJECT',
382
+ UPDATE_CASE_RECORD: 'UPDATE_CASE_RECORD',
377
383
  };
378
384
  this.UseCase = {
379
385
  PROGRAM_INFO: 'SAVE_PROGRAMME_DETAILS',
@@ -465,6 +471,16 @@ let LoggerEnum = class LoggerEnum {
465
471
  GUS_WITHDRAW_APPLICATION: 'GUS_WITHDRAW_APPLICATION',
466
472
  STUDENT_OAP_LEAD_OWNER_ASSIGNMENT: 'STUDENT_OAP_LEAD_OWNER_ASSIGNMENT',
467
473
  UEG_DEPOSIT_CONFIRMED: 'UEG_DEPOSIT_CONFIRMED',
474
+ ULAW_ACCEPTED_STAGE: 'ULAW_ACCEPTED_STAGE',
475
+ ULAW_ADMISSION_STAGE: 'ULAW_ADMISSION_STAGE',
476
+ ULAW_CLOSED_LOST_STAGE: 'ULAW_CLOSED_LOST_STAGE',
477
+ ULAW_ENROLMENT_STAGE: 'ULAW_ENROLMENT_STAGE',
478
+ ULAW_NEED_CLARIFICATION: 'ULAW_NEED_CLARIFICATION',
479
+ ULAW_NEW_LEAD: 'ULAW_NEW_LEAD',
480
+ ULAW_OFFER_STAGE: 'ULAW_OFFER_STAGE',
481
+ ULAW_PAYMENT_STAGE: 'ULAW_PAYMENT_STAGE',
482
+ ULAW_NEW_APPLICATION: 'ULAW_NEW_APPLICATION',
483
+ CHATBOT_CHAT_CLOSED: 'CHATBOT_CHAT_CLOSED',
468
484
  };
469
485
  this.Component = {
470
486
  OAP_FRONTEND: 'OAP-FRONTEND',
@@ -517,7 +533,13 @@ let LoggerEnum = class LoggerEnum {
517
533
  UE_CAMPUSNET: 'UE_CAMPUSNET',
518
534
  GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_HANDLER: 'GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_HANDLER',
519
535
  GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_QUEUE: 'GUS_SALESFORCE_UE_CAMPUSNET_INTEGRATION_QUEUE',
520
- OCR: 'OCR'
536
+ OCR: 'OCR',
537
+ ULAW_GUS_SALESFORCE_INTEGRATION_QUEUE: 'ULAW_GUS_SALESFORCE_INTEGRATION_QUEUE',
538
+ ULAW_GUS_SALESFORCE_INTEGRATION_HANDLER: 'ULAW_GUS_SALESFORCE_INTEGRATION_HANDLER',
539
+ GUS_SALESFORCE_ULAW_INTEGRATION_QUEUE: 'GUS_SALESFORCE_ULAW_INTEGRATION_QUEUE',
540
+ GUS_SALESFORCE_ULAW_INTEGRATION_HANDLER: 'GUS_SALESFORCE_ULAW_INTEGRATION_HANDLER',
541
+ APPHERO_CHATBOT_CASE_HANDLER: 'APPHERO_CHATBOT_CASE_HANDLER',
542
+ APPHERO_CHATBOT_CASE_REQUEST_QUEUE: 'APPHERO_CHATBOT_CASE_REQUEST_QUEUE',
521
543
  };
522
544
  }
523
545
  };
@@ -291,7 +291,7 @@ exports.BRAND_USECASE_MAPPING = [
291
291
  destination: 'MYUCW',
292
292
  },
293
293
  {
294
- brands: ['UCW',],
294
+ brands: ['UCW'],
295
295
  usecase: 'GUS_WITHDRAW_APPLICATION',
296
296
  source: 'GUS Salesforce',
297
297
  destination: 'MYUCW',
@@ -493,5 +493,59 @@ exports.BRAND_USECASE_MAPPING = [
493
493
  usecase: 'UEG_DEPOSIT_CONFIRMED',
494
494
  source: 'UE Campusnet',
495
495
  destination: 'GUS Salesforce',
496
- }
496
+ },
497
+ {
498
+ brands: ['ULAW'],
499
+ usecase: 'ULAW_NEW_APPLICATION',
500
+ source: 'ULAW DCRM',
501
+ destination: 'GUS Salesforce',
502
+ },
503
+ {
504
+ brands: ['ULAW'],
505
+ usecase: 'ULAW_NEW_LEAD',
506
+ source: 'ULAW DCRM',
507
+ destination: 'GUS Salesforce',
508
+ },
509
+ {
510
+ brands: ['ULAW'],
511
+ usecase: 'ULAW_NEED_CLARIFICATION',
512
+ source: 'ULAW DCRM',
513
+ destination: 'GUS Salesforce',
514
+ },
515
+ {
516
+ brands: ['ULAW'],
517
+ usecase: 'ULAW_OFFER_STAGE',
518
+ source: 'ULAW DCRM',
519
+ destination: 'GUS Salesforce',
520
+ },
521
+ {
522
+ brands: ['ULAW'],
523
+ usecase: 'ULAW_PAYMENT_STAGE',
524
+ source: 'ULAW DCRM',
525
+ destination: 'GUS Salesforce',
526
+ },
527
+ {
528
+ brands: ['ULAW'],
529
+ usecase: 'ULAW_ENROLMENT_STAGE',
530
+ source: 'ULAW DCRM',
531
+ destination: 'GUS Salesforce',
532
+ },
533
+ {
534
+ brands: ['ULAW'],
535
+ usecase: 'ULAW_ADMISSION_STAGE',
536
+ source: 'ULAW DCRM',
537
+ destination: 'GUS Salesforce',
538
+ },
539
+ {
540
+ brands: ['ULAW'],
541
+ usecase: 'ULAW_ACCEPTED_STAGE',
542
+ source: 'ULAW DCRM',
543
+ destination: 'GUS Salesforce',
544
+ },
545
+ {
546
+ brands: ['ULAW'],
547
+ usecase: 'ULAW_CLOSED_LOST_STAGE',
548
+ source: 'ULAW DCRM',
549
+ destination: 'GUS Salesforce',
550
+ },
497
551
  ];
@@ -69,5 +69,14 @@ export declare enum UsecaseMapping {
69
69
  GUS_DOCUMENT_UPLOAD = "Gus document upload",
70
70
  GUS_WITHDRAW_APPLICATION = "Withdraw application",
71
71
  STUDENT_OAP_LEAD_OWNER_ASSIGNMENT = "Student OAP lead owner assignment",
72
- UEG_DEPOSIT_CONFIRMED = "Deposit confirmed"
72
+ UEG_DEPOSIT_CONFIRMED = "Deposit confirmed",
73
+ ULAW_ACCEPTED_STAGE = "Admission Accepted",
74
+ ULAW_ADMISSION_STAGE = "Admission Stage Updated",
75
+ ULAW_CLOSED_LOST_STAGE = "Application Closed",
76
+ ULAW_ENROLMENT_STAGE = "Enrollment Confirmed",
77
+ ULAW_NEED_CLARIFICATION = "Additional Information Requested",
78
+ ULAW_NEW_LEAD = "New Lead Created",
79
+ ULAW_OFFER_STAGE = "Offer Issued",
80
+ ULAW_PAYMENT_STAGE = "Payment Processed",
81
+ ULAW_NEW_APPLICATION = "New Application Submitted"
73
82
  }
@@ -74,4 +74,13 @@ var UsecaseMapping;
74
74
  UsecaseMapping["GUS_WITHDRAW_APPLICATION"] = "Withdraw application";
75
75
  UsecaseMapping["STUDENT_OAP_LEAD_OWNER_ASSIGNMENT"] = "Student OAP lead owner assignment";
76
76
  UsecaseMapping["UEG_DEPOSIT_CONFIRMED"] = "Deposit confirmed";
77
+ UsecaseMapping["ULAW_ACCEPTED_STAGE"] = "Admission Accepted";
78
+ UsecaseMapping["ULAW_ADMISSION_STAGE"] = "Admission Stage Updated";
79
+ UsecaseMapping["ULAW_CLOSED_LOST_STAGE"] = "Application Closed";
80
+ UsecaseMapping["ULAW_ENROLMENT_STAGE"] = "Enrollment Confirmed";
81
+ UsecaseMapping["ULAW_NEED_CLARIFICATION"] = "Additional Information Requested";
82
+ UsecaseMapping["ULAW_NEW_LEAD"] = "New Lead Created";
83
+ UsecaseMapping["ULAW_OFFER_STAGE"] = "Offer Issued";
84
+ UsecaseMapping["ULAW_PAYMENT_STAGE"] = "Payment Processed";
85
+ UsecaseMapping["ULAW_NEW_APPLICATION"] = "New Application Submitted";
77
86
  })(UsecaseMapping || (exports.UsecaseMapping = UsecaseMapping = {}));
package/package.json CHANGED
@@ -1,79 +1,79 @@
1
- {
2
- "name": "@gus-eip/loggers",
3
- "version": "4.0.0",
4
- "description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
5
- "author": "gus",
6
- "readmeFilename": "README.md",
7
- "main": "dist/index.js",
8
- "files": [
9
- "dist/**/*",
10
- "*.md"
11
- ],
12
- "scripts": {
13
- "start:dev": "tsc -w",
14
- "build": "tsc",
15
- "prepare": "npm run build",
16
- "format": "prettier --write \"src/**/*.ts\"",
17
- "lint": "tslint -p tsconfig.json -c tslint.json",
18
- "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
19
- "test:watch": "jest --watch",
20
- "test:cov": "jest --coverage",
21
- "test:e2e": "jest --config ./test/jest-e2e.json"
22
- },
23
- "keywords": [
24
- "nestjs",
25
- "nodejs",
26
- "javascript",
27
- "typescript",
28
- "eip-loggers"
29
- ],
30
- "publishConfig": {
31
- "access": "public"
32
- },
33
- "dependencies": {
34
- "@aws-sdk/client-ssm": "^3.759.0",
35
- "aws-sdk": "^2.1590.0",
36
- "axios": "^1.7.4"
37
- },
38
- "devDependencies": {
39
- "@nestjs/common": "^10.0.2",
40
- "@nestjs/core": "^10.0.2",
41
- "@nestjs/platform-express": "^10.0.2",
42
- "@nestjs/testing": "10.0.2",
43
- "@types/express": "4.17.17",
44
- "@types/jest": "29.5.2",
45
- "@types/lodash": "^4.17.7",
46
- "@types/node": "20.3.1",
47
- "@types/supertest": "2.0.12",
48
- "@typescript-eslint/eslint-plugin": "^5.60.0",
49
- "@typescript-eslint/parser": "^5.60.0",
50
- "eslint": "^8.43.0",
51
- "eslint-config-prettier": "^8.8.0",
52
- "eslint-plugin-prettier": "^4.2.1",
53
- "jest": "29.5.0",
54
- "prettier": "2.8.8",
55
- "reflect-metadata": "^0.1.13",
56
- "rxjs": "^7.8.1",
57
- "supertest": "6.3.3",
58
- "ts-jest": "29.1.0",
59
- "ts-node": "10.9.1",
60
- "tsc-watch": "6.0.4",
61
- "tsconfig-paths": "4.2.0",
62
- "tslint": "5.20.1",
63
- "typescript": "^5.5.4"
64
- },
65
- "jest": {
66
- "moduleFileExtensions": [
67
- "js",
68
- "json",
69
- "ts"
70
- ],
71
- "rootDir": "src",
72
- "testRegex": ".spec.ts$",
73
- "transform": {
74
- "^.+\\.(t|j)s$": "ts-jest"
75
- },
76
- "coverageDirectory": "../coverage",
77
- "testEnvironment": "node"
78
- }
79
- }
1
+ {
2
+ "name": "@gus-eip/loggers",
3
+ "version": "4.0.2",
4
+ "description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
5
+ "author": "gus",
6
+ "readmeFilename": "README.md",
7
+ "main": "dist/index.js",
8
+ "files": [
9
+ "dist/**/*",
10
+ "*.md"
11
+ ],
12
+ "scripts": {
13
+ "start:dev": "tsc -w",
14
+ "build": "tsc",
15
+ "prepare": "npm run build",
16
+ "format": "prettier --write \"src/**/*.ts\"",
17
+ "lint": "tslint -p tsconfig.json -c tslint.json",
18
+ "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
19
+ "test:watch": "jest --watch",
20
+ "test:cov": "jest --coverage",
21
+ "test:e2e": "jest --config ./test/jest-e2e.json"
22
+ },
23
+ "keywords": [
24
+ "nestjs",
25
+ "nodejs",
26
+ "javascript",
27
+ "typescript",
28
+ "eip-loggers"
29
+ ],
30
+ "publishConfig": {
31
+ "access": "public"
32
+ },
33
+ "dependencies": {
34
+ "@aws-sdk/client-ssm": "^3.759.0",
35
+ "aws-sdk": "^2.1590.0",
36
+ "axios": "^1.7.4"
37
+ },
38
+ "devDependencies": {
39
+ "@nestjs/common": "^10.0.2",
40
+ "@nestjs/core": "^10.0.2",
41
+ "@nestjs/platform-express": "^10.0.2",
42
+ "@nestjs/testing": "10.0.2",
43
+ "@types/express": "4.17.17",
44
+ "@types/jest": "29.5.2",
45
+ "@types/lodash": "^4.17.7",
46
+ "@types/node": "20.3.1",
47
+ "@types/supertest": "2.0.12",
48
+ "@typescript-eslint/eslint-plugin": "^5.60.0",
49
+ "@typescript-eslint/parser": "^5.60.0",
50
+ "eslint": "^8.43.0",
51
+ "eslint-config-prettier": "^8.8.0",
52
+ "eslint-plugin-prettier": "^4.2.1",
53
+ "jest": "29.5.0",
54
+ "prettier": "2.8.8",
55
+ "reflect-metadata": "^0.1.13",
56
+ "rxjs": "^7.8.1",
57
+ "supertest": "6.3.3",
58
+ "ts-jest": "29.1.0",
59
+ "ts-node": "10.9.1",
60
+ "tsc-watch": "6.0.4",
61
+ "tsconfig-paths": "4.2.0",
62
+ "tslint": "5.20.1",
63
+ "typescript": "^5.5.4"
64
+ },
65
+ "jest": {
66
+ "moduleFileExtensions": [
67
+ "js",
68
+ "json",
69
+ "ts"
70
+ ],
71
+ "rootDir": "src",
72
+ "testRegex": ".spec.ts$",
73
+ "transform": {
74
+ "^.+\\.(t|j)s$": "ts-jest"
75
+ },
76
+ "coverageDirectory": "../coverage",
77
+ "testEnvironment": "node"
78
+ }
79
+ }