@athenna/logger 1.1.4 → 1.1.7

package/index.d.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 export * from './src/Logger';
+export * from './src/Facades/Log';
 export * from './src/Utils/Color';
 export * from './src/Contracts/DriverContract';
 export * from './src/Contracts/FormatterContract';

package/index.js

@@ -19,6 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./src/Logger"), exports);
+__exportStar(require("./src/Facades/Log"), exports);
 __exportStar(require("./src/Utils/Color"), exports);
 __exportStar(require("./src/Contracts/DriverContract"), exports);
 __exportStar(require("./src/Contracts/FormatterContract"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "1.1.4",
+  "version": "1.1.7",
   "description": "",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -153,7 +153,7 @@
     }
   },
   "dependencies": {
-    "@athenna/ioc": "1.1.2",
+    "@athenna/ioc": "1.1.3",
     "@secjs/utils": "1.8.3",
     "chalk": "4.1.1",
     "reflect-metadata": "0.1.13",

package/src/Facades/Log.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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.
+ */
+import { Logger } from '../Logger';
+export declare const Log: Logger;

package/src/Facades/Log.js

@@ -0,0 +1,13 @@
+"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.Log = void 0;
+const ioc_1 = require("@athenna/ioc");
+exports.Log = ioc_1.Facade.createFor('Athenna/Core/Logger');

package/src/Logger.d.ts

@@ -1,21 +1,110 @@
 import { DriverContract } from './Contracts/DriverContract';
 import { FormatterContract } from './Contracts/FormatterContract';
 export declare class Logger {
+    /**
+     * Runtime configurations to be used inside the Drivers and Formatters.
+     * @private
+     */
     private runtimeConfig;
-    private channelName;
+    /**
+     * The driver responsible for transporting the logs.
+     * @private
+     */
     private driver;
-    constructor(runtimeConfig?: any);
+    /**
+     * The log channel selected with driver and formatter configurations.
+     * @private
+     */
+    private channelName;
+    /**
+     * Creates a new instance of Logger.
+     *
+     * @return {Logger}
+     */
+    constructor();
+    /**
+     * Return all drivers available.
+     */
     static get drivers(): string[];
+    /**
+     * Return all formatters available.
+     */
     static get formatters(): string[];
+    /**
+     * Builds a new driver to use within Logger class.
+     *
+     * @param name
+     * @param driver
+     */
     static buildDriver(name: string, driver: new (channel: string, configs?: any) => DriverContract): void;
+    /**
+     * Builds a new formatter to use within Logger class.
+     *
+     * @param name
+     * @param formatter
+     */
     static buildFormatter(name: string, formatter: new () => FormatterContract): void;
+    /**
+     * Applies the log engine to execute chalk methods of string.
+     *
+     * @param content
+     * @private
+     */
     private static applyLogEngine;
+    /**
+     * Change the log channel.
+     *
+     * @param channel
+     * @param runtimeConfig
+     */
     channel(channel: string, runtimeConfig?: any): Logger;
+    /**
+     * Creates a log of type log in channel.
+     * @param message
+     * @param options
+     */
     log(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Creates a log of type info in channel.
+     *
+     * @param message
+     * @param options
+     */
     info(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Creates a log of type warn in channel.
+     *
+     * @param message
+     * @param options
+     */
     warn(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Creates a log of type error in channel.
+     *
+     * @param message
+     * @param options
+     */
     error(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Creates a log of type debug in channel.
+     *
+     * @param message
+     * @param options
+     */
     debug(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Creates a log of type success in channel.
+     *
+     * @param message
+     * @param options
+     */
     success(message: any, options?: {}): void | Promise<void>;
+    /**
+     * Create options concatenating client options with default options.
+     *
+     * @param options
+     * @param defaultValues
+     * @private
+     */
     private createOptions;
 }

package/src/Logger.js

@@ -10,23 +10,60 @@ const Color_1 = require("./Utils/Color");
 const DriverFactory_1 = require("./Factories/DriverFactory");
 const FormatterFactory_1 = require("./Factories/FormatterFactory");
 class Logger {
-    constructor(runtimeConfig = {}) {
-        this.runtimeConfig = runtimeConfig;
+    /**
+     * Creates a new instance of Logger.
+     *
+     * @return {Logger}
+     */
+    constructor() {
+        /**
+         * Runtime configurations to be used inside the Drivers and Formatters.
+         * @private
+         */
+        this.runtimeConfig = {};
+        /**
+         * The log channel selected with driver and formatter configurations.
+         * @private
+         */
         this.channelName = 'default';
         this.driver = DriverFactory_1.DriverFactory.fabricate(this.channelName, this.runtimeConfig);
     }
+    /**
+     * Return all drivers available.
+     */
     static get drivers() {
         return DriverFactory_1.DriverFactory.availableDrivers();
     }
+    /**
+     * Return all formatters available.
+     */
     static get formatters() {
         return FormatterFactory_1.FormatterFactory.availableFormatters();
     }
+    /**
+     * Builds a new driver to use within Logger class.
+     *
+     * @param name
+     * @param driver
+     */
     static buildDriver(name, driver) {
         DriverFactory_1.DriverFactory.createDriver(name, driver);
     }
+    /**
+     * Builds a new formatter to use within Logger class.
+     *
+     * @param name
+     * @param formatter
+     */
     static buildFormatter(name, formatter) {
         FormatterFactory_1.FormatterFactory.createFormatter(name, formatter);
     }
+    /**
+     * Applies the log engine to execute chalk methods of string.
+     *
+     * @param content
+     * @private
+     */
     static applyLogEngine(content) {
         if (utils_1.Is.String(content)) {
             const matches = content.match(/\({(.*?)} (.*?)\)/);
@@ -49,22 +86,37 @@ class Logger {
         }
         return content;
     }
+    /**
+     * Change the log channel.
+     *
+     * @param channel
+     * @param runtimeConfig
+     */
     channel(channel, runtimeConfig) {
         if (runtimeConfig)
             this.runtimeConfig = runtimeConfig;
         this.driver = DriverFactory_1.DriverFactory.fabricate(channel, this.runtimeConfig);
+        this.channelName = channel;
         return this;
     }
+    /**
+     * Creates a log of type log in channel.
+     * @param message
+     * @param options
+     */
     log(message, options = {}) {
-        options = this.createOptions(options, {
-            streamType: 'stdout',
-        });
+        options = this.createOptions(options, {});
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Creates a log of type info in channel.
+     *
+     * @param message
+     * @param options
+     */
     info(message, options = {}) {
         options = this.createOptions(options, {
-            streamType: 'stdout',
             formatterConfig: {
                 level: 'INFO',
                 chalk: Color_1.Color.cyan,
@@ -73,6 +125,12 @@ class Logger {
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Creates a log of type warn in channel.
+     *
+     * @param message
+     * @param options
+     */
     warn(message, options = {}) {
         options = this.createOptions(options, {
             streamType: 'stdout',
@@ -84,6 +142,12 @@ class Logger {
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Creates a log of type error in channel.
+     *
+     * @param message
+     * @param options
+     */
     error(message, options = {}) {
         options = this.createOptions(options, {
             streamType: 'stdout',
@@ -95,6 +159,12 @@ class Logger {
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Creates a log of type debug in channel.
+     *
+     * @param message
+     * @param options
+     */
     debug(message, options = {}) {
         options = this.createOptions(options, {
             streamType: 'stdout',
@@ -106,6 +176,12 @@ class Logger {
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Creates a log of type success in channel.
+     *
+     * @param message
+     * @param options
+     */
     success(message, options = {}) {
         options = this.createOptions(options, {
             streamType: 'stdout',
@@ -117,6 +193,13 @@ class Logger {
         message = Logger.applyLogEngine(message);
         return this.driver.transport(message, options);
     }
+    /**
+     * Create options concatenating client options with default options.
+     *
+     * @param options
+     * @param defaultValues
+     * @private
+     */
     createOptions(options, defaultValues) {
         let formatterConfig = Object.assign({}, {
             ...defaultValues.formatterConfig,