@microsoft/sp-diagnostics 1.23.1 → 1.24.0-beta.2

package/lib-commonjs/Api/Qos/QosMonitorShareFailureWithCP.js

@@ -1,117 +1,97 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QosMonitorShareFailureWithCP = void 0;
-var tslib_1 = require("tslib");
-var QosMonitor_1 = tslib_1.__importDefault(require("./QosMonitor"));
-var QosResultType_1 = require("./QosResultType");
-var index_1 = require("../../index");
-var Killswitches_1 = require("../../common/Killswitches");
-/**
- * Monitor which handles failures for QosMonitor and also invokes Customer Promise Handlers to record failure
- * @internal
- */
-var QosMonitorShareFailureWithCP = /** @class */ (function (_super) {
-    tslib_1.__extends(QosMonitorShareFailureWithCP, _super);
-    /**
-     * Creates a QoS monitor and also registers the Customer promise handlers to notify in case of failures
-     * @internal
-     *
-     * @param scenarioName  - Unique name of the QoS scenario
-     * @param copyToEngagement - indicate whether this data should be used as Engagement as well.
-     * @param extraDataForCustomerPromise - Holds extra information about Customer Promise handlers to invoke
-     * and error information where failures are logged
-     */
-    function QosMonitorShareFailureWithCP(scenarioName, copyToEngagement, extraDataForCustomerPromise, copyToCosmos) {
-        if (copyToEngagement === void 0) { copyToEngagement = false; }
-        if (copyToCosmos === void 0) { copyToCosmos = false; }
-        var _this = _super.call(this, scenarioName, /* copyToCosmos */ copyToCosmos, /* copyToInterana */ copyToEngagement) || this;
-        _this._extraDataForCustomerPromise = extraDataForCustomerPromise;
-        return _this;
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "QosMonitorShareFailureWithCP", {
+    enumerable: true,
+    get: function() {
+        return QosMonitorShareFailureWithCP;
     }
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _QosMonitor = /*#__PURE__*/ _interop_require_default._(require("./QosMonitor"));
+const _QosResultType = require("./QosResultType");
+const _Diagnostics = /*#__PURE__*/ _interop_require_default._(require("../../Diagnostics"));
+const _Killswitches = require("../../common/Killswitches");
+class QosMonitorShareFailureWithCP extends _QosMonitor.default {
     /**
-     * QoS monitor ends with failure and invokes the Customer Promise handlers
-     * to log a failure
-     * @internal
-     *
-     * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
-     * <failuretag> will be filled with param tagName
-     */
-    QosMonitorShareFailureWithCP.prototype.writeUnexpectedFailure = function (tagNameSuffix, ex, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+   * QoS monitor ends with failure and invokes the Customer Promise handlers
+   * to log a failure
+   * @internal
+   *
+   * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
+   * <failuretag> will be filled with param tagName
+   */ writeUnexpectedFailure(tagNameSuffix = 'DefaultUnexpected', ex, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     extraData) {
-        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultUnexpected'; }
-        _super.prototype.writeUnexpectedFailure.call(this, tagNameSuffix, ex, extraData);
-        this._logCustomerPromiseFailure((ex === null || ex === void 0 ? void 0 : ex.message) || 'DefaultErrorMessage', tagNameSuffix, QosResultType_1.QosResultType.Failure, extraData);
-    };
+        super.writeUnexpectedFailure(tagNameSuffix, ex, extraData);
+        this._logCustomerPromiseFailure(ex?.message || 'DefaultErrorMessage', tagNameSuffix, _QosResultType.QosResultType.Failure, extraData);
+    }
     /**
-     * QoS monitor ends with expected failure and invokes the Customer Promise handlers
-     * to log an expected failure
-     * @internal
-     *
-     * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
-     * <failuretag> will be filled with param tagName
-     */
-    QosMonitorShareFailureWithCP.prototype.writeExpectedFailure = function (tagNameSuffix, ex, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    extraData, skipLoggingCustomerPromiseFailure) {
-        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultExpected'; }
-        if (skipLoggingCustomerPromiseFailure === void 0) { skipLoggingCustomerPromiseFailure = false; }
-        _super.prototype.writeExpectedFailure.call(this, tagNameSuffix, ex, extraData);
+   * QoS monitor ends with expected failure and invokes the Customer Promise handlers
+   * to log an expected failure
+   * @internal
+   *
+   * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
+   * <failuretag> will be filled with param tagName
+   */ writeExpectedFailure(tagNameSuffix = 'DefaultExpected', ex, // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    extraData, skipLoggingCustomerPromiseFailure = false) {
+        super.writeExpectedFailure(tagNameSuffix, ex, extraData);
         if (!skipLoggingCustomerPromiseFailure) {
-            this._logCustomerPromiseFailure((ex === null || ex === void 0 ? void 0 : ex.message) || 'DefaultErrorMessage', tagNameSuffix, QosResultType_1.QosResultType.ExpectedFailure, extraData);
+            this._logCustomerPromiseFailure(ex?.message || 'DefaultErrorMessage', tagNameSuffix, _QosResultType.QosResultType.ExpectedFailure, extraData);
         }
-    };
+    }
     /**
-     * Invokes the registered Customer Promise Handlers by using the passed in serviceKey
-     * @param errorMessage - Information to indicate which scenario failed.
-     * @param errorScenario -Additional error details describing the failure from the module.
-     * @param resultType - ResultTypeEnum used to indicate expected or unexpected failure.
-     * @param extraData - Additional information to be logged, which might include pageType and/or errorStack
-     */
-    QosMonitorShareFailureWithCP.prototype._logCustomerPromiseFailure = function (errorMessage, errorScenario, resultType, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+   * Invokes the registered Customer Promise Handlers by using the passed in serviceKey
+   * @param errorMessage - Information to indicate which scenario failed.
+   * @param errorScenario -Additional error details describing the failure from the module.
+   * @param resultType - ResultTypeEnum used to indicate expected or unexpected failure.
+   * @param extraData - Additional information to be logged, which might include pageType and/or errorStack
+   */ _logCustomerPromiseFailure(errorMessage, errorScenario, resultType = _QosResultType.QosResultType.Failure, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     extraData) {
-        if (resultType === void 0) { resultType = QosResultType_1.QosResultType.Failure; }
         if (this._extraDataForCustomerPromise) {
-            this._extraDataForCustomerPromise.forEach(function (extraHandlerInfo) {
-                var logFailure = extraHandlerInfo.logFailure, veto = extraHandlerInfo.veto;
-                var errorModuleName = extraHandlerInfo.errorModuleName +
-                    getAuthoringSuffix() +
-                    (!(0, Killswitches_1.isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive)() ? getOfflineSuffix() : '');
-                var errorDetailsForCP = {
+            this._extraDataForCustomerPromise.forEach((extraHandlerInfo)=>{
+                const { logFailure, veto } = extraHandlerInfo;
+                const errorModuleName = extraHandlerInfo.errorModuleName + getAuthoringSuffix() + (!(0, _Killswitches.isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive)() ? getOfflineSuffix() : '');
+                const errorDetailsForCP = {
                     errorCode: errorModuleName,
-                    errorScenario: errorScenario,
-                    errorMessage: errorMessage,
-                    resultType: resultType,
-                    pageType: extraData === null || extraData === void 0 ? void 0 : extraData.pageType,
-                    errorStack: extraData === null || extraData === void 0 ? void 0 : extraData.errorStack,
-                    veto: veto
+                    errorScenario,
+                    errorMessage,
+                    resultType,
+                    pageType: extraData?.pageType,
+                    errorStack: extraData?.errorStack,
+                    veto
                 };
                 logFailure(errorDetailsForCP);
             });
         }
-    };
-    return QosMonitorShareFailureWithCP;
-}(QosMonitor_1.default));
-exports.QosMonitorShareFailureWithCP = QosMonitorShareFailureWithCP;
+    }
+    /**
+   * Creates a QoS monitor and also registers the Customer promise handlers to notify in case of failures
+   * @internal
+   *
+   * @param scenarioName  - Unique name of the QoS scenario
+   * @param copyToEngagement - indicate whether this data should be used as Engagement as well.
+   * @param extraDataForCustomerPromise - Holds extra information about Customer Promise handlers to invoke
+   * and error information where failures are logged
+   */ constructor(scenarioName, copyToEngagement = false, extraDataForCustomerPromise, copyToCosmos = false){
+        super(scenarioName, /* copyToCosmos */ copyToCosmos, /* copyToInterana */ copyToEngagement);
+        this._extraDataForCustomerPromise = extraDataForCustomerPromise;
+    }
+}
 function getAuthoringSuffix() {
-    var extraDiagnosticInfo = index_1._Diagnostics._getExtraDiagnosticInfo();
+    const extraDiagnosticInfo = _Diagnostics.default._getExtraDiagnosticInfo();
     if (!extraDiagnosticInfo || !extraDiagnosticInfo.hasAuthoringStarted) {
         return '';
-    }
-    else if (!extraDiagnosticInfo.authoringSessionClientCount) {
-        return extraDiagnosticInfo.isAuthoringUsingDDS
-            ? " in Legacy Authoring (DDS)"
-            : ' in Legacy Authoring (no DDS)';
-    }
-    else if (extraDiagnosticInfo.authoringSessionClientCount > 1) {
+    } else if (!extraDiagnosticInfo.authoringSessionClientCount) {
+        return extraDiagnosticInfo.isAuthoringUsingDDS ? ` in Legacy Authoring (DDS)` : ' in Legacy Authoring (no DDS)';
+    } else if (extraDiagnosticInfo.authoringSessionClientCount > 1) {
         return ' with Multiple Users';
-    }
-    else {
+    } else {
         return '';
     }
 }
 function getOfflineSuffix() {
     return window.navigator.onLine ? '' : ' (offline)';
 }
-//# sourceMappingURL=QosMonitorShareFailureWithCP.js.map
+
+//# sourceMappingURL=./QosMonitorShareFailureWithCP.js.map

package/lib-commonjs/Api/Qos/QosResultType.js

@@ -1,14 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QosResultType = void 0;
 /**
  * Qos Result Type const object.
  * @internal
- */
-// eslint-disable-next-line @typescript-eslint/typedef
-exports.QosResultType = {
+ */ // eslint-disable-next-line @typescript-eslint/typedef
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "QosResultType", {
+    enumerable: true,
+    get: function() {
+        return QosResultType;
+    }
+});
+const QosResultType = {
     Success: 0,
     Failure: 1,
     ExpectedFailure: 2
 };
-//# sourceMappingURL=QosResultType.js.map
+
+//# sourceMappingURL=./QosResultType.js.map

package/lib-commonjs/Api/Trace/DefaultTraceHandler.js

@@ -1,32 +1,30 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Default implementation for the Trace logger class.
- */
-var DefaultTraceHandler = /** @class */ (function () {
-    function DefaultTraceHandler() {
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return DefaultTraceHandler;
     }
+});
+class DefaultTraceHandler {
     /**
-     * Default implementation for log function.
-     */
-    DefaultTraceHandler.prototype.log = function (traceLogEvent) {
+   * Default implementation for log function.
+   */ log(traceLogEvent) {
         if (!DEPRECATED_UNIT_TEST) {
             // eslint-disable-next-line no-console
-            console.log("Error: ".concat(traceLogEvent.data, ", ") +
-                "Event Name: ".concat(traceLogEvent.eventName, ", ") +
-                "Result Code: ".concat(traceLogEvent.resultCode));
+            console.log(`Error: ${traceLogEvent.data}, ` + `Event Name: ${traceLogEvent.eventName}, ` + `Result Code: ${traceLogEvent.resultCode}`);
         }
-    };
+    }
     /**
-     * Default implementation for verbose function.
-     */
-    DefaultTraceHandler.prototype.verbose = function (verboseTraceEvent) {
+   * Default implementation for verbose function.
+   */ verbose(verboseTraceEvent) {
         if (!DEPRECATED_UNIT_TEST) {
             // eslint-disable-next-line no-console
-            console.log("Error: ".concat(verboseTraceEvent.data, ", Event Name: ").concat(verboseTraceEvent.eventName));
+            console.log(`Error: ${verboseTraceEvent.data}, Event Name: ${verboseTraceEvent.eventName}`);
         }
-    };
-    return DefaultTraceHandler;
-}());
-exports.default = DefaultTraceHandler;
-//# sourceMappingURL=DefaultTraceHandler.js.map
+    }
+}
+
+//# sourceMappingURL=./DefaultTraceHandler.js.map

package/lib-commonjs/Api/Trace/ITraceHandler.js

@@ -1,3 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ITraceHandler.js.map
+/**
+ * Trace logger log data interface
+ * @internal
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=./ITraceHandler.js.map

package/lib-commonjs/Api/Trace/ITraceLogger.js

@@ -1,3 +1,6 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ITraceLogger.js.map
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=./ITraceLogger.js.map

package/lib-commonjs/Api/Trace/LogEvent.js

@@ -1,150 +1,111 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-var LogSource_1 = require("../LogSource");
-var LogManager_1 = tslib_1.__importDefault(require("../LogManager/LogManager"));
-/**
- * An object that represents one log event.
- * @internal
- */
-var LogEvent = /** @class */ (function () {
-    /**
-     * Do not call this constructor directly. Use LogEvent.log instead.
-     */
-    function LogEvent(source, data, level, serviceScope) {
-        this._validate(source, data);
-        this._timestamp = new Date().getTime();
-        this._scope = this._getScope(serviceScope);
-        this._source = source.substr(0, this._maxSourceLength);
-        this._setData(data);
-        this._level = level;
-        this._prefix = this._getPrefix();
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return LogEvent;
     }
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _LogSource = require("../LogSource");
+const _LogManager = /*#__PURE__*/ _interop_require_default._(require("../LogManager/LogManager"));
+class LogEvent {
     /**
-     * Use this method to log an event.
-     *
-     * @param source - source of the log event, e.g. class name of the source file
-     * @param data - data of the log event
-     * @param level - level of the log event
-     * @param serviceScope - scope of the log event, e.g. component/web part
-     */
-    LogEvent.log = function (source, data, level, serviceScope) {
-        var event = new LogEvent(source, data, level, serviceScope);
+   * Use this method to log an event.
+   *
+   * @param source - source of the log event, e.g. class name of the source file
+   * @param data - data of the log event
+   * @param level - level of the log event
+   * @param serviceScope - scope of the log event, e.g. component/web part
+   */ static log(source, data, level, serviceScope) {
+        const event = new LogEvent(source, data, level, serviceScope);
         LogEvent.logManager.log(event);
         return event;
-    };
-    LogEvent.prototype.toString = function () {
-        var timedPrefix = "[".concat(this._timestamp, "][").concat(this._prefix, "]");
+    }
+    toString() {
+        const timedPrefix = `[${this._timestamp}][${this._prefix}]`;
         if (this._message) {
-            return "".concat(timedPrefix, " ").concat(this._message);
-        }
-        else if (this._error) {
-            return "".concat(timedPrefix, " ").concat(this._error.toString());
-        }
-        else {
+            return `${timedPrefix} ${this._message}`;
+        } else if (this._error) {
+            return `${timedPrefix} ${this._error.toString()}`;
+        } else {
             return timedPrefix;
         }
-    };
-    Object.defineProperty(LogEvent.prototype, "timestamp", {
-        get: function () {
-            return this._timestamp;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "level", {
-        get: function () {
-            return this._level;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "prefix", {
-        get: function () {
-            return this._prefix;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "scope", {
-        get: function () {
-            return this._scope;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "source", {
-        get: function () {
-            return this._source;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "message", {
-        get: function () {
-            return this._message;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "error", {
-        get: function () {
-            return this._error;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "_maxSourceLength", {
-        get: function () {
-            return 30;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(LogEvent.prototype, "_maxMessageLength", {
-        get: function () {
-            return 150;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    LogEvent.prototype._validate = function (source, data) {
+    }
+    get timestamp() {
+        return this._timestamp;
+    }
+    get level() {
+        return this._level;
+    }
+    get prefix() {
+        return this._prefix;
+    }
+    get scope() {
+        return this._scope;
+    }
+    get source() {
+        return this._source;
+    }
+    get message() {
+        return this._message;
+    }
+    get error() {
+        return this._error;
+    }
+    get _maxSourceLength() {
+        return 30;
+    }
+    get _maxMessageLength() {
+        return 150;
+    }
+    _validate(source, data) {
         if (!source) {
             throw new Error('source cannot be undefined or null for Logger');
         }
         if (!data) {
             throw new Error('data cannot be undefined or null');
         }
-    };
-    LogEvent.prototype._setData = function (data) {
+    }
+    _setData(data) {
         if (typeof data === 'string') {
             this._message = data.substr(0, this._maxMessageLength);
-        }
-        else if (data instanceof Error) {
+        } else if (data instanceof Error) {
             this._error = data;
         }
-    };
-    LogEvent.prototype._getPrefix = function () {
-        var prefix = "".concat(this._source);
+    }
+    _getPrefix() {
+        let prefix = `${this._source}`;
         if (this._scope && !this._scope.isEmpty()) {
-            prefix = "".concat(this._scope.id.substr(0, this._maxSourceLength), ".").concat(prefix);
+            prefix = `${this._scope.id.substr(0, this._maxSourceLength)}.${prefix}`;
         }
-        return "".concat(prefix);
-    };
-    LogEvent.prototype._getScope = function (serviceScope) {
-        var parentSource;
+        return `${prefix}`;
+    }
+    _getScope(serviceScope) {
+        let parentSource;
         if (serviceScope) {
-            serviceScope.whenFinished(function () {
-                parentSource = serviceScope.consume(LogSource_1.logSourceServiceKey);
+            serviceScope.whenFinished(()=>{
+                parentSource = serviceScope.consume(_LogSource.logSourceServiceKey);
             });
         }
         return parentSource;
-    };
+    }
     /**
-     * Allows process log events.
-     */
-    LogEvent.logManager = new LogManager_1.default();
-    return LogEvent;
-}());
-exports.default = LogEvent;
-//# sourceMappingURL=LogEvent.js.map
+   * Do not call this constructor directly. Use LogEvent.log instead.
+   */ constructor(source, data, level, serviceScope){
+        this._validate(source, data);
+        this._timestamp = new Date().getTime();
+        this._scope = this._getScope(serviceScope);
+        this._source = source.substr(0, this._maxSourceLength);
+        this._setData(data);
+        this._level = level;
+        this._prefix = this._getPrefix();
+    }
+}
+/**
+   * Allows process log events.
+   */ LogEvent.logManager = new _LogManager.default();
+
+//# sourceMappingURL=./LogEvent.js.map