@mhmdhammoud/meritt-utils 1.2.0 → 1.3.0

package/ReleaseNotes.md

@@ -1,8 +1,18 @@
 # Changes
 
-## Version 1.0.5
+## Version 1.3.0
+
+- Added toUpperTitle method that accepts a string and removes all non alphanumeric characters and capitalizes each letter of every first word
 
-### Added
+```typescript
+import {Logger} from '@mhmdhammoud/meritt-utils'
+
+// Usage Example
+Logger.info('className', ' functionName', 'logMessage', 'userIp')
+// Available levels info warn error
+```
+
+## Version 1.0.5
 
 - Added toUpperTitle method that accepts a string and removes all non alphanumeric characters and capitalizes each letter of every first word
 
@@ -19,8 +29,6 @@ console : Hello World 99
 
 ## Version 1.0.4
 
-### Added
-
 - Added generateKeys method that returns public and private keys
 
 ```typescript
@@ -38,14 +46,10 @@ console.log(response)
 
 ```
 
-### Fixes and Improvements
-
 - Checking for prime numbers discarding even and odd numbers and skips 6 iterations at a time until radical I
 
 ## Version 1.0.3
 
-### Added
-
 - Added Formatter class for manipulating strings
 
 ```typescript
@@ -55,8 +59,6 @@ import {Formatter} from '@mhmdhammoud/meritt-utils'
 const slug = Formatter.slugify('My Product Name') // my-product-name
 ```
 
-### Fixes and Improvements
-
 - Fixed bug in Crypto class where encrypting a string with a key that is not a number would throw an error
 - Improved Crypto class to allow encrypting and decrypting numbers and objects
 - Documented Crypto class

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export { default as WinstonConfiguaration } from './logger-config';

package/dist/config/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WinstonConfiguaration = void 0;
+var logger_config_1 = require("./logger-config");
+Object.defineProperty(exports, "WinstonConfiguaration", { enumerable: true, get: function () { return __importDefault(logger_config_1).default; } });

package/dist/config/logger-config.d.ts

@@ -0,0 +1,5 @@
+import { ElasticsearchTransport } from 'winston-elasticsearch';
+declare const loggerConfiguration: {
+    transports: ElasticsearchTransport[];
+};
+export default loggerConfiguration;

package/dist/config/logger-config.js

@@ -0,0 +1,86 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston_elasticsearch_1 = require("winston-elasticsearch");
+const dotenv = __importStar(require("dotenv"));
+dotenv.config();
+const { ELASTICSEARCH_USERNAME, ELASTICSEARCH_PASSWORD, ELASTICSEARCH_NODE, SERVER_NICKNAME, LOG_LEVEL, } = process.env;
+const transports = process.env.NODE_ENV !== 'local'
+    ? [
+        // Elasticsearch Transport for 'info' logs
+        new winston_elasticsearch_1.ElasticsearchTransport({
+            level: 'info',
+            indexPrefix: process.env.SERVER_NICKNAME,
+            clientOpts: {
+                node: ELASTICSEARCH_NODE,
+                tls: {
+                    rejectUnauthorized: false, // Only for development, not recommended in production
+                },
+                auth: {
+                    username: ELASTICSEARCH_USERNAME,
+                    password: ELASTICSEARCH_PASSWORD,
+                },
+            },
+            // format: winston.format.combine(winston.format.json()), // Adjust as needed
+        }),
+        // Elasticsearch Transport for 'warn' logs
+        new winston_elasticsearch_1.ElasticsearchTransport({
+            level: LOG_LEVEL,
+            indexPrefix: SERVER_NICKNAME,
+            clientOpts: {
+                node: ELASTICSEARCH_NODE,
+                tls: {
+                    rejectUnauthorized: false, // Only for development, not recommended in production
+                },
+                auth: {
+                    username: ELASTICSEARCH_USERNAME,
+                    password: ELASTICSEARCH_PASSWORD,
+                },
+            },
+            // format: winston.format.combine(winston.format.json()), // Adjust as needed
+        }),
+        // Elasticsearch Transport for 'error' logs
+        new winston_elasticsearch_1.ElasticsearchTransport({
+            level: 'error',
+            indexPrefix: process.env.SERVER_NICKNAME,
+            clientOpts: {
+                node: ELASTICSEARCH_NODE,
+                tls: {
+                    rejectUnauthorized: false, // Only for development, not recommended in production
+                },
+                auth: {
+                    username: ELASTICSEARCH_USERNAME,
+                    password: ELASTICSEARCH_PASSWORD,
+                },
+            },
+            // format: winston.format.combine(winston.format.json()), // Adjust as needed
+        }),
+        // eslint-disable-next-line no-mixed-spaces-and-tabs
+    ]
+    : [];
+const loggerConfiguration = {
+    transports,
+};
+exports.default = loggerConfiguration;

