pusher 5.0.0 → 5.1.1-beta

package/.github/stale.yml

@@ -1,7 +1,7 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 
 # Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 365
+daysUntilStale: 90
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
 # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
@@ -23,4 +23,4 @@ markComment: >
   This issue has been automatically marked as stale because it has not had
   recent activity. It will be closed if no further activity occurs. If you'd
   like this issue to stay open please leave a comment indicating how this issue
-  is affecting you. Thankyou.
+  is affecting you. Thank you.

package/CHANGELOG.md

@@ -1,6 +1,23 @@
+## 5.1.1-beta (2022-06-01)
+
+[FIXED] Updated typescript types with new user features.
+
+## 5.1.0-beta (2022-04-22)
+
+[ADDED] Support for terminating user connections based on user id
+[ADDED] Support for sending messages to users based on user id
+[ADDED] Support for implementing user authentication endpoints
+[DEPRECATED] authenticate function is deprecated. The same functionality (and interface) is now provided by authorizeChannel
+
+## 5.0.1 (2022-01-24)
+
+[FIXED] Incorrect `require` on `version.js` was causing a compilation error in Webpack
+[FIXED] Inconsistent encoding for shared secret between other SDKs
+
 ## 5.0.0 (2021-02-18)
 
 [BREAKING CHANGE] `trigger` now accepts a `params` _object_ instead of a `socket_id` as the third parameter.
+
 [ADDED] Support for requesting channel attributes as part of a `trigger` and `triggerBatch` request via an `info` parameter.
 
 ## 4.0.2 (2020-11-30)
