@villedemontreal/logger 6.5.1

package/dist/src/lazyLogger.d.ts

@@ -0,0 +1,21 @@
+import { ILogger, LogLevel } from './logger';
+/**
+ * A Logger wrapper that allows to lazyly create a
+ * real Logger.
+ *
+ * The first time a log is perform, the
+ * "loggerCreator" will be called to create
+ * the actual Logger.
+ */
+export declare class LazyLogger implements ILogger {
+    private realLogger;
+    private name;
+    private loggerCreator;
+    constructor(name: string, loggerCreator: (name: string) => ILogger);
+    debug(messageObj: any, txtMsg?: string): void;
+    info(messageObj: any, txtMsg?: string): void;
+    warning(messageObj: any, txtMsg?: string): void;
+    error(messageObj: any, txtMsg?: string): void;
+    log(level: LogLevel, messageObj: any, txtMsg?: string): void;
+    protected getRealLogger(): ILogger;
+}

package/dist/src/lazyLogger.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LazyLogger = void 0;
+/**
+ * A Logger wrapper that allows to lazyly create a
+ * real Logger.
+ *
+ * The first time a log is perform, the
+ * "loggerCreator" will be called to create
+ * the actual Logger.
+ */
+class LazyLogger {
+    constructor(name, loggerCreator) {
+        this.name = name;
+        if (!loggerCreator) {
+            throw new Error(`The Logger Creator is required!`);
+        }
+        this.loggerCreator = loggerCreator;
+    }
+    debug(messageObj, txtMsg) {
+        return this.getRealLogger().debug(messageObj, txtMsg);
+    }
+    info(messageObj, txtMsg) {
+        return this.getRealLogger().info(messageObj, txtMsg);
+    }
+    warning(messageObj, txtMsg) {
+        return this.getRealLogger().warning(messageObj, txtMsg);
+    }
+    error(messageObj, txtMsg) {
+        return this.getRealLogger().error(messageObj, txtMsg);
+    }
+    log(level, messageObj, txtMsg) {
+        return this.getRealLogger().log(level, messageObj, txtMsg);
+    }
+    getRealLogger() {
+        if (!this.realLogger) {
+            this.realLogger = this.loggerCreator(this.name);
+            if (!this.realLogger) {
+                throw new Error(`The Logger Creator must create a valid Logger!`);
+            }
+        }
+        return this.realLogger;
+    }
+}
+exports.LazyLogger = LazyLogger;
+//# sourceMappingURL=lazyLogger.js.map

package/dist/src/lazyLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lazyLogger.js","sourceRoot":"","sources":["../../src/lazyLogger.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,MAAa,UAAU;IAKrB,YAAY,IAAY,EAAE,aAAwC;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;QACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,UAAe,EAAE,MAAe;QAC3C,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IACM,IAAI,CAAC,UAAe,EAAE,MAAe;QAC1C,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IACM,OAAO,CAAC,UAAe,EAAE,MAAe;QAC7C,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IACM,KAAK,CAAC,UAAe,EAAE,MAAe;QAC3C,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IACM,GAAG,CAAC,KAAe,EAAE,UAAe,EAAE,MAAe;QAC1D,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAES,aAAa;QACrB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;gBACpB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACnE;SACF;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAvCD,gCAuCC"}

package/dist/src/logger.d.ts

