@creejs/commons-logging 1.0.8 → 2.0.2

package/lib/log-level.js

@@ -1,181 +0,0 @@
-import { TypeUtils } from '@creejs/commons-lang'
-
-const { isNumber, isString } = TypeUtils
-/**
- * @namespace LogLevel
- * @description Defines the logging levels and provides utilities for working with them.
- */
-// module vars
-const TRACE = 'TRACE'
-const DEBUG = 'DEBUG'
-const INFO = 'INFO'
-const WARN = 'WARN'
-const ERROR = 'ERROR'
-const FATAL = 'FATAL'
-const OFF = 'OFF'
-const ALL = 'ALL'
-
-const Names = new Set([TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF, ALL])
-/**
- * The logging level numbers, where OFF=-1, FATAL=0, ERROR=1, WARN=2, INFO=3, DEBUG=4, TRACE=5, ALL=6
- * @enum {number}
- * @memberof LogLevel
- * @static
- */
-const Level = {
-  OFF: -1,
-  FATAL: 0,
-  ERROR: 1,
-  WARN: 2,
-  INFO: 3,
-  DEBUG: 4,
-  TRACE: 5,
-  ALL: 6
-}
-
-/**
- * Standard logging level names
- * @enum {string}
- * @memberof LogLevel
- * @static
- * @constant
- */
-const Name = {
-  TRACE,
-  DEBUG,
-  INFO,
-  WARN,
-  ERROR,
-  FATAL,
-  OFF
-}
-
-/**
- * Internal map for quick lookup of level names by their numeric values
- * @type {Map<number, string>}
- * @private
- */
-const Value2Name = new Map()
-for (const [name, value] of Object.entries(Level)) {
-  Value2Name.set(value, name)
-}
-
-/**
- * The default logging level (ERROR)
- * @type {number}
- * @memberof LogLevel
- * @static
- */
-const DefaultLevel = Level.ERROR
-
-/**
- * Converts a numeric logging level value to its corresponding name.
- * @param {number} value - The numeric logging level value to convert.
- * @returns {string|undefined} The name associated with the given logging level value, from {@link LogLevel.Name}.
- * @memberof LogLevel
- * @static
- */
-function value2Name (value) {
-  if (!isNumber(value)) {
-    return undefined
-  }
-  return Value2Name.get(value)
-}
-
-/**
- * Converts a logging level name to its corresponding numeric value.
- * @param {string} name - The name of the logging level.
- * @returns {number|undefined} The numeric value of the logging level from {@link LogLevel.Level}, or undefined if name is not supported.
- * @memberof LogLevel
- * @static
- */
-function name2Value (name) {
-  if (!isString(name)) {
-    return undefined
-  }
-  // @ts-ignore
-  return Level[name.toUpperCase()]
-}
-
-/**
- * Checks if the given level is a valid log level.
- * @param {number} level - The log level to check.
- * @returns {boolean} True if the level is valid, false otherwise.
- * @memberof LogLevel
- * @static
- */
-function hasLevel (level) {
-  return Value2Name.has(level)
-}
-
-/**
- * Checks if the given level name exists in the Name enum/object.
- * @param {string} levelName - The name of the log level to check.
- * @returns {boolean} True if the level name exists, false otherwise.
- * @memberof LogLevel
- * @static
- */
-function hasName (levelName) {
-  if (!isString(levelName)) {
-    return false
-  }
-  return Names.has(levelName.toUpperCase())
-}
-
-/**
- * Validates that a given level is a number and falls within the valid range.
- * @param {*} level - The log level to validate
- * @throws {Error} If level is not a number or outside valid range (Level.OFF to Level.ALL)
- * @memberof LogLevel
- * @static
- */
-function assertLevel (level) {
-  if (!isNumber(level)) {
-    throw new Error(`Level Not Number: type=${typeof level} value=${level}`)
-  }
-  if (level < Level.OFF || level > Level.ALL) {
-    throw new Error(`Not Valid Level: ${level}, Expect between ${Level.OFF} and ${Level.ALL}`)
-  }
-}
-
-const LogLevel = {
-  Name,
-  Level,
-  DefaultLevel,
-  hasLevel,
-  hasName,
-  assertLevel,
-  /**
-   *  Same with [Name]{@link LogLevel.Name}
-   *  @type {Object}
-   *  @memberof LogLevel
-   *  @static
-   */
-  LevelName: Name,
-  /**
-   *  Same with [Level]{@link LogLevel.Level}
-   *  @type {Object}
-   *  @memberof LogLevel
-   *  @static
-   */
-  LevelValue: Level,
-
-  value2Name,
-
-  name2Value
-}
-
-export default LogLevel
-
-export {
-  Name,
-  Level,
-  DefaultLevel,
-  hasLevel,
-  hasName,
-  assertLevel,
-  Name as LevelName,
-  Level as LevelValue,
-  value2Name,
-  name2Value
-}

