@vvlad1973/simple-logger 1.2.2 → 2.0.2

package/dist/classes/simple-logger.d.ts

@@ -0,0 +1,125 @@
+/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+import { ExternalLogger, LogFn, LoggerFactory, LoggerLevel, LoggerOptions } from '../types/simple-logger.types.js';
+export default class SimpleLogger {
+    private currentLevelIndex;
+    private logger;
+    private bindings;
+    private msgPrefix?;
+    private enabled;
+    isExternal: boolean;
+    static readonly noop: LogFn;
+    trace: LogFn;
+    debug: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    error: LogFn;
+    fatal: LogFn;
+    silent: LogFn;
+    /**
+     * Initializes a new instance of the SimpleLogger class.
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} [options={}] - Options for the logger, such as the logging level and bindings.
+     */
+    constructor(externalLogger?: ExternalLogger | LoggerFactory | null, options?: LoggerOptions);
+    /**
+     * Resolves the effective logging level based on the provided logger and explicit level.
+     *
+     * @param {ExternalLogger | Console} logger - The logger to resolve the level for.
+     * @param {LoggerLevel} [explicitLevel] - The explicit logging level to use, if provided.
+     * @return {LoggerLevel} The resolved effective logging level.
+     */
+    private resolveEffectiveLevel;
+    /**
+     * Initializes the logger with the provided external logger and options.
+     *
+     * Handles different cases for the external logger, including:
+     * - No external logger provided (falls back to console)
+     * - External logger is a factory function (e.g. pino)
+     * - External logger is invalid or console (falls back to console)
+     * - External logger is provided without parameters
+     * - External logger has a .child() method
+     * - External logger does not have a .child() method (uses directly)
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} options - Options for the logger, such as the logging level and bindings.
+     * @return {void}
+     */
+    private initLogger;
+    /**
+     * Updates the logging methods based on the current logging level and external logger configuration.
+     *
+     * Iterates over the available logging levels and sets the corresponding logging method to either call the external log method or the internal pretty format log method, depending on the logger configuration.
+     *
+     * @return {void}
+     */
+    private updateLoggingMethods;
+    /**
+     * Calls the external log method for the specified level with the provided arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the external log method.
+     * @param {unknown[]} args - The arguments to pass to the external log method.
+     * @return {void}
+     */
+    private callExternalLogMethod;
+    /**
+     * Formats and logs a message with the specified level and arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the log message.
+     * @param {unknown[]} args - The arguments to use when formatting the log message.
+     * @return {void}
+     */
+    private prettyFormatLog;
+    /**
+     * Retrieves the current logging level.
+     *
+     * @return {LoggerLevel} The current logging level.
+     */
+    getLevel(): LoggerLevel;
+    /**
+     * Sets the logging level.
+     *
+     * @param {LoggerLevel} level - The logging level to set.
+     * @return {void}
+     */
+    setLevel(level: LoggerLevel): void;
+    /**
+     * Enables the logger.
+     *
+     * @return {void}
+     */
+    enable(): void;
+    /**
+     * Disables the logger.
+     *
+     * @return {void} Nothing is returned.
+     */
+    disable(): void;
+    /**
+     * Creates a new child logger with the merged bindings.
+     *
+     * If the external logger supports the `child` method, it will be used to create the child logger.
+     * Otherwise, a new SimpleLogger instance will be created with the merged bindings.
+     *
+     * @param {Record<string, unknown>} newBindings - The new bindings to merge with the existing bindings.
+     * @return {SimpleLogger} The new child logger instance.
+     */
+    child(newBindings: Record<string, unknown>): SimpleLogger;
+    /**
+     * Logs the start of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionStart(name?: string): void;
+    /**
+     * Logs the end of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionEnd(name?: string): void;
+}

package/dist/classes/simple-logger.js

@@ -0,0 +1,290 @@
+/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+import util from 'util';
+import { getCallerName } from 'vvlad1973-utils';
+import { hasChild, isValidLogger } from '../helpers/validators.js';
+import { extractContext, extractMessage, colorizeLevel, prepareLogCall, } from '../helpers/helpers.js';
+import { LoggerLevels } from '../constants/constants.js';
+export default class SimpleLogger {
+    currentLevelIndex = Object.values(LoggerLevels).indexOf(LoggerLevels.INFO);
+    logger = console;
+    bindings = {};
+    msgPrefix;
+    enabled = true;
+    isExternal = false;
+    static noop = () => { };
+    trace = SimpleLogger.noop;
+    debug = SimpleLogger.noop;
+    info = SimpleLogger.noop;
+    warn = SimpleLogger.noop;
+    error = SimpleLogger.noop;
+    fatal = SimpleLogger.noop;
+    silent = SimpleLogger.noop;
+    /**
+     * Initializes a new instance of the SimpleLogger class.
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} [options={}] - Options for the logger, such as the logging level and bindings.
+     */
+    constructor(externalLogger, options = {}) {
+        this.initLogger(externalLogger, options);
+    }
+    /**
+     * Resolves the effective logging level based on the provided logger and explicit level.
+     *
+     * @param {ExternalLogger | Console} logger - The logger to resolve the level for.
+     * @param {LoggerLevel} [explicitLevel] - The explicit logging level to use, if provided.
+     * @return {LoggerLevel} The resolved effective logging level.
+     */
+    resolveEffectiveLevel(logger, explicitLevel) {
+        const levels = Object.values(LoggerLevels);
+        if (explicitLevel)
+            return explicitLevel;
+        if (logger &&
+            typeof logger === 'object' &&
+            'level' in logger &&
+            typeof logger.level === 'string') {
+            const lvl = logger.level.toLowerCase();
+            if (levels.includes(lvl))
+                return lvl;
+        }
+        return levels[this.currentLevelIndex];
+    }
+    /**
+     * Initializes the logger with the provided external logger and options.
+     *
+     * Handles different cases for the external logger, including:
+     * - No external logger provided (falls back to console)
+     * - External logger is a factory function (e.g. pino)
+     * - External logger is invalid or console (falls back to console)
+     * - External logger is provided without parameters
+     * - External logger has a .child() method
+     * - External logger does not have a .child() method (uses directly)
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} options - Options for the logger, such as the logging level and bindings.
+     * @return {void}
+     */
+    initLogger(externalLogger, options = {}) {
+        const { level, bindings = {}, msgPrefix, transport, ...restOptions } = options;
+        const hasParams = level || msgPrefix || Object.keys(bindings).length > 0;
+        const effectiveBindings = {
+            ...bindings,
+            ...(msgPrefix ? { msgPrefix } : {}),
+        };
+        this.bindings = effectiveBindings;
+        this.msgPrefix = msgPrefix;
+        // CASE 1: логгер не передан
+        if (!externalLogger) {
+            this.logger = console;
+            this.isExternal = false;
+            this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+            return;
+        }
+        // CASE 2: логгер — фабрика (например, pino)
+        if (typeof externalLogger === 'function') {
+            this.logger = externalLogger({
+                level,
+                ...restOptions,
+                ...(transport ? { transport } : {}),
+            });
+            this.isExternal = true;
+            this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+            return;
+        }
+        // CASE 3: логгер есть, но он невалиден (нет методов)
+        if (!isValidLogger(externalLogger) || externalLogger === console) {
+            console.warn('Invalid or console logger passed, falling back to internal console.');
+            this.logger = console;
+            this.isExternal = false;
+            this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+            return;
+        }
+        // CASE 4: логгер передан без параметров
+        if (!hasParams) {
+            this.logger = externalLogger;
+            this.isExternal = true;
+            this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+            return;
+        }
+        // CASE 5: логгер с .child()
+        if (hasChild(externalLogger)) {
+            this.logger = externalLogger.child({
+                ...effectiveBindings,
+                ...restOptions,
+                ...(transport ? { transport } : {}),
+            });
+            this.isExternal = true;
+            this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+            return;
+        }
+        // CASE 6: логгер без .child — используем напрямую, только применим level
+        this.logger = externalLogger;
+        this.isExternal = true;
+        if (typeof externalLogger.level === 'string') {
+            externalLogger.level = this.resolveEffectiveLevel(this.logger, level);
+        }
+        this.setLevel(this.resolveEffectiveLevel(this.logger, level));
+    }
+    /**
+     * Updates the logging methods based on the current logging level and external logger configuration.
+     *
+     * Iterates over the available logging levels and sets the corresponding logging method to either call the external log method or the internal pretty format log method, depending on the logger configuration.
+     *
+     * @return {void}
+     */
+    updateLoggingMethods() {
+        const levels = Object.values(LoggerLevels);
+        levels.forEach((level, index) => {
+            if (this.enabled && this.currentLevelIndex <= index) {
+                this[level] = (...args) => {
+                    if (this.isExternal) {
+                        this.callExternalLogMethod(level, args);
+                    }
+                    else {
+                        this.prettyFormatLog(level, args);
+                    }
+                };
+            }
+            else {
+                this[level] = SimpleLogger.noop;
+            }
+        });
+    }
+    /**
+     * Calls the external log method for the specified level with the provided arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the external log method.
+     * @param {unknown[]} args - The arguments to pass to the external log method.
+     * @return {void}
+     */
+    callExternalLogMethod(level, args) {
+        const method = this.logger[level];
+        if (typeof method !== 'function')
+            return;
+        const prepared = prepareLogCall(args);
+        if (prepared !== null) {
+            method(...prepared);
+        }
+        else {
+            console.warn(`Invalid log arguments for "${level}"`, args);
+        }
+    }
+    /**
+     * Formats and logs a message with the specified level and arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the log message.
+     * @param {unknown[]} args - The arguments to use when formatting the log message.
+     * @return {void}
+     */
+    prettyFormatLog(level, args) {
+        const time = new Date().toISOString().slice(0, 19).replace('T', ' ');
+        const levelStr = colorizeLevel(level, level.toUpperCase().padEnd(5));
+        const context = extractContext(args);
+        const { msg, rest } = extractMessage(args);
+        const fullMsg = util.format(msg, ...rest);
+        const ctx = Object.entries({ ...this.bindings, ...context })
+            .map(([k, v]) => `${k}=${v}`)
+            .join(' ');
+        const prefix = `[${time}] ${levelStr}`;
+        const contextStr = ctx ? ` (${ctx})` : '';
+        const msgPrefixStr = this.msgPrefix ? ` ${this.msgPrefix}` : '';
+        console.log(`${prefix}${contextStr}:${msgPrefixStr} ${fullMsg}`);
+    }
+    /**
+     * Retrieves the current logging level.
+     *
+     * @return {LoggerLevel} The current logging level.
+     */
+    getLevel() {
+        return Object.values(LoggerLevels)[this.currentLevelIndex];
+    }
+    /**
+     * Sets the logging level.
+     *
+     * @param {LoggerLevel} level - The logging level to set.
+     * @return {void}
+     */
+    setLevel(level) {
+        const index = Object.values(LoggerLevels).indexOf(level);
+        if (index !== -1) {
+            this.currentLevelIndex = index;
+            if (typeof this.logger.level === 'string') {
+                this.logger.level = level;
+            }
+            this.updateLoggingMethods();
+        }
+    }
+    /**
+     * Enables the logger.
+     *
+     * @return {void}
+     */
+    enable() {
+        this.enabled = true;
+        this.updateLoggingMethods();
+    }
+    /**
+     * Disables the logger.
+     *
+     * @return {void} Nothing is returned.
+     */
+    disable() {
+        this.enabled = false;
+        this.updateLoggingMethods();
+    }
+    /**
+     * Creates a new child logger with the merged bindings.
+     *
+     * If the external logger supports the `child` method, it will be used to create the child logger.
+     * Otherwise, a new SimpleLogger instance will be created with the merged bindings.
+     *
+     * @param {Record<string, unknown>} newBindings - The new bindings to merge with the existing bindings.
+     * @return {SimpleLogger} The new child logger instance.
+     */
+    child(newBindings) {
+        const merged = { ...this.bindings, ...newBindings };
+        if (this.isExternal &&
+            typeof this.logger === 'object' &&
+            this.logger !== null) {
+            const logger = this.logger;
+            const childFn = logger.child;
+            if (typeof childFn === 'function') {
+                const childLogger = childFn.call(logger, merged);
+                return new SimpleLogger(childLogger, {
+                    level: this.getLevel(),
+                    bindings: merged,
+                    msgPrefix: this.msgPrefix,
+                });
+            }
+        }
+        return new SimpleLogger(this.logger, {
+            level: this.getLevel(),
+            bindings: merged,
+            msgPrefix: this.msgPrefix,
+        });
+    }
+    /**
+     * Logs the start of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionStart(name) {
+        const caller = name || getCallerName();
+        this.trace(`Function start: ${caller}`);
+    }
+    /**
+     * Logs the end of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionEnd(name) {
+        const caller = name || getCallerName();
+        this.trace(`Function end: ${caller}`);
+    }
+}
+//# sourceMappingURL=simple-logger.js.map

package/dist/classes/simple-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-logger.js","sourceRoot":"","sources":["../../src/classes/simple-logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EACL,cAAc,EACd,cAAc,EACd,aAAa,EACb,cAAc,GACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AASzD,MAAM,CAAC,OAAO,OAAO,YAAY;IACvB,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAC7D,YAAY,CAAC,IAAI,CAClB,CAAC;IACM,MAAM,GAA6B,OAAO,CAAC;IAC3C,QAAQ,GAA4B,EAAE,CAAC;IACvC,SAAS,CAAU;IACnB,OAAO,GAAG,IAAI,CAAC;IACvB,UAAU,GAAG,KAAK,CAAC;IAEnB,MAAM,CAAU,IAAI,GAAU,GAAG,EAAE,GAAE,CAAC,CAAC;IAEvC,KAAK,GAAU,YAAY,CAAC,IAAI,CAAC;IACjC,KAAK,GAAU,YAAY,CAAC,IAAI,CAAC;IACjC,IAAI,GAAU,YAAY,CAAC,IAAI,CAAC;IAChC,IAAI,GAAU,YAAY,CAAC,IAAI,CAAC;IAChC,KAAK,GAAU,YAAY,CAAC,IAAI,CAAC;IACjC,KAAK,GAAU,YAAY,CAAC,IAAI,CAAC;IACjC,MAAM,GAAU,YAAY,CAAC,IAAI,CAAC;IAElC;;;;;OAKG;IACH,YACE,cAAsD,EACtD,UAAyB,EAAE;QAE3B,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACK,qBAAqB,CAC3B,MAAgC,EAChC,aAA2B;QAE3B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAI,aAAa;YAAE,OAAO,aAAa,CAAC;QACxC,IACE,MAAM;YACN,OAAO,MAAM,KAAK,QAAQ;YAC1B,OAAO,IAAI,MAAM;YACjB,OAAQ,MAAc,CAAC,KAAK,KAAK,QAAQ,EACzC,CAAC;YACD,MAAM,GAAG,GAAI,MAAc,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAChD,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAkB,CAAC;gBAAE,OAAO,GAAkB,CAAC;QACrE,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACK,UAAU,CAChB,cAAsD,EACtD,UAAyB,EAAE;QAE3B,MAAM,EACJ,KAAK,EACL,QAAQ,GAAG,EAAE,EACb,SAAS,EACT,SAAS,EACT,GAAG,WAAW,EACf,GAAG,OAAO,CAAC;QAEZ,MAAM,SAAS,GAAG,KAAK,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACzE,MAAM,iBAAiB,GAAG;YACxB,GAAG,QAAQ;YACX,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACpC,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,4BAA4B;QAC5B,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;YACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,4CAA4C;QAC5C,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE,CAAC;YACzC,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC;gBAC3B,KAAK;gBACL,GAAG,WAAW;gBACd,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACpC,CAAC,CAAC;YACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,qDAAqD;QACrD,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;YACjE,OAAO,CAAC,IAAI,CACV,qEAAqE,CACtE,CAAC;YACF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;YACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,wCAAwC;QACxC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC;YAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,4BAA4B;QAC5B,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC;gBACjC,GAAG,iBAAiB;gBACpB,GAAG,WAAW;gBACd,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACpC,CAAC,CAAC;YACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,yEAAyE;QACzE,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,OAAO,cAAc,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC7C,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACK,oBAAoB;QAC1B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAE3C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC9B,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,iBAAiB,IAAI,KAAK,EAAE,CAAC;gBACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;oBACnC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACpB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAC1C,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACpC,CAAC;gBACH,CAAC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;YAClC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,qBAAqB,CAAC,KAAkB,EAAE,IAAe;QAC/D,MAAM,MAAM,GAAI,IAAI,CAAC,MAAyB,CAAC,KAAK,CAAC,CAAC;QACtD,IAAI,OAAO,MAAM,KAAK,UAAU;YAAE,OAAO;QAEzC,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACrB,MAAuC,CAAC,GAAG,QAAQ,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,8BAA8B,KAAK,GAAG,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAC,KAAkB,EAAE,IAAe;QACzD,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAE1C,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;aACzD,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;aAC5B,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,MAAM,MAAM,GAAG,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEhE,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,UAAU,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,KAAkB;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,OAAQ,IAAI,CAAC,MAAyB,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC7D,IAAI,CAAC,MAAyB,CAAC,KAAK,GAAG,KAAK,CAAC;YAChD,CAAC;YACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAoC;QAC/C,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;QAEpD,IACE,IAAI,CAAC,UAAU;YACf,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;YAC/B,IAAI,CAAC,MAAM,KAAK,IAAI,EACpB,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAwB,CAAC;YAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;YAE7B,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;gBAClC,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBACjD,OAAO,IAAI,YAAY,CAAC,WAAW,EAAE;oBACnC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE;oBACtB,QAAQ,EAAE,MAAM;oBAChB,SAAS,EAAE,IAAI,CAAC,SAAS;iBAC1B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAwB,EAAE;YACrD,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE;YACtB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,IAAa;QACnC,MAAM,MAAM,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,IAAa;QACjC,MAAM,MAAM,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC"}

package/dist/constants/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const LoggerLevels: {
+    readonly TRACE: "trace";
+    readonly DEBUG: "debug";
+    readonly INFO: "info";
+    readonly WARN: "warn";
+    readonly ERROR: "error";
+    readonly FATAL: "fatal";
+    readonly SILENT: "silent";
+};

package/dist/constants/constants.js

@@ -0,0 +1,10 @@
+export const LoggerLevels = {
+    TRACE: 'trace',
+    DEBUG: 'debug',
+    INFO: 'info',
+    WARN: 'warn',
+    ERROR: 'error',
+    FATAL: 'fatal',
+    SILENT: 'silent',
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACR,CAAC"}

package/dist/helpers/helpers.d.ts

@@ -0,0 +1,31 @@
+import { LoggerLevel, PreparedLogCall } from '../types/simple-logger.types.js';
+/**
+ * Extracts the message and rest of the arguments from the provided array.
+ *
+ * If the first argument is an object and the second argument is a string, the second argument is considered the message.
+ * If the first argument is a string, it is considered the message.
+ * Otherwise, an empty message is returned.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the message from.
+ * @return {{ msg: string; rest: unknown[] }} An object containing the extracted message and the rest of the arguments.
+ */
+export declare function extractMessage(args: unknown[]): {
+    msg: string;
+    rest: unknown[];
+};
+/**
+ * Extracts the context object from the provided array of arguments.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the context from.
+ * @return {Record<string, unknown>} The extracted context object, or an empty object if no context is found.
+ */
+export declare function extractContext(args: unknown[]): Record<string, unknown>;
+/**
+ * Returns a string with the provided label colored according to the specified logging level.
+ *
+ * @param {LoggerLevel} level - The logging level to determine the color from.
+ * @param {string} label - The label to be colored.
+ * @return {string} The colored label.
+ */
+export declare function colorizeLevel(level: LoggerLevel, label: string): string;
+export declare function prepareLogCall(args: unknown[]): PreparedLogCall;

package/dist/helpers/helpers.js

@@ -0,0 +1,81 @@
+import chalk from 'chalk';
+import { LoggerLevels } from '../constants/constants.js';
+/**
+ * Extracts the message and rest of the arguments from the provided array.
+ *
+ * If the first argument is an object and the second argument is a string, the second argument is considered the message.
+ * If the first argument is a string, it is considered the message.
+ * Otherwise, an empty message is returned.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the message from.
+ * @return {{ msg: string; rest: unknown[] }} An object containing the extracted message and the rest of the arguments.
+ */
+export function extractMessage(args) {
+    const [first, second, ...rest] = args;
+    if (typeof first === 'object' &&
+        first !== null &&
+        typeof second === 'string') {
+        return { msg: second, rest };
+    }
+    if (typeof first === 'string') {
+        return {
+            msg: first,
+            rest: [second, ...rest].filter((value) => value !== undefined),
+        };
+    }
+    return { msg: '', rest: [] };
+}
+/**
+ * Extracts the context object from the provided array of arguments.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the context from.
+ * @return {Record<string, unknown>} The extracted context object, or an empty object if no context is found.
+ */
+export function extractContext(args) {
+    const [first] = args;
+    if (typeof first === 'object' && first !== null && !Array.isArray(first)) {
+        return first;
+    }
+    return {};
+}
+/**
+ * Returns a string with the provided label colored according to the specified logging level.
+ *
+ * @param {LoggerLevel} level - The logging level to determine the color from.
+ * @param {string} label - The label to be colored.
+ * @return {string} The colored label.
+ */
+export function colorizeLevel(level, label) {
+    switch (level) {
+        case LoggerLevels.DEBUG:
+        case LoggerLevels.TRACE:
+            return chalk.gray(label);
+        case LoggerLevels.INFO:
+            return chalk.green(label);
+        case LoggerLevels.WARN:
+            return chalk.yellow(label);
+        case LoggerLevels.ERROR:
+        case LoggerLevels.FATAL:
+            return chalk.red(label);
+        default:
+            return label;
+    }
+    /**
+     * Prepares the log call by rearranging the provided arguments into a standardized format.
+     *
+     * @param {unknown[]} args - The array of arguments to prepare for the log call.
+     * @return {PreparedLogCall} The prepared log call arguments, or null if the input is invalid.
+     */
+}
+export function prepareLogCall(args) {
+    if (typeof args[0] === 'string') {
+        return [args[0], ...args.slice(1)];
+    }
+    if (typeof args[0] === 'object' && args[0] !== null) {
+        const msg = typeof args[1] === 'string' ? args[1] : undefined;
+        const rest = args.slice(msg ? 2 : 1);
+        return [args[0], msg, ...rest];
+    }
+    return null;
+}
+//# sourceMappingURL=helpers.js.map

package/dist/helpers/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,IAAe;IAI5C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEtC,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,OAAO,MAAM,KAAK,QAAQ,EAC1B,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACL,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAe;IAC5C,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IACrB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzE,OAAO,KAAgC,CAAC;IAC1C,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,KAAkB,EAAE,KAAa;IAC7D,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY,CAAC,KAAK,CAAC;QACxB,KAAK,YAAY,CAAC,KAAK;YACrB,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,KAAK,YAAY,CAAC,IAAI;YACpB,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,KAAK,YAAY,CAAC,IAAI;YACpB,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7B,KAAK,YAAY,CAAC,KAAK,CAAC;QACxB,KAAK,YAAY,CAAC,KAAK;YACrB,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1B;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;IACH;;;;;OAKG;AACH,CAAC;AAAA,MAAM,UAAU,cAAc,CAAC,IAAe;IAC7C,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/helpers/validators.d.ts

@@ -0,0 +1,17 @@
+import { ExternalLogger } from '../types/simple-logger.types.js';
+/**
+ * Checks if the provided logger is a valid ExternalLogger instance.
+ *
+ * @param {unknown} logger - The logger to validate.
+ * @return {logger is ExternalLogger} True if the logger is a valid ExternalLogger, false otherwise.
+ */
+export declare function isValidLogger(logger: unknown): logger is ExternalLogger;
+/**
+ * Checks if the provided logger is an ExternalLogger instance with a child method.
+ *
+ * @param {unknown} logger - The logger to check.
+ * @return {logger is ExternalLogger & { child: Function }} True if the logger is an ExternalLogger with a child method, false otherwise.
+ */
+export declare function hasChild(logger: unknown): logger is ExternalLogger & {
+    child: Function;
+};

package/dist/helpers/validators.js

@@ -0,0 +1,27 @@
+import { LoggerLevels } from '../constants/constants';
+/**
+ * Checks if the provided logger is a valid ExternalLogger instance.
+ *
+ * @param {unknown} logger - The logger to validate.
+ * @return {logger is ExternalLogger} True if the logger is a valid ExternalLogger, false otherwise.
+ */
+export function isValidLogger(logger) {
+    const levels = Object.values(LoggerLevels);
+    if (typeof logger !== 'object' || logger === null) {
+        return false;
+    }
+    const candidate = logger;
+    return levels.some((level) => typeof candidate[level] === 'function');
+}
+/**
+ * Checks if the provided logger is an ExternalLogger instance with a child method.
+ *
+ * @param {unknown} logger - The logger to check.
+ * @return {logger is ExternalLogger & { child: Function }} True if the logger is an ExternalLogger with a child method, false otherwise.
+ */
+export function hasChild(logger) {
+    return (typeof logger === 'object' &&
+        logger !== null &&
+        typeof logger.child === 'function');
+}
+//# sourceMappingURL=validators.js.map

package/dist/helpers/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../src/helpers/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAGtD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,MAAe;IAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAE3C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,MAAiC,CAAC;IAEpD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,SAAS,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAe;IAEf,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,OAAQ,MAAc,CAAC,KAAK,KAAK,UAAU,CAC5C,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,2 +1,5 @@
-export { default } from './simple-logger.js';
-export * from './simple-logger.js';
+import SimpleLogger from './classes/simple-logger';
+export default SimpleLogger;
+export { SimpleLogger };
+export * from './types/simple-logger.types.js';
+export * from './constants/constants.js';

package/dist/index.js

@@ -1,3 +1,6 @@
-export { default } from './simple-logger.js';
-export * from './simple-logger.js';
+import SimpleLogger from './classes/simple-logger';
+export default SimpleLogger;
+export { SimpleLogger };
+export * from './types/simple-logger.types.js';
+export * from './constants/constants.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,yBAAyB,CAAC;AAEnD,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC"}