This message demonstrates sending attachments using the ${format} format.
+ > {
+ console.log('🌊 Sending attachments using streams...');
+
+ let attachments: CreateAttachmentRequest[] = [];
+ let sizeDescription;
+
+ if (large) {
+ // Send one large attachment
+ const file = fileManager.getLargeFiles()[0];
+ attachments = [{
+ filename: file.filename,
+ contentType: file.contentType,
+ content: file.asStream(),
+ size: file.size,
+ }];
+ sizeDescription = 'large';
+ } else {
+ // Send multiple small attachments
+ const files = fileManager.getSmallFiles().slice(0, 2);
+ attachments = files.map(file => ({
+ filename: file.filename,
+ contentType: file.contentType,
+ content: file.asStream(),
+ size: file.size,
+ }));
+ sizeDescription = 'small';
+ }
+
+ const requestBody: SendMessageRequest = {
+ to: [{ name: 'Test Recipient', email: recipientEmail }],
+ subject: `Nylas SDK - Stream Attachments (${sizeDescription})`,
+ body: `
+ Stream Attachments Example
+ This demonstrates sending attachments using readable streams.
+ Useful when you have streams from other sources.
+ Attachment size: ${sizeDescription} (${attachments.length} file${attachments.length > 1 ? 's' : ''})
+ `,
+ attachments
+ };
+
+ // For large files, use a longer timeout (5 minutes)
+ const overrides = large ? { timeout: 300 } : undefined;
+
+ return await nylas.messages.send({
+ identifier: grantId,
+ requestBody,
+ overrides
+ });
+}
\ No newline at end of file
diff --git a/examples/messages/examples/string-attachments.ts b/examples/messages/examples/string-attachments.ts
new file mode 100644
index 00000000..74f47f35
--- /dev/null
+++ b/examples/messages/examples/string-attachments.ts
@@ -0,0 +1,98 @@
+import * as dotenv from 'dotenv';
+import Nylas, { NylasResponse, Message, SendMessageRequest, CreateAttachmentRequest } from 'nylas';
+import { TestFileManager } from '../utils/attachment-file-manager';
+import * as path from 'path';
+import * as process from 'process';
+
+// Load environment variables from .env file
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+// Initialize the Nylas client
+const nylas = new Nylas({
+ apiKey: process.env.NYLAS_API_KEY || '',
+ apiUri: process.env.NYLAS_API_URI || 'https://api.us.nylas.com'
+});
+
+const grantId: string = process.env.NYLAS_GRANT_ID || '';
+
+/**
+ * Example 4: String Content Attachments (Base64 Encoded Files)
+ *
+ * Perfect for sending existing files as base64 encoded strings.
+ * This example pulls the same files used by other examples but encodes them as base64 strings.
+ */
+export async function sendStringAttachments(fileManager: TestFileManager, recipientEmail: string, large: boolean = false): Promise> {
+ console.log('📝 Sending base64 encoded file attachments as strings...');
+
+ let stringAttachments: CreateAttachmentRequest[] = [];
+ let sizeDescription = '';
+
+ if (large) {
+ // Send one large attachment - use the large PDF file
+ const largeFiles = fileManager.getLargeFiles();
+ if (largeFiles.length > 0) {
+ const file = largeFiles.find(f => f.filename.includes('pdf')) || largeFiles[0];
+ const fileBuffer = file.asBuffer();
+ const base64Content = fileBuffer.toString('base64');
+
+ stringAttachments = [{
+ filename: file.filename,
+ contentType: file.contentType,
+ content: base64Content,
+ size: Buffer.byteLength(base64Content, 'utf8'),
+ }];
+ sizeDescription = 'large';
+ } else {
+ throw new Error('No large files available for testing');
+ }
+ } else {
+ // Send multiple small attachments - use text file and image file
+ const smallFiles = fileManager.getSmallFiles();
+ if (smallFiles.length >= 2) {
+ // Get the text file and image file
+ const textFile = smallFiles.find(f => f.filename.includes('.txt')) || smallFiles[0];
+ const imageFile = smallFiles.find(f => f.filename.includes('.jpg')) || smallFiles[1];
+
+ const files = [textFile, imageFile];
+
+ stringAttachments = files.map(file => {
+ const fileBuffer = file.asBuffer();
+ const base64Content = fileBuffer.toString('base64');
+
+ return {
+ filename: file.filename,
+ contentType: file.contentType,
+ content: base64Content,
+ size: Buffer.byteLength(base64Content, 'utf8'),
+ };
+ });
+ sizeDescription = 'small';
+ } else {
+ throw new Error('Not enough small files available for testing');
+ }
+ }
+
+ const requestBody: SendMessageRequest = {
+ to: [{ name: 'Test Recipient', email: recipientEmail }],
+ subject: `Nylas SDK - Base64 String Attachments (${sizeDescription})`,
+ body: `
+ Base64 String Attachments Example
+ This demonstrates sending existing files as base64 encoded strings.
+ Files are converted from the same test files used in other examples.
+ Attachment size: ${sizeDescription} (${stringAttachments.length} file${stringAttachments.length > 1 ? 's' : ''})
+
+ ${stringAttachments.map(att => `- ${att.filename} (${att.size} bytes base64 encoded)
`).join('')}
+
+ `,
+ attachments: stringAttachments
+ };
+
+ // For large files, use a longer timeout (5 minutes)
+ const overrides = large ? { timeout: 300 } : undefined;
+
+ return await nylas.messages.send({
+ identifier: grantId,
+ requestBody,
+ overrides
+ });
+}
\ No newline at end of file
diff --git a/examples/messages/send-attachments-cli.ts b/examples/messages/send-attachments-cli.ts
new file mode 100644
index 00000000..50949fe5
--- /dev/null
+++ b/examples/messages/send-attachments-cli.ts
@@ -0,0 +1,70 @@
+import * as dotenv from 'dotenv';
+import * as path from 'path';
+import * as process from 'process';
+import { TestFileManager } from './utils/attachment-file-manager';
+
+// =============================================================================
+// 🎯 NYLAS SDK ATTACHMENT EXAMPLES - Import clean, focused examples
+// =============================================================================
+
+// Example 1: File Path Attachments (Most Common & Efficient)
+import { sendFilePathAttachments } from './examples/file-path-attachments';
+
+// Example 2: Stream Attachments (For More Control)
+import { sendStreamAttachments } from './examples/stream-attachments';
+
+// Example 3: Buffer Attachments (For Small Files)
+import { sendBufferAttachments } from './examples/buffer-attachments';
+
+// Example 4: String Content Attachments (For Dynamic Content)
+import { sendStringAttachments } from './examples/string-attachments';
+
+// Flexible format-based attachment sending
+import { sendAttachmentsByFormat } from './examples/flexible-attachments';
+
+// =============================================================================
+// 📂 File Manager - Manage test files
+// =============================================================================
+// Available test files in the examples/messages/attachments directory
+const testFileManager = new TestFileManager(path.resolve(__dirname, './attachments'), [
+ 'test-small-26B.txt',
+ 'test-image-512KB.jpg',
+ 'test-document-12MB.pdf',
+ 'test-image-10MB.jpg'
+]);
+
+
+// =============================================================================
+// 🛠️ CLI Interface - Start CLI when run directly
+// =============================================================================
+
+import { startCli } from './cli-interface';
+import type { SendAttachmentsExamples } from './examples';
+
+const sendAttachmentsExamples: SendAttachmentsExamples = {
+ sendFilePathAttachments,
+ sendStreamAttachments,
+ sendBufferAttachments,
+ sendStringAttachments,
+ sendAttachmentsByFormat
+};
+const grantId: string = process.env.NYLAS_GRANT_ID || '';
+
+// Check for required environment variables
+if (!process.env.NYLAS_API_KEY) {
+ throw new Error('NYLAS_API_KEY environment variable is not set');
+}
+if (!grantId) {
+ throw new Error('NYLAS_GRANT_ID environment variable is not set');
+}
+
+// Load environment variables from .env file
+dotenv.config({ path: path.resolve(__dirname, '../.env') });
+
+// Run the CLI
+if (require.main === module) {
+ startCli(sendAttachmentsExamples, testFileManager, process.env.TEST_EMAIL || '').catch(error => {
+ console.error('Error:', error.message);
+ process.exit(1);
+ });
+}
\ No newline at end of file
diff --git a/examples/messages/utils/attachment-file-manager.ts b/examples/messages/utils/attachment-file-manager.ts
new file mode 100644
index 00000000..963d492e
--- /dev/null
+++ b/examples/messages/utils/attachment-file-manager.ts
@@ -0,0 +1,245 @@
+import * as path from 'path';
+import * as fs from 'fs';
+import * as mime from 'mime-types';
+import { CreateAttachmentRequest } from 'nylas';
+
+
+/**
+ * File format types for different ways to handle attachments
+ */
+export type FileFormat = 'file' | 'stream' | 'buffer' | 'string';
+
+/**
+ * Maximum size for small files
+ */
+export const MAX_SMALL_FILE_SIZE_LIMIT = 1024 * 1024 * 3; // 3MB
+
+/**
+ * Interface for file information and content access
+ */
+interface FileHandler {
+ path: string;
+ exists: boolean;
+ filename: string;
+ size: number;
+ contentType: string;
+
+ // Methods to get content in different formats
+ asFileRequest(): CreateAttachmentRequest;
+ asStream(): fs.ReadStream;
+ asBuffer(): Buffer;
+ asString(): string;
+}
+
+/**
+ * Common utility class for handling test files in different formats
+ */
+export class TestFileHandler implements FileHandler {
+ public readonly path: string;
+ public readonly exists: boolean;
+ public readonly filename: string;
+ public readonly size: number;
+ public readonly contentType: string;
+
+ constructor(fileName: string, baseDir?: string) {
+ // Default to attachments subdirectory relative to the messages folder
+ const attachmentsDir = baseDir || path.resolve(__dirname, '../attachments');
+ this.path = path.resolve(attachmentsDir, fileName);
+ this.exists = fs.existsSync(this.path);
+ this.filename = path.basename(this.path);
+
+ if (this.exists) {
+ const stats = fs.statSync(this.path);
+ this.size = stats.size;
+ this.contentType = mime.lookup(this.path) || 'application/octet-stream';
+ } else {
+ this.size = 0;
+ this.contentType = 'application/octet-stream';
+ }
+ }
+
+ /**
+ * Get file as CreateAttachmentRequest using file stream (original method)
+ */
+ asFileRequest(): CreateAttachmentRequest {
+ if (!this.exists) {
+ throw new Error(`File not found: ${this.filename}`);
+ }
+
+ return {
+ filename: this.filename,
+ contentType: this.contentType,
+ content: fs.createReadStream(this.path),
+ size: this.size,
+ };
+ }
+
+ /**
+ * Get file as a readable stream
+ */
+ asStream(): fs.ReadStream {
+ if (!this.exists) {
+ throw new Error(`File not found: ${this.filename}`);
+ }
+ return fs.createReadStream(this.path);
+ }
+
+ /**
+ * Get file as a Buffer
+ */
+ asBuffer(): Buffer {
+ if (!this.exists) {
+ throw new Error(`File not found: ${this.filename}`);
+ }
+ return fs.readFileSync(this.path);
+ }
+
+ /**
+ * Get file as a string (only works for text files)
+ */
+ asString(): string {
+ if (!this.exists) {
+ throw new Error(`File not found: ${this.filename}`);
+ }
+
+ // Check if it's likely a text file
+ const textTypes = ['text/', 'application/json', 'application/xml'];
+ const isTextFile = textTypes.some(type => this.contentType.startsWith(type));
+
+ if (!isTextFile && this.size > MAX_SMALL_FILE_SIZE_LIMIT) { // > 1MB
+ throw new Error(`File ${this.filename} is too large or not a text file to read as string`);
+ }
+
+ return fs.readFileSync(this.path, 'utf8');
+ }
+}
+
+/**
+ * File manager utility to handle all test files
+ */
+export class TestFileManager {
+ private files: Map = new Map();
+ private baseDir: string;
+
+ constructor(baseDir?: string, files?: string[]) {
+ // Default to attachments subdirectory relative to the messages folder
+ this.baseDir = baseDir || path.resolve(__dirname, '../attachments');
+
+ // Initialize all test files
+ files?.forEach(fileName => {
+ this.files.set(fileName, new TestFileHandler(fileName, this.baseDir));
+ });
+ }
+
+ /**
+ * Get a file handler by filename
+ */
+ getFile(fileName: string): TestFileHandler {
+ const handler = this.files.get(fileName);
+ if (!handler) {
+ throw new Error(`Unknown test file: ${fileName}`);
+ }
+ return handler;
+ }
+
+ /**
+ * Get all available files
+ */
+ getAllFiles(): TestFileHandler[] {
+ return Array.from(this.files.values());
+ }
+
+ /**
+ * Get only files that exist
+ */
+ getExistingFiles(): TestFileHandler[] {
+ return this.getAllFiles().filter(file => file.exists);
+ }
+
+ /**
+ * Get small files (< 1MB)
+ */
+ getSmallFiles(): TestFileHandler[] {
+ return this.getExistingFiles().filter(file => file.size < MAX_SMALL_FILE_SIZE_LIMIT);
+ }
+
+ /**
+ * Get large files (>= 1MB)
+ */
+ getLargeFiles(): TestFileHandler[] {
+ return this.getExistingFiles().filter(file => file.size >= MAX_SMALL_FILE_SIZE_LIMIT);
+ }
+
+ /**
+ * Check status of all test files
+ */
+ checkFileStatus(): void {
+ console.log('\nChecking test file status:');
+ this.getAllFiles().forEach(file => {
+ const status = file.exists ? `✓ Found (${file.size} bytes)` : '✗ Not found';
+ const sizeLabel = file.size >= MAX_SMALL_FILE_SIZE_LIMIT ? 'LARGE' : 'SMALL';
+ console.log(` ${file.filename}: ${status} [${sizeLabel}]`);
+ });
+ }
+
+ /**
+ * Create attachment request for a file in the specified format
+ */
+ createAttachmentRequest(fileName: string, format: FileFormat): CreateAttachmentRequest {
+ const file = this.getFile(fileName);
+
+ switch (format) {
+ case 'file':
+ return file.asFileRequest();
+
+ case 'stream':
+ return {
+ filename: file.filename,
+ contentType: file.contentType,
+ content: file.asStream(),
+ size: file.size,
+ };
+
+ case 'buffer':
+ return {
+ filename: file.filename,
+ contentType: file.contentType,
+ content: file.asBuffer(),
+ size: file.size,
+ };
+
+ case 'string':
+ const stringContent = file.asString();
+ return {
+ filename: file.filename,
+ contentType: file.contentType,
+ content: stringContent,
+ size: Buffer.byteLength(stringContent, 'utf8'),
+ };
+
+ default:
+ throw new Error(`Unsupported format: ${format}`);
+ }
+ }
+}
+
+/**
+ * Helper function to create a file request builder for any file path
+ * This maintains backward compatibility with the original function
+ */
+export function createFileRequestBuilder(filePath: string): CreateAttachmentRequest {
+ // If it's not an absolute path, assume it's in the attachments subdirectory
+ const fullPath = path.resolve(__dirname, filePath);
+
+ const stats = fs.statSync(fullPath);
+ const filename = path.basename(fullPath);
+ const contentType = mime.lookup(fullPath) || 'application/octet-stream';
+ const content = fs.createReadStream(fullPath);
+
+ return {
+ filename,
+ contentType,
+ content,
+ size: stats.size,
+ };
+}
\ No newline at end of file
diff --git a/examples/package-lock.json b/examples/package-lock.json
index e8a177c4..873702b8 100644
--- a/examples/package-lock.json
+++ b/examples/package-lock.json
@@ -8,10 +8,16 @@
"name": "nylas-examples",
"version": "1.0.0",
"dependencies": {
+ "chalk": "^5.3.0",
+ "commander": "^11.1.0",
"dotenv": "^16.0.0",
+ "inquirer": "^9.2.12",
+ "mime-types": "^2.1.35",
"nylas": "file:.."
},
"devDependencies": {
+ "@types/inquirer": "^9.0.7",
+ "@types/mime-types": "^2.1.4",
"@types/node": "^18.11.9",
"ts-node": "^10.8.0",
"typescript": "^5.0.0"
@@ -19,11 +25,12 @@
},
"..": {
"name": "nylas",
- "version": "7.8.0",
+ "version": "7.11.0",
"license": "MIT",
"dependencies": {
"change-case": "^4.1.2",
- "form-data": "^4.0.0",
+ "form-data-encoder": "^4.1.0",
+ "formdata-node": "^6.0.3",
"mime-types": "^2.1.35",
"node-fetch": "^2.6.12",
"uuid": "^8.3.2"
@@ -32,6 +39,7 @@
"@babel/core": "^7.3.3",
"@types/jest": "^29.5.2",
"@types/mime-types": "^2.1.2",
+ "@types/node": "^22.15.21",
"@types/node-fetch": "^2.6.4",
"@types/uuid": "^8.3.4",
"@typescript-eslint/eslint-plugin": "^2.25.0",
@@ -42,11 +50,11 @@
"eslint-plugin-import": "^2.28.1",
"eslint-plugin-prettier": "^3.0.1",
"jest": "^29.6.1",
- "prettier": "^1.19.1",
+ "prettier": "^3.5.3",
"ts-jest": "^29.1.1",
- "typedoc": "^0.24.8",
- "typedoc-plugin-rename-defaults": "^0.6.5",
- "typescript": "^4.9.5"
+ "typedoc": "^0.28.4",
+ "typedoc-plugin-rename-defaults": "^0.7.3",
+ "typescript": "^5.8.3"
},
"engines": {
"node": ">=16"
@@ -65,6 +73,15 @@
"node": ">=12"
}
},
+ "node_modules/@inquirer/figures": {
+ "version": "1.0.12",
+ "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.12.tgz",
+ "integrity": "sha512-MJttijd8rMFcKJC8NYmprWr6hD3r9Gd9qUC0XwPNwoEPWSMVJwA2MlXxF+nhZZNMY+HXsWa+o7KY2emWYIn0jQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ }
+ },
"node_modules/@jridgewell/resolve-uri": {
"version": "3.1.2",
"resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz",
@@ -121,6 +138,24 @@
"dev": true,
"license": "MIT"
},
+ "node_modules/@types/inquirer": {
+ "version": "9.0.8",
+ "resolved": "https://registry.npmjs.org/@types/inquirer/-/inquirer-9.0.8.tgz",
+ "integrity": "sha512-CgPD5kFGWsb8HJ5K7rfWlifao87m4ph8uioU7OTncJevmE/VLIqAAjfQtko578JZg7/f69K4FgqYym3gNr7DeA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/through": "*",
+ "rxjs": "^7.2.0"
+ }
+ },
+ "node_modules/@types/mime-types": {
+ "version": "2.1.4",
+ "resolved": "https://registry.npmjs.org/@types/mime-types/-/mime-types-2.1.4.tgz",
+ "integrity": "sha512-lfU4b34HOri+kAY5UheuFMWPDOI+OPceBSHZKp69gEyTL/mmJ4cnU6Y/rlme3UL3GyOn6Y42hyIEw0/q8sWx5w==",
+ "dev": true,
+ "license": "MIT"
+ },
"node_modules/@types/node": {
"version": "18.19.86",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.86.tgz",
@@ -131,6 +166,16 @@
"undici-types": "~5.26.4"
}
},
+ "node_modules/@types/through": {
+ "version": "0.0.33",
+ "resolved": "https://registry.npmjs.org/@types/through/-/through-0.0.33.tgz",
+ "integrity": "sha512-HsJ+z3QuETzP3cswwtzt2vEIiHBk/dCcHGhbmG5X3ecnwFD/lPrMpliGXxSCg03L9AhrdwA4Oz/qfspkDW+xGQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
"node_modules/acorn": {
"version": "8.14.1",
"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz",
@@ -157,6 +202,45 @@
"node": ">=0.4.0"
}
},
+ "node_modules/ansi-escapes": {
+ "version": "4.3.2",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",
+ "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==",
+ "license": "MIT",
+ "dependencies": {
+ "type-fest": "^0.21.3"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "license": "MIT",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
"node_modules/arg": {
"version": "4.1.3",
"resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
@@ -164,6 +248,148 @@
"dev": true,
"license": "MIT"
},
+ "node_modules/base64-js": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+ "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/bl": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz",
+ "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==",
+ "license": "MIT",
+ "dependencies": {
+ "buffer": "^5.5.0",
+ "inherits": "^2.0.4",
+ "readable-stream": "^3.4.0"
+ }
+ },
+ "node_modules/buffer": {
+ "version": "5.7.1",
+ "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz",
+ "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "base64-js": "^1.3.1",
+ "ieee754": "^1.1.13"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "5.4.1",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz",
+ "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==",
+ "license": "MIT",
+ "engines": {
+ "node": "^12.17.0 || ^14.13 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/chardet": {
+ "version": "0.7.0",
+ "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz",
+ "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==",
+ "license": "MIT"
+ },
+ "node_modules/cli-cursor": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz",
+ "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==",
+ "license": "MIT",
+ "dependencies": {
+ "restore-cursor": "^3.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/cli-spinners": {
+ "version": "2.9.2",
+ "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz",
+ "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/cli-width": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
+ "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
+ "license": "ISC",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/clone": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz",
+ "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
+ "license": "MIT"
+ },
+ "node_modules/commander": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz",
+ "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=16"
+ }
+ },
"node_modules/create-require": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
@@ -171,6 +397,18 @@
"dev": true,
"license": "MIT"
},
+ "node_modules/defaults": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz",
+ "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==",
+ "license": "MIT",
+ "dependencies": {
+ "clone": "^1.0.2"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
"node_modules/diff": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
@@ -193,6 +431,158 @@
"url": "https://dotenvx.com"
}
},
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
+ "license": "MIT"
+ },
+ "node_modules/external-editor": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz",
+ "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==",
+ "license": "MIT",
+ "dependencies": {
+ "chardet": "^0.7.0",
+ "iconv-lite": "^0.4.24",
+ "tmp": "^0.0.33"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/iconv-lite": {
+ "version": "0.4.24",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz",
+ "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==",
+ "license": "MIT",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/ieee754": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
+ "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
+ "license": "ISC"
+ },
+ "node_modules/inquirer": {
+ "version": "9.3.7",
+ "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-9.3.7.tgz",
+ "integrity": "sha512-LJKFHCSeIRq9hanN14IlOtPSTe3lNES7TYDTE2xxdAy1LS5rYphajK1qtwvj3YmQXvvk0U2Vbmcni8P9EIQW9w==",
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/figures": "^1.0.3",
+ "ansi-escapes": "^4.3.2",
+ "cli-width": "^4.1.0",
+ "external-editor": "^3.1.0",
+ "mute-stream": "1.0.0",
+ "ora": "^5.4.1",
+ "run-async": "^3.0.0",
+ "rxjs": "^7.8.1",
+ "string-width": "^4.2.3",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^6.2.0",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-interactive": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz",
+ "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-unicode-supported": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz",
+ "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/log-symbols": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz",
+ "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==",
+ "license": "MIT",
+ "dependencies": {
+ "chalk": "^4.1.0",
+ "is-unicode-supported": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/log-symbols/node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
"node_modules/make-error": {
"version": "1.3.6",
"resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
@@ -200,10 +590,248 @@
"dev": true,
"license": "ISC"
},
+ "node_modules/mime-db": {
+ "version": "1.52.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
+ "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mime-types": {
+ "version": "2.1.35",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
+ "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
+ "license": "MIT",
+ "dependencies": {
+ "mime-db": "1.52.0"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mimic-fn": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz",
+ "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/mute-stream": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-1.0.0.tgz",
+ "integrity": "sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA==",
+ "license": "ISC",
+ "engines": {
+ "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+ }
+ },
"node_modules/nylas": {
"resolved": "..",
"link": true
},
+ "node_modules/onetime": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz",
+ "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==",
+ "license": "MIT",
+ "dependencies": {
+ "mimic-fn": "^2.1.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora": {
+ "version": "5.4.1",
+ "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz",
+ "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==",
+ "license": "MIT",
+ "dependencies": {
+ "bl": "^4.1.0",
+ "chalk": "^4.1.0",
+ "cli-cursor": "^3.1.0",
+ "cli-spinners": "^2.5.0",
+ "is-interactive": "^1.0.0",
+ "is-unicode-supported": "^0.1.0",
+ "log-symbols": "^4.1.0",
+ "strip-ansi": "^6.0.0",
+ "wcwidth": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/os-tmpdir": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz",
+ "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/readable-stream": {
+ "version": "3.6.2",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
+ "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==",
+ "license": "MIT",
+ "dependencies": {
+ "inherits": "^2.0.3",
+ "string_decoder": "^1.1.1",
+ "util-deprecate": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/restore-cursor": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz",
+ "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==",
+ "license": "MIT",
+ "dependencies": {
+ "onetime": "^5.1.0",
+ "signal-exit": "^3.0.2"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/run-async": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/run-async/-/run-async-3.0.0.tgz",
+ "integrity": "sha512-540WwVDOMxA6dN6We19EcT9sc3hkXPw5mzRNGM3FkdN/vtE9NFvj5lFAPNwUDmJjXidm3v7TC1cTE7t17Ulm1Q==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/rxjs": {
+ "version": "7.8.2",
+ "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz",
+ "integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "tslib": "^2.1.0"
+ }
+ },
+ "node_modules/safe-buffer": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
+ "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/safer-buffer": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
+ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
+ "license": "MIT"
+ },
+ "node_modules/signal-exit": {
+ "version": "3.0.7",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz",
+ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==",
+ "license": "ISC"
+ },
+ "node_modules/string_decoder": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
+ "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==",
+ "license": "MIT",
+ "dependencies": {
+ "safe-buffer": "~5.2.0"
+ }
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "license": "MIT",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "license": "MIT",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/tmp": {
+ "version": "0.0.33",
+ "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
+ "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==",
+ "license": "MIT",
+ "dependencies": {
+ "os-tmpdir": "~1.0.2"
+ },
+ "engines": {
+ "node": ">=0.6.0"
+ }
+ },
"node_modules/ts-node": {
"version": "10.9.2",
"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
@@ -248,6 +876,24 @@
}
}
},
+ "node_modules/tslib": {
+ "version": "2.8.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
+ "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
+ "license": "0BSD"
+ },
+ "node_modules/type-fest": {
+ "version": "0.21.3",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz",
+ "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
+ "license": "(MIT OR CC0-1.0)",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
"node_modules/typescript": {
"version": "5.8.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz",
@@ -269,6 +915,12 @@
"dev": true,
"license": "MIT"
},
+ "node_modules/util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==",
+ "license": "MIT"
+ },
"node_modules/v8-compile-cache-lib": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
@@ -276,6 +928,29 @@
"dev": true,
"license": "MIT"
},
+ "node_modules/wcwidth": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz",
+ "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==",
+ "license": "MIT",
+ "dependencies": {
+ "defaults": "^1.0.3"
+ }
+ },
+ "node_modules/wrap-ansi": {
+ "version": "6.2.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
+ "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
"node_modules/yn": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
@@ -285,6 +960,18 @@
"engines": {
"node": ">=6"
}
+ },
+ "node_modules/yoctocolors-cjs": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/yoctocolors-cjs/-/yoctocolors-cjs-2.1.2.tgz",
+ "integrity": "sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
}
}
}
diff --git a/examples/package.json b/examples/package.json
index 64ade60f..de670a7f 100644
--- a/examples/package.json
+++ b/examples/package.json
@@ -9,15 +9,22 @@
"notetakers": "ts-node notetakers/notetaker.ts",
"calendars": "ts-node calendars/event_with_notetaker.ts",
"messages": "ts-node messages/messages.ts",
+ "send-attachments": "ts-node messages/send-attachments-cli.ts",
"folders": "ts-node folders/folders.ts"
},
"dependencies": {
+ "chalk": "^5.3.0",
+ "commander": "^11.1.0",
"dotenv": "^16.0.0",
+ "inquirer": "^9.2.12",
+ "mime-types": "^2.1.35",
"nylas": "file:.."
},
"devDependencies": {
"ts-node": "^10.8.0",
"typescript": "^5.0.0",
- "@types/node": "^18.11.9"
+ "@types/node": "^18.11.9",
+ "@types/inquirer": "^9.0.7",
+ "@types/mime-types": "^2.1.4"
}
}
\ No newline at end of file
diff --git a/jest.config.js b/jest.config.js
index a1544a8f..b3785f22 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -9,10 +9,19 @@ const config = {
],
},
moduleNameMapper: {
- '^[../]+src/([^/]+)$': '/lib/esm/$1.js',
- '^[../]+src/resources/([^/]+)$': '/lib/esm/resources/$1.js',
- '^[../]+src/models/([^/]+)$': '/lib/esm/models/$1.js',
+ '^[../]+src/([^/]+)$': '/src/$1.ts',
+ '^[../]+src/resources/([^/]+)$': '/src/resources/$1.ts',
+ '^[../]+src/models/([^/]+)$': '/src/models/$1.ts',
+ // Handle .js imports in TypeScript files for Jest
+ '^(.+)\\.js$': '$1',
},
+ // Handle ESM modules like node-fetch v3
+ extensionsToTreatAsEsm: ['.ts'],
+ transformIgnorePatterns: [
+ 'node_modules/(?!(node-fetch|data-uri-to-buffer|fetch-blob|formdata-polyfill)/)',
+ ],
+ // Set up jest-fetch-mock
+ setupFilesAfterEnv: ['/tests/setupTests.ts'],
coverageThreshold: {
global: {
functions: 80,
diff --git a/package-lock.json b/package-lock.json
index edeca825..b00ab1e2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,9 +10,10 @@
"license": "MIT",
"dependencies": {
"change-case": "^4.1.2",
- "form-data": "^4.0.0",
+ "form-data-encoder": "^4.1.0",
+ "formdata-node": "^6.0.3",
"mime-types": "^2.1.35",
- "node-fetch": "^2.6.12",
+ "node-fetch": "^3.3.2",
"uuid": "^8.3.2"
},
"devDependencies": {
@@ -20,7 +21,6 @@
"@types/jest": "^29.5.2",
"@types/mime-types": "^2.1.2",
"@types/node": "^22.15.21",
- "@types/node-fetch": "^2.6.4",
"@types/uuid": "^8.3.4",
"@typescript-eslint/eslint-plugin": "^2.25.0",
"@typescript-eslint/parser": "^2.25.0",
@@ -30,6 +30,7 @@
"eslint-plugin-import": "^2.28.1",
"eslint-plugin-prettier": "^3.0.1",
"jest": "^29.6.1",
+ "jest-fetch-mock": "^3.0.3",
"prettier": "^3.5.3",
"ts-jest": "^29.1.1",
"typedoc": "^0.28.4",
@@ -1538,30 +1539,6 @@
"undici-types": "~6.21.0"
}
},
- "node_modules/@types/node-fetch": {
- "version": "2.6.4",
- "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.4.tgz",
- "integrity": "sha512-1ZX9fcN4Rvkvgv4E6PAY5WXUFWFcRWxZa3EW83UjycOB9ljJCedb2CupIP4RZMEwF/M3eTcCihbBRgwtGbg5Rg==",
- "dev": true,
- "dependencies": {
- "@types/node": "*",
- "form-data": "^3.0.0"
- }
- },
- "node_modules/@types/node-fetch/node_modules/form-data": {
- "version": "3.0.1",
- "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
- "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
- "dev": true,
- "dependencies": {
- "asynckit": "^0.4.0",
- "combined-stream": "^1.0.8",
- "mime-types": "^2.1.12"
- },
- "engines": {
- "node": ">= 6"
- }
- },
"node_modules/@types/prettier": {
"version": "2.7.3",
"resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.3.tgz",
@@ -1911,11 +1888,6 @@
"node": ">=4"
}
},
- "node_modules/asynckit": {
- "version": "0.4.0",
- "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
- "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
- },
"node_modules/available-typed-arrays": {
"version": "1.0.5",
"resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz",
@@ -2422,17 +2394,6 @@
"integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==",
"dev": true
},
- "node_modules/combined-stream": {
- "version": "1.0.8",
- "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
- "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
- "dependencies": {
- "delayed-stream": "~1.0.0"
- },
- "engines": {
- "node": ">= 0.8"
- }
- },
"node_modules/concat-map": {
"version": "0.0.1",
"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
@@ -2455,6 +2416,37 @@
"integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==",
"dev": true
},
+ "node_modules/cross-fetch": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.2.0.tgz",
+ "integrity": "sha512-Q+xVJLoGOeIMXZmbUK4HYk+69cQH6LudR0Vu/pRm2YlU/hDV9CiS0gKUMaWY5f2NeUH9C1nV3bsTlCo0FsTV1Q==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "node-fetch": "^2.7.0"
+ }
+ },
+ "node_modules/cross-fetch/node_modules/node-fetch": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
+ "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "whatwg-url": "^5.0.0"
+ },
+ "engines": {
+ "node": "4.x || >=6.0.0"
+ },
+ "peerDependencies": {
+ "encoding": "^0.1.0"
+ },
+ "peerDependenciesMeta": {
+ "encoding": {
+ "optional": true
+ }
+ }
+ },
"node_modules/cross-spawn": {
"version": "6.0.5",
"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz",
@@ -2480,6 +2472,15 @@
"semver": "bin/semver"
}
},
+ "node_modules/data-uri-to-buffer": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz",
+ "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
"node_modules/debug": {
"version": "4.3.4",
"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -2534,14 +2535,6 @@
"url": "https://github.com/sponsors/ljharb"
}
},
- "node_modules/delayed-stream": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
- "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==",
- "engines": {
- "node": ">=0.4.0"
- }
- },
"node_modules/detect-newline": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz",
@@ -3268,6 +3261,29 @@
"bser": "2.1.1"
}
},
+ "node_modules/fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "paypal",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ },
+ "engines": {
+ "node": "^12.20 || >= 14.13"
+ }
+ },
"node_modules/figures": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/figures/-/figures-2.0.0.tgz",
@@ -3346,17 +3362,34 @@
"is-callable": "^1.1.3"
}
},
- "node_modules/form-data": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
- "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
+ "node_modules/form-data-encoder": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-4.1.0.tgz",
+ "integrity": "sha512-G6NsmEW15s0Uw9XnCg+33H3ViYRyiM0hMrMhhqQOR8NFc5GhYrI+6I3u7OTw7b91J2g8rtvMBZJDbcGb2YUniw==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/formdata-node": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/formdata-node/-/formdata-node-6.0.3.tgz",
+ "integrity": "sha512-8e1++BCiTzUno9v5IZ2J6bv4RU+3UKDmqWUQD0MIMVCd9AdhWkO1gw57oo1mNEX1dMq2EGI+FbWz4B92pscSQg==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
+ "license": "MIT",
"dependencies": {
- "asynckit": "^0.4.0",
- "combined-stream": "^1.0.8",
- "mime-types": "^2.1.12"
+ "fetch-blob": "^3.1.2"
},
"engines": {
- "node": ">= 6"
+ "node": ">=12.20.0"
}
},
"node_modules/fs.realpath": {
@@ -4742,6 +4775,17 @@
"node": "^14.15.0 || ^16.10.0 || >=18.0.0"
}
},
+ "node_modules/jest-fetch-mock": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/jest-fetch-mock/-/jest-fetch-mock-3.0.3.tgz",
+ "integrity": "sha512-Ux1nWprtLrdrH4XwE7O7InRY6psIi3GOsqNESJgMJ+M5cv4A8Lh7SN9d2V2kKRZ8ebAfcd1LNyZguAOb6JiDqw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cross-fetch": "^3.0.4",
+ "promise-polyfill": "^8.1.3"
+ }
+ },
"node_modules/jest-get-type": {
"version": "29.4.3",
"resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.4.3.tgz",
@@ -6091,23 +6135,42 @@
"tslib": "^2.0.3"
}
},
+ "node_modules/node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==",
+ "deprecated": "Use your platform's native DOMException instead",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "github",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "license": "MIT",
+ "engines": {
+ "node": ">=10.5.0"
+ }
+ },
"node_modules/node-fetch": {
- "version": "2.6.12",
- "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.12.tgz",
- "integrity": "sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g==",
+ "version": "3.3.2",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
+ "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
+ "license": "MIT",
"dependencies": {
- "whatwg-url": "^5.0.0"
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
},
"engines": {
- "node": "4.x || >=6.0.0"
- },
- "peerDependencies": {
- "encoding": "^0.1.0"
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
},
- "peerDependenciesMeta": {
- "encoding": {
- "optional": true
- }
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/node-fetch"
}
},
"node_modules/node-int64": {
@@ -6551,6 +6614,13 @@
"node": ">=0.4.0"
}
},
+ "node_modules/promise-polyfill": {
+ "version": "8.3.0",
+ "resolved": "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-8.3.0.tgz",
+ "integrity": "sha512-H5oELycFml5yto/atYqmjyigJoAo3+OXwolYiH7OfQuYlAqhxNvTfiNMbV9hsC6Yp83yE5r2KTVmtrG6R9i6Pg==",
+ "dev": true,
+ "license": "MIT"
+ },
"node_modules/prompts": {
"version": "2.4.2",
"resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
@@ -7266,7 +7336,9 @@
"node_modules/tr46": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
- "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
+ "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
+ "dev": true,
+ "license": "MIT"
},
"node_modules/ts-jest": {
"version": "29.1.1",
@@ -7673,15 +7745,28 @@
"makeerror": "1.0.12"
}
},
+ "node_modules/web-streams-polyfill": {
+ "version": "3.3.3",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz",
+ "integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
"node_modules/webidl-conversions": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
- "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
+ "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
+ "dev": true,
+ "license": "BSD-2-Clause"
},
"node_modules/whatwg-url": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
+ "dev": true,
+ "license": "MIT",
"dependencies": {
"tr46": "~0.0.3",
"webidl-conversions": "^3.0.0"
@@ -9153,29 +9238,6 @@
"undici-types": "~6.21.0"
}
},
- "@types/node-fetch": {
- "version": "2.6.4",
- "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.4.tgz",
- "integrity": "sha512-1ZX9fcN4Rvkvgv4E6PAY5WXUFWFcRWxZa3EW83UjycOB9ljJCedb2CupIP4RZMEwF/M3eTcCihbBRgwtGbg5Rg==",
- "dev": true,
- "requires": {
- "@types/node": "*",
- "form-data": "^3.0.0"
- },
- "dependencies": {
- "form-data": {
- "version": "3.0.1",
- "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
- "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
- "dev": true,
- "requires": {
- "asynckit": "^0.4.0",
- "combined-stream": "^1.0.8",
- "mime-types": "^2.1.12"
- }
- }
- }
- },
"@types/prettier": {
"version": "2.7.3",
"resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.3.tgz",
@@ -9411,11 +9473,6 @@
"integrity": "sha512-+Ryf6g3BKoRc7jfp7ad8tM4TtMiaWvbF/1/sQcZPkkS7ag3D5nMBCe2UfOTONtAkaG0tO0ij3C5Lwmf1EiyjHg==",
"dev": true
},
- "asynckit": {
- "version": "0.4.0",
- "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
- "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
- },
"available-typed-arrays": {
"version": "1.0.5",
"resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz",
@@ -9792,14 +9849,6 @@
"integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==",
"dev": true
},
- "combined-stream": {
- "version": "1.0.8",
- "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
- "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
- "requires": {
- "delayed-stream": "~1.0.0"
- }
- },
"concat-map": {
"version": "0.0.1",
"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
@@ -9822,6 +9871,26 @@
"integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==",
"dev": true
},
+ "cross-fetch": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.2.0.tgz",
+ "integrity": "sha512-Q+xVJLoGOeIMXZmbUK4HYk+69cQH6LudR0Vu/pRm2YlU/hDV9CiS0gKUMaWY5f2NeUH9C1nV3bsTlCo0FsTV1Q==",
+ "dev": true,
+ "requires": {
+ "node-fetch": "^2.7.0"
+ },
+ "dependencies": {
+ "node-fetch": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
+ "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
+ "dev": true,
+ "requires": {
+ "whatwg-url": "^5.0.0"
+ }
+ }
+ }
+ },
"cross-spawn": {
"version": "6.0.5",
"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz",
@@ -9843,6 +9912,11 @@
}
}
},
+ "data-uri-to-buffer": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz",
+ "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A=="
+ },
"debug": {
"version": "4.3.4",
"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -9880,11 +9954,6 @@
"object-keys": "^1.1.1"
}
},
- "delayed-stream": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
- "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ=="
- },
"detect-newline": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz",
@@ -10450,6 +10519,15 @@
"bser": "2.1.1"
}
},
+ "fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "requires": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ }
+ },
"figures": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/figures/-/figures-2.0.0.tgz",
@@ -10513,14 +10591,22 @@
"is-callable": "^1.1.3"
}
},
- "form-data": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
- "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
+ "form-data-encoder": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-4.1.0.tgz",
+ "integrity": "sha512-G6NsmEW15s0Uw9XnCg+33H3ViYRyiM0hMrMhhqQOR8NFc5GhYrI+6I3u7OTw7b91J2g8rtvMBZJDbcGb2YUniw=="
+ },
+ "formdata-node": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/formdata-node/-/formdata-node-6.0.3.tgz",
+ "integrity": "sha512-8e1++BCiTzUno9v5IZ2J6bv4RU+3UKDmqWUQD0MIMVCd9AdhWkO1gw57oo1mNEX1dMq2EGI+FbWz4B92pscSQg=="
+ },
+ "formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
"requires": {
- "asynckit": "^0.4.0",
- "combined-stream": "^1.0.8",
- "mime-types": "^2.1.12"
+ "fetch-blob": "^3.1.2"
}
},
"fs.realpath": {
@@ -11506,6 +11592,16 @@
"jest-util": "^29.6.1"
}
},
+ "jest-fetch-mock": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/jest-fetch-mock/-/jest-fetch-mock-3.0.3.tgz",
+ "integrity": "sha512-Ux1nWprtLrdrH4XwE7O7InRY6psIi3GOsqNESJgMJ+M5cv4A8Lh7SN9d2V2kKRZ8ebAfcd1LNyZguAOb6JiDqw==",
+ "dev": true,
+ "requires": {
+ "cross-fetch": "^3.0.4",
+ "promise-polyfill": "^8.1.3"
+ }
+ },
"jest-get-type": {
"version": "29.4.3",
"resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.4.3.tgz",
@@ -12542,12 +12638,19 @@
"tslib": "^2.0.3"
}
},
+ "node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ=="
+ },
"node-fetch": {
- "version": "2.6.12",
- "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.12.tgz",
- "integrity": "sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g==",
+ "version": "3.3.2",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
+ "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
"requires": {
- "whatwg-url": "^5.0.0"
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
}
},
"node-int64": {
@@ -12873,6 +12976,12 @@
"integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==",
"dev": true
},
+ "promise-polyfill": {
+ "version": "8.3.0",
+ "resolved": "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-8.3.0.tgz",
+ "integrity": "sha512-H5oELycFml5yto/atYqmjyigJoAo3+OXwolYiH7OfQuYlAqhxNvTfiNMbV9hsC6Yp83yE5r2KTVmtrG6R9i6Pg==",
+ "dev": true
+ },
"prompts": {
"version": "2.4.2",
"resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
@@ -13417,7 +13526,8 @@
"tr46": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
- "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
+ "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
+ "dev": true
},
"ts-jest": {
"version": "29.1.1",
@@ -13694,15 +13804,22 @@
"makeerror": "1.0.12"
}
},
+ "web-streams-polyfill": {
+ "version": "3.3.3",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz",
+ "integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw=="
+ },
"webidl-conversions": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
- "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
+ "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
+ "dev": true
},
"whatwg-url": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
+ "dev": true,
"requires": {
"tr46": "~0.0.3",
"webidl-conversions": "^3.0.0"
diff --git a/package.json b/package.json
index 6fa01bb5..bf26a85c 100644
--- a/package.json
+++ b/package.json
@@ -40,9 +40,10 @@
"license": "MIT",
"dependencies": {
"change-case": "^4.1.2",
- "form-data": "^4.0.0",
+ "form-data-encoder": "^4.1.0",
+ "formdata-node": "^6.0.3",
"mime-types": "^2.1.35",
- "node-fetch": "^2.6.12",
+ "node-fetch": "^3.3.2",
"uuid": "^8.3.2"
},
"devDependencies": {
@@ -50,7 +51,6 @@
"@types/jest": "^29.5.2",
"@types/mime-types": "^2.1.2",
"@types/node": "^22.15.21",
- "@types/node-fetch": "^2.6.4",
"@types/uuid": "^8.3.4",
"@typescript-eslint/eslint-plugin": "^2.25.0",
"@typescript-eslint/parser": "^2.25.0",
@@ -60,6 +60,7 @@
"eslint-plugin-import": "^2.28.1",
"eslint-plugin-prettier": "^3.0.1",
"jest": "^29.6.1",
+ "jest-fetch-mock": "^3.0.3",
"prettier": "^3.5.3",
"ts-jest": "^29.1.1",
"typedoc": "^0.28.4",
diff --git a/src/apiClient.ts b/src/apiClient.ts
index fb4e964d..17bc7b17 100644
--- a/src/apiClient.ts
+++ b/src/apiClient.ts
@@ -1,5 +1,5 @@
import fetch, { Request, Response } from 'node-fetch';
-import { AbortSignal } from 'node-fetch/externals.js';
+import { Readable as _Readable } from 'node:stream';
import { NylasConfig, OverridableNylasConfig } from './config.js';
import {
NylasApiError,
@@ -8,7 +8,8 @@ import {
} from './models/error.js';
import { objKeysToCamelCase, objKeysToSnakeCase } from './utils.js';
import { SDK_VERSION } from './version.js';
-import FormData from 'form-data';
+import { FormData } from 'formdata-node';
+import { FormDataEncoder as _FormDataEncoder } from 'form-data-encoder';
import { snakeCase } from 'change-case';
/**
@@ -265,10 +266,6 @@ export default class APIClient {
if (optionParams.form) {
requestOptions.body = optionParams.form;
- requestOptions.headers = {
- ...requestOptions.headers,
- ...optionParams.form.getHeaders(),
- };
}
return requestOptions;
@@ -315,6 +312,10 @@ export default class APIClient {
options: RequestOptionsParams
): Promise {
const response = await this.sendRequest(options);
+ // TODO: See if we can fix this in a backwards compatible way
+ if (!response.body) {
+ throw new Error('No response body');
+ }
return response.body;
}
}
diff --git a/src/resources/auth.ts b/src/resources/auth.ts
index c6e0606a..d46f1a80 100644
--- a/src/resources/auth.ts
+++ b/src/resources/auth.ts
@@ -1,5 +1,5 @@
import { v4 as uuid } from 'uuid';
-import { createHash } from 'crypto';
+import { createHash } from 'node:crypto';
import { Resource } from './resource.js';
import {
URLForAdminConsentConfig,
diff --git a/src/resources/drafts.ts b/src/resources/drafts.ts
index 15196295..2a14d14d 100644
--- a/src/resources/drafts.ts
+++ b/src/resources/drafts.ts
@@ -14,7 +14,7 @@ import {
NylasResponse,
} from '../models/response.js';
import {
- encodeAttachmentStreams,
+ encodeAttachmentContent,
calculateTotalPayloadSize,
} from '../utils.js';
import { makePathParams } from '../utils.js';
@@ -138,7 +138,7 @@ export class Drafts extends Resource {
overrides,
});
} else if (requestBody.attachments) {
- const processedAttachments = await encodeAttachmentStreams(
+ const processedAttachments = await encodeAttachmentContent(
requestBody.attachments
);
@@ -183,7 +183,7 @@ export class Drafts extends Resource {
overrides,
});
} else if (requestBody.attachments) {
- const processedAttachments = await encodeAttachmentStreams(
+ const processedAttachments = await encodeAttachmentContent(
requestBody.attachments
);
diff --git a/src/resources/messages.ts b/src/resources/messages.ts
index 33693972..8fe4ed46 100644
--- a/src/resources/messages.ts
+++ b/src/resources/messages.ts
@@ -1,4 +1,4 @@
-import FormData from 'form-data';
+import { Blob, FormData } from 'formdata-node';
import APIClient, { RequestOptionsParams } from '../apiClient.js';
import { Overrides } from '../config.js';
import {
@@ -23,10 +23,11 @@ import {
NylasResponse,
} from '../models/response.js';
import {
- encodeAttachmentStreams,
- objKeysToSnakeCase,
- makePathParams,
+ attachmentStreamToFile,
calculateTotalPayloadSize,
+ encodeAttachmentContent,
+ makePathParams,
+ objKeysToSnakeCase,
} from '../utils.js';
import { AsyncListResponse, Resource } from './resource.js';
import { SmartCompose } from './smartCompose.js';
@@ -248,7 +249,7 @@ export class Messages extends Resource {
requestOptions.form = Messages._buildFormRequest(requestBody);
} else {
if (requestBody.attachments) {
- const processedAttachments = await encodeAttachmentStreams(
+ const processedAttachments = await encodeAttachmentContent(
requestBody.attachments
);
@@ -346,10 +347,7 @@ export class Messages extends Resource {
static _buildFormRequest(
requestBody: CreateDraftRequest | UpdateDraftRequest | SendMessageRequest
): FormData {
- // FormData imports are funky, cjs needs to use .default, es6 doesn't
- const FD = require('form-data');
- const FormDataConstructor = FD.default || FD;
- const form: FormData = new FormDataConstructor();
+ const form = new FormData();
// Split out the message payload from the attachments
const messagePayload = {
@@ -359,13 +357,28 @@ export class Messages extends Resource {
form.append('message', JSON.stringify(objKeysToSnakeCase(messagePayload)));
// Add a separate form field for each attachment
- requestBody.attachments?.forEach((attachment, index) => {
- const contentId = attachment.contentId || `file${index}`;
- form.append(contentId, attachment.content, {
- filename: attachment.filename,
- contentType: attachment.contentType,
+ if (requestBody.attachments && requestBody.attachments.length > 0) {
+ requestBody.attachments.map((attachment, index) => {
+ const contentId = attachment.contentId || `file${index}`;
+ // Handle different content types for formdata-node
+ if (typeof attachment.content === 'string') {
+ // Base64 string - create a Blob
+ const buffer = Buffer.from(attachment.content, 'base64');
+ const blob = new Blob([buffer], { type: attachment.contentType });
+ form.append(contentId, blob, attachment.filename);
+ } else if (Buffer.isBuffer(attachment.content)) {
+ // Buffer - create a Blob
+ const blob = new Blob([attachment.content], {
+ type: attachment.contentType,
+ });
+ form.append(contentId, blob, attachment.filename);
+ } else {
+ // ReadableStream - create a proper file-like object according to formdata-node docs
+ const file = attachmentStreamToFile(attachment);
+ form.append(contentId, file, attachment.filename);
+ }
});
- });
+ }
return form;
}
diff --git a/src/utils.ts b/src/utils.ts
index 5ae41e01..8b2fb29f 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,8 +1,9 @@
import { camelCase, snakeCase } from 'change-case';
-import * as fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
import * as mime from 'mime-types';
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
+import { File as _File, Blob as _Blob } from 'formdata-node';
import { CreateAttachmentRequest } from './models/attachments.js';
export function createFileRequestBuilder(
@@ -43,24 +44,82 @@ function streamToBase64(stream: NodeJS.ReadableStream): Promise {
}
/**
- * Encodes the content of each attachment stream to base64.
+ * Converts a ReadableStream to a File-like object that can be used with FormData.
+ * @param attachment The attachment containing the stream and metadata.
+ * @param mimeType The MIME type for the file (optional).
+ * @returns A File-like object that properly handles the stream.
+ */
+export function attachmentStreamToFile(
+ attachment: CreateAttachmentRequest,
+ mimeType?: string
+): any {
+ if (mimeType != null && typeof mimeType !== 'string') {
+ throw new Error('Invalid mimetype, expected string.');
+ }
+ const content = attachment.content;
+ if (typeof content === 'string' || Buffer.isBuffer(content)) {
+ throw new Error('Invalid attachment content, expected ReadableStream.');
+ }
+
+ // Create a file-shaped object that FormData can handle properly
+ const fileObject = {
+ type: mimeType || attachment.contentType,
+ name: attachment.filename,
+ [Symbol.toStringTag]: 'File',
+ stream() {
+ return content;
+ },
+ };
+
+ // Add size if available
+ if (attachment.size !== undefined) {
+ (fileObject as any).size = attachment.size;
+ }
+
+ return fileObject;
+}
+
+/**
+ * Encodes the content of each attachment to base64.
+ * Handles ReadableStream, Buffer, and string content types.
* @param attachments The attachments to encode.
* @returns The attachments with their content encoded to base64.
*/
-export async function encodeAttachmentStreams(
+export async function encodeAttachmentContent(
attachments: CreateAttachmentRequest[]
): Promise {
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
+ let base64EncodedContent: string;
+
+ if (attachment.content instanceof Readable) {
+ // ReadableStream -> base64
+ base64EncodedContent = await streamToBase64(attachment.content);
+ } else if (Buffer.isBuffer(attachment.content)) {
+ // Buffer -> base64
+ base64EncodedContent = attachment.content.toString('base64');
+ } else {
+ // string (assumed to already be base64)
+ base64EncodedContent = attachment.content as string;
+ }
+
+ return { ...attachment, content: base64EncodedContent };
})
);
}
+/**
+ * @deprecated Use encodeAttachmentContent instead. This alias is provided for backwards compatibility.
+ * 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: CreateAttachmentRequest[]
+): Promise {
+ return encodeAttachmentContent(attachments);
+}
+
/**
* The type of function that converts a string to a different casing.
* @ignore Not for public use.
diff --git a/test-file-size.js b/test-file-size.js
new file mode 100644
index 00000000..f1489f83
--- /dev/null
+++ b/test-file-size.js
@@ -0,0 +1,155 @@
+// Quick test to verify file size generation
+function testLargeContentGeneration() {
+ // Create text content dynamically
+ let textContent =
+ 'This is a dynamically created text file!\n\nGenerated at: ' +
+ new Date().toISOString();
+ let jsonContent = JSON.stringify(
+ {
+ message: 'Hello from Nylas SDK!',
+ timestamp: new Date().toISOString(),
+ data: { temperature: 72, humidity: 45 },
+ },
+ null,
+ 2
+ );
+
+ // Generate large content
+ textContent += '\n\n' + '='.repeat(100) + '\n';
+ textContent += 'LARGE FILE SIMULATION - TARGET SIZE: >3MB\n';
+ textContent += '='.repeat(100) + '\n\n';
+
+ // Generate enough content to exceed 3,145,728 bytes (3MB)
+ const loremIpsum =
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. ';
+
+ // Repeat Lorem ipsum to generate ~1.5MB of text content
+ const targetTextSize = 1572864; // 1.5MB
+ const repeats = Math.ceil(targetTextSize / loremIpsum.length);
+ textContent += loremIpsum.repeat(repeats);
+
+ // Add some structured data
+ textContent += '\n\n' + '='.repeat(100) + '\n';
+ textContent += 'LARGE DATASET SECTION\n';
+ textContent += '='.repeat(100) + '\n\n';
+
+ for (let i = 0; i < 1000; i++) {
+ textContent += `Record ${i}: This is a detailed record with ID ${i} containing extensive information about item ${i}. `;
+ textContent += `Timestamp: ${new Date().toISOString()}, Category: category-${i % 20}, `;
+ textContent += `Tags: tag-${i}, tag-${i + 1}, tag-${i + 2}, tag-${i + 3}, `;
+ textContent += `Properties: color=${['red', 'blue', 'green', 'yellow', 'purple', 'orange'][i % 6]}, `;
+ textContent += `size=${['small', 'medium', 'large', 'extra-large'][i % 4]}, `;
+ textContent += `active=${i % 2 === 0}, priority=${i % 10}, score=${Math.random().toFixed(6)}.\n`;
+ }
+
+ // Create a very large JSON structure to exceed 3MB total
+ const largeData = Array.from({ length: 2000 }, (_, i) => ({
+ id: i,
+ name: `Item ${i}`,
+ description: `This is item number ${i} with extensive additional data to make the JSON file larger. Here's some detailed information about this item including its history, specifications, and metadata.`,
+ timestamp: new Date().toISOString(),
+ details: {
+ category: `category-${i % 25}`,
+ subcategory: `subcategory-${i % 50}`,
+ tags: [
+ `tag-${i}`,
+ `tag-${i + 1}`,
+ `tag-${i + 2}`,
+ `tag-${i + 3}`,
+ `tag-${i + 4}`,
+ ],
+ properties: {
+ color: [
+ 'red',
+ 'blue',
+ 'green',
+ 'yellow',
+ 'purple',
+ 'orange',
+ 'pink',
+ 'cyan',
+ ][i % 8],
+ size: ['tiny', 'small', 'medium', 'large', 'extra-large', 'huge'][
+ i % 6
+ ],
+ weight: `${(Math.random() * 1000).toFixed(2)}kg`,
+ dimensions: {
+ length: `${(Math.random() * 100).toFixed(2)}cm`,
+ width: `${(Math.random() * 100).toFixed(2)}cm`,
+ height: `${(Math.random() * 100).toFixed(2)}cm`,
+ },
+ active: i % 2 === 0,
+ priority: i % 10,
+ score: Math.random(),
+ ratings: Array.from(
+ { length: 20 },
+ () => Math.floor(Math.random() * 5) + 1
+ ),
+ },
+ history: Array.from({ length: 10 }, (_, j) => ({
+ date: new Date(
+ Date.now() - Math.random() * 365 * 24 * 60 * 60 * 1000
+ ).toISOString(),
+ action: [
+ 'created',
+ 'updated',
+ 'viewed',
+ 'edited',
+ 'deleted',
+ 'restored',
+ ][j % 6],
+ user: `user-${j % 100}`,
+ details: `Action ${j} performed on item ${i} with additional context and information.`,
+ })),
+ },
+ }));
+
+ jsonContent = JSON.stringify(
+ {
+ message: 'Hello from Nylas SDK - Large Dataset (>3MB)!',
+ timestamp: new Date().toISOString(),
+ totalItems: largeData.length,
+ estimatedSize: '~2MB JSON content',
+ items: largeData,
+ metadata: {
+ generated: new Date().toISOString(),
+ purpose: 'Large file testing',
+ targetSize: '3145728+ bytes',
+ format: 'JSON',
+ },
+ },
+ null,
+ 2
+ );
+
+ // Calculate sizes
+ const textSize = Buffer.byteLength(textContent, 'utf8');
+ const jsonSize = Buffer.byteLength(jsonContent, 'utf8');
+ const totalSize = textSize + jsonSize;
+ const targetSize = 3145728; // 3MB
+
+ // eslint-disable-next-line no-console
+ console.log(
+ `Text content size: ${textSize.toLocaleString()} bytes (${(textSize / 1024 / 1024).toFixed(2)} MB)`
+ );
+ // eslint-disable-next-line no-console
+ console.log(
+ `JSON content size: ${jsonSize.toLocaleString()} bytes (${(jsonSize / 1024 / 1024).toFixed(2)} MB)`
+ );
+ // eslint-disable-next-line no-console
+ console.log(
+ `Total size: ${totalSize.toLocaleString()} bytes (${(totalSize / 1024 / 1024).toFixed(2)} MB)`
+ );
+ // eslint-disable-next-line no-console
+ console.log(
+ `Target size: ${targetSize.toLocaleString()} bytes (${(targetSize / 1024 / 1024).toFixed(2)} MB)`
+ );
+ // eslint-disable-next-line no-console
+ console.log(`Exceeds target: ${totalSize > targetSize ? 'YES ✅' : 'NO ❌'}`);
+ // eslint-disable-next-line no-console
+ console.log(
+ `Excess: ${totalSize > targetSize ? '+' : ''}${(totalSize - targetSize).toLocaleString()} bytes`
+ );
+}
+
+testLargeContentGeneration();
diff --git a/tests/apiClient.spec.ts b/tests/apiClient.spec.ts
index 5c3a0dc1..17a09acb 100644
--- a/tests/apiClient.spec.ts
+++ b/tests/apiClient.spec.ts
@@ -1,4 +1,3 @@
-import { RequestInfo } from 'node-fetch';
import APIClient, { RequestOptionsParams } from '../src/apiClient';
import {
NylasApiError,
@@ -6,17 +5,15 @@ import {
NylasSdkTimeoutError,
} from '../src/models/error';
import { SDK_VERSION } from '../src/version';
-import { mockedFetch, mockResponse } from './testUtils';
-
-jest.mock('node-fetch', () => {
- const originalModule = jest.requireActual('node-fetch');
- return {
- ...originalModule,
- default: jest.fn(),
- };
-});
+import { mockResponse } from './testUtils';
+
+import fetchMock from 'jest-fetch-mock';
describe('APIClient', () => {
+ beforeEach(() => {
+ fetchMock.resetMocks();
+ });
+
describe('constructor', () => {
it('should initialize all the values', () => {
const client = new APIClient({
@@ -261,7 +258,7 @@ describe('APIClient', () => {
mockResp.headers.set(key, value);
});
- mockedFetch.mockImplementationOnce(() => Promise.resolve(mockResp));
+ fetchMock.mockImplementationOnce(() => Promise.resolve(mockResp));
const response = await client.request({
path: '/test',
@@ -282,7 +279,7 @@ describe('APIClient', () => {
});
it('should throw an error if the response is undefined', async () => {
- mockedFetch.mockImplementationOnce(() =>
+ fetchMock.mockImplementationOnce(() =>
Promise.resolve(undefined as any)
);
@@ -298,7 +295,7 @@ describe('APIClient', () => {
const payload = {
invalid: true,
};
- mockedFetch.mockImplementationOnce(() =>
+ fetchMock.mockImplementationOnce(() =>
Promise.resolve(mockResponse(JSON.stringify(payload), 400))
);
@@ -337,7 +334,7 @@ describe('APIClient', () => {
mockHeaders['x-nylas-api-version']
);
- mockedFetch.mockImplementation(() => Promise.resolve(mockResp));
+ fetchMock.mockImplementation(() => Promise.resolve(mockResp));
try {
await client.request({
@@ -387,7 +384,7 @@ describe('APIClient', () => {
mockHeaders['x-nylas-api-version']
);
- mockedFetch.mockImplementation(() => Promise.resolve(mockResp));
+ fetchMock.mockImplementation(() => Promise.resolve(mockResp));
try {
await client.request({
@@ -405,7 +402,7 @@ describe('APIClient', () => {
it('should respect override timeout when provided in seconds (value < 1000)', async () => {
const overrideTimeout = 2; // 2 second timeout
- mockedFetch.mockImplementationOnce((_url: RequestInfo) => {
+ fetchMock.mockImplementationOnce(() => {
// Immediately throw an AbortError to simulate a timeout
const error = new Error('The operation was aborted');
error.name = 'AbortError';
@@ -434,7 +431,7 @@ describe('APIClient', () => {
try {
const overrideTimeoutMs = 2000; // 2000 milliseconds (2 seconds)
- mockedFetch.mockImplementationOnce((_url: RequestInfo) => {
+ fetchMock.mockImplementationOnce(() => {
// Immediately throw an AbortError to simulate a timeout
const error = new Error('The operation was aborted');
error.name = 'AbortError';
@@ -468,7 +465,7 @@ describe('APIClient', () => {
try {
// Mock fetch to return a successful response so we can verify setTimeout
- mockedFetch.mockImplementationOnce(() =>
+ fetchMock.mockImplementationOnce(() =>
Promise.resolve(mockResponse(JSON.stringify({ data: 'test' })))
);
@@ -503,7 +500,7 @@ describe('APIClient', () => {
try {
// Mock fetch to return a successful response so we can verify setTimeout
- mockedFetch.mockImplementationOnce(() =>
+ fetchMock.mockImplementationOnce(() =>
Promise.resolve(mockResponse(JSON.stringify({ data: 'test' })))
);
@@ -530,7 +527,7 @@ describe('APIClient', () => {
});
it('should use default timeout when no override provided', async () => {
- mockedFetch.mockImplementationOnce((_url: RequestInfo) => {
+ fetchMock.mockImplementationOnce(() => {
// Immediately throw an AbortError to simulate a timeout
const error = new Error('The operation was aborted');
error.name = 'AbortError';
@@ -567,7 +564,7 @@ describe('APIClient', () => {
mockResp.headers.set(key, value);
});
- mockedFetch.mockImplementationOnce(() => Promise.resolve(mockResp));
+ fetchMock.mockImplementationOnce(() => Promise.resolve(mockResp));
const result = await client.request({
path: '/test',
diff --git a/tests/resources/applications.spec.ts b/tests/resources/applications.spec.ts
index ca50b688..5612dfdc 100644
--- a/tests/resources/applications.spec.ts
+++ b/tests/resources/applications.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Applications } from '../../src/resources/applications';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Applications', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/attachments.spec.ts b/tests/resources/attachments.spec.ts
index 573fc45d..a5d60199 100644
--- a/tests/resources/attachments.spec.ts
+++ b/tests/resources/attachments.spec.ts
@@ -1,7 +1,7 @@
import APIClient from '../../src/apiClient';
import { Attachments } from '../../src/resources/attachments';
import { Readable } from 'stream';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Attachments', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/bookings.spec.ts b/tests/resources/bookings.spec.ts
index a4cd88d9..590565d8 100644
--- a/tests/resources/bookings.spec.ts
+++ b/tests/resources/bookings.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Bookings } from '../../src/resources/bookings';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Bookings', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/calendars.spec.ts b/tests/resources/calendars.spec.ts
index 578fb74d..b11c2837 100644
--- a/tests/resources/calendars.spec.ts
+++ b/tests/resources/calendars.spec.ts
@@ -1,7 +1,7 @@
import APIClient from '../../src/apiClient';
import { Calendars } from '../../src/resources/calendars';
import { AvailabilityMethod } from '../../src/models/availability';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Calendars', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/configurations.spec.ts b/tests/resources/configurations.spec.ts
index 1a47b349..20b43b3c 100644
--- a/tests/resources/configurations.spec.ts
+++ b/tests/resources/configurations.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Configurations } from '../../src/resources/configurations';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Configurations', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/contacts.spec.ts b/tests/resources/contacts.spec.ts
index dcbc370d..5296dfa9 100644
--- a/tests/resources/contacts.spec.ts
+++ b/tests/resources/contacts.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Contacts } from '../../src/resources/contacts';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Contacts', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/credentials.spec.ts b/tests/resources/credentials.spec.ts
index ee53ff68..be803153 100644
--- a/tests/resources/credentials.spec.ts
+++ b/tests/resources/credentials.spec.ts
@@ -1,7 +1,7 @@
import APIClient from '../../src/apiClient';
import { CredentialType } from '../../src/models/credentials';
import { Credentials } from '../../src/resources/credentials';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Credentials', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/drafts.spec.ts b/tests/resources/drafts.spec.ts
index 229611ff..1c522c2d 100644
--- a/tests/resources/drafts.spec.ts
+++ b/tests/resources/drafts.spec.ts
@@ -3,11 +3,11 @@ import { CreateAttachmentRequest } from '../../src/models/attachments';
import { Drafts } from '../../src/resources/drafts';
import { objKeysToCamelCase } from '../../src/utils';
import { createReadableStream, MockedFormData } from '../testUtils';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
// Mock the FormData constructor
-jest.mock('form-data', () => {
- return jest.fn().mockImplementation(function (this: MockedFormData) {
+jest.mock('formdata-node', () => ({
+ FormData: jest.fn().mockImplementation(function (this: MockedFormData) {
const appendedData: Record = {};
this.append = (key: string, value: any): void => {
@@ -15,8 +15,23 @@ jest.mock('form-data', () => {
};
this._getAppendedData = (): Record => appendedData;
- });
-});
+ }),
+ Blob: jest.fn().mockImplementation((parts: any[], options?: any) => ({
+ type: options?.type || '',
+ size: parts.reduce((size, part) => size + (part.length || 0), 0),
+ })),
+ File: jest
+ .fn()
+ .mockImplementation((parts: any[], name: string, options?: any) => ({
+ name,
+ type: options?.type || '',
+ size:
+ options?.size ||
+ parts.reduce((size, part) => size + (part.length || 0), 0),
+ stream: () => parts[0],
+ [Symbol.toStringTag]: 'File',
+ })),
+}));
describe('Drafts', () => {
let apiClient: jest.Mocked;
@@ -296,7 +311,14 @@ describe('Drafts', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ // ReadableStream is now wrapped in a file-like object
+ expect(formData.file0).toEqual({
+ type: 'text/plain',
+ name: 'file1.txt',
+ size: 3145728, // 3MB as declared in the attachment
+ stream: expect.any(Function),
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('POST');
expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts');
expect(capturedRequest.overrides).toEqual({
@@ -344,7 +366,14 @@ describe('Drafts', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ // ReadableStream is now wrapped in a file-like object
+ expect(formData.file0).toEqual({
+ type: 'text/plain',
+ name: 'small_file.txt',
+ size: 1000, // 1KB as declared in the attachment
+ stream: expect.any(Function),
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('POST');
expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts');
});
@@ -428,7 +457,14 @@ describe('Drafts', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ // ReadableStream is now wrapped in a file-like object
+ expect(formData.file0).toEqual({
+ type: 'text/plain',
+ name: 'file1.txt',
+ size: 3145728, // 3MB as declared in the attachment
+ stream: expect.any(Function),
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('PUT');
expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts/draft123');
expect(capturedRequest.overrides).toEqual({
@@ -477,7 +513,13 @@ describe('Drafts', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ expect(formData.file0).toEqual({
+ size: 1000, // 1KB as declared in the attachment
+ stream: expect.any(Function),
+ type: 'text/plain',
+ name: 'small_file.txt',
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('PUT');
expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts/draft123');
});
diff --git a/tests/resources/events.spec.ts b/tests/resources/events.spec.ts
index cb91d5cf..55134df9 100644
--- a/tests/resources/events.spec.ts
+++ b/tests/resources/events.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Events } from '../../src/resources/events';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Events', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/messages.spec.ts b/tests/resources/messages.spec.ts
index 31714834..4ae7315f 100644
--- a/tests/resources/messages.spec.ts
+++ b/tests/resources/messages.spec.ts
@@ -7,11 +7,11 @@ import {
Message,
MessageTrackingOptions,
} from '../../src/models/messages';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
// Mock the FormData constructor
-jest.mock('form-data', () => {
- return jest.fn().mockImplementation(function (this: MockedFormData) {
+jest.mock('formdata-node', () => ({
+ FormData: jest.fn().mockImplementation(function (this: MockedFormData) {
const appendedData: Record = {};
this.append = (key: string, value: any): void => {
@@ -19,8 +19,23 @@ jest.mock('form-data', () => {
};
this._getAppendedData = (): Record => appendedData;
- });
-});
+ }),
+ Blob: jest.fn().mockImplementation((parts: any[], options?: any) => ({
+ type: options?.type || '',
+ size: parts.reduce((size, part) => size + (part.length || 0), 0),
+ })),
+ File: jest
+ .fn()
+ .mockImplementation((parts: any[], name: string, options?: any) => ({
+ name,
+ type: options?.type || '',
+ size:
+ options?.size ||
+ parts.reduce((size, part) => size + (part.length || 0), 0),
+ stream: () => parts[0],
+ [Symbol.toStringTag]: 'File',
+ })),
+}));
describe('Messages', () => {
let apiClient: jest.Mocked;
@@ -391,7 +406,14 @@ describe('Messages', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ // ReadableStream is now wrapped in a file-like object
+ expect(formData.file0).toEqual({
+ type: 'text/plain',
+ name: 'file1.txt',
+ size: 3145728, // 3MB as declared in the attachment
+ stream: expect.any(Function),
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('POST');
expect(capturedRequest.path).toEqual('/v3/grants/id123/messages/send');
expect(capturedRequest.overrides).toEqual({
@@ -439,7 +461,14 @@ describe('Messages', () => {
capturedRequest.form as any as MockedFormData
)._getAppendedData();
expect(formData.message).toEqual(JSON.stringify(messageJson));
- expect(formData.file0).toEqual(fileStream);
+ // ReadableStream is now wrapped in a file-like object
+ expect(formData.file0).toEqual({
+ type: 'text/plain',
+ name: 'small_file.txt',
+ size: 1000, // 1KB as declared in the attachment
+ stream: expect.any(Function),
+ [Symbol.toStringTag]: 'File',
+ });
expect(capturedRequest.method).toEqual('POST');
expect(capturedRequest.path).toEqual('/v3/grants/id123/messages/send');
});
diff --git a/tests/resources/redirectUris.spec.ts b/tests/resources/redirectUris.spec.ts
index 180e3267..51b68390 100644
--- a/tests/resources/redirectUris.spec.ts
+++ b/tests/resources/redirectUris.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { RedirectUris } from '../../src/resources/redirectUris';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('RedirectUris', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/sessions.spec.ts b/tests/resources/sessions.spec.ts
index d8e876e8..d14a4596 100644
--- a/tests/resources/sessions.spec.ts
+++ b/tests/resources/sessions.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { Sessions } from '../../src/resources/sessions';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Sessions', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/smartCompose.spec.ts b/tests/resources/smartCompose.spec.ts
index 82bb9e98..e922710d 100644
--- a/tests/resources/smartCompose.spec.ts
+++ b/tests/resources/smartCompose.spec.ts
@@ -1,6 +1,6 @@
import APIClient from '../../src/apiClient';
import { SmartCompose } from '../../src/resources/smartCompose';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('SmartCompose', () => {
let apiClient: jest.Mocked;
diff --git a/tests/resources/webhooks.spec.ts b/tests/resources/webhooks.spec.ts
index 37c9bd29..740df236 100644
--- a/tests/resources/webhooks.spec.ts
+++ b/tests/resources/webhooks.spec.ts
@@ -2,7 +2,7 @@ import APIClient from '../../src/apiClient';
import { Webhooks } from '../../src/resources/webhooks';
import { WebhookTriggers } from '../../src/models/webhooks';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
describe('Webhooks', () => {
let apiClient: jest.Mocked;
diff --git a/tests/setupTests.ts b/tests/setupTests.ts
new file mode 100644
index 00000000..c4e6c932
--- /dev/null
+++ b/tests/setupTests.ts
@@ -0,0 +1,6 @@
+import { enableFetchMocks } from 'jest-fetch-mock';
+
+enableFetchMocks();
+
+// Export for TypeScript module resolution
+export {};
diff --git a/tests/testUtils.ts b/tests/testUtils.ts
index 2d14c75e..a2f1255e 100644
--- a/tests/testUtils.ts
+++ b/tests/testUtils.ts
@@ -1,5 +1,4 @@
/* istanbul ignore file */
-import fetch from 'node-fetch';
import { Readable } from 'stream';
export interface MockedFormData {
@@ -7,8 +6,6 @@ export interface MockedFormData {
_getAppendedData(): Record;
}
-export const mockedFetch = fetch as jest.MockedFunction;
-
export const mockResponse = (body: string, status = 200): any => {
const headers: Record = {};
@@ -48,7 +45,21 @@ export const createReadableStream = (text: string): NodeJS.ReadableStream => {
return new Readable({
read(): void {
this.push(text);
- this.push(null); // indicates EOF
+ this.push(null);
},
});
};
+
+export class MockFormData implements MockedFormData {
+ private data: Record = {};
+
+ // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+ append(key: string, value: any) {
+ this.data[key] = value;
+ }
+
+ // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+ _getAppendedData() {
+ return this.data;
+ }
+}
diff --git a/tests/utils.spec.ts b/tests/utils.spec.ts
index f81fa040..4a34da65 100644
--- a/tests/utils.spec.ts
+++ b/tests/utils.spec.ts
@@ -3,9 +3,13 @@ import {
objKeysToCamelCase,
objKeysToSnakeCase,
makePathParams,
+ encodeAttachmentContent,
+ encodeAttachmentStreams,
} from '../src/utils';
+import { Readable } from 'stream';
+import { CreateAttachmentRequest } from '../src/models/attachments';
-jest.mock('fs', () => {
+jest.mock('node:fs', () => {
return {
statSync: jest.fn(),
createReadStream: jest.fn(),
@@ -27,8 +31,8 @@ describe('createFileRequestBuilder', () => {
beforeEach(() => {
jest.resetAllMocks();
- require('fs').statSync.mockReturnValue(mockedStatSync);
- require('fs').createReadStream.mockReturnValue(mockedReadStream);
+ require('node:fs').statSync.mockReturnValue(mockedStatSync);
+ require('node:fs').createReadStream.mockReturnValue(mockedReadStream);
});
it('should return correct file details for a given filePath', () => {
@@ -275,3 +279,211 @@ describe('makePathParams and safePath', () => {
expect(path).toBe('/v3/grants/%2F%40%23%24%25%5E%26*()');
});
});
+
+describe('encodeAttachmentContent', () => {
+ // Helper function to create a readable stream from a string
+ const createReadableStream = (content: string): NodeJS.ReadableStream => {
+ const stream = new Readable();
+ stream.push(content);
+ stream.push(null); // Signal end of stream
+ return stream;
+ };
+
+ it('should encode Buffer content to base64', async () => {
+ const testContent = 'Hello, World!';
+ const buffer = Buffer.from(testContent, 'utf8');
+ const expectedBase64 = buffer.toString('base64');
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'test.txt',
+ contentType: 'text/plain',
+ content: buffer,
+ size: buffer.length,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(expectedBase64);
+ expect(result[0].filename).toBe('test.txt');
+ expect(result[0].contentType).toBe('text/plain');
+ expect(result[0].size).toBe(buffer.length);
+ });
+
+ it('should encode ReadableStream content to base64', async () => {
+ const testContent = 'Stream content test';
+ const stream = createReadableStream(testContent);
+ const expectedBase64 = Buffer.from(testContent, 'utf8').toString('base64');
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'stream.txt',
+ contentType: 'text/plain',
+ content: stream,
+ size: testContent.length,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(expectedBase64);
+ expect(result[0].filename).toBe('stream.txt');
+ expect(result[0].contentType).toBe('text/plain');
+ });
+
+ it('should pass through string content unchanged', async () => {
+ const base64Content = 'SGVsbG8sIFdvcmxkIQ=='; // "Hello, World!" in base64
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'string.txt',
+ contentType: 'text/plain',
+ content: base64Content,
+ size: 13,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(base64Content);
+ expect(result[0].filename).toBe('string.txt');
+ expect(result[0].contentType).toBe('text/plain');
+ });
+
+ it('should handle mixed content types in a single request', async () => {
+ const bufferContent = Buffer.from('Buffer content', 'utf8');
+ const streamContent = createReadableStream('Stream content');
+ const stringContent = 'U3RyaW5nIGNvbnRlbnQ='; // Already base64
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'buffer.txt',
+ contentType: 'text/plain',
+ content: bufferContent,
+ size: bufferContent.length,
+ },
+ {
+ filename: 'stream.txt',
+ contentType: 'text/plain',
+ content: streamContent,
+ size: 14,
+ },
+ {
+ filename: 'string.txt',
+ contentType: 'text/plain',
+ content: stringContent,
+ size: 13,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(3);
+
+ // Buffer should be converted to base64
+ expect(result[0].content).toBe(bufferContent.toString('base64'));
+ expect(result[0].filename).toBe('buffer.txt');
+
+ // Stream should be converted to base64
+ expect(result[1].content).toBe(
+ Buffer.from('Stream content', 'utf8').toString('base64')
+ );
+ expect(result[1].filename).toBe('stream.txt');
+
+ // String should be passed through
+ expect(result[2].content).toBe(stringContent);
+ expect(result[2].filename).toBe('string.txt');
+ });
+
+ it('should handle binary Buffer content correctly', async () => {
+ // Create a buffer with binary data (some non-text bytes)
+ const binaryData = new Uint8Array([0x00, 0x01, 0x02, 0xff, 0xfe, 0xfd]);
+ const buffer = Buffer.from(binaryData);
+ const expectedBase64 = buffer.toString('base64');
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'binary.bin',
+ contentType: 'application/octet-stream',
+ content: buffer,
+ size: buffer.length,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(expectedBase64);
+ expect(result[0].filename).toBe('binary.bin');
+ expect(result[0].contentType).toBe('application/octet-stream');
+ });
+
+ it('should handle empty Buffer', async () => {
+ const emptyBuffer = Buffer.alloc(0);
+ const expectedBase64 = emptyBuffer.toString('base64'); // Should be empty string
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'empty.txt',
+ contentType: 'text/plain',
+ content: emptyBuffer,
+ size: 0,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(expectedBase64);
+ expect(result[0].filename).toBe('empty.txt');
+ });
+
+ it('should handle large Buffer content', async () => {
+ // Create a 1KB buffer with repeating pattern
+ const largeContent = 'A'.repeat(1024);
+ const largeBuffer = Buffer.from(largeContent, 'utf8');
+ const expectedBase64 = largeBuffer.toString('base64');
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'large.txt',
+ contentType: 'text/plain',
+ content: largeBuffer,
+ size: largeBuffer.length,
+ },
+ ];
+
+ const result = await encodeAttachmentContent(attachments);
+
+ expect(result).toHaveLength(1);
+ expect(result[0].content).toBe(expectedBase64);
+ expect(result[0].filename).toBe('large.txt');
+ expect(result[0].size).toBe(1024);
+ });
+});
+
+describe('encodeAttachmentStreams (backwards compatibility)', () => {
+ it('should work the same as encodeAttachmentContent', async () => {
+ const testContent = 'Backwards compatibility test';
+ const buffer = Buffer.from(testContent, 'utf8');
+
+ const attachments: CreateAttachmentRequest[] = [
+ {
+ filename: 'compat.txt',
+ contentType: 'text/plain',
+ content: buffer,
+ size: buffer.length,
+ },
+ ];
+
+ const newResult = await encodeAttachmentContent(attachments);
+ const oldResult = await encodeAttachmentStreams(attachments);
+
+ expect(oldResult).toEqual(newResult);
+ expect(oldResult[0].content).toBe(buffer.toString('base64'));
+ });
+});