@maeris/maeris-player 0.1.1 → 0.1.2
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/README.md +7 -14
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -6,18 +6,6 @@ Start the runner once, then trigger runs from the Maeris web app.
|
|
|
6
6
|
## Prerequisites
|
|
7
7
|
- Node.js 18+
|
|
8
8
|
- macOS / Windows / Linux
|
|
9
|
-
- Access to the `@maeris` npm scope (this package may be private)
|
|
10
|
-
|
|
11
|
-
## Goals
|
|
12
|
-
- Replay recorder steps through the Chrome extension in a local browser window.
|
|
13
|
-
- Mirror the cloud runner as closely as possible (status updates, assertions, screenshots).
|
|
14
|
-
- Provide a lightweight CLI or UI shim that interfaces with the extension via WebSocket messages.
|
|
15
|
-
|
|
16
|
-
## Architecture
|
|
17
|
-
1. **CLI (`src/cli/run.js`)** starts a WebSocket server and waits for the UI to send `RUN_STEPS`, or replays a local JSON file when `--steps` is provided.
|
|
18
|
-
2. **Runner core (`src/runner/index.js`)** normalizes steps, opens Playwright, streams `STEP_*`/`REPLAY_*` events over WebSocket (port 8090).
|
|
19
|
-
3. **Playwright adapter (`src/runner/playwrightAdapter.js`)** performs clicks, inputs, navigations, assertions; captures screenshots on failure.
|
|
20
|
-
4. **Event contract (`src/runner/events.js`)** defines the message names (`STEP_STARTED`, `STEP_PASSED`, `STEP_FAILED`, `NAVIGATION`, `REPLAY_COMPLETE`, etc.).
|
|
21
9
|
|
|
22
10
|
## Quick start
|
|
23
11
|
```bash
|
|
@@ -80,9 +68,9 @@ maeris-player --tls
|
|
|
80
68
|
- If runs don't start, confirm the runner is listening:
|
|
81
69
|
- `ws://localhost:8090` for non-TLS
|
|
82
70
|
- `wss://localhost:8090` for TLS
|
|
83
|
-
- If publish fails with 2FA errors, see "Publishing" below.
|
|
84
71
|
|
|
85
|
-
##
|
|
72
|
+
## Maintainers
|
|
73
|
+
### Publishing
|
|
86
74
|
This is published as a public scoped package (`@maeris/maeris-player`).
|
|
87
75
|
|
|
88
76
|
If your npm org enforces 2FA, you will need either:
|
|
@@ -93,3 +81,8 @@ First publish (or if npm requires it for scoped packages):
|
|
|
93
81
|
```bash
|
|
94
82
|
npm publish --access public
|
|
95
83
|
```
|
|
84
|
+
|
|
85
|
+
### Architecture (for contributors)
|
|
86
|
+
1. `src/cli/run.js` starts a WebSocket server and waits for the UI to send `RUN_STEPS`, or replays a local JSON file when `--steps` is provided.
|
|
87
|
+
2. `src/runner/index.js` normalizes steps, opens Playwright, and streams `STEP_*` / `REPLAY_*` events over WebSocket (port 8090).
|
|
88
|
+
3. `src/runner/playwrightAdapter.js` performs clicks, inputs, navigations, assertions, and captures screenshots on failure.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@maeris/maeris-player",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Local Playwright-based runner for Maeris",
|
|
6
6
|
"scripts": {
|
|
@@ -16,10 +16,13 @@
|
|
|
16
16
|
"access": "public"
|
|
17
17
|
},
|
|
18
18
|
"license": "MIT",
|
|
19
|
+
"engines": {
|
|
20
|
+
"node": ">=18"
|
|
21
|
+
},
|
|
19
22
|
"dependencies": {
|
|
20
23
|
"playwright": "^1.44.0",
|
|
21
24
|
"selfsigned": "^2.4.1",
|
|
22
25
|
"ws": "^8.13.0",
|
|
23
|
-
"yargs": "^
|
|
26
|
+
"yargs": "^17.7.2"
|
|
24
27
|
}
|
|
25
28
|
}
|