@serenity-js/rest 3.41.2 → 3.42.0

package/esm/screenplay/interactions/ChangeApiConfig.d.ts

@@ -0,0 +1,135 @@
+import type { Answerable } from '@serenity-js/core';
+import { Interaction } from '@serenity-js/core';
+/**
+ * Changes configuration of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+ * that the [actor](https://serenity-js.org/api/core/class/Actor/) executing this [interaction](https://serenity-js.org/api/core/class/Interaction/) has been configured with.
+ *
+ * ## Changing API URL for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { By Navigate, PageElement, Text } from '@serenity-js/web';
+ * import { axiosCreate, CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ * import * as axios from 'axios';
+ *
+ * // Let's imagine that the website under test displays
+ * // a dynamically generated API URL that we would like to use
+ * const ApiDetailsWidget = {
+ *   url: () => PageElement.located(By.id('api-url')).describedAs('API URL'),
+ * }
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     BrowseTheWeb.using(protractor.browser),
+ *
+ *     // Note: no default base URL is given when the axios instance is created
+ *     CallAnApi.using(axiosCreate()),
+ *   )
+ *   .attemptsTo(
+ *     Navigate.to('/profile'),
+ *
+ *     // We change the API URL based on the text displayed in the widget
+ *     // (although we could change it to some arbitrary string too).
+ *     ChangeApiConfig.setUrlTo(Text.of(ApiDetailsWidget.url())),
+ *
+ *     // Any subsequent request will be sent to the newly set URL
+ *     Send.a(GetRequest.to('/projects')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Changing API port for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { LocalServer, ManageALocalServer, StartLocalServer } from '@serenity-js/local-server'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     ManageALocalServer.runningAHttpListener(someServer),
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     StartALocalServer.onRandomPort(),
+ *     ChangeApiConfig.setPortTo(LocalServer.port()),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Setting a header for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled, Question } from '@serenity-js/core'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * // A sample Question reading a Node process environment variable
+ * const EnvVar = (var_name: string) =>
+ *     Question.about(`${ name } environment variable`, actor => process.env[var_name]);
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     ChangeApiConfig.setHeader('Authorization', EnvVar('TOKEN')),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Handling sensitive information
+ *
+ * By design, any data handled by an actor appears in Serenity/JS reports.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
+ *
+ * ```ts
+ * import { actorCalled, Masked } from '@serenity-js/core'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     ChangeApiConfig.setHeader('Authorization', Masked.valueOf('secret token')),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * @group Activities
+ */
+export declare class ChangeApiConfig {
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     *
+     * @param newApiUrl
+     */
+    static setUrlTo(newApiUrl: Answerable<string>): Interaction;
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the port configured in the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     *
+     * @param newApiPort
+     */
+    static setPortTo(newApiPort: Answerable<number>): Interaction;
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the configuration of the [`AxiosInstance`](https://axios-http.com/docs/instance)
+     * used by their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * and set an HTTP request header for any subsequent [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     * issued via [`Send`](https://serenity-js.org/api/rest/class/Send/).
+     *
+     * @param name
+     * @param value
+     */
+    static setHeader(name: Answerable<string>, value: Answerable<string>): Interaction;
+}
+//# sourceMappingURL=ChangeApiConfig.d.ts.map

package/esm/screenplay/interactions/ChangeApiConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeApiConfig.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/ChangeApiConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAsD,MAAM,mBAAmB,CAAC;AACxG,OAAO,EAAK,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,qBAAa,eAAe;IAExB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAI3D;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAI7D;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;CAGrF"}

package/esm/screenplay/interactions/ChangeApiConfig.js

@@ -0,0 +1,212 @@
+import { URL } from 'node:url';
+import { d, Interaction, LogicError } from '@serenity-js/core';
+import { CallAnApi } from '../abilities/index.js';
+/**
+ * Changes configuration of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+ * that the [actor](https://serenity-js.org/api/core/class/Actor/) executing this [interaction](https://serenity-js.org/api/core/class/Interaction/) has been configured with.
+ *
+ * ## Changing API URL for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { By Navigate, PageElement, Text } from '@serenity-js/web';
+ * import { axiosCreate, CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ * import * as axios from 'axios';
+ *
+ * // Let's imagine that the website under test displays
+ * // a dynamically generated API URL that we would like to use
+ * const ApiDetailsWidget = {
+ *   url: () => PageElement.located(By.id('api-url')).describedAs('API URL'),
+ * }
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     BrowseTheWeb.using(protractor.browser),
+ *
+ *     // Note: no default base URL is given when the axios instance is created
+ *     CallAnApi.using(axiosCreate()),
+ *   )
+ *   .attemptsTo(
+ *     Navigate.to('/profile'),
+ *
+ *     // We change the API URL based on the text displayed in the widget
+ *     // (although we could change it to some arbitrary string too).
+ *     ChangeApiConfig.setUrlTo(Text.of(ApiDetailsWidget.url())),
+ *
+ *     // Any subsequent request will be sent to the newly set URL
+ *     Send.a(GetRequest.to('/projects')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Changing API port for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { LocalServer, ManageALocalServer, StartLocalServer } from '@serenity-js/local-server'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     ManageALocalServer.runningAHttpListener(someServer),
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     StartALocalServer.onRandomPort(),
+ *     ChangeApiConfig.setPortTo(LocalServer.port()),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Setting a header for all subsequent requests
+ *
+ * ```ts
+ * import { actorCalled, Question } from '@serenity-js/core'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * // A sample Question reading a Node process environment variable
+ * const EnvVar = (var_name: string) =>
+ *     Question.about(`${ name } environment variable`, actor => process.env[var_name]);
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     ChangeApiConfig.setHeader('Authorization', EnvVar('TOKEN')),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * ## Handling sensitive information
+ *
+ * By design, any data handled by an actor appears in Serenity/JS reports.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
+ *
+ * ```ts
+ * import { actorCalled, Masked } from '@serenity-js/core'
+ * import { CallAnApi, ChangeApiConfig, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(
+ *     CallAnApi.at('http://localhost'),
+ *   )
+ *   .attemptsTo(
+ *     ChangeApiConfig.setHeader('Authorization', Masked.valueOf('secret token')),
+ *     Send.a(GetRequest.to('/api')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * @group Activities
+ */
+export class ChangeApiConfig {
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     *
+     * @param newApiUrl
+     */
+    static setUrlTo(newApiUrl) {
+        return new ChangeApiConfigSetUrl(newApiUrl);
+    }
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the port configured in the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     *
+     * @param newApiPort
+     */
+    static setPortTo(newApiPort) {
+        return new ChangeApiConfigSetPort(newApiPort);
+    }
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the configuration of the [`AxiosInstance`](https://axios-http.com/docs/instance)
+     * used by their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * and set an HTTP request header for any subsequent [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     * issued via [`Send`](https://serenity-js.org/api/rest/class/Send/).
+     *
+     * @param name
+     * @param value
+     */
+    static setHeader(name, value) {
+        return new ChangeApiConfigSetHeader(name, value);
+    }
+}
+/**
+ * @package
+ */
+class ChangeApiConfigSetUrl extends Interaction {
+    newApiUrl;
+    constructor(newApiUrl) {
+        super(d `#actor changes API url configuration to ${newApiUrl}`);
+        this.newApiUrl = newApiUrl;
+    }
+    performAs(actor) {
+        return actor.answer(this.newApiUrl)
+            .then(newApiUrl => CallAnApi.as(actor).modifyConfig(config => config.baseURL = newApiUrl));
+    }
+}
+/**
+ * @package
+ */
+class ChangeApiConfigSetPort extends Interaction {
+    newPort;
+    constructor(newPort) {
+        super(`#actor changes API port configuration to ${newPort}`);
+        this.newPort = newPort;
+    }
+    performAs(actor) {
+        return actor.answer(this.newPort)
+            .then(newPort => CallAnApi.as(actor).modifyConfig(config => {
+            if (!config.baseURL) {
+                throw new LogicError(`Can't change the port of a baseURL that has not been set`);
+            }
+            try {
+                const newUrl = new URL(config.baseURL);
+                newUrl.port = `${newPort}`;
+                config.baseURL = newUrl.toString();
+            }
+            catch (error) {
+                throw new LogicError(`Could not change the API port`, error);
+            }
+        }));
+    }
+}
+/**
+ * @package
+ *
+ * @see https://github.com/axios/axios#custom-instance-defaults
+ */
+class ChangeApiConfigSetHeader extends Interaction {
+    name;
+    value;
+    constructor(name, value) {
+        super(`#actor changes API URL and sets header "${name}" to "${value}"`);
+        this.name = name;
+        this.value = value;
+    }
+    performAs(actor) {
+        return Promise.all([
+            actor.answer(this.name),
+            actor.answer(this.value),
+        ]).
+            then(([name, value]) => {
+            if (!name) {
+                throw new LogicError(`Looks like the name of the header is missing, "${name}" given`);
+            }
+            // A header with an empty value might still be valid so we don't validate the value
+            // see: https://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.1
+            return CallAnApi.as(actor).modifyConfig(config => {
+                config.headers.common[name] = value;
+            });
+        });
+    }
+}
+//# sourceMappingURL=ChangeApiConfig.js.map

package/esm/screenplay/interactions/ChangeApiConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeApiConfig.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/ChangeApiConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,MAAM,OAAO,eAAe;IAExB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,SAA6B;QACzC,OAAO,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,UAA8B;QAC3C,OAAO,IAAI,sBAAsB,CAAC,UAAU,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CAAC,IAAwB,EAAE,KAAyB;QAChE,OAAO,IAAI,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,qBAAsB,SAAQ,WAAW;IACd;IAA7B,YAA6B,SAA6B;QACtD,KAAK,CAAC,CAAC,CAAA,2CAA4C,SAAU,EAAE,CAAC,CAAC;QADxC,cAAS,GAAT,SAAS,CAAoB;IAE1D,CAAC;IAED,SAAS,CAAC,KAA2D;QACjE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aAC9B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACnG,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,sBAAwB,SAAQ,WAAW;IAChB;IAA7B,YAA6B,OAAoC;QAC7D,KAAK,CAAC,4CAA6C,OAAQ,EAAE,CAAC,CAAC;QADtC,YAAO,GAAP,OAAO,CAA6B;IAEjE,CAAC;IAED,SAAS,CAAC,KAA2D;QACjE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;aAC5B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;YACvD,IAAI,CAAE,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,IAAI,UAAU,CAAC,0DAA0D,CAAC,CAAA;YACpF,CAAC;YAED,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACvC,MAAM,CAAC,IAAI,GAAG,GAAI,OAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACvC,CAAC;YACD,OAAO,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,UAAU,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;YACjE,CAAC;QACL,CAAC,CAAC,CAAC,CAAC;IACZ,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,wBAAyB,SAAQ,WAAW;IAGzB;IACA;IAFrB,YACqB,IAAwB,EACxB,KAAyB;QAE1C,KAAK,CAAC,2CAA4C,IAAK,SAAU,KAAM,GAAG,CAAC,CAAC;QAH3D,SAAI,GAAJ,IAAI,CAAoB;QACxB,UAAK,GAAL,KAAK,CAAoB;IAG9C,CAAC;IAED,SAAS,CAAC,KAA2D;QACjE,OAAO,OAAO,CAAC,GAAG,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SAC3B,CAAC;YACF,IAAI,CAAC,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,EAAE,EAAE;YACrB,IAAI,CAAE,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,UAAU,CAAC,kDAAmD,IAAK,SAAS,CAAC,CAAC;YAC5F,CAAC;YAED,mFAAmF;YACnF,qEAAqE;YAErE,OAAO,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;gBAC7C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACxC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/esm/screenplay/interactions/Send.d.ts

@@ -0,0 +1,48 @@
+import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } from '@serenity-js/core';
+import { Interaction } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+/**
+ * Sends a [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/) to a specified URL.
+ *
+ * The response to the request is made available via [`LastResponse`](https://serenity-js.org/api/rest/class/LastResponse/).
+ *
+ * ## Send a GET request
+ *
+ * ```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('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/books/0-688-00230-7')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * @group Activities
+ */
+export declare class Send extends Interaction {
+    private readonly request;
+    /**
+     * Instantiates a new [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/).
+     *
+     * #### Learn more
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param request
+     */
+    static a(request: Answerable<AxiosRequestConfig>): Interaction;
+    /**
+     * @param request
+     */
+    protected constructor(request: Answerable<AxiosRequestConfig>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & CollectsArtifacts & AnswersQuestions): Promise<void>;
+    private responseToArtifact;
+    private requestToArtifactName;
+}
+//# sourceMappingURL=Send.d.ts.map

package/esm/screenplay/interactions/Send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Send.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Send.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,KAAK,EAAE,kBAAkB,EAAgE,MAAM,OAAO,CAAC;AAK9G;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,IAAK,SAAQ,WAAW;IAiBX,OAAO,CAAC,QAAQ,CAAC,OAAO;IAf9C;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,kBAAkB,CAAC,GAAG,WAAW;IAI9D;;OAEG;IACH,SAAS,aAA8B,OAAO,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAI9E;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBrF,OAAO,CAAC,kBAAkB;IA0B1B,OAAO,CAAC,qBAAqB;CAGhC"}

package/esm/screenplay/interactions/Send.js

@@ -0,0 +1,83 @@
+import { Interaction } from '@serenity-js/core';
+import { HTTPRequestResponse, Name } from '@serenity-js/core/model';
+import { AxiosHeaders } from 'axios';
+import { CallAnApi } from '../abilities/index.js';
+/**
+ * Sends a [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/) to a specified URL.
+ *
+ * The response to the request is made available via [`LastResponse`](https://serenity-js.org/api/rest/class/LastResponse/).
+ *
+ * ## Send a GET request
+ *
+ * ```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('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/books/0-688-00230-7')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *   )
+ * ```
+ *
+ * @group Activities
+ */
+export class Send extends Interaction {
+    request;
+    /**
+     * Instantiates a new [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/).
+     *
+     * #### Learn more
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param request
+     */
+    static a(request) {
+        return new Send(request);
+    }
+    /**
+     * @param request
+     */
+    constructor(request) {
+        super(`#actor sends ${request.toString()}`);
+        this.request = request;
+    }
+    /**
+     * @inheritDoc
+     */
+    performAs(actor) {
+        const callAnApi = CallAnApi.as(actor);
+        return actor.answer(this.request)
+            .then(config => callAnApi.request(config).then((response) => {
+            const resolvedUrl = callAnApi.resolveUrl(config);
+            actor.collect(this.responseToArtifact(resolvedUrl, response), this.requestToArtifactName(response.config.method, resolvedUrl));
+        }));
+    }
+    responseToArtifact(targetUrl, response) {
+        const request = response.config;
+        const axiosRequestHeaders = request.headers;
+        const requestHeaders = AxiosHeaders.from(axiosRequestHeaders).toJSON(true);
+        const axiosResponseHeaders = response.headers;
+        const responseHeaders = AxiosHeaders.from(axiosResponseHeaders).toJSON(false);
+        const requestAndResponse = {
+            request: {
+                method: request.method,
+                url: targetUrl,
+                headers: requestHeaders,
+                data: request.data,
+            },
+            response: {
+                status: response.status,
+                headers: responseHeaders,
+                data: response.data,
+            },
+        };
+        return HTTPRequestResponse.fromJSON(requestAndResponse);
+    }
+    requestToArtifactName(method, url) {
+        return new Name(`${method.toUpperCase()} ${url}`);
+    }
+}
+//# sourceMappingURL=Send.js.map

package/esm/screenplay/interactions/Send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Send.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Send.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAEpE,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAiBM;IAfvC;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,CAAC,OAAuC;QAC5C,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,YAAuC,OAAuC;QAC1E,KAAK,CAAC,gBAAiB,OAAO,CAAC,QAAQ,EAAG,EAAE,CAAC,CAAC;QADX,YAAO,GAAP,OAAO,CAAgC;IAE9E,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,KAA2D;QACjE,MAAM,SAAS,GAAG,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAEtC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;aAC5B,IAAI,CAAC,MAAM,CAAC,EAAE,CACX,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YACvD,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAEjD,KAAK,CAAC,OAAO,CACT,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,EAC9C,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAClE,CAAC;QACN,CAAC,CAAC,CACL,CAAC;IACV,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,QAAuB;QACjE,MAAM,OAAO,GAAuB,QAAQ,CAAC,MAAM,CAAC;QAEpD,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;QAC5C,MAAM,cAAc,GAA8C,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,IAAI,CAA8C,CAAC;QAEnK,MAAM,oBAAoB,GAAmD,QAAQ,CAAC,OAAO,CAAC;QAC9F,MAAM,eAAe,GAAG,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,KAAK,CAA4B,CAAC;QAEzG,MAAM,kBAAkB,GAAuB;YAC3C,OAAO,EAAE;gBACL,MAAM,EAAM,OAAO,CAAC,MAAM;gBAC1B,GAAG,EAAS,SAAS;gBACrB,OAAO,EAAK,cAAc;gBAC1B,IAAI,EAAQ,OAAO,CAAC,IAAI;aAC3B;YACD,QAAQ,EAAE;gBACN,MAAM,EAAM,QAAQ,CAAC,MAAM;gBAC3B,OAAO,EAAK,eAAkF;gBAC9F,IAAI,EAAQ,QAAQ,CAAC,IAAI;aAC5B;SACJ,CAAC;QAEF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC5D,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,GAAW;QACrD,OAAO,IAAI,IAAI,CAAC,GAAI,MAAM,CAAC,WAAW,EAAG,IAAK,GAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;CACJ"}

package/esm/screenplay/interactions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ChangeApiConfig.js';
+export * from './Send.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/screenplay/interactions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC"}

package/esm/screenplay/interactions/index.js

@@ -0,0 +1,3 @@
+export * from './ChangeApiConfig.js';
+export * from './Send.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/interactions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC"}

package/esm/screenplay/models/DeleteRequest.d.ts

@@ -0,0 +1,66 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The DELETE method requests that the origin server remove the
+ * association between the target resource and its current
+ * functionality.
+ *
+ * ## Create and then remove a resource
+ *
+ * ```ts
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { CallAnApi, DeleteRequest, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals, startsWith } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Apisitt')
+ *    .whoCan(CallAnApi.at('https://api.example.org/'))
+ *    .attemptsTo(
+ *      // create a new test user account
+ *      Send.a(PostRequest.to('/users').with({
+ *          login: 'tester',
+ *          password: 'P@ssword1',
+ *      }),
+ *      Ensure.that(LastResponse.status(), equals(201)),
+ *      Ensure.that(LastResponse.header('Location'), startsWith('/users')),
+ *
+ *      // delete the test user account
+ *      Send.a(DeleteRequest.to(LastResponse.header('Location'))),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.5
+ *
+ * @group Models
+ */
+export declare class DeleteRequest extends HTTPRequest {
+    /**
+     * Configures the object with a destination URI.
+     *
+     * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
+     * it gets concatenated with the URL provided to the Axios instance
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     */
+    static to(resourceUri: Answerable<string>): DeleteRequest;
+    /**
+     * Overrides the default Axios request configuration provided
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config: Answerable<WithAnswerableProperties<AxiosRequestConfig>>): DeleteRequest;
+}
+//# sourceMappingURL=DeleteRequest.d.ts.map

package/esm/screenplay/models/DeleteRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeleteRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/DeleteRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE1C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,aAAa;IAIzD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,aAAa;CAGzF"}

package/esm/screenplay/models/DeleteRequest.js

@@ -0,0 +1,69 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The DELETE method requests that the origin server remove the
+ * association between the target resource and its current
+ * functionality.
+ *
+ * ## Create and then remove a resource
+ *
+ * ```ts
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { CallAnApi, DeleteRequest, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals, startsWith } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Apisitt')
+ *    .whoCan(CallAnApi.at('https://api.example.org/'))
+ *    .attemptsTo(
+ *      // create a new test user account
+ *      Send.a(PostRequest.to('/users').with({
+ *          login: 'tester',
+ *          password: 'P@ssword1',
+ *      }),
+ *      Ensure.that(LastResponse.status(), equals(201)),
+ *      Ensure.that(LastResponse.header('Location'), startsWith('/users')),
+ *
+ *      // delete the test user account
+ *      Send.a(DeleteRequest.to(LastResponse.header('Location'))),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.5
+ *
+ * @group Models
+ */
+export class DeleteRequest extends HTTPRequest {
+    /**
+     * Configures the object with a destination URI.
+     *
+     * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
+     * it gets concatenated with the URL provided to the Axios instance
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     */
+    static to(resourceUri) {
+        return new DeleteRequest(resourceUri);
+    }
+    /**
+     * Overrides the default Axios request configuration provided
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config) {
+        return new DeleteRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=DeleteRequest.js.map

package/esm/screenplay/models/DeleteRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeleteRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/DeleteRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE1C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACvF,CAAC;CACJ"}