@serenity-js/serenity-bdd 3.14.1 → 3.15.0

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.15.0](https://github.com/serenity-js/serenity-js/compare/v3.14.2...v3.15.0) (2024-01-12)
+
+
+### Bug Fixes
+
+* **serenity-bdd:** upgraded Serenity BDD CLI to 4.0.43 ([e1d22e9](https://github.com/serenity-js/serenity-js/commit/e1d22e92e120c7b6205ffe63dc22ebba5844e7ba)), closes [#1147](https://github.com/serenity-js/serenity-js/issues/1147)
+
+
+### Features
+
+* **serenity-bdd:** auto-detect requirements hierarchy root directory ([e2011b0](https://github.com/serenity-js/serenity-js/commit/e2011b0b95565d67e8ee785f3e197f827703a934)), closes [#1147](https://github.com/serenity-js/serenity-js/issues/1147)
+* **serenity-bdd:** support for Serenity BDD 4 ([c15c366](https://github.com/serenity-js/serenity-js/commit/c15c3660f957c21c367f8f27218a05d3fbca78de)), closes [#1147](https://github.com/serenity-js/serenity-js/issues/1147)
+* **serenity-bdd:** support for Serenity BDD 4 ([0760417](https://github.com/serenity-js/serenity-js/commit/0760417e2fa3e9fbfc78cd9965052531625bf45e))
+* **serenity-bdd:** support for Serenity BDD CLI v4.0.40 ([271068e](https://github.com/serenity-js/serenity-js/commit/271068e7ff64659138c5662cd3b8ae93bc7a7438)), closes [#1147](https://github.com/serenity-js/serenity-js/issues/1147)
+* **serenity-bdd:** support for Serenity BDD v4 CLI ([6988248](https://github.com/serenity-js/serenity-js/commit/69882485ce28bb18e502b3f49740a4f82aedaa1d)), closes [#1147](https://github.com/serenity-js/serenity-js/issues/1147) [#2042](https://github.com/serenity-js/serenity-js/issues/2042)
+
+
+
+
+
+## [3.14.2](https://github.com/serenity-js/serenity-js/compare/v3.14.1...v3.14.2) (2023-12-12)
+
+**Note:** Version bump only for package @serenity-js/serenity-bdd
+
+
+
+
+
 ## [3.14.1](https://github.com/serenity-js/serenity-js/compare/v3.14.0...v3.14.1) (2023-12-10)
 
 

package/README.md

@@ -12,7 +12,7 @@ of complex software systems faster, more collaborative and easier to scale.
 - [Serenity/JS web testing tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario)
 - [Serenity/JS Handbook](https://serenity-js.org/handbook) and [Getting Started guides](https://serenity-js.org/handbook/getting-started/)
 - [API documentation](https://serenity-js.org/api/core)
-- [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates)
+- [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/getting-started/project-templates/)
 
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
@@ -24,307 +24,9 @@ of complex software systems faster, more collaborative and easier to scale.
 
 [`@serenity-js/serenity-bdd`](https://serenity-js.org/api/serenity-bdd/) module integrates Serenity/JS and the Serenity BDD reporting CLI.
 
-This integration enables your Serenity/JS tests to produce interim JSON reports, which the Serenity BDD reporting CLI
-can then turn into world-class, illustrated test reports and living documentation. Learn more about [Serenity/JS reporting](https://serenity-js.org/handbook/reporting/index.html).
-
-### Installation
-
-To install this module, run the following command in your computer terminal:
-
-```sh
-npm install --save-dev @serenity-js/core @serenity-js/serenity-bdd
-```
-
-To learn more about Serenity/JS and how to use it on your project, follow the [Serenity/JS Getting Started guide](https://serenity-js.org/handbook/getting-started/).
-
-### SerenityBDDReporter
-
-To allow Serenity/JS to produce Serenity BDD-standard JSON reports, assign the `SerenityBDDReporter` to the `Stage`
-and configure the `ArtifactArchiver` to store the reports at the location where Serenity BDD expects to find them.
-
-This can be done:
-- via `playwright.config.ts`, if you're using Serenity/JS with [Playwright Test](https://serenity-js.org/api/playwright-test)
-- via `wdio.conf.ts`, if you're using Serenity/JS with [WebdriverIO](https://serenity-js.org/api/playwright-test)
-- via `protractor.conf.js`, if you're using Serenity/JS with [Protractor](https://serenity-js.org/api/protractor)
-- or programmatically.
-
-#### Usage with Playwright Test
-
-Learn more about using [Serenity/JS with Playwright Test](https://serenity-js.org/api/playwright-test).
-
-```typescript
-// playwright.config.ts
-import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
-
-const config: PlaywrightTestConfig = {
-    reporter: [
-        [ '@serenity-js/playwright-test', {
-            crew: [
-                '@serenity-js/serenity-bdd',
-                [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
-            ]
-        }]
-    ],
-
-    // Other configuration omitted for brevity
-    // For details, see https://playwright.dev/docs/test-configuration    
-}
-
-export default config
-```
-
-#### Usage with WebdriverIO
-
-Learn more about using [Serenity/JS with WebdriverIO](https://serenity-js.org/api/webdriverio).
-
-```typescript
-// wdio.conf.ts
-
-import { WebdriverIOConfig } from '@serenity-js/webdriverio'
-
-export const config: WebdriverIOConfig = {
-
-    framework: '@serenity-js/webdriverio',
-
-    serenity: {
-        crew: [
-            '@serenity-js/serenity-bdd',
-            [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
-        ]
-    },
-
-    // Other configuration omitted for brevity
-    // For details, see https://webdriver.io/docs/options
-}
-```
-
-#### Usage with Protractor
-
-Learn more about using [Serenity/JS with Protractor](https://serenity-js.org/api/protractor).
-
-```javascript
-// protractor.conf.js
-
-exports.config = {
-
-    framework:      'custom',
-    frameworkPath:  require.resolve('@serenity-js/protractor/adapter'),
-
-    serenity: {
-        crew: [
-            '@serenity-js/serenity-bdd',
-            [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
-        ]
-    },
-
-    // ...
-}
-```
-
-#### Programmatic configuration
-
-Learn more about [configuring Serenity/JS programmatically](https://serenity-js.org/api/core/class/SerenityConfig).
-
-```typescript
-import { ArtifactArchiver, configure } from '@serenity-js/core'
-import { SerenityBDDReporter } from '@serenity-js/serenity-bdd'
-
-configure({
-    crew: [
-        ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
-        new SerenityBDDReporter()
-    ],
-})
-```
-
-### Serenity BDD Living Documentation
-
-To turn the Serenity BDD-standard JSON reports produced by the `SerenityBDDReporter` into Serenity BDD test reports,
-you need the [Serenity BDD reporting CLI](https://github.com/serenity-bdd/serenity-cli).
-
-The Serenity BDD reporting CLI is a Java program, distributed as an executable `.jar` file and [available on Bintray](https://bintray.com/serenity/maven/serenity-cli).
-
-This module ships with a `serenity-bdd` CLI wrapper that makes downloading and running the Serenity BDD reporting CLI easy.
-
-To learn more about the usage of the `serenity-bdd` wrapper, run:
-
-```console
-npx serenity-bdd --help
-```
-
-#### Configuring Serenity BDD reporting CLI
-
-To configure the [Serenity BDD reporting CLI](https://github.com/serenity-bdd/serenity-cli), place a file called `serenity.properties`
-in your project root directory. 
-
-For example:
-
-```
-# serenity.properties
-serenity.project.name=My awesome project
-```
-
-Please note that the reporting CLI considers only those properties that are related to producing test reports.
-Learn more about configuring [`serenity.properties`](https://serenity-bdd.github.io/docs/reference/serenity-properties).
-
-#### Downloading the Serenity BDD reporting CLI
-
-To download the Serenity BDD reporting CLI or to update it, use the update command:
-
-```console
-npx serenity-bdd update
-```
-
-You can also tell it to download the Serenity BDD reporting CLI jar from your company's artifact repository if you can't use the official Bintray one:
-
-```
-npx serenity-bdd update --repository https://artifactory.example.org/
-```
-
-To learn more about the `update` command, run:
-
-```
-npx serenity-bdd --help update
-```
-
-Please note that the `update` command will try to download the `.jar` only if you don't have it cached already, or when the one you have is not up to date. Otherwise, no outbound network calls are made.
-
-##### Downloading through a proxy
-
-The `update` command will pick up your proxy configuration automatically from your [NPM config](https://docs.npmjs.com/cli/v6/commands/npm-config), [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc), or environment variables. 
-
-Please note that you only need to use one of those configuration mechanisms.
-
-###### Use NPM config (Linux, macOS, Windows)
-
-To use NPM-level configuration, run the following commands in your terminal:
-
-```console
-npm config set proxy http://[user:pwd]@domain.tld:port
-npm config set https-proxy http://[user:pwd]@domain.tld:port
-```
-
-If your proxy requires a certificate file, you can provide a path to it as follows:
-
-```console
-npm config set cafile /path/to/root-ca.pem
-```
-
-The above can also be accomplished by placing an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) with following contents in your home directory or your project root:
-
-```bash
-# ~/.npmrc
-proxy = http://[user:pwd]@domain.tld:port
-https-proxy = http://[user:pwd]@domain.tld:port
-
-cafile = /path/to/root-ca.pem          # optional
-noproxy = localhost,mycompany.com      # optional
-```
-
-###### Environment variables on Linux or macOS
-
-To set your proxy on Linux or macOS, run the following commands in your terminal:
-
-```console
-export HTTP_PROXY=http://[user:pwd]@domain.tld:port
-export HTTPS_PROXY=http://[user:pwd]@domain.tld:port
-```
-
-If needed, you can also set a `NO_PROXY` variable to a comma-separated list of domains that don't require a proxy, for example:
-
-```console
-export NO_PROXY=localhost,mycompany.com
-```
-
-Please note that you can add the above commands to your shell's `~/.profile`, so that they're executed whenever you open a new terminal.
-
-###### Environment variables on Windows
-
-To configure a proxy on Windows, run the following commands in Command Prompt:
-
-```console
-set HTTP_PROXY=http://[user:pwd]@domain.tld:port
-set HTTPS_PROXY=http://[user:pwd]@domain.tld:port
-```
-
-If you're using Powershell, run the following commands instead:
-
-```console
-$env:HTTP_PROXY = http://[user:pwd]@domain.tld:port
-$env:HTTPS_PROXY = http://[user:pwd]@domain.tld:port
-```
-
-##### Use a specific User-Agent
-
-If your artifact registry requires you to use a specific user agent, you can configure it using NPM config:
-
-```console
-npm config set user-agent "Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0"
-``` 
-
-##### Ignore SSL checks
-
-You can instruct the `update` command to ignore any SSL certificate errors by providing an `--ignoreSSL` flag when running the command:  
-
-```console
-npx serenity-bdd update --ignoreSSL
-```
-
-You can also disable certificate checks at the NPM config level by running: 
-
-```console
-npm config set strict-ssl false
-```
-
-Alternative, you can accomplish the same with an `.npmrc` file:
-
-```bash
-# ~/.npmrc
-npm_config_strict-ssl = false
-```
-
-#### Producing the Serenity BDD test report
-
-To produce the Serenity BDD test report and living documentation using default settings, run:
-
-```
-npx serenity-bdd run
-```
-
-To learn more about the `run` command and how to change the default settings, run:
-
-```
-npx serenity-bdd --help run
-```
-
-### Using NPM scripts
-
-[Serenity BDD reports](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter) are generated by [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-core/tree/main/serenity-cli),
-a Java program downloaded and managed by the [`@serenity-js/serenity-bdd`](https://serenity-js.org/api/serenity-bdd) module.
-
-In general, to produce Serenity BDD reports, your test suite must:
-- download the Serenity BDD CLI, by calling `serenity-bdd update`
-- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](https://serenity-js.org/api/serenity-bdd/class/SerenityBDDReporter)
-- invoke the Serenity BDD CLI when you want to produce the report, by calling `serenity-bdd run`
-
-The pattern used by all the [Serenity/JS Project Templates](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates) relies
-on using:
-- an NPM [`postinstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts#life-cycle-operation-order) script to download the Serenity BDD CLI
-- [`npm-failsafe`](https://www.npmjs.com/package/npm-failsafe) to run the reporting process even if the test suite itself has failed (which is precisely when you need test reports the most...).
-- [`rimraf`](https://www.npmjs.com/package/rimraf) as a convenience method to remove any test reports left over from the previous run
-
-```json title="package.json"
-{
-  "scripts": {
-    "postinstall": "serenity-bdd update",
-    "clean": "rimraf target",
-    "test": "failsafe clean test:execute test:report",
-    "test:execute": "cucumber-js",
-    "test:report": "serenity-bdd run --features ./features ",
-  }
-}
-```
-Note that in the above code sample, you should configure `test:execute` to invoke [your test runner of choice](https://serenity-js.org/handbook/test-runners/).
+Learn more about [Serenity/JS reporting with Serenity BDD](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter/):
+- [Installation, configuration and usage](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter/#installation-and-usage)
+- [Best practices](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter/#serenity-bdd-best-practices)
 
 ## 📣 Stay up to date
 

package/lib/cli/commands/run.d.ts

@@ -1,3 +1,4 @@
+import { Path } from '@serenity-js/core/lib/io';
 import type { Argv } from '../Argv';
 declare const _default: {
     command: string;
@@ -12,7 +13,7 @@ declare const _default: {
             describe: string;
         };
         features: {
-            default: string;
+            default: Path;
             describe: string;
         };
         artifact: {

package/lib/cli/commands/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/run.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBA0DV,IAAI,KAAG,QAAQ,IAAI,CAAC;;AAhD9C,kBAmFE"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/run.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAI5D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBA4DV,IAAI,KAAG,QAAQ,IAAI,CAAC;;AAhD9C,kBAmFE"}

package/lib/cli/commands/run.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 const core_1 = require("@serenity-js/core");
 const io_1 = require("@serenity-js/core/lib/io");
 const path = __importStar(require("path")); // eslint-disable-line unicorn/import-style
+const SpecDirectory_1 = require("../../stage/crew/serenity-bdd-reporter/SpecDirectory");
 const defaults_1 = require("../defaults");
 const io_2 = require("../io");
 const model_1 = require("../model");
@@ -32,6 +33,7 @@ const Printer_1 = require("../Printer");
 const screenplay_1 = require("../screenplay");
 const stage_1 = require("../stage");
 const yargs = require('yargs'); // eslint-disable-line @typescript-eslint/no-var-requires
+const cwd = new io_1.Path(process.cwd());
 module.exports = {
     command: 'run',
     desc: 'Invokes the Serenity BDD CLI jar to produce a Serenity BDD HTML report from the Serenity/JS JSON reports',
@@ -45,8 +47,8 @@ module.exports = {
             describe: 'A relative path to the directory where the Serenity BDD report should be produced',
         },
         features: {
-            default: defaults_1.defaults.featuresDir,
-            describe: 'A relative path to the directory containing the Cucumber.js feature files',
+            default: cwd.relative(new SpecDirectory_1.SpecDirectory(new io_1.FileSystem(cwd)).guessLocation()),
+            describe: 'A relative path to the requirements hierarchy root directory, such as "./features" or "./spec"',
         },
         artifact: {
             default: defaults_1.defaults.artifact,
@@ -66,7 +68,7 @@ module.exports = {
             describe: `Base URL of your JIRA server`,
         },
         project: {
-            default: path.basename(process.cwd()),
+            default: cwd.basename(),
             describe: `Project name to appear in the Serenity reports`,
         },
         shortFilenames: {
@@ -83,7 +85,7 @@ module.exports = {
     handler: async (argv) => {
         const printer = new Printer_1.Printer(process.stdout, process.stderr), artifactGAV = model_1.GAV.fromString(argv.artifact), pathToArtifact = new io_1.Path(argv.cacheDir).join(artifactGAV.toPath()), moduleRoot = path.resolve(__dirname, '../../../');
         (0, core_1.configure)({
-            actors: new stage_1.RunCommandActors(new io_1.Path(process.cwd())),
+            actors: new stage_1.RunCommandActors(cwd),
             crew: [
                 new stage_1.NotificationReporter(printer),
                 new stage_1.ProgressReporter(printer),

package/lib/cli/commands/run.js.map

@@ -1 +1 @@
-{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../src/cli/commands/run.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAA2D;AAC3D,iDAAgD;AAChD,2CAA6B,CAAG,2CAA2C;AAG3E,0CAAuC;AACvC,8BAAoC;AACpC,oCAA+B;AAC/B,wCAAqC;AACrC,8CAA0F;AAC1F,oCAAoF;AAEpF,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,yDAAyD;AAEzF,iBAAS;IACL,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,0GAA0G;IAChH,OAAO,EAAE;QACL,QAAQ,EAAE;YACN,OAAO,EAAI,mBAAQ,CAAC,QAAQ;YAC5B,QAAQ,EAAE,kEAAkE;SAC/E;QACD,WAAW,EAAE;YACT,OAAO,EAAI,mBAAQ,CAAC,SAAS;YAC7B,QAAQ,EAAE,mFAAmF;SAChG;QACD,QAAQ,EAAE;YACN,OAAO,EAAI,mBAAQ,CAAC,WAAW;YAC/B,QAAQ,EAAE,2EAA2E;SACxF;QACD,QAAQ,EAAE;YACN,OAAO,EAAI,mBAAQ,CAAC,QAAQ;YAC5B,QAAQ,EAAE,oIAAoI;SACjJ;QACD,MAAM,EAAE;YACJ,OAAO,EAAI,mBAAQ,CAAC,SAAS;YAC7B,QAAQ,EAAE,0EAA0E;SACvF;QACD,eAAe,EAAE;YACb,QAAQ,EAAE,6CAA6C;SAC1D;QACD,WAAW,EAAE;YACT,QAAQ,EAAE,yBAAyB;SACtC;QACD,OAAO,EAAE;YACL,QAAQ,EAAE,8BAA8B;SAC3C;QACD,OAAO,EAAE;YACL,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACrC,QAAQ,EAAE,gDAAgD;SAC7D;QACD,cAAc,EAAE;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,sEAAsE;SACnF;QACD,GAAG,EAAE;YACD,OAAO,EAAE,mBAAQ,CAAC,GAAG;YACrB,OAAO,EAAE,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAE;YACpC,QAAQ,EAAE,yDAAyD;SACtE;KACJ;IACD,OAAO,EAAE,KAAK,EAAE,IAAU,EAAiB,EAAE;QAEzC,MACI,OAAO,GAAG,IAAI,iBAAO,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EACrD,WAAW,GAAG,WAAG,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAC3C,cAAc,GAAG,IAAI,SAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EACnE,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAEtD,IAAA,gBAAS,EAAC;YACN,MAAM,EAAE,IAAI,wBAAgB,CAAC,IAAI,SAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACrD,IAAI,EAAE;gBACF,IAAI,4BAAoB,CAAC,OAAO,CAAC;gBACjC,IAAI,wBAAgB,CAAC,OAAO,CAAC;aAChC;SACJ,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,IAAA,kBAAW,EAAC,sBAAsB,CAAC,CAAC;QAElD,IAAI;YACA,MAAM,KAAK,CAAC,UAAU,CAClB,8BAAiB,CAAC,EAAE,CAAC,cAAc,CAAC;iBAC/B,cAAc,CAAC,6BAAgB,CAAC,EAAE,CAAC;gBAChC,6BAA6B,EAAE,GAAI,IAAI,CAAC,cAAe,EAAE;gBACzD,WAAW,EAAE,IAAI,CAAC,GAAG;gBACrB,2BAA2B,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,gCAAgC,CAAC;aAC1F,CAAC,CAAC;iBACF,aAAa,CAAC,iCAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CACtD,CAAC;YACF,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;SACzB;QACD,OAAO,KAAK,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,IAAA,gBAAW,EAAC,KAAK,CAAC,CAAC,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;SAChC;IACL,CAAC;CACJ,CAAC"}
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../src/cli/commands/run.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAA2D;AAC3D,iDAA4D;AAC5D,2CAA6B,CAAC,2CAA2C;AAEzE,wFAAqF;AAErF,0CAAuC;AACvC,8BAAoC;AACpC,oCAA+B;AAC/B,wCAAqC;AACrC,8CAA0F;AAC1F,oCAAoF;AAEpF,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,yDAAyD;AAEzF,MAAM,GAAG,GAAG,IAAI,SAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAEpC,iBAAS;IACL,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,0GAA0G;IAChH,OAAO,EAAE;QACL,QAAQ,EAAE;YACN,OAAO,EAAI,mBAAQ,CAAC,QAAQ;YAC5B,QAAQ,EAAE,kEAAkE;SAC/E;QACD,WAAW,EAAE;YACT,OAAO,EAAI,mBAAQ,CAAC,SAAS;YAC7B,QAAQ,EAAE,mFAAmF;SAChG;QACD,QAAQ,EAAE;YACN,OAAO,EAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,6BAAa,CAAC,IAAI,eAAU,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;YAC/E,QAAQ,EAAE,gGAAgG;SAC7G;QACD,QAAQ,EAAE;YACN,OAAO,EAAI,mBAAQ,CAAC,QAAQ;YAC5B,QAAQ,EAAE,oIAAoI;SACjJ;QACD,MAAM,EAAE;YACJ,OAAO,EAAI,mBAAQ,CAAC,SAAS;YAC7B,QAAQ,EAAE,0EAA0E;SACvF;QACD,eAAe,EAAE;YACb,QAAQ,EAAE,6CAA6C;SAC1D;QACD,WAAW,EAAE;YACT,QAAQ,EAAE,yBAAyB;SACtC;QACD,OAAO,EAAE;YACL,QAAQ,EAAE,8BAA8B;SAC3C;QACD,OAAO,EAAE;YACL,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE;YACvB,QAAQ,EAAE,gDAAgD;SAC7D;QACD,cAAc,EAAE;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,sEAAsE;SACnF;QACD,GAAG,EAAE;YACD,OAAO,EAAE,mBAAQ,CAAC,GAAG;YACrB,OAAO,EAAE,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAE;YACpC,QAAQ,EAAE,yDAAyD;SACtE;KACJ;IACD,OAAO,EAAE,KAAK,EAAE,IAAU,EAAiB,EAAE;QAEzC,MACI,OAAO,GAAG,IAAI,iBAAO,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EACrD,WAAW,GAAG,WAAG,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAC3C,cAAc,GAAG,IAAI,SAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EACnE,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAEtD,IAAA,gBAAS,EAAC;YACN,MAAM,EAAE,IAAI,wBAAgB,CAAC,GAAG,CAAC;YACjC,IAAI,EAAE;gBACF,IAAI,4BAAoB,CAAC,OAAO,CAAC;gBACjC,IAAI,wBAAgB,CAAC,OAAO,CAAC;aAChC;SACJ,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,IAAA,kBAAW,EAAC,sBAAsB,CAAC,CAAC;QAElD,IAAI;YACA,MAAM,KAAK,CAAC,UAAU,CAClB,8BAAiB,CAAC,EAAE,CAAC,cAAc,CAAC;iBAC/B,cAAc,CAAC,6BAAgB,CAAC,EAAE,CAAC;gBAChC,6BAA6B,EAAE,GAAI,IAAI,CAAC,cAAe,EAAE;gBACzD,WAAW,EAAE,IAAI,CAAC,GAAG;gBACrB,2BAA2B,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,gCAAgC,CAAC;aAC1F,CAAC,CAAC;iBACF,aAAa,CAAC,iCAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CACtD,CAAC;YACF,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;SACzB;QACD,OAAO,KAAK,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,IAAA,gBAAW,EAAC,KAAK,CAAC,CAAC,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;SAChC;IACL,CAAC;CACJ,CAAC"}

package/lib/cli/defaults.d.ts

@@ -1,7 +1,6 @@
 /**
- * @desc
- *  Default configuration to be used when invoking the serenity-bdd command line interface.
- *  See the source code to find out more about the values being used.
+ * Default configuration to be used when invoking the serenity-bdd command line interface.
+ * See the source code to find out more about the values being used.
  *
  * @typedef {Object} defaults
  * @property {string} artifact      The GAV identifier of the artifact to download from the artifact repository
@@ -20,7 +19,6 @@ export declare const defaults: {
     cacheDir: string;
     sourceDir: string;
     reportDir: string;
-    featuresDir: string;
     log: string;
 };
 //# sourceMappingURL=defaults.d.ts.map

package/lib/cli/defaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/cli/defaults.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ;;;;;;;;CAQpB,CAAC"}
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/cli/defaults.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ;;;;;;;CAOpB,CAAC"}

package/lib/cli/defaults.js

@@ -2,9 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 /**
- * @desc
- *  Default configuration to be used when invoking the serenity-bdd command line interface.
- *  See the source code to find out more about the values being used.
+ * Default configuration to be used when invoking the serenity-bdd command line interface.
+ * See the source code to find out more about the values being used.
  *
  * @typedef {Object} defaults
  * @property {string} artifact      The GAV identifier of the artifact to download from the artifact repository
@@ -18,12 +17,11 @@ exports.defaults = void 0;
  * @public
  */
 exports.defaults = {
-    artifact: 'net.serenity-bdd:serenity-cli:jar:3.1.0',
+    artifact: 'net.serenity-bdd:serenity-cli:jar:4.0.43',
     repository: 'https://repo1.maven.org/maven2/',
     cacheDir: 'node_modules/@serenity-js/serenity-bdd/cache',
     sourceDir: 'target/site/serenity',
     reportDir: 'target/site/serenity',
-    featuresDir: 'features',
     log: 'warn',
 };
 //# sourceMappingURL=defaults.js.map

package/lib/cli/defaults.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/cli/defaults.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACU,QAAA,QAAQ,GAAG;IACpB,QAAQ,EAAK,yCAAyC;IACtD,UAAU,EAAG,iCAAiC;IAC9C,QAAQ,EAAK,8CAA8C;IAC3D,SAAS,EAAI,sBAAsB;IACnC,SAAS,EAAI,sBAAsB;IACnC,WAAW,EAAE,UAAU;IACvB,GAAG,EAAU,MAAM;CACtB,CAAC"}
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/cli/defaults.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACU,QAAA,QAAQ,GAAG;IACpB,QAAQ,EAAK,0CAA0C;IACvD,UAAU,EAAG,iCAAiC;IAC9C,QAAQ,EAAK,8CAA8C;IAC3D,SAAS,EAAI,sBAAsB;IACnC,SAAS,EAAI,sBAAsB;IACnC,GAAG,EAAU,MAAM;CACtB,CAAC"}

package/lib/index.d.ts

@@ -1,4 +1,6 @@
-import type { StageCrewMember } from '@serenity-js/core';
+import type { StageCrewMemberBuilder } from '@serenity-js/core';
+import type { SerenityBDDReporterConfig } from './stage';
+import { SerenityBDDReporter } from './stage';
 export * from './stage';
-export default function create(): StageCrewMember;
+export default function create(config?: SerenityBDDReporterConfig): StageCrewMemberBuilder<SerenityBDDReporter>;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzD,cAAc,SAAS,CAAC;AAExB,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,eAAe,CAEhD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C,cAAc,SAAS,CAAC;AAExB,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,MAAM,GAAE,yBAA8B,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,CAElH"}

package/lib/index.js

@@ -16,8 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const stage_1 = require("./stage");
 __exportStar(require("./stage"), exports);
-function create() {
-    return new stage_1.SerenityBDDReporter();
+function create(config = {}) {
+    return stage_1.SerenityBDDReporter.fromJSON(config);
 }
 exports.default = create;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,mCAA8C;AAE9C,0CAAwB;AAExB,SAAwB,MAAM;IAC1B,OAAO,IAAI,2BAAmB,EAAE,CAAC;AACrC,CAAC;AAFD,yBAEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAGA,mCAA8C;AAE9C,0CAAwB;AAExB,SAAwB,MAAM,CAAC,SAAoC,EAAE;IACjE,OAAO,2BAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAFD,yBAEC"}

package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts

@@ -1,5 +1,7 @@
-import type { Stage, StageCrewMember } from '@serenity-js/core';
+import type { Stage, StageCrewMember, StageCrewMemberBuilder } from '@serenity-js/core';
 import type { DomainEvent } from '@serenity-js/core/lib/events';
+import { Path } from '@serenity-js/core/lib/io';
+import type { SerenityBDDReporterConfig } from './SerenityBDDReporterConfig';
 /**
  * A {@apilink StageCrewMember} that produces [Serenity BDD](http://serenity-bdd.info/)-standard JSON reports
  * to be parsed by [Serenity BDD CLI Reporter](https://github.com/serenity-bdd/serenity-cli)
@@ -13,8 +15,12 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
  *
  * configure({
  *   crew: [
- *     ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *     new SerenityBDDReporter()
+ *     ArtifactArchiver.fromJSON({
+ *       outputDirectory: './target/site/serenity'
+ *     }),
+ *     SerenityBDDReporter.fromJSON({
+ *       specDirectory: './features'            // optional configuration
+ *     })
  *   ],
  * })
  * ```
@@ -45,8 +51,6 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
  *
  * ```ts
  * // wdio.conf.ts
- * import { ArtifactArchiver } from '@serenity-js/core';
- * import { SerenityBDDReporter } from '@serenity-js/serenity-bdd';
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio';
  *
  * export const config: WebdriverIOConfig = {
@@ -68,10 +72,6 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
  *
  * ```js
  * // protractor.conf.js
- * const
- *   { ArtifactArchiver }    = require('@serenity-js/core'),
- *   { SerenityBDDReporter } = require('@serenity-js/serenity-bdd')
- *
  * exports.config = {
  *   framework:     'custom',
  *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
@@ -88,16 +88,40 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
  * }
  * ```
  *
+ * ## Configuring Serenity BDD Reporter
+ *
+ * To override Serenity BDD Reporter default configuration, provide a {@link SerenityBDDReporterConfig} as the second element of the {@link SerenityConfig.crew} array
+ * using your test runner-specific configuration mechanism.
+ *
+ * For example, to change the default location
+ * of the [requirements hierarchy root directory](https://serenity-bdd.github.io/docs/reporting/living_documentation#the-requirements-hierarchy),
+ * specify the `specDirectory` property:
+ *
+ * ```js
+ *     crew: [
+ *       [ '@serenity-js/serenity-bdd', { specDirectory: './features' } ],
+ *       // ...
+ *     ],
+ * ```
+ *
+ * ### Learn more:
+ * - [Serenity BDD Reporter integration documentation](/handbook/reporting/serenity-bdd-reporter/)
+ * - [Serenity/JS examples on GitHub](https://github.com/serenity-js/serenity-js/tree/main/examples)
+ *
  * @group Stage
  */
 export declare class SerenityBDDReporter implements StageCrewMember {
+    private readonly specDirectory;
     private stage?;
     private readonly eventQueues;
     private readonly processors;
+    static fromJSON(config: SerenityBDDReporterConfig): StageCrewMemberBuilder<SerenityBDDReporter>;
     /**
-     * @param [stage=undefined] stage
+     * @param {Path} specDirectory
+     * @param {Stage} [stage]
+     *  The stage this {@apilink StageCrewMember} should be assigned to
      */
-    constructor(stage?: Stage);
+    constructor(specDirectory: Path, stage?: Stage);
     /**
      * @inheritDoc
      */

package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerenityBDDReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,KAAK,EAAE,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAM/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO3C,OAAO,CAAC,KAAK,CAAC;IAN1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8B;IAEzD;;OAEG;gBACiB,KAAK,CAAC,EAAE,KAAK;IAGjC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA2ClC,OAAO,CAAC,eAAe;CAG1B"}
+{"version":3,"file":"SerenityBDDReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAsC,MAAM,mBAAmB,CAAC;AAE5H,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAGhE,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAKhD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAG7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2GG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAcnD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,KAAK,CAAC;IAdlB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuB;IAElD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,GAAG,sBAAsB,CAAC,mBAAmB,CAAC;IAI/F;;;;OAIG;gBAEkB,aAAa,EAAE,IAAI,EAC5B,KAAK,CAAC,EAAE,KAAK;IAKzB;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA2ClC,OAAO,CAAC,eAAe;CAG1B"}