@gus-eip/loggers 4.2.2 → 4.2.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 (3) hide show
  1. package/README.md +92 -92
  2. package/dist/mappings/source-destination-mapping.js +23 -23
  3. package/package.json +79 -79
package/README.md CHANGED
@@ -1,92 +1,92 @@
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 any EIP integration (for example: `oap-handlers`, `oap-backend`, `eip-integration-handlers`, `platform-events-listener`, or `gus-middleware-service`) introduces a new use case, event, or component, follow these steps to keep this package as the single source of truth for EIP logging:
75
-
76
- 1. Add the new use case, event and component identifiers to `enum.ts`.
77
-
78
- 2. Add a user-friendly message/label for the use case in `mappings/usecase-mapping.ts`.
79
-
80
- 3. Update `mappings/source-destination-mapping.ts` to include the use case and the corresponding brand(s) with their `source` and `destination` values. If the use case already exists and a newly onboarded brand uses it, add the brand under that existing use case entry.
81
-
82
- Notes:
83
-
84
- - The `mappings/source-destination-mapping.ts` file is the ultimate source of truth for EIP logger routing and should accurately reflect brand → use case → (source, destination) mappings.
85
- - Keep `enum.ts` identifiers stable. Prefer adding new identifiers rather than renaming existing ones to avoid breaking downstream projects.
86
-
87
- Publishing and downstream updates:
88
-
89
- - After making changes, bump and publish this package.
90
- - Then update the dependency version used by the `gus-eip-analytics` repository: set the new package version in the `dev` branch for development deployments and in the `prod` branch for production deployments so downstream services pick up the release.
91
-
92
- ---
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 any EIP integration (for example: `oap-handlers`, `oap-backend`, `eip-integration-handlers`, `platform-events-listener`, or `gus-middleware-service`) introduces a new use case, event, or component, follow these steps to keep this package as the single source of truth for EIP logging:
75
+
76
+ 1. Add the new use case, event and component identifiers to `enum.ts`.
77
+
78
+ 2. Add a user-friendly message/label for the use case in `mappings/usecase-mapping.ts`.
79
+
80
+ 3. Update `mappings/source-destination-mapping.ts` to include the use case and the corresponding brand(s) with their `source` and `destination` values. If the use case already exists and a newly onboarded brand uses it, add the brand under that existing use case entry.
81
+
82
+ Notes:
83
+
84
+ - The `mappings/source-destination-mapping.ts` file is the ultimate source of truth for EIP logger routing and should accurately reflect brand → use case → (source, destination) mappings.
85
+ - Keep `enum.ts` identifiers stable. Prefer adding new identifiers rather than renaming existing ones to avoid breaking downstream projects.
86
+
87
+ Publishing and downstream updates:
88
+
89
+ - After making changes, bump and publish this package.
90
+ - Then update the dependency version used by the `gus-eip-analytics` repository: set the new package version in the `dev` branch for development deployments and in the `prod` branch for production deployments so downstream services pick up the release.
91
+
92
+ ---
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', 'WUL', 'Arden University', 'PU'],
6
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UEG', 'UCW', 'UNFC', 'WUL', 'Arden University', 'ARD', 'PU'],
7
7
  usecase: 'SAVE_BASIC_DETAILS',
8
8
  source: 'OAP',
9
9
  destination: 'GUS Salesforce',
@@ -39,7 +39,7 @@ exports.BRAND_USECASE_MAPPING = [
39
39
  destination: 'GUS Salesforce',
40
40
  },
41
41
  {
42
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UEG', 'Arden University'],
42
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UEG', 'Arden University', 'ARD'],
43
43
  usecase: 'SAVE_PERSONAL_DETAILS',
44
44
  source: 'OAP',
45
45
  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', 'WUL', 'Arden University', 'PU'],
54
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW', 'WUL', 'Arden University', 'ARD', 'PU'],
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', 'WUL', 'Arden University', 'PU'],
60
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'WUL', 'Arden University', 'ARD', 'PU'],
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', 'WUL', 'Arden University', 'PU'],
66
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'WUL', 'Arden University', 'ARD', 'PU'],
67
67
  usecase: 'GUS_SALESFORCE_OPERATION',
68
68
  source: 'OAP',
69
69
  destination: 'GUS Salesforce',
@@ -105,49 +105,49 @@ exports.BRAND_USECASE_MAPPING = [
105
105
  destination: 'GUS Salesforce',
106
106
  },
107
107
  {
108
- brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW', 'WUL', 'Arden University', 'PU'],
108
+ brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC', 'UEG', 'UCW', 'WUL', 'Arden University', 'ARD', 'PU'],
109
109
  usecase: 'SAVE_PROGRAMME_DETAILS',
110
110
  source: 'OAP',
111
111
  destination: 'GUS Salesforce',
112
112
  },
113
113
  {
114
- brands: ['Arden University'],
114
+ brands: ['Arden University', 'ARD'],
115
115
  usecase: 'SAVE_CONTACT_DETAILS',
116
116
  source: 'OAP',
117
117
  destination: 'GUS Salesforce',
118
118
  },
