Allow override of "user-agent" header and fix "pg" options in /hooks and /connections (#4)

Author: pedrokehl

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@makehq/sdk",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "description": "Make TypeScript SDK",
     "license": "MIT",
     "author": "Make",

package.json

@@ -1,4 +1,4 @@
-import type { FetchFunction, JSONValue, Pagination, PickColumns } from '../types.js';
+import type { FetchFunction, JSONValue, PickColumns } from '../types.js';
 
 /**
  * Represents a connection in Make.
@@ -67,8 +67,6 @@ export type ListConnectionsOptions<C extends keyof Connection = never> = {
     type?: string[];
     /** Team ID to filter connections by (can override the main parameter) */
     teamId?: number;
-    /** Pagination options */
-    pg?: Partial<Pagination<Connection>>;
 };
 
 /**
@@ -214,7 +212,6 @@ export class Connections {
                     teamId,
                     type: options?.type,
                     cols: options?.cols,
-                    pg: options?.pg,
                 },
             })
         ).connections;

src/endpoints/connections.ts

@@ -165,6 +165,7 @@ export class Hooks {
                     typeName: options?.typeName,
                     assigned: options?.assigned,
                     viewForScenarioId: options?.viewForScenarioId,
+                    pg: options?.pg,
                 },
             })
         ).hooks;

src/endpoints/hooks.ts

@@ -29,6 +29,12 @@ export class Make {
      */
     public readonly zone: string;
 
+    /**
+     * Request Headers
+     * Can be used to set custom headers for all requests
+     */
+    private readonly headers: Record<string, string>;
+
     /**
      * The API version to use
      * Default is version 2 of the Make API
@@ -129,12 +135,15 @@ export class Make {
      * Create a new Make SDK instance
      * @param token Your Make API key or OAuth2 access token
      * @param zone The Make zone (e.g. eu1.make.com)
-     * @param version API version to use (defaults to 2)
+     * @param options Optional configuration
+     * @param options.version API version to use (defaults to 2)
+     * @param options.headers Custom headers to include in all requests
      */
-    constructor(token: string, zone: string, version = 2) {
+    constructor(token: string, zone: string, options: { version?: number, headers?: Record<string, string> } = {}) {
         this.#token = token;
         this.zone = zone;
-        this.version = version;
+        this.version = options.version ?? 2;
+        this.headers = options.headers ?? {};
         this.protocol = 'https';
 
         this.users = new Users(this.fetch.bind(this));
@@ -167,12 +176,14 @@ export class Make {
      * @internal
      */
     public async fetch<T = unknown>(url: string, options?: FetchOptions): Promise<T> {
-        options = Object.assign({}, options, {
-            headers: Object.assign({}, options?.headers, {
+        options = {
+            ...options,
+            headers: {
                 'user-agent': `MakeTypeScriptSDK/${VERSION}`,
+                ...this.headers,
                 authorization: `${isAPIKey(this.#token) ? 'Token' : 'Bearer'} ${this.#token}`,
-            }),
-        });
+            },
+        };
 
         if (url.charAt(0) === '/') {
             if (url.charAt(1) === '/') {

src/make.ts

@@ -32,4 +32,22 @@ describe('Make SDK', () => {
 
         await expect(make.users.me()).rejects.toThrow('Bad Request');
     });
+
+    it('Should allow overriding user-agent header', async () => {
+        const makeWithCustomHeaders = new Make(MAKE_API_KEY, MAKE_ZONE, { headers: { 'user-agent': 'CustomUserAgent' } });
+        mockFetch('GET https://make.local/api/v2/users/me', { authUser: null }, req => {
+            expect(req.headers.get('user-agent')).toBe('CustomUserAgent');
+        });
+
+        expect(await makeWithCustomHeaders.users.me()).toBe(null);
+    });
+
+    it('Should allow passing custom headers to all requests', async () => {
+        const makeWithCustomHeaders = new Make(MAKE_API_KEY, MAKE_ZONE, { headers: { 'x-custom-header': 'FooBar' } });
+        mockFetch('GET https://make.local/api/v2/users/me', { authUser: null }, req => {
+            expect(req.headers.get('x-custom-header')).toBe('FooBar');
+        });
+
+        expect(await makeWithCustomHeaders.users.me()).toBe(null);
+    });
 });