@serenity-js/rest 3.0.0-rc.9 → 3.0.1

package/lib/model/GetRequest.d.ts

@@ -1,70 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  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.
- *
- * @example <caption>Verify response to a GET request</caption>
- *  import { Actor } 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;
- *  }
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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',
- *      })),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.1
- *
- * @extends {HTTPRequest}
- */
-export declare class GetRequest extends HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {GetRequest}
-     */
-    static to(resourceUri: Answerable<string>): GetRequest;
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {GetRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): GetRequest;
-}

package/lib/model/GetRequest.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  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.
- *
- * @example <caption>Verify response to a GET request</caption>
- *  import { Actor } 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;
- *  }
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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',
- *      })),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.1
- *
- * @extends {HTTPRequest}
- */
-class GetRequest extends HTTPRequest_1.HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {GetRequest}
-     */
-    static to(resourceUri) {
-        return new GetRequest(resourceUri);
-    }
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {GetRequest}
-     */
-    using(config) {
-        return new GetRequest(this.resourceUri, undefined, config);
-    }
-}
-exports.GetRequest = GetRequest;
-//# sourceMappingURL=GetRequest.js.map

package/lib/model/GetRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GetRequest.js","sourceRoot":"","sources":["../../src/model/GetRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAa,UAAW,SAAQ,yBAAW;IAEvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACJ;AAjCD,gCAiCC"}

package/lib/model/HTTPRequest.d.ts

@@ -1,56 +0,0 @@
-import { Answerable, AnswersQuestions, Question, UsesAbilities } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-/**
- * @desc
- *  HTTP Request sent by the {@link @serenity-js/core/lib/screenplay/actor~Actor}
- *  using the {@link Send} {@link @serenity-js/core/lib/screenplay~Interaction}
- *
- * @abstract
- * @extends {Question<Promise<AxiosRequestConfig>>}
- */
-export declare abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>> {
-    protected readonly resourceUri?: Answerable<string>;
-    protected readonly data?: Answerable<any>;
-    protected readonly config?: Answerable<AxiosRequestConfig>;
-    private subject;
-    /**
-     * @protected
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} [resourceUri]
-     *  URL to which the request should be sent
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<any>} [data]
-     *  Request body to be sent as part of the Put, Post or Patch request
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} [config]
-     *  Axios request configuration, which can be used to override the defaults
-     *  provided when the {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} is instantiated
-     */
-    protected constructor(resourceUri?: Answerable<string>, data?: Answerable<any>, config?: Answerable<AxiosRequestConfig>);
-    /**
-     * @desc
-     *  Resolves the {@link Question} in the context of a given {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *
-     * @param {AnswersQuestions & UsesAbilities} actor
-     * @returns {Promise<AxiosRequestConfig>}
-     */
-    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<AxiosRequestConfig>;
-    /**
-     * @desc
-     *  Changes the description of this question's subject.
-     *
-     * @param {string} subject
-     * @returns {Question<T>}
-     */
-    describedAs(subject: string): this;
-    toString(): string;
-    /**
-     * Determines the request method based on the name of the request class.
-     * For example: GetRequest => GET, PostRequest => POST, etc.
-     */
-    private httpMethodName;
-    /**
-     * A human-readable description of the request, such as "a GET request", "an OPTIONS request", etc.
-     */
-    private requestDescription;
-}

package/lib/model/HTTPRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HTTPRequest.js","sourceRoot":"","sources":["../../src/model/HTTPRequest.ts"],"names":[],"mappings":";;;AAAA,4CAA0F;AAC1F,iDAAqD;AAGrD;;;;;;;GAOG;AACH,MAAsB,WAAY,SAAQ,eAAqC;IAI3E;;;;;;;;;;;;OAYG;IACH,YACuB,WAAgC,EAChC,IAAsB,EACtB,MAAuC;QAE1D,KAAK,EAAE,CAAC;QAJW,gBAAW,GAAX,WAAW,CAAqB;QAChC,SAAI,GAAJ,IAAI,CAAkB;QACtB,WAAM,GAAN,MAAM,CAAiC;QAG1D,IAAI,CAAC,OAAO,GAAG,GAAI,IAAI,CAAC,kBAAkB,EAAG,OAAQ,IAAA,cAAS,EAAC,GAAI,IAAI,CAAC,WAAY,EAAG,EAAE,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;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,IAAI,CAAC,cAAc,EAAE,EAAE,CACpC,CACJ;YACD,IAAI,CAAC,MAAM,CAAC,EAAE;QACV,8DAA8D;QAC9D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACpC,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACb,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;aAC1B;YACD,OAAO,GAAG,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CACT,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAe;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,cAAc;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACtE,CAAC;IAED;;OAEG;IACK,kBAAkB;QACtB,MACI,MAAM,GAAG,CAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAE,EACpC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEnC,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;AA7FD,kCA6FC"}

package/lib/model/HeadRequest.d.ts

@@ -1,55 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  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.
- *
- * @example <caption>File download test</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, HeadRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.2
- *
- * @extends {HTTPRequest}
- */
-export declare class HeadRequest extends HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {HeadRequest}
-     */
-    static to(resourceUri: Answerable<string>): HeadRequest;
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {HeadRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): HeadRequest;
-}

package/lib/model/HeadRequest.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeadRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  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.
- *
- * @example <caption>File download test</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, HeadRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.2
- *
- * @extends {HTTPRequest}
- */
-class HeadRequest extends HTTPRequest_1.HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {HeadRequest}
-     */
-    static to(resourceUri) {
-        return new HeadRequest(resourceUri);
-    }
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {HeadRequest}
-     */
-    using(config) {
-        return new HeadRequest(this.resourceUri, undefined, config);
-    }
-}
-exports.HeadRequest = HeadRequest;
-//# sourceMappingURL=HeadRequest.js.map

package/lib/model/HeadRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HeadRequest.js","sourceRoot":"","sources":["../../src/model/HeadRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,WAAY,SAAQ,yBAAW;IAExC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;CACJ;AAjCD,kCAiCC"}

package/lib/model/OptionsRequest.d.ts

@@ -1,58 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  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.
- *
- * @example <caption>File download test</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, OptionsRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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')),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.7
- *
- * @extends {HTTPRequest}
- */
-export declare class OptionsRequest extends HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {OptionsRequest}
-     */
-    static to(resourceUri: Answerable<string>): OptionsRequest;
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {OptionsRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): OptionsRequest;
-}

package/lib/model/OptionsRequest.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OptionsRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  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.
- *
- * @example <caption>File download test</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, OptionsRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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')),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.7
- *
- * @extends {HTTPRequest}
- */
-class OptionsRequest extends HTTPRequest_1.HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {OptionsRequest}
-     */
-    static to(resourceUri) {
-        return new OptionsRequest(resourceUri);
-    }
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {OptionsRequest}
-     */
-    using(config) {
-        return new OptionsRequest(this.resourceUri, undefined, config);
-    }
-}
-exports.OptionsRequest = OptionsRequest;
-//# sourceMappingURL=OptionsRequest.js.map

package/lib/model/OptionsRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OptionsRequest.js","sourceRoot":"","sources":["../../src/model/OptionsRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,cAAe,SAAQ,yBAAW;IAE3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;CACJ;AAjCD,wCAiCC"}

package/lib/model/PatchRequest.d.ts

@@ -1,65 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  The PATCH method requests that a set of changes described in the
- *  request entity be applied to the resource identified by the `resourceUri`.
- *
- * @example <caption>Add new resource to a collection</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PatchRequest, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.attemptsTo(
- *      Send.a(PatchRequest.to('/books/0-688-00230-7').with({
- *          lastReadOn: '2016-06-16',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(204)),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
- * @see https://tools.ietf.org/html/rfc5789
- *
- * @extends {HTTPRequest}
- */
-export declare class PatchRequest extends HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {PatchRequest}
-     */
-    static to(resourceUri: Answerable<string>): PatchRequest;
-    /**
-     * @desc
-     *  Configures the object with a request body.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<any>} data
-     *  Data to be sent to the `resourceUri`
-     *
-     * @returns {PatchRequest}
-     */
-    with(data: Answerable<any>): PatchRequest;
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {PatchRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): PatchRequest;
-}

package/lib/model/PatchRequest.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PatchRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  The PATCH method requests that a set of changes described in the
- *  request entity be applied to the resource identified by the `resourceUri`.
- *
- * @example <caption>Add new resource to a collection</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PatchRequest, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.attemptsTo(
- *      Send.a(PatchRequest.to('/books/0-688-00230-7').with({
- *          lastReadOn: '2016-06-16',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(204)),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
- * @see https://tools.ietf.org/html/rfc5789
- *
- * @extends {HTTPRequest}
- */
-class PatchRequest extends HTTPRequest_1.HTTPRequest {
-    /**
-     * @desc
-     *  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 {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} resourceUri
-     *  The URI where the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should send the {@link HTTPRequest}.
-     *
-     * @returns {PatchRequest}
-     */
-    static to(resourceUri) {
-        return new PatchRequest(resourceUri);
-    }
-    /**
-     * @desc
-     *  Configures the object with a request body.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<any>} data
-     *  Data to be sent to the `resourceUri`
-     *
-     * @returns {PatchRequest}
-     */
-    with(data) {
-        return new PatchRequest(this.resourceUri, data, this.config);
-    }
-    /**
-     * @desc
-     *  Overrides the default Axios request configuration provided
-     *  when {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} was instantiated.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<AxiosRequestConfig>} config
-     *  Axios request configuration overrides
-     *
-     * @returns {PatchRequest}
-     */
-    using(config) {
-        return new PatchRequest(this.resourceUri, this.data, config);
-    }
-}
-exports.PatchRequest = PatchRequest;
-//# sourceMappingURL=PatchRequest.js.map

package/lib/model/PatchRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PatchRequest.js","sourceRoot":"","sources":["../../src/model/PatchRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,YAAa,SAAQ,yBAAW;IAEzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;CACJ;AA9CD,oCA8CC"}