@vvlad1973/simple-logger 1.2.0

package/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Используйте IntelliSense, чтобы узнать о возможных атрибутах.
+  // Наведите указатель мыши, чтобы просмотреть описания существующих атрибутов.
+  // Для получения дополнительной информации посетите: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Запустить программу",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}\\src\\__test__\\simple-logger.test.ts",
+      "preLaunchTask": "tsc: build - tsconfig.json",
+      "outFiles": [
+        "${workspaceFolder}/dist/**/*.js"
+      ]
+    }
+  ]
+}

package/LICENSE

@@ -0,0 +1,19 @@
+# MIT License with Commercial Use
+
+Copyright (c) 2022 Vladislav Vnukovskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software.
+
+Commercial Use:
+
+The user is allowed to use the Software for commercial purposes, subject to the following conditions:
+
+The user must agree to share a portion of their revenue with the author of the Software.
+
+The author of the Software reserves the right to verify the accuracy and size of the revenue earned by the user through the use of the Software. This provision is a mandatory condition for the commercial use of the Software.
+
+If the user does not agree to these conditions, they may not use the Software for commercial purposes.
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# @vvlad1973/simple-logger
+
+A simple logger module for Node.js applications with support for various logging levels.
+
+## Installation
+
+```bash
+npm install vvlad1973-simple-logger
+```
+
+## Features
+
+- Supports logging at different levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
+- Allows integration with external logging libraries like Pino.
+
+## Usage
+
+### Simple Logger
+
+```javascript
+
+import SimpleLogger from 'vvlad1973-simple-logger';
+
+const logger = new SimpleLogger('DEBUG');
+
+logger.debug('Debug message');
+logger.info('Info message');
+logger.warn('Warning message');
+logger.error('Error message');
+logger.fatal('Fatal error message');
+```
+
+### Integration with Pino
+
+```javascript
+import pino from 'pino';
+import SimpleLogger from 'vvlad1973-simple-logger';
+
+// Initialize Pino logger
+const pinoLogger = pino({
+  prettyPrint: true,
+});
+
+// Use Pino logger with SimpleLogger
+const logger = new SimpleLogger('DEBUG', pinoLogger);
+
+logger.debug('Debug message');
+logger.info('Info message');
+logger.warn('Warning message');
+logger.error('Error message');
+logger.fatal('Fatal error message');
+```
+
+## API
+
+### new SimpleLogger(level, externalLogger)
+
+Creates a new instance of SimpleLogger.
+
+- level (optional): Initial logging level. Defaults to 'INFO'.
+- externalLogger (optional): External logger instance. Can be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.
+
+### setLevel(level)
+
+Sets the logging level of the logger instance.
+
+- level: The logging level to set ('TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL').
+
+### setExternalLogger(logger)
+
+Sets an external logger instance to be used by SimpleLogger.
+
+- logger: External logger instance. Should be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.
+
+### logFunctionStart(functionName?)
+
+Logs the start of a function.
+
+- functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.
+
+### logFunctionEnd(functionName?)
+
+Logs the end of a function.
+
+- functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.
+
+### Documentation
+
+Full information about the package is available in the [./docs](./docs/index.html) directory
+
+### License
+
+This project is licensed under the MIT License with Commercial Use.
+
+## Author
+
+Vladislav Vnukovskiy <vvlad1973@gmail.com>

package/dist/__test__/simple-logger.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__test__/simple-logger.test.js

