@serenity-js/core 3.10.1 → 3.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +6 -3
  3. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts +22 -23
  4. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts.map +1 -1
  5. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js +22 -23
  6. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js.map +1 -1
  7. package/lib/stage/crew/stream-reporter/StreamReporter.d.ts +23 -24
  8. package/lib/stage/crew/stream-reporter/StreamReporter.d.ts.map +1 -1
  9. package/lib/stage/crew/stream-reporter/StreamReporter.js +23 -24
  10. package/lib/stage/crew/stream-reporter/StreamReporter.js.map +1 -1
  11. package/package.json +4 -4
  12. package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts +22 -23
  13. package/src/stage/crew/stream-reporter/StreamReporter.ts +23 -24
package/CHANGELOG.md CHANGED
@@ -3,6 +3,25 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.10.3](https://github.com/serenity-js/serenity-js/compare/v3.10.2...v3.10.3) (2023-09-15)
7
+
8
+ **Note:** Version bump only for package @serenity-js/core
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * **core:** updated installation instruction in the README ([ec3f277](https://github.com/serenity-js/serenity-js/commit/ec3f2778334abbd7324497ceaa2df9f0560a103e)), closes [#1915](https://github.com/serenity-js/serenity-js/issues/1915)
20
+
21
+
22
+
23
+
24
+
6
25
  ## [3.10.1](https://github.com/serenity-js/serenity-js/compare/v3.10.0...v3.10.1) (2023-09-01)
7
26
 
8
27
  **Note:** Version bump only for package @serenity-js/core
package/README.md CHANGED
@@ -9,9 +9,10 @@
9
9
  of complex software systems faster, more collaborative and easier to scale.
10
10
 
11
11
  ⭐️ Get started with Serenity/JS!
12
- - [Serenity/JS Handbook](https://serenity-js.org/handbook) and [tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario),
13
- - [API documentation](https://serenity-js.org/api/core),
14
- - [Serenity/JS project templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates).
12
+ - [Serenity/JS web testing tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario)
13
+ - [Serenity/JS Handbook](https://serenity-js.org/handbook) and [Getting Started guides](https://serenity-js.org/handbook/getting-started/)
14
+ - [API documentation](https://serenity-js.org/api/core)
15
+ - [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates)
15
16
 
16
17
  👋 Join the Serenity/JS Community!
17
18
  - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
@@ -33,6 +34,8 @@ To install this module, run the following command in your computer terminal:
33
34
  npm install --save-dev @serenity-js/core
34
35
  ```
35
36
 
37
+ 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/).
38
+
36
39
  ## 📣 Stay up to date
37
40
 
38
41
  New features, tutorials, and demos are coming soon!
package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts CHANGED
@@ -5,7 +5,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
5
5
  /**
6
6
  * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
7
7
  *
8
- * ## Registering `ArtifactArchiver` programmatically
8
+ * ## Registering Artifact Archiver programmatically
9
9
  *
10
10
  * ```ts
11
11
  * import { ArtifactArchiver, configure } from '@serenity-js/core'
@@ -18,7 +18,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
18
18
  * })
19
19
  * ```
20
20
  *
21
- * ## Using `ArtifactArchiver` with Playwright Test
21
+ * ## Using Artifact Archiver with Playwright Test
22
22
  *
23
23
  * ```ts
24
24
  * // playwright.config.ts
@@ -32,7 +32,6 @@ import type { StageCrewMember } from '../../StageCrewMember';
32
32
  * crew: [
33
33
  * '@serenity-js/serenity-bdd',
34
34
  * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
35
- * [ '@serenity-js/core:StreamReporter', { outputFile: 'target/events.ndjson' }]
36
35
  * ]
37
36
  * // other Serenity/JS config
38
37
  * }]
@@ -41,26 +40,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
41
40
  * }
42
41
  * ```
43
42
  *
44
- * ## Using `ArtifactArchiver` with Protractor
45
- *
46
- * ```js
47
- * // protractor.conf.js
48
- * exports.config = {
49
- * framework: 'custom',
50
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
51
- *
52
- * serenity: {
53
- * crew: [
54
- * '@serenity-js/serenity-bdd',
55
- * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
56
- * ],
57
- * // other Serenity/JS config
58
- * },
59
- * // other Protractor config
60
- * }
61
- * ```
62
- *
63
- * ## Using `ArtifactArchiver` with WebdriverIO
43
+ * ## Using Artifact Archiver with WebdriverIO
64
44
  *
65
45
  * ```ts
66
46
  * // wdio.conf.ts
@@ -81,6 +61,25 @@ import type { StageCrewMember } from '../../StageCrewMember';
81
61
  * }
82
62
  * ```
83
63
  *
64
+ * ## Using Artifact Archiver with Protractor
65
+ *
66
+ * ```js
67
+ * // protractor.conf.js
68
+ * exports.config = {
69
+ * framework: 'custom',
70
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
71
+ *
72
+ * serenity: {
73
+ * crew: [
74
+ * '@serenity-js/serenity-bdd',
75
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
76
+ * ],
77
+ * // other Serenity/JS config
78
+ * },
79
+ * // other Protractor config
80
+ * }
81
+ * ```
82
+ *
84
83
  * @group Stage
85
84
  */
86
85
  export declare class ArtifactArchiver implements StageCrewMember {
package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ArtifactArchiver.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACR,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,UAAU,EAAQ,MAAM,aAAa,CAAC;AAG/C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,qBAAa,gBAAiB,YAAW,eAAe;IAkChD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,KAAK,CAAC;IAjClB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,eAAe;IAQpE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAMrE;;;;OAIG;gBAEkB,UAAU,EAAE,UAAU,EAC/B,KAAK,CAAC,EAAE,KAAK;IAIzB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA8BlC,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,OAAO;IAwBf,OAAO,CAAC,yBAAyB;CAwBpC"}
1
+ {"version":3,"file":"ArtifactArchiver.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACR,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,UAAU,EAAQ,MAAM,aAAa,CAAC;AAG/C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,qBAAa,gBAAiB,YAAW,eAAe;IAkChD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,KAAK,CAAC;IAjClB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,eAAe;IAQpE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAMrE;;;;OAIG;gBAEkB,UAAU,EAAE,UAAU,EAC/B,KAAK,CAAC,EAAE,KAAK;IAIzB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA8BlC,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,OAAO;IAwBf,OAAO,CAAC,yBAAyB;CAwBpC"}
package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js CHANGED
@@ -9,7 +9,7 @@ const Hash_1 = require("./Hash");
9
9
  /**
10
10
  * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
11
11
  *
12
- * ## Registering `ArtifactArchiver` programmatically
12
+ * ## Registering Artifact Archiver programmatically
13
13
  *
14
14
  * ```ts
15
15
  * import { ArtifactArchiver, configure } from '@serenity-js/core'
@@ -22,7 +22,7 @@ const Hash_1 = require("./Hash");
22
22
  * })
