@athenna/logger 1.2.6 → 1.2.9

package/src/Factories/DriverFactory.js

@@ -9,17 +9,16 @@
 
 import { Config } from '@secjs/utils'
 
+import { FactoryHelper } from '#src/index'
 import { FileDriver } from '#src/Drivers/FileDriver'
 import { NullDriver } from '#src/Drivers/NullDriver'
-import { PinoDriver } from '#src/Drivers/PinoDriver'
-import { DebugDriver } from '#src/Drivers/DebugDriver'
 import { SlackDriver } from '#src/Drivers/SlackDriver'
 import { ConsoleDriver } from '#src/Drivers/ConsoleDriver'
 import { DiscordDriver } from '#src/Drivers/DiscordDriver'
 import { TelegramDriver } from '#src/Drivers/TelegramDriver'
 import { DriverExistException } from '#src/Exceptions/DriverExistException'
 import { NotFoundDriverException } from '#src/Exceptions/NotFoundDriverException'
-import { NotFoundChannelException } from '#src/Exceptions/NotFoundChannelException'
+import { NotImplementedConfigException } from '#src/Exceptions/NotImplementedConfigException'
 
 export class DriverFactory {
   /**
@@ -27,12 +26,10 @@ export class DriverFactory {
    *
    * @type {Map<string, { Driver: any }>}
    */
-  static drivers = new Map()
+  static #drivers = new Map()
     .set('file', { Driver: FileDriver })
     .set('null', { Driver: NullDriver })
-    .set('pino', { Driver: PinoDriver })
     .set('slack', { Driver: SlackDriver })
-    .set('debug', { Driver: DebugDriver })
     .set('console', { Driver: ConsoleDriver })
     .set('discord', { Driver: DiscordDriver })
     .set('telegram', { Driver: TelegramDriver })
@@ -45,7 +42,7 @@ export class DriverFactory {
   static availableDrivers() {
     const availableDrivers = []
 
-    for (const [key] of this.drivers.entries()) {
+    for (const key of this.#drivers.keys()) {
       availableDrivers.push(key)
     }
 
@@ -61,18 +58,13 @@ export class DriverFactory {
    * @return {any}
    */
   static fabricate(channelName, runtimeConfig = {}) {
-    if (channelName === 'default') {
-      channelName = Config.get('logging.default')
-    }
-
     const channelConfig = this.#getChannelConfig(channelName)
-    const driverObject = this.drivers.get(channelConfig.driver)
 
-    if (!driverObject) {
-      throw new NotFoundDriverException(channelConfig.driver)
-    }
+    const { Driver } = this.#drivers.get(channelConfig.driver)
 
-    return new driverObject.Driver(channelName, runtimeConfig)
+    const configs = FactoryHelper.groupConfigs(runtimeConfig, channelConfig)
+
+    return new Driver(configs)
   }
 
   /**
@@ -82,11 +74,11 @@ export class DriverFactory {
    * @param {(channel: string, configs?: any) => any} driver
    */
   static createDriver(name, driver) {
-    if (this.drivers.has(name)) {
+    if (this.#drivers.has(name)) {
       throw new DriverExistException(name)
     }
 
-    this.drivers.set(name, { Driver: driver })
+    this.#drivers.set(name, { Driver: driver })
   }
 
   /**
@@ -96,13 +88,17 @@ export class DriverFactory {
    * @return {any}
    */
   static #getChannelConfig(channelName) {
+    if (channelName === 'default') {
+      channelName = Config.get('logging.default')
+    }
+
     const channelConfig = Config.get(`logging.channels.${channelName}`)
 
     if (!channelConfig) {
-      throw new NotFoundChannelException(channelName)
+      throw new NotImplementedConfigException(channelName)
     }
 
-    if (!this.drivers.has(channelConfig.driver)) {
+    if (!this.#drivers.has(channelConfig.driver)) {
       throw new NotFoundDriverException(channelConfig.driver)
     }
 

package/src/Factories/FormatterFactory.js

@@ -8,7 +8,6 @@
  */
 
 import { CliFormatter } from '#src/Formatters/CliFormatter'
-import { NestFormatter } from '#src/Formatters/NestFormatter'
 import { JsonFormatter } from '#src/Formatters/JsonFormatter'
 import { NoneFormatter } from '#src/Formatters/NoneFormatter'
 import { SimpleFormatter } from '#src/Formatters/SimpleFormatter'
@@ -25,7 +24,6 @@ export class FormatterFactory {
    */
   static formatters = new Map()
     .set('cli', { Formatter: CliFormatter })
-    .set('nest', { Formatter: NestFormatter })
     .set('json', { Formatter: JsonFormatter })
     .set('none', { Formatter: NoneFormatter })
     .set('simple', { Formatter: SimpleFormatter })

package/src/Formatters/CliFormatter.js

@@ -7,24 +7,18 @@
  * file that was distributed with this source code.
  */
 
-import { FactoryHelper } from '#src/index'
+import { Formatter } from '#src/Formatters/Formatter'
 
-export class CliFormatter {
+export class CliFormatter extends Formatter {
   /**
    * Format the message.
    *
    * @param {string} message
-   * @param {{ level: 'info'|'INFO'|'debug'|'DEBUG'|'warn'|'WARN'|'error'|'ERROR'|'success'|'SUCCESS', chalk: import('chalk').ChalkInstance }} options
    * @return {string}
    */
-  format(message, options) {
-    options.level = options.level.toLowerCase()
+  format(message) {
+    const level = this.cliLevel()
 
-    const level = FactoryHelper.paintByLevel(
-      options.level,
-      `[  ${options.level}  ]`,
-    )
-
-    return `${level} ${message}`
+    return this.clean(`${level} ${this.toString(message)}`)
   }
 }

package/src/Formatters/Formatter.js

@@ -0,0 +1,245 @@
+/**
+ * @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 { hostname } from 'node:os'
+
+import { Is } from '@secjs/utils'
+
+import { ColorHelper } from '#src/Helpers/ColorHelper'
+
+export class Formatter {
+  /**
+   * Holds the configuration object of formatter.
+   */
+  configs = {}
+
+  /**
+   * Creates a new instance of Formatter.
+   *
+   * @param {any} configs
+   * @return {Formatter}
+   */
+  config(configs) {
+    this.configs = configs
+
+    return this
+  }
+
+  /**
+   * Format the message.
+   *
+   * @param {string} message
+   * @return {string}
+   */
+  format(message) {}
+
+  /**
+   * Create the PID for formatter.
+   *
+   * @return {string}
+   */
+  pid() {
+    return process.pid.toString()
+  }
+
+  /**
+   * Create the hostname for formatter.
+   *
+   * @return {string}
+   */
+  hostname() {
+    return hostname()
+  }
+
+  /**
+   * Create the timestamp for formatter.
+   *
+   * @return {string}
+   */
+  timestamp() {
+    const localeStringOptions = {
+      year: 'numeric',
+      hour: 'numeric',
+      minute: 'numeric',
+      second: 'numeric',
+      day: '2-digit',
+      month: '2-digit',
+    }
+
+    return new Date(Date.now()).toLocaleString(undefined, localeStringOptions)
+  }
+
+  /**
+   * Transform the message to string.
+   *
+   * @param message {string}
+   * @return {string}
+   */
+  toString(message) {
+    if (Is.String(message)) {
+      return message
+    }
+
+    if (Is.Object(message)) {
+      message = JSON.stringify(message)
+    }
+
+    return `${message}`
+  }
+
+  /**
+   * Clean the message removing colors if clean
+   * option is true.
+   *
+   * @param message {string}
+   * @return {string}
+   */
+  clean(message) {
+    if (this.configs.clean) {
+      return ColorHelper.removeColors(message)
+    }
+
+    return message
+  }
+
+  /**
+   * Apply all colors necessary to message.
+   *
+   * @param message {string}
+   * @return {string}
+   */
+  applyColors(message) {
+    message = this.toString(message)
+
+    return this.applyColorsByChalk(this.applyColorsByLevel(message))
+  }
+
+  /**
+   * Apply colors in message.
+   *
+   * @param message {string}
+   * @return {string}
+   */
+  applyColorsByChalk(message) {
+    if (!this.configs.chalk) {
+      return message
+    }
+
+    return this.configs.chalk(message)
+  }
+
+  /**
+   * Apply colors in message by level.
+   *
+   * @param message {string}
+   * @return {string}
+   */
+  applyColorsByLevel(message) {
+    const level = this.configs.level
+
+    return this.paintMessageByLevel(level, message)
+  }
+
+  /**
+   * Create the cli level string.
+   *
+   * @return {string}
+   */
+  cliLevel() {
+    const level = this.configs.level
+
+    if (!ColorHelper[level]) {
+      return level
+    }
+
+    return ColorHelper[level].bold(`[  ${level}  ]`)
+  }
+
+  /**
+   * Create the simple level string.
+   *
+   * @return {string}
+   */
+  simpleLevel() {
+    const level = this.configs.level
+
+    if (!ColorHelper[level]) {
+      return level
+    }
+
+    return ColorHelper[level].bold(`[${level.toUpperCase()}]`)
+  }
+
+  /**
+   * Create the message level emoji string.
+   *
+   * @return {string}
+   */
+  messageLevel() {
+    const level = this.configs.level
+
+    return this.getEmojiByLevel(level, this.configs.customEmoji)
+  }
+
+  /**
+   * Get the emoji by level.
+   *
+   * @param {string} level
+   * @param {string} [customEmoji]
+   * @return {string}
+   */
+  getEmojiByLevel(level, customEmoji) {
+    if (customEmoji) {
+      return customEmoji
+    }
+
+    const levelEmojis = {
+      trace: '\u{1F43E}',
+      debug: '\u{1F50E}',
+      info: '\u{2139}',
+      success: '\u{2705}',
+      warn: '\u{26A0}',
+      error: '\u{274C}',
+      fatal: '\u{1F6D1}',
+    }
+
+    if (!levelEmojis[level.toLowerCase()]) {
+      return ''
+    }
+
+    return levelEmojis[level.toLowerCase()]
+  }
+
+  /**
+   * Paint the message by level.
+   *
+   * @param {string} level
+   * @param {string} message
+   * @return {string}
+   */
+  paintMessageByLevel(level, message) {
+    const levelLower = level.toLowerCase()
+
+    const levelColors = {
+      trace: ColorHelper.trace,
+      debug: ColorHelper.debug,
+      info: ColorHelper.info,
+      success: ColorHelper.success,
+      warn: ColorHelper.warn,
+      error: ColorHelper.error,
+      fatal: ColorHelper.fatal,
+    }
+
+    if (!levelColors[levelLower]) {
+      return message
+    }
+
+    return levelColors[levelLower](message)
+  }
+}

package/src/Formatters/JsonFormatter.js

@@ -7,18 +7,30 @@
  * file that was distributed with this source code.
  */
 
-import { ColorHelper } from '#src/index'
+import { Is } from '@secjs/utils'
+import { Formatter } from '#src/Formatters/Formatter'
 
-export class JsonFormatter {
+export class JsonFormatter extends Formatter {
   /**
+   * Format the message.
    *
-   * @param {Record<any, any>} message
-   * @param {{ chalk: import('chalk').ChalkInstance }} options
+   * @param {any} message
    * @return {string}
    */
-  format(message, options) {
-    const jsonSpaced = JSON.stringify(message, null, 2)
+  format(message) {
+    const base = {
+      level: this.configs.level,
+      time: Date.now(),
+      pid: this.pid(),
+      hostname: this.hostname(),
+    }
 
-    return `${ColorHelper.bold('JSON:')} ${options.chalk(jsonSpaced)}`
+    if (Is.String(message)) {
+      base.msg = message
+
+      return JSON.stringify(base)
+    }
+
+    return JSON.stringify({ ...base, ...message })
   }
 }

package/src/Formatters/MessageFormatter.js

@@ -1,4 +1,3 @@
-/* eslint-disable prettier/prettier */
 /**
  * @athenna/logger
  *
@@ -8,33 +7,20 @@
  * file that was distributed with this source code.
  */
 
-import { FactoryHelper } from '#src/index'
-
-export class MessageFormatter {
-  /**
-   * The last timestamp.
-   *
-   * @type {number}
-   */
-  #lastTimestamp
+import { Formatter } from '#src/Formatters/Formatter'
 
+export class MessageFormatter extends Formatter {
   /**
    * Format the message.
    *
    * @param {string} message
-   * @param {{ level: 'info'|'INFO'|'debug'|'DEBUG'|'warn'|'WARN'|'error'|'ERROR'|'success'|'SUCCESS', customEmoji: string }} options
    * @return {string}
    */
-  format(message, options) {
-    const timestampDiff = FactoryHelper.getTimestampDiff(this.#lastTimestamp)
-
-    this.#lastTimestamp = Date.now()
-
-    const level = FactoryHelper.getEmojiByLevel(
-      options.level,
-      options.customEmoji,
+  format(message) {
+    return this.clean(
+      `${this.messageLevel()} - (${this.pid()}) - (${this.hostname()}): ${this.toString(
+        message,
+      )}`,
     )
-
-    return `${level} ${message}${timestampDiff}`
   }
 }

package/src/Formatters/NoneFormatter.js

@@ -7,15 +7,16 @@
  * file that was distributed with this source code.
  */
 
-export class NoneFormatter {
+import { Formatter } from '#src/Formatters/Formatter'
+
+export class NoneFormatter extends Formatter {
   /**
    * Format the message.
    *
    * @param {string} message
-   * @param {any} [_options]
    * @return {string}
    */
-  format(message, _options) {
-    return message
+  format(message) {
+    return this.clean(this.toString(message))
   }
 }

package/src/Formatters/RequestFormatter.js

@@ -8,16 +8,16 @@
  */
 
 import { ColorHelper } from '#src/index'
+import { Formatter } from '#src/Formatters/Formatter'
 
-export class RequestFormatter {
+export class RequestFormatter extends Formatter {
   /**
    * Format the message.
    *
    * @param {any} ctx
-   * @param {{ asJson: boolean, chalk: import('chalk').ChalkInstance }} options
    * @return {string}
    */
-  format(ctx, options) {
+  format(ctx) {
     const ip = ctx.request.ip
     const status = ctx.status
     const responseTimeMs = `${Math.round(ctx.responseTime)}ms`
@@ -25,8 +25,10 @@ export class RequestFormatter {
       `${ctx.request.method}::${ctx.request.baseUrl}`,
     )
 
-    if (!options.asJson) {
-      return `(${ip}) - [${status}] ${methodAndUrl} ${responseTimeMs}`
+    if (!this.configs.asJson) {
+      return this.clean(
+        `(${ip}) - [${status}] ${methodAndUrl} ${responseTimeMs}`,
+      )
     }
 
     const metadata = {

package/src/Formatters/SimpleFormatter.js

@@ -7,33 +7,22 @@
  * file that was distributed with this source code.
  */
 
-import { FactoryHelper } from '#src/index'
-
-export class SimpleFormatter {
-  /**
-   * The last timestamp.
-   *
-   * @type {number}
-   */
-  #lastTimestamp
+import { Formatter } from '#src/Formatters/Formatter'
 
+export class SimpleFormatter extends Formatter {
   /**
    * Format the message.
    *
    * @param {string} message
-   * @param {{ level: 'info'|'INFO'|'debug'|'DEBUG'|'warn'|'WARN'|'error'|'ERROR'|'success'|'SUCCESS', chalk: import('chalk').ChalkInstance }} options
    * @return {string}
    */
-  format(message, options) {
-    const timestampDiff = FactoryHelper.getTimestampDiff(this.#lastTimestamp)
-    this.#lastTimestamp = Date.now()
+  format(message) {
+    const level = this.simpleLevel()
 
-    const timestamp = FactoryHelper.getTimestamp()
-    const level = FactoryHelper.paintByLevel(
-      options.level.toLowerCase(),
-      `[${options.level.toUpperCase()}]`,
+    return this.clean(
+      `${level} - ${this.timestamp()} - (${this.pid()}) ${this.applyColors(
+        message,
+      )}`,
     )
-
-    return `${level} - ${timestamp} ${options.chalk(message)}${timestampDiff}`
   }
 }

package/src/Helpers/ColorHelper.js

@@ -26,6 +26,15 @@ export class ColorHelper {
     return ColorHelper.chalk.bold
   }
 
+  /**
+   * Paint as grey.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get grey() {
+    return ColorHelper.chalk.hex('#505050')
+  }
+
   /**
    * Paint as purple.
    *
@@ -117,12 +126,12 @@ export class ColorHelper {
   }
 
   /**
-   * Paint infos.
+   * Paint debugs.
    *
    * @return {import('chalk').ChalkInstance}
    */
-  static get info() {
-    return this.cyan.bold
+  static get trace() {
+    return this.grey.bold
   }
 
   /**
@@ -135,12 +144,12 @@ export class ColorHelper {
   }
 
   /**
-   * Paint error.
+   * Paint infos.
    *
    * @return {import('chalk').ChalkInstance}
    */
-  static get error() {
-    return this.red.bold
+  static get info() {
+    return this.cyan
   }
 
   /**
@@ -149,25 +158,34 @@ export class ColorHelper {
    * @return {import('chalk').ChalkInstance}
    */
   static get success() {
-    return this.green.bold
+    return this.green
   }
 
   /**
-   * Paint critical.
+   * Paint warning.
    *
    * @return {import('chalk').ChalkInstance}
    */
-  static get critical() {
-    return this.darkRed.bold
+  static get warn() {
+    return this.orange
   }
 
   /**
-   * Paint warning.
+   * Paint error.
    *
    * @return {import('chalk').ChalkInstance}
    */
-  static get warning() {
-    return this.orange.bold
+  static get error() {
+    return this.red
+  }
+
+  /**
+   * Paint fatal.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get fatal() {
+    return ColorHelper.chalk.bgRed
   }
 
   /**
@@ -237,7 +255,7 @@ export class ColorHelper {
    * Remove all colors and special chars of string.
    *
    * @param {string} string
-   * @return {import('chalk').ChalkInstance}
+   * @return {string}
    */
   static removeColors(string) {
     return ColorHelper.chalk.reset(string).replace(