@villedemontreal/logger 6.5.1

package/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) Ville de Montréal and other contributors
+
+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, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+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,164 @@
+# @villedemontreal/logger
+
+Logger pour applications Node.
+
+Ajoute automatiquement aux logs des informations pertinentes telles que les Correlation Ids, le
+nom de l'application, etc.
+
+_Important_ : La configuration `correlationIdProvider` est requise! Votre application
+(ou API) _doit_ passer le provider à utiliser...
+
+
+## Installation
+
+```shell
+    npm install @villedemontreal/logger
+```
+
+## Usage
+
+1.  Nous suggérons de créer, dans votre projet, un fichier "`src/utils/logger.ts`" initialisant la librairie du Logger.
+    Puis créer une function exportée `createLogger` que vous utiliserez dans vos divers composants, pour
+    créer un Logger associé. Le but de cette indirection est de s'assurer que les Loggers créés sont bien configurés.
+
+```typescript
+import { correlationIdService } from '@villemontreal/core-correlation-id-nodejs-lib';
+import {
+  createLogger as createLoggerBase,
+  ILogger,
+  initLogger,
+  LoggerConfigs
+} from '@villemontreal/core-utils-logger-nodejs-lib';
+import { configs } from '../../config/configs';
+
+let loggerLibInitialised = false;
+
+function initLoggerConfigs() {
+  const loggerConfig: LoggerConfigs = new LoggerConfigs(() => correlationIdService.getId());
+  loggerConfig.setLogDirectory(configs.logging.dir);
+  loggerConfig.setLogLevel(configs.logging.level);
+  loggerConfig.setSlowerLogToFileToo(configs.logging.logToFile);
+  loggerConfig.setLogHumanReadableinConsole(configs.logging.humanReadableInConsole);
+  loggerConfig.setAddStackTraceToErrorMessagesInDev(configs.logging.addStackTraceToErrorMessagesInDev);
+  loggerConfig.setLogSource(configs.logging.logSource);
+  loggerConfig.setLogRotateFilesNbr(configs.logging.logRotateFilesNbr);
+  loggerConfig.setLogRotateThresholdMB(configs.logging.logRotateThresholdMB);
+  loggerConfig.setLogRotateMaxTotalSizeMB(configs.logging.logRotateMaxTotalSizeMB);
+
+  initLogger(loggerConfig);
+}
+
+export function createLogger(name: string): ILogger {
+  if (!loggerLibInitialised) {
+    initLoggerConfigs();
+    loggerLibInitialised = true;
+  }
+
+  return createLoggerBase(name);
+}
+```
+
+2.  Si c'est une _librairie_ que vous développer (voir [core-nodejs-lib-template](https://bitbucket.org/villemontreal/core-nodejs-lib-template)), vous aurez aussi ce fichier "`src/utils/logger.ts`"
+    mais il ne fera qu'utiliser le "`Logger Creator`" que vous aurez _vous-mêmes_ reçu en configuration! :
+
+```typescript
+import { LoggerConfigs, ILogger, Logger, LazyLogger, LogLevel } from '@villemontreal/core-utils-logger-nodejs-lib';
+import { configs } from '../config/configs';
+
+export function createLogger(name: string): ILogger {
+  return new LazyLogger(name, (name: string) => {
+    return configs.loggerCreator(name);
+  });
+}
+```
+
+Notez ici l'utilisation de `LazyLogger` et non de `Logger`... Ceci est requis car votre propre librairie
+pourrait ne pas encore avoir été configurée lorsque le premier appel à "_`let logger = createLogger("someName")`_"! Le `LazyLogger` ne va valider les configurations que _lors du premier log_.
+
+## Logger dans un fichier
+
+En appelant "`setSlowerLogToFileToo(true)`", vous faites en sorte que les logs se feront dans un fichier en plus de se faire sur le "stdout" standard (la "console"). Vous pouvez spécifier
+le répertoire où les logs autont lieu en utilisant "`setLogDirectory(...)`", qui a la valeur "`./log`" par défaut).
+
+Notez que de logger dans un fichier ne devrait être fait qu'en _local_. Sur les autres environnements, nous utilisong Graylog qui utilise ce qui est écrit _dans la console_ pour ses logs!
+
+## Changer le niveau de log sans redémarrer l'application
+
+```
+import { LogLevel } from '@villemontreal/core-utils-general-nodejs-lib';
+import { setGlobalLogLevel } from '@villemontreal/core-utils-logger-nodejs-lib';
+
+setGlobalLogLevel(LogLevel.DEBUG);
+```
+
+# Builder le projet
+
+**Note**: Sur Linux/Mac assurz-vous que le fichier `run` est exécutable. Autrement, lancez `chmod +x ./run`.
+
+Pour lancer le build :
+
+- > `run compile` ou `./run compile` (sur Linux/Mac)
+
+Pour lancer les tests :
+
+- > `run test` ou `./run test` (sur Linux/Mac)
+
+# Mode Watch
+
+Lors du développement, il est possible de lancer `run watch` (ou `./run watch` sur Linux/mac) dans un terminal
+externe pour démarrer la compilation incrémentale. Il est alors possible de lancer certaines _launch configuration_
+comme `Debug current tests file - fast` dans VsCode et ainsi déboguer le fichier de tests présentement ouvert sans
+avoir à (re)compiler au préalable (la compilation incrémentale s'en sera chargé).
+
+Notez que, par défaut, des _notifications desktop_ sont activées pour indiquer visuellement si la compilation
+incrémentale est un succès ou si une erreur a été trouvée. Vous pouvez désactiver ces notifications en utilisant
+`run watch --dn` (`d`isable `n`otifications).
+
+# Déboguer le projet
+
+Trois "_launch configurations_" sont founies pour déboguer le projet dans VSCode :
+
+- "`Debug all tests`", la launch configuration par défaut. Lance les tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés.
+
+- "`Debug a test file`". Lance _un_ fichier de tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés. Pour changer le fichier de tests à être exécuté, vous devez modifier la ligne appropriée dans le fichier "`.vscode/launch.json`".
+
+- "`Debug current tests file`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Effectue la compîlation au préalable.
+
+- "`Debug current tests file - fast`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Aucune compilation
+  n'est effectuée au préalable. Cette launch configuration doit être utilisée lorsque la compilation incrémentale roule (voir la section "`Mode Watch`" plus haut)
+
+## Artifact Nexus privé, lors du développement
+
+Lors du développement d'une nouvelle fonctionnalité, sur une branche `feature`, il peut parfois être
+utile de déployer une version temporaire de la librairie dans Nexus. Ceci permet de bien tester
+l'utilisation de la librairie modifiée dans un vrai projet, ou même dans une autre librairie
+elle-même par la suite utilisée dans un vrai projet.
+
+Si le code à tester est terminé et prêt à être mis en commun avec d'autres développeurs, la solution
+de base, comme spécifiée à la section précédante, est de merger sur `develop`: ceci créera
+automatiquement un artifact "`-pre-build`" dans Nexus. Cependant, si le code est encore en développement
+et vous désirez éviter de polluer la branche commune `develop` avec du code temporaire, il y a une
+solution permettant de générer un artifact "`[votre prénom]-pre-build`" temporaire dans Nexus,
+à partir d'une branche `feature` directement:
+
+1. Checkoutez votre branche `feature` dans une branche nommée "`nexus`". Ce nom est
+   important et correspond à une entrée dans le `Jenkinsfile`.
+2. Une fois sur la branche `nexus`, ajoutez un suffixe "`-[votre prénom]`" à
+   la version dans le `package.json`, par exemple: "`5.15.0-roger`".
+   Ceci permet d'éviter tout conflit dans Nexus et exprime clairement qu'il
+   s'agit d'une version temporaire pour votre développement privé.
+3. Commitez et poussez la branche `nexus`.
+4. Une fois le build Jenkins terminé, un artifact pour votre version aura été
+   déployé dans Nexus.
+
+**Notez** que, lors du développement dans une branche `feature`, l'utilisation d'un simple
+`npm link` local peut souvent être suffisant! Mais cette solution a ses limites, par exemple si
+vous désirez tester la librairie modifiée _dans un container Docker_.
+
+# Aide / Contributions
+
+Pour obtenir de l'aide avec cette librairie, vous pouvez poster sur la salle Google Chat [dev-discussions](https://chat.google.com/room/AAAASmiQveI).
+
+Notez que les contributions sous forme de pull requests sont bienvenues.

package/dist/src/config/configs.d.ts

@@ -0,0 +1,118 @@
+import { LogLevel } from '../logger';
+/**
+ * Logger Config
+ */
+export declare class LoggerConfigs {
+    /**
+     * The correlation id provider.
+     * To set this is required.
+     */
+    private correlationIdProvider;
+    /**
+     * Enable logging to a file.
+     * Default to false.
+     */
+    private logToFile;
+    /**
+     * The directory where the potential
+     * log file will be written.
+     * Default to "./log".
+     */
+    private logDir;
+    /**
+     * Log rotation file nb
+     */
+    private logRotateFilesNbr;
+    /**
+     * Log rotation threshhold in MB
+     */
+    private logRotateThresholdMB;
+    /**
+     * Log maximum total size in MB
+     */
+    private logRotateMaxTotalSizeMB;
+    /**
+     * Logging level (info, debug, warning, error)
+     *
+     * Default value : DEBUG in DEV or WARNING otherwise.
+     */
+    private logLevel;
+    /**
+     * Log in human readable form in the console.
+     */
+    private logHumanReadableinConsole;
+    /**
+     * Add the stack trace to the error log in development
+     */
+    private addStackTraceToErrorMessagesInDev;
+    /**
+     * Log the source of the error in the log message
+     */
+    private logSource;
+    /**
+     * The Correlation Id provider is required.
+     */
+    constructor(correlationIdProvider: () => string);
+    /**
+     * The current Correlation Id.
+     */
+    get correlationId(): string;
+    /**
+     * Logging to a file?
+     */
+    isLogToFile(): boolean;
+    /**
+     * Get the directory where the log files should be written
+     */
+    getLogDirectory(): string;
+    /**
+     * Get the current logging level
+     */
+    getLogLevel(): LogLevel;
+    isLogHumanReadableinConsole(): boolean;
+    isAddStackTraceToErrorMessagesInDev(): boolean;
+    isLogSource(): boolean;
+    getLogRotateFilesNbr(): number;
+    getLogRotateThresholdMB(): number;
+    getLogRotateMaxTotalSizeMB(): number;
+    /**
+     * Enable logging to a file in addition to
+     * logging to the standard output.
+     * This should probably be let to FALSE in our
+     * current network where Graylog is used : no
+     * log files are indeed required!
+     */
+    setSlowerLogToFileToo(logToFile: boolean): void;
+    /**
+     * Set the directory where the log files should be written
+     */
+    setLogDirectory(logDir: string): void;
+    /**
+     * Set the logging level
+     */
+    setLogLevel(loglevel: LogLevel): void;
+    /**
+     * Set the logs in the console to be human readable
+     */
+    setLogHumanReadableinConsole(logHumanReadableinConsole: boolean): void;
+    /**
+     * Set the stack trace to be logged in development environment
+     */
+    setAddStackTraceToErrorMessagesInDev(addStackTraceToErrorMessagesInDev: boolean): void;
+    /**
+     * Set if the source of the error should be logged
+     */
+    setLogSource(logSource: boolean): void;
+    /**
+     * Set the number of log files to rotate
+     */
+    setLogRotateFilesNbr(logRotateFilesNb: number): void;
+    /**
+     * Set the log rotation threshhold.
+     */
+    setLogRotateThresholdMB(logRotateThresholdMB: number): void;
+    /**
+     * Set the maximum total size of the logfile
+     */
+    setLogRotateMaxTotalSizeMB(logRotateMaxTotalSizeMB: number): void;
+}

package/dist/src/config/configs.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerConfigs = void 0;
+const general_utils_1 = require("@villedemontreal/general-utils");
+const logger_1 = require("../logger");
+/**
+ * Logger Config
+ */
+class LoggerConfigs {
+    /**
+     * The Correlation Id provider is required.
+     */
+    constructor(correlationIdProvider) {
+        /**
+         * The correlation id provider.
+         * To set this is required.
+         */
+        this.correlationIdProvider = null;
+        /**
+         * Enable logging to a file.
+         * Default to false.
+         */
+        this.logToFile = false;
+        /**
+         * The directory where the potential
+         * log file will be written.
+         * Default to "./log".
+         */
+        this.logDir = './log';
+        /**
+         * Log rotation file nb
+         */
+        this.logRotateFilesNbr = 30;
+        /**
+         * Log rotation threshhold in MB
+         */
+        this.logRotateThresholdMB = 100;
+        /**
+         * Log maximum total size in MB
+         */
+        this.logRotateMaxTotalSizeMB = 1000;
+        /**
+         * Logging level (info, debug, warning, error)
+         *
+         * Default value : DEBUG in DEV or WARNING otherwise.
+         */
+        this.logLevel = process.env.NODE_ENV === general_utils_1.globalConstants.Environments.DEV ? logger_1.LogLevel.DEBUG : logger_1.LogLevel.WARNING;
+        /**
+         * Log in human readable form in the console.
+         */
+        this.logHumanReadableinConsole = false;
+        /**
+         * Add the stack trace to the error log in development
+         */
+        this.addStackTraceToErrorMessagesInDev = process.env.NODE_ENV === general_utils_1.globalConstants.Environments.DEV ? true : false;
+        /**
+         * Log the source of the error in the log message
+         */
+        this.logSource = true;
+        if (!correlationIdProvider) {
+            throw new Error(`The Correlation Id provider is required.`);
+        }
+        this.correlationIdProvider = correlationIdProvider;
+    }
+    /**
+     * The current Correlation Id.
+     */
+    get correlationId() {
+        return this.correlationIdProvider();
+    }
+    /**
+     * Logging to a file?
+     */
+    isLogToFile() {
+        return this.logToFile;
+    }
+    /**
+     * Get the directory where the log files should be written
+     */
+    getLogDirectory() {
+        return this.logDir;
+    }
+    /**
+     * Get the current logging level
+     */
+    getLogLevel() {
+        return this.logLevel;
+    }
+    isLogHumanReadableinConsole() {
+        return this.logHumanReadableinConsole;
+    }
+    isAddStackTraceToErrorMessagesInDev() {
+        return this.addStackTraceToErrorMessagesInDev;
+    }
+    isLogSource() {
+        return this.logSource;
+    }
+    getLogRotateFilesNbr() {
+        return this.logRotateFilesNbr;
+    }
+    getLogRotateThresholdMB() {
+        return this.logRotateThresholdMB;
+    }
+    getLogRotateMaxTotalSizeMB() {
+        return this.logRotateMaxTotalSizeMB;
+    }
+    /**
+     * Enable logging to a file in addition to
+     * logging to the standard output.
+     * This should probably be let to FALSE in our
+     * current network where Graylog is used : no
+     * log files are indeed required!
+     */
+    setSlowerLogToFileToo(logToFile) {
+        this.logToFile = logToFile;
+    }
+    /**
+     * Set the directory where the log files should be written
+     */
+    setLogDirectory(logDir) {
+        this.logDir = logDir;
+    }
+    /**
+     * Set the logging level
+     */
+    setLogLevel(loglevel) {
+        this.logLevel = loglevel;
+    }
+    /**
+     * Set the logs in the console to be human readable
+     */
+    setLogHumanReadableinConsole(logHumanReadableinConsole) {
+        this.logHumanReadableinConsole = logHumanReadableinConsole;
+    }
+    /**
+     * Set the stack trace to be logged in development environment
+     */
+    setAddStackTraceToErrorMessagesInDev(addStackTraceToErrorMessagesInDev) {
+        this.addStackTraceToErrorMessagesInDev = addStackTraceToErrorMessagesInDev;
+    }
+    /**
+     * Set if the source of the error should be logged
+     */
+    setLogSource(logSource) {
+        this.logSource = logSource;
+    }
+    /**
+     * Set the number of log files to rotate
+     */
+    setLogRotateFilesNbr(logRotateFilesNb) {
+        this.logRotateFilesNbr = logRotateFilesNb;
+    }
+    /**
+     * Set the log rotation threshhold.
+     */
+    setLogRotateThresholdMB(logRotateThresholdMB) {
+        this.logRotateThresholdMB = logRotateThresholdMB;
+    }
+    /**
+     * Set the maximum total size of the logfile
+     */
+    setLogRotateMaxTotalSizeMB(logRotateMaxTotalSizeMB) {
+        this.logRotateMaxTotalSizeMB = logRotateMaxTotalSizeMB;
+    }
+}
+exports.LoggerConfigs = LoggerConfigs;
+//# sourceMappingURL=configs.js.map

package/dist/src/config/configs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configs.js","sourceRoot":"","sources":["../../../src/config/configs.ts"],"names":[],"mappings":";;;AAAA,kEAAiE;AACjE,sCAAqC;AAErC;;GAEG;AACH,MAAa,aAAa;IA2DxB;;OAEG;IACH,YAAY,qBAAmC;QA7D/C;;;WAGG;QACK,0BAAqB,GAAiB,IAAI,CAAC;QAEnD;;;WAGG;QACK,cAAS,GAAY,KAAK,CAAC;QAEnC;;;;WAIG;QACK,WAAM,GAAW,OAAO,CAAC;QAEjC;;WAEG;QACK,sBAAiB,GAAW,EAAE,CAAC;QAEvC;;WAEG;QACK,yBAAoB,GAAW,GAAG,CAAC;QAE3C;;WAEG;QACK,4BAAuB,GAAW,IAAI,CAAC;QAE/C;;;;WAIG;QACK,aAAQ,GACd,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,+BAAe,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,iBAAQ,CAAC,OAAO,CAAC;QAEhG;;WAEG;QACK,8BAAyB,GAAY,KAAK,CAAC;QAEnD;;WAEG;QACK,sCAAiC,GACvC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,+BAAe,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAE3E;;WAEG;QACK,cAAS,GAAY,IAAI,CAAC;QAMhC,IAAI,CAAC,qBAAqB,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QAED,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,2BAA2B;QAChC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAEM,mCAAmC;QACxC,OAAO,IAAI,CAAC,iCAAiC,CAAC;IAChD,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAEM,uBAAuB;QAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAEM,0BAA0B;QAC/B,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,SAAkB;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,MAAc;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,QAAkB;QACnC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,4BAA4B,CAAC,yBAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IAC7D,CAAC;IAED;;OAEG;IACI,oCAAoC,CAAC,iCAA0C;QACpF,IAAI,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,SAAkB;QACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,gBAAwB;QAClD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,oBAA4B;QACzD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,0BAA0B,CAAC,uBAA+B;QAC/D,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;IACzD,CAAC;CACF;AA5LD,sCA4LC"}

package/dist/src/config/constants.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Library constants
+ */
+export declare class Constants {
+    /**
+     * The library root. When this library is used
+     * as a dependency in a project, the "libRoot"
+     * will be the path to the dependency folder,
+     * inside the "node_modules".
+     */
+    libRoot: string;
+    /**
+     * The app root. When this library is used
+     * as a dependency in a project, the "appRoot"
+     * will be the path to the root project!
+     */
+    appRoot: string;
+    constructor();
+    /**
+     * Logging constants
+     */
+    get logging(): {
+        /**
+         * The properties that can be added to a log entry.
+         */
+        properties: {
+            /**
+             * The type of log. Those types are specified in
+             * the following "logType" section.
+             */
+            LOG_TYPE: string;
+            /**
+             * The version of the log type.
+             */
+            LOG_TYPE_VERSION: string;
+            /**
+             * "Nom du composant logiciel"
+             */
+            APP_NAME: string;
+            /**
+             * "Version du composant logiciel"
+             */
+            APP_VERSION: string;
+            /**
+             * Correlation id
+             */
+            CORRELATION_ID: string;
+        };
+        /**
+         * The types of logs
+         */
+        logType: {
+            /**
+             * The type for our Ville de Montréal logs.
+             */
+            MONTREAL: string;
+        };
+    };
+}
+export declare let constants: Constants;

package/dist/src/config/constants.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constants = exports.Constants = void 0;
+const app_root_path_1 = require("app-root-path");
+const path = require("path");
+/**
+ * Library constants
+ */
+class Constants {
+    constructor() {
+        // From the "dist/src/config" folder
+        this.libRoot = path.normalize(__dirname + '/../../..');
+        this.appRoot = app_root_path_1.path;
+    }
+    /**
+     * Logging constants
+     */
+    get logging() {
+        return {
+            /**
+             * The properties that can be added to a log entry.
+             */
+            properties: {
+                /**
+                 * The type of log. Those types are specified in
+                 * the following "logType" section.
+                 */
+                LOG_TYPE: 'logType',
+                /**
+                 * The version of the log type.
+                 */
+                LOG_TYPE_VERSION: 'logTypeVersion',
+                /**
+                 * "Nom du composant logiciel"
+                 */
+                APP_NAME: 'app',
+                /**
+                 * "Version du composant logiciel"
+                 */
+                APP_VERSION: 'version',
+                /**
+                 * Correlation id
+                 */
+                CORRELATION_ID: 'cid'
+            },
+            /**
+             * The types of logs
+             */
+            logType: {
+                /**
+                 * The type for our Ville de Montréal logs.
+                 */
+                MONTREAL: 'mtl'
+            }
+        };
+    }
+}
+exports.Constants = Constants;
+exports.constants = new Constants();
+//# sourceMappingURL=constants.js.map

package/dist/src/config/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/config/constants.ts"],"names":[],"mappings":";;;AAAA,iDAAgD;AAChD,6BAA6B;AAE7B;;GAEG;AACH,MAAa,SAAS;IAgBpB;QACE,oCAAoC;QACpC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,oBAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO;YACL;;eAEG;YACH,UAAU,EAAE;gBACV;;;mBAGG;gBACH,QAAQ,EAAE,SAAS;gBAEnB;;mBAEG;gBACH,gBAAgB,EAAE,gBAAgB;gBAElC;;mBAEG;gBACH,QAAQ,EAAE,KAAK;gBAEf;;mBAEG;gBACH,WAAW,EAAE,SAAS;gBAEtB;;mBAEG;gBACH,cAAc,EAAE,KAAK;aACtB;YAED;;eAEG;YACH,OAAO,EAAE;gBACP;;mBAEG;gBACH,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC;CACF;AArED,8BAqEC;AAEU,QAAA,SAAS,GAAc,IAAI,SAAS,EAAE,CAAC"}

package/dist/src/consoleStream.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+export declare class ConsoleStream extends Stream {
+    private prettyStdOut;
+    private isLogHumanReadableinConsole;
+    constructor(isLogHumanReadableinConsole: boolean);
+    write(data: any): void;
+}

package/dist/src/consoleStream.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleStream = void 0;
+const stream_1 = require("stream");
+const prettyStream = require('bunyan-prettystream-circularsafe');
+class ConsoleStream extends stream_1.Stream {
+    constructor(isLogHumanReadableinConsole) {
+        super();
+        this.isLogHumanReadableinConsole = isLogHumanReadableinConsole;
+        this.prettyStdOut = new prettyStream();
+        this.prettyStdOut.pipe(process.stdout);
+    }
+    write(data) {
+        // Using human readable format?
+        if (this.isLogHumanReadableinConsole) {
+            this.prettyStdOut.write(data);
+        }
+        else {
+            let dataClean = data;
+            if (typeof dataClean !== 'string') {
+                dataClean = JSON.stringify(dataClean);
+            }
+            dataClean += '\n';
+            process.stdout.write(dataClean);
+        }
+    }
+}
+exports.ConsoleStream = ConsoleStream;
+//# sourceMappingURL=consoleStream.js.map

package/dist/src/consoleStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleStream.js","sourceRoot":"","sources":["../../src/consoleStream.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAChC,MAAM,YAAY,GAAG,OAAO,CAAC,kCAAkC,CAAC,CAAC;AAEjE,MAAa,aAAc,SAAQ,eAAM;IAIvC,YAAY,2BAAoC;QAC9C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;QAC/D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,IAAS;QACpB,+BAA+B;QAC/B,IAAI,IAAI,CAAC,2BAA2B,EAAE;YACpC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC/B;aAAM;YACL,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBACjC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;aACvC;YACD,SAAS,IAAI,IAAI,CAAC;YAElB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;SACjC;IACH,CAAC;CACF;AAzBD,sCAyBC"}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './config/configs';
+export * from './logger';
+export * from './lazyLogger';

package/dist/src/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config/configs"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./lazyLogger"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC;AACjC,2CAAyB;AACzB,+CAA6B"}