refactor!: #262 remove deprecated methods (#288)

* refactor: #262 remove deprecated methods

* Updated README

* sync package.json

Author: miquelbeltran

README.md

@@ -126,21 +126,6 @@ client.send(error)
   });
 ```
 
-### Legacy `sendWithCallback`
-
-```javascript
-client.sendWithCallback(new Error(), {}, function (response){ });
-```
-
-The client still provides a legacy `send()` method that supports callbacks instead of `Promises`.
-
-**This method is deprecated and will be removed in the future.**
-
-The callback should be a node-style callback: `function(err, response) { /*...*/ }`.
-*Note*: If the callback only takes one parameter (`function(response){ /*...*/ }`)
-it will only be called when the transmission is successful. This is included for
-backwards compatibility; the Node-style callback should be preferred.
-
 ### Send Parameters
 
 The `send()` method accepts a series of optional named parameters, defined as follows:
@@ -227,11 +212,10 @@ You can attach user information to every Raygun Crash Report.
 It will be transmitted with the error sent, and a count of affected customers will appear on the dashboard in the error group view.
 If you provide an email address, and the user has associated a Gravatar with it, their picture will be also displayed.
 
-This package offers three different ways to do that:
+This package offers two different ways to do that:
 
 1. Provide the `userInfo` parameter in the `send()` method.
 2. Implement the `user(request)` method.
-3. Call to the `setUser(user)` method (not recommended and deprecated).
 
 #### User information object
 
@@ -263,7 +247,7 @@ userInfo = {
 For legacy support reasons, you can also provide the `string` identifier directly as the user information:
 
 ```js
-setUser("123");
+raygunClient.send(error, { userInfo: "123" });
 ```
 
 #### `userInfo` parameter in `send()`
@@ -274,7 +258,7 @@ Provide the `userInfo` optional parameter in the `send()` method call:
 client.send(new Error(), { userInfo });
 ```
 
-This provided user information will take priority over the `user(request)` and `setUser(user)` methods.
+This provided user information will take priority over the `user(request)` method.
 
 #### Implement `raygunClient.user(req)`
 
@@ -302,13 +286,6 @@ raygunClient.user = function (req) {
 **Param**: *req*: the current request.
 **Returns**: The current user's identifier, or an object that describes the user.
 
-#### Global `setUser(user)` method (Deprecated)
-
-You can set the user information globally by calling `setUser(user)` and providing the user information.
-
-This is not recommended, the method has been marked as _deprecated_ and will be eventually removed.
-It is advised to update your code to set it with the `user(request)` method or provide the `userInfo` in the `send()` call.
-
 ### Version tracking
 
 Call setVersion(*string*) on a RaygunClient to set the version of the calling application. This is expected to be of the format x.x.x.x, where x is a positive integer. The version will be visible in the dashboard.

lib/raygun.ts

@@ -10,8 +10,6 @@
 
 import {
   BreadcrumbMessage,
-  callVariadicCallback,
-  Callback,
   CustomData,
   Hook,
   Message,
@@ -151,7 +149,6 @@ class Raygun {
     }
 
     this.expressHandler = this.expressHandler.bind(this);
-    this.sendWithCallback = this.sendWithCallback.bind(this);
     this.send = this.send.bind(this);
 
     this._offlineStorage =
@@ -173,16 +170,6 @@ class Raygun {
     return null;
   }
 
-  /**
-   * Sets a user globally.
-   * @deprecated Implement user(request) callback or provide userInfo in send() method call instead
-   * @param user - as RawUserData
-   */
-  setUser(user: UserMessageData) {
-    this._user = user;
-    return this;
-  }
-
   /**
    * If you're using the `raygunClient.expressHandler`, you can send custom data along by setting this function.
    *
@@ -362,36 +349,6 @@ class Raygun {
     }
   }
 
-  /**
-   * @deprecated sendWithCallback is a deprecated method. Instead, use send, which supports async/await calls.
-   *
-   * See: https://github.com/MindscapeHQ/raygun4node/issues/262
-   */
-  sendWithCallback(
-    exception: Error | string,
-    customData?: CustomData,
-    callback?: Callback<IncomingMessage>,
-    request?: RequestParams,
-    tags?: Tag[],
-  ) {
-    // call async send but redirect response to provided legacy callback
-    this.send(exception, {
-      customData,
-      request,
-      tags,
-    })
-      .then((response) => {
-        if (callback) {
-          callVariadicCallback(callback, null, response);
-        }
-      })
-      .catch((error) => {
-        if (callback) {
-          callVariadicCallback(callback, error, null);
-        }
-      });
-  }
-
   private reportUncaughtExceptions() {
     const [major, minor] = process.versions.node
       .split(".")

lib/types.ts

@@ -193,31 +193,6 @@ export type RaygunOptions = {
   reportUncaughtExceptions?: boolean;
 };
 
-// TODO: Remove all Callback related types when sendWithCallback is finally removed
-// See: https://github.com/MindscapeHQ/raygun4node/issues/262
-export type CallbackNoError<T> = (t: T | null) => void;
-export type CallbackWithError<T> = (e: Error | null, t: T | null) => void;
-
-export function isCallbackWithError<T>(
-  cb: Callback<T>,
-): cb is CallbackWithError<T> {
-  return cb.length > 1;
-}
-
-export function callVariadicCallback<T>(
-  callback: Callback<T>,
-  error: Error | null,
-  result: T | null,
-) {
-  if (isCallbackWithError(callback)) {
-    return callback(error, result);
-  } else {
-    return callback(result);
-  }
-}
-
-export type Callback<T> = CallbackNoError<T> | CallbackWithError<T>;
-
 /**
  * Internal type, sent to the Raygun API as part of MessageDetails
  */

package-lock.json

@@ -35,7 +35,6 @@ test("async send complex", {}, function (t) {
 
   let client = new Raygun.Client()
     .init({ apiKey: API_KEY })
-    .setUser("callum@mindscape.co.nz")
     .setVersion("1.0.0.0");
 
   client