@serenity-js/rest 3.10.4 → 3.11.1

package/lib/screenplay/questions/LastResponse.js

@@ -19,7 +19,7 @@ const abilities_1 = require("../abilities");
  *     author: string;
  * }
  *
- * await actorCalled('Apisit')
+ * await actorCalled('Apisitt')
  *   .whoCan(CallAnApi.at('https://api.example.org/'))
  *   .attemptsTo(
  *     Send.a(GetRequest.to('/books/0-688-00230-7')),
@@ -61,7 +61,7 @@ const abilities_1 = require("../abilities");
  * ```
  *
  * ## Learn more
- * - [AxiosResponse](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L133-L140)
+ * - [AxiosResponse](https://axios-http.com/docs/res_schema)
  *
  * @group Questions
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/rest",
-  "version": "3.10.4",
+  "version": "3.11.1",
   "description": "Test REST APIs with Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -45,14 +45,19 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.10.4",
-    "axios": "^1.5.0"
+    "@serenity-js/core": "3.11.1",
+    "agent-base": "^7.1.0",
+    "axios": "^1.5.1",
+    "http-proxy-agent": "^7.0.0",
+    "https-proxy-agent": "^7.0.2",
+    "lru-cache": "^10.0.1",
+    "proxy-from-env": "^1.1.0"
   },
   "devDependencies": {
     "@integration/testing-tools": "3.0.0",
-    "@serenity-js/assertions": "3.10.4",
+    "@serenity-js/assertions": "3.11.1",
     "@types/chai": "^4.3.6",
-    "@types/mocha": "^10.0.1",
+    "@types/mocha": "^10.0.2",
     "axios-mock-adapter": "1.22.0",
     "c8": "8.0.1",
     "mocha": "^10.2.0",
@@ -60,5 +65,5 @@
     "ts-node": "^10.9.1",
     "typescript": "5.1.6"
   },
-  "gitHead": "28f12bd6029a9a6c1d8e492486138bf0c83916cd"
+  "gitHead": "b3e36f6e42eb2c545afa961946469fb6dd93f4df"
 }

package/src/index.ts

@@ -1,2 +1 @@
-export * from './models';
 export * from './screenplay';

package/src/screenplay/abilities/AxiosRequestConfigDefaults.ts

@@ -0,0 +1,15 @@
+import { type CreateAxiosDefaults } from 'axios';
+
+export type AxiosRequestConfigProxyDefaults = {
+    host: string;
+    port?: number;          // SOCKS proxies don't require port number
+    auth?: {
+        username: string;
+        password: string;
+    };
+    protocol?: string;
+}
+
+export type AxiosRequestConfigDefaults<Data = any> = Omit<CreateAxiosDefaults<Data>, 'proxy'> & {
+    proxy?: AxiosRequestConfigProxyDefaults | false;
+}

package/src/screenplay/abilities/CallAnApi.ts

@@ -1,13 +1,31 @@
-import { Ability, ConfigurationError, LogicError, TestCompromisedError } from '@serenity-js/core';
-import type { AxiosDefaults, AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import axios from 'axios';
+import { Ability, ConfigurationError, Duration, LogicError, TestCompromisedError } from '@serenity-js/core';
+import axios, {
+    Axios,
+    type AxiosDefaults,
+    type AxiosError,
+    type AxiosInstance,
+    type AxiosRequestConfig,
+    type AxiosResponse,
+    type CreateAxiosDefaults,
+} from 'axios';
+
+import type { AxiosRequestConfigDefaults, AxiosRequestConfigProxyDefaults } from './AxiosRequestConfigDefaults';
+import { axiosProxyOverridesFor } from './proxy';
 
 /**
- * An {@apilink Ability} that enables the {@apilink Actor} to call an HTTP API.
+ * An {@apilink Ability} that wraps [axios client](https://axios-http.com/docs/api_intro) and enables
+ * the {@apilink Actor} to {@apilink Send} {@apilink HTTPRequest|HTTP requests} to HTTP APIs.
+ *
+ * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
+ * described in ["Node.js Axios behind corporate proxies"](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d)
+ * to automatically detect proxy server configuration based
+ * on your [environment variables](https://www.npmjs.com/package/proxy-from-env#environment-variables).
+ * You can override this configuration if needed.
  *
- * If you need to connect via a proxy, check out ["Using Axios behind corporate proxies"](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d).
+ * ## Configuring the ability to call an API
  *
- * ## Using the default Axios HTTP client
+ * The easiest way to configure the ability to `CallAnApi` is to provide the `baseURL` of your HTTP API,
+ * and rely on Serenity/JS to offer other sensible defaults:
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -19,30 +37,128 @@ import axios from 'axios';
  *     CallAnApi.at('https://api.example.org/')
  *   )
  *   .attemptsTo(
+ *     Send.a(GetRequest.to('/v1/users/2')),            // GET https://api.example.org/v1/users/2
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ### Resolving relative URLs
+ *
+ * Serenity/JS resolves request URLs using Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base).
+ * This means that the request URL is determined using the resource path resolved in the context of base URL, i.e. `new URL(resourcePath, [baseURL])`.
+ *
+ * Consider the following example:
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.at(baseURL)
+ *   )
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to(resourcePath)),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * In the above example:
+ * - when `resourcePath` is defined as a full URL, it overrides the base URL
+ * - when `resourcePath` starts with a forward slash `/`, it replaces any path defined in the base URL
+ * - when `resourcePath` is not a full URL and doesn't start with a forward slash, it gets appended to the base URL
+ *
+ * | baseURL                       | resourcePath               | result                               |
+ * | ----------------------------- | -------------------------- | ------------------------------------ |
+ * | `https://api.example.org/`    | `/v1/users/2`              | `https://api.example.org/v1/users/2` |
+ * | `https://example.org/api/v1/` | `users/2`                  | `https://example.org/api/v1/users/2` |
+ * | `https://example.org/api/v1/` | `/secure/oauth`            | `https://example.org/secure/oauth`   |
+ * | `https://v1.example.org/api/` | `https://v2.example.org/`  | `https://v2.example.org/`            |
+ *
+ * ### Using Axios configuration object
+ *
+ * When you need more control over how your Axios instance is configured, provide
+ * an [Axios configuration object](https://axios-http.com/docs/req_config). For example:
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.using({
+ *       baseURL: 'https://api.example.org/',
+ *       timeout: 30_000,
+ *       // ... other configuration options
+ *     })
+ *   )
+ *   .attemptsTo(
  *     Send.a(GetRequest.to('/users/2')),
  *     Ensure.that(LastResponse.status(), equals(200)),
  *   )
  * ```
  *
- * ## Using Axios client with custom configuration
+ * ### Working with proxy servers
+ *
+ * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) to automatically
+ * detect proxy server configuration based on your [environment variables](https://www.npmjs.com/package/proxy-from-env#environment-variables).
+ *
+ * This default behaviour can be overridden by providing explicit proxy configuration:
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.using({
+ *       baseURL: 'https://api.example.org/',
+ *       proxy: {
+ *         protocol: 'http',
+ *         host: 'proxy.example.org',
+ *         port: 9000,
+ *         auth: {                          // `auth` is optional
+ *           username: 'proxy-username',
+ *           password: 'proxy-password',
+ *         }
+ *       }
+ *       // ... other configuration options
+ *     })
+ *   )
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/users/2')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * Please note that Serenity/JS uses [proxy-agents](https://github.com/TooTallNate/proxy-agents)
+ * and the approach described in ["Node.js Axios behind corporate proxies"](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d)
+ * to work around [limited proxy support capabilities](https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+proxy) in Axios itself.
+ *
+ * ### Using Axios instance with proxy support
+ *
+ * To have full control over the Axios instance used by the ability to `CallAnApi`, you can create it yourself
+ * and inject it into the ability.
+ * This approach allows you to still benefit from automated proxy detection in configuration, while taking advantage
+ * of the many [Axios plugins](https://www.npmjs.com/search?q=axios).
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
  * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
  * import { Ensure, equals } from '@serenity-js/assertions'
  *
- * import * as axios from 'axios'
+ * import axios from 'axios'
+ * import axiosRetry from 'axios-retry'
  *
- * const axiosInstance = axios.create({
- *   timeout: 5 * 1000,
- *   headers: {
- *     'X-Custom-Api-Key': 'secret-key',
- *   },
- * });
+ * const instance = axios.create({ baseURL 'https://api.example.org/' })
+ * axiosRetry(axios, { retries: 3 })
  *
  * await actorCalled('Apisitt')
  *   .whoCan(
- *     CallAnApi.using(axiosInstance),
+ *     CallAnApi.using(instance)
  *   )
  *   .attemptsTo(
  *     Send.a(GetRequest.to('/users/2')),
@@ -50,54 +166,228 @@ import axios from 'axios';
  *   )
  * ```
  *
+ * ### Using raw Axios instance
+ *
+ * If you don't want Serenity/JS to enhance your Axios instance with proxy support, instantiate the ability to
+ * `CallAnApi` using its constructor directly.
+ * Note, however, that by using this approach you're taking the responsibility for all the aspects of configuring Axios.
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * import axios from 'axios'
+ * import axiosRetry from 'axios-retry'
+ *
+ * const instance = axios.create({ baseURL 'https://api.example.org/' })
+ * axiosRetry(axios, { retries: 3 })
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     new CallAnApi(instance)     // using the constructor ensures your axios instance is not modified in any way.
+ *   )
+ *   .attemptsTo(
+ *     // ...
+ *   )
+ * ```
+ *
+ * ### Serenity/JS defaults
+ *
+ * When using {@apilink CallAnApi.at} or {@apilink CallAnApi.using} with a configuration object, Serenity/JS
+ * merges your [Axios request configuration](https://axios-http.com/docs/req_config) with the following defaults:
+ * - `timeout`: 10 seconds
+ *
+ *
+ * You can override them by specifying the given property in your configuration object, for example:
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.using({
+ *       baseURL: 'https://api.example.org/',
+ *       timeout: 30_000
+ *     })
+ *   )
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/users/2')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Interacting with multiple APIs
+ *
+ * Some test scenarios might require you to interact with multiple HTTP APIs. With Serenity/JS you can do this
+ * using either API-specific actors, or by specifying full URLs when performing the requests.
+ *
+ * The following examples will assume that the test scenarios needs to interact with the following APIs:
+ * - `https://testdata.example.org/api/v1/`
+ * - `https://shop.example.org/api/v1/`
+ *
+ * Let's also assume that the `testdata` API allows the automation to manage the test data used by the `shop` API.
+ *
+ * ### Using API-specific actors
+ *
+ * To create API-specific actors, configure your [test runner](/handbook/test-runners/) with a {@apilink Cast}
+ * that gives your actors appropriate abilities based, for example, on their name:
+ *
+ * ```ts
+ * import { beforeEach } from 'mocha'
+ * import { Actor, Cast, engage } from '@serenity-js/core'
+ * import { CallAnApi } from '@serenity-js/rest'
+ *
+ * export class MyActors implements Cast {
+ *   prepare(actor: Actor): Actor {
+ *     switch(actor.name) {
+ *       case 'Ted':
+ *         return actor.whoCan(CallAnApi.at('https://testdata.example.org/api/v1/'))
+ *       case 'Shelly':
+ *         return actor.whoCan(CallAnApi.at('https://shop.example.org/api/v1/'))
+ *       default:
+ *         return actor;
+ *     }
+ *   }
+ * }
+ *
+ * beforeEach(() => engage(new MyActors()))
+ * ```
+ *
+ * Next, retrieve the appropriate actor in your test scenario using {@apilink actorCalled}, for example:
+ *
+ * ```ts
+ * import { describe, it, beforeEach } from 'mocha'
+ * import { actorCalled, engage } from '@serenity-js/core
+ * import { Send, GetRequest, PostRequest, LastResponse } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * describe('Multi-actor API testing', () => {
+ *   beforeEach(() => engage(new MyActors()))
+ *
+ *   it('allows each actor to interact with their API', async () => {
+ *
+ *     await actorCalled('Ted').attemptsTo(
+ *       Send.a(PostRequest.to('products').with({ name: 'Apples', price: '£2.50' })),
+ *       Ensure.that(LastResponse.status(), equals(201)),
+ *     )
+ *
+ *     await actorCalled('Shelly').attemptsTo(
+ *       Send.a(GetRequest.to('?product=Apples')),
+ *       Ensure.that(LastResponse.status(), equals(200)),
+ *       Ensure.that(LastResponse.body(), equals([
+ *         { name: 'Apples', price: '£2.50' }
+ *       ])),
+ *     )
+ *   })
+ * })
+ * ```
+ *
+ * ### Using full URLs
+ *
+ * If you prefer to have a single actor interacting with multiple APIs, you can specify the full URL for every request:
+ *
+ * ```ts
+ * import { describe, it, beforeEach } from 'mocha'
+ * import { actorCalled, Cast, engage } from '@serenity-js/core
+ * import { CallAnApi, Send, GetRequest, PostRequest, LastResponse } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * describe('Multi-actor API testing', () => {
+ *   beforeEach(() => engage(
+ *     Cast.where(actor => actor.whoCan(CallAnApi.using({})))
+ *   ))
+ *
+ *   it('allows each actor to interact with their API', async () => {
+ *
+ *     await actorCalled('Alice').attemptsTo(
+ *       Send.a(PostRequest.to('https://testdata.example.org/api/v1/products')
+ *         .with({ name: 'Apples', price: '£2.50' })),
+ *       Ensure.that(LastResponse.status(), equals(201)),
+ *
+ *       Send.a(GetRequest.to('https://shop.example.org/api/v1/?product=Apples')),
+ *       Ensure.that(LastResponse.status(), equals(200)),
+ *       Ensure.that(LastResponse.body(), equals([
+ *         { name: 'Apples', price: '£2.50' }
+ *       ])),
+ *     )
+ *   })
+ * })
+ * ```
+ *
  * ## Learn more
