crisp-api 7.0.0 → 7.2.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## v7.2.0
+
+### New Features
+
+* Automated the package release process via GitHub Actions (ie. `npm publish`).
+
+## v7.1.0
+
+### New Features
+
+* Added `CrispClient.verifyWidget` to verify Widget Events.
+
 ## v7.0.0
 
 ### Breaking Changes

package/README.md

@@ -1,6 +1,6 @@
 # Crisp API Wrapper
 
-[![Test and Build](https://github.com/crisp-im/node-crisp-api/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Test+and+Build%22) [![NPM](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
+[![Test and Build](https://github.com/crisp-im/node-crisp-api/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Test+and+Build%22) [![Build and Release](https://github.com/crisp-im/node-crisp-api/workflows/Build%20and%20Release/badge.svg)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Build+and+Release%22) [![NPM](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
 
 The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
 

package/lib/crisp.js

@@ -524,33 +524,27 @@ Crisp.prototype = {
    */
   verifyHook : function(secret, body, timestamp, signature) {
     if (this._loopback) {
-      // Ensure all provided data is valid
-      if (!secret || !signature || !body || typeof body !== "object"  ||
-            !timestamp || isNaN(timestamp) === true) {
-        return false;
-      }
-
-      // Compute local trace
-      var localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
-
-      // Create local HMAC
-      var localMac = Crypto.createHmac("sha256", secret);
-
-      localMac.update(localTrace);
-
-      // Compute local signature, and compare
-      var localSignature = localMac.digest("hex");
-
-      return (
-        (signature === localSignature) ? true : false
-      );
+      return this._verifySignature(secret, body, timestamp, signature);
     }
 
-    // Default: not verified (signatures do not match or loopback not /yet?/ \
-    //   bound)
+    // Default: not verified (loopback not /yet?/ bound)
     return false;
   },
 
+  /**
+   * Verifies an event string and checks that signatures match (used for \
+   *   Widgets)
+   * @memberof Crisp
+   * @method verifyWidget
+   * @param {string} secret
+   * @param {object} body
+   * @param {string} timestamp
+   * @param {string} signature
+   */
+  verifyWidget : function(secret, body, timestamp, signature) {
+    return this._verifySignature(secret, body, timestamp, signature);
+  },
+
   /**
    * Rebinds socket events (used for WebSockets)
    * @memberof Crisp
@@ -1001,6 +995,39 @@ Crisp.prototype = {
     // Other methods must hold a response body, therefore we can fallback on \
     //   an HTTP error if we fail to acquire any reason at all.
     return ((response.body || {}).reason || "http_error");
+  },
+
+  /**
+   * Verifies an event string and checks that signatures match
+   * @memberof Crisp
+   * @private
+   * @method verifyHook
+   * @param {string} secret
+   * @param {object} body
+   * @param {string} timestamp
+   * @param {string} signature
+   */
+  _verifySignature : function(secret, body, timestamp, signature) {
+    // Ensure all provided data is valid
+    if (!secret || !signature || !body || typeof body !== "object"  ||
+          !timestamp || isNaN(timestamp) === true) {
+      return false;
+    }
+
+    // Compute local trace
+    var localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
+
+    // Create local HMAC
+    var localMac = Crypto.createHmac("sha256", secret);
+
+    localMac.update(localTrace);
+
+    // Compute local signature, and compare
+    var localSignature = localMac.digest("hex");
+
+    return (
+      (signature === localSignature) ? true : false
+    );
   }
 };
 

package/package.json

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