@athenna/logger 3.0.4 → 3.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -51,9 +51,9 @@
     "telegraf": "4.7.0"
   },
   "devDependencies": {
-    "@athenna/common": "3.0.0",
-    "@athenna/config": "3.0.2",
-    "@athenna/ioc": "3.0.0",
+    "@athenna/common": "3.0.1",
+    "@athenna/config": "3.0.3",
+    "@athenna/ioc": "3.0.1",
     "@japa/assert": "1.3.4",
     "@japa/run-failed-tests": "1.0.7",
     "@japa/runner": "2.0.7",

package/src/Drivers/Driver.js

@@ -60,7 +60,7 @@ export class Driver {
    * @param {any} configs
    * @return {ConsoleDriver}
    */
-  constructor(configs) {
+  constructor(configs = {}) {
     this.configs = configs
 
     const json = Json.copy(configs)
@@ -70,8 +70,8 @@ export class Driver {
 
     this.driverConfig = json
     this.level = json.level || 'info'
-    this.formatter = configs.formatter
-    this.formatterConfig = configs.formatterConfig
+    this.formatter = configs.formatter || 'none'
+    this.formatterConfig = configs.formatterConfig || {}
   }
 
   /**

package/src/Factories/DriverFactory.js

@@ -69,6 +69,20 @@ export class DriverFactory {
     return new Driver(configs)
   }
 
+  /**
+   * Fabricate a new instance of a driver without
+   * configurations.
+   *
+   * @param {string} driverName
+   * @param {any} runtimeConfig
+   * @return {any}
+   */
+  static fabricateOnly(driverName, runtimeConfig = {}) {
+    const { Driver } = this.#drivers.get(driverName)
+
+    return new Driver(runtimeConfig)
+  }
+
   /**
    * Creates a new driver implementation.
    *

package/src/Formatters/Formatter.js

@@ -7,13 +7,12 @@
  * file that was distributed with this source code.
  */
 
+import rTracer from 'cls-rtracer'
+
 import { hostname } from 'node:os'
 import { Is } from '@athenna/common'
-import { createRequire } from 'node:module'
 import { ColorHelper } from '#src/Helpers/ColorHelper'
 
-const require = createRequire(import.meta.url)
-
 export class Formatter {
   /**
    * Holds the configuration object of formatter.
@@ -73,13 +72,7 @@ export class Formatter {
    * @return {string | null}
    */
   traceId() {
-    try {
-      const rTracer = require('cls-rtracer')
-
-      return rTracer.id()
-    } catch (err) {
-      return null
-    }
+    return rTracer.id() || null
   }
 
   /**

package/src/Helpers/ColorHelper.js

@@ -7,7 +7,9 @@
  * file that was distributed with this source code.
  */
 
-import chalk from 'chalk'
+import { Is } from '@athenna/common'
+import { format } from 'node:util'
+import chalk, { Chalk } from 'chalk'
 
 export class ColorHelper {
   /**
@@ -274,4 +276,47 @@ export class ColorHelper {
   static httpMethod(method) {
     return this[method]
   }
+
+  /**
+   * Applies the log engine to execute chalk methods.
+   *
+   * @param {string} args
+   * @return {any}
+   */
+  static applyLogEngine(...args) {
+    if (!Is.String(args[0])) {
+      return args[0]
+    }
+
+    let content = format(...args.filter(arg => arg !== undefined))
+
+    const matches = content.match(/\({(.*?)} ([\s\S]*?)\)/g)
+
+    if (!matches) {
+      return content
+    }
+
+    matches.forEach(match => {
+      const [chalkMethodsInBrackets, chalkMethodsString] =
+        match.match(/\{(.*?)\}/)
+
+      const message = match
+        .replace(chalkMethodsInBrackets, '')
+        .replace(/\s*\(\s*|\s*\)\s*/g, '')
+
+      const chalkMethodsArray = chalkMethodsString.replace(/\s/g, '').split(',')
+
+      let chalk = new Chalk()
+
+      chalkMethodsArray.forEach(chalkMethod => {
+        if (!chalk[chalkMethod]) return
+
+        chalk = chalk[chalkMethod]
+      })
+
+      content = content.replace(match, chalk(message))
+    })
+
+    return content
+  }
 }

package/src/Helpers/ConsoleLogger.js

@@ -0,0 +1,134 @@
+/**
+ * @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 { ColorHelper } from '#src/index'
+import { DriverFactory } from '#src/Factories/DriverFactory'
+
+export class ConsoleLogger {
+  /**
+   * The driver responsible for transporting the logs.
+   *
+   * @type {any[]}
+   */
+  #drivers = []
+
+  /**
+   * Creates a new instance of ConsoleLogger.
+   *
+   * @param {any} [runtimeConfigs]
+   * @return {ConsoleLogger}
+   */
+  constructor(runtimeConfigs) {
+    this.#drivers.push(DriverFactory.fabricateOnly('console', runtimeConfigs))
+  }
+
+  /**
+   * Set runtime configurations for drivers and
+   * formatters.
+   *
+   * @return {ConsoleLogger}
+   */
+  config() {
+    return this
+  }
+
+  /**
+   * Change the log channel.
+   *
+   * @return {ConsoleLogger}
+   */
+  channel() {
+    return this
+  }
+
+  /**
+   * Call drivers to transport the log.
+   *
+   * @param {string} level
+   * @param {string} args
+   * @return {any | Promise<any>}
+   */
+  #log(level, ...args) {
+    const message = ColorHelper.applyLogEngine(...args)
+
+    const promises = this.#drivers.map(d => d.transport(level, message))
+
+    return Promise.all(promises)
+  }
+
+  /**
+   * Creates a log of type trace in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  trace(...args) {
+    return this.#log('trace', ...args)
+  }
+
+  /**
+   * Creates a log of type debug in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  debug(...args) {
+    return this.#log('debug', ...args)
+  }
+
+  /**
+   * Creates a log of type info in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  info(...args) {
+    return this.#log('info', ...args)
+  }
+
+  /**
+   * Creates a log of type success in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  success(...args) {
+    return this.#log('success', ...args)
+  }
+
+  /**
+   * Creates a log of type warn in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  warn(...args) {
+    return this.#log('warn', ...args)
+  }
+
+  /**
+   * Creates a log of type error in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  error(...args) {
+    return this.#log('error', ...args)
+  }
+
+  /**
+   * Creates a log of type fatal in channel.
+   *
+   * @param {string|any} args
+   * @return {any | Promise<any>}
+   */
+  fatal(...args) {
+    return this.#log('fatal', ...args)
+  }
+}

package/src/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * @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 { Facade } from '@athenna/ioc'
 
 export const Log: typeof Facade & Logger
@@ -404,6 +413,14 @@ export class ColorHelper {
    * @return {import('chalk').ChalkInstance}
    */
   static httpMethod(method: any): import('chalk').ChalkInstance
+
+  /**
+   * Applies the log engine to execute chalk methods.
+   *
+   * @param {string} args
+   * @return {any}
+   */
+  static applyLogEngine(...args): any
 }
 
 export class FactoryHelper {
@@ -447,6 +464,16 @@ export class DriverFactory {
    */
   static fabricate(channelName: string, runtimeConfig?: any): any
 
+  /**
+   * Fabricate a new instance of a driver without
+   * configurations.
+   *
+   * @param {string} driverName
+   * @param {any} runtimeConfig
+   * @return {any}
+   */
+  static fabricateOnly(driverName: string, runtimeConfig?: any): any
+
   /**
    * Creates a new driver implementation.
    *
@@ -496,7 +523,113 @@ export class FormatterFactory {
   static createFormatter(name: string, formatter: () => any): void
 }
 
+export class ConsoleLogger {
+  /**
+   * Creates a log of type trace in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  trace(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type trace in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  trace(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type debug in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  debug(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type debug in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  debug(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type info in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  info(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type info in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  info(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type success in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  success(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type success in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  success(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type warn in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  warn(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type warn in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  warn(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type error in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  error(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type error in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  error(...args: string[] | any[]): any | Promise<any>
+}
+
 export class Logger {
+  /**
+   * Get a new instance of the ConsoleLogger.
+   *
+   * @param {any} [runtimeConfigs]
+   * @return {ConsoleLogger}
+   */
+  static getConsoleLogger(runtimeConfigs?: any): ConsoleLogger
+
   /**
    * Set runtime configurations for drivers and
    * formatters.

package/src/index.js

@@ -1,12 +1,20 @@
-import { Chalk } from 'chalk'
-import { format } from 'node:util'
-import { Is } from '@athenna/common'
-
+/**
+ * @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 { ColorHelper } from '#src/index'
+import { ConsoleLogger } from '#src/Helpers/ConsoleLogger'
 import { DriverFactory } from '#src/Factories/DriverFactory'
 
 export * from './Facades/Log.js'
 
 export * from './Helpers/ColorHelper.js'
+export * from './Helpers/ConsoleLogger.js'
 export * from './Helpers/FactoryHelper.js'
 
 export * from './Drivers/Driver.js'
@@ -16,6 +24,16 @@ export * from './Factories/DriverFactory.js'
 export * from './Factories/FormatterFactory.js'
 
 export class Logger {
+  /**
+   * Get a new instance of the ConsoleLogger.
+   *
+   * @param {any} [runtimeConfigs]
+   * @return {ConsoleLogger}
+   */
+  static getConsoleLogger(runtimeConfigs) {
+    return new ConsoleLogger(runtimeConfigs)
+  }
+
   /**
    * The driver responsible for transporting the logs.
    *
@@ -76,7 +94,7 @@ export class Logger {
    * @return {any | Promise<any>}
    */
   #log(level, ...args) {
-    const message = this.#applyEngine(...args)
+    const message = ColorHelper.applyLogEngine(...args)
 
     const promises = this.#drivers.map(d => d.transport(level, message))
 
@@ -152,47 +170,4 @@ export class Logger {
   fatal(...args) {
     return this.#log('fatal', ...args)
   }
-
-  /**
-   * Applies the log engine to execute chalk methods.
-   *
-   * @param {string} args
-   * @return {any}
-   */
-  #applyEngine(...args) {
-    if (!Is.String(args[0])) {
-      return args[0]
-    }
-
-    let content = format(...args.filter(arg => arg !== undefined))
-
-    const matches = content.match(/\({(.*?)} ([\s\S]*?)\)/g)
-
-    if (!matches) {
-      return content
-    }
-
-    matches.forEach(match => {
-      const [chalkMethodsInBrackets, chalkMethodsString] =
-        match.match(/\{(.*?)\}/)
-
-      const message = match
-        .replace(chalkMethodsInBrackets, '')
-        .replace(/\s*\(\s*|\s*\)\s*/g, '')
-
-      const chalkMethodsArray = chalkMethodsString.replace(/\s/g, '').split(',')
-
-      let chalk = new Chalk()
-
-      chalkMethodsArray.forEach(chalkMethod => {
-        if (!chalk[chalkMethod]) return
-
-        chalk = chalk[chalkMethod]
-      })
-
-      content = content.replace(match, chalk(message))
-    })
-
-    return content
-  }
 }