nylas 7.3.0 → 7.4.0

package/lib/cjs/resources/drafts.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Drafts = void 0;
 const messages_js_1 = require("./messages.js");
 const resource_js_1 = require("./resource.js");
+const utils_js_1 = require("../utils.js");
 /**
  * Nylas Drafts API
  *
@@ -34,11 +35,11 @@ class Drafts extends resource_js_1.Resource {
      * Return a Draft
      * @return The draft
      */
-    create({ identifier, requestBody, overrides, }) {
+    async create({ identifier, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/drafts`;
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= messages_js_1.Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             const form = messages_js_1.Messages._buildFormRequest(requestBody);
@@ -49,6 +50,13 @@ class Drafts extends resource_js_1.Resource {
                 overrides,
             });
         }
+        else if (requestBody.attachments) {
+            const processedAttachments = await (0, utils_js_1.encodeAttachmentStreams)(requestBody.attachments);
+            requestBody = {
+                ...requestBody,
+                attachments: processedAttachments,
+            };
+        }
         return super._create({
             path,
             requestBody,
@@ -59,11 +67,11 @@ class Drafts extends resource_js_1.Resource {
      * Update a Draft
      * @return The updated draft
      */
-    update({ identifier, draftId, requestBody, overrides, }) {
+    async update({ identifier, draftId, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/drafts/${draftId}`;
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= messages_js_1.Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             const form = messages_js_1.Messages._buildFormRequest(requestBody);
@@ -74,6 +82,13 @@ class Drafts extends resource_js_1.Resource {
                 overrides,
             });
         }
+        else if (requestBody.attachments) {
+            const processedAttachments = await (0, utils_js_1.encodeAttachmentStreams)(requestBody.attachments);
+            requestBody = {
+                ...requestBody,
+                attachments: processedAttachments,
+            };
+        }
         return super._update({
             path,
             requestBody,

package/lib/cjs/resources/messages.js

@@ -62,7 +62,7 @@ class Messages extends resource_js_1.Resource {
      * Send an email
      * @return The sent message
      */
-    send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/messages/send`;
         const requestOptions = {
             method: 'POST',
@@ -70,14 +70,23 @@ class Messages extends resource_js_1.Resource {
             overrides,
         };
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             requestOptions.form = Messages._buildFormRequest(requestBody);
         }
         else {
-            requestOptions.body = requestBody;
+            if (requestBody.attachments) {
+                const processedAttachments = await (0, utils_js_1.encodeAttachmentStreams)(requestBody.attachments);
+                requestOptions.body = {
+                    ...requestBody,
+                    attachments: processedAttachments,
+                };
+            }
+            else {
+                requestOptions.body = requestBody;
+            }
         }
         return this.apiClient.request(requestOptions);
     }
@@ -111,6 +120,18 @@ class Messages extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Remove extra information from a list of messages
+     * @return The list of cleaned messages
+     */
+    cleanMessages({ identifier, requestBody, overrides, }) {
+        return this.apiClient.request({
+            method: 'PUT',
+            path: `/v3/grants/${identifier}/messages/clean`,
+            body: requestBody,
+            overrides,
+        });
+    }
     static _buildFormRequest(requestBody) {
         let form;
         // FormData imports are funky, cjs needs to use .default, es6 doesn't

package/lib/cjs/utils.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objKeysToSnakeCase = exports.objKeysToCamelCase = exports.createFileRequestBuilder = void 0;
+exports.objKeysToSnakeCase = exports.objKeysToCamelCase = exports.encodeAttachmentStreams = exports.createFileRequestBuilder = void 0;
 const change_case_1 = require("change-case");
 const fs = require("fs");
 const path = require("path");
 const mime = require("mime-types");
+const stream_1 = require("stream");
 function createFileRequestBuilder(filePath) {
     const stats = fs.statSync(filePath);
     const filename = path.basename(filePath);
@@ -18,6 +19,40 @@ function createFileRequestBuilder(filePath) {
     };
 }
 exports.createFileRequestBuilder = createFileRequestBuilder;
+/**
+ * Converts a ReadableStream to a base64 encoded string.
+ * @param stream The ReadableStream containing the binary data.
+ * @returns The stream base64 encoded to a string.
+ */
+function streamToBase64(stream) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream.on('data', (chunk) => {
+            chunks.push(chunk);
+        });
+        stream.on('end', () => {
+            const base64 = Buffer.concat(chunks).toString('base64');
+            resolve(base64);
+        });
+        stream.on('error', err => {
+            reject(err);
+        });
+    });
+}
+/**
+ * Encodes the content of each attachment stream to base64.
+ * @param attachments The attachments to encode.
+ * @returns The attachments with their content encoded to base64.
+ */
+async function encodeAttachmentStreams(attachments) {
+    return await Promise.all(attachments.map(async (attachment) => {
+        const base64EncodedContent = attachment.content instanceof stream_1.Readable
+            ? await streamToBase64(attachment.content)
+            : attachment.content;
+        return { ...attachment, content: base64EncodedContent }; // Replace the stream with its base64 string
+    }));
+}
+exports.encodeAttachmentStreams = encodeAttachmentStreams;
 /**
  * Applies the casing function and ensures numeric parts are preceded by underscores in snake_case.
  * @param casingFunction The original casing function.

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.3.0';
+exports.SDK_VERSION = '7.4.0';

package/lib/esm/resources/drafts.js

@@ -1,5 +1,6 @@
 import { Messages } from './messages.js';
 import { Resource } from './resource.js';
+import { encodeAttachmentStreams } from '../utils.js';
 /**
  * Nylas Drafts API
  *
@@ -31,11 +32,11 @@ export class Drafts extends Resource {
      * Return a Draft
      * @return The draft
      */
-    create({ identifier, requestBody, overrides, }) {
+    async create({ identifier, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/drafts`;
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             const form = Messages._buildFormRequest(requestBody);
@@ -46,6 +47,13 @@ export class Drafts extends Resource {
                 overrides,
             });
         }
+        else if (requestBody.attachments) {
+            const processedAttachments = await encodeAttachmentStreams(requestBody.attachments);
+            requestBody = {
+                ...requestBody,
+                attachments: processedAttachments,
+            };
+        }
         return super._create({
             path,
             requestBody,
@@ -56,11 +64,11 @@ export class Drafts extends Resource {
      * Update a Draft
      * @return The updated draft
      */
-    update({ identifier, draftId, requestBody, overrides, }) {
+    async update({ identifier, draftId, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/drafts/${draftId}`;
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             const form = Messages._buildFormRequest(requestBody);
@@ -71,6 +79,13 @@ export class Drafts extends Resource {
                 overrides,
             });
         }
+        else if (requestBody.attachments) {
+            const processedAttachments = await encodeAttachmentStreams(requestBody.attachments);
+            requestBody = {
+                ...requestBody,
+                attachments: processedAttachments,
+            };
+        }
         return super._update({
             path,
             requestBody,

package/lib/esm/resources/messages.js

@@ -1,6 +1,6 @@
 import { Resource } from './resource.js';
 import * as FormData from 'form-data';
-import { objKeysToSnakeCase } from '../utils.js';
+import { encodeAttachmentStreams, objKeysToSnakeCase } from '../utils.js';
 import { SmartCompose } from './smartCompose.js';
 /**
  * Nylas Messages API
@@ -59,7 +59,7 @@ export class Messages extends Resource {
      * Send an email
      * @return The sent message
      */
-    send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, overrides, }) {
         const path = `/v3/grants/${identifier}/messages/send`;
         const requestOptions = {
             method: 'POST',
@@ -67,14 +67,23 @@ export class Messages extends Resource {
             overrides,
         };
         // Use form data only if the attachment size is greater than 3mb
-        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
-            return attachment.size || 0;
+        const attachmentSize = requestBody.attachments?.reduce((total, attachment) => {
+            return total + (attachment.size || 0);
         }, 0) || 0;
         if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
             requestOptions.form = Messages._buildFormRequest(requestBody);
         }
         else {
-            requestOptions.body = requestBody;
+            if (requestBody.attachments) {
+                const processedAttachments = await encodeAttachmentStreams(requestBody.attachments);
+                requestOptions.body = {
+                    ...requestBody,
+                    attachments: processedAttachments,
+                };
+            }
+            else {
+                requestOptions.body = requestBody;
+            }
         }
         return this.apiClient.request(requestOptions);
     }
@@ -108,6 +117,18 @@ export class Messages extends Resource {
             overrides,
         });
     }
+    /**
+     * Remove extra information from a list of messages
+     * @return The list of cleaned messages
+     */
+    cleanMessages({ identifier, requestBody, overrides, }) {
+        return this.apiClient.request({
+            method: 'PUT',
+            path: `/v3/grants/${identifier}/messages/clean`,
+            body: requestBody,
+            overrides,
+        });
+    }
     static _buildFormRequest(requestBody) {
         let form;
         // FormData imports are funky, cjs needs to use .default, es6 doesn't

package/lib/esm/utils.js

@@ -2,6 +2,7 @@ import { camelCase, snakeCase } from 'change-case';
 import * as fs from 'fs';
 import * as path from 'path';
 import * as mime from 'mime-types';
+import { Readable } from 'stream';
 export function createFileRequestBuilder(filePath) {
     const stats = fs.statSync(filePath);
     const filename = path.basename(filePath);
@@ -14,6 +15,39 @@ export function createFileRequestBuilder(filePath) {
         size: stats.size,
     };
 }
+/**
+ * Converts a ReadableStream to a base64 encoded string.
+ * @param stream The ReadableStream containing the binary data.
+ * @returns The stream base64 encoded to a string.
+ */
+function streamToBase64(stream) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream.on('data', (chunk) => {
+            chunks.push(chunk);
+        });
+        stream.on('end', () => {
+            const base64 = Buffer.concat(chunks).toString('base64');
+            resolve(base64);
+        });
+        stream.on('error', err => {
+            reject(err);
+        });
+    });
+}
+/**
+ * Encodes the content of each attachment stream to base64.
+ * @param attachments The attachments to encode.
+ * @returns The attachments with their content encoded to base64.
+ */
+export async function encodeAttachmentStreams(attachments) {
+    return await Promise.all(attachments.map(async (attachment) => {
+        const base64EncodedContent = attachment.content instanceof Readable
+            ? await streamToBase64(attachment.content)
+            : attachment.content;
+        return { ...attachment, content: base64EncodedContent }; // Replace the stream with its base64 string
+    }));
+}
 /**
  * Applies the casing function and ensures numeric parts are preceded by underscores in snake_case.
  * @param casingFunction The original casing function.

package/lib/esm/version.js

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

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

@@ -34,8 +34,9 @@ interface BaseAttachment {
 export interface CreateAttachmentRequest extends BaseAttachment {
     /**
      * Content of the attachment.
+     * It can either be a readable stream or a base64 encoded string.
      */
-    content: NodeJS.ReadableStream;
+    content: NodeJS.ReadableStream | string;
 }
 /**
  * Interface of an attachment object from Nylas.

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

@@ -158,6 +158,10 @@ export interface CodeExchangeResponse {
      * Currently always Bearer.
      */
     tokenType?: string;
+    /**
+     * The provider that the code was exchanged with.
+     */
+    provider?: Provider;
 }
 /**
  * Interface representing the object used to set parameters for detecting a provider.

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

@@ -273,3 +273,41 @@ export interface FindMessageQueryParams {
      */
     fields?: MessageFields;
 }
+/**
+ * Interface representing the request to clean a message.
+ */
+export interface CleanMessagesRequest {
+    /**
+     * IDs of the email messages to clean.
+     */
+    messageId: string[];
+    /**
+     * If true, removes link-related tags (<a>) from the email message while keeping the text.
+     */
+    ignoreLinks?: boolean;
+    /**
+     * If true, removes images from the email message.
+     */
+    ignoreImages?: boolean;
+    /**
+     * If true, converts images in the email message to Markdown.
+     */
+    imagesAsMarkdown?: boolean;
+    /**
+     * If true, removes table-related tags (<table>, <th>, <td>, <tr>) from the email message while keeping rows.
+     */
+    ignoreTables?: boolean;
+    /**
+     * If true, removes phrases such as "Best" and "Regards" in the email message signature.
+     */
+    removeConclusionPhrases?: boolean;
+}
+/**
+ * Interface representing the response after cleaning a message.
+ */
+export interface CleanMessagesResponse extends Message {
+    /**
+     * The cleaned HTML message body.
+     */
+    conversation: string;
+}

package/lib/types/resources/messages.d.ts

@@ -1,5 +1,5 @@
 import { AsyncListResponse, Resource } from './resource.js';
-import { FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
+import { CleanMessagesRequest, CleanMessagesResponse, FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
 import { Overrides } from '../config.js';
 import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
 import { CreateDraftRequest, SendMessageRequest, UpdateDraftRequest } from '../models/drafts.js';
@@ -77,6 +77,15 @@ export interface FindScheduledMessageParams {
  * @property scheduleId The id of the scheduled message to destroy.
  */
 export type StopScheduledMessageParams = FindScheduledMessageParams;
+/**
+ * The parameters for the {@link Messages.cleanMessages} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The values to clean the message with
+ */
+export interface CleanMessagesParams {
+    identifier: string;
+    requestBody: CleanMessagesRequest;
+}
 /**
  * Nylas Messages API
  *
@@ -126,5 +135,10 @@ export declare class Messages extends Resource {
      * @return The confirmation of the stopped scheduled message
      */
     stopScheduledMessage({ identifier, scheduleId, overrides, }: StopScheduledMessageParams & Overrides): Promise<NylasResponse<StopScheduledMessageResponse>>;
+    /**
+     * Remove extra information from a list of messages
+     * @return The list of cleaned messages
+     */
+    cleanMessages({ identifier, requestBody, overrides, }: CleanMessagesParams & Overrides): Promise<NylasListResponse<CleanMessagesResponse>>;
     static _buildFormRequest(requestBody: CreateDraftRequest | UpdateDraftRequest | SendMessageRequest): FormData;
 }

package/lib/types/utils.d.ts

@@ -1,5 +1,11 @@
 import { CreateAttachmentRequest } from './models/attachments.js';
 export declare function createFileRequestBuilder(filePath: string): CreateAttachmentRequest;
+/**
+ * Encodes the content of each attachment stream to base64.
+ * @param attachments The attachments to encode.
+ * @returns The attachments with their content encoded to base64.
+ */
+export declare function encodeAttachmentStreams(attachments: CreateAttachmentRequest[]): Promise<CreateAttachmentRequest[]>;
 /**
  * A utility function that recursively converts all keys in an object to camelCase.
  * @param obj The object to convert

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.3.0";
+export declare const SDK_VERSION = "7.4.0";

package/package.json

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