23
23
  * ```
24
24
  *
25
- * ## Using `ArtifactArchiver` with Playwright Test
25
+ * ## Using Artifact Archiver with Playwright Test
26
26
  *
27
27
  * ```ts
28
28
  * // playwright.config.ts
@@ -36,7 +36,6 @@ const Hash_1 = require("./Hash");
36
36
  * crew: [
37
37
  * '@serenity-js/serenity-bdd',
38
38
  * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
39
- * [ '@serenity-js/core:StreamReporter', { outputFile: 'target/events.ndjson' }]
40
39
  * ]
41
40
  * // other Serenity/JS config
42
41
  * }]
@@ -45,26 +44,7 @@ const Hash_1 = require("./Hash");
45
44
  * }
46
45
  * ```
47
46
  *
48
- * ## Using `ArtifactArchiver` with Protractor
49
- *
50
- * ```js
51
- * // protractor.conf.js
52
- * exports.config = {
53
- * framework: 'custom',
54
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
55
- *
56
- * serenity: {
57
- * crew: [
58
- * '@serenity-js/serenity-bdd',
59
- * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
60
- * ],
61
- * // other Serenity/JS config
62
- * },
63
- * // other Protractor config
64
- * }
65
- * ```
66
- *
67
- * ## Using `ArtifactArchiver` with WebdriverIO
47
+ * ## Using Artifact Archiver with WebdriverIO
68
48
  *
69
49
  * ```ts