119
119
  {
120
- brands: ['Arden University'],
120
+ brands: ['Arden University', 'ARD'],
121
121
  usecase: 'SAVE_QUALIFICATION_DETAILS',
122
122
  source: 'OAP',
123
123
  destination: 'GUS Salesforce',
124
124
  },
125
125
  {
126
- brands: ['Arden University'],
126
+ brands: ['Arden University', 'ARD'],
127
127
  usecase: 'SAVE_PERSONAL_STATEMENT',
128
128
  source: 'OAP',
129
129
  destination: 'GUS Salesforce',
130
130
  },
131
131
  {
132
- brands: ['Arden University'],
132
+ brands: ['Arden University', 'ARD'],
133
133
  usecase: 'SAVE_VISA_DETAILS',
134
134
  source: 'OAP',
135
135
  destination: 'GUS Salesforce',
136
136
  },
137
137
  {
138
- brands: ['Arden University'],
138
+ brands: ['Arden University', 'ARD'],
139
139
  usecase: 'SAVE_REFEREE_DETAILS',
140
140
  source: 'OAP',
141
141
  destination: 'GUS Salesforce',
142
142
  },
143
143
  {
144
- brands: ['Arden University'],
144
+ brands: ['Arden University', 'ARD'],
145
145
  usecase: 'SAVE_FUNDING_DETAILS',
146
146
  source: 'OAP',
147
147
  destination: 'GUS Salesforce',
148
148
  },
149
149
  {
150
- brands: ['Arden University'],
150
+ brands: ['Arden University', 'ARD'],
151
151
  usecase: 'SAVE_SUBMISSION_DETAILS',
152
152
  source: 'OAP',
153
153
  destination: 'GUS Salesforce',
@@ -657,55 +657,55 @@ exports.BRAND_USECASE_MAPPING = [
657
657
  destination: 'GUS Salesforce',
658
658
  },
659
659
  {
660
- brands: ['Arden University'],
660
+ brands: ['Arden University', 'ARD'],
661
661
  usecase: 'ADDITIONAL_DOCUMENTS_REQUIRED',
662
662
  source: 'Arden DCRM',
663
663
  destination: 'GUS Salesforce',
664
664
  },
665
665
  {
666
- brands: ['Arden University'],
666
+ brands: ['Arden University', 'ARD'],
667
667
  usecase: 'ADDITIONAL_INFORMATION_REQUIRED',
668
668
  source: 'Arden DCRM',
669
669
  destination: 'GUS Salesforce',
670
670
  },
671
671
  {
672
- brands: ['Arden University'],
672
+ brands: ['Arden University', 'ARD'],
673
673
  usecase: 'APPLICATION_INTAKE_CHANGE',
674
674
  source: 'Arden DCRM',
675
675
  destination: 'GUS Salesforce',
676
676
  },
677
677
  {
678
- brands: ['Arden University'],
678
+ brands: ['Arden University', 'ARD'],
679
679
  usecase: 'CLOSED_LOST_STAGE',
680
680
  source: 'Arden DCRM',
681
681
  destination: 'GUS Salesforce',
682
682
  },
683
683
  {
684
- brands: ['Arden University'],
684
+ brands: ['Arden University', 'ARD'],
685
685
  usecase: 'ENROLMENT_STAGE',
686
686
  source: 'Arden DCRM',
687
687
  destination: 'GUS Salesforce',
688
688
  },
689
689
  {
690
- brands: ['Arden University'],
690
+ brands: ['Arden University', 'ARD'],
691
691
  usecase: 'OFFER_STAGE',
692
692
  source: 'Arden DCRM',
693
693
  destination: 'GUS Salesforce',
694
694
  },
695
695
  {
696
- brands: ['Arden University'],
696
+ brands: ['Arden University', 'ARD'],
697
697
  usecase: 'PAYMENT_RECEIVED',
698
698
  source: 'Arden DCRM',
699
699
  destination: 'GUS Salesforce',
700
700
  },
701
701
  {
702
- brands: ['Arden University'],
702
+ brands: ['Arden University', 'ARD'],
703
703
  usecase: 'REJECT_DOCUMENT',
704
704
  source: 'Arden DCRM',
705
705
  destination: 'GUS Salesforce',
706
706
  },
707
707
  {
708
- brands: ['Arden University'],
708
+ brands: ['Arden University', 'ARD'],
709
709
  usecase: 'VISA_STATUS_UPDATE',
710
710
  source: 'Arden DCRM',
711
711
  destination: 'GUS Salesforce',
@@ -741,7 +741,7 @@ exports.BRAND_USECASE_MAPPING = [
741
741
  destination: 'GUS Salesforce',
742
742
  },
743
743
  {
744
- brands: ['WUL', 'Arden University'],
744
+ brands: ['WUL', 'Arden University', 'ARD'],
745
745
  usecase: 'SAVE_EXPERIENCE',
746
746
  source: 'OAP',
747
747
  destination: 'GUS Salesforce',
package/package.json CHANGED
@@ -1,79 +1,79 @@
1
- {
2
- "name": "@gus-eip/loggers",
3
- "version": "4.2.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.2.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
+ }