@serenity-js/rest 3.41.1 → 3.42.0

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

@@ -0,0 +1,73 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The HTTP GET method requests a representation of the specified resource.
+ * It is the most frequent type of request made by consumers of a typical HTTP API.
+ * For this reason it's important to test every known endpoint that responds to GET requests and ensure that it
+ * behaves correctly.
+ *
+ * Since the GET method is used to _retrieve_ data from a server, it should be implemented
+ * as [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe)
+ * and [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
+ * This means that an identical request can be made once or several times in a row with the same effect while leaving
+ * the server in the same state.
+ *
+ * ## Verify response to 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'
+ *
+ *  interface Book {
+ *      title: string;
+ *      author: string;
+ *  }
+ *
+ *  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)),
+ *      Ensure.that(LastResponse.body<Book>(), equals({
+ *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *          author: 'Robert M. Pirsig',
+ *      })),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.1
+ *
+ * @group Models
+ */
+export declare class GetRequest 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>): GetRequest;
+    /**
+     * 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>>): GetRequest;
+}
+//# sourceMappingURL=GetRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GetRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/GetRequest.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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,UAAW,SAAQ,WAAW;IAEvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU;IAItD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,UAAU;CAGtF"}

package/esm/screenplay/models/GetRequest.js

@@ -0,0 +1,76 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The HTTP GET method requests a representation of the specified resource.
+ * It is the most frequent type of request made by consumers of a typical HTTP API.
+ * For this reason it's important to test every known endpoint that responds to GET requests and ensure that it
+ * behaves correctly.
+ *
+ * Since the GET method is used to _retrieve_ data from a server, it should be implemented
+ * as [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe)
+ * and [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
+ * This means that an identical request can be made once or several times in a row with the same effect while leaving
+ * the server in the same state.
+ *
+ * ## Verify response to 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'
+ *
+ *  interface Book {
+ *      title: string;
+ *      author: string;
+ *  }
+ *
+ *  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)),
+ *      Ensure.that(LastResponse.body<Book>(), equals({
+ *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *          author: 'Robert M. Pirsig',
+ *      })),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.1
+ *
+ * @group Models
+ */
+export class GetRequest 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 GetRequest(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 GetRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=GetRequest.js.map

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

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

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

@@ -0,0 +1,40 @@
+import type { Answerable, AnswersQuestions, UsesAbilities, WithAnswerableProperties } from '@serenity-js/core';
+import { Question } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+/**
+ * HTTP Request sent by the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * using the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/)
+ *
+ * @group Models
+ */
+export declare abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>> {
+    protected readonly resourceUri?: Answerable<string>;
+    protected readonly data?: Answerable<any>;
+    protected readonly config?: Answerable<WithAnswerableProperties<AxiosRequestConfig>>;
+    /**
+     * @param [resourceUri]
+     *  URL to which the request should be sent
+     *
+     * @param [data]
+     *  Request body to be sent as part of the Put, Post or Patch request
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} [config]
+     *  Axios request configuration, which can be used to override the defaults
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) is instantiated
+     */
+    protected constructor(resourceUri?: Answerable<string>, data?: Answerable<any>, config?: Answerable<WithAnswerableProperties<AxiosRequestConfig>>);
+    /**
+     * @inheritDoc
+     */
+    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<AxiosRequestConfig>;
+    /**
+     * Determines the request method based on the name of the request class.
+     * For example: GetRequest => GET, PostRequest => POST, etc.
+     */
+    private static httpMethodName;
+    /**
+     * A human-readable description of the request, such as "a GET request", "an OPTIONS request", etc.
+     */
+    private static requestDescription;
+}
+//# sourceMappingURL=HTTPRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/HTTPRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC/G,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD;;;;;GAKG;AACH,8BAAsB,WAAY,SAAQ,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAcvE,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IACnD,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAdxF;;;;;;;;;;OAUG;IACH,SAAS,aACc,WAAW,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,EAChC,IAAI,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACtB,MAAM,CAAC,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAKxF;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,gBAAgB,GAAG,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0BhF;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAI7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAOpC"}

package/esm/screenplay/models/HTTPRequest.js

@@ -0,0 +1,62 @@
+import { Question } from '@serenity-js/core';
+import { d } from '@serenity-js/core/io';
+/**
+ * HTTP Request sent by the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * using the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/)
+ *
+ * @group Models
+ */
+export class HTTPRequest extends Question {
+    resourceUri;
+    data;
+    config;
+    /**
+     * @param [resourceUri]
+     *  URL to which the request should be sent
+     *
+     * @param [data]
+     *  Request body to be sent as part of the Put, Post or Patch request
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} [config]
+     *  Axios request configuration, which can be used to override the defaults
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) is instantiated
+     */
+    constructor(resourceUri, data, config) {
+        super(`${HTTPRequest.requestDescription(new.target.name)} to ${d `${resourceUri}`}`);
+        this.resourceUri = resourceUri;
+        this.data = data;
+        this.config = config;
+    }
+    /**
+     * @inheritDoc
+     */
+    answeredBy(actor) {
+        return Promise.all([
+            this.resourceUri ? actor.answer(this.resourceUri) : Promise.resolve(void 0),
+            this.config ? actor.answer(this.config) : Promise.resolve({}),
+            this.data ? actor.answer(this.data) : Promise.resolve(void 0),
+        ]).
+            then(([url, config, data]) => Object.assign({}, { url, data }, config, { method: HTTPRequest.httpMethodName(this.constructor.name) })).
+            then(config => Object.keys(config).reduce((acc, key) => {
+            if (config[key] !== null && config[key] !== undefined) {
+                acc[key] = config[key];
+            }
+            return acc;
+        }, {}));
+    }
+    /**
+     * Determines the request method based on the name of the request class.
+     * For example: GetRequest => GET, PostRequest => POST, etc.
+     */
+    static httpMethodName(className) {
+        return className.replace(/Request/, '').toUpperCase();
+    }
+    /**
+     * A human-readable description of the request, such as "a GET request", "an OPTIONS request", etc.
+     */
+    static requestDescription(className) {
+        const vowels = ['A', 'E', 'I', 'O', 'U'], method = HTTPRequest.httpMethodName(className);
+        return `${~vowels.indexOf(method[0]) ? 'an' : 'a'} ${method} request`;
+    }
+}
+//# sourceMappingURL=HTTPRequest.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/HTTPRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGzC;;;;;GAKG;AACH,MAAM,OAAgB,WAAY,SAAQ,QAAqC;IAcpD;IACA;IACA;IAdvB;;;;;;;;;;OAUG;IACH,YACuB,WAAgC,EAChC,IAAsB,EACtB,MAAiE;QAEpF,KAAK,CAAC,GAAI,WAAW,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAE,OAAQ,CAAC,CAAA,GAAI,WAAY,EAAG,EAAE,CAAC,CAAC;QAJvE,gBAAW,GAAX,WAAW,CAAqB;QAChC,SAAI,GAAJ,IAAI,CAAkB;QACtB,WAAM,GAAN,MAAM,CAA2D;IAGxF,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAuC;QAC9C,OAAO,OAAO,CAAC,GAAG,CAAC;YACf,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7E,IAAI,CAAC,MAAM,CAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACzE,IAAI,CAAC,IAAI,CAAQ,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAU,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAChF,CAAC;YACF,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAEzB,MAAM,CAAC,MAAM,CACT,EAAE,EACF,EAAE,GAAG,EAAE,IAAI,EAAE,EACb,MAAM,EACN,EAAE,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAChE,CACJ;YACD,IAAI,CAAC,MAAM,CAAC,EAAE,CAEV,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACpC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAG,CAAC;gBACrD,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,GAAG,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CACT,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,kBAAkB,CAAC,SAAiB;QAC/C,MACI,MAAM,GAAG,CAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAE,EACpC,MAAM,GAAG,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAEnD,OAAO,GAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAI,IAAK,MAAO,UAAU,CAAC;IAC9E,CAAC;CACJ"}

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

@@ -0,0 +1,58 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The HTTP HEAD method requests the headers that are returned if the specified resource
+ * would be requested with an HTTP GET method.
+ * Such a request can be done before deciding to download a large resource to save bandwidth, for example.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, HeadRequest, 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(HeadRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Content-Length'), equals(256)), // assuming we know the size of the document
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.2
+ *
+ * @group Models
+ */
+export declare class HeadRequest 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>): HeadRequest;
+    /**
+     * 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>>): HeadRequest;
+}
+//# sourceMappingURL=HeadRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HeadRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/HeadRequest.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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAExC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAIvD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,WAAW;CAGvF"}

package/esm/screenplay/models/HeadRequest.js

@@ -0,0 +1,61 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The HTTP HEAD method requests the headers that are returned if the specified resource
+ * would be requested with an HTTP GET method.
+ * Such a request can be done before deciding to download a large resource to save bandwidth, for example.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, HeadRequest, 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(HeadRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Content-Length'), equals(256)), // assuming we know the size of the document
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.2
+ *
+ * @group Models
+ */
+export class HeadRequest 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 HeadRequest(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 HeadRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=HeadRequest.js.map

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

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

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

@@ -0,0 +1,61 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The OPTIONS method requests information about the communication
+ * options available for the target resource, at either the origin
+ * server or an intervening intermediary.  This method allows a client
+ * to determine the options and/or requirements associated with a
+ * resource, or the capabilities of a server, without implying a
+ * resource action.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, OptionsRequest, 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(OptionsRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Allow'), equals('OPTIONS, GET, HEAD')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.7
+ *
+ * @group Models
+ */
+export declare class OptionsRequest 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>): OptionsRequest;
+    /**
+     * 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>>): OptionsRequest;
+}
+//# sourceMappingURL=OptionsRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/OptionsRequest.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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,cAAc;IAI1D;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,cAAc;CAG1F"}

package/esm/screenplay/models/OptionsRequest.js

@@ -0,0 +1,64 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The OPTIONS method requests information about the communication
+ * options available for the target resource, at either the origin
+ * server or an intervening intermediary.  This method allows a client
+ * to determine the options and/or requirements associated with a
+ * resource, or the capabilities of a server, without implying a
+ * resource action.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, OptionsRequest, 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(OptionsRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Allow'), equals('OPTIONS, GET, HEAD')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.7
+ *
+ * @group Models
+ */
+export class OptionsRequest 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 OptionsRequest(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 OptionsRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=OptionsRequest.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/OptionsRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACxF,CAAC;CACJ"}

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

@@ -0,0 +1,65 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * The PATCH method requests that a set of changes described in the
+ * request entity be applied to the resource identified by the `resourceUri`.
+ *
+ * ## Add new resource to a collection
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PatchRequest, 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(PatchRequest.to('/books/0-688-00230-7').with({
+ *       lastReadOn: '2016-06-16',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(204)),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
+ * - https://tools.ietf.org/html/rfc5789
+ *
+ * @group Models
+ */
+export declare class PatchRequest 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>): PatchRequest;
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data: Answerable<any>): PatchRequest;
+    /**
+     * 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>>): PatchRequest;
+}
+//# sourceMappingURL=PatchRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PatchRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/PatchRequest.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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAEzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,YAAY;IAIxD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,YAAY;IAIzC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,YAAY;CAGxF"}