@athenna/logger 3.0.9 → 3.1.0

package/src/Exceptions/DriverExistException.js

@@ -1,31 +0,0 @@
-/**
- * @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 { Exception } from '@athenna/common'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class DriverExistException extends Exception {
-  /**
-   * Creates a new instance of DriverExistException.
-   *
-   * @param {string} driverName
-   * @return {DriverExistException}
-   */
-  constructor(driverName) {
-    const content = `The driver ${driverName} already exists in DriverFactory.`
-    const availableDrivers = DriverFactory.availableDrivers().join(', ')
-
-    super(
-      content,
-      500,
-      'E_EXIST_DRIVER',
-      `Available drivers are: ${availableDrivers}. The name ${driverName} is already in use inside DriverFactory. Try using a different name for your driver implementation.`,
-    )
-  }
-}

package/src/Exceptions/FormatterExistException.js

@@ -1,32 +0,0 @@
-/**
- * @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 { Exception } from '@athenna/common'
-import { FormatterFactory } from '#src/Factories/FormatterFactory'
-
-export class FormatterExistException extends Exception {
-  /**
-   * Creates a new instance of FormatterExistException.
-   *
-   * @param {string} formatterName
-   * @return {FormatterExistException}
-   */
-  constructor(formatterName) {
-    const content = `The formatter ${formatterName} already exists in FormatterFactory.`
-    const availableFormatters =
-      FormatterFactory.availableFormatters().join(', ')
-
-    super(
-      content,
-      500,
-      'E_EXIST_FORMATTER',
-      `Available formatters are: ${availableFormatters}. The name ${formatterName} is already in use inside FormatterFactory. Try using a different name for your formatter implementation.`,
-    )
-  }
-}

package/src/Exceptions/NotFoundDriverException.js

@@ -1,31 +0,0 @@
-/**
- * @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 { Exception, Path } from '@athenna/common'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class NotFoundDriverException extends Exception {
-  /**
-   * Creates a new instance of NotFoundDriverException.
-   *
-   * @param {string} driverName
-   * @return {NotFoundDriverException}
-   */
-  constructor(driverName) {
-    const content = `The driver ${driverName} has not been found.`
-    const availableDrivers = DriverFactory.availableDrivers().join(', ')
-
-    super(
-      content,
-      500,
-      'E_NOT_FOUND',
-      `Available drivers are: ${availableDrivers}. Look into your config/logger.${Path.ext()} file if ${driverName} driver is implemented by logger. Or create ${driverName} driver implementation using DriverFactory.createDriver("${driverName}", ...) method.`,
-    )
-  }
-}

package/src/Exceptions/NotFoundFormatterException.js

@@ -1,31 +0,0 @@
-/**
- * @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 { Exception } from '@athenna/common'
-import { FormatterFactory } from '#src/Factories/FormatterFactory'
-
-export class NotFoundFormatterException extends Exception {
-  /**
-   * Creates a new instance of NotFoundFormatterException.
-   *
-   * @param {string} formatterName
-   * @return {NotFoundFormatterException}
-   */
-  constructor(formatterName) {
-    const content = `The formatter ${formatterName} has not been found.`
-    const availableDrivers = FormatterFactory.availableFormatters().join(', ')
-
-    super(
-      content,
-      500,
-      'E_NOT_FOUND',
-      `Available formatters are: ${availableDrivers}. Look into your config/logger.js file if ${formatterName} formatter is implemented by logger. Or create ${formatterName} formatter implementation using FormatterFactory.createFormatter("${formatterName}", ...) method.`,
-    )
-  }
-}

package/src/Exceptions/NotImplementedConfigException.js

