nylas 6.9.0 → 6.10.0

package/lib/models/webhook-notification.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import Model from './model';
 import { Attribute } from './attributes';
 export declare type LinkClickProperties = {
@@ -121,4 +122,12 @@ export default class WebhookNotification extends Model implements WebhookNotific
     deltas: WebhookDelta[];
     static attributes: Record<string, Attribute>;
     constructor(props?: WebhookNotificationProperties);
+    /**
+     * Verify incoming webhook signature came from Nylas
+     * @param xNylasSignature The signature to verify
+     * @param rawBody The raw body from the payload
+     * @param clientSecret Overriding client secret of the app receiving the webhook
+     * @return true if the webhook signature was verified from Nylas
+     */
+    static verifyWebhookSignature(xNylasSignature: string, rawBody: Buffer, clientSecret?: string): boolean;
 }

package/lib/models/webhook-notification.js

@@ -15,9 +15,18 @@ var __extends = (this && this.__extends) || (function () {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var crypto_1 = __importDefault(require("crypto"));
 var model_1 = __importDefault(require("./model"));
 var attributes_1 = __importDefault(require("./attributes"));
+var config = __importStar(require("../config"));
 var LinkClick = /** @class */ (function (_super) {
     __extends(LinkClick, _super);
     function LinkClick(props) {
@@ -276,6 +285,24 @@ var WebhookNotification = /** @class */ (function (_super) {
         _this.initAttributes(props);
         return _this;
     }
+    /**
+     * Verify incoming webhook signature came from Nylas
+     * @param xNylasSignature The signature to verify
+     * @param rawBody The raw body from the payload
+     * @param clientSecret Overriding client secret of the app receiving the webhook
+     * @return true if the webhook signature was verified from Nylas
+     */
+    WebhookNotification.verifyWebhookSignature = function (xNylasSignature, rawBody, clientSecret) {
+        var clientSecretToUse = clientSecret || config.clientSecret;
+        if (!clientSecretToUse) {
+            throw new Error('Client secret is required to verify webhook signature');
+        }
+        var digest = crypto_1.default
+            .createHmac('sha256', clientSecretToUse)
+            .update(rawBody)
+            .digest('hex');
+        return digest === xNylasSignature;
+    };
     WebhookNotification.attributes = {
         deltas: attributes_1.default.Collection({
             modelKey: 'deltas',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "6.9.0",
+  "version": "6.10.0",
   "description": "A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.",
   "main": "lib/nylas.js",
   "types": "lib/nylas.d.ts",