@athenna/logger 3.0.9 → 3.1.1

package/build/Helpers/FactoryHelper.js

@@ -0,0 +1,20 @@
+/**
+ * @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 '@athenna/common';
+export class FactoryHelper {
+    /**
+     * Group the configuration values.
+     */
+    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/build/Logger/Logger.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 { VanillaLogger } from '#src/Logger/VanillaLogger';
+export declare class Logger {
+    /**
+     * The drivers responsible for transporting the logs.
+     */
+    private drivers;
+    /**
+     * Runtime configurations to be used inside the Drivers and Formatters.
+     */
+    private runtimeConfigs;
+    constructor();
+    /**
+     * Set runtime configurations for drivers and
+     * formatters.
+     */
+    config(runtimeConfigs: any): this;
+    /**
+     * Change the log channel.
+     */
+    channel(...channels: string[]): this;
+    /**
+     * Call drivers to transport the log.
+     */
+    private log;
+    /**
+     * Creates a log of type trace in channel.
+     */
+    trace(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type debug in channel.
+     */
+    debug(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type info in channel.
+     */
+    info(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type success in channel.
+     */
+    success(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type warn in channel.
+     */
+    warn(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type error in channel.
+     */
+    error(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type fatal in channel.
+     */
+    fatal(...args: any[]): any | Promise<any>;
+    /**
+     * Get a new instance of any log driver
+     * with vanilla configurations. By default,
+     * vanilla logger will use the "console" driver
+     * and "none" formatter.
+     */
+    static getVanillaLogger(configs?: any): VanillaLogger;
+}

package/build/Logger/Logger.js

@@ -0,0 +1,105 @@
+/**
+ * @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 { Color } from '@athenna/common';
+import { Config } from '@athenna/config';
+import { VanillaLogger } from '#src/Logger/VanillaLogger';
+import { DriverFactory } from '#src/Factories/DriverFactory';
+export class Logger {
+    /**
+     * The drivers responsible for transporting the logs.
+     */
+    drivers = [];
+    /**
+     * Runtime configurations to be used inside the Drivers and Formatters.
+     */
+    runtimeConfigs = {};
+    constructor() {
+        if (!Config.exists(`logging.channels.${Config.get('logging.default')}`)) {
+            return this;
+        }
+        this.drivers.push(DriverFactory.fabricate('default', this.runtimeConfigs));
+    }
+    /**
+     * Set runtime configurations for drivers and
+     * formatters.
+     */
+    config(runtimeConfigs) {
+        this.runtimeConfigs = runtimeConfigs;
+        return this;
+    }
+    /**
+     * Change the log channel.
+     */
+    channel(...channels) {
+        this.drivers = [];
+        channels.forEach(c => {
+            this.drivers.push(DriverFactory.fabricate(c, this.runtimeConfigs));
+        });
+        return this;
+    }
+    /**
+     * Call drivers to transport the log.
+     */
+    async log(level, ...args) {
+        const message = Color.apply(...args);
+        const promises = this.drivers.map((driver) => driver.transport(level, message));
+        return Promise.all(promises);
+    }
+    /**
+     * Creates a log of type trace in channel.
+     */
+    trace(...args) {
+        return this.log('trace', ...args);
+    }
+    /**
+     * Creates a log of type debug in channel.
+     */
+    debug(...args) {
+        return this.log('debug', ...args);
+    }
+    /**
+     * Creates a log of type info in channel.
+     */
+    info(...args) {
+        return this.log('info', ...args);
+    }
+    /**
+     * Creates a log of type success in channel.
+     */
+    success(...args) {
+        return this.log('success', ...args);
+    }
+    /**
+     * Creates a log of type warn in channel.
+     */
+    warn(...args) {
+        return this.log('warn', ...args);
+    }
+    /**
+     * Creates a log of type error in channel.
+     */
+    error(...args) {
+        return this.log('error', ...args);
+    }
+    /**
+     * Creates a log of type fatal in channel.
+     */
+    fatal(...args) {
+        return this.log('fatal', ...args);
+    }
+    /**
+     * Get a new instance of any log driver
+     * with vanilla configurations. By default,
+     * vanilla logger will use the "console" driver
+     * and "none" formatter.
+     */
+    static getVanillaLogger(configs = {}) {
+        return new VanillaLogger(configs);
+    }
+}

package/build/Logger/VanillaLogger.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @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 class VanillaLogger {
+    /**
+     * The driver responsible for transporting the logs.
+     */
+    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.
+     */
+    config(): VanillaLogger;
+    /**
+     * Change the log channel.
+     */
+    channel(): VanillaLogger;
+    /**
+     * Call drivers to transport the log.
+     *
+     * @param {string} level
+     * @param {string} args
+     * @return {any | Promise<any>}
+     */
+    private log;
+    /**
+     * Creates a log of type trace in channel.
+     */
+    trace(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type debug in channel.
+     */
+    debug(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type info in channel.
+     */
+    info(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type success in channel.
+     */
+    success(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type warn in channel.
+     */
+    warn(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type error in channel.
+     */
+    error(...args: any[]): any | Promise<any>;
+    /**
+     * Creates a log of type fatal in channel.
+     */
+    fatal(...args: any[]): any | Promise<any>;
+}

package/build/Logger/VanillaLogger.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 { Color } from '@athenna/common';
+import { DriverFactory } from '#src/Factories/DriverFactory';
+export class VanillaLogger {
+    /**
+     * The driver responsible for transporting the logs.
+     */
+    drivers = [];
+    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.
+     */
+    config() {
+        return this;
+    }
+    /**
+     * Change the log channel.
+     */
+    channel() {
+        return this;
+    }
+    /**
+     * Call drivers to transport the log.
+     *
+     * @param {string} level
+     * @param {string} args
+     * @return {any | Promise<any>}
+     */
+    log(level, ...args) {
+        const message = Color.apply(...args);
+        const promises = this.drivers.map((driver) => driver.transport(level, message));
+        return Promise.all(promises);
+    }
+    /**
+     * Creates a log of type trace in channel.
+     */
+    trace(...args) {
+        return this.log('trace', ...args);
+    }
+    /**
+     * Creates a log of type debug in channel.
+     */
+    debug(...args) {
+        return this.log('debug', ...args);
+    }
+    /**
+     * Creates a log of type info in channel.
+     */
+    info(...args) {
+        return this.log('info', ...args);
+    }
+    /**
+     * Creates a log of type success in channel.
+     */
+    success(...args) {
+        return this.log('success', ...args);
+    }
+    /**
+     * Creates a log of type warn in channel.
+     */
+    warn(...args) {
+        return this.log('warn', ...args);
+    }
+    /**
+     * Creates a log of type error in channel.
+     */
+    error(...args) {
+        return this.log('error', ...args);
+    }
+    /**
+     * Creates a log of type fatal in channel.
+     */
+    fatal(...args) {
+        return this.log('fatal', ...args);
+    }
+}

package/build/Providers/LoggerProvider.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 { ServiceProvider } from '@athenna/ioc';
+export declare class LoggerProvider extends ServiceProvider {
+    register(): void;
+}

package/{src → build}/Providers/LoggerProvider.js

@@ -6,17 +6,10 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-import { Logger } from '#src/index'
-import { ServiceProvider } from '@athenna/ioc'
-
+import { Logger } from '#src/Logger/Logger';
+import { ServiceProvider } from '@athenna/ioc';
 export class LoggerProvider extends ServiceProvider {
-  /**
-   * Register any application services.
-   *
-   * @return {void}
-   */
-  register() {
-    this.container.bind('Athenna/Core/Logger', Logger, false)
-  }
+    register() {
+        this.container.bind('Athenna/Core/Logger', Logger, false);
+    }
 }

package/build/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 * from './Facades/Log.js';
+export * from './Logger/Logger.js';
+export * from './Drivers/Driver.js';
+export * from './Formatters/Formatter.js';
+export * from './Logger/VanillaLogger.js';
+export * from './Helpers/FactoryHelper.js';
+export * from './Factories/DriverFactory.js';
+export * from './Providers/LoggerProvider.js';
+export * from './Factories/FormatterFactory.js';

package/build/index.js

@@ -0,0 +1,17 @@
+/**
+ * @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 * from './Facades/Log.js';
+export * from './Logger/Logger.js';
+export * from './Drivers/Driver.js';
+export * from './Formatters/Formatter.js';
+export * from './Logger/VanillaLogger.js';
+export * from './Helpers/FactoryHelper.js';
+export * from './Factories/DriverFactory.js';
+export * from './Providers/LoggerProvider.js';
+export * from './Factories/FormatterFactory.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.0.9",
+  "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,70 +21,81 @@
     "esm"
   ],
   "scripts": {
-    "lint:fix": "eslint \"{src,tests}/**/*.js\" --fix",
-    "test": "npm run --silent lint:fix && node ./tests/index.js",
-    "test:debug": "cross-env DEBUG=api:* && npm run --silent test",
-    "test:coverage": "c8 npm run --silent test",
-    "gen:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --out src/index.js"
+    "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:coverage": "c8 npm run --silent test"
   },
   "files": [
-    "src/*.js",
-    "src/*.d.ts",
-    "src/**/*.js",
-    "src/**/*.d.ts"
+    "build/*.js",
+    "build/*.d.ts",
+    "build/**/*.js",
+    "build/**/*.d.ts",
+    "templates/**"
   ],
   "type": "module",
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "imports": {
-    "#src/*": "./src/*.js",
-    "#tests/*": "./tests/*.js"
+    "#src/*": "./build/*.js",
+    "#src": "./build/index.js",
+    "#tests/*": "./tests/*.js",
+    "#tests": "./tests/index.js"
   },
   "exports": {
-    ".": "./src/index.js",
-    "./facades/Log": "./src/Facades/Log.js",
-    "./providers/LoggerProvider": "./src/Providers/LoggerProvider.js"
+    ".": "./build/index.js",
+    "./providers/LoggerProvider": "./build/Providers/LoggerProvider.js"
   },
   "dependencies": {
-    "chalk": "5.0.1",
-    "telegraf": "4.7.0"
+    "telegraf": "^4.11.2"
   },
   "devDependencies": {
-    "@athenna/common": "3.0.2",
-    "@athenna/config": "3.0.4",
-    "@athenna/ioc": "3.0.2",
-    "@japa/assert": "1.3.4",
-    "@japa/run-failed-tests": "1.0.7",
-    "@japa/runner": "2.0.7",
-    "@japa/spec-reporter": "1.1.12",
-    "c8": "7.11.2",
-    "cls-rtracer": "2.6.2",
-    "commitizen": "4.2.5",
-    "cross-env": "7.0.3",
-    "cz-conventional-changelog": "3.3.0",
-    "dotenv": "16.0.3",
-    "eslint": "8.14.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-config-standard": "17.0.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-n": "15.2.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-promise": "6.0.0",
-    "husky": "3.0.9",
-    "lint-staged": "12.4.1",
-    "minimist": "1.2.6",
-    "prettier": "2.6.2",
-    "rimraf": "3.0.2",
-    "typescript": "4.6.4"
+    "@athenna/common": "^3.0.0",
+    "@athenna/config": "^3.0.0",
+    "@athenna/ioc": "^3.0.0",
+    "@japa/assert": "^1.3.6",
+    "@japa/run-failed-tests": "^1.1.0",
+    "@japa/runner": "^2.2.2",
+    "@japa/spec-reporter": "^1.3.2",
+    "@swc/core": "^1.3.27",
+    "@types/bytes": "^3.1.1",
+    "@types/callsite": "^1.0.31",
+    "@types/debug": "^4.1.7",
+    "@types/kind-of": "^6.0.0",
+    "@types/lodash": "^4.14.191",
+    "@types/ms": "^0.7.31",
+    "@types/pluralize": "^0.0.29",
+    "@types/uuid": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
+    "c8": "^7.12.0",
+    "cls-rtracer": "^2.6.2",
+    "commitizen": "^4.2.6",
+    "cross-env": "^7.0.3",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "husky": "^3.1.0",
+    "lint-staged": "^12.5.0",
+    "minimist": "^1.2.7",
+    "prettier": "^2.8.3",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
   },
   "c8": {
     "all": true,
     "include": [
-      "src/**/*.js"
-    ],
-    "exclude": [
-      "src/Helpers/ColorHelper.js"
+      "src/**/*.ts"
     ],
+    "exclude": [],
     "reporter": [
       "text-summary",
       "html"
@@ -129,6 +139,9 @@
       }
     ]
   },
+  "eslintIgnore": [
+    "build/**/*"
+  ],
   "eslintConfig": {
     "env": {
       "es2021": true,
@@ -138,28 +151,36 @@
       "ioc": true,
       "Env": true,
       "Path": true,
-      "Config": true
+      "Config": true,
+      "container": true
     },
     "plugins": [
-      "prettier"
+      "prettier",
+      "@typescript-eslint"
     ],
     "extends": [
       "standard",
       "eslint:recommended",
-      "plugin:prettier/recommended"
-    ],
-    "ignorePatterns": [
-      "**/*.d.ts"
+      "plugin:prettier/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:@typescript-eslint/eslint-recommended"
     ],
-    "parserOptions": {
-      "ecmaVersion": "latest",
-      "sourceType": "module"
-    },
+    "parser": "@typescript-eslint/parser",
     "rules": {
       "camelcase": "off",
       "dot-notation": "off",
       "prettier/prettier": "error",
-      "no-useless-constructor": "off"
+      "no-useless-constructor": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "argsIgnorePattern": "^_",
+          "varsIgnorePattern": "^_",
+          "caughtErrorsIgnorePattern": "^_"
+        }
+      ]
     }
   }
 }

package/src/Drivers/ConsoleDriver.js

@@ -1,40 +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 { Driver } from '#src/Drivers/Driver'
-
-export class ConsoleDriver extends Driver {
-  /**
-   * Creates a new instance of ConsoleDriver.
-   *
-   * @param {any} configs
-   * @return {ConsoleDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {any} message
-   * @return {any}
-   */
-  transport(level, message) {
-    if (!this.couldBeTransported(level)) {
-      return
-    }
-
-    const formatted = this.format(level, message)
-    const streamType = this.getStreamTypeFor(level)
-
-    return process[streamType].write(`${formatted}\n`)
-  }
-}