package/lib/log4js/index.js

@@ -1,8 +0,0 @@
-// internal
-
-// owned
-import Log4jsProvider from './log4js-provider.js'
-
-// module vars
-const log4jsProvider = new Log4jsProvider()
-export default log4jsProvider

package/lib/log4js/log4js-6x-config.js

@@ -1,12 +0,0 @@
-const DefaultConfig = { // 6x fromat
-  appenders: {
-    out: { type: 'console' }
-  },
-  categories: {
-    default: { appenders: ['out'], level: 'error' }
-  }
-}
-
-export default DefaultConfig
-
-export { DefaultConfig }

package/lib/log4js/log4js-factory.js

@@ -1,89 +0,0 @@
-// internal
-import { TypeAssert } from '@creejs/commons-lang'
-// owned
-// eslint-disable-next-line no-unused-vars
-import Logger from '../logger.js'
-// eslint-disable-next-line no-unused-vars
-import { Level, value2Name } from '../log-level.js'
-import LogFactory from '../log-factory.js'
-
-import Log4jsLogger from './log4js-logger.js'
-import DefaultConfig from './log4js-6x-config.js'
-
-const { assertString } = TypeAssert
-
-/**
- * Use log4js as the logging provider.
- */
-export default class Log4jsFactory extends LogFactory {
-  /**
-   * the log4js module instance.
-   * @returns {{}} The log4js module instance.
-   */
-  get log4js () {
-    return this._libraryModule
-  }
-
-  get setting () {
-    if (this._setting == null) {
-      this._setting = cloneDefaultConfig()
-    }
-    return this._setting
-  }
-
-  /**
-   * Initializes the log4js provider by configuring it with the provided settings.
-   * @override
-   */
-  init () {
-    // @ts-ignore
-    this.log4js.configure(this.setting)
-  }
-
-  /**
-   * Update factory's Log Level
-   * 1. Only Provider knows how to update
-   * @param {number} level - The log level to set, see {@link LogLevel.Level}
-   * @returns {void}
-   * @throws {Error} Throws an error as this method is Not Impled Yet.
-   * @abstract
-   */
-  setLevel (level) {
-    let levelName = value2Name(level)
-    if (levelName == null) {
-      throw new Error(`Invalid log level: ${level}`)
-    }
-    levelName = levelName.toLowerCase()
-    let updated = false
-    // @ts-ignore
-    const { categories } = this.setting
-    for (const categoryKey in categories) {
-      const category = categories[categoryKey]
-      const { level: categoryLevel } = category
-      if (categoryLevel !== levelName) {
-        category.level = levelName.toLowerCase()
-        updated = true
-      }
-    }
-    // init log4js again
-    updated && this.init()
-  }
-
-  /**
-   * Creates a new logger instance with the specified name and log level.
-   * @param {string} loggerName - The name of the logger to create.
-   * @returns {Logger} A new logger instance configured with the given name and level.
-   * @override
-   */
-  createLogger (loggerName) {
-    assertString(loggerName)
-    // @ts-ignore
-    const nativeLogger = this.log4js.getLogger(loggerName)
-    const logger = new Log4jsLogger(loggerName, nativeLogger)
-    return logger
-  }
-}
-
-function cloneDefaultConfig () {
-  return JSON.parse(JSON.stringify(DefaultConfig))
-}

package/lib/log4js/log4js-logger.js

