@serenity-js/rest 3.36.1 → 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 +19 -0
- package/README.md +48 -34
- package/package.json +5 -5
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.37.0](https://github.com/serenity-js/serenity-js/compare/v3.36.2...v3.37.0) (2025-12-02)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **deps:** update dependency lru-cache to v11.2.4 ([5325516](https://github.com/serenity-js/serenity-js/commit/53255161e3b3ef77fe26ee72c5d40bbac6a2a5b4))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## [3.36.2](https://github.com/serenity-js/serenity-js/compare/v3.36.1...v3.36.2) (2025-11-26)
|
|
18
|
+
|
|
19
|
+
**Note:** Version bump only for package @serenity-js/rest
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
6
25
|
## [3.36.1](https://github.com/serenity-js/serenity-js/compare/v3.36.0...v3.36.1) (2025-11-16)
|
|
7
26
|
|
|
8
27
|
|
package/README.md
CHANGED
|
@@ -1,40 +1,34 @@
|
|
|
1
|
-
# Serenity/JS
|
|
1
|
+
# Serenity/JS REST
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/js/%40serenity-js%2Frest)
|
|
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/rest)
|
|
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
|
-
of complex software systems faster, more collaborative and easier to scale.
|
|
10
|
-
|
|
11
|
-
⭐️ Get started with Serenity/JS!
|
|
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/)
|
|
16
|
-
|
|
17
|
-
👋 Join the Serenity/JS Community!
|
|
18
|
-
- Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
|
|
19
|
-
- Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
|
|
20
|
-
- Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
|
|
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
|
-
|
|
23
|
-
## Serenity/JS REST
|
|
16
|
+
[`@serenity-js/rest`](https://serenity-js.org/api/rest/) enables actors to perform HTTP requests and validate responses in [Screenplay](https://serenity-js.org/handbook/design/screenplay-pattern/) tests.
|
|
24
17
|
|
|
25
|
-
|
|
18
|
+
## Features
|
|
26
19
|
|
|
27
|
-
|
|
20
|
+
- Integrates Serenity/JS with Axios providing standardised [Screenplay REST API](https://serenity-js.org/api/rest/)
|
|
21
|
+
- Compatible with all the [Serenity/JS modules](https://serenity-js.org/api/) and [supported test runners](https://serenity-js.org/handbook/test-runners/)
|
|
28
22
|
|
|
29
|
-
|
|
30
|
-
run the following command in your computer terminal:
|
|
23
|
+
## Installation
|
|
31
24
|
|
|
32
25
|
```sh
|
|
33
26
|
npm install --save-dev @serenity-js/core @serenity-js/rest @serenity-js/assertions axios
|
|
34
27
|
```
|
|
35
28
|
|
|
29
|
+
See the [Serenity/JS Installation Guide](https://serenity-js.org/handbook/installation/).
|
|
36
30
|
|
|
37
|
-
|
|
31
|
+
## Quick Start
|
|
38
32
|
|
|
39
33
|
```typescript
|
|
40
34
|
import { actorCalled } from '@serenity-js/core'
|
|
@@ -63,20 +57,40 @@ await actor.attemptsTo(
|
|
|
63
57
|
)
|
|
64
58
|
```
|
|
65
59
|
|
|
66
|
-
|
|
60
|
+
Explore practical examples and in-depth explanations in the [Serenity/JS Handbook](https://serenity-js.org/handbook/).
|
|
67
61
|
|
|
68
|
-
|
|
69
|
-
Follow [Serenity/JS on LinkedIn](https://www.linkedin.com/company/serenity-js),
|
|
70
|
-
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!
|
|
71
|
-
Please also make sure to star ⭐️ [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) to help others discover the framework!
|
|
62
|
+
## Documentation
|
|
72
63
|
|
|
73
|
-
[
|
|
74
|
-
[
|
|
75
|
-
[
|
|
76
|
-
[
|
|
64
|
+
- [API Reference](https://serenity-js.org/api/)
|
|
65
|
+
- [Screenplay Pattern Guide](https://serenity-js.org/handbook/design/screenplay-pattern/)
|
|
66
|
+
- [Serenity/JS Project Templates](https://serenity-js.org/handbook/project-templates/)
|
|
67
|
+
- [Tutorial: First Web Scenario](https://serenity-js.org/handbook/tutorials/your-first-web-scenario/)
|
|
68
|
+
- [Tutorial: First API Scenario](https://serenity-js.org/handbook/tutorials/your-first-api-scenario/)
|
|
69
|
+
|
|
70
|
+
## Contributing
|
|
71
|
+
|
|
72
|
+
Contributions of all kinds are welcome! Get started with the [Contributing Guide](https://serenity-js.org/community/contributing/).
|
|
73
|
+
|
|
74
|
+
## Community
|
|
75
|
+
|
|
76
|
+
- [Community Chat](https://matrix.to/#/#serenity-js:gitter.im)
|
|
77
|
+
- [Discussions Forum](https://github.com/orgs/serenity-js/discussions)
|
|
78
|
+
- Visit the [💡How to... ?](https://github.com/orgs/serenity-js/discussions/categories/how-to) section for answers to common questions
|
|
79
|
+
|
|
80
|
+
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!
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
The Serenity/JS code base is licensed under the [Apache-2.0](https://opensource.org/license/apache-2-0) license,
|
|
85
|
+
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/).
|
|
86
|
+
|
|
87
|
+
See the [Serenity/JS License](https://serenity-js.org/legal/license/).
|
|
88
|
+
|
|
89
|
+
## Support
|
|
77
90
|
|
|
78
|
-
|
|
91
|
+
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)
|
|
92
|
+
and priority help in the [Discussions Forum](https://github.com/orgs/serenity-js/discussions).
|
|
79
93
|
|
|
80
|
-
|
|
94
|
+
For corporate sponsorship or commercial support, please contact [Jan Molak](https://www.linkedin.com/in/janmolak/).
|
|
81
95
|
|
|
82
|
-
[](https://github.com/sponsors/serenity-js)
|
|
96
|
+
[](https://github.com/sponsors/serenity-js).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@serenity-js/rest",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.37.0",
|
|
4
4
|
"description": "Serenity/JS Screenplay Pattern library for interacting with REST and other HTTP-based services, supporting comprehensive API testing and blended testing scenarios",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Jan Molak",
|
|
@@ -51,17 +51,17 @@
|
|
|
51
51
|
"node": "^20 || ^22 || ^24"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@serenity-js/core": "3.
|
|
54
|
+
"@serenity-js/core": "3.37.0",
|
|
55
55
|
"agent-base": "7.1.4",
|
|
56
56
|
"axios": "1.13.2",
|
|
57
57
|
"http-proxy-agent": "7.0.2",
|
|
58
58
|
"https-proxy-agent": "7.0.6",
|
|
59
|
-
"lru-cache": "11.2.
|
|
59
|
+
"lru-cache": "11.2.4",
|
|
60
60
|
"tiny-types": "1.24.3"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
63
|
"@integration/testing-tools": "3.0.0",
|
|
64
|
-
"@serenity-js/assertions": "3.
|
|
64
|
+
"@serenity-js/assertions": "3.37.0",
|
|
65
65
|
"@types/chai": "4.3.20",
|
|
66
66
|
"@types/mocha": "10.0.10",
|
|
67
67
|
"axios-mock-adapter": "2.1.0",
|
|
@@ -71,5 +71,5 @@
|
|
|
71
71
|
"ts-node": "10.9.2",
|
|
72
72
|
"typescript": "5.9.3"
|
|
73
73
|
},
|
|
74
|
-
"gitHead": "
|
|
74
|
+
"gitHead": "dae146cd99a04f09b5926fb9d3205af562fa2927"
|
|
75
75
|
}
|