@@ -0,0 +1,169 @@
+import { LogLevel } from '@villedemontreal/general-utils';
+import * as pino from 'pino';
+import { LoggerConfigs } from './config/configs';
+export { LogLevel } from '@villedemontreal/general-utils';
+/**
+ * A Logger.
+ */
+export interface ILogger {
+    debug(messageObj: any, txtMsg?: string): void;
+    info(messageObj: any, txtMsg?: string): void;
+    warning(messageObj: any, txtMsg?: string): void;
+    error(messageObj: any, txtMsg?: string): void;
+    log(level: LogLevel, messageObj: any, txtMsg?: string): void;
+}
+/**
+ * Converts a Pino level to its number value.
+ */
+export declare const convertPinoLevelToNumber: (pinoLogLevel: pino.Level) => number;
+/**
+ * Converts a local LogLevel to a Pino label level.
+ */
+export declare const convertLogLevelToPinoLabelLevel: (logLevel: LogLevel) => pino.Level;
+/**
+ * Converts a local LogLevel to a Pino number level.
+ */
+export declare const convertLogLevelToPinoNumberLevel: (logLevel: LogLevel) => number;
+/**
+ * Initialize the logger with the config given in parameter
+ * This function must be used before using createLogger or Logger Class
+ * @param {LoggerConfigs} loggerConfig
+ * @param {string} [name='default']
+ * @param force if `true`, the logger will be initialized
+ *   again even if it already is.
+ */
+export declare const initLogger: (loggerConfig: LoggerConfigs, name?: string, force?: boolean) => void;
+/**
+ * Change the global log level of the application. Useful to change dynamically
+ * the log level of something that is already started.
+ * @param level The log level to set for the application
+ */
+export declare const setGlobalLogLevel: (level: LogLevel) => void;
+/**
+ * Shorthands function that return a new logger instance
+ * Internally, we use the same logger instance but with different context like the name given in parameter
+ * and this context is kept in this new instance returned.
+ * @export
+ * @param {string} name
+ * @returns {ILogger}
+ */
+export declare function createLogger(name: string): ILogger;
+export declare function isInited(): boolean;
+/**
+ * Logger implementation.
+ */
+export declare class Logger implements ILogger {
+    private readonly pino;
+    /**
+     * Creates a logger.
+     *
+     * @param the logger name. This name should be related
+     * to the file the logger is created in. On a production
+     * environment, it's possible that only this name will
+     * be available to locate the source of the log.
+     * Streams will be created after the first call to the logger
+     */
+    constructor(name: string);
+    /**
+     * Logs a DEBUG level message object.
+     *
+     * If the extra "txtMsg" parameter is set, it is
+     * going to be  added to messageObj as a ".msg"
+     * property (if messageObj is an object) or
+     * concatenated to messageObj (if it's not an
+     * object).
+     *
+     * Those types of logs are possible :
+     *
+     * - log.debug("a simple text message");
+     * - log.debug({"name": "an object"});
+     * - log.debug({"name": "an object..."}, "... and an extra text message");
+     * - log.debug(err, "a catched error and an explanation message");
+     */
+    debug(messageObj: any, txtMsg?: string): void;
+    /**
+     * Logs an INFO level message.
+     *
+     * If the extra "txtMsg" parameter is set, it is
+     * going to be  added to messageObj as a ".msg"
+     * property (if messageObj is an object) or
+     * concatenated to messageObj (if it's not an
+     * object).
+     *
+     * Those types of logs are possible :
+     *
+     * - log.info("a simple text message");
+     * - log.info({"name": "an object"});
+     * - log.info({"name": "an object..."}, "... and an extra text message");
+     * - log.info(err, "a catched error and an explanation message");public
+     */
+    info(messageObj: any, txtMsg?: string): void;
+    /**
+     * Logs a WARNING level message.
+     *
+     * If the extra "txtMsg" parameter is set, it is
+     * going to be  added to messageObj as a ".msg"
+     * property (if messageObj is an object) or
+     * concatenated to messageObj (if it's not an
+     * object).
+     *
+     * Those types of logs are possible :
+     *
+     * - log.warning("a simple text message");
+     * - log.warning({"name": "an object"});
+     * - log.warning({"name": "an object..."}, "... and an extra text message");
+     * - log.warning(err, "a catched error and an explanation mespublic sage");
+     */
+    warning(messageObj: any, txtMsg?: string): void;
+    /**
+     * Logs an ERROR level message.
+     *
+     * If the extra "txtMsg" parameter is set, it is
+     * going to be  added to messageObj as a ".msg"
+     * property (if messageObj is an object) or
+     * concatenated to messageObj (if it's not an
+     * object).
+     *
+     * Those types of logs are possible :
+     *
+     * - log.error("a simple text message");
+     * - log.error({"name": "an object"});
+     * - log.error({"name": "an object..."}, "... and an extra text message");
+     * - log.error(err, "a catched error and an explanatpublic ion message");
+     */
+    error(messageObj: any, txtMsg?: string): void;
+    /**
+     * Logs a level specific message.
+     *
+     * If the extra "txtMsg" parameter is set, it is
+     * going to be added to messageObj as a ".msg"
+     * property (if messageObj is an object) or
+     * concatenated to messageObj (if it's not an
+     * object).
+     *
+     * Those types of logs are possible :
+     *
+     * - log(LogLevel.XXXXX, "a simple text message");
+     * - log({"name": "an object"});
+     * - log({"name": "an object..."}, "... and an extra text message");
+     * - log(err, "a catched error and an epublic xplanation message");
+     */
+    log(level: LogLevel, messageObj: any, txtMsg?: string): void;
+    /**
+     * Update the logger based on the parent changes.
+     * Could use something more precise to handle specific event but
+     * people could use it to update the child independently from the parent,
+     * which is not what is intended.
+     */
+    update(): void;
+    /**
+     * Adds the file and line number where the log occures.
+     * This particular code is required since our custom Logger
+     * is a layer over Pino and therefore adds an extra level
+     * to the error stack. Without this code, the file and line number
+     * are not the right ones.
+     *
+     * Based by http://stackoverflow.com/a/38197778/843699
+     */
+    private enhanceLog;
+}