@@ -1,107 +0,0 @@
-// 3rd
-// internal
-// owned
-import { assertLevel, value2Name, name2Value, Level } from '../log-level.js'
-import Logger from '../logger.js'
-// module vars
-
-export default class Log4jsLogger extends Logger {
-  /**
-   * Creates a new ConsoleLogger instance.
-   * @constructor
-   * @param {string} name - The name of the logger.
-   * @param {*} nativeLogger - Log4js library
-   */
-  constructor (name, nativeLogger) {
-    super(name, nativeLogger)
-    // @ts-ignore
-    this._level = undefined // MUST NOT accept level from outside
-    this._logger = nativeLogger
-  }
-
-  /**
-   * 1. log4js may have many categories(loggerName) with diffirent level
-   * 2. return the underlying log4js native logger's level
-   * @returns {number} The current log level.
-   */
-  get level () {
-    if (this._level == null) {
-      const levelName = this._logger.level.levelStr
-      if (levelName == null) {
-        return Level.OFF
-      }
-      const level = name2Value(levelName)
-      if (level == null) {
-        throw new Error(`Unknown level name: ${levelName}`)
-      }
-      return level
-    }
-    return this._level
-  }
-
-  /**
-   * set log4js native logger's level
-   * @param {number} level
-   * @override
-   * @protectd
-   */
-  _setLevel (level) {
-    assertLevel(level)
-    const levelName = value2Name(level)
-    if (levelName == null) {
-      throw new Error(`Invalid log level: ${level}`)
-    }
-    // log4js use string level, eg. 'error, trace'
-    this._logger.level = levelName.toLowerCase()
-  }
-
-  /**
-   * Logs a fatal error message with timestamp and logger name.
-   * Only outputs if fatal logging is enabled for this logger instance.
-   * @param {...any} args - Arguments to log (will be space-separated)
-   */
-  _fatal (...args) {
-    this._logger.fatal(...args)
-  }
-
-  /**
-   * Logs an error message to the console with timestamp and logger name.
-   * Only logs if error logging is enabled for this logger instance.
-   * @param {...any} args - Arguments to be logged as error message
-   */
-  _error (...args) {
-    this._logger.error(...args)
-  }
-
-  /**
-   * Logs a warning message to the console if warn logging is enabled.
-   * @param {...any} args - The arguments to log as a warning message.
-   */
-  _warn (...args) {
-    this._logger.warn(...args)
-  }
-
-  /**
-   * Logs debug messages to console if debug mode is enabled.
-   * @param {...any} args - The data to be logged
-   */
-  _debug (...args) {
-    this._logger.debug(...args)
-  }
-
-  /**
-   * Logs an info message to the console with timestamp and logger name.
-   * @param {...any} args - The data to be logged. Accepts multiple arguments.
-   */
-  _info (...args) {
-    this._logger.info(...args)
-  }
-
-  /**
-   * Logs a trace message with timestamp and logger name if trace logging is enabled.
-   * @param {...any} args - Data to be logged as trace message.
-   */
-  _trace (...args) {
-    this._logger.trace(...args)
-  }
-}

package/lib/log4js/log4js-provider.js

@@ -1,34 +0,0 @@
-// internal
-import { TypeAssert } from '@creejs/commons-lang'
-
-// owned
-import ProviderType from '../provider-type.js'
-import Provider from '../provider.js'
-import Log4jsFactory from './log4js-factory.js'
-
-const { assertNotNil } = TypeAssert
-
-export default class Log4jsProvider extends Provider {
-  /**
-   * Gets the provider type (Log4js).
-   * @returns {string} "LOG4JS"
-   * @override
-   */
-  getType () {
-    return ProviderType.Log4js
-  }
-
-  /**
-   * Creates a new Provider instance.
-   * @param {*} libraryModule - The library module to be used.
-   * @param {*} setting - Configuration settings for the provider.
-   * @returns {Log4jsFactory} A new instance of Log4jsFactory.
-   * @override
-   */
-  createLogFactory (libraryModule, setting) {
-    assertNotNil(libraryModule)
-    const factory = new Log4jsFactory(libraryModule, setting)
-    factory.init()
-    return factory
-  }
-}

package/lib/logger.js