package/dist/index.d.ts

@@ -1 +1 @@
-export { Crypto, Formatter, Colorful } from './lib';
+export * from './lib';

package/dist/index.js

@@ -1,7 +1,17 @@
 "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 });
-exports.Colorful = exports.Formatter = exports.Crypto = void 0;
-var lib_1 = require("./lib");
-Object.defineProperty(exports, "Crypto", { enumerable: true, get: function () { return lib_1.Crypto; } });
-Object.defineProperty(exports, "Formatter", { enumerable: true, get: function () { return lib_1.Formatter; } });
-Object.defineProperty(exports, "Colorful", { enumerable: true, get: function () { return lib_1.Colorful; } });
+__exportStar(require("./lib"), exports);

package/dist/lib/index.d.ts

@@ -3,3 +3,4 @@ export { default as Formatter } from './formatter';
 export { default as Pdf } from './formatter';
 export { default as Colorful } from './colorful';
 export { default as ImageFull } from './imagefull';
+export { default as Logger } from './logger';

package/dist/lib/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImageFull = exports.Colorful = exports.Pdf = exports.Formatter = exports.Crypto = void 0;
+exports.Logger = exports.ImageFull = exports.Colorful = exports.Pdf = exports.Formatter = exports.Crypto = void 0;
 var cypto_1 = require("./cypto");
 Object.defineProperty(exports, "Crypto", { enumerable: true, get: function () { return __importDefault(cypto_1).default; } });
 var formatter_1 = require("./formatter");
@@ -14,3 +14,5 @@ var colorful_1 = require("./colorful");
 Object.defineProperty(exports, "Colorful", { enumerable: true, get: function () { return __importDefault(colorful_1).default; } });
 var imagefull_1 = require("./imagefull");
 Object.defineProperty(exports, "ImageFull", { enumerable: true, get: function () { return __importDefault(imagefull_1).default; } });
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return __importDefault(logger_1).default; } });

package/dist/lib/logger.d.ts

@@ -0,0 +1,43 @@
+import { LoggerOptions } from 'winston';
+/**
+ * Service for logging information, warnings, and errors using Winston.
+ */
+declare class LoggerService {
+    private logger;
+    /**
+     * Creates an instance of LoggerService.
+     * @param config - The configuration options for Winston logger.
+     */
+    constructor(config: LoggerOptions);
+    /**
+     * Logs an informational message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    info(className: string, functionName: string, logMessage: string, userIp: string): void;
+    /**
+     * Logs a warning message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    warn(className: string, functionName: string, logMessage: string, userIp: string): void;
+    /**
+     * Logs an error message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    error(className: string, functionName: string, logMessage: string, userIp: string, data?: Object): void;
+    private createLogMessage;
+    private log;
+}
+declare const Logger: LoggerService;
+export default Logger;

package/dist/lib/logger.js

@@ -0,0 +1,92 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston_1 = __importDefault(require("winston"));
+const config_1 = require("../config");
+/**
+ * Service for logging information, warnings, and errors using Winston.
+ */
+class LoggerService {
+    /**
+     * Creates an instance of LoggerService.
+     * @param config - The configuration options for Winston logger.
+     */
+    constructor(config) {
+        this.logger = winston_1.default.createLogger({
+            ...config,
+            level: process.env.LOG_LEVEL,
+        });
+        if (process.env.NODE_ENV === 'local') {
+            this.logger.add(new winston_1.default.transports.Console({
+                level: 'info',
+                format: winston_1.default.format.combine(winston_1.default.format.simple(), winston_1.default.format.colorize(), winston_1.default.format.printf(({ level, message }) => {
+                    return `[${level}]: ${JSON.stringify(message)}`;
+                    // Parse the message as JSON and include in the log
+                })),
+            }));
+        }
+        this.logger.level = process.env.LOG_LEVEL;
+    }
+    /**
+     * Logs an informational message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    info(className, functionName, logMessage, userIp) {
+        const message = this.createLogMessage(className, functionName, logMessage, userIp);
+        this.log('info', message);
+    }
+    /**
+     * Logs a warning message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    warn(className, functionName, logMessage, userIp) {
+        const message = this.createLogMessage(className, functionName, logMessage, userIp);
+        this.log('warn', message);
+    }
+    /**
+     * Logs an error message.
+     * @param className - The name of the class that generated the log.
+     * @param functionName - The name of the function that generated the log.
+     * @param logMessage - The log message text.
+     * @param userIp - The user's IP address associated with the log.
+     * @param data - Additional data associated with the log.
+     */
+    error(className, functionName, logMessage, userIp, data = {}) {
+        const message = this.createLogMessage(className, functionName, logMessage, userIp, data);
+        this.log('error', message);
+    }
+    createLogMessage(className, functionName, logMessage, userIp, data = {}) {
+        return {
+            className,
+            functionName,
+            logMessage,
+            userIp,
+            data,
+        };
+    }
+    log(level, logMessage) {
+        this.logger.log({
+            level,
+            //@ts-ignore
+            message: logMessage,
+        });
+        process.on('unhandledRejection', (reason, promise) => {
+            this.logger.error('Unhandled Rejection at:', promise, 'reason:', reason);
+        });
+        process.on('uncaughtException', (err) => {
+            this.logger.error('Uncaught Exception:', err);
+        });
+    }
+}
+const Logger = new LoggerService(config_1.WinstonConfiguaration);
+exports.default = Logger;

package/example.env

@@ -0,0 +1,6 @@
+ELASTICSEARCH_USERNAME=
+ELASTICSEARCH_PASSWORD=
+ELASTICSEARCH_NODE=
+SERVER_NICKNAME=
+NODE_ENV=
+LOG_LEVEL=info

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mhmdhammoud/meritt-utils",
-	"version": "1.2.0",
+	"version": "1.3.0",
 	"description": "",
 	"main": "./dist/index.js",
 	"private": false,
@@ -40,6 +40,9 @@
 	"license": "ISC",
 	"dependencies": {
 		"axios": "^1.4.0",
-		"imagesloaded": "^5.0.0"
+		"dotenv": "^16.4.1",
+		"imagesloaded": "^5.0.0",
+		"winston": "^3.11.0",
+		"winston-elasticsearch": "^0.17.4"
 	}
 }

package/src/config/index.ts

@@ -0,0 +1 @@
+export {default as WinstonConfiguaration} from './logger-config'

package/src/config/logger-config.ts

@@ -0,0 +1,73 @@
+import {ElasticsearchTransport} from 'winston-elasticsearch'
+import * as dotenv from 'dotenv'
+dotenv.config()
+const {
+	ELASTICSEARCH_USERNAME,
+	ELASTICSEARCH_PASSWORD,
+	ELASTICSEARCH_NODE,
+	SERVER_NICKNAME,
+	LOG_LEVEL,
+} = process.env
+
+const transports =
+	process.env.NODE_ENV !== 'local'
+		? [
+				// Elasticsearch Transport for 'info' logs
+				new ElasticsearchTransport({
+					level: 'info',
+					indexPrefix: process.env.SERVER_NICKNAME, // Index prefix for Elasticsearch
+					clientOpts: {
+						node: ELASTICSEARCH_NODE,
+						tls: {
+							rejectUnauthorized: false, // Only for development, not recommended in production
+						},
+						auth: {
+							username: ELASTICSEARCH_USERNAME,
+							password: ELASTICSEARCH_PASSWORD,
+						},
+					},
+					// format: winston.format.combine(winston.format.json()), // Adjust as needed
+				}),
+
+				// Elasticsearch Transport for 'warn' logs
+				new ElasticsearchTransport({
+					level: LOG_LEVEL,
+					indexPrefix: SERVER_NICKNAME, // Index prefix for Elasticsearch
+					clientOpts: {
+						node: ELASTICSEARCH_NODE,
+						tls: {
+							rejectUnauthorized: false, // Only for development, not recommended in production
+						},
+						auth: {
+							username: ELASTICSEARCH_USERNAME,
+							password: ELASTICSEARCH_PASSWORD,
+						},
+					},
+					// format: winston.format.combine(winston.format.json()), // Adjust as needed
+				}),
+
+				// Elasticsearch Transport for 'error' logs
+				new ElasticsearchTransport({
+					level: 'error',
+					indexPrefix: process.env.SERVER_NICKNAME, // Index prefix for Elasticsearch
+					clientOpts: {
+						node: ELASTICSEARCH_NODE,
+						tls: {
+							rejectUnauthorized: false, // Only for development, not recommended in production
+						},
+						auth: {
+							username: ELASTICSEARCH_USERNAME,
+							password: ELASTICSEARCH_PASSWORD,
+						},
+					},
+					// format: winston.format.combine(winston.format.json()), // Adjust as needed
+				}),
+				// eslint-disable-next-line no-mixed-spaces-and-tabs
+		  ]
+		: []
+
+const loggerConfiguration = {
+	transports,
+}
+
+export default loggerConfiguration

package/src/env.d.ts

@@ -0,0 +1,9 @@
+declare namespace NodeJS {
+	export interface ProcessEnv {
+		NODE_ENV: 'development' | 'production' | 'test' | 'local'
+		ELASTICSEARCH_NODE: string
+		ELASTICSEARCH_USERNAME: string
+		ELASTICSEARCH_PASSWORD: string
+		LOG_LEVEL: string
+	}
+}

package/src/index.ts

@@ -1 +1 @@
-export {Crypto, Formatter, Colorful} from './lib'
+export * from './lib'

package/src/lib/index.ts

@@ -3,3 +3,4 @@ export {default as Formatter} from './formatter'
 export {default as Pdf} from './formatter'
 export {default as Colorful} from './colorful'
 export {default as ImageFull} from './imagefull'
+export {default as Logger} from './logger'

package/src/lib/logger.ts

@@ -0,0 +1,172 @@
+import Winston, {Logger as WinstonLogger, LoggerOptions} from 'winston'
+import {WinstonConfiguaration} from '../config'
+
+/**
+ * Represents a log message with structured information.
+ */
+interface LogMessage {
+	/**
+	 * The name of the class that generated the log.
+	 */
+	className: string
+
+	/**
+	 * The name of the function that generated the log.
+	 */
+	functionName: string
+
+	/**
+	 * The log message text.
+	 */
+	logMessage: string
+
+	/**
+	 * The user's IP address associated with the log.
+	 */
+	userIp: string
+
+	/**
+	 * Additional data associated with the log.
+	 */
+	data?: Record<string, any>
+}
+
+/**
+ * Service for logging information, warnings, and errors using Winston.
+ */
+class LoggerService {
+	private logger: WinstonLogger
+
+	/**
+	 * Creates an instance of LoggerService.
+	 * @param config - The configuration options for Winston logger.
+	 */
+	constructor(config: LoggerOptions) {
+		this.logger = Winston.createLogger({
+			...config,
+			level: process.env.LOG_LEVEL,
+		})
+		if (process.env.NODE_ENV === 'local') {
+			this.logger.add(
+				new Winston.transports.Console({
+					level: 'info',
+					format: Winston.format.combine(
+						Winston.format.simple(),
+						Winston.format.colorize(),
+						Winston.format.printf(({level, message}) => {
+							return `[${level}]: ${JSON.stringify(message)}`
+							// Parse the message as JSON and include in the log
+						})
+					),
+				})
+			)
+		}
+
+		this.logger.level = process.env.LOG_LEVEL
+	}
+
+	/**
+	 * Logs an informational message.
+	 * @param className - The name of the class that generated the log.
+	 * @param functionName - The name of the function that generated the log.
+	 * @param logMessage - The log message text.
+	 * @param userIp - The user's IP address associated with the log.
+	 * @param data - Additional data associated with the log.
+	 */
+	info(
+		className: string,
+		functionName: string,
+		logMessage: string,
+		userIp: string
+	): void {
+		const message = this.createLogMessage(
+			className,
+			functionName,
+			logMessage,
+			userIp
+		)
+		this.log('info', message)
+	}
+
+	/**
+	 * Logs a warning message.
+	 * @param className - The name of the class that generated the log.
+	 * @param functionName - The name of the function that generated the log.
+	 * @param logMessage - The log message text.
+	 * @param userIp - The user's IP address associated with the log.
+	 * @param data - Additional data associated with the log.
+	 */
+	warn(
+		className: string,
+		functionName: string,
+		logMessage: string,
+		userIp: string
+	): void {
+		const message = this.createLogMessage(
+			className,
+			functionName,
+			logMessage,
+			userIp
+		)
+		this.log('warn', message)
+	}
+
+	/**
+	 * Logs an error message.
+	 * @param className - The name of the class that generated the log.
+	 * @param functionName - The name of the function that generated the log.
+	 * @param logMessage - The log message text.
+	 * @param userIp - The user's IP address associated with the log.
+	 * @param data - Additional data associated with the log.
+	 */
+	error(
+		className: string,
+		functionName: string,
+		logMessage: string,
+		userIp: string,
+		data: Object = {}
+	): void {
+		const message = this.createLogMessage(
+			className,
+			functionName,
+			logMessage,
+			userIp,
+			data
+		)
+		this.log('error', message)
+	}
+
+	private createLogMessage(
+		className: string,
+		functionName: string,
+		logMessage: string,
+		userIp: string,
+		data: Record<string, any> = {}
+	): LogMessage {
+		return {
+			className,
+			functionName,
+			logMessage,
+			userIp,
+			data,
+		}
+	}
+
+	private log(level: string, logMessage: LogMessage): void {
+		this.logger.log({
+			level,
+			//@ts-ignore
+			message: logMessage,
+		})
+		process.on('unhandledRejection', (reason, promise) => {
+			this.logger.error('Unhandled Rejection at:', promise, 'reason:', reason)
+		})
+
+		process.on('uncaughtException', (err) => {
+			this.logger.error('Uncaught Exception:', err)
+		})
+	}
+}
+
+const Logger = new LoggerService(WinstonConfiguaration)
+export default Logger