@athenna/logger 3.0.9 → 3.1.0

package/src/Formatters/MessageFormatter.js

@@ -1,26 +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 MessageFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    return this.clean(
-      `${this.messageLevel()} - (${this.pid()}) - (${this.hostname()}): ${this.toString(
-        message,
-      )}`,
-    )
-  }
-}

package/src/Formatters/RequestFormatter.js

@@ -1,64 +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 { ColorHelper } from '#src/index'
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class RequestFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {any} ctx
-   * @return {string}
-   */
-  format(ctx) {
-    const ip = ctx.request.ip
-    const status = ctx.status
-    const responseTimeMs = `${Math.round(ctx.responseTime)}ms`
-    const methodAndStatus = ColorHelper[ctx.request.method](
-      `[${ctx.request.method}::${ctx.status}]`,
-    )
-
-    if (!this.configs.asJson) {
-      return this.clean(
-        `${methodAndStatus} - [${ip}] - ${new Date().toISOString()} - ${
-          ctx.request.baseUrl
-        } ${responseTimeMs}`,
-      )
-    }
-
-    const metadata = {
-      method: ctx.request.method,
-      duration: responseTimeMs,
-      status: status <= 399 ? 'SUCCESS' : 'ERROR',
-      statusCode: status,
-      url: ctx.request.hostUrl,
-      path: ctx.request.baseUrl,
-      createdAt: Date.now(),
-      traceId: this.traceId(),
-      data: ctx.data,
-    }
-
-    const request = {
-      url: ctx.request.hostUrl,
-      method: ctx.request.method,
-      body: ctx.request.body,
-      params: ctx.request.params,
-      queries: ctx.request.queries,
-      headers: ctx.request.headers,
-    }
-
-    const response = {
-      body: ctx.body,
-      headers: ctx.headers,
-    }
-
-    return JSON.stringify({ request, response, metadata })
-  }
-}

package/src/Formatters/SimpleFormatter.js

@@ -1,27 +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 SimpleFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    const pid = this.pid()
-    const time = this.timestamp()
-    const level = this.simpleLevel()
-    const colorizedMsg = this.applyColors(message)
-
-    return this.clean(`${level} - ${time} - (${pid}) ${colorizedMsg}`)
-  }
-}

package/src/Helpers/ColorHelper.js

@@ -1,322 +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 { format } from 'node:util'
-import chalk, { Chalk } from 'chalk'
-
-export class ColorHelper {
-  /**
-   * Chalk instance.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static chalk = chalk
-
-  /**
-   * Paint as bold.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get bold() {
-    return ColorHelper.chalk.bold
-  }
-
-  /**
-   * Paint as grey.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get grey() {
-    return ColorHelper.chalk.hex('#505050')
-  }
-
-  /**
-   * Paint as purple.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get purple() {
-    return ColorHelper.chalk.hex('#7628c8')
-  }
-
-  /**
-   * Paint as darkPurple.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get darkPurple() {
-    return ColorHelper.chalk.hex('#501b86')
-  }
-
-  /**
-   * Paint as yellow.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get yellow() {
-    return ColorHelper.chalk.hex('#ffe600')
-  }
-
-  /**
-   * Paint as cyan.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get cyan() {
-    return ColorHelper.chalk.hex('#00ffff')
-  }
-
-  /**
-   * Paint as white.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get white() {
-    return ColorHelper.chalk.hex('#ffffff')
-  }
-
-  /**
-   * Paint as orange.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get orange() {
-    return ColorHelper.chalk.hex('#f18b0e')
-  }
-
-  /**
-   * Paint as green.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get green() {
-    return ColorHelper.chalk.hex('#0ef12c')
-  }
-
-  /**
-   * Paint as darkGreen.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get darkGreen() {
-    return ColorHelper.chalk.hex('#1cb70b')
-  }
-
-  /**
-   * Paint as red.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get red() {
-    return ColorHelper.chalk.hex('#f10e0e')
-  }
-
-  /**
-   * Paint as darkRed.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get darkRed() {
-    return ColorHelper.chalk.hex('#710909')
-  }
-
-  /**
-   * Paint debugs.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get trace() {
-    return this.grey.bold
-  }
-
-  /**
-   * Paint debugs.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get debug() {
-    return this.purple.bold
-  }
-
-  /**
-   * Paint infos.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get info() {
-    return this.cyan
-  }
-
-  /**
-   * Paint success.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get success() {
-    return this.green
-  }
-
-  /**
-   * Paint warning.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get warn() {
-    return this.orange
-  }
-
-  /**
-   * Paint error.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get error() {
-    return this.red
-  }
-
-  /**
-   * Paint fatal.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get fatal() {
-    return ColorHelper.chalk.bgRed
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get GET() {
-    return this.purple.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get HEAD() {
-    return this.cyan.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get PUT() {
-    return this.orange.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get PATCH() {
-    return this.yellow.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get POST() {
-    return this.green.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get DELETE() {
-    return this.red.bold
-  }
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get OPTIONS() {
-    return this.cyan.bold
-  }
-
-  /**
-   * Remove all colors and special chars of string.
-   *
-   * @param {string} string
-   * @return {string}
-   */
-  static removeColors(string) {
-    return ColorHelper.chalk.reset(string).replace(
-      // eslint-disable-next-line no-control-regex
-      /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
-      '',
-    )
-  }
-
-  /**
-   * Paint by the http method.
-   *
-   * @param {'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', 'OPTIONS', 'HEAD' } method
-   * @return {import('chalk').ChalkInstance}
-   */
-  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/FactoryHelper.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 { Options } from '@athenna/common'
-
-export class FactoryHelper {
-  /**
-   * Group the configuration values.
-   *
-   * @param {any} object
-   * @param {any} defaultValue
-   * @return {any}
-   */
-  static groupConfigs(object, defaultValue) {
-    const formatter = object.formatter || defaultValue.formatter
-    const formatterConfig = Options.create(
-      object.formatterConfig,
-      defaultValue.formatterConfig,
-    )
-
-    const driverConfig = Options.create(object, defaultValue)
-
-    return { ...driverConfig, formatter, formatterConfig }
-  }
-}

package/src/Helpers/VanillaLogger.js

@@ -1,134 +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 { ColorHelper } from '#src/index'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class VanillaLogger {
-  /**
-   * The driver responsible for transporting the logs.
-   *
-   * @type {any[]}
-   */
-  #drivers = []
-
-  /**
-   * Creates a new instance of ConsoleLogger.
-   *
-   * @param {any} [configs]
-   * @return {VanillaLogger}
-   */
-  constructor(configs) {
-    this.#drivers.push(DriverFactory.fabricateVanilla(configs))
-  }
-
-  /**
-   * Set runtime configurations for drivers and
-   * formatters.
-   *
-   * @return {VanillaLogger}
-   */
-  config() {
-    return this
-  }
-
-  /**
-   * Change the log channel.
-   *
-   * @return {VanillaLogger}
-   */
-  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)
-  }
-}