Merge branch 'main' into CUST-3777-v-3-node-sdk-timeout-is-ignored-if-passed-in-overrides

Author: AaronDDM

CHANGELOG.md

@@ -4,6 +4,7 @@
 * Remove `createdAt` field from message model.
 * Change `latestMessageReceivedDate` & `latestMessageSentDate` to be optional on threads model.
 * Fix issue where timeout was not being respected when overriding the timeout in the request options.
+* Fix issue where query params with array values were not being transformed into comma-delimited strings
 
 ### 7.7.2 / 2024-12-02
 * Fix `credentials` resource to use correct endpoint.

package-lock.json

@@ -107,7 +107,9 @@ export default class APIClient {
           }
           url.searchParams.set('metadata_pair', metadataPair.join(','));
         } else if (Array.isArray(value)) {
-          url.searchParams.append(snakeCaseKey, value.join(','));
+          for (const item of value) {
+            url.searchParams.append(snakeCaseKey, item as string);
+          }
         } else if (typeof value === 'object') {
           for (const item in value) {
             url.searchParams.append(

src/apiClient.ts

@@ -71,8 +71,20 @@ export class Threads extends Resource {
   }: ListThreadsParams & Overrides): AsyncListResponse<
     NylasListResponse<Thread>
   > {
+    const modifiedQueryParams: Record<string, unknown> | undefined = queryParams
+      ? { ...queryParams }
+      : undefined;
+
+    // Transform some query params that are arrays into comma-delimited strings
+    if (modifiedQueryParams && queryParams) {
+      if (Array.isArray(queryParams?.anyEmail)) {
+        delete modifiedQueryParams.anyEmail;
+        modifiedQueryParams['any_email'] = queryParams.anyEmail.join(',');
+      }
+    }
+
     return super._list<NylasListResponse<Thread>>({
-      queryParams,
+      queryParams: modifiedQueryParams,
       overrides,
       path: `/v3/grants/${identifier}/threads`,
     });

src/resources/threads.ts

@@ -115,7 +115,23 @@ describe('APIClient', () => {
 
         expect(options.url).toEqual(
           new URL(
-            'https://api.us.nylas.com/test?foo=bar&list=a%2Cb%2Cc&map=key1%3Avalue1&map=key2%3Avalue2'
+            'https://api.us.nylas.com/test?foo=bar&list=a&list=b&list=c&map=key1%3Avalue1&map=key2%3Avalue2'
+          )
+        );
+      });
+
+      it('should handle repeated query parameters', () => {
+        const options = client.requestOptions({
+          path: '/test',
+          method: 'GET',
+          queryParams: {
+            eventType: ['default', 'outOfOffice', 'focusTime'],
+          },
+        });
+
+        expect(options.url).toEqual(
+          new URL(
+            'https://api.us.nylas.com/test?event_type=default&event_type=outOfOffice&event_type=focusTime'
           )
         );
       });

tests/apiClient.spec.ts

@@ -1,12 +1,12 @@
 import APIClient from '../../src/apiClient';
 import { Threads } from '../../src/resources/threads';
-jest.mock('../src/apiClient');
+jest.mock('../../src/apiClient');
 
 describe('Threads', () => {
   let apiClient: jest.Mocked<APIClient>;
   let threads: Threads;
 
-  beforeAll(() => {
+  beforeEach(() => {
     apiClient = new APIClient({
       apiKey: 'apiKey',
       apiUri: 'https://test.api.nylas.com',
@@ -37,6 +37,25 @@ describe('Threads', () => {
         },
       });
     });
+
+    it('should transform anyEmail array into comma-delimited any_email parameter', async () => {
+      const mockEmails = ['[email protected]', '[email protected]'];
+      await threads.list({
+        identifier: 'id123',
+        queryParams: {
+          anyEmail: mockEmails,
+        },
+      });
+
+      expect(apiClient.request).toHaveBeenCalledWith({
+        method: 'GET',
+        path: '/v3/grants/id123/threads',
+        overrides: undefined,
+        queryParams: {
+          any_email: mockEmails.join(','),
+        },
+      });
+    });
   });
 
   describe('find', () => {