@gus-eip/loggers 4.4.4 → 4.4.5

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,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/enum.d.ts CHANGED
@@ -524,6 +524,10 @@ export declare class LoggerEnum {
524
524
  FETCH_VISA_DETAILS_INITIATED: string;
525
525
  FETCH_VISA_DETAILS_COMPLETED: string;
526
526
  FETCH_VISA_DETAILS_FAILED: string;
527
+ SFTP_FILE_UPLOAD_INITIATED: string;
528
+ SFTP_FILE_UPLOAD_FAILED: string;
529
+ SFTP_FILE_DOWNLOAD_INITIATED: string;
530
+ SFTP_FILE_DOWNLOAD_FAILED: string;
527
531
  };
528
532
  UseCase: {
529
533
  PROGRAM_INFO: string;
@@ -716,6 +720,8 @@ export declare class LoggerEnum {
716
720
  FAILED_ACCESS_INFO_STREAM_PROCESSED: string;
717
721
  COMPLETED_ACCESS_INFO_STREAM_PROCESSED: string;
718
722
  INITIATED_ACCESS_INFO_STREAM_PROCESSED: string;
723
+ SFTP_INBOUND_FILE_UPLOAD: string;
724
+ SFTP_OUTBOUND_FILE_POLLING: string;
719
725
  };
720
726
  Component: {
721
727
  OAP_FRONTEND: string;
@@ -807,5 +813,6 @@ export declare class LoggerEnum {
807
813
  OAP_SCHEDULE_EXECUTION: string;
808
814
  OAP_EVENT_SCHEDULER: string;
809
815
  PUBLISH_EVENT_TO_SF: string;
816
+ SFTP_SERVER: string;
810
817
  };
811
818
  }
package/dist/enum.js CHANGED
@@ -535,6 +535,10 @@ let LoggerEnum = class LoggerEnum {
535
535
  FETCH_VISA_DETAILS_INITIATED: 'FETCH_VISA_DETAILS_INITIATED',
536
536
  FETCH_VISA_DETAILS_COMPLETED: 'FETCH_VISA_DETAILS_COMPLETED',
537
537
  FETCH_VISA_DETAILS_FAILED: 'FETCH_VISA_DETAILS_FAILED',
538
+ SFTP_FILE_UPLOAD_INITIATED: 'SFTP_FILE_UPLOAD_INITIATED',
539
+ SFTP_FILE_UPLOAD_FAILED: 'SFTP_FILE_UPLOAD_FAILED',
540
+ SFTP_FILE_DOWNLOAD_INITIATED: 'SFTP_FILE_DOWNLOAD_INITIATED',
541
+ SFTP_FILE_DOWNLOAD_FAILED: 'SFTP_FILE_DOWNLOAD_FAILED',
538
542
  };
539
543
  this.UseCase = {
540
544
  PROGRAM_INFO: 'SAVE_PROGRAMME_DETAILS',
@@ -727,6 +731,8 @@ let LoggerEnum = class LoggerEnum {
727
731
  FAILED_ACCESS_INFO_STREAM_PROCESSED: 'FAILED_ACCESS_INFO_STREAM_PROCESSED',
728
732
  COMPLETED_ACCESS_INFO_STREAM_PROCESSED: 'COMPLETED_ACCESS_INFO_STREAM_PROCESSED',
729
733
  INITIATED_ACCESS_INFO_STREAM_PROCESSED: 'INITIATED_ACCESS_INFO_STREAM_PROCESSED',
734
+ SFTP_INBOUND_FILE_UPLOAD: 'SFTP_INBOUND_FILE_UPLOAD',
735
+ SFTP_OUTBOUND_FILE_POLLING: 'SFTP_OUTBOUND_FILE_POLLING',
730
736
  };
731
737
  this.Component = {
732
738
  OAP_FRONTEND: 'OAP-FRONTEND',
@@ -818,6 +824,7 @@ let LoggerEnum = class LoggerEnum {
818
824
  OAP_SCHEDULE_EXECUTION: 'OAP_SCHEDULE_EXECUTION',
819
825
  OAP_EVENT_SCHEDULER: 'OAP_EVENT_SCHEDULER',
820
826
  PUBLISH_EVENT_TO_SF: 'PUBLISH_EVENT_TO_SF',
827
+ SFTP_SERVER: 'SFTP_SERVER',
821
828
  };
822
829
  }
823
830
  };
@@ -125,5 +125,7 @@ export declare enum UsecaseMapping {
125
125
  SAVE_FAMILY_INFO = "Save Family Info",
126
126
  SAVE_TRANSFER_STUDENTS = "Save Transfer Students",
127
127
  SAVE_REFERENCES = "Save References",
128
- SAVE_ACTIVITIES_AND_INVOLVEMENT = "Save Activities And Involvement"
128
+ SAVE_ACTIVITIES_AND_INVOLVEMENT = "Save Activities And Involvement",
129
+ SFTP_INBOUND_FILE_UPLOAD = "SFTP Inbound File Upload",
130
+ SFTP_OUTBOUND_FILE_POLLING = "SFTP Outbound File Polling"
129
131
  }
@@ -130,4 +130,6 @@ var UsecaseMapping;
130
130
  UsecaseMapping["SAVE_TRANSFER_STUDENTS"] = "Save Transfer Students";
131
131
  UsecaseMapping["SAVE_REFERENCES"] = "Save References";
132
132
  UsecaseMapping["SAVE_ACTIVITIES_AND_INVOLVEMENT"] = "Save Activities And Involvement";
133
+ UsecaseMapping["SFTP_INBOUND_FILE_UPLOAD"] = "SFTP Inbound File Upload";
134
+ UsecaseMapping["SFTP_OUTBOUND_FILE_POLLING"] = "SFTP Outbound File Polling";
133
135
  })(UsecaseMapping || (exports.UsecaseMapping = UsecaseMapping = {}));
package/package.json CHANGED
@@ -1,79 +1,79 @@
1
- {
2
- "name": "@gus-eip/loggers",
3
- "version": "4.4.4",
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.4.5",
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
+ }