@uzulla/voreux 0.1.0 → 0.1.1
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/dist/cli.js +1 -5
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/package.json +6 -7
- package/LICENSE +0 -21
- package/README.md +0 -81
package/dist/cli.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uzulla/voreux",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Voreux: Stagehand + Vitest
|
|
5
|
-
"license": "MIT",
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Voreux: Stagehand + Vitest based E2E testing framework",
|
|
6
5
|
"type": "module",
|
|
7
6
|
"main": "./dist/index.js",
|
|
8
7
|
"types": "./dist/index.d.ts",
|
|
@@ -16,9 +15,7 @@
|
|
|
16
15
|
}
|
|
17
16
|
},
|
|
18
17
|
"files": [
|
|
19
|
-
"dist"
|
|
20
|
-
"README.md",
|
|
21
|
-
"LICENSE"
|
|
18
|
+
"dist"
|
|
22
19
|
],
|
|
23
20
|
"scripts": {
|
|
24
21
|
"build": "tsc -p tsconfig.json",
|
|
@@ -27,7 +24,9 @@
|
|
|
27
24
|
"dependencies": {
|
|
28
25
|
"@browserbasehq/stagehand": "^3.0.8",
|
|
29
26
|
"pixelmatch": "^7.1.0",
|
|
30
|
-
"pngjs": "^7.0.0"
|
|
27
|
+
"pngjs": "^7.0.0"
|
|
28
|
+
},
|
|
29
|
+
"peerDependencies": {
|
|
31
30
|
"zod": "^3.25.76"
|
|
32
31
|
},
|
|
33
32
|
"devDependencies": {
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2024 uzulla
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
package/README.md
DELETED
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# Voreux
|
|
2
|
-
|
|
3
|
-
Voreux は、**Stagehand + Vitest** ベースの E2E テストフレームワークです。
|
|
4
|
-
|
|
5
|
-
AI に「クリックして」「入力して」と指示するだけで、Web ブラウザ操作を自動化するテストを書けます。
|
|
6
|
-
|
|
7
|
-
## 特徴
|
|
8
|
-
|
|
9
|
-
- **AI ファースト**: LLM に自然な指示語でブラウザ操作をさせる
|
|
10
|
-
- **自己修復**: 要素が見つからなくなっても自動でリトライ
|
|
11
|
-
- **スクリーンショット比較**: ビジュアルリグレッションも検出
|
|
12
|
-
- **録画対応**: テスト実行の様子を動画出力
|
|
13
|
-
|
|
14
|
-
## インストール
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
npm install @uzulla/voreux
|
|
18
|
-
# または
|
|
19
|
-
pnpm add @uzulla/voreux
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
**必須環境**
|
|
23
|
-
|
|
24
|
-
- Node.js >= 22.x
|
|
25
|
-
- pnpm >= 10.x(推奨)または npm
|
|
26
|
-
- Windows ユーザーは **WSL2** が必要です
|
|
27
|
-
|
|
28
|
-
## クイックスタート
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
# プロジェクトの雛形を生成
|
|
32
|
-
npx @uzulla/voreux init my-e2e
|
|
33
|
-
cd my-e2e
|
|
34
|
-
|
|
35
|
-
# 依存をインストール
|
|
36
|
-
pnpm install
|
|
37
|
-
|
|
38
|
-
# OPENAI_API_KEY を設定
|
|
39
|
-
cp .env.example .env
|
|
40
|
-
# .env の OPENAI_API_KEY を実際のキーに置き換える
|
|
41
|
-
|
|
42
|
-
# テストを実行
|
|
43
|
-
pnpm test
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## 最初のテストを書く
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
import { defineScenarioSuite } from "@uzulla/voreux";
|
|
50
|
-
|
|
51
|
-
const steps = [
|
|
52
|
-
{
|
|
53
|
-
name: "load page",
|
|
54
|
-
selfHeal: false,
|
|
55
|
-
run: async (ctx) => {
|
|
56
|
-
await ctx.page.goto("https://example.com/");
|
|
57
|
-
},
|
|
58
|
-
},
|
|
59
|
-
];
|
|
60
|
-
|
|
61
|
-
defineScenarioSuite({
|
|
62
|
-
suiteName: "example",
|
|
63
|
-
originUrl: "https://example.com/",
|
|
64
|
-
steps,
|
|
65
|
-
});
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## 設定
|
|
69
|
-
|
|
70
|
-
### 環境変数
|
|
71
|
-
|
|
72
|
-
| 変数 | 既定値 | 説明 |
|
|
73
|
-
|---|---|---|
|
|
74
|
-
| `OPENAI_API_KEY` | **必須** | OpenAI API キー |
|
|
75
|
-
| `SELF_HEAL` | `0` | `1` で自己修復を有効化 |
|
|
76
|
-
| `STAGEHAND_MODEL` | `openai/gpt-4o` | 使用するモデル |
|
|
77
|
-
| `E2E_HEADLESS` | `false` | `1` でヘッドレス実行 |
|
|
78
|
-
|
|
79
|
-
## ライセンス
|
|
80
|
-
|
|
81
|
-
MIT
|