- * - https://github.com/axios/axios
- * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
+ * - [Axios: Configuring requests](https://axios-http.com/docs/req_config)
+ * - [MDN: HTTP methods documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
  *
  * @group Abilities
  */
 export class CallAnApi extends Ability {
 
-    /** @private */
     private lastResponse: AxiosResponse;
 
+    private static readonly defaults: CreateAxiosDefaults<any> = {
+        timeout: Duration.ofSeconds(10).inMilliseconds(),
+    };
+
     /**
-     * Produces an {@apilink Ability|ability} to call a REST api at a specified baseUrl
+     * Produces an {@apilink Ability|ability} to call a REST API at a specified `baseURL`;
      *
-     * Default timeout is set to 2s.
-     *
-     * Default request headers:
-     * - `Accept`: `application/json,application/xml`
+     * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
      *
      * @param baseURL
      */
-    static at(baseURL: string): CallAnApi {
-        return new CallAnApi(axios.create({
-            baseURL,
-            timeout: 2000,
-            headers: { Accept: 'application/json,application/xml' },
-        }));
+    static at(baseURL: URL | string): CallAnApi {
+        return CallAnApi.using({
+            baseURL: baseURL instanceof URL
+                ? baseURL.toString()
+                : baseURL
+        });
     }
 
     /**
-     * Produces an {@apilink Ability|ability} to call a REST API using a given axios instance.
+     * Produces an {@apilink Ability|ability} to call an HTTP API using the given Axios instance,
+     * or an Axios request configuration object.
      *
-     * Useful when you need to customise Axios to
-     * [make it aware of proxies](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d),
-     * for example.
+     * When you provide an [Axios configuration object](https://axios-http.com/docs/req_config),
+     * it gets shallow-merged with the following defaults:
+     * - request timeout of 10 seconds
+     * - automatic proxy support based on
+     *   your [environment variables](https://www.npmjs.com/package/proxy-from-env#environment-variables)
      *
-     * #### Learn more
-     * - [AxiosInstance](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L235-L238)
+     * When you provide an Axios instance, it's enhanced with proxy support and no other modifications are made.
      *
-     * @param axiosInstance
+     * If you don't want Serenity/JS to augment or modify your Axios instance in any way,
+     * please use the {@apilink CallAnApi.constructor} directly.
+     *
+     * @param axiosInstanceOrConfig
      */
-    static using(axiosInstance: AxiosInstance): CallAnApi {
-        return new CallAnApi(axiosInstance);
+    static using(axiosInstanceOrConfig: AxiosInstance | AxiosRequestConfigDefaults): CallAnApi {
+
+        const axiosInstanceGiven = isAxiosInstance(axiosInstanceOrConfig);
+
+        const axiosInstance = axiosInstanceGiven
+            ? axiosInstanceOrConfig
+            : axios.create({
+                ...CallAnApi.defaults,
+                ...omit(axiosInstanceOrConfig, 'proxy'),
+            });
+
+        const proxyConfig: AxiosRequestConfigProxyDefaults | false | undefined = axiosInstanceGiven
+            ? axiosInstanceOrConfig.defaults.proxy
+            : axiosInstanceOrConfig.proxy;
+
+        const proxyOverrides = axiosProxyOverridesFor({
+            ...axiosInstance.defaults,
+            proxy: proxyConfig || undefined,
+        });
+
+        return new CallAnApi(withOverrides(axiosInstance, proxyOverrides));
     }
 
     /**
      * #### Learn more
-     * - [AxiosInstance](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L235-L238)
+     * - [AxiosInstance](https://axios-http.com/docs/instance)
      *
      * @param axiosInstance
      *  A pre-configured instance of the Axios HTTP client
@@ -112,7 +402,7 @@ export class CallAnApi extends Ability {
      * has been instantiated and given to the {@apilink Actor}.
      *
      * #### Learn more
-     * - [AxiosRequestConfig](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L75-L113)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
      *
      * @param fn
      */
@@ -125,8 +415,8 @@ export class CallAnApi extends Ability {
      * Response will be cached and available via {@apilink mapLastResponse}
      *
      * #### Learn more
-     * - [AxiosRequestConfig](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L75-L113)
-     * - [AxiosResponse](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L133-L140)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     * - [AxiosResponse](https://axios-http.com/docs/res_schema)
      *
      * @param config
      *  Axios request configuration, which can be used to override the defaults
@@ -144,7 +434,7 @@ export class CallAnApi extends Ability {
 
             return this.lastResponse;
         }
-        catch(error) {
+        catch (error) {
             const description = `${ config.method.toUpperCase() } ${ url || config.url }`;
 
             switch (true) {
@@ -154,7 +444,7 @@ export class CallAnApi extends Ability {
                     throw new TestCompromisedError(`A network error has occurred: ${ description }`, error);
                 case error instanceof TypeError:
                     throw new ConfigurationError(`Looks like there was an issue with Axios configuration`, error);
-                case ! (error as AxiosError).response:
+                case !(error as AxiosError).response:
                     throw new TestCompromisedError(`The API call has failed: ${ description }`, error);
                 default:
                     this.lastResponse = error.response;
@@ -168,9 +458,8 @@ export class CallAnApi extends Ability {
      * Resolves the final URL, based on the {@apilink AxiosRequestConfig} provided
      * and any defaults that the {@apilink AxiosInstance} has been configured with.
      *
-     * #### Learn more
-     * - [AxiosRequestConfig](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L75-L113)
-     * - [AxiosInstance](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L235-L238)
+     * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
+     * to ensure URLs are correctly resolved.
      *
      * @param config
      */
@@ -187,7 +476,7 @@ export class CallAnApi extends Ability {
      * Useful when you need to extract a portion of the {@apilink AxiosResponse} object.
      *
      * #### Learn more
-     * - [AxiosResponse](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L133-L140)
+     * - [AxiosResponse](https://axios-http.com/docs/res_schema)
      *
      * @param mappingFunction
      */
@@ -199,3 +488,21 @@ export class CallAnApi extends Ability {
         return mappingFunction(this.lastResponse);
     }
 }
+
+function isAxiosInstance(axiosInstanceOrConfig: any): axiosInstanceOrConfig is AxiosInstance {
+    return axiosInstanceOrConfig
+        && (axiosInstanceOrConfig instanceof Axios || axiosInstanceOrConfig.defaults);
+}
+
+function withOverrides<Data = any>(axiosInstance: AxiosInstance, overrides: AxiosRequestConfig<Data>): AxiosInstance {
+    for (const [key, override] of Object.entries(overrides)) {
+        axiosInstance.defaults[key] = override;
+    }
+
+    return axiosInstance;
+}
+
+function omit<T extends object, K extends keyof T>(record: T, key: K): Omit<T, K> {
+    const { [key]: omitted_, ...rest } = record;
+    return rest;
+}

package/src/screenplay/abilities/index.ts

@@ -1 +1,2 @@
+export * from './AxiosRequestConfigDefaults';
 export * from './CallAnApi';