@athenna/logger 3.0.8 → 3.1.0

package/src/index.d.ts

@@ -1,797 +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 { Facade } from '@athenna/ioc'
-
-export const Log: typeof Facade & Logger
-
-export class Driver {
-  /**
-   * Holds the configuration object itself.
-   *
-   * @type {any}
-   */
-  configs: any
-
-  /**
-   * Holds the configuration object of driver.
-   *
-   * @type {any}
-   */
-  driverConfig: any
-
-  /**
-   * Holds the formatter string value.
-   *
-   * @type {string}
-   */
-  formatter: string
-
-  /**
-   * Holds the configuration object of formatter.
-   *
-   * @type {any}
-   */
-  formatterConfig: any
-
-  /**
-   * The max log level that this driver can transport.
-   *
-   * @return {string}
-   */
-  level: string
-
-  /**
-   * The log level order to check if log could
-   * be transported or not.
-   *
-   * @type {string[]}
-   */
-  levelOrder: string[]
-
-  /**
-   * Creates a new instance of ConsoleDriver.
-   *
-   * @param {any} configs
-   * @return {Driver}
-   */
-  constructor(configs: any)
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {any | Promise<any>}
-   */
-  transport(level: string, message: string): any | Promise<any>
-
-  /**
-   * Check if message could be transported.
-   *
-   * @param level {string}
-   * @return {boolean}
-   */
-  couldBeTransported(level: string): boolean
-
-  /**
-   * Call formatter factory to format the message.
-   *
-   * @param level {string}
-   * @param message {string}
-   * @param [clean] {boolean}
-   * @return {any}
-   */
-  format(level: string, message: string, clean?: boolean): any
-
-  /**
-   * Get the stream type for level.
-   *
-   * @param level {string}
-   * @return {string}
-   */
-  getStreamTypeFor(level: string): string
-}
-
-export class Formatter {
-  /**
-   * Holds the configuration object of formatter.
-   */
-  configs: any
-
-  /**
-   * Creates a new instance of Formatter.
-   *
-   * @param {any} configs
-   * @return {Formatter}
-   */
-  config(configs: any): Formatter
-
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message: string): string
-
-  /**
-   * Create the PID for formatter.
-   *
-   * @return {string}
-   */
-  pid(): string
-
-  /**
-   * Create the hostname for formatter.
-   *
-   * @return {string}
-   */
-  hostname(): string
-
-  /**
-   * Get the level without any color or format.
-   *
-   * @return {string}
-   */
-  level(): string
-
-  /**
-   * Get the trace id for formatter.
-   *
-   * @return {string | null}
-   */
-  traceId(): string | null
-
-  /**
-   * Create the timestamp for formatter.
-   *
-   * @return {string}
-   */
-  timestamp(): string
-
-  /**
-   * Transform the message to string.
-   *
-   * @param message {string}
-   * @return {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.
-   *
-   * @param message {string}
-   * @param [force] {boolean}
-   * @return {string}
-   */
-  clean(message, force?: boolean): string
-
-  /**
-   * Apply all colors necessary to message.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColors(message: string): string
-
-  /**
-   * Apply colors in message.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColorsByChalk(message: string): string
-
-  /**
-   * Apply colors in message by level.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColorsByLevel(message: string): string
-
-  /**
-   * Create the cli level string.
-   *
-   * @return {string}
-   */
-  cliLevel(): string
-
-  /**
-   * Create the simple level string.
-   *
-   * @return {string}
-   */
-  simpleLevel(): string
-
-  /**
-   * Create the message level emoji string.
-   *
-   * @return {string}
-   */
-  messageLevel(): string
-}
-
-export class ColorHelper {
-  /**
-   * Chalk instance.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static chalk: import('chalk').ChalkInstance
-
-  /**
-   * Paint as bold.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get bold(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as purple.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get purple(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as darkPurple.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get darkPurple(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as yellow.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get yellow(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as cyan.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get cyan(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as white.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get white(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as orange.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get orange(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as green.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get green(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as darkGreen.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get darkGreen(): import('chalk').ChalkInstance
-
-  /**
-   * Paint as red.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get red(): import('chalk').ChalkInstance
-
-  /**
-   * Paint traces.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get trace(): import('chalk').ChalkInstance
-
-  /**
-   * Paint debugs.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get debug(): import('chalk').ChalkInstance
-
-  /**
-   * Paint infos.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get info(): import('chalk').ChalkInstance
-
-  /**
-   * Paint success.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get success(): import('chalk').ChalkInstance
-
-  /**
-   * Paint warns.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get warn(): import('chalk').ChalkInstance
-
-  /**
-   * Paint errors.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get error(): import('chalk').ChalkInstance
-
-  /**
-   * Paint fatals.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get fatal(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get GET(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get HEAD(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get PUT(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get PATCH(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get POST(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get DELETE(): import('chalk').ChalkInstance
-
-  /**
-   * Paint http method.
-   *
-   * @return {import('chalk').ChalkInstance}
-   */
-  static get OPTIONS(): import('chalk').ChalkInstance
-
-  /**
-   * Remove all colors and special chars of string.
-   *
-   * @param {string} string
-   * @return {string}
-   */
-  static removeColors(string: string): string
-
-  /**
-   * Paint by the http method.
-   *
-   * @param {'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', 'OPTIONS', 'HEAD' } method
-   * @return {import('chalk').ChalkInstance}
-   */
-  static httpMethod(method: any): import('chalk').ChalkInstance
-
-  /**
-   * Applies the log engine to execute chalk methods.
-   *
-   * @param {string} args
-   * @return {any}
-   */
-  static applyLogEngine(...args): any
-}
-
-export class FactoryHelper {
-  /**
-   * Group the configuration values.
-   *
-   * @param {any} object
-   * @param {any} defaultValue
-   * @return {any}
-   */
-  static groupConfigs(object: any, defaultValue: any): any
-}
-
-export class DriverFactory {
-  /**
-   * Drivers of DriverFactory.
-   *
-   * @type {Map<string, { Driver: any }>}
-   */
-  static drivers: Map<
-    string,
-    {
-      Driver: any
-    }
-  >
-
-  /**
-   * Return an array with all available drivers.
-   *
-   * @return {any[]}
-   */
-  static availableDrivers(): any[]
-
-  /**
-   * Fabricate a new instance of a driver based on
-   * channel configurations.
-   *
-   * @param {string} channelName
-   * @param {any} runtimeConfig
-   * @return {any}
-   */
-  static fabricate(channelName: string, runtimeConfig?: any): any
-
-  /**
-   * Fabricate a new instance of a driver without
-   * configurations.
-   *
-   * @param {string} driverName
-   * @param {any} runtimeConfig
-   * @return {any}
-   */
-  static fabricateOnly(driverName: string, runtimeConfig?: any): any
-
-  /**
-   * Creates a new driver implementation.
-   *
-   * @param {string} name
-   * @param {(channel: string, configs?: any) => any} driver
-   */
-  static createDriver(
-    name: string,
-    driver: (channel: string, configs?: any) => any,
-  ): void
-}
-
-export class FormatterFactory {
-  /**
-   * Formatters of FormatterFactory.
-   *
-   * @type {Map<string, { Formatter: any }>}
-   */
-  static formatters: Map<
-    string,
-    {
-      Formatter: any
-    }
-  >
-
-  /**
-   * Return an array with all available formatters.
-   *
-   * @return {any[]}
-   */
-  static availableFormatters(): any[]
-
-  /**
-   * Fabricate a new instance of a formatter.
-   *
-   * @param {string} formatterName
-   * @return {any}
-   */
-  static fabricate(formatterName: string): any
-
-  /**
-   * Creates a new formatter implementation.
-   *
-   * @param {string} name
-   * @param {() => any} formatter
-   */
-  static createFormatter(name: string, formatter: () => any): void
-}
-
-export class VanillaLogger {
-  /**
-   * Set runtime configurations for drivers and
-   * formatters.
-   *
-   * @param {any} runtimeConfig
-   * @return {VanillaLogger}
-   */
-  config(runtimeConfig: any): VanillaLogger
-
-  /**
-   * Change the log channel.
-   *
-   * @param {string[]} channels
-   * @return {VanillaLogger}
-   */
-  channel(...channels: string[]): VanillaLogger
-
-  /**
-   * Creates a log of type trace in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  trace(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type trace in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  trace(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type debug in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  debug(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type debug in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  debug(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type info in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  info(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type info in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  info(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type success in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  success(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type success in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  success(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type warn in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  warn(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type warn in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  warn(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type error in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  error(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type error in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  error(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type fatal in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  fatal(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type fatal in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  fatal(...args: string[] | any[]): any | Promise<any>
-}
-
-export class Logger {
-  /**
-   * Set runtime configurations for drivers and
-   * formatters.
-   *
-   * @param {any} runtimeConfig
-   * @return {Logger}
-   */
-  config(runtimeConfig: any): Logger
-
-  /**
-   * Change the log channel.
-   *
-   * @param {string[]} channels
-   * @return {Logger}
-   */
-  channel(...channels: string[]): Logger
-
-  /**
-   * Creates a log of type trace in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  trace(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type trace in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  trace(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type debug in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  debug(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type debug in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  debug(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type info in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  info(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type info in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  info(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type success in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  success(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type success in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  success(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type warn in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  warn(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type warn in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  warn(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type error in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  error(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type error in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  error(...args: string[] | any[]): any | Promise<any>
-
-  /**
-   * Creates a log of type fatal in channel.
-   *
-   * @param {string|any} message
-   * @return {any | Promise<any>}
-   */
-  fatal(message: string | any): any | Promise<any>
-
-  /**
-   * Creates a log of type fatal in channel.
-   *
-   * @param {string[]|any[]} args
-   * @return {any | Promise<any>}
-   */
-  fatal(...args: string[] | 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.
-   *
-   * @param {any} [configs]
-   * @return {VanillaLogger}
-   */
-  static getVanillaLogger(configs?: any): VanillaLogger
-}