@@ -51,6 +68,7 @@ const pusher = new Pusher.forURL(process.env.PUSHER_URL, {
 [UPGRADED] development dependencies
 
 [ADDED] encryptionMasterKeyBase64 constructor parameter to make it easier to use the full range of 32 byte binary values in encryption key
+
 [DEPRECATED] encryptionMasterKey constructor parameter - use encryptionMasterKeyBase64
 
 ## 3.0.0 (2019-09-26)

package/README.md

@@ -7,9 +7,9 @@ In order to use this library, you need to have an account on <https://pusher.com
 
 ## Supported platforms
 
-This SDK supports **Node.js** version 8+.
+This SDK supports **Node.js** version 10+.
 
-We test the library against a selection of Node.js versions which we update over time. Please refer to [travis.yml](https://github.com/pusher/pusher-http-node/blob/master/.travis.yml) for the set of versions that are currently tested with CI.
+We test the library against a selection of Node.js versions which we update over time. Please refer to [test.yml](https://github.com/pusher/pusher-http-node/blob/master/.github/workflows/test.yml) for the set of versions that are currently tested with CI.
 
 If you find any compatibility issues, please [raise an issue](https://github.com/pusher/pusher-http-node/issues/new) in the repository or contact support at [support@pusher.com](support@pusher.com). We will happily investigate reported problems ❤️.
 
@@ -237,11 +237,11 @@ pusher
   })
 ```
 
-### End-to-end encryption [BETA]
+### End-to-end encryption
 
 This library supports end-to-end encryption of your private channels. This means that only you and your connected clients will be able to read your messages. Pusher cannot decrypt them. You can enable this feature by following these steps:
 
-1. You should first set up Private channels. This involves [creating an authentication endpoint on your server](https://pusher.com/docs/authenticating_users).
+1. You should first set up Private channels. This involves [creating an authorization endpoint on your server](https://pusher.com/docs/authenticating_users).
 
 2. Next, generate your 32 byte master encryption key, encode it as base64 and pass it to the Pusher constructor.
 
@@ -278,17 +278,44 @@ pusher.trigger(["channel-1", "private-encrypted-channel-2"], "test_event", {
 
 Rationale: the methods in this library map directly to individual Channels HTTP API requests. If we allowed triggering a single event on multiple channels (some encrypted, some unencrypted), then it would require two API requests: one where the event is encrypted to the encrypted channels, and one where the event is unencrypted for unencrypted channels.
 
-### Authenticating private channels
+### Authenticating users
 
-To authorise your users to access private channels on Pusher Channels, you can use the `authenticate` function:
+To authenticate users during sign in, you can use the `authenticateUser` function:
 
 ```javascript
-const auth = pusher.authenticate(socketId, channel)
+const userData = {
+  id: "unique_user_id",
+  name: "John Doe",
+  image: "https://...",
+}
+const auth = pusher.authenticateUser(socketId, userData)
+```
+
+The `userData` parameter must contain an `id` property with a non empty string. For more information see: <http://pusher.com/docs/authenticating_users>
+
+### Terminating user connections
+
+In order to terminate a user's connections, the user must have been authenticated. Check the [Server user authentication docs](http://pusher.com/docs/authenticating_users) for the information on how to create a user authentication endpoint.
+
+To terminate all connections established by a given user, you can use the `terminateUserConnections` function:
+
+```javascript
+pusher.terminateUserConnections(userId)
+```
+
+Please note, that it only terminates the user's active connections. This means, if nothing else is done, the user will be able to reconnect. For more information see: [Terminating user connections docs](https://pusher.com/docs/channels/server_api/terminating-user-connections/).
+
+### Private channel authorisation
+
+To authorise your users to access private channels on Pusher Channels, you can use the `authorizeChannel` function:
+
+```javascript
+const auth = pusher.authorizeChannel(socketId, channel)
 ```
 
 For more information see: <http://pusher.com/docs/authenticating_users>
 
-### Authenticating presence channels
+### Presence channel authorisation
 
 Using presence channels is similar to private channels, but you can specify extra data to identify that particular user:
 
@@ -300,7 +327,7 @@ const channelData = {
     twitter_id: '@leggetter'
   }
 };
-const auth = pusher.authenticate(socketId, channel, channelData);
+const auth = pusher.authorizeChannel(socketId, channel, channelData);
 ```
 
 The `auth` is then returned to the caller as JSON.

package/examples/typescript/main.ts

@@ -4,8 +4,7 @@ import * as Pusher from "pusher"
 
 const pusher = Pusher.forURL(process.env.PUSHER_URL, {
   encryptionMasterKeyBase64: Buffer.from(
-    "01234567890123456789012345678901",
-    "binary"
+    "01234567890123456789012345678901"
   ).toString("base64"),
   agent: new Agent({ keepAlive: true }),
 })

package/index.d.ts

@@ -24,11 +24,29 @@ declare class Pusher {
   get(opts: Pusher.GetOptions): Promise<Response>
   post(opts: Pusher.PostOptions): Promise<Response>
 
+  /**
+   * @deprecated Use authorizeChannel
+   */
   authenticate(
     socketId: string,
     channel: string,
     data?: Pusher.PresenceChannelData
-  ): Pusher.AuthResponse
+  ): Pusher.ChannelAuthResponse
+
+  authorizeChannel(
+    socketId: string,
+    channel: string,
+    data?: Pusher.PresenceChannelData
+  ): Pusher.ChannelAuthResponse
+
+  authenticateUser(
+    socketId: string,
+    userData: Pusher.UserChannelData
+  ): Pusher.UserAuthResponse
+
+  sendToUser(userId: string, event: string, data: any): Promise<Response>
+
+  terminateUserConnections(userId: string): Promise<Response>
 
   webhook(request: Pusher.WebHookRequest): Pusher.WebHook
   createSignedQueryString(opts: Pusher.SignedQueryStringOptions): string
@@ -106,12 +124,26 @@ declare namespace Pusher {
     params?: Params
   }
 
+  /**
+   * @deprecated Use ChannelAuthResponse
+   */
   export interface AuthResponse {
     auth: string
     channel_data?: string
     shared_secret?: string
   }
 
+  export interface ChannelAuthResponse {
+    auth: string
+    channel_data?: string
+    shared_secret?: string
+  }
+
+  export interface UserAuthResponse {
+    auth: string
+    user_data: string
+  }
+
   export interface PresenceChannelData {
     user_id: string
     user_info?: {
@@ -119,6 +151,11 @@ declare namespace Pusher {
     }
   }
 
+  export interface UserChannelData {
+    id: string
+    [key: string]: any
+  }
+
   export interface WebHookRequest {
     headers: object
     rawBody: string

package/lib/auth.js

@@ -1,5 +1,14 @@
 const util = require("./util")
 
+function getSocketSignatureForUser(token, socketId, userData) {
+  const serializedUserData = JSON.stringify(userData)
+  const signature = token.sign(`${socketId}::user::${serializedUserData}`)
+  return {
+    auth: `${token.key}:${signature}`,
+    user_data: serializedUserData,
+  }
+}
+
 function getSocketSignature(pusher, token, channel, socketID, data) {
   const result = {}
 
@@ -26,4 +35,5 @@ function getSocketSignature(pusher, token, channel, socketID, data) {
   return result
 }
 
+exports.getSocketSignatureForUser = getSocketSignatureForUser
 exports.getSocketSignature = getSocketSignature

package/lib/config.js

@@ -49,7 +49,7 @@ function Config(options) {
       )
     }
 
-    this.encryptionMasterKey = options.encryptionMasterKey
+    this.encryptionMasterKey = Buffer.from(options.encryptionMasterKey)
   }
 
   // Handle base64 encoded 32 byte key to encourage use of the full range of byte values
@@ -61,10 +61,7 @@ function Config(options) {
       throw new Error("encryptionMasterKeyBase64 must be valid base64")
     }
 
-    const decodedKey = Buffer.from(
-      options.encryptionMasterKeyBase64,
-      "base64"
-    ).toString("binary")
+    const decodedKey = Buffer.from(options.encryptionMasterKeyBase64, "base64")
     if (decodedKey.length !== 32) {
       throw new Error(
         "encryptionMasterKeyBase64 must decode to 32 bytes, but the string " +

package/lib/pusher.js

@@ -34,6 +34,19 @@ const validateSocketId = function (socketId) {
   }
 }
 
+const validateUserId = function (userId) {
+  if (typeof userId !== "string" || userId === "") {
+    throw new Error("Invalid user id: '" + userId + "'")
+  }
+}
+
+const validateUserData = function (userData) {
+  if (userData == null || typeof userData !== "object") {
+    throw new Error("Invalid user data: '" + userData + "'")
+  }
+  validateUserId(userData.id)
+}
+
 /** Provides access to Pusher's REST API, WebHooks and authentication.
  *
  * @constructor
@@ -103,9 +116,9 @@ Pusher.forCluster = function (cluster, options) {
  * @param {String} socketId socket id
  * @param {String} channel channel name
  * @param {Object} [data] additional socket data
- * @returns {String} authentication signature
+ * @returns {String} authorization signature
  */
-Pusher.prototype.authenticate = function (socketId, channel, data) {
+Pusher.prototype.authorizeChannel = function (socketId, channel, data) {
   validateSocketId(socketId)
   validateChannel(channel)
 
@@ -118,6 +131,60 @@ Pusher.prototype.authenticate = function (socketId, channel, data) {
   )
 }
 
+/** Returns a signature for given socket id, channel and socket data.
+ *
+ *  DEPRECATED. Use authorizeChannel.
+ *
+ * @param {String} socketId socket id
+ * @param {String} channel channel name
+ * @param {Object} [data] additional socket data
+ * @returns {String} authorization signature
+ */
+Pusher.prototype.authenticate = Pusher.prototype.authorizeChannel
+
+/** Returns a signature for given socket id and user data.
+ *
+ * @param {String} socketId socket id
+ * @param {Object} userData user data
+ * @returns {String} authentication signature
+ */
+Pusher.prototype.authenticateUser = function (socketId, userData) {
+  validateSocketId(socketId)
+  validateUserData(userData)
+
+  return auth.getSocketSignatureForUser(this.config.token, socketId, userData)
+}
+
+/** Sends an event to a user.
+ *
+ * Event name can be at most 200 characters long.
+ *
+ * @param {String} userId user id
+ * @param {String} event event name
+ * @param data event data, objects are JSON-encoded
+ * @returns {Promise} a promise resolving to a response, or rejecting to a RequestError.
+ * @see RequestError
+ */
+Pusher.prototype.sendToUser = function (userId, event, data) {
+  if (event.length > 200) {
+    throw new Error("Too long event name: '" + event + "'")
+  }
+  validateUserId(userId)
+  return events.trigger(this, [`#server-to-user-${userId}`], event, data)
+}
+
+/** Terminate users's connections.
+ *
+ *
+ * @param {String} userId user id
+ * @returns {Promise} a promise resolving to a response, or rejecting to a RequestError.
+ * @see RequestError
+ */
+Pusher.prototype.terminateUserConnections = function (userId) {
+  validateUserId(userId)
+  return this.post({ path: `/users/${userId}/terminate_connections`, body: {} })
+}
+
 /** Triggers an event.
  *
  * Channel names can contain only characters which are alphanumeric, '_' or '-'
@@ -234,7 +301,9 @@ Pusher.prototype.createSignedQueryString = function (options) {
 Pusher.prototype.channelSharedSecret = function (channel) {
   return crypto
     .createHash("sha256")
-    .update(channel + this.config.encryptionMasterKey)
+    .update(
+      Buffer.concat([Buffer.from(channel), this.config.encryptionMasterKey])
+    )
     .digest()
 }
 

package/lib/version.js

@@ -1 +1 @@
-module.exports = require("../package").version
+module.exports = require("../package.json").version

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pusher",
   "description": "Node.js client to interact with the Pusher Channels REST API",
-  "version": "5.0.0",
+  "version": "5.1.1-beta",
   "author": "Pusher <support@pusher.com>",
   "contributors": [
     {
@@ -54,7 +54,7 @@
     "realtime"
   ],
   "license": "MIT",
-  "repository": "git://github.com/pusher/pusher-rest-node",
+  "repository": "git://github.com/pusher/pusher-http-node",
   "main": "lib/pusher",
   "typings": "index.d.ts",
   "engines": {