nylas 6.8.0 → 6.10.0

package/lib/config.d.ts

@@ -3,10 +3,17 @@ export declare let apiServer: string | null;
 export declare function setApiServer(newApiServer: string | null): void;
 export declare let clientSecret: string;
 export declare function setClientSecret(newClientSecret: string): void;
+export declare let timeout: number;
+export declare function setTimeout(newTimeout: number): void;
 export declare type NylasConfig = {
+    /** Nylas application client ID */
     clientId: string;
+    /** Nylas application client secret */
     clientSecret: string;
+    /** API Server base URL */
     apiServer?: string;
+    /** Timeout for outgoing API calls, in milliseconds */
+    timeout?: number;
 };
 export declare enum ResponseType {
     CODE = "code",

package/lib/config.js

@@ -12,6 +12,11 @@ function setClientSecret(newClientSecret) {
     exports.clientSecret = newClientSecret;
 }
 exports.setClientSecret = setClientSecret;
+exports.timeout = 0;
+function setTimeout(newTimeout) {
+    exports.timeout = newTimeout;
+}
+exports.setTimeout = setTimeout;
 var ResponseType;
 (function (ResponseType) {
     ResponseType["CODE"] = "code";

package/lib/models/nylas-api-error.js

@@ -42,6 +42,7 @@ var NylasApiError = /** @class */ (function (_super) {
             403: 'Forbidden',
             404: 'Not Found',
             405: 'Method Not Allowed',
+            409: 'Conflict',
             410: 'Gone',
             418: "I'm a Teapot",
             422: 'Sending Error',

package/lib/models/restful-model-collection.d.ts

@@ -2,7 +2,7 @@ import NylasConnection from '../nylas-connection';
 import RestfulModel from './restful-model';
 import ModelCollection from './model-collection';
 export declare type GetCallback = (error: Error | null, result?: RestfulModel) => void;
-export default class RestfulModelCollection<T extends RestfulModel> extends ModelCollection<any> {
+export default class RestfulModelCollection<T extends RestfulModel> extends ModelCollection<T> {
     modelClass: typeof RestfulModel;
     constructor(modelClass: typeof RestfulModel, connection: NylasConnection);
     count(params?: Record<string, unknown>, callback?: (err: Error | null, num?: number) => void): Promise<number>;

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/lib/models/when.d.ts

@@ -3,7 +3,10 @@ import { Attribute } from './attributes';
 export declare type WhenProperties = {
     startTime?: number;
     endTime?: number;
+    startTimezone?: string;
+    endTimezone?: string;
     time?: number;
+    timezone?: string;
     startDate?: string;
     endDate?: string;
     date?: string;
@@ -12,7 +15,10 @@ export declare type WhenProperties = {
 export default class When extends Model implements WhenProperties {
     startTime?: number;
     endTime?: number;
+    startTimezone?: string;
+    endTimezone?: string;
     time?: number;
+    timezone?: string;
     startDate?: string;
     endDate?: string;
     date?: string;

package/lib/models/when.js

@@ -41,9 +41,20 @@ var When = /** @class */ (function (_super) {
             modelKey: 'endTime',
             jsonKey: 'end_time',
         }),
+        startTimezone: attributes_1.default.String({
+            modelKey: 'startTimezone',
+            jsonKey: 'start_timezone',
+        }),
+        endTimezone: attributes_1.default.String({
+            modelKey: 'endTimezone',
+            jsonKey: 'end_timezone',
+        }),
         time: attributes_1.default.Number({
             modelKey: 'time',
         }),
+        timezone: attributes_1.default.String({
+            modelKey: 'timezone',
+        }),
         startDate: attributes_1.default.String({
             modelKey: 'startDate',
             jsonKey: 'start_date',

package/lib/nylas-connection.js

@@ -10,6 +10,9 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+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 = {};
@@ -17,12 +20,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     result["default"] = mod;
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 // TODO since node 10 URL is global
 var url_1 = require("url");
+// TODO since node 15 AbortController is global
+var abort_controller_1 = __importDefault(require("abort-controller"));
 var node_fetch_1 = __importStar(require("node-fetch"));
 var config = __importStar(require("./config"));
 var restful_model_collection_1 = __importDefault(require("./models/restful-model-collection"));
@@ -181,8 +183,16 @@ var NylasConnection = /** @class */ (function () {
     NylasConnection.prototype.request = function (options) {
         var _this = this;
         var req = this.newRequest(options);
+        var controller;
+        var timeout;
+        if (config.timeout && config.timeout !== 0) {
+            controller = new abort_controller_1.default();
+            timeout = setTimeout(function () {
+                controller.abort();
+            }, 150);
+        }
         return new Promise(function (resolve, reject) {
-            return node_fetch_1.default(req)
+            return node_fetch_1.default(req, { signal: controller === null || controller === void 0 ? void 0 : controller.signal })
                 .then(function (response) {
                 if (typeof response === 'undefined') {
                     return reject(new Error('No response'));
@@ -255,8 +265,15 @@ var NylasConnection = /** @class */ (function () {
                 }
             })
                 .catch(function (err) {
+                if (err && err.name && err.name === 'AbortError') {
+                    console.warn('Request timed out');
+                    return reject(err);
+                }
                 console.error("Error encountered during request:\n" + err.stack);
                 return reject(err);
+            })
+                .then(function () {
+                clearTimeout(timeout);
             });
         });
     };

package/lib/nylas.d.ts

@@ -14,6 +14,8 @@ declare class Nylas {
     static set clientSecret(newClientSecret: string);
     static get apiServer(): string | null;
     static set apiServer(newApiServer: string | null);
+    static get timeout(): number;
+    static set timeout(timeout: number);
     static accounts: ManagementModelCollection<ManagementAccount> | RestfulModelCollection<Account>;
     static connect: Connect;
     static webhooks: ManagementModelCollection<Webhook>;

package/lib/nylas.js

@@ -46,6 +46,17 @@ var Nylas = /** @class */ (function () {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(Nylas, "timeout", {
+        get: function () {
+            return config.timeout;
+        },
+        // Timeout for outgoing API calls, in milliseconds
+        set: function (timeout) {
+            config.setTimeout(timeout);
+        },
+        enumerable: true,
+        configurable: true
+    });
     Nylas.config = function (config) {
         if (config.apiServer && config.apiServer.indexOf('://') === -1) {
             throw new Error('Please specify a fully qualified URL for the API Server.');
@@ -62,6 +73,7 @@ var Nylas = /** @class */ (function () {
         else {
             this.apiServer = 'https://api.nylas.com';
         }
+        this.timeout = config.timeout || 0;
         var conn = new nylas_connection_1.default(this.clientSecret, {
             clientId: this.clientId,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "6.8.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",