@quatrain/log 0.1.2

package/lib/AbstractLoggerAdapter.d.ts

@@ -0,0 +1,35 @@
+export declare enum LogLevel {
+    TRACE = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4,
+    SILENT = 5
+}
+export interface LoggerType {
+    log(message: string): void;
+    debug(message: string): void;
+    warn(message: string): void;
+    info(message: string): void;
+    error(message: string): void;
+    trace(message: string): void;
+}
+export declare class AbstractLoggerAdapter {
+    protected _me: string;
+    protected _logLevel: LogLevel;
+    protected _logger: any;
+    constructor(prefix?: string, level?: LogLevel);
+    timestamp: () => string;
+    formatLogMessage: (message: any) => string;
+    /**
+     * Log message using defined logger
+     * @param message string | object
+     * @param level string
+     */
+    log(message: any, level?: LogLevel): void;
+    debug(message: any): void;
+    warn(message: any): void;
+    info(message: any): void;
+    error(message: any): void;
+    trace(message: any): void;
+}

package/lib/AbstractLoggerAdapter.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractLoggerAdapter = exports.LogLevel = void 0;
+const Log_1 = require("./Log");
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["TRACE"] = 0] = "TRACE";
+    LogLevel[LogLevel["DEBUG"] = 1] = "DEBUG";
+    LogLevel[LogLevel["INFO"] = 2] = "INFO";
+    LogLevel[LogLevel["WARN"] = 3] = "WARN";
+    LogLevel[LogLevel["ERROR"] = 4] = "ERROR";
+    LogLevel[LogLevel["SILENT"] = 5] = "SILENT";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+class AbstractLoggerAdapter {
+    constructor(prefix = '', level = LogLevel.WARN) {
+        this._me = '';
+        this._logLevel = LogLevel.WARN;
+        this._logger = undefined;
+        // How timestamp are formatted
+        this.timestamp = () => new Date().toISOString();
+        this.formatLogMessage = (message) => `${Log_1.Log.timestamp()} - [${this._me}] ${typeof message === 'string' ? message : JSON.stringify(message)}`;
+        this._me = prefix;
+        this._logLevel = level;
+    }
+    /**
+     * Log message using defined logger
+     * @param message string | object
+     * @param level string
+     */
+    log(message, level = LogLevel.WARN) {
+        this._logger.log(this.formatLogMessage(message));
+    }
+    debug(message) {
+        this._logger.debug(this.formatLogMessage(message));
+    }
+    warn(message) {
+        this._logger.warn(this.formatLogMessage(message));
+    }
+    info(message) {
+        this._logger.info(this.formatLogMessage(message));
+    }
+    error(message) {
+        this._logger.error(this.formatLogMessage(message));
+    }
+    trace(message) {
+        this._logger.trace(this.formatLogMessage(message));
+    }
+}
+exports.AbstractLoggerAdapter = AbstractLoggerAdapter;

package/lib/DefaultLoggerAdapter.d.ts

@@ -0,0 +1,4 @@
+import { AbstractLoggerAdapter } from './AbstractLoggerAdapter';
+export declare class DefaultLoggerAdapter extends AbstractLoggerAdapter {
+    constructor();
+}

package/lib/DefaultLoggerAdapter.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLoggerAdapter = void 0;
+const AbstractLoggerAdapter_1 = require("./AbstractLoggerAdapter");
+const loglevel_1 = __importDefault(require("loglevel"));
+class DefaultLoggerAdapter extends AbstractLoggerAdapter_1.AbstractLoggerAdapter {
+    constructor() {
+        super('Log');
+        this._logger = loglevel_1.default;
+    }
+}
+exports.DefaultLoggerAdapter = DefaultLoggerAdapter;

package/lib/Log.d.ts

