@athenna/logger 1.0.5 → 1.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "description": "",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -153,8 +153,9 @@
     }
   },
   "dependencies": {
-    "@athenna/ioc": "1.0.7",
+    "@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/Drivers/ConsoleDriver.d.ts

@@ -14,12 +14,12 @@ export interface ConsoleDriverOpts {
     context: string;
     formatter: string;
     streamType: string;
+    formatterConfig: any;
 }
 export declare class ConsoleDriver implements DriverContract {
-    private readonly _level;
-    private readonly _context;
     private readonly _formatter;
     private readonly _streamType;
+    private readonly _formatterConfig;
     constructor(channel: string, configs?: any);
     transport(message: string, options?: ConsoleDriverOpts): void;
 }

package/src/Drivers/ConsoleDriver.js

@@ -14,19 +14,17 @@ const FormatterFactory_1 = require("../Factories/FormatterFactory");
 class ConsoleDriver {
     constructor(channel, configs = {}) {
         const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this._level = configs.level || channelConfig.level;
-        this._context = configs.context || channelConfig.context;
         this._formatter = configs.formatter || channelConfig.formatter;
         this._streamType = configs.streamType || channelConfig.streamType;
+        this._formatterConfig =
+            configs.formatterConfig || channelConfig.formatterConfig;
     }
     transport(message, options) {
         options = Object.assign({}, {
-            level: this._level,
-            context: this._context,
             formatter: this._formatter,
             streamType: this._streamType,
         }, options);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, options);
+        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, options.formatterConfig || this._formatterConfig);
         process[options.streamType].write(`${message}\n`);
     }
 }

package/src/Drivers/DebugDriver.d.ts

@@ -14,12 +14,12 @@ export interface DebugDriverOpts {
     context: string;
     formatter: string;
     namespace: string;
+    formatterConfig: any;
 }
 export declare class DebugDriver implements DriverContract {
-    private readonly _level;
-    private readonly _context;
     private readonly _formatter;
     private readonly _namespace;
+    private readonly _formatterConfig;
     constructor(channel: string, configs?: any);
     transport(message: string, options?: DebugDriverOpts): void;
 }

package/src/Drivers/DebugDriver.js

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

package/src/Drivers/FileDriver.d.ts

@@ -12,12 +12,12 @@ export interface FileDriverOpts {
     context: string;
     formatter: string;
     filePath: string;
+    formatterConfig: any;
 }
 export declare class FileDriver implements DriverContract {
-    private readonly _level;
-    private readonly _context;
     private readonly _filePath;
     private readonly _formatter;
+    private readonly _formatterConfig;
     constructor(channel: string, configs?: any);
     transport(message: string, options?: FileDriverOpts): Promise<void>;
 }

package/src/Drivers/FileDriver.js

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

package/src/Logger.d.ts

@@ -4,16 +4,18 @@ export declare class Logger {
     private runtimeConfig;
     private channelName;
     private driver;
-    static buildDriver(name: string, driver: new (channel: string, configs?: any) => DriverContract): void;
-    static buildFormatter(name: string, formatter: new () => FormatterContract): void;
+    constructor(runtimeConfig?: any);
     static get drivers(): string[];
     static get formatters(): string[];
-    constructor(runtimeConfig?: any);
+    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?: any): Promise<void>;
-    info(message: any, options?: any): Promise<void>;
-    warn(message: any, options?: any): Promise<void>;
-    error(message: any, options?: any): Promise<void>;
-    debug(message: any, options?: any): Promise<void>;
-    success(message: any, options?: any): Promise<void>;
+    log(message: any, options?: {}): void | Promise<void>;
+    info(message: any, options?: {}): void | Promise<void>;
+    warn(message: any, options?: {}): void | Promise<void>;
+    error(message: any, options?: {}): void | Promise<void>;
+    debug(message: any, options?: {}): void | Promise<void>;
+    success(message: any, options?: {}): void | Promise<void>;
+    private createOptions;
 }

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");
@@ -12,17 +16,39 @@ class Logger {
         this.channelName = 'default';
         this.driver = DriverFactory_1.DriverFactory.fabricate(this.channelName, this.runtimeConfig);
     }