@@ -0,0 +1,113 @@
+import { describe, it, beforeEach } from 'node:test';
+import assert from 'assert';
+import SimpleLogger from '../simple-logger.js';
+function createMockLoggerMethod() {
+    const calls = [];
+    const mockFn = function (...args) {
+        calls.push(args);
+    };
+    mockFn.mock = { calls };
+    return mockFn;
+}
+function createNoopMethod() {
+    const calls = [];
+    const mockFn = function (...args) { };
+    mockFn.mock = { calls };
+    return mockFn;
+}
+function createExternalLoggerMock() {
+    return {
+        trace: createMockLoggerMethod(),
+        debug: createMockLoggerMethod(),
+        info: createMockLoggerMethod(),
+        warn: createMockLoggerMethod(),
+        error: createMockLoggerMethod(),
+        fatal: createMockLoggerMethod(),
+        silent: createMockLoggerMethod(),
+    };
+}
+describe('SimpleLogger', () => {
+    let logger;
+    let externalLoggerMock;
+    beforeEach(() => {
+        externalLoggerMock = createExternalLoggerMock();
+        logger = new SimpleLogger('info', externalLoggerMock);
+    });
+    it('should call external logger methods appropriately', () => {
+        logger.trace('trace message');
+        logger.debug('debug message');
+        logger.info('info message');
+        logger.warn('warn message');
+        logger.error('error message');
+        logger.fatal('fatal message');
+        assert.strictEqual(externalLoggerMock.trace.mock.calls.length, 0);
+        assert.strictEqual(externalLoggerMock.debug.mock.calls.length, 0);
+        assert.strictEqual(externalLoggerMock.info.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.info.mock.calls[0][0], 'info message');
+        assert.strictEqual(externalLoggerMock.warn.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.warn.mock.calls[0][0], 'warn message');
+        assert.strictEqual(externalLoggerMock.error.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.error.mock.calls[0][0], 'error message');
+        assert.strictEqual(externalLoggerMock.fatal.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.fatal.mock.calls[0][0], 'fatal message');
+    });
+    it('should log function start and end', () => {
+        logger.setLevel('TRACE');
+        function testFunction() {
+            logger.logFunctionStart();
+            logger.logFunctionEnd();
+        }
+        testFunction();
+        assert.strictEqual(externalLoggerMock.trace.mock.calls.length, 2);
+        assert.strictEqual(externalLoggerMock.trace.mock.calls[0][0], 'Function start: testFunction');
+        assert.strictEqual(externalLoggerMock.trace.mock.calls[1][0], 'Function end: testFunction');
+    });
+});
+describe('SimpleLogger2', () => {
+    let logger;
+    let externalLoggerMock;
+    beforeEach(() => {
+        externalLoggerMock = createExternalLoggerMock();
+        logger = new SimpleLogger('info', externalLoggerMock);
+    });
+    it('should use console as default external logger', () => {
+        const defaultLogger = new SimpleLogger();
+        assert.ok(defaultLogger);
+    });
+    it('should set the correct log level', () => {
+        logger.setLevel('DEBUG');
+        assert.notStrictEqual(logger.trace, () => { });
+        assert.strictEqual(typeof logger.debug, 'function');
+        assert.strictEqual(typeof logger.info, 'function');
+    });
+    it('should call external logger methods appropriately', () => {
+        logger.trace('trace message');
+        logger.debug('debug message');
+        logger.info('info message');
+        logger.warn('warn message');
+        logger.error('error message');
+        logger.fatal('fatal message');
+        assert.strictEqual(externalLoggerMock.trace.mock.calls.length, 0); // because default level is INFO
+        assert.strictEqual(externalLoggerMock.debug.mock.calls.length, 0); // because default level is INFO
+        assert.strictEqual(externalLoggerMock.info.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.info.mock.calls[0][0], 'info message');
+        assert.strictEqual(externalLoggerMock.warn.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.warn.mock.calls[0][0], 'warn message');
+        assert.strictEqual(externalLoggerMock.error.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.error.mock.calls[0][0], 'error message');
+        assert.strictEqual(externalLoggerMock.fatal.mock.calls.length, 1);
+        assert.strictEqual(externalLoggerMock.fatal.mock.calls[0][0], 'fatal message');
+    });
+    it('should log function start and end', () => {
+        logger.setLevel('TRACE');
+        function testFunction() {
+            logger.logFunctionStart();
+            logger.logFunctionEnd();
+        }
+        testFunction();
+        assert.strictEqual(externalLoggerMock.trace.mock.calls.length, 2);
+        assert.strictEqual(externalLoggerMock.trace.mock.calls[0][0], 'Function start: testFunction');
+        assert.strictEqual(externalLoggerMock.trace.mock.calls[1][0], 'Function end: testFunction');
+    });
+});
+//# sourceMappingURL=simple-logger.test.js.map

