@gus-eip/loggers 1.0.1

package/README.md

@@ -0,0 +1,67 @@
+# @gus-eip/eip-loggers
+
+## Overview
+
+`@gus-eip/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/eip-loggers
+```
+
+## Usage
+
+To use the logger module in your application, follow these steps:
+
+1. Import `LoggerModule` from `@gus-eip/eip-loggers` inside your module.
+
+```javascript
+import { LoggerModule } from '@gus-eip/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/eip-loggers';
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({
+      region: process.env.REGION,
+      logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
+      options: 'CloudWatchLogger',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Feel free to customize this README according to your specific package features, usage guidelines, and licensing terms.

package/dist/cloudwatch.logger.d.ts

@@ -0,0 +1,12 @@
+import { ILogger } from './interface';
+export declare class CloudWatchLoggerService implements ILogger {
+    private logger;
+    private region;
+    private logGroupName;
+    constructor(region: string, logGroupName: string);
+    private defaultVersion;
+    private createCloudWatchTransport;
+    private logToCloudWatch;
+    log(requestedId: string, message: any, event: string, statusCode: number, details: any, brand: any, logStreamName: string): Promise<any>;
+    error(requestedId: string, message: any, event: string, errorCode: string, statusCode: number, details: any, brand: any, logStreamName: string): Promise<any>;
+}

package/dist/cloudwatch.logger.js

@@ -0,0 +1,79 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudWatchLoggerService = void 0;
+const common_1 = require("@nestjs/common");
+const winston = require("winston");
+const CloudWatchTransport = require("winston-aws-cloudwatch");
+const AWS = require("aws-sdk");
+let CloudWatchLoggerService = exports.CloudWatchLoggerService = class CloudWatchLoggerService {
+    constructor(region, logGroupName) {
+        this.defaultVersion = 'v1';
+        this.region = region;
+        this.logGroupName = logGroupName;
+        AWS.config.update({ region: this.region });
+        this.logger = winston.createLogger({
+            format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
+            transports: [new winston.transports.Console()],
+        });
+    }
+    async createCloudWatchTransport(logStreamName) {
+        return new CloudWatchTransport({
+            logGroupName: this.logGroupName,
+            logStreamName,
+            createLogGroup: true,
+            createLogStream: true,
+            awsRegion: this.region,
+            level: 'info',
+        });
+    }
+    async logToCloudWatch(level, logObject) {
+        this.logger[level]('', {
+            ...logObject,
+            version: this.defaultVersion,
+            timestamp: new Date().toISOString(),
+        });
+    }
+    async log(requestedId, message, event, statusCode, details, brand, logStreamName) {
+        console.log(this.region, this.logGroupName);
+        const transport = await this.createCloudWatchTransport(logStreamName);
+        await this.logger.add(transport);
+        const logObject = {
+            requestedId,
+            message,
+            type: 'INFO',
+            event,
+            statusCode,
+            details,
+            brand,
+        };
+        await this.logToCloudWatch('info', logObject);
+    }
+    async error(requestedId, message, event, errorCode, statusCode, details, brand, logStreamName) {
+        const transport = await this.createCloudWatchTransport(logStreamName);
+        await this.logger.add(transport);
+        const logObject = {
+            requestedId,
+            message,
+            type: 'Error',
+            event,
+            errorCode,
+            statusCode,
+            details,
+            brand,
+        };
+        await this.logToCloudWatch('error', logObject);
+    }
+};
+exports.CloudWatchLoggerService = CloudWatchLoggerService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [String, String])
+], CloudWatchLoggerService);

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './cloudwatch.logger';
+export * from './interface';
+export * from './module';
+export * from './provider';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cloudwatch.logger"), exports);
+__exportStar(require("./interface"), exports);
+__exportStar(require("./module"), exports);
+__exportStar(require("./provider"), exports);

package/dist/interface.d.ts

@@ -0,0 +1,4 @@
+export interface ILogger {
+    log(requestedId: string, logMessage: any, event: string, statusCode: number, details: any, brand: any, logStreamName: string): Promise<any>;
+    error(requestedId: string, errorMessage: any, event: string, errorCode: string, statusCode: number, details: any, brand: any, logStreamName: string): Promise<any>;
+}

package/dist/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/logger.interface.d.ts

@@ -0,0 +1,5 @@
+export interface LoggerModuleOptions {
+    region: string;
+    logGroupName: string;
+    options: string;
+}

package/dist/interfaces/logger.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/module.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule } from '@nestjs/common';
+import { LoggerModuleOptions } from './interfaces/logger.interface';
+export declare class LoggerModule {
+    static forRoot(params: LoggerModuleOptions): DynamicModule;
+}

package/dist/module.js

@@ -0,0 +1,35 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var LoggerModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerModule = void 0;
+const common_1 = require("@nestjs/common");
+const cloudwatch_logger_1 = require("./cloudwatch.logger");
+let LoggerModule = exports.LoggerModule = LoggerModule_1 = class LoggerModule {
+    static forRoot(params) {
+        const cloudwatchProvider = {
+            provide: params.options,
+            useClass: cloudwatch_logger_1.CloudWatchLoggerService,
+        };
+        const cloudwatchProviders = {
+            provide: params.options,
+            useFactory: () => new cloudwatch_logger_1.CloudWatchLoggerService(params.region, params.logGroupName),
+        };
+        return {
+            module: LoggerModule_1,
+            exports: [cloudwatchProvider, cloudwatchProviders],
+            providers: [
+                cloudwatchProvider,
+                cloudwatchProviders,
+            ],
+        };
+    }
+};
+exports.LoggerModule = LoggerModule = LoggerModule_1 = __decorate([
+    (0, common_1.Module)({})
+], LoggerModule);

package/dist/provider.d.ts

@@ -0,0 +1,2 @@
+import { Provider } from '@nestjs/common';
+export declare const LoggerProviders: Provider[];

package/dist/provider.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerProviders = void 0;
+const cloudwatch_logger_1 = require("./cloudwatch.logger");
+exports.LoggerProviders = [
+    {
+        provide: 'CloudWatchLogger',
+        useClass: cloudwatch_logger_1.CloudWatchLoggerService,
+    },
+];

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@gus-eip/loggers",
+  "version": "1.0.1",
+  "description": "",
+  "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",
+    "cashify",
+    "eip-loggers",
+    "currency-exchange",
+    "conversion",
+    "money",
+    "exchange-rates"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "aws-sdk": "^2.1590.0",
+    "winston": "^3.13.0",
+    "winston-aws-cloudwatch": "^3.0.0"
+  },
+  "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/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.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}