@serenity-js/core 3.36.2 → 3.37.0
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.
- package/CHANGELOG.md +8 -0
- package/README.md +65 -33
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
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.37.0](https://github.com/serenity-js/serenity-js/compare/v3.36.2...v3.37.0) (2025-12-02)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @serenity-js/core
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [3.36.2](https://github.com/serenity-js/serenity-js/compare/v3.36.1...v3.36.2) (2025-11-26)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @serenity-js/core
|
package/README.md
CHANGED
|
@@ -1,53 +1,85 @@
|
|
|
1
|
-
# Serenity/JS
|
|
1
|
+
# Serenity/JS Core
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/js/%40serenity-js%2Fcore)
|
|
4
|
+
[](https://github.com/serenity-js/serenity-js/actions)
|
|
5
|
+
[](https://qlty.sh/gh/serenity-js/projects/serenity-js)
|
|
6
|
+
[](https://qlty.sh/gh/serenity-js/projects/serenity-js)
|
|
7
|
+
[](https://github.com/serenity-js/serenity-js/graphs/contributors)
|
|
8
|
+
[](https://snyk.io/test/npm/@serenity-js/core)
|
|
9
|
+
[](https://github.com/serenity-js/serenity-js)
|
|
2
10
|
|
|
3
11
|
[](https://www.linkedin.com/company/serenity-js)
|
|
4
12
|
[](https://www.youtube.com/@serenity-js)
|
|
5
13
|
[](https://matrix.to/#/#serenity-js:gitter.im)
|
|
6
14
|
[](https://github.com/sponsors/serenity-js)
|
|
7
15
|
|
|
8
|
-
[
|
|
9
|
-
|
|
16
|
+
[`@serenity-js/core`](https://serenity-js.org/api/core/) provides foundational building blocks of the [Serenity/JS](https://serenity-js.org)
|
|
17
|
+
ecosystem, enabling clean, expressive, and highly maintainable test automation based on the [Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern/).
|
|
18
|
+
This package provides APIs and extension points used across all [Serenity/JS modules](https://serenity-js.org/api/).
|
|
10
19
|
|
|
11
|
-
|
|
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)
|
|
14
|
-
- [API documentation](https://serenity-js.org/api/)
|
|
15
|
-
- [Serenity/JS Project Templates](https://serenity-js.org/handbook/project-templates/)
|
|
20
|
+
## Features
|
|
16
21
|
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
|
|
22
|
+
- **Core APIs** for implementing the [Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern/) in automated tests.
|
|
23
|
+
- **Actor lifecycle and abilities management** for clear, maintainable test orchestration.
|
|
24
|
+
- **Flexible integration points** with [test runners](https://serenity-js.org/handbook/test-runners/) and [reporting tools](https://serenity-js.org/handbook/reporting/).
|
|
25
|
+
- **TypeScript-first design** with strong typing for safer and more predictable test code.
|
|
22
26
|
|
|
23
|
-
##
|
|
27
|
+
## Installation
|
|
24
28
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
29
|
+
```bash
|
|
30
|
+
npm install --save-dev @serenity-js/core
|
|
31
|
+
````
|
|
28
32
|
|
|
29
|
-
|
|
33
|
+
See the [Serenity/JS Installation Guide](https://serenity-js.org/handbook/installation/).
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
## Quick Start
|
|
32
36
|
|
|
33
|
-
```
|
|
34
|
-
|
|
37
|
+
```ts
|
|
38
|
+
import { actorCalled } from '@serenity-js/core'
|
|
39
|
+
|
|
40
|
+
await actorCalled('Alice')
|
|
41
|
+
.whoCan(
|
|
42
|
+
// Add abilities
|
|
43
|
+
)
|
|
44
|
+
.attemptsTo(
|
|
45
|
+
// Add tasks and interactions
|
|
46
|
+
)
|
|
35
47
|
```
|
|
36
48
|
|
|
37
|
-
|
|
49
|
+
Explore practical examples and in-depth explanations in the [Serenity/JS Handbook](https://serenity-js.org/handbook/).
|
|
38
50
|
|
|
39
|
-
|
|
40
|
-
Follow [Serenity/JS on LinkedIn](https://www.linkedin.com/company/serenity-js),
|
|
41
|
-
subscribe to [Serenity/JS channel on YouTube](https://www.youtube.com/@serenity-js) and join the [Serenity/JS Community Chat](https://matrix.to/#/#serenity-js:gitter.im) to stay up to date!
|
|
42
|
-
Please also make sure to star ⭐️ [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) to help others discover the framework!
|
|
51
|
+
## Documentation
|
|
43
52
|
|
|
44
|
-
[
|
|
45
|
-
[
|
|
46
|
-
[
|
|
47
|
-
[
|
|
53
|
+
- [API Reference](https://serenity-js.org/api/)
|
|
54
|
+
- [Screenplay Pattern Guide](https://serenity-js.org/handbook/design/screenplay-pattern/)
|
|
55
|
+
- [Serenity/JS Project Templates](https://serenity-js.org/handbook/project-templates/)
|
|
56
|
+
- [Tutorial: First Web Scenario](https://serenity-js.org/handbook/tutorials/your-first-web-scenario/)
|
|
57
|
+
- [Tutorial: First API Scenario](https://serenity-js.org/handbook/tutorials/your-first-api-scenario/)
|
|
58
|
+
|
|
59
|
+
## Contributing
|
|
60
|
+
|
|
61
|
+
Contributions of all kinds are welcome! Get started with the [Contributing Guide](https://serenity-js.org/community/contributing/).
|
|
62
|
+
|
|
63
|
+
## Community
|
|
64
|
+
|
|
65
|
+
- [Community Chat](https://matrix.to/#/#serenity-js:gitter.im)
|
|
66
|
+
- [Discussions Forum](https://github.com/orgs/serenity-js/discussions)
|
|
67
|
+
- Visit the [💡How to... ?](https://github.com/orgs/serenity-js/discussions/categories/how-to) section for answers to common questions
|
|
68
|
+
|
|
69
|
+
If you enjoy using Serenity/JS, make sure to star ⭐️ [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) to help others discover the framework!
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
The Serenity/JS code base is licensed under the [Apache-2.0](https://opensource.org/license/apache-2-0) license,
|
|
74
|
+
while its documentation and the [Serenity/JS Handbook](https://serenity-js.org/handbook/) are licensed under the [Creative Commons BY-NC-SA 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/).
|
|
75
|
+
|
|
76
|
+
See the [Serenity/JS License](https://serenity-js.org/legal/license/).
|
|
77
|
+
|
|
78
|
+
## Support
|
|
48
79
|
|
|
49
|
-
|
|
80
|
+
Support ongoing development through [GitHub Sponsors](https://github.com/sponsors/serenity-js). Sponsors gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks)
|
|
81
|
+
and priority help in the [Discussions Forum](https://github.com/orgs/serenity-js/discussions).
|
|
50
82
|
|
|
51
|
-
|
|
83
|
+
For corporate sponsorship or commercial support, please contact [Jan Molak](https://www.linkedin.com/in/janmolak/).
|
|
52
84
|
|
|
53
|
-
[](https://github.com/sponsors/serenity-js)
|
|
85
|
+
[](https://github.com/sponsors/serenity-js).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@serenity-js/core",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.37.0",
|
|
4
4
|
"description": "The core Serenity/JS framework, providing the Screenplay Pattern interfaces, as well as the test reporting and integration infrastructure",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Jan Molak",
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"@types/validate-npm-package-name": "4.0.2",
|
|
58
58
|
"assertion-error-formatter": "3.0.0",
|
|
59
59
|
"c8": "10.1.3",
|
|
60
|
-
"memfs": "4.51.
|
|
60
|
+
"memfs": "4.51.1",
|
|
61
61
|
"mocha": "11.7.5",
|
|
62
62
|
"mocha-multi": "1.1.7",
|
|
63
63
|
"ts-node": "10.9.2",
|
|
@@ -74,5 +74,5 @@
|
|
|
74
74
|
"engines": {
|
|
75
75
|
"node": "^20 || ^22 || ^24"
|
|
76
76
|
},
|
|
77
|
-
"gitHead": "
|
|
77
|
+
"gitHead": "dae146cd99a04f09b5926fb9d3205af562fa2927"
|
|
78
78
|
}
|