70
50
  * // wdio.conf.ts
@@ -85,6 +65,25 @@ const Hash_1 = require("./Hash");
85
65
  * }
86
66
  * ```
87
67
  *
68
+ * ## Using Artifact Archiver with Protractor
69
+ *
70
+ * ```js
71
+ * // protractor.conf.js
72
+ * exports.config = {
73
+ * framework: 'custom',
74
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
75
+ *
76
+ * serenity: {
77
+ * crew: [
78
+ * '@serenity-js/serenity-bdd',
79
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
80
+ * ],
81
+ * // other Serenity/JS config
82
+ * },
83
+ * // other Protractor config
84
+ * }
85
+ * ```
86
+ *
88
87
  * @group Stage
89
88
  */
90
89
  class ArtifactArchiver {
package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ArtifactArchiver.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":";;;AACA,2CAAkF;AAIlF,4CAQyB;AACzB,oCAA+C;AAE/C,0CAAqF;AAGrF,iCAA8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,MAAa,gBAAgB;IAEzB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAqB;QAC9C,IAAA,mBAAM,EAAC,+BAA+B,EAAE,WAAW,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3F,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,SAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpH,OAAO,IAAI,gBAAgB,CAAC,IAAI,eAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAmC;QAC/C,MAAM,eAAe,GAAG,IAAA,mBAAM,EAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QAEnG,OAAO,IAAI,gBAAgB,CAAC,IAAI,eAAU,CAAC,SAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YACqB,UAAsB,EAC/B,KAAa;QADJ,eAAU,GAAV,UAAU,CAAY;QAC/B,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IAED,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,CAAC,CAAC,KAAK,YAAY,0BAAiB,CAAC,EAAE;YACvC,0BAA0B;YAC1B,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,aAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,kBAAkB,EACjC,QAAQ,EACR,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;SACL;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,kBAAU,EAAE;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAElF,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAClC,MAAM,EACN,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;SACL;IACL,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,YAAkB,EAAE,QAAkB,EAAE,SAAiB;QACzF,MAAM,IAAI,GAAG,WAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1D,OAAO,SAAI,CAAC,mBAAmB;QAC3B,8FAA8F;QAC9F,8FAA8F;QAC9F,uEAAuE;QACvE,GAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,IAAK,IAAK,SAAU,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAE/H,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,YAAkB,EAAE,QAAgB,EAAE,QAA0B,EAAE,QAAsC;QACpH,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,WAAY,YAAY,CAAC,KAAM,MAAM,CAAC,EACtD,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;aAClD,IAAI,CAAC,aAAa,CAAC,EAAE;YAClB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QACP,CAAC,CAAC;aACD,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,yBAAyB,CAAC,KAA2D,EAAE,sBAA4B;QACvH,OAAO,CAAC,YAAkB,EAAE,EAAE;YAC1B,IAAI,KAAK,YAAY,yCAAgC,EAAE;gBACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,wCAA+B,CACnD,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;iBAAM,IAAI,KAAK,YAAY,0BAAiB,EAAE;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,yBAAgB,CACpC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AAhJD,4CAgJC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;SAC1B,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC"}
1
+ {"version":3,"file":"ArtifactArchiver.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":";;;AACA,2CAAkF;AAIlF,4CAQyB;AACzB,oCAA+C;AAE/C,0CAAqF;AAGrF,iCAA8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,MAAa,gBAAgB;IAEzB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAqB;QAC9C,IAAA,mBAAM,EAAC,+BAA+B,EAAE,WAAW,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3F,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,SAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpH,OAAO,IAAI,gBAAgB,CAAC,IAAI,eAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAmC;QAC/C,MAAM,eAAe,GAAG,IAAA,mBAAM,EAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QAEnG,OAAO,IAAI,gBAAgB,CAAC,IAAI,eAAU,CAAC,SAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YACqB,UAAsB,EAC/B,KAAa;QADJ,eAAU,GAAV,UAAU,CAAY;QAC/B,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IAED,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,CAAC,CAAC,KAAK,YAAY,0BAAiB,CAAC,EAAE;YACvC,0BAA0B;YAC1B,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,aAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,kBAAkB,EACjC,QAAQ,EACR,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;SACL;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,kBAAU,EAAE;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAElF,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAClC,MAAM,EACN,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;SACL;IACL,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,YAAkB,EAAE,QAAkB,EAAE,SAAiB;QACzF,MAAM,IAAI,GAAG,WAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1D,OAAO,SAAI,CAAC,mBAAmB;QAC3B,8FAA8F;QAC9F,8FAA8F;QAC9F,uEAAuE;QACvE,GAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,IAAK,IAAK,SAAU,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAE/H,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,YAAkB,EAAE,QAAgB,EAAE,QAA0B,EAAE,QAAsC;QACpH,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,WAAY,YAAY,CAAC,KAAM,MAAM,CAAC,EACtD,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;aAClD,IAAI,CAAC,aAAa,CAAC,EAAE;YAClB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QACP,CAAC,CAAC;aACD,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,yBAAyB,CAAC,KAA2D,EAAE,sBAA4B;QACvH,OAAO,CAAC,YAAkB,EAAE,EAAE;YAC1B,IAAI,KAAK,YAAY,yCAAgC,EAAE;gBACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,wCAA+B,CACnD,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;iBAAM,IAAI,KAAK,YAAY,0BAAiB,EAAE;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,yBAAgB,CACpC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AAhJD,4CAgJC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;SAC1B,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC"}
package/lib/stage/crew/stream-reporter/StreamReporter.d.ts CHANGED
@@ -9,7 +9,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
9
9
  *
10
10
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
11
11
  *
12
- * ## Registering `StreamReporter` programmatically
12
+ * ## Registering Stream Reporter programmatically
13
13
  *
14
14
  * ```ts
