@athenna/logger 1.1.7 → 1.2.0

package/src/Helpers/ColorHelper.js

@@ -0,0 +1,259 @@
+/**
+ * @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 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 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 infos.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get info() {
+    return this.cyan.bold
+  }
+
+  /**
+   * Paint debugs.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get debug() {
+    return this.purple.bold
+  }
+
+  /**
+   * Paint error.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get error() {
+    return this.red.bold
+  }
+
+  /**
+   * Paint success.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get success() {
+    return this.green.bold
+  }
+
+  /**
+   * Paint critical.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get critical() {
+    return this.darkRed.bold
+  }
+
+  /**
+   * Paint warning.
+   *
+   * @return {import('chalk').ChalkInstance}
+   */
+  static get warning() {
+    return this.orange.bold
+  }
+
+  /**
+   * 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 {import('chalk').ChalkInstance}
+   */
+  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]
+  }
+}

package/src/Helpers/FactoryHelper.js

@@ -0,0 +1,121 @@
+/**
+ * @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 '@secjs/utils'
+
+import { ColorHelper } from '#src/Helpers/ColorHelper'
+
+export class FactoryHelper {
+  /**
+   * Get the timestamp value formatted.
+   *
+   * @return {string}
+   */
+  static getTimestamp() {
+    const localeStringOptions = {
+      year: 'numeric',
+      hour: 'numeric',
+      minute: 'numeric',
+      second: 'numeric',
+      day: '2-digit',
+      month: '2-digit',
+    }
+
+    return new Date(Date.now()).toLocaleString(undefined, localeStringOptions)
+  }
+
+  /**
+   * Get the timestamp diff between logs.
+   *
+   * @param {number} lastTimestamp
+   * @return {string}
+   */
+  static getTimestampDiff(lastTimestamp) {
+    let timestampDiff = ''
+
+    if (lastTimestamp) {
+      timestampDiff = ColorHelper.yellow(` +${Date.now() - lastTimestamp}ms`)
+    }
+
+    return timestampDiff
+  }
+
+  /**
+   * Get the emoji by level.
+   *
+   * @param {string} level
+   * @param {string} [customEmoji]
+   * @return {string}
+   */
+  static getEmojiByLevel(level, customEmoji) {
+    if (customEmoji) {
+      return customEmoji
+    }
+
+    const levelEmojis = {
+      info: '\u{2139}',
+      debug: '\u{1F50E}',
+      warn: '\u{26A0}',
+      error: '\u{274C}',
+      success: '\u{2705}',
+      critical: '\u{1F6D1}',
+    }
+
+    if (!levelEmojis[level.toLowerCase()]) {
+      return ''
+    }
+
+    return levelEmojis[level.toLowerCase()]
+  }
+
+  /**
+   * Paint the message by level.
+   *
+   * @param {string} level
+   * @param {string} message
+   * @return {string}
+   */
+  static paintByLevel(level, message) {
+    level = level.toLowerCase()
+
+    const levelColors = {
+      info: ColorHelper.info,
+      debug: ColorHelper.debug,
+      warn: ColorHelper.warning,
+      error: ColorHelper.error,
+      success: ColorHelper.success,
+      critical: ColorHelper.critical,
+    }
+
+    if (!levelColors[level]) {
+      return message
+    }
+
+    return levelColors[level](message)
+  }
+
+  /**
+   * 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/Providers/LoggerProvider.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,18 +6,17 @@
  * 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.LoggerProvider = void 0;
-const Logger_1 = require("../Logger");
-const ioc_1 = require("@athenna/ioc");
-class LoggerProvider extends ioc_1.ServiceProvider {
-    /**
-     * Register any application services.
-     *
-     * @return void
-     */
-    register() {
-        this.container.bind('Athenna/Core/Logger', Logger_1.Logger);
-    }
+
+import { Logger } from '#src/index'
+import { ServiceProvider } from '@athenna/ioc'
+
+export class LoggerProvider extends ServiceProvider {
+  /**
+   * Register any application services.
+   *
+   * @return void
+   */
+  register() {
+    this.container.bind('Athenna/Core/Logger', Logger)
+  }
 }
-exports.LoggerProvider = LoggerProvider;