@@ -1,284 +0,0 @@
-// internal
-import { TypeAssert } from '@creejs/commons-lang'
-// owned
-import LogLevel from './log-level.js'
-
-const { Level, DefaultLevel, assertLevel } = LogLevel
-const { assertString } = TypeAssert
-/**
- * Abstract Logger Class of All Logger
- * @abstract
- */
-export default class Logger {
-  /**
-   * Creates a new Logger instance.
-   * @constructor
-   * @param {string} name - The name identifier for the logger
-   * @param {*} [nativeLogger]
-   * @param {number} [level] - The logging level, default is Level.ERROR=1
-   */
-  constructor (name, nativeLogger, level = DefaultLevel) {
-    assertString(name)
-    assertLevel(level)
-    this._name = name
-    this._nativeLogger = nativeLogger
-    this._level = level
-  }
-
-  get nativeLogger () {
-    return this._nativeLogger
-  }
-
-  get level () {
-    return this._level
-  }
-
-  /**
-   * Gets the name of the logger instance.
-   * @returns {string} The name of the logger.
-   */
-  get name () {
-    return this._name
-  }
-
-  /**
-   * Checks if FATAL level logging is enabled for this logger.
-   * @returns {boolean} True if FATAL level logging is enabled, false otherwise.
-   */
-  get fatalEnabled () {
-    return this.level >= Level.FATAL
-  }
-
-  /**
-   * Checks if ERROR level logging is enabled for this logger.
-   * @returns {boolean} True if ERROR level logging is enabled, false otherwise.
-   */
-  get errorEnabled () {
-    return this.level >= Level.ERROR
-  }
-
-  /**
-   * Checks if WARN level logging is enabled for this logger.
-   * @returns {boolean} True if WARN level logging is enabled, false otherwise.
-   */
-  get warnEnabled () {
-    return this.level >= Level.WARN
-  }
-
-  /**
-   * Checks if DEBUG level logging is enabled for this logger.
-   * @returns {boolean} True if DEBUG level logging is enabled, false otherwise.
-   */
-  get debugEnabled () {
-    return this.level >= Level.DEBUG
-  }
-
-  /**
-   * Checks if INFO level logging is enabled for this logger.
-   * @returns {boolean} True if INFO level logging is enabled, false otherwise.
-   */
-  get infoEnabled () {
-    return this.level >= Level.INFO
-  }
-
-  /**
-   * Checks if TRACE level logging is enabled for this logger.
-   * @returns {boolean} True if TRACE level logging is enabled, false otherwise.
-   */
-  get traceEnabled () {
-    return this.level >= Level.TRACE
-  }
-
-  /**
-   * change log level for current logger instance.
-   * @param {number} level - new log level to set
-   * @throws {Error} Currently throws an error as this method is Not Impled Yet.
-   * @abstract
-   */
-  setLevel (level) {
-    LogLevel.assertLevel(level)
-    this._setLevel(level)
-    this._level = level
-  }
-
-  /**
-   * Logs a fatal error message with timestamp and logger name.
-   * Only outputs if fatal logging is enabled for this logger instance.
-   * @param {...any} args - Arguments to log (will be space-separated)
-   */
-  fatal (...args) {
-    if (this.fatalEnabled) {
-      this._fatal(...args)
-    }
-  }
-
-  /**
-   * Logs an error message to the console with timestamp and logger name.
-   * Only logs if error logging is enabled for this logger instance.
-   * @param {...any} args - Arguments to be logged as error message
-   */
-  error (...args) {
-    if (this.errorEnabled) {
-      this._error(...args)
-    }
-  }
-
-  /**
-   * Logs a warning message to the console if warn logging is enabled.
-   * @param {...any} args - The arguments to log as a warning message.
-   */
-  warn (...args) {
-    if (this.warnEnabled) {
-      this._warn(...args)
-    }
-  }
-
-  /**
-   * Logs debug messages to console if debug mode is enabled.
-   * @param {...any} args - The data to be logged
-   */
-  debug (...args) {
-    if (this.debugEnabled) {
-      this._debug(...args)
-    }
-  }
-
-  /**
-   * Logs an info message to the console with timestamp and logger name.
-   * @param {...any} args - The data to be logged. Accepts multiple arguments.
-   */
-  info (...args) {
-    if (this.infoEnabled) {
-      this._info(...args)
-    }
-  }
-
-  /**
-   * Logs a trace message with timestamp and logger name if trace logging is enabled.
-   * @param {...any} args - Data to be logged as trace message.
-   */
-  trace (...args) {
-    if (this.traceEnabled) {
-      this._trace(...args)
-    }
-  }
-
-  /**
-   * Checks if FATAL level logging is enabled for this logger.
-   * @returns {boolean} True if FATAL level logging is enabled, false otherwise.
-   */
-  isFatalEnabled () {
-    return this.fatalEnabled
-  }
-
-  /**
-   * Checks if ERROR level logging is enabled for this logger.
-   * @returns {boolean} True if ERROR level logging is enabled, false otherwise.
-   */
-  isErrorEnabled () {
-    return this.errorEnabled
-  }
-
-  /**
-   * Checks if WARN level logging is enabled for this logger.
-   * @returns {boolean} True if WARN level logging is enabled, false otherwise.
-   */
-  isWarnEnabled () {
-    return this.warnEnabled
-  }
-
-  /**
-   * Checks if DEBUG level logging is enabled for this logger.
-   * @returns {boolean} True if DEBUG level logging is enabled, false otherwise.
-   */
-  isDebugEnabled () {
-    return this.debugEnabled
-  }
-
-  /**
-   * Checks if INFO level logging is enabled for this logger.
-   * @returns {boolean} True if INFO level logging is enabled, false otherwise.
-   */
-  isInfoEnabled () {
-    return this.infoEnabled
-  }
-
-  /**
-   * Checks if TRACE level logging is enabled for this logger.
-   * @returns {boolean} True if TRACE level logging is enabled, false otherwise.
-   */
-  isTraceEnabled () {
-    return this.traceEnabled
-  }
-
-  /**
-   * Sets the logging level
-   * @param {number} level
-   * @throws {Error} Always throws "Not Impled Yet Yet" error.
-   * @protected
-   * @abstract
-   */
-  _setLevel (level) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement fatal logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _fatal (...args) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement error logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _error (...args) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement warn logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _warn (...args) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement debug logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _debug (...args) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement info logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _info (...args) {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Override this method to implement trace logging.
-   * @protected
-   * @param {...*} args - Variable arguments
-   * @throws {Error} Always throws "Not Impled Yet Yet" error
-   */
-  _trace (...args) {
-    throw new Error('Not Impled Yet')
-  }
-}