package/dist/__test__/simple-logger.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-logger.test.js","sourceRoot":"","sources":["../../src/__test__/simple-logger.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,YAAY,MAAM,qBAAqB,CAAC;AAY/C,SAAS,sBAAsB;IAC7B,MAAM,KAAK,GAAY,EAAE,CAAC;IAC1B,MAAM,MAAM,GAAG,UAAU,GAAG,IAAW;QACrC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAiB,CAAC;IAClB,MAAM,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,KAAK,GAAY,EAAE,CAAC;IAC1B,MAAM,MAAM,GAAG,UAAU,GAAG,IAAW,IAAG,CAAiB,CAAC;IAC5D,MAAM,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAWD,SAAS,wBAAwB;IAC/B,OAAO;QACL,KAAK,EAAE,sBAAsB,EAAE;QAC/B,KAAK,EAAE,sBAAsB,EAAE;QAC/B,IAAI,EAAE,sBAAsB,EAAE;QAC9B,IAAI,EAAE,sBAAsB,EAAE;QAC9B,KAAK,EAAE,sBAAsB,EAAE;QAC/B,KAAK,EAAE,sBAAsB,EAAE;QAC/B,MAAM,EAAC,sBAAsB,EAAE;KAChC,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,MAAoB,CAAC;IACzB,IAAI,kBAAsC,CAAC;IAE3C,UAAU,CAAC,GAAG,EAAE;QACd,kBAAkB,GAAG,wBAAwB,EAAE,CAAC;QAChD,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxC,cAAc,CACf,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxC,cAAc,CACf,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,eAAe,CAChB,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzB,SAAS,YAAY;YACnB,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,YAAY,EAAE,CAAC;QAEf,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,8BAA8B,CAC/B,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,4BAA4B,CAC7B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,IAAI,MAAoB,CAAC;IACzB,IAAI,kBAAsC,CAAC;IAE3C,UAAU,CAAC,GAAG,EAAE;QACd,kBAAkB,GAAG,wBAAwB,EAAE,CAAC;QAChD,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,aAAa,GAAG,IAAI,YAAY,EAAE,CAAC;QACzC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,WAAW,CAAC,OAAO,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,OAAO,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,gCAAgC;QACnG,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,gCAAgC;QACnG,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxC,cAAc,CACf,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxC,cAAc,CACf,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,eAAe,CAChB,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzB,SAAS,YAAY;YACnB,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,YAAY,EAAE,CAAC;QAEf,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,8BAA8B,CAC/B,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,4BAA4B,CAC7B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './simple-logger.js';
+export * from './simple-logger.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { default } from './simple-logger.js';
+export * from './simple-logger.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/simple-logger.d.ts

@@ -0,0 +1,80 @@
+/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+export type ExternalLogger = {
+    trace?: LogFn;
+    debug?: LogFn;
+    info?: LogFn;
+    warn?: LogFn;
+    error?: LogFn;
+    fatal?: LogFn;
+    silent?: LogFn;
+    level?: string;
+};
+interface LogFn {
+    <T extends object>(obj: T, msg?: string, ...args: any[]): void;
+    (obj: unknown, msg?: string, ...args: any[]): void;
+    (msg: string, ...args: any[]): void;
+}
+declare const loggerLevels: readonly ["trace", "debug", "info", "warn", "error", "fatal", "silent"];
+export type LoggerLevel = (typeof loggerLevels)[number];
+/**
+ * A simple logger class with various logging levels.
+ * @class
+ * @param {string} [level='info'] - Initial logging level.
+ * @param {ExternalLogger | undefined | null} [externalLogger=null] - Optional external logger to use.
+ */
+export declare class SimpleLogger {
+    #private;
+    isExternal: boolean;
+    constructor(level?: LoggerLevel, externalLogger?: ExternalLogger);
+    trace: LogFn;
+    debug: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    error: LogFn;
+    fatal: LogFn;
+    silent: LogFn;
+    /**
+     * Updates the logging methods based on the current logging level.
+     * @private
+     */
+    private updateLoggingMethods;
+    /**
+     * Checks if the provided logger is valid.
+     * @private
+     * @param {any} logger - The logger to check.
+     * @returns {boolean} - True if the logger is valid, otherwise false.
+     */
+    private isValidLogger;
+    /**
+     * Gets the external logger method for a specific level.
+     * @param {string} method - The logger method to get.
+     * @param {string} [fallbackMethod] - The fallback logger method to get.
+     * @returns {LoggerMethod} - The logger method or a no-op function.
+     * @private
+     */
+    private getExternalLoggerMethod;
+    /**
+     * Sets the logging level.
+     * @param {string} level - The logging level to set.
+     */
+    setLevel(level: string): void;
+    /**
+     * Sets an external logger to be used.
+     * @param {ExternalLogger | undefined | null} logger - The external logger to set.
+     */
+    setExternalLogger(logger: ExternalLogger | undefined | null, level?: LoggerLevel): void;
+    /**
+     * Logs the start of a function.
+     * @param {string} [functionName] - Optional function name to log.
+     */
+    logFunctionStart(functionName?: string): void;
+    /**
+     * Logs the end of a function.
+     * @param {string} [functionName] - Optional function name to log.
+     */
+    logFunctionEnd(functionName?: string): void;
+}
+export default SimpleLogger;

