index.d.ts

/**
 * Good Logs
 * Copyright(c) 2024 Bally Lomibao
 * MIT Licensed
 */
import { Request, Response, NextFunction } from 'express'

interface RequestExtended extends Request {
  body: { [key: string]: string | undefined }
}

interface Env {
  PRODUCTION: 'production'
  DEVELOPMENT: 'development'
  TEST: 'test'
}

declare namespace Goodlog {
  /**
   * Custom color for logging
   * @param message
   * @param color - @see - https://www.npmjs.com/package/colors
   */
  function custom(color: any, ...message: string[]): void

  /**
   * log message to console
   * @param message - message to log : default
   */
  function log(...message: string[]): void

  /**
   * log message in type info
   * @param message - message to log : type info
   */
  function info(...message: string[]): void

  /**
   * log message in type warn
   * @param message - message to log : type warn
   */
  function warn(...message: string[]): void

  /**
   * log message in type array in a table
   * @param message - message to log : type array/object
   */
  function tbl(...message: any[]): void

  /**
   * log message in type error
   * @param error - error message to log : type error
   * @param tag - tag of the error
   * @param target - target of the error
   * @param args - additional arguments
   * @return void
   */
  function error(error: any, tag: string, target: string, ...args: any[]): void

  /**
   * log message in type debug
   * @param message - message to log : type debug
   */
  function debug(...message: string[]): void

  /**
   *
   * @param port - server port
   * @param apiRoot - api version
   * @param env - status of the server environment
   * @param isConnected - send the status of the server connection
   * @return void
   */
  //  declare function server(
  //   port: number,
  //   apiRoot: string,
  //   isProd: boolean,
  //   isConnected: boolean
  // ): void
  function server(port: any, apiRoot: string, env: string, isConnected: boolean): void

  /**
   *
   * @param req - request {IRequestExtended}
   * @param res  - response {Response}
   * @param next  - next {NextFunction}
   * @return void
   */
  function req(req: RequestExtended, res: Response, next: NextFunction): void

  /**
   * Preset log type for connection status update in the console
   * @param db - connection call
   * @param isConnected - send the status of the db connection
   */
  function db(host: any, dbName: any, isConnected: boolean): void
}

declare const goodlog: typeof Goodlog

export = goodlog