Add support for passing in headers to outgoing calls (#552)

This PR allows you to pass in a map of additional, custom headers that can be sent to the Node SDK.
nylas · Apr 5, 2024 · 618d8bd · 618d8bd
1 parent 12e9595
commit 618d8bd
Show file tree

Hide file tree

Showing 19 changed files with 195 additions and 7 deletions.
diff --git a/src/apiClient.ts b/src/apiClient.ts
@@ -65,11 +65,16 @@ export default class APIClient {
    * The timeout for requests to the Nylas API, in seconds
    */
   timeout: number;
+  /**
+   * Additional headers to send with outgoing requests
+   */
+  headers: Record<string, string>;
 
-  constructor({ apiKey, apiUri, timeout }: Required<NylasConfig>) {
+  constructor({ apiKey, apiUri, timeout, headers }: Required<NylasConfig>) {
     this.apiKey = apiKey;
     this.serverUrl = apiUri;
     this.timeout = timeout * 1000; // fetch timeout uses milliseconds
+    this.headers = headers;
   }
 
   private setRequestUrl({
@@ -112,11 +117,17 @@ export default class APIClient {
     headers,
     overrides,
   }: RequestOptionsParams): Record<string, string> {
+    const mergedHeaders: Record<string, string> = {
+      ...headers,
+      ...this.headers,
+      ...overrides?.headers,
+    };
+
     return {
       Accept: 'application/json',
       'User-Agent': `Nylas Node SDK v${SDK_VERSION}`,
       Authorization: `Bearer ${overrides?.apiKey || this.apiKey}`,
-      ...headers,
+      ...mergedHeaders,
     };
   }
 

diff --git a/src/config.ts b/src/config.ts
@@ -3,11 +3,13 @@
  * @property apiKey The Nylas API key to use for authentication
  * @property apiUri The URL to use for communicating with the Nylas API
  * @property timeout The timeout for requests to the Nylas API, in seconds
+ * @property headers Additional headers to send with outgoing requests
  */
 export type NylasConfig = {
   apiKey: string;
   apiUri?: string;
   timeout?: number;
+  headers?: Record<string, string>;
 };
 
 /**

diff --git a/src/models/events.ts b/src/models/events.ts
@@ -354,10 +354,10 @@ type When = Time | Timespan | Date | Datespan;
  * Type representing the different objects representing time and duration when creating events.
  */
 type CreateWhen =
-  | Omit<Time, 'type'>
-  | Omit<Timespan, 'type'>
-  | Omit<Date, 'type'>
-  | Omit<Datespan, 'type'>;
+  | Omit<Time, 'object'>
+  | Omit<Timespan, 'object'>
+  | Omit<Date, 'object'>
+  | Omit<Datespan, 'object'>;
 
 /**
  * Enum representing the different types of when objects.

diff --git a/src/nylas.ts b/src/nylas.ts
@@ -90,6 +90,7 @@ export default class Nylas {
       apiKey: config.apiKey,
       apiUri: config.apiUri || DEFAULT_SERVER_URL,
       timeout: config.timeout || 90,
+      headers: config.headers || {},
     });
 
     this.applications = new Applications(this.apiClient);

diff --git a/tests/apiClient.spec.ts b/tests/apiClient.spec.ts
@@ -18,11 +18,17 @@ describe('APIClient', () => {
         apiKey: 'test',
         apiUri: 'https://test.api.nylas.com',
         timeout: 30,
+        headers: {
+          'X-SDK-Test-Header': 'This is a test',
+        },
       });
 
       expect(client.apiKey).toBe('test');
       expect(client.serverUrl).toBe('https://test.api.nylas.com');
       expect(client.timeout).toBe(30000);
+      expect(client.headers).toEqual({
+        'X-SDK-Test-Header': 'This is a test',
+      });
     });
   });
 
@@ -34,6 +40,7 @@ describe('APIClient', () => {
         apiKey: 'testApiKey',
         apiUri: 'https://api.us.nylas.com',
         timeout: 30,
+        headers: {},
       });
     });
 
@@ -97,13 +104,20 @@ describe('APIClient', () => {
 
     describe('newRequest', () => {
       it('should set all the fields properly', () => {
+        client.headers = {
+          'global-header': 'global-value',
+        };
+
         const options: RequestOptionsParams = {
           path: '/test',
           method: 'POST',
           headers: { 'X-SDK-Test-Header': 'This is a test' },
           queryParams: { param: 'value' },
           body: { id: 'abc123' },
-          overrides: { apiUri: 'https://override.api.nylas.com' },
+          overrides: {
+            apiUri: 'https://override.api.nylas.com',
+            headers: { override: 'bar' },
+          },
         };
         const newRequest = client.newRequest(options);
 
@@ -114,6 +128,8 @@ describe('APIClient', () => {
           'Content-Type': ['application/json'],
           'User-Agent': [`Nylas Node SDK v${SDK_VERSION}`],
           'X-SDK-Test-Header': ['This is a test'],
+          'global-header': ['global-value'],
+          override: ['bar'],
         });
         expect(newRequest.url).toEqual(
           'https://override.api.nylas.com/test?param=value'

diff --git a/tests/resources/applications.spec.ts b/tests/resources/applications.spec.ts
@@ -11,6 +11,7 @@ describe('Applications', () => {
       apiKey: 'apiKey',
       apiUri: 'https://api.nylas.com',
       timeout: 30,
+      headers: {},
     }) as jest.Mocked<APIClient>;
 
     applications = new Applications(apiClient);
@@ -22,6 +23,7 @@ describe('Applications', () => {
       await applications.getDetails({
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -30,6 +32,7 @@ describe('Applications', () => {
         path: '/v3/applications',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });

diff --git a/tests/resources/attachments.spec.ts b/tests/resources/attachments.spec.ts
@@ -12,6 +12,7 @@ describe('Attachments', () => {
       apiKey: 'apiKey',
       apiUri: 'https://test.api.nylas.com',
       timeout: 30,
+      headers: {},
     }) as jest.Mocked<APIClient>;
 
     attachments = new Attachments(apiClient);
@@ -32,6 +33,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -43,6 +45,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -58,6 +61,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -69,6 +73,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -84,6 +89,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -95,6 +101,7 @@ describe('Attachments', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });

diff --git a/tests/resources/auth.spec.ts b/tests/resources/auth.spec.ts
@@ -15,6 +15,7 @@ describe('Auth', () => {
       apiKey: 'apiKey',
       apiUri: 'https://test.api.nylas.com',
       timeout: 30,
+      headers: {},
     });
 
     auth = new Auth(apiClient);
@@ -149,6 +150,7 @@ describe('Auth', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -165,6 +167,7 @@ describe('Auth', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });

diff --git a/tests/resources/calendars.spec.ts b/tests/resources/calendars.spec.ts
@@ -12,6 +12,7 @@ describe('Calendars', () => {
       apiKey: 'apiKey',
       apiUri: 'https://test.api.nylas.com',
       timeout: 30,
+      headers: {},
     }) as jest.Mocked<APIClient>;
 
     calendars = new Calendars(apiClient);
@@ -24,6 +25,7 @@ describe('Calendars', () => {
         identifier: 'id123',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -32,6 +34,7 @@ describe('Calendars', () => {
         path: '/v3/grants/id123/calendars',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -44,6 +47,7 @@ describe('Calendars', () => {
         calendarId: 'calendar123',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -52,6 +56,7 @@ describe('Calendars', () => {
         path: '/v3/grants/id123/calendars/calendar123',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -67,6 +72,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -79,6 +85,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -94,6 +101,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -105,6 +113,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -117,6 +126,7 @@ describe('Calendars', () => {
         calendarId: 'calendar123',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -125,6 +135,7 @@ describe('Calendars', () => {
         path: '/v3/grants/id123/calendars/calendar123',
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });
@@ -160,6 +171,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
 
@@ -193,6 +205,7 @@ describe('Calendars', () => {
         },
         overrides: {
           apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
         },
       });
     });