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

package/lib/model/PostRequest.d.ts

@@ -1,102 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  The HTTP POST method requests that the origin server accepts
- *  the entity enclosed in the request as a new subordinate of the resource
- *  identified by the `resourceUri`.
- *
- *  This means that the POST should be used when you want to create a child resource under
- *  a collection of resources.
- *
- *  POST request is neither [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe),
- *  nor [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
- *  This means that if you retry a POST request N times,
- *  a correctly implemented HTTP REST API will create N resources with N different URIs.
- *
- * @example <caption>Add new resource to a collection</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PostRequest, 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(PostRequest.to('/books').with({
- *          isbn: '0-688-00230-7',
- *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
- *          author: 'Robert M. Pirsig',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(201)),
- *      Ensure.that(LastResponse.header('Location'), equals('/books/0-688-00230-7')),
- *  );
- *
- * @example <caption>Submit a HTML form</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { stringify } from 'querystring';
- *
- *  const
- *      actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com')),
- *      formData = stringify({
- *          name: actor.name,
- *          email: `${ actor.name }@example.com`,
- *          text: 'Your website is great! Learnt a lot :-)'
- *      });
- *
- *  actor.attemptsTo(
- *      Send.a(PostRequest.to('/feedback').with(postData).using({
- *          headers: {
- *              'Content-Type': 'application/x-www-form-urlencoded',
- *              'Content-Length': formData.length
- *          }
- *      })),
- *      Ensure.that(LastResponse.status(), equals(200)),
- *      Ensure.that(LastResponse.header('Location'), equals('/feedback/thank-you.html')),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.3
- *
- * @extends {HTTPRequest}
- */
-export declare class PostRequest 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 {PostRequest}
-     */
-    static to(resourceUri: Answerable<string>): PostRequest;
-    /**
-     * @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 {PostRequest}
-     */
-    with(data: Answerable<any>): PostRequest;
-    /**
-     * @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 {PostRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): PostRequest;
-}

package/lib/model/PostRequest.js

@@ -1,111 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  The HTTP POST method requests that the origin server accepts
- *  the entity enclosed in the request as a new subordinate of the resource
- *  identified by the `resourceUri`.
- *
- *  This means that the POST should be used when you want to create a child resource under
- *  a collection of resources.
- *
- *  POST request is neither [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe),
- *  nor [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
- *  This means that if you retry a POST request N times,
- *  a correctly implemented HTTP REST API will create N resources with N different URIs.
- *
- * @example <caption>Add new resource to a collection</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PostRequest, 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(PostRequest.to('/books').with({
- *          isbn: '0-688-00230-7',
- *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
- *          author: 'Robert M. Pirsig',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(201)),
- *      Ensure.that(LastResponse.header('Location'), equals('/books/0-688-00230-7')),
- *  );
- *
- * @example <caption>Submit a HTML form</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { stringify } from 'querystring';
- *
- *  const
- *      actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com')),
- *      formData = stringify({
- *          name: actor.name,
- *          email: `${ actor.name }@example.com`,
- *          text: 'Your website is great! Learnt a lot :-)'
- *      });
- *
- *  actor.attemptsTo(
- *      Send.a(PostRequest.to('/feedback').with(postData).using({
- *          headers: {
- *              'Content-Type': 'application/x-www-form-urlencoded',
- *              'Content-Length': formData.length
- *          }
- *      })),
- *      Ensure.that(LastResponse.status(), equals(200)),
- *      Ensure.that(LastResponse.header('Location'), equals('/feedback/thank-you.html')),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.3
- *
- * @extends {HTTPRequest}
- */
-class PostRequest 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 {PostRequest}
-     */
-    static to(resourceUri) {
-        return new PostRequest(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 {PostRequest}
-     */
-    with(data) {
-        return new PostRequest(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 {PostRequest}
-     */
-    using(config) {
-        return new PostRequest(this.resourceUri, this.data, config);
-    }
-}
-exports.PostRequest = PostRequest;
-//# sourceMappingURL=PostRequest.js.map

package/lib/model/PostRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PostRequest.js","sourceRoot":"","sources":["../../src/model/PostRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;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;;;;;;;;OAQG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;CACJ;AA9CD,kCA8CC"}

package/lib/model/PutRequest.d.ts

@@ -1,75 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-import { HTTPRequest } from './HTTPRequest';
-/**
- * @desc
- *  The PUT method requests that the state of the target resource be
- *  created or replaced with the state defined by the representation
- *  enclosed in the request message payload.
- *
- *  PUT request should be used when you want to create
- *  a new resource at a known `resourceUri` (e.g. `/books/0-688-00230-7`)
- *  or replace an existing resource at such `resourceUri`.
- *
- *  PUT request is [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent):
- *  calling it once or several times successively has the same effect (that is no _side effect_).
- *
- * @example <caption>Create a new resource at a known location</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PutRequest, 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(PutRequest.to('/books/0-688-00230-7').with({
- *          isbn: '0-688-00230-7',
- *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
- *          author: 'Robert M. Pirsig',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(201)),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.4
- *
- * @extends {HTTPRequest}
- */
-export declare class PutRequest 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 {PutRequest}
-     */
-    static to(resourceUri: Answerable<string>): PutRequest;
-    /**
-     * @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 {PutRequest}
-     */
-    with(data: Answerable<any>): PutRequest;
-    /**
-     * @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 {PutRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): PutRequest;
-}

package/lib/model/PutRequest.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PutRequest = void 0;
-const HTTPRequest_1 = require("./HTTPRequest");
-/**
- * @desc
- *  The PUT method requests that the state of the target resource be
- *  created or replaced with the state defined by the representation
- *  enclosed in the request message payload.
- *
- *  PUT request should be used when you want to create
- *  a new resource at a known `resourceUri` (e.g. `/books/0-688-00230-7`)
- *  or replace an existing resource at such `resourceUri`.
- *
- *  PUT request is [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent):
- *  calling it once or several times successively has the same effect (that is no _side effect_).
- *
- * @example <caption>Create a new resource at a known location</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, LastResponse, PutRequest, 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(PutRequest.to('/books/0-688-00230-7').with({
- *          isbn: '0-688-00230-7',
- *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
- *          author: 'Robert M. Pirsig',
- *      })),
- *      Ensure.that(LastResponse.status(), equals(201)),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.4
- *
- * @extends {HTTPRequest}
- */
-class PutRequest 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 {PutRequest}
-     */
-    static to(resourceUri) {
-        return new PutRequest(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 {PutRequest}
-     */
-    with(data) {
-        return new PutRequest(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 {PutRequest}
-     */
-    using(config) {
-        return new PutRequest(this.resourceUri, this.data, config);
-    }
-}
-exports.PutRequest = PutRequest;
-//# sourceMappingURL=PutRequest.js.map

package/lib/model/PutRequest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PutRequest.js","sourceRoot":"","sources":["../../src/model/PutRequest.ts"],"names":[],"mappings":";;;AAGA,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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;;;;;;;;OAQG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAsC;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACJ;AA9CD,gCA8CC"}

package/lib/model/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,+CAA6B;AAC7B,gDAA8B;AAC9B,gDAA8B;AAC9B,mDAAiC;AACjC,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B"}

package/lib/screenplay/interactions/ChangeApiUrl.d.ts

@@ -1,82 +0,0 @@
-import { Answerable, AnswersQuestions, CollectsArtifacts, Interaction, UsesAbilities } from '@serenity-js/core';
-/**
- * @desc
- *  Changes the base URL the {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability}
- *  has been configured with. Useful when we don't know the URL before the test is started,
- *  for example when the URL is dynamically generated and needs to be read from the website under test.
- *
- * @example <caption>Changing the API URL</caption>
- * import { Actor } from '@serenity-js/core';
- * import { Navigate, Target, Text } from '@serenity-js/protractor';
- * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
- * import { protractor, by } from 'protractor';
- *
- * import axios  from 'axios';
- *
- * const actor = Actor.named('Apisit').whoCan(
- *     BrowseTheWeb.using(protractor.browser),
- *
- *     // Note: no default base URL is given when the axios instance is created
- *     CallAnApi.using(axios.create()),
- * );
- *
- * // Let's imagine that the website under test displays
- * // a dynamically generated API URL we'd like to use
- * const ApiDetailsWidget = {
- *     Url: Target.the('API URL').located(by.id('api-url')),
- * }
- *
- * actor.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).
- *     ChangeApiUrl.to(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)),
- * );
- *
- * @deprecated Use ChangeApiConfig.setUrlTo(newUrl) instead
- *
- * @see {@link ChangeApiConfig}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-export declare class ChangeApiUrl extends Interaction {
-    private readonly newApiUrl;
-    /**
-     * @desc
-     *  Instantiates a new {@link ChangeApiUrl} {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} newApiUrl
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static to(newApiUrl: Answerable<string>): Interaction;
-    /**
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} newApiUrl
-     */
-    constructor(newApiUrl: Answerable<string>);
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & CollectsArtifacts & AnswersQuestions} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~CollectsArtifacts}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    performAs(actor: UsesAbilities & CollectsArtifacts & AnswersQuestions): Promise<void>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-}

package/lib/screenplay/interactions/ChangeApiUrl.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChangeApiUrl = void 0;
-const core_1 = require("@serenity-js/core");
-const abilities_1 = require("../abilities");
-/**
- * @desc
- *  Changes the base URL the {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability}
- *  has been configured with. Useful when we don't know the URL before the test is started,
- *  for example when the URL is dynamically generated and needs to be read from the website under test.
- *
- * @example <caption>Changing the API URL</caption>
- * import { Actor } from '@serenity-js/core';
- * import { Navigate, Target, Text } from '@serenity-js/protractor';
- * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
- * import { protractor, by } from 'protractor';
- *
- * import axios  from 'axios';
- *
- * const actor = Actor.named('Apisit').whoCan(
- *     BrowseTheWeb.using(protractor.browser),
- *
- *     // Note: no default base URL is given when the axios instance is created
- *     CallAnApi.using(axios.create()),
- * );
- *
- * // Let's imagine that the website under test displays
- * // a dynamically generated API URL we'd like to use
- * const ApiDetailsWidget = {
- *     Url: Target.the('API URL').located(by.id('api-url')),
- * }
- *
- * actor.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).
- *     ChangeApiUrl.to(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)),
- * );
- *
- * @deprecated Use ChangeApiConfig.setUrlTo(newUrl) instead
- *
- * @see {@link ChangeApiConfig}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-class ChangeApiUrl extends core_1.Interaction {
-    /**
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} newApiUrl
-     */
-    constructor(newApiUrl) {
-        super();
-        this.newApiUrl = newApiUrl;
-    }
-    /**
-     * @desc
-     *  Instantiates a new {@link ChangeApiUrl} {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} newApiUrl
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static to(newApiUrl) {
-        return new ChangeApiUrl(newApiUrl);
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & CollectsArtifacts & AnswersQuestions} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~CollectsArtifacts}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    performAs(actor) {
-        return actor.answer(this.newApiUrl)
-            .then(newApiUrl => abilities_1.CallAnApi.as(actor).modifyConfig(config => config.baseURL = newApiUrl));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return `#actor changes the API URL to ${this.newApiUrl.toString()}`;
-    }
-}
-exports.ChangeApiUrl = ChangeApiUrl;
-//# sourceMappingURL=ChangeApiUrl.js.map

package/lib/screenplay/interactions/ChangeApiUrl.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ChangeApiUrl.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/ChangeApiUrl.ts"],"names":[],"mappings":";;;AAAA,4CAAgH;AAEhH,4CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAa,YAAa,SAAQ,kBAAW;IAazC;;OAEG;IACH,YAA6B,SAA6B;QACtD,KAAK,EAAE,CAAC;QADiB,cAAS,GAAT,SAAS,CAAoB;IAE1D,CAAC;IAhBD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,SAA6B;QACnC,OAAO,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IASD;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAA2D;QACjE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aAC9B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,iCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAG,EAAE,CAAC;IAC1E,CAAC;CACJ;AA/CD,oCA+CC"}

package/src/model/DeleteRequest.ts

@@ -1,71 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { AxiosRequestConfig } from 'axios';
-
-import { HTTPRequest } from './HTTPRequest';
-
-/**
- * @desc
- *  The DELETE method requests that the origin server remove the
- *  association between the target resource and its current
- *  functionality.
- *
- * @example <caption>Create and remove a resource</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, DeleteRequest, LastResponse, PostRequest, Send } from '@serenity-js/rest'
- *  import { Ensure, equals, startsWith } from '@serenity-js/assertions';
- *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
- *
- *  actor.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)),
- *  );
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
- * @see https://tools.ietf.org/html/rfc7231#section-4.3.5
- *
- * @extends {HTTPRequest}
- */
-export class DeleteRequest 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 {DeleteRequest}
-     */
-    static to(resourceUri: Answerable<string>): DeleteRequest {
-        return new DeleteRequest(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 {DeleteRequest}
-     */
-    using(config: Answerable<AxiosRequestConfig>): DeleteRequest {
-        return new DeleteRequest(this.resourceUri, undefined, config);
-    }
-}