15
15
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -21,7 +21,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
21
21
  * })
22
22
  * ```
23
23
  *
24
- * ## Writing `DomainEvents` to a file
24
+ * ## Writing Domain Events to a file
25
25
  *
26
26
  * ```ts
27
27
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -34,19 +34,18 @@ import type { StageCrewMember } from '../../StageCrewMember';
34
34
  * })
35
35
  * ```
36
36
  *
37
- * ## Using `StreamReporter` with Playwright Test
37
+ * ## Using Stream Reporter with Playwright Test
38
38
  *
39
39
  * ```ts
40
40
  * // playwright.config.ts
41
41
  * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
42
42
  *
43
43
  * const config: PlaywrightTestConfig = {
44
- * testDir: './spec',
45
44
  *
46
45
  * reporter: [
47
46
  * [ '@serenity-js/playwright-test', {
48
47
  * crew: [
49
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
48
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' } ]
50
49
  * ]
51
50
  * // other Serenity/JS config
52
51
  * }]
@@ -55,25 +54,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
55
54
  * }
56
55
  * ```
57
56
  *
58
- * ## Using `StreamReporter` with Protractor
59
- *
60
- * ```js
61
- * // protractor.conf.js
62
- * exports.config = {
63
- * framework: 'custom',
64
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
65
- *
66
- * serenity: {
67
- * crew: [
68
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
69
- * ],
70
- * // other Serenity/JS config
71
- * },
72
- * // other Protractor config
73
- * }
74
- * ```
75
- *
76
- * ## Using `StreamReporter` with WebdriverIO
57
+ * ## Using Stream Reporter with WebdriverIO
77
58
  *
78
59
  * ```ts
79
60
  * // wdio.conf.ts
@@ -94,6 +75,24 @@ import type { StageCrewMember } from '../../StageCrewMember';
94
75
  * }
