crisp-api 6.2.0 → 6.3.0

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## v6.3.0
+
+### New Features
+
+* Added the new `CrispClient.rebind` method, which requests the RTM API to rebind to newly installed/subscribed websites (depending on the authentication tier).
+
 ## v6.2.0
 
 ### New Features

package/README.md

@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2022 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 22/07/2022
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 29/07/2022
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -2217,7 +2217,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```
       </details>
 
-  * **Get Subscription Details** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
+  * **Get Subscription Details** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
     * `CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)`
     * <details>
       <summary>See Example</summary>
@@ -2386,7 +2386,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
 
 You can bind to realtime events from Crisp, in order to get notified of incoming messages and updates in websites.
 
-You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically. This method returns a `Promise` object.
+Before you start with RTM events, please consider the following:
+
+* You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically. This method returns a `Promise` object.
+* Whenever the list of websites that your authentication token is entitled to receive events for changes, you will need to call `CrispClient.rebind()`. This method also returns a `Promise` object.
 
 Available events are listed below:
 

package/lib/crisp.js

@@ -24,6 +24,7 @@ Crisp.DEFAULT_SOCKET_RECONNECT_DELAY     = 5000;
 Crisp.DEFAULT_SOCKET_RECONNECT_DELAY_MAX = 10000;
 Crisp.DEFAULT_SOCKET_RECONNECT_FACTOR    = 0.75;
 Crisp.DEFAULT_SOCKET_SCHEDULE            = 500;
+Crisp.DEFAULT_EVENT_REBIND_INTERVAL_MIN  = 2500;
 Crisp.DEFAULT_USERAGENT_PREFIX           = "node-crisp-api/";
 
 
@@ -176,6 +177,9 @@ function Crisp() {
   /** @private */
   this._socketScheduler = null;
 
+  /** @private */
+  this._lastEventRebind = null;
+
   /** @private */
   this._socketBindHooks = [];
 
@@ -408,7 +412,7 @@ Crisp.prototype = {
       return this._prepareSocket(
         function(socket, emitter) {
           // Listen for event (once socket is bound)
-          socket.on(event, function(data) {
+          socket.on(event, function(data) {
             emitter.emit(event, data);
           });
         }
@@ -418,6 +422,38 @@ Crisp.prototype = {
     return Promise.resolve();
   },
 
+  /**
+   * Rebind socket events
+   * @memberof Crisp
+   * @method rebind
+   */
+  rebind : function() {
+    if (!this._socket) {
+      throw new Error(
+        "[Crisp] rebind: cannot rebind a socket that is not yet bound"
+      );
+    }
+
+    // Make sure that the library user is not rebinding too frequently (which \
+    //   is illegal)
+    var nowTime = Date.now();
+
+    if (this._lastEventRebind !== null  &&
+          ((nowTime - this._lastEventRebind)  <
+              Crisp.DEFAULT_EVENT_REBIND_INTERVAL_MIN)) {
+      throw new Error(
+        "[Crisp] rebind: cannot rebind, last rebind was requested too recently"
+      );
+    }
+
+    // Rebind to socket events (eg. newly bound websites)
+    this._lastEventRebind = nowTime;
+
+    this._socket.emit("socket:bind", {});
+
+    return Promise.resolve();
+  },
+
   /**
    * Prepare a URI based from path segments
    * @memberof Crisp

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "6.2.0",
+  "version": "6.3.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {

package/types/crisp.d.ts

@@ -25,6 +25,8 @@ declare class Crisp {
     /** @private */
     private _socketScheduler;
     /** @private */
+    private _lastEventRebind;
+    /** @private */
     private _socketBindHooks;
     /** @private */
     private _boundEvents;
@@ -40,6 +42,7 @@ declare class Crisp {
     put: (resource: string, query: object, body: object) => any;
     delete: (resource: string, query: object, body: object) => any;
     on: (event: string, callback: Function) => void;
+    rebind: () => void;
     _prepareRestUrl: (paths: any[]) => string;
     _prepareServices: () => void;
     _prepareResources: (serviceInstance: object, resources: any[]) => void;
@@ -48,7 +51,7 @@ declare class Crisp {
     _emitAuthenticate: () => void;
 }
 declare namespace Crisp {
-    export { DEFAULT_REQUEST_TIMEOUT, DEFAULT_SOCKET_TIMEOUT, DEFAULT_SOCKET_RECONNECT_DELAY, DEFAULT_SOCKET_RECONNECT_DELAY_MAX, DEFAULT_SOCKET_RECONNECT_FACTOR, DEFAULT_SOCKET_SCHEDULE, DEFAULT_USERAGENT_PREFIX, DEFAULT_REST_HOST, DEFAULT_REST_BASE_PATH, DEFAULT_RTM_EVENTS, Crisp };
+    export { DEFAULT_REQUEST_TIMEOUT, DEFAULT_SOCKET_TIMEOUT, DEFAULT_SOCKET_RECONNECT_DELAY, DEFAULT_SOCKET_RECONNECT_DELAY_MAX, DEFAULT_SOCKET_RECONNECT_FACTOR, DEFAULT_SOCKET_SCHEDULE, DEFAULT_EVENT_REBIND_INTERVAL_MIN, DEFAULT_USERAGENT_PREFIX, DEFAULT_REST_HOST, DEFAULT_REST_BASE_PATH, DEFAULT_RTM_EVENTS, Crisp };
 }
 declare var DEFAULT_REQUEST_TIMEOUT: number;
 declare var DEFAULT_SOCKET_TIMEOUT: number;
@@ -56,6 +59,7 @@ declare var DEFAULT_SOCKET_RECONNECT_DELAY: number;
 declare var DEFAULT_SOCKET_RECONNECT_DELAY_MAX: number;
 declare var DEFAULT_SOCKET_RECONNECT_FACTOR: number;
 declare var DEFAULT_SOCKET_SCHEDULE: number;
+declare var DEFAULT_EVENT_REBIND_INTERVAL_MIN: number;
 declare var DEFAULT_USERAGENT_PREFIX: string;
 declare var DEFAULT_REST_HOST: string;
 declare var DEFAULT_REST_BASE_PATH: string;