Feature: Add support for request headers

jest.config.ts

@@ -6,10 +6,7 @@ const config: Config = {
   restoreMocks: true,
   testEnvironment: 'node',
   transform: {
-    '^.+\\.ts$': [
-      'ts-jest',
-      { diagnostics: { ignoreCodes: ['TS151001'] } }
-    ],
+    '^.+\\.ts$': ['ts-jest', { diagnostics: { ignoreCodes: ['TS151001'] } }],
   },
 };
 

package.json

@@ -36,7 +36,7 @@
     "@types/tough-cookie": "^4.0.5",
     "@typescript-eslint/eslint-plugin": "^6.18.1",
     "@typescript-eslint/parser": "^6.18.1",
-    "axios-mock-adapter": "^1.22.0",
+    "axios-mock-adapter": "^2.0.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.2",

src/client.test.ts

@@ -174,6 +174,26 @@ describe('Client', () => {
       expect(response).toEqual('result');
     });
 
+    test('makes a request with headers', async () => {
+      const client = new Client('id', 'key');
+
+      mock.onGet('/products/:count').reply((config) => {
+        const headers = Object.fromEntries(
+          Object.entries(config.headers || {}),
+        );
+        return [200, headers['X-Foo']];
+      });
+
+      const response = await client.request(
+        HttpMethod.get,
+        '/products/:count',
+        {},
+        { 'X-Foo': 'bar' },
+      );
+
+      expect(response).toEqual('bar');
+    });
+
     test('handles an error response', async () => {
       const client = new Client('id', 'key');
 

src/client.ts

@@ -148,29 +148,30 @@ export class Client {
     });
   }
 
-  get<T>(url: string, data?: unknown): Promise<T> {
-    return this.request(HttpMethod.get, url, data);
+  get<T>(url: string, data?: unknown, headers?: HttpHeaders): Promise<T> {
+    return this.request(HttpMethod.get, url, data, headers);
   }
 
-  post<T>(url: string, data: unknown): Promise<T> {
-    return this.request(HttpMethod.post, url, data);
+  post<T>(url: string, data: unknown, headers?: HttpHeaders): Promise<T> {
+    return this.request(HttpMethod.post, url, data, headers);
   }
 
-  put<T>(url: string, data: unknown): Promise<T> {
-    return this.request(HttpMethod.put, url, data);
+  put<T>(url: string, data: unknown, headers?: HttpHeaders): Promise<T> {
+    return this.request(HttpMethod.put, url, data, headers);
   }
 
-  delete<T>(url: string, data?: unknown): Promise<T> {
-    return this.request(HttpMethod.delete, url, data);
+  delete<T>(url: string, data?: unknown, headers?: HttpHeaders): Promise<T> {
+    return this.request(HttpMethod.delete, url, data, headers);
   }
 
   async request<T>(
     method: HttpMethod,
     url: string,
     data?: unknown,
+    headers?: HttpHeaders,
   ): Promise<T> {
     // Prepare url and data for request
-    const requestParams = transformRequest(method, url, data);
+    const requestParams = transformRequest(method, url, data, headers);
 
     return new Promise((resolve, reject) => {
       const { retries } = this.options;
@@ -221,11 +222,13 @@ function transformRequest(
   method: HttpMethod,
   url: string,
   data: unknown,
+  headers?: HttpHeaders,
 ): axios.AxiosRequestConfig {
   return {
     method,
     url: typeof url?.toString === 'function' ? url.toString() : '',
     data: data !== undefined ? data : null,
+    headers,
   };
 }