@athenna/logger 3.1.0 → 3.1.1

package/build/Formatters/Formatter.js

@@ -8,8 +8,7 @@
  */
 import rTracer from 'cls-rtracer';
 import { hostname } from 'node:os';
-import { Is } from '@athenna/common';
-import { ColorHelper } from '#src/Helpers/ColorHelper';
+import { Is, Color } from '@athenna/common';
 export class Formatter {
     /**
      * Holds the configuration object of formatter.
@@ -80,7 +79,7 @@ export class Formatter {
      */
     clean(message, force = false) {
         if (this.configs.clean || force) {
-            return ColorHelper.removeColors(message);
+            return Color.removeColors(message);
         }
         return message;
     }
@@ -112,20 +111,20 @@ export class Formatter {
      */
     cliLevel() {
         const level = this.configs.level;
-        if (!ColorHelper[level]) {
+        if (!Color[level]) {
             return level;
         }
-        return ColorHelper[level].bold(`[  ${level}  ]`);
+        return Color[level].bold(`[  ${level}  ]`);
     }
     /**
      * Create the simple level string.
      */
     simpleLevel() {
         const level = this.configs.level;
-        if (!ColorHelper[level]) {
+        if (!Color[level]) {
             return level;
         }
-        return ColorHelper[level].bold(`[${level.toUpperCase()}]`);
+        return Color[level].bold(`[${level.toUpperCase()}]`);
     }
     /**
      * Create the message level emoji string.
@@ -161,13 +160,13 @@ export class Formatter {
     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,
+            trace: Color.trace,
+            debug: Color.debug,
+            info: Color.info,
+            success: Color.success,
+            warn: Color.warn,
+            error: Color.error,
+            fatal: Color.fatal,
         };
         if (!levelColors[levelLower]) {
             return message;

package/build/Formatters/RequestFormatter.js

@@ -6,14 +6,17 @@
  * 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 { Color, Is } from '@athenna/common';
 import { Formatter } from '#src/Formatters/Formatter';
 export class RequestFormatter extends Formatter {
     format(ctx) {
+        if (Is.String(ctx)) {
+            return 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}]`);
+        const methodAndStatus = Color[ctx.request.method](`[${ctx.request.method}::${ctx.status}]`);
         if (!this.configs.asJson) {
             return this.clean(`${methodAndStatus} - [${ip}] - ${new Date().toISOString()} - ${ctx.request.baseUrl} ${responseTimeMs}`);
         }

package/build/Logger/Logger.js

@@ -6,8 +6,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import { Color } from '@athenna/common';
 import { Config } from '@athenna/config';
-import { ColorHelper } from '#src/Helpers/ColorHelper';
 import { VanillaLogger } from '#src/Logger/VanillaLogger';
 import { DriverFactory } from '#src/Factories/DriverFactory';
 export class Logger {
@@ -47,7 +47,7 @@ export class Logger {
      * Call drivers to transport the log.
      */
     async log(level, ...args) {
-        const message = ColorHelper.applyLogEngine(...args);
+        const message = Color.apply(...args);
         const promises = this.drivers.map((driver) => driver.transport(level, message));
         return Promise.all(promises);
     }

package/build/Logger/VanillaLogger.d.ts

@@ -12,6 +12,11 @@ export declare class VanillaLogger {
      */
     drivers: any[];
     constructor(configs: any);
+    /**
+     * Log a simple log message without using the log driver
+     * but using the Color engine.
+     */
+    simple(...args: any[]): void;
     /**
      * Set runtime configurations for drivers and
      * formatters.

package/build/Logger/VanillaLogger.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { ColorHelper } from '#src/Helpers/ColorHelper';
+import { Color } from '@athenna/common';
 import { DriverFactory } from '#src/Factories/DriverFactory';
 export class VanillaLogger {
     /**
@@ -16,6 +16,13 @@ export class VanillaLogger {
     constructor(configs) {
         this.drivers.push(DriverFactory.fabricateVanilla(configs));
     }
+    /**
+     * Log a simple log message without using the log driver
+     * but using the Color engine.
+     */
+    simple(...args) {
+        process.stdout.write(Color.apply(...args).concat('\n'));
+    }
     /**
      * Set runtime configurations for drivers and
      * formatters.
@@ -37,7 +44,7 @@ export class VanillaLogger {
      * @return {any | Promise<any>}
      */
     log(level, ...args) {
-        const message = ColorHelper.applyLogEngine(...args);
+        const message = Color.apply(...args);
         const promises = this.drivers.map((driver) => driver.transport(level, message));
         return Promise.all(promises);
     }

package/build/index.d.ts

@@ -9,7 +9,6 @@
 export * from './Facades/Log.js';
 export * from './Logger/Logger.js';
 export * from './Drivers/Driver.js';
-export * from './Helpers/ColorHelper.js';
 export * from './Formatters/Formatter.js';
 export * from './Logger/VanillaLogger.js';
 export * from './Helpers/FactoryHelper.js';

package/build/index.js

@@ -9,7 +9,6 @@
 export * from './Facades/Log.js';
 export * from './Logger/Logger.js';
 export * from './Drivers/Driver.js';
-export * from './Helpers/ColorHelper.js';
 export * from './Formatters/Formatter.js';
 export * from './Logger/VanillaLogger.js';
 export * from './Helpers/FactoryHelper.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -13,7 +13,6 @@
     "telegram",
     "console",
     "debug",
-    "pino",
     "buckets",
     "logger",
     "drivers",
@@ -22,10 +21,10 @@
     "esm"
   ],
   "scripts": {
-    "build": "rimraf build && tsc",
+    "build": "ts-node bin/build.ts",
     "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix",
-    "test": "npm run --silent lint:fix && ts-node ./bin/test.ts",
-    "test:debug": "cross-env DEBUG=api:* ts-node ./bin/test.ts --inspect",
+    "test": "npm run --silent lint:fix && ts-node bin/test.ts",
+    "test:debug": "cross-env DEBUG=api:* ts-node bin/test.ts --inspect",
     "test:coverage": "c8 npm run --silent test"
   },
   "files": [
@@ -49,7 +48,6 @@
     "./providers/LoggerProvider": "./build/Providers/LoggerProvider.js"
   },
   "dependencies": {
-    "chalk": "^5.2.0",
     "telegraf": "^4.11.2"
   },
   "devDependencies": {
@@ -153,7 +151,8 @@
       "ioc": true,
       "Env": true,
       "Path": true,
-      "Config": true
+      "Config": true,
+      "container": true
     },
     "plugins": [
       "prettier",

package/build/Helpers/ColorHelper.d.ts

@@ -1,131 +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 { ChalkInstance } from 'chalk';
-export declare class ColorHelper {
-    /**
-     * Chalk instance.
-     */
-    static chalk: ChalkInstance;
-    /**
-     * Paint as bold.
-     */
-    static get bold(): ChalkInstance;
-    /**
-     * Paint as grey.
-     */
-    static get grey(): ChalkInstance;
-    /**
-     * Paint as purple.
-     */
-    static get purple(): ChalkInstance;
-    /**
-     * Paint as darkPurple.
-     */
-    static get darkPurple(): ChalkInstance;
-    /**
-     * Paint as yellow.
-     */
-    static get yellow(): ChalkInstance;
-    /**
-     * Paint as cyan.
-     */
-    static get cyan(): ChalkInstance;
-    /**
-     * Paint as white.
-     */
-    static get white(): ChalkInstance;
-    /**
-     * Paint as orange.
-     */
-    static get orange(): ChalkInstance;
-    /**
-     * Paint as green.
-     */
-    static get green(): ChalkInstance;
-    /**
-     * Paint as darkGreen.
-     */
-    static get darkGreen(): ChalkInstance;
-    /**
-     * Paint as red.
-     */
-    static get red(): ChalkInstance;
-    /**
-     * Paint as darkRed.
-     */
-    static get darkRed(): ChalkInstance;
-    /**
-     * Paint debugs.
-     */
-    static get trace(): ChalkInstance;
-    /**
-     * Paint debugs.
-     */
-    static get debug(): ChalkInstance;
-    /**
-     * Paint infos.
-     */
-    static get info(): ChalkInstance;
-    /**
-     * Paint success.
-     */
-    static get success(): ChalkInstance;
-    /**
-     * Paint warning.
-     */
-    static get warn(): ChalkInstance;
-    /**
-     * Paint error.
-     */
-    static get error(): ChalkInstance;
-    /**
-     * Paint fatal.
-     */
-    static get fatal(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get GET(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get HEAD(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get PUT(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get PATCH(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get POST(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get DELETE(): ChalkInstance;
-    /**
-     * Paint http method.
-     */
-    static get OPTIONS(): ChalkInstance;
-    /**
-     * Remove all colors and special chars of string.
-     */
-    static removeColors(value: string): string;
-    /**
-     * Paint by the http method.
-     */
-    static httpMethod(method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD'): ChalkInstance;
-    /**
-     * Applies the log engine to execute chalk methods.
-     */
-    static applyLogEngine(...args: string[]): any;
-}

package/build/Helpers/ColorHelper.js

@@ -1,215 +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 { format } from 'node:util';
-import { Is } from '@athenna/common';
-import { Chalk } from 'chalk';
-export class ColorHelper {
-    /**
-     * Chalk instance.
-     */
-    static chalk = new Chalk();
-    /**
-     * Paint as bold.
-     */
-    static get bold() {
-        return ColorHelper.chalk.bold;
-    }
-    /**
-     * Paint as grey.
-     */
-    static get grey() {
-        return ColorHelper.chalk.hex('#505050');
-    }
-    /**
-     * Paint as purple.
-     */
-    static get purple() {
-        return ColorHelper.chalk.hex('#7628c8');
-    }
-    /**
-     * Paint as darkPurple.
-     */
-    static get darkPurple() {
-        return ColorHelper.chalk.hex('#501b86');
-    }
-    /**
-     * Paint as yellow.
-     */
-    static get yellow() {
-        return ColorHelper.chalk.hex('#ffe600');
-    }
-    /**
-     * Paint as cyan.
-     */
-    static get cyan() {
-        return ColorHelper.chalk.hex('#00ffff');
-    }
-    /**
-     * Paint as white.
-     */
-    static get white() {
-        return ColorHelper.chalk.hex('#ffffff');
-    }
-    /**
-     * Paint as orange.
-     */
-    static get orange() {
-        return ColorHelper.chalk.hex('#f18b0e');
-    }
-    /**
-     * Paint as green.
-     */
-    static get green() {
-        return ColorHelper.chalk.hex('#0ef12c');
-    }
-    /**
-     * Paint as darkGreen.
-     */
-    static get darkGreen() {
-        return ColorHelper.chalk.hex('#1cb70b');
-    }
-    /**
-     * Paint as red.
-     */
-    static get red() {
-        return ColorHelper.chalk.hex('#f10e0e');
-    }
-    /**
-     * Paint as darkRed.
-     */
-    static get darkRed() {
-        return ColorHelper.chalk.hex('#710909');
-    }
-    /**
-     * Paint debugs.
-     */
-    static get trace() {
-        return this.grey.bold;
-    }
-    /**
-     * Paint debugs.
-     */
-    static get debug() {
-        return this.purple.bold;
-    }
-    /**
-     * Paint infos.
-     */
-    static get info() {
-        return this.cyan;
-    }
-    /**
-     * Paint success.
-     */
-    static get success() {
-        return this.green;
-    }
-    /**
-     * Paint warning.
-     */
-    static get warn() {
-        return this.orange;
-    }
-    /**
-     * Paint error.
-     */
-    static get error() {
-        return this.red;
-    }
-    /**
-     * Paint fatal.
-     */
-    static get fatal() {
-        return ColorHelper.chalk.bgRed;
-    }
-    /**
-     * Paint http method.
-     */
-    static get GET() {
-        return this.purple.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get HEAD() {
-        return this.cyan.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get PUT() {
-        return this.orange.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get PATCH() {
-        return this.yellow.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get POST() {
-        return this.green.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get DELETE() {
-        return this.red.bold;
-    }
-    /**
-     * Paint http method.
-     */
-    static get OPTIONS() {
-        return this.cyan.bold;
-    }
-    /**
-     * Remove all colors and special chars of string.
-     */
-    static removeColors(value) {
-        return ColorHelper.chalk.reset(value).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.
-     */
-    static httpMethod(method) {
-        return this[method];
-    }
-    /**
-     * Applies the log engine to execute chalk methods.
-     */
-    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;
-    }
-}