@athenna/logger 1.1.8 → 1.2.1

package/src/Drivers/PinoDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,66 +6,89 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PinoDriver = void 0;
-const pino_1 = __importDefault(require("pino"));
-const utils_1 = require("@secjs/utils");
-const groupConfigs_1 = require("../Utils/groupConfigs");
-const OnlyPinoPrettyException_1 = require("../Exceptions/OnlyPinoPrettyException");
-class PinoDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this.configs = groupConfigs_1.groupConfigs(configs, channelConfig);
+
+import pino from 'pino'
+
+import { Config } from '@secjs/utils'
+
+import { FactoryHelper } from '#src/index'
+import { OnlyPinoPrettyException } from '#src/Exceptions/OnlyPinoPrettyException'
+
+export class PinoDriver {
+  /**
+   * Holds the configuration set of PinoDriver.
+   *
+   * @type {import('pino').LoggerOptions & { formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of PinoDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {PinoDriver}
+   */
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {import('pino').LoggerOptions & { formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }} [options]
+   * @return {void}
+   */
+  transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    configs.customLevels = {
+      info: 1,
+      warn: 2,
+      error: 3,
+      debug: 4,
+      success: 5,
+      critical: 6,
     }
-    transport(message, options = {}) {
-        const configs = groupConfigs_1.groupConfigs(options, this.configs);
-        configs.customLevels = {
-            info: 1,
-            warn: 2,
-            error: 3,
-            debug: 4,
-            success: 5,
-        };
-        configs.useOnlyCustomLevels = true;
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        const pinoMethod = configs.formatterConfig.level.toLowerCase();
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        delete configs.formatterConfig.level;
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        delete configs.formatterConfig.chalk;
-        if (configs.formatter !== 'pino-pretty') {
-            throw new OnlyPinoPrettyException_1.OnlyPinoPrettyException();
-        }
-        const pinoConfigs = {};
-        Object.keys(configs).forEach(key => {
-            if (key === 'formatter') {
-                pinoConfigs.transport = {
-                    target: 'pino-pretty',
-                    options: configs.formatterConfig,
-                };
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                configs.formatterConfig.customLevels =
-                    'info:1,warn:2,error:3,debug:4,success:5';
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                configs.formatterConfig.customColors =
-                    'info:cyan,warn:yellow,error:red,debug:magenta,success:green';
-                return;
-            }
-            if (['driver', 'formatterConfig'].includes(key)) {
-                return;
-            }
-            pinoConfigs[key] = configs[key];
-        });
-        const logger = pino_1.default(pinoConfigs);
-        return logger[pinoMethod](message);
+    configs.useOnlyCustomLevels = true
+
+    const pinoMethod = configs.formatterConfig.level.toLowerCase()
+
+    delete configs.formatterConfig.level
+    delete configs.formatterConfig.chalk
+
+    if (configs.formatter !== 'pino-pretty') {
+      throw new OnlyPinoPrettyException()
     }
+
+    const pinoConfigs = {}
+
+    Object.keys(configs).forEach(key => {
+      if (key === 'formatter') {
+        pinoConfigs.transport = {
+          target: 'pino-pretty',
+          options: configs.formatterConfig,
+        }
+        configs.formatterConfig.customLevels =
+          'info:1,warn:2,error:3,debug:4,success:5,critical:6'
+        configs.formatterConfig.customColors =
+          'info:cyan,warn:yellow,error:red,debug:magenta,success:green,critical:red'
+
+        return
+      }
+
+      if (['driver', 'formatterConfig'].includes(key)) {
+        return
+      }
+
+      pinoConfigs[key] = configs[key]
+    })
+
+    const logger = pino(pinoConfigs)
+
+    logger[pinoMethod](message)
+  }
 }
-exports.PinoDriver = PinoDriver;

package/src/Drivers/SlackDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,25 +6,49 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SlackDriver = void 0;
-const axios_1 = __importDefault(require("axios"));
-const utils_1 = require("@secjs/utils");
-const Color_1 = require("../Utils/Color");
-const groupConfigs_1 = require("../Utils/groupConfigs");
-const FormatterFactory_1 = require("../Factories/FormatterFactory");
-class SlackDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this.configs = groupConfigs_1.groupConfigs(configs, channelConfig);
-    }
-    async transport(message, options = {}) {
-        const configs = groupConfigs_1.groupConfigs(options, this.configs);
-        message = FormatterFactory_1.FormatterFactory.fabricate(configs.formatter).format(message, configs.formatterConfig);
-        await axios_1.default.post(configs.url, { text: Color_1.Color.removeColors(message) });
-    }
+
+import axios from 'axios'
+
+import { Config } from '@secjs/utils'
+
+import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
+
+export class SlackDriver {
+  /**
+   * Holds the configuration set of SlackDriver.
+   *
+   * @type {{ url?: string, formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of SlackDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {SlackDriver}
+   */
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ url?: string, formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }} [options]
+   * @return {Promise<void>}
+   */
+  async transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    await axios.post(configs.url, { text: ColorHelper.removeColors(message) })
+  }
 }
-exports.SlackDriver = SlackDriver;

package/src/Drivers/TelegramDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,24 +6,48 @@
  * 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.TelegramDriver = void 0;
-const telegraf_1 = require("telegraf");
-const utils_1 = require("@secjs/utils");
-const Color_1 = require("../Utils/Color");
-const groupConfigs_1 = require("../Utils/groupConfigs");
-const FormatterFactory_1 = require("../Factories/FormatterFactory");
-class TelegramDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this.configs = groupConfigs_1.groupConfigs(configs, channelConfig);
-    }
-    async transport(message, options = {}) {
-        const configs = groupConfigs_1.groupConfigs(options, this.configs);
-        message = FormatterFactory_1.FormatterFactory.fabricate(configs.formatter).format(message, configs.formatterConfig);
-        await new telegraf_1.Telegraf(configs.token).telegram.sendMessage(configs.chatId, Color_1.Color.removeColors(message), {
-            parse_mode: configs.parseMode,
-        });
-    }
+
+import { Telegraf } from 'telegraf'
+
+import { Config } from '@secjs/utils'
+
+import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
+
+export class TelegramDriver {
+  /**
+   * Holds the configuration set of SlackDriver.
+   *
+   * @type {{ token?: string, chatId?: string|number, parseMode?: 'HTML'|'Markdown'|'MarkdownV2', formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }}
+   */
+  configs
+
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ token?: string, chatId?: string|number, parseMode?: 'HTML'|'Markdown'|'MarkdownV2', formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }} [options]
+   * @return {Promise<void>}
+   */
+  async transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    await new Telegraf(configs.token).telegram.sendMessage(
+      configs.chatId,
+      ColorHelper.removeColors(message),
+      {
+        parse_mode: configs.parseMode,
+      },
+    )
+  }
 }
-exports.TelegramDriver = TelegramDriver;

package/src/Exceptions/DriverExistException.js

@@ -0,0 +1,31 @@
+/**
+ * @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 '@secjs/utils'
+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

@@ -0,0 +1,32 @@
+/**
+ * @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 '@secjs/utils'
+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/NotFoundChannelException.js

@@ -0,0 +1,32 @@
+/**
+ * @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, Exception } from '@secjs/utils'
+
+export class NotFoundChannelException extends Exception {
+  /**
+   * Creates a new instance of NotFoundChannelException.
+   *
+   * @param {string} channelName
+   * @return {NotFoundChannelException}
+   */
+  constructor(channelName) {
+    const content = `Channel ${channelName} not found.`
+    const availableChannels = Object.keys(Config.get('logging.channels')).join(
+      ', ',
+    )
+
+    super(
+      content,
+      500,
+      'E_NOT_FOUND',
+      `Available channels are: ${availableChannels}. Look into your config/logger file if ${channelName} channel is inside "channels" property, if it does not exist create ${channelName} channel object inside "channels".`,
+    )
+  }
+}

package/src/Exceptions/NotFoundDriverException.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,13 +6,26 @@
  * 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.NotFoundDriverException = void 0;
-const utils_1 = require("@secjs/utils");
-class NotFoundDriverException extends utils_1.Exception {
-    constructor(driverName) {
-        const content = `The driver ${driverName} has not been found`;
-        super(content, 500, 'NOT_FOUND_ERROR', `Look into your config/logger file if this driver is implemented by logger. Or create this driver implementation using Logger.buildDriver method`);
-    }
+
+import { Exception } from '@secjs/utils'
+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 file if ${driverName} driver is implemented by logger. Or create ${driverName} driver implementation using DriverFactory.createDriver("${driverName}", ...) method.`,
+    )
+  }
 }
-exports.NotFoundDriverException = NotFoundDriverException;

package/src/Exceptions/NotFoundFormatterException.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,13 +6,26 @@
  * 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.NotFoundFormatterException = void 0;
-const utils_1 = require("@secjs/utils");
-class NotFoundFormatterException extends utils_1.Exception {
-    constructor(formatterName) {
-        const content = `The formatter ${formatterName} has not been found`;
-        super(content, 500, 'NOT_FOUND_ERROR', `Look into your config/logger file if this formatter is implemented by logger. Or create this formatter implementation using Logger.buildFormatter method`);
-    }
+
+import { Exception } from '@secjs/utils'
+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 file if ${formatterName} formatter is implemented by logger. Or create ${formatterName} formatter implementation using FormatterFactory.createFormatter("${formatterName}", ...) method.`,
+    )
+  }
 }
-exports.NotFoundFormatterException = NotFoundFormatterException;

package/src/Exceptions/OnlyPinoPrettyException.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,13 +6,23 @@
  * 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.OnlyPinoPrettyException = void 0;
-const utils_1 = require("@secjs/utils");
-class OnlyPinoPrettyException extends utils_1.Exception {
-    constructor() {
-        const content = `The driver "pino" can only be used with "pino-pretty" formatter.`;
-        super(content, 500, 'ONLY_PINO-PRETTY_EXCEPTION', `Look into your config/logger file the formatter that you are trying to use with your channel configuration.`);
-    }
+
+import { Exception } from '@secjs/utils'
+
+export class OnlyPinoPrettyException extends Exception {
+  /**
+   * Creates a new instance of OnlyPinoPrettyException.
+   *
+   * @return {OnlyPinoPrettyException}
+   */
+  constructor() {
+    const content = `The driver "pino" can only be used with "pino-pretty" formatter.`
+
+    super(
+      content,
+      500,
+      'E_PINO_PRETTY',
+      `Available formatters are: pino-pretty. Look into your config/logger file where your are using "pino" driver and change the formatter to pino-pretty.`,
+    )
+  }
 }
-exports.OnlyPinoPrettyException = OnlyPinoPrettyException;

package/src/Facades/Log.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,7 +6,12 @@
  * 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.Log = void 0;
-const ioc_1 = require("@athenna/ioc");
-exports.Log = ioc_1.Facade.createFor('Athenna/Core/Logger');
+
+import { Facade } from '@athenna/ioc'
+
+/**
+ * Log facade.
+ *
+ * @type {Facade & import('../index').Logger}
+ */
+export const Log = Facade.createFor('Athenna/Core/Logger')