95
76
  * ```
96
77
  *
78
+ * ## Using Stream Reporter with Protractor
79
+ *
80
+ * ```js
81
+ * // protractor.conf.js
82
+ * exports.config = {
83
+ * framework: 'custom',
84
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
85
+ *
86
+ * serenity: {
87
+ * crew: [
88
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
89
+ * ],
90
+ * // other Serenity/JS config
91
+ * },
92
+ * // other Protractor config
93
+ * }
94
+ * ```
95
+ *
97
96
  * @group Stage
98
97
  */
99
98
  export declare class StreamReporter implements StageCrewMember {
package/lib/stage/crew/stream-reporter/StreamReporter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"StreamReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,qBAAa,cAAe,YAAW,eAAe;IAyB9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAxB3B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAS9E;;;;;;OAMG;gBAEkB,MAAM,GAAE,QAAyB,EACjC,KAAK,CAAC,EAAE,KAAK;IAIlC;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAIzC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAKrC"}
1
+ {"version":3,"file":"StreamReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,qBAAa,cAAe,YAAW,eAAe;IAyB9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAxB3B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAS9E;;;;;;OAMG;gBAEkB,MAAM,GAAE,QAAyB,EACjC,KAAK,CAAC,EAAE,KAAK;IAIlC;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAIzC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAKrC"}
package/lib/stage/crew/stream-reporter/StreamReporter.js CHANGED
@@ -9,7 +9,7 @@ const io_1 = require("../../../io");
9
9
  *
10
10
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
11
11
  *
12
- * ## Registering `StreamReporter` programmatically
12
+ * ## Registering Stream Reporter programmatically
13
13
  *
14
14
  * ```ts
15
15
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -21,7 +21,7 @@ const io_1 = require("../../../io");
21
21
  * })
22
22
  * ```
23
23
  *
24
- * ## Writing `DomainEvents` to a file
24
+ * ## Writing Domain Events to a file
25
25
  *
26
26
  * ```ts
27
27
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -34,19 +34,18 @@ const io_1 = require("../../../io");
34
34
  * })
35
35
  * ```
36
36
  *
37
- * ## Using `StreamReporter` with Playwright Test
37
+ * ## Using Stream Reporter with Playwright Test
38
38
  *
39
39
  * ```ts
40
40
  * // playwright.config.ts
41
41
  * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
42
42
  *
43
43
  * const config: PlaywrightTestConfig = {
44
- * testDir: './spec',
45
44
  *
46
45
  * reporter: [
47
46
  * [ '@serenity-js/playwright-test', {
48
47
  * crew: [
49
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
48
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' } ]
50
49
  * ]
51
50
  * // other Serenity/JS config
52
51
  * }]
@@ -55,25 +54,7 @@ const io_1 = require("../../../io");
55
54
  * }
56
55
  * ```
57
56
  *
58
- * ## Using `StreamReporter` with Protractor
59
- *
60
- * ```js
61
- * // protractor.conf.js
62
- * exports.config = {
63
- * framework: 'custom',
64
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
65
- *
66
- * serenity: {
67
- * crew: [
68
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
69
- * ],
70
- * // other Serenity/JS config
71
- * },
72
- * // other Protractor config
73
- * }
74
- * ```
75
- *
76
- * ## Using `StreamReporter` with WebdriverIO
57
+ * ## Using Stream Reporter with WebdriverIO
77
58
  *
78
59
  * ```ts
79
60
  * // wdio.conf.ts
@@ -94,6 +75,24 @@ const io_1 = require("../../../io");
94
75
  * }
