nylas 7.7.4 → 7.8.0-canary.1

package/lib/cjs/apiClient.js

@@ -87,15 +87,21 @@ class APIClient {
                     // Check if the request is an authentication request
                     const isAuthRequest = options.path.includes('connect/token') ||
                         options.path.includes('connect/revoke');
+                    const headers = response?.headers?.entries
+                        ? Object.fromEntries(response.headers.entries())
+                        : {};
+                    const flowId = headers['x-flow-id'];
+                    const requestId = headers['x-request-id'];
                     if (isAuthRequest) {
-                        error = new error_js_1.NylasOAuthError(camelCaseError, response.status);
+                        error = new error_js_1.NylasOAuthError(camelCaseError, response.status, requestId, flowId, headers);
                     }
                     else {
-                        error = new error_js_1.NylasApiError(camelCaseError, response.status);
+                        error = new error_js_1.NylasApiError(camelCaseError, response.status, requestId, flowId, headers);
                     }
                 }
                 catch (e) {
-                    throw new Error(`Received an error but could not parse response from the server: ${text}`);
+                    const flowId = response?.headers?.get('x-flow-id') || undefined;
+                    throw new Error(`Received an error but could not parse response from the server${flowId ? ` with flow ID ${flowId}` : ''}: ${text}`);
                 }
                 throw error;
             }
