@serenity-js/rest 2.32.7 → 3.0.0-rc.10

package/CHANGELOG.md

@@ -3,6 +3,242 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-rc.10](https://github.com/serenity-js/serenity-js/compare/v2.33.0...v3.0.0-rc.10) (2022-02-03)
+
+
+
+# [3.0.0-rc.9](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.8...v3.0.0-rc.9) (2022-02-01)
+
+
+
+# [3.0.0-rc.8](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.7...v3.0.0-rc.8) (2022-01-28)
+
+
+
+# [3.0.0-rc.7](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.6...v3.0.0-rc.7) (2022-01-28)
+
+
+### Features
+
+* **core:** replaced `Adapter` with `QuestionAdapter` and introduced `Optional` ([8d84ad3](https://github.com/serenity-js/serenity-js/commit/8d84ad3863e3c726533d0f21934fb1e2fa8b3022)), closes [#1103](https://github.com/serenity-js/serenity-js/issues/1103)
+
+
+
+# [3.0.0-rc.6](https://github.com/serenity-js/serenity-js/compare/v2.32.7...v3.0.0-rc.6) (2022-01-10)
+
+
+
+# [3.0.0-rc.5](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.4...v3.0.0-rc.5) (2022-01-07)
+
+
+
+# [3.0.0-rc.4](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.3...v3.0.0-rc.4) (2021-12-30)
+
+
+### Bug Fixes
+
+* **core:** you can now retrieve the .length property of an Array wrapped in an Adapter<Array> ([c36e210](https://github.com/serenity-js/serenity-js/commit/c36e210c024052b96ba47e9663c7098e269c5688))
+
+
+
+# [3.0.0-rc.3](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.2...v3.0.0-rc.3) (2021-12-29)
+
+
+### Bug Fixes
+
+* **rest:** corrected LastResponse to wrap .status(), .body(), .header() and .headers() in Adapters ([aab8e93](https://github.com/serenity-js/serenity-js/commit/aab8e93a19005710d9f333756cdae5aa21c31058)), closes [#1082](https://github.com/serenity-js/serenity-js/issues/1082)
+
+
+
+# [3.0.0-rc.2](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.1...v3.0.0-rc.2) (2021-12-09)
+
+
+
+# [3.0.0-rc.1](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.0...v3.0.0-rc.1) (2021-12-09)
+
+
+
+# [3.0.0-rc.0](https://github.com/serenity-js/serenity-js/compare/v2.32.5...v3.0.0-rc.0) (2021-12-08)
+
+
+### Bug Fixes
+
+* **core:** 3.0 RC ([469d54e](https://github.com/serenity-js/serenity-js/commit/469d54e4f81ef430566b93852e3174826f8ef672)), closes [#805](https://github.com/serenity-js/serenity-js/issues/805)
+
+
+### Features
+
+* **core:** question.about produces "props" that proxy the methods of the underlying model ([f771872](https://github.com/serenity-js/serenity-js/commit/f771872c56b487e404002c3800fc8f3baaed804f))
+
+
+### BREAKING CHANGES
+
+* **core:** Introduced @serenity-js/web - a shared library for Serenity/JS Web integration
+modules such as @serenity-js/protractor and @serenity-js/webdriverio. Dropped support for Node 12.
+
+
+
+
+
+# [3.0.0-rc.9](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.8...v3.0.0-rc.9) (2022-02-01)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+# [3.0.0-rc.8](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.7...v3.0.0-rc.8) (2022-01-28)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+# [3.0.0-rc.7](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.6...v3.0.0-rc.7) (2022-01-28)
+
+
+### Features
+
+* **core:** replaced `Adapter` with `QuestionAdapter` and introduced `Optional` ([8d84ad3](https://github.com/serenity-js/serenity-js/commit/8d84ad3863e3c726533d0f21934fb1e2fa8b3022)), closes [#1103](https://github.com/serenity-js/serenity-js/issues/1103)
+
+
+
+
+
+# [3.0.0-rc.6](https://github.com/serenity-js/serenity-js/compare/v2.32.7...v3.0.0-rc.6) (2022-01-10)
+
+
+
+# [3.0.0-rc.5](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.4...v3.0.0-rc.5) (2022-01-07)
+
+
+
+# [3.0.0-rc.4](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.3...v3.0.0-rc.4) (2021-12-30)
+
+
+### Bug Fixes
+
+* **core:** you can now retrieve the .length property of an Array wrapped in an Adapter<Array> ([c36e210](https://github.com/serenity-js/serenity-js/commit/c36e210c024052b96ba47e9663c7098e269c5688))
+
+
+
+# [3.0.0-rc.3](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.2...v3.0.0-rc.3) (2021-12-29)
+
+
+### Bug Fixes
+
+* **rest:** corrected LastResponse to wrap .status(), .body(), .header() and .headers() in Adapters ([aab8e93](https://github.com/serenity-js/serenity-js/commit/aab8e93a19005710d9f333756cdae5aa21c31058)), closes [#1082](https://github.com/serenity-js/serenity-js/issues/1082)
+
+
+
+# [3.0.0-rc.2](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.1...v3.0.0-rc.2) (2021-12-09)
+
+
+
+# [3.0.0-rc.1](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.0...v3.0.0-rc.1) (2021-12-09)
+
+
+
+# [3.0.0-rc.0](https://github.com/serenity-js/serenity-js/compare/v2.32.5...v3.0.0-rc.0) (2021-12-08)
+
+
+### Bug Fixes
+
+* **core:** 3.0 RC ([469d54e](https://github.com/serenity-js/serenity-js/commit/469d54e4f81ef430566b93852e3174826f8ef672)), closes [#805](https://github.com/serenity-js/serenity-js/issues/805)
+
+
+### Features
+
+* **core:** question.about produces "props" that proxy the methods of the underlying model ([f771872](https://github.com/serenity-js/serenity-js/commit/f771872c56b487e404002c3800fc8f3baaed804f))
+
+
+### BREAKING CHANGES
+
+* **core:** Introduced @serenity-js/web - a shared library for Serenity/JS Web integration
+modules such as @serenity-js/protractor and @serenity-js/webdriverio. Dropped support for Node 12.
+
+
+
+
+
+# [3.0.0-rc.5](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.4...v3.0.0-rc.5) (2022-01-07)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+# [3.0.0-rc.4](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.3...v3.0.0-rc.4) (2021-12-30)
+
+
+### Bug Fixes
+
+* **core:** you can now retrieve the .length property of an Array wrapped in an Adapter<Array> ([c36e210](https://github.com/serenity-js/serenity-js/commit/c36e210c024052b96ba47e9663c7098e269c5688))
+
+
+
+
+
+# [3.0.0-rc.3](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.2...v3.0.0-rc.3) (2021-12-29)
+
+
+### Bug Fixes
+
+* **rest:** corrected LastResponse to wrap .status(), .body(), .header() and .headers() in Adapters ([aab8e93](https://github.com/serenity-js/serenity-js/commit/aab8e93a19005710d9f333756cdae5aa21c31058)), closes [#1082](https://github.com/serenity-js/serenity-js/issues/1082)
+
+
+
+
+
+# [3.0.0-rc.2](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.1...v3.0.0-rc.2) (2021-12-09)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+# [3.0.0-rc.1](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.0...v3.0.0-rc.1) (2021-12-09)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+# [3.0.0-rc.0](https://github.com/serenity-js/serenity-js/compare/v2.32.5...v3.0.0-rc.0) (2021-12-08)
+
+
+### Bug Fixes
+
+* **core:** 3.0 RC ([469d54e](https://github.com/serenity-js/serenity-js/commit/469d54e4f81ef430566b93852e3174826f8ef672)), closes [#805](https://github.com/serenity-js/serenity-js/issues/805)
+
+
+### Features
+
+* **core:** question.about produces "props" that proxy the methods of the underlying model ([f771872](https://github.com/serenity-js/serenity-js/commit/f771872c56b487e404002c3800fc8f3baaed804f))
+
+
+### BREAKING CHANGES
+
+* **core:** Introduced @serenity-js/web - a shared library for Serenity/JS Web integration
+modules such as @serenity-js/protractor and @serenity-js/webdriverio. Dropped support for Node 12.
+
+
+
+
+
+# [2.33.0](https://github.com/serenity-js/serenity-js/compare/v2.32.7...v2.33.0) (2022-02-03)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
 ## [2.32.7](https://github.com/serenity-js/serenity-js/compare/v2.32.6...v2.32.7) (2022-01-10)
 
 **Note:** Version bump only for package @serenity-js/rest

package/lib/model/HTTPRequest.d.ts

@@ -12,6 +12,7 @@ export declare abstract class HTTPRequest extends Question<Promise<AxiosRequestC
     protected readonly resourceUri?: Answerable<string>;
     protected readonly data?: Answerable<any>;
     protected readonly config?: Answerable<AxiosRequestConfig>;
+    private subject;
     /**
      * @protected
      *
@@ -34,6 +35,15 @@ export declare abstract class HTTPRequest extends Question<Promise<AxiosRequestC
      * @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.

package/lib/model/HTTPRequest.js

@@ -26,7 +26,7 @@ class HTTPRequest extends core_1.Question {
      *  provided when the {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability} is instantiated
      */
     constructor(resourceUri, data, config) {
-        super('');
+        super();
         this.resourceUri = resourceUri;
         this.data = data;
         this.config = config;
@@ -55,6 +55,20 @@ class HTTPRequest extends core_1.Question {
             return acc;
         }, {}));
     }
+    /**
+     * @desc
+     *  Changes the description of this question's subject.
+     *
+     * @param {string} subject
+     * @returns {Question<T>}
+     */
+    describedAs(subject) {
+        this.subject = subject;
+        return this;
+    }
+    toString() {
+        return this.subject;
+    }
     /**
      * Determines the request method based on the name of the request class.
      * For example: GetRequest => GET, PostRequest => POST, etc.

package/lib/model/HTTPRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"HTTPRequest.js","sourceRoot":"","sources":["../../src/model/HTTPRequest.ts"],"names":[],"mappings":";;;AAAA,4CAA0F;AAC1F,iDAAqD;AAGrD;;;;;;;GAOG;AACH,MAAsB,WAAY,SAAQ,eAAqC;IAE3E;;;;;;;;;;;;OAYG;IACH,YACuB,WAAgC,EAChC,IAAsB,EACtB,MAAuC;QAE1D,KAAK,CAAC,EAAE,CAAC,CAAC;QAJS,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;;;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;AA3ED,kCA2EC"}
+{"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/screenplay/questions/LastResponse.d.ts

@@ -1,4 +1,4 @@
-import { Question } from '@serenity-js/core';
+import { QuestionAdapter } from '@serenity-js/core';
 /**
  * @desc
  *  Provides access to the properties of the last {@link AxiosResponse} object,
@@ -25,6 +25,31 @@ import { Question } from '@serenity-js/core';
  *          author: 'Robert M. Pirsig',
  *      })),
  *  );
+ *
+ * @example <caption>Use Serenity/JS adapters to navigate complex response objects</caption>
+ *  import { Actor } from '@serenity-js/core';
+ *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ *  interface Developer {
+ *      name: string;
+ *      id: string;
+ *      projects: Project[];
+ *  }
+ *
+ *  interface Project {
+ *      name: string;
+ *      repoUrl: string;
+ *  }
+ *
+ *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
+ *
+ *  actor.attemptsTo(
+ *      Send.a(GetRequest.to('/developers/jan-molak')),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *      Ensure.that(LastResponse.body<Developer>().name, equals('Jan Molak')),
+ *      Ensure.that(LastResponse.body<Developer>().projects[0].name, equals('Serenity/JS')),
+ *  );
  */
 export declare class LastResponse {
     /**
@@ -33,7 +58,7 @@ export declare class LastResponse {
      *
      * @returns {@serenity-js/core/lib/screenplay~Question<number>}
      */
-    static status(): Question<number>;
+    static status(): QuestionAdapter<number>;
     /**
      * @desc
      *  Enables asserting on the {@link LastResponse} body
@@ -90,7 +115,7 @@ export declare class LastResponse {
      * @see {@link @serenity-js/core/lib/screenplay/questions~Property}
      * @see {@link @serenity-js/core/lib/screenplay/questions~List}
      */
-    static body<T = any>(): Question<T>;
+    static body<T = any>(): QuestionAdapter<T>;
     /**
      * @desc
      *  Enables asserting on one of the {@link LastResponse}'s headers
@@ -98,7 +123,7 @@ export declare class LastResponse {
      * @param {string} name
      * @returns {@serenity-js/core/lib/screenplay~Question<string>}
      */
-    static header(name: string): Question<string>;
+    static header(name: string): QuestionAdapter<string>;
     /**
      * @desc
      *  Enables asserting on all of the {@link LastResponse}'s headers,
@@ -106,5 +131,5 @@ export declare class LastResponse {
      *
      * @returns {@serenity-js/core/lib/screenplay~Question<Record<string, string>>}
      */
-    static headers(): Question<Record<string, string>>;
+    static headers(): QuestionAdapter<Record<string, string>>;
 }

package/lib/screenplay/questions/LastResponse.js

@@ -29,6 +29,31 @@ const abilities_1 = require("../abilities");
  *          author: 'Robert M. Pirsig',
  *      })),
  *  );
+ *
+ * @example <caption>Use Serenity/JS adapters to navigate complex response objects</caption>
+ *  import { Actor } from '@serenity-js/core';
+ *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ *  interface Developer {
+ *      name: string;
+ *      id: string;
+ *      projects: Project[];
+ *  }
+ *
+ *  interface Project {
+ *      name: string;
+ *      repoUrl: string;
+ *  }
+ *
+ *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
+ *
+ *  actor.attemptsTo(
+ *      Send.a(GetRequest.to('/developers/jan-molak')),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *      Ensure.that(LastResponse.body<Developer>().name, equals('Jan Molak')),
+ *      Ensure.that(LastResponse.body<Developer>().projects[0].name, equals('Serenity/JS')),
+ *  );
  */
 class LastResponse {
     /**
@@ -38,7 +63,7 @@ class LastResponse {
      * @returns {@serenity-js/core/lib/screenplay~Question<number>}
      */
     static status() {
-        return core_1.Question.about(`the status of the last response`, actor => {
+        return core_1.Question.about(`the status of the last response`, async (actor) => {
             return abilities_1.CallAnApi.as(actor).mapLastResponse(response => response.status);
         });
     }
@@ -99,7 +124,7 @@ class LastResponse {
      * @see {@link @serenity-js/core/lib/screenplay/questions~List}
      */
     static body() {
-        return core_1.Question.about(`the body of the last response`, actor => {
+        return core_1.Question.about(`the body of the last response`, async (actor) => {
             return abilities_1.CallAnApi.as(actor).mapLastResponse(response => response.data);
         });
     }
@@ -111,7 +136,7 @@ class LastResponse {
      * @returns {@serenity-js/core/lib/screenplay~Question<string>}
      */
     static header(name) {
-        return core_1.Question.about(`the '${name}' header of the last response`, actor => {
+        return core_1.Question.about(`the '${name}' header of the last response`, async (actor) => {
             return abilities_1.CallAnApi.as(actor).mapLastResponse(response => response.headers[name]);
         });
     }
@@ -123,7 +148,7 @@ class LastResponse {
      * @returns {@serenity-js/core/lib/screenplay~Question<Record<string, string>>}
      */
     static headers() {
-        return core_1.Question.about(`the headers or the last response`, actor => {
+        return core_1.Question.about(`the headers or the last response`, async (actor) => {
             return abilities_1.CallAnApi.as(actor).mapLastResponse(response => response.headers);
         });
     }

package/lib/screenplay/questions/LastResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"LastResponse.js","sourceRoot":"","sources":["../../../src/screenplay/questions/LastResponse.ts"],"names":[],"mappings":";;;AAAA,4CAA6C;AAE7C,4CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,YAAY;IAErB;;;;;OAKG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,eAAQ,CAAC,KAAK,CAAS,iCAAiC,EAAE,KAAK,CAAC,EAAE;YACrE,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,eAAQ,CAAC,KAAK,CAAI,+BAA+B,EAAE,KAAK,CAAC,EAAE;YAC9D,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAS,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY;QACtB,OAAO,eAAQ,CAAC,KAAK,CAAS,QAAS,IAAK,+BAA+B,EAAE,KAAK,CAAC,EAAE;YACjF,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,eAAQ,CAAC,KAAK,CAAyB,kCAAkC,EAAE,KAAK,CAAC,EAAE;YACtF,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AArGD,oCAqGC"}
+{"version":3,"file":"LastResponse.js","sourceRoot":"","sources":["../../../src/screenplay/questions/LastResponse.ts"],"names":[],"mappings":";;;AAAA,4CAA8D;AAE9D,4CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAa,YAAY;IAErB;;;;;OAKG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,eAAQ,CAAC,KAAK,CAAS,iCAAiC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC3E,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,eAAQ,CAAC,KAAK,CAAI,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpE,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAS,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY;QACtB,OAAO,eAAQ,CAAC,KAAK,CAAS,QAAS,IAAK,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACvF,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,eAAQ,CAAC,KAAK,CAAyB,kCAAkC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC5F,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AArGD,oCAqGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/rest",
-  "version": "2.32.7",
+  "version": "3.0.0-rc.10",
   "description": "Test REST APIs with Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -29,7 +29,7 @@
   ],
   "scripts": {
     "clean": "rimraf .nyc_output lib target",
-    "lint": "eslint --ext ts --config ../../.eslintrc.js .",
+    "lint": "eslint --ext ts --config ../../.eslintrc.yml .",
     "lint:fix": "npm run lint -- --fix",
     "test": "nyc --report-dir ../../target/coverage/rest mocha --config ../../.mocharc.yml 'spec/**/*.spec.*'",
     "compile": "tsc --project tsconfig.json",
@@ -43,17 +43,17 @@
     "url": "https://github.com/serenity-js/serenity-js/issues"
   },
   "engines": {
-    "node": "^12 || ^14 || ^16",
+    "node": "^14 || ^16",
     "npm": "^6 || ^7 || ^8"
   },
   "dependencies": {
-    "@serenity-js/core": "2.32.7",
+    "@serenity-js/core": "3.0.0-rc.10",
     "axios": "^0.21.4"
   },
   "devDependencies": {
-    "@documentation/esdoc-template": "2.0.0",
-    "@integration/testing-tools": "2.0.0",
-    "@serenity-js/assertions": "2.32.7",
+    "@documentation/esdoc-template": "3.0.0",
+    "@integration/testing-tools": "3.0.0",
+    "@serenity-js/assertions": "3.0.0-rc.10",
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.0.0",
     "axios-mock-adapter": "^1.20.0",
@@ -83,5 +83,5 @@
     "cache": true,
     "all": true
   },
-  "gitHead": "93f54f9919b74d66f10cdd7acbadba5927d728f7"
+  "gitHead": "7e8570d412348980c22a6e189ebc4c4f0157919d"
 }

package/src/model/HTTPRequest.ts

@@ -12,6 +12,8 @@ import { AxiosRequestConfig } from 'axios';
  */
 export abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>> {
 
+    private subject: string;
+
     /**
      * @protected
      *
@@ -30,7 +32,7 @@ export abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>>
         protected readonly data?: Answerable<any>,
         protected readonly config?: Answerable<AxiosRequestConfig>,
     ) {
-        super('');
+        super();
         this.subject = `${ this.requestDescription() } to ${ formatted `${ this.resourceUri }` }`;
     }
 
@@ -67,6 +69,22 @@ export abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>>
         );
     }
 
+    /**
+     * @desc
+     *  Changes the description of this question's subject.
+     *
+     * @param {string} subject
+     * @returns {Question<T>}
+     */
+    describedAs(subject: string): this {
+        this.subject = subject;
+        return this;
+    }
+
+    toString(): string {
+        return this.subject;
+    }
+
     /**
      * Determines the request method based on the name of the request class.
      * For example: GetRequest => GET, PostRequest => POST, etc.

package/src/screenplay/questions/LastResponse.ts

@@ -1,4 +1,4 @@
-import { Question } from '@serenity-js/core';
+import { Question, QuestionAdapter } from '@serenity-js/core';
 
 import { CallAnApi } from '../abilities';
 
@@ -28,6 +28,31 @@ import { CallAnApi } from '../abilities';
  *          author: 'Robert M. Pirsig',
  *      })),
  *  );
+ *
+ * @example <caption>Use Serenity/JS adapters to navigate complex response objects</caption>
+ *  import { Actor } from '@serenity-js/core';
+ *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ *  interface Developer {
+ *      name: string;
+ *      id: string;
+ *      projects: Project[];
+ *  }
+ *
+ *  interface Project {
+ *      name: string;
+ *      repoUrl: string;
+ *  }
+ *
+ *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
+ *
+ *  actor.attemptsTo(
+ *      Send.a(GetRequest.to('/developers/jan-molak')),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *      Ensure.that(LastResponse.body<Developer>().name, equals('Jan Molak')),
+ *      Ensure.that(LastResponse.body<Developer>().projects[0].name, equals('Serenity/JS')),
+ *  );
  */
 export class LastResponse {
 
@@ -37,8 +62,8 @@ export class LastResponse {
      *
      * @returns {@serenity-js/core/lib/screenplay~Question<number>}
      */
-    static status(): Question<number> {
-        return Question.about<number>(`the status of the last response`, actor => {
+    static status(): QuestionAdapter<number> {
+        return Question.about<number>(`the status of the last response`, async actor => {
             return CallAnApi.as(actor).mapLastResponse(response => response.status);
         });
     }
@@ -99,8 +124,8 @@ export class LastResponse {
      * @see {@link @serenity-js/core/lib/screenplay/questions~Property}
      * @see {@link @serenity-js/core/lib/screenplay/questions~List}
      */
-    static body<T = any>(): Question<T> {
-        return Question.about<T>(`the body of the last response`, actor => {
+    static body<T = any>(): QuestionAdapter<T> {
+        return Question.about<T>(`the body of the last response`, async actor => {
             return CallAnApi.as(actor).mapLastResponse<T>(response => response.data as T);
         });
     }
@@ -112,8 +137,8 @@ export class LastResponse {
      * @param {string} name
      * @returns {@serenity-js/core/lib/screenplay~Question<string>}
      */
-    static header(name: string): Question<string> {
-        return Question.about<string>(`the '${ name }' header of the last response`, actor => {
+    static header(name: string): QuestionAdapter<string> {
+        return Question.about<string>(`the '${ name }' header of the last response`, async actor => {
             return CallAnApi.as(actor).mapLastResponse(response => response.headers[name]);
         });
     }
@@ -125,8 +150,8 @@ export class LastResponse {
      *
      * @returns {@serenity-js/core/lib/screenplay~Question<Record<string, string>>}
      */
-    static headers(): Question<Record<string, string>> {
-        return Question.about<Record<string, string>>(`the headers or the last response`, actor => {
+    static headers(): QuestionAdapter<Record<string, string>> {
+        return Question.about<Record<string, string>>(`the headers or the last response`, async actor => {
             return CallAnApi.as(actor).mapLastResponse(response => response.headers);
         });
     }