@@ -1,37 +0,0 @@
-/**
- * @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 { Path, Exception } from '@athenna/common'
-
-export class NotImplementedConfigException extends Exception {
-  /**
-   * Creates a new instance of NotImplementedConfigException.
-   *
-   * @param {string} channelName
-   * @param {any[]} channels
-   * @return {NotImplementedConfigException}
-   */
-  constructor(channelName, channels) {
-    const content = `Channel ${channelName} is not configured inside logging.channels object from config/logging.${Path.ext()} file.`
-
-    let help = ''
-
-    if (channels && channels.length) {
-      const availableConfigs = Object.keys(channels).join(', ')
-
-      help += `Available configurations are: ${availableConfigs}.`
-    } else {
-      help += `The "Config.get('logging.channels')" is empty, maybe your configuration files are not loaded?`
-    }
-
-    help += ` Create your configuration inside channels object to use it. Or load your configuration files using "Config.safeLoad(Path.config('logging.${Path.ext()}'))`
-
-    super(content, 500, 'E_NOT_IMPLEMENTED_CONFIG_ERROR', help)
-  }
-}

package/src/Factories/DriverFactory.js

@@ -1,128 +0,0 @@
-/**
- * @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 { Config } from '@athenna/config'
-
-import { FactoryHelper } from '#src/index'
-import { FileDriver } from '#src/Drivers/FileDriver'
-import { NullDriver } from '#src/Drivers/NullDriver'
-import { SlackDriver } from '#src/Drivers/SlackDriver'
-import { StackDriver } from '#src/Drivers/StackDriver'
-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 { NotImplementedConfigException } from '#src/Exceptions/NotImplementedConfigException'
-import { Options } from '@athenna/common'
-
-export class DriverFactory {
-  /**
-   * Drivers of DriverFactory.
-   *
-   * @type {Map<string, { Driver: any }>}
-   */
-  static #drivers = new Map()
-    .set('file', { Driver: FileDriver })
-    .set('null', { Driver: NullDriver })
-    .set('slack', { Driver: SlackDriver })
-    .set('stack', { Driver: StackDriver })
-    .set('console', { Driver: ConsoleDriver })
-    .set('discord', { Driver: DiscordDriver })
-    .set('telegram', { Driver: TelegramDriver })
-
-  /**
-   * Return an array with all available drivers.
-   *
-   * @return {any[]}
-   */
-  static availableDrivers() {
-    const availableDrivers = []
-
-    for (const key of this.#drivers.keys()) {
-      availableDrivers.push(key)
-    }
-
-    return availableDrivers
-  }
-
-  /**
-   * Fabricate a new instance of a driver based on
-   * channel configurations.
-   *
-   * @param {string} channelName
-   * @param {any} runtimeConfig
-   * @return {any}
-   */
-  static fabricate(channelName, runtimeConfig = {}) {
-    const channelConfig = this.#getChannelConfig(channelName)
-
-    const { Driver } = this.#drivers.get(channelConfig.driver)
-
-    const configs = FactoryHelper.groupConfigs(runtimeConfig, channelConfig)
-
-    return new Driver(configs)
-  }
-
-  /**
-   * Fabricate a new instance of a driver with vanilla
-   * configurations.
-   *
-   * @param {any} configs
-   * @return {any}
-   */
-  static fabricateVanilla(configs = {}) {
-    configs = Options.create(configs, {
-      driver: 'console',
-      formatter: 'none',
-    })
-
-    const { Driver } = this.#drivers.get(configs.driver)
-
-    return new Driver(configs)
-  }
-
-  /**
-   * Creates a new driver implementation.
-   *
-   * @param {string} name
-   * @param {(channel: string, configs?: any) => any} driver
-   */
-  static createDriver(name, driver) {
-    if (this.#drivers.has(name)) {
-      throw new DriverExistException(name)
-    }
-
-    this.#drivers.set(name, { Driver: driver })
-  }
-
-  /**
-   * Get all the configuration of a channel.
-   *
-   * @param {string} channelName
-   * @return {any}
-   */
-  static #getChannelConfig(channelName) {
-    if (channelName === 'default') {
-      channelName = Config.get('logging.default') || channelName
-    }
-
-    const channelConfig = Config.get(`logging.channels.${channelName}`)
-
-    if (!channelConfig) {
-      throw new NotImplementedConfigException(channelName)
-    }
-
-    if (!this.#drivers.has(channelConfig.driver)) {
-      throw new NotFoundDriverException(channelConfig.driver)
-    }
-
-    return channelConfig
-  }
-}

