@honeybadger-io/js 6.8.3 → 6.9.0

package/dist/browser/util.d.ts

@@ -16,8 +16,4 @@ export declare function localURLPathname(url: string): any;
 export declare function decodeCookie(string: string): Record<string, unknown>;
 export declare function encodeCookie(object: any): string;
 export declare const preferCatch: boolean;
-/** globalThis has fairly good support. But just in case, lets check its defined.
- * @see {https://caniuse.com/?search=globalThis}
- */
-export declare function globalThisOrWindow(): typeof globalThis;
 //# sourceMappingURL=util.d.ts.map

package/dist/server/honeybadger.js

@@ -51,7 +51,7 @@ var server$1 = {};
 
 var src = {};
 
-var client$1 = {};
+var events = {};
 
 var util$1 = {};
 
@@ -258,7 +258,7 @@ var require$$0$1 = /*@__PURE__*/getAugmentedNamespace(stackTraceParser_esm);
 	    }
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.isBrowserConfig = exports.clone = exports.formatCGIData = exports.filterUrl = exports.filter = exports.generateStackTrace = exports.endpoint = exports.instrumentConsole = exports.instrument = exports.isErrorObject = exports.makeNotice = exports.logger = exports.sanitize = exports.shallowClone = exports.runAfterNotifyHandlers = exports.runBeforeNotifyHandlers = exports.getSourceForBacktrace = exports.getCauses = exports.calculateBacktraceShift = exports.DEFAULT_BACKTRACE_SHIFT = exports.makeBacktrace = exports.objectIsExtensible = exports.objectIsEmpty = exports.mergeNotice = exports.merge = void 0;
+	exports.logDeprecatedMethod = exports.globalThisOrWindow = exports.isBrowserConfig = exports.clone = exports.formatCGIData = exports.filterUrl = exports.filter = exports.generateStackTrace = exports.endpoint = exports.instrumentConsole = exports.instrument = exports.isErrorObject = exports.makeNotice = exports.logger = exports.sanitize = exports.shallowClone = exports.runAfterNotifyHandlers = exports.runBeforeNotifyHandlers = exports.getSourceForBacktrace = exports.getCauses = exports.calculateBacktraceShift = exports.DEFAULT_BACKTRACE_SHIFT = exports.makeBacktrace = exports.objectIsExtensible = exports.objectIsEmpty = exports.mergeNotice = exports.merge = void 0;
 	/* eslint-disable prefer-rest-params */
 	var stackTraceParser = __importStar(require$$0$1);
 	function merge(obj1, obj2) {
@@ -799,9 +799,80 @@ var require$$0$1 = /*@__PURE__*/getAugmentedNamespace(stackTraceParser_esm);
 	    return config.async !== undefined;
 	}
 	exports.isBrowserConfig = isBrowserConfig;
+	/** globalThis has fairly good support. But just in case, lets check its defined.
+	 * @see {https://caniuse.com/?search=globalThis}
+	 */
+	function globalThisOrWindow() {
+	    if (typeof globalThis !== 'undefined') {
+	        return globalThis;
+	    }
+	    if (typeof self !== 'undefined') {
+	        return self;
+	    }
+	    return window;
+	}
+	exports.globalThisOrWindow = globalThisOrWindow;
+	var _deprecatedMethodCalls = {};
+	/**
+	 * Logs a deprecation warning, every X calls to the method.
+	 */
+	function logDeprecatedMethod(logger, oldMethod, newMethod, callCountThreshold) {
+	    if (callCountThreshold === void 0) { callCountThreshold = 100; }
+	    var key = "".concat(oldMethod, "-").concat(newMethod);
+	    if (typeof _deprecatedMethodCalls[key] === 'undefined') {
+	        _deprecatedMethodCalls[key] = 0;
+	    }
+	    if (_deprecatedMethodCalls[key] % callCountThreshold !== 0) {
+	        _deprecatedMethodCalls[key]++;
+	        return;
+	    }
+	    var msg = "Deprecation warning: ".concat(oldMethod, " has been deprecated; please use ").concat(newMethod, " instead.");
+	    logger.warn(msg);
+	    _deprecatedMethodCalls[key]++;
+	}
+	exports.logDeprecatedMethod = logDeprecatedMethod;
 	
 } (util$1));
 
+Object.defineProperty(events, "__esModule", { value: true });
+var util_1$7 = util$1;
+function default_1$2(_window) {
+    if (_window === void 0) { _window = (0, util_1$7.globalThisOrWindow)(); }
+    return {
+        shouldReloadOnConfigure: false,
+        load: function (client) {
+            function sendEventsToInsights() {
+                return client.config.eventsEnabled;
+            }
+            if (!sendEventsToInsights()) {
+                return;
+            }
+            (0, util_1$7.instrumentConsole)(_window, function (level, args) {
+                if (!sendEventsToInsights()) {
+                    return;
+                }
+                if (args.length === 0) {
+                    return;
+                }
+                var data = {
+                    severity: level,
+                };
+                if (typeof args[0] === 'string') {
+                    data.message = args[0];
+                    data.args = args.slice(1);
+                }
+                else {
+                    data.args = args;
+                }
+                client.event('log', data);
+            });
+        }
+    };
+}
+events.default = default_1$2;
+
+var client$1 = {};
+
 var store = {};
 
 Object.defineProperty(store, "__esModule", { value: true });