@@ -137,9 +143,16 @@ class APIClient {
         });
     }
     async requestWithResponse(response) {
+        const headers = response?.headers?.entries
+            ? Object.fromEntries(response.headers.entries())
+            : {};
+        const flowId = headers['x-flow-id'];
         const text = await response.text();
         try {
             const responseJSON = JSON.parse(text);
+            // Inject the flow ID and headers into the response
+            responseJSON.flowId = flowId;
+            responseJSON.headers = headers;
             return (0, utils_js_1.objKeysToCamelCase)(responseJSON, ['metadata']);
         }
         catch (e) {

package/lib/cjs/models/error.js

@@ -17,10 +17,12 @@ exports.AbstractNylasSdkError = AbstractNylasSdkError;
  * Class representation of a general Nylas API error.
  */
 class NylasApiError extends AbstractNylasApiError {
-    constructor(apiError, statusCode) {
+    constructor(apiError, statusCode, requestId, flowId, headers) {
         super(apiError.error.message);
         this.type = apiError.error.type;
-        this.requestId = apiError.requestId;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
         this.providerError = apiError.error.providerError;
         this.statusCode = statusCode;
     }
@@ -30,13 +32,16 @@ exports.NylasApiError = NylasApiError;
  * Class representing an OAuth error returned by the Nylas API.
  */
 class NylasOAuthError extends AbstractNylasApiError {
-    constructor(apiError, statusCode) {
+    constructor(apiError, statusCode, requestId, flowId, headers) {
         super(apiError.errorDescription);
         this.error = apiError.error;
         this.errorCode = apiError.errorCode;
         this.errorDescription = apiError.errorDescription;
         this.errorUri = apiError.errorUri;
         this.statusCode = statusCode;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
     }
 }
 exports.NylasOAuthError = NylasOAuthError;
@@ -44,10 +49,13 @@ exports.NylasOAuthError = NylasOAuthError;
  * Error thrown when the Nylas SDK times out before receiving a response from the server
  */
 class NylasSdkTimeoutError extends AbstractNylasSdkError {
-    constructor(url, timeout) {
+    constructor(url, timeout, requestId, flowId, headers) {
         super('Nylas SDK timed out before receiving a response from the server.');
         this.url = url;
         this.timeout = timeout;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
     }
 }
 exports.NylasSdkTimeoutError = NylasSdkTimeoutError;

package/lib/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 // This file is generated by scripts/exportVersion.js
-exports.SDK_VERSION = '7.7.4';
+exports.SDK_VERSION = '7.8.0-canary.1';

package/lib/esm/apiClient.js

@@ -85,15 +85,21 @@ export default class APIClient {
                     // Check if the request is an authentication request
                     const isAuthRequest = options.path.includes('connect/token') ||
                         options.path.includes('connect/revoke');
+                    const headers = response?.headers?.entries
+                        ? Object.fromEntries(response.headers.entries())
+                        : {};
+                    const flowId = headers['x-flow-id'];
+                    const requestId = headers['x-request-id'];
                     if (isAuthRequest) {
-                        error = new NylasOAuthError(camelCaseError, response.status);
+                        error = new NylasOAuthError(camelCaseError, response.status, requestId, flowId, headers);
                     }
                     else {
-                        error = new NylasApiError(camelCaseError, response.status);
+                        error = new NylasApiError(camelCaseError, response.status, requestId, flowId, headers);
                     }
                 }
                 catch (e) {
-                    throw new Error(`Received an error but could not parse response from the server: ${text}`);
+                    const flowId = response?.headers?.get('x-flow-id') || undefined;
+                    throw new Error(`Received an error but could not parse response from the server${flowId ? ` with flow ID ${flowId}` : ''}: ${text}`);
                 }
                 throw error;
             }
@@ -135,9 +141,16 @@ export default class APIClient {
         });
     }
     async requestWithResponse(response) {
+        const headers = response?.headers?.entries
+            ? Object.fromEntries(response.headers.entries())
+            : {};
+        const flowId = headers['x-flow-id'];
         const text = await response.text();
         try {
             const responseJSON = JSON.parse(text);
+            // Inject the flow ID and headers into the response
+            responseJSON.flowId = flowId;
+            responseJSON.headers = headers;
             return objKeysToCamelCase(responseJSON, ['metadata']);
         }
         catch (e) {

package/lib/esm/models/error.js

@@ -12,10 +12,12 @@ export class AbstractNylasSdkError extends Error {
  * Class representation of a general Nylas API error.
  */
 export class NylasApiError extends AbstractNylasApiError {
-    constructor(apiError, statusCode) {
+    constructor(apiError, statusCode, requestId, flowId, headers) {
         super(apiError.error.message);
         this.type = apiError.error.type;
-        this.requestId = apiError.requestId;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
         this.providerError = apiError.error.providerError;
         this.statusCode = statusCode;
     }
@@ -24,22 +26,28 @@ export class NylasApiError extends AbstractNylasApiError {
  * Class representing an OAuth error returned by the Nylas API.
  */
 export class NylasOAuthError extends AbstractNylasApiError {
-    constructor(apiError, statusCode) {
+    constructor(apiError, statusCode, requestId, flowId, headers) {
         super(apiError.errorDescription);
         this.error = apiError.error;
         this.errorCode = apiError.errorCode;
         this.errorDescription = apiError.errorDescription;
         this.errorUri = apiError.errorUri;
         this.statusCode = statusCode;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
     }
 }
 /**
  * Error thrown when the Nylas SDK times out before receiving a response from the server
  */
 export class NylasSdkTimeoutError extends AbstractNylasSdkError {
-    constructor(url, timeout) {
+    constructor(url, timeout, requestId, flowId, headers) {
         super('Nylas SDK timed out before receiving a response from the server.');
         this.url = url;
         this.timeout = timeout;
+        this.requestId = requestId;
+        this.flowId = flowId;
+        this.headers = headers;
     }
 }

package/lib/esm/version.js

@@ -1,2 +1,2 @@
 // This file is generated by scripts/exportVersion.js
-export const SDK_VERSION = '7.7.4';
+export const SDK_VERSION = '7.8.0-canary.1';

package/lib/types/models/error.d.ts

@@ -10,6 +10,15 @@ export declare abstract class AbstractNylasApiError extends Error {
      * The HTTP status code of the error response.
      */
     statusCode?: number;
+    /**
+     * The flow ID
+     * Provide this to Nylas support to help trace requests and responses
+     */
+    flowId?: string | null;
+    /**
+     * The response headers
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Base class for all Nylas SDK errors.
@@ -28,7 +37,7 @@ export declare class NylasApiError extends AbstractNylasApiError implements Nyla
      * Provider Error.
      */
     providerError: any;
-    constructor(apiError: NylasApiErrorResponse, statusCode?: number);
+    constructor(apiError: NylasApiErrorResponse, statusCode?: number, requestId?: string, flowId?: string, headers?: Record<string, string>);
 }
 /**
  * Class representing an OAuth error returned by the Nylas API.
@@ -50,7 +59,7 @@ export declare class NylasOAuthError extends AbstractNylasApiError implements Ny
      * URL to the related documentation and troubleshooting regarding this error.
      */
     errorUri: string;
-    constructor(apiError: NylasOAuthErrorResponse, statusCode?: number);
+    constructor(apiError: NylasOAuthErrorResponse, statusCode?: number, requestId?: string, flowId?: string, headers?: Record<string, string>);
 }
 /**
  * Error thrown when the Nylas SDK times out before receiving a response from the server
@@ -64,7 +73,20 @@ export declare class NylasSdkTimeoutError extends AbstractNylasSdkError {
      * The timeout value set in the Nylas SDK, in seconds
      */
     timeout: number;
-    constructor(url: string, timeout: number);
+    /**
+     * The request ID
+     */
+    requestId?: string;
+    /**
+     * The flow ID
+     * Provide this to Nylas support to help trace requests and responses
+     */
+    flowId?: string;
+    /**
+     * The response headers
+     */
+    headers?: Record<string, string>;
+    constructor(url: string, timeout: number, requestId?: string, flowId?: string, headers?: Record<string, string>);
 }
 /**
  * Interface representing the error response from the Nylas API.
@@ -72,6 +94,8 @@ export declare class NylasSdkTimeoutError extends AbstractNylasSdkError {
 export interface NylasApiErrorResponse {
     requestId: string;
     error: NylasApiErrorResponseData;
+    flowId?: string;
+    headers?: Record<string, string>;
 }
 /**
  * Interface representing the error data within the response object.

package/lib/types/models/response.d.ts

@@ -16,6 +16,15 @@ export interface NylasResponse<T> {
      * The request ID
      */
     requestId: string;
+    /**
+     * The flow ID
+     * Provide this t
+     */
+    flowId?: string;
+    /**
+     * The response headers
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Interface representation of a Nylas response object that contains a list of objects.

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.7.4";
+export declare const SDK_VERSION = "7.8.0-canary.1";

package/package.json

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