@athenna/logger 1.1.8 → 1.1.9

package/src/Factories/DriverFactory.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,63 +6,106 @@
  * 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.DriverFactory = void 0;
-const utils_1 = require("@secjs/utils");
-const PinoDriver_1 = require("../Drivers/PinoDriver");
-const FileDriver_1 = require("../Drivers/FileDriver");
-const NullDriver_1 = require("../Drivers/NullDriver");
-const DebugDriver_1 = require("../Drivers/DebugDriver");
-const SlackDriver_1 = require("../Drivers/SlackDriver");
-const ConsoleDriver_1 = require("../Drivers/ConsoleDriver");
-const DiscordDriver_1 = require("../Drivers/DiscordDriver");
-const TelegramDriver_1 = require("../Drivers/TelegramDriver");
-const NotFoundDriverException_1 = require("../Exceptions/NotFoundDriverException");
-const DriverAlreadyExistException_1 = require("../Exceptions/DriverAlreadyExistException");
-const ChannelNotConfiguredException_1 = require("../Exceptions/ChannelNotConfiguredException");
-class DriverFactory {
-    static availableDrivers() {
-        const availableDrivers = [];
-        for (const [key] of this.drivers.entries()) {
-            availableDrivers.push(key);
-        }
-        return availableDrivers;
+
+import { Config } from '@secjs/utils'
+
+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'
+
+export class DriverFactory {
+  /**
+   * Drivers of DriverFactory.
+   *
+   * @type {Map<string, { Driver: any }>}
+   */
+  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 })
+
+  /**
+   * Return an array with all available drivers.
+   *
+   * @return {any[]}
+   */
+  static availableDrivers() {
+    const availableDrivers = []
+
+    for (const [key] of this.drivers.entries()) {
+      availableDrivers.push(key)
     }
-    static fabricate(channelName, runtimeConfig = {}) {
-        if (channelName === 'default') {
-            channelName = utils_1.Config.get('logging.default');
-        }
-        const channelConfig = this.getChannelConfig(channelName);
-        const driverObject = this.drivers.get(channelConfig.driver);
-        if (!driverObject) {
-            throw new NotFoundDriverException_1.NotFoundDriverException(channelConfig.driver);
-        }
-        return new driverObject.Driver(channelName, runtimeConfig);
+
+    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 = {}) {
+    if (channelName === 'default') {
+      channelName = Config.get('logging.default')
     }
-    static createDriver(name, driver) {
-        if (this.drivers.has(name)) {
-            throw new DriverAlreadyExistException_1.DriverAlreadyExistException(name);
-        }
-        this.drivers.set(name, { Driver: driver });
+
+    const channelConfig = this.#getChannelConfig(channelName)
+    const driverObject = this.drivers.get(channelConfig.driver)
+
+    if (!driverObject) {
+      throw new NotFoundDriverException(channelConfig.driver)
     }
-    static getChannelConfig(channelName) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channelName}`);
-        if (!channelConfig) {
-            throw new ChannelNotConfiguredException_1.ChannelNotConfiguredException(channelName);
-        }
-        if (!this.drivers.has(channelConfig.driver)) {
-            throw new NotFoundDriverException_1.NotFoundDriverException(channelConfig.driver);
-        }
-        return channelConfig;
+
+    return new driverObject.Driver(channelName, runtimeConfig)
+  }
+
+  /**
+   * 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) {
+    const channelConfig = Config.get(`logging.channels.${channelName}`)
+
+    if (!channelConfig) {
+      throw new NotFoundChannelException(channelName)
+    }
+
+    if (!this.drivers.has(channelConfig.driver)) {
+      throw new NotFoundDriverException(channelConfig.driver)
+    }
+
+    return channelConfig
+  }
 }
-exports.DriverFactory = DriverFactory;
-DriverFactory.drivers = new Map()
-    .set('file', { Driver: FileDriver_1.FileDriver })
-    .set('null', { Driver: NullDriver_1.NullDriver })
-    .set('pino', { Driver: PinoDriver_1.PinoDriver })
-    .set('slack', { Driver: SlackDriver_1.SlackDriver })
-    .set('debug', { Driver: DebugDriver_1.DebugDriver })
-    .set('console', { Driver: ConsoleDriver_1.ConsoleDriver })
-    .set('discord', { Driver: DiscordDriver_1.DiscordDriver })
-    .set('telegram', { Driver: TelegramDriver_1.TelegramDriver });

package/src/Factories/FormatterFactory.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,43 +6,74 @@
  * 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.FormatterFactory = void 0;
-const CliFormatter_1 = require("../Formatters/CliFormatter");
-const JsonFormatter_1 = require("../Formatters/JsonFormatter");
-const NestFormatter_1 = require("../Formatters/NestFormatter");
-const SimpleFormatter_1 = require("../Formatters/SimpleFormatter");
-const MessageFormatter_1 = require("../Formatters/MessageFormatter");
-const RequestFormatter_1 = require("../Formatters/RequestFormatter");
-const NotFoundFormatterException_1 = require("../Exceptions/NotFoundFormatterException");
-const FormatterAlreadyExistException_1 = require("../Exceptions/FormatterAlreadyExistException");
-class FormatterFactory {
-    static availableFormatters() {
-        const availableFormatters = [];
-        for (const [key] of this.formatters.entries()) {
-            availableFormatters.push(key);
-        }
-        return availableFormatters;
+
+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'
+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('nest', { Formatter: NestFormatter })
+    .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)
     }
-    static fabricate(formatterName) {
-        const formatterObject = this.formatters.get(formatterName);
-        if (!formatterObject) {
-            throw new NotFoundFormatterException_1.NotFoundFormatterException(formatterName);
-        }
-        return new formatterObject.Formatter();
+
+    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)
     }
-    static createFormatter(name, driver) {
-        if (this.formatters.has(name)) {
-            throw new FormatterAlreadyExistException_1.FormatterAlreadyExistException(name);
-        }
-        this.formatters.set(name, { Formatter: driver });
+
+    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 })
+  }
 }
-exports.FormatterFactory = FormatterFactory;
-FormatterFactory.formatters = new Map()
-    .set('cli', { Formatter: CliFormatter_1.CliFormatter })
-    .set('nest', { Formatter: NestFormatter_1.NestFormatter })
-    .set('json', { Formatter: JsonFormatter_1.JsonFormatter })
-    .set('simple', { Formatter: SimpleFormatter_1.SimpleFormatter })
-    .set('message', { Formatter: MessageFormatter_1.MessageFormatter })
-    .set('request', { Formatter: RequestFormatter_1.RequestFormatter });

package/src/Formatters/CliFormatter.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,25 +6,25 @@
  * 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.CliFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-class CliFormatter {
-    static paintByLevel(level) {
-        const levelColors = {
-            info: Color_1.Color.info,
-            debug: Color_1.Color.debug,
-            warn: Color_1.Color.warning,
-            error: Color_1.Color.error,
-            success: Color_1.Color.log,
-        };
-        if (!levelColors[level.toLowerCase()])
-            return `[  ${level.toLowerCase()}  ]`;
-        return levelColors[level.toLowerCase()](`[  ${level.toLowerCase()}  ]`);
-    }
-    format(message, options) {
-        const level = CliFormatter.paintByLevel(options.level);
-        return `${level} ${message}`;
-    }
+
+import { FactoryHelper } from '#src/index'
+
+export class CliFormatter {
+  /**
+   * 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()
+
+    const level = FactoryHelper.paintByLevel(
+      options.level,
+      `[  ${options.level}  ]`,
+    )
+
+    return `${level} ${message}`
+  }
 }
-exports.CliFormatter = CliFormatter;

package/src/Formatters/JsonFormatter.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,13 +6,19 @@
  * 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.JsonFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-class JsonFormatter {
-    format(message, options) {
-        const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
-        return `${pid} - ${Color_1.Color.bold('JSON:')} ${options.chalk(JSON.stringify(message, null, 2))}`;
-    }
+
+import { ColorHelper } from '#src/index'
+
+export class JsonFormatter {
+  /**
+   *
+   * @param {Record<any, any>} message
+   * @param {{ chalk: import('chalk').ChalkInstance }} options
+   * @return {string}
+   */
+  format(message, options) {
+    const jsonSpaced = JSON.stringify(message, null, 2)
+
+    return `${ColorHelper.bold('JSON:')} ${options.chalk(jsonSpaced)}`
+  }
 }
-exports.JsonFormatter = JsonFormatter;

package/src/Formatters/MessageFormatter.js

@@ -1,4 +1,3 @@
-"use strict";
 /* eslint-disable prettier/prettier */
 /**
  * @athenna/logger
@@ -8,36 +7,34 @@
  * 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.MessageFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-class MessageFormatter {
-    static getTimestampDiff() {
-        let result = '';
-        if (this.lastTimestamp) {
-            result = Color_1.Color.yellow(` +${Date.now() - this.lastTimestamp}ms`);
-        }
-        this.lastTimestamp = Date.now();
-        return result;
-    }
-    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}',
-        };
-        if (!levelEmojis[level.toLowerCase()])
-            return '';
-        return levelEmojis[level.toLowerCase()];
-    }
-    format(message, options) {
-        const timestampDiff = MessageFormatter.getTimestampDiff();
-        const level = MessageFormatter.getEmojiByLevel(options.level, options.customEmoji);
-        return `${level} ${message}${timestampDiff}`;
-    }
+
+import { FactoryHelper } from '#src/index'
+
+export class MessageFormatter {
+  /**
+   * The last timestamp.
+   *
+   * @type {number}
+   */
+  #lastTimestamp
+
+  /**
+   * 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,
+    )
+
+    return `${level} ${message}${timestampDiff}`
+  }
 }
-exports.MessageFormatter = MessageFormatter;

package/src/Formatters/NestFormatter.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,25 +6,35 @@
  * 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.NestFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-const getTimestamp_1 = require("../Utils/getTimestamp");
-class NestFormatter {
-    static getTimestampDiff() {
-        let result = '';
-        if (this.lastTimestamp) {
-            result = Color_1.Color.yellow(` +${Date.now() - this.lastTimestamp}ms`);
-        }
-        this.lastTimestamp = Date.now();
-        return result;
-    }
-    format(message, options) {
-        const pid = Color_1.Color.yellow(`[Athenna] - PID: ${process.pid}`);
-        const timestamp = getTimestamp_1.getTimestamp();
-        const messageCtx = Color_1.Color.yellow(`[${options.context}] `);
-        const timestampDiff = NestFormatter.getTimestampDiff();
-        return `${pid} - ${timestamp} ${messageCtx}${options.chalk(message)}${timestampDiff}`;
-    }
+
+import { ColorHelper, FactoryHelper } from '#src/index'
+
+export class NestFormatter {
+  /**
+   * The last timestamp.
+   *
+   * @type {number}
+   */
+  #lastTimestamp
+
+  /**
+   * Format the message.
+   *
+   * @param {string} message
+   * @param {{ context: string, chalk: import('chalk').ChalkInstance }} options
+   * @return {string}
+   */
+  format(message, options) {
+    const timestampDiff = FactoryHelper.getTimestampDiff(this.#lastTimestamp)
+
+    this.#lastTimestamp = Date.now()
+
+    const pid = ColorHelper.yellow(`[Athenna] - PID: ${process.pid}`)
+    const timestamp = FactoryHelper.getTimestamp()
+    const messageCtx = ColorHelper.yellow(`[${options.context}] `)
+
+    return `${pid} - ${timestamp} ${messageCtx}${options.chalk(
+      message,
+    )}${timestampDiff}`
+  }
 }
-exports.NestFormatter = NestFormatter;

package/src/Formatters/NoneFormatter.js

@@ -0,0 +1,21 @@
+/**
+ * @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.
+ */
+
+export class NoneFormatter {
+  /**
+   * Format the message.
+   *
+   * @param {string} message
+   * @param {any} [_options]
+   * @return {string}
+   */
+  format(message, _options) {
+    return message
+  }
+}

package/src/Formatters/RequestFormatter.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,41 +6,54 @@
  * 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.RequestFormatter = void 0;
-const Color_1 = require("../Utils/Color");
-class RequestFormatter {
-    format(ctx, options) {
-        const ip = ctx.request.ip;
-        const status = ctx.status;
-        const responseTimeMs = `${Math.round(ctx.responseTime)}ms`;
-        const methodAndUrl = Color_1.Color[ctx.request.method](`${ctx.request.method}::${ctx.request.baseUrl}`);
-        if (!options.asJson) {
-            return `(${ip}) - [${status}] ${methodAndUrl} ${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(),
-            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 });
+
+import { ColorHelper } from '#src/index'
+
+export class RequestFormatter {
+  /**
+   * Format the message.
+   *
+   * @param {any} ctx
+   * @param {{ asJson: boolean, chalk: import('chalk').ChalkInstance }} options
+   * @return {string}
+   */
+  format(ctx, options) {
+    const ip = ctx.request.ip
+    const status = ctx.status
+    const responseTimeMs = `${Math.round(ctx.responseTime)}ms`
+    const methodAndUrl = ColorHelper[ctx.request.method](
+      `${ctx.request.method}::${ctx.request.baseUrl}`,
+    )
+
+    if (!options.asJson) {
+      return `(${ip}) - [${status}] ${methodAndUrl} ${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(),
+      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 })
+  }
 }
-exports.RequestFormatter = RequestFormatter;