@itwin/core-bentley 4.0.0-dev.48 → 4.0.0-dev.51

package/lib/cjs/Logger.js

@@ -1,257 +1,257 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Logging
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PerfLogger = exports.Logger = exports.LogLevel = void 0;
-const BentleyError_1 = require("./BentleyError");
-const BentleyLoggerCategory_1 = require("./BentleyLoggerCategory");
-/** Use to categorize logging messages by severity.
- * @public
- */
-var LogLevel;
-(function (LogLevel) {
-    /** Tracing and debugging - low level */
-    LogLevel[LogLevel["Trace"] = 0] = "Trace";
-    /** Information - mid level */
-    LogLevel[LogLevel["Info"] = 1] = "Info";
-    /** Warnings - high level */
-    LogLevel[LogLevel["Warning"] = 2] = "Warning";
-    /** Errors - highest level */
-    LogLevel[LogLevel["Error"] = 3] = "Error";
-    /** Higher than any real logging level. This is used to turn a category off. */
-    LogLevel[LogLevel["None"] = 4] = "None";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
-/** Logger allows libraries and apps to report potentially useful information about operations, and it allows apps and users to control
- * how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md).
- * @public
- */
-class Logger {
-    /** Initialize the logger streams. Should be called at application initialization time. */
-    static initialize(logError, logWarning, logInfo, logTrace) {
-        Logger._logError = logError;
-        Logger._logWarning = logWarning;
-        Logger._logInfo = logInfo;
-        Logger._logTrace = logTrace;
-        Logger.turnOffLevelDefault();
-        Logger.turnOffCategories();
-    }
-    /** Initialize the logger to output to the console. */
-    static initializeToConsole() {
-        const logConsole = (level) => (category, message, metaData) => console.log(`${level} | ${category} | ${message} ${Logger.stringifyMetaData(metaData)}`); // eslint-disable-line no-console
-        Logger.initialize(logConsole("Error"), logConsole("Warning"), logConsole("Info"), logConsole("Trace"));
-    }
-    /** merge the supplied metadata with all static metadata into one object */
-    static getMetaData(metaData) {
-        const metaObj = {};
-        for (const meta of Logger.staticMetaData) {
-            const val = BentleyError_1.BentleyError.getMetaData(meta[1]);
-            if (val)
-                Object.assign(metaObj, val);
-        }
-        Object.assign(metaObj, BentleyError_1.BentleyError.getMetaData(metaData)); // do this last so user supplied values take precedence
-        return metaObj;
-    }
-    /** stringify the metadata for a log message by merging the supplied metadata with all static metadata into one object that is then `JSON.stringify`ed. */
-    static stringifyMetaData(metaData) {
-        const metaObj = this.getMetaData(metaData);
-        return Object.keys(metaObj).length > 0 ? JSON.stringify(metaObj) : "";
-    }
-    /** Set the least severe level at which messages should be displayed by default. Call setLevel to override this default setting for specific categories. */
-    static setLevelDefault(minLevel) {
-        this._minLevel = minLevel;
-        this.logLevelChangedFn?.();
-    }
-    /** Set the minimum logging level for the specified category. The minimum level is least severe level at which messages in the
-     * specified category should be displayed.
-     */
-    static setLevel(category, minLevel) {
-        Logger._categoryFilter.set(category, minLevel);
-        this.logLevelChangedFn?.();
-    }
-    /** Interpret a string as the name of a LogLevel */
-    static parseLogLevel(str) {
-        switch (str.toUpperCase()) {
-            case "EXCEPTION": return LogLevel.Error;
-            case "FATAL": return LogLevel.Error;
-            case "ERROR": return LogLevel.Error;
-            case "WARNING": return LogLevel.Warning;
-            case "INFO": return LogLevel.Info;
-            case "TRACE": return LogLevel.Trace;
-            case "DEBUG": return LogLevel.Trace;
-        }
-        return LogLevel.None;
-    }
-    /** Set the log level for multiple categories at once. Also see [[validateProps]] */
-    static configureLevels(cfg) {
-        Logger.validateProps(cfg);
-        if (cfg.defaultLevel !== undefined) {
-            this.setLevelDefault(Logger.parseLogLevel(cfg.defaultLevel));
-        }
-        if (cfg.categoryLevels !== undefined) {
-            for (const cl of cfg.categoryLevels) {
-                this.setLevel(cl.category, Logger.parseLogLevel(cl.logLevel));
-            }
-        }
-    }
-    static isLogLevel(v) {
-        return LogLevel.hasOwnProperty(v);
-    }
-    /** Check that the specified object is a valid LoggerLevelsConfig. This is useful when reading a config from a .json file. */
-    static validateProps(config) {
-        const validProps = ["defaultLevel", "categoryLevels"];
-        for (const prop of Object.keys(config)) {
-            if (!validProps.includes(prop))
-                throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig - unrecognized property: ${prop}`);
-            if (prop === "defaultLevel") {
-                if (!Logger.isLogLevel(config.defaultLevel))
-                    throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.defaultLevel must be a LogLevel. Invalid value: ${JSON.stringify(config.defaultLevel)}`);
-            }
-            else if (prop === "categoryLevels") {
-                const value = config[prop];
-                if (!Array.isArray(value))
-                    throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels must be an array. Invalid value: ${JSON.stringify(value)}`);
-                for (const item of config[prop]) {
-                    if (!item.hasOwnProperty("category") || !item.hasOwnProperty("logLevel"))
-                        throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item must be a LoggerCategoryAndLevel {category: logLevel:}. Invalid value: ${JSON.stringify(item)}`);
-                    if (!Logger.isLogLevel(item.logLevel))
-                        throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item's logLevel property must be a LogLevel. Invalid value: ${JSON.stringify(item.logLevel)}`);
-                }
-            }
-        }
-    }
-    /** Get the minimum logging level for the specified category. */
-    static getLevel(category) {
-        // Prefer the level set for this category specifically
-        const minLevelForThisCategory = Logger._categoryFilter.get(category);
-        if (minLevelForThisCategory !== undefined)
-            return minLevelForThisCategory;
-        // Fall back on the level set for the parent of this category.
-        const parent = category.lastIndexOf(".");
-        if (parent !== -1)
-            return Logger.getLevel(category.slice(0, parent));
-        // Fall back on the default level.
-        return Logger._minLevel;
-    }
-    /** Turns off the least severe level at which messages should be displayed by default.
-     * This turns off logging for all messages for which no category minimum level is defined.
-     */
-    static turnOffLevelDefault() {
-        Logger._minLevel = undefined;
-    }
-    /** Turns off all category level filters previously defined with [[Logger.setLevel]].
-     */
-    static turnOffCategories() {
-        Logger._categoryFilter.clear();
-    }
-    /** Check if messages in the specified category should be displayed at this level of severity. */
-    static isEnabled(category, level) {
-        const minLevel = Logger.getLevel(category);
-        return (minLevel !== undefined) && (level >= minLevel);
-    }
-    /** Log the specified message to the **error** stream.
-     * @param category  The category of the message.
-     * @param message  The message.
-     * @param metaData  Optional data for the message
-     */
-    static logError(category, message, metaData) {
-        if (Logger._logError && Logger.isEnabled(category, LogLevel.Error))
-            Logger._logError(category, message, metaData);
-    }
-    static getExceptionMessage(err) {
-        const stack = Logger.logExceptionCallstacks ? `\n${BentleyError_1.BentleyError.getErrorStack(err)}` : "";
-        return BentleyError_1.BentleyError.getErrorMessage(err) + stack;
-    }
-    /** Log the specified exception. The special "ExceptionType" property will be added as metadata,
-     * in addition to any other metadata that may be supplied by the caller, unless the
-     * metadata supplied by the caller already includes this property.
-     * @param category  The category of the message.
-     * @param err  The exception object.
-     * @param log The logger output function to use - defaults to Logger.logError
-     * @param metaData  Optional data for the message
-     */
-    static logException(category, err, log = Logger.logError) {
-        log(category, Logger.getExceptionMessage(err), () => {
-            return { ...BentleyError_1.BentleyError.getErrorMetadata(err), exceptionType: err.constructor.name };
-        });
-    }
-    /** Log the specified message to the **warning** stream.
-     * @param category  The category of the message.
-     * @param message  The message.
-     * @param metaData  Optional data for the message
-     */
-    static logWarning(category, message, metaData) {
-        if (Logger._logWarning && Logger.isEnabled(category, LogLevel.Warning))
-            Logger._logWarning(category, message, metaData);
-    }
-    /** Log the specified message to the **info** stream.
-     * @param category  The category of the message.
-     * @param message  The message.
-     * @param metaData  Optional data for the message
-     */
-    static logInfo(category, message, metaData) {
-        if (Logger._logInfo && Logger.isEnabled(category, LogLevel.Info))
-            Logger._logInfo(category, message, metaData);
-    }
-    /** Log the specified message to the **trace** stream.
-     * @param category  The category of the message.
-     * @param message  The message.
-     * @param metaData  Optional data for the message
-     */
-    static logTrace(category, message, metaData) {
-        if (Logger._logTrace && Logger.isEnabled(category, LogLevel.Trace))
-            Logger._logTrace(category, message, metaData);
-    }
-}
-exports.Logger = Logger;
-Logger._categoryFilter = new Map(); // do not change the name of this member, it is referenced directly from node addon
-Logger._minLevel = undefined; // do not change the name of this member, it is referenced directly from node addon
-/** Should the call stack be included when an exception is logged?  */
-Logger.logExceptionCallstacks = false;
-/** All static metadata is combined with per-call metadata and stringified in every log message.
- * Static metadata can either be an object or a function that returns an object.
- * Use a key to identify entries in the map so the can be removed individually.
- * @internal */
-Logger.staticMetaData = new Map();
-/** Simple performance diagnostics utility.
- * It measures the time from construction to disposal. On disposal it logs the routine name along with
- * the duration in milliseconds.
- * It also logs the routine name at construction time so that nested calls can be disambiguated.
- *
- * The timings are logged using the log category **Performance** and log severity [[LogLevel.INFO]].
- * Enable those, if you want to capture timings.
- * @public
- */
-class PerfLogger {
-    constructor(operation, metaData) {
-        this._operation = operation;
-        this._metaData = metaData;
-        if (!Logger.isEnabled(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, PerfLogger._severity)) {
-            this._startTimeStamp = 0;
-            return;
-        }
-        Logger.logInfo(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, `${this._operation},START`, this._metaData);
-        this._startTimeStamp = new Date().getTime(); // take timestamp
-    }
-    logMessage() {
-        const endTimeStamp = new Date().getTime();
-        if (!Logger.isEnabled(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, PerfLogger._severity))
-            return;
-        Logger.logInfo(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, `${this._operation},END`, () => {
-            const mdata = this._metaData ? BentleyError_1.BentleyError.getMetaData(this._metaData) : {};
-            return {
-                ...mdata, TimeElapsed: endTimeStamp - this._startTimeStamp, // eslint-disable-line @typescript-eslint/naming-convention
-            };
-        });
-    }
-    dispose() {
-        this.logMessage();
-    }
-}
-exports.PerfLogger = PerfLogger;
-PerfLogger._severity = LogLevel.Info;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Logging
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PerfLogger = exports.Logger = exports.LogLevel = void 0;
+const BentleyError_1 = require("./BentleyError");
+const BentleyLoggerCategory_1 = require("./BentleyLoggerCategory");
+/** Use to categorize logging messages by severity.
+ * @public
+ */
+var LogLevel;
+(function (LogLevel) {
+    /** Tracing and debugging - low level */
+    LogLevel[LogLevel["Trace"] = 0] = "Trace";
+    /** Information - mid level */
+    LogLevel[LogLevel["Info"] = 1] = "Info";
+    /** Warnings - high level */
+    LogLevel[LogLevel["Warning"] = 2] = "Warning";
+    /** Errors - highest level */
+    LogLevel[LogLevel["Error"] = 3] = "Error";
+    /** Higher than any real logging level. This is used to turn a category off. */
+    LogLevel[LogLevel["None"] = 4] = "None";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+/** Logger allows libraries and apps to report potentially useful information about operations, and it allows apps and users to control
+ * how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md).
+ * @public
+ */
+class Logger {
+    /** Initialize the logger streams. Should be called at application initialization time. */
+    static initialize(logError, logWarning, logInfo, logTrace) {
+        Logger._logError = logError;
+        Logger._logWarning = logWarning;
+        Logger._logInfo = logInfo;
+        Logger._logTrace = logTrace;
+        Logger.turnOffLevelDefault();
+        Logger.turnOffCategories();
+    }
+    /** Initialize the logger to output to the console. */
+    static initializeToConsole() {
+        const logConsole = (level) => (category, message, metaData) => console.log(`${level} | ${category} | ${message} ${Logger.stringifyMetaData(metaData)}`); // eslint-disable-line no-console
+        Logger.initialize(logConsole("Error"), logConsole("Warning"), logConsole("Info"), logConsole("Trace"));
+    }
+    /** merge the supplied metadata with all static metadata into one object */
+    static getMetaData(metaData) {
+        const metaObj = {};
+        for (const meta of Logger.staticMetaData) {
+            const val = BentleyError_1.BentleyError.getMetaData(meta[1]);
+            if (val)
+                Object.assign(metaObj, val);
+        }
+        Object.assign(metaObj, BentleyError_1.BentleyError.getMetaData(metaData)); // do this last so user supplied values take precedence
+        return metaObj;
+    }
+    /** stringify the metadata for a log message by merging the supplied metadata with all static metadata into one object that is then `JSON.stringify`ed. */
+    static stringifyMetaData(metaData) {
+        const metaObj = this.getMetaData(metaData);
+        return Object.keys(metaObj).length > 0 ? JSON.stringify(metaObj) : "";
+    }
+    /** Set the least severe level at which messages should be displayed by default. Call setLevel to override this default setting for specific categories. */
+    static setLevelDefault(minLevel) {
+        this._minLevel = minLevel;
+        this.logLevelChangedFn?.();
+    }
+    /** Set the minimum logging level for the specified category. The minimum level is least severe level at which messages in the
+     * specified category should be displayed.
+     */
+    static setLevel(category, minLevel) {
+        Logger._categoryFilter.set(category, minLevel);
+        this.logLevelChangedFn?.();
+    }
+    /** Interpret a string as the name of a LogLevel */
+    static parseLogLevel(str) {
+        switch (str.toUpperCase()) {
+            case "EXCEPTION": return LogLevel.Error;
+            case "FATAL": return LogLevel.Error;
+            case "ERROR": return LogLevel.Error;
+            case "WARNING": return LogLevel.Warning;
+            case "INFO": return LogLevel.Info;
+            case "TRACE": return LogLevel.Trace;
+            case "DEBUG": return LogLevel.Trace;
+        }
+        return LogLevel.None;
+    }
+    /** Set the log level for multiple categories at once. Also see [[validateProps]] */
+    static configureLevels(cfg) {
+        Logger.validateProps(cfg);
+        if (cfg.defaultLevel !== undefined) {
+            this.setLevelDefault(Logger.parseLogLevel(cfg.defaultLevel));
+        }
+        if (cfg.categoryLevels !== undefined) {
+            for (const cl of cfg.categoryLevels) {
+                this.setLevel(cl.category, Logger.parseLogLevel(cl.logLevel));
+            }
+        }
+    }
+    static isLogLevel(v) {
+        return LogLevel.hasOwnProperty(v);
+    }
+    /** Check that the specified object is a valid LoggerLevelsConfig. This is useful when reading a config from a .json file. */
+    static validateProps(config) {
+        const validProps = ["defaultLevel", "categoryLevels"];
+        for (const prop of Object.keys(config)) {
+            if (!validProps.includes(prop))
+                throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig - unrecognized property: ${prop}`);
+            if (prop === "defaultLevel") {
+                if (!Logger.isLogLevel(config.defaultLevel))
+                    throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.defaultLevel must be a LogLevel. Invalid value: ${JSON.stringify(config.defaultLevel)}`);
+            }
+            else if (prop === "categoryLevels") {
+                const value = config[prop];
+                if (!Array.isArray(value))
+                    throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels must be an array. Invalid value: ${JSON.stringify(value)}`);
+                for (const item of config[prop]) {
+                    if (!item.hasOwnProperty("category") || !item.hasOwnProperty("logLevel"))
+                        throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item must be a LoggerCategoryAndLevel {category: logLevel:}. Invalid value: ${JSON.stringify(item)}`);
+                    if (!Logger.isLogLevel(item.logLevel))
+                        throw new BentleyError_1.BentleyError(BentleyError_1.IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item's logLevel property must be a LogLevel. Invalid value: ${JSON.stringify(item.logLevel)}`);
+                }
+            }
+        }
+    }
+    /** Get the minimum logging level for the specified category. */
+    static getLevel(category) {
+        // Prefer the level set for this category specifically
+        const minLevelForThisCategory = Logger._categoryFilter.get(category);
+        if (minLevelForThisCategory !== undefined)
+            return minLevelForThisCategory;
+        // Fall back on the level set for the parent of this category.
+        const parent = category.lastIndexOf(".");
+        if (parent !== -1)
+            return Logger.getLevel(category.slice(0, parent));
+        // Fall back on the default level.
+        return Logger._minLevel;
+    }
+    /** Turns off the least severe level at which messages should be displayed by default.
+     * This turns off logging for all messages for which no category minimum level is defined.
+     */
+    static turnOffLevelDefault() {
+        Logger._minLevel = undefined;
+    }
+    /** Turns off all category level filters previously defined with [[Logger.setLevel]].
+     */
+    static turnOffCategories() {
+        Logger._categoryFilter.clear();
+    }
+    /** Check if messages in the specified category should be displayed at this level of severity. */
+    static isEnabled(category, level) {
+        const minLevel = Logger.getLevel(category);
+        return (minLevel !== undefined) && (level >= minLevel);
+    }
+    /** Log the specified message to the **error** stream.
+     * @param category  The category of the message.
+     * @param message  The message.
+     * @param metaData  Optional data for the message
+     */
+    static logError(category, message, metaData) {
+        if (Logger._logError && Logger.isEnabled(category, LogLevel.Error))
+            Logger._logError(category, message, metaData);
+    }
+    static getExceptionMessage(err) {
+        const stack = Logger.logExceptionCallstacks ? `\n${BentleyError_1.BentleyError.getErrorStack(err)}` : "";
+        return BentleyError_1.BentleyError.getErrorMessage(err) + stack;
+    }
+    /** Log the specified exception. The special "ExceptionType" property will be added as metadata,
+     * in addition to any other metadata that may be supplied by the caller, unless the
+     * metadata supplied by the caller already includes this property.
+     * @param category  The category of the message.
+     * @param err  The exception object.
+     * @param log The logger output function to use - defaults to Logger.logError
+     * @param metaData  Optional data for the message
+     */
+    static logException(category, err, log = Logger.logError) {
+        log(category, Logger.getExceptionMessage(err), () => {
+            return { ...BentleyError_1.BentleyError.getErrorMetadata(err), exceptionType: err.constructor.name };
+        });
+    }
+    /** Log the specified message to the **warning** stream.
+     * @param category  The category of the message.
+     * @param message  The message.
+     * @param metaData  Optional data for the message
+     */
+    static logWarning(category, message, metaData) {
+        if (Logger._logWarning && Logger.isEnabled(category, LogLevel.Warning))
+            Logger._logWarning(category, message, metaData);
+    }
+    /** Log the specified message to the **info** stream.
+     * @param category  The category of the message.
+     * @param message  The message.
+     * @param metaData  Optional data for the message
+     */
+    static logInfo(category, message, metaData) {
+        if (Logger._logInfo && Logger.isEnabled(category, LogLevel.Info))
+            Logger._logInfo(category, message, metaData);
+    }
+    /** Log the specified message to the **trace** stream.
+     * @param category  The category of the message.
+     * @param message  The message.
+     * @param metaData  Optional data for the message
+     */
+    static logTrace(category, message, metaData) {
+        if (Logger._logTrace && Logger.isEnabled(category, LogLevel.Trace))
+            Logger._logTrace(category, message, metaData);
+    }
+}
+exports.Logger = Logger;
+Logger._categoryFilter = new Map(); // do not change the name of this member, it is referenced directly from node addon
+Logger._minLevel = undefined; // do not change the name of this member, it is referenced directly from node addon
+/** Should the call stack be included when an exception is logged?  */
+Logger.logExceptionCallstacks = false;
+/** All static metadata is combined with per-call metadata and stringified in every log message.
+ * Static metadata can either be an object or a function that returns an object.
+ * Use a key to identify entries in the map so the can be removed individually.
+ * @internal */
+Logger.staticMetaData = new Map();
+/** Simple performance diagnostics utility.
+ * It measures the time from construction to disposal. On disposal it logs the routine name along with
+ * the duration in milliseconds.
+ * It also logs the routine name at construction time so that nested calls can be disambiguated.
+ *
+ * The timings are logged using the log category **Performance** and log severity [[LogLevel.INFO]].
+ * Enable those, if you want to capture timings.
+ * @public
+ */
+class PerfLogger {
+    constructor(operation, metaData) {
+        this._operation = operation;
+        this._metaData = metaData;
+        if (!Logger.isEnabled(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, PerfLogger._severity)) {
+            this._startTimeStamp = 0;
+            return;
+        }
+        Logger.logInfo(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, `${this._operation},START`, this._metaData);
+        this._startTimeStamp = new Date().getTime(); // take timestamp
+    }
+    logMessage() {
+        const endTimeStamp = new Date().getTime();
+        if (!Logger.isEnabled(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, PerfLogger._severity))
+            return;
+        Logger.logInfo(BentleyLoggerCategory_1.BentleyLoggerCategory.Performance, `${this._operation},END`, () => {
+            const mdata = this._metaData ? BentleyError_1.BentleyError.getMetaData(this._metaData) : {};
+            return {
+                ...mdata, TimeElapsed: endTimeStamp - this._startTimeStamp, // eslint-disable-line @typescript-eslint/naming-convention
+            };
+        });
+    }
+    dispose() {
+        this.logMessage();
+    }
+}
+exports.PerfLogger = PerfLogger;
+PerfLogger._severity = LogLevel.Info;
 //# sourceMappingURL=Logger.js.map