package/src/Factories/FormatterFactory.js

@@ -1,77 +0,0 @@
-/**
- * @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 { CliFormatter } from '#src/Formatters/CliFormatter'
-import { JsonFormatter } from '#src/Formatters/JsonFormatter'
-import { NoneFormatter } from '#src/Formatters/NoneFormatter'
-import { SimpleFormatter } from '#src/Formatters/SimpleFormatter'
-import { MessageFormatter } from '#src/Formatters/MessageFormatter'
-import { RequestFormatter } from '#src/Formatters/RequestFormatter'
-import { FormatterExistException } from '#src/Exceptions/FormatterExistException'
-import { NotFoundFormatterException } from '#src/Exceptions/NotFoundFormatterException'
-
-export class FormatterFactory {
-  /**
-   * Formatters of FormatterFactory.
-   *
-   * @type {Map<string, { Formatter: any }>}
-   */
-  static formatters = new Map()
-    .set('cli', { Formatter: CliFormatter })
-    .set('json', { Formatter: JsonFormatter })
-    .set('none', { Formatter: NoneFormatter })
-    .set('simple', { Formatter: SimpleFormatter })
-    .set('message', { Formatter: MessageFormatter })
-    .set('request', { Formatter: RequestFormatter })
-
-  /**
-   * Return an array with all available formatters.
-   *
-   * @return {any[]}
-   */
-  static availableFormatters() {
-    const availableFormatters = []
-
-    for (const [key] of this.formatters.entries()) {
-      availableFormatters.push(key)
-    }
-
-    return availableFormatters
-  }
-
-  /**
-   * Fabricate a new instance of a formatter.
-   *
-   * @param {string} formatterName
-   * @return {any}
-   */
-  static fabricate(formatterName) {
-    const formatterObject = this.formatters.get(formatterName)
-
-    if (!formatterObject) {
-      throw new NotFoundFormatterException(formatterName)
-    }
-
-    return new formatterObject.Formatter()
-  }
-
-  /**
-   * Creates a new formatter implementation.
-   *
-   * @param {string} name
-   * @param {() => any} formatter
-   */
-  static createFormatter(name, formatter) {
-    if (this.formatters.has(name)) {
-      throw new FormatterExistException(name)
-    }
-
-    this.formatters.set(name, { Formatter: formatter })
-  }
-}

package/src/Formatters/CliFormatter.js

@@ -1,24 +0,0 @@
-/**
- * @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 { Formatter } from '#src/Formatters/Formatter'
-
-export class CliFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    const level = this.cliLevel()
-
-    return this.clean(`${level} ${this.toString(message)}`)
-  }
-}

package/src/Formatters/Formatter.js

@@ -1,266 +0,0 @@
-/**
- * @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 rTracer from 'cls-rtracer'
-
-import { hostname } from 'node:os'
-import { Is } from '@athenna/common'
-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()
-  }
-
-  /**
-   * Get the level without any color or format.
-   *
-   * @return {string}
-   */
-  level() {
-    return this.configs.level
-  }
-
-  /**
-   * Get the trace id for formatter.
-   *
-   * @return {string | null}
-   */
-  traceId() {
-    return rTracer.id() || null
-  }
-
-  /**
-   * 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. If force is true, then colors
-   * will be removed even if configs clean option
-   * is false.
-   *
-   * @param message {string}
-   * @param [force] {boolean}
-   * @return {string}
-   */
-  clean(message, force = false) {
-    if (this.configs.clean || force) {
-      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

@@ -1,37 +0,0 @@
-/**
- * @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 { Is } from '@athenna/common'
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class JsonFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {any} message
-   * @return {string}
-   */
-  format(message) {
-    const base = {
-      level: this.level(),
-      time: Date.now(),
-      pid: this.pid(),
-      hostname: this.hostname(),
-      traceId: this.traceId(),
-    }
-
-    if (Is.String(message)) {
-      base.msg = message
-
-      return JSON.stringify(base)
-    }
-
-    return JSON.stringify({ ...base, ...message })
-  }
-}