@gus-eip/loggers 4.1.2 → 4.1.3

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.
Files changed (7) hide show
  1. package/README.md +81 -81
  2. package/dist/enum.d.ts +11 -0
  3. package/dist/enum.js +12 -1
  4. package/dist/mappings/source-destination-mapping.js +60 -6
  5. package/dist/mappings/usecase-mapping.d.ts +4 -1
  6. package/dist/mappings/usecase-mapping.js +3 -0
  7. package/package.json +79 -79
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
@@ -464,6 +464,7 @@ export declare class LoggerEnum {
464
464
  ENROLLMENT_AGREEMENT_INFO: string;
465
465
  TERMS_AND_CONDITION: string;
466
466
  REVIEW_AND_SUBMIT: string;
467
+ REVIEW: string;
467
468
  COURSE_SELECTION: string;
468
469
  EDUCATION_HISTORY: string;
469
470
  STANDARDIZED_TESTS: string;
@@ -558,6 +559,16 @@ export declare class LoggerEnum {
558
559
  VISA_STATUS_UPDATE: string;
559
560
  CLOSED_LOST_STAGE: string;
560
561
  ENROLMENT_STAGE: string;
562
+ INSTRUCTIONS: string;
563
+ PERSONAL_BACKGROUND: string;
564
+ ADDITIONAL_APPLICANT_INFO: string;
565
+ ACADEMIC_HISTORY: string;
566
+ ENGLISH_PROFICIENCY: string;
567
+ EXPERIENCE: string;
568
+ APPLICATION_MATERIALS: string;
569
+ AWARDS_AND_HONORS: string;
570
+ ADDITIONAL_INFORMATION: string;
571
+ DISCLOSURES: string;
561
572
  };
562
573
  Component: {
563
574
  OAP_FRONTEND: string;
package/dist/enum.js CHANGED
@@ -475,6 +475,7 @@ let LoggerEnum = class LoggerEnum {
475
475
  ENROLLMENT_AGREEMENT_INFO: 'SAVE_ENROLLMENT_AGREEMENT_INFO',
476
476
  TERMS_AND_CONDITION: 'SAVE_TERMS_AND_CONDITIONS',
477
477
  REVIEW_AND_SUBMIT: 'SUBMIT_APPLICATION',
478
+ REVIEW: 'SUBMIT_APPLICATION',
478
479
  COURSE_SELECTION: 'SAVE_COURSE_SELECTION_DETAILS',
479
480
  EDUCATION_HISTORY: 'SAVE_EDUCATION_HISTORY_DETAILS',
480
481
  STANDARDIZED_TESTS: 'SAVE_STANDARDIZED_TESTS_DETAILS',
@@ -568,7 +569,17 @@ let LoggerEnum = class LoggerEnum {
568
569
  REJECT_DOCUMENT: 'REJECT_DOCUMENT',
569
570
  VISA_STATUS_UPDATE: 'VISA_STATUS_UPDATE',
570
571
  CLOSED_LOST_STAGE: 'CLOSED_LOST_STAGE',
571
- ENROLMENT_STAGE: 'ENROLMENT_STAGE'
572
+ ENROLMENT_STAGE: 'ENROLMENT_STAGE',
573
+ INSTRUCTIONS: 'SAVE_INSTRUCTIONS',
574
+ PERSONAL_BACKGROUND: 'SAVE_PERSONAL_BACKGROUND',
575
+ ADDITIONAL_APPLICANT_INFO: 'SAVE_ADDITIONAL_APPLICANT_INFO',
576
+ ACADEMIC_HISTORY: 'SAVE_ACADEMIC_HISTORY',
577
+ ENGLISH_PROFICIENCY: 'SAVE_ENGLISH_PROFICIENCY',
578
+ EXPERIENCE: 'SAVE_EXPERIENCE',
579
+ APPLICATION_MATERIALS: 'SAVE_APPLICATION_MATERIALS',
580
+ AWARDS_AND_HONORS: 'SAVE_AWARDS_AND_HONORS',
581
+ ADDITIONAL_INFORMATION: 'SAVE_ADDITIONAL_INFORMATION',
582
+ DISCLOSURES: 'SAVE_DISCLOSURES'
572
583
  };
573
584
  this.Component = {
574
585
  OAP_FRONTEND: 'OAP-FRONTEND',
package/dist/mappings/source-destination-mapping.js CHANGED
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.BRAND_USECASE_MAPPING = void 0;
4
4
  exports.BRAND_USECASE_MAPPING = [
5
5
  {
6
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UEG', 'UCW', 'UNFC'],
6
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UEG', 'UCW', 'UNFC', 'WUL'],
7
7
  usecase: 'SAVE_BASIC_DETAILS',
8
8
  source: 'OAP',
9
9
  destination: 'GUS Salesforce',
@@ -21,7 +21,7 @@ exports.BRAND_USECASE_MAPPING = [
21
21
  destination: 'GUS Salesforce',
22
22
  },
23
23
  {
24
- brands: ['LIM College', 'HZU', 'IBAT', 'UEG'],
24
+ brands: ['LIM College', 'HZU', 'IBAT', 'UEG', 'WUL'],
25
25
  usecase: 'SAVE_ADDITIONAL_INFORMATION',
26
26
  source: 'OAP',
27
27
  destination: 'GUS Salesforce',
@@ -51,19 +51,19 @@ exports.BRAND_USECASE_MAPPING = [
51
51
  destination: 'GUS Salesforce',
52
52
  },
53
53
  {
54
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW'],
54
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW', 'WUL'],
55
55
  usecase: 'SUBMIT_APPLICATION',
56
56
  source: 'OAP',
57
57
  destination: 'GUS Salesforce',
58
58
  },
59
59
  {
60
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG'],
60
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'WUL'],
61
61
  usecase: 'UPLOAD_DOCUMENT',
62
62
  source: 'OAP',
63
63
  destination: 'GUS Salesforce',
64
64
  },
65
65
  {
66
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG'],
66
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'WUL'],
67
67
  usecase: 'GUS_SALESFORCE_OPERATION',
68
68
  source: 'OAP',
69
69
  destination: 'GUS Salesforce',
@@ -105,7 +105,7 @@ exports.BRAND_USECASE_MAPPING = [
105
105
  destination: 'GUS Salesforce',
106
106
  },
107
107
  {
108
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW'],
108
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW', 'WUL'],
109
109
  usecase: 'SAVE_PROGRAMME_DETAILS',
110
110
  source: 'OAP',
111
111
  destination: 'GUS Salesforce',
@@ -614,4 +614,58 @@ exports.BRAND_USECASE_MAPPING = [
614
614
  source: 'Arden DCRM',
615
615
  destination: 'GUS Salesforce',
616
616
  },
617
+ {
618
+ brands: ['WUL'],
619
+ usecase: 'SAVE_INSTRUCTIONS',
620
+ source: 'OAP',
621
+ destination: 'GUS Salesforce',
622
+ },
623
+ {
624
+ brands: ['WUL'],
625
+ usecase: 'SAVE_PERSONAL_BACKGROUND',
626
+ source: 'OAP',
627
+ destination: 'GUS Salesforce',
628
+ },
629
+ {
630
+ brands: ['WUL'],
631
+ usecase: 'SAVE_ADDITIONAL_APPLICANT_INFO',
632
+ source: 'OAP',
633
+ destination: 'GUS Salesforce',
634
+ },
635
+ {
636
+ brands: ['WUL'],
637
+ usecase: 'SAVE_ACADEMIC_HISTORY',
638
+ source: 'OAP',
639
+ destination: 'GUS Salesforce',
640
+ },
641
+ {
642
+ brands: ['WUL'],
643
+ usecase: 'SAVE_ENGLISH_PROFICIENCY',
644
+ source: 'OAP',
645
+ destination: 'GUS Salesforce',
646
+ },
647
+ {
648
+ brands: ['WUL'],
649
+ usecase: 'SAVE_EXPERIENCE',
650
+ source: 'OAP',
651
+ destination: 'GUS Salesforce',
652
+ },
653
+ {
654
+ brands: ['WUL'],
655
+ usecase: 'SAVE_APPLICATION_MATERIALS',
656
+ source: 'OAP',
657
+ destination: 'GUS Salesforce',
658
+ },
659
+ {
660
+ brands: ['WUL'],
661
+ usecase: 'SAVE_AWARDS_AND_HONORS',
662
+ source: 'OAP',
663
+ destination: 'GUS Salesforce',
664
+ },
665
+ {
666
+ brands: ['WUL'],
667
+ usecase: 'SAVE_DISCLOSURES',
668
+ source: 'OAP',
669
+ destination: 'GUS Salesforce',
670
+ }
617
671
  ];
package/dist/mappings/usecase-mapping.d.ts CHANGED
@@ -89,5 +89,8 @@ export declare enum UsecaseMapping {
89
89
  REJECT_DOCUMENT = "Document Rejection",
90
90
  VISA_STATUS_UPDATE = "Visa Status Update",
91
91
  CLOSED_LOST_STAGE = "Closed Lost Stage",
92
- ENROLMENT_STAGE = "Enrolment Stage"
92
+ ENROLMENT_STAGE = "Enrolment Stage",
93
+ SAVE_INSTRUCTIONS = "Save Instructions",
94
+ SAVE_PERSONAL_BACKGROUND = "Save Personal Background",
95
+ SAVE_ADDITIONAL_APPLICANT_INFO = "Save Additional Applicant Information"
93
96
  }
package/dist/mappings/usecase-mapping.js CHANGED
@@ -94,4 +94,7 @@ var UsecaseMapping;
94
94
  UsecaseMapping["VISA_STATUS_UPDATE"] = "Visa Status Update";
95
95
  UsecaseMapping["CLOSED_LOST_STAGE"] = "Closed Lost Stage";
96
96
  UsecaseMapping["ENROLMENT_STAGE"] = "Enrolment Stage";
97
+ UsecaseMapping["SAVE_INSTRUCTIONS"] = "Save Instructions";
98
+ UsecaseMapping["SAVE_PERSONAL_BACKGROUND"] = "Save Personal Background";
99
+ UsecaseMapping["SAVE_ADDITIONAL_APPLICANT_INFO"] = "Save Additional Applicant Information";
97
100
  })(UsecaseMapping || (exports.UsecaseMapping = UsecaseMapping = {}));
package/package.json CHANGED
@@ -1,79 +1,79 @@
1
- {
2
- "name": "@gus-eip/loggers",
3
- "version": "4.1.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
- }
1
+ {
2
+ "name": "@gus-eip/loggers",
3
+ "version": "4.1.3",
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
+ }