95
76
  * ```
96
77
  *
78
+ * ## Using Stream Reporter with Protractor
79
+ *
80
+ * ```js
81
+ * // protractor.conf.js
82
+ * exports.config = {
83
+ * framework: 'custom',
84
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
85
+ *
86
+ * serenity: {
87
+ * crew: [
88
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
89
+ * ],
90
+ * // other Serenity/JS config
91
+ * },
92
+ * // other Protractor config
93
+ * }
94
+ * ```
95
+ *
97
96
  * @group Stage
98
97
  */
99
98
  class StreamReporter {
package/lib/stage/crew/stream-reporter/StreamReporter.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"StreamReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";;;AACA,2CAAyD;AAGzD,oCAA+C;AAI/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,MAAa,cAAc;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA4C;QACxD,MAAM,UAAU,GAAG,IAAA,mBAAM,EAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAExC,MAAM,EAAE,GAAG,IAAI,eAAU,CAAC,SAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAEzC,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,YACqB,SAAmB,OAAO,CAAC,MAAM,EACjC,KAAa;QADb,WAAM,GAAN,MAAM,CAA2B;QACjC,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,IAAI,CACjF,CAAC;IACN,CAAC;CACJ;AAvDD,wCAuDC"}
1
+ {"version":3,"file":"StreamReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";;;AACA,2CAAyD;AAGzD,oCAA+C;AAI/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,MAAa,cAAc;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA4C;QACxD,MAAM,UAAU,GAAG,IAAA,mBAAM,EAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAExC,MAAM,EAAE,GAAG,IAAI,eAAU,CAAC,SAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAEzC,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,YACqB,SAAmB,OAAO,CAAC,MAAM,EACjC,KAAa;QADb,WAAM,GAAN,MAAM,CAA2B;QACjC,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,IAAI,CACjF,CAAC;IACN,CAAC;CACJ;AAvDD,wCAuDC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serenity-js/core",
3
- "version": "3.10.1",
3
+ "version": "3.10.3",
4
4
  "description": "Serenity/JS Screenplay, reporting engine and core interfaces.",
5
5
  "author": {
6
6
  "name": "Jan Molak",
@@ -46,11 +46,11 @@
46
46
  "validate-npm-package-name": "^5.0.0"
47
47
  },
48
48
  "devDependencies": {
49
- "@types/chai": "^4.3.5",
49
+ "@types/chai": "^4.3.6",
50
50
  "@types/diff": "^5.0.3",
51
51
  "@types/filenamify": "^2.0.2",
52
52
  "@types/mocha": "^10.0.1",
53
- "@types/semver": "^7.5.1",
53
+ "@types/semver": "^7.5.2",
54
54
  "@types/validate-npm-package-name": "^4.0.0",
55
55
  "assertion-error-formatter": "^3.0.0",
56
56
  "c8": "8.0.1",
@@ -71,5 +71,5 @@
71
71
  "engines": {
72
72
  "node": "^16.13 || ^18.12 || ^20"
73
73
  },
74
- "gitHead": "7ab90f30b17ed745cad713363a27edfd7cdce08a"
74
+ "gitHead": "064edb63e8d4dee447feaab63cf61cbcf6414fdf"
75
75
  }
package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts CHANGED
@@ -22,7 +22,7 @@ import { Hash } from './Hash';
22
22
  /**
23
23
  * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
24
24
  *
25
- * ## Registering `ArtifactArchiver` programmatically
25
+ * ## Registering Artifact Archiver programmatically
26
26
  *
27
27
  * ```ts
28
28
  * import { ArtifactArchiver, configure } from '@serenity-js/core'
@@ -35,7 +35,7 @@ import { Hash } from './Hash';
35
35
  * })
36
36
  * ```
37
37
  *
38
- * ## Using `ArtifactArchiver` with Playwright Test
38
+ * ## Using Artifact Archiver with Playwright Test
39
39
  *
40
40
  * ```ts
41
41
  * // playwright.config.ts
@@ -49,7 +49,6 @@ import { Hash } from './Hash';
49
49
  * crew: [
50
50
  * '@serenity-js/serenity-bdd',
51
51
  * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
52
- * [ '@serenity-js/core:StreamReporter', { outputFile: 'target/events.ndjson' }]
53
52
  * ]
54
53
  * // other Serenity/JS config
55
54
  * }]
@@ -58,26 +57,7 @@ import { Hash } from './Hash';
58
57
  * }