@@ -876,6 +947,7 @@ defaults.CONFIG = {
     revision: null,
     reportData: null,
     breadcrumbsEnabled: true,
+    // we could decide the value of eventsEnabled based on `env` and `developmentEnvironments`
     eventsEnabled: false,
     maxBreadcrumbs: 40,
     maxObjectDepth: 8,
@@ -956,8 +1028,8 @@ var ThrottledEventsLogger = /** @class */ (function () {
             this.config[k] = opts[k];
         }
     };
-    ThrottledEventsLogger.prototype.logEvent = function (data) {
-        this.queue.push(data);
+    ThrottledEventsLogger.prototype.log = function (payload) {
+        this.queue.push(payload);
         if (!this.isProcessing) {
             this.processQueue();
         }
@@ -1016,8 +1088,9 @@ var ThrottledEventsLogger = /** @class */ (function () {
     /**
      * todo: improve this
      *
-     * The EventsLogger overrides the console methods
-     * so if we want to log something we need to use the original methods
+     * The EventsLogger overrides the console methods to enable automatic instrumentation
+     * of console logs to the Honeybadger API.
+     * So if we want to log something in here we need to use the original methods.
      */
     ThrottledEventsLogger.prototype.originalLogger = function () {
         var _a, _b, _c, _d, _e;
@@ -1105,7 +1178,7 @@ var Client = /** @class */ (function () {
         this.__notifier = {
             name: '@honeybadger-io/core',
             url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/core',
-            version: '6.8.3'
+            version: '6.9.0'
         };
         this.config = __assign$1(__assign$1({}, defaults_1.CONFIG), opts);
         this.__initStore();
@@ -1309,8 +1382,20 @@ var Client = /** @class */ (function () {
         });
         return this;
     };
+    /**
+     * @deprecated Use {@link event} instead.
+     */
     Client.prototype.logEvent = function (data) {
-        this.__eventsLogger.logEvent(data);
+        (0, util_1$4.logDeprecatedMethod)(this.logger, 'Honeybadger.logEvent', 'Honeybadger.event');
+        this.event('log', data);
+    };
+    Client.prototype.event = function (type, data) {
+        var _a;
+        if (typeof type === 'object') {
+            data = type;
+            type = (_a = type['event_type']) !== null && _a !== void 0 ? _a : undefined;
+        }
+        this.__eventsLogger.log(__assign$1({ event_type: type, ts: new Date().toISOString() }, data));
     };
     Client.prototype.__getBreadcrumbs = function () {
         return this.__store.getContents('breadcrumbs').slice();
@@ -1496,13 +1581,20 @@ Object.defineProperty(types, "__esModule", { value: true });
 	    __setModuleDefault(result, mod);
 	    return result;
 	};
+	var __importDefault = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
+	    return (mod && mod.__esModule) ? mod : { "default": mod };
+	};
 	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.Util = exports.Types = exports.Client = void 0;
+	exports.Plugins = exports.Util = exports.Types = exports.Client = void 0;
+	var events_1 = __importDefault(events);
 	var client_1 = client$1;
 	Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 	__exportStar(store, exports);
 	exports.Types = __importStar(types);
 	exports.Util = __importStar(util$1);
+	exports.Plugins = {
+	    events: events_1.default
+	};
 	
 } (src));
 
@@ -2617,7 +2709,8 @@ client.CheckInsClient = CheckInsClient;
 	var endpoint = core_1.Util.endpoint;
 	var DEFAULT_PLUGINS = [
 	    (0, uncaught_exception_plugin_1.default)(),
-	    (0, unhandled_rejection_plugin_1.default)()
+	    (0, unhandled_rejection_plugin_1.default)(),
+	    core_1.Plugins.events(),
 	];
 	var Honeybadger = /** @class */ (function (_super) {
 	    __extends(Honeybadger, _super);
@@ -2769,7 +2862,7 @@ client.CheckInsClient = CheckInsClient;
 	var NOTIFIER = {
 	    name: '@honeybadger-io/js',
 	    url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/js',
-	    version: '6.8.3'
+	    version: '6.9.0'
 	};
 	var userAgent = function () {
 	    return "Honeybadger JS Server Client ".concat(NOTIFIER.version, ", ").concat(os_1.default.version(), "; ").concat(os_1.default.platform());