@@ -0,0 +1,21 @@
+import { AbstractLoggerAdapter } from "./AbstractLoggerAdapter";
+export type LoggerRegistry<T extends AbstractLoggerAdapter> = {
+    [x: string]: T;
+};
+export declare class Log {
+    static defaultLogger: string;
+    protected static _loggers: LoggerRegistry<any>;
+    static timestamp: () => string;
+    static addLogger(logger: AbstractLoggerAdapter, alias: string, setDefault?: boolean): void;
+    static getLogger<T extends AbstractLoggerAdapter>(alias?: string): T;
+    /**
+     * Log message using defined logger
+     * @param message string | object
+     */
+    static log(message: any): void;
+    static debug(message: any): void;
+    static warn(message: any): void;
+    static info(message: any): void;
+    static error(message: any): void;
+    static trace(message: any): void;
+}

package/lib/Log.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Log = void 0;
+const DefaultLoggerAdapter_1 = require("./DefaultLoggerAdapter");
+class Log {
+    static addLogger(logger, alias, setDefault = false) {
+        this._loggers[alias] = logger;
+        if (setDefault) {
+            this.defaultLogger = alias;
+        }
+    }
+    static getLogger(alias = this.defaultLogger) {
+        if (this._loggers[alias]) {
+            return this._loggers[alias];
+        }
+        else {
+            throw new Error(`Unknown logger alias: '${alias}'`);
+        }
+    }
+    /**
+     * Log message using defined logger
+     * @param message string | object
+     */
+    static log(message) {
+        return Log.getLogger().log(message);
+    }
+    static debug(message) {
+        return Log.getLogger().debug(message);
+    }
+    static warn(message) {
+        return Log.getLogger().warn(message);
+    }
+    static info(message) {
+        return Log.getLogger().info(message);
+    }
+    static error(message) {
+        return Log.getLogger().error(message);
+    }
+    static trace(message) {
+        return Log.getLogger().trace(message);
+    }
+}
+exports.Log = Log;
+Log.defaultLogger = '@default';
+Log._loggers = {
+    default: new DefaultLoggerAdapter_1.DefaultLoggerAdapter()
+};
+// How timestamp are formatted
+Log.timestamp = () => new Date().toISOString();

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { Log } from './Log';
+import { LogLevel, AbstractLoggerAdapter } from './AbstractLoggerAdapter';
+export { Log, AbstractLoggerAdapter, LogLevel };

package/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = exports.AbstractLoggerAdapter = exports.Log = void 0;
+const Log_1 = require("./Log");
+Object.defineProperty(exports, "Log", { enumerable: true, get: function () { return Log_1.Log; } });
+const AbstractLoggerAdapter_1 = require("./AbstractLoggerAdapter");
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return AbstractLoggerAdapter_1.LogLevel; } });
+Object.defineProperty(exports, "AbstractLoggerAdapter", { enumerable: true, get: function () { return AbstractLoggerAdapter_1.AbstractLoggerAdapter; } });

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@quatrain/log",
+  "version": "0.1.2",
+  "description": "Logger for business apps",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/",
+    "README.md"
+  ],
+  "author": "Quatrain Développement SAS <developers@quatrain.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^22.10.1",
+    "jest": "^27.4.7",
+    "jest-node-exports-resolver": "^1.1.6",
+    "trace-unhandled": "^2.0.1",
+    "ts-jest": "^27.1.2",
+    "ts-node": "^10.4.0",
+    "typescript": "^5.1.5"
+  },
+  "dependencies": {
+    "loglevel": "^1.9.2"
+  },
+  "scripts": {
+    "test-ci": "jest --runInBand",
+    "build": "tsc",
+    "wbuild": "tsc --watch",
+    "bump-to": "yarn version",
+    "hash": "node ../../bin/hashFolder.js",
+    "hash:persist": "yarn hash  > .hash_latest.txt",
+    "hash:compare": "yarn hash > .hash_newest.txt && cmp -s .hash_latest.txt .hash_newest.txt",
+    "publish": "yarn hash:compare || yarn publish:process",
+    "publish:process": "yarn version patch && yarn build && yarn npm publish --access public && yarn hash:persist"
+  }
+}