package/lib/cjs/Logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iDAA6E;AAC7E,mEAAgE;AAQhE;;GAEG;AACH,IAAY,QAWX;AAXD,WAAY,QAAQ;IAClB,wCAAwC;IACxC,yCAAK,CAAA;IACL,8BAA8B;IAC9B,uCAAI,CAAA;IACJ,4BAA4B;IAC5B,6CAAO,CAAA;IACP,6BAA6B;IAC7B,yCAAK,CAAA;IACL,+EAA+E;IAC/E,uCAAI,CAAA;AACN,CAAC,EAXW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAWnB;AAkBD;;;GAGG;AACH,MAAa,MAAM;IAmBjB,0FAA0F;IACnF,MAAM,CAAC,UAAU,CAAC,QAAsB,EAAE,UAAwB,EAAE,OAAqB,EAAE,QAAsB;QACtH,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC5B,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC5B,MAAM,CAAC,mBAAmB,EAAE,CAAC;QAC7B,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,mBAAmB;QAC/B,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,QAAgB,EAAE,OAAe,EAAE,QAAyB,EAAE,EAAE,CACrG,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,QAAQ,MAAM,OAAO,IAAI,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,iCAAiC;QAE7H,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,2EAA2E;IACpE,MAAM,CAAC,WAAW,CAAC,QAA0B;QAClD,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,cAAc,EAAE;YACxC,MAAM,GAAG,GAAG,2BAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,GAAG;gBACL,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,2BAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,uDAAuD;QACnH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,0JAA0J;IACnJ,MAAM,CAAC,iBAAiB,CAAC,QAA0B;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,2JAA2J;IACpJ,MAAM,CAAC,eAAe,CAAC,QAAkB;QAC9C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,QAAkB;QACzD,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;IAC7B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,aAAa,CAAC,GAAW;QACrC,QAAQ,GAAG,CAAC,WAAW,EAAE,EAAE;YACzB,KAAK,WAAW,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACxC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,SAAS,CAAC,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC;YACxC,KAAK,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC,IAAI,CAAC;YAClC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;SACrC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,eAAe,CAAC,GAAuB;QACnD,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,GAAG,CAAC,YAAY,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;SAC9D;QACD,IAAI,GAAG,CAAC,cAAc,KAAK,SAAS,EAAE;YACpC,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,cAAc,EAAE;gBACnC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC/D;SACF;IACH,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,CAAS;QACjC,OAAO,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,6HAA6H;IACtH,MAAM,CAAC,aAAa,CAAC,MAAW;QACrC,MAAM,UAAU,GAAG,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACtC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC5B,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,IAAI,EAAE,CAAC,CAAC;YACrG,IAAI,IAAI,KAAK,cAAc,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC;oBACzC,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,sEAAsE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;aAC5J;iBAAM,IAAI,IAAI,KAAK,gBAAgB,EAAE;gBACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;oBACvB,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,sEAAsE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC7I,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC/B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;wBACtE,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,wHAAwH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAC9L,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;wBACnC,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,wGAAwG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;iBACxL;aACF;SACF;IACH,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,QAAgB;QACrC,sDAAsD;QACtD,MAAM,uBAAuB,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrE,IAAI,uBAAuB,KAAK,SAAS;YACvC,OAAO,uBAAuB,CAAC;QAEjC,8DAA8D;QAC9D,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,MAAM,KAAK,CAAC,CAAC;YACf,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAEpD,kCAAkC;QAClC,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,mBAAmB;QAC/B,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED;OACG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAED,iGAAiG;IAC1F,MAAM,CAAC,SAAS,CAAC,QAAgB,EAAE,KAAe;QACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QAClF,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,GAAY;QAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAK,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1F,OAAO,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,YAAY,CAAC,QAAgB,EAAE,GAAQ,EAAE,MAAmB,MAAM,CAAC,QAAQ;QACvF,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE;YAClD,OAAO,EAAE,GAAG,2BAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QACpF,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC;YACpE,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QACjF,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC;YAC9D,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QAClF,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;;AAvNH,wBAwNC;AAjNgB,sBAAe,GAAG,IAAI,GAAG,EAAoB,CAAC,CAAC,mFAAmF;AAClI,gBAAS,GAAyB,SAAS,CAAC,CAAC,mFAAmF;AAE/I,sEAAsE;AACxD,6BAAsB,GAAG,KAAK,CAAC;AAE7C;;;eAGe;AACD,qBAAc,GAAG,IAAI,GAAG,EAA2B,CAAC;AAyMpE;;;;;;;;GAQG;AACH,MAAa,UAAU;IAOrB,YAAmB,SAAiB,EAAE,QAA0B;QAC9D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,6CAAqB,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE;YAC9E,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;YACzB,OAAO;SACR;QAED,MAAM,CAAC,OAAO,CAAC,6CAAqB,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9F,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,iBAAiB;IAChE,CAAC;IAEO,UAAU;QAChB,MAAM,YAAY,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,6CAAqB,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC;YAC5E,OAAO;QAET,MAAM,CAAC,OAAO,CAAC,6CAAqB,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,MAAM,EAAE,GAAG,EAAE;YAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,2BAAY,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7E,OAAO;gBACL,GAAG,KAAK,EAAE,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,2DAA2D;aACxH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;;AAnCH,gCAoCC;AAnCgB,oBAAS,GAAa,QAAQ,CAAC,IAAI,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Logging\n */\n\nimport { BentleyError, IModelStatus, LoggingMetaData } from \"./BentleyError\";\nimport { BentleyLoggerCategory } from \"./BentleyLoggerCategory\";\nimport { IDisposable } from \"./Disposable\";\n\n/** Defines the *signature* for a log function.\n * @public\n */\nexport type LogFunction = (category: string, message: string, metaData: LoggingMetaData) => void;\n\n/** Use to categorize logging messages by severity.\n * @public\n */\nexport enum LogLevel {\n  /** Tracing and debugging - low level */\n  Trace,\n  /** Information - mid level */\n  Info,\n  /** Warnings - high level */\n  Warning,\n  /** Errors - highest level */\n  Error,\n  /** Higher than any real logging level. This is used to turn a category off. */\n  None,\n}\n\n/** Identifies a logging category and the LogLevel that should be used for it. The LogLevel is specified by its string name.\n * @public\n */\nexport interface LoggerCategoryAndLevel {\n  category: string;\n  logLevel: string;\n}\n\n/** Specifies logging levels, including the default logging level and a set of categories and levels for them.\n * @public\n */\nexport interface LoggerLevelsConfig {\n  defaultLevel?: string;\n  categoryLevels?: LoggerCategoryAndLevel[];\n}\n\n/** Logger allows libraries and apps to report potentially useful information about operations, and it allows apps and users to control\n * how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md).\n * @public\n */\nexport class Logger {\n  protected static _logError: LogFunction | undefined;\n  protected static _logWarning: LogFunction | undefined;\n  protected static _logInfo: LogFunction | undefined;\n  protected static _logTrace: LogFunction | undefined;\n  /** @internal */\n  public static logLevelChangedFn?: VoidFunction;\n  private static _categoryFilter = new Map<string, LogLevel>(); // do not change the name of this member, it is referenced directly from node addon\n  private static _minLevel: LogLevel | undefined = undefined; // do not change the name of this member, it is referenced directly from node addon\n\n  /** Should the call stack be included when an exception is logged?  */\n  public static logExceptionCallstacks = false;\n\n  /** All static metadata is combined with per-call metadata and stringified in every log message.\n   * Static metadata can either be an object or a function that returns an object.\n   * Use a key to identify entries in the map so the can be removed individually.\n   * @internal */\n  public static staticMetaData = new Map<string, LoggingMetaData>();\n\n  /** Initialize the logger streams. Should be called at application initialization time. */\n  public static initialize(logError?: LogFunction, logWarning?: LogFunction, logInfo?: LogFunction, logTrace?: LogFunction): void {\n    Logger._logError = logError;\n    Logger._logWarning = logWarning;\n    Logger._logInfo = logInfo;\n    Logger._logTrace = logTrace;\n    Logger.turnOffLevelDefault();\n    Logger.turnOffCategories();\n  }\n\n  /** Initialize the logger to output to the console. */\n  public static initializeToConsole(): void {\n    const logConsole = (level: string) => (category: string, message: string, metaData: LoggingMetaData) =>\n      console.log(`${level} | ${category} | ${message} ${Logger.stringifyMetaData(metaData)}`); // eslint-disable-line no-console\n\n    Logger.initialize(logConsole(\"Error\"), logConsole(\"Warning\"), logConsole(\"Info\"), logConsole(\"Trace\"));\n  }\n\n  /** merge the supplied metadata with all static metadata into one object */\n  public static getMetaData(metaData?: LoggingMetaData): object {\n    const metaObj = {};\n    for (const meta of Logger.staticMetaData) {\n      const val = BentleyError.getMetaData(meta[1]);\n      if (val)\n        Object.assign(metaObj, val);\n    }\n    Object.assign(metaObj, BentleyError.getMetaData(metaData)); // do this last so user supplied values take precedence\n    return metaObj;\n  }\n\n  /** stringify the metadata for a log message by merging the supplied metadata with all static metadata into one object that is then `JSON.stringify`ed. */\n  public static stringifyMetaData(metaData?: LoggingMetaData): string {\n    const metaObj = this.getMetaData(metaData);\n    return Object.keys(metaObj).length > 0 ? JSON.stringify(metaObj) : \"\";\n  }\n\n  /** Set the least severe level at which messages should be displayed by default. Call setLevel to override this default setting for specific categories. */\n  public static setLevelDefault(minLevel: LogLevel): void {\n    this._minLevel = minLevel;\n    this.logLevelChangedFn?.();\n  }\n\n  /** Set the minimum logging level for the specified category. The minimum level is least severe level at which messages in the\n   * specified category should be displayed.\n   */\n  public static setLevel(category: string, minLevel: LogLevel) {\n    Logger._categoryFilter.set(category, minLevel);\n    this.logLevelChangedFn?.();\n  }\n\n  /** Interpret a string as the name of a LogLevel */\n  public static parseLogLevel(str: string): LogLevel {\n    switch (str.toUpperCase()) {\n      case \"EXCEPTION\": return LogLevel.Error;\n      case \"FATAL\": return LogLevel.Error;\n      case \"ERROR\": return LogLevel.Error;\n      case \"WARNING\": return LogLevel.Warning;\n      case \"INFO\": return LogLevel.Info;\n      case \"TRACE\": return LogLevel.Trace;\n      case \"DEBUG\": return LogLevel.Trace;\n    }\n    return LogLevel.None;\n  }\n\n  /** Set the log level for multiple categories at once. Also see [[validateProps]] */\n  public static configureLevels(cfg: LoggerLevelsConfig) {\n    Logger.validateProps(cfg);\n    if (cfg.defaultLevel !== undefined) {\n      this.setLevelDefault(Logger.parseLogLevel(cfg.defaultLevel));\n    }\n    if (cfg.categoryLevels !== undefined) {\n      for (const cl of cfg.categoryLevels) {\n        this.setLevel(cl.category, Logger.parseLogLevel(cl.logLevel));\n      }\n    }\n  }\n\n  private static isLogLevel(v: string) {\n    return LogLevel.hasOwnProperty(v);\n  }\n\n  /** Check that the specified object is a valid LoggerLevelsConfig. This is useful when reading a config from a .json file. */\n  public static validateProps(config: any) {\n    const validProps = [\"defaultLevel\", \"categoryLevels\"];\n    for (const prop of Object.keys(config)) {\n      if (!validProps.includes(prop))\n        throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig - unrecognized property: ${prop}`);\n      if (prop === \"defaultLevel\") {\n        if (!Logger.isLogLevel(config.defaultLevel))\n          throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.defaultLevel must be a LogLevel. Invalid value: ${JSON.stringify(config.defaultLevel)}`);\n      } else if (prop === \"categoryLevels\") {\n        const value = config[prop];\n        if (!Array.isArray(value))\n          throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels must be an array. Invalid value: ${JSON.stringify(value)}`);\n        for (const item of config[prop]) {\n          if (!item.hasOwnProperty(\"category\") || !item.hasOwnProperty(\"logLevel\"))\n            throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item must be a LoggerCategoryAndLevel {category: logLevel:}. Invalid value: ${JSON.stringify(item)}`);\n          if (!Logger.isLogLevel(item.logLevel))\n            throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item's logLevel property must be a LogLevel. Invalid value: ${JSON.stringify(item.logLevel)}`);\n        }\n      }\n    }\n  }\n\n  /** Get the minimum logging level for the specified category. */\n  public static getLevel(category: string): LogLevel | undefined {\n    // Prefer the level set for this category specifically\n    const minLevelForThisCategory = Logger._categoryFilter.get(category);\n    if (minLevelForThisCategory !== undefined)\n      return minLevelForThisCategory;\n\n    // Fall back on the level set for the parent of this category.\n    const parent = category.lastIndexOf(\".\");\n    if (parent !== -1)\n      return Logger.getLevel(category.slice(0, parent));\n\n    // Fall back on the default level.\n    return Logger._minLevel;\n  }\n\n  /** Turns off the least severe level at which messages should be displayed by default.\n   * This turns off logging for all messages for which no category minimum level is defined.\n   */\n  public static turnOffLevelDefault(): void {\n    Logger._minLevel = undefined;\n  }\n\n  /** Turns off all category level filters previously defined with [[Logger.setLevel]].\n   */\n  public static turnOffCategories(): void {\n    Logger._categoryFilter.clear();\n  }\n\n  /** Check if messages in the specified category should be displayed at this level of severity. */\n  public static isEnabled(category: string, level: LogLevel): boolean {\n    const minLevel = Logger.getLevel(category);\n    return (minLevel !== undefined) && (level >= minLevel);\n  }\n\n  /** Log the specified message to the **error** stream.\n   * @param category  The category of the message.\n   * @param message  The message.\n   * @param metaData  Optional data for the message\n   */\n  public static logError(category: string, message: string, metaData?: LoggingMetaData): void {\n    if (Logger._logError && Logger.isEnabled(category, LogLevel.Error))\n      Logger._logError(category, message, metaData);\n  }\n\n  private static getExceptionMessage(err: unknown): string {\n    const stack = Logger.logExceptionCallstacks ? `\\n${BentleyError.getErrorStack(err)}` : \"\";\n    return BentleyError.getErrorMessage(err) + stack;\n  }\n\n  /** Log the specified exception. The special \"ExceptionType\" property will be added as metadata,\n   * in addition to any other metadata that may be supplied by the caller, unless the\n   * metadata supplied by the caller already includes this property.\n   * @param category  The category of the message.\n   * @param err  The exception object.\n   * @param log The logger output function to use - defaults to Logger.logError\n   * @param metaData  Optional data for the message\n   */\n  public static logException(category: string, err: any, log: LogFunction = Logger.logError): void {\n    log(category, Logger.getExceptionMessage(err), () => {\n      return { ...BentleyError.getErrorMetadata(err), exceptionType: err.constructor.name };\n    });\n  }\n\n  /** Log the specified message to the **warning** stream.\n   * @param category  The category of the message.\n   * @param message  The message.\n   * @param metaData  Optional data for the message\n   */\n  public static logWarning(category: string, message: string, metaData?: LoggingMetaData): void {\n    if (Logger._logWarning && Logger.isEnabled(category, LogLevel.Warning))\n      Logger._logWarning(category, message, metaData);\n  }\n\n  /** Log the specified message to the **info** stream.\n   * @param category  The category of the message.\n   * @param message  The message.\n   * @param metaData  Optional data for the message\n   */\n  public static logInfo(category: string, message: string, metaData?: LoggingMetaData): void {\n    if (Logger._logInfo && Logger.isEnabled(category, LogLevel.Info))\n      Logger._logInfo(category, message, metaData);\n  }\n\n  /** Log the specified message to the **trace** stream.\n   * @param category  The category of the message.\n   * @param message  The message.\n   * @param metaData  Optional data for the message\n   */\n  public static logTrace(category: string, message: string, metaData?: LoggingMetaData): void {\n    if (Logger._logTrace && Logger.isEnabled(category, LogLevel.Trace))\n      Logger._logTrace(category, message, metaData);\n  }\n}\n\n/** Simple performance diagnostics utility.\n * It measures the time from construction to disposal. On disposal it logs the routine name along with\n * the duration in milliseconds.\n * It also logs the routine name at construction time so that nested calls can be disambiguated.\n *\n * The timings are logged using the log category **Performance** and log severity [[LogLevel.INFO]].\n * Enable those, if you want to capture timings.\n * @public\n */\nexport class PerfLogger implements IDisposable {\n  private static _severity: LogLevel = LogLevel.Info;\n\n  private _operation: string;\n  private _metaData?: LoggingMetaData;\n  private _startTimeStamp: number;\n\n  public constructor(operation: string, metaData?: LoggingMetaData) {\n    this._operation = operation;\n    this._metaData = metaData;\n\n    if (!Logger.isEnabled(BentleyLoggerCategory.Performance, PerfLogger._severity)) {\n      this._startTimeStamp = 0;\n      return;\n    }\n\n    Logger.logInfo(BentleyLoggerCategory.Performance, `${this._operation},START`, this._metaData);\n    this._startTimeStamp = new Date().getTime(); // take timestamp\n  }\n\n  private logMessage(): void {\n    const endTimeStamp: number = new Date().getTime();\n    if (!Logger.isEnabled(BentleyLoggerCategory.Performance, PerfLogger._severity))\n      return;\n\n    Logger.logInfo(BentleyLoggerCategory.Performance, `${this._operation},END`, () => {\n      const mdata = this._metaData ? BentleyError.getMetaData(this._metaData) : {};\n      return {\n        ...mdata, TimeElapsed: endTimeStamp - this._startTimeStamp, // eslint-disable-line @typescript-eslint/naming-convention\n      };\n    });\n  }\n\n  public dispose(): void {\n    this.logMessage();\n  }\n}\n\n"]}
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iDAA6E;AAC7E,mEAAgE;AAQhE;;GAEG;AACH,IAAY,QAWX;AAXD,WAAY,QAAQ;IAClB,wCAAwC;IACxC,yCAAK,CAAA;IACL,8BAA8B;IAC9B,uCAAI,CAAA;IACJ,4BAA4B;IAC5B,6CAAO,CAAA;IACP,6BAA6B;IAC7B,yCAAK,CAAA;IACL,+EAA+E;IAC/E,uCAAI,CAAA;AACN,CAAC,EAXW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAWnB;AAkBD;;;GAGG;AACH,MAAa,MAAM;IAmBjB,0FAA0F;IACnF,MAAM,CAAC,UAAU,CAAC,QAAsB,EAAE,UAAwB,EAAE,OAAqB,EAAE,QAAsB;QACtH,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC5B,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC5B,MAAM,CAAC,mBAAmB,EAAE,CAAC;QAC7B,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,mBAAmB;QAC/B,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,QAAgB,EAAE,OAAe,EAAE,QAAyB,EAAE,EAAE,CACrG,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,QAAQ,MAAM,OAAO,IAAI,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,iCAAiC;QAE7H,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,2EAA2E;IACpE,MAAM,CAAC,WAAW,CAAC,QAA0B;QAClD,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,cAAc,EAAE;YACxC,MAAM,GAAG,GAAG,2BAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,GAAG;gBACL,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,2BAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,uDAAuD;QACnH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,0JAA0J;IACnJ,MAAM,CAAC,iBAAiB,CAAC,QAA0B;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,2JAA2J;IACpJ,MAAM,CAAC,eAAe,CAAC,QAAkB;QAC9C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,QAAkB;QACzD,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;IAC7B,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,aAAa,CAAC,GAAW;QACrC,QAAQ,GAAG,CAAC,WAAW,EAAE,EAAE;YACzB,KAAK,WAAW,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACxC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,SAAS,CAAC,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC;YACxC,KAAK,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC,IAAI,CAAC;YAClC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;YACpC,KAAK,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC;SACrC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,oFAAoF;IAC7E,MAAM,CAAC,eAAe,CAAC,GAAuB;QACnD,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,GAAG,CAAC,YAAY,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;SAC9D;QACD,IAAI,GAAG,CAAC,cAAc,KAAK,SAAS,EAAE;YACpC,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,cAAc,EAAE;gBACnC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC/D;SACF;IACH,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,CAAS;QACjC,OAAO,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,6HAA6H;IACtH,MAAM,CAAC,aAAa,CAAC,MAAW;QACrC,MAAM,UAAU,GAAG,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACtC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC5B,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,+CAA+C,IAAI,EAAE,CAAC,CAAC;YACrG,IAAI,IAAI,KAAK,cAAc,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC;oBACzC,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,sEAAsE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;aAC5J;iBAAM,IAAI,IAAI,KAAK,gBAAgB,EAAE;gBACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;oBACvB,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,sEAAsE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC7I,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC/B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;wBACtE,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,wHAAwH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAC9L,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;wBACnC,MAAM,IAAI,2BAAY,CAAC,2BAAY,CAAC,MAAM,EAAE,wGAAwG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;iBACxL;aACF;SACF;IACH,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,QAAgB;QACrC,sDAAsD;QACtD,MAAM,uBAAuB,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrE,IAAI,uBAAuB,KAAK,SAAS;YACvC,OAAO,uBAAuB,CAAC;QAEjC,8DAA8D;QAC9D,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,MAAM,KAAK,CAAC,CAAC;YACf,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAEpD,kCAAkC;QAClC,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,mBAAmB;QAC/B,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED;OACG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAED,iGAAiG;IAC1F,MAAM,CAAC,SAAS,CAAC,QAAgB,EAAE,KAAe;QACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QAClF,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,GAAY;QAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAK,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1F,OAAO,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,YAAY,CAAC,QAAgB,EAAE,GAAQ,EAAE,MAAmB,MAAM,CAAC,QAAQ;QACvF,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE;YAClD,OAAO,EAAE,GAAG,2BAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QACpF,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC;YACpE,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QACjF,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC;YAC9D,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAAe,EAAE,QAA0B;QAClF,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;;AAvNH,wBAwNC;AAjNgB,sBAAe,GAAG,IAAI,GAAG,EAAoB,CAAC,CAAC,mFAAmF;AAClI,gBAAS,GAAyB,SAAS,CAAC,CAAC,mFAAmF;AAE/I,sEAAsE;AACxD,6BAAsB,GAAG,KAAK,CAAC;AAE7C;;;eAGe;AACD,qBAAc,GAAG,IAAI,GAAG,EAA2B,CAAC;AAyMpE;;;;;;;;GAQG;AACH,MAAa,UAAU;IAOrB,YAAmB,SAAiB,EAAE,QAA0B;QAC9D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,6CAAqB,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE;YAC9E,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;YACzB,OAAO;SACR;QAED,MAAM,CAAC,OAAO,CAAC,6CAAqB,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9F,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,iBAAiB;IAChE,CAAC;IAEO,UAAU;QAChB,MAAM,YAAY,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,6CAAqB,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC;YAC5E,OAAO;QAET,MAAM,CAAC,OAAO,CAAC,6CAAqB,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,MAAM,EAAE,GAAG,EAAE;YAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,2BAAY,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7E,OAAO;gBACL,GAAG,KAAK,EAAE,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,2DAA2D;aACxH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;;AAnCH,gCAoCC;AAnCgB,oBAAS,GAAa,QAAQ,CAAC,IAAI,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Logging\r\n */\r\n\r\nimport { BentleyError, IModelStatus, LoggingMetaData } from \"./BentleyError\";\r\nimport { BentleyLoggerCategory } from \"./BentleyLoggerCategory\";\r\nimport { IDisposable } from \"./Disposable\";\r\n\r\n/** Defines the *signature* for a log function.\r\n * @public\r\n */\r\nexport type LogFunction = (category: string, message: string, metaData: LoggingMetaData) => void;\r\n\r\n/** Use to categorize logging messages by severity.\r\n * @public\r\n */\r\nexport enum LogLevel {\r\n  /** Tracing and debugging - low level */\r\n  Trace,\r\n  /** Information - mid level */\r\n  Info,\r\n  /** Warnings - high level */\r\n  Warning,\r\n  /** Errors - highest level */\r\n  Error,\r\n  /** Higher than any real logging level. This is used to turn a category off. */\r\n  None,\r\n}\r\n\r\n/** Identifies a logging category and the LogLevel that should be used for it. The LogLevel is specified by its string name.\r\n * @public\r\n */\r\nexport interface LoggerCategoryAndLevel {\r\n  category: string;\r\n  logLevel: string;\r\n}\r\n\r\n/** Specifies logging levels, including the default logging level and a set of categories and levels for them.\r\n * @public\r\n */\r\nexport interface LoggerLevelsConfig {\r\n  defaultLevel?: string;\r\n  categoryLevels?: LoggerCategoryAndLevel[];\r\n}\r\n\r\n/** Logger allows libraries and apps to report potentially useful information about operations, and it allows apps and users to control\r\n * how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md).\r\n * @public\r\n */\r\nexport class Logger {\r\n  protected static _logError: LogFunction | undefined;\r\n  protected static _logWarning: LogFunction | undefined;\r\n  protected static _logInfo: LogFunction | undefined;\r\n  protected static _logTrace: LogFunction | undefined;\r\n  /** @internal */\r\n  public static logLevelChangedFn?: VoidFunction;\r\n  private static _categoryFilter = new Map<string, LogLevel>(); // do not change the name of this member, it is referenced directly from node addon\r\n  private static _minLevel: LogLevel | undefined = undefined; // do not change the name of this member, it is referenced directly from node addon\r\n\r\n  /** Should the call stack be included when an exception is logged?  */\r\n  public static logExceptionCallstacks = false;\r\n\r\n  /** All static metadata is combined with per-call metadata and stringified in every log message.\r\n   * Static metadata can either be an object or a function that returns an object.\r\n   * Use a key to identify entries in the map so the can be removed individually.\r\n   * @internal */\r\n  public static staticMetaData = new Map<string, LoggingMetaData>();\r\n\r\n  /** Initialize the logger streams. Should be called at application initialization time. */\r\n  public static initialize(logError?: LogFunction, logWarning?: LogFunction, logInfo?: LogFunction, logTrace?: LogFunction): void {\r\n    Logger._logError = logError;\r\n    Logger._logWarning = logWarning;\r\n    Logger._logInfo = logInfo;\r\n    Logger._logTrace = logTrace;\r\n    Logger.turnOffLevelDefault();\r\n    Logger.turnOffCategories();\r\n  }\r\n\r\n  /** Initialize the logger to output to the console. */\r\n  public static initializeToConsole(): void {\r\n    const logConsole = (level: string) => (category: string, message: string, metaData: LoggingMetaData) =>\r\n      console.log(`${level} | ${category} | ${message} ${Logger.stringifyMetaData(metaData)}`); // eslint-disable-line no-console\r\n\r\n    Logger.initialize(logConsole(\"Error\"), logConsole(\"Warning\"), logConsole(\"Info\"), logConsole(\"Trace\"));\r\n  }\r\n\r\n  /** merge the supplied metadata with all static metadata into one object */\r\n  public static getMetaData(metaData?: LoggingMetaData): object {\r\n    const metaObj = {};\r\n    for (const meta of Logger.staticMetaData) {\r\n      const val = BentleyError.getMetaData(meta[1]);\r\n      if (val)\r\n        Object.assign(metaObj, val);\r\n    }\r\n    Object.assign(metaObj, BentleyError.getMetaData(metaData)); // do this last so user supplied values take precedence\r\n    return metaObj;\r\n  }\r\n\r\n  /** stringify the metadata for a log message by merging the supplied metadata with all static metadata into one object that is then `JSON.stringify`ed. */\r\n  public static stringifyMetaData(metaData?: LoggingMetaData): string {\r\n    const metaObj = this.getMetaData(metaData);\r\n    return Object.keys(metaObj).length > 0 ? JSON.stringify(metaObj) : \"\";\r\n  }\r\n\r\n  /** Set the least severe level at which messages should be displayed by default. Call setLevel to override this default setting for specific categories. */\r\n  public static setLevelDefault(minLevel: LogLevel): void {\r\n    this._minLevel = minLevel;\r\n    this.logLevelChangedFn?.();\r\n  }\r\n\r\n  /** Set the minimum logging level for the specified category. The minimum level is least severe level at which messages in the\r\n   * specified category should be displayed.\r\n   */\r\n  public static setLevel(category: string, minLevel: LogLevel) {\r\n    Logger._categoryFilter.set(category, minLevel);\r\n    this.logLevelChangedFn?.();\r\n  }\r\n\r\n  /** Interpret a string as the name of a LogLevel */\r\n  public static parseLogLevel(str: string): LogLevel {\r\n    switch (str.toUpperCase()) {\r\n      case \"EXCEPTION\": return LogLevel.Error;\r\n      case \"FATAL\": return LogLevel.Error;\r\n      case \"ERROR\": return LogLevel.Error;\r\n      case \"WARNING\": return LogLevel.Warning;\r\n      case \"INFO\": return LogLevel.Info;\r\n      case \"TRACE\": return LogLevel.Trace;\r\n      case \"DEBUG\": return LogLevel.Trace;\r\n    }\r\n    return LogLevel.None;\r\n  }\r\n\r\n  /** Set the log level for multiple categories at once. Also see [[validateProps]] */\r\n  public static configureLevels(cfg: LoggerLevelsConfig) {\r\n    Logger.validateProps(cfg);\r\n    if (cfg.defaultLevel !== undefined) {\r\n      this.setLevelDefault(Logger.parseLogLevel(cfg.defaultLevel));\r\n    }\r\n    if (cfg.categoryLevels !== undefined) {\r\n      for (const cl of cfg.categoryLevels) {\r\n        this.setLevel(cl.category, Logger.parseLogLevel(cl.logLevel));\r\n      }\r\n    }\r\n  }\r\n\r\n  private static isLogLevel(v: string) {\r\n    return LogLevel.hasOwnProperty(v);\r\n  }\r\n\r\n  /** Check that the specified object is a valid LoggerLevelsConfig. This is useful when reading a config from a .json file. */\r\n  public static validateProps(config: any) {\r\n    const validProps = [\"defaultLevel\", \"categoryLevels\"];\r\n    for (const prop of Object.keys(config)) {\r\n      if (!validProps.includes(prop))\r\n        throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig - unrecognized property: ${prop}`);\r\n      if (prop === \"defaultLevel\") {\r\n        if (!Logger.isLogLevel(config.defaultLevel))\r\n          throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.defaultLevel must be a LogLevel. Invalid value: ${JSON.stringify(config.defaultLevel)}`);\r\n      } else if (prop === \"categoryLevels\") {\r\n        const value = config[prop];\r\n        if (!Array.isArray(value))\r\n          throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels must be an array. Invalid value: ${JSON.stringify(value)}`);\r\n        for (const item of config[prop]) {\r\n          if (!item.hasOwnProperty(\"category\") || !item.hasOwnProperty(\"logLevel\"))\r\n            throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item must be a LoggerCategoryAndLevel {category: logLevel:}. Invalid value: ${JSON.stringify(item)}`);\r\n          if (!Logger.isLogLevel(item.logLevel))\r\n            throw new BentleyError(IModelStatus.BadArg, `LoggerLevelsConfig.categoryLevels - each item's logLevel property must be a LogLevel. Invalid value: ${JSON.stringify(item.logLevel)}`);\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Get the minimum logging level for the specified category. */\r\n  public static getLevel(category: string): LogLevel | undefined {\r\n    // Prefer the level set for this category specifically\r\n    const minLevelForThisCategory = Logger._categoryFilter.get(category);\r\n    if (minLevelForThisCategory !== undefined)\r\n      return minLevelForThisCategory;\r\n\r\n    // Fall back on the level set for the parent of this category.\r\n    const parent = category.lastIndexOf(\".\");\r\n    if (parent !== -1)\r\n      return Logger.getLevel(category.slice(0, parent));\r\n\r\n    // Fall back on the default level.\r\n    return Logger._minLevel;\r\n  }\r\n\r\n  /** Turns off the least severe level at which messages should be displayed by default.\r\n   * This turns off logging for all messages for which no category minimum level is defined.\r\n   */\r\n  public static turnOffLevelDefault(): void {\r\n    Logger._minLevel = undefined;\r\n  }\r\n\r\n  /** Turns off all category level filters previously defined with [[Logger.setLevel]].\r\n   */\r\n  public static turnOffCategories(): void {\r\n    Logger._categoryFilter.clear();\r\n  }\r\n\r\n  /** Check if messages in the specified category should be displayed at this level of severity. */\r\n  public static isEnabled(category: string, level: LogLevel): boolean {\r\n    const minLevel = Logger.getLevel(category);\r\n    return (minLevel !== undefined) && (level >= minLevel);\r\n  }\r\n\r\n  /** Log the specified message to the **error** stream.\r\n   * @param category  The category of the message.\r\n   * @param message  The message.\r\n   * @param metaData  Optional data for the message\r\n   */\r\n  public static logError(category: string, message: string, metaData?: LoggingMetaData): void {\r\n    if (Logger._logError && Logger.isEnabled(category, LogLevel.Error))\r\n      Logger._logError(category, message, metaData);\r\n  }\r\n\r\n  private static getExceptionMessage(err: unknown): string {\r\n    const stack = Logger.logExceptionCallstacks ? `\\n${BentleyError.getErrorStack(err)}` : \"\";\r\n    return BentleyError.getErrorMessage(err) + stack;\r\n  }\r\n\r\n  /** Log the specified exception. The special \"ExceptionType\" property will be added as metadata,\r\n   * in addition to any other metadata that may be supplied by the caller, unless the\r\n   * metadata supplied by the caller already includes this property.\r\n   * @param category  The category of the message.\r\n   * @param err  The exception object.\r\n   * @param log The logger output function to use - defaults to Logger.logError\r\n   * @param metaData  Optional data for the message\r\n   */\r\n  public static logException(category: string, err: any, log: LogFunction = Logger.logError): void {\r\n    log(category, Logger.getExceptionMessage(err), () => {\r\n      return { ...BentleyError.getErrorMetadata(err), exceptionType: err.constructor.name };\r\n    });\r\n  }\r\n\r\n  /** Log the specified message to the **warning** stream.\r\n   * @param category  The category of the message.\r\n   * @param message  The message.\r\n   * @param metaData  Optional data for the message\r\n   */\r\n  public static logWarning(category: string, message: string, metaData?: LoggingMetaData): void {\r\n    if (Logger._logWarning && Logger.isEnabled(category, LogLevel.Warning))\r\n      Logger._logWarning(category, message, metaData);\r\n  }\r\n\r\n  /** Log the specified message to the **info** stream.\r\n   * @param category  The category of the message.\r\n   * @param message  The message.\r\n   * @param metaData  Optional data for the message\r\n   */\r\n  public static logInfo(category: string, message: string, metaData?: LoggingMetaData): void {\r\n    if (Logger._logInfo && Logger.isEnabled(category, LogLevel.Info))\r\n      Logger._logInfo(category, message, metaData);\r\n  }\r\n\r\n  /** Log the specified message to the **trace** stream.\r\n   * @param category  The category of the message.\r\n   * @param message  The message.\r\n   * @param metaData  Optional data for the message\r\n   */\r\n  public static logTrace(category: string, message: string, metaData?: LoggingMetaData): void {\r\n    if (Logger._logTrace && Logger.isEnabled(category, LogLevel.Trace))\r\n      Logger._logTrace(category, message, metaData);\r\n  }\r\n}\r\n\r\n/** Simple performance diagnostics utility.\r\n * It measures the time from construction to disposal. On disposal it logs the routine name along with\r\n * the duration in milliseconds.\r\n * It also logs the routine name at construction time so that nested calls can be disambiguated.\r\n *\r\n * The timings are logged using the log category **Performance** and log severity [[LogLevel.INFO]].\r\n * Enable those, if you want to capture timings.\r\n * @public\r\n */\r\nexport class PerfLogger implements IDisposable {\r\n  private static _severity: LogLevel = LogLevel.Info;\r\n\r\n  private _operation: string;\r\n  private _metaData?: LoggingMetaData;\r\n  private _startTimeStamp: number;\r\n\r\n  public constructor(operation: string, metaData?: LoggingMetaData) {\r\n    this._operation = operation;\r\n    this._metaData = metaData;\r\n\r\n    if (!Logger.isEnabled(BentleyLoggerCategory.Performance, PerfLogger._severity)) {\r\n      this._startTimeStamp = 0;\r\n      return;\r\n    }\r\n\r\n    Logger.logInfo(BentleyLoggerCategory.Performance, `${this._operation},START`, this._metaData);\r\n    this._startTimeStamp = new Date().getTime(); // take timestamp\r\n  }\r\n\r\n  private logMessage(): void {\r\n    const endTimeStamp: number = new Date().getTime();\r\n    if (!Logger.isEnabled(BentleyLoggerCategory.Performance, PerfLogger._severity))\r\n      return;\r\n\r\n    Logger.logInfo(BentleyLoggerCategory.Performance, `${this._operation},END`, () => {\r\n      const mdata = this._metaData ? BentleyError.getMetaData(this._metaData) : {};\r\n      return {\r\n        ...mdata, TimeElapsed: endTimeStamp - this._startTimeStamp, // eslint-disable-line @typescript-eslint/naming-convention\r\n      };\r\n    });\r\n  }\r\n\r\n  public dispose(): void {\r\n    this.logMessage();\r\n  }\r\n}\r\n\r\n"]}