59
58
  * ```
60
59
  *
61
- * ## Using `ArtifactArchiver` with Protractor
62
- *
63
- * ```js
64
- * // protractor.conf.js
65
- * exports.config = {
66
- * framework: 'custom',
67
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
68
- *
69
- * serenity: {
70
- * crew: [
71
- * '@serenity-js/serenity-bdd',
72
- * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
73
- * ],
74
- * // other Serenity/JS config
75
- * },
76
- * // other Protractor config
77
- * }
78
- * ```
79
- *
80
- * ## Using `ArtifactArchiver` with WebdriverIO
60
+ * ## Using Artifact Archiver with WebdriverIO
81
61
  *
82
62
  * ```ts
83
63
  * // wdio.conf.ts
@@ -98,6 +78,25 @@ import { Hash } from './Hash';
98
78
  * }
99
79
  * ```
100
80
  *
81
+ * ## Using Artifact Archiver with Protractor
82
+ *
83
+ * ```js
84
+ * // protractor.conf.js
85
+ * exports.config = {
86
+ * framework: 'custom',
87
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
88
+ *
89
+ * serenity: {
90
+ * crew: [
91
+ * '@serenity-js/serenity-bdd',
92
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
93
+ * ],
94
+ * // other Serenity/JS config
95
+ * },
96
+ * // other Protractor config
97
+ * }
98
+ * ```
99
+ *
101
100
  * @group Stage
102
101
  */
103
102
  export class ArtifactArchiver implements StageCrewMember {
package/src/stage/crew/stream-reporter/StreamReporter.ts CHANGED
@@ -12,7 +12,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
12
12
  *
13
13
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
14
14
  *
15
- * ## Registering `StreamReporter` programmatically
15
+ * ## Registering Stream Reporter programmatically
16
16
  *
17
17
  * ```ts
18
18
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -24,7 +24,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
24
24
  * })
25
25
  * ```
26
26
  *
27
- * ## Writing `DomainEvents` to a file
27
+ * ## Writing Domain Events to a file
28
28
  *
29
29
  * ```ts
30
30
  * import { configure, StreamReporter } from '@serenity-js/core'
@@ -37,19 +37,18 @@ import type { StageCrewMember } from '../../StageCrewMember';
37
37
  * })
38
38
  * ```
39
39
  *
40
- * ## Using `StreamReporter` with Playwright Test
40
+ * ## Using Stream Reporter with Playwright Test
41
41
  *
42
42
  * ```ts
43
43
  * // playwright.config.ts
44
44
  * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
45
45
  *
46
46
  * const config: PlaywrightTestConfig = {
47
- * testDir: './spec',
48
47
  *
49
48
  * reporter: [
50
49
  * [ '@serenity-js/playwright-test', {
51
50
  * crew: [
52
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
51
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' } ]
53
52
  * ]
54
53
  * // other Serenity/JS config
55
54
  * }]
@@ -58,25 +57,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
58
57
  * }
59
58
  * ```
60
59
  *
61
- * ## Using `StreamReporter` with Protractor
62
- *
63
- * ```js
64
- * // protractor.conf.js
65
- * exports.config = {
66
- * framework: 'custom',
67
- * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
68
- *
69
- * serenity: {
70
- * crew: [
71
- * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
72
- * ],
73
- * // other Serenity/JS config
74
- * },
75
- * // other Protractor config
76
- * }
77
- * ```
78
- *
79
- * ## Using `StreamReporter` with WebdriverIO
60
+ * ## Using Stream Reporter with WebdriverIO
80
61
  *
81
62
  * ```ts
82
63
  * // wdio.conf.ts
@@ -97,6 +78,24 @@ import type { StageCrewMember } from '../../StageCrewMember';
97
78
  * }
98
79
  * ```
99
80
  *
81
+ * ## Using Stream Reporter with Protractor
82
+ *
83
+ * ```js
84
+ * // protractor.conf.js
85
+ * exports.config = {
86
+ * framework: 'custom',
87
+ * frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
88
+ *
89
+ * serenity: {
90
+ * crew: [
91
+ * [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
92
+ * ],
93
+ * // other Serenity/JS config
94
+ * },
95
+ * // other Protractor config
96
+ * }
97
+ * ```
98
+ *
100
99
  * @group Stage
101
100
  */
102
101
  export class StreamReporter implements StageCrewMember {