package/dist/simple-logger.js

@@ -0,0 +1,152 @@
+/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+import { getCallerName } from 'vvlad1973-utils';
+const loggerLevels = [
+    'trace',
+    'debug',
+    'info',
+    'warn',
+    'error',
+    'fatal',
+    'silent',
+];
+/**
+ * A simple logger class with various logging levels.
+ * @class
+ * @param {string} [level='info'] - Initial logging level.
+ * @param {ExternalLogger | undefined | null} [externalLogger=null] - Optional external logger to use.
+ */
+export class SimpleLogger {
+    #levels = loggerLevels;
+    #currentLevel = 2;
+    #logger = console;
+    isExternal = false;
+    constructor(level, externalLogger) {
+        if (externalLogger && this.isValidLogger(externalLogger)) {
+            this.setExternalLogger(externalLogger, level);
+        }
+        else {
+            this.setLevel(level ?? 'info');
+        }
+    }
+    trace = (...args) => { };
+    debug = (...args) => { };
+    info = (...args) => { };
+    warn = (...args) => { };
+    error = (...args) => { };
+    fatal = (...args) => { };
+    silent = (...args) => { };
+    /**
+     * Updates the logging methods based on the current logging level.
+     * @private
+     */
+    updateLoggingMethods() {
+        try {
+            const noop = (...args) => { };
+            this.trace =
+                this.#currentLevel <= 0 ? this.getExternalLoggerMethod('trace') : noop;
+            this.debug =
+                this.#currentLevel <= 1 ? this.getExternalLoggerMethod('debug') : noop;
+            this.info =
+                this.#currentLevel <= 2 ? this.getExternalLoggerMethod('info') : noop;
+            this.warn =
+                this.#currentLevel <= 3 ? this.getExternalLoggerMethod('warn') : noop;
+            this.error =
+                this.#currentLevel <= 4 ? this.getExternalLoggerMethod('error') : noop;
+            this.fatal =
+                this.#currentLevel <= 5
+                    ? this.getExternalLoggerMethod('fatal', 'error')
+                    : noop;
+            this.silent = noop;
+        }
+        catch (error) {
+            console.error(error);
+        }
+    }
+    /**
+     * Checks if the provided logger is valid.
+     * @private
+     * @param {any} logger - The logger to check.
+     * @returns {boolean} - True if the logger is valid, otherwise false.
+     */
+    isValidLogger(logger) {
+        return loggerLevels.every((method) => {
+            return typeof logger[method] === 'function';
+        });
+    }
+    /**
+     * Gets the external logger method for a specific level.
+     * @param {string} method - The logger method to get.
+     * @param {string} [fallbackMethod] - The fallback logger method to get.
+     * @returns {LoggerMethod} - The logger method or a no-op function.
+     * @private
+     */
+    getExternalLoggerMethod(method, fallbackMethod) {
+        try {
+            const loggerMethod = this.#logger[method];
+            if (typeof loggerMethod === 'function') {
+                return loggerMethod.bind(this.#logger);
+            }
+            else if (typeof fallbackMethod !== 'undefined') {
+                const fallbackLoggerMethod = this.#logger[fallbackMethod];
+                if (typeof fallbackLoggerMethod === 'function') {
+                    return fallbackLoggerMethod.bind(this.#logger);
+                }
+            }
+            return () => { };
+        }
+        catch (error) {
+            console.error(error);
+            return () => { };
+        }
+    }
+    /**
+     * Sets the logging level.
+     * @param {string} level - The logging level to set.
+     */
+    setLevel(level) {
+        const index = this.#levels.indexOf(level.toLowerCase());
+        if (index !== -1) {
+            this.#currentLevel = index;
+            if (typeof this.#logger.level === 'string') {
+                this.#logger.level = level;
+            }
+            this.updateLoggingMethods();
+        }
+    }
+    /**
+     * Sets an external logger to be used.
+     * @param {ExternalLogger | undefined | null} logger - The external logger to set.
+     */
+    setExternalLogger(logger, level) {
+        if (logger && this.isValidLogger(logger)) {
+            this.#logger = logger;
+            this.isExternal = true;
+        }
+        else {
+            this.#logger = console;
+            this.isExternal = false;
+        }
+        this.setLevel(level ?? logger?.level ?? this.#levels[this.#currentLevel]);
+    }
+    /**
+     * Logs the start of a function.
+     * @param {string} [functionName] - Optional function name to log.
+     */
+    logFunctionStart(functionName) {
+        const callerName = functionName || getCallerName();
+        this.trace(`Function start: ${callerName}`);
+    }
+    /**
+     * Logs the end of a function.
+     * @param {string} [functionName] - Optional function name to log.
+     */
+    logFunctionEnd(functionName) {
+        const callerName = functionName || getCallerName();
+        this.trace(`Function end: ${callerName}`);
+    }
+}
+export default SimpleLogger;
+//# sourceMappingURL=simple-logger.js.map

package/dist/simple-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-logger.js","sourceRoot":"","sources":["../src/simple-logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAmBhD,MAAM,YAAY,GAAG;IACnB,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;CACA,CAAC;AAEX;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IACvB,OAAO,GAAG,YAAY,CAAC;IACvB,aAAa,GAAW,CAAC,CAAC;IAC1B,OAAO,GAA6B,OAAO,CAAC;IAE5C,UAAU,GAAY,KAAK,CAAC;IAE5B,YAAY,KAAmB,EAAE,cAA+B;QAC9D,IAAI,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,KAAK,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACtC,KAAK,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACtC,IAAI,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACrC,IAAI,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACrC,KAAK,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACtC,KAAK,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IACtC,MAAM,GAAU,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;IAEvC;;;OAGG;IACK,oBAAoB;QAC1B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK;gBACR,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,IAAI,CAAC,KAAK;gBACR,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,IAAI,CAAC,IAAI;gBACP,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACxE,IAAI,CAAC,IAAI;gBACP,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACxE,IAAI,CAAC,KAAK;gBACR,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,IAAI,CAAC,KAAK;gBACR,IAAI,CAAC,aAAa,IAAI,CAAC;oBACrB,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC;oBAChD,CAAC,CAAC,IAAI,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,MAAW;QAC/B,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,OAAO,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAC7B,MAA4B,EAC5B,cAAqC;QAErC,IAAI,CAAC;YACH,MAAM,YAAY,GAAI,IAAI,CAAC,OAA0B,CAAC,MAAM,CAAC,CAAC;YAE9D,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;gBACvC,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;iBAAM,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE,CAAC;gBACjD,MAAM,oBAAoB,GAAI,IAAI,CAAC,OAA0B,CAC3D,cAAc,CACf,CAAC;gBAEF,IAAI,OAAO,oBAAoB,KAAK,UAAU,EAAE,CAAC;oBAC/C,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YACD,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAa;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAiB,CAAC,CAAC;QACvE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAE3B,IAAI,OAAQ,IAAI,CAAC,OAA0B,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9D,IAAI,CAAC,OAA0B,CAAC,KAAK,GAAG,KAAK,CAAC;YACjD,CAAC;YACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACtB,MAAyC,EACzC,KAAmB;QAEnB,IAAI,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,YAAqB;QAC3C,MAAM,UAAU,GAAG,YAAY,IAAI,aAAa,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,YAAqB;QACzC,MAAM,UAAU,GAAG,YAAY,IAAI,aAAa,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,iBAAiB,UAAU,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,eAAe,YAAY,CAAC"}

package/docs/index.html

@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> Home</title>
+
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+
+  
+</head>
+
+
+
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+    
+
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+            
+            
+        </div>
+        <div class="menu">
+            
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+                
+                
+                
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            
+            <nav>
+                
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-SimpleLogger.html">SimpleLogger</a></li></ul><h3>Classes</h3><ul><li><a href="module-SimpleLogger.SimpleLogger.html">SimpleLogger</a></li></ul></div>
+                
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p></p>
+                    <h1>Home</h1>
+                </header>
+                
+
+
+
+    
+
+
+    <h3> </h3>
+
+
+
+
+
+
+
+
+
+
+    
+
+
+
+
+
+
+
+
+
+            </div>
+            
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+            
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+
+
+</body>
+</html>