+    static get drivers() {
+        return DriverFactory_1.DriverFactory.availableDrivers();
+    }
+    static get formatters() {
+        return FormatterFactory_1.FormatterFactory.availableFormatters();
+    }
     static buildDriver(name, driver) {
         DriverFactory_1.DriverFactory.createDriver(name, driver);
     }
     static buildFormatter(name, formatter) {
         FormatterFactory_1.FormatterFactory.createFormatter(name, formatter);
     }
-    static get drivers() {
-        return DriverFactory_1.DriverFactory.availableDrivers();
-    }
-    static get formatters() {
-        return FormatterFactory_1.FormatterFactory.availableFormatters();
+    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)
@@ -30,80 +56,86 @@ class Logger {
         this.driver = DriverFactory_1.DriverFactory.fabricate(channel, this.runtimeConfig);
         return this;
     }
-    async log(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
-                ...this.runtimeConfig.formatterConfig,
-            };
-        }
-        await this.driver.transport(message, options);
+    log(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
     }
-    async info(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        options.level = 'INFO';
-        options.color = Color_1.Color.cyan;
-        options.streamType = 'stdout';
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
-                ...this.runtimeConfig.formatterConfig,
-            };
-        }
-        await this.driver.transport(message, options);
+    info(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+            formatterConfig: {
+                level: 'INFO',
+                color: Color_1.Color.cyan,
+            },
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
     }
-    async warn(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        options.level = 'WARN';
-        options.color = Color_1.Color.orange;
-        options.streamType = 'stdout';
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
-                ...this.runtimeConfig.formatterConfig,
-            };
-        }
-        await this.driver.transport(message, options);
+    warn(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+            formatterConfig: {
+                level: 'WARN',
+                color: Color_1.Color.orange,
+            },
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
     }
-    async error(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        options.level = 'ERROR';
-        options.color = Color_1.Color.red;
-        options.streamType = 'stderr';
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
-                ...this.runtimeConfig.formatterConfig,
-            };
-        }
-        await this.driver.transport(message, options);
+    error(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+            formatterConfig: {
+                level: 'ERROR',
+                color: Color_1.Color.red,
+            },
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
     }
-    async debug(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        options.level = 'DEBUG';
-        options.color = Color_1.Color.purple;
-        options.streamType = 'stdout';
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
-                ...this.runtimeConfig.formatterConfig,
-            };
-        }
-        await this.driver.transport(message, options);
+    debug(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+            formatterConfig: {
+                level: 'DEBUG',
+                color: Color_1.Color.purple,
+            },
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
+    }
+    success(message, options = {}) {
+        options = this.createOptions(options, {
+            streamType: 'stdout',
+            formatterConfig: {
+                level: 'SUCCESS',
+                color: Color_1.Color.green,
+            },
+        });
+        message = Logger.applyLogEngine(message);
+        return this.driver.transport(message, options);
     }
-    async success(message, options) {
-        options = Object.assign({}, { context: 'Logger' }, options);
-        options.level = 'SUCCESS';
-        options.color = Color_1.Color.green;
-        options.streamType = 'stdout';
-        if (this.runtimeConfig && this.runtimeConfig.formatterConfig) {
-            options = {
-                ...options,
+    createOptions(options, defaultValues) {
+        let formatterConfig = Object.assign({}, {
+            ...defaultValues.formatterConfig,
+        }, options.formatterConfig);
+        if (this.runtimeConfig.formatterConfig) {
+            formatterConfig = {
                 ...this.runtimeConfig.formatterConfig,
+                ...formatterConfig,
             };
         }
-        await this.driver.transport(message, options);
+        options = Object.assign({}, {
+            streamType: 'stdout',
+        }, options);
+        options = {
+            ...options,
+            formatterConfig,
+        };
+        return options;
     }
 }
 exports.Logger = Logger;

package/src/Providers/LoggerProvider.d.ts

@@ -8,6 +8,10 @@
  */
 import { ServiceProvider } from '@athenna/ioc';
 export declare class LoggerProvider extends ServiceProvider {
-    boot(): void;
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
     register(): void;
 }

package/src/Providers/LoggerProvider.js

@@ -12,7 +12,11 @@ exports.LoggerProvider = void 0;
 const Logger_1 = require("../Logger");
 const ioc_1 = require("@athenna/ioc");
 class LoggerProvider extends ioc_1.ServiceProvider {
-    boot() { }
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
     register() {
         this.container.bind('Athenna/Core/Logger', Logger_1.Logger);
     }

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;