@gus-eip/loggers 4.2.8 → 4.2.9

package/README.md

@@ -1,92 +1,92 @@
-# @gus-eip/loggers
-
-## Overview
-
-`@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.
-
-## Installation
-
-You can install the package via npm:
-
-```bash
-npm install @gus-eip/loggers
-```
-
-## Usage
-
-To use the logger module in your application, follow these steps:
-
-1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
-
-```javascript
-import { LoggerModule } from '@gus-eip/loggers';
-```
-
-2. Configure `LoggerModule` in your module by calling the `forRoot` method.
-
-```javascript
-LoggerModule.forRoot({
-  region: process.env.REGION,
-  logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
-  options: 'CloudWatchLogger',
-}),
-```
-
-Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
-
-## Configuration Options
-
-- `region`: The AWS region where your CloudWatch logs are located.
-- `logGroupName`: The name of the log group where logs will be sent.
-- `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
-
-## Example
-
-```javascript
-import { Module } from '@nestjs/common';
-import { LoggerModule } from '@gus-eip/loggers';
-
-@Module({
-  imports: [
-    LoggerModule.forRoot({
-      region: process.env.REGION,
-      logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
-      options: 'CloudWatchLogger',
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-```
-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.
-
-```
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
----
-
-## OAP-EIP LOGGER
-
-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:
-
-1. Add the new use case, event and component identifiers to `enum.ts`.
-
-2. Add a user-friendly message/label for the use case in `mappings/usecase-mapping.ts`.
-
-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.
-
-Notes:
-
-- 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.
-- Keep `enum.ts` identifiers stable. Prefer adding new identifiers rather than renaming existing ones to avoid breaking downstream projects.
-
-Publishing and downstream updates:
-
-- After making changes, bump and publish this package.
-- 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.
-
----
+# @gus-eip/loggers
+
+## Overview
+
+`@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.
+
+## Installation
+
+You can install the package via npm:
+
+```bash
+npm install @gus-eip/loggers
+```
+
+## Usage
+
+To use the logger module in your application, follow these steps:
+
+1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
+
+```javascript
+import { LoggerModule } from '@gus-eip/loggers';
+```
+
+2. Configure `LoggerModule` in your module by calling the `forRoot` method.
+
+```javascript
+LoggerModule.forRoot({
+  region: process.env.REGION,
+  logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
+  options: 'CloudWatchLogger',
+}),
+```
+
+Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
+
+## Configuration Options
+
+- `region`: The AWS region where your CloudWatch logs are located.
+- `logGroupName`: The name of the log group where logs will be sent.
+- `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
+
+## Example
+
+```javascript
+import { Module } from '@nestjs/common';
+import { LoggerModule } from '@gus-eip/loggers';
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({
+      region: process.env.REGION,
+      logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
+      options: 'CloudWatchLogger',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+```
+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.
+
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## OAP-EIP LOGGER
+
+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:
+
+1. Add the new use case, event and component identifiers to `enum.ts`.
+
+2. Add a user-friendly message/label for the use case in `mappings/usecase-mapping.ts`.
+
+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.
+
+Notes:
+
+- 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.
+- Keep `enum.ts` identifiers stable. Prefer adding new identifiers rather than renaming existing ones to avoid breaking downstream projects.
+
+Publishing and downstream updates:
+
+- After making changes, bump and publish this package.
+- 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.
+
+---

package/dist/cloudwatch.logger.js

@@ -152,7 +152,9 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
             entityKey: fullLogObject.entityKey || '',
             event: fullLogObject.event || '',
             status,
-            message: type === 'error' ? fullLogObject.errorMessage : fullLogObject.logMessage,
+            message: type === 'error'
+                ? fullLogObject.errorMessage
+                : fullLogObject.logMessage,
             logGroupName: this.logGroupName,
         };
         const sqsUrl = await ssm_utils_1.ssmUtils.getSqsUrl();
@@ -177,7 +179,7 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
         }
     }
     async sendNotificationtoTeams(title, summary, handler, logStreamName, isFormattingRequired = true, type) {
-        console.log('Notification summary', summary);
+        console.log('Notification Summary : ', summary);
         const webhookUrl = this.teamWebhookUrl;
         const timestamp = new Date().toISOString();
         let headers;
@@ -199,40 +201,115 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
             : typeof summary === 'object'
                 ? JSON.stringify(summary)
                 : summary;
-        const alertMessage = {
-            '@type': 'MessageCard',
-            '@context': 'http://schema.org/extensions',
-            summary: 'System Alert',
-            themeColor: 'FF0000',
-            title: `🚨 ${title} 🚨`,
-            sections: [
-                {
-                    facts: [
-                        {
-                            name: 'summary:',
-                            value: summaryMsg,
-                        },
-                        {
-                            name: 'component:',
-                            value: handler,
-                        },
-                        {
-                            name: 'timestamp:',
-                            value: timestamp,
-                        },
-                        {
-                            name: 'type:',
-                            value: type,
-                        },
-                        {
-                            name: '',
-                            value: `[Click here for more details](https://eu-west-1.console.aws.amazon.com/cloudwatch/home?region=eu-west-1#logsV2:log-groups/log-group/${this.logGroupName}/log-events/${logStreamName})`,
+        const awsLogUrl = `https://eu-west-1.console.aws.amazon.com/cloudwatch/home?region=eu-west-1#logsV2:log-groups/log-group/${this.logGroupName}/log-events/${logStreamName}`;
+        const isPowerAutomate = webhookUrl.includes('powerautomate');
+        console.log('isPowerAutomate', isPowerAutomate);
+        const alertMessage = isPowerAutomate
+            ? {
+                attachments: [
+                    {
+                        contentType: 'application/vnd.microsoft.card.adaptive',
+                        content: {
+                            type: 'AdaptiveCard',
+                            version: '1.4',
+                            body: [
+                                {
+                                    type: 'TextBlock',
+                                    text: `🚨 ${title} 🚨`,
+                                    weight: 'Bolder',
+                                    size: 'Large',
+                                    color: type === 'Error'
+                                        ? 'Attention'
+                                        : type === 'Warning'
+                                            ? 'Warning'
+                                            : 'Good',
+                                },
+                                {
+                                    type: 'TextBlock',
+                                    text: `Handler: ${handler}`,
+                                    wrap: true,
+                                },
+                                {
+                                    type: 'TextBlock',
+                                    text: `Timestamp: ${timestamp}`,
+                                    wrap: true,
+                                },
+                                {
+                                    type: 'TextBlock',
+                                    text: `Type: ${type}`,
+                                    wrap: true,
+                                },
+                                {
+                                    type: 'Container',
+                                    items: summary.map((item) => ({
+                                        type: 'Container',
+                                        items: Object.entries(item).map(([key, value]) => ({
+                                            type: 'ColumnSet',
+                                            columns: [
+                                                {
+                                                    type: 'Column',
+                                                    width: 'auto',
+                                                    items: [
+                                                        {
+                                                            type: 'TextBlock',
+                                                            text: key,
+                                                            weight: 'Bolder',
+                                                            wrap: true,
+                                                        },
+                                                    ],
+                                                },
+                                                {
+                                                    type: 'Column',
+                                                    width: 'stretch',
+                                                    items: [
+                                                        {
+                                                            type: 'TextBlock',
+                                                            text: typeof value === 'object'
+                                                                ? JSON.stringify(value, null, 2)
+                                                                : String(value !== null && value !== void 0 ? value : ''),
+                                                            wrap: true,
+                                                        },
+                                                    ],
+                                                },
+                                            ],
+                                        })),
+                                        separator: true,
+                                    })),
+                                },
+                            ],
+                            actions: [
+                                {
+                                    type: 'Action.OpenUrl',
+                                    title: '🔍 View AWS Logs',
+                                    url: awsLogUrl,
+                                },
+                            ],
                         },
-                    ],
-                    markdown: true,
-                },
-            ],
-        };
+                    },
+                ],
+            }
+            : {
+                '@type': 'MessageCard',
+                '@context': 'http://schema.org/extensions',
+                summary: 'System Alert',
+                themeColor: 'FF0000',
+                title: `🚨 ${title} 🚨`,
+                sections: [
+                    {
+                        facts: [
+                            { name: 'summary:', value: summaryMsg },
+                            { name: 'component:', value: handler },
+                            { name: 'timestamp:', value: timestamp },
+                            { name: 'type:', value: type },
+                            {
+                                name: '',
+                                value: `[Click here for more details](${awsLogUrl})`,
+                            },
+                        ],
+                        markdown: true,
+                    },
+                ],
+            };
         try {
             await axios_1.default.post(webhookUrl, alertMessage, {
                 headers: {

package/dist/test.d.ts

@@ -0,0 +1,2 @@
+declare const axios: any;
+declare function sendNotificationtoTeams(title: any, summary: any, handler: any, logStreamName: any, isFormattingRequired: boolean, type: any): Promise<any>;

package/dist/test.js

@@ -0,0 +1,168 @@
+const axios = require('axios');
+async function sendNotificationtoTeams(title, summary, handler, logStreamName, isFormattingRequired = true, type) {
+    console.log('Notification summary', summary);
+    const webhookUrl = 'https://gus.webhook.office.com/webhookb2/a7847242-acac-4b2e-9d64-a3818681a2ec@5665ee7a-3634-4975-9c21-2778cda48edd/IncomingWebhook/6b32fef8240843359b1b3e902fb4d716/e06d3c50-7be6-44a2-87e7-48a4696d8297/V26sOW3X1erzRoeQSKP8rq1toiHD1Qtr41icu1ZxSHyh01';
+    const timestamp = new Date().toISOString();
+    let headers;
+    let headerRow;
+    let separatorRow;
+    let rows;
+    let formattedSummary;
+    if (isFormattingRequired) {
+        headers = Object.keys(summary[0]);
+        headerRow = `| ${headers.join(' | ')} |`;
+        separatorRow = `| ${headers.map(() => '---').join(' | ')} |`;
+        rows = summary
+            .map((item) => `| ${headers.map((header) => item[header] || '').join(' | ')} |`)
+            .join('\n');
+        formattedSummary = [headerRow, separatorRow, rows].join('\n');
+    }
+    const summaryMsg = isFormattingRequired
+        ? formattedSummary
+        : typeof summary === 'object'
+            ? JSON.stringify(summary)
+            : summary;
+    const awsLogUrl = `https://eu-west-1.console.aws.amazon.com/cloudwatch/home?region=eu-west-1#logsV2:log-groups/log-group/${this.logGroupName}/log-events/${logStreamName}`;
+    const isPowerAutomate = webhookUrl.includes('powerautomate');
+    const alertMessage = isPowerAutomate
+        ? {
+            attachments: [
+                {
+                    contentType: 'application/vnd.microsoft.card.adaptive',
+                    content: {
+                        type: 'AdaptiveCard',
+                        version: '1.4',
+                        body: [
+                            {
+                                type: 'TextBlock',
+                                text: `🚨 ${title} 🚨`,
+                                weight: 'Bolder',
+                                size: 'Large',
+                                color: type === 'Error'
+                                    ? 'Attention'
+                                    : type === 'Warning'
+                                        ? 'Warning'
+                                        : 'Good',
+                            },
+                            {
+                                type: 'TextBlock',
+                                text: `Handler: ${handler}`,
+                                wrap: true,
+                            },
+                            {
+                                type: 'TextBlock',
+                                text: `Timestamp: ${timestamp}`,
+                                wrap: true,
+                            },
+                            {
+                                type: 'TextBlock',
+                                text: `Type: ${type}`,
+                                wrap: true,
+                            },
+                            {
+                                type: 'Container',
+                                items: summary.map((item) => ({
+                                    type: 'Container',
+                                    items: Object.entries(item).map(([key, value]) => ({
+                                        type: 'ColumnSet',
+                                        columns: [
+                                            {
+                                                type: 'Column',
+                                                width: 'auto',
+                                                items: [
+                                                    {
+                                                        type: 'TextBlock',
+                                                        text: key,
+                                                        weight: 'Bolder',
+                                                        wrap: true,
+                                                    },
+                                                ],
+                                            },
+                                            {
+                                                type: 'Column',
+                                                width: 'stretch',
+                                                items: [
+                                                    {
+                                                        type: 'TextBlock',
+                                                        text: typeof value === 'object'
+                                                            ? JSON.stringify(value, null, 2)
+                                                            : String(value !== null && value !== void 0 ? value : ''),
+                                                        wrap: true,
+                                                    },
+                                                ],
+                                            },
+                                        ],
+                                    })),
+                                    separator: true,
+                                })),
+                            },
+                        ],
+                        actions: [
+                            {
+                                type: 'Action.OpenUrl',
+                                title: '🔍 View AWS Logs',
+                                url: awsLogUrl,
+                            },
+                        ],
+                    },
+                },
+            ],
+        }
+        : {
+            '@type': 'MessageCard',
+            '@context': 'http://schema.org/extensions',
+            summary: 'System Alert',
+            themeColor: type === 'Error'
+                ? 'FF0000'
+                : type === 'Warning'
+                    ? 'FFFF00'
+                    : '00FF00',
+            title: `🚨 ${title} 🚨`,
+            sections: [
+                {
+                    facts: [
+                        { name: 'summary:', value: summaryMsg },
+                        { name: 'component:', value: handler },
+                        { name: 'timestamp:', value: timestamp },
+                        { name: 'type:', value: type },
+                        {
+                            name: '',
+                            value: `[Click here for more details](${awsLogUrl})`,
+                        },
+                    ],
+                    markdown: true,
+                },
+            ],
+        };
+    try {
+        await axios.post(webhookUrl, alertMessage, {
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        });
+        console.log('Message sent successfully');
+    }
+    catch (error) {
+        console.error('Error sending message:', error);
+    }
+}
+(async () => {
+    await sendNotificationtoTeams('Test Alert', [
+        {
+            job: 'gus-dlq-alert-job',
+            runStatus: 'Started',
+            ErrorsCount: 0,
+        },
+        {
+            job: 'kyb-kyc-event-listener',
+            totalhrsRun: 24,
+            listenerErrorsCount: 0,
+        },
+        {
+            job: 'kyb-kyc-verification-process',
+            screeningEnquiryCount: 0,
+            screeningEnquiryFeedbackCount: 0,
+            sfErrorsCount: 0,
+        },
+    ], 'ZoomToBoxSyncHandler', 'TestStream123', true, 'Error');
+})();

package/package.json

@@ -1,79 +1,79 @@
-{
-  "name": "@gus-eip/loggers",
-  "version": "4.2.8",
-  "description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
-  "author": "gus",
-  "readmeFilename": "README.md",
-  "main": "dist/index.js",
-  "files": [
-    "dist/**/*",
-    "*.md"
-  ],
-  "scripts": {
-    "start:dev": "tsc -w",
-    "build": "tsc",
-    "prepare": "npm run build",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "tslint -p tsconfig.json -c tslint.json",
-    "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
-  },
-  "keywords": [
-    "nestjs",
-    "nodejs",
-    "javascript",
-    "typescript",
-    "eip-loggers"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@aws-sdk/client-ssm": "^3.759.0",
-    "aws-sdk": "^2.1590.0",
-    "axios": "^1.7.4"
-  },
-  "devDependencies": {
-    "@nestjs/common": "^10.0.2",
-    "@nestjs/core": "^10.0.2",
-    "@nestjs/platform-express": "^10.0.2",
-    "@nestjs/testing": "10.0.2",
-    "@types/express": "4.17.17",
-    "@types/jest": "29.5.2",
-    "@types/lodash": "^4.17.7",
-    "@types/node": "20.3.1",
-    "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
-    "eslint": "^8.43.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "29.5.0",
-    "prettier": "2.8.8",
-    "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.1",
-    "supertest": "6.3.3",
-    "ts-jest": "29.1.0",
-    "ts-node": "10.9.1",
-    "tsc-watch": "6.0.4",
-    "tsconfig-paths": "4.2.0",
-    "tslint": "5.20.1",
-    "typescript": "^5.5.4"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".spec.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  }
-}
+{
+  "name": "@gus-eip/loggers",
+  "version": "4.2.9",
+  "description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
+  "author": "gus",
+  "readmeFilename": "README.md",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*",
+    "*.md"
+  ],
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "keywords": [
+    "nestjs",
+    "nodejs",
+    "javascript",
+    "typescript",
+    "eip-loggers"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@aws-sdk/client-ssm": "^3.759.0",
+    "aws-sdk": "^2.1590.0",
+    "axios": "^1.7.4"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^10.0.2",
+    "@nestjs/core": "^10.0.2",
+    "@nestjs/platform-express": "^10.0.2",
+    "@nestjs/testing": "10.0.2",
+    "@types/express": "4.17.17",
+    "@types/jest": "29.5.2",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "20.3.1",
+    "@types/supertest": "2.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "29.5.0",
+    "prettier": "2.8.8",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1",
+    "supertest": "6.3.3",
+    "ts-jest": "29.1.0",
+    "ts-node": "10.9.1",
+    "tsc-watch": "6.0.4",
+    "tsconfig-paths": "4.2.0",
+    "tslint": "5.20.1",
+    "typescript": "^5.5.4"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}