Add typescript types and onboarding ping

CHANGELOG.md

@@ -28,6 +28,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Unused normalize.css file
 
 -->
+## [3.1.0]
+
+### Added 
+- Added a ping to tell Raygun that raygun4js has been set up correctly, this information will be used to help users when setting up a new application. This can be disabled using the new `sendPing` option e.g., `rg4js('sendPing', false)`. The ping contains the version of Raygun4js being used, aswell as what products that have been enabled (CrashReporting and or Real User Monitoring) 
+- Moved the typescript types into the main raygun4js repo
+- Added an new option for enabling Real user monitoring 
+
 ## [3.0.1]
 
 ### Fixed

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "raygun4js",
-  "version": "2.28.0",
+  "version": "3.1.0",
   "homepage": "http://raygun.com",
   "authors": [
     "Mindscape <[email protected]>"

package.json

@@ -2,11 +2,12 @@
   "name": "raygun4js",
   "main": "dist/raygun.umd.js",
   "files": [
-    "dist/*"
+    "dist/*",
+    "types/*"
   ],
   "title": "Raygun4js",
   "description": "Raygun.com plugin for JavaScript",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "homepage": "https://github.com/MindscapeHQ/raygun4js",
   "author": {
     "name": "MindscapeHQ",
@@ -16,17 +17,18 @@
     "type": "git",
     "url": "https://github.com/MindscapeHQ/raygun4js.git"
   },
+  "types": "./types/index.d.ts",
   "bugs": "https://github.com/MindscapeHQ/raygun4js/issues",
   "license": "SEE LICENSE IN https://github.com/MindscapeHQ/raygun4js/blob/master/LICENSE",
   "devDependencies": {
-    "@wdio/cli": "^8.11.2",
-    "@wdio/dot-reporter": "^8.11.0",
-    "@wdio/jasmine-framework": "^8.11.2",
-    "@wdio/local-runner": "^8.11.2",
-    "@wdio/selenium-standalone-service": "^8.11.0",
-    "@wdio/spec-reporter": "^8.11.2",
-    "@wdio/static-server-service": "^8.11.0",
-    "chromedriver": "^119.0.1",
+    "@wdio/cli": "^8.36.1",
+    "@wdio/dot-reporter": "^8.36.1",
+    "@wdio/jasmine-framework": "^8.36.1",
+    "@wdio/local-runner": "^8.36.1",
+    "@wdio/selenium-standalone-service": "^8.14.0",
+    "@wdio/spec-reporter": "^8.36.1",
+    "@wdio/static-server-service": "^8.36.1",
+    "chromedriver": "^124.0.3",
     "cross-env": "^7.0.3",
     "grunt": "^1.6.1",
     "grunt-browserify": "^6.0.0",
@@ -36,7 +38,7 @@
     "grunt-contrib-uglify": "^5.2.2",
     "grunt-contrib-watch": "^1.1.0",
     "grunt-string-replace": "^1.3.1",
-    "jasmine": "^5.0.2",
+    "jasmine": "^5.1.0",
     "underscore": "^1.13.6",
     "wdio-chromedriver-service": "^8.1.1"
   },

raygun4js.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
   <metadata>
     <id>raygun4js</id>
-    <version>2.28.0</version>
+    <version>3.1.0</version>
     <title>Raygun4js</title>
     <authors>Raygun Limited</authors>
     <owners>Raygun Limited</owners>

src/raygun.js

@@ -29,7 +29,6 @@ var raygunFactory = function (window, $, undefined) {
   };
 
   var _userKey = 'raygun4js-userid';
-
   // State variables
   var _traceKit = TraceKit,
     _raygun = window.Raygun,
@@ -56,7 +55,6 @@ var raygunFactory = function (window, $, undefined) {
     _groupingKeyCallback,
     _beforeXHRCallback,
     _afterSendCallback,
-    _raygunApiUrl = 'https://api.raygun.io',
     _excludedHostnames = null,
     _excludedUserAgents = null,
     _filterScope = 'customData',
@@ -101,6 +99,7 @@ var raygunFactory = function (window, $, undefined) {
     init: function (key, options, customdata) {
       _traceKit.remoteFetching = false;
 
+      Raygun.Options._raygunApiUrl = 'https://api.raygun.io';
       this.Options._raygunApiKey = key;
 
       if (customdata) {
@@ -129,8 +128,8 @@ var raygunFactory = function (window, $, undefined) {
         _trackViewportDimensions = options.trackViewportDimensions === undefined ? true : options.trackViewportDimensions;
 
         if (options.apiUrl) {
-          _raygunApiUrl = options.apiUrl;
-          _customEndpointSet = true;
+          this.Options._raygunApiUrl = options.apiUrl;
+          this.Options._customEndpointSet = true;
         }
 
         if (typeof options.wrapAsynchronousCallbacks !== 'undefined') {
@@ -151,8 +150,8 @@ var raygunFactory = function (window, $, undefined) {
         }
 
         if (options.apiEndpoint) {
-          _raygunApiUrl = options.apiEndpoint;
-          _customEndpointSet = true;
+          this.Options._raygunApiUrl = options.apiEndpoint;
+          this.Options._customEndpointSet = true;
         }
 
         if (options.from) {
@@ -500,7 +499,7 @@ var raygunFactory = function (window, $, undefined) {
       var startRum = function () {
         _rum = new Raygun.RealUserMonitoring(
           Raygun.Options._raygunApiKey,
-          _raygunApiUrl,
+          Raygun.Options._raygunApiUrl,
           makePostCorsRequest,
           _user,
           _version,
@@ -978,7 +977,7 @@ var raygunFactory = function (window, $, undefined) {
     }
 
     Raygun.Utilities.log('Sending exception data to Raygun:', data);
-    var url = _raygunApiUrl + '/entries?apikey=' + encodeURIComponent(Raygun.Options._raygunApiKey);
+    var url = Raygun.Options._raygunApiUrl + '/entries?apikey=' + encodeURIComponent(Raygun.Options._raygunApiKey);
     makePostCorsRequest(url, JSON.stringify(data));
   }
 

src/raygun.loader.js

@@ -14,11 +14,18 @@
     delayedCommands = [],
     apiKey,
     options,
-    attach,
-    enablePulse,
     noConflict,
+    realUserMonitoringEnabled = false,
+    crashReportingEnabled = false,
     captureUnhandledRejections;
 
+  var metadata = {
+    ping : {
+        sendPing : true,
+        pingIntervalId : -1,
+        failedPings : 0
+    },
+  };
   var snippetOnErrorSignature = ['function (b,c,d,f,g){', '||(g=new Error(b)),a[e].q=a[e].q||[]'];
 
   errorQueue = window[window['RaygunObject']].q;
@@ -51,6 +58,9 @@
 
     if (key) {
       switch (key) {
+        case 'sendPing':
+          metadata.ping.sendPing = value;
+          break;
         // React Native only
         case 'boot':
           onLoadHandler();
@@ -68,12 +78,13 @@
           break;
         case 'attach':
         case 'enableCrashReporting':
-          attach = value;
+          crashReportingEnabled = value;
           hasLoaded = true;
           break;
+        case 'enableRealUserMonitoring':
         case 'enableRUM':
         case 'enablePulse':
-          enablePulse = value;
+          realUserMonitoringEnabled = value;
           hasLoaded = true;
           break;
         case 'detach':
@@ -218,6 +229,39 @@
     }
   };
 
+  function ping() {
+    if(metadata.ping.failedPings > 10) {
+        clearInterval(metadata.ping.pingIntervalId);
+    }
+
+    var url = Raygun.Options._raygunApiUrl + "/ping?apiKey=" + encodeURIComponent(Raygun.Options._raygunApiKey);
+    var data = {
+        crashReportingEnabled: crashReportingEnabled ? true : false,
+        realUserMonitoringEnabled: realUserMonitoringEnabled ? true : false,
+        providerName: "raygun4js",
+        providerVersion: '{{VERSION}}'
+    };
+
+    fetch(url, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify(data)
+    }).then(function(response) {
+    if (response.ok) {
+      metadata.ping.failedPings = 0;
+    } else {
+      // Request failed
+      metadata.ping.failedPings++;
+    }
+  })
+    .catch(function() {
+        metadata.ping.failedPings++;
+    });
+  }
+
+
   var installGlobalExecutor = function() {
     window[window['RaygunObject']] = function() {
       return executor(arguments);
@@ -232,21 +276,21 @@
     if (noConflict) {
       rg = Raygun.noConflict();
     }
-
+    
     if (apiKey) {
       if (!options) {
         options = {};
       }
 
-      if (enablePulse) {
+      if (realUserMonitoringEnabled) {
         options.disablePulse = false;
       }
 
       options.from = 'onLoad';
       rg.init(apiKey, options, null);
     }
 
-    if (attach) {
+    if (crashReportingEnabled) {
       rg.attach();
 
       errorQueue = window[window['RaygunObject']].q;
@@ -275,6 +319,10 @@
       installGlobalExecutor();
     }
 
+    if(metadata.ping.sendPing) {
+      ping(); //call immediately
+      metadata.ping.pingIntervalId = setInterval(ping, 1000 * 60 * 5); //5 minutes
+    }
     window[window['RaygunObject']].q = errorQueue;
   };