@creejs/commons-logging 2.0.0 → 2.0.2

package/lib/logger.js

@@ -1,285 +0,0 @@
-'use strict'
-
-const { assertString } = require('@creejs/commons-lang/lib/type-assert')
-const LogLevel = require('./log-level')
-const { Level, DefaultLevel, assertLevel } = require('./log-level')
-
-/**
- * Abstract Logger Class of All Logger
- * @abstract
- */
-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')
-  }
-}
-
-module.exports = Logger

package/lib/provider-type.js

@@ -1,22 +0,0 @@
-'use strict'
-/**
- * @type {string}
- * @memberof ProviderType
- */
-const Log4js = 'LOG4JS'
-/**
- * @type {string}
- * @memberof ProviderType
- */
-const Console = 'CONSOLE'
-
-/**
- * @namespace ProviderType
- * @description Define the static types
- */
-const ProviderType = {
-  Log4js,
-  Console
-}
-
-module.exports = ProviderType

package/lib/provider.js

@@ -1,53 +0,0 @@
-'use strict'
-
-// owned
-// eslint-disable-next-line no-unused-vars
-const LogFactory = require('./log-factory')
-
-/**
- * A interface that All Provider module must export
- * @interface
- */
-class Provider {
-  /**
-   * Checks if a value resembles a logging provider by verifying it has required methods.
-   * @param {*} value - The value to check
-   * @returns {boolean}
-   */
-  static isProviderLike (value) {
-    if (value == null) {
-      return false
-    }
-    return typeof value === 'object' && typeof value.createLogFactory === 'function' && typeof value.getType === 'function'
-  }
-
-  /**
-   * Asserts that the given value is a valid provider-like object.
-   * @throws {Error} Throws an error if the value is not provider-like.
-   * @param {*} value - The value to check.
-   */
-  static assertProviderLike (value) {
-    if (!this.isProviderLike(value)) {
-      throw new Error('Not LogProvider')
-    }
-  }
-
-  /**
-   * The Type Name of current Provider
-   * @return {String} The type of the provider.
-   */
-  getType () {
-    throw new Error('Not Impled Yet')
-  }
-
-  /**
-   * Create a new LogFactory instance
-   * @param {*} [nativeLib] - The native library to use for logging.
-   * @param {*} [setting] - Configuration settings for the logging provider.
-   * @returns {LogFactory} A new instance of LogFactory.
-   */
-  createLogFactory (nativeLib, setting) {
-    throw new Error('Not Impled Yet')
-  }
-}
-module.exports = Provider

package/types/console-logger.d.ts

@@ -1,7 +0,0 @@
-export = ConsoleLogger;
-/**
- * A Simple Implementation of the Logger interface that logs to the console.
- */
-declare class ConsoleLogger extends Logger {
-}
-import Logger = require("./logger");

package/types/log4js-logger.d.ts

@@ -1,13 +0,0 @@
-export = Log4jsLogger;
-declare class Log4jsLogger extends Logger {
-    /**
-     * Creates a new ConsoleLogger instance.
-     * @constructor
-     * @param {string} name - The name of the logger.
-     * @param {number} level - The logging level.
-     * @param {module} log4jsModule - Log4js library
-     */
-    constructor(name: string, level: number, log4jsModule: any);
-    _logger: any;
-}
-import Logger = require("./logger");

package/types/logging-level.d.ts

@@ -1,41 +0,0 @@
-/**
- * Standard logging level names
- * @type {Object.<string, string>}
- */
-export const Names: {
-    [x: string]: string;
-};
-/**
- * *
- */
-export type Level = number;
-export namespace Level {
-    let OFF: number;
-    let FATAL: number;
-    let ERROR: number;
-    let WARN: number;
-    let INFO: number;
-    let DEBUG: number;
-    let TRACE: number;
-    let ALL: number;
-}
-/**
- * The default logging level (ERROR)
- * @type {number}
- */
-export const DefaultLevel: number;
-/**
- * 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.
- * @memberof LoggingLevel
- */
-export function value2Name(value: number): string | undefined;
-/**
- * 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, or undefined if name is not supported.
- * @memberof LoggingLevel
- */
-export function name2Value(name: string): number | undefined;
-export { Names as LevelNames, Level as LevelValue };