feat: add support for accepting axios options in sendRequest (#299)

This adds logic to extract the Axios options from the request parameters
and pass them to the final request. It also exposes a type for generated
SDKs to utilize, so they don't need to install Axios just for that type.

Signed-off-by: Dustin Popp <[email protected]>

Author: dpopp07

etc/ibm-cloud-sdk-core.api.md

@@ -6,12 +6,15 @@
 
 /// <reference types="node" />
 
+import { GenericAbortSignal as AbortSignal_2 } from 'axios';
 import { AxiosInstance } from 'axios';
 import type { CookieJar } from 'tough-cookie';
 import { Debugger } from 'debug';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
+export { AbortSignal_2 as AbortSignal }
+
 // @public
 export function atLeastOne(...args: any): boolean;
 

index.ts

@@ -18,6 +18,7 @@
  * @module ibm-cloud-sdk-core
  */
 
+export * from './lib/axios-types';
 export { BaseService, UserOptions } from './lib/base-service';
 export * from './auth';
 export * from './lib/helper';

lib/axios-types.ts

@@ -0,0 +1,17 @@
+/**
+ * (C) Copyright IBM Corp. 2025.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { GenericAbortSignal as AbortSignal } from 'axios';

lib/request-wrapper.ts

@@ -245,7 +245,7 @@ export class RequestWrapper {
    */
   public async sendRequest(parameters): Promise<any> {
     const options = extend(true, {}, parameters.defaultOptions, parameters.options);
-    const { path, body, form, formData, qs, method, serviceUrl } = options;
+    const { path, body, form, formData, qs, method, serviceUrl, axiosOptions } = options;
     let { headers, url } = options;
 
     const multipartForm = new FormData();
@@ -329,6 +329,7 @@ export class RequestWrapper {
       raxConfig: this.raxConfig,
       responseType: options.responseType || 'json',
       paramsSerializer: { serialize: (params) => stringify(params) },
+      ...axiosOptions,
     };
 
     return this.axiosInstance(requestParams).then(

test/unit/request-wrapper.test.js

@@ -227,6 +227,43 @@ describe('sendRequest', () => {
     expect(mockAxiosInstance.mock.calls).toHaveLength(1);
   });
 
+  it('should include any specified axios request options', async () => {
+    const parameters = {
+      defaultOptions: {
+        body: 'post=body',
+        formData: '',
+        qs: {},
+        method: 'POST',
+        url: 'https://example.ibm.com/v1',
+        headers: {
+          'test-header': 'test-header-value',
+        },
+        responseType: 'buffer',
+        axiosOptions: {
+          signal: 'mock',
+        },
+      },
+    };
+
+    mockAxiosInstance.mockResolvedValue(axiosResolveValue);
+
+    const res = await requestWrapperInstance.sendRequest(parameters);
+    // assert results
+    expect(mockAxiosInstance.mock.calls[0][0].data).toEqual('post=body');
+    expect(mockAxiosInstance.mock.calls[0][0].url).toEqual('https://example.ibm.com/v1');
+    expect(mockAxiosInstance.mock.calls[0][0].headers).toEqual({
+      'Accept-Encoding': 'gzip',
+      'test-header': 'test-header-value',
+    });
+    expect(mockAxiosInstance.mock.calls[0][0].method).toEqual(parameters.defaultOptions.method);
+    expect(mockAxiosInstance.mock.calls[0][0].responseType).toEqual(
+      parameters.defaultOptions.responseType
+    );
+    expect(mockAxiosInstance.mock.calls[0][0].signal).toEqual('mock');
+    expect(res).toEqual(expectedResult);
+    expect(mockAxiosInstance.mock.calls).toHaveLength(1);
+  });
+
   it('sendRequest should strip trailing slashes', async () => {
     const parameters = {
       defaultOptions: {