nylas 7.13.3 → 8.0.1

package/README.md

@@ -1,12 +1,30 @@
-<a href="https://www.nylas.com/">
-    <img src="https://brand.nylas.com/assets/downloads/logo_horizontal_png/Nylas-Logo-Horizontal-Blue_.png" alt="Aimeos logo" title="Aimeos" align="right" height="60" />
-</a>
-
-# Nylas Node.js SDK  
-
-[![npm](https://img.shields.io/npm/v/nylas)
-](https://www.npmjs.com/package/nylas)
-[![codecov](https://codecov.io/gh/nylas/nylas-nodejs/branch/main/graph/badge.svg?token=94IMGU4F09)](https://codecov.io/gh/nylas/nylas-nodejs)
+<div align="center">
+  <a href="https://www.nylas.com/">
+    <img src="/diagrams/nylas-logo.png" alt="Nylas" height="80" />
+  </a>
+  
+  <h1>Nylas Node.js SDK</h1>
+  
+  <p>
+    <strong>The official Node.js SDK for the Nylas Communications Platform</strong>
+  </p>
+  
+  <p>
+    <a href="https://www.npmjs.com/package/nylas"><img src="https://img.shields.io/npm/v/nylas" alt="npm version" /></a>
+    <a href="https://codecov.io/gh/nylas/nylas-nodejs"><img src="https://codecov.io/gh/nylas/nylas-nodejs/branch/main/graph/badge.svg?token=94IMGU4F09" alt="code coverage" /></a>
+    <a href="https://www.npmjs.com/package/nylas"><img src="https://img.shields.io/npm/dm/nylas" alt="downloads" /></a>
+    <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" /></a>
+  </p>
+  
+  <p>
+    <a href="https://developer.nylas.com/docs/v3/sdks/node/">📖 Documentation</a> •
+    <a href="https://dashboard.nylas.com/register">🚀 Get Started</a> •
+    <a href="https://github.com/orgs/nylas-samples/repositories?q=&type=all&language=javascript">💡 Examples</a> •
+    <a href="https://developer.nylas.com/docs/api/">📚 API Reference</a>
+  </p>
+</div>
+
+<br />
 
 This is the GitHub repository for the Nylas Node SDK. This repo is primarily for anyone who wants to make contributions to the SDK, or install it from source. If you are looking to use Node to access the Nylas Email, Calendar, or Contacts API you should refer to our official [Node SDK Quickstart Guide](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
 

package/lib/cjs/apiClient.js

@@ -4,8 +4,9 @@ exports.REQUEST_ID_HEADER = exports.FLOW_ID_HEADER = void 0;
 const error_js_1 = require("./models/error.js");
 const utils_js_1 = require("./utils.js");
 const version_js_1 = require("./version.js");
+const form_data_encoder_1 = require("form-data-encoder");
+const stream_1 = require("stream");
 const change_case_1 = require("change-case");
-const fetchWrapper_js_1 = require("./utils/fetchWrapper.js");
 /**
  * The header key for the debugging flow ID
  */
@@ -94,7 +95,6 @@ class APIClient {
             controller.abort();
         }, timeoutDuration);
         try {
-            const fetch = await (0, fetchWrapper_js_1.getFetch)();
             const response = await fetch(req, {
                 signal: controller.signal,
             });
@@ -156,18 +156,32 @@ class APIClient {
             requestOptions.headers['Content-Type'] = 'application/json';
         }
         if (optionParams.form) {
-            requestOptions.body = optionParams.form;
+            // Use FormDataEncoder to properly encode the form data with the correct
+            // Content-Type header including the multipart boundary.
+            // This is required for Node.js environments where formdata-node's FormData
+            // doesn't automatically set the Content-Type header on fetch requests.
+            const encoder = new form_data_encoder_1.FormDataEncoder(optionParams.form);
+            // Set the Content-Type header with the boundary from the encoder
+            requestOptions.headers['Content-Type'] = encoder.contentType;
+            // Convert the encoded form data to a readable stream for the request body
+            requestOptions.body = stream_1.Readable.from(encoder);
+            // Node.js native fetch requires duplex: 'half' when sending a streaming body
+            requestOptions.duplex = 'half';
         }
         return requestOptions;
     }
     async newRequest(options) {
         const newOptions = this.requestOptions(options);
-        const RequestConstructor = await (0, fetchWrapper_js_1.getRequest)();
-        return new RequestConstructor(newOptions.url, {
+        const requestInit = {
             method: newOptions.method,
             headers: newOptions.headers,
             body: newOptions.body,
-        });
+        };
+        // Add duplex option for streaming bodies (required by Node.js native fetch)
+        if (newOptions.duplex) {
+            requestInit.duplex = newOptions.duplex;
+        }
+        return new Request(newOptions.url, requestInit);
     }
     async requestWithResponse(response) {
         const headers = response?.headers?.entries
@@ -200,11 +214,11 @@ class APIClient {
     }
     async requestRaw(options) {
         const response = await this.sendRequest(options);
-        return response.buffer();
+        const arrayBuffer = await response.arrayBuffer();
+        return Buffer.from(arrayBuffer);
     }
     async requestStream(options) {
         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');
         }

package/lib/cjs/resources/folders.js

@@ -32,12 +32,13 @@ class Folders extends resource_js_1.Resource {
      * Return a Folder
      * @return The folder
      */
-    find({ identifier, folderId, overrides, }) {
+    find({ identifier, folderId, queryParams, overrides, }) {
         return super._find({
             path: (0, utils_js_1.makePathParams)('/v3/grants/{identifier}/folders/{folderId}', {
                 identifier,
                 folderId,
             }),
+            queryParams,
             overrides,
         });
     }

package/lib/cjs/version.js

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

package/lib/esm/apiClient.js

@@ -1,8 +1,9 @@
 import { NylasApiError, NylasOAuthError, NylasSdkTimeoutError, } from './models/error.js';
 import { objKeysToCamelCase, objKeysToSnakeCase } from './utils.js';
 import { SDK_VERSION } from './version.js';
+import { FormDataEncoder } from 'form-data-encoder';
+import { Readable } from 'stream';
 import { snakeCase } from 'change-case';
-import { getFetch, getRequest } from './utils/fetchWrapper.js';
 /**
  * The header key for the debugging flow ID
  */
@@ -91,7 +92,6 @@ export default class APIClient {
             controller.abort();
         }, timeoutDuration);
         try {
-            const fetch = await getFetch();
             const response = await fetch(req, {
                 signal: controller.signal,
             });
@@ -153,18 +153,32 @@ export default class APIClient {
             requestOptions.headers['Content-Type'] = 'application/json';
         }
         if (optionParams.form) {
-            requestOptions.body = optionParams.form;
+            // Use FormDataEncoder to properly encode the form data with the correct
+            // Content-Type header including the multipart boundary.
+            // This is required for Node.js environments where formdata-node's FormData
+            // doesn't automatically set the Content-Type header on fetch requests.
+            const encoder = new FormDataEncoder(optionParams.form);
+            // Set the Content-Type header with the boundary from the encoder
+            requestOptions.headers['Content-Type'] = encoder.contentType;
+            // Convert the encoded form data to a readable stream for the request body
+            requestOptions.body = Readable.from(encoder);
+            // Node.js native fetch requires duplex: 'half' when sending a streaming body
+            requestOptions.duplex = 'half';
         }
         return requestOptions;
     }
     async newRequest(options) {
         const newOptions = this.requestOptions(options);
-        const RequestConstructor = await getRequest();
-        return new RequestConstructor(newOptions.url, {
+        const requestInit = {
             method: newOptions.method,
             headers: newOptions.headers,
             body: newOptions.body,
-        });
+        };
+        // Add duplex option for streaming bodies (required by Node.js native fetch)
+        if (newOptions.duplex) {
+            requestInit.duplex = newOptions.duplex;
+        }
+        return new Request(newOptions.url, requestInit);
     }
     async requestWithResponse(response) {
         const headers = response?.headers?.entries
@@ -197,11 +211,11 @@ export default class APIClient {
     }
     async requestRaw(options) {
         const response = await this.sendRequest(options);
-        return response.buffer();
+        const arrayBuffer = await response.arrayBuffer();
+        return Buffer.from(arrayBuffer);
     }
     async requestStream(options) {
         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');
         }

package/lib/esm/resources/folders.js

@@ -29,12 +29,13 @@ export class Folders extends Resource {
      * Return a Folder
      * @return The folder
      */
-    find({ identifier, folderId, overrides, }) {
+    find({ identifier, folderId, queryParams, overrides, }) {
         return super._find({
             path: makePathParams('/v3/grants/{identifier}/folders/{folderId}', {
                 identifier,
                 folderId,
             }),
+            queryParams,
             overrides,
         });
     }

package/lib/esm/version.js

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

package/lib/types/apiClient.d.ts

@@ -1,6 +1,5 @@
 import { NylasConfig, OverridableNylasConfig } from './config.js';
 import { FormData } from 'formdata-node';
-import type { Request, Response } from './utils/fetchWrapper.js';
 /**
  * The header key for the debugging flow ID
  */
@@ -45,6 +44,7 @@ interface RequestOptions {
     url: URL;
     body?: any;
     overrides?: Partial<NylasConfig>;
+    duplex?: 'half';
 }
 /**
  * The API client for communicating with the Nylas API
@@ -77,6 +77,6 @@ export default class APIClient {
     requestWithResponse<T>(response: Response): Promise<T>;
     request<T>(options: RequestOptionsParams): Promise<T>;
     requestRaw(options: RequestOptionsParams): Promise<Buffer>;
-    requestStream(options: RequestOptionsParams): Promise<NodeJS.ReadableStream>;
+    requestStream(options: RequestOptionsParams): Promise<ReadableStream<Uint8Array>>;
 }
 export {};

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

@@ -130,6 +130,11 @@ export interface Event {
      * Master event id if recurring events.
      */
     masterEventId?: string;
+    /**
+     * The original start time of the event, in Unix timestamp format.
+     * This field is present only if the event is an instance of a recurring event.
+     */
+    originalStartTime?: number;
     /**
      * Notetaker meeting bot settings
      */

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

@@ -95,4 +95,20 @@ export interface ListFolderQueryParams extends ListQueryParams {
      */
     singleLevel?: boolean;
 }
+/**
+ * Interface representing the query parameters for finding a folder.
+ */
+export interface FindFolderQueryParams {
+    /**
+     * (Microsoft only) When true, Nylas includes hidden folders in its response.
+     * @default false
+     */
+    includeHiddenFolders?: boolean;
+    /**
+     * Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at).
+     * This allows you to receive only the portion of object data that you're interested in.
+     * You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.
+     */
+    select?: string;
+}
 export type UpdateFolderRequest = Partial<CreateFolderRequest>;

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

@@ -46,7 +46,7 @@ export declare class Attachments extends Resource {
      * @param queryParams The query parameters to include in the request
      * @returns {NodeJS.ReadableStream} The ReadableStream containing the file data.
      */
-    download({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<NodeJS.ReadableStream>;
+    download({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<ReadableStream<Uint8Array>>;
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

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

@@ -1,5 +1,5 @@
 import { Overrides } from '../config.js';
-import { Folder, CreateFolderRequest, UpdateFolderRequest, ListFolderQueryParams } from '../models/folders.js';
+import { Folder, CreateFolderRequest, UpdateFolderRequest, ListFolderQueryParams, FindFolderQueryParams } from '../models/folders.js';
 import { NylasBaseResponse, NylasResponse, NylasListResponse } from '../models/response.js';
 import { Resource, AsyncListResponse } from './resource.js';
 /**
@@ -15,10 +15,12 @@ interface ListFoldersParams {
  * The parameters for the {@link Folders.find} method
  * @property identifier The identifier of the grant to act upon
  * @property folderId The id of the Folder to retrieve
+ * @property queryParams The query parameters to include in the request
  */
 interface FindFolderParams {
     identifier: string;
     folderId: string;
+    queryParams?: FindFolderQueryParams;
 }
 /**
  * The parameters for the {@link Folders.create} method
@@ -72,7 +74,7 @@ export declare class Folders extends Resource {
      * Return a Folder
      * @return The folder
      */
-    find({ identifier, folderId, overrides, }: FindFolderParams & Overrides): Promise<NylasResponse<Folder>>;
+    find({ identifier, folderId, queryParams, overrides, }: FindFolderParams & Overrides): Promise<NylasResponse<Folder>>;
     /**
      * Create a Folder
      * @return The created folder

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

@@ -47,7 +47,7 @@ export declare class Resource {
     protected _updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>;
     protected _destroy<T>({ path, queryParams, requestBody, overrides, }: DestroyParams): Promise<T>;
     protected _getRaw({ path, queryParams, overrides, }: FindParams<void>): Promise<Buffer>;
-    protected _getStream({ path, queryParams, overrides, }: FindParams<void>): Promise<NodeJS.ReadableStream>;
+    protected _getStream({ path, queryParams, overrides, }: FindParams<void>): Promise<ReadableStream<Uint8Array>>;
 }
 type ListYieldReturn<T> = T & {
     next: () => Promise<IteratorResult<T, undefined>>;

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.13.3";
+export declare const SDK_VERSION = "8.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "7.13.3",
+  "version": "8.0.1",
   "description": "A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.",
   "main": "lib/cjs/nylas.js",
   "types": "lib/types/nylas.d.ts",
@@ -11,7 +11,7 @@
     "cjs-wrapper.d.ts"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "scripts": {
     "test": "jest",
@@ -26,8 +26,8 @@
     "generate-model-index": "node scripts/generateModelIndex.js",
     "prebuild": "npm run export-version && npm run generate-model-index",
     "build": "rm -rf lib && npm run build-esm && npm run build-cjs && npm run generate-lib-package-json",
-    "build-esm": "node scripts/setupFetchWrapper.js esm && tsc -p tsconfig.esm.json",
-    "build-cjs": "node scripts/setupFetchWrapper.js cjs && tsc -p tsconfig.cjs.json",
+    "build-esm": "tsc -p tsconfig.esm.json",
+    "build-cjs": "tsc -p tsconfig.cjs.json",
     "prepare": "npm run build",
     "build:docs": "typedoc --out docs",
     "version": "npm run export-version && git add src/version.ts"
@@ -45,7 +45,6 @@
     "form-data-encoder": "^4.1.0",
     "formdata-node": "^6.0.3",
     "mime-types": "^2.1.35",
-    "node-fetch": "^3.3.2",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

package/lib/cjs/utils/fetchWrapper-cjs.js

@@ -1,55 +0,0 @@
-"use strict";
-/**
- * Fetch wrapper for CJS builds - uses dynamic imports for node-fetch compatibility
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFetch = getFetch;
-exports.getRequest = getRequest;
-exports.getResponse = getResponse;
-// Cache for the dynamically imported module
-let nodeFetchModule = null;
-/**
- * Get fetch function - uses dynamic import for CJS
- */
-async function getFetch() {
-    // In test environment, use global fetch (mocked by jest-fetch-mock)
-    if (typeof global !== 'undefined' && global.fetch) {
-        return global.fetch;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.default;
-}
-/**
- * Get Request constructor - uses dynamic import for CJS
- */
-async function getRequest() {
-    // In test environment, use global Request or a mock
-    if (typeof global !== 'undefined' && global.Request) {
-        return global.Request;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.Request;
-}
-/**
- * Get Response constructor - uses dynamic import for CJS
- */
-async function getResponse() {
-    // In test environment, use global Response or a mock
-    if (typeof global !== 'undefined' && global.Response) {
-        return global.Response;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.Response;
-}

package/lib/cjs/utils/fetchWrapper.js

@@ -1,55 +0,0 @@
-"use strict";
-/**
- * Fetch wrapper for CJS builds - uses dynamic imports for node-fetch compatibility
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFetch = getFetch;
-exports.getRequest = getRequest;
-exports.getResponse = getResponse;
-// Cache for the dynamically imported module
-let nodeFetchModule = null;
-/**
- * Get fetch function - uses dynamic import for CJS
- */
-async function getFetch() {
-    // In test environment, use global fetch (mocked by jest-fetch-mock)
-    if (typeof global !== 'undefined' && global.fetch) {
-        return global.fetch;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.default;
-}
-/**
- * Get Request constructor - uses dynamic import for CJS
- */
-async function getRequest() {
-    // In test environment, use global Request or a mock
-    if (typeof global !== 'undefined' && global.Request) {
-        return global.Request;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.Request;
-}
-/**
- * Get Response constructor - uses dynamic import for CJS
- */
-async function getResponse() {
-    // In test environment, use global Response or a mock
-    if (typeof global !== 'undefined' && global.Response) {
-        return global.Response;
-    }
-    if (!nodeFetchModule) {
-        // Use Function constructor to prevent TypeScript from converting to require()
-        const dynamicImport = new Function('specifier', 'return import(specifier)');
-        nodeFetchModule = (await dynamicImport('node-fetch'));
-    }
-    return nodeFetchModule.Response;
-}

package/lib/esm/utils/fetchWrapper-esm.js

@@ -1,22 +0,0 @@
-/**
- * Fetch wrapper for ESM builds - uses static imports for optimal performance
- */
-import fetch, { Request, Response } from 'node-fetch';
-/**
- * Get fetch function - uses static import for ESM
- */
-export async function getFetch() {
-    return fetch;
-}
-/**
- * Get Request constructor - uses static import for ESM
- */
-export async function getRequest() {
-    return Request;
-}
-/**
- * Get Response constructor - uses static import for ESM
- */
-export async function getResponse() {
-    return Response;
-}

package/lib/esm/utils/fetchWrapper.js

@@ -1,22 +0,0 @@
-/**
- * Fetch wrapper for ESM builds - uses static imports for optimal performance
- */
-import fetch, { Request, Response } from 'node-fetch';
-/**
- * Get fetch function - uses static import for ESM
- */
-export async function getFetch() {
-    return fetch;
-}
-/**
- * Get Request constructor - uses static import for ESM
- */
-export async function getRequest() {
-    return Request;
-}
-/**
- * Get Response constructor - uses static import for ESM
- */
-export async function getResponse() {
-    return Response;
-}

package/lib/types/utils/fetchWrapper-cjs.d.ts

@@ -1,19 +0,0 @@
-/**
- * Fetch wrapper for CJS builds - uses dynamic imports for node-fetch compatibility
- */
-/**
- * Get fetch function - uses dynamic import for CJS
- */
-export declare function getFetch(): Promise<any>;
-/**
- * Get Request constructor - uses dynamic import for CJS
- */
-export declare function getRequest(): Promise<any>;
-/**
- * Get Response constructor - uses dynamic import for CJS
- */
-export declare function getResponse(): Promise<any>;
-export type RequestInit = any;
-export type HeadersInit = any;
-export type Request = any;
-export type Response = any;

package/lib/types/utils/fetchWrapper-esm.d.ts

@@ -1,18 +0,0 @@
-/**
- * Fetch wrapper for ESM builds - uses static imports for optimal performance
- */
-import fetch, { Request, Response } from 'node-fetch';
-import type { RequestInit, HeadersInit } from 'node-fetch';
-/**
- * Get fetch function - uses static import for ESM
- */
-export declare function getFetch(): Promise<typeof fetch>;
-/**
- * Get Request constructor - uses static import for ESM
- */
-export declare function getRequest(): Promise<typeof Request>;
-/**
- * Get Response constructor - uses static import for ESM
- */
-export declare function getResponse(): Promise<typeof Response>;
-export type { RequestInit, HeadersInit, Request, Response };

package/lib/types/utils/fetchWrapper.d.ts

@@ -1,19 +0,0 @@
-/**
- * Fetch wrapper for CJS builds - uses dynamic imports for node-fetch compatibility
- */
-/**
- * Get fetch function - uses dynamic import for CJS
- */
-export declare function getFetch(): Promise<any>;
-/**
- * Get Request constructor - uses dynamic import for CJS
- */
-export declare function getRequest(): Promise<any>;
-/**
- * Get Response constructor - uses dynamic import for CJS
- */
-export declare function getResponse(): Promise<any>;
-export type RequestInit = any;
-export type HeadersInit = any;
-export type Request = any;
-export type Response = any;