@athenna/logger 3.0.8 → 3.1.0

package/build/Factories/DriverFactory.js

@@ -0,0 +1,93 @@
+/**
+ * @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 { Options } from '@athenna/common';
+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 { FactoryHelper } from '#src/Helpers/FactoryHelper';
+import { TelegramDriver } from '#src/Drivers/TelegramDriver';
+import { DriverExistException } from '#src/Exceptions/DriverExistException';
+import { NotFoundDriverException } from '#src/Exceptions/NotFoundDriverException';
+import { NotImplementedConfigException } from '#src/Exceptions/NotImplementedConfigException';
+export class DriverFactory {
+    /**
+     * Drivers of DriverFactory.
+     */
+    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.
+     */
+    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.
+     */
+    static fabricate(channelName, configs = {}) {
+        const channelConfig = this.getChannelConfig(channelName);
+        const { Driver } = this.drivers.get(channelConfig.driver);
+        return new Driver(FactoryHelper.groupConfigs(configs, channelConfig));
+    }
+    /**
+     * Fabricate a new instance of a driver with vanilla
+     * configurations.
+     */
+    static fabricateVanilla(configs = {}) {
+        configs = Options.create(configs, {
+            driver: 'console',
+            formatter: 'none',
+        });
+        if (!this.drivers.has(configs.driver)) {
+            throw new NotFoundDriverException(configs.driver);
+        }
+        const { Driver } = this.drivers.get(configs.driver);
+        return new Driver(configs);
+    }
+    /**
+     * Creates a new driver implementation.
+     */
+    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.
+     */
+    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/build/Factories/FormatterFactory.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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 declare class FormatterFactory {
+    /**
+     * Formatters of FormatterFactory.
+     */
+    static formatters: Map<string, {
+        Formatter: any;
+    }>;
+    /**
+     * Return an array with all available formatters.
+     */
+    static availableFormatters(): string[];
+    /**
+     * Fabricate a new instance of a formatter.
+     */
+    static fabricate(formatterName: string): Formatter;
+    /**
+     * Creates a new formatter implementation.
+     */
+    static createFormatter(name: string, formatter: typeof Formatter): void;
+}

package/build/Factories/FormatterFactory.js

@@ -0,0 +1,57 @@
+/**
+ * @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.
+     */
+    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.
+     */
+    static availableFormatters() {
+        const availableFormatters = [];
+        for (const [key] of this.formatters.entries()) {
+            availableFormatters.push(key);
+        }
+        return availableFormatters;
+    }
+    /**
+     * Fabricate a new instance of a formatter.
+     */
+    static fabricate(formatterName) {
+        const formatterObject = this.formatters.get(formatterName);
+        if (!formatterObject) {
+            throw new NotFoundFormatterException(formatterName);
+        }
+        return new formatterObject.Formatter();
+    }
+    /**
+     * Creates a new formatter implementation.
+     */
+    static createFormatter(name, formatter) {
+        if (this.formatters.has(name)) {
+            throw new FormatterExistException(name);
+        }
+        this.formatters.set(name, { Formatter: formatter });
+    }
+}

package/build/Formatters/CliFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class CliFormatter extends Formatter {
+    format(message: string): string;
+}

package/build/Formatters/CliFormatter.js

@@ -0,0 +1,15 @@
+/**
+ * @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(message) {
+        const level = this.cliLevel();
+        return this.clean(`${level} ${this.toString(message)}`);
+    }
+}

package/build/Formatters/Formatter.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @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 declare abstract class Formatter {
+    /**
+     * Holds the configuration object of formatter.
+     */
+    configs: any;
+    /**
+     * Creates a new instance of Formatter.
+     */
+    config(configs: any): Formatter;
+    /**
+     * Format the message.
+     */
+    abstract format(message: any): string;
+    /**
+     * Create the PID for formatter.
+     */
+    pid(): string;
+    /**
+     * Create the hostname for formatter.
+     */
+    hostname(): string;
+    /**
+     * Get the level without any color or format.
+     */
+    level(): string;
+    /**
+     * Get the trace id for formatter.
+     */
+    traceId(): string | null;
+    /**
+     * Create the timestamp for formatter.
+     */
+    timestamp(): string;
+    /**
+     * Transform the message to string.
+     */
+    toString(message: string): string;
+    /**
+     * 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.
+     */
+    clean(message: string, force?: boolean): string;
+    /**
+     * Apply all colors necessary to message.
+     */
+    applyColors(message: string): string;
+    /**
+     * Apply colors in message.
+     */
+    applyColorsByChalk(message: string): string;
+    /**
+     * Apply colors in message by level.
+     */
+    applyColorsByLevel(message: string): string;
+    /**
+     * Create the cli level string.
+     */
+    cliLevel(): string;
+    /**
+     * Create the simple level string.
+     */
+    simpleLevel(): string;
+    /**
+     * Create the message level emoji string.
+     */
+    messageLevel(): string;
+    /**
+     * Get the emoji by level.
+     */
+    getEmojiByLevel(level: string, customEmoji?: string): string;
+    /**
+     * Paint the message by level.
+     */
+    paintMessageByLevel(level: string, message: string): string;
+}

package/build/Formatters/Formatter.js

@@ -0,0 +1,177 @@
+/**
+ * @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.
+     */
+    config(configs) {
+        this.configs = configs;
+        return this;
+    }
+    /**
+     * Create the PID for formatter.
+     */
+    pid() {
+        return process.pid.toString();
+    }
+    /**
+     * Create the hostname for formatter.
+     */
+    hostname() {
+        return hostname();
+    }
+    /**
+     * Get the level without any color or format.
+     */
+    level() {
+        return this.configs.level;
+    }
+    /**
+     * Get the trace id for formatter.
+     */
+    traceId() {
+        return (rTracer.id() || null);
+    }
+    /**
+     * Create the timestamp for formatter.
+     */
+    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.
+     */
+    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.
+     */
+    clean(message, force = false) {
+        if (this.configs.clean || force) {
+            return ColorHelper.removeColors(message);
+        }
+        return message;
+    }
+    /**
+     * Apply all colors necessary to message.
+     */
+    applyColors(message) {
+        message = this.toString(message);
+        return this.applyColorsByChalk(this.applyColorsByLevel(message));
+    }
+    /**
+     * Apply colors in message.
+     */
+    applyColorsByChalk(message) {
+        if (!this.configs.chalk) {
+            return message;
+        }
+        return this.configs.chalk(message);
+    }
+    /**
+     * Apply colors in message by level.
+     */
+    applyColorsByLevel(message) {
+        const level = this.configs.level;
+        return this.paintMessageByLevel(level, message);
+    }
+    /**
+     * Create the cli level string.
+     */
+    cliLevel() {
+        const level = this.configs.level;
+        if (!ColorHelper[level]) {
+            return level;
+        }
+        return ColorHelper[level].bold(`[  ${level}  ]`);
+    }
+    /**
+     * Create the simple level string.
+     */
+    simpleLevel() {
+        const level = this.configs.level;
+        if (!ColorHelper[level]) {
+            return level;
+        }
+        return ColorHelper[level].bold(`[${level.toUpperCase()}]`);
+    }
+    /**
+     * Create the message level emoji string.
+     */
+    messageLevel() {
+        const level = this.configs.level;
+        return this.getEmojiByLevel(level, this.configs.customEmoji);
+    }
+    /**
+     * Get the emoji by level.
+     */
+    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.
+     */
+    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/build/Formatters/JsonFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class JsonFormatter extends Formatter {
+    format(message: any): string;
+}

package/build/Formatters/JsonFormatter.js

@@ -0,0 +1,26 @@
+/**
+ * @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(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 });
+    }
+}

package/build/Formatters/MessageFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class MessageFormatter extends Formatter {
+    format(message: string): string;
+}

package/build/Formatters/MessageFormatter.js

@@ -0,0 +1,14 @@
+/**
+ * @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(message) {
+        return this.clean(`${this.messageLevel()} - (${this.pid()}) - (${this.hostname()}): ${this.toString(message)}`);
+    }
+}

package/build/Formatters/NoneFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class NoneFormatter extends Formatter {
+    format(message: string): string;
+}

package/{src → build}/Formatters/NoneFormatter.js

@@ -6,17 +6,9 @@
  * 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'
-
+import { Formatter } from '#src/Formatters/Formatter';
 export class NoneFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    return this.clean(this.toString(message))
-  }
+    format(message) {
+        return this.clean(this.toString(message));
+    }
 }

package/build/Formatters/RequestFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class RequestFormatter extends Formatter {
+    format(ctx: any): string;
+}

package/build/Formatters/RequestFormatter.js

@@ -0,0 +1,45 @@
+/**
+ * @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(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/build/Formatters/SimpleFormatter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class SimpleFormatter extends Formatter {
+    format(message: string): string;
+}

package/build/Formatters/SimpleFormatter.js

@@ -0,0 +1,18 @@
+/**
+ * @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(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}`);
+    }
+}