@anweat/dsh-browser 0.1.7 → 0.1.9

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 (74) hide show
  1. package/README.md +356 -245
  2. package/cordis.patch.yml +26 -16
  3. package/lib/approval-policy.js +34 -0
  4. package/lib/approval-policy.js.map +1 -1
  5. package/lib/auth-profiles.js +10 -1
  6. package/lib/auth-profiles.js.map +1 -1
  7. package/lib/automation-assets-rpc.d.ts +5 -0
  8. package/lib/automation-assets-rpc.js +63 -0
  9. package/lib/automation-assets-rpc.js.map +1 -0
  10. package/lib/automation-assets.d.ts +139 -0
  11. package/lib/automation-assets.js +372 -0
  12. package/lib/automation-assets.js.map +1 -0
  13. package/lib/automation-development.d.ts +13 -0
  14. package/lib/automation-development.js +37 -0
  15. package/lib/automation-development.js.map +1 -0
  16. package/lib/automation-execution.d.ts +14 -0
  17. package/lib/automation-execution.js +55 -0
  18. package/lib/automation-execution.js.map +1 -0
  19. package/lib/browser-service.d.ts +73 -25
  20. package/lib/browser-service.js +286 -74
  21. package/lib/browser-service.js.map +1 -1
  22. package/lib/client/SettingsCard.d.ts +2 -0
  23. package/lib/client/SettingsCard.js +69 -0
  24. package/lib/client/SettingsCard.js.map +1 -0
  25. package/lib/client/automation-assets-client.d.ts +38 -0
  26. package/lib/client/automation-assets-client.js +83 -0
  27. package/lib/client/automation-assets-client.js.map +1 -0
  28. package/lib/client/context-types.d.ts +8 -0
  29. package/lib/client/context-types.js +2 -0
  30. package/lib/client/context-types.js.map +1 -0
  31. package/lib/client/form.d.ts +62 -0
  32. package/lib/client/form.js +224 -0
  33. package/lib/client/form.js.map +1 -0
  34. package/lib/client/index.d.ts +27 -0
  35. package/lib/client/index.js +28 -0
  36. package/lib/client/index.js.map +1 -0
  37. package/lib/client/locales.d.ts +86 -0
  38. package/lib/client/locales.js +65 -0
  39. package/lib/client/locales.js.map +1 -0
  40. package/lib/client/settings-namespace.d.ts +2 -0
  41. package/lib/client/settings-namespace.js +3 -0
  42. package/lib/client/settings-namespace.js.map +1 -0
  43. package/lib/client/styles.d.ts +48 -0
  44. package/lib/client/styles.js +28 -0
  45. package/lib/client/styles.js.map +1 -0
  46. package/lib/client.js +1282 -0
  47. package/lib/client.js.map +1 -0
  48. package/lib/config.d.ts +14 -0
  49. package/lib/config.js +43 -0
  50. package/lib/config.js.map +1 -1
  51. package/lib/deps.d.ts +7 -1
  52. package/lib/deps.js +22 -6
  53. package/lib/deps.js.map +1 -1
  54. package/lib/freedom.d.ts +4 -1
  55. package/lib/freedom.js +14 -0
  56. package/lib/freedom.js.map +1 -1
  57. package/lib/index.d.ts +3 -1
  58. package/lib/index.js +20 -3
  59. package/lib/index.js.map +1 -1
  60. package/lib/opencli-catalog.d.ts +21 -0
  61. package/lib/opencli-catalog.js +49 -0
  62. package/lib/opencli-catalog.js.map +1 -0
  63. package/lib/scripts.d.ts +1 -1
  64. package/lib/scripts.js +30 -29
  65. package/lib/scripts.js.map +1 -1
  66. package/lib/tools.d.ts +2 -1
  67. package/lib/tools.js +222 -11
  68. package/lib/tools.js.map +1 -1
  69. package/lib/usage-policy.d.ts +49 -0
  70. package/lib/usage-policy.js +171 -0
  71. package/lib/usage-policy.js.map +1 -0
  72. package/package.json +133 -78
  73. package/scripts/check-client-bundle.mjs +15 -0
  74. package/scripts/clean-lib.mjs +3 -0
package/README.md CHANGED
@@ -1,245 +1,356 @@
1
- # dsh-browser
2
-
3
- 自包含的浏览器运行时插件 for [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(DSH)。
4
-
5
- 把 **Playwright(chromium 内核)** 与 **OpenCLI** 作为插件自身的 npm 依赖打包(优先插件本地,缺省回退全局复用),对外提供一个 `browser` 服务 + 一组交互式浏览器工具。`dsh-web-search-pro` 通过 `inject: ['browser']` 注入该服务,驱动它的 playwright / opencli 后端——**不再依赖全局 CLI**。
6
-
7
- ## 安装
8
-
9
- ```bash
10
- dsh plugin --profile web add @anweat/dsh-browser
11
- # 或本地目录 / tarball:
12
- dsh plugin --profile web add ./dsh-browser
13
- # 重启(web profile 关闭了 HMR):
14
- dsh --profile web
15
- ```
16
-
17
- > 依赖 `@deepseek-ai/*` 已发布到 npm(`^0.1.0-rc.6`)。
18
- > 若你的 harness 是本地源码 checkout(如 `0.1.0-rc.5`),版本号可能有出入——用
19
- > `dsh plugin --profile web add ./<path>` 并在 profile 的 `pnpm-workspace.yaml`
20
- > 里对齐版本后重装即可。
21
-
22
- ## 快速使用与适用情形
23
-
24
- 安装并重启后,可先让模型调用 `browser_status`,再按任务选择工具。默认
25
- `automationMode: standard`:读取直接执行,点击、输入、滚动及页面写操作走 DSH 原生一次性审批。
26
-
27
- | 情形 | 推荐方式 | 关键边界 |
28
- |---|---|---|
29
- | 公开网页读取、截图 | `browser_open` → `browser_read` / `browser_screenshot` | 不需要登录态 |
30
- | 表单、分页、懒加载 | `browser_click` / `browser_type` / `browser_scroll` | `standard` 下审批;`autonomous` 下可直接执行 |
31
- | 登录后站点 | `authProfile` | 必须配置 `allowedDomains`;默认不回写 Cookie |
32
- | 固定站点增强 | `rulePack` | 只允许有界步骤;本地 init script 必须 SHA-256 固定且 ≤64KB |
33
- | 模型生成的多步操作 | `browser_recipe_run` | 声明式步骤;审批策略由 `automationMode` 决定 |
34
- | 默认只读脚本 | `browser_script_catalog` → `browser_script_run_builtin` | 内置 article/links/JSON-LD/forms,不执行外来代码 |
35
- | 外部模型生成 UserScript | `browser_script_validate` `browser_userscript_run` | 必须 `@match` + `@grant none`;除 `unrestricted` 外执行前审批 |
36
- | Reddit/小红书等 OpenCLI 平台 | `browser_opencli_status` / `browser_opencli_run` | 除 `unrestricted` 外通用调用需审批;Chrome 扩展与登录态须在线 |
37
-
38
- DSH 会话示例:
39
-
40
- ```text
41
- 先调用 browser_status;然后用 browser_open 打开目标页。
42
- 若页面需要登录,使用 authProfile=forum;不要把 Cookie 放进工具参数。
43
- ```
44
-
45
- ## 内核与依赖的"打包 vs 复用"
46
-
47
- | | 实际是什么 | 打包还是复用 |
48
- |---|---|---|
49
- | **chromium 内核** | 共享缓存 `%LOCALAPPDATA%\ms-playwright`(约 400MB) | **永远复用共享缓存**,不塞进插件、不重复下载;缺失时 `browser_install` 一键补 |
50
- | **playwright 驱动**(JS 包) | `playwright` npm 依赖 | 插件本地 node_modules 优先,缺省回退全局 npm |
51
- | **opencli**(纯 Node CLI) | `@jackwener/opencli` npm 依赖 | 同上,本地优先 / 全局复用 |
52
-
53
- ## 服务:`browser`
54
-
55
- `dsh-browser` 在 `apply()` 里 `ctx.provide('browser', service)`。任何插件声明
56
- `inject: ['browser']` 即可消费:
57
-
58
- ```ts
59
- export const inject = ['tools', 'browser']
60
- export function apply(ctx: Context) {
61
- const browser = ctx.get('browser') as BrowserService
62
- // browser.render / snapshot / searchResults / opencli / recipe /
63
- // runBuiltinScript / runUserscript / open / click / type / scroll / read / screenshot / close
64
- }
65
- ```
66
-
67
- 服务接口(结构性,无需共享类型包)见 `src/browser-service.ts`。
68
-
69
- ## 自动化自由度
70
-
71
- `automationMode` 控制模型可见的工具集合和执行审批。建议从 `standard` 开始,仅在完全只读任务或受控自动化环境中切换:
72
-
73
- | 模式 | 暴露工具 | 直接交互 / 写 Recipe | 不可取消的安全底线 |
74
- |---|---:|---|---|
75
- | `read-only` | 10 | 隐藏 click/type/scroll/install/UserScript/OpenCLI run;写 Recipe 拒绝 | 只能读取、校验、截图及运行只读脚本/Recipe |
76
- | `standard`(默认) | 16 | 点击、输入、滚动及写 Recipe 均需一次性审批 | UserScript、通用 OpenCLI、浏览器安装也需审批 |
77
- | `autonomous` | 16 个 | 点击、输入、滚动及写 Recipe 可直接执行 | 外部 UserScript、通用 OpenCLI、浏览器安装仍强制审批 |
78
- | `unrestricted` | 16 个 | 所有工具均不触发审批,适合隔离环境中的无人值守测试 | 仍执行域名、元数据、参数、大小和步骤数校验 |
79
-
80
- `unrestricted` 会允许模型直接运行外部脚本、通用 CLI 和安装命令,只应在隔离的测试 profile 或明确授权的自动化环境中使用;日常 profile 保持 `standard`。模式改变后需要重启 DSH profile,工具目录才会按新配置重新注册。
81
-
82
- ## 工具(最多 16 个)
83
-
84
- | 工具 | 作用 |
85
- |---|---|
86
- | `browser_open` | 打开 URL,返回标题/可读文本/全页截图路径(持久页会话) |
87
- | `browser_click` | 按 CSS 选择器点击 |
88
- | `browser_type` | input/textarea 输入 |
89
- | `browser_scroll` | 纵向滚动(触发懒加载) |
90
- | `browser_read` | 读当前页 URL/标题/文本(不截图) |
91
- | `browser_screenshot` | 当前页全页截图 |
92
- | `browser_close` | 关闭当前页(下次 open 全新) |
93
- | `browser_status` | 运行时状态(含 automationMode、已暴露工具及各类审批策略) |
94
- | `browser_install` | 安装 playwright chromium(`browser_status` 报缺失时执行一次) |
95
- | `browser_script_catalog` | 列出内置只读脚本及其 SHA-256 |
96
- | `browser_script_validate` | 解析外部 UserScript 的元数据、域名、grant、能力与哈希,不执行 |
97
- | `browser_script_run_builtin` | 在独立 Playwright context 中运行内置只读脚本 |
98
- | `browser_userscript_run` | 运行外部 UserScript;强制域名匹配,审批策略由模式决定 |
99
- | `browser_recipe_run` | 最多 25 步 Playwright Recipe;支持等待、定位、表单、键盘、提取、断言和截图 |
100
- | `browser_opencli_status` | 实际运行 OpenCLI doctor,报告 daemon/extension/profile 连通性 |
101
- | `browser_opencli_run` | 通用 OpenCLI argv 网关;除 `unrestricted` 外触发 DSH 原生一次性审批 |
102
-
103
- ## 外部模型脚本:推荐流程
104
-
105
- 外部模型可以输出 Tampermonkey/UserScript 格式源码,但不要直接执行。让当前 DSH Agent 先调用
106
- `browser_script_validate`,展示名称、`@match`、SHA-256 和能力,再调用
107
- `browser_userscript_run`。除 `unrestricted` 外,执行调用会进入 Harness
108
- `tools/pre-execute → approval` 原生流程;用户拒绝、没有 approval 服务或调用不属于 Agent 时都不会运行。
109
-
110
- 最小脚本示例:
111
-
112
- ```js
113
- // ==UserScript==
114
- // @name Read Search Cards
115
- // @match https://example.com/search*
116
- // @grant none
117
- // ==/UserScript==
118
- return [...document.querySelectorAll('.result')].slice(0, 20).map(card => ({
119
- title: card.querySelector('h2')?.textContent?.trim() || '',
120
- url: card.querySelector('a')?.href || '',
121
- }))
122
- ```
123
-
124
- 当前兼容的是 UserScript 元数据和页面脚本执行模型,不模拟完整 Tampermonkey:
125
-
126
- - 只支持 `@grant none`;`GM_cookie`、`GM_xmlhttpRequest`、`unsafeWindow` 等不提供。
127
- - 不支持 `@require`,避免审批过的源码在运行时再拉取未审查代码。
128
- - 源码 ≤64KB、结果 ≤100,000 字符、单次运行最长 30 秒。
129
- - 使用显式 URL,新建独立 Playwright context;需要登录态时只能选已限域的 `authProfile`。
130
- - 审批代表允许该脚本以当前站点登录身份操作页面;静态能力报告只用于解释,不是沙箱。
131
-
132
- 常见读取任务优先用内置脚本:`article-clean`、`links`、`jsonld`、`forms`。它们不返回表单当前值,
133
- 也不触发点击或网络写操作。
134
-
135
- ## Playwright Recipe
136
-
137
- Recipe 适合让模型生成可审计、可复现的多步操作,不必生成 JavaScript:
138
-
139
- ```json
140
- {
141
- "url": "https://example.com/search",
142
- "steps": [
143
- { "type": "wait", "condition": "selector", "value": "#query" },
144
- { "type": "fill", "selector": "#query", "value": "DeepSeek Harness" },
145
- { "type": "press", "selector": "#query", "key": "Enter" },
146
- { "type": "wait", "condition": "load" },
147
- { "type": "extract", "selector": "main", "mode": "links", "limit": 30 },
148
- { "type": "screenshot" }
149
- ]
150
- }
151
- ```
152
-
153
- 支持的步骤为:`wait`、`click`、`fill`、`type`、`press`、`select`、`check`、`hover`、
154
- `scroll`、`extract`、`assert`、`screenshot`。纯读取步骤直接执行;出现点击、输入、键盘、选择、
155
- 勾选、悬停或滚动时,`standard` 下整个 Recipe 只询问一次审批,批准后顺序执行;
156
- `autonomous` / `unrestricted` 下直接执行,`read-only` 下拒绝。
157
-
158
- ## 配置(cordis.yml / patch config)
159
-
160
- ```yaml
161
- - insert:
162
- - id: browser
163
- name: '@anweat/dsh-browser'
164
- config:
165
- automationMode: standard # read-only | standard | autonomous | unrestricted
166
- channel: chromium # 'chromium'(打包内核)| 'msedge'(系统 Edge)
167
- headless: true
168
- opencliEnabled: true
169
- storageStatePath: '' # Playwright 登录态 JSON(复用已登录会话)
170
- authProfiles:
171
- forum:
172
- storageStatePath: 'D:/secrets/forum.json'
173
- allowedDomains: [example.com]
174
- persistState: false # 默认只读;true 才会原子回写刷新后的状态
175
- rulePacks:
176
- forum-enhanced:
177
- matches: [example.com]
178
- initScriptPath: 'D:/dsh/rules/forum.js'
179
- initScriptSha256: '<64位sha256>'
180
- steps:
181
- - { type: waitFor, selector: '#results', timeoutMs: 10000 }
182
- - { type: scroll, deltaY: 1600, repeat: 2, waitMs: 300 }
183
- autoInstall: false # 缺内核时是否自动 install chromium
184
- verbose: false
185
- ```
186
-
187
- ## 登录态复用
188
-
189
- - `channel: chromium` + `storageStatePath` 指向一份 storageState JSON,即可用你已登录的身份抓受限页面。
190
- - 新配置优先使用 `authProfiles`:按名称复用全局登录态,但必须用 `allowedDomains` 限域;默认只读,避免一次搜索意外改写 Cookie Vault。
191
- - `browser_open` 和 web-search-pro 的平台搜索可选择 `authProfile` / `rulePack`。`browser_status` 只显示 profile 名称、域名和回写状态,不显示文件路径或 Cookie。
192
- - RulePack 仍只允许有界动作;init script 必须是本地、SHA-256 固定且不超过 64KB。外部模型 JavaScript 使用独立的 UserScript 工具,不能冒充 RulePack;除 `unrestricted` 外需一次性审批。
193
- - 生成登录态:`npx playwright codegen --save-storage=storageState.json`(或复用 `dsh-web-search-pro` 的 `scripts/save-login.mjs`),把产物路径填进 `storageStatePath`。
194
- - opencli 的社交平台后端(小红书/推特/Reddit/IG/FB)仍需浏览器扩展 + 登录态在线,即使 opencli 已打包为依赖也绕不开扩展。
195
-
196
- ### OpenCLI 连接检查
197
-
198
- 插件运行时优先使用自己依赖的 OpenCLI。需要在终端排查 Browser Bridge 时,可全局安装同一 CLI 并检查:
199
-
200
- ```bash
201
- npm i -g @jackwener/opencli
202
- opencli daemon status
203
- opencli doctor
204
- ```
205
-
206
- 健康状态应同时包含 daemon running、extension connected 和一个 connected Chrome profile。仅安装 npm 包不等于 Browser Bridge 可用;Chrome 扩展断开时,OpenCLI 社区搜索会明确失败,而普通 Playwright 浏览器工具不受影响。
207
-
208
- 插件内先调用 `browser_opencli_status`,不要只看 `browser_status.opencliEnabled`。后者表示配置开关,
209
- 前者才是真实连接。通用调用以 argv 数组传入,不经过 shell,也不会自行拼接引号:
210
-
211
- ```json
212
- {
213
- "profile": "chrome",
214
- "args": ["reddit", "search", "DeepSeek Harness", "-f", "json"]
215
- }
216
- ```
217
-
218
- 优先级建议:已有站点 adapter(`opencli <site> <command>`)→ `opencli web read` / `extract` →
219
- `browser network` → DOM state/find/action → 最后才是只读 `eval`。`opencli browser` 必须包含显式 session:
220
-
221
- ```text
222
- ["browser", "research", "open", "https://example.com"]
223
- ["browser", "research", "state"]
224
- ["browser", "research", "network", "--filter", "title,url"]
225
- ["browser", "research", "extract", "--selector", "main"]
226
- ["browser", "research", "close"]
227
- ```
228
-
229
- `browser_opencli_run` 是通用高级入口,可能调用发布、删除、发帖等 adapter,因此无论命令看起来是否只读,
230
- `unrestricted` 外都要求原生一次性审批。常规搜索仍优先走 `dsh-web-search-pro` 的只读工具。
231
-
232
- ## 发布 / 构建
233
-
234
- ```bash
235
- pnpm install # 装依赖(playwright / opencli / @deepseek-ai/*)
236
- pnpm test
237
- pnpm run build # tsc → lib/
238
- node scripts/install-browser.mjs # 安装 chromium 内核(发布前验证,可选)
239
- ```
240
-
241
- ## dsh-web-search-pro 的关系
242
-
243
- `dsh-web-search-pro` 现在 `inject: ['browser']`,其 `web_snapshot` / `web_fetch_pro`(playwright 后端) /
244
- `web_platform_search`(中文社区 playwright + 社交平台 opencli) 全部走本插件的 `browser` 服务。
245
- 两者可独立安装,但 web-search-pro 的浏览器类能力依赖 dsh-browser 先行提供 `browser` 服务(Cordis `inject` 自动排序,无需手动控制挂载顺序)。
1
+ # dsh-browser
2
+
3
+ 自包含的浏览器运行时插件 for [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(DSH)。
4
+
5
+ 把 **Playwright / Patchright(可选 Chromium 驱动)** 与 **OpenCLI** 作为插件自身的 npm 依赖打包(优先插件本地,缺省回退全局复用),对外提供一个 `browser` 服务 + 一组交互式浏览器工具。`dsh-web-search-pro` 通过 `inject: ['browser']` 注入该服务,驱动它的浏览器 / OpenCLI 后端——**不再依赖全局 CLI**。
6
+
7
+ ## 安装
8
+
9
+ ```bash
10
+ dsh plugin --profile web add @anweat/dsh-browser
11
+ # 或本地目录 / tarball:
12
+ dsh plugin --profile web add ./dsh-browser
13
+ # 重启(web profile 关闭了 HMR):
14
+ dsh --profile web
15
+ ```
16
+
17
+ > 依赖 `@deepseek-ai/*` 已发布到 npm(当前适配基线为 `^0.1.1-rc.2`)。
18
+ > 若你的 harness 是包含未发布提交的本地源码 checkout,版本号可能有出入——用
19
+ > `dsh plugin --profile web add ./<path>` 并在 profile 的 `pnpm-workspace.yaml`
20
+ > 里对齐版本后重装即可。
21
+
22
+ ## 从旧版本升级
23
+
24
+ Web Search Pro 与浏览器插件应同步升级;`dsh-web-search-pro >= 0.1.8` 需要 `@anweat/dsh-browser >= 0.1.8`。0.1.9 新增受治理的可复用 Recipe / UserScript 草稿,要求真实浏览器回放通过后才能手工激活;同时修正 Chromium 就绪探测、服务禁用开关和持久登录态校验。
25
+
26
+ ```bash
27
+ dsh plugin --profile web add @anweat/dsh-browser@^0.1.9 dsh-web-search-pro@^0.1.11
28
+ ```
29
+
30
+ 升级后完整停止并重启 Web profile,再调用 `browser_status`、`browser_opencli_status` `web_backend_status`;仅刷新网页不会重新加载插件服务或 Web Search Pro 配置面板。尤其不要只升级 Web Search Pro:新的工具目录、Patchright 运行时和调用缓冲都来自浏览器插件。
31
+
32
+ ## 快速使用与适用情形
33
+
34
+ 安装并重启后,可先让模型调用 `browser_status`,再按任务选择工具。默认
35
+ `automationMode: standard`:读取直接执行,点击、输入、滚动及页面写操作走 DSH 原生一次性审批。
36
+
37
+ | 情形 | 推荐方式 | 关键边界 |
38
+ |---|---|---|
39
+ | 公开网页读取、截图 | `browser_open` → `browser_read` / `browser_screenshot` | 不需要登录态 |
40
+ | 表单、分页、懒加载 | `browser_click` / `browser_type` / `browser_scroll` | `standard` 下审批;`autonomous` 下可直接执行 |
41
+ | 登录后站点 | `authProfile` | 必须配置 `allowedDomains`;默认不回写 Cookie |
42
+ | 固定站点增强 | `rulePack` | 只允许有界步骤;本地 init script 必须 SHA-256 固定且 ≤64KB |
43
+ | 模型生成的多步操作 | `browser_recipe_run` | 声明式步骤;审批策略由 `automationMode` 决定 |
44
+ | 默认只读脚本 | `browser_script_catalog` → `browser_script_run_builtin` | 内置 article/links/JSON-LD/forms,不执行外来代码 |
45
+ | 外部模型生成 UserScript | `browser_script_validate` → `browser_userscript_run` | 必须 `@match` + `@grant none`;除 `unrestricted` 外执行前审批 |
46
+ | 有限站点遍历 | `browser_crawl` | 页数、深度、并发、突发与退避始终受 `usagePolicy` 约束 |
47
+ | Reddit/小红书等 OpenCLI 平台 | `browser_opencli_status` → `browser_opencli_catalog` → `browser_opencli_run` | 先发现精确 adapter;通用调用除 `unrestricted` 外需审批 |
48
+ | 普通站点兼容性不佳 | `browserRuntime: patchright` | Chromium-only;建议专用 Chrome profile,不与指纹注入库叠加 |
49
+
50
+ DSH 会话示例:
51
+
52
+ ```text
53
+ 先调用 browser_status;然后用 browser_open 打开目标页。
54
+ 若页面需要登录,使用 authProfile=forum;不要把 Cookie 放进工具参数。
55
+ ```
56
+
57
+ ## 内核与依赖的"打包 vs 复用"
58
+
59
+ | | 实际是什么 | 打包还是复用 |
60
+ |---|---|---|
61
+ | **chromium 内核** | 共享缓存 `%LOCALAPPDATA%\ms-playwright`(约 400MB) | **永远复用共享缓存**,不塞进插件、不重复下载;缺失时 `browser_install` 一键补 |
62
+ | **playwright 驱动**(JS 包) | `playwright` npm 依赖 | 插件本地 node_modules 优先,缺省回退全局 npm |
63
+ | **patchright 驱动**(可选) | Playwright 同版本的 Chromium 兼容驱动 | 插件内置;配置 `browserRuntime: patchright` 才启用 |
64
+ | **opencli**(纯 Node CLI) | `@jackwener/opencli` npm 依赖 | 同上,本地优先 / 全局复用 |
65
+
66
+ ## 服务:`browser`
67
+
68
+ `dsh-browser` 在 `apply()` 里 `ctx.provide('browser', service)`。任何插件声明
69
+ `inject: ['browser']` 即可消费:
70
+
71
+ ```ts
72
+ export const inject = ['tools', 'browser']
73
+ export function apply(ctx: Context) {
74
+ const browser = ctx.get('browser') as BrowserService
75
+ // browser.render / snapshot / searchResults / opencli / recipe /
76
+ // runBuiltinScript / runUserscript / open / click / type / scroll / read / screenshot / close
77
+ }
78
+ ```
79
+
80
+ 服务接口(结构性,无需共享类型包)见 `src/browser-service.ts`。
81
+
82
+ ## 自动化自由度
83
+
84
+ `automationMode` 控制模型可见的工具集合和执行审批。建议从 `standard` 开始,仅在完全只读任务或受控自动化环境中切换:
85
+
86
+ | 模式 | 浏览器与 Web Search Pro 写操作 | 仍需审批或拒绝 | 不可取消的安全底线 |
87
+ |---|---|---|---|
88
+ | `read-only` | 只读工具与只读 Recipe;缓存清理、规则写入和安装拒绝 | 页面交互、写 Recipe、UserScript、OpenCLI run 均隐藏或拒绝 | 只能读取、校验、截图及运行只读脚本/Recipe |
89
+ | `standard`(默认) | 页面交互、写 Recipe、缓存清理和规则写入均需一次性审批 | UserScript、通用 OpenCLI、浏览器/后端安装也需审批 | 所有安全校验持续启用 |
90
+ | `autonomous` | 页面交互、写 Recipe、缓存清理和规则写入可直接执行 | 外部 UserScript、通用 OpenCLI、浏览器/后端安装仍强制审批 | 所有安全校验持续启用 |
91
+ | `unrestricted` | 所有上述工具均不触发审批,适合隔离环境中的无人值守测试 | 无审批提示 | 仍执行域名、元数据、参数、大小和步骤数校验 |
92
+
93
+ `unrestricted` 会允许模型直接运行外部脚本、通用 CLI 和安装命令,只应在隔离的测试 profile 或明确授权的自动化环境中使用;日常 profile 保持 `standard`。它只取消人工确认,**不会取消 `usagePolicy` 的并发、突发、页数、深度、重试与冷却保护**。模式改变后需要重启 DSH profile,工具目录才会按新配置重新注册。
94
+
95
+ ## 工具(最多 21 个)
96
+
97
+ | 工具 | 作用 |
98
+ |---|---|
99
+ | `browser_open` | 打开 URL,返回标题/可读文本/全页截图路径(持久页会话) |
100
+ | `browser_click` | CSS 选择器点击 |
101
+ | `browser_type` | input/textarea 输入 |
102
+ | `browser_scroll` | 纵向滚动(触发懒加载) |
103
+ | `browser_read` | 读当前页 URL/标题/文本(不截图) |
104
+ | `browser_screenshot` | 当前页全页截图 |
105
+ | `browser_close` | 关闭当前页(下次 open 全新) |
106
+ | `browser_status` | 运行时状态(含 automationMode、已暴露工具及各类审批策略) |
107
+ | `browser_install` | 安装 playwright chromium(`browser_status` 报缺失时执行一次) |
108
+ | `browser_script_catalog` | 列出内置只读脚本及其 SHA-256 |
109
+ | `browser_script_validate` | 解析外部 UserScript 的元数据、域名、grant、能力与哈希,不执行 |
110
+ | `browser_script_run_builtin` | 在独立 Playwright context 中运行内置只读脚本 |
111
+ | `browser_userscript_run` | 运行外部 UserScript;强制域名匹配,审批策略由模式决定 |
112
+ | `browser_recipe_run` | 最多 25 步 Playwright Recipe;支持等待、定位、表单、键盘、提取、断言和截图 |
113
+ | `browser_automation_search` | 只有显式关键词调用才检索;可限定 active/draft/all、域名和类型,最多返回 `retrievalTopK` 条摘要 |
114
+ | `browser_automation_develop` | 按确切 ID 读取源码,或显式保存、静态校验、真实回放草稿;永远不能激活资产 |
115
+ | `browser_automation_run` | 按 ID 运行已激活资产;再次执行限域和输入大小校验,审批由 `automationMode` 决定 |
116
+ | `browser_opencli_status` | 实际运行 OpenCLI doctor,报告 daemon/extension/profile 连通性 |
117
+ | `browser_opencli_catalog` | 对 OpenCLI 大目录按 query/site/access/strategy 过滤,单次最多返回 100 条 |
118
+ | `browser_opencli_run` | 通用 OpenCLI argv 网关;除 `unrestricted` 外触发 DSH 原生一次性审批 |
119
+ | `browser_crawl` | 匿名、有限广度遍历;默认同源,强制使用全局调用缓冲和单次页数/深度预算 |
120
+
121
+ ## 可复用自动化资产(实验性)
122
+
123
+ > **Experimental:** Recipe/UserScript 的积累、模型开发、检索和复用接口仍可能调整。建议先在隔离 profile 中启用,审阅草稿并完成真实浏览器回放后再手动激活;不要把它作为无人监管的生产写操作入口。
124
+
125
+ 自动化执行自由度与资产持久化是两套独立开关。`automationMode: unrestricted` 只影响执行审批,不会让 Agent 自动保存脚本;默认 `automationAssets.persistenceMode: suggest` 仅对成功的 `browser_recipe_run` 记录脱敏语义步骤。具体输入会替换为 `{{input}}` / `{{secret}}`,会话 ID 只保存短哈希,不保存页面正文、cookie、token、密码或聊天记录。
126
+
127
+ 默认在 14 天窗口内,同一域名和步骤指纹至少成功 3 次、来自至少 2 个会话且成功率达到 80%,面板才出现“是否总结”候选。每天最多提示 2 次;候选、草稿和已激活资产均有数量上限。推荐流程是:
128
+
129
+ 1. 候选达到阈值后,在“浏览器自动化 可复用自动化资产”选择“总结为草稿”或“暂不总结”。
130
+ 2. 在脚本列表点选草稿;只有此时前端才按 ID 读取完整 recipe / UserScript。编辑器支持 recipe 和带 `@match`、`@grant none` 的 UserScript。UserScript 可从只读对象 `__DSH_INPUTS__` 读取 `inputNames` 声明的运行时输入,输入不会写入资产文件。
131
+ 3. 保存后先做静态校验,再填写测试 URL/输入执行真实浏览器回放。只有真实回放成功才可手动激活;已激活版本不可原地编辑,避免后台行为静默漂移。
132
+ 4. Agent 用 `browser_automation_search` 获取有界摘要,再用 `browser_automation_run` 按 ID 调用。检索默认 top 5、目录预算约 800 tokens,源码不会进入模型上下文。
133
+
134
+ `persistenceMode` 可选 `off | manual | suggest | auto-draft`。日常使用建议 `suggest`;`auto-draft` 只适合隔离测试 profile,并且仍不会自动激活。`activationMode` 当前默认并推荐 `manual`;`auto-tested` 作为后续真实沙箱回放策略的保留配置,不会把一次静态校验当成生产激活依据。
135
+
136
+ ### 模型显式开发 recipe / UserScript
137
+
138
+ 模型目录不会预载任何 recipe 或源码。需要批量索引等强指向自动化时,模型按以下顺序显式访问:
139
+
140
+ 1. 调用 `browser_automation_search(query="batch-index issues", status="draft|active", kind="recipe")`,仅得到 ID、名称、标签、域名、输入名和运行统计。
141
+ 2. 确认要修改某项后,调用 `browser_automation_develop(action="get", id="...")`;只有这一步会把单个资产的完整 recipe/源码带入当前上下文。
142
+ 3. `action="save"` 可直接声明新的 recipe,或保存带 `@match` / `@grant none` 的 UserScript;只能生成/更新 draft。默认每个模型会话最多写 3 次,仍受全局 `maxDrafts` 限制。
143
+ 4. `action="validate"` 只做结构与 UserScript 元数据校验,不提供激活资格;`action="test"` 必须给 URL 和声明输入,执行真实 Playwright 回放,成功后才标记 `passed`。
144
+ 5. 激活、归档和回滚只在可视化面板完成,模型开发工具没有对应动作。
145
+
146
+ recipe 建议把检索意图固化在 `name`、`description` `tags`,例如 `batch-index`、`issues`、`community-search`。检索采用小规模确定性关键词评分和 token 预算,不自动把整个资产库升级成模型工具,也不使用隐藏的全量 prompt 注入。
147
+
148
+ `modelDevelopmentEnabled: false` 会在重启后直接从模型工具目录移除开发入口;`standard` 保存草稿和真实回放均需审批,`autonomous` 可直接保存草稿但真实回放仍需审批,只有 `unrestricted` 才会跳过回放审批。所有模式仍执行域名、UserScript 元数据、输入、源码大小和使用频率限制。
149
+
150
+ ## 使用策略:防止过度调用的缓冲
151
+
152
+ `usagePolicy` 是资源与站点压力保护,不是审批系统。所有模式共用同一个进程内 Governor:
153
+
154
+ - `maxConcurrency` 限制同时发起的导航,超出后排队;`burst` + `minDelayMs` 限制单站点短时突发。
155
+ - OpenCLI adapter / Browser Bridge 调度也占用同一全局并发与 burst 缓冲,不会因绕过 Playwright 而失去节流。
156
+ - 站点返回 429、502、503、504 时,按 `Retry-After` 或指数退避进入站点级冷却,最多重试 `retryLimit` 次。
157
+ - `browser_crawl` 还受 `maxPagesPerRun` 和 `maxDepth` 硬上限约束;调用参数只能收紧,不能突破配置。
158
+ - 泛爬取默认使用匿名 context,不继承全局 `storageStatePath` 或 `defaultAuthProfile`;登录后读取仍使用显式限域的单页/Recipe 工具。
159
+ - `browser_status` 显示累计运行、排队、等待和 backoff 次数,便于判断是否调用过密。
160
+ - 泛爬取能力本身不隐藏,但调用方仍应遵守目标站点条款、robots 指令、版权、隐私和适用法律;工具每次返回该警告。
161
+
162
+ ## 外部模型脚本:推荐流程
163
+
164
+ 外部模型可以输出 Tampermonkey/UserScript 格式源码,但不要直接执行。让当前 DSH Agent 先调用
165
+ `browser_script_validate`,展示名称、`@match`、SHA-256 和能力,再调用
166
+ `browser_userscript_run`。除 `unrestricted` 外,执行调用会进入 Harness
167
+ `tools/pre-execute → approval` 原生流程;用户拒绝、没有 approval 服务或调用不属于 Agent 时都不会运行。
168
+
169
+ 最小脚本示例:
170
+
171
+ ```js
172
+ // ==UserScript==
173
+ // @name Read Search Cards
174
+ // @match https://example.com/search*
175
+ // @grant none
176
+ // ==/UserScript==
177
+ return [...document.querySelectorAll('.result')].slice(0, 20).map(card => ({
178
+ title: card.querySelector('h2')?.textContent?.trim() || '',
179
+ url: card.querySelector('a')?.href || '',
180
+ }))
181
+ ```
182
+
183
+ 当前兼容的是 UserScript 元数据和页面脚本执行模型,不模拟完整 Tampermonkey:
184
+
185
+ - 只支持 `@grant none`;`GM_cookie`、`GM_xmlhttpRequest`、`unsafeWindow` 等不提供。
186
+ - 不支持 `@require`,避免审批过的源码在运行时再拉取未审查代码。
187
+ - 源码 ≤64KB、结果 ≤100,000 字符、单次运行最长 30 秒。
188
+ - 使用显式 URL,新建独立 Playwright context;需要登录态时只能选已限域的 `authProfile`。
189
+ - 审批代表允许该脚本以当前站点登录身份操作页面;静态能力报告只用于解释,不是沙箱。
190
+
191
+ 常见读取任务优先用内置脚本:`article-clean`、`links`、`jsonld`、`forms`。它们不返回表单当前值,
192
+ 也不触发点击或网络写操作。
193
+
194
+ ## Playwright Recipe
195
+
196
+ Recipe 适合让模型生成可审计、可复现的多步操作,不必生成 JavaScript:
197
+
198
+ ```json
199
+ {
200
+ "url": "https://example.com/search",
201
+ "steps": [
202
+ { "type": "wait", "condition": "selector", "value": "#query" },
203
+ { "type": "fill", "selector": "#query", "value": "DeepSeek Harness" },
204
+ { "type": "press", "selector": "#query", "key": "Enter" },
205
+ { "type": "wait", "condition": "load" },
206
+ { "type": "extract", "selector": "main", "mode": "links", "limit": 30 },
207
+ { "type": "screenshot" }
208
+ ]
209
+ }
210
+ ```
211
+
212
+ 支持的步骤为:`wait`、`click`、`fill`、`type`、`press`、`select`、`check`、`hover`、
213
+ `scroll`、`extract`、`assert`、`screenshot`。纯读取步骤直接执行;出现点击、输入、键盘、选择、
214
+ 勾选、悬停或滚动时,`standard` 下整个 Recipe 只询问一次审批,批准后顺序执行;
215
+ `autonomous` / `unrestricted` 下直接执行,`read-only` 下拒绝。
216
+
217
+ ## 配置(cordis.yml / patch config)
218
+
219
+ ```yaml
220
+ - insert:
221
+ - id: browser
222
+ name: '@anweat/dsh-browser'
223
+ config:
224
+ automationMode: standard # read-only | standard | autonomous | unrestricted
225
+ browserRuntime: playwright # playwright | patchright
226
+ channel: chromium # 'chromium'(打包内核)| 'msedge'(系统 Edge)
227
+ headless: true
228
+ opencliEnabled: true
229
+ usagePolicy: # 所有模式都生效;无审批模式也不会绕过
230
+ minDelayMs: 750
231
+ maxConcurrency: 2
232
+ burst: 3
233
+ maxPagesPerRun: 20
234
+ maxDepth: 2
235
+ retryLimit: 2
236
+ backoffBaseMs: 1000
237
+ cooldownMs: 30000
238
+ automationAssets:
239
+ enabled: true
240
+ persistenceMode: suggest # off | manual | suggest | auto-draft
241
+ activationMode: manual # 当前推荐值;不会因静态校验自动激活
242
+ minSuccessfulRuns: 3
243
+ minDistinctSessions: 2
244
+ successWindowDays: 14
245
+ minSuccessRate: 0.8
246
+ maxCandidates: 20
247
+ candidateTtlDays: 14
248
+ maxSuggestionsPerDay: 2
249
+ maxDrafts: 10
250
+ maxActiveAssets: 50
251
+ retrievalTopK: 5
252
+ catalogTokenBudget: 800
253
+ modelDevelopmentEnabled: true
254
+ maxModelDraftWritesPerSession: 3
255
+ storageStatePath: '' # Playwright 登录态 JSON(复用已登录会话)
256
+ authProfiles:
257
+ forum:
258
+ storageStatePath: 'D:/secrets/forum.json'
259
+ allowedDomains: [example.com]
260
+ persistState: false # 默认只读;true 才会原子回写刷新后的状态
261
+ rulePacks:
262
+ forum-enhanced:
263
+ matches: [example.com]
264
+ initScriptPath: 'D:/dsh/rules/forum.js'
265
+ initScriptSha256: '<64位sha256>'
266
+ steps:
267
+ - { type: waitFor, selector: '#results', timeoutMs: 10000 }
268
+ - { type: scroll, deltaY: 1600, repeat: 2, waitMs: 300 }
269
+ autoInstall: false # 缺内核时是否自动 install chromium
270
+ verbose: false
271
+ ```
272
+
273
+ 这些字段同时进入 Host settings 命名空间和专用可视化卡片:打开 `设置 → 插件 → 插件配置 → 浏览器自动化`,可调整工具自由度、Playwright/Patchright、OpenCLI、`usagePolicy`、自动化资产策略与限域登录态;同一卡片包含候选提示、脚本列表、JSON 编辑器、测试、激活和归档操作。保存运行时配置后需要重启 profile;资产 CRUD 通过 loopback-only Host RPC 即时落盘。若没有看到卡片,先确认浏览器插件已同步升级并完整重启,而不是只刷新 Web Search Pro 页面。
274
+
275
+ ### Patchright 可选内核
276
+
277
+ Patchright 是 Playwright-compatible 的 Chromium 驱动,适合普通 Playwright 在搜索页遇到自动化检测时显式启用:
278
+
279
+ ```yaml
280
+ browserRuntime: patchright
281
+ channel: chrome
282
+ headless: false
283
+ ```
284
+
285
+ `channel: chrome + headless: false` 是更贴近其推荐的兼容配置;CI/无人值守也可使用 headless,但 `browser_status.runtimeWarnings` 会如实提示差异。Patchright 会禁用 Playwright console API,因此依赖控制台监听的 Recipe/脚本不应切换到它。不要再叠加自定义 User-Agent、额外请求头或指纹注入器;这类组合更容易形成自相矛盾的指纹。
286
+
287
+ Camoufox 当前没有硬集成:截至本版,其 JS 包要求 Node 22 且 peer 约束为 `playwright-core <1.61`,与本插件验证的 Playwright/Patchright 1.62.1 不兼容,并需要独立下载 Firefox 内核。后续等版本边界对齐后再作为第三 provider 接入,避免安装后才发生依赖漂移。
288
+
289
+ ## 登录态复用
290
+
291
+ - `channel: chromium` + `storageStatePath` 指向一份 storageState JSON,即可用你已登录的身份抓受限页面。
292
+ - 新配置优先使用 `authProfiles`:按名称复用全局登录态,但必须用 `allowedDomains` 限域;默认只读,避免一次搜索意外改写 Cookie Vault。
293
+ - `browser_open` 和 web-search-pro 的平台搜索可选择 `authProfile` / `rulePack`。`browser_status` 只显示 profile 名称、域名和回写状态,不显示文件路径或 Cookie。
294
+ - RulePack 仍只允许有界动作;init script 必须是本地、SHA-256 固定且不超过 64KB。外部模型 JavaScript 使用独立的 UserScript 工具,不能冒充 RulePack;除 `unrestricted` 外需一次性审批。
295
+ - 生成登录态:`npx playwright codegen --save-storage=storageState.json`(或复用 `dsh-web-search-pro` 的 `scripts/save-login.mjs`),把产物路径填进 `storageStatePath`。
296
+ - opencli 的社交平台后端(小红书/推特/Reddit/IG/FB)仍需浏览器扩展 + 登录态在线,即使 opencli 已打包为依赖也绕不开扩展。
297
+
298
+ ### OpenCLI 连接检查
299
+
300
+ 插件运行时优先使用自己依赖的 OpenCLI。需要在终端排查 Browser Bridge 时,可全局安装同一 CLI 并检查:
301
+
302
+ ```bash
303
+ npm i -g @jackwener/opencli
304
+ opencli daemon status
305
+ opencli doctor
306
+ ```
307
+
308
+ 健康状态应同时包含 daemon running、extension connected 和一个 connected Chrome profile。仅安装 npm 包不等于 Browser Bridge 可用;Chrome 扩展断开时,OpenCLI 社区搜索会明确失败,而普通 Playwright 浏览器工具不受影响。
309
+
310
+ 插件内先调用 `browser_opencli_status`,不要只看 `browser_status.opencliEnabled`。后者表示配置开关,
311
+ 前者才是真实连接。通用调用以 argv 数组传入,不经过 shell,也不会自行拼接引号:
312
+
313
+ ```json
314
+ {
315
+ "profile": "chrome",
316
+ "args": ["reddit", "search", "DeepSeek Harness", "-f", "json"]
317
+ }
318
+ ```
319
+
320
+ 不确定命令时先查目录,避免让模型猜 adapter:
321
+
322
+ ```json
323
+ { "query": "search", "site": "reddit", "access": "read", "limit": 10 }
324
+ ```
325
+
326
+ `browser_opencli_catalog` 从 `opencli list -f json` 读取并缓存目录,只暴露过滤后的最多 100 条;它不执行站点命令,也不读取站点登录数据。
327
+
328
+ 优先级建议:已有站点 adapter(`opencli <site> <command>`)→ `opencli web read` / `extract` →
329
+ `browser network` → DOM state/find/action → 最后才是只读 `eval`。`opencli browser` 必须包含显式 session:
330
+
331
+ ```text
332
+ ["browser", "research", "open", "https://example.com"]
333
+ ["browser", "research", "state"]
334
+ ["browser", "research", "network", "--filter", "title,url"]
335
+ ["browser", "research", "extract", "--selector", "main"]
336
+ ["browser", "research", "close"]
337
+ ```
338
+
339
+ `browser_opencli_run` 是通用高级入口,可能调用发布、删除、发帖等 adapter,因此无论命令看起来是否只读,
340
+ 除 `unrestricted` 外都要求原生一次性审批。常规搜索仍优先走 `dsh-web-search-pro` 的只读工具。
341
+
342
+ ## 发布 / 构建
343
+
344
+ ```bash
345
+ pnpm install # 装依赖(playwright / patchright / opencli / @deepseek-ai/*)
346
+ pnpm test
347
+ pnpm run build # tsc → lib/
348
+ pnpm run verify # typecheck → build → real-browser tests → client bundle check
349
+ node scripts/install-browser.mjs # 安装 chromium 内核(发布前验证,可选)
350
+ ```
351
+
352
+ ## 与 dsh-web-search-pro 的关系
353
+
354
+ `dsh-web-search-pro` 现在 `inject: ['browser']`,其 `web_snapshot` / `web_fetch_pro`(playwright 后端) /
355
+ `web_platform_search`(中文社区 playwright + 社交平台 opencli) 全部走本插件的 `browser` 服务。
356
+ 两者可独立安装,但 web-search-pro 的浏览器类能力依赖 dsh-browser 先行提供 `browser` 服务(Cordis `inject` 自动排序,无需手动控制挂载顺序)。