@athenna/logger 1.0.7 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -155,6 +155,7 @@
   "dependencies": {
     "@athenna/ioc": "1.0.9",
     "@secjs/utils": "1.8.0",
+    "chalk": "4.1.1",
     "reflect-metadata": "0.1.13",
     "tscpaths": "0.0.9"
   }

package/src/Contracts/LevelTypes.d.ts

@@ -0,0 +1 @@
+export declare type LevelTypes = 'info' | 'INFO' | 'debug' | 'DEBUG' | 'warn' | 'WARN' | 'error' | 'ERROR' | 'success' | 'SUCCESS';

package/src/Contracts/LevelTypes.js

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

package/src/Drivers/ConsoleDriver.js

@@ -16,15 +16,15 @@ class ConsoleDriver {
         const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
         this._formatter = configs.formatter || channelConfig.formatter;
         this._streamType = configs.streamType || channelConfig.streamType;
-        this._formatterConfig =
-            configs.formatterConfig || channelConfig.formatterConfig;
+        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
     }
     transport(message, options) {
         options = Object.assign({}, {
             formatter: this._formatter,
             streamType: this._streamType,
         }, options);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, options.formatterConfig || this._formatterConfig);
+        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
+        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
         process[options.streamType].write(`${message}\n`);
     }
 }

package/src/Drivers/DebugDriver.js

@@ -17,15 +17,15 @@ class DebugDriver {
         const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
         this._formatter = configs.formatter || channelConfig.formatter;
         this._namespace = configs.namespace || channelConfig.namespace;
-        this._formatterConfig =
-            configs.formatterConfig || channelConfig.formatterConfig;
+        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
     }
     transport(message, options) {
         options = Object.assign({}, {
             formatter: this._formatter,
             namespace: this._namespace,
         }, options);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, options.formatterConfig || this._formatterConfig);
+        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
+        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
         debug_1.debug(options.namespace)(message);
     }
 }

package/src/Drivers/FileDriver.js

@@ -19,8 +19,7 @@ class FileDriver {
         const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
         this._filePath = configs.filePath || channelConfig.filePath;
         this._formatter = configs.formatter || channelConfig.formatter;
-        this._formatterConfig =
-            configs.formatterConfig || channelConfig.formatterConfig;
+        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
     }
     async transport(message, options) {
         options = Object.assign({}, {
@@ -32,7 +31,8 @@ class FileDriver {
         if (!fs_1.existsSync(dir)) {
             fs_1.mkdirSync(dir, { recursive: true });
         }
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, options.formatterConfig || this._formatterConfig);
+        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
+        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
         return new Promise((resolve, reject) => {
             const stream = fs_1.createWriteStream(filePath, { flags: 'a' });
             stream.write(`${Color_1.Color.removeColors(message)}` + '\n');

package/src/Factories/FormatterFactory.js

@@ -9,12 +9,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormatterFactory = void 0;
-const LogFormatter_1 = require("../Formatters/LogFormatter");
 const JsonFormatter_1 = require("../Formatters/JsonFormatter");
-const DebugFormatter_1 = require("../Formatters/DebugFormatter");
-const ContextFormatter_1 = require("../Formatters/ContextFormatter");
+const NestFormatter_1 = require("../Formatters/NestFormatter");
+const SimpleFormatter_1 = require("../Formatters/SimpleFormatter");
 const NotFoundFormatterException_1 = require("../Exceptions/NotFoundFormatterException");
 const FormatterAlreadyExistException_1 = require("../Exceptions/FormatterAlreadyExistException");
+const CliFormatter_1 = require("../Formatters/CliFormatter");
 class FormatterFactory {
     static availableFormatters() {
         const availableFormatters = [];
@@ -39,7 +39,7 @@ class FormatterFactory {
 }
 exports.FormatterFactory = FormatterFactory;
 FormatterFactory.formatters = new Map()
-    .set('context', { Formatter: ContextFormatter_1.ContextFormatter })
-    .set('debug', { Formatter: DebugFormatter_1.DebugFormatter })
+    .set('cli', { Formatter: CliFormatter_1.CliFormatter })
+    .set('nest', { Formatter: NestFormatter_1.NestFormatter })
     .set('json', { Formatter: JsonFormatter_1.JsonFormatter })
-    .set('log', { Formatter: LogFormatter_1.LogFormatter });
+    .set('simple', { Formatter: SimpleFormatter_1.SimpleFormatter });

package/src/Formatters/{LogFormatter.d.ts → CliFormatter.d.ts}

@@ -7,12 +7,13 @@
  * file that was distributed with this source code.
  */
 import { Chalk } from 'chalk';
+import { LevelTypes } from '../Contracts/LevelTypes';
 import { FormatterContract } from '../Contracts/FormatterContract';
-export interface LogFormatterOptions {
-    color: Chalk;
-    level: 'INFO' | 'DEBUG' | 'WARN' | 'ERROR' | 'SUCCESS';
+export interface CliFormatterOptions {
+    chalk: Chalk;
+    level: LevelTypes;
 }
-export declare class LogFormatter implements FormatterContract {
-    format(message: string, options?: LogFormatterOptions): string;
+export declare class CliFormatter implements FormatterContract {
     private static paintByLevel;
+    format(message: string, options: CliFormatterOptions): string;
 }

package/src/Formatters/CliFormatter.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliFormatter = void 0;
+const Color_1 = require("../Utils/Color");
+class CliFormatter {
+    static paintByLevel(level) {
+        const levelColors = {
+            info: Color_1.Color.info,
+            debug: Color_1.Color.debug,
+            warn: Color_1.Color.warning,
+            error: Color_1.Color.error,
+            success: Color_1.Color.log,
+        };
+        return levelColors[level.toLowerCase()](`[  ${level.toLowerCase()}  ]`);
+    }
+    format(message, options) {
+        const level = CliFormatter.paintByLevel(options.level);
+        return `${level} ${message}`;
+    }
+}
+exports.CliFormatter = CliFormatter;

package/src/Formatters/JsonFormatter.d.ts

@@ -9,8 +9,8 @@
 import { Chalk } from 'chalk';
 import { FormatterContract } from '../Contracts/FormatterContract';
 export interface JsonFormatterOptions {
-    color: Chalk;
+    chalk: Chalk;
 }
 export declare class JsonFormatter implements FormatterContract {
-    format(message: Record<any, unknown>, options?: JsonFormatterOptions): string;
+    format(message: Record<any, unknown>, options: JsonFormatterOptions): string;
 }

package/src/Formatters/JsonFormatter.js

@@ -12,9 +12,8 @@ exports.JsonFormatter = void 0;
 const Color_1 = require("../Utils/Color");
 class JsonFormatter {
     format(message, options) {
-        options = Object.assign({}, { color: Color_1.Color.green }, options);
         const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
-        return `${pid} - ${Color_1.Color.bold('JSON:')} ${options.color(JSON.stringify(message, null, 2))}`;
+        return `${pid} - ${Color_1.Color.bold('JSON:')} ${options.chalk(JSON.stringify(message, null, 2))}`;
     }
 }
 exports.JsonFormatter = JsonFormatter;

package/src/Formatters/{ContextFormatter.d.ts → NestFormatter.d.ts}

@@ -9,11 +9,11 @@
 import { Chalk } from 'chalk';
 import { FormatterContract } from '../Contracts/FormatterContract';
 export interface ContextFormatterOptions {
-    color: Chalk;
+    chalk: Chalk;
     context: string;
 }
-export declare class ContextFormatter implements FormatterContract {
-    format(message: string, options?: ContextFormatterOptions): string;
+export declare class NestFormatter implements FormatterContract {
     private static lastTimestamp?;
     private static getTimestampDiff;
+    format(message: string, options: ContextFormatterOptions): string;
 }

package/src/Formatters/{ContextFormatter.js → NestFormatter.js}

@@ -8,18 +8,10 @@
  * file that was distributed with this source code.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextFormatter = void 0;
+exports.NestFormatter = void 0;
 const Color_1 = require("../Utils/Color");
 const getTimestamp_1 = require("../Utils/getTimestamp");
-class ContextFormatter {
-    format(message, options) {
-        options = Object.assign({}, { color: Color_1.Color.green, context: 'Logger' }, options);
-        const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
-        const timestamp = getTimestamp_1.getTimestamp();
-        const messageCtx = Color_1.Color.yellow(`[${options.context}] `);
-        const timestampDiff = ContextFormatter.getTimestampDiff();
-        return `${pid} - ${timestamp} ${messageCtx}${options.color(message)}${timestampDiff}`;
-    }
+class NestFormatter {
     static getTimestampDiff() {
         let result = '';
         if (this.lastTimestamp) {
@@ -28,5 +20,12 @@ class ContextFormatter {
         this.lastTimestamp = Date.now();
         return result;
     }
+    format(message, options) {
+        const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
+        const timestamp = getTimestamp_1.getTimestamp();
+        const messageCtx = Color_1.Color.yellow(`[${options.context}] `);
+        const timestampDiff = NestFormatter.getTimestampDiff();
+        return `${pid} - ${timestamp} ${messageCtx}${options.chalk(message)}${timestampDiff}`;
+    }
 }
-exports.ContextFormatter = ContextFormatter;
+exports.NestFormatter = NestFormatter;

package/src/Formatters/{DebugFormatter.d.ts → SimpleFormatter.d.ts}

@@ -7,14 +7,15 @@
  * file that was distributed with this source code.
  */
 import { Chalk } from 'chalk';
+import { LevelTypes } from '../Contracts/LevelTypes';
 import { FormatterContract } from '../Contracts/FormatterContract';
-export interface DebugFormatterOptions {
-    color: Chalk;
-    context: string;
-    namespace: string;
+export interface LogFormatterOptions {
+    chalk: Chalk;
+    level: LevelTypes;
 }
-export declare class DebugFormatter implements FormatterContract {
-    format(message: string, options?: DebugFormatterOptions): string;
+export declare class SimpleFormatter implements FormatterContract {
     private static lastTimestamp?;
     private static getTimestampDiff;
+    private static paintByLevel;
+    format(message: string, options: LogFormatterOptions): string;
 }

package/src/Formatters/{LogFormatter.js → SimpleFormatter.js}

@@ -8,16 +8,17 @@
  * file that was distributed with this source code.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogFormatter = void 0;
+exports.SimpleFormatter = void 0;
 const Color_1 = require("../Utils/Color");
 const getTimestamp_1 = require("../Utils/getTimestamp");
-class LogFormatter {
-    format(message, options) {
-        options = Object.assign({}, { color: Color_1.Color.green, level: 'info' }, options);
-        const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
-        const timestamp = getTimestamp_1.getTimestamp();
-        const level = LogFormatter.paintByLevel(options.level);
-        return `${pid} - ${timestamp} ${level} ${options.color(message)}`;
+class SimpleFormatter {
+    static getTimestampDiff() {
+        let result = '';
+        if (this.lastTimestamp) {
+            result = Color_1.Color.yellow(` +${Date.now() - this.lastTimestamp}ms`);
+        }
+        this.lastTimestamp = Date.now();
+        return result;
     }
     static paintByLevel(level) {
         const levelColors = {
@@ -27,7 +28,13 @@ class LogFormatter {
             error: Color_1.Color.error,
             success: Color_1.Color.log,
         };
-        return levelColors[level.toLowerCase()](`[${level}]`);
+        return levelColors[level.toLowerCase()](`[${level.toUpperCase()}]`);
+    }
+    format(message, options) {
+        const timestamp = getTimestamp_1.getTimestamp();
+        const timestampDiff = SimpleFormatter.getTimestampDiff();
+        const level = SimpleFormatter.paintByLevel(options.level);
+        return `${level} - ${timestamp} ${options.chalk(message)}${timestampDiff}`;
     }
 }
-exports.LogFormatter = LogFormatter;
+exports.SimpleFormatter = SimpleFormatter;

package/src/Logger.d.ts

@@ -9,6 +9,7 @@ export declare class Logger {
     static get formatters(): string[];
     static buildDriver(name: string, driver: new (channel: string, configs?: any) => DriverContract): void;
     static buildFormatter(name: string, formatter: new () => FormatterContract): void;
+    private static applyLogEngine;
     channel(channel: string, runtimeConfig?: any): Logger;
     log(message: any, options?: {}): void | Promise<void>;
     info(message: any, options?: {}): void | Promise<void>;

package/src/Logger.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
+const chalk_1 = __importDefault(require("chalk"));
 const Color_1 = require("./Utils/Color");
 const utils_1 = require("@secjs/utils");
 const DriverFactory_1 = require("./Factories/DriverFactory");
@@ -24,6 +28,28 @@ class Logger {
     static buildFormatter(name, formatter) {
         FormatterFactory_1.FormatterFactory.createFormatter(name, formatter);
     }
+    static applyLogEngine(content) {
+        if (utils_1.Is.String(content)) {
+            const matches = content.match(/\({(.*?)} (.*?)\)/);
+            if (matches) {
+                const chalkMethodsString = matches[1].replace(/\s/g, '');
+                const chalkMethodsArray = chalkMethodsString.split(',');
+                const message = matches[2];
+                let chalk = chalk_1.default;
+                chalkMethodsArray.forEach(chalkMethod => {
+                    if (!chalk[chalkMethod])
+                        return;
+                    chalk = chalk[chalkMethod];
+                });
+                content = content
+                    .replace(`({${matches[1]}} `, '')
+                    .replace(`({${matches[1]}}`, '')
+                    .replace(`${matches[2]})`, chalk(message));
+            }
+            return content;
+        }
+        return content;
+    }
     channel(channel, runtimeConfig) {
         if (runtimeConfig)
             this.runtimeConfig = runtimeConfig;
@@ -34,6 +60,7 @@ class Logger {
         options = this.createOptions(options, {
             streamType: 'stdout',
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     info(message, options = {}) {
@@ -41,9 +68,10 @@ class Logger {
             streamType: 'stdout',
             formatterConfig: {
                 level: 'INFO',
-                color: Color_1.Color.cyan,
+                chalk: Color_1.Color.cyan,
             },
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     warn(message, options = {}) {
@@ -51,9 +79,10 @@ class Logger {
             streamType: 'stdout',
             formatterConfig: {
                 level: 'WARN',
-                color: Color_1.Color.orange,
+                chalk: Color_1.Color.orange,
             },
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     error(message, options = {}) {
@@ -61,9 +90,10 @@ class Logger {
             streamType: 'stdout',
             formatterConfig: {
                 level: 'ERROR',
-                color: Color_1.Color.red,
+                chalk: Color_1.Color.red,
             },
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     debug(message, options = {}) {
@@ -71,9 +101,10 @@ class Logger {
             streamType: 'stdout',
             formatterConfig: {
                 level: 'DEBUG',
-                color: Color_1.Color.purple,
+                chalk: Color_1.Color.purple,
             },
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     success(message, options = {}) {
@@ -81,9 +112,10 @@ class Logger {
             streamType: 'stdout',
             formatterConfig: {
                 level: 'SUCCESS',
-                color: Color_1.Color.green,
+                chalk: Color_1.Color.green,
             },
         });
+        message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
     createOptions(options, defaultValues) {

package/src/Utils/Color.d.ts

@@ -6,11 +6,19 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Chalk } from 'chalk';
+import chalk, { Chalk } from 'chalk';
 declare type Methods = 'GET' | 'POST' | 'PUT' | 'DELETE';
 export declare class Color {
-    static chalk: Chalk & {
-        supportsColor: import("chalk").ColorSupport;
+    static chalk: chalk.Chalk & chalk.ChalkFunction & {
+        supportsColor: false | chalk.ColorSupport;
+        Level: chalk.Level;
+        Color: ("black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright");
+        ForegroundColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
+        BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";
+        Modifiers: "reset" | "bold" | "dim" | "italic" | "underline" | "inverse" | "hidden" | "strikethrough" | "visible";
+        stderr: chalk.Chalk & {
+            supportsColor: false | chalk.ColorSupport;
+        };
     };
     static get bold(): Chalk;
     static get purple(): Chalk;

package/src/Formatters/DebugFormatter.js

@@ -1,32 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DebugFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-const getTimestamp_1 = require("../Utils/getTimestamp");
-class DebugFormatter {
-    format(message, options) {
-        options = Object.assign({}, { color: Color_1.Color.green, context: 'Debugger', namespace: 'api:main' }, options);
-        const pid = Color_1.Color.yellow(`[Athenna Debugger] - PID: ${process.pid}`);
-        const timestamp = Color_1.Color.white(getTimestamp_1.getTimestamp());
-        const messageCtx = Color_1.Color.yellow(`[${options.context}] `);
-        const timestampDiff = DebugFormatter.getTimestampDiff();
-        return `${pid} - ${timestamp} ${messageCtx}${options.color(message)}${timestampDiff}`;
-    }
-    static getTimestampDiff() {
-        let result = '';
-        if (this.lastTimestamp) {
-            result = Color_1.Color.yellow(` +${Date.now() - this.lastTimestamp}ms`);
-        }
-        this.lastTimestamp = Date.now();
-        return result;
-    }
-}
-exports.DebugFormatter = DebugFormatter;