@serenity-js/local-server 3.0.0-rc.8 → 3.0.0

package/README.md

@@ -1,18 +1,16 @@
 # Serenity/JS
 
-[Serenity/JS](https://serenity-js.org) is a framework designed to make acceptance and regression testing
-of modern full-stack applications faster, more collaborative and easier to scale.
+[![Follow Serenity/JS on LinkedIn](https://img.shields.io/badge/Follow-Serenity%2FJS%20-0077B5?logo=linkedin)](https://www.linkedin.com/company/serenity-js)
+[![Watch Serenity/JS on YouTube](https://img.shields.io/badge/Watch-@serenity--js-E62117?logo=youtube)](https://www.youtube.com/@serenity-js)
+[![Join Serenity/JS Community Chat](https://img.shields.io/badge/Chat-Serenity%2FJS%20Community-FBD30B?logo=matrix)](https://matrix.to/#/#serenity-js:gitter.im)
+[![Support Serenity/JS on GitHub](https://img.shields.io/badge/Support-@serenity--js-703EC8?logo=github)](https://matrix.to/#/#serenity-js:gitter.im)
 
-Visit [serenity-js.org](https://serenity-js.org/) for the [latest tutorials](https://serenity-js.org/handbook/)
-and [API docs](https://serenity-js.org/modules/), and follow [@SerenityJS](https://twitter.com/SerenityJS) and [@JanMolak](https://twitter.com/JanMolak) on Twitter for project updates.
+[Serenity/JS](https://serenity-js.org) is an innovative framework designed to make acceptance and regression testing
+of complex software systems faster, more collaborative and easier to scale.
 
-### Learning Serenity/JS
+To get started, check out the comprehensive [Serenity/JS Handbook](https://serenity-js.org/handbook), [API documentation](https://serenity-js.org/api/core), and [Serenity/JS project templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates).
 
-To learn more about Serenity/JS, check out the video below, read the [tutorial](https://serenity-js.org/handbook/thinking-in-serenity-js/index.html), review the [examples](https://github.com/serenity-js/serenity-js/tree/master/examples), and create your own test suite with [Serenity/JS template projects](https://github.com/serenity-js).
-
-If you have any questions, join us on [Serenity/JS Community Chat](https://gitter.im/serenity-js/Lobby).
-
-[![Full-Stack Acceptance Testing with Serenity/JS and the Screenplay Pattern](https://img.youtube.com/vi/djPMf-n93Rw/0.jpg)](https://www.youtube.com/watch?v=djPMf-n93Rw)
+If you have any questions or just want to say hello, join the [Serenity/JS Community Chat](https://matrix.to/#/#serenity-js:gitter.im).
 
 ## Serenity/JS Local Server
 

package/lib/index.d.ts

@@ -1 +1,2 @@
 export * from './screenplay';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

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

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}

package/lib/screenplay/abilities/ManageALocalServer.d.ts

@@ -1,147 +1,119 @@
 /// <reference types="node" />
-import { Ability, UsesAbilities } from '@serenity-js/core';
+/// <reference types="node" />
+/// <reference types="node" />
+import { Ability } from '@serenity-js/core';
 import * as http from 'http';
 import * as https from 'https';
 import * as net from 'net';
 /**
- * @desc
- *  An {@link @serenity-js/core/lib/screenplay~Ability} that enables the {@link @serenity-js/core/lib/screenplay/actor~Actor}
- *  to manage a local [Node.js](https://nodejs.org/) server.
+ * An {@apilink Ability} that enables an {@apilink Actor}
+ * to manage a local [Node.js](https://nodejs.org/) server.
  *
- * @example <caption>Using a raw Node.js server</caption>
- * import { Actor } from '@serenity-js/core';
- * import { CallAnApi, GetRequest, Send } from '@serenity-js/rest';
+ * ## Managing a raw Node.js server
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, Send } from '@serenity-js/rest'
  * import { ManageALocalServer, LocalTestServer, StartLocalTestServer, StopLocalTestServer } from '@serenity-js/local-server'
- * import { Ensure, equals } from '@serenity-js/assertions';
+ * import { Ensure, equals } from '@serenity-js/assertions'
  *
- * import axios from 'axios';
- * import * as http from 'http';
+ * import * as axios from 'axios'
+ * import * as http from 'http'
  *
  * const server = http.createServer(function (request, response) {
- *     response.setHeader('Connection', 'close');
- *     response.end('Hello!');
+ *   response.setHeader('Connection', 'close');
+ *   response.end('Hello!');
  * })
  *
- * const actor = Actor.named('Apisit').whoCan(
+ * await actorCalled('Apisit')
+ *   .whoCan(
  *     ManageALocalServer.using(server),
  *     CallAnApi.using(axios.create()),
- * );
- *
- * actor.attemptsTo(
+ *   )
+ *   .attemptsTo(
  *     StartLocalTestServer.onRandomPort(),
  *     Send.a(GetRequest.to(LocalServer.url())),
  *     Ensure.that(LastResponse.status(), equals(200)),
  *     Ensure.that(LastResponse.body<string>(), equals('Hello!')),
  *     StopLocalTestServer.ifRunning(),
- * );
+ *   )
+ * ```
  *
- * @see https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/
- * @see https://nodejs.org/api/http.html#http_class_http_server
+ * ## Learn more
+ * - [Anatomy of an HTTP transaction](https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/)
+ * - [Node.js HTTP server](https://nodejs.org/api/http.html#http_class_http_server)
  *
- * @implements {@link @serenity-js/core/lib/screenplay~Ability}
+ * @group Abilities
  */
-export declare class ManageALocalServer implements Ability {
+export declare class ManageALocalServer extends Ability {
     private readonly protocol;
     private readonly server;
     /**
-     * @desc
-     *  {@link @serenity-js/core/lib/screenplay~Ability} to manage a Node.js HTTP server using the provided `requestListener`.
+     * An {@apilink Ability} to manage a Node.js HTTP server using the provided `requestListener`.
      *
-     * @param {RequestListener | net~Server} listener
-     * @returns {ManageALocalServer}
+     * @param listener
      */
     static runningAHttpListener(listener: RequestListener | net.Server): ManageALocalServer;
     /**
-     * @desc
-     *  {@link @serenity-js/core/lib/screenplay~Ability} to manage a Node.js HTTPS server using the provided server `requestListener`.
+     * An {@apilink Ability} to manage a Node.js HTTPS server using the provided server `requestListener`.
      *
-     * @param {RequestListener | https~Server} listener
-     * @param {https~ServerOptions} options - Accepts options from `tls.createServer()`, `tls.createSecureContext()` and `http.createServer()`.
-     * @returns {ManageALocalServer}
+     * @param listener
+     * @param options
+     *  Accepts an options object from `tls.createServer()`, `tls.createSecureContext()` and `http.createServer()`.
      *
      * @see https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
      */
     static runningAHttpsListener(listener: RequestListener | https.Server, options?: https.ServerOptions): ManageALocalServer;
     /**
-     * @desc
-     *  Used to access the {@link @serenity-js/core/lib/screenplay/actor~Actor}'s {@link @serenity-js/core/lib/screenplay~Ability}  to {@link ManageALocalServer}
-     *  from within the {@link @serenity-js/core/lib/screenplay~Interaction} classes,
-     *  such as {@link StartLocalServer}.
-     *
-     * @param {@serenity-js/core/lib/screenplay~UsesAbilities} actor
-     * @return {ManageALocalServer}
-     */
-    static as(actor: UsesAbilities): ManageALocalServer;
-    /**
-     * @param {string} protocol - Protocol to be used when communicating with the running server; `http` or `https`
+     * @param protocol
+     *  Protocol to be used when communicating with the running server; `http` or `https`
      *
-     * @param {net~Server} server - A Node.js server requestListener, with support for [server shutdown](https://www.npmjs.com/package/http-shutdown).
+     * @param server
+     *  A Node.js server requestListener, with support for [server shutdown](https://www.npmjs.com/package/http-shutdown).
      *
      * @see https://www.npmjs.com/package/http-shutdown
      */
     constructor(protocol: SupportedProtocols, server: net.Server);
     /**
-     * @desc
-     *  Starts the server on the first free port between `preferredPort` and `highestPort`, inclusive.
+     * Starts the server on the first free port between `preferredPort` and `highestPort`, inclusive.
      *
-     * @param {number} [preferredPort=8000]
+     * @param [preferredPort=8000]
      *  Lower bound of the preferred port range
      *
-     * @param {number} [highestPort=65535] highestPort
+     * @param [highestPort=65535] highestPort
      *  Upper bound of the preferred port range
-     *
-     * @returns {Promise<void>}
      */
     listen(preferredPort?: number, highestPort?: number): Promise<void>;
     /**
-     * @desc
-     *  Provides access to the server requestListener
+     * Provides access to the server `requestListener`
      *
      * @param {function(server: ServerWithShutdown, protocol?: SupportedProtocols): T} fn
-     * @returns {T}
      */
     mapInstance<T>(fn: (server: ServerWithShutdown, protocol?: SupportedProtocols) => T): T;
 }
 /**
- * @desc
- *  A `requestListener` function that Node's
- *  [`http.createServer`](https://nodejs.org/api/http.html#http_http_createserver_options_requestlistener)
- *  or [`https.createServer`](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener)
- *  would accept.
- *
- * @public
- *
- * @typedef {function(request: http.IncomingMessage, response: http.ServerResponse): void} RequestListener
+ * A `requestListener` function accepted by Node's
+ * [`http.createServer`](https://nodejs.org/api/http.html#http_http_createserver_options_requestlistener)
+ * or [`https.createServer`](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener).
  */
-export declare type RequestListener = (request: http.IncomingMessage, response: http.ServerResponse) => void;
+export type RequestListener = (request: http.IncomingMessage, response: http.ServerResponse) => void;
 /**
- * @desc
- *  A {@link net~Server} with an added shutdown method.
+ * A {@apilink net.Server} with an added shutdown method.
  *
  * @see https://www.npmjs.com/package/http-shutdown
- *
- * @public
- *
- * @typedef {net~Server & { shutdown: (callback: (error?: Error) => void) => void }} ServerWithShutdown
  */
-export declare type ServerWithShutdown = net.Server & {
+export type ServerWithShutdown = net.Server & {
     shutdown: (callback: (error?: Error) => void) => void;
     forceShutdown: (callback: (error?: Error) => void) => void;
 };
 /**
- * @desc
- *  The protocol supported by the instance of the {@link ServerWithShutdown},
- *  wrapped by the {@link ManageALocalServer} {@link @serenity-js/core/lib/screenplay~Ability}.
- *
- * @see {@link ManageALocalServer#mapInstance}
- *
- * @public
+ * The protocol supported by the instance of the {@apilink ServerWithShutdown},
+ * wrapped by the {@apilink Ability|ability} to {@apilink ManageALocalServer}.
  *
- * @typedef {Object} SupportedProtocols
- * @property {string} HTTP
- * @property {string} HTTPS
+ * @group Models
  */
 export declare enum SupportedProtocols {
     HTTP = "http",
     HTTPS = "https"
 }
+//# sourceMappingURL=ManageALocalServer.d.ts.map

package/lib/screenplay/abilities/ManageALocalServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManageALocalServer.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/ManageALocalServer.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,OAAO,EAAsB,MAAM,mBAAmB,CAAC;AAChE,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAG3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,kBAAmB,SAAQ,OAAO;IA2C/B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAzCrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAE5C;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,eAAe,GAAG,GAAG,CAAC,MAAM,GAAG,kBAAkB;IAQvF;;;;;;;;OAQG;IACH,MAAM,CAAC,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,GAAE,KAAK,CAAC,aAAkB,GAAG,kBAAkB;IAQ7H;;;;;;;;OAQG;gBAC0B,QAAQ,EAAE,kBAAkB,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM;IAK7E;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,SAAO,EAAE,WAAW,SAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBhE;;;;OAIG;IACH,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,kBAAkB,KAAK,CAAC,GAAG,CAAC;CAG1F;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC;AAErG;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,MAAM,GAAG;IAC1C,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,KAAK,IAAI,CAAC;IACtD,aAAa,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,KAAK,IAAI,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,kBAAkB;IAC1B,IAAI,SAAS;IACb,KAAK,UAAU;CAClB"}

package/lib/screenplay/abilities/ManageALocalServer.js

@@ -1,66 +1,79 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SupportedProtocols = exports.ManageALocalServer = void 0;
 const core_1 = require("@serenity-js/core");
-const http = require("http");
+const http = __importStar(require("http"));
 const withShutdownSupport = require("http-shutdown");
-const https = require("https");
+const https = __importStar(require("https"));
 const portfinder_1 = require("portfinder");
 /**
- * @desc
- *  An {@link @serenity-js/core/lib/screenplay~Ability} that enables the {@link @serenity-js/core/lib/screenplay/actor~Actor}
- *  to manage a local [Node.js](https://nodejs.org/) server.
+ * An {@apilink Ability} that enables an {@apilink Actor}
+ * to manage a local [Node.js](https://nodejs.org/) server.
+ *
+ * ## Managing a raw Node.js server
  *
- * @example <caption>Using a raw Node.js server</caption>
- * import { Actor } from '@serenity-js/core';
- * import { CallAnApi, GetRequest, Send } from '@serenity-js/rest';
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, Send } from '@serenity-js/rest'
  * import { ManageALocalServer, LocalTestServer, StartLocalTestServer, StopLocalTestServer } from '@serenity-js/local-server'
- * import { Ensure, equals } from '@serenity-js/assertions';
+ * import { Ensure, equals } from '@serenity-js/assertions'
  *
- * import axios from 'axios';
- * import * as http from 'http';
+ * import * as axios from 'axios'
+ * import * as http from 'http'
  *
  * const server = http.createServer(function (request, response) {
- *     response.setHeader('Connection', 'close');
- *     response.end('Hello!');
+ *   response.setHeader('Connection', 'close');
+ *   response.end('Hello!');
  * })
  *
- * const actor = Actor.named('Apisit').whoCan(
+ * await actorCalled('Apisit')
+ *   .whoCan(
  *     ManageALocalServer.using(server),
  *     CallAnApi.using(axios.create()),
- * );
- *
- * actor.attemptsTo(
+ *   )
+ *   .attemptsTo(
  *     StartLocalTestServer.onRandomPort(),
  *     Send.a(GetRequest.to(LocalServer.url())),
  *     Ensure.that(LastResponse.status(), equals(200)),
  *     Ensure.that(LastResponse.body<string>(), equals('Hello!')),
  *     StopLocalTestServer.ifRunning(),
- * );
+ *   )
+ * ```
  *
- * @see https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/
- * @see https://nodejs.org/api/http.html#http_class_http_server
+ * ## Learn more
+ * - [Anatomy of an HTTP transaction](https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/)
+ * - [Node.js HTTP server](https://nodejs.org/api/http.html#http_class_http_server)
  *
- * @implements {@link @serenity-js/core/lib/screenplay~Ability}
+ * @group Abilities
  */
-class ManageALocalServer {
-    /**
-     * @param {string} protocol - Protocol to be used when communicating with the running server; `http` or `https`
-     *
-     * @param {net~Server} server - A Node.js server requestListener, with support for [server shutdown](https://www.npmjs.com/package/http-shutdown).
-     *
-     * @see https://www.npmjs.com/package/http-shutdown
-     */
-    constructor(protocol, server) {
-        this.protocol = protocol;
-        this.server = withShutdownSupport(server);
-    }
+class ManageALocalServer extends core_1.Ability {
     /**
-     * @desc
-     *  {@link @serenity-js/core/lib/screenplay~Ability} to manage a Node.js HTTP server using the provided `requestListener`.
+     * An {@apilink Ability} to manage a Node.js HTTP server using the provided `requestListener`.
      *
-     * @param {RequestListener | net~Server} listener
-     * @returns {ManageALocalServer}
+     * @param listener
      */
     static runningAHttpListener(listener) {
         const server = typeof listener === 'function'
@@ -69,12 +82,11 @@ class ManageALocalServer {
         return new ManageALocalServer(SupportedProtocols.HTTP, server);
     }
     /**
-     * @desc
-     *  {@link @serenity-js/core/lib/screenplay~Ability} to manage a Node.js HTTPS server using the provided server `requestListener`.
+     * An {@apilink Ability} to manage a Node.js HTTPS server using the provided server `requestListener`.
      *
-     * @param {RequestListener | https~Server} listener
-     * @param {https~ServerOptions} options - Accepts options from `tls.createServer()`, `tls.createSecureContext()` and `http.createServer()`.
-     * @returns {ManageALocalServer}
+     * @param listener
+     * @param options
+     *  Accepts an options object from `tls.createServer()`, `tls.createSecureContext()` and `http.createServer()`.
      *
      * @see https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
      */
@@ -85,28 +97,27 @@ class ManageALocalServer {
         return new ManageALocalServer(SupportedProtocols.HTTPS, server);
     }
     /**
-     * @desc
-     *  Used to access the {@link @serenity-js/core/lib/screenplay/actor~Actor}'s {@link @serenity-js/core/lib/screenplay~Ability}  to {@link ManageALocalServer}
-     *  from within the {@link @serenity-js/core/lib/screenplay~Interaction} classes,
-     *  such as {@link StartLocalServer}.
+     * @param protocol
+     *  Protocol to be used when communicating with the running server; `http` or `https`
+     *
+     * @param server
+     *  A Node.js server requestListener, with support for [server shutdown](https://www.npmjs.com/package/http-shutdown).
      *
-     * @param {@serenity-js/core/lib/screenplay~UsesAbilities} actor
-     * @return {ManageALocalServer}
+     * @see https://www.npmjs.com/package/http-shutdown
      */
-    static as(actor) {
-        return actor.abilityTo(ManageALocalServer);
+    constructor(protocol, server) {
+        super();
+        this.protocol = protocol;
+        this.server = withShutdownSupport(server);
     }
     /**
-     * @desc
-     *  Starts the server on the first free port between `preferredPort` and `highestPort`, inclusive.
+     * Starts the server on the first free port between `preferredPort` and `highestPort`, inclusive.
      *
-     * @param {number} [preferredPort=8000]
+     * @param [preferredPort=8000]
      *  Lower bound of the preferred port range
      *
-     * @param {number} [highestPort=65535] highestPort
+     * @param [highestPort=65535] highestPort
      *  Upper bound of the preferred port range
-     *
-     * @returns {Promise<void>}
      */
     listen(preferredPort = 8000, highestPort = 65535) {
         return (0, portfinder_1.getPortPromise)({ port: preferredPort, stopPort: highestPort })
@@ -125,11 +136,9 @@ class ManageALocalServer {
         }));
     }
     /**
-     * @desc
-     *  Provides access to the server requestListener
+     * Provides access to the server `requestListener`
      *
      * @param {function(server: ServerWithShutdown, protocol?: SupportedProtocols): T} fn
-     * @returns {T}
      */
     mapInstance(fn) {
         return fn(this.server, this.protocol);
@@ -137,17 +146,10 @@ class ManageALocalServer {
 }
 exports.ManageALocalServer = ManageALocalServer;
 /**
- * @desc
- *  The protocol supported by the instance of the {@link ServerWithShutdown},
- *  wrapped by the {@link ManageALocalServer} {@link @serenity-js/core/lib/screenplay~Ability}.
- *
- * @see {@link ManageALocalServer#mapInstance}
- *
- * @public
+ * The protocol supported by the instance of the {@apilink ServerWithShutdown},
+ * wrapped by the {@apilink Ability|ability} to {@apilink ManageALocalServer}.
  *
- * @typedef {Object} SupportedProtocols
- * @property {string} HTTP
- * @property {string} HTTPS
+ * @group Models
  */
 var SupportedProtocols;
 (function (SupportedProtocols) {

package/lib/screenplay/abilities/ManageALocalServer.js.map

@@ -1 +1 @@
-{"version":3,"file":"ManageALocalServer.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/ManageALocalServer.ts"],"names":[],"mappings":";;;AAAA,4CAA+E;AAC/E,6BAA6B;AAC7B,qDAAsD;AACtD,+BAA+B;AAE/B,2CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAa,kBAAkB;IAkD3B;;;;;;OAMG;IACH,YAA6B,QAA4B,EAAE,MAAkB;QAAhD,aAAQ,GAAR,QAAQ,CAAoB;QACrD,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAvDD;;;;;;OAMG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAsC;QAC9D,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,UAAU;YACzC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;YAC7B,CAAC,CAAC,QAAQ,CAAC;QAEf,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,qBAAqB,CAAC,QAAwC,EAAE,UAA+B,EAAE;QACpG,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,UAAU;YACzC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;YACvC,CAAC,CAAC,QAAQ,CAAC;QAEf,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,KAAoB;QAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC/C,CAAC;IAaD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,aAAa,GAAG,IAAI,EAAE,WAAW,GAAG,KAAK;QAC5C,OAAO,IAAA,2BAAc,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;aAChE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAChD,SAAS,YAAY,CAAC,KAA6B;gBAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;oBAC7B,OAAO,MAAM,CAAC,IAAI,yBAAkB,CAAC,qEAAsE,IAAK,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;iBAChI;gBAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAExC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE;gBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;gBAElD,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAI,EAAoE;QAC/E,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACJ;AAxGD,gDAwGC;AA8BD;;;;;;;;;;;;GAYG;AACH,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B"}
+{"version":3,"file":"ManageALocalServer.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/ManageALocalServer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAgE;AAChE,2CAA6B;AAC7B,qDAAsD;AACtD,6CAA+B;AAE/B,2CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,kBAAmB,SAAQ,cAAO;IAI3C;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAsC;QAC9D,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,UAAU;YACzC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;YAC7B,CAAC,CAAC,QAAQ,CAAC;QAEf,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,qBAAqB,CAAC,QAAwC,EAAE,UAA+B,EAAE;QACpG,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,UAAU;YACzC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;YACvC,CAAC,CAAC,QAAQ,CAAC;QAEf,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,YAA6B,QAA4B,EAAE,MAAkB;QACzE,KAAK,EAAE,CAAC;QADiB,aAAQ,GAAR,QAAQ,CAAoB;QAErD,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,GAAG,IAAI,EAAE,WAAW,GAAG,KAAK;QAC5C,OAAO,IAAA,2BAAc,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;aAChE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAChD,SAAS,YAAY,CAAC,KAA6B;gBAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;oBAC7B,OAAO,MAAM,CAAC,IAAI,yBAAkB,CAAC,qEAAsE,IAAK,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;iBAChI;gBAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAExC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE;gBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;gBAElD,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAI,EAAoE;QAC/E,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACJ;AAtFD,gDAsFC;AAmBD;;;;;GAKG;AACH,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B"}

package/lib/screenplay/abilities/index.d.ts

@@ -1 +1,2 @@
 export * from './ManageALocalServer';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/abilities/index.d.ts.map

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

package/lib/screenplay/abilities/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/screenplay/abilities/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC"}

package/lib/screenplay/index.d.ts

@@ -1,3 +1,4 @@
 export * from './abilities';
 export * from './interactions';
 export * from './questions';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/lib/screenplay/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/screenplay/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,8CAA4B"}

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

@@ -1,67 +1,31 @@
 import { Answerable, Interaction } from '@serenity-js/core';
 /**
- * @desc
- *  Starts local server so that a test can interact with it.
+ * Starts local server so that a test can interact with it.
+ *
+ * @group Activities
  */
 export declare class StartLocalServer {
     /**
-     * @desc
-     *  Starts local test server on a random available ports.
-     *
-     * @see {@link LocalServer.url}
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * Starts local test server on a random available ports.
      */
     static onRandomPort(): Interaction;
     /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to start a local test server on one of the preferred ports.
-     *
-     *  Please note: this method is kept for backwards compatibility. However, its behaviour has changed
-     *  and is currently identical to calling `StartLocalServer.onPort` with the first of `preferredPorts`
-     *  passed as an argument.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<number[]>} preferredPorts
-     *  A list of preferred ports. Please note that only the first one will be used!
+     * Instructs the {@apilink Actor} to start a local test server on a `preferredPort`,
+     * or a random one if that's not available.
      *
-     * @see {@link LocalServer.url}
-     * @see {@link StartLocalServer.onPort}
-     * @see {@link StartLocalServer.onRandomPortBetween}
-     *
-     * @deprecated Use `StartLocalServer.onPort` or `StartLocalServer.onRandomPortBetween`
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static onOneOfThePreferredPorts(preferredPorts: Answerable<number[]>): Interaction;
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to start a local test server on a `preferredPort`, or a random one if that's not available.
-     *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<number>} preferredPort
-     *  preferred port
-     *
-     * @see {@link LocalServer.url}
-     * @see {@link @serenity-js/core/lib/screenplay~Answerable}
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * @param preferredPort
      */
     static onPort(preferredPort: Answerable<number>): Interaction;
     /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to start a local test server on a random port between `lowestPort` and `highestPort`.
+     * Instructs the {@apilink Actor} to start a local test server on a random port
+     * between `lowestPort` and `highestPort`, inclusive.
      *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<number>} lowestPort
+     * @param {Answerable<number>} lowestPort
      *  Lower bound of the preferred port range
      *
-     * @param {@serenity-js/core/lib/screenplay~Answerable<number>} highestPort
+     * @param {Answerable<number>} highestPort
      *  Upper bound of the preferred port range
-     *
-     * @see {@link LocalServer.url}
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
      */
     static onRandomPortBetween(lowestPort: Answerable<number>, highestPort: Answerable<number>): Interaction;
 }
+//# sourceMappingURL=StartLocalServer.d.ts.map

package/lib/screenplay/interactions/StartLocalServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StartLocalServer.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/StartLocalServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAuC,WAAW,EAAiB,MAAM,mBAAmB,CAAC;AAIhH;;;;GAIG;AACH,qBAAa,gBAAgB;IAEzB;;OAEG;IACH,MAAM,CAAC,YAAY,IAAI,WAAW;IAIlC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAI7D;;;;;;;;